~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/log.py

  • Committer: John Arbash Meinel
  • Date: 2008-04-18 20:30:59 UTC
  • mto: This revision was merged to the branch mainline in revision 3434.
  • Revision ID: john@arbash-meinel.com-20080418203059-iguj66uacil58ytv
bzr log bzr:// was failing at the first revision because it was trying to

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