/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: Robert Collins
  • Date: 2008-03-26 21:42:35 UTC
  • mto: This revision was merged to the branch mainline in revision 3313.
  • Revision ID: robertc@robertcollins.net-20080326214235-3wmnqamcgytwif89
 * ``VersionedFile.get_graph`` is deprecated, with no replacement method.
   The method was size(history) and not desirable. (Robert Collins)

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