/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/log.py

  • Committer: Kent Gibson
  • Date: 2007-11-17 09:37:33 UTC
  • mto: This revision was merged to the branch mainline in revision 3067.
  • Revision ID: warthog618@gmail.com-20071117093733-r31dz89u600c6zxm
Support logging single merge revisions with short and line log formatters.

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