/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to bzrlib/log.py

  • Committer: Jelmer Vernooij
  • Date: 2006-06-21 13:54:14 UTC
  • mto: (1558.14.8 Aaron's integration)
  • mto: This revision was merged to the branch mainline in revision 1803.
  • Revision ID: jelmer@samba.org-20060621135414-11a3a70e53adbb99
Install benchmarks.

Show diffs side-by-side

added added

removed removed

Lines of Context:
49
49
all the changes since the previous revision that touched hello.c.
50
50
"""
51
51
 
52
 
 
53
 
from bzrlib.tree import EmptyTree
 
52
# TODO: option to show delta summaries for merged-in revisions
 
53
 
 
54
from itertools import izip
 
55
import re
 
56
 
54
57
from bzrlib.delta import compare_trees
 
58
import bzrlib.errors as errors
55
59
from bzrlib.trace import mutter
56
 
from bzrlib.errors import InvalidRevisionNumber
 
60
from bzrlib.tree import EmptyTree
 
61
from bzrlib.tsort import merge_sort
57
62
 
58
63
 
59
64
def find_touching_revisions(branch, file_id):
71
76
    last_path = None
72
77
    revno = 1
73
78
    for revision_id in branch.revision_history():
74
 
        this_inv = branch.get_revision_inventory(revision_id)
 
79
        this_inv = branch.repository.get_revision_inventory(revision_id)
75
80
        if file_id in this_inv:
76
81
            this_ie = this_inv[file_id]
77
82
            this_path = this_inv.id2path(file_id)
110
115
    return rh
111
116
 
112
117
 
 
118
def _get_revision_delta(branch, revno):
 
119
    """Return the delta for a mainline revision.
 
120
    
 
121
    This is used to show summaries in verbose logs, and also for finding 
 
122
    revisions which touch a given file."""
 
123
    # XXX: What are we supposed to do when showing a summary for something 
 
124
    # other than a mainline revision.  The delta to it's first parent, or
 
125
    # (more useful) the delta to a nominated other revision.
 
126
    return branch.get_revision_delta(revno)
 
127
 
 
128
 
113
129
def show_log(branch,
114
130
             lf,
115
131
             specific_fileid=None,
140
156
    end_revision
141
157
        If not None, only show revisions <= end_revision
142
158
    """
 
159
    branch.lock_read()
 
160
    try:
 
161
        _show_log(branch, lf, specific_fileid, verbose, direction,
 
162
                  start_revision, end_revision, search)
 
163
    finally:
 
164
        branch.unlock()
 
165
    
 
166
def _show_log(branch,
 
167
             lf,
 
168
             specific_fileid=None,
 
169
             verbose=False,
 
170
             direction='reverse',
 
171
             start_revision=None,
 
172
             end_revision=None,
 
173
             search=None):
 
174
    """Worker function for show_log - see show_log."""
143
175
    from bzrlib.osutils import format_date
144
176
    from bzrlib.errors import BzrCheckError
145
177
    from bzrlib.textui import show_status
150
182
        warn("not a LogFormatter instance: %r" % lf)
151
183
 
152
184
    if specific_fileid:
153
 
        mutter('get log for file_id %r' % specific_fileid)
 
185
        mutter('get log for file_id %r', specific_fileid)
154
186
 
155
187
    if search is not None:
156
188
        import re
162
194
    
163
195
    if start_revision is None:
164
196
        start_revision = 1
165
 
    elif start_revision < 1 or start_revision >= len(which_revs):
166
 
        raise InvalidRevisionNumber(start_revision)
 
197
    else:
 
198
        branch.check_real_revno(start_revision)
167
199
    
168
200
    if end_revision is None:
169
201
        end_revision = len(which_revs)
170
 
    elif end_revision < 1 or end_revision >= len(which_revs):
171
 
        raise InvalidRevisionNumber(end_revision)
 
202
    else:
 
203
        branch.check_real_revno(end_revision)
172
204
 
173
205
    # list indexes are 0-based; revisions are 1-based
174
206
    cut_revs = which_revs[(start_revision-1):(end_revision)]
 
207
    if not cut_revs:
 
208
        return
 
209
    # override the mainline to look like the revision history.
 
210
    mainline_revs = [revision_id for index, revision_id in cut_revs]
 
211
    if cut_revs[0][0] == 1:
 
212
        mainline_revs.insert(0, None)
 
213
    else:
 
214
        mainline_revs.insert(0, which_revs[start_revision-2][1])
 
215
 
 
216
    merge_sorted_revisions = merge_sort(
 
217
        branch.repository.get_revision_graph(mainline_revs[-1]),
 
218
        mainline_revs[-1],
 
219
        mainline_revs)
175
220
 
176
221
    if direction == 'reverse':
177
222
        cut_revs.reverse()
178
223
    elif direction == 'forward':
179
 
        pass
 
224
        # forward means oldest first.
 
225
        merge_sorted_revisions.reverse()
180
226
    else:
181
227
        raise ValueError('invalid direction %r' % direction)
182
228
 
183
 
    for revno, rev_id in cut_revs:
184
 
        if verbose or specific_fileid:
185
 
            delta = branch.get_revision_delta(revno)
 
229
    revision_history = branch.revision_history()
 
230
 
 
231
    # convert the revision history to a dictionary:
 
232
    rev_nos = {}
 
233
    for index, rev_id in cut_revs:
 
234
        rev_nos[rev_id] = index
 
235
 
 
236
    def iter_revisions():
 
237
        revision_ids = [r for s, r, m, e in merge_sorted_revisions]
 
238
        num = 9
 
239
        while revision_ids:
 
240
            revisions = branch.repository.get_revisions(revision_ids[:num])
 
241
            for revision in revisions:
 
242
                yield revision
 
243
            revision_ids  = revision_ids[num:]
 
244
            num = int(num * 1.5)
186
245
            
187
 
        if specific_fileid:
188
 
            if not delta.touches_file_id(specific_fileid):
189
 
                continue
190
 
 
191
 
        if not verbose:
192
 
            # although we calculated it, throw it away without display
193
 
            delta = None
194
 
 
195
 
        rev = branch.get_revision(rev_id)
 
246
        revisions = branch.repository.get_revisions()
 
247
        for revision in revisions:
 
248
            yield revision
 
249
    # now we just print all the revisions
 
250
    for ((sequence, rev_id, merge_depth, end_of_merge), rev) in \
 
251
        izip(merge_sorted_revisions, iter_revisions()):
196
252
 
197
253
        if searchRE:
198
254
            if not searchRE.search(rev.message):
199
255
                continue
200
256
 
201
 
        lf.show(revno, rev, delta)
202
 
 
203
 
 
204
 
 
205
 
def deltas_for_log_dummy(branch, which_revs):
206
 
    """Return all the revisions without intermediate deltas.
207
 
 
208
 
    Useful for log commands that won't need the delta information.
209
 
    """
 
257
        if merge_depth == 0:
 
258
            # a mainline revision.
 
259
            if verbose or specific_fileid:
 
260
                delta = _get_revision_delta(branch, rev_nos[rev_id])
 
261
                
 
262
            if specific_fileid:
 
263
                if not delta.touches_file_id(specific_fileid):
 
264
                    continue
210
265
    
211
 
    for revno, revision_id in which_revs:
212
 
        yield revno, branch.get_revision(revision_id), None
213
 
 
214
 
 
215
 
def deltas_for_log_reverse(branch, which_revs):
216
 
    """Compute deltas for display in latest-to-earliest order.
217
 
 
218
 
    branch
219
 
        Branch to traverse
220
 
 
221
 
    which_revs
222
 
        Sequence of (revno, revision_id) for the subset of history to examine
223
 
 
224
 
    returns 
225
 
        Sequence of (revno, rev, delta)
226
 
 
227
 
    The delta is from the given revision to the next one in the
228
 
    sequence, which makes sense if the log is being displayed from
229
 
    newest to oldest.
230
 
    """
231
 
    last_revno = last_revision_id = last_tree = None
232
 
    for revno, revision_id in which_revs:
233
 
        this_tree = branch.revision_tree(revision_id)
234
 
        this_revision = branch.get_revision(revision_id)
235
 
        
236
 
        if last_revno:
237
 
            yield last_revno, last_revision, compare_trees(this_tree, last_tree, False)
238
 
 
239
 
        this_tree = EmptyTree(branch.get_root_id())
240
 
 
241
 
        last_revno = revno
242
 
        last_revision = this_revision
243
 
        last_tree = this_tree
244
 
 
245
 
    if last_revno:
246
 
        if last_revno == 1:
247
 
            this_tree = EmptyTree(branch.get_root_id())
248
 
        else:
249
 
            this_revno = last_revno - 1
250
 
            this_revision_id = branch.revision_history()[this_revno]
251
 
            this_tree = branch.revision_tree(this_revision_id)
252
 
        yield last_revno, last_revision, compare_trees(this_tree, last_tree, False)
253
 
 
254
 
 
255
 
def deltas_for_log_forward(branch, which_revs):
256
 
    """Compute deltas for display in forward log.
257
 
 
258
 
    Given a sequence of (revno, revision_id) pairs, return
259
 
    (revno, rev, delta).
260
 
 
261
 
    The delta is from the given revision to the next one in the
262
 
    sequence, which makes sense if the log is being displayed from
263
 
    newest to oldest.
264
 
    """
265
 
    last_revno = last_revision_id = last_tree = None
266
 
    prev_tree = EmptyTree(branch.get_root_id())
267
 
 
268
 
    for revno, revision_id in which_revs:
269
 
        this_tree = branch.revision_tree(revision_id)
270
 
        this_revision = branch.get_revision(revision_id)
271
 
 
272
 
        if not last_revno:
273
 
            if revno == 1:
274
 
                last_tree = EmptyTree(branch.get_root_id())
275
 
            else:
276
 
                last_revno = revno - 1
277
 
                last_revision_id = branch.revision_history()[last_revno]
278
 
                last_tree = branch.revision_tree(last_revision_id)
279
 
 
280
 
        yield revno, this_revision, compare_trees(last_tree, this_tree, False)
281
 
 
282
 
        last_revno = revno
283
 
        last_revision = this_revision
284
 
        last_tree = this_tree
 
266
            if not verbose:
 
267
                # although we calculated it, throw it away without display
 
268
                delta = None
 
269
 
 
270
            lf.show(rev_nos[rev_id], rev, delta)
 
271
        elif hasattr(lf, 'show_merge'):
 
272
            lf.show_merge(rev, merge_depth)
285
273
 
286
274
 
287
275
class LogFormatter(object):
288
276
    """Abstract class to display log messages."""
 
277
 
289
278
    def __init__(self, to_file, show_ids=False, show_timezone='original'):
290
279
        self.to_file = to_file
291
280
        self.show_ids = show_ids
292
281
        self.show_timezone = show_timezone
293
282
 
294
 
 
295
283
    def show(self, revno, rev, delta):
296
284
        raise NotImplementedError('not implemented in abstract base')
297
 
        
298
 
 
299
 
 
300
 
 
301
 
 
302
 
 
 
285
 
 
286
    def short_committer(self, rev):
 
287
        return re.sub('<.*@.*>', '', rev.committer).strip(' ')
 
288
    
 
289
    
303
290
class LongLogFormatter(LogFormatter):
304
291
    def show(self, revno, rev, delta):
305
 
        from osutils import format_date
306
 
 
 
292
        return self._show_helper(revno=revno, rev=rev, delta=delta)
 
293
 
 
294
    def show_merge(self, rev, merge_depth):
 
295
        return self._show_helper(rev=rev, indent='    '*merge_depth, merged=True, delta=None)
 
296
 
 
297
    def _show_helper(self, rev=None, revno=None, indent='', merged=False, delta=None):
 
298
        """Show a revision, either merged or not."""
 
299
        from bzrlib.osutils import format_date
307
300
        to_file = self.to_file
308
 
 
309
 
        print >>to_file,  '-' * 60
310
 
        print >>to_file,  'revno:', revno
 
301
        print >>to_file,  indent+'-' * 60
 
302
        if revno is not None:
 
303
            print >>to_file,  'revno:', revno
 
304
        if merged:
 
305
            print >>to_file,  indent+'merged:', rev.revision_id
 
306
        elif self.show_ids:
 
307
            print >>to_file,  indent+'revision-id:', rev.revision_id
311
308
        if self.show_ids:
312
 
            print >>to_file,  'revision-id:', rev.revision_id
313
 
        print >>to_file,  'committer:', rev.committer
314
 
 
 
309
            for parent_id in rev.parent_ids:
 
310
                print >>to_file, indent+'parent:', parent_id
 
311
        print >>to_file,  indent+'committer:', rev.committer
 
312
        try:
 
313
            print >>to_file, indent+'branch nick: %s' % \
 
314
                rev.properties['branch-nick']
 
315
        except KeyError:
 
316
            pass
315
317
        date_str = format_date(rev.timestamp,
316
318
                               rev.timezone or 0,
317
319
                               self.show_timezone)
318
 
        print >>to_file,  'timestamp: %s' % date_str
 
320
        print >>to_file,  indent+'timestamp: %s' % date_str
319
321
 
320
 
        print >>to_file,  'message:'
 
322
        print >>to_file,  indent+'message:'
321
323
        if not rev.message:
322
 
            print >>to_file,  '  (no message)'
 
324
            print >>to_file,  indent+'  (no message)'
323
325
        else:
324
 
            for l in rev.message.split('\n'):
325
 
                print >>to_file,  '  ' + l
326
 
 
 
326
            message = rev.message.rstrip('\r\n')
 
327
            for l in message.split('\n'):
 
328
                print >>to_file,  indent+'  ' + l
327
329
        if delta != None:
328
330
            delta.show(to_file, self.show_ids)
329
331
 
330
332
 
331
 
 
332
333
class ShortLogFormatter(LogFormatter):
333
334
    def show(self, revno, rev, delta):
334
335
        from bzrlib.osutils import format_date
335
336
 
336
337
        to_file = self.to_file
337
 
 
338
 
        print >>to_file, "%5d %s\t%s" % (revno, rev.committer,
 
338
        date_str = format_date(rev.timestamp, rev.timezone or 0,
 
339
                            self.show_timezone)
 
340
        print >>to_file, "%5d %s\t%s" % (revno, self.short_committer(rev),
339
341
                format_date(rev.timestamp, rev.timezone or 0,
340
 
                            self.show_timezone))
 
342
                            self.show_timezone, date_fmt="%Y-%m-%d",
 
343
                           show_offset=False))
341
344
        if self.show_ids:
342
345
            print >>to_file,  '      revision-id:', rev.revision_id
343
346
        if not rev.message:
344
347
            print >>to_file,  '      (no message)'
345
348
        else:
346
 
            for l in rev.message.split('\n'):
 
349
            message = rev.message.rstrip('\r\n')
 
350
            for l in message.split('\n'):
347
351
                print >>to_file,  '      ' + l
348
352
 
349
353
        # TODO: Why not show the modified files in a shorter form as
350
354
        # well? rewrap them single lines of appropriate length
351
355
        if delta != None:
352
356
            delta.show(to_file, self.show_ids)
353
 
        print
354
 
 
355
 
 
356
 
 
357
 
FORMATTERS = {'long': LongLogFormatter,
 
357
        print >>to_file, ''
 
358
 
 
359
 
 
360
class LineLogFormatter(LogFormatter):
 
361
    def truncate(self, str, max_len):
 
362
        if len(str) <= max_len:
 
363
            return str
 
364
        return str[:max_len-3]+'...'
 
365
 
 
366
    def date_string(self, rev):
 
367
        from bzrlib.osutils import format_date
 
368
        return format_date(rev.timestamp, rev.timezone or 0, 
 
369
                           self.show_timezone, date_fmt="%Y-%m-%d",
 
370
                           show_offset=False)
 
371
 
 
372
    def message(self, rev):
 
373
        if not rev.message:
 
374
            return '(no message)'
 
375
        else:
 
376
            return rev.message
 
377
 
 
378
    def show(self, revno, rev, delta):
 
379
        from bzrlib.osutils import terminal_width
 
380
        print >> self.to_file, self.log_string(revno, rev, terminal_width()-1)
 
381
 
 
382
    def log_string(self, revno, rev, max_chars):
 
383
        """Format log info into one string. Truncate tail of string
 
384
        :param  revno:      revision number (int) or None.
 
385
                            Revision numbers counts from 1.
 
386
        :param  rev:        revision info object
 
387
        :param  max_chars:  maximum length of resulting string
 
388
        :return:            formatted truncated string
 
389
        """
 
390
        out = []
 
391
        if revno:
 
392
            # show revno only when is not None
 
393
            out.append("%d:" % revno)
 
394
        out.append(self.truncate(self.short_committer(rev), 20))
 
395
        out.append(self.date_string(rev))
 
396
        out.append(rev.get_summary())
 
397
        return self.truncate(" ".join(out).rstrip('\n'), max_chars)
 
398
 
 
399
 
 
400
def line_log(rev, max_chars):
 
401
    lf = LineLogFormatter(None)
 
402
    return lf.log_string(None, rev, max_chars)
 
403
 
 
404
FORMATTERS = {
 
405
              'long': LongLogFormatter,
358
406
              'short': ShortLogFormatter,
 
407
              'line': LineLogFormatter,
359
408
              }
360
409
 
 
410
def register_formatter(name, formatter):
 
411
    FORMATTERS[name] = formatter
361
412
 
362
413
def log_formatter(name, *args, **kwargs):
 
414
    """Construct a formatter from arguments.
 
415
 
 
416
    name -- Name of the formatter to construct; currently 'long', 'short' and
 
417
        'line' are supported.
 
418
    """
363
419
    from bzrlib.errors import BzrCommandError
364
 
    
365
420
    try:
366
421
        return FORMATTERS[name](*args, **kwargs)
367
 
    except IndexError:
 
422
    except KeyError:
368
423
        raise BzrCommandError("unknown log formatter: %r" % name)
369
424
 
370
425
def show_one_log(revno, rev, delta, verbose, to_file, show_timezone):
371
 
    # deprecated; for compatability
 
426
    # deprecated; for compatibility
372
427
    lf = LongLogFormatter(to_file=to_file, show_timezone=show_timezone)
373
428
    lf.show(revno, rev, delta)
 
429
 
 
430
def show_changed_revisions(branch, old_rh, new_rh, to_file=None, log_format='long'):
 
431
    """Show the change in revision history comparing the old revision history to the new one.
 
432
 
 
433
    :param branch: The branch where the revisions exist
 
434
    :param old_rh: The old revision history
 
435
    :param new_rh: The new revision history
 
436
    :param to_file: A file to write the results to. If None, stdout will be used
 
437
    """
 
438
    if to_file is None:
 
439
        import sys
 
440
        import codecs
 
441
        import bzrlib
 
442
        to_file = codecs.getwriter(bzrlib.user_encoding)(sys.stdout, errors='replace')
 
443
    lf = log_formatter(log_format,
 
444
                       show_ids=False,
 
445
                       to_file=to_file,
 
446
                       show_timezone='original')
 
447
 
 
448
    # This is the first index which is different between
 
449
    # old and new
 
450
    base_idx = None
 
451
    for i in xrange(max(len(new_rh),
 
452
                        len(old_rh))):
 
453
        if (len(new_rh) <= i
 
454
            or len(old_rh) <= i
 
455
            or new_rh[i] != old_rh[i]):
 
456
            base_idx = i
 
457
            break
 
458
 
 
459
    if base_idx is None:
 
460
        to_file.write('Nothing seems to have changed\n')
 
461
        return
 
462
    ## TODO: It might be nice to do something like show_log
 
463
    ##       and show the merged entries. But since this is the
 
464
    ##       removed revisions, it shouldn't be as important
 
465
    if base_idx < len(old_rh):
 
466
        to_file.write('*'*60)
 
467
        to_file.write('\nRemoved Revisions:\n')
 
468
        for i in range(base_idx, len(old_rh)):
 
469
            rev = branch.repository.get_revision(old_rh[i])
 
470
            lf.show(i+1, rev, None)
 
471
        to_file.write('*'*60)
 
472
        to_file.write('\n\n')
 
473
    if base_idx < len(new_rh):
 
474
        to_file.write('Added Revisions:\n')
 
475
        show_log(branch,
 
476
                 lf,
 
477
                 None,
 
478
                 verbose=True,
 
479
                 direction='forward',
 
480
                 start_revision=base_idx+1,
 
481
                 end_revision=len(new_rh),
 
482
                 search=None)
 
483