~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/log.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2008-10-31 04:39:04 UTC
  • mfrom: (3565.6.16 switch_nick)
  • Revision ID: pqm@pqm.ubuntu.com-20081031043904-52fnbfrloojemvcc
(mbp) branch nickname documentation

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
16
16
 
17
17
 
18
18
 
 
19
"""Code to show logs of changes.
 
20
 
 
21
Various flavors of log can be produced:
 
22
 
 
23
* for one file, or the whole tree, and (not done yet) for
 
24
  files in a given directory
 
25
 
 
26
* in "verbose" mode with a description of what changed from one
 
27
  version to the next
 
28
 
 
29
* with file-ids and revision-ids shown
 
30
 
 
31
Logs are actually written out through an abstract LogFormatter
 
32
interface, which allows for different preferred formats.  Plugins can
 
33
register formats too.
 
34
 
 
35
Logs can be produced in either forward (oldest->newest) or reverse
 
36
(newest->oldest) order.
 
37
 
 
38
Logs can be filtered to show only revisions matching a particular
 
39
search string, or within a particular range of revisions.  The range
 
40
can be given as date/times, which are reduced to revisions before
 
41
calling in here.
 
42
 
 
43
In verbose mode we show a summary of what changed in each particular
 
44
revision.  Note that this is the delta for changes in that revision
 
45
relative to its left-most parent, not the delta relative to the last
 
46
logged revision.  So for example if you ask for a verbose log of
 
47
changes touching hello.c you will get a list of those revisions also
 
48
listing other things that were changed in the same revision, but not
 
49
all the changes since the previous revision that touched hello.c.
 
50
"""
 
51
 
 
52
import codecs
 
53
from itertools import (
 
54
    izip,
 
55
    )
 
56
import re
 
57
import sys
 
58
from warnings import (
 
59
    warn,
 
60
    )
 
61
 
 
62
from bzrlib.lazy_import import lazy_import
 
63
lazy_import(globals(), """
 
64
 
 
65
from bzrlib import (
 
66
    config,
 
67
    errors,
 
68
    repository as _mod_repository,
 
69
    revision as _mod_revision,
 
70
    revisionspec,
 
71
    trace,
 
72
    tsort,
 
73
    )
 
74
""")
 
75
 
 
76
from bzrlib import (
 
77
    registry,
 
78
    )
 
79
from bzrlib.osutils import (
 
80
    format_date,
 
81
    get_terminal_encoding,
 
82
    terminal_width,
 
83
    )
 
84
 
19
85
 
20
86
def find_touching_revisions(branch, file_id):
21
87
    """Yield a description of revisions which affect the file_id.
25
91
    This is the list of revisions where the file is either added,
26
92
    modified, renamed or deleted.
27
93
 
28
 
    Revisions are returned in chronological order.
29
 
 
30
94
    TODO: Perhaps some way to limit this to only particular revisions,
31
 
    or to traverse a non-branch set of revisions?
32
 
 
33
 
    TODO: If a directory is given, then by default look for all
34
 
    changes under that directory.
 
95
    or to traverse a non-mainline set of revisions?
35
96
    """
36
97
    last_ie = None
37
98
    last_path = None
38
99
    revno = 1
39
100
    for revision_id in branch.revision_history():
40
 
        this_inv = branch.get_revision_inventory(revision_id)
 
101
        this_inv = branch.repository.get_revision_inventory(revision_id)
41
102
        if file_id in this_inv:
42
103
            this_ie = this_inv[file_id]
43
104
            this_path = this_inv.id2path(file_id)
66
127
        revno += 1
67
128
 
68
129
 
 
130
def _enumerate_history(branch):
 
131
    rh = []
 
132
    revno = 1
 
133
    for rev_id in branch.revision_history():
 
134
        rh.append((revno, rev_id))
 
135
        revno += 1
 
136
    return rh
 
137
 
 
138
 
69
139
def show_log(branch,
70
 
             filename=None,
71
 
             show_timezone='original',
 
140
             lf,
 
141
             specific_fileid=None,
72
142
             verbose=False,
73
 
             show_ids=False,
74
 
             to_file=None):
 
143
             direction='reverse',
 
144
             start_revision=None,
 
145
             end_revision=None,
 
146
             search=None,
 
147
             limit=None):
75
148
    """Write out human-readable log of commits to this branch.
76
149
 
77
 
    filename
 
150
    lf
 
151
        LogFormatter object to show the output.
 
152
 
 
153
    specific_fileid
78
154
        If true, list only the commits affecting the specified
79
155
        file, rather than all commits.
80
156
 
81
 
    show_timezone
82
 
        'original' (committer's timezone),
83
 
        'utc' (universal time), or
84
 
        'local' (local user's timezone)
85
 
 
86
157
    verbose
87
158
        If true show added/changed/deleted/renamed files.
88
159
 
89
 
    show_ids
90
 
        If true, show revision and file ids.
91
 
 
92
 
    to_file
93
 
        File to send log to; by default stdout.
94
 
    """
95
 
    from osutils import format_date
96
 
    from errors import BzrCheckError
97
 
    from diff import compare_inventories
98
 
    from textui import show_status
99
 
    from inventory import Inventory
100
 
 
101
 
    if to_file == None:
102
 
        import sys
103
 
        to_file = sys.stdout
104
 
 
105
 
    if filename:
106
 
        file_id = branch.read_working_inventory().path2id(filename)
107
 
        def which_revs():
108
 
            for revno, revid, why in find_touching_revisions(branch, file_id):
109
 
                yield revno, revid
110
 
    else:
111
 
        def which_revs():
112
 
            for i, revid in enumerate(branch.revision_history()):
113
 
                yield i+1, revid
 
160
    direction
 
161
        'reverse' (default) is latest to earliest;
 
162
        'forward' is earliest to latest.
 
163
 
 
164
    start_revision
 
165
        If not None, only show revisions >= start_revision
 
166
 
 
167
    end_revision
 
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
 
175
    """
 
176
    branch.lock_read()
 
177
    try:
 
178
        if getattr(lf, 'begin_log', None):
 
179
            lf.begin_log()
 
180
 
 
181
        _show_log(branch, lf, specific_fileid, verbose, direction,
 
182
                  start_revision, end_revision, search, limit)
 
183
 
 
184
        if getattr(lf, 'end_log', None):
 
185
            lf.end_log()
 
186
    finally:
 
187
        branch.unlock()
 
188
 
 
189
 
 
190
def _show_log(branch,
 
191
             lf,
 
192
             specific_fileid=None,
 
193
             verbose=False,
 
194
             direction='reverse',
 
195
             start_revision=None,
 
196
             end_revision=None,
 
197
             search=None,
 
198
             limit=None):
 
199
    """Worker function for show_log - see show_log."""
 
200
    if not isinstance(lf, LogFormatter):
 
201
        warn("not a LogFormatter instance: %r" % lf)
 
202
 
 
203
    if specific_fileid:
 
204
        trace.mutter('get log for file_id %r', specific_fileid)
 
205
    generate_merge_revisions = getattr(lf, 'supports_merge_revisions', False)
 
206
    allow_single_merge_revision = getattr(lf,
 
207
        'supports_single_merge_revision', False)
 
208
    view_revisions = calculate_view_revisions(branch, start_revision,
 
209
                                              end_revision, direction,
 
210
                                              specific_fileid,
 
211
                                              generate_merge_revisions,
 
212
                                              allow_single_merge_revision)
 
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
                                                         view_revisions,
 
272
                                                         direction)
 
273
 
 
274
    # rebase merge_depth - unless there are no revisions or 
 
275
    # either the first or last revision have merge_depth = 0.
 
276
    if view_revisions and view_revisions[0][2] and view_revisions[-1][2]:
 
277
        min_depth = min([d for r,n,d in view_revisions])
 
278
        if min_depth != 0:
 
279
            view_revisions = [(r,n,d-min_depth) for r,n,d in view_revisions]
 
280
    return view_revisions
 
281
 
 
282
 
 
283
def _linear_view_revisions(branch):
 
284
    start_revno, start_revision_id = branch.last_revision_info()
 
285
    repo = branch.repository
 
286
    revision_ids = repo.iter_reverse_revision_history(start_revision_id)
 
287
    for num, revision_id in enumerate(revision_ids):
 
288
        yield revision_id, str(start_revno - num), 0
 
289
 
 
290
 
 
291
def make_log_rev_iterator(branch, view_revisions, generate_delta, search):
 
292
    """Create a revision iterator for log.
 
293
 
 
294
    :param branch: The branch being logged.
 
295
    :param view_revisions: The revisions being viewed.
 
296
    :param generate_delta: Whether to generate a delta for each revision.
 
297
    :param search: A user text search string.
 
298
    :return: An iterator over lists of ((rev_id, revno, merge_depth), rev,
 
299
        delta).
 
300
    """
 
301
    # Convert view_revisions into (view, None, None) groups to fit with
 
302
    # the standard interface here.
 
303
    if type(view_revisions) == list:
 
304
        # A single batch conversion is faster than many incremental ones.
 
305
        # As we have all the data, do a batch conversion.
 
306
        nones = [None] * len(view_revisions)
 
307
        log_rev_iterator = iter([zip(view_revisions, nones, nones)])
 
308
    else:
 
309
        def _convert():
 
310
            for view in view_revisions:
 
311
                yield (view, None, None)
 
312
        log_rev_iterator = iter([_convert()])
 
313
    for adapter in log_adapters:
 
314
        log_rev_iterator = adapter(branch, generate_delta, search,
 
315
            log_rev_iterator)
 
316
    return log_rev_iterator
 
317
 
 
318
 
 
319
def _make_search_filter(branch, generate_delta, search, log_rev_iterator):
 
320
    """Create a filtered iterator of log_rev_iterator matching on a regex.
 
321
 
 
322
    :param branch: The branch being logged.
 
323
    :param generate_delta: Whether to generate a delta for each revision.
 
324
    :param search: A user text search string.
 
325
    :param log_rev_iterator: An input iterator containing all revisions that
 
326
        could be displayed, in lists.
 
327
    :return: An iterator over lists of ((rev_id, revno, merge_depth), rev,
 
328
        delta).
 
329
    """
 
330
    if search is None:
 
331
        return log_rev_iterator
 
332
    # Compile the search now to get early errors.
 
333
    searchRE = re.compile(search, re.IGNORECASE)
 
334
    return _filter_message_re(searchRE, log_rev_iterator)
 
335
 
 
336
 
 
337
def _filter_message_re(searchRE, log_rev_iterator):
 
338
    for revs in log_rev_iterator:
 
339
        new_revs = []
 
340
        for (rev_id, revno, merge_depth), rev, delta in revs:
 
341
            if searchRE.search(rev.message):
 
342
                new_revs.append(((rev_id, revno, merge_depth), rev, delta))
 
343
        yield new_revs
 
344
 
 
345
 
 
346
def _make_delta_filter(branch, generate_delta, search, log_rev_iterator):
 
347
    """Add revision deltas to a log iterator if needed.
 
348
 
 
349
    :param branch: The branch being logged.
 
350
    :param generate_delta: Whether to generate a delta for each revision.
 
351
    :param search: A user text search string.
 
352
    :param log_rev_iterator: An input iterator containing all revisions that
 
353
        could be displayed, in lists.
 
354
    :return: An iterator over lists of ((rev_id, revno, merge_depth), rev,
 
355
        delta).
 
356
    """
 
357
    if not generate_delta:
 
358
        return log_rev_iterator
 
359
    return _generate_deltas(branch.repository, log_rev_iterator)
 
360
 
 
361
 
 
362
def _generate_deltas(repository, log_rev_iterator):
 
363
    """Create deltas for each batch of revisions in log_rev_iterator."""
 
364
    for revs in log_rev_iterator:
 
365
        revisions = [rev[1] for rev in revs]
 
366
        deltas = repository.get_deltas_for_revisions(revisions)
 
367
        revs = [(rev[0], rev[1], delta) for rev, delta in izip(revs, deltas)]
 
368
        yield revs
 
369
 
 
370
 
 
371
def _make_revision_objects(branch, generate_delta, search, log_rev_iterator):
 
372
    """Extract revision objects from the repository
 
373
 
 
374
    :param branch: The branch being logged.
 
375
    :param generate_delta: Whether to generate a delta for each revision.
 
376
    :param search: A user text search string.
 
377
    :param log_rev_iterator: An input iterator containing all revisions that
 
378
        could be displayed, in lists.
 
379
    :return: An iterator over lists of ((rev_id, revno, merge_depth), rev,
 
380
        delta).
 
381
    """
 
382
    repository = branch.repository
 
383
    for revs in log_rev_iterator:
 
384
        # r = revision_id, n = revno, d = merge depth
 
385
        revision_ids = [view[0] for view, _, _ in revs]
 
386
        revisions = repository.get_revisions(revision_ids)
 
387
        revs = [(rev[0], revision, rev[2]) for rev, revision in
 
388
            izip(revs, revisions)]
 
389
        yield revs
 
390
 
 
391
 
 
392
def _make_batch_filter(branch, generate_delta, search, log_rev_iterator):
 
393
    """Group up a single large batch into smaller ones.
 
394
 
 
395
    :param branch: The branch being logged.
 
396
    :param generate_delta: Whether to generate a delta for each revision.
 
397
    :param search: A user text search string.
 
398
    :param log_rev_iterator: An input iterator containing all revisions that
 
399
        could be displayed, in lists.
 
400
    :return: An iterator over lists of ((rev_id, revno, merge_depth), rev, delta).
 
401
    """
 
402
    repository = branch.repository
 
403
    num = 9
 
404
    for batch in log_rev_iterator:
 
405
        batch = iter(batch)
 
406
        while True:
 
407
            step = [detail for _, detail in zip(range(num), batch)]
 
408
            if len(step) == 0:
 
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 
 
442
    if start_revision is None:
 
443
        start_revno = 1
 
444
    else:
 
445
        if isinstance(start_revision, revisionspec.RevisionInfo):
 
446
            start_rev_id = start_revision.rev_id
 
447
            start_revno = start_revision.revno or 1
 
448
        else:
 
449
            branch.check_real_revno(start_revision)
 
450
            start_revno = start_revision
 
451
    
 
452
    end_rev_id = None
 
453
    if end_revision is None:
 
454
        end_revno = branch_revno
 
455
    else:
 
456
        if isinstance(end_revision, revisionspec.RevisionInfo):
 
457
            end_rev_id = end_revision.rev_id
 
458
            end_revno = end_revision.revno or branch_revno
 
459
        else:
 
460
            branch.check_real_revno(end_revision)
 
461
            end_revno = end_revision
 
462
 
 
463
    if ((start_rev_id == _mod_revision.NULL_REVISION)
 
464
        or (end_rev_id == _mod_revision.NULL_REVISION)):
 
465
        raise errors.BzrCommandError('Logging revision 0 is invalid.')
 
466
    if start_revno > end_revno:
 
467
        raise errors.BzrCommandError("Start revision must be older than "
 
468
                                     "the end revision.")
 
469
 
 
470
    if end_revno < start_revno:
 
471
        return None, None, None, None
 
472
    cur_revno = branch_revno
 
473
    rev_nos = {}
 
474
    mainline_revs = []
 
475
    for revision_id in branch.repository.iter_reverse_revision_history(
 
476
                        branch_last_revision):
 
477
        if cur_revno < start_revno:
 
478
            # We have gone far enough, but we always add 1 more revision
 
479
            rev_nos[revision_id] = cur_revno
 
480
            mainline_revs.append(revision_id)
 
481
            break
 
482
        if cur_revno <= end_revno:
 
483
            rev_nos[revision_id] = cur_revno
 
484
            mainline_revs.append(revision_id)
 
485
        cur_revno -= 1
 
486
    else:
 
487
        # We walked off the edge of all revisions, so we add a 'None' marker
 
488
        mainline_revs.append(None)
 
489
 
 
490
    mainline_revs.reverse()
 
491
 
 
492
    # override the mainline to look like the revision history.
 
493
    return mainline_revs, rev_nos, start_rev_id, end_rev_id
 
494
 
 
495
 
 
496
def _filter_revision_range(view_revisions, start_rev_id, end_rev_id):
 
497
    """Filter view_revisions based on revision ranges.
 
498
 
 
499
    :param view_revisions: A list of (revision_id, dotted_revno, merge_depth) 
 
500
            tuples to be filtered.
 
501
 
 
502
    :param start_rev_id: If not NONE specifies the first revision to be logged.
 
503
            If NONE then all revisions up to the end_rev_id are logged.
 
504
 
 
505
    :param end_rev_id: If not NONE specifies the last revision to be logged.
 
506
            If NONE then all revisions up to the end of the log are logged.
 
507
 
 
508
    :return: The filtered view_revisions.
 
509
    """
 
510
    if start_rev_id or end_rev_id: 
 
511
        revision_ids = [r for r, n, d in view_revisions]
 
512
        if start_rev_id:
 
513
            start_index = revision_ids.index(start_rev_id)
 
514
        else:
 
515
            start_index = 0
 
516
        if start_rev_id == end_rev_id:
 
517
            end_index = start_index
 
518
        else:
 
519
            if end_rev_id:
 
520
                end_index = revision_ids.index(end_rev_id)
 
521
            else:
 
522
                end_index = len(view_revisions) - 1
 
523
        # To include the revisions merged into the last revision, 
 
524
        # extend end_rev_id down to, but not including, the next rev
 
525
        # with the same or lesser merge_depth
 
526
        end_merge_depth = view_revisions[end_index][2]
 
527
        try:
 
528
            for index in xrange(end_index+1, len(view_revisions)+1):
 
529
                if view_revisions[index][2] <= end_merge_depth:
 
530
                    end_index = index - 1
 
531
                    break
 
532
        except IndexError:
 
533
            # if the search falls off the end then log to the end as well
 
534
            end_index = len(view_revisions) - 1
 
535
        view_revisions = view_revisions[start_index:end_index+1]
 
536
    return view_revisions
 
537
 
 
538
 
 
539
def _filter_revisions_touching_file_id(branch, file_id, view_revisions,
 
540
                                       direction):
 
541
    r"""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 E
 
550
        |/ /
 
551
        D |
 
552
        |\|
 
553
        | F
 
554
        |/
 
555
        G
 
556
 
 
557
    And 'C' changes a file, then both C and D will be returned. F will not be
 
558
    returned even though it brings the changes to C into the branch starting
 
559
    with E. (Note that if we were using F as the tip instead of G, then we
 
560
    would see C, D, F.)
 
561
 
 
562
    This will also be restricted based on a subset of the mainline.
 
563
 
 
564
    :param branch: The branch where we can get text revision information.
 
565
    :param file_id: Filter out revisions that do not touch file_id.
 
566
    :param view_revisions: A list of (revision_id, dotted_revno, merge_depth)
 
567
        tuples. This is the list of revisions which will be filtered. It is
 
568
        assumed that view_revisions is in merge_sort order (either forward or
 
569
        reverse).
 
570
    :param direction: The direction of view_revisions.  See also
 
571
        reverse_by_depth, and get_view_revisions
 
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
    if direction == 'forward':
 
596
        # TODO: The algorithm for finding 'merges' of file changes expects
 
597
        #       'reverse' order (the default from 'merge_sort()'). Instead of
 
598
        #       forcing this, we could just use the reverse_by_depth order.
 
599
        view_revisions = reverse_by_depth(view_revisions)
 
600
    # Track what revisions will merge the current revision, replace entries
 
601
    # with 'None' when they have been added to result
 
602
    current_merge_stack = [None]
 
603
    for info in view_revisions:
 
604
        rev_id, revno, depth = info
 
605
        if depth == len(current_merge_stack):
 
606
            current_merge_stack.append(info)
 
607
        else:
 
608
            del current_merge_stack[depth + 1:]
 
609
            current_merge_stack[-1] = info
 
610
 
 
611
        if rev_id in modified_text_revisions:
 
612
            # This needs to be logged, along with the extra revisions
 
613
            for idx in xrange(len(current_merge_stack)):
 
614
                node = current_merge_stack[idx]
 
615
                if node is not None:
 
616
                    result.append(node)
 
617
                    current_merge_stack[idx] = None
 
618
    if direction == 'forward':
 
619
        result = reverse_by_depth(result)
 
620
    return result
 
621
 
 
622
 
 
623
def get_view_revisions(mainline_revs, rev_nos, branch, direction,
 
624
                       include_merges=True):
 
625
    """Produce an iterator of revisions to show
 
626
    :return: an iterator of (revision_id, revno, merge_depth)
 
627
    (if there is no revno for a revision, None is supplied)
 
628
    """
 
629
    if include_merges is False:
 
630
        revision_ids = mainline_revs[1:]
 
631
        if direction == 'reverse':
 
632
            revision_ids.reverse()
 
633
        for revision_id in revision_ids:
 
634
            yield revision_id, str(rev_nos[revision_id]), 0
 
635
        return
 
636
    graph = branch.repository.get_graph()
 
637
    # This asks for all mainline revisions, which means we only have to spider
 
638
    # sideways, rather than depth history. That said, its still size-of-history
 
639
    # and should be addressed.
 
640
    # mainline_revisions always includes an extra revision at the beginning, so
 
641
    # don't request it.
 
642
    parent_map = dict(((key, value) for key, value in
 
643
        graph.iter_ancestry(mainline_revs[1:]) if value is not None))
 
644
    # filter out ghosts; merge_sort errors on ghosts.
 
645
    rev_graph = _mod_repository._strip_NULL_ghosts(parent_map)
 
646
    merge_sorted_revisions = tsort.merge_sort(
 
647
        rev_graph,
 
648
        mainline_revs[-1],
 
649
        mainline_revs,
 
650
        generate_revno=True)
 
651
 
 
652
    if direction == 'forward':
 
653
        # forward means oldest first.
 
654
        merge_sorted_revisions = reverse_by_depth(merge_sorted_revisions)
 
655
    elif direction != 'reverse':
 
656
        raise ValueError('invalid direction %r' % direction)
 
657
 
 
658
    for sequence, rev_id, merge_depth, revno, end_of_merge in merge_sorted_revisions:
 
659
        yield rev_id, '.'.join(map(str, revno)), merge_depth
 
660
 
 
661
 
 
662
def reverse_by_depth(merge_sorted_revisions, _depth=0):
 
663
    """Reverse revisions by depth.
 
664
 
 
665
    Revisions with a different depth are sorted as a group with the previous
 
666
    revision of that depth.  There may be no topological justification for this,
 
667
    but it looks much nicer.
 
668
    """
 
669
    zd_revisions = []
 
670
    for val in merge_sorted_revisions:
 
671
        if val[2] == _depth:
 
672
            zd_revisions.append([val])
 
673
        else:
 
674
            zd_revisions[-1].append(val)
 
675
    for revisions in zd_revisions:
 
676
        if len(revisions) > 1:
 
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
    return result
 
683
 
 
684
 
 
685
class LogRevision(object):
 
686
    """A revision to be logged (by LogFormatter.log_revision).
 
687
 
 
688
    A simple wrapper for the attributes of a revision to be logged.
 
689
    The attributes may or may not be populated, as determined by the 
 
690
    logging options and the log formatter capabilities.
 
691
    """
 
692
 
 
693
    def __init__(self, rev=None, revno=None, merge_depth=0, delta=None,
 
694
                 tags=None):
 
695
        self.rev = rev
 
696
        self.revno = revno
 
697
        self.merge_depth = merge_depth
 
698
        self.delta = delta
 
699
        self.tags = tags
 
700
 
 
701
 
 
702
class LogFormatter(object):
 
703
    """Abstract class to display log messages.
 
704
 
 
705
    At a minimum, a derived class must implement the log_revision method.
 
706
 
 
707
    If the LogFormatter needs to be informed of the beginning or end of
 
708
    a log it should implement the begin_log and/or end_log hook methods.
 
709
 
 
710
    A LogFormatter should define the following supports_XXX flags 
 
711
    to indicate which LogRevision attributes it supports:
 
712
 
 
713
    - supports_delta must be True if this log formatter supports delta.
 
714
        Otherwise the delta attribute may not be populated.
 
715
    - supports_merge_revisions must be True if this log formatter supports 
 
716
        merge revisions.  If not, and if supports_single_merge_revisions is
 
717
        also not True, then only mainline revisions will be passed to the 
 
718
        formatter.
 
719
    - supports_single_merge_revision must be True if this log formatter
 
720
        supports logging only a single merge revision.  This flag is
 
721
        only relevant if supports_merge_revisions is not True.
 
722
    - supports_tags must be True if this log formatter supports tags.
 
723
        Otherwise the tags attribute may not be populated.
 
724
 
 
725
    Plugins can register functions to show custom revision properties using
 
726
    the properties_handler_registry. The registered function
 
727
    must respect the following interface description:
 
728
        def my_show_properties(properties_dict):
 
729
            # code that returns a dict {'name':'value'} of the properties 
 
730
            # to be shown
 
731
    """
 
732
 
 
733
    def __init__(self, to_file, show_ids=False, show_timezone='original'):
 
734
        self.to_file = to_file
 
735
        self.show_ids = show_ids
 
736
        self.show_timezone = show_timezone
 
737
 
 
738
# TODO: uncomment this block after show() has been removed.
 
739
# Until then defining log_revision would prevent _show_log calling show() 
 
740
# in legacy formatters.
 
741
#    def log_revision(self, revision):
 
742
#        """Log a revision.
 
743
#
 
744
#        :param  revision:   The LogRevision to be logged.
 
745
#        """
 
746
#        raise NotImplementedError('not implemented in abstract base')
 
747
 
 
748
    def short_committer(self, rev):
 
749
        name, address = config.parse_username(rev.committer)
 
750
        if name:
 
751
            return name
 
752
        return address
 
753
 
 
754
    def short_author(self, rev):
 
755
        name, address = config.parse_username(rev.get_apparent_author())
 
756
        if name:
 
757
            return name
 
758
        return address
 
759
 
 
760
    def show_properties(self, revision, indent):
 
761
        """Displays the custom properties returned by each registered handler.
114
762
        
115
 
    branch._need_readlock()
116
 
    precursor = None
117
 
    if verbose:
118
 
        prev_inv = Inventory()
119
 
    for revno, revision_id in which_revs():
120
 
        print >>to_file,  '-' * 60
121
 
        print >>to_file,  'revno:', revno
122
 
        rev = branch.get_revision(revision_id)
123
 
        if show_ids:
124
 
            print >>to_file,  'revision-id:', revision_id
125
 
        print >>to_file,  'committer:', rev.committer
126
 
        print >>to_file,  'timestamp: %s' % (format_date(rev.timestamp, rev.timezone or 0,
127
 
                                             show_timezone))
128
 
 
129
 
        if revision_id != rev.revision_id:
130
 
            raise BzrCheckError("retrieved wrong revision: %r"
131
 
                                % (revision_id, rev.revision_id))
132
 
 
133
 
        print >>to_file,  'message:'
 
763
        If a registered handler raises an error it is propagated.
 
764
        """
 
765
        for key, handler in properties_handler_registry.iteritems():
 
766
            for key, value in handler(revision).items():
 
767
                self.to_file.write(indent + key + ': ' + value + '\n')
 
768
 
 
769
 
 
770
class LongLogFormatter(LogFormatter):
 
771
 
 
772
    supports_merge_revisions = True
 
773
    supports_delta = True
 
774
    supports_tags = True
 
775
 
 
776
    def log_revision(self, revision):
 
777
        """Log a revision, either merged or not."""
 
778
        indent = '    ' * revision.merge_depth
 
779
        to_file = self.to_file
 
780
        to_file.write(indent + '-' * 60 + '\n')
 
781
        if revision.revno is not None:
 
782
            to_file.write(indent + 'revno: %s\n' % (revision.revno,))
 
783
        if revision.tags:
 
784
            to_file.write(indent + 'tags: %s\n' % (', '.join(revision.tags)))
 
785
        if self.show_ids:
 
786
            to_file.write(indent + 'revision-id: ' + revision.rev.revision_id)
 
787
            to_file.write('\n')
 
788
            for parent_id in revision.rev.parent_ids:
 
789
                to_file.write(indent + 'parent: %s\n' % (parent_id,))
 
790
        self.show_properties(revision.rev, indent)
 
791
 
 
792
        author = revision.rev.properties.get('author', None)
 
793
        if author is not None:
 
794
            to_file.write(indent + 'author: %s\n' % (author,))
 
795
        to_file.write(indent + 'committer: %s\n' % (revision.rev.committer,))
 
796
 
 
797
        branch_nick = revision.rev.properties.get('branch-nick', None)
 
798
        if branch_nick is not None:
 
799
            to_file.write(indent + 'branch nick: %s\n' % (branch_nick,))
 
800
 
 
801
        date_str = format_date(revision.rev.timestamp,
 
802
                               revision.rev.timezone or 0,
 
803
                               self.show_timezone)
 
804
        to_file.write(indent + 'timestamp: %s\n' % (date_str,))
 
805
 
 
806
        to_file.write(indent + 'message:\n')
 
807
        if not revision.rev.message:
 
808
            to_file.write(indent + '  (no message)\n')
 
809
        else:
 
810
            message = revision.rev.message.rstrip('\r\n')
 
811
            for l in message.split('\n'):
 
812
                to_file.write(indent + '  %s\n' % (l,))
 
813
        if revision.delta is not None:
 
814
            revision.delta.show(to_file, self.show_ids, indent=indent)
 
815
 
 
816
 
 
817
class ShortLogFormatter(LogFormatter):
 
818
 
 
819
    supports_delta = True
 
820
    supports_single_merge_revision = True
 
821
 
 
822
    def log_revision(self, revision):
 
823
        to_file = self.to_file
 
824
        is_merge = ''
 
825
        if len(revision.rev.parent_ids) > 1:
 
826
            is_merge = ' [merge]'
 
827
        to_file.write("%5s %s\t%s%s\n" % (revision.revno,
 
828
                self.short_author(revision.rev),
 
829
                format_date(revision.rev.timestamp,
 
830
                            revision.rev.timezone or 0,
 
831
                            self.show_timezone, date_fmt="%Y-%m-%d",
 
832
                            show_offset=False),
 
833
                is_merge))
 
834
        if self.show_ids:
 
835
            to_file.write('      revision-id:%s\n' % (revision.rev.revision_id,))
 
836
        if not revision.rev.message:
 
837
            to_file.write('      (no message)\n')
 
838
        else:
 
839
            message = revision.rev.message.rstrip('\r\n')
 
840
            for l in message.split('\n'):
 
841
                to_file.write('      %s\n' % (l,))
 
842
 
 
843
        # TODO: Why not show the modified files in a shorter form as
 
844
        # well? rewrap them single lines of appropriate length
 
845
        if revision.delta is not None:
 
846
            revision.delta.show(to_file, self.show_ids)
 
847
        to_file.write('\n')
 
848
 
 
849
 
 
850
class LineLogFormatter(LogFormatter):
 
851
 
 
852
    supports_single_merge_revision = True
 
853
 
 
854
    def __init__(self, *args, **kwargs):
 
855
        super(LineLogFormatter, self).__init__(*args, **kwargs)
 
856
        self._max_chars = terminal_width() - 1
 
857
 
 
858
    def truncate(self, str, max_len):
 
859
        if len(str) <= max_len:
 
860
            return str
 
861
        return str[:max_len-3]+'...'
 
862
 
 
863
    def date_string(self, rev):
 
864
        return format_date(rev.timestamp, rev.timezone or 0, 
 
865
                           self.show_timezone, date_fmt="%Y-%m-%d",
 
866
                           show_offset=False)
 
867
 
 
868
    def message(self, rev):
134
869
        if not rev.message:
135
 
            print >>to_file,  '  (no message)'
 
870
            return '(no message)'
136
871
        else:
137
 
            for l in rev.message.split('\n'):
138
 
                print >>to_file,  '  ' + l
139
 
 
140
 
        # Don't show a list of changed files if we were asked about
141
 
        # one specific file.
142
 
 
143
 
        if verbose and not filename:
144
 
            this_inv = branch.get_inventory(rev.inventory_id)
145
 
            delta = compare_inventories(prev_inv, this_inv)
146
 
 
147
 
            if delta.removed:
148
 
                print >>to_file, 'removed files:'
149
 
                for path, fid in delta.removed:
150
 
                    if show_ids:
151
 
                        print >>to_file, '  %-30s %s' % (path, fid)
152
 
                    else:
153
 
                        print >>to_file, ' ', path
154
 
            if delta.added:
155
 
                print >>to_file, 'added files:'
156
 
                for path, fid in delta.added:
157
 
                    if show_ids:
158
 
                        print >>to_file, '  %-30s %s' % (path, fid)
159
 
                    else:
160
 
                        print >>to_file, '  ' + path
161
 
            if delta.renamed:
162
 
                print >>to_file, 'renamed files:'
163
 
                for oldpath, newpath, fid in delta.renamed:
164
 
                    if show_ids:
165
 
                        print >>to_file, '  %s => %s %s' % (oldpath, newpath, fid)
166
 
                    else:
167
 
                        print >>to_file, '  %s => %s' % (oldpath, newpath)
168
 
            if delta.modified:
169
 
                print >>to_file, 'modified files:'
170
 
                for path, fid in delta.modified:
171
 
                    if show_ids:
172
 
                        print >>to_file, '  %-30s %s' % (path, fid)
173
 
                    else:
174
 
                        print >>to_file, '  ' + path
175
 
 
176
 
            prev_inv = this_inv
177
 
 
178
 
        precursor = revision_id
179
 
 
 
872
            return rev.message
 
873
 
 
874
    def log_revision(self, revision):
 
875
        self.to_file.write(self.log_string(revision.revno, revision.rev,
 
876
                                              self._max_chars))
 
877
        self.to_file.write('\n')
 
878
 
 
879
    def log_string(self, revno, rev, max_chars):
 
880
        """Format log info into one string. Truncate tail of string
 
881
        :param  revno:      revision number or None.
 
882
                            Revision numbers counts from 1.
 
883
        :param  rev:        revision info object
 
884
        :param  max_chars:  maximum length of resulting string
 
885
        :return:            formatted truncated string
 
886
        """
 
887
        out = []
 
888
        if revno:
 
889
            # show revno only when is not None
 
890
            out.append("%s:" % revno)
 
891
        out.append(self.truncate(self.short_author(rev), 20))
 
892
        out.append(self.date_string(rev))
 
893
        out.append(rev.get_summary())
 
894
        return self.truncate(" ".join(out).rstrip('\n'), max_chars)
 
895
 
 
896
 
 
897
def line_log(rev, max_chars):
 
898
    lf = LineLogFormatter(None)
 
899
    return lf.log_string(None, rev, max_chars)
 
900
 
 
901
 
 
902
class LogFormatterRegistry(registry.Registry):
 
903
    """Registry for log formatters"""
 
904
 
 
905
    def make_formatter(self, name, *args, **kwargs):
 
906
        """Construct a formatter from arguments.
 
907
 
 
908
        :param name: Name of the formatter to construct.  'short', 'long' and
 
909
            'line' are built-in.
 
910
        """
 
911
        return self.get(name)(*args, **kwargs)
 
912
 
 
913
    def get_default(self, branch):
 
914
        return self.get(branch.get_config().log_format())
 
915
 
 
916
 
 
917
log_formatter_registry = LogFormatterRegistry()
 
918
 
 
919
 
 
920
log_formatter_registry.register('short', ShortLogFormatter,
 
921
                                'Moderately short log format')
 
922
log_formatter_registry.register('long', LongLogFormatter,
 
923
                                'Detailed log format')
 
924
log_formatter_registry.register('line', LineLogFormatter,
 
925
                                'Log format with one line per revision')
 
926
 
 
927
 
 
928
def register_formatter(name, formatter):
 
929
    log_formatter_registry.register(name, formatter)
 
930
 
 
931
 
 
932
def log_formatter(name, *args, **kwargs):
 
933
    """Construct a formatter from arguments.
 
934
 
 
935
    name -- Name of the formatter to construct; currently 'long', 'short' and
 
936
        'line' are supported.
 
937
    """
 
938
    try:
 
939
        return log_formatter_registry.make_formatter(name, *args, **kwargs)
 
940
    except KeyError:
 
941
        raise errors.BzrCommandError("unknown log formatter: %r" % name)
 
942
 
 
943
 
 
944
def show_one_log(revno, rev, delta, verbose, to_file, show_timezone):
 
945
    # deprecated; for compatibility
 
946
    lf = LongLogFormatter(to_file=to_file, show_timezone=show_timezone)
 
947
    lf.show(revno, rev, delta)
 
948
 
 
949
 
 
950
def show_changed_revisions(branch, old_rh, new_rh, to_file=None,
 
951
                           log_format='long'):
 
952
    """Show the change in revision history comparing the old revision history to the new one.
 
953
 
 
954
    :param branch: The branch where the revisions exist
 
955
    :param old_rh: The old revision history
 
956
    :param new_rh: The new revision history
 
957
    :param to_file: A file to write the results to. If None, stdout will be used
 
958
    """
 
959
    if to_file is None:
 
960
        to_file = codecs.getwriter(get_terminal_encoding())(sys.stdout,
 
961
            errors='replace')
 
962
    lf = log_formatter(log_format,
 
963
                       show_ids=False,
 
964
                       to_file=to_file,
 
965
                       show_timezone='original')
 
966
 
 
967
    # This is the first index which is different between
 
968
    # old and new
 
969
    base_idx = None
 
970
    for i in xrange(max(len(new_rh),
 
971
                        len(old_rh))):
 
972
        if (len(new_rh) <= i
 
973
            or len(old_rh) <= i
 
974
            or new_rh[i] != old_rh[i]):
 
975
            base_idx = i
 
976
            break
 
977
 
 
978
    if base_idx is None:
 
979
        to_file.write('Nothing seems to have changed\n')
 
980
        return
 
981
    ## TODO: It might be nice to do something like show_log
 
982
    ##       and show the merged entries. But since this is the
 
983
    ##       removed revisions, it shouldn't be as important
 
984
    if base_idx < len(old_rh):
 
985
        to_file.write('*'*60)
 
986
        to_file.write('\nRemoved Revisions:\n')
 
987
        for i in range(base_idx, len(old_rh)):
 
988
            rev = branch.repository.get_revision(old_rh[i])
 
989
            lr = LogRevision(rev, i+1, 0, None)
 
990
            lf.log_revision(lr)
 
991
        to_file.write('*'*60)
 
992
        to_file.write('\n\n')
 
993
    if base_idx < len(new_rh):
 
994
        to_file.write('Added Revisions:\n')
 
995
        show_log(branch,
 
996
                 lf,
 
997
                 None,
 
998
                 verbose=False,
 
999
                 direction='forward',
 
1000
                 start_revision=base_idx+1,
 
1001
                 end_revision=len(new_rh),
 
1002
                 search=None)
 
1003
 
 
1004
 
 
1005
properties_handler_registry = registry.Registry()
 
1006
 
 
1007
# adapters which revision ids to log are filtered. When log is called, the
 
1008
# log_rev_iterator is adapted through each of these factory methods.
 
1009
# Plugins are welcome to mutate this list in any way they like - as long
 
1010
# as the overall behaviour is preserved. At this point there is no extensible
 
1011
# mechanism for getting parameters to each factory method, and until there is
 
1012
# this won't be considered a stable api.
 
1013
log_adapters = [
 
1014
    # core log logic
 
1015
    _make_batch_filter,
 
1016
    # read revision objects
 
1017
    _make_revision_objects,
 
1018
    # filter on log messages
 
1019
    _make_search_filter,
 
1020
    # generate deltas for things we will show
 
1021
    _make_delta_filter
 
1022
    ]