~bzr-pqm/bzr/bzr.dev

369 by Martin Pool
- Split out log printing into new show_log function
1
# Copyright (C) 2005 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
45
relative to its mainline 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.
527 by Martin Pool
- refactor log command
50
"""
51
1185.33.41 by Martin Pool
Fix regression of 'bzr log -v' - it wasn't showing changed files at all. (#4676)
52
# TODO: option to show delta summaries for merged-in revisions
1773.4.1 by Martin Pool
Add pyflakes makefile target; fix many warnings
53
1756.2.13 by Aaron Bentley
Used scaled iterator to retrive revisions
54
from itertools import izip
1624.1.3 by Robert Collins
Convert log to use the new tsort.merge_sort routine.
55
import re
1185.33.41 by Martin Pool
Fix regression of 'bzr log -v' - it wasn't showing changed files at all. (#4676)
56
1988.4.2 by Robert Collins
``bzr log`` Now shows dotted-decimal revision numbers for all revisions,
57
from bzrlib import symbol_versioning
1433 by Robert Collins
merge in and make incremental Gustavo Niemeyers nested log patch, and remove all bare exceptions in store and transport packages.
58
import bzrlib.errors as errors
1988.4.2 by Robert Collins
``bzr log`` Now shows dotted-decimal revision numbers for all revisions,
59
from bzrlib.symbol_versioning import deprecated_method, zero_eleven
1624.1.3 by Robert Collins
Convert log to use the new tsort.merge_sort routine.
60
from bzrlib.trace import mutter
61
from bzrlib.tsort import merge_sort
974.1.26 by aaron.bentley at utoronto
merged mbp@sourcefrog.net-20050817233101-0939da1cf91f2472
62
375 by Martin Pool
- New command touching-revisions and function to trace
63
64
def find_touching_revisions(branch, file_id):
65
    """Yield a description of revisions which affect the file_id.
66
67
    Each returned element is (revno, revision_id, description)
68
69
    This is the list of revisions where the file is either added,
70
    modified, renamed or deleted.
71
72
    TODO: Perhaps some way to limit this to only particular revisions,
522 by Martin Pool
todo
73
    or to traverse a non-mainline set of revisions?
375 by Martin Pool
- New command touching-revisions and function to trace
74
    """
75
    last_ie = None
76
    last_path = None
77
    revno = 1
78
    for revision_id in branch.revision_history():
1185.67.2 by Aaron Bentley
Renamed Branch.storage to Branch.repository
79
        this_inv = branch.repository.get_revision_inventory(revision_id)
375 by Martin Pool
- New command touching-revisions and function to trace
80
        if file_id in this_inv:
81
            this_ie = this_inv[file_id]
82
            this_path = this_inv.id2path(file_id)
83
        else:
84
            this_ie = this_path = None
85
86
        # now we know how it was last time, and how it is in this revision.
87
        # are those two states effectively the same or not?
88
89
        if not this_ie and not last_ie:
90
            # not present in either
91
            pass
92
        elif this_ie and not last_ie:
93
            yield revno, revision_id, "added " + this_path
94
        elif not this_ie and last_ie:
95
            # deleted here
96
            yield revno, revision_id, "deleted " + last_path
97
        elif this_path != last_path:
98
            yield revno, revision_id, ("renamed %s => %s" % (last_path, this_path))
99
        elif (this_ie.text_size != last_ie.text_size
100
              or this_ie.text_sha1 != last_ie.text_sha1):
101
            yield revno, revision_id, "modified " + this_path
102
103
        last_ie = this_ie
104
        last_path = this_path
105
        revno += 1
106
107
527 by Martin Pool
- refactor log command
108
974.1.26 by aaron.bentley at utoronto
merged mbp@sourcefrog.net-20050817233101-0939da1cf91f2472
109
def _enumerate_history(branch):
110
    rh = []
111
    revno = 1
112
    for rev_id in branch.revision_history():
113
        rh.append((revno, rev_id))
114
        revno += 1
115
    return rh
116
117
378 by Martin Pool
- New usage bzr log FILENAME
118
def show_log(branch,
794 by Martin Pool
- Merge John's nice short-log format.
119
             lf,
527 by Martin Pool
- refactor log command
120
             specific_fileid=None,
378 by Martin Pool
- New usage bzr log FILENAME
121
             verbose=False,
567 by Martin Pool
- New form 'bzr log -r FROM:TO'
122
             direction='reverse',
123
             start_revision=None,
900 by Martin Pool
- patch from john to search for matching commits
124
             end_revision=None,
125
             search=None):
369 by Martin Pool
- Split out log printing into new show_log function
126
    """Write out human-readable log of commits to this branch.
127
794 by Martin Pool
- Merge John's nice short-log format.
128
    lf
129
        LogFormatter object to show the output.
130
527 by Martin Pool
- refactor log command
131
    specific_fileid
378 by Martin Pool
- New usage bzr log FILENAME
132
        If true, list only the commits affecting the specified
133
        file, rather than all commits.
134
369 by Martin Pool
- Split out log printing into new show_log function
135
    verbose
136
        If true show added/changed/deleted/renamed files.
137
527 by Martin Pool
- refactor log command
138
    direction
139
        'reverse' (default) is latest to earliest;
140
        'forward' is earliest to latest.
567 by Martin Pool
- New form 'bzr log -r FROM:TO'
141
142
    start_revision
143
        If not None, only show revisions >= start_revision
144
145
    end_revision
146
        If not None, only show revisions <= end_revision
369 by Martin Pool
- Split out log printing into new show_log function
147
    """
1417.1.7 by Robert Collins
teach log it needs a read lock
148
    branch.lock_read()
149
    try:
1756.1.6 by Aaron Bentley
Revert locking fix
150
        _show_log(branch, lf, specific_fileid, verbose, direction,
151
                  start_revision, end_revision, search)
1417.1.7 by Robert Collins
teach log it needs a read lock
152
    finally:
153
        branch.unlock()
154
    
155
def _show_log(branch,
156
             lf,
157
             specific_fileid=None,
158
             verbose=False,
159
             direction='reverse',
160
             start_revision=None,
161
             end_revision=None,
162
             search=None):
163
    """Worker function for show_log - see show_log."""
794 by Martin Pool
- Merge John's nice short-log format.
164
    from bzrlib.osutils import format_date
165
    from bzrlib.errors import BzrCheckError
166
    
167
    from warnings import warn
369 by Martin Pool
- Split out log printing into new show_log function
168
794 by Martin Pool
- Merge John's nice short-log format.
169
    if not isinstance(lf, LogFormatter):
170
        warn("not a LogFormatter instance: %r" % lf)
533 by Martin Pool
- fix up asking for the log for the root of a remote branch
171
172
    if specific_fileid:
1185.31.4 by John Arbash Meinel
Fixing mutter() calls to not have to do string processing.
173
        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
174
900 by Martin Pool
- patch from john to search for matching commits
175
    if search is not None:
176
        import re
177
        searchRE = re.compile(search, re.IGNORECASE)
178
    else:
179
        searchRE = None
180
974.1.26 by aaron.bentley at utoronto
merged mbp@sourcefrog.net-20050817233101-0939da1cf91f2472
181
    which_revs = _enumerate_history(branch)
182
    
183
    if start_revision is None:
184
        start_revision = 1
974.1.54 by aaron.bentley at utoronto
Fixed the revno bug in log
185
    else:
186
        branch.check_real_revno(start_revision)
974.1.26 by aaron.bentley at utoronto
merged mbp@sourcefrog.net-20050817233101-0939da1cf91f2472
187
    
188
    if end_revision is None:
189
        end_revision = len(which_revs)
974.1.54 by aaron.bentley at utoronto
Fixed the revno bug in log
190
    else:
191
        branch.check_real_revno(end_revision)
974.1.26 by aaron.bentley at utoronto
merged mbp@sourcefrog.net-20050817233101-0939da1cf91f2472
192
193
    # list indexes are 0-based; revisions are 1-based
194
    cut_revs = which_revs[(start_revision-1):(end_revision)]
1624.1.3 by Robert Collins
Convert log to use the new tsort.merge_sort routine.
195
    if not cut_revs:
196
        return
1756.2.18 by Aaron Bentley
Factor out the revision list generation
197
198
    # convert the revision history to a dictionary:
1756.2.27 by Aaron Bentley
Tweak rev_nos style
199
    rev_nos = dict((k, v) for v, k in cut_revs)
1756.2.18 by Aaron Bentley
Factor out the revision list generation
200
1624.1.3 by Robert Collins
Convert log to use the new tsort.merge_sort routine.
201
    # override the mainline to look like the revision history.
202
    mainline_revs = [revision_id for index, revision_id in cut_revs]
203
    if cut_revs[0][0] == 1:
204
        mainline_revs.insert(0, None)
205
    else:
206
        mainline_revs.insert(0, which_revs[start_revision-2][1])
1988.4.2 by Robert Collins
``bzr log`` Now shows dotted-decimal revision numbers for all revisions,
207
    # how should we show merged revisions ?
208
    # old api: show_merge. New api: show_merge_revno
209
    show_merge_revno = getattr(lf, 'show_merge_revno', None)
210
    show_merge = getattr(lf, 'show_merge', None)
211
    if show_merge is None and show_merge_revno is None:
212
        # no merged-revno support
213
        include_merges = False
1756.2.20 by Aaron Bentley
Optimize log formats that don't show merges
214
    else:
1988.4.2 by Robert Collins
``bzr log`` Now shows dotted-decimal revision numbers for all revisions,
215
        include_merges = True
216
    if show_merge is not None and show_merge_revno is None:
217
        # tell developers to update their code
218
        symbol_versioning.warn('LogFormatters should provide show_merge_revno '
219
            'instead of show_merge since bzr 0.11.',
220
            DeprecationWarning, stacklevel=3)
1756.2.18 by Aaron Bentley
Factor out the revision list generation
221
    view_revisions = list(get_view_revisions(mainline_revs, rev_nos, branch,
1756.2.22 by Aaron Bentley
Apply review comments
222
                          direction, include_merges=include_merges))
1624.1.3 by Robert Collins
Convert log to use the new tsort.merge_sort routine.
223
1756.2.13 by Aaron Bentley
Used scaled iterator to retrive revisions
224
    def iter_revisions():
1756.3.22 by Aaron Bentley
Tweaks from review
225
        # r = revision, n = revno, d = merge depth
1756.2.20 by Aaron Bentley
Optimize log formats that don't show merges
226
        revision_ids = [r for r, n, d in view_revisions]
1756.3.2 by Aaron Bentley
Refactor revision_delta call
227
        zeros = set(r for r, n, d in view_revisions if d == 0)
1756.2.13 by Aaron Bentley
Used scaled iterator to retrive revisions
228
        num = 9
1756.3.22 by Aaron Bentley
Tweaks from review
229
        repository = branch.repository
1756.2.13 by Aaron Bentley
Used scaled iterator to retrive revisions
230
        while revision_ids:
1756.3.22 by Aaron Bentley
Tweaks from review
231
            cur_deltas = {}
232
            revisions = repository.get_revisions(revision_ids[:num])
1756.3.3 by Aaron Bentley
More refactoring, introduce revision_trees.
233
            if verbose or specific_fileid:
234
                delta_revisions = [r for r in revisions if
235
                                   r.revision_id in zeros]
1756.3.22 by Aaron Bentley
Tweaks from review
236
                deltas = repository.get_deltas_for_revisions(delta_revisions)
237
                cur_deltas = dict(izip((r.revision_id for r in 
238
                                        delta_revisions), deltas))
1756.2.13 by Aaron Bentley
Used scaled iterator to retrive revisions
239
            for revision in revisions:
1756.3.22 by Aaron Bentley
Tweaks from review
240
                # The delta value will be None unless
241
                # 1. verbose or specific_fileid is specified, and
242
                # 2. the revision is a mainline revision
1756.3.3 by Aaron Bentley
More refactoring, introduce revision_trees.
243
                yield revision, cur_deltas.get(revision.revision_id)
1756.2.13 by Aaron Bentley
Used scaled iterator to retrive revisions
244
            revision_ids  = revision_ids[num:]
245
            num = int(num * 1.5)
246
            
1624.1.3 by Robert Collins
Convert log to use the new tsort.merge_sort routine.
247
    # now we just print all the revisions
1756.3.2 by Aaron Bentley
Refactor revision_delta call
248
    for ((rev_id, revno, merge_depth), (rev, delta)) in \
1756.2.18 by Aaron Bentley
Factor out the revision list generation
249
         izip(view_revisions, iter_revisions()):
974.1.26 by aaron.bentley at utoronto
merged mbp@sourcefrog.net-20050817233101-0939da1cf91f2472
250
251
        if searchRE:
252
            if not searchRE.search(rev.message):
253
                continue
254
1624.1.3 by Robert Collins
Convert log to use the new tsort.merge_sort routine.
255
        if merge_depth == 0:
256
            # a mainline revision.
257
                
258
            if specific_fileid:
259
                if not delta.touches_file_id(specific_fileid):
260
                    continue
261
    
262
            if not verbose:
263
                # although we calculated it, throw it away without display
264
                delta = None
265
1756.2.18 by Aaron Bentley
Factor out the revision list generation
266
            lf.show(revno, rev, delta)
1756.2.20 by Aaron Bentley
Optimize log formats that don't show merges
267
        else:
1988.4.2 by Robert Collins
``bzr log`` Now shows dotted-decimal revision numbers for all revisions,
268
            if show_merge_revno is None:
269
                lf.show_merge(rev, merge_depth)
270
            else:
271
                lf.show_merge_revno(rev, merge_depth, revno)
527 by Martin Pool
- refactor log command
272
530 by Martin Pool
- put back verbose log support for reversed logs
273
1756.2.20 by Aaron Bentley
Optimize log formats that don't show merges
274
def get_view_revisions(mainline_revs, rev_nos, branch, direction,
1756.2.22 by Aaron Bentley
Apply review comments
275
                       include_merges=True):
1756.2.18 by Aaron Bentley
Factor out the revision list generation
276
    """Produce an iterator of revisions to show
277
    :return: an iterator of (revision_id, revno, merge_depth)
278
    (if there is no revno for a revision, None is supplied)
279
    """
1756.2.22 by Aaron Bentley
Apply review comments
280
    if include_merges is False:
1756.2.20 by Aaron Bentley
Optimize log formats that don't show merges
281
        revision_ids = mainline_revs[1:]
282
        if direction == 'reverse':
283
            revision_ids.reverse()
284
        for revision_id in revision_ids:
1988.4.2 by Robert Collins
``bzr log`` Now shows dotted-decimal revision numbers for all revisions,
285
            yield revision_id, str(rev_nos[revision_id]), 0
1756.2.20 by Aaron Bentley
Optimize log formats that don't show merges
286
        return
1756.2.18 by Aaron Bentley
Factor out the revision list generation
287
    merge_sorted_revisions = merge_sort(
288
        branch.repository.get_revision_graph(mainline_revs[-1]),
289
        mainline_revs[-1],
1988.4.2 by Robert Collins
``bzr log`` Now shows dotted-decimal revision numbers for all revisions,
290
        mainline_revs,
291
        generate_revno=True)
1756.2.18 by Aaron Bentley
Factor out the revision list generation
292
293
    if direction == 'forward':
294
        # forward means oldest first.
1756.2.25 by Aaron Bentley
Sort revisions at each depth, instead of just mainline revisions.
295
        merge_sorted_revisions = reverse_by_depth(merge_sorted_revisions)
1756.2.18 by Aaron Bentley
Factor out the revision list generation
296
    elif direction != 'reverse':
297
        raise ValueError('invalid direction %r' % direction)
298
1988.4.2 by Robert Collins
``bzr log`` Now shows dotted-decimal revision numbers for all revisions,
299
    for sequence, rev_id, merge_depth, revno, end_of_merge in merge_sorted_revisions:
300
        yield rev_id, '.'.join(map(str, revno)), merge_depth
1756.2.18 by Aaron Bentley
Factor out the revision list generation
301
302
1756.2.25 by Aaron Bentley
Sort revisions at each depth, instead of just mainline revisions.
303
def reverse_by_depth(merge_sorted_revisions, _depth=0):
304
    """Reverse revisions by depth.
1756.2.24 by Aaron Bentley
Forward sorting shows merges under mainline revision
305
1756.2.25 by Aaron Bentley
Sort revisions at each depth, instead of just mainline revisions.
306
    Revisions with a different depth are sorted as a group with the previous
307
    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
308
    but it looks much nicer.
309
    """
310
    zd_revisions = []
311
    for val in merge_sorted_revisions:
1756.2.25 by Aaron Bentley
Sort revisions at each depth, instead of just mainline revisions.
312
        if val[2] == _depth:
1756.2.24 by Aaron Bentley
Forward sorting shows merges under mainline revision
313
            zd_revisions.append([val])
314
        else:
1756.2.25 by Aaron Bentley
Sort revisions at each depth, instead of just mainline revisions.
315
            assert val[2] > _depth
1756.2.24 by Aaron Bentley
Forward sorting shows merges under mainline revision
316
            zd_revisions[-1].append(val)
1756.2.25 by Aaron Bentley
Sort revisions at each depth, instead of just mainline revisions.
317
    for revisions in zd_revisions:
318
        if len(revisions) > 1:
319
            revisions[1:] = reverse_by_depth(revisions[1:], _depth + 1)
1756.2.24 by Aaron Bentley
Forward sorting shows merges under mainline revision
320
    zd_revisions.reverse()
321
    result = []
322
    for chunk in zd_revisions:
323
        result.extend(chunk)
324
    return result
325
326
794 by Martin Pool
- Merge John's nice short-log format.
327
class LogFormatter(object):
328
    """Abstract class to display log messages."""
1704.2.20 by Martin Pool
log --line shows revision numbers (Alexander)
329
974.1.26 by aaron.bentley at utoronto
merged mbp@sourcefrog.net-20050817233101-0939da1cf91f2472
330
    def __init__(self, to_file, show_ids=False, show_timezone='original'):
794 by Martin Pool
- Merge John's nice short-log format.
331
        self.to_file = to_file
332
        self.show_ids = show_ids
333
        self.show_timezone = show_timezone
974.1.26 by aaron.bentley at utoronto
merged mbp@sourcefrog.net-20050817233101-0939da1cf91f2472
334
335
    def show(self, revno, rev, delta):
336
        raise NotImplementedError('not implemented in abstract base')
1393.1.56 by Martin Pool
- doc and small refactoring of log code
337
1185.35.19 by Aaron Bentley
Tweaked short-log as Meinel suggested
338
    def short_committer(self, rev):
339
        return re.sub('<.*@.*>', '', rev.committer).strip(' ')
340
    
1393.1.56 by Martin Pool
- doc and small refactoring of log code
341
    
794 by Martin Pool
- Merge John's nice short-log format.
342
class LongLogFormatter(LogFormatter):
343
    def show(self, revno, rev, delta):
1185.33.41 by Martin Pool
Fix regression of 'bzr log -v' - it wasn't showing changed files at all. (#4676)
344
        return self._show_helper(revno=revno, rev=rev, delta=delta)
794 by Martin Pool
- Merge John's nice short-log format.
345
1988.4.2 by Robert Collins
``bzr log`` Now shows dotted-decimal revision numbers for all revisions,
346
    @deprecated_method(zero_eleven)
1624.1.3 by Robert Collins
Convert log to use the new tsort.merge_sort routine.
347
    def show_merge(self, rev, merge_depth):
348
        return self._show_helper(rev=rev, indent='    '*merge_depth, merged=True, delta=None)
1185.33.41 by Martin Pool
Fix regression of 'bzr log -v' - it wasn't showing changed files at all. (#4676)
349
1988.4.2 by Robert Collins
``bzr log`` Now shows dotted-decimal revision numbers for all revisions,
350
    def show_merge_revno(self, rev, merge_depth, revno):
351
        """Show a merged revision rev, with merge_depth and a revno."""
352
        return self._show_helper(rev=rev, revno=revno,
353
            indent='    '*merge_depth, merged=True, delta=None)
354
1185.33.41 by Martin Pool
Fix regression of 'bzr log -v' - it wasn't showing changed files at all. (#4676)
355
    def _show_helper(self, rev=None, revno=None, indent='', merged=False, delta=None):
1624.1.3 by Robert Collins
Convert log to use the new tsort.merge_sort routine.
356
        """Show a revision, either merged or not."""
1185.33.41 by Martin Pool
Fix regression of 'bzr log -v' - it wasn't showing changed files at all. (#4676)
357
        from bzrlib.osutils import format_date
1433 by Robert Collins
merge in and make incremental Gustavo Niemeyers nested log patch, and remove all bare exceptions in store and transport packages.
358
        to_file = self.to_file
359
        print >>to_file,  indent+'-' * 60
1185.35.18 by Aaron Bentley
Refactored long-format log printing
360
        if revno is not None:
1988.4.2 by Robert Collins
``bzr log`` Now shows dotted-decimal revision numbers for all revisions,
361
            print >>to_file,  indent+'revno:', revno
1185.35.18 by Aaron Bentley
Refactored long-format log printing
362
        if merged:
363
            print >>to_file,  indent+'merged:', rev.revision_id
364
        elif self.show_ids:
365
            print >>to_file,  indent+'revision-id:', rev.revision_id
1433 by Robert Collins
merge in and make incremental Gustavo Niemeyers nested log patch, and remove all bare exceptions in store and transport packages.
366
        if self.show_ids:
367
            for parent_id in rev.parent_ids:
368
                print >>to_file, indent+'parent:', parent_id
369
        print >>to_file,  indent+'committer:', rev.committer
1185.35.17 by Aaron Bentley
Added branch nicks to long-format logs
370
        try:
371
            print >>to_file, indent+'branch nick: %s' % \
372
                rev.properties['branch-nick']
373
        except KeyError:
374
            pass
1433 by Robert Collins
merge in and make incremental Gustavo Niemeyers nested log patch, and remove all bare exceptions in store and transport packages.
375
        date_str = format_date(rev.timestamp,
376
                               rev.timezone or 0,
377
                               self.show_timezone)
378
        print >>to_file,  indent+'timestamp: %s' % date_str
379
380
        print >>to_file,  indent+'message:'
381
        if not rev.message:
382
            print >>to_file,  indent+'  (no message)'
383
        else:
1185.31.20 by John Arbash Meinel
Stripping trailing newlines when displaying log messages
384
            message = rev.message.rstrip('\r\n')
385
            for l in message.split('\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.
386
                print >>to_file,  indent+'  ' + l
1963.2.6 by Robey Pointer
pychecker is on crack; go back to using 'is None'.
387
        if delta is not None:
1185.33.41 by Martin Pool
Fix regression of 'bzr log -v' - it wasn't showing changed files at all. (#4676)
388
            delta.show(to_file, self.show_ids)
794 by Martin Pool
- Merge John's nice short-log format.
389
390
391
class ShortLogFormatter(LogFormatter):
392
    def show(self, revno, rev, delta):
393
        from bzrlib.osutils import format_date
394
395
        to_file = self.to_file
1185.12.25 by Aaron Bentley
Added one-line log format
396
        date_str = format_date(rev.timestamp, rev.timezone or 0,
397
                            self.show_timezone)
1988.4.2 by Robert Collins
``bzr log`` Now shows dotted-decimal revision numbers for all revisions,
398
        print >>to_file, "%5s %s\t%s" % (revno, self.short_committer(rev),
794 by Martin Pool
- Merge John's nice short-log format.
399
                format_date(rev.timestamp, rev.timezone or 0,
1185.35.19 by Aaron Bentley
Tweaked short-log as Meinel suggested
400
                            self.show_timezone, date_fmt="%Y-%m-%d",
401
                           show_offset=False))
794 by Martin Pool
- Merge John's nice short-log format.
402
        if self.show_ids:
403
            print >>to_file,  '      revision-id:', rev.revision_id
404
        if not rev.message:
405
            print >>to_file,  '      (no message)'
406
        else:
1185.31.20 by John Arbash Meinel
Stripping trailing newlines when displaying log messages
407
            message = rev.message.rstrip('\r\n')
408
            for l in message.split('\n'):
794 by Martin Pool
- Merge John's nice short-log format.
409
                print >>to_file,  '      ' + l
410
974.1.26 by aaron.bentley at utoronto
merged mbp@sourcefrog.net-20050817233101-0939da1cf91f2472
411
        # TODO: Why not show the modified files in a shorter form as
412
        # well? rewrap them single lines of appropriate length
1963.2.6 by Robey Pointer
pychecker is on crack; go back to using 'is None'.
413
        if delta is not None:
794 by Martin Pool
- Merge John's nice short-log format.
414
            delta.show(to_file, self.show_ids)
1185.31.21 by John Arbash Meinel
Added test for log formatting, found bug when redirecting short logs to a file instead of stdout.
415
        print >>to_file, ''
794 by Martin Pool
- Merge John's nice short-log format.
416
1704.2.20 by Martin Pool
log --line shows revision numbers (Alexander)
417
1185.12.25 by Aaron Bentley
Added one-line log format
418
class LineLogFormatter(LogFormatter):
419
    def truncate(self, str, max_len):
420
        if len(str) <= max_len:
421
            return str
422
        return str[:max_len-3]+'...'
423
424
    def date_string(self, rev):
425
        from bzrlib.osutils import format_date
426
        return format_date(rev.timestamp, rev.timezone or 0, 
427
                           self.show_timezone, date_fmt="%Y-%m-%d",
428
                           show_offset=False)
429
430
    def message(self, rev):
431
        if not rev.message:
432
            return '(no message)'
433
        else:
434
            return rev.message
435
436
    def show(self, revno, rev, delta):
1704.2.2 by Martin Pool
Detect terminal width using ioctl
437
        from bzrlib.osutils import terminal_width
1704.2.20 by Martin Pool
log --line shows revision numbers (Alexander)
438
        print >> self.to_file, self.log_string(revno, rev, terminal_width()-1)
1185.12.25 by Aaron Bentley
Added one-line log format
439
1704.2.20 by Martin Pool
log --line shows revision numbers (Alexander)
440
    def log_string(self, revno, rev, max_chars):
441
        """Format log info into one string. Truncate tail of string
442
        :param  revno:      revision number (int) or None.
443
                            Revision numbers counts from 1.
444
        :param  rev:        revision info object
445
        :param  max_chars:  maximum length of resulting string
446
        :return:            formatted truncated string
447
        """
448
        out = []
449
        if revno:
450
            # show revno only when is not None
1988.4.2 by Robert Collins
``bzr log`` Now shows dotted-decimal revision numbers for all revisions,
451
            out.append("%s:" % revno)
1704.2.20 by Martin Pool
log --line shows revision numbers (Alexander)
452
        out.append(self.truncate(self.short_committer(rev), 20))
1185.12.25 by Aaron Bentley
Added one-line log format
453
        out.append(self.date_string(rev))
1740.2.5 by Aaron Bentley
Merge from bzr.dev
454
        out.append(rev.get_summary())
1185.12.25 by Aaron Bentley
Added one-line log format
455
        return self.truncate(" ".join(out).rstrip('\n'), max_chars)
794 by Martin Pool
- Merge John's nice short-log format.
456
1704.2.20 by Martin Pool
log --line shows revision numbers (Alexander)
457
1185.12.27 by Aaron Bentley
Use line log for pending merges
458
def line_log(rev, max_chars):
459
    lf = LineLogFormatter(None)
1704.2.20 by Martin Pool
log --line shows revision numbers (Alexander)
460
    return lf.log_string(None, rev, max_chars)
1185.12.27 by Aaron Bentley
Use line log for pending merges
461
1553.2.4 by Erik Bågfors
Support for setting the default log format at a configuration option
462
FORMATTERS = {
1553.2.1 by Erik Bågfors
Support for plugins to register log formatters and set default formatter
463
              'long': LongLogFormatter,
794 by Martin Pool
- Merge John's nice short-log format.
464
              'short': ShortLogFormatter,
1185.12.25 by Aaron Bentley
Added one-line log format
465
              'line': LineLogFormatter,
794 by Martin Pool
- Merge John's nice short-log format.
466
              }
467
1553.2.1 by Erik Bågfors
Support for plugins to register log formatters and set default formatter
468
def register_formatter(name, formatter):
469
    FORMATTERS[name] = formatter
470
794 by Martin Pool
- Merge John's nice short-log format.
471
def log_formatter(name, *args, **kwargs):
1393.1.56 by Martin Pool
- doc and small refactoring of log code
472
    """Construct a formatter from arguments.
473
1185.12.27 by Aaron Bentley
Use line log for pending merges
474
    name -- Name of the formatter to construct; currently 'long', 'short' and
475
        'line' are supported.
1393.1.56 by Martin Pool
- doc and small refactoring of log code
476
    """
794 by Martin Pool
- Merge John's nice short-log format.
477
    from bzrlib.errors import BzrCommandError
478
    try:
479
        return FORMATTERS[name](*args, **kwargs)
1553.2.2 by Erik Bågfors
Made "unknown log formatter" error message work
480
    except KeyError:
794 by Martin Pool
- Merge John's nice short-log format.
481
        raise BzrCommandError("unknown log formatter: %r" % name)
974.1.26 by aaron.bentley at utoronto
merged mbp@sourcefrog.net-20050817233101-0939da1cf91f2472
482
483
def show_one_log(revno, rev, delta, verbose, to_file, show_timezone):
1759.2.1 by Jelmer Vernooij
Fix some types (found using aspell).
484
    # deprecated; for compatibility
974.1.26 by aaron.bentley at utoronto
merged mbp@sourcefrog.net-20050817233101-0939da1cf91f2472
485
    lf = LongLogFormatter(to_file=to_file, show_timezone=show_timezone)
486
    lf.show(revno, rev, delta)
1185.32.2 by John Arbash Meinel
Refactor pull --verbose into a log.py function, add tests.
487
488
def show_changed_revisions(branch, old_rh, new_rh, to_file=None, log_format='long'):
489
    """Show the change in revision history comparing the old revision history to the new one.
490
491
    :param branch: The branch where the revisions exist
492
    :param old_rh: The old revision history
493
    :param new_rh: The new revision history
494
    :param to_file: A file to write the results to. If None, stdout will be used
495
    """
496
    if to_file is None:
497
        import sys
498
        import codecs
499
        import bzrlib
500
        to_file = codecs.getwriter(bzrlib.user_encoding)(sys.stdout, errors='replace')
501
    lf = log_formatter(log_format,
502
                       show_ids=False,
503
                       to_file=to_file,
504
                       show_timezone='original')
505
506
    # This is the first index which is different between
507
    # old and new
508
    base_idx = None
509
    for i in xrange(max(len(new_rh),
510
                        len(old_rh))):
511
        if (len(new_rh) <= i
512
            or len(old_rh) <= i
513
            or new_rh[i] != old_rh[i]):
514
            base_idx = i
515
            break
516
517
    if base_idx is None:
518
        to_file.write('Nothing seems to have changed\n')
519
        return
520
    ## TODO: It might be nice to do something like show_log
521
    ##       and show the merged entries. But since this is the
522
    ##       removed revisions, it shouldn't be as important
523
    if base_idx < len(old_rh):
524
        to_file.write('*'*60)
525
        to_file.write('\nRemoved Revisions:\n')
526
        for i in range(base_idx, len(old_rh)):
1185.67.2 by Aaron Bentley
Renamed Branch.storage to Branch.repository
527
            rev = branch.repository.get_revision(old_rh[i])
1185.32.2 by John Arbash Meinel
Refactor pull --verbose into a log.py function, add tests.
528
            lf.show(i+1, rev, None)
529
        to_file.write('*'*60)
530
        to_file.write('\n\n')
531
    if base_idx < len(new_rh):
532
        to_file.write('Added Revisions:\n')
533
        show_log(branch,
534
                 lf,
535
                 None,
536
                 verbose=True,
537
                 direction='forward',
538
                 start_revision=base_idx+1,
539
                 end_revision=len(new_rh),
540
                 search=None)
541