~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/log.py

  • Committer: Aaron Bentley
  • Date: 2006-08-08 06:47:16 UTC
  • mto: (1910.2.43 format-bumps)
  • mto: This revision was merged to the branch mainline in revision 1922.
  • Revision ID: aaron.bentley@utoronto.ca-20060808064716-75bc465292c2708f
Ensure root entry always has a revision

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
1
# Copyright (C) 2005 Canonical Ltd
2
 
 
 
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
5
5
# the Free Software Foundation; either version 2 of the License, or
6
6
# (at your option) any later version.
7
 
 
 
7
#
8
8
# This program is distributed in the hope that it will be useful,
9
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11
11
# GNU General Public License for more details.
12
 
 
 
12
#
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
49
49
all the changes since the previous revision that touched hello.c.
50
50
"""
51
51
 
 
52
# TODO: option to show delta summaries for merged-in revisions
 
53
 
 
54
from itertools import izip
 
55
import re
52
56
 
53
57
import bzrlib.errors as errors
54
 
from bzrlib.tree import EmptyTree
55
 
from bzrlib.delta import compare_trees
56
58
from bzrlib.trace import mutter
57
 
import re
 
59
from bzrlib.tsort import merge_sort
58
60
 
59
61
 
60
62
def find_touching_revisions(branch, file_id):
72
74
    last_path = None
73
75
    revno = 1
74
76
    for revision_id in branch.revision_history():
75
 
        this_inv = branch.get_revision_inventory(revision_id)
 
77
        this_inv = branch.repository.get_revision_inventory(revision_id)
76
78
        if file_id in this_inv:
77
79
            this_ie = this_inv[file_id]
78
80
            this_path = this_inv.id2path(file_id)
111
113
    return rh
112
114
 
113
115
 
114
 
def _get_revision_delta(branch, revno):
115
 
    """Return the delta for a mainline revision.
116
 
    
117
 
    This is used to show summaries in verbose logs, and also for finding 
118
 
    revisions which touch a given file."""
119
 
    # XXX: What are we supposed to do when showing a summary for something 
120
 
    # other than a mainline revision.  The delta to it's first parent, or
121
 
    # (more useful) the delta to a nominated other revision.
122
 
    return branch.get_revision_delta(revno)
123
 
 
124
 
 
125
116
def show_log(branch,
126
117
             lf,
127
118
             specific_fileid=None,
170
161
    """Worker function for show_log - see show_log."""
171
162
    from bzrlib.osutils import format_date
172
163
    from bzrlib.errors import BzrCheckError
173
 
    from bzrlib.textui import show_status
174
164
    
175
165
    from warnings import warn
176
166
 
178
168
        warn("not a LogFormatter instance: %r" % lf)
179
169
 
180
170
    if specific_fileid:
181
 
        mutter('get log for file_id %r' % specific_fileid)
 
171
        mutter('get log for file_id %r', specific_fileid)
182
172
 
183
173
    if search is not None:
184
174
        import re
200
190
 
201
191
    # list indexes are 0-based; revisions are 1-based
202
192
    cut_revs = which_revs[(start_revision-1):(end_revision)]
203
 
 
204
 
    if direction == 'reverse':
205
 
        cut_revs.reverse()
206
 
    elif direction == 'forward':
207
 
        pass
208
 
    else:
 
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)
 
234
            
 
235
    # now we just print all the revisions
 
236
    for ((rev_id, revno, merge_depth), (rev, delta)) in \
 
237
         izip(view_revisions, iter_revisions()):
 
238
 
 
239
        if searchRE:
 
240
            if not searchRE.search(rev.message):
 
241
                continue
 
242
 
 
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
 
249
    
 
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':
209
281
        raise ValueError('invalid direction %r' % direction)
210
282
 
211
283
    revision_history = branch.revision_history()
212
 
    for revno, rev_id in cut_revs:
213
 
        if verbose or specific_fileid:
214
 
            delta = _get_revision_delta(branch, revno)
215
 
            
216
 
        if specific_fileid:
217
 
            if not delta.touches_file_id(specific_fileid):
218
 
                continue
219
 
 
220
 
        if not verbose:
221
 
            # although we calculated it, throw it away without display
222
 
            delta = None
223
 
 
224
 
        rev = branch.get_revision(rev_id)
225
 
 
226
 
        if searchRE:
227
 
            if not searchRE.search(rev.message):
228
 
                continue
229
 
 
230
 
        lf.show(revno, rev, delta)
231
 
        if hasattr(lf, 'show_merge'):
232
 
            if revno == 1:
233
 
                excludes = set()
234
 
            else:
235
 
                # revno is 1 based, so -2 to get back 1 less.
236
 
                excludes = set(branch.get_ancestry(revision_history[revno - 2]))
237
 
            pending = list(rev.parent_ids)
238
 
            while pending:
239
 
                rev_id = pending.pop()
240
 
                if rev_id in excludes:
241
 
                    continue
242
 
                # prevent showing merged revs twice if they multi-path.
243
 
                excludes.add(rev_id)
244
 
                try:
245
 
                    rev = branch.get_revision(rev_id)
246
 
                except errors.NoSuchRevision:
247
 
                    continue
248
 
                pending.extend(rev.parent_ids)
249
 
                lf.show_merge(rev)
250
 
 
251
 
 
252
 
def deltas_for_log_dummy(branch, which_revs):
253
 
    """Return all the revisions without intermediate deltas.
254
 
 
255
 
    Useful for log commands that won't need the delta information.
256
 
    """
257
 
    
258
 
    for revno, revision_id in which_revs:
259
 
        yield revno, branch.get_revision(revision_id), None
260
 
 
261
 
 
262
 
def deltas_for_log_reverse(branch, which_revs):
263
 
    """Compute deltas for display in latest-to-earliest order.
264
 
 
265
 
    branch
266
 
        Branch to traverse
267
 
 
268
 
    which_revs
269
 
        Sequence of (revno, revision_id) for the subset of history to examine
270
 
 
271
 
    returns 
272
 
        Sequence of (revno, rev, delta)
273
 
 
274
 
    The delta is from the given revision to the next one in the
275
 
    sequence, which makes sense if the log is being displayed from
276
 
    newest to oldest.
277
 
    """
278
 
    last_revno = last_revision_id = last_tree = None
279
 
    for revno, revision_id in which_revs:
280
 
        this_tree = branch.revision_tree(revision_id)
281
 
        this_revision = branch.get_revision(revision_id)
282
 
        
283
 
        if last_revno:
284
 
            yield last_revno, last_revision, compare_trees(this_tree, last_tree, False)
285
 
 
286
 
        this_tree = EmptyTree(branch.get_root_id())
287
 
 
288
 
        last_revno = revno
289
 
        last_revision = this_revision
290
 
        last_tree = this_tree
291
 
 
292
 
    if last_revno:
293
 
        if last_revno == 1:
294
 
            this_tree = EmptyTree(branch.get_root_id())
 
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])
295
300
        else:
296
 
            this_revno = last_revno - 1
297
 
            this_revision_id = branch.revision_history()[this_revno]
298
 
            this_tree = branch.revision_tree(this_revision_id)
299
 
        yield last_revno, last_revision, compare_trees(this_tree, last_tree, False)
300
 
 
301
 
 
302
 
def deltas_for_log_forward(branch, which_revs):
303
 
    """Compute deltas for display in forward log.
304
 
 
305
 
    Given a sequence of (revno, revision_id) pairs, return
306
 
    (revno, rev, delta).
307
 
 
308
 
    The delta is from the given revision to the next one in the
309
 
    sequence, which makes sense if the log is being displayed from
310
 
    newest to oldest.
311
 
    """
312
 
    last_revno = last_revision_id = last_tree = None
313
 
    prev_tree = EmptyTree(branch.get_root_id())
314
 
 
315
 
    for revno, revision_id in which_revs:
316
 
        this_tree = branch.revision_tree(revision_id)
317
 
        this_revision = branch.get_revision(revision_id)
318
 
 
319
 
        if not last_revno:
320
 
            if revno == 1:
321
 
                last_tree = EmptyTree(branch.get_root_id())
322
 
            else:
323
 
                last_revno = revno - 1
324
 
                last_revision_id = branch.revision_history()[last_revno]
325
 
                last_tree = branch.revision_tree(last_revision_id)
326
 
 
327
 
        yield revno, this_revision, compare_trees(last_tree, this_tree, False)
328
 
 
329
 
        last_revno = revno
330
 
        last_revision = this_revision
331
 
        last_tree = this_tree
 
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
332
311
 
333
312
 
334
313
class LogFormatter(object):
335
314
    """Abstract class to display log messages."""
 
315
 
336
316
    def __init__(self, to_file, show_ids=False, show_timezone='original'):
337
317
        self.to_file = to_file
338
318
        self.show_ids = show_ids
339
319
        self.show_timezone = show_timezone
340
320
 
341
 
 
342
321
    def show(self, revno, rev, delta):
343
322
        raise NotImplementedError('not implemented in abstract base')
344
323
 
 
324
    def short_committer(self, rev):
 
325
        return re.sub('<.*@.*>', '', rev.committer).strip(' ')
 
326
    
345
327
    
346
328
class LongLogFormatter(LogFormatter):
347
329
    def show(self, revno, rev, delta):
348
 
        from osutils import format_date
349
 
 
350
 
        to_file = self.to_file
351
 
 
352
 
        print >>to_file,  '-' * 60
353
 
        print >>to_file,  'revno:', revno
354
 
        if self.show_ids:
355
 
            print >>to_file,  'revision-id:', rev.revision_id
356
 
 
357
 
            for parent_id in rev.parent_ids:
358
 
                print >>to_file, 'parent:', parent_id
359
 
            
360
 
        print >>to_file,  'committer:', rev.committer
361
 
 
362
 
        date_str = format_date(rev.timestamp,
363
 
                               rev.timezone or 0,
364
 
                               self.show_timezone)
365
 
        print >>to_file,  'timestamp: %s' % date_str
366
 
 
367
 
        print >>to_file,  'message:'
368
 
        if not rev.message:
369
 
            print >>to_file,  '  (no message)'
370
 
        else:
371
 
            for l in rev.message.split('\n'):
372
 
                print >>to_file,  '  ' + l
373
 
 
374
 
        if delta != None:
375
 
            delta.show(to_file, self.show_ids)
376
 
 
377
 
    def show_merge(self, rev):
378
 
        from osutils import format_date
379
 
 
380
 
        to_file = self.to_file
381
 
 
382
 
        indent = '    '
383
 
 
 
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
 
338
        to_file = self.to_file
384
339
        print >>to_file,  indent+'-' * 60
385
 
        print >>to_file,  indent+'merged:', rev.revision_id
 
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
386
346
        if self.show_ids:
387
347
            for parent_id in rev.parent_ids:
388
348
                print >>to_file, indent+'parent:', parent_id
389
 
            
390
349
        print >>to_file,  indent+'committer:', rev.committer
391
 
 
 
350
        try:
 
351
            print >>to_file, indent+'branch nick: %s' % \
 
352
                rev.properties['branch-nick']
 
353
        except KeyError:
 
354
            pass
392
355
        date_str = format_date(rev.timestamp,
393
356
                               rev.timezone or 0,
394
357
                               self.show_timezone)
398
361
        if not rev.message:
399
362
            print >>to_file,  indent+'  (no message)'
400
363
        else:
401
 
            for l in rev.message.split('\n'):
 
364
            message = rev.message.rstrip('\r\n')
 
365
            for l in message.split('\n'):
402
366
                print >>to_file,  indent+'  ' + l
 
367
        if delta != None:
 
368
            delta.show(to_file, self.show_ids)
403
369
 
404
370
 
405
371
class ShortLogFormatter(LogFormatter):
409
375
        to_file = self.to_file
410
376
        date_str = format_date(rev.timestamp, rev.timezone or 0,
411
377
                            self.show_timezone)
412
 
        print >>to_file, "%5d %s\t%s" % (revno, rev.committer,
 
378
        print >>to_file, "%5d %s\t%s" % (revno, self.short_committer(rev),
413
379
                format_date(rev.timestamp, rev.timezone or 0,
414
 
                            self.show_timezone))
 
380
                            self.show_timezone, date_fmt="%Y-%m-%d",
 
381
                           show_offset=False))
415
382
        if self.show_ids:
416
383
            print >>to_file,  '      revision-id:', rev.revision_id
417
384
        if not rev.message:
418
385
            print >>to_file,  '      (no message)'
419
386
        else:
420
 
            for l in rev.message.split('\n'):
 
387
            message = rev.message.rstrip('\r\n')
 
388
            for l in message.split('\n'):
421
389
                print >>to_file,  '      ' + l
422
390
 
423
391
        # TODO: Why not show the modified files in a shorter form as
424
392
        # well? rewrap them single lines of appropriate length
425
393
        if delta != None:
426
394
            delta.show(to_file, self.show_ids)
427
 
        print
 
395
        print >>to_file, ''
 
396
 
428
397
 
429
398
class LineLogFormatter(LogFormatter):
430
399
    def truncate(self, str, max_len):
444
413
        else:
445
414
            return rev.message
446
415
 
447
 
    def short_committer(self, rev):
448
 
        return re.sub('<.*@.*>', '', rev.committer).strip(' ')
449
 
    
450
416
    def show(self, revno, rev, delta):
451
 
        print >> self.to_file, self.log_string(rev, 79) 
 
417
        from bzrlib.osutils import terminal_width
 
418
        print >> self.to_file, self.log_string(revno, rev, terminal_width()-1)
452
419
 
453
 
    def log_string(self, rev, max_chars):
454
 
        out = [self.truncate(self.short_committer(rev), 20)]
 
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))
455
433
        out.append(self.date_string(rev))
456
 
        out.append(self.message(rev).replace('\n', ' '))
 
434
        out.append(rev.get_summary())
457
435
        return self.truncate(" ".join(out).rstrip('\n'), max_chars)
458
436
 
 
437
 
459
438
def line_log(rev, max_chars):
460
439
    lf = LineLogFormatter(None)
461
 
    return lf.log_string(rev, max_chars)
 
440
    return lf.log_string(None, rev, max_chars)
462
441
 
463
 
FORMATTERS = {'long': LongLogFormatter,
 
442
FORMATTERS = {
 
443
              'long': LongLogFormatter,
464
444
              'short': ShortLogFormatter,
465
445
              'line': LineLogFormatter,
466
446
              }
467
447
 
 
448
def register_formatter(name, formatter):
 
449
    FORMATTERS[name] = formatter
468
450
 
469
451
def log_formatter(name, *args, **kwargs):
470
452
    """Construct a formatter from arguments.
475
457
    from bzrlib.errors import BzrCommandError
476
458
    try:
477
459
        return FORMATTERS[name](*args, **kwargs)
478
 
    except IndexError:
 
460
    except KeyError:
479
461
        raise BzrCommandError("unknown log formatter: %r" % name)
480
462
 
481
463
def show_one_log(revno, rev, delta, verbose, to_file, show_timezone):
482
 
    # deprecated; for compatability
 
464
    # deprecated; for compatibility
483
465
    lf = LongLogFormatter(to_file=to_file, show_timezone=show_timezone)
484
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