← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/log.py

  • Committer: Martin Pool
  • Date: 2005-09-16 08:23:10 UTC
  • Revision ID: mbp@sourcefrog.net-20050916082310-ecb5a25c40253839
- wrap wide strings when showing exceptions

Show diffs side-by-side

added added

removed removed

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