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 __future__ import absolute_import
21
from cStringIO import StringIO
30
class RevisionTree(tree.Tree):
31
"""Tree viewing a previous revision.
33
File text can be retrieved from the text store.
36
def __init__(self, repository, revision_id):
37
self._repository = repository
38
self._revision_id = revision_id
39
self._rules_searcher = None
41
def has_versioned_directories(self):
42
"""See `Tree.has_versioned_directories`."""
43
return self._repository._format.supports_versioned_directories
45
def supports_tree_reference(self):
46
return getattr(self._repository._format, "supports_tree_reference",
49
def get_parent_ids(self):
50
"""See Tree.get_parent_ids.
52
A RevisionTree's parents match the revision graph.
54
if self._revision_id in (None, revision.NULL_REVISION):
57
parent_ids = self._repository.get_revision(
58
self._revision_id).parent_ids
61
def get_revision_id(self):
62
"""Return the revision id associated with this tree."""
63
return self._revision_id
65
def get_file_revision(self, file_id, path=None):
66
"""Return the revision id in which a file was last changed."""
67
raise NotImplementedError(self.get_file_revision)
69
def get_file_text(self, file_id, path=None):
70
for (identifier, content) in self.iter_files_bytes([(file_id, None)]):
71
ret = "".join(content)
74
def get_file(self, file_id, path=None):
75
return StringIO(self.get_file_text(file_id))
78
return self._repository.is_locked()
81
self._repository.lock_read()
85
return '<%s instance at %x, rev_id=%r>' % (
86
self.__class__.__name__, id(self), self._revision_id)
89
self._repository.unlock()
91
def _get_rules_searcher(self, default_searcher):
92
"""See Tree._get_rules_searcher."""
93
if self._rules_searcher is None:
94
self._rules_searcher = super(RevisionTree,
95
self)._get_rules_searcher(default_searcher)
96
return self._rules_searcher
99
class InventoryRevisionTree(RevisionTree,tree.InventoryTree):
101
def __init__(self, repository, inv, revision_id):
102
RevisionTree.__init__(self, repository, revision_id)
103
self._inventory = inv
105
def get_file_mtime(self, file_id, path=None):
106
inv, inv_file_id = self._unpack_file_id(file_id)
107
ie = inv[inv_file_id]
109
revision = self._repository.get_revision(ie.revision)
110
except errors.NoSuchRevision:
111
raise errors.FileTimestampUnavailable(self.id2path(file_id))
112
return revision.timestamp
114
def get_file_size(self, file_id):
115
inv, inv_file_id = self._unpack_file_id(file_id)
116
return inv[inv_file_id].text_size
118
def get_file_sha1(self, file_id, path=None, stat_value=None):
119
inv, inv_file_id = self._unpack_file_id(file_id)
120
ie = inv[inv_file_id]
121
if ie.kind == "file":
125
def get_file_revision(self, file_id, path=None):
126
inv, inv_file_id = self._unpack_file_id(file_id)
127
ie = inv[inv_file_id]
130
def is_executable(self, file_id, path=None):
131
inv, inv_file_id = self._unpack_file_id(file_id)
132
ie = inv[inv_file_id]
133
if ie.kind != "file":
137
def has_filename(self, filename):
138
return bool(self.path2id(filename))
140
def list_files(self, include_root=False, from_dir=None, recursive=True):
141
# The only files returned by this are those from the version
144
inv = self.root_inventory
146
inv, from_dir_id = self._path2inv_file_id(from_dir)
147
if from_dir_id is None:
148
# Directory not versioned
150
entries = inv.iter_entries(from_dir=from_dir_id, recursive=recursive)
151
if inv.root is not None and not include_root and from_dir is None:
152
# skip the root for compatability with the current apis.
154
for path, entry in entries:
155
yield path, 'V', entry.kind, entry.file_id, entry
157
def get_symlink_target(self, file_id, path=None):
158
inv, inv_file_id = self._unpack_file_id(file_id)
159
ie = inv[inv_file_id]
160
# Inventories store symlink targets in unicode
161
return ie.symlink_target
163
def get_reference_revision(self, file_id, path=None):
164
inv, inv_file_id = self._unpack_file_id(file_id)
165
return inv[inv_file_id].reference_revision
167
def get_root_id(self):
168
if self.root_inventory.root:
169
return self.root_inventory.root.file_id
171
def kind(self, file_id):
172
inv, inv_file_id = self._unpack_file_id(file_id)
173
return inv[inv_file_id].kind
175
def path_content_summary(self, path):
176
"""See Tree.path_content_summary."""
177
inv, file_id = self._path2inv_file_id(path)
179
return ('missing', None, None, None)
183
return (kind, entry.text_size, entry.executable, entry.text_sha1)
184
elif kind == 'symlink':
185
return (kind, None, None, entry.symlink_target)
187
return (kind, None, None, None)
189
def _comparison_data(self, entry, path):
191
return None, False, None
192
return entry.kind, entry.executable, None
194
def _file_size(self, entry, stat_value):
195
return entry.text_size
197
def walkdirs(self, prefix=""):
198
_directory = 'directory'
199
inv, top_id = self._path2inv_file_id(prefix)
203
pending = [(prefix, '', _directory, None, top_id, None)]
206
currentdir = pending.pop()
207
# 0 - relpath, 1- basename, 2- kind, 3- stat, id, v-kind
209
relroot = currentdir[0] + '/'
212
# FIXME: stash the node in pending
213
entry = inv[currentdir[4]]
214
for name, child in entry.sorted_children():
215
toppath = relroot + name
216
dirblock.append((toppath, name, child.kind, None,
217
child.file_id, child.kind
219
yield (currentdir[0], entry.file_id), dirblock
220
# push the user specified dirs from dirblock
221
for dir in reversed(dirblock):
222
if dir[2] == _directory:
225
def iter_files_bytes(self, desired_files):
226
"""See Tree.iter_files_bytes.
228
This version is implemented on top of Repository.iter_files_bytes"""
229
repo_desired_files = [(f, self.get_file_revision(f), i)
230
for f, i in desired_files]
232
for result in self._repository.iter_files_bytes(repo_desired_files):
234
except errors.RevisionNotPresent, e:
235
raise errors.NoSuchFile(e.file_id)
237
def annotate_iter(self, file_id,
238
default_revision=revision.CURRENT_REVISION):
239
"""See Tree.annotate_iter"""
240
text_key = (file_id, self.get_file_revision(file_id))
241
annotator = self._repository.texts.get_annotator()
242
annotations = annotator.annotate_flat(text_key)
243
return [(key[-1], line) for key, line in annotations]
245
def __eq__(self, other):
248
if isinstance(other, InventoryRevisionTree):
249
return (self.root_inventory == other.root_inventory)
252
def __ne__(self, other):
253
return not (self == other)
256
raise ValueError('not hashable')
259
class InterCHKRevisionTree(tree.InterTree):
260
"""Fast path optimiser for RevisionTrees with CHK inventories."""
263
def is_compatible(source, target):
264
if (isinstance(source, RevisionTree)
265
and isinstance(target, RevisionTree)):
267
# Only CHK inventories have id_to_entry attribute
268
source.root_inventory.id_to_entry
269
target.root_inventory.id_to_entry
271
except AttributeError:
275
def iter_changes(self, include_unchanged=False,
276
specific_files=None, pb=None, extra_trees=[],
277
require_versioned=True, want_unversioned=False):
278
lookup_trees = [self.source]
280
lookup_trees.extend(extra_trees)
281
# The ids of items we need to examine to insure delta consistency.
282
precise_file_ids = set()
283
discarded_changes = {}
284
if specific_files == []:
285
specific_file_ids = []
287
specific_file_ids = self.target.paths2ids(specific_files,
288
lookup_trees, require_versioned=require_versioned)
289
# FIXME: It should be possible to delegate include_unchanged handling
290
# to CHKInventory.iter_changes and do a better job there -- vila
292
changed_file_ids = set()
293
# FIXME: nested tree support
294
for result in self.target.root_inventory.iter_changes(
295
self.source.root_inventory):
296
if specific_file_ids is not None:
298
if file_id not in specific_file_ids:
299
# A change from the whole tree that we don't want to show yet.
300
# We may find that we need to show it for delta consistency, so
302
discarded_changes[result[0]] = result
304
new_parent_id = result[4][1]
305
precise_file_ids.add(new_parent_id)
307
changed_file_ids.add(result[0])
308
if specific_file_ids is not None:
309
for result in self._handle_precise_ids(precise_file_ids,
310
changed_file_ids, discarded_changes=discarded_changes):
312
if include_unchanged:
313
# CHKMap avoid being O(tree), so we go to O(tree) only if
315
# Now walk the whole inventory, excluding the already yielded
317
# FIXME: Support nested trees
318
changed_file_ids = set(changed_file_ids)
319
for relpath, entry in self.target.root_inventory.iter_entries():
320
if (specific_file_ids is not None
321
and not entry.file_id in specific_file_ids):
323
if not entry.file_id in changed_file_ids:
324
yield (entry.file_id,
325
(relpath, relpath), # Not renamed
326
False, # Not modified
327
(True, True), # Still versioned
328
(entry.parent_id, entry.parent_id),
329
(entry.name, entry.name),
330
(entry.kind, entry.kind),
331
(entry.executable, entry.executable))
334
tree.InterTree.register_optimiser(InterCHKRevisionTree)