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
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
|
# Copyright (C) 2005 Canonical Ltd
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
"""Code to show logs of changes.
Various flavors of log can be produced:
* for one file, or the whole tree, and (not done yet) for
files in a given directory
* in "verbose" mode with a description of what changed from one
version to the next
* with file-ids and revision-ids shown
Logs are actually written out through an abstract LogFormatter
interface, which allows for different preferred formats. Plugins can
register formats too.
Logs can be produced in either forward (oldest->newest) or reverse
(newest->oldest) order.
Logs can be filtered to show only revisions matching a particular
search string, or within a particular range of revisions. The range
can be given as date/times, which are reduced to revisions before
calling in here.
In verbose mode we show a summary of what changed in each particular
revision. Note that this is the delta for changes in that revision
relative to its mainline parent, not the delta relative to the last
logged revision. So for example if you ask for a verbose log of
changes touching hello.c you will get a list of those revisions also
listing other things that were changed in the same revision, but not
all the changes since the previous revision that touched hello.c.
"""
# TODO: option to show delta summaries for merged-in revisions
import re
from bzrlib.delta import compare_trees
import bzrlib.errors as errors
from bzrlib.trace import mutter
from bzrlib.tree import EmptyTree
from bzrlib.tsort import merge_sort
def find_touching_revisions(branch, file_id):
"""Yield a description of revisions which affect the file_id.
Each returned element is (revno, revision_id, description)
This is the list of revisions where the file is either added,
modified, renamed or deleted.
TODO: Perhaps some way to limit this to only particular revisions,
or to traverse a non-mainline set of revisions?
"""
last_ie = None
last_path = None
revno = 1
for revision_id in branch.revision_history():
this_inv = branch.repository.get_revision_inventory(revision_id)
if file_id in this_inv:
this_ie = this_inv[file_id]
this_path = this_inv.id2path(file_id)
else:
this_ie = this_path = None
# now we know how it was last time, and how it is in this revision.
# are those two states effectively the same or not?
if not this_ie and not last_ie:
# not present in either
pass
elif this_ie and not last_ie:
yield revno, revision_id, "added " + this_path
elif not this_ie and last_ie:
# deleted here
yield revno, revision_id, "deleted " + last_path
elif this_path != last_path:
yield revno, revision_id, ("renamed %s => %s" % (last_path, this_path))
elif (this_ie.text_size != last_ie.text_size
or this_ie.text_sha1 != last_ie.text_sha1):
yield revno, revision_id, "modified " + this_path
last_ie = this_ie
last_path = this_path
revno += 1
def _enumerate_history(branch):
rh = []
revno = 1
for rev_id in branch.revision_history():
rh.append((revno, rev_id))
revno += 1
return rh
def _get_revision_delta(branch, revno):
"""Return the delta for a mainline revision.
This is used to show summaries in verbose logs, and also for finding
revisions which touch a given file."""
# XXX: What are we supposed to do when showing a summary for something
# other than a mainline revision. The delta to it's first parent, or
# (more useful) the delta to a nominated other revision.
return branch.get_revision_delta(revno)
def show_log(branch,
lf,
specific_fileid=None,
verbose=False,
direction='reverse',
start_revision=None,
end_revision=None,
search=None):
"""Write out human-readable log of commits to this branch.
lf
LogFormatter object to show the output.
specific_fileid
If true, list only the commits affecting the specified
file, rather than all commits.
verbose
If true show added/changed/deleted/renamed files.
direction
'reverse' (default) is latest to earliest;
'forward' is earliest to latest.
start_revision
If not None, only show revisions >= start_revision
end_revision
If not None, only show revisions <= end_revision
"""
branch.lock_read()
try:
_show_log(branch, lf, specific_fileid, verbose, direction,
start_revision, end_revision, search)
finally:
branch.unlock()
def _show_log(branch,
lf,
specific_fileid=None,
verbose=False,
direction='reverse',
start_revision=None,
end_revision=None,
search=None):
"""Worker function for show_log - see show_log."""
from bzrlib.osutils import format_date
from bzrlib.errors import BzrCheckError
from bzrlib.textui import show_status
from warnings import warn
if not isinstance(lf, LogFormatter):
warn("not a LogFormatter instance: %r" % lf)
if specific_fileid:
mutter('get log for file_id %r', specific_fileid)
if search is not None:
import re
searchRE = re.compile(search, re.IGNORECASE)
else:
searchRE = None
which_revs = _enumerate_history(branch)
if start_revision is None:
start_revision = 1
else:
branch.check_real_revno(start_revision)
if end_revision is None:
end_revision = len(which_revs)
else:
branch.check_real_revno(end_revision)
# list indexes are 0-based; revisions are 1-based
cut_revs = which_revs[(start_revision-1):(end_revision)]
if not cut_revs:
return
# override the mainline to look like the revision history.
mainline_revs = [revision_id for index, revision_id in cut_revs]
if cut_revs[0][0] == 1:
mainline_revs.insert(0, None)
else:
mainline_revs.insert(0, which_revs[start_revision-2][1])
merge_sorted_revisions = merge_sort(
branch.repository.get_revision_graph(mainline_revs[-1]),
mainline_revs[-1],
mainline_revs)
if direction == 'reverse':
cut_revs.reverse()
elif direction == 'forward':
# forward means oldest first.
merge_sorted_revisions.reverse()
else:
raise ValueError('invalid direction %r' % direction)
revision_history = branch.revision_history()
# convert the revision history to a dictionary:
rev_nos = {}
for index, rev_id in cut_revs:
rev_nos[rev_id] = index
# now we just print all the revisions
for sequence, rev_id, merge_depth, end_of_merge in merge_sorted_revisions:
rev = branch.repository.get_revision(rev_id)
if searchRE:
if not searchRE.search(rev.message):
continue
if merge_depth == 0:
# a mainline revision.
if verbose or specific_fileid:
delta = _get_revision_delta(branch, rev_nos[rev_id])
if specific_fileid:
if not delta.touches_file_id(specific_fileid):
continue
if not verbose:
# although we calculated it, throw it away without display
delta = None
lf.show(rev_nos[rev_id], rev, delta)
elif hasattr(lf, 'show_merge'):
lf.show_merge(rev, merge_depth)
def deltas_for_log_dummy(branch, which_revs):
"""Return all the revisions without intermediate deltas.
Useful for log commands that won't need the delta information.
"""
for revno, revision_id in which_revs:
yield revno, branch.get_revision(revision_id), None
def deltas_for_log_reverse(branch, which_revs):
"""Compute deltas for display in latest-to-earliest order.
branch
Branch to traverse
which_revs
Sequence of (revno, revision_id) for the subset of history to examine
returns
Sequence of (revno, rev, delta)
The delta is from the given revision to the next one in the
sequence, which makes sense if the log is being displayed from
newest to oldest.
"""
last_revno = last_revision_id = last_tree = None
for revno, revision_id in which_revs:
this_tree = branch.revision_tree(revision_id)
this_revision = branch.get_revision(revision_id)
if last_revno:
yield last_revno, last_revision, compare_trees(this_tree, last_tree, False)
this_tree = EmptyTree(branch.get_root_id())
last_revno = revno
last_revision = this_revision
last_tree = this_tree
if last_revno:
if last_revno == 1:
this_tree = EmptyTree(branch.get_root_id())
else:
this_revno = last_revno - 1
this_revision_id = branch.revision_history()[this_revno]
this_tree = branch.revision_tree(this_revision_id)
yield last_revno, last_revision, compare_trees(this_tree, last_tree, False)
def deltas_for_log_forward(branch, which_revs):
"""Compute deltas for display in forward log.
Given a sequence of (revno, revision_id) pairs, return
(revno, rev, delta).
The delta is from the given revision to the next one in the
sequence, which makes sense if the log is being displayed from
newest to oldest.
"""
last_revno = last_revision_id = last_tree = None
prev_tree = EmptyTree(branch.get_root_id())
for revno, revision_id in which_revs:
this_tree = branch.revision_tree(revision_id)
this_revision = branch.get_revision(revision_id)
if not last_revno:
if revno == 1:
last_tree = EmptyTree(branch.get_root_id())
else:
last_revno = revno - 1
last_revision_id = branch.revision_history()[last_revno]
last_tree = branch.revision_tree(last_revision_id)
yield revno, this_revision, compare_trees(last_tree, this_tree, False)
last_revno = revno
last_revision = this_revision
last_tree = this_tree
class LogFormatter(object):
"""Abstract class to display log messages."""
def __init__(self, to_file, show_ids=False, show_timezone='original'):
self.to_file = to_file
self.show_ids = show_ids
self.show_timezone = show_timezone
def show(self, revno, rev, delta):
raise NotImplementedError('not implemented in abstract base')
def short_committer(self, rev):
return re.sub('<.*@.*>', '', rev.committer).strip(' ')
class LongLogFormatter(LogFormatter):
def show(self, revno, rev, delta):
return self._show_helper(revno=revno, rev=rev, delta=delta)
def show_merge(self, rev, merge_depth):
return self._show_helper(rev=rev, indent=' '*merge_depth, merged=True, delta=None)
def _show_helper(self, rev=None, revno=None, indent='', merged=False, delta=None):
"""Show a revision, either merged or not."""
from bzrlib.osutils import format_date
to_file = self.to_file
print >>to_file, indent+'-' * 60
if revno is not None:
print >>to_file, 'revno:', revno
if merged:
print >>to_file, indent+'merged:', rev.revision_id
elif self.show_ids:
print >>to_file, indent+'revision-id:', rev.revision_id
if self.show_ids:
for parent_id in rev.parent_ids:
print >>to_file, indent+'parent:', parent_id
print >>to_file, indent+'committer:', rev.committer
try:
print >>to_file, indent+'branch nick: %s' % \
rev.properties['branch-nick']
except KeyError:
pass
date_str = format_date(rev.timestamp,
rev.timezone or 0,
self.show_timezone)
print >>to_file, indent+'timestamp: %s' % date_str
print >>to_file, indent+'message:'
if not rev.message:
print >>to_file, indent+' (no message)'
else:
message = rev.message.rstrip('\r\n')
for l in message.split('\n'):
print >>to_file, indent+' ' + l
if delta != None:
delta.show(to_file, self.show_ids)
class ShortLogFormatter(LogFormatter):
def show(self, revno, rev, delta):
from bzrlib.osutils import format_date
to_file = self.to_file
date_str = format_date(rev.timestamp, rev.timezone or 0,
self.show_timezone)
print >>to_file, "%5d %s\t%s" % (revno, self.short_committer(rev),
format_date(rev.timestamp, rev.timezone or 0,
self.show_timezone, date_fmt="%Y-%m-%d",
show_offset=False))
if self.show_ids:
print >>to_file, ' revision-id:', rev.revision_id
if not rev.message:
print >>to_file, ' (no message)'
else:
message = rev.message.rstrip('\r\n')
for l in message.split('\n'):
print >>to_file, ' ' + l
# TODO: Why not show the modified files in a shorter form as
# well? rewrap them single lines of appropriate length
if delta != None:
delta.show(to_file, self.show_ids)
print >>to_file, ''
class LineLogFormatter(LogFormatter):
def truncate(self, str, max_len):
if len(str) <= max_len:
return str
return str[:max_len-3]+'...'
def date_string(self, rev):
from bzrlib.osutils import format_date
return format_date(rev.timestamp, rev.timezone or 0,
self.show_timezone, date_fmt="%Y-%m-%d",
show_offset=False)
def message(self, rev):
if not rev.message:
return '(no message)'
else:
return rev.message
def show(self, revno, rev, delta):
from bzrlib.osutils import terminal_width
print >> self.to_file, self.log_string(rev, terminal_width() - 1)
def log_string(self, rev, max_chars):
out = [self.truncate(self.short_committer(rev), 20)]
out.append(self.date_string(rev))
out.append(self.message(rev).replace('\n', ' '))
return self.truncate(" ".join(out).rstrip('\n'), max_chars)
def line_log(rev, max_chars):
lf = LineLogFormatter(None)
return lf.log_string(rev, max_chars)
FORMATTERS = {
'long': LongLogFormatter,
'short': ShortLogFormatter,
'line': LineLogFormatter,
}
def register_formatter(name, formatter):
FORMATTERS[name] = formatter
def log_formatter(name, *args, **kwargs):
"""Construct a formatter from arguments.
name -- Name of the formatter to construct; currently 'long', 'short' and
'line' are supported.
"""
from bzrlib.errors import BzrCommandError
try:
return FORMATTERS[name](*args, **kwargs)
except KeyError:
raise BzrCommandError("unknown log formatter: %r" % name)
def show_one_log(revno, rev, delta, verbose, to_file, show_timezone):
# deprecated; for compatability
lf = LongLogFormatter(to_file=to_file, show_timezone=show_timezone)
lf.show(revno, rev, delta)
def show_changed_revisions(branch, old_rh, new_rh, to_file=None, log_format='long'):
"""Show the change in revision history comparing the old revision history to the new one.
:param branch: The branch where the revisions exist
:param old_rh: The old revision history
:param new_rh: The new revision history
:param to_file: A file to write the results to. If None, stdout will be used
"""
if to_file is None:
import sys
import codecs
import bzrlib
to_file = codecs.getwriter(bzrlib.user_encoding)(sys.stdout, errors='replace')
lf = log_formatter(log_format,
show_ids=False,
to_file=to_file,
show_timezone='original')
# This is the first index which is different between
# old and new
base_idx = None
for i in xrange(max(len(new_rh),
len(old_rh))):
if (len(new_rh) <= i
or len(old_rh) <= i
or new_rh[i] != old_rh[i]):
base_idx = i
break
if base_idx is None:
to_file.write('Nothing seems to have changed\n')
return
## TODO: It might be nice to do something like show_log
## and show the merged entries. But since this is the
## removed revisions, it shouldn't be as important
if base_idx < len(old_rh):
to_file.write('*'*60)
to_file.write('\nRemoved Revisions:\n')
for i in range(base_idx, len(old_rh)):
rev = branch.repository.get_revision(old_rh[i])
lf.show(i+1, rev, None)
to_file.write('*'*60)
to_file.write('\n\n')
if base_idx < len(new_rh):
to_file.write('Added Revisions:\n')
show_log(branch,
lf,
None,
verbose=True,
direction='forward',
start_revision=base_idx+1,
end_revision=len(new_rh),
search=None)
|