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 (
 
 
62
from bzrlib.lazy_import import lazy_import
 
 
63
lazy_import(globals(), """
 
 
68
    repository as _mod_repository,
 
 
69
    revision as _mod_revision,
 
 
79
from bzrlib.osutils import (
 
 
81
    get_terminal_encoding,
 
 
86
def find_touching_revisions(branch, file_id):
 
 
87
    """Yield a description of revisions which affect the file_id.
 
 
89
    Each returned element is (revno, revision_id, description)
 
 
91
    This is the list of revisions where the file is either added,
 
 
92
    modified, renamed or deleted.
 
 
94
    TODO: Perhaps some way to limit this to only particular revisions,
 
 
95
    or to traverse a non-mainline set of revisions?
 
 
100
    for revision_id in branch.revision_history():
 
 
101
        this_inv = branch.repository.get_revision_inventory(revision_id)
 
 
102
        if file_id in this_inv:
 
 
103
            this_ie = this_inv[file_id]
 
 
104
            this_path = this_inv.id2path(file_id)
 
 
106
            this_ie = this_path = None
 
 
108
        # now we know how it was last time, and how it is in this revision.
 
 
109
        # are those two states effectively the same or not?
 
 
111
        if not this_ie and not last_ie:
 
 
112
            # not present in either
 
 
114
        elif this_ie and not last_ie:
 
 
115
            yield revno, revision_id, "added " + this_path
 
 
116
        elif not this_ie and last_ie:
 
 
118
            yield revno, revision_id, "deleted " + last_path
 
 
119
        elif this_path != last_path:
 
 
120
            yield revno, revision_id, ("renamed %s => %s" % (last_path, this_path))
 
 
121
        elif (this_ie.text_size != last_ie.text_size
 
 
122
              or this_ie.text_sha1 != last_ie.text_sha1):
 
 
123
            yield revno, revision_id, "modified " + this_path
 
 
126
        last_path = this_path
 
 
130
def _enumerate_history(branch):
 
 
133
    for rev_id in branch.revision_history():
 
 
134
        rh.append((revno, rev_id))
 
 
141
             specific_fileid=None,
 
 
148
    """Write out human-readable log of commits to this branch.
 
 
151
        LogFormatter object to show the output.
 
 
154
        If true, list only the commits affecting the specified
 
 
155
        file, rather than all commits.
 
 
158
        If true show added/changed/deleted/renamed files.
 
 
161
        'reverse' (default) is latest to earliest;
 
 
162
        'forward' is earliest to latest.
 
 
165
        If not None, only show revisions >= start_revision
 
 
168
        If not None, only show revisions <= end_revision
 
 
171
        If not None, only show revisions with matching commit messages
 
 
174
        If not None or 0, only show limit revisions
 
 
178
        if getattr(lf, 'begin_log', None):
 
 
181
        _show_log(branch, lf, specific_fileid, verbose, direction,
 
 
182
                  start_revision, end_revision, search, limit)
 
 
184
        if getattr(lf, 'end_log', None):
 
 
190
def _show_log(branch,
 
 
192
             specific_fileid=None,
 
 
199
    """Worker function for show_log - see show_log."""
 
 
200
    if not isinstance(lf, LogFormatter):
 
 
201
        warn("not a LogFormatter instance: %r" % lf)
 
 
204
        trace.mutter('get log for file_id %r', specific_fileid)
 
 
205
    generate_merge_revisions = getattr(lf, 'supports_merge_revisions', False)
 
 
206
    allow_single_merge_revision = getattr(lf,
 
 
207
        'supports_single_merge_revision', False)
 
 
208
    view_revisions = calculate_view_revisions(branch, start_revision,
 
 
209
                                              end_revision, direction,
 
 
211
                                              generate_merge_revisions,
 
 
212
                                              allow_single_merge_revision)
 
 
213
    if search is not None:
 
 
214
        searchRE = re.compile(search, re.IGNORECASE)
 
 
219
    generate_tags = getattr(lf, 'supports_tags', False)
 
 
221
        if branch.supports_tags():
 
 
222
            rev_tag_dict = branch.tags.get_reverse_tag_dict()
 
 
224
    generate_delta = verbose and getattr(lf, 'supports_delta', False)
 
 
226
    # now we just print all the revisions
 
 
228
    for (rev_id, revno, merge_depth), rev, delta in _iter_revisions(
 
 
229
        branch.repository, view_revisions, generate_delta):
 
 
231
            if not searchRE.search(rev.message):
 
 
234
        lr = LogRevision(rev, revno, merge_depth, delta,
 
 
235
                         rev_tag_dict.get(rev_id))
 
 
239
            if log_count >= limit:
 
 
243
def calculate_view_revisions(branch, start_revision, end_revision, direction,
 
 
244
                             specific_fileid, generate_merge_revisions,
 
 
245
                             allow_single_merge_revision):
 
 
246
    if (not generate_merge_revisions and start_revision is end_revision is
 
 
247
        None and direction == 'reverse' and specific_fileid is None):
 
 
248
        return _linear_view_revisions(branch)
 
 
250
    mainline_revs, rev_nos, start_rev_id, end_rev_id = \
 
 
251
        _get_mainline_revs(branch, start_revision, end_revision)
 
 
252
    if not mainline_revs:
 
 
255
    if direction == 'reverse':
 
 
256
        start_rev_id, end_rev_id = end_rev_id, start_rev_id
 
 
258
    generate_single_revision = False
 
 
259
    if ((not generate_merge_revisions)
 
 
260
        and ((start_rev_id and (start_rev_id not in rev_nos))
 
 
261
            or (end_rev_id and (end_rev_id not in rev_nos)))):
 
 
262
        generate_single_revision = ((start_rev_id == end_rev_id)
 
 
263
            and allow_single_merge_revision)
 
 
264
        if not generate_single_revision:
 
 
265
            raise errors.BzrCommandError('Selected log formatter only supports'
 
 
266
                ' mainline revisions.')
 
 
267
        generate_merge_revisions = generate_single_revision
 
 
268
    view_revs_iter = get_view_revisions(mainline_revs, rev_nos, branch,
 
 
269
                          direction, include_merges=generate_merge_revisions)
 
 
270
    view_revisions = _filter_revision_range(list(view_revs_iter),
 
 
273
    if view_revisions and generate_single_revision:
 
 
274
        view_revisions = view_revisions[0:1]
 
 
276
        view_revisions = _filter_revisions_touching_file_id(branch,
 
 
281
    # rebase merge_depth - unless there are no revisions or 
 
 
282
    # either the first or last revision have merge_depth = 0.
 
 
283
    if view_revisions and view_revisions[0][2] and view_revisions[-1][2]:
 
 
284
        min_depth = min([d for r,n,d in view_revisions])
 
 
286
            view_revisions = [(r,n,d-min_depth) for r,n,d in view_revisions]
 
 
287
    return view_revisions
 
 
290
def _linear_view_revisions(branch):
 
 
291
    start_revno, start_revision_id = branch.last_revision_info()
 
 
292
    repo = branch.repository
 
 
293
    revision_ids = repo.iter_reverse_revision_history(start_revision_id)
 
 
294
    for num, revision_id in enumerate(revision_ids):
 
 
295
        yield revision_id, str(start_revno - num), 0
 
 
298
def _iter_revisions(repository, view_revisions, generate_delta):
 
 
300
    view_revisions = iter(view_revisions)
 
 
302
        cur_view_revisions = [d for x, d in zip(range(num), view_revisions)]
 
 
303
        if len(cur_view_revisions) == 0:
 
 
306
        # r = revision, n = revno, d = merge depth
 
 
307
        revision_ids = [r for (r, n, d) in cur_view_revisions]
 
 
308
        revisions = repository.get_revisions(revision_ids)
 
 
310
            deltas = repository.get_deltas_for_revisions(revisions)
 
 
311
            cur_deltas = dict(izip((r.revision_id for r in revisions),
 
 
313
        for view_data, revision in izip(cur_view_revisions, revisions):
 
 
314
            yield view_data, revision, cur_deltas.get(revision.revision_id)
 
 
315
        num = min(int(num * 1.5), 200)
 
 
318
def _get_mainline_revs(branch, start_revision, end_revision):
 
 
319
    """Get the mainline revisions from the branch.
 
 
321
    Generates the list of mainline revisions for the branch.
 
 
323
    :param  branch: The branch containing the revisions. 
 
 
325
    :param  start_revision: The first revision to be logged.
 
 
326
            For backwards compatibility this may be a mainline integer revno,
 
 
327
            but for merge revision support a RevisionInfo is expected.
 
 
329
    :param  end_revision: The last revision to be logged.
 
 
330
            For backwards compatibility this may be a mainline integer revno,
 
 
331
            but for merge revision support a RevisionInfo is expected.
 
 
333
    :return: A (mainline_revs, rev_nos, start_rev_id, end_rev_id) tuple.
 
 
335
    branch_revno, branch_last_revision = branch.last_revision_info()
 
 
336
    if branch_revno == 0:
 
 
337
        return None, None, None, None
 
 
339
    # For mainline generation, map start_revision and end_revision to 
 
 
340
    # mainline revnos. If the revision is not on the mainline choose the 
 
 
341
    # appropriate extreme of the mainline instead - the extra will be 
 
 
343
    # Also map the revisions to rev_ids, to be used in the later filtering
 
 
346
    if start_revision is None:
 
 
349
        if isinstance(start_revision, revisionspec.RevisionInfo):
 
 
350
            start_rev_id = start_revision.rev_id
 
 
351
            start_revno = start_revision.revno or 1
 
 
353
            branch.check_real_revno(start_revision)
 
 
354
            start_revno = start_revision
 
 
357
    if end_revision is None:
 
 
358
        end_revno = branch_revno
 
 
360
        if isinstance(end_revision, revisionspec.RevisionInfo):
 
 
361
            end_rev_id = end_revision.rev_id
 
 
362
            end_revno = end_revision.revno or branch_revno
 
 
364
            branch.check_real_revno(end_revision)
 
 
365
            end_revno = end_revision
 
 
367
    if ((start_rev_id == _mod_revision.NULL_REVISION)
 
 
368
        or (end_rev_id == _mod_revision.NULL_REVISION)):
 
 
369
        raise errors.BzrCommandError('Logging revision 0 is invalid.')
 
 
370
    if start_revno > end_revno:
 
 
371
        raise errors.BzrCommandError("Start revision must be older than "
 
 
374
    if end_revno < start_revno:
 
 
375
        return None, None, None, None
 
 
376
    cur_revno = branch_revno
 
 
379
    for revision_id in branch.repository.iter_reverse_revision_history(
 
 
380
                        branch_last_revision):
 
 
381
        if cur_revno < start_revno:
 
 
382
            # We have gone far enough, but we always add 1 more revision
 
 
383
            rev_nos[revision_id] = cur_revno
 
 
384
            mainline_revs.append(revision_id)
 
 
386
        if cur_revno <= end_revno:
 
 
387
            rev_nos[revision_id] = cur_revno
 
 
388
            mainline_revs.append(revision_id)
 
 
391
        # We walked off the edge of all revisions, so we add a 'None' marker
 
 
392
        mainline_revs.append(None)
 
 
394
    mainline_revs.reverse()
 
 
396
    # override the mainline to look like the revision history.
 
 
397
    return mainline_revs, rev_nos, start_rev_id, end_rev_id
 
 
400
def _filter_revision_range(view_revisions, start_rev_id, end_rev_id):
 
 
401
    """Filter view_revisions based on revision ranges.
 
 
403
    :param view_revisions: A list of (revision_id, dotted_revno, merge_depth) 
 
 
404
            tuples to be filtered.
 
 
406
    :param start_rev_id: If not NONE specifies the first revision to be logged.
 
 
407
            If NONE then all revisions up to the end_rev_id are logged.
 
 
409
    :param end_rev_id: If not NONE specifies the last revision to be logged.
 
 
410
            If NONE then all revisions up to the end of the log are logged.
 
 
412
    :return: The filtered view_revisions.
 
 
414
    if start_rev_id or end_rev_id: 
 
 
415
        revision_ids = [r for r, n, d in view_revisions]
 
 
417
            start_index = revision_ids.index(start_rev_id)
 
 
420
        if start_rev_id == end_rev_id:
 
 
421
            end_index = start_index
 
 
424
                end_index = revision_ids.index(end_rev_id)
 
 
426
                end_index = len(view_revisions) - 1
 
 
427
        # To include the revisions merged into the last revision, 
 
 
428
        # extend end_rev_id down to, but not including, the next rev
 
 
429
        # with the same or lesser merge_depth
 
 
430
        end_merge_depth = view_revisions[end_index][2]
 
 
432
            for index in xrange(end_index+1, len(view_revisions)+1):
 
 
433
                if view_revisions[index][2] <= end_merge_depth:
 
 
434
                    end_index = index - 1
 
 
437
            # if the search falls off the end then log to the end as well
 
 
438
            end_index = len(view_revisions) - 1
 
 
439
        view_revisions = view_revisions[start_index:end_index+1]
 
 
440
    return view_revisions
 
 
443
def _filter_revisions_touching_file_id(branch, file_id, mainline_revisions,
 
 
445
    """Return the list of revision ids which touch a given file id.
 
 
447
    The function filters view_revisions and returns a subset.
 
 
448
    This includes the revisions which directly change the file id,
 
 
449
    and the revisions which merge these changes. So if the
 
 
457
    And 'C' changes a file, then both C and D will be returned.
 
 
459
    This will also can be restricted based on a subset of the mainline.
 
 
461
    :return: A list of (revision_id, dotted_revno, merge_depth) tuples.
 
 
463
    # find all the revisions that change the specific file
 
 
464
    # build the ancestry of each revision in the graph
 
 
465
    # - only listing the ancestors that change the specific file.
 
 
466
    graph = branch.repository.get_graph()
 
 
467
    # This asks for all mainline revisions, which means we only have to spider
 
 
468
    # sideways, rather than depth history. That said, its still size-of-history
 
 
469
    # and should be addressed.
 
 
470
    # mainline_revisions always includes an extra revision at the beginning, so
 
 
472
    parent_map = dict(((key, value) for key, value in
 
 
473
        graph.iter_ancestry(mainline_revisions[1:]) if value is not None))
 
 
474
    sorted_rev_list = tsort.topo_sort(parent_map.items())
 
 
475
    text_keys = [(file_id, rev_id) for rev_id in sorted_rev_list]
 
 
476
    modified_text_versions = branch.repository.texts.get_parent_map(text_keys)
 
 
478
    for rev in sorted_rev_list:
 
 
479
        text_key = (file_id, rev)
 
 
480
        parents = parent_map[rev]
 
 
481
        if text_key not in modified_text_versions and len(parents) == 1:
 
 
482
            # We will not be adding anything new, so just use a reference to
 
 
483
            # the parent ancestry.
 
 
484
            rev_ancestry = ancestry[parents[0]]
 
 
487
            if text_key in modified_text_versions:
 
 
488
                rev_ancestry.add(rev)
 
 
489
            for parent in parents:
 
 
490
                if parent not in ancestry:
 
 
491
                    # parent is a Ghost, which won't be present in
 
 
492
                    # sorted_rev_list, but we may access it later, so create an
 
 
494
                    ancestry[parent] = set()
 
 
495
                rev_ancestry = rev_ancestry.union(ancestry[parent])
 
 
496
        ancestry[rev] = rev_ancestry
 
 
498
    def is_merging_rev(r):
 
 
499
        parents = parent_map[r]
 
 
501
            leftparent = parents[0]
 
 
502
            for rightparent in parents[1:]:
 
 
503
                if not ancestry[leftparent].issuperset(
 
 
504
                        ancestry[rightparent]):
 
 
508
    # filter from the view the revisions that did not change or merge 
 
 
510
    return [(r, n, d) for r, n, d in view_revs_iter
 
 
511
            if (file_id, r) in modified_text_versions or is_merging_rev(r)]
 
 
514
def get_view_revisions(mainline_revs, rev_nos, branch, direction,
 
 
515
                       include_merges=True):
 
 
516
    """Produce an iterator of revisions to show
 
 
517
    :return: an iterator of (revision_id, revno, merge_depth)
 
 
518
    (if there is no revno for a revision, None is supplied)
 
 
520
    if include_merges is False:
 
 
521
        revision_ids = mainline_revs[1:]
 
 
522
        if direction == 'reverse':
 
 
523
            revision_ids.reverse()
 
 
524
        for revision_id in revision_ids:
 
 
525
            yield revision_id, str(rev_nos[revision_id]), 0
 
 
527
    graph = branch.repository.get_graph()
 
 
528
    # This asks for all mainline revisions, which means we only have to spider
 
 
529
    # sideways, rather than depth history. That said, its still size-of-history
 
 
530
    # and should be addressed.
 
 
531
    # mainline_revisions always includes an extra revision at the beginning, so
 
 
533
    parent_map = dict(((key, value) for key, value in
 
 
534
        graph.iter_ancestry(mainline_revs[1:]) if value is not None))
 
 
535
    # filter out ghosts; merge_sort errors on ghosts.
 
 
536
    rev_graph = _mod_repository._strip_NULL_ghosts(parent_map)
 
 
537
    merge_sorted_revisions = tsort.merge_sort(
 
 
543
    if direction == 'forward':
 
 
544
        # forward means oldest first.
 
 
545
        merge_sorted_revisions = reverse_by_depth(merge_sorted_revisions)
 
 
546
    elif direction != 'reverse':
 
 
547
        raise ValueError('invalid direction %r' % direction)
 
 
549
    for sequence, rev_id, merge_depth, revno, end_of_merge in merge_sorted_revisions:
 
 
550
        yield rev_id, '.'.join(map(str, revno)), merge_depth
 
 
553
def reverse_by_depth(merge_sorted_revisions, _depth=0):
 
 
554
    """Reverse revisions by depth.
 
 
556
    Revisions with a different depth are sorted as a group with the previous
 
 
557
    revision of that depth.  There may be no topological justification for this,
 
 
558
    but it looks much nicer.
 
 
561
    for val in merge_sorted_revisions:
 
 
563
            zd_revisions.append([val])
 
 
565
            zd_revisions[-1].append(val)
 
 
566
    for revisions in zd_revisions:
 
 
567
        if len(revisions) > 1:
 
 
568
            revisions[1:] = reverse_by_depth(revisions[1:], _depth + 1)
 
 
569
    zd_revisions.reverse()
 
 
571
    for chunk in zd_revisions:
 
 
576
class LogRevision(object):
 
 
577
    """A revision to be logged (by LogFormatter.log_revision).
 
 
579
    A simple wrapper for the attributes of a revision to be logged.
 
 
580
    The attributes may or may not be populated, as determined by the 
 
 
581
    logging options and the log formatter capabilities.
 
 
584
    def __init__(self, rev=None, revno=None, merge_depth=0, delta=None,
 
 
588
        self.merge_depth = merge_depth
 
 
593
class LogFormatter(object):
 
 
594
    """Abstract class to display log messages.
 
 
596
    At a minimum, a derived class must implement the log_revision method.
 
 
598
    If the LogFormatter needs to be informed of the beginning or end of
 
 
599
    a log it should implement the begin_log and/or end_log hook methods.
 
 
601
    A LogFormatter should define the following supports_XXX flags 
 
 
602
    to indicate which LogRevision attributes it supports:
 
 
604
    - supports_delta must be True if this log formatter supports delta.
 
 
605
        Otherwise the delta attribute may not be populated.
 
 
606
    - supports_merge_revisions must be True if this log formatter supports 
 
 
607
        merge revisions.  If not, and if supports_single_merge_revisions is
 
 
608
        also not True, then only mainline revisions will be passed to the 
 
 
610
    - supports_single_merge_revision must be True if this log formatter
 
 
611
        supports logging only a single merge revision.  This flag is
 
 
612
        only relevant if supports_merge_revisions is not True.
 
 
613
    - supports_tags must be True if this log formatter supports tags.
 
 
614
        Otherwise the tags attribute may not be populated.
 
 
616
    Plugins can register functions to show custom revision properties using
 
 
617
    the properties_handler_registry. The registered function
 
 
618
    must respect the following interface description:
 
 
619
        def my_show_properties(properties_dict):
 
 
620
            # code that returns a dict {'name':'value'} of the properties 
 
 
624
    def __init__(self, to_file, show_ids=False, show_timezone='original'):
 
 
625
        self.to_file = to_file
 
 
626
        self.show_ids = show_ids
 
 
627
        self.show_timezone = show_timezone
 
 
629
# TODO: uncomment this block after show() has been removed.
 
 
630
# Until then defining log_revision would prevent _show_log calling show() 
 
 
631
# in legacy formatters.
 
 
632
#    def log_revision(self, revision):
 
 
635
#        :param  revision:   The LogRevision to be logged.
 
 
637
#        raise NotImplementedError('not implemented in abstract base')
 
 
639
    def short_committer(self, rev):
 
 
640
        name, address = config.parse_username(rev.committer)
 
 
645
    def short_author(self, rev):
 
 
646
        name, address = config.parse_username(rev.get_apparent_author())
 
 
651
    def show_properties(self, revision, indent):
 
 
652
        """Displays the custom properties returned by each registered handler.
 
 
654
        If a registered handler raises an error it is propagated.
 
 
656
        for key, handler in properties_handler_registry.iteritems():
 
 
657
            for key, value in handler(revision).items():
 
 
658
                self.to_file.write(indent + key + ': ' + value + '\n')
 
 
661
class LongLogFormatter(LogFormatter):
 
 
663
    supports_merge_revisions = True
 
 
664
    supports_delta = True
 
 
667
    def log_revision(self, revision):
 
 
668
        """Log a revision, either merged or not."""
 
 
669
        indent = '    ' * revision.merge_depth
 
 
670
        to_file = self.to_file
 
 
671
        to_file.write(indent + '-' * 60 + '\n')
 
 
672
        if revision.revno is not None:
 
 
673
            to_file.write(indent + 'revno: %s\n' % (revision.revno,))
 
 
675
            to_file.write(indent + 'tags: %s\n' % (', '.join(revision.tags)))
 
 
677
            to_file.write(indent + 'revision-id: ' + revision.rev.revision_id)
 
 
679
            for parent_id in revision.rev.parent_ids:
 
 
680
                to_file.write(indent + 'parent: %s\n' % (parent_id,))
 
 
681
        self.show_properties(revision.rev, indent)
 
 
683
        author = revision.rev.properties.get('author', None)
 
 
684
        if author is not None:
 
 
685
            to_file.write(indent + 'author: %s\n' % (author,))
 
 
686
        to_file.write(indent + 'committer: %s\n' % (revision.rev.committer,))
 
 
688
        branch_nick = revision.rev.properties.get('branch-nick', None)
 
 
689
        if branch_nick is not None:
 
 
690
            to_file.write(indent + 'branch nick: %s\n' % (branch_nick,))
 
 
692
        date_str = format_date(revision.rev.timestamp,
 
 
693
                               revision.rev.timezone or 0,
 
 
695
        to_file.write(indent + 'timestamp: %s\n' % (date_str,))
 
 
697
        to_file.write(indent + 'message:\n')
 
 
698
        if not revision.rev.message:
 
 
699
            to_file.write(indent + '  (no message)\n')
 
 
701
            message = revision.rev.message.rstrip('\r\n')
 
 
702
            for l in message.split('\n'):
 
 
703
                to_file.write(indent + '  %s\n' % (l,))
 
 
704
        if revision.delta is not None:
 
 
705
            revision.delta.show(to_file, self.show_ids, indent=indent)
 
 
708
class ShortLogFormatter(LogFormatter):
 
 
710
    supports_delta = True
 
 
711
    supports_single_merge_revision = True
 
 
713
    def log_revision(self, revision):
 
 
714
        to_file = self.to_file
 
 
716
        if len(revision.rev.parent_ids) > 1:
 
 
717
            is_merge = ' [merge]'
 
 
718
        to_file.write("%5s %s\t%s%s\n" % (revision.revno,
 
 
719
                self.short_author(revision.rev),
 
 
720
                format_date(revision.rev.timestamp,
 
 
721
                            revision.rev.timezone or 0,
 
 
722
                            self.show_timezone, date_fmt="%Y-%m-%d",
 
 
726
            to_file.write('      revision-id:%s\n' % (revision.rev.revision_id,))
 
 
727
        if not revision.rev.message:
 
 
728
            to_file.write('      (no message)\n')
 
 
730
            message = revision.rev.message.rstrip('\r\n')
 
 
731
            for l in message.split('\n'):
 
 
732
                to_file.write('      %s\n' % (l,))
 
 
734
        # TODO: Why not show the modified files in a shorter form as
 
 
735
        # well? rewrap them single lines of appropriate length
 
 
736
        if revision.delta is not None:
 
 
737
            revision.delta.show(to_file, self.show_ids)
 
 
741
class LineLogFormatter(LogFormatter):
 
 
743
    supports_single_merge_revision = True
 
 
745
    def __init__(self, *args, **kwargs):
 
 
746
        super(LineLogFormatter, self).__init__(*args, **kwargs)
 
 
747
        self._max_chars = terminal_width() - 1
 
 
749
    def truncate(self, str, max_len):
 
 
750
        if len(str) <= max_len:
 
 
752
        return str[:max_len-3]+'...'
 
 
754
    def date_string(self, rev):
 
 
755
        return format_date(rev.timestamp, rev.timezone or 0, 
 
 
756
                           self.show_timezone, date_fmt="%Y-%m-%d",
 
 
759
    def message(self, rev):
 
 
761
            return '(no message)'
 
 
765
    def log_revision(self, revision):
 
 
766
        self.to_file.write(self.log_string(revision.revno, revision.rev,
 
 
768
        self.to_file.write('\n')
 
 
770
    def log_string(self, revno, rev, max_chars):
 
 
771
        """Format log info into one string. Truncate tail of string
 
 
772
        :param  revno:      revision number (int) or None.
 
 
773
                            Revision numbers counts from 1.
 
 
774
        :param  rev:        revision info object
 
 
775
        :param  max_chars:  maximum length of resulting string
 
 
776
        :return:            formatted truncated string
 
 
780
            # show revno only when is not None
 
 
781
            out.append("%s:" % revno)
 
 
782
        out.append(self.truncate(self.short_author(rev), 20))
 
 
783
        out.append(self.date_string(rev))
 
 
784
        out.append(rev.get_summary())
 
 
785
        return self.truncate(" ".join(out).rstrip('\n'), max_chars)
 
 
788
def line_log(rev, max_chars):
 
 
789
    lf = LineLogFormatter(None)
 
 
790
    return lf.log_string(None, rev, max_chars)
 
 
793
class LogFormatterRegistry(registry.Registry):
 
 
794
    """Registry for log formatters"""
 
 
796
    def make_formatter(self, name, *args, **kwargs):
 
 
797
        """Construct a formatter from arguments.
 
 
799
        :param name: Name of the formatter to construct.  'short', 'long' and
 
 
802
        return self.get(name)(*args, **kwargs)
 
 
804
    def get_default(self, branch):
 
 
805
        return self.get(branch.get_config().log_format())
 
 
808
log_formatter_registry = LogFormatterRegistry()
 
 
811
log_formatter_registry.register('short', ShortLogFormatter,
 
 
812
                                'Moderately short log format')
 
 
813
log_formatter_registry.register('long', LongLogFormatter,
 
 
814
                                'Detailed log format')
 
 
815
log_formatter_registry.register('line', LineLogFormatter,
 
 
816
                                'Log format with one line per revision')
 
 
819
def register_formatter(name, formatter):
 
 
820
    log_formatter_registry.register(name, formatter)
 
 
823
def log_formatter(name, *args, **kwargs):
 
 
824
    """Construct a formatter from arguments.
 
 
826
    name -- Name of the formatter to construct; currently 'long', 'short' and
 
 
827
        'line' are supported.
 
 
830
        return log_formatter_registry.make_formatter(name, *args, **kwargs)
 
 
832
        raise errors.BzrCommandError("unknown log formatter: %r" % name)
 
 
835
def show_one_log(revno, rev, delta, verbose, to_file, show_timezone):
 
 
836
    # deprecated; for compatibility
 
 
837
    lf = LongLogFormatter(to_file=to_file, show_timezone=show_timezone)
 
 
838
    lf.show(revno, rev, delta)
 
 
841
def show_changed_revisions(branch, old_rh, new_rh, to_file=None,
 
 
843
    """Show the change in revision history comparing the old revision history to the new one.
 
 
845
    :param branch: The branch where the revisions exist
 
 
846
    :param old_rh: The old revision history
 
 
847
    :param new_rh: The new revision history
 
 
848
    :param to_file: A file to write the results to. If None, stdout will be used
 
 
851
        to_file = codecs.getwriter(get_terminal_encoding())(sys.stdout,
 
 
853
    lf = log_formatter(log_format,
 
 
856
                       show_timezone='original')
 
 
858
    # This is the first index which is different between
 
 
861
    for i in xrange(max(len(new_rh),
 
 
865
            or new_rh[i] != old_rh[i]):
 
 
870
        to_file.write('Nothing seems to have changed\n')
 
 
872
    ## TODO: It might be nice to do something like show_log
 
 
873
    ##       and show the merged entries. But since this is the
 
 
874
    ##       removed revisions, it shouldn't be as important
 
 
875
    if base_idx < len(old_rh):
 
 
876
        to_file.write('*'*60)
 
 
877
        to_file.write('\nRemoved Revisions:\n')
 
 
878
        for i in range(base_idx, len(old_rh)):
 
 
879
            rev = branch.repository.get_revision(old_rh[i])
 
 
880
            lr = LogRevision(rev, i+1, 0, None)
 
 
882
        to_file.write('*'*60)
 
 
883
        to_file.write('\n\n')
 
 
884
    if base_idx < len(new_rh):
 
 
885
        to_file.write('Added Revisions:\n')
 
 
891
                 start_revision=base_idx+1,
 
 
892
                 end_revision=len(new_rh),
 
 
896
properties_handler_registry = registry.Registry()