/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: Aaron Bentley
  • Date: 2006-06-26 18:01:07 UTC
  • mto: This revision was merged to the branch mainline in revision 1823.
  • Revision ID: abentley@panoramicfeedback.com-20060626180107-ec9e2e851569e2d8
Clean up bundle revision specification

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
54
 
from bzrlib.delta import compare_trees
 
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
55
58
from bzrlib.trace import mutter
56
 
from bzrlib.errors import InvalidRevisionNumber
 
59
from bzrlib.tsort import merge_sort
57
60
 
58
61
 
59
62
def find_touching_revisions(branch, file_id):
71
74
    last_path = None
72
75
    revno = 1
73
76
    for revision_id in branch.revision_history():
74
 
        this_inv = branch.get_revision_inventory(revision_id)
 
77
        this_inv = branch.repository.get_revision_inventory(revision_id)
75
78
        if file_id in this_inv:
76
79
            this_ie = this_inv[file_id]
77
80
            this_path = this_inv.id2path(file_id)
140
143
    end_revision
141
144
        If not None, only show revisions <= end_revision
142
145
    """
 
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."""
143
162
    from bzrlib.osutils import format_date
144
163
    from bzrlib.errors import BzrCheckError
145
164
    from bzrlib.textui import show_status
150
169
        warn("not a LogFormatter instance: %r" % lf)
151
170
 
152
171
    if specific_fileid:
153
 
        mutter('get log for file_id %r' % specific_fileid)
 
172
        mutter('get log for file_id %r', specific_fileid)
154
173
 
155
174
    if search is not None:
156
175
        import re
162
181
    
163
182
    if start_revision is None:
164
183
        start_revision = 1
165
 
    elif start_revision < 1 or start_revision >= len(which_revs):
166
 
        raise InvalidRevisionNumber(start_revision)
 
184
    else:
 
185
        branch.check_real_revno(start_revision)
167
186
    
168
187
    if end_revision is None:
169
188
        end_revision = len(which_revs)
170
 
    elif end_revision < 1 or end_revision >= len(which_revs):
171
 
        raise InvalidRevisionNumber(end_revision)
 
189
    else:
 
190
        branch.check_real_revno(end_revision)
172
191
 
173
192
    # list indexes are 0-based; revisions are 1-based
174
193
    cut_revs = which_revs[(start_revision-1):(end_revision)]
175
 
 
176
 
    if direction == 'reverse':
177
 
        cut_revs.reverse()
178
 
    elif direction == 'forward':
179
 
        pass
180
 
    else:
181
 
        raise ValueError('invalid direction %r' % direction)
182
 
 
183
 
    for revno, rev_id in cut_revs:
184
 
        if verbose or specific_fileid:
185
 
            delta = branch.get_revision_delta(revno)
 
194
    if not cut_revs:
 
195
        return
 
196
 
 
197
    # convert the revision history to a dictionary:
 
198
    rev_nos = dict((k, v) for v, k in cut_revs)
 
199
 
 
200
    # override the mainline to look like the revision history.
 
201
    mainline_revs = [revision_id for index, revision_id in cut_revs]
 
202
    if cut_revs[0][0] == 1:
 
203
        mainline_revs.insert(0, None)
 
204
    else:
 
205
        mainline_revs.insert(0, which_revs[start_revision-2][1])
 
206
    if getattr(lf, 'show_merge', None) is not None:
 
207
        include_merges = True 
 
208
    else:
 
209
        include_merges = False 
 
210
    view_revisions = list(get_view_revisions(mainline_revs, rev_nos, branch,
 
211
                          direction, include_merges=include_merges))
 
212
 
 
213
    def iter_revisions():
 
214
        # r = revision, n = revno, d = merge depth
 
215
        revision_ids = [r for r, n, d in view_revisions]
 
216
        zeros = set(r for r, n, d in view_revisions if d == 0)
 
217
        num = 9
 
218
        repository = branch.repository
 
219
        while revision_ids:
 
220
            cur_deltas = {}
 
221
            revisions = repository.get_revisions(revision_ids[:num])
 
222
            if verbose or specific_fileid:
 
223
                delta_revisions = [r for r in revisions if
 
224
                                   r.revision_id in zeros]
 
225
                deltas = repository.get_deltas_for_revisions(delta_revisions)
 
226
                cur_deltas = dict(izip((r.revision_id for r in 
 
227
                                        delta_revisions), deltas))
 
228
            for revision in revisions:
 
229
                # The delta value will be None unless
 
230
                # 1. verbose or specific_fileid is specified, and
 
231
                # 2. the revision is a mainline revision
 
232
                yield revision, cur_deltas.get(revision.revision_id)
 
233
            revision_ids  = revision_ids[num:]
 
234
            num = int(num * 1.5)
186
235
            
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)
 
236
    # now we just print all the revisions
 
237
    for ((rev_id, revno, merge_depth), (rev, delta)) in \
 
238
         izip(view_revisions, iter_revisions()):
196
239
 
197
240
        if searchRE:
198
241
            if not searchRE.search(rev.message):
199
242
                continue
200
243
 
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
 
    """
 
244
        if merge_depth == 0:
 
245
            # a mainline revision.
 
246
                
 
247
            if specific_fileid:
 
248
                if not delta.touches_file_id(specific_fileid):
 
249
                    continue
210
250
    
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
 
251
            if not verbose:
 
252
                # although we calculated it, throw it away without display
 
253
                delta = None
 
254
 
 
255
            lf.show(revno, rev, delta)
 
256
        else:
 
257
            lf.show_merge(rev, merge_depth)
 
258
 
 
259
 
 
260
def get_view_revisions(mainline_revs, rev_nos, branch, direction,
 
261
                       include_merges=True):
 
262
    """Produce an iterator of revisions to show
 
263
    :return: an iterator of (revision_id, revno, merge_depth)
 
264
    (if there is no revno for a revision, None is supplied)
 
265
    """
 
266
    if include_merges is False:
 
267
        revision_ids = mainline_revs[1:]
 
268
        if direction == 'reverse':
 
269
            revision_ids.reverse()
 
270
        for revision_id in revision_ids:
 
271
            yield revision_id, rev_nos[revision_id], 0
 
272
        return
 
273
    merge_sorted_revisions = merge_sort(
 
274
        branch.repository.get_revision_graph(mainline_revs[-1]),
 
275
        mainline_revs[-1],
 
276
        mainline_revs)
 
277
 
 
278
    if direction == 'forward':
 
279
        # forward means oldest first.
 
280
        merge_sorted_revisions = reverse_by_depth(merge_sorted_revisions)
 
281
    elif direction != 'reverse':
 
282
        raise ValueError('invalid direction %r' % direction)
 
283
 
 
284
    revision_history = branch.revision_history()
 
285
 
 
286
    for sequence, rev_id, merge_depth, end_of_merge in merge_sorted_revisions:
 
287
        yield rev_id, rev_nos.get(rev_id), merge_depth
 
288
 
 
289
 
 
290
def reverse_by_depth(merge_sorted_revisions, _depth=0):
 
291
    """Reverse revisions by depth.
 
292
 
 
293
    Revisions with a different depth are sorted as a group with the previous
 
294
    revision of that depth.  There may be no topological justification for this,
 
295
    but it looks much nicer.
 
296
    """
 
297
    zd_revisions = []
 
298
    for val in merge_sorted_revisions:
 
299
        if val[2] == _depth:
 
300
            zd_revisions.append([val])
 
301
        else:
 
302
            assert val[2] > _depth
 
303
            zd_revisions[-1].append(val)
 
304
    for revisions in zd_revisions:
 
305
        if len(revisions) > 1:
 
306
            revisions[1:] = reverse_by_depth(revisions[1:], _depth + 1)
 
307
    zd_revisions.reverse()
 
308
    result = []
 
309
    for chunk in zd_revisions:
 
310
        result.extend(chunk)
 
311
    return result
285
312
 
286
313
 
287
314
class LogFormatter(object):
288
315
    """Abstract class to display log messages."""
 
316
 
289
317
    def __init__(self, to_file, show_ids=False, show_timezone='original'):
290
318
        self.to_file = to_file
291
319
        self.show_ids = show_ids
292
320
        self.show_timezone = show_timezone
293
321
 
294
 
 
295
322
    def show(self, revno, rev, delta):
296
323
        raise NotImplementedError('not implemented in abstract base')
297
 
        
298
 
 
299
 
 
300
 
 
301
 
 
302
 
 
 
324
 
 
325
    def short_committer(self, rev):
 
326
        return re.sub('<.*@.*>', '', rev.committer).strip(' ')
 
327
    
 
328
    
303
329
class LongLogFormatter(LogFormatter):
304
330
    def show(self, revno, rev, delta):
305
 
        from osutils import format_date
306
 
 
 
331
        return self._show_helper(revno=revno, rev=rev, delta=delta)
 
332
 
 
333
    def show_merge(self, rev, merge_depth):
 
334
        return self._show_helper(rev=rev, indent='    '*merge_depth, merged=True, delta=None)
 
335
 
 
336
    def _show_helper(self, rev=None, revno=None, indent='', merged=False, delta=None):
 
337
        """Show a revision, either merged or not."""
 
338
        from bzrlib.osutils import format_date
307
339
        to_file = self.to_file
308
 
 
309
 
        print >>to_file,  '-' * 60
310
 
        print >>to_file,  'revno:', revno
 
340
        print >>to_file,  indent+'-' * 60
 
341
        if revno is not None:
 
342
            print >>to_file,  'revno:', revno
 
343
        if merged:
 
344
            print >>to_file,  indent+'merged:', rev.revision_id
 
345
        elif self.show_ids:
 
346
            print >>to_file,  indent+'revision-id:', rev.revision_id
311
347
        if self.show_ids:
312
 
            print >>to_file,  'revision-id:', rev.revision_id
313
 
        print >>to_file,  'committer:', rev.committer
314
 
 
 
348
            for parent_id in rev.parent_ids:
 
349
                print >>to_file, indent+'parent:', parent_id
 
350
        print >>to_file,  indent+'committer:', rev.committer
 
351
        try:
 
352
            print >>to_file, indent+'branch nick: %s' % \
 
353
                rev.properties['branch-nick']
 
354
        except KeyError:
 
355
            pass
315
356
        date_str = format_date(rev.timestamp,
316
357
                               rev.timezone or 0,
317
358
                               self.show_timezone)
318
 
        print >>to_file,  'timestamp: %s' % date_str
 
359
        print >>to_file,  indent+'timestamp: %s' % date_str
319
360
 
320
 
        print >>to_file,  'message:'
 
361
        print >>to_file,  indent+'message:'
321
362
        if not rev.message:
322
 
            print >>to_file,  '  (no message)'
 
363
            print >>to_file,  indent+'  (no message)'
323
364
        else:
324
 
            for l in rev.message.split('\n'):
325
 
                print >>to_file,  '  ' + l
326
 
 
 
365
            message = rev.message.rstrip('\r\n')
 
366
            for l in message.split('\n'):
 
367
                print >>to_file,  indent+'  ' + l
327
368
        if delta != None:
328
369
            delta.show(to_file, self.show_ids)
329
370
 
330
371
 
331
 
 
332
372
class ShortLogFormatter(LogFormatter):
333
373
    def show(self, revno, rev, delta):
334
374
        from bzrlib.osutils import format_date
335
375
 
336
376
        to_file = self.to_file
337
 
 
338
 
        print >>to_file, "%5d %s\t%s" % (revno, rev.committer,
 
377
        date_str = format_date(rev.timestamp, rev.timezone or 0,
 
378
                            self.show_timezone)
 
379
        print >>to_file, "%5d %s\t%s" % (revno, self.short_committer(rev),
339
380
                format_date(rev.timestamp, rev.timezone or 0,
340
 
                            self.show_timezone))
 
381
                            self.show_timezone, date_fmt="%Y-%m-%d",
 
382
                           show_offset=False))
341
383
        if self.show_ids:
342
384
            print >>to_file,  '      revision-id:', rev.revision_id
343
385
        if not rev.message:
344
386
            print >>to_file,  '      (no message)'
345
387
        else:
346
 
            for l in rev.message.split('\n'):
 
388
            message = rev.message.rstrip('\r\n')
 
389
            for l in message.split('\n'):
347
390
                print >>to_file,  '      ' + l
348
391
 
349
392
        # TODO: Why not show the modified files in a shorter form as
350
393
        # well? rewrap them single lines of appropriate length
351
394
        if delta != None:
352
395
            delta.show(to_file, self.show_ids)
353
 
        print
354
 
 
355
 
 
356
 
 
357
 
FORMATTERS = {'long': LongLogFormatter,
 
396
        print >>to_file, ''
 
397
 
 
398
 
 
399
class LineLogFormatter(LogFormatter):
 
400
    def truncate(self, str, max_len):
 
401
        if len(str) <= max_len:
 
402
            return str
 
403
        return str[:max_len-3]+'...'
 
404
 
 
405
    def date_string(self, rev):
 
406
        from bzrlib.osutils import format_date
 
407
        return format_date(rev.timestamp, rev.timezone or 0, 
 
408
                           self.show_timezone, date_fmt="%Y-%m-%d",
 
409
                           show_offset=False)
 
410
 
 
411
    def message(self, rev):
 
412
        if not rev.message:
 
413
            return '(no message)'
 
414
        else:
 
415
            return rev.message
 
416
 
 
417
    def show(self, revno, rev, delta):
 
418
        from bzrlib.osutils import terminal_width
 
419
        print >> self.to_file, self.log_string(revno, rev, terminal_width()-1)
 
420
 
 
421
    def log_string(self, revno, rev, max_chars):
 
422
        """Format log info into one string. Truncate tail of string
 
423
        :param  revno:      revision number (int) or None.
 
424
                            Revision numbers counts from 1.
 
425
        :param  rev:        revision info object
 
426
        :param  max_chars:  maximum length of resulting string
 
427
        :return:            formatted truncated string
 
428
        """
 
429
        out = []
 
430
        if revno:
 
431
            # show revno only when is not None
 
432
            out.append("%d:" % revno)
 
433
        out.append(self.truncate(self.short_committer(rev), 20))
 
434
        out.append(self.date_string(rev))
 
435
        out.append(rev.get_summary())
 
436
        return self.truncate(" ".join(out).rstrip('\n'), max_chars)
 
437
 
 
438
 
 
439
def line_log(rev, max_chars):
 
440
    lf = LineLogFormatter(None)
 
441
    return lf.log_string(None, rev, max_chars)
 
442
 
 
443
FORMATTERS = {
 
444
              'long': LongLogFormatter,
358
445
              'short': ShortLogFormatter,
 
446
              'line': LineLogFormatter,
359
447
              }
360
448
 
 
449
def register_formatter(name, formatter):
 
450
    FORMATTERS[name] = formatter
361
451
 
362
452
def log_formatter(name, *args, **kwargs):
 
453
    """Construct a formatter from arguments.
 
454
 
 
455
    name -- Name of the formatter to construct; currently 'long', 'short' and
 
456
        'line' are supported.
 
457
    """
363
458
    from bzrlib.errors import BzrCommandError
364
 
    
365
459
    try:
366
460
        return FORMATTERS[name](*args, **kwargs)
367
 
    except IndexError:
 
461
    except KeyError:
368
462
        raise BzrCommandError("unknown log formatter: %r" % name)
369
463
 
370
464
def show_one_log(revno, rev, delta, verbose, to_file, show_timezone):
371
 
    # deprecated; for compatability
 
465
    # deprecated; for compatibility
372
466
    lf = LongLogFormatter(to_file=to_file, show_timezone=show_timezone)
373
467
    lf.show(revno, rev, delta)
 
468
 
 
469
def show_changed_revisions(branch, old_rh, new_rh, to_file=None, log_format='long'):
 
470
    """Show the change in revision history comparing the old revision history to the new one.
 
471
 
 
472
    :param branch: The branch where the revisions exist
 
473
    :param old_rh: The old revision history
 
474
    :param new_rh: The new revision history
 
475
    :param to_file: A file to write the results to. If None, stdout will be used
 
476
    """
 
477
    if to_file is None:
 
478
        import sys
 
479
        import codecs
 
480
        import bzrlib
 
481
        to_file = codecs.getwriter(bzrlib.user_encoding)(sys.stdout, errors='replace')
 
482
    lf = log_formatter(log_format,
 
483
                       show_ids=False,
 
484
                       to_file=to_file,
 
485
                       show_timezone='original')
 
486
 
 
487
    # This is the first index which is different between
 
488
    # old and new
 
489
    base_idx = None
 
490
    for i in xrange(max(len(new_rh),
 
491
                        len(old_rh))):
 
492
        if (len(new_rh) <= i
 
493
            or len(old_rh) <= i
 
494
            or new_rh[i] != old_rh[i]):
 
495
            base_idx = i
 
496
            break
 
497
 
 
498
    if base_idx is None:
 
499
        to_file.write('Nothing seems to have changed\n')
 
500
        return
 
501
    ## TODO: It might be nice to do something like show_log
 
502
    ##       and show the merged entries. But since this is the
 
503
    ##       removed revisions, it shouldn't be as important
 
504
    if base_idx < len(old_rh):
 
505
        to_file.write('*'*60)
 
506
        to_file.write('\nRemoved Revisions:\n')
 
507
        for i in range(base_idx, len(old_rh)):
 
508
            rev = branch.repository.get_revision(old_rh[i])
 
509
            lf.show(i+1, rev, None)
 
510
        to_file.write('*'*60)
 
511
        to_file.write('\n\n')
 
512
    if base_idx < len(new_rh):
 
513
        to_file.write('Added Revisions:\n')
 
514
        show_log(branch,
 
515
                 lf,
 
516
                 None,
 
517
                 verbose=True,
 
518
                 direction='forward',
 
519
                 start_revision=base_idx+1,
 
520
                 end_revision=len(new_rh),
 
521
                 search=None)
 
522