~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/revisiontree.py

  • Committer: Patch Queue Manager
  • Date: 2011-09-22 14:12:18 UTC
  • mfrom: (6155.3.1 jam)
  • Revision ID: pqm@pqm.ubuntu.com-20110922141218-86s4uu6nqvourw4f
(jameinel) Cleanup comments bzrlib/smart/__init__.py (John A Meinel)

Show diffs side-by-side

added added

removed removed

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