~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/log.py

  • Committer: Robert Collins
  • Date: 2006-03-01 03:26:23 UTC
  • mto: (1594.2.4 integration)
  • mto: This revision was merged to the branch mainline in revision 1596.
  • Revision ID: robertc@robertcollins.net-20060301032623-9d3c073e102f2239
Move WeaveStore down into bzrlib.store.versioned.weave.

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
 
52
53
# TODO: option to show delta summaries for merged-in revisions
53
54
 
54
 
from itertools import izip
55
 
import re
56
 
 
57
 
from bzrlib import(
58
 
    registry,
59
 
    symbol_versioning,
60
 
    )
61
55
import bzrlib.errors as errors
62
 
from bzrlib.symbol_versioning import deprecated_method, zero_eleven
 
56
from bzrlib.tree import EmptyTree
 
57
from bzrlib.delta import compare_trees
63
58
from bzrlib.trace import mutter
64
 
from bzrlib.tsort import merge_sort
 
59
import re
65
60
 
66
61
 
67
62
def find_touching_revisions(branch, file_id):
118
113
    return rh
119
114
 
120
115
 
 
116
def _get_revision_delta(branch, revno):
 
117
    """Return the delta for a mainline revision.
 
118
    
 
119
    This is used to show summaries in verbose logs, and also for finding 
 
120
    revisions which touch a given file."""
 
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
 
121
127
def show_log(branch,
122
128
             lf,
123
129
             specific_fileid=None,
166
172
    """Worker function for show_log - see show_log."""
167
173
    from bzrlib.osutils import format_date
168
174
    from bzrlib.errors import BzrCheckError
 
175
    from bzrlib.textui import show_status
169
176
    
170
177
    from warnings import warn
171
178
 
195
202
 
196
203
    # list indexes are 0-based; revisions are 1-based
197
204
    cut_revs = which_revs[(start_revision-1):(end_revision)]
198
 
    if not cut_revs:
199
 
        return
200
 
 
201
 
    # convert the revision history to a dictionary:
202
 
    rev_nos = dict((k, v) for v, k in cut_revs)
203
 
 
204
 
    # override the mainline to look like the revision history.
205
 
    mainline_revs = [revision_id for index, revision_id in cut_revs]
206
 
    if cut_revs[0][0] == 1:
207
 
        mainline_revs.insert(0, None)
208
 
    else:
209
 
        mainline_revs.insert(0, which_revs[start_revision-2][1])
210
 
    # how should we show merged revisions ?
211
 
    # old api: show_merge. New api: show_merge_revno
212
 
    show_merge_revno = getattr(lf, 'show_merge_revno', None)
213
 
    show_merge = getattr(lf, 'show_merge', None)
214
 
    if show_merge is None and show_merge_revno is None:
215
 
        # no merged-revno support
216
 
        include_merges = False
217
 
    else:
218
 
        include_merges = True
219
 
    if show_merge is not None and show_merge_revno is None:
220
 
        # tell developers to update their code
221
 
        symbol_versioning.warn('LogFormatters should provide show_merge_revno '
222
 
            'instead of show_merge since bzr 0.11.',
223
 
            DeprecationWarning, stacklevel=3)
224
 
    view_revisions = list(get_view_revisions(mainline_revs, rev_nos, branch,
225
 
                          direction, include_merges=include_merges))
226
 
 
227
 
    def iter_revisions():
228
 
        # r = revision, n = revno, d = merge depth
229
 
        revision_ids = [r for r, n, d in view_revisions]
230
 
        zeros = set(r for r, n, d in view_revisions if d == 0)
231
 
        num = 9
232
 
        repository = branch.repository
233
 
        while revision_ids:
234
 
            cur_deltas = {}
235
 
            revisions = repository.get_revisions(revision_ids[:num])
236
 
            if verbose or specific_fileid:
237
 
                delta_revisions = [r for r in revisions if
238
 
                                   r.revision_id in zeros]
239
 
                deltas = repository.get_deltas_for_revisions(delta_revisions)
240
 
                cur_deltas = dict(izip((r.revision_id for r in 
241
 
                                        delta_revisions), deltas))
242
 
            for revision in revisions:
243
 
                # The delta value will be None unless
244
 
                # 1. verbose or specific_fileid is specified, and
245
 
                # 2. the revision is a mainline revision
246
 
                yield revision, cur_deltas.get(revision.revision_id)
247
 
            revision_ids  = revision_ids[num:]
248
 
            num = int(num * 1.5)
 
205
 
 
206
    if direction == 'reverse':
 
207
        cut_revs.reverse()
 
208
    elif direction == 'forward':
 
209
        pass
 
210
    else:
 
211
        raise ValueError('invalid direction %r' % direction)
 
212
 
 
213
    revision_history = branch.revision_history()
 
214
    for revno, rev_id in cut_revs:
 
215
        if verbose or specific_fileid:
 
216
            delta = _get_revision_delta(branch, revno)
249
217
            
250
 
    # now we just print all the revisions
251
 
    for ((rev_id, revno, merge_depth), (rev, delta)) in \
252
 
         izip(view_revisions, iter_revisions()):
 
218
        if specific_fileid:
 
219
            if not delta.touches_file_id(specific_fileid):
 
220
                continue
 
221
 
 
222
        if not verbose:
 
223
            # although we calculated it, throw it away without display
 
224
            delta = None
 
225
 
 
226
        rev = branch.repository.get_revision(rev_id)
253
227
 
254
228
        if searchRE:
255
229
            if not searchRE.search(rev.message):
256
230
                continue
257
231
 
258
 
        if merge_depth == 0:
259
 
            # a mainline revision.
260
 
                
261
 
            if specific_fileid:
262
 
                if not delta.touches_file_id(specific_fileid):
263
 
                    continue
 
232
        lf.show(revno, rev, delta)
 
233
        if hasattr(lf, 'show_merge'):
 
234
            if revno == 1:
 
235
                excludes = set()
 
236
            else:
 
237
                # revno is 1 based, so -2 to get back 1 less.
 
238
                repository = branch.repository
 
239
                excludes = repository.get_ancestry(revision_history[revno - 2])
 
240
                excludes = set(excludes)
 
241
            pending = list(rev.parent_ids)
 
242
            while pending:
 
243
                rev_id = pending.pop()
 
244
                if rev_id in excludes:
 
245
                    continue
 
246
                # prevent showing merged revs twice if they multi-path.
 
247
                excludes.add(rev_id)
 
248
                try:
 
249
                    rev = branch.repository.get_revision(rev_id)
 
250
                except errors.NoSuchRevision:
 
251
                    continue
 
252
                pending.extend(rev.parent_ids)
 
253
                lf.show_merge(rev)
 
254
 
 
255
 
 
256
def deltas_for_log_dummy(branch, which_revs):
 
257
    """Return all the revisions without intermediate deltas.
 
258
 
 
259
    Useful for log commands that won't need the delta information.
 
260
    """
264
261
    
265
 
            if not verbose:
266
 
                # although we calculated it, throw it away without display
267
 
                delta = None
268
 
 
269
 
            lf.show(revno, rev, delta)
 
262
    for revno, revision_id in which_revs:
 
263
        yield revno, branch.get_revision(revision_id), None
 
264
 
 
265
 
 
266
def deltas_for_log_reverse(branch, which_revs):
 
267
    """Compute deltas for display in latest-to-earliest order.
 
268
 
 
269
    branch
 
270
        Branch to traverse
 
271
 
 
272
    which_revs
 
273
        Sequence of (revno, revision_id) for the subset of history to examine
 
274
 
 
275
    returns 
 
276
        Sequence of (revno, rev, delta)
 
277
 
 
278
    The delta is from the given revision to the next one in the
 
279
    sequence, which makes sense if the log is being displayed from
 
280
    newest to oldest.
 
281
    """
 
282
    last_revno = last_revision_id = last_tree = None
 
283
    for revno, revision_id in which_revs:
 
284
        this_tree = branch.revision_tree(revision_id)
 
285
        this_revision = branch.get_revision(revision_id)
 
286
        
 
287
        if last_revno:
 
288
            yield last_revno, last_revision, compare_trees(this_tree, last_tree, False)
 
289
 
 
290
        this_tree = EmptyTree(branch.get_root_id())
 
291
 
 
292
        last_revno = revno
 
293
        last_revision = this_revision
 
294
        last_tree = this_tree
 
295
 
 
296
    if last_revno:
 
297
        if last_revno == 1:
 
298
            this_tree = EmptyTree(branch.get_root_id())
270
299
        else:
271
 
            if show_merge_revno is None:
272
 
                lf.show_merge(rev, merge_depth)
 
300
            this_revno = last_revno - 1
 
301
            this_revision_id = branch.revision_history()[this_revno]
 
302
            this_tree = branch.revision_tree(this_revision_id)
 
303
        yield last_revno, last_revision, compare_trees(this_tree, last_tree, False)
 
304
 
 
305
 
 
306
def deltas_for_log_forward(branch, which_revs):
 
307
    """Compute deltas for display in forward log.
 
308
 
 
309
    Given a sequence of (revno, revision_id) pairs, return
 
310
    (revno, rev, delta).
 
311
 
 
312
    The delta is from the given revision to the next one in the
 
313
    sequence, which makes sense if the log is being displayed from
 
314
    newest to oldest.
 
315
    """
 
316
    last_revno = last_revision_id = last_tree = None
 
317
    prev_tree = EmptyTree(branch.get_root_id())
 
318
 
 
319
    for revno, revision_id in which_revs:
 
320
        this_tree = branch.revision_tree(revision_id)
 
321
        this_revision = branch.get_revision(revision_id)
 
322
 
 
323
        if not last_revno:
 
324
            if revno == 1:
 
325
                last_tree = EmptyTree(branch.get_root_id())
273
326
            else:
274
 
                lf.show_merge_revno(rev, merge_depth, revno)
275
 
 
276
 
 
277
 
def get_view_revisions(mainline_revs, rev_nos, branch, direction,
278
 
                       include_merges=True):
279
 
    """Produce an iterator of revisions to show
280
 
    :return: an iterator of (revision_id, revno, merge_depth)
281
 
    (if there is no revno for a revision, None is supplied)
282
 
    """
283
 
    if include_merges is False:
284
 
        revision_ids = mainline_revs[1:]
285
 
        if direction == 'reverse':
286
 
            revision_ids.reverse()
287
 
        for revision_id in revision_ids:
288
 
            yield revision_id, str(rev_nos[revision_id]), 0
289
 
        return
290
 
    merge_sorted_revisions = merge_sort(
291
 
        branch.repository.get_revision_graph(mainline_revs[-1]),
292
 
        mainline_revs[-1],
293
 
        mainline_revs,
294
 
        generate_revno=True)
295
 
 
296
 
    if direction == 'forward':
297
 
        # forward means oldest first.
298
 
        merge_sorted_revisions = reverse_by_depth(merge_sorted_revisions)
299
 
    elif direction != 'reverse':
300
 
        raise ValueError('invalid direction %r' % direction)
301
 
 
302
 
    for sequence, rev_id, merge_depth, revno, end_of_merge in merge_sorted_revisions:
303
 
        yield rev_id, '.'.join(map(str, revno)), merge_depth
304
 
 
305
 
 
306
 
def reverse_by_depth(merge_sorted_revisions, _depth=0):
307
 
    """Reverse revisions by depth.
308
 
 
309
 
    Revisions with a different depth are sorted as a group with the previous
310
 
    revision of that depth.  There may be no topological justification for this,
311
 
    but it looks much nicer.
312
 
    """
313
 
    zd_revisions = []
314
 
    for val in merge_sorted_revisions:
315
 
        if val[2] == _depth:
316
 
            zd_revisions.append([val])
317
 
        else:
318
 
            assert val[2] > _depth
319
 
            zd_revisions[-1].append(val)
320
 
    for revisions in zd_revisions:
321
 
        if len(revisions) > 1:
322
 
            revisions[1:] = reverse_by_depth(revisions[1:], _depth + 1)
323
 
    zd_revisions.reverse()
324
 
    result = []
325
 
    for chunk in zd_revisions:
326
 
        result.extend(chunk)
327
 
    return result
 
327
                last_revno = revno - 1
 
328
                last_revision_id = branch.revision_history()[last_revno]
 
329
                last_tree = branch.revision_tree(last_revision_id)
 
330
 
 
331
        yield revno, this_revision, compare_trees(last_tree, this_tree, False)
 
332
 
 
333
        last_revno = revno
 
334
        last_revision = this_revision
 
335
        last_tree = this_tree
328
336
 
329
337
 
330
338
class LogFormatter(object):
331
339
    """Abstract class to display log messages."""
332
 
 
333
340
    def __init__(self, to_file, show_ids=False, show_timezone='original'):
334
341
        self.to_file = to_file
335
342
        self.show_ids = show_ids
336
343
        self.show_timezone = show_timezone
337
344
 
 
345
 
338
346
    def show(self, revno, rev, delta):
339
347
        raise NotImplementedError('not implemented in abstract base')
340
348
 
346
354
    def show(self, revno, rev, delta):
347
355
        return self._show_helper(revno=revno, rev=rev, delta=delta)
348
356
 
349
 
    @deprecated_method(zero_eleven)
350
 
    def show_merge(self, rev, merge_depth):
351
 
        return self._show_helper(rev=rev, indent='    '*merge_depth, merged=True, delta=None)
352
 
 
353
 
    def show_merge_revno(self, rev, merge_depth, revno):
354
 
        """Show a merged revision rev, with merge_depth and a revno."""
355
 
        return self._show_helper(rev=rev, revno=revno,
356
 
            indent='    '*merge_depth, merged=True, delta=None)
 
357
    def show_merge(self, rev):
 
358
        return self._show_helper(rev=rev, indent='    ', merged=True, delta=None)
357
359
 
358
360
    def _show_helper(self, rev=None, revno=None, indent='', merged=False, delta=None):
359
 
        """Show a revision, either merged or not."""
 
361
        """Show a revision, either merged or not."""
360
362
        from bzrlib.osutils import format_date
361
363
        to_file = self.to_file
362
364
        print >>to_file,  indent+'-' * 60
363
365
        if revno is not None:
364
 
            print >>to_file,  indent+'revno:', revno
 
366
            print >>to_file,  'revno:', revno
365
367
        if merged:
366
368
            print >>to_file,  indent+'merged:', rev.revision_id
367
369
        elif self.show_ids:
387
389
            message = rev.message.rstrip('\r\n')
388
390
            for l in message.split('\n'):
389
391
                print >>to_file,  indent+'  ' + l
390
 
        if delta is not None:
 
392
        if delta != None:
391
393
            delta.show(to_file, self.show_ids)
392
394
 
393
395
 
398
400
        to_file = self.to_file
399
401
        date_str = format_date(rev.timestamp, rev.timezone or 0,
400
402
                            self.show_timezone)
401
 
        print >>to_file, "%5s %s\t%s" % (revno, self.short_committer(rev),
 
403
        print >>to_file, "%5d %s\t%s" % (revno, self.short_committer(rev),
402
404
                format_date(rev.timestamp, rev.timezone or 0,
403
405
                            self.show_timezone, date_fmt="%Y-%m-%d",
404
406
                           show_offset=False))
413
415
 
414
416
        # TODO: Why not show the modified files in a shorter form as
415
417
        # well? rewrap them single lines of appropriate length
416
 
        if delta is not None:
 
418
        if delta != None:
417
419
            delta.show(to_file, self.show_ids)
418
420
        print >>to_file, ''
419
421
 
420
 
 
421
422
class LineLogFormatter(LogFormatter):
422
423
    def truncate(self, str, max_len):
423
424
        if len(str) <= max_len:
437
438
            return rev.message
438
439
 
439
440
    def show(self, revno, rev, delta):
440
 
        from bzrlib.osutils import terminal_width
441
 
        print >> self.to_file, self.log_string(revno, rev, terminal_width()-1)
 
441
        print >> self.to_file, self.log_string(rev, 79) 
442
442
 
443
 
    def log_string(self, revno, rev, max_chars):
444
 
        """Format log info into one string. Truncate tail of string
445
 
        :param  revno:      revision number (int) or None.
446
 
                            Revision numbers counts from 1.
447
 
        :param  rev:        revision info object
448
 
        :param  max_chars:  maximum length of resulting string
449
 
        :return:            formatted truncated string
450
 
        """
451
 
        out = []
452
 
        if revno:
453
 
            # show revno only when is not None
454
 
            out.append("%s:" % revno)
455
 
        out.append(self.truncate(self.short_committer(rev), 20))
 
443
    def log_string(self, rev, max_chars):
 
444
        out = [self.truncate(self.short_committer(rev), 20)]
456
445
        out.append(self.date_string(rev))
457
 
        out.append(rev.get_summary())
 
446
        out.append(self.message(rev).replace('\n', ' '))
458
447
        return self.truncate(" ".join(out).rstrip('\n'), max_chars)
459
448
 
460
 
 
461
449
def line_log(rev, max_chars):
462
450
    lf = LineLogFormatter(None)
463
 
    return lf.log_string(None, rev, max_chars)
464
 
 
465
 
 
466
 
class LogFormatterRegistry(registry.Registry):
467
 
    """Registry for log formatters"""
468
 
 
469
 
    def make_formatter(self, name, *args, **kwargs):
470
 
        """Construct a formatter from arguments.
471
 
 
472
 
        :param name: Name of the formatter to construct.  'short', 'long' and
473
 
            'line' are built-in.
474
 
        """
475
 
        return self.get(name)(*args, **kwargs)
476
 
 
477
 
    def get_default(self, branch):
478
 
        return self.get(branch.get_config().log_format())
479
 
 
480
 
 
481
 
log_formatter_registry = LogFormatterRegistry()
482
 
 
483
 
 
484
 
log_formatter_registry.register('short', ShortLogFormatter,
485
 
                                'Moderately short log format')
486
 
log_formatter_registry.register('long', LongLogFormatter,
487
 
                                'Detailed log format')
488
 
log_formatter_registry.register('line', LineLogFormatter,
489
 
                                'Log format with one line per revision')
490
 
 
 
451
    return lf.log_string(rev, max_chars)
 
452
 
 
453
FORMATTERS = {
 
454
              'long': LongLogFormatter,
 
455
              'short': ShortLogFormatter,
 
456
              'line': LineLogFormatter,
 
457
              }
491
458
 
492
459
def register_formatter(name, formatter):
493
 
    log_formatter_registry.register(name, formatter)
494
 
 
 
460
    FORMATTERS[name] = formatter
495
461
 
496
462
def log_formatter(name, *args, **kwargs):
497
463
    """Construct a formatter from arguments.
501
467
    """
502
468
    from bzrlib.errors import BzrCommandError
503
469
    try:
504
 
        return log_formatter_registry.make_formatter(name, *args, **kwargs)
 
470
        return FORMATTERS[name](*args, **kwargs)
505
471
    except KeyError:
506
472
        raise BzrCommandError("unknown log formatter: %r" % name)
507
473
 
508
 
 
509
474
def show_one_log(revno, rev, delta, verbose, to_file, show_timezone):
510
 
    # deprecated; for compatibility
 
475
    # deprecated; for compatability
511
476
    lf = LongLogFormatter(to_file=to_file, show_timezone=show_timezone)
512
477
    lf.show(revno, rev, delta)
513
478