~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/log.py

  • Committer: Robert Collins
  • Date: 2006-06-26 16:23:10 UTC
  • mfrom: (1780.2.1 misc-fixen)
  • mto: This revision was merged to the branch mainline in revision 1815.
  • Revision ID: robertc@robertcollins.net-20060626162310-98f5b55b8cc19d46
(robertc) Misc minor typos and the like.

Show diffs side-by-side

added added

removed removed

Lines of Context:
49
49
all the changes since the previous revision that touched hello.c.
50
50
"""
51
51
 
52
 
 
53
 
from bzrlib.tree import EmptyTree
54
 
from bzrlib.delta import compare_trees
 
52
# TODO: option to show delta summaries for merged-in revisions
 
53
 
 
54
from itertools import izip
 
55
import re
 
56
 
 
57
import bzrlib.errors as errors
55
58
from bzrlib.trace import mutter
 
59
from bzrlib.tsort import merge_sort
56
60
 
57
61
 
58
62
def find_touching_revisions(branch, file_id):
70
74
    last_path = None
71
75
    revno = 1
72
76
    for revision_id in branch.revision_history():
73
 
        this_inv = branch.get_revision_inventory(revision_id)
 
77
        this_inv = branch.repository.get_revision_inventory(revision_id)
74
78
        if file_id in this_inv:
75
79
            this_ie = this_inv[file_id]
76
80
            this_path = this_inv.id2path(file_id)
109
113
    return rh
110
114
 
111
115
 
112
 
def _get_revision_delta(branch, revno):
113
 
    """Return the delta for a mainline revision.
114
 
    
115
 
    This is used to show summaries in verbose logs, and also for finding 
116
 
    revisions which touch a given file."""
117
 
    # FIXME: The current version is very inefficient; it retrieves all revisions
118
 
    # twice and reads the weave twice.  We ought to keep revisions in memory 
119
 
    # in case they're used again, either in a general cache or perhaps 
120
 
    # in this code.
121
 
    # XXX: What are we supposed to do when showing a summary for something 
122
 
    # other than a mainline revision.  The delta to it's first parent, or
123
 
    # (more useful) the delta to a nominated other revision.
124
 
    return branch.get_revision_delta(revno)
125
 
 
126
 
 
127
116
def show_log(branch,
128
117
             lf,
129
118
             specific_fileid=None,
154
143
    end_revision
155
144
        If not None, only show revisions <= end_revision
156
145
    """
 
146
    branch.lock_read()
 
147
    try:
 
148
        _show_log(branch, lf, specific_fileid, verbose, direction,
 
149
                  start_revision, end_revision, search)
 
150
    finally:
 
151
        branch.unlock()
 
152
    
 
153
def _show_log(branch,
 
154
             lf,
 
155
             specific_fileid=None,
 
156
             verbose=False,
 
157
             direction='reverse',
 
158
             start_revision=None,
 
159
             end_revision=None,
 
160
             search=None):
 
161
    """Worker function for show_log - see show_log."""
157
162
    from bzrlib.osutils import format_date
158
163
    from bzrlib.errors import BzrCheckError
159
 
    from bzrlib.textui import show_status
160
164
    
161
165
    from warnings import warn
162
166
 
164
168
        warn("not a LogFormatter instance: %r" % lf)
165
169
 
166
170
    if specific_fileid:
167
 
        mutter('get log for file_id %r' % specific_fileid)
 
171
        mutter('get log for file_id %r', specific_fileid)
168
172
 
169
173
    if search is not None:
170
174
        import re
186
190
 
187
191
    # list indexes are 0-based; revisions are 1-based
188
192
    cut_revs = which_revs[(start_revision-1):(end_revision)]
189
 
 
190
 
    if direction == 'reverse':
191
 
        cut_revs.reverse()
192
 
    elif direction == 'forward':
193
 
        pass
194
 
    else:
195
 
        raise ValueError('invalid direction %r' % direction)
196
 
 
197
 
    for revno, rev_id in cut_revs:
198
 
        if verbose or specific_fileid:
199
 
            delta = _get_revision_delta(branch, revno)
 
193
    if not cut_revs:
 
194
        return
 
195
 
 
196
    # convert the revision history to a dictionary:
 
197
    rev_nos = dict((k, v) for v, k in cut_revs)
 
198
 
 
199
    # override the mainline to look like the revision history.
 
200
    mainline_revs = [revision_id for index, revision_id in cut_revs]
 
201
    if cut_revs[0][0] == 1:
 
202
        mainline_revs.insert(0, None)
 
203
    else:
 
204
        mainline_revs.insert(0, which_revs[start_revision-2][1])
 
205
    if getattr(lf, 'show_merge', None) is not None:
 
206
        include_merges = True 
 
207
    else:
 
208
        include_merges = False 
 
209
    view_revisions = list(get_view_revisions(mainline_revs, rev_nos, branch,
 
210
                          direction, include_merges=include_merges))
 
211
 
 
212
    def iter_revisions():
 
213
        # r = revision, n = revno, d = merge depth
 
214
        revision_ids = [r for r, n, d in view_revisions]
 
215
        zeros = set(r for r, n, d in view_revisions if d == 0)
 
216
        num = 9
 
217
        repository = branch.repository
 
218
        while revision_ids:
 
219
            cur_deltas = {}
 
220
            revisions = repository.get_revisions(revision_ids[:num])
 
221
            if verbose or specific_fileid:
 
222
                delta_revisions = [r for r in revisions if
 
223
                                   r.revision_id in zeros]
 
224
                deltas = repository.get_deltas_for_revisions(delta_revisions)
 
225
                cur_deltas = dict(izip((r.revision_id for r in 
 
226
                                        delta_revisions), deltas))
 
227
            for revision in revisions:
 
228
                # The delta value will be None unless
 
229
                # 1. verbose or specific_fileid is specified, and
 
230
                # 2. the revision is a mainline revision
 
231
                yield revision, cur_deltas.get(revision.revision_id)
 
232
            revision_ids  = revision_ids[num:]
 
233
            num = int(num * 1.5)
200
234
            
201
 
        if specific_fileid:
202
 
            if not delta.touches_file_id(specific_fileid):
203
 
                continue
204
 
 
205
 
        if not verbose:
206
 
            # although we calculated it, throw it away without display
207
 
            delta = None
208
 
 
209
 
        rev = branch.get_revision(rev_id)
 
235
    # now we just print all the revisions
 
236
    for ((rev_id, revno, merge_depth), (rev, delta)) in \
 
237
         izip(view_revisions, iter_revisions()):
210
238
 
211
239
        if searchRE:
212
240
            if not searchRE.search(rev.message):
213
241
                continue
214
242
 
215
 
        lf.show(revno, rev, delta)
216
 
 
217
 
 
218
 
 
219
 
def deltas_for_log_dummy(branch, which_revs):
220
 
    """Return all the revisions without intermediate deltas.
221
 
 
222
 
    Useful for log commands that won't need the delta information.
223
 
    """
 
243
        if merge_depth == 0:
 
244
            # a mainline revision.
 
245
                
 
246
            if specific_fileid:
 
247
                if not delta.touches_file_id(specific_fileid):
 
248
                    continue
224
249
    
225
 
    for revno, revision_id in which_revs:
226
 
        yield revno, branch.get_revision(revision_id), None
227
 
 
228
 
 
229
 
def deltas_for_log_reverse(branch, which_revs):
230
 
    """Compute deltas for display in latest-to-earliest order.
231
 
 
232
 
    branch
233
 
        Branch to traverse
234
 
 
235
 
    which_revs
236
 
        Sequence of (revno, revision_id) for the subset of history to examine
237
 
 
238
 
    returns 
239
 
        Sequence of (revno, rev, delta)
240
 
 
241
 
    The delta is from the given revision to the next one in the
242
 
    sequence, which makes sense if the log is being displayed from
243
 
    newest to oldest.
244
 
    """
245
 
    last_revno = last_revision_id = last_tree = None
246
 
    for revno, revision_id in which_revs:
247
 
        this_tree = branch.revision_tree(revision_id)
248
 
        this_revision = branch.get_revision(revision_id)
249
 
        
250
 
        if last_revno:
251
 
            yield last_revno, last_revision, compare_trees(this_tree, last_tree, False)
252
 
 
253
 
        this_tree = EmptyTree(branch.get_root_id())
254
 
 
255
 
        last_revno = revno
256
 
        last_revision = this_revision
257
 
        last_tree = this_tree
258
 
 
259
 
    if last_revno:
260
 
        if last_revno == 1:
261
 
            this_tree = EmptyTree(branch.get_root_id())
262
 
        else:
263
 
            this_revno = last_revno - 1
264
 
            this_revision_id = branch.revision_history()[this_revno]
265
 
            this_tree = branch.revision_tree(this_revision_id)
266
 
        yield last_revno, last_revision, compare_trees(this_tree, last_tree, False)
267
 
 
268
 
 
269
 
def deltas_for_log_forward(branch, which_revs):
270
 
    """Compute deltas for display in forward log.
271
 
 
272
 
    Given a sequence of (revno, revision_id) pairs, return
273
 
    (revno, rev, delta).
274
 
 
275
 
    The delta is from the given revision to the next one in the
276
 
    sequence, which makes sense if the log is being displayed from
277
 
    newest to oldest.
278
 
    """
279
 
    last_revno = last_revision_id = last_tree = None
280
 
    prev_tree = EmptyTree(branch.get_root_id())
281
 
 
282
 
    for revno, revision_id in which_revs:
283
 
        this_tree = branch.revision_tree(revision_id)
284
 
        this_revision = branch.get_revision(revision_id)
285
 
 
286
 
        if not last_revno:
287
 
            if revno == 1:
288
 
                last_tree = EmptyTree(branch.get_root_id())
289
 
            else:
290
 
                last_revno = revno - 1
291
 
                last_revision_id = branch.revision_history()[last_revno]
292
 
                last_tree = branch.revision_tree(last_revision_id)
293
 
 
294
 
        yield revno, this_revision, compare_trees(last_tree, this_tree, False)
295
 
 
296
 
        last_revno = revno
297
 
        last_revision = this_revision
298
 
        last_tree = this_tree
 
250
            if not verbose:
 
251
                # although we calculated it, throw it away without display
 
252
                delta = None
 
253
 
 
254
            lf.show(revno, rev, delta)
 
255
        else:
 
256
            lf.show_merge(rev, merge_depth)
 
257
 
 
258
 
 
259
def get_view_revisions(mainline_revs, rev_nos, branch, direction,
 
260
                       include_merges=True):
 
261
    """Produce an iterator of revisions to show
 
262
    :return: an iterator of (revision_id, revno, merge_depth)
 
263
    (if there is no revno for a revision, None is supplied)
 
264
    """
 
265
    if include_merges is False:
 
266
        revision_ids = mainline_revs[1:]
 
267
        if direction == 'reverse':
 
268
            revision_ids.reverse()
 
269
        for revision_id in revision_ids:
 
270
            yield revision_id, rev_nos[revision_id], 0
 
271
        return
 
272
    merge_sorted_revisions = merge_sort(
 
273
        branch.repository.get_revision_graph(mainline_revs[-1]),
 
274
        mainline_revs[-1],
 
275
        mainline_revs)
 
276
 
 
277
    if direction == 'forward':
 
278
        # forward means oldest first.
 
279
        merge_sorted_revisions = reverse_by_depth(merge_sorted_revisions)
 
280
    elif direction != 'reverse':
 
281
        raise ValueError('invalid direction %r' % direction)
 
282
 
 
283
    revision_history = branch.revision_history()
 
284
 
 
285
    for sequence, rev_id, merge_depth, end_of_merge in merge_sorted_revisions:
 
286
        yield rev_id, rev_nos.get(rev_id), merge_depth
 
287
 
 
288
 
 
289
def reverse_by_depth(merge_sorted_revisions, _depth=0):
 
290
    """Reverse revisions by depth.
 
291
 
 
292
    Revisions with a different depth are sorted as a group with the previous
 
293
    revision of that depth.  There may be no topological justification for this,
 
294
    but it looks much nicer.
 
295
    """
 
296
    zd_revisions = []
 
297
    for val in merge_sorted_revisions:
 
298
        if val[2] == _depth:
 
299
            zd_revisions.append([val])
 
300
        else:
 
301
            assert val[2] > _depth
 
302
            zd_revisions[-1].append(val)
 
303
    for revisions in zd_revisions:
 
304
        if len(revisions) > 1:
 
305
            revisions[1:] = reverse_by_depth(revisions[1:], _depth + 1)
 
306
    zd_revisions.reverse()
 
307
    result = []
 
308
    for chunk in zd_revisions:
 
309
        result.extend(chunk)
 
310
    return result
299
311
 
300
312
 
301
313
class LogFormatter(object):
302
314
    """Abstract class to display log messages."""
 
315
 
303
316
    def __init__(self, to_file, show_ids=False, show_timezone='original'):
304
317
        self.to_file = to_file
305
318
        self.show_ids = show_ids
306
319
        self.show_timezone = show_timezone
307
320
 
308
 
 
309
321
    def show(self, revno, rev, delta):
310
322
        raise NotImplementedError('not implemented in abstract base')
311
323
 
 
324
    def short_committer(self, rev):
 
325
        return re.sub('<.*@.*>', '', rev.committer).strip(' ')
 
326
    
312
327
    
313
328
class LongLogFormatter(LogFormatter):
314
329
    def show(self, revno, rev, delta):
315
 
        from osutils import format_date
316
 
 
 
330
        return self._show_helper(revno=revno, rev=rev, delta=delta)
 
331
 
 
332
    def show_merge(self, rev, merge_depth):
 
333
        return self._show_helper(rev=rev, indent='    '*merge_depth, merged=True, delta=None)
 
334
 
 
335
    def _show_helper(self, rev=None, revno=None, indent='', merged=False, delta=None):
 
336
        """Show a revision, either merged or not."""
 
337
        from bzrlib.osutils import format_date
317
338
        to_file = self.to_file
318
 
 
319
 
        print >>to_file,  '-' * 60
320
 
        print >>to_file,  'revno:', revno
 
339
        print >>to_file,  indent+'-' * 60
 
340
        if revno is not None:
 
341
            print >>to_file,  'revno:', revno
 
342
        if merged:
 
343
            print >>to_file,  indent+'merged:', rev.revision_id
 
344
        elif self.show_ids:
 
345
            print >>to_file,  indent+'revision-id:', rev.revision_id
321
346
        if self.show_ids:
322
 
            print >>to_file,  'revision-id:', rev.revision_id
323
 
 
324
347
            for parent_id in rev.parent_ids:
325
 
                print >>to_file, 'parent:', parent_id
326
 
            
327
 
        print >>to_file,  'committer:', rev.committer
328
 
 
 
348
                print >>to_file, indent+'parent:', parent_id
 
349
        print >>to_file,  indent+'committer:', rev.committer
 
350
        try:
 
351
            print >>to_file, indent+'branch nick: %s' % \
 
352
                rev.properties['branch-nick']
 
353
        except KeyError:
 
354
            pass
329
355
        date_str = format_date(rev.timestamp,
330
356
                               rev.timezone or 0,
331
357
                               self.show_timezone)
332
 
        print >>to_file,  'timestamp: %s' % date_str
 
358
        print >>to_file,  indent+'timestamp: %s' % date_str
333
359
 
334
 
        print >>to_file,  'message:'
 
360
        print >>to_file,  indent+'message:'
335
361
        if not rev.message:
336
 
            print >>to_file,  '  (no message)'
 
362
            print >>to_file,  indent+'  (no message)'
337
363
        else:
338
 
            for l in rev.message.split('\n'):
339
 
                print >>to_file,  '  ' + l
340
 
 
 
364
            message = rev.message.rstrip('\r\n')
 
365
            for l in message.split('\n'):
 
366
                print >>to_file,  indent+'  ' + l
341
367
        if delta != None:
342
368
            delta.show(to_file, self.show_ids)
343
369
 
344
370
 
345
 
 
346
371
class ShortLogFormatter(LogFormatter):
347
372
    def show(self, revno, rev, delta):
348
373
        from bzrlib.osutils import format_date
349
374
 
350
375
        to_file = self.to_file
351
 
 
352
 
        print >>to_file, "%5d %s\t%s" % (revno, rev.committer,
 
376
        date_str = format_date(rev.timestamp, rev.timezone or 0,
 
377
                            self.show_timezone)
 
378
        print >>to_file, "%5d %s\t%s" % (revno, self.short_committer(rev),
353
379
                format_date(rev.timestamp, rev.timezone or 0,
354
 
                            self.show_timezone))
 
380
                            self.show_timezone, date_fmt="%Y-%m-%d",
 
381
                           show_offset=False))
355
382
        if self.show_ids:
356
383
            print >>to_file,  '      revision-id:', rev.revision_id
357
384
        if not rev.message:
358
385
            print >>to_file,  '      (no message)'
359
386
        else:
360
 
            for l in rev.message.split('\n'):
 
387
            message = rev.message.rstrip('\r\n')
 
388
            for l in message.split('\n'):
361
389
                print >>to_file,  '      ' + l
362
390
 
363
391
        # TODO: Why not show the modified files in a shorter form as
364
392
        # well? rewrap them single lines of appropriate length
365
393
        if delta != None:
366
394
            delta.show(to_file, self.show_ids)
367
 
        print
368
 
 
369
 
 
370
 
 
371
 
FORMATTERS = {'long': LongLogFormatter,
 
395
        print >>to_file, ''
 
396
 
 
397
 
 
398
class LineLogFormatter(LogFormatter):
 
399
    def truncate(self, str, max_len):
 
400
        if len(str) <= max_len:
 
401
            return str
 
402
        return str[:max_len-3]+'...'
 
403
 
 
404
    def date_string(self, rev):
 
405
        from bzrlib.osutils import format_date
 
406
        return format_date(rev.timestamp, rev.timezone or 0, 
 
407
                           self.show_timezone, date_fmt="%Y-%m-%d",
 
408
                           show_offset=False)
 
409
 
 
410
    def message(self, rev):
 
411
        if not rev.message:
 
412
            return '(no message)'
 
413
        else:
 
414
            return rev.message
 
415
 
 
416
    def show(self, revno, rev, delta):
 
417
        from bzrlib.osutils import terminal_width
 
418
        print >> self.to_file, self.log_string(revno, rev, terminal_width()-1)
 
419
 
 
420
    def log_string(self, revno, rev, max_chars):
 
421
        """Format log info into one string. Truncate tail of string
 
422
        :param  revno:      revision number (int) or None.
 
423
                            Revision numbers counts from 1.
 
424
        :param  rev:        revision info object
 
425
        :param  max_chars:  maximum length of resulting string
 
426
        :return:            formatted truncated string
 
427
        """
 
428
        out = []
 
429
        if revno:
 
430
            # show revno only when is not None
 
431
            out.append("%d:" % revno)
 
432
        out.append(self.truncate(self.short_committer(rev), 20))
 
433
        out.append(self.date_string(rev))
 
434
        out.append(rev.get_summary())
 
435
        return self.truncate(" ".join(out).rstrip('\n'), max_chars)
 
436
 
 
437
 
 
438
def line_log(rev, max_chars):
 
439
    lf = LineLogFormatter(None)
 
440
    return lf.log_string(None, rev, max_chars)
 
441
 
 
442
FORMATTERS = {
 
443
              'long': LongLogFormatter,
372
444
              'short': ShortLogFormatter,
 
445
              'line': LineLogFormatter,
373
446
              }
374
447
 
 
448
def register_formatter(name, formatter):
 
449
    FORMATTERS[name] = formatter
375
450
 
376
451
def log_formatter(name, *args, **kwargs):
377
452
    """Construct a formatter from arguments.
378
453
 
379
 
    name -- Name of the formatter to construct; currently 'long' and
380
 
        'short' are supported.
 
454
    name -- Name of the formatter to construct; currently 'long', 'short' and
 
455
        'line' are supported.
381
456
    """
382
457
    from bzrlib.errors import BzrCommandError
383
458
    try:
384
459
        return FORMATTERS[name](*args, **kwargs)
385
 
    except IndexError:
 
460
    except KeyError:
386
461
        raise BzrCommandError("unknown log formatter: %r" % name)
387
462
 
388
463
def show_one_log(revno, rev, delta, verbose, to_file, show_timezone):
389
 
    # deprecated; for compatability
 
464
    # deprecated; for compatibility
390
465
    lf = LongLogFormatter(to_file=to_file, show_timezone=show_timezone)
391
466
    lf.show(revno, rev, delta)
 
467
 
 
468
def show_changed_revisions(branch, old_rh, new_rh, to_file=None, log_format='long'):
 
469
    """Show the change in revision history comparing the old revision history to the new one.
 
470
 
 
471
    :param branch: The branch where the revisions exist
 
472
    :param old_rh: The old revision history
 
473
    :param new_rh: The new revision history
 
474
    :param to_file: A file to write the results to. If None, stdout will be used
 
475
    """
 
476
    if to_file is None:
 
477
        import sys
 
478
        import codecs
 
479
        import bzrlib
 
480
        to_file = codecs.getwriter(bzrlib.user_encoding)(sys.stdout, errors='replace')
 
481
    lf = log_formatter(log_format,
 
482
                       show_ids=False,
 
483
                       to_file=to_file,
 
484
                       show_timezone='original')
 
485
 
 
486
    # This is the first index which is different between
 
487
    # old and new
 
488
    base_idx = None
 
489
    for i in xrange(max(len(new_rh),
 
490
                        len(old_rh))):
 
491
        if (len(new_rh) <= i
 
492
            or len(old_rh) <= i
 
493
            or new_rh[i] != old_rh[i]):
 
494
            base_idx = i
 
495
            break
 
496
 
 
497
    if base_idx is None:
 
498
        to_file.write('Nothing seems to have changed\n')
 
499
        return
 
500
    ## TODO: It might be nice to do something like show_log
 
501
    ##       and show the merged entries. But since this is the
 
502
    ##       removed revisions, it shouldn't be as important
 
503
    if base_idx < len(old_rh):
 
504
        to_file.write('*'*60)
 
505
        to_file.write('\nRemoved Revisions:\n')
 
506
        for i in range(base_idx, len(old_rh)):
 
507
            rev = branch.repository.get_revision(old_rh[i])
 
508
            lf.show(i+1, rev, None)
 
509
        to_file.write('*'*60)
 
510
        to_file.write('\n\n')
 
511
    if base_idx < len(new_rh):
 
512
        to_file.write('Added Revisions:\n')
 
513
        show_log(branch,
 
514
                 lf,
 
515
                 None,
 
516
                 verbose=True,
 
517
                 direction='forward',
 
518
                 start_revision=base_idx+1,
 
519
                 end_revision=len(new_rh),
 
520
                 search=None)
 
521