~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/workingtree.py

  • Committer: Vincent Ladeuil
  • Date: 2010-10-07 06:08:01 UTC
  • mto: This revision was merged to the branch mainline in revision 5491.
  • Revision ID: v.ladeuil+lp@free.fr-20101007060801-wfdhizfhfmctl8qa
Fix some typos and propose a release planning.

Show diffs side-by-side

added added

removed removed

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