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 import delta
26
from bzrlib.decorators import needs_read_lock
27
from bzrlib.errors import BzrError, BzrCheckError
28
from bzrlib import errors
29
from bzrlib.inventory import Inventory
30
from bzrlib.inter import InterObject
31
from bzrlib.osutils import fingerprint_file
32
import bzrlib.revision
33
from bzrlib.trace import mutter, note
37
"""Abstract file tree.
39
There are several subclasses:
41
* `WorkingTree` exists as files on disk editable by the user.
43
* `RevisionTree` is a tree as recorded at some point in the past.
45
Trees contain an `Inventory` object, and also know how to retrieve
46
file texts mentioned in the inventory, either from a working
47
directory or from a store.
49
It is possible for trees to contain files that are not described
50
in their inventory or vice versa; for this use `filenames()`.
52
Trees can be compared, etc, regardless of whether they are working
53
trees or versioned trees.
56
def changes_from(self, other, want_unchanged=False, specific_files=None,
57
extra_trees=None, require_versioned=False, include_root=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,
84
include_root=include_root
88
"""Get a list of the conflicts in the tree.
90
Each conflict is an instance of bzrlib.conflicts.Conflict.
94
def get_parent_ids(self):
95
"""Get the parent ids for this tree.
97
:return: a list of parent ids. [] is returned to indicate
98
a tree with no parents.
99
:raises: BzrError if the parents are not known.
101
raise NotImplementedError(self.get_parent_ids)
103
def has_filename(self, filename):
104
"""True if the tree has given filename."""
105
raise NotImplementedError()
107
def has_id(self, file_id):
108
return self.inventory.has_id(file_id)
110
__contains__ = has_id
112
def has_or_had_id(self, file_id):
113
if file_id == self.inventory.root.file_id:
115
return self.inventory.has_id(file_id)
118
return iter(self.inventory)
120
def id2path(self, file_id):
121
return self.inventory.id2path(file_id)
123
def is_control_filename(self, filename):
124
"""True if filename is the name of a control file in this tree.
126
:param filename: A filename within the tree. This is a relative path
127
from the root of this tree.
129
This is true IF and ONLY IF the filename is part of the meta data
130
that bzr controls in this tree. I.E. a random .bzr directory placed
131
on disk will not be a control file for this tree.
133
return self.bzrdir.is_control_filename(filename)
135
def iter_entries_by_dir(self):
136
"""Walk the tree in 'by_dir' order.
138
This will yield each entry in the tree as a (path, entry) tuple. The
139
order that they are yielded is: the contents of a directory are
140
preceeded by the parent of a directory, and all the contents of a
141
directory are grouped together.
143
return self.inventory.iter_entries_by_dir()
145
def kind(self, file_id):
146
raise NotImplementedError("subclasses must implement kind")
148
def _get_inventory(self):
149
return self._inventory
151
def get_file(self, file_id):
152
"""Return a file object for the file file_id in the tree."""
153
raise NotImplementedError(self.get_file)
155
def get_file_by_path(self, path):
156
return self.get_file(self._inventory.path2id(path))
158
inventory = property(_get_inventory,
159
doc="Inventory of this Tree")
161
def _check_retrieved(self, ie, f):
164
fp = fingerprint_file(f)
167
if ie.text_size is not None:
168
if ie.text_size != fp['size']:
169
raise BzrError("mismatched size for file %r in %r" % (ie.file_id, self._store),
170
["inventory expects %d bytes" % ie.text_size,
171
"file is actually %d bytes" % fp['size'],
172
"store is probably damaged/corrupt"])
174
if ie.text_sha1 != fp['sha1']:
175
raise BzrError("wrong SHA-1 for file %r in %r" % (ie.file_id, self._store),
176
["inventory expects %s" % ie.text_sha1,
177
"file is actually %s" % fp['sha1'],
178
"store is probably damaged/corrupt"])
180
def path2id(self, path):
181
"""Return the id for path in this tree."""
182
return self._inventory.path2id(path)
184
def print_file(self, file_id):
185
"""Print file with id `file_id` to stdout."""
187
sys.stdout.write(self.get_file_text(file_id))
193
"""What files are present in this tree and unknown.
195
:return: an iterator over the unknown files.
202
def filter_unversioned_files(self, paths):
203
"""Filter out paths that are not versioned.
205
:return: set of paths.
207
# NB: we specifically *don't* call self.has_filename, because for
208
# WorkingTrees that can indicate files that exist on disk but that
210
pred = self.inventory.has_filename
211
return set((p for p in paths if not pred(p)))
215
from bzrlib.revisiontree import RevisionTree
218
class EmptyTree(Tree):
221
self._inventory = Inventory(root_id=None)
222
warn('EmptyTree is deprecated as of bzr 0.9 please use '
223
'repository.revision_tree instead.',
224
DeprecationWarning, stacklevel=2)
226
def get_parent_ids(self):
229
def get_symlink_target(self, file_id):
232
def has_filename(self, filename):
235
def kind(self, file_id):
236
assert self._inventory[file_id].kind == "directory"
239
def list_files(self, include_root=False):
242
def __contains__(self, file_id):
243
return (file_id in self._inventory)
245
def get_file_sha1(self, file_id, path=None):
249
######################################################################
252
# TODO: Merge these two functions into a single one that can operate
253
# on either a whole tree or a set of files.
255
# TODO: Return the diff in order by filename, not by category or in
256
# random order. Can probably be done by lock-stepping through the
257
# filenames from both trees.
260
def file_status(filename, old_tree, new_tree):
261
"""Return single-letter status, old and new names for a file.
263
The complexity here is in deciding how to represent renames;
264
many complex cases are possible.
266
old_inv = old_tree.inventory
267
new_inv = new_tree.inventory
268
new_id = new_inv.path2id(filename)
269
old_id = old_inv.path2id(filename)
271
if not new_id and not old_id:
272
# easy: doesn't exist in either; not versioned at all
273
if new_tree.is_ignored(filename):
274
return 'I', None, None
276
return '?', None, None
278
# There is now a file of this name, great.
281
# There is no longer a file of this name, but we can describe
282
# what happened to the file that used to have
283
# this name. There are two possibilities: either it was
284
# deleted entirely, or renamed.
286
if new_inv.has_id(old_id):
287
return 'X', old_inv.id2path(old_id), new_inv.id2path(old_id)
289
return 'D', old_inv.id2path(old_id), None
291
# if the file_id is new in this revision, it is added
292
if new_id and not old_inv.has_id(new_id):
295
# if there used to be a file of this name, but that ID has now
296
# disappeared, it is deleted
297
if old_id and not new_inv.has_id(old_id):
304
def find_renames(old_inv, new_inv):
305
for file_id in old_inv:
306
if file_id not in new_inv:
308
old_name = old_inv.id2path(file_id)
309
new_name = new_inv.id2path(file_id)
310
if old_name != new_name:
311
yield (old_name, new_name)
314
def find_ids_across_trees(filenames, trees, require_versioned=True):
315
"""Find the ids corresponding to specified filenames.
317
All matches in all trees will be used, and all children of matched
318
directories will be used.
320
:param filenames: The filenames to find file_ids for
321
:param trees: The trees to find file_ids within
322
:param require_versioned: if true, all specified filenames must occur in
324
:return: a set of file ids for the specified filenames and their children.
328
specified_ids = _find_filename_ids_across_trees(filenames, trees,
330
return _find_children_across_trees(specified_ids, trees)
333
def _find_filename_ids_across_trees(filenames, trees, require_versioned):
334
"""Find the ids corresponding to specified filenames.
336
All matches in all trees will be used.
338
:param filenames: The filenames to find file_ids for
339
:param trees: The trees to find file_ids within
340
:param require_versioned: if true, all specified filenames must occur in
342
:return: a set of file ids for the specified filenames
345
interesting_ids = set()
346
for tree_path in filenames:
349
file_id = tree.inventory.path2id(tree_path)
350
if file_id is not None:
351
interesting_ids.add(file_id)
354
not_versioned.append(tree_path)
355
if len(not_versioned) > 0 and require_versioned:
356
raise errors.PathsNotVersionedError(not_versioned)
357
return interesting_ids
360
def _find_children_across_trees(specified_ids, trees):
361
"""Return a set including specified ids and their children
363
All matches in all trees will be used.
365
:param trees: The trees to find file_ids within
366
:return: a set containing all specified ids and their children
368
interesting_ids = set(specified_ids)
369
pending = interesting_ids
370
# now handle children of interesting ids
371
# we loop so that we handle all children of each id in both trees
372
while len(pending) > 0:
374
for file_id in pending:
376
if file_id not in tree:
378
entry = tree.inventory[file_id]
379
for child in getattr(entry, 'children', {}).itervalues():
380
if child.file_id not in interesting_ids:
381
new_pending.add(child.file_id)
382
interesting_ids.update(new_pending)
383
pending = new_pending
384
return interesting_ids
387
class InterTree(InterObject):
388
"""This class represents operations taking place between two Trees.
390
Its instances have methods like 'compare' and contain references to the
391
source and target trees these operations are to be carried out on.
393
clients of bzrlib should not need to use InterTree directly, rather they
394
should use the convenience methods on Tree such as 'Tree.compare()' which
395
will pass through to InterTree as appropriate.
401
def compare(self, want_unchanged=False, specific_files=None,
402
extra_trees=None, require_versioned=False, include_root=False):
403
"""Return the changes from source to target.
405
:return: A TreeDelta.
406
:param specific_files: An optional list of file paths to restrict the
407
comparison to. When mapping filenames to ids, all matches in all
408
trees (including optional extra_trees) are used, and all children of
409
matched directories are included.
410
:param want_unchanged: An optional boolean requesting the inclusion of
411
unchanged entries in the result.
412
:param extra_trees: An optional list of additional trees to use when
413
mapping the contents of specific_files (paths) to file_ids.
414
:param require_versioned: An optional boolean (defaults to False). When
415
supplied and True all the 'specific_files' must be versioned, or
416
a PathsNotVersionedError will be thrown.
418
# NB: show_status depends on being able to pass in non-versioned files and
419
# report them as unknown
420
trees = (self.source, self.target)
421
if extra_trees is not None:
422
trees = trees + tuple(extra_trees)
423
specific_file_ids = find_ids_across_trees(specific_files,
424
trees, require_versioned=require_versioned)
425
if specific_files and not specific_file_ids:
426
# All files are unversioned, so just return an empty delta
427
# _compare_trees would think we want a complete delta
428
return delta.TreeDelta()
429
return delta._compare_trees(self.source, self.target, want_unchanged,
430
specific_file_ids, include_root)
added
removed
bzrlib/tree.py
