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