1
# Copyright (C) 2005-2011 Canonical Ltd
1
# Copyright (C) 2005 Canonical Ltd
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
5
5
# the Free Software Foundation; either version 2 of the License, or
6
6
# (at your option) any later version.
8
8
# This program is distributed in the hope that it will be useful,
9
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
11
# GNU General Public License for more details.
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17
17
"""Tree classes, representing directory at point in time.
22
from bzrlib.lazy_import import lazy_import
23
lazy_import(globals(), """
27
conflicts as _mod_conflicts,
34
revision as _mod_revision,
40
from bzrlib.decorators import needs_read_lock
41
from bzrlib.inter import InterObject
42
from bzrlib.symbol_versioning import (
21
import os.path, os, fnmatch
23
from osutils import pumpfile, compare_files, 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
49
36
"""Abstract file tree.
51
38
There are several subclasses:
53
40
* `WorkingTree` exists as files on disk editable by the user.
55
42
* `RevisionTree` is a tree as recorded at some point in the past.
46
Trees contain an `Inventory` object, and also know how to retrieve
47
file texts mentioned in the inventory, either from a working
48
directory or from a store.
50
It is possible for trees to contain files that are not described
51
in their inventory or vice versa; for this use `filenames()`.
57
53
Trees can be compared, etc, regardless of whether they are working
58
54
trees or versioned trees.
61
def changes_from(self, other, want_unchanged=False, specific_files=None,
62
extra_trees=None, require_versioned=False, include_root=False,
63
want_unversioned=False):
64
"""Return a TreeDelta of the changes from other to this tree.
66
:param other: A tree to compare with.
67
:param specific_files: An optional list of file paths to restrict the
68
comparison to. When mapping filenames to ids, all matches in all
69
trees (including optional extra_trees) are used, and all children of
70
matched directories are included.
71
:param want_unchanged: An optional boolean requesting the inclusion of
72
unchanged entries in the result.
73
:param extra_trees: An optional list of additional trees to use when
74
mapping the contents of specific_files (paths) to file_ids.
75
:param require_versioned: An optional boolean (defaults to False). When
76
supplied and True all the 'specific_files' must be versioned, or
77
a PathsNotVersionedError will be thrown.
78
:param want_unversioned: Scan for unversioned paths.
80
The comparison will be performed by an InterTree object looked up on
83
# Martin observes that Tree.changes_from returns a TreeDelta and this
84
# may confuse people, because the class name of the returned object is
85
# a synonym of the object referenced in the method name.
86
return InterTree.get(other, self).compare(
87
want_unchanged=want_unchanged,
88
specific_files=specific_files,
89
extra_trees=extra_trees,
90
require_versioned=require_versioned,
91
include_root=include_root,
92
want_unversioned=want_unversioned,
95
def iter_changes(self, from_tree, include_unchanged=False,
96
specific_files=None, pb=None, extra_trees=None,
97
require_versioned=True, want_unversioned=False):
98
"""See InterTree.iter_changes"""
99
intertree = InterTree.get(from_tree, self)
100
return intertree.iter_changes(include_unchanged, specific_files, pb,
101
extra_trees, require_versioned, want_unversioned=want_unversioned)
104
"""Get a list of the conflicts in the tree.
106
Each conflict is an instance of bzrlib.conflicts.Conflict.
108
return _mod_conflicts.ConflictList()
111
"""For trees that can have unversioned files, return all such paths."""
114
def get_parent_ids(self):
115
"""Get the parent ids for this tree.
117
:return: a list of parent ids. [] is returned to indicate
118
a tree with no parents.
119
:raises: BzrError if the parents are not known.
121
raise NotImplementedError(self.get_parent_ids)
123
57
def has_filename(self, filename):
124
58
"""True if the tree has given filename."""
125
raise NotImplementedError(self.has_filename)
59
raise NotImplementedError()
127
61
def has_id(self, file_id):
128
raise NotImplementedError(self.has_id)
130
def __contains__(self, file_id):
131
return self.has_id(file_id)
133
def has_or_had_id(self, file_id):
134
raise NotImplementedError(self.has_or_had_id)
136
def is_ignored(self, filename):
137
"""Check whether the filename is ignored by this tree.
139
:param filename: The relative filename within the tree.
140
:return: True if the filename is ignored.
144
def all_file_ids(self):
145
"""Iterate through all file ids, including ids for missing files."""
146
raise NotImplementedError(self.all_file_ids)
62
return self.inventory.has_id(file_id)
65
"""Return set of all ids in this tree."""
66
return self.inventory.id_set()
148
68
def id2path(self, file_id):
149
"""Return the path for a file id.
153
raise NotImplementedError(self.id2path)
155
def iter_entries_by_dir(self, specific_file_ids=None, yield_parents=False):
156
"""Walk the tree in 'by_dir' order.
158
This will yield each entry in the tree as a (path, entry) tuple.
159
The order that they are yielded is:
161
Directories are walked in a depth-first lexicographical order,
162
however, whenever a directory is reached, all of its direct child
163
nodes are yielded in lexicographical order before yielding the
166
For example, in the tree::
176
The yield order (ignoring root) would be::
177
a, f, a/b, a/d, a/b/c, a/d/e, f/g
179
:param yield_parents: If True, yield the parents from the root leading
180
down to specific_file_ids that have been requested. This has no
181
impact if specific_file_ids is None.
183
raise NotImplementedError(self.iter_entries_by_dir)
185
def list_files(self, include_root=False, from_dir=None, recursive=True):
186
"""List all files in this tree.
188
:param include_root: Whether to include the entry for the tree root
189
:param from_dir: Directory under which to list files
190
:param recursive: Whether to list files recursively
191
:return: iterator over tuples of (path, versioned, kind, file_id,
194
raise NotImplementedError(self.list_files)
196
def iter_references(self):
197
if self.supports_tree_reference():
198
for path, entry in self.iter_entries_by_dir():
199
if entry.kind == 'tree-reference':
200
yield path, entry.file_id
202
def kind(self, file_id):
203
raise NotImplementedError("Tree subclass %s must implement kind"
204
% self.__class__.__name__)
206
def stored_kind(self, file_id):
207
"""File kind stored for this file_id.
209
May not match kind on disk for working trees. Always available
210
for versioned files, even when the file itself is missing.
212
return self.kind(file_id)
214
def path_content_summary(self, path):
215
"""Get a summary of the information about path.
217
All the attributes returned are for the canonical form, not the
218
convenient form (if content filters are in use.)
220
:param path: A relative path within the tree.
221
:return: A tuple containing kind, size, exec, sha1-or-link.
222
Kind is always present (see tree.kind()).
223
size is present if kind is file and the size of the
224
canonical form can be cheaply determined, None otherwise.
225
exec is None unless kind is file and the platform supports the 'x'
227
sha1-or-link is the link target if kind is symlink, or the sha1 if
228
it can be obtained without reading the file.
230
raise NotImplementedError(self.path_content_summary)
232
def get_reference_revision(self, file_id, path=None):
233
raise NotImplementedError("Tree subclass %s must implement "
234
"get_reference_revision"
235
% self.__class__.__name__)
237
def _comparison_data(self, entry, path):
238
"""Return a tuple of kind, executable, stat_value for a file.
240
entry may be None if there is no inventory entry for the file, but
241
path must always be supplied.
243
kind is None if there is no file present (even if an inventory id is
244
present). executable is False for non-file entries.
246
raise NotImplementedError(self._comparison_data)
248
def _file_size(self, entry, stat_value):
249
raise NotImplementedError(self._file_size)
251
def get_file(self, file_id, path=None):
252
"""Return a file object for the file file_id in the tree.
254
If both file_id and path are defined, it is implementation defined as
255
to which one is used.
257
raise NotImplementedError(self.get_file)
259
def get_file_with_stat(self, file_id, path=None):
260
"""Get a file handle and stat object for file_id.
262
The default implementation returns (self.get_file, None) for backwards
265
:param file_id: The file id to read.
266
:param path: The path of the file, if it is known.
267
:return: A tuple (file_handle, stat_value_or_None). If the tree has
268
no stat facility, or need for a stat cache feedback during commit,
269
it may return None for the second element of the tuple.
271
return (self.get_file(file_id, path), None)
273
def get_file_text(self, file_id, path=None):
274
"""Return the byte content of a file.
276
:param file_id: The file_id of the file.
277
:param path: The path of the file.
278
If both file_id and path are supplied, an implementation may use
281
my_file = self.get_file(file_id, path)
283
return my_file.read()
287
def get_file_lines(self, file_id, path=None):
288
"""Return the content of a file, as lines.
290
:param file_id: The file_id of the file.
291
:param path: The path of the file.
292
If both file_id and path are supplied, an implementation may use
295
return osutils.split_lines(self.get_file_text(file_id, path))
297
def get_file_sha1(self, file_id, path=None):
298
"""Return the SHA1 file for a file.
300
:param file_id: The handle for this file.
301
:param path: The path that this file can be found at.
302
These must point to the same object.
304
raise NotImplementedError(self.get_file_sha1)
306
def get_file_mtime(self, file_id, path=None):
307
"""Return the modification time for a file.
309
:param file_id: The handle for this file.
310
:param path: The path that this file can be found at.
311
These must point to the same object.
313
raise NotImplementedError(self.get_file_mtime)
315
def get_file_size(self, file_id):
316
"""Return the size of a file in bytes.
318
This applies only to regular files. If invoked on directories or
319
symlinks, it will return None.
320
:param file_id: The file-id of the file
322
raise NotImplementedError(self.get_file_size)
324
def get_file_by_path(self, path):
325
raise NotImplementedError(self.get_file_by_path)
327
def is_executable(self, file_id, path=None):
328
"""Check if a file is executable.
330
:param file_id: The handle for this file.
331
:param path: The path that this file can be found at.
332
These must point to the same object.
334
raise NotImplementedError(self.is_executable)
336
def iter_files_bytes(self, desired_files):
337
"""Iterate through file contents.
339
Files will not necessarily be returned in the order they occur in
340
desired_files. No specific order is guaranteed.
342
Yields pairs of identifier, bytes_iterator. identifier is an opaque
343
value supplied by the caller as part of desired_files. It should
344
uniquely identify the file version in the caller's context. (Examples:
345
an index number or a TreeTransform trans_id.)
347
bytes_iterator is an iterable of bytestrings for the file. The
348
kind of iterable and length of the bytestrings are unspecified, but for
349
this implementation, it is a tuple containing a single bytestring with
350
the complete text of the file.
352
:param desired_files: a list of (file_id, identifier) pairs
354
for file_id, identifier in desired_files:
355
# We wrap the string in a tuple so that we can return an iterable
356
# of bytestrings. (Technically, a bytestring is also an iterable
357
# of bytestrings, but iterating through each character is not
359
cur_file = (self.get_file_text(file_id),)
360
yield identifier, cur_file
362
def get_symlink_target(self, file_id):
363
"""Get the target for a given file_id.
365
It is assumed that the caller already knows that file_id is referencing
367
:param file_id: Handle for the symlink entry.
368
:return: The path the symlink points to.
370
raise NotImplementedError(self.get_symlink_target)
373
def get_root_id(self):
374
"""Return the file_id for the root of this tree."""
375
raise NotImplementedError(self.get_root_id)
377
def annotate_iter(self, file_id,
378
default_revision=_mod_revision.CURRENT_REVISION):
379
"""Return an iterator of revision_id, line tuples.
381
For working trees (and mutable trees in general), the special
382
revision_id 'current:' will be used for lines that are new in this
383
tree, e.g. uncommitted changes.
384
:param file_id: The file to produce an annotated version from
385
:param default_revision: For lines that don't match a basis, mark them
386
with this revision id. Not all implementations will make use of
389
raise NotImplementedError(self.annotate_iter)
391
def _get_plan_merge_data(self, file_id, other, base):
392
from bzrlib import versionedfile
393
vf = versionedfile._PlanMergeVersionedFile(file_id)
394
last_revision_a = self._get_file_revision(file_id, vf, 'this:')
395
last_revision_b = other._get_file_revision(file_id, vf, 'other:')
397
last_revision_base = None
399
last_revision_base = base._get_file_revision(file_id, vf, 'base:')
400
return vf, last_revision_a, last_revision_b, last_revision_base
402
def plan_file_merge(self, file_id, other, base=None):
403
"""Generate a merge plan based on annotations.
405
If the file contains uncommitted changes in this tree, they will be
406
attributed to the 'current:' pseudo-revision. If the file contains
407
uncommitted changes in the other tree, they will be assigned to the
408
'other:' pseudo-revision.
410
data = self._get_plan_merge_data(file_id, other, base)
411
vf, last_revision_a, last_revision_b, last_revision_base = data
412
return vf.plan_merge(last_revision_a, last_revision_b,
415
def plan_file_lca_merge(self, file_id, other, base=None):
416
"""Generate a merge plan based lca-newness.
418
If the file contains uncommitted changes in this tree, they will be
419
attributed to the 'current:' pseudo-revision. If the file contains
420
uncommitted changes in the other tree, they will be assigned to the
421
'other:' pseudo-revision.
423
data = self._get_plan_merge_data(file_id, other, base)
424
vf, last_revision_a, last_revision_b, last_revision_base = data
425
return vf.plan_lca_merge(last_revision_a, last_revision_b,
428
def _iter_parent_trees(self):
429
"""Iterate through parent trees, defaulting to Tree.revision_tree."""
430
for revision_id in self.get_parent_ids():
432
yield self.revision_tree(revision_id)
433
except errors.NoSuchRevisionInTree:
434
yield self.repository.revision_tree(revision_id)
436
def _get_file_revision(self, file_id, vf, tree_revision):
437
"""Ensure that file_id, tree_revision is in vf to plan the merge."""
439
if getattr(self, '_repository', None) is None:
440
last_revision = tree_revision
441
parent_keys = [(file_id, t.get_file_revision(file_id)) for t in
442
self._iter_parent_trees()]
443
vf.add_lines((file_id, last_revision), parent_keys,
444
self.get_file_lines(file_id))
445
repo = self.branch.repository
448
last_revision = self.get_file_revision(file_id)
449
base_vf = self._repository.texts
450
if base_vf not in vf.fallback_versionedfiles:
451
vf.fallback_versionedfiles.append(base_vf)
69
return self.inventory.id2path(file_id)
71
def _get_inventory(self):
72
return self._inventory
74
inventory = property(_get_inventory,
75
doc="Inventory of this Tree")
454
77
def _check_retrieved(self, ie, f):
457
fp = osutils.fingerprint_file(f)
78
fp = fingerprint_file(f)
460
if ie.text_size is not None:
81
if ie.text_size != None:
461
82
if ie.text_size != fp['size']:
462
raise errors.BzrError(
463
"mismatched size for file %r in %r" %
464
(ie.file_id, self._store),
83
bailout("mismatched size for file %r in %r" % (ie.file_id, self._store),
465
84
["inventory expects %d bytes" % ie.text_size,
466
85
"file is actually %d bytes" % fp['size'],
467
86
"store is probably damaged/corrupt"])
469
88
if ie.text_sha1 != fp['sha1']:
470
raise errors.BzrError("wrong SHA-1 for file %r in %r" %
471
(ie.file_id, self._store),
89
bailout("wrong SHA-1 for file %r in %r" % (ie.file_id, self._store),
472
90
["inventory expects %s" % ie.text_sha1,
473
91
"file is actually %s" % fp['sha1'],
474
92
"store is probably damaged/corrupt"])
476
def path2id(self, path):
477
"""Return the id for path in this tree."""
478
raise NotImplementedError(self.path2id)
480
def paths2ids(self, paths, trees=[], require_versioned=True):
481
"""Return all the ids that can be reached by walking from paths.
483
Each path is looked up in this tree and any extras provided in
484
trees, and this is repeated recursively: the children in an extra tree
485
of a directory that has been renamed under a provided path in this tree
486
are all returned, even if none exist under a provided path in this
487
tree, and vice versa.
489
:param paths: An iterable of paths to start converting to ids from.
490
Alternatively, if paths is None, no ids should be calculated and None
491
will be returned. This is offered to make calling the api unconditional
492
for code that *might* take a list of files.
493
:param trees: Additional trees to consider.
494
:param require_versioned: If False, do not raise NotVersionedError if
495
an element of paths is not versioned in this tree and all of trees.
497
return find_ids_across_trees(paths, [self] + list(trees), require_versioned)
499
def iter_children(self, file_id):
500
entry = self.iter_entries_by_dir([file_id]).next()[1]
501
for child in getattr(entry, 'children', {}).itervalues():
505
"""Lock this tree for multiple read only operations.
507
:return: A bzrlib.lock.LogicalLockResult.
511
def revision_tree(self, revision_id):
512
"""Obtain a revision tree for the revision revision_id.
514
The intention of this method is to allow access to possibly cached
515
tree data. Implementors of this method should raise NoSuchRevision if
516
the tree is not locally available, even if they could obtain the
517
tree via a repository or some other means. Callers are responsible
518
for finding the ultimate source for a revision tree.
520
:param revision_id: The revision_id of the requested tree.
522
:raises: NoSuchRevision if the tree cannot be obtained.
524
raise errors.NoSuchRevisionInTree(self, revision_id)
95
def print_file(self, fileid):
96
"""Print file with id `fileid` to stdout."""
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):
526
246
def unknowns(self):
527
"""What files are present in this tree and unknown.
529
:return: an iterator over the unknown files.
536
def filter_unversioned_files(self, paths):
537
"""Filter out paths that are versioned.
539
:return: set of paths.
541
raise NotImplementedError(self.filter_unversioned_files)
543
def walkdirs(self, prefix=""):
544
"""Walk the contents of this tree from path down.
546
This yields all the data about the contents of a directory at a time.
547
After each directory has been yielded, if the caller has mutated the
548
list to exclude some directories, they are then not descended into.
550
The data yielded is of the form:
551
((directory-relpath, directory-path-from-root, directory-fileid),
552
[(relpath, basename, kind, lstat, path_from_tree_root, file_id,
553
versioned_kind), ...]),
554
- directory-relpath is the containing dirs relpath from prefix
555
- directory-path-from-root is the containing dirs path from /
556
- directory-fileid is the id of the directory if it is versioned.
557
- relpath is the relative path within the subtree being walked.
558
- basename is the basename
559
- kind is the kind of the file now. If unknonwn then the file is not
560
present within the tree - but it may be recorded as versioned. See
562
- lstat is the stat data *if* the file was statted.
563
- path_from_tree_root is the path from the root of the tree.
564
- file_id is the file_id if the entry is versioned.
565
- versioned_kind is the kind of the file as last recorded in the
566
versioning system. If 'unknown' the file is not versioned.
567
One of 'kind' and 'versioned_kind' must not be 'unknown'.
569
:param prefix: Start walking from prefix within the tree rather than
570
at the root. This allows one to walk a subtree but get paths that are
571
relative to a tree rooted higher up.
572
:return: an iterator over the directory data.
574
raise NotImplementedError(self.walkdirs)
576
def supports_content_filtering(self):
579
def _content_filter_stack(self, path=None, file_id=None):
580
"""The stack of content filters for a path if filtering is supported.
582
Readers will be applied in first-to-last order.
583
Writers will be applied in last-to-first order.
584
Either the path or the file-id needs to be provided.
586
:param path: path relative to the root of the tree
588
:param file_id: file_id or None if unknown
589
:return: the list of filters - [] if there are none
591
filter_pref_names = filters._get_registered_names()
592
if len(filter_pref_names) == 0:
595
path = self.id2path(file_id)
596
prefs = self.iter_search_rules([path], filter_pref_names).next()
597
stk = filters._get_filter_stack_for(prefs)
598
if 'filters' in debug.debug_flags:
599
trace.note("*** %s content-filter: %s => %r" % (path,prefs,stk))
602
def _content_filter_stack_provider(self):
603
"""A function that returns a stack of ContentFilters.
605
The function takes a path (relative to the top of the tree) and a
606
file-id as parameters.
608
:return: None if content filtering is not supported by this tree.
610
if self.supports_content_filtering():
611
return lambda path, file_id: \
612
self._content_filter_stack(path, file_id)
616
def iter_search_rules(self, path_names, pref_names=None,
617
_default_searcher=None):
618
"""Find the preferences for filenames in a tree.
620
:param path_names: an iterable of paths to find attributes for.
621
Paths are given relative to the root of the tree.
622
:param pref_names: the list of preferences to lookup - None for all
623
:param _default_searcher: private parameter to assist testing - don't use
624
:return: an iterator of tuple sequences, one per path-name.
625
See _RulesSearcher.get_items for details on the tuple sequence.
627
if _default_searcher is None:
628
_default_searcher = rules._per_user_searcher
629
searcher = self._get_rules_searcher(_default_searcher)
630
if searcher is not None:
631
if pref_names is not None:
632
for path in path_names:
633
yield searcher.get_selected_items(path, pref_names)
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):
635
for path in path_names:
636
yield searcher.get_items(path)
638
def _get_rules_searcher(self, default_searcher):
639
"""Get the RulesSearcher for this tree given the default one."""
640
searcher = default_searcher
644
class InventoryTree(Tree):
645
"""A tree that relies on an inventory for its metadata.
647
Trees contain an `Inventory` object, and also know how to retrieve
648
file texts mentioned in the inventory, either from a working
649
directory or from a store.
651
It is possible for trees to contain files that are not described
652
in their inventory or vice versa; for this use `filenames()`.
654
Subclasses should set the _inventory attribute, which is considered
655
private to external API users.
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.
658
def get_canonical_inventory_paths(self, paths):
659
"""Like get_canonical_inventory_path() but works on multiple items.
661
:param paths: A sequence of paths relative to the root of the tree.
662
:return: A list of paths, with each item the corresponding input path
663
adjusted to account for existing elements that match case
666
return list(self._yield_canonical_inventory_paths(paths))
668
def get_canonical_inventory_path(self, path):
669
"""Returns the first inventory item that case-insensitively matches path.
671
If a path matches exactly, it is returned. If no path matches exactly
672
but more than one path matches case-insensitively, it is implementation
673
defined which is returned.
675
If no path matches case-insensitively, the input path is returned, but
676
with as many path entries that do exist changed to their canonical
679
If you need to resolve many names from the same tree, you should
680
use get_canonical_inventory_paths() to avoid O(N) behaviour.
682
:param path: A paths relative to the root of the tree.
683
:return: The input path adjusted to account for existing elements
684
that match case insensitively.
686
return self._yield_canonical_inventory_paths([path]).next()
688
def _yield_canonical_inventory_paths(self, paths):
690
# First, if the path as specified exists exactly, just use it.
691
if self.path2id(path) is not None:
695
cur_id = self.get_root_id()
697
bit_iter = iter(path.split("/"))
701
for child in self.iter_children(cur_id):
703
# XXX: it seem like if the child is known to be in the
704
# tree, we shouldn't need to go from its id back to
705
# its path -- mbp 2010-02-11
707
# XXX: it seems like we could be more efficient
708
# by just directly looking up the original name and
709
# only then searching all children; also by not
710
# chopping paths so much. -- mbp 2010-02-11
711
child_base = os.path.basename(self.id2path(child))
712
if (child_base == elt):
713
# if we found an exact match, we can stop now; if
714
# we found an approximate match we need to keep
715
# searching because there might be an exact match
718
new_path = osutils.pathjoin(cur_path, child_base)
720
elif child_base.lower() == lelt:
722
new_path = osutils.pathjoin(cur_path, child_base)
723
except errors.NoSuchId:
724
# before a change is committed we can see this error...
729
# got to the end of this directory and no entries matched.
730
# Return what matched so far, plus the rest as specified.
731
cur_path = osutils.pathjoin(cur_path, elt, *list(bit_iter))
736
def _get_inventory(self):
737
return self._inventory
739
inventory = property(_get_inventory,
740
doc="Inventory of this Tree")
743
def path2id(self, path):
744
"""Return the id for path in this tree."""
745
return self._inventory.path2id(path)
747
def id2path(self, file_id):
748
"""Return the path for a file id.
752
return self.inventory.id2path(file_id)
754
def has_id(self, file_id):
755
return self.inventory.has_id(file_id)
757
def has_or_had_id(self, file_id):
758
return self.inventory.has_id(file_id)
760
def all_file_ids(self):
761
return set(self.inventory)
763
@deprecated_method(deprecated_in((2, 4, 0)))
765
return iter(self.inventory)
767
def filter_unversioned_files(self, paths):
768
"""Filter out paths that are versioned.
770
:return: set of paths.
772
# NB: we specifically *don't* call self.has_filename, because for
773
# WorkingTrees that can indicate files that exist on disk but that
775
pred = self.inventory.has_filename
776
return set((p for p in paths if not pred(p)))
779
def iter_entries_by_dir(self, specific_file_ids=None, yield_parents=False):
780
"""Walk the tree in 'by_dir' order.
782
This will yield each entry in the tree as a (path, entry) tuple.
783
The order that they are yielded is:
785
See Tree.iter_entries_by_dir for details.
787
:param yield_parents: If True, yield the parents from the root leading
788
down to specific_file_ids that have been requested. This has no
789
impact if specific_file_ids is None.
791
return self.inventory.iter_entries_by_dir(
792
specific_file_ids=specific_file_ids, yield_parents=yield_parents)
794
def get_file_by_path(self, path):
795
return self.get_file(self._inventory.path2id(path), path)
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
384
class EmptyTree(Tree):
386
self._inventory = Inventory()
388
def has_filename(self, filename):
391
def list_files(self):
392
if False: # just to make it a generator
798
397
######################################################################
851
def find_ids_across_trees(filenames, trees, require_versioned=True):
852
"""Find the ids corresponding to specified filenames.
854
All matches in all trees will be used, and all children of matched
855
directories will be used.
857
:param filenames: The filenames to find file_ids for (if None, returns
859
:param trees: The trees to find file_ids within
860
:param require_versioned: if true, all specified filenames must occur in
862
:return: a set of file ids for the specified filenames and their children.
866
specified_path_ids = _find_ids_across_trees(filenames, trees,
868
return _find_children_across_trees(specified_path_ids, trees)
871
def _find_ids_across_trees(filenames, trees, require_versioned):
872
"""Find the ids corresponding to specified filenames.
874
All matches in all trees will be used, but subdirectories are not scanned.
876
:param filenames: The filenames to find file_ids for
877
:param trees: The trees to find file_ids within
878
:param require_versioned: if true, all specified filenames must occur in
880
:return: a set of file ids for the specified filenames
883
interesting_ids = set()
884
for tree_path in filenames:
887
file_id = tree.path2id(tree_path)
888
if file_id is not None:
889
interesting_ids.add(file_id)
892
not_versioned.append(tree_path)
893
if len(not_versioned) > 0 and require_versioned:
894
raise errors.PathsNotVersionedError(not_versioned)
895
return interesting_ids
898
def _find_children_across_trees(specified_ids, trees):
899
"""Return a set including specified ids and their children.
901
All matches in all trees will be used.
903
:param trees: The trees to find file_ids within
904
:return: a set containing all specified ids and their children
906
interesting_ids = set(specified_ids)
907
pending = interesting_ids
908
# now handle children of interesting ids
909
# we loop so that we handle all children of each id in both trees
910
while len(pending) > 0:
912
for file_id in pending:
914
if not tree.has_or_had_id(file_id):
916
for child_id in tree.iter_children(file_id):
917
if child_id not in interesting_ids:
918
new_pending.add(child_id)
919
interesting_ids.update(new_pending)
920
pending = new_pending
921
return interesting_ids
924
class InterTree(InterObject):
925
"""This class represents operations taking place between two Trees.
927
Its instances have methods like 'compare' and contain references to the
928
source and target trees these operations are to be carried out on.
930
Clients of bzrlib should not need to use InterTree directly, rather they
931
should use the convenience methods on Tree such as 'Tree.compare()' which
932
will pass through to InterTree as appropriate.
935
# Formats that will be used to test this InterTree. If both are
936
# None, this InterTree will not be tested (e.g. because a complex
938
_matching_from_tree_format = None
939
_matching_to_tree_format = None
944
def is_compatible(kls, source, target):
945
# The default implementation is naive and uses the public API, so
946
# it works for all trees.
949
def _changes_from_entries(self, source_entry, target_entry,
950
source_path=None, target_path=None):
951
"""Generate a iter_changes tuple between source_entry and target_entry.
953
:param source_entry: An inventory entry from self.source, or None.
954
:param target_entry: An inventory entry from self.target, or None.
955
:param source_path: The path of source_entry, if known. If not known
956
it will be looked up.
957
:param target_path: The path of target_entry, if known. If not known
958
it will be looked up.
959
:return: A tuple, item 0 of which is an iter_changes result tuple, and
960
item 1 is True if there are any changes in the result tuple.
962
if source_entry is None:
963
if target_entry is None:
965
file_id = target_entry.file_id
967
file_id = source_entry.file_id
968
if source_entry is not None:
969
source_versioned = True
970
source_name = source_entry.name
971
source_parent = source_entry.parent_id
972
if source_path is None:
973
source_path = self.source.id2path(file_id)
974
source_kind, source_executable, source_stat = \
975
self.source._comparison_data(source_entry, source_path)
977
source_versioned = False
981
source_executable = None
982
if target_entry is not None:
983
target_versioned = True
984
target_name = target_entry.name
985
target_parent = target_entry.parent_id
986
if target_path is None:
987
target_path = self.target.id2path(file_id)
988
target_kind, target_executable, target_stat = \
989
self.target._comparison_data(target_entry, target_path)
991
target_versioned = False
995
target_executable = None
996
versioned = (source_versioned, target_versioned)
997
kind = (source_kind, target_kind)
998
changed_content = False
999
if source_kind != target_kind:
1000
changed_content = True
1001
elif source_kind == 'file':
1002
if (self.source.get_file_sha1(file_id, source_path, source_stat) !=
1003
self.target.get_file_sha1(file_id, target_path, target_stat)):
1004
changed_content = True
1005
elif source_kind == 'symlink':
1006
if (self.source.get_symlink_target(file_id) !=
1007
self.target.get_symlink_target(file_id)):
1008
changed_content = True
1009
# XXX: Yes, the indentation below is wrong. But fixing it broke
1010
# test_merge.TestMergerEntriesLCAOnDisk.
1011
# test_nested_tree_subtree_renamed_and_modified. We'll wait for
1012
# the fix from bzr.dev -- vila 2009026
1013
elif source_kind == 'tree-reference':
1014
if (self.source.get_reference_revision(file_id, source_path)
1015
!= self.target.get_reference_revision(file_id, target_path)):
1016
changed_content = True
1017
parent = (source_parent, target_parent)
1018
name = (source_name, target_name)
1019
executable = (source_executable, target_executable)
1020
if (changed_content is not False or versioned[0] != versioned[1]
1021
or parent[0] != parent[1] or name[0] != name[1] or
1022
executable[0] != executable[1]):
1026
return (file_id, (source_path, target_path), changed_content,
1027
versioned, parent, name, kind, executable), changes
1030
def compare(self, want_unchanged=False, specific_files=None,
1031
extra_trees=None, require_versioned=False, include_root=False,
1032
want_unversioned=False):
1033
"""Return the changes from source to target.
1035
:return: A TreeDelta.
1036
:param specific_files: An optional list of file paths to restrict the
1037
comparison to. When mapping filenames to ids, all matches in all
1038
trees (including optional extra_trees) are used, and all children of
1039
matched directories are included.
1040
:param want_unchanged: An optional boolean requesting the inclusion of
1041
unchanged entries in the result.
1042
:param extra_trees: An optional list of additional trees to use when
1043
mapping the contents of specific_files (paths) to file_ids.
1044
:param require_versioned: An optional boolean (defaults to False). When
1045
supplied and True all the 'specific_files' must be versioned, or
1046
a PathsNotVersionedError will be thrown.
1047
:param want_unversioned: Scan for unversioned paths.
1049
trees = (self.source,)
1050
if extra_trees is not None:
1051
trees = trees + tuple(extra_trees)
1052
# target is usually the newer tree:
1053
specific_file_ids = self.target.paths2ids(specific_files, trees,
1054
require_versioned=require_versioned)
1055
if specific_files and not specific_file_ids:
1056
# All files are unversioned, so just return an empty delta
1057
# _compare_trees would think we want a complete delta
1058
result = delta.TreeDelta()
1059
fake_entry = inventory.InventoryFile('unused', 'unused', 'unused')
1060
result.unversioned = [(path, None,
1061
self.target._comparison_data(fake_entry, path)[0]) for path in
1064
return delta._compare_trees(self.source, self.target, want_unchanged,
1065
specific_files, include_root, extra_trees=extra_trees,
1066
require_versioned=require_versioned,
1067
want_unversioned=want_unversioned)
1069
def iter_changes(self, include_unchanged=False,
1070
specific_files=None, pb=None, extra_trees=[],
1071
require_versioned=True, want_unversioned=False):
1072
"""Generate an iterator of changes between trees.
1074
A tuple is returned:
1075
(file_id, (path_in_source, path_in_target),
1076
changed_content, versioned, parent, name, kind,
1079
Changed_content is True if the file's content has changed. This
1080
includes changes to its kind, and to a symlink's target.
1082
versioned, parent, name, kind, executable are tuples of (from, to).
1083
If a file is missing in a tree, its kind is None.
1085
Iteration is done in parent-to-child order, relative to the target
1088
There is no guarantee that all paths are in sorted order: the
1089
requirement to expand the search due to renames may result in children
1090
that should be found early being found late in the search, after
1091
lexically later results have been returned.
1092
:param require_versioned: Raise errors.PathsNotVersionedError if a
1093
path in the specific_files list is not versioned in one of
1094
source, target or extra_trees.
1095
:param specific_files: An optional list of file paths to restrict the
1096
comparison to. When mapping filenames to ids, all matches in all
1097
trees (including optional extra_trees) are used, and all children
1098
of matched directories are included. The parents in the target tree
1099
of the specific files up to and including the root of the tree are
1100
always evaluated for changes too.
1101
:param want_unversioned: Should unversioned files be returned in the
1102
output. An unversioned file is defined as one with (False, False)
1103
for the versioned pair.
1105
lookup_trees = [self.source]
1107
lookup_trees.extend(extra_trees)
1108
# The ids of items we need to examine to insure delta consistency.
1109
precise_file_ids = set()
1110
changed_file_ids = []
1111
if specific_files == []:
1112
specific_file_ids = []
1114
specific_file_ids = self.target.paths2ids(specific_files,
1115
lookup_trees, require_versioned=require_versioned)
1116
if specific_files is not None:
1117
# reparented or added entries must have their parents included
1118
# so that valid deltas can be created. The seen_parents set
1119
# tracks the parents that we need to have.
1120
# The seen_dirs set tracks directory entries we've yielded.
1121
# After outputting version object in to_entries we set difference
1122
# the two seen sets and start checking parents.
1123
seen_parents = set()
1125
if want_unversioned:
1126
all_unversioned = sorted([(p.split('/'), p) for p in
1127
self.target.extras()
1128
if specific_files is None or
1129
osutils.is_inside_any(specific_files, p)])
1130
all_unversioned = collections.deque(all_unversioned)
1132
all_unversioned = collections.deque()
1134
from_entries_by_dir = list(self.source.iter_entries_by_dir(
1135
specific_file_ids=specific_file_ids))
1136
from_data = dict((e.file_id, (p, e)) for p, e in from_entries_by_dir)
1137
to_entries_by_dir = list(self.target.iter_entries_by_dir(
1138
specific_file_ids=specific_file_ids))
1139
num_entries = len(from_entries_by_dir) + len(to_entries_by_dir)
1141
# the unversioned path lookup only occurs on real trees - where there
1142
# can be extras. So the fake_entry is solely used to look up
1143
# executable it values when execute is not supported.
1144
fake_entry = inventory.InventoryFile('unused', 'unused', 'unused')
1145
for target_path, target_entry in to_entries_by_dir:
1146
while (all_unversioned and
1147
all_unversioned[0][0] < target_path.split('/')):
1148
unversioned_path = all_unversioned.popleft()
1149
target_kind, target_executable, target_stat = \
1150
self.target._comparison_data(fake_entry, unversioned_path[1])
1151
yield (None, (None, unversioned_path[1]), True, (False, False),
1153
(None, unversioned_path[0][-1]),
1154
(None, target_kind),
1155
(None, target_executable))
1156
source_path, source_entry = from_data.get(target_entry.file_id,
1158
result, changes = self._changes_from_entries(source_entry,
1159
target_entry, source_path=source_path, target_path=target_path)
1160
to_paths[result[0]] = result[1][1]
1165
pb.update('comparing files', entry_count, num_entries)
1166
if changes or include_unchanged:
1167
if specific_file_ids is not None:
1168
new_parent_id = result[4][1]
1169
precise_file_ids.add(new_parent_id)
1170
changed_file_ids.append(result[0])
1172
# Ensure correct behaviour for reparented/added specific files.
1173
if specific_files is not None:
1174
# Record output dirs
1175
if result[6][1] == 'directory':
1176
seen_dirs.add(result[0])
1177
# Record parents of reparented/added entries.
1178
versioned = result[3]
1180
if not versioned[0] or parents[0] != parents[1]:
1181
seen_parents.add(parents[1])
1182
while all_unversioned:
1183
# yield any trailing unversioned paths
1184
unversioned_path = all_unversioned.popleft()
1185
to_kind, to_executable, to_stat = \
1186
self.target._comparison_data(fake_entry, unversioned_path[1])
1187
yield (None, (None, unversioned_path[1]), True, (False, False),
1189
(None, unversioned_path[0][-1]),
1191
(None, to_executable))
1192
# Yield all remaining source paths
1193
for path, from_entry in from_entries_by_dir:
1194
file_id = from_entry.file_id
1195
if file_id in to_paths:
1198
if not self.target.has_id(file_id):
1199
# common case - paths we have not emitted are not present in
1203
to_path = self.target.id2path(file_id)
1206
pb.update('comparing files', entry_count, num_entries)
1207
versioned = (True, False)
1208
parent = (from_entry.parent_id, None)
1209
name = (from_entry.name, None)
1210
from_kind, from_executable, stat_value = \
1211
self.source._comparison_data(from_entry, path)
1212
kind = (from_kind, None)
1213
executable = (from_executable, None)
1214
changed_content = from_kind is not None
1215
# the parent's path is necessarily known at this point.
1216
changed_file_ids.append(file_id)
1217
yield(file_id, (path, to_path), changed_content, versioned, parent,
1218
name, kind, executable)
1219
changed_file_ids = set(changed_file_ids)
1220
if specific_file_ids is not None:
1221
for result in self._handle_precise_ids(precise_file_ids,
1225
def _get_entry(self, tree, file_id):
1226
"""Get an inventory entry from a tree, with missing entries as None.
1228
If the tree raises NotImplementedError on accessing .inventory, then
1229
this is worked around using iter_entries_by_dir on just the file id
1232
:param tree: The tree to lookup the entry in.
1233
:param file_id: The file_id to lookup.
1236
inventory = tree.inventory
1237
except NotImplementedError:
1238
# No inventory available.
1240
iterator = tree.iter_entries_by_dir(specific_file_ids=[file_id])
1241
return iterator.next()[1]
1242
except StopIteration:
1246
return inventory[file_id]
1247
except errors.NoSuchId:
1250
def _handle_precise_ids(self, precise_file_ids, changed_file_ids,
1251
discarded_changes=None):
1252
"""Fill out a partial iter_changes to be consistent.
1254
:param precise_file_ids: The file ids of parents that were seen during
1256
:param changed_file_ids: The file ids of already emitted items.
1257
:param discarded_changes: An optional dict of precalculated
1258
iter_changes items which the partial iter_changes had not output
1260
:return: A generator of iter_changes items to output.
1262
# process parents of things that had changed under the users
1263
# requested paths to prevent incorrect paths or parent ids which
1264
# aren't in the tree.
1265
while precise_file_ids:
1266
precise_file_ids.discard(None)
1267
# Don't emit file_ids twice
1268
precise_file_ids.difference_update(changed_file_ids)
1269
if not precise_file_ids:
1271
# If the there was something at a given output path in source, we
1272
# have to include the entry from source in the delta, or we would
1273
# be putting this entry into a used path.
1275
for parent_id in precise_file_ids:
1277
paths.append(self.target.id2path(parent_id))
1278
except errors.NoSuchId:
1279
# This id has been dragged in from the source by delta
1280
# expansion and isn't present in target at all: we don't
1281
# need to check for path collisions on it.
1284
old_id = self.source.path2id(path)
1285
precise_file_ids.add(old_id)
1286
precise_file_ids.discard(None)
1287
current_ids = precise_file_ids
1288
precise_file_ids = set()
1289
# We have to emit all of precise_file_ids that have been altered.
1290
# We may have to output the children of some of those ids if any
1291
# directories have stopped being directories.
1292
for file_id in current_ids:
1294
if discarded_changes:
1295
result = discarded_changes.get(file_id)
1300
old_entry = self._get_entry(self.source, file_id)
1301
new_entry = self._get_entry(self.target, file_id)
1302
result, changes = self._changes_from_entries(
1303
old_entry, new_entry)
1306
# Get this parents parent to examine.
1307
new_parent_id = result[4][1]
1308
precise_file_ids.add(new_parent_id)
1310
if (result[6][0] == 'directory' and
1311
result[6][1] != 'directory'):
1312
# This stopped being a directory, the old children have
1314
if old_entry is None:
1315
# Reusing a discarded change.
1316
old_entry = self._get_entry(self.source, file_id)
1317
for child in old_entry.children.values():
1318
precise_file_ids.add(child.file_id)
1319
changed_file_ids.add(result[0])
1323
InterTree.register_optimiser(InterTree)
1326
class MultiWalker(object):
1327
"""Walk multiple trees simultaneously, getting combined results."""
1329
# Note: This could be written to not assume you can do out-of-order
1330
# lookups. Instead any nodes that don't match in all trees could be
1331
# marked as 'deferred', and then returned in the final cleanup loop.
1332
# For now, I think it is "nicer" to return things as close to the
1333
# "master_tree" order as we can.
1335
def __init__(self, master_tree, other_trees):
1336
"""Create a new MultiWalker.
1338
All trees being walked must implement "iter_entries_by_dir()", such
1339
that they yield (path, object) tuples, where that object will have a
1340
'.file_id' member, that can be used to check equality.
1342
:param master_tree: All trees will be 'slaved' to the master_tree such
1343
that nodes in master_tree will be used as 'first-pass' sync points.
1344
Any nodes that aren't in master_tree will be merged in a second
1346
:param other_trees: A list of other trees to walk simultaneously.
1348
self._master_tree = master_tree
1349
self._other_trees = other_trees
1351
# Keep track of any nodes that were properly processed just out of
1352
# order, that way we don't return them at the end, we don't have to
1353
# track *all* processed file_ids, just the out-of-order ones
1354
self._out_of_order_processed = set()
1357
def _step_one(iterator):
1358
"""Step an iter_entries_by_dir iterator.
1360
:return: (has_more, path, ie)
1361
If has_more is False, path and ie will be None.
1364
path, ie = iterator.next()
1365
except StopIteration:
1366
return False, None, None
1368
return True, path, ie
1371
def _cmp_path_by_dirblock(path1, path2):
1372
"""Compare two paths based on what directory they are in.
1374
This generates a sort order, such that all children of a directory are
1375
sorted together, and grandchildren are in the same order as the
1376
children appear. But all grandchildren come after all children.
1378
:param path1: first path
1379
:param path2: the second path
1380
:return: negative number if ``path1`` comes first,
1381
0 if paths are equal
1382
and a positive number if ``path2`` sorts first
1384
# Shortcut this special case
1387
# This is stolen from _dirstate_helpers_py.py, only switching it to
1388
# Unicode objects. Consider using encode_utf8() and then using the
1389
# optimized versions, or maybe writing optimized unicode versions.
1390
if not isinstance(path1, unicode):
1391
raise TypeError("'path1' must be a unicode string, not %s: %r"
1392
% (type(path1), path1))
1393
if not isinstance(path2, unicode):
1394
raise TypeError("'path2' must be a unicode string, not %s: %r"
1395
% (type(path2), path2))
1396
return cmp(MultiWalker._path_to_key(path1),
1397
MultiWalker._path_to_key(path2))
1400
def _path_to_key(path):
1401
dirname, basename = osutils.split(path)
1402
return (dirname.split(u'/'), basename)
1404
def _lookup_by_file_id(self, extra_entries, other_tree, file_id):
1405
"""Lookup an inventory entry by file_id.
1407
This is called when an entry is missing in the normal order.
1408
Generally this is because a file was either renamed, or it was
1409
deleted/added. If the entry was found in the inventory and not in
1410
extra_entries, it will be added to self._out_of_order_processed
1412
:param extra_entries: A dictionary of {file_id: (path, ie)}. This
1413
should be filled with entries that were found before they were
1414
used. If file_id is present, it will be removed from the
1416
:param other_tree: The Tree to search, in case we didn't find the entry
1418
:param file_id: The file_id to look for
1419
:return: (path, ie) if found or (None, None) if not present.
1421
if file_id in extra_entries:
1422
return extra_entries.pop(file_id)
1423
# TODO: Is id2path better as the first call, or is
1424
# inventory[file_id] better as a first check?
1426
cur_path = other_tree.id2path(file_id)
1427
except errors.NoSuchId:
1429
if cur_path is None:
1432
self._out_of_order_processed.add(file_id)
1433
cur_ie = other_tree.inventory[file_id]
1434
return (cur_path, cur_ie)
1437
"""Match up the values in the different trees."""
1438
for result in self._walk_master_tree():
1440
self._finish_others()
1441
for result in self._walk_others():
1444
def _walk_master_tree(self):
1445
"""First pass, walk all trees in lock-step.
1447
When we are done, all nodes in the master_tree will have been
1448
processed. _other_walkers, _other_entries, and _others_extra will be
1449
set on 'self' for future processing.
1451
# This iterator has the most "inlining" done, because it tends to touch
1452
# every file in the tree, while the others only hit nodes that don't
1454
master_iterator = self._master_tree.iter_entries_by_dir()
1456
other_walkers = [other.iter_entries_by_dir()
1457
for other in self._other_trees]
1458
other_entries = [self._step_one(walker) for walker in other_walkers]
1459
# Track extra nodes in the other trees
1460
others_extra = [{} for i in xrange(len(self._other_trees))]
1462
master_has_more = True
1463
step_one = self._step_one
1464
lookup_by_file_id = self._lookup_by_file_id
1465
out_of_order_processed = self._out_of_order_processed
1467
while master_has_more:
1468
(master_has_more, path, master_ie) = step_one(master_iterator)
1469
if not master_has_more:
1472
file_id = master_ie.file_id
1474
other_values_append = other_values.append
1475
next_other_entries = []
1476
next_other_entries_append = next_other_entries.append
1477
for idx, (other_has_more, other_path, other_ie) in enumerate(other_entries):
1478
if not other_has_more:
1479
other_values_append(lookup_by_file_id(
1480
others_extra[idx], self._other_trees[idx], file_id))
1481
next_other_entries_append((False, None, None))
1482
elif file_id == other_ie.file_id:
1483
# This is the critical code path, as most of the entries
1484
# should match between most trees.
1485
other_values_append((other_path, other_ie))
1486
next_other_entries_append(step_one(other_walkers[idx]))
1488
# This walker did not match, step it until it either
1489
# matches, or we know we are past the current walker.
1490
other_walker = other_walkers[idx]
1491
other_extra = others_extra[idx]
1492
while (other_has_more and
1493
self._cmp_path_by_dirblock(other_path, path) < 0):
1494
other_file_id = other_ie.file_id
1495
if other_file_id not in out_of_order_processed:
1496
other_extra[other_file_id] = (other_path, other_ie)
1497
other_has_more, other_path, other_ie = \
1498
step_one(other_walker)
1499
if other_has_more and other_ie.file_id == file_id:
1500
# We ended up walking to this point, match and step
1502
other_values_append((other_path, other_ie))
1503
other_has_more, other_path, other_ie = \
1504
step_one(other_walker)
1506
# This record isn't in the normal order, see if it
1508
other_values_append(lookup_by_file_id(
1509
other_extra, self._other_trees[idx], file_id))
1510
next_other_entries_append((other_has_more, other_path,
1512
other_entries = next_other_entries
1514
# We've matched all the walkers, yield this datapoint
1515
yield path, file_id, master_ie, other_values
1516
self._other_walkers = other_walkers
1517
self._other_entries = other_entries
1518
self._others_extra = others_extra
1520
def _finish_others(self):
1521
"""Finish walking the other iterators, so we get all entries."""
1522
for idx, info in enumerate(self._other_entries):
1523
other_extra = self._others_extra[idx]
1524
(other_has_more, other_path, other_ie) = info
1525
while other_has_more:
1526
other_file_id = other_ie.file_id
1527
if other_file_id not in self._out_of_order_processed:
1528
other_extra[other_file_id] = (other_path, other_ie)
1529
other_has_more, other_path, other_ie = \
1530
self._step_one(self._other_walkers[idx])
1531
del self._other_entries
1533
def _walk_others(self):
1534
"""Finish up by walking all the 'deferred' nodes."""
1535
# TODO: One alternative would be to grab all possible unprocessed
1536
# file_ids, and then sort by path, and then yield them. That
1537
# might ensure better ordering, in case a caller strictly
1538
# requires parents before children.
1539
for idx, other_extra in enumerate(self._others_extra):
1540
others = sorted(other_extra.itervalues(),
1541
key=lambda x: self._path_to_key(x[0]))
1542
for other_path, other_ie in others:
1543
file_id = other_ie.file_id
1544
# We don't need to check out_of_order_processed here, because
1545
# the lookup_by_file_id will be removing anything processed
1546
# from the extras cache
1547
other_extra.pop(file_id)
1548
other_values = [(None, None) for i in xrange(idx)]
1549
other_values.append((other_path, other_ie))
1550
for alt_idx, alt_extra in enumerate(self._others_extra[idx+1:]):
1551
alt_idx = alt_idx + idx + 1
1552
alt_extra = self._others_extra[alt_idx]
1553
alt_tree = self._other_trees[alt_idx]
1554
other_values.append(self._lookup_by_file_id(
1555
alt_extra, alt_tree, file_id))
1556
yield other_path, file_id, None, other_values
452
def find_renames(old_inv, new_inv):
453
for file_id in old_inv:
454
if file_id not in new_inv:
456
old_name = old_inv.id2path(file_id)
457
new_name = new_inv.id2path(file_id)
458
if old_name != new_name:
459
yield (old_name, new_name)
added
removed
bzrlib/tree.py
