/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

merge bzr.dev.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005, 2006, 2007 Canonical Ltd
 
1
# Copyright (C) 2005, 2006, 2007, 2009 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
12
12
#
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
16
 
17
17
 
18
18
 
49
49
all the changes since the previous revision that touched hello.c.
50
50
"""
51
51
 
52
 
# TODO: option to show delta summaries for merged-in revisions
53
 
 
54
 
from itertools import izip
 
52
import codecs
 
53
from cStringIO import StringIO
 
54
from itertools import (
 
55
    chain,
 
56
    izip,
 
57
    )
55
58
import re
 
59
import sys
 
60
from warnings import (
 
61
    warn,
 
62
    )
 
63
 
 
64
from bzrlib.lazy_import import lazy_import
 
65
lazy_import(globals(), """
 
66
 
 
67
from bzrlib import (
 
68
    bzrdir,
 
69
    config,
 
70
    diff,
 
71
    errors,
 
72
    repository as _mod_repository,
 
73
    revision as _mod_revision,
 
74
    revisionspec,
 
75
    trace,
 
76
    tsort,
 
77
    )
 
78
""")
56
79
 
57
80
from bzrlib import (
58
81
    registry,
59
 
    symbol_versioning,
60
 
    )
61
 
import bzrlib.errors as errors
62
 
from bzrlib.revisionspec import(
63
 
    RevisionInfo
64
 
    )
65
 
from bzrlib.symbol_versioning import (
66
 
    deprecated_method,
67
 
    zero_eleven,
68
 
    zero_seventeen,
69
 
    )
70
 
from bzrlib.trace import mutter
71
 
from bzrlib.tsort import (
72
 
    merge_sort,
73
 
    topo_sort,
 
82
    )
 
83
from bzrlib.osutils import (
 
84
    format_date,
 
85
    get_terminal_encoding,
 
86
    re_compile_checked,
 
87
    terminal_width,
74
88
    )
75
89
 
76
90
 
135
149
             start_revision=None,
136
150
             end_revision=None,
137
151
             search=None,
138
 
             limit=None):
 
152
             limit=None,
 
153
             show_diff=False):
139
154
    """Write out human-readable log of commits to this branch.
140
155
 
141
 
    lf
142
 
        LogFormatter object to show the output.
143
 
 
144
 
    specific_fileid
145
 
        If true, list only the commits affecting the specified
146
 
        file, rather than all commits.
147
 
 
148
 
    verbose
149
 
        If true show added/changed/deleted/renamed files.
150
 
 
151
 
    direction
152
 
        'reverse' (default) is latest to earliest;
153
 
        'forward' is earliest to latest.
154
 
 
155
 
    start_revision
156
 
        If not None, only show revisions >= start_revision
157
 
 
158
 
    end_revision
159
 
        If not None, only show revisions <= end_revision
160
 
 
161
 
    search
162
 
        If not None, only show revisions with matching commit messages
163
 
 
164
 
    limit
165
 
        If not None or 0, only show limit revisions
166
 
    """
167
 
    branch.lock_read()
168
 
    try:
169
 
        if getattr(lf, 'begin_log', None):
170
 
            lf.begin_log()
171
 
 
172
 
        _show_log(branch, lf, specific_fileid, verbose, direction,
173
 
                  start_revision, end_revision, search, limit)
174
 
 
175
 
        if getattr(lf, 'end_log', None):
176
 
            lf.end_log()
177
 
    finally:
178
 
        branch.unlock()
179
 
 
180
 
def _show_log(branch,
181
 
             lf,
182
 
             specific_fileid=None,
183
 
             verbose=False,
184
 
             direction='reverse',
185
 
             start_revision=None,
186
 
             end_revision=None,
187
 
             search=None,
188
 
             limit=None):
189
 
    """Worker function for show_log - see show_log."""
190
 
    from bzrlib.osutils import format_date
191
 
    from bzrlib.errors import BzrCheckError
192
 
    
193
 
    from warnings import warn
194
 
 
195
 
    if not isinstance(lf, LogFormatter):
196
 
        warn("not a LogFormatter instance: %r" % lf)
197
 
 
198
 
    if specific_fileid:
199
 
        mutter('get log for file_id %r', specific_fileid)
200
 
 
201
 
    if search is not None:
202
 
        import re
203
 
        searchRE = re.compile(search, re.IGNORECASE)
204
 
    else:
205
 
        searchRE = None
206
 
 
207
 
    mainline_revs, rev_nos, start_rev_id, end_rev_id = \
208
 
        _get_mainline_revs(branch, start_revision, end_revision)
209
 
    if not mainline_revs:
210
 
        return
211
 
 
 
156
    This function is being retained for backwards compatibility but
 
157
    should not be extended with new parameters. Use the new Logger class
 
158
    instead, eg. Logger(branch, rqst).show(lf), adding parameters to the
 
159
    make_log_request_dict function.
 
160
 
 
161
    :param lf: The LogFormatter object showing the output.
 
162
 
 
163
    :param specific_fileid: If not None, list only the commits affecting the
 
164
        specified file, rather than all commits.
 
165
 
 
166
    :param verbose: If True show added/changed/deleted/renamed files.
 
167
 
 
168
    :param direction: 'reverse' (default) is latest to earliest; 'forward' is
 
169
        earliest to latest.
 
170
 
 
171
    :param start_revision: If not None, only show revisions >= start_revision
 
172
 
 
173
    :param end_revision: If not None, only show revisions <= end_revision
 
174
 
 
175
    :param search: If not None, only show revisions with matching commit
 
176
        messages
 
177
 
 
178
    :param limit: If set, shows only 'limit' revisions, all revisions are shown
 
179
        if None or 0.
 
180
 
 
181
    :param show_diff: If True, output a diff after each revision.
 
182
    """
 
183
    # Convert old-style parameters to new-style parameters
 
184
    if specific_fileid is not None:
 
185
        file_ids = [specific_fileid]
 
186
    else:
 
187
        file_ids = None
 
188
    if verbose:
 
189
        if file_ids:
 
190
            delta_type = 'partial'
 
191
        else:
 
192
            delta_type = 'full'
 
193
    else:
 
194
        delta_type = None
 
195
    if show_diff:
 
196
        if file_ids:
 
197
            diff_type = 'partial'
 
198
        else:
 
199
            diff_type = 'full'
 
200
    else:
 
201
        diff_type = None
 
202
 
 
203
    # Build the request and execute it
 
204
    rqst = make_log_request_dict(direction=direction, specific_fileids=file_ids,
 
205
        start_revision=start_revision, end_revision=end_revision,
 
206
        limit=limit, message_search=search,
 
207
        delta_type=delta_type, diff_type=diff_type)
 
208
    Logger(branch, rqst).show(lf)
 
209
 
 
210
 
 
211
# Note: This needs to be kept this in sync with the defaults in
 
212
# make_log_request_dict() below
 
213
_DEFAULT_REQUEST_PARAMS = {
 
214
    'direction': 'reverse',
 
215
    'levels': 1,
 
216
    'generate_tags': True,
 
217
    '_match_using_deltas': True,
 
218
    }
 
219
 
 
220
 
 
221
def make_log_request_dict(direction='reverse', specific_fileids=None,
 
222
    start_revision=None, end_revision=None, limit=None,
 
223
    message_search=None, levels=1, generate_tags=True, delta_type=None,
 
224
    diff_type=None, _match_using_deltas=True):
 
225
    """Convenience function for making a logging request dictionary.
 
226
 
 
227
    Using this function may make code slightly safer by ensuring
 
228
    parameters have the correct names. It also provides a reference
 
229
    point for documenting the supported parameters.
 
230
 
 
231
    :param direction: 'reverse' (default) is latest to earliest;
 
232
      'forward' is earliest to latest.
 
233
 
 
234
    :param specific_fileids: If not None, only include revisions
 
235
      affecting the specified files, rather than all revisions.
 
236
 
 
237
    :param start_revision: If not None, only generate
 
238
      revisions >= start_revision
 
239
 
 
240
    :param end_revision: If not None, only generate
 
241
      revisions <= end_revision
 
242
 
 
243
    :param limit: If set, generate only 'limit' revisions, all revisions
 
244
      are shown if None or 0.
 
245
 
 
246
    :param message_search: If not None, only include revisions with
 
247
      matching commit messages
 
248
 
 
249
    :param levels: the number of levels of revisions to
 
250
      generate; 1 for just the mainline; 0 for all levels.
 
251
 
 
252
    :param generate_tags: If True, include tags for matched revisions.
 
253
 
 
254
    :param delta_type: Either 'full', 'partial' or None.
 
255
      'full' means generate the complete delta - adds/deletes/modifies/etc;
 
256
      'partial' means filter the delta using specific_fileids;
 
257
      None means do not generate any delta.
 
258
 
 
259
    :param diff_type: Either 'full', 'partial' or None.
 
260
      'full' means generate the complete diff - adds/deletes/modifies/etc;
 
261
      'partial' means filter the diff using specific_fileids;
 
262
      None means do not generate any diff.
 
263
 
 
264
    :param _match_using_deltas: a private parameter controlling the
 
265
      algorithm used for matching specific_fileids. This parameter
 
266
      may be removed in the future so bzrlib client code should NOT
 
267
      use it.
 
268
    """
 
269
    return {
 
270
        'direction': direction,
 
271
        'specific_fileids': specific_fileids,
 
272
        'start_revision': start_revision,
 
273
        'end_revision': end_revision,
 
274
        'limit': limit,
 
275
        'message_search': message_search,
 
276
        'levels': levels,
 
277
        'generate_tags': generate_tags,
 
278
        'delta_type': delta_type,
 
279
        'diff_type': diff_type,
 
280
        # Add 'private' attributes for features that may be deprecated
 
281
        '_match_using_deltas': _match_using_deltas,
 
282
    }
 
283
 
 
284
 
 
285
def _apply_log_request_defaults(rqst):
 
286
    """Apply default values to a request dictionary."""
 
287
    result = _DEFAULT_REQUEST_PARAMS
 
288
    if rqst:
 
289
        result.update(rqst)
 
290
    return result
 
291
 
 
292
 
 
293
class LogGenerator(object):
 
294
    """A generator of log revisions."""
 
295
 
 
296
    def iter_log_revisions(self):
 
297
        """Iterate over LogRevision objects.
 
298
 
 
299
        :return: An iterator yielding LogRevision objects.
 
300
        """
 
301
        raise NotImplementedError(self.iter_log_revisions)
 
302
 
 
303
 
 
304
class Logger(object):
 
305
    """An object the generates, formats and displays a log."""
 
306
 
 
307
    def __init__(self, branch, rqst):
 
308
        """Create a Logger.
 
309
 
 
310
        :param branch: the branch to log
 
311
        :param rqst: A dictionary specifying the query parameters.
 
312
          See make_log_request_dict() for supported values.
 
313
        """
 
314
        self.branch = branch
 
315
        self.rqst = _apply_log_request_defaults(rqst)
 
316
 
 
317
    def show(self, lf):
 
318
        """Display the log.
 
319
 
 
320
        :param lf: The LogFormatter object to send the output to.
 
321
        """
 
322
        if not isinstance(lf, LogFormatter):
 
323
            warn("not a LogFormatter instance: %r" % lf)
 
324
 
 
325
        self.branch.lock_read()
 
326
        try:
 
327
            if getattr(lf, 'begin_log', None):
 
328
                lf.begin_log()
 
329
            self._show_body(lf)
 
330
            if getattr(lf, 'end_log', None):
 
331
                lf.end_log()
 
332
        finally:
 
333
            self.branch.unlock()
 
334
 
 
335
    def _show_body(self, lf):
 
336
        """Show the main log output.
 
337
 
 
338
        Subclasses may wish to override this.
 
339
        """
 
340
        # Tweak the LogRequest based on what the LogFormatter can handle.
 
341
        # (There's no point generating stuff if the formatter can't display it.)
 
342
        rqst = self.rqst
 
343
        rqst['levels'] = lf.get_levels()
 
344
        if not getattr(lf, 'supports_tags', False):
 
345
            rqst['generate_tags'] = False
 
346
        if not getattr(lf, 'supports_delta', False):
 
347
            rqst['delta_type'] = None
 
348
        if not getattr(lf, 'supports_diff', False):
 
349
            rqst['diff_type'] = None
 
350
 
 
351
        # Find and print the interesting revisions
 
352
        generator = self._generator_factory(self.branch, rqst)
 
353
        for lr in generator.iter_log_revisions():
 
354
            lf.log_revision(lr)
 
355
        lf.show_advice()
 
356
 
 
357
    def _generator_factory(self, branch, rqst):
 
358
        """Make the LogGenerator object to use.
 
359
        
 
360
        Subclasses may wish to override this.
 
361
        """
 
362
        return _DefaultLogGenerator(branch, rqst)
 
363
 
 
364
 
 
365
class _StartNotLinearAncestor(Exception):
 
366
    """Raised when a start revision is not found walking left-hand history."""
 
367
 
 
368
 
 
369
class _DefaultLogGenerator(LogGenerator):
 
370
    """The default generator of log revisions."""
 
371
 
 
372
    def __init__(self, branch, rqst):
 
373
        self.branch = branch
 
374
        self.rqst = rqst
 
375
        if rqst.get('generate_tags') and branch.supports_tags():
 
376
            self.rev_tag_dict = branch.tags.get_reverse_tag_dict()
 
377
        else:
 
378
            self.rev_tag_dict = {}
 
379
 
 
380
    def iter_log_revisions(self):
 
381
        """Iterate over LogRevision objects.
 
382
 
 
383
        :return: An iterator yielding LogRevision objects.
 
384
        """
 
385
        rqst = self.rqst
 
386
        log_count = 0
 
387
        revision_iterator = self._create_log_revision_iterator()
 
388
        for revs in revision_iterator:
 
389
            for (rev_id, revno, merge_depth), rev, delta in revs:
 
390
                # 0 levels means show everything; merge_depth counts from 0
 
391
                levels = rqst.get('levels')
 
392
                if levels != 0 and merge_depth >= levels:
 
393
                    continue
 
394
                diff = self._format_diff(rev, rev_id)
 
395
                yield LogRevision(rev, revno, merge_depth, delta,
 
396
                    self.rev_tag_dict.get(rev_id), diff)
 
397
                limit = rqst.get('limit')
 
398
                if limit:
 
399
                    log_count += 1
 
400
                    if log_count >= limit:
 
401
                        return
 
402
 
 
403
    def _format_diff(self, rev, rev_id):
 
404
        diff_type = self.rqst.get('diff_type')
 
405
        if diff_type is None:
 
406
            return None
 
407
        repo = self.branch.repository
 
408
        if len(rev.parent_ids) == 0:
 
409
            ancestor_id = _mod_revision.NULL_REVISION
 
410
        else:
 
411
            ancestor_id = rev.parent_ids[0]
 
412
        tree_1 = repo.revision_tree(ancestor_id)
 
413
        tree_2 = repo.revision_tree(rev_id)
 
414
        file_ids = self.rqst.get('specific_fileids')
 
415
        if diff_type == 'partial' and file_ids is not None:
 
416
            specific_files = [tree_2.id2path(id) for id in file_ids]
 
417
        else:
 
418
            specific_files = None
 
419
        s = StringIO()
 
420
        diff.show_diff_trees(tree_1, tree_2, s, specific_files, old_label='',
 
421
            new_label='')
 
422
        return s.getvalue()
 
423
 
 
424
    def _create_log_revision_iterator(self):
 
425
        """Create a revision iterator for log.
 
426
 
 
427
        :return: An iterator over lists of ((rev_id, revno, merge_depth), rev,
 
428
            delta).
 
429
        """
 
430
        self.start_rev_id, self.end_rev_id = _get_revision_limits(
 
431
            self.branch, self.rqst.get('start_revision'),
 
432
            self.rqst.get('end_revision'))
 
433
        if self.rqst.get('_match_using_deltas'):
 
434
            return self._log_revision_iterator_using_delta_matching()
 
435
        else:
 
436
            # We're using the per-file-graph algorithm. This scales really
 
437
            # well but only makes sense if there is a single file and it's
 
438
            # not a directory
 
439
            file_count = len(self.rqst.get('specific_fileids'))
 
440
            if file_count != 1:
 
441
                raise BzrError("illegal LogRequest: must match-using-deltas "
 
442
                    "when logging %d files" % file_count)
 
443
            return self._log_revision_iterator_using_per_file_graph()
 
444
 
 
445
    def _log_revision_iterator_using_delta_matching(self):
 
446
        # Get the base revisions, filtering by the revision range
 
447
        rqst = self.rqst
 
448
        generate_merge_revisions = rqst.get('levels') != 1
 
449
        delayed_graph_generation = not rqst.get('specific_fileids') and (
 
450
                rqst.get('limit') or self.start_rev_id or self.end_rev_id)
 
451
        view_revisions = _calc_view_revisions(self.branch, self.start_rev_id,
 
452
            self.end_rev_id, rqst.get('direction'), generate_merge_revisions,
 
453
            delayed_graph_generation=delayed_graph_generation)
 
454
 
 
455
        # Apply the other filters
 
456
        return make_log_rev_iterator(self.branch, view_revisions,
 
457
            rqst.get('delta_type'), rqst.get('message_search'),
 
458
            file_ids=rqst.get('specific_fileids'),
 
459
            direction=rqst.get('direction'))
 
460
 
 
461
    def _log_revision_iterator_using_per_file_graph(self):
 
462
        # Get the base revisions, filtering by the revision range.
 
463
        # Note that we always generate the merge revisions because
 
464
        # filter_revisions_touching_file_id() requires them ...
 
465
        rqst = self.rqst
 
466
        view_revisions = _calc_view_revisions(self.branch, self.start_rev_id,
 
467
            self.end_rev_id, rqst.get('direction'), True)
 
468
        if not isinstance(view_revisions, list):
 
469
            view_revisions = list(view_revisions)
 
470
        view_revisions = _filter_revisions_touching_file_id(self.branch,
 
471
            rqst.get('specific_fileids')[0], view_revisions,
 
472
            include_merges=rqst.get('levels') != 1)
 
473
        return make_log_rev_iterator(self.branch, view_revisions,
 
474
            rqst.get('delta_type'), rqst.get('message_search'))
 
475
 
 
476
 
 
477
def _calc_view_revisions(branch, start_rev_id, end_rev_id, direction,
 
478
    generate_merge_revisions, delayed_graph_generation=False):
 
479
    """Calculate the revisions to view.
 
480
 
 
481
    :return: An iterator of (revision_id, dotted_revno, merge_depth) tuples OR
 
482
             a list of the same tuples.
 
483
    """
 
484
    br_revno, br_rev_id = branch.last_revision_info()
 
485
    if br_revno == 0:
 
486
        return []
 
487
 
 
488
    # If a single revision is requested, check we can handle it
 
489
    generate_single_revision = (end_rev_id and start_rev_id == end_rev_id and
 
490
        (not generate_merge_revisions or not _has_merges(branch, end_rev_id)))
 
491
    if generate_single_revision:
 
492
        return _generate_one_revision(branch, end_rev_id, br_rev_id, br_revno)
 
493
 
 
494
    # If we only want to see linear revisions, we can iterate ...
 
495
    if not generate_merge_revisions:
 
496
        return _generate_flat_revisions(branch, start_rev_id, end_rev_id,
 
497
            direction)
 
498
    else:
 
499
        return _generate_all_revisions(branch, start_rev_id, end_rev_id,
 
500
            direction, delayed_graph_generation)
 
501
 
 
502
 
 
503
def _generate_one_revision(branch, rev_id, br_rev_id, br_revno):
 
504
    if rev_id == br_rev_id:
 
505
        # It's the tip
 
506
        return [(br_rev_id, br_revno, 0)]
 
507
    else:
 
508
        revno = branch.revision_id_to_dotted_revno(rev_id)
 
509
        revno_str = '.'.join(str(n) for n in revno)
 
510
        return [(rev_id, revno_str, 0)]
 
511
 
 
512
 
 
513
def _generate_flat_revisions(branch, start_rev_id, end_rev_id, direction):
 
514
    result = _linear_view_revisions(branch, start_rev_id, end_rev_id)
 
515
    # If a start limit was given and it's not obviously an
 
516
    # ancestor of the end limit, check it before outputting anything
 
517
    if direction == 'forward' or (start_rev_id
 
518
        and not _is_obvious_ancestor(branch, start_rev_id, end_rev_id)):
 
519
        try:
 
520
            result = list(result)
 
521
        except _StartNotLinearAncestor:
 
522
            raise errors.BzrCommandError('Start revision not found in'
 
523
                ' left-hand history of end revision.')
 
524
    if direction == 'forward':
 
525
        result = reversed(result)
 
526
    return result
 
527
 
 
528
 
 
529
def _generate_all_revisions(branch, start_rev_id, end_rev_id, direction,
 
530
    delayed_graph_generation):
 
531
    # On large trees, generating the merge graph can take 30-60 seconds
 
532
    # so we delay doing it until a merge is detected, incrementally
 
533
    # returning initial (non-merge) revisions while we can.
 
534
    initial_revisions = []
 
535
    if delayed_graph_generation:
 
536
        try:
 
537
            for rev_id, revno, depth in \
 
538
                _linear_view_revisions(branch, start_rev_id, end_rev_id):
 
539
                if _has_merges(branch, rev_id):
 
540
                    end_rev_id = rev_id
 
541
                    break
 
542
                else:
 
543
                    initial_revisions.append((rev_id, revno, depth))
 
544
            else:
 
545
                # No merged revisions found
 
546
                if direction == 'reverse':
 
547
                    return initial_revisions
 
548
                elif direction == 'forward':
 
549
                    return reversed(initial_revisions)
 
550
                else:
 
551
                    raise ValueError('invalid direction %r' % direction)
 
552
        except _StartNotLinearAncestor:
 
553
            # A merge was never detected so the lower revision limit can't
 
554
            # be nested down somewhere
 
555
            raise errors.BzrCommandError('Start revision not found in'
 
556
                ' history of end revision.')
 
557
 
 
558
    # A log including nested merges is required. If the direction is reverse,
 
559
    # we rebase the initial merge depths so that the development line is
 
560
    # shown naturally, i.e. just like it is for linear logging. We can easily
 
561
    # make forward the exact opposite display, but showing the merge revisions
 
562
    # indented at the end seems slightly nicer in that case.
 
563
    view_revisions = chain(iter(initial_revisions),
 
564
        _graph_view_revisions(branch, start_rev_id, end_rev_id,
 
565
        rebase_initial_depths=direction == 'reverse'))
212
566
    if direction == 'reverse':
213
 
        start_rev_id, end_rev_id = end_rev_id, start_rev_id
214
 
        
215
 
    legacy_lf = getattr(lf, 'log_revision', None) is None
216
 
    if legacy_lf:
217
 
        # pre-0.17 formatters use show for mainline revisions.
218
 
        # how should we show merged revisions ?
219
 
        #   pre-0.11 api: show_merge
220
 
        #   0.11-0.16 api: show_merge_revno
221
 
        show_merge_revno = getattr(lf, 'show_merge_revno', None)
222
 
        show_merge = getattr(lf, 'show_merge', None)
223
 
        if show_merge is None and show_merge_revno is None:
224
 
            # no merged-revno support
225
 
            generate_merge_revisions = False
226
 
        else:
227
 
            generate_merge_revisions = True
228
 
        # tell developers to update their code
229
 
        symbol_versioning.warn('LogFormatters should provide log_revision '
230
 
            'instead of show and show_merge_revno since bzr 0.17.',
231
 
            DeprecationWarning, stacklevel=3)
232
 
    else:
233
 
        generate_merge_revisions = getattr(lf, 'supports_merge_revisions', 
234
 
                                           False)
235
 
    view_revs_iter = get_view_revisions(mainline_revs, rev_nos, branch,
236
 
                          direction, include_merges=generate_merge_revisions)
237
 
    view_revisions = _filter_revision_range(list(view_revs_iter),
238
 
                                            start_rev_id,
239
 
                                            end_rev_id)
 
567
        return view_revisions
 
568
    elif direction == 'forward':
 
569
        # Forward means oldest first, adjusting for depth.
 
570
        view_revisions = reverse_by_depth(list(view_revisions))
 
571
        return _rebase_merge_depth(view_revisions)
 
572
    else:
 
573
        raise ValueError('invalid direction %r' % direction)
 
574
 
 
575
 
 
576
def _has_merges(branch, rev_id):
 
577
    """Does a revision have multiple parents or not?"""
 
578
    parents = branch.repository.get_parent_map([rev_id]).get(rev_id, [])
 
579
    return len(parents) > 1
 
580
 
 
581
 
 
582
def _is_obvious_ancestor(branch, start_rev_id, end_rev_id):
 
583
    """Is start_rev_id an obvious ancestor of end_rev_id?"""
 
584
    if start_rev_id and end_rev_id:
 
585
        start_dotted = branch.revision_id_to_dotted_revno(start_rev_id)
 
586
        end_dotted = branch.revision_id_to_dotted_revno(end_rev_id)
 
587
        if len(start_dotted) == 1 and len(end_dotted) == 1:
 
588
            # both on mainline
 
589
            return start_dotted[0] <= end_dotted[0]
 
590
        elif (len(start_dotted) == 3 and len(end_dotted) == 3 and
 
591
            start_dotted[0:1] == end_dotted[0:1]):
 
592
            # both on same development line
 
593
            return start_dotted[2] <= end_dotted[2]
 
594
        else:
 
595
            # not obvious
 
596
            return False
 
597
    return True
 
598
 
 
599
 
 
600
def _linear_view_revisions(branch, start_rev_id, end_rev_id):
 
601
    """Calculate a sequence of revisions to view, newest to oldest.
 
602
 
 
603
    :param start_rev_id: the lower revision-id
 
604
    :param end_rev_id: the upper revision-id
 
605
    :return: An iterator of (revision_id, dotted_revno, merge_depth) tuples.
 
606
    :raises _StartNotLinearAncestor: if a start_rev_id is specified but
 
607
      is not found walking the left-hand history
 
608
    """
 
609
    br_revno, br_rev_id = branch.last_revision_info()
 
610
    repo = branch.repository
 
611
    if start_rev_id is None and end_rev_id is None:
 
612
        cur_revno = br_revno
 
613
        for revision_id in repo.iter_reverse_revision_history(br_rev_id):
 
614
            yield revision_id, str(cur_revno), 0
 
615
            cur_revno -= 1
 
616
    else:
 
617
        if end_rev_id is None:
 
618
            end_rev_id = br_rev_id
 
619
        found_start = start_rev_id is None
 
620
        for revision_id in repo.iter_reverse_revision_history(end_rev_id):
 
621
            revno = branch.revision_id_to_dotted_revno(revision_id)
 
622
            revno_str = '.'.join(str(n) for n in revno)
 
623
            if not found_start and revision_id == start_rev_id:
 
624
                yield revision_id, revno_str, 0
 
625
                found_start = True
 
626
                break
 
627
            else:
 
628
                yield revision_id, revno_str, 0
 
629
        else:
 
630
            if not found_start:
 
631
                raise _StartNotLinearAncestor()
 
632
 
 
633
 
 
634
def _graph_view_revisions(branch, start_rev_id, end_rev_id,
 
635
    rebase_initial_depths=True):
 
636
    """Calculate revisions to view including merges, newest to oldest.
 
637
 
 
638
    :param branch: the branch
 
639
    :param start_rev_id: the lower revision-id
 
640
    :param end_rev_id: the upper revision-id
 
641
    :param rebase_initial_depth: should depths be rebased until a mainline
 
642
      revision is found?
 
643
    :return: An iterator of (revision_id, dotted_revno, merge_depth) tuples.
 
644
    """
 
645
    view_revisions = branch.iter_merge_sorted_revisions(
 
646
        start_revision_id=end_rev_id, stop_revision_id=start_rev_id,
 
647
        stop_rule="with-merges")
 
648
    if not rebase_initial_depths:
 
649
        for (rev_id, merge_depth, revno, end_of_merge
 
650
             ) in view_revisions:
 
651
            yield rev_id, '.'.join(map(str, revno)), merge_depth
 
652
    else:
 
653
        # We're following a development line starting at a merged revision.
 
654
        # We need to adjust depths down by the initial depth until we find
 
655
        # a depth less than it. Then we use that depth as the adjustment.
 
656
        # If and when we reach the mainline, depth adjustment ends.
 
657
        depth_adjustment = None
 
658
        for (rev_id, merge_depth, revno, end_of_merge
 
659
             ) in view_revisions:
 
660
            if depth_adjustment is None:
 
661
                depth_adjustment = merge_depth
 
662
            if depth_adjustment:
 
663
                if merge_depth < depth_adjustment:
 
664
                    depth_adjustment = merge_depth
 
665
                merge_depth -= depth_adjustment
 
666
            yield rev_id, '.'.join(map(str, revno)), merge_depth
 
667
 
 
668
 
 
669
def calculate_view_revisions(branch, start_revision, end_revision, direction,
 
670
        specific_fileid, generate_merge_revisions):
 
671
    """Calculate the revisions to view.
 
672
 
 
673
    :return: An iterator of (revision_id, dotted_revno, merge_depth) tuples OR
 
674
             a list of the same tuples.
 
675
    """
 
676
    # This method is no longer called by the main code path.
 
677
    # It is retained for API compatibility and may be deprecated
 
678
    # soon. IGC 20090116
 
679
    start_rev_id, end_rev_id = _get_revision_limits(branch, start_revision,
 
680
        end_revision)
 
681
    view_revisions = list(_calc_view_revisions(branch, start_rev_id, end_rev_id,
 
682
        direction, generate_merge_revisions or specific_fileid))
240
683
    if specific_fileid:
241
684
        view_revisions = _filter_revisions_touching_file_id(branch,
242
 
                                                         specific_fileid,
243
 
                                                         mainline_revs,
244
 
                                                         view_revisions)
245
 
 
246
 
    # rebase merge_depth - unless there are no revisions or 
247
 
    # either the first or last revision have merge_depth = 0.
 
685
            specific_fileid, view_revisions,
 
686
            include_merges=generate_merge_revisions)
 
687
    return _rebase_merge_depth(view_revisions)
 
688
 
 
689
 
 
690
def _rebase_merge_depth(view_revisions):
 
691
    """Adjust depths upwards so the top level is 0."""
 
692
    # If either the first or last revision have a merge_depth of 0, we're done
248
693
    if view_revisions and view_revisions[0][2] and view_revisions[-1][2]:
249
694
        min_depth = min([d for r,n,d in view_revisions])
250
695
        if min_depth != 0:
251
696
            view_revisions = [(r,n,d-min_depth) for r,n,d in view_revisions]
252
 
        
253
 
    rev_tag_dict = {}
254
 
    generate_tags = getattr(lf, 'supports_tags', False)
255
 
    if generate_tags:
256
 
        if branch.supports_tags():
257
 
            rev_tag_dict = branch.tags.get_reverse_tag_dict()
258
 
 
259
 
    generate_delta = verbose and getattr(lf, 'supports_delta', False)
260
 
 
261
 
    def iter_revisions():
262
 
        # r = revision, n = revno, d = merge depth
263
 
        revision_ids = [r for r, n, d in view_revisions]
264
 
        num = 9
265
 
        repository = branch.repository
266
 
        while revision_ids:
267
 
            cur_deltas = {}
268
 
            revisions = repository.get_revisions(revision_ids[:num])
269
 
            if generate_delta:
270
 
                deltas = repository.get_deltas_for_revisions(revisions)
271
 
                cur_deltas = dict(izip((r.revision_id for r in revisions),
272
 
                                       deltas))
273
 
            for revision in revisions:
274
 
                yield revision, cur_deltas.get(revision.revision_id)
275
 
            revision_ids  = revision_ids[num:]
 
697
    return view_revisions
 
698
 
 
699
 
 
700
def make_log_rev_iterator(branch, view_revisions, generate_delta, search,
 
701
        file_ids=None, direction='reverse'):
 
702
    """Create a revision iterator for log.
 
703
 
 
704
    :param branch: The branch being logged.
 
705
    :param view_revisions: The revisions being viewed.
 
706
    :param generate_delta: Whether to generate a delta for each revision.
 
707
      Permitted values are None, 'full' and 'partial'.
 
708
    :param search: A user text search string.
 
709
    :param file_ids: If non empty, only revisions matching one or more of
 
710
      the file-ids are to be kept.
 
711
    :param direction: the direction in which view_revisions is sorted
 
712
    :return: An iterator over lists of ((rev_id, revno, merge_depth), rev,
 
713
        delta).
 
714
    """
 
715
    # Convert view_revisions into (view, None, None) groups to fit with
 
716
    # the standard interface here.
 
717
    if type(view_revisions) == list:
 
718
        # A single batch conversion is faster than many incremental ones.
 
719
        # As we have all the data, do a batch conversion.
 
720
        nones = [None] * len(view_revisions)
 
721
        log_rev_iterator = iter([zip(view_revisions, nones, nones)])
 
722
    else:
 
723
        def _convert():
 
724
            for view in view_revisions:
 
725
                yield (view, None, None)
 
726
        log_rev_iterator = iter([_convert()])
 
727
    for adapter in log_adapters:
 
728
        # It would be nicer if log adapters were first class objects
 
729
        # with custom parameters. This will do for now. IGC 20090127
 
730
        if adapter == _make_delta_filter:
 
731
            log_rev_iterator = adapter(branch, generate_delta,
 
732
                search, log_rev_iterator, file_ids, direction)
 
733
        else:
 
734
            log_rev_iterator = adapter(branch, generate_delta,
 
735
                search, log_rev_iterator)
 
736
    return log_rev_iterator
 
737
 
 
738
 
 
739
def _make_search_filter(branch, generate_delta, search, log_rev_iterator):
 
740
    """Create a filtered iterator of log_rev_iterator matching on a regex.
 
741
 
 
742
    :param branch: The branch being logged.
 
743
    :param generate_delta: Whether to generate a delta for each revision.
 
744
    :param search: A user text search string.
 
745
    :param log_rev_iterator: An input iterator containing all revisions that
 
746
        could be displayed, in lists.
 
747
    :return: An iterator over lists of ((rev_id, revno, merge_depth), rev,
 
748
        delta).
 
749
    """
 
750
    if search is None:
 
751
        return log_rev_iterator
 
752
    searchRE = re_compile_checked(search, re.IGNORECASE,
 
753
            'log message filter')
 
754
    return _filter_message_re(searchRE, log_rev_iterator)
 
755
 
 
756
 
 
757
def _filter_message_re(searchRE, log_rev_iterator):
 
758
    for revs in log_rev_iterator:
 
759
        new_revs = []
 
760
        for (rev_id, revno, merge_depth), rev, delta in revs:
 
761
            if searchRE.search(rev.message):
 
762
                new_revs.append(((rev_id, revno, merge_depth), rev, delta))
 
763
        yield new_revs
 
764
 
 
765
 
 
766
def _make_delta_filter(branch, generate_delta, search, log_rev_iterator,
 
767
    fileids=None, direction='reverse'):
 
768
    """Add revision deltas to a log iterator if needed.
 
769
 
 
770
    :param branch: The branch being logged.
 
771
    :param generate_delta: Whether to generate a delta for each revision.
 
772
      Permitted values are None, 'full' and 'partial'.
 
773
    :param search: A user text search string.
 
774
    :param log_rev_iterator: An input iterator containing all revisions that
 
775
        could be displayed, in lists.
 
776
    :param fileids: If non empty, only revisions matching one or more of
 
777
      the file-ids are to be kept.
 
778
    :param direction: the direction in which view_revisions is sorted
 
779
    :return: An iterator over lists of ((rev_id, revno, merge_depth), rev,
 
780
        delta).
 
781
    """
 
782
    if not generate_delta and not fileids:
 
783
        return log_rev_iterator
 
784
    return _generate_deltas(branch.repository, log_rev_iterator,
 
785
        generate_delta, fileids, direction)
 
786
 
 
787
 
 
788
def _generate_deltas(repository, log_rev_iterator, delta_type, fileids,
 
789
    direction):
 
790
    """Create deltas for each batch of revisions in log_rev_iterator.
 
791
 
 
792
    If we're only generating deltas for the sake of filtering against
 
793
    file-ids, we stop generating deltas once all file-ids reach the
 
794
    appropriate life-cycle point. If we're receiving data newest to
 
795
    oldest, then that life-cycle point is 'add', otherwise it's 'remove'.
 
796
    """
 
797
    check_fileids = fileids is not None and len(fileids) > 0
 
798
    if check_fileids:
 
799
        fileid_set = set(fileids)
 
800
        if direction == 'reverse':
 
801
            stop_on = 'add'
 
802
        else:
 
803
            stop_on = 'remove'
 
804
    else:
 
805
        fileid_set = None
 
806
    for revs in log_rev_iterator:
 
807
        # If we were matching against fileids and we've run out,
 
808
        # there's nothing left to do
 
809
        if check_fileids and not fileid_set:
 
810
            return
 
811
        revisions = [rev[1] for rev in revs]
 
812
        new_revs = []
 
813
        if delta_type == 'full' and not check_fileids:
 
814
            deltas = repository.get_deltas_for_revisions(revisions)
 
815
            for rev, delta in izip(revs, deltas):
 
816
                new_revs.append((rev[0], rev[1], delta))
 
817
        else:
 
818
            deltas = repository.get_deltas_for_revisions(revisions, fileid_set)
 
819
            for rev, delta in izip(revs, deltas):
 
820
                if check_fileids:
 
821
                    if delta is None or not delta.has_changed():
 
822
                        continue
 
823
                    else:
 
824
                        _update_fileids(delta, fileid_set, stop_on)
 
825
                        if delta_type is None:
 
826
                            delta = None
 
827
                        elif delta_type == 'full':
 
828
                            # If the file matches all the time, rebuilding
 
829
                            # a full delta like this in addition to a partial
 
830
                            # one could be slow. However, it's likely that
 
831
                            # most revisions won't get this far, making it
 
832
                            # faster to filter on the partial deltas and
 
833
                            # build the occasional full delta than always
 
834
                            # building full deltas and filtering those.
 
835
                            rev_id = rev[0][0]
 
836
                            delta = repository.get_revision_delta(rev_id)
 
837
                new_revs.append((rev[0], rev[1], delta))
 
838
        yield new_revs
 
839
 
 
840
 
 
841
def _update_fileids(delta, fileids, stop_on):
 
842
    """Update the set of file-ids to search based on file lifecycle events.
 
843
    
 
844
    :param fileids: a set of fileids to update
 
845
    :param stop_on: either 'add' or 'remove' - take file-ids out of the
 
846
      fileids set once their add or remove entry is detected respectively
 
847
    """
 
848
    if stop_on == 'add':
 
849
        for item in delta.added:
 
850
            if item[1] in fileids:
 
851
                fileids.remove(item[1])
 
852
    elif stop_on == 'delete':
 
853
        for item in delta.removed:
 
854
            if item[1] in fileids:
 
855
                fileids.remove(item[1])
 
856
 
 
857
 
 
858
def _make_revision_objects(branch, generate_delta, search, log_rev_iterator):
 
859
    """Extract revision objects from the repository
 
860
 
 
861
    :param branch: The branch being logged.
 
862
    :param generate_delta: Whether to generate a delta for each revision.
 
863
    :param search: A user text search string.
 
864
    :param log_rev_iterator: An input iterator containing all revisions that
 
865
        could be displayed, in lists.
 
866
    :return: An iterator over lists of ((rev_id, revno, merge_depth), rev,
 
867
        delta).
 
868
    """
 
869
    repository = branch.repository
 
870
    for revs in log_rev_iterator:
 
871
        # r = revision_id, n = revno, d = merge depth
 
872
        revision_ids = [view[0] for view, _, _ in revs]
 
873
        revisions = repository.get_revisions(revision_ids)
 
874
        revs = [(rev[0], revision, rev[2]) for rev, revision in
 
875
            izip(revs, revisions)]
 
876
        yield revs
 
877
 
 
878
 
 
879
def _make_batch_filter(branch, generate_delta, search, log_rev_iterator):
 
880
    """Group up a single large batch into smaller ones.
 
881
 
 
882
    :param branch: The branch being logged.
 
883
    :param generate_delta: Whether to generate a delta for each revision.
 
884
    :param search: A user text search string.
 
885
    :param log_rev_iterator: An input iterator containing all revisions that
 
886
        could be displayed, in lists.
 
887
    :return: An iterator over lists of ((rev_id, revno, merge_depth), rev,
 
888
        delta).
 
889
    """
 
890
    repository = branch.repository
 
891
    num = 9
 
892
    for batch in log_rev_iterator:
 
893
        batch = iter(batch)
 
894
        while True:
 
895
            step = [detail for _, detail in zip(range(num), batch)]
 
896
            if len(step) == 0:
 
897
                break
 
898
            yield step
276
899
            num = min(int(num * 1.5), 200)
277
900
 
278
 
    # now we just print all the revisions
279
 
    log_count = 0
280
 
    for ((rev_id, revno, merge_depth), (rev, delta)) in \
281
 
         izip(view_revisions, iter_revisions()):
282
 
 
283
 
        if searchRE:
284
 
            if not searchRE.search(rev.message):
285
 
                continue
286
 
 
287
 
        if not legacy_lf:
288
 
            lr = LogRevision(rev, revno, merge_depth, delta,
289
 
                             rev_tag_dict.get(rev_id))
290
 
            lf.log_revision(lr)
291
 
        else:
292
 
            # support for legacy (pre-0.17) LogFormatters
293
 
            if merge_depth == 0:
294
 
                if generate_tags:
295
 
                    lf.show(revno, rev, delta, rev_tag_dict.get(rev_id))
296
 
                else:
297
 
                    lf.show(revno, rev, delta)
298
 
            else:
299
 
                if show_merge_revno is None:
300
 
                    lf.show_merge(rev, merge_depth)
301
 
                else:
302
 
                    if generate_tags:
303
 
                        lf.show_merge_revno(rev, merge_depth, revno,
304
 
                                            rev_tag_dict.get(rev_id))
305
 
                    else:
306
 
                        lf.show_merge_revno(rev, merge_depth, revno)
307
 
        if limit:
308
 
            log_count += 1
309
 
            if log_count >= limit:
310
 
                break
 
901
 
 
902
def _get_revision_limits(branch, start_revision, end_revision):
 
903
    """Get and check revision limits.
 
904
 
 
905
    :param  branch: The branch containing the revisions.
 
906
 
 
907
    :param  start_revision: The first revision to be logged.
 
908
            For backwards compatibility this may be a mainline integer revno,
 
909
            but for merge revision support a RevisionInfo is expected.
 
910
 
 
911
    :param  end_revision: The last revision to be logged.
 
912
            For backwards compatibility this may be a mainline integer revno,
 
913
            but for merge revision support a RevisionInfo is expected.
 
914
 
 
915
    :return: (start_rev_id, end_rev_id) tuple.
 
916
    """
 
917
    branch_revno, branch_rev_id = branch.last_revision_info()
 
918
    start_rev_id = None
 
919
    if start_revision is None:
 
920
        start_revno = 1
 
921
    else:
 
922
        if isinstance(start_revision, revisionspec.RevisionInfo):
 
923
            start_rev_id = start_revision.rev_id
 
924
            start_revno = start_revision.revno or 1
 
925
        else:
 
926
            branch.check_real_revno(start_revision)
 
927
            start_revno = start_revision
 
928
            start_rev_id = branch.get_rev_id(start_revno)
 
929
 
 
930
    end_rev_id = None
 
931
    if end_revision is None:
 
932
        end_revno = branch_revno
 
933
    else:
 
934
        if isinstance(end_revision, revisionspec.RevisionInfo):
 
935
            end_rev_id = end_revision.rev_id
 
936
            end_revno = end_revision.revno or branch_revno
 
937
        else:
 
938
            branch.check_real_revno(end_revision)
 
939
            end_revno = end_revision
 
940
            end_rev_id = branch.get_rev_id(end_revno)
 
941
 
 
942
    if branch_revno != 0:
 
943
        if (start_rev_id == _mod_revision.NULL_REVISION
 
944
            or end_rev_id == _mod_revision.NULL_REVISION):
 
945
            raise errors.BzrCommandError('Logging revision 0 is invalid.')
 
946
        if start_revno > end_revno:
 
947
            raise errors.BzrCommandError("Start revision must be older than "
 
948
                                         "the end revision.")
 
949
    return (start_rev_id, end_rev_id)
311
950
 
312
951
 
313
952
def _get_mainline_revs(branch, start_revision, end_revision):
314
953
    """Get the mainline revisions from the branch.
315
 
    
 
954
 
316
955
    Generates the list of mainline revisions for the branch.
317
 
    
318
 
    :param  branch: The branch containing the revisions. 
 
956
 
 
957
    :param  branch: The branch containing the revisions.
319
958
 
320
959
    :param  start_revision: The first revision to be logged.
321
960
            For backwards compatibility this may be a mainline integer revno,
327
966
 
328
967
    :return: A (mainline_revs, rev_nos, start_rev_id, end_rev_id) tuple.
329
968
    """
330
 
    which_revs = _enumerate_history(branch)
331
 
    if not which_revs:
 
969
    branch_revno, branch_last_revision = branch.last_revision_info()
 
970
    if branch_revno == 0:
332
971
        return None, None, None, None
333
972
 
334
 
    # For mainline generation, map start_revision and end_revision to 
335
 
    # mainline revnos. If the revision is not on the mainline choose the 
336
 
    # appropriate extreme of the mainline instead - the extra will be 
 
973
    # For mainline generation, map start_revision and end_revision to
 
974
    # mainline revnos. If the revision is not on the mainline choose the
 
975
    # appropriate extreme of the mainline instead - the extra will be
337
976
    # filtered later.
338
977
    # Also map the revisions to rev_ids, to be used in the later filtering
339
978
    # stage.
340
 
    start_rev_id = None 
 
979
    start_rev_id = None
341
980
    if start_revision is None:
342
981
        start_revno = 1
343
982
    else:
344
 
        if isinstance(start_revision,RevisionInfo):
 
983
        if isinstance(start_revision, revisionspec.RevisionInfo):
345
984
            start_rev_id = start_revision.rev_id
346
985
            start_revno = start_revision.revno or 1
347
986
        else:
348
987
            branch.check_real_revno(start_revision)
349
988
            start_revno = start_revision
350
 
    
 
989
 
351
990
    end_rev_id = None
352
991
    if end_revision is None:
353
 
        end_revno = len(which_revs)
 
992
        end_revno = branch_revno
354
993
    else:
355
 
        if isinstance(end_revision,RevisionInfo):
 
994
        if isinstance(end_revision, revisionspec.RevisionInfo):
356
995
            end_rev_id = end_revision.rev_id
357
 
            end_revno = end_revision.revno or len(which_revs)
 
996
            end_revno = end_revision.revno or branch_revno
358
997
        else:
359
998
            branch.check_real_revno(end_revision)
360
999
            end_revno = end_revision
361
1000
 
 
1001
    if ((start_rev_id == _mod_revision.NULL_REVISION)
 
1002
        or (end_rev_id == _mod_revision.NULL_REVISION)):
 
1003
        raise errors.BzrCommandError('Logging revision 0 is invalid.')
362
1004
    if start_revno > end_revno:
363
 
        from bzrlib.errors import BzrCommandError
364
 
        raise BzrCommandError("Start revision must be older than "
365
 
                              "the end revision.")
 
1005
        raise errors.BzrCommandError("Start revision must be older than "
 
1006
                                     "the end revision.")
366
1007
 
367
 
    # list indexes are 0-based; revisions are 1-based
368
 
    cut_revs = which_revs[(start_revno-1):(end_revno)]
369
 
    if not cut_revs:
 
1008
    if end_revno < start_revno:
370
1009
        return None, None, None, None
 
1010
    cur_revno = branch_revno
 
1011
    rev_nos = {}
 
1012
    mainline_revs = []
 
1013
    for revision_id in branch.repository.iter_reverse_revision_history(
 
1014
                        branch_last_revision):
 
1015
        if cur_revno < start_revno:
 
1016
            # We have gone far enough, but we always add 1 more revision
 
1017
            rev_nos[revision_id] = cur_revno
 
1018
            mainline_revs.append(revision_id)
 
1019
            break
 
1020
        if cur_revno <= end_revno:
 
1021
            rev_nos[revision_id] = cur_revno
 
1022
            mainline_revs.append(revision_id)
 
1023
        cur_revno -= 1
 
1024
    else:
 
1025
        # We walked off the edge of all revisions, so we add a 'None' marker
 
1026
        mainline_revs.append(None)
371
1027
 
372
 
    # convert the revision history to a dictionary:
373
 
    rev_nos = dict((k, v) for v, k in cut_revs)
 
1028
    mainline_revs.reverse()
374
1029
 
375
1030
    # override the mainline to look like the revision history.
376
 
    mainline_revs = [revision_id for index, revision_id in cut_revs]
377
 
    if cut_revs[0][0] == 1:
378
 
        mainline_revs.insert(0, None)
379
 
    else:
380
 
        mainline_revs.insert(0, which_revs[start_revno-2][1])
381
1031
    return mainline_revs, rev_nos, start_rev_id, end_rev_id
382
1032
 
383
1033
 
384
1034
def _filter_revision_range(view_revisions, start_rev_id, end_rev_id):
385
1035
    """Filter view_revisions based on revision ranges.
386
1036
 
387
 
    :param view_revisions: A list of (revision_id, dotted_revno, merge_depth) 
 
1037
    :param view_revisions: A list of (revision_id, dotted_revno, merge_depth)
388
1038
            tuples to be filtered.
389
1039
 
390
1040
    :param start_rev_id: If not NONE specifies the first revision to be logged.
395
1045
 
396
1046
    :return: The filtered view_revisions.
397
1047
    """
398
 
    if start_rev_id or end_rev_id: 
 
1048
    # This method is no longer called by the main code path.
 
1049
    # It may be removed soon. IGC 20090127
 
1050
    if start_rev_id or end_rev_id:
399
1051
        revision_ids = [r for r, n, d in view_revisions]
400
1052
        if start_rev_id:
401
1053
            start_index = revision_ids.index(start_rev_id)
408
1060
                end_index = revision_ids.index(end_rev_id)
409
1061
            else:
410
1062
                end_index = len(view_revisions) - 1
411
 
        # To include the revisions merged into the last revision, 
 
1063
        # To include the revisions merged into the last revision,
412
1064
        # extend end_rev_id down to, but not including, the next rev
413
1065
        # with the same or lesser merge_depth
414
1066
        end_merge_depth = view_revisions[end_index][2]
424
1076
    return view_revisions
425
1077
 
426
1078
 
427
 
def _filter_revisions_touching_file_id(branch, file_id, mainline_revisions,
428
 
                                       view_revs_iter):
429
 
    """Return the list of revision ids which touch a given file id.
 
1079
def _filter_revisions_touching_file_id(branch, file_id, view_revisions,
 
1080
    include_merges=True):
 
1081
    r"""Return the list of revision ids which touch a given file id.
430
1082
 
431
1083
    The function filters view_revisions and returns a subset.
432
1084
    This includes the revisions which directly change the file id,
433
1085
    and the revisions which merge these changes. So if the
434
1086
    revision graph is::
435
 
        A
436
 
        |\
437
 
        B C
 
1087
        A-.
 
1088
        |\ \
 
1089
        B C E
 
1090
        |/ /
 
1091
        D |
 
1092
        |\|
 
1093
        | F
438
1094
        |/
439
 
        D
440
 
 
441
 
    And 'C' changes a file, then both C and D will be returned.
442
 
 
443
 
    This will also can be restricted based on a subset of the mainline.
 
1095
        G
 
1096
 
 
1097
    And 'C' changes a file, then both C and D will be returned. F will not be
 
1098
    returned even though it brings the changes to C into the branch starting
 
1099
    with E. (Note that if we were using F as the tip instead of G, then we
 
1100
    would see C, D, F.)
 
1101
 
 
1102
    This will also be restricted based on a subset of the mainline.
 
1103
 
 
1104
    :param branch: The branch where we can get text revision information.
 
1105
 
 
1106
    :param file_id: Filter out revisions that do not touch file_id.
 
1107
 
 
1108
    :param view_revisions: A list of (revision_id, dotted_revno, merge_depth)
 
1109
        tuples. This is the list of revisions which will be filtered. It is
 
1110
        assumed that view_revisions is in merge_sort order (i.e. newest
 
1111
        revision first ).
 
1112
 
 
1113
    :param include_merges: include merge revisions in the result or not
444
1114
 
445
1115
    :return: A list of (revision_id, dotted_revno, merge_depth) tuples.
446
1116
    """
447
 
    # find all the revisions that change the specific file
448
 
    file_weave = branch.repository.weave_store.get_weave(file_id,
449
 
                branch.repository.get_transaction())
450
 
    weave_modifed_revisions = set(file_weave.versions())
451
 
    # build the ancestry of each revision in the graph
452
 
    # - only listing the ancestors that change the specific file.
453
 
    rev_graph = branch.repository.get_revision_graph(mainline_revisions[-1])
454
 
    sorted_rev_list = topo_sort(rev_graph)
455
 
    ancestry = {}
456
 
    for rev in sorted_rev_list:
457
 
        parents = rev_graph[rev]
458
 
        if rev not in weave_modifed_revisions and len(parents) == 1:
459
 
            # We will not be adding anything new, so just use a reference to
460
 
            # the parent ancestry.
461
 
            rev_ancestry = ancestry[parents[0]]
 
1117
    # Lookup all possible text keys to determine which ones actually modified
 
1118
    # the file.
 
1119
    text_keys = [(file_id, rev_id) for rev_id, revno, depth in view_revisions]
 
1120
    next_keys = None
 
1121
    # Looking up keys in batches of 1000 can cut the time in half, as well as
 
1122
    # memory consumption. GraphIndex *does* like to look for a few keys in
 
1123
    # parallel, it just doesn't like looking for *lots* of keys in parallel.
 
1124
    # TODO: This code needs to be re-evaluated periodically as we tune the
 
1125
    #       indexing layer. We might consider passing in hints as to the known
 
1126
    #       access pattern (sparse/clustered, high success rate/low success
 
1127
    #       rate). This particular access is clustered with a low success rate.
 
1128
    get_parent_map = branch.repository.texts.get_parent_map
 
1129
    modified_text_revisions = set()
 
1130
    chunk_size = 1000
 
1131
    for start in xrange(0, len(text_keys), chunk_size):
 
1132
        next_keys = text_keys[start:start + chunk_size]
 
1133
        # Only keep the revision_id portion of the key
 
1134
        modified_text_revisions.update(
 
1135
            [k[1] for k in get_parent_map(next_keys)])
 
1136
    del text_keys, next_keys
 
1137
 
 
1138
    result = []
 
1139
    # Track what revisions will merge the current revision, replace entries
 
1140
    # with 'None' when they have been added to result
 
1141
    current_merge_stack = [None]
 
1142
    for info in view_revisions:
 
1143
        rev_id, revno, depth = info
 
1144
        if depth == len(current_merge_stack):
 
1145
            current_merge_stack.append(info)
462
1146
        else:
463
 
            rev_ancestry = set()
464
 
            if rev in weave_modifed_revisions:
465
 
                rev_ancestry.add(rev)
466
 
            for parent in parents:
467
 
                rev_ancestry = rev_ancestry.union(ancestry[parent])
468
 
        ancestry[rev] = rev_ancestry
469
 
 
470
 
    def is_merging_rev(r):
471
 
        parents = rev_graph[r]
472
 
        if len(parents) > 1:
473
 
            leftparent = parents[0]
474
 
            for rightparent in parents[1:]:
475
 
                if not ancestry[leftparent].issuperset(
476
 
                        ancestry[rightparent]):
477
 
                    return True
478
 
        return False
479
 
 
480
 
    # filter from the view the revisions that did not change or merge 
481
 
    # the specific file
482
 
    return [(r, n, d) for r, n, d in view_revs_iter
483
 
            if r in weave_modifed_revisions or is_merging_rev(r)]
 
1147
            del current_merge_stack[depth + 1:]
 
1148
            current_merge_stack[-1] = info
 
1149
 
 
1150
        if rev_id in modified_text_revisions:
 
1151
            # This needs to be logged, along with the extra revisions
 
1152
            for idx in xrange(len(current_merge_stack)):
 
1153
                node = current_merge_stack[idx]
 
1154
                if node is not None:
 
1155
                    if include_merges or node[2] == 0:
 
1156
                        result.append(node)
 
1157
                        current_merge_stack[idx] = None
 
1158
    return result
484
1159
 
485
1160
 
486
1161
def get_view_revisions(mainline_revs, rev_nos, branch, direction,
489
1164
    :return: an iterator of (revision_id, revno, merge_depth)
490
1165
    (if there is no revno for a revision, None is supplied)
491
1166
    """
492
 
    if include_merges is False:
 
1167
    # This method is no longer called by the main code path.
 
1168
    # It is retained for API compatibility and may be deprecated
 
1169
    # soon. IGC 20090127
 
1170
    if not include_merges:
493
1171
        revision_ids = mainline_revs[1:]
494
1172
        if direction == 'reverse':
495
1173
            revision_ids.reverse()
496
1174
        for revision_id in revision_ids:
497
1175
            yield revision_id, str(rev_nos[revision_id]), 0
498
1176
        return
499
 
    merge_sorted_revisions = merge_sort(
500
 
        branch.repository.get_revision_graph(mainline_revs[-1]),
 
1177
    graph = branch.repository.get_graph()
 
1178
    # This asks for all mainline revisions, which means we only have to spider
 
1179
    # sideways, rather than depth history. That said, its still size-of-history
 
1180
    # and should be addressed.
 
1181
    # mainline_revisions always includes an extra revision at the beginning, so
 
1182
    # don't request it.
 
1183
    parent_map = dict(((key, value) for key, value in
 
1184
        graph.iter_ancestry(mainline_revs[1:]) if value is not None))
 
1185
    # filter out ghosts; merge_sort errors on ghosts.
 
1186
    rev_graph = _mod_repository._strip_NULL_ghosts(parent_map)
 
1187
    merge_sorted_revisions = tsort.merge_sort(
 
1188
        rev_graph,
501
1189
        mainline_revs[-1],
502
1190
        mainline_revs,
503
1191
        generate_revno=True)
508
1196
    elif direction != 'reverse':
509
1197
        raise ValueError('invalid direction %r' % direction)
510
1198
 
511
 
    for sequence, rev_id, merge_depth, revno, end_of_merge in merge_sorted_revisions:
 
1199
    for (sequence, rev_id, merge_depth, revno, end_of_merge
 
1200
         ) in merge_sorted_revisions:
512
1201
        yield rev_id, '.'.join(map(str, revno)), merge_depth
513
1202
 
514
1203
 
519
1208
    revision of that depth.  There may be no topological justification for this,
520
1209
    but it looks much nicer.
521
1210
    """
 
1211
    # Add a fake revision at start so that we can always attach sub revisions
 
1212
    merge_sorted_revisions = [(None, None, _depth)] + merge_sorted_revisions
522
1213
    zd_revisions = []
523
1214
    for val in merge_sorted_revisions:
524
1215
        if val[2] == _depth:
 
1216
            # Each revision at the current depth becomes a chunk grouping all
 
1217
            # higher depth revisions.
525
1218
            zd_revisions.append([val])
526
1219
        else:
527
 
            assert val[2] > _depth
528
1220
            zd_revisions[-1].append(val)
529
1221
    for revisions in zd_revisions:
530
1222
        if len(revisions) > 1:
 
1223
            # We have higher depth revisions, let reverse them locally
531
1224
            revisions[1:] = reverse_by_depth(revisions[1:], _depth + 1)
532
1225
    zd_revisions.reverse()
533
1226
    result = []
534
1227
    for chunk in zd_revisions:
535
1228
        result.extend(chunk)
 
1229
    if _depth == 0:
 
1230
        # Top level call, get rid of the fake revisions that have been added
 
1231
        result = [r for r in result if r[0] is not None and r[1] is not None]
536
1232
    return result
537
1233
 
538
1234
 
540
1236
    """A revision to be logged (by LogFormatter.log_revision).
541
1237
 
542
1238
    A simple wrapper for the attributes of a revision to be logged.
543
 
    The attributes may or may not be populated, as determined by the 
 
1239
    The attributes may or may not be populated, as determined by the
544
1240
    logging options and the log formatter capabilities.
545
1241
    """
546
1242
 
547
1243
    def __init__(self, rev=None, revno=None, merge_depth=0, delta=None,
548
 
                 tags=None):
 
1244
                 tags=None, diff=None):
549
1245
        self.rev = rev
550
 
        self.revno = revno
 
1246
        self.revno = str(revno)
551
1247
        self.merge_depth = merge_depth
552
1248
        self.delta = delta
553
1249
        self.tags = tags
 
1250
        self.diff = diff
554
1251
 
555
1252
 
556
1253
class LogFormatter(object):
561
1258
    If the LogFormatter needs to be informed of the beginning or end of
562
1259
    a log it should implement the begin_log and/or end_log hook methods.
563
1260
 
564
 
    A LogFormatter should define the following supports_XXX flags 
 
1261
    A LogFormatter should define the following supports_XXX flags
565
1262
    to indicate which LogRevision attributes it supports:
566
1263
 
567
1264
    - supports_delta must be True if this log formatter supports delta.
568
 
        Otherwise the delta attribute may not be populated.
569
 
    - supports_merge_revisions must be True if this log formatter supports 
570
 
        merge revisions.  If not, only mainline revisions (those 
571
 
        with merge_depth == 0) will be passed to the formatter.
 
1265
        Otherwise the delta attribute may not be populated.  The 'delta_format'
 
1266
        attribute describes whether the 'short_status' format (1) or the long
 
1267
        one (2) should be used.
 
1268
 
 
1269
    - supports_merge_revisions must be True if this log formatter supports
 
1270
        merge revisions.  If not, then only mainline revisions will be passed
 
1271
        to the formatter.
 
1272
 
 
1273
    - preferred_levels is the number of levels this formatter defaults to.
 
1274
        The default value is zero meaning display all levels.
 
1275
        This value is only relevant if supports_merge_revisions is True.
 
1276
 
572
1277
    - supports_tags must be True if this log formatter supports tags.
573
1278
        Otherwise the tags attribute may not be populated.
 
1279
 
 
1280
    - supports_diff must be True if this log formatter supports diffs.
 
1281
        Otherwise the diff attribute may not be populated.
 
1282
 
 
1283
    Plugins can register functions to show custom revision properties using
 
1284
    the properties_handler_registry. The registered function
 
1285
    must respect the following interface description:
 
1286
        def my_show_properties(properties_dict):
 
1287
            # code that returns a dict {'name':'value'} of the properties
 
1288
            # to be shown
574
1289
    """
575
 
 
576
 
    def __init__(self, to_file, show_ids=False, show_timezone='original'):
 
1290
    preferred_levels = 0
 
1291
 
 
1292
    def __init__(self, to_file, show_ids=False, show_timezone='original',
 
1293
                 delta_format=None, levels=None, show_advice=False):
 
1294
        """Create a LogFormatter.
 
1295
 
 
1296
        :param to_file: the file to output to
 
1297
        :param show_ids: if True, revision-ids are to be displayed
 
1298
        :param show_timezone: the timezone to use
 
1299
        :param delta_format: the level of delta information to display
 
1300
          or None to leave it to the formatter to decide
 
1301
        :param levels: the number of levels to display; None or -1 to
 
1302
          let the log formatter decide.
 
1303
        :param show_advice: whether to show advice at the end of the
 
1304
          log or not
 
1305
        """
577
1306
        self.to_file = to_file
 
1307
        # 'exact' stream used to show diff, it should print content 'as is'
 
1308
        # and should not try to decode/encode it to unicode to avoid bug #328007
 
1309
        self.to_exact_file = getattr(to_file, 'stream', to_file)
578
1310
        self.show_ids = show_ids
579
1311
        self.show_timezone = show_timezone
580
 
 
581
 
# TODO: uncomment this block after show() has been removed.
582
 
# Until then defining log_revision would prevent _show_log calling show() 
583
 
# in legacy formatters.
584
 
#    def log_revision(self, revision):
585
 
#        """Log a revision.
586
 
#
587
 
#        :param  revision:   The LogRevision to be logged.
588
 
#        """
589
 
#        raise NotImplementedError('not implemented in abstract base')
590
 
 
591
 
    @deprecated_method(zero_seventeen)
592
 
    def show(self, revno, rev, delta):
 
1312
        if delta_format is None:
 
1313
            # Ensures backward compatibility
 
1314
            delta_format = 2 # long format
 
1315
        self.delta_format = delta_format
 
1316
        self.levels = levels
 
1317
        self._show_advice = show_advice
 
1318
        self._merge_count = 0
 
1319
 
 
1320
    def get_levels(self):
 
1321
        """Get the number of levels to display or 0 for all."""
 
1322
        if getattr(self, 'supports_merge_revisions', False):
 
1323
            if self.levels is None or self.levels == -1:
 
1324
                self.levels = self.preferred_levels
 
1325
        else:
 
1326
            self.levels = 1
 
1327
        return self.levels
 
1328
 
 
1329
    def log_revision(self, revision):
 
1330
        """Log a revision.
 
1331
 
 
1332
        :param  revision:   The LogRevision to be logged.
 
1333
        """
593
1334
        raise NotImplementedError('not implemented in abstract base')
594
1335
 
 
1336
    def show_advice(self):
 
1337
        """Output user advice, if any, when the log is completed."""
 
1338
        if self._show_advice and self.levels == 1 and self._merge_count > 0:
 
1339
            advice_sep = self.get_advice_separator()
 
1340
            if advice_sep:
 
1341
                self.to_file.write(advice_sep)
 
1342
            self.to_file.write(
 
1343
                "Use --include-merges or -n0 to see merged revisions.\n")
 
1344
 
 
1345
    def get_advice_separator(self):
 
1346
        """Get the text separating the log from the closing advice."""
 
1347
        return ''
 
1348
 
595
1349
    def short_committer(self, rev):
596
 
        return re.sub('<.*@.*>', '', rev.committer).strip(' ')
 
1350
        name, address = config.parse_username(rev.committer)
 
1351
        if name:
 
1352
            return name
 
1353
        return address
 
1354
 
 
1355
    def short_author(self, rev):
 
1356
        name, address = config.parse_username(rev.get_apparent_authors()[0])
 
1357
        if name:
 
1358
            return name
 
1359
        return address
 
1360
 
 
1361
    def merge_marker(self, revision):
 
1362
        """Get the merge marker to include in the output or '' if none."""
 
1363
        if len(revision.rev.parent_ids) > 1:
 
1364
            self._merge_count += 1
 
1365
            return ' [merge]'
 
1366
        else:
 
1367
            return ''
 
1368
 
 
1369
    def show_properties(self, revision, indent):
 
1370
        """Displays the custom properties returned by each registered handler.
 
1371
 
 
1372
        If a registered handler raises an error it is propagated.
 
1373
        """
 
1374
        for key, handler in properties_handler_registry.iteritems():
 
1375
            for key, value in handler(revision).items():
 
1376
                self.to_file.write(indent + key + ': ' + value + '\n')
 
1377
 
 
1378
    def show_diff(self, to_file, diff, indent):
 
1379
        for l in diff.rstrip().split('\n'):
 
1380
            to_file.write(indent + '%s\n' % (l,))
597
1381
 
598
1382
 
599
1383
class LongLogFormatter(LogFormatter):
600
1384
 
601
1385
    supports_merge_revisions = True
 
1386
    preferred_levels = 1
602
1387
    supports_delta = True
603
1388
    supports_tags = True
604
 
 
605
 
    @deprecated_method(zero_seventeen)
606
 
    def show(self, revno, rev, delta, tags=None):
607
 
        lr = LogRevision(rev, revno, 0, delta, tags)
608
 
        return self.log_revision(lr)
609
 
 
610
 
    @deprecated_method(zero_eleven)
611
 
    def show_merge(self, rev, merge_depth):
612
 
        lr = LogRevision(rev, merge_depth=merge_depth)
613
 
        return self.log_revision(lr)
614
 
 
615
 
    @deprecated_method(zero_seventeen)
616
 
    def show_merge_revno(self, rev, merge_depth, revno, tags=None):
617
 
        """Show a merged revision rev, with merge_depth and a revno."""
618
 
        lr = LogRevision(rev, revno, merge_depth, tags=tags)
619
 
        return self.log_revision(lr)
 
1389
    supports_diff = True
620
1390
 
621
1391
    def log_revision(self, revision):
622
1392
        """Log a revision, either merged or not."""
623
 
        from bzrlib.osutils import format_date
624
 
        indent = '    '*revision.merge_depth
 
1393
        indent = '    ' * revision.merge_depth
625
1394
        to_file = self.to_file
626
 
        print >>to_file,  indent+'-' * 60
 
1395
        to_file.write(indent + '-' * 60 + '\n')
627
1396
        if revision.revno is not None:
628
 
            print >>to_file,  indent+'revno:', revision.revno
 
1397
            to_file.write(indent + 'revno: %s%s\n' % (revision.revno,
 
1398
                self.merge_marker(revision)))
629
1399
        if revision.tags:
630
 
            print >>to_file, indent+'tags: %s' % (', '.join(revision.tags))
 
1400
            to_file.write(indent + 'tags: %s\n' % (', '.join(revision.tags)))
631
1401
        if self.show_ids:
632
 
            print >>to_file, indent+'revision-id:', revision.rev.revision_id
 
1402
            to_file.write(indent + 'revision-id: ' + revision.rev.revision_id)
 
1403
            to_file.write('\n')
633
1404
            for parent_id in revision.rev.parent_ids:
634
 
                print >>to_file, indent+'parent:', parent_id
635
 
        print >>to_file, indent+'committer:', revision.rev.committer
636
 
 
637
 
        try:
638
 
            print >>to_file, indent+'branch nick: %s' % \
639
 
                revision.rev.properties['branch-nick']
640
 
        except KeyError:
641
 
            pass
 
1405
                to_file.write(indent + 'parent: %s\n' % (parent_id,))
 
1406
        self.show_properties(revision.rev, indent)
 
1407
 
 
1408
        committer = revision.rev.committer
 
1409
        authors = revision.rev.get_apparent_authors()
 
1410
        if authors != [committer]:
 
1411
            to_file.write(indent + 'author: %s\n' % (", ".join(authors),))
 
1412
        to_file.write(indent + 'committer: %s\n' % (committer,))
 
1413
 
 
1414
        branch_nick = revision.rev.properties.get('branch-nick', None)
 
1415
        if branch_nick is not None:
 
1416
            to_file.write(indent + 'branch nick: %s\n' % (branch_nick,))
 
1417
 
642
1418
        date_str = format_date(revision.rev.timestamp,
643
1419
                               revision.rev.timezone or 0,
644
1420
                               self.show_timezone)
645
 
        print >>to_file,  indent+'timestamp: %s' % date_str
 
1421
        to_file.write(indent + 'timestamp: %s\n' % (date_str,))
646
1422
 
647
 
        print >>to_file,  indent+'message:'
 
1423
        to_file.write(indent + 'message:\n')
648
1424
        if not revision.rev.message:
649
 
            print >>to_file,  indent+'  (no message)'
 
1425
            to_file.write(indent + '  (no message)\n')
650
1426
        else:
651
1427
            message = revision.rev.message.rstrip('\r\n')
652
1428
            for l in message.split('\n'):
653
 
                print >>to_file,  indent+'  ' + l
 
1429
                to_file.write(indent + '  %s\n' % (l,))
654
1430
        if revision.delta is not None:
655
 
            revision.delta.show(to_file, self.show_ids, indent=indent)
 
1431
            # We don't respect delta_format for compatibility
 
1432
            revision.delta.show(to_file, self.show_ids, indent=indent,
 
1433
                                short_status=False)
 
1434
        if revision.diff is not None:
 
1435
            to_file.write(indent + 'diff:\n')
 
1436
            # Note: we explicitly don't indent the diff (relative to the
 
1437
            # revision information) so that the output can be fed to patch -p0
 
1438
            self.show_diff(self.to_exact_file, revision.diff, indent)
 
1439
 
 
1440
    def get_advice_separator(self):
 
1441
        """Get the text separating the log from the closing advice."""
 
1442
        return '-' * 60 + '\n'
656
1443
 
657
1444
 
658
1445
class ShortLogFormatter(LogFormatter):
659
1446
 
 
1447
    supports_merge_revisions = True
 
1448
    preferred_levels = 1
660
1449
    supports_delta = True
 
1450
    supports_tags = True
 
1451
    supports_diff = True
661
1452
 
662
 
    @deprecated_method(zero_seventeen)
663
 
    def show(self, revno, rev, delta):
664
 
        lr = LogRevision(rev, revno, 0, delta)
665
 
        return self.log_revision(lr)
 
1453
    def __init__(self, *args, **kwargs):
 
1454
        super(ShortLogFormatter, self).__init__(*args, **kwargs)
 
1455
        self.revno_width_by_depth = {}
666
1456
 
667
1457
    def log_revision(self, revision):
668
 
        from bzrlib.osutils import format_date
 
1458
        # We need two indents: one per depth and one for the information
 
1459
        # relative to that indent. Most mainline revnos are 5 chars or
 
1460
        # less while dotted revnos are typically 11 chars or less. Once
 
1461
        # calculated, we need to remember the offset for a given depth
 
1462
        # as we might be starting from a dotted revno in the first column
 
1463
        # and we want subsequent mainline revisions to line up.
 
1464
        depth = revision.merge_depth
 
1465
        indent = '    ' * depth
 
1466
        revno_width = self.revno_width_by_depth.get(depth)
 
1467
        if revno_width is None:
 
1468
            if revision.revno.find('.') == -1:
 
1469
                # mainline revno, e.g. 12345
 
1470
                revno_width = 5
 
1471
            else:
 
1472
                # dotted revno, e.g. 12345.10.55
 
1473
                revno_width = 11
 
1474
            self.revno_width_by_depth[depth] = revno_width
 
1475
        offset = ' ' * (revno_width + 1)
669
1476
 
670
1477
        to_file = self.to_file
671
 
        date_str = format_date(revision.rev.timestamp,
672
 
                               revision.rev.timezone or 0,
673
 
                               self.show_timezone)
674
 
        is_merge = ''
675
 
        if len(revision.rev.parent_ids) > 1:
676
 
            is_merge = ' [merge]'
677
 
        print >>to_file, "%5s %s\t%s%s" % (revision.revno,
678
 
                self.short_committer(revision.rev),
 
1478
        tags = ''
 
1479
        if revision.tags:
 
1480
            tags = ' {%s}' % (', '.join(revision.tags))
 
1481
        to_file.write(indent + "%*s %s\t%s%s%s\n" % (revno_width,
 
1482
                revision.revno, self.short_author(revision.rev),
679
1483
                format_date(revision.rev.timestamp,
680
1484
                            revision.rev.timezone or 0,
681
1485
                            self.show_timezone, date_fmt="%Y-%m-%d",
682
1486
                            show_offset=False),
683
 
                is_merge)
 
1487
                tags, self.merge_marker(revision)))
 
1488
        self.show_properties(revision.rev, indent+offset)
684
1489
        if self.show_ids:
685
 
            print >>to_file,  '      revision-id:', revision.rev.revision_id
 
1490
            to_file.write(indent + offset + 'revision-id:%s\n'
 
1491
                          % (revision.rev.revision_id,))
686
1492
        if not revision.rev.message:
687
 
            print >>to_file,  '      (no message)'
 
1493
            to_file.write(indent + offset + '(no message)\n')
688
1494
        else:
689
1495
            message = revision.rev.message.rstrip('\r\n')
690
1496
            for l in message.split('\n'):
691
 
                print >>to_file,  '      ' + l
 
1497
                to_file.write(indent + offset + '%s\n' % (l,))
692
1498
 
693
 
        # TODO: Why not show the modified files in a shorter form as
694
 
        # well? rewrap them single lines of appropriate length
695
1499
        if revision.delta is not None:
696
 
            revision.delta.show(to_file, self.show_ids)
697
 
        print >>to_file, ''
 
1500
            revision.delta.show(to_file, self.show_ids, indent=indent + offset,
 
1501
                                short_status=self.delta_format==1)
 
1502
        if revision.diff is not None:
 
1503
            self.show_diff(self.to_exact_file, revision.diff, '      ')
 
1504
        to_file.write('\n')
698
1505
 
699
1506
 
700
1507
class LineLogFormatter(LogFormatter):
701
1508
 
 
1509
    supports_merge_revisions = True
 
1510
    preferred_levels = 1
 
1511
    supports_tags = True
 
1512
 
702
1513
    def __init__(self, *args, **kwargs):
703
 
        from bzrlib.osutils import terminal_width
704
1514
        super(LineLogFormatter, self).__init__(*args, **kwargs)
705
1515
        self._max_chars = terminal_width() - 1
706
1516
 
710
1520
        return str[:max_len-3]+'...'
711
1521
 
712
1522
    def date_string(self, rev):
713
 
        from bzrlib.osutils import format_date
714
 
        return format_date(rev.timestamp, rev.timezone or 0, 
 
1523
        return format_date(rev.timestamp, rev.timezone or 0,
715
1524
                           self.show_timezone, date_fmt="%Y-%m-%d",
716
1525
                           show_offset=False)
717
1526
 
721
1530
        else:
722
1531
            return rev.message
723
1532
 
724
 
    @deprecated_method(zero_seventeen)
725
 
    def show(self, revno, rev, delta):
726
 
        from bzrlib.osutils import terminal_width
727
 
        print >> self.to_file, self.log_string(revno, rev, terminal_width()-1)
728
 
 
729
1533
    def log_revision(self, revision):
730
 
        print >>self.to_file, self.log_string(revision.revno, revision.rev,
731
 
                                              self._max_chars)
 
1534
        indent = '  ' * revision.merge_depth
 
1535
        self.to_file.write(self.log_string(revision.revno, revision.rev,
 
1536
            self._max_chars, revision.tags, indent))
 
1537
        self.to_file.write('\n')
732
1538
 
733
 
    def log_string(self, revno, rev, max_chars):
 
1539
    def log_string(self, revno, rev, max_chars, tags=None, prefix=''):
734
1540
        """Format log info into one string. Truncate tail of string
735
 
        :param  revno:      revision number (int) or None.
 
1541
        :param  revno:      revision number or None.
736
1542
                            Revision numbers counts from 1.
737
 
        :param  rev:        revision info object
 
1543
        :param  rev:        revision object
738
1544
        :param  max_chars:  maximum length of resulting string
 
1545
        :param  tags:       list of tags or None
 
1546
        :param  prefix:     string to prefix each line
739
1547
        :return:            formatted truncated string
740
1548
        """
741
1549
        out = []
742
1550
        if revno:
743
1551
            # show revno only when is not None
744
1552
            out.append("%s:" % revno)
745
 
        out.append(self.truncate(self.short_committer(rev), 20))
 
1553
        out.append(self.truncate(self.short_author(rev), 20))
746
1554
        out.append(self.date_string(rev))
 
1555
        if len(rev.parent_ids) > 1:
 
1556
            out.append('[merge]')
 
1557
        if tags:
 
1558
            tag_str = '{%s}' % (', '.join(tags))
 
1559
            out.append(tag_str)
747
1560
        out.append(rev.get_summary())
748
 
        return self.truncate(" ".join(out).rstrip('\n'), max_chars)
 
1561
        return self.truncate(prefix + " ".join(out).rstrip('\n'), max_chars)
 
1562
 
 
1563
 
 
1564
class GnuChangelogLogFormatter(LogFormatter):
 
1565
 
 
1566
    supports_merge_revisions = True
 
1567
    supports_delta = True
 
1568
 
 
1569
    def log_revision(self, revision):
 
1570
        """Log a revision, either merged or not."""
 
1571
        to_file = self.to_file
 
1572
 
 
1573
        date_str = format_date(revision.rev.timestamp,
 
1574
                               revision.rev.timezone or 0,
 
1575
                               self.show_timezone,
 
1576
                               date_fmt='%Y-%m-%d',
 
1577
                               show_offset=False)
 
1578
        committer_str = revision.rev.committer.replace (' <', '  <')
 
1579
        to_file.write('%s  %s\n\n' % (date_str,committer_str))
 
1580
 
 
1581
        if revision.delta is not None and revision.delta.has_changed():
 
1582
            for c in revision.delta.added + revision.delta.removed + revision.delta.modified:
 
1583
                path, = c[:1]
 
1584
                to_file.write('\t* %s:\n' % (path,))
 
1585
            for c in revision.delta.renamed:
 
1586
                oldpath,newpath = c[:2]
 
1587
                # For renamed files, show both the old and the new path
 
1588
                to_file.write('\t* %s:\n\t* %s:\n' % (oldpath,newpath))
 
1589
            to_file.write('\n')
 
1590
 
 
1591
        if not revision.rev.message:
 
1592
            to_file.write('\tNo commit message\n')
 
1593
        else:
 
1594
            message = revision.rev.message.rstrip('\r\n')
 
1595
            for l in message.split('\n'):
 
1596
                to_file.write('\t%s\n' % (l.lstrip(),))
 
1597
            to_file.write('\n')
749
1598
 
750
1599
 
751
1600
def line_log(rev, max_chars):
777
1626
                                'Detailed log format')
778
1627
log_formatter_registry.register('line', LineLogFormatter,
779
1628
                                'Log format with one line per revision')
 
1629
log_formatter_registry.register('gnu-changelog', GnuChangelogLogFormatter,
 
1630
                                'Format used by GNU ChangeLog files')
780
1631
 
781
1632
 
782
1633
def register_formatter(name, formatter):
789
1640
    name -- Name of the formatter to construct; currently 'long', 'short' and
790
1641
        'line' are supported.
791
1642
    """
792
 
    from bzrlib.errors import BzrCommandError
793
1643
    try:
794
1644
        return log_formatter_registry.make_formatter(name, *args, **kwargs)
795
1645
    except KeyError:
796
 
        raise BzrCommandError("unknown log formatter: %r" % name)
 
1646
        raise errors.BzrCommandError("unknown log formatter: %r" % name)
797
1647
 
798
1648
 
799
1649
def show_one_log(revno, rev, delta, verbose, to_file, show_timezone):
802
1652
    lf.show(revno, rev, delta)
803
1653
 
804
1654
 
805
 
def show_changed_revisions(branch, old_rh, new_rh, to_file=None, log_format='long'):
 
1655
def show_changed_revisions(branch, old_rh, new_rh, to_file=None,
 
1656
                           log_format='long'):
806
1657
    """Show the change in revision history comparing the old revision history to the new one.
807
1658
 
808
1659
    :param branch: The branch where the revisions exist
811
1662
    :param to_file: A file to write the results to. If None, stdout will be used
812
1663
    """
813
1664
    if to_file is None:
814
 
        import sys
815
 
        import codecs
816
 
        import bzrlib
817
 
        to_file = codecs.getwriter(bzrlib.user_encoding)(sys.stdout, errors='replace')
 
1665
        to_file = codecs.getwriter(get_terminal_encoding())(sys.stdout,
 
1666
            errors='replace')
818
1667
    lf = log_formatter(log_format,
819
1668
                       show_ids=False,
820
1669
                       to_file=to_file,
851
1700
        show_log(branch,
852
1701
                 lf,
853
1702
                 None,
854
 
                 verbose=True,
 
1703
                 verbose=False,
855
1704
                 direction='forward',
856
1705
                 start_revision=base_idx+1,
857
1706
                 end_revision=len(new_rh),
858
1707
                 search=None)
859
1708
 
 
1709
 
 
1710
def get_history_change(old_revision_id, new_revision_id, repository):
 
1711
    """Calculate the uncommon lefthand history between two revisions.
 
1712
 
 
1713
    :param old_revision_id: The original revision id.
 
1714
    :param new_revision_id: The new revision id.
 
1715
    :param repository: The repository to use for the calculation.
 
1716
 
 
1717
    return old_history, new_history
 
1718
    """
 
1719
    old_history = []
 
1720
    old_revisions = set()
 
1721
    new_history = []
 
1722
    new_revisions = set()
 
1723
    new_iter = repository.iter_reverse_revision_history(new_revision_id)
 
1724
    old_iter = repository.iter_reverse_revision_history(old_revision_id)
 
1725
    stop_revision = None
 
1726
    do_old = True
 
1727
    do_new = True
 
1728
    while do_new or do_old:
 
1729
        if do_new:
 
1730
            try:
 
1731
                new_revision = new_iter.next()
 
1732
            except StopIteration:
 
1733
                do_new = False
 
1734
            else:
 
1735
                new_history.append(new_revision)
 
1736
                new_revisions.add(new_revision)
 
1737
                if new_revision in old_revisions:
 
1738
                    stop_revision = new_revision
 
1739
                    break
 
1740
        if do_old:
 
1741
            try:
 
1742
                old_revision = old_iter.next()
 
1743
            except StopIteration:
 
1744
                do_old = False
 
1745
            else:
 
1746
                old_history.append(old_revision)
 
1747
                old_revisions.add(old_revision)
 
1748
                if old_revision in new_revisions:
 
1749
                    stop_revision = old_revision
 
1750
                    break
 
1751
    new_history.reverse()
 
1752
    old_history.reverse()
 
1753
    if stop_revision is not None:
 
1754
        new_history = new_history[new_history.index(stop_revision) + 1:]
 
1755
        old_history = old_history[old_history.index(stop_revision) + 1:]
 
1756
    return old_history, new_history
 
1757
 
 
1758
 
 
1759
def show_branch_change(branch, output, old_revno, old_revision_id):
 
1760
    """Show the changes made to a branch.
 
1761
 
 
1762
    :param branch: The branch to show changes about.
 
1763
    :param output: A file-like object to write changes to.
 
1764
    :param old_revno: The revno of the old tip.
 
1765
    :param old_revision_id: The revision_id of the old tip.
 
1766
    """
 
1767
    new_revno, new_revision_id = branch.last_revision_info()
 
1768
    old_history, new_history = get_history_change(old_revision_id,
 
1769
                                                  new_revision_id,
 
1770
                                                  branch.repository)
 
1771
    if old_history == [] and new_history == []:
 
1772
        output.write('Nothing seems to have changed\n')
 
1773
        return
 
1774
 
 
1775
    log_format = log_formatter_registry.get_default(branch)
 
1776
    lf = log_format(show_ids=False, to_file=output, show_timezone='original')
 
1777
    if old_history != []:
 
1778
        output.write('*'*60)
 
1779
        output.write('\nRemoved Revisions:\n')
 
1780
        show_flat_log(branch.repository, old_history, old_revno, lf)
 
1781
        output.write('*'*60)
 
1782
        output.write('\n\n')
 
1783
    if new_history != []:
 
1784
        output.write('Added Revisions:\n')
 
1785
        start_revno = new_revno - len(new_history) + 1
 
1786
        show_log(branch, lf, None, verbose=False, direction='forward',
 
1787
                 start_revision=start_revno,)
 
1788
 
 
1789
 
 
1790
def show_flat_log(repository, history, last_revno, lf):
 
1791
    """Show a simple log of the specified history.
 
1792
 
 
1793
    :param repository: The repository to retrieve revisions from.
 
1794
    :param history: A list of revision_ids indicating the lefthand history.
 
1795
    :param last_revno: The revno of the last revision_id in the history.
 
1796
    :param lf: The log formatter to use.
 
1797
    """
 
1798
    start_revno = last_revno - len(history) + 1
 
1799
    revisions = repository.get_revisions(history)
 
1800
    for i, rev in enumerate(revisions):
 
1801
        lr = LogRevision(rev, i + last_revno, 0, None)
 
1802
        lf.log_revision(lr)
 
1803
 
 
1804
 
 
1805
def _get_info_for_log_files(revisionspec_list, file_list):
 
1806
    """Find file-ids and kinds given a list of files and a revision range.
 
1807
 
 
1808
    We search for files at the end of the range. If not found there,
 
1809
    we try the start of the range.
 
1810
 
 
1811
    :param revisionspec_list: revision range as parsed on the command line
 
1812
    :param file_list: the list of paths given on the command line;
 
1813
      the first of these can be a branch location or a file path,
 
1814
      the remainder must be file paths
 
1815
    :return: (branch, info_list, start_rev_info, end_rev_info) where
 
1816
      info_list is a list of (relative_path, file_id, kind) tuples where
 
1817
      kind is one of values 'directory', 'file', 'symlink', 'tree-reference'.
 
1818
    """
 
1819
    from builtins import _get_revision_range, safe_relpath_files
 
1820
    tree, b, path = bzrdir.BzrDir.open_containing_tree_or_branch(file_list[0])
 
1821
    # XXX: It's damn messy converting a list of paths to relative paths when
 
1822
    # those paths might be deleted ones, they might be on a case-insensitive
 
1823
    # filesystem and/or they might be in silly locations (like another branch).
 
1824
    # For example, what should "log bzr://branch/dir/file1 file2" do? (Is
 
1825
    # file2 implicitly in the same dir as file1 or should its directory be
 
1826
    # taken from the current tree somehow?) For now, this solves the common
 
1827
    # case of running log in a nested directory, assuming paths beyond the
 
1828
    # first one haven't been deleted ...
 
1829
    if tree:
 
1830
        relpaths = [path] + safe_relpath_files(tree, file_list[1:])
 
1831
    else:
 
1832
        relpaths = [path] + file_list[1:]
 
1833
    info_list = []
 
1834
    start_rev_info, end_rev_info = _get_revision_range(revisionspec_list, b,
 
1835
        "log")
 
1836
    if relpaths in ([], [u'']):
 
1837
        return b, [], start_rev_info, end_rev_info
 
1838
    if start_rev_info is None and end_rev_info is None:
 
1839
        if tree is None:
 
1840
            tree = b.basis_tree()
 
1841
        tree1 = None
 
1842
        for fp in relpaths:
 
1843
            file_id = tree.path2id(fp)
 
1844
            kind = _get_kind_for_file_id(tree, file_id)
 
1845
            if file_id is None:
 
1846
                # go back to when time began
 
1847
                if tree1 is None:
 
1848
                    try:
 
1849
                        rev1 = b.get_rev_id(1)
 
1850
                    except errors.NoSuchRevision:
 
1851
                        # No history at all
 
1852
                        file_id = None
 
1853
                        kind = None
 
1854
                    else:
 
1855
                        tree1 = b.repository.revision_tree(rev1)
 
1856
                if tree1:
 
1857
                    file_id = tree1.path2id(fp)
 
1858
                    kind = _get_kind_for_file_id(tree1, file_id)
 
1859
            info_list.append((fp, file_id, kind))
 
1860
 
 
1861
    elif start_rev_info == end_rev_info:
 
1862
        # One revision given - file must exist in it
 
1863
        tree = b.repository.revision_tree(end_rev_info.rev_id)
 
1864
        for fp in relpaths:
 
1865
            file_id = tree.path2id(fp)
 
1866
            kind = _get_kind_for_file_id(tree, file_id)
 
1867
            info_list.append((fp, file_id, kind))
 
1868
 
 
1869
    else:
 
1870
        # Revision range given. Get the file-id from the end tree.
 
1871
        # If that fails, try the start tree.
 
1872
        rev_id = end_rev_info.rev_id
 
1873
        if rev_id is None:
 
1874
            tree = b.basis_tree()
 
1875
        else:
 
1876
            tree = b.repository.revision_tree(rev_id)
 
1877
        tree1 = None
 
1878
        for fp in relpaths:
 
1879
            file_id = tree.path2id(fp)
 
1880
            kind = _get_kind_for_file_id(tree, file_id)
 
1881
            if file_id is None:
 
1882
                if tree1 is None:
 
1883
                    rev_id = start_rev_info.rev_id
 
1884
                    if rev_id is None:
 
1885
                        rev1 = b.get_rev_id(1)
 
1886
                        tree1 = b.repository.revision_tree(rev1)
 
1887
                    else:
 
1888
                        tree1 = b.repository.revision_tree(rev_id)
 
1889
                file_id = tree1.path2id(fp)
 
1890
                kind = _get_kind_for_file_id(tree1, file_id)
 
1891
            info_list.append((fp, file_id, kind))
 
1892
    return b, info_list, start_rev_info, end_rev_info
 
1893
 
 
1894
 
 
1895
def _get_kind_for_file_id(tree, file_id):
 
1896
    """Return the kind of a file-id or None if it doesn't exist."""
 
1897
    if file_id is not None:
 
1898
        return tree.kind(file_id)
 
1899
    else:
 
1900
        return None
 
1901
 
 
1902
 
 
1903
properties_handler_registry = registry.Registry()
 
1904
properties_handler_registry.register_lazy("foreign",
 
1905
                                          "bzrlib.foreign",
 
1906
                                          "show_foreign_properties")
 
1907
 
 
1908
 
 
1909
# adapters which revision ids to log are filtered. When log is called, the
 
1910
# log_rev_iterator is adapted through each of these factory methods.
 
1911
# Plugins are welcome to mutate this list in any way they like - as long
 
1912
# as the overall behaviour is preserved. At this point there is no extensible
 
1913
# mechanism for getting parameters to each factory method, and until there is
 
1914
# this won't be considered a stable api.
 
1915
log_adapters = [
 
1916
    # core log logic
 
1917
    _make_batch_filter,
 
1918
    # read revision objects
 
1919
    _make_revision_objects,
 
1920
    # filter on log messages
 
1921
    _make_search_filter,
 
1922
    # generate deltas for things we will show
 
1923
    _make_delta_filter
 
1924
    ]