/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/log.py

  • Committer: Robert Collins
  • Date: 2010-05-06 11:08:10 UTC
  • mto: This revision was merged to the branch mainline in revision 5223.
  • Revision ID: robertc@robertcollins.net-20100506110810-h3j07fh5gmw54s25
Cleaner matcher matching revised unlocking protocol.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005-2011 Canonical Ltd
 
1
# Copyright (C) 2005-2010 Canonical Ltd
2
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
14
14
# along with this program; if not, write to the Free Software
15
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
16
 
 
17
 
 
18
 
17
19
"""Code to show logs of changes.
18
20
 
19
21
Various flavors of log can be produced:
47
49
all the changes since the previous revision that touched hello.c.
48
50
"""
49
51
 
50
 
from __future__ import absolute_import
51
 
 
52
52
import codecs
53
 
import itertools
 
53
from cStringIO import StringIO
 
54
from itertools import (
 
55
    chain,
 
56
    izip,
 
57
    )
54
58
import re
55
59
import sys
56
60
from warnings import (
57
61
    warn,
58
62
    )
59
63
 
60
 
from .lazy_import import lazy_import
 
64
from bzrlib.lazy_import import lazy_import
61
65
lazy_import(globals(), """
62
66
 
63
 
from breezy import (
 
67
from bzrlib import (
 
68
    bzrdir,
64
69
    config,
65
 
    controldir,
66
70
    diff,
 
71
    errors,
67
72
    foreign,
68
73
    repository as _mod_repository,
69
74
    revision as _mod_revision,
 
75
    revisionspec,
 
76
    trace,
70
77
    tsort,
71
78
    )
72
 
from breezy.i18n import gettext, ngettext
73
79
""")
74
80
 
75
 
from . import (
76
 
    errors,
77
 
    lazy_regex,
 
81
from bzrlib import (
78
82
    registry,
79
 
    revisionspec,
80
83
    )
81
 
from .osutils import (
 
84
from bzrlib.osutils import (
82
85
    format_date,
83
86
    format_date_with_offset_in_original_timezone,
84
 
    get_diff_header_encoding,
85
87
    get_terminal_encoding,
 
88
    re_compile_checked,
86
89
    terminal_width,
87
90
    )
88
 
from .sixish import (
89
 
    BytesIO,
90
 
    range,
91
 
    zip,
 
91
from bzrlib.symbol_versioning import (
 
92
    deprecated_function,
 
93
    deprecated_in,
92
94
    )
93
 
from .tree import find_previous_path
94
 
 
95
 
 
96
 
def find_touching_revisions(repository, last_revision, last_tree, last_path):
 
95
 
 
96
 
 
97
def find_touching_revisions(branch, file_id):
97
98
    """Yield a description of revisions which affect the file_id.
98
99
 
99
100
    Each returned element is (revno, revision_id, description)
104
105
    TODO: Perhaps some way to limit this to only particular revisions,
105
106
    or to traverse a non-mainline set of revisions?
106
107
    """
107
 
    last_verifier = last_tree.get_file_verifier(last_path)
108
 
    graph = repository.get_graph()
109
 
    history = list(graph.iter_lefthand_ancestry(last_revision, []))
110
 
    revno = len(history)
111
 
    for revision_id in history:
112
 
        this_tree = repository.revision_tree(revision_id)
113
 
        this_path = find_previous_path(last_tree, this_tree, last_path)
 
108
    last_ie = None
 
109
    last_path = None
 
110
    revno = 1
 
111
    for revision_id in branch.revision_history():
 
112
        this_inv = branch.repository.get_inventory(revision_id)
 
113
        if file_id in this_inv:
 
114
            this_ie = this_inv[file_id]
 
115
            this_path = this_inv.id2path(file_id)
 
116
        else:
 
117
            this_ie = this_path = None
114
118
 
115
119
        # now we know how it was last time, and how it is in this revision.
116
120
        # are those two states effectively the same or not?
117
 
        if this_path is not None and last_path is None:
118
 
            yield revno, revision_id, "deleted " + this_path
119
 
            this_verifier = this_tree.get_file_verifier(this_path)
120
 
        elif this_path is None and last_path is not None:
121
 
            yield revno, revision_id, "added " + last_path
 
121
 
 
122
        if not this_ie and not last_ie:
 
123
            # not present in either
 
124
            pass
 
125
        elif this_ie and not last_ie:
 
126
            yield revno, revision_id, "added " + this_path
 
127
        elif not this_ie and last_ie:
 
128
            # deleted here
 
129
            yield revno, revision_id, "deleted " + last_path
122
130
        elif this_path != last_path:
123
 
            yield revno, revision_id, ("renamed %s => %s" % (this_path, last_path))
124
 
            this_verifier = this_tree.get_file_verifier(this_path)
125
 
        else:
126
 
            this_verifier = this_tree.get_file_verifier(this_path)
127
 
            if (this_verifier != last_verifier):
128
 
                yield revno, revision_id, "modified " + this_path
 
131
            yield revno, revision_id, ("renamed %s => %s" % (last_path, this_path))
 
132
        elif (this_ie.text_size != last_ie.text_size
 
133
              or this_ie.text_sha1 != last_ie.text_sha1):
 
134
            yield revno, revision_id, "modified " + this_path
129
135
 
130
 
        last_verifier = this_verifier
 
136
        last_ie = this_ie
131
137
        last_path = this_path
132
 
        last_tree = this_tree
133
 
        if last_path is None:
134
 
            return
135
 
        revno -= 1
 
138
        revno += 1
 
139
 
 
140
 
 
141
def _enumerate_history(branch):
 
142
    rh = []
 
143
    revno = 1
 
144
    for rev_id in branch.revision_history():
 
145
        rh.append((revno, rev_id))
 
146
        revno += 1
 
147
    return rh
136
148
 
137
149
 
138
150
def show_log(branch,
144
156
             end_revision=None,
145
157
             search=None,
146
158
             limit=None,
147
 
             show_diff=False,
148
 
             match=None):
 
159
             show_diff=False):
149
160
    """Write out human-readable log of commits to this branch.
150
161
 
151
162
    This function is being retained for backwards compatibility but
174
185
        if None or 0.
175
186
 
176
187
    :param show_diff: If True, output a diff after each revision.
177
 
 
178
 
    :param match: Dictionary of search lists to use when matching revision
179
 
      properties.
180
188
    """
181
189
    # Convert old-style parameters to new-style parameters
182
190
    if specific_fileid is not None:
198
206
    else:
199
207
        diff_type = None
200
208
 
201
 
    if isinstance(start_revision, int):
202
 
        try:
203
 
            start_revision = revisionspec.RevisionInfo(branch, start_revision)
204
 
        except errors.NoSuchRevision:
205
 
            raise errors.InvalidRevisionNumber(start_revision)
206
 
 
207
 
    if isinstance(end_revision, int):
208
 
        try:
209
 
            end_revision = revisionspec.RevisionInfo(branch, end_revision)
210
 
        except errors.NoSuchRevision:
211
 
            raise errors.InvalidRevisionNumber(end_revision)
212
 
 
213
 
    if end_revision is not None and end_revision.revno == 0:
214
 
        raise errors.InvalidRevisionNumber(end_revision.revno)
215
 
 
216
209
    # Build the request and execute it
217
210
    rqst = make_log_request_dict(direction=direction, specific_fileids=file_ids,
218
211
        start_revision=start_revision, end_revision=end_revision,
221
214
    Logger(branch, rqst).show(lf)
222
215
 
223
216
 
224
 
# Note: This needs to be kept in sync with the defaults in
 
217
# Note: This needs to be kept this in sync with the defaults in
225
218
# make_log_request_dict() below
226
219
_DEFAULT_REQUEST_PARAMS = {
227
220
    'direction': 'reverse',
228
 
    'levels': None,
 
221
    'levels': 1,
229
222
    'generate_tags': True,
230
223
    'exclude_common_ancestry': False,
231
224
    '_match_using_deltas': True,
234
227
 
235
228
def make_log_request_dict(direction='reverse', specific_fileids=None,
236
229
                          start_revision=None, end_revision=None, limit=None,
237
 
                          message_search=None, levels=None, generate_tags=True,
 
230
                          message_search=None, levels=1, generate_tags=True,
238
231
                          delta_type=None,
239
232
                          diff_type=None, _match_using_deltas=True,
240
 
                          exclude_common_ancestry=False, match=None,
241
 
                          signature=False, omit_merges=False,
 
233
                          exclude_common_ancestry=False,
242
234
                          ):
243
235
    """Convenience function for making a logging request dictionary.
244
236
 
265
257
      matching commit messages
266
258
 
267
259
    :param levels: the number of levels of revisions to
268
 
      generate; 1 for just the mainline; 0 for all levels, or None for
269
 
      a sensible default.
 
260
      generate; 1 for just the mainline; 0 for all levels.
270
261
 
271
262
    :param generate_tags: If True, include tags for matched revisions.
272
 
`
 
263
 
273
264
    :param delta_type: Either 'full', 'partial' or None.
274
265
      'full' means generate the complete delta - adds/deletes/modifies/etc;
275
266
      'partial' means filter the delta using specific_fileids;
282
273
 
283
274
    :param _match_using_deltas: a private parameter controlling the
284
275
      algorithm used for matching specific_fileids. This parameter
285
 
      may be removed in the future so breezy client code should NOT
 
276
      may be removed in the future so bzrlib client code should NOT
286
277
      use it.
287
278
 
288
279
    :param exclude_common_ancestry: Whether -rX..Y should be interpreted as a
289
280
      range operator or as a graph difference.
290
 
 
291
 
    :param signature: show digital signature information
292
 
 
293
 
    :param match: Dictionary of list of search strings to use when filtering
294
 
      revisions. Keys can be 'message', 'author', 'committer', 'bugs' or
295
 
      the empty string to match any of the preceding properties.
296
 
 
297
 
    :param omit_merges: If True, commits with more than one parent are
298
 
      omitted.
299
 
 
300
281
    """
301
 
    # Take care of old style message_search parameter
302
 
    if message_search:
303
 
        if match:
304
 
            if 'message' in match:
305
 
                match['message'].append(message_search)
306
 
            else:
307
 
                match['message'] = [message_search]
308
 
        else:
309
 
            match= {'message': [message_search]}
310
282
    return {
311
283
        'direction': direction,
312
284
        'specific_fileids': specific_fileids,
313
285
        'start_revision': start_revision,
314
286
        'end_revision': end_revision,
315
287
        'limit': limit,
 
288
        'message_search': message_search,
316
289
        'levels': levels,
317
290
        'generate_tags': generate_tags,
318
291
        'delta_type': delta_type,
319
292
        'diff_type': diff_type,
320
293
        'exclude_common_ancestry': exclude_common_ancestry,
321
 
        'signature': signature,
322
 
        'match': match,
323
 
        'omit_merges': omit_merges,
324
294
        # Add 'private' attributes for features that may be deprecated
325
295
        '_match_using_deltas': _match_using_deltas,
326
296
    }
328
298
 
329
299
def _apply_log_request_defaults(rqst):
330
300
    """Apply default values to a request dictionary."""
331
 
    result = _DEFAULT_REQUEST_PARAMS.copy()
 
301
    result = _DEFAULT_REQUEST_PARAMS
332
302
    if rqst:
333
303
        result.update(rqst)
334
304
    return result
335
305
 
336
306
 
337
 
def format_signature_validity(rev_id, branch):
338
 
    """get the signature validity
339
 
 
340
 
    :param rev_id: revision id to validate
341
 
    :param branch: branch of revision
342
 
    :return: human readable string to print to log
343
 
    """
344
 
    from breezy import gpg
345
 
 
346
 
    gpg_strategy = gpg.GPGStrategy(branch.get_config_stack())
347
 
    result = branch.repository.verify_revision_signature(rev_id, gpg_strategy)
348
 
    if result[0] == gpg.SIGNATURE_VALID:
349
 
        return u"valid signature from {0}".format(result[1])
350
 
    if result[0] == gpg.SIGNATURE_KEY_MISSING:
351
 
        return "unknown key {0}".format(result[1])
352
 
    if result[0] == gpg.SIGNATURE_NOT_VALID:
353
 
        return "invalid signature!"
354
 
    if result[0] == gpg.SIGNATURE_NOT_SIGNED:
355
 
        return "no signature"
356
 
 
357
 
 
358
307
class LogGenerator(object):
359
308
    """A generator of log revisions."""
360
309
 
387
336
        if not isinstance(lf, LogFormatter):
388
337
            warn("not a LogFormatter instance: %r" % lf)
389
338
 
390
 
        with self.branch.lock_read():
 
339
        self.branch.lock_read()
 
340
        try:
391
341
            if getattr(lf, 'begin_log', None):
392
342
                lf.begin_log()
393
343
            self._show_body(lf)
394
344
            if getattr(lf, 'end_log', None):
395
345
                lf.end_log()
 
346
        finally:
 
347
            self.branch.unlock()
396
348
 
397
349
    def _show_body(self, lf):
398
350
        """Show the main log output.
402
354
        # Tweak the LogRequest based on what the LogFormatter can handle.
403
355
        # (There's no point generating stuff if the formatter can't display it.)
404
356
        rqst = self.rqst
405
 
        if rqst['levels'] is None or lf.get_levels() > rqst['levels']:
406
 
            # user didn't specify levels, use whatever the LF can handle:
407
 
            rqst['levels'] = lf.get_levels()
408
 
 
 
357
        rqst['levels'] = lf.get_levels()
409
358
        if not getattr(lf, 'supports_tags', False):
410
359
            rqst['generate_tags'] = False
411
360
        if not getattr(lf, 'supports_delta', False):
412
361
            rqst['delta_type'] = None
413
362
        if not getattr(lf, 'supports_diff', False):
414
363
            rqst['diff_type'] = None
415
 
        if not getattr(lf, 'supports_signatures', False):
416
 
            rqst['signature'] = False
417
364
 
418
365
        # Find and print the interesting revisions
419
366
        generator = self._generator_factory(self.branch, rqst)
420
 
        try:
421
 
            for lr in generator.iter_log_revisions():
422
 
                lf.log_revision(lr)
423
 
        except errors.GhostRevisionUnusableHere:
424
 
            raise errors.BzrCommandError(
425
 
                    gettext('Further revision history missing.'))
 
367
        for lr in generator.iter_log_revisions():
 
368
            lf.log_revision(lr)
426
369
        lf.show_advice()
427
370
 
428
371
    def _generator_factory(self, branch, rqst):
429
372
        """Make the LogGenerator object to use.
430
 
 
 
373
        
431
374
        Subclasses may wish to override this.
432
375
        """
433
376
        return _DefaultLogGenerator(branch, rqst)
457
400
        levels = rqst.get('levels')
458
401
        limit = rqst.get('limit')
459
402
        diff_type = rqst.get('diff_type')
460
 
        show_signature = rqst.get('signature')
461
 
        omit_merges = rqst.get('omit_merges')
462
403
        log_count = 0
463
404
        revision_iterator = self._create_log_revision_iterator()
464
405
        for revs in revision_iterator:
465
406
            for (rev_id, revno, merge_depth), rev, delta in revs:
466
407
                # 0 levels means show everything; merge_depth counts from 0
467
 
                if levels != 0 and merge_depth is not None and merge_depth >= levels:
468
 
                    continue
469
 
                if omit_merges and len(rev.parent_ids) > 1:
470
 
                    continue
471
 
                if rev is None:
472
 
                    raise errors.GhostRevisionUnusableHere(rev_id)
 
408
                if levels != 0 and merge_depth >= levels:
 
409
                    continue
473
410
                if diff_type is None:
474
411
                    diff = None
475
412
                else:
476
413
                    diff = self._format_diff(rev, rev_id, diff_type)
477
 
                if show_signature:
478
 
                    signature = format_signature_validity(rev_id, self.branch)
479
 
                else:
480
 
                    signature = None
481
414
                yield LogRevision(rev, revno, merge_depth, delta,
482
 
                    self.rev_tag_dict.get(rev_id), diff, signature)
 
415
                    self.rev_tag_dict.get(rev_id), diff)
483
416
                if limit:
484
417
                    log_count += 1
485
418
                    if log_count >= limit:
498
431
            specific_files = [tree_2.id2path(id) for id in file_ids]
499
432
        else:
500
433
            specific_files = None
501
 
        s = BytesIO()
502
 
        path_encoding = get_diff_header_encoding()
 
434
        s = StringIO()
503
435
        diff.show_diff_trees(tree_1, tree_2, s, specific_files, old_label='',
504
 
            new_label='', path_encoding=path_encoding)
 
436
            new_label='')
505
437
        return s.getvalue()
506
438
 
507
439
    def _create_log_revision_iterator(self):
540
472
 
541
473
        # Apply the other filters
542
474
        return make_log_rev_iterator(self.branch, view_revisions,
543
 
            rqst.get('delta_type'), rqst.get('match'),
 
475
            rqst.get('delta_type'), rqst.get('message_search'),
544
476
            file_ids=rqst.get('specific_fileids'),
545
477
            direction=rqst.get('direction'))
546
478
 
559
491
            rqst.get('specific_fileids')[0], view_revisions,
560
492
            include_merges=rqst.get('levels') != 1)
561
493
        return make_log_rev_iterator(self.branch, view_revisions,
562
 
            rqst.get('delta_type'), rqst.get('match'))
 
494
            rqst.get('delta_type'), rqst.get('message_search'))
563
495
 
564
496
 
565
497
def _calc_view_revisions(branch, start_rev_id, end_rev_id, direction,
573
505
             a list of the same tuples.
574
506
    """
575
507
    if (exclude_common_ancestry and start_rev_id == end_rev_id):
576
 
        raise errors.BzrCommandError(gettext(
577
 
            '--exclude-common-ancestry requires two different revisions'))
 
508
        raise errors.BzrCommandError(
 
509
            '--exclude-common-ancestry requires two different revisions')
578
510
    if direction not in ('reverse', 'forward'):
579
 
        raise ValueError(gettext('invalid direction %r') % direction)
580
 
    br_rev_id = branch.last_revision()
581
 
    if br_rev_id == _mod_revision.NULL_REVISION:
 
511
        raise ValueError('invalid direction %r' % direction)
 
512
    br_revno, br_rev_id = branch.last_revision_info()
 
513
    if br_revno == 0:
582
514
        return []
583
515
 
584
516
    if (end_rev_id and start_rev_id == end_rev_id
585
517
        and (not generate_merge_revisions
586
518
             or not _has_merges(branch, end_rev_id))):
587
519
        # If a single revision is requested, check we can handle it
588
 
        return  _generate_one_revision(branch, end_rev_id, br_rev_id,
589
 
                                       branch.revno())
590
 
    if not generate_merge_revisions:
591
 
        try:
592
 
            # If we only want to see linear revisions, we can iterate ...
593
 
            iter_revs = _linear_view_revisions(
594
 
                branch, start_rev_id, end_rev_id,
595
 
                exclude_common_ancestry=exclude_common_ancestry)
596
 
            # If a start limit was given and it's not obviously an
597
 
            # ancestor of the end limit, check it before outputting anything
598
 
            if (direction == 'forward'
599
 
                or (start_rev_id and not _is_obvious_ancestor(
600
 
                        branch, start_rev_id, end_rev_id))):
601
 
                    iter_revs = list(iter_revs)
602
 
            if direction == 'forward':
603
 
                iter_revs = reversed(iter_revs)
604
 
            return iter_revs
605
 
        except _StartNotLinearAncestor:
606
 
            # Switch to the slower implementation that may be able to find a
607
 
            # non-obvious ancestor out of the left-hand history.
608
 
            pass
609
 
    iter_revs = _generate_all_revisions(branch, start_rev_id, end_rev_id,
610
 
                                        direction, delayed_graph_generation,
611
 
                                        exclude_common_ancestry)
612
 
    if direction == 'forward':
613
 
        iter_revs = _rebase_merge_depth(reverse_by_depth(list(iter_revs)))
 
520
        iter_revs = _generate_one_revision(branch, end_rev_id, br_rev_id,
 
521
                                           br_revno)
 
522
    elif not generate_merge_revisions:
 
523
        # If we only want to see linear revisions, we can iterate ...
 
524
        iter_revs = _generate_flat_revisions(branch, start_rev_id, end_rev_id,
 
525
                                             direction)
 
526
        if direction == 'forward':
 
527
            iter_revs = reversed(iter_revs)
 
528
    else:
 
529
        iter_revs = _generate_all_revisions(branch, start_rev_id, end_rev_id,
 
530
                                            direction, delayed_graph_generation,
 
531
                                            exclude_common_ancestry)
 
532
        if direction == 'forward':
 
533
            iter_revs = _rebase_merge_depth(reverse_by_depth(list(iter_revs)))
614
534
    return iter_revs
615
535
 
616
536
 
619
539
        # It's the tip
620
540
        return [(br_rev_id, br_revno, 0)]
621
541
    else:
622
 
        revno_str = _compute_revno_str(branch, rev_id)
 
542
        revno = branch.revision_id_to_dotted_revno(rev_id)
 
543
        revno_str = '.'.join(str(n) for n in revno)
623
544
        return [(rev_id, revno_str, 0)]
624
545
 
625
546
 
 
547
def _generate_flat_revisions(branch, start_rev_id, end_rev_id, direction):
 
548
    result = _linear_view_revisions(branch, start_rev_id, end_rev_id)
 
549
    # If a start limit was given and it's not obviously an
 
550
    # ancestor of the end limit, check it before outputting anything
 
551
    if direction == 'forward' or (start_rev_id
 
552
        and not _is_obvious_ancestor(branch, start_rev_id, end_rev_id)):
 
553
        try:
 
554
            result = list(result)
 
555
        except _StartNotLinearAncestor:
 
556
            raise errors.BzrCommandError('Start revision not found in'
 
557
                ' left-hand history of end revision.')
 
558
    return result
 
559
 
 
560
 
626
561
def _generate_all_revisions(branch, start_rev_id, end_rev_id, direction,
627
562
                            delayed_graph_generation,
628
563
                            exclude_common_ancestry=False):
637
572
    if delayed_graph_generation:
638
573
        try:
639
574
            for rev_id, revno, depth in  _linear_view_revisions(
640
 
                branch, start_rev_id, end_rev_id, exclude_common_ancestry):
 
575
                branch, start_rev_id, end_rev_id):
641
576
                if _has_merges(branch, rev_id):
642
577
                    # The end_rev_id can be nested down somewhere. We need an
643
578
                    # explicit ancestry check. There is an ambiguity here as we
664
599
        except _StartNotLinearAncestor:
665
600
            # A merge was never detected so the lower revision limit can't
666
601
            # be nested down somewhere
667
 
            raise errors.BzrCommandError(gettext('Start revision not found in'
668
 
                ' history of end revision.'))
 
602
            raise errors.BzrCommandError('Start revision not found in'
 
603
                ' history of end revision.')
669
604
 
670
605
    # We exit the loop above because we encounter a revision with merges, from
671
606
    # this revision, we need to switch to _graph_view_revisions.
675
610
    # shown naturally, i.e. just like it is for linear logging. We can easily
676
611
    # make forward the exact opposite display, but showing the merge revisions
677
612
    # indented at the end seems slightly nicer in that case.
678
 
    view_revisions = itertools.chain(iter(initial_revisions),
 
613
    view_revisions = chain(iter(initial_revisions),
679
614
        _graph_view_revisions(branch, start_rev_id, end_rev_id,
680
615
                              rebase_initial_depths=(direction == 'reverse'),
681
616
                              exclude_common_ancestry=exclude_common_ancestry))
688
623
    return len(parents) > 1
689
624
 
690
625
 
691
 
def _compute_revno_str(branch, rev_id):
692
 
    """Compute the revno string from a rev_id.
693
 
 
694
 
    :return: The revno string, or None if the revision is not in the supplied
695
 
        branch.
696
 
    """
697
 
    try:
698
 
        revno = branch.revision_id_to_dotted_revno(rev_id)
699
 
    except errors.NoSuchRevision:
700
 
        # The revision must be outside of this branch
701
 
        return None
702
 
    else:
703
 
        return '.'.join(str(n) for n in revno)
704
 
 
705
 
 
706
626
def _is_obvious_ancestor(branch, start_rev_id, end_rev_id):
707
627
    """Is start_rev_id an obvious ancestor of end_rev_id?"""
708
628
    if start_rev_id and end_rev_id:
709
 
        try:
710
 
            start_dotted = branch.revision_id_to_dotted_revno(start_rev_id)
711
 
            end_dotted = branch.revision_id_to_dotted_revno(end_rev_id)
712
 
        except errors.NoSuchRevision:
713
 
            # one or both is not in the branch; not obvious
714
 
            return False
 
629
        start_dotted = branch.revision_id_to_dotted_revno(start_rev_id)
 
630
        end_dotted = branch.revision_id_to_dotted_revno(end_rev_id)
715
631
        if len(start_dotted) == 1 and len(end_dotted) == 1:
716
632
            # both on mainline
717
633
            return start_dotted[0] <= end_dotted[0]
727
643
    return True
728
644
 
729
645
 
730
 
def _linear_view_revisions(branch, start_rev_id, end_rev_id,
731
 
                           exclude_common_ancestry=False):
 
646
def _linear_view_revisions(branch, start_rev_id, end_rev_id):
732
647
    """Calculate a sequence of revisions to view, newest to oldest.
733
648
 
734
649
    :param start_rev_id: the lower revision-id
735
650
    :param end_rev_id: the upper revision-id
736
 
    :param exclude_common_ancestry: Whether the start_rev_id should be part of
737
 
        the iterated revisions.
738
651
    :return: An iterator of (revision_id, dotted_revno, merge_depth) tuples.
739
 
        dotted_revno will be None for ghosts
740
652
    :raises _StartNotLinearAncestor: if a start_rev_id is specified but
741
 
        is not found walking the left-hand history
 
653
      is not found walking the left-hand history
742
654
    """
 
655
    br_revno, br_rev_id = branch.last_revision_info()
743
656
    repo = branch.repository
744
 
    graph = repo.get_graph()
745
657
    if start_rev_id is None and end_rev_id is None:
746
 
        try:
747
 
            br_revno, br_rev_id = branch.last_revision_info()
748
 
        except errors.GhostRevisionsHaveNoRevno:
749
 
            br_rev_id = branch.last_revision()
750
 
            cur_revno = None
751
 
        else:
752
 
            cur_revno = br_revno
753
 
        graph_iter = graph.iter_lefthand_ancestry(br_rev_id,
754
 
            (_mod_revision.NULL_REVISION,))
755
 
        while True:
756
 
            try:
757
 
                revision_id = next(graph_iter)
758
 
            except errors.RevisionNotPresent as e:
759
 
                # Oops, a ghost.
760
 
                yield e.revision_id, None, None
761
 
                break
762
 
            except StopIteration:
763
 
                break
764
 
            else:
765
 
                yield revision_id, str(cur_revno) if cur_revno is not None else None, 0
766
 
                if cur_revno is not None:
767
 
                    cur_revno -= 1
 
658
        cur_revno = br_revno
 
659
        for revision_id in repo.iter_reverse_revision_history(br_rev_id):
 
660
            yield revision_id, str(cur_revno), 0
 
661
            cur_revno -= 1
768
662
    else:
769
 
        br_rev_id = branch.last_revision()
770
663
        if end_rev_id is None:
771
664
            end_rev_id = br_rev_id
772
665
        found_start = start_rev_id is None
773
 
        graph_iter = graph.iter_lefthand_ancestry(end_rev_id,
774
 
            (_mod_revision.NULL_REVISION,))
775
 
        while True:
776
 
            try:
777
 
                revision_id = next(graph_iter)
778
 
            except StopIteration:
779
 
                break
780
 
            except errors.RevisionNotPresent as e:
781
 
                # Oops, a ghost.
782
 
                yield e.revision_id, None, None
 
666
        for revision_id in repo.iter_reverse_revision_history(end_rev_id):
 
667
            revno = branch.revision_id_to_dotted_revno(revision_id)
 
668
            revno_str = '.'.join(str(n) for n in revno)
 
669
            if not found_start and revision_id == start_rev_id:
 
670
                yield revision_id, revno_str, 0
 
671
                found_start = True
783
672
                break
784
673
            else:
785
 
                revno_str = _compute_revno_str(branch, revision_id)
786
 
                if not found_start and revision_id == start_rev_id:
787
 
                    if not exclude_common_ancestry:
788
 
                        yield revision_id, revno_str, 0
789
 
                    found_start = True
790
 
                    break
791
 
                else:
792
 
                    yield revision_id, revno_str, 0
793
 
        if not found_start:
794
 
            raise _StartNotLinearAncestor()
 
674
                yield revision_id, revno_str, 0
 
675
        else:
 
676
            if not found_start:
 
677
                raise _StartNotLinearAncestor()
795
678
 
796
679
 
797
680
def _graph_view_revisions(branch, start_rev_id, end_rev_id,
838
721
            yield rev_id, '.'.join(map(str, revno)), merge_depth
839
722
 
840
723
 
 
724
@deprecated_function(deprecated_in((2, 2, 0)))
 
725
def calculate_view_revisions(branch, start_revision, end_revision, direction,
 
726
        specific_fileid, generate_merge_revisions):
 
727
    """Calculate the revisions to view.
 
728
 
 
729
    :return: An iterator of (revision_id, dotted_revno, merge_depth) tuples OR
 
730
             a list of the same tuples.
 
731
    """
 
732
    start_rev_id, end_rev_id = _get_revision_limits(branch, start_revision,
 
733
        end_revision)
 
734
    view_revisions = list(_calc_view_revisions(branch, start_rev_id, end_rev_id,
 
735
        direction, generate_merge_revisions or specific_fileid))
 
736
    if specific_fileid:
 
737
        view_revisions = _filter_revisions_touching_file_id(branch,
 
738
            specific_fileid, view_revisions,
 
739
            include_merges=generate_merge_revisions)
 
740
    return _rebase_merge_depth(view_revisions)
 
741
 
 
742
 
841
743
def _rebase_merge_depth(view_revisions):
842
744
    """Adjust depths upwards so the top level is 0."""
843
745
    # If either the first or last revision have a merge_depth of 0, we're done
844
746
    if view_revisions and view_revisions[0][2] and view_revisions[-1][2]:
845
 
        min_depth = min([d for r, n, d in view_revisions])
 
747
        min_depth = min([d for r,n,d in view_revisions])
846
748
        if min_depth != 0:
847
 
            view_revisions = [(r, n, d-min_depth) for r, n, d in view_revisions]
 
749
            view_revisions = [(r,n,d-min_depth) for r,n,d in view_revisions]
848
750
    return view_revisions
849
751
 
850
752
 
865
767
    """
866
768
    # Convert view_revisions into (view, None, None) groups to fit with
867
769
    # the standard interface here.
868
 
    if isinstance(view_revisions, list):
 
770
    if type(view_revisions) == list:
869
771
        # A single batch conversion is faster than many incremental ones.
870
772
        # As we have all the data, do a batch conversion.
871
773
        nones = [None] * len(view_revisions)
872
 
        log_rev_iterator = iter([list(zip(view_revisions, nones, nones))])
 
774
        log_rev_iterator = iter([zip(view_revisions, nones, nones)])
873
775
    else:
874
776
        def _convert():
875
777
            for view in view_revisions:
887
789
    return log_rev_iterator
888
790
 
889
791
 
890
 
def _make_search_filter(branch, generate_delta, match, log_rev_iterator):
 
792
def _make_search_filter(branch, generate_delta, search, log_rev_iterator):
891
793
    """Create a filtered iterator of log_rev_iterator matching on a regex.
892
794
 
893
795
    :param branch: The branch being logged.
894
796
    :param generate_delta: Whether to generate a delta for each revision.
895
 
    :param match: A dictionary with properties as keys and lists of strings
896
 
        as values. To match, a revision may match any of the supplied strings
897
 
        within a single property but must match at least one string for each
898
 
        property.
 
797
    :param search: A user text search string.
899
798
    :param log_rev_iterator: An input iterator containing all revisions that
900
799
        could be displayed, in lists.
901
800
    :return: An iterator over lists of ((rev_id, revno, merge_depth), rev,
902
801
        delta).
903
802
    """
904
 
    if not match:
 
803
    if search is None:
905
804
        return log_rev_iterator
906
 
    searchRE = [(k, [re.compile(x, re.IGNORECASE) for x in v])
907
 
                for k, v in match.items()]
908
 
    return _filter_re(searchRE, log_rev_iterator)
909
 
 
910
 
 
911
 
def _filter_re(searchRE, log_rev_iterator):
 
805
    searchRE = re_compile_checked(search, re.IGNORECASE,
 
806
            'log message filter')
 
807
    return _filter_message_re(searchRE, log_rev_iterator)
 
808
 
 
809
 
 
810
def _filter_message_re(searchRE, log_rev_iterator):
912
811
    for revs in log_rev_iterator:
913
 
        new_revs = [rev for rev in revs if _match_filter(searchRE, rev[1])]
914
 
        if new_revs:
915
 
            yield new_revs
916
 
 
917
 
def _match_filter(searchRE, rev):
918
 
    strings = {
919
 
               'message': (rev.message,),
920
 
               'committer': (rev.committer,),
921
 
               'author': (rev.get_apparent_authors()),
922
 
               'bugs': list(rev.iter_bugs())
923
 
               }
924
 
    strings[''] = [item for inner_list in strings.values()
925
 
                   for item in inner_list]
926
 
    for (k, v) in searchRE:
927
 
        if k in strings and not _match_any_filter(strings[k], v):
928
 
            return False
929
 
    return True
930
 
 
931
 
def _match_any_filter(strings, res):
932
 
    return any(re.search(s) for re in res for s in strings)
 
812
        new_revs = []
 
813
        for (rev_id, revno, merge_depth), rev, delta in revs:
 
814
            if searchRE.search(rev.message):
 
815
                new_revs.append(((rev_id, revno, merge_depth), rev, delta))
 
816
        yield new_revs
 
817
 
933
818
 
934
819
def _make_delta_filter(branch, generate_delta, search, log_rev_iterator,
935
820
    fileids=None, direction='reverse'):
980
865
        new_revs = []
981
866
        if delta_type == 'full' and not check_fileids:
982
867
            deltas = repository.get_deltas_for_revisions(revisions)
983
 
            for rev, delta in zip(revs, deltas):
 
868
            for rev, delta in izip(revs, deltas):
984
869
                new_revs.append((rev[0], rev[1], delta))
985
870
        else:
986
871
            deltas = repository.get_deltas_for_revisions(revisions, fileid_set)
987
 
            for rev, delta in zip(revs, deltas):
 
872
            for rev, delta in izip(revs, deltas):
988
873
                if check_fileids:
989
874
                    if delta is None or not delta.has_changed():
990
875
                        continue
1008
893
 
1009
894
def _update_fileids(delta, fileids, stop_on):
1010
895
    """Update the set of file-ids to search based on file lifecycle events.
1011
 
 
 
896
    
1012
897
    :param fileids: a set of fileids to update
1013
898
    :param stop_on: either 'add' or 'remove' - take file-ids out of the
1014
899
      fileids set once their add or remove entry is detected respectively
1038
923
    for revs in log_rev_iterator:
1039
924
        # r = revision_id, n = revno, d = merge depth
1040
925
        revision_ids = [view[0] for view, _, _ in revs]
1041
 
        revisions = dict(repository.iter_revisions(revision_ids))
1042
 
        yield [(rev[0], revisions[rev[0][0]], rev[2]) for rev in revs]
 
926
        revisions = repository.get_revisions(revision_ids)
 
927
        revs = [(rev[0], revision, rev[2]) for rev, revision in
 
928
            izip(revs, revisions)]
 
929
        yield revs
1043
930
 
1044
931
 
1045
932
def _make_batch_filter(branch, generate_delta, search, log_rev_iterator):
1053
940
    :return: An iterator over lists of ((rev_id, revno, merge_depth), rev,
1054
941
        delta).
1055
942
    """
 
943
    repository = branch.repository
1056
944
    num = 9
1057
945
    for batch in log_rev_iterator:
1058
946
        batch = iter(batch)
1070
958
    :param  branch: The branch containing the revisions.
1071
959
 
1072
960
    :param  start_revision: The first revision to be logged.
 
961
            For backwards compatibility this may be a mainline integer revno,
1073
962
            but for merge revision support a RevisionInfo is expected.
1074
963
 
1075
964
    :param  end_revision: The last revision to be logged.
1078
967
 
1079
968
    :return: (start_rev_id, end_rev_id) tuple.
1080
969
    """
 
970
    branch_revno, branch_rev_id = branch.last_revision_info()
1081
971
    start_rev_id = None
1082
 
    start_revno = None
1083
 
    if start_revision is not None:
1084
 
        if not isinstance(start_revision, revisionspec.RevisionInfo):
1085
 
            raise TypeError(start_revision)
1086
 
        start_rev_id = start_revision.rev_id
1087
 
        start_revno = start_revision.revno
1088
 
    if start_revno is None:
 
972
    if start_revision is None:
1089
973
        start_revno = 1
 
974
    else:
 
975
        if isinstance(start_revision, revisionspec.RevisionInfo):
 
976
            start_rev_id = start_revision.rev_id
 
977
            start_revno = start_revision.revno or 1
 
978
        else:
 
979
            branch.check_real_revno(start_revision)
 
980
            start_revno = start_revision
 
981
            start_rev_id = branch.get_rev_id(start_revno)
1090
982
 
1091
983
    end_rev_id = None
1092
 
    end_revno = None
1093
 
    if end_revision is not None:
1094
 
        if not isinstance(end_revision, revisionspec.RevisionInfo):
1095
 
            raise TypeError(start_revision)
1096
 
        end_rev_id = end_revision.rev_id
1097
 
        end_revno = end_revision.revno
1098
 
    if end_revno is None:
1099
 
        try:
1100
 
            end_revno = branch.revno()
1101
 
        except errors.GhostRevisionsHaveNoRevno:
1102
 
            end_revno = None
 
984
    if end_revision is None:
 
985
        end_revno = branch_revno
 
986
    else:
 
987
        if isinstance(end_revision, revisionspec.RevisionInfo):
 
988
            end_rev_id = end_revision.rev_id
 
989
            end_revno = end_revision.revno or branch_revno
 
990
        else:
 
991
            branch.check_real_revno(end_revision)
 
992
            end_revno = end_revision
 
993
            end_rev_id = branch.get_rev_id(end_revno)
1103
994
 
1104
 
    if branch.last_revision() != _mod_revision.NULL_REVISION:
 
995
    if branch_revno != 0:
1105
996
        if (start_rev_id == _mod_revision.NULL_REVISION
1106
997
            or end_rev_id == _mod_revision.NULL_REVISION):
1107
 
            raise errors.BzrCommandError(gettext('Logging revision 0 is invalid.'))
1108
 
        if end_revno is not None and start_revno > end_revno:
1109
 
            raise errors.BzrCommandError(gettext("Start revision must be "
1110
 
                                         "older than the end revision."))
 
998
            raise errors.BzrCommandError('Logging revision 0 is invalid.')
 
999
        if start_revno > end_revno:
 
1000
            raise errors.BzrCommandError("Start revision must be older than "
 
1001
                                         "the end revision.")
1111
1002
    return (start_rev_id, end_rev_id)
1112
1003
 
1113
1004
 
1162
1053
 
1163
1054
    if ((start_rev_id == _mod_revision.NULL_REVISION)
1164
1055
        or (end_rev_id == _mod_revision.NULL_REVISION)):
1165
 
        raise errors.BzrCommandError(gettext('Logging revision 0 is invalid.'))
 
1056
        raise errors.BzrCommandError('Logging revision 0 is invalid.')
1166
1057
    if start_revno > end_revno:
1167
 
        raise errors.BzrCommandError(gettext("Start revision must be older "
1168
 
                                     "than the end revision."))
 
1058
        raise errors.BzrCommandError("Start revision must be older than "
 
1059
                                     "the end revision.")
1169
1060
 
1170
1061
    if end_revno < start_revno:
1171
1062
        return None, None, None, None
1172
1063
    cur_revno = branch_revno
1173
1064
    rev_nos = {}
1174
1065
    mainline_revs = []
1175
 
    graph = branch.repository.get_graph()
1176
 
    for revision_id in graph.iter_lefthand_ancestry(
1177
 
            branch_last_revision, (_mod_revision.NULL_REVISION,)):
 
1066
    for revision_id in branch.repository.iter_reverse_revision_history(
 
1067
                        branch_last_revision):
1178
1068
        if cur_revno < start_revno:
1179
1069
            # We have gone far enough, but we always add 1 more revision
1180
1070
            rev_nos[revision_id] = cur_revno
1194
1084
    return mainline_revs, rev_nos, start_rev_id, end_rev_id
1195
1085
 
1196
1086
 
 
1087
@deprecated_function(deprecated_in((2, 2, 0)))
 
1088
def _filter_revision_range(view_revisions, start_rev_id, end_rev_id):
 
1089
    """Filter view_revisions based on revision ranges.
 
1090
 
 
1091
    :param view_revisions: A list of (revision_id, dotted_revno, merge_depth)
 
1092
            tuples to be filtered.
 
1093
 
 
1094
    :param start_rev_id: If not NONE specifies the first revision to be logged.
 
1095
            If NONE then all revisions up to the end_rev_id are logged.
 
1096
 
 
1097
    :param end_rev_id: If not NONE specifies the last revision to be logged.
 
1098
            If NONE then all revisions up to the end of the log are logged.
 
1099
 
 
1100
    :return: The filtered view_revisions.
 
1101
    """
 
1102
    if start_rev_id or end_rev_id:
 
1103
        revision_ids = [r for r, n, d in view_revisions]
 
1104
        if start_rev_id:
 
1105
            start_index = revision_ids.index(start_rev_id)
 
1106
        else:
 
1107
            start_index = 0
 
1108
        if start_rev_id == end_rev_id:
 
1109
            end_index = start_index
 
1110
        else:
 
1111
            if end_rev_id:
 
1112
                end_index = revision_ids.index(end_rev_id)
 
1113
            else:
 
1114
                end_index = len(view_revisions) - 1
 
1115
        # To include the revisions merged into the last revision,
 
1116
        # extend end_rev_id down to, but not including, the next rev
 
1117
        # with the same or lesser merge_depth
 
1118
        end_merge_depth = view_revisions[end_index][2]
 
1119
        try:
 
1120
            for index in xrange(end_index+1, len(view_revisions)+1):
 
1121
                if view_revisions[index][2] <= end_merge_depth:
 
1122
                    end_index = index - 1
 
1123
                    break
 
1124
        except IndexError:
 
1125
            # if the search falls off the end then log to the end as well
 
1126
            end_index = len(view_revisions) - 1
 
1127
        view_revisions = view_revisions[start_index:end_index+1]
 
1128
    return view_revisions
 
1129
 
 
1130
 
1197
1131
def _filter_revisions_touching_file_id(branch, file_id, view_revisions,
1198
1132
    include_merges=True):
1199
1133
    r"""Return the list of revision ids which touch a given file id.
1202
1136
    This includes the revisions which directly change the file id,
1203
1137
    and the revisions which merge these changes. So if the
1204
1138
    revision graph is::
1205
 
 
1206
1139
        A-.
1207
1140
        |\ \
1208
1141
        B C E
1235
1168
    """
1236
1169
    # Lookup all possible text keys to determine which ones actually modified
1237
1170
    # the file.
1238
 
    graph = branch.repository.get_file_graph()
1239
 
    get_parent_map = graph.get_parent_map
1240
1171
    text_keys = [(file_id, rev_id) for rev_id, revno, depth in view_revisions]
1241
1172
    next_keys = None
1242
1173
    # Looking up keys in batches of 1000 can cut the time in half, as well as
1246
1177
    #       indexing layer. We might consider passing in hints as to the known
1247
1178
    #       access pattern (sparse/clustered, high success rate/low success
1248
1179
    #       rate). This particular access is clustered with a low success rate.
 
1180
    get_parent_map = branch.repository.texts.get_parent_map
1249
1181
    modified_text_revisions = set()
1250
1182
    chunk_size = 1000
1251
 
    for start in range(0, len(text_keys), chunk_size):
 
1183
    for start in xrange(0, len(text_keys), chunk_size):
1252
1184
        next_keys = text_keys[start:start + chunk_size]
1253
1185
        # Only keep the revision_id portion of the key
1254
1186
        modified_text_revisions.update(
1269
1201
 
1270
1202
        if rev_id in modified_text_revisions:
1271
1203
            # This needs to be logged, along with the extra revisions
1272
 
            for idx in range(len(current_merge_stack)):
 
1204
            for idx in xrange(len(current_merge_stack)):
1273
1205
                node = current_merge_stack[idx]
1274
1206
                if node is not None:
1275
1207
                    if include_merges or node[2] == 0:
1278
1210
    return result
1279
1211
 
1280
1212
 
 
1213
@deprecated_function(deprecated_in((2, 2, 0)))
 
1214
def get_view_revisions(mainline_revs, rev_nos, branch, direction,
 
1215
                       include_merges=True):
 
1216
    """Produce an iterator of revisions to show
 
1217
    :return: an iterator of (revision_id, revno, merge_depth)
 
1218
    (if there is no revno for a revision, None is supplied)
 
1219
    """
 
1220
    if not include_merges:
 
1221
        revision_ids = mainline_revs[1:]
 
1222
        if direction == 'reverse':
 
1223
            revision_ids.reverse()
 
1224
        for revision_id in revision_ids:
 
1225
            yield revision_id, str(rev_nos[revision_id]), 0
 
1226
        return
 
1227
    graph = branch.repository.get_graph()
 
1228
    # This asks for all mainline revisions, which means we only have to spider
 
1229
    # sideways, rather than depth history. That said, its still size-of-history
 
1230
    # and should be addressed.
 
1231
    # mainline_revisions always includes an extra revision at the beginning, so
 
1232
    # don't request it.
 
1233
    parent_map = dict(((key, value) for key, value in
 
1234
        graph.iter_ancestry(mainline_revs[1:]) if value is not None))
 
1235
    # filter out ghosts; merge_sort errors on ghosts.
 
1236
    rev_graph = _mod_repository._strip_NULL_ghosts(parent_map)
 
1237
    merge_sorted_revisions = tsort.merge_sort(
 
1238
        rev_graph,
 
1239
        mainline_revs[-1],
 
1240
        mainline_revs,
 
1241
        generate_revno=True)
 
1242
 
 
1243
    if direction == 'forward':
 
1244
        # forward means oldest first.
 
1245
        merge_sorted_revisions = reverse_by_depth(merge_sorted_revisions)
 
1246
    elif direction != 'reverse':
 
1247
        raise ValueError('invalid direction %r' % direction)
 
1248
 
 
1249
    for (sequence, rev_id, merge_depth, revno, end_of_merge
 
1250
         ) in merge_sorted_revisions:
 
1251
        yield rev_id, '.'.join(map(str, revno)), merge_depth
 
1252
 
 
1253
 
1281
1254
def reverse_by_depth(merge_sorted_revisions, _depth=0):
1282
1255
    """Reverse revisions by depth.
1283
1256
 
1318
1291
    """
1319
1292
 
1320
1293
    def __init__(self, rev=None, revno=None, merge_depth=0, delta=None,
1321
 
                 tags=None, diff=None, signature=None):
 
1294
                 tags=None, diff=None):
1322
1295
        self.rev = rev
1323
 
        if revno is None:
1324
 
            self.revno = None
1325
 
        else:
1326
 
            self.revno = str(revno)
 
1296
        self.revno = str(revno)
1327
1297
        self.merge_depth = merge_depth
1328
1298
        self.delta = delta
1329
1299
        self.tags = tags
1330
1300
        self.diff = diff
1331
 
        self.signature = signature
1332
1301
 
1333
1302
 
1334
1303
class LogFormatter(object):
1343
1312
    to indicate which LogRevision attributes it supports:
1344
1313
 
1345
1314
    - supports_delta must be True if this log formatter supports delta.
1346
 
      Otherwise the delta attribute may not be populated.  The 'delta_format'
1347
 
      attribute describes whether the 'short_status' format (1) or the long
1348
 
      one (2) should be used.
 
1315
        Otherwise the delta attribute may not be populated.  The 'delta_format'
 
1316
        attribute describes whether the 'short_status' format (1) or the long
 
1317
        one (2) should be used.
1349
1318
 
1350
1319
    - supports_merge_revisions must be True if this log formatter supports
1351
 
      merge revisions.  If not, then only mainline revisions will be passed
1352
 
      to the formatter.
 
1320
        merge revisions.  If not, then only mainline revisions will be passed
 
1321
        to the formatter.
1353
1322
 
1354
1323
    - preferred_levels is the number of levels this formatter defaults to.
1355
 
      The default value is zero meaning display all levels.
1356
 
      This value is only relevant if supports_merge_revisions is True.
 
1324
        The default value is zero meaning display all levels.
 
1325
        This value is only relevant if supports_merge_revisions is True.
1357
1326
 
1358
1327
    - supports_tags must be True if this log formatter supports tags.
1359
 
      Otherwise the tags attribute may not be populated.
 
1328
        Otherwise the tags attribute may not be populated.
1360
1329
 
1361
1330
    - supports_diff must be True if this log formatter supports diffs.
1362
 
      Otherwise the diff attribute may not be populated.
1363
 
 
1364
 
    - supports_signatures must be True if this log formatter supports GPG
1365
 
      signatures.
 
1331
        Otherwise the diff attribute may not be populated.
1366
1332
 
1367
1333
    Plugins can register functions to show custom revision properties using
1368
1334
    the properties_handler_registry. The registered function
1369
 
    must respect the following interface description::
1370
 
 
 
1335
    must respect the following interface description:
1371
1336
        def my_show_properties(properties_dict):
1372
1337
            # code that returns a dict {'name':'value'} of the properties
1373
1338
            # to be shown
1376
1341
 
1377
1342
    def __init__(self, to_file, show_ids=False, show_timezone='original',
1378
1343
                 delta_format=None, levels=None, show_advice=False,
1379
 
                 to_exact_file=None, author_list_handler=None):
 
1344
                 to_exact_file=None):
1380
1345
        """Create a LogFormatter.
1381
1346
 
1382
1347
        :param to_file: the file to output to
1383
 
        :param to_exact_file: if set, gives an output stream to which
 
1348
        :param to_exact_file: if set, gives an output stream to which 
1384
1349
             non-Unicode diffs are written.
1385
1350
        :param show_ids: if True, revision-ids are to be displayed
1386
1351
        :param show_timezone: the timezone to use
1390
1355
          let the log formatter decide.
1391
1356
        :param show_advice: whether to show advice at the end of the
1392
1357
          log or not
1393
 
        :param author_list_handler: callable generating a list of
1394
 
          authors to display for a given revision
1395
1358
        """
1396
1359
        self.to_file = to_file
1397
1360
        # 'exact' stream used to show diff, it should print content 'as is'
1412
1375
        self.levels = levels
1413
1376
        self._show_advice = show_advice
1414
1377
        self._merge_count = 0
1415
 
        self._author_list_handler = author_list_handler
1416
1378
 
1417
1379
    def get_levels(self):
1418
1380
        """Get the number of levels to display or 0 for all."""
1437
1399
            if advice_sep:
1438
1400
                self.to_file.write(advice_sep)
1439
1401
            self.to_file.write(
1440
 
                "Use --include-merged or -n0 to see merged revisions.\n")
 
1402
                "Use --include-merges or -n0 to see merged revisions.\n")
1441
1403
 
1442
1404
    def get_advice_separator(self):
1443
1405
        """Get the text separating the log from the closing advice."""
1450
1412
        return address
1451
1413
 
1452
1414
    def short_author(self, rev):
1453
 
        return self.authors(rev, 'first', short=True, sep=', ')
1454
 
 
1455
 
    def authors(self, rev, who, short=False, sep=None):
1456
 
        """Generate list of authors, taking --authors option into account.
1457
 
 
1458
 
        The caller has to specify the name of a author list handler,
1459
 
        as provided by the author list registry, using the ``who``
1460
 
        argument.  That name only sets a default, though: when the
1461
 
        user selected a different author list generation using the
1462
 
        ``--authors`` command line switch, as represented by the
1463
 
        ``author_list_handler`` constructor argument, that value takes
1464
 
        precedence.
1465
 
 
1466
 
        :param rev: The revision for which to generate the list of authors.
1467
 
        :param who: Name of the default handler.
1468
 
        :param short: Whether to shorten names to either name or address.
1469
 
        :param sep: What separator to use for automatic concatenation.
1470
 
        """
1471
 
        if self._author_list_handler is not None:
1472
 
            # The user did specify --authors, which overrides the default
1473
 
            author_list_handler = self._author_list_handler
1474
 
        else:
1475
 
            # The user didn't specify --authors, so we use the caller's default
1476
 
            author_list_handler = author_list_registry.get(who)
1477
 
        names = author_list_handler(rev)
1478
 
        if short:
1479
 
            for i in range(len(names)):
1480
 
                name, address = config.parse_username(names[i])
1481
 
                if name:
1482
 
                    names[i] = name
1483
 
                else:
1484
 
                    names[i] = address
1485
 
        if sep is not None:
1486
 
            names = sep.join(names)
1487
 
        return names
 
1415
        name, address = config.parse_username(rev.get_apparent_authors()[0])
 
1416
        if name:
 
1417
            return name
 
1418
        return address
1488
1419
 
1489
1420
    def merge_marker(self, revision):
1490
1421
        """Get the merge marker to include in the output or '' if none."""
1525
1456
                rev.mapping.vcs.show_foreign_revid(rev.foreign_revid))
1526
1457
 
1527
1458
        # Imported foreign revision revision ids always contain :
1528
 
        if not b":" in rev.revision_id:
 
1459
        if not ":" in rev.revision_id:
1529
1460
            return []
1530
1461
 
1531
1462
        # Revision was once imported from a foreign repository
1545
1476
        return lines
1546
1477
 
1547
1478
    def show_diff(self, to_file, diff, indent):
1548
 
        encoding = get_terminal_encoding()
1549
 
        for l in diff.rstrip().split(b'\n'):
1550
 
            to_file.write(indent + l.decode(encoding, 'ignore') + '\n')
 
1479
        for l in diff.rstrip().split('\n'):
 
1480
            to_file.write(indent + '%s\n' % (l,))
1551
1481
 
1552
1482
 
1553
1483
# Separator between revisions in long format
1561
1491
    supports_delta = True
1562
1492
    supports_tags = True
1563
1493
    supports_diff = True
1564
 
    supports_signatures = True
1565
1494
 
1566
1495
    def __init__(self, *args, **kwargs):
1567
1496
        super(LongLogFormatter, self).__init__(*args, **kwargs)
1586
1515
            lines.append('revno: %s%s' % (revision.revno,
1587
1516
                self.merge_marker(revision)))
1588
1517
        if revision.tags:
1589
 
            lines.append('tags: %s' % (', '.join(sorted(revision.tags))))
1590
 
        if self.show_ids or revision.revno is None:
1591
 
            lines.append('revision-id: %s' % (revision.rev.revision_id.decode('utf-8'),))
 
1518
            lines.append('tags: %s' % (', '.join(revision.tags)))
1592
1519
        if self.show_ids:
 
1520
            lines.append('revision-id: %s' % (revision.rev.revision_id,))
1593
1521
            for parent_id in revision.rev.parent_ids:
1594
 
                lines.append('parent: %s' % (parent_id.decode('utf-8'),))
 
1522
                lines.append('parent: %s' % (parent_id,))
1595
1523
        lines.extend(self.custom_properties(revision.rev))
1596
1524
 
1597
1525
        committer = revision.rev.committer
1598
 
        authors = self.authors(revision.rev, 'all')
 
1526
        authors = revision.rev.get_apparent_authors()
1599
1527
        if authors != [committer]:
1600
1528
            lines.append('author: %s' % (", ".join(authors),))
1601
1529
        lines.append('committer: %s' % (committer,))
1606
1534
 
1607
1535
        lines.append('timestamp: %s' % (self.date_string(revision.rev),))
1608
1536
 
1609
 
        if revision.signature is not None:
1610
 
            lines.append('signature: ' + revision.signature)
1611
 
 
1612
1537
        lines.append('message:')
1613
1538
        if not revision.rev.message:
1614
1539
            lines.append('  (no message)')
1622
1547
        to_file.write("%s%s\n" % (indent, ('\n' + indent).join(lines)))
1623
1548
        if revision.delta is not None:
1624
1549
            # Use the standard status output to display changes
1625
 
            from breezy.delta import report_delta
1626
 
            report_delta(to_file, revision.delta, short_status=False,
 
1550
            from bzrlib.delta import report_delta
 
1551
            report_delta(to_file, revision.delta, short_status=False, 
1627
1552
                         show_ids=self.show_ids, indent=indent)
1628
1553
        if revision.diff is not None:
1629
1554
            to_file.write(indent + 'diff:\n')
1661
1586
        indent = '    ' * depth
1662
1587
        revno_width = self.revno_width_by_depth.get(depth)
1663
1588
        if revno_width is None:
1664
 
            if revision.revno is None or revision.revno.find('.') == -1:
 
1589
            if revision.revno.find('.') == -1:
1665
1590
                # mainline revno, e.g. 12345
1666
1591
                revno_width = 5
1667
1592
            else:
1673
1598
        to_file = self.to_file
1674
1599
        tags = ''
1675
1600
        if revision.tags:
1676
 
            tags = ' {%s}' % (', '.join(sorted(revision.tags)))
 
1601
            tags = ' {%s}' % (', '.join(revision.tags))
1677
1602
        to_file.write(indent + "%*s %s\t%s%s%s\n" % (revno_width,
1678
 
                revision.revno or "", self.short_author(revision.rev),
 
1603
                revision.revno, self.short_author(revision.rev),
1679
1604
                format_date(revision.rev.timestamp,
1680
1605
                            revision.rev.timezone or 0,
1681
1606
                            self.show_timezone, date_fmt="%Y-%m-%d",
1682
1607
                            show_offset=False),
1683
1608
                tags, self.merge_marker(revision)))
1684
1609
        self.show_properties(revision.rev, indent+offset)
1685
 
        if self.show_ids or revision.revno is None:
 
1610
        if self.show_ids:
1686
1611
            to_file.write(indent + offset + 'revision-id:%s\n'
1687
 
                          % (revision.rev.revision_id.decode('utf-8'),))
 
1612
                          % (revision.rev.revision_id,))
1688
1613
        if not revision.rev.message:
1689
1614
            to_file.write(indent + offset + '(no message)\n')
1690
1615
        else:
1694
1619
 
1695
1620
        if revision.delta is not None:
1696
1621
            # Use the standard status output to display changes
1697
 
            from breezy.delta import report_delta
1698
 
            report_delta(to_file, revision.delta,
1699
 
                         short_status=self.delta_format==1,
 
1622
            from bzrlib.delta import report_delta
 
1623
            report_delta(to_file, revision.delta, 
 
1624
                         short_status=self.delta_format==1, 
1700
1625
                         show_ids=self.show_ids, indent=indent + offset)
1701
1626
        if revision.diff is not None:
1702
1627
            self.show_diff(self.to_exact_file, revision.diff, '      ')
1741
1666
 
1742
1667
    def log_string(self, revno, rev, max_chars, tags=None, prefix=''):
1743
1668
        """Format log info into one string. Truncate tail of string
1744
 
 
1745
 
        :param revno:      revision number or None.
1746
 
                           Revision numbers counts from 1.
1747
 
        :param rev:        revision object
1748
 
        :param max_chars:  maximum length of resulting string
1749
 
        :param tags:       list of tags or None
1750
 
        :param prefix:     string to prefix each line
1751
 
        :return:           formatted truncated string
 
1669
        :param  revno:      revision number or None.
 
1670
                            Revision numbers counts from 1.
 
1671
        :param  rev:        revision object
 
1672
        :param  max_chars:  maximum length of resulting string
 
1673
        :param  tags:       list of tags or None
 
1674
        :param  prefix:     string to prefix each line
 
1675
        :return:            formatted truncated string
1752
1676
        """
1753
1677
        out = []
1754
1678
        if revno:
1755
1679
            # show revno only when is not None
1756
1680
            out.append("%s:" % revno)
1757
 
        if max_chars is not None:
1758
 
            out.append(self.truncate(self.short_author(rev), (max_chars+3)//4))
1759
 
        else:
1760
 
            out.append(self.short_author(rev))
 
1681
        out.append(self.truncate(self.short_author(rev), 20))
1761
1682
        out.append(self.date_string(rev))
1762
1683
        if len(rev.parent_ids) > 1:
1763
1684
            out.append('[merge]')
1764
1685
        if tags:
1765
 
            tag_str = '{%s}' % (', '.join(sorted(tags)))
 
1686
            tag_str = '{%s}' % (', '.join(tags))
1766
1687
            out.append(tag_str)
1767
1688
        out.append(rev.get_summary())
1768
1689
        return self.truncate(prefix + " ".join(out).rstrip('\n'), max_chars)
1782
1703
                               self.show_timezone,
1783
1704
                               date_fmt='%Y-%m-%d',
1784
1705
                               show_offset=False)
1785
 
        committer_str = self.authors(revision.rev, 'first', sep=', ')
1786
 
        committer_str = committer_str.replace(' <', '  <')
1787
 
        to_file.write('%s  %s\n\n' % (date_str, committer_str))
 
1706
        committer_str = revision.rev.get_apparent_authors()[0].replace (' <', '  <')
 
1707
        to_file.write('%s  %s\n\n' % (date_str,committer_str))
1788
1708
 
1789
1709
        if revision.delta is not None and revision.delta.has_changed():
1790
1710
            for c in revision.delta.added + revision.delta.removed + revision.delta.modified:
1791
1711
                path, = c[:1]
1792
1712
                to_file.write('\t* %s:\n' % (path,))
1793
1713
            for c in revision.delta.renamed:
1794
 
                oldpath, newpath = c[:2]
 
1714
                oldpath,newpath = c[:2]
1795
1715
                # For renamed files, show both the old and the new path
1796
 
                to_file.write('\t* %s:\n\t* %s:\n' % (oldpath, newpath))
 
1716
                to_file.write('\t* %s:\n\t* %s:\n' % (oldpath,newpath))
1797
1717
            to_file.write('\n')
1798
1718
 
1799
1719
        if not revision.rev.message:
1822
1742
        return self.get(name)(*args, **kwargs)
1823
1743
 
1824
1744
    def get_default(self, branch):
1825
 
        c = branch.get_config_stack()
1826
 
        return self.get(c.get('log_format'))
 
1745
        return self.get(branch.get_config().log_format())
1827
1746
 
1828
1747
 
1829
1748
log_formatter_registry = LogFormatterRegistry()
1830
1749
 
1831
1750
 
1832
1751
log_formatter_registry.register('short', ShortLogFormatter,
1833
 
                                'Moderately short log format.')
 
1752
                                'Moderately short log format')
1834
1753
log_formatter_registry.register('long', LongLogFormatter,
1835
 
                                'Detailed log format.')
 
1754
                                'Detailed log format')
1836
1755
log_formatter_registry.register('line', LineLogFormatter,
1837
 
                                'Log format with one line per revision.')
 
1756
                                'Log format with one line per revision')
1838
1757
log_formatter_registry.register('gnu-changelog', GnuChangelogLogFormatter,
1839
 
                                'Format used by GNU ChangeLog files.')
 
1758
                                'Format used by GNU ChangeLog files')
1840
1759
 
1841
1760
 
1842
1761
def register_formatter(name, formatter):
1852
1771
    try:
1853
1772
        return log_formatter_registry.make_formatter(name, *args, **kwargs)
1854
1773
    except KeyError:
1855
 
        raise errors.BzrCommandError(gettext("unknown log formatter: %r") % name)
1856
 
 
1857
 
 
1858
 
def author_list_all(rev):
1859
 
    return rev.get_apparent_authors()[:]
1860
 
 
1861
 
 
1862
 
def author_list_first(rev):
1863
 
    lst = rev.get_apparent_authors()
1864
 
    try:
1865
 
        return [lst[0]]
1866
 
    except IndexError:
1867
 
        return []
1868
 
 
1869
 
 
1870
 
def author_list_committer(rev):
1871
 
    return [rev.committer]
1872
 
 
1873
 
 
1874
 
author_list_registry = registry.Registry()
1875
 
 
1876
 
author_list_registry.register('all', author_list_all,
1877
 
                              'All authors')
1878
 
 
1879
 
author_list_registry.register('first', author_list_first,
1880
 
                              'The first author')
1881
 
 
1882
 
author_list_registry.register('committer', author_list_committer,
1883
 
                              'The committer')
 
1774
        raise errors.BzrCommandError("unknown log formatter: %r" % name)
 
1775
 
 
1776
 
 
1777
def show_one_log(revno, rev, delta, verbose, to_file, show_timezone):
 
1778
    # deprecated; for compatibility
 
1779
    lf = LongLogFormatter(to_file=to_file, show_timezone=show_timezone)
 
1780
    lf.show(revno, rev, delta)
1884
1781
 
1885
1782
 
1886
1783
def show_changed_revisions(branch, old_rh, new_rh, to_file=None,
1903
1800
    # This is the first index which is different between
1904
1801
    # old and new
1905
1802
    base_idx = None
1906
 
    for i in range(max(len(new_rh), len(old_rh))):
 
1803
    for i in xrange(max(len(new_rh),
 
1804
                        len(old_rh))):
1907
1805
        if (len(new_rh) <= i
1908
1806
            or len(old_rh) <= i
1909
1807
            or new_rh[i] != old_rh[i]):
1950
1848
    old_revisions = set()
1951
1849
    new_history = []
1952
1850
    new_revisions = set()
1953
 
    graph = repository.get_graph()
1954
 
    new_iter = graph.iter_lefthand_ancestry(new_revision_id)
1955
 
    old_iter = graph.iter_lefthand_ancestry(old_revision_id)
 
1851
    new_iter = repository.iter_reverse_revision_history(new_revision_id)
 
1852
    old_iter = repository.iter_reverse_revision_history(old_revision_id)
1956
1853
    stop_revision = None
1957
1854
    do_old = True
1958
1855
    do_new = True
1959
1856
    while do_new or do_old:
1960
1857
        if do_new:
1961
1858
            try:
1962
 
                new_revision = next(new_iter)
 
1859
                new_revision = new_iter.next()
1963
1860
            except StopIteration:
1964
1861
                do_new = False
1965
1862
            else:
1970
1867
                    break
1971
1868
        if do_old:
1972
1869
            try:
1973
 
                old_revision = next(old_iter)
 
1870
                old_revision = old_iter.next()
1974
1871
            except StopIteration:
1975
1872
                do_old = False
1976
1873
            else:
2015
1912
        output.write('Added Revisions:\n')
2016
1913
        start_revno = new_revno - len(new_history) + 1
2017
1914
        show_log(branch, lf, None, verbose=False, direction='forward',
2018
 
                 start_revision=start_revno)
 
1915
                 start_revision=start_revno,)
2019
1916
 
2020
1917
 
2021
1918
def show_flat_log(repository, history, last_revno, lf):
2033
1930
        lf.log_revision(lr)
2034
1931
 
2035
1932
 
2036
 
def _get_info_for_log_files(revisionspec_list, file_list, add_cleanup):
 
1933
def _get_info_for_log_files(revisionspec_list, file_list):
2037
1934
    """Find file-ids and kinds given a list of files and a revision range.
2038
1935
 
2039
1936
    We search for files at the end of the range. If not found there,
2043
1940
    :param file_list: the list of paths given on the command line;
2044
1941
      the first of these can be a branch location or a file path,
2045
1942
      the remainder must be file paths
2046
 
    :param add_cleanup: When the branch returned is read locked,
2047
 
      an unlock call will be queued to the cleanup.
2048
1943
    :return: (branch, info_list, start_rev_info, end_rev_info) where
2049
1944
      info_list is a list of (relative_path, file_id, kind) tuples where
2050
1945
      kind is one of values 'directory', 'file', 'symlink', 'tree-reference'.
2051
1946
      branch will be read-locked.
2052
1947
    """
2053
 
    from breezy.builtins import _get_revision_range
2054
 
    tree, b, path = controldir.ControlDir.open_containing_tree_or_branch(
2055
 
        file_list[0])
2056
 
    add_cleanup(b.lock_read().unlock)
 
1948
    from builtins import _get_revision_range, safe_relpath_files
 
1949
    tree, b, path = bzrdir.BzrDir.open_containing_tree_or_branch(file_list[0])
 
1950
    b.lock_read()
2057
1951
    # XXX: It's damn messy converting a list of paths to relative paths when
2058
1952
    # those paths might be deleted ones, they might be on a case-insensitive
2059
1953
    # filesystem and/or they might be in silly locations (like another branch).
2063
1957
    # case of running log in a nested directory, assuming paths beyond the
2064
1958
    # first one haven't been deleted ...
2065
1959
    if tree:
2066
 
        relpaths = [path] + tree.safe_relpath_files(file_list[1:])
 
1960
        relpaths = [path] + safe_relpath_files(tree, file_list[1:])
2067
1961
    else:
2068
1962
        relpaths = [path] + file_list[1:]
2069
1963
    info_list = []
2077
1971
        tree1 = None
2078
1972
        for fp in relpaths:
2079
1973
            file_id = tree.path2id(fp)
2080
 
            kind = _get_kind_for_file_id(tree, fp, file_id)
 
1974
            kind = _get_kind_for_file_id(tree, file_id)
2081
1975
            if file_id is None:
2082
1976
                # go back to when time began
2083
1977
                if tree1 is None:
2091
1985
                        tree1 = b.repository.revision_tree(rev1)
2092
1986
                if tree1:
2093
1987
                    file_id = tree1.path2id(fp)
2094
 
                    kind = _get_kind_for_file_id(tree1, fp, file_id)
 
1988
                    kind = _get_kind_for_file_id(tree1, file_id)
2095
1989
            info_list.append((fp, file_id, kind))
2096
1990
 
2097
1991
    elif start_rev_info == end_rev_info:
2099
1993
        tree = b.repository.revision_tree(end_rev_info.rev_id)
2100
1994
        for fp in relpaths:
2101
1995
            file_id = tree.path2id(fp)
2102
 
            kind = _get_kind_for_file_id(tree, fp, file_id)
 
1996
            kind = _get_kind_for_file_id(tree, file_id)
2103
1997
            info_list.append((fp, file_id, kind))
2104
1998
 
2105
1999
    else:
2113
2007
        tree1 = None
2114
2008
        for fp in relpaths:
2115
2009
            file_id = tree.path2id(fp)
2116
 
            kind = _get_kind_for_file_id(tree, fp, file_id)
 
2010
            kind = _get_kind_for_file_id(tree, file_id)
2117
2011
            if file_id is None:
2118
2012
                if tree1 is None:
2119
2013
                    rev_id = start_rev_info.rev_id
2123
2017
                    else:
2124
2018
                        tree1 = b.repository.revision_tree(rev_id)
2125
2019
                file_id = tree1.path2id(fp)
2126
 
                kind = _get_kind_for_file_id(tree1, fp, file_id)
 
2020
                kind = _get_kind_for_file_id(tree1, file_id)
2127
2021
            info_list.append((fp, file_id, kind))
2128
2022
    return b, info_list, start_rev_info, end_rev_info
2129
2023
 
2130
2024
 
2131
 
def _get_kind_for_file_id(tree, path, file_id):
 
2025
def _get_kind_for_file_id(tree, file_id):
2132
2026
    """Return the kind of a file-id or None if it doesn't exist."""
2133
2027
    if file_id is not None:
2134
 
        return tree.kind(path, file_id)
 
2028
        return tree.kind(file_id)
2135
2029
    else:
2136
2030
        return None
2137
2031
 
2140
2034
 
2141
2035
# Use the properties handlers to print out bug information if available
2142
2036
def _bugs_properties_handler(revision):
2143
 
    if 'bugs' in revision.properties:
 
2037
    if revision.properties.has_key('bugs'):
2144
2038
        bug_lines = revision.properties['bugs'].split('\n')
2145
2039
        bug_rows = [line.split(' ', 1) for line in bug_lines]
2146
2040
        fixed_bug_urls = [row[0] for row in bug_rows if
2147
2041
                          len(row) > 1 and row[1] == 'fixed']
2148
2042
 
2149
2043
        if fixed_bug_urls:
2150
 
            return {ngettext('fixes bug', 'fixes bugs', len(fixed_bug_urls)):\
2151
 
                    ' '.join(fixed_bug_urls)}
 
2044
            return {'fixes bug(s)': ' '.join(fixed_bug_urls)}
2152
2045
    return {}
2153
2046
 
2154
2047
properties_handler_registry.register('bugs_properties_handler',