← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/log.py

  • Committer: Aaron Bentley
  • Date: 2006-06-03 16:23:09 UTC
  • mfrom: (1736 +trunk)
  • mto: This revision was merged to the branch mainline in revision 1738.
  • Revision ID: aaron.bentley@utoronto.ca-20060603162309-c975ca9ea9fea344
Merge from bzr.dev

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/log.py
50
50
"""
51
51
 
52
52
 
53
 
from bzrlib.tree import EmptyTree
 
53
# TODO: option to show delta summaries for merged-in revisions
 
54
import re
 
55
 
54
56
from bzrlib.delta import compare_trees
 
57
import bzrlib.errors as errors
55
58
from bzrlib.trace import mutter
 
59
from bzrlib.tree import EmptyTree
 
60
from bzrlib.tsort import merge_sort
56
61
 
57
62
 
58
63
def find_touching_revisions(branch, file_id):
70
75
    last_path = None
71
76
    revno = 1
72
77
    for revision_id in branch.revision_history():
73
 
        this_inv = branch.get_revision_inventory(revision_id)
 
78
        this_inv = branch.repository.get_revision_inventory(revision_id)
74
79
        if file_id in this_inv:
75
80
            this_ie = this_inv[file_id]
76
81
            this_path = this_inv.id2path(file_id)
109
114
    return rh
110
115
 
111
116
 
 
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
 
112
128
def show_log(branch,
113
129
             lf,
114
130
             specific_fileid=None,
139
155
    end_revision
140
156
        If not None, only show revisions <= end_revision
141
157
    """
 
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."""
142
174
    from bzrlib.osutils import format_date
143
175
    from bzrlib.errors import BzrCheckError
144
176
    from bzrlib.textui import show_status
149
181
        warn("not a LogFormatter instance: %r" % lf)
150
182
 
151
183
    if specific_fileid:
152
 
        mutter('get log for file_id %r' % specific_fileid)
 
184
        mutter('get log for file_id %r', specific_fileid)
153
185
 
154
186
    if search is not None:
155
187
        import re
171
203
 
172
204
    # list indexes are 0-based; revisions are 1-based
173
205
    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)
174
219
 
175
220
    if direction == 'reverse':
176
221
        cut_revs.reverse()
177
222
    elif direction == 'forward':
178
 
        pass
 
223
        # forward means oldest first.
 
224
        merge_sorted_revisions.reverse()
179
225
    else:
180
226
        raise ValueError('invalid direction %r' % direction)
181
227
 
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)
 
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)
195
238
 
196
239
        if searchRE:
197
240
            if not searchRE.search(rev.message):
198
241
                continue
199
242
 
200
 
        lf.show(revno, rev, delta)
 
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
201
255
 
 
256
            lf.show(rev_nos[rev_id], rev, delta)
 
257
        elif hasattr(lf, 'show_merge'):
 
258
            lf.show_merge(rev, merge_depth)
202
259
 
203
260
 
204
261
def deltas_for_log_dummy(branch, which_revs):
285
342
 
286
343
class LogFormatter(object):
287
344
    """Abstract class to display log messages."""
 
345
 
288
346
    def __init__(self, to_file, show_ids=False, show_timezone='original'):
289
347
        self.to_file = to_file
290
348
        self.show_ids = show_ids
291
349
        self.show_timezone = show_timezone
292
350
 
293
 
 
294
351
    def show(self, revno, rev, delta):
295
352
        raise NotImplementedError('not implemented in abstract base')
296
 
        
297
 
 
298
 
 
299
 
 
300
 
 
301
 
 
 
353
 
 
354
    def short_committer(self, rev):
 
355
        return re.sub('<.*@.*>', '', rev.committer).strip(' ')
 
356
    
 
357
    
302
358
class LongLogFormatter(LogFormatter):
303
359
    def show(self, revno, rev, delta):
304
 
        from osutils import format_date
305
 
 
 
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
306
368
        to_file = self.to_file
307
 
 
308
 
        print >>to_file,  '-' * 60
309
 
        print >>to_file,  'revno:', revno
 
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
310
376
        if self.show_ids:
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
 
 
 
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
318
385
        date_str = format_date(rev.timestamp,
319
386
                               rev.timezone or 0,
320
387
                               self.show_timezone)
321
 
        print >>to_file,  'timestamp: %s' % date_str
 
388
        print >>to_file,  indent+'timestamp: %s' % date_str
322
389
 
323
 
        print >>to_file,  'message:'
 
390
        print >>to_file,  indent+'message:'
324
391
        if not rev.message:
325
 
            print >>to_file,  '  (no message)'
 
392
            print >>to_file,  indent+'  (no message)'
326
393
        else:
327
 
            for l in rev.message.split('\n'):
328
 
                print >>to_file,  '  ' + l
329
 
 
 
394
            message = rev.message.rstrip('\r\n')
 
395
            for l in message.split('\n'):
 
396
                print >>to_file,  indent+'  ' + l
330
397
        if delta != None:
331
398
            delta.show(to_file, self.show_ids)
332
399
 
333
400
 
334
 
 
335
401
class ShortLogFormatter(LogFormatter):
336
402
    def show(self, revno, rev, delta):
337
403
        from bzrlib.osutils import format_date
338
404
 
339
405
        to_file = self.to_file
340
 
 
341
 
        print >>to_file, "%5d %s\t%s" % (revno, rev.committer,
 
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),
342
409
                format_date(rev.timestamp, rev.timezone or 0,
343
 
                            self.show_timezone))
 
410
                            self.show_timezone, date_fmt="%Y-%m-%d",
 
411
                           show_offset=False))
344
412
        if self.show_ids:
345
413
            print >>to_file,  '      revision-id:', rev.revision_id
346
414
        if not rev.message:
347
415
            print >>to_file,  '      (no message)'
348
416
        else:
349
 
            for l in rev.message.split('\n'):
 
417
            message = rev.message.rstrip('\r\n')
 
418
            for l in message.split('\n'):
350
419
                print >>to_file,  '      ' + l
351
420
 
352
421
        # TODO: Why not show the modified files in a shorter form as
353
422
        # well? rewrap them single lines of appropriate length
354
423
        if delta != None:
355
424
            delta.show(to_file, self.show_ids)
356
 
        print
357
 
 
358
 
 
359
 
 
360
 
FORMATTERS = {'long': LongLogFormatter,
 
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,
361
474
              'short': ShortLogFormatter,
 
475
              'line': LineLogFormatter,
362
476
              }
363
477
 
 
478
def register_formatter(name, formatter):
 
479
    FORMATTERS[name] = formatter
364
480
 
365
481
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
    """
366
487
    from bzrlib.errors import BzrCommandError
367
 
    
368
488
    try:
369
489
        return FORMATTERS[name](*args, **kwargs)
370
 
    except IndexError:
 
490
    except KeyError:
371
491
        raise BzrCommandError("unknown log formatter: %r" % name)
372
492
 
373
493
def show_one_log(revno, rev, delta, verbose, to_file, show_timezone):
374
494
    # deprecated; for compatability
375
495
    lf = LongLogFormatter(to_file=to_file, show_timezone=show_timezone)
376
496
    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