/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 breezy/log.py

  • Committer: Jelmer Vernooij
  • Date: 2019-02-04 01:01:24 UTC
  • mto: This revision was merged to the branch mainline in revision 7268.
  • Revision ID: jelmer@jelmer.uk-20190204010124-ni0i4qc6f5tnbvux
Fix source tests.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005-2010 Canonical Ltd
 
1
# Copyright (C) 2005-2011 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
 
 
19
17
"""Code to show logs of changes.
20
18
 
21
19
Various flavors of log can be produced:
49
47
all the changes since the previous revision that touched hello.c.
50
48
"""
51
49
 
 
50
from __future__ import absolute_import
 
51
 
52
52
import codecs
53
 
from cStringIO import StringIO
54
 
from itertools import (
55
 
    chain,
56
 
    izip,
57
 
    )
 
53
import itertools
58
54
import re
59
55
import sys
60
56
from warnings import (
61
57
    warn,
62
58
    )
63
59
 
64
 
from bzrlib.lazy_import import lazy_import
 
60
from .lazy_import import lazy_import
65
61
lazy_import(globals(), """
66
62
 
67
 
from bzrlib import (
68
 
    bzrdir,
 
63
from breezy import (
69
64
    config,
 
65
    controldir,
70
66
    diff,
71
 
    errors,
72
67
    foreign,
73
 
    repository as _mod_repository,
 
68
    lazy_regex,
74
69
    revision as _mod_revision,
 
70
    )
 
71
from breezy.i18n import gettext, ngettext
 
72
""")
 
73
 
 
74
from . import (
 
75
    errors,
 
76
    registry,
75
77
    revisionspec,
76
78
    trace,
77
 
    tsort,
78
 
    )
79
 
""")
80
 
 
81
 
from bzrlib import (
82
 
    registry,
83
 
    )
84
 
from bzrlib.osutils import (
 
79
    )
 
80
from .osutils import (
85
81
    format_date,
86
82
    format_date_with_offset_in_original_timezone,
 
83
    get_diff_header_encoding,
87
84
    get_terminal_encoding,
88
 
    re_compile_checked,
89
85
    terminal_width,
90
86
    )
91
 
from bzrlib.symbol_versioning import (
92
 
    deprecated_function,
93
 
    deprecated_in,
 
87
from .sixish import (
 
88
    BytesIO,
 
89
    range,
 
90
    zip,
94
91
    )
95
 
 
96
 
 
97
 
def find_touching_revisions(branch, file_id):
 
92
from .tree import find_previous_path
 
93
 
 
94
 
 
95
def find_touching_revisions(repository, last_revision, last_tree, last_path):
98
96
    """Yield a description of revisions which affect the file_id.
99
97
 
100
98
    Each returned element is (revno, revision_id, description)
105
103
    TODO: Perhaps some way to limit this to only particular revisions,
106
104
    or to traverse a non-mainline set of revisions?
107
105
    """
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
 
106
    last_verifier = last_tree.get_file_verifier(last_path)
 
107
    graph = repository.get_graph()
 
108
    history = list(graph.iter_lefthand_ancestry(last_revision, []))
 
109
    revno = len(history)
 
110
    for revision_id in history:
 
111
        this_tree = repository.revision_tree(revision_id)
 
112
        this_path = find_previous_path(last_tree, this_tree, last_path)
118
113
 
119
114
        # now we know how it was last time, and how it is in this revision.
120
115
        # are those two states effectively the same or not?
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
 
116
        if this_path is not None and last_path is None:
 
117
            yield revno, revision_id, "deleted " + this_path
 
118
            this_verifier = this_tree.get_file_verifier(this_path)
 
119
        elif this_path is None and last_path is not None:
 
120
            yield revno, revision_id, "added " + last_path
130
121
        elif this_path != last_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
 
122
            yield revno, revision_id, ("renamed %s => %s" % (this_path, last_path))
 
123
            this_verifier = this_tree.get_file_verifier(this_path)
 
124
        else:
 
125
            this_verifier = this_tree.get_file_verifier(this_path)
 
126
            if (this_verifier != last_verifier):
 
127
                yield revno, revision_id, "modified " + this_path
135
128
 
136
 
        last_ie = this_ie
 
129
        last_verifier = this_verifier
137
130
        last_path = this_path
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
 
131
        last_tree = this_tree
 
132
        if last_path is None:
 
133
            return
 
134
        revno -= 1
148
135
 
149
136
 
150
137
def show_log(branch,
156
143
             end_revision=None,
157
144
             search=None,
158
145
             limit=None,
159
 
             show_diff=False):
 
146
             show_diff=False,
 
147
             match=None):
160
148
    """Write out human-readable log of commits to this branch.
161
149
 
162
150
    This function is being retained for backwards compatibility but
185
173
        if None or 0.
186
174
 
187
175
    :param show_diff: If True, output a diff after each revision.
 
176
 
 
177
    :param match: Dictionary of search lists to use when matching revision
 
178
      properties.
188
179
    """
189
180
    # Convert old-style parameters to new-style parameters
190
181
    if specific_fileid is not None:
206
197
    else:
207
198
        diff_type = None
208
199
 
 
200
    if isinstance(start_revision, int):
 
201
        try:
 
202
            start_revision = revisionspec.RevisionInfo(branch, start_revision)
 
203
        except errors.NoSuchRevision:
 
204
            raise errors.InvalidRevisionNumber(start_revision)
 
205
 
 
206
    if isinstance(end_revision, int):
 
207
        try:
 
208
            end_revision = revisionspec.RevisionInfo(branch, end_revision)
 
209
        except errors.NoSuchRevision:
 
210
            raise errors.InvalidRevisionNumber(end_revision)
 
211
 
 
212
    if end_revision is not None and end_revision.revno == 0:
 
213
        raise errors.InvalidRevisionNumber(end_revision.revno)
 
214
 
209
215
    # Build the request and execute it
210
216
    rqst = make_log_request_dict(direction=direction, specific_fileids=file_ids,
211
 
        start_revision=start_revision, end_revision=end_revision,
212
 
        limit=limit, message_search=search,
213
 
        delta_type=delta_type, diff_type=diff_type)
 
217
                                 start_revision=start_revision, end_revision=end_revision,
 
218
                                 limit=limit, message_search=search,
 
219
                                 delta_type=delta_type, diff_type=diff_type)
214
220
    Logger(branch, rqst).show(lf)
215
221
 
216
222
 
217
 
# Note: This needs to be kept this in sync with the defaults in
 
223
# Note: This needs to be kept in sync with the defaults in
218
224
# make_log_request_dict() below
219
225
_DEFAULT_REQUEST_PARAMS = {
220
226
    'direction': 'reverse',
221
 
    'levels': 1,
 
227
    'levels': None,
222
228
    'generate_tags': True,
223
229
    'exclude_common_ancestry': False,
224
230
    '_match_using_deltas': True,
227
233
 
228
234
def make_log_request_dict(direction='reverse', specific_fileids=None,
229
235
                          start_revision=None, end_revision=None, limit=None,
230
 
                          message_search=None, levels=1, generate_tags=True,
 
236
                          message_search=None, levels=None, generate_tags=True,
231
237
                          delta_type=None,
232
238
                          diff_type=None, _match_using_deltas=True,
233
 
                          exclude_common_ancestry=False,
 
239
                          exclude_common_ancestry=False, match=None,
 
240
                          signature=False, omit_merges=False,
234
241
                          ):
235
242
    """Convenience function for making a logging request dictionary.
236
243
 
257
264
      matching commit messages
258
265
 
259
266
    :param levels: the number of levels of revisions to
260
 
      generate; 1 for just the mainline; 0 for all levels.
 
267
      generate; 1 for just the mainline; 0 for all levels, or None for
 
268
      a sensible default.
261
269
 
262
270
    :param generate_tags: If True, include tags for matched revisions.
263
 
 
 
271
`
264
272
    :param delta_type: Either 'full', 'partial' or None.
265
273
      'full' means generate the complete delta - adds/deletes/modifies/etc;
266
274
      'partial' means filter the delta using specific_fileids;
273
281
 
274
282
    :param _match_using_deltas: a private parameter controlling the
275
283
      algorithm used for matching specific_fileids. This parameter
276
 
      may be removed in the future so bzrlib client code should NOT
 
284
      may be removed in the future so breezy client code should NOT
277
285
      use it.
278
286
 
279
287
    :param exclude_common_ancestry: Whether -rX..Y should be interpreted as a
280
288
      range operator or as a graph difference.
 
289
 
 
290
    :param signature: show digital signature information
 
291
 
 
292
    :param match: Dictionary of list of search strings to use when filtering
 
293
      revisions. Keys can be 'message', 'author', 'committer', 'bugs' or
 
294
      the empty string to match any of the preceding properties.
 
295
 
 
296
    :param omit_merges: If True, commits with more than one parent are
 
297
      omitted.
 
298
 
281
299
    """
 
300
    # Take care of old style message_search parameter
 
301
    if message_search:
 
302
        if match:
 
303
            if 'message' in match:
 
304
                match['message'].append(message_search)
 
305
            else:
 
306
                match['message'] = [message_search]
 
307
        else:
 
308
            match = {'message': [message_search]}
282
309
    return {
283
310
        'direction': direction,
284
311
        'specific_fileids': specific_fileids,
285
312
        'start_revision': start_revision,
286
313
        'end_revision': end_revision,
287
314
        'limit': limit,
288
 
        'message_search': message_search,
289
315
        'levels': levels,
290
316
        'generate_tags': generate_tags,
291
317
        'delta_type': delta_type,
292
318
        'diff_type': diff_type,
293
319
        'exclude_common_ancestry': exclude_common_ancestry,
 
320
        'signature': signature,
 
321
        'match': match,
 
322
        'omit_merges': omit_merges,
294
323
        # Add 'private' attributes for features that may be deprecated
295
324
        '_match_using_deltas': _match_using_deltas,
296
325
    }
298
327
 
299
328
def _apply_log_request_defaults(rqst):
300
329
    """Apply default values to a request dictionary."""
301
 
    result = _DEFAULT_REQUEST_PARAMS
 
330
    result = _DEFAULT_REQUEST_PARAMS.copy()
302
331
    if rqst:
303
332
        result.update(rqst)
304
333
    return result
305
334
 
306
335
 
 
336
def format_signature_validity(rev_id, branch):
 
337
    """get the signature validity
 
338
 
 
339
    :param rev_id: revision id to validate
 
340
    :param branch: branch of revision
 
341
    :return: human readable string to print to log
 
342
    """
 
343
    from breezy import gpg
 
344
 
 
345
    gpg_strategy = gpg.GPGStrategy(branch.get_config_stack())
 
346
    result = branch.repository.verify_revision_signature(rev_id, gpg_strategy)
 
347
    if result[0] == gpg.SIGNATURE_VALID:
 
348
        return u"valid signature from {0}".format(result[1])
 
349
    if result[0] == gpg.SIGNATURE_KEY_MISSING:
 
350
        return "unknown key {0}".format(result[1])
 
351
    if result[0] == gpg.SIGNATURE_NOT_VALID:
 
352
        return "invalid signature!"
 
353
    if result[0] == gpg.SIGNATURE_NOT_SIGNED:
 
354
        return "no signature"
 
355
 
 
356
 
307
357
class LogGenerator(object):
308
358
    """A generator of log revisions."""
309
359
 
336
386
        if not isinstance(lf, LogFormatter):
337
387
            warn("not a LogFormatter instance: %r" % lf)
338
388
 
339
 
        self.branch.lock_read()
340
 
        try:
 
389
        with self.branch.lock_read():
341
390
            if getattr(lf, 'begin_log', None):
342
391
                lf.begin_log()
343
392
            self._show_body(lf)
344
393
            if getattr(lf, 'end_log', None):
345
394
                lf.end_log()
346
 
        finally:
347
 
            self.branch.unlock()
348
395
 
349
396
    def _show_body(self, lf):
350
397
        """Show the main log output.
354
401
        # Tweak the LogRequest based on what the LogFormatter can handle.
355
402
        # (There's no point generating stuff if the formatter can't display it.)
356
403
        rqst = self.rqst
357
 
        rqst['levels'] = lf.get_levels()
 
404
        if rqst['levels'] is None or lf.get_levels() > rqst['levels']:
 
405
            # user didn't specify levels, use whatever the LF can handle:
 
406
            rqst['levels'] = lf.get_levels()
 
407
 
358
408
        if not getattr(lf, 'supports_tags', False):
359
409
            rqst['generate_tags'] = False
360
410
        if not getattr(lf, 'supports_delta', False):
361
411
            rqst['delta_type'] = None
362
412
        if not getattr(lf, 'supports_diff', False):
363
413
            rqst['diff_type'] = None
 
414
        if not getattr(lf, 'supports_signatures', False):
 
415
            rqst['signature'] = False
364
416
 
365
417
        # Find and print the interesting revisions
366
418
        generator = self._generator_factory(self.branch, rqst)
367
 
        for lr in generator.iter_log_revisions():
368
 
            lf.log_revision(lr)
 
419
        try:
 
420
            for lr in generator.iter_log_revisions():
 
421
                lf.log_revision(lr)
 
422
        except errors.GhostRevisionUnusableHere:
 
423
            raise errors.BzrCommandError(
 
424
                gettext('Further revision history missing.'))
369
425
        lf.show_advice()
370
426
 
371
427
    def _generator_factory(self, branch, rqst):
372
428
        """Make the LogGenerator object to use.
373
 
        
 
429
 
374
430
        Subclasses may wish to override this.
375
431
        """
376
432
        return _DefaultLogGenerator(branch, rqst)
400
456
        levels = rqst.get('levels')
401
457
        limit = rqst.get('limit')
402
458
        diff_type = rqst.get('diff_type')
 
459
        show_signature = rqst.get('signature')
 
460
        omit_merges = rqst.get('omit_merges')
403
461
        log_count = 0
404
462
        revision_iterator = self._create_log_revision_iterator()
405
463
        for revs in revision_iterator:
406
464
            for (rev_id, revno, merge_depth), rev, delta in revs:
407
465
                # 0 levels means show everything; merge_depth counts from 0
408
 
                if levels != 0 and merge_depth >= levels:
409
 
                    continue
 
466
                if (levels != 0 and merge_depth is not None and
 
467
                        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)
410
473
                if diff_type is None:
411
474
                    diff = None
412
475
                else:
413
476
                    diff = self._format_diff(rev, rev_id, diff_type)
414
 
                yield LogRevision(rev, revno, merge_depth, delta,
415
 
                    self.rev_tag_dict.get(rev_id), diff)
 
477
                if show_signature:
 
478
                    signature = format_signature_validity(rev_id, self.branch)
 
479
                else:
 
480
                    signature = None
 
481
                yield LogRevision(
 
482
                    rev, revno, merge_depth, delta,
 
483
                    self.rev_tag_dict.get(rev_id), diff, signature)
416
484
                if limit:
417
485
                    log_count += 1
418
486
                    if log_count >= limit:
431
499
            specific_files = [tree_2.id2path(id) for id in file_ids]
432
500
        else:
433
501
            specific_files = None
434
 
        s = StringIO()
 
502
        s = BytesIO()
 
503
        path_encoding = get_diff_header_encoding()
435
504
        diff.show_diff_trees(tree_1, tree_2, s, specific_files, old_label='',
436
 
            new_label='')
 
505
                             new_label='', path_encoding=path_encoding)
437
506
        return s.getvalue()
438
507
 
439
508
    def _create_log_revision_iterator(self):
453
522
            # not a directory
454
523
            file_count = len(self.rqst.get('specific_fileids'))
455
524
            if file_count != 1:
456
 
                raise BzrError("illegal LogRequest: must match-using-deltas "
 
525
                raise errors.BzrError(
 
526
                    "illegal LogRequest: must match-using-deltas "
457
527
                    "when logging %d files" % file_count)
458
528
            return self._log_revision_iterator_using_per_file_graph()
459
529
 
462
532
        rqst = self.rqst
463
533
        generate_merge_revisions = rqst.get('levels') != 1
464
534
        delayed_graph_generation = not rqst.get('specific_fileids') and (
465
 
                rqst.get('limit') or self.start_rev_id or self.end_rev_id)
 
535
            rqst.get('limit') or self.start_rev_id or self.end_rev_id)
466
536
        view_revisions = _calc_view_revisions(
467
537
            self.branch, self.start_rev_id, self.end_rev_id,
468
538
            rqst.get('direction'),
472
542
 
473
543
        # Apply the other filters
474
544
        return make_log_rev_iterator(self.branch, view_revisions,
475
 
            rqst.get('delta_type'), rqst.get('message_search'),
476
 
            file_ids=rqst.get('specific_fileids'),
477
 
            direction=rqst.get('direction'))
 
545
                                     rqst.get('delta_type'), rqst.get('match'),
 
546
                                     file_ids=rqst.get('specific_fileids'),
 
547
                                     direction=rqst.get('direction'))
478
548
 
479
549
    def _log_revision_iterator_using_per_file_graph(self):
480
550
        # Get the base revisions, filtering by the revision range.
488
558
        if not isinstance(view_revisions, list):
489
559
            view_revisions = list(view_revisions)
490
560
        view_revisions = _filter_revisions_touching_file_id(self.branch,
491
 
            rqst.get('specific_fileids')[0], view_revisions,
492
 
            include_merges=rqst.get('levels') != 1)
 
561
                                                            rqst.get('specific_fileids')[
 
562
                                                                0], view_revisions,
 
563
                                                            include_merges=rqst.get('levels') != 1)
493
564
        return make_log_rev_iterator(self.branch, view_revisions,
494
 
            rqst.get('delta_type'), rqst.get('message_search'))
 
565
                                     rqst.get('delta_type'), rqst.get('match'))
495
566
 
496
567
 
497
568
def _calc_view_revisions(branch, start_rev_id, end_rev_id, direction,
505
576
             a list of the same tuples.
506
577
    """
507
578
    if (exclude_common_ancestry and start_rev_id == end_rev_id):
508
 
        raise errors.BzrCommandError(
509
 
            '--exclude-common-ancestry requires two different revisions')
 
579
        raise errors.BzrCommandError(gettext(
 
580
            '--exclude-common-ancestry requires two different revisions'))
510
581
    if direction not in ('reverse', 'forward'):
511
 
        raise ValueError('invalid direction %r' % direction)
512
 
    br_revno, br_rev_id = branch.last_revision_info()
513
 
    if br_revno == 0:
 
582
        raise ValueError(gettext('invalid direction %r') % direction)
 
583
    br_rev_id = branch.last_revision()
 
584
    if br_rev_id == _mod_revision.NULL_REVISION:
514
585
        return []
515
586
 
516
587
    if (end_rev_id and start_rev_id == end_rev_id
517
588
        and (not generate_merge_revisions
518
589
             or not _has_merges(branch, end_rev_id))):
519
590
        # If a single revision is requested, check we can handle it
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)))
 
591
        return _generate_one_revision(branch, end_rev_id, br_rev_id,
 
592
                                      branch.revno())
 
593
    if not generate_merge_revisions:
 
594
        try:
 
595
            # If we only want to see linear revisions, we can iterate ...
 
596
            iter_revs = _linear_view_revisions(
 
597
                branch, start_rev_id, end_rev_id,
 
598
                exclude_common_ancestry=exclude_common_ancestry)
 
599
            # If a start limit was given and it's not obviously an
 
600
            # ancestor of the end limit, check it before outputting anything
 
601
            if (direction == 'forward'
 
602
                or (start_rev_id and not _is_obvious_ancestor(
 
603
                    branch, start_rev_id, end_rev_id))):
 
604
                iter_revs = list(iter_revs)
 
605
            if direction == 'forward':
 
606
                iter_revs = reversed(iter_revs)
 
607
            return iter_revs
 
608
        except _StartNotLinearAncestor:
 
609
            # Switch to the slower implementation that may be able to find a
 
610
            # non-obvious ancestor out of the left-hand history.
 
611
            pass
 
612
    iter_revs = _generate_all_revisions(branch, start_rev_id, end_rev_id,
 
613
                                        direction, delayed_graph_generation,
 
614
                                        exclude_common_ancestry)
 
615
    if direction == 'forward':
 
616
        iter_revs = _rebase_merge_depth(reverse_by_depth(list(iter_revs)))
534
617
    return iter_revs
535
618
 
536
619
 
539
622
        # It's the tip
540
623
        return [(br_rev_id, br_revno, 0)]
541
624
    else:
542
 
        revno = branch.revision_id_to_dotted_revno(rev_id)
543
 
        revno_str = '.'.join(str(n) for n in revno)
 
625
        revno_str = _compute_revno_str(branch, rev_id)
544
626
        return [(rev_id, revno_str, 0)]
545
627
 
546
628
 
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
 
 
561
629
def _generate_all_revisions(branch, start_rev_id, end_rev_id, direction,
562
630
                            delayed_graph_generation,
563
631
                            exclude_common_ancestry=False):
571
639
    initial_revisions = []
572
640
    if delayed_graph_generation:
573
641
        try:
574
 
            for rev_id, revno, depth in  _linear_view_revisions(
575
 
                branch, start_rev_id, end_rev_id):
 
642
            for rev_id, revno, depth in _linear_view_revisions(
 
643
                    branch, start_rev_id, end_rev_id, exclude_common_ancestry):
576
644
                if _has_merges(branch, rev_id):
577
645
                    # The end_rev_id can be nested down somewhere. We need an
578
646
                    # explicit ancestry check. There is an ambiguity here as we
585
653
                    # -- vila 20100319
586
654
                    graph = branch.repository.get_graph()
587
655
                    if (start_rev_id is not None
588
 
                        and not graph.is_ancestor(start_rev_id, end_rev_id)):
 
656
                            and not graph.is_ancestor(start_rev_id, end_rev_id)):
589
657
                        raise _StartNotLinearAncestor()
590
658
                    # Since we collected the revisions so far, we need to
591
659
                    # adjust end_rev_id.
599
667
        except _StartNotLinearAncestor:
600
668
            # A merge was never detected so the lower revision limit can't
601
669
            # be nested down somewhere
602
 
            raise errors.BzrCommandError('Start revision not found in'
603
 
                ' history of end revision.')
 
670
            raise errors.BzrCommandError(gettext('Start revision not found in'
 
671
                                                 ' history of end revision.'))
604
672
 
605
673
    # We exit the loop above because we encounter a revision with merges, from
606
674
    # this revision, we need to switch to _graph_view_revisions.
610
678
    # shown naturally, i.e. just like it is for linear logging. We can easily
611
679
    # make forward the exact opposite display, but showing the merge revisions
612
680
    # indented at the end seems slightly nicer in that case.
613
 
    view_revisions = chain(iter(initial_revisions),
614
 
        _graph_view_revisions(branch, start_rev_id, end_rev_id,
615
 
                              rebase_initial_depths=(direction == 'reverse'),
616
 
                              exclude_common_ancestry=exclude_common_ancestry))
 
681
    view_revisions = itertools.chain(iter(initial_revisions),
 
682
                                     _graph_view_revisions(branch, start_rev_id, end_rev_id,
 
683
                                                           rebase_initial_depths=(
 
684
                                                               direction == 'reverse'),
 
685
                                                           exclude_common_ancestry=exclude_common_ancestry))
617
686
    return view_revisions
618
687
 
619
688
 
623
692
    return len(parents) > 1
624
693
 
625
694
 
 
695
def _compute_revno_str(branch, rev_id):
 
696
    """Compute the revno string from a rev_id.
 
697
 
 
698
    :return: The revno string, or None if the revision is not in the supplied
 
699
        branch.
 
700
    """
 
701
    try:
 
702
        revno = branch.revision_id_to_dotted_revno(rev_id)
 
703
    except errors.NoSuchRevision:
 
704
        # The revision must be outside of this branch
 
705
        return None
 
706
    else:
 
707
        return '.'.join(str(n) for n in revno)
 
708
 
 
709
 
626
710
def _is_obvious_ancestor(branch, start_rev_id, end_rev_id):
627
711
    """Is start_rev_id an obvious ancestor of end_rev_id?"""
628
712
    if start_rev_id and end_rev_id:
629
 
        start_dotted = branch.revision_id_to_dotted_revno(start_rev_id)
630
 
        end_dotted = branch.revision_id_to_dotted_revno(end_rev_id)
 
713
        try:
 
714
            start_dotted = branch.revision_id_to_dotted_revno(start_rev_id)
 
715
            end_dotted = branch.revision_id_to_dotted_revno(end_rev_id)
 
716
        except errors.NoSuchRevision:
 
717
            # one or both is not in the branch; not obvious
 
718
            return False
631
719
        if len(start_dotted) == 1 and len(end_dotted) == 1:
632
720
            # both on mainline
633
721
            return start_dotted[0] <= end_dotted[0]
634
722
        elif (len(start_dotted) == 3 and len(end_dotted) == 3 and
635
 
            start_dotted[0:1] == end_dotted[0:1]):
 
723
              start_dotted[0:1] == end_dotted[0:1]):
636
724
            # both on same development line
637
725
            return start_dotted[2] <= end_dotted[2]
638
726
        else:
643
731
    return True
644
732
 
645
733
 
646
 
def _linear_view_revisions(branch, start_rev_id, end_rev_id):
 
734
def _linear_view_revisions(branch, start_rev_id, end_rev_id,
 
735
                           exclude_common_ancestry=False):
647
736
    """Calculate a sequence of revisions to view, newest to oldest.
648
737
 
649
738
    :param start_rev_id: the lower revision-id
650
739
    :param end_rev_id: the upper revision-id
 
740
    :param exclude_common_ancestry: Whether the start_rev_id should be part of
 
741
        the iterated revisions.
651
742
    :return: An iterator of (revision_id, dotted_revno, merge_depth) tuples.
 
743
        dotted_revno will be None for ghosts
652
744
    :raises _StartNotLinearAncestor: if a start_rev_id is specified but
653
 
      is not found walking the left-hand history
 
745
        is not found walking the left-hand history
654
746
    """
655
 
    br_revno, br_rev_id = branch.last_revision_info()
656
747
    repo = branch.repository
 
748
    graph = repo.get_graph()
657
749
    if start_rev_id is None and end_rev_id is None:
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
 
750
        try:
 
751
            br_revno, br_rev_id = branch.last_revision_info()
 
752
        except errors.GhostRevisionsHaveNoRevno:
 
753
            br_rev_id = branch.last_revision()
 
754
            cur_revno = None
 
755
        else:
 
756
            cur_revno = br_revno
 
757
        graph_iter = graph.iter_lefthand_ancestry(br_rev_id,
 
758
                                                  (_mod_revision.NULL_REVISION,))
 
759
        while True:
 
760
            try:
 
761
                revision_id = next(graph_iter)
 
762
            except errors.RevisionNotPresent as e:
 
763
                # Oops, a ghost.
 
764
                yield e.revision_id, None, None
 
765
                break
 
766
            except StopIteration:
 
767
                break
 
768
            else:
 
769
                yield revision_id, str(cur_revno) if cur_revno is not None else None, 0
 
770
                if cur_revno is not None:
 
771
                    cur_revno -= 1
662
772
    else:
 
773
        br_rev_id = branch.last_revision()
663
774
        if end_rev_id is None:
664
775
            end_rev_id = br_rev_id
665
776
        found_start = start_rev_id is 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
 
777
        graph_iter = graph.iter_lefthand_ancestry(end_rev_id,
 
778
                                                  (_mod_revision.NULL_REVISION,))
 
779
        while True:
 
780
            try:
 
781
                revision_id = next(graph_iter)
 
782
            except StopIteration:
 
783
                break
 
784
            except errors.RevisionNotPresent as e:
 
785
                # Oops, a ghost.
 
786
                yield e.revision_id, None, None
672
787
                break
673
788
            else:
674
 
                yield revision_id, revno_str, 0
675
 
        else:
676
 
            if not found_start:
677
 
                raise _StartNotLinearAncestor()
 
789
                revno_str = _compute_revno_str(branch, revision_id)
 
790
                if not found_start and revision_id == start_rev_id:
 
791
                    if not exclude_common_ancestry:
 
792
                        yield revision_id, revno_str, 0
 
793
                    found_start = True
 
794
                    break
 
795
                else:
 
796
                    yield revision_id, revno_str, 0
 
797
        if not found_start:
 
798
            raise _StartNotLinearAncestor()
678
799
 
679
800
 
680
801
def _graph_view_revisions(branch, start_rev_id, end_rev_id,
721
842
            yield rev_id, '.'.join(map(str, revno)), merge_depth
722
843
 
723
844
 
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
 
 
743
845
def _rebase_merge_depth(view_revisions):
744
846
    """Adjust depths upwards so the top level is 0."""
745
847
    # If either the first or last revision have a merge_depth of 0, we're done
746
848
    if view_revisions and view_revisions[0][2] and view_revisions[-1][2]:
747
 
        min_depth = min([d for r,n,d in view_revisions])
 
849
        min_depth = min([d for r, n, d in view_revisions])
748
850
        if min_depth != 0:
749
 
            view_revisions = [(r,n,d-min_depth) for r,n,d in view_revisions]
 
851
            view_revisions = [(r, n, d - min_depth)
 
852
                              for r, n, d in view_revisions]
750
853
    return view_revisions
751
854
 
752
855
 
753
856
def make_log_rev_iterator(branch, view_revisions, generate_delta, search,
754
 
        file_ids=None, direction='reverse'):
 
857
                          file_ids=None, direction='reverse'):
755
858
    """Create a revision iterator for log.
756
859
 
757
860
    :param branch: The branch being logged.
767
870
    """
768
871
    # Convert view_revisions into (view, None, None) groups to fit with
769
872
    # the standard interface here.
770
 
    if type(view_revisions) == list:
 
873
    if isinstance(view_revisions, list):
771
874
        # A single batch conversion is faster than many incremental ones.
772
875
        # As we have all the data, do a batch conversion.
773
876
        nones = [None] * len(view_revisions)
774
 
        log_rev_iterator = iter([zip(view_revisions, nones, nones)])
 
877
        log_rev_iterator = iter([list(zip(view_revisions, nones, nones))])
775
878
    else:
776
879
        def _convert():
777
880
            for view in view_revisions:
781
884
        # It would be nicer if log adapters were first class objects
782
885
        # with custom parameters. This will do for now. IGC 20090127
783
886
        if adapter == _make_delta_filter:
784
 
            log_rev_iterator = adapter(branch, generate_delta,
785
 
                search, log_rev_iterator, file_ids, direction)
 
887
            log_rev_iterator = adapter(
 
888
                branch, generate_delta, search, log_rev_iterator, file_ids,
 
889
                direction)
786
890
        else:
787
 
            log_rev_iterator = adapter(branch, generate_delta,
788
 
                search, log_rev_iterator)
 
891
            log_rev_iterator = adapter(
 
892
                branch, generate_delta, search, log_rev_iterator)
789
893
    return log_rev_iterator
790
894
 
791
895
 
792
 
def _make_search_filter(branch, generate_delta, search, log_rev_iterator):
 
896
def _make_search_filter(branch, generate_delta, match, log_rev_iterator):
793
897
    """Create a filtered iterator of log_rev_iterator matching on a regex.
794
898
 
795
899
    :param branch: The branch being logged.
796
900
    :param generate_delta: Whether to generate a delta for each revision.
797
 
    :param search: A user text search string.
 
901
    :param match: A dictionary with properties as keys and lists of strings
 
902
        as values. To match, a revision may match any of the supplied strings
 
903
        within a single property but must match at least one string for each
 
904
        property.
798
905
    :param log_rev_iterator: An input iterator containing all revisions that
799
906
        could be displayed, in lists.
800
907
    :return: An iterator over lists of ((rev_id, revno, merge_depth), rev,
801
908
        delta).
802
909
    """
803
 
    if search is None:
 
910
    if not match:
804
911
        return 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
    # Use lazy_compile so mapping to InvalidPattern error occurs.
 
913
    searchRE = [(k, [lazy_regex.lazy_compile(x, re.IGNORECASE) for x in v])
 
914
                for k, v in match.items()]
 
915
    return _filter_re(searchRE, log_rev_iterator)
 
916
 
 
917
 
 
918
def _filter_re(searchRE, log_rev_iterator):
811
919
    for revs in log_rev_iterator:
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
 
920
        new_revs = [rev for rev in revs if _match_filter(searchRE, rev[1])]
 
921
        if new_revs:
 
922
            yield new_revs
 
923
 
 
924
 
 
925
def _match_filter(searchRE, rev):
 
926
    strings = {
 
927
        'message': (rev.message,),
 
928
        'committer': (rev.committer,),
 
929
        'author': (rev.get_apparent_authors()),
 
930
        'bugs': list(rev.iter_bugs())
 
931
        }
 
932
    strings[''] = [item for inner_list in strings.values()
 
933
                   for item in inner_list]
 
934
    for k, v in searchRE:
 
935
        if k in strings and not _match_any_filter(strings[k], v):
 
936
            return False
 
937
    return True
 
938
 
 
939
 
 
940
def _match_any_filter(strings, res):
 
941
    return any(r.search(s) for r in res for s in strings)
817
942
 
818
943
 
819
944
def _make_delta_filter(branch, generate_delta, search, log_rev_iterator,
820
 
    fileids=None, direction='reverse'):
 
945
                       fileids=None, direction='reverse'):
821
946
    """Add revision deltas to a log iterator if needed.
822
947
 
823
948
    :param branch: The branch being logged.
835
960
    if not generate_delta and not fileids:
836
961
        return log_rev_iterator
837
962
    return _generate_deltas(branch.repository, log_rev_iterator,
838
 
        generate_delta, fileids, direction)
 
963
                            generate_delta, fileids, direction)
839
964
 
840
965
 
841
966
def _generate_deltas(repository, log_rev_iterator, delta_type, fileids,
842
 
    direction):
 
967
                     direction):
843
968
    """Create deltas for each batch of revisions in log_rev_iterator.
844
969
 
845
970
    If we're only generating deltas for the sake of filtering against
865
990
        new_revs = []
866
991
        if delta_type == 'full' and not check_fileids:
867
992
            deltas = repository.get_deltas_for_revisions(revisions)
868
 
            for rev, delta in izip(revs, deltas):
 
993
            for rev, delta in zip(revs, deltas):
869
994
                new_revs.append((rev[0], rev[1], delta))
870
995
        else:
871
996
            deltas = repository.get_deltas_for_revisions(revisions, fileid_set)
872
 
            for rev, delta in izip(revs, deltas):
 
997
            for rev, delta in zip(revs, deltas):
873
998
                if check_fileids:
874
999
                    if delta is None or not delta.has_changed():
875
1000
                        continue
893
1018
 
894
1019
def _update_fileids(delta, fileids, stop_on):
895
1020
    """Update the set of file-ids to search based on file lifecycle events.
896
 
    
 
1021
 
897
1022
    :param fileids: a set of fileids to update
898
1023
    :param stop_on: either 'add' or 'remove' - take file-ids out of the
899
1024
      fileids set once their add or remove entry is detected respectively
923
1048
    for revs in log_rev_iterator:
924
1049
        # r = revision_id, n = revno, d = merge depth
925
1050
        revision_ids = [view[0] for view, _, _ 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
 
1051
        revisions = dict(repository.iter_revisions(revision_ids))
 
1052
        yield [(rev[0], revisions[rev[0][0]], rev[2]) for rev in revs]
930
1053
 
931
1054
 
932
1055
def _make_batch_filter(branch, generate_delta, search, log_rev_iterator):
940
1063
    :return: An iterator over lists of ((rev_id, revno, merge_depth), rev,
941
1064
        delta).
942
1065
    """
943
 
    repository = branch.repository
944
1066
    num = 9
945
1067
    for batch in log_rev_iterator:
946
1068
        batch = iter(batch)
958
1080
    :param  branch: The branch containing the revisions.
959
1081
 
960
1082
    :param  start_revision: The first revision to be logged.
961
 
            For backwards compatibility this may be a mainline integer revno,
962
1083
            but for merge revision support a RevisionInfo is expected.
963
1084
 
964
1085
    :param  end_revision: The last revision to be logged.
967
1088
 
968
1089
    :return: (start_rev_id, end_rev_id) tuple.
969
1090
    """
970
 
    branch_revno, branch_rev_id = branch.last_revision_info()
971
1091
    start_rev_id = None
972
 
    if start_revision is None:
 
1092
    start_revno = None
 
1093
    if start_revision is not None:
 
1094
        if not isinstance(start_revision, revisionspec.RevisionInfo):
 
1095
            raise TypeError(start_revision)
 
1096
        start_rev_id = start_revision.rev_id
 
1097
        start_revno = start_revision.revno
 
1098
    if start_revno is None:
973
1099
        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)
982
1100
 
983
1101
    end_rev_id = 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)
 
1102
    end_revno = None
 
1103
    if end_revision is not None:
 
1104
        if not isinstance(end_revision, revisionspec.RevisionInfo):
 
1105
            raise TypeError(start_revision)
 
1106
        end_rev_id = end_revision.rev_id
 
1107
        end_revno = end_revision.revno
 
1108
    if end_revno is None:
 
1109
        try:
 
1110
            end_revno = branch.revno()
 
1111
        except errors.GhostRevisionsHaveNoRevno:
 
1112
            end_revno = None
994
1113
 
995
 
    if branch_revno != 0:
 
1114
    if branch.last_revision() != _mod_revision.NULL_REVISION:
996
1115
        if (start_rev_id == _mod_revision.NULL_REVISION
997
 
            or end_rev_id == _mod_revision.NULL_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.")
 
1116
                or end_rev_id == _mod_revision.NULL_REVISION):
 
1117
            raise errors.BzrCommandError(
 
1118
                gettext('Logging revision 0 is invalid.'))
 
1119
        if end_revno is not None and start_revno > end_revno:
 
1120
            raise errors.BzrCommandError(
 
1121
                gettext("Start revision must be older than the end revision."))
1002
1122
    return (start_rev_id, end_rev_id)
1003
1123
 
1004
1124
 
1052
1172
            end_revno = end_revision
1053
1173
 
1054
1174
    if ((start_rev_id == _mod_revision.NULL_REVISION)
1055
 
        or (end_rev_id == _mod_revision.NULL_REVISION)):
1056
 
        raise errors.BzrCommandError('Logging revision 0 is invalid.')
 
1175
            or (end_rev_id == _mod_revision.NULL_REVISION)):
 
1176
        raise errors.BzrCommandError(gettext('Logging revision 0 is invalid.'))
1057
1177
    if start_revno > end_revno:
1058
 
        raise errors.BzrCommandError("Start revision must be older than "
1059
 
                                     "the end revision.")
 
1178
        raise errors.BzrCommandError(gettext("Start revision must be older "
 
1179
                                             "than the end revision."))
1060
1180
 
1061
1181
    if end_revno < start_revno:
1062
1182
        return None, None, None, None
1063
1183
    cur_revno = branch_revno
1064
1184
    rev_nos = {}
1065
1185
    mainline_revs = []
1066
 
    for revision_id in branch.repository.iter_reverse_revision_history(
1067
 
                        branch_last_revision):
 
1186
    graph = branch.repository.get_graph()
 
1187
    for revision_id in graph.iter_lefthand_ancestry(
 
1188
            branch_last_revision, (_mod_revision.NULL_REVISION,)):
1068
1189
        if cur_revno < start_revno:
1069
1190
            # We have gone far enough, but we always add 1 more revision
1070
1191
            rev_nos[revision_id] = cur_revno
1084
1205
    return mainline_revs, rev_nos, start_rev_id, end_rev_id
1085
1206
 
1086
1207
 
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
 
 
1131
1208
def _filter_revisions_touching_file_id(branch, file_id, view_revisions,
1132
 
    include_merges=True):
 
1209
                                       include_merges=True):
1133
1210
    r"""Return the list of revision ids which touch a given file id.
1134
1211
 
1135
1212
    The function filters view_revisions and returns a subset.
1136
1213
    This includes the revisions which directly change the file id,
1137
1214
    and the revisions which merge these changes. So if the
1138
1215
    revision graph is::
 
1216
 
1139
1217
        A-.
1140
1218
        |\ \
1141
1219
        B C E
1168
1246
    """
1169
1247
    # Lookup all possible text keys to determine which ones actually modified
1170
1248
    # the file.
 
1249
    graph = branch.repository.get_file_graph()
 
1250
    get_parent_map = graph.get_parent_map
1171
1251
    text_keys = [(file_id, rev_id) for rev_id, revno, depth in view_revisions]
1172
1252
    next_keys = None
1173
1253
    # Looking up keys in batches of 1000 can cut the time in half, as well as
1177
1257
    #       indexing layer. We might consider passing in hints as to the known
1178
1258
    #       access pattern (sparse/clustered, high success rate/low success
1179
1259
    #       rate). This particular access is clustered with a low success rate.
1180
 
    get_parent_map = branch.repository.texts.get_parent_map
1181
1260
    modified_text_revisions = set()
1182
1261
    chunk_size = 1000
1183
 
    for start in xrange(0, len(text_keys), chunk_size):
 
1262
    for start in range(0, len(text_keys), chunk_size):
1184
1263
        next_keys = text_keys[start:start + chunk_size]
1185
1264
        # Only keep the revision_id portion of the key
1186
1265
        modified_text_revisions.update(
1201
1280
 
1202
1281
        if rev_id in modified_text_revisions:
1203
1282
            # This needs to be logged, along with the extra revisions
1204
 
            for idx in xrange(len(current_merge_stack)):
 
1283
            for idx in range(len(current_merge_stack)):
1205
1284
                node = current_merge_stack[idx]
1206
1285
                if node is not None:
1207
1286
                    if include_merges or node[2] == 0:
1210
1289
    return result
1211
1290
 
1212
1291
 
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
 
 
1254
1292
def reverse_by_depth(merge_sorted_revisions, _depth=0):
1255
1293
    """Reverse revisions by depth.
1256
1294
 
1257
1295
    Revisions with a different depth are sorted as a group with the previous
1258
 
    revision of that depth.  There may be no topological justification for this,
 
1296
    revision of that depth.  There may be no topological justification for this
1259
1297
    but it looks much nicer.
1260
1298
    """
1261
1299
    # Add a fake revision at start so that we can always attach sub revisions
1291
1329
    """
1292
1330
 
1293
1331
    def __init__(self, rev=None, revno=None, merge_depth=0, delta=None,
1294
 
                 tags=None, diff=None):
 
1332
                 tags=None, diff=None, signature=None):
1295
1333
        self.rev = rev
1296
 
        self.revno = str(revno)
 
1334
        if revno is None:
 
1335
            self.revno = None
 
1336
        else:
 
1337
            self.revno = str(revno)
1297
1338
        self.merge_depth = merge_depth
1298
1339
        self.delta = delta
1299
1340
        self.tags = tags
1300
1341
        self.diff = diff
 
1342
        self.signature = signature
1301
1343
 
1302
1344
 
1303
1345
class LogFormatter(object):
1312
1354
    to indicate which LogRevision attributes it supports:
1313
1355
 
1314
1356
    - supports_delta must be True if this log formatter supports delta.
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.
 
1357
      Otherwise the delta attribute may not be populated.  The 'delta_format'
 
1358
      attribute describes whether the 'short_status' format (1) or the long
 
1359
      one (2) should be used.
1318
1360
 
1319
1361
    - supports_merge_revisions must be True if this log formatter supports
1320
 
        merge revisions.  If not, then only mainline revisions will be passed
1321
 
        to the formatter.
 
1362
      merge revisions.  If not, then only mainline revisions will be passed
 
1363
      to the formatter.
1322
1364
 
1323
1365
    - preferred_levels is the number of levels this formatter defaults to.
1324
 
        The default value is zero meaning display all levels.
1325
 
        This value is only relevant if supports_merge_revisions is True.
 
1366
      The default value is zero meaning display all levels.
 
1367
      This value is only relevant if supports_merge_revisions is True.
1326
1368
 
1327
1369
    - supports_tags must be True if this log formatter supports tags.
1328
 
        Otherwise the tags attribute may not be populated.
 
1370
      Otherwise the tags attribute may not be populated.
1329
1371
 
1330
1372
    - supports_diff must be True if this log formatter supports diffs.
1331
 
        Otherwise the diff attribute may not be populated.
 
1373
      Otherwise the diff attribute may not be populated.
 
1374
 
 
1375
    - supports_signatures must be True if this log formatter supports GPG
 
1376
      signatures.
1332
1377
 
1333
1378
    Plugins can register functions to show custom revision properties using
1334
1379
    the properties_handler_registry. The registered function
1335
 
    must respect the following interface description:
 
1380
    must respect the following interface description::
 
1381
 
1336
1382
        def my_show_properties(properties_dict):
1337
1383
            # code that returns a dict {'name':'value'} of the properties
1338
1384
            # to be shown
1341
1387
 
1342
1388
    def __init__(self, to_file, show_ids=False, show_timezone='original',
1343
1389
                 delta_format=None, levels=None, show_advice=False,
1344
 
                 to_exact_file=None):
 
1390
                 to_exact_file=None, author_list_handler=None):
1345
1391
        """Create a LogFormatter.
1346
1392
 
1347
1393
        :param to_file: the file to output to
1348
 
        :param to_exact_file: if set, gives an output stream to which 
 
1394
        :param to_exact_file: if set, gives an output stream to which
1349
1395
             non-Unicode diffs are written.
1350
1396
        :param show_ids: if True, revision-ids are to be displayed
1351
1397
        :param show_timezone: the timezone to use
1355
1401
          let the log formatter decide.
1356
1402
        :param show_advice: whether to show advice at the end of the
1357
1403
          log or not
 
1404
        :param author_list_handler: callable generating a list of
 
1405
          authors to display for a given revision
1358
1406
        """
1359
1407
        self.to_file = to_file
1360
1408
        # 'exact' stream used to show diff, it should print content 'as is'
1361
 
        # and should not try to decode/encode it to unicode to avoid bug #328007
 
1409
        # and should not try to decode/encode it to unicode to avoid bug
 
1410
        # #328007
1362
1411
        if to_exact_file is not None:
1363
1412
            self.to_exact_file = to_exact_file
1364
1413
        else:
1365
 
            # XXX: somewhat hacky; this assumes it's a codec writer; it's better
1366
 
            # for code that expects to get diffs to pass in the exact file
1367
 
            # stream
 
1414
            # XXX: somewhat hacky; this assumes it's a codec writer; it's
 
1415
            # better for code that expects to get diffs to pass in the exact
 
1416
            # file stream
1368
1417
            self.to_exact_file = getattr(to_file, 'stream', to_file)
1369
1418
        self.show_ids = show_ids
1370
1419
        self.show_timezone = show_timezone
1371
1420
        if delta_format is None:
1372
1421
            # Ensures backward compatibility
1373
 
            delta_format = 2 # long format
 
1422
            delta_format = 2  # long format
1374
1423
        self.delta_format = delta_format
1375
1424
        self.levels = levels
1376
1425
        self._show_advice = show_advice
1377
1426
        self._merge_count = 0
 
1427
        self._author_list_handler = author_list_handler
1378
1428
 
1379
1429
    def get_levels(self):
1380
1430
        """Get the number of levels to display or 0 for all."""
1399
1449
            if advice_sep:
1400
1450
                self.to_file.write(advice_sep)
1401
1451
            self.to_file.write(
1402
 
                "Use --include-merges or -n0 to see merged revisions.\n")
 
1452
                "Use --include-merged or -n0 to see merged revisions.\n")
1403
1453
 
1404
1454
    def get_advice_separator(self):
1405
1455
        """Get the text separating the log from the closing advice."""
1412
1462
        return address
1413
1463
 
1414
1464
    def short_author(self, rev):
1415
 
        name, address = config.parse_username(rev.get_apparent_authors()[0])
1416
 
        if name:
1417
 
            return name
1418
 
        return address
 
1465
        return self.authors(rev, 'first', short=True, sep=', ')
 
1466
 
 
1467
    def authors(self, rev, who, short=False, sep=None):
 
1468
        """Generate list of authors, taking --authors option into account.
 
1469
 
 
1470
        The caller has to specify the name of a author list handler,
 
1471
        as provided by the author list registry, using the ``who``
 
1472
        argument.  That name only sets a default, though: when the
 
1473
        user selected a different author list generation using the
 
1474
        ``--authors`` command line switch, as represented by the
 
1475
        ``author_list_handler`` constructor argument, that value takes
 
1476
        precedence.
 
1477
 
 
1478
        :param rev: The revision for which to generate the list of authors.
 
1479
        :param who: Name of the default handler.
 
1480
        :param short: Whether to shorten names to either name or address.
 
1481
        :param sep: What separator to use for automatic concatenation.
 
1482
        """
 
1483
        if self._author_list_handler is not None:
 
1484
            # The user did specify --authors, which overrides the default
 
1485
            author_list_handler = self._author_list_handler
 
1486
        else:
 
1487
            # The user didn't specify --authors, so we use the caller's default
 
1488
            author_list_handler = author_list_registry.get(who)
 
1489
        names = author_list_handler(rev)
 
1490
        if short:
 
1491
            for i in range(len(names)):
 
1492
                name, address = config.parse_username(names[i])
 
1493
                if name:
 
1494
                    names[i] = name
 
1495
                else:
 
1496
                    names[i] = address
 
1497
        if sep is not None:
 
1498
            names = sep.join(names)
 
1499
        return names
1419
1500
 
1420
1501
    def merge_marker(self, revision):
1421
1502
        """Get the merge marker to include in the output or '' if none."""
1442
1523
        """
1443
1524
        lines = self._foreign_info_properties(revision)
1444
1525
        for key, handler in properties_handler_registry.iteritems():
1445
 
            lines.extend(self._format_properties(handler(revision)))
 
1526
            try:
 
1527
                lines.extend(self._format_properties(handler(revision)))
 
1528
            except Exception:
 
1529
                trace.log_exception_quietly()
 
1530
                trace.print_exception(sys.exc_info(), self.to_file)
1446
1531
        return lines
1447
1532
 
1448
1533
    def _foreign_info_properties(self, rev):
1456
1541
                rev.mapping.vcs.show_foreign_revid(rev.foreign_revid))
1457
1542
 
1458
1543
        # Imported foreign revision revision ids always contain :
1459
 
        if not ":" in rev.revision_id:
 
1544
        if b":" not in rev.revision_id:
1460
1545
            return []
1461
1546
 
1462
1547
        # Revision was once imported from a foreign repository
1476
1561
        return lines
1477
1562
 
1478
1563
    def show_diff(self, to_file, diff, indent):
1479
 
        for l in diff.rstrip().split('\n'):
1480
 
            to_file.write(indent + '%s\n' % (l,))
 
1564
        encoding = get_terminal_encoding()
 
1565
        for l in diff.rstrip().split(b'\n'):
 
1566
            to_file.write(indent + l.decode(encoding, 'ignore') + '\n')
1481
1567
 
1482
1568
 
1483
1569
# Separator between revisions in long format
1491
1577
    supports_delta = True
1492
1578
    supports_tags = True
1493
1579
    supports_diff = True
 
1580
    supports_signatures = True
1494
1581
 
1495
1582
    def __init__(self, *args, **kwargs):
1496
1583
        super(LongLogFormatter, self).__init__(*args, **kwargs)
1505
1592
 
1506
1593
    def _date_string_original_timezone(self, rev):
1507
1594
        return format_date_with_offset_in_original_timezone(rev.timestamp,
1508
 
            rev.timezone or 0)
 
1595
                                                            rev.timezone or 0)
1509
1596
 
1510
1597
    def log_revision(self, revision):
1511
1598
        """Log a revision, either merged or not."""
1513
1600
        lines = [_LONG_SEP]
1514
1601
        if revision.revno is not None:
1515
1602
            lines.append('revno: %s%s' % (revision.revno,
1516
 
                self.merge_marker(revision)))
 
1603
                                          self.merge_marker(revision)))
1517
1604
        if revision.tags:
1518
 
            lines.append('tags: %s' % (', '.join(revision.tags)))
 
1605
            lines.append('tags: %s' % (', '.join(sorted(revision.tags))))
 
1606
        if self.show_ids or revision.revno is None:
 
1607
            lines.append('revision-id: %s' %
 
1608
                         (revision.rev.revision_id.decode('utf-8'),))
1519
1609
        if self.show_ids:
1520
 
            lines.append('revision-id: %s' % (revision.rev.revision_id,))
1521
1610
            for parent_id in revision.rev.parent_ids:
1522
 
                lines.append('parent: %s' % (parent_id,))
 
1611
                lines.append('parent: %s' % (parent_id.decode('utf-8'),))
1523
1612
        lines.extend(self.custom_properties(revision.rev))
1524
1613
 
1525
1614
        committer = revision.rev.committer
1526
 
        authors = revision.rev.get_apparent_authors()
 
1615
        authors = self.authors(revision.rev, 'all')
1527
1616
        if authors != [committer]:
1528
1617
            lines.append('author: %s' % (", ".join(authors),))
1529
1618
        lines.append('committer: %s' % (committer,))
1534
1623
 
1535
1624
        lines.append('timestamp: %s' % (self.date_string(revision.rev),))
1536
1625
 
 
1626
        if revision.signature is not None:
 
1627
            lines.append('signature: ' + revision.signature)
 
1628
 
1537
1629
        lines.append('message:')
1538
1630
        if not revision.rev.message:
1539
1631
            lines.append('  (no message)')
1547
1639
        to_file.write("%s%s\n" % (indent, ('\n' + indent).join(lines)))
1548
1640
        if revision.delta is not None:
1549
1641
            # Use the standard status output to display changes
1550
 
            from bzrlib.delta import report_delta
1551
 
            report_delta(to_file, revision.delta, short_status=False, 
 
1642
            from breezy.delta import report_delta
 
1643
            report_delta(to_file, revision.delta, short_status=False,
1552
1644
                         show_ids=self.show_ids, indent=indent)
1553
1645
        if revision.diff is not None:
1554
1646
            to_file.write(indent + 'diff:\n')
1586
1678
        indent = '    ' * depth
1587
1679
        revno_width = self.revno_width_by_depth.get(depth)
1588
1680
        if revno_width is None:
1589
 
            if revision.revno.find('.') == -1:
 
1681
            if revision.revno is None or revision.revno.find('.') == -1:
1590
1682
                # mainline revno, e.g. 12345
1591
1683
                revno_width = 5
1592
1684
            else:
1598
1690
        to_file = self.to_file
1599
1691
        tags = ''
1600
1692
        if revision.tags:
1601
 
            tags = ' {%s}' % (', '.join(revision.tags))
 
1693
            tags = ' {%s}' % (', '.join(sorted(revision.tags)))
1602
1694
        to_file.write(indent + "%*s %s\t%s%s%s\n" % (revno_width,
1603
 
                revision.revno, self.short_author(revision.rev),
1604
 
                format_date(revision.rev.timestamp,
1605
 
                            revision.rev.timezone or 0,
1606
 
                            self.show_timezone, date_fmt="%Y-%m-%d",
1607
 
                            show_offset=False),
1608
 
                tags, self.merge_marker(revision)))
1609
 
        self.show_properties(revision.rev, indent+offset)
1610
 
        if self.show_ids:
 
1695
                                                     revision.revno or "", self.short_author(
 
1696
                                                         revision.rev),
 
1697
                                                     format_date(revision.rev.timestamp,
 
1698
                                                                 revision.rev.timezone or 0,
 
1699
                                                                 self.show_timezone, date_fmt="%Y-%m-%d",
 
1700
                                                                 show_offset=False),
 
1701
                                                     tags, self.merge_marker(revision)))
 
1702
        self.show_properties(revision.rev, indent + offset)
 
1703
        if self.show_ids or revision.revno is None:
1611
1704
            to_file.write(indent + offset + 'revision-id:%s\n'
1612
 
                          % (revision.rev.revision_id,))
 
1705
                          % (revision.rev.revision_id.decode('utf-8'),))
1613
1706
        if not revision.rev.message:
1614
1707
            to_file.write(indent + offset + '(no message)\n')
1615
1708
        else:
1619
1712
 
1620
1713
        if revision.delta is not None:
1621
1714
            # Use the standard status output to display changes
1622
 
            from bzrlib.delta import report_delta
1623
 
            report_delta(to_file, revision.delta, 
1624
 
                         short_status=self.delta_format==1, 
 
1715
            from breezy.delta import report_delta
 
1716
            report_delta(to_file, revision.delta,
 
1717
                         short_status=self.delta_format == 1,
1625
1718
                         show_ids=self.show_ids, indent=indent + offset)
1626
1719
        if revision.diff is not None:
1627
1720
            self.show_diff(self.to_exact_file, revision.diff, '      ')
1645
1738
    def truncate(self, str, max_len):
1646
1739
        if max_len is None or len(str) <= max_len:
1647
1740
            return str
1648
 
        return str[:max_len-3] + '...'
 
1741
        return str[:max_len - 3] + '...'
1649
1742
 
1650
1743
    def date_string(self, rev):
1651
1744
        return format_date(rev.timestamp, rev.timezone or 0,
1661
1754
    def log_revision(self, revision):
1662
1755
        indent = '  ' * revision.merge_depth
1663
1756
        self.to_file.write(self.log_string(revision.revno, revision.rev,
1664
 
            self._max_chars, revision.tags, indent))
 
1757
                                           self._max_chars, revision.tags, indent))
1665
1758
        self.to_file.write('\n')
1666
1759
 
1667
1760
    def log_string(self, revno, rev, max_chars, tags=None, prefix=''):
1668
1761
        """Format log info into one string. Truncate tail of 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
 
1762
 
 
1763
        :param revno:      revision number or None.
 
1764
                           Revision numbers counts from 1.
 
1765
        :param rev:        revision object
 
1766
        :param max_chars:  maximum length of resulting string
 
1767
        :param tags:       list of tags or None
 
1768
        :param prefix:     string to prefix each line
 
1769
        :return:           formatted truncated string
1676
1770
        """
1677
1771
        out = []
1678
1772
        if revno:
1679
1773
            # show revno only when is not None
1680
1774
            out.append("%s:" % revno)
1681
 
        out.append(self.truncate(self.short_author(rev), 20))
 
1775
        if max_chars is not None:
 
1776
            out.append(self.truncate(
 
1777
                self.short_author(rev), (max_chars + 3) // 4))
 
1778
        else:
 
1779
            out.append(self.short_author(rev))
1682
1780
        out.append(self.date_string(rev))
1683
1781
        if len(rev.parent_ids) > 1:
1684
1782
            out.append('[merge]')
1685
1783
        if tags:
1686
 
            tag_str = '{%s}' % (', '.join(tags))
 
1784
            tag_str = '{%s}' % (', '.join(sorted(tags)))
1687
1785
            out.append(tag_str)
1688
1786
        out.append(rev.get_summary())
1689
1787
        return self.truncate(prefix + " ".join(out).rstrip('\n'), max_chars)
1703
1801
                               self.show_timezone,
1704
1802
                               date_fmt='%Y-%m-%d',
1705
1803
                               show_offset=False)
1706
 
        committer_str = revision.rev.get_apparent_authors()[0].replace (' <', '  <')
1707
 
        to_file.write('%s  %s\n\n' % (date_str,committer_str))
 
1804
        committer_str = self.authors(revision.rev, 'first', sep=', ')
 
1805
        committer_str = committer_str.replace(' <', '  <')
 
1806
        to_file.write('%s  %s\n\n' % (date_str, committer_str))
1708
1807
 
1709
1808
        if revision.delta is not None and revision.delta.has_changed():
1710
1809
            for c in revision.delta.added + revision.delta.removed + revision.delta.modified:
1711
1810
                path, = c[:1]
1712
1811
                to_file.write('\t* %s:\n' % (path,))
1713
1812
            for c in revision.delta.renamed:
1714
 
                oldpath,newpath = c[:2]
 
1813
                oldpath, newpath = c[:2]
1715
1814
                # For renamed files, show both the old and the new path
1716
 
                to_file.write('\t* %s:\n\t* %s:\n' % (oldpath,newpath))
 
1815
                to_file.write('\t* %s:\n\t* %s:\n' % (oldpath, newpath))
1717
1816
            to_file.write('\n')
1718
1817
 
1719
1818
        if not revision.rev.message:
1742
1841
        return self.get(name)(*args, **kwargs)
1743
1842
 
1744
1843
    def get_default(self, branch):
1745
 
        return self.get(branch.get_config().log_format())
 
1844
        c = branch.get_config_stack()
 
1845
        return self.get(c.get('log_format'))
1746
1846
 
1747
1847
 
1748
1848
log_formatter_registry = LogFormatterRegistry()
1749
1849
 
1750
1850
 
1751
1851
log_formatter_registry.register('short', ShortLogFormatter,
1752
 
                                'Moderately short log format')
 
1852
                                'Moderately short log format.')
1753
1853
log_formatter_registry.register('long', LongLogFormatter,
1754
 
                                'Detailed log format')
 
1854
                                'Detailed log format.')
1755
1855
log_formatter_registry.register('line', LineLogFormatter,
1756
 
                                'Log format with one line per revision')
 
1856
                                'Log format with one line per revision.')
1757
1857
log_formatter_registry.register('gnu-changelog', GnuChangelogLogFormatter,
1758
 
                                'Format used by GNU ChangeLog files')
 
1858
                                'Format used by GNU ChangeLog files.')
1759
1859
 
1760
1860
 
1761
1861
def register_formatter(name, formatter):
1771
1871
    try:
1772
1872
        return log_formatter_registry.make_formatter(name, *args, **kwargs)
1773
1873
    except KeyError:
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)
 
1874
        raise errors.BzrCommandError(
 
1875
            gettext("unknown log formatter: %r") % name)
 
1876
 
 
1877
 
 
1878
def author_list_all(rev):
 
1879
    return rev.get_apparent_authors()[:]
 
1880
 
 
1881
 
 
1882
def author_list_first(rev):
 
1883
    lst = rev.get_apparent_authors()
 
1884
    try:
 
1885
        return [lst[0]]
 
1886
    except IndexError:
 
1887
        return []
 
1888
 
 
1889
 
 
1890
def author_list_committer(rev):
 
1891
    return [rev.committer]
 
1892
 
 
1893
 
 
1894
author_list_registry = registry.Registry()
 
1895
 
 
1896
author_list_registry.register('all', author_list_all,
 
1897
                              'All authors')
 
1898
 
 
1899
author_list_registry.register('first', author_list_first,
 
1900
                              'The first author')
 
1901
 
 
1902
author_list_registry.register('committer', author_list_committer,
 
1903
                              'The committer')
1781
1904
 
1782
1905
 
1783
1906
def show_changed_revisions(branch, old_rh, new_rh, to_file=None,
1791
1914
    """
1792
1915
    if to_file is None:
1793
1916
        to_file = codecs.getwriter(get_terminal_encoding())(sys.stdout,
1794
 
            errors='replace')
 
1917
                                                            errors='replace')
1795
1918
    lf = log_formatter(log_format,
1796
1919
                       show_ids=False,
1797
1920
                       to_file=to_file,
1800
1923
    # This is the first index which is different between
1801
1924
    # old and new
1802
1925
    base_idx = None
1803
 
    for i in xrange(max(len(new_rh),
1804
 
                        len(old_rh))):
 
1926
    for i in range(max(len(new_rh), len(old_rh))):
1805
1927
        if (len(new_rh) <= i
1806
1928
            or len(old_rh) <= i
1807
 
            or new_rh[i] != old_rh[i]):
 
1929
                or new_rh[i] != old_rh[i]):
1808
1930
            base_idx = i
1809
1931
            break
1810
1932
 
1811
1933
    if base_idx is None:
1812
1934
        to_file.write('Nothing seems to have changed\n')
1813
1935
        return
1814
 
    ## TODO: It might be nice to do something like show_log
1815
 
    ##       and show the merged entries. But since this is the
1816
 
    ##       removed revisions, it shouldn't be as important
 
1936
    # TODO: It might be nice to do something like show_log
 
1937
    # and show the merged entries. But since this is the
 
1938
    # removed revisions, it shouldn't be as important
1817
1939
    if base_idx < len(old_rh):
1818
 
        to_file.write('*'*60)
 
1940
        to_file.write('*' * 60)
1819
1941
        to_file.write('\nRemoved Revisions:\n')
1820
1942
        for i in range(base_idx, len(old_rh)):
1821
1943
            rev = branch.repository.get_revision(old_rh[i])
1822
 
            lr = LogRevision(rev, i+1, 0, None)
 
1944
            lr = LogRevision(rev, i + 1, 0, None)
1823
1945
            lf.log_revision(lr)
1824
 
        to_file.write('*'*60)
 
1946
        to_file.write('*' * 60)
1825
1947
        to_file.write('\n\n')
1826
1948
    if base_idx < len(new_rh):
1827
1949
        to_file.write('Added Revisions:\n')
1830
1952
                 None,
1831
1953
                 verbose=False,
1832
1954
                 direction='forward',
1833
 
                 start_revision=base_idx+1,
 
1955
                 start_revision=base_idx + 1,
1834
1956
                 end_revision=len(new_rh),
1835
1957
                 search=None)
1836
1958
 
1848
1970
    old_revisions = set()
1849
1971
    new_history = []
1850
1972
    new_revisions = set()
1851
 
    new_iter = repository.iter_reverse_revision_history(new_revision_id)
1852
 
    old_iter = repository.iter_reverse_revision_history(old_revision_id)
 
1973
    graph = repository.get_graph()
 
1974
    new_iter = graph.iter_lefthand_ancestry(new_revision_id)
 
1975
    old_iter = graph.iter_lefthand_ancestry(old_revision_id)
1853
1976
    stop_revision = None
1854
1977
    do_old = True
1855
1978
    do_new = True
1856
1979
    while do_new or do_old:
1857
1980
        if do_new:
1858
1981
            try:
1859
 
                new_revision = new_iter.next()
 
1982
                new_revision = next(new_iter)
1860
1983
            except StopIteration:
1861
1984
                do_new = False
1862
1985
            else:
1867
1990
                    break
1868
1991
        if do_old:
1869
1992
            try:
1870
 
                old_revision = old_iter.next()
 
1993
                old_revision = next(old_iter)
1871
1994
            except StopIteration:
1872
1995
                do_old = False
1873
1996
            else:
1903
2026
    log_format = log_formatter_registry.get_default(branch)
1904
2027
    lf = log_format(show_ids=False, to_file=output, show_timezone='original')
1905
2028
    if old_history != []:
1906
 
        output.write('*'*60)
 
2029
        output.write('*' * 60)
1907
2030
        output.write('\nRemoved Revisions:\n')
1908
2031
        show_flat_log(branch.repository, old_history, old_revno, lf)
1909
 
        output.write('*'*60)
 
2032
        output.write('*' * 60)
1910
2033
        output.write('\n\n')
1911
2034
    if new_history != []:
1912
2035
        output.write('Added Revisions:\n')
1913
2036
        start_revno = new_revno - len(new_history) + 1
1914
2037
        show_log(branch, lf, None, verbose=False, direction='forward',
1915
 
                 start_revision=start_revno,)
 
2038
                 start_revision=start_revno)
1916
2039
 
1917
2040
 
1918
2041
def show_flat_log(repository, history, last_revno, lf):
1923
2046
    :param last_revno: The revno of the last revision_id in the history.
1924
2047
    :param lf: The log formatter to use.
1925
2048
    """
1926
 
    start_revno = last_revno - len(history) + 1
1927
2049
    revisions = repository.get_revisions(history)
1928
2050
    for i, rev in enumerate(revisions):
1929
2051
        lr = LogRevision(rev, i + last_revno, 0, None)
1930
2052
        lf.log_revision(lr)
1931
2053
 
1932
2054
 
1933
 
def _get_info_for_log_files(revisionspec_list, file_list):
 
2055
def _get_info_for_log_files(revisionspec_list, file_list, add_cleanup):
1934
2056
    """Find file-ids and kinds given a list of files and a revision range.
1935
2057
 
1936
2058
    We search for files at the end of the range. If not found there,
1940
2062
    :param file_list: the list of paths given on the command line;
1941
2063
      the first of these can be a branch location or a file path,
1942
2064
      the remainder must be file paths
 
2065
    :param add_cleanup: When the branch returned is read locked,
 
2066
      an unlock call will be queued to the cleanup.
1943
2067
    :return: (branch, info_list, start_rev_info, end_rev_info) where
1944
2068
      info_list is a list of (relative_path, file_id, kind) tuples where
1945
2069
      kind is one of values 'directory', 'file', 'symlink', 'tree-reference'.
1946
2070
      branch will be read-locked.
1947
2071
    """
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()
 
2072
    from breezy.builtins import _get_revision_range
 
2073
    tree, b, path = controldir.ControlDir.open_containing_tree_or_branch(
 
2074
        file_list[0])
 
2075
    add_cleanup(b.lock_read().unlock)
1951
2076
    # XXX: It's damn messy converting a list of paths to relative paths when
1952
2077
    # those paths might be deleted ones, they might be on a case-insensitive
1953
2078
    # filesystem and/or they might be in silly locations (like another branch).
1957
2082
    # case of running log in a nested directory, assuming paths beyond the
1958
2083
    # first one haven't been deleted ...
1959
2084
    if tree:
1960
 
        relpaths = [path] + safe_relpath_files(tree, file_list[1:])
 
2085
        relpaths = [path] + tree.safe_relpath_files(file_list[1:])
1961
2086
    else:
1962
2087
        relpaths = [path] + file_list[1:]
1963
2088
    info_list = []
1964
2089
    start_rev_info, end_rev_info = _get_revision_range(revisionspec_list, b,
1965
 
        "log")
 
2090
                                                       "log")
1966
2091
    if relpaths in ([], [u'']):
1967
2092
        return b, [], start_rev_info, end_rev_info
1968
2093
    if start_rev_info is None and end_rev_info is None:
1971
2096
        tree1 = None
1972
2097
        for fp in relpaths:
1973
2098
            file_id = tree.path2id(fp)
1974
 
            kind = _get_kind_for_file_id(tree, file_id)
 
2099
            kind = _get_kind_for_file_id(tree, fp, file_id)
1975
2100
            if file_id is None:
1976
2101
                # go back to when time began
1977
2102
                if tree1 is None:
1985
2110
                        tree1 = b.repository.revision_tree(rev1)
1986
2111
                if tree1:
1987
2112
                    file_id = tree1.path2id(fp)
1988
 
                    kind = _get_kind_for_file_id(tree1, file_id)
 
2113
                    kind = _get_kind_for_file_id(tree1, fp, file_id)
1989
2114
            info_list.append((fp, file_id, kind))
1990
2115
 
1991
2116
    elif start_rev_info == end_rev_info:
1993
2118
        tree = b.repository.revision_tree(end_rev_info.rev_id)
1994
2119
        for fp in relpaths:
1995
2120
            file_id = tree.path2id(fp)
1996
 
            kind = _get_kind_for_file_id(tree, file_id)
 
2121
            kind = _get_kind_for_file_id(tree, fp, file_id)
1997
2122
            info_list.append((fp, file_id, kind))
1998
2123
 
1999
2124
    else:
2007
2132
        tree1 = None
2008
2133
        for fp in relpaths:
2009
2134
            file_id = tree.path2id(fp)
2010
 
            kind = _get_kind_for_file_id(tree, file_id)
 
2135
            kind = _get_kind_for_file_id(tree, fp, file_id)
2011
2136
            if file_id is None:
2012
2137
                if tree1 is None:
2013
2138
                    rev_id = start_rev_info.rev_id
2017
2142
                    else:
2018
2143
                        tree1 = b.repository.revision_tree(rev_id)
2019
2144
                file_id = tree1.path2id(fp)
2020
 
                kind = _get_kind_for_file_id(tree1, file_id)
 
2145
                kind = _get_kind_for_file_id(tree1, fp, file_id)
2021
2146
            info_list.append((fp, file_id, kind))
2022
2147
    return b, info_list, start_rev_info, end_rev_info
2023
2148
 
2024
2149
 
2025
 
def _get_kind_for_file_id(tree, file_id):
 
2150
def _get_kind_for_file_id(tree, path, file_id):
2026
2151
    """Return the kind of a file-id or None if it doesn't exist."""
2027
2152
    if file_id is not None:
2028
 
        return tree.kind(file_id)
 
2153
        return tree.kind(path)
2029
2154
    else:
2030
2155
        return None
2031
2156
 
2033
2158
properties_handler_registry = registry.Registry()
2034
2159
 
2035
2160
# Use the properties handlers to print out bug information if available
 
2161
 
 
2162
 
2036
2163
def _bugs_properties_handler(revision):
2037
 
    if revision.properties.has_key('bugs'):
2038
 
        bug_lines = revision.properties['bugs'].split('\n')
2039
 
        bug_rows = [line.split(' ', 1) for line in bug_lines]
2040
 
        fixed_bug_urls = [row[0] for row in bug_rows if
2041
 
                          len(row) > 1 and row[1] == 'fixed']
 
2164
    fixed_bug_urls = []
 
2165
    related_bug_urls = []
 
2166
    for bug_url, status in revision.iter_bugs():
 
2167
        if status == 'fixed':
 
2168
            fixed_bug_urls.append(bug_url)
 
2169
        elif status == 'related':
 
2170
            related_bug_urls.append(bug_url)
 
2171
    ret = {}
 
2172
    if fixed_bug_urls:
 
2173
        text = ngettext('fixes bug', 'fixes bugs', len(fixed_bug_urls))
 
2174
        ret[text] = ' '.join(fixed_bug_urls)
 
2175
    if related_bug_urls:
 
2176
        text = ngettext('related bug', 'related bugs',
 
2177
                        len(related_bug_urls))
 
2178
        ret[text] = ' '.join(related_bug_urls)
 
2179
    return ret
2042
2180
 
2043
 
        if fixed_bug_urls:
2044
 
            return {'fixes bug(s)': ' '.join(fixed_bug_urls)}
2045
 
    return {}
2046
2181
 
2047
2182
properties_handler_registry.register('bugs_properties_handler',
2048
2183
                                     _bugs_properties_handler)