~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/revisiontree.py

  • Committer: Martin Pool
  • Date: 2005-05-11 06:20:05 UTC
  • Revision ID: mbp@sourcefrog.net-20050511062005-297af3451635dae0
- Don't lose first line of command help!

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005, 2007 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
 
 
17
 
"""RevisionTree - a Tree implementation backed by repository data for a revision."""
18
 
 
19
 
from cStringIO import StringIO
20
 
 
21
 
from bzrlib import (
22
 
    errors,
23
 
    osutils,
24
 
    revision,
25
 
    symbol_versioning,
26
 
    tree,
27
 
    )
28
 
 
29
 
 
30
 
class RevisionTree(tree.Tree):
31
 
    """Tree viewing a previous revision.
32
 
 
33
 
    File text can be retrieved from the text store.
34
 
    """
35
 
 
36
 
    def __init__(self, branch, inv, revision_id):
37
 
        # for compatability the 'branch' parameter has not been renamed to
38
 
        # repository at this point. However, we should change RevisionTree's
39
 
        # construction to always be via Repository and not via direct
40
 
        # construction - this will mean that we can change the constructor
41
 
        # with much less chance of breaking client code.
42
 
        self._repository = branch
43
 
        self._inventory = inv
44
 
        self._revision_id = revision_id
45
 
        self._rules_searcher = None
46
 
 
47
 
    def supports_tree_reference(self):
48
 
        return getattr(self._repository._format, "supports_tree_reference",
49
 
            False)
50
 
 
51
 
    def get_parent_ids(self):
52
 
        """See Tree.get_parent_ids.
53
 
 
54
 
        A RevisionTree's parents match the revision graph.
55
 
        """
56
 
        if self._revision_id in (None, revision.NULL_REVISION):
57
 
            parent_ids = []
58
 
        else:
59
 
            parent_ids = self._repository.get_revision(
60
 
                self._revision_id).parent_ids
61
 
        return parent_ids
62
 
 
63
 
    def get_revision_id(self):
64
 
        """Return the revision id associated with this tree."""
65
 
        return self._revision_id
66
 
 
67
 
    def get_file_text(self, file_id, path=None):
68
 
        _, content = list(self.iter_files_bytes([(file_id, None)]))[0]
69
 
        return ''.join(content)
70
 
 
71
 
    def get_file(self, file_id, path=None):
72
 
        return StringIO(self.get_file_text(file_id))
73
 
 
74
 
    def iter_files_bytes(self, desired_files):
75
 
        """See Tree.iter_files_bytes.
76
 
 
77
 
        This version is implemented on top of Repository.extract_files_bytes"""
78
 
        repo_desired_files = [(f, self.inventory[f].revision, i)
79
 
                              for f, i in desired_files]
80
 
        try:
81
 
            for result in self._repository.iter_files_bytes(repo_desired_files):
82
 
                yield result
83
 
        except errors.RevisionNotPresent, e:
84
 
            raise errors.NoSuchFile(e.revision_id)
85
 
 
86
 
    def annotate_iter(self, file_id,
87
 
                      default_revision=revision.CURRENT_REVISION):
88
 
        """See Tree.annotate_iter"""
89
 
        text_key = (file_id, self.inventory[file_id].revision)
90
 
        annotator = self._repository.texts.get_annotator()
91
 
        annotations = annotator.annotate_flat(text_key)
92
 
        return [(key[-1], line) for key, line in annotations]
93
 
 
94
 
    def get_file_size(self, file_id):
95
 
        """See Tree.get_file_size"""
96
 
        return self._inventory[file_id].text_size
97
 
 
98
 
    def get_file_sha1(self, file_id, path=None, stat_value=None):
99
 
        ie = self._inventory[file_id]
100
 
        if ie.kind == "file":
101
 
            return ie.text_sha1
102
 
        return None
103
 
 
104
 
    def get_file_mtime(self, file_id, path=None):
105
 
        ie = self._inventory[file_id]
106
 
        try:
107
 
            revision = self._repository.get_revision(ie.revision)
108
 
        except errors.NoSuchRevision:
109
 
            raise errors.FileTimestampUnavailable(self.id2path(file_id))
110
 
        return revision.timestamp
111
 
 
112
 
    def is_executable(self, file_id, path=None):
113
 
        ie = self._inventory[file_id]
114
 
        if ie.kind != "file":
115
 
            return None
116
 
        return ie.executable
117
 
 
118
 
    def has_filename(self, filename):
119
 
        return bool(self.inventory.path2id(filename))
120
 
 
121
 
    def list_files(self, include_root=False, from_dir=None, recursive=True):
122
 
        # The only files returned by this are those from the version
123
 
        inv = self.inventory
124
 
        if from_dir is None:
125
 
            from_dir_id = None
126
 
        else:
127
 
            from_dir_id = inv.path2id(from_dir)
128
 
            if from_dir_id is None:
129
 
                # Directory not versioned
130
 
                return
131
 
        entries = inv.iter_entries(from_dir=from_dir_id, recursive=recursive)
132
 
        if inv.root is not None and not include_root and from_dir is None:
133
 
            # skip the root for compatability with the current apis.
134
 
            entries.next()
135
 
        for path, entry in entries:
136
 
            yield path, 'V', entry.kind, entry.file_id, entry
137
 
 
138
 
    def get_symlink_target(self, file_id):
139
 
        ie = self._inventory[file_id]
140
 
        # Inventories store symlink targets in unicode
141
 
        return ie.symlink_target
142
 
 
143
 
    def get_reference_revision(self, file_id, path=None):
144
 
        return self.inventory[file_id].reference_revision
145
 
 
146
 
    def get_root_id(self):
147
 
        if self.inventory.root:
148
 
            return self.inventory.root.file_id
149
 
 
150
 
    def kind(self, file_id):
151
 
        return self._inventory[file_id].kind
152
 
 
153
 
    def path_content_summary(self, path):
154
 
        """See Tree.path_content_summary."""
155
 
        id = self.inventory.path2id(path)
156
 
        if id is None:
157
 
            return ('missing', None, None, None)
158
 
        entry = self._inventory[id]
159
 
        kind = entry.kind
160
 
        if kind == 'file':
161
 
            return (kind, entry.text_size, entry.executable, entry.text_sha1)
162
 
        elif kind == 'symlink':
163
 
            return (kind, None, None, entry.symlink_target)
164
 
        else:
165
 
            return (kind, None, None, None)
166
 
 
167
 
    def _comparison_data(self, entry, path):
168
 
        if entry is None:
169
 
            return None, False, None
170
 
        return entry.kind, entry.executable, None
171
 
 
172
 
    def _file_size(self, entry, stat_value):
173
 
        return entry.text_size
174
 
 
175
 
    def _get_ancestors(self, default_revision):
176
 
        return set(self._repository.get_ancestry(self._revision_id,
177
 
                                                 topo_sorted=False))
178
 
 
179
 
    def lock_read(self):
180
 
        self._repository.lock_read()
181
 
 
182
 
    def __repr__(self):
183
 
        return '<%s instance at %x, rev_id=%r>' % (
184
 
            self.__class__.__name__, id(self), self._revision_id)
185
 
 
186
 
    def unlock(self):
187
 
        self._repository.unlock()
188
 
 
189
 
    def walkdirs(self, prefix=""):
190
 
        _directory = 'directory'
191
 
        inv = self.inventory
192
 
        top_id = inv.path2id(prefix)
193
 
        if top_id is None:
194
 
            pending = []
195
 
        else:
196
 
            pending = [(prefix, '', _directory, None, top_id, None)]
197
 
        while pending:
198
 
            dirblock = []
199
 
            currentdir = pending.pop()
200
 
            # 0 - relpath, 1- basename, 2- kind, 3- stat, id, v-kind
201
 
            if currentdir[0]:
202
 
                relroot = currentdir[0] + '/'
203
 
            else:
204
 
                relroot = ""
205
 
            # FIXME: stash the node in pending
206
 
            entry = inv[currentdir[4]]
207
 
            for name, child in entry.sorted_children():
208
 
                toppath = relroot + name
209
 
                dirblock.append((toppath, name, child.kind, None,
210
 
                    child.file_id, child.kind
211
 
                    ))
212
 
            yield (currentdir[0], entry.file_id), dirblock
213
 
            # push the user specified dirs from dirblock
214
 
            for dir in reversed(dirblock):
215
 
                if dir[2] == _directory:
216
 
                    pending.append(dir)
217
 
 
218
 
    def _get_rules_searcher(self, default_searcher):
219
 
        """See Tree._get_rules_searcher."""
220
 
        if self._rules_searcher is None:
221
 
            self._rules_searcher = super(RevisionTree,
222
 
                self)._get_rules_searcher(default_searcher)
223
 
        return self._rules_searcher
224
 
 
225
 
 
226
 
class InterCHKRevisionTree(tree.InterTree):
227
 
    """Fast path optimiser for RevisionTrees with CHK inventories."""
228
 
 
229
 
    @staticmethod
230
 
    def is_compatible(source, target):
231
 
        if (isinstance(source, RevisionTree)
232
 
            and isinstance(target, RevisionTree)):
233
 
            try:
234
 
                # Only CHK inventories have id_to_entry attribute
235
 
                source.inventory.id_to_entry
236
 
                target.inventory.id_to_entry
237
 
                return True
238
 
            except AttributeError:
239
 
                pass
240
 
        return False
241
 
 
242
 
    def iter_changes(self, include_unchanged=False,
243
 
                     specific_files=None, pb=None, extra_trees=[],
244
 
                     require_versioned=True, want_unversioned=False):
245
 
        lookup_trees = [self.source]
246
 
        if extra_trees:
247
 
             lookup_trees.extend(extra_trees)
248
 
        # The ids of items we need to examine to insure delta consistency.
249
 
        precise_file_ids = set()
250
 
        discarded_changes = {}
251
 
        if specific_files == []:
252
 
            specific_file_ids = []
253
 
        else:
254
 
            specific_file_ids = self.target.paths2ids(specific_files,
255
 
                lookup_trees, require_versioned=require_versioned)
256
 
        # FIXME: It should be possible to delegate include_unchanged handling
257
 
        # to CHKInventory.iter_changes and do a better job there -- vila
258
 
        # 20090304
259
 
        changed_file_ids = set()
260
 
        for result in self.target.inventory.iter_changes(self.source.inventory):
261
 
            if specific_file_ids is not None:
262
 
                file_id = result[0]
263
 
                if file_id not in specific_file_ids:
264
 
                    # A change from the whole tree that we don't want to show yet.
265
 
                    # We may find that we need to show it for delta consistency, so
266
 
                    # stash it.
267
 
                    discarded_changes[result[0]] = result
268
 
                    continue
269
 
                new_parent_id = result[4][1]
270
 
                precise_file_ids.add(new_parent_id)
271
 
            yield result
272
 
            changed_file_ids.add(result[0])
273
 
        if specific_file_ids is not None:
274
 
            for result in self._handle_precise_ids(precise_file_ids,
275
 
                changed_file_ids, discarded_changes=discarded_changes):
276
 
                yield result
277
 
        if include_unchanged:
278
 
            # CHKMap avoid being O(tree), so we go to O(tree) only if
279
 
            # required to.
280
 
            # Now walk the whole inventory, excluding the already yielded
281
 
            # file ids
282
 
            changed_file_ids = set(changed_file_ids)
283
 
            for relpath, entry in self.target.inventory.iter_entries():
284
 
                if (specific_file_ids is not None
285
 
                    and not entry.file_id in specific_file_ids):
286
 
                    continue
287
 
                if not entry.file_id in changed_file_ids:
288
 
                    yield (entry.file_id,
289
 
                           (relpath, relpath), # Not renamed
290
 
                           False, # Not modified
291
 
                           (True, True), # Still  versioned
292
 
                           (entry.parent_id, entry.parent_id),
293
 
                           (entry.name, entry.name),
294
 
                           (entry.kind, entry.kind),
295
 
                           (entry.executable, entry.executable))
296
 
 
297
 
 
298
 
tree.InterTree.register_optimiser(InterCHKRevisionTree)