1
1
# Copyright (C) 2005 Canonical Ltd
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
5
5
# the Free Software Foundation; either version 2 of the License, or
6
6
# (at your option) any later version.
8
8
# This program is distributed in the hope that it will be useful,
9
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
11
# GNU General Public License for more details.
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
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
48
53
trees or versioned trees.
56
def changes_from(self, other, want_unchanged=False, specific_files=None,
57
extra_trees=None, require_versioned=False):
58
"""Return a TreeDelta of the changes from other to this tree.
60
:param other: A tree to compare with.
61
:param specific_files: An optional list of file paths to restrict the
62
comparison to. When mapping filenames to ids, all matches in all
63
trees (including optional extra_trees) are used, and all children of
64
matched directories are included.
65
:param want_unchanged: An optional boolean requesting the inclusion of
66
unchanged entries in the result.
67
:param extra_trees: An optional list of additional trees to use when
68
mapping the contents of specific_files (paths) to file_ids.
69
:param require_versioned: An optional boolean (defaults to False). When
70
supplied and True all the 'specific_files' must be versioned, or
71
a PathsNotVersionedError will be thrown.
73
The comparison will be performed by an InterTree object looked up on
76
# Martin observes that Tree.changes_from returns a TreeDelta and this
77
# may confuse people, because the class name of the returned object is
78
# a synonym of the object referenced in the method name.
79
return InterTree.get(other, self).compare(
80
want_unchanged=want_unchanged,
81
specific_files=specific_files,
82
extra_trees=extra_trees,
83
require_versioned=require_versioned,
87
"""Get a list of the conflicts in the tree.
89
Each conflict is an instance of bzrlib.conflicts.Conflict.
93
def get_parent_ids(self):
94
"""Get the parent ids for this tree.
96
:return: a list of parent ids. [] is returned to indicate
97
a tree with no parents.
98
:raises: BzrError if the parents are not known.
100
raise NotImplementedError(self.get_parent_ids)
51
102
def has_filename(self, filename):
52
103
"""True if the tree has given filename."""
53
104
raise NotImplementedError()
55
106
def has_id(self, file_id):
56
107
return self.inventory.has_id(file_id)
109
__contains__ = has_id
58
111
def has_or_had_id(self, file_id):
59
112
if file_id == self.inventory.root.file_id:
61
114
return self.inventory.has_id(file_id)
65
116
def __iter__(self):
66
117
return iter(self.inventory)
68
119
def id2path(self, file_id):
69
120
return self.inventory.id2path(file_id)
122
def iter_entries_by_dir(self):
123
"""Walk the tree in 'by_dir' order.
125
This will yield each entry in the tree as a (path, entry) tuple. The
126
order that they are yielded is: the contents of a directory are
127
preceeded by the parent of a directory, and all the contents of a
128
directory are grouped together.
130
return self.inventory.iter_entries_by_dir()
71
132
def kind(self, file_id):
72
133
raise NotImplementedError("subclasses must implement kind")
121
189
# are not versioned.
122
190
pred = self.inventory.has_filename
123
191
return set((p for p in paths if not pred(p)))
126
class RevisionTree(Tree):
127
"""Tree viewing a previous revision.
129
File text can be retrieved from the text store.
131
TODO: Some kind of `__repr__` method, but a good one
132
probably means knowing the branch and revision number,
133
or at least passing a description to the constructor.
136
def __init__(self, branch, inv, revision_id):
137
self._branch = branch
138
self._weave_store = branch.weave_store
139
self._inventory = inv
140
self._revision_id = revision_id
142
def get_revision_id(self):
143
"""Return the revision id associated with this tree."""
144
return self._revision_id
146
def get_weave(self, file_id):
147
return self._weave_store.get_weave(file_id,
148
self._branch.get_transaction())
150
def get_file_lines(self, file_id):
151
ie = self._inventory[file_id]
152
weave = self.get_weave(file_id)
153
return weave.get_lines(ie.revision)
155
def get_file_text(self, file_id):
156
return ''.join(self.get_file_lines(file_id))
158
def get_file(self, file_id):
159
return StringIO(self.get_file_text(file_id))
161
def get_file_size(self, file_id):
162
return self._inventory[file_id].text_size
164
def get_file_sha1(self, file_id, path=None):
165
ie = self._inventory[file_id]
166
if ie.kind == "file":
170
def get_file_mtime(self, file_id, path=None):
171
ie = self._inventory[file_id]
172
revision = self._branch.get_revision(ie.revision)
173
return revision.timestamp
175
def is_executable(self, file_id, path=None):
176
ie = self._inventory[file_id]
177
if ie.kind != "file":
179
return self._inventory[file_id].executable
181
def has_filename(self, filename):
182
return bool(self.inventory.path2id(filename))
184
def list_files(self):
185
# The only files returned by this are those from the version
186
for path, entry in self.inventory.iter_entries():
187
yield path, 'V', entry.kind, entry.file_id, entry
189
def get_symlink_target(self, file_id):
190
ie = self._inventory[file_id]
191
return ie.symlink_target;
193
def kind(self, file_id):
194
return self._inventory[file_id].kind
197
self._branch.lock_read()
200
self._branch.unlock()
195
from bzrlib.revisiontree import RevisionTree
203
198
class EmptyTree(Tree):
204
200
def __init__(self):
205
201
self._inventory = Inventory()
202
warn('EmptyTree is deprecated as of bzr 0.9 please use '
203
'repository.revision_tree instead.',
204
DeprecationWarning, stacklevel=2)
206
def get_parent_ids(self):
207
209
def get_symlink_target(self, file_id):
290
292
yield (old_name, new_name)
295
def find_ids_across_trees(filenames, trees, require_versioned=True):
296
"""Find the ids corresponding to specified filenames.
298
All matches in all trees will be used, and all children of matched
299
directories will be used.
301
:param filenames: The filenames to find file_ids for
302
:param trees: The trees to find file_ids within
303
:param require_versioned: if true, all specified filenames must occur in
305
:return: a set of file ids for the specified filenames and their children.
309
specified_ids = _find_filename_ids_across_trees(filenames, trees,
311
return _find_children_across_trees(specified_ids, trees)
314
def _find_filename_ids_across_trees(filenames, trees, require_versioned):
315
"""Find the ids corresponding to specified filenames.
317
All matches in all trees will be used.
319
:param filenames: The filenames to find file_ids for
320
:param trees: The trees to find file_ids within
321
:param require_versioned: if true, all specified filenames must occur in
323
:return: a set of file ids for the specified filenames
326
interesting_ids = set()
327
for tree_path in filenames:
330
file_id = tree.inventory.path2id(tree_path)
331
if file_id is not None:
332
interesting_ids.add(file_id)
335
not_versioned.append(tree_path)
336
if len(not_versioned) > 0 and require_versioned:
337
raise errors.PathsNotVersionedError(not_versioned)
338
return interesting_ids
341
def _find_children_across_trees(specified_ids, trees):
342
"""Return a set including specified ids and their children
344
All matches in all trees will be used.
346
:param trees: The trees to find file_ids within
347
:return: a set containing all specified ids and their children
349
interesting_ids = set(specified_ids)
350
pending = interesting_ids
351
# now handle children of interesting ids
352
# we loop so that we handle all children of each id in both trees
353
while len(pending) > 0:
355
for file_id in pending:
357
if file_id not in tree:
359
entry = tree.inventory[file_id]
360
for child in getattr(entry, 'children', {}).itervalues():
361
if child.file_id not in interesting_ids:
362
new_pending.add(child.file_id)
363
interesting_ids.update(new_pending)
364
pending = new_pending
365
return interesting_ids
368
class InterTree(InterObject):
369
"""This class represents operations taking place between two Trees.
371
Its instances have methods like 'compare' and contain references to the
372
source and target trees these operations are to be carried out on.
374
clients of bzrlib should not need to use InterTree directly, rather they
375
should use the convenience methods on Tree such as 'Tree.compare()' which
376
will pass through to InterTree as appropriate.
382
def compare(self, want_unchanged=False, specific_files=None,
383
extra_trees=None, require_versioned=False):
384
"""Return the changes from source to target.
386
:return: A TreeDelta.
387
:param specific_files: An optional list of file paths to restrict the
388
comparison to. When mapping filenames to ids, all matches in all
389
trees (including optional extra_trees) are used, and all children of
390
matched directories are included.
391
:param want_unchanged: An optional boolean requesting the inclusion of
392
unchanged entries in the result.
393
:param extra_trees: An optional list of additional trees to use when
394
mapping the contents of specific_files (paths) to file_ids.
395
:param require_versioned: An optional boolean (defaults to False). When
396
supplied and True all the 'specific_files' must be versioned, or
397
a PathsNotVersionedError will be thrown.
399
# NB: show_status depends on being able to pass in non-versioned files and
400
# report them as unknown
401
trees = (self.source, self.target)
402
if extra_trees is not None:
403
trees = trees + tuple(extra_trees)
404
specific_file_ids = find_ids_across_trees(specific_files,
405
trees, require_versioned=require_versioned)
406
if specific_files and not specific_file_ids:
407
# All files are unversioned, so just return an empty delta
408
# _compare_trees would think we want a complete delta
409
return delta.TreeDelta()
410
return delta._compare_trees(self.source, self.target, want_unchanged,