~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/revisiontree.py

  • Committer: Ian Clatworthy
  • Date: 2009-12-03 23:21:16 UTC
  • mfrom: (4852.4.1 RCStoVCS)
  • mto: This revision was merged to the branch mainline in revision 4860.
  • Revision ID: ian.clatworthy@canonical.com-20091203232116-f8igfvc6muqrn4yx
Revision Control -> Version Control in docs

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
        revision = self._repository.get_revision(ie.revision)
 
107
        return revision.timestamp
 
108
 
 
109
    def is_executable(self, file_id, path=None):
 
110
        ie = self._inventory[file_id]
 
111
        if ie.kind != "file":
 
112
            return None
 
113
        return ie.executable
 
114
 
 
115
    def has_filename(self, filename):
 
116
        return bool(self.inventory.path2id(filename))
 
117
 
 
118
    def list_files(self, include_root=False, from_dir=None, recursive=True):
 
119
        # The only files returned by this are those from the version
 
120
        inv = self.inventory
 
121
        if from_dir is None:
 
122
            from_dir_id = None
 
123
        else:
 
124
            from_dir_id = inv.path2id(from_dir)
 
125
            if from_dir_id is None:
 
126
                # Directory not versioned
 
127
                return
 
128
        entries = inv.iter_entries(from_dir=from_dir_id, recursive=recursive)
 
129
        if inv.root is not None and not include_root and from_dir is None:
 
130
            # skip the root for compatability with the current apis.
 
131
            entries.next()
 
132
        for path, entry in entries:
 
133
            yield path, 'V', entry.kind, entry.file_id, entry
 
134
 
 
135
    def get_symlink_target(self, file_id):
 
136
        ie = self._inventory[file_id]
 
137
        # Inventories store symlink targets in unicode
 
138
        return ie.symlink_target
 
139
 
 
140
    def get_reference_revision(self, file_id, path=None):
 
141
        return self.inventory[file_id].reference_revision
 
142
 
 
143
    def get_root_id(self):
 
144
        if self.inventory.root:
 
145
            return self.inventory.root.file_id
 
146
 
 
147
    def kind(self, file_id):
 
148
        return self._inventory[file_id].kind
 
149
 
 
150
    def path_content_summary(self, path):
 
151
        """See Tree.path_content_summary."""
 
152
        id = self.inventory.path2id(path)
 
153
        if id is None:
 
154
            return ('missing', None, None, None)
 
155
        entry = self._inventory[id]
 
156
        kind = entry.kind
 
157
        if kind == 'file':
 
158
            return (kind, entry.text_size, entry.executable, entry.text_sha1)
 
159
        elif kind == 'symlink':
 
160
            return (kind, None, None, entry.symlink_target)
 
161
        else:
 
162
            return (kind, None, None, None)
 
163
 
 
164
    def _comparison_data(self, entry, path):
 
165
        if entry is None:
 
166
            return None, False, None
 
167
        return entry.kind, entry.executable, None
 
168
 
 
169
    def _file_size(self, entry, stat_value):
 
170
        return entry.text_size
 
171
 
 
172
    def _get_ancestors(self, default_revision):
 
173
        return set(self._repository.get_ancestry(self._revision_id,
 
174
                                                 topo_sorted=False))
 
175
 
 
176
    def lock_read(self):
 
177
        self._repository.lock_read()
 
178
 
 
179
    def __repr__(self):
 
180
        return '<%s instance at %x, rev_id=%r>' % (
 
181
            self.__class__.__name__, id(self), self._revision_id)
 
182
 
 
183
    def unlock(self):
 
184
        self._repository.unlock()
 
185
 
 
186
    def walkdirs(self, prefix=""):
 
187
        _directory = 'directory'
 
188
        inv = self.inventory
 
189
        top_id = inv.path2id(prefix)
 
190
        if top_id is None:
 
191
            pending = []
 
192
        else:
 
193
            pending = [(prefix, '', _directory, None, top_id, None)]
 
194
        while pending:
 
195
            dirblock = []
 
196
            currentdir = pending.pop()
 
197
            # 0 - relpath, 1- basename, 2- kind, 3- stat, id, v-kind
 
198
            if currentdir[0]:
 
199
                relroot = currentdir[0] + '/'
 
200
            else:
 
201
                relroot = ""
 
202
            # FIXME: stash the node in pending
 
203
            entry = inv[currentdir[4]]
 
204
            for name, child in entry.sorted_children():
 
205
                toppath = relroot + name
 
206
                dirblock.append((toppath, name, child.kind, None,
 
207
                    child.file_id, child.kind
 
208
                    ))
 
209
            yield (currentdir[0], entry.file_id), dirblock
 
210
            # push the user specified dirs from dirblock
 
211
            for dir in reversed(dirblock):
 
212
                if dir[2] == _directory:
 
213
                    pending.append(dir)
 
214
 
 
215
    def _get_rules_searcher(self, default_searcher):
 
216
        """See Tree._get_rules_searcher."""
 
217
        if self._rules_searcher is None:
 
218
            self._rules_searcher = super(RevisionTree,
 
219
                self)._get_rules_searcher(default_searcher)
 
220
        return self._rules_searcher
 
221
 
 
222
 
 
223
class InterCHKRevisionTree(tree.InterTree):
 
224
    """Fast path optimiser for RevisionTrees with CHK inventories."""
 
225
 
 
226
    @staticmethod
 
227
    def is_compatible(source, target):
 
228
        if (isinstance(source, RevisionTree)
 
229
            and isinstance(target, RevisionTree)):
 
230
            try:
 
231
                # Only CHK inventories have id_to_entry attribute
 
232
                source.inventory.id_to_entry
 
233
                target.inventory.id_to_entry
 
234
                return True
 
235
            except AttributeError:
 
236
                pass
 
237
        return False
 
238
 
 
239
    def iter_changes(self, include_unchanged=False,
 
240
                     specific_files=None, pb=None, extra_trees=[],
 
241
                     require_versioned=True, want_unversioned=False):
 
242
        lookup_trees = [self.source]
 
243
        if extra_trees:
 
244
             lookup_trees.extend(extra_trees)
 
245
        # The ids of items we need to examine to insure delta consistency.
 
246
        precise_file_ids = set()
 
247
        discarded_changes = {}
 
248
        if specific_files == []:
 
249
            specific_file_ids = []
 
250
        else:
 
251
            specific_file_ids = self.target.paths2ids(specific_files,
 
252
                lookup_trees, require_versioned=require_versioned)
 
253
        # FIXME: It should be possible to delegate include_unchanged handling
 
254
        # to CHKInventory.iter_changes and do a better job there -- vila
 
255
        # 20090304
 
256
        changed_file_ids = set()
 
257
        for result in self.target.inventory.iter_changes(self.source.inventory):
 
258
            if specific_file_ids is not None:
 
259
                file_id = result[0]
 
260
                if file_id not in specific_file_ids:
 
261
                    # A change from the whole tree that we don't want to show yet.
 
262
                    # We may find that we need to show it for delta consistency, so
 
263
                    # stash it.
 
264
                    discarded_changes[result[0]] = result
 
265
                    continue
 
266
                new_parent_id = result[4][1]
 
267
                precise_file_ids.add(new_parent_id)
 
268
            yield result
 
269
            changed_file_ids.add(result[0])
 
270
        if specific_file_ids is not None:
 
271
            for result in self._handle_precise_ids(precise_file_ids,
 
272
                changed_file_ids, discarded_changes=discarded_changes):
 
273
                yield result
 
274
        if include_unchanged:
 
275
            # CHKMap avoid being O(tree), so we go to O(tree) only if
 
276
            # required to.
 
277
            # Now walk the whole inventory, excluding the already yielded
 
278
            # file ids
 
279
            changed_file_ids = set(changed_file_ids)
 
280
            for relpath, entry in self.target.inventory.iter_entries():
 
281
                if (specific_file_ids is not None
 
282
                    and not entry.file_id in specific_file_ids):
 
283
                    continue
 
284
                if not entry.file_id in changed_file_ids:
 
285
                    yield (entry.file_id,
 
286
                           (relpath, relpath), # Not renamed
 
287
                           False, # Not modified
 
288
                           (True, True), # Still  versioned
 
289
                           (entry.parent_id, entry.parent_id),
 
290
                           (entry.name, entry.name),
 
291
                           (entry.kind, entry.kind),
 
292
                           (entry.executable, entry.executable))
 
293
 
 
294
 
 
295
tree.InterTree.register_optimiser(InterCHKRevisionTree)