~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/log.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2006-04-12 03:21:39 UTC
  • mfrom: (1558.12.7 revert-missing)
  • Revision ID: pqm@pqm.ubuntu.com-20060412032139-5508773d6a1cd4ae
Remove debug path printing

Show diffs side-by-side

added added

removed removed

Lines of Context:
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
56
 
from bzrlib.errors import InvalidRevisionNumber
 
59
from bzrlib.tree import EmptyTree
 
60
from bzrlib.tsort import merge_sort
57
61
 
58
62
 
59
63
def find_touching_revisions(branch, file_id):
71
75
    last_path = None
72
76
    revno = 1
73
77
    for revision_id in branch.revision_history():
74
 
        this_inv = branch.get_revision_inventory(revision_id)
 
78
        this_inv = branch.repository.get_revision_inventory(revision_id)
75
79
        if file_id in this_inv:
76
80
            this_ie = this_inv[file_id]
77
81
            this_path = this_inv.id2path(file_id)
110
114
    return rh
111
115
 
112
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
 
113
128
def show_log(branch,
114
129
             lf,
115
130
             specific_fileid=None,
140
155
    end_revision
141
156
        If not None, only show revisions <= end_revision
142
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."""
143
174
    from bzrlib.osutils import format_date
144
175
    from bzrlib.errors import BzrCheckError
145
176
    from bzrlib.textui import show_status
150
181
        warn("not a LogFormatter instance: %r" % lf)
151
182
 
152
183
    if specific_fileid:
153
 
        mutter('get log for file_id %r' % specific_fileid)
 
184
        mutter('get log for file_id %r', specific_fileid)
154
185
 
155
186
    if search is not None:
156
187
        import re
162
193
    
163
194
    if start_revision is None:
164
195
        start_revision = 1
165
 
    elif start_revision < 1 or start_revision >= len(which_revs):
166
 
        raise InvalidRevisionNumber(start_revision)
 
196
    else:
 
197
        branch.check_real_revno(start_revision)
167
198
    
168
199
    if end_revision is None:
169
200
        end_revision = len(which_revs)
170
 
    elif end_revision < 1 or end_revision >= len(which_revs):
171
 
        raise InvalidRevisionNumber(end_revision)
 
201
    else:
 
202
        branch.check_real_revno(end_revision)
172
203
 
173
204
    # list indexes are 0-based; revisions are 1-based
174
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)
175
219
 
176
220
    if direction == 'reverse':
177
221
        cut_revs.reverse()
178
222
    elif direction == 'forward':
179
 
        pass
 
223
        # forward means oldest first.
 
224
        merge_sorted_revisions.reverse()
180
225
    else:
181
226
        raise ValueError('invalid direction %r' % direction)
182
227
 
183
 
    for revno, rev_id in cut_revs:
184
 
        if verbose or specific_fileid:
185
 
            delta = branch.get_revision_delta(revno)
186
 
            
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)
 
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)
196
238
 
197
239
        if searchRE:
198
240
            if not searchRE.search(rev.message):
199
241
                continue
200
242
 
201
 
        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
202
255
 
 
256
            lf.show(rev_nos[rev_id], rev, delta)
 
257
        elif hasattr(lf, 'show_merge'):
 
258
            lf.show_merge(rev, merge_depth)
203
259
 
204
260
 
205
261
def deltas_for_log_dummy(branch, which_revs):
294
350
 
295
351
    def show(self, revno, rev, delta):
296
352
        raise NotImplementedError('not implemented in abstract base')
297
 
        
298
 
 
299
 
 
300
 
 
301
 
 
302
 
 
 
353
 
 
354
    def short_committer(self, rev):
 
355
        return re.sub('<.*@.*>', '', rev.committer).strip(' ')
 
356
    
 
357
    
303
358
class LongLogFormatter(LogFormatter):
304
359
    def show(self, revno, rev, delta):
305
 
        from osutils import format_date
306
 
 
 
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
307
368
        to_file = self.to_file
308
 
 
309
 
        print >>to_file,  '-' * 60
310
 
        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
311
376
        if self.show_ids:
312
 
            print >>to_file,  'revision-id:', rev.revision_id
313
 
        print >>to_file,  'committer:', rev.committer
314
 
 
 
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
315
385
        date_str = format_date(rev.timestamp,
316
386
                               rev.timezone or 0,
317
387
                               self.show_timezone)
318
 
        print >>to_file,  'timestamp: %s' % date_str
 
388
        print >>to_file,  indent+'timestamp: %s' % date_str
319
389
 
320
 
        print >>to_file,  'message:'
 
390
        print >>to_file,  indent+'message:'
321
391
        if not rev.message:
322
 
            print >>to_file,  '  (no message)'
 
392
            print >>to_file,  indent+'  (no message)'
323
393
        else:
324
 
            for l in rev.message.split('\n'):
325
 
                print >>to_file,  '  ' + l
326
 
 
 
394
            message = rev.message.rstrip('\r\n')
 
395
            for l in message.split('\n'):
 
396
                print >>to_file,  indent+'  ' + l
327
397
        if delta != None:
328
398
            delta.show(to_file, self.show_ids)
329
399
 
330
400
 
331
 
 
332
401
class ShortLogFormatter(LogFormatter):
333
402
    def show(self, revno, rev, delta):
334
403
        from bzrlib.osutils import format_date
335
404
 
336
405
        to_file = self.to_file
337
 
 
338
 
        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),
339
409
                format_date(rev.timestamp, rev.timezone or 0,
340
 
                            self.show_timezone))
 
410
                            self.show_timezone, date_fmt="%Y-%m-%d",
 
411
                           show_offset=False))
341
412
        if self.show_ids:
342
413
            print >>to_file,  '      revision-id:', rev.revision_id
343
414
        if not rev.message:
344
415
            print >>to_file,  '      (no message)'
345
416
        else:
346
 
            for l in rev.message.split('\n'):
 
417
            message = rev.message.rstrip('\r\n')
 
418
            for l in message.split('\n'):
347
419
                print >>to_file,  '      ' + l
348
420
 
349
421
        # TODO: Why not show the modified files in a shorter form as
350
422
        # well? rewrap them single lines of appropriate length
351
423
        if delta != None:
352
424
            delta.show(to_file, self.show_ids)
353
 
        print
354
 
 
355
 
 
356
 
 
357
 
FORMATTERS = {'long': LongLogFormatter,
 
425
        print >>to_file, ''
 
426
 
 
427
class LineLogFormatter(LogFormatter):
 
428
    def truncate(self, str, max_len):
 
429
        if len(str) <= max_len:
 
430
            return str
 
431
        return str[:max_len-3]+'...'
 
432
 
 
433
    def date_string(self, rev):
 
434
        from bzrlib.osutils import format_date
 
435
        return format_date(rev.timestamp, rev.timezone or 0, 
 
436
                           self.show_timezone, date_fmt="%Y-%m-%d",
 
437
                           show_offset=False)
 
438
 
 
439
    def message(self, rev):
 
440
        if not rev.message:
 
441
            return '(no message)'
 
442
        else:
 
443
            return rev.message
 
444
 
 
445
    def show(self, revno, rev, delta):
 
446
        print >> self.to_file, self.log_string(rev, 79) 
 
447
 
 
448
    def log_string(self, rev, max_chars):
 
449
        out = [self.truncate(self.short_committer(rev), 20)]
 
450
        out.append(self.date_string(rev))
 
451
        out.append(self.message(rev).replace('\n', ' '))
 
452
        return self.truncate(" ".join(out).rstrip('\n'), max_chars)
 
453
 
 
454
def line_log(rev, max_chars):
 
455
    lf = LineLogFormatter(None)
 
456
    return lf.log_string(rev, max_chars)
 
457
 
 
458
FORMATTERS = {
 
459
              'long': LongLogFormatter,
358
460
              'short': ShortLogFormatter,
 
461
              'line': LineLogFormatter,
359
462
              }
360
463
 
 
464
def register_formatter(name, formatter):
 
465
    FORMATTERS[name] = formatter
361
466
 
362
467
def log_formatter(name, *args, **kwargs):
 
468
    """Construct a formatter from arguments.
 
469
 
 
470
    name -- Name of the formatter to construct; currently 'long', 'short' and
 
471
        'line' are supported.
 
472
    """
363
473
    from bzrlib.errors import BzrCommandError
364
 
    
365
474
    try:
366
475
        return FORMATTERS[name](*args, **kwargs)
367
 
    except IndexError:
 
476
    except KeyError:
368
477
        raise BzrCommandError("unknown log formatter: %r" % name)
369
478
 
370
479
def show_one_log(revno, rev, delta, verbose, to_file, show_timezone):
371
480
    # deprecated; for compatability
372
481
    lf = LongLogFormatter(to_file=to_file, show_timezone=show_timezone)
373
482
    lf.show(revno, rev, delta)
 
483
 
 
484
def show_changed_revisions(branch, old_rh, new_rh, to_file=None, log_format='long'):
 
485
    """Show the change in revision history comparing the old revision history to the new one.
 
486
 
 
487
    :param branch: The branch where the revisions exist
 
488
    :param old_rh: The old revision history
 
489
    :param new_rh: The new revision history
 
490
    :param to_file: A file to write the results to. If None, stdout will be used
 
491
    """
 
492
    if to_file is None:
 
493
        import sys
 
494
        import codecs
 
495
        import bzrlib
 
496
        to_file = codecs.getwriter(bzrlib.user_encoding)(sys.stdout, errors='replace')
 
497
    lf = log_formatter(log_format,
 
498
                       show_ids=False,
 
499
                       to_file=to_file,
 
500
                       show_timezone='original')
 
501
 
 
502
    # This is the first index which is different between
 
503
    # old and new
 
504
    base_idx = None
 
505
    for i in xrange(max(len(new_rh),
 
506
                        len(old_rh))):
 
507
        if (len(new_rh) <= i
 
508
            or len(old_rh) <= i
 
509
            or new_rh[i] != old_rh[i]):
 
510
            base_idx = i
 
511
            break
 
512
 
 
513
    if base_idx is None:
 
514
        to_file.write('Nothing seems to have changed\n')
 
515
        return
 
516
    ## TODO: It might be nice to do something like show_log
 
517
    ##       and show the merged entries. But since this is the
 
518
    ##       removed revisions, it shouldn't be as important
 
519
    if base_idx < len(old_rh):
 
520
        to_file.write('*'*60)
 
521
        to_file.write('\nRemoved Revisions:\n')
 
522
        for i in range(base_idx, len(old_rh)):
 
523
            rev = branch.repository.get_revision(old_rh[i])
 
524
            lf.show(i+1, rev, None)
 
525
        to_file.write('*'*60)
 
526
        to_file.write('\n\n')
 
527
    if base_idx < len(new_rh):
 
528
        to_file.write('Added Revisions:\n')
 
529
        show_log(branch,
 
530
                 lf,
 
531
                 None,
 
532
                 verbose=True,
 
533
                 direction='forward',
 
534
                 start_revision=base_idx+1,
 
535
                 end_revision=len(new_rh),
 
536
                 search=None)
 
537