~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/log.py

  • Committer: Martin Pool
  • Date: 2005-07-11 07:05:34 UTC
  • Revision ID: mbp@sourcefrog.net-20050711070534-5227696ab167ccde
- merge aaron's append_multiple.patch

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005, 2006, 2007 Canonical Ltd
2
 
#
 
1
# Copyright (C) 2005 Canonical Ltd
 
2
 
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
5
5
# the Free Software Foundation; either version 2 of the License, or
6
6
# (at your option) any later version.
7
 
#
 
7
 
8
8
# This program is distributed in the hope that it will be useful,
9
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11
11
# GNU General Public License for more details.
12
 
#
 
12
 
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
28
28
 
29
29
* with file-ids and revision-ids shown
30
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.
 
31
* from last to first or (not anymore) from first to last;
 
32
  the default is "reversed" because it shows the likely most
 
33
  relevant and interesting information first
 
34
 
 
35
* (not yet) in XML format
50
36
"""
51
37
 
52
 
import codecs
53
 
from cStringIO import StringIO
54
 
from itertools import (
55
 
    chain,
56
 
    izip,
57
 
    )
58
 
import re
59
 
import sys
60
 
from warnings import (
61
 
    warn,
62
 
    )
63
 
 
64
 
from bzrlib.lazy_import import lazy_import
65
 
lazy_import(globals(), """
66
 
 
67
 
from bzrlib import (
68
 
    config,
69
 
    diff,
70
 
    errors,
71
 
    repository as _mod_repository,
72
 
    revision as _mod_revision,
73
 
    revisionspec,
74
 
    trace,
75
 
    tsort,
76
 
    )
77
 
""")
78
 
 
79
 
from bzrlib import (
80
 
    registry,
81
 
    )
82
 
from bzrlib.osutils import (
83
 
    format_date,
84
 
    get_terminal_encoding,
85
 
    terminal_width,
86
 
    )
87
 
 
 
38
 
 
39
from trace import mutter
88
40
 
89
41
def find_touching_revisions(branch, file_id):
90
42
    """Yield a description of revisions which affect the file_id.
101
53
    last_path = None
102
54
    revno = 1
103
55
    for revision_id in branch.revision_history():
104
 
        this_inv = branch.repository.get_revision_inventory(revision_id)
 
56
        this_inv = branch.get_revision_inventory(revision_id)
105
57
        if file_id in this_inv:
106
58
            this_ie = this_inv[file_id]
107
59
            this_path = this_inv.id2path(file_id)
130
82
        revno += 1
131
83
 
132
84
 
133
 
def _enumerate_history(branch):
134
 
    rh = []
135
 
    revno = 1
136
 
    for rev_id in branch.revision_history():
137
 
        rh.append((revno, rev_id))
138
 
        revno += 1
139
 
    return rh
140
 
 
141
85
 
142
86
def show_log(branch,
143
87
             lf,
146
90
             direction='reverse',
147
91
             start_revision=None,
148
92
             end_revision=None,
149
 
             search=None,
150
 
             limit=None,
151
 
             show_diff=False):
 
93
             search=None):
152
94
    """Write out human-readable log of commits to this branch.
153
95
 
154
 
    :param lf: The LogFormatter object showing the output.
155
 
 
156
 
    :param specific_fileid: If not None, list only the commits affecting the
157
 
        specified file, rather than all commits.
158
 
 
159
 
    :param verbose: If True show added/changed/deleted/renamed files.
160
 
 
161
 
    :param direction: 'reverse' (default) is latest to earliest; 'forward' is
162
 
        earliest to latest.
163
 
 
164
 
    :param start_revision: If not None, only show revisions >= start_revision
165
 
 
166
 
    :param end_revision: If not None, only show revisions <= end_revision
167
 
 
168
 
    :param search: If not None, only show revisions with matching commit
169
 
        messages
170
 
 
171
 
    :param limit: If set, shows only 'limit' revisions, all revisions are shown
172
 
        if None or 0.
173
 
 
174
 
    :param show_diff: If True, output a diff after each revision.
 
96
    lf
 
97
        LogFormatter object to show the output.
 
98
 
 
99
    specific_fileid
 
100
        If true, list only the commits affecting the specified
 
101
        file, rather than all commits.
 
102
 
 
103
    verbose
 
104
        If true show added/changed/deleted/renamed files.
 
105
 
 
106
    direction
 
107
        'reverse' (default) is latest to earliest;
 
108
        'forward' is earliest to latest.
 
109
 
 
110
    start_revision
 
111
        If not None, only show revisions >= start_revision
 
112
 
 
113
    end_revision
 
114
        If not None, only show revisions <= end_revision
175
115
    """
176
 
    branch.lock_read()
177
 
    try:
178
 
        if getattr(lf, 'begin_log', None):
179
 
            lf.begin_log()
180
 
 
181
 
        _show_log(branch, lf, specific_fileid, verbose, direction,
182
 
                  start_revision, end_revision, search, limit, show_diff)
183
 
 
184
 
        if getattr(lf, 'end_log', None):
185
 
            lf.end_log()
186
 
    finally:
187
 
        branch.unlock()
188
 
 
189
 
 
190
 
def _show_log(branch,
191
 
             lf,
192
 
             specific_fileid=None,
193
 
             verbose=False,
194
 
             direction='reverse',
195
 
             start_revision=None,
196
 
             end_revision=None,
197
 
             search=None,
198
 
             limit=None,
199
 
             show_diff=False):
200
 
    """Worker function for show_log - see show_log."""
 
116
    from bzrlib.osutils import format_date
 
117
    from bzrlib.errors import BzrCheckError
 
118
    from bzrlib.textui import show_status
 
119
    
 
120
    from warnings import warn
 
121
 
201
122
    if not isinstance(lf, LogFormatter):
202
123
        warn("not a LogFormatter instance: %r" % lf)
 
124
 
203
125
    if specific_fileid:
204
 
        trace.mutter('get log for file_id %r', specific_fileid)
 
126
        mutter('get log for file_id %r' % specific_fileid)
205
127
 
206
 
    # Consult the LogFormatter about what it needs and can handle
207
 
    levels_to_display = lf.get_levels()
208
 
    generate_merge_revisions = levels_to_display != 1
209
 
    allow_single_merge_revision = True
210
 
    if not getattr(lf, 'supports_merge_revisions', False):
211
 
        allow_single_merge_revision = getattr(lf,
212
 
            'supports_single_merge_revision', False)
213
 
    generate_tags = getattr(lf, 'supports_tags', False)
214
 
    if generate_tags and branch.supports_tags():
215
 
        rev_tag_dict = branch.tags.get_reverse_tag_dict()
 
128
    if search is not None:
 
129
        import re
 
130
        searchRE = re.compile(search, re.IGNORECASE)
216
131
    else:
217
 
        rev_tag_dict = {}
218
 
    generate_delta = verbose and getattr(lf, 'supports_delta', False)
219
 
    generate_diff = show_diff and getattr(lf, 'supports_diff', False)
220
 
 
221
 
    # Find and print the interesting revisions
222
 
    repo = branch.repository
223
 
    log_count = 0
224
 
    revision_iterator = _create_log_revision_iterator(branch,
225
 
        start_revision, end_revision, direction, specific_fileid, search,
226
 
        generate_merge_revisions, allow_single_merge_revision,
227
 
        generate_delta, limited_output=limit > 0)
228
 
    for revs in revision_iterator:
229
 
        for (rev_id, revno, merge_depth), rev, delta in revs:
230
 
            # Note: 0 levels means show everything; merge_depth counts from 0
231
 
            if levels_to_display != 0 and merge_depth >= levels_to_display:
 
132
        searchRE = None
 
133
 
 
134
    which_revs = branch.enum_history(direction)
 
135
    which_revs = [x for x in which_revs if (
 
136
            (start_revision is None or x[0] >= start_revision)
 
137
            and (end_revision is None or x[0] <= end_revision))]
 
138
 
 
139
    if not (verbose or specific_fileid):
 
140
        # no need to know what changed between revisions
 
141
        with_deltas = deltas_for_log_dummy(branch, which_revs)
 
142
    elif direction == 'reverse':
 
143
        with_deltas = deltas_for_log_reverse(branch, which_revs)
 
144
    else:        
 
145
        with_deltas = deltas_for_log_forward(branch, which_revs)
 
146
 
 
147
    for revno, rev, delta in with_deltas:
 
148
        if specific_fileid:
 
149
            if not delta.touches_file_id(specific_fileid):
232
150
                continue
233
 
            if generate_diff:
234
 
                diff = _format_diff(repo, rev, rev_id, specific_fileid)
235
 
            else:
236
 
                diff = None
237
 
            lr = LogRevision(rev, revno, merge_depth, delta,
238
 
                             rev_tag_dict.get(rev_id), diff)
239
 
            lf.log_revision(lr)
240
 
            if limit:
241
 
                log_count += 1
242
 
                if log_count >= limit:
243
 
                    return
244
 
 
245
 
 
246
 
def _format_diff(repo, rev, rev_id, specific_fileid):
247
 
    if len(rev.parent_ids) == 0:
248
 
        ancestor_id = _mod_revision.NULL_REVISION
249
 
    else:
250
 
        ancestor_id = rev.parent_ids[0]
251
 
    tree_1 = repo.revision_tree(ancestor_id)
252
 
    tree_2 = repo.revision_tree(rev_id)
253
 
    if specific_fileid:
254
 
        specific_files = [tree_2.id2path(specific_fileid)]
255
 
    else:
256
 
        specific_files = None
257
 
    s = StringIO()
258
 
    diff.show_diff_trees(tree_1, tree_2, s, specific_files, old_label='',
259
 
        new_label='')
260
 
    return s.getvalue()
261
 
 
262
 
 
263
 
class _StartNotLinearAncestor(Exception):
264
 
    """Raised when a start revision is not found walking left-hand history."""
265
 
 
266
 
 
267
 
def _create_log_revision_iterator(branch, start_revision, end_revision,
268
 
    direction, specific_fileid, search, generate_merge_revisions,
269
 
    allow_single_merge_revision, generate_delta, limited_output=False):
270
 
    """Create a revision iterator for log.
271
 
 
272
 
    :param branch: The branch being logged.
273
 
    :param start_revision: If not None, only show revisions >= start_revision
274
 
    :param end_revision: If not None, only show revisions <= end_revision
275
 
    :param direction: 'reverse' (default) is latest to earliest; 'forward' is
276
 
        earliest to latest.
277
 
    :param specific_fileid: If not None, list only the commits affecting the
278
 
        specified file.
279
 
    :param search: If not None, only show revisions with matching commit
280
 
        messages.
281
 
    :param generate_merge_revisions: If False, show only mainline revisions.
282
 
    :param allow_single_merge_revision: If True, logging of a single
283
 
        revision off the mainline is to be allowed
284
 
    :param generate_delta: Whether to generate a delta for each revision.
285
 
    :param limited_output: if True, the user only wants a limited result
286
 
 
287
 
    :return: An iterator over lists of ((rev_id, revno, merge_depth), rev,
288
 
        delta).
289
 
    """
290
 
    start_rev_id, end_rev_id = _get_revision_limits(branch, start_revision,
291
 
        end_revision)
292
 
 
293
 
    # Decide how file-ids are matched: delta-filtering vs per-file graph.
294
 
    # Delta filtering allows revisions to be displayed incrementally
295
 
    # though the total time is much slower for huge repositories: log -v
296
 
    # is the *lower* performance bound. At least until the split
297
 
    # inventory format arrives, per-file-graph needs to remain the
298
 
    # default except in verbose mode. Delta filtering should give more
299
 
    # accurate results (e.g. inclusion of FILE deletions) so arguably
300
 
    # it should always be used in the future.
301
 
    use_deltas_for_matching = specific_fileid and generate_delta
302
 
    delayed_graph_generation = not specific_fileid and (
303
 
            start_rev_id or end_rev_id or limited_output)
304
 
    generate_merges = generate_merge_revisions or (specific_fileid and
305
 
        not use_deltas_for_matching)
306
 
    view_revisions = _calc_view_revisions(branch, start_rev_id, end_rev_id,
307
 
        direction, generate_merges, allow_single_merge_revision,
308
 
        delayed_graph_generation=delayed_graph_generation)
309
 
    search_deltas_for_fileids = None
310
 
    if use_deltas_for_matching:
311
 
        search_deltas_for_fileids = set([specific_fileid])
312
 
    elif specific_fileid:
313
 
        if not isinstance(view_revisions, list):
314
 
            view_revisions = list(view_revisions)
315
 
        view_revisions = _filter_revisions_touching_file_id(branch,
316
 
            specific_fileid, view_revisions,
317
 
            include_merges=generate_merge_revisions)
318
 
    return make_log_rev_iterator(branch, view_revisions, generate_delta,
319
 
        search, file_ids=search_deltas_for_fileids, direction=direction)
320
 
 
321
 
 
322
 
def _calc_view_revisions(branch, start_rev_id, end_rev_id, direction,
323
 
    generate_merge_revisions, allow_single_merge_revision,
324
 
    delayed_graph_generation=False):
325
 
    """Calculate the revisions to view.
326
 
 
327
 
    :return: An iterator of (revision_id, dotted_revno, merge_depth) tuples OR
328
 
             a list of the same tuples.
329
 
    """
330
 
    br_revno, br_rev_id = branch.last_revision_info()
331
 
    if br_revno == 0:
332
 
        return []
333
 
 
334
 
    # If a single revision is requested, check we can handle it
335
 
    generate_single_revision = (end_rev_id and start_rev_id == end_rev_id and
336
 
        (not generate_merge_revisions or not _has_merges(branch, end_rev_id)))
337
 
    if generate_single_revision:
338
 
        if end_rev_id == br_rev_id:
339
 
            # It's the tip
340
 
            return [(br_rev_id, br_revno, 0)]
341
 
        else:
342
 
            revno = branch.revision_id_to_dotted_revno(end_rev_id)
343
 
            if len(revno) > 1 and not allow_single_merge_revision:
344
 
                # It's a merge revision and the log formatter is
345
 
                # completely brain dead. This "feature" of allowing
346
 
                # log formatters incapable of displaying dotted revnos
347
 
                # ought to be deprecated IMNSHO. IGC 20091022
348
 
                raise errors.BzrCommandError('Selected log formatter only'
349
 
                    ' supports mainline revisions.')
350
 
            revno_str = '.'.join(str(n) for n in revno)
351
 
            return [(end_rev_id, revno_str, 0)]
352
 
 
353
 
    # If we only want to see linear revisions, we can iterate ...
354
 
    if not generate_merge_revisions:
355
 
        result = _linear_view_revisions(branch, start_rev_id, end_rev_id)
356
 
        # If a start limit was given and it's not obviously an
357
 
        # ancestor of the end limit, check it before outputting anything
358
 
        if direction == 'forward' or (start_rev_id
359
 
            and not _is_obvious_ancestor(branch, start_rev_id, end_rev_id)):
360
 
            try:
361
 
                result = list(result)
362
 
            except _StartNotLinearAncestor:
363
 
                raise errors.BzrCommandError('Start revision not found in'
364
 
                    ' left-hand history of end revision.')
365
 
        if direction == 'forward':
366
 
            result = reversed(list(result))
367
 
        return result
368
 
 
369
 
    # On large trees, generating the merge graph can take 30-60 seconds
370
 
    # so we delay doing it until a merge is detected, incrementally
371
 
    # returning initial (non-merge) revisions while we can.
372
 
    initial_revisions = []
373
 
    if delayed_graph_generation:
374
 
        try:
375
 
            for rev_id, revno, depth in \
376
 
                _linear_view_revisions(branch, start_rev_id, end_rev_id):
377
 
                if _has_merges(branch, rev_id):
378
 
                    end_rev_id = rev_id
379
 
                    break
380
 
                else:
381
 
                    initial_revisions.append((rev_id, revno, depth))
382
 
            else:
383
 
                # No merged revisions found
384
 
                if direction == 'reverse':
385
 
                    return initial_revisions
386
 
                elif direction == 'forward':
387
 
                    return reversed(initial_revisions)
388
 
                else:
389
 
                    raise ValueError('invalid direction %r' % direction)
390
 
        except _StartNotLinearAncestor:
391
 
            # A merge was never detected so the lower revision limit can't
392
 
            # be nested down somewhere
393
 
            raise errors.BzrCommandError('Start revision not found in'
394
 
                ' history of end revision.')
395
 
 
396
 
    # A log including nested merges is required. If the direction is reverse,
397
 
    # we rebase the initial merge depths so that the development line is
398
 
    # shown naturally, i.e. just like it is for linear logging. We can easily
399
 
    # make forward the exact opposite display, but showing the merge revisions
400
 
    # indented at the end seems slightly nicer in that case.
401
 
    view_revisions = chain(iter(initial_revisions),
402
 
        _graph_view_revisions(branch, start_rev_id, end_rev_id,
403
 
        rebase_initial_depths=direction == 'reverse'))
404
 
    if direction == 'reverse':
405
 
        return view_revisions
406
 
    elif direction == 'forward':
407
 
        # Forward means oldest first, adjusting for depth.
408
 
        view_revisions = reverse_by_depth(list(view_revisions))
409
 
        return _rebase_merge_depth(view_revisions)
410
 
    else:
411
 
        raise ValueError('invalid direction %r' % direction)
412
 
 
413
 
 
414
 
def _has_merges(branch, rev_id):
415
 
    """Does a revision have multiple parents or not?"""
416
 
    parents = branch.repository.get_parent_map([rev_id]).get(rev_id, [])
417
 
    return len(parents) > 1
418
 
 
419
 
 
420
 
def _is_obvious_ancestor(branch, start_rev_id, end_rev_id):
421
 
    """Is start_rev_id an obvious ancestor of end_rev_id?"""
422
 
    if start_rev_id and end_rev_id:
423
 
        start_dotted = branch.revision_id_to_dotted_revno(start_rev_id)
424
 
        end_dotted = branch.revision_id_to_dotted_revno(end_rev_id)
425
 
        if len(start_dotted) == 1 and len(end_dotted) == 1:
426
 
            # both on mainline
427
 
            return start_dotted[0] <= end_dotted[0]
428
 
        elif (len(start_dotted) == 3 and len(end_dotted) == 3 and
429
 
            start_dotted[0:1] == end_dotted[0:1]):
430
 
            # both on same development line
431
 
            return start_dotted[2] <= end_dotted[2]
432
 
        else:
433
 
            # not obvious
434
 
            return False
435
 
    return True
436
 
 
437
 
 
438
 
def _linear_view_revisions(branch, start_rev_id, end_rev_id):
439
 
    """Calculate a sequence of revisions to view, newest to oldest.
440
 
 
441
 
    :param start_rev_id: the lower revision-id
442
 
    :param end_rev_id: the upper revision-id
443
 
    :return: An iterator of (revision_id, dotted_revno, merge_depth) tuples.
444
 
    :raises _StartNotLinearAncestor: if a start_rev_id is specified but
445
 
      is not found walking the left-hand history
446
 
    """
447
 
    br_revno, br_rev_id = branch.last_revision_info()
448
 
    repo = branch.repository
449
 
    if start_rev_id is None and end_rev_id is None:
450
 
        cur_revno = br_revno
451
 
        for revision_id in repo.iter_reverse_revision_history(br_rev_id):
452
 
            yield revision_id, str(cur_revno), 0
453
 
            cur_revno -= 1
454
 
    else:
455
 
        if end_rev_id is None:
456
 
            end_rev_id = br_rev_id
457
 
        found_start = start_rev_id is None
458
 
        for revision_id in repo.iter_reverse_revision_history(end_rev_id):
459
 
            revno = branch.revision_id_to_dotted_revno(revision_id)
460
 
            revno_str = '.'.join(str(n) for n in revno)
461
 
            if not found_start and revision_id == start_rev_id:
462
 
                yield revision_id, revno_str, 0
463
 
                found_start = True
464
 
                break
465
 
            else:
466
 
                yield revision_id, revno_str, 0
467
 
        else:
468
 
            if not found_start:
469
 
                raise _StartNotLinearAncestor()
470
 
 
471
 
 
472
 
def _graph_view_revisions(branch, start_rev_id, end_rev_id,
473
 
    rebase_initial_depths=True):
474
 
    """Calculate revisions to view including merges, newest to oldest.
475
 
 
476
 
    :param branch: the branch
477
 
    :param start_rev_id: the lower revision-id
478
 
    :param end_rev_id: the upper revision-id
479
 
    :param rebase_initial_depth: should depths be rebased until a mainline
480
 
      revision is found?
481
 
    :return: An iterator of (revision_id, dotted_revno, merge_depth) tuples.
482
 
    """
483
 
    view_revisions = branch.iter_merge_sorted_revisions(
484
 
        start_revision_id=end_rev_id, stop_revision_id=start_rev_id,
485
 
        stop_rule="with-merges")
486
 
    if not rebase_initial_depths:
487
 
        for (rev_id, merge_depth, revno, end_of_merge
488
 
             ) in view_revisions:
489
 
            yield rev_id, '.'.join(map(str, revno)), merge_depth
490
 
    else:
491
 
        # We're following a development line starting at a merged revision.
492
 
        # We need to adjust depths down by the initial depth until we find
493
 
        # a depth less than it. Then we use that depth as the adjustment.
494
 
        # If and when we reach the mainline, depth adjustment ends.
495
 
        depth_adjustment = None
496
 
        for (rev_id, merge_depth, revno, end_of_merge
497
 
             ) in view_revisions:
498
 
            if depth_adjustment is None:
499
 
                depth_adjustment = merge_depth
500
 
            if depth_adjustment:
501
 
                if merge_depth < depth_adjustment:
502
 
                    depth_adjustment = merge_depth
503
 
                merge_depth -= depth_adjustment
504
 
            yield rev_id, '.'.join(map(str, revno)), merge_depth
505
 
 
506
 
 
507
 
def calculate_view_revisions(branch, start_revision, end_revision, direction,
508
 
        specific_fileid, generate_merge_revisions, allow_single_merge_revision):
509
 
    """Calculate the revisions to view.
510
 
 
511
 
    :return: An iterator of (revision_id, dotted_revno, merge_depth) tuples OR
512
 
             a list of the same tuples.
513
 
    """
514
 
    # This method is no longer called by the main code path.
515
 
    # It is retained for API compatibility and may be deprecated
516
 
    # soon. IGC 20090116
517
 
    start_rev_id, end_rev_id = _get_revision_limits(branch, start_revision,
518
 
        end_revision)
519
 
    view_revisions = list(_calc_view_revisions(branch, start_rev_id, end_rev_id,
520
 
        direction, generate_merge_revisions or specific_fileid,
521
 
        allow_single_merge_revision))
522
 
    if specific_fileid:
523
 
        view_revisions = _filter_revisions_touching_file_id(branch,
524
 
            specific_fileid, view_revisions,
525
 
            include_merges=generate_merge_revisions)
526
 
    return _rebase_merge_depth(view_revisions)
527
 
 
528
 
 
529
 
def _rebase_merge_depth(view_revisions):
530
 
    """Adjust depths upwards so the top level is 0."""
531
 
    # If either the first or last revision have a merge_depth of 0, we're done
532
 
    if view_revisions and view_revisions[0][2] and view_revisions[-1][2]:
533
 
        min_depth = min([d for r,n,d in view_revisions])
534
 
        if min_depth != 0:
535
 
            view_revisions = [(r,n,d-min_depth) for r,n,d in view_revisions]
536
 
    return view_revisions
537
 
 
538
 
 
539
 
def make_log_rev_iterator(branch, view_revisions, generate_delta, search,
540
 
        file_ids=None, direction='reverse'):
541
 
    """Create a revision iterator for log.
542
 
 
543
 
    :param branch: The branch being logged.
544
 
    :param view_revisions: The revisions being viewed.
545
 
    :param generate_delta: Whether to generate a delta for each revision.
546
 
    :param search: A user text search string.
547
 
    :param file_ids: If non empty, only revisions matching one or more of
548
 
      the file-ids are to be kept.
549
 
    :param direction: the direction in which view_revisions is sorted
550
 
    :return: An iterator over lists of ((rev_id, revno, merge_depth), rev,
551
 
        delta).
552
 
    """
553
 
    # Convert view_revisions into (view, None, None) groups to fit with
554
 
    # the standard interface here.
555
 
    if type(view_revisions) == list:
556
 
        # A single batch conversion is faster than many incremental ones.
557
 
        # As we have all the data, do a batch conversion.
558
 
        nones = [None] * len(view_revisions)
559
 
        log_rev_iterator = iter([zip(view_revisions, nones, nones)])
560
 
    else:
561
 
        def _convert():
562
 
            for view in view_revisions:
563
 
                yield (view, None, None)
564
 
        log_rev_iterator = iter([_convert()])
565
 
    for adapter in log_adapters:
566
 
        # It would be nicer if log adapters were first class objects
567
 
        # with custom parameters. This will do for now. IGC 20090127
568
 
        if adapter == _make_delta_filter:
569
 
            log_rev_iterator = adapter(branch, generate_delta,
570
 
                search, log_rev_iterator, file_ids, direction)
571
 
        else:
572
 
            log_rev_iterator = adapter(branch, generate_delta,
573
 
                search, log_rev_iterator)
574
 
    return log_rev_iterator
575
 
 
576
 
 
577
 
def _make_search_filter(branch, generate_delta, search, log_rev_iterator):
578
 
    """Create a filtered iterator of log_rev_iterator matching on a regex.
579
 
 
580
 
    :param branch: The branch being logged.
581
 
    :param generate_delta: Whether to generate a delta for each revision.
582
 
    :param search: A user text search string.
583
 
    :param log_rev_iterator: An input iterator containing all revisions that
584
 
        could be displayed, in lists.
585
 
    :return: An iterator over lists of ((rev_id, revno, merge_depth), rev,
586
 
        delta).
587
 
    """
588
 
    if search is None:
589
 
        return log_rev_iterator
590
 
    # Compile the search now to get early errors.
591
 
    searchRE = re.compile(search, re.IGNORECASE)
592
 
    return _filter_message_re(searchRE, log_rev_iterator)
593
 
 
594
 
 
595
 
def _filter_message_re(searchRE, log_rev_iterator):
596
 
    for revs in log_rev_iterator:
597
 
        new_revs = []
598
 
        for (rev_id, revno, merge_depth), rev, delta in revs:
599
 
            if searchRE.search(rev.message):
600
 
                new_revs.append(((rev_id, revno, merge_depth), rev, delta))
601
 
        yield new_revs
602
 
 
603
 
 
604
 
def _make_delta_filter(branch, generate_delta, search, log_rev_iterator,
605
 
    fileids=None, direction='reverse'):
606
 
    """Add revision deltas to a log iterator if needed.
607
 
 
608
 
    :param branch: The branch being logged.
609
 
    :param generate_delta: Whether to generate a delta for each revision.
610
 
    :param search: A user text search string.
611
 
    :param log_rev_iterator: An input iterator containing all revisions that
612
 
        could be displayed, in lists.
613
 
    :param fileids: If non empty, only revisions matching one or more of
614
 
      the file-ids are to be kept.
615
 
    :param direction: the direction in which view_revisions is sorted
616
 
    :return: An iterator over lists of ((rev_id, revno, merge_depth), rev,
617
 
        delta).
618
 
    """
619
 
    if not generate_delta and not fileids:
620
 
        return log_rev_iterator
621
 
    return _generate_deltas(branch.repository, log_rev_iterator,
622
 
        generate_delta, fileids, direction)
623
 
 
624
 
 
625
 
def _generate_deltas(repository, log_rev_iterator, always_delta, fileids,
626
 
    direction):
627
 
    """Create deltas for each batch of revisions in log_rev_iterator.
628
 
    
629
 
    If we're only generating deltas for the sake of filtering against
630
 
    file-ids, we stop generating deltas once all file-ids reach the
631
 
    appropriate life-cycle point. If we're receiving data newest to
632
 
    oldest, then that life-cycle point is 'add', otherwise it's 'remove'.
633
 
    """
634
 
    check_fileids = fileids is not None and len(fileids) > 0
635
 
    if check_fileids:
636
 
        fileid_set = set(fileids)
637
 
        if direction == 'reverse':
638
 
            stop_on = 'add'
639
 
        else:
640
 
            stop_on = 'remove'
641
 
    else:
642
 
        fileid_set = None
643
 
    for revs in log_rev_iterator:
644
 
        # If we were matching against fileids and we've run out,
645
 
        # there's nothing left to do
646
 
        if check_fileids and not fileid_set:
647
 
            return
648
 
        revisions = [rev[1] for rev in revs]
649
 
        deltas = repository.get_deltas_for_revisions(revisions)
650
 
        new_revs = []
651
 
        for rev, delta in izip(revs, deltas):
652
 
            if check_fileids:
653
 
                if not _delta_matches_fileids(delta, fileid_set, stop_on):
654
 
                    continue
655
 
                elif not always_delta:
656
 
                    # Delta was created just for matching - ditch it
657
 
                    # Note: It would probably be a better UI to return
658
 
                    # a delta filtered by the file-ids, rather than
659
 
                    # None at all. That functional enhancement can
660
 
                    # come later ...
661
 
                    delta = None
662
 
            new_revs.append((rev[0], rev[1], delta))
663
 
        yield new_revs
664
 
 
665
 
 
666
 
def _delta_matches_fileids(delta, fileids, stop_on='add'):
667
 
    """Check is a delta matches one of more file-ids.
668
 
    
669
 
    :param fileids: a set of fileids to match against.
670
 
    :param stop_on: either 'add' or 'remove' - take file-ids out of the
671
 
      fileids set once their add or remove entry is detected respectively
672
 
    """
673
 
    if not fileids:
674
 
        return False
675
 
    result = False
676
 
    for item in delta.added:
677
 
        if item[1] in fileids:
678
 
            if stop_on == 'add':
679
 
                fileids.remove(item[1])
680
 
            result = True
681
 
    for item in delta.removed:
682
 
        if item[1] in fileids:
683
 
            if stop_on == 'delete':
684
 
                fileids.remove(item[1])
685
 
            result = True
686
 
    if result:
687
 
        return True
688
 
    for l in (delta.modified, delta.renamed, delta.kind_changed):
689
 
        for item in l:
690
 
            if item[1] in fileids:
691
 
                return True
692
 
    return False
693
 
 
694
 
 
695
 
def _make_revision_objects(branch, generate_delta, search, log_rev_iterator):
696
 
    """Extract revision objects from the repository
697
 
 
698
 
    :param branch: The branch being logged.
699
 
    :param generate_delta: Whether to generate a delta for each revision.
700
 
    :param search: A user text search string.
701
 
    :param log_rev_iterator: An input iterator containing all revisions that
702
 
        could be displayed, in lists.
703
 
    :return: An iterator over lists of ((rev_id, revno, merge_depth), rev,
704
 
        delta).
705
 
    """
706
 
    repository = branch.repository
707
 
    for revs in log_rev_iterator:
708
 
        # r = revision_id, n = revno, d = merge depth
709
 
        revision_ids = [view[0] for view, _, _ in revs]
710
 
        revisions = repository.get_revisions(revision_ids)
711
 
        revs = [(rev[0], revision, rev[2]) for rev, revision in
712
 
            izip(revs, revisions)]
713
 
        yield revs
714
 
 
715
 
 
716
 
def _make_batch_filter(branch, generate_delta, search, log_rev_iterator):
717
 
    """Group up a single large batch into smaller ones.
718
 
 
719
 
    :param branch: The branch being logged.
720
 
    :param generate_delta: Whether to generate a delta for each revision.
721
 
    :param search: A user text search string.
722
 
    :param log_rev_iterator: An input iterator containing all revisions that
723
 
        could be displayed, in lists.
724
 
    :return: An iterator over lists of ((rev_id, revno, merge_depth), rev,
725
 
        delta).
726
 
    """
727
 
    repository = branch.repository
728
 
    num = 9
729
 
    for batch in log_rev_iterator:
730
 
        batch = iter(batch)
731
 
        while True:
732
 
            step = [detail for _, detail in zip(range(num), batch)]
733
 
            if len(step) == 0:
734
 
                break
735
 
            yield step
736
 
            num = min(int(num * 1.5), 200)
737
 
 
738
 
 
739
 
def _get_revision_limits(branch, start_revision, end_revision):
740
 
    """Get and check revision limits.
741
 
 
742
 
    :param  branch: The branch containing the revisions. 
743
 
 
744
 
    :param  start_revision: The first revision to be logged.
745
 
            For backwards compatibility this may be a mainline integer revno,
746
 
            but for merge revision support a RevisionInfo is expected.
747
 
 
748
 
    :param  end_revision: The last revision to be logged.
749
 
            For backwards compatibility this may be a mainline integer revno,
750
 
            but for merge revision support a RevisionInfo is expected.
751
 
 
752
 
    :return: (start_rev_id, end_rev_id) tuple.
753
 
    """
754
 
    branch_revno, branch_rev_id = branch.last_revision_info()
755
 
    start_rev_id = None
756
 
    if start_revision is None:
757
 
        start_revno = 1
758
 
    else:
759
 
        if isinstance(start_revision, revisionspec.RevisionInfo):
760
 
            start_rev_id = start_revision.rev_id
761
 
            start_revno = start_revision.revno or 1
762
 
        else:
763
 
            branch.check_real_revno(start_revision)
764
 
            start_revno = start_revision
765
 
            start_rev_id = branch.get_rev_id(start_revno)
766
 
 
767
 
    end_rev_id = None
768
 
    if end_revision is None:
769
 
        end_revno = branch_revno
770
 
    else:
771
 
        if isinstance(end_revision, revisionspec.RevisionInfo):
772
 
            end_rev_id = end_revision.rev_id
773
 
            end_revno = end_revision.revno or branch_revno
774
 
        else:
775
 
            branch.check_real_revno(end_revision)
776
 
            end_revno = end_revision
777
 
            end_rev_id = branch.get_rev_id(end_revno)
778
 
 
779
 
    if branch_revno != 0:
780
 
        if (start_rev_id == _mod_revision.NULL_REVISION
781
 
            or end_rev_id == _mod_revision.NULL_REVISION):
782
 
            raise errors.BzrCommandError('Logging revision 0 is invalid.')
783
 
        if start_revno > end_revno:
784
 
            raise errors.BzrCommandError("Start revision must be older than "
785
 
                                         "the end revision.")
786
 
    return (start_rev_id, end_rev_id)
787
 
 
788
 
 
789
 
def _get_mainline_revs(branch, start_revision, end_revision):
790
 
    """Get the mainline revisions from the branch.
791
 
    
792
 
    Generates the list of mainline revisions for the branch.
793
 
    
794
 
    :param  branch: The branch containing the revisions. 
795
 
 
796
 
    :param  start_revision: The first revision to be logged.
797
 
            For backwards compatibility this may be a mainline integer revno,
798
 
            but for merge revision support a RevisionInfo is expected.
799
 
 
800
 
    :param  end_revision: The last revision to be logged.
801
 
            For backwards compatibility this may be a mainline integer revno,
802
 
            but for merge revision support a RevisionInfo is expected.
803
 
 
804
 
    :return: A (mainline_revs, rev_nos, start_rev_id, end_rev_id) tuple.
805
 
    """
806
 
    branch_revno, branch_last_revision = branch.last_revision_info()
807
 
    if branch_revno == 0:
808
 
        return None, None, None, None
809
 
 
810
 
    # For mainline generation, map start_revision and end_revision to 
811
 
    # mainline revnos. If the revision is not on the mainline choose the 
812
 
    # appropriate extreme of the mainline instead - the extra will be 
813
 
    # filtered later.
814
 
    # Also map the revisions to rev_ids, to be used in the later filtering
815
 
    # stage.
816
 
    start_rev_id = None
817
 
    if start_revision is None:
818
 
        start_revno = 1
819
 
    else:
820
 
        if isinstance(start_revision, revisionspec.RevisionInfo):
821
 
            start_rev_id = start_revision.rev_id
822
 
            start_revno = start_revision.revno or 1
823
 
        else:
824
 
            branch.check_real_revno(start_revision)
825
 
            start_revno = start_revision
826
 
 
827
 
    end_rev_id = None
828
 
    if end_revision is None:
829
 
        end_revno = branch_revno
830
 
    else:
831
 
        if isinstance(end_revision, revisionspec.RevisionInfo):
832
 
            end_rev_id = end_revision.rev_id
833
 
            end_revno = end_revision.revno or branch_revno
834
 
        else:
835
 
            branch.check_real_revno(end_revision)
836
 
            end_revno = end_revision
837
 
 
838
 
    if ((start_rev_id == _mod_revision.NULL_REVISION)
839
 
        or (end_rev_id == _mod_revision.NULL_REVISION)):
840
 
        raise errors.BzrCommandError('Logging revision 0 is invalid.')
841
 
    if start_revno > end_revno:
842
 
        raise errors.BzrCommandError("Start revision must be older than "
843
 
                                     "the end revision.")
844
 
 
845
 
    if end_revno < start_revno:
846
 
        return None, None, None, None
847
 
    cur_revno = branch_revno
848
 
    rev_nos = {}
849
 
    mainline_revs = []
850
 
    for revision_id in branch.repository.iter_reverse_revision_history(
851
 
                        branch_last_revision):
852
 
        if cur_revno < start_revno:
853
 
            # We have gone far enough, but we always add 1 more revision
854
 
            rev_nos[revision_id] = cur_revno
855
 
            mainline_revs.append(revision_id)
856
 
            break
857
 
        if cur_revno <= end_revno:
858
 
            rev_nos[revision_id] = cur_revno
859
 
            mainline_revs.append(revision_id)
860
 
        cur_revno -= 1
861
 
    else:
862
 
        # We walked off the edge of all revisions, so we add a 'None' marker
863
 
        mainline_revs.append(None)
864
 
 
865
 
    mainline_revs.reverse()
866
 
 
867
 
    # override the mainline to look like the revision history.
868
 
    return mainline_revs, rev_nos, start_rev_id, end_rev_id
869
 
 
870
 
 
871
 
def _filter_revision_range(view_revisions, start_rev_id, end_rev_id):
872
 
    """Filter view_revisions based on revision ranges.
873
 
 
874
 
    :param view_revisions: A list of (revision_id, dotted_revno, merge_depth) 
875
 
            tuples to be filtered.
876
 
 
877
 
    :param start_rev_id: If not NONE specifies the first revision to be logged.
878
 
            If NONE then all revisions up to the end_rev_id are logged.
879
 
 
880
 
    :param end_rev_id: If not NONE specifies the last revision to be logged.
881
 
            If NONE then all revisions up to the end of the log are logged.
882
 
 
883
 
    :return: The filtered view_revisions.
884
 
    """
885
 
    # This method is no longer called by the main code path.
886
 
    # It may be removed soon. IGC 20090127
887
 
    if start_rev_id or end_rev_id:
888
 
        revision_ids = [r for r, n, d in view_revisions]
889
 
        if start_rev_id:
890
 
            start_index = revision_ids.index(start_rev_id)
891
 
        else:
892
 
            start_index = 0
893
 
        if start_rev_id == end_rev_id:
894
 
            end_index = start_index
895
 
        else:
896
 
            if end_rev_id:
897
 
                end_index = revision_ids.index(end_rev_id)
898
 
            else:
899
 
                end_index = len(view_revisions) - 1
900
 
        # To include the revisions merged into the last revision, 
901
 
        # extend end_rev_id down to, but not including, the next rev
902
 
        # with the same or lesser merge_depth
903
 
        end_merge_depth = view_revisions[end_index][2]
904
 
        try:
905
 
            for index in xrange(end_index+1, len(view_revisions)+1):
906
 
                if view_revisions[index][2] <= end_merge_depth:
907
 
                    end_index = index - 1
908
 
                    break
909
 
        except IndexError:
910
 
            # if the search falls off the end then log to the end as well
911
 
            end_index = len(view_revisions) - 1
912
 
        view_revisions = view_revisions[start_index:end_index+1]
913
 
    return view_revisions
914
 
 
915
 
 
916
 
def _filter_revisions_touching_file_id(branch, file_id, view_revisions,
917
 
    include_merges=True):
918
 
    r"""Return the list of revision ids which touch a given file id.
919
 
 
920
 
    The function filters view_revisions and returns a subset.
921
 
    This includes the revisions which directly change the file id,
922
 
    and the revisions which merge these changes. So if the
923
 
    revision graph is::
924
 
        A-.
925
 
        |\ \
926
 
        B C E
927
 
        |/ /
928
 
        D |
929
 
        |\|
930
 
        | F
931
 
        |/
932
 
        G
933
 
 
934
 
    And 'C' changes a file, then both C and D will be returned. F will not be
935
 
    returned even though it brings the changes to C into the branch starting
936
 
    with E. (Note that if we were using F as the tip instead of G, then we
937
 
    would see C, D, F.)
938
 
 
939
 
    This will also be restricted based on a subset of the mainline.
940
 
 
941
 
    :param branch: The branch where we can get text revision information.
942
 
 
943
 
    :param file_id: Filter out revisions that do not touch file_id.
944
 
 
945
 
    :param view_revisions: A list of (revision_id, dotted_revno, merge_depth)
946
 
        tuples. This is the list of revisions which will be filtered. It is
947
 
        assumed that view_revisions is in merge_sort order (i.e. newest
948
 
        revision first ).
949
 
 
950
 
    :param include_merges: include merge revisions in the result or not
951
 
 
952
 
    :return: A list of (revision_id, dotted_revno, merge_depth) tuples.
953
 
    """
954
 
    # Lookup all possible text keys to determine which ones actually modified
955
 
    # the file.
956
 
    text_keys = [(file_id, rev_id) for rev_id, revno, depth in view_revisions]
957
 
    # Looking up keys in batches of 1000 can cut the time in half, as well as
958
 
    # memory consumption. GraphIndex *does* like to look for a few keys in
959
 
    # parallel, it just doesn't like looking for *lots* of keys in parallel.
960
 
    # TODO: This code needs to be re-evaluated periodically as we tune the
961
 
    #       indexing layer. We might consider passing in hints as to the known
962
 
    #       access pattern (sparse/clustered, high success rate/low success
963
 
    #       rate). This particular access is clustered with a low success rate.
964
 
    get_parent_map = branch.repository.texts.get_parent_map
965
 
    modified_text_revisions = set()
966
 
    chunk_size = 1000
967
 
    for start in xrange(0, len(text_keys), chunk_size):
968
 
        next_keys = text_keys[start:start + chunk_size]
969
 
        # Only keep the revision_id portion of the key
970
 
        modified_text_revisions.update(
971
 
            [k[1] for k in get_parent_map(next_keys)])
972
 
    del text_keys, next_keys
973
 
 
974
 
    result = []
975
 
    # Track what revisions will merge the current revision, replace entries
976
 
    # with 'None' when they have been added to result
977
 
    current_merge_stack = [None]
978
 
    for info in view_revisions:
979
 
        rev_id, revno, depth = info
980
 
        if depth == len(current_merge_stack):
981
 
            current_merge_stack.append(info)
982
 
        else:
983
 
            del current_merge_stack[depth + 1:]
984
 
            current_merge_stack[-1] = info
985
 
 
986
 
        if rev_id in modified_text_revisions:
987
 
            # This needs to be logged, along with the extra revisions
988
 
            for idx in xrange(len(current_merge_stack)):
989
 
                node = current_merge_stack[idx]
990
 
                if node is not None:
991
 
                    if include_merges or node[2] == 0:
992
 
                        result.append(node)
993
 
                        current_merge_stack[idx] = None
994
 
    return result
995
 
 
996
 
 
997
 
def get_view_revisions(mainline_revs, rev_nos, branch, direction,
998
 
                       include_merges=True):
999
 
    """Produce an iterator of revisions to show
1000
 
    :return: an iterator of (revision_id, revno, merge_depth)
1001
 
    (if there is no revno for a revision, None is supplied)
1002
 
    """
1003
 
    # This method is no longer called by the main code path.
1004
 
    # It is retained for API compatibility and may be deprecated
1005
 
    # soon. IGC 20090127
1006
 
    if not include_merges:
1007
 
        revision_ids = mainline_revs[1:]
1008
 
        if direction == 'reverse':
1009
 
            revision_ids.reverse()
1010
 
        for revision_id in revision_ids:
1011
 
            yield revision_id, str(rev_nos[revision_id]), 0
1012
 
        return
1013
 
    graph = branch.repository.get_graph()
1014
 
    # This asks for all mainline revisions, which means we only have to spider
1015
 
    # sideways, rather than depth history. That said, its still size-of-history
1016
 
    # and should be addressed.
1017
 
    # mainline_revisions always includes an extra revision at the beginning, so
1018
 
    # don't request it.
1019
 
    parent_map = dict(((key, value) for key, value in
1020
 
        graph.iter_ancestry(mainline_revs[1:]) if value is not None))
1021
 
    # filter out ghosts; merge_sort errors on ghosts.
1022
 
    rev_graph = _mod_repository._strip_NULL_ghosts(parent_map)
1023
 
    merge_sorted_revisions = tsort.merge_sort(
1024
 
        rev_graph,
1025
 
        mainline_revs[-1],
1026
 
        mainline_revs,
1027
 
        generate_revno=True)
1028
 
 
1029
 
    if direction == 'forward':
1030
 
        # forward means oldest first.
1031
 
        merge_sorted_revisions = reverse_by_depth(merge_sorted_revisions)
1032
 
    elif direction != 'reverse':
1033
 
        raise ValueError('invalid direction %r' % direction)
1034
 
 
1035
 
    for (sequence, rev_id, merge_depth, revno, end_of_merge
1036
 
         ) in merge_sorted_revisions:
1037
 
        yield rev_id, '.'.join(map(str, revno)), merge_depth
1038
 
 
1039
 
 
1040
 
def reverse_by_depth(merge_sorted_revisions, _depth=0):
1041
 
    """Reverse revisions by depth.
1042
 
 
1043
 
    Revisions with a different depth are sorted as a group with the previous
1044
 
    revision of that depth.  There may be no topological justification for this,
1045
 
    but it looks much nicer.
1046
 
    """
1047
 
    # Add a fake revision at start so that we can always attach sub revisions
1048
 
    merge_sorted_revisions = [(None, None, _depth)] + merge_sorted_revisions
1049
 
    zd_revisions = []
1050
 
    for val in merge_sorted_revisions:
1051
 
        if val[2] == _depth:
1052
 
            # Each revision at the current depth becomes a chunk grouping all
1053
 
            # higher depth revisions.
1054
 
            zd_revisions.append([val])
1055
 
        else:
1056
 
            zd_revisions[-1].append(val)
1057
 
    for revisions in zd_revisions:
1058
 
        if len(revisions) > 1:
1059
 
            # We have higher depth revisions, let reverse them locally
1060
 
            revisions[1:] = reverse_by_depth(revisions[1:], _depth + 1)
1061
 
    zd_revisions.reverse()
1062
 
    result = []
1063
 
    for chunk in zd_revisions:
1064
 
        result.extend(chunk)
1065
 
    if _depth == 0:
1066
 
        # Top level call, get rid of the fake revisions that have been added
1067
 
        result = [r for r in result if r[0] is not None and r[1] is not None]
1068
 
    return result
1069
 
 
1070
 
 
1071
 
class LogRevision(object):
1072
 
    """A revision to be logged (by LogFormatter.log_revision).
1073
 
 
1074
 
    A simple wrapper for the attributes of a revision to be logged.
1075
 
    The attributes may or may not be populated, as determined by the 
1076
 
    logging options and the log formatter capabilities.
1077
 
    """
1078
 
 
1079
 
    def __init__(self, rev=None, revno=None, merge_depth=0, delta=None,
1080
 
                 tags=None, diff=None):
1081
 
        self.rev = rev
1082
 
        self.revno = str(revno)
1083
 
        self.merge_depth = merge_depth
1084
 
        self.delta = delta
1085
 
        self.tags = tags
1086
 
        self.diff = diff
 
151
 
 
152
        if not verbose:
 
153
            # although we calculated it, throw it away without display
 
154
            delta = None
 
155
 
 
156
        if searchRE is None or searchRE.search(rev.message):
 
157
            lf.show(revno, rev, delta)
 
158
 
 
159
 
 
160
 
 
161
def deltas_for_log_dummy(branch, which_revs):
 
162
    for revno, revision_id in which_revs:
 
163
        yield revno, branch.get_revision(revision_id), None
 
164
 
 
165
 
 
166
def deltas_for_log_reverse(branch, which_revs):
 
167
    """Compute deltas for display in reverse log.
 
168
 
 
169
    Given a sequence of (revno, revision_id) pairs, return
 
170
    (revno, rev, delta).
 
171
 
 
172
    The delta is from the given revision to the next one in the
 
173
    sequence, which makes sense if the log is being displayed from
 
174
    newest to oldest.
 
175
    """
 
176
    from tree import EmptyTree
 
177
    from diff import compare_trees
 
178
    
 
179
    last_revno = last_revision_id = last_tree = None
 
180
    for revno, revision_id in which_revs:
 
181
        this_tree = branch.revision_tree(revision_id)
 
182
        this_revision = branch.get_revision(revision_id)
 
183
        
 
184
        if last_revno:
 
185
            yield last_revno, last_revision, compare_trees(this_tree, last_tree, False)
 
186
 
 
187
        last_revno = revno
 
188
        last_revision = this_revision
 
189
        last_tree = this_tree
 
190
 
 
191
    if last_revno:
 
192
        if last_revno == 1:
 
193
            this_tree = EmptyTree()
 
194
        else:
 
195
            this_revno = last_revno - 1
 
196
            this_revision_id = branch.revision_history()[this_revno]
 
197
            this_tree = branch.revision_tree(this_revision_id)
 
198
        yield last_revno, last_revision, compare_trees(this_tree, last_tree, False)
 
199
 
 
200
 
 
201
def deltas_for_log_forward(branch, which_revs):
 
202
    """Compute deltas for display in forward log.
 
203
 
 
204
    Given a sequence of (revno, revision_id) pairs, return
 
205
    (revno, rev, delta).
 
206
 
 
207
    The delta is from the given revision to the next one in the
 
208
    sequence, which makes sense if the log is being displayed from
 
209
    newest to oldest.
 
210
    """
 
211
    from tree import EmptyTree
 
212
    from diff import compare_trees
 
213
 
 
214
    last_revno = last_revision_id = last_tree = None
 
215
    for revno, revision_id in which_revs:
 
216
        this_tree = branch.revision_tree(revision_id)
 
217
        this_revision = branch.get_revision(revision_id)
 
218
 
 
219
        if not last_revno:
 
220
            if revno == 1:
 
221
                last_tree = EmptyTree()
 
222
            else:
 
223
                last_revno = revno - 1
 
224
                last_revision_id = branch.revision_history()[last_revno]
 
225
                last_tree = branch.revision_tree(last_revision_id)
 
226
 
 
227
        yield revno, this_revision, compare_trees(last_tree, this_tree, False)
 
228
 
 
229
        last_revno = revno
 
230
        last_revision = this_revision
 
231
        last_tree = this_tree
1087
232
 
1088
233
 
1089
234
class LogFormatter(object):
1090
 
    """Abstract class to display log messages.
1091
 
 
1092
 
    At a minimum, a derived class must implement the log_revision method.
1093
 
 
1094
 
    If the LogFormatter needs to be informed of the beginning or end of
1095
 
    a log it should implement the begin_log and/or end_log hook methods.
1096
 
 
1097
 
    A LogFormatter should define the following supports_XXX flags 
1098
 
    to indicate which LogRevision attributes it supports:
1099
 
 
1100
 
    - supports_delta must be True if this log formatter supports delta.
1101
 
        Otherwise the delta attribute may not be populated.  The 'delta_format'
1102
 
        attribute describes whether the 'short_status' format (1) or the long
1103
 
        one (2) should be used.
1104
 
 
1105
 
    - supports_merge_revisions must be True if this log formatter supports 
1106
 
        merge revisions.  If not, and if supports_single_merge_revision is
1107
 
        also not True, then only mainline revisions will be passed to the 
1108
 
        formatter.
1109
 
 
1110
 
    - preferred_levels is the number of levels this formatter defaults to.
1111
 
        The default value is zero meaning display all levels.
1112
 
        This value is only relevant if supports_merge_revisions is True.
1113
 
 
1114
 
    - supports_single_merge_revision must be True if this log formatter
1115
 
        supports logging only a single merge revision.  This flag is
1116
 
        only relevant if supports_merge_revisions is not True.
1117
 
 
1118
 
    - supports_tags must be True if this log formatter supports tags.
1119
 
        Otherwise the tags attribute may not be populated.
1120
 
 
1121
 
    - supports_diff must be True if this log formatter supports diffs.
1122
 
        Otherwise the diff attribute may not be populated.
1123
 
 
1124
 
    Plugins can register functions to show custom revision properties using
1125
 
    the properties_handler_registry. The registered function
1126
 
    must respect the following interface description:
1127
 
        def my_show_properties(properties_dict):
1128
 
            # code that returns a dict {'name':'value'} of the properties 
1129
 
            # to be shown
1130
 
    """
1131
 
    preferred_levels = 0
1132
 
 
1133
 
    def __init__(self, to_file, show_ids=False, show_timezone='original',
1134
 
                 delta_format=None, levels=None):
1135
 
        """Create a LogFormatter.
1136
 
 
1137
 
        :param to_file: the file to output to
1138
 
        :param show_ids: if True, revision-ids are to be displayed
1139
 
        :param show_timezone: the timezone to use
1140
 
        :param delta_format: the level of delta information to display
1141
 
          or None to leave it u to the formatter to decide
1142
 
        :param levels: the number of levels to display; None or -1 to
1143
 
          let the log formatter decide.
1144
 
        """
 
235
    """Abstract class to display log messages."""
 
236
    def __init__(self, to_file, show_ids=False, show_timezone=False):
1145
237
        self.to_file = to_file
1146
238
        self.show_ids = show_ids
1147
239
        self.show_timezone = show_timezone
1148
 
        if delta_format is None:
1149
 
            # Ensures backward compatibility
1150
 
            delta_format = 2 # long format
1151
 
        self.delta_format = delta_format
1152
 
        self.levels = levels
1153
 
 
1154
 
    def get_levels(self):
1155
 
        """Get the number of levels to display or 0 for all."""
1156
 
        if getattr(self, 'supports_merge_revisions', False):
1157
 
            if self.levels is None or self.levels == -1:
1158
 
                return self.preferred_levels
1159
 
            else:
1160
 
                return self.levels
1161
 
        return 1
1162
 
 
1163
 
    def log_revision(self, revision):
1164
 
        """Log a revision.
1165
 
 
1166
 
        :param  revision:   The LogRevision to be logged.
1167
 
        """
1168
 
        raise NotImplementedError('not implemented in abstract base')
1169
 
 
1170
 
    def short_committer(self, rev):
1171
 
        name, address = config.parse_username(rev.committer)
1172
 
        if name:
1173
 
            return name
1174
 
        return address
1175
 
 
1176
 
    def short_author(self, rev):
1177
 
        name, address = config.parse_username(rev.get_apparent_author())
1178
 
        if name:
1179
 
            return name
1180
 
        return address
1181
 
 
1182
 
    def show_properties(self, revision, indent):
1183
 
        """Displays the custom properties returned by each registered handler.
1184
240
        
1185
 
        If a registered handler raises an error it is propagated.
1186
 
        """
1187
 
        for key, handler in properties_handler_registry.iteritems():
1188
 
            for key, value in handler(revision).items():
1189
 
                self.to_file.write(indent + key + ': ' + value + '\n')
1190
 
 
1191
 
    def show_diff(self, to_file, diff, indent):
1192
 
        for l in diff.rstrip().split('\n'):
1193
 
            to_file.write(indent + '%s\n' % (l,))
 
241
 
 
242
 
 
243
 
1194
244
 
1195
245
 
1196
246
class LongLogFormatter(LogFormatter):
1197
 
 
1198
 
    supports_merge_revisions = True
1199
 
    supports_delta = True
1200
 
    supports_tags = True
1201
 
    supports_diff = True
1202
 
 
1203
 
    def log_revision(self, revision):
1204
 
        """Log a revision, either merged or not."""
1205
 
        indent = '    ' * revision.merge_depth
 
247
    def show(self, revno, rev, delta):
 
248
        from osutils import format_date
 
249
 
1206
250
        to_file = self.to_file
1207
 
        to_file.write(indent + '-' * 60 + '\n')
1208
 
        if revision.revno is not None:
1209
 
            to_file.write(indent + 'revno: %s\n' % (revision.revno,))
1210
 
        if revision.tags:
1211
 
            to_file.write(indent + 'tags: %s\n' % (', '.join(revision.tags)))
 
251
 
 
252
        print >>to_file,  '-' * 60
 
253
        print >>to_file,  'revno:', revno
1212
254
        if self.show_ids:
1213
 
            to_file.write(indent + 'revision-id: ' + revision.rev.revision_id)
1214
 
            to_file.write('\n')
1215
 
            for parent_id in revision.rev.parent_ids:
1216
 
                to_file.write(indent + 'parent: %s\n' % (parent_id,))
1217
 
        self.show_properties(revision.rev, indent)
1218
 
 
1219
 
        author = revision.rev.properties.get('author', None)
1220
 
        if author is not None:
1221
 
            to_file.write(indent + 'author: %s\n' % (author,))
1222
 
        to_file.write(indent + 'committer: %s\n' % (revision.rev.committer,))
1223
 
 
1224
 
        branch_nick = revision.rev.properties.get('branch-nick', None)
1225
 
        if branch_nick is not None:
1226
 
            to_file.write(indent + 'branch nick: %s\n' % (branch_nick,))
1227
 
 
1228
 
        date_str = format_date(revision.rev.timestamp,
1229
 
                               revision.rev.timezone or 0,
1230
 
                               self.show_timezone)
1231
 
        to_file.write(indent + 'timestamp: %s\n' % (date_str,))
1232
 
 
1233
 
        to_file.write(indent + 'message:\n')
1234
 
        if not revision.rev.message:
1235
 
            to_file.write(indent + '  (no message)\n')
 
255
            print >>to_file,  'revision-id:', rev.revision_id
 
256
        print >>to_file,  'committer:', rev.committer
 
257
        print >>to_file,  'timestamp: %s' % (format_date(rev.timestamp, rev.timezone or 0,
 
258
                                             self.show_timezone))
 
259
 
 
260
        print >>to_file,  'message:'
 
261
        if not rev.message:
 
262
            print >>to_file,  '  (no message)'
1236
263
        else:
1237
 
            message = revision.rev.message.rstrip('\r\n')
1238
 
            for l in message.split('\n'):
1239
 
                to_file.write(indent + '  %s\n' % (l,))
1240
 
        if revision.delta is not None:
1241
 
            # We don't respect delta_format for compatibility
1242
 
            revision.delta.show(to_file, self.show_ids, indent=indent,
1243
 
                                short_status=False)
1244
 
        if revision.diff is not None:
1245
 
            to_file.write(indent + 'diff:\n')
1246
 
            # Note: we explicitly don't indent the diff (relative to the
1247
 
            # revision information) so that the output can be fed to patch -p0
1248
 
            self.show_diff(to_file, revision.diff, indent)
 
264
            for l in rev.message.split('\n'):
 
265
                print >>to_file,  '  ' + l
 
266
 
 
267
        if delta != None:
 
268
            delta.show(to_file, self.show_ids)
 
269
 
1249
270
 
1250
271
 
1251
272
class ShortLogFormatter(LogFormatter):
1252
 
 
1253
 
    supports_merge_revisions = True
1254
 
    preferred_levels = 1
1255
 
    supports_delta = True
1256
 
    supports_tags = True
1257
 
    supports_diff = True
1258
 
 
1259
 
    def __init__(self, *args, **kwargs):
1260
 
        super(ShortLogFormatter, self).__init__(*args, **kwargs)
1261
 
        self.revno_width_by_depth = {}
1262
 
 
1263
 
    def log_revision(self, revision):
1264
 
        # We need two indents: one per depth and one for the information
1265
 
        # relative to that indent. Most mainline revnos are 5 chars or
1266
 
        # less while dotted revnos are typically 11 chars or less. Once
1267
 
        # calculated, we need to remember the offset for a given depth
1268
 
        # as we might be starting from a dotted revno in the first column
1269
 
        # and we want subsequent mainline revisions to line up.
1270
 
        depth = revision.merge_depth
1271
 
        indent = '    ' * depth
1272
 
        revno_width = self.revno_width_by_depth.get(depth)
1273
 
        if revno_width is None:
1274
 
            if revision.revno.find('.') == -1:
1275
 
                # mainline revno, e.g. 12345
1276
 
                revno_width = 5
1277
 
            else:
1278
 
                # dotted revno, e.g. 12345.10.55
1279
 
                revno_width = 11
1280
 
            self.revno_width_by_depth[depth] = revno_width
1281
 
        offset = ' ' * (revno_width + 1)
 
273
    def show(self, revno, rev, delta):
 
274
        from bzrlib.osutils import format_date
1282
275
 
1283
276
        to_file = self.to_file
1284
 
        is_merge = ''
1285
 
        if len(revision.rev.parent_ids) > 1:
1286
 
            is_merge = ' [merge]'
1287
 
        tags = ''
1288
 
        if revision.tags:
1289
 
            tags = ' {%s}' % (', '.join(revision.tags))
1290
 
        to_file.write(indent + "%*s %s\t%s%s%s\n" % (revno_width,
1291
 
                revision.revno, self.short_author(revision.rev),
1292
 
                format_date(revision.rev.timestamp,
1293
 
                            revision.rev.timezone or 0,
1294
 
                            self.show_timezone, date_fmt="%Y-%m-%d",
1295
 
                            show_offset=False),
1296
 
                tags, is_merge))
1297
 
        self.show_properties(revision.rev, indent+offset)
 
277
 
 
278
        print >>to_file, "%5d %s\t%s" % (revno, rev.committer,
 
279
                format_date(rev.timestamp, rev.timezone or 0,
 
280
                            self.show_timezone))
1298
281
        if self.show_ids:
1299
 
            to_file.write(indent + offset + 'revision-id:%s\n'
1300
 
                          % (revision.rev.revision_id,))
1301
 
        if not revision.rev.message:
1302
 
            to_file.write(indent + offset + '(no message)\n')
1303
 
        else:
1304
 
            message = revision.rev.message.rstrip('\r\n')
1305
 
            for l in message.split('\n'):
1306
 
                to_file.write(indent + offset + '%s\n' % (l,))
1307
 
 
1308
 
        if revision.delta is not None:
1309
 
            revision.delta.show(to_file, self.show_ids, indent=indent + offset,
1310
 
                                short_status=self.delta_format==1)
1311
 
        if revision.diff is not None:
1312
 
            self.show_diff(to_file, revision.diff, '      ')
1313
 
        to_file.write('\n')
1314
 
 
1315
 
 
1316
 
class LineLogFormatter(LogFormatter):
1317
 
 
1318
 
    supports_merge_revisions = True
1319
 
    preferred_levels = 1
1320
 
    supports_tags = True
1321
 
 
1322
 
    def __init__(self, *args, **kwargs):
1323
 
        super(LineLogFormatter, self).__init__(*args, **kwargs)
1324
 
        self._max_chars = terminal_width() - 1
1325
 
 
1326
 
    def truncate(self, str, max_len):
1327
 
        if len(str) <= max_len:
1328
 
            return str
1329
 
        return str[:max_len-3]+'...'
1330
 
 
1331
 
    def date_string(self, rev):
1332
 
        return format_date(rev.timestamp, rev.timezone or 0,
1333
 
                           self.show_timezone, date_fmt="%Y-%m-%d",
1334
 
                           show_offset=False)
1335
 
 
1336
 
    def message(self, rev):
 
282
            print >>to_file,  '      revision-id:', rev.revision_id
1337
283
        if not rev.message:
1338
 
            return '(no message)'
 
284
            print >>to_file,  '      (no message)'
1339
285
        else:
1340
 
            return rev.message
1341
 
 
1342
 
    def log_revision(self, revision):
1343
 
        indent = '  ' * revision.merge_depth
1344
 
        self.to_file.write(self.log_string(revision.revno, revision.rev,
1345
 
            self._max_chars, revision.tags, indent))
1346
 
        self.to_file.write('\n')
1347
 
 
1348
 
    def log_string(self, revno, rev, max_chars, tags=None, prefix=''):
1349
 
        """Format log info into one string. Truncate tail of string
1350
 
        :param  revno:      revision number or None.
1351
 
                            Revision numbers counts from 1.
1352
 
        :param  rev:        revision object
1353
 
        :param  max_chars:  maximum length of resulting string
1354
 
        :param  tags:       list of tags or None
1355
 
        :param  prefix:     string to prefix each line
1356
 
        :return:            formatted truncated string
1357
 
        """
1358
 
        out = []
1359
 
        if revno:
1360
 
            # show revno only when is not None
1361
 
            out.append("%s:" % revno)
1362
 
        out.append(self.truncate(self.short_author(rev), 20))
1363
 
        out.append(self.date_string(rev))
1364
 
        if len(rev.parent_ids) > 1:
1365
 
            out.append('[merge]')
1366
 
        if tags:
1367
 
            tag_str = '{%s}' % (', '.join(tags))
1368
 
            out.append(tag_str)
1369
 
        out.append(rev.get_summary())
1370
 
        return self.truncate(prefix + " ".join(out).rstrip('\n'), max_chars)
1371
 
 
1372
 
 
1373
 
def line_log(rev, max_chars):
1374
 
    lf = LineLogFormatter(None)
1375
 
    return lf.log_string(None, rev, max_chars)
1376
 
 
1377
 
 
1378
 
class LogFormatterRegistry(registry.Registry):
1379
 
    """Registry for log formatters"""
1380
 
 
1381
 
    def make_formatter(self, name, *args, **kwargs):
1382
 
        """Construct a formatter from arguments.
1383
 
 
1384
 
        :param name: Name of the formatter to construct.  'short', 'long' and
1385
 
            'line' are built-in.
1386
 
        """
1387
 
        return self.get(name)(*args, **kwargs)
1388
 
 
1389
 
    def get_default(self, branch):
1390
 
        return self.get(branch.get_config().log_format())
1391
 
 
1392
 
 
1393
 
log_formatter_registry = LogFormatterRegistry()
1394
 
 
1395
 
 
1396
 
log_formatter_registry.register('short', ShortLogFormatter,
1397
 
                                'Moderately short log format')
1398
 
log_formatter_registry.register('long', LongLogFormatter,
1399
 
                                'Detailed log format')
1400
 
log_formatter_registry.register('line', LineLogFormatter,
1401
 
                                'Log format with one line per revision')
1402
 
 
1403
 
 
1404
 
def register_formatter(name, formatter):
1405
 
    log_formatter_registry.register(name, formatter)
 
286
            for l in rev.message.split('\n'):
 
287
                print >>to_file,  '      ' + l
 
288
 
 
289
        if delta != None:
 
290
            delta.show(to_file, self.show_ids)
 
291
        print
 
292
 
 
293
 
 
294
 
 
295
FORMATTERS = {'long': LongLogFormatter,
 
296
              'short': ShortLogFormatter,
 
297
              }
1406
298
 
1407
299
 
1408
300
def log_formatter(name, *args, **kwargs):
1409
 
    """Construct a formatter from arguments.
1410
 
 
1411
 
    name -- Name of the formatter to construct; currently 'long', 'short' and
1412
 
        'line' are supported.
1413
 
    """
 
301
    from bzrlib.errors import BzrCommandError
 
302
    
1414
303
    try:
1415
 
        return log_formatter_registry.make_formatter(name, *args, **kwargs)
1416
 
    except KeyError:
1417
 
        raise errors.BzrCommandError("unknown log formatter: %r" % name)
1418
 
 
1419
 
 
1420
 
def show_one_log(revno, rev, delta, verbose, to_file, show_timezone):
1421
 
    # deprecated; for compatibility
1422
 
    lf = LongLogFormatter(to_file=to_file, show_timezone=show_timezone)
1423
 
    lf.show(revno, rev, delta)
1424
 
 
1425
 
 
1426
 
def show_changed_revisions(branch, old_rh, new_rh, to_file=None,
1427
 
                           log_format='long'):
1428
 
    """Show the change in revision history comparing the old revision history to the new one.
1429
 
 
1430
 
    :param branch: The branch where the revisions exist
1431
 
    :param old_rh: The old revision history
1432
 
    :param new_rh: The new revision history
1433
 
    :param to_file: A file to write the results to. If None, stdout will be used
1434
 
    """
1435
 
    if to_file is None:
1436
 
        to_file = codecs.getwriter(get_terminal_encoding())(sys.stdout,
1437
 
            errors='replace')
1438
 
    lf = log_formatter(log_format,
1439
 
                       show_ids=False,
1440
 
                       to_file=to_file,
1441
 
                       show_timezone='original')
1442
 
 
1443
 
    # This is the first index which is different between
1444
 
    # old and new
1445
 
    base_idx = None
1446
 
    for i in xrange(max(len(new_rh),
1447
 
                        len(old_rh))):
1448
 
        if (len(new_rh) <= i
1449
 
            or len(old_rh) <= i
1450
 
            or new_rh[i] != old_rh[i]):
1451
 
            base_idx = i
1452
 
            break
1453
 
 
1454
 
    if base_idx is None:
1455
 
        to_file.write('Nothing seems to have changed\n')
1456
 
        return
1457
 
    ## TODO: It might be nice to do something like show_log
1458
 
    ##       and show the merged entries. But since this is the
1459
 
    ##       removed revisions, it shouldn't be as important
1460
 
    if base_idx < len(old_rh):
1461
 
        to_file.write('*'*60)
1462
 
        to_file.write('\nRemoved Revisions:\n')
1463
 
        for i in range(base_idx, len(old_rh)):
1464
 
            rev = branch.repository.get_revision(old_rh[i])
1465
 
            lr = LogRevision(rev, i+1, 0, None)
1466
 
            lf.log_revision(lr)
1467
 
        to_file.write('*'*60)
1468
 
        to_file.write('\n\n')
1469
 
    if base_idx < len(new_rh):
1470
 
        to_file.write('Added Revisions:\n')
1471
 
        show_log(branch,
1472
 
                 lf,
1473
 
                 None,
1474
 
                 verbose=False,
1475
 
                 direction='forward',
1476
 
                 start_revision=base_idx+1,
1477
 
                 end_revision=len(new_rh),
1478
 
                 search=None)
1479
 
 
1480
 
 
1481
 
def get_history_change(old_revision_id, new_revision_id, repository):
1482
 
    """Calculate the uncommon lefthand history between two revisions.
1483
 
 
1484
 
    :param old_revision_id: The original revision id.
1485
 
    :param new_revision_id: The new revision id.
1486
 
    :param repository: The repository to use for the calculation.
1487
 
 
1488
 
    return old_history, new_history
1489
 
    """
1490
 
    old_history = []
1491
 
    old_revisions = set()
1492
 
    new_history = []
1493
 
    new_revisions = set()
1494
 
    new_iter = repository.iter_reverse_revision_history(new_revision_id)
1495
 
    old_iter = repository.iter_reverse_revision_history(old_revision_id)
1496
 
    stop_revision = None
1497
 
    do_old = True
1498
 
    do_new = True
1499
 
    while do_new or do_old:
1500
 
        if do_new:
1501
 
            try:
1502
 
                new_revision = new_iter.next()
1503
 
            except StopIteration:
1504
 
                do_new = False
1505
 
            else:
1506
 
                new_history.append(new_revision)
1507
 
                new_revisions.add(new_revision)
1508
 
                if new_revision in old_revisions:
1509
 
                    stop_revision = new_revision
1510
 
                    break
1511
 
        if do_old:
1512
 
            try:
1513
 
                old_revision = old_iter.next()
1514
 
            except StopIteration:
1515
 
                do_old = False
1516
 
            else:
1517
 
                old_history.append(old_revision)
1518
 
                old_revisions.add(old_revision)
1519
 
                if old_revision in new_revisions:
1520
 
                    stop_revision = old_revision
1521
 
                    break
1522
 
    new_history.reverse()
1523
 
    old_history.reverse()
1524
 
    if stop_revision is not None:
1525
 
        new_history = new_history[new_history.index(stop_revision) + 1:]
1526
 
        old_history = old_history[old_history.index(stop_revision) + 1:]
1527
 
    return old_history, new_history
1528
 
 
1529
 
 
1530
 
def show_branch_change(branch, output, old_revno, old_revision_id):
1531
 
    """Show the changes made to a branch.
1532
 
 
1533
 
    :param branch: The branch to show changes about.
1534
 
    :param output: A file-like object to write changes to.
1535
 
    :param old_revno: The revno of the old tip.
1536
 
    :param old_revision_id: The revision_id of the old tip.
1537
 
    """
1538
 
    new_revno, new_revision_id = branch.last_revision_info()
1539
 
    old_history, new_history = get_history_change(old_revision_id,
1540
 
                                                  new_revision_id,
1541
 
                                                  branch.repository)
1542
 
    if old_history == [] and new_history == []:
1543
 
        output.write('Nothing seems to have changed\n')
1544
 
        return
1545
 
 
1546
 
    log_format = log_formatter_registry.get_default(branch)
1547
 
    lf = log_format(show_ids=False, to_file=output, show_timezone='original')
1548
 
    if old_history != []:
1549
 
        output.write('*'*60)
1550
 
        output.write('\nRemoved Revisions:\n')
1551
 
        show_flat_log(branch.repository, old_history, old_revno, lf)
1552
 
        output.write('*'*60)
1553
 
        output.write('\n\n')
1554
 
    if new_history != []:
1555
 
        output.write('Added Revisions:\n')
1556
 
        start_revno = new_revno - len(new_history) + 1
1557
 
        show_log(branch, lf, None, verbose=False, direction='forward',
1558
 
                 start_revision=start_revno,)
1559
 
 
1560
 
 
1561
 
def show_flat_log(repository, history, last_revno, lf):
1562
 
    """Show a simple log of the specified history.
1563
 
 
1564
 
    :param repository: The repository to retrieve revisions from.
1565
 
    :param history: A list of revision_ids indicating the lefthand history.
1566
 
    :param last_revno: The revno of the last revision_id in the history.
1567
 
    :param lf: The log formatter to use.
1568
 
    """
1569
 
    start_revno = last_revno - len(history) + 1
1570
 
    revisions = repository.get_revisions(history)
1571
 
    for i, rev in enumerate(revisions):
1572
 
        lr = LogRevision(rev, i + last_revno, 0, None)
1573
 
        lf.log_revision(lr)
1574
 
 
1575
 
 
1576
 
def _get_fileid_to_log(revision, tree, b, fp):
1577
 
    """Find the file-id to log for a file path in a revision range.
1578
 
 
1579
 
    :param revision: the revision range as parsed on the command line
1580
 
    :param tree: the working tree, if any
1581
 
    :param b: the branch
1582
 
    :param fp: file path
1583
 
    """
1584
 
    if revision is None:
1585
 
        if tree is None:
1586
 
            tree = b.basis_tree()
1587
 
        file_id = tree.path2id(fp)
1588
 
        if file_id is None:
1589
 
            # go back to when time began
1590
 
            try:
1591
 
                rev1 = b.get_rev_id(1)
1592
 
            except errors.NoSuchRevision:
1593
 
                # No history at all
1594
 
                file_id = None
1595
 
            else:
1596
 
                tree = b.repository.revision_tree(rev1)
1597
 
                file_id = tree.path2id(fp)
1598
 
 
1599
 
    elif len(revision) == 1:
1600
 
        # One revision given - file must exist in it
1601
 
        tree = revision[0].as_tree(b)
1602
 
        file_id = tree.path2id(fp)
1603
 
 
1604
 
    elif len(revision) == 2:
1605
 
        # Revision range given. Get the file-id from the end tree.
1606
 
        # If that fails, try the start tree.
1607
 
        rev_id = revision[1].as_revision_id(b)
1608
 
        if rev_id is None:
1609
 
            tree = b.basis_tree()
1610
 
        else:
1611
 
            tree = revision[1].as_tree(b)
1612
 
        file_id = tree.path2id(fp)
1613
 
        if file_id is None:
1614
 
            rev_id = revision[0].as_revision_id(b)
1615
 
            if rev_id is None:
1616
 
                rev1 = b.get_rev_id(1)
1617
 
                tree = b.repository.revision_tree(rev1)
1618
 
            else:
1619
 
                tree = revision[0].as_tree(b)
1620
 
            file_id = tree.path2id(fp)
1621
 
    else:
1622
 
        raise errors.BzrCommandError(
1623
 
            'bzr log --revision takes one or two values.')
1624
 
    return file_id
1625
 
 
1626
 
 
1627
 
properties_handler_registry = registry.Registry()
1628
 
properties_handler_registry.register_lazy("foreign",
1629
 
                                          "bzrlib.foreign",
1630
 
                                          "show_foreign_properties")
1631
 
 
1632
 
 
1633
 
# adapters which revision ids to log are filtered. When log is called, the
1634
 
# log_rev_iterator is adapted through each of these factory methods.
1635
 
# Plugins are welcome to mutate this list in any way they like - as long
1636
 
# as the overall behaviour is preserved. At this point there is no extensible
1637
 
# mechanism for getting parameters to each factory method, and until there is
1638
 
# this won't be considered a stable api.
1639
 
log_adapters = [
1640
 
    # core log logic
1641
 
    _make_batch_filter,
1642
 
    # read revision objects
1643
 
    _make_revision_objects,
1644
 
    # filter on log messages
1645
 
    _make_search_filter,
1646
 
    # generate deltas for things we will show
1647
 
    _make_delta_filter
1648
 
    ]
 
304
        return FORMATTERS[name](*args, **kwargs)
 
305
    except IndexError:
 
306
        raise BzrCommandError("unknown log formatter: %r" % name)