~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/workingtree.py

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

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

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005-2010 Canonical Ltd
 
1
# Copyright (C) 2005-2011 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
44
44
import stat
45
45
import re
46
46
 
47
 
import bzrlib
48
47
from bzrlib import (
49
48
    branch,
50
49
    bzrdir,
51
50
    conflicts as _mod_conflicts,
 
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
 
575
    def _check_for_tree_references(self, iterator):
 
576
        """See if directories have become tree-references."""
 
577
        blocked_parent_ids = set()
 
578
        for path, ie in iterator:
 
579
            if ie.parent_id in blocked_parent_ids:
 
580
                # This entry was pruned because one of its parents became a
 
581
                # TreeReference. If this is a directory, mark it as blocked.
 
582
                if ie.kind == 'directory':
 
583
                    blocked_parent_ids.add(ie.file_id)
 
584
                continue
 
585
            if ie.kind == 'directory' and self._directory_is_tree_reference(path):
 
586
                # This InventoryDirectory needs to be a TreeReference
 
587
                ie = inventory.TreeReference(ie.file_id, ie.name, ie.parent_id)
 
588
                blocked_parent_ids.add(ie.file_id)
 
589
            yield path, ie
 
590
 
 
591
    def iter_entries_by_dir(self, specific_file_ids=None, yield_parents=False):
 
592
        """See Tree.iter_entries_by_dir()"""
 
593
        # The only trick here is that if we supports_tree_reference then we
 
594
        # need to detect if a directory becomes a tree-reference.
 
595
        iterator = super(WorkingTree, self).iter_entries_by_dir(
 
596
                specific_file_ids=specific_file_ids,
 
597
                yield_parents=yield_parents)
 
598
        if not self.supports_tree_reference():
 
599
            return iterator
 
600
        else:
 
601
            return self._check_for_tree_references(iterator)
617
602
 
618
603
    def get_file_size(self, file_id):
619
604
        """See Tree.get_file_size"""
627
612
            else:
628
613
                return None
629
614
 
630
 
    @needs_read_lock
631
615
    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
 
616
        # FIXME: Shouldn't this be in Tree?
 
617
        raise NotImplementedError(self.get_file_sha1)
683
618
 
684
619
    @needs_tree_write_lock
685
620
    def _gather_kinds(self, files, kinds):
811
746
            if revision_id in heads and revision_id not in new_revision_ids:
812
747
                new_revision_ids.append(revision_id)
813
748
        if new_revision_ids != revision_ids:
814
 
            trace.mutter('requested to set revision_ids = %s,'
 
749
            mutter('requested to set revision_ids = %s,'
815
750
                         ' but filtered to %s', revision_ids, new_revision_ids)
816
751
        return new_revision_ids
817
752
 
843
778
        self._set_merges_from_parent_ids(revision_ids)
844
779
 
845
780
    @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
781
    def set_pending_merges(self, rev_list):
877
782
        parents = self.get_parent_ids()
878
783
        leftmost = parents[:1]
883
788
    def set_merge_modified(self, modified_hashes):
884
789
        def iter_stanzas():
885
790
            for file_id, hash in modified_hashes.iteritems():
886
 
                yield Stanza(file_id=file_id.decode('utf8'), hash=hash)
 
791
                yield _mod_rio.Stanza(file_id=file_id.decode('utf8'),
 
792
                    hash=hash)
887
793
        self._put_rio('merge-hashes', iter_stanzas(), MERGE_MODIFIED_HEADER_1)
888
794
 
889
795
    def _sha_from_stat(self, path, stat_result):
898
804
 
899
805
    def _put_rio(self, filename, stanzas, header):
900
806
        self._must_be_locked()
901
 
        my_file = rio_file(stanzas, header)
 
807
        my_file = _mod_rio.rio_file(stanzas, header)
902
808
        self._transport.put_file(filename, my_file,
903
809
            mode=self.bzrdir._get_file_mode())
904
810
 
946
852
        merger.set_pending()
947
853
        return conflicts
948
854
 
949
 
    @needs_read_lock
950
855
    def merge_modified(self):
951
856
        """Return a dictionary of files modified by a merge.
952
857
 
957
862
        This returns a map of file_id->sha1, containing only files which are
958
863
        still in the working inventory and have that text hash.
959
864
        """
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()
 
865
        raise NotImplementedError(self.merge_modified)
982
866
 
983
867
    @needs_write_lock
984
868
    def mkdir(self, path, file_id=None):
994
878
        target = osutils.readlink(abspath)
995
879
        return target
996
880
 
997
 
    @needs_write_lock
998
881
    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()
 
882
        raise NotImplementedError(self.subsume)
1038
883
 
1039
884
    def _setup_directory_is_tree_reference(self):
1040
885
        if self._branch.repository._format.supports_tree_reference:
1062
907
        # checkout in a subdirectory.  This can be avoided by not adding
1063
908
        # it.  mbp 20070306
1064
909
 
1065
 
    @needs_tree_write_lock
1066
910
    def extract(self, file_id, format=None):
1067
911
        """Extract a subtree from this tree.
1068
912
 
1069
913
        A new branch will be created, relative to the path for this tree.
1070
914
        """
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)
 
915
        raise NotImplementedError(self.extract)
1121
916
 
1122
917
    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
 
918
        """Write the in memory meta data to disk."""
 
919
        raise NotImplementedError(self.flush)
1133
920
 
1134
921
    def _kind(self, relpath):
1135
922
        return osutils.file_kind(self.abspath(relpath))
1145
932
        :param from_dir: start from this directory or None for the root
1146
933
        :param recursive: whether to recurse into subdirectories or not
1147
934
        """
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):
 
935
        raise NotImplementedError(self.list_files)
 
936
 
 
937
    def move(self, from_paths, to_dir=None, after=False):
1261
938
        """Rename files.
1262
939
 
1263
 
        to_dir must exist in the inventory.
 
940
        to_dir must be known to the working tree.
1264
941
 
1265
942
        If to_dir exists and is a directory, the files are moved into
1266
943
        it, keeping their old names.
1272
949
        independently.
1273
950
 
1274
951
        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.
 
952
        working tree metadata. The second mode only updates the working tree
 
953
        metadata without touching the file on the filesystem.
1278
954
 
1279
955
        move uses the second mode if 'after == True' and the target is not
1280
956
        versioned but present in the working tree.
1292
968
        This returns a list of (from_path, to_path) pairs for each
1293
969
        entry that is moved.
1294
970
        """
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)
 
971
        raise NotImplementedError(self.move)
1464
972
 
1465
973
    @needs_tree_write_lock
1466
974
    def rename_one(self, from_rel, to_rel, after=False):
1470
978
 
1471
979
        rename_one has several 'modes' to work. First, it can rename a physical
1472
980
        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.
 
981
        only change the file_id without touching any physical file.
1475
982
 
1476
983
        rename_one uses the second mode if 'after == True' and 'to_rel' is not
1477
984
        versioned but present in the working tree.
1486
993
 
1487
994
        Everything else results in an error.
1488
995
        """
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
 
996
        raise NotImplementedError(self.rename_one)
1550
997
 
1551
998
    @needs_read_lock
1552
999
    def unknowns(self):
1560
1007
        return iter(
1561
1008
            [subp for subp in self.extras() if not self.is_ignored(subp)])
1562
1009
 
1563
 
    @needs_tree_write_lock
1564
1010
    def unversion(self, file_ids):
1565
1011
        """Remove the file ids in file_ids from the current versioned set.
1566
1012
 
1570
1016
        :param file_ids: The file ids to stop versioning.
1571
1017
        :raises: NoSuchId if any fileid is not currently versioned.
1572
1018
        """
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
 
1019
        raise NotImplementedError(self.unversion)
1600
1020
 
1601
1021
    @needs_write_lock
1602
1022
    def pull(self, source, overwrite=False, stop_revision=None,
1603
 
             change_reporter=None, possible_transports=None, local=False):
 
1023
             change_reporter=None, possible_transports=None, local=False,
 
1024
             show_base=False):
1604
1025
        source.lock_read()
1605
1026
        try:
1606
1027
            old_revision_info = self.branch.last_revision_info()
1620
1041
                                basis_tree,
1621
1042
                                this_tree=self,
1622
1043
                                pb=None,
1623
 
                                change_reporter=change_reporter)
 
1044
                                change_reporter=change_reporter,
 
1045
                                show_base=show_base)
1624
1046
                    basis_root_id = basis_tree.get_root_id()
1625
1047
                    new_root_id = new_basis_tree.get_root_id()
1626
1048
                    if basis_root_id != new_root_id:
1665
1087
        Currently returned depth-first, sorted by name within directories.
1666
1088
        This is the same order used by 'osutils.walkdirs'.
1667
1089
        """
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
 
1090
        raise NotImplementedError(self.extras)
1699
1091
 
1700
1092
    def ignored_files(self):
1701
1093
        """Yield list of PATH, IGNORE_PATTERN"""
1750
1142
 
1751
1143
    def stored_kind(self, file_id):
1752
1144
        """See Tree.stored_kind"""
1753
 
        return self.inventory[file_id].kind
 
1145
        raise NotImplementedError(self.stored_kind)
1754
1146
 
1755
1147
    def _comparison_data(self, entry, path):
1756
1148
        abspath = self.abspath(path)
1798
1190
            raise errors.ObjectNotLocked(self)
1799
1191
 
1800
1192
    def lock_read(self):
1801
 
        """See Branch.lock_read, and WorkingTree.unlock."""
 
1193
        """Lock the tree for reading.
 
1194
 
 
1195
        This also locks the branch, and can be unlocked via self.unlock().
 
1196
 
 
1197
        :return: A bzrlib.lock.LogicalLockResult.
 
1198
        """
1802
1199
        if not self.is_locked():
1803
1200
            self._reset_data()
1804
1201
        self.branch.lock_read()
1805
1202
        try:
1806
 
            return self._control_files.lock_read()
 
1203
            self._control_files.lock_read()
 
1204
            return LogicalLockResult(self.unlock)
1807
1205
        except:
1808
1206
            self.branch.unlock()
1809
1207
            raise
1810
1208
 
1811
1209
    def lock_tree_write(self):
1812
 
        """See MutableTree.lock_tree_write, and WorkingTree.unlock."""
 
1210
        """See MutableTree.lock_tree_write, and WorkingTree.unlock.
 
1211
 
 
1212
        :return: A bzrlib.lock.LogicalLockResult.
 
1213
        """
1813
1214
        if not self.is_locked():
1814
1215
            self._reset_data()
1815
1216
        self.branch.lock_read()
1816
1217
        try:
1817
 
            return self._control_files.lock_write()
 
1218
            self._control_files.lock_write()
 
1219
            return LogicalLockResult(self.unlock)
1818
1220
        except:
1819
1221
            self.branch.unlock()
1820
1222
            raise
1821
1223
 
1822
1224
    def lock_write(self):
1823
 
        """See MutableTree.lock_write, and WorkingTree.unlock."""
 
1225
        """See MutableTree.lock_write, and WorkingTree.unlock.
 
1226
 
 
1227
        :return: A bzrlib.lock.LogicalLockResult.
 
1228
        """
1824
1229
        if not self.is_locked():
1825
1230
            self._reset_data()
1826
1231
        self.branch.lock_write()
1827
1232
        try:
1828
 
            return self._control_files.lock_write()
 
1233
            self._control_files.lock_write()
 
1234
            return LogicalLockResult(self.unlock)
1829
1235
        except:
1830
1236
            self.branch.unlock()
1831
1237
            raise
1833
1239
    def get_physical_lock_status(self):
1834
1240
        return self._control_files.get_physical_lock_status()
1835
1241
 
1836
 
    def _basis_inventory_name(self):
1837
 
        return 'basis-inventory-cache'
1838
 
 
1839
1242
    def _reset_data(self):
1840
1243
        """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)
 
1244
        raise NotImplementedError(self._reset_data)
1848
1245
 
1849
 
    @needs_tree_write_lock
1850
1246
    def set_last_revision(self, new_revision):
1851
1247
        """Change the last revision in the working tree."""
1852
 
        if self._change_last_revision(new_revision):
1853
 
            self._cache_basis_inventory(new_revision)
 
1248
        raise NotImplementedError(self.set_last_revision)
1854
1249
 
1855
1250
    def _change_last_revision(self, new_revision):
1856
1251
        """Template method part of set_last_revision to perform the change.
1859
1254
        when their last revision is set.
1860
1255
        """
1861
1256
        if _mod_revision.is_null(new_revision):
1862
 
            self.branch.set_revision_history([])
 
1257
            self.branch.set_last_revision_info(0, new_revision)
1863
1258
            return False
 
1259
        _mod_revision.check_not_reserved_id(new_revision)
1864
1260
        try:
1865
1261
            self.branch.generate_revision_history(new_revision)
1866
1262
        except errors.NoSuchRevision:
1867
1263
            # not present in the repo - dont try to set it deeper than the tip
1868
 
            self.branch.set_revision_history([new_revision])
 
1264
            self.branch._set_revision_history([new_revision])
1869
1265
        return True
1870
1266
 
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
1267
    @needs_tree_write_lock
1937
1268
    def remove(self, files, verbose=False, to_file=None, keep_files=True,
1938
1269
        force=False):
1939
 
        """Remove nominated files from the working inventory.
 
1270
        """Remove nominated files from the working tree metadata.
1940
1271
 
1941
1272
        :files: File paths relative to the basedir.
1942
1273
        :keep_files: If true, the files will also be kept.
1948
1279
 
1949
1280
        inv_delta = []
1950
1281
 
1951
 
        new_files=set()
 
1282
        all_files = set() # specified and nested files 
1952
1283
        unknown_nested_files=set()
1953
1284
        if to_file is None:
1954
1285
            to_file = sys.stdout
1955
1286
 
 
1287
        files_to_backup = []
 
1288
 
1956
1289
        def recurse_directory_to_add_files(directory):
1957
1290
            # Recurse directory and add all files
1958
1291
            # so we can check if they have changed.
1959
 
            for parent_info, file_infos in\
1960
 
                self.walkdirs(directory):
 
1292
            for parent_info, file_infos in self.walkdirs(directory):
1961
1293
                for relpath, basename, kind, lstat, fileid, kind in file_infos:
1962
1294
                    # Is it versioned or ignored?
1963
 
                    if self.path2id(relpath) or self.is_ignored(relpath):
 
1295
                    if self.path2id(relpath):
1964
1296
                        # Add nested content for deletion.
1965
 
                        new_files.add(relpath)
 
1297
                        all_files.add(relpath)
1966
1298
                    else:
1967
 
                        # Files which are not versioned and not ignored
 
1299
                        # Files which are not versioned
1968
1300
                        # should be treated as unknown.
1969
 
                        unknown_nested_files.add((relpath, None, kind))
 
1301
                        files_to_backup.append(relpath)
1970
1302
 
1971
1303
        for filename in files:
1972
1304
            # Get file name into canonical form.
1973
1305
            abspath = self.abspath(filename)
1974
1306
            filename = self.relpath(abspath)
1975
1307
            if len(filename) > 0:
1976
 
                new_files.add(filename)
 
1308
                all_files.add(filename)
1977
1309
                recurse_directory_to_add_files(filename)
1978
1310
 
1979
 
        files = list(new_files)
 
1311
        files = list(all_files)
1980
1312
 
1981
1313
        if len(files) == 0:
1982
1314
            return # nothing to do
1986
1318
 
1987
1319
        # Bail out if we are going to delete files we shouldn't
1988
1320
        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
 
1321
            for (file_id, path, content_change, versioned, parent_id, name,
 
1322
                 kind, executable) in self.iter_changes(self.basis_tree(),
 
1323
                     include_unchanged=True, require_versioned=False,
 
1324
                     want_unversioned=True, specific_files=files):
 
1325
                if versioned[0] == False:
 
1326
                    # The record is unknown or newly added
 
1327
                    files_to_backup.append(path[1])
 
1328
                elif (content_change and (kind[1] is not None) and
 
1329
                        osutils.is_inside_any(files, path[1])):
 
1330
                    # Versioned and changed, but not deleted, and still
 
1331
                    # in one of the dirs to be deleted.
 
1332
                    files_to_backup.append(path[1])
2005
1333
 
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)
 
1334
        def backup(file_to_backup):
 
1335
            backup_name = self.bzrdir._available_backup_name(file_to_backup)
 
1336
            osutils.rename(abs_path, self.abspath(backup_name))
 
1337
            return "removed %s (but kept a copy: %s)" % (file_to_backup,
 
1338
                                                         backup_name)
2015
1339
 
2016
1340
        # Build inv_delta and delete files where applicable,
2017
 
        # do this before any modifications to inventory.
 
1341
        # do this before any modifications to meta data.
2018
1342
        for f in files:
2019
1343
            fid = self.path2id(f)
2020
1344
            message = None
2041
1365
                        len(os.listdir(abs_path)) > 0):
2042
1366
                        if force:
2043
1367
                            osutils.rmtree(abs_path)
 
1368
                            message = "deleted %s" % (f,)
2044
1369
                        else:
2045
 
                            message = "%s is not an empty directory "\
2046
 
                                "and won't be deleted." % (f,)
 
1370
                            message = backup(f)
2047
1371
                    else:
2048
 
                        osutils.delete_any(abs_path)
2049
 
                        message = "deleted %s" % (f,)
 
1372
                        if f in files_to_backup:
 
1373
                            message = backup(f)
 
1374
                        else:
 
1375
                            osutils.delete_any(abs_path)
 
1376
                            message = "deleted %s" % (f,)
2050
1377
                elif message is not None:
2051
1378
                    # Only care if we haven't done anything yet.
2052
1379
                    message = "%s does not exist." % (f,)
2097
1424
        WorkingTree can supply revision_trees for the basis revision only
2098
1425
        because there is only one cached inventory in the bzr directory.
2099
1426
        """
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)
 
1427
        raise NotImplementedError(self.revision_tree)
2141
1428
 
2142
1429
    @needs_tree_write_lock
2143
1430
    def set_root_id(self, file_id):
2156
1443
            present in the current inventory or an error will occur. It must
2157
1444
            not be None, but rather a valid file id.
2158
1445
        """
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
 
1446
        raise NotImplementedError(self._set_root_id)
2177
1447
 
2178
1448
    def unlock(self):
2179
1449
        """See Branch.unlock.
2189
1459
    _marker = object()
2190
1460
 
2191
1461
    def update(self, change_reporter=None, possible_transports=None,
2192
 
               revision=None, old_tip=_marker):
 
1462
               revision=None, old_tip=_marker, show_base=False):
2193
1463
        """Update a working tree along its branch.
2194
1464
 
2195
1465
        This will update the branch if its bound too, which means we have
2232
1502
            else:
2233
1503
                if old_tip is self._marker:
2234
1504
                    old_tip = None
2235
 
            return self._update_tree(old_tip, change_reporter, revision)
 
1505
            return self._update_tree(old_tip, change_reporter, revision, show_base)
2236
1506
        finally:
2237
1507
            self.unlock()
2238
1508
 
2239
1509
    @needs_tree_write_lock
2240
 
    def _update_tree(self, old_tip=None, change_reporter=None, revision=None):
 
1510
    def _update_tree(self, old_tip=None, change_reporter=None, revision=None,
 
1511
                     show_base=False):
2241
1512
        """Update a tree to the master branch.
2242
1513
 
2243
1514
        :param old_tip: if supplied, the previous tip revision the branch,
2270
1541
            other_tree = self.branch.repository.revision_tree(old_tip)
2271
1542
            nb_conflicts = merge.merge_inner(self.branch, other_tree,
2272
1543
                                             base_tree, this_tree=self,
2273
 
                                             change_reporter=change_reporter)
 
1544
                                             change_reporter=change_reporter,
 
1545
                                             show_base=show_base)
2274
1546
            if nb_conflicts:
2275
1547
                self.add_parent_tree((old_tip, other_tree))
2276
 
                trace.note('Rerun update after fixing the conflicts.')
 
1548
                note('Rerun update after fixing the conflicts.')
2277
1549
                return nb_conflicts
2278
1550
 
2279
1551
        if last_rev != _mod_revision.ensure_null(revision):
2285
1557
            basis = self.basis_tree()
2286
1558
            basis.lock_read()
2287
1559
            try:
2288
 
                if (basis.inventory.root is None
2289
 
                    or basis.inventory.root.file_id != to_root_id):
 
1560
                if (basis.get_root_id() is None or basis.get_root_id() != to_root_id):
2290
1561
                    self.set_root_id(to_root_id)
2291
1562
                    self.flush()
2292
1563
            finally:
2300
1571
 
2301
1572
            nb_conflicts = merge.merge_inner(self.branch, to_tree, base_tree,
2302
1573
                                             this_tree=self,
2303
 
                                             change_reporter=change_reporter)
 
1574
                                             change_reporter=change_reporter,
 
1575
                                             show_base=show_base)
2304
1576
            self.set_last_revision(revision)
2305
1577
            # TODO - dedup parents list with things merged by pull ?
2306
1578
            # reuse the tree we've updated to to set the basis:
2333
1605
                #       warning might be sufficient to let the user know what
2334
1606
                #       is going on.
2335
1607
                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()
 
1608
                              self._hashcache.cache_file_name(), e)
2343
1609
 
2344
1610
    def set_conflicts(self, arg):
2345
1611
        raise errors.UnsupportedOperation(self.set_conflicts, self)
2347
1613
    def add_conflicts(self, arg):
2348
1614
        raise errors.UnsupportedOperation(self.add_conflicts, self)
2349
1615
 
2350
 
    @needs_read_lock
2351
1616
    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
 
1617
        raise NotImplementedError(self.conflicts)
2375
1618
 
2376
1619
    def walkdirs(self, prefix=""):
2377
1620
        """Walk the directories of this tree.
2503
1746
                 [(file1_path, file1_name, file1_kind, None, file1_id,
2504
1747
                   file1_kind), ... ])
2505
1748
        """
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)
 
1749
        raise NotImplementedError(self._walkdirs)
2535
1750
 
2536
1751
    @needs_tree_write_lock
2537
1752
    def auto_resolve(self):
2595
1810
        """
2596
1811
        return
2597
1812
 
 
1813
    @needs_read_lock
 
1814
    def check_state(self):
 
1815
        """Check that the working state is/isn't valid."""
 
1816
        check_refs = self._get_check_refs()
 
1817
        refs = {}
 
1818
        for ref in check_refs:
 
1819
            kind, value = ref
 
1820
            if kind == 'trees':
 
1821
                refs[ref] = self.branch.repository.revision_tree(value)
 
1822
        self._check(refs)
 
1823
 
 
1824
    def reset_state(self, revision_ids=None):
 
1825
        """Reset the state of the working tree.
 
1826
 
 
1827
        This does a hard-reset to a last-known-good state. This is a way to
 
1828
        fix if something got corrupted (like the .bzr/checkout/dirstate file)
 
1829
        """
 
1830
        raise NotImplementedError(self.reset_state)
 
1831
 
2598
1832
    def _get_rules_searcher(self, default_searcher):
2599
1833
        """See Tree._get_rules_searcher."""
2600
1834
        if self._rules_searcher is None:
2608
1842
        return ShelfManager(self, self._transport)
2609
1843
 
2610
1844
 
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.
 
1845
class InventoryWorkingTree(WorkingTree,
 
1846
        bzrlib.mutabletree.MutableInventoryTree):
 
1847
    """Base class for working trees that are inventory-oriented.
 
1848
 
 
1849
    The inventory is held in the `Branch` working-inventory, and the
 
1850
    files are in a directory on disk.
 
1851
 
 
1852
    It is possible for a `WorkingTree` to have a filename which is
 
1853
    not listed in the Inventory and vice versa.
2617
1854
    """
2618
1855
 
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()
 
1856
    def __init__(self, basedir='.',
 
1857
                 branch=DEPRECATED_PARAMETER,
 
1858
                 _inventory=None,
 
1859
                 _control_files=None,
 
1860
                 _internal=False,
 
1861
                 _format=None,
 
1862
                 _bzrdir=None):
 
1863
        """Construct a InventoryWorkingTree instance. This is not a public API.
 
1864
 
 
1865
        :param branch: A branch to override probing for the branch.
 
1866
        """
 
1867
        super(InventoryWorkingTree, self).__init__(basedir=basedir,
 
1868
            branch=branch, _control_files=_control_files, _internal=_internal,
 
1869
            _format=_format, _bzrdir=_bzrdir)
 
1870
 
 
1871
        if _inventory is None:
 
1872
            # This will be acquired on lock_read() or lock_write()
 
1873
            self._inventory_is_modified = False
 
1874
            self._inventory = None
 
1875
        else:
 
1876
            # the caller of __init__ has provided an inventory,
 
1877
            # we assume they know what they are doing - as its only
 
1878
            # the Format factory and creation methods that are
 
1879
            # permitted to do this.
 
1880
            self._set_inventory(_inventory, dirty=False)
 
1881
 
 
1882
    def _set_inventory(self, inv, dirty):
 
1883
        """Set the internal cached inventory.
 
1884
 
 
1885
        :param inv: The inventory to set.
 
1886
        :param dirty: A boolean indicating whether the inventory is the same
 
1887
            logical inventory as whats on disk. If True the inventory is not
 
1888
            the same and should be written to disk or data will be lost, if
 
1889
            False then the inventory is the same as that on disk and any
 
1890
            serialisation would be unneeded overhead.
 
1891
        """
 
1892
        self._inventory = inv
 
1893
        self._inventory_is_modified = dirty
 
1894
 
 
1895
    def _serialize(self, inventory, out_file):
 
1896
        xml5.serializer_v5.write_inventory(self._inventory, out_file,
 
1897
            working=True)
 
1898
 
 
1899
    def _deserialize(selt, in_file):
 
1900
        return xml5.serializer_v5.read_inventory(in_file)
 
1901
 
 
1902
    @needs_tree_write_lock
 
1903
    def _write_inventory(self, inv):
 
1904
        """Write inventory as the current inventory."""
 
1905
        self._set_inventory(inv, dirty=True)
 
1906
        self.flush()
 
1907
 
 
1908
    # XXX: This method should be deprecated in favour of taking in a proper
 
1909
    # new Inventory object.
 
1910
    @needs_tree_write_lock
 
1911
    def set_inventory(self, new_inventory_list):
 
1912
        from bzrlib.inventory import (Inventory,
 
1913
                                      InventoryDirectory,
 
1914
                                      InventoryFile,
 
1915
                                      InventoryLink)
 
1916
        inv = Inventory(self.get_root_id())
 
1917
        for path, file_id, parent, kind in new_inventory_list:
 
1918
            name = os.path.basename(path)
 
1919
            if name == "":
 
1920
                continue
 
1921
            # fixme, there should be a factory function inv,add_??
 
1922
            if kind == 'directory':
 
1923
                inv.add(InventoryDirectory(file_id, name, parent))
 
1924
            elif kind == 'file':
 
1925
                inv.add(InventoryFile(file_id, name, parent))
 
1926
            elif kind == 'symlink':
 
1927
                inv.add(InventoryLink(file_id, name, parent))
 
1928
            else:
 
1929
                raise errors.BzrError("unknown kind %r" % kind)
 
1930
        self._write_inventory(inv)
 
1931
 
 
1932
    def _write_basis_inventory(self, xml):
 
1933
        """Write the basis inventory XML to the basis-inventory file"""
 
1934
        path = self._basis_inventory_name()
 
1935
        sio = StringIO(xml)
 
1936
        self._transport.put_file(path, sio,
 
1937
            mode=self.bzrdir._get_file_mode())
 
1938
 
 
1939
    def _reset_data(self):
 
1940
        """Reset transient data that cannot be revalidated."""
 
1941
        self._inventory_is_modified = False
 
1942
        f = self._transport.get('inventory')
 
1943
        try:
 
1944
            result = self._deserialize(f)
2661
1945
        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."""
 
1946
            f.close()
 
1947
        self._set_inventory(result, dirty=False)
 
1948
 
 
1949
    def _set_root_id(self, file_id):
 
1950
        """Set the root id for this tree, in a format specific manner.
 
1951
 
 
1952
        :param file_id: The file id to assign to the root. It must not be
 
1953
            present in the current inventory or an error will occur. It must
 
1954
            not be None, but rather a valid file id.
 
1955
        """
 
1956
        inv = self._inventory
 
1957
        orig_root_id = inv.root.file_id
 
1958
        # TODO: it might be nice to exit early if there was nothing
 
1959
        # to do, saving us from trigger a sync on unlock.
 
1960
        self._inventory_is_modified = True
 
1961
        # we preserve the root inventory entry object, but
 
1962
        # unlinkit from the byid index
 
1963
        del inv._byid[inv.root.file_id]
 
1964
        inv.root.file_id = file_id
 
1965
        # and link it into the index with the new changed id.
 
1966
        inv._byid[inv.root.file_id] = inv.root
 
1967
        # and finally update all children to reference the new id.
 
1968
        # XXX: this should be safe to just look at the root.children
 
1969
        # list, not the WHOLE INVENTORY.
 
1970
        for fid in inv:
 
1971
            entry = inv[fid]
 
1972
            if entry.parent_id == orig_root_id:
 
1973
                entry.parent_id = inv.root.file_id
 
1974
 
 
1975
    def all_file_ids(self):
 
1976
        """See Tree.iter_all_file_ids"""
 
1977
        return set(self.inventory)
 
1978
 
 
1979
    @needs_tree_write_lock
 
1980
    def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
 
1981
        """See MutableTree.set_parent_trees."""
 
1982
        parent_ids = [rev for (rev, tree) in parents_list]
 
1983
        for revision_id in parent_ids:
 
1984
            _mod_revision.check_not_reserved_id(revision_id)
 
1985
 
 
1986
        self._check_parents_for_ghosts(parent_ids,
 
1987
            allow_leftmost_as_ghost=allow_leftmost_as_ghost)
 
1988
 
 
1989
        parent_ids = self._filter_parent_ids_by_ancestry(parent_ids)
 
1990
 
 
1991
        if len(parent_ids) == 0:
 
1992
            leftmost_parent_id = _mod_revision.NULL_REVISION
 
1993
            leftmost_parent_tree = None
 
1994
        else:
 
1995
            leftmost_parent_id, leftmost_parent_tree = parents_list[0]
 
1996
 
 
1997
        if self._change_last_revision(leftmost_parent_id):
 
1998
            if leftmost_parent_tree is None:
 
1999
                # If we don't have a tree, fall back to reading the
 
2000
                # parent tree from the repository.
 
2001
                self._cache_basis_inventory(leftmost_parent_id)
 
2002
            else:
 
2003
                inv = leftmost_parent_tree.inventory
 
2004
                xml = self._create_basis_xml_from_inventory(
 
2005
                                        leftmost_parent_id, inv)
 
2006
                self._write_basis_inventory(xml)
 
2007
        self._set_merges_from_parent_ids(parent_ids)
 
2008
 
 
2009
    def _cache_basis_inventory(self, new_revision):
 
2010
        """Cache new_revision as the basis inventory."""
 
2011
        # TODO: this should allow the ready-to-use inventory to be passed in,
 
2012
        # as commit already has that ready-to-use [while the format is the
 
2013
        # same, that is].
2678
2014
        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())]
 
2015
            # this double handles the inventory - unpack and repack -
 
2016
            # but is easier to understand. We can/should put a conditional
 
2017
            # in here based on whether the inventory is in the latest format
 
2018
            # - perhaps we should repack all inventories on a repository
 
2019
            # upgrade ?
 
2020
            # the fast path is to copy the raw xml from the repository. If the
 
2021
            # xml contains 'revision_id="', then we assume the right
 
2022
            # revision_id is set. We must check for this full string, because a
 
2023
            # root node id can legitimately look like 'revision_id' but cannot
 
2024
            # contain a '"'.
 
2025
            xml = self.branch.repository._get_inventory_xml(new_revision)
 
2026
            firstline = xml.split('\n', 1)[0]
 
2027
            if (not 'revision_id="' in firstline or
 
2028
                'format="7"' not in firstline):
 
2029
                inv = self.branch.repository._serializer.read_inventory_from_string(
 
2030
                    xml, new_revision)
 
2031
                xml = self._create_basis_xml_from_inventory(new_revision, inv)
 
2032
            self._write_basis_inventory(xml)
 
2033
        except (errors.NoSuchRevision, errors.RevisionNotPresent):
 
2034
            pass
 
2035
 
 
2036
    def _basis_inventory_name(self):
 
2037
        return 'basis-inventory-cache'
 
2038
 
 
2039
    def _create_basis_xml_from_inventory(self, revision_id, inventory):
 
2040
        """Create the text that will be saved in basis-inventory"""
 
2041
        inventory.revision_id = revision_id
 
2042
        return xml7.serializer_v7.write_inventory_to_string(inventory)
2699
2043
 
2700
2044
    @needs_tree_write_lock
2701
2045
    def set_conflicts(self, conflicts):
2721
2065
                    raise errors.ConflictFormatError()
2722
2066
            except StopIteration:
2723
2067
                raise errors.ConflictFormatError()
2724
 
            return _mod_conflicts.ConflictList.from_stanzas(RioReader(confile))
 
2068
            reader = _mod_rio.RioReader(confile)
 
2069
            return _mod_conflicts.ConflictList.from_stanzas(reader)
2725
2070
        finally:
2726
2071
            confile.close()
2727
2072
 
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):
 
2073
    def read_basis_inventory(self):
 
2074
        """Read the cached basis inventory."""
 
2075
        path = self._basis_inventory_name()
 
2076
        return self._transport.get_bytes(path)
 
2077
 
 
2078
    @needs_read_lock
 
2079
    def read_working_inventory(self):
 
2080
        """Read the working inventory.
 
2081
 
 
2082
        :raises errors.InventoryModified: read_working_inventory will fail
 
2083
            when the current in memory inventory has been modified.
 
2084
        """
 
2085
        # conceptually this should be an implementation detail of the tree.
 
2086
        # XXX: Deprecate this.
 
2087
        # ElementTree does its own conversion from UTF-8, so open in
 
2088
        # binary.
 
2089
        if self._inventory_is_modified:
 
2090
            raise errors.InventoryModified(self)
 
2091
        f = self._transport.get('inventory')
 
2092
        try:
 
2093
            result = self._deserialize(f)
 
2094
        finally:
 
2095
            f.close()
 
2096
        self._set_inventory(result, dirty=False)
 
2097
        return result
 
2098
 
 
2099
    @needs_read_lock
 
2100
    def get_root_id(self):
 
2101
        """Return the id of this trees root"""
 
2102
        return self._inventory.root.file_id
 
2103
 
 
2104
    def has_id(self, file_id):
 
2105
        # files that have been deleted are excluded
 
2106
        inv = self.inventory
 
2107
        if not inv.has_id(file_id):
 
2108
            return False
 
2109
        path = inv.id2path(file_id)
 
2110
        return osutils.lexists(self.abspath(path))
 
2111
 
 
2112
    def has_or_had_id(self, file_id):
 
2113
        if file_id == self.inventory.root.file_id:
 
2114
            return True
 
2115
        return self.inventory.has_id(file_id)
 
2116
 
 
2117
    __contains__ = has_id
 
2118
 
 
2119
    @symbol_versioning.deprecated_method(symbol_versioning.deprecated_in((2, 4, 0)))
 
2120
    def __iter__(self):
 
2121
        """Iterate through file_ids for this tree.
 
2122
 
 
2123
        file_ids are in a WorkingTree if they are in the working inventory
 
2124
        and the working file exists.
 
2125
        """
 
2126
        inv = self._inventory
 
2127
        for path, ie in inv.iter_entries():
 
2128
            if osutils.lexists(self.abspath(path)):
 
2129
                yield ie.file_id
 
2130
 
 
2131
    @needs_tree_write_lock
 
2132
    def set_last_revision(self, new_revision):
 
2133
        """Change the last revision in the working tree."""
 
2134
        if self._change_last_revision(new_revision):
 
2135
            self._cache_basis_inventory(new_revision)
 
2136
 
 
2137
    @needs_tree_write_lock
 
2138
    def reset_state(self, revision_ids=None):
 
2139
        """Reset the state of the working tree.
 
2140
 
 
2141
        This does a hard-reset to a last-known-good state. This is a way to
 
2142
        fix if something got corrupted (like the .bzr/checkout/dirstate file)
 
2143
        """
 
2144
        if revision_ids is None:
 
2145
            revision_ids = self.get_parent_ids()
 
2146
        if not revision_ids:
 
2147
            rt = self.branch.repository.revision_tree(
 
2148
                _mod_revision.NULL_REVISION)
 
2149
        else:
 
2150
            rt = self.branch.repository.revision_tree(revision_ids[0])
 
2151
        self._write_inventory(rt.inventory)
 
2152
        self.set_parent_ids(revision_ids)
 
2153
 
 
2154
    def flush(self):
 
2155
        """Write the in memory inventory to disk."""
 
2156
        # TODO: Maybe this should only write on dirty ?
 
2157
        if self._control_files._lock_mode != 'w':
 
2158
            raise errors.NotWriteLocked(self)
 
2159
        sio = StringIO()
 
2160
        self._serialize(self._inventory, sio)
 
2161
        sio.seek(0)
 
2162
        self._transport.put_file('inventory', sio,
 
2163
            mode=self.bzrdir._get_file_mode())
 
2164
        self._inventory_is_modified = False
 
2165
 
 
2166
    @needs_read_lock
 
2167
    def get_file_sha1(self, file_id, path=None, stat_value=None):
 
2168
        if not path:
 
2169
            path = self._inventory.id2path(file_id)
 
2170
        return self._hashcache.get_sha1(path, stat_value)
 
2171
 
 
2172
    def get_file_mtime(self, file_id, path=None):
 
2173
        """See Tree.get_file_mtime."""
 
2174
        if not path:
 
2175
            path = self.inventory.id2path(file_id)
 
2176
        return os.lstat(self.abspath(path)).st_mtime
 
2177
 
 
2178
    def _is_executable_from_path_and_stat_from_basis(self, path, stat_result):
 
2179
        file_id = self.path2id(path)
 
2180
        if file_id is None:
 
2181
            # For unversioned files on win32, we just assume they are not
 
2182
            # executable
 
2183
            return False
 
2184
        return self._inventory[file_id].executable
 
2185
 
 
2186
    def _is_executable_from_path_and_stat_from_stat(self, path, stat_result):
 
2187
        mode = stat_result.st_mode
 
2188
        return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
 
2189
 
 
2190
    if not supports_executable():
 
2191
        def is_executable(self, file_id, path=None):
 
2192
            return self._inventory[file_id].executable
 
2193
 
 
2194
        _is_executable_from_path_and_stat = \
 
2195
            _is_executable_from_path_and_stat_from_basis
 
2196
    else:
 
2197
        def is_executable(self, file_id, path=None):
 
2198
            if not path:
 
2199
                path = self.id2path(file_id)
 
2200
            mode = os.lstat(self.abspath(path)).st_mode
 
2201
            return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
 
2202
 
 
2203
        _is_executable_from_path_and_stat = \
 
2204
            _is_executable_from_path_and_stat_from_stat
 
2205
 
 
2206
    @needs_tree_write_lock
 
2207
    def _add(self, files, ids, kinds):
 
2208
        """See MutableTree._add."""
 
2209
        # TODO: Re-adding a file that is removed in the working copy
 
2210
        # should probably put it back with the previous ID.
 
2211
        # the read and write working inventory should not occur in this
 
2212
        # function - they should be part of lock_write and unlock.
 
2213
        inv = self.inventory
 
2214
        for f, file_id, kind in zip(files, ids, kinds):
 
2215
            if file_id is None:
 
2216
                inv.add_path(f, kind=kind)
 
2217
            else:
 
2218
                inv.add_path(f, kind=kind, file_id=file_id)
 
2219
            self._inventory_is_modified = True
 
2220
 
 
2221
    def revision_tree(self, revision_id):
 
2222
        """See WorkingTree.revision_id."""
 
2223
        if revision_id == self.last_revision():
 
2224
            try:
 
2225
                xml = self.read_basis_inventory()
 
2226
            except errors.NoSuchFile:
 
2227
                pass
 
2228
            else:
 
2229
                try:
 
2230
                    inv = xml7.serializer_v7.read_inventory_from_string(xml)
 
2231
                    # dont use the repository revision_tree api because we want
 
2232
                    # to supply the inventory.
 
2233
                    if inv.revision_id == revision_id:
 
2234
                        return revisiontree.InventoryRevisionTree(
 
2235
                            self.branch.repository, inv, revision_id)
 
2236
                except errors.BadInventoryFormat:
 
2237
                    pass
 
2238
        # raise if there was no inventory, or if we read the wrong inventory.
 
2239
        raise errors.NoSuchRevisionInTree(self, revision_id)
 
2240
 
 
2241
    @needs_read_lock
 
2242
    def annotate_iter(self, file_id, default_revision=CURRENT_REVISION):
 
2243
        """See Tree.annotate_iter
 
2244
 
 
2245
        This implementation will use the basis tree implementation if possible.
 
2246
        Lines not in the basis are attributed to CURRENT_REVISION
 
2247
 
 
2248
        If there are pending merges, lines added by those merges will be
 
2249
        incorrectly attributed to CURRENT_REVISION (but after committing, the
 
2250
        attribution will be correct).
 
2251
        """
 
2252
        maybe_file_parent_keys = []
 
2253
        for parent_id in self.get_parent_ids():
 
2254
            try:
 
2255
                parent_tree = self.revision_tree(parent_id)
 
2256
            except errors.NoSuchRevisionInTree:
 
2257
                parent_tree = self.branch.repository.revision_tree(parent_id)
 
2258
            parent_tree.lock_read()
 
2259
            try:
 
2260
                if file_id not in parent_tree:
 
2261
                    continue
 
2262
                ie = parent_tree.inventory[file_id]
 
2263
                if ie.kind != 'file':
 
2264
                    # Note: this is slightly unnecessary, because symlinks and
 
2265
                    # directories have a "text" which is the empty text, and we
 
2266
                    # know that won't mess up annotations. But it seems cleaner
 
2267
                    continue
 
2268
                parent_text_key = (file_id, ie.revision)
 
2269
                if parent_text_key not in maybe_file_parent_keys:
 
2270
                    maybe_file_parent_keys.append(parent_text_key)
 
2271
            finally:
 
2272
                parent_tree.unlock()
 
2273
        graph = _mod_graph.Graph(self.branch.repository.texts)
 
2274
        heads = graph.heads(maybe_file_parent_keys)
 
2275
        file_parent_keys = []
 
2276
        for key in maybe_file_parent_keys:
 
2277
            if key in heads:
 
2278
                file_parent_keys.append(key)
 
2279
 
 
2280
        # Now we have the parents of this content
 
2281
        annotator = self.branch.repository.texts.get_annotator()
 
2282
        text = self.get_file_text(file_id)
 
2283
        this_key =(file_id, default_revision)
 
2284
        annotator.add_special_text(this_key, file_parent_keys, text)
 
2285
        annotations = [(key[-1], line)
 
2286
                       for key, line in annotator.annotate_flat(this_key)]
 
2287
        return annotations
 
2288
 
 
2289
    @needs_read_lock
 
2290
    def merge_modified(self):
 
2291
        """Return a dictionary of files modified by a merge.
 
2292
 
 
2293
        The list is initialized by WorkingTree.set_merge_modified, which is
 
2294
        typically called after we make some automatic updates to the tree
 
2295
        because of a merge.
 
2296
 
 
2297
        This returns a map of file_id->sha1, containing only files which are
 
2298
        still in the working inventory and have that text hash.
 
2299
        """
 
2300
        try:
 
2301
            hashfile = self._transport.get('merge-hashes')
 
2302
        except errors.NoSuchFile:
 
2303
            return {}
 
2304
        try:
 
2305
            merge_hashes = {}
 
2306
            try:
 
2307
                if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
 
2308
                    raise errors.MergeModifiedFormatError()
 
2309
            except StopIteration:
 
2310
                raise errors.MergeModifiedFormatError()
 
2311
            for s in _mod_rio.RioReader(hashfile):
 
2312
                # RioReader reads in Unicode, so convert file_ids back to utf8
 
2313
                file_id = osutils.safe_file_id(s.get("file_id"), warn=False)
 
2314
                if file_id not in self.inventory:
 
2315
                    continue
 
2316
                text_hash = s.get("hash")
 
2317
                if text_hash == self.get_file_sha1(file_id):
 
2318
                    merge_hashes[file_id] = text_hash
 
2319
            return merge_hashes
 
2320
        finally:
 
2321
            hashfile.close()
 
2322
 
 
2323
    @needs_write_lock
 
2324
    def subsume(self, other_tree):
 
2325
        def add_children(inventory, entry):
 
2326
            for child_entry in entry.children.values():
 
2327
                inventory._byid[child_entry.file_id] = child_entry
 
2328
                if child_entry.kind == 'directory':
 
2329
                    add_children(inventory, child_entry)
 
2330
        if other_tree.get_root_id() == self.get_root_id():
 
2331
            raise errors.BadSubsumeSource(self, other_tree,
 
2332
                                          'Trees have the same root')
 
2333
        try:
 
2334
            other_tree_path = self.relpath(other_tree.basedir)
 
2335
        except errors.PathNotChild:
 
2336
            raise errors.BadSubsumeSource(self, other_tree,
 
2337
                'Tree is not contained by the other')
 
2338
        new_root_parent = self.path2id(osutils.dirname(other_tree_path))
 
2339
        if new_root_parent is None:
 
2340
            raise errors.BadSubsumeSource(self, other_tree,
 
2341
                'Parent directory is not versioned.')
 
2342
        # We need to ensure that the result of a fetch will have a
 
2343
        # versionedfile for the other_tree root, and only fetching into
 
2344
        # RepositoryKnit2 guarantees that.
 
2345
        if not self.branch.repository.supports_rich_root():
 
2346
            raise errors.SubsumeTargetNeedsUpgrade(other_tree)
 
2347
        other_tree.lock_tree_write()
 
2348
        try:
 
2349
            new_parents = other_tree.get_parent_ids()
 
2350
            other_root = other_tree.inventory.root
 
2351
            other_root.parent_id = new_root_parent
 
2352
            other_root.name = osutils.basename(other_tree_path)
 
2353
            self.inventory.add(other_root)
 
2354
            add_children(self.inventory, other_root)
 
2355
            self._write_inventory(self.inventory)
 
2356
            # normally we don't want to fetch whole repositories, but i think
 
2357
            # here we really do want to consolidate the whole thing.
 
2358
            for parent_id in other_tree.get_parent_ids():
 
2359
                self.branch.fetch(other_tree.branch, parent_id)
 
2360
                self.add_parent_tree_id(parent_id)
 
2361
        finally:
 
2362
            other_tree.unlock()
 
2363
        other_tree.bzrdir.retire_bzrdir()
 
2364
 
 
2365
    @needs_tree_write_lock
 
2366
    def extract(self, file_id, format=None):
 
2367
        """Extract a subtree from this tree.
 
2368
 
 
2369
        A new branch will be created, relative to the path for this tree.
 
2370
        """
 
2371
        self.flush()
 
2372
        def mkdirs(path):
 
2373
            segments = osutils.splitpath(path)
 
2374
            transport = self.branch.bzrdir.root_transport
 
2375
            for name in segments:
 
2376
                transport = transport.clone(name)
 
2377
                transport.ensure_base()
 
2378
            return transport
 
2379
 
 
2380
        sub_path = self.id2path(file_id)
 
2381
        branch_transport = mkdirs(sub_path)
 
2382
        if format is None:
 
2383
            format = self.bzrdir.cloning_metadir()
 
2384
        branch_transport.ensure_base()
 
2385
        branch_bzrdir = format.initialize_on_transport(branch_transport)
 
2386
        try:
 
2387
            repo = branch_bzrdir.find_repository()
 
2388
        except errors.NoRepositoryPresent:
 
2389
            repo = branch_bzrdir.create_repository()
 
2390
        if not repo.supports_rich_root():
 
2391
            raise errors.RootNotRich()
 
2392
        new_branch = branch_bzrdir.create_branch()
 
2393
        new_branch.pull(self.branch)
 
2394
        for parent_id in self.get_parent_ids():
 
2395
            new_branch.fetch(self.branch, parent_id)
 
2396
        tree_transport = self.bzrdir.root_transport.clone(sub_path)
 
2397
        if tree_transport.base != branch_transport.base:
 
2398
            tree_bzrdir = format.initialize_on_transport(tree_transport)
 
2399
            branch.BranchReferenceFormat().initialize(tree_bzrdir,
 
2400
                target_branch=new_branch)
 
2401
        else:
 
2402
            tree_bzrdir = branch_bzrdir
 
2403
        wt = tree_bzrdir.create_workingtree(_mod_revision.NULL_REVISION)
 
2404
        wt.set_parent_ids(self.get_parent_ids())
 
2405
        my_inv = self.inventory
 
2406
        child_inv = inventory.Inventory(root_id=None)
 
2407
        new_root = my_inv[file_id]
 
2408
        my_inv.remove_recursive_id(file_id)
 
2409
        new_root.parent_id = None
 
2410
        child_inv.add(new_root)
 
2411
        self._write_inventory(my_inv)
 
2412
        wt._write_inventory(child_inv)
 
2413
        return wt
 
2414
 
 
2415
    def list_files(self, include_root=False, from_dir=None, recursive=True):
 
2416
        """List all files as (path, class, kind, id, entry).
 
2417
 
 
2418
        Lists, but does not descend into unversioned directories.
 
2419
        This does not include files that have been deleted in this
 
2420
        tree. Skips the control directory.
 
2421
 
 
2422
        :param include_root: if True, return an entry for the root
 
2423
        :param from_dir: start from this directory or None for the root
 
2424
        :param recursive: whether to recurse into subdirectories or not
 
2425
        """
 
2426
        # list_files is an iterator, so @needs_read_lock doesn't work properly
 
2427
        # with it. So callers should be careful to always read_lock the tree.
 
2428
        if not self.is_locked():
 
2429
            raise errors.ObjectNotLocked(self)
 
2430
 
 
2431
        inv = self.inventory
 
2432
        if from_dir is None and include_root is True:
 
2433
            yield ('', 'V', 'directory', inv.root.file_id, inv.root)
 
2434
        # Convert these into local objects to save lookup times
 
2435
        pathjoin = osutils.pathjoin
 
2436
        file_kind = self._kind
 
2437
 
 
2438
        # transport.base ends in a slash, we want the piece
 
2439
        # between the last two slashes
 
2440
        transport_base_dir = self.bzrdir.transport.base.rsplit('/', 2)[1]
 
2441
 
 
2442
        fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
 
2443
 
 
2444
        # directory file_id, relative path, absolute path, reverse sorted children
 
2445
        if from_dir is not None:
 
2446
            from_dir_id = inv.path2id(from_dir)
 
2447
            if from_dir_id is None:
 
2448
                # Directory not versioned
 
2449
                return
 
2450
            from_dir_abspath = pathjoin(self.basedir, from_dir)
 
2451
        else:
 
2452
            from_dir_id = inv.root.file_id
 
2453
            from_dir_abspath = self.basedir
 
2454
        children = os.listdir(from_dir_abspath)
 
2455
        children.sort()
 
2456
        # jam 20060527 The kernel sized tree seems equivalent whether we
 
2457
        # use a deque and popleft to keep them sorted, or if we use a plain
 
2458
        # list and just reverse() them.
 
2459
        children = collections.deque(children)
 
2460
        stack = [(from_dir_id, u'', from_dir_abspath, children)]
 
2461
        while stack:
 
2462
            from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
 
2463
 
 
2464
            while children:
 
2465
                f = children.popleft()
 
2466
                ## TODO: If we find a subdirectory with its own .bzr
 
2467
                ## directory, then that is a separate tree and we
 
2468
                ## should exclude it.
 
2469
 
 
2470
                # the bzrdir for this tree
 
2471
                if transport_base_dir == f:
 
2472
                    continue
 
2473
 
 
2474
                # we know that from_dir_relpath and from_dir_abspath never end in a slash
 
2475
                # and 'f' doesn't begin with one, we can do a string op, rather
 
2476
                # than the checks of pathjoin(), all relative paths will have an extra slash
 
2477
                # at the beginning
 
2478
                fp = from_dir_relpath + '/' + f
 
2479
 
 
2480
                # absolute path
 
2481
                fap = from_dir_abspath + '/' + f
 
2482
 
 
2483
                dir_ie = inv[from_dir_id]
 
2484
                if dir_ie.kind == 'directory':
 
2485
                    f_ie = dir_ie.children.get(f)
 
2486
                else:
 
2487
                    f_ie = None
 
2488
                if f_ie:
 
2489
                    c = 'V'
 
2490
                elif self.is_ignored(fp[1:]):
 
2491
                    c = 'I'
 
2492
                else:
 
2493
                    # we may not have found this file, because of a unicode
 
2494
                    # issue, or because the directory was actually a symlink.
 
2495
                    f_norm, can_access = osutils.normalized_filename(f)
 
2496
                    if f == f_norm or not can_access:
 
2497
                        # No change, so treat this file normally
 
2498
                        c = '?'
 
2499
                    else:
 
2500
                        # this file can be accessed by a normalized path
 
2501
                        # check again if it is versioned
 
2502
                        # these lines are repeated here for performance
 
2503
                        f = f_norm
 
2504
                        fp = from_dir_relpath + '/' + f
 
2505
                        fap = from_dir_abspath + '/' + f
 
2506
                        f_ie = inv.get_child(from_dir_id, f)
 
2507
                        if f_ie:
 
2508
                            c = 'V'
 
2509
                        elif self.is_ignored(fp[1:]):
 
2510
                            c = 'I'
 
2511
                        else:
 
2512
                            c = '?'
 
2513
 
 
2514
                fk = file_kind(fap)
 
2515
 
 
2516
                # make a last minute entry
 
2517
                if f_ie:
 
2518
                    yield fp[1:], c, fk, f_ie.file_id, f_ie
 
2519
                else:
 
2520
                    try:
 
2521
                        yield fp[1:], c, fk, None, fk_entries[fk]()
 
2522
                    except KeyError:
 
2523
                        yield fp[1:], c, fk, None, TreeEntry()
 
2524
                    continue
 
2525
 
 
2526
                if fk != 'directory':
 
2527
                    continue
 
2528
 
 
2529
                # But do this child first if recursing down
 
2530
                if recursive:
 
2531
                    new_children = os.listdir(fap)
 
2532
                    new_children.sort()
 
2533
                    new_children = collections.deque(new_children)
 
2534
                    stack.append((f_ie.file_id, fp, fap, new_children))
 
2535
                    # Break out of inner loop,
 
2536
                    # so that we start outer loop with child
 
2537
                    break
 
2538
            else:
 
2539
                # if we finished all children, pop it off the stack
 
2540
                stack.pop()
 
2541
 
 
2542
    @needs_tree_write_lock
 
2543
    def move(self, from_paths, to_dir=None, after=False):
 
2544
        """Rename files.
 
2545
 
 
2546
        to_dir must exist in the inventory.
 
2547
 
 
2548
        If to_dir exists and is a directory, the files are moved into
 
2549
        it, keeping their old names.
 
2550
 
 
2551
        Note that to_dir is only the last component of the new name;
 
2552
        this doesn't change the directory.
 
2553
 
 
2554
        For each entry in from_paths the move mode will be determined
 
2555
        independently.
 
2556
 
 
2557
        The first mode moves the file in the filesystem and updates the
 
2558
        inventory. The second mode only updates the inventory without
 
2559
        touching the file on the filesystem.
 
2560
 
 
2561
        move uses the second mode if 'after == True' and the target is not
 
2562
        versioned but present in the working tree.
 
2563
 
 
2564
        move uses the second mode if 'after == False' and the source is
 
2565
        versioned but no longer in the working tree, and the target is not
 
2566
        versioned but present in the working tree.
 
2567
 
 
2568
        move uses the first mode if 'after == False' and the source is
 
2569
        versioned and present in the working tree, and the target is not
 
2570
        versioned and not present in the working tree.
 
2571
 
 
2572
        Everything else results in an error.
 
2573
 
 
2574
        This returns a list of (from_path, to_path) pairs for each
 
2575
        entry that is moved.
 
2576
        """
 
2577
        rename_entries = []
 
2578
        rename_tuples = []
 
2579
 
 
2580
        # check for deprecated use of signature
 
2581
        if to_dir is None:
 
2582
            raise TypeError('You must supply a target directory')
 
2583
        # check destination directory
 
2584
        if isinstance(from_paths, basestring):
 
2585
            raise ValueError()
 
2586
        inv = self.inventory
 
2587
        to_abs = self.abspath(to_dir)
 
2588
        if not isdir(to_abs):
 
2589
            raise errors.BzrMoveFailedError('',to_dir,
 
2590
                errors.NotADirectory(to_abs))
 
2591
        if not self.has_filename(to_dir):
 
2592
            raise errors.BzrMoveFailedError('',to_dir,
 
2593
                errors.NotInWorkingDirectory(to_dir))
 
2594
        to_dir_id = inv.path2id(to_dir)
 
2595
        if to_dir_id is None:
 
2596
            raise errors.BzrMoveFailedError('',to_dir,
 
2597
                errors.NotVersionedError(path=to_dir))
 
2598
 
 
2599
        to_dir_ie = inv[to_dir_id]
 
2600
        if to_dir_ie.kind != 'directory':
 
2601
            raise errors.BzrMoveFailedError('',to_dir,
 
2602
                errors.NotADirectory(to_abs))
 
2603
 
 
2604
        # create rename entries and tuples
 
2605
        for from_rel in from_paths:
 
2606
            from_tail = splitpath(from_rel)[-1]
 
2607
            from_id = inv.path2id(from_rel)
 
2608
            if from_id is None:
 
2609
                raise errors.BzrMoveFailedError(from_rel,to_dir,
 
2610
                    errors.NotVersionedError(path=from_rel))
 
2611
 
 
2612
            from_entry = inv[from_id]
 
2613
            from_parent_id = from_entry.parent_id
 
2614
            to_rel = pathjoin(to_dir, from_tail)
 
2615
            rename_entry = InventoryWorkingTree._RenameEntry(
 
2616
                from_rel=from_rel,
 
2617
                from_id=from_id,
 
2618
                from_tail=from_tail,
 
2619
                from_parent_id=from_parent_id,
 
2620
                to_rel=to_rel, to_tail=from_tail,
 
2621
                to_parent_id=to_dir_id)
 
2622
            rename_entries.append(rename_entry)
 
2623
            rename_tuples.append((from_rel, to_rel))
 
2624
 
 
2625
        # determine which move mode to use. checks also for movability
 
2626
        rename_entries = self._determine_mv_mode(rename_entries, after)
 
2627
 
 
2628
        original_modified = self._inventory_is_modified
 
2629
        try:
 
2630
            if len(from_paths):
 
2631
                self._inventory_is_modified = True
 
2632
            self._move(rename_entries)
 
2633
        except:
 
2634
            # restore the inventory on error
 
2635
            self._inventory_is_modified = original_modified
 
2636
            raise
 
2637
        self._write_inventory(inv)
 
2638
        return rename_tuples
 
2639
 
 
2640
    @needs_tree_write_lock
 
2641
    def rename_one(self, from_rel, to_rel, after=False):
 
2642
        """Rename one file.
 
2643
 
 
2644
        This can change the directory or the filename or both.
 
2645
 
 
2646
        rename_one has several 'modes' to work. First, it can rename a physical
 
2647
        file and change the file_id. That is the normal mode. Second, it can
 
2648
        only change the file_id without touching any physical file.
 
2649
 
 
2650
        rename_one uses the second mode if 'after == True' and 'to_rel' is not
 
2651
        versioned but present in the working tree.
 
2652
 
 
2653
        rename_one uses the second mode if 'after == False' and 'from_rel' is
 
2654
        versioned but no longer in the working tree, and 'to_rel' is not
 
2655
        versioned but present in the working tree.
 
2656
 
 
2657
        rename_one uses the first mode if 'after == False' and 'from_rel' is
 
2658
        versioned and present in the working tree, and 'to_rel' is not
 
2659
        versioned and not present in the working tree.
 
2660
 
 
2661
        Everything else results in an error.
 
2662
        """
 
2663
        inv = self.inventory
 
2664
        rename_entries = []
 
2665
 
 
2666
        # create rename entries and tuples
 
2667
        from_tail = splitpath(from_rel)[-1]
 
2668
        from_id = inv.path2id(from_rel)
 
2669
        if from_id is None:
 
2670
            # if file is missing in the inventory maybe it's in the basis_tree
 
2671
            basis_tree = self.branch.basis_tree()
 
2672
            from_id = basis_tree.path2id(from_rel)
 
2673
            if from_id is None:
 
2674
                raise errors.BzrRenameFailedError(from_rel,to_rel,
 
2675
                    errors.NotVersionedError(path=from_rel))
 
2676
            # put entry back in the inventory so we can rename it
 
2677
            from_entry = basis_tree.inventory[from_id].copy()
 
2678
            inv.add(from_entry)
 
2679
        else:
 
2680
            from_entry = inv[from_id]
 
2681
        from_parent_id = from_entry.parent_id
 
2682
        to_dir, to_tail = os.path.split(to_rel)
 
2683
        to_dir_id = inv.path2id(to_dir)
 
2684
        rename_entry = InventoryWorkingTree._RenameEntry(from_rel=from_rel,
 
2685
                                     from_id=from_id,
 
2686
                                     from_tail=from_tail,
 
2687
                                     from_parent_id=from_parent_id,
 
2688
                                     to_rel=to_rel, to_tail=to_tail,
 
2689
                                     to_parent_id=to_dir_id)
 
2690
        rename_entries.append(rename_entry)
 
2691
 
 
2692
        # determine which move mode to use. checks also for movability
 
2693
        rename_entries = self._determine_mv_mode(rename_entries, after)
 
2694
 
 
2695
        # check if the target changed directory and if the target directory is
 
2696
        # versioned
 
2697
        if to_dir_id is None:
 
2698
            raise errors.BzrMoveFailedError(from_rel,to_rel,
 
2699
                errors.NotVersionedError(path=to_dir))
 
2700
 
 
2701
        # all checks done. now we can continue with our actual work
 
2702
        mutter('rename_one:\n'
 
2703
               '  from_id   {%s}\n'
 
2704
               '  from_rel: %r\n'
 
2705
               '  to_rel:   %r\n'
 
2706
               '  to_dir    %r\n'
 
2707
               '  to_dir_id {%s}\n',
 
2708
               from_id, from_rel, to_rel, to_dir, to_dir_id)
 
2709
 
 
2710
        self._move(rename_entries)
 
2711
        self._write_inventory(inv)
 
2712
 
 
2713
    class _RenameEntry(object):
 
2714
        def __init__(self, from_rel, from_id, from_tail, from_parent_id,
 
2715
                     to_rel, to_tail, to_parent_id, only_change_inv=False):
 
2716
            self.from_rel = from_rel
 
2717
            self.from_id = from_id
 
2718
            self.from_tail = from_tail
 
2719
            self.from_parent_id = from_parent_id
 
2720
            self.to_rel = to_rel
 
2721
            self.to_tail = to_tail
 
2722
            self.to_parent_id = to_parent_id
 
2723
            self.only_change_inv = only_change_inv
 
2724
 
 
2725
    def _determine_mv_mode(self, rename_entries, after=False):
 
2726
        """Determines for each from-to pair if both inventory and working tree
 
2727
        or only the inventory has to be changed.
 
2728
 
 
2729
        Also does basic plausability tests.
 
2730
        """
 
2731
        inv = self.inventory
 
2732
 
 
2733
        for rename_entry in rename_entries:
 
2734
            # store to local variables for easier reference
 
2735
            from_rel = rename_entry.from_rel
 
2736
            from_id = rename_entry.from_id
 
2737
            to_rel = rename_entry.to_rel
 
2738
            to_id = inv.path2id(to_rel)
 
2739
            only_change_inv = False
 
2740
 
 
2741
            # check the inventory for source and destination
 
2742
            if from_id is None:
 
2743
                raise errors.BzrMoveFailedError(from_rel,to_rel,
 
2744
                    errors.NotVersionedError(path=from_rel))
 
2745
            if to_id is not None:
 
2746
                raise errors.BzrMoveFailedError(from_rel,to_rel,
 
2747
                    errors.AlreadyVersionedError(path=to_rel))
 
2748
 
 
2749
            # try to determine the mode for rename (only change inv or change
 
2750
            # inv and file system)
 
2751
            if after:
 
2752
                if not self.has_filename(to_rel):
 
2753
                    raise errors.BzrMoveFailedError(from_id,to_rel,
 
2754
                        errors.NoSuchFile(path=to_rel,
 
2755
                        extra="New file has not been created yet"))
 
2756
                only_change_inv = True
 
2757
            elif not self.has_filename(from_rel) and self.has_filename(to_rel):
 
2758
                only_change_inv = True
 
2759
            elif self.has_filename(from_rel) and not self.has_filename(to_rel):
 
2760
                only_change_inv = False
 
2761
            elif (not self.case_sensitive
 
2762
                  and from_rel.lower() == to_rel.lower()
 
2763
                  and self.has_filename(from_rel)):
 
2764
                only_change_inv = False
 
2765
            else:
 
2766
                # something is wrong, so lets determine what exactly
 
2767
                if not self.has_filename(from_rel) and \
 
2768
                   not self.has_filename(to_rel):
 
2769
                    raise errors.BzrRenameFailedError(from_rel,to_rel,
 
2770
                        errors.PathsDoNotExist(paths=(str(from_rel),
 
2771
                        str(to_rel))))
 
2772
                else:
 
2773
                    raise errors.RenameFailedFilesExist(from_rel, to_rel)
 
2774
            rename_entry.only_change_inv = only_change_inv
 
2775
        return rename_entries
 
2776
 
 
2777
    def _move(self, rename_entries):
 
2778
        """Moves a list of files.
 
2779
 
 
2780
        Depending on the value of the flag 'only_change_inv', the
 
2781
        file will be moved on the file system or not.
 
2782
        """
 
2783
        inv = self.inventory
 
2784
        moved = []
 
2785
 
 
2786
        for entry in rename_entries:
 
2787
            try:
 
2788
                self._move_entry(entry)
 
2789
            except:
 
2790
                self._rollback_move(moved)
 
2791
                raise
 
2792
            moved.append(entry)
 
2793
 
 
2794
    def _rollback_move(self, moved):
 
2795
        """Try to rollback a previous move in case of an filesystem error."""
 
2796
        inv = self.inventory
 
2797
        for entry in moved:
 
2798
            try:
 
2799
                self._move_entry(WorkingTree._RenameEntry(
 
2800
                    entry.to_rel, entry.from_id,
 
2801
                    entry.to_tail, entry.to_parent_id, entry.from_rel,
 
2802
                    entry.from_tail, entry.from_parent_id,
 
2803
                    entry.only_change_inv))
 
2804
            except errors.BzrMoveFailedError, e:
 
2805
                raise errors.BzrMoveFailedError( '', '', "Rollback failed."
 
2806
                        " The working tree is in an inconsistent state."
 
2807
                        " Please consider doing a 'bzr revert'."
 
2808
                        " Error message is: %s" % e)
 
2809
 
 
2810
    def _move_entry(self, entry):
 
2811
        inv = self.inventory
 
2812
        from_rel_abs = self.abspath(entry.from_rel)
 
2813
        to_rel_abs = self.abspath(entry.to_rel)
 
2814
        if from_rel_abs == to_rel_abs:
 
2815
            raise errors.BzrMoveFailedError(entry.from_rel, entry.to_rel,
 
2816
                "Source and target are identical.")
 
2817
 
 
2818
        if not entry.only_change_inv:
 
2819
            try:
 
2820
                osutils.rename(from_rel_abs, to_rel_abs)
 
2821
            except OSError, e:
 
2822
                raise errors.BzrMoveFailedError(entry.from_rel,
 
2823
                    entry.to_rel, e[1])
 
2824
        inv.rename(entry.from_id, entry.to_parent_id, entry.to_tail)
 
2825
 
 
2826
    @needs_tree_write_lock
 
2827
    def unversion(self, file_ids):
 
2828
        """Remove the file ids in file_ids from the current versioned set.
 
2829
 
 
2830
        When a file_id is unversioned, all of its children are automatically
 
2831
        unversioned.
 
2832
 
 
2833
        :param file_ids: The file ids to stop versioning.
 
2834
        :raises: NoSuchId if any fileid is not currently versioned.
 
2835
        """
 
2836
        for file_id in file_ids:
 
2837
            if file_id not in self._inventory:
 
2838
                raise errors.NoSuchId(self, file_id)
 
2839
        for file_id in file_ids:
 
2840
            if self._inventory.has_id(file_id):
 
2841
                self._inventory.remove_recursive_id(file_id)
 
2842
        if len(file_ids):
 
2843
            # in the future this should just set a dirty bit to wait for the
 
2844
            # final unlock. However, until all methods of workingtree start
 
2845
            # with the current in -memory inventory rather than triggering
 
2846
            # a read, it is more complex - we need to teach read_inventory
 
2847
            # to know when to read, and when to not read first... and possibly
 
2848
            # to save first when the in memory one may be corrupted.
 
2849
            # so for now, we just only write it if it is indeed dirty.
 
2850
            # - RBC 20060907
 
2851
            self._write_inventory(self._inventory)
 
2852
 
 
2853
    def stored_kind(self, file_id):
 
2854
        """See Tree.stored_kind"""
 
2855
        return self.inventory[file_id].kind
 
2856
 
 
2857
    def extras(self):
 
2858
        """Yield all unversioned files in this WorkingTree.
 
2859
 
 
2860
        If there are any unversioned directories then only the directory is
 
2861
        returned, not all its children.  But if there are unversioned files
 
2862
        under a versioned subdirectory, they are returned.
 
2863
 
 
2864
        Currently returned depth-first, sorted by name within directories.
 
2865
        This is the same order used by 'osutils.walkdirs'.
 
2866
        """
 
2867
        ## TODO: Work from given directory downwards
 
2868
        for path, dir_entry in self.inventory.directories():
 
2869
            # mutter("search for unknowns in %r", path)
 
2870
            dirabs = self.abspath(path)
 
2871
            if not isdir(dirabs):
 
2872
                # e.g. directory deleted
 
2873
                continue
 
2874
 
 
2875
            fl = []
 
2876
            for subf in os.listdir(dirabs):
 
2877
                if self.bzrdir.is_control_filename(subf):
 
2878
                    continue
 
2879
                if subf not in dir_entry.children:
 
2880
                    try:
 
2881
                        (subf_norm,
 
2882
                         can_access) = osutils.normalized_filename(subf)
 
2883
                    except UnicodeDecodeError:
 
2884
                        path_os_enc = path.encode(osutils._fs_enc)
 
2885
                        relpath = path_os_enc + '/' + subf
 
2886
                        raise errors.BadFilenameEncoding(relpath,
 
2887
                                                         osutils._fs_enc)
 
2888
                    if subf_norm != subf and can_access:
 
2889
                        if subf_norm not in dir_entry.children:
 
2890
                            fl.append(subf_norm)
 
2891
                    else:
 
2892
                        fl.append(subf)
 
2893
 
 
2894
            fl.sort()
 
2895
            for subf in fl:
 
2896
                subp = pathjoin(path, subf)
 
2897
                yield subp
 
2898
 
 
2899
    def _walkdirs(self, prefix=""):
 
2900
        """Walk the directories of this tree.
 
2901
 
 
2902
           :prefix: is used as the directrory to start with.
 
2903
           returns a generator which yields items in the form:
 
2904
                ((curren_directory_path, fileid),
 
2905
                 [(file1_path, file1_name, file1_kind, None, file1_id,
 
2906
                   file1_kind), ... ])
 
2907
        """
 
2908
        _directory = 'directory'
 
2909
        # get the root in the inventory
 
2910
        inv = self.inventory
 
2911
        top_id = inv.path2id(prefix)
 
2912
        if top_id is None:
 
2913
            pending = []
 
2914
        else:
 
2915
            pending = [(prefix, '', _directory, None, top_id, None)]
 
2916
        while pending:
 
2917
            dirblock = []
 
2918
            currentdir = pending.pop()
 
2919
            # 0 - relpath, 1- basename, 2- kind, 3- stat, 4-id, 5-kind
 
2920
            top_id = currentdir[4]
 
2921
            if currentdir[0]:
 
2922
                relroot = currentdir[0] + '/'
 
2923
            else:
 
2924
                relroot = ""
 
2925
            # FIXME: stash the node in pending
 
2926
            entry = inv[top_id]
 
2927
            if entry.kind == 'directory':
 
2928
                for name, child in entry.sorted_children():
 
2929
                    dirblock.append((relroot + name, name, child.kind, None,
 
2930
                        child.file_id, child.kind
 
2931
                        ))
 
2932
            yield (currentdir[0], entry.file_id), dirblock
 
2933
            # push the user specified dirs from dirblock
 
2934
            for dir in reversed(dirblock):
 
2935
                if dir[2] == _directory:
 
2936
                    pending.append(dir)
 
2937
 
 
2938
 
 
2939
class WorkingTreeFormatRegistry(controldir.ControlComponentFormatRegistry):
 
2940
    """Registry for working tree formats."""
 
2941
 
 
2942
    def __init__(self, other_registry=None):
 
2943
        super(WorkingTreeFormatRegistry, self).__init__(other_registry)
 
2944
        self._default_format = None
 
2945
        self._default_format_key = None
 
2946
 
 
2947
    def get_default(self):
 
2948
        """Return the current default format."""
 
2949
        if (self._default_format_key is not None and
 
2950
            self._default_format is None):
 
2951
            self._default_format = self.get(self._default_format_key)
 
2952
        return self._default_format
 
2953
 
 
2954
    def set_default(self, format):
 
2955
        """Set the default format."""
 
2956
        self._default_format = format
 
2957
        self._default_format_key = None
 
2958
 
 
2959
    def set_default_key(self, format_string):
 
2960
        """Set the default format by its format string."""
 
2961
        self._default_format_key = format_string
 
2962
        self._default_format = None
 
2963
 
 
2964
 
 
2965
format_registry = WorkingTreeFormatRegistry()
 
2966
 
 
2967
 
 
2968
class WorkingTreeFormat(controldir.ControlComponentFormat):
2750
2969
    """An encapsulation of the initialization and open routines for a format.
2751
2970
 
2752
2971
    Formats provide three things:
2764
2983
    object will be created every time regardless.
2765
2984
    """
2766
2985
 
2767
 
    _default_format = None
2768
 
    """The default format used for new trees."""
2769
 
 
2770
 
    _formats = {}
2771
 
    """The known formats."""
2772
 
 
2773
2986
    requires_rich_root = False
2774
2987
 
2775
2988
    upgrade_recommended = False
2776
2989
 
 
2990
    requires_normalized_unicode_filenames = False
 
2991
 
 
2992
    case_sensitive_filename = "FoRMaT"
 
2993
 
 
2994
    missing_parent_conflicts = False
 
2995
    """If this format supports missing parent conflicts."""
 
2996
 
 
2997
    @classmethod
 
2998
    def find_format_string(klass, a_bzrdir):
 
2999
        """Return format name for the working tree object in a_bzrdir."""
 
3000
        try:
 
3001
            transport = a_bzrdir.get_workingtree_transport(None)
 
3002
            return transport.get_bytes("format")
 
3003
        except errors.NoSuchFile:
 
3004
            raise errors.NoWorkingTree(base=transport.base)
 
3005
 
2777
3006
    @classmethod
2778
3007
    def find_format(klass, a_bzrdir):
2779
3008
        """Return the format for the working tree object in a_bzrdir."""
2780
3009
        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)
 
3010
            format_string = klass.find_format_string(a_bzrdir)
 
3011
            return format_registry.get(format_string)
2786
3012
        except KeyError:
2787
3013
            raise errors.UnknownFormatError(format=format_string,
2788
3014
                                            kind="working tree")
2789
3015
 
 
3016
    def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
 
3017
                   accelerator_tree=None, hardlink=False):
 
3018
        """Initialize a new working tree in a_bzrdir.
 
3019
 
 
3020
        :param a_bzrdir: BzrDir to initialize the working tree in.
 
3021
        :param revision_id: allows creating a working tree at a different
 
3022
            revision than the branch is at.
 
3023
        :param from_branch: Branch to checkout
 
3024
        :param accelerator_tree: A tree which can be used for retrieving file
 
3025
            contents more quickly than the revision tree, i.e. a workingtree.
 
3026
            The revision tree will be used for cases where accelerator_tree's
 
3027
            content is different.
 
3028
        :param hardlink: If true, hard-link files from accelerator_tree,
 
3029
            where possible.
 
3030
        """
 
3031
        raise NotImplementedError(self.initialize)
 
3032
 
2790
3033
    def __eq__(self, other):
2791
3034
        return self.__class__ is other.__class__
2792
3035
 
2794
3037
        return not (self == other)
2795
3038
 
2796
3039
    @classmethod
 
3040
    @symbol_versioning.deprecated_method(
 
3041
        symbol_versioning.deprecated_in((2, 4, 0)))
2797
3042
    def get_default_format(klass):
2798
3043
        """Return the current default format."""
2799
 
        return klass._default_format
 
3044
        return format_registry.get_default()
2800
3045
 
2801
3046
    def get_format_string(self):
2802
3047
        """Return the ASCII format string that identifies this format."""
2824
3069
        return False
2825
3070
 
2826
3071
    @classmethod
 
3072
    @symbol_versioning.deprecated_method(
 
3073
        symbol_versioning.deprecated_in((2, 4, 0)))
2827
3074
    def register_format(klass, format):
2828
 
        klass._formats[format.get_format_string()] = format
2829
 
 
2830
 
    @classmethod
 
3075
        format_registry.register(format)
 
3076
 
 
3077
    @classmethod
 
3078
    @symbol_versioning.deprecated_method(
 
3079
        symbol_versioning.deprecated_in((2, 4, 0)))
 
3080
    def register_extra_format(klass, format):
 
3081
        format_registry.register_extra(format)
 
3082
 
 
3083
    @classmethod
 
3084
    @symbol_versioning.deprecated_method(
 
3085
        symbol_versioning.deprecated_in((2, 4, 0)))
 
3086
    def unregister_extra_format(klass, format):
 
3087
        format_registry.unregister_extra(format)
 
3088
 
 
3089
    @classmethod
 
3090
    @symbol_versioning.deprecated_method(
 
3091
        symbol_versioning.deprecated_in((2, 4, 0)))
 
3092
    def get_formats(klass):
 
3093
        return format_registry._get_all()
 
3094
 
 
3095
    @classmethod
 
3096
    @symbol_versioning.deprecated_method(
 
3097
        symbol_versioning.deprecated_in((2, 4, 0)))
2831
3098
    def set_default_format(klass, format):
2832
 
        klass._default_format = format
 
3099
        format_registry.set_default(format)
2833
3100
 
2834
3101
    @classmethod
 
3102
    @symbol_versioning.deprecated_method(
 
3103
        symbol_versioning.deprecated_in((2, 4, 0)))
2835
3104
    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
 
                   ]
 
3105
        format_registry.remove(format)
 
3106
 
 
3107
 
 
3108
format_registry.register_lazy("Bazaar Working Tree Format 4 (bzr 0.15)\n",
 
3109
    "bzrlib.workingtree_4", "WorkingTreeFormat4")
 
3110
format_registry.register_lazy("Bazaar Working Tree Format 5 (bzr 1.11)\n",
 
3111
    "bzrlib.workingtree_4", "WorkingTreeFormat5")
 
3112
format_registry.register_lazy("Bazaar Working Tree Format 6 (bzr 1.14)\n",
 
3113
    "bzrlib.workingtree_4", "WorkingTreeFormat6")
 
3114
format_registry.register_lazy("Bazaar-NG Working Tree format 3",
 
3115
    "bzrlib.workingtree_3", "WorkingTreeFormat3")
 
3116
format_registry.set_default_key("Bazaar Working Tree Format 6 (bzr 1.14)\n")