~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/log.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2008-04-07 07:52:50 UTC
  • mfrom: (3340.1.1 208418-1.4)
  • Revision ID: pqm@pqm.ubuntu.com-20080407075250-phs53xnslo8boaeo
Return the correct knit serialisation method in _StreamAccess.
        (Andrew Bennetts, Martin Pool, Robert Collins)

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
 
83
from bzrlib.tsort import (
 
84
    merge_sort,
 
85
    topo_sort,
 
86
    )
56
87
 
57
88
 
58
89
def find_touching_revisions(branch, file_id):
70
101
    last_path = None
71
102
    revno = 1
72
103
    for revision_id in branch.revision_history():
73
 
        this_inv = branch.get_revision_inventory(revision_id)
 
104
        this_inv = branch.repository.get_revision_inventory(revision_id)
74
105
        if file_id in this_inv:
75
106
            this_ie = this_inv[file_id]
76
107
            this_path = this_inv.id2path(file_id)
99
130
        revno += 1
100
131
 
101
132
 
102
 
 
103
133
def _enumerate_history(branch):
104
134
    rh = []
105
135
    revno = 1
116
146
             direction='reverse',
117
147
             start_revision=None,
118
148
             end_revision=None,
119
 
             search=None):
 
149
             search=None,
 
150
             limit=None):
120
151
    """Write out human-readable log of commits to this branch.
121
152
 
122
153
    lf
138
169
 
139
170
    end_revision
140
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
141
178
    """
142
 
    from bzrlib.osutils import format_date
143
 
    from bzrlib.errors import BzrCheckError
144
 
    from bzrlib.textui import show_status
145
 
    
146
 
    from warnings import warn
147
 
 
 
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."""
148
203
    if not isinstance(lf, LogFormatter):
149
204
        warn("not a LogFormatter instance: %r" % lf)
150
205
 
151
206
    if specific_fileid:
152
 
        mutter('get log for file_id %r' % specific_fileid)
153
 
 
 
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)
154
216
    if search is not None:
155
 
        import re
156
217
        searchRE = re.compile(search, re.IGNORECASE)
157
218
    else:
158
219
        searchRE = None
159
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
    """
160
338
    which_revs = _enumerate_history(branch)
161
 
    
 
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 
162
349
    if start_revision is None:
163
 
        start_revision = 1
 
350
        start_revno = 1
164
351
    else:
165
 
        branch.check_real_revno(start_revision)
 
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
166
358
    
 
359
    end_rev_id = None
167
360
    if end_revision is None:
168
 
        end_revision = len(which_revs)
 
361
        end_revno = len(which_revs)
169
362
    else:
170
 
        branch.check_real_revno(end_revision)
 
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.")
171
376
 
172
377
    # list indexes are 0-based; revisions are 1-based
173
 
    cut_revs = which_revs[(start_revision-1):(end_revision)]
174
 
 
175
 
    if direction == 'reverse':
176
 
        cut_revs.reverse()
177
 
    elif direction == 'forward':
178
 
        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)
179
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
    parent_map = dict(((key, value) for key, value in
 
468
        graph.iter_ancestry(mainline_revisions) if value is not None))
 
469
    sorted_rev_list = topo_sort(parent_map.items())
 
470
    ancestry = {}
 
471
    for rev in sorted_rev_list:
 
472
        parents = parent_map[rev]
 
473
        if rev not in weave_modifed_revisions and len(parents) == 1:
 
474
            # We will not be adding anything new, so just use a reference to
 
475
            # the parent ancestry.
 
476
            rev_ancestry = ancestry[parents[0]]
 
477
        else:
 
478
            rev_ancestry = set()
 
479
            if rev in weave_modifed_revisions:
 
480
                rev_ancestry.add(rev)
 
481
            for parent in parents:
 
482
                rev_ancestry = rev_ancestry.union(ancestry[parent])
 
483
        ancestry[rev] = rev_ancestry
 
484
 
 
485
    def is_merging_rev(r):
 
486
        parents = parent_map[r]
 
487
        if len(parents) > 1:
 
488
            leftparent = parents[0]
 
489
            for rightparent in parents[1:]:
 
490
                if not ancestry[leftparent].issuperset(
 
491
                        ancestry[rightparent]):
 
492
                    return True
 
493
        return False
 
494
 
 
495
    # filter from the view the revisions that did not change or merge 
 
496
    # the specific file
 
497
    return [(r, n, d) for r, n, d in view_revs_iter
 
498
            if r in weave_modifed_revisions or is_merging_rev(r)]
 
499
 
 
500
 
 
501
def get_view_revisions(mainline_revs, rev_nos, branch, direction,
 
502
                       include_merges=True):
 
503
    """Produce an iterator of revisions to show
 
504
    :return: an iterator of (revision_id, revno, merge_depth)
 
505
    (if there is no revno for a revision, None is supplied)
 
506
    """
 
507
    if include_merges is False:
 
508
        revision_ids = mainline_revs[1:]
 
509
        if direction == 'reverse':
 
510
            revision_ids.reverse()
 
511
        for revision_id in revision_ids:
 
512
            yield revision_id, str(rev_nos[revision_id]), 0
 
513
        return
 
514
    graph = branch.repository.get_graph()
 
515
    # This asks for all mainline revisions, which means we only have to spider
 
516
    # sideways, rather than depth history. That said, its still size-of-history
 
517
    # and should be addressed.
 
518
    parent_map = dict(((key, value) for key, value in
 
519
        graph.iter_ancestry(mainline_revs) if value is not None))
 
520
    # filter out ghosts; merge_sort errors on ghosts.
 
521
    rev_graph = _strip_NULL_ghosts(parent_map)
 
522
    merge_sorted_revisions = merge_sort(
 
523
        rev_graph,
 
524
        mainline_revs[-1],
 
525
        mainline_revs,
 
526
        generate_revno=True)
 
527
 
 
528
    if direction == 'forward':
 
529
        # forward means oldest first.
 
530
        merge_sorted_revisions = reverse_by_depth(merge_sorted_revisions)
 
531
    elif direction != 'reverse':
180
532
        raise ValueError('invalid direction %r' % direction)
181
533
 
182
 
    for revno, rev_id in cut_revs:
183
 
        if verbose or specific_fileid:
184
 
            delta = branch.get_revision_delta(revno)
185
 
            
186
 
        if specific_fileid:
187
 
            if not delta.touches_file_id(specific_fileid):
188
 
                continue
189
 
 
190
 
        if not verbose:
191
 
            # although we calculated it, throw it away without display
192
 
            delta = None
193
 
 
194
 
        rev = branch.get_revision(rev_id)
195
 
 
196
 
        if searchRE:
197
 
            if not searchRE.search(rev.message):
198
 
                continue
199
 
 
200
 
        lf.show(revno, rev, delta)
201
 
 
202
 
 
203
 
 
204
 
def deltas_for_log_dummy(branch, which_revs):
205
 
    """Return all the revisions without intermediate deltas.
206
 
 
207
 
    Useful for log commands that won't need the delta information.
208
 
    """
209
 
    
210
 
    for revno, revision_id in which_revs:
211
 
        yield revno, branch.get_revision(revision_id), None
212
 
 
213
 
 
214
 
def deltas_for_log_reverse(branch, which_revs):
215
 
    """Compute deltas for display in latest-to-earliest order.
216
 
 
217
 
    branch
218
 
        Branch to traverse
219
 
 
220
 
    which_revs
221
 
        Sequence of (revno, revision_id) for the subset of history to examine
222
 
 
223
 
    returns 
224
 
        Sequence of (revno, rev, delta)
225
 
 
226
 
    The delta is from the given revision to the next one in the
227
 
    sequence, which makes sense if the log is being displayed from
228
 
    newest to oldest.
229
 
    """
230
 
    last_revno = last_revision_id = last_tree = None
231
 
    for revno, revision_id in which_revs:
232
 
        this_tree = branch.revision_tree(revision_id)
233
 
        this_revision = branch.get_revision(revision_id)
234
 
        
235
 
        if last_revno:
236
 
            yield last_revno, last_revision, compare_trees(this_tree, last_tree, False)
237
 
 
238
 
        this_tree = EmptyTree(branch.get_root_id())
239
 
 
240
 
        last_revno = revno
241
 
        last_revision = this_revision
242
 
        last_tree = this_tree
243
 
 
244
 
    if last_revno:
245
 
        if last_revno == 1:
246
 
            this_tree = EmptyTree(branch.get_root_id())
 
534
    for sequence, rev_id, merge_depth, revno, end_of_merge in merge_sorted_revisions:
 
535
        yield rev_id, '.'.join(map(str, revno)), merge_depth
 
536
 
 
537
 
 
538
def reverse_by_depth(merge_sorted_revisions, _depth=0):
 
539
    """Reverse revisions by depth.
 
540
 
 
541
    Revisions with a different depth are sorted as a group with the previous
 
542
    revision of that depth.  There may be no topological justification for this,
 
543
    but it looks much nicer.
 
544
    """
 
545
    zd_revisions = []
 
546
    for val in merge_sorted_revisions:
 
547
        if val[2] == _depth:
 
548
            zd_revisions.append([val])
247
549
        else:
248
 
            this_revno = last_revno - 1
249
 
            this_revision_id = branch.revision_history()[this_revno]
250
 
            this_tree = branch.revision_tree(this_revision_id)
251
 
        yield last_revno, last_revision, compare_trees(this_tree, last_tree, False)
252
 
 
253
 
 
254
 
def deltas_for_log_forward(branch, which_revs):
255
 
    """Compute deltas for display in forward log.
256
 
 
257
 
    Given a sequence of (revno, revision_id) pairs, return
258
 
    (revno, rev, delta).
259
 
 
260
 
    The delta is from the given revision to the next one in the
261
 
    sequence, which makes sense if the log is being displayed from
262
 
    newest to oldest.
 
550
            assert val[2] > _depth
 
551
            zd_revisions[-1].append(val)
 
552
    for revisions in zd_revisions:
 
553
        if len(revisions) > 1:
 
554
            revisions[1:] = reverse_by_depth(revisions[1:], _depth + 1)
 
555
    zd_revisions.reverse()
 
556
    result = []
 
557
    for chunk in zd_revisions:
 
558
        result.extend(chunk)
 
559
    return result
 
560
 
 
561
 
 
562
class LogRevision(object):
 
563
    """A revision to be logged (by LogFormatter.log_revision).
 
564
 
 
565
    A simple wrapper for the attributes of a revision to be logged.
 
566
    The attributes may or may not be populated, as determined by the 
 
567
    logging options and the log formatter capabilities.
263
568
    """
264
 
    last_revno = last_revision_id = last_tree = None
265
 
    prev_tree = EmptyTree(branch.get_root_id())
266
 
 
267
 
    for revno, revision_id in which_revs:
268
 
        this_tree = branch.revision_tree(revision_id)
269
 
        this_revision = branch.get_revision(revision_id)
270
 
 
271
 
        if not last_revno:
272
 
            if revno == 1:
273
 
                last_tree = EmptyTree(branch.get_root_id())
274
 
            else:
275
 
                last_revno = revno - 1
276
 
                last_revision_id = branch.revision_history()[last_revno]
277
 
                last_tree = branch.revision_tree(last_revision_id)
278
 
 
279
 
        yield revno, this_revision, compare_trees(last_tree, this_tree, False)
280
 
 
281
 
        last_revno = revno
282
 
        last_revision = this_revision
283
 
        last_tree = this_tree
 
569
 
 
570
    def __init__(self, rev=None, revno=None, merge_depth=0, delta=None,
 
571
                 tags=None):
 
572
        self.rev = rev
 
573
        self.revno = revno
 
574
        self.merge_depth = merge_depth
 
575
        self.delta = delta
 
576
        self.tags = tags
284
577
 
285
578
 
286
579
class LogFormatter(object):
287
 
    """Abstract class to display log messages."""
 
580
    """Abstract class to display log messages.
 
581
 
 
582
    At a minimum, a derived class must implement the log_revision method.
 
583
 
 
584
    If the LogFormatter needs to be informed of the beginning or end of
 
585
    a log it should implement the begin_log and/or end_log hook methods.
 
586
 
 
587
    A LogFormatter should define the following supports_XXX flags 
 
588
    to indicate which LogRevision attributes it supports:
 
589
 
 
590
    - supports_delta must be True if this log formatter supports delta.
 
591
        Otherwise the delta attribute may not be populated.
 
592
    - supports_merge_revisions must be True if this log formatter supports 
 
593
        merge revisions.  If not, and if supports_single_merge_revisions is
 
594
        also not True, then only mainline revisions will be passed to the 
 
595
        formatter.
 
596
    - supports_single_merge_revision must be True if this log formatter
 
597
        supports logging only a single merge revision.  This flag is
 
598
        only relevant if supports_merge_revisions is not True.
 
599
    - supports_tags must be True if this log formatter supports tags.
 
600
        Otherwise the tags attribute may not be populated.
 
601
    """
 
602
 
288
603
    def __init__(self, to_file, show_ids=False, show_timezone='original'):
289
604
        self.to_file = to_file
290
605
        self.show_ids = show_ids
291
606
        self.show_timezone = show_timezone
292
607
 
293
 
 
294
 
    def show(self, revno, rev, delta):
295
 
        raise NotImplementedError('not implemented in abstract base')
296
 
        
297
 
 
298
 
 
299
 
 
 
608
# TODO: uncomment this block after show() has been removed.
 
609
# Until then defining log_revision would prevent _show_log calling show() 
 
610
# in legacy formatters.
 
611
#    def log_revision(self, revision):
 
612
#        """Log a revision.
 
613
#
 
614
#        :param  revision:   The LogRevision to be logged.
 
615
#        """
 
616
#        raise NotImplementedError('not implemented in abstract base')
 
617
 
 
618
    def short_committer(self, rev):
 
619
        name, address = config.parse_username(rev.committer)
 
620
        if name:
 
621
            return name
 
622
        return address
 
623
 
 
624
    def short_author(self, rev):
 
625
        name, address = config.parse_username(rev.get_apparent_author())
 
626
        if name:
 
627
            return name
 
628
        return address
300
629
 
301
630
 
302
631
class LongLogFormatter(LogFormatter):
303
 
    def show(self, revno, rev, delta):
304
 
        from osutils import format_date
305
 
 
 
632
 
 
633
    supports_merge_revisions = True
 
634
    supports_delta = True
 
635
    supports_tags = True
 
636
 
 
637
    def log_revision(self, revision):
 
638
        """Log a revision, either merged or not."""
 
639
        indent = '    ' * revision.merge_depth
306
640
        to_file = self.to_file
307
 
 
308
 
        print >>to_file,  '-' * 60
309
 
        print >>to_file,  'revno:', revno
 
641
        to_file.write(indent + '-' * 60 + '\n')
 
642
        if revision.revno is not None:
 
643
            to_file.write(indent + 'revno: %s\n' % (revision.revno,))
 
644
        if revision.tags:
 
645
            to_file.write(indent + 'tags: %s\n' % (', '.join(revision.tags)))
310
646
        if self.show_ids:
311
 
            print >>to_file,  'revision-id:', rev.revision_id
312
 
 
313
 
            for parent in rev.parents:
314
 
                print >>to_file, 'parent:', parent.revision_id
315
 
            
316
 
        print >>to_file,  'committer:', rev.committer
317
 
 
318
 
        date_str = format_date(rev.timestamp,
319
 
                               rev.timezone or 0,
 
647
            to_file.write(indent + 'revision-id: ' + revision.rev.revision_id)
 
648
            to_file.write('\n')
 
649
            for parent_id in revision.rev.parent_ids:
 
650
                to_file.write(indent + 'parent: %s\n' % (parent_id,))
 
651
 
 
652
        author = revision.rev.properties.get('author', None)
 
653
        if author is not None:
 
654
            to_file.write(indent + 'author: %s\n' % (author,))
 
655
        to_file.write(indent + 'committer: %s\n' % (revision.rev.committer,))
 
656
 
 
657
        branch_nick = revision.rev.properties.get('branch-nick', None)
 
658
        if branch_nick is not None:
 
659
            to_file.write(indent + 'branch nick: %s\n' % (branch_nick,))
 
660
 
 
661
        date_str = format_date(revision.rev.timestamp,
 
662
                               revision.rev.timezone or 0,
320
663
                               self.show_timezone)
321
 
        print >>to_file,  'timestamp: %s' % date_str
 
664
        to_file.write(indent + 'timestamp: %s\n' % (date_str,))
322
665
 
323
 
        print >>to_file,  'message:'
324
 
        if not rev.message:
325
 
            print >>to_file,  '  (no message)'
 
666
        to_file.write(indent + 'message:\n')
 
667
        if not revision.rev.message:
 
668
            to_file.write(indent + '  (no message)\n')
326
669
        else:
327
 
            for l in rev.message.split('\n'):
328
 
                print >>to_file,  '  ' + l
329
 
 
330
 
        if delta != None:
331
 
            delta.show(to_file, self.show_ids)
332
 
 
 
670
            message = revision.rev.message.rstrip('\r\n')
 
671
            for l in message.split('\n'):
 
672
                to_file.write(indent + '  %s\n' % (l,))
 
673
        if revision.delta is not None:
 
674
            revision.delta.show(to_file, self.show_ids, indent=indent)
333
675
 
334
676
 
335
677
class ShortLogFormatter(LogFormatter):
336
 
    def show(self, revno, rev, delta):
337
 
        from bzrlib.osutils import format_date
338
 
 
 
678
 
 
679
    supports_delta = True
 
680
    supports_single_merge_revision = True
 
681
 
 
682
    def log_revision(self, revision):
339
683
        to_file = self.to_file
340
 
 
341
 
        print >>to_file, "%5d %s\t%s" % (revno, rev.committer,
342
 
                format_date(rev.timestamp, rev.timezone or 0,
343
 
                            self.show_timezone))
 
684
        date_str = format_date(revision.rev.timestamp,
 
685
                               revision.rev.timezone or 0,
 
686
                               self.show_timezone)
 
687
        is_merge = ''
 
688
        if len(revision.rev.parent_ids) > 1:
 
689
            is_merge = ' [merge]'
 
690
        to_file.write("%5s %s\t%s%s\n" % (revision.revno,
 
691
                self.short_author(revision.rev),
 
692
                format_date(revision.rev.timestamp,
 
693
                            revision.rev.timezone or 0,
 
694
                            self.show_timezone, date_fmt="%Y-%m-%d",
 
695
                            show_offset=False),
 
696
                is_merge))
344
697
        if self.show_ids:
345
 
            print >>to_file,  '      revision-id:', rev.revision_id
346
 
        if not rev.message:
347
 
            print >>to_file,  '      (no message)'
 
698
            to_file.write('      revision-id:%s\n' % (revision.rev.revision_id,))
 
699
        if not revision.rev.message:
 
700
            to_file.write('      (no message)\n')
348
701
        else:
349
 
            for l in rev.message.split('\n'):
350
 
                print >>to_file,  '      ' + l
 
702
            message = revision.rev.message.rstrip('\r\n')
 
703
            for l in message.split('\n'):
 
704
                to_file.write('      %s\n' % (l,))
351
705
 
352
706
        # TODO: Why not show the modified files in a shorter form as
353
707
        # well? rewrap them single lines of appropriate length
354
 
        if delta != None:
355
 
            delta.show(to_file, self.show_ids)
356
 
        print
357
 
 
358
 
 
359
 
 
360
 
FORMATTERS = {'long': LongLogFormatter,
361
 
              'short': ShortLogFormatter,
362
 
              }
 
708
        if revision.delta is not None:
 
709
            revision.delta.show(to_file, self.show_ids)
 
710
        to_file.write('\n')
 
711
 
 
712
 
 
713
class LineLogFormatter(LogFormatter):
 
714
 
 
715
    supports_single_merge_revision = True
 
716
 
 
717
    def __init__(self, *args, **kwargs):
 
718
        super(LineLogFormatter, self).__init__(*args, **kwargs)
 
719
        self._max_chars = terminal_width() - 1
 
720
 
 
721
    def truncate(self, str, max_len):
 
722
        if len(str) <= max_len:
 
723
            return str
 
724
        return str[:max_len-3]+'...'
 
725
 
 
726
    def date_string(self, rev):
 
727
        return format_date(rev.timestamp, rev.timezone or 0, 
 
728
                           self.show_timezone, date_fmt="%Y-%m-%d",
 
729
                           show_offset=False)
 
730
 
 
731
    def message(self, rev):
 
732
        if not rev.message:
 
733
            return '(no message)'
 
734
        else:
 
735
            return rev.message
 
736
 
 
737
    def log_revision(self, revision):
 
738
        self.to_file.write(self.log_string(revision.revno, revision.rev,
 
739
                                              self._max_chars))
 
740
        self.to_file.write('\n')
 
741
 
 
742
    def log_string(self, revno, rev, max_chars):
 
743
        """Format log info into one string. Truncate tail of string
 
744
        :param  revno:      revision number (int) or None.
 
745
                            Revision numbers counts from 1.
 
746
        :param  rev:        revision info object
 
747
        :param  max_chars:  maximum length of resulting string
 
748
        :return:            formatted truncated string
 
749
        """
 
750
        out = []
 
751
        if revno:
 
752
            # show revno only when is not None
 
753
            out.append("%s:" % revno)
 
754
        out.append(self.truncate(self.short_author(rev), 20))
 
755
        out.append(self.date_string(rev))
 
756
        out.append(rev.get_summary())
 
757
        return self.truncate(" ".join(out).rstrip('\n'), max_chars)
 
758
 
 
759
 
 
760
def line_log(rev, max_chars):
 
761
    lf = LineLogFormatter(None)
 
762
    return lf.log_string(None, rev, max_chars)
 
763
 
 
764
 
 
765
class LogFormatterRegistry(registry.Registry):
 
766
    """Registry for log formatters"""
 
767
 
 
768
    def make_formatter(self, name, *args, **kwargs):
 
769
        """Construct a formatter from arguments.
 
770
 
 
771
        :param name: Name of the formatter to construct.  'short', 'long' and
 
772
            'line' are built-in.
 
773
        """
 
774
        return self.get(name)(*args, **kwargs)
 
775
 
 
776
    def get_default(self, branch):
 
777
        return self.get(branch.get_config().log_format())
 
778
 
 
779
 
 
780
log_formatter_registry = LogFormatterRegistry()
 
781
 
 
782
 
 
783
log_formatter_registry.register('short', ShortLogFormatter,
 
784
                                'Moderately short log format')
 
785
log_formatter_registry.register('long', LongLogFormatter,
 
786
                                'Detailed log format')
 
787
log_formatter_registry.register('line', LineLogFormatter,
 
788
                                'Log format with one line per revision')
 
789
 
 
790
 
 
791
def register_formatter(name, formatter):
 
792
    log_formatter_registry.register(name, formatter)
363
793
 
364
794
 
365
795
def log_formatter(name, *args, **kwargs):
366
 
    from bzrlib.errors import BzrCommandError
367
 
    
 
796
    """Construct a formatter from arguments.
 
797
 
 
798
    name -- Name of the formatter to construct; currently 'long', 'short' and
 
799
        'line' are supported.
 
800
    """
368
801
    try:
369
 
        return FORMATTERS[name](*args, **kwargs)
370
 
    except IndexError:
 
802
        return log_formatter_registry.make_formatter(name, *args, **kwargs)
 
803
    except KeyError:
371
804
        raise BzrCommandError("unknown log formatter: %r" % name)
372
805
 
 
806
 
373
807
def show_one_log(revno, rev, delta, verbose, to_file, show_timezone):
374
 
    # deprecated; for compatability
 
808
    # deprecated; for compatibility
375
809
    lf = LongLogFormatter(to_file=to_file, show_timezone=show_timezone)
376
810
    lf.show(revno, rev, delta)
 
811
 
 
812
 
 
813
def show_changed_revisions(branch, old_rh, new_rh, to_file=None,
 
814
                           log_format='long'):
 
815
    """Show the change in revision history comparing the old revision history to the new one.
 
816
 
 
817
    :param branch: The branch where the revisions exist
 
818
    :param old_rh: The old revision history
 
819
    :param new_rh: The new revision history
 
820
    :param to_file: A file to write the results to. If None, stdout will be used
 
821
    """
 
822
    if to_file is None:
 
823
        to_file = codecs.getwriter(get_terminal_encoding())(sys.stdout,
 
824
            errors='replace')
 
825
    lf = log_formatter(log_format,
 
826
                       show_ids=False,
 
827
                       to_file=to_file,
 
828
                       show_timezone='original')
 
829
 
 
830
    # This is the first index which is different between
 
831
    # old and new
 
832
    base_idx = None
 
833
    for i in xrange(max(len(new_rh),
 
834
                        len(old_rh))):
 
835
        if (len(new_rh) <= i
 
836
            or len(old_rh) <= i
 
837
            or new_rh[i] != old_rh[i]):
 
838
            base_idx = i
 
839
            break
 
840
 
 
841
    if base_idx is None:
 
842
        to_file.write('Nothing seems to have changed\n')
 
843
        return
 
844
    ## TODO: It might be nice to do something like show_log
 
845
    ##       and show the merged entries. But since this is the
 
846
    ##       removed revisions, it shouldn't be as important
 
847
    if base_idx < len(old_rh):
 
848
        to_file.write('*'*60)
 
849
        to_file.write('\nRemoved Revisions:\n')
 
850
        for i in range(base_idx, len(old_rh)):
 
851
            rev = branch.repository.get_revision(old_rh[i])
 
852
            lr = LogRevision(rev, i+1, 0, None)
 
853
            lf.log_revision(lr)
 
854
        to_file.write('*'*60)
 
855
        to_file.write('\n\n')
 
856
    if base_idx < len(new_rh):
 
857
        to_file.write('Added Revisions:\n')
 
858
        show_log(branch,
 
859
                 lf,
 
860
                 None,
 
861
                 verbose=False,
 
862
                 direction='forward',
 
863
                 start_revision=base_idx+1,
 
864
                 end_revision=len(new_rh),
 
865
                 search=None)
 
866