/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/workingtree.py

  • Committer: Jelmer Vernooij
  • Date: 2011-05-09 13:55:20 UTC
  • mto: This revision was merged to the branch mainline in revision 5843.
  • Revision ID: jelmer@samba.org-20110509135520-8r5rgkjd30iunztg
Fix two warnings.

Show diffs side-by-side

added added

removed removed

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