/
repo.py
365 lines (310 loc) · 13 KB
/
repo.py
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
import os.path
import io
import stat
import subprocess
from dulwich.objects import S_ISGITLINK
from dulwich.object_store import tree_lookup_path
from dulwich.objects import Blob
from dulwich.errors import NotTreeError
import dulwich, dulwich.patch
from klaus.utils import (
force_unicode,
parent_directory,
repo_human_name,
encode_for_git,
decode_from_git,
)
from klaus.diff import render_diff
NOT_SET = "__not_set__"
def cached_call(key, validator, producer, _cache={}):
data, old_validator = _cache.get(key, (None, NOT_SET))
if old_validator != validator:
data = producer()
_cache[key] = (data, validator)
return data
class FancyRepo(dulwich.repo.Repo):
"""A wrapper around Dulwich's Repo that adds some helper methods."""
def __init__(self, path, namespace):
super(FancyRepo, self).__init__(path)
self.namespace = namespace
@property
def name(self):
return repo_human_name(self.path)
@property
def namespaced_name(self):
return os.path.join(self.namespace or "", self.name)
# TODO: factor out stuff into dulwich
def get_last_updated_at(self):
"""Get datetime of last commit to this repository."""
# Cache result to speed up repo_list.html template.
# If self.get_refs() has changed, we should invalidate the cache.
all_refs = self.get_refs()
return cached_call(
key=(id(self), "get_last_updated_at"),
validator=all_refs,
producer=lambda: self._get_last_updated_at(all_refs),
)
def _get_last_updated_at(self, all_refs):
resolveable_refs = []
for ref_hash in all_refs:
try:
resolveable_refs.append(self[ref_hash])
except KeyError:
# Whoops. The ref points at a non-existant object
pass
resolveable_refs.sort(
key=lambda obj: getattr(obj, "commit_time", float("-inf")), reverse=True
)
for ref in resolveable_refs:
# Find the latest ref that has a commit_time; tags do not
# have a commit time
if hasattr(ref, "commit_time"):
return ref.commit_time
return None
@property
def cloneurl(self):
"""Retrieve the gitweb notion of the public clone URL of this repo."""
f = self.get_named_file("cloneurl")
if f is not None:
return force_unicode(f.read())
c = self.get_config()
try:
return force_unicode(c.get(b"gitweb", b"url"))
except KeyError:
return None
def get_description(self):
"""Like Dulwich's `get_description`, but returns None if the file
contains Git's default text "Unnamed repository[...]".
"""
# Cache result to speed up repo_list.html template.
# If description file mtime has changed, we should invalidate the cache.
description_file = os.path.join(self._controldir, "description")
try:
description_mtime = os.stat(description_file).st_mtime
except OSError:
description_mtime = None
return cached_call(
key=(id(self), "get_description"),
validator=description_mtime,
producer=self._get_description,
)
def _get_description(self):
description = super(FancyRepo, self).get_description()
if description:
description = force_unicode(description)
if not description.startswith("Unnamed repository;"):
return force_unicode(description)
def get_commit(self, rev):
"""Get commit object identified by `rev` (SHA or branch or tag name)."""
for prefix in ["refs/heads/", "refs/tags/", ""]:
key = prefix + rev
try:
obj = self[encode_for_git(key)]
if isinstance(obj, dulwich.objects.Tag):
obj = self[obj.object[1]]
return obj
except KeyError:
pass
raise KeyError(rev)
def get_default_branch(self):
"""Tries to guess the default repo branch name."""
for candidate in ["master", "trunk", "default", "gh-pages"]:
try:
self.get_commit(candidate)
return candidate
except KeyError:
pass
try:
return self.get_branch_names()[0]
except IndexError:
return None
def get_ref_names_ordered_by_last_commit(self, prefix, exclude=None):
"""Return a list of ref names that begin with `prefix`, ordered by the
time they have been committed to last.
"""
def get_commit_time(refname):
try:
obj = self[refs[refname]]
except KeyError:
# Default to 0, i.e. sorting refs that point at non-existant
# objects last.
return 0
if isinstance(obj, dulwich.objects.Tag):
return obj.tag_time
return obj.commit_time
refs = self.refs.as_dict(encode_for_git(prefix))
if exclude:
refs.pop(prefix + exclude, None)
sorted_names = sorted(refs.keys(), key=get_commit_time, reverse=True)
return [decode_from_git(ref) for ref in sorted_names]
def get_branch_names(self, exclude=None):
"""Return a list of branch names of this repo, ordered by the time they
have been committed to last.
"""
return self.get_ref_names_ordered_by_last_commit("refs/heads", exclude)
def get_tag_names(self):
"""Return a list of tag names of this repo, ordered by creation time."""
return self.get_ref_names_ordered_by_last_commit("refs/tags")
def get_tag_and_branch_shas(self):
"""Return a list of SHAs of all tags and branches."""
tag_shas = self.refs.as_dict(b"refs/tags/").values()
branch_shas = self.refs.as_dict(b"refs/heads/").values()
return set(tag_shas) | set(branch_shas)
def history(self, commit, path=None, max_commits=None, skip=0):
"""Return a list of all commits that affected `path`, starting at branch
or commit `commit`. `skip` can be used for pagination, `max_commits`
to limit the number of commits returned.
Similar to `git log [branch/commit] [--skip skip] [-n max_commits]`.
"""
# XXX The pure-Python/dulwich code is very slow compared to `git log`
# at the time of this writing (mid-2012).
# For instance, `git log .tx` in the Django root directory takes
# about 0.15s on my machine whereas the history() method needs 5s.
# Therefore we use `git log` here until dulwich gets faster.
# For the pure-Python implementation, see the 'purepy-hist' branch.
cmd = ["git", "log", "--format=%H"]
if skip:
cmd.append("--skip=%d" % skip)
if max_commits:
cmd.append("--max-count=%d" % max_commits)
cmd.append(decode_from_git(commit.id))
if path:
cmd.extend(["--", path])
output = subprocess.check_output(cmd, cwd=os.path.abspath(self.path))
sha1_sums = output.strip().split(b"\n")
return [self[sha1] for sha1 in sha1_sums]
def blame(self, commit, path):
"""Return a 'git blame' list for the file at `path`: For each line in
the file, the list contains the commit that last changed that line.
"""
# XXX see comment in `.history()`
cmd = ["git", "blame", "-ls", "--root", decode_from_git(commit.id), "--", path]
output = subprocess.check_output(cmd, cwd=os.path.abspath(self.path))
sha1_sums = [line[:40] for line in output.strip().split(b"\n") if line]
return [
None if self[sha1] is None else decode_from_git(self[sha1].id)
for sha1 in sha1_sums
]
def get_blob_or_tree(self, commit, path):
"""Return the Git tree or blob object for `path` at `commit`."""
try:
(mode, oid) = tree_lookup_path(
self.__getitem__, commit.tree, encode_for_git(path)
)
except NotTreeError:
# Some part of the path was a file where a folder was expected.
# Example: path="/path/to/foo.txt" but "to" is a file in "/path".
raise KeyError
return self[oid]
def listdir(self, commit, path):
"""Return a list of submodules, directories and files in given
directory: Lists of (link name, target path) tuples.
"""
submodules, dirs, files = [], [], []
for entry_rel in self.get_blob_or_tree(commit, path).items():
# entry_rel: Entry('foo.txt', ...)
# entry_abs: Entry('spam/eggs/foo.txt', ...)
entry_abs = entry_rel.in_path(encode_for_git(path))
path_str = decode_from_git(entry_abs.path)
item = (os.path.basename(path_str), path_str)
if S_ISGITLINK(entry_abs.mode):
submodules.append(item)
elif stat.S_ISDIR(entry_abs.mode):
dirs.append(item)
else:
files.append(item)
keyfunc = lambda tpl: tpl[0].lower()
submodules.sort(key=keyfunc)
files.sort(key=keyfunc)
dirs.sort(key=keyfunc)
if path:
dirs.insert(0, ("..", parent_directory(path)))
return {"submodules": submodules, "dirs": dirs, "files": files}
def commit_diff(self, commit):
"""Return the list of changes introduced by `commit`."""
from klaus.utils import guess_is_binary
if commit.parents:
parent_tree = self[commit.parents[0]].tree
else:
parent_tree = None
summary = {"nfiles": 0, "nadditions": 0, "ndeletions": 0}
file_changes = [] # the changes in detail
dulwich_changes = self.object_store.tree_changes(parent_tree, commit.tree)
for (oldpath, newpath), (oldmode, newmode), (oldsha, newsha) in dulwich_changes:
summary["nfiles"] += 1
try:
oldblob = self.object_store[oldsha] if oldsha else Blob.from_string(b"")
except KeyError:
# probably related to submodules; Dulwich will handle that.
oldblob = Blob.from_string(b"")
try:
newblob = self.object_store[newsha] if newsha else Blob.from_string(b"")
except KeyError:
# probably related to submodules; Dulwich will handle that.
newblob = Blob.from_string(b"")
# Check for binary files -- can't show diffs for these
if guess_is_binary(newblob) or guess_is_binary(oldblob):
file_changes.append(
{
"is_binary": True,
"old_filename": oldpath or "/dev/null",
"new_filename": newpath or "/dev/null",
"chunks": None,
}
)
continue
additions, deletions, chunks = render_diff(
oldblob.splitlines(), newblob.splitlines()
)
change = {
"is_binary": False,
"old_filename": oldpath or "/dev/null",
"new_filename": newpath or "/dev/null",
"chunks": chunks,
"additions": additions,
"deletions": deletions,
}
summary["nadditions"] += additions
summary["ndeletions"] += deletions
file_changes.append(change)
return summary, file_changes
def raw_commit_diff(self, commit):
if commit.parents:
parent_tree = self[commit.parents[0]].tree
else:
parent_tree = None
bytesio = io.BytesIO()
dulwich.patch.write_tree_diff(
bytesio, self.object_store, parent_tree, commit.tree
)
return bytesio.getvalue()
def freeze(self):
return FrozenFancyRepo(self)
class FrozenFancyRepo(object):
"""A special version of FancyRepo that assumes the underlying Git
repository does not change. Used for performance optimizations.
"""
def __init__(self, repo):
self.__repo = repo
self.__last_updated_at = NOT_SET
def __setattr__(self, name, value):
if not name.startswith("_FrozenFancyRepo__"):
raise TypeError("Can't set %s attribute on FrozenFancyRepo" % name)
super(FrozenFancyRepo, self).__setattr__(name, value)
def __getattr__(self, name):
return getattr(self.__repo, name)
def fast_get_last_updated_at(self):
if self.__last_updated_at is NOT_SET:
self.__last_updated_at = self.__repo.get_last_updated_at()
return self.__last_updated_at
class InvalidRepo:
"""Represent an invalid repository and store pertinent data."""
def __init__(self, path, namespace):
self.path = path
self.namespace = namespace
@property
def name(self):
return repo_human_name(self.path)
@property
def namespaced_name(self):
return os.path.join(self.namespace or "", self.name)