~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/tree.py

Merge bzr.dev.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005-2010 Canonical Ltd
 
1
# Copyright (C) 2005-2011 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
 
from collections import deque
22
 
 
23
 
import bzrlib
 
21
 
 
22
from bzrlib.lazy_import import lazy_import
 
23
lazy_import(globals(), """
 
24
import collections
 
25
 
24
26
from bzrlib import (
25
27
    conflicts as _mod_conflicts,
26
28
    debug,
27
29
    delta,
 
30
    errors,
28
31
    filters,
 
32
    inventory,
29
33
    osutils,
30
34
    revision as _mod_revision,
31
35
    rules,
 
36
    trace,
32
37
    )
 
38
""")
 
39
 
33
40
from bzrlib.decorators import needs_read_lock
34
 
from bzrlib.errors import BzrError, NoSuchId
35
 
from bzrlib import errors
36
 
from bzrlib.inventory import InventoryFile
37
41
from bzrlib.inter import InterObject
38
 
from bzrlib.osutils import fingerprint_file
39
 
from bzrlib.symbol_versioning import deprecated_function, deprecated_in
40
 
from bzrlib.trace import note
41
42
 
42
43
 
43
44
class Tree(object):
49
50
 
50
51
    * `RevisionTree` is a tree as recorded at some point in the past.
51
52
 
52
 
    Trees contain an `Inventory` object, and also know how to retrieve
53
 
    file texts mentioned in the inventory, either from a working
54
 
    directory or from a store.
55
 
 
56
 
    It is possible for trees to contain files that are not described
57
 
    in their inventory or vice versa; for this use `filenames()`.
58
 
 
59
53
    Trees can be compared, etc, regardless of whether they are working
60
54
    trees or versioned trees.
61
55
    """
127
121
        raise NotImplementedError(self.has_filename)
128
122
 
129
123
    def has_id(self, file_id):
130
 
        return self.inventory.has_id(file_id)
 
124
        raise NotImplementedError(self.has_id)
131
125
 
132
126
    def __contains__(self, file_id):
133
127
        return self.has_id(file_id)
134
128
 
135
129
    def has_or_had_id(self, file_id):
136
 
        return self.inventory.has_id(file_id)
 
130
        raise NotImplementedError(self.has_or_had_id)
137
131
 
138
132
    def is_ignored(self, filename):
139
133
        """Check whether the filename is ignored by this tree.
144
138
        return False
145
139
 
146
140
    def __iter__(self):
147
 
        return iter(self.inventory)
 
141
        """Yield all file ids in this tree."""
 
142
        raise NotImplementedError(self.__iter__)
148
143
 
149
144
    def all_file_ids(self):
150
145
        """Iterate through all file ids, including ids for missing files."""
155
150
 
156
151
        :raises NoSuchId:
157
152
        """
158
 
        return self.inventory.id2path(file_id)
 
153
        raise NotImplementedError(self.id2path)
159
154
 
160
 
    @needs_read_lock
161
155
    def iter_entries_by_dir(self, specific_file_ids=None, yield_parents=False):
162
156
        """Walk the tree in 'by_dir' order.
163
157
 
186
180
            down to specific_file_ids that have been requested. This has no
187
181
            impact if specific_file_ids is None.
188
182
        """
189
 
        return self.inventory.iter_entries_by_dir(
190
 
            specific_file_ids=specific_file_ids, yield_parents=yield_parents)
 
183
        raise NotImplementedError(self.iter_entries_by_dir)
 
184
 
 
185
    def list_files(self, include_root=False, from_dir=None, recursive=True):
 
186
        """List all files in this tree.
 
187
 
 
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,
 
192
            inventory entry)
 
193
        """
 
194
        raise NotImplementedError(self.list_files)
191
195
 
192
196
    def iter_references(self):
193
197
        if self.supports_tree_reference():
244
248
    def _file_size(self, entry, stat_value):
245
249
        raise NotImplementedError(self._file_size)
246
250
 
247
 
    def _get_inventory(self):
248
 
        return self._inventory
249
 
 
250
251
    def get_file(self, file_id, path=None):
251
252
        """Return a file object for the file file_id in the tree.
252
253
 
293
294
        """
294
295
        return osutils.split_lines(self.get_file_text(file_id, path))
295
296
 
 
297
    def get_file_sha1(self, file_id, path=None):
 
298
        """Return the SHA1 file for a file.
 
299
 
 
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.
 
303
        """
 
304
        raise NotImplementedError(self.get_file_sha1)
 
305
 
296
306
    def get_file_mtime(self, file_id, path=None):
297
307
        """Return the modification time for a file.
298
308
 
312
322
        raise NotImplementedError(self.get_file_size)
313
323
 
314
324
    def get_file_by_path(self, path):
315
 
        return self.get_file(self._inventory.path2id(path), path)
 
325
        raise NotImplementedError(self.get_file_by_path)
 
326
 
 
327
    def is_executable(self, file_id, path=None):
 
328
        """Check if a file is executable.
 
329
 
 
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.
 
333
        """
 
334
        raise NotImplementedError(self.is_executable)
316
335
 
317
336
    def iter_files_bytes(self, desired_files):
318
337
        """Iterate through file contents.
350
369
        """
351
370
        raise NotImplementedError(self.get_symlink_target)
352
371
 
353
 
    def get_canonical_inventory_paths(self, paths):
354
 
        """Like get_canonical_inventory_path() but works on multiple items.
355
 
 
356
 
        :param paths: A sequence of paths relative to the root of the tree.
357
 
        :return: A list of paths, with each item the corresponding input path
358
 
        adjusted to account for existing elements that match case
359
 
        insensitively.
360
 
        """
361
 
        return list(self._yield_canonical_inventory_paths(paths))
362
 
 
363
 
    def get_canonical_inventory_path(self, path):
364
 
        """Returns the first inventory item that case-insensitively matches path.
365
 
 
366
 
        If a path matches exactly, it is returned. If no path matches exactly
367
 
        but more than one path matches case-insensitively, it is implementation
368
 
        defined which is returned.
369
 
 
370
 
        If no path matches case-insensitively, the input path is returned, but
371
 
        with as many path entries that do exist changed to their canonical
372
 
        form.
373
 
 
374
 
        If you need to resolve many names from the same tree, you should
375
 
        use get_canonical_inventory_paths() to avoid O(N) behaviour.
376
 
 
377
 
        :param path: A paths relative to the root of the tree.
378
 
        :return: The input path adjusted to account for existing elements
379
 
        that match case insensitively.
380
 
        """
381
 
        return self._yield_canonical_inventory_paths([path]).next()
382
 
 
383
 
    def _yield_canonical_inventory_paths(self, paths):
384
 
        for path in paths:
385
 
            # First, if the path as specified exists exactly, just use it.
386
 
            if self.path2id(path) is not None:
387
 
                yield path
388
 
                continue
389
 
            # go walkin...
390
 
            cur_id = self.get_root_id()
391
 
            cur_path = ''
392
 
            bit_iter = iter(path.split("/"))
393
 
            for elt in bit_iter:
394
 
                lelt = elt.lower()
395
 
                new_path = None
396
 
                for child in self.iter_children(cur_id):
397
 
                    try:
398
 
                        # XXX: it seem like if the child is known to be in the
399
 
                        # tree, we shouldn't need to go from its id back to
400
 
                        # its path -- mbp 2010-02-11
401
 
                        #
402
 
                        # XXX: it seems like we could be more efficient
403
 
                        # by just directly looking up the original name and
404
 
                        # only then searching all children; also by not
405
 
                        # chopping paths so much. -- mbp 2010-02-11
406
 
                        child_base = os.path.basename(self.id2path(child))
407
 
                        if (child_base == elt):
408
 
                            # if we found an exact match, we can stop now; if
409
 
                            # we found an approximate match we need to keep
410
 
                            # searching because there might be an exact match
411
 
                            # later.  
412
 
                            cur_id = child
413
 
                            new_path = osutils.pathjoin(cur_path, child_base)
414
 
                            break
415
 
                        elif child_base.lower() == lelt:
416
 
                            cur_id = child
417
 
                            new_path = osutils.pathjoin(cur_path, child_base)
418
 
                    except NoSuchId:
419
 
                        # before a change is committed we can see this error...
420
 
                        continue
421
 
                if new_path:
422
 
                    cur_path = new_path
423
 
                else:
424
 
                    # got to the end of this directory and no entries matched.
425
 
                    # Return what matched so far, plus the rest as specified.
426
 
                    cur_path = osutils.pathjoin(cur_path, elt, *list(bit_iter))
427
 
                    break
428
 
            yield cur_path
429
 
        # all done.
430
372
 
431
373
    def get_root_id(self):
432
374
        """Return the file_id for the root of this tree."""
491
433
            except errors.NoSuchRevisionInTree:
492
434
                yield self.repository.revision_tree(revision_id)
493
435
 
494
 
    @staticmethod
495
 
    def _file_revision(revision_tree, file_id):
496
 
        """Determine the revision associated with a file in a given tree."""
497
 
        revision_tree.lock_read()
498
 
        try:
499
 
            return revision_tree.inventory[file_id].revision
500
 
        finally:
501
 
            revision_tree.unlock()
502
 
 
503
436
    def _get_file_revision(self, file_id, vf, tree_revision):
504
437
        """Ensure that file_id, tree_revision is in vf to plan the merge."""
505
438
 
506
439
        if getattr(self, '_repository', None) is None:
507
440
            last_revision = tree_revision
508
 
            parent_keys = [(file_id, self._file_revision(t, file_id)) for t in
 
441
            parent_keys = [(file_id, t.get_file_revision(file_id)) for t in
509
442
                self._iter_parent_trees()]
510
443
            vf.add_lines((file_id, last_revision), parent_keys,
511
444
                         self.get_file_lines(file_id))
512
445
            repo = self.branch.repository
513
446
            base_vf = repo.texts
514
447
        else:
515
 
            last_revision = self._file_revision(self, file_id)
 
448
            last_revision = self.get_file_revision(file_id)
516
449
            base_vf = self._repository.texts
517
450
        if base_vf not in vf.fallback_versionedfiles:
518
451
            vf.fallback_versionedfiles.append(base_vf)
519
452
        return last_revision
520
453
 
521
 
    inventory = property(_get_inventory,
522
 
                         doc="Inventory of this Tree")
523
 
 
524
454
    def _check_retrieved(self, ie, f):
525
455
        if not __debug__:
526
456
            return
527
 
        fp = fingerprint_file(f)
 
457
        fp = osutils.fingerprint_file(f)
528
458
        f.seek(0)
529
459
 
530
460
        if ie.text_size is not None:
531
461
            if ie.text_size != fp['size']:
532
 
                raise BzrError("mismatched size for file %r in %r" % (ie.file_id, self._store),
 
462
                raise errors.BzrError(
 
463
                        "mismatched size for file %r in %r" %
 
464
                        (ie.file_id, self._store),
533
465
                        ["inventory expects %d bytes" % ie.text_size,
534
466
                         "file is actually %d bytes" % fp['size'],
535
467
                         "store is probably damaged/corrupt"])
536
468
 
537
469
        if ie.text_sha1 != fp['sha1']:
538
 
            raise BzrError("wrong SHA-1 for file %r in %r" % (ie.file_id, self._store),
 
470
            raise errors.BzrError("wrong SHA-1 for file %r in %r" %
 
471
                    (ie.file_id, self._store),
539
472
                    ["inventory expects %s" % ie.text_sha1,
540
473
                     "file is actually %s" % fp['sha1'],
541
474
                     "store is probably damaged/corrupt"])
542
475
 
543
 
    @needs_read_lock
544
476
    def path2id(self, path):
545
477
        """Return the id for path in this tree."""
546
 
        return self._inventory.path2id(path)
 
478
        raise NotImplementedError(self.path2id)
547
479
 
548
480
    def paths2ids(self, paths, trees=[], require_versioned=True):
549
481
        """Return all the ids that can be reached by walking from paths.
606
538
 
607
539
        :return: set of paths.
608
540
        """
609
 
        # NB: we specifically *don't* call self.has_filename, because for
610
 
        # WorkingTrees that can indicate files that exist on disk but that
611
 
        # are not versioned.
612
 
        pred = self.inventory.has_filename
613
 
        return set((p for p in paths if not pred(p)))
 
541
        raise NotImplementedError(self.filter_unversioned_files)
614
542
 
615
543
    def walkdirs(self, prefix=""):
616
544
        """Walk the contents of this tree from path down.
668
596
        prefs = self.iter_search_rules([path], filter_pref_names).next()
669
597
        stk = filters._get_filter_stack_for(prefs)
670
598
        if 'filters' in debug.debug_flags:
671
 
            note("*** %s content-filter: %s => %r" % (path,prefs,stk))
 
599
            trace.note("*** %s content-filter: %s => %r" % (path,prefs,stk))
672
600
        return stk
673
601
 
674
602
    def _content_filter_stack_provider(self):
713
641
        return searcher
714
642
 
715
643
 
 
644
class InventoryTree(Tree):
 
645
    """A tree that relies on an inventory for its metadata.
 
646
 
 
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.
 
650
 
 
651
    It is possible for trees to contain files that are not described
 
652
    in their inventory or vice versa; for this use `filenames()`.
 
653
 
 
654
    Subclasses should set the _inventory attribute, which is considered
 
655
    private to external API users.
 
656
    """
 
657
 
 
658
    def get_canonical_inventory_paths(self, paths):
 
659
        """Like get_canonical_inventory_path() but works on multiple items.
 
660
 
 
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
 
664
        insensitively.
 
665
        """
 
666
        return list(self._yield_canonical_inventory_paths(paths))
 
667
 
 
668
    def get_canonical_inventory_path(self, path):
 
669
        """Returns the first inventory item that case-insensitively matches path.
 
670
 
 
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.
 
674
 
 
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
 
677
        form.
 
678
 
 
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.
 
681
 
 
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.
 
685
        """
 
686
        return self._yield_canonical_inventory_paths([path]).next()
 
687
 
 
688
    def _yield_canonical_inventory_paths(self, paths):
 
689
        for path in paths:
 
690
            # First, if the path as specified exists exactly, just use it.
 
691
            if self.path2id(path) is not None:
 
692
                yield path
 
693
                continue
 
694
            # go walkin...
 
695
            cur_id = self.get_root_id()
 
696
            cur_path = ''
 
697
            bit_iter = iter(path.split("/"))
 
698
            for elt in bit_iter:
 
699
                lelt = elt.lower()
 
700
                new_path = None
 
701
                for child in self.iter_children(cur_id):
 
702
                    try:
 
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
 
706
                        #
 
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
 
716
                            # later.  
 
717
                            cur_id = child
 
718
                            new_path = osutils.pathjoin(cur_path, child_base)
 
719
                            break
 
720
                        elif child_base.lower() == lelt:
 
721
                            cur_id = child
 
722
                            new_path = osutils.pathjoin(cur_path, child_base)
 
723
                    except errors.NoSuchId:
 
724
                        # before a change is committed we can see this error...
 
725
                        continue
 
726
                if new_path:
 
727
                    cur_path = new_path
 
728
                else:
 
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))
 
732
                    break
 
733
            yield cur_path
 
734
        # all done.
 
735
 
 
736
    def _get_inventory(self):
 
737
        return self._inventory
 
738
 
 
739
    inventory = property(_get_inventory,
 
740
                         doc="Inventory of this Tree")
 
741
 
 
742
    @needs_read_lock
 
743
    def path2id(self, path):
 
744
        """Return the id for path in this tree."""
 
745
        return self._inventory.path2id(path)
 
746
 
 
747
    def id2path(self, file_id):
 
748
        """Return the path for a file id.
 
749
 
 
750
        :raises NoSuchId:
 
751
        """
 
752
        return self.inventory.id2path(file_id)
 
753
 
 
754
    def has_id(self, file_id):
 
755
        return self.inventory.has_id(file_id)
 
756
 
 
757
    def has_or_had_id(self, file_id):
 
758
        return self.inventory.has_id(file_id)
 
759
 
 
760
    def __iter__(self):
 
761
        return iter(self.inventory)
 
762
 
 
763
    def filter_unversioned_files(self, paths):
 
764
        """Filter out paths that are versioned.
 
765
 
 
766
        :return: set of paths.
 
767
        """
 
768
        # NB: we specifically *don't* call self.has_filename, because for
 
769
        # WorkingTrees that can indicate files that exist on disk but that
 
770
        # are not versioned.
 
771
        pred = self.inventory.has_filename
 
772
        return set((p for p in paths if not pred(p)))
 
773
 
 
774
    @needs_read_lock
 
775
    def iter_entries_by_dir(self, specific_file_ids=None, yield_parents=False):
 
776
        """Walk the tree in 'by_dir' order.
 
777
 
 
778
        This will yield each entry in the tree as a (path, entry) tuple.
 
779
        The order that they are yielded is:
 
780
 
 
781
        See Tree.iter_entries_by_dir for details.
 
782
 
 
783
        :param yield_parents: If True, yield the parents from the root leading
 
784
            down to specific_file_ids that have been requested. This has no
 
785
            impact if specific_file_ids is None.
 
786
        """
 
787
        return self.inventory.iter_entries_by_dir(
 
788
            specific_file_ids=specific_file_ids, yield_parents=yield_parents)
 
789
 
 
790
    def get_file_by_path(self, path):
 
791
        return self.get_file(self._inventory.path2id(path), path)
 
792
 
 
793
 
716
794
######################################################################
717
795
# diff
718
796
 
968
1046
            # All files are unversioned, so just return an empty delta
969
1047
            # _compare_trees would think we want a complete delta
970
1048
            result = delta.TreeDelta()
971
 
            fake_entry = InventoryFile('unused', 'unused', 'unused')
 
1049
            fake_entry = inventory.InventoryFile('unused', 'unused', 'unused')
972
1050
            result.unversioned = [(path, None,
973
1051
                self.target._comparison_data(fake_entry, path)[0]) for path in
974
1052
                specific_files]
1039
1117
                                     self.target.extras()
1040
1118
                if specific_files is None or
1041
1119
                    osutils.is_inside_any(specific_files, p)])
1042
 
            all_unversioned = deque(all_unversioned)
 
1120
            all_unversioned = collections.deque(all_unversioned)
1043
1121
        else:
1044
 
            all_unversioned = deque()
 
1122
            all_unversioned = collections.deque()
1045
1123
        to_paths = {}
1046
1124
        from_entries_by_dir = list(self.source.iter_entries_by_dir(
1047
1125
            specific_file_ids=specific_file_ids))
1053
1131
        # the unversioned path lookup only occurs on real trees - where there
1054
1132
        # can be extras. So the fake_entry is solely used to look up
1055
1133
        # executable it values when execute is not supported.
1056
 
        fake_entry = InventoryFile('unused', 'unused', 'unused')
 
1134
        fake_entry = inventory.InventoryFile('unused', 'unused', 'unused')
1057
1135
        for target_path, target_entry in to_entries_by_dir:
1058
1136
            while (all_unversioned and
1059
1137
                all_unversioned[0][0] < target_path.split('/')):