~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/log.py

  • Committer: Martin Pool
  • Date: 2005-06-20 03:54:23 UTC
  • Revision ID: mbp@sourcefrog.net-20050620035423-10f4bb320656b0d1
- files within stores are no longer made readonly

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
# Copyright (C) 2005 Canonical Ltd
 
2
 
 
3
# This program is free software; you can redistribute it and/or modify
 
4
# it under the terms of the GNU General Public License as published by
 
5
# the Free Software Foundation; either version 2 of the License, or
 
6
# (at your option) any later version.
 
7
 
 
8
# This program is distributed in the hope that it will be useful,
 
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
 
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
11
# GNU General Public License for more details.
 
12
 
 
13
# You should have received a copy of the GNU General Public License
 
14
# along with this program; if not, write to the Free Software
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
16
 
 
17
 
 
18
 
 
19
"""Code to show logs of changes.
 
20
 
 
21
Various flavors of log can be produced:
 
22
 
 
23
* for one file, or the whole tree, and (not done yet) for
 
24
  files in a given directory
 
25
 
 
26
* in "verbose" mode with a description of what changed from one
 
27
  version to the next
 
28
 
 
29
* with file-ids and revision-ids shown
 
30
 
 
31
* from last to first or (not anymore) from first to last;
 
32
  the default is "reversed" because it shows the likely most
 
33
  relevant and interesting information first
 
34
 
 
35
* (not yet) in XML format
 
36
"""
 
37
 
 
38
 
 
39
from trace import mutter
 
40
 
 
41
def find_touching_revisions(branch, file_id):
 
42
    """Yield a description of revisions which affect the file_id.
 
43
 
 
44
    Each returned element is (revno, revision_id, description)
 
45
 
 
46
    This is the list of revisions where the file is either added,
 
47
    modified, renamed or deleted.
 
48
 
 
49
    TODO: Perhaps some way to limit this to only particular revisions,
 
50
    or to traverse a non-mainline set of revisions?
 
51
    """
 
52
    last_ie = None
 
53
    last_path = None
 
54
    revno = 1
 
55
    for revision_id in branch.revision_history():
 
56
        this_inv = branch.get_revision_inventory(revision_id)
 
57
        if file_id in this_inv:
 
58
            this_ie = this_inv[file_id]
 
59
            this_path = this_inv.id2path(file_id)
 
60
        else:
 
61
            this_ie = this_path = None
 
62
 
 
63
        # now we know how it was last time, and how it is in this revision.
 
64
        # are those two states effectively the same or not?
 
65
 
 
66
        if not this_ie and not last_ie:
 
67
            # not present in either
 
68
            pass
 
69
        elif this_ie and not last_ie:
 
70
            yield revno, revision_id, "added " + this_path
 
71
        elif not this_ie and last_ie:
 
72
            # deleted here
 
73
            yield revno, revision_id, "deleted " + last_path
 
74
        elif this_path != last_path:
 
75
            yield revno, revision_id, ("renamed %s => %s" % (last_path, this_path))
 
76
        elif (this_ie.text_size != last_ie.text_size
 
77
              or this_ie.text_sha1 != last_ie.text_sha1):
 
78
            yield revno, revision_id, "modified " + this_path
 
79
 
 
80
        last_ie = this_ie
 
81
        last_path = this_path
 
82
        revno += 1
 
83
 
 
84
 
 
85
 
 
86
def show_log(branch,
 
87
             specific_fileid=None,
 
88
             show_timezone='original',
 
89
             verbose=False,
 
90
             show_ids=False,
 
91
             to_file=None,
 
92
             direction='reverse',
 
93
             start_revision=None,
 
94
             end_revision=None):
 
95
    """Write out human-readable log of commits to this branch.
 
96
 
 
97
    specific_fileid
 
98
        If true, list only the commits affecting the specified
 
99
        file, rather than all commits.
 
100
 
 
101
    show_timezone
 
102
        'original' (committer's timezone),
 
103
        'utc' (universal time), or
 
104
        'local' (local user's timezone)
 
105
 
 
106
    verbose
 
107
        If true show added/changed/deleted/renamed files.
 
108
 
 
109
    show_ids
 
110
        If true, show revision and file ids.
 
111
 
 
112
    to_file
 
113
        File to send log to; by default stdout.
 
114
 
 
115
    direction
 
116
        'reverse' (default) is latest to earliest;
 
117
        'forward' is earliest to latest.
 
118
 
 
119
    start_revision
 
120
        If not None, only show revisions >= start_revision
 
121
 
 
122
    end_revision
 
123
        If not None, only show revisions <= end_revision
 
124
    """
 
125
    from osutils import format_date
 
126
    from errors import BzrCheckError
 
127
    from textui import show_status
 
128
 
 
129
 
 
130
    if specific_fileid:
 
131
        mutter('get log for file_id %r' % specific_fileid)
 
132
 
 
133
    if to_file == None:
 
134
        import sys
 
135
        to_file = sys.stdout
 
136
 
 
137
    which_revs = branch.enum_history(direction)
 
138
 
 
139
    if not (verbose or specific_fileid):
 
140
        # no need to know what changed between revisions
 
141
        with_deltas = deltas_for_log_dummy(branch, which_revs)
 
142
    elif direction == 'reverse':
 
143
        with_deltas = deltas_for_log_reverse(branch, which_revs)
 
144
    else:        
 
145
        raise NotImplementedError("sorry, verbose forward logs not done yet")
 
146
 
 
147
    for revno, rev, delta in with_deltas:
 
148
        if specific_fileid:
 
149
            if not delta.touches_file_id(specific_fileid):
 
150
                continue
 
151
 
 
152
        if start_revision is not None and revno < start_revision:
 
153
            continue
 
154
 
 
155
        if end_revision is not None and revno > end_revision:
 
156
            continue
 
157
        
 
158
        if not verbose:
 
159
            # although we calculated it, throw it away without display
 
160
            delta = None
 
161
            
 
162
        show_one_log(revno, rev, delta, show_ids, to_file, show_timezone)
 
163
 
 
164
 
 
165
 
 
166
def deltas_for_log_dummy(branch, which_revs):
 
167
    for revno, revision_id in which_revs:
 
168
        yield revno, branch.get_revision(revision_id), None
 
169
 
 
170
 
 
171
def deltas_for_log_reverse(branch, which_revs):
 
172
    """Compute deltas for display in reverse log.
 
173
 
 
174
    Given a sequence of (revno, revision_id) pairs, return
 
175
    (revno, rev, delta).
 
176
 
 
177
    The delta is from the given revision to the next one in the
 
178
    sequence, which makes sense if the log is being displayed from
 
179
    newest to oldest.
 
180
    """
 
181
    from tree import EmptyTree
 
182
    from diff import compare_trees
 
183
    
 
184
    last_revno = last_revision_id = last_tree = None
 
185
    for revno, revision_id in which_revs:
 
186
        this_tree = branch.revision_tree(revision_id)
 
187
        this_revision = branch.get_revision(revision_id)
 
188
        
 
189
        if last_revno:
 
190
            yield last_revno, last_revision, compare_trees(this_tree, last_tree, False)
 
191
 
 
192
        last_revno = revno
 
193
        last_revision = this_revision
 
194
        last_tree = this_tree
 
195
 
 
196
    if last_revno:
 
197
        this_tree = EmptyTree()
 
198
        yield last_revno, last_revision, compare_trees(this_tree, last_tree, False)
 
199
 
 
200
 
 
201
 
 
202
 
 
203
def show_one_log(revno, rev, delta, show_ids, to_file, show_timezone):
 
204
    from osutils import format_date
 
205
    
 
206
    print >>to_file,  '-' * 60
 
207
    print >>to_file,  'revno:', revno
 
208
    if show_ids:
 
209
        print >>to_file,  'revision-id:', rev.revision_id
 
210
    print >>to_file,  'committer:', rev.committer
 
211
    print >>to_file,  'timestamp: %s' % (format_date(rev.timestamp, rev.timezone or 0,
 
212
                                         show_timezone))
 
213
 
 
214
    print >>to_file,  'message:'
 
215
    if not rev.message:
 
216
        print >>to_file,  '  (no message)'
 
217
    else:
 
218
        for l in rev.message.split('\n'):
 
219
            print >>to_file,  '  ' + l
 
220
 
 
221
    if delta != None:
 
222
        delta.show(to_file, show_ids)