~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/workingtree.py

  • Committer: Vincent Ladeuil
  • Date: 2011-05-17 20:58:43 UTC
  • mfrom: (5609.39.5 2.3)
  • mto: This revision was merged to the branch mainline in revision 5885.
  • Revision ID: v.ladeuil+lp@free.fr-20110517205843-uo1tntrz6kqfn1hb
Merge 2.3 into trunk

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:
289
268
        self._control_files.break_lock()
290
269
        self.branch.break_lock()
291
270
 
292
 
    def _get_check_refs(self):
293
 
        """Return the references needed to perform a check of this tree.
294
 
        
295
 
        The default implementation returns no refs, and is only suitable for
296
 
        trees that have no local caching and can commit on ghosts at any time.
297
 
 
298
 
        :seealso: bzrlib.check for details about check_refs.
299
 
        """
300
 
        return []
301
 
 
302
271
    def requires_rich_root(self):
303
272
        return self._format.requires_rich_root
304
273
 
311
280
    def supports_views(self):
312
281
        return self.views.supports_views()
313
282
 
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
283
    @staticmethod
328
284
    def open(path=None, _unsupported=False):
329
285
        """Open an existing working tree at path.
353
309
        return control.open_workingtree(), relpath
354
310
 
355
311
    @staticmethod
356
 
    def open_containing_paths(file_list, default_directory='.',
357
 
        canonicalize=True, apply_view=True):
 
312
    def open_containing_paths(file_list, default_directory=None,
 
313
                              canonicalize=True, apply_view=True):
358
314
        """Open the WorkingTree that contains a set of paths.
359
315
 
360
316
        Fail if the paths given are not all in a single tree.
362
318
        This is used for the many command-line interfaces that take a list of
363
319
        any number of files and that require they all be in the same tree.
364
320
        """
 
321
        if default_directory is None:
 
322
            default_directory = u'.'
365
323
        # recommended replacement for builtins.internal_tree_files
366
324
        if file_list is None or len(file_list) == 0:
367
325
            tree = WorkingTree.open_containing(default_directory)[0]
375
333
                    view_str = views.view_display_str(view_files)
376
334
                    note("Ignoring files outside view. View is %s" % view_str)
377
335
            return tree, file_list
378
 
        tree = WorkingTree.open_containing(file_list[0])[0]
 
336
        if default_directory == u'.':
 
337
            seed = file_list[0]
 
338
        else:
 
339
            seed = default_directory
 
340
            file_list = [osutils.pathjoin(default_directory, f)
 
341
                         for f in file_list]
 
342
        tree = WorkingTree.open_containing(seed)[0]
379
343
        return tree, tree.safe_relpath_files(file_list, canonicalize,
380
 
            apply_view=apply_view)
 
344
                                             apply_view=apply_view)
381
345
 
382
346
    def safe_relpath_files(self, file_list, canonicalize=True, apply_view=True):
383
347
        """Convert file_list into a list of relpaths in tree.
434
398
                                              list_current=list_current)
435
399
        return [tr for tr in iterator if tr is not None]
436
400
 
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
401
    def all_file_ids(self):
452
402
        """See Tree.iter_all_file_ids"""
453
 
        return set(self.inventory)
 
403
        raise NotImplementedError(self.all_file_ids)
454
404
 
455
405
    def __repr__(self):
456
406
        return "<%s of %s>" % (self.__class__.__name__,
511
461
        return self.get_file_with_stat(file_id, path, filtered=filtered)[0]
512
462
 
513
463
    def get_file_with_stat(self, file_id, path=None, filtered=True,
514
 
        _fstat=os.fstat):
 
464
                           _fstat=osutils.fstat):
515
465
        """See Tree.get_file_with_stat."""
516
466
        if path is None:
517
467
            path = self.id2path(file_id)
519
469
        stat_value = _fstat(file_obj.fileno())
520
470
        if filtered and self.supports_content_filtering():
521
471
            filters = self._content_filter_stack(path)
522
 
            file_obj = filtered_input_file(file_obj, filters)
 
472
            file_obj = _mod_filters.filtered_input_file(file_obj, filters)
523
473
        return (file_obj, stat_value)
524
474
 
525
475
    def get_file_text(self, file_id, path=None, filtered=True):
534
484
        f = file(path, 'rb')
535
485
        if filtered and self.supports_content_filtering():
536
486
            filters = self._content_filter_stack(filename)
537
 
            return filtered_input_file(f, filters)
 
487
            return _mod_filters.filtered_input_file(f, filters)
538
488
        else:
539
489
            return f
540
490
 
546
496
        finally:
547
497
            file.close()
548
498
 
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
499
    def _get_ancestors(self, default_revision):
598
500
        ancestors = set([default_revision])
599
501
        for parent_id in self.get_parent_ids():
622
524
                parents.append(revision_id)
623
525
        return parents
624
526
 
625
 
    @needs_read_lock
626
527
    def get_root_id(self):
627
528
        """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))
 
529
        raise NotImplementedError(self.get_root_id)
633
530
 
634
531
    @needs_read_lock
635
532
    def clone(self, to_bzrdir, revision_id=None):
665
562
    def id2abspath(self, file_id):
666
563
        return self.abspath(self.id2path(file_id))
667
564
 
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
 
565
    def _check_for_tree_references(self, iterator):
 
566
        """See if directories have become tree-references."""
 
567
        blocked_parent_ids = set()
 
568
        for path, ie in iterator:
 
569
            if ie.parent_id in blocked_parent_ids:
 
570
                # This entry was pruned because one of its parents became a
 
571
                # TreeReference. If this is a directory, mark it as blocked.
 
572
                if ie.kind == 'directory':
 
573
                    blocked_parent_ids.add(ie.file_id)
 
574
                continue
 
575
            if ie.kind == 'directory' and self._directory_is_tree_reference(path):
 
576
                # This InventoryDirectory needs to be a TreeReference
 
577
                ie = inventory.TreeReference(ie.file_id, ie.name, ie.parent_id)
 
578
                blocked_parent_ids.add(ie.file_id)
 
579
            yield path, ie
 
580
 
 
581
    def iter_entries_by_dir(self, specific_file_ids=None, yield_parents=False):
 
582
        """See Tree.iter_entries_by_dir()"""
 
583
        # The only trick here is that if we supports_tree_reference then we
 
584
        # need to detect if a directory becomes a tree-reference.
 
585
        iterator = super(WorkingTree, self).iter_entries_by_dir(
 
586
                specific_file_ids=specific_file_ids,
 
587
                yield_parents=yield_parents)
 
588
        if not self.supports_tree_reference():
 
589
            return iterator
 
590
        else:
 
591
            return self._check_for_tree_references(iterator)
682
592
 
683
593
    def get_file_size(self, file_id):
684
594
        """See Tree.get_file_size"""
692
602
            else:
693
603
                return None
694
604
 
695
 
    @needs_read_lock
696
605
    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
 
606
        # FIXME: Shouldn't this be in Tree?
 
607
        raise NotImplementedError(self.get_file_sha1)
748
608
 
749
609
    @needs_tree_write_lock
750
610
    def _gather_kinds(self, files, kinds):
876
736
            if revision_id in heads and revision_id not in new_revision_ids:
877
737
                new_revision_ids.append(revision_id)
878
738
        if new_revision_ids != revision_ids:
879
 
            trace.mutter('requested to set revision_ids = %s,'
 
739
            mutter('requested to set revision_ids = %s,'
880
740
                         ' but filtered to %s', revision_ids, new_revision_ids)
881
741
        return new_revision_ids
882
742
 
908
768
        self._set_merges_from_parent_ids(revision_ids)
909
769
 
910
770
    @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
771
    def set_pending_merges(self, rev_list):
942
772
        parents = self.get_parent_ids()
943
773
        leftmost = parents[:1]
948
778
    def set_merge_modified(self, modified_hashes):
949
779
        def iter_stanzas():
950
780
            for file_id, hash in modified_hashes.iteritems():
951
 
                yield Stanza(file_id=file_id.decode('utf8'), hash=hash)
 
781
                yield _mod_rio.Stanza(file_id=file_id.decode('utf8'),
 
782
                    hash=hash)
952
783
        self._put_rio('merge-hashes', iter_stanzas(), MERGE_MODIFIED_HEADER_1)
953
784
 
954
785
    def _sha_from_stat(self, path, stat_result):
963
794
 
964
795
    def _put_rio(self, filename, stanzas, header):
965
796
        self._must_be_locked()
966
 
        my_file = rio_file(stanzas, header)
 
797
        my_file = _mod_rio.rio_file(stanzas, header)
967
798
        self._transport.put_file(filename, my_file,
968
799
            mode=self.bzrdir._get_file_mode())
969
800
 
1011
842
        merger.set_pending()
1012
843
        return conflicts
1013
844
 
1014
 
    @needs_read_lock
1015
845
    def merge_modified(self):
1016
846
        """Return a dictionary of files modified by a merge.
1017
847
 
1022
852
        This returns a map of file_id->sha1, containing only files which are
1023
853
        still in the working inventory and have that text hash.
1024
854
        """
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()
 
855
        raise NotImplementedError(self.merge_modified)
1047
856
 
1048
857
    @needs_write_lock
1049
858
    def mkdir(self, path, file_id=None):
1054
863
        self.add(path, file_id, 'directory')
1055
864
        return file_id
1056
865
 
1057
 
    def get_symlink_target(self, file_id):
1058
 
        abspath = self.id2abspath(file_id)
 
866
    def get_symlink_target(self, file_id, path=None):
 
867
        if path is not None:
 
868
            abspath = self.abspath(path)
 
869
        else:
 
870
            abspath = self.id2abspath(file_id)
1059
871
        target = osutils.readlink(abspath)
1060
872
        return target
1061
873
 
1062
 
    @needs_write_lock
1063
874
    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()
 
875
        raise NotImplementedError(self.subsume)
1103
876
 
1104
877
    def _setup_directory_is_tree_reference(self):
1105
878
        if self._branch.repository._format.supports_tree_reference:
1127
900
        # checkout in a subdirectory.  This can be avoided by not adding
1128
901
        # it.  mbp 20070306
1129
902
 
1130
 
    @needs_tree_write_lock
1131
903
    def extract(self, file_id, format=None):
1132
904
        """Extract a subtree from this tree.
1133
905
 
1134
906
        A new branch will be created, relative to the path for this tree.
1135
907
        """
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)
 
908
        raise NotImplementedError(self.extract)
1186
909
 
1187
910
    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
 
911
        """Write the in memory meta data to disk."""
 
912
        raise NotImplementedError(self.flush)
1198
913
 
1199
914
    def _kind(self, relpath):
1200
915
        return osutils.file_kind(self.abspath(relpath))
1210
925
        :param from_dir: start from this directory or None for the root
1211
926
        :param recursive: whether to recurse into subdirectories or not
1212
927
        """
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
 
928
        raise NotImplementedError(self.list_files)
 
929
 
1330
930
    def move(self, from_paths, to_dir=None, after=False):
1331
931
        """Rename files.
1332
932
 
1333
 
        to_dir must exist in the inventory.
 
933
        to_dir must be known to the working tree.
1334
934
 
1335
935
        If to_dir exists and is a directory, the files are moved into
1336
936
        it, keeping their old names.
1342
942
        independently.
1343
943
 
1344
944
        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.
 
945
        working tree metadata. The second mode only updates the working tree
 
946
        metadata without touching the file on the filesystem.
1348
947
 
1349
948
        move uses the second mode if 'after == True' and the target is not
1350
949
        versioned but present in the working tree.
1362
961
        This returns a list of (from_path, to_path) pairs for each
1363
962
        entry that is moved.
1364
963
        """
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)
 
964
        raise NotImplementedError(self.move)
1527
965
 
1528
966
    @needs_tree_write_lock
1529
967
    def rename_one(self, from_rel, to_rel, after=False):
1533
971
 
1534
972
        rename_one has several 'modes' to work. First, it can rename a physical
1535
973
        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.
 
974
        only change the file_id without touching any physical file.
1538
975
 
1539
976
        rename_one uses the second mode if 'after == True' and 'to_rel' is not
1540
977
        versioned but present in the working tree.
1549
986
 
1550
987
        Everything else results in an error.
1551
988
        """
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
 
989
        raise NotImplementedError(self.rename_one)
1613
990
 
1614
991
    @needs_read_lock
1615
992
    def unknowns(self):
1623
1000
        return iter(
1624
1001
            [subp for subp in self.extras() if not self.is_ignored(subp)])
1625
1002
 
1626
 
    @needs_tree_write_lock
1627
1003
    def unversion(self, file_ids):
1628
1004
        """Remove the file ids in file_ids from the current versioned set.
1629
1005
 
1633
1009
        :param file_ids: The file ids to stop versioning.
1634
1010
        :raises: NoSuchId if any fileid is not currently versioned.
1635
1011
        """
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
 
1012
        raise NotImplementedError(self.unversion)
1663
1013
 
1664
1014
    @needs_write_lock
1665
1015
    def pull(self, source, overwrite=False, stop_revision=None,
1675
1025
            new_revision_info = self.branch.last_revision_info()
1676
1026
            if new_revision_info != old_revision_info:
1677
1027
                repository = self.branch.repository
 
1028
                if repository._format.fast_deltas:
 
1029
                    parent_ids = self.get_parent_ids()
 
1030
                    if parent_ids:
 
1031
                        basis_id = parent_ids[0]
 
1032
                        basis_tree = repository.revision_tree(basis_id)
1678
1033
                basis_tree.lock_read()
1679
1034
                try:
1680
1035
                    new_basis_tree = self.branch.basis_tree()
1730
1085
        Currently returned depth-first, sorted by name within directories.
1731
1086
        This is the same order used by 'osutils.walkdirs'.
1732
1087
        """
1733
 
        ## TODO: Work from given directory downwards
1734
 
        for path, dir_entry in self.inventory.directories():
1735
 
            # mutter("search for unknowns in %r", path)
1736
 
            dirabs = self.abspath(path)
1737
 
            if not isdir(dirabs):
1738
 
                # e.g. directory deleted
1739
 
                continue
1740
 
 
1741
 
            fl = []
1742
 
            for subf in os.listdir(dirabs):
1743
 
                if self.bzrdir.is_control_filename(subf):
1744
 
                    continue
1745
 
                if subf not in dir_entry.children:
1746
 
                    try:
1747
 
                        (subf_norm,
1748
 
                         can_access) = osutils.normalized_filename(subf)
1749
 
                    except UnicodeDecodeError:
1750
 
                        path_os_enc = path.encode(osutils._fs_enc)
1751
 
                        relpath = path_os_enc + '/' + subf
1752
 
                        raise errors.BadFilenameEncoding(relpath,
1753
 
                                                         osutils._fs_enc)
1754
 
                    if subf_norm != subf and can_access:
1755
 
                        if subf_norm not in dir_entry.children:
1756
 
                            fl.append(subf_norm)
1757
 
                    else:
1758
 
                        fl.append(subf)
1759
 
 
1760
 
            fl.sort()
1761
 
            for subf in fl:
1762
 
                subp = pathjoin(path, subf)
1763
 
                yield subp
 
1088
        raise NotImplementedError(self.extras)
1764
1089
 
1765
1090
    def ignored_files(self):
1766
1091
        """Yield list of PATH, IGNORE_PATTERN"""
1815
1140
 
1816
1141
    def stored_kind(self, file_id):
1817
1142
        """See Tree.stored_kind"""
1818
 
        return self.inventory[file_id].kind
 
1143
        raise NotImplementedError(self.stored_kind)
1819
1144
 
1820
1145
    def _comparison_data(self, entry, path):
1821
1146
        abspath = self.abspath(path)
1912
1237
    def get_physical_lock_status(self):
1913
1238
        return self._control_files.get_physical_lock_status()
1914
1239
 
1915
 
    def _basis_inventory_name(self):
1916
 
        return 'basis-inventory-cache'
1917
 
 
1918
1240
    def _reset_data(self):
1919
1241
        """Reset transient data that cannot be revalidated."""
1920
 
        self._inventory_is_modified = False
1921
 
        f = self._transport.get('inventory')
1922
 
        try:
1923
 
            result = self._deserialize(f)
1924
 
        finally:
1925
 
            f.close()
1926
 
        self._set_inventory(result, dirty=False)
 
1242
        raise NotImplementedError(self._reset_data)
1927
1243
 
1928
 
    @needs_tree_write_lock
1929
1244
    def set_last_revision(self, new_revision):
1930
1245
        """Change the last revision in the working tree."""
1931
 
        if self._change_last_revision(new_revision):
1932
 
            self._cache_basis_inventory(new_revision)
 
1246
        raise NotImplementedError(self.set_last_revision)
1933
1247
 
1934
1248
    def _change_last_revision(self, new_revision):
1935
1249
        """Template method part of set_last_revision to perform the change.
1938
1252
        when their last revision is set.
1939
1253
        """
1940
1254
        if _mod_revision.is_null(new_revision):
1941
 
            self.branch.set_revision_history([])
 
1255
            self.branch.set_last_revision_info(0, new_revision)
1942
1256
            return False
 
1257
        _mod_revision.check_not_reserved_id(new_revision)
1943
1258
        try:
1944
1259
            self.branch.generate_revision_history(new_revision)
1945
1260
        except errors.NoSuchRevision:
1946
1261
            # not present in the repo - dont try to set it deeper than the tip
1947
 
            self.branch.set_revision_history([new_revision])
 
1262
            self.branch._set_revision_history([new_revision])
1948
1263
        return True
1949
1264
 
1950
 
    def _write_basis_inventory(self, xml):
1951
 
        """Write the basis inventory XML to the basis-inventory file"""
1952
 
        path = self._basis_inventory_name()
1953
 
        sio = StringIO(xml)
1954
 
        self._transport.put_file(path, sio,
1955
 
            mode=self.bzrdir._get_file_mode())
1956
 
 
1957
 
    def _create_basis_xml_from_inventory(self, revision_id, inventory):
1958
 
        """Create the text that will be saved in basis-inventory"""
1959
 
        inventory.revision_id = revision_id
1960
 
        return xml7.serializer_v7.write_inventory_to_string(inventory)
1961
 
 
1962
 
    def _cache_basis_inventory(self, new_revision):
1963
 
        """Cache new_revision as the basis inventory."""
1964
 
        # TODO: this should allow the ready-to-use inventory to be passed in,
1965
 
        # as commit already has that ready-to-use [while the format is the
1966
 
        # same, that is].
1967
 
        try:
1968
 
            # this double handles the inventory - unpack and repack -
1969
 
            # but is easier to understand. We can/should put a conditional
1970
 
            # in here based on whether the inventory is in the latest format
1971
 
            # - perhaps we should repack all inventories on a repository
1972
 
            # upgrade ?
1973
 
            # the fast path is to copy the raw xml from the repository. If the
1974
 
            # xml contains 'revision_id="', then we assume the right
1975
 
            # revision_id is set. We must check for this full string, because a
1976
 
            # root node id can legitimately look like 'revision_id' but cannot
1977
 
            # contain a '"'.
1978
 
            xml = self.branch.repository._get_inventory_xml(new_revision)
1979
 
            firstline = xml.split('\n', 1)[0]
1980
 
            if (not 'revision_id="' in firstline or
1981
 
                'format="7"' not in firstline):
1982
 
                inv = self.branch.repository._serializer.read_inventory_from_string(
1983
 
                    xml, new_revision)
1984
 
                xml = self._create_basis_xml_from_inventory(new_revision, inv)
1985
 
            self._write_basis_inventory(xml)
1986
 
        except (errors.NoSuchRevision, errors.RevisionNotPresent):
1987
 
            pass
1988
 
 
1989
 
    def read_basis_inventory(self):
1990
 
        """Read the cached basis inventory."""
1991
 
        path = self._basis_inventory_name()
1992
 
        return self._transport.get_bytes(path)
1993
 
 
1994
 
    @needs_read_lock
1995
 
    def read_working_inventory(self):
1996
 
        """Read the working inventory.
1997
 
 
1998
 
        :raises errors.InventoryModified: read_working_inventory will fail
1999
 
            when the current in memory inventory has been modified.
2000
 
        """
2001
 
        # conceptually this should be an implementation detail of the tree.
2002
 
        # XXX: Deprecate this.
2003
 
        # ElementTree does its own conversion from UTF-8, so open in
2004
 
        # binary.
2005
 
        if self._inventory_is_modified:
2006
 
            raise errors.InventoryModified(self)
2007
 
        f = self._transport.get('inventory')
2008
 
        try:
2009
 
            result = self._deserialize(f)
2010
 
        finally:
2011
 
            f.close()
2012
 
        self._set_inventory(result, dirty=False)
2013
 
        return result
2014
 
 
2015
1265
    @needs_tree_write_lock
2016
1266
    def remove(self, files, verbose=False, to_file=None, keep_files=True,
2017
1267
        force=False):
2018
 
        """Remove nominated files from the working inventory.
 
1268
        """Remove nominated files from the working tree metadata.
2019
1269
 
2020
1270
        :files: File paths relative to the basedir.
2021
1271
        :keep_files: If true, the files will also be kept.
2080
1330
                    files_to_backup.append(path[1])
2081
1331
 
2082
1332
        def backup(file_to_backup):
2083
 
            backup_name = self.bzrdir.generate_backup_name(file_to_backup)
 
1333
            backup_name = self.bzrdir._available_backup_name(file_to_backup)
2084
1334
            osutils.rename(abs_path, self.abspath(backup_name))
2085
 
            return "removed %s (but kept a copy: %s)" % (file_to_backup, backup_name)
 
1335
            return "removed %s (but kept a copy: %s)" % (file_to_backup,
 
1336
                                                         backup_name)
2086
1337
 
2087
1338
        # Build inv_delta and delete files where applicable,
2088
 
        # do this before any modifications to inventory.
 
1339
        # do this before any modifications to meta data.
2089
1340
        for f in files:
2090
1341
            fid = self.path2id(f)
2091
1342
            message = None
2171
1422
        WorkingTree can supply revision_trees for the basis revision only
2172
1423
        because there is only one cached inventory in the bzr directory.
2173
1424
        """
2174
 
        if revision_id == self.last_revision():
2175
 
            try:
2176
 
                xml = self.read_basis_inventory()
2177
 
            except errors.NoSuchFile:
2178
 
                pass
2179
 
            else:
2180
 
                try:
2181
 
                    inv = xml7.serializer_v7.read_inventory_from_string(xml)
2182
 
                    # dont use the repository revision_tree api because we want
2183
 
                    # to supply the inventory.
2184
 
                    if inv.revision_id == revision_id:
2185
 
                        return revisiontree.RevisionTree(self.branch.repository,
2186
 
                            inv, revision_id)
2187
 
                except errors.BadInventoryFormat:
2188
 
                    pass
2189
 
        # raise if there was no inventory, or if we read the wrong inventory.
2190
 
        raise errors.NoSuchRevisionInTree(self, revision_id)
2191
 
 
2192
 
    # XXX: This method should be deprecated in favour of taking in a proper
2193
 
    # new Inventory object.
2194
 
    @needs_tree_write_lock
2195
 
    def set_inventory(self, new_inventory_list):
2196
 
        from bzrlib.inventory import (Inventory,
2197
 
                                      InventoryDirectory,
2198
 
                                      InventoryFile,
2199
 
                                      InventoryLink)
2200
 
        inv = Inventory(self.get_root_id())
2201
 
        for path, file_id, parent, kind in new_inventory_list:
2202
 
            name = os.path.basename(path)
2203
 
            if name == "":
2204
 
                continue
2205
 
            # fixme, there should be a factory function inv,add_??
2206
 
            if kind == 'directory':
2207
 
                inv.add(InventoryDirectory(file_id, name, parent))
2208
 
            elif kind == 'file':
2209
 
                inv.add(InventoryFile(file_id, name, parent))
2210
 
            elif kind == 'symlink':
2211
 
                inv.add(InventoryLink(file_id, name, parent))
2212
 
            else:
2213
 
                raise errors.BzrError("unknown kind %r" % kind)
2214
 
        self._write_inventory(inv)
 
1425
        raise NotImplementedError(self.revision_tree)
2215
1426
 
2216
1427
    @needs_tree_write_lock
2217
1428
    def set_root_id(self, file_id):
2230
1441
            present in the current inventory or an error will occur. It must
2231
1442
            not be None, but rather a valid file id.
2232
1443
        """
2233
 
        inv = self._inventory
2234
 
        orig_root_id = inv.root.file_id
2235
 
        # TODO: it might be nice to exit early if there was nothing
2236
 
        # to do, saving us from trigger a sync on unlock.
2237
 
        self._inventory_is_modified = True
2238
 
        # we preserve the root inventory entry object, but
2239
 
        # unlinkit from the byid index
2240
 
        del inv._byid[inv.root.file_id]
2241
 
        inv.root.file_id = file_id
2242
 
        # and link it into the index with the new changed id.
2243
 
        inv._byid[inv.root.file_id] = inv.root
2244
 
        # and finally update all children to reference the new id.
2245
 
        # XXX: this should be safe to just look at the root.children
2246
 
        # list, not the WHOLE INVENTORY.
2247
 
        for fid in inv:
2248
 
            entry = inv[fid]
2249
 
            if entry.parent_id == orig_root_id:
2250
 
                entry.parent_id = inv.root.file_id
 
1444
        raise NotImplementedError(self._set_root_id)
2251
1445
 
2252
1446
    def unlock(self):
2253
1447
        """See Branch.unlock.
2349
1543
                                             show_base=show_base)
2350
1544
            if nb_conflicts:
2351
1545
                self.add_parent_tree((old_tip, other_tree))
2352
 
                trace.note('Rerun update after fixing the conflicts.')
 
1546
                note('Rerun update after fixing the conflicts.')
2353
1547
                return nb_conflicts
2354
1548
 
2355
1549
        if last_rev != _mod_revision.ensure_null(revision):
2361
1555
            basis = self.basis_tree()
2362
1556
            basis.lock_read()
2363
1557
            try:
2364
 
                if (basis.inventory.root is None
2365
 
                    or basis.inventory.root.file_id != to_root_id):
 
1558
                if (basis.get_root_id() is None or basis.get_root_id() != to_root_id):
2366
1559
                    self.set_root_id(to_root_id)
2367
1560
                    self.flush()
2368
1561
            finally:
2410
1603
                #       warning might be sufficient to let the user know what
2411
1604
                #       is going on.
2412
1605
                mutter('Could not write hashcache for %s\nError: %s',
2413
 
                       self._hashcache.cache_file_name(), e)
2414
 
 
2415
 
    @needs_tree_write_lock
2416
 
    def _write_inventory(self, inv):
2417
 
        """Write inventory as the current inventory."""
2418
 
        self._set_inventory(inv, dirty=True)
2419
 
        self.flush()
 
1606
                              self._hashcache.cache_file_name(), e)
2420
1607
 
2421
1608
    def set_conflicts(self, arg):
2422
1609
        raise errors.UnsupportedOperation(self.set_conflicts, self)
2424
1611
    def add_conflicts(self, arg):
2425
1612
        raise errors.UnsupportedOperation(self.add_conflicts, self)
2426
1613
 
2427
 
    @needs_read_lock
2428
1614
    def conflicts(self):
2429
 
        conflicts = _mod_conflicts.ConflictList()
2430
 
        for conflicted in self._iter_conflicts():
2431
 
            text = True
2432
 
            try:
2433
 
                if file_kind(self.abspath(conflicted)) != "file":
2434
 
                    text = False
2435
 
            except errors.NoSuchFile:
2436
 
                text = False
2437
 
            if text is True:
2438
 
                for suffix in ('.THIS', '.OTHER'):
2439
 
                    try:
2440
 
                        kind = file_kind(self.abspath(conflicted+suffix))
2441
 
                        if kind != "file":
2442
 
                            text = False
2443
 
                    except errors.NoSuchFile:
2444
 
                        text = False
2445
 
                    if text == False:
2446
 
                        break
2447
 
            ctype = {True: 'text conflict', False: 'contents conflict'}[text]
2448
 
            conflicts.append(_mod_conflicts.Conflict.factory(ctype,
2449
 
                             path=conflicted,
2450
 
                             file_id=self.path2id(conflicted)))
2451
 
        return conflicts
 
1615
        raise NotImplementedError(self.conflicts)
2452
1616
 
2453
1617
    def walkdirs(self, prefix=""):
2454
1618
        """Walk the directories of this tree.
2580
1744
                 [(file1_path, file1_name, file1_kind, None, file1_id,
2581
1745
                   file1_kind), ... ])
2582
1746
        """
2583
 
        _directory = 'directory'
2584
 
        # get the root in the inventory
2585
 
        inv = self.inventory
2586
 
        top_id = inv.path2id(prefix)
2587
 
        if top_id is None:
2588
 
            pending = []
2589
 
        else:
2590
 
            pending = [(prefix, '', _directory, None, top_id, None)]
2591
 
        while pending:
2592
 
            dirblock = []
2593
 
            currentdir = pending.pop()
2594
 
            # 0 - relpath, 1- basename, 2- kind, 3- stat, 4-id, 5-kind
2595
 
            top_id = currentdir[4]
2596
 
            if currentdir[0]:
2597
 
                relroot = currentdir[0] + '/'
2598
 
            else:
2599
 
                relroot = ""
2600
 
            # FIXME: stash the node in pending
2601
 
            entry = inv[top_id]
2602
 
            if entry.kind == 'directory':
2603
 
                for name, child in entry.sorted_children():
2604
 
                    dirblock.append((relroot + name, name, child.kind, None,
2605
 
                        child.file_id, child.kind
2606
 
                        ))
2607
 
            yield (currentdir[0], entry.file_id), dirblock
2608
 
            # push the user specified dirs from dirblock
2609
 
            for dir in reversed(dirblock):
2610
 
                if dir[2] == _directory:
2611
 
                    pending.append(dir)
 
1747
        raise NotImplementedError(self._walkdirs)
2612
1748
 
2613
1749
    @needs_tree_write_lock
2614
1750
    def auto_resolve(self):
2642
1778
        self.set_conflicts(un_resolved)
2643
1779
        return un_resolved, resolved
2644
1780
 
2645
 
    @needs_read_lock
2646
 
    def _check(self, references):
2647
 
        """Check the tree for consistency.
2648
 
 
2649
 
        :param references: A dict with keys matching the items returned by
2650
 
            self._get_check_refs(), and values from looking those keys up in
2651
 
            the repository.
2652
 
        """
2653
 
        tree_basis = self.basis_tree()
2654
 
        tree_basis.lock_read()
2655
 
        try:
2656
 
            repo_basis = references[('trees', self.last_revision())]
2657
 
            if len(list(repo_basis.iter_changes(tree_basis))) > 0:
2658
 
                raise errors.BzrCheckError(
2659
 
                    "Mismatched basis inventory content.")
2660
 
            self._validate()
2661
 
        finally:
2662
 
            tree_basis.unlock()
2663
 
 
2664
1781
    def _validate(self):
2665
1782
        """Validate internal structures.
2666
1783
 
2672
1789
        """
2673
1790
        return
2674
1791
 
 
1792
    def check_state(self):
 
1793
        """Check that the working state is/isn't valid."""
 
1794
        raise NotImplementedError(self.check_state)
 
1795
 
 
1796
    def reset_state(self, revision_ids=None):
 
1797
        """Reset the state of the working tree.
 
1798
 
 
1799
        This does a hard-reset to a last-known-good state. This is a way to
 
1800
        fix if something got corrupted (like the .bzr/checkout/dirstate file)
 
1801
        """
 
1802
        raise NotImplementedError(self.reset_state)
 
1803
 
2675
1804
    def _get_rules_searcher(self, default_searcher):
2676
1805
        """See Tree._get_rules_searcher."""
2677
1806
        if self._rules_searcher is None:
2685
1814
        return ShelfManager(self, self._transport)
2686
1815
 
2687
1816
 
2688
 
class WorkingTree2(WorkingTree):
2689
 
    """This is the Format 2 working tree.
2690
 
 
2691
 
    This was the first weave based working tree.
2692
 
     - uses os locks for locking.
2693
 
     - uses the branch last-revision.
 
1817
class InventoryWorkingTree(WorkingTree,
 
1818
        bzrlib.mutabletree.MutableInventoryTree):
 
1819
    """Base class for working trees that are inventory-oriented.
 
1820
 
 
1821
    The inventory is held in the `Branch` working-inventory, and the
 
1822
    files are in a directory on disk.
 
1823
 
 
1824
    It is possible for a `WorkingTree` to have a filename which is
 
1825
    not listed in the Inventory and vice versa.
2694
1826
    """
2695
1827
 
2696
 
    def __init__(self, *args, **kwargs):
2697
 
        super(WorkingTree2, self).__init__(*args, **kwargs)
2698
 
        # WorkingTree2 has more of a constraint that self._inventory must
2699
 
        # exist. Because this is an older format, we don't mind the overhead
2700
 
        # caused by the extra computation here.
2701
 
 
2702
 
        # Newer WorkingTree's should only have self._inventory set when they
2703
 
        # have a read lock.
2704
 
        if self._inventory is None:
2705
 
            self.read_working_inventory()
2706
 
 
2707
 
    def _get_check_refs(self):
2708
 
        """Return the references needed to perform a check of this tree."""
2709
 
        return [('trees', self.last_revision())]
2710
 
 
2711
 
    def lock_tree_write(self):
2712
 
        """See WorkingTree.lock_tree_write().
2713
 
 
2714
 
        In Format2 WorkingTrees we have a single lock for the branch and tree
2715
 
        so lock_tree_write() degrades to lock_write().
2716
 
 
2717
 
        :return: An object with an unlock method which will release the lock
2718
 
            obtained.
2719
 
        """
2720
 
        self.branch.lock_write()
2721
 
        try:
2722
 
            self._control_files.lock_write()
2723
 
            return self
2724
 
        except:
2725
 
            self.branch.unlock()
2726
 
            raise
2727
 
 
2728
 
    def unlock(self):
2729
 
        # do non-implementation specific cleanup
2730
 
        self._cleanup()
2731
 
 
2732
 
        # we share control files:
2733
 
        if self._control_files._lock_count == 3:
2734
 
            # _inventory_is_modified is always False during a read lock.
2735
 
            if self._inventory_is_modified:
2736
 
                self.flush()
2737
 
            self._write_hashcache_if_dirty()
2738
 
 
2739
 
        # reverse order of locking.
2740
 
        try:
2741
 
            return self._control_files.unlock()
 
1828
    def __init__(self, basedir='.',
 
1829
                 branch=DEPRECATED_PARAMETER,
 
1830
                 _inventory=None,
 
1831
                 _control_files=None,
 
1832
                 _internal=False,
 
1833
                 _format=None,
 
1834
                 _bzrdir=None):
 
1835
        """Construct a InventoryWorkingTree instance. This is not a public API.
 
1836
 
 
1837
        :param branch: A branch to override probing for the branch.
 
1838
        """
 
1839
        super(InventoryWorkingTree, self).__init__(basedir=basedir,
 
1840
            branch=branch, _control_files=_control_files, _internal=_internal,
 
1841
            _format=_format, _bzrdir=_bzrdir)
 
1842
 
 
1843
        if _inventory is None:
 
1844
            # This will be acquired on lock_read() or lock_write()
 
1845
            self._inventory_is_modified = False
 
1846
            self._inventory = None
 
1847
        else:
 
1848
            # the caller of __init__ has provided an inventory,
 
1849
            # we assume they know what they are doing - as its only
 
1850
            # the Format factory and creation methods that are
 
1851
            # permitted to do this.
 
1852
            self._set_inventory(_inventory, dirty=False)
 
1853
 
 
1854
    def _set_inventory(self, inv, dirty):
 
1855
        """Set the internal cached inventory.
 
1856
 
 
1857
        :param inv: The inventory to set.
 
1858
        :param dirty: A boolean indicating whether the inventory is the same
 
1859
            logical inventory as whats on disk. If True the inventory is not
 
1860
            the same and should be written to disk or data will be lost, if
 
1861
            False then the inventory is the same as that on disk and any
 
1862
            serialisation would be unneeded overhead.
 
1863
        """
 
1864
        self._inventory = inv
 
1865
        self._inventory_is_modified = dirty
 
1866
 
 
1867
    def _serialize(self, inventory, out_file):
 
1868
        xml5.serializer_v5.write_inventory(self._inventory, out_file,
 
1869
            working=True)
 
1870
 
 
1871
    def _deserialize(selt, in_file):
 
1872
        return xml5.serializer_v5.read_inventory(in_file)
 
1873
 
 
1874
    @needs_tree_write_lock
 
1875
    def _write_inventory(self, inv):
 
1876
        """Write inventory as the current inventory."""
 
1877
        self._set_inventory(inv, dirty=True)
 
1878
        self.flush()
 
1879
 
 
1880
    # XXX: This method should be deprecated in favour of taking in a proper
 
1881
    # new Inventory object.
 
1882
    @needs_tree_write_lock
 
1883
    def set_inventory(self, new_inventory_list):
 
1884
        from bzrlib.inventory import (Inventory,
 
1885
                                      InventoryDirectory,
 
1886
                                      InventoryFile,
 
1887
                                      InventoryLink)
 
1888
        inv = Inventory(self.get_root_id())
 
1889
        for path, file_id, parent, kind in new_inventory_list:
 
1890
            name = os.path.basename(path)
 
1891
            if name == "":
 
1892
                continue
 
1893
            # fixme, there should be a factory function inv,add_??
 
1894
            if kind == 'directory':
 
1895
                inv.add(InventoryDirectory(file_id, name, parent))
 
1896
            elif kind == 'file':
 
1897
                inv.add(InventoryFile(file_id, name, parent))
 
1898
            elif kind == 'symlink':
 
1899
                inv.add(InventoryLink(file_id, name, parent))
 
1900
            else:
 
1901
                raise errors.BzrError("unknown kind %r" % kind)
 
1902
        self._write_inventory(inv)
 
1903
 
 
1904
    def _write_basis_inventory(self, xml):
 
1905
        """Write the basis inventory XML to the basis-inventory file"""
 
1906
        path = self._basis_inventory_name()
 
1907
        sio = StringIO(xml)
 
1908
        self._transport.put_file(path, sio,
 
1909
            mode=self.bzrdir._get_file_mode())
 
1910
 
 
1911
    def _reset_data(self):
 
1912
        """Reset transient data that cannot be revalidated."""
 
1913
        self._inventory_is_modified = False
 
1914
        f = self._transport.get('inventory')
 
1915
        try:
 
1916
            result = self._deserialize(f)
2742
1917
        finally:
2743
 
            self.branch.unlock()
2744
 
 
2745
 
 
2746
 
class WorkingTree3(WorkingTree):
2747
 
    """This is the Format 3 working tree.
2748
 
 
2749
 
    This differs from the base WorkingTree by:
2750
 
     - having its own file lock
2751
 
     - having its own last-revision property.
2752
 
 
2753
 
    This is new in bzr 0.8
2754
 
    """
2755
 
 
2756
 
    @needs_read_lock
2757
 
    def _last_revision(self):
2758
 
        """See Mutable.last_revision."""
 
1918
            f.close()
 
1919
        self._set_inventory(result, dirty=False)
 
1920
 
 
1921
    def _set_root_id(self, file_id):
 
1922
        """Set the root id for this tree, in a format specific manner.
 
1923
 
 
1924
        :param file_id: The file id to assign to the root. It must not be
 
1925
            present in the current inventory or an error will occur. It must
 
1926
            not be None, but rather a valid file id.
 
1927
        """
 
1928
        inv = self._inventory
 
1929
        orig_root_id = inv.root.file_id
 
1930
        # TODO: it might be nice to exit early if there was nothing
 
1931
        # to do, saving us from trigger a sync on unlock.
 
1932
        self._inventory_is_modified = True
 
1933
        # we preserve the root inventory entry object, but
 
1934
        # unlinkit from the byid index
 
1935
        del inv._byid[inv.root.file_id]
 
1936
        inv.root.file_id = file_id
 
1937
        # and link it into the index with the new changed id.
 
1938
        inv._byid[inv.root.file_id] = inv.root
 
1939
        # and finally update all children to reference the new id.
 
1940
        # XXX: this should be safe to just look at the root.children
 
1941
        # list, not the WHOLE INVENTORY.
 
1942
        for fid in inv:
 
1943
            entry = inv[fid]
 
1944
            if entry.parent_id == orig_root_id:
 
1945
                entry.parent_id = inv.root.file_id
 
1946
 
 
1947
    def all_file_ids(self):
 
1948
        """See Tree.iter_all_file_ids"""
 
1949
        return set(self.inventory)
 
1950
 
 
1951
    @needs_tree_write_lock
 
1952
    def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
 
1953
        """See MutableTree.set_parent_trees."""
 
1954
        parent_ids = [rev for (rev, tree) in parents_list]
 
1955
        for revision_id in parent_ids:
 
1956
            _mod_revision.check_not_reserved_id(revision_id)
 
1957
 
 
1958
        self._check_parents_for_ghosts(parent_ids,
 
1959
            allow_leftmost_as_ghost=allow_leftmost_as_ghost)
 
1960
 
 
1961
        parent_ids = self._filter_parent_ids_by_ancestry(parent_ids)
 
1962
 
 
1963
        if len(parent_ids) == 0:
 
1964
            leftmost_parent_id = _mod_revision.NULL_REVISION
 
1965
            leftmost_parent_tree = None
 
1966
        else:
 
1967
            leftmost_parent_id, leftmost_parent_tree = parents_list[0]
 
1968
 
 
1969
        if self._change_last_revision(leftmost_parent_id):
 
1970
            if leftmost_parent_tree is None:
 
1971
                # If we don't have a tree, fall back to reading the
 
1972
                # parent tree from the repository.
 
1973
                self._cache_basis_inventory(leftmost_parent_id)
 
1974
            else:
 
1975
                inv = leftmost_parent_tree.inventory
 
1976
                xml = self._create_basis_xml_from_inventory(
 
1977
                                        leftmost_parent_id, inv)
 
1978
                self._write_basis_inventory(xml)
 
1979
        self._set_merges_from_parent_ids(parent_ids)
 
1980
 
 
1981
    def _cache_basis_inventory(self, new_revision):
 
1982
        """Cache new_revision as the basis inventory."""
 
1983
        # TODO: this should allow the ready-to-use inventory to be passed in,
 
1984
        # as commit already has that ready-to-use [while the format is the
 
1985
        # same, that is].
2759
1986
        try:
2760
 
            return self._transport.get_bytes('last-revision')
2761
 
        except errors.NoSuchFile:
2762
 
            return _mod_revision.NULL_REVISION
2763
 
 
2764
 
    def _change_last_revision(self, revision_id):
2765
 
        """See WorkingTree._change_last_revision."""
2766
 
        if revision_id is None or revision_id == _mod_revision.NULL_REVISION:
2767
 
            try:
2768
 
                self._transport.delete('last-revision')
2769
 
            except errors.NoSuchFile:
2770
 
                pass
2771
 
            return False
2772
 
        else:
2773
 
            self._transport.put_bytes('last-revision', revision_id,
2774
 
                mode=self.bzrdir._get_file_mode())
2775
 
            return True
2776
 
 
2777
 
    def _get_check_refs(self):
2778
 
        """Return the references needed to perform a check of this tree."""
2779
 
        return [('trees', self.last_revision())]
 
1987
            # this double handles the inventory - unpack and repack -
 
1988
            # but is easier to understand. We can/should put a conditional
 
1989
            # in here based on whether the inventory is in the latest format
 
1990
            # - perhaps we should repack all inventories on a repository
 
1991
            # upgrade ?
 
1992
            # the fast path is to copy the raw xml from the repository. If the
 
1993
            # xml contains 'revision_id="', then we assume the right
 
1994
            # revision_id is set. We must check for this full string, because a
 
1995
            # root node id can legitimately look like 'revision_id' but cannot
 
1996
            # contain a '"'.
 
1997
            xml = self.branch.repository._get_inventory_xml(new_revision)
 
1998
            firstline = xml.split('\n', 1)[0]
 
1999
            if (not 'revision_id="' in firstline or
 
2000
                'format="7"' not in firstline):
 
2001
                inv = self.branch.repository._serializer.read_inventory_from_string(
 
2002
                    xml, new_revision)
 
2003
                xml = self._create_basis_xml_from_inventory(new_revision, inv)
 
2004
            self._write_basis_inventory(xml)
 
2005
        except (errors.NoSuchRevision, errors.RevisionNotPresent):
 
2006
            pass
 
2007
 
 
2008
    def _basis_inventory_name(self):
 
2009
        return 'basis-inventory-cache'
 
2010
 
 
2011
    def _create_basis_xml_from_inventory(self, revision_id, inventory):
 
2012
        """Create the text that will be saved in basis-inventory"""
 
2013
        inventory.revision_id = revision_id
 
2014
        return xml7.serializer_v7.write_inventory_to_string(inventory)
2780
2015
 
2781
2016
    @needs_tree_write_lock
2782
2017
    def set_conflicts(self, conflicts):
2802
2037
                    raise errors.ConflictFormatError()
2803
2038
            except StopIteration:
2804
2039
                raise errors.ConflictFormatError()
2805
 
            return _mod_conflicts.ConflictList.from_stanzas(RioReader(confile))
 
2040
            reader = _mod_rio.RioReader(confile)
 
2041
            return _mod_conflicts.ConflictList.from_stanzas(reader)
2806
2042
        finally:
2807
2043
            confile.close()
2808
2044
 
2809
 
    def unlock(self):
2810
 
        # do non-implementation specific cleanup
2811
 
        self._cleanup()
2812
 
        if self._control_files._lock_count == 1:
2813
 
            # _inventory_is_modified is always False during a read lock.
2814
 
            if self._inventory_is_modified:
2815
 
                self.flush()
2816
 
            self._write_hashcache_if_dirty()
2817
 
        # reverse order of locking.
2818
 
        try:
2819
 
            return self._control_files.unlock()
2820
 
        finally:
2821
 
            self.branch.unlock()
2822
 
 
2823
 
 
2824
 
def get_conflicted_stem(path):
2825
 
    for suffix in _mod_conflicts.CONFLICT_SUFFIXES:
2826
 
        if path.endswith(suffix):
2827
 
            return path[:-len(suffix)]
2828
 
 
2829
 
 
2830
 
class WorkingTreeFormat(object):
 
2045
    def read_basis_inventory(self):
 
2046
        """Read the cached basis inventory."""
 
2047
        path = self._basis_inventory_name()
 
2048
        return self._transport.get_bytes(path)
 
2049
 
 
2050
    @needs_read_lock
 
2051
    def read_working_inventory(self):
 
2052
        """Read the working inventory.
 
2053
 
 
2054
        :raises errors.InventoryModified: read_working_inventory will fail
 
2055
            when the current in memory inventory has been modified.
 
2056
        """
 
2057
        # conceptually this should be an implementation detail of the tree.
 
2058
        # XXX: Deprecate this.
 
2059
        # ElementTree does its own conversion from UTF-8, so open in
 
2060
        # binary.
 
2061
        if self._inventory_is_modified:
 
2062
            raise errors.InventoryModified(self)
 
2063
        f = self._transport.get('inventory')
 
2064
        try:
 
2065
            result = self._deserialize(f)
 
2066
        finally:
 
2067
            f.close()
 
2068
        self._set_inventory(result, dirty=False)
 
2069
        return result
 
2070
 
 
2071
    @needs_read_lock
 
2072
    def get_root_id(self):
 
2073
        """Return the id of this trees root"""
 
2074
        return self._inventory.root.file_id
 
2075
 
 
2076
    def has_id(self, file_id):
 
2077
        # files that have been deleted are excluded
 
2078
        inv = self.inventory
 
2079
        if not inv.has_id(file_id):
 
2080
            return False
 
2081
        path = inv.id2path(file_id)
 
2082
        return osutils.lexists(self.abspath(path))
 
2083
 
 
2084
    def has_or_had_id(self, file_id):
 
2085
        if file_id == self.inventory.root.file_id:
 
2086
            return True
 
2087
        return self.inventory.has_id(file_id)
 
2088
 
 
2089
    __contains__ = has_id
 
2090
 
 
2091
    @symbol_versioning.deprecated_method(symbol_versioning.deprecated_in((2, 4, 0)))
 
2092
    def __iter__(self):
 
2093
        """Iterate through file_ids for this tree.
 
2094
 
 
2095
        file_ids are in a WorkingTree if they are in the working inventory
 
2096
        and the working file exists.
 
2097
        """
 
2098
        inv = self._inventory
 
2099
        for path, ie in inv.iter_entries():
 
2100
            if osutils.lexists(self.abspath(path)):
 
2101
                yield ie.file_id
 
2102
 
 
2103
    @needs_tree_write_lock
 
2104
    def set_last_revision(self, new_revision):
 
2105
        """Change the last revision in the working tree."""
 
2106
        if self._change_last_revision(new_revision):
 
2107
            self._cache_basis_inventory(new_revision)
 
2108
 
 
2109
    def _get_check_refs(self):
 
2110
        """Return the references needed to perform a check of this tree.
 
2111
        
 
2112
        The default implementation returns no refs, and is only suitable for
 
2113
        trees that have no local caching and can commit on ghosts at any time.
 
2114
 
 
2115
        :seealso: bzrlib.check for details about check_refs.
 
2116
        """
 
2117
        return []
 
2118
 
 
2119
    @needs_read_lock
 
2120
    def _check(self, references):
 
2121
        """Check the tree for consistency.
 
2122
 
 
2123
        :param references: A dict with keys matching the items returned by
 
2124
            self._get_check_refs(), and values from looking those keys up in
 
2125
            the repository.
 
2126
        """
 
2127
        tree_basis = self.basis_tree()
 
2128
        tree_basis.lock_read()
 
2129
        try:
 
2130
            repo_basis = references[('trees', self.last_revision())]
 
2131
            if len(list(repo_basis.iter_changes(tree_basis))) > 0:
 
2132
                raise errors.BzrCheckError(
 
2133
                    "Mismatched basis inventory content.")
 
2134
            self._validate()
 
2135
        finally:
 
2136
            tree_basis.unlock()
 
2137
 
 
2138
    @needs_read_lock
 
2139
    def check_state(self):
 
2140
        """Check that the working state is/isn't valid."""
 
2141
        check_refs = self._get_check_refs()
 
2142
        refs = {}
 
2143
        for ref in check_refs:
 
2144
            kind, value = ref
 
2145
            if kind == 'trees':
 
2146
                refs[ref] = self.branch.repository.revision_tree(value)
 
2147
        self._check(refs)
 
2148
 
 
2149
    @needs_tree_write_lock
 
2150
    def reset_state(self, revision_ids=None):
 
2151
        """Reset the state of the working tree.
 
2152
 
 
2153
        This does a hard-reset to a last-known-good state. This is a way to
 
2154
        fix if something got corrupted (like the .bzr/checkout/dirstate file)
 
2155
        """
 
2156
        if revision_ids is None:
 
2157
            revision_ids = self.get_parent_ids()
 
2158
        if not revision_ids:
 
2159
            rt = self.branch.repository.revision_tree(
 
2160
                _mod_revision.NULL_REVISION)
 
2161
        else:
 
2162
            rt = self.branch.repository.revision_tree(revision_ids[0])
 
2163
        self._write_inventory(rt.inventory)
 
2164
        self.set_parent_ids(revision_ids)
 
2165
 
 
2166
    def flush(self):
 
2167
        """Write the in memory inventory to disk."""
 
2168
        # TODO: Maybe this should only write on dirty ?
 
2169
        if self._control_files._lock_mode != 'w':
 
2170
            raise errors.NotWriteLocked(self)
 
2171
        sio = StringIO()
 
2172
        self._serialize(self._inventory, sio)
 
2173
        sio.seek(0)
 
2174
        self._transport.put_file('inventory', sio,
 
2175
            mode=self.bzrdir._get_file_mode())
 
2176
        self._inventory_is_modified = False
 
2177
 
 
2178
    @needs_read_lock
 
2179
    def get_file_sha1(self, file_id, path=None, stat_value=None):
 
2180
        if not path:
 
2181
            path = self._inventory.id2path(file_id)
 
2182
        return self._hashcache.get_sha1(path, stat_value)
 
2183
 
 
2184
    def get_file_mtime(self, file_id, path=None):
 
2185
        """See Tree.get_file_mtime."""
 
2186
        if not path:
 
2187
            path = self.inventory.id2path(file_id)
 
2188
        return os.lstat(self.abspath(path)).st_mtime
 
2189
 
 
2190
    def _is_executable_from_path_and_stat_from_basis(self, path, stat_result):
 
2191
        file_id = self.path2id(path)
 
2192
        if file_id is None:
 
2193
            # For unversioned files on win32, we just assume they are not
 
2194
            # executable
 
2195
            return False
 
2196
        return self._inventory[file_id].executable
 
2197
 
 
2198
    def _is_executable_from_path_and_stat_from_stat(self, path, stat_result):
 
2199
        mode = stat_result.st_mode
 
2200
        return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
 
2201
 
 
2202
    if not supports_executable():
 
2203
        def is_executable(self, file_id, path=None):
 
2204
            return self._inventory[file_id].executable
 
2205
 
 
2206
        _is_executable_from_path_and_stat = \
 
2207
            _is_executable_from_path_and_stat_from_basis
 
2208
    else:
 
2209
        def is_executable(self, file_id, path=None):
 
2210
            if not path:
 
2211
                path = self.id2path(file_id)
 
2212
            mode = os.lstat(self.abspath(path)).st_mode
 
2213
            return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
 
2214
 
 
2215
        _is_executable_from_path_and_stat = \
 
2216
            _is_executable_from_path_and_stat_from_stat
 
2217
 
 
2218
    @needs_tree_write_lock
 
2219
    def _add(self, files, ids, kinds):
 
2220
        """See MutableTree._add."""
 
2221
        # TODO: Re-adding a file that is removed in the working copy
 
2222
        # should probably put it back with the previous ID.
 
2223
        # the read and write working inventory should not occur in this
 
2224
        # function - they should be part of lock_write and unlock.
 
2225
        inv = self.inventory
 
2226
        for f, file_id, kind in zip(files, ids, kinds):
 
2227
            if file_id is None:
 
2228
                inv.add_path(f, kind=kind)
 
2229
            else:
 
2230
                inv.add_path(f, kind=kind, file_id=file_id)
 
2231
            self._inventory_is_modified = True
 
2232
 
 
2233
    def revision_tree(self, revision_id):
 
2234
        """See WorkingTree.revision_id."""
 
2235
        if revision_id == self.last_revision():
 
2236
            try:
 
2237
                xml = self.read_basis_inventory()
 
2238
            except errors.NoSuchFile:
 
2239
                pass
 
2240
            else:
 
2241
                try:
 
2242
                    inv = xml7.serializer_v7.read_inventory_from_string(xml)
 
2243
                    # dont use the repository revision_tree api because we want
 
2244
                    # to supply the inventory.
 
2245
                    if inv.revision_id == revision_id:
 
2246
                        return revisiontree.InventoryRevisionTree(
 
2247
                            self.branch.repository, inv, revision_id)
 
2248
                except errors.BadInventoryFormat:
 
2249
                    pass
 
2250
        # raise if there was no inventory, or if we read the wrong inventory.
 
2251
        raise errors.NoSuchRevisionInTree(self, revision_id)
 
2252
 
 
2253
    @needs_read_lock
 
2254
    def annotate_iter(self, file_id, default_revision=CURRENT_REVISION):
 
2255
        """See Tree.annotate_iter
 
2256
 
 
2257
        This implementation will use the basis tree implementation if possible.
 
2258
        Lines not in the basis are attributed to CURRENT_REVISION
 
2259
 
 
2260
        If there are pending merges, lines added by those merges will be
 
2261
        incorrectly attributed to CURRENT_REVISION (but after committing, the
 
2262
        attribution will be correct).
 
2263
        """
 
2264
        maybe_file_parent_keys = []
 
2265
        for parent_id in self.get_parent_ids():
 
2266
            try:
 
2267
                parent_tree = self.revision_tree(parent_id)
 
2268
            except errors.NoSuchRevisionInTree:
 
2269
                parent_tree = self.branch.repository.revision_tree(parent_id)
 
2270
            parent_tree.lock_read()
 
2271
            try:
 
2272
                if file_id not in parent_tree:
 
2273
                    continue
 
2274
                ie = parent_tree.inventory[file_id]
 
2275
                if ie.kind != 'file':
 
2276
                    # Note: this is slightly unnecessary, because symlinks and
 
2277
                    # directories have a "text" which is the empty text, and we
 
2278
                    # know that won't mess up annotations. But it seems cleaner
 
2279
                    continue
 
2280
                parent_text_key = (file_id, ie.revision)
 
2281
                if parent_text_key not in maybe_file_parent_keys:
 
2282
                    maybe_file_parent_keys.append(parent_text_key)
 
2283
            finally:
 
2284
                parent_tree.unlock()
 
2285
        graph = _mod_graph.Graph(self.branch.repository.texts)
 
2286
        heads = graph.heads(maybe_file_parent_keys)
 
2287
        file_parent_keys = []
 
2288
        for key in maybe_file_parent_keys:
 
2289
            if key in heads:
 
2290
                file_parent_keys.append(key)
 
2291
 
 
2292
        # Now we have the parents of this content
 
2293
        annotator = self.branch.repository.texts.get_annotator()
 
2294
        text = self.get_file_text(file_id)
 
2295
        this_key =(file_id, default_revision)
 
2296
        annotator.add_special_text(this_key, file_parent_keys, text)
 
2297
        annotations = [(key[-1], line)
 
2298
                       for key, line in annotator.annotate_flat(this_key)]
 
2299
        return annotations
 
2300
 
 
2301
    @needs_read_lock
 
2302
    def merge_modified(self):
 
2303
        """Return a dictionary of files modified by a merge.
 
2304
 
 
2305
        The list is initialized by WorkingTree.set_merge_modified, which is
 
2306
        typically called after we make some automatic updates to the tree
 
2307
        because of a merge.
 
2308
 
 
2309
        This returns a map of file_id->sha1, containing only files which are
 
2310
        still in the working inventory and have that text hash.
 
2311
        """
 
2312
        try:
 
2313
            hashfile = self._transport.get('merge-hashes')
 
2314
        except errors.NoSuchFile:
 
2315
            return {}
 
2316
        try:
 
2317
            merge_hashes = {}
 
2318
            try:
 
2319
                if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
 
2320
                    raise errors.MergeModifiedFormatError()
 
2321
            except StopIteration:
 
2322
                raise errors.MergeModifiedFormatError()
 
2323
            for s in _mod_rio.RioReader(hashfile):
 
2324
                # RioReader reads in Unicode, so convert file_ids back to utf8
 
2325
                file_id = osutils.safe_file_id(s.get("file_id"), warn=False)
 
2326
                if file_id not in self.inventory:
 
2327
                    continue
 
2328
                text_hash = s.get("hash")
 
2329
                if text_hash == self.get_file_sha1(file_id):
 
2330
                    merge_hashes[file_id] = text_hash
 
2331
            return merge_hashes
 
2332
        finally:
 
2333
            hashfile.close()
 
2334
 
 
2335
    @needs_write_lock
 
2336
    def subsume(self, other_tree):
 
2337
        def add_children(inventory, entry):
 
2338
            for child_entry in entry.children.values():
 
2339
                inventory._byid[child_entry.file_id] = child_entry
 
2340
                if child_entry.kind == 'directory':
 
2341
                    add_children(inventory, child_entry)
 
2342
        if other_tree.get_root_id() == self.get_root_id():
 
2343
            raise errors.BadSubsumeSource(self, other_tree,
 
2344
                                          'Trees have the same root')
 
2345
        try:
 
2346
            other_tree_path = self.relpath(other_tree.basedir)
 
2347
        except errors.PathNotChild:
 
2348
            raise errors.BadSubsumeSource(self, other_tree,
 
2349
                'Tree is not contained by the other')
 
2350
        new_root_parent = self.path2id(osutils.dirname(other_tree_path))
 
2351
        if new_root_parent is None:
 
2352
            raise errors.BadSubsumeSource(self, other_tree,
 
2353
                'Parent directory is not versioned.')
 
2354
        # We need to ensure that the result of a fetch will have a
 
2355
        # versionedfile for the other_tree root, and only fetching into
 
2356
        # RepositoryKnit2 guarantees that.
 
2357
        if not self.branch.repository.supports_rich_root():
 
2358
            raise errors.SubsumeTargetNeedsUpgrade(other_tree)
 
2359
        other_tree.lock_tree_write()
 
2360
        try:
 
2361
            new_parents = other_tree.get_parent_ids()
 
2362
            other_root = other_tree.inventory.root
 
2363
            other_root.parent_id = new_root_parent
 
2364
            other_root.name = osutils.basename(other_tree_path)
 
2365
            self.inventory.add(other_root)
 
2366
            add_children(self.inventory, other_root)
 
2367
            self._write_inventory(self.inventory)
 
2368
            # normally we don't want to fetch whole repositories, but i think
 
2369
            # here we really do want to consolidate the whole thing.
 
2370
            for parent_id in other_tree.get_parent_ids():
 
2371
                self.branch.fetch(other_tree.branch, parent_id)
 
2372
                self.add_parent_tree_id(parent_id)
 
2373
        finally:
 
2374
            other_tree.unlock()
 
2375
        other_tree.bzrdir.retire_bzrdir()
 
2376
 
 
2377
    @needs_tree_write_lock
 
2378
    def extract(self, file_id, format=None):
 
2379
        """Extract a subtree from this tree.
 
2380
 
 
2381
        A new branch will be created, relative to the path for this tree.
 
2382
        """
 
2383
        self.flush()
 
2384
        def mkdirs(path):
 
2385
            segments = osutils.splitpath(path)
 
2386
            transport = self.branch.bzrdir.root_transport
 
2387
            for name in segments:
 
2388
                transport = transport.clone(name)
 
2389
                transport.ensure_base()
 
2390
            return transport
 
2391
 
 
2392
        sub_path = self.id2path(file_id)
 
2393
        branch_transport = mkdirs(sub_path)
 
2394
        if format is None:
 
2395
            format = self.bzrdir.cloning_metadir()
 
2396
        branch_transport.ensure_base()
 
2397
        branch_bzrdir = format.initialize_on_transport(branch_transport)
 
2398
        try:
 
2399
            repo = branch_bzrdir.find_repository()
 
2400
        except errors.NoRepositoryPresent:
 
2401
            repo = branch_bzrdir.create_repository()
 
2402
        if not repo.supports_rich_root():
 
2403
            raise errors.RootNotRich()
 
2404
        new_branch = branch_bzrdir.create_branch()
 
2405
        new_branch.pull(self.branch)
 
2406
        for parent_id in self.get_parent_ids():
 
2407
            new_branch.fetch(self.branch, parent_id)
 
2408
        tree_transport = self.bzrdir.root_transport.clone(sub_path)
 
2409
        if tree_transport.base != branch_transport.base:
 
2410
            tree_bzrdir = format.initialize_on_transport(tree_transport)
 
2411
            branch.BranchReferenceFormat().initialize(tree_bzrdir,
 
2412
                target_branch=new_branch)
 
2413
        else:
 
2414
            tree_bzrdir = branch_bzrdir
 
2415
        wt = tree_bzrdir.create_workingtree(_mod_revision.NULL_REVISION)
 
2416
        wt.set_parent_ids(self.get_parent_ids())
 
2417
        my_inv = self.inventory
 
2418
        child_inv = inventory.Inventory(root_id=None)
 
2419
        new_root = my_inv[file_id]
 
2420
        my_inv.remove_recursive_id(file_id)
 
2421
        new_root.parent_id = None
 
2422
        child_inv.add(new_root)
 
2423
        self._write_inventory(my_inv)
 
2424
        wt._write_inventory(child_inv)
 
2425
        return wt
 
2426
 
 
2427
    def list_files(self, include_root=False, from_dir=None, recursive=True):
 
2428
        """List all files as (path, class, kind, id, entry).
 
2429
 
 
2430
        Lists, but does not descend into unversioned directories.
 
2431
        This does not include files that have been deleted in this
 
2432
        tree. Skips the control directory.
 
2433
 
 
2434
        :param include_root: if True, return an entry for the root
 
2435
        :param from_dir: start from this directory or None for the root
 
2436
        :param recursive: whether to recurse into subdirectories or not
 
2437
        """
 
2438
        # list_files is an iterator, so @needs_read_lock doesn't work properly
 
2439
        # with it. So callers should be careful to always read_lock the tree.
 
2440
        if not self.is_locked():
 
2441
            raise errors.ObjectNotLocked(self)
 
2442
 
 
2443
        inv = self.inventory
 
2444
        if from_dir is None and include_root is True:
 
2445
            yield ('', 'V', 'directory', inv.root.file_id, inv.root)
 
2446
        # Convert these into local objects to save lookup times
 
2447
        pathjoin = osutils.pathjoin
 
2448
        file_kind = self._kind
 
2449
 
 
2450
        # transport.base ends in a slash, we want the piece
 
2451
        # between the last two slashes
 
2452
        transport_base_dir = self.bzrdir.transport.base.rsplit('/', 2)[1]
 
2453
 
 
2454
        fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
 
2455
 
 
2456
        # directory file_id, relative path, absolute path, reverse sorted children
 
2457
        if from_dir is not None:
 
2458
            from_dir_id = inv.path2id(from_dir)
 
2459
            if from_dir_id is None:
 
2460
                # Directory not versioned
 
2461
                return
 
2462
            from_dir_abspath = pathjoin(self.basedir, from_dir)
 
2463
        else:
 
2464
            from_dir_id = inv.root.file_id
 
2465
            from_dir_abspath = self.basedir
 
2466
        children = os.listdir(from_dir_abspath)
 
2467
        children.sort()
 
2468
        # jam 20060527 The kernel sized tree seems equivalent whether we
 
2469
        # use a deque and popleft to keep them sorted, or if we use a plain
 
2470
        # list and just reverse() them.
 
2471
        children = collections.deque(children)
 
2472
        stack = [(from_dir_id, u'', from_dir_abspath, children)]
 
2473
        while stack:
 
2474
            from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
 
2475
 
 
2476
            while children:
 
2477
                f = children.popleft()
 
2478
                ## TODO: If we find a subdirectory with its own .bzr
 
2479
                ## directory, then that is a separate tree and we
 
2480
                ## should exclude it.
 
2481
 
 
2482
                # the bzrdir for this tree
 
2483
                if transport_base_dir == f:
 
2484
                    continue
 
2485
 
 
2486
                # we know that from_dir_relpath and from_dir_abspath never end in a slash
 
2487
                # and 'f' doesn't begin with one, we can do a string op, rather
 
2488
                # than the checks of pathjoin(), all relative paths will have an extra slash
 
2489
                # at the beginning
 
2490
                fp = from_dir_relpath + '/' + f
 
2491
 
 
2492
                # absolute path
 
2493
                fap = from_dir_abspath + '/' + f
 
2494
 
 
2495
                dir_ie = inv[from_dir_id]
 
2496
                if dir_ie.kind == 'directory':
 
2497
                    f_ie = dir_ie.children.get(f)
 
2498
                else:
 
2499
                    f_ie = None
 
2500
                if f_ie:
 
2501
                    c = 'V'
 
2502
                elif self.is_ignored(fp[1:]):
 
2503
                    c = 'I'
 
2504
                else:
 
2505
                    # we may not have found this file, because of a unicode
 
2506
                    # issue, or because the directory was actually a symlink.
 
2507
                    f_norm, can_access = osutils.normalized_filename(f)
 
2508
                    if f == f_norm or not can_access:
 
2509
                        # No change, so treat this file normally
 
2510
                        c = '?'
 
2511
                    else:
 
2512
                        # this file can be accessed by a normalized path
 
2513
                        # check again if it is versioned
 
2514
                        # these lines are repeated here for performance
 
2515
                        f = f_norm
 
2516
                        fp = from_dir_relpath + '/' + f
 
2517
                        fap = from_dir_abspath + '/' + f
 
2518
                        f_ie = inv.get_child(from_dir_id, f)
 
2519
                        if f_ie:
 
2520
                            c = 'V'
 
2521
                        elif self.is_ignored(fp[1:]):
 
2522
                            c = 'I'
 
2523
                        else:
 
2524
                            c = '?'
 
2525
 
 
2526
                fk = file_kind(fap)
 
2527
 
 
2528
                # make a last minute entry
 
2529
                if f_ie:
 
2530
                    yield fp[1:], c, fk, f_ie.file_id, f_ie
 
2531
                else:
 
2532
                    try:
 
2533
                        yield fp[1:], c, fk, None, fk_entries[fk]()
 
2534
                    except KeyError:
 
2535
                        yield fp[1:], c, fk, None, TreeEntry()
 
2536
                    continue
 
2537
 
 
2538
                if fk != 'directory':
 
2539
                    continue
 
2540
 
 
2541
                # But do this child first if recursing down
 
2542
                if recursive:
 
2543
                    new_children = os.listdir(fap)
 
2544
                    new_children.sort()
 
2545
                    new_children = collections.deque(new_children)
 
2546
                    stack.append((f_ie.file_id, fp, fap, new_children))
 
2547
                    # Break out of inner loop,
 
2548
                    # so that we start outer loop with child
 
2549
                    break
 
2550
            else:
 
2551
                # if we finished all children, pop it off the stack
 
2552
                stack.pop()
 
2553
 
 
2554
    @needs_tree_write_lock
 
2555
    def move(self, from_paths, to_dir=None, after=False):
 
2556
        """Rename files.
 
2557
 
 
2558
        to_dir must exist in the inventory.
 
2559
 
 
2560
        If to_dir exists and is a directory, the files are moved into
 
2561
        it, keeping their old names.
 
2562
 
 
2563
        Note that to_dir is only the last component of the new name;
 
2564
        this doesn't change the directory.
 
2565
 
 
2566
        For each entry in from_paths the move mode will be determined
 
2567
        independently.
 
2568
 
 
2569
        The first mode moves the file in the filesystem and updates the
 
2570
        inventory. The second mode only updates the inventory without
 
2571
        touching the file on the filesystem.
 
2572
 
 
2573
        move uses the second mode if 'after == True' and the target is not
 
2574
        versioned but present in the working tree.
 
2575
 
 
2576
        move uses the second mode if 'after == False' and the source is
 
2577
        versioned but no longer in the working tree, and the target is not
 
2578
        versioned but present in the working tree.
 
2579
 
 
2580
        move uses the first mode if 'after == False' and the source is
 
2581
        versioned and present in the working tree, and the target is not
 
2582
        versioned and not present in the working tree.
 
2583
 
 
2584
        Everything else results in an error.
 
2585
 
 
2586
        This returns a list of (from_path, to_path) pairs for each
 
2587
        entry that is moved.
 
2588
        """
 
2589
        rename_entries = []
 
2590
        rename_tuples = []
 
2591
 
 
2592
        # check for deprecated use of signature
 
2593
        if to_dir is None:
 
2594
            raise TypeError('You must supply a target directory')
 
2595
        # check destination directory
 
2596
        if isinstance(from_paths, basestring):
 
2597
            raise ValueError()
 
2598
        inv = self.inventory
 
2599
        to_abs = self.abspath(to_dir)
 
2600
        if not isdir(to_abs):
 
2601
            raise errors.BzrMoveFailedError('',to_dir,
 
2602
                errors.NotADirectory(to_abs))
 
2603
        if not self.has_filename(to_dir):
 
2604
            raise errors.BzrMoveFailedError('',to_dir,
 
2605
                errors.NotInWorkingDirectory(to_dir))
 
2606
        to_dir_id = inv.path2id(to_dir)
 
2607
        if to_dir_id is None:
 
2608
            raise errors.BzrMoveFailedError('',to_dir,
 
2609
                errors.NotVersionedError(path=to_dir))
 
2610
 
 
2611
        to_dir_ie = inv[to_dir_id]
 
2612
        if to_dir_ie.kind != 'directory':
 
2613
            raise errors.BzrMoveFailedError('',to_dir,
 
2614
                errors.NotADirectory(to_abs))
 
2615
 
 
2616
        # create rename entries and tuples
 
2617
        for from_rel in from_paths:
 
2618
            from_tail = splitpath(from_rel)[-1]
 
2619
            from_id = inv.path2id(from_rel)
 
2620
            if from_id is None:
 
2621
                raise errors.BzrMoveFailedError(from_rel,to_dir,
 
2622
                    errors.NotVersionedError(path=from_rel))
 
2623
 
 
2624
            from_entry = inv[from_id]
 
2625
            from_parent_id = from_entry.parent_id
 
2626
            to_rel = pathjoin(to_dir, from_tail)
 
2627
            rename_entry = InventoryWorkingTree._RenameEntry(
 
2628
                from_rel=from_rel,
 
2629
                from_id=from_id,
 
2630
                from_tail=from_tail,
 
2631
                from_parent_id=from_parent_id,
 
2632
                to_rel=to_rel, to_tail=from_tail,
 
2633
                to_parent_id=to_dir_id)
 
2634
            rename_entries.append(rename_entry)
 
2635
            rename_tuples.append((from_rel, to_rel))
 
2636
 
 
2637
        # determine which move mode to use. checks also for movability
 
2638
        rename_entries = self._determine_mv_mode(rename_entries, after)
 
2639
 
 
2640
        original_modified = self._inventory_is_modified
 
2641
        try:
 
2642
            if len(from_paths):
 
2643
                self._inventory_is_modified = True
 
2644
            self._move(rename_entries)
 
2645
        except:
 
2646
            # restore the inventory on error
 
2647
            self._inventory_is_modified = original_modified
 
2648
            raise
 
2649
        self._write_inventory(inv)
 
2650
        return rename_tuples
 
2651
 
 
2652
    @needs_tree_write_lock
 
2653
    def rename_one(self, from_rel, to_rel, after=False):
 
2654
        """Rename one file.
 
2655
 
 
2656
        This can change the directory or the filename or both.
 
2657
 
 
2658
        rename_one has several 'modes' to work. First, it can rename a physical
 
2659
        file and change the file_id. That is the normal mode. Second, it can
 
2660
        only change the file_id without touching any physical file.
 
2661
 
 
2662
        rename_one uses the second mode if 'after == True' and 'to_rel' is not
 
2663
        versioned but present in the working tree.
 
2664
 
 
2665
        rename_one uses the second mode if 'after == False' and 'from_rel' is
 
2666
        versioned but no longer in the working tree, and 'to_rel' is not
 
2667
        versioned but present in the working tree.
 
2668
 
 
2669
        rename_one uses the first mode if 'after == False' and 'from_rel' is
 
2670
        versioned and present in the working tree, and 'to_rel' is not
 
2671
        versioned and not present in the working tree.
 
2672
 
 
2673
        Everything else results in an error.
 
2674
        """
 
2675
        inv = self.inventory
 
2676
        rename_entries = []
 
2677
 
 
2678
        # create rename entries and tuples
 
2679
        from_tail = splitpath(from_rel)[-1]
 
2680
        from_id = inv.path2id(from_rel)
 
2681
        if from_id is None:
 
2682
            # if file is missing in the inventory maybe it's in the basis_tree
 
2683
            basis_tree = self.branch.basis_tree()
 
2684
            from_id = basis_tree.path2id(from_rel)
 
2685
            if from_id is None:
 
2686
                raise errors.BzrRenameFailedError(from_rel,to_rel,
 
2687
                    errors.NotVersionedError(path=from_rel))
 
2688
            # put entry back in the inventory so we can rename it
 
2689
            from_entry = basis_tree.inventory[from_id].copy()
 
2690
            inv.add(from_entry)
 
2691
        else:
 
2692
            from_entry = inv[from_id]
 
2693
        from_parent_id = from_entry.parent_id
 
2694
        to_dir, to_tail = os.path.split(to_rel)
 
2695
        to_dir_id = inv.path2id(to_dir)
 
2696
        rename_entry = InventoryWorkingTree._RenameEntry(from_rel=from_rel,
 
2697
                                     from_id=from_id,
 
2698
                                     from_tail=from_tail,
 
2699
                                     from_parent_id=from_parent_id,
 
2700
                                     to_rel=to_rel, to_tail=to_tail,
 
2701
                                     to_parent_id=to_dir_id)
 
2702
        rename_entries.append(rename_entry)
 
2703
 
 
2704
        # determine which move mode to use. checks also for movability
 
2705
        rename_entries = self._determine_mv_mode(rename_entries, after)
 
2706
 
 
2707
        # check if the target changed directory and if the target directory is
 
2708
        # versioned
 
2709
        if to_dir_id is None:
 
2710
            raise errors.BzrMoveFailedError(from_rel,to_rel,
 
2711
                errors.NotVersionedError(path=to_dir))
 
2712
 
 
2713
        # all checks done. now we can continue with our actual work
 
2714
        mutter('rename_one:\n'
 
2715
               '  from_id   {%s}\n'
 
2716
               '  from_rel: %r\n'
 
2717
               '  to_rel:   %r\n'
 
2718
               '  to_dir    %r\n'
 
2719
               '  to_dir_id {%s}\n',
 
2720
               from_id, from_rel, to_rel, to_dir, to_dir_id)
 
2721
 
 
2722
        self._move(rename_entries)
 
2723
        self._write_inventory(inv)
 
2724
 
 
2725
    class _RenameEntry(object):
 
2726
        def __init__(self, from_rel, from_id, from_tail, from_parent_id,
 
2727
                     to_rel, to_tail, to_parent_id, only_change_inv=False):
 
2728
            self.from_rel = from_rel
 
2729
            self.from_id = from_id
 
2730
            self.from_tail = from_tail
 
2731
            self.from_parent_id = from_parent_id
 
2732
            self.to_rel = to_rel
 
2733
            self.to_tail = to_tail
 
2734
            self.to_parent_id = to_parent_id
 
2735
            self.only_change_inv = only_change_inv
 
2736
 
 
2737
    def _determine_mv_mode(self, rename_entries, after=False):
 
2738
        """Determines for each from-to pair if both inventory and working tree
 
2739
        or only the inventory has to be changed.
 
2740
 
 
2741
        Also does basic plausability tests.
 
2742
        """
 
2743
        inv = self.inventory
 
2744
 
 
2745
        for rename_entry in rename_entries:
 
2746
            # store to local variables for easier reference
 
2747
            from_rel = rename_entry.from_rel
 
2748
            from_id = rename_entry.from_id
 
2749
            to_rel = rename_entry.to_rel
 
2750
            to_id = inv.path2id(to_rel)
 
2751
            only_change_inv = False
 
2752
 
 
2753
            # check the inventory for source and destination
 
2754
            if from_id is None:
 
2755
                raise errors.BzrMoveFailedError(from_rel,to_rel,
 
2756
                    errors.NotVersionedError(path=from_rel))
 
2757
            if to_id is not None:
 
2758
                raise errors.BzrMoveFailedError(from_rel,to_rel,
 
2759
                    errors.AlreadyVersionedError(path=to_rel))
 
2760
 
 
2761
            # try to determine the mode for rename (only change inv or change
 
2762
            # inv and file system)
 
2763
            if after:
 
2764
                if not self.has_filename(to_rel):
 
2765
                    raise errors.BzrMoveFailedError(from_id,to_rel,
 
2766
                        errors.NoSuchFile(path=to_rel,
 
2767
                        extra="New file has not been created yet"))
 
2768
                only_change_inv = True
 
2769
            elif not self.has_filename(from_rel) and self.has_filename(to_rel):
 
2770
                only_change_inv = True
 
2771
            elif self.has_filename(from_rel) and not self.has_filename(to_rel):
 
2772
                only_change_inv = False
 
2773
            elif (not self.case_sensitive
 
2774
                  and from_rel.lower() == to_rel.lower()
 
2775
                  and self.has_filename(from_rel)):
 
2776
                only_change_inv = False
 
2777
            else:
 
2778
                # something is wrong, so lets determine what exactly
 
2779
                if not self.has_filename(from_rel) and \
 
2780
                   not self.has_filename(to_rel):
 
2781
                    raise errors.BzrRenameFailedError(from_rel,to_rel,
 
2782
                        errors.PathsDoNotExist(paths=(str(from_rel),
 
2783
                        str(to_rel))))
 
2784
                else:
 
2785
                    raise errors.RenameFailedFilesExist(from_rel, to_rel)
 
2786
            rename_entry.only_change_inv = only_change_inv
 
2787
        return rename_entries
 
2788
 
 
2789
    def _move(self, rename_entries):
 
2790
        """Moves a list of files.
 
2791
 
 
2792
        Depending on the value of the flag 'only_change_inv', the
 
2793
        file will be moved on the file system or not.
 
2794
        """
 
2795
        inv = self.inventory
 
2796
        moved = []
 
2797
 
 
2798
        for entry in rename_entries:
 
2799
            try:
 
2800
                self._move_entry(entry)
 
2801
            except:
 
2802
                self._rollback_move(moved)
 
2803
                raise
 
2804
            moved.append(entry)
 
2805
 
 
2806
    def _rollback_move(self, moved):
 
2807
        """Try to rollback a previous move in case of an filesystem error."""
 
2808
        inv = self.inventory
 
2809
        for entry in moved:
 
2810
            try:
 
2811
                self._move_entry(WorkingTree._RenameEntry(
 
2812
                    entry.to_rel, entry.from_id,
 
2813
                    entry.to_tail, entry.to_parent_id, entry.from_rel,
 
2814
                    entry.from_tail, entry.from_parent_id,
 
2815
                    entry.only_change_inv))
 
2816
            except errors.BzrMoveFailedError, e:
 
2817
                raise errors.BzrMoveFailedError( '', '', "Rollback failed."
 
2818
                        " The working tree is in an inconsistent state."
 
2819
                        " Please consider doing a 'bzr revert'."
 
2820
                        " Error message is: %s" % e)
 
2821
 
 
2822
    def _move_entry(self, entry):
 
2823
        inv = self.inventory
 
2824
        from_rel_abs = self.abspath(entry.from_rel)
 
2825
        to_rel_abs = self.abspath(entry.to_rel)
 
2826
        if from_rel_abs == to_rel_abs:
 
2827
            raise errors.BzrMoveFailedError(entry.from_rel, entry.to_rel,
 
2828
                "Source and target are identical.")
 
2829
 
 
2830
        if not entry.only_change_inv:
 
2831
            try:
 
2832
                osutils.rename(from_rel_abs, to_rel_abs)
 
2833
            except OSError, e:
 
2834
                raise errors.BzrMoveFailedError(entry.from_rel,
 
2835
                    entry.to_rel, e[1])
 
2836
        inv.rename(entry.from_id, entry.to_parent_id, entry.to_tail)
 
2837
 
 
2838
    @needs_tree_write_lock
 
2839
    def unversion(self, file_ids):
 
2840
        """Remove the file ids in file_ids from the current versioned set.
 
2841
 
 
2842
        When a file_id is unversioned, all of its children are automatically
 
2843
        unversioned.
 
2844
 
 
2845
        :param file_ids: The file ids to stop versioning.
 
2846
        :raises: NoSuchId if any fileid is not currently versioned.
 
2847
        """
 
2848
        for file_id in file_ids:
 
2849
            if file_id not in self._inventory:
 
2850
                raise errors.NoSuchId(self, file_id)
 
2851
        for file_id in file_ids:
 
2852
            if self._inventory.has_id(file_id):
 
2853
                self._inventory.remove_recursive_id(file_id)
 
2854
        if len(file_ids):
 
2855
            # in the future this should just set a dirty bit to wait for the
 
2856
            # final unlock. However, until all methods of workingtree start
 
2857
            # with the current in -memory inventory rather than triggering
 
2858
            # a read, it is more complex - we need to teach read_inventory
 
2859
            # to know when to read, and when to not read first... and possibly
 
2860
            # to save first when the in memory one may be corrupted.
 
2861
            # so for now, we just only write it if it is indeed dirty.
 
2862
            # - RBC 20060907
 
2863
            self._write_inventory(self._inventory)
 
2864
 
 
2865
    def stored_kind(self, file_id):
 
2866
        """See Tree.stored_kind"""
 
2867
        return self.inventory[file_id].kind
 
2868
 
 
2869
    def extras(self):
 
2870
        """Yield all unversioned files in this WorkingTree.
 
2871
 
 
2872
        If there are any unversioned directories then only the directory is
 
2873
        returned, not all its children.  But if there are unversioned files
 
2874
        under a versioned subdirectory, they are returned.
 
2875
 
 
2876
        Currently returned depth-first, sorted by name within directories.
 
2877
        This is the same order used by 'osutils.walkdirs'.
 
2878
        """
 
2879
        ## TODO: Work from given directory downwards
 
2880
        for path, dir_entry in self.inventory.directories():
 
2881
            # mutter("search for unknowns in %r", path)
 
2882
            dirabs = self.abspath(path)
 
2883
            if not isdir(dirabs):
 
2884
                # e.g. directory deleted
 
2885
                continue
 
2886
 
 
2887
            fl = []
 
2888
            for subf in os.listdir(dirabs):
 
2889
                if self.bzrdir.is_control_filename(subf):
 
2890
                    continue
 
2891
                if subf not in dir_entry.children:
 
2892
                    try:
 
2893
                        (subf_norm,
 
2894
                         can_access) = osutils.normalized_filename(subf)
 
2895
                    except UnicodeDecodeError:
 
2896
                        path_os_enc = path.encode(osutils._fs_enc)
 
2897
                        relpath = path_os_enc + '/' + subf
 
2898
                        raise errors.BadFilenameEncoding(relpath,
 
2899
                                                         osutils._fs_enc)
 
2900
                    if subf_norm != subf and can_access:
 
2901
                        if subf_norm not in dir_entry.children:
 
2902
                            fl.append(subf_norm)
 
2903
                    else:
 
2904
                        fl.append(subf)
 
2905
 
 
2906
            fl.sort()
 
2907
            for subf in fl:
 
2908
                subp = pathjoin(path, subf)
 
2909
                yield subp
 
2910
 
 
2911
    def _walkdirs(self, prefix=""):
 
2912
        """Walk the directories of this tree.
 
2913
 
 
2914
           :prefix: is used as the directrory to start with.
 
2915
           returns a generator which yields items in the form:
 
2916
                ((curren_directory_path, fileid),
 
2917
                 [(file1_path, file1_name, file1_kind, None, file1_id,
 
2918
                   file1_kind), ... ])
 
2919
        """
 
2920
        _directory = 'directory'
 
2921
        # get the root in the inventory
 
2922
        inv = self.inventory
 
2923
        top_id = inv.path2id(prefix)
 
2924
        if top_id is None:
 
2925
            pending = []
 
2926
        else:
 
2927
            pending = [(prefix, '', _directory, None, top_id, None)]
 
2928
        while pending:
 
2929
            dirblock = []
 
2930
            currentdir = pending.pop()
 
2931
            # 0 - relpath, 1- basename, 2- kind, 3- stat, 4-id, 5-kind
 
2932
            top_id = currentdir[4]
 
2933
            if currentdir[0]:
 
2934
                relroot = currentdir[0] + '/'
 
2935
            else:
 
2936
                relroot = ""
 
2937
            # FIXME: stash the node in pending
 
2938
            entry = inv[top_id]
 
2939
            if entry.kind == 'directory':
 
2940
                for name, child in entry.sorted_children():
 
2941
                    dirblock.append((relroot + name, name, child.kind, None,
 
2942
                        child.file_id, child.kind
 
2943
                        ))
 
2944
            yield (currentdir[0], entry.file_id), dirblock
 
2945
            # push the user specified dirs from dirblock
 
2946
            for dir in reversed(dirblock):
 
2947
                if dir[2] == _directory:
 
2948
                    pending.append(dir)
 
2949
 
 
2950
 
 
2951
class WorkingTreeFormatRegistry(controldir.ControlComponentFormatRegistry):
 
2952
    """Registry for working tree formats."""
 
2953
 
 
2954
    def __init__(self, other_registry=None):
 
2955
        super(WorkingTreeFormatRegistry, self).__init__(other_registry)
 
2956
        self._default_format = None
 
2957
        self._default_format_key = None
 
2958
 
 
2959
    def get_default(self):
 
2960
        """Return the current default format."""
 
2961
        if (self._default_format_key is not None and
 
2962
            self._default_format is None):
 
2963
            self._default_format = self.get(self._default_format_key)
 
2964
        return self._default_format
 
2965
 
 
2966
    def set_default(self, format):
 
2967
        """Set the default format."""
 
2968
        self._default_format = format
 
2969
        self._default_format_key = None
 
2970
 
 
2971
    def set_default_key(self, format_string):
 
2972
        """Set the default format by its format string."""
 
2973
        self._default_format_key = format_string
 
2974
        self._default_format = None
 
2975
 
 
2976
 
 
2977
format_registry = WorkingTreeFormatRegistry()
 
2978
 
 
2979
 
 
2980
class WorkingTreeFormat(controldir.ControlComponentFormat):
2831
2981
    """An encapsulation of the initialization and open routines for a format.
2832
2982
 
2833
2983
    Formats provide three things:
2845
2995
    object will be created every time regardless.
2846
2996
    """
2847
2997
 
2848
 
    _default_format = None
2849
 
    """The default format used for new trees."""
2850
 
 
2851
 
    _formats = {}
2852
 
    """The known formats."""
2853
 
 
2854
2998
    requires_rich_root = False
2855
2999
 
2856
3000
    upgrade_recommended = False
2857
3001
 
 
3002
    requires_normalized_unicode_filenames = False
 
3003
 
 
3004
    case_sensitive_filename = "FoRMaT"
 
3005
 
 
3006
    missing_parent_conflicts = False
 
3007
    """If this format supports missing parent conflicts."""
 
3008
 
 
3009
    @classmethod
 
3010
    def find_format_string(klass, a_bzrdir):
 
3011
        """Return format name for the working tree object in a_bzrdir."""
 
3012
        try:
 
3013
            transport = a_bzrdir.get_workingtree_transport(None)
 
3014
            return transport.get_bytes("format")
 
3015
        except errors.NoSuchFile:
 
3016
            raise errors.NoWorkingTree(base=transport.base)
 
3017
 
2858
3018
    @classmethod
2859
3019
    def find_format(klass, a_bzrdir):
2860
3020
        """Return the format for the working tree object in a_bzrdir."""
2861
3021
        try:
2862
 
            transport = a_bzrdir.get_workingtree_transport(None)
2863
 
            format_string = transport.get_bytes("format")
2864
 
            return klass._formats[format_string]
2865
 
        except errors.NoSuchFile:
2866
 
            raise errors.NoWorkingTree(base=transport.base)
 
3022
            format_string = klass.find_format_string(a_bzrdir)
 
3023
            return format_registry.get(format_string)
2867
3024
        except KeyError:
2868
3025
            raise errors.UnknownFormatError(format=format_string,
2869
3026
                                            kind="working tree")
2870
3027
 
 
3028
    def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
 
3029
                   accelerator_tree=None, hardlink=False):
 
3030
        """Initialize a new working tree in a_bzrdir.
 
3031
 
 
3032
        :param a_bzrdir: BzrDir to initialize the working tree in.
 
3033
        :param revision_id: allows creating a working tree at a different
 
3034
            revision than the branch is at.
 
3035
        :param from_branch: Branch to checkout
 
3036
        :param accelerator_tree: A tree which can be used for retrieving file
 
3037
            contents more quickly than the revision tree, i.e. a workingtree.
 
3038
            The revision tree will be used for cases where accelerator_tree's
 
3039
            content is different.
 
3040
        :param hardlink: If true, hard-link files from accelerator_tree,
 
3041
            where possible.
 
3042
        """
 
3043
        raise NotImplementedError(self.initialize)
 
3044
 
2871
3045
    def __eq__(self, other):
2872
3046
        return self.__class__ is other.__class__
2873
3047
 
2875
3049
        return not (self == other)
2876
3050
 
2877
3051
    @classmethod
 
3052
    @symbol_versioning.deprecated_method(
 
3053
        symbol_versioning.deprecated_in((2, 4, 0)))
2878
3054
    def get_default_format(klass):
2879
3055
        """Return the current default format."""
2880
 
        return klass._default_format
 
3056
        return format_registry.get_default()
2881
3057
 
2882
3058
    def get_format_string(self):
2883
3059
        """Return the ASCII format string that identifies this format."""
2905
3081
        return False
2906
3082
 
2907
3083
    @classmethod
 
3084
    @symbol_versioning.deprecated_method(
 
3085
        symbol_versioning.deprecated_in((2, 4, 0)))
2908
3086
    def register_format(klass, format):
2909
 
        klass._formats[format.get_format_string()] = format
2910
 
 
2911
 
    @classmethod
 
3087
        format_registry.register(format)
 
3088
 
 
3089
    @classmethod
 
3090
    @symbol_versioning.deprecated_method(
 
3091
        symbol_versioning.deprecated_in((2, 4, 0)))
 
3092
    def register_extra_format(klass, format):
 
3093
        format_registry.register_extra(format)
 
3094
 
 
3095
    @classmethod
 
3096
    @symbol_versioning.deprecated_method(
 
3097
        symbol_versioning.deprecated_in((2, 4, 0)))
 
3098
    def unregister_extra_format(klass, format):
 
3099
        format_registry.unregister_extra(format)
 
3100
 
 
3101
    @classmethod
 
3102
    @symbol_versioning.deprecated_method(
 
3103
        symbol_versioning.deprecated_in((2, 4, 0)))
 
3104
    def get_formats(klass):
 
3105
        return format_registry._get_all()
 
3106
 
 
3107
    @classmethod
 
3108
    @symbol_versioning.deprecated_method(
 
3109
        symbol_versioning.deprecated_in((2, 4, 0)))
2912
3110
    def set_default_format(klass, format):
2913
 
        klass._default_format = format
 
3111
        format_registry.set_default(format)
2914
3112
 
2915
3113
    @classmethod
 
3114
    @symbol_versioning.deprecated_method(
 
3115
        symbol_versioning.deprecated_in((2, 4, 0)))
2916
3116
    def unregister_format(klass, format):
2917
 
        del klass._formats[format.get_format_string()]
2918
 
 
2919
 
 
2920
 
class WorkingTreeFormat2(WorkingTreeFormat):
2921
 
    """The second working tree format.
2922
 
 
2923
 
    This format modified the hash cache from the format 1 hash cache.
2924
 
    """
2925
 
 
2926
 
    upgrade_recommended = True
2927
 
 
2928
 
    def get_format_description(self):
2929
 
        """See WorkingTreeFormat.get_format_description()."""
2930
 
        return "Working tree format 2"
2931
 
 
2932
 
    def _stub_initialize_on_transport(self, transport, file_mode):
2933
 
        """Workaround: create control files for a remote working tree.
2934
 
 
2935
 
        This ensures that it can later be updated and dealt with locally,
2936
 
        since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
2937
 
        no working tree.  (See bug #43064).
2938
 
        """
2939
 
        sio = StringIO()
2940
 
        inv = inventory.Inventory()
2941
 
        xml5.serializer_v5.write_inventory(inv, sio, working=True)
2942
 
        sio.seek(0)
2943
 
        transport.put_file('inventory', sio, file_mode)
2944
 
        transport.put_bytes('pending-merges', '', file_mode)
2945
 
 
2946
 
    def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
2947
 
                   accelerator_tree=None, hardlink=False):
2948
 
        """See WorkingTreeFormat.initialize()."""
2949
 
        if not isinstance(a_bzrdir.transport, LocalTransport):
2950
 
            raise errors.NotLocalUrl(a_bzrdir.transport.base)
2951
 
        if from_branch is not None:
2952
 
            branch = from_branch
2953
 
        else:
2954
 
            branch = a_bzrdir.open_branch()
2955
 
        if revision_id is None:
2956
 
            revision_id = _mod_revision.ensure_null(branch.last_revision())
2957
 
        branch.lock_write()
2958
 
        try:
2959
 
            branch.generate_revision_history(revision_id)
2960
 
        finally:
2961
 
            branch.unlock()
2962
 
        inv = inventory.Inventory()
2963
 
        wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2964
 
                         branch,
2965
 
                         inv,
2966
 
                         _internal=True,
2967
 
                         _format=self,
2968
 
                         _bzrdir=a_bzrdir)
2969
 
        basis_tree = branch.repository.revision_tree(revision_id)
2970
 
        if basis_tree.inventory.root is not None:
2971
 
            wt.set_root_id(basis_tree.get_root_id())
2972
 
        # set the parent list and cache the basis tree.
2973
 
        if _mod_revision.is_null(revision_id):
2974
 
            parent_trees = []
2975
 
        else:
2976
 
            parent_trees = [(revision_id, basis_tree)]
2977
 
        wt.set_parent_trees(parent_trees)
2978
 
        transform.build_tree(basis_tree, wt)
2979
 
        return wt
2980
 
 
2981
 
    def __init__(self):
2982
 
        super(WorkingTreeFormat2, self).__init__()
2983
 
        self._matchingbzrdir = bzrdir.BzrDirFormat6()
2984
 
 
2985
 
    def open(self, a_bzrdir, _found=False):
2986
 
        """Return the WorkingTree object for a_bzrdir
2987
 
 
2988
 
        _found is a private parameter, do not use it. It is used to indicate
2989
 
               if format probing has already been done.
2990
 
        """
2991
 
        if not _found:
2992
 
            # we are being called directly and must probe.
2993
 
            raise NotImplementedError
2994
 
        if not isinstance(a_bzrdir.transport, LocalTransport):
2995
 
            raise errors.NotLocalUrl(a_bzrdir.transport.base)
2996
 
        wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2997
 
                           _internal=True,
2998
 
                           _format=self,
2999
 
                           _bzrdir=a_bzrdir)
3000
 
        return wt
3001
 
 
3002
 
class WorkingTreeFormat3(WorkingTreeFormat):
3003
 
    """The second working tree format updated to record a format marker.
3004
 
 
3005
 
    This format:
3006
 
        - exists within a metadir controlling .bzr
3007
 
        - includes an explicit version marker for the workingtree control
3008
 
          files, separate from the BzrDir format
3009
 
        - modifies the hash cache format
3010
 
        - is new in bzr 0.8
3011
 
        - uses a LockDir to guard access for writes.
3012
 
    """
3013
 
 
3014
 
    upgrade_recommended = True
3015
 
 
3016
 
    def get_format_string(self):
3017
 
        """See WorkingTreeFormat.get_format_string()."""
3018
 
        return "Bazaar-NG Working Tree format 3"
3019
 
 
3020
 
    def get_format_description(self):
3021
 
        """See WorkingTreeFormat.get_format_description()."""
3022
 
        return "Working tree format 3"
3023
 
 
3024
 
    _lock_file_name = 'lock'
3025
 
    _lock_class = LockDir
3026
 
 
3027
 
    _tree_class = WorkingTree3
3028
 
 
3029
 
    def __get_matchingbzrdir(self):
3030
 
        return bzrdir.BzrDirMetaFormat1()
3031
 
 
3032
 
    _matchingbzrdir = property(__get_matchingbzrdir)
3033
 
 
3034
 
    def _open_control_files(self, a_bzrdir):
3035
 
        transport = a_bzrdir.get_workingtree_transport(None)
3036
 
        return LockableFiles(transport, self._lock_file_name,
3037
 
                             self._lock_class)
3038
 
 
3039
 
    def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
3040
 
                   accelerator_tree=None, hardlink=False):
3041
 
        """See WorkingTreeFormat.initialize().
3042
 
 
3043
 
        :param revision_id: if supplied, create a working tree at a different
3044
 
            revision than the branch is at.
3045
 
        :param accelerator_tree: A tree which can be used for retrieving file
3046
 
            contents more quickly than the revision tree, i.e. a workingtree.
3047
 
            The revision tree will be used for cases where accelerator_tree's
3048
 
            content is different.
3049
 
        :param hardlink: If true, hard-link files from accelerator_tree,
3050
 
            where possible.
3051
 
        """
3052
 
        if not isinstance(a_bzrdir.transport, LocalTransport):
3053
 
            raise errors.NotLocalUrl(a_bzrdir.transport.base)
3054
 
        transport = a_bzrdir.get_workingtree_transport(self)
3055
 
        control_files = self._open_control_files(a_bzrdir)
3056
 
        control_files.create_lock()
3057
 
        control_files.lock_write()
3058
 
        transport.put_bytes('format', self.get_format_string(),
3059
 
            mode=a_bzrdir._get_file_mode())
3060
 
        if from_branch is not None:
3061
 
            branch = from_branch
3062
 
        else:
3063
 
            branch = a_bzrdir.open_branch()
3064
 
        if revision_id is None:
3065
 
            revision_id = _mod_revision.ensure_null(branch.last_revision())
3066
 
        # WorkingTree3 can handle an inventory which has a unique root id.
3067
 
        # as of bzr 0.12. However, bzr 0.11 and earlier fail to handle
3068
 
        # those trees. And because there isn't a format bump inbetween, we
3069
 
        # are maintaining compatibility with older clients.
3070
 
        # inv = Inventory(root_id=gen_root_id())
3071
 
        inv = self._initial_inventory()
3072
 
        wt = self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
3073
 
                         branch,
3074
 
                         inv,
3075
 
                         _internal=True,
3076
 
                         _format=self,
3077
 
                         _bzrdir=a_bzrdir,
3078
 
                         _control_files=control_files)
3079
 
        wt.lock_tree_write()
3080
 
        try:
3081
 
            basis_tree = branch.repository.revision_tree(revision_id)
3082
 
            # only set an explicit root id if there is one to set.
3083
 
            if basis_tree.inventory.root is not None:
3084
 
                wt.set_root_id(basis_tree.get_root_id())
3085
 
            if revision_id == _mod_revision.NULL_REVISION:
3086
 
                wt.set_parent_trees([])
3087
 
            else:
3088
 
                wt.set_parent_trees([(revision_id, basis_tree)])
3089
 
            transform.build_tree(basis_tree, wt)
3090
 
        finally:
3091
 
            # Unlock in this order so that the unlock-triggers-flush in
3092
 
            # WorkingTree is given a chance to fire.
3093
 
            control_files.unlock()
3094
 
            wt.unlock()
3095
 
        return wt
3096
 
 
3097
 
    def _initial_inventory(self):
3098
 
        return inventory.Inventory()
3099
 
 
3100
 
    def __init__(self):
3101
 
        super(WorkingTreeFormat3, self).__init__()
3102
 
 
3103
 
    def open(self, a_bzrdir, _found=False):
3104
 
        """Return the WorkingTree object for a_bzrdir
3105
 
 
3106
 
        _found is a private parameter, do not use it. It is used to indicate
3107
 
               if format probing has already been done.
3108
 
        """
3109
 
        if not _found:
3110
 
            # we are being called directly and must probe.
3111
 
            raise NotImplementedError
3112
 
        if not isinstance(a_bzrdir.transport, LocalTransport):
3113
 
            raise errors.NotLocalUrl(a_bzrdir.transport.base)
3114
 
        wt = self._open(a_bzrdir, self._open_control_files(a_bzrdir))
3115
 
        return wt
3116
 
 
3117
 
    def _open(self, a_bzrdir, control_files):
3118
 
        """Open the tree itself.
3119
 
 
3120
 
        :param a_bzrdir: the dir for the tree.
3121
 
        :param control_files: the control files for the tree.
3122
 
        """
3123
 
        return self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
3124
 
                                _internal=True,
3125
 
                                _format=self,
3126
 
                                _bzrdir=a_bzrdir,
3127
 
                                _control_files=control_files)
3128
 
 
3129
 
    def __str__(self):
3130
 
        return self.get_format_string()
3131
 
 
3132
 
 
3133
 
__default_format = WorkingTreeFormat6()
3134
 
WorkingTreeFormat.register_format(__default_format)
3135
 
WorkingTreeFormat.register_format(WorkingTreeFormat5())
3136
 
WorkingTreeFormat.register_format(WorkingTreeFormat4())
3137
 
WorkingTreeFormat.register_format(WorkingTreeFormat3())
3138
 
WorkingTreeFormat.set_default_format(__default_format)
3139
 
# formats which have no format string are not discoverable
3140
 
# and not independently creatable, so are not registered.
3141
 
_legacy_formats = [WorkingTreeFormat2(),
3142
 
                   ]
 
3117
        format_registry.remove(format)
 
3118
 
 
3119
 
 
3120
format_registry.register_lazy("Bazaar Working Tree Format 4 (bzr 0.15)\n",
 
3121
    "bzrlib.workingtree_4", "WorkingTreeFormat4")
 
3122
format_registry.register_lazy("Bazaar Working Tree Format 5 (bzr 1.11)\n",
 
3123
    "bzrlib.workingtree_4", "WorkingTreeFormat5")
 
3124
format_registry.register_lazy("Bazaar Working Tree Format 6 (bzr 1.14)\n",
 
3125
    "bzrlib.workingtree_4", "WorkingTreeFormat6")
 
3126
format_registry.register_lazy("Bazaar-NG Working Tree format 3",
 
3127
    "bzrlib.workingtree_3", "WorkingTreeFormat3")
 
3128
format_registry.set_default_key("Bazaar Working Tree Format 6 (bzr 1.14)\n")