/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to bzrlib/log.py

  • Committer: Andrew Bennetts
  • Date: 2008-04-02 00:14:00 UTC
  • mfrom: (3324 +trunk)
  • mto: This revision was merged to the branch mainline in revision 3756.
  • Revision ID: andrew.bennetts@canonical.com-20080402001400-r1pqse38i03dl97w
Merge from bzr.dev.

Show diffs side-by-side

added added

removed removed

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