1
# Copyright (C) 2005 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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17
"""Tree classes, representing directory at point in time.
21
from cStringIO import StringIO
22
from warnings import warn
25
from bzrlib.errors import BzrError, BzrCheckError
26
from bzrlib import errors
27
from bzrlib.inventory import Inventory
28
from bzrlib.osutils import fingerprint_file
29
import bzrlib.revision
30
from bzrlib.trace import mutter, note
34
"""Abstract file tree.
36
There are several subclasses:
38
* `WorkingTree` exists as files on disk editable by the user.
40
* `RevisionTree` is a tree as recorded at some point in the past.
42
Trees contain an `Inventory` object, and also know how to retrieve
43
file texts mentioned in the inventory, either from a working
44
directory or from a store.
46
It is possible for trees to contain files that are not described
47
in their inventory or vice versa; for this use `filenames()`.
49
Trees can be compared, etc, regardless of whether they are working
50
trees or versioned trees.
54
"""Get a list of the conflicts in the tree.
56
Each conflict is an instance of bzrlib.conflicts.Conflict.
60
def get_parent_ids(self):
61
"""Get the parent ids for this tree.
63
:return: a list of parent ids. [] is returned to indicate
64
a tree with no parents.
65
:raises: BzrError if the parents are not known.
67
raise NotImplementedError(self.get_parent_ids)
69
def has_filename(self, filename):
70
"""True if the tree has given filename."""
71
raise NotImplementedError()
73
def has_id(self, file_id):
74
return self.inventory.has_id(file_id)
78
def has_or_had_id(self, file_id):
79
if file_id == self.inventory.root.file_id:
81
return self.inventory.has_id(file_id)
84
return iter(self.inventory)
86
def id2path(self, file_id):
87
return self.inventory.id2path(file_id)
89
def iter_entries_by_dir(self):
90
"""Walk the tree in 'by_dir' order.
92
This will yield each entry in the tree as a (path, entry) tuple. The
93
order that they are yielded is: the contents of a directory are
94
preceeded by the parent of a directory, and all the contents of a
95
directory are grouped together.
97
return self.inventory.iter_entries_by_dir()
99
def kind(self, file_id):
100
raise NotImplementedError("subclasses must implement kind")
102
def _get_inventory(self):
103
return self._inventory
105
def get_file_by_path(self, path):
106
return self.get_file(self._inventory.path2id(path))
108
inventory = property(_get_inventory,
109
doc="Inventory of this Tree")
111
def _check_retrieved(self, ie, f):
114
fp = fingerprint_file(f)
117
if ie.text_size != None:
118
if ie.text_size != fp['size']:
119
raise BzrError("mismatched size for file %r in %r" % (ie.file_id, self._store),
120
["inventory expects %d bytes" % ie.text_size,
121
"file is actually %d bytes" % fp['size'],
122
"store is probably damaged/corrupt"])
124
if ie.text_sha1 != fp['sha1']:
125
raise BzrError("wrong SHA-1 for file %r in %r" % (ie.file_id, self._store),
126
["inventory expects %s" % ie.text_sha1,
127
"file is actually %s" % fp['sha1'],
128
"store is probably damaged/corrupt"])
131
def print_file(self, file_id):
132
"""Print file with id `file_id` to stdout."""
134
sys.stdout.write(self.get_file_text(file_id))
140
"""What files are present in this tree and unknown.
142
:return: an iterator over the unknown files.
149
def filter_unversioned_files(self, paths):
150
"""Filter out paths that are not versioned.
152
:return: set of paths.
154
# NB: we specifically *don't* call self.has_filename, because for
155
# WorkingTrees that can indicate files that exist on disk but that
157
pred = self.inventory.has_filename
158
return set((p for p in paths if not pred(p)))
162
from bzrlib.revisiontree import RevisionTree
165
class EmptyTree(Tree):
168
self._inventory = Inventory()
169
warn('EmptyTree is deprecated as of bzr 0.9 please use '
170
'repository.revision_tree instead.',
171
DeprecationWarning, stacklevel=2)
173
def get_parent_ids(self):
176
def get_symlink_target(self, file_id):
179
def has_filename(self, filename):
182
def kind(self, file_id):
183
assert self._inventory[file_id].kind == "root_directory"
184
return "root_directory"
186
def list_files(self):
189
def __contains__(self, file_id):
190
return file_id in self._inventory
192
def get_file_sha1(self, file_id, path=None):
193
assert self._inventory[file_id].kind == "root_directory"
197
######################################################################
200
# TODO: Merge these two functions into a single one that can operate
201
# on either a whole tree or a set of files.
203
# TODO: Return the diff in order by filename, not by category or in
204
# random order. Can probably be done by lock-stepping through the
205
# filenames from both trees.
208
def file_status(filename, old_tree, new_tree):
209
"""Return single-letter status, old and new names for a file.
211
The complexity here is in deciding how to represent renames;
212
many complex cases are possible.
214
old_inv = old_tree.inventory
215
new_inv = new_tree.inventory
216
new_id = new_inv.path2id(filename)
217
old_id = old_inv.path2id(filename)
219
if not new_id and not old_id:
220
# easy: doesn't exist in either; not versioned at all
221
if new_tree.is_ignored(filename):
222
return 'I', None, None
224
return '?', None, None
226
# There is now a file of this name, great.
229
# There is no longer a file of this name, but we can describe
230
# what happened to the file that used to have
231
# this name. There are two possibilities: either it was
232
# deleted entirely, or renamed.
234
if new_inv.has_id(old_id):
235
return 'X', old_inv.id2path(old_id), new_inv.id2path(old_id)
237
return 'D', old_inv.id2path(old_id), None
239
# if the file_id is new in this revision, it is added
240
if new_id and not old_inv.has_id(new_id):
243
# if there used to be a file of this name, but that ID has now
244
# disappeared, it is deleted
245
if old_id and not new_inv.has_id(old_id):
252
def find_renames(old_inv, new_inv):
253
for file_id in old_inv:
254
if file_id not in new_inv:
256
old_name = old_inv.id2path(file_id)
257
new_name = new_inv.id2path(file_id)
258
if old_name != new_name:
259
yield (old_name, new_name)
262
def find_ids_across_trees(filenames, trees, require_versioned=True):
263
"""Find the ids corresponding to specified filenames.
265
All matches in all trees will be used, and all children of matched
266
directories will be used.
268
:param filenames: The filenames to find file_ids for
269
:param trees: The trees to find file_ids within
270
:param require_versioned: if true, all specified filenames must occur in
272
:return: a set of file ids for the specified filenames and their children.
276
specified_ids = _find_filename_ids_across_trees(filenames, trees,
278
return _find_children_across_trees(specified_ids, trees)
281
def _find_filename_ids_across_trees(filenames, trees, require_versioned):
282
"""Find the ids corresponding to specified filenames.
284
All matches in all trees will be used.
286
:param filenames: The filenames to find file_ids for
287
:param trees: The trees to find file_ids within
288
:param require_versioned: if true, all specified filenames must occur in
290
:return: a set of file ids for the specified filenames
293
interesting_ids = set()
294
for tree_path in filenames:
297
file_id = tree.inventory.path2id(tree_path)
298
if file_id is not None:
299
interesting_ids.add(file_id)
302
not_versioned.append(tree_path)
303
if len(not_versioned) > 0 and require_versioned:
304
raise errors.PathsNotVersionedError(not_versioned)
305
return interesting_ids
308
def _find_children_across_trees(specified_ids, trees):
309
"""Return a set including specified ids and their children
311
All matches in all trees will be used.
313
:param trees: The trees to find file_ids within
314
:return: a set containing all specified ids and their children
316
interesting_ids = set(specified_ids)
317
pending = interesting_ids
318
# now handle children of interesting ids
319
# we loop so that we handle all children of each id in both trees
320
while len(pending) > 0:
322
for file_id in pending:
324
if file_id not in tree:
326
entry = tree.inventory[file_id]
327
for child in getattr(entry, 'children', {}).itervalues():
328
if child.file_id not in interesting_ids:
329
new_pending.add(child.file_id)
330
interesting_ids.update(new_pending)
331
pending = new_pending
332
return interesting_ids
added
removed
bzrlib/tree.py
