~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/tree.py

  • Committer: Aaron Bentley
  • Date: 2009-06-19 21:16:31 UTC
  • mto: This revision was merged to the branch mainline in revision 4481.
  • Revision ID: aaron@aaronbentley.com-20090619211631-4fnkv2uui98xj7ux
Provide control over switch and shelver messaging.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005-2011 Canonical Ltd
 
1
# Copyright (C) 2005, 2009 Canonical Ltd
2
2
#
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
18
18
"""
19
19
 
20
20
import os
21
 
 
22
 
from bzrlib.lazy_import import lazy_import
23
 
lazy_import(globals(), """
24
 
import collections
25
 
 
 
21
from collections import deque
 
22
from cStringIO import StringIO
 
23
 
 
24
import bzrlib
26
25
from bzrlib import (
27
26
    conflicts as _mod_conflicts,
28
27
    debug,
29
28
    delta,
30
 
    errors,
31
29
    filters,
32
 
    inventory,
33
30
    osutils,
34
31
    revision as _mod_revision,
35
32
    rules,
36
 
    trace,
 
33
    symbol_versioning,
37
34
    )
38
 
""")
39
 
 
40
35
from bzrlib.decorators import needs_read_lock
 
36
from bzrlib.errors import BzrError, BzrCheckError, NoSuchId
 
37
from bzrlib import errors
 
38
from bzrlib.inventory import Inventory, InventoryFile
41
39
from bzrlib.inter import InterObject
42
 
from bzrlib.symbol_versioning import (
43
 
    deprecated_in,
44
 
    deprecated_method,
45
 
    )
 
40
from bzrlib.osutils import fingerprint_file
 
41
import bzrlib.revision
 
42
from bzrlib.symbol_versioning import deprecated_function, deprecated_in
 
43
from bzrlib.trace import mutter, note
46
44
 
47
45
 
48
46
class Tree(object):
54
52
 
55
53
    * `RevisionTree` is a tree as recorded at some point in the past.
56
54
 
 
55
    Trees contain an `Inventory` object, and also know how to retrieve
 
56
    file texts mentioned in the inventory, either from a working
 
57
    directory or from a store.
 
58
 
 
59
    It is possible for trees to contain files that are not described
 
60
    in their inventory or vice versa; for this use `filenames()`.
 
61
 
57
62
    Trees can be compared, etc, regardless of whether they are working
58
63
    trees or versioned trees.
59
64
    """
95
100
    def iter_changes(self, from_tree, include_unchanged=False,
96
101
                     specific_files=None, pb=None, extra_trees=None,
97
102
                     require_versioned=True, want_unversioned=False):
98
 
        """See InterTree.iter_changes"""
99
103
        intertree = InterTree.get(from_tree, self)
100
104
        return intertree.iter_changes(include_unchanged, specific_files, pb,
101
105
            extra_trees, require_versioned, want_unversioned=want_unversioned)
125
129
        raise NotImplementedError(self.has_filename)
126
130
 
127
131
    def has_id(self, file_id):
128
 
        raise NotImplementedError(self.has_id)
 
132
        return self.inventory.has_id(file_id)
129
133
 
130
 
    @deprecated_method(deprecated_in((2, 4, 0)))
131
134
    def __contains__(self, file_id):
132
135
        return self.has_id(file_id)
133
136
 
134
137
    def has_or_had_id(self, file_id):
135
 
        raise NotImplementedError(self.has_or_had_id)
 
138
        if file_id == self.inventory.root.file_id:
 
139
            return True
 
140
        return self.inventory.has_id(file_id)
136
141
 
137
142
    def is_ignored(self, filename):
138
143
        """Check whether the filename is ignored by this tree.
142
147
        """
143
148
        return False
144
149
 
 
150
    def __iter__(self):
 
151
        return iter(self.inventory)
 
152
 
145
153
    def all_file_ids(self):
146
154
        """Iterate through all file ids, including ids for missing files."""
147
 
        raise NotImplementedError(self.all_file_ids)
 
155
        return set(self.inventory)
148
156
 
149
157
    def id2path(self, file_id):
150
158
        """Return the path for a file id.
151
159
 
152
160
        :raises NoSuchId:
153
161
        """
154
 
        raise NotImplementedError(self.id2path)
155
 
 
156
 
    def iter_entries_by_dir(self, specific_file_ids=None, yield_parents=False):
 
162
        return self.inventory.id2path(file_id)
 
163
 
 
164
    def is_control_filename(self, filename):
 
165
        """True if filename is the name of a control file in this tree.
 
166
 
 
167
        :param filename: A filename within the tree. This is a relative path
 
168
        from the root of this tree.
 
169
 
 
170
        This is true IF and ONLY IF the filename is part of the meta data
 
171
        that bzr controls in this tree. I.E. a random .bzr directory placed
 
172
        on disk will not be a control file for this tree.
 
173
        """
 
174
        return self.bzrdir.is_control_filename(filename)
 
175
 
 
176
    @needs_read_lock
 
177
    def iter_entries_by_dir(self, specific_file_ids=None):
157
178
        """Walk the tree in 'by_dir' order.
158
179
 
159
180
        This will yield each entry in the tree as a (path, entry) tuple.
175
196
             g
176
197
 
177
198
        The yield order (ignoring root) would be::
178
 
 
179
199
          a, f, a/b, a/d, a/b/c, a/d/e, f/g
180
 
 
181
 
        :param yield_parents: If True, yield the parents from the root leading
182
 
            down to specific_file_ids that have been requested. This has no
183
 
            impact if specific_file_ids is None.
184
 
        """
185
 
        raise NotImplementedError(self.iter_entries_by_dir)
186
 
 
187
 
    def list_files(self, include_root=False, from_dir=None, recursive=True):
188
 
        """List all files in this tree.
189
 
 
190
 
        :param include_root: Whether to include the entry for the tree root
191
 
        :param from_dir: Directory under which to list files
192
 
        :param recursive: Whether to list files recursively
193
 
        :return: iterator over tuples of (path, versioned, kind, file_id,
194
 
            inventory entry)
195
 
        """
196
 
        raise NotImplementedError(self.list_files)
 
200
        """
 
201
        return self.inventory.iter_entries_by_dir(
 
202
            specific_file_ids=specific_file_ids)
197
203
 
198
204
    def iter_references(self):
199
205
        if self.supports_tree_reference():
216
222
    def path_content_summary(self, path):
217
223
        """Get a summary of the information about path.
218
224
 
219
 
        All the attributes returned are for the canonical form, not the
220
 
        convenient form (if content filters are in use.)
221
 
 
222
225
        :param path: A relative path within the tree.
223
226
        :return: A tuple containing kind, size, exec, sha1-or-link.
224
227
            Kind is always present (see tree.kind()).
225
 
            size is present if kind is file and the size of the 
226
 
                canonical form can be cheaply determined, None otherwise.
 
228
            size is present if kind is file, None otherwise.
227
229
            exec is None unless kind is file and the platform supports the 'x'
228
230
                bit.
229
231
            sha1-or-link is the link target if kind is symlink, or the sha1 if
250
252
    def _file_size(self, entry, stat_value):
251
253
        raise NotImplementedError(self._file_size)
252
254
 
 
255
    def _get_inventory(self):
 
256
        return self._inventory
 
257
 
253
258
    def get_file(self, file_id, path=None):
254
259
        """Return a file object for the file file_id in the tree.
255
260
 
277
282
 
278
283
        :param file_id: The file_id of the file.
279
284
        :param path: The path of the file.
280
 
 
281
285
        If both file_id and path are supplied, an implementation may use
282
286
        either one.
283
 
 
284
 
        :returns: A single byte string for the whole file.
285
287
        """
286
288
        my_file = self.get_file(file_id, path)
287
289
        try:
294
296
 
295
297
        :param file_id: The file_id of the file.
296
298
        :param path: The path of the file.
297
 
 
298
299
        If both file_id and path are supplied, an implementation may use
299
300
        either one.
300
301
        """
301
302
        return osutils.split_lines(self.get_file_text(file_id, path))
302
303
 
303
 
    def get_file_verifier(self, file_id, path=None, stat_value=None):
304
 
        """Return a verifier for a file.
305
 
 
306
 
        The default implementation returns a sha1.
307
 
 
308
 
        :param file_id: The handle for this file.
309
 
        :param path: The path that this file can be found at.
310
 
            These must point to the same object.
311
 
        :param stat_value: Optional stat value for the object
312
 
        :return: Tuple with verifier name and verifier data
313
 
        """
314
 
        return ("SHA1", self.get_file_sha1(file_id, path=path,
315
 
            stat_value=stat_value))
316
 
 
317
 
    def get_file_sha1(self, file_id, path=None, stat_value=None):
318
 
        """Return the SHA1 file for a file.
319
 
 
320
 
        :note: callers should use get_file_verifier instead
321
 
            where possible, as the underlying repository implementation may
322
 
            have quicker access to a non-sha1 verifier.
323
 
 
324
 
        :param file_id: The handle for this file.
325
 
        :param path: The path that this file can be found at.
326
 
            These must point to the same object.
327
 
        :param stat_value: Optional stat value for the object
328
 
        """
329
 
        raise NotImplementedError(self.get_file_sha1)
330
 
 
331
304
    def get_file_mtime(self, file_id, path=None):
332
305
        """Return the modification time for a file.
333
306
 
347
320
        raise NotImplementedError(self.get_file_size)
348
321
 
349
322
    def get_file_by_path(self, path):
350
 
        raise NotImplementedError(self.get_file_by_path)
351
 
 
352
 
    def is_executable(self, file_id, path=None):
353
 
        """Check if a file is executable.
354
 
 
355
 
        :param file_id: The handle for this file.
356
 
        :param path: The path that this file can be found at.
357
 
            These must point to the same object.
358
 
        """
359
 
        raise NotImplementedError(self.is_executable)
 
323
        return self.get_file(self._inventory.path2id(path), path)
360
324
 
361
325
    def iter_files_bytes(self, desired_files):
362
326
        """Iterate through file contents.
384
348
            cur_file = (self.get_file_text(file_id),)
385
349
            yield identifier, cur_file
386
350
 
387
 
    def get_symlink_target(self, file_id, path=None):
 
351
    def get_symlink_target(self, file_id):
388
352
        """Get the target for a given file_id.
389
353
 
390
354
        It is assumed that the caller already knows that file_id is referencing
391
355
        a symlink.
392
356
        :param file_id: Handle for the symlink entry.
393
 
        :param path: The path of the file.
394
 
        If both file_id and path are supplied, an implementation may use
395
 
        either one.
396
357
        :return: The path the symlink points to.
397
358
        """
398
359
        raise NotImplementedError(self.get_symlink_target)
399
360
 
 
361
    def get_canonical_inventory_paths(self, paths):
 
362
        """Like get_canonical_inventory_path() but works on multiple items.
 
363
 
 
364
        :param paths: A sequence of paths relative to the root of the tree.
 
365
        :return: A list of paths, with each item the corresponding input path
 
366
        adjusted to account for existing elements that match case
 
367
        insensitively.
 
368
        """
 
369
        return list(self._yield_canonical_inventory_paths(paths))
 
370
 
 
371
    def get_canonical_inventory_path(self, path):
 
372
        """Returns the first inventory item that case-insensitively matches path.
 
373
 
 
374
        If a path matches exactly, it is returned. If no path matches exactly
 
375
        but more than one path matches case-insensitively, it is implementation
 
376
        defined which is returned.
 
377
 
 
378
        If no path matches case-insensitively, the input path is returned, but
 
379
        with as many path entries that do exist changed to their canonical
 
380
        form.
 
381
 
 
382
        If you need to resolve many names from the same tree, you should
 
383
        use get_canonical_inventory_paths() to avoid O(N) behaviour.
 
384
 
 
385
        :param path: A paths relative to the root of the tree.
 
386
        :return: The input path adjusted to account for existing elements
 
387
        that match case insensitively.
 
388
        """
 
389
        return self._yield_canonical_inventory_paths([path]).next()
 
390
 
 
391
    def _yield_canonical_inventory_paths(self, paths):
 
392
        for path in paths:
 
393
            # First, if the path as specified exists exactly, just use it.
 
394
            if self.path2id(path) is not None:
 
395
                yield path
 
396
                continue
 
397
            # go walkin...
 
398
            cur_id = self.get_root_id()
 
399
            cur_path = ''
 
400
            bit_iter = iter(path.split("/"))
 
401
            for elt in bit_iter:
 
402
                lelt = elt.lower()
 
403
                for child in self.iter_children(cur_id):
 
404
                    try:
 
405
                        child_base = os.path.basename(self.id2path(child))
 
406
                        if child_base.lower() == lelt:
 
407
                            cur_id = child
 
408
                            cur_path = osutils.pathjoin(cur_path, child_base)
 
409
                            break
 
410
                    except NoSuchId:
 
411
                        # before a change is committed we can see this error...
 
412
                        continue
 
413
                else:
 
414
                    # got to the end of this directory and no entries matched.
 
415
                    # Return what matched so far, plus the rest as specified.
 
416
                    cur_path = osutils.pathjoin(cur_path, elt, *list(bit_iter))
 
417
                    break
 
418
            yield cur_path
 
419
        # all done.
 
420
 
400
421
    def get_root_id(self):
401
422
        """Return the file_id for the root of this tree."""
402
423
        raise NotImplementedError(self.get_root_id)
416
437
        raise NotImplementedError(self.annotate_iter)
417
438
 
418
439
    def _get_plan_merge_data(self, file_id, other, base):
419
 
        from bzrlib import versionedfile
 
440
        from bzrlib import merge, versionedfile
420
441
        vf = versionedfile._PlanMergeVersionedFile(file_id)
421
442
        last_revision_a = self._get_file_revision(file_id, vf, 'this:')
422
443
        last_revision_b = other._get_file_revision(file_id, vf, 'other:')
460
481
            except errors.NoSuchRevisionInTree:
461
482
                yield self.repository.revision_tree(revision_id)
462
483
 
 
484
    @staticmethod
 
485
    def _file_revision(revision_tree, file_id):
 
486
        """Determine the revision associated with a file in a given tree."""
 
487
        revision_tree.lock_read()
 
488
        try:
 
489
            return revision_tree.inventory[file_id].revision
 
490
        finally:
 
491
            revision_tree.unlock()
 
492
 
463
493
    def _get_file_revision(self, file_id, vf, tree_revision):
464
494
        """Ensure that file_id, tree_revision is in vf to plan the merge."""
465
495
 
466
496
        if getattr(self, '_repository', None) is None:
467
497
            last_revision = tree_revision
468
 
            parent_keys = [(file_id, t.get_file_revision(file_id)) for t in
 
498
            parent_keys = [(file_id, self._file_revision(t, file_id)) for t in
469
499
                self._iter_parent_trees()]
470
500
            vf.add_lines((file_id, last_revision), parent_keys,
471
 
                         self.get_file_lines(file_id))
 
501
                         self.get_file(file_id).readlines())
472
502
            repo = self.branch.repository
473
503
            base_vf = repo.texts
474
504
        else:
475
 
            last_revision = self.get_file_revision(file_id)
 
505
            last_revision = self._file_revision(self, file_id)
476
506
            base_vf = self._repository.texts
477
507
        if base_vf not in vf.fallback_versionedfiles:
478
508
            vf.fallback_versionedfiles.append(base_vf)
479
509
        return last_revision
480
510
 
 
511
    inventory = property(_get_inventory,
 
512
                         doc="Inventory of this Tree")
 
513
 
481
514
    def _check_retrieved(self, ie, f):
482
515
        if not __debug__:
483
516
            return
484
 
        fp = osutils.fingerprint_file(f)
 
517
        fp = fingerprint_file(f)
485
518
        f.seek(0)
486
519
 
487
520
        if ie.text_size is not None:
488
521
            if ie.text_size != fp['size']:
489
 
                raise errors.BzrError(
490
 
                        "mismatched size for file %r in %r" %
491
 
                        (ie.file_id, self._store),
 
522
                raise BzrError("mismatched size for file %r in %r" % (ie.file_id, self._store),
492
523
                        ["inventory expects %d bytes" % ie.text_size,
493
524
                         "file is actually %d bytes" % fp['size'],
494
525
                         "store is probably damaged/corrupt"])
495
526
 
496
527
        if ie.text_sha1 != fp['sha1']:
497
 
            raise errors.BzrError("wrong SHA-1 for file %r in %r" %
498
 
                    (ie.file_id, self._store),
 
528
            raise BzrError("wrong SHA-1 for file %r in %r" % (ie.file_id, self._store),
499
529
                    ["inventory expects %s" % ie.text_sha1,
500
530
                     "file is actually %s" % fp['sha1'],
501
531
                     "store is probably damaged/corrupt"])
502
532
 
 
533
    @needs_read_lock
503
534
    def path2id(self, path):
504
535
        """Return the id for path in this tree."""
505
 
        raise NotImplementedError(self.path2id)
 
536
        return self._inventory.path2id(path)
506
537
 
507
538
    def paths2ids(self, paths, trees=[], require_versioned=True):
508
539
        """Return all the ids that can be reached by walking from paths.
529
560
            yield child.file_id
530
561
 
531
562
    def lock_read(self):
532
 
        """Lock this tree for multiple read only operations.
533
 
        
534
 
        :return: A bzrlib.lock.LogicalLockResult.
535
 
        """
536
563
        pass
537
564
 
538
565
    def revision_tree(self, revision_id):
565
592
 
566
593
        :return: set of paths.
567
594
        """
568
 
        raise NotImplementedError(self.filter_unversioned_files)
 
595
        # NB: we specifically *don't* call self.has_filename, because for
 
596
        # WorkingTrees that can indicate files that exist on disk but that
 
597
        # are not versioned.
 
598
        pred = self.inventory.has_filename
 
599
        return set((p for p in paths if not pred(p)))
569
600
 
570
601
    def walkdirs(self, prefix=""):
571
602
        """Walk the contents of this tree from path down.
623
654
        prefs = self.iter_search_rules([path], filter_pref_names).next()
624
655
        stk = filters._get_filter_stack_for(prefs)
625
656
        if 'filters' in debug.debug_flags:
626
 
            trace.note("*** %s content-filter: %s => %r" % (path,prefs,stk))
 
657
            note("*** %s content-filter: %s => %r" % (path,prefs,stk))
627
658
        return stk
628
659
 
629
660
    def _content_filter_stack_provider(self):
662
693
                for path in path_names:
663
694
                    yield searcher.get_items(path)
664
695
 
 
696
    @needs_read_lock
665
697
    def _get_rules_searcher(self, default_searcher):
666
698
        """Get the RulesSearcher for this tree given the default one."""
667
699
        searcher = default_searcher
668
700
        return searcher
669
701
 
670
702
 
671
 
class InventoryTree(Tree):
672
 
    """A tree that relies on an inventory for its metadata.
673
 
 
674
 
    Trees contain an `Inventory` object, and also know how to retrieve
675
 
    file texts mentioned in the inventory, either from a working
676
 
    directory or from a store.
677
 
 
678
 
    It is possible for trees to contain files that are not described
679
 
    in their inventory or vice versa; for this use `filenames()`.
680
 
 
681
 
    Subclasses should set the _inventory attribute, which is considered
682
 
    private to external API users.
 
703
######################################################################
 
704
# diff
 
705
 
 
706
# TODO: Merge these two functions into a single one that can operate
 
707
# on either a whole tree or a set of files.
 
708
 
 
709
# TODO: Return the diff in order by filename, not by category or in
 
710
# random order.  Can probably be done by lock-stepping through the
 
711
# filenames from both trees.
 
712
 
 
713
 
 
714
def file_status(filename, old_tree, new_tree):
 
715
    """Return single-letter status, old and new names for a file.
 
716
 
 
717
    The complexity here is in deciding how to represent renames;
 
718
    many complex cases are possible.
683
719
    """
684
 
 
685
 
    def get_canonical_inventory_paths(self, paths):
686
 
        """Like get_canonical_inventory_path() but works on multiple items.
687
 
 
688
 
        :param paths: A sequence of paths relative to the root of the tree.
689
 
        :return: A list of paths, with each item the corresponding input path
690
 
        adjusted to account for existing elements that match case
691
 
        insensitively.
692
 
        """
693
 
        return list(self._yield_canonical_inventory_paths(paths))
694
 
 
695
 
    def get_canonical_inventory_path(self, path):
696
 
        """Returns the first inventory item that case-insensitively matches path.
697
 
 
698
 
        If a path matches exactly, it is returned. If no path matches exactly
699
 
        but more than one path matches case-insensitively, it is implementation
700
 
        defined which is returned.
701
 
 
702
 
        If no path matches case-insensitively, the input path is returned, but
703
 
        with as many path entries that do exist changed to their canonical
704
 
        form.
705
 
 
706
 
        If you need to resolve many names from the same tree, you should
707
 
        use get_canonical_inventory_paths() to avoid O(N) behaviour.
708
 
 
709
 
        :param path: A paths relative to the root of the tree.
710
 
        :return: The input path adjusted to account for existing elements
711
 
        that match case insensitively.
712
 
        """
713
 
        return self._yield_canonical_inventory_paths([path]).next()
714
 
 
715
 
    def _yield_canonical_inventory_paths(self, paths):
716
 
        for path in paths:
717
 
            # First, if the path as specified exists exactly, just use it.
718
 
            if self.path2id(path) is not None:
719
 
                yield path
720
 
                continue
721
 
            # go walkin...
722
 
            cur_id = self.get_root_id()
723
 
            cur_path = ''
724
 
            bit_iter = iter(path.split("/"))
725
 
            for elt in bit_iter:
726
 
                lelt = elt.lower()
727
 
                new_path = None
728
 
                for child in self.iter_children(cur_id):
729
 
                    try:
730
 
                        # XXX: it seem like if the child is known to be in the
731
 
                        # tree, we shouldn't need to go from its id back to
732
 
                        # its path -- mbp 2010-02-11
733
 
                        #
734
 
                        # XXX: it seems like we could be more efficient
735
 
                        # by just directly looking up the original name and
736
 
                        # only then searching all children; also by not
737
 
                        # chopping paths so much. -- mbp 2010-02-11
738
 
                        child_base = os.path.basename(self.id2path(child))
739
 
                        if (child_base == elt):
740
 
                            # if we found an exact match, we can stop now; if
741
 
                            # we found an approximate match we need to keep
742
 
                            # searching because there might be an exact match
743
 
                            # later.  
744
 
                            cur_id = child
745
 
                            new_path = osutils.pathjoin(cur_path, child_base)
746
 
                            break
747
 
                        elif child_base.lower() == lelt:
748
 
                            cur_id = child
749
 
                            new_path = osutils.pathjoin(cur_path, child_base)
750
 
                    except errors.NoSuchId:
751
 
                        # before a change is committed we can see this error...
752
 
                        continue
753
 
                if new_path:
754
 
                    cur_path = new_path
755
 
                else:
756
 
                    # got to the end of this directory and no entries matched.
757
 
                    # Return what matched so far, plus the rest as specified.
758
 
                    cur_path = osutils.pathjoin(cur_path, elt, *list(bit_iter))
759
 
                    break
760
 
            yield cur_path
761
 
        # all done.
762
 
 
763
 
    def _get_inventory(self):
764
 
        return self._inventory
765
 
 
766
 
    inventory = property(_get_inventory,
767
 
                         doc="Inventory of this Tree")
768
 
 
769
 
    @needs_read_lock
770
 
    def path2id(self, path):
771
 
        """Return the id for path in this tree."""
772
 
        return self._inventory.path2id(path)
773
 
 
774
 
    def id2path(self, file_id):
775
 
        """Return the path for a file id.
776
 
 
777
 
        :raises NoSuchId:
778
 
        """
779
 
        return self.inventory.id2path(file_id)
780
 
 
781
 
    def has_id(self, file_id):
782
 
        return self.inventory.has_id(file_id)
783
 
 
784
 
    def has_or_had_id(self, file_id):
785
 
        return self.inventory.has_id(file_id)
786
 
 
787
 
    def all_file_ids(self):
788
 
        return set(self.inventory)
789
 
 
790
 
    @deprecated_method(deprecated_in((2, 4, 0)))
791
 
    def __iter__(self):
792
 
        return iter(self.inventory)
793
 
 
794
 
    def filter_unversioned_files(self, paths):
795
 
        """Filter out paths that are versioned.
796
 
 
797
 
        :return: set of paths.
798
 
        """
799
 
        # NB: we specifically *don't* call self.has_filename, because for
800
 
        # WorkingTrees that can indicate files that exist on disk but that
801
 
        # are not versioned.
802
 
        pred = self.inventory.has_filename
803
 
        return set((p for p in paths if not pred(p)))
804
 
 
805
 
    @needs_read_lock
806
 
    def iter_entries_by_dir(self, specific_file_ids=None, yield_parents=False):
807
 
        """Walk the tree in 'by_dir' order.
808
 
 
809
 
        This will yield each entry in the tree as a (path, entry) tuple.
810
 
        The order that they are yielded is:
811
 
 
812
 
        See Tree.iter_entries_by_dir for details.
813
 
 
814
 
        :param yield_parents: If True, yield the parents from the root leading
815
 
            down to specific_file_ids that have been requested. This has no
816
 
            impact if specific_file_ids is None.
817
 
        """
818
 
        return self.inventory.iter_entries_by_dir(
819
 
            specific_file_ids=specific_file_ids, yield_parents=yield_parents)
820
 
 
821
 
    def get_file_by_path(self, path):
822
 
        return self.get_file(self._inventory.path2id(path), path)
 
720
    old_inv = old_tree.inventory
 
721
    new_inv = new_tree.inventory
 
722
    new_id = new_inv.path2id(filename)
 
723
    old_id = old_inv.path2id(filename)
 
724
 
 
725
    if not new_id and not old_id:
 
726
        # easy: doesn't exist in either; not versioned at all
 
727
        if new_tree.is_ignored(filename):
 
728
            return 'I', None, None
 
729
        else:
 
730
            return '?', None, None
 
731
    elif new_id:
 
732
        # There is now a file of this name, great.
 
733
        pass
 
734
    else:
 
735
        # There is no longer a file of this name, but we can describe
 
736
        # what happened to the file that used to have
 
737
        # this name.  There are two possibilities: either it was
 
738
        # deleted entirely, or renamed.
 
739
        if new_inv.has_id(old_id):
 
740
            return 'X', old_inv.id2path(old_id), new_inv.id2path(old_id)
 
741
        else:
 
742
            return 'D', old_inv.id2path(old_id), None
 
743
 
 
744
    # if the file_id is new in this revision, it is added
 
745
    if new_id and not old_inv.has_id(new_id):
 
746
        return 'A'
 
747
 
 
748
    # if there used to be a file of this name, but that ID has now
 
749
    # disappeared, it is deleted
 
750
    if old_id and not new_inv.has_id(old_id):
 
751
        return 'D'
 
752
 
 
753
    return 'wtf?'
 
754
 
 
755
 
 
756
@deprecated_function(deprecated_in((1, 9, 0)))
 
757
def find_renames(old_inv, new_inv):
 
758
    for file_id in old_inv:
 
759
        if file_id not in new_inv:
 
760
            continue
 
761
        old_name = old_inv.id2path(file_id)
 
762
        new_name = new_inv.id2path(file_id)
 
763
        if old_name != new_name:
 
764
            yield (old_name, new_name)
823
765
 
824
766
 
825
767
def find_ids_across_trees(filenames, trees, require_versioned=True):
832
774
        None)
833
775
    :param trees: The trees to find file_ids within
834
776
    :param require_versioned: if true, all specified filenames must occur in
835
 
        at least one tree.
 
777
    at least one tree.
836
778
    :return: a set of file ids for the specified filenames and their children.
837
779
    """
838
780
    if not filenames:
885
827
        new_pending = set()
886
828
        for file_id in pending:
887
829
            for tree in trees:
888
 
                if not tree.has_or_had_id(file_id):
 
830
                if not tree.has_id(file_id):
889
831
                    continue
890
832
                for child_id in tree.iter_children(file_id):
891
833
                    if child_id not in interesting_ids:
906
848
    will pass through to InterTree as appropriate.
907
849
    """
908
850
 
909
 
    # Formats that will be used to test this InterTree. If both are
910
 
    # None, this InterTree will not be tested (e.g. because a complex
911
 
    # setup is required)
912
 
    _matching_from_tree_format = None
913
 
    _matching_to_tree_format = None
914
 
 
915
851
    _optimisers = []
916
852
 
917
 
    @classmethod
918
 
    def is_compatible(kls, source, target):
919
 
        # The default implementation is naive and uses the public API, so
920
 
        # it works for all trees.
921
 
        return True
922
 
 
923
 
    def _changes_from_entries(self, source_entry, target_entry,
924
 
        source_path=None, target_path=None):
925
 
        """Generate a iter_changes tuple between source_entry and target_entry.
926
 
 
927
 
        :param source_entry: An inventory entry from self.source, or None.
928
 
        :param target_entry: An inventory entry from self.target, or None.
929
 
        :param source_path: The path of source_entry, if known. If not known
930
 
            it will be looked up.
931
 
        :param target_path: The path of target_entry, if known. If not known
932
 
            it will be looked up.
933
 
        :return: A tuple, item 0 of which is an iter_changes result tuple, and
934
 
            item 1 is True if there are any changes in the result tuple.
935
 
        """
936
 
        if source_entry is None:
937
 
            if target_entry is None:
938
 
                return None
939
 
            file_id = target_entry.file_id
940
 
        else:
941
 
            file_id = source_entry.file_id
942
 
        if source_entry is not None:
943
 
            source_versioned = True
944
 
            source_name = source_entry.name
945
 
            source_parent = source_entry.parent_id
946
 
            if source_path is None:
947
 
                source_path = self.source.id2path(file_id)
948
 
            source_kind, source_executable, source_stat = \
949
 
                self.source._comparison_data(source_entry, source_path)
950
 
        else:
951
 
            source_versioned = False
952
 
            source_name = None
953
 
            source_parent = None
954
 
            source_kind = None
955
 
            source_executable = None
956
 
        if target_entry is not None:
957
 
            target_versioned = True
958
 
            target_name = target_entry.name
959
 
            target_parent = target_entry.parent_id
960
 
            if target_path is None:
961
 
                target_path = self.target.id2path(file_id)
962
 
            target_kind, target_executable, target_stat = \
963
 
                self.target._comparison_data(target_entry, target_path)
964
 
        else:
965
 
            target_versioned = False
966
 
            target_name = None
967
 
            target_parent = None
968
 
            target_kind = None
969
 
            target_executable = None
970
 
        versioned = (source_versioned, target_versioned)
971
 
        kind = (source_kind, target_kind)
972
 
        changed_content = False
973
 
        if source_kind != target_kind:
974
 
            changed_content = True
975
 
        elif source_kind == 'file':
976
 
            if not self.file_content_matches(file_id, file_id, source_path,
977
 
                    target_path, source_stat, target_stat):
978
 
                changed_content = True
979
 
        elif source_kind == 'symlink':
980
 
            if (self.source.get_symlink_target(file_id) !=
981
 
                self.target.get_symlink_target(file_id)):
982
 
                changed_content = True
983
 
            # XXX: Yes, the indentation below is wrong. But fixing it broke
984
 
            # test_merge.TestMergerEntriesLCAOnDisk.
985
 
            # test_nested_tree_subtree_renamed_and_modified. We'll wait for
986
 
            # the fix from bzr.dev -- vila 2009026
987
 
            elif source_kind == 'tree-reference':
988
 
                if (self.source.get_reference_revision(file_id, source_path)
989
 
                    != self.target.get_reference_revision(file_id, target_path)):
990
 
                    changed_content = True
991
 
        parent = (source_parent, target_parent)
992
 
        name = (source_name, target_name)
993
 
        executable = (source_executable, target_executable)
994
 
        if (changed_content is not False or versioned[0] != versioned[1]
995
 
            or parent[0] != parent[1] or name[0] != name[1] or
996
 
            executable[0] != executable[1]):
997
 
            changes = True
998
 
        else:
999
 
            changes = False
1000
 
        return (file_id, (source_path, target_path), changed_content,
1001
 
                versioned, parent, name, kind, executable), changes
1002
 
 
1003
853
    @needs_read_lock
1004
854
    def compare(self, want_unchanged=False, specific_files=None,
1005
855
        extra_trees=None, require_versioned=False, include_root=False,
1020
870
            a PathsNotVersionedError will be thrown.
1021
871
        :param want_unversioned: Scan for unversioned paths.
1022
872
        """
 
873
        # NB: show_status depends on being able to pass in non-versioned files
 
874
        # and report them as unknown
1023
875
        trees = (self.source,)
1024
876
        if extra_trees is not None:
1025
877
            trees = trees + tuple(extra_trees)
1030
882
            # All files are unversioned, so just return an empty delta
1031
883
            # _compare_trees would think we want a complete delta
1032
884
            result = delta.TreeDelta()
1033
 
            fake_entry = inventory.InventoryFile('unused', 'unused', 'unused')
 
885
            fake_entry = InventoryFile('unused', 'unused', 'unused')
1034
886
            result.unversioned = [(path, None,
1035
887
                self.target._comparison_data(fake_entry, path)[0]) for path in
1036
888
                specific_files]
1066
918
        :param require_versioned: Raise errors.PathsNotVersionedError if a
1067
919
            path in the specific_files list is not versioned in one of
1068
920
            source, target or extra_trees.
1069
 
        :param specific_files: An optional list of file paths to restrict the
1070
 
            comparison to. When mapping filenames to ids, all matches in all
1071
 
            trees (including optional extra_trees) are used, and all children
1072
 
            of matched directories are included. The parents in the target tree
1073
 
            of the specific files up to and including the root of the tree are
1074
 
            always evaluated for changes too.
1075
921
        :param want_unversioned: Should unversioned files be returned in the
1076
922
            output. An unversioned file is defined as one with (False, False)
1077
923
            for the versioned pair.
1079
925
        lookup_trees = [self.source]
1080
926
        if extra_trees:
1081
927
             lookup_trees.extend(extra_trees)
1082
 
        # The ids of items we need to examine to insure delta consistency.
1083
 
        precise_file_ids = set()
1084
 
        changed_file_ids = []
1085
928
        if specific_files == []:
1086
929
            specific_file_ids = []
1087
930
        else:
1088
931
            specific_file_ids = self.target.paths2ids(specific_files,
1089
932
                lookup_trees, require_versioned=require_versioned)
1090
 
        if specific_files is not None:
1091
 
            # reparented or added entries must have their parents included
1092
 
            # so that valid deltas can be created. The seen_parents set
1093
 
            # tracks the parents that we need to have.
1094
 
            # The seen_dirs set tracks directory entries we've yielded.
1095
 
            # After outputting version object in to_entries we set difference
1096
 
            # the two seen sets and start checking parents.
1097
 
            seen_parents = set()
1098
 
            seen_dirs = set()
1099
933
        if want_unversioned:
1100
934
            all_unversioned = sorted([(p.split('/'), p) for p in
1101
935
                                     self.target.extras()
1102
936
                if specific_files is None or
1103
937
                    osutils.is_inside_any(specific_files, p)])
1104
 
            all_unversioned = collections.deque(all_unversioned)
 
938
            all_unversioned = deque(all_unversioned)
1105
939
        else:
1106
 
            all_unversioned = collections.deque()
 
940
            all_unversioned = deque()
1107
941
        to_paths = {}
1108
942
        from_entries_by_dir = list(self.source.iter_entries_by_dir(
1109
943
            specific_file_ids=specific_file_ids))
1115
949
        # the unversioned path lookup only occurs on real trees - where there
1116
950
        # can be extras. So the fake_entry is solely used to look up
1117
951
        # executable it values when execute is not supported.
1118
 
        fake_entry = inventory.InventoryFile('unused', 'unused', 'unused')
1119
 
        for target_path, target_entry in to_entries_by_dir:
1120
 
            while (all_unversioned and
1121
 
                all_unversioned[0][0] < target_path.split('/')):
 
952
        fake_entry = InventoryFile('unused', 'unused', 'unused')
 
953
        for to_path, to_entry in to_entries_by_dir:
 
954
            while all_unversioned and all_unversioned[0][0] < to_path.split('/'):
1122
955
                unversioned_path = all_unversioned.popleft()
1123
 
                target_kind, target_executable, target_stat = \
 
956
                to_kind, to_executable, to_stat = \
1124
957
                    self.target._comparison_data(fake_entry, unversioned_path[1])
1125
958
                yield (None, (None, unversioned_path[1]), True, (False, False),
1126
959
                    (None, None),
1127
960
                    (None, unversioned_path[0][-1]),
1128
 
                    (None, target_kind),
1129
 
                    (None, target_executable))
1130
 
            source_path, source_entry = from_data.get(target_entry.file_id,
1131
 
                (None, None))
1132
 
            result, changes = self._changes_from_entries(source_entry,
1133
 
                target_entry, source_path=source_path, target_path=target_path)
1134
 
            to_paths[result[0]] = result[1][1]
 
961
                    (None, to_kind),
 
962
                    (None, to_executable))
 
963
            file_id = to_entry.file_id
 
964
            to_paths[file_id] = to_path
1135
965
            entry_count += 1
1136
 
            if result[3][0]:
 
966
            changed_content = False
 
967
            from_path, from_entry = from_data.get(file_id, (None, None))
 
968
            from_versioned = (from_entry is not None)
 
969
            if from_entry is not None:
 
970
                from_versioned = True
 
971
                from_name = from_entry.name
 
972
                from_parent = from_entry.parent_id
 
973
                from_kind, from_executable, from_stat = \
 
974
                    self.source._comparison_data(from_entry, from_path)
1137
975
                entry_count += 1
 
976
            else:
 
977
                from_versioned = False
 
978
                from_kind = None
 
979
                from_parent = None
 
980
                from_name = None
 
981
                from_executable = None
 
982
            versioned = (from_versioned, True)
 
983
            to_kind, to_executable, to_stat = \
 
984
                self.target._comparison_data(to_entry, to_path)
 
985
            kind = (from_kind, to_kind)
 
986
            if kind[0] != kind[1]:
 
987
                changed_content = True
 
988
            elif from_kind == 'file':
 
989
                if (self.source.get_file_sha1(file_id, from_path, from_stat) !=
 
990
                    self.target.get_file_sha1(file_id, to_path, to_stat)):
 
991
                    changed_content = True
 
992
            elif from_kind == 'symlink':
 
993
                if (self.source.get_symlink_target(file_id) !=
 
994
                    self.target.get_symlink_target(file_id)):
 
995
                    changed_content = True
 
996
                # XXX: Yes, the indentation below is wrong. But fixing it broke
 
997
                # test_merge.TestMergerEntriesLCAOnDisk.
 
998
                # test_nested_tree_subtree_renamed_and_modified. We'll wait for
 
999
                # the fix from bzr.dev -- vila 2009026
 
1000
                elif from_kind == 'tree-reference':
 
1001
                    if (self.source.get_reference_revision(file_id, from_path)
 
1002
                        != self.target.get_reference_revision(file_id, to_path)):
 
1003
                        changed_content = True
 
1004
            parent = (from_parent, to_entry.parent_id)
 
1005
            name = (from_name, to_entry.name)
 
1006
            executable = (from_executable, to_executable)
1138
1007
            if pb is not None:
1139
1008
                pb.update('comparing files', entry_count, num_entries)
1140
 
            if changes or include_unchanged:
1141
 
                if specific_file_ids is not None:
1142
 
                    new_parent_id = result[4][1]
1143
 
                    precise_file_ids.add(new_parent_id)
1144
 
                    changed_file_ids.append(result[0])
1145
 
                yield result
1146
 
            # Ensure correct behaviour for reparented/added specific files.
1147
 
            if specific_files is not None:
1148
 
                # Record output dirs
1149
 
                if result[6][1] == 'directory':
1150
 
                    seen_dirs.add(result[0])
1151
 
                # Record parents of reparented/added entries.
1152
 
                versioned = result[3]
1153
 
                parents = result[4]
1154
 
                if not versioned[0] or parents[0] != parents[1]:
1155
 
                    seen_parents.add(parents[1])
 
1009
            if (changed_content is not False or versioned[0] != versioned[1]
 
1010
                or parent[0] != parent[1] or name[0] != name[1] or
 
1011
                executable[0] != executable[1] or include_unchanged):
 
1012
                yield (file_id, (from_path, to_path), changed_content,
 
1013
                    versioned, parent, name, kind, executable)
 
1014
 
1156
1015
        while all_unversioned:
1157
1016
            # yield any trailing unversioned paths
1158
1017
            unversioned_path = all_unversioned.popleft()
1163
1022
                (None, unversioned_path[0][-1]),
1164
1023
                (None, to_kind),
1165
1024
                (None, to_executable))
1166
 
        # Yield all remaining source paths
 
1025
 
 
1026
        def get_to_path(to_entry):
 
1027
            if to_entry.parent_id is None:
 
1028
                to_path = '' # the root
 
1029
            else:
 
1030
                if to_entry.parent_id not in to_paths:
 
1031
                    # recurse up
 
1032
                    return get_to_path(self.target.inventory[to_entry.parent_id])
 
1033
                to_path = osutils.pathjoin(to_paths[to_entry.parent_id],
 
1034
                                           to_entry.name)
 
1035
            to_paths[to_entry.file_id] = to_path
 
1036
            return to_path
 
1037
 
1167
1038
        for path, from_entry in from_entries_by_dir:
1168
1039
            file_id = from_entry.file_id
1169
1040
            if file_id in to_paths:
1170
1041
                # already returned
1171
1042
                continue
1172
 
            if not self.target.has_id(file_id):
 
1043
            if not file_id in self.target.all_file_ids():
1173
1044
                # common case - paths we have not emitted are not present in
1174
1045
                # target.
1175
1046
                to_path = None
1176
1047
            else:
1177
 
                to_path = self.target.id2path(file_id)
 
1048
                to_path = get_to_path(self.target.inventory[file_id])
1178
1049
            entry_count += 1
1179
1050
            if pb is not None:
1180
1051
                pb.update('comparing files', entry_count, num_entries)
1187
1058
            executable = (from_executable, None)
1188
1059
            changed_content = from_kind is not None
1189
1060
            # the parent's path is necessarily known at this point.
1190
 
            changed_file_ids.append(file_id)
1191
1061
            yield(file_id, (path, to_path), changed_content, versioned, parent,
1192
1062
                  name, kind, executable)
1193
 
        changed_file_ids = set(changed_file_ids)
1194
 
        if specific_file_ids is not None:
1195
 
            for result in self._handle_precise_ids(precise_file_ids,
1196
 
                changed_file_ids):
1197
 
                yield result
1198
 
 
1199
 
    def _get_entry(self, tree, file_id):
1200
 
        """Get an inventory entry from a tree, with missing entries as None.
1201
 
 
1202
 
        If the tree raises NotImplementedError on accessing .inventory, then
1203
 
        this is worked around using iter_entries_by_dir on just the file id
1204
 
        desired.
1205
 
 
1206
 
        :param tree: The tree to lookup the entry in.
1207
 
        :param file_id: The file_id to lookup.
1208
 
        """
1209
 
        try:
1210
 
            inventory = tree.inventory
1211
 
        except NotImplementedError:
1212
 
            # No inventory available.
1213
 
            try:
1214
 
                iterator = tree.iter_entries_by_dir(specific_file_ids=[file_id])
1215
 
                return iterator.next()[1]
1216
 
            except StopIteration:
1217
 
                return None
1218
 
        else:
1219
 
            try:
1220
 
                return inventory[file_id]
1221
 
            except errors.NoSuchId:
1222
 
                return None
1223
 
 
1224
 
    def _handle_precise_ids(self, precise_file_ids, changed_file_ids,
1225
 
        discarded_changes=None):
1226
 
        """Fill out a partial iter_changes to be consistent.
1227
 
 
1228
 
        :param precise_file_ids: The file ids of parents that were seen during
1229
 
            the iter_changes.
1230
 
        :param changed_file_ids: The file ids of already emitted items.
1231
 
        :param discarded_changes: An optional dict of precalculated
1232
 
            iter_changes items which the partial iter_changes had not output
1233
 
            but had calculated.
1234
 
        :return: A generator of iter_changes items to output.
1235
 
        """
1236
 
        # process parents of things that had changed under the users
1237
 
        # requested paths to prevent incorrect paths or parent ids which
1238
 
        # aren't in the tree.
1239
 
        while precise_file_ids:
1240
 
            precise_file_ids.discard(None)
1241
 
            # Don't emit file_ids twice
1242
 
            precise_file_ids.difference_update(changed_file_ids)
1243
 
            if not precise_file_ids:
1244
 
                break
1245
 
            # If the there was something at a given output path in source, we
1246
 
            # have to include the entry from source in the delta, or we would
1247
 
            # be putting this entry into a used path.
1248
 
            paths = []
1249
 
            for parent_id in precise_file_ids:
1250
 
                try:
1251
 
                    paths.append(self.target.id2path(parent_id))
1252
 
                except errors.NoSuchId:
1253
 
                    # This id has been dragged in from the source by delta
1254
 
                    # expansion and isn't present in target at all: we don't
1255
 
                    # need to check for path collisions on it.
1256
 
                    pass
1257
 
            for path in paths:
1258
 
                old_id = self.source.path2id(path)
1259
 
                precise_file_ids.add(old_id)
1260
 
            precise_file_ids.discard(None)
1261
 
            current_ids = precise_file_ids
1262
 
            precise_file_ids = set()
1263
 
            # We have to emit all of precise_file_ids that have been altered.
1264
 
            # We may have to output the children of some of those ids if any
1265
 
            # directories have stopped being directories.
1266
 
            for file_id in current_ids:
1267
 
                # Examine file_id
1268
 
                if discarded_changes:
1269
 
                    result = discarded_changes.get(file_id)
1270
 
                    old_entry = None
1271
 
                else:
1272
 
                    result = None
1273
 
                if result is None:
1274
 
                    old_entry = self._get_entry(self.source, file_id)
1275
 
                    new_entry = self._get_entry(self.target, file_id)
1276
 
                    result, changes = self._changes_from_entries(
1277
 
                        old_entry, new_entry)
1278
 
                else:
1279
 
                    changes = True
1280
 
                # Get this parents parent to examine.
1281
 
                new_parent_id = result[4][1]
1282
 
                precise_file_ids.add(new_parent_id)
1283
 
                if changes:
1284
 
                    if (result[6][0] == 'directory' and
1285
 
                        result[6][1] != 'directory'):
1286
 
                        # This stopped being a directory, the old children have
1287
 
                        # to be included.
1288
 
                        if old_entry is None:
1289
 
                            # Reusing a discarded change.
1290
 
                            old_entry = self._get_entry(self.source, file_id)
1291
 
                        for child in old_entry.children.values():
1292
 
                            precise_file_ids.add(child.file_id)
1293
 
                    changed_file_ids.add(result[0])
1294
 
                    yield result
1295
 
 
1296
 
    @needs_read_lock
1297
 
    def file_content_matches(self, source_file_id, target_file_id,
1298
 
            source_path=None, target_path=None, source_stat=None, target_stat=None):
1299
 
        """Check if two files are the same in the source and target trees.
1300
 
 
1301
 
        This only checks that the contents of the files are the same,
1302
 
        it does not touch anything else.
1303
 
 
1304
 
        :param source_file_id: File id of the file in the source tree
1305
 
        :param target_file_id: File id of the file in the target tree
1306
 
        :param source_path: Path of the file in the source tree
1307
 
        :param target_path: Path of the file in the target tree
1308
 
        :param source_stat: Optional stat value of the file in the source tree
1309
 
        :param target_stat: Optional stat value of the file in the target tree
1310
 
        :return: Boolean indicating whether the files have the same contents
1311
 
        """
1312
 
        source_verifier_kind, source_verifier_data = self.source.get_file_verifier(
1313
 
            source_file_id, source_path, source_stat)
1314
 
        target_verifier_kind, target_verifier_data = self.target.get_file_verifier(
1315
 
            target_file_id, target_path, target_stat)
1316
 
        if source_verifier_kind == target_verifier_kind:
1317
 
            return (source_verifier_data == target_verifier_data)
1318
 
        # Fall back to SHA1 for now
1319
 
        if source_verifier_kind != "SHA1":
1320
 
            source_sha1 = self.source.get_file_sha1(source_file_id,
1321
 
                    source_path, source_stat)
1322
 
        else:
1323
 
            source_sha1 = source_verifier_data
1324
 
        if target_verifier_kind != "SHA1":
1325
 
            target_sha1 = self.target.get_file_sha1(target_file_id,
1326
 
                    target_path, target_stat)
1327
 
        else:
1328
 
            target_sha1 = target_verifier_data
1329
 
        return (source_sha1 == target_sha1)
1330
 
 
1331
 
InterTree.register_optimiser(InterTree)
1332
1063
 
1333
1064
 
1334
1065
class MultiWalker(object):