~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/log.py

  • Committer: Robert Collins
  • Date: 2005-10-11 07:00:25 UTC
  • mto: This revision was merged to the branch mainline in revision 1443.
  • Revision ID: robertc@robertcollins.net-20051011070025-bac6b53cb6186dfd
create a config module - there is enough config logic to make this worthwhile, and start testing config processing.

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