~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/log.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2007-06-12 06:07:27 UTC
  • mfrom: (2522.1.1 bzr.dev)
  • Revision ID: pqm@pqm.ubuntu.com-20070612060727-v8nd5etbkay15fm2
prepare for 0.18 development

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005 Canonical Ltd
2
 
 
 
1
# Copyright (C) 2005, 2006, 2007 Canonical Ltd
 
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
# TODO: option to show delta summaries for merged-in revisions
 
53
 
 
54
from itertools import izip
 
55
import re
 
56
 
 
57
from bzrlib import (
 
58
    registry,
 
59
    symbol_versioning,
 
60
    )
53
61
import bzrlib.errors as errors
54
 
from bzrlib.tree import EmptyTree
55
 
from bzrlib.delta import compare_trees
 
62
from bzrlib.symbol_versioning import (
 
63
    deprecated_method,
 
64
    zero_eleven,
 
65
    zero_seventeen,
 
66
    )
56
67
from bzrlib.trace import mutter
57
 
import re
 
68
from bzrlib.tsort import (
 
69
    merge_sort,
 
70
    topo_sort,
 
71
    )
58
72
 
59
73
 
60
74
def find_touching_revisions(branch, file_id):
72
86
    last_path = None
73
87
    revno = 1
74
88
    for revision_id in branch.revision_history():
75
 
        this_inv = branch.get_revision_inventory(revision_id)
 
89
        this_inv = branch.repository.get_revision_inventory(revision_id)
76
90
        if file_id in this_inv:
77
91
            this_ie = this_inv[file_id]
78
92
            this_path = this_inv.id2path(file_id)
111
125
    return rh
112
126
 
113
127
 
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
128
def show_log(branch,
126
129
             lf,
127
130
             specific_fileid=None,
129
132
             direction='reverse',
130
133
             start_revision=None,
131
134
             end_revision=None,
132
 
             search=None):
 
135
             search=None,
 
136
             limit=None):
133
137
    """Write out human-readable log of commits to this branch.
134
138
 
135
139
    lf
151
155
 
152
156
    end_revision
153
157
        If not None, only show revisions <= end_revision
 
158
 
 
159
    search
 
160
        If not None, only show revisions with matching commit messages
 
161
 
 
162
    limit
 
163
        If not None or 0, only show limit revisions
154
164
    """
155
165
    branch.lock_read()
156
166
    try:
 
167
        if getattr(lf, 'begin_log', None):
 
168
            lf.begin_log()
 
169
 
157
170
        _show_log(branch, lf, specific_fileid, verbose, direction,
158
 
                  start_revision, end_revision, search)
 
171
                  start_revision, end_revision, search, limit)
 
172
 
 
173
        if getattr(lf, 'end_log', None):
 
174
            lf.end_log()
159
175
    finally:
160
176
        branch.unlock()
161
 
    
 
177
 
162
178
def _show_log(branch,
163
179
             lf,
164
180
             specific_fileid=None,
166
182
             direction='reverse',
167
183
             start_revision=None,
168
184
             end_revision=None,
169
 
             search=None):
 
185
             search=None,
 
186
             limit=None):
170
187
    """Worker function for show_log - see show_log."""
171
188
    from bzrlib.osutils import format_date
172
189
    from bzrlib.errors import BzrCheckError
173
 
    from bzrlib.textui import show_status
174
190
    
175
191
    from warnings import warn
176
192
 
200
216
 
201
217
    # list indexes are 0-based; revisions are 1-based
202
218
    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:
209
 
        raise ValueError('invalid direction %r' % direction)
210
 
 
211
 
    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)
 
219
    if not cut_revs:
 
220
        return
 
221
 
 
222
    # convert the revision history to a dictionary:
 
223
    rev_nos = dict((k, v) for v, k in cut_revs)
 
224
 
 
225
    # override the mainline to look like the revision history.
 
226
    mainline_revs = [revision_id for index, revision_id in cut_revs]
 
227
    if cut_revs[0][0] == 1:
 
228
        mainline_revs.insert(0, None)
 
229
    else:
 
230
        mainline_revs.insert(0, which_revs[start_revision-2][1])
 
231
    legacy_lf = getattr(lf, 'log_revision', None) is None
 
232
    if legacy_lf:
 
233
        # pre-0.17 formatters use show for mainline revisions.
 
234
        # how should we show merged revisions ?
 
235
        #   pre-0.11 api: show_merge
 
236
        #   0.11-0.16 api: show_merge_revno
 
237
        show_merge_revno = getattr(lf, 'show_merge_revno', None)
 
238
        show_merge = getattr(lf, 'show_merge', None)
 
239
        if show_merge is None and show_merge_revno is None:
 
240
            # no merged-revno support
 
241
            generate_merge_revisions = False
 
242
        else:
 
243
            generate_merge_revisions = True
 
244
        # tell developers to update their code
 
245
        symbol_versioning.warn('LogFormatters should provide log_revision '
 
246
            'instead of show and show_merge_revno since bzr 0.17.',
 
247
            DeprecationWarning, stacklevel=3)
 
248
    else:
 
249
        generate_merge_revisions = getattr(lf, 'supports_merge_revisions', 
 
250
                                           False)
 
251
    view_revs_iter = get_view_revisions(mainline_revs, rev_nos, branch,
 
252
                          direction, include_merges=generate_merge_revisions)
 
253
    if specific_fileid:
 
254
        view_revisions = _get_revisions_touching_file_id(branch,
 
255
                                                         specific_fileid,
 
256
                                                         mainline_revs,
 
257
                                                         view_revs_iter)
 
258
    else:
 
259
        view_revisions = list(view_revs_iter)
 
260
 
 
261
    rev_tag_dict = {}
 
262
    generate_tags = getattr(lf, 'supports_tags', False)
 
263
    if generate_tags:
 
264
        if branch.supports_tags():
 
265
            rev_tag_dict = branch.tags.get_reverse_tag_dict()
 
266
 
 
267
    generate_delta = verbose and getattr(lf, 'supports_delta', False)
 
268
 
 
269
    def iter_revisions():
 
270
        # r = revision, n = revno, d = merge depth
 
271
        revision_ids = [r for r, n, d in view_revisions]
 
272
        zeros = set(r for r, n, d in view_revisions if d == 0)
 
273
        num = 9
 
274
        repository = branch.repository
 
275
        while revision_ids:
 
276
            cur_deltas = {}
 
277
            revisions = repository.get_revisions(revision_ids[:num])
 
278
            if generate_delta:
 
279
                delta_revisions = [r for r in revisions if
 
280
                                   r.revision_id in zeros]
 
281
                deltas = repository.get_deltas_for_revisions(delta_revisions)
 
282
                cur_deltas = dict(izip((r.revision_id for r in 
 
283
                                        delta_revisions), deltas))
 
284
            for revision in revisions:
 
285
                # The delta value will be None unless
 
286
                # 1. verbose is specified, and
 
287
                # 2. the revision is a mainline revision
 
288
                yield revision, cur_deltas.get(revision.revision_id)
 
289
            revision_ids  = revision_ids[num:]
 
290
            num = min(int(num * 1.5), 200)
 
291
 
 
292
    # now we just print all the revisions
 
293
    log_count = 0
 
294
    for ((rev_id, revno, merge_depth), (rev, delta)) in \
 
295
         izip(view_revisions, iter_revisions()):
225
296
 
226
297
        if searchRE:
227
298
            if not searchRE.search(rev.message):
228
299
                continue
229
300
 
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())
295
 
        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
        if not legacy_lf:
 
302
            lr = LogRevision(rev, revno, merge_depth, delta,
 
303
                             rev_tag_dict.get(rev_id))
 
304
            lf.log_revision(lr)
 
305
        else:
 
306
            # support for legacy (pre-0.17) LogFormatters
 
307
            if merge_depth == 0:
 
308
                if generate_tags:
 
309
                    lf.show(revno, rev, delta, rev_tag_dict.get(rev_id))
 
310
                else:
 
311
                    lf.show(revno, rev, delta)
 
312
            else:
 
313
                if show_merge_revno is None:
 
314
                    lf.show_merge(rev, merge_depth)
 
315
                else:
 
316
                    if generate_tags:
 
317
                        lf.show_merge_revno(rev, merge_depth, revno,
 
318
                                            rev_tag_dict.get(rev_id))
 
319
                    else:
 
320
                        lf.show_merge_revno(rev, merge_depth, revno)
 
321
        if limit:
 
322
            log_count += 1
 
323
            if log_count >= limit:
 
324
                break
 
325
 
 
326
 
 
327
def _get_revisions_touching_file_id(branch, file_id, mainline_revisions,
 
328
                                    view_revs_iter):
 
329
    """Return the list of revision ids which touch a given file id.
 
330
 
 
331
    This includes the revisions which directly change the file id,
 
332
    and the revisions which merge these changes. So if the
 
333
    revision graph is::
 
334
        A
 
335
        |\
 
336
        B C
 
337
        |/
 
338
        D
 
339
 
 
340
    And 'C' changes a file, then both C and D will be returned.
 
341
 
 
342
    This will also can be restricted based on a subset of the mainline.
 
343
 
 
344
    :return: A list of (revision_id, dotted_revno, merge_depth) tuples.
 
345
    """
 
346
    # find all the revisions that change the specific file
 
347
    file_weave = branch.repository.weave_store.get_weave(file_id,
 
348
                branch.repository.get_transaction())
 
349
    weave_modifed_revisions = set(file_weave.versions())
 
350
    # build the ancestry of each revision in the graph
 
351
    # - only listing the ancestors that change the specific file.
 
352
    rev_graph = branch.repository.get_revision_graph(mainline_revisions[-1])
 
353
    sorted_rev_list = topo_sort(rev_graph)
 
354
    ancestry = {}
 
355
    for rev in sorted_rev_list:
 
356
        parents = rev_graph[rev]
 
357
        if rev not in weave_modifed_revisions and len(parents) == 1:
 
358
            # We will not be adding anything new, so just use a reference to
 
359
            # the parent ancestry.
 
360
            rev_ancestry = ancestry[parents[0]]
 
361
        else:
 
362
            rev_ancestry = set()
 
363
            if rev in weave_modifed_revisions:
 
364
                rev_ancestry.add(rev)
 
365
            for parent in parents:
 
366
                rev_ancestry = rev_ancestry.union(ancestry[parent])
 
367
        ancestry[rev] = rev_ancestry
 
368
 
 
369
    def is_merging_rev(r):
 
370
        parents = rev_graph[r]
 
371
        if len(parents) > 1:
 
372
            leftparent = parents[0]
 
373
            for rightparent in parents[1:]:
 
374
                if not ancestry[leftparent].issuperset(
 
375
                        ancestry[rightparent]):
 
376
                    return True
 
377
        return False
 
378
 
 
379
    # filter from the view the revisions that did not change or merge 
 
380
    # the specific file
 
381
    return [(r, n, d) for r, n, d in view_revs_iter
 
382
            if r in weave_modifed_revisions or is_merging_rev(r)]
 
383
 
 
384
 
 
385
def get_view_revisions(mainline_revs, rev_nos, branch, direction,
 
386
                       include_merges=True):
 
387
    """Produce an iterator of revisions to show
 
388
    :return: an iterator of (revision_id, revno, merge_depth)
 
389
    (if there is no revno for a revision, None is supplied)
 
390
    """
 
391
    if include_merges is False:
 
392
        revision_ids = mainline_revs[1:]
 
393
        if direction == 'reverse':
 
394
            revision_ids.reverse()
 
395
        for revision_id in revision_ids:
 
396
            yield revision_id, str(rev_nos[revision_id]), 0
 
397
        return
 
398
    merge_sorted_revisions = merge_sort(
 
399
        branch.repository.get_revision_graph(mainline_revs[-1]),
 
400
        mainline_revs[-1],
 
401
        mainline_revs,
 
402
        generate_revno=True)
 
403
 
 
404
    if direction == 'forward':
 
405
        # forward means oldest first.
 
406
        merge_sorted_revisions = reverse_by_depth(merge_sorted_revisions)
 
407
    elif direction != 'reverse':
 
408
        raise ValueError('invalid direction %r' % direction)
 
409
 
 
410
    for sequence, rev_id, merge_depth, revno, end_of_merge in merge_sorted_revisions:
 
411
        yield rev_id, '.'.join(map(str, revno)), merge_depth
 
412
 
 
413
 
 
414
def reverse_by_depth(merge_sorted_revisions, _depth=0):
 
415
    """Reverse revisions by depth.
 
416
 
 
417
    Revisions with a different depth are sorted as a group with the previous
 
418
    revision of that depth.  There may be no topological justification for this,
 
419
    but it looks much nicer.
 
420
    """
 
421
    zd_revisions = []
 
422
    for val in merge_sorted_revisions:
 
423
        if val[2] == _depth:
 
424
            zd_revisions.append([val])
 
425
        else:
 
426
            assert val[2] > _depth
 
427
            zd_revisions[-1].append(val)
 
428
    for revisions in zd_revisions:
 
429
        if len(revisions) > 1:
 
430
            revisions[1:] = reverse_by_depth(revisions[1:], _depth + 1)
 
431
    zd_revisions.reverse()
 
432
    result = []
 
433
    for chunk in zd_revisions:
 
434
        result.extend(chunk)
 
435
    return result
 
436
 
 
437
 
 
438
class LogRevision(object):
 
439
    """A revision to be logged (by LogFormatter.log_revision).
 
440
 
 
441
    A simple wrapper for the attributes of a revision to be logged.
 
442
    The attributes may or may not be populated, as determined by the 
 
443
    logging options and the log formatter capabilities.
 
444
    """
 
445
 
 
446
    def __init__(self, rev=None, revno=None, merge_depth=0, delta=None,
 
447
                 tags=None):
 
448
        self.rev = rev
 
449
        self.revno = revno
 
450
        self.merge_depth = merge_depth
 
451
        self.delta = delta
 
452
        self.tags = tags
332
453
 
333
454
 
334
455
class LogFormatter(object):
335
 
    """Abstract class to display log messages."""
 
456
    """Abstract class to display log messages.
 
457
 
 
458
    At a minimum, a derived class must implement the log_revision method.
 
459
 
 
460
    If the LogFormatter needs to be informed of the beginning or end of
 
461
    a log it should implement the begin_log and/or end_log hook methods.
 
462
 
 
463
    A LogFormatter should define the following supports_XXX flags 
 
464
    to indicate which LogRevision attributes it supports:
 
465
 
 
466
    - supports_delta must be True if this log formatter supports delta.
 
467
        Otherwise the delta attribute may not be populated.
 
468
    - supports_merge_revisions must be True if this log formatter supports 
 
469
        merge revisions.  If not, only revisions mainline revisions (those 
 
470
        with merge_depth == 0) will be passed to the formatter.
 
471
    - supports_tags must be True if this log formatter supports tags.
 
472
        Otherwise the tags attribute may not be populated.
 
473
    """
 
474
 
336
475
    def __init__(self, to_file, show_ids=False, show_timezone='original'):
337
476
        self.to_file = to_file
338
477
        self.show_ids = show_ids
339
478
        self.show_timezone = show_timezone
340
479
 
 
480
# TODO: uncomment this block after show() has been removed.
 
481
# Until then defining log_revision would prevent _show_log calling show() 
 
482
# in legacy formatters.
 
483
#    def log_revision(self, revision):
 
484
#        """Log a revision.
 
485
#
 
486
#        :param  revision:   The LogRevision to be logged.
 
487
#        """
 
488
#        raise NotImplementedError('not implemented in abstract base')
341
489
 
 
490
    @deprecated_method(zero_seventeen)
342
491
    def show(self, revno, rev, delta):
343
492
        raise NotImplementedError('not implemented in abstract base')
344
493
 
345
494
    def short_committer(self, rev):
346
495
        return re.sub('<.*@.*>', '', rev.committer).strip(' ')
347
 
    
348
 
    
 
496
 
 
497
 
349
498
class LongLogFormatter(LogFormatter):
350
 
    def show(self, revno, rev, delta):
351
 
        return self._show_helper(revno=revno, rev=rev)
352
 
 
353
 
    def show_merge(self, rev):
354
 
        return self._show_helper(rev=rev, indent='    ', merged=True)
355
 
 
356
 
    def _show_helper(self, rev=None, revno=None, indent='', merged=False):
357
 
        from osutils import format_date
358
 
 
 
499
 
 
500
    supports_merge_revisions = True
 
501
    supports_delta = True
 
502
    supports_tags = True
 
503
 
 
504
    @deprecated_method(zero_seventeen)
 
505
    def show(self, revno, rev, delta, tags=None):
 
506
        lr = LogRevision(rev, revno, 0, delta, tags)
 
507
        return self.log_revision(lr)
 
508
 
 
509
    @deprecated_method(zero_eleven)
 
510
    def show_merge(self, rev, merge_depth):
 
511
        lr = LogRevision(rev, merge_depth=merge_depth)
 
512
        return self.log_revision(lr)
 
513
 
 
514
    @deprecated_method(zero_seventeen)
 
515
    def show_merge_revno(self, rev, merge_depth, revno, tags=None):
 
516
        """Show a merged revision rev, with merge_depth and a revno."""
 
517
        lr = LogRevision(rev, revno, merge_depth, tags=tags)
 
518
        return self.log_revision(lr)
 
519
 
 
520
    def log_revision(self, revision):
 
521
        """Log a revision, either merged or not."""
 
522
        from bzrlib.osutils import format_date
 
523
        indent = '    '*revision.merge_depth
359
524
        to_file = self.to_file
360
 
 
361
 
 
362
525
        print >>to_file,  indent+'-' * 60
363
 
        if revno is not None:
364
 
            print >>to_file,  'revno:', revno
365
 
        if merged:
366
 
            print >>to_file,  indent+'merged:', rev.revision_id
367
 
        elif self.show_ids:
368
 
            print >>to_file,  indent+'revision-id:', rev.revision_id
 
526
        if revision.revno is not None:
 
527
            print >>to_file,  indent+'revno:', revision.revno
 
528
        if revision.tags:
 
529
            print >>to_file, indent+'tags: %s' % (', '.join(revision.tags))
369
530
        if self.show_ids:
370
 
            for parent_id in rev.parent_ids:
 
531
            print >>to_file, indent+'revision-id:', revision.rev.revision_id
 
532
            for parent_id in revision.rev.parent_ids:
371
533
                print >>to_file, indent+'parent:', parent_id
372
 
            
373
 
        print >>to_file,  indent+'committer:', rev.committer
 
534
        print >>to_file, indent+'committer:', revision.rev.committer
 
535
 
374
536
        try:
375
537
            print >>to_file, indent+'branch nick: %s' % \
376
 
                rev.properties['branch-nick']
 
538
                revision.rev.properties['branch-nick']
377
539
        except KeyError:
378
540
            pass
379
 
 
380
 
        date_str = format_date(rev.timestamp,
381
 
                               rev.timezone or 0,
 
541
        date_str = format_date(revision.rev.timestamp,
 
542
                               revision.rev.timezone or 0,
382
543
                               self.show_timezone)
383
544
        print >>to_file,  indent+'timestamp: %s' % date_str
384
545
 
385
546
        print >>to_file,  indent+'message:'
386
 
        if not rev.message:
 
547
        if not revision.rev.message:
387
548
            print >>to_file,  indent+'  (no message)'
388
549
        else:
389
 
            for l in rev.message.split('\n'):
 
550
            message = revision.rev.message.rstrip('\r\n')
 
551
            for l in message.split('\n'):
390
552
                print >>to_file,  indent+'  ' + l
 
553
        if revision.delta is not None:
 
554
            revision.delta.show(to_file, self.show_ids)
391
555
 
392
556
 
393
557
class ShortLogFormatter(LogFormatter):
 
558
 
 
559
    supports_delta = True
 
560
 
 
561
    @deprecated_method(zero_seventeen)
394
562
    def show(self, revno, rev, delta):
 
563
        lr = LogRevision(rev, revno, 0, delta)
 
564
        return self.log_revision(lr)
 
565
 
 
566
    def log_revision(self, revision):
395
567
        from bzrlib.osutils import format_date
396
568
 
397
569
        to_file = self.to_file
398
 
        date_str = format_date(rev.timestamp, rev.timezone or 0,
399
 
                            self.show_timezone)
400
 
        print >>to_file, "%5d %s\t%s" % (revno, self.short_committer(rev),
401
 
                format_date(rev.timestamp, rev.timezone or 0,
 
570
        date_str = format_date(revision.rev.timestamp,
 
571
                               revision.rev.timezone or 0,
 
572
                               self.show_timezone)
 
573
        is_merge = ''
 
574
        if len(revision.rev.parent_ids) > 1:
 
575
            is_merge = ' [merge]'
 
576
        print >>to_file, "%5s %s\t%s%s" % (revision.revno,
 
577
                self.short_committer(revision.rev),
 
578
                format_date(revision.rev.timestamp,
 
579
                            revision.rev.timezone or 0,
402
580
                            self.show_timezone, date_fmt="%Y-%m-%d",
403
 
                           show_offset=False))
 
581
                            show_offset=False),
 
582
                is_merge)
404
583
        if self.show_ids:
405
 
            print >>to_file,  '      revision-id:', rev.revision_id
406
 
        if not rev.message:
 
584
            print >>to_file,  '      revision-id:', revision.rev.revision_id
 
585
        if not revision.rev.message:
407
586
            print >>to_file,  '      (no message)'
408
587
        else:
409
 
            for l in rev.message.split('\n'):
 
588
            message = revision.rev.message.rstrip('\r\n')
 
589
            for l in message.split('\n'):
410
590
                print >>to_file,  '      ' + l
411
591
 
412
592
        # TODO: Why not show the modified files in a shorter form as
413
593
        # well? rewrap them single lines of appropriate length
414
 
        if delta != None:
415
 
            delta.show(to_file, self.show_ids)
416
 
        print
 
594
        if revision.delta is not None:
 
595
            revision.delta.show(to_file, self.show_ids)
 
596
        print >>to_file, ''
 
597
 
417
598
 
418
599
class LineLogFormatter(LogFormatter):
 
600
 
 
601
    def __init__(self, *args, **kwargs):
 
602
        from bzrlib.osutils import terminal_width
 
603
        super(LineLogFormatter, self).__init__(*args, **kwargs)
 
604
        self._max_chars = terminal_width() - 1
 
605
 
419
606
    def truncate(self, str, max_len):
420
607
        if len(str) <= max_len:
421
608
            return str
433
620
        else:
434
621
            return rev.message
435
622
 
 
623
    @deprecated_method(zero_seventeen)
436
624
    def show(self, revno, rev, delta):
437
 
        print >> self.to_file, self.log_string(rev, 79) 
438
 
 
439
 
    def log_string(self, rev, max_chars):
440
 
        out = [self.truncate(self.short_committer(rev), 20)]
 
625
        from bzrlib.osutils import terminal_width
 
626
        print >> self.to_file, self.log_string(revno, rev, terminal_width()-1)
 
627
 
 
628
    def log_revision(self, revision):
 
629
        print >>self.to_file, self.log_string(revision.revno, revision.rev,
 
630
                                              self._max_chars)
 
631
 
 
632
    def log_string(self, revno, rev, max_chars):
 
633
        """Format log info into one string. Truncate tail of string
 
634
        :param  revno:      revision number (int) or None.
 
635
                            Revision numbers counts from 1.
 
636
        :param  rev:        revision info object
 
637
        :param  max_chars:  maximum length of resulting string
 
638
        :return:            formatted truncated string
 
639
        """
 
640
        out = []
 
641
        if revno:
 
642
            # show revno only when is not None
 
643
            out.append("%s:" % revno)
 
644
        out.append(self.truncate(self.short_committer(rev), 20))
441
645
        out.append(self.date_string(rev))
442
 
        out.append(self.message(rev).replace('\n', ' '))
 
646
        out.append(rev.get_summary())
443
647
        return self.truncate(" ".join(out).rstrip('\n'), max_chars)
444
648
 
 
649
 
445
650
def line_log(rev, max_chars):
446
651
    lf = LineLogFormatter(None)
447
 
    return lf.log_string(rev, max_chars)
448
 
 
449
 
FORMATTERS = {'long': LongLogFormatter,
450
 
              'short': ShortLogFormatter,
451
 
              'line': LineLogFormatter,
452
 
              }
 
652
    return lf.log_string(None, rev, max_chars)
 
653
 
 
654
 
 
655
class LogFormatterRegistry(registry.Registry):
 
656
    """Registry for log formatters"""
 
657
 
 
658
    def make_formatter(self, name, *args, **kwargs):
 
659
        """Construct a formatter from arguments.
 
660
 
 
661
        :param name: Name of the formatter to construct.  'short', 'long' and
 
662
            'line' are built-in.
 
663
        """
 
664
        return self.get(name)(*args, **kwargs)
 
665
 
 
666
    def get_default(self, branch):
 
667
        return self.get(branch.get_config().log_format())
 
668
 
 
669
 
 
670
log_formatter_registry = LogFormatterRegistry()
 
671
 
 
672
 
 
673
log_formatter_registry.register('short', ShortLogFormatter,
 
674
                                'Moderately short log format')
 
675
log_formatter_registry.register('long', LongLogFormatter,
 
676
                                'Detailed log format')
 
677
log_formatter_registry.register('line', LineLogFormatter,
 
678
                                'Log format with one line per revision')
 
679
 
 
680
 
 
681
def register_formatter(name, formatter):
 
682
    log_formatter_registry.register(name, formatter)
453
683
 
454
684
 
455
685
def log_formatter(name, *args, **kwargs):
460
690
    """
461
691
    from bzrlib.errors import BzrCommandError
462
692
    try:
463
 
        return FORMATTERS[name](*args, **kwargs)
464
 
    except IndexError:
 
693
        return log_formatter_registry.make_formatter(name, *args, **kwargs)
 
694
    except KeyError:
465
695
        raise BzrCommandError("unknown log formatter: %r" % name)
466
696
 
 
697
 
467
698
def show_one_log(revno, rev, delta, verbose, to_file, show_timezone):
468
 
    # deprecated; for compatability
 
699
    # deprecated; for compatibility
469
700
    lf = LongLogFormatter(to_file=to_file, show_timezone=show_timezone)
470
701
    lf.show(revno, rev, delta)
471
702
 
 
703
 
472
704
def show_changed_revisions(branch, old_rh, new_rh, to_file=None, log_format='long'):
473
705
    """Show the change in revision history comparing the old revision history to the new one.
474
706
 
508
740
        to_file.write('*'*60)
509
741
        to_file.write('\nRemoved Revisions:\n')
510
742
        for i in range(base_idx, len(old_rh)):
511
 
            rev = branch.get_revision(old_rh[i])
512
 
            lf.show(i+1, rev, None)
 
743
            rev = branch.repository.get_revision(old_rh[i])
 
744
            lr = LogRevision(rev, i+1, 0, None)
 
745
            lf.log_revision(lr)
513
746
        to_file.write('*'*60)
514
747
        to_file.write('\n\n')
515
748
    if base_idx < len(new_rh):