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