/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/revisiontree.py

Add source index to the index iteration API to allow mapping back to the origin of retrieved data.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/revisiontree.py
 
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., 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
 
 
21
from bzrlib import (
 
22
    osutils,
 
23
    revision,
 
24
    symbol_versioning,
 
25
    )
 
26
from bzrlib.tree import Tree
 
27
 
 
28
 
 
29
class RevisionTree(Tree):
 
30
    """Tree viewing a previous revision.
 
31
 
 
32
    File text can be retrieved from the text store.
 
33
    """
 
34
    
 
35
    def __init__(self, branch, inv, revision_id):
 
36
        # for compatability the 'branch' parameter has not been renamed to 
 
37
        # repository at this point. However, we should change RevisionTree's
 
38
        # construction to always be via Repository and not via direct 
 
39
        # construction - this will mean that we can change the constructor
 
40
        # with much less chance of breaking client code.
 
41
        self._repository = branch
 
42
        self._weave_store = branch.weave_store
 
43
        self._inventory = inv
 
44
        self._revision_id = osutils.safe_revision_id(revision_id)
 
45
 
 
46
    def supports_tree_reference(self):
 
47
        return True
 
48
 
 
49
    def get_parent_ids(self):
 
50
        """See Tree.get_parent_ids.
 
51
 
 
52
        A RevisionTree's parents match the revision graph.
 
53
        """
 
54
        if self._revision_id in (None, revision.NULL_REVISION):
 
55
            parent_ids = []
 
56
        else:
 
57
            parent_ids = self._repository.get_revision(
 
58
                self._revision_id).parent_ids
 
59
        return parent_ids
 
60
        
 
61
    def get_revision_id(self):
 
62
        """Return the revision id associated with this tree."""
 
63
        return self._revision_id
 
64
 
 
65
    @symbol_versioning.deprecated_method(symbol_versioning.zero_nineteen)
 
66
    def get_weave(self, file_id):
 
67
        return self._get_weave(file_id)
 
68
 
 
69
    def _get_weave(self, file_id):
 
70
        file_id = osutils.safe_file_id(file_id)
 
71
        return self._weave_store.get_weave(file_id,
 
72
                self._repository.get_transaction())
 
73
 
 
74
    def get_file_lines(self, file_id):
 
75
        file_id = osutils.safe_file_id(file_id)
 
76
        ie = self._inventory[file_id]
 
77
        weave = self._get_weave(file_id)
 
78
        return weave.get_lines(ie.revision)
 
79
 
 
80
    def get_file_text(self, file_id):
 
81
        file_id = osutils.safe_file_id(file_id)
 
82
        return ''.join(self.get_file_lines(file_id))
 
83
 
 
84
    def get_file(self, file_id):
 
85
        file_id = osutils.safe_file_id(file_id)
 
86
        return StringIO(self.get_file_text(file_id))
 
87
 
 
88
    def annotate_iter(self, file_id,
 
89
                      default_revision=revision.CURRENT_REVISION):
 
90
        """See Tree.annotate_iter"""
 
91
        file_id = osutils.safe_file_id(file_id)
 
92
        w = self._get_weave(file_id)
 
93
        return w.annotate_iter(self.inventory[file_id].revision)
 
94
 
 
95
    def get_file_size(self, file_id):
 
96
        file_id = osutils.safe_file_id(file_id)
 
97
        return self._inventory[file_id].text_size
 
98
 
 
99
    def get_file_sha1(self, file_id, path=None, stat_value=None):
 
100
        file_id = osutils.safe_file_id(file_id)
 
101
        ie = self._inventory[file_id]
 
102
        if ie.kind == "file":
 
103
            return ie.text_sha1
 
104
        return None
 
105
 
 
106
    def get_file_mtime(self, file_id, path=None):
 
107
        file_id = osutils.safe_file_id(file_id)
 
108
        ie = self._inventory[file_id]
 
109
        revision = self._repository.get_revision(ie.revision)
 
110
        return revision.timestamp
 
111
 
 
112
    def is_executable(self, file_id, path=None):
 
113
        file_id = osutils.safe_file_id(file_id)
 
114
        ie = self._inventory[file_id]
 
115
        if ie.kind != "file":
 
116
            return None
 
117
        return ie.executable
 
118
 
 
119
    def has_filename(self, filename):
 
120
        return bool(self.inventory.path2id(filename))
 
121
 
 
122
    def list_files(self, include_root=False):
 
123
        # The only files returned by this are those from the version
 
124
        entries = self.inventory.iter_entries()
 
125
        # skip the root for compatability with the current apis.
 
126
        if self.inventory.root is not None and not include_root:
 
127
            # skip the root for compatability with the current apis.
 
128
            entries.next()
 
129
        for path, entry in entries:
 
130
            yield path, 'V', entry.kind, entry.file_id, entry
 
131
 
 
132
    def get_symlink_target(self, file_id):
 
133
        file_id = osutils.safe_file_id(file_id)
 
134
        ie = self._inventory[file_id]
 
135
        return ie.symlink_target;
 
136
 
 
137
    def get_reference_revision(self, file_id, path=None):
 
138
        return self.inventory[file_id].reference_revision
 
139
 
 
140
    def get_root_id(self):
 
141
        if self.inventory.root:
 
142
            return self.inventory.root.file_id
 
143
 
 
144
    def kind(self, file_id):
 
145
        file_id = osutils.safe_file_id(file_id)
 
146
        return self._inventory[file_id].kind
 
147
 
 
148
    def _comparison_data(self, entry, path):
 
149
        if entry is None:
 
150
            return None, False, None
 
151
        return entry.kind, entry.executable, None
 
152
 
 
153
    def _file_size(self, entry, stat_value):
 
154
        assert entry.text_size is not None
 
155
        return entry.text_size
 
156
 
 
157
    def _get_ancestors(self, default_revision):
 
158
        return set(self._repository.get_ancestry(self._revision_id,
 
159
                                                 topo_sorted=False))
 
160
 
 
161
    def lock_read(self):
 
162
        self._repository.lock_read()
 
163
 
 
164
    def __repr__(self):
 
165
        return '<%s instance at %x, rev_id=%r>' % (
 
166
            self.__class__.__name__, id(self), self._revision_id)
 
167
 
 
168
    def unlock(self):
 
169
        self._repository.unlock()
 
170
 
 
171
    def walkdirs(self, prefix=""):
 
172
        _directory = 'directory'
 
173
        inv = self.inventory
 
174
        top_id = inv.path2id(prefix)
 
175
        if top_id is None:
 
176
            pending = []
 
177
        else:
 
178
            pending = [(prefix, '', _directory, None, top_id, None)]
 
179
        while pending:
 
180
            dirblock = []
 
181
            currentdir = pending.pop()
 
182
            # 0 - relpath, 1- basename, 2- kind, 3- stat, id, v-kind
 
183
            if currentdir[0]:
 
184
                relroot = currentdir[0] + '/'
 
185
            else:
 
186
                relroot = ""
 
187
            # FIXME: stash the node in pending
 
188
            entry = inv[currentdir[4]]
 
189
            for name, child in entry.sorted_children():
 
190
                toppath = relroot + name
 
191
                dirblock.append((toppath, name, child.kind, None,
 
192
                    child.file_id, child.kind
 
193
                    ))
 
194
            yield (currentdir[0], entry.file_id), dirblock
 
195
            # push the user specified dirs from dirblock
 
196
            for dir in reversed(dirblock):
 
197
                if dir[2] == _directory:
 
198
                    pending.append(dir)