/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 23:41:35 UTC
  • mto: This revision was merged to the branch mainline in revision 5223.
  • Revision ID: robertc@robertcollins.net-20100506234135-yivbzczw1sejxnxc
Lock methods on ``Tree``, ``Branch`` and ``Repository`` are now
expected to return an object which can be used to unlock them. This reduces
duplicate code when using cleanups. The previous 'tokens's returned by
``Branch.lock_write`` and ``Repository.lock_write`` are now attributes
on the result of the lock_write. ``repository.RepositoryWriteLockResult``
and ``branch.BranchWriteLockResult`` document this. (Robert Collins)

``log._get_info_for_log_files`` now takes an add_cleanup callable.
(Robert Collins)

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