/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/log.py

  • Committer: Ian Clatworthy
  • Date: 2008-07-17 00:41:25 UTC
  • mto: This revision was merged to the branch mainline in revision 3545.
  • Revision ID: ian.clatworthy@canonical.com-20080717004125-xqq4jhlh9ldxgg7a
fix how cog.py is invoked on Windows (Mark Hammond)

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
# Copyright (C) 2005, 2006, 2007 Canonical Ltd
 
2
#
 
3
# This program is free software; you can redistribute it and/or modify
 
4
# it under the terms of the GNU General Public License as published by
 
5
# the Free Software Foundation; either version 2 of the License, or
 
6
# (at your option) any later version.
 
7
#
 
8
# This program is distributed in the hope that it will be useful,
 
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
 
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
11
# GNU General Public License for more details.
 
12
#
 
13
# You should have received a copy of the GNU General Public License
 
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
 
16
 
 
17
 
 
18
 
 
19
"""Code to show logs of changes.
 
20
 
 
21
Various flavors of log can be produced:
 
22
 
 
23
* for one file, or the whole tree, and (not done yet) for
 
24
  files in a given directory
 
25
 
 
26
* in "verbose" mode with a description of what changed from one
 
27
  version to the next
 
28
 
 
29
* with file-ids and revision-ids shown
 
30
 
 
31
Logs are actually written out through an abstract LogFormatter
 
32
interface, which allows for different preferred formats.  Plugins can
 
33
register formats too.
 
34
 
 
35
Logs can be produced in either forward (oldest->newest) or reverse
 
36
(newest->oldest) order.
 
37
 
 
38
Logs can be filtered to show only revisions matching a particular
 
39
search string, or within a particular range of revisions.  The range
 
40
can be given as date/times, which are reduced to revisions before
 
41
calling in here.
 
42
 
 
43
In verbose mode we show a summary of what changed in each particular
 
44
revision.  Note that this is the delta for changes in that revision
 
45
relative to its left-most parent, not the delta relative to the last
 
46
logged revision.  So for example if you ask for a verbose log of
 
47
changes touching hello.c you will get a list of those revisions also
 
48
listing other things that were changed in the same revision, but not
 
49
all the changes since the previous revision that touched hello.c.
 
50
"""
 
51
 
 
52
import codecs
 
53
from itertools import (
 
54
    izip,
 
55
    )
 
56
import re
 
57
import sys
 
58
from warnings import (
 
59
    warn,
 
60
    )
 
61
 
 
62
from bzrlib import (
 
63
    config,
 
64
    lazy_regex,
 
65
    registry,
 
66
    )
 
67
from bzrlib.errors import (
 
68
    BzrCommandError,
 
69
    )
 
70
from bzrlib.osutils import (
 
71
    format_date,
 
72
    get_terminal_encoding,
 
73
    terminal_width,
 
74
    )
 
75
from bzrlib.repository import _strip_NULL_ghosts
 
76
from bzrlib.revision import (
 
77
    NULL_REVISION,
 
78
    )
 
79
from bzrlib.revisionspec import (
 
80
    RevisionInfo,
 
81
    )
 
82
from bzrlib.trace import mutter
 
83
from bzrlib.tsort import (
 
84
    merge_sort,
 
85
    topo_sort,
 
86
    )
 
87
 
 
88
 
 
89
def find_touching_revisions(branch, file_id):
 
90
    """Yield a description of revisions which affect the file_id.
 
91
 
 
92
    Each returned element is (revno, revision_id, description)
 
93
 
 
94
    This is the list of revisions where the file is either added,
 
95
    modified, renamed or deleted.
 
96
 
 
97
    TODO: Perhaps some way to limit this to only particular revisions,
 
98
    or to traverse a non-mainline set of revisions?
 
99
    """
 
100
    last_ie = None
 
101
    last_path = None
 
102
    revno = 1
 
103
    for revision_id in branch.revision_history():
 
104
        this_inv = branch.repository.get_revision_inventory(revision_id)
 
105
        if file_id in this_inv:
 
106
            this_ie = this_inv[file_id]
 
107
            this_path = this_inv.id2path(file_id)
 
108
        else:
 
109
            this_ie = this_path = None
 
110
 
 
111
        # now we know how it was last time, and how it is in this revision.
 
112
        # are those two states effectively the same or not?
 
113
 
 
114
        if not this_ie and not last_ie:
 
115
            # not present in either
 
116
            pass
 
117
        elif this_ie and not last_ie:
 
118
            yield revno, revision_id, "added " + this_path
 
119
        elif not this_ie and last_ie:
 
120
            # deleted here
 
121
            yield revno, revision_id, "deleted " + last_path
 
122
        elif this_path != last_path:
 
123
            yield revno, revision_id, ("renamed %s => %s" % (last_path, this_path))
 
124
        elif (this_ie.text_size != last_ie.text_size
 
125
              or this_ie.text_sha1 != last_ie.text_sha1):
 
126
            yield revno, revision_id, "modified " + this_path
 
127
 
 
128
        last_ie = this_ie
 
129
        last_path = this_path
 
130
        revno += 1
 
131
 
 
132
 
 
133
def _enumerate_history(branch):
 
134
    rh = []
 
135
    revno = 1
 
136
    for rev_id in branch.revision_history():
 
137
        rh.append((revno, rev_id))
 
138
        revno += 1
 
139
    return rh
 
140
 
 
141
 
 
142
def show_log(branch,
 
143
             lf,
 
144
             specific_fileid=None,
 
145
             verbose=False,
 
146
             direction='reverse',
 
147
             start_revision=None,
 
148
             end_revision=None,
 
149
             search=None,
 
150
             limit=None):
 
151
    """Write out human-readable log of commits to this branch.
 
152
 
 
153
    lf
 
154
        LogFormatter object to show the output.
 
155
 
 
156
    specific_fileid
 
157
        If true, list only the commits affecting the specified
 
158
        file, rather than all commits.
 
159
 
 
160
    verbose
 
161
        If true show added/changed/deleted/renamed files.
 
162
 
 
163
    direction
 
164
        'reverse' (default) is latest to earliest;
 
165
        'forward' is earliest to latest.
 
166
 
 
167
    start_revision
 
168
        If not None, only show revisions >= start_revision
 
169
 
 
170
    end_revision
 
171
        If not None, only show revisions <= end_revision
 
172
 
 
173
    search
 
174
        If not None, only show revisions with matching commit messages
 
175
 
 
176
    limit
 
177
        If not None or 0, only show limit revisions
 
178
    """
 
179
    branch.lock_read()
 
180
    try:
 
181
        if getattr(lf, 'begin_log', None):
 
182
            lf.begin_log()
 
183
 
 
184
        _show_log(branch, lf, specific_fileid, verbose, direction,
 
185
                  start_revision, end_revision, search, limit)
 
186
 
 
187
        if getattr(lf, 'end_log', None):
 
188
            lf.end_log()
 
189
    finally:
 
190
        branch.unlock()
 
191
 
 
192
 
 
193
def _show_log(branch,
 
194
             lf,
 
195
             specific_fileid=None,
 
196
             verbose=False,
 
197
             direction='reverse',
 
198
             start_revision=None,
 
199
             end_revision=None,
 
200
             search=None,
 
201
             limit=None):
 
202
    """Worker function for show_log - see show_log."""
 
203
    if not isinstance(lf, LogFormatter):
 
204
        warn("not a LogFormatter instance: %r" % lf)
 
205
 
 
206
    if specific_fileid:
 
207
        mutter('get log for file_id %r', specific_fileid)
 
208
    generate_merge_revisions = getattr(lf, 'supports_merge_revisions', False)
 
209
    allow_single_merge_revision = getattr(lf,
 
210
        'supports_single_merge_revision', False)
 
211
    view_revisions = calculate_view_revisions(branch, start_revision,
 
212
                                              end_revision, direction,
 
213
                                              specific_fileid,
 
214
                                              generate_merge_revisions,
 
215
                                              allow_single_merge_revision)
 
216
    if search is not None:
 
217
        searchRE = re.compile(search, re.IGNORECASE)
 
218
    else:
 
219
        searchRE = None
 
220
 
 
221
    rev_tag_dict = {}
 
222
    generate_tags = getattr(lf, 'supports_tags', False)
 
223
    if generate_tags:
 
224
        if branch.supports_tags():
 
225
            rev_tag_dict = branch.tags.get_reverse_tag_dict()
 
226
 
 
227
    generate_delta = verbose and getattr(lf, 'supports_delta', False)
 
228
 
 
229
    # now we just print all the revisions
 
230
    log_count = 0
 
231
    for (rev_id, revno, merge_depth), rev, delta in _iter_revisions(
 
232
        branch.repository, view_revisions, generate_delta):
 
233
        if searchRE:
 
234
            if not searchRE.search(rev.message):
 
235
                continue
 
236
 
 
237
        lr = LogRevision(rev, revno, merge_depth, delta,
 
238
                         rev_tag_dict.get(rev_id))
 
239
        lf.log_revision(lr)
 
240
        if limit:
 
241
            log_count += 1
 
242
            if log_count >= limit:
 
243
                break
 
244
 
 
245
 
 
246
def calculate_view_revisions(branch, start_revision, end_revision, direction,
 
247
                             specific_fileid, generate_merge_revisions,
 
248
                             allow_single_merge_revision):
 
249
    if (not generate_merge_revisions and start_revision is end_revision is
 
250
        None and direction == 'reverse' and specific_fileid is None):
 
251
        return _linear_view_revisions(branch)
 
252
 
 
253
    mainline_revs, rev_nos, start_rev_id, end_rev_id = \
 
254
        _get_mainline_revs(branch, start_revision, end_revision)
 
255
    if not mainline_revs:
 
256
        return []
 
257
 
 
258
    if direction == 'reverse':
 
259
        start_rev_id, end_rev_id = end_rev_id, start_rev_id
 
260
 
 
261
    generate_single_revision = False
 
262
    if ((not generate_merge_revisions)
 
263
        and ((start_rev_id and (start_rev_id not in rev_nos))
 
264
            or (end_rev_id and (end_rev_id not in rev_nos)))):
 
265
        generate_single_revision = ((start_rev_id == end_rev_id)
 
266
            and allow_single_merge_revision)
 
267
        if not generate_single_revision:
 
268
            raise BzrCommandError('Selected log formatter only supports '
 
269
                'mainline revisions.')
 
270
        generate_merge_revisions = generate_single_revision
 
271
    view_revs_iter = get_view_revisions(mainline_revs, rev_nos, branch,
 
272
                          direction, include_merges=generate_merge_revisions)
 
273
    view_revisions = _filter_revision_range(list(view_revs_iter),
 
274
                                            start_rev_id,
 
275
                                            end_rev_id)
 
276
    if view_revisions and generate_single_revision:
 
277
        view_revisions = view_revisions[0:1]
 
278
    if specific_fileid:
 
279
        view_revisions = _filter_revisions_touching_file_id(branch,
 
280
                                                         specific_fileid,
 
281
                                                         mainline_revs,
 
282
                                                         view_revisions)
 
283
 
 
284
    # rebase merge_depth - unless there are no revisions or 
 
285
    # either the first or last revision have merge_depth = 0.
 
286
    if view_revisions and view_revisions[0][2] and view_revisions[-1][2]:
 
287
        min_depth = min([d for r,n,d in view_revisions])
 
288
        if min_depth != 0:
 
289
            view_revisions = [(r,n,d-min_depth) for r,n,d in view_revisions]
 
290
    return view_revisions
 
291
 
 
292
 
 
293
def _linear_view_revisions(branch):
 
294
    start_revno, start_revision_id = branch.last_revision_info()
 
295
    repo = branch.repository
 
296
    revision_ids = repo.iter_reverse_revision_history(start_revision_id)
 
297
    for num, revision_id in enumerate(revision_ids):
 
298
        yield revision_id, str(start_revno - num), 0
 
299
 
 
300
 
 
301
def _iter_revisions(repository, view_revisions, generate_delta):
 
302
    num = 9
 
303
    view_revisions = iter(view_revisions)
 
304
    while True:
 
305
        cur_view_revisions = [d for x, d in zip(range(num), view_revisions)]
 
306
        if len(cur_view_revisions) == 0:
 
307
            break
 
308
        cur_deltas = {}
 
309
        # r = revision, n = revno, d = merge depth
 
310
        revision_ids = [r for (r, n, d) in cur_view_revisions]
 
311
        revisions = repository.get_revisions(revision_ids)
 
312
        if generate_delta:
 
313
            deltas = repository.get_deltas_for_revisions(revisions)
 
314
            cur_deltas = dict(izip((r.revision_id for r in revisions),
 
315
                                   deltas))
 
316
        for view_data, revision in izip(cur_view_revisions, revisions):
 
317
            yield view_data, revision, cur_deltas.get(revision.revision_id)
 
318
        num = min(int(num * 1.5), 200)
 
319
 
 
320
 
 
321
def _get_mainline_revs(branch, start_revision, end_revision):
 
322
    """Get the mainline revisions from the branch.
 
323
    
 
324
    Generates the list of mainline revisions for the branch.
 
325
    
 
326
    :param  branch: The branch containing the revisions. 
 
327
 
 
328
    :param  start_revision: The first revision to be logged.
 
329
            For backwards compatibility this may be a mainline integer revno,
 
330
            but for merge revision support a RevisionInfo is expected.
 
331
 
 
332
    :param  end_revision: The last revision to be logged.
 
333
            For backwards compatibility this may be a mainline integer revno,
 
334
            but for merge revision support a RevisionInfo is expected.
 
335
 
 
336
    :return: A (mainline_revs, rev_nos, start_rev_id, end_rev_id) tuple.
 
337
    """
 
338
    branch_revno, branch_last_revision = branch.last_revision_info()
 
339
    if branch_revno == 0:
 
340
        return None, None, None, None
 
341
 
 
342
    # For mainline generation, map start_revision and end_revision to 
 
343
    # mainline revnos. If the revision is not on the mainline choose the 
 
344
    # appropriate extreme of the mainline instead - the extra will be 
 
345
    # filtered later.
 
346
    # Also map the revisions to rev_ids, to be used in the later filtering
 
347
    # stage.
 
348
    start_rev_id = None 
 
349
    if start_revision is None:
 
350
        start_revno = 1
 
351
    else:
 
352
        if isinstance(start_revision, RevisionInfo):
 
353
            start_rev_id = start_revision.rev_id
 
354
            start_revno = start_revision.revno or 1
 
355
        else:
 
356
            branch.check_real_revno(start_revision)
 
357
            start_revno = start_revision
 
358
    
 
359
    end_rev_id = None
 
360
    if end_revision is None:
 
361
        end_revno = branch_revno
 
362
    else:
 
363
        if isinstance(end_revision, RevisionInfo):
 
364
            end_rev_id = end_revision.rev_id
 
365
            end_revno = end_revision.revno or branch_revno
 
366
        else:
 
367
            branch.check_real_revno(end_revision)
 
368
            end_revno = end_revision
 
369
 
 
370
    if ((start_rev_id == NULL_REVISION)
 
371
        or (end_rev_id == NULL_REVISION)):
 
372
        raise BzrCommandError('Logging revision 0 is invalid.')
 
373
    if start_revno > end_revno:
 
374
        raise BzrCommandError("Start revision must be older than "
 
375
                              "the end revision.")
 
376
 
 
377
    if end_revno < start_revno:
 
378
        return None, None, None, None
 
379
    cur_revno = branch_revno
 
380
    rev_nos = {}
 
381
    mainline_revs = []
 
382
    for revision_id in branch.repository.iter_reverse_revision_history(
 
383
                        branch_last_revision):
 
384
        if cur_revno < start_revno:
 
385
            # We have gone far enough, but we always add 1 more revision
 
386
            rev_nos[revision_id] = cur_revno
 
387
            mainline_revs.append(revision_id)
 
388
            break
 
389
        if cur_revno <= end_revno:
 
390
            rev_nos[revision_id] = cur_revno
 
391
            mainline_revs.append(revision_id)
 
392
        cur_revno -= 1
 
393
    else:
 
394
        # We walked off the edge of all revisions, so we add a 'None' marker
 
395
        mainline_revs.append(None)
 
396
 
 
397
    mainline_revs.reverse()
 
398
 
 
399
    # override the mainline to look like the revision history.
 
400
    return mainline_revs, rev_nos, start_rev_id, end_rev_id
 
401
 
 
402
 
 
403
def _filter_revision_range(view_revisions, start_rev_id, end_rev_id):
 
404
    """Filter view_revisions based on revision ranges.
 
405
 
 
406
    :param view_revisions: A list of (revision_id, dotted_revno, merge_depth) 
 
407
            tuples to be filtered.
 
408
 
 
409
    :param start_rev_id: If not NONE specifies the first revision to be logged.
 
410
            If NONE then all revisions up to the end_rev_id are logged.
 
411
 
 
412
    :param end_rev_id: If not NONE specifies the last revision to be logged.
 
413
            If NONE then all revisions up to the end of the log are logged.
 
414
 
 
415
    :return: The filtered view_revisions.
 
416
    """
 
417
    if start_rev_id or end_rev_id: 
 
418
        revision_ids = [r for r, n, d in view_revisions]
 
419
        if start_rev_id:
 
420
            start_index = revision_ids.index(start_rev_id)
 
421
        else:
 
422
            start_index = 0
 
423
        if start_rev_id == end_rev_id:
 
424
            end_index = start_index
 
425
        else:
 
426
            if end_rev_id:
 
427
                end_index = revision_ids.index(end_rev_id)
 
428
            else:
 
429
                end_index = len(view_revisions) - 1
 
430
        # To include the revisions merged into the last revision, 
 
431
        # extend end_rev_id down to, but not including, the next rev
 
432
        # with the same or lesser merge_depth
 
433
        end_merge_depth = view_revisions[end_index][2]
 
434
        try:
 
435
            for index in xrange(end_index+1, len(view_revisions)+1):
 
436
                if view_revisions[index][2] <= end_merge_depth:
 
437
                    end_index = index - 1
 
438
                    break
 
439
        except IndexError:
 
440
            # if the search falls off the end then log to the end as well
 
441
            end_index = len(view_revisions) - 1
 
442
        view_revisions = view_revisions[start_index:end_index+1]
 
443
    return view_revisions
 
444
 
 
445
 
 
446
def _filter_revisions_touching_file_id(branch, file_id, mainline_revisions,
 
447
                                       view_revs_iter):
 
448
    """Return the list of revision ids which touch a given file id.
 
449
 
 
450
    The function filters view_revisions and returns a subset.
 
451
    This includes the revisions which directly change the file id,
 
452
    and the revisions which merge these changes. So if the
 
453
    revision graph is::
 
454
        A
 
455
        |\
 
456
        B C
 
457
        |/
 
458
        D
 
459
 
 
460
    And 'C' changes a file, then both C and D will be returned.
 
461
 
 
462
    This will also can be restricted based on a subset of the mainline.
 
463
 
 
464
    :return: A list of (revision_id, dotted_revno, merge_depth) tuples.
 
465
    """
 
466
    # find all the revisions that change the specific file
 
467
    # build the ancestry of each revision in the graph
 
468
    # - only listing the ancestors that change the specific file.
 
469
    graph = branch.repository.get_graph()
 
470
    # This asks for all mainline revisions, which means we only have to spider
 
471
    # sideways, rather than depth history. That said, its still size-of-history
 
472
    # and should be addressed.
 
473
    # mainline_revisions always includes an extra revision at the beginning, so
 
474
    # don't request it.
 
475
    parent_map = dict(((key, value) for key, value in
 
476
        graph.iter_ancestry(mainline_revisions[1:]) if value is not None))
 
477
    sorted_rev_list = topo_sort(parent_map.items())
 
478
    text_keys = [(file_id, rev_id) for rev_id in sorted_rev_list]
 
479
    modified_text_versions = branch.repository.texts.get_parent_map(text_keys)
 
480
    ancestry = {}
 
481
    for rev in sorted_rev_list:
 
482
        text_key = (file_id, rev)
 
483
        parents = parent_map[rev]
 
484
        if text_key not in modified_text_versions and len(parents) == 1:
 
485
            # We will not be adding anything new, so just use a reference to
 
486
            # the parent ancestry.
 
487
            rev_ancestry = ancestry[parents[0]]
 
488
        else:
 
489
            rev_ancestry = set()
 
490
            if text_key in modified_text_versions:
 
491
                rev_ancestry.add(rev)
 
492
            for parent in parents:
 
493
                if parent not in ancestry:
 
494
                    # parent is a Ghost, which won't be present in
 
495
                    # sorted_rev_list, but we may access it later, so create an
 
496
                    # empty node for it
 
497
                    ancestry[parent] = set()
 
498
                rev_ancestry = rev_ancestry.union(ancestry[parent])
 
499
        ancestry[rev] = rev_ancestry
 
500
 
 
501
    def is_merging_rev(r):
 
502
        parents = parent_map[r]
 
503
        if len(parents) > 1:
 
504
            leftparent = parents[0]
 
505
            for rightparent in parents[1:]:
 
506
                if not ancestry[leftparent].issuperset(
 
507
                        ancestry[rightparent]):
 
508
                    return True
 
509
        return False
 
510
 
 
511
    # filter from the view the revisions that did not change or merge 
 
512
    # the specific file
 
513
    return [(r, n, d) for r, n, d in view_revs_iter
 
514
            if (file_id, r) in modified_text_versions or is_merging_rev(r)]
 
515
 
 
516
 
 
517
def get_view_revisions(mainline_revs, rev_nos, branch, direction,
 
518
                       include_merges=True):
 
519
    """Produce an iterator of revisions to show
 
520
    :return: an iterator of (revision_id, revno, merge_depth)
 
521
    (if there is no revno for a revision, None is supplied)
 
522
    """
 
523
    if include_merges is False:
 
524
        revision_ids = mainline_revs[1:]
 
525
        if direction == 'reverse':
 
526
            revision_ids.reverse()
 
527
        for revision_id in revision_ids:
 
528
            yield revision_id, str(rev_nos[revision_id]), 0
 
529
        return
 
530
    graph = branch.repository.get_graph()
 
531
    # This asks for all mainline revisions, which means we only have to spider
 
532
    # sideways, rather than depth history. That said, its still size-of-history
 
533
    # and should be addressed.
 
534
    # mainline_revisions always includes an extra revision at the beginning, so
 
535
    # don't request it.
 
536
    parent_map = dict(((key, value) for key, value in
 
537
        graph.iter_ancestry(mainline_revs[1:]) if value is not None))
 
538
    # filter out ghosts; merge_sort errors on ghosts.
 
539
    rev_graph = _strip_NULL_ghosts(parent_map)
 
540
    merge_sorted_revisions = merge_sort(
 
541
        rev_graph,
 
542
        mainline_revs[-1],
 
543
        mainline_revs,
 
544
        generate_revno=True)
 
545
 
 
546
    if direction == 'forward':
 
547
        # forward means oldest first.
 
548
        merge_sorted_revisions = reverse_by_depth(merge_sorted_revisions)
 
549
    elif direction != 'reverse':
 
550
        raise ValueError('invalid direction %r' % direction)
 
551
 
 
552
    for sequence, rev_id, merge_depth, revno, end_of_merge in merge_sorted_revisions:
 
553
        yield rev_id, '.'.join(map(str, revno)), merge_depth
 
554
 
 
555
 
 
556
def reverse_by_depth(merge_sorted_revisions, _depth=0):
 
557
    """Reverse revisions by depth.
 
558
 
 
559
    Revisions with a different depth are sorted as a group with the previous
 
560
    revision of that depth.  There may be no topological justification for this,
 
561
    but it looks much nicer.
 
562
    """
 
563
    zd_revisions = []
 
564
    for val in merge_sorted_revisions:
 
565
        if val[2] == _depth:
 
566
            zd_revisions.append([val])
 
567
        else:
 
568
            zd_revisions[-1].append(val)
 
569
    for revisions in zd_revisions:
 
570
        if len(revisions) > 1:
 
571
            revisions[1:] = reverse_by_depth(revisions[1:], _depth + 1)
 
572
    zd_revisions.reverse()
 
573
    result = []
 
574
    for chunk in zd_revisions:
 
575
        result.extend(chunk)
 
576
    return result
 
577
 
 
578
 
 
579
class LogRevision(object):
 
580
    """A revision to be logged (by LogFormatter.log_revision).
 
581
 
 
582
    A simple wrapper for the attributes of a revision to be logged.
 
583
    The attributes may or may not be populated, as determined by the 
 
584
    logging options and the log formatter capabilities.
 
585
    """
 
586
 
 
587
    def __init__(self, rev=None, revno=None, merge_depth=0, delta=None,
 
588
                 tags=None):
 
589
        self.rev = rev
 
590
        self.revno = revno
 
591
        self.merge_depth = merge_depth
 
592
        self.delta = delta
 
593
        self.tags = tags
 
594
 
 
595
 
 
596
class LogFormatter(object):
 
597
    """Abstract class to display log messages.
 
598
 
 
599
    At a minimum, a derived class must implement the log_revision method.
 
600
 
 
601
    If the LogFormatter needs to be informed of the beginning or end of
 
602
    a log it should implement the begin_log and/or end_log hook methods.
 
603
 
 
604
    A LogFormatter should define the following supports_XXX flags 
 
605
    to indicate which LogRevision attributes it supports:
 
606
 
 
607
    - supports_delta must be True if this log formatter supports delta.
 
608
        Otherwise the delta attribute may not be populated.
 
609
    - supports_merge_revisions must be True if this log formatter supports 
 
610
        merge revisions.  If not, and if supports_single_merge_revisions is
 
611
        also not True, then only mainline revisions will be passed to the 
 
612
        formatter.
 
613
    - supports_single_merge_revision must be True if this log formatter
 
614
        supports logging only a single merge revision.  This flag is
 
615
        only relevant if supports_merge_revisions is not True.
 
616
    - supports_tags must be True if this log formatter supports tags.
 
617
        Otherwise the tags attribute may not be populated.
 
618
    """
 
619
 
 
620
    def __init__(self, to_file, show_ids=False, show_timezone='original'):
 
621
        self.to_file = to_file
 
622
        self.show_ids = show_ids
 
623
        self.show_timezone = show_timezone
 
624
 
 
625
# TODO: uncomment this block after show() has been removed.
 
626
# Until then defining log_revision would prevent _show_log calling show() 
 
627
# in legacy formatters.
 
628
#    def log_revision(self, revision):
 
629
#        """Log a revision.
 
630
#
 
631
#        :param  revision:   The LogRevision to be logged.
 
632
#        """
 
633
#        raise NotImplementedError('not implemented in abstract base')
 
634
 
 
635
    def short_committer(self, rev):
 
636
        name, address = config.parse_username(rev.committer)
 
637
        if name:
 
638
            return name
 
639
        return address
 
640
 
 
641
    def short_author(self, rev):
 
642
        name, address = config.parse_username(rev.get_apparent_author())
 
643
        if name:
 
644
            return name
 
645
        return address
 
646
 
 
647
 
 
648
class LongLogFormatter(LogFormatter):
 
649
 
 
650
    supports_merge_revisions = True
 
651
    supports_delta = True
 
652
    supports_tags = True
 
653
 
 
654
    def log_revision(self, revision):
 
655
        """Log a revision, either merged or not."""
 
656
        indent = '    ' * revision.merge_depth
 
657
        to_file = self.to_file
 
658
        to_file.write(indent + '-' * 60 + '\n')
 
659
        if revision.revno is not None:
 
660
            to_file.write(indent + 'revno: %s\n' % (revision.revno,))
 
661
        if revision.tags:
 
662
            to_file.write(indent + 'tags: %s\n' % (', '.join(revision.tags)))
 
663
        if self.show_ids:
 
664
            to_file.write(indent + 'revision-id: ' + revision.rev.revision_id)
 
665
            to_file.write('\n')
 
666
            for parent_id in revision.rev.parent_ids:
 
667
                to_file.write(indent + 'parent: %s\n' % (parent_id,))
 
668
 
 
669
        author = revision.rev.properties.get('author', None)
 
670
        if author is not None:
 
671
            to_file.write(indent + 'author: %s\n' % (author,))
 
672
        to_file.write(indent + 'committer: %s\n' % (revision.rev.committer,))
 
673
 
 
674
        branch_nick = revision.rev.properties.get('branch-nick', None)
 
675
        if branch_nick is not None:
 
676
            to_file.write(indent + 'branch nick: %s\n' % (branch_nick,))
 
677
 
 
678
        date_str = format_date(revision.rev.timestamp,
 
679
                               revision.rev.timezone or 0,
 
680
                               self.show_timezone)
 
681
        to_file.write(indent + 'timestamp: %s\n' % (date_str,))
 
682
 
 
683
        to_file.write(indent + 'message:\n')
 
684
        if not revision.rev.message:
 
685
            to_file.write(indent + '  (no message)\n')
 
686
        else:
 
687
            message = revision.rev.message.rstrip('\r\n')
 
688
            for l in message.split('\n'):
 
689
                to_file.write(indent + '  %s\n' % (l,))
 
690
        if revision.delta is not None:
 
691
            revision.delta.show(to_file, self.show_ids, indent=indent)
 
692
 
 
693
 
 
694
class ShortLogFormatter(LogFormatter):
 
695
 
 
696
    supports_delta = True
 
697
    supports_single_merge_revision = True
 
698
 
 
699
    def log_revision(self, revision):
 
700
        to_file = self.to_file
 
701
        is_merge = ''
 
702
        if len(revision.rev.parent_ids) > 1:
 
703
            is_merge = ' [merge]'
 
704
        to_file.write("%5s %s\t%s%s\n" % (revision.revno,
 
705
                self.short_author(revision.rev),
 
706
                format_date(revision.rev.timestamp,
 
707
                            revision.rev.timezone or 0,
 
708
                            self.show_timezone, date_fmt="%Y-%m-%d",
 
709
                            show_offset=False),
 
710
                is_merge))
 
711
        if self.show_ids:
 
712
            to_file.write('      revision-id:%s\n' % (revision.rev.revision_id,))
 
713
        if not revision.rev.message:
 
714
            to_file.write('      (no message)\n')
 
715
        else:
 
716
            message = revision.rev.message.rstrip('\r\n')
 
717
            for l in message.split('\n'):
 
718
                to_file.write('      %s\n' % (l,))
 
719
 
 
720
        # TODO: Why not show the modified files in a shorter form as
 
721
        # well? rewrap them single lines of appropriate length
 
722
        if revision.delta is not None:
 
723
            revision.delta.show(to_file, self.show_ids)
 
724
        to_file.write('\n')
 
725
 
 
726
 
 
727
class LineLogFormatter(LogFormatter):
 
728
 
 
729
    supports_single_merge_revision = True
 
730
 
 
731
    def __init__(self, *args, **kwargs):
 
732
        super(LineLogFormatter, self).__init__(*args, **kwargs)
 
733
        self._max_chars = terminal_width() - 1
 
734
 
 
735
    def truncate(self, str, max_len):
 
736
        if len(str) <= max_len:
 
737
            return str
 
738
        return str[:max_len-3]+'...'
 
739
 
 
740
    def date_string(self, rev):
 
741
        return format_date(rev.timestamp, rev.timezone or 0, 
 
742
                           self.show_timezone, date_fmt="%Y-%m-%d",
 
743
                           show_offset=False)
 
744
 
 
745
    def message(self, rev):
 
746
        if not rev.message:
 
747
            return '(no message)'
 
748
        else:
 
749
            return rev.message
 
750
 
 
751
    def log_revision(self, revision):
 
752
        self.to_file.write(self.log_string(revision.revno, revision.rev,
 
753
                                              self._max_chars))
 
754
        self.to_file.write('\n')
 
755
 
 
756
    def log_string(self, revno, rev, max_chars):
 
757
        """Format log info into one string. Truncate tail of string
 
758
        :param  revno:      revision number (int) or None.
 
759
                            Revision numbers counts from 1.
 
760
        :param  rev:        revision info object
 
761
        :param  max_chars:  maximum length of resulting string
 
762
        :return:            formatted truncated string
 
763
        """
 
764
        out = []
 
765
        if revno:
 
766
            # show revno only when is not None
 
767
            out.append("%s:" % revno)
 
768
        out.append(self.truncate(self.short_author(rev), 20))
 
769
        out.append(self.date_string(rev))
 
770
        out.append(rev.get_summary())
 
771
        return self.truncate(" ".join(out).rstrip('\n'), max_chars)
 
772
 
 
773
 
 
774
def line_log(rev, max_chars):
 
775
    lf = LineLogFormatter(None)
 
776
    return lf.log_string(None, rev, max_chars)
 
777
 
 
778
 
 
779
class LogFormatterRegistry(registry.Registry):
 
780
    """Registry for log formatters"""
 
781
 
 
782
    def make_formatter(self, name, *args, **kwargs):
 
783
        """Construct a formatter from arguments.
 
784
 
 
785
        :param name: Name of the formatter to construct.  'short', 'long' and
 
786
            'line' are built-in.
 
787
        """
 
788
        return self.get(name)(*args, **kwargs)
 
789
 
 
790
    def get_default(self, branch):
 
791
        return self.get(branch.get_config().log_format())
 
792
 
 
793
 
 
794
log_formatter_registry = LogFormatterRegistry()
 
795
 
 
796
 
 
797
log_formatter_registry.register('short', ShortLogFormatter,
 
798
                                'Moderately short log format')
 
799
log_formatter_registry.register('long', LongLogFormatter,
 
800
                                'Detailed log format')
 
801
log_formatter_registry.register('line', LineLogFormatter,
 
802
                                'Log format with one line per revision')
 
803
 
 
804
 
 
805
def register_formatter(name, formatter):
 
806
    log_formatter_registry.register(name, formatter)
 
807
 
 
808
 
 
809
def log_formatter(name, *args, **kwargs):
 
810
    """Construct a formatter from arguments.
 
811
 
 
812
    name -- Name of the formatter to construct; currently 'long', 'short' and
 
813
        'line' are supported.
 
814
    """
 
815
    try:
 
816
        return log_formatter_registry.make_formatter(name, *args, **kwargs)
 
817
    except KeyError:
 
818
        raise BzrCommandError("unknown log formatter: %r" % name)
 
819
 
 
820
 
 
821
def show_one_log(revno, rev, delta, verbose, to_file, show_timezone):
 
822
    # deprecated; for compatibility
 
823
    lf = LongLogFormatter(to_file=to_file, show_timezone=show_timezone)
 
824
    lf.show(revno, rev, delta)
 
825
 
 
826
 
 
827
def show_changed_revisions(branch, old_rh, new_rh, to_file=None,
 
828
                           log_format='long'):
 
829
    """Show the change in revision history comparing the old revision history to the new one.
 
830
 
 
831
    :param branch: The branch where the revisions exist
 
832
    :param old_rh: The old revision history
 
833
    :param new_rh: The new revision history
 
834
    :param to_file: A file to write the results to. If None, stdout will be used
 
835
    """
 
836
    if to_file is None:
 
837
        to_file = codecs.getwriter(get_terminal_encoding())(sys.stdout,
 
838
            errors='replace')
 
839
    lf = log_formatter(log_format,
 
840
                       show_ids=False,
 
841
                       to_file=to_file,
 
842
                       show_timezone='original')
 
843
 
 
844
    # This is the first index which is different between
 
845
    # old and new
 
846
    base_idx = None
 
847
    for i in xrange(max(len(new_rh),
 
848
                        len(old_rh))):
 
849
        if (len(new_rh) <= i
 
850
            or len(old_rh) <= i
 
851
            or new_rh[i] != old_rh[i]):
 
852
            base_idx = i
 
853
            break
 
854
 
 
855
    if base_idx is None:
 
856
        to_file.write('Nothing seems to have changed\n')
 
857
        return
 
858
    ## TODO: It might be nice to do something like show_log
 
859
    ##       and show the merged entries. But since this is the
 
860
    ##       removed revisions, it shouldn't be as important
 
861
    if base_idx < len(old_rh):
 
862
        to_file.write('*'*60)
 
863
        to_file.write('\nRemoved Revisions:\n')
 
864
        for i in range(base_idx, len(old_rh)):
 
865
            rev = branch.repository.get_revision(old_rh[i])
 
866
            lr = LogRevision(rev, i+1, 0, None)
 
867
            lf.log_revision(lr)
 
868
        to_file.write('*'*60)
 
869
        to_file.write('\n\n')
 
870
    if base_idx < len(new_rh):
 
871
        to_file.write('Added Revisions:\n')
 
872
        show_log(branch,
 
873
                 lf,
 
874
                 None,
 
875
                 verbose=False,
 
876
                 direction='forward',
 
877
                 start_revision=base_idx+1,
 
878
                 end_revision=len(new_rh),
 
879
                 search=None)
 
880