/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: Canonical.com Patch Queue Manager
  • Date: 2006-06-23 18:09:10 UTC
  • mfrom: (1793.2.10 bundles)
  • Revision ID: pqm@pqm.ubuntu.com-20060623180910-c45d7b3db60625f7
Ensure that crlf bundles don't cause path to be treated as branch

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