/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: Martin Pool
  • Date: 2005-05-17 08:20:31 UTC
  • Revision ID: mbp@sourcefrog.net-20050517082031-802a4d121b6c87f0
- new utility TreeDelta.touches_file_id

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/log.py
 
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
 
 
40
def find_touching_revisions(branch, file_id):
 
41
    """Yield a description of revisions which affect the file_id.
 
42
 
 
43
    Each returned element is (revno, revision_id, description)
 
44
 
 
45
    This is the list of revisions where the file is either added,
 
46
    modified, renamed or deleted.
 
47
 
 
48
    TODO: Perhaps some way to limit this to only particular revisions,
 
49
    or to traverse a non-mainline set of revisions?
 
50
    """
 
51
    last_ie = None
 
52
    last_path = None
 
53
    revno = 1
 
54
    for revision_id in branch.revision_history():
 
55
        this_inv = branch.get_revision_inventory(revision_id)
 
56
        if file_id in this_inv:
 
57
            this_ie = this_inv[file_id]
 
58
            this_path = this_inv.id2path(file_id)
 
59
        else:
 
60
            this_ie = this_path = None
 
61
 
 
62
        # now we know how it was last time, and how it is in this revision.
 
63
        # are those two states effectively the same or not?
 
64
 
 
65
        if not this_ie and not last_ie:
 
66
            # not present in either
 
67
            pass
 
68
        elif this_ie and not last_ie:
 
69
            yield revno, revision_id, "added " + this_path
 
70
        elif not this_ie and last_ie:
 
71
            # deleted here
 
72
            yield revno, revision_id, "deleted " + last_path
 
73
        elif this_path != last_path:
 
74
            yield revno, revision_id, ("renamed %s => %s" % (last_path, this_path))
 
75
        elif (this_ie.text_size != last_ie.text_size
 
76
              or this_ie.text_sha1 != last_ie.text_sha1):
 
77
            yield revno, revision_id, "modified " + this_path
 
78
 
 
79
        last_ie = this_ie
 
80
        last_path = this_path
 
81
        revno += 1
 
82
 
 
83
 
 
84
 
 
85
def show_log(branch,
 
86
             specific_fileid=None,
 
87
             show_timezone='original',
 
88
             verbose=False,
 
89
             show_ids=False,
 
90
             to_file=None,
 
91
             direction='reverse'):
 
92
    """Write out human-readable log of commits to this branch.
 
93
 
 
94
    specific_fileid
 
95
        If true, list only the commits affecting the specified
 
96
        file, rather than all commits.
 
97
 
 
98
    show_timezone
 
99
        'original' (committer's timezone),
 
100
        'utc' (universal time), or
 
101
        'local' (local user's timezone)
 
102
 
 
103
    verbose
 
104
        If true show added/changed/deleted/renamed files.
 
105
 
 
106
    show_ids
 
107
        If true, show revision and file ids.
 
108
 
 
109
    to_file
 
110
        File to send log to; by default stdout.
 
111
 
 
112
    direction
 
113
        'reverse' (default) is latest to earliest;
 
114
        'forward' is earliest to latest.
 
115
    """
 
116
    from osutils import format_date
 
117
    from errors import BzrCheckError
 
118
    from textui import show_status
 
119
 
 
120
    if to_file == None:
 
121
        import sys
 
122
        to_file = sys.stdout
 
123
 
 
124
    if specific_fileid:
 
125
        raise NotImplementedError('sorry, option not implemented at the moment')
 
126
    
 
127
    which_revs = branch.enum_history(direction)
 
128
 
 
129
    if not verbose:
 
130
        # no actual deltas generated
 
131
        with_deltas = deltas_for_log_dummy(branch, which_revs)
 
132
    elif direction == 'reverse':
 
133
        with_deltas = deltas_for_log_reverse(branch, which_revs)
 
134
    else:        
 
135
        raise NotImplementedError("sorry, verbose forward logs not done yet")
 
136
 
 
137
    for revno, rev, delta in with_deltas:
 
138
        # TODO: if filename given, check if it's changed; if not
 
139
        # changed, skip this one
 
140
        show_one_log(revno, rev, delta, show_ids, to_file, show_timezone)
 
141
 
 
142
 
 
143
 
 
144
def deltas_for_log_dummy(branch, which_revs):
 
145
    for revno, revision_id in which_revs:
 
146
        yield revno, branch.get_revision(revision_id), None
 
147
 
 
148
 
 
149
def deltas_for_log_reverse(branch, which_revs):
 
150
    """Compute deltas for display in reverse log.
 
151
 
 
152
    Given a sequence of (revno, revision_id) pairs, return
 
153
    (revno, rev, delta).
 
154
 
 
155
    The delta is from the given revision to the next one in the
 
156
    sequence, which makes sense if the log is being displayed from
 
157
    newest to oldest.
 
158
    """
 
159
    from tree import EmptyTree
 
160
    from diff import compare_trees
 
161
    
 
162
    last_revno = last_revision_id = last_tree = None
 
163
    for revno, revision_id in which_revs:
 
164
        this_tree = branch.revision_tree(revision_id)
 
165
        this_revision = branch.get_revision(revision_id)
 
166
        
 
167
        if last_revno:
 
168
            yield last_revno, last_revision, compare_trees(this_tree, last_tree, False)
 
169
 
 
170
        last_revno = revno
 
171
        last_revision = this_revision
 
172
        last_tree = this_tree
 
173
 
 
174
    if last_revno:
 
175
        this_tree = EmptyTree()
 
176
        yield last_revno, last_revision, compare_trees(this_tree, last_tree, False)
 
177
 
 
178
 
 
179
 
 
180
def junk():
 
181
    precursor = None
 
182
    if verbose:
 
183
        from tree import EmptyTree
 
184
        prev_tree = EmptyTree()
 
185
    for revno, revision_id in which_revs:
 
186
        precursor = revision_id
 
187
 
 
188
    if revision_id != rev.revision_id:
 
189
        raise BzrCheckError("retrieved wrong revision: %r"
 
190
                            % (revision_id, rev.revision_id))
 
191
 
 
192
    if verbose:
 
193
        this_tree = branch.revision_tree(revision_id)
 
194
        delta = compare_trees(prev_tree, this_tree, want_unchanged=False)
 
195
        prev_tree = this_tree
 
196
    else:
 
197
        delta = None    
 
198
 
 
199
 
 
200
 
 
201
def show_one_log(revno, rev, delta, show_ids, to_file, show_timezone):
 
202
    from osutils import format_date
 
203
    
 
204
    print >>to_file,  '-' * 60
 
205
    print >>to_file,  'revno:', revno
 
206
    if show_ids:
 
207
        print >>to_file,  'revision-id:', rev.revision_id
 
208
    print >>to_file,  'committer:', rev.committer
 
209
    print >>to_file,  'timestamp: %s' % (format_date(rev.timestamp, rev.timezone or 0,
 
210
                                         show_timezone))
 
211
 
 
212
    print >>to_file,  'message:'
 
213
    if not rev.message:
 
214
        print >>to_file,  '  (no message)'
 
215
    else:
 
216
        for l in rev.message.split('\n'):
 
217
            print >>to_file,  '  ' + l
 
218
 
 
219
    if delta != None:
 
220
        delta.show(to_file, show_ids)