~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/log.py

  • Committer: Ian Clatworthy
  • Date: 2009-01-19 02:24:15 UTC
  • mto: This revision was merged to the branch mainline in revision 3944.
  • Revision ID: ian.clatworthy@canonical.com-20090119022415-mo0mcfeiexfktgwt
apply jam's log --short fix (Ian Clatworthy)

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005 Canonical Ltd
2
 
 
 
1
# Copyright (C) 2005, 2006, 2007 Canonical Ltd
 
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
5
5
# the Free Software Foundation; either version 2 of the License, or
6
6
# (at your option) any later version.
7
 
 
 
7
#
8
8
# This program is distributed in the hope that it will be useful,
9
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11
11
# GNU General Public License for more details.
12
 
 
 
12
#
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
42
42
 
43
43
In verbose mode we show a summary of what changed in each particular
44
44
revision.  Note that this is the delta for changes in that revision
45
 
relative to its mainline parent, not the delta relative to the last
 
45
relative to its left-most parent, not the delta relative to the last
46
46
logged revision.  So for example if you ask for a verbose log of
47
47
changes touching hello.c you will get a list of those revisions also
48
48
listing other things that were changed in the same revision, but not
49
49
all the changes since the previous revision that touched hello.c.
50
50
"""
51
51
 
52
 
 
53
 
# TODO: option to show delta summaries for merged-in revisions
 
52
import codecs
 
53
from itertools import (
 
54
    izip,
 
55
    )
54
56
import re
55
 
 
56
 
from bzrlib.delta import compare_trees
57
 
import bzrlib.errors as errors
58
 
from bzrlib.trace import mutter
59
 
from bzrlib.tree import EmptyTree
60
 
from bzrlib.tsort import merge_sort
 
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
 
 
76
from bzrlib import (
 
77
    registry,
 
78
    )
 
79
from bzrlib.osutils import (
 
80
    format_date,
 
81
    get_terminal_encoding,
 
82
    terminal_width,
 
83
    )
61
84
 
62
85
 
63
86
def find_touching_revisions(branch, file_id):
104
127
        revno += 1
105
128
 
106
129
 
107
 
 
108
130
def _enumerate_history(branch):
109
131
    rh = []
110
132
    revno = 1
114
136
    return rh
115
137
 
116
138
 
117
 
def _get_revision_delta(branch, revno):
118
 
    """Return the delta for a mainline revision.
119
 
    
120
 
    This is used to show summaries in verbose logs, and also for finding 
121
 
    revisions which touch a given file."""
122
 
    # XXX: What are we supposed to do when showing a summary for something 
123
 
    # other than a mainline revision.  The delta to it's first parent, or
124
 
    # (more useful) the delta to a nominated other revision.
125
 
    return branch.get_revision_delta(revno)
126
 
 
127
 
 
128
139
def show_log(branch,
129
140
             lf,
130
141
             specific_fileid=None,
132
143
             direction='reverse',
133
144
             start_revision=None,
134
145
             end_revision=None,
135
 
             search=None):
 
146
             search=None,
 
147
             limit=None):
136
148
    """Write out human-readable log of commits to this branch.
137
149
 
138
 
    lf
139
 
        LogFormatter object to show the output.
140
 
 
141
 
    specific_fileid
142
 
        If true, list only the commits affecting the specified
143
 
        file, rather than all commits.
144
 
 
145
 
    verbose
146
 
        If true show added/changed/deleted/renamed files.
147
 
 
148
 
    direction
149
 
        'reverse' (default) is latest to earliest;
150
 
        'forward' is earliest to latest.
151
 
 
152
 
    start_revision
153
 
        If not None, only show revisions >= start_revision
154
 
 
155
 
    end_revision
156
 
        If not None, only show revisions <= end_revision
 
150
    :param lf: The LogFormatter object showing the output.
 
151
 
 
152
    :param specific_fileid: If not None, list only the commits affecting the
 
153
        specified file, rather than all commits.
 
154
 
 
155
    :param verbose: If True show added/changed/deleted/renamed files.
 
156
 
 
157
    :param direction: 'reverse' (default) is latest to earliest; 'forward' is
 
158
        earliest to latest.
 
159
 
 
160
    :param start_revision: If not None, only show revisions >= start_revision
 
161
 
 
162
    :param end_revision: If not None, only show revisions <= end_revision
 
163
 
 
164
    :param search: If not None, only show revisions with matching commit
 
165
        messages
 
166
 
 
167
    :param limit: If set, shows only 'limit' revisions, all revisions are shown
 
168
        if None or 0.
157
169
    """
158
170
    branch.lock_read()
159
171
    try:
 
172
        if getattr(lf, 'begin_log', None):
 
173
            lf.begin_log()
 
174
 
160
175
        _show_log(branch, lf, specific_fileid, verbose, direction,
161
 
                  start_revision, end_revision, search)
 
176
                  start_revision, end_revision, search, limit)
 
177
 
 
178
        if getattr(lf, 'end_log', None):
 
179
            lf.end_log()
162
180
    finally:
163
181
        branch.unlock()
164
 
    
 
182
 
 
183
 
165
184
def _show_log(branch,
166
185
             lf,
167
186
             specific_fileid=None,
169
188
             direction='reverse',
170
189
             start_revision=None,
171
190
             end_revision=None,
172
 
             search=None):
 
191
             search=None,
 
192
             limit=None):
173
193
    """Worker function for show_log - see show_log."""
174
 
    from bzrlib.osutils import format_date
175
 
    from bzrlib.errors import BzrCheckError
176
 
    from bzrlib.textui import show_status
177
 
    
178
 
    from warnings import warn
179
 
 
180
194
    if not isinstance(lf, LogFormatter):
181
195
        warn("not a LogFormatter instance: %r" % lf)
182
196
 
183
197
    if specific_fileid:
184
 
        mutter('get log for file_id %r', specific_fileid)
185
 
 
186
 
    if search is not None:
187
 
        import re
188
 
        searchRE = re.compile(search, re.IGNORECASE)
 
198
        trace.mutter('get log for file_id %r', specific_fileid)
 
199
    generate_merge_revisions = getattr(lf, 'supports_merge_revisions', False)
 
200
    allow_single_merge_revision = getattr(lf,
 
201
        'supports_single_merge_revision', False)
 
202
    view_revisions = calculate_view_revisions(branch, start_revision,
 
203
                                              end_revision, direction,
 
204
                                              specific_fileid,
 
205
                                              generate_merge_revisions,
 
206
                                              allow_single_merge_revision)
 
207
    rev_tag_dict = {}
 
208
    generate_tags = getattr(lf, 'supports_tags', False)
 
209
    if generate_tags:
 
210
        if branch.supports_tags():
 
211
            rev_tag_dict = branch.tags.get_reverse_tag_dict()
 
212
 
 
213
    generate_delta = verbose and getattr(lf, 'supports_delta', False)
 
214
 
 
215
    # now we just print all the revisions
 
216
    log_count = 0
 
217
    revision_iterator = make_log_rev_iterator(branch, view_revisions,
 
218
        generate_delta, search)
 
219
    for revs in revision_iterator:
 
220
        for (rev_id, revno, merge_depth), rev, delta in revs:
 
221
            lr = LogRevision(rev, revno, merge_depth, delta,
 
222
                             rev_tag_dict.get(rev_id))
 
223
            lf.log_revision(lr)
 
224
            if limit:
 
225
                log_count += 1
 
226
                if log_count >= limit:
 
227
                    return
 
228
 
 
229
 
 
230
def calculate_view_revisions(branch, start_revision, end_revision, direction,
 
231
                             specific_fileid, generate_merge_revisions,
 
232
                             allow_single_merge_revision):
 
233
    if (    not generate_merge_revisions
 
234
        and start_revision is end_revision is None
 
235
        and direction == 'reverse'
 
236
        and specific_fileid is None):
 
237
        return _linear_view_revisions(branch)
 
238
 
 
239
    mainline_revs, rev_nos, start_rev_id, end_rev_id = _get_mainline_revs(
 
240
        branch, start_revision, end_revision)
 
241
    if not mainline_revs:
 
242
        return []
 
243
 
 
244
    generate_single_revision = False
 
245
    if ((not generate_merge_revisions)
 
246
        and ((start_rev_id and (start_rev_id not in rev_nos))
 
247
            or (end_rev_id and (end_rev_id not in rev_nos)))):
 
248
        generate_single_revision = ((start_rev_id == end_rev_id)
 
249
            and allow_single_merge_revision)
 
250
        if not generate_single_revision:
 
251
            raise errors.BzrCommandError('Selected log formatter only supports'
 
252
                ' mainline revisions.')
 
253
        generate_merge_revisions = generate_single_revision
 
254
    include_merges = generate_merge_revisions or specific_fileid
 
255
    view_revs_iter = get_view_revisions(mainline_revs, rev_nos, branch,
 
256
                          direction, include_merges=include_merges)
 
257
 
 
258
    if direction == 'reverse':
 
259
        start_rev_id, end_rev_id = end_rev_id, start_rev_id
 
260
    view_revisions = _filter_revision_range(list(view_revs_iter),
 
261
                                            start_rev_id,
 
262
                                            end_rev_id)
 
263
    if view_revisions and generate_single_revision:
 
264
        view_revisions = view_revisions[0:1]
 
265
    if specific_fileid:
 
266
        view_revisions = _filter_revisions_touching_file_id(branch,
 
267
            specific_fileid, view_revisions,
 
268
            include_merges=generate_merge_revisions)
 
269
 
 
270
    # rebase merge_depth - unless there are no revisions or 
 
271
    # either the first or last revision have merge_depth = 0.
 
272
    if view_revisions and view_revisions[0][2] and view_revisions[-1][2]:
 
273
        min_depth = min([d for r,n,d in view_revisions])
 
274
        if min_depth != 0:
 
275
            view_revisions = [(r,n,d-min_depth) for r,n,d in view_revisions]
 
276
    return view_revisions
 
277
 
 
278
 
 
279
def _linear_view_revisions(branch):
 
280
    start_revno, start_revision_id = branch.last_revision_info()
 
281
    repo = branch.repository
 
282
    revision_ids = repo.iter_reverse_revision_history(start_revision_id)
 
283
    for num, revision_id in enumerate(revision_ids):
 
284
        yield revision_id, str(start_revno - num), 0
 
285
 
 
286
 
 
287
def make_log_rev_iterator(branch, view_revisions, generate_delta, search):
 
288
    """Create a revision iterator for log.
 
289
 
 
290
    :param branch: The branch being logged.
 
291
    :param view_revisions: The revisions being viewed.
 
292
    :param generate_delta: Whether to generate a delta for each revision.
 
293
    :param search: A user text search string.
 
294
    :return: An iterator over lists of ((rev_id, revno, merge_depth), rev,
 
295
        delta).
 
296
    """
 
297
    # Convert view_revisions into (view, None, None) groups to fit with
 
298
    # the standard interface here.
 
299
    if type(view_revisions) == list:
 
300
        # A single batch conversion is faster than many incremental ones.
 
301
        # As we have all the data, do a batch conversion.
 
302
        nones = [None] * len(view_revisions)
 
303
        log_rev_iterator = iter([zip(view_revisions, nones, nones)])
189
304
    else:
190
 
        searchRE = None
191
 
 
192
 
    which_revs = _enumerate_history(branch)
193
 
    
 
305
        def _convert():
 
306
            for view in view_revisions:
 
307
                yield (view, None, None)
 
308
        log_rev_iterator = iter([_convert()])
 
309
    for adapter in log_adapters:
 
310
        log_rev_iterator = adapter(branch, generate_delta, search,
 
311
            log_rev_iterator)
 
312
    return log_rev_iterator
 
313
 
 
314
 
 
315
def _make_search_filter(branch, generate_delta, search, log_rev_iterator):
 
316
    """Create a filtered iterator of log_rev_iterator matching on a regex.
 
317
 
 
318
    :param branch: The branch being logged.
 
319
    :param generate_delta: Whether to generate a delta for each revision.
 
320
    :param search: A user text search string.
 
321
    :param log_rev_iterator: An input iterator containing all revisions that
 
322
        could be displayed, in lists.
 
323
    :return: An iterator over lists of ((rev_id, revno, merge_depth), rev,
 
324
        delta).
 
325
    """
 
326
    if search is None:
 
327
        return log_rev_iterator
 
328
    # Compile the search now to get early errors.
 
329
    searchRE = re.compile(search, re.IGNORECASE)
 
330
    return _filter_message_re(searchRE, log_rev_iterator)
 
331
 
 
332
 
 
333
def _filter_message_re(searchRE, log_rev_iterator):
 
334
    for revs in log_rev_iterator:
 
335
        new_revs = []
 
336
        for (rev_id, revno, merge_depth), rev, delta in revs:
 
337
            if searchRE.search(rev.message):
 
338
                new_revs.append(((rev_id, revno, merge_depth), rev, delta))
 
339
        yield new_revs
 
340
 
 
341
 
 
342
def _make_delta_filter(branch, generate_delta, search, log_rev_iterator):
 
343
    """Add revision deltas to a log iterator if needed.
 
344
 
 
345
    :param branch: The branch being logged.
 
346
    :param generate_delta: Whether to generate a delta for each revision.
 
347
    :param search: A user text search string.
 
348
    :param log_rev_iterator: An input iterator containing all revisions that
 
349
        could be displayed, in lists.
 
350
    :return: An iterator over lists of ((rev_id, revno, merge_depth), rev,
 
351
        delta).
 
352
    """
 
353
    if not generate_delta:
 
354
        return log_rev_iterator
 
355
    return _generate_deltas(branch.repository, log_rev_iterator)
 
356
 
 
357
 
 
358
def _generate_deltas(repository, log_rev_iterator):
 
359
    """Create deltas for each batch of revisions in log_rev_iterator."""
 
360
    for revs in log_rev_iterator:
 
361
        revisions = [rev[1] for rev in revs]
 
362
        deltas = repository.get_deltas_for_revisions(revisions)
 
363
        revs = [(rev[0], rev[1], delta) for rev, delta in izip(revs, deltas)]
 
364
        yield revs
 
365
 
 
366
 
 
367
def _make_revision_objects(branch, generate_delta, search, log_rev_iterator):
 
368
    """Extract revision objects from the repository
 
369
 
 
370
    :param branch: The branch being logged.
 
371
    :param generate_delta: Whether to generate a delta for each revision.
 
372
    :param search: A user text search string.
 
373
    :param log_rev_iterator: An input iterator containing all revisions that
 
374
        could be displayed, in lists.
 
375
    :return: An iterator over lists of ((rev_id, revno, merge_depth), rev,
 
376
        delta).
 
377
    """
 
378
    repository = branch.repository
 
379
    for revs in log_rev_iterator:
 
380
        # r = revision_id, n = revno, d = merge depth
 
381
        revision_ids = [view[0] for view, _, _ in revs]
 
382
        revisions = repository.get_revisions(revision_ids)
 
383
        revs = [(rev[0], revision, rev[2]) for rev, revision in
 
384
            izip(revs, revisions)]
 
385
        yield revs
 
386
 
 
387
 
 
388
def _make_batch_filter(branch, generate_delta, search, log_rev_iterator):
 
389
    """Group up a single large batch into smaller ones.
 
390
 
 
391
    :param branch: The branch being logged.
 
392
    :param generate_delta: Whether to generate a delta for each revision.
 
393
    :param search: A user text search string.
 
394
    :param log_rev_iterator: An input iterator containing all revisions that
 
395
        could be displayed, in lists.
 
396
    :return: An iterator over lists of ((rev_id, revno, merge_depth), rev,
 
397
        delta).
 
398
    """
 
399
    repository = branch.repository
 
400
    num = 9
 
401
    for batch in log_rev_iterator:
 
402
        batch = iter(batch)
 
403
        while True:
 
404
            step = [detail for _, detail in zip(range(num), batch)]
 
405
            if len(step) == 0:
 
406
                break
 
407
            yield step
 
408
            num = min(int(num * 1.5), 200)
 
409
 
 
410
 
 
411
def _get_mainline_revs(branch, start_revision, end_revision):
 
412
    """Get the mainline revisions from the branch.
 
413
    
 
414
    Generates the list of mainline revisions for the branch.
 
415
    
 
416
    :param  branch: The branch containing the revisions. 
 
417
 
 
418
    :param  start_revision: The first revision to be logged.
 
419
            For backwards compatibility this may be a mainline integer revno,
 
420
            but for merge revision support a RevisionInfo is expected.
 
421
 
 
422
    :param  end_revision: The last revision to be logged.
 
423
            For backwards compatibility this may be a mainline integer revno,
 
424
            but for merge revision support a RevisionInfo is expected.
 
425
 
 
426
    :return: A (mainline_revs, rev_nos, start_rev_id, end_rev_id) tuple.
 
427
    """
 
428
    branch_revno, branch_last_revision = branch.last_revision_info()
 
429
    if branch_revno == 0:
 
430
        return None, None, None, None
 
431
 
 
432
    # For mainline generation, map start_revision and end_revision to 
 
433
    # mainline revnos. If the revision is not on the mainline choose the 
 
434
    # appropriate extreme of the mainline instead - the extra will be 
 
435
    # filtered later.
 
436
    # Also map the revisions to rev_ids, to be used in the later filtering
 
437
    # stage.
 
438
    start_rev_id = None
194
439
    if start_revision is None:
195
 
        start_revision = 1
 
440
        start_revno = 1
196
441
    else:
197
 
        branch.check_real_revno(start_revision)
198
 
    
 
442
        if isinstance(start_revision, revisionspec.RevisionInfo):
 
443
            start_rev_id = start_revision.rev_id
 
444
            start_revno = start_revision.revno or 1
 
445
        else:
 
446
            branch.check_real_revno(start_revision)
 
447
            start_revno = start_revision
 
448
 
 
449
    end_rev_id = None
199
450
    if end_revision is None:
200
 
        end_revision = len(which_revs)
201
 
    else:
202
 
        branch.check_real_revno(end_revision)
203
 
 
204
 
    # list indexes are 0-based; revisions are 1-based
205
 
    cut_revs = which_revs[(start_revision-1):(end_revision)]
206
 
    if not cut_revs:
207
 
        return
 
451
        end_revno = branch_revno
 
452
    else:
 
453
        if isinstance(end_revision, revisionspec.RevisionInfo):
 
454
            end_rev_id = end_revision.rev_id
 
455
            end_revno = end_revision.revno or branch_revno
 
456
        else:
 
457
            branch.check_real_revno(end_revision)
 
458
            end_revno = end_revision
 
459
 
 
460
    if ((start_rev_id == _mod_revision.NULL_REVISION)
 
461
        or (end_rev_id == _mod_revision.NULL_REVISION)):
 
462
        raise errors.BzrCommandError('Logging revision 0 is invalid.')
 
463
    if start_revno > end_revno:
 
464
        raise errors.BzrCommandError("Start revision must be older than "
 
465
                                     "the end revision.")
 
466
 
 
467
    if end_revno < start_revno:
 
468
        return None, None, None, None
 
469
    cur_revno = branch_revno
 
470
    rev_nos = {}
 
471
    mainline_revs = []
 
472
    for revision_id in branch.repository.iter_reverse_revision_history(
 
473
                        branch_last_revision):
 
474
        if cur_revno < start_revno:
 
475
            # We have gone far enough, but we always add 1 more revision
 
476
            rev_nos[revision_id] = cur_revno
 
477
            mainline_revs.append(revision_id)
 
478
            break
 
479
        if cur_revno <= end_revno:
 
480
            rev_nos[revision_id] = cur_revno
 
481
            mainline_revs.append(revision_id)
 
482
        cur_revno -= 1
 
483
    else:
 
484
        # We walked off the edge of all revisions, so we add a 'None' marker
 
485
        mainline_revs.append(None)
 
486
 
 
487
    mainline_revs.reverse()
 
488
 
208
489
    # override the mainline to look like the revision history.
209
 
    mainline_revs = [revision_id for index, revision_id in cut_revs]
210
 
    if cut_revs[0][0] == 1:
211
 
        mainline_revs.insert(0, None)
212
 
    else:
213
 
        mainline_revs.insert(0, which_revs[start_revision-2][1])
214
 
 
215
 
    merge_sorted_revisions = merge_sort(
216
 
        branch.repository.get_revision_graph(mainline_revs[-1]),
 
490
    return mainline_revs, rev_nos, start_rev_id, end_rev_id
 
491
 
 
492
 
 
493
def _filter_revision_range(view_revisions, start_rev_id, end_rev_id):
 
494
    """Filter view_revisions based on revision ranges.
 
495
 
 
496
    :param view_revisions: A list of (revision_id, dotted_revno, merge_depth) 
 
497
            tuples to be filtered.
 
498
 
 
499
    :param start_rev_id: If not NONE specifies the first revision to be logged.
 
500
            If NONE then all revisions up to the end_rev_id are logged.
 
501
 
 
502
    :param end_rev_id: If not NONE specifies the last revision to be logged.
 
503
            If NONE then all revisions up to the end of the log are logged.
 
504
 
 
505
    :return: The filtered view_revisions.
 
506
    """
 
507
    if start_rev_id or end_rev_id:
 
508
        revision_ids = [r for r, n, d in view_revisions]
 
509
        if start_rev_id:
 
510
            start_index = revision_ids.index(start_rev_id)
 
511
        else:
 
512
            start_index = 0
 
513
        if start_rev_id == end_rev_id:
 
514
            end_index = start_index
 
515
        else:
 
516
            if end_rev_id:
 
517
                end_index = revision_ids.index(end_rev_id)
 
518
            else:
 
519
                end_index = len(view_revisions) - 1
 
520
        # To include the revisions merged into the last revision, 
 
521
        # extend end_rev_id down to, but not including, the next rev
 
522
        # with the same or lesser merge_depth
 
523
        end_merge_depth = view_revisions[end_index][2]
 
524
        try:
 
525
            for index in xrange(end_index+1, len(view_revisions)+1):
 
526
                if view_revisions[index][2] <= end_merge_depth:
 
527
                    end_index = index - 1
 
528
                    break
 
529
        except IndexError:
 
530
            # if the search falls off the end then log to the end as well
 
531
            end_index = len(view_revisions) - 1
 
532
        view_revisions = view_revisions[start_index:end_index+1]
 
533
    return view_revisions
 
534
 
 
535
 
 
536
def _filter_revisions_touching_file_id(branch, file_id, view_revisions,
 
537
    include_merges=True):
 
538
    r"""Return the list of revision ids which touch a given file id.
 
539
 
 
540
    The function filters view_revisions and returns a subset.
 
541
    This includes the revisions which directly change the file id,
 
542
    and the revisions which merge these changes. So if the
 
543
    revision graph is::
 
544
        A-.
 
545
        |\ \
 
546
        B C E
 
547
        |/ /
 
548
        D |
 
549
        |\|
 
550
        | F
 
551
        |/
 
552
        G
 
553
 
 
554
    And 'C' changes a file, then both C and D will be returned. F will not be
 
555
    returned even though it brings the changes to C into the branch starting
 
556
    with E. (Note that if we were using F as the tip instead of G, then we
 
557
    would see C, D, F.)
 
558
 
 
559
    This will also be restricted based on a subset of the mainline.
 
560
 
 
561
    :param branch: The branch where we can get text revision information.
 
562
 
 
563
    :param file_id: Filter out revisions that do not touch file_id.
 
564
 
 
565
    :param view_revisions: A list of (revision_id, dotted_revno, merge_depth)
 
566
        tuples. This is the list of revisions which will be filtered. It is
 
567
        assumed that view_revisions is in merge_sort order (i.e. newest
 
568
        revision first ).
 
569
 
 
570
    :param include_merges: include merge revisions in the result or not
 
571
 
 
572
    :return: A list of (revision_id, dotted_revno, merge_depth) tuples.
 
573
    """
 
574
    # Lookup all possible text keys to determine which ones actually modified
 
575
    # the file.
 
576
    text_keys = [(file_id, rev_id) for rev_id, revno, depth in view_revisions]
 
577
    # Looking up keys in batches of 1000 can cut the time in half, as well as
 
578
    # memory consumption. GraphIndex *does* like to look for a few keys in
 
579
    # parallel, it just doesn't like looking for *lots* of keys in parallel.
 
580
    # TODO: This code needs to be re-evaluated periodically as we tune the
 
581
    #       indexing layer. We might consider passing in hints as to the known
 
582
    #       access pattern (sparse/clustered, high success rate/low success
 
583
    #       rate). This particular access is clustered with a low success rate.
 
584
    get_parent_map = branch.repository.texts.get_parent_map
 
585
    modified_text_revisions = set()
 
586
    chunk_size = 1000
 
587
    for start in xrange(0, len(text_keys), chunk_size):
 
588
        next_keys = text_keys[start:start + chunk_size]
 
589
        # Only keep the revision_id portion of the key
 
590
        modified_text_revisions.update(
 
591
            [k[1] for k in get_parent_map(next_keys)])
 
592
    del text_keys, next_keys
 
593
 
 
594
    result = []
 
595
    # Track what revisions will merge the current revision, replace entries
 
596
    # with 'None' when they have been added to result
 
597
    current_merge_stack = [None]
 
598
    for info in view_revisions:
 
599
        rev_id, revno, depth = info
 
600
        if depth == len(current_merge_stack):
 
601
            current_merge_stack.append(info)
 
602
        else:
 
603
            del current_merge_stack[depth + 1:]
 
604
            current_merge_stack[-1] = info
 
605
 
 
606
        if rev_id in modified_text_revisions:
 
607
            # This needs to be logged, along with the extra revisions
 
608
            for idx in xrange(len(current_merge_stack)):
 
609
                node = current_merge_stack[idx]
 
610
                if node is not None:
 
611
                    if include_merges or node[2] == 0:
 
612
                        result.append(node)
 
613
                        current_merge_stack[idx] = None
 
614
    return result
 
615
 
 
616
 
 
617
def get_view_revisions(mainline_revs, rev_nos, branch, direction,
 
618
                       include_merges=True):
 
619
    """Produce an iterator of revisions to show
 
620
    :return: an iterator of (revision_id, revno, merge_depth)
 
621
    (if there is no revno for a revision, None is supplied)
 
622
    """
 
623
    if not include_merges:
 
624
        revision_ids = mainline_revs[1:]
 
625
        if direction == 'reverse':
 
626
            revision_ids.reverse()
 
627
        for revision_id in revision_ids:
 
628
            yield revision_id, str(rev_nos[revision_id]), 0
 
629
        return
 
630
    graph = branch.repository.get_graph()
 
631
    # This asks for all mainline revisions, which means we only have to spider
 
632
    # sideways, rather than depth history. That said, its still size-of-history
 
633
    # and should be addressed.
 
634
    # mainline_revisions always includes an extra revision at the beginning, so
 
635
    # don't request it.
 
636
    parent_map = dict(((key, value) for key, value in
 
637
        graph.iter_ancestry(mainline_revs[1:]) if value is not None))
 
638
    # filter out ghosts; merge_sort errors on ghosts.
 
639
    rev_graph = _mod_repository._strip_NULL_ghosts(parent_map)
 
640
    merge_sorted_revisions = tsort.merge_sort(
 
641
        rev_graph,
217
642
        mainline_revs[-1],
218
 
        mainline_revs)
 
643
        mainline_revs,
 
644
        generate_revno=True)
219
645
 
220
 
    if direction == 'reverse':
221
 
        cut_revs.reverse()
222
 
    elif direction == 'forward':
 
646
    if direction == 'forward':
223
647
        # forward means oldest first.
224
 
        merge_sorted_revisions.reverse()
225
 
    else:
 
648
        merge_sorted_revisions = reverse_by_depth(merge_sorted_revisions)
 
649
    elif direction != 'reverse':
226
650
        raise ValueError('invalid direction %r' % direction)
227
651
 
228
 
    revision_history = branch.revision_history()
229
 
 
230
 
    # convert the revision history to a dictionary:
231
 
    rev_nos = {}
232
 
    for index, rev_id in cut_revs:
233
 
        rev_nos[rev_id] = index
234
 
 
235
 
    # now we just print all the revisions
236
 
    for sequence, rev_id, merge_depth, end_of_merge in merge_sorted_revisions:
237
 
        rev = branch.repository.get_revision(rev_id)
238
 
 
239
 
        if searchRE:
240
 
            if not searchRE.search(rev.message):
241
 
                continue
242
 
 
243
 
        if merge_depth == 0:
244
 
            # a mainline revision.
245
 
            if verbose or specific_fileid:
246
 
                delta = _get_revision_delta(branch, rev_nos[rev_id])
247
 
                
248
 
            if specific_fileid:
249
 
                if not delta.touches_file_id(specific_fileid):
250
 
                    continue
251
 
    
252
 
            if not verbose:
253
 
                # although we calculated it, throw it away without display
254
 
                delta = None
255
 
 
256
 
            lf.show(rev_nos[rev_id], rev, delta)
257
 
        elif hasattr(lf, 'show_merge'):
258
 
            lf.show_merge(rev, merge_depth)
259
 
 
260
 
 
261
 
def deltas_for_log_dummy(branch, which_revs):
262
 
    """Return all the revisions without intermediate deltas.
263
 
 
264
 
    Useful for log commands that won't need the delta information.
265
 
    """
266
 
    
267
 
    for revno, revision_id in which_revs:
268
 
        yield revno, branch.get_revision(revision_id), None
269
 
 
270
 
 
271
 
def deltas_for_log_reverse(branch, which_revs):
272
 
    """Compute deltas for display in latest-to-earliest order.
273
 
 
274
 
    branch
275
 
        Branch to traverse
276
 
 
277
 
    which_revs
278
 
        Sequence of (revno, revision_id) for the subset of history to examine
279
 
 
280
 
    returns 
281
 
        Sequence of (revno, rev, delta)
282
 
 
283
 
    The delta is from the given revision to the next one in the
284
 
    sequence, which makes sense if the log is being displayed from
285
 
    newest to oldest.
286
 
    """
287
 
    last_revno = last_revision_id = last_tree = None
288
 
    for revno, revision_id in which_revs:
289
 
        this_tree = branch.revision_tree(revision_id)
290
 
        this_revision = branch.get_revision(revision_id)
291
 
        
292
 
        if last_revno:
293
 
            yield last_revno, last_revision, compare_trees(this_tree, last_tree, False)
294
 
 
295
 
        this_tree = EmptyTree(branch.get_root_id())
296
 
 
297
 
        last_revno = revno
298
 
        last_revision = this_revision
299
 
        last_tree = this_tree
300
 
 
301
 
    if last_revno:
302
 
        if last_revno == 1:
303
 
            this_tree = EmptyTree(branch.get_root_id())
 
652
    for (sequence, rev_id, merge_depth, revno, end_of_merge
 
653
         ) in merge_sorted_revisions:
 
654
        yield rev_id, '.'.join(map(str, revno)), merge_depth
 
655
 
 
656
 
 
657
def reverse_by_depth(merge_sorted_revisions, _depth=0):
 
658
    """Reverse revisions by depth.
 
659
 
 
660
    Revisions with a different depth are sorted as a group with the previous
 
661
    revision of that depth.  There may be no topological justification for this,
 
662
    but it looks much nicer.
 
663
    """
 
664
    # Add a fake revision at start so that we can always attach sub revisions
 
665
    merge_sorted_revisions = [(None, None, _depth)] + merge_sorted_revisions
 
666
    zd_revisions = []
 
667
    for val in merge_sorted_revisions:
 
668
        if val[2] == _depth:
 
669
            # Each revision at the current depth becomes a chunk grouping all
 
670
            # higher depth revisions.
 
671
            zd_revisions.append([val])
304
672
        else:
305
 
            this_revno = last_revno - 1
306
 
            this_revision_id = branch.revision_history()[this_revno]
307
 
            this_tree = branch.revision_tree(this_revision_id)
308
 
        yield last_revno, last_revision, compare_trees(this_tree, last_tree, False)
309
 
 
310
 
 
311
 
def deltas_for_log_forward(branch, which_revs):
312
 
    """Compute deltas for display in forward log.
313
 
 
314
 
    Given a sequence of (revno, revision_id) pairs, return
315
 
    (revno, rev, delta).
316
 
 
317
 
    The delta is from the given revision to the next one in the
318
 
    sequence, which makes sense if the log is being displayed from
319
 
    newest to oldest.
 
673
            zd_revisions[-1].append(val)
 
674
    for revisions in zd_revisions:
 
675
        if len(revisions) > 1:
 
676
            # We have higher depth revisions, let reverse them locally
 
677
            revisions[1:] = reverse_by_depth(revisions[1:], _depth + 1)
 
678
    zd_revisions.reverse()
 
679
    result = []
 
680
    for chunk in zd_revisions:
 
681
        result.extend(chunk)
 
682
    if _depth == 0:
 
683
        # Top level call, get rid of the fake revisions that have been added
 
684
        result = [r for r in result if r[0] is not None and r[1] is not None]
 
685
    return result
 
686
 
 
687
 
 
688
class LogRevision(object):
 
689
    """A revision to be logged (by LogFormatter.log_revision).
 
690
 
 
691
    A simple wrapper for the attributes of a revision to be logged.
 
692
    The attributes may or may not be populated, as determined by the 
 
693
    logging options and the log formatter capabilities.
320
694
    """
321
 
    last_revno = last_revision_id = last_tree = None
322
 
    prev_tree = EmptyTree(branch.get_root_id())
323
 
 
324
 
    for revno, revision_id in which_revs:
325
 
        this_tree = branch.revision_tree(revision_id)
326
 
        this_revision = branch.get_revision(revision_id)
327
 
 
328
 
        if not last_revno:
329
 
            if revno == 1:
330
 
                last_tree = EmptyTree(branch.get_root_id())
331
 
            else:
332
 
                last_revno = revno - 1
333
 
                last_revision_id = branch.revision_history()[last_revno]
334
 
                last_tree = branch.revision_tree(last_revision_id)
335
 
 
336
 
        yield revno, this_revision, compare_trees(last_tree, this_tree, False)
337
 
 
338
 
        last_revno = revno
339
 
        last_revision = this_revision
340
 
        last_tree = this_tree
 
695
 
 
696
    def __init__(self, rev=None, revno=None, merge_depth=0, delta=None,
 
697
                 tags=None):
 
698
        self.rev = rev
 
699
        self.revno = revno
 
700
        self.merge_depth = merge_depth
 
701
        self.delta = delta
 
702
        self.tags = tags
341
703
 
342
704
 
343
705
class LogFormatter(object):
344
 
    """Abstract class to display log messages."""
345
 
 
346
 
    def __init__(self, to_file, show_ids=False, show_timezone='original'):
 
706
    """Abstract class to display log messages.
 
707
 
 
708
    At a minimum, a derived class must implement the log_revision method.
 
709
 
 
710
    If the LogFormatter needs to be informed of the beginning or end of
 
711
    a log it should implement the begin_log and/or end_log hook methods.
 
712
 
 
713
    A LogFormatter should define the following supports_XXX flags 
 
714
    to indicate which LogRevision attributes it supports:
 
715
 
 
716
    - supports_delta must be True if this log formatter supports delta.
 
717
        Otherwise the delta attribute may not be populated.  The 'delta_format'
 
718
        attribute describes whether the 'short_status' format (1) or the long
 
719
        one (2) sould be used.
 
720
 
 
721
    - supports_merge_revisions must be True if this log formatter supports 
 
722
        merge revisions.  If not, and if supports_single_merge_revisions is
 
723
        also not True, then only mainline revisions will be passed to the 
 
724
        formatter.
 
725
    - supports_single_merge_revision must be True if this log formatter
 
726
        supports logging only a single merge revision.  This flag is
 
727
        only relevant if supports_merge_revisions is not True.
 
728
    - supports_tags must be True if this log formatter supports tags.
 
729
        Otherwise the tags attribute may not be populated.
 
730
 
 
731
    Plugins can register functions to show custom revision properties using
 
732
    the properties_handler_registry. The registered function
 
733
    must respect the following interface description:
 
734
        def my_show_properties(properties_dict):
 
735
            # code that returns a dict {'name':'value'} of the properties 
 
736
            # to be shown
 
737
    """
 
738
 
 
739
    def __init__(self, to_file, show_ids=False, show_timezone='original',
 
740
                 delta_format=None):
347
741
        self.to_file = to_file
348
742
        self.show_ids = show_ids
349
743
        self.show_timezone = show_timezone
 
744
        if delta_format is None:
 
745
            # Ensures backward compatibility
 
746
            delta_format = 2 # long format
 
747
        self.delta_format = delta_format
350
748
 
351
 
    def show(self, revno, rev, delta):
352
 
        raise NotImplementedError('not implemented in abstract base')
 
749
# TODO: uncomment this block after show() has been removed.
 
750
# Until then defining log_revision would prevent _show_log calling show() 
 
751
# in legacy formatters.
 
752
#    def log_revision(self, revision):
 
753
#        """Log a revision.
 
754
#
 
755
#        :param  revision:   The LogRevision to be logged.
 
756
#        """
 
757
#        raise NotImplementedError('not implemented in abstract base')
353
758
 
354
759
    def short_committer(self, rev):
355
 
        return re.sub('<.*@.*>', '', rev.committer).strip(' ')
356
 
    
357
 
    
 
760
        name, address = config.parse_username(rev.committer)
 
761
        if name:
 
762
            return name
 
763
        return address
 
764
 
 
765
    def short_author(self, rev):
 
766
        name, address = config.parse_username(rev.get_apparent_author())
 
767
        if name:
 
768
            return name
 
769
        return address
 
770
 
 
771
    def show_properties(self, revision, indent):
 
772
        """Displays the custom properties returned by each registered handler.
 
773
        
 
774
        If a registered handler raises an error it is propagated.
 
775
        """
 
776
        for key, handler in properties_handler_registry.iteritems():
 
777
            for key, value in handler(revision).items():
 
778
                self.to_file.write(indent + key + ': ' + value + '\n')
 
779
 
 
780
 
358
781
class LongLogFormatter(LogFormatter):
359
 
    def show(self, revno, rev, delta):
360
 
        return self._show_helper(revno=revno, rev=rev, delta=delta)
361
 
 
362
 
    def show_merge(self, rev, merge_depth):
363
 
        return self._show_helper(rev=rev, indent='    '*merge_depth, merged=True, delta=None)
364
 
 
365
 
    def _show_helper(self, rev=None, revno=None, indent='', merged=False, delta=None):
366
 
        """Show a revision, either merged or not."""
367
 
        from bzrlib.osutils import format_date
 
782
 
 
783
    supports_merge_revisions = True
 
784
    supports_delta = True
 
785
    supports_tags = True
 
786
 
 
787
    def log_revision(self, revision):
 
788
        """Log a revision, either merged or not."""
 
789
        indent = '    ' * revision.merge_depth
368
790
        to_file = self.to_file
369
 
        print >>to_file,  indent+'-' * 60
370
 
        if revno is not None:
371
 
            print >>to_file,  'revno:', revno
372
 
        if merged:
373
 
            print >>to_file,  indent+'merged:', rev.revision_id
374
 
        elif self.show_ids:
375
 
            print >>to_file,  indent+'revision-id:', rev.revision_id
 
791
        to_file.write(indent + '-' * 60 + '\n')
 
792
        if revision.revno is not None:
 
793
            to_file.write(indent + 'revno: %s\n' % (revision.revno,))
 
794
        if revision.tags:
 
795
            to_file.write(indent + 'tags: %s\n' % (', '.join(revision.tags)))
376
796
        if self.show_ids:
377
 
            for parent_id in rev.parent_ids:
378
 
                print >>to_file, indent+'parent:', parent_id
379
 
        print >>to_file,  indent+'committer:', rev.committer
380
 
        try:
381
 
            print >>to_file, indent+'branch nick: %s' % \
382
 
                rev.properties['branch-nick']
383
 
        except KeyError:
384
 
            pass
385
 
        date_str = format_date(rev.timestamp,
386
 
                               rev.timezone or 0,
 
797
            to_file.write(indent + 'revision-id: ' + revision.rev.revision_id)
 
798
            to_file.write('\n')
 
799
            for parent_id in revision.rev.parent_ids:
 
800
                to_file.write(indent + 'parent: %s\n' % (parent_id,))
 
801
        self.show_properties(revision.rev, indent)
 
802
 
 
803
        author = revision.rev.properties.get('author', None)
 
804
        if author is not None:
 
805
            to_file.write(indent + 'author: %s\n' % (author,))
 
806
        to_file.write(indent + 'committer: %s\n' % (revision.rev.committer,))
 
807
 
 
808
        branch_nick = revision.rev.properties.get('branch-nick', None)
 
809
        if branch_nick is not None:
 
810
            to_file.write(indent + 'branch nick: %s\n' % (branch_nick,))
 
811
 
 
812
        date_str = format_date(revision.rev.timestamp,
 
813
                               revision.rev.timezone or 0,
387
814
                               self.show_timezone)
388
 
        print >>to_file,  indent+'timestamp: %s' % date_str
 
815
        to_file.write(indent + 'timestamp: %s\n' % (date_str,))
389
816
 
390
 
        print >>to_file,  indent+'message:'
391
 
        if not rev.message:
392
 
            print >>to_file,  indent+'  (no message)'
 
817
        to_file.write(indent + 'message:\n')
 
818
        if not revision.rev.message:
 
819
            to_file.write(indent + '  (no message)\n')
393
820
        else:
394
 
            message = rev.message.rstrip('\r\n')
 
821
            message = revision.rev.message.rstrip('\r\n')
395
822
            for l in message.split('\n'):
396
 
                print >>to_file,  indent+'  ' + l
397
 
        if delta != None:
398
 
            delta.show(to_file, self.show_ids)
 
823
                to_file.write(indent + '  %s\n' % (l,))
 
824
        if revision.delta is not None:
 
825
            # We don't respect delta_format for compatibility
 
826
            revision.delta.show(to_file, self.show_ids, indent=indent,
 
827
                                short_status=False)
399
828
 
400
829
 
401
830
class ShortLogFormatter(LogFormatter):
402
 
    def show(self, revno, rev, delta):
403
 
        from bzrlib.osutils import format_date
404
 
 
 
831
 
 
832
    supports_delta = True
 
833
    supports_single_merge_revision = True
 
834
 
 
835
    def log_revision(self, revision):
405
836
        to_file = self.to_file
406
 
        date_str = format_date(rev.timestamp, rev.timezone or 0,
407
 
                            self.show_timezone)
408
 
        print >>to_file, "%5d %s\t%s" % (revno, self.short_committer(rev),
409
 
                format_date(rev.timestamp, rev.timezone or 0,
 
837
        is_merge = ''
 
838
        if len(revision.rev.parent_ids) > 1:
 
839
            is_merge = ' [merge]'
 
840
        to_file.write("%5s %s\t%s%s\n" % (revision.revno,
 
841
                self.short_author(revision.rev),
 
842
                format_date(revision.rev.timestamp,
 
843
                            revision.rev.timezone or 0,
410
844
                            self.show_timezone, date_fmt="%Y-%m-%d",
411
 
                           show_offset=False))
 
845
                            show_offset=False),
 
846
                is_merge))
412
847
        if self.show_ids:
413
 
            print >>to_file,  '      revision-id:', rev.revision_id
414
 
        if not rev.message:
415
 
            print >>to_file,  '      (no message)'
 
848
            to_file.write('      revision-id:%s\n'
 
849
                          % (revision.rev.revision_id,))
 
850
        if not revision.rev.message:
 
851
            to_file.write('      (no message)\n')
416
852
        else:
417
 
            message = rev.message.rstrip('\r\n')
 
853
            message = revision.rev.message.rstrip('\r\n')
418
854
            for l in message.split('\n'):
419
 
                print >>to_file,  '      ' + l
 
855
                to_file.write('      %s\n' % (l,))
420
856
 
421
 
        # TODO: Why not show the modified files in a shorter form as
422
 
        # well? rewrap them single lines of appropriate length
423
 
        if delta != None:
424
 
            delta.show(to_file, self.show_ids)
425
 
        print >>to_file, ''
 
857
        if revision.delta is not None:
 
858
            revision.delta.show(to_file, self.show_ids,
 
859
                                short_status=self.delta_format==1)
 
860
        to_file.write('\n')
426
861
 
427
862
 
428
863
class LineLogFormatter(LogFormatter):
 
864
 
 
865
    supports_single_merge_revision = True
 
866
 
 
867
    def __init__(self, *args, **kwargs):
 
868
        super(LineLogFormatter, self).__init__(*args, **kwargs)
 
869
        self._max_chars = terminal_width() - 1
 
870
 
429
871
    def truncate(self, str, max_len):
430
872
        if len(str) <= max_len:
431
873
            return str
432
874
        return str[:max_len-3]+'...'
433
875
 
434
876
    def date_string(self, rev):
435
 
        from bzrlib.osutils import format_date
436
 
        return format_date(rev.timestamp, rev.timezone or 0, 
 
877
        return format_date(rev.timestamp, rev.timezone or 0,
437
878
                           self.show_timezone, date_fmt="%Y-%m-%d",
438
879
                           show_offset=False)
439
880
 
443
884
        else:
444
885
            return rev.message
445
886
 
446
 
    def show(self, revno, rev, delta):
447
 
        from bzrlib.osutils import terminal_width
448
 
        print >> self.to_file, self.log_string(revno, rev, terminal_width()-1)
 
887
    def log_revision(self, revision):
 
888
        self.to_file.write(self.log_string(revision.revno, revision.rev,
 
889
                                              self._max_chars))
 
890
        self.to_file.write('\n')
449
891
 
450
892
    def log_string(self, revno, rev, max_chars):
451
893
        """Format log info into one string. Truncate tail of string
452
 
        :param  revno:      revision number (int) or None.
 
894
        :param  revno:      revision number or None.
453
895
                            Revision numbers counts from 1.
454
896
        :param  rev:        revision info object
455
897
        :param  max_chars:  maximum length of resulting string
458
900
        out = []
459
901
        if revno:
460
902
            # show revno only when is not None
461
 
            out.append("%d:" % revno)
462
 
        out.append(self.truncate(self.short_committer(rev), 20))
 
903
            out.append("%s:" % revno)
 
904
        out.append(self.truncate(self.short_author(rev), 20))
463
905
        out.append(self.date_string(rev))
464
906
        out.append(rev.get_summary())
465
907
        return self.truncate(" ".join(out).rstrip('\n'), max_chars)
469
911
    lf = LineLogFormatter(None)
470
912
    return lf.log_string(None, rev, max_chars)
471
913
 
472
 
FORMATTERS = {
473
 
              'long': LongLogFormatter,
474
 
              'short': ShortLogFormatter,
475
 
              'line': LineLogFormatter,
476
 
              }
 
914
 
 
915
class LogFormatterRegistry(registry.Registry):
 
916
    """Registry for log formatters"""
 
917
 
 
918
    def make_formatter(self, name, *args, **kwargs):
 
919
        """Construct a formatter from arguments.
 
920
 
 
921
        :param name: Name of the formatter to construct.  'short', 'long' and
 
922
            'line' are built-in.
 
923
        """
 
924
        return self.get(name)(*args, **kwargs)
 
925
 
 
926
    def get_default(self, branch):
 
927
        return self.get(branch.get_config().log_format())
 
928
 
 
929
 
 
930
log_formatter_registry = LogFormatterRegistry()
 
931
 
 
932
 
 
933
log_formatter_registry.register('short', ShortLogFormatter,
 
934
                                'Moderately short log format')
 
935
log_formatter_registry.register('long', LongLogFormatter,
 
936
                                'Detailed log format')
 
937
log_formatter_registry.register('line', LineLogFormatter,
 
938
                                'Log format with one line per revision')
 
939
 
477
940
 
478
941
def register_formatter(name, formatter):
479
 
    FORMATTERS[name] = formatter
 
942
    log_formatter_registry.register(name, formatter)
 
943
 
480
944
 
481
945
def log_formatter(name, *args, **kwargs):
482
946
    """Construct a formatter from arguments.
484
948
    name -- Name of the formatter to construct; currently 'long', 'short' and
485
949
        'line' are supported.
486
950
    """
487
 
    from bzrlib.errors import BzrCommandError
488
951
    try:
489
 
        return FORMATTERS[name](*args, **kwargs)
 
952
        return log_formatter_registry.make_formatter(name, *args, **kwargs)
490
953
    except KeyError:
491
 
        raise BzrCommandError("unknown log formatter: %r" % name)
 
954
        raise errors.BzrCommandError("unknown log formatter: %r" % name)
 
955
 
492
956
 
493
957
def show_one_log(revno, rev, delta, verbose, to_file, show_timezone):
494
958
    # deprecated; for compatibility
495
959
    lf = LongLogFormatter(to_file=to_file, show_timezone=show_timezone)
496
960
    lf.show(revno, rev, delta)
497
961
 
498
 
def show_changed_revisions(branch, old_rh, new_rh, to_file=None, log_format='long'):
 
962
 
 
963
def show_changed_revisions(branch, old_rh, new_rh, to_file=None,
 
964
                           log_format='long'):
499
965
    """Show the change in revision history comparing the old revision history to the new one.
500
966
 
501
967
    :param branch: The branch where the revisions exist
504
970
    :param to_file: A file to write the results to. If None, stdout will be used
505
971
    """
506
972
    if to_file is None:
507
 
        import sys
508
 
        import codecs
509
 
        import bzrlib
510
 
        to_file = codecs.getwriter(bzrlib.user_encoding)(sys.stdout, errors='replace')
 
973
        to_file = codecs.getwriter(get_terminal_encoding())(sys.stdout,
 
974
            errors='replace')
511
975
    lf = log_formatter(log_format,
512
976
                       show_ids=False,
513
977
                       to_file=to_file,
535
999
        to_file.write('\nRemoved Revisions:\n')
536
1000
        for i in range(base_idx, len(old_rh)):
537
1001
            rev = branch.repository.get_revision(old_rh[i])
538
 
            lf.show(i+1, rev, None)
 
1002
            lr = LogRevision(rev, i+1, 0, None)
 
1003
            lf.log_revision(lr)
539
1004
        to_file.write('*'*60)
540
1005
        to_file.write('\n\n')
541
1006
    if base_idx < len(new_rh):
543
1008
        show_log(branch,
544
1009
                 lf,
545
1010
                 None,
546
 
                 verbose=True,
 
1011
                 verbose=False,
547
1012
                 direction='forward',
548
1013
                 start_revision=base_idx+1,
549
1014
                 end_revision=len(new_rh),
550
1015
                 search=None)
551
1016
 
 
1017
 
 
1018
def get_history_change(old_revision_id, new_revision_id, repository):
 
1019
    """Calculate the uncommon lefthand history between two revisions.
 
1020
 
 
1021
    :param old_revision_id: The original revision id.
 
1022
    :param new_revision_id: The new revision id.
 
1023
    :param repository: The repository to use for the calculation.
 
1024
 
 
1025
    return old_history, new_history
 
1026
    """
 
1027
    old_history = []
 
1028
    old_revisions = set()
 
1029
    new_history = []
 
1030
    new_revisions = set()
 
1031
    new_iter = repository.iter_reverse_revision_history(new_revision_id)
 
1032
    old_iter = repository.iter_reverse_revision_history(old_revision_id)
 
1033
    stop_revision = None
 
1034
    do_old = True
 
1035
    do_new = True
 
1036
    while do_new or do_old:
 
1037
        if do_new:
 
1038
            try:
 
1039
                new_revision = new_iter.next()
 
1040
            except StopIteration:
 
1041
                do_new = False
 
1042
            else:
 
1043
                new_history.append(new_revision)
 
1044
                new_revisions.add(new_revision)
 
1045
                if new_revision in old_revisions:
 
1046
                    stop_revision = new_revision
 
1047
                    break
 
1048
        if do_old:
 
1049
            try:
 
1050
                old_revision = old_iter.next()
 
1051
            except StopIteration:
 
1052
                do_old = False
 
1053
            else:
 
1054
                old_history.append(old_revision)
 
1055
                old_revisions.add(old_revision)
 
1056
                if old_revision in new_revisions:
 
1057
                    stop_revision = old_revision
 
1058
                    break
 
1059
    new_history.reverse()
 
1060
    old_history.reverse()
 
1061
    if stop_revision is not None:
 
1062
        new_history = new_history[new_history.index(stop_revision) + 1:]
 
1063
        old_history = old_history[old_history.index(stop_revision) + 1:]
 
1064
    return old_history, new_history
 
1065
 
 
1066
 
 
1067
def show_branch_change(branch, output, old_revno, old_revision_id):
 
1068
    """Show the changes made to a branch.
 
1069
 
 
1070
    :param branch: The branch to show changes about.
 
1071
    :param output: A file-like object to write changes to.
 
1072
    :param old_revno: The revno of the old tip.
 
1073
    :param old_revision_id: The revision_id of the old tip.
 
1074
    """
 
1075
    new_revno, new_revision_id = branch.last_revision_info()
 
1076
    old_history, new_history = get_history_change(old_revision_id,
 
1077
                                                  new_revision_id,
 
1078
                                                  branch.repository)
 
1079
    if old_history == [] and new_history == []:
 
1080
        output.write('Nothing seems to have changed\n')
 
1081
        return
 
1082
 
 
1083
    log_format = log_formatter_registry.get_default(branch)
 
1084
    lf = log_format(show_ids=False, to_file=output, show_timezone='original')
 
1085
    if old_history != []:
 
1086
        output.write('*'*60)
 
1087
        output.write('\nRemoved Revisions:\n')
 
1088
        show_flat_log(branch.repository, old_history, old_revno, lf)
 
1089
        output.write('*'*60)
 
1090
        output.write('\n\n')
 
1091
    if new_history != []:
 
1092
        output.write('Added Revisions:\n')
 
1093
        start_revno = new_revno - len(new_history) + 1
 
1094
        show_log(branch, lf, None, verbose=False, direction='forward',
 
1095
                 start_revision=start_revno,)
 
1096
 
 
1097
 
 
1098
def show_flat_log(repository, history, last_revno, lf):
 
1099
    """Show a simple log of the specified history.
 
1100
 
 
1101
    :param repository: The repository to retrieve revisions from.
 
1102
    :param history: A list of revision_ids indicating the lefthand history.
 
1103
    :param last_revno: The revno of the last revision_id in the history.
 
1104
    :param lf: The log formatter to use.
 
1105
    """
 
1106
    start_revno = last_revno - len(history) + 1
 
1107
    revisions = repository.get_revisions(history)
 
1108
    for i, rev in enumerate(revisions):
 
1109
        lr = LogRevision(rev, i + last_revno, 0, None)
 
1110
        lf.log_revision(lr)
 
1111
 
 
1112
 
 
1113
properties_handler_registry = registry.Registry()
 
1114
properties_handler_registry.register_lazy("foreign",
 
1115
                                          "bzrlib.foreign",
 
1116
                                          "show_foreign_properties")
 
1117
 
 
1118
 
 
1119
# adapters which revision ids to log are filtered. When log is called, the
 
1120
# log_rev_iterator is adapted through each of these factory methods.
 
1121
# Plugins are welcome to mutate this list in any way they like - as long
 
1122
# as the overall behaviour is preserved. At this point there is no extensible
 
1123
# mechanism for getting parameters to each factory method, and until there is
 
1124
# this won't be considered a stable api.
 
1125
log_adapters = [
 
1126
    # core log logic
 
1127
    _make_batch_filter,
 
1128
    # read revision objects
 
1129
    _make_revision_objects,
 
1130
    # filter on log messages
 
1131
    _make_search_filter,
 
1132
    # generate deltas for things we will show
 
1133
    _make_delta_filter
 
1134
    ]