~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/log.py

  • Committer: Martin Pool
  • Date: 2007-06-21 04:27:47 UTC
  • mto: This revision was merged to the branch mainline in revision 2551.
  • Revision ID: mbp@sourcefrog.net-20070621042747-e3g0tdn8if750mv5
More commit specs

Show diffs side-by-side

added added

removed removed

Lines of Context:
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 left-most parent, not the delta relative to the last
 
45
relative to its mainline 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
 
    )
 
52
# TODO: option to show delta summaries for merged-in revisions
 
53
 
 
54
from itertools import izip
56
55
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
 
 
65
 
from bzrlib import (
66
 
    config,
67
 
    errors,
68
 
    repository as _mod_repository,
69
 
    revision as _mod_revision,
70
 
    revisionspec,
71
 
    trace,
72
 
    tsort,
73
 
    )
74
 
""")
75
56
 
76
57
from bzrlib import (
77
58
    registry,
78
 
    )
79
 
from bzrlib.osutils import (
80
 
    format_date,
81
 
    get_terminal_encoding,
82
 
    terminal_width,
 
59
    symbol_versioning,
 
60
    )
 
61
import bzrlib.errors as errors
 
62
from bzrlib.symbol_versioning import (
 
63
    deprecated_method,
 
64
    zero_eleven,
 
65
    zero_seventeen,
 
66
    )
 
67
from bzrlib.trace import mutter
 
68
from bzrlib.tsort import (
 
69
    merge_sort,
 
70
    topo_sort,
83
71
    )
84
72
 
85
73
 
127
115
        revno += 1
128
116
 
129
117
 
 
118
 
130
119
def _enumerate_history(branch):
131
120
    rh = []
132
121
    revno = 1
186
175
    finally:
187
176
        branch.unlock()
188
177
 
189
 
 
190
178
def _show_log(branch,
191
179
             lf,
192
180
             specific_fileid=None,
197
185
             search=None,
198
186
             limit=None):
199
187
    """Worker function for show_log - see show_log."""
 
188
    from bzrlib.osutils import format_date
 
189
    from bzrlib.errors import BzrCheckError
 
190
    
 
191
    from warnings import warn
 
192
 
200
193
    if not isinstance(lf, LogFormatter):
201
194
        warn("not a LogFormatter instance: %r" % lf)
202
195
 
203
196
    if specific_fileid:
204
 
        trace.mutter('get log for file_id %r', specific_fileid)
205
 
    generate_merge_revisions = getattr(lf, 'supports_merge_revisions', False)
206
 
    allow_single_merge_revision = getattr(lf,
207
 
        'supports_single_merge_revision', False)
208
 
    view_revisions = calculate_view_revisions(branch, start_revision,
209
 
                                              end_revision, direction,
210
 
                                              specific_fileid,
211
 
                                              generate_merge_revisions,
212
 
                                              allow_single_merge_revision)
 
197
        mutter('get log for file_id %r', specific_fileid)
 
198
 
 
199
    if search is not None:
 
200
        import re
 
201
        searchRE = re.compile(search, re.IGNORECASE)
 
202
    else:
 
203
        searchRE = None
 
204
 
 
205
    which_revs = _enumerate_history(branch)
 
206
    
 
207
    if start_revision is None:
 
208
        start_revision = 1
 
209
    else:
 
210
        branch.check_real_revno(start_revision)
 
211
    
 
212
    if end_revision is None:
 
213
        end_revision = len(which_revs)
 
214
    else:
 
215
        branch.check_real_revno(end_revision)
 
216
 
 
217
    # list indexes are 0-based; revisions are 1-based
 
218
    cut_revs = which_revs[(start_revision-1):(end_revision)]
 
219
    if not cut_revs:
 
220
        return
 
221
 
 
222
    # convert the revision history to a dictionary:
 
223
    rev_nos = dict((k, v) for v, k in cut_revs)
 
224
 
 
225
    # override the mainline to look like the revision history.
 
226
    mainline_revs = [revision_id for index, revision_id in cut_revs]
 
227
    if cut_revs[0][0] == 1:
 
228
        mainline_revs.insert(0, None)
 
229
    else:
 
230
        mainline_revs.insert(0, which_revs[start_revision-2][1])
 
231
    legacy_lf = getattr(lf, 'log_revision', None) is None
 
232
    if legacy_lf:
 
233
        # pre-0.17 formatters use show for mainline revisions.
 
234
        # how should we show merged revisions ?
 
235
        #   pre-0.11 api: show_merge
 
236
        #   0.11-0.16 api: show_merge_revno
 
237
        show_merge_revno = getattr(lf, 'show_merge_revno', None)
 
238
        show_merge = getattr(lf, 'show_merge', None)
 
239
        if show_merge is None and show_merge_revno is None:
 
240
            # no merged-revno support
 
241
            generate_merge_revisions = False
 
242
        else:
 
243
            generate_merge_revisions = True
 
244
        # tell developers to update their code
 
245
        symbol_versioning.warn('LogFormatters should provide log_revision '
 
246
            'instead of show and show_merge_revno since bzr 0.17.',
 
247
            DeprecationWarning, stacklevel=3)
 
248
    else:
 
249
        generate_merge_revisions = getattr(lf, 'supports_merge_revisions', 
 
250
                                           False)
 
251
    view_revs_iter = get_view_revisions(mainline_revs, rev_nos, branch,
 
252
                          direction, include_merges=generate_merge_revisions)
 
253
    if specific_fileid:
 
254
        view_revisions = _get_revisions_touching_file_id(branch,
 
255
                                                         specific_fileid,
 
256
                                                         mainline_revs,
 
257
                                                         view_revs_iter)
 
258
    else:
 
259
        view_revisions = list(view_revs_iter)
 
260
 
213
261
    rev_tag_dict = {}
214
262
    generate_tags = getattr(lf, 'supports_tags', False)
215
263
    if generate_tags:
218
266
 
219
267
    generate_delta = verbose and getattr(lf, 'supports_delta', False)
220
268
 
 
269
    def iter_revisions():
 
270
        # r = revision, n = revno, d = merge depth
 
271
        revision_ids = [r for r, n, d in view_revisions]
 
272
        zeros = set(r for r, n, d in view_revisions if d == 0)
 
273
        num = 9
 
274
        repository = branch.repository
 
275
        while revision_ids:
 
276
            cur_deltas = {}
 
277
            revisions = repository.get_revisions(revision_ids[:num])
 
278
            if generate_delta:
 
279
                delta_revisions = [r for r in revisions if
 
280
                                   r.revision_id in zeros]
 
281
                deltas = repository.get_deltas_for_revisions(delta_revisions)
 
282
                cur_deltas = dict(izip((r.revision_id for r in 
 
283
                                        delta_revisions), deltas))
 
284
            for revision in revisions:
 
285
                # The delta value will be None unless
 
286
                # 1. verbose is specified, and
 
287
                # 2. the revision is a mainline revision
 
288
                yield revision, cur_deltas.get(revision.revision_id)
 
289
            revision_ids  = revision_ids[num:]
 
290
            num = min(int(num * 1.5), 200)
 
291
 
221
292
    # now we just print all the revisions
222
293
    log_count = 0
223
 
    revision_iterator = make_log_rev_iterator(branch, view_revisions,
224
 
        generate_delta, search)
225
 
    for revs in revision_iterator:
226
 
        for (rev_id, revno, merge_depth), rev, delta in revs:
 
294
    for ((rev_id, revno, merge_depth), (rev, delta)) in \
 
295
         izip(view_revisions, iter_revisions()):
 
296
 
 
297
        if searchRE:
 
298
            if not searchRE.search(rev.message):
 
299
                continue
 
300
 
 
301
        if not legacy_lf:
227
302
            lr = LogRevision(rev, revno, merge_depth, delta,
228
303
                             rev_tag_dict.get(rev_id))
229
304
            lf.log_revision(lr)
230
 
            if limit:
231
 
                log_count += 1
232
 
                if log_count >= limit:
233
 
                    return
234
 
 
235
 
 
236
 
def calculate_view_revisions(branch, start_revision, end_revision, direction,
237
 
                             specific_fileid, generate_merge_revisions,
238
 
                             allow_single_merge_revision):
239
 
    if (not generate_merge_revisions and start_revision is end_revision is
240
 
        None and direction == 'reverse' and specific_fileid is None):
241
 
        return _linear_view_revisions(branch)
242
 
 
243
 
    mainline_revs, rev_nos, start_rev_id, end_rev_id = \
244
 
        _get_mainline_revs(branch, start_revision, end_revision)
245
 
    if not mainline_revs:
246
 
        return []
247
 
 
248
 
    if direction == 'reverse':
249
 
        start_rev_id, end_rev_id = end_rev_id, start_rev_id
250
 
 
251
 
    generate_single_revision = False
252
 
    if ((not generate_merge_revisions)
253
 
        and ((start_rev_id and (start_rev_id not in rev_nos))
254
 
            or (end_rev_id and (end_rev_id not in rev_nos)))):
255
 
        generate_single_revision = ((start_rev_id == end_rev_id)
256
 
            and allow_single_merge_revision)
257
 
        if not generate_single_revision:
258
 
            raise errors.BzrCommandError('Selected log formatter only supports'
259
 
                ' mainline revisions.')
260
 
        generate_merge_revisions = generate_single_revision
261
 
    view_revs_iter = get_view_revisions(mainline_revs, rev_nos, branch,
262
 
                          direction, include_merges=generate_merge_revisions)
263
 
    view_revisions = _filter_revision_range(list(view_revs_iter),
264
 
                                            start_rev_id,
265
 
                                            end_rev_id)
266
 
    if view_revisions and generate_single_revision:
267
 
        view_revisions = view_revisions[0:1]
268
 
    if specific_fileid:
269
 
        view_revisions = _filter_revisions_touching_file_id(branch,
270
 
                                                         specific_fileid,
271
 
                                                         mainline_revs,
272
 
                                                         view_revisions)
273
 
 
274
 
    # rebase merge_depth - unless there are no revisions or 
275
 
    # either the first or last revision have merge_depth = 0.
276
 
    if view_revisions and view_revisions[0][2] and view_revisions[-1][2]:
277
 
        min_depth = min([d for r,n,d in view_revisions])
278
 
        if min_depth != 0:
279
 
            view_revisions = [(r,n,d-min_depth) for r,n,d in view_revisions]
280
 
    return view_revisions
281
 
 
282
 
 
283
 
def _linear_view_revisions(branch):
284
 
    start_revno, start_revision_id = branch.last_revision_info()
285
 
    repo = branch.repository
286
 
    revision_ids = repo.iter_reverse_revision_history(start_revision_id)
287
 
    for num, revision_id in enumerate(revision_ids):
288
 
        yield revision_id, str(start_revno - num), 0
289
 
 
290
 
 
291
 
def make_log_rev_iterator(branch, view_revisions, generate_delta, search):
292
 
    """Create a revision iterator for log.
293
 
 
294
 
    :param branch: The branch being logged.
295
 
    :param view_revisions: The revisions being viewed.
296
 
    :param generate_delta: Whether to generate a delta for each revision.
297
 
    :param search: A user text search string.
298
 
    :return: An iterator over lists of ((rev_id, revno, merge_depth), rev,
299
 
        delta).
300
 
    """
301
 
    # Convert view_revisions into (view, None, None) groups to fit with
302
 
    # the standard interface here.
303
 
    if type(view_revisions) == list:
304
 
        # A single batch conversion is faster than many incremental ones.
305
 
        # As we have all the data, do a batch conversion.
306
 
        nones = [None] * len(view_revisions)
307
 
        log_rev_iterator = iter([zip(view_revisions, nones, nones)])
308
 
    else:
309
 
        def _convert():
310
 
            for view in view_revisions:
311
 
                yield (view, None, None)
312
 
        log_rev_iterator = iter([_convert()])
313
 
    for adapter in log_adapters:
314
 
        log_rev_iterator = adapter(branch, generate_delta, search,
315
 
            log_rev_iterator)
316
 
    return log_rev_iterator
317
 
 
318
 
 
319
 
def _make_search_filter(branch, generate_delta, search, log_rev_iterator):
320
 
    """Create a filtered iterator of log_rev_iterator matching on a regex.
321
 
 
322
 
    :param branch: The branch being logged.
323
 
    :param generate_delta: Whether to generate a delta for each revision.
324
 
    :param search: A user text search string.
325
 
    :param log_rev_iterator: An input iterator containing all revisions that
326
 
        could be displayed, in lists.
327
 
    :return: An iterator over lists of ((rev_id, revno, merge_depth), rev,
328
 
        delta).
329
 
    """
330
 
    if search is None:
331
 
        return log_rev_iterator
332
 
    # Compile the search now to get early errors.
333
 
    searchRE = re.compile(search, re.IGNORECASE)
334
 
    return _filter_message_re(searchRE, log_rev_iterator)
335
 
 
336
 
 
337
 
def _filter_message_re(searchRE, log_rev_iterator):
338
 
    for revs in log_rev_iterator:
339
 
        new_revs = []
340
 
        for (rev_id, revno, merge_depth), rev, delta in revs:
341
 
            if searchRE.search(rev.message):
342
 
                new_revs.append(((rev_id, revno, merge_depth), rev, delta))
343
 
        yield new_revs
344
 
 
345
 
 
346
 
def _make_delta_filter(branch, generate_delta, search, log_rev_iterator):
347
 
    """Add revision deltas to a log iterator if needed.
348
 
 
349
 
    :param branch: The branch being logged.
350
 
    :param generate_delta: Whether to generate a delta for each revision.
351
 
    :param search: A user text search string.
352
 
    :param log_rev_iterator: An input iterator containing all revisions that
353
 
        could be displayed, in lists.
354
 
    :return: An iterator over lists of ((rev_id, revno, merge_depth), rev,
355
 
        delta).
356
 
    """
357
 
    if not generate_delta:
358
 
        return log_rev_iterator
359
 
    return _generate_deltas(branch.repository, log_rev_iterator)
360
 
 
361
 
 
362
 
def _generate_deltas(repository, log_rev_iterator):
363
 
    """Create deltas for each batch of revisions in log_rev_iterator."""
364
 
    for revs in log_rev_iterator:
365
 
        revisions = [rev[1] for rev in revs]
366
 
        deltas = repository.get_deltas_for_revisions(revisions)
367
 
        revs = [(rev[0], rev[1], delta) for rev, delta in izip(revs, deltas)]
368
 
        yield revs
369
 
 
370
 
 
371
 
def _make_revision_objects(branch, generate_delta, search, log_rev_iterator):
372
 
    """Extract revision objects from the repository
373
 
 
374
 
    :param branch: The branch being logged.
375
 
    :param generate_delta: Whether to generate a delta for each revision.
376
 
    :param search: A user text search string.
377
 
    :param log_rev_iterator: An input iterator containing all revisions that
378
 
        could be displayed, in lists.
379
 
    :return: An iterator over lists of ((rev_id, revno, merge_depth), rev,
380
 
        delta).
381
 
    """
382
 
    repository = branch.repository
383
 
    for revs in log_rev_iterator:
384
 
        # r = revision_id, n = revno, d = merge depth
385
 
        revision_ids = [view[0] for view, _, _ in revs]
386
 
        revisions = repository.get_revisions(revision_ids)
387
 
        revs = [(rev[0], revision, rev[2]) for rev, revision in
388
 
            izip(revs, revisions)]
389
 
        yield revs
390
 
 
391
 
 
392
 
def _make_batch_filter(branch, generate_delta, search, log_rev_iterator):
393
 
    """Group up a single large batch into smaller ones.
394
 
 
395
 
    :param branch: The branch being logged.
396
 
    :param generate_delta: Whether to generate a delta for each revision.
397
 
    :param search: A user text search string.
398
 
    :param log_rev_iterator: An input iterator containing all revisions that
399
 
        could be displayed, in lists.
400
 
    :return: An iterator over lists of ((rev_id, revno, merge_depth), rev, delta).
401
 
    """
402
 
    repository = branch.repository
403
 
    num = 9
404
 
    for batch in log_rev_iterator:
405
 
        batch = iter(batch)
406
 
        while True:
407
 
            step = [detail for _, detail in zip(range(num), batch)]
408
 
            if len(step) == 0:
 
305
        else:
 
306
            # support for legacy (pre-0.17) LogFormatters
 
307
            if merge_depth == 0:
 
308
                if generate_tags:
 
309
                    lf.show(revno, rev, delta, rev_tag_dict.get(rev_id))
 
310
                else:
 
311
                    lf.show(revno, rev, delta)
 
312
            else:
 
313
                if show_merge_revno is None:
 
314
                    lf.show_merge(rev, merge_depth)
 
315
                else:
 
316
                    if generate_tags:
 
317
                        lf.show_merge_revno(rev, merge_depth, revno,
 
318
                                            rev_tag_dict.get(rev_id))
 
319
                    else:
 
320
                        lf.show_merge_revno(rev, merge_depth, revno)
 
321
        if limit:
 
322
            log_count += 1
 
323
            if log_count >= limit:
409
324
                break
410
 
            yield step
411
 
            num = min(int(num * 1.5), 200)
412
 
 
413
 
 
414
 
def _get_mainline_revs(branch, start_revision, end_revision):
415
 
    """Get the mainline revisions from the branch.
416
 
    
417
 
    Generates the list of mainline revisions for the branch.
418
 
    
419
 
    :param  branch: The branch containing the revisions. 
420
 
 
421
 
    :param  start_revision: The first revision to be logged.
422
 
            For backwards compatibility this may be a mainline integer revno,
423
 
            but for merge revision support a RevisionInfo is expected.
424
 
 
425
 
    :param  end_revision: The last revision to be logged.
426
 
            For backwards compatibility this may be a mainline integer revno,
427
 
            but for merge revision support a RevisionInfo is expected.
428
 
 
429
 
    :return: A (mainline_revs, rev_nos, start_rev_id, end_rev_id) tuple.
430
 
    """
431
 
    branch_revno, branch_last_revision = branch.last_revision_info()
432
 
    if branch_revno == 0:
433
 
        return None, None, None, None
434
 
 
435
 
    # For mainline generation, map start_revision and end_revision to 
436
 
    # mainline revnos. If the revision is not on the mainline choose the 
437
 
    # appropriate extreme of the mainline instead - the extra will be 
438
 
    # filtered later.
439
 
    # Also map the revisions to rev_ids, to be used in the later filtering
440
 
    # stage.
441
 
    start_rev_id = None 
442
 
    if start_revision is None:
443
 
        start_revno = 1
444
 
    else:
445
 
        if isinstance(start_revision, revisionspec.RevisionInfo):
446
 
            start_rev_id = start_revision.rev_id
447
 
            start_revno = start_revision.revno or 1
448
 
        else:
449
 
            branch.check_real_revno(start_revision)
450
 
            start_revno = start_revision
451
 
    
452
 
    end_rev_id = None
453
 
    if end_revision is None:
454
 
        end_revno = branch_revno
455
 
    else:
456
 
        if isinstance(end_revision, revisionspec.RevisionInfo):
457
 
            end_rev_id = end_revision.rev_id
458
 
            end_revno = end_revision.revno or branch_revno
459
 
        else:
460
 
            branch.check_real_revno(end_revision)
461
 
            end_revno = end_revision
462
 
 
463
 
    if ((start_rev_id == _mod_revision.NULL_REVISION)
464
 
        or (end_rev_id == _mod_revision.NULL_REVISION)):
465
 
        raise errors.BzrCommandError('Logging revision 0 is invalid.')
466
 
    if start_revno > end_revno:
467
 
        raise errors.BzrCommandError("Start revision must be older than "
468
 
                                     "the end revision.")
469
 
 
470
 
    if end_revno < start_revno:
471
 
        return None, None, None, None
472
 
    cur_revno = branch_revno
473
 
    rev_nos = {}
474
 
    mainline_revs = []
475
 
    for revision_id in branch.repository.iter_reverse_revision_history(
476
 
                        branch_last_revision):
477
 
        if cur_revno < start_revno:
478
 
            # We have gone far enough, but we always add 1 more revision
479
 
            rev_nos[revision_id] = cur_revno
480
 
            mainline_revs.append(revision_id)
481
 
            break
482
 
        if cur_revno <= end_revno:
483
 
            rev_nos[revision_id] = cur_revno
484
 
            mainline_revs.append(revision_id)
485
 
        cur_revno -= 1
486
 
    else:
487
 
        # We walked off the edge of all revisions, so we add a 'None' marker
488
 
        mainline_revs.append(None)
489
 
 
490
 
    mainline_revs.reverse()
491
 
 
492
 
    # override the mainline to look like the revision history.
493
 
    return mainline_revs, rev_nos, start_rev_id, end_rev_id
494
 
 
495
 
 
496
 
def _filter_revision_range(view_revisions, start_rev_id, end_rev_id):
497
 
    """Filter view_revisions based on revision ranges.
498
 
 
499
 
    :param view_revisions: A list of (revision_id, dotted_revno, merge_depth) 
500
 
            tuples to be filtered.
501
 
 
502
 
    :param start_rev_id: If not NONE specifies the first revision to be logged.
503
 
            If NONE then all revisions up to the end_rev_id are logged.
504
 
 
505
 
    :param end_rev_id: If not NONE specifies the last revision to be logged.
506
 
            If NONE then all revisions up to the end of the log are logged.
507
 
 
508
 
    :return: The filtered view_revisions.
509
 
    """
510
 
    if start_rev_id or end_rev_id: 
511
 
        revision_ids = [r for r, n, d in view_revisions]
512
 
        if start_rev_id:
513
 
            start_index = revision_ids.index(start_rev_id)
514
 
        else:
515
 
            start_index = 0
516
 
        if start_rev_id == end_rev_id:
517
 
            end_index = start_index
518
 
        else:
519
 
            if end_rev_id:
520
 
                end_index = revision_ids.index(end_rev_id)
521
 
            else:
522
 
                end_index = len(view_revisions) - 1
523
 
        # To include the revisions merged into the last revision, 
524
 
        # extend end_rev_id down to, but not including, the next rev
525
 
        # with the same or lesser merge_depth
526
 
        end_merge_depth = view_revisions[end_index][2]
527
 
        try:
528
 
            for index in xrange(end_index+1, len(view_revisions)+1):
529
 
                if view_revisions[index][2] <= end_merge_depth:
530
 
                    end_index = index - 1
531
 
                    break
532
 
        except IndexError:
533
 
            # if the search falls off the end then log to the end as well
534
 
            end_index = len(view_revisions) - 1
535
 
        view_revisions = view_revisions[start_index:end_index+1]
536
 
    return view_revisions
537
 
 
538
 
 
539
 
def _filter_revisions_touching_file_id(branch, file_id, mainline_revisions,
540
 
                                       view_revs_iter):
 
325
 
 
326
 
 
327
def _get_revisions_touching_file_id(branch, file_id, mainline_revisions,
 
328
                                    view_revs_iter):
541
329
    """Return the list of revision ids which touch a given file id.
542
330
 
543
 
    The function filters view_revisions and returns a subset.
544
331
    This includes the revisions which directly change the file id,
545
332
    and the revisions which merge these changes. So if the
546
333
    revision graph is::
557
344
    :return: A list of (revision_id, dotted_revno, merge_depth) tuples.
558
345
    """
559
346
    # find all the revisions that change the specific file
 
347
    file_weave = branch.repository.weave_store.get_weave(file_id,
 
348
                branch.repository.get_transaction())
 
349
    weave_modifed_revisions = set(file_weave.versions())
560
350
    # build the ancestry of each revision in the graph
561
351
    # - only listing the ancestors that change the specific file.
562
 
    graph = branch.repository.get_graph()
563
 
    # This asks for all mainline revisions, which means we only have to spider
564
 
    # sideways, rather than depth history. That said, its still size-of-history
565
 
    # and should be addressed.
566
 
    # mainline_revisions always includes an extra revision at the beginning, so
567
 
    # don't request it.
568
 
    parent_map = dict(((key, value) for key, value in
569
 
        graph.iter_ancestry(mainline_revisions[1:]) if value is not None))
570
 
    sorted_rev_list = tsort.topo_sort(parent_map.items())
571
 
    text_keys = [(file_id, rev_id) for rev_id in sorted_rev_list]
572
 
    modified_text_versions = branch.repository.texts.get_parent_map(text_keys)
 
352
    rev_graph = branch.repository.get_revision_graph(mainline_revisions[-1])
 
353
    sorted_rev_list = topo_sort(rev_graph)
573
354
    ancestry = {}
574
355
    for rev in sorted_rev_list:
575
 
        text_key = (file_id, rev)
576
 
        parents = parent_map[rev]
577
 
        if text_key not in modified_text_versions and len(parents) == 1:
 
356
        parents = rev_graph[rev]
 
357
        if rev not in weave_modifed_revisions and len(parents) == 1:
578
358
            # We will not be adding anything new, so just use a reference to
579
359
            # the parent ancestry.
580
360
            rev_ancestry = ancestry[parents[0]]
581
361
        else:
582
362
            rev_ancestry = set()
583
 
            if text_key in modified_text_versions:
 
363
            if rev in weave_modifed_revisions:
584
364
                rev_ancestry.add(rev)
585
365
            for parent in parents:
586
 
                if parent not in ancestry:
587
 
                    # parent is a Ghost, which won't be present in
588
 
                    # sorted_rev_list, but we may access it later, so create an
589
 
                    # empty node for it
590
 
                    ancestry[parent] = set()
591
366
                rev_ancestry = rev_ancestry.union(ancestry[parent])
592
367
        ancestry[rev] = rev_ancestry
593
368
 
594
369
    def is_merging_rev(r):
595
 
        parents = parent_map[r]
 
370
        parents = rev_graph[r]
596
371
        if len(parents) > 1:
597
372
            leftparent = parents[0]
598
373
            for rightparent in parents[1:]:
604
379
    # filter from the view the revisions that did not change or merge 
605
380
    # the specific file
606
381
    return [(r, n, d) for r, n, d in view_revs_iter
607
 
            if (file_id, r) in modified_text_versions or is_merging_rev(r)]
 
382
            if r in weave_modifed_revisions or is_merging_rev(r)]
608
383
 
609
384
 
610
385
def get_view_revisions(mainline_revs, rev_nos, branch, direction,
620
395
        for revision_id in revision_ids:
621
396
            yield revision_id, str(rev_nos[revision_id]), 0
622
397
        return
623
 
    graph = branch.repository.get_graph()
624
 
    # This asks for all mainline revisions, which means we only have to spider
625
 
    # sideways, rather than depth history. That said, its still size-of-history
626
 
    # and should be addressed.
627
 
    # mainline_revisions always includes an extra revision at the beginning, so
628
 
    # don't request it.
629
 
    parent_map = dict(((key, value) for key, value in
630
 
        graph.iter_ancestry(mainline_revs[1:]) if value is not None))
631
 
    # filter out ghosts; merge_sort errors on ghosts.
632
 
    rev_graph = _mod_repository._strip_NULL_ghosts(parent_map)
633
 
    merge_sorted_revisions = tsort.merge_sort(
634
 
        rev_graph,
 
398
    merge_sorted_revisions = merge_sort(
 
399
        branch.repository.get_revision_graph(mainline_revs[-1]),
635
400
        mainline_revs[-1],
636
401
        mainline_revs,
637
402
        generate_revno=True)
658
423
        if val[2] == _depth:
659
424
            zd_revisions.append([val])
660
425
        else:
 
426
            assert val[2] > _depth
661
427
            zd_revisions[-1].append(val)
662
428
    for revisions in zd_revisions:
663
429
        if len(revisions) > 1:
700
466
    - supports_delta must be True if this log formatter supports delta.
701
467
        Otherwise the delta attribute may not be populated.
702
468
    - supports_merge_revisions must be True if this log formatter supports 
703
 
        merge revisions.  If not, and if supports_single_merge_revisions is
704
 
        also not True, then only mainline revisions will be passed to the 
705
 
        formatter.
706
 
    - supports_single_merge_revision must be True if this log formatter
707
 
        supports logging only a single merge revision.  This flag is
708
 
        only relevant if supports_merge_revisions is not True.
 
469
        merge revisions.  If not, only revisions mainline revisions (those 
 
470
        with merge_depth == 0) will be passed to the formatter.
709
471
    - supports_tags must be True if this log formatter supports tags.
710
472
        Otherwise the tags attribute may not be populated.
711
 
 
712
 
    Plugins can register functions to show custom revision properties using
713
 
    the properties_handler_registry. The registered function
714
 
    must respect the following interface description:
715
 
        def my_show_properties(properties_dict):
716
 
            # code that returns a dict {'name':'value'} of the properties 
717
 
            # to be shown
718
473
    """
719
474
 
720
475
    def __init__(self, to_file, show_ids=False, show_timezone='original'):
732
487
#        """
733
488
#        raise NotImplementedError('not implemented in abstract base')
734
489
 
 
490
    @deprecated_method(zero_seventeen)
 
491
    def show(self, revno, rev, delta):
 
492
        raise NotImplementedError('not implemented in abstract base')
 
493
 
735
494
    def short_committer(self, rev):
736
 
        name, address = config.parse_username(rev.committer)
737
 
        if name:
738
 
            return name
739
 
        return address
740
 
 
741
 
    def short_author(self, rev):
742
 
        name, address = config.parse_username(rev.get_apparent_author())
743
 
        if name:
744
 
            return name
745
 
        return address
746
 
 
747
 
    def show_properties(self, revision, indent):
748
 
        """Displays the custom properties returned by each registered handler.
749
 
        
750
 
        If a registered handler raises an error it is propagated.
751
 
        """
752
 
        for key, handler in properties_handler_registry.iteritems():
753
 
            for key, value in handler(revision).items():
754
 
                self.to_file.write(indent + key + ': ' + value + '\n')
 
495
        return re.sub('<.*@.*>', '', rev.committer).strip(' ')
755
496
 
756
497
 
757
498
class LongLogFormatter(LogFormatter):
760
501
    supports_delta = True
761
502
    supports_tags = True
762
503
 
 
504
    @deprecated_method(zero_seventeen)
 
505
    def show(self, revno, rev, delta, tags=None):
 
506
        lr = LogRevision(rev, revno, 0, delta, tags)
 
507
        return self.log_revision(lr)
 
508
 
 
509
    @deprecated_method(zero_eleven)
 
510
    def show_merge(self, rev, merge_depth):
 
511
        lr = LogRevision(rev, merge_depth=merge_depth)
 
512
        return self.log_revision(lr)
 
513
 
 
514
    @deprecated_method(zero_seventeen)
 
515
    def show_merge_revno(self, rev, merge_depth, revno, tags=None):
 
516
        """Show a merged revision rev, with merge_depth and a revno."""
 
517
        lr = LogRevision(rev, revno, merge_depth, tags=tags)
 
518
        return self.log_revision(lr)
 
519
 
763
520
    def log_revision(self, revision):
764
521
        """Log a revision, either merged or not."""
765
 
        indent = '    ' * revision.merge_depth
 
522
        from bzrlib.osutils import format_date
 
523
        indent = '    '*revision.merge_depth
766
524
        to_file = self.to_file
767
 
        to_file.write(indent + '-' * 60 + '\n')
 
525
        print >>to_file,  indent+'-' * 60
768
526
        if revision.revno is not None:
769
 
            to_file.write(indent + 'revno: %s\n' % (revision.revno,))
 
527
            print >>to_file,  indent+'revno:', revision.revno
770
528
        if revision.tags:
771
 
            to_file.write(indent + 'tags: %s\n' % (', '.join(revision.tags)))
 
529
            print >>to_file, indent+'tags: %s' % (', '.join(revision.tags))
772
530
        if self.show_ids:
773
 
            to_file.write(indent + 'revision-id: ' + revision.rev.revision_id)
774
 
            to_file.write('\n')
 
531
            print >>to_file, indent+'revision-id:', revision.rev.revision_id
775
532
            for parent_id in revision.rev.parent_ids:
776
 
                to_file.write(indent + 'parent: %s\n' % (parent_id,))
777
 
        self.show_properties(revision.rev, indent)
778
 
 
779
 
        author = revision.rev.properties.get('author', None)
780
 
        if author is not None:
781
 
            to_file.write(indent + 'author: %s\n' % (author,))
782
 
        to_file.write(indent + 'committer: %s\n' % (revision.rev.committer,))
783
 
 
784
 
        branch_nick = revision.rev.properties.get('branch-nick', None)
785
 
        if branch_nick is not None:
786
 
            to_file.write(indent + 'branch nick: %s\n' % (branch_nick,))
787
 
 
 
533
                print >>to_file, indent+'parent:', parent_id
 
534
        print >>to_file, indent+'committer:', revision.rev.committer
 
535
 
 
536
        try:
 
537
            print >>to_file, indent+'branch nick: %s' % \
 
538
                revision.rev.properties['branch-nick']
 
539
        except KeyError:
 
540
            pass
788
541
        date_str = format_date(revision.rev.timestamp,
789
542
                               revision.rev.timezone or 0,
790
543
                               self.show_timezone)
791
 
        to_file.write(indent + 'timestamp: %s\n' % (date_str,))
 
544
        print >>to_file,  indent+'timestamp: %s' % date_str
792
545
 
793
 
        to_file.write(indent + 'message:\n')
 
546
        print >>to_file,  indent+'message:'
794
547
        if not revision.rev.message:
795
 
            to_file.write(indent + '  (no message)\n')
 
548
            print >>to_file,  indent+'  (no message)'
796
549
        else:
797
550
            message = revision.rev.message.rstrip('\r\n')
798
551
            for l in message.split('\n'):
799
 
                to_file.write(indent + '  %s\n' % (l,))
 
552
                print >>to_file,  indent+'  ' + l
800
553
        if revision.delta is not None:
801
 
            revision.delta.show(to_file, self.show_ids, indent=indent)
 
554
            revision.delta.show(to_file, self.show_ids)
802
555
 
803
556
 
804
557
class ShortLogFormatter(LogFormatter):
805
558
 
806
559
    supports_delta = True
807
 
    supports_single_merge_revision = True
 
560
 
 
561
    @deprecated_method(zero_seventeen)
 
562
    def show(self, revno, rev, delta):
 
563
        lr = LogRevision(rev, revno, 0, delta)
 
564
        return self.log_revision(lr)
808
565
 
809
566
    def log_revision(self, revision):
 
567
        from bzrlib.osutils import format_date
 
568
 
810
569
        to_file = self.to_file
 
570
        date_str = format_date(revision.rev.timestamp,
 
571
                               revision.rev.timezone or 0,
 
572
                               self.show_timezone)
811
573
        is_merge = ''
812
574
        if len(revision.rev.parent_ids) > 1:
813
575
            is_merge = ' [merge]'
814
 
        to_file.write("%5s %s\t%s%s\n" % (revision.revno,
815
 
                self.short_author(revision.rev),
 
576
        print >>to_file, "%5s %s\t%s%s" % (revision.revno,
 
577
                self.short_committer(revision.rev),
816
578
                format_date(revision.rev.timestamp,
817
579
                            revision.rev.timezone or 0,
818
580
                            self.show_timezone, date_fmt="%Y-%m-%d",
819
581
                            show_offset=False),
820
 
                is_merge))
 
582
                is_merge)
821
583
        if self.show_ids:
822
 
            to_file.write('      revision-id:%s\n' % (revision.rev.revision_id,))
 
584
            print >>to_file,  '      revision-id:', revision.rev.revision_id
823
585
        if not revision.rev.message:
824
 
            to_file.write('      (no message)\n')
 
586
            print >>to_file,  '      (no message)'
825
587
        else:
826
588
            message = revision.rev.message.rstrip('\r\n')
827
589
            for l in message.split('\n'):
828
 
                to_file.write('      %s\n' % (l,))
 
590
                print >>to_file,  '      ' + l
829
591
 
830
592
        # TODO: Why not show the modified files in a shorter form as
831
593
        # well? rewrap them single lines of appropriate length
832
594
        if revision.delta is not None:
833
595
            revision.delta.show(to_file, self.show_ids)
834
 
        to_file.write('\n')
 
596
        print >>to_file, ''
835
597
 
836
598
 
837
599
class LineLogFormatter(LogFormatter):
838
600
 
839
 
    supports_single_merge_revision = True
840
 
 
841
601
    def __init__(self, *args, **kwargs):
 
602
        from bzrlib.osutils import terminal_width
842
603
        super(LineLogFormatter, self).__init__(*args, **kwargs)
843
604
        self._max_chars = terminal_width() - 1
844
605
 
848
609
        return str[:max_len-3]+'...'
849
610
 
850
611
    def date_string(self, rev):
 
612
        from bzrlib.osutils import format_date
851
613
        return format_date(rev.timestamp, rev.timezone or 0, 
852
614
                           self.show_timezone, date_fmt="%Y-%m-%d",
853
615
                           show_offset=False)
858
620
        else:
859
621
            return rev.message
860
622
 
 
623
    @deprecated_method(zero_seventeen)
 
624
    def show(self, revno, rev, delta):
 
625
        from bzrlib.osutils import terminal_width
 
626
        print >> self.to_file, self.log_string(revno, rev, terminal_width()-1)
 
627
 
861
628
    def log_revision(self, revision):
862
 
        self.to_file.write(self.log_string(revision.revno, revision.rev,
863
 
                                              self._max_chars))
864
 
        self.to_file.write('\n')
 
629
        print >>self.to_file, self.log_string(revision.revno, revision.rev,
 
630
                                              self._max_chars)
865
631
 
866
632
    def log_string(self, revno, rev, max_chars):
867
633
        """Format log info into one string. Truncate tail of string
875
641
        if revno:
876
642
            # show revno only when is not None
877
643
            out.append("%s:" % revno)
878
 
        out.append(self.truncate(self.short_author(rev), 20))
 
644
        out.append(self.truncate(self.short_committer(rev), 20))
879
645
        out.append(self.date_string(rev))
880
646
        out.append(rev.get_summary())
881
647
        return self.truncate(" ".join(out).rstrip('\n'), max_chars)
922
688
    name -- Name of the formatter to construct; currently 'long', 'short' and
923
689
        'line' are supported.
924
690
    """
 
691
    from bzrlib.errors import BzrCommandError
925
692
    try:
926
693
        return log_formatter_registry.make_formatter(name, *args, **kwargs)
927
694
    except KeyError:
928
 
        raise errors.BzrCommandError("unknown log formatter: %r" % name)
 
695
        raise BzrCommandError("unknown log formatter: %r" % name)
929
696
 
930
697
 
931
698
def show_one_log(revno, rev, delta, verbose, to_file, show_timezone):
934
701
    lf.show(revno, rev, delta)
935
702
 
936
703
 
937
 
def show_changed_revisions(branch, old_rh, new_rh, to_file=None,
938
 
                           log_format='long'):
 
704
def show_changed_revisions(branch, old_rh, new_rh, to_file=None, log_format='long'):
939
705
    """Show the change in revision history comparing the old revision history to the new one.
940
706
 
941
707
    :param branch: The branch where the revisions exist
944
710
    :param to_file: A file to write the results to. If None, stdout will be used
945
711
    """
946
712
    if to_file is None:
947
 
        to_file = codecs.getwriter(get_terminal_encoding())(sys.stdout,
948
 
            errors='replace')
 
713
        import sys
 
714
        import codecs
 
715
        import bzrlib
 
716
        to_file = codecs.getwriter(bzrlib.user_encoding)(sys.stdout, errors='replace')
949
717
    lf = log_formatter(log_format,
950
718
                       show_ids=False,
951
719
                       to_file=to_file,
982
750
        show_log(branch,
983
751
                 lf,
984
752
                 None,
985
 
                 verbose=False,
 
753
                 verbose=True,
986
754
                 direction='forward',
987
755
                 start_revision=base_idx+1,
988
756
                 end_revision=len(new_rh),
989
757
                 search=None)
990
758
 
991
 
 
992
 
properties_handler_registry = registry.Registry()
993
 
 
994
 
# adapters which revision ids to log are filtered. When log is called, the
995
 
# log_rev_iterator is adapted through each of these factory methods.
996
 
# Plugins are welcome to mutate this list in any way they like - as long
997
 
# as the overall behaviour is preserved. At this point there is no extensible
998
 
# mechanism for getting parameters to each factory method, and until there is
999
 
# this won't be considered a stable api.
1000
 
log_adapters = [
1001
 
    # core log logic
1002
 
    _make_batch_filter,
1003
 
    # read revision objects
1004
 
    _make_revision_objects,
1005
 
    # filter on log messages
1006
 
    _make_search_filter,
1007
 
    # generate deltas for things we will show
1008
 
    _make_delta_filter
1009
 
    ]