17
17
"""Tree classes, representing directory at point in time.
21
import os.path, os, fnmatch
23
from osutils import pumpfile, filesize, quotefn, sha_file, \
24
joinpath, splitpath, appendpath, isdir, isfile, file_kind, fingerprint_file
26
from stat import S_ISREG, S_ISDIR, ST_MODE, ST_SIZE
28
from inventory import Inventory
29
from trace import mutter, note
30
from errors import bailout
21
from cStringIO import StringIO
28
from bzrlib.decorators import needs_read_lock
29
from bzrlib.errors import BzrError, BzrCheckError
30
from bzrlib import errors
31
from bzrlib.inventory import Inventory
32
from bzrlib.inter import InterObject
33
from bzrlib.osutils import fingerprint_file
34
import bzrlib.revision
35
from bzrlib.trace import mutter, note
35
38
class Tree(object):
36
39
"""Abstract file tree.
54
55
trees or versioned trees.
58
def changes_from(self, other, want_unchanged=False, specific_files=None,
59
extra_trees=None, require_versioned=False, include_root=False):
60
"""Return a TreeDelta of the changes from other to this tree.
62
:param other: A tree to compare with.
63
:param specific_files: An optional list of file paths to restrict the
64
comparison to. When mapping filenames to ids, all matches in all
65
trees (including optional extra_trees) are used, and all children of
66
matched directories are included.
67
:param want_unchanged: An optional boolean requesting the inclusion of
68
unchanged entries in the result.
69
:param extra_trees: An optional list of additional trees to use when
70
mapping the contents of specific_files (paths) to file_ids.
71
:param require_versioned: An optional boolean (defaults to False). When
72
supplied and True all the 'specific_files' must be versioned, or
73
a PathsNotVersionedError will be thrown.
75
The comparison will be performed by an InterTree object looked up on
78
# Martin observes that Tree.changes_from returns a TreeDelta and this
79
# may confuse people, because the class name of the returned object is
80
# a synonym of the object referenced in the method name.
81
return InterTree.get(other, self).compare(
82
want_unchanged=want_unchanged,
83
specific_files=specific_files,
84
extra_trees=extra_trees,
85
require_versioned=require_versioned,
86
include_root=include_root
90
"""Get a list of the conflicts in the tree.
92
Each conflict is an instance of bzrlib.conflicts.Conflict.
96
def get_parent_ids(self):
97
"""Get the parent ids for this tree.
99
:return: a list of parent ids. [] is returned to indicate
100
a tree with no parents.
101
:raises: BzrError if the parents are not known.
103
raise NotImplementedError(self.get_parent_ids)
57
105
def has_filename(self, filename):
58
106
"""True if the tree has given filename."""
59
107
raise NotImplementedError()
64
112
__contains__ = has_id
114
def has_or_had_id(self, file_id):
115
if file_id == self.inventory.root.file_id:
117
return self.inventory.has_id(file_id)
66
119
def __iter__(self):
67
120
return iter(self.inventory)
69
122
def id2path(self, file_id):
70
123
return self.inventory.id2path(file_id)
125
def is_control_filename(self, filename):
126
"""True if filename is the name of a control file in this tree.
128
:param filename: A filename within the tree. This is a relative path
129
from the root of this tree.
131
This is true IF and ONLY IF the filename is part of the meta data
132
that bzr controls in this tree. I.E. a random .bzr directory placed
133
on disk will not be a control file for this tree.
135
return self.bzrdir.is_control_filename(filename)
137
def iter_entries_by_dir(self):
138
"""Walk the tree in 'by_dir' order.
140
This will yield each entry in the tree as a (path, entry) tuple. The
141
order that they are yielded is: the contents of a directory are
142
preceeded by the parent of a directory, and all the contents of a
143
directory are grouped together.
145
return self.inventory.iter_entries_by_dir()
147
def kind(self, file_id):
148
raise NotImplementedError("subclasses must implement kind")
72
150
def _get_inventory(self):
73
151
return self._inventory
153
def get_file(self, file_id):
154
"""Return a file object for the file file_id in the tree."""
155
raise NotImplementedError(self.get_file)
157
def get_file_by_path(self, path):
158
return self.get_file(self._inventory.path2id(path))
75
160
inventory = property(_get_inventory,
76
161
doc="Inventory of this Tree")
78
163
def _check_retrieved(self, ie, f):
79
166
fp = fingerprint_file(f)
82
if ie.text_size != None:
169
if ie.text_size is not None:
83
170
if ie.text_size != fp['size']:
84
bailout("mismatched size for file %r in %r" % (ie.file_id, self._store),
171
raise BzrError("mismatched size for file %r in %r" % (ie.file_id, self._store),
85
172
["inventory expects %d bytes" % ie.text_size,
86
173
"file is actually %d bytes" % fp['size'],
87
174
"store is probably damaged/corrupt"])
89
176
if ie.text_sha1 != fp['sha1']:
90
bailout("wrong SHA-1 for file %r in %r" % (ie.file_id, self._store),
177
raise BzrError("wrong SHA-1 for file %r in %r" % (ie.file_id, self._store),
91
178
["inventory expects %s" % ie.text_sha1,
92
179
"file is actually %s" % fp['sha1'],
93
180
"store is probably damaged/corrupt"])
182
def path2id(self, path):
183
"""Return the id for path in this tree."""
184
return self._inventory.path2id(path)
96
def print_file(self, fileid):
97
"""Print file with id `fileid` to stdout."""
186
def print_file(self, file_id):
187
"""Print file with id `file_id` to stdout."""
99
pumpfile(self.get_file(fileid), sys.stdout)
102
def export(self, dest):
103
"""Export this tree to a new directory.
105
`dest` should not exist, and will be created holding the
106
contents of this tree.
108
TODO: To handle subdirectories we need to create the
111
:note: If the export fails, the destination directory will be
112
left in a half-assed state.
115
mutter('export version %r' % self)
117
for dp, ie in inv.iter_entries():
119
fullpath = appendpath(dest, dp)
120
if kind == 'directory':
123
pumpfile(self.get_file(ie.file_id), file(fullpath, 'wb'))
125
bailout("don't know how to export {%s} of kind %r" % (ie.file_id, kind))
126
mutter(" export {%s} kind %s to %s" % (ie.file_id, kind, fullpath))
130
class RevisionTree(Tree):
131
"""Tree viewing a previous revision.
133
File text can be retrieved from the text store.
135
TODO: Some kind of `__repr__` method, but a good one
136
probably means knowing the branch and revision number,
137
or at least passing a description to the constructor.
140
def __init__(self, store, inv):
142
self._inventory = inv
144
def get_file(self, file_id):
145
ie = self._inventory[file_id]
146
f = self._store[ie.text_id]
147
mutter(" get fileid{%s} from %r" % (file_id, self))
148
self._check_retrieved(ie, f)
151
def get_file_size(self, file_id):
152
return self._inventory[file_id].text_size
154
def get_file_sha1(self, file_id):
155
ie = self._inventory[file_id]
158
def has_filename(self, filename):
159
return bool(self.inventory.path2id(filename))
161
def list_files(self):
162
# The only files returned by this are those from the version
163
for path, entry in self.inventory.iter_entries():
164
yield path, 'V', entry.kind, entry.file_id
189
sys.stdout.write(self.get_file_text(file_id))
195
"""What files are present in this tree and unknown.
197
:return: an iterator over the unknown files.
204
def filter_unversioned_files(self, paths):
205
"""Filter out paths that are not versioned.
207
:return: set of paths.
209
# NB: we specifically *don't* call self.has_filename, because for
210
# WorkingTrees that can indicate files that exist on disk but that
212
pred = self.inventory.has_filename
213
return set((p for p in paths if not pred(p)))
167
216
class EmptyTree(Tree):
168
218
def __init__(self):
169
self._inventory = Inventory()
219
self._inventory = Inventory(root_id=None)
220
symbol_versioning.warn('EmptyTree is deprecated as of bzr 0.9 please'
221
' use repository.revision_tree instead.',
222
DeprecationWarning, stacklevel=2)
224
def get_parent_ids(self):
227
def get_symlink_target(self, file_id):
171
230
def has_filename(self, filename):
174
def list_files(self):
175
if False: # just to make it a generator
233
def kind(self, file_id):
234
assert self._inventory[file_id].kind == "directory"
237
def list_files(self, include_root=False):
240
def __contains__(self, file_id):
241
return (file_id in self._inventory)
243
def get_file_sha1(self, file_id, path=None):
180
247
######################################################################
241
308
if old_name != new_name:
242
309
yield (old_name, new_name)
312
def find_ids_across_trees(filenames, trees, require_versioned=True):
313
"""Find the ids corresponding to specified filenames.
315
All matches in all trees will be used, and all children of matched
316
directories will be used.
318
:param filenames: The filenames to find file_ids for
319
:param trees: The trees to find file_ids within
320
:param require_versioned: if true, all specified filenames must occur in
322
:return: a set of file ids for the specified filenames and their children.
326
specified_ids = _find_filename_ids_across_trees(filenames, trees,
328
return _find_children_across_trees(specified_ids, trees)
331
def _find_filename_ids_across_trees(filenames, trees, require_versioned):
332
"""Find the ids corresponding to specified filenames.
334
All matches in all trees will be used.
336
:param filenames: The filenames to find file_ids for
337
:param trees: The trees to find file_ids within
338
:param require_versioned: if true, all specified filenames must occur in
340
:return: a set of file ids for the specified filenames
343
interesting_ids = set()
344
for tree_path in filenames:
347
file_id = tree.inventory.path2id(tree_path)
348
if file_id is not None:
349
interesting_ids.add(file_id)
352
not_versioned.append(tree_path)
353
if len(not_versioned) > 0 and require_versioned:
354
raise errors.PathsNotVersionedError(not_versioned)
355
return interesting_ids
358
def _find_children_across_trees(specified_ids, trees):
359
"""Return a set including specified ids and their children
361
All matches in all trees will be used.
363
:param trees: The trees to find file_ids within
364
:return: a set containing all specified ids and their children
366
interesting_ids = set(specified_ids)
367
pending = interesting_ids
368
# now handle children of interesting ids
369
# we loop so that we handle all children of each id in both trees
370
while len(pending) > 0:
372
for file_id in pending:
374
if file_id not in tree:
376
entry = tree.inventory[file_id]
377
for child in getattr(entry, 'children', {}).itervalues():
378
if child.file_id not in interesting_ids:
379
new_pending.add(child.file_id)
380
interesting_ids.update(new_pending)
381
pending = new_pending
382
return interesting_ids
385
class InterTree(InterObject):
386
"""This class represents operations taking place between two Trees.
388
Its instances have methods like 'compare' and contain references to the
389
source and target trees these operations are to be carried out on.
391
clients of bzrlib should not need to use InterTree directly, rather they
392
should use the convenience methods on Tree such as 'Tree.compare()' which
393
will pass through to InterTree as appropriate.
399
def compare(self, want_unchanged=False, specific_files=None,
400
extra_trees=None, require_versioned=False, include_root=False):
401
"""Return the changes from source to target.
403
:return: A TreeDelta.
404
:param specific_files: An optional list of file paths to restrict the
405
comparison to. When mapping filenames to ids, all matches in all
406
trees (including optional extra_trees) are used, and all children of
407
matched directories are included.
408
:param want_unchanged: An optional boolean requesting the inclusion of
409
unchanged entries in the result.
410
:param extra_trees: An optional list of additional trees to use when
411
mapping the contents of specific_files (paths) to file_ids.
412
:param require_versioned: An optional boolean (defaults to False). When
413
supplied and True all the 'specific_files' must be versioned, or
414
a PathsNotVersionedError will be thrown.
416
# NB: show_status depends on being able to pass in non-versioned files and
417
# report them as unknown
418
trees = (self.source, self.target)
419
if extra_trees is not None:
420
trees = trees + tuple(extra_trees)
421
specific_file_ids = find_ids_across_trees(specific_files,
422
trees, require_versioned=require_versioned)
423
if specific_files and not specific_file_ids:
424
# All files are unversioned, so just return an empty delta
425
# _compare_trees would think we want a complete delta
426
return delta.TreeDelta()
427
return delta._compare_trees(self.source, self.target, want_unchanged,
428
specific_file_ids, include_root)
431
# This was deprecated before 0.12, but did not have an official warning
432
@symbol_versioning.deprecated_function(symbol_versioning.zero_twelve)
433
def RevisionTree(*args, **kwargs):
434
"""RevisionTree has moved to bzrlib.revisiontree.RevisionTree()
436
Accessing it as bzrlib.tree.RevisionTree has been deprecated as of
439
from bzrlib.revisiontree import RevisionTree as _RevisionTree
440
return _RevisionTree(*args, **kwargs)
added
removed
bzrlib/tree.py
