~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/workingtree.py

  • Committer: John Arbash Meinel
  • Date: 2011-05-11 11:35:28 UTC
  • mto: This revision was merged to the branch mainline in revision 5851.
  • Revision ID: john@arbash-meinel.com-20110511113528-qepibuwxicjrbb2h
Break compatibility with python <2.6.

This includes auditing the code for places where we were doing
explicit 'sys.version' checks and removing them as appropriate.

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
44
44
import stat
45
45
import re
46
46
 
47
 
import bzrlib
48
47
from bzrlib import (
49
48
    branch,
50
49
    bzrdir,
51
50
    conflicts as _mod_conflicts,
52
51
    controldir,
53
52
    errors,
 
53
    filters as _mod_filters,
54
54
    generate_ids,
55
55
    globbing,
56
56
    graph as _mod_graph,
60
60
    merge,
61
61
    revision as _mod_revision,
62
62
    revisiontree,
63
 
    trace,
 
63
    rio as _mod_rio,
64
64
    transform,
65
65
    transport,
66
66
    ui,
68
68
    xml5,
69
69
    xml7,
70
70
    )
71
 
from bzrlib.workingtree_4 import (
72
 
    WorkingTreeFormat4,
73
 
    WorkingTreeFormat5,
74
 
    WorkingTreeFormat6,
75
 
    )
76
71
""")
77
72
 
78
73
from bzrlib import symbol_versioning
79
74
from bzrlib.decorators import needs_read_lock, needs_write_lock
80
75
from bzrlib.lock import LogicalLockResult
81
 
from bzrlib.lockable_files import LockableFiles
82
 
from bzrlib.lockdir import LockDir
83
76
import bzrlib.mutabletree
84
77
from bzrlib.mutabletree import needs_tree_write_lock
85
78
from bzrlib import osutils
93
86
    splitpath,
94
87
    supports_executable,
95
88
    )
96
 
from bzrlib.filters import filtered_input_file
97
89
from bzrlib.trace import mutter, note
98
 
from bzrlib.transport.local import LocalTransport
99
90
from bzrlib.revision import CURRENT_REVISION
100
 
from bzrlib.rio import RioReader, rio_file, Stanza
101
91
from bzrlib.symbol_versioning import (
102
92
    deprecated_passed,
103
93
    DEPRECATED_PARAMETER,
172
162
    controldir.ControlComponent):
173
163
    """Working copy tree.
174
164
 
175
 
    The inventory is held in the `Branch` working-inventory, and the
176
 
    files are in a directory on disk.
177
 
 
178
 
    It is possible for a `WorkingTree` to have a filename which is
179
 
    not listed in the Inventory and vice versa.
180
 
 
181
165
    :ivar basedir: The root of the tree on disk. This is a unicode path object
182
166
        (as opposed to a URL).
183
167
    """
188
172
 
189
173
    def __init__(self, basedir='.',
190
174
                 branch=DEPRECATED_PARAMETER,
191
 
                 _inventory=None,
192
175
                 _control_files=None,
193
176
                 _internal=False,
194
177
                 _format=None,
209
192
        else:
210
193
            self._branch = self.bzrdir.open_branch()
211
194
        self.basedir = realpath(basedir)
212
 
        # if branch is at our basedir and is a format 6 or less
213
 
        if isinstance(self._format, WorkingTreeFormat2):
214
 
            # share control object
215
 
            self._control_files = self.branch.control_files
216
 
        else:
217
 
            # assume all other formats have their own control files.
218
 
            self._control_files = _control_files
 
195
        self._control_files = _control_files
219
196
        self._transport = self._control_files._transport
220
197
        # update the whole cache up front and write to disk if anything changed;
221
198
        # in the future we might want to do this more selectively
237
214
            mutter("write hc")
238
215
            hc.write()
239
216
 
240
 
        if _inventory is None:
241
 
            # This will be acquired on lock_read() or lock_write()
242
 
            self._inventory_is_modified = False
243
 
            self._inventory = None
244
 
        else:
245
 
            # the caller of __init__ has provided an inventory,
246
 
            # we assume they know what they are doing - as its only
247
 
            # the Format factory and creation methods that are
248
 
            # permitted to do this.
249
 
            self._set_inventory(_inventory, dirty=False)
250
217
        self._detect_case_handling()
251
218
        self._rules_searcher = None
252
219
        self.views = self._make_views()
259
226
    def control_transport(self):
260
227
        return self._transport
261
228
 
 
229
    def is_control_filename(self, filename):
 
230
        """True if filename is the name of a control file in this tree.
 
231
 
 
232
        :param filename: A filename within the tree. This is a relative path
 
233
        from the root of this tree.
 
234
 
 
235
        This is true IF and ONLY IF the filename is part of the meta data
 
236
        that bzr controls in this tree. I.E. a random .bzr directory placed
 
237
        on disk will not be a control file for this tree.
 
238
        """
 
239
        return self.bzrdir.is_control_filename(filename)
 
240
 
262
241
    def _detect_case_handling(self):
263
242
        wt_trans = self.bzrdir.get_workingtree_transport(None)
264
243
        try:
265
 
            wt_trans.stat("FoRMaT")
 
244
            wt_trans.stat(self._format.case_sensitive_filename)
266
245
        except errors.NoSuchFile:
267
246
            self.case_sensitive = True
268
247
        else:
311
290
    def supports_views(self):
312
291
        return self.views.supports_views()
313
292
 
314
 
    def _set_inventory(self, inv, dirty):
315
 
        """Set the internal cached inventory.
316
 
 
317
 
        :param inv: The inventory to set.
318
 
        :param dirty: A boolean indicating whether the inventory is the same
319
 
            logical inventory as whats on disk. If True the inventory is not
320
 
            the same and should be written to disk or data will be lost, if
321
 
            False then the inventory is the same as that on disk and any
322
 
            serialisation would be unneeded overhead.
323
 
        """
324
 
        self._inventory = inv
325
 
        self._inventory_is_modified = dirty
326
 
 
327
293
    @staticmethod
328
294
    def open(path=None, _unsupported=False):
329
295
        """Open an existing working tree at path.
353
319
        return control.open_workingtree(), relpath
354
320
 
355
321
    @staticmethod
356
 
    def open_containing_paths(file_list, default_directory='.',
357
 
        canonicalize=True, apply_view=True):
 
322
    def open_containing_paths(file_list, default_directory=None,
 
323
                              canonicalize=True, apply_view=True):
358
324
        """Open the WorkingTree that contains a set of paths.
359
325
 
360
326
        Fail if the paths given are not all in a single tree.
362
328
        This is used for the many command-line interfaces that take a list of
363
329
        any number of files and that require they all be in the same tree.
364
330
        """
 
331
        if default_directory is None:
 
332
            default_directory = u'.'
365
333
        # recommended replacement for builtins.internal_tree_files
366
334
        if file_list is None or len(file_list) == 0:
367
335
            tree = WorkingTree.open_containing(default_directory)[0]
375
343
                    view_str = views.view_display_str(view_files)
376
344
                    note("Ignoring files outside view. View is %s" % view_str)
377
345
            return tree, file_list
378
 
        tree = WorkingTree.open_containing(file_list[0])[0]
 
346
        if default_directory == u'.':
 
347
            seed = file_list[0]
 
348
        else:
 
349
            seed = default_directory
 
350
            file_list = [osutils.pathjoin(default_directory, f)
 
351
                         for f in file_list]
 
352
        tree = WorkingTree.open_containing(seed)[0]
379
353
        return tree, tree.safe_relpath_files(file_list, canonicalize,
380
 
            apply_view=apply_view)
 
354
                                             apply_view=apply_view)
381
355
 
382
356
    def safe_relpath_files(self, file_list, canonicalize=True, apply_view=True):
383
357
        """Convert file_list into a list of relpaths in tree.
434
408
                                              list_current=list_current)
435
409
        return [tr for tr in iterator if tr is not None]
436
410
 
437
 
    # should be deprecated - this is slow and in any case treating them as a
438
 
    # container is (we now know) bad style -- mbp 20070302
439
 
    ## @deprecated_method(zero_fifteen)
440
 
    def __iter__(self):
441
 
        """Iterate through file_ids for this tree.
442
 
 
443
 
        file_ids are in a WorkingTree if they are in the working inventory
444
 
        and the working file exists.
445
 
        """
446
 
        inv = self._inventory
447
 
        for path, ie in inv.iter_entries():
448
 
            if osutils.lexists(self.abspath(path)):
449
 
                yield ie.file_id
450
 
 
451
411
    def all_file_ids(self):
452
412
        """See Tree.iter_all_file_ids"""
453
 
        return set(self.inventory)
 
413
        raise NotImplementedError(self.all_file_ids)
454
414
 
455
415
    def __repr__(self):
456
416
        return "<%s of %s>" % (self.__class__.__name__,
511
471
        return self.get_file_with_stat(file_id, path, filtered=filtered)[0]
512
472
 
513
473
    def get_file_with_stat(self, file_id, path=None, filtered=True,
514
 
        _fstat=os.fstat):
 
474
                           _fstat=osutils.fstat):
515
475
        """See Tree.get_file_with_stat."""
516
476
        if path is None:
517
477
            path = self.id2path(file_id)
519
479
        stat_value = _fstat(file_obj.fileno())
520
480
        if filtered and self.supports_content_filtering():
521
481
            filters = self._content_filter_stack(path)
522
 
            file_obj = filtered_input_file(file_obj, filters)
 
482
            file_obj = _mod_filters.filtered_input_file(file_obj, filters)
523
483
        return (file_obj, stat_value)
524
484
 
525
485
    def get_file_text(self, file_id, path=None, filtered=True):
534
494
        f = file(path, 'rb')
535
495
        if filtered and self.supports_content_filtering():
536
496
            filters = self._content_filter_stack(filename)
537
 
            return filtered_input_file(f, filters)
 
497
            return _mod_filters.filtered_input_file(f, filters)
538
498
        else:
539
499
            return f
540
500
 
546
506
        finally:
547
507
            file.close()
548
508
 
549
 
    @needs_read_lock
550
 
    def annotate_iter(self, file_id, default_revision=CURRENT_REVISION):
551
 
        """See Tree.annotate_iter
552
 
 
553
 
        This implementation will use the basis tree implementation if possible.
554
 
        Lines not in the basis are attributed to CURRENT_REVISION
555
 
 
556
 
        If there are pending merges, lines added by those merges will be
557
 
        incorrectly attributed to CURRENT_REVISION (but after committing, the
558
 
        attribution will be correct).
559
 
        """
560
 
        maybe_file_parent_keys = []
561
 
        for parent_id in self.get_parent_ids():
562
 
            try:
563
 
                parent_tree = self.revision_tree(parent_id)
564
 
            except errors.NoSuchRevisionInTree:
565
 
                parent_tree = self.branch.repository.revision_tree(parent_id)
566
 
            parent_tree.lock_read()
567
 
            try:
568
 
                if file_id not in parent_tree:
569
 
                    continue
570
 
                ie = parent_tree.inventory[file_id]
571
 
                if ie.kind != 'file':
572
 
                    # Note: this is slightly unnecessary, because symlinks and
573
 
                    # directories have a "text" which is the empty text, and we
574
 
                    # know that won't mess up annotations. But it seems cleaner
575
 
                    continue
576
 
                parent_text_key = (file_id, ie.revision)
577
 
                if parent_text_key not in maybe_file_parent_keys:
578
 
                    maybe_file_parent_keys.append(parent_text_key)
579
 
            finally:
580
 
                parent_tree.unlock()
581
 
        graph = _mod_graph.Graph(self.branch.repository.texts)
582
 
        heads = graph.heads(maybe_file_parent_keys)
583
 
        file_parent_keys = []
584
 
        for key in maybe_file_parent_keys:
585
 
            if key in heads:
586
 
                file_parent_keys.append(key)
587
 
 
588
 
        # Now we have the parents of this content
589
 
        annotator = self.branch.repository.texts.get_annotator()
590
 
        text = self.get_file_text(file_id)
591
 
        this_key =(file_id, default_revision)
592
 
        annotator.add_special_text(this_key, file_parent_keys, text)
593
 
        annotations = [(key[-1], line)
594
 
                       for key, line in annotator.annotate_flat(this_key)]
595
 
        return annotations
596
 
 
597
509
    def _get_ancestors(self, default_revision):
598
510
        ancestors = set([default_revision])
599
511
        for parent_id in self.get_parent_ids():
622
534
                parents.append(revision_id)
623
535
        return parents
624
536
 
625
 
    @needs_read_lock
626
537
    def get_root_id(self):
627
538
        """Return the id of this trees root"""
628
 
        return self._inventory.root.file_id
629
 
 
630
 
    def _get_store_filename(self, file_id):
631
 
        ## XXX: badly named; this is not in the store at all
632
 
        return self.abspath(self.id2path(file_id))
 
539
        raise NotImplementedError(self.get_root_id)
633
540
 
634
541
    @needs_read_lock
635
542
    def clone(self, to_bzrdir, revision_id=None):
665
572
    def id2abspath(self, file_id):
666
573
        return self.abspath(self.id2path(file_id))
667
574
 
668
 
    def has_id(self, file_id):
669
 
        # files that have been deleted are excluded
670
 
        inv = self.inventory
671
 
        if not inv.has_id(file_id):
672
 
            return False
673
 
        path = inv.id2path(file_id)
674
 
        return osutils.lexists(self.abspath(path))
675
 
 
676
 
    def has_or_had_id(self, file_id):
677
 
        if file_id == self.inventory.root.file_id:
678
 
            return True
679
 
        return self.inventory.has_id(file_id)
680
 
 
681
 
    __contains__ = has_id
 
575
    def _check_for_tree_references(self, iterator):
 
576
        """See if directories have become tree-references."""
 
577
        blocked_parent_ids = set()
 
578
        for path, ie in iterator:
 
579
            if ie.parent_id in blocked_parent_ids:
 
580
                # This entry was pruned because one of its parents became a
 
581
                # TreeReference. If this is a directory, mark it as blocked.
 
582
                if ie.kind == 'directory':
 
583
                    blocked_parent_ids.add(ie.file_id)
 
584
                continue
 
585
            if ie.kind == 'directory' and self._directory_is_tree_reference(path):
 
586
                # This InventoryDirectory needs to be a TreeReference
 
587
                ie = inventory.TreeReference(ie.file_id, ie.name, ie.parent_id)
 
588
                blocked_parent_ids.add(ie.file_id)
 
589
            yield path, ie
 
590
 
 
591
    def iter_entries_by_dir(self, specific_file_ids=None, yield_parents=False):
 
592
        """See Tree.iter_entries_by_dir()"""
 
593
        # The only trick here is that if we supports_tree_reference then we
 
594
        # need to detect if a directory becomes a tree-reference.
 
595
        iterator = super(WorkingTree, self).iter_entries_by_dir(
 
596
                specific_file_ids=specific_file_ids,
 
597
                yield_parents=yield_parents)
 
598
        if not self.supports_tree_reference():
 
599
            return iterator
 
600
        else:
 
601
            return self._check_for_tree_references(iterator)
682
602
 
683
603
    def get_file_size(self, file_id):
684
604
        """See Tree.get_file_size"""
692
612
            else:
693
613
                return None
694
614
 
695
 
    @needs_read_lock
696
615
    def get_file_sha1(self, file_id, path=None, stat_value=None):
697
 
        if not path:
698
 
            path = self._inventory.id2path(file_id)
699
 
        return self._hashcache.get_sha1(path, stat_value)
700
 
 
701
 
    def get_file_mtime(self, file_id, path=None):
702
 
        if not path:
703
 
            path = self.inventory.id2path(file_id)
704
 
        return os.lstat(self.abspath(path)).st_mtime
705
 
 
706
 
    def _is_executable_from_path_and_stat_from_basis(self, path, stat_result):
707
 
        file_id = self.path2id(path)
708
 
        if file_id is None:
709
 
            # For unversioned files on win32, we just assume they are not
710
 
            # executable
711
 
            return False
712
 
        return self._inventory[file_id].executable
713
 
 
714
 
    def _is_executable_from_path_and_stat_from_stat(self, path, stat_result):
715
 
        mode = stat_result.st_mode
716
 
        return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
717
 
 
718
 
    if not supports_executable():
719
 
        def is_executable(self, file_id, path=None):
720
 
            return self._inventory[file_id].executable
721
 
 
722
 
        _is_executable_from_path_and_stat = \
723
 
            _is_executable_from_path_and_stat_from_basis
724
 
    else:
725
 
        def is_executable(self, file_id, path=None):
726
 
            if not path:
727
 
                path = self.id2path(file_id)
728
 
            mode = os.lstat(self.abspath(path)).st_mode
729
 
            return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
730
 
 
731
 
        _is_executable_from_path_and_stat = \
732
 
            _is_executable_from_path_and_stat_from_stat
733
 
 
734
 
    @needs_tree_write_lock
735
 
    def _add(self, files, ids, kinds):
736
 
        """See MutableTree._add."""
737
 
        # TODO: Re-adding a file that is removed in the working copy
738
 
        # should probably put it back with the previous ID.
739
 
        # the read and write working inventory should not occur in this
740
 
        # function - they should be part of lock_write and unlock.
741
 
        inv = self.inventory
742
 
        for f, file_id, kind in zip(files, ids, kinds):
743
 
            if file_id is None:
744
 
                inv.add_path(f, kind=kind)
745
 
            else:
746
 
                inv.add_path(f, kind=kind, file_id=file_id)
747
 
            self._inventory_is_modified = True
 
616
        # FIXME: Shouldn't this be in Tree?
 
617
        raise NotImplementedError(self.get_file_sha1)
748
618
 
749
619
    @needs_tree_write_lock
750
620
    def _gather_kinds(self, files, kinds):
876
746
            if revision_id in heads and revision_id not in new_revision_ids:
877
747
                new_revision_ids.append(revision_id)
878
748
        if new_revision_ids != revision_ids:
879
 
            trace.mutter('requested to set revision_ids = %s,'
 
749
            mutter('requested to set revision_ids = %s,'
880
750
                         ' but filtered to %s', revision_ids, new_revision_ids)
881
751
        return new_revision_ids
882
752
 
908
778
        self._set_merges_from_parent_ids(revision_ids)
909
779
 
910
780
    @needs_tree_write_lock
911
 
    def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
912
 
        """See MutableTree.set_parent_trees."""
913
 
        parent_ids = [rev for (rev, tree) in parents_list]
914
 
        for revision_id in parent_ids:
915
 
            _mod_revision.check_not_reserved_id(revision_id)
916
 
 
917
 
        self._check_parents_for_ghosts(parent_ids,
918
 
            allow_leftmost_as_ghost=allow_leftmost_as_ghost)
919
 
 
920
 
        parent_ids = self._filter_parent_ids_by_ancestry(parent_ids)
921
 
 
922
 
        if len(parent_ids) == 0:
923
 
            leftmost_parent_id = _mod_revision.NULL_REVISION
924
 
            leftmost_parent_tree = None
925
 
        else:
926
 
            leftmost_parent_id, leftmost_parent_tree = parents_list[0]
927
 
 
928
 
        if self._change_last_revision(leftmost_parent_id):
929
 
            if leftmost_parent_tree is None:
930
 
                # If we don't have a tree, fall back to reading the
931
 
                # parent tree from the repository.
932
 
                self._cache_basis_inventory(leftmost_parent_id)
933
 
            else:
934
 
                inv = leftmost_parent_tree.inventory
935
 
                xml = self._create_basis_xml_from_inventory(
936
 
                                        leftmost_parent_id, inv)
937
 
                self._write_basis_inventory(xml)
938
 
        self._set_merges_from_parent_ids(parent_ids)
939
 
 
940
 
    @needs_tree_write_lock
941
781
    def set_pending_merges(self, rev_list):
942
782
        parents = self.get_parent_ids()
943
783
        leftmost = parents[:1]
948
788
    def set_merge_modified(self, modified_hashes):
949
789
        def iter_stanzas():
950
790
            for file_id, hash in modified_hashes.iteritems():
951
 
                yield Stanza(file_id=file_id.decode('utf8'), hash=hash)
 
791
                yield _mod_rio.Stanza(file_id=file_id.decode('utf8'),
 
792
                    hash=hash)
952
793
        self._put_rio('merge-hashes', iter_stanzas(), MERGE_MODIFIED_HEADER_1)
953
794
 
954
795
    def _sha_from_stat(self, path, stat_result):
963
804
 
964
805
    def _put_rio(self, filename, stanzas, header):
965
806
        self._must_be_locked()
966
 
        my_file = rio_file(stanzas, header)
 
807
        my_file = _mod_rio.rio_file(stanzas, header)
967
808
        self._transport.put_file(filename, my_file,
968
809
            mode=self.bzrdir._get_file_mode())
969
810
 
1011
852
        merger.set_pending()
1012
853
        return conflicts
1013
854
 
1014
 
    @needs_read_lock
1015
855
    def merge_modified(self):
1016
856
        """Return a dictionary of files modified by a merge.
1017
857
 
1022
862
        This returns a map of file_id->sha1, containing only files which are
1023
863
        still in the working inventory and have that text hash.
1024
864
        """
1025
 
        try:
1026
 
            hashfile = self._transport.get('merge-hashes')
1027
 
        except errors.NoSuchFile:
1028
 
            return {}
1029
 
        try:
1030
 
            merge_hashes = {}
1031
 
            try:
1032
 
                if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
1033
 
                    raise errors.MergeModifiedFormatError()
1034
 
            except StopIteration:
1035
 
                raise errors.MergeModifiedFormatError()
1036
 
            for s in RioReader(hashfile):
1037
 
                # RioReader reads in Unicode, so convert file_ids back to utf8
1038
 
                file_id = osutils.safe_file_id(s.get("file_id"), warn=False)
1039
 
                if file_id not in self.inventory:
1040
 
                    continue
1041
 
                text_hash = s.get("hash")
1042
 
                if text_hash == self.get_file_sha1(file_id):
1043
 
                    merge_hashes[file_id] = text_hash
1044
 
            return merge_hashes
1045
 
        finally:
1046
 
            hashfile.close()
 
865
        raise NotImplementedError(self.merge_modified)
1047
866
 
1048
867
    @needs_write_lock
1049
868
    def mkdir(self, path, file_id=None):
1059
878
        target = osutils.readlink(abspath)
1060
879
        return target
1061
880
 
1062
 
    @needs_write_lock
1063
881
    def subsume(self, other_tree):
1064
 
        def add_children(inventory, entry):
1065
 
            for child_entry in entry.children.values():
1066
 
                inventory._byid[child_entry.file_id] = child_entry
1067
 
                if child_entry.kind == 'directory':
1068
 
                    add_children(inventory, child_entry)
1069
 
        if other_tree.get_root_id() == self.get_root_id():
1070
 
            raise errors.BadSubsumeSource(self, other_tree,
1071
 
                                          'Trees have the same root')
1072
 
        try:
1073
 
            other_tree_path = self.relpath(other_tree.basedir)
1074
 
        except errors.PathNotChild:
1075
 
            raise errors.BadSubsumeSource(self, other_tree,
1076
 
                'Tree is not contained by the other')
1077
 
        new_root_parent = self.path2id(osutils.dirname(other_tree_path))
1078
 
        if new_root_parent is None:
1079
 
            raise errors.BadSubsumeSource(self, other_tree,
1080
 
                'Parent directory is not versioned.')
1081
 
        # We need to ensure that the result of a fetch will have a
1082
 
        # versionedfile for the other_tree root, and only fetching into
1083
 
        # RepositoryKnit2 guarantees that.
1084
 
        if not self.branch.repository.supports_rich_root():
1085
 
            raise errors.SubsumeTargetNeedsUpgrade(other_tree)
1086
 
        other_tree.lock_tree_write()
1087
 
        try:
1088
 
            new_parents = other_tree.get_parent_ids()
1089
 
            other_root = other_tree.inventory.root
1090
 
            other_root.parent_id = new_root_parent
1091
 
            other_root.name = osutils.basename(other_tree_path)
1092
 
            self.inventory.add(other_root)
1093
 
            add_children(self.inventory, other_root)
1094
 
            self._write_inventory(self.inventory)
1095
 
            # normally we don't want to fetch whole repositories, but i think
1096
 
            # here we really do want to consolidate the whole thing.
1097
 
            for parent_id in other_tree.get_parent_ids():
1098
 
                self.branch.fetch(other_tree.branch, parent_id)
1099
 
                self.add_parent_tree_id(parent_id)
1100
 
        finally:
1101
 
            other_tree.unlock()
1102
 
        other_tree.bzrdir.retire_bzrdir()
 
882
        raise NotImplementedError(self.subsume)
1103
883
 
1104
884
    def _setup_directory_is_tree_reference(self):
1105
885
        if self._branch.repository._format.supports_tree_reference:
1127
907
        # checkout in a subdirectory.  This can be avoided by not adding
1128
908
        # it.  mbp 20070306
1129
909
 
1130
 
    @needs_tree_write_lock
1131
910
    def extract(self, file_id, format=None):
1132
911
        """Extract a subtree from this tree.
1133
912
 
1134
913
        A new branch will be created, relative to the path for this tree.
1135
914
        """
1136
 
        self.flush()
1137
 
        def mkdirs(path):
1138
 
            segments = osutils.splitpath(path)
1139
 
            transport = self.branch.bzrdir.root_transport
1140
 
            for name in segments:
1141
 
                transport = transport.clone(name)
1142
 
                transport.ensure_base()
1143
 
            return transport
1144
 
 
1145
 
        sub_path = self.id2path(file_id)
1146
 
        branch_transport = mkdirs(sub_path)
1147
 
        if format is None:
1148
 
            format = self.bzrdir.cloning_metadir()
1149
 
        branch_transport.ensure_base()
1150
 
        branch_bzrdir = format.initialize_on_transport(branch_transport)
1151
 
        try:
1152
 
            repo = branch_bzrdir.find_repository()
1153
 
        except errors.NoRepositoryPresent:
1154
 
            repo = branch_bzrdir.create_repository()
1155
 
        if not repo.supports_rich_root():
1156
 
            raise errors.RootNotRich()
1157
 
        new_branch = branch_bzrdir.create_branch()
1158
 
        new_branch.pull(self.branch)
1159
 
        for parent_id in self.get_parent_ids():
1160
 
            new_branch.fetch(self.branch, parent_id)
1161
 
        tree_transport = self.bzrdir.root_transport.clone(sub_path)
1162
 
        if tree_transport.base != branch_transport.base:
1163
 
            tree_bzrdir = format.initialize_on_transport(tree_transport)
1164
 
            branch.BranchReferenceFormat().initialize(tree_bzrdir,
1165
 
                target_branch=new_branch)
1166
 
        else:
1167
 
            tree_bzrdir = branch_bzrdir
1168
 
        wt = tree_bzrdir.create_workingtree(_mod_revision.NULL_REVISION)
1169
 
        wt.set_parent_ids(self.get_parent_ids())
1170
 
        my_inv = self.inventory
1171
 
        child_inv = inventory.Inventory(root_id=None)
1172
 
        new_root = my_inv[file_id]
1173
 
        my_inv.remove_recursive_id(file_id)
1174
 
        new_root.parent_id = None
1175
 
        child_inv.add(new_root)
1176
 
        self._write_inventory(my_inv)
1177
 
        wt._write_inventory(child_inv)
1178
 
        return wt
1179
 
 
1180
 
    def _serialize(self, inventory, out_file):
1181
 
        xml5.serializer_v5.write_inventory(self._inventory, out_file,
1182
 
            working=True)
1183
 
 
1184
 
    def _deserialize(selt, in_file):
1185
 
        return xml5.serializer_v5.read_inventory(in_file)
 
915
        raise NotImplementedError(self.extract)
1186
916
 
1187
917
    def flush(self):
1188
 
        """Write the in memory inventory to disk."""
1189
 
        # TODO: Maybe this should only write on dirty ?
1190
 
        if self._control_files._lock_mode != 'w':
1191
 
            raise errors.NotWriteLocked(self)
1192
 
        sio = StringIO()
1193
 
        self._serialize(self._inventory, sio)
1194
 
        sio.seek(0)
1195
 
        self._transport.put_file('inventory', sio,
1196
 
            mode=self.bzrdir._get_file_mode())
1197
 
        self._inventory_is_modified = False
 
918
        """Write the in memory meta data to disk."""
 
919
        raise NotImplementedError(self.flush)
1198
920
 
1199
921
    def _kind(self, relpath):
1200
922
        return osutils.file_kind(self.abspath(relpath))
1210
932
        :param from_dir: start from this directory or None for the root
1211
933
        :param recursive: whether to recurse into subdirectories or not
1212
934
        """
1213
 
        # list_files is an iterator, so @needs_read_lock doesn't work properly
1214
 
        # with it. So callers should be careful to always read_lock the tree.
1215
 
        if not self.is_locked():
1216
 
            raise errors.ObjectNotLocked(self)
1217
 
 
1218
 
        inv = self.inventory
1219
 
        if from_dir is None and include_root is True:
1220
 
            yield ('', 'V', 'directory', inv.root.file_id, inv.root)
1221
 
        # Convert these into local objects to save lookup times
1222
 
        pathjoin = osutils.pathjoin
1223
 
        file_kind = self._kind
1224
 
 
1225
 
        # transport.base ends in a slash, we want the piece
1226
 
        # between the last two slashes
1227
 
        transport_base_dir = self.bzrdir.transport.base.rsplit('/', 2)[1]
1228
 
 
1229
 
        fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
1230
 
 
1231
 
        # directory file_id, relative path, absolute path, reverse sorted children
1232
 
        if from_dir is not None:
1233
 
            from_dir_id = inv.path2id(from_dir)
1234
 
            if from_dir_id is None:
1235
 
                # Directory not versioned
1236
 
                return
1237
 
            from_dir_abspath = pathjoin(self.basedir, from_dir)
1238
 
        else:
1239
 
            from_dir_id = inv.root.file_id
1240
 
            from_dir_abspath = self.basedir
1241
 
        children = os.listdir(from_dir_abspath)
1242
 
        children.sort()
1243
 
        # jam 20060527 The kernel sized tree seems equivalent whether we
1244
 
        # use a deque and popleft to keep them sorted, or if we use a plain
1245
 
        # list and just reverse() them.
1246
 
        children = collections.deque(children)
1247
 
        stack = [(from_dir_id, u'', from_dir_abspath, children)]
1248
 
        while stack:
1249
 
            from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
1250
 
 
1251
 
            while children:
1252
 
                f = children.popleft()
1253
 
                ## TODO: If we find a subdirectory with its own .bzr
1254
 
                ## directory, then that is a separate tree and we
1255
 
                ## should exclude it.
1256
 
 
1257
 
                # the bzrdir for this tree
1258
 
                if transport_base_dir == f:
1259
 
                    continue
1260
 
 
1261
 
                # we know that from_dir_relpath and from_dir_abspath never end in a slash
1262
 
                # and 'f' doesn't begin with one, we can do a string op, rather
1263
 
                # than the checks of pathjoin(), all relative paths will have an extra slash
1264
 
                # at the beginning
1265
 
                fp = from_dir_relpath + '/' + f
1266
 
 
1267
 
                # absolute path
1268
 
                fap = from_dir_abspath + '/' + f
1269
 
 
1270
 
                dir_ie = inv[from_dir_id]
1271
 
                if dir_ie.kind == 'directory':
1272
 
                    f_ie = dir_ie.children.get(f)
1273
 
                else:
1274
 
                    f_ie = None
1275
 
                if f_ie:
1276
 
                    c = 'V'
1277
 
                elif self.is_ignored(fp[1:]):
1278
 
                    c = 'I'
1279
 
                else:
1280
 
                    # we may not have found this file, because of a unicode
1281
 
                    # issue, or because the directory was actually a symlink.
1282
 
                    f_norm, can_access = osutils.normalized_filename(f)
1283
 
                    if f == f_norm or not can_access:
1284
 
                        # No change, so treat this file normally
1285
 
                        c = '?'
1286
 
                    else:
1287
 
                        # this file can be accessed by a normalized path
1288
 
                        # check again if it is versioned
1289
 
                        # these lines are repeated here for performance
1290
 
                        f = f_norm
1291
 
                        fp = from_dir_relpath + '/' + f
1292
 
                        fap = from_dir_abspath + '/' + f
1293
 
                        f_ie = inv.get_child(from_dir_id, f)
1294
 
                        if f_ie:
1295
 
                            c = 'V'
1296
 
                        elif self.is_ignored(fp[1:]):
1297
 
                            c = 'I'
1298
 
                        else:
1299
 
                            c = '?'
1300
 
 
1301
 
                fk = file_kind(fap)
1302
 
 
1303
 
                # make a last minute entry
1304
 
                if f_ie:
1305
 
                    yield fp[1:], c, fk, f_ie.file_id, f_ie
1306
 
                else:
1307
 
                    try:
1308
 
                        yield fp[1:], c, fk, None, fk_entries[fk]()
1309
 
                    except KeyError:
1310
 
                        yield fp[1:], c, fk, None, TreeEntry()
1311
 
                    continue
1312
 
 
1313
 
                if fk != 'directory':
1314
 
                    continue
1315
 
 
1316
 
                # But do this child first if recursing down
1317
 
                if recursive:
1318
 
                    new_children = os.listdir(fap)
1319
 
                    new_children.sort()
1320
 
                    new_children = collections.deque(new_children)
1321
 
                    stack.append((f_ie.file_id, fp, fap, new_children))
1322
 
                    # Break out of inner loop,
1323
 
                    # so that we start outer loop with child
1324
 
                    break
1325
 
            else:
1326
 
                # if we finished all children, pop it off the stack
1327
 
                stack.pop()
1328
 
 
1329
 
    @needs_tree_write_lock
 
935
        raise NotImplementedError(self.list_files)
 
936
 
1330
937
    def move(self, from_paths, to_dir=None, after=False):
1331
938
        """Rename files.
1332
939
 
1333
 
        to_dir must exist in the inventory.
 
940
        to_dir must be known to the working tree.
1334
941
 
1335
942
        If to_dir exists and is a directory, the files are moved into
1336
943
        it, keeping their old names.
1342
949
        independently.
1343
950
 
1344
951
        The first mode moves the file in the filesystem and updates the
1345
 
        inventory. The second mode only updates the inventory without
1346
 
        touching the file on the filesystem. This is the new mode introduced
1347
 
        in version 0.15.
 
952
        working tree metadata. The second mode only updates the working tree
 
953
        metadata without touching the file on the filesystem.
1348
954
 
1349
955
        move uses the second mode if 'after == True' and the target is not
1350
956
        versioned but present in the working tree.
1362
968
        This returns a list of (from_path, to_path) pairs for each
1363
969
        entry that is moved.
1364
970
        """
1365
 
        rename_entries = []
1366
 
        rename_tuples = []
1367
 
 
1368
 
        # check for deprecated use of signature
1369
 
        if to_dir is None:
1370
 
            raise TypeError('You must supply a target directory')
1371
 
        # check destination directory
1372
 
        if isinstance(from_paths, basestring):
1373
 
            raise ValueError()
1374
 
        inv = self.inventory
1375
 
        to_abs = self.abspath(to_dir)
1376
 
        if not isdir(to_abs):
1377
 
            raise errors.BzrMoveFailedError('',to_dir,
1378
 
                errors.NotADirectory(to_abs))
1379
 
        if not self.has_filename(to_dir):
1380
 
            raise errors.BzrMoveFailedError('',to_dir,
1381
 
                errors.NotInWorkingDirectory(to_dir))
1382
 
        to_dir_id = inv.path2id(to_dir)
1383
 
        if to_dir_id is None:
1384
 
            raise errors.BzrMoveFailedError('',to_dir,
1385
 
                errors.NotVersionedError(path=str(to_dir)))
1386
 
 
1387
 
        to_dir_ie = inv[to_dir_id]
1388
 
        if to_dir_ie.kind != 'directory':
1389
 
            raise errors.BzrMoveFailedError('',to_dir,
1390
 
                errors.NotADirectory(to_abs))
1391
 
 
1392
 
        # create rename entries and tuples
1393
 
        for from_rel in from_paths:
1394
 
            from_tail = splitpath(from_rel)[-1]
1395
 
            from_id = inv.path2id(from_rel)
1396
 
            if from_id is None:
1397
 
                raise errors.BzrMoveFailedError(from_rel,to_dir,
1398
 
                    errors.NotVersionedError(path=str(from_rel)))
1399
 
 
1400
 
            from_entry = inv[from_id]
1401
 
            from_parent_id = from_entry.parent_id
1402
 
            to_rel = pathjoin(to_dir, from_tail)
1403
 
            rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
1404
 
                                         from_id=from_id,
1405
 
                                         from_tail=from_tail,
1406
 
                                         from_parent_id=from_parent_id,
1407
 
                                         to_rel=to_rel, to_tail=from_tail,
1408
 
                                         to_parent_id=to_dir_id)
1409
 
            rename_entries.append(rename_entry)
1410
 
            rename_tuples.append((from_rel, to_rel))
1411
 
 
1412
 
        # determine which move mode to use. checks also for movability
1413
 
        rename_entries = self._determine_mv_mode(rename_entries, after)
1414
 
 
1415
 
        original_modified = self._inventory_is_modified
1416
 
        try:
1417
 
            if len(from_paths):
1418
 
                self._inventory_is_modified = True
1419
 
            self._move(rename_entries)
1420
 
        except:
1421
 
            # restore the inventory on error
1422
 
            self._inventory_is_modified = original_modified
1423
 
            raise
1424
 
        self._write_inventory(inv)
1425
 
        return rename_tuples
1426
 
 
1427
 
    def _determine_mv_mode(self, rename_entries, after=False):
1428
 
        """Determines for each from-to pair if both inventory and working tree
1429
 
        or only the inventory has to be changed.
1430
 
 
1431
 
        Also does basic plausability tests.
1432
 
        """
1433
 
        inv = self.inventory
1434
 
 
1435
 
        for rename_entry in rename_entries:
1436
 
            # store to local variables for easier reference
1437
 
            from_rel = rename_entry.from_rel
1438
 
            from_id = rename_entry.from_id
1439
 
            to_rel = rename_entry.to_rel
1440
 
            to_id = inv.path2id(to_rel)
1441
 
            only_change_inv = False
1442
 
 
1443
 
            # check the inventory for source and destination
1444
 
            if from_id is None:
1445
 
                raise errors.BzrMoveFailedError(from_rel,to_rel,
1446
 
                    errors.NotVersionedError(path=str(from_rel)))
1447
 
            if to_id is not None:
1448
 
                raise errors.BzrMoveFailedError(from_rel,to_rel,
1449
 
                    errors.AlreadyVersionedError(path=str(to_rel)))
1450
 
 
1451
 
            # try to determine the mode for rename (only change inv or change
1452
 
            # inv and file system)
1453
 
            if after:
1454
 
                if not self.has_filename(to_rel):
1455
 
                    raise errors.BzrMoveFailedError(from_id,to_rel,
1456
 
                        errors.NoSuchFile(path=str(to_rel),
1457
 
                        extra="New file has not been created yet"))
1458
 
                only_change_inv = True
1459
 
            elif not self.has_filename(from_rel) and self.has_filename(to_rel):
1460
 
                only_change_inv = True
1461
 
            elif self.has_filename(from_rel) and not self.has_filename(to_rel):
1462
 
                only_change_inv = False
1463
 
            elif (not self.case_sensitive
1464
 
                  and from_rel.lower() == to_rel.lower()
1465
 
                  and self.has_filename(from_rel)):
1466
 
                only_change_inv = False
1467
 
            else:
1468
 
                # something is wrong, so lets determine what exactly
1469
 
                if not self.has_filename(from_rel) and \
1470
 
                   not self.has_filename(to_rel):
1471
 
                    raise errors.BzrRenameFailedError(from_rel,to_rel,
1472
 
                        errors.PathsDoNotExist(paths=(str(from_rel),
1473
 
                        str(to_rel))))
1474
 
                else:
1475
 
                    raise errors.RenameFailedFilesExist(from_rel, to_rel)
1476
 
            rename_entry.only_change_inv = only_change_inv
1477
 
        return rename_entries
1478
 
 
1479
 
    def _move(self, rename_entries):
1480
 
        """Moves a list of files.
1481
 
 
1482
 
        Depending on the value of the flag 'only_change_inv', the
1483
 
        file will be moved on the file system or not.
1484
 
        """
1485
 
        inv = self.inventory
1486
 
        moved = []
1487
 
 
1488
 
        for entry in rename_entries:
1489
 
            try:
1490
 
                self._move_entry(entry)
1491
 
            except:
1492
 
                self._rollback_move(moved)
1493
 
                raise
1494
 
            moved.append(entry)
1495
 
 
1496
 
    def _rollback_move(self, moved):
1497
 
        """Try to rollback a previous move in case of an filesystem error."""
1498
 
        inv = self.inventory
1499
 
        for entry in moved:
1500
 
            try:
1501
 
                self._move_entry(WorkingTree._RenameEntry(
1502
 
                    entry.to_rel, entry.from_id,
1503
 
                    entry.to_tail, entry.to_parent_id, entry.from_rel,
1504
 
                    entry.from_tail, entry.from_parent_id,
1505
 
                    entry.only_change_inv))
1506
 
            except errors.BzrMoveFailedError, e:
1507
 
                raise errors.BzrMoveFailedError( '', '', "Rollback failed."
1508
 
                        " The working tree is in an inconsistent state."
1509
 
                        " Please consider doing a 'bzr revert'."
1510
 
                        " Error message is: %s" % e)
1511
 
 
1512
 
    def _move_entry(self, entry):
1513
 
        inv = self.inventory
1514
 
        from_rel_abs = self.abspath(entry.from_rel)
1515
 
        to_rel_abs = self.abspath(entry.to_rel)
1516
 
        if from_rel_abs == to_rel_abs:
1517
 
            raise errors.BzrMoveFailedError(entry.from_rel, entry.to_rel,
1518
 
                "Source and target are identical.")
1519
 
 
1520
 
        if not entry.only_change_inv:
1521
 
            try:
1522
 
                osutils.rename(from_rel_abs, to_rel_abs)
1523
 
            except OSError, e:
1524
 
                raise errors.BzrMoveFailedError(entry.from_rel,
1525
 
                    entry.to_rel, e[1])
1526
 
        inv.rename(entry.from_id, entry.to_parent_id, entry.to_tail)
 
971
        raise NotImplementedError(self.move)
1527
972
 
1528
973
    @needs_tree_write_lock
1529
974
    def rename_one(self, from_rel, to_rel, after=False):
1533
978
 
1534
979
        rename_one has several 'modes' to work. First, it can rename a physical
1535
980
        file and change the file_id. That is the normal mode. Second, it can
1536
 
        only change the file_id without touching any physical file. This is
1537
 
        the new mode introduced in version 0.15.
 
981
        only change the file_id without touching any physical file.
1538
982
 
1539
983
        rename_one uses the second mode if 'after == True' and 'to_rel' is not
1540
984
        versioned but present in the working tree.
1549
993
 
1550
994
        Everything else results in an error.
1551
995
        """
1552
 
        inv = self.inventory
1553
 
        rename_entries = []
1554
 
 
1555
 
        # create rename entries and tuples
1556
 
        from_tail = splitpath(from_rel)[-1]
1557
 
        from_id = inv.path2id(from_rel)
1558
 
        if from_id is None:
1559
 
            # if file is missing in the inventory maybe it's in the basis_tree
1560
 
            basis_tree = self.branch.basis_tree()
1561
 
            from_id = basis_tree.path2id(from_rel)
1562
 
            if from_id is None:
1563
 
                raise errors.BzrRenameFailedError(from_rel,to_rel,
1564
 
                    errors.NotVersionedError(path=str(from_rel)))
1565
 
            # put entry back in the inventory so we can rename it
1566
 
            from_entry = basis_tree.inventory[from_id].copy()
1567
 
            inv.add(from_entry)
1568
 
        else:
1569
 
            from_entry = inv[from_id]
1570
 
        from_parent_id = from_entry.parent_id
1571
 
        to_dir, to_tail = os.path.split(to_rel)
1572
 
        to_dir_id = inv.path2id(to_dir)
1573
 
        rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
1574
 
                                     from_id=from_id,
1575
 
                                     from_tail=from_tail,
1576
 
                                     from_parent_id=from_parent_id,
1577
 
                                     to_rel=to_rel, to_tail=to_tail,
1578
 
                                     to_parent_id=to_dir_id)
1579
 
        rename_entries.append(rename_entry)
1580
 
 
1581
 
        # determine which move mode to use. checks also for movability
1582
 
        rename_entries = self._determine_mv_mode(rename_entries, after)
1583
 
 
1584
 
        # check if the target changed directory and if the target directory is
1585
 
        # versioned
1586
 
        if to_dir_id is None:
1587
 
            raise errors.BzrMoveFailedError(from_rel,to_rel,
1588
 
                errors.NotVersionedError(path=str(to_dir)))
1589
 
 
1590
 
        # all checks done. now we can continue with our actual work
1591
 
        mutter('rename_one:\n'
1592
 
               '  from_id   {%s}\n'
1593
 
               '  from_rel: %r\n'
1594
 
               '  to_rel:   %r\n'
1595
 
               '  to_dir    %r\n'
1596
 
               '  to_dir_id {%s}\n',
1597
 
               from_id, from_rel, to_rel, to_dir, to_dir_id)
1598
 
 
1599
 
        self._move(rename_entries)
1600
 
        self._write_inventory(inv)
1601
 
 
1602
 
    class _RenameEntry(object):
1603
 
        def __init__(self, from_rel, from_id, from_tail, from_parent_id,
1604
 
                     to_rel, to_tail, to_parent_id, only_change_inv=False):
1605
 
            self.from_rel = from_rel
1606
 
            self.from_id = from_id
1607
 
            self.from_tail = from_tail
1608
 
            self.from_parent_id = from_parent_id
1609
 
            self.to_rel = to_rel
1610
 
            self.to_tail = to_tail
1611
 
            self.to_parent_id = to_parent_id
1612
 
            self.only_change_inv = only_change_inv
 
996
        raise NotImplementedError(self.rename_one)
1613
997
 
1614
998
    @needs_read_lock
1615
999
    def unknowns(self):
1623
1007
        return iter(
1624
1008
            [subp for subp in self.extras() if not self.is_ignored(subp)])
1625
1009
 
1626
 
    @needs_tree_write_lock
1627
1010
    def unversion(self, file_ids):
1628
1011
        """Remove the file ids in file_ids from the current versioned set.
1629
1012
 
1633
1016
        :param file_ids: The file ids to stop versioning.
1634
1017
        :raises: NoSuchId if any fileid is not currently versioned.
1635
1018
        """
1636
 
        for file_id in file_ids:
1637
 
            if file_id not in self._inventory:
1638
 
                raise errors.NoSuchId(self, file_id)
1639
 
        for file_id in file_ids:
1640
 
            if self._inventory.has_id(file_id):
1641
 
                self._inventory.remove_recursive_id(file_id)
1642
 
        if len(file_ids):
1643
 
            # in the future this should just set a dirty bit to wait for the
1644
 
            # final unlock. However, until all methods of workingtree start
1645
 
            # with the current in -memory inventory rather than triggering
1646
 
            # a read, it is more complex - we need to teach read_inventory
1647
 
            # to know when to read, and when to not read first... and possibly
1648
 
            # to save first when the in memory one may be corrupted.
1649
 
            # so for now, we just only write it if it is indeed dirty.
1650
 
            # - RBC 20060907
1651
 
            self._write_inventory(self._inventory)
1652
 
 
1653
 
    def _iter_conflicts(self):
1654
 
        conflicted = set()
1655
 
        for info in self.list_files():
1656
 
            path = info[0]
1657
 
            stem = get_conflicted_stem(path)
1658
 
            if stem is None:
1659
 
                continue
1660
 
            if stem not in conflicted:
1661
 
                conflicted.add(stem)
1662
 
                yield stem
 
1019
        raise NotImplementedError(self.unversion)
1663
1020
 
1664
1021
    @needs_write_lock
1665
1022
    def pull(self, source, overwrite=False, stop_revision=None,
1666
 
             change_reporter=None, possible_transports=None, local=False):
 
1023
             change_reporter=None, possible_transports=None, local=False,
 
1024
             show_base=False):
1667
1025
        source.lock_read()
1668
1026
        try:
1669
1027
            old_revision_info = self.branch.last_revision_info()
1683
1041
                                basis_tree,
1684
1042
                                this_tree=self,
1685
1043
                                pb=None,
1686
 
                                change_reporter=change_reporter)
 
1044
                                change_reporter=change_reporter,
 
1045
                                show_base=show_base)
1687
1046
                    basis_root_id = basis_tree.get_root_id()
1688
1047
                    new_root_id = new_basis_tree.get_root_id()
1689
1048
                    if basis_root_id != new_root_id:
1728
1087
        Currently returned depth-first, sorted by name within directories.
1729
1088
        This is the same order used by 'osutils.walkdirs'.
1730
1089
        """
1731
 
        ## TODO: Work from given directory downwards
1732
 
        for path, dir_entry in self.inventory.directories():
1733
 
            # mutter("search for unknowns in %r", path)
1734
 
            dirabs = self.abspath(path)
1735
 
            if not isdir(dirabs):
1736
 
                # e.g. directory deleted
1737
 
                continue
1738
 
 
1739
 
            fl = []
1740
 
            for subf in os.listdir(dirabs):
1741
 
                if self.bzrdir.is_control_filename(subf):
1742
 
                    continue
1743
 
                if subf not in dir_entry.children:
1744
 
                    try:
1745
 
                        (subf_norm,
1746
 
                         can_access) = osutils.normalized_filename(subf)
1747
 
                    except UnicodeDecodeError:
1748
 
                        path_os_enc = path.encode(osutils._fs_enc)
1749
 
                        relpath = path_os_enc + '/' + subf
1750
 
                        raise errors.BadFilenameEncoding(relpath,
1751
 
                                                         osutils._fs_enc)
1752
 
                    if subf_norm != subf and can_access:
1753
 
                        if subf_norm not in dir_entry.children:
1754
 
                            fl.append(subf_norm)
1755
 
                    else:
1756
 
                        fl.append(subf)
1757
 
 
1758
 
            fl.sort()
1759
 
            for subf in fl:
1760
 
                subp = pathjoin(path, subf)
1761
 
                yield subp
 
1090
        raise NotImplementedError(self.extras)
1762
1091
 
1763
1092
    def ignored_files(self):
1764
1093
        """Yield list of PATH, IGNORE_PATTERN"""
1813
1142
 
1814
1143
    def stored_kind(self, file_id):
1815
1144
        """See Tree.stored_kind"""
1816
 
        return self.inventory[file_id].kind
 
1145
        raise NotImplementedError(self.stored_kind)
1817
1146
 
1818
1147
    def _comparison_data(self, entry, path):
1819
1148
        abspath = self.abspath(path)
1910
1239
    def get_physical_lock_status(self):
1911
1240
        return self._control_files.get_physical_lock_status()
1912
1241
 
1913
 
    def _basis_inventory_name(self):
1914
 
        return 'basis-inventory-cache'
1915
 
 
1916
1242
    def _reset_data(self):
1917
1243
        """Reset transient data that cannot be revalidated."""
1918
 
        self._inventory_is_modified = False
1919
 
        f = self._transport.get('inventory')
1920
 
        try:
1921
 
            result = self._deserialize(f)
1922
 
        finally:
1923
 
            f.close()
1924
 
        self._set_inventory(result, dirty=False)
 
1244
        raise NotImplementedError(self._reset_data)
1925
1245
 
1926
 
    @needs_tree_write_lock
1927
1246
    def set_last_revision(self, new_revision):
1928
1247
        """Change the last revision in the working tree."""
1929
 
        if self._change_last_revision(new_revision):
1930
 
            self._cache_basis_inventory(new_revision)
 
1248
        raise NotImplementedError(self.set_last_revision)
1931
1249
 
1932
1250
    def _change_last_revision(self, new_revision):
1933
1251
        """Template method part of set_last_revision to perform the change.
1936
1254
        when their last revision is set.
1937
1255
        """
1938
1256
        if _mod_revision.is_null(new_revision):
1939
 
            self.branch.set_revision_history([])
 
1257
            self.branch.set_last_revision_info(0, new_revision)
1940
1258
            return False
 
1259
        _mod_revision.check_not_reserved_id(new_revision)
1941
1260
        try:
1942
1261
            self.branch.generate_revision_history(new_revision)
1943
1262
        except errors.NoSuchRevision:
1944
1263
            # not present in the repo - dont try to set it deeper than the tip
1945
 
            self.branch.set_revision_history([new_revision])
 
1264
            self.branch._set_revision_history([new_revision])
1946
1265
        return True
1947
1266
 
1948
 
    def _write_basis_inventory(self, xml):
1949
 
        """Write the basis inventory XML to the basis-inventory file"""
1950
 
        path = self._basis_inventory_name()
1951
 
        sio = StringIO(xml)
1952
 
        self._transport.put_file(path, sio,
1953
 
            mode=self.bzrdir._get_file_mode())
1954
 
 
1955
 
    def _create_basis_xml_from_inventory(self, revision_id, inventory):
1956
 
        """Create the text that will be saved in basis-inventory"""
1957
 
        inventory.revision_id = revision_id
1958
 
        return xml7.serializer_v7.write_inventory_to_string(inventory)
1959
 
 
1960
 
    def _cache_basis_inventory(self, new_revision):
1961
 
        """Cache new_revision as the basis inventory."""
1962
 
        # TODO: this should allow the ready-to-use inventory to be passed in,
1963
 
        # as commit already has that ready-to-use [while the format is the
1964
 
        # same, that is].
1965
 
        try:
1966
 
            # this double handles the inventory - unpack and repack -
1967
 
            # but is easier to understand. We can/should put a conditional
1968
 
            # in here based on whether the inventory is in the latest format
1969
 
            # - perhaps we should repack all inventories on a repository
1970
 
            # upgrade ?
1971
 
            # the fast path is to copy the raw xml from the repository. If the
1972
 
            # xml contains 'revision_id="', then we assume the right
1973
 
            # revision_id is set. We must check for this full string, because a
1974
 
            # root node id can legitimately look like 'revision_id' but cannot
1975
 
            # contain a '"'.
1976
 
            xml = self.branch.repository._get_inventory_xml(new_revision)
1977
 
            firstline = xml.split('\n', 1)[0]
1978
 
            if (not 'revision_id="' in firstline or
1979
 
                'format="7"' not in firstline):
1980
 
                inv = self.branch.repository._serializer.read_inventory_from_string(
1981
 
                    xml, new_revision)
1982
 
                xml = self._create_basis_xml_from_inventory(new_revision, inv)
1983
 
            self._write_basis_inventory(xml)
1984
 
        except (errors.NoSuchRevision, errors.RevisionNotPresent):
1985
 
            pass
1986
 
 
1987
 
    def read_basis_inventory(self):
1988
 
        """Read the cached basis inventory."""
1989
 
        path = self._basis_inventory_name()
1990
 
        return self._transport.get_bytes(path)
1991
 
 
1992
 
    @needs_read_lock
1993
 
    def read_working_inventory(self):
1994
 
        """Read the working inventory.
1995
 
 
1996
 
        :raises errors.InventoryModified: read_working_inventory will fail
1997
 
            when the current in memory inventory has been modified.
1998
 
        """
1999
 
        # conceptually this should be an implementation detail of the tree.
2000
 
        # XXX: Deprecate this.
2001
 
        # ElementTree does its own conversion from UTF-8, so open in
2002
 
        # binary.
2003
 
        if self._inventory_is_modified:
2004
 
            raise errors.InventoryModified(self)
2005
 
        f = self._transport.get('inventory')
2006
 
        try:
2007
 
            result = self._deserialize(f)
2008
 
        finally:
2009
 
            f.close()
2010
 
        self._set_inventory(result, dirty=False)
2011
 
        return result
2012
 
 
2013
1267
    @needs_tree_write_lock
2014
1268
    def remove(self, files, verbose=False, to_file=None, keep_files=True,
2015
1269
        force=False):
2016
 
        """Remove nominated files from the working inventory.
 
1270
        """Remove nominated files from the working tree metadata.
2017
1271
 
2018
1272
        :files: File paths relative to the basedir.
2019
1273
        :keep_files: If true, the files will also be kept.
2078
1332
                    files_to_backup.append(path[1])
2079
1333
 
2080
1334
        def backup(file_to_backup):
2081
 
            backup_name = self.bzrdir.generate_backup_name(file_to_backup)
 
1335
            backup_name = self.bzrdir._available_backup_name(file_to_backup)
2082
1336
            osutils.rename(abs_path, self.abspath(backup_name))
2083
 
            return "removed %s (but kept a copy: %s)" % (file_to_backup, backup_name)
 
1337
            return "removed %s (but kept a copy: %s)" % (file_to_backup,
 
1338
                                                         backup_name)
2084
1339
 
2085
1340
        # Build inv_delta and delete files where applicable,
2086
 
        # do this before any modifications to inventory.
 
1341
        # do this before any modifications to meta data.
2087
1342
        for f in files:
2088
1343
            fid = self.path2id(f)
2089
1344
            message = None
2169
1424
        WorkingTree can supply revision_trees for the basis revision only
2170
1425
        because there is only one cached inventory in the bzr directory.
2171
1426
        """
2172
 
        if revision_id == self.last_revision():
2173
 
            try:
2174
 
                xml = self.read_basis_inventory()
2175
 
            except errors.NoSuchFile:
2176
 
                pass
2177
 
            else:
2178
 
                try:
2179
 
                    inv = xml7.serializer_v7.read_inventory_from_string(xml)
2180
 
                    # dont use the repository revision_tree api because we want
2181
 
                    # to supply the inventory.
2182
 
                    if inv.revision_id == revision_id:
2183
 
                        return revisiontree.RevisionTree(self.branch.repository,
2184
 
                            inv, revision_id)
2185
 
                except errors.BadInventoryFormat:
2186
 
                    pass
2187
 
        # raise if there was no inventory, or if we read the wrong inventory.
2188
 
        raise errors.NoSuchRevisionInTree(self, revision_id)
2189
 
 
2190
 
    # XXX: This method should be deprecated in favour of taking in a proper
2191
 
    # new Inventory object.
2192
 
    @needs_tree_write_lock
2193
 
    def set_inventory(self, new_inventory_list):
2194
 
        from bzrlib.inventory import (Inventory,
2195
 
                                      InventoryDirectory,
2196
 
                                      InventoryFile,
2197
 
                                      InventoryLink)
2198
 
        inv = Inventory(self.get_root_id())
2199
 
        for path, file_id, parent, kind in new_inventory_list:
2200
 
            name = os.path.basename(path)
2201
 
            if name == "":
2202
 
                continue
2203
 
            # fixme, there should be a factory function inv,add_??
2204
 
            if kind == 'directory':
2205
 
                inv.add(InventoryDirectory(file_id, name, parent))
2206
 
            elif kind == 'file':
2207
 
                inv.add(InventoryFile(file_id, name, parent))
2208
 
            elif kind == 'symlink':
2209
 
                inv.add(InventoryLink(file_id, name, parent))
2210
 
            else:
2211
 
                raise errors.BzrError("unknown kind %r" % kind)
2212
 
        self._write_inventory(inv)
 
1427
        raise NotImplementedError(self.revision_tree)
2213
1428
 
2214
1429
    @needs_tree_write_lock
2215
1430
    def set_root_id(self, file_id):
2228
1443
            present in the current inventory or an error will occur. It must
2229
1444
            not be None, but rather a valid file id.
2230
1445
        """
2231
 
        inv = self._inventory
2232
 
        orig_root_id = inv.root.file_id
2233
 
        # TODO: it might be nice to exit early if there was nothing
2234
 
        # to do, saving us from trigger a sync on unlock.
2235
 
        self._inventory_is_modified = True
2236
 
        # we preserve the root inventory entry object, but
2237
 
        # unlinkit from the byid index
2238
 
        del inv._byid[inv.root.file_id]
2239
 
        inv.root.file_id = file_id
2240
 
        # and link it into the index with the new changed id.
2241
 
        inv._byid[inv.root.file_id] = inv.root
2242
 
        # and finally update all children to reference the new id.
2243
 
        # XXX: this should be safe to just look at the root.children
2244
 
        # list, not the WHOLE INVENTORY.
2245
 
        for fid in inv:
2246
 
            entry = inv[fid]
2247
 
            if entry.parent_id == orig_root_id:
2248
 
                entry.parent_id = inv.root.file_id
 
1446
        raise NotImplementedError(self._set_root_id)
2249
1447
 
2250
1448
    def unlock(self):
2251
1449
        """See Branch.unlock.
2261
1459
    _marker = object()
2262
1460
 
2263
1461
    def update(self, change_reporter=None, possible_transports=None,
2264
 
               revision=None, old_tip=_marker):
 
1462
               revision=None, old_tip=_marker, show_base=False):
2265
1463
        """Update a working tree along its branch.
2266
1464
 
2267
1465
        This will update the branch if its bound too, which means we have
2304
1502
            else:
2305
1503
                if old_tip is self._marker:
2306
1504
                    old_tip = None
2307
 
            return self._update_tree(old_tip, change_reporter, revision)
 
1505
            return self._update_tree(old_tip, change_reporter, revision, show_base)
2308
1506
        finally:
2309
1507
            self.unlock()
2310
1508
 
2311
1509
    @needs_tree_write_lock
2312
 
    def _update_tree(self, old_tip=None, change_reporter=None, revision=None):
 
1510
    def _update_tree(self, old_tip=None, change_reporter=None, revision=None,
 
1511
                     show_base=False):
2313
1512
        """Update a tree to the master branch.
2314
1513
 
2315
1514
        :param old_tip: if supplied, the previous tip revision the branch,
2342
1541
            other_tree = self.branch.repository.revision_tree(old_tip)
2343
1542
            nb_conflicts = merge.merge_inner(self.branch, other_tree,
2344
1543
                                             base_tree, this_tree=self,
2345
 
                                             change_reporter=change_reporter)
 
1544
                                             change_reporter=change_reporter,
 
1545
                                             show_base=show_base)
2346
1546
            if nb_conflicts:
2347
1547
                self.add_parent_tree((old_tip, other_tree))
2348
 
                trace.note('Rerun update after fixing the conflicts.')
 
1548
                note('Rerun update after fixing the conflicts.')
2349
1549
                return nb_conflicts
2350
1550
 
2351
1551
        if last_rev != _mod_revision.ensure_null(revision):
2357
1557
            basis = self.basis_tree()
2358
1558
            basis.lock_read()
2359
1559
            try:
2360
 
                if (basis.inventory.root is None
2361
 
                    or basis.inventory.root.file_id != to_root_id):
 
1560
                if (basis.get_root_id() is None or basis.get_root_id() != to_root_id):
2362
1561
                    self.set_root_id(to_root_id)
2363
1562
                    self.flush()
2364
1563
            finally:
2372
1571
 
2373
1572
            nb_conflicts = merge.merge_inner(self.branch, to_tree, base_tree,
2374
1573
                                             this_tree=self,
2375
 
                                             change_reporter=change_reporter)
 
1574
                                             change_reporter=change_reporter,
 
1575
                                             show_base=show_base)
2376
1576
            self.set_last_revision(revision)
2377
1577
            # TODO - dedup parents list with things merged by pull ?
2378
1578
            # reuse the tree we've updated to to set the basis:
2405
1605
                #       warning might be sufficient to let the user know what
2406
1606
                #       is going on.
2407
1607
                mutter('Could not write hashcache for %s\nError: %s',
2408
 
                       self._hashcache.cache_file_name(), e)
2409
 
 
2410
 
    @needs_tree_write_lock
2411
 
    def _write_inventory(self, inv):
2412
 
        """Write inventory as the current inventory."""
2413
 
        self._set_inventory(inv, dirty=True)
2414
 
        self.flush()
 
1608
                              self._hashcache.cache_file_name(), e)
2415
1609
 
2416
1610
    def set_conflicts(self, arg):
2417
1611
        raise errors.UnsupportedOperation(self.set_conflicts, self)
2419
1613
    def add_conflicts(self, arg):
2420
1614
        raise errors.UnsupportedOperation(self.add_conflicts, self)
2421
1615
 
2422
 
    @needs_read_lock
2423
1616
    def conflicts(self):
2424
 
        conflicts = _mod_conflicts.ConflictList()
2425
 
        for conflicted in self._iter_conflicts():
2426
 
            text = True
2427
 
            try:
2428
 
                if file_kind(self.abspath(conflicted)) != "file":
2429
 
                    text = False
2430
 
            except errors.NoSuchFile:
2431
 
                text = False
2432
 
            if text is True:
2433
 
                for suffix in ('.THIS', '.OTHER'):
2434
 
                    try:
2435
 
                        kind = file_kind(self.abspath(conflicted+suffix))
2436
 
                        if kind != "file":
2437
 
                            text = False
2438
 
                    except errors.NoSuchFile:
2439
 
                        text = False
2440
 
                    if text == False:
2441
 
                        break
2442
 
            ctype = {True: 'text conflict', False: 'contents conflict'}[text]
2443
 
            conflicts.append(_mod_conflicts.Conflict.factory(ctype,
2444
 
                             path=conflicted,
2445
 
                             file_id=self.path2id(conflicted)))
2446
 
        return conflicts
 
1617
        raise NotImplementedError(self.conflicts)
2447
1618
 
2448
1619
    def walkdirs(self, prefix=""):
2449
1620
        """Walk the directories of this tree.
2575
1746
                 [(file1_path, file1_name, file1_kind, None, file1_id,
2576
1747
                   file1_kind), ... ])
2577
1748
        """
2578
 
        _directory = 'directory'
2579
 
        # get the root in the inventory
2580
 
        inv = self.inventory
2581
 
        top_id = inv.path2id(prefix)
2582
 
        if top_id is None:
2583
 
            pending = []
2584
 
        else:
2585
 
            pending = [(prefix, '', _directory, None, top_id, None)]
2586
 
        while pending:
2587
 
            dirblock = []
2588
 
            currentdir = pending.pop()
2589
 
            # 0 - relpath, 1- basename, 2- kind, 3- stat, 4-id, 5-kind
2590
 
            top_id = currentdir[4]
2591
 
            if currentdir[0]:
2592
 
                relroot = currentdir[0] + '/'
2593
 
            else:
2594
 
                relroot = ""
2595
 
            # FIXME: stash the node in pending
2596
 
            entry = inv[top_id]
2597
 
            if entry.kind == 'directory':
2598
 
                for name, child in entry.sorted_children():
2599
 
                    dirblock.append((relroot + name, name, child.kind, None,
2600
 
                        child.file_id, child.kind
2601
 
                        ))
2602
 
            yield (currentdir[0], entry.file_id), dirblock
2603
 
            # push the user specified dirs from dirblock
2604
 
            for dir in reversed(dirblock):
2605
 
                if dir[2] == _directory:
2606
 
                    pending.append(dir)
 
1749
        raise NotImplementedError(self._walkdirs)
2607
1750
 
2608
1751
    @needs_tree_write_lock
2609
1752
    def auto_resolve(self):
2667
1810
        """
2668
1811
        return
2669
1812
 
 
1813
    @needs_read_lock
 
1814
    def check_state(self):
 
1815
        """Check that the working state is/isn't valid."""
 
1816
        check_refs = self._get_check_refs()
 
1817
        refs = {}
 
1818
        for ref in check_refs:
 
1819
            kind, value = ref
 
1820
            if kind == 'trees':
 
1821
                refs[ref] = self.branch.repository.revision_tree(value)
 
1822
        self._check(refs)
 
1823
 
 
1824
    def reset_state(self, revision_ids=None):
 
1825
        """Reset the state of the working tree.
 
1826
 
 
1827
        This does a hard-reset to a last-known-good state. This is a way to
 
1828
        fix if something got corrupted (like the .bzr/checkout/dirstate file)
 
1829
        """
 
1830
        raise NotImplementedError(self.reset_state)
 
1831
 
2670
1832
    def _get_rules_searcher(self, default_searcher):
2671
1833
        """See Tree._get_rules_searcher."""
2672
1834
        if self._rules_searcher is None:
2680
1842
        return ShelfManager(self, self._transport)
2681
1843
 
2682
1844
 
2683
 
class WorkingTree2(WorkingTree):
2684
 
    """This is the Format 2 working tree.
2685
 
 
2686
 
    This was the first weave based working tree.
2687
 
     - uses os locks for locking.
2688
 
     - uses the branch last-revision.
 
1845
class InventoryWorkingTree(WorkingTree,
 
1846
        bzrlib.mutabletree.MutableInventoryTree):
 
1847
    """Base class for working trees that are inventory-oriented.
 
1848
 
 
1849
    The inventory is held in the `Branch` working-inventory, and the
 
1850
    files are in a directory on disk.
 
1851
 
 
1852
    It is possible for a `WorkingTree` to have a filename which is
 
1853
    not listed in the Inventory and vice versa.
2689
1854
    """
2690
1855
 
2691
 
    def __init__(self, *args, **kwargs):
2692
 
        super(WorkingTree2, self).__init__(*args, **kwargs)
2693
 
        # WorkingTree2 has more of a constraint that self._inventory must
2694
 
        # exist. Because this is an older format, we don't mind the overhead
2695
 
        # caused by the extra computation here.
2696
 
 
2697
 
        # Newer WorkingTree's should only have self._inventory set when they
2698
 
        # have a read lock.
2699
 
        if self._inventory is None:
2700
 
            self.read_working_inventory()
2701
 
 
2702
 
    def _get_check_refs(self):
2703
 
        """Return the references needed to perform a check of this tree."""
2704
 
        return [('trees', self.last_revision())]
2705
 
 
2706
 
    def lock_tree_write(self):
2707
 
        """See WorkingTree.lock_tree_write().
2708
 
 
2709
 
        In Format2 WorkingTrees we have a single lock for the branch and tree
2710
 
        so lock_tree_write() degrades to lock_write().
2711
 
 
2712
 
        :return: An object with an unlock method which will release the lock
2713
 
            obtained.
2714
 
        """
2715
 
        self.branch.lock_write()
2716
 
        try:
2717
 
            self._control_files.lock_write()
2718
 
            return self
2719
 
        except:
2720
 
            self.branch.unlock()
2721
 
            raise
2722
 
 
2723
 
    def unlock(self):
2724
 
        # do non-implementation specific cleanup
2725
 
        self._cleanup()
2726
 
 
2727
 
        # we share control files:
2728
 
        if self._control_files._lock_count == 3:
2729
 
            # _inventory_is_modified is always False during a read lock.
2730
 
            if self._inventory_is_modified:
2731
 
                self.flush()
2732
 
            self._write_hashcache_if_dirty()
2733
 
 
2734
 
        # reverse order of locking.
2735
 
        try:
2736
 
            return self._control_files.unlock()
 
1856
    def __init__(self, basedir='.',
 
1857
                 branch=DEPRECATED_PARAMETER,
 
1858
                 _inventory=None,
 
1859
                 _control_files=None,
 
1860
                 _internal=False,
 
1861
                 _format=None,
 
1862
                 _bzrdir=None):
 
1863
        """Construct a InventoryWorkingTree instance. This is not a public API.
 
1864
 
 
1865
        :param branch: A branch to override probing for the branch.
 
1866
        """
 
1867
        super(InventoryWorkingTree, self).__init__(basedir=basedir,
 
1868
            branch=branch, _control_files=_control_files, _internal=_internal,
 
1869
            _format=_format, _bzrdir=_bzrdir)
 
1870
 
 
1871
        if _inventory is None:
 
1872
            # This will be acquired on lock_read() or lock_write()
 
1873
            self._inventory_is_modified = False
 
1874
            self._inventory = None
 
1875
        else:
 
1876
            # the caller of __init__ has provided an inventory,
 
1877
            # we assume they know what they are doing - as its only
 
1878
            # the Format factory and creation methods that are
 
1879
            # permitted to do this.
 
1880
            self._set_inventory(_inventory, dirty=False)
 
1881
 
 
1882
    def _set_inventory(self, inv, dirty):
 
1883
        """Set the internal cached inventory.
 
1884
 
 
1885
        :param inv: The inventory to set.
 
1886
        :param dirty: A boolean indicating whether the inventory is the same
 
1887
            logical inventory as whats on disk. If True the inventory is not
 
1888
            the same and should be written to disk or data will be lost, if
 
1889
            False then the inventory is the same as that on disk and any
 
1890
            serialisation would be unneeded overhead.
 
1891
        """
 
1892
        self._inventory = inv
 
1893
        self._inventory_is_modified = dirty
 
1894
 
 
1895
    def _serialize(self, inventory, out_file):
 
1896
        xml5.serializer_v5.write_inventory(self._inventory, out_file,
 
1897
            working=True)
 
1898
 
 
1899
    def _deserialize(selt, in_file):
 
1900
        return xml5.serializer_v5.read_inventory(in_file)
 
1901
 
 
1902
    @needs_tree_write_lock
 
1903
    def _write_inventory(self, inv):
 
1904
        """Write inventory as the current inventory."""
 
1905
        self._set_inventory(inv, dirty=True)
 
1906
        self.flush()
 
1907
 
 
1908
    # XXX: This method should be deprecated in favour of taking in a proper
 
1909
    # new Inventory object.
 
1910
    @needs_tree_write_lock
 
1911
    def set_inventory(self, new_inventory_list):
 
1912
        from bzrlib.inventory import (Inventory,
 
1913
                                      InventoryDirectory,
 
1914
                                      InventoryFile,
 
1915
                                      InventoryLink)
 
1916
        inv = Inventory(self.get_root_id())
 
1917
        for path, file_id, parent, kind in new_inventory_list:
 
1918
            name = os.path.basename(path)
 
1919
            if name == "":
 
1920
                continue
 
1921
            # fixme, there should be a factory function inv,add_??
 
1922
            if kind == 'directory':
 
1923
                inv.add(InventoryDirectory(file_id, name, parent))
 
1924
            elif kind == 'file':
 
1925
                inv.add(InventoryFile(file_id, name, parent))
 
1926
            elif kind == 'symlink':
 
1927
                inv.add(InventoryLink(file_id, name, parent))
 
1928
            else:
 
1929
                raise errors.BzrError("unknown kind %r" % kind)
 
1930
        self._write_inventory(inv)
 
1931
 
 
1932
    def _write_basis_inventory(self, xml):
 
1933
        """Write the basis inventory XML to the basis-inventory file"""
 
1934
        path = self._basis_inventory_name()
 
1935
        sio = StringIO(xml)
 
1936
        self._transport.put_file(path, sio,
 
1937
            mode=self.bzrdir._get_file_mode())
 
1938
 
 
1939
    def _reset_data(self):
 
1940
        """Reset transient data that cannot be revalidated."""
 
1941
        self._inventory_is_modified = False
 
1942
        f = self._transport.get('inventory')
 
1943
        try:
 
1944
            result = self._deserialize(f)
2737
1945
        finally:
2738
 
            self.branch.unlock()
2739
 
 
2740
 
 
2741
 
class WorkingTree3(WorkingTree):
2742
 
    """This is the Format 3 working tree.
2743
 
 
2744
 
    This differs from the base WorkingTree by:
2745
 
     - having its own file lock
2746
 
     - having its own last-revision property.
2747
 
 
2748
 
    This is new in bzr 0.8
2749
 
    """
2750
 
 
2751
 
    @needs_read_lock
2752
 
    def _last_revision(self):
2753
 
        """See Mutable.last_revision."""
 
1946
            f.close()
 
1947
        self._set_inventory(result, dirty=False)
 
1948
 
 
1949
    def _set_root_id(self, file_id):
 
1950
        """Set the root id for this tree, in a format specific manner.
 
1951
 
 
1952
        :param file_id: The file id to assign to the root. It must not be
 
1953
            present in the current inventory or an error will occur. It must
 
1954
            not be None, but rather a valid file id.
 
1955
        """
 
1956
        inv = self._inventory
 
1957
        orig_root_id = inv.root.file_id
 
1958
        # TODO: it might be nice to exit early if there was nothing
 
1959
        # to do, saving us from trigger a sync on unlock.
 
1960
        self._inventory_is_modified = True
 
1961
        # we preserve the root inventory entry object, but
 
1962
        # unlinkit from the byid index
 
1963
        del inv._byid[inv.root.file_id]
 
1964
        inv.root.file_id = file_id
 
1965
        # and link it into the index with the new changed id.
 
1966
        inv._byid[inv.root.file_id] = inv.root
 
1967
        # and finally update all children to reference the new id.
 
1968
        # XXX: this should be safe to just look at the root.children
 
1969
        # list, not the WHOLE INVENTORY.
 
1970
        for fid in inv:
 
1971
            entry = inv[fid]
 
1972
            if entry.parent_id == orig_root_id:
 
1973
                entry.parent_id = inv.root.file_id
 
1974
 
 
1975
    def all_file_ids(self):
 
1976
        """See Tree.iter_all_file_ids"""
 
1977
        return set(self.inventory)
 
1978
 
 
1979
    @needs_tree_write_lock
 
1980
    def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
 
1981
        """See MutableTree.set_parent_trees."""
 
1982
        parent_ids = [rev for (rev, tree) in parents_list]
 
1983
        for revision_id in parent_ids:
 
1984
            _mod_revision.check_not_reserved_id(revision_id)
 
1985
 
 
1986
        self._check_parents_for_ghosts(parent_ids,
 
1987
            allow_leftmost_as_ghost=allow_leftmost_as_ghost)
 
1988
 
 
1989
        parent_ids = self._filter_parent_ids_by_ancestry(parent_ids)
 
1990
 
 
1991
        if len(parent_ids) == 0:
 
1992
            leftmost_parent_id = _mod_revision.NULL_REVISION
 
1993
            leftmost_parent_tree = None
 
1994
        else:
 
1995
            leftmost_parent_id, leftmost_parent_tree = parents_list[0]
 
1996
 
 
1997
        if self._change_last_revision(leftmost_parent_id):
 
1998
            if leftmost_parent_tree is None:
 
1999
                # If we don't have a tree, fall back to reading the
 
2000
                # parent tree from the repository.
 
2001
                self._cache_basis_inventory(leftmost_parent_id)
 
2002
            else:
 
2003
                inv = leftmost_parent_tree.inventory
 
2004
                xml = self._create_basis_xml_from_inventory(
 
2005
                                        leftmost_parent_id, inv)
 
2006
                self._write_basis_inventory(xml)
 
2007
        self._set_merges_from_parent_ids(parent_ids)
 
2008
 
 
2009
    def _cache_basis_inventory(self, new_revision):
 
2010
        """Cache new_revision as the basis inventory."""
 
2011
        # TODO: this should allow the ready-to-use inventory to be passed in,
 
2012
        # as commit already has that ready-to-use [while the format is the
 
2013
        # same, that is].
2754
2014
        try:
2755
 
            return self._transport.get_bytes('last-revision')
2756
 
        except errors.NoSuchFile:
2757
 
            return _mod_revision.NULL_REVISION
2758
 
 
2759
 
    def _change_last_revision(self, revision_id):
2760
 
        """See WorkingTree._change_last_revision."""
2761
 
        if revision_id is None or revision_id == _mod_revision.NULL_REVISION:
2762
 
            try:
2763
 
                self._transport.delete('last-revision')
2764
 
            except errors.NoSuchFile:
2765
 
                pass
2766
 
            return False
2767
 
        else:
2768
 
            self._transport.put_bytes('last-revision', revision_id,
2769
 
                mode=self.bzrdir._get_file_mode())
2770
 
            return True
2771
 
 
2772
 
    def _get_check_refs(self):
2773
 
        """Return the references needed to perform a check of this tree."""
2774
 
        return [('trees', self.last_revision())]
 
2015
            # this double handles the inventory - unpack and repack -
 
2016
            # but is easier to understand. We can/should put a conditional
 
2017
            # in here based on whether the inventory is in the latest format
 
2018
            # - perhaps we should repack all inventories on a repository
 
2019
            # upgrade ?
 
2020
            # the fast path is to copy the raw xml from the repository. If the
 
2021
            # xml contains 'revision_id="', then we assume the right
 
2022
            # revision_id is set. We must check for this full string, because a
 
2023
            # root node id can legitimately look like 'revision_id' but cannot
 
2024
            # contain a '"'.
 
2025
            xml = self.branch.repository._get_inventory_xml(new_revision)
 
2026
            firstline = xml.split('\n', 1)[0]
 
2027
            if (not 'revision_id="' in firstline or
 
2028
                'format="7"' not in firstline):
 
2029
                inv = self.branch.repository._serializer.read_inventory_from_string(
 
2030
                    xml, new_revision)
 
2031
                xml = self._create_basis_xml_from_inventory(new_revision, inv)
 
2032
            self._write_basis_inventory(xml)
 
2033
        except (errors.NoSuchRevision, errors.RevisionNotPresent):
 
2034
            pass
 
2035
 
 
2036
    def _basis_inventory_name(self):
 
2037
        return 'basis-inventory-cache'
 
2038
 
 
2039
    def _create_basis_xml_from_inventory(self, revision_id, inventory):
 
2040
        """Create the text that will be saved in basis-inventory"""
 
2041
        inventory.revision_id = revision_id
 
2042
        return xml7.serializer_v7.write_inventory_to_string(inventory)
2775
2043
 
2776
2044
    @needs_tree_write_lock
2777
2045
    def set_conflicts(self, conflicts):
2797
2065
                    raise errors.ConflictFormatError()
2798
2066
            except StopIteration:
2799
2067
                raise errors.ConflictFormatError()
2800
 
            return _mod_conflicts.ConflictList.from_stanzas(RioReader(confile))
 
2068
            reader = _mod_rio.RioReader(confile)
 
2069
            return _mod_conflicts.ConflictList.from_stanzas(reader)
2801
2070
        finally:
2802
2071
            confile.close()
2803
2072
 
2804
 
    def unlock(self):
2805
 
        # do non-implementation specific cleanup
2806
 
        self._cleanup()
2807
 
        if self._control_files._lock_count == 1:
2808
 
            # _inventory_is_modified is always False during a read lock.
2809
 
            if self._inventory_is_modified:
2810
 
                self.flush()
2811
 
            self._write_hashcache_if_dirty()
2812
 
        # reverse order of locking.
2813
 
        try:
2814
 
            return self._control_files.unlock()
2815
 
        finally:
2816
 
            self.branch.unlock()
2817
 
 
2818
 
 
2819
 
def get_conflicted_stem(path):
2820
 
    for suffix in _mod_conflicts.CONFLICT_SUFFIXES:
2821
 
        if path.endswith(suffix):
2822
 
            return path[:-len(suffix)]
2823
 
 
2824
 
 
2825
 
class WorkingTreeFormat(object):
 
2073
    def read_basis_inventory(self):
 
2074
        """Read the cached basis inventory."""
 
2075
        path = self._basis_inventory_name()
 
2076
        return self._transport.get_bytes(path)
 
2077
 
 
2078
    @needs_read_lock
 
2079
    def read_working_inventory(self):
 
2080
        """Read the working inventory.
 
2081
 
 
2082
        :raises errors.InventoryModified: read_working_inventory will fail
 
2083
            when the current in memory inventory has been modified.
 
2084
        """
 
2085
        # conceptually this should be an implementation detail of the tree.
 
2086
        # XXX: Deprecate this.
 
2087
        # ElementTree does its own conversion from UTF-8, so open in
 
2088
        # binary.
 
2089
        if self._inventory_is_modified:
 
2090
            raise errors.InventoryModified(self)
 
2091
        f = self._transport.get('inventory')
 
2092
        try:
 
2093
            result = self._deserialize(f)
 
2094
        finally:
 
2095
            f.close()
 
2096
        self._set_inventory(result, dirty=False)
 
2097
        return result
 
2098
 
 
2099
    @needs_read_lock
 
2100
    def get_root_id(self):
 
2101
        """Return the id of this trees root"""
 
2102
        return self._inventory.root.file_id
 
2103
 
 
2104
    def has_id(self, file_id):
 
2105
        # files that have been deleted are excluded
 
2106
        inv = self.inventory
 
2107
        if not inv.has_id(file_id):
 
2108
            return False
 
2109
        path = inv.id2path(file_id)
 
2110
        return osutils.lexists(self.abspath(path))
 
2111
 
 
2112
    def has_or_had_id(self, file_id):
 
2113
        if file_id == self.inventory.root.file_id:
 
2114
            return True
 
2115
        return self.inventory.has_id(file_id)
 
2116
 
 
2117
    __contains__ = has_id
 
2118
 
 
2119
    @symbol_versioning.deprecated_method(symbol_versioning.deprecated_in((2, 4, 0)))
 
2120
    def __iter__(self):
 
2121
        """Iterate through file_ids for this tree.
 
2122
 
 
2123
        file_ids are in a WorkingTree if they are in the working inventory
 
2124
        and the working file exists.
 
2125
        """
 
2126
        inv = self._inventory
 
2127
        for path, ie in inv.iter_entries():
 
2128
            if osutils.lexists(self.abspath(path)):
 
2129
                yield ie.file_id
 
2130
 
 
2131
    @needs_tree_write_lock
 
2132
    def set_last_revision(self, new_revision):
 
2133
        """Change the last revision in the working tree."""
 
2134
        if self._change_last_revision(new_revision):
 
2135
            self._cache_basis_inventory(new_revision)
 
2136
 
 
2137
    @needs_tree_write_lock
 
2138
    def reset_state(self, revision_ids=None):
 
2139
        """Reset the state of the working tree.
 
2140
 
 
2141
        This does a hard-reset to a last-known-good state. This is a way to
 
2142
        fix if something got corrupted (like the .bzr/checkout/dirstate file)
 
2143
        """
 
2144
        if revision_ids is None:
 
2145
            revision_ids = self.get_parent_ids()
 
2146
        if not revision_ids:
 
2147
            rt = self.branch.repository.revision_tree(
 
2148
                _mod_revision.NULL_REVISION)
 
2149
        else:
 
2150
            rt = self.branch.repository.revision_tree(revision_ids[0])
 
2151
        self._write_inventory(rt.inventory)
 
2152
        self.set_parent_ids(revision_ids)
 
2153
 
 
2154
    def flush(self):
 
2155
        """Write the in memory inventory to disk."""
 
2156
        # TODO: Maybe this should only write on dirty ?
 
2157
        if self._control_files._lock_mode != 'w':
 
2158
            raise errors.NotWriteLocked(self)
 
2159
        sio = StringIO()
 
2160
        self._serialize(self._inventory, sio)
 
2161
        sio.seek(0)
 
2162
        self._transport.put_file('inventory', sio,
 
2163
            mode=self.bzrdir._get_file_mode())
 
2164
        self._inventory_is_modified = False
 
2165
 
 
2166
    @needs_read_lock
 
2167
    def get_file_sha1(self, file_id, path=None, stat_value=None):
 
2168
        if not path:
 
2169
            path = self._inventory.id2path(file_id)
 
2170
        return self._hashcache.get_sha1(path, stat_value)
 
2171
 
 
2172
    def get_file_mtime(self, file_id, path=None):
 
2173
        """See Tree.get_file_mtime."""
 
2174
        if not path:
 
2175
            path = self.inventory.id2path(file_id)
 
2176
        return os.lstat(self.abspath(path)).st_mtime
 
2177
 
 
2178
    def _is_executable_from_path_and_stat_from_basis(self, path, stat_result):
 
2179
        file_id = self.path2id(path)
 
2180
        if file_id is None:
 
2181
            # For unversioned files on win32, we just assume they are not
 
2182
            # executable
 
2183
            return False
 
2184
        return self._inventory[file_id].executable
 
2185
 
 
2186
    def _is_executable_from_path_and_stat_from_stat(self, path, stat_result):
 
2187
        mode = stat_result.st_mode
 
2188
        return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
 
2189
 
 
2190
    if not supports_executable():
 
2191
        def is_executable(self, file_id, path=None):
 
2192
            return self._inventory[file_id].executable
 
2193
 
 
2194
        _is_executable_from_path_and_stat = \
 
2195
            _is_executable_from_path_and_stat_from_basis
 
2196
    else:
 
2197
        def is_executable(self, file_id, path=None):
 
2198
            if not path:
 
2199
                path = self.id2path(file_id)
 
2200
            mode = os.lstat(self.abspath(path)).st_mode
 
2201
            return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
 
2202
 
 
2203
        _is_executable_from_path_and_stat = \
 
2204
            _is_executable_from_path_and_stat_from_stat
 
2205
 
 
2206
    @needs_tree_write_lock
 
2207
    def _add(self, files, ids, kinds):
 
2208
        """See MutableTree._add."""
 
2209
        # TODO: Re-adding a file that is removed in the working copy
 
2210
        # should probably put it back with the previous ID.
 
2211
        # the read and write working inventory should not occur in this
 
2212
        # function - they should be part of lock_write and unlock.
 
2213
        inv = self.inventory
 
2214
        for f, file_id, kind in zip(files, ids, kinds):
 
2215
            if file_id is None:
 
2216
                inv.add_path(f, kind=kind)
 
2217
            else:
 
2218
                inv.add_path(f, kind=kind, file_id=file_id)
 
2219
            self._inventory_is_modified = True
 
2220
 
 
2221
    def revision_tree(self, revision_id):
 
2222
        """See WorkingTree.revision_id."""
 
2223
        if revision_id == self.last_revision():
 
2224
            try:
 
2225
                xml = self.read_basis_inventory()
 
2226
            except errors.NoSuchFile:
 
2227
                pass
 
2228
            else:
 
2229
                try:
 
2230
                    inv = xml7.serializer_v7.read_inventory_from_string(xml)
 
2231
                    # dont use the repository revision_tree api because we want
 
2232
                    # to supply the inventory.
 
2233
                    if inv.revision_id == revision_id:
 
2234
                        return revisiontree.InventoryRevisionTree(
 
2235
                            self.branch.repository, inv, revision_id)
 
2236
                except errors.BadInventoryFormat:
 
2237
                    pass
 
2238
        # raise if there was no inventory, or if we read the wrong inventory.
 
2239
        raise errors.NoSuchRevisionInTree(self, revision_id)
 
2240
 
 
2241
    @needs_read_lock
 
2242
    def annotate_iter(self, file_id, default_revision=CURRENT_REVISION):
 
2243
        """See Tree.annotate_iter
 
2244
 
 
2245
        This implementation will use the basis tree implementation if possible.
 
2246
        Lines not in the basis are attributed to CURRENT_REVISION
 
2247
 
 
2248
        If there are pending merges, lines added by those merges will be
 
2249
        incorrectly attributed to CURRENT_REVISION (but after committing, the
 
2250
        attribution will be correct).
 
2251
        """
 
2252
        maybe_file_parent_keys = []
 
2253
        for parent_id in self.get_parent_ids():
 
2254
            try:
 
2255
                parent_tree = self.revision_tree(parent_id)
 
2256
            except errors.NoSuchRevisionInTree:
 
2257
                parent_tree = self.branch.repository.revision_tree(parent_id)
 
2258
            parent_tree.lock_read()
 
2259
            try:
 
2260
                if file_id not in parent_tree:
 
2261
                    continue
 
2262
                ie = parent_tree.inventory[file_id]
 
2263
                if ie.kind != 'file':
 
2264
                    # Note: this is slightly unnecessary, because symlinks and
 
2265
                    # directories have a "text" which is the empty text, and we
 
2266
                    # know that won't mess up annotations. But it seems cleaner
 
2267
                    continue
 
2268
                parent_text_key = (file_id, ie.revision)
 
2269
                if parent_text_key not in maybe_file_parent_keys:
 
2270
                    maybe_file_parent_keys.append(parent_text_key)
 
2271
            finally:
 
2272
                parent_tree.unlock()
 
2273
        graph = _mod_graph.Graph(self.branch.repository.texts)
 
2274
        heads = graph.heads(maybe_file_parent_keys)
 
2275
        file_parent_keys = []
 
2276
        for key in maybe_file_parent_keys:
 
2277
            if key in heads:
 
2278
                file_parent_keys.append(key)
 
2279
 
 
2280
        # Now we have the parents of this content
 
2281
        annotator = self.branch.repository.texts.get_annotator()
 
2282
        text = self.get_file_text(file_id)
 
2283
        this_key =(file_id, default_revision)
 
2284
        annotator.add_special_text(this_key, file_parent_keys, text)
 
2285
        annotations = [(key[-1], line)
 
2286
                       for key, line in annotator.annotate_flat(this_key)]
 
2287
        return annotations
 
2288
 
 
2289
    @needs_read_lock
 
2290
    def merge_modified(self):
 
2291
        """Return a dictionary of files modified by a merge.
 
2292
 
 
2293
        The list is initialized by WorkingTree.set_merge_modified, which is
 
2294
        typically called after we make some automatic updates to the tree
 
2295
        because of a merge.
 
2296
 
 
2297
        This returns a map of file_id->sha1, containing only files which are
 
2298
        still in the working inventory and have that text hash.
 
2299
        """
 
2300
        try:
 
2301
            hashfile = self._transport.get('merge-hashes')
 
2302
        except errors.NoSuchFile:
 
2303
            return {}
 
2304
        try:
 
2305
            merge_hashes = {}
 
2306
            try:
 
2307
                if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
 
2308
                    raise errors.MergeModifiedFormatError()
 
2309
            except StopIteration:
 
2310
                raise errors.MergeModifiedFormatError()
 
2311
            for s in _mod_rio.RioReader(hashfile):
 
2312
                # RioReader reads in Unicode, so convert file_ids back to utf8
 
2313
                file_id = osutils.safe_file_id(s.get("file_id"), warn=False)
 
2314
                if file_id not in self.inventory:
 
2315
                    continue
 
2316
                text_hash = s.get("hash")
 
2317
                if text_hash == self.get_file_sha1(file_id):
 
2318
                    merge_hashes[file_id] = text_hash
 
2319
            return merge_hashes
 
2320
        finally:
 
2321
            hashfile.close()
 
2322
 
 
2323
    @needs_write_lock
 
2324
    def subsume(self, other_tree):
 
2325
        def add_children(inventory, entry):
 
2326
            for child_entry in entry.children.values():
 
2327
                inventory._byid[child_entry.file_id] = child_entry
 
2328
                if child_entry.kind == 'directory':
 
2329
                    add_children(inventory, child_entry)
 
2330
        if other_tree.get_root_id() == self.get_root_id():
 
2331
            raise errors.BadSubsumeSource(self, other_tree,
 
2332
                                          'Trees have the same root')
 
2333
        try:
 
2334
            other_tree_path = self.relpath(other_tree.basedir)
 
2335
        except errors.PathNotChild:
 
2336
            raise errors.BadSubsumeSource(self, other_tree,
 
2337
                'Tree is not contained by the other')
 
2338
        new_root_parent = self.path2id(osutils.dirname(other_tree_path))
 
2339
        if new_root_parent is None:
 
2340
            raise errors.BadSubsumeSource(self, other_tree,
 
2341
                'Parent directory is not versioned.')
 
2342
        # We need to ensure that the result of a fetch will have a
 
2343
        # versionedfile for the other_tree root, and only fetching into
 
2344
        # RepositoryKnit2 guarantees that.
 
2345
        if not self.branch.repository.supports_rich_root():
 
2346
            raise errors.SubsumeTargetNeedsUpgrade(other_tree)
 
2347
        other_tree.lock_tree_write()
 
2348
        try:
 
2349
            new_parents = other_tree.get_parent_ids()
 
2350
            other_root = other_tree.inventory.root
 
2351
            other_root.parent_id = new_root_parent
 
2352
            other_root.name = osutils.basename(other_tree_path)
 
2353
            self.inventory.add(other_root)
 
2354
            add_children(self.inventory, other_root)
 
2355
            self._write_inventory(self.inventory)
 
2356
            # normally we don't want to fetch whole repositories, but i think
 
2357
            # here we really do want to consolidate the whole thing.
 
2358
            for parent_id in other_tree.get_parent_ids():
 
2359
                self.branch.fetch(other_tree.branch, parent_id)
 
2360
                self.add_parent_tree_id(parent_id)
 
2361
        finally:
 
2362
            other_tree.unlock()
 
2363
        other_tree.bzrdir.retire_bzrdir()
 
2364
 
 
2365
    @needs_tree_write_lock
 
2366
    def extract(self, file_id, format=None):
 
2367
        """Extract a subtree from this tree.
 
2368
 
 
2369
        A new branch will be created, relative to the path for this tree.
 
2370
        """
 
2371
        self.flush()
 
2372
        def mkdirs(path):
 
2373
            segments = osutils.splitpath(path)
 
2374
            transport = self.branch.bzrdir.root_transport
 
2375
            for name in segments:
 
2376
                transport = transport.clone(name)
 
2377
                transport.ensure_base()
 
2378
            return transport
 
2379
 
 
2380
        sub_path = self.id2path(file_id)
 
2381
        branch_transport = mkdirs(sub_path)
 
2382
        if format is None:
 
2383
            format = self.bzrdir.cloning_metadir()
 
2384
        branch_transport.ensure_base()
 
2385
        branch_bzrdir = format.initialize_on_transport(branch_transport)
 
2386
        try:
 
2387
            repo = branch_bzrdir.find_repository()
 
2388
        except errors.NoRepositoryPresent:
 
2389
            repo = branch_bzrdir.create_repository()
 
2390
        if not repo.supports_rich_root():
 
2391
            raise errors.RootNotRich()
 
2392
        new_branch = branch_bzrdir.create_branch()
 
2393
        new_branch.pull(self.branch)
 
2394
        for parent_id in self.get_parent_ids():
 
2395
            new_branch.fetch(self.branch, parent_id)
 
2396
        tree_transport = self.bzrdir.root_transport.clone(sub_path)
 
2397
        if tree_transport.base != branch_transport.base:
 
2398
            tree_bzrdir = format.initialize_on_transport(tree_transport)
 
2399
            branch.BranchReferenceFormat().initialize(tree_bzrdir,
 
2400
                target_branch=new_branch)
 
2401
        else:
 
2402
            tree_bzrdir = branch_bzrdir
 
2403
        wt = tree_bzrdir.create_workingtree(_mod_revision.NULL_REVISION)
 
2404
        wt.set_parent_ids(self.get_parent_ids())
 
2405
        my_inv = self.inventory
 
2406
        child_inv = inventory.Inventory(root_id=None)
 
2407
        new_root = my_inv[file_id]
 
2408
        my_inv.remove_recursive_id(file_id)
 
2409
        new_root.parent_id = None
 
2410
        child_inv.add(new_root)
 
2411
        self._write_inventory(my_inv)
 
2412
        wt._write_inventory(child_inv)
 
2413
        return wt
 
2414
 
 
2415
    def list_files(self, include_root=False, from_dir=None, recursive=True):
 
2416
        """List all files as (path, class, kind, id, entry).
 
2417
 
 
2418
        Lists, but does not descend into unversioned directories.
 
2419
        This does not include files that have been deleted in this
 
2420
        tree. Skips the control directory.
 
2421
 
 
2422
        :param include_root: if True, return an entry for the root
 
2423
        :param from_dir: start from this directory or None for the root
 
2424
        :param recursive: whether to recurse into subdirectories or not
 
2425
        """
 
2426
        # list_files is an iterator, so @needs_read_lock doesn't work properly
 
2427
        # with it. So callers should be careful to always read_lock the tree.
 
2428
        if not self.is_locked():
 
2429
            raise errors.ObjectNotLocked(self)
 
2430
 
 
2431
        inv = self.inventory
 
2432
        if from_dir is None and include_root is True:
 
2433
            yield ('', 'V', 'directory', inv.root.file_id, inv.root)
 
2434
        # Convert these into local objects to save lookup times
 
2435
        pathjoin = osutils.pathjoin
 
2436
        file_kind = self._kind
 
2437
 
 
2438
        # transport.base ends in a slash, we want the piece
 
2439
        # between the last two slashes
 
2440
        transport_base_dir = self.bzrdir.transport.base.rsplit('/', 2)[1]
 
2441
 
 
2442
        fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
 
2443
 
 
2444
        # directory file_id, relative path, absolute path, reverse sorted children
 
2445
        if from_dir is not None:
 
2446
            from_dir_id = inv.path2id(from_dir)
 
2447
            if from_dir_id is None:
 
2448
                # Directory not versioned
 
2449
                return
 
2450
            from_dir_abspath = pathjoin(self.basedir, from_dir)
 
2451
        else:
 
2452
            from_dir_id = inv.root.file_id
 
2453
            from_dir_abspath = self.basedir
 
2454
        children = os.listdir(from_dir_abspath)
 
2455
        children.sort()
 
2456
        # jam 20060527 The kernel sized tree seems equivalent whether we
 
2457
        # use a deque and popleft to keep them sorted, or if we use a plain
 
2458
        # list and just reverse() them.
 
2459
        children = collections.deque(children)
 
2460
        stack = [(from_dir_id, u'', from_dir_abspath, children)]
 
2461
        while stack:
 
2462
            from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
 
2463
 
 
2464
            while children:
 
2465
                f = children.popleft()
 
2466
                ## TODO: If we find a subdirectory with its own .bzr
 
2467
                ## directory, then that is a separate tree and we
 
2468
                ## should exclude it.
 
2469
 
 
2470
                # the bzrdir for this tree
 
2471
                if transport_base_dir == f:
 
2472
                    continue
 
2473
 
 
2474
                # we know that from_dir_relpath and from_dir_abspath never end in a slash
 
2475
                # and 'f' doesn't begin with one, we can do a string op, rather
 
2476
                # than the checks of pathjoin(), all relative paths will have an extra slash
 
2477
                # at the beginning
 
2478
                fp = from_dir_relpath + '/' + f
 
2479
 
 
2480
                # absolute path
 
2481
                fap = from_dir_abspath + '/' + f
 
2482
 
 
2483
                dir_ie = inv[from_dir_id]
 
2484
                if dir_ie.kind == 'directory':
 
2485
                    f_ie = dir_ie.children.get(f)
 
2486
                else:
 
2487
                    f_ie = None
 
2488
                if f_ie:
 
2489
                    c = 'V'
 
2490
                elif self.is_ignored(fp[1:]):
 
2491
                    c = 'I'
 
2492
                else:
 
2493
                    # we may not have found this file, because of a unicode
 
2494
                    # issue, or because the directory was actually a symlink.
 
2495
                    f_norm, can_access = osutils.normalized_filename(f)
 
2496
                    if f == f_norm or not can_access:
 
2497
                        # No change, so treat this file normally
 
2498
                        c = '?'
 
2499
                    else:
 
2500
                        # this file can be accessed by a normalized path
 
2501
                        # check again if it is versioned
 
2502
                        # these lines are repeated here for performance
 
2503
                        f = f_norm
 
2504
                        fp = from_dir_relpath + '/' + f
 
2505
                        fap = from_dir_abspath + '/' + f
 
2506
                        f_ie = inv.get_child(from_dir_id, f)
 
2507
                        if f_ie:
 
2508
                            c = 'V'
 
2509
                        elif self.is_ignored(fp[1:]):
 
2510
                            c = 'I'
 
2511
                        else:
 
2512
                            c = '?'
 
2513
 
 
2514
                fk = file_kind(fap)
 
2515
 
 
2516
                # make a last minute entry
 
2517
                if f_ie:
 
2518
                    yield fp[1:], c, fk, f_ie.file_id, f_ie
 
2519
                else:
 
2520
                    try:
 
2521
                        yield fp[1:], c, fk, None, fk_entries[fk]()
 
2522
                    except KeyError:
 
2523
                        yield fp[1:], c, fk, None, TreeEntry()
 
2524
                    continue
 
2525
 
 
2526
                if fk != 'directory':
 
2527
                    continue
 
2528
 
 
2529
                # But do this child first if recursing down
 
2530
                if recursive:
 
2531
                    new_children = os.listdir(fap)
 
2532
                    new_children.sort()
 
2533
                    new_children = collections.deque(new_children)
 
2534
                    stack.append((f_ie.file_id, fp, fap, new_children))
 
2535
                    # Break out of inner loop,
 
2536
                    # so that we start outer loop with child
 
2537
                    break
 
2538
            else:
 
2539
                # if we finished all children, pop it off the stack
 
2540
                stack.pop()
 
2541
 
 
2542
    @needs_tree_write_lock
 
2543
    def move(self, from_paths, to_dir=None, after=False):
 
2544
        """Rename files.
 
2545
 
 
2546
        to_dir must exist in the inventory.
 
2547
 
 
2548
        If to_dir exists and is a directory, the files are moved into
 
2549
        it, keeping their old names.
 
2550
 
 
2551
        Note that to_dir is only the last component of the new name;
 
2552
        this doesn't change the directory.
 
2553
 
 
2554
        For each entry in from_paths the move mode will be determined
 
2555
        independently.
 
2556
 
 
2557
        The first mode moves the file in the filesystem and updates the
 
2558
        inventory. The second mode only updates the inventory without
 
2559
        touching the file on the filesystem.
 
2560
 
 
2561
        move uses the second mode if 'after == True' and the target is not
 
2562
        versioned but present in the working tree.
 
2563
 
 
2564
        move uses the second mode if 'after == False' and the source is
 
2565
        versioned but no longer in the working tree, and the target is not
 
2566
        versioned but present in the working tree.
 
2567
 
 
2568
        move uses the first mode if 'after == False' and the source is
 
2569
        versioned and present in the working tree, and the target is not
 
2570
        versioned and not present in the working tree.
 
2571
 
 
2572
        Everything else results in an error.
 
2573
 
 
2574
        This returns a list of (from_path, to_path) pairs for each
 
2575
        entry that is moved.
 
2576
        """
 
2577
        rename_entries = []
 
2578
        rename_tuples = []
 
2579
 
 
2580
        # check for deprecated use of signature
 
2581
        if to_dir is None:
 
2582
            raise TypeError('You must supply a target directory')
 
2583
        # check destination directory
 
2584
        if isinstance(from_paths, basestring):
 
2585
            raise ValueError()
 
2586
        inv = self.inventory
 
2587
        to_abs = self.abspath(to_dir)
 
2588
        if not isdir(to_abs):
 
2589
            raise errors.BzrMoveFailedError('',to_dir,
 
2590
                errors.NotADirectory(to_abs))
 
2591
        if not self.has_filename(to_dir):
 
2592
            raise errors.BzrMoveFailedError('',to_dir,
 
2593
                errors.NotInWorkingDirectory(to_dir))
 
2594
        to_dir_id = inv.path2id(to_dir)
 
2595
        if to_dir_id is None:
 
2596
            raise errors.BzrMoveFailedError('',to_dir,
 
2597
                errors.NotVersionedError(path=to_dir))
 
2598
 
 
2599
        to_dir_ie = inv[to_dir_id]
 
2600
        if to_dir_ie.kind != 'directory':
 
2601
            raise errors.BzrMoveFailedError('',to_dir,
 
2602
                errors.NotADirectory(to_abs))
 
2603
 
 
2604
        # create rename entries and tuples
 
2605
        for from_rel in from_paths:
 
2606
            from_tail = splitpath(from_rel)[-1]
 
2607
            from_id = inv.path2id(from_rel)
 
2608
            if from_id is None:
 
2609
                raise errors.BzrMoveFailedError(from_rel,to_dir,
 
2610
                    errors.NotVersionedError(path=from_rel))
 
2611
 
 
2612
            from_entry = inv[from_id]
 
2613
            from_parent_id = from_entry.parent_id
 
2614
            to_rel = pathjoin(to_dir, from_tail)
 
2615
            rename_entry = InventoryWorkingTree._RenameEntry(
 
2616
                from_rel=from_rel,
 
2617
                from_id=from_id,
 
2618
                from_tail=from_tail,
 
2619
                from_parent_id=from_parent_id,
 
2620
                to_rel=to_rel, to_tail=from_tail,
 
2621
                to_parent_id=to_dir_id)
 
2622
            rename_entries.append(rename_entry)
 
2623
            rename_tuples.append((from_rel, to_rel))
 
2624
 
 
2625
        # determine which move mode to use. checks also for movability
 
2626
        rename_entries = self._determine_mv_mode(rename_entries, after)
 
2627
 
 
2628
        original_modified = self._inventory_is_modified
 
2629
        try:
 
2630
            if len(from_paths):
 
2631
                self._inventory_is_modified = True
 
2632
            self._move(rename_entries)
 
2633
        except:
 
2634
            # restore the inventory on error
 
2635
            self._inventory_is_modified = original_modified
 
2636
            raise
 
2637
        self._write_inventory(inv)
 
2638
        return rename_tuples
 
2639
 
 
2640
    @needs_tree_write_lock
 
2641
    def rename_one(self, from_rel, to_rel, after=False):
 
2642
        """Rename one file.
 
2643
 
 
2644
        This can change the directory or the filename or both.
 
2645
 
 
2646
        rename_one has several 'modes' to work. First, it can rename a physical
 
2647
        file and change the file_id. That is the normal mode. Second, it can
 
2648
        only change the file_id without touching any physical file.
 
2649
 
 
2650
        rename_one uses the second mode if 'after == True' and 'to_rel' is not
 
2651
        versioned but present in the working tree.
 
2652
 
 
2653
        rename_one uses the second mode if 'after == False' and 'from_rel' is
 
2654
        versioned but no longer in the working tree, and 'to_rel' is not
 
2655
        versioned but present in the working tree.
 
2656
 
 
2657
        rename_one uses the first mode if 'after == False' and 'from_rel' is
 
2658
        versioned and present in the working tree, and 'to_rel' is not
 
2659
        versioned and not present in the working tree.
 
2660
 
 
2661
        Everything else results in an error.
 
2662
        """
 
2663
        inv = self.inventory
 
2664
        rename_entries = []
 
2665
 
 
2666
        # create rename entries and tuples
 
2667
        from_tail = splitpath(from_rel)[-1]
 
2668
        from_id = inv.path2id(from_rel)
 
2669
        if from_id is None:
 
2670
            # if file is missing in the inventory maybe it's in the basis_tree
 
2671
            basis_tree = self.branch.basis_tree()
 
2672
            from_id = basis_tree.path2id(from_rel)
 
2673
            if from_id is None:
 
2674
                raise errors.BzrRenameFailedError(from_rel,to_rel,
 
2675
                    errors.NotVersionedError(path=from_rel))
 
2676
            # put entry back in the inventory so we can rename it
 
2677
            from_entry = basis_tree.inventory[from_id].copy()
 
2678
            inv.add(from_entry)
 
2679
        else:
 
2680
            from_entry = inv[from_id]
 
2681
        from_parent_id = from_entry.parent_id
 
2682
        to_dir, to_tail = os.path.split(to_rel)
 
2683
        to_dir_id = inv.path2id(to_dir)
 
2684
        rename_entry = InventoryWorkingTree._RenameEntry(from_rel=from_rel,
 
2685
                                     from_id=from_id,
 
2686
                                     from_tail=from_tail,
 
2687
                                     from_parent_id=from_parent_id,
 
2688
                                     to_rel=to_rel, to_tail=to_tail,
 
2689
                                     to_parent_id=to_dir_id)
 
2690
        rename_entries.append(rename_entry)
 
2691
 
 
2692
        # determine which move mode to use. checks also for movability
 
2693
        rename_entries = self._determine_mv_mode(rename_entries, after)
 
2694
 
 
2695
        # check if the target changed directory and if the target directory is
 
2696
        # versioned
 
2697
        if to_dir_id is None:
 
2698
            raise errors.BzrMoveFailedError(from_rel,to_rel,
 
2699
                errors.NotVersionedError(path=to_dir))
 
2700
 
 
2701
        # all checks done. now we can continue with our actual work
 
2702
        mutter('rename_one:\n'
 
2703
               '  from_id   {%s}\n'
 
2704
               '  from_rel: %r\n'
 
2705
               '  to_rel:   %r\n'
 
2706
               '  to_dir    %r\n'
 
2707
               '  to_dir_id {%s}\n',
 
2708
               from_id, from_rel, to_rel, to_dir, to_dir_id)
 
2709
 
 
2710
        self._move(rename_entries)
 
2711
        self._write_inventory(inv)
 
2712
 
 
2713
    class _RenameEntry(object):
 
2714
        def __init__(self, from_rel, from_id, from_tail, from_parent_id,
 
2715
                     to_rel, to_tail, to_parent_id, only_change_inv=False):
 
2716
            self.from_rel = from_rel
 
2717
            self.from_id = from_id
 
2718
            self.from_tail = from_tail
 
2719
            self.from_parent_id = from_parent_id
 
2720
            self.to_rel = to_rel
 
2721
            self.to_tail = to_tail
 
2722
            self.to_parent_id = to_parent_id
 
2723
            self.only_change_inv = only_change_inv
 
2724
 
 
2725
    def _determine_mv_mode(self, rename_entries, after=False):
 
2726
        """Determines for each from-to pair if both inventory and working tree
 
2727
        or only the inventory has to be changed.
 
2728
 
 
2729
        Also does basic plausability tests.
 
2730
        """
 
2731
        inv = self.inventory
 
2732
 
 
2733
        for rename_entry in rename_entries:
 
2734
            # store to local variables for easier reference
 
2735
            from_rel = rename_entry.from_rel
 
2736
            from_id = rename_entry.from_id
 
2737
            to_rel = rename_entry.to_rel
 
2738
            to_id = inv.path2id(to_rel)
 
2739
            only_change_inv = False
 
2740
 
 
2741
            # check the inventory for source and destination
 
2742
            if from_id is None:
 
2743
                raise errors.BzrMoveFailedError(from_rel,to_rel,
 
2744
                    errors.NotVersionedError(path=from_rel))
 
2745
            if to_id is not None:
 
2746
                raise errors.BzrMoveFailedError(from_rel,to_rel,
 
2747
                    errors.AlreadyVersionedError(path=to_rel))
 
2748
 
 
2749
            # try to determine the mode for rename (only change inv or change
 
2750
            # inv and file system)
 
2751
            if after:
 
2752
                if not self.has_filename(to_rel):
 
2753
                    raise errors.BzrMoveFailedError(from_id,to_rel,
 
2754
                        errors.NoSuchFile(path=to_rel,
 
2755
                        extra="New file has not been created yet"))
 
2756
                only_change_inv = True
 
2757
            elif not self.has_filename(from_rel) and self.has_filename(to_rel):
 
2758
                only_change_inv = True
 
2759
            elif self.has_filename(from_rel) and not self.has_filename(to_rel):
 
2760
                only_change_inv = False
 
2761
            elif (not self.case_sensitive
 
2762
                  and from_rel.lower() == to_rel.lower()
 
2763
                  and self.has_filename(from_rel)):
 
2764
                only_change_inv = False
 
2765
            else:
 
2766
                # something is wrong, so lets determine what exactly
 
2767
                if not self.has_filename(from_rel) and \
 
2768
                   not self.has_filename(to_rel):
 
2769
                    raise errors.BzrRenameFailedError(from_rel,to_rel,
 
2770
                        errors.PathsDoNotExist(paths=(str(from_rel),
 
2771
                        str(to_rel))))
 
2772
                else:
 
2773
                    raise errors.RenameFailedFilesExist(from_rel, to_rel)
 
2774
            rename_entry.only_change_inv = only_change_inv
 
2775
        return rename_entries
 
2776
 
 
2777
    def _move(self, rename_entries):
 
2778
        """Moves a list of files.
 
2779
 
 
2780
        Depending on the value of the flag 'only_change_inv', the
 
2781
        file will be moved on the file system or not.
 
2782
        """
 
2783
        inv = self.inventory
 
2784
        moved = []
 
2785
 
 
2786
        for entry in rename_entries:
 
2787
            try:
 
2788
                self._move_entry(entry)
 
2789
            except:
 
2790
                self._rollback_move(moved)
 
2791
                raise
 
2792
            moved.append(entry)
 
2793
 
 
2794
    def _rollback_move(self, moved):
 
2795
        """Try to rollback a previous move in case of an filesystem error."""
 
2796
        inv = self.inventory
 
2797
        for entry in moved:
 
2798
            try:
 
2799
                self._move_entry(WorkingTree._RenameEntry(
 
2800
                    entry.to_rel, entry.from_id,
 
2801
                    entry.to_tail, entry.to_parent_id, entry.from_rel,
 
2802
                    entry.from_tail, entry.from_parent_id,
 
2803
                    entry.only_change_inv))
 
2804
            except errors.BzrMoveFailedError, e:
 
2805
                raise errors.BzrMoveFailedError( '', '', "Rollback failed."
 
2806
                        " The working tree is in an inconsistent state."
 
2807
                        " Please consider doing a 'bzr revert'."
 
2808
                        " Error message is: %s" % e)
 
2809
 
 
2810
    def _move_entry(self, entry):
 
2811
        inv = self.inventory
 
2812
        from_rel_abs = self.abspath(entry.from_rel)
 
2813
        to_rel_abs = self.abspath(entry.to_rel)
 
2814
        if from_rel_abs == to_rel_abs:
 
2815
            raise errors.BzrMoveFailedError(entry.from_rel, entry.to_rel,
 
2816
                "Source and target are identical.")
 
2817
 
 
2818
        if not entry.only_change_inv:
 
2819
            try:
 
2820
                osutils.rename(from_rel_abs, to_rel_abs)
 
2821
            except OSError, e:
 
2822
                raise errors.BzrMoveFailedError(entry.from_rel,
 
2823
                    entry.to_rel, e[1])
 
2824
        inv.rename(entry.from_id, entry.to_parent_id, entry.to_tail)
 
2825
 
 
2826
    @needs_tree_write_lock
 
2827
    def unversion(self, file_ids):
 
2828
        """Remove the file ids in file_ids from the current versioned set.
 
2829
 
 
2830
        When a file_id is unversioned, all of its children are automatically
 
2831
        unversioned.
 
2832
 
 
2833
        :param file_ids: The file ids to stop versioning.
 
2834
        :raises: NoSuchId if any fileid is not currently versioned.
 
2835
        """
 
2836
        for file_id in file_ids:
 
2837
            if file_id not in self._inventory:
 
2838
                raise errors.NoSuchId(self, file_id)
 
2839
        for file_id in file_ids:
 
2840
            if self._inventory.has_id(file_id):
 
2841
                self._inventory.remove_recursive_id(file_id)
 
2842
        if len(file_ids):
 
2843
            # in the future this should just set a dirty bit to wait for the
 
2844
            # final unlock. However, until all methods of workingtree start
 
2845
            # with the current in -memory inventory rather than triggering
 
2846
            # a read, it is more complex - we need to teach read_inventory
 
2847
            # to know when to read, and when to not read first... and possibly
 
2848
            # to save first when the in memory one may be corrupted.
 
2849
            # so for now, we just only write it if it is indeed dirty.
 
2850
            # - RBC 20060907
 
2851
            self._write_inventory(self._inventory)
 
2852
 
 
2853
    def stored_kind(self, file_id):
 
2854
        """See Tree.stored_kind"""
 
2855
        return self.inventory[file_id].kind
 
2856
 
 
2857
    def extras(self):
 
2858
        """Yield all unversioned files in this WorkingTree.
 
2859
 
 
2860
        If there are any unversioned directories then only the directory is
 
2861
        returned, not all its children.  But if there are unversioned files
 
2862
        under a versioned subdirectory, they are returned.
 
2863
 
 
2864
        Currently returned depth-first, sorted by name within directories.
 
2865
        This is the same order used by 'osutils.walkdirs'.
 
2866
        """
 
2867
        ## TODO: Work from given directory downwards
 
2868
        for path, dir_entry in self.inventory.directories():
 
2869
            # mutter("search for unknowns in %r", path)
 
2870
            dirabs = self.abspath(path)
 
2871
            if not isdir(dirabs):
 
2872
                # e.g. directory deleted
 
2873
                continue
 
2874
 
 
2875
            fl = []
 
2876
            for subf in os.listdir(dirabs):
 
2877
                if self.bzrdir.is_control_filename(subf):
 
2878
                    continue
 
2879
                if subf not in dir_entry.children:
 
2880
                    try:
 
2881
                        (subf_norm,
 
2882
                         can_access) = osutils.normalized_filename(subf)
 
2883
                    except UnicodeDecodeError:
 
2884
                        path_os_enc = path.encode(osutils._fs_enc)
 
2885
                        relpath = path_os_enc + '/' + subf
 
2886
                        raise errors.BadFilenameEncoding(relpath,
 
2887
                                                         osutils._fs_enc)
 
2888
                    if subf_norm != subf and can_access:
 
2889
                        if subf_norm not in dir_entry.children:
 
2890
                            fl.append(subf_norm)
 
2891
                    else:
 
2892
                        fl.append(subf)
 
2893
 
 
2894
            fl.sort()
 
2895
            for subf in fl:
 
2896
                subp = pathjoin(path, subf)
 
2897
                yield subp
 
2898
 
 
2899
    def _walkdirs(self, prefix=""):
 
2900
        """Walk the directories of this tree.
 
2901
 
 
2902
           :prefix: is used as the directrory to start with.
 
2903
           returns a generator which yields items in the form:
 
2904
                ((curren_directory_path, fileid),
 
2905
                 [(file1_path, file1_name, file1_kind, None, file1_id,
 
2906
                   file1_kind), ... ])
 
2907
        """
 
2908
        _directory = 'directory'
 
2909
        # get the root in the inventory
 
2910
        inv = self.inventory
 
2911
        top_id = inv.path2id(prefix)
 
2912
        if top_id is None:
 
2913
            pending = []
 
2914
        else:
 
2915
            pending = [(prefix, '', _directory, None, top_id, None)]
 
2916
        while pending:
 
2917
            dirblock = []
 
2918
            currentdir = pending.pop()
 
2919
            # 0 - relpath, 1- basename, 2- kind, 3- stat, 4-id, 5-kind
 
2920
            top_id = currentdir[4]
 
2921
            if currentdir[0]:
 
2922
                relroot = currentdir[0] + '/'
 
2923
            else:
 
2924
                relroot = ""
 
2925
            # FIXME: stash the node in pending
 
2926
            entry = inv[top_id]
 
2927
            if entry.kind == 'directory':
 
2928
                for name, child in entry.sorted_children():
 
2929
                    dirblock.append((relroot + name, name, child.kind, None,
 
2930
                        child.file_id, child.kind
 
2931
                        ))
 
2932
            yield (currentdir[0], entry.file_id), dirblock
 
2933
            # push the user specified dirs from dirblock
 
2934
            for dir in reversed(dirblock):
 
2935
                if dir[2] == _directory:
 
2936
                    pending.append(dir)
 
2937
 
 
2938
 
 
2939
class WorkingTreeFormatRegistry(controldir.ControlComponentFormatRegistry):
 
2940
    """Registry for working tree formats."""
 
2941
 
 
2942
    def __init__(self, other_registry=None):
 
2943
        super(WorkingTreeFormatRegistry, self).__init__(other_registry)
 
2944
        self._default_format = None
 
2945
        self._default_format_key = None
 
2946
 
 
2947
    def get_default(self):
 
2948
        """Return the current default format."""
 
2949
        if (self._default_format_key is not None and
 
2950
            self._default_format is None):
 
2951
            self._default_format = self.get(self._default_format_key)
 
2952
        return self._default_format
 
2953
 
 
2954
    def set_default(self, format):
 
2955
        """Set the default format."""
 
2956
        self._default_format = format
 
2957
        self._default_format_key = None
 
2958
 
 
2959
    def set_default_key(self, format_string):
 
2960
        """Set the default format by its format string."""
 
2961
        self._default_format_key = format_string
 
2962
        self._default_format = None
 
2963
 
 
2964
 
 
2965
format_registry = WorkingTreeFormatRegistry()
 
2966
 
 
2967
 
 
2968
class WorkingTreeFormat(controldir.ControlComponentFormat):
2826
2969
    """An encapsulation of the initialization and open routines for a format.
2827
2970
 
2828
2971
    Formats provide three things:
2840
2983
    object will be created every time regardless.
2841
2984
    """
2842
2985
 
2843
 
    _default_format = None
2844
 
    """The default format used for new trees."""
2845
 
 
2846
 
    _formats = {}
2847
 
    """The known formats."""
2848
 
 
2849
2986
    requires_rich_root = False
2850
2987
 
2851
2988
    upgrade_recommended = False
2852
2989
 
 
2990
    requires_normalized_unicode_filenames = False
 
2991
 
 
2992
    case_sensitive_filename = "FoRMaT"
 
2993
 
 
2994
    missing_parent_conflicts = False
 
2995
    """If this format supports missing parent conflicts."""
 
2996
 
 
2997
    @classmethod
 
2998
    def find_format_string(klass, a_bzrdir):
 
2999
        """Return format name for the working tree object in a_bzrdir."""
 
3000
        try:
 
3001
            transport = a_bzrdir.get_workingtree_transport(None)
 
3002
            return transport.get_bytes("format")
 
3003
        except errors.NoSuchFile:
 
3004
            raise errors.NoWorkingTree(base=transport.base)
 
3005
 
2853
3006
    @classmethod
2854
3007
    def find_format(klass, a_bzrdir):
2855
3008
        """Return the format for the working tree object in a_bzrdir."""
2856
3009
        try:
2857
 
            transport = a_bzrdir.get_workingtree_transport(None)
2858
 
            format_string = transport.get_bytes("format")
2859
 
            return klass._formats[format_string]
2860
 
        except errors.NoSuchFile:
2861
 
            raise errors.NoWorkingTree(base=transport.base)
 
3010
            format_string = klass.find_format_string(a_bzrdir)
 
3011
            return format_registry.get(format_string)
2862
3012
        except KeyError:
2863
3013
            raise errors.UnknownFormatError(format=format_string,
2864
3014
                                            kind="working tree")
2865
3015
 
 
3016
    def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
 
3017
                   accelerator_tree=None, hardlink=False):
 
3018
        """Initialize a new working tree in a_bzrdir.
 
3019
 
 
3020
        :param a_bzrdir: BzrDir to initialize the working tree in.
 
3021
        :param revision_id: allows creating a working tree at a different
 
3022
            revision than the branch is at.
 
3023
        :param from_branch: Branch to checkout
 
3024
        :param accelerator_tree: A tree which can be used for retrieving file
 
3025
            contents more quickly than the revision tree, i.e. a workingtree.
 
3026
            The revision tree will be used for cases where accelerator_tree's
 
3027
            content is different.
 
3028
        :param hardlink: If true, hard-link files from accelerator_tree,
 
3029
            where possible.
 
3030
        """
 
3031
        raise NotImplementedError(self.initialize)
 
3032
 
2866
3033
    def __eq__(self, other):
2867
3034
        return self.__class__ is other.__class__
2868
3035
 
2870
3037
        return not (self == other)
2871
3038
 
2872
3039
    @classmethod
 
3040
    @symbol_versioning.deprecated_method(
 
3041
        symbol_versioning.deprecated_in((2, 4, 0)))
2873
3042
    def get_default_format(klass):
2874
3043
        """Return the current default format."""
2875
 
        return klass._default_format
 
3044
        return format_registry.get_default()
2876
3045
 
2877
3046
    def get_format_string(self):
2878
3047
        """Return the ASCII format string that identifies this format."""
2900
3069
        return False
2901
3070
 
2902
3071
    @classmethod
 
3072
    @symbol_versioning.deprecated_method(
 
3073
        symbol_versioning.deprecated_in((2, 4, 0)))
2903
3074
    def register_format(klass, format):
2904
 
        klass._formats[format.get_format_string()] = format
2905
 
 
2906
 
    @classmethod
 
3075
        format_registry.register(format)
 
3076
 
 
3077
    @classmethod
 
3078
    @symbol_versioning.deprecated_method(
 
3079
        symbol_versioning.deprecated_in((2, 4, 0)))
 
3080
    def register_extra_format(klass, format):
 
3081
        format_registry.register_extra(format)
 
3082
 
 
3083
    @classmethod
 
3084
    @symbol_versioning.deprecated_method(
 
3085
        symbol_versioning.deprecated_in((2, 4, 0)))
 
3086
    def unregister_extra_format(klass, format):
 
3087
        format_registry.unregister_extra(format)
 
3088
 
 
3089
    @classmethod
 
3090
    @symbol_versioning.deprecated_method(
 
3091
        symbol_versioning.deprecated_in((2, 4, 0)))
 
3092
    def get_formats(klass):
 
3093
        return format_registry._get_all()
 
3094
 
 
3095
    @classmethod
 
3096
    @symbol_versioning.deprecated_method(
 
3097
        symbol_versioning.deprecated_in((2, 4, 0)))
2907
3098
    def set_default_format(klass, format):
2908
 
        klass._default_format = format
 
3099
        format_registry.set_default(format)
2909
3100
 
2910
3101
    @classmethod
 
3102
    @symbol_versioning.deprecated_method(
 
3103
        symbol_versioning.deprecated_in((2, 4, 0)))
2911
3104
    def unregister_format(klass, format):
2912
 
        del klass._formats[format.get_format_string()]
2913
 
 
2914
 
 
2915
 
class WorkingTreeFormat2(WorkingTreeFormat):
2916
 
    """The second working tree format.
2917
 
 
2918
 
    This format modified the hash cache from the format 1 hash cache.
2919
 
    """
2920
 
 
2921
 
    upgrade_recommended = True
2922
 
 
2923
 
    def get_format_description(self):
2924
 
        """See WorkingTreeFormat.get_format_description()."""
2925
 
        return "Working tree format 2"
2926
 
 
2927
 
    def _stub_initialize_on_transport(self, transport, file_mode):
2928
 
        """Workaround: create control files for a remote working tree.
2929
 
 
2930
 
        This ensures that it can later be updated and dealt with locally,
2931
 
        since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
2932
 
        no working tree.  (See bug #43064).
2933
 
        """
2934
 
        sio = StringIO()
2935
 
        inv = inventory.Inventory()
2936
 
        xml5.serializer_v5.write_inventory(inv, sio, working=True)
2937
 
        sio.seek(0)
2938
 
        transport.put_file('inventory', sio, file_mode)
2939
 
        transport.put_bytes('pending-merges', '', file_mode)
2940
 
 
2941
 
    def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
2942
 
                   accelerator_tree=None, hardlink=False):
2943
 
        """See WorkingTreeFormat.initialize()."""
2944
 
        if not isinstance(a_bzrdir.transport, LocalTransport):
2945
 
            raise errors.NotLocalUrl(a_bzrdir.transport.base)
2946
 
        if from_branch is not None:
2947
 
            branch = from_branch
2948
 
        else:
2949
 
            branch = a_bzrdir.open_branch()
2950
 
        if revision_id is None:
2951
 
            revision_id = _mod_revision.ensure_null(branch.last_revision())
2952
 
        branch.lock_write()
2953
 
        try:
2954
 
            branch.generate_revision_history(revision_id)
2955
 
        finally:
2956
 
            branch.unlock()
2957
 
        inv = inventory.Inventory()
2958
 
        wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2959
 
                         branch,
2960
 
                         inv,
2961
 
                         _internal=True,
2962
 
                         _format=self,
2963
 
                         _bzrdir=a_bzrdir)
2964
 
        basis_tree = branch.repository.revision_tree(revision_id)
2965
 
        if basis_tree.inventory.root is not None:
2966
 
            wt.set_root_id(basis_tree.get_root_id())
2967
 
        # set the parent list and cache the basis tree.
2968
 
        if _mod_revision.is_null(revision_id):
2969
 
            parent_trees = []
2970
 
        else:
2971
 
            parent_trees = [(revision_id, basis_tree)]
2972
 
        wt.set_parent_trees(parent_trees)
2973
 
        transform.build_tree(basis_tree, wt)
2974
 
        return wt
2975
 
 
2976
 
    def __init__(self):
2977
 
        super(WorkingTreeFormat2, self).__init__()
2978
 
        self._matchingbzrdir = bzrdir.BzrDirFormat6()
2979
 
 
2980
 
    def open(self, a_bzrdir, _found=False):
2981
 
        """Return the WorkingTree object for a_bzrdir
2982
 
 
2983
 
        _found is a private parameter, do not use it. It is used to indicate
2984
 
               if format probing has already been done.
2985
 
        """
2986
 
        if not _found:
2987
 
            # we are being called directly and must probe.
2988
 
            raise NotImplementedError
2989
 
        if not isinstance(a_bzrdir.transport, LocalTransport):
2990
 
            raise errors.NotLocalUrl(a_bzrdir.transport.base)
2991
 
        wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2992
 
                           _internal=True,
2993
 
                           _format=self,
2994
 
                           _bzrdir=a_bzrdir)
2995
 
        return wt
2996
 
 
2997
 
class WorkingTreeFormat3(WorkingTreeFormat):
2998
 
    """The second working tree format updated to record a format marker.
2999
 
 
3000
 
    This format:
3001
 
        - exists within a metadir controlling .bzr
3002
 
        - includes an explicit version marker for the workingtree control
3003
 
          files, separate from the BzrDir format
3004
 
        - modifies the hash cache format
3005
 
        - is new in bzr 0.8
3006
 
        - uses a LockDir to guard access for writes.
3007
 
    """
3008
 
 
3009
 
    upgrade_recommended = True
3010
 
 
3011
 
    def get_format_string(self):
3012
 
        """See WorkingTreeFormat.get_format_string()."""
3013
 
        return "Bazaar-NG Working Tree format 3"
3014
 
 
3015
 
    def get_format_description(self):
3016
 
        """See WorkingTreeFormat.get_format_description()."""
3017
 
        return "Working tree format 3"
3018
 
 
3019
 
    _lock_file_name = 'lock'
3020
 
    _lock_class = LockDir
3021
 
 
3022
 
    _tree_class = WorkingTree3
3023
 
 
3024
 
    def __get_matchingbzrdir(self):
3025
 
        return bzrdir.BzrDirMetaFormat1()
3026
 
 
3027
 
    _matchingbzrdir = property(__get_matchingbzrdir)
3028
 
 
3029
 
    def _open_control_files(self, a_bzrdir):
3030
 
        transport = a_bzrdir.get_workingtree_transport(None)
3031
 
        return LockableFiles(transport, self._lock_file_name,
3032
 
                             self._lock_class)
3033
 
 
3034
 
    def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
3035
 
                   accelerator_tree=None, hardlink=False):
3036
 
        """See WorkingTreeFormat.initialize().
3037
 
 
3038
 
        :param revision_id: if supplied, create a working tree at a different
3039
 
            revision than the branch is at.
3040
 
        :param accelerator_tree: A tree which can be used for retrieving file
3041
 
            contents more quickly than the revision tree, i.e. a workingtree.
3042
 
            The revision tree will be used for cases where accelerator_tree's
3043
 
            content is different.
3044
 
        :param hardlink: If true, hard-link files from accelerator_tree,
3045
 
            where possible.
3046
 
        """
3047
 
        if not isinstance(a_bzrdir.transport, LocalTransport):
3048
 
            raise errors.NotLocalUrl(a_bzrdir.transport.base)
3049
 
        transport = a_bzrdir.get_workingtree_transport(self)
3050
 
        control_files = self._open_control_files(a_bzrdir)
3051
 
        control_files.create_lock()
3052
 
        control_files.lock_write()
3053
 
        transport.put_bytes('format', self.get_format_string(),
3054
 
            mode=a_bzrdir._get_file_mode())
3055
 
        if from_branch is not None:
3056
 
            branch = from_branch
3057
 
        else:
3058
 
            branch = a_bzrdir.open_branch()
3059
 
        if revision_id is None:
3060
 
            revision_id = _mod_revision.ensure_null(branch.last_revision())
3061
 
        # WorkingTree3 can handle an inventory which has a unique root id.
3062
 
        # as of bzr 0.12. However, bzr 0.11 and earlier fail to handle
3063
 
        # those trees. And because there isn't a format bump inbetween, we
3064
 
        # are maintaining compatibility with older clients.
3065
 
        # inv = Inventory(root_id=gen_root_id())
3066
 
        inv = self._initial_inventory()
3067
 
        wt = self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
3068
 
                         branch,
3069
 
                         inv,
3070
 
                         _internal=True,
3071
 
                         _format=self,
3072
 
                         _bzrdir=a_bzrdir,
3073
 
                         _control_files=control_files)
3074
 
        wt.lock_tree_write()
3075
 
        try:
3076
 
            basis_tree = branch.repository.revision_tree(revision_id)
3077
 
            # only set an explicit root id if there is one to set.
3078
 
            if basis_tree.inventory.root is not None:
3079
 
                wt.set_root_id(basis_tree.get_root_id())
3080
 
            if revision_id == _mod_revision.NULL_REVISION:
3081
 
                wt.set_parent_trees([])
3082
 
            else:
3083
 
                wt.set_parent_trees([(revision_id, basis_tree)])
3084
 
            transform.build_tree(basis_tree, wt)
3085
 
        finally:
3086
 
            # Unlock in this order so that the unlock-triggers-flush in
3087
 
            # WorkingTree is given a chance to fire.
3088
 
            control_files.unlock()
3089
 
            wt.unlock()
3090
 
        return wt
3091
 
 
3092
 
    def _initial_inventory(self):
3093
 
        return inventory.Inventory()
3094
 
 
3095
 
    def __init__(self):
3096
 
        super(WorkingTreeFormat3, self).__init__()
3097
 
 
3098
 
    def open(self, a_bzrdir, _found=False):
3099
 
        """Return the WorkingTree object for a_bzrdir
3100
 
 
3101
 
        _found is a private parameter, do not use it. It is used to indicate
3102
 
               if format probing has already been done.
3103
 
        """
3104
 
        if not _found:
3105
 
            # we are being called directly and must probe.
3106
 
            raise NotImplementedError
3107
 
        if not isinstance(a_bzrdir.transport, LocalTransport):
3108
 
            raise errors.NotLocalUrl(a_bzrdir.transport.base)
3109
 
        wt = self._open(a_bzrdir, self._open_control_files(a_bzrdir))
3110
 
        return wt
3111
 
 
3112
 
    def _open(self, a_bzrdir, control_files):
3113
 
        """Open the tree itself.
3114
 
 
3115
 
        :param a_bzrdir: the dir for the tree.
3116
 
        :param control_files: the control files for the tree.
3117
 
        """
3118
 
        return self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
3119
 
                                _internal=True,
3120
 
                                _format=self,
3121
 
                                _bzrdir=a_bzrdir,
3122
 
                                _control_files=control_files)
3123
 
 
3124
 
    def __str__(self):
3125
 
        return self.get_format_string()
3126
 
 
3127
 
 
3128
 
__default_format = WorkingTreeFormat6()
3129
 
WorkingTreeFormat.register_format(__default_format)
3130
 
WorkingTreeFormat.register_format(WorkingTreeFormat5())
3131
 
WorkingTreeFormat.register_format(WorkingTreeFormat4())
3132
 
WorkingTreeFormat.register_format(WorkingTreeFormat3())
3133
 
WorkingTreeFormat.set_default_format(__default_format)
3134
 
# formats which have no format string are not discoverable
3135
 
# and not independently creatable, so are not registered.
3136
 
_legacy_formats = [WorkingTreeFormat2(),
3137
 
                   ]
 
3105
        format_registry.remove(format)
 
3106
 
 
3107
 
 
3108
format_registry.register_lazy("Bazaar Working Tree Format 4 (bzr 0.15)\n",
 
3109
    "bzrlib.workingtree_4", "WorkingTreeFormat4")
 
3110
format_registry.register_lazy("Bazaar Working Tree Format 5 (bzr 1.11)\n",
 
3111
    "bzrlib.workingtree_4", "WorkingTreeFormat5")
 
3112
format_registry.register_lazy("Bazaar Working Tree Format 6 (bzr 1.14)\n",
 
3113
    "bzrlib.workingtree_4", "WorkingTreeFormat6")
 
3114
format_registry.register_lazy("Bazaar-NG Working Tree format 3",
 
3115
    "bzrlib.workingtree_3", "WorkingTreeFormat3")
 
3116
format_registry.set_default_key("Bazaar Working Tree Format 6 (bzr 1.14)\n")