~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/log.py

  • Committer: Andrew Bennetts
  • Date: 2010-01-15 05:30:30 UTC
  • mto: (4973.1.1 integration)
  • mto: This revision was merged to the branch mainline in revision 4975.
  • Revision ID: andrew.bennetts@canonical.com-20100115053030-1d6qd89pnj8hmb55
Pass kinds (not pairs) to MergeHookParams.

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
 
65
65
lazy_import(globals(), """
66
66
 
67
67
from bzrlib import (
 
68
    bzrdir,
68
69
    config,
69
70
    diff,
70
71
    errors,
 
72
    foreign,
71
73
    repository as _mod_repository,
72
74
    revision as _mod_revision,
73
75
    revisionspec,
81
83
    )
82
84
from bzrlib.osutils import (
83
85
    format_date,
 
86
    format_date_with_offset_in_original_timezone,
84
87
    get_terminal_encoding,
 
88
    re_compile_checked,
85
89
    terminal_width,
86
90
    )
87
91
 
151
155
             show_diff=False):
152
156
    """Write out human-readable log of commits to this branch.
153
157
 
 
158
    This function is being retained for backwards compatibility but
 
159
    should not be extended with new parameters. Use the new Logger class
 
160
    instead, eg. Logger(branch, rqst).show(lf), adding parameters to the
 
161
    make_log_request_dict function.
 
162
 
154
163
    :param lf: The LogFormatter object showing the output.
155
164
 
156
165
    :param specific_fileid: If not None, list only the commits affecting the
173
182
 
174
183
    :param show_diff: If True, output a diff after each revision.
175
184
    """
176
 
    branch.lock_read()
177
 
    try:
178
 
        if getattr(lf, 'begin_log', None):
179
 
            lf.begin_log()
180
 
 
181
 
        _show_log(branch, lf, specific_fileid, verbose, direction,
182
 
                  start_revision, end_revision, search, limit, show_diff)
183
 
 
184
 
        if getattr(lf, 'end_log', None):
185
 
            lf.end_log()
186
 
    finally:
187
 
        branch.unlock()
188
 
 
189
 
 
190
 
def _show_log(branch,
191
 
             lf,
192
 
             specific_fileid=None,
193
 
             verbose=False,
194
 
             direction='reverse',
195
 
             start_revision=None,
196
 
             end_revision=None,
197
 
             search=None,
198
 
             limit=None,
199
 
             show_diff=False):
200
 
    """Worker function for show_log - see show_log."""
201
 
    if not isinstance(lf, LogFormatter):
202
 
        warn("not a LogFormatter instance: %r" % lf)
203
 
    if specific_fileid:
204
 
        trace.mutter('get log for file_id %r', specific_fileid)
205
 
 
206
 
    # Consult the LogFormatter about what it needs and can handle
207
 
    levels_to_display = lf.get_levels()
208
 
    generate_merge_revisions = levels_to_display != 1
209
 
    allow_single_merge_revision = True
210
 
    if not getattr(lf, 'supports_merge_revisions', False):
211
 
        allow_single_merge_revision = getattr(lf,
212
 
            'supports_single_merge_revision', False)
213
 
    generate_tags = getattr(lf, 'supports_tags', False)
214
 
    if generate_tags and branch.supports_tags():
215
 
        rev_tag_dict = branch.tags.get_reverse_tag_dict()
216
 
    else:
217
 
        rev_tag_dict = {}
218
 
    generate_delta = verbose and getattr(lf, 'supports_delta', False)
219
 
    generate_diff = show_diff and getattr(lf, 'supports_diff', False)
220
 
 
221
 
    # Find and print the interesting revisions
222
 
    repo = branch.repository
223
 
    log_count = 0
224
 
    revision_iterator = _create_log_revision_iterator(branch,
225
 
        start_revision, end_revision, direction, specific_fileid, search,
226
 
        generate_merge_revisions, allow_single_merge_revision,
227
 
        generate_delta, limited_output=limit > 0)
228
 
    for revs in revision_iterator:
229
 
        for (rev_id, revno, merge_depth), rev, delta in revs:
230
 
            # Note: 0 levels means show everything; merge_depth counts from 0
231
 
            if levels_to_display != 0 and merge_depth >= levels_to_display:
232
 
                continue
233
 
            if generate_diff:
234
 
                diff = _format_diff(repo, rev, rev_id, specific_fileid)
235
 
            else:
236
 
                diff = None
237
 
            lr = LogRevision(rev, revno, merge_depth, delta,
238
 
                             rev_tag_dict.get(rev_id), diff)
 
185
    # Convert old-style parameters to new-style parameters
 
186
    if specific_fileid is not None:
 
187
        file_ids = [specific_fileid]
 
188
    else:
 
189
        file_ids = None
 
190
    if verbose:
 
191
        if file_ids:
 
192
            delta_type = 'partial'
 
193
        else:
 
194
            delta_type = 'full'
 
195
    else:
 
196
        delta_type = None
 
197
    if show_diff:
 
198
        if file_ids:
 
199
            diff_type = 'partial'
 
200
        else:
 
201
            diff_type = 'full'
 
202
    else:
 
203
        diff_type = None
 
204
 
 
205
    # Build the request and execute it
 
206
    rqst = make_log_request_dict(direction=direction, specific_fileids=file_ids,
 
207
        start_revision=start_revision, end_revision=end_revision,
 
208
        limit=limit, message_search=search,
 
209
        delta_type=delta_type, diff_type=diff_type)
 
210
    Logger(branch, rqst).show(lf)
 
211
 
 
212
 
 
213
# Note: This needs to be kept this in sync with the defaults in
 
214
# make_log_request_dict() below
 
215
_DEFAULT_REQUEST_PARAMS = {
 
216
    'direction': 'reverse',
 
217
    'levels': 1,
 
218
    'generate_tags': True,
 
219
    '_match_using_deltas': True,
 
220
    }
 
221
 
 
222
 
 
223
def make_log_request_dict(direction='reverse', specific_fileids=None,
 
224
    start_revision=None, end_revision=None, limit=None,
 
225
    message_search=None, levels=1, generate_tags=True, delta_type=None,
 
226
    diff_type=None, _match_using_deltas=True):
 
227
    """Convenience function for making a logging request dictionary.
 
228
 
 
229
    Using this function may make code slightly safer by ensuring
 
230
    parameters have the correct names. It also provides a reference
 
231
    point for documenting the supported parameters.
 
232
 
 
233
    :param direction: 'reverse' (default) is latest to earliest;
 
234
      'forward' is earliest to latest.
 
235
 
 
236
    :param specific_fileids: If not None, only include revisions
 
237
      affecting the specified files, rather than all revisions.
 
238
 
 
239
    :param start_revision: If not None, only generate
 
240
      revisions >= start_revision
 
241
 
 
242
    :param end_revision: If not None, only generate
 
243
      revisions <= end_revision
 
244
 
 
245
    :param limit: If set, generate only 'limit' revisions, all revisions
 
246
      are shown if None or 0.
 
247
 
 
248
    :param message_search: If not None, only include revisions with
 
249
      matching commit messages
 
250
 
 
251
    :param levels: the number of levels of revisions to
 
252
      generate; 1 for just the mainline; 0 for all levels.
 
253
 
 
254
    :param generate_tags: If True, include tags for matched revisions.
 
255
 
 
256
    :param delta_type: Either 'full', 'partial' or None.
 
257
      'full' means generate the complete delta - adds/deletes/modifies/etc;
 
258
      'partial' means filter the delta using specific_fileids;
 
259
      None means do not generate any delta.
 
260
 
 
261
    :param diff_type: Either 'full', 'partial' or None.
 
262
      'full' means generate the complete diff - adds/deletes/modifies/etc;
 
263
      'partial' means filter the diff using specific_fileids;
 
264
      None means do not generate any diff.
 
265
 
 
266
    :param _match_using_deltas: a private parameter controlling the
 
267
      algorithm used for matching specific_fileids. This parameter
 
268
      may be removed in the future so bzrlib client code should NOT
 
269
      use it.
 
270
    """
 
271
    return {
 
272
        'direction': direction,
 
273
        'specific_fileids': specific_fileids,
 
274
        'start_revision': start_revision,
 
275
        'end_revision': end_revision,
 
276
        'limit': limit,
 
277
        'message_search': message_search,
 
278
        'levels': levels,
 
279
        'generate_tags': generate_tags,
 
280
        'delta_type': delta_type,
 
281
        'diff_type': diff_type,
 
282
        # Add 'private' attributes for features that may be deprecated
 
283
        '_match_using_deltas': _match_using_deltas,
 
284
    }
 
285
 
 
286
 
 
287
def _apply_log_request_defaults(rqst):
 
288
    """Apply default values to a request dictionary."""
 
289
    result = _DEFAULT_REQUEST_PARAMS
 
290
    if rqst:
 
291
        result.update(rqst)
 
292
    return result
 
293
 
 
294
 
 
295
class LogGenerator(object):
 
296
    """A generator of log revisions."""
 
297
 
 
298
    def iter_log_revisions(self):
 
299
        """Iterate over LogRevision objects.
 
300
 
 
301
        :return: An iterator yielding LogRevision objects.
 
302
        """
 
303
        raise NotImplementedError(self.iter_log_revisions)
 
304
 
 
305
 
 
306
class Logger(object):
 
307
    """An object the generates, formats and displays a log."""
 
308
 
 
309
    def __init__(self, branch, rqst):
 
310
        """Create a Logger.
 
311
 
 
312
        :param branch: the branch to log
 
313
        :param rqst: A dictionary specifying the query parameters.
 
314
          See make_log_request_dict() for supported values.
 
315
        """
 
316
        self.branch = branch
 
317
        self.rqst = _apply_log_request_defaults(rqst)
 
318
 
 
319
    def show(self, lf):
 
320
        """Display the log.
 
321
 
 
322
        :param lf: The LogFormatter object to send the output to.
 
323
        """
 
324
        if not isinstance(lf, LogFormatter):
 
325
            warn("not a LogFormatter instance: %r" % lf)
 
326
 
 
327
        self.branch.lock_read()
 
328
        try:
 
329
            if getattr(lf, 'begin_log', None):
 
330
                lf.begin_log()
 
331
            self._show_body(lf)
 
332
            if getattr(lf, 'end_log', None):
 
333
                lf.end_log()
 
334
        finally:
 
335
            self.branch.unlock()
 
336
 
 
337
    def _show_body(self, lf):
 
338
        """Show the main log output.
 
339
 
 
340
        Subclasses may wish to override this.
 
341
        """
 
342
        # Tweak the LogRequest based on what the LogFormatter can handle.
 
343
        # (There's no point generating stuff if the formatter can't display it.)
 
344
        rqst = self.rqst
 
345
        rqst['levels'] = lf.get_levels()
 
346
        if not getattr(lf, 'supports_tags', False):
 
347
            rqst['generate_tags'] = False
 
348
        if not getattr(lf, 'supports_delta', False):
 
349
            rqst['delta_type'] = None
 
350
        if not getattr(lf, 'supports_diff', False):
 
351
            rqst['diff_type'] = None
 
352
 
 
353
        # Find and print the interesting revisions
 
354
        generator = self._generator_factory(self.branch, rqst)
 
355
        for lr in generator.iter_log_revisions():
239
356
            lf.log_revision(lr)
240
 
            if limit:
241
 
                log_count += 1
242
 
                if log_count >= limit:
243
 
                    return
244
 
 
245
 
 
246
 
def _format_diff(repo, rev, rev_id, specific_fileid):
247
 
    if len(rev.parent_ids) == 0:
248
 
        ancestor_id = _mod_revision.NULL_REVISION
249
 
    else:
250
 
        ancestor_id = rev.parent_ids[0]
251
 
    tree_1 = repo.revision_tree(ancestor_id)
252
 
    tree_2 = repo.revision_tree(rev_id)
253
 
    if specific_fileid:
254
 
        specific_files = [tree_2.id2path(specific_fileid)]
255
 
    else:
256
 
        specific_files = None
257
 
    s = StringIO()
258
 
    diff.show_diff_trees(tree_1, tree_2, s, specific_files, old_label='',
259
 
        new_label='')
260
 
    return s.getvalue()
 
357
        lf.show_advice()
 
358
 
 
359
    def _generator_factory(self, branch, rqst):
 
360
        """Make the LogGenerator object to use.
 
361
        
 
362
        Subclasses may wish to override this.
 
363
        """
 
364
        return _DefaultLogGenerator(branch, rqst)
261
365
 
262
366
 
263
367
class _StartNotLinearAncestor(Exception):
264
368
    """Raised when a start revision is not found walking left-hand history."""
265
369
 
266
370
 
267
 
def _create_log_revision_iterator(branch, start_revision, end_revision,
268
 
    direction, specific_fileid, search, generate_merge_revisions,
269
 
    allow_single_merge_revision, generate_delta, limited_output=False):
270
 
    """Create a revision iterator for log.
271
 
 
272
 
    :param branch: The branch being logged.
273
 
    :param start_revision: If not None, only show revisions >= start_revision
274
 
    :param end_revision: If not None, only show revisions <= end_revision
275
 
    :param direction: 'reverse' (default) is latest to earliest; 'forward' is
276
 
        earliest to latest.
277
 
    :param specific_fileid: If not None, list only the commits affecting the
278
 
        specified file.
279
 
    :param search: If not None, only show revisions with matching commit
280
 
        messages.
281
 
    :param generate_merge_revisions: If False, show only mainline revisions.
282
 
    :param allow_single_merge_revision: If True, logging of a single
283
 
        revision off the mainline is to be allowed
284
 
    :param generate_delta: Whether to generate a delta for each revision.
285
 
    :param limited_output: if True, the user only wants a limited result
286
 
 
287
 
    :return: An iterator over lists of ((rev_id, revno, merge_depth), rev,
288
 
        delta).
289
 
    """
290
 
    start_rev_id, end_rev_id = _get_revision_limits(branch, start_revision,
291
 
        end_revision)
292
 
 
293
 
    # Decide how file-ids are matched: delta-filtering vs per-file graph.
294
 
    # Delta filtering allows revisions to be displayed incrementally
295
 
    # though the total time is much slower for huge repositories: log -v
296
 
    # is the *lower* performance bound. At least until the split
297
 
    # inventory format arrives, per-file-graph needs to remain the
298
 
    # default except in verbose mode. Delta filtering should give more
299
 
    # accurate results (e.g. inclusion of FILE deletions) so arguably
300
 
    # it should always be used in the future.
301
 
    use_deltas_for_matching = specific_fileid and generate_delta
302
 
    delayed_graph_generation = not specific_fileid and (
303
 
            start_rev_id or end_rev_id or limited_output)
304
 
    generate_merges = generate_merge_revisions or (specific_fileid and
305
 
        not use_deltas_for_matching)
306
 
    view_revisions = _calc_view_revisions(branch, start_rev_id, end_rev_id,
307
 
        direction, generate_merges, allow_single_merge_revision,
308
 
        delayed_graph_generation=delayed_graph_generation)
309
 
    search_deltas_for_fileids = None
310
 
    if use_deltas_for_matching:
311
 
        search_deltas_for_fileids = set([specific_fileid])
312
 
    elif specific_fileid:
 
371
class _DefaultLogGenerator(LogGenerator):
 
372
    """The default generator of log revisions."""
 
373
 
 
374
    def __init__(self, branch, rqst):
 
375
        self.branch = branch
 
376
        self.rqst = rqst
 
377
        if rqst.get('generate_tags') and branch.supports_tags():
 
378
            self.rev_tag_dict = branch.tags.get_reverse_tag_dict()
 
379
        else:
 
380
            self.rev_tag_dict = {}
 
381
 
 
382
    def iter_log_revisions(self):
 
383
        """Iterate over LogRevision objects.
 
384
 
 
385
        :return: An iterator yielding LogRevision objects.
 
386
        """
 
387
        rqst = self.rqst
 
388
        levels = rqst.get('levels')
 
389
        limit = rqst.get('limit')
 
390
        diff_type = rqst.get('diff_type')
 
391
        log_count = 0
 
392
        revision_iterator = self._create_log_revision_iterator()
 
393
        for revs in revision_iterator:
 
394
            for (rev_id, revno, merge_depth), rev, delta in revs:
 
395
                # 0 levels means show everything; merge_depth counts from 0
 
396
                if levels != 0 and merge_depth >= levels:
 
397
                    continue
 
398
                if diff_type is None:
 
399
                    diff = None
 
400
                else:
 
401
                    diff = self._format_diff(rev, rev_id, diff_type)
 
402
                yield LogRevision(rev, revno, merge_depth, delta,
 
403
                    self.rev_tag_dict.get(rev_id), diff)
 
404
                if limit:
 
405
                    log_count += 1
 
406
                    if log_count >= limit:
 
407
                        return
 
408
 
 
409
    def _format_diff(self, rev, rev_id, diff_type):
 
410
        repo = self.branch.repository
 
411
        if len(rev.parent_ids) == 0:
 
412
            ancestor_id = _mod_revision.NULL_REVISION
 
413
        else:
 
414
            ancestor_id = rev.parent_ids[0]
 
415
        tree_1 = repo.revision_tree(ancestor_id)
 
416
        tree_2 = repo.revision_tree(rev_id)
 
417
        file_ids = self.rqst.get('specific_fileids')
 
418
        if diff_type == 'partial' and file_ids is not None:
 
419
            specific_files = [tree_2.id2path(id) for id in file_ids]
 
420
        else:
 
421
            specific_files = None
 
422
        s = StringIO()
 
423
        diff.show_diff_trees(tree_1, tree_2, s, specific_files, old_label='',
 
424
            new_label='')
 
425
        return s.getvalue()
 
426
 
 
427
    def _create_log_revision_iterator(self):
 
428
        """Create a revision iterator for log.
 
429
 
 
430
        :return: An iterator over lists of ((rev_id, revno, merge_depth), rev,
 
431
            delta).
 
432
        """
 
433
        self.start_rev_id, self.end_rev_id = _get_revision_limits(
 
434
            self.branch, self.rqst.get('start_revision'),
 
435
            self.rqst.get('end_revision'))
 
436
        if self.rqst.get('_match_using_deltas'):
 
437
            return self._log_revision_iterator_using_delta_matching()
 
438
        else:
 
439
            # We're using the per-file-graph algorithm. This scales really
 
440
            # well but only makes sense if there is a single file and it's
 
441
            # not a directory
 
442
            file_count = len(self.rqst.get('specific_fileids'))
 
443
            if file_count != 1:
 
444
                raise BzrError("illegal LogRequest: must match-using-deltas "
 
445
                    "when logging %d files" % file_count)
 
446
            return self._log_revision_iterator_using_per_file_graph()
 
447
 
 
448
    def _log_revision_iterator_using_delta_matching(self):
 
449
        # Get the base revisions, filtering by the revision range
 
450
        rqst = self.rqst
 
451
        generate_merge_revisions = rqst.get('levels') != 1
 
452
        delayed_graph_generation = not rqst.get('specific_fileids') and (
 
453
                rqst.get('limit') or self.start_rev_id or self.end_rev_id)
 
454
        view_revisions = _calc_view_revisions(self.branch, self.start_rev_id,
 
455
            self.end_rev_id, rqst.get('direction'), generate_merge_revisions,
 
456
            delayed_graph_generation=delayed_graph_generation)
 
457
 
 
458
        # Apply the other filters
 
459
        return make_log_rev_iterator(self.branch, view_revisions,
 
460
            rqst.get('delta_type'), rqst.get('message_search'),
 
461
            file_ids=rqst.get('specific_fileids'),
 
462
            direction=rqst.get('direction'))
 
463
 
 
464
    def _log_revision_iterator_using_per_file_graph(self):
 
465
        # Get the base revisions, filtering by the revision range.
 
466
        # Note that we always generate the merge revisions because
 
467
        # filter_revisions_touching_file_id() requires them ...
 
468
        rqst = self.rqst
 
469
        view_revisions = _calc_view_revisions(self.branch, self.start_rev_id,
 
470
            self.end_rev_id, rqst.get('direction'), True)
313
471
        if not isinstance(view_revisions, list):
314
472
            view_revisions = list(view_revisions)
315
 
        view_revisions = _filter_revisions_touching_file_id(branch,
316
 
            specific_fileid, view_revisions,
317
 
            include_merges=generate_merge_revisions)
318
 
    return make_log_rev_iterator(branch, view_revisions, generate_delta,
319
 
        search, file_ids=search_deltas_for_fileids, direction=direction)
 
473
        view_revisions = _filter_revisions_touching_file_id(self.branch,
 
474
            rqst.get('specific_fileids')[0], view_revisions,
 
475
            include_merges=rqst.get('levels') != 1)
 
476
        return make_log_rev_iterator(self.branch, view_revisions,
 
477
            rqst.get('delta_type'), rqst.get('message_search'))
320
478
 
321
479
 
322
480
def _calc_view_revisions(branch, start_rev_id, end_rev_id, direction,
323
 
    generate_merge_revisions, allow_single_merge_revision,
324
 
    delayed_graph_generation=False):
 
481
    generate_merge_revisions, delayed_graph_generation=False):
325
482
    """Calculate the revisions to view.
326
483
 
327
484
    :return: An iterator of (revision_id, dotted_revno, merge_depth) tuples OR
335
492
    generate_single_revision = (end_rev_id and start_rev_id == end_rev_id and
336
493
        (not generate_merge_revisions or not _has_merges(branch, end_rev_id)))
337
494
    if generate_single_revision:
338
 
        if end_rev_id == br_rev_id:
339
 
            # It's the tip
340
 
            return [(br_rev_id, br_revno, 0)]
341
 
        else:
342
 
            revno = branch.revision_id_to_dotted_revno(end_rev_id)
343
 
            if len(revno) > 1 and not allow_single_merge_revision:
344
 
                # It's a merge revision and the log formatter is
345
 
                # completely brain dead. This "feature" of allowing
346
 
                # log formatters incapable of displaying dotted revnos
347
 
                # ought to be deprecated IMNSHO. IGC 20091022
348
 
                raise errors.BzrCommandError('Selected log formatter only'
349
 
                    ' supports mainline revisions.')
350
 
            revno_str = '.'.join(str(n) for n in revno)
351
 
            return [(end_rev_id, revno_str, 0)]
 
495
        return _generate_one_revision(branch, end_rev_id, br_rev_id, br_revno)
352
496
 
353
497
    # If we only want to see linear revisions, we can iterate ...
354
498
    if not generate_merge_revisions:
355
 
        result = _linear_view_revisions(branch, start_rev_id, end_rev_id)
356
 
        # If a start limit was given and it's not obviously an
357
 
        # ancestor of the end limit, check it before outputting anything
358
 
        if direction == 'forward' or (start_rev_id
359
 
            and not _is_obvious_ancestor(branch, start_rev_id, end_rev_id)):
360
 
            try:
361
 
                result = list(result)
362
 
            except _StartNotLinearAncestor:
363
 
                raise errors.BzrCommandError('Start revision not found in'
364
 
                    ' left-hand history of end revision.')
365
 
        if direction == 'forward':
366
 
            result = reversed(list(result))
367
 
        return result
368
 
 
 
499
        return _generate_flat_revisions(branch, start_rev_id, end_rev_id,
 
500
            direction)
 
501
    else:
 
502
        return _generate_all_revisions(branch, start_rev_id, end_rev_id,
 
503
            direction, delayed_graph_generation)
 
504
 
 
505
 
 
506
def _generate_one_revision(branch, rev_id, br_rev_id, br_revno):
 
507
    if rev_id == br_rev_id:
 
508
        # It's the tip
 
509
        return [(br_rev_id, br_revno, 0)]
 
510
    else:
 
511
        revno = branch.revision_id_to_dotted_revno(rev_id)
 
512
        revno_str = '.'.join(str(n) for n in revno)
 
513
        return [(rev_id, revno_str, 0)]
 
514
 
 
515
 
 
516
def _generate_flat_revisions(branch, start_rev_id, end_rev_id, direction):
 
517
    result = _linear_view_revisions(branch, start_rev_id, end_rev_id)
 
518
    # If a start limit was given and it's not obviously an
 
519
    # ancestor of the end limit, check it before outputting anything
 
520
    if direction == 'forward' or (start_rev_id
 
521
        and not _is_obvious_ancestor(branch, start_rev_id, end_rev_id)):
 
522
        try:
 
523
            result = list(result)
 
524
        except _StartNotLinearAncestor:
 
525
            raise errors.BzrCommandError('Start revision not found in'
 
526
                ' left-hand history of end revision.')
 
527
    if direction == 'forward':
 
528
        result = reversed(result)
 
529
    return result
 
530
 
 
531
 
 
532
def _generate_all_revisions(branch, start_rev_id, end_rev_id, direction,
 
533
    delayed_graph_generation):
369
534
    # On large trees, generating the merge graph can take 30-60 seconds
370
535
    # so we delay doing it until a merge is detected, incrementally
371
536
    # returning initial (non-merge) revisions while we can.
505
670
 
506
671
 
507
672
def calculate_view_revisions(branch, start_revision, end_revision, direction,
508
 
        specific_fileid, generate_merge_revisions, allow_single_merge_revision):
 
673
        specific_fileid, generate_merge_revisions):
509
674
    """Calculate the revisions to view.
510
675
 
511
676
    :return: An iterator of (revision_id, dotted_revno, merge_depth) tuples OR
517
682
    start_rev_id, end_rev_id = _get_revision_limits(branch, start_revision,
518
683
        end_revision)
519
684
    view_revisions = list(_calc_view_revisions(branch, start_rev_id, end_rev_id,
520
 
        direction, generate_merge_revisions or specific_fileid,
521
 
        allow_single_merge_revision))
 
685
        direction, generate_merge_revisions or specific_fileid))
522
686
    if specific_fileid:
523
687
        view_revisions = _filter_revisions_touching_file_id(branch,
524
688
            specific_fileid, view_revisions,
543
707
    :param branch: The branch being logged.
544
708
    :param view_revisions: The revisions being viewed.
545
709
    :param generate_delta: Whether to generate a delta for each revision.
 
710
      Permitted values are None, 'full' and 'partial'.
546
711
    :param search: A user text search string.
547
712
    :param file_ids: If non empty, only revisions matching one or more of
548
713
      the file-ids are to be kept.
587
752
    """
588
753
    if search is None:
589
754
        return log_rev_iterator
590
 
    # Compile the search now to get early errors.
591
 
    searchRE = re.compile(search, re.IGNORECASE)
 
755
    searchRE = re_compile_checked(search, re.IGNORECASE,
 
756
            'log message filter')
592
757
    return _filter_message_re(searchRE, log_rev_iterator)
593
758
 
594
759
 
607
772
 
608
773
    :param branch: The branch being logged.
609
774
    :param generate_delta: Whether to generate a delta for each revision.
 
775
      Permitted values are None, 'full' and 'partial'.
610
776
    :param search: A user text search string.
611
777
    :param log_rev_iterator: An input iterator containing all revisions that
612
778
        could be displayed, in lists.
622
788
        generate_delta, fileids, direction)
623
789
 
624
790
 
625
 
def _generate_deltas(repository, log_rev_iterator, always_delta, fileids,
 
791
def _generate_deltas(repository, log_rev_iterator, delta_type, fileids,
626
792
    direction):
627
793
    """Create deltas for each batch of revisions in log_rev_iterator.
628
 
    
 
794
 
629
795
    If we're only generating deltas for the sake of filtering against
630
796
    file-ids, we stop generating deltas once all file-ids reach the
631
797
    appropriate life-cycle point. If we're receiving data newest to
646
812
        if check_fileids and not fileid_set:
647
813
            return
648
814
        revisions = [rev[1] for rev in revs]
649
 
        deltas = repository.get_deltas_for_revisions(revisions)
650
815
        new_revs = []
651
 
        for rev, delta in izip(revs, deltas):
652
 
            if check_fileids:
653
 
                if not _delta_matches_fileids(delta, fileid_set, stop_on):
654
 
                    continue
655
 
                elif not always_delta:
656
 
                    # Delta was created just for matching - ditch it
657
 
                    # Note: It would probably be a better UI to return
658
 
                    # a delta filtered by the file-ids, rather than
659
 
                    # None at all. That functional enhancement can
660
 
                    # come later ...
661
 
                    delta = None
662
 
            new_revs.append((rev[0], rev[1], delta))
 
816
        if delta_type == 'full' and not check_fileids:
 
817
            deltas = repository.get_deltas_for_revisions(revisions)
 
818
            for rev, delta in izip(revs, deltas):
 
819
                new_revs.append((rev[0], rev[1], delta))
 
820
        else:
 
821
            deltas = repository.get_deltas_for_revisions(revisions, fileid_set)
 
822
            for rev, delta in izip(revs, deltas):
 
823
                if check_fileids:
 
824
                    if delta is None or not delta.has_changed():
 
825
                        continue
 
826
                    else:
 
827
                        _update_fileids(delta, fileid_set, stop_on)
 
828
                        if delta_type is None:
 
829
                            delta = None
 
830
                        elif delta_type == 'full':
 
831
                            # If the file matches all the time, rebuilding
 
832
                            # a full delta like this in addition to a partial
 
833
                            # one could be slow. However, it's likely that
 
834
                            # most revisions won't get this far, making it
 
835
                            # faster to filter on the partial deltas and
 
836
                            # build the occasional full delta than always
 
837
                            # building full deltas and filtering those.
 
838
                            rev_id = rev[0][0]
 
839
                            delta = repository.get_revision_delta(rev_id)
 
840
                new_revs.append((rev[0], rev[1], delta))
663
841
        yield new_revs
664
842
 
665
843
 
666
 
def _delta_matches_fileids(delta, fileids, stop_on='add'):
667
 
    """Check is a delta matches one of more file-ids.
 
844
def _update_fileids(delta, fileids, stop_on):
 
845
    """Update the set of file-ids to search based on file lifecycle events.
668
846
    
669
 
    :param fileids: a set of fileids to match against.
 
847
    :param fileids: a set of fileids to update
670
848
    :param stop_on: either 'add' or 'remove' - take file-ids out of the
671
849
      fileids set once their add or remove entry is detected respectively
672
850
    """
673
 
    if not fileids:
674
 
        return False
675
 
    result = False
676
 
    for item in delta.added:
677
 
        if item[1] in fileids:
678
 
            if stop_on == 'add':
679
 
                fileids.remove(item[1])
680
 
            result = True
681
 
    for item in delta.removed:
682
 
        if item[1] in fileids:
683
 
            if stop_on == 'delete':
684
 
                fileids.remove(item[1])
685
 
            result = True
686
 
    if result:
687
 
        return True
688
 
    for l in (delta.modified, delta.renamed, delta.kind_changed):
689
 
        for item in l:
690
 
            if item[1] in fileids:
691
 
                return True
692
 
    return False
 
851
    if stop_on == 'add':
 
852
        for item in delta.added:
 
853
            if item[1] in fileids:
 
854
                fileids.remove(item[1])
 
855
    elif stop_on == 'delete':
 
856
        for item in delta.removed:
 
857
            if item[1] in fileids:
 
858
                fileids.remove(item[1])
693
859
 
694
860
 
695
861
def _make_revision_objects(branch, generate_delta, search, log_rev_iterator):
739
905
def _get_revision_limits(branch, start_revision, end_revision):
740
906
    """Get and check revision limits.
741
907
 
742
 
    :param  branch: The branch containing the revisions. 
 
908
    :param  branch: The branch containing the revisions.
743
909
 
744
910
    :param  start_revision: The first revision to be logged.
745
911
            For backwards compatibility this may be a mainline integer revno,
788
954
 
789
955
def _get_mainline_revs(branch, start_revision, end_revision):
790
956
    """Get the mainline revisions from the branch.
791
 
    
 
957
 
792
958
    Generates the list of mainline revisions for the branch.
793
 
    
794
 
    :param  branch: The branch containing the revisions. 
 
959
 
 
960
    :param  branch: The branch containing the revisions.
795
961
 
796
962
    :param  start_revision: The first revision to be logged.
797
963
            For backwards compatibility this may be a mainline integer revno,
807
973
    if branch_revno == 0:
808
974
        return None, None, None, None
809
975
 
810
 
    # For mainline generation, map start_revision and end_revision to 
811
 
    # mainline revnos. If the revision is not on the mainline choose the 
812
 
    # appropriate extreme of the mainline instead - the extra will be 
 
976
    # For mainline generation, map start_revision and end_revision to
 
977
    # mainline revnos. If the revision is not on the mainline choose the
 
978
    # appropriate extreme of the mainline instead - the extra will be
813
979
    # filtered later.
814
980
    # Also map the revisions to rev_ids, to be used in the later filtering
815
981
    # stage.
871
1037
def _filter_revision_range(view_revisions, start_rev_id, end_rev_id):
872
1038
    """Filter view_revisions based on revision ranges.
873
1039
 
874
 
    :param view_revisions: A list of (revision_id, dotted_revno, merge_depth) 
 
1040
    :param view_revisions: A list of (revision_id, dotted_revno, merge_depth)
875
1041
            tuples to be filtered.
876
1042
 
877
1043
    :param start_rev_id: If not NONE specifies the first revision to be logged.
897
1063
                end_index = revision_ids.index(end_rev_id)
898
1064
            else:
899
1065
                end_index = len(view_revisions) - 1
900
 
        # To include the revisions merged into the last revision, 
 
1066
        # To include the revisions merged into the last revision,
901
1067
        # extend end_rev_id down to, but not including, the next rev
902
1068
        # with the same or lesser merge_depth
903
1069
        end_merge_depth = view_revisions[end_index][2]
954
1120
    # Lookup all possible text keys to determine which ones actually modified
955
1121
    # the file.
956
1122
    text_keys = [(file_id, rev_id) for rev_id, revno, depth in view_revisions]
 
1123
    next_keys = None
957
1124
    # Looking up keys in batches of 1000 can cut the time in half, as well as
958
1125
    # memory consumption. GraphIndex *does* like to look for a few keys in
959
1126
    # parallel, it just doesn't like looking for *lots* of keys in parallel.
1072
1239
    """A revision to be logged (by LogFormatter.log_revision).
1073
1240
 
1074
1241
    A simple wrapper for the attributes of a revision to be logged.
1075
 
    The attributes may or may not be populated, as determined by the 
 
1242
    The attributes may or may not be populated, as determined by the
1076
1243
    logging options and the log formatter capabilities.
1077
1244
    """
1078
1245
 
1094
1261
    If the LogFormatter needs to be informed of the beginning or end of
1095
1262
    a log it should implement the begin_log and/or end_log hook methods.
1096
1263
 
1097
 
    A LogFormatter should define the following supports_XXX flags 
 
1264
    A LogFormatter should define the following supports_XXX flags
1098
1265
    to indicate which LogRevision attributes it supports:
1099
1266
 
1100
1267
    - supports_delta must be True if this log formatter supports delta.
1101
1268
        Otherwise the delta attribute may not be populated.  The 'delta_format'
1102
1269
        attribute describes whether the 'short_status' format (1) or the long
1103
1270
        one (2) should be used.
1104
 
 
1105
 
    - supports_merge_revisions must be True if this log formatter supports 
1106
 
        merge revisions.  If not, and if supports_single_merge_revision is
1107
 
        also not True, then only mainline revisions will be passed to the 
1108
 
        formatter.
 
1271
 
 
1272
    - supports_merge_revisions must be True if this log formatter supports
 
1273
        merge revisions.  If not, then only mainline revisions will be passed
 
1274
        to the formatter.
1109
1275
 
1110
1276
    - preferred_levels is the number of levels this formatter defaults to.
1111
1277
        The default value is zero meaning display all levels.
1112
1278
        This value is only relevant if supports_merge_revisions is True.
1113
1279
 
1114
 
    - supports_single_merge_revision must be True if this log formatter
1115
 
        supports logging only a single merge revision.  This flag is
1116
 
        only relevant if supports_merge_revisions is not True.
1117
 
 
1118
1280
    - supports_tags must be True if this log formatter supports tags.
1119
1281
        Otherwise the tags attribute may not be populated.
1120
1282
 
1125
1287
    the properties_handler_registry. The registered function
1126
1288
    must respect the following interface description:
1127
1289
        def my_show_properties(properties_dict):
1128
 
            # code that returns a dict {'name':'value'} of the properties 
 
1290
            # code that returns a dict {'name':'value'} of the properties
1129
1291
            # to be shown
1130
1292
    """
1131
1293
    preferred_levels = 0
1132
1294
 
1133
1295
    def __init__(self, to_file, show_ids=False, show_timezone='original',
1134
 
                 delta_format=None, levels=None):
 
1296
            delta_format=None, levels=None, show_advice=False,
 
1297
            to_exact_file=None):
1135
1298
        """Create a LogFormatter.
1136
1299
 
1137
1300
        :param to_file: the file to output to
 
1301
        :param to_exact_file: if set, gives an output stream to which 
 
1302
             non-Unicode diffs are written.
1138
1303
        :param show_ids: if True, revision-ids are to be displayed
1139
1304
        :param show_timezone: the timezone to use
1140
1305
        :param delta_format: the level of delta information to display
1141
 
          or None to leave it u to the formatter to decide
 
1306
          or None to leave it to the formatter to decide
1142
1307
        :param levels: the number of levels to display; None or -1 to
1143
1308
          let the log formatter decide.
 
1309
        :param show_advice: whether to show advice at the end of the
 
1310
          log or not
1144
1311
        """
1145
1312
        self.to_file = to_file
 
1313
        # 'exact' stream used to show diff, it should print content 'as is'
 
1314
        # and should not try to decode/encode it to unicode to avoid bug #328007
 
1315
        if to_exact_file is not None:
 
1316
            self.to_exact_file = to_exact_file
 
1317
        else:
 
1318
            # XXX: somewhat hacky; this assumes it's a codec writer; it's better
 
1319
            # for code that expects to get diffs to pass in the exact file
 
1320
            # stream
 
1321
            self.to_exact_file = getattr(to_file, 'stream', to_file)
1146
1322
        self.show_ids = show_ids
1147
1323
        self.show_timezone = show_timezone
1148
1324
        if delta_format is None:
1150
1326
            delta_format = 2 # long format
1151
1327
        self.delta_format = delta_format
1152
1328
        self.levels = levels
 
1329
        self._show_advice = show_advice
 
1330
        self._merge_count = 0
1153
1331
 
1154
1332
    def get_levels(self):
1155
1333
        """Get the number of levels to display or 0 for all."""
1156
1334
        if getattr(self, 'supports_merge_revisions', False):
1157
1335
            if self.levels is None or self.levels == -1:
1158
 
                return self.preferred_levels
1159
 
            else:
1160
 
                return self.levels
1161
 
        return 1
 
1336
                self.levels = self.preferred_levels
 
1337
        else:
 
1338
            self.levels = 1
 
1339
        return self.levels
1162
1340
 
1163
1341
    def log_revision(self, revision):
1164
1342
        """Log a revision.
1167
1345
        """
1168
1346
        raise NotImplementedError('not implemented in abstract base')
1169
1347
 
 
1348
    def show_advice(self):
 
1349
        """Output user advice, if any, when the log is completed."""
 
1350
        if self._show_advice and self.levels == 1 and self._merge_count > 0:
 
1351
            advice_sep = self.get_advice_separator()
 
1352
            if advice_sep:
 
1353
                self.to_file.write(advice_sep)
 
1354
            self.to_file.write(
 
1355
                "Use --include-merges or -n0 to see merged revisions.\n")
 
1356
 
 
1357
    def get_advice_separator(self):
 
1358
        """Get the text separating the log from the closing advice."""
 
1359
        return ''
 
1360
 
1170
1361
    def short_committer(self, rev):
1171
1362
        name, address = config.parse_username(rev.committer)
1172
1363
        if name:
1174
1365
        return address
1175
1366
 
1176
1367
    def short_author(self, rev):
1177
 
        name, address = config.parse_username(rev.get_apparent_author())
 
1368
        name, address = config.parse_username(rev.get_apparent_authors()[0])
1178
1369
        if name:
1179
1370
            return name
1180
1371
        return address
1181
1372
 
 
1373
    def merge_marker(self, revision):
 
1374
        """Get the merge marker to include in the output or '' if none."""
 
1375
        if len(revision.rev.parent_ids) > 1:
 
1376
            self._merge_count += 1
 
1377
            return ' [merge]'
 
1378
        else:
 
1379
            return ''
 
1380
 
1182
1381
    def show_properties(self, revision, indent):
1183
1382
        """Displays the custom properties returned by each registered handler.
1184
 
        
1185
 
        If a registered handler raises an error it is propagated.
1186
 
        """
 
1383
 
 
1384
        If a registered handler raises an error it is propagated.
 
1385
        """
 
1386
        for line in self.custom_properties(revision):
 
1387
            self.to_file.write("%s%s\n" % (indent, line))
 
1388
 
 
1389
    def custom_properties(self, revision):
 
1390
        """Format the custom properties returned by each registered handler.
 
1391
 
 
1392
        If a registered handler raises an error it is propagated.
 
1393
 
 
1394
        :return: a list of formatted lines (excluding trailing newlines)
 
1395
        """
 
1396
        lines = self._foreign_info_properties(revision)
1187
1397
        for key, handler in properties_handler_registry.iteritems():
1188
 
            for key, value in handler(revision).items():
1189
 
                self.to_file.write(indent + key + ': ' + value + '\n')
 
1398
            lines.extend(self._format_properties(handler(revision)))
 
1399
        return lines
 
1400
 
 
1401
    def _foreign_info_properties(self, rev):
 
1402
        """Custom log displayer for foreign revision identifiers.
 
1403
 
 
1404
        :param rev: Revision object.
 
1405
        """
 
1406
        # Revision comes directly from a foreign repository
 
1407
        if isinstance(rev, foreign.ForeignRevision):
 
1408
            return rev.mapping.vcs.show_foreign_revid(rev.foreign_revid)
 
1409
 
 
1410
        # Imported foreign revision revision ids always contain :
 
1411
        if not ":" in rev.revision_id:
 
1412
            return []
 
1413
 
 
1414
        # Revision was once imported from a foreign repository
 
1415
        try:
 
1416
            foreign_revid, mapping = \
 
1417
                foreign.foreign_vcs_registry.parse_revision_id(rev.revision_id)
 
1418
        except errors.InvalidRevisionId:
 
1419
            return []
 
1420
 
 
1421
        return self._format_properties(
 
1422
            mapping.vcs.show_foreign_revid(foreign_revid))
 
1423
 
 
1424
    def _format_properties(self, properties):
 
1425
        lines = []
 
1426
        for key, value in properties.items():
 
1427
            lines.append(key + ': ' + value)
 
1428
        return lines
1190
1429
 
1191
1430
    def show_diff(self, to_file, diff, indent):
1192
1431
        for l in diff.rstrip().split('\n'):
1193
1432
            to_file.write(indent + '%s\n' % (l,))
1194
1433
 
1195
1434
 
 
1435
# Separator between revisions in long format
 
1436
_LONG_SEP = '-' * 60
 
1437
 
 
1438
 
1196
1439
class LongLogFormatter(LogFormatter):
1197
1440
 
1198
1441
    supports_merge_revisions = True
 
1442
    preferred_levels = 1
1199
1443
    supports_delta = True
1200
1444
    supports_tags = True
1201
1445
    supports_diff = True
1202
1446
 
 
1447
    def __init__(self, *args, **kwargs):
 
1448
        super(LongLogFormatter, self).__init__(*args, **kwargs)
 
1449
        if self.show_timezone == 'original':
 
1450
            self.date_string = self._date_string_original_timezone
 
1451
        else:
 
1452
            self.date_string = self._date_string_with_timezone
 
1453
 
 
1454
    def _date_string_with_timezone(self, rev):
 
1455
        return format_date(rev.timestamp, rev.timezone or 0,
 
1456
                           self.show_timezone)
 
1457
 
 
1458
    def _date_string_original_timezone(self, rev):
 
1459
        return format_date_with_offset_in_original_timezone(rev.timestamp,
 
1460
            rev.timezone or 0)
 
1461
 
1203
1462
    def log_revision(self, revision):
1204
1463
        """Log a revision, either merged or not."""
1205
1464
        indent = '    ' * revision.merge_depth
1206
 
        to_file = self.to_file
1207
 
        to_file.write(indent + '-' * 60 + '\n')
 
1465
        lines = [_LONG_SEP]
1208
1466
        if revision.revno is not None:
1209
 
            to_file.write(indent + 'revno: %s\n' % (revision.revno,))
 
1467
            lines.append('revno: %s%s' % (revision.revno,
 
1468
                self.merge_marker(revision)))
1210
1469
        if revision.tags:
1211
 
            to_file.write(indent + 'tags: %s\n' % (', '.join(revision.tags)))
 
1470
            lines.append('tags: %s' % (', '.join(revision.tags)))
1212
1471
        if self.show_ids:
1213
 
            to_file.write(indent + 'revision-id: ' + revision.rev.revision_id)
1214
 
            to_file.write('\n')
 
1472
            lines.append('revision-id: %s' % (revision.rev.revision_id,))
1215
1473
            for parent_id in revision.rev.parent_ids:
1216
 
                to_file.write(indent + 'parent: %s\n' % (parent_id,))
1217
 
        self.show_properties(revision.rev, indent)
 
1474
                lines.append('parent: %s' % (parent_id,))
 
1475
        lines.extend(self.custom_properties(revision.rev))
1218
1476
 
1219
 
        author = revision.rev.properties.get('author', None)
1220
 
        if author is not None:
1221
 
            to_file.write(indent + 'author: %s\n' % (author,))
1222
 
        to_file.write(indent + 'committer: %s\n' % (revision.rev.committer,))
 
1477
        committer = revision.rev.committer
 
1478
        authors = revision.rev.get_apparent_authors()
 
1479
        if authors != [committer]:
 
1480
            lines.append('author: %s' % (", ".join(authors),))
 
1481
        lines.append('committer: %s' % (committer,))
1223
1482
 
1224
1483
        branch_nick = revision.rev.properties.get('branch-nick', None)
1225
1484
        if branch_nick is not None:
1226
 
            to_file.write(indent + 'branch nick: %s\n' % (branch_nick,))
1227
 
 
1228
 
        date_str = format_date(revision.rev.timestamp,
1229
 
                               revision.rev.timezone or 0,
1230
 
                               self.show_timezone)
1231
 
        to_file.write(indent + 'timestamp: %s\n' % (date_str,))
1232
 
 
1233
 
        to_file.write(indent + 'message:\n')
 
1485
            lines.append('branch nick: %s' % (branch_nick,))
 
1486
 
 
1487
        lines.append('timestamp: %s' % (self.date_string(revision.rev),))
 
1488
 
 
1489
        lines.append('message:')
1234
1490
        if not revision.rev.message:
1235
 
            to_file.write(indent + '  (no message)\n')
 
1491
            lines.append('  (no message)')
1236
1492
        else:
1237
1493
            message = revision.rev.message.rstrip('\r\n')
1238
1494
            for l in message.split('\n'):
1239
 
                to_file.write(indent + '  %s\n' % (l,))
 
1495
                lines.append('  %s' % (l,))
 
1496
 
 
1497
        # Dump the output, appending the delta and diff if requested
 
1498
        to_file = self.to_file
 
1499
        to_file.write("%s%s\n" % (indent, ('\n' + indent).join(lines)))
1240
1500
        if revision.delta is not None:
1241
1501
            # We don't respect delta_format for compatibility
1242
1502
            revision.delta.show(to_file, self.show_ids, indent=indent,
1243
1503
                                short_status=False)
1244
1504
        if revision.diff is not None:
1245
1505
            to_file.write(indent + 'diff:\n')
 
1506
            to_file.flush()
1246
1507
            # Note: we explicitly don't indent the diff (relative to the
1247
1508
            # revision information) so that the output can be fed to patch -p0
1248
 
            self.show_diff(to_file, revision.diff, indent)
 
1509
            self.show_diff(self.to_exact_file, revision.diff, indent)
 
1510
            self.to_exact_file.flush()
 
1511
 
 
1512
    def get_advice_separator(self):
 
1513
        """Get the text separating the log from the closing advice."""
 
1514
        return '-' * 60 + '\n'
1249
1515
 
1250
1516
 
1251
1517
class ShortLogFormatter(LogFormatter):
1281
1547
        offset = ' ' * (revno_width + 1)
1282
1548
 
1283
1549
        to_file = self.to_file
1284
 
        is_merge = ''
1285
 
        if len(revision.rev.parent_ids) > 1:
1286
 
            is_merge = ' [merge]'
1287
1550
        tags = ''
1288
1551
        if revision.tags:
1289
1552
            tags = ' {%s}' % (', '.join(revision.tags))
1293
1556
                            revision.rev.timezone or 0,
1294
1557
                            self.show_timezone, date_fmt="%Y-%m-%d",
1295
1558
                            show_offset=False),
1296
 
                tags, is_merge))
 
1559
                tags, self.merge_marker(revision)))
1297
1560
        self.show_properties(revision.rev, indent+offset)
1298
1561
        if self.show_ids:
1299
1562
            to_file.write(indent + offset + 'revision-id:%s\n'
1309
1572
            revision.delta.show(to_file, self.show_ids, indent=indent + offset,
1310
1573
                                short_status=self.delta_format==1)
1311
1574
        if revision.diff is not None:
1312
 
            self.show_diff(to_file, revision.diff, '      ')
 
1575
            self.show_diff(self.to_exact_file, revision.diff, '      ')
1313
1576
        to_file.write('\n')
1314
1577
 
1315
1578
 
1321
1584
 
1322
1585
    def __init__(self, *args, **kwargs):
1323
1586
        super(LineLogFormatter, self).__init__(*args, **kwargs)
1324
 
        self._max_chars = terminal_width() - 1
 
1587
        width = terminal_width()
 
1588
        if width is not None:
 
1589
            # we need one extra space for terminals that wrap on last char
 
1590
            width = width - 1
 
1591
        self._max_chars = width
1325
1592
 
1326
1593
    def truncate(self, str, max_len):
1327
 
        if len(str) <= max_len:
 
1594
        if max_len is None or len(str) <= max_len:
1328
1595
            return str
1329
 
        return str[:max_len-3]+'...'
 
1596
        return str[:max_len-3] + '...'
1330
1597
 
1331
1598
    def date_string(self, rev):
1332
1599
        return format_date(rev.timestamp, rev.timezone or 0,
1370
1637
        return self.truncate(prefix + " ".join(out).rstrip('\n'), max_chars)
1371
1638
 
1372
1639
 
 
1640
class GnuChangelogLogFormatter(LogFormatter):
 
1641
 
 
1642
    supports_merge_revisions = True
 
1643
    supports_delta = True
 
1644
 
 
1645
    def log_revision(self, revision):
 
1646
        """Log a revision, either merged or not."""
 
1647
        to_file = self.to_file
 
1648
 
 
1649
        date_str = format_date(revision.rev.timestamp,
 
1650
                               revision.rev.timezone or 0,
 
1651
                               self.show_timezone,
 
1652
                               date_fmt='%Y-%m-%d',
 
1653
                               show_offset=False)
 
1654
        committer_str = revision.rev.committer.replace (' <', '  <')
 
1655
        to_file.write('%s  %s\n\n' % (date_str,committer_str))
 
1656
 
 
1657
        if revision.delta is not None and revision.delta.has_changed():
 
1658
            for c in revision.delta.added + revision.delta.removed + revision.delta.modified:
 
1659
                path, = c[:1]
 
1660
                to_file.write('\t* %s:\n' % (path,))
 
1661
            for c in revision.delta.renamed:
 
1662
                oldpath,newpath = c[:2]
 
1663
                # For renamed files, show both the old and the new path
 
1664
                to_file.write('\t* %s:\n\t* %s:\n' % (oldpath,newpath))
 
1665
            to_file.write('\n')
 
1666
 
 
1667
        if not revision.rev.message:
 
1668
            to_file.write('\tNo commit message\n')
 
1669
        else:
 
1670
            message = revision.rev.message.rstrip('\r\n')
 
1671
            for l in message.split('\n'):
 
1672
                to_file.write('\t%s\n' % (l.lstrip(),))
 
1673
            to_file.write('\n')
 
1674
 
 
1675
 
1373
1676
def line_log(rev, max_chars):
1374
1677
    lf = LineLogFormatter(None)
1375
1678
    return lf.log_string(None, rev, max_chars)
1399
1702
                                'Detailed log format')
1400
1703
log_formatter_registry.register('line', LineLogFormatter,
1401
1704
                                'Log format with one line per revision')
 
1705
log_formatter_registry.register('gnu-changelog', GnuChangelogLogFormatter,
 
1706
                                'Format used by GNU ChangeLog files')
1402
1707
 
1403
1708
 
1404
1709
def register_formatter(name, formatter):
1573
1878
        lf.log_revision(lr)
1574
1879
 
1575
1880
 
1576
 
def _get_fileid_to_log(revision, tree, b, fp):
1577
 
    """Find the file-id to log for a file path in a revision range.
1578
 
 
1579
 
    :param revision: the revision range as parsed on the command line
1580
 
    :param tree: the working tree, if any
1581
 
    :param b: the branch
1582
 
    :param fp: file path
 
1881
def _get_info_for_log_files(revisionspec_list, file_list):
 
1882
    """Find file-ids and kinds given a list of files and a revision range.
 
1883
 
 
1884
    We search for files at the end of the range. If not found there,
 
1885
    we try the start of the range.
 
1886
 
 
1887
    :param revisionspec_list: revision range as parsed on the command line
 
1888
    :param file_list: the list of paths given on the command line;
 
1889
      the first of these can be a branch location or a file path,
 
1890
      the remainder must be file paths
 
1891
    :return: (branch, info_list, start_rev_info, end_rev_info) where
 
1892
      info_list is a list of (relative_path, file_id, kind) tuples where
 
1893
      kind is one of values 'directory', 'file', 'symlink', 'tree-reference'.
 
1894
      branch will be read-locked.
1583
1895
    """
1584
 
    if revision is None:
 
1896
    from builtins import _get_revision_range, safe_relpath_files
 
1897
    tree, b, path = bzrdir.BzrDir.open_containing_tree_or_branch(file_list[0])
 
1898
    b.lock_read()
 
1899
    # XXX: It's damn messy converting a list of paths to relative paths when
 
1900
    # those paths might be deleted ones, they might be on a case-insensitive
 
1901
    # filesystem and/or they might be in silly locations (like another branch).
 
1902
    # For example, what should "log bzr://branch/dir/file1 file2" do? (Is
 
1903
    # file2 implicitly in the same dir as file1 or should its directory be
 
1904
    # taken from the current tree somehow?) For now, this solves the common
 
1905
    # case of running log in a nested directory, assuming paths beyond the
 
1906
    # first one haven't been deleted ...
 
1907
    if tree:
 
1908
        relpaths = [path] + safe_relpath_files(tree, file_list[1:])
 
1909
    else:
 
1910
        relpaths = [path] + file_list[1:]
 
1911
    info_list = []
 
1912
    start_rev_info, end_rev_info = _get_revision_range(revisionspec_list, b,
 
1913
        "log")
 
1914
    if relpaths in ([], [u'']):
 
1915
        return b, [], start_rev_info, end_rev_info
 
1916
    if start_rev_info is None and end_rev_info is None:
1585
1917
        if tree is None:
1586
1918
            tree = b.basis_tree()
1587
 
        file_id = tree.path2id(fp)
1588
 
        if file_id is None:
1589
 
            # go back to when time began
1590
 
            try:
1591
 
                rev1 = b.get_rev_id(1)
1592
 
            except errors.NoSuchRevision:
1593
 
                # No history at all
1594
 
                file_id = None
1595
 
            else:
1596
 
                tree = b.repository.revision_tree(rev1)
1597
 
                file_id = tree.path2id(fp)
 
1919
        tree1 = None
 
1920
        for fp in relpaths:
 
1921
            file_id = tree.path2id(fp)
 
1922
            kind = _get_kind_for_file_id(tree, file_id)
 
1923
            if file_id is None:
 
1924
                # go back to when time began
 
1925
                if tree1 is None:
 
1926
                    try:
 
1927
                        rev1 = b.get_rev_id(1)
 
1928
                    except errors.NoSuchRevision:
 
1929
                        # No history at all
 
1930
                        file_id = None
 
1931
                        kind = None
 
1932
                    else:
 
1933
                        tree1 = b.repository.revision_tree(rev1)
 
1934
                if tree1:
 
1935
                    file_id = tree1.path2id(fp)
 
1936
                    kind = _get_kind_for_file_id(tree1, file_id)
 
1937
            info_list.append((fp, file_id, kind))
1598
1938
 
1599
 
    elif len(revision) == 1:
 
1939
    elif start_rev_info == end_rev_info:
1600
1940
        # One revision given - file must exist in it
1601
 
        tree = revision[0].as_tree(b)
1602
 
        file_id = tree.path2id(fp)
 
1941
        tree = b.repository.revision_tree(end_rev_info.rev_id)
 
1942
        for fp in relpaths:
 
1943
            file_id = tree.path2id(fp)
 
1944
            kind = _get_kind_for_file_id(tree, file_id)
 
1945
            info_list.append((fp, file_id, kind))
1603
1946
 
1604
 
    elif len(revision) == 2:
 
1947
    else:
1605
1948
        # Revision range given. Get the file-id from the end tree.
1606
1949
        # If that fails, try the start tree.
1607
 
        rev_id = revision[1].as_revision_id(b)
 
1950
        rev_id = end_rev_info.rev_id
1608
1951
        if rev_id is None:
1609
1952
            tree = b.basis_tree()
1610
1953
        else:
1611
 
            tree = revision[1].as_tree(b)
1612
 
        file_id = tree.path2id(fp)
1613
 
        if file_id is None:
1614
 
            rev_id = revision[0].as_revision_id(b)
1615
 
            if rev_id is None:
1616
 
                rev1 = b.get_rev_id(1)
1617
 
                tree = b.repository.revision_tree(rev1)
1618
 
            else:
1619
 
                tree = revision[0].as_tree(b)
 
1954
            tree = b.repository.revision_tree(rev_id)
 
1955
        tree1 = None
 
1956
        for fp in relpaths:
1620
1957
            file_id = tree.path2id(fp)
 
1958
            kind = _get_kind_for_file_id(tree, file_id)
 
1959
            if file_id is None:
 
1960
                if tree1 is None:
 
1961
                    rev_id = start_rev_info.rev_id
 
1962
                    if rev_id is None:
 
1963
                        rev1 = b.get_rev_id(1)
 
1964
                        tree1 = b.repository.revision_tree(rev1)
 
1965
                    else:
 
1966
                        tree1 = b.repository.revision_tree(rev_id)
 
1967
                file_id = tree1.path2id(fp)
 
1968
                kind = _get_kind_for_file_id(tree1, file_id)
 
1969
            info_list.append((fp, file_id, kind))
 
1970
    return b, info_list, start_rev_info, end_rev_info
 
1971
 
 
1972
 
 
1973
def _get_kind_for_file_id(tree, file_id):
 
1974
    """Return the kind of a file-id or None if it doesn't exist."""
 
1975
    if file_id is not None:
 
1976
        return tree.kind(file_id)
1621
1977
    else:
1622
 
        raise errors.BzrCommandError(
1623
 
            'bzr log --revision takes one or two values.')
1624
 
    return file_id
 
1978
        return None
1625
1979
 
1626
1980
 
1627
1981
properties_handler_registry = registry.Registry()
1628
 
properties_handler_registry.register_lazy("foreign",
1629
 
                                          "bzrlib.foreign",
1630
 
                                          "show_foreign_properties")
 
1982
 
 
1983
# Use the properties handlers to print out bug information if available
 
1984
def _bugs_properties_handler(revision):
 
1985
    if revision.properties.has_key('bugs'):
 
1986
        bug_lines = revision.properties['bugs'].split('\n')
 
1987
        bug_rows = [line.split(' ', 1) for line in bug_lines]
 
1988
        fixed_bug_urls = [row[0] for row in bug_rows if
 
1989
                          len(row) > 1 and row[1] == 'fixed']
 
1990
        
 
1991
        if fixed_bug_urls:
 
1992
            return {'fixes bug(s)': ' '.join(fixed_bug_urls)}
 
1993
    return {}
 
1994
 
 
1995
properties_handler_registry.register('bugs_properties_handler',
 
1996
                                     _bugs_properties_handler)
1631
1997
 
1632
1998
 
1633
1999
# adapters which revision ids to log are filtered. When log is called, the