forked from libgit2/libgit2sharp
/
CommitLog.cs
393 lines (324 loc) · 13.8 KB
/
CommitLog.cs
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
using System;
using System.Collections;
using System.Collections.Generic;
using System.Globalization;
using System.Linq;
using LibGit2Sharp.Core;
using LibGit2Sharp.Core.Handles;
namespace LibGit2Sharp
{
/// <summary>
/// A log of commits in a <see cref = "Repository" />
/// </summary>
public class CommitLog : IQueryableCommitLog
{
private readonly Repository repo;
private IList<object> includedIdentifier = new List<object> { "HEAD" };
private IList<object> excludedIdentifier = new List<object>();
private readonly GitSortOptions sortOptions;
/// <summary>
/// Needed for mocking purposes.
/// </summary>
protected CommitLog()
{ }
/// <summary>
/// Initializes a new instance of the <see cref = "CommitLog" /> class.
/// The commits will be enumerated according in reverse chronological order.
/// </summary>
/// <param name = "repo">The repository.</param>
internal CommitLog(Repository repo)
: this(repo, GitSortOptions.Time)
{
}
/// <summary>
/// Initializes a new instance of the <see cref = "CommitLog" /> class.
/// </summary>
/// <param name = "repo">The repository.</param>
/// <param name = "sortingStrategy">The sorting strategy which should be applied when enumerating the commits.</param>
internal CommitLog(Repository repo, GitSortOptions sortingStrategy)
{
this.repo = repo;
sortOptions = sortingStrategy;
}
/// <summary>
/// Gets the current sorting strategy applied when enumerating the log
/// </summary>
public virtual GitSortOptions SortedBy
{
get { return sortOptions; }
}
#region IEnumerable<Commit> Members
/// <summary>
/// Returns an enumerator that iterates through the log.
/// </summary>
/// <returns>An <see cref = "IEnumerator{T}" /> object that can be used to iterate through the log.</returns>
public virtual IEnumerator<Commit> GetEnumerator()
{
if ((repo.Info.IsEmpty) && includedIdentifier.Any(o => PointsAtTheHead(o.ToString()))) // TODO: ToString() == fragile
{
return Enumerable.Empty<Commit>().GetEnumerator();
}
return new CommitEnumerator(repo, includedIdentifier, excludedIdentifier, sortOptions);
}
/// <summary>
/// Returns an enumerator that iterates through the log.
/// </summary>
/// <returns>An <see cref = "IEnumerator" /> object that can be used to iterate through the log.</returns>
IEnumerator IEnumerable.GetEnumerator()
{
return GetEnumerator();
}
#endregion
/// <summary>
/// Returns the list of commits of the repository matching the specified <paramref name = "filter" />.
/// </summary>
/// <param name = "filter">The options used to control which commits will be returned.</param>
/// <returns>A list of commits, ready to be enumerated.</returns>
public virtual ICommitLog QueryBy(Filter filter)
{
Ensure.ArgumentNotNull(filter, "filter");
Ensure.ArgumentNotNull(filter.Since, "filter.Since");
Ensure.ArgumentNotNullOrEmptyString(filter.Since.ToString(), "filter.Since");
return new CommitLog(repo, filter.SortBy)
{
includedIdentifier = ToList(filter.Since),
excludedIdentifier = ToList(filter.Until)
};
}
private static IList<object> ToList(object obj)
{
var list = new List<object>();
if (obj == null)
{
return list;
}
var types = new[]
{
typeof(string), typeof(ObjectId),
typeof(Commit), typeof(TagAnnotation),
typeof(Tag), typeof(Branch), typeof(DetachedHead),
typeof(Reference), typeof(DirectReference), typeof(SymbolicReference)
};
if (types.Contains(obj.GetType()))
{
list.Add(obj);
return list;
}
list.AddRange(((IEnumerable)obj).Cast<object>());
return list;
}
private static bool PointsAtTheHead(string shaOrRefName)
{
return ("HEAD".Equals(shaOrRefName, StringComparison.Ordinal) || "refs/heads/master".Equals(shaOrRefName, StringComparison.Ordinal));
}
/// <summary>
/// Find the best possible common ancestor given two <see cref = "Commit"/>s.
/// </summary>
/// <param name = "first">The first <see cref = "Commit"/>.</param>
/// <param name = "second">The second <see cref = "Commit"/>.</param>
/// <returns>The common ancestor or null if none found.</returns>
public virtual Commit FindCommonAncestor(Commit first, Commit second)
{
Ensure.ArgumentNotNull(first, "first");
Ensure.ArgumentNotNull(second, "second");
using (var osw1 = new ObjectSafeWrapper(first.Id, repo))
using (var osw2 = new ObjectSafeWrapper(second.Id, repo))
{
GitOid ret;
int result = NativeMethods.git_merge_base(out ret, repo.Handle, osw1.ObjectPtr, osw2.ObjectPtr);
if (result == (int)GitErrorCode.NotFound)
{
return null;
}
Ensure.Success(result);
return repo.Lookup<Commit>(new ObjectId(ret));
}
}
/// <summary>
/// Find the best possible common ancestor given two or more <see cref="Commit"/>.
/// </summary>
/// <param name = "commits">The <see cref = "Commit"/>s for which to find the common ancestor.</param>
/// <returns>The common ancestor or null if none found.</returns>
public virtual Commit FindCommonAncestor(IEnumerable<Commit> commits)
{
Ensure.ArgumentNotNull(commits, "commits");
Commit ret = null;
int count = 0;
foreach (var commit in commits)
{
if (commit == null)
{
throw new ArgumentException("Enumerable contains null at position: " + count.ToString(CultureInfo.InvariantCulture), "commits");
}
count++;
if (count == 1)
{
ret = commit;
continue;
}
ret = FindCommonAncestor(ret, commit);
if (ret == null)
{
break;
}
}
if (count < 2)
{
throw new ArgumentException("The enumerable must contains at least two commits.", "commits");
}
return ret;
}
/// <summary>
/// Stores the content of the <see cref = "Repository.Index" /> as a new <see cref = "Commit" /> into the repository.
/// The tip of the <see cref = "Repository.Head"/> will be used as the parent of this new Commit.
/// Once the commit is created, the <see cref = "Repository.Head"/> will move forward to point at it.
/// </summary>
/// <param name = "message">The description of why a change was made to the repository.</param>
/// <param name = "author">The <see cref = "Signature" /> of who made the change.</param>
/// <param name = "committer">The <see cref = "Signature" /> of who added the change to the repository.</param>
/// <param name = "amendPreviousCommit">True to amend the current <see cref = "Commit"/> pointed at by <see cref = "Repository.Head"/>, false otherwise.</param>
/// <returns>The generated <see cref = "Commit" />.</returns>
[Obsolete("This method will be removed in the next release. Please use Repository.Commit() instead.")]
public Commit Create(string message, Signature author, Signature committer, bool amendPreviousCommit)
{
return repo.Commit(message, author, committer, amendPreviousCommit);
}
private class CommitEnumerator : IEnumerator<Commit>
{
private readonly Repository repo;
private readonly RevWalkerSafeHandle handle;
private ObjectId currentOid;
public CommitEnumerator(Repository repo, IList<object> includedIdentifier, IList<object> excludedIdentifier, GitSortOptions sortingStrategy)
{
this.repo = repo;
int res = NativeMethods.git_revwalk_new(out handle, repo.Handle);
repo.RegisterForCleanup(handle);
Ensure.Success(res);
Sort(sortingStrategy);
Push(includedIdentifier);
Hide(excludedIdentifier);
}
#region IEnumerator<Commit> Members
public Commit Current
{
get { return repo.Lookup<Commit>(currentOid); }
}
object IEnumerator.Current
{
get { return Current; }
}
public bool MoveNext()
{
GitOid oid;
int res = NativeMethods.git_revwalk_next(out oid, handle);
if (res == (int)GitErrorCode.RevWalkOver)
{
return false;
}
Ensure.Success(res);
currentOid = new ObjectId(oid);
return true;
}
public void Reset()
{
NativeMethods.git_revwalk_reset(handle);
}
#endregion
public void Dispose()
{
Dispose(true);
GC.SuppressFinalize(this);
}
private void Dispose(bool disposing)
{
handle.SafeDispose();
}
private delegate int HidePushSignature(RevWalkerSafeHandle handle, ref GitOid oid);
private void InternalHidePush(IList<object> identifier, HidePushSignature hidePush)
{
IEnumerable<ObjectId> oids = RetrieveCommitOids(identifier).TakeWhile(o => o != null);
foreach (ObjectId actedOn in oids)
{
GitOid oid = actedOn.Oid;
int res = hidePush(handle, ref oid);
Ensure.Success(res);
}
}
private void Push(IList<object> identifier)
{
InternalHidePush(identifier, NativeMethods.git_revwalk_push);
}
private void Hide(IList<object> identifier)
{
if (identifier == null)
{
return;
}
InternalHidePush(identifier, NativeMethods.git_revwalk_hide);
}
private void Sort(GitSortOptions options)
{
NativeMethods.git_revwalk_sorting(handle, options);
}
private ObjectId DereferenceToCommit(string identifier)
{
// TODO: Should we check the type? Git-log allows TagAnnotation oid as parameter. But what about Blobs and Trees?
GitObject commit = repo.Lookup(identifier, GitObjectType.Any, LookUpOptions.ThrowWhenNoGitObjectHasBeenFound | LookUpOptions.DereferenceResultToCommit);
return commit != null ? commit.Id : null;
}
private IEnumerable<ObjectId> RetrieveCommitOids(object identifier)
{
if (identifier is string)
{
yield return DereferenceToCommit(identifier as string);
yield break;
}
if (identifier is ObjectId)
{
yield return DereferenceToCommit(((ObjectId)identifier).Sha);
yield break;
}
if (identifier is Commit)
{
yield return ((Commit)identifier).Id;
yield break;
}
if (identifier is TagAnnotation)
{
yield return DereferenceToCommit(((TagAnnotation)identifier).Target.Id.Sha);
yield break;
}
if (identifier is Tag)
{
yield return DereferenceToCommit(((Tag)identifier).Target.Id.Sha);
yield break;
}
if (identifier is Branch)
{
var branch = (Branch)identifier;
Ensure.GitObjectIsNotNull(branch.Tip, branch.CanonicalName);
yield return branch.Tip.Id;
yield break;
}
if (identifier is Reference)
{
yield return DereferenceToCommit(((Reference)identifier).CanonicalName);
yield break;
}
if (identifier is IEnumerable)
{
var enumerable = (IEnumerable)identifier;
foreach (object entry in enumerable)
{
foreach (ObjectId oid in RetrieveCommitOids(entry))
{
yield return oid;
}
}
yield break;
}
throw new LibGit2SharpException(string.Format(CultureInfo.InvariantCulture, "Unexpected kind of identifier '{0}'.", identifier));
}
}
}
}