~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/log.py

  • Committer: Martin Pool
  • Date: 2005-06-06 05:55:19 UTC
  • Revision ID: mbp@sourcefrog.net-20050606055519-2fa201b47cefec08
- fix permissions on exported tar/zip files

Show diffs side-by-side

added added

removed removed

Lines of Context:
28
28
 
29
29
* with file-ids and revision-ids shown
30
30
 
31
 
Logs are actually written out through an abstract LogFormatter
32
 
interface, which allows for different preferred formats.  Plugins can
33
 
register formats too.
34
 
 
35
 
Logs can be produced in either forward (oldest->newest) or reverse
36
 
(newest->oldest) order.
37
 
 
38
 
Logs can be filtered to show only revisions matching a particular
39
 
search string, or within a particular range of revisions.  The range
40
 
can be given as date/times, which are reduced to revisions before
41
 
calling in here.
42
 
 
43
 
In verbose mode we show a summary of what changed in each particular
44
 
revision.  Note that this is the delta for changes in that revision
45
 
relative to its 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.
 
31
* from last to first or (not anymore) from first to last;
 
32
  the default is "reversed" because it shows the likely most
 
33
  relevant and interesting information first
 
34
 
 
35
* (not yet) in XML format
50
36
"""
51
37
 
52
 
# TODO: option to show delta summaries for merged-in revisions
53
 
 
54
 
from itertools import izip
55
 
import re
56
 
 
57
 
import bzrlib.errors as errors
58
 
from bzrlib.trace import mutter
59
 
from bzrlib.tsort import merge_sort
60
 
 
 
38
 
 
39
from trace import mutter
61
40
 
62
41
def find_touching_revisions(branch, file_id):
63
42
    """Yield a description of revisions which affect the file_id.
74
53
    last_path = None
75
54
    revno = 1
76
55
    for revision_id in branch.revision_history():
77
 
        this_inv = branch.repository.get_revision_inventory(revision_id)
 
56
        this_inv = branch.get_revision_inventory(revision_id)
78
57
        if file_id in this_inv:
79
58
            this_ie = this_inv[file_id]
80
59
            this_path = this_inv.id2path(file_id)
104
83
 
105
84
 
106
85
 
107
 
def _enumerate_history(branch):
108
 
    rh = []
109
 
    revno = 1
110
 
    for rev_id in branch.revision_history():
111
 
        rh.append((revno, rev_id))
112
 
        revno += 1
113
 
    return rh
114
 
 
115
 
 
116
86
def show_log(branch,
117
 
             lf,
118
87
             specific_fileid=None,
 
88
             show_timezone='original',
119
89
             verbose=False,
 
90
             show_ids=False,
 
91
             to_file=None,
120
92
             direction='reverse',
121
93
             start_revision=None,
122
 
             end_revision=None,
123
 
             search=None):
 
94
             end_revision=None):
124
95
    """Write out human-readable log of commits to this branch.
125
96
 
126
 
    lf
127
 
        LogFormatter object to show the output.
128
 
 
129
97
    specific_fileid
130
98
        If true, list only the commits affecting the specified
131
99
        file, rather than all commits.
132
100
 
 
101
    show_timezone
 
102
        'original' (committer's timezone),
 
103
        'utc' (universal time), or
 
104
        'local' (local user's timezone)
 
105
 
133
106
    verbose
134
107
        If true show added/changed/deleted/renamed files.
135
108
 
 
109
    show_ids
 
110
        If true, show revision and file ids.
 
111
 
 
112
    to_file
 
113
        File to send log to; by default stdout.
 
114
 
136
115
    direction
137
116
        'reverse' (default) is latest to earliest;
138
117
        'forward' is earliest to latest.
143
122
    end_revision
144
123
        If not None, only show revisions <= end_revision
145
124
    """
146
 
    branch.lock_read()
147
 
    try:
148
 
        _show_log(branch, lf, specific_fileid, verbose, direction,
149
 
                  start_revision, end_revision, search)
150
 
    finally:
151
 
        branch.unlock()
152
 
    
153
 
def _show_log(branch,
154
 
             lf,
155
 
             specific_fileid=None,
156
 
             verbose=False,
157
 
             direction='reverse',
158
 
             start_revision=None,
159
 
             end_revision=None,
160
 
             search=None):
161
 
    """Worker function for show_log - see show_log."""
162
 
    from bzrlib.osutils import format_date
163
 
    from bzrlib.errors import BzrCheckError
164
 
    
165
 
    from warnings import warn
 
125
    from osutils import format_date
 
126
    from errors import BzrCheckError
 
127
    from textui import show_status
166
128
 
167
 
    if not isinstance(lf, LogFormatter):
168
 
        warn("not a LogFormatter instance: %r" % lf)
169
129
 
170
130
    if specific_fileid:
171
 
        mutter('get log for file_id %r', specific_fileid)
172
 
 
173
 
    if search is not None:
174
 
        import re
175
 
        searchRE = re.compile(search, re.IGNORECASE)
176
 
    else:
177
 
        searchRE = None
178
 
 
179
 
    which_revs = _enumerate_history(branch)
180
 
    
181
 
    if start_revision is None:
182
 
        start_revision = 1
183
 
    else:
184
 
        branch.check_real_revno(start_revision)
185
 
    
186
 
    if end_revision is None:
187
 
        end_revision = len(which_revs)
188
 
    else:
189
 
        branch.check_real_revno(end_revision)
190
 
 
191
 
    # list indexes are 0-based; revisions are 1-based
192
 
    cut_revs = which_revs[(start_revision-1):(end_revision)]
193
 
    if not cut_revs:
194
 
        return
195
 
 
196
 
    # convert the revision history to a dictionary:
197
 
    rev_nos = dict((k, v) for v, k in cut_revs)
198
 
 
199
 
    # override the mainline to look like the revision history.
200
 
    mainline_revs = [revision_id for index, revision_id in cut_revs]
201
 
    if cut_revs[0][0] == 1:
202
 
        mainline_revs.insert(0, None)
203
 
    else:
204
 
        mainline_revs.insert(0, which_revs[start_revision-2][1])
205
 
    if getattr(lf, 'show_merge', None) is not None:
206
 
        include_merges = True 
207
 
    else:
208
 
        include_merges = False 
209
 
    view_revisions = list(get_view_revisions(mainline_revs, rev_nos, branch,
210
 
                          direction, include_merges=include_merges))
211
 
 
212
 
    def iter_revisions():
213
 
        # r = revision, n = revno, d = merge depth
214
 
        revision_ids = [r for r, n, d in view_revisions]
215
 
        zeros = set(r for r, n, d in view_revisions if d == 0)
216
 
        num = 9
217
 
        repository = branch.repository
218
 
        while revision_ids:
219
 
            cur_deltas = {}
220
 
            revisions = repository.get_revisions(revision_ids[:num])
221
 
            if verbose or specific_fileid:
222
 
                delta_revisions = [r for r in revisions if
223
 
                                   r.revision_id in zeros]
224
 
                deltas = repository.get_deltas_for_revisions(delta_revisions)
225
 
                cur_deltas = dict(izip((r.revision_id for r in 
226
 
                                        delta_revisions), deltas))
227
 
            for revision in revisions:
228
 
                # The delta value will be None unless
229
 
                # 1. verbose or specific_fileid is specified, and
230
 
                # 2. the revision is a mainline revision
231
 
                yield revision, cur_deltas.get(revision.revision_id)
232
 
            revision_ids  = revision_ids[num:]
233
 
            num = int(num * 1.5)
 
131
        mutter('get log for file_id %r' % specific_fileid)
 
132
 
 
133
    if to_file == None:
 
134
        import sys
 
135
        to_file = sys.stdout
 
136
 
 
137
    which_revs = branch.enum_history(direction)
 
138
 
 
139
    if not (verbose or specific_fileid):
 
140
        # no need to know what changed between revisions
 
141
        with_deltas = deltas_for_log_dummy(branch, which_revs)
 
142
    elif direction == 'reverse':
 
143
        with_deltas = deltas_for_log_reverse(branch, which_revs)
 
144
    else:        
 
145
        raise NotImplementedError("sorry, verbose forward logs not done yet")
 
146
 
 
147
    for revno, rev, delta in with_deltas:
 
148
        if specific_fileid:
 
149
            if not delta.touches_file_id(specific_fileid):
 
150
                continue
 
151
 
 
152
        if start_revision is not None and revno < start_revision:
 
153
            continue
 
154
 
 
155
        if end_revision is not None and revno > end_revision:
 
156
            continue
 
157
        
 
158
        if not verbose:
 
159
            # although we calculated it, throw it away without display
 
160
            delta = None
234
161
            
235
 
    # now we just print all the revisions
236
 
    for ((rev_id, revno, merge_depth), (rev, delta)) in \
237
 
         izip(view_revisions, iter_revisions()):
238
 
 
239
 
        if searchRE:
240
 
            if not searchRE.search(rev.message):
241
 
                continue
242
 
 
243
 
        if merge_depth == 0:
244
 
            # a mainline revision.
245
 
                
246
 
            if specific_fileid:
247
 
                if not delta.touches_file_id(specific_fileid):
248
 
                    continue
249
 
    
250
 
            if not verbose:
251
 
                # although we calculated it, throw it away without display
252
 
                delta = None
253
 
 
254
 
            lf.show(revno, rev, delta)
255
 
        else:
256
 
            lf.show_merge(rev, merge_depth)
257
 
 
258
 
 
259
 
def get_view_revisions(mainline_revs, rev_nos, branch, direction,
260
 
                       include_merges=True):
261
 
    """Produce an iterator of revisions to show
262
 
    :return: an iterator of (revision_id, revno, merge_depth)
263
 
    (if there is no revno for a revision, None is supplied)
264
 
    """
265
 
    if include_merges is False:
266
 
        revision_ids = mainline_revs[1:]
267
 
        if direction == 'reverse':
268
 
            revision_ids.reverse()
269
 
        for revision_id in revision_ids:
270
 
            yield revision_id, rev_nos[revision_id], 0
271
 
        return
272
 
    merge_sorted_revisions = merge_sort(
273
 
        branch.repository.get_revision_graph(mainline_revs[-1]),
274
 
        mainline_revs[-1],
275
 
        mainline_revs)
276
 
 
277
 
    if direction == 'forward':
278
 
        # forward means oldest first.
279
 
        merge_sorted_revisions = reverse_by_depth(merge_sorted_revisions)
280
 
    elif direction != 'reverse':
281
 
        raise ValueError('invalid direction %r' % direction)
282
 
 
283
 
    revision_history = branch.revision_history()
284
 
 
285
 
    for sequence, rev_id, merge_depth, end_of_merge in merge_sorted_revisions:
286
 
        yield rev_id, rev_nos.get(rev_id), merge_depth
287
 
 
288
 
 
289
 
def reverse_by_depth(merge_sorted_revisions, _depth=0):
290
 
    """Reverse revisions by depth.
291
 
 
292
 
    Revisions with a different depth are sorted as a group with the previous
293
 
    revision of that depth.  There may be no topological justification for this,
294
 
    but it looks much nicer.
295
 
    """
296
 
    zd_revisions = []
297
 
    for val in merge_sorted_revisions:
298
 
        if val[2] == _depth:
299
 
            zd_revisions.append([val])
300
 
        else:
301
 
            assert val[2] > _depth
302
 
            zd_revisions[-1].append(val)
303
 
    for revisions in zd_revisions:
304
 
        if len(revisions) > 1:
305
 
            revisions[1:] = reverse_by_depth(revisions[1:], _depth + 1)
306
 
    zd_revisions.reverse()
307
 
    result = []
308
 
    for chunk in zd_revisions:
309
 
        result.extend(chunk)
310
 
    return result
311
 
 
312
 
 
313
 
class LogFormatter(object):
314
 
    """Abstract class to display log messages."""
315
 
 
316
 
    def __init__(self, to_file, show_ids=False, show_timezone='original'):
317
 
        self.to_file = to_file
318
 
        self.show_ids = show_ids
319
 
        self.show_timezone = show_timezone
320
 
 
321
 
    def show(self, revno, rev, delta):
322
 
        raise NotImplementedError('not implemented in abstract base')
323
 
 
324
 
    def short_committer(self, rev):
325
 
        return re.sub('<.*@.*>', '', rev.committer).strip(' ')
326
 
    
327
 
    
328
 
class LongLogFormatter(LogFormatter):
329
 
    def show(self, revno, rev, delta):
330
 
        return self._show_helper(revno=revno, rev=rev, delta=delta)
331
 
 
332
 
    def show_merge(self, rev, merge_depth):
333
 
        return self._show_helper(rev=rev, indent='    '*merge_depth, merged=True, delta=None)
334
 
 
335
 
    def _show_helper(self, rev=None, revno=None, indent='', merged=False, delta=None):
336
 
        """Show a revision, either merged or not."""
337
 
        from bzrlib.osutils import format_date
338
 
        to_file = self.to_file
339
 
        print >>to_file,  indent+'-' * 60
340
 
        if revno is not None:
341
 
            print >>to_file,  'revno:', revno
342
 
        if merged:
343
 
            print >>to_file,  indent+'merged:', rev.revision_id
344
 
        elif self.show_ids:
345
 
            print >>to_file,  indent+'revision-id:', rev.revision_id
346
 
        if self.show_ids:
347
 
            for parent_id in rev.parent_ids:
348
 
                print >>to_file, indent+'parent:', parent_id
349
 
        print >>to_file,  indent+'committer:', rev.committer
350
 
        try:
351
 
            print >>to_file, indent+'branch nick: %s' % \
352
 
                rev.properties['branch-nick']
353
 
        except KeyError:
354
 
            pass
355
 
        date_str = format_date(rev.timestamp,
356
 
                               rev.timezone or 0,
357
 
                               self.show_timezone)
358
 
        print >>to_file,  indent+'timestamp: %s' % date_str
359
 
 
360
 
        print >>to_file,  indent+'message:'
361
 
        if not rev.message:
362
 
            print >>to_file,  indent+'  (no message)'
363
 
        else:
364
 
            message = rev.message.rstrip('\r\n')
365
 
            for l in message.split('\n'):
366
 
                print >>to_file,  indent+'  ' + l
367
 
        if delta != None:
368
 
            delta.show(to_file, self.show_ids)
369
 
 
370
 
 
371
 
class ShortLogFormatter(LogFormatter):
372
 
    def show(self, revno, rev, delta):
373
 
        from bzrlib.osutils import format_date
374
 
 
375
 
        to_file = self.to_file
376
 
        date_str = format_date(rev.timestamp, rev.timezone or 0,
377
 
                            self.show_timezone)
378
 
        print >>to_file, "%5d %s\t%s" % (revno, self.short_committer(rev),
379
 
                format_date(rev.timestamp, rev.timezone or 0,
380
 
                            self.show_timezone, date_fmt="%Y-%m-%d",
381
 
                           show_offset=False))
382
 
        if self.show_ids:
383
 
            print >>to_file,  '      revision-id:', rev.revision_id
384
 
        if not rev.message:
385
 
            print >>to_file,  '      (no message)'
386
 
        else:
387
 
            message = rev.message.rstrip('\r\n')
388
 
            for l in message.split('\n'):
389
 
                print >>to_file,  '      ' + l
390
 
 
391
 
        # TODO: Why not show the modified files in a shorter form as
392
 
        # well? rewrap them single lines of appropriate length
393
 
        if delta != None:
394
 
            delta.show(to_file, self.show_ids)
395
 
        print >>to_file, ''
396
 
 
397
 
 
398
 
class LineLogFormatter(LogFormatter):
399
 
    def truncate(self, str, max_len):
400
 
        if len(str) <= max_len:
401
 
            return str
402
 
        return str[:max_len-3]+'...'
403
 
 
404
 
    def date_string(self, rev):
405
 
        from bzrlib.osutils import format_date
406
 
        return format_date(rev.timestamp, rev.timezone or 0, 
407
 
                           self.show_timezone, date_fmt="%Y-%m-%d",
408
 
                           show_offset=False)
409
 
 
410
 
    def message(self, rev):
411
 
        if not rev.message:
412
 
            return '(no message)'
413
 
        else:
414
 
            return rev.message
415
 
 
416
 
    def show(self, revno, rev, delta):
417
 
        from bzrlib.osutils import terminal_width
418
 
        print >> self.to_file, self.log_string(revno, rev, terminal_width()-1)
419
 
 
420
 
    def log_string(self, revno, rev, max_chars):
421
 
        """Format log info into one string. Truncate tail of string
422
 
        :param  revno:      revision number (int) or None.
423
 
                            Revision numbers counts from 1.
424
 
        :param  rev:        revision info object
425
 
        :param  max_chars:  maximum length of resulting string
426
 
        :return:            formatted truncated string
427
 
        """
428
 
        out = []
429
 
        if revno:
430
 
            # show revno only when is not None
431
 
            out.append("%d:" % revno)
432
 
        out.append(self.truncate(self.short_committer(rev), 20))
433
 
        out.append(self.date_string(rev))
434
 
        out.append(rev.get_summary())
435
 
        return self.truncate(" ".join(out).rstrip('\n'), max_chars)
436
 
 
437
 
 
438
 
def line_log(rev, max_chars):
439
 
    lf = LineLogFormatter(None)
440
 
    return lf.log_string(None, rev, max_chars)
441
 
 
442
 
FORMATTERS = {
443
 
              'long': LongLogFormatter,
444
 
              'short': ShortLogFormatter,
445
 
              'line': LineLogFormatter,
446
 
              }
447
 
 
448
 
def register_formatter(name, formatter):
449
 
    FORMATTERS[name] = formatter
450
 
 
451
 
def log_formatter(name, *args, **kwargs):
452
 
    """Construct a formatter from arguments.
453
 
 
454
 
    name -- Name of the formatter to construct; currently 'long', 'short' and
455
 
        'line' are supported.
456
 
    """
457
 
    from bzrlib.errors import BzrCommandError
458
 
    try:
459
 
        return FORMATTERS[name](*args, **kwargs)
460
 
    except KeyError:
461
 
        raise BzrCommandError("unknown log formatter: %r" % name)
462
 
 
463
 
def show_one_log(revno, rev, delta, verbose, to_file, show_timezone):
464
 
    # deprecated; for compatibility
465
 
    lf = LongLogFormatter(to_file=to_file, show_timezone=show_timezone)
466
 
    lf.show(revno, rev, delta)
467
 
 
468
 
def show_changed_revisions(branch, old_rh, new_rh, to_file=None, log_format='long'):
469
 
    """Show the change in revision history comparing the old revision history to the new one.
470
 
 
471
 
    :param branch: The branch where the revisions exist
472
 
    :param old_rh: The old revision history
473
 
    :param new_rh: The new revision history
474
 
    :param to_file: A file to write the results to. If None, stdout will be used
475
 
    """
476
 
    if to_file is None:
477
 
        import sys
478
 
        import codecs
479
 
        import bzrlib
480
 
        to_file = codecs.getwriter(bzrlib.user_encoding)(sys.stdout, errors='replace')
481
 
    lf = log_formatter(log_format,
482
 
                       show_ids=False,
483
 
                       to_file=to_file,
484
 
                       show_timezone='original')
485
 
 
486
 
    # This is the first index which is different between
487
 
    # old and new
488
 
    base_idx = None
489
 
    for i in xrange(max(len(new_rh),
490
 
                        len(old_rh))):
491
 
        if (len(new_rh) <= i
492
 
            or len(old_rh) <= i
493
 
            or new_rh[i] != old_rh[i]):
494
 
            base_idx = i
495
 
            break
496
 
 
497
 
    if base_idx is None:
498
 
        to_file.write('Nothing seems to have changed\n')
499
 
        return
500
 
    ## TODO: It might be nice to do something like show_log
501
 
    ##       and show the merged entries. But since this is the
502
 
    ##       removed revisions, it shouldn't be as important
503
 
    if base_idx < len(old_rh):
504
 
        to_file.write('*'*60)
505
 
        to_file.write('\nRemoved Revisions:\n')
506
 
        for i in range(base_idx, len(old_rh)):
507
 
            rev = branch.repository.get_revision(old_rh[i])
508
 
            lf.show(i+1, rev, None)
509
 
        to_file.write('*'*60)
510
 
        to_file.write('\n\n')
511
 
    if base_idx < len(new_rh):
512
 
        to_file.write('Added Revisions:\n')
513
 
        show_log(branch,
514
 
                 lf,
515
 
                 None,
516
 
                 verbose=True,
517
 
                 direction='forward',
518
 
                 start_revision=base_idx+1,
519
 
                 end_revision=len(new_rh),
520
 
                 search=None)
521
 
 
 
162
        show_one_log(revno, rev, delta, show_ids, to_file, show_timezone)
 
163
 
 
164
 
 
165
 
 
166
def deltas_for_log_dummy(branch, which_revs):
 
167
    for revno, revision_id in which_revs:
 
168
        yield revno, branch.get_revision(revision_id), None
 
169
 
 
170
 
 
171
def deltas_for_log_reverse(branch, which_revs):
 
172
    """Compute deltas for display in reverse log.
 
173
 
 
174
    Given a sequence of (revno, revision_id) pairs, return
 
175
    (revno, rev, delta).
 
176
 
 
177
    The delta is from the given revision to the next one in the
 
178
    sequence, which makes sense if the log is being displayed from
 
179
    newest to oldest.
 
180
    """
 
181
    from tree import EmptyTree
 
182
    from diff import compare_trees
 
183
    
 
184
    last_revno = last_revision_id = last_tree = None
 
185
    for revno, revision_id in which_revs:
 
186
        this_tree = branch.revision_tree(revision_id)
 
187
        this_revision = branch.get_revision(revision_id)
 
188
        
 
189
        if last_revno:
 
190
            yield last_revno, last_revision, compare_trees(this_tree, last_tree, False)
 
191
 
 
192
        last_revno = revno
 
193
        last_revision = this_revision
 
194
        last_tree = this_tree
 
195
 
 
196
    if last_revno:
 
197
        this_tree = EmptyTree()
 
198
        yield last_revno, last_revision, compare_trees(this_tree, last_tree, False)
 
199
 
 
200
 
 
201
 
 
202
def junk():
 
203
    precursor = None
 
204
    if verbose:
 
205
        from tree import EmptyTree
 
206
        prev_tree = EmptyTree()
 
207
    for revno, revision_id in which_revs:
 
208
        precursor = revision_id
 
209
 
 
210
    if revision_id != rev.revision_id:
 
211
        raise BzrCheckError("retrieved wrong revision: %r"
 
212
                            % (revision_id, rev.revision_id))
 
213
 
 
214
    if verbose:
 
215
        this_tree = branch.revision_tree(revision_id)
 
216
        delta = compare_trees(prev_tree, this_tree, want_unchanged=False)
 
217
        prev_tree = this_tree
 
218
    else:
 
219
        delta = None    
 
220
 
 
221
 
 
222
 
 
223
def show_one_log(revno, rev, delta, show_ids, to_file, show_timezone):
 
224
    from osutils import format_date
 
225
    
 
226
    print >>to_file,  '-' * 60
 
227
    print >>to_file,  'revno:', revno
 
228
    if show_ids:
 
229
        print >>to_file,  'revision-id:', rev.revision_id
 
230
    print >>to_file,  'committer:', rev.committer
 
231
    print >>to_file,  'timestamp: %s' % (format_date(rev.timestamp, rev.timezone or 0,
 
232
                                         show_timezone))
 
233
 
 
234
    print >>to_file,  'message:'
 
235
    if not rev.message:
 
236
        print >>to_file,  '  (no message)'
 
237
    else:
 
238
        for l in rev.message.split('\n'):
 
239
            print >>to_file,  '  ' + l
 
240
 
 
241
    if delta != None:
 
242
        delta.show(to_file, show_ids)