106
61
def has_id(self, file_id):
107
62
return self.inventory.has_id(file_id)
109
__contains__ = has_id
111
def has_or_had_id(self, file_id):
112
if file_id == self.inventory.root.file_id:
114
return self.inventory.has_id(file_id)
117
return iter(self.inventory)
65
"""Return set of all ids in this tree."""
66
return self.inventory.id_set()
119
68
def id2path(self, file_id):
120
69
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()
132
def kind(self, file_id):
133
raise NotImplementedError("subclasses must implement kind")
135
71
def _get_inventory(self):
136
72
return self._inventory
138
def get_file_by_path(self, path):
139
return self.get_file(self._inventory.path2id(path))
141
74
inventory = property(_get_inventory,
142
75
doc="Inventory of this Tree")
144
77
def _check_retrieved(self, ie, f):
147
78
fp = fingerprint_file(f)
150
81
if ie.text_size != None:
151
82
if ie.text_size != fp['size']:
152
raise BzrError("mismatched size for file %r in %r" % (ie.file_id, self._store),
83
bailout("mismatched size for file %r in %r" % (ie.file_id, self._store),
153
84
["inventory expects %d bytes" % ie.text_size,
154
85
"file is actually %d bytes" % fp['size'],
155
86
"store is probably damaged/corrupt"])
157
88
if ie.text_sha1 != fp['sha1']:
158
raise BzrError("wrong SHA-1 for file %r in %r" % (ie.file_id, self._store),
89
bailout("wrong SHA-1 for file %r in %r" % (ie.file_id, self._store),
159
90
["inventory expects %s" % ie.text_sha1,
160
91
"file is actually %s" % fp['sha1'],
161
92
"store is probably damaged/corrupt"])
164
def print_file(self, file_id):
165
"""Print file with id `file_id` to stdout."""
95
def print_file(self, fileid):
96
"""Print file with id `fileid` to stdout."""
167
sys.stdout.write(self.get_file_text(file_id))
98
pumpfile(self.get_file(fileid), sys.stdout)
101
def export(self, dest):
102
"""Export this tree to a new directory.
104
`dest` should not exist, and will be created holding the
105
contents of this tree.
107
:todo: To handle subdirectories we need to create the
110
:note: If the export fails, the destination directory will be
111
left in a half-assed state.
114
mutter('export version %r' % self)
116
for dp, ie in inv.iter_entries():
118
fullpath = appendpath(dest, dp)
119
if kind == 'directory':
122
pumpfile(self.get_file(ie.file_id), file(fullpath, 'wb'))
124
bailout("don't know how to export {%s} of kind %r" % (fid, kind))
125
mutter(" export {%s} kind %s to %s" % (ie.file_id, kind, fullpath))
129
class WorkingTree(Tree):
130
"""Working copy tree.
132
The inventory is held in the `Branch` working-inventory, and the
133
files are in a directory on disk.
135
It is possible for a `WorkingTree` to have a filename which is
136
not listed in the Inventory and vice versa.
138
def __init__(self, basedir, inv):
139
self._inventory = inv
140
self.basedir = basedir
141
self.path2id = inv.path2id
144
return "<%s of %s>" % (self.__class__.__name__,
147
def abspath(self, filename):
148
return os.path.join(self.basedir, filename)
150
def has_filename(self, filename):
151
return os.path.exists(self.abspath(filename))
153
def get_file(self, file_id):
154
return self.get_file_byname(self.id2path(file_id))
156
def get_file_byname(self, filename):
157
return file(self.abspath(filename), 'rb')
159
def _get_store_filename(self, file_id):
160
## XXX: badly named; this isn't in the store at all
161
return self.abspath(self.id2path(file_id))
163
def has_id(self, file_id):
164
# files that have been deleted are excluded
165
if not self.inventory.has_id(file_id):
167
return os.access(self.abspath(self.inventory.id2path(file_id)), os.F_OK)
169
def get_file_size(self, file_id):
170
return os.stat(self._get_store_filename(file_id))[ST_SIZE]
172
def get_file_sha1(self, file_id):
173
f = self.get_file(file_id)
177
def file_class(self, filename):
178
if self.path2id(filename):
180
elif self.is_ignored(filename):
186
def list_files(self):
187
"""Recursively list all files as (path, class, kind, id).
189
Lists, but does not descend into unversioned directories.
191
This does not include files that have been deleted in this
194
Skips the control directory.
198
def descend(from_dir_relpath, from_dir_id, dp):
202
## TODO: If we find a subdirectory with its own .bzr
203
## directory, then that is a separate tree and we
204
## should exclude it.
205
if bzrlib.BZRDIR == f:
209
fp = appendpath(from_dir_relpath, f)
212
fap = appendpath(dp, f)
214
f_ie = inv.get_child(from_dir_id, f)
217
elif self.is_ignored(fp):
226
bailout("file %r entered as kind %r id %r, now of kind %r"
227
% (fap, f_ie.kind, f_ie.file_id, fk))
229
yield fp, c, fk, (f_ie and f_ie.file_id)
231
if fk != 'directory':
235
# don't descend unversioned directories
238
for ff in descend(fp, f_ie.file_id, fap):
241
for f in descend('', inv.root.file_id, self.basedir):
172
246
def unknowns(self):
173
"""What files are present in this tree and unknown.
175
:return: an iterator over the unknown files.
182
def filter_unversioned_files(self, paths):
183
"""Filter out paths that are not versioned.
185
:return: set of paths.
187
# NB: we specifically *don't* call self.has_filename, because for
188
# WorkingTrees that can indicate files that exist on disk but that
190
pred = self.inventory.has_filename
191
return set((p for p in paths if not pred(p)))
195
from bzrlib.revisiontree import RevisionTree
247
for subp in self.extras():
248
if not self.is_ignored(subp):
253
"""Yield all unknown files in this WorkingTree.
255
If there are any unknown directories then only the directory is
256
returned, not all its children. But if there are unknown files
257
under a versioned subdirectory, they are returned.
259
Currently returned depth-first, sorted by name within directories.
261
## TODO: Work from given directory downwards
263
for path, dir_entry in self.inventory.directories():
264
mutter("search for unknowns in %r" % path)
265
dirabs = self.abspath(path)
266
if not isdir(dirabs):
267
# e.g. directory deleted
271
for subf in os.listdir(dirabs):
273
and (subf not in dir_entry.children)):
278
subp = appendpath(path, subf)
282
def ignored_files(self):
283
"""Yield list of PATH, IGNORE_PATTERN"""
284
for subp in self.extras():
285
pat = self.is_ignored(subp)
290
def get_ignore_list(self):
291
"""Return list of ignore patterns.
293
Cached in the Tree object after the first call.
295
if hasattr(self, '_ignorelist'):
296
return self._ignorelist
298
l = bzrlib.DEFAULT_IGNORE[:]
299
if self.has_filename(bzrlib.IGNORE_FILENAME):
300
f = self.get_file_byname(bzrlib.IGNORE_FILENAME)
301
l.extend([line.rstrip("\n\r") for line in f.readlines()])
306
def is_ignored(self, filename):
307
"""Check whether the filename matches an ignore pattern.
309
Patterns containing '/' need to match the whole path; others
310
match against only the last component.
312
If the file is ignored, returns the pattern which caused it to
313
be ignored, otherwise None. So this can simply be used as a
314
boolean if desired."""
316
## TODO: Use '**' to match directories, and other extended globbing stuff from cvs/rsync.
318
for pat in self.get_ignore_list():
320
# as a special case, you can put ./ at the start of a pattern;
321
# this is good to match in the top-level only;
326
if fnmatch.fnmatchcase(filename, newpat):
329
if fnmatch.fnmatchcase(splitpath(filename)[-1], pat):
337
class RevisionTree(Tree):
338
"""Tree viewing a previous revision.
340
File text can be retrieved from the text store.
342
:todo: Some kind of `__repr__` method, but a good one
343
probably means knowing the branch and revision number,
344
or at least passing a description to the constructor.
347
def __init__(self, store, inv):
349
self._inventory = inv
351
def get_file(self, file_id):
352
ie = self._inventory[file_id]
353
f = self._store[ie.text_id]
354
mutter(" get fileid{%s} from %r" % (file_id, self))
355
self._check_retrieved(ie, f)
358
def get_file_size(self, file_id):
359
return self._inventory[file_id].text_size
361
def get_file_sha1(self, file_id):
362
ie = self._inventory[file_id]
365
def has_filename(self, filename):
366
return bool(self.inventory.path2id(filename))
368
def list_files(self):
369
# The only files returned by this are those from the version
370
for path, entry in self.inventory.iter_entries():
371
yield path, 'V', entry.kind, entry.file_id
198
374
class EmptyTree(Tree):
200
375
def __init__(self):
201
376
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):
209
def get_symlink_target(self, file_id):
212
378
def has_filename(self, filename):
215
def kind(self, file_id):
216
assert self._inventory[file_id].kind == "root_directory"
217
return "root_directory"
219
381
def list_files(self):
382
if False: # just to make it a generator
222
def __contains__(self, file_id):
223
return file_id in self._inventory
225
def get_file_sha1(self, file_id, path=None):
226
assert self._inventory[file_id].kind == "root_directory"
230
387
######################################################################
291
448
if old_name != new_name:
292
449
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,
added
removed
bzrlib/tree.py
