/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: Guillermo Gonzalez
  • Date: 2008-07-05 23:06:12 UTC
  • mto: (3542.1.1 logdisplayers)
  • mto: This revision was merged to the branch mainline in revision 3556.
  • Revision ID: guillo.gonzo@gmail.com-20080705230612-0v78sasowqo8yflr
 * bzrlib.log.show_roperties don't hide handler errors
 * renames custom_properties_handler_registry to properties_handler_registry  
 * tests moved out of blackbox 
 * created TestCaseWithoutPropsHandler to avoid using properties handlers 
   in log tests that assertDiff against the full log output

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
    trace,
 
67
    )
 
68
from bzrlib.errors import (
 
69
    BzrCommandError,
 
70
    )
 
71
from bzrlib.osutils import (
 
72
    format_date,
 
73
    get_terminal_encoding,
 
74
    terminal_width,
 
75
    )
 
76
from bzrlib.repository import _strip_NULL_ghosts
 
77
from bzrlib.revision import (
 
78
    NULL_REVISION,
 
79
    )
 
80
from bzrlib.revisionspec import (
 
81
    RevisionInfo,
 
82
    )
 
83
from bzrlib.trace import mutter
 
84
from bzrlib.tsort import (
 
85
    merge_sort,
 
86
    topo_sort,
 
87
    )
 
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
 
 
194
def _show_log(branch,
 
195
             lf,
 
196
             specific_fileid=None,
 
197
             verbose=False,
 
198
             direction='reverse',
 
199
             start_revision=None,
 
200
             end_revision=None,
 
201
             search=None,
 
202
             limit=None):
 
203
    """Worker function for show_log - see show_log."""
 
204
    if not isinstance(lf, LogFormatter):
 
205
        warn("not a LogFormatter instance: %r" % lf)
 
206
 
 
207
    if specific_fileid:
 
208
        mutter('get log for file_id %r', specific_fileid)
 
209
    generate_merge_revisions = getattr(lf, 'supports_merge_revisions', False)
 
210
    allow_single_merge_revision = getattr(lf,
 
211
        'supports_single_merge_revision', False)
 
212
    view_revisions = calculate_view_revisions(branch, start_revision,
 
213
                                              end_revision, direction,
 
214
                                              specific_fileid,
 
215
                                              generate_merge_revisions,
 
216
                                              allow_single_merge_revision)
 
217
    if search is not None:
 
218
        searchRE = re.compile(search, re.IGNORECASE)
 
219
    else:
 
220
        searchRE = None
 
221
 
 
222
    rev_tag_dict = {}
 
223
    generate_tags = getattr(lf, 'supports_tags', False)
 
224
    if generate_tags:
 
225
        if branch.supports_tags():
 
226
            rev_tag_dict = branch.tags.get_reverse_tag_dict()
 
227
 
 
228
    generate_delta = verbose and getattr(lf, 'supports_delta', False)
 
229
 
 
230
    # now we just print all the revisions
 
231
    log_count = 0
 
232
    for (rev_id, revno, merge_depth), rev, delta in _iter_revisions(
 
233
        branch.repository, view_revisions, generate_delta):
 
234
        if searchRE:
 
235
            if not searchRE.search(rev.message):
 
236
                continue
 
237
 
 
238
        lr = LogRevision(rev, revno, merge_depth, delta,
 
239
                         rev_tag_dict.get(rev_id))
 
240
        lf.log_revision(lr)
 
241
        if limit:
 
242
            log_count += 1
 
243
            if log_count >= limit:
 
244
                break
 
245
 
 
246
 
 
247
def calculate_view_revisions(branch, start_revision, end_revision, direction,
 
248
                             specific_fileid, generate_merge_revisions,
 
249
                             allow_single_merge_revision):
 
250
    if (not generate_merge_revisions and start_revision is end_revision is
 
251
        None and direction == 'reverse' and specific_fileid is None):
 
252
        return _linear_view_revisions(branch)
 
253
 
 
254
    mainline_revs, rev_nos, start_rev_id, end_rev_id = \
 
255
        _get_mainline_revs(branch, start_revision, end_revision)
 
256
    if not mainline_revs:
 
257
        return []
 
258
 
 
259
    if direction == 'reverse':
 
260
        start_rev_id, end_rev_id = end_rev_id, start_rev_id
 
261
 
 
262
    generate_single_revision = False
 
263
    if ((not generate_merge_revisions)
 
264
        and ((start_rev_id and (start_rev_id not in rev_nos))
 
265
            or (end_rev_id and (end_rev_id not in rev_nos)))):
 
266
        generate_single_revision = ((start_rev_id == end_rev_id)
 
267
            and allow_single_merge_revision)
 
268
        if not generate_single_revision:
 
269
            raise BzrCommandError('Selected log formatter only supports '
 
270
                'mainline revisions.')
 
271
        generate_merge_revisions = generate_single_revision
 
272
    view_revs_iter = get_view_revisions(mainline_revs, rev_nos, branch,
 
273
                          direction, include_merges=generate_merge_revisions)
 
274
    view_revisions = _filter_revision_range(list(view_revs_iter),
 
275
                                            start_rev_id,
 
276
                                            end_rev_id)
 
277
    if view_revisions and generate_single_revision:
 
278
        view_revisions = view_revisions[0:1]
 
279
    if specific_fileid:
 
280
        view_revisions = _filter_revisions_touching_file_id(branch,
 
281
                                                         specific_fileid,
 
282
                                                         mainline_revs,
 
283
                                                         view_revisions)
 
284
 
 
285
    # rebase merge_depth - unless there are no revisions or 
 
286
    # either the first or last revision have merge_depth = 0.
 
287
    if view_revisions and view_revisions[0][2] and view_revisions[-1][2]:
 
288
        min_depth = min([d for r,n,d in view_revisions])
 
289
        if min_depth != 0:
 
290
            view_revisions = [(r,n,d-min_depth) for r,n,d in view_revisions]
 
291
    return view_revisions
 
292
 
 
293
 
 
294
def _linear_view_revisions(branch):
 
295
    start_revno, start_revision_id = branch.last_revision_info()
 
296
    repo = branch.repository
 
297
    revision_ids = repo.iter_reverse_revision_history(start_revision_id)
 
298
    for num, revision_id in enumerate(revision_ids):
 
299
        yield revision_id, str(start_revno - num), 0
 
300
 
 
301
 
 
302
def _iter_revisions(repository, view_revisions, generate_delta):
 
303
    num = 9
 
304
    view_revisions = iter(view_revisions)
 
305
    while True:
 
306
        cur_view_revisions = [d for x, d in zip(range(num), view_revisions)]
 
307
        if len(cur_view_revisions) == 0:
 
308
            break
 
309
        cur_deltas = {}
 
310
        # r = revision, n = revno, d = merge depth
 
311
        revision_ids = [r for (r, n, d) in cur_view_revisions]
 
312
        revisions = repository.get_revisions(revision_ids)
 
313
        if generate_delta:
 
314
            deltas = repository.get_deltas_for_revisions(revisions)
 
315
            cur_deltas = dict(izip((r.revision_id for r in revisions),
 
316
                                   deltas))
 
317
        for view_data, revision in izip(cur_view_revisions, revisions):
 
318
            yield view_data, revision, cur_deltas.get(revision.revision_id)
 
319
        num = min(int(num * 1.5), 200)
 
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
        raise BzrCommandError('Logging revision 0 is invalid.')
 
374
    if start_revno > end_revno:
 
375
        raise BzrCommandError("Start revision must be older than "
 
376
                              "the end revision.")
 
377
 
 
378
    # list indexes are 0-based; revisions are 1-based
 
379
    cut_revs = which_revs[(start_revno-1):(end_revno)]
 
380
    if not cut_revs:
 
381
        return None, None, None, None
 
382
 
 
383
    # convert the revision history to a dictionary:
 
384
    rev_nos = dict((k, v) for v, k in cut_revs)
 
385
 
 
386
    # override the mainline to look like the revision history.
 
387
    mainline_revs = [revision_id for index, revision_id in cut_revs]
 
388
    if cut_revs[0][0] == 1:
 
389
        mainline_revs.insert(0, None)
 
390
    else:
 
391
        mainline_revs.insert(0, which_revs[start_revno-2][1])
 
392
    return mainline_revs, rev_nos, start_rev_id, end_rev_id
 
393
 
 
394
 
 
395
def _filter_revision_range(view_revisions, start_rev_id, end_rev_id):
 
396
    """Filter view_revisions based on revision ranges.
 
397
 
 
398
    :param view_revisions: A list of (revision_id, dotted_revno, merge_depth) 
 
399
            tuples to be filtered.
 
400
 
 
401
    :param start_rev_id: If not NONE specifies the first revision to be logged.
 
402
            If NONE then all revisions up to the end_rev_id are logged.
 
403
 
 
404
    :param end_rev_id: If not NONE specifies the last revision to be logged.
 
405
            If NONE then all revisions up to the end of the log are logged.
 
406
 
 
407
    :return: The filtered view_revisions.
 
408
    """
 
409
    if start_rev_id or end_rev_id: 
 
410
        revision_ids = [r for r, n, d in view_revisions]
 
411
        if start_rev_id:
 
412
            start_index = revision_ids.index(start_rev_id)
 
413
        else:
 
414
            start_index = 0
 
415
        if start_rev_id == end_rev_id:
 
416
            end_index = start_index
 
417
        else:
 
418
            if end_rev_id:
 
419
                end_index = revision_ids.index(end_rev_id)
 
420
            else:
 
421
                end_index = len(view_revisions) - 1
 
422
        # To include the revisions merged into the last revision, 
 
423
        # extend end_rev_id down to, but not including, the next rev
 
424
        # with the same or lesser merge_depth
 
425
        end_merge_depth = view_revisions[end_index][2]
 
426
        try:
 
427
            for index in xrange(end_index+1, len(view_revisions)+1):
 
428
                if view_revisions[index][2] <= end_merge_depth:
 
429
                    end_index = index - 1
 
430
                    break
 
431
        except IndexError:
 
432
            # if the search falls off the end then log to the end as well
 
433
            end_index = len(view_revisions) - 1
 
434
        view_revisions = view_revisions[start_index:end_index+1]
 
435
    return view_revisions
 
436
 
 
437
 
 
438
def _filter_revisions_touching_file_id(branch, file_id, mainline_revisions,
 
439
                                       view_revs_iter):
 
440
    """Return the list of revision ids which touch a given file id.
 
441
 
 
442
    The function filters view_revisions and returns a subset.
 
443
    This includes the revisions which directly change the file id,
 
444
    and the revisions which merge these changes. So if the
 
445
    revision graph is::
 
446
        A
 
447
        |\
 
448
        B C
 
449
        |/
 
450
        D
 
451
 
 
452
    And 'C' changes a file, then both C and D will be returned.
 
453
 
 
454
    This will also can be restricted based on a subset of the mainline.
 
455
 
 
456
    :return: A list of (revision_id, dotted_revno, merge_depth) tuples.
 
457
    """
 
458
    # find all the revisions that change the specific file
 
459
    file_weave = branch.repository.weave_store.get_weave(file_id,
 
460
                branch.repository.get_transaction())
 
461
    weave_modifed_revisions = set(file_weave.versions())
 
462
    # build the ancestry of each revision in the graph
 
463
    # - only listing the ancestors that change the specific file.
 
464
    graph = branch.repository.get_graph()
 
465
    # This asks for all mainline revisions, which means we only have to spider
 
466
    # sideways, rather than depth history. That said, its still size-of-history
 
467
    # and should be addressed.
 
468
    parent_map = dict(((key, value) for key, value in
 
469
        graph.iter_ancestry(mainline_revisions) if value is not None))
 
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
    parent_map = dict(((key, value) for key, value in
 
520
        graph.iter_ancestry(mainline_revs) if value is not None))
 
521
    # filter out ghosts; merge_sort errors on ghosts.
 
522
    rev_graph = _strip_NULL_ghosts(parent_map)
 
523
    merge_sorted_revisions = merge_sort(
 
524
        rev_graph,
 
525
        mainline_revs[-1],
 
526
        mainline_revs,
 
527
        generate_revno=True)
 
528
 
 
529
    if direction == 'forward':
 
530
        # forward means oldest first.
 
531
        merge_sorted_revisions = reverse_by_depth(merge_sorted_revisions)
 
532
    elif direction != 'reverse':
 
533
        raise ValueError('invalid direction %r' % direction)
 
534
 
 
535
    for sequence, rev_id, merge_depth, revno, end_of_merge in merge_sorted_revisions:
 
536
        yield rev_id, '.'.join(map(str, revno)), merge_depth
 
537
 
 
538
 
 
539
def reverse_by_depth(merge_sorted_revisions, _depth=0):
 
540
    """Reverse revisions by depth.
 
541
 
 
542
    Revisions with a different depth are sorted as a group with the previous
 
543
    revision of that depth.  There may be no topological justification for this,
 
544
    but it looks much nicer.
 
545
    """
 
546
    zd_revisions = []
 
547
    for val in merge_sorted_revisions:
 
548
        if val[2] == _depth:
 
549
            zd_revisions.append([val])
 
550
        else:
 
551
            assert val[2] > _depth
 
552
            zd_revisions[-1].append(val)
 
553
    for revisions in zd_revisions:
 
554
        if len(revisions) > 1:
 
555
            revisions[1:] = reverse_by_depth(revisions[1:], _depth + 1)
 
556
    zd_revisions.reverse()
 
557
    result = []
 
558
    for chunk in zd_revisions:
 
559
        result.extend(chunk)
 
560
    return result
 
561
 
 
562
 
 
563
class LogRevision(object):
 
564
    """A revision to be logged (by LogFormatter.log_revision).
 
565
 
 
566
    A simple wrapper for the attributes of a revision to be logged.
 
567
    The attributes may or may not be populated, as determined by the 
 
568
    logging options and the log formatter capabilities.
 
569
    """
 
570
 
 
571
    def __init__(self, rev=None, revno=None, merge_depth=0, delta=None,
 
572
                 tags=None):
 
573
        self.rev = rev
 
574
        self.revno = revno
 
575
        self.merge_depth = merge_depth
 
576
        self.delta = delta
 
577
        self.tags = tags
 
578
 
 
579
 
 
580
class LogFormatter(object):
 
581
    """Abstract class to display log messages.
 
582
 
 
583
    At a minimum, a derived class must implement the log_revision method.
 
584
 
 
585
    If the LogFormatter needs to be informed of the beginning or end of
 
586
    a log it should implement the begin_log and/or end_log hook methods.
 
587
 
 
588
    A LogFormatter should define the following supports_XXX flags 
 
589
    to indicate which LogRevision attributes it supports:
 
590
 
 
591
    - supports_delta must be True if this log formatter supports delta.
 
592
        Otherwise the delta attribute may not be populated.
 
593
    - supports_merge_revisions must be True if this log formatter supports 
 
594
        merge revisions.  If not, and if supports_single_merge_revisions is
 
595
        also not True, then only mainline revisions will be passed to the 
 
596
        formatter.
 
597
    - supports_single_merge_revision must be True if this log formatter
 
598
        supports logging only a single merge revision.  This flag is
 
599
        only relevant if supports_merge_revisions is not True.
 
600
    - supports_tags must be True if this log formatter supports tags.
 
601
        Otherwise the tags attribute may not be populated.
 
602
 
 
603
    Plugins can register functions to show custom revision properties using
 
604
    the custom_properties_handler_registry. The registered function
 
605
    must respect the following interface description:
 
606
        def my_show_properties(properties_dict):
 
607
            # code that returns a dict {'name':'value'} of the properties 
 
608
            # to be shown
 
609
    """
 
610
 
 
611
    def __init__(self, to_file, show_ids=False, show_timezone='original'):
 
612
        self.to_file = to_file
 
613
        self.show_ids = show_ids
 
614
        self.show_timezone = show_timezone
 
615
 
 
616
# TODO: uncomment this block after show() has been removed.
 
617
# Until then defining log_revision would prevent _show_log calling show() 
 
618
# in legacy formatters.
 
619
#    def log_revision(self, revision):
 
620
#        """Log a revision.
 
621
#
 
622
#        :param  revision:   The LogRevision to be logged.
 
623
#        """
 
624
#        raise NotImplementedError('not implemented in abstract base')
 
625
 
 
626
    def short_committer(self, rev):
 
627
        name, address = config.parse_username(rev.committer)
 
628
        if name:
 
629
            return name
 
630
        return address
 
631
 
 
632
    def short_author(self, rev):
 
633
        name, address = config.parse_username(rev.get_apparent_author())
 
634
        if name:
 
635
            return name
 
636
        return address
 
637
 
 
638
    def show_properties(self, revision, indent):
 
639
        """Displays the custom properties returned by each registered handler.
 
640
        
 
641
        If a registered handler raises a error it is propagated.
 
642
        """
 
643
        for key, handler in properties_handler_registry.iteritems():
 
644
            for key, value in handler(revision).items():
 
645
                self.to_file.write(indent + key + ': ' + value + '\n')
 
646
 
 
647
 
 
648
class LongLogFormatter(LogFormatter):
 
649
 
 
650
    supports_merge_revisions = True
 
651
    supports_delta = True
 
652
    supports_tags = True
 
653
 
 
654
    def log_revision(self, revision):
 
655
        """Log a revision, either merged or not."""
 
656
        indent = '    ' * revision.merge_depth
 
657
        to_file = self.to_file
 
658
        to_file.write(indent + '-' * 60 + '\n')
 
659
        if revision.revno is not None:
 
660
            to_file.write(indent + 'revno: %s\n' % (revision.revno,))
 
661
        if revision.tags:
 
662
            to_file.write(indent + 'tags: %s\n' % (', '.join(revision.tags)))
 
663
        if self.show_ids:
 
664
            to_file.write(indent + 'revision-id: ' + revision.rev.revision_id)
 
665
            to_file.write('\n')
 
666
            for parent_id in revision.rev.parent_ids:
 
667
                to_file.write(indent + 'parent: %s\n' % (parent_id,))
 
668
        self.show_properties(revision.rev.properties, indent)
 
669
 
 
670
        author = revision.rev.properties.get('author', None)
 
671
        if author is not None:
 
672
            to_file.write(indent + 'author: %s\n' % (author,))
 
673
        to_file.write(indent + 'committer: %s\n' % (revision.rev.committer,))
 
674
 
 
675
        branch_nick = revision.rev.properties.get('branch-nick', None)
 
676
        if branch_nick is not None:
 
677
            to_file.write(indent + 'branch nick: %s\n' % (branch_nick,))
 
678
 
 
679
        date_str = format_date(revision.rev.timestamp,
 
680
                               revision.rev.timezone or 0,
 
681
                               self.show_timezone)
 
682
        to_file.write(indent + 'timestamp: %s\n' % (date_str,))
 
683
 
 
684
        to_file.write(indent + 'message:\n')
 
685
        if not revision.rev.message:
 
686
            to_file.write(indent + '  (no message)\n')
 
687
        else:
 
688
            message = revision.rev.message.rstrip('\r\n')
 
689
            for l in message.split('\n'):
 
690
                to_file.write(indent + '  %s\n' % (l,))
 
691
        if revision.delta is not None:
 
692
            revision.delta.show(to_file, self.show_ids, indent=indent)
 
693
 
 
694
 
 
695
class ShortLogFormatter(LogFormatter):
 
696
 
 
697
    supports_delta = True
 
698
    supports_single_merge_revision = True
 
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
    def log_revision(self, revision):
 
756
        self.to_file.write(self.log_string(revision.revno, revision.rev,
 
757
                                              self._max_chars))
 
758
        self.to_file.write('\n')
 
759
 
 
760
    def log_string(self, revno, rev, max_chars):
 
761
        """Format log info into one string. Truncate tail of string
 
762
        :param  revno:      revision number (int) or None.
 
763
                            Revision numbers counts from 1.
 
764
        :param  rev:        revision info object
 
765
        :param  max_chars:  maximum length of resulting string
 
766
        :return:            formatted truncated string
 
767
        """
 
768
        out = []
 
769
        if revno:
 
770
            # show revno only when is not None
 
771
            out.append("%s:" % revno)
 
772
        out.append(self.truncate(self.short_author(rev), 20))
 
773
        out.append(self.date_string(rev))
 
774
        out.append(rev.get_summary())
 
775
        return self.truncate(" ".join(out).rstrip('\n'), max_chars)
 
776
 
 
777
 
 
778
def line_log(rev, max_chars):
 
779
    lf = LineLogFormatter(None)
 
780
    return lf.log_string(None, rev, max_chars)
 
781
 
 
782
 
 
783
class LogFormatterRegistry(registry.Registry):
 
784
    """Registry for log formatters"""
 
785
 
 
786
    def make_formatter(self, name, *args, **kwargs):
 
787
        """Construct a formatter from arguments.
 
788
 
 
789
        :param name: Name of the formatter to construct.  'short', 'long' and
 
790
            'line' are built-in.
 
791
        """
 
792
        return self.get(name)(*args, **kwargs)
 
793
 
 
794
    def get_default(self, branch):
 
795
        return self.get(branch.get_config().log_format())
 
796
 
 
797
 
 
798
log_formatter_registry = LogFormatterRegistry()
 
799
 
 
800
 
 
801
log_formatter_registry.register('short', ShortLogFormatter,
 
802
                                'Moderately short log format')
 
803
log_formatter_registry.register('long', LongLogFormatter,
 
804
                                'Detailed log format')
 
805
log_formatter_registry.register('line', LineLogFormatter,
 
806
                                'Log format with one line per revision')
 
807
 
 
808
 
 
809
def register_formatter(name, formatter):
 
810
    log_formatter_registry.register(name, formatter)
 
811
 
 
812
 
 
813
def log_formatter(name, *args, **kwargs):
 
814
    """Construct a formatter from arguments.
 
815
 
 
816
    name -- Name of the formatter to construct; currently 'long', 'short' and
 
817
        'line' are supported.
 
818
    """
 
819
    try:
 
820
        return log_formatter_registry.make_formatter(name, *args, **kwargs)
 
821
    except KeyError:
 
822
        raise BzrCommandError("unknown log formatter: %r" % name)
 
823
 
 
824
 
 
825
def show_one_log(revno, rev, delta, verbose, to_file, show_timezone):
 
826
    # deprecated; for compatibility
 
827
    lf = LongLogFormatter(to_file=to_file, show_timezone=show_timezone)
 
828
    lf.show(revno, rev, delta)
 
829
 
 
830
 
 
831
def show_changed_revisions(branch, old_rh, new_rh, to_file=None,
 
832
                           log_format='long'):
 
833
    """Show the change in revision history comparing the old revision history to the new one.
 
834
 
 
835
    :param branch: The branch where the revisions exist
 
836
    :param old_rh: The old revision history
 
837
    :param new_rh: The new revision history
 
838
    :param to_file: A file to write the results to. If None, stdout will be used
 
839
    """
 
840
    if to_file is None:
 
841
        to_file = codecs.getwriter(get_terminal_encoding())(sys.stdout,
 
842
            errors='replace')
 
843
    lf = log_formatter(log_format,
 
844
                       show_ids=False,
 
845
                       to_file=to_file,
 
846
                       show_timezone='original')
 
847
 
 
848
    # This is the first index which is different between
 
849
    # old and new
 
850
    base_idx = None
 
851
    for i in xrange(max(len(new_rh),
 
852
                        len(old_rh))):
 
853
        if (len(new_rh) <= i
 
854
            or len(old_rh) <= i
 
855
            or new_rh[i] != old_rh[i]):
 
856
            base_idx = i
 
857
            break
 
858
 
 
859
    if base_idx is None:
 
860
        to_file.write('Nothing seems to have changed\n')
 
861
        return
 
862
    ## TODO: It might be nice to do something like show_log
 
863
    ##       and show the merged entries. But since this is the
 
864
    ##       removed revisions, it shouldn't be as important
 
865
    if base_idx < len(old_rh):
 
866
        to_file.write('*'*60)
 
867
        to_file.write('\nRemoved Revisions:\n')
 
868
        for i in range(base_idx, len(old_rh)):
 
869
            rev = branch.repository.get_revision(old_rh[i])
 
870
            lr = LogRevision(rev, i+1, 0, None)
 
871
            lf.log_revision(lr)
 
872
        to_file.write('*'*60)
 
873
        to_file.write('\n\n')
 
874
    if base_idx < len(new_rh):
 
875
        to_file.write('Added Revisions:\n')
 
876
        show_log(branch,
 
877
                 lf,
 
878
                 None,
 
879
                 verbose=False,
 
880
                 direction='forward',
 
881
                 start_revision=base_idx+1,
 
882
                 end_revision=len(new_rh),
 
883
                 search=None)
 
884
 
 
885
 
 
886
properties_handler_registry = registry.Registry()