~bzr-pqm/bzr/bzr.dev

2255.2.83 by John Arbash Meinel
[merge] bzr.dev 2294
1
# Copyright (C) 2005, 2007 Canonical Ltd
1852.7.1 by Robert Collins
Move RevisionTree out of tree.py.
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
"""RevisionTree - a Tree implementation backed by repository data for a revision."""
18
19
from cStringIO import StringIO
20
2249.5.13 by John Arbash Meinel
Finish auditing Repository, and fix generate_ids to always generate utf8 ids.
21
from bzrlib import (
3350.6.4 by Robert Collins
First cut at pluralised VersionedFiles. Some rather massive API incompatabilities, primarily because of the difficulty of coherence among competing stores.
22
    errors,
2249.5.13 by John Arbash Meinel
Finish auditing Repository, and fix generate_ids to always generate utf8 ids.
23
    osutils,
2255.2.83 by John Arbash Meinel
[merge] bzr.dev 2294
24
    revision,
1551.15.50 by Aaron Bentley
Deprecate RevisionTree.get_weave
25
    symbol_versioning,
2249.5.13 by John Arbash Meinel
Finish auditing Repository, and fix generate_ids to always generate utf8 ids.
26
    )
1852.7.1 by Robert Collins
Move RevisionTree out of tree.py.
27
from bzrlib.tree import Tree
28
29
30
class RevisionTree(Tree):
31
    """Tree viewing a previous revision.
32
33
    File text can be retrieved from the text store.
34
    """
3008.1.13 by Michael Hudson
merge bzr.dev
35
1852.7.1 by Robert Collins
Move RevisionTree out of tree.py.
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
2858.2.1 by Martin Pool
Remove most calls to safe_file_id and safe_revision_id.
44
        self._revision_id = revision_id
3398.1.24 by Ian Clatworthy
make iter_search_rules a tree method
45
        self._rules_searcher = None
1852.7.1 by Robert Collins
Move RevisionTree out of tree.py.
46
2100.3.20 by Aaron Bentley
Implement tree comparison for tree references
47
    def supports_tree_reference(self):
48
        return True
49
1852.7.1 by Robert Collins
Move RevisionTree out of tree.py.
50
    def get_parent_ids(self):
51
        """See Tree.get_parent_ids.
52
53
        A RevisionTree's parents match the revision graph.
54
        """
1908.11.3 by Robert Collins
Merge bzr.dev
55
        if self._revision_id in (None, revision.NULL_REVISION):
56
            parent_ids = []
1908.11.2 by Robert Collins
Implement WorkingTree interface conformance tests for
57
        else:
1986.1.2 by Robert Collins
Various changes to allow non-workingtree specific tests to run entirely
58
            parent_ids = self._repository.get_revision(
59
                self._revision_id).parent_ids
1852.7.1 by Robert Collins
Move RevisionTree out of tree.py.
60
        return parent_ids
61
        
62
    def get_revision_id(self):
63
        """Return the revision id associated with this tree."""
64
        return self._revision_id
65
66
    def get_file_lines(self, file_id):
3350.6.4 by Robert Collins
First cut at pluralised VersionedFiles. Some rather massive API incompatabilities, primarily because of the difficulty of coherence among competing stores.
67
        return osutils.split_lines(self.get_file_text(file_id))
1852.7.1 by Robert Collins
Move RevisionTree out of tree.py.
68
69
    def get_file_text(self, file_id):
3350.6.4 by Robert Collins
First cut at pluralised VersionedFiles. Some rather massive API incompatabilities, primarily because of the difficulty of coherence among competing stores.
70
        return list(self.iter_files_bytes([(file_id, None)]))[0][1]
1852.7.1 by Robert Collins
Move RevisionTree out of tree.py.
71
2743.3.5 by Ian Clatworthy
Incorporate feedback from abentley
72
    def get_file(self, file_id, path=None):
1852.7.1 by Robert Collins
Move RevisionTree out of tree.py.
73
        return StringIO(self.get_file_text(file_id))
74
2708.1.7 by Aaron Bentley
Rename extract_files_bytes to iter_files_bytes
75
    def iter_files_bytes(self, desired_files):
3350.6.4 by Robert Collins
First cut at pluralised VersionedFiles. Some rather massive API incompatabilities, primarily because of the difficulty of coherence among competing stores.
76
        """See Tree.iter_files_bytes.
2708.1.4 by Aaron Bentley
RevisionTree and DirStateRevisionTree use Repository.extract_files_bytes
77
78
        This version is implemented on top of Repository.extract_files_bytes"""
2708.1.6 by Aaron Bentley
Turn extract_files_bytes into an iterator
79
        repo_desired_files = [(f, self.inventory[f].revision, i)
80
                              for f, i in desired_files]
3350.6.4 by Robert Collins
First cut at pluralised VersionedFiles. Some rather massive API incompatabilities, primarily because of the difficulty of coherence among competing stores.
81
        try:
82
            for result in self._repository.iter_files_bytes(repo_desired_files):
83
                yield result
84
        except errors.RevisionNotPresent, e:
85
            raise errors.NoSuchFile(e.revision_id)
2708.1.4 by Aaron Bentley
RevisionTree and DirStateRevisionTree use Repository.extract_files_bytes
86
1551.15.46 by Aaron Bentley
Move plan merge to tree
87
    def annotate_iter(self, file_id,
88
                      default_revision=revision.CURRENT_REVISION):
1551.9.16 by Aaron Bentley
Implement Tree.annotate_iter for RevisionTree and WorkingTree
89
        """See Tree.annotate_iter"""
3350.6.4 by Robert Collins
First cut at pluralised VersionedFiles. Some rather massive API incompatabilities, primarily because of the difficulty of coherence among competing stores.
90
        text_key = (file_id, self.inventory[file_id].revision)
91
        annotations = self._repository.texts.annotate(text_key)
92
        return [(key[-1], line) for key, line in annotations]
1551.9.16 by Aaron Bentley
Implement Tree.annotate_iter for RevisionTree and WorkingTree
93
1852.7.1 by Robert Collins
Move RevisionTree out of tree.py.
94
    def get_file_size(self, file_id):
3363.3.4 by Aaron Bentley
Add get_file_size to Tree interface
95
        """See Tree.get_file_size"""
1852.7.1 by Robert Collins
Move RevisionTree out of tree.py.
96
        return self._inventory[file_id].text_size
97
2012.1.7 by Aaron Bentley
Get tree._iter_changed down to ~ 1 stat per file
98
    def get_file_sha1(self, file_id, path=None, stat_value=None):
1852.7.1 by Robert Collins
Move RevisionTree out of tree.py.
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":
2294.1.10 by John Arbash Meinel
Switch all apis over to utf8 file ids. All tests pass
112
            return None
113
        return ie.executable
1852.7.1 by Robert Collins
Move RevisionTree out of tree.py.
114
115
    def has_filename(self, filename):
116
        return bool(self.inventory.path2id(filename))
117
1910.2.56 by Aaron Bentley
More work on bundles
118
    def list_files(self, include_root=False):
1852.7.1 by Robert Collins
Move RevisionTree out of tree.py.
119
        # The only files returned by this are those from the version
120
        entries = self.inventory.iter_entries()
121
        # skip the root for compatability with the current apis.
1731.1.52 by Aaron Bentley
Merge from bzr.dev
122
        if self.inventory.root is not None and not include_root:
1910.2.56 by Aaron Bentley
More work on bundles
123
            # skip the root for compatability with the current apis.
1731.1.33 by Aaron Bentley
Revert no-special-root changes
124
            entries.next()
1852.7.1 by Robert Collins
Move RevisionTree out of tree.py.
125
        for path, entry in entries:
126
            yield path, 'V', entry.kind, entry.file_id, entry
127
128
    def get_symlink_target(self, file_id):
129
        ie = self._inventory[file_id]
130
        return ie.symlink_target;
131
2255.2.226 by Robert Collins
Get merge_nested finally working: change nested tree iterators to take file_ids, and ensure the right branch is connected to in the merge logic. May not be suitable for shared repositories yet.
132
    def get_reference_revision(self, file_id, path=None):
133
        return self.inventory[file_id].reference_revision
2100.3.20 by Aaron Bentley
Implement tree comparison for tree references
134
2255.2.166 by Martin Pool
(broken) Add Tree.get_root_id() & test
135
    def get_root_id(self):
136
        if self.inventory.root:
137
            return self.inventory.root.file_id
138
1852.7.1 by Robert Collins
Move RevisionTree out of tree.py.
139
    def kind(self, file_id):
140
        return self._inventory[file_id].kind
141
2776.1.7 by Robert Collins
* New method on ``bzrlib.tree.Tree`` ``path_content_summary`` provides a
142
    def path_content_summary(self, path):
143
        """See Tree.path_content_summary."""
144
        id = self.inventory.path2id(path)
145
        if id is None:
146
            return ('missing', None, None, None)
147
        entry = self._inventory[id]
148
        kind = entry.kind
149
        if kind == 'file':
150
            return (kind, entry.text_size, entry.executable, entry.text_sha1)
151
        elif kind == 'symlink':
152
            return (kind, None, None, entry.symlink_target)
153
        else:
154
            return (kind, None, None, None)
155
2012.1.7 by Aaron Bentley
Get tree._iter_changed down to ~ 1 stat per file
156
    def _comparison_data(self, entry, path):
157
        if entry is None:
2012.1.15 by Aaron Bentley
Minor tweaks
158
            return None, False, None
2012.1.7 by Aaron Bentley
Get tree._iter_changed down to ~ 1 stat per file
159
        return entry.kind, entry.executable, None
160
161
    def _file_size(self, entry, stat_value):
162
        return entry.text_size
163
1551.15.46 by Aaron Bentley
Move plan merge to tree
164
    def _get_ancestors(self, default_revision):
165
        return set(self._repository.get_ancestry(self._revision_id,
166
                                                 topo_sorted=False))
167
1852.7.1 by Robert Collins
Move RevisionTree out of tree.py.
168
    def lock_read(self):
169
        self._repository.lock_read()
170
2255.2.119 by Robert Collins
Give RevisionTree a repr method.
171
    def __repr__(self):
172
        return '<%s instance at %x, rev_id=%r>' % (
173
            self.__class__.__name__, id(self), self._revision_id)
174
1852.7.1 by Robert Collins
Move RevisionTree out of tree.py.
175
    def unlock(self):
176
        self._repository.unlock()
177
1852.15.3 by Robert Collins
Add a first-cut Tree.walkdirs method.
178
    def walkdirs(self, prefix=""):
179
        _directory = 'directory'
180
        inv = self.inventory
1852.15.10 by Robert Collins
Tweak the Tree.walkdirs interface more to be more useful.
181
        top_id = inv.path2id(prefix)
182
        if top_id is None:
183
            pending = []
184
        else:
185
            pending = [(prefix, '', _directory, None, top_id, None)]
1852.15.3 by Robert Collins
Add a first-cut Tree.walkdirs method.
186
        while pending:
187
            dirblock = []
188
            currentdir = pending.pop()
1852.15.10 by Robert Collins
Tweak the Tree.walkdirs interface more to be more useful.
189
            # 0 - relpath, 1- basename, 2- kind, 3- stat, id, v-kind
1852.15.3 by Robert Collins
Add a first-cut Tree.walkdirs method.
190
            if currentdir[0]:
191
                relroot = currentdir[0] + '/'
192
            else:
193
                relroot = ""
194
            # FIXME: stash the node in pending
1852.15.10 by Robert Collins
Tweak the Tree.walkdirs interface more to be more useful.
195
            entry = inv[currentdir[4]]
1852.15.3 by Robert Collins
Add a first-cut Tree.walkdirs method.
196
            for name, child in entry.sorted_children():
197
                toppath = relroot + name
1852.15.10 by Robert Collins
Tweak the Tree.walkdirs interface more to be more useful.
198
                dirblock.append((toppath, name, child.kind, None,
1852.15.3 by Robert Collins
Add a first-cut Tree.walkdirs method.
199
                    child.file_id, child.kind
200
                    ))
1852.15.10 by Robert Collins
Tweak the Tree.walkdirs interface more to be more useful.
201
            yield (currentdir[0], entry.file_id), dirblock
1852.15.3 by Robert Collins
Add a first-cut Tree.walkdirs method.
202
            # push the user specified dirs from dirblock
203
            for dir in reversed(dirblock):
204
                if dir[2] == _directory:
205
                    pending.append(dir)
3398.1.24 by Ian Clatworthy
make iter_search_rules a tree method
206
207
    def _get_rules_searcher(self, default_searcher):
208
        """See Tree._get_rules_searcher."""
209
        if self._rules_searcher is None:
210
            self._rules_searcher = super(RevisionTree,
211
                self)._get_rules_searcher(default_searcher)
212
        return self._rules_searcher