1
# Copyright (C) 2005, 2006, 2007 Canonical Ltd
 
 
3
# This program is free software; you can redistribute it and/or modify
 
 
4
# it under the terms of the GNU General Public License as published by
 
 
5
# the Free Software Foundation; either version 2 of the License, or
 
 
6
# (at your option) any later version.
 
 
8
# This program is distributed in the hope that it will be useful,
 
 
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
 
 
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
 
11
# GNU General Public License for more details.
 
 
13
# You should have received a copy of the GNU General Public License
 
 
14
# along with this program; if not, write to the Free Software
 
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
 
19
"""Code to show logs of changes.
 
 
21
Various flavors of log can be produced:
 
 
23
* for one file, or the whole tree, and (not done yet) for
 
 
24
  files in a given directory
 
 
26
* in "verbose" mode with a description of what changed from one
 
 
29
* with file-ids and revision-ids shown
 
 
31
Logs are actually written out through an abstract LogFormatter
 
 
32
interface, which allows for different preferred formats.  Plugins can
 
 
35
Logs can be produced in either forward (oldest->newest) or reverse
 
 
36
(newest->oldest) order.
 
 
38
Logs can be filtered to show only revisions matching a particular
 
 
39
search string, or within a particular range of revisions.  The range
 
 
40
can be given as date/times, which are reduced to revisions before
 
 
43
In verbose mode we show a summary of what changed in each particular
 
 
44
revision.  Note that this is the delta for changes in that revision
 
 
45
relative to its left-most parent, not the delta relative to the last
 
 
46
logged revision.  So for example if you ask for a verbose log of
 
 
47
changes touching hello.c you will get a list of those revisions also
 
 
48
listing other things that were changed in the same revision, but not
 
 
49
all the changes since the previous revision that touched hello.c.
 
 
53
from itertools import (
 
 
58
from warnings import (
 
 
68
from bzrlib.errors import (
 
 
71
from bzrlib.osutils import (
 
 
73
    get_terminal_encoding,
 
 
76
from bzrlib.revision import (
 
 
79
from bzrlib.revisionspec import (
 
 
82
from bzrlib.symbol_versioning import (
 
 
86
from bzrlib.trace import mutter
 
 
87
from bzrlib.tsort import (
 
 
93
def find_touching_revisions(branch, file_id):
 
 
94
    """Yield a description of revisions which affect the file_id.
 
 
96
    Each returned element is (revno, revision_id, description)
 
 
98
    This is the list of revisions where the file is either added,
 
 
99
    modified, renamed or deleted.
 
 
101
    TODO: Perhaps some way to limit this to only particular revisions,
 
 
102
    or to traverse a non-mainline set of revisions?
 
 
107
    for revision_id in branch.revision_history():
 
 
108
        this_inv = branch.repository.get_revision_inventory(revision_id)
 
 
109
        if file_id in this_inv:
 
 
110
            this_ie = this_inv[file_id]
 
 
111
            this_path = this_inv.id2path(file_id)
 
 
113
            this_ie = this_path = None
 
 
115
        # now we know how it was last time, and how it is in this revision.
 
 
116
        # are those two states effectively the same or not?
 
 
118
        if not this_ie and not last_ie:
 
 
119
            # not present in either
 
 
121
        elif this_ie and not last_ie:
 
 
122
            yield revno, revision_id, "added " + this_path
 
 
123
        elif not this_ie and last_ie:
 
 
125
            yield revno, revision_id, "deleted " + last_path
 
 
126
        elif this_path != last_path:
 
 
127
            yield revno, revision_id, ("renamed %s => %s" % (last_path, this_path))
 
 
128
        elif (this_ie.text_size != last_ie.text_size
 
 
129
              or this_ie.text_sha1 != last_ie.text_sha1):
 
 
130
            yield revno, revision_id, "modified " + this_path
 
 
133
        last_path = this_path
 
 
137
def _enumerate_history(branch):
 
 
140
    for rev_id in branch.revision_history():
 
 
141
        rh.append((revno, rev_id))
 
 
148
             specific_fileid=None,
 
 
155
    """Write out human-readable log of commits to this branch.
 
 
158
        LogFormatter object to show the output.
 
 
161
        If true, list only the commits affecting the specified
 
 
162
        file, rather than all commits.
 
 
165
        If true show added/changed/deleted/renamed files.
 
 
168
        'reverse' (default) is latest to earliest;
 
 
169
        'forward' is earliest to latest.
 
 
172
        If not None, only show revisions >= start_revision
 
 
175
        If not None, only show revisions <= end_revision
 
 
178
        If not None, only show revisions with matching commit messages
 
 
181
        If not None or 0, only show limit revisions
 
 
185
        if getattr(lf, 'begin_log', None):
 
 
188
        _show_log(branch, lf, specific_fileid, verbose, direction,
 
 
189
                  start_revision, end_revision, search, limit)
 
 
191
        if getattr(lf, 'end_log', None):
 
 
196
def _show_log(branch,
 
 
198
             specific_fileid=None,
 
 
205
    """Worker function for show_log - see show_log."""
 
 
206
    if not isinstance(lf, LogFormatter):
 
 
207
        warn("not a LogFormatter instance: %r" % lf)
 
 
210
        mutter('get log for file_id %r', specific_fileid)
 
 
212
    if search is not None:
 
 
213
        searchRE = re.compile(search, re.IGNORECASE)
 
 
217
    mainline_revs, rev_nos, start_rev_id, end_rev_id = \
 
 
218
        _get_mainline_revs(branch, start_revision, end_revision)
 
 
219
    if not mainline_revs:
 
 
222
    if direction == 'reverse':
 
 
223
        start_rev_id, end_rev_id = end_rev_id, start_rev_id
 
 
225
    legacy_lf = getattr(lf, 'log_revision', None) is None
 
 
227
        # pre-0.17 formatters use show for mainline revisions.
 
 
228
        # how should we show merged revisions ?
 
 
229
        #   pre-0.11 api: show_merge
 
 
230
        #   0.11-0.16 api: show_merge_revno
 
 
231
        show_merge_revno = getattr(lf, 'show_merge_revno', None)
 
 
232
        show_merge = getattr(lf, 'show_merge', None)
 
 
233
        if show_merge is None and show_merge_revno is None:
 
 
234
            # no merged-revno support
 
 
235
            generate_merge_revisions = False
 
 
237
            generate_merge_revisions = True
 
 
238
        # tell developers to update their code
 
 
239
        symbol_versioning.warn('LogFormatters should provide log_revision '
 
 
240
            'instead of show and show_merge_revno since bzr 0.17.',
 
 
241
            DeprecationWarning, stacklevel=3)
 
 
243
        generate_merge_revisions = getattr(lf, 'supports_merge_revisions', 
 
 
245
    generate_single_revision = False
 
 
246
    if ((not generate_merge_revisions)
 
 
247
        and ((start_rev_id and (start_rev_id not in rev_nos))
 
 
248
            or (end_rev_id and (end_rev_id not in rev_nos)))):
 
 
249
        generate_single_revision = ((start_rev_id == end_rev_id)
 
 
250
            and getattr(lf, 'supports_single_merge_revision', False))
 
 
251
        if not generate_single_revision:
 
 
252
            raise BzrCommandError('Selected log formatter only supports '
 
 
253
                'mainline revisions.')
 
 
254
        generate_merge_revisions = generate_single_revision
 
 
255
    view_revs_iter = get_view_revisions(mainline_revs, rev_nos, branch,
 
 
256
                          direction, include_merges=generate_merge_revisions)
 
 
257
    view_revisions = _filter_revision_range(list(view_revs_iter),
 
 
260
    if view_revisions and generate_single_revision:
 
 
261
        view_revisions = view_revisions[0:1]
 
 
263
        view_revisions = _filter_revisions_touching_file_id(branch,
 
 
268
    # rebase merge_depth - unless there are no revisions or 
 
 
269
    # either the first or last revision have merge_depth = 0.
 
 
270
    if view_revisions and view_revisions[0][2] and view_revisions[-1][2]:
 
 
271
        min_depth = min([d for r,n,d in view_revisions])
 
 
273
            view_revisions = [(r,n,d-min_depth) for r,n,d in view_revisions]
 
 
276
    generate_tags = getattr(lf, 'supports_tags', False)
 
 
278
        if branch.supports_tags():
 
 
279
            rev_tag_dict = branch.tags.get_reverse_tag_dict()
 
 
281
    generate_delta = verbose and getattr(lf, 'supports_delta', False)
 
 
283
    def iter_revisions():
 
 
284
        # r = revision, n = revno, d = merge depth
 
 
285
        revision_ids = [r for r, n, d in view_revisions]
 
 
287
        repository = branch.repository
 
 
290
            revisions = repository.get_revisions(revision_ids[:num])
 
 
292
                deltas = repository.get_deltas_for_revisions(revisions)
 
 
293
                cur_deltas = dict(izip((r.revision_id for r in revisions),
 
 
295
            for revision in revisions:
 
 
296
                yield revision, cur_deltas.get(revision.revision_id)
 
 
297
            revision_ids  = revision_ids[num:]
 
 
298
            num = min(int(num * 1.5), 200)
 
 
300
    # now we just print all the revisions
 
 
302
    for ((rev_id, revno, merge_depth), (rev, delta)) in \
 
 
303
         izip(view_revisions, iter_revisions()):
 
 
306
            if not searchRE.search(rev.message):
 
 
310
            lr = LogRevision(rev, revno, merge_depth, delta,
 
 
311
                             rev_tag_dict.get(rev_id))
 
 
314
            # support for legacy (pre-0.17) LogFormatters
 
 
317
                    lf.show(revno, rev, delta, rev_tag_dict.get(rev_id))
 
 
319
                    lf.show(revno, rev, delta)
 
 
321
                if show_merge_revno is None:
 
 
322
                    lf.show_merge(rev, merge_depth)
 
 
325
                        lf.show_merge_revno(rev, merge_depth, revno,
 
 
326
                                            rev_tag_dict.get(rev_id))
 
 
328
                        lf.show_merge_revno(rev, merge_depth, revno)
 
 
331
            if log_count >= limit:
 
 
335
def _get_mainline_revs(branch, start_revision, end_revision):
 
 
336
    """Get the mainline revisions from the branch.
 
 
338
    Generates the list of mainline revisions for the branch.
 
 
340
    :param  branch: The branch containing the revisions. 
 
 
342
    :param  start_revision: The first revision to be logged.
 
 
343
            For backwards compatibility this may be a mainline integer revno,
 
 
344
            but for merge revision support a RevisionInfo is expected.
 
 
346
    :param  end_revision: The last revision to be logged.
 
 
347
            For backwards compatibility this may be a mainline integer revno,
 
 
348
            but for merge revision support a RevisionInfo is expected.
 
 
350
    :return: A (mainline_revs, rev_nos, start_rev_id, end_rev_id) tuple.
 
 
352
    which_revs = _enumerate_history(branch)
 
 
354
        return None, None, None, None
 
 
356
    # For mainline generation, map start_revision and end_revision to 
 
 
357
    # mainline revnos. If the revision is not on the mainline choose the 
 
 
358
    # appropriate extreme of the mainline instead - the extra will be 
 
 
360
    # Also map the revisions to rev_ids, to be used in the later filtering
 
 
363
    if start_revision is None:
 
 
366
        if isinstance(start_revision,RevisionInfo):
 
 
367
            start_rev_id = start_revision.rev_id
 
 
368
            start_revno = start_revision.revno or 1
 
 
370
            branch.check_real_revno(start_revision)
 
 
371
            start_revno = start_revision
 
 
374
    if end_revision is None:
 
 
375
        end_revno = len(which_revs)
 
 
377
        if isinstance(end_revision,RevisionInfo):
 
 
378
            end_rev_id = end_revision.rev_id
 
 
379
            end_revno = end_revision.revno or len(which_revs)
 
 
381
            branch.check_real_revno(end_revision)
 
 
382
            end_revno = end_revision
 
 
384
    if ((start_rev_id == NULL_REVISION)
 
 
385
        or (end_rev_id == NULL_REVISION)):
 
 
386
        raise BzrCommandError('Logging revision 0 is invalid.')
 
 
387
    if start_revno > end_revno:
 
 
388
        raise BzrCommandError("Start revision must be older than "
 
 
391
    # list indexes are 0-based; revisions are 1-based
 
 
392
    cut_revs = which_revs[(start_revno-1):(end_revno)]
 
 
394
        return None, None, None, None
 
 
396
    # convert the revision history to a dictionary:
 
 
397
    rev_nos = dict((k, v) for v, k in cut_revs)
 
 
399
    # override the mainline to look like the revision history.
 
 
400
    mainline_revs = [revision_id for index, revision_id in cut_revs]
 
 
401
    if cut_revs[0][0] == 1:
 
 
402
        mainline_revs.insert(0, None)
 
 
404
        mainline_revs.insert(0, which_revs[start_revno-2][1])
 
 
405
    return mainline_revs, rev_nos, start_rev_id, end_rev_id
 
 
408
def _filter_revision_range(view_revisions, start_rev_id, end_rev_id):
 
 
409
    """Filter view_revisions based on revision ranges.
 
 
411
    :param view_revisions: A list of (revision_id, dotted_revno, merge_depth) 
 
 
412
            tuples to be filtered.
 
 
414
    :param start_rev_id: If not NONE specifies the first revision to be logged.
 
 
415
            If NONE then all revisions up to the end_rev_id are logged.
 
 
417
    :param end_rev_id: If not NONE specifies the last revision to be logged.
 
 
418
            If NONE then all revisions up to the end of the log are logged.
 
 
420
    :return: The filtered view_revisions.
 
 
422
    if start_rev_id or end_rev_id: 
 
 
423
        revision_ids = [r for r, n, d in view_revisions]
 
 
425
            start_index = revision_ids.index(start_rev_id)
 
 
428
        if start_rev_id == end_rev_id:
 
 
429
            end_index = start_index
 
 
432
                end_index = revision_ids.index(end_rev_id)
 
 
434
                end_index = len(view_revisions) - 1
 
 
435
        # To include the revisions merged into the last revision, 
 
 
436
        # extend end_rev_id down to, but not including, the next rev
 
 
437
        # with the same or lesser merge_depth
 
 
438
        end_merge_depth = view_revisions[end_index][2]
 
 
440
            for index in xrange(end_index+1, len(view_revisions)+1):
 
 
441
                if view_revisions[index][2] <= end_merge_depth:
 
 
442
                    end_index = index - 1
 
 
445
            # if the search falls off the end then log to the end as well
 
 
446
            end_index = len(view_revisions) - 1
 
 
447
        view_revisions = view_revisions[start_index:end_index+1]
 
 
448
    return view_revisions
 
 
451
def _filter_revisions_touching_file_id(branch, file_id, mainline_revisions,
 
 
453
    """Return the list of revision ids which touch a given file id.
 
 
455
    The function filters view_revisions and returns a subset.
 
 
456
    This includes the revisions which directly change the file id,
 
 
457
    and the revisions which merge these changes. So if the
 
 
465
    And 'C' changes a file, then both C and D will be returned.
 
 
467
    This will also can be restricted based on a subset of the mainline.
 
 
469
    :return: A list of (revision_id, dotted_revno, merge_depth) tuples.
 
 
471
    # find all the revisions that change the specific file
 
 
472
    file_weave = branch.repository.weave_store.get_weave(file_id,
 
 
473
                branch.repository.get_transaction())
 
 
474
    weave_modifed_revisions = set(file_weave.versions())
 
 
475
    # build the ancestry of each revision in the graph
 
 
476
    # - only listing the ancestors that change the specific file.
 
 
477
    rev_graph = branch.repository.get_revision_graph(mainline_revisions[-1])
 
 
478
    sorted_rev_list = topo_sort(rev_graph)
 
 
480
    for rev in sorted_rev_list:
 
 
481
        parents = rev_graph[rev]
 
 
482
        if rev not in weave_modifed_revisions and len(parents) == 1:
 
 
483
            # We will not be adding anything new, so just use a reference to
 
 
484
            # the parent ancestry.
 
 
485
            rev_ancestry = ancestry[parents[0]]
 
 
488
            if rev in weave_modifed_revisions:
 
 
489
                rev_ancestry.add(rev)
 
 
490
            for parent in parents:
 
 
491
                rev_ancestry = rev_ancestry.union(ancestry[parent])
 
 
492
        ancestry[rev] = rev_ancestry
 
 
494
    def is_merging_rev(r):
 
 
495
        parents = rev_graph[r]
 
 
497
            leftparent = parents[0]
 
 
498
            for rightparent in parents[1:]:
 
 
499
                if not ancestry[leftparent].issuperset(
 
 
500
                        ancestry[rightparent]):
 
 
504
    # filter from the view the revisions that did not change or merge 
 
 
506
    return [(r, n, d) for r, n, d in view_revs_iter
 
 
507
            if r in weave_modifed_revisions or is_merging_rev(r)]
 
 
510
def get_view_revisions(mainline_revs, rev_nos, branch, direction,
 
 
511
                       include_merges=True):
 
 
512
    """Produce an iterator of revisions to show
 
 
513
    :return: an iterator of (revision_id, revno, merge_depth)
 
 
514
    (if there is no revno for a revision, None is supplied)
 
 
516
    if include_merges is False:
 
 
517
        revision_ids = mainline_revs[1:]
 
 
518
        if direction == 'reverse':
 
 
519
            revision_ids.reverse()
 
 
520
        for revision_id in revision_ids:
 
 
521
            yield revision_id, str(rev_nos[revision_id]), 0
 
 
523
    merge_sorted_revisions = merge_sort(
 
 
524
        branch.repository.get_revision_graph(mainline_revs[-1]),
 
 
529
    if direction == 'forward':
 
 
530
        # forward means oldest first.
 
 
531
        merge_sorted_revisions = reverse_by_depth(merge_sorted_revisions)
 
 
532
    elif direction != 'reverse':
 
 
533
        raise ValueError('invalid direction %r' % direction)
 
 
535
    for sequence, rev_id, merge_depth, revno, end_of_merge in merge_sorted_revisions:
 
 
536
        yield rev_id, '.'.join(map(str, revno)), merge_depth
 
 
539
def reverse_by_depth(merge_sorted_revisions, _depth=0):
 
 
540
    """Reverse revisions by depth.
 
 
542
    Revisions with a different depth are sorted as a group with the previous
 
 
543
    revision of that depth.  There may be no topological justification for this,
 
 
544
    but it looks much nicer.
 
 
547
    for val in merge_sorted_revisions:
 
 
549
            zd_revisions.append([val])
 
 
551
            assert val[2] > _depth
 
 
552
            zd_revisions[-1].append(val)
 
 
553
    for revisions in zd_revisions:
 
 
554
        if len(revisions) > 1:
 
 
555
            revisions[1:] = reverse_by_depth(revisions[1:], _depth + 1)
 
 
556
    zd_revisions.reverse()
 
 
558
    for chunk in zd_revisions:
 
 
563
class LogRevision(object):
 
 
564
    """A revision to be logged (by LogFormatter.log_revision).
 
 
566
    A simple wrapper for the attributes of a revision to be logged.
 
 
567
    The attributes may or may not be populated, as determined by the 
 
 
568
    logging options and the log formatter capabilities.
 
 
571
    def __init__(self, rev=None, revno=None, merge_depth=0, delta=None,
 
 
575
        self.merge_depth = merge_depth
 
 
580
class LogFormatter(object):
 
 
581
    """Abstract class to display log messages.
 
 
583
    At a minimum, a derived class must implement the log_revision method.
 
 
585
    If the LogFormatter needs to be informed of the beginning or end of
 
 
586
    a log it should implement the begin_log and/or end_log hook methods.
 
 
588
    A LogFormatter should define the following supports_XXX flags 
 
 
589
    to indicate which LogRevision attributes it supports:
 
 
591
    - supports_delta must be True if this log formatter supports delta.
 
 
592
        Otherwise the delta attribute may not be populated.
 
 
593
    - supports_merge_revisions must be True if this log formatter supports 
 
 
594
        merge revisions.  If not, and if supports_single_merge_revisions is
 
 
595
        also not True, then only mainline revisions will be passed to the 
 
 
597
    - supports_single_merge_revision must be True if this log formatter
 
 
598
        supports logging only a single merge revision.  This flag is
 
 
599
        only relevant if supports_merge_revisions is not True.
 
 
600
    - supports_tags must be True if this log formatter supports tags.
 
 
601
        Otherwise the tags attribute may not be populated.
 
 
604
    def __init__(self, to_file, show_ids=False, show_timezone='original'):
 
 
605
        self.to_file = to_file
 
 
606
        self.show_ids = show_ids
 
 
607
        self.show_timezone = show_timezone
 
 
609
# TODO: uncomment this block after show() has been removed.
 
 
610
# Until then defining log_revision would prevent _show_log calling show() 
 
 
611
# in legacy formatters.
 
 
612
#    def log_revision(self, revision):
 
 
615
#        :param  revision:   The LogRevision to be logged.
 
 
617
#        raise NotImplementedError('not implemented in abstract base')
 
 
619
    @deprecated_method(zero_seventeen)
 
 
620
    def show(self, revno, rev, delta):
 
 
621
        raise NotImplementedError('not implemented in abstract base')
 
 
623
    def short_committer(self, rev):
 
 
624
        name, address = config.parse_username(rev.committer)
 
 
629
    def short_author(self, rev):
 
 
630
        name, address = config.parse_username(rev.get_apparent_author())
 
 
636
class LongLogFormatter(LogFormatter):
 
 
638
    supports_merge_revisions = True
 
 
639
    supports_delta = True
 
 
642
    @deprecated_method(zero_seventeen)
 
 
643
    def show(self, revno, rev, delta, tags=None):
 
 
644
        lr = LogRevision(rev, revno, 0, delta, tags)
 
 
645
        return self.log_revision(lr)
 
 
647
    @deprecated_method(zero_seventeen)
 
 
648
    def show_merge_revno(self, rev, merge_depth, revno, tags=None):
 
 
649
        """Show a merged revision rev, with merge_depth and a revno."""
 
 
650
        lr = LogRevision(rev, revno, merge_depth, tags=tags)
 
 
651
        return self.log_revision(lr)
 
 
653
    def log_revision(self, revision):
 
 
654
        """Log a revision, either merged or not."""
 
 
655
        indent = '    ' * revision.merge_depth
 
 
656
        to_file = self.to_file
 
 
657
        to_file.write(indent + '-' * 60 + '\n')
 
 
658
        if revision.revno is not None:
 
 
659
            to_file.write(indent + 'revno: %s\n' % (revision.revno,))
 
 
661
            to_file.write(indent + 'tags: %s\n' % (', '.join(revision.tags)))
 
 
663
            to_file.write(indent + 'revision-id:' + revision.rev.revision_id)
 
 
665
            for parent_id in revision.rev.parent_ids:
 
 
666
                to_file.write(indent + 'parent: %s\n' % (parent_id,))
 
 
668
        author = revision.rev.properties.get('author', None)
 
 
669
        if author is not None:
 
 
670
            to_file.write(indent + 'author: %s\n' % (author,))
 
 
671
        to_file.write(indent + 'committer: %s\n' % (revision.rev.committer,))
 
 
673
        branch_nick = revision.rev.properties.get('branch-nick', None)
 
 
674
        if branch_nick is not None:
 
 
675
            to_file.write(indent + 'branch nick: %s\n' % (branch_nick,))
 
 
677
        date_str = format_date(revision.rev.timestamp,
 
 
678
                               revision.rev.timezone or 0,
 
 
680
        to_file.write(indent + 'timestamp: %s\n' % (date_str,))
 
 
682
        to_file.write(indent + 'message:\n')
 
 
683
        if not revision.rev.message:
 
 
684
            to_file.write(indent + '  (no message)\n')
 
 
686
            message = revision.rev.message.rstrip('\r\n')
 
 
687
            for l in message.split('\n'):
 
 
688
                to_file.write(indent + '  %s\n' % (l,))
 
 
689
        if revision.delta is not None:
 
 
690
            revision.delta.show(to_file, self.show_ids, indent=indent)
 
 
693
class ShortLogFormatter(LogFormatter):
 
 
695
    supports_delta = True
 
 
696
    supports_single_merge_revision = True
 
 
698
    @deprecated_method(zero_seventeen)
 
 
699
    def show(self, revno, rev, delta):
 
 
700
        lr = LogRevision(rev, revno, 0, delta)
 
 
701
        return self.log_revision(lr)
 
 
703
    def log_revision(self, revision):
 
 
704
        to_file = self.to_file
 
 
705
        date_str = format_date(revision.rev.timestamp,
 
 
706
                               revision.rev.timezone or 0,
 
 
709
        if len(revision.rev.parent_ids) > 1:
 
 
710
            is_merge = ' [merge]'
 
 
711
        to_file.write("%5s %s\t%s%s\n" % (revision.revno,
 
 
712
                self.short_author(revision.rev),
 
 
713
                format_date(revision.rev.timestamp,
 
 
714
                            revision.rev.timezone or 0,
 
 
715
                            self.show_timezone, date_fmt="%Y-%m-%d",
 
 
719
            to_file.write('      revision-id:%s\n' % (revision.rev.revision_id,))
 
 
720
        if not revision.rev.message:
 
 
721
            to_file.write('      (no message)\n')
 
 
723
            message = revision.rev.message.rstrip('\r\n')
 
 
724
            for l in message.split('\n'):
 
 
725
                to_file.write('      %s\n' % (l,))
 
 
727
        # TODO: Why not show the modified files in a shorter form as
 
 
728
        # well? rewrap them single lines of appropriate length
 
 
729
        if revision.delta is not None:
 
 
730
            revision.delta.show(to_file, self.show_ids)
 
 
734
class LineLogFormatter(LogFormatter):
 
 
736
    supports_single_merge_revision = True
 
 
738
    def __init__(self, *args, **kwargs):
 
 
739
        super(LineLogFormatter, self).__init__(*args, **kwargs)
 
 
740
        self._max_chars = terminal_width() - 1
 
 
742
    def truncate(self, str, max_len):
 
 
743
        if len(str) <= max_len:
 
 
745
        return str[:max_len-3]+'...'
 
 
747
    def date_string(self, rev):
 
 
748
        return format_date(rev.timestamp, rev.timezone or 0, 
 
 
749
                           self.show_timezone, date_fmt="%Y-%m-%d",
 
 
752
    def message(self, rev):
 
 
754
            return '(no message)'
 
 
758
    @deprecated_method(zero_seventeen)
 
 
759
    def show(self, revno, rev, delta):
 
 
760
        self.to_file.write(self.log_string(revno, rev, terminal_width()-1))
 
 
761
        self.to_file.write('\n')
 
 
763
    def log_revision(self, revision):
 
 
764
        self.to_file.write(self.log_string(revision.revno, revision.rev,
 
 
766
        self.to_file.write('\n')
 
 
768
    def log_string(self, revno, rev, max_chars):
 
 
769
        """Format log info into one string. Truncate tail of string
 
 
770
        :param  revno:      revision number (int) or None.
 
 
771
                            Revision numbers counts from 1.
 
 
772
        :param  rev:        revision info object
 
 
773
        :param  max_chars:  maximum length of resulting string
 
 
774
        :return:            formatted truncated string
 
 
778
            # show revno only when is not None
 
 
779
            out.append("%s:" % revno)
 
 
780
        out.append(self.truncate(self.short_author(rev), 20))
 
 
781
        out.append(self.date_string(rev))
 
 
782
        out.append(rev.get_summary())
 
 
783
        return self.truncate(" ".join(out).rstrip('\n'), max_chars)
 
 
786
def line_log(rev, max_chars):
 
 
787
    lf = LineLogFormatter(None)
 
 
788
    return lf.log_string(None, rev, max_chars)
 
 
791
class LogFormatterRegistry(registry.Registry):
 
 
792
    """Registry for log formatters"""
 
 
794
    def make_formatter(self, name, *args, **kwargs):
 
 
795
        """Construct a formatter from arguments.
 
 
797
        :param name: Name of the formatter to construct.  'short', 'long' and
 
 
800
        return self.get(name)(*args, **kwargs)
 
 
802
    def get_default(self, branch):
 
 
803
        return self.get(branch.get_config().log_format())
 
 
806
log_formatter_registry = LogFormatterRegistry()
 
 
809
log_formatter_registry.register('short', ShortLogFormatter,
 
 
810
                                'Moderately short log format')
 
 
811
log_formatter_registry.register('long', LongLogFormatter,
 
 
812
                                'Detailed log format')
 
 
813
log_formatter_registry.register('line', LineLogFormatter,
 
 
814
                                'Log format with one line per revision')
 
 
817
def register_formatter(name, formatter):
 
 
818
    log_formatter_registry.register(name, formatter)
 
 
821
def log_formatter(name, *args, **kwargs):
 
 
822
    """Construct a formatter from arguments.
 
 
824
    name -- Name of the formatter to construct; currently 'long', 'short' and
 
 
825
        'line' are supported.
 
 
828
        return log_formatter_registry.make_formatter(name, *args, **kwargs)
 
 
830
        raise BzrCommandError("unknown log formatter: %r" % name)
 
 
833
def show_one_log(revno, rev, delta, verbose, to_file, show_timezone):
 
 
834
    # deprecated; for compatibility
 
 
835
    lf = LongLogFormatter(to_file=to_file, show_timezone=show_timezone)
 
 
836
    lf.show(revno, rev, delta)
 
 
839
def show_changed_revisions(branch, old_rh, new_rh, to_file=None,
 
 
841
    """Show the change in revision history comparing the old revision history to the new one.
 
 
843
    :param branch: The branch where the revisions exist
 
 
844
    :param old_rh: The old revision history
 
 
845
    :param new_rh: The new revision history
 
 
846
    :param to_file: A file to write the results to. If None, stdout will be used
 
 
849
        to_file = codecs.getwriter(get_terminal_encoding())(sys.stdout,
 
 
851
    lf = log_formatter(log_format,
 
 
854
                       show_timezone='original')
 
 
856
    # This is the first index which is different between
 
 
859
    for i in xrange(max(len(new_rh),
 
 
863
            or new_rh[i] != old_rh[i]):
 
 
868
        to_file.write('Nothing seems to have changed\n')
 
 
870
    ## TODO: It might be nice to do something like show_log
 
 
871
    ##       and show the merged entries. But since this is the
 
 
872
    ##       removed revisions, it shouldn't be as important
 
 
873
    if base_idx < len(old_rh):
 
 
874
        to_file.write('*'*60)
 
 
875
        to_file.write('\nRemoved Revisions:\n')
 
 
876
        for i in range(base_idx, len(old_rh)):
 
 
877
            rev = branch.repository.get_revision(old_rh[i])
 
 
878
            lr = LogRevision(rev, i+1, 0, None)
 
 
880
        to_file.write('*'*60)
 
 
881
        to_file.write('\n\n')
 
 
882
    if base_idx < len(new_rh):
 
 
883
        to_file.write('Added Revisions:\n')
 
 
889
                 start_revision=base_idx+1,
 
 
890
                 end_revision=len(new_rh),