1
# Copyright (C) 2006-2010 Canonical Ltd
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.
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.
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
17
"""RevisionTree - a Tree implementation backed by repository data for a revision."""
19
from cStringIO import StringIO
28
class RevisionTree(tree.Tree):
29
"""Tree viewing a previous revision.
31
File text can be retrieved from the text store.
34
def __init__(self, repository, revision_id):
35
self._repository = repository
36
self._revision_id = revision_id
37
self._rules_searcher = None
39
def has_versioned_directories(self):
40
"""See `Tree.has_versioned_directories`."""
41
return self._repository._format.supports_versioned_directories
43
def supports_tree_reference(self):
44
return getattr(self._repository._format, "supports_tree_reference",
47
def get_parent_ids(self):
48
"""See Tree.get_parent_ids.
50
A RevisionTree's parents match the revision graph.
52
if self._revision_id in (None, revision.NULL_REVISION):
55
parent_ids = self._repository.get_revision(
56
self._revision_id).parent_ids
59
def get_revision_id(self):
60
"""Return the revision id associated with this tree."""
61
return self._revision_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)
67
def get_file_text(self, file_id, path=None):
68
for (identifier, content) in self.iter_files_bytes([(file_id, None)]):
69
ret = "".join(content)
72
def get_file(self, file_id, path=None):
73
return StringIO(self.get_file_text(file_id))
76
return self._repository.is_locked()
79
self._repository.lock_read()
83
return '<%s instance at %x, rev_id=%r>' % (
84
self.__class__.__name__, id(self), self._revision_id)
87
self._repository.unlock()
89
def _get_rules_searcher(self, default_searcher):
90
"""See Tree._get_rules_searcher."""
91
if self._rules_searcher is None:
92
self._rules_searcher = super(RevisionTree,
93
self)._get_rules_searcher(default_searcher)
94
return self._rules_searcher
97
class InventoryRevisionTree(RevisionTree,tree.InventoryTree):
99
def __init__(self, repository, inv, revision_id):
100
RevisionTree.__init__(self, repository, revision_id)
101
self._inventory = inv
103
def get_file_mtime(self, file_id, path=None):
104
ie = self._inventory[file_id]
106
revision = self._repository.get_revision(ie.revision)
107
except errors.NoSuchRevision:
108
raise errors.FileTimestampUnavailable(self.id2path(file_id))
109
return revision.timestamp
111
def get_file_size(self, file_id):
112
return self._inventory[file_id].text_size
114
def get_file_sha1(self, file_id, path=None, stat_value=None):
115
ie = self._inventory[file_id]
116
if ie.kind == "file":
120
def get_file_revision(self, file_id, path=None):
121
ie = self._inventory[file_id]
124
def is_executable(self, file_id, path=None):
125
ie = self._inventory[file_id]
126
if ie.kind != "file":
130
def has_filename(self, filename):
131
return bool(self.inventory.path2id(filename))
133
def list_files(self, include_root=False, from_dir=None, recursive=True):
134
# The only files returned by this are those from the version
139
from_dir_id = inv.path2id(from_dir)
140
if from_dir_id is None:
141
# Directory not versioned
143
entries = inv.iter_entries(from_dir=from_dir_id, recursive=recursive)
144
if inv.root is not None and not include_root and from_dir is None:
145
# skip the root for compatability with the current apis.
147
for path, entry in entries:
148
yield path, 'V', entry.kind, entry.file_id, entry
150
def get_symlink_target(self, file_id, path=None):
151
ie = self._inventory[file_id]
152
# Inventories store symlink targets in unicode
153
return ie.symlink_target
155
def get_reference_revision(self, file_id, path=None):
156
return self.inventory[file_id].reference_revision
158
def get_root_id(self):
159
if self.inventory.root:
160
return self.inventory.root.file_id
162
def kind(self, file_id):
163
return self._inventory[file_id].kind
165
def path_content_summary(self, path):
166
"""See Tree.path_content_summary."""
167
id = self.inventory.path2id(path)
169
return ('missing', None, None, None)
170
entry = self._inventory[id]
173
return (kind, entry.text_size, entry.executable, entry.text_sha1)
174
elif kind == 'symlink':
175
return (kind, None, None, entry.symlink_target)
177
return (kind, None, None, None)
179
def _comparison_data(self, entry, path):
181
return None, False, None
182
return entry.kind, entry.executable, None
184
def _file_size(self, entry, stat_value):
185
return entry.text_size
187
def walkdirs(self, prefix=""):
188
_directory = 'directory'
190
top_id = inv.path2id(prefix)
194
pending = [(prefix, '', _directory, None, top_id, None)]
197
currentdir = pending.pop()
198
# 0 - relpath, 1- basename, 2- kind, 3- stat, id, v-kind
200
relroot = currentdir[0] + '/'
203
# FIXME: stash the node in pending
204
entry = inv[currentdir[4]]
205
for name, child in entry.sorted_children():
206
toppath = relroot + name
207
dirblock.append((toppath, name, child.kind, None,
208
child.file_id, child.kind
210
yield (currentdir[0], entry.file_id), dirblock
211
# push the user specified dirs from dirblock
212
for dir in reversed(dirblock):
213
if dir[2] == _directory:
216
def iter_files_bytes(self, desired_files):
217
"""See Tree.iter_files_bytes.
219
This version is implemented on top of Repository.iter_files_bytes"""
220
repo_desired_files = [(f, self.get_file_revision(f), i)
221
for f, i in desired_files]
223
for result in self._repository.iter_files_bytes(repo_desired_files):
225
except errors.RevisionNotPresent, e:
226
raise errors.NoSuchFile(e.file_id)
228
def annotate_iter(self, file_id,
229
default_revision=revision.CURRENT_REVISION):
230
"""See Tree.annotate_iter"""
231
text_key = (file_id, self.get_file_revision(file_id))
232
annotator = self._repository.texts.get_annotator()
233
annotations = annotator.annotate_flat(text_key)
234
return [(key[-1], line) for key, line in annotations]
237
class InterCHKRevisionTree(tree.InterTree):
238
"""Fast path optimiser for RevisionTrees with CHK inventories."""
241
def is_compatible(source, target):
242
if (isinstance(source, RevisionTree)
243
and isinstance(target, RevisionTree)):
245
# Only CHK inventories have id_to_entry attribute
246
source.inventory.id_to_entry
247
target.inventory.id_to_entry
249
except AttributeError:
253
def iter_changes(self, include_unchanged=False,
254
specific_files=None, pb=None, extra_trees=[],
255
require_versioned=True, want_unversioned=False):
256
lookup_trees = [self.source]
258
lookup_trees.extend(extra_trees)
259
# The ids of items we need to examine to insure delta consistency.
260
precise_file_ids = set()
261
discarded_changes = {}
262
if specific_files == []:
263
specific_file_ids = []
265
specific_file_ids = self.target.paths2ids(specific_files,
266
lookup_trees, require_versioned=require_versioned)
267
# FIXME: It should be possible to delegate include_unchanged handling
268
# to CHKInventory.iter_changes and do a better job there -- vila
270
changed_file_ids = set()
271
for result in self.target.inventory.iter_changes(self.source.inventory):
272
if specific_file_ids is not None:
274
if file_id not in specific_file_ids:
275
# A change from the whole tree that we don't want to show yet.
276
# We may find that we need to show it for delta consistency, so
278
discarded_changes[result[0]] = result
280
new_parent_id = result[4][1]
281
precise_file_ids.add(new_parent_id)
283
changed_file_ids.add(result[0])
284
if specific_file_ids is not None:
285
for result in self._handle_precise_ids(precise_file_ids,
286
changed_file_ids, discarded_changes=discarded_changes):
288
if include_unchanged:
289
# CHKMap avoid being O(tree), so we go to O(tree) only if
291
# Now walk the whole inventory, excluding the already yielded
293
changed_file_ids = set(changed_file_ids)
294
for relpath, entry in self.target.inventory.iter_entries():
295
if (specific_file_ids is not None
296
and not entry.file_id in specific_file_ids):
298
if not entry.file_id in changed_file_ids:
299
yield (entry.file_id,
300
(relpath, relpath), # Not renamed
301
False, # Not modified
302
(True, True), # Still versioned
303
(entry.parent_id, entry.parent_id),
304
(entry.name, entry.name),
305
(entry.kind, entry.kind),
306
(entry.executable, entry.executable))
309
tree.InterTree.register_optimiser(InterCHKRevisionTree)