~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/log.py

  • Committer: Vincent Ladeuil
  • Date: 2007-11-14 08:20:59 UTC
  • mfrom: (2990 +trunk)
  • mto: (2990.1.1 trunk)
  • mto: This revision was merged to the branch mainline in revision 2991.
  • Revision ID: v.ladeuil+lp@free.fr-20071114082059-bx03o3laiqfnyleb
merge bzr.dev

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
# Copyright (C) 2005, 2006, 2007 Canonical Ltd
 
2
#
 
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.
 
7
#
 
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.
 
12
#
 
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
 
16
 
 
17
 
 
18
 
 
19
"""Code to show logs of changes.
 
20
 
 
21
Various flavors of log can be produced:
 
22
 
 
23
* for one file, or the whole tree, and (not done yet) for
 
24
  files in a given directory
 
25
 
 
26
* in "verbose" mode with a description of what changed from one
 
27
  version to the next
 
28
 
 
29
* with file-ids and revision-ids shown
 
30
 
 
31
Logs are actually written out through an abstract LogFormatter
 
32
interface, which allows for different preferred formats.  Plugins can
 
33
register formats too.
 
34
 
 
35
Logs can be produced in either forward (oldest->newest) or reverse
 
36
(newest->oldest) order.
 
37
 
 
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
 
41
calling in here.
 
42
 
 
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.
 
50
"""
 
51
 
 
52
from itertools import izip
 
53
import re
 
54
 
 
55
from bzrlib import (
 
56
    registry,
 
57
    symbol_versioning,
 
58
    )
 
59
import bzrlib.errors as errors
 
60
from bzrlib.revision import (
 
61
    NULL_REVISION,
 
62
    )
 
63
from bzrlib.revisionspec import (
 
64
    RevisionInfo,
 
65
    )
 
66
from bzrlib.symbol_versioning import (
 
67
    deprecated_method,
 
68
    zero_seventeen,
 
69
    )
 
70
from bzrlib.trace import mutter
 
71
from bzrlib.tsort import (
 
72
    merge_sort,
 
73
    topo_sort,
 
74
    )
 
75
 
 
76
 
 
77
def find_touching_revisions(branch, file_id):
 
78
    """Yield a description of revisions which affect the file_id.
 
79
 
 
80
    Each returned element is (revno, revision_id, description)
 
81
 
 
82
    This is the list of revisions where the file is either added,
 
83
    modified, renamed or deleted.
 
84
 
 
85
    TODO: Perhaps some way to limit this to only particular revisions,
 
86
    or to traverse a non-mainline set of revisions?
 
87
    """
 
88
    last_ie = None
 
89
    last_path = None
 
90
    revno = 1
 
91
    for revision_id in branch.revision_history():
 
92
        this_inv = branch.repository.get_revision_inventory(revision_id)
 
93
        if file_id in this_inv:
 
94
            this_ie = this_inv[file_id]
 
95
            this_path = this_inv.id2path(file_id)
 
96
        else:
 
97
            this_ie = this_path = None
 
98
 
 
99
        # now we know how it was last time, and how it is in this revision.
 
100
        # are those two states effectively the same or not?
 
101
 
 
102
        if not this_ie and not last_ie:
 
103
            # not present in either
 
104
            pass
 
105
        elif this_ie and not last_ie:
 
106
            yield revno, revision_id, "added " + this_path
 
107
        elif not this_ie and last_ie:
 
108
            # deleted here
 
109
            yield revno, revision_id, "deleted " + last_path
 
110
        elif this_path != last_path:
 
111
            yield revno, revision_id, ("renamed %s => %s" % (last_path, this_path))
 
112
        elif (this_ie.text_size != last_ie.text_size
 
113
              or this_ie.text_sha1 != last_ie.text_sha1):
 
114
            yield revno, revision_id, "modified " + this_path
 
115
 
 
116
        last_ie = this_ie
 
117
        last_path = this_path
 
118
        revno += 1
 
119
 
 
120
 
 
121
def _enumerate_history(branch):
 
122
    rh = []
 
123
    revno = 1
 
124
    for rev_id in branch.revision_history():
 
125
        rh.append((revno, rev_id))
 
126
        revno += 1
 
127
    return rh
 
128
 
 
129
 
 
130
def show_log(branch,
 
131
             lf,
 
132
             specific_fileid=None,
 
133
             verbose=False,
 
134
             direction='reverse',
 
135
             start_revision=None,
 
136
             end_revision=None,
 
137
             search=None,
 
138
             limit=None):
 
139
    """Write out human-readable log of commits to this branch.
 
140
 
 
141
    lf
 
142
        LogFormatter object to show the output.
 
143
 
 
144
    specific_fileid
 
145
        If true, list only the commits affecting the specified
 
146
        file, rather than all commits.
 
147
 
 
148
    verbose
 
149
        If true show added/changed/deleted/renamed files.
 
150
 
 
151
    direction
 
152
        'reverse' (default) is latest to earliest;
 
153
        'forward' is earliest to latest.
 
154
 
 
155
    start_revision
 
156
        If not None, only show revisions >= start_revision
 
157
 
 
158
    end_revision
 
159
        If not None, only show revisions <= end_revision
 
160
 
 
161
    search
 
162
        If not None, only show revisions with matching commit messages
 
163
 
 
164
    limit
 
165
        If not None or 0, only show limit revisions
 
166
    """
 
167
    branch.lock_read()
 
168
    try:
 
169
        if getattr(lf, 'begin_log', None):
 
170
            lf.begin_log()
 
171
 
 
172
        _show_log(branch, lf, specific_fileid, verbose, direction,
 
173
                  start_revision, end_revision, search, limit)
 
174
 
 
175
        if getattr(lf, 'end_log', None):
 
176
            lf.end_log()
 
177
    finally:
 
178
        branch.unlock()
 
179
 
 
180
def _show_log(branch,
 
181
             lf,
 
182
             specific_fileid=None,
 
183
             verbose=False,
 
184
             direction='reverse',
 
185
             start_revision=None,
 
186
             end_revision=None,
 
187
             search=None,
 
188
             limit=None):
 
189
    """Worker function for show_log - see show_log."""
 
190
    from bzrlib.osutils import format_date
 
191
    from bzrlib.errors import BzrCheckError
 
192
    
 
193
    from warnings import warn
 
194
 
 
195
    if not isinstance(lf, LogFormatter):
 
196
        warn("not a LogFormatter instance: %r" % lf)
 
197
 
 
198
    if specific_fileid:
 
199
        mutter('get log for file_id %r', specific_fileid)
 
200
 
 
201
    if search is not None:
 
202
        import re
 
203
        searchRE = re.compile(search, re.IGNORECASE)
 
204
    else:
 
205
        searchRE = None
 
206
 
 
207
    mainline_revs, rev_nos, start_rev_id, end_rev_id = \
 
208
        _get_mainline_revs(branch, start_revision, end_revision)
 
209
    if not mainline_revs:
 
210
        return
 
211
 
 
212
    if direction == 'reverse':
 
213
        start_rev_id, end_rev_id = end_rev_id, start_rev_id
 
214
        
 
215
    legacy_lf = getattr(lf, 'log_revision', None) is None
 
216
    if legacy_lf:
 
217
        # pre-0.17 formatters use show for mainline revisions.
 
218
        # how should we show merged revisions ?
 
219
        #   pre-0.11 api: show_merge
 
220
        #   0.11-0.16 api: show_merge_revno
 
221
        show_merge_revno = getattr(lf, 'show_merge_revno', None)
 
222
        show_merge = getattr(lf, 'show_merge', None)
 
223
        if show_merge is None and show_merge_revno is None:
 
224
            # no merged-revno support
 
225
            generate_merge_revisions = False
 
226
        else:
 
227
            generate_merge_revisions = True
 
228
        # tell developers to update their code
 
229
        symbol_versioning.warn('LogFormatters should provide log_revision '
 
230
            'instead of show and show_merge_revno since bzr 0.17.',
 
231
            DeprecationWarning, stacklevel=3)
 
232
    else:
 
233
        generate_merge_revisions = getattr(lf, 'supports_merge_revisions', 
 
234
                                           False)
 
235
    if ((not generate_merge_revisions)
 
236
        and ((start_rev_id and (start_rev_id not in rev_nos))
 
237
            or (end_rev_id and (end_rev_id not in rev_nos)))):
 
238
        from bzrlib.errors import BzrCommandError
 
239
        raise BzrCommandError('Selected log formatter only supports '
 
240
            'mainline revisions.')
 
241
    view_revs_iter = get_view_revisions(mainline_revs, rev_nos, branch,
 
242
                          direction, include_merges=generate_merge_revisions)
 
243
    view_revisions = _filter_revision_range(list(view_revs_iter),
 
244
                                            start_rev_id,
 
245
                                            end_rev_id)
 
246
    if specific_fileid:
 
247
        view_revisions = _filter_revisions_touching_file_id(branch,
 
248
                                                         specific_fileid,
 
249
                                                         mainline_revs,
 
250
                                                         view_revisions)
 
251
 
 
252
    # rebase merge_depth - unless there are no revisions or 
 
253
    # either the first or last revision have merge_depth = 0.
 
254
    if view_revisions and view_revisions[0][2] and view_revisions[-1][2]:
 
255
        min_depth = min([d for r,n,d in view_revisions])
 
256
        if min_depth != 0:
 
257
            view_revisions = [(r,n,d-min_depth) for r,n,d in view_revisions]
 
258
        
 
259
    rev_tag_dict = {}
 
260
    generate_tags = getattr(lf, 'supports_tags', False)
 
261
    if generate_tags:
 
262
        if branch.supports_tags():
 
263
            rev_tag_dict = branch.tags.get_reverse_tag_dict()
 
264
 
 
265
    generate_delta = verbose and getattr(lf, 'supports_delta', False)
 
266
 
 
267
    def iter_revisions():
 
268
        # r = revision, n = revno, d = merge depth
 
269
        revision_ids = [r for r, n, d in view_revisions]
 
270
        num = 9
 
271
        repository = branch.repository
 
272
        while revision_ids:
 
273
            cur_deltas = {}
 
274
            revisions = repository.get_revisions(revision_ids[:num])
 
275
            if generate_delta:
 
276
                deltas = repository.get_deltas_for_revisions(revisions)
 
277
                cur_deltas = dict(izip((r.revision_id for r in revisions),
 
278
                                       deltas))
 
279
            for revision in revisions:
 
280
                yield revision, cur_deltas.get(revision.revision_id)
 
281
            revision_ids  = revision_ids[num:]
 
282
            num = min(int(num * 1.5), 200)
 
283
 
 
284
    # now we just print all the revisions
 
285
    log_count = 0
 
286
    for ((rev_id, revno, merge_depth), (rev, delta)) in \
 
287
         izip(view_revisions, iter_revisions()):
 
288
 
 
289
        if searchRE:
 
290
            if not searchRE.search(rev.message):
 
291
                continue
 
292
 
 
293
        if not legacy_lf:
 
294
            lr = LogRevision(rev, revno, merge_depth, delta,
 
295
                             rev_tag_dict.get(rev_id))
 
296
            lf.log_revision(lr)
 
297
        else:
 
298
            # support for legacy (pre-0.17) LogFormatters
 
299
            if merge_depth == 0:
 
300
                if generate_tags:
 
301
                    lf.show(revno, rev, delta, rev_tag_dict.get(rev_id))
 
302
                else:
 
303
                    lf.show(revno, rev, delta)
 
304
            else:
 
305
                if show_merge_revno is None:
 
306
                    lf.show_merge(rev, merge_depth)
 
307
                else:
 
308
                    if generate_tags:
 
309
                        lf.show_merge_revno(rev, merge_depth, revno,
 
310
                                            rev_tag_dict.get(rev_id))
 
311
                    else:
 
312
                        lf.show_merge_revno(rev, merge_depth, revno)
 
313
        if limit:
 
314
            log_count += 1
 
315
            if log_count >= limit:
 
316
                break
 
317
 
 
318
 
 
319
def _get_mainline_revs(branch, start_revision, end_revision):
 
320
    """Get the mainline revisions from the branch.
 
321
    
 
322
    Generates the list of mainline revisions for the branch.
 
323
    
 
324
    :param  branch: The branch containing the revisions. 
 
325
 
 
326
    :param  start_revision: The first revision to be logged.
 
327
            For backwards compatibility this may be a mainline integer revno,
 
328
            but for merge revision support a RevisionInfo is expected.
 
329
 
 
330
    :param  end_revision: The last revision to be logged.
 
331
            For backwards compatibility this may be a mainline integer revno,
 
332
            but for merge revision support a RevisionInfo is expected.
 
333
 
 
334
    :return: A (mainline_revs, rev_nos, start_rev_id, end_rev_id) tuple.
 
335
    """
 
336
    which_revs = _enumerate_history(branch)
 
337
    if not which_revs:
 
338
        return None, None, None, None
 
339
 
 
340
    # For mainline generation, map start_revision and end_revision to 
 
341
    # mainline revnos. If the revision is not on the mainline choose the 
 
342
    # appropriate extreme of the mainline instead - the extra will be 
 
343
    # filtered later.
 
344
    # Also map the revisions to rev_ids, to be used in the later filtering
 
345
    # stage.
 
346
    start_rev_id = None 
 
347
    if start_revision is None:
 
348
        start_revno = 1
 
349
    else:
 
350
        if isinstance(start_revision,RevisionInfo):
 
351
            start_rev_id = start_revision.rev_id
 
352
            start_revno = start_revision.revno or 1
 
353
        else:
 
354
            branch.check_real_revno(start_revision)
 
355
            start_revno = start_revision
 
356
    
 
357
    end_rev_id = None
 
358
    if end_revision is None:
 
359
        end_revno = len(which_revs)
 
360
    else:
 
361
        if isinstance(end_revision,RevisionInfo):
 
362
            end_rev_id = end_revision.rev_id
 
363
            end_revno = end_revision.revno or len(which_revs)
 
364
        else:
 
365
            branch.check_real_revno(end_revision)
 
366
            end_revno = end_revision
 
367
 
 
368
    if ((start_rev_id == NULL_REVISION)
 
369
        or (end_rev_id == NULL_REVISION)):
 
370
        from bzrlib.errors import BzrCommandError
 
371
        raise BzrCommandError('Logging revision 0 is invalid.')
 
372
    if start_revno > end_revno:
 
373
        from bzrlib.errors import BzrCommandError
 
374
        raise BzrCommandError("Start revision must be older than "
 
375
                              "the end revision.")
 
376
 
 
377
    # list indexes are 0-based; revisions are 1-based
 
378
    cut_revs = which_revs[(start_revno-1):(end_revno)]
 
379
    if not cut_revs:
 
380
        return None, None, None, None
 
381
 
 
382
    # convert the revision history to a dictionary:
 
383
    rev_nos = dict((k, v) for v, k in cut_revs)
 
384
 
 
385
    # override the mainline to look like the revision history.
 
386
    mainline_revs = [revision_id for index, revision_id in cut_revs]
 
387
    if cut_revs[0][0] == 1:
 
388
        mainline_revs.insert(0, None)
 
389
    else:
 
390
        mainline_revs.insert(0, which_revs[start_revno-2][1])
 
391
    return mainline_revs, rev_nos, start_rev_id, end_rev_id
 
392
 
 
393
 
 
394
def _filter_revision_range(view_revisions, start_rev_id, end_rev_id):
 
395
    """Filter view_revisions based on revision ranges.
 
396
 
 
397
    :param view_revisions: A list of (revision_id, dotted_revno, merge_depth) 
 
398
            tuples to be filtered.
 
399
 
 
400
    :param start_rev_id: If not NONE specifies the first revision to be logged.
 
401
            If NONE then all revisions up to the end_rev_id are logged.
 
402
 
 
403
    :param end_rev_id: If not NONE specifies the last revision to be logged.
 
404
            If NONE then all revisions up to the end of the log are logged.
 
405
 
 
406
    :return: The filtered view_revisions.
 
407
    """
 
408
    if start_rev_id or end_rev_id: 
 
409
        revision_ids = [r for r, n, d in view_revisions]
 
410
        if start_rev_id:
 
411
            start_index = revision_ids.index(start_rev_id)
 
412
        else:
 
413
            start_index = 0
 
414
        if start_rev_id == end_rev_id:
 
415
            end_index = start_index
 
416
        else:
 
417
            if end_rev_id:
 
418
                end_index = revision_ids.index(end_rev_id)
 
419
            else:
 
420
                end_index = len(view_revisions) - 1
 
421
        # To include the revisions merged into the last revision, 
 
422
        # extend end_rev_id down to, but not including, the next rev
 
423
        # with the same or lesser merge_depth
 
424
        end_merge_depth = view_revisions[end_index][2]
 
425
        try:
 
426
            for index in xrange(end_index+1, len(view_revisions)+1):
 
427
                if view_revisions[index][2] <= end_merge_depth:
 
428
                    end_index = index - 1
 
429
                    break
 
430
        except IndexError:
 
431
            # if the search falls off the end then log to the end as well
 
432
            end_index = len(view_revisions) - 1
 
433
        view_revisions = view_revisions[start_index:end_index+1]
 
434
    return view_revisions
 
435
 
 
436
 
 
437
def _filter_revisions_touching_file_id(branch, file_id, mainline_revisions,
 
438
                                       view_revs_iter):
 
439
    """Return the list of revision ids which touch a given file id.
 
440
 
 
441
    The function filters view_revisions and returns a subset.
 
442
    This includes the revisions which directly change the file id,
 
443
    and the revisions which merge these changes. So if the
 
444
    revision graph is::
 
445
        A
 
446
        |\
 
447
        B C
 
448
        |/
 
449
        D
 
450
 
 
451
    And 'C' changes a file, then both C and D will be returned.
 
452
 
 
453
    This will also can be restricted based on a subset of the mainline.
 
454
 
 
455
    :return: A list of (revision_id, dotted_revno, merge_depth) tuples.
 
456
    """
 
457
    # find all the revisions that change the specific file
 
458
    file_weave = branch.repository.weave_store.get_weave(file_id,
 
459
                branch.repository.get_transaction())
 
460
    weave_modifed_revisions = set(file_weave.versions())
 
461
    # build the ancestry of each revision in the graph
 
462
    # - only listing the ancestors that change the specific file.
 
463
    rev_graph = branch.repository.get_revision_graph(mainline_revisions[-1])
 
464
    sorted_rev_list = topo_sort(rev_graph)
 
465
    ancestry = {}
 
466
    for rev in sorted_rev_list:
 
467
        parents = rev_graph[rev]
 
468
        if rev not in weave_modifed_revisions and len(parents) == 1:
 
469
            # We will not be adding anything new, so just use a reference to
 
470
            # the parent ancestry.
 
471
            rev_ancestry = ancestry[parents[0]]
 
472
        else:
 
473
            rev_ancestry = set()
 
474
            if rev in weave_modifed_revisions:
 
475
                rev_ancestry.add(rev)
 
476
            for parent in parents:
 
477
                rev_ancestry = rev_ancestry.union(ancestry[parent])
 
478
        ancestry[rev] = rev_ancestry
 
479
 
 
480
    def is_merging_rev(r):
 
481
        parents = rev_graph[r]
 
482
        if len(parents) > 1:
 
483
            leftparent = parents[0]
 
484
            for rightparent in parents[1:]:
 
485
                if not ancestry[leftparent].issuperset(
 
486
                        ancestry[rightparent]):
 
487
                    return True
 
488
        return False
 
489
 
 
490
    # filter from the view the revisions that did not change or merge 
 
491
    # the specific file
 
492
    return [(r, n, d) for r, n, d in view_revs_iter
 
493
            if r in weave_modifed_revisions or is_merging_rev(r)]
 
494
 
 
495
 
 
496
def get_view_revisions(mainline_revs, rev_nos, branch, direction,
 
497
                       include_merges=True):
 
498
    """Produce an iterator of revisions to show
 
499
    :return: an iterator of (revision_id, revno, merge_depth)
 
500
    (if there is no revno for a revision, None is supplied)
 
501
    """
 
502
    if include_merges is False:
 
503
        revision_ids = mainline_revs[1:]
 
504
        if direction == 'reverse':
 
505
            revision_ids.reverse()
 
506
        for revision_id in revision_ids:
 
507
            yield revision_id, str(rev_nos[revision_id]), 0
 
508
        return
 
509
    merge_sorted_revisions = merge_sort(
 
510
        branch.repository.get_revision_graph(mainline_revs[-1]),
 
511
        mainline_revs[-1],
 
512
        mainline_revs,
 
513
        generate_revno=True)
 
514
 
 
515
    if direction == 'forward':
 
516
        # forward means oldest first.
 
517
        merge_sorted_revisions = reverse_by_depth(merge_sorted_revisions)
 
518
    elif direction != 'reverse':
 
519
        raise ValueError('invalid direction %r' % direction)
 
520
 
 
521
    for sequence, rev_id, merge_depth, revno, end_of_merge in merge_sorted_revisions:
 
522
        yield rev_id, '.'.join(map(str, revno)), merge_depth
 
523
 
 
524
 
 
525
def reverse_by_depth(merge_sorted_revisions, _depth=0):
 
526
    """Reverse revisions by depth.
 
527
 
 
528
    Revisions with a different depth are sorted as a group with the previous
 
529
    revision of that depth.  There may be no topological justification for this,
 
530
    but it looks much nicer.
 
531
    """
 
532
    zd_revisions = []
 
533
    for val in merge_sorted_revisions:
 
534
        if val[2] == _depth:
 
535
            zd_revisions.append([val])
 
536
        else:
 
537
            assert val[2] > _depth
 
538
            zd_revisions[-1].append(val)
 
539
    for revisions in zd_revisions:
 
540
        if len(revisions) > 1:
 
541
            revisions[1:] = reverse_by_depth(revisions[1:], _depth + 1)
 
542
    zd_revisions.reverse()
 
543
    result = []
 
544
    for chunk in zd_revisions:
 
545
        result.extend(chunk)
 
546
    return result
 
547
 
 
548
 
 
549
class LogRevision(object):
 
550
    """A revision to be logged (by LogFormatter.log_revision).
 
551
 
 
552
    A simple wrapper for the attributes of a revision to be logged.
 
553
    The attributes may or may not be populated, as determined by the 
 
554
    logging options and the log formatter capabilities.
 
555
    """
 
556
 
 
557
    def __init__(self, rev=None, revno=None, merge_depth=0, delta=None,
 
558
                 tags=None):
 
559
        self.rev = rev
 
560
        self.revno = revno
 
561
        self.merge_depth = merge_depth
 
562
        self.delta = delta
 
563
        self.tags = tags
 
564
 
 
565
 
 
566
class LogFormatter(object):
 
567
    """Abstract class to display log messages.
 
568
 
 
569
    At a minimum, a derived class must implement the log_revision method.
 
570
 
 
571
    If the LogFormatter needs to be informed of the beginning or end of
 
572
    a log it should implement the begin_log and/or end_log hook methods.
 
573
 
 
574
    A LogFormatter should define the following supports_XXX flags 
 
575
    to indicate which LogRevision attributes it supports:
 
576
 
 
577
    - supports_delta must be True if this log formatter supports delta.
 
578
        Otherwise the delta attribute may not be populated.
 
579
    - supports_merge_revisions must be True if this log formatter supports 
 
580
        merge revisions.  If not, only mainline revisions (those 
 
581
        with merge_depth == 0) will be passed to the formatter.
 
582
    - supports_tags must be True if this log formatter supports tags.
 
583
        Otherwise the tags attribute may not be populated.
 
584
    """
 
585
 
 
586
    def __init__(self, to_file, show_ids=False, show_timezone='original'):
 
587
        self.to_file = to_file
 
588
        self.show_ids = show_ids
 
589
        self.show_timezone = show_timezone
 
590
 
 
591
# TODO: uncomment this block after show() has been removed.
 
592
# Until then defining log_revision would prevent _show_log calling show() 
 
593
# in legacy formatters.
 
594
#    def log_revision(self, revision):
 
595
#        """Log a revision.
 
596
#
 
597
#        :param  revision:   The LogRevision to be logged.
 
598
#        """
 
599
#        raise NotImplementedError('not implemented in abstract base')
 
600
 
 
601
    @deprecated_method(zero_seventeen)
 
602
    def show(self, revno, rev, delta):
 
603
        raise NotImplementedError('not implemented in abstract base')
 
604
 
 
605
    def short_committer(self, rev):
 
606
        return re.sub('<.*@.*>', '', rev.committer).strip(' ')
 
607
 
 
608
    def short_author(self, rev):
 
609
        return re.sub('<.*@.*>', '', rev.get_apparent_author()).strip(' ')
 
610
 
 
611
 
 
612
class LongLogFormatter(LogFormatter):
 
613
 
 
614
    supports_merge_revisions = True
 
615
    supports_delta = True
 
616
    supports_tags = True
 
617
 
 
618
    @deprecated_method(zero_seventeen)
 
619
    def show(self, revno, rev, delta, tags=None):
 
620
        lr = LogRevision(rev, revno, 0, delta, tags)
 
621
        return self.log_revision(lr)
 
622
 
 
623
    @deprecated_method(zero_seventeen)
 
624
    def show_merge_revno(self, rev, merge_depth, revno, tags=None):
 
625
        """Show a merged revision rev, with merge_depth and a revno."""
 
626
        lr = LogRevision(rev, revno, merge_depth, tags=tags)
 
627
        return self.log_revision(lr)
 
628
 
 
629
    def log_revision(self, revision):
 
630
        """Log a revision, either merged or not."""
 
631
        from bzrlib.osutils import format_date
 
632
        indent = '    ' * revision.merge_depth
 
633
        to_file = self.to_file
 
634
        to_file.write(indent + '-' * 60 + '\n')
 
635
        if revision.revno is not None:
 
636
            to_file.write(indent + 'revno: %s\n' % (revision.revno,))
 
637
        if revision.tags:
 
638
            to_file.write(indent + 'tags: %s\n' % (', '.join(revision.tags)))
 
639
        if self.show_ids:
 
640
            to_file.write(indent + 'revision-id:' + revision.rev.revision_id)
 
641
            to_file.write('\n')
 
642
            for parent_id in revision.rev.parent_ids:
 
643
                to_file.write(indent + 'parent: %s\n' % (parent_id,))
 
644
 
 
645
        author = revision.rev.properties.get('author', None)
 
646
        if author is not None:
 
647
            to_file.write(indent + 'author: %s\n' % (author,))
 
648
        to_file.write(indent + 'committer: %s\n' % (revision.rev.committer,))
 
649
 
 
650
        branch_nick = revision.rev.properties.get('branch-nick', None)
 
651
        if branch_nick is not None:
 
652
            to_file.write(indent + 'branch nick: %s\n' % (branch_nick,))
 
653
 
 
654
        date_str = format_date(revision.rev.timestamp,
 
655
                               revision.rev.timezone or 0,
 
656
                               self.show_timezone)
 
657
        to_file.write(indent + 'timestamp: %s\n' % (date_str,))
 
658
 
 
659
        to_file.write(indent + 'message:\n')
 
660
        if not revision.rev.message:
 
661
            to_file.write(indent + '  (no message)\n')
 
662
        else:
 
663
            message = revision.rev.message.rstrip('\r\n')
 
664
            for l in message.split('\n'):
 
665
                to_file.write(indent + '  %s\n' % (l,))
 
666
        if revision.delta is not None:
 
667
            revision.delta.show(to_file, self.show_ids, indent=indent)
 
668
 
 
669
 
 
670
class ShortLogFormatter(LogFormatter):
 
671
 
 
672
    supports_delta = True
 
673
 
 
674
    @deprecated_method(zero_seventeen)
 
675
    def show(self, revno, rev, delta):
 
676
        lr = LogRevision(rev, revno, 0, delta)
 
677
        return self.log_revision(lr)
 
678
 
 
679
    def log_revision(self, revision):
 
680
        from bzrlib.osutils import format_date
 
681
 
 
682
        to_file = self.to_file
 
683
        date_str = format_date(revision.rev.timestamp,
 
684
                               revision.rev.timezone or 0,
 
685
                               self.show_timezone)
 
686
        is_merge = ''
 
687
        if len(revision.rev.parent_ids) > 1:
 
688
            is_merge = ' [merge]'
 
689
        to_file.write("%5s %s\t%s%s\n" % (revision.revno,
 
690
                self.short_author(revision.rev),
 
691
                format_date(revision.rev.timestamp,
 
692
                            revision.rev.timezone or 0,
 
693
                            self.show_timezone, date_fmt="%Y-%m-%d",
 
694
                            show_offset=False),
 
695
                is_merge))
 
696
        if self.show_ids:
 
697
            to_file.write('      revision-id:%s\n' % (revision.rev.revision_id,))
 
698
        if not revision.rev.message:
 
699
            to_file.write('      (no message)\n')
 
700
        else:
 
701
            message = revision.rev.message.rstrip('\r\n')
 
702
            for l in message.split('\n'):
 
703
                to_file.write('      %s\n' % (l,))
 
704
 
 
705
        # TODO: Why not show the modified files in a shorter form as
 
706
        # well? rewrap them single lines of appropriate length
 
707
        if revision.delta is not None:
 
708
            revision.delta.show(to_file, self.show_ids)
 
709
        to_file.write('\n')
 
710
 
 
711
 
 
712
class LineLogFormatter(LogFormatter):
 
713
 
 
714
    def __init__(self, *args, **kwargs):
 
715
        from bzrlib.osutils import terminal_width
 
716
        super(LineLogFormatter, self).__init__(*args, **kwargs)
 
717
        self._max_chars = terminal_width() - 1
 
718
 
 
719
    def truncate(self, str, max_len):
 
720
        if len(str) <= max_len:
 
721
            return str
 
722
        return str[:max_len-3]+'...'
 
723
 
 
724
    def date_string(self, rev):
 
725
        from bzrlib.osutils import format_date
 
726
        return format_date(rev.timestamp, rev.timezone or 0, 
 
727
                           self.show_timezone, date_fmt="%Y-%m-%d",
 
728
                           show_offset=False)
 
729
 
 
730
    def message(self, rev):
 
731
        if not rev.message:
 
732
            return '(no message)'
 
733
        else:
 
734
            return rev.message
 
735
 
 
736
    @deprecated_method(zero_seventeen)
 
737
    def show(self, revno, rev, delta):
 
738
        from bzrlib.osutils import terminal_width
 
739
        self.to_file.write(self.log_string(revno, rev, terminal_width()-1))
 
740
        self.to_file.write('\n')
 
741
 
 
742
    def log_revision(self, revision):
 
743
        self.to_file.write(self.log_string(revision.revno, revision.rev,
 
744
                                              self._max_chars))
 
745
        self.to_file.write('\n')
 
746
 
 
747
    def log_string(self, revno, rev, max_chars):
 
748
        """Format log info into one string. Truncate tail of string
 
749
        :param  revno:      revision number (int) or None.
 
750
                            Revision numbers counts from 1.
 
751
        :param  rev:        revision info object
 
752
        :param  max_chars:  maximum length of resulting string
 
753
        :return:            formatted truncated string
 
754
        """
 
755
        out = []
 
756
        if revno:
 
757
            # show revno only when is not None
 
758
            out.append("%s:" % revno)
 
759
        out.append(self.truncate(self.short_author(rev), 20))
 
760
        out.append(self.date_string(rev))
 
761
        out.append(rev.get_summary())
 
762
        return self.truncate(" ".join(out).rstrip('\n'), max_chars)
 
763
 
 
764
 
 
765
def line_log(rev, max_chars):
 
766
    lf = LineLogFormatter(None)
 
767
    return lf.log_string(None, rev, max_chars)
 
768
 
 
769
 
 
770
class LogFormatterRegistry(registry.Registry):
 
771
    """Registry for log formatters"""
 
772
 
 
773
    def make_formatter(self, name, *args, **kwargs):
 
774
        """Construct a formatter from arguments.
 
775
 
 
776
        :param name: Name of the formatter to construct.  'short', 'long' and
 
777
            'line' are built-in.
 
778
        """
 
779
        return self.get(name)(*args, **kwargs)
 
780
 
 
781
    def get_default(self, branch):
 
782
        return self.get(branch.get_config().log_format())
 
783
 
 
784
 
 
785
log_formatter_registry = LogFormatterRegistry()
 
786
 
 
787
 
 
788
log_formatter_registry.register('short', ShortLogFormatter,
 
789
                                'Moderately short log format')
 
790
log_formatter_registry.register('long', LongLogFormatter,
 
791
                                'Detailed log format')
 
792
log_formatter_registry.register('line', LineLogFormatter,
 
793
                                'Log format with one line per revision')
 
794
 
 
795
 
 
796
def register_formatter(name, formatter):
 
797
    log_formatter_registry.register(name, formatter)
 
798
 
 
799
 
 
800
def log_formatter(name, *args, **kwargs):
 
801
    """Construct a formatter from arguments.
 
802
 
 
803
    name -- Name of the formatter to construct; currently 'long', 'short' and
 
804
        'line' are supported.
 
805
    """
 
806
    from bzrlib.errors import BzrCommandError
 
807
    try:
 
808
        return log_formatter_registry.make_formatter(name, *args, **kwargs)
 
809
    except KeyError:
 
810
        raise BzrCommandError("unknown log formatter: %r" % name)
 
811
 
 
812
 
 
813
def show_one_log(revno, rev, delta, verbose, to_file, show_timezone):
 
814
    # deprecated; for compatibility
 
815
    lf = LongLogFormatter(to_file=to_file, show_timezone=show_timezone)
 
816
    lf.show(revno, rev, delta)
 
817
 
 
818
 
 
819
def show_changed_revisions(branch, old_rh, new_rh, to_file=None,
 
820
                           log_format='long'):
 
821
    """Show the change in revision history comparing the old revision history to the new one.
 
822
 
 
823
    :param branch: The branch where the revisions exist
 
824
    :param old_rh: The old revision history
 
825
    :param new_rh: The new revision history
 
826
    :param to_file: A file to write the results to. If None, stdout will be used
 
827
    """
 
828
    if to_file is None:
 
829
        import sys
 
830
        import codecs
 
831
        import bzrlib
 
832
        to_file = codecs.getwriter(bzrlib.user_encoding)(sys.stdout,
 
833
                                                         errors='replace')
 
834
    lf = log_formatter(log_format,
 
835
                       show_ids=False,
 
836
                       to_file=to_file,
 
837
                       show_timezone='original')
 
838
 
 
839
    # This is the first index which is different between
 
840
    # old and new
 
841
    base_idx = None
 
842
    for i in xrange(max(len(new_rh),
 
843
                        len(old_rh))):
 
844
        if (len(new_rh) <= i
 
845
            or len(old_rh) <= i
 
846
            or new_rh[i] != old_rh[i]):
 
847
            base_idx = i
 
848
            break
 
849
 
 
850
    if base_idx is None:
 
851
        to_file.write('Nothing seems to have changed\n')
 
852
        return
 
853
    ## TODO: It might be nice to do something like show_log
 
854
    ##       and show the merged entries. But since this is the
 
855
    ##       removed revisions, it shouldn't be as important
 
856
    if base_idx < len(old_rh):
 
857
        to_file.write('*'*60)
 
858
        to_file.write('\nRemoved Revisions:\n')
 
859
        for i in range(base_idx, len(old_rh)):
 
860
            rev = branch.repository.get_revision(old_rh[i])
 
861
            lr = LogRevision(rev, i+1, 0, None)
 
862
            lf.log_revision(lr)
 
863
        to_file.write('*'*60)
 
864
        to_file.write('\n\n')
 
865
    if base_idx < len(new_rh):
 
866
        to_file.write('Added Revisions:\n')
 
867
        show_log(branch,
 
868
                 lf,
 
869
                 None,
 
870
                 verbose=False,
 
871
                 direction='forward',
 
872
                 start_revision=base_idx+1,
 
873
                 end_revision=len(new_rh),
 
874
                 search=None)
 
875