~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/log.py

  • Committer: Andrew Bennetts
  • Date: 2008-09-05 10:48:03 UTC
  • mto: This revision was merged to the branch mainline in revision 3693.
  • Revision ID: andrew.bennetts@canonical.com-20080905104803-6g72dz6wcldosfs2
Remove monkey-patching of branch._ensure_real from test_remote.py.

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
150
    lf
154
166
 
155
167
    end_revision
156
168
        If not None, only show revisions <= end_revision
 
169
 
 
170
    search
 
171
        If not None, only show revisions with matching commit messages
 
172
 
 
173
    limit
 
174
        If not None or 0, only show limit revisions
157
175
    """
158
176
    branch.lock_read()
159
177
    try:
 
178
        if getattr(lf, 'begin_log', None):
 
179
            lf.begin_log()
 
180
 
160
181
        _show_log(branch, lf, specific_fileid, verbose, direction,
161
 
                  start_revision, end_revision, search)
 
182
                  start_revision, end_revision, search, limit)
 
183
 
 
184
        if getattr(lf, 'end_log', None):
 
185
            lf.end_log()
162
186
    finally:
163
187
        branch.unlock()
164
 
    
 
188
 
 
189
 
165
190
def _show_log(branch,
166
191
             lf,
167
192
             specific_fileid=None,
169
194
             direction='reverse',
170
195
             start_revision=None,
171
196
             end_revision=None,
172
 
             search=None):
 
197
             search=None,
 
198
             limit=None):
173
199
    """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
200
    if not isinstance(lf, LogFormatter):
181
201
        warn("not a LogFormatter instance: %r" % lf)
182
202
 
183
203
    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)
 
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)
 
213
    rev_tag_dict = {}
 
214
    generate_tags = getattr(lf, 'supports_tags', False)
 
215
    if generate_tags:
 
216
        if branch.supports_tags():
 
217
            rev_tag_dict = branch.tags.get_reverse_tag_dict()
 
218
 
 
219
    generate_delta = verbose and getattr(lf, 'supports_delta', False)
 
220
 
 
221
    # now we just print all the revisions
 
222
    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:
 
227
            lr = LogRevision(rev, revno, merge_depth, delta,
 
228
                             rev_tag_dict.get(rev_id))
 
229
            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)])
189
308
    else:
190
 
        searchRE = None
191
 
 
192
 
    which_revs = _enumerate_history(branch)
193
 
    
 
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:
 
409
                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 
194
442
    if start_revision is None:
195
 
        start_revision = 1
 
443
        start_revno = 1
196
444
    else:
197
 
        branch.check_real_revno(start_revision)
 
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
198
451
    
 
452
    end_rev_id = None
199
453
    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
 
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
 
208
492
    # 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]),
 
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):
 
541
    """Return the list of revision ids which touch a given file id.
 
542
 
 
543
    The function filters view_revisions and returns a subset.
 
544
    This includes the revisions which directly change the file id,
 
545
    and the revisions which merge these changes. So if the
 
546
    revision graph is::
 
547
        A
 
548
        |\
 
549
        B C
 
550
        |/
 
551
        D
 
552
 
 
553
    And 'C' changes a file, then both C and D will be returned.
 
554
 
 
555
    This will also can be restricted based on a subset of the mainline.
 
556
 
 
557
    :return: A list of (revision_id, dotted_revno, merge_depth) tuples.
 
558
    """
 
559
    # find all the revisions that change the specific file
 
560
    # build the ancestry of each revision in the graph
 
561
    # - 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)
 
573
    ancestry = {}
 
574
    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:
 
578
            # We will not be adding anything new, so just use a reference to
 
579
            # the parent ancestry.
 
580
            rev_ancestry = ancestry[parents[0]]
 
581
        else:
 
582
            rev_ancestry = set()
 
583
            if text_key in modified_text_versions:
 
584
                rev_ancestry.add(rev)
 
585
            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
                rev_ancestry = rev_ancestry.union(ancestry[parent])
 
592
        ancestry[rev] = rev_ancestry
 
593
 
 
594
    def is_merging_rev(r):
 
595
        parents = parent_map[r]
 
596
        if len(parents) > 1:
 
597
            leftparent = parents[0]
 
598
            for rightparent in parents[1:]:
 
599
                if not ancestry[leftparent].issuperset(
 
600
                        ancestry[rightparent]):
 
601
                    return True
 
602
        return False
 
603
 
 
604
    # filter from the view the revisions that did not change or merge 
 
605
    # the specific file
 
606
    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)]
 
608
 
 
609
 
 
610
def get_view_revisions(mainline_revs, rev_nos, branch, direction,
 
611
                       include_merges=True):
 
612
    """Produce an iterator of revisions to show
 
613
    :return: an iterator of (revision_id, revno, merge_depth)
 
614
    (if there is no revno for a revision, None is supplied)
 
615
    """
 
616
    if include_merges is False:
 
617
        revision_ids = mainline_revs[1:]
 
618
        if direction == 'reverse':
 
619
            revision_ids.reverse()
 
620
        for revision_id in revision_ids:
 
621
            yield revision_id, str(rev_nos[revision_id]), 0
 
622
        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,
217
635
        mainline_revs[-1],
218
 
        mainline_revs)
 
636
        mainline_revs,
 
637
        generate_revno=True)
219
638
 
220
 
    if direction == 'reverse':
221
 
        cut_revs.reverse()
222
 
    elif direction == 'forward':
 
639
    if direction == 'forward':
223
640
        # forward means oldest first.
224
 
        merge_sorted_revisions.reverse()
225
 
    else:
 
641
        merge_sorted_revisions = reverse_by_depth(merge_sorted_revisions)
 
642
    elif direction != 'reverse':
226
643
        raise ValueError('invalid direction %r' % direction)
227
644
 
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
 
    revisions = branch.repository.get_revisions([r for s, r, m, e in
236
 
                                                 merge_sorted_revisions])
237
 
 
238
 
    # now we just print all the revisions
239
 
    for ((sequence, rev_id, merge_depth, end_of_merge), rev) in \
240
 
        zip(merge_sorted_revisions, revisions):
241
 
 
242
 
        if searchRE:
243
 
            if not searchRE.search(rev.message):
244
 
                continue
245
 
 
246
 
        if merge_depth == 0:
247
 
            # a mainline revision.
248
 
            if verbose or specific_fileid:
249
 
                delta = _get_revision_delta(branch, rev_nos[rev_id])
250
 
                
251
 
            if specific_fileid:
252
 
                if not delta.touches_file_id(specific_fileid):
253
 
                    continue
254
 
    
255
 
            if not verbose:
256
 
                # although we calculated it, throw it away without display
257
 
                delta = None
258
 
 
259
 
            lf.show(rev_nos[rev_id], rev, delta)
260
 
        elif hasattr(lf, 'show_merge'):
261
 
            lf.show_merge(rev, merge_depth)
262
 
 
263
 
 
264
 
def deltas_for_log_dummy(branch, which_revs):
265
 
    """Return all the revisions without intermediate deltas.
266
 
 
267
 
    Useful for log commands that won't need the delta information.
268
 
    """
269
 
    
270
 
    for revno, revision_id in which_revs:
271
 
        yield revno, branch.get_revision(revision_id), None
272
 
 
273
 
 
274
 
def deltas_for_log_reverse(branch, which_revs):
275
 
    """Compute deltas for display in latest-to-earliest order.
276
 
 
277
 
    branch
278
 
        Branch to traverse
279
 
 
280
 
    which_revs
281
 
        Sequence of (revno, revision_id) for the subset of history to examine
282
 
 
283
 
    returns 
284
 
        Sequence of (revno, rev, delta)
285
 
 
286
 
    The delta is from the given revision to the next one in the
287
 
    sequence, which makes sense if the log is being displayed from
288
 
    newest to oldest.
289
 
    """
290
 
    last_revno = last_revision_id = last_tree = None
291
 
    for revno, revision_id in which_revs:
292
 
        this_tree = branch.revision_tree(revision_id)
293
 
        this_revision = branch.get_revision(revision_id)
294
 
        
295
 
        if last_revno:
296
 
            yield last_revno, last_revision, compare_trees(this_tree, last_tree, False)
297
 
 
298
 
        this_tree = EmptyTree(branch.get_root_id())
299
 
 
300
 
        last_revno = revno
301
 
        last_revision = this_revision
302
 
        last_tree = this_tree
303
 
 
304
 
    if last_revno:
305
 
        if last_revno == 1:
306
 
            this_tree = EmptyTree(branch.get_root_id())
 
645
    for sequence, rev_id, merge_depth, revno, end_of_merge in merge_sorted_revisions:
 
646
        yield rev_id, '.'.join(map(str, revno)), merge_depth
 
647
 
 
648
 
 
649
def reverse_by_depth(merge_sorted_revisions, _depth=0):
 
650
    """Reverse revisions by depth.
 
651
 
 
652
    Revisions with a different depth are sorted as a group with the previous
 
653
    revision of that depth.  There may be no topological justification for this,
 
654
    but it looks much nicer.
 
655
    """
 
656
    zd_revisions = []
 
657
    for val in merge_sorted_revisions:
 
658
        if val[2] == _depth:
 
659
            zd_revisions.append([val])
307
660
        else:
308
 
            this_revno = last_revno - 1
309
 
            this_revision_id = branch.revision_history()[this_revno]
310
 
            this_tree = branch.revision_tree(this_revision_id)
311
 
        yield last_revno, last_revision, compare_trees(this_tree, last_tree, False)
312
 
 
313
 
 
314
 
def deltas_for_log_forward(branch, which_revs):
315
 
    """Compute deltas for display in forward log.
316
 
 
317
 
    Given a sequence of (revno, revision_id) pairs, return
318
 
    (revno, rev, delta).
319
 
 
320
 
    The delta is from the given revision to the next one in the
321
 
    sequence, which makes sense if the log is being displayed from
322
 
    newest to oldest.
 
661
            zd_revisions[-1].append(val)
 
662
    for revisions in zd_revisions:
 
663
        if len(revisions) > 1:
 
664
            revisions[1:] = reverse_by_depth(revisions[1:], _depth + 1)
 
665
    zd_revisions.reverse()
 
666
    result = []
 
667
    for chunk in zd_revisions:
 
668
        result.extend(chunk)
 
669
    return result
 
670
 
 
671
 
 
672
class LogRevision(object):
 
673
    """A revision to be logged (by LogFormatter.log_revision).
 
674
 
 
675
    A simple wrapper for the attributes of a revision to be logged.
 
676
    The attributes may or may not be populated, as determined by the 
 
677
    logging options and the log formatter capabilities.
323
678
    """
324
 
    last_revno = last_revision_id = last_tree = None
325
 
    prev_tree = EmptyTree(branch.get_root_id())
326
 
 
327
 
    for revno, revision_id in which_revs:
328
 
        this_tree = branch.revision_tree(revision_id)
329
 
        this_revision = branch.get_revision(revision_id)
330
 
 
331
 
        if not last_revno:
332
 
            if revno == 1:
333
 
                last_tree = EmptyTree(branch.get_root_id())
334
 
            else:
335
 
                last_revno = revno - 1
336
 
                last_revision_id = branch.revision_history()[last_revno]
337
 
                last_tree = branch.revision_tree(last_revision_id)
338
 
 
339
 
        yield revno, this_revision, compare_trees(last_tree, this_tree, False)
340
 
 
341
 
        last_revno = revno
342
 
        last_revision = this_revision
343
 
        last_tree = this_tree
 
679
 
 
680
    def __init__(self, rev=None, revno=None, merge_depth=0, delta=None,
 
681
                 tags=None):
 
682
        self.rev = rev
 
683
        self.revno = revno
 
684
        self.merge_depth = merge_depth
 
685
        self.delta = delta
 
686
        self.tags = tags
344
687
 
345
688
 
346
689
class LogFormatter(object):
347
 
    """Abstract class to display log messages."""
 
690
    """Abstract class to display log messages.
 
691
 
 
692
    At a minimum, a derived class must implement the log_revision method.
 
693
 
 
694
    If the LogFormatter needs to be informed of the beginning or end of
 
695
    a log it should implement the begin_log and/or end_log hook methods.
 
696
 
 
697
    A LogFormatter should define the following supports_XXX flags 
 
698
    to indicate which LogRevision attributes it supports:
 
699
 
 
700
    - supports_delta must be True if this log formatter supports delta.
 
701
        Otherwise the delta attribute may not be populated.
 
702
    - 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.
 
709
    - supports_tags must be True if this log formatter supports tags.
 
710
        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
    """
348
719
 
349
720
    def __init__(self, to_file, show_ids=False, show_timezone='original'):
350
721
        self.to_file = to_file
351
722
        self.show_ids = show_ids
352
723
        self.show_timezone = show_timezone
353
724
 
354
 
    def show(self, revno, rev, delta):
355
 
        raise NotImplementedError('not implemented in abstract base')
 
725
# TODO: uncomment this block after show() has been removed.
 
726
# Until then defining log_revision would prevent _show_log calling show() 
 
727
# in legacy formatters.
 
728
#    def log_revision(self, revision):
 
729
#        """Log a revision.
 
730
#
 
731
#        :param  revision:   The LogRevision to be logged.
 
732
#        """
 
733
#        raise NotImplementedError('not implemented in abstract base')
356
734
 
357
735
    def short_committer(self, rev):
358
 
        return re.sub('<.*@.*>', '', rev.committer).strip(' ')
359
 
    
360
 
    
 
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')
 
755
 
 
756
 
361
757
class LongLogFormatter(LogFormatter):
362
 
    def show(self, revno, rev, delta):
363
 
        return self._show_helper(revno=revno, rev=rev, delta=delta)
364
 
 
365
 
    def show_merge(self, rev, merge_depth):
366
 
        return self._show_helper(rev=rev, indent='    '*merge_depth, merged=True, delta=None)
367
 
 
368
 
    def _show_helper(self, rev=None, revno=None, indent='', merged=False, delta=None):
369
 
        """Show a revision, either merged or not."""
370
 
        from bzrlib.osutils import format_date
 
758
 
 
759
    supports_merge_revisions = True
 
760
    supports_delta = True
 
761
    supports_tags = True
 
762
 
 
763
    def log_revision(self, revision):
 
764
        """Log a revision, either merged or not."""
 
765
        indent = '    ' * revision.merge_depth
371
766
        to_file = self.to_file
372
 
        print >>to_file,  indent+'-' * 60
373
 
        if revno is not None:
374
 
            print >>to_file,  'revno:', revno
375
 
        if merged:
376
 
            print >>to_file,  indent+'merged:', rev.revision_id
377
 
        elif self.show_ids:
378
 
            print >>to_file,  indent+'revision-id:', rev.revision_id
 
767
        to_file.write(indent + '-' * 60 + '\n')
 
768
        if revision.revno is not None:
 
769
            to_file.write(indent + 'revno: %s\n' % (revision.revno,))
 
770
        if revision.tags:
 
771
            to_file.write(indent + 'tags: %s\n' % (', '.join(revision.tags)))
379
772
        if self.show_ids:
380
 
            for parent_id in rev.parent_ids:
381
 
                print >>to_file, indent+'parent:', parent_id
382
 
        print >>to_file,  indent+'committer:', rev.committer
383
 
        try:
384
 
            print >>to_file, indent+'branch nick: %s' % \
385
 
                rev.properties['branch-nick']
386
 
        except KeyError:
387
 
            pass
388
 
        date_str = format_date(rev.timestamp,
389
 
                               rev.timezone or 0,
 
773
            to_file.write(indent + 'revision-id: ' + revision.rev.revision_id)
 
774
            to_file.write('\n')
 
775
            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
 
 
788
        date_str = format_date(revision.rev.timestamp,
 
789
                               revision.rev.timezone or 0,
390
790
                               self.show_timezone)
391
 
        print >>to_file,  indent+'timestamp: %s' % date_str
 
791
        to_file.write(indent + 'timestamp: %s\n' % (date_str,))
392
792
 
393
 
        print >>to_file,  indent+'message:'
394
 
        if not rev.message:
395
 
            print >>to_file,  indent+'  (no message)'
 
793
        to_file.write(indent + 'message:\n')
 
794
        if not revision.rev.message:
 
795
            to_file.write(indent + '  (no message)\n')
396
796
        else:
397
 
            message = rev.message.rstrip('\r\n')
 
797
            message = revision.rev.message.rstrip('\r\n')
398
798
            for l in message.split('\n'):
399
 
                print >>to_file,  indent+'  ' + l
400
 
        if delta != None:
401
 
            delta.show(to_file, self.show_ids)
 
799
                to_file.write(indent + '  %s\n' % (l,))
 
800
        if revision.delta is not None:
 
801
            revision.delta.show(to_file, self.show_ids, indent=indent)
402
802
 
403
803
 
404
804
class ShortLogFormatter(LogFormatter):
405
 
    def show(self, revno, rev, delta):
406
 
        from bzrlib.osutils import format_date
407
 
 
 
805
 
 
806
    supports_delta = True
 
807
    supports_single_merge_revision = True
 
808
 
 
809
    def log_revision(self, revision):
408
810
        to_file = self.to_file
409
 
        date_str = format_date(rev.timestamp, rev.timezone or 0,
410
 
                            self.show_timezone)
411
 
        print >>to_file, "%5d %s\t%s" % (revno, self.short_committer(rev),
412
 
                format_date(rev.timestamp, rev.timezone or 0,
 
811
        is_merge = ''
 
812
        if len(revision.rev.parent_ids) > 1:
 
813
            is_merge = ' [merge]'
 
814
        to_file.write("%5s %s\t%s%s\n" % (revision.revno,
 
815
                self.short_author(revision.rev),
 
816
                format_date(revision.rev.timestamp,
 
817
                            revision.rev.timezone or 0,
413
818
                            self.show_timezone, date_fmt="%Y-%m-%d",
414
 
                           show_offset=False))
 
819
                            show_offset=False),
 
820
                is_merge))
415
821
        if self.show_ids:
416
 
            print >>to_file,  '      revision-id:', rev.revision_id
417
 
        if not rev.message:
418
 
            print >>to_file,  '      (no message)'
 
822
            to_file.write('      revision-id:%s\n' % (revision.rev.revision_id,))
 
823
        if not revision.rev.message:
 
824
            to_file.write('      (no message)\n')
419
825
        else:
420
 
            message = rev.message.rstrip('\r\n')
 
826
            message = revision.rev.message.rstrip('\r\n')
421
827
            for l in message.split('\n'):
422
 
                print >>to_file,  '      ' + l
 
828
                to_file.write('      %s\n' % (l,))
423
829
 
424
830
        # TODO: Why not show the modified files in a shorter form as
425
831
        # well? rewrap them single lines of appropriate length
426
 
        if delta != None:
427
 
            delta.show(to_file, self.show_ids)
428
 
        print >>to_file, ''
 
832
        if revision.delta is not None:
 
833
            revision.delta.show(to_file, self.show_ids)
 
834
        to_file.write('\n')
429
835
 
430
836
 
431
837
class LineLogFormatter(LogFormatter):
 
838
 
 
839
    supports_single_merge_revision = True
 
840
 
 
841
    def __init__(self, *args, **kwargs):
 
842
        super(LineLogFormatter, self).__init__(*args, **kwargs)
 
843
        self._max_chars = terminal_width() - 1
 
844
 
432
845
    def truncate(self, str, max_len):
433
846
        if len(str) <= max_len:
434
847
            return str
435
848
        return str[:max_len-3]+'...'
436
849
 
437
850
    def date_string(self, rev):
438
 
        from bzrlib.osutils import format_date
439
851
        return format_date(rev.timestamp, rev.timezone or 0, 
440
852
                           self.show_timezone, date_fmt="%Y-%m-%d",
441
853
                           show_offset=False)
446
858
        else:
447
859
            return rev.message
448
860
 
449
 
    def show(self, revno, rev, delta):
450
 
        from bzrlib.osutils import terminal_width
451
 
        print >> self.to_file, self.log_string(revno, rev, terminal_width()-1)
 
861
    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')
452
865
 
453
866
    def log_string(self, revno, rev, max_chars):
454
867
        """Format log info into one string. Truncate tail of string
461
874
        out = []
462
875
        if revno:
463
876
            # show revno only when is not None
464
 
            out.append("%d:" % revno)
465
 
        out.append(self.truncate(self.short_committer(rev), 20))
 
877
            out.append("%s:" % revno)
 
878
        out.append(self.truncate(self.short_author(rev), 20))
466
879
        out.append(self.date_string(rev))
467
880
        out.append(rev.get_summary())
468
881
        return self.truncate(" ".join(out).rstrip('\n'), max_chars)
472
885
    lf = LineLogFormatter(None)
473
886
    return lf.log_string(None, rev, max_chars)
474
887
 
475
 
FORMATTERS = {
476
 
              'long': LongLogFormatter,
477
 
              'short': ShortLogFormatter,
478
 
              'line': LineLogFormatter,
479
 
              }
 
888
 
 
889
class LogFormatterRegistry(registry.Registry):
 
890
    """Registry for log formatters"""
 
891
 
 
892
    def make_formatter(self, name, *args, **kwargs):
 
893
        """Construct a formatter from arguments.
 
894
 
 
895
        :param name: Name of the formatter to construct.  'short', 'long' and
 
896
            'line' are built-in.
 
897
        """
 
898
        return self.get(name)(*args, **kwargs)
 
899
 
 
900
    def get_default(self, branch):
 
901
        return self.get(branch.get_config().log_format())
 
902
 
 
903
 
 
904
log_formatter_registry = LogFormatterRegistry()
 
905
 
 
906
 
 
907
log_formatter_registry.register('short', ShortLogFormatter,
 
908
                                'Moderately short log format')
 
909
log_formatter_registry.register('long', LongLogFormatter,
 
910
                                'Detailed log format')
 
911
log_formatter_registry.register('line', LineLogFormatter,
 
912
                                'Log format with one line per revision')
 
913
 
480
914
 
481
915
def register_formatter(name, formatter):
482
 
    FORMATTERS[name] = formatter
 
916
    log_formatter_registry.register(name, formatter)
 
917
 
483
918
 
484
919
def log_formatter(name, *args, **kwargs):
485
920
    """Construct a formatter from arguments.
487
922
    name -- Name of the formatter to construct; currently 'long', 'short' and
488
923
        'line' are supported.
489
924
    """
490
 
    from bzrlib.errors import BzrCommandError
491
925
    try:
492
 
        return FORMATTERS[name](*args, **kwargs)
 
926
        return log_formatter_registry.make_formatter(name, *args, **kwargs)
493
927
    except KeyError:
494
 
        raise BzrCommandError("unknown log formatter: %r" % name)
 
928
        raise errors.BzrCommandError("unknown log formatter: %r" % name)
 
929
 
495
930
 
496
931
def show_one_log(revno, rev, delta, verbose, to_file, show_timezone):
497
932
    # deprecated; for compatibility
498
933
    lf = LongLogFormatter(to_file=to_file, show_timezone=show_timezone)
499
934
    lf.show(revno, rev, delta)
500
935
 
501
 
def show_changed_revisions(branch, old_rh, new_rh, to_file=None, log_format='long'):
 
936
 
 
937
def show_changed_revisions(branch, old_rh, new_rh, to_file=None,
 
938
                           log_format='long'):
502
939
    """Show the change in revision history comparing the old revision history to the new one.
503
940
 
504
941
    :param branch: The branch where the revisions exist
507
944
    :param to_file: A file to write the results to. If None, stdout will be used
508
945
    """
509
946
    if to_file is None:
510
 
        import sys
511
 
        import codecs
512
 
        import bzrlib
513
 
        to_file = codecs.getwriter(bzrlib.user_encoding)(sys.stdout, errors='replace')
 
947
        to_file = codecs.getwriter(get_terminal_encoding())(sys.stdout,
 
948
            errors='replace')
514
949
    lf = log_formatter(log_format,
515
950
                       show_ids=False,
516
951
                       to_file=to_file,
538
973
        to_file.write('\nRemoved Revisions:\n')
539
974
        for i in range(base_idx, len(old_rh)):
540
975
            rev = branch.repository.get_revision(old_rh[i])
541
 
            lf.show(i+1, rev, None)
 
976
            lr = LogRevision(rev, i+1, 0, None)
 
977
            lf.log_revision(lr)
542
978
        to_file.write('*'*60)
543
979
        to_file.write('\n\n')
544
980
    if base_idx < len(new_rh):
546
982
        show_log(branch,
547
983
                 lf,
548
984
                 None,
549
 
                 verbose=True,
 
985
                 verbose=False,
550
986
                 direction='forward',
551
987
                 start_revision=base_idx+1,
552
988
                 end_revision=len(new_rh),
553
989
                 search=None)
554
990
 
 
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
    ]