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 is_control_filename(self, filename):
123
"""True if filename is the name of a control file in this tree.
125
:param filename: A filename within the tree. This is a relative path
126
from the root of this tree.
128
This is true IF and ONLY IF the filename is part of the meta data
129
that bzr controls in this tree. I.E. a random .bzr directory placed
130
on disk will not be a control file for this tree.
132
return self.bzrdir.is_control_filename(filename)
134
def iter_entries_by_dir(self):
135
"""Walk the tree in 'by_dir' order.
137
This will yield each entry in the tree as a (path, entry) tuple. The
138
order that they are yielded is: the contents of a directory are
139
preceeded by the parent of a directory, and all the contents of a
140
directory are grouped together.
142
return self.inventory.iter_entries_by_dir()
144
def kind(self, file_id):
145
raise NotImplementedError("subclasses must implement kind")
147
71
def _get_inventory(self):
148
72
return self._inventory
150
def get_file(self, file_id):
151
"""Return a file object for the file file_id in the tree."""
152
raise NotImplementedError(self.get_file)
154
def get_file_by_path(self, path):
155
return self.get_file(self._inventory.path2id(path))
157
74
inventory = property(_get_inventory,
158
75
doc="Inventory of this Tree")
160
77
def _check_retrieved(self, ie, f):
163
78
fp = fingerprint_file(f)
166
if ie.text_size is not None:
81
if ie.text_size != None:
167
82
if ie.text_size != fp['size']:
168
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),
169
84
["inventory expects %d bytes" % ie.text_size,
170
85
"file is actually %d bytes" % fp['size'],
171
86
"store is probably damaged/corrupt"])
173
88
if ie.text_sha1 != fp['sha1']:
174
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),
175
90
["inventory expects %s" % ie.text_sha1,
176
91
"file is actually %s" % fp['sha1'],
177
92
"store is probably damaged/corrupt"])
179
def path2id(self, path):
180
"""Return the id for path in this tree."""
181
return self._inventory.path2id(path)
183
def print_file(self, file_id):
184
"""Print file with id `file_id` to stdout."""
95
def print_file(self, fileid):
96
"""Print file with id `fileid` to stdout."""
186
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):
191
246
def unknowns(self):
192
"""What files are present in this tree and unknown.
194
:return: an iterator over the unknown files.
201
def filter_unversioned_files(self, paths):
202
"""Filter out paths that are not versioned.
204
:return: set of paths.
206
# NB: we specifically *don't* call self.has_filename, because for
207
# WorkingTrees that can indicate files that exist on disk but that
209
pred = self.inventory.has_filename
210
return set((p for p in paths if not pred(p)))
214
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
r"""Check whether the filename matches an ignore pattern.
309
Patterns containing '/' or '\' need to match the whole path;
310
others 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
317
# globbing stuff from cvs/rsync.
319
# XXX: fnmatch is actually not quite what we want: it's only
320
# approximately the same as real Unix fnmatch, and doesn't
321
# treat dotfiles correctly and allows * to match /.
322
# Eventually it should be replaced with something more
325
for pat in self.get_ignore_list():
326
if '/' in pat or '\\' in pat:
328
# as a special case, you can put ./ at the start of a
329
# pattern; this is good to match in the top-level
332
if (pat[:2] == './') or (pat[:2] == '.\\'):
336
if fnmatch.fnmatchcase(filename, newpat):
339
if fnmatch.fnmatchcase(splitpath(filename)[-1], pat):
347
class RevisionTree(Tree):
348
"""Tree viewing a previous revision.
350
File text can be retrieved from the text store.
352
TODO: Some kind of `__repr__` method, but a good one
353
probably means knowing the branch and revision number,
354
or at least passing a description to the constructor.
357
def __init__(self, store, inv):
359
self._inventory = inv
361
def get_file(self, file_id):
362
ie = self._inventory[file_id]
363
f = self._store[ie.text_id]
364
mutter(" get fileid{%s} from %r" % (file_id, self))
365
self._check_retrieved(ie, f)
368
def get_file_size(self, file_id):
369
return self._inventory[file_id].text_size
371
def get_file_sha1(self, file_id):
372
ie = self._inventory[file_id]
375
def has_filename(self, filename):
376
return bool(self.inventory.path2id(filename))
378
def list_files(self):
379
# The only files returned by this are those from the version
380
for path, entry in self.inventory.iter_entries():
381
yield path, 'V', entry.kind, entry.file_id
217
384
class EmptyTree(Tree):
219
385
def __init__(self):
220
386
self._inventory = Inventory()
221
warn('EmptyTree is deprecated as of bzr 0.9 please use '
222
'repository.revision_tree instead.',
223
DeprecationWarning, stacklevel=2)
225
def get_parent_ids(self):
228
def get_symlink_target(self, file_id):
231
388
def has_filename(self, filename):
234
def kind(self, file_id):
235
assert self._inventory[file_id].kind == "directory"
238
391
def list_files(self):
392
if False: # just to make it a generator
241
def __contains__(self, file_id):
242
return (file_id in self._inventory)
244
def get_file_sha1(self, file_id, path=None):
248
397
######################################################################
309
458
if old_name != new_name:
310
459
yield (old_name, new_name)
313
def find_ids_across_trees(filenames, trees, require_versioned=True):
314
"""Find the ids corresponding to specified filenames.
316
All matches in all trees will be used, and all children of matched
317
directories 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 and their children.
327
specified_ids = _find_filename_ids_across_trees(filenames, trees,
329
return _find_children_across_trees(specified_ids, trees)
332
def _find_filename_ids_across_trees(filenames, trees, require_versioned):
333
"""Find the ids corresponding to specified filenames.
335
All matches in all trees will be used.
337
:param filenames: The filenames to find file_ids for
338
:param trees: The trees to find file_ids within
339
:param require_versioned: if true, all specified filenames must occur in
341
:return: a set of file ids for the specified filenames
344
interesting_ids = set()
345
for tree_path in filenames:
348
file_id = tree.inventory.path2id(tree_path)
349
if file_id is not None:
350
interesting_ids.add(file_id)
353
not_versioned.append(tree_path)
354
if len(not_versioned) > 0 and require_versioned:
355
raise errors.PathsNotVersionedError(not_versioned)
356
return interesting_ids
359
def _find_children_across_trees(specified_ids, trees):
360
"""Return a set including specified ids and their children
362
All matches in all trees will be used.
364
:param trees: The trees to find file_ids within
365
:return: a set containing all specified ids and their children
367
interesting_ids = set(specified_ids)
368
pending = interesting_ids
369
# now handle children of interesting ids
370
# we loop so that we handle all children of each id in both trees
371
while len(pending) > 0:
373
for file_id in pending:
375
if file_id not in tree:
377
entry = tree.inventory[file_id]
378
for child in getattr(entry, 'children', {}).itervalues():
379
if child.file_id not in interesting_ids:
380
new_pending.add(child.file_id)
381
interesting_ids.update(new_pending)
382
pending = new_pending
383
return interesting_ids
386
class InterTree(InterObject):
387
"""This class represents operations taking place between two Trees.
389
Its instances have methods like 'compare' and contain references to the
390
source and target trees these operations are to be carried out on.
392
clients of bzrlib should not need to use InterTree directly, rather they
393
should use the convenience methods on Tree such as 'Tree.compare()' which
394
will pass through to InterTree as appropriate.
400
def compare(self, want_unchanged=False, specific_files=None,
401
extra_trees=None, require_versioned=False):
402
"""Return the changes from source to target.
404
:return: A TreeDelta.
405
:param specific_files: An optional list of file paths to restrict the
406
comparison to. When mapping filenames to ids, all matches in all
407
trees (including optional extra_trees) are used, and all children of
408
matched directories are included.
409
:param want_unchanged: An optional boolean requesting the inclusion of
410
unchanged entries in the result.
411
:param extra_trees: An optional list of additional trees to use when
412
mapping the contents of specific_files (paths) to file_ids.
413
:param require_versioned: An optional boolean (defaults to False). When
414
supplied and True all the 'specific_files' must be versioned, or
415
a PathsNotVersionedError will be thrown.
417
# NB: show_status depends on being able to pass in non-versioned files and
418
# report them as unknown
419
trees = (self.source, self.target)
420
if extra_trees is not None:
421
trees = trees + tuple(extra_trees)
422
specific_file_ids = find_ids_across_trees(specific_files,
423
trees, require_versioned=require_versioned)
424
if specific_files and not specific_file_ids:
425
# All files are unversioned, so just return an empty delta
426
# _compare_trees would think we want a complete delta
427
return delta.TreeDelta()
428
return delta._compare_trees(self.source, self.target, want_unchanged,
added
removed
bzrlib/tree.py
