/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar
2359.1.1 by Kent Gibson
Fix ``bzr log <file>`` so it only logs the revisions that changed the file, and does it faster.
1
# Copyright (C) 2005, 2006, 2007 Canonical Ltd
1887.1.1 by Adeodato Simó
Do not separate paragraphs in the copyright statement with blank lines,
2
#
369 by Martin Pool
- Split out log printing into new show_log function
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.
1887.1.1 by Adeodato Simó
Do not separate paragraphs in the copyright statement with blank lines,
7
#
369 by Martin Pool
- Split out log printing into new show_log function
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.
1887.1.1 by Adeodato Simó
Do not separate paragraphs in the copyright statement with blank lines,
12
#
369 by Martin Pool
- Split out log printing into new show_log function
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
375 by Martin Pool
- New command touching-revisions and function to trace
17
18
527 by Martin Pool
- refactor log command
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
974.1.26 by aaron.bentley at utoronto
merged mbp@sourcefrog.net-20050817233101-0939da1cf91f2472
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
2466.12.2 by Kent Gibson
shift log output with only merge revisions to the left margin
45
relative to its left-most parent, not the delta relative to the last
974.1.26 by aaron.bentley at utoronto
merged mbp@sourcefrog.net-20050817233101-0939da1cf91f2472
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.
527 by Martin Pool
- refactor log command
50
"""
51
2997.1.2 by Kent Gibson
Move all imports to top of log.py
52
import codecs
53
from itertools import (
54
    izip,
55
    )
1624.1.3 by Robert Collins
Convert log to use the new tsort.merge_sort routine.
56
import re
2997.1.2 by Kent Gibson
Move all imports to top of log.py
57
import sys
58
from warnings import (
59
    warn,
60
    )
1185.33.41 by Martin Pool
Fix regression of 'bzr log -v' - it wasn't showing changed files at all. (#4676)
61
2490.1.2 by John Arbash Meinel
Cleanup according to PEP8 and some other small whitespace fixes
62
from bzrlib import (
2221.4.10 by Aaron Bentley
Implement log options using RegistryOption
63
    registry,
64
    symbol_versioning,
2997.1.2 by Kent Gibson
Move all imports to top of log.py
65
    )
66
from bzrlib.errors import (
67
    BzrCommandError,
68
    )
69
from bzrlib.osutils import (
70
    format_date,
2997.1.3 by Alexander Belchenko
file wrapper around stdout should use terminal encoding, not user_encoding.
71
    get_terminal_encoding,
2997.1.2 by Kent Gibson
Move all imports to top of log.py
72
    terminal_width,
73
    )
2978.4.1 by Kent Gibson
Logging revision 0 returns error.
74
from bzrlib.revision import (
75
    NULL_REVISION,
76
    )
77
from bzrlib.revisionspec import (
78
    RevisionInfo,
2466.12.1 by Kent Gibson
Fix ``bzr log -r`` to support selecting merge revisions.
79
    )
2490.1.2 by John Arbash Meinel
Cleanup according to PEP8 and some other small whitespace fixes
80
from bzrlib.symbol_versioning import (
2466.8.1 by Kent Gibson
Reworked LogFormatter API to simplify extending the attributes of the revision being logged. Added support for begin_log() and end_log() hooks in LogFormatters.
81
    deprecated_method,
82
    zero_seventeen,
83
    )
1624.1.3 by Robert Collins
Convert log to use the new tsort.merge_sort routine.
84
from bzrlib.trace import mutter
2490.1.2 by John Arbash Meinel
Cleanup according to PEP8 and some other small whitespace fixes
85
from bzrlib.tsort import (
2359.1.2 by Kent Gibson
add logging of merge revisions
86
    merge_sort,
87
    topo_sort,
88
    )
974.1.26 by aaron.bentley at utoronto
merged mbp@sourcefrog.net-20050817233101-0939da1cf91f2472
89
375 by Martin Pool
- New command touching-revisions and function to trace
90
91
def find_touching_revisions(branch, file_id):
92
    """Yield a description of revisions which affect the file_id.
93
94
    Each returned element is (revno, revision_id, description)
95
96
    This is the list of revisions where the file is either added,
97
    modified, renamed or deleted.
98
99
    TODO: Perhaps some way to limit this to only particular revisions,
522 by Martin Pool
todo
100
    or to traverse a non-mainline set of revisions?
375 by Martin Pool
- New command touching-revisions and function to trace
101
    """
102
    last_ie = None
103
    last_path = None
104
    revno = 1
105
    for revision_id in branch.revision_history():
1185.67.2 by Aaron Bentley
Renamed Branch.storage to Branch.repository
106
        this_inv = branch.repository.get_revision_inventory(revision_id)
375 by Martin Pool
- New command touching-revisions and function to trace
107
        if file_id in this_inv:
108
            this_ie = this_inv[file_id]
109
            this_path = this_inv.id2path(file_id)
110
        else:
111
            this_ie = this_path = None
112
113
        # now we know how it was last time, and how it is in this revision.
114
        # are those two states effectively the same or not?
115
116
        if not this_ie and not last_ie:
117
            # not present in either
118
            pass
119
        elif this_ie and not last_ie:
120
            yield revno, revision_id, "added " + this_path
121
        elif not this_ie and last_ie:
122
            # deleted here
123
            yield revno, revision_id, "deleted " + last_path
124
        elif this_path != last_path:
125
            yield revno, revision_id, ("renamed %s => %s" % (last_path, this_path))
126
        elif (this_ie.text_size != last_ie.text_size
127
              or this_ie.text_sha1 != last_ie.text_sha1):
128
            yield revno, revision_id, "modified " + this_path
129
130
        last_ie = this_ie
131
        last_path = this_path
132
        revno += 1
133
134
974.1.26 by aaron.bentley at utoronto
merged mbp@sourcefrog.net-20050817233101-0939da1cf91f2472
135
def _enumerate_history(branch):
136
    rh = []
137
    revno = 1
138
    for rev_id in branch.revision_history():
139
        rh.append((revno, rev_id))
140
        revno += 1
141
    return rh
142
143
378 by Martin Pool
- New usage bzr log FILENAME
144
def show_log(branch,
794 by Martin Pool
- Merge John's nice short-log format.
145
             lf,
527 by Martin Pool
- refactor log command
146
             specific_fileid=None,
378 by Martin Pool
- New usage bzr log FILENAME
147
             verbose=False,
567 by Martin Pool
- New form 'bzr log -r FROM:TO'
148
             direction='reverse',
149
             start_revision=None,
900 by Martin Pool
- patch from john to search for matching commits
150
             end_revision=None,
2466.9.1 by Kent Gibson
add bzr log --limit
151
             search=None,
152
             limit=None):
369 by Martin Pool
- Split out log printing into new show_log function
153
    """Write out human-readable log of commits to this branch.
154
794 by Martin Pool
- Merge John's nice short-log format.
155
    lf
156
        LogFormatter object to show the output.
157
527 by Martin Pool
- refactor log command
158
    specific_fileid
378 by Martin Pool
- New usage bzr log FILENAME
159
        If true, list only the commits affecting the specified
160
        file, rather than all commits.
161
369 by Martin Pool
- Split out log printing into new show_log function
162
    verbose
163
        If true show added/changed/deleted/renamed files.
164
527 by Martin Pool
- refactor log command
165
    direction
166
        'reverse' (default) is latest to earliest;
167
        'forward' is earliest to latest.
567 by Martin Pool
- New form 'bzr log -r FROM:TO'
168
169
    start_revision
170
        If not None, only show revisions >= start_revision
171
172
    end_revision
173
        If not None, only show revisions <= end_revision
2466.9.1 by Kent Gibson
add bzr log --limit
174
175
    search
176
        If not None, only show revisions with matching commit messages
177
178
    limit
179
        If not None or 0, only show limit revisions
369 by Martin Pool
- Split out log printing into new show_log function
180
    """
1417.1.7 by Robert Collins
teach log it needs a read lock
181
    branch.lock_read()
182
    try:
2466.8.2 by Kent Gibson
Move begin/end calls from _show_log to show_log. Fix long line.
183
        if getattr(lf, 'begin_log', None):
184
            lf.begin_log()
185
1756.1.6 by Aaron Bentley
Revert locking fix
186
        _show_log(branch, lf, specific_fileid, verbose, direction,
2466.9.1 by Kent Gibson
add bzr log --limit
187
                  start_revision, end_revision, search, limit)
2466.8.2 by Kent Gibson
Move begin/end calls from _show_log to show_log. Fix long line.
188
189
        if getattr(lf, 'end_log', None):
190
            lf.end_log()
1417.1.7 by Robert Collins
teach log it needs a read lock
191
    finally:
192
        branch.unlock()
2490.1.2 by John Arbash Meinel
Cleanup according to PEP8 and some other small whitespace fixes
193
1417.1.7 by Robert Collins
teach log it needs a read lock
194
def _show_log(branch,
195
             lf,
196
             specific_fileid=None,
197
             verbose=False,
198
             direction='reverse',
199
             start_revision=None,
200
             end_revision=None,
2466.9.1 by Kent Gibson
add bzr log --limit
201
             search=None,
202
             limit=None):
1417.1.7 by Robert Collins
teach log it needs a read lock
203
    """Worker function for show_log - see show_log."""
794 by Martin Pool
- Merge John's nice short-log format.
204
    if not isinstance(lf, LogFormatter):
205
        warn("not a LogFormatter instance: %r" % lf)
533 by Martin Pool
- fix up asking for the log for the root of a remote branch
206
207
    if specific_fileid:
1185.31.4 by John Arbash Meinel
Fixing mutter() calls to not have to do string processing.
208
        mutter('get log for file_id %r', specific_fileid)
533 by Martin Pool
- fix up asking for the log for the root of a remote branch
209
900 by Martin Pool
- patch from john to search for matching commits
210
    if search is not None:
211
        searchRE = re.compile(search, re.IGNORECASE)
212
    else:
213
        searchRE = None
214
2466.12.1 by Kent Gibson
Fix ``bzr log -r`` to support selecting merge revisions.
215
    mainline_revs, rev_nos, start_rev_id, end_rev_id = \
216
        _get_mainline_revs(branch, start_revision, end_revision)
217
    if not mainline_revs:
1624.1.3 by Robert Collins
Convert log to use the new tsort.merge_sort routine.
218
        return
1756.2.18 by Aaron Bentley
Factor out the revision list generation
219
2466.12.1 by Kent Gibson
Fix ``bzr log -r`` to support selecting merge revisions.
220
    if direction == 'reverse':
221
        start_rev_id, end_rev_id = end_rev_id, start_rev_id
222
        
2490.1.2 by John Arbash Meinel
Cleanup according to PEP8 and some other small whitespace fixes
223
    legacy_lf = getattr(lf, 'log_revision', None) is None
2466.8.1 by Kent Gibson
Reworked LogFormatter API to simplify extending the attributes of the revision being logged. Added support for begin_log() and end_log() hooks in LogFormatters.
224
    if legacy_lf:
225
        # pre-0.17 formatters use show for mainline revisions.
226
        # how should we show merged revisions ?
227
        #   pre-0.11 api: show_merge
228
        #   0.11-0.16 api: show_merge_revno
229
        show_merge_revno = getattr(lf, 'show_merge_revno', None)
230
        show_merge = getattr(lf, 'show_merge', None)
231
        if show_merge is None and show_merge_revno is None:
232
            # no merged-revno support
233
            generate_merge_revisions = False
234
        else:
235
            generate_merge_revisions = True
1988.4.2 by Robert Collins
``bzr log`` Now shows dotted-decimal revision numbers for all revisions,
236
        # tell developers to update their code
2466.8.1 by Kent Gibson
Reworked LogFormatter API to simplify extending the attributes of the revision being logged. Added support for begin_log() and end_log() hooks in LogFormatters.
237
        symbol_versioning.warn('LogFormatters should provide log_revision '
238
            'instead of show and show_merge_revno since bzr 0.17.',
1988.4.2 by Robert Collins
``bzr log`` Now shows dotted-decimal revision numbers for all revisions,
239
            DeprecationWarning, stacklevel=3)
2466.8.1 by Kent Gibson
Reworked LogFormatter API to simplify extending the attributes of the revision being logged. Added support for begin_log() and end_log() hooks in LogFormatters.
240
    else:
241
        generate_merge_revisions = getattr(lf, 'supports_merge_revisions', 
242
                                           False)
2997.1.1 by Kent Gibson
Support logging single merge revisions with short and line log formatters.
243
    generate_single_revision = False
2985.1.1 by Aaron Bentley
Better behavior when user requests a log that cannot be viewed (Kent Gibson)
244
    if ((not generate_merge_revisions)
2978.3.2 by Kent Gibson
Use in rather than has_key
245
        and ((start_rev_id and (start_rev_id not in rev_nos))
246
            or (end_rev_id and (end_rev_id not in rev_nos)))):
2997.1.1 by Kent Gibson
Support logging single merge revisions with short and line log formatters.
247
        generate_single_revision = ((start_rev_id == end_rev_id)
248
            and getattr(lf, 'supports_single_merge_revision', False))
249
        if not generate_single_revision:
250
            raise BzrCommandError('Selected log formatter only supports '
251
                'mainline revisions.')
252
        generate_merge_revisions = generate_single_revision
2359.1.1 by Kent Gibson
Fix ``bzr log <file>`` so it only logs the revisions that changed the file, and does it faster.
253
    view_revs_iter = get_view_revisions(mainline_revs, rev_nos, branch,
2466.8.1 by Kent Gibson
Reworked LogFormatter API to simplify extending the attributes of the revision being logged. Added support for begin_log() and end_log() hooks in LogFormatters.
254
                          direction, include_merges=generate_merge_revisions)
2466.12.1 by Kent Gibson
Fix ``bzr log -r`` to support selecting merge revisions.
255
    view_revisions = _filter_revision_range(list(view_revs_iter),
256
                                            start_rev_id,
257
                                            end_rev_id)
2997.1.1 by Kent Gibson
Support logging single merge revisions with short and line log formatters.
258
    if view_revisions and generate_single_revision:
259
        view_revisions = view_revisions[0:1]
2359.1.1 by Kent Gibson
Fix ``bzr log <file>`` so it only logs the revisions that changed the file, and does it faster.
260
    if specific_fileid:
2466.12.1 by Kent Gibson
Fix ``bzr log -r`` to support selecting merge revisions.
261
        view_revisions = _filter_revisions_touching_file_id(branch,
2359.1.4 by John Arbash Meinel
Refactor the specific revisions for file id into a helper function.
262
                                                         specific_fileid,
263
                                                         mainline_revs,
2466.12.1 by Kent Gibson
Fix ``bzr log -r`` to support selecting merge revisions.
264
                                                         view_revisions)
2388.1.11 by Alexander Belchenko
changes after John's review
265
2466.12.2 by Kent Gibson
shift log output with only merge revisions to the left margin
266
    # rebase merge_depth - unless there are no revisions or 
267
    # either the first or last revision have merge_depth = 0.
268
    if view_revisions and view_revisions[0][2] and view_revisions[-1][2]:
2466.12.3 by Kent Gibson
Fix JAM's review comments for left align patch
269
        min_depth = min([d for r,n,d in view_revisions])
270
        if min_depth != 0:
2466.12.2 by Kent Gibson
shift log output with only merge revisions to the left margin
271
            view_revisions = [(r,n,d-min_depth) for r,n,d in view_revisions]
272
        
2466.8.1 by Kent Gibson
Reworked LogFormatter API to simplify extending the attributes of the revision being logged. Added support for begin_log() and end_log() hooks in LogFormatters.
273
    rev_tag_dict = {}
274
    generate_tags = getattr(lf, 'supports_tags', False)
275
    if generate_tags:
2388.1.8 by Erik Bagfors
Redo based on input from Alexander
276
        if branch.supports_tags():
277
            rev_tag_dict = branch.tags.get_reverse_tag_dict()
2388.1.11 by Alexander Belchenko
changes after John's review
278
2466.8.1 by Kent Gibson
Reworked LogFormatter API to simplify extending the attributes of the revision being logged. Added support for begin_log() and end_log() hooks in LogFormatters.
279
    generate_delta = verbose and getattr(lf, 'supports_delta', False)
280
1756.2.13 by Aaron Bentley
Used scaled iterator to retrive revisions
281
    def iter_revisions():
1756.3.22 by Aaron Bentley
Tweaks from review
282
        # r = revision, n = revno, d = merge depth
1756.2.20 by Aaron Bentley
Optimize log formats that don't show merges
283
        revision_ids = [r for r, n, d in view_revisions]
1756.2.13 by Aaron Bentley
Used scaled iterator to retrive revisions
284
        num = 9
1756.3.22 by Aaron Bentley
Tweaks from review
285
        repository = branch.repository
1756.2.13 by Aaron Bentley
Used scaled iterator to retrive revisions
286
        while revision_ids:
1756.3.22 by Aaron Bentley
Tweaks from review
287
            cur_deltas = {}
288
            revisions = repository.get_revisions(revision_ids[:num])
2466.8.1 by Kent Gibson
Reworked LogFormatter API to simplify extending the attributes of the revision being logged. Added support for begin_log() and end_log() hooks in LogFormatters.
289
            if generate_delta:
2466.11.1 by Kent Gibson
Long log format reports deltas on merge revisions.
290
                deltas = repository.get_deltas_for_revisions(revisions)
291
                cur_deltas = dict(izip((r.revision_id for r in revisions),
292
                                       deltas))
1756.2.13 by Aaron Bentley
Used scaled iterator to retrive revisions
293
            for revision in revisions:
1756.3.3 by Aaron Bentley
More refactoring, introduce revision_trees.
294
                yield revision, cur_deltas.get(revision.revision_id)
1756.2.13 by Aaron Bentley
Used scaled iterator to retrive revisions
295
            revision_ids  = revision_ids[num:]
2359.1.2 by Kent Gibson
add logging of merge revisions
296
            num = min(int(num * 1.5), 200)
2466.8.1 by Kent Gibson
Reworked LogFormatter API to simplify extending the attributes of the revision being logged. Added support for begin_log() and end_log() hooks in LogFormatters.
297
1624.1.3 by Robert Collins
Convert log to use the new tsort.merge_sort routine.
298
    # now we just print all the revisions
2466.9.1 by Kent Gibson
add bzr log --limit
299
    log_count = 0
1756.3.2 by Aaron Bentley
Refactor revision_delta call
300
    for ((rev_id, revno, merge_depth), (rev, delta)) in \
1756.2.18 by Aaron Bentley
Factor out the revision list generation
301
         izip(view_revisions, iter_revisions()):
974.1.26 by aaron.bentley at utoronto
merged mbp@sourcefrog.net-20050817233101-0939da1cf91f2472
302
303
        if searchRE:
304
            if not searchRE.search(rev.message):
305
                continue
306
2466.8.1 by Kent Gibson
Reworked LogFormatter API to simplify extending the attributes of the revision being logged. Added support for begin_log() and end_log() hooks in LogFormatters.
307
        if not legacy_lf:
2490.1.2 by John Arbash Meinel
Cleanup according to PEP8 and some other small whitespace fixes
308
            lr = LogRevision(rev, revno, merge_depth, delta,
2466.8.2 by Kent Gibson
Move begin/end calls from _show_log to show_log. Fix long line.
309
                             rev_tag_dict.get(rev_id))
2466.8.1 by Kent Gibson
Reworked LogFormatter API to simplify extending the attributes of the revision being logged. Added support for begin_log() and end_log() hooks in LogFormatters.
310
            lf.log_revision(lr)
1756.2.20 by Aaron Bentley
Optimize log formats that don't show merges
311
        else:
2466.8.1 by Kent Gibson
Reworked LogFormatter API to simplify extending the attributes of the revision being logged. Added support for begin_log() and end_log() hooks in LogFormatters.
312
            # support for legacy (pre-0.17) LogFormatters
313
            if merge_depth == 0:
314
                if generate_tags:
315
                    lf.show(revno, rev, delta, rev_tag_dict.get(rev_id))
316
                else:
317
                    lf.show(revno, rev, delta)
1988.4.2 by Robert Collins
``bzr log`` Now shows dotted-decimal revision numbers for all revisions,
318
            else:
2466.8.1 by Kent Gibson
Reworked LogFormatter API to simplify extending the attributes of the revision being logged. Added support for begin_log() and end_log() hooks in LogFormatters.
319
                if show_merge_revno is None:
320
                    lf.show_merge(rev, merge_depth)
2388.1.8 by Erik Bagfors
Redo based on input from Alexander
321
                else:
2466.8.1 by Kent Gibson
Reworked LogFormatter API to simplify extending the attributes of the revision being logged. Added support for begin_log() and end_log() hooks in LogFormatters.
322
                    if generate_tags:
323
                        lf.show_merge_revno(rev, merge_depth, revno,
324
                                            rev_tag_dict.get(rev_id))
325
                    else:
326
                        lf.show_merge_revno(rev, merge_depth, revno)
2466.9.1 by Kent Gibson
add bzr log --limit
327
        if limit:
328
            log_count += 1
329
            if log_count >= limit:
330
                break
2466.8.1 by Kent Gibson
Reworked LogFormatter API to simplify extending the attributes of the revision being logged. Added support for begin_log() and end_log() hooks in LogFormatters.
331
530 by Martin Pool
- put back verbose log support for reversed logs
332
2466.12.1 by Kent Gibson
Fix ``bzr log -r`` to support selecting merge revisions.
333
def _get_mainline_revs(branch, start_revision, end_revision):
334
    """Get the mainline revisions from the branch.
335
    
336
    Generates the list of mainline revisions for the branch.
337
    
338
    :param  branch: The branch containing the revisions. 
339
340
    :param  start_revision: The first revision to be logged.
341
            For backwards compatibility this may be a mainline integer revno,
342
            but for merge revision support a RevisionInfo is expected.
343
344
    :param  end_revision: The last revision to be logged.
345
            For backwards compatibility this may be a mainline integer revno,
346
            but for merge revision support a RevisionInfo is expected.
347
348
    :return: A (mainline_revs, rev_nos, start_rev_id, end_rev_id) tuple.
349
    """
350
    which_revs = _enumerate_history(branch)
351
    if not which_revs:
352
        return None, None, None, None
353
354
    # For mainline generation, map start_revision and end_revision to 
355
    # mainline revnos. If the revision is not on the mainline choose the 
356
    # appropriate extreme of the mainline instead - the extra will be 
357
    # filtered later.
358
    # Also map the revisions to rev_ids, to be used in the later filtering
359
    # stage.
360
    start_rev_id = None 
361
    if start_revision is None:
362
        start_revno = 1
363
    else:
364
        if isinstance(start_revision,RevisionInfo):
365
            start_rev_id = start_revision.rev_id
366
            start_revno = start_revision.revno or 1
367
        else:
368
            branch.check_real_revno(start_revision)
369
            start_revno = start_revision
370
    
371
    end_rev_id = None
372
    if end_revision is None:
373
        end_revno = len(which_revs)
374
    else:
375
        if isinstance(end_revision,RevisionInfo):
376
            end_rev_id = end_revision.rev_id
377
            end_revno = end_revision.revno or len(which_revs)
378
        else:
379
            branch.check_real_revno(end_revision)
380
            end_revno = end_revision
381
2989.1.1 by Aaron Bentley
Merge Kent's revision 0 fix
382
    if ((start_rev_id == NULL_REVISION)
2978.4.1 by Kent Gibson
Logging revision 0 returns error.
383
        or (end_rev_id == NULL_REVISION)):
384
        raise BzrCommandError('Logging revision 0 is invalid.')
2466.12.1 by Kent Gibson
Fix ``bzr log -r`` to support selecting merge revisions.
385
    if start_revno > end_revno:
386
        raise BzrCommandError("Start revision must be older than "
387
                              "the end revision.")
388
389
    # list indexes are 0-based; revisions are 1-based
390
    cut_revs = which_revs[(start_revno-1):(end_revno)]
391
    if not cut_revs:
392
        return None, None, None, None
393
394
    # convert the revision history to a dictionary:
395
    rev_nos = dict((k, v) for v, k in cut_revs)
396
397
    # override the mainline to look like the revision history.
398
    mainline_revs = [revision_id for index, revision_id in cut_revs]
399
    if cut_revs[0][0] == 1:
400
        mainline_revs.insert(0, None)
401
    else:
402
        mainline_revs.insert(0, which_revs[start_revno-2][1])
403
    return mainline_revs, rev_nos, start_rev_id, end_rev_id
404
405
406
def _filter_revision_range(view_revisions, start_rev_id, end_rev_id):
407
    """Filter view_revisions based on revision ranges.
408
409
    :param view_revisions: A list of (revision_id, dotted_revno, merge_depth) 
410
            tuples to be filtered.
411
412
    :param start_rev_id: If not NONE specifies the first revision to be logged.
413
            If NONE then all revisions up to the end_rev_id are logged.
414
415
    :param end_rev_id: If not NONE specifies the last revision to be logged.
416
            If NONE then all revisions up to the end of the log are logged.
417
418
    :return: The filtered view_revisions.
419
    """
420
    if start_rev_id or end_rev_id: 
421
        revision_ids = [r for r, n, d in view_revisions]
422
        if start_rev_id:
423
            start_index = revision_ids.index(start_rev_id)
424
        else:
425
            start_index = 0
426
        if start_rev_id == end_rev_id:
427
            end_index = start_index
428
        else:
429
            if end_rev_id:
430
                end_index = revision_ids.index(end_rev_id)
431
            else:
432
                end_index = len(view_revisions) - 1
433
        # To include the revisions merged into the last revision, 
434
        # extend end_rev_id down to, but not including, the next rev
435
        # with the same or lesser merge_depth
436
        end_merge_depth = view_revisions[end_index][2]
437
        try:
438
            for index in xrange(end_index+1, len(view_revisions)+1):
439
                if view_revisions[index][2] <= end_merge_depth:
440
                    end_index = index - 1
441
                    break
442
        except IndexError:
443
            # if the search falls off the end then log to the end as well
444
            end_index = len(view_revisions) - 1
445
        view_revisions = view_revisions[start_index:end_index+1]
446
    return view_revisions
447
448
449
def _filter_revisions_touching_file_id(branch, file_id, mainline_revisions,
450
                                       view_revs_iter):
2359.1.4 by John Arbash Meinel
Refactor the specific revisions for file id into a helper function.
451
    """Return the list of revision ids which touch a given file id.
452
2466.12.1 by Kent Gibson
Fix ``bzr log -r`` to support selecting merge revisions.
453
    The function filters view_revisions and returns a subset.
2359.1.4 by John Arbash Meinel
Refactor the specific revisions for file id into a helper function.
454
    This includes the revisions which directly change the file id,
455
    and the revisions which merge these changes. So if the
456
    revision graph is::
457
        A
458
        |\
459
        B C
460
        |/
461
        D
462
463
    And 'C' changes a file, then both C and D will be returned.
464
465
    This will also can be restricted based on a subset of the mainline.
2359.1.8 by John Arbash Meinel
doc
466
467
    :return: A list of (revision_id, dotted_revno, merge_depth) tuples.
2359.1.4 by John Arbash Meinel
Refactor the specific revisions for file id into a helper function.
468
    """
469
    # find all the revisions that change the specific file
2359.1.5 by John Arbash Meinel
change some variable names to make the function a bit clearer.
470
    file_weave = branch.repository.weave_store.get_weave(file_id,
2359.1.4 by John Arbash Meinel
Refactor the specific revisions for file id into a helper function.
471
                branch.repository.get_transaction())
2359.1.5 by John Arbash Meinel
change some variable names to make the function a bit clearer.
472
    weave_modifed_revisions = set(file_weave.versions())
2359.1.4 by John Arbash Meinel
Refactor the specific revisions for file id into a helper function.
473
    # build the ancestry of each revision in the graph
474
    # - only listing the ancestors that change the specific file.
475
    rev_graph = branch.repository.get_revision_graph(mainline_revisions[-1])
476
    sorted_rev_list = topo_sort(rev_graph)
477
    ancestry = {}
478
    for rev in sorted_rev_list:
2359.1.9 by John Arbash Meinel
Only generate a new set when we need to. Drops 'bzr log NEWS' time from 22s => 8s
479
        parents = rev_graph[rev]
480
        if rev not in weave_modifed_revisions and len(parents) == 1:
481
            # We will not be adding anything new, so just use a reference to
482
            # the parent ancestry.
483
            rev_ancestry = ancestry[parents[0]]
484
        else:
485
            rev_ancestry = set()
486
            if rev in weave_modifed_revisions:
487
                rev_ancestry.add(rev)
488
            for parent in parents:
489
                rev_ancestry = rev_ancestry.union(ancestry[parent])
2359.1.4 by John Arbash Meinel
Refactor the specific revisions for file id into a helper function.
490
        ancestry[rev] = rev_ancestry
491
2359.1.5 by John Arbash Meinel
change some variable names to make the function a bit clearer.
492
    def is_merging_rev(r):
2359.1.4 by John Arbash Meinel
Refactor the specific revisions for file id into a helper function.
493
        parents = rev_graph[r]
494
        if len(parents) > 1:
495
            leftparent = parents[0]
496
            for rightparent in parents[1:]:
497
                if not ancestry[leftparent].issuperset(
498
                        ancestry[rightparent]):
499
                    return True
500
        return False
501
502
    # filter from the view the revisions that did not change or merge 
503
    # the specific file
504
    return [(r, n, d) for r, n, d in view_revs_iter
2359.1.5 by John Arbash Meinel
change some variable names to make the function a bit clearer.
505
            if r in weave_modifed_revisions or is_merging_rev(r)]
2359.1.4 by John Arbash Meinel
Refactor the specific revisions for file id into a helper function.
506
507
1756.2.20 by Aaron Bentley
Optimize log formats that don't show merges
508
def get_view_revisions(mainline_revs, rev_nos, branch, direction,
1756.2.22 by Aaron Bentley
Apply review comments
509
                       include_merges=True):
1756.2.18 by Aaron Bentley
Factor out the revision list generation
510
    """Produce an iterator of revisions to show
511
    :return: an iterator of (revision_id, revno, merge_depth)
512
    (if there is no revno for a revision, None is supplied)
513
    """
1756.2.22 by Aaron Bentley
Apply review comments
514
    if include_merges is False:
1756.2.20 by Aaron Bentley
Optimize log formats that don't show merges
515
        revision_ids = mainline_revs[1:]
516
        if direction == 'reverse':
517
            revision_ids.reverse()
518
        for revision_id in revision_ids:
1988.4.2 by Robert Collins
``bzr log`` Now shows dotted-decimal revision numbers for all revisions,
519
            yield revision_id, str(rev_nos[revision_id]), 0
1756.2.20 by Aaron Bentley
Optimize log formats that don't show merges
520
        return
1756.2.18 by Aaron Bentley
Factor out the revision list generation
521
    merge_sorted_revisions = merge_sort(
522
        branch.repository.get_revision_graph(mainline_revs[-1]),
523
        mainline_revs[-1],
1988.4.2 by Robert Collins
``bzr log`` Now shows dotted-decimal revision numbers for all revisions,
524
        mainline_revs,
525
        generate_revno=True)
1756.2.18 by Aaron Bentley
Factor out the revision list generation
526
527
    if direction == 'forward':
528
        # forward means oldest first.
1756.2.25 by Aaron Bentley
Sort revisions at each depth, instead of just mainline revisions.
529
        merge_sorted_revisions = reverse_by_depth(merge_sorted_revisions)
1756.2.18 by Aaron Bentley
Factor out the revision list generation
530
    elif direction != 'reverse':
531
        raise ValueError('invalid direction %r' % direction)
532
1988.4.2 by Robert Collins
``bzr log`` Now shows dotted-decimal revision numbers for all revisions,
533
    for sequence, rev_id, merge_depth, revno, end_of_merge in merge_sorted_revisions:
534
        yield rev_id, '.'.join(map(str, revno)), merge_depth
1756.2.18 by Aaron Bentley
Factor out the revision list generation
535
536
1756.2.25 by Aaron Bentley
Sort revisions at each depth, instead of just mainline revisions.
537
def reverse_by_depth(merge_sorted_revisions, _depth=0):
538
    """Reverse revisions by depth.
1756.2.24 by Aaron Bentley
Forward sorting shows merges under mainline revision
539
1756.2.25 by Aaron Bentley
Sort revisions at each depth, instead of just mainline revisions.
540
    Revisions with a different depth are sorted as a group with the previous
541
    revision of that depth.  There may be no topological justification for this,
1756.2.24 by Aaron Bentley
Forward sorting shows merges under mainline revision
542
    but it looks much nicer.
543
    """
544
    zd_revisions = []
545
    for val in merge_sorted_revisions:
1756.2.25 by Aaron Bentley
Sort revisions at each depth, instead of just mainline revisions.
546
        if val[2] == _depth:
1756.2.24 by Aaron Bentley
Forward sorting shows merges under mainline revision
547
            zd_revisions.append([val])
548
        else:
1756.2.25 by Aaron Bentley
Sort revisions at each depth, instead of just mainline revisions.
549
            assert val[2] > _depth
1756.2.24 by Aaron Bentley
Forward sorting shows merges under mainline revision
550
            zd_revisions[-1].append(val)
1756.2.25 by Aaron Bentley
Sort revisions at each depth, instead of just mainline revisions.
551
    for revisions in zd_revisions:
552
        if len(revisions) > 1:
553
            revisions[1:] = reverse_by_depth(revisions[1:], _depth + 1)
1756.2.24 by Aaron Bentley
Forward sorting shows merges under mainline revision
554
    zd_revisions.reverse()
555
    result = []
556
    for chunk in zd_revisions:
557
        result.extend(chunk)
558
    return result
559
560
2466.8.1 by Kent Gibson
Reworked LogFormatter API to simplify extending the attributes of the revision being logged. Added support for begin_log() and end_log() hooks in LogFormatters.
561
class LogRevision(object):
562
    """A revision to be logged (by LogFormatter.log_revision).
563
564
    A simple wrapper for the attributes of a revision to be logged.
565
    The attributes may or may not be populated, as determined by the 
566
    logging options and the log formatter capabilities.
567
    """
568
2490.1.2 by John Arbash Meinel
Cleanup according to PEP8 and some other small whitespace fixes
569
    def __init__(self, rev=None, revno=None, merge_depth=0, delta=None,
570
                 tags=None):
2466.8.1 by Kent Gibson
Reworked LogFormatter API to simplify extending the attributes of the revision being logged. Added support for begin_log() and end_log() hooks in LogFormatters.
571
        self.rev = rev
572
        self.revno = revno
573
        self.merge_depth = merge_depth
574
        self.delta = delta
575
        self.tags = tags
576
577
794 by Martin Pool
- Merge John's nice short-log format.
578
class LogFormatter(object):
2466.8.1 by Kent Gibson
Reworked LogFormatter API to simplify extending the attributes of the revision being logged. Added support for begin_log() and end_log() hooks in LogFormatters.
579
    """Abstract class to display log messages.
580
581
    At a minimum, a derived class must implement the log_revision method.
582
583
    If the LogFormatter needs to be informed of the beginning or end of
584
    a log it should implement the begin_log and/or end_log hook methods.
585
586
    A LogFormatter should define the following supports_XXX flags 
587
    to indicate which LogRevision attributes it supports:
588
589
    - supports_delta must be True if this log formatter supports delta.
590
        Otherwise the delta attribute may not be populated.
591
    - supports_merge_revisions must be True if this log formatter supports 
2997.1.1 by Kent Gibson
Support logging single merge revisions with short and line log formatters.
592
        merge revisions.  If not, and if supports_single_merge_revisions is
593
        also not True, then only mainline revisions will be passed to the 
594
        formatter.
595
    - supports_single_merge_revision must be True if this log formatter
596
        supports logging only a single merge revision.  This flag is
597
        only relevant if supports_merge_revisions is not True.
2466.8.1 by Kent Gibson
Reworked LogFormatter API to simplify extending the attributes of the revision being logged. Added support for begin_log() and end_log() hooks in LogFormatters.
598
    - supports_tags must be True if this log formatter supports tags.
599
        Otherwise the tags attribute may not be populated.
600
    """
1704.2.20 by Martin Pool
log --line shows revision numbers (Alexander)
601
2388.1.8 by Erik Bagfors
Redo based on input from Alexander
602
    def __init__(self, to_file, show_ids=False, show_timezone='original'):
794 by Martin Pool
- Merge John's nice short-log format.
603
        self.to_file = to_file
604
        self.show_ids = show_ids
605
        self.show_timezone = show_timezone
974.1.26 by aaron.bentley at utoronto
merged mbp@sourcefrog.net-20050817233101-0939da1cf91f2472
606
2466.8.1 by Kent Gibson
Reworked LogFormatter API to simplify extending the attributes of the revision being logged. Added support for begin_log() and end_log() hooks in LogFormatters.
607
# TODO: uncomment this block after show() has been removed.
608
# Until then defining log_revision would prevent _show_log calling show() 
609
# in legacy formatters.
610
#    def log_revision(self, revision):
611
#        """Log a revision.
612
#
613
#        :param  revision:   The LogRevision to be logged.
614
#        """
615
#        raise NotImplementedError('not implemented in abstract base')
616
617
    @deprecated_method(zero_seventeen)
974.1.26 by aaron.bentley at utoronto
merged mbp@sourcefrog.net-20050817233101-0939da1cf91f2472
618
    def show(self, revno, rev, delta):
619
        raise NotImplementedError('not implemented in abstract base')
1393.1.56 by Martin Pool
- doc and small refactoring of log code
620
1185.35.19 by Aaron Bentley
Tweaked short-log as Meinel suggested
621
    def short_committer(self, rev):
622
        return re.sub('<.*@.*>', '', rev.committer).strip(' ')
2388.1.11 by Alexander Belchenko
changes after John's review
623
2671.5.4 by Lukáš Lalinsky
Replace the committer with the author in log, the committer is displayed only in the long format and only if it's different from the author.
624
    def short_author(self, rev):
2671.5.7 by Lukáš Lalinsky
Rename get_author to get_apparent_author, revert the long log back to displaying the committer.
625
        return re.sub('<.*@.*>', '', rev.get_apparent_author()).strip(' ')
2671.5.4 by Lukáš Lalinsky
Replace the committer with the author in log, the committer is displayed only in the long format and only if it's different from the author.
626
2388.1.11 by Alexander Belchenko
changes after John's review
627
794 by Martin Pool
- Merge John's nice short-log format.
628
class LongLogFormatter(LogFormatter):
2388.1.11 by Alexander Belchenko
changes after John's review
629
2466.8.1 by Kent Gibson
Reworked LogFormatter API to simplify extending the attributes of the revision being logged. Added support for begin_log() and end_log() hooks in LogFormatters.
630
    supports_merge_revisions = True
631
    supports_delta = True
632
    supports_tags = True
2388.1.10 by Alexander Belchenko
Slightly reworked: use None instead of [] as default tags list; PEP-8
633
2466.8.1 by Kent Gibson
Reworked LogFormatter API to simplify extending the attributes of the revision being logged. Added support for begin_log() and end_log() hooks in LogFormatters.
634
    @deprecated_method(zero_seventeen)
2388.1.10 by Alexander Belchenko
Slightly reworked: use None instead of [] as default tags list; PEP-8
635
    def show(self, revno, rev, delta, tags=None):
2490.1.2 by John Arbash Meinel
Cleanup according to PEP8 and some other small whitespace fixes
636
        lr = LogRevision(rev, revno, 0, delta, tags)
2466.8.1 by Kent Gibson
Reworked LogFormatter API to simplify extending the attributes of the revision being logged. Added support for begin_log() and end_log() hooks in LogFormatters.
637
        return self.log_revision(lr)
794 by Martin Pool
- Merge John's nice short-log format.
638
2466.8.1 by Kent Gibson
Reworked LogFormatter API to simplify extending the attributes of the revision being logged. Added support for begin_log() and end_log() hooks in LogFormatters.
639
    @deprecated_method(zero_seventeen)
2388.1.10 by Alexander Belchenko
Slightly reworked: use None instead of [] as default tags list; PEP-8
640
    def show_merge_revno(self, rev, merge_depth, revno, tags=None):
1988.4.2 by Robert Collins
``bzr log`` Now shows dotted-decimal revision numbers for all revisions,
641
        """Show a merged revision rev, with merge_depth and a revno."""
2490.1.2 by John Arbash Meinel
Cleanup according to PEP8 and some other small whitespace fixes
642
        lr = LogRevision(rev, revno, merge_depth, tags=tags)
2466.8.1 by Kent Gibson
Reworked LogFormatter API to simplify extending the attributes of the revision being logged. Added support for begin_log() and end_log() hooks in LogFormatters.
643
        return self.log_revision(lr)
1988.4.2 by Robert Collins
``bzr log`` Now shows dotted-decimal revision numbers for all revisions,
644
2466.8.1 by Kent Gibson
Reworked LogFormatter API to simplify extending the attributes of the revision being logged. Added support for begin_log() and end_log() hooks in LogFormatters.
645
    def log_revision(self, revision):
646
        """Log a revision, either merged or not."""
2671.2.5 by Lukáš Lalinský
Fixes for comments from the mailing list.
647
        indent = '    ' * revision.merge_depth
1433 by Robert Collins
merge in and make incremental Gustavo Niemeyers nested log patch, and remove all bare exceptions in store and transport packages.
648
        to_file = self.to_file
2911.6.1 by Blake Winton
Change 'print >> f,'s to 'f.write('s.
649
        to_file.write(indent + '-' * 60 + '\n')
2466.8.1 by Kent Gibson
Reworked LogFormatter API to simplify extending the attributes of the revision being logged. Added support for begin_log() and end_log() hooks in LogFormatters.
650
        if revision.revno is not None:
2911.6.3 by Blake Winton
Implemented suggestions from John Arbash Meinel.
651
            to_file.write(indent + 'revno: %s\n' % (revision.revno,))
2466.8.1 by Kent Gibson
Reworked LogFormatter API to simplify extending the attributes of the revision being logged. Added support for begin_log() and end_log() hooks in LogFormatters.
652
        if revision.tags:
2911.6.1 by Blake Winton
Change 'print >> f,'s to 'f.write('s.
653
            to_file.write(indent + 'tags: %s\n' % (', '.join(revision.tags)))
1433 by Robert Collins
merge in and make incremental Gustavo Niemeyers nested log patch, and remove all bare exceptions in store and transport packages.
654
        if self.show_ids:
2911.6.1 by Blake Winton
Change 'print >> f,'s to 'f.write('s.
655
            to_file.write(indent + 'revision-id:' + revision.rev.revision_id)
656
            to_file.write('\n')
2466.8.1 by Kent Gibson
Reworked LogFormatter API to simplify extending the attributes of the revision being logged. Added support for begin_log() and end_log() hooks in LogFormatters.
657
            for parent_id in revision.rev.parent_ids:
2911.6.3 by Blake Winton
Implemented suggestions from John Arbash Meinel.
658
                to_file.write(indent + 'parent: %s\n' % (parent_id,))
2671.2.2 by Lukáš Lalinský
Move setting of the author revision property to MutableTree.commit. Don't use try/except KeyError in LongLogFormatter to display authors and branch-nicks. Removed warning about missing e-mail in the authors name.
659
2671.5.7 by Lukáš Lalinsky
Rename get_author to get_apparent_author, revert the long log back to displaying the committer.
660
        author = revision.rev.properties.get('author', None)
661
        if author is not None:
2911.6.3 by Blake Winton
Implemented suggestions from John Arbash Meinel.
662
            to_file.write(indent + 'author: %s\n' % (author,))
663
        to_file.write(indent + 'committer: %s\n' % (revision.rev.committer,))
2671.2.2 by Lukáš Lalinský
Move setting of the author revision property to MutableTree.commit. Don't use try/except KeyError in LongLogFormatter to display authors and branch-nicks. Removed warning about missing e-mail in the authors name.
664
665
        branch_nick = revision.rev.properties.get('branch-nick', None)
666
        if branch_nick is not None:
2911.6.3 by Blake Winton
Implemented suggestions from John Arbash Meinel.
667
            to_file.write(indent + 'branch nick: %s\n' % (branch_nick,))
2671.2.2 by Lukáš Lalinský
Move setting of the author revision property to MutableTree.commit. Don't use try/except KeyError in LongLogFormatter to display authors and branch-nicks. Removed warning about missing e-mail in the authors name.
668
2466.8.1 by Kent Gibson
Reworked LogFormatter API to simplify extending the attributes of the revision being logged. Added support for begin_log() and end_log() hooks in LogFormatters.
669
        date_str = format_date(revision.rev.timestamp,
670
                               revision.rev.timezone or 0,
1433 by Robert Collins
merge in and make incremental Gustavo Niemeyers nested log patch, and remove all bare exceptions in store and transport packages.
671
                               self.show_timezone)
2911.6.3 by Blake Winton
Implemented suggestions from John Arbash Meinel.
672
        to_file.write(indent + 'timestamp: %s\n' % (date_str,))
1433 by Robert Collins
merge in and make incremental Gustavo Niemeyers nested log patch, and remove all bare exceptions in store and transport packages.
673
2911.6.1 by Blake Winton
Change 'print >> f,'s to 'f.write('s.
674
        to_file.write(indent + 'message:\n')
2466.8.1 by Kent Gibson
Reworked LogFormatter API to simplify extending the attributes of the revision being logged. Added support for begin_log() and end_log() hooks in LogFormatters.
675
        if not revision.rev.message:
2911.6.1 by Blake Winton
Change 'print >> f,'s to 'f.write('s.
676
            to_file.write(indent + '  (no message)\n')
1433 by Robert Collins
merge in and make incremental Gustavo Niemeyers nested log patch, and remove all bare exceptions in store and transport packages.
677
        else:
2466.8.1 by Kent Gibson
Reworked LogFormatter API to simplify extending the attributes of the revision being logged. Added support for begin_log() and end_log() hooks in LogFormatters.
678
            message = revision.rev.message.rstrip('\r\n')
1185.31.20 by John Arbash Meinel
Stripping trailing newlines when displaying log messages
679
            for l in message.split('\n'):
2911.6.3 by Blake Winton
Implemented suggestions from John Arbash Meinel.
680
                to_file.write(indent + '  %s\n' % (l,))
2466.8.1 by Kent Gibson
Reworked LogFormatter API to simplify extending the attributes of the revision being logged. Added support for begin_log() and end_log() hooks in LogFormatters.
681
        if revision.delta is not None:
2466.11.1 by Kent Gibson
Long log format reports deltas on merge revisions.
682
            revision.delta.show(to_file, self.show_ids, indent=indent)
794 by Martin Pool
- Merge John's nice short-log format.
683
684
685
class ShortLogFormatter(LogFormatter):
2466.8.1 by Kent Gibson
Reworked LogFormatter API to simplify extending the attributes of the revision being logged. Added support for begin_log() and end_log() hooks in LogFormatters.
686
687
    supports_delta = True
2997.1.1 by Kent Gibson
Support logging single merge revisions with short and line log formatters.
688
    supports_single_merge_revision = True
2466.8.1 by Kent Gibson
Reworked LogFormatter API to simplify extending the attributes of the revision being logged. Added support for begin_log() and end_log() hooks in LogFormatters.
689
690
    @deprecated_method(zero_seventeen)
794 by Martin Pool
- Merge John's nice short-log format.
691
    def show(self, revno, rev, delta):
2490.1.2 by John Arbash Meinel
Cleanup according to PEP8 and some other small whitespace fixes
692
        lr = LogRevision(rev, revno, 0, delta)
2466.8.1 by Kent Gibson
Reworked LogFormatter API to simplify extending the attributes of the revision being logged. Added support for begin_log() and end_log() hooks in LogFormatters.
693
        return self.log_revision(lr)
694
695
    def log_revision(self, revision):
794 by Martin Pool
- Merge John's nice short-log format.
696
        to_file = self.to_file
2483.2.5 by John Arbash Meinel
[merge] bzr.dev 2501
697
        date_str = format_date(revision.rev.timestamp,
2466.8.1 by Kent Gibson
Reworked LogFormatter API to simplify extending the attributes of the revision being logged. Added support for begin_log() and end_log() hooks in LogFormatters.
698
                               revision.rev.timezone or 0,
699
                               self.show_timezone)
2483.2.2 by John Arbash Meinel
Add [merge] after the timestamp for revisions with merges.
700
        is_merge = ''
2483.2.5 by John Arbash Meinel
[merge] bzr.dev 2501
701
        if len(revision.rev.parent_ids) > 1:
2483.2.2 by John Arbash Meinel
Add [merge] after the timestamp for revisions with merges.
702
            is_merge = ' [merge]'
2911.6.1 by Blake Winton
Change 'print >> f,'s to 'f.write('s.
703
        to_file.write("%5s %s\t%s%s\n" % (revision.revno,
2671.5.4 by Lukáš Lalinsky
Replace the committer with the author in log, the committer is displayed only in the long format and only if it's different from the author.
704
                self.short_author(revision.rev),
2483.2.5 by John Arbash Meinel
[merge] bzr.dev 2501
705
                format_date(revision.rev.timestamp,
2466.8.1 by Kent Gibson
Reworked LogFormatter API to simplify extending the attributes of the revision being logged. Added support for begin_log() and end_log() hooks in LogFormatters.
706
                            revision.rev.timezone or 0,
1185.35.19 by Aaron Bentley
Tweaked short-log as Meinel suggested
707
                            self.show_timezone, date_fmt="%Y-%m-%d",
2483.2.5 by John Arbash Meinel
[merge] bzr.dev 2501
708
                            show_offset=False),
2911.6.1 by Blake Winton
Change 'print >> f,'s to 'f.write('s.
709
                is_merge))
794 by Martin Pool
- Merge John's nice short-log format.
710
        if self.show_ids:
2911.6.3 by Blake Winton
Implemented suggestions from John Arbash Meinel.
711
            to_file.write('      revision-id:%s\n' % (revision.rev.revision_id,))
2466.8.1 by Kent Gibson
Reworked LogFormatter API to simplify extending the attributes of the revision being logged. Added support for begin_log() and end_log() hooks in LogFormatters.
712
        if not revision.rev.message:
2911.6.1 by Blake Winton
Change 'print >> f,'s to 'f.write('s.
713
            to_file.write('      (no message)\n')
794 by Martin Pool
- Merge John's nice short-log format.
714
        else:
2466.8.1 by Kent Gibson
Reworked LogFormatter API to simplify extending the attributes of the revision being logged. Added support for begin_log() and end_log() hooks in LogFormatters.
715
            message = revision.rev.message.rstrip('\r\n')
1185.31.20 by John Arbash Meinel
Stripping trailing newlines when displaying log messages
716
            for l in message.split('\n'):
2911.6.3 by Blake Winton
Implemented suggestions from John Arbash Meinel.
717
                to_file.write('      %s\n' % (l,))
794 by Martin Pool
- Merge John's nice short-log format.
718
974.1.26 by aaron.bentley at utoronto
merged mbp@sourcefrog.net-20050817233101-0939da1cf91f2472
719
        # TODO: Why not show the modified files in a shorter form as
720
        # well? rewrap them single lines of appropriate length
2466.8.1 by Kent Gibson
Reworked LogFormatter API to simplify extending the attributes of the revision being logged. Added support for begin_log() and end_log() hooks in LogFormatters.
721
        if revision.delta is not None:
722
            revision.delta.show(to_file, self.show_ids)
2911.6.1 by Blake Winton
Change 'print >> f,'s to 'f.write('s.
723
        to_file.write('\n')
794 by Martin Pool
- Merge John's nice short-log format.
724
1704.2.20 by Martin Pool
log --line shows revision numbers (Alexander)
725
1185.12.25 by Aaron Bentley
Added one-line log format
726
class LineLogFormatter(LogFormatter):
2466.8.1 by Kent Gibson
Reworked LogFormatter API to simplify extending the attributes of the revision being logged. Added support for begin_log() and end_log() hooks in LogFormatters.
727
2997.1.1 by Kent Gibson
Support logging single merge revisions with short and line log formatters.
728
    supports_single_merge_revision = True
729
2466.8.1 by Kent Gibson
Reworked LogFormatter API to simplify extending the attributes of the revision being logged. Added support for begin_log() and end_log() hooks in LogFormatters.
730
    def __init__(self, *args, **kwargs):
731
        super(LineLogFormatter, self).__init__(*args, **kwargs)
732
        self._max_chars = terminal_width() - 1
733
1185.12.25 by Aaron Bentley
Added one-line log format
734
    def truncate(self, str, max_len):
735
        if len(str) <= max_len:
736
            return str
737
        return str[:max_len-3]+'...'
738
739
    def date_string(self, rev):
740
        return format_date(rev.timestamp, rev.timezone or 0, 
741
                           self.show_timezone, date_fmt="%Y-%m-%d",
742
                           show_offset=False)
743
744
    def message(self, rev):
745
        if not rev.message:
746
            return '(no message)'
747
        else:
748
            return rev.message
749
2466.8.1 by Kent Gibson
Reworked LogFormatter API to simplify extending the attributes of the revision being logged. Added support for begin_log() and end_log() hooks in LogFormatters.
750
    @deprecated_method(zero_seventeen)
1185.12.25 by Aaron Bentley
Added one-line log format
751
    def show(self, revno, rev, delta):
2911.6.1 by Blake Winton
Change 'print >> f,'s to 'f.write('s.
752
        self.to_file.write(self.log_string(revno, rev, terminal_width()-1))
753
        self.to_file.write('\n')
1185.12.25 by Aaron Bentley
Added one-line log format
754
2466.8.1 by Kent Gibson
Reworked LogFormatter API to simplify extending the attributes of the revision being logged. Added support for begin_log() and end_log() hooks in LogFormatters.
755
    def log_revision(self, revision):
2911.6.1 by Blake Winton
Change 'print >> f,'s to 'f.write('s.
756
        self.to_file.write(self.log_string(revision.revno, revision.rev,
757
                                              self._max_chars))
758
        self.to_file.write('\n')
2466.8.1 by Kent Gibson
Reworked LogFormatter API to simplify extending the attributes of the revision being logged. Added support for begin_log() and end_log() hooks in LogFormatters.
759
1704.2.20 by Martin Pool
log --line shows revision numbers (Alexander)
760
    def log_string(self, revno, rev, max_chars):
761
        """Format log info into one string. Truncate tail of string
762
        :param  revno:      revision number (int) or None.
763
                            Revision numbers counts from 1.
764
        :param  rev:        revision info object
765
        :param  max_chars:  maximum length of resulting string
766
        :return:            formatted truncated string
767
        """
768
        out = []
769
        if revno:
770
            # show revno only when is not None
1988.4.2 by Robert Collins
``bzr log`` Now shows dotted-decimal revision numbers for all revisions,
771
            out.append("%s:" % revno)
2671.5.4 by Lukáš Lalinsky
Replace the committer with the author in log, the committer is displayed only in the long format and only if it's different from the author.
772
        out.append(self.truncate(self.short_author(rev), 20))
1185.12.25 by Aaron Bentley
Added one-line log format
773
        out.append(self.date_string(rev))
1740.2.5 by Aaron Bentley
Merge from bzr.dev
774
        out.append(rev.get_summary())
1185.12.25 by Aaron Bentley
Added one-line log format
775
        return self.truncate(" ".join(out).rstrip('\n'), max_chars)
794 by Martin Pool
- Merge John's nice short-log format.
776
1704.2.20 by Martin Pool
log --line shows revision numbers (Alexander)
777
1185.12.27 by Aaron Bentley
Use line log for pending merges
778
def line_log(rev, max_chars):
779
    lf = LineLogFormatter(None)
1704.2.20 by Martin Pool
log --line shows revision numbers (Alexander)
780
    return lf.log_string(None, rev, max_chars)
1185.12.27 by Aaron Bentley
Use line log for pending merges
781
2221.4.10 by Aaron Bentley
Implement log options using RegistryOption
782
783
class LogFormatterRegistry(registry.Registry):
784
    """Registry for log formatters"""
785
786
    def make_formatter(self, name, *args, **kwargs):
787
        """Construct a formatter from arguments.
788
789
        :param name: Name of the formatter to construct.  'short', 'long' and
790
            'line' are built-in.
791
        """
792
        return self.get(name)(*args, **kwargs)
793
794
    def get_default(self, branch):
795
        return self.get(branch.get_config().log_format())
796
797
798
log_formatter_registry = LogFormatterRegistry()
799
800
801
log_formatter_registry.register('short', ShortLogFormatter,
802
                                'Moderately short log format')
803
log_formatter_registry.register('long', LongLogFormatter,
804
                                'Detailed log format')
805
log_formatter_registry.register('line', LineLogFormatter,
806
                                'Log format with one line per revision')
807
794 by Martin Pool
- Merge John's nice short-log format.
808
1553.2.1 by Erik Bågfors
Support for plugins to register log formatters and set default formatter
809
def register_formatter(name, formatter):
2221.4.10 by Aaron Bentley
Implement log options using RegistryOption
810
    log_formatter_registry.register(name, formatter)
811
1553.2.1 by Erik Bågfors
Support for plugins to register log formatters and set default formatter
812
794 by Martin Pool
- Merge John's nice short-log format.
813
def log_formatter(name, *args, **kwargs):
1393.1.56 by Martin Pool
- doc and small refactoring of log code
814
    """Construct a formatter from arguments.
815
1185.12.27 by Aaron Bentley
Use line log for pending merges
816
    name -- Name of the formatter to construct; currently 'long', 'short' and
817
        'line' are supported.
1393.1.56 by Martin Pool
- doc and small refactoring of log code
818
    """
794 by Martin Pool
- Merge John's nice short-log format.
819
    try:
2221.4.10 by Aaron Bentley
Implement log options using RegistryOption
820
        return log_formatter_registry.make_formatter(name, *args, **kwargs)
1553.2.2 by Erik Bågfors
Made "unknown log formatter" error message work
821
    except KeyError:
794 by Martin Pool
- Merge John's nice short-log format.
822
        raise BzrCommandError("unknown log formatter: %r" % name)
974.1.26 by aaron.bentley at utoronto
merged mbp@sourcefrog.net-20050817233101-0939da1cf91f2472
823
2221.4.10 by Aaron Bentley
Implement log options using RegistryOption
824
974.1.26 by aaron.bentley at utoronto
merged mbp@sourcefrog.net-20050817233101-0939da1cf91f2472
825
def show_one_log(revno, rev, delta, verbose, to_file, show_timezone):
1759.2.1 by Jelmer Vernooij
Fix some types (found using aspell).
826
    # deprecated; for compatibility
974.1.26 by aaron.bentley at utoronto
merged mbp@sourcefrog.net-20050817233101-0939da1cf91f2472
827
    lf = LongLogFormatter(to_file=to_file, show_timezone=show_timezone)
828
    lf.show(revno, rev, delta)
1185.32.2 by John Arbash Meinel
Refactor pull --verbose into a log.py function, add tests.
829
2490.1.4 by John Arbash Meinel
Update bzrlib.log.show_changed_revisions to use the new api
830
1551.17.2 by Aaron Bentley
Stop showing deltas in pull -v output
831
def show_changed_revisions(branch, old_rh, new_rh, to_file=None,
832
                           log_format='long'):
1185.32.2 by John Arbash Meinel
Refactor pull --verbose into a log.py function, add tests.
833
    """Show the change in revision history comparing the old revision history to the new one.
834
835
    :param branch: The branch where the revisions exist
836
    :param old_rh: The old revision history
837
    :param new_rh: The new revision history
838
    :param to_file: A file to write the results to. If None, stdout will be used
839
    """
840
    if to_file is None:
2997.1.3 by Alexander Belchenko
file wrapper around stdout should use terminal encoding, not user_encoding.
841
        to_file = codecs.getwriter(get_terminal_encoding())(sys.stdout,
842
            errors='replace')
1185.32.2 by John Arbash Meinel
Refactor pull --verbose into a log.py function, add tests.
843
    lf = log_formatter(log_format,
844
                       show_ids=False,
845
                       to_file=to_file,
846
                       show_timezone='original')
847
848
    # This is the first index which is different between
849
    # old and new
850
    base_idx = None
851
    for i in xrange(max(len(new_rh),
852
                        len(old_rh))):
853
        if (len(new_rh) <= i
854
            or len(old_rh) <= i
855
            or new_rh[i] != old_rh[i]):
856
            base_idx = i
857
            break
858
859
    if base_idx is None:
860
        to_file.write('Nothing seems to have changed\n')
861
        return
862
    ## TODO: It might be nice to do something like show_log
863
    ##       and show the merged entries. But since this is the
864
    ##       removed revisions, it shouldn't be as important
865
    if base_idx < len(old_rh):
866
        to_file.write('*'*60)
867
        to_file.write('\nRemoved Revisions:\n')
868
        for i in range(base_idx, len(old_rh)):
1185.67.2 by Aaron Bentley
Renamed Branch.storage to Branch.repository
869
            rev = branch.repository.get_revision(old_rh[i])
2490.1.4 by John Arbash Meinel
Update bzrlib.log.show_changed_revisions to use the new api
870
            lr = LogRevision(rev, i+1, 0, None)
871
            lf.log_revision(lr)
1185.32.2 by John Arbash Meinel
Refactor pull --verbose into a log.py function, add tests.
872
        to_file.write('*'*60)
873
        to_file.write('\n\n')
874
    if base_idx < len(new_rh):
875
        to_file.write('Added Revisions:\n')
876
        show_log(branch,
877
                 lf,
878
                 None,
1551.17.2 by Aaron Bentley
Stop showing deltas in pull -v output
879
                 verbose=False,
1185.32.2 by John Arbash Meinel
Refactor pull --verbose into a log.py function, add tests.
880
                 direction='forward',
881
                 start_revision=base_idx+1,
882
                 end_revision=len(new_rh),
883
                 search=None)
884