/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to bzrlib/workingtree.py

  • Committer: Jelmer Vernooij
  • Date: 2011-05-03 23:16:56 UTC
  • mto: This revision was merged to the branch mainline in revision 5819.
  • Revision ID: jelmer@samba.org-20110503231656-4sxm717yejm8cpuw
Add tariff test to make sure working tree isn't opened by 'bzr serve'
that simply accesses a branch.

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
 
75
from bzrlib.lock import LogicalLockResult
80
76
from bzrlib.lockable_files import LockableFiles
81
77
from bzrlib.lockdir import LockDir
82
78
import bzrlib.mutabletree
92
88
    splitpath,
93
89
    supports_executable,
94
90
    )
95
 
from bzrlib.filters import filtered_input_file
96
91
from bzrlib.trace import mutter, note
97
92
from bzrlib.transport.local import LocalTransport
98
93
from bzrlib.revision import CURRENT_REVISION
99
 
from bzrlib.rio import RioReader, rio_file, Stanza
100
94
from bzrlib.symbol_versioning import (
101
95
    deprecated_passed,
102
96
    DEPRECATED_PARAMETER,
168
162
 
169
163
 
170
164
class WorkingTree(bzrlib.mutabletree.MutableTree,
171
 
    bzrdir.ControlComponent):
 
165
    controldir.ControlComponent):
172
166
    """Working copy tree.
173
167
 
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.
 
168
    :ivar basedir: The root of the tree on disk. This is a unicode path object
 
169
        (as opposed to a URL).
179
170
    """
180
171
 
181
172
    # override this to set the strategy for storing views
184
175
 
185
176
    def __init__(self, basedir='.',
186
177
                 branch=DEPRECATED_PARAMETER,
187
 
                 _inventory=None,
188
178
                 _control_files=None,
189
179
                 _internal=False,
190
180
                 _format=None,
205
195
        else:
206
196
            self._branch = self.bzrdir.open_branch()
207
197
        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
 
198
        self._control_files = _control_files
215
199
        self._transport = self._control_files._transport
216
200
        # update the whole cache up front and write to disk if anything changed;
217
201
        # in the future we might want to do this more selectively
233
217
            mutter("write hc")
234
218
            hc.write()
235
219
 
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
220
        self._detect_case_handling()
247
221
        self._rules_searcher = None
248
222
        self.views = self._make_views()
255
229
    def control_transport(self):
256
230
        return self._transport
257
231
 
 
232
    def is_control_filename(self, filename):
 
233
        """True if filename is the name of a control file in this tree.
 
234
 
 
235
        :param filename: A filename within the tree. This is a relative path
 
236
        from the root of this tree.
 
237
 
 
238
        This is true IF and ONLY IF the filename is part of the meta data
 
239
        that bzr controls in this tree. I.E. a random .bzr directory placed
 
240
        on disk will not be a control file for this tree.
 
241
        """
 
242
        return self.bzrdir.is_control_filename(filename)
 
243
 
258
244
    def _detect_case_handling(self):
259
245
        wt_trans = self.bzrdir.get_workingtree_transport(None)
260
246
        try:
261
 
            wt_trans.stat("FoRMaT")
 
247
            wt_trans.stat(self._format.case_sensitive_filename)
262
248
        except errors.NoSuchFile:
263
249
            self.case_sensitive = True
264
250
        else:
307
293
    def supports_views(self):
308
294
        return self.views.supports_views()
309
295
 
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
296
    @staticmethod
324
297
    def open(path=None, _unsupported=False):
325
298
        """Open an existing working tree at path.
346
319
        if path is None:
347
320
            path = osutils.getcwd()
348
321
        control, relpath = bzrdir.BzrDir.open_containing(path)
349
 
 
350
322
        return control.open_workingtree(), relpath
351
323
 
352
324
    @staticmethod
 
325
    def open_containing_paths(file_list, default_directory=None,
 
326
                              canonicalize=True, apply_view=True):
 
327
        """Open the WorkingTree that contains a set of paths.
 
328
 
 
329
        Fail if the paths given are not all in a single tree.
 
330
 
 
331
        This is used for the many command-line interfaces that take a list of
 
332
        any number of files and that require they all be in the same tree.
 
333
        """
 
334
        if default_directory is None:
 
335
            default_directory = u'.'
 
336
        # recommended replacement for builtins.internal_tree_files
 
337
        if file_list is None or len(file_list) == 0:
 
338
            tree = WorkingTree.open_containing(default_directory)[0]
 
339
            # XXX: doesn't really belong here, and seems to have the strange
 
340
            # side effect of making it return a bunch of files, not the whole
 
341
            # tree -- mbp 20100716
 
342
            if tree.supports_views() and apply_view:
 
343
                view_files = tree.views.lookup_view()
 
344
                if view_files:
 
345
                    file_list = view_files
 
346
                    view_str = views.view_display_str(view_files)
 
347
                    note("Ignoring files outside view. View is %s" % view_str)
 
348
            return tree, file_list
 
349
        if default_directory == u'.':
 
350
            seed = file_list[0]
 
351
        else:
 
352
            seed = default_directory
 
353
            file_list = [osutils.pathjoin(default_directory, f)
 
354
                         for f in file_list]
 
355
        tree = WorkingTree.open_containing(seed)[0]
 
356
        return tree, tree.safe_relpath_files(file_list, canonicalize,
 
357
                                             apply_view=apply_view)
 
358
 
 
359
    def safe_relpath_files(self, file_list, canonicalize=True, apply_view=True):
 
360
        """Convert file_list into a list of relpaths in tree.
 
361
 
 
362
        :param self: A tree to operate on.
 
363
        :param file_list: A list of user provided paths or None.
 
364
        :param apply_view: if True and a view is set, apply it or check that
 
365
            specified files are within it
 
366
        :return: A list of relative paths.
 
367
        :raises errors.PathNotChild: When a provided path is in a different self
 
368
            than self.
 
369
        """
 
370
        if file_list is None:
 
371
            return None
 
372
        if self.supports_views() and apply_view:
 
373
            view_files = self.views.lookup_view()
 
374
        else:
 
375
            view_files = []
 
376
        new_list = []
 
377
        # self.relpath exists as a "thunk" to osutils, but canonical_relpath
 
378
        # doesn't - fix that up here before we enter the loop.
 
379
        if canonicalize:
 
380
            fixer = lambda p: osutils.canonical_relpath(self.basedir, p)
 
381
        else:
 
382
            fixer = self.relpath
 
383
        for filename in file_list:
 
384
            relpath = fixer(osutils.dereference_path(filename))
 
385
            if view_files and not osutils.is_inside_any(view_files, relpath):
 
386
                raise errors.FileOutsideView(filename, view_files)
 
387
            new_list.append(relpath)
 
388
        return new_list
 
389
 
 
390
    @staticmethod
353
391
    def open_downlevel(path=None):
354
392
        """Open an unsupported working tree.
355
393
 
368
406
                return True, None
369
407
            else:
370
408
                return True, tree
371
 
        transport = get_transport(location)
372
 
        iterator = bzrdir.BzrDir.find_bzrdirs(transport, evaluate=evaluate,
 
409
        t = transport.get_transport(location)
 
410
        iterator = bzrdir.BzrDir.find_bzrdirs(t, evaluate=evaluate,
373
411
                                              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
 
412
        return [tr for tr in iterator if tr is not None]
389
413
 
390
414
    def all_file_ids(self):
391
415
        """See Tree.iter_all_file_ids"""
392
 
        return set(self.inventory)
 
416
        raise NotImplementedError(self.all_file_ids)
393
417
 
394
418
    def __repr__(self):
395
419
        return "<%s of %s>" % (self.__class__.__name__,
450
474
        return self.get_file_with_stat(file_id, path, filtered=filtered)[0]
451
475
 
452
476
    def get_file_with_stat(self, file_id, path=None, filtered=True,
453
 
        _fstat=os.fstat):
 
477
                           _fstat=osutils.fstat):
454
478
        """See Tree.get_file_with_stat."""
455
479
        if path is None:
456
480
            path = self.id2path(file_id)
458
482
        stat_value = _fstat(file_obj.fileno())
459
483
        if filtered and self.supports_content_filtering():
460
484
            filters = self._content_filter_stack(path)
461
 
            file_obj = filtered_input_file(file_obj, filters)
 
485
            file_obj = _mod_filters.filtered_input_file(file_obj, filters)
462
486
        return (file_obj, stat_value)
463
487
 
464
488
    def get_file_text(self, file_id, path=None, filtered=True):
465
 
        return self.get_file(file_id, path=path, filtered=filtered).read()
 
489
        my_file = self.get_file(file_id, path=path, filtered=filtered)
 
490
        try:
 
491
            return my_file.read()
 
492
        finally:
 
493
            my_file.close()
466
494
 
467
495
    def get_file_byname(self, filename, filtered=True):
468
496
        path = self.abspath(filename)
469
497
        f = file(path, 'rb')
470
498
        if filtered and self.supports_content_filtering():
471
499
            filters = self._content_filter_stack(filename)
472
 
            return filtered_input_file(f, filters)
 
500
            return _mod_filters.filtered_input_file(f, filters)
473
501
        else:
474
502
            return f
475
503
 
481
509
        finally:
482
510
            file.close()
483
511
 
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
512
    def _get_ancestors(self, default_revision):
533
513
        ancestors = set([default_revision])
534
514
        for parent_id in self.get_parent_ids():
557
537
                parents.append(revision_id)
558
538
        return parents
559
539
 
560
 
    @needs_read_lock
561
540
    def get_root_id(self):
562
541
        """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))
 
542
        raise NotImplementedError(self.get_root_id)
568
543
 
569
544
    @needs_read_lock
570
545
    def clone(self, to_bzrdir, revision_id=None):
600
575
    def id2abspath(self, file_id):
601
576
        return self.abspath(self.id2path(file_id))
602
577
 
603
 
    def has_id(self, file_id):
604
 
        # files that have been deleted are excluded
605
 
        inv = self.inventory
606
 
        if not inv.has_id(file_id):
607
 
            return False
608
 
        path = inv.id2path(file_id)
609
 
        return osutils.lexists(self.abspath(path))
610
 
 
611
 
    def has_or_had_id(self, file_id):
612
 
        if file_id == self.inventory.root.file_id:
613
 
            return True
614
 
        return self.inventory.has_id(file_id)
615
 
 
616
 
    __contains__ = has_id
617
 
 
618
578
    def get_file_size(self, file_id):
619
579
        """See Tree.get_file_size"""
620
580
        # XXX: this returns the on-disk size; it should probably return the
627
587
            else:
628
588
                return None
629
589
 
630
 
    @needs_read_lock
631
590
    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
 
591
        # FIXME: Shouldn't this be in Tree?
 
592
        raise NotImplementedError(self.get_file_sha1)
683
593
 
684
594
    @needs_tree_write_lock
685
595
    def _gather_kinds(self, files, kinds):
811
721
            if revision_id in heads and revision_id not in new_revision_ids:
812
722
                new_revision_ids.append(revision_id)
813
723
        if new_revision_ids != revision_ids:
814
 
            trace.mutter('requested to set revision_ids = %s,'
 
724
            mutter('requested to set revision_ids = %s,'
815
725
                         ' but filtered to %s', revision_ids, new_revision_ids)
816
726
        return new_revision_ids
817
727
 
883
793
    def set_merge_modified(self, modified_hashes):
884
794
        def iter_stanzas():
885
795
            for file_id, hash in modified_hashes.iteritems():
886
 
                yield Stanza(file_id=file_id.decode('utf8'), hash=hash)
 
796
                yield _mod_rio.Stanza(file_id=file_id.decode('utf8'),
 
797
                    hash=hash)
887
798
        self._put_rio('merge-hashes', iter_stanzas(), MERGE_MODIFIED_HEADER_1)
888
799
 
889
800
    def _sha_from_stat(self, path, stat_result):
898
809
 
899
810
    def _put_rio(self, filename, stanzas, header):
900
811
        self._must_be_locked()
901
 
        my_file = rio_file(stanzas, header)
 
812
        my_file = _mod_rio.rio_file(stanzas, header)
902
813
        self._transport.put_file(filename, my_file,
903
814
            mode=self.bzrdir._get_file_mode())
904
815
 
946
857
        merger.set_pending()
947
858
        return conflicts
948
859
 
949
 
    @needs_read_lock
950
860
    def merge_modified(self):
951
861
        """Return a dictionary of files modified by a merge.
952
862
 
957
867
        This returns a map of file_id->sha1, containing only files which are
958
868
        still in the working inventory and have that text hash.
959
869
        """
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()
 
870
        raise NotImplementedError(self.merge_modified)
982
871
 
983
872
    @needs_write_lock
984
873
    def mkdir(self, path, file_id=None):
994
883
        target = osutils.readlink(abspath)
995
884
        return target
996
885
 
997
 
    @needs_write_lock
998
886
    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()
 
887
        raise NotImplementedError(self.subsume)
1038
888
 
1039
889
    def _setup_directory_is_tree_reference(self):
1040
890
        if self._branch.repository._format.supports_tree_reference:
1062
912
        # checkout in a subdirectory.  This can be avoided by not adding
1063
913
        # it.  mbp 20070306
1064
914
 
1065
 
    @needs_tree_write_lock
1066
915
    def extract(self, file_id, format=None):
1067
916
        """Extract a subtree from this tree.
1068
917
 
1069
918
        A new branch will be created, relative to the path for this tree.
1070
919
        """
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)
 
920
        raise NotImplementedError(self.extract)
1121
921
 
1122
922
    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
 
923
        """Write the in memory meta data to disk."""
 
924
        raise NotImplementedError(self.flush)
1133
925
 
1134
926
    def _kind(self, relpath):
1135
927
        return osutils.file_kind(self.abspath(relpath))
1145
937
        :param from_dir: start from this directory or None for the root
1146
938
        :param recursive: whether to recurse into subdirectories or not
1147
939
        """
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):
 
940
        raise NotImplementedError(self.list_files)
 
941
 
 
942
    def move(self, from_paths, to_dir=None, after=False):
1261
943
        """Rename files.
1262
944
 
1263
 
        to_dir must exist in the inventory.
 
945
        to_dir must be known to the working tree.
1264
946
 
1265
947
        If to_dir exists and is a directory, the files are moved into
1266
948
        it, keeping their old names.
1272
954
        independently.
1273
955
 
1274
956
        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.
 
957
        working tree metadata. The second mode only updates the working tree
 
958
        metadata without touching the file on the filesystem.
1278
959
 
1279
960
        move uses the second mode if 'after == True' and the target is not
1280
961
        versioned but present in the working tree.
1292
973
        This returns a list of (from_path, to_path) pairs for each
1293
974
        entry that is moved.
1294
975
        """
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)
 
976
        raise NotImplementedError(self.move)
1464
977
 
1465
978
    @needs_tree_write_lock
1466
979
    def rename_one(self, from_rel, to_rel, after=False):
1470
983
 
1471
984
        rename_one has several 'modes' to work. First, it can rename a physical
1472
985
        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.
 
986
        only change the file_id without touching any physical file.
1475
987
 
1476
988
        rename_one uses the second mode if 'after == True' and 'to_rel' is not
1477
989
        versioned but present in the working tree.
1486
998
 
1487
999
        Everything else results in an error.
1488
1000
        """
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
 
1001
        raise NotImplementedError(self.rename_one)
1550
1002
 
1551
1003
    @needs_read_lock
1552
1004
    def unknowns(self):
1560
1012
        return iter(
1561
1013
            [subp for subp in self.extras() if not self.is_ignored(subp)])
1562
1014
 
1563
 
    @needs_tree_write_lock
1564
1015
    def unversion(self, file_ids):
1565
1016
        """Remove the file ids in file_ids from the current versioned set.
1566
1017
 
1570
1021
        :param file_ids: The file ids to stop versioning.
1571
1022
        :raises: NoSuchId if any fileid is not currently versioned.
1572
1023
        """
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
 
1024
        raise NotImplementedError(self.unversion)
1600
1025
 
1601
1026
    @needs_write_lock
1602
1027
    def pull(self, source, overwrite=False, stop_revision=None,
1603
 
             change_reporter=None, possible_transports=None, local=False):
 
1028
             change_reporter=None, possible_transports=None, local=False,
 
1029
             show_base=False):
1604
1030
        source.lock_read()
1605
1031
        try:
1606
1032
            old_revision_info = self.branch.last_revision_info()
1620
1046
                                basis_tree,
1621
1047
                                this_tree=self,
1622
1048
                                pb=None,
1623
 
                                change_reporter=change_reporter)
 
1049
                                change_reporter=change_reporter,
 
1050
                                show_base=show_base)
1624
1051
                    basis_root_id = basis_tree.get_root_id()
1625
1052
                    new_root_id = new_basis_tree.get_root_id()
1626
1053
                    if basis_root_id != new_root_id:
1665
1092
        Currently returned depth-first, sorted by name within directories.
1666
1093
        This is the same order used by 'osutils.walkdirs'.
1667
1094
        """
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
 
1095
        raise NotImplementedError(self.extras)
1699
1096
 
1700
1097
    def ignored_files(self):
1701
1098
        """Yield list of PATH, IGNORE_PATTERN"""
1750
1147
 
1751
1148
    def stored_kind(self, file_id):
1752
1149
        """See Tree.stored_kind"""
1753
 
        return self.inventory[file_id].kind
 
1150
        raise NotImplementedError(self.stored_kind)
1754
1151
 
1755
1152
    def _comparison_data(self, entry, path):
1756
1153
        abspath = self.abspath(path)
1798
1195
            raise errors.ObjectNotLocked(self)
1799
1196
 
1800
1197
    def lock_read(self):
1801
 
        """See Branch.lock_read, and WorkingTree.unlock."""
 
1198
        """Lock the tree for reading.
 
1199
 
 
1200
        This also locks the branch, and can be unlocked via self.unlock().
 
1201
 
 
1202
        :return: A bzrlib.lock.LogicalLockResult.
 
1203
        """
1802
1204
        if not self.is_locked():
1803
1205
            self._reset_data()
1804
1206
        self.branch.lock_read()
1805
1207
        try:
1806
 
            return self._control_files.lock_read()
 
1208
            self._control_files.lock_read()
 
1209
            return LogicalLockResult(self.unlock)
1807
1210
        except:
1808
1211
            self.branch.unlock()
1809
1212
            raise
1810
1213
 
1811
1214
    def lock_tree_write(self):
1812
 
        """See MutableTree.lock_tree_write, and WorkingTree.unlock."""
 
1215
        """See MutableTree.lock_tree_write, and WorkingTree.unlock.
 
1216
 
 
1217
        :return: A bzrlib.lock.LogicalLockResult.
 
1218
        """
1813
1219
        if not self.is_locked():
1814
1220
            self._reset_data()
1815
1221
        self.branch.lock_read()
1816
1222
        try:
1817
 
            return self._control_files.lock_write()
 
1223
            self._control_files.lock_write()
 
1224
            return LogicalLockResult(self.unlock)
1818
1225
        except:
1819
1226
            self.branch.unlock()
1820
1227
            raise
1821
1228
 
1822
1229
    def lock_write(self):
1823
 
        """See MutableTree.lock_write, and WorkingTree.unlock."""
 
1230
        """See MutableTree.lock_write, and WorkingTree.unlock.
 
1231
 
 
1232
        :return: A bzrlib.lock.LogicalLockResult.
 
1233
        """
1824
1234
        if not self.is_locked():
1825
1235
            self._reset_data()
1826
1236
        self.branch.lock_write()
1827
1237
        try:
1828
 
            return self._control_files.lock_write()
 
1238
            self._control_files.lock_write()
 
1239
            return LogicalLockResult(self.unlock)
1829
1240
        except:
1830
1241
            self.branch.unlock()
1831
1242
            raise
1833
1244
    def get_physical_lock_status(self):
1834
1245
        return self._control_files.get_physical_lock_status()
1835
1246
 
1836
 
    def _basis_inventory_name(self):
1837
 
        return 'basis-inventory-cache'
1838
 
 
1839
1247
    def _reset_data(self):
1840
1248
        """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)
 
1249
        raise NotImplementedError(self._reset_data)
1848
1250
 
1849
 
    @needs_tree_write_lock
1850
1251
    def set_last_revision(self, new_revision):
1851
1252
        """Change the last revision in the working tree."""
1852
 
        if self._change_last_revision(new_revision):
1853
 
            self._cache_basis_inventory(new_revision)
 
1253
        raise NotImplementedError(self.set_last_revision)
1854
1254
 
1855
1255
    def _change_last_revision(self, new_revision):
1856
1256
        """Template method part of set_last_revision to perform the change.
1859
1259
        when their last revision is set.
1860
1260
        """
1861
1261
        if _mod_revision.is_null(new_revision):
1862
 
            self.branch.set_revision_history([])
 
1262
            self.branch.set_last_revision_info(0, new_revision)
1863
1263
            return False
1864
1264
        try:
1865
1265
            self.branch.generate_revision_history(new_revision)
1866
1266
        except errors.NoSuchRevision:
1867
1267
            # not present in the repo - dont try to set it deeper than the tip
1868
 
            self.branch.set_revision_history([new_revision])
 
1268
            self.branch._set_revision_history([new_revision])
1869
1269
        return True
1870
1270
 
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
1271
    @needs_tree_write_lock
1937
1272
    def remove(self, files, verbose=False, to_file=None, keep_files=True,
1938
1273
        force=False):
1939
 
        """Remove nominated files from the working inventory.
 
1274
        """Remove nominated files from the working tree metadata.
1940
1275
 
1941
1276
        :files: File paths relative to the basedir.
1942
1277
        :keep_files: If true, the files will also be kept.
1948
1283
 
1949
1284
        inv_delta = []
1950
1285
 
1951
 
        new_files=set()
 
1286
        all_files = set() # specified and nested files 
1952
1287
        unknown_nested_files=set()
1953
1288
        if to_file is None:
1954
1289
            to_file = sys.stdout
1955
1290
 
 
1291
        files_to_backup = []
 
1292
 
1956
1293
        def recurse_directory_to_add_files(directory):
1957
1294
            # Recurse directory and add all files
1958
1295
            # so we can check if they have changed.
1959
 
            for parent_info, file_infos in\
1960
 
                self.walkdirs(directory):
 
1296
            for parent_info, file_infos in self.walkdirs(directory):
1961
1297
                for relpath, basename, kind, lstat, fileid, kind in file_infos:
1962
1298
                    # Is it versioned or ignored?
1963
 
                    if self.path2id(relpath) or self.is_ignored(relpath):
 
1299
                    if self.path2id(relpath):
1964
1300
                        # Add nested content for deletion.
1965
 
                        new_files.add(relpath)
 
1301
                        all_files.add(relpath)
1966
1302
                    else:
1967
 
                        # Files which are not versioned and not ignored
 
1303
                        # Files which are not versioned
1968
1304
                        # should be treated as unknown.
1969
 
                        unknown_nested_files.add((relpath, None, kind))
 
1305
                        files_to_backup.append(relpath)
1970
1306
 
1971
1307
        for filename in files:
1972
1308
            # Get file name into canonical form.
1973
1309
            abspath = self.abspath(filename)
1974
1310
            filename = self.relpath(abspath)
1975
1311
            if len(filename) > 0:
1976
 
                new_files.add(filename)
 
1312
                all_files.add(filename)
1977
1313
                recurse_directory_to_add_files(filename)
1978
1314
 
1979
 
        files = list(new_files)
 
1315
        files = list(all_files)
1980
1316
 
1981
1317
        if len(files) == 0:
1982
1318
            return # nothing to do
1986
1322
 
1987
1323
        # Bail out if we are going to delete files we shouldn't
1988
1324
        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
 
1325
            for (file_id, path, content_change, versioned, parent_id, name,
 
1326
                 kind, executable) in self.iter_changes(self.basis_tree(),
 
1327
                     include_unchanged=True, require_versioned=False,
 
1328
                     want_unversioned=True, specific_files=files):
 
1329
                if versioned[0] == False:
 
1330
                    # The record is unknown or newly added
 
1331
                    files_to_backup.append(path[1])
 
1332
                elif (content_change and (kind[1] is not None) and
 
1333
                        osutils.is_inside_any(files, path[1])):
 
1334
                    # Versioned and changed, but not deleted, and still
 
1335
                    # in one of the dirs to be deleted.
 
1336
                    files_to_backup.append(path[1])
2005
1337
 
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)
 
1338
        def backup(file_to_backup):
 
1339
            backup_name = self.bzrdir._available_backup_name(file_to_backup)
 
1340
            osutils.rename(abs_path, self.abspath(backup_name))
 
1341
            return "removed %s (but kept a copy: %s)" % (file_to_backup,
 
1342
                                                         backup_name)
2015
1343
 
2016
1344
        # Build inv_delta and delete files where applicable,
2017
 
        # do this before any modifications to inventory.
 
1345
        # do this before any modifications to meta data.
2018
1346
        for f in files:
2019
1347
            fid = self.path2id(f)
2020
1348
            message = None
2041
1369
                        len(os.listdir(abs_path)) > 0):
2042
1370
                        if force:
2043
1371
                            osutils.rmtree(abs_path)
 
1372
                            message = "deleted %s" % (f,)
2044
1373
                        else:
2045
 
                            message = "%s is not an empty directory "\
2046
 
                                "and won't be deleted." % (f,)
 
1374
                            message = backup(f)
2047
1375
                    else:
2048
 
                        osutils.delete_any(abs_path)
2049
 
                        message = "deleted %s" % (f,)
 
1376
                        if f in files_to_backup:
 
1377
                            message = backup(f)
 
1378
                        else:
 
1379
                            osutils.delete_any(abs_path)
 
1380
                            message = "deleted %s" % (f,)
2050
1381
                elif message is not None:
2051
1382
                    # Only care if we haven't done anything yet.
2052
1383
                    message = "%s does not exist." % (f,)
2097
1428
        WorkingTree can supply revision_trees for the basis revision only
2098
1429
        because there is only one cached inventory in the bzr directory.
2099
1430
        """
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)
 
1431
        raise NotImplementedError(self.revision_tree)
2141
1432
 
2142
1433
    @needs_tree_write_lock
2143
1434
    def set_root_id(self, file_id):
2156
1447
            present in the current inventory or an error will occur. It must
2157
1448
            not be None, but rather a valid file id.
2158
1449
        """
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
 
1450
        raise NotImplementedError(self._set_root_id)
2177
1451
 
2178
1452
    def unlock(self):
2179
1453
        """See Branch.unlock.
2189
1463
    _marker = object()
2190
1464
 
2191
1465
    def update(self, change_reporter=None, possible_transports=None,
2192
 
               revision=None, old_tip=_marker):
 
1466
               revision=None, old_tip=_marker, show_base=False):
2193
1467
        """Update a working tree along its branch.
2194
1468
 
2195
1469
        This will update the branch if its bound too, which means we have
2232
1506
            else:
2233
1507
                if old_tip is self._marker:
2234
1508
                    old_tip = None
2235
 
            return self._update_tree(old_tip, change_reporter, revision)
 
1509
            return self._update_tree(old_tip, change_reporter, revision, show_base)
2236
1510
        finally:
2237
1511
            self.unlock()
2238
1512
 
2239
1513
    @needs_tree_write_lock
2240
 
    def _update_tree(self, old_tip=None, change_reporter=None, revision=None):
 
1514
    def _update_tree(self, old_tip=None, change_reporter=None, revision=None,
 
1515
                     show_base=False):
2241
1516
        """Update a tree to the master branch.
2242
1517
 
2243
1518
        :param old_tip: if supplied, the previous tip revision the branch,
2270
1545
            other_tree = self.branch.repository.revision_tree(old_tip)
2271
1546
            nb_conflicts = merge.merge_inner(self.branch, other_tree,
2272
1547
                                             base_tree, this_tree=self,
2273
 
                                             change_reporter=change_reporter)
 
1548
                                             change_reporter=change_reporter,
 
1549
                                             show_base=show_base)
2274
1550
            if nb_conflicts:
2275
1551
                self.add_parent_tree((old_tip, other_tree))
2276
 
                trace.note('Rerun update after fixing the conflicts.')
 
1552
                note('Rerun update after fixing the conflicts.')
2277
1553
                return nb_conflicts
2278
1554
 
2279
1555
        if last_rev != _mod_revision.ensure_null(revision):
2285
1561
            basis = self.basis_tree()
2286
1562
            basis.lock_read()
2287
1563
            try:
2288
 
                if (basis.inventory.root is None
2289
 
                    or basis.inventory.root.file_id != to_root_id):
 
1564
                if (basis.get_root_id() is None or basis.get_root_id() != to_root_id):
2290
1565
                    self.set_root_id(to_root_id)
2291
1566
                    self.flush()
2292
1567
            finally:
2300
1575
 
2301
1576
            nb_conflicts = merge.merge_inner(self.branch, to_tree, base_tree,
2302
1577
                                             this_tree=self,
2303
 
                                             change_reporter=change_reporter)
 
1578
                                             change_reporter=change_reporter,
 
1579
                                             show_base=show_base)
2304
1580
            self.set_last_revision(revision)
2305
1581
            # TODO - dedup parents list with things merged by pull ?
2306
1582
            # reuse the tree we've updated to to set the basis:
2333
1609
                #       warning might be sufficient to let the user know what
2334
1610
                #       is going on.
2335
1611
                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()
 
1612
                              self._hashcache.cache_file_name(), e)
2343
1613
 
2344
1614
    def set_conflicts(self, arg):
2345
1615
        raise errors.UnsupportedOperation(self.set_conflicts, self)
2347
1617
    def add_conflicts(self, arg):
2348
1618
        raise errors.UnsupportedOperation(self.add_conflicts, self)
2349
1619
 
2350
 
    @needs_read_lock
2351
1620
    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
 
1621
        raise NotImplementedError(self.conflicts)
2375
1622
 
2376
1623
    def walkdirs(self, prefix=""):
2377
1624
        """Walk the directories of this tree.
2503
1750
                 [(file1_path, file1_name, file1_kind, None, file1_id,
2504
1751
                   file1_kind), ... ])
2505
1752
        """
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)
 
1753
        raise NotImplementedError(self._walkdirs)
2535
1754
 
2536
1755
    @needs_tree_write_lock
2537
1756
    def auto_resolve(self):
2595
1814
        """
2596
1815
        return
2597
1816
 
 
1817
    @needs_read_lock
 
1818
    def check_state(self):
 
1819
        """Check that the working state is/isn't valid."""
 
1820
        check_refs = self._get_check_refs()
 
1821
        refs = {}
 
1822
        for ref in check_refs:
 
1823
            kind, value = ref
 
1824
            if kind == 'trees':
 
1825
                refs[ref] = self.branch.repository.revision_tree(value)
 
1826
        self._check(refs)
 
1827
 
 
1828
    def reset_state(self, revision_ids=None):
 
1829
        """Reset the state of the working tree.
 
1830
 
 
1831
        This does a hard-reset to a last-known-good state. This is a way to
 
1832
        fix if something got corrupted (like the .bzr/checkout/dirstate file)
 
1833
        """
 
1834
        raise NotImplementedError(self.reset_state)
 
1835
 
2598
1836
    def _get_rules_searcher(self, default_searcher):
2599
1837
        """See Tree._get_rules_searcher."""
2600
1838
        if self._rules_searcher is None:
2608
1846
        return ShelfManager(self, self._transport)
2609
1847
 
2610
1848
 
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.
 
1849
class InventoryWorkingTree(WorkingTree,
 
1850
        bzrlib.mutabletree.MutableInventoryTree):
 
1851
    """Base class for working trees that are inventory-oriented.
 
1852
 
 
1853
    The inventory is held in the `Branch` working-inventory, and the
 
1854
    files are in a directory on disk.
 
1855
 
 
1856
    It is possible for a `WorkingTree` to have a filename which is
 
1857
    not listed in the Inventory and vice versa.
2617
1858
    """
2618
1859
 
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()
 
1860
    def __init__(self, basedir='.',
 
1861
                 branch=DEPRECATED_PARAMETER,
 
1862
                 _inventory=None,
 
1863
                 _control_files=None,
 
1864
                 _internal=False,
 
1865
                 _format=None,
 
1866
                 _bzrdir=None):
 
1867
        """Construct a InventoryWorkingTree instance. This is not a public API.
 
1868
 
 
1869
        :param branch: A branch to override probing for the branch.
 
1870
        """
 
1871
        super(InventoryWorkingTree, self).__init__(basedir=basedir,
 
1872
            branch=branch, _control_files=_control_files, _internal=_internal,
 
1873
            _format=_format, _bzrdir=_bzrdir)
 
1874
 
 
1875
        if _inventory is None:
 
1876
            # This will be acquired on lock_read() or lock_write()
 
1877
            self._inventory_is_modified = False
 
1878
            self._inventory = None
 
1879
        else:
 
1880
            # the caller of __init__ has provided an inventory,
 
1881
            # we assume they know what they are doing - as its only
 
1882
            # the Format factory and creation methods that are
 
1883
            # permitted to do this.
 
1884
            self._set_inventory(_inventory, dirty=False)
 
1885
 
 
1886
    def _set_inventory(self, inv, dirty):
 
1887
        """Set the internal cached inventory.
 
1888
 
 
1889
        :param inv: The inventory to set.
 
1890
        :param dirty: A boolean indicating whether the inventory is the same
 
1891
            logical inventory as whats on disk. If True the inventory is not
 
1892
            the same and should be written to disk or data will be lost, if
 
1893
            False then the inventory is the same as that on disk and any
 
1894
            serialisation would be unneeded overhead.
 
1895
        """
 
1896
        self._inventory = inv
 
1897
        self._inventory_is_modified = dirty
 
1898
 
 
1899
    def _serialize(self, inventory, out_file):
 
1900
        xml5.serializer_v5.write_inventory(self._inventory, out_file,
 
1901
            working=True)
 
1902
 
 
1903
    def _deserialize(selt, in_file):
 
1904
        return xml5.serializer_v5.read_inventory(in_file)
 
1905
 
 
1906
    @needs_tree_write_lock
 
1907
    def _write_inventory(self, inv):
 
1908
        """Write inventory as the current inventory."""
 
1909
        self._set_inventory(inv, dirty=True)
 
1910
        self.flush()
 
1911
 
 
1912
    # XXX: This method should be deprecated in favour of taking in a proper
 
1913
    # new Inventory object.
 
1914
    @needs_tree_write_lock
 
1915
    def set_inventory(self, new_inventory_list):
 
1916
        from bzrlib.inventory import (Inventory,
 
1917
                                      InventoryDirectory,
 
1918
                                      InventoryFile,
 
1919
                                      InventoryLink)
 
1920
        inv = Inventory(self.get_root_id())
 
1921
        for path, file_id, parent, kind in new_inventory_list:
 
1922
            name = os.path.basename(path)
 
1923
            if name == "":
 
1924
                continue
 
1925
            # fixme, there should be a factory function inv,add_??
 
1926
            if kind == 'directory':
 
1927
                inv.add(InventoryDirectory(file_id, name, parent))
 
1928
            elif kind == 'file':
 
1929
                inv.add(InventoryFile(file_id, name, parent))
 
1930
            elif kind == 'symlink':
 
1931
                inv.add(InventoryLink(file_id, name, parent))
 
1932
            else:
 
1933
                raise errors.BzrError("unknown kind %r" % kind)
 
1934
        self._write_inventory(inv)
 
1935
 
 
1936
    def _write_basis_inventory(self, xml):
 
1937
        """Write the basis inventory XML to the basis-inventory file"""
 
1938
        path = self._basis_inventory_name()
 
1939
        sio = StringIO(xml)
 
1940
        self._transport.put_file(path, sio,
 
1941
            mode=self.bzrdir._get_file_mode())
 
1942
 
 
1943
    def _reset_data(self):
 
1944
        """Reset transient data that cannot be revalidated."""
 
1945
        self._inventory_is_modified = False
 
1946
        f = self._transport.get('inventory')
 
1947
        try:
 
1948
            result = self._deserialize(f)
 
1949
        finally:
 
1950
            f.close()
 
1951
        self._set_inventory(result, dirty=False)
 
1952
 
 
1953
    def _set_root_id(self, file_id):
 
1954
        """Set the root id for this tree, in a format specific manner.
 
1955
 
 
1956
        :param file_id: The file id to assign to the root. It must not be
 
1957
            present in the current inventory or an error will occur. It must
 
1958
            not be None, but rather a valid file id.
 
1959
        """
 
1960
        inv = self._inventory
 
1961
        orig_root_id = inv.root.file_id
 
1962
        # TODO: it might be nice to exit early if there was nothing
 
1963
        # to do, saving us from trigger a sync on unlock.
 
1964
        self._inventory_is_modified = True
 
1965
        # we preserve the root inventory entry object, but
 
1966
        # unlinkit from the byid index
 
1967
        del inv._byid[inv.root.file_id]
 
1968
        inv.root.file_id = file_id
 
1969
        # and link it into the index with the new changed id.
 
1970
        inv._byid[inv.root.file_id] = inv.root
 
1971
        # and finally update all children to reference the new id.
 
1972
        # XXX: this should be safe to just look at the root.children
 
1973
        # list, not the WHOLE INVENTORY.
 
1974
        for fid in inv:
 
1975
            entry = inv[fid]
 
1976
            if entry.parent_id == orig_root_id:
 
1977
                entry.parent_id = inv.root.file_id
 
1978
 
 
1979
    def all_file_ids(self):
 
1980
        """See Tree.iter_all_file_ids"""
 
1981
        return set(self.inventory)
 
1982
 
 
1983
    def _cache_basis_inventory(self, new_revision):
 
1984
        """Cache new_revision as the basis inventory."""
 
1985
        # TODO: this should allow the ready-to-use inventory to be passed in,
 
1986
        # as commit already has that ready-to-use [while the format is the
 
1987
        # same, that is].
 
1988
        try:
 
1989
            # this double handles the inventory - unpack and repack -
 
1990
            # but is easier to understand. We can/should put a conditional
 
1991
            # in here based on whether the inventory is in the latest format
 
1992
            # - perhaps we should repack all inventories on a repository
 
1993
            # upgrade ?
 
1994
            # the fast path is to copy the raw xml from the repository. If the
 
1995
            # xml contains 'revision_id="', then we assume the right
 
1996
            # revision_id is set. We must check for this full string, because a
 
1997
            # root node id can legitimately look like 'revision_id' but cannot
 
1998
            # contain a '"'.
 
1999
            xml = self.branch.repository._get_inventory_xml(new_revision)
 
2000
            firstline = xml.split('\n', 1)[0]
 
2001
            if (not 'revision_id="' in firstline or
 
2002
                'format="7"' not in firstline):
 
2003
                inv = self.branch.repository._serializer.read_inventory_from_string(
 
2004
                    xml, new_revision)
 
2005
                xml = self._create_basis_xml_from_inventory(new_revision, inv)
 
2006
            self._write_basis_inventory(xml)
 
2007
        except (errors.NoSuchRevision, errors.RevisionNotPresent):
 
2008
            pass
 
2009
 
 
2010
    def _basis_inventory_name(self):
 
2011
        return 'basis-inventory-cache'
 
2012
 
 
2013
    def _create_basis_xml_from_inventory(self, revision_id, inventory):
 
2014
        """Create the text that will be saved in basis-inventory"""
 
2015
        inventory.revision_id = revision_id
 
2016
        return xml7.serializer_v7.write_inventory_to_string(inventory)
 
2017
 
 
2018
    def read_basis_inventory(self):
 
2019
        """Read the cached basis inventory."""
 
2020
        path = self._basis_inventory_name()
 
2021
        return self._transport.get_bytes(path)
 
2022
 
 
2023
    @needs_read_lock
 
2024
    def read_working_inventory(self):
 
2025
        """Read the working inventory.
 
2026
 
 
2027
        :raises errors.InventoryModified: read_working_inventory will fail
 
2028
            when the current in memory inventory has been modified.
 
2029
        """
 
2030
        # conceptually this should be an implementation detail of the tree.
 
2031
        # XXX: Deprecate this.
 
2032
        # ElementTree does its own conversion from UTF-8, so open in
 
2033
        # binary.
 
2034
        if self._inventory_is_modified:
 
2035
            raise errors.InventoryModified(self)
 
2036
        f = self._transport.get('inventory')
 
2037
        try:
 
2038
            result = self._deserialize(f)
 
2039
        finally:
 
2040
            f.close()
 
2041
        self._set_inventory(result, dirty=False)
 
2042
        return result
 
2043
 
 
2044
    @needs_read_lock
 
2045
    def get_root_id(self):
 
2046
        """Return the id of this trees root"""
 
2047
        return self._inventory.root.file_id
 
2048
 
 
2049
    def has_id(self, file_id):
 
2050
        # files that have been deleted are excluded
 
2051
        inv = self.inventory
 
2052
        if not inv.has_id(file_id):
 
2053
            return False
 
2054
        path = inv.id2path(file_id)
 
2055
        return osutils.lexists(self.abspath(path))
 
2056
 
 
2057
    def has_or_had_id(self, file_id):
 
2058
        if file_id == self.inventory.root.file_id:
 
2059
            return True
 
2060
        return self.inventory.has_id(file_id)
 
2061
 
 
2062
    __contains__ = has_id
 
2063
 
 
2064
    # should be deprecated - this is slow and in any case treating them as a
 
2065
    # container is (we now know) bad style -- mbp 20070302
 
2066
    ## @deprecated_method(zero_fifteen)
 
2067
    def __iter__(self):
 
2068
        """Iterate through file_ids for this tree.
 
2069
 
 
2070
        file_ids are in a WorkingTree if they are in the working inventory
 
2071
        and the working file exists.
 
2072
        """
 
2073
        inv = self._inventory
 
2074
        for path, ie in inv.iter_entries():
 
2075
            if osutils.lexists(self.abspath(path)):
 
2076
                yield ie.file_id
 
2077
 
 
2078
    @needs_tree_write_lock
 
2079
    def set_last_revision(self, new_revision):
 
2080
        """Change the last revision in the working tree."""
 
2081
        if self._change_last_revision(new_revision):
 
2082
            self._cache_basis_inventory(new_revision)
 
2083
 
 
2084
    @needs_tree_write_lock
 
2085
    def reset_state(self, revision_ids=None):
 
2086
        """Reset the state of the working tree.
 
2087
 
 
2088
        This does a hard-reset to a last-known-good state. This is a way to
 
2089
        fix if something got corrupted (like the .bzr/checkout/dirstate file)
 
2090
        """
 
2091
        if revision_ids is None:
 
2092
            revision_ids = self.get_parent_ids()
 
2093
        if not revision_ids:
 
2094
            rt = self.branch.repository.revision_tree(
 
2095
                _mod_revision.NULL_REVISION)
 
2096
        else:
 
2097
            rt = self.branch.repository.revision_tree(revision_ids[0])
 
2098
        self._write_inventory(rt.inventory)
 
2099
        self.set_parent_ids(revision_ids)
 
2100
 
 
2101
    def flush(self):
 
2102
        """Write the in memory inventory to disk."""
 
2103
        # TODO: Maybe this should only write on dirty ?
 
2104
        if self._control_files._lock_mode != 'w':
 
2105
            raise errors.NotWriteLocked(self)
 
2106
        sio = StringIO()
 
2107
        self._serialize(self._inventory, sio)
 
2108
        sio.seek(0)
 
2109
        self._transport.put_file('inventory', sio,
 
2110
            mode=self.bzrdir._get_file_mode())
 
2111
        self._inventory_is_modified = False
 
2112
 
 
2113
    @needs_read_lock
 
2114
    def get_file_sha1(self, file_id, path=None, stat_value=None):
 
2115
        if not path:
 
2116
            path = self._inventory.id2path(file_id)
 
2117
        return self._hashcache.get_sha1(path, stat_value)
 
2118
 
 
2119
    def get_file_mtime(self, file_id, path=None):
 
2120
        """See Tree.get_file_mtime."""
 
2121
        if not path:
 
2122
            path = self.inventory.id2path(file_id)
 
2123
        return os.lstat(self.abspath(path)).st_mtime
 
2124
 
 
2125
    def _is_executable_from_path_and_stat_from_basis(self, path, stat_result):
 
2126
        file_id = self.path2id(path)
 
2127
        if file_id is None:
 
2128
            # For unversioned files on win32, we just assume they are not
 
2129
            # executable
 
2130
            return False
 
2131
        return self._inventory[file_id].executable
 
2132
 
 
2133
    def _is_executable_from_path_and_stat_from_stat(self, path, stat_result):
 
2134
        mode = stat_result.st_mode
 
2135
        return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
 
2136
 
 
2137
    if not supports_executable():
 
2138
        def is_executable(self, file_id, path=None):
 
2139
            return self._inventory[file_id].executable
 
2140
 
 
2141
        _is_executable_from_path_and_stat = \
 
2142
            _is_executable_from_path_and_stat_from_basis
 
2143
    else:
 
2144
        def is_executable(self, file_id, path=None):
 
2145
            if not path:
 
2146
                path = self.id2path(file_id)
 
2147
            mode = os.lstat(self.abspath(path)).st_mode
 
2148
            return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
 
2149
 
 
2150
        _is_executable_from_path_and_stat = \
 
2151
            _is_executable_from_path_and_stat_from_stat
 
2152
 
 
2153
    @needs_tree_write_lock
 
2154
    def _add(self, files, ids, kinds):
 
2155
        """See MutableTree._add."""
 
2156
        # TODO: Re-adding a file that is removed in the working copy
 
2157
        # should probably put it back with the previous ID.
 
2158
        # the read and write working inventory should not occur in this
 
2159
        # function - they should be part of lock_write and unlock.
 
2160
        inv = self.inventory
 
2161
        for f, file_id, kind in zip(files, ids, kinds):
 
2162
            if file_id is None:
 
2163
                inv.add_path(f, kind=kind)
 
2164
            else:
 
2165
                inv.add_path(f, kind=kind, file_id=file_id)
 
2166
            self._inventory_is_modified = True
 
2167
 
 
2168
    def revision_tree(self, revision_id):
 
2169
        """See WorkingTree.revision_id."""
 
2170
        if revision_id == self.last_revision():
 
2171
            try:
 
2172
                xml = self.read_basis_inventory()
 
2173
            except errors.NoSuchFile:
 
2174
                pass
 
2175
            else:
 
2176
                try:
 
2177
                    inv = xml7.serializer_v7.read_inventory_from_string(xml)
 
2178
                    # dont use the repository revision_tree api because we want
 
2179
                    # to supply the inventory.
 
2180
                    if inv.revision_id == revision_id:
 
2181
                        return revisiontree.InventoryRevisionTree(
 
2182
                            self.branch.repository, inv, revision_id)
 
2183
                except errors.BadInventoryFormat:
 
2184
                    pass
 
2185
        # raise if there was no inventory, or if we read the wrong inventory.
 
2186
        raise errors.NoSuchRevisionInTree(self, revision_id)
 
2187
 
 
2188
    @needs_read_lock
 
2189
    def annotate_iter(self, file_id, default_revision=CURRENT_REVISION):
 
2190
        """See Tree.annotate_iter
 
2191
 
 
2192
        This implementation will use the basis tree implementation if possible.
 
2193
        Lines not in the basis are attributed to CURRENT_REVISION
 
2194
 
 
2195
        If there are pending merges, lines added by those merges will be
 
2196
        incorrectly attributed to CURRENT_REVISION (but after committing, the
 
2197
        attribution will be correct).
 
2198
        """
 
2199
        maybe_file_parent_keys = []
 
2200
        for parent_id in self.get_parent_ids():
 
2201
            try:
 
2202
                parent_tree = self.revision_tree(parent_id)
 
2203
            except errors.NoSuchRevisionInTree:
 
2204
                parent_tree = self.branch.repository.revision_tree(parent_id)
 
2205
            parent_tree.lock_read()
 
2206
            try:
 
2207
                if file_id not in parent_tree:
 
2208
                    continue
 
2209
                ie = parent_tree.inventory[file_id]
 
2210
                if ie.kind != 'file':
 
2211
                    # Note: this is slightly unnecessary, because symlinks and
 
2212
                    # directories have a "text" which is the empty text, and we
 
2213
                    # know that won't mess up annotations. But it seems cleaner
 
2214
                    continue
 
2215
                parent_text_key = (file_id, ie.revision)
 
2216
                if parent_text_key not in maybe_file_parent_keys:
 
2217
                    maybe_file_parent_keys.append(parent_text_key)
 
2218
            finally:
 
2219
                parent_tree.unlock()
 
2220
        graph = _mod_graph.Graph(self.branch.repository.texts)
 
2221
        heads = graph.heads(maybe_file_parent_keys)
 
2222
        file_parent_keys = []
 
2223
        for key in maybe_file_parent_keys:
 
2224
            if key in heads:
 
2225
                file_parent_keys.append(key)
 
2226
 
 
2227
        # Now we have the parents of this content
 
2228
        annotator = self.branch.repository.texts.get_annotator()
 
2229
        text = self.get_file_text(file_id)
 
2230
        this_key =(file_id, default_revision)
 
2231
        annotator.add_special_text(this_key, file_parent_keys, text)
 
2232
        annotations = [(key[-1], line)
 
2233
                       for key, line in annotator.annotate_flat(this_key)]
 
2234
        return annotations
 
2235
 
 
2236
    @needs_read_lock
 
2237
    def merge_modified(self):
 
2238
        """Return a dictionary of files modified by a merge.
 
2239
 
 
2240
        The list is initialized by WorkingTree.set_merge_modified, which is
 
2241
        typically called after we make some automatic updates to the tree
 
2242
        because of a merge.
 
2243
 
 
2244
        This returns a map of file_id->sha1, containing only files which are
 
2245
        still in the working inventory and have that text hash.
 
2246
        """
 
2247
        try:
 
2248
            hashfile = self._transport.get('merge-hashes')
 
2249
        except errors.NoSuchFile:
 
2250
            return {}
 
2251
        try:
 
2252
            merge_hashes = {}
 
2253
            try:
 
2254
                if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
 
2255
                    raise errors.MergeModifiedFormatError()
 
2256
            except StopIteration:
 
2257
                raise errors.MergeModifiedFormatError()
 
2258
            for s in _mod_rio.RioReader(hashfile):
 
2259
                # RioReader reads in Unicode, so convert file_ids back to utf8
 
2260
                file_id = osutils.safe_file_id(s.get("file_id"), warn=False)
 
2261
                if file_id not in self.inventory:
 
2262
                    continue
 
2263
                text_hash = s.get("hash")
 
2264
                if text_hash == self.get_file_sha1(file_id):
 
2265
                    merge_hashes[file_id] = text_hash
 
2266
            return merge_hashes
 
2267
        finally:
 
2268
            hashfile.close()
 
2269
 
 
2270
    @needs_write_lock
 
2271
    def subsume(self, other_tree):
 
2272
        def add_children(inventory, entry):
 
2273
            for child_entry in entry.children.values():
 
2274
                inventory._byid[child_entry.file_id] = child_entry
 
2275
                if child_entry.kind == 'directory':
 
2276
                    add_children(inventory, child_entry)
 
2277
        if other_tree.get_root_id() == self.get_root_id():
 
2278
            raise errors.BadSubsumeSource(self, other_tree,
 
2279
                                          'Trees have the same root')
 
2280
        try:
 
2281
            other_tree_path = self.relpath(other_tree.basedir)
 
2282
        except errors.PathNotChild:
 
2283
            raise errors.BadSubsumeSource(self, other_tree,
 
2284
                'Tree is not contained by the other')
 
2285
        new_root_parent = self.path2id(osutils.dirname(other_tree_path))
 
2286
        if new_root_parent is None:
 
2287
            raise errors.BadSubsumeSource(self, other_tree,
 
2288
                'Parent directory is not versioned.')
 
2289
        # We need to ensure that the result of a fetch will have a
 
2290
        # versionedfile for the other_tree root, and only fetching into
 
2291
        # RepositoryKnit2 guarantees that.
 
2292
        if not self.branch.repository.supports_rich_root():
 
2293
            raise errors.SubsumeTargetNeedsUpgrade(other_tree)
 
2294
        other_tree.lock_tree_write()
 
2295
        try:
 
2296
            new_parents = other_tree.get_parent_ids()
 
2297
            other_root = other_tree.inventory.root
 
2298
            other_root.parent_id = new_root_parent
 
2299
            other_root.name = osutils.basename(other_tree_path)
 
2300
            self.inventory.add(other_root)
 
2301
            add_children(self.inventory, other_root)
 
2302
            self._write_inventory(self.inventory)
 
2303
            # normally we don't want to fetch whole repositories, but i think
 
2304
            # here we really do want to consolidate the whole thing.
 
2305
            for parent_id in other_tree.get_parent_ids():
 
2306
                self.branch.fetch(other_tree.branch, parent_id)
 
2307
                self.add_parent_tree_id(parent_id)
 
2308
        finally:
 
2309
            other_tree.unlock()
 
2310
        other_tree.bzrdir.retire_bzrdir()
 
2311
 
 
2312
    @needs_tree_write_lock
 
2313
    def extract(self, file_id, format=None):
 
2314
        """Extract a subtree from this tree.
 
2315
 
 
2316
        A new branch will be created, relative to the path for this tree.
 
2317
        """
 
2318
        self.flush()
 
2319
        def mkdirs(path):
 
2320
            segments = osutils.splitpath(path)
 
2321
            transport = self.branch.bzrdir.root_transport
 
2322
            for name in segments:
 
2323
                transport = transport.clone(name)
 
2324
                transport.ensure_base()
 
2325
            return transport
 
2326
 
 
2327
        sub_path = self.id2path(file_id)
 
2328
        branch_transport = mkdirs(sub_path)
 
2329
        if format is None:
 
2330
            format = self.bzrdir.cloning_metadir()
 
2331
        branch_transport.ensure_base()
 
2332
        branch_bzrdir = format.initialize_on_transport(branch_transport)
 
2333
        try:
 
2334
            repo = branch_bzrdir.find_repository()
 
2335
        except errors.NoRepositoryPresent:
 
2336
            repo = branch_bzrdir.create_repository()
 
2337
        if not repo.supports_rich_root():
 
2338
            raise errors.RootNotRich()
 
2339
        new_branch = branch_bzrdir.create_branch()
 
2340
        new_branch.pull(self.branch)
 
2341
        for parent_id in self.get_parent_ids():
 
2342
            new_branch.fetch(self.branch, parent_id)
 
2343
        tree_transport = self.bzrdir.root_transport.clone(sub_path)
 
2344
        if tree_transport.base != branch_transport.base:
 
2345
            tree_bzrdir = format.initialize_on_transport(tree_transport)
 
2346
            branch.BranchReferenceFormat().initialize(tree_bzrdir,
 
2347
                target_branch=new_branch)
 
2348
        else:
 
2349
            tree_bzrdir = branch_bzrdir
 
2350
        wt = tree_bzrdir.create_workingtree(_mod_revision.NULL_REVISION)
 
2351
        wt.set_parent_ids(self.get_parent_ids())
 
2352
        my_inv = self.inventory
 
2353
        child_inv = inventory.Inventory(root_id=None)
 
2354
        new_root = my_inv[file_id]
 
2355
        my_inv.remove_recursive_id(file_id)
 
2356
        new_root.parent_id = None
 
2357
        child_inv.add(new_root)
 
2358
        self._write_inventory(my_inv)
 
2359
        wt._write_inventory(child_inv)
 
2360
        return wt
 
2361
 
 
2362
    def list_files(self, include_root=False, from_dir=None, recursive=True):
 
2363
        """List all files as (path, class, kind, id, entry).
 
2364
 
 
2365
        Lists, but does not descend into unversioned directories.
 
2366
        This does not include files that have been deleted in this
 
2367
        tree. Skips the control directory.
 
2368
 
 
2369
        :param include_root: if True, return an entry for the root
 
2370
        :param from_dir: start from this directory or None for the root
 
2371
        :param recursive: whether to recurse into subdirectories or not
 
2372
        """
 
2373
        # list_files is an iterator, so @needs_read_lock doesn't work properly
 
2374
        # with it. So callers should be careful to always read_lock the tree.
 
2375
        if not self.is_locked():
 
2376
            raise errors.ObjectNotLocked(self)
 
2377
 
 
2378
        inv = self.inventory
 
2379
        if from_dir is None and include_root is True:
 
2380
            yield ('', 'V', 'directory', inv.root.file_id, inv.root)
 
2381
        # Convert these into local objects to save lookup times
 
2382
        pathjoin = osutils.pathjoin
 
2383
        file_kind = self._kind
 
2384
 
 
2385
        # transport.base ends in a slash, we want the piece
 
2386
        # between the last two slashes
 
2387
        transport_base_dir = self.bzrdir.transport.base.rsplit('/', 2)[1]
 
2388
 
 
2389
        fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
 
2390
 
 
2391
        # directory file_id, relative path, absolute path, reverse sorted children
 
2392
        if from_dir is not None:
 
2393
            from_dir_id = inv.path2id(from_dir)
 
2394
            if from_dir_id is None:
 
2395
                # Directory not versioned
 
2396
                return
 
2397
            from_dir_abspath = pathjoin(self.basedir, from_dir)
 
2398
        else:
 
2399
            from_dir_id = inv.root.file_id
 
2400
            from_dir_abspath = self.basedir
 
2401
        children = os.listdir(from_dir_abspath)
 
2402
        children.sort()
 
2403
        # jam 20060527 The kernel sized tree seems equivalent whether we
 
2404
        # use a deque and popleft to keep them sorted, or if we use a plain
 
2405
        # list and just reverse() them.
 
2406
        children = collections.deque(children)
 
2407
        stack = [(from_dir_id, u'', from_dir_abspath, children)]
 
2408
        while stack:
 
2409
            from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
 
2410
 
 
2411
            while children:
 
2412
                f = children.popleft()
 
2413
                ## TODO: If we find a subdirectory with its own .bzr
 
2414
                ## directory, then that is a separate tree and we
 
2415
                ## should exclude it.
 
2416
 
 
2417
                # the bzrdir for this tree
 
2418
                if transport_base_dir == f:
 
2419
                    continue
 
2420
 
 
2421
                # we know that from_dir_relpath and from_dir_abspath never end in a slash
 
2422
                # and 'f' doesn't begin with one, we can do a string op, rather
 
2423
                # than the checks of pathjoin(), all relative paths will have an extra slash
 
2424
                # at the beginning
 
2425
                fp = from_dir_relpath + '/' + f
 
2426
 
 
2427
                # absolute path
 
2428
                fap = from_dir_abspath + '/' + f
 
2429
 
 
2430
                dir_ie = inv[from_dir_id]
 
2431
                if dir_ie.kind == 'directory':
 
2432
                    f_ie = dir_ie.children.get(f)
 
2433
                else:
 
2434
                    f_ie = None
 
2435
                if f_ie:
 
2436
                    c = 'V'
 
2437
                elif self.is_ignored(fp[1:]):
 
2438
                    c = 'I'
 
2439
                else:
 
2440
                    # we may not have found this file, because of a unicode
 
2441
                    # issue, or because the directory was actually a symlink.
 
2442
                    f_norm, can_access = osutils.normalized_filename(f)
 
2443
                    if f == f_norm or not can_access:
 
2444
                        # No change, so treat this file normally
 
2445
                        c = '?'
 
2446
                    else:
 
2447
                        # this file can be accessed by a normalized path
 
2448
                        # check again if it is versioned
 
2449
                        # these lines are repeated here for performance
 
2450
                        f = f_norm
 
2451
                        fp = from_dir_relpath + '/' + f
 
2452
                        fap = from_dir_abspath + '/' + f
 
2453
                        f_ie = inv.get_child(from_dir_id, f)
 
2454
                        if f_ie:
 
2455
                            c = 'V'
 
2456
                        elif self.is_ignored(fp[1:]):
 
2457
                            c = 'I'
 
2458
                        else:
 
2459
                            c = '?'
 
2460
 
 
2461
                fk = file_kind(fap)
 
2462
 
 
2463
                # make a last minute entry
 
2464
                if f_ie:
 
2465
                    yield fp[1:], c, fk, f_ie.file_id, f_ie
 
2466
                else:
 
2467
                    try:
 
2468
                        yield fp[1:], c, fk, None, fk_entries[fk]()
 
2469
                    except KeyError:
 
2470
                        yield fp[1:], c, fk, None, TreeEntry()
 
2471
                    continue
 
2472
 
 
2473
                if fk != 'directory':
 
2474
                    continue
 
2475
 
 
2476
                # But do this child first if recursing down
 
2477
                if recursive:
 
2478
                    new_children = os.listdir(fap)
 
2479
                    new_children.sort()
 
2480
                    new_children = collections.deque(new_children)
 
2481
                    stack.append((f_ie.file_id, fp, fap, new_children))
 
2482
                    # Break out of inner loop,
 
2483
                    # so that we start outer loop with child
 
2484
                    break
 
2485
            else:
 
2486
                # if we finished all children, pop it off the stack
 
2487
                stack.pop()
 
2488
 
 
2489
    @needs_tree_write_lock
 
2490
    def move(self, from_paths, to_dir=None, after=False):
 
2491
        """Rename files.
 
2492
 
 
2493
        to_dir must exist in the inventory.
 
2494
 
 
2495
        If to_dir exists and is a directory, the files are moved into
 
2496
        it, keeping their old names.
 
2497
 
 
2498
        Note that to_dir is only the last component of the new name;
 
2499
        this doesn't change the directory.
 
2500
 
 
2501
        For each entry in from_paths the move mode will be determined
 
2502
        independently.
 
2503
 
 
2504
        The first mode moves the file in the filesystem and updates the
 
2505
        inventory. The second mode only updates the inventory without
 
2506
        touching the file on the filesystem.
 
2507
 
 
2508
        move uses the second mode if 'after == True' and the target is not
 
2509
        versioned but present in the working tree.
 
2510
 
 
2511
        move uses the second mode if 'after == False' and the source is
 
2512
        versioned but no longer in the working tree, and the target is not
 
2513
        versioned but present in the working tree.
 
2514
 
 
2515
        move uses the first mode if 'after == False' and the source is
 
2516
        versioned and present in the working tree, and the target is not
 
2517
        versioned and not present in the working tree.
 
2518
 
 
2519
        Everything else results in an error.
 
2520
 
 
2521
        This returns a list of (from_path, to_path) pairs for each
 
2522
        entry that is moved.
 
2523
        """
 
2524
        rename_entries = []
 
2525
        rename_tuples = []
 
2526
 
 
2527
        # check for deprecated use of signature
 
2528
        if to_dir is None:
 
2529
            raise TypeError('You must supply a target directory')
 
2530
        # check destination directory
 
2531
        if isinstance(from_paths, basestring):
 
2532
            raise ValueError()
 
2533
        inv = self.inventory
 
2534
        to_abs = self.abspath(to_dir)
 
2535
        if not isdir(to_abs):
 
2536
            raise errors.BzrMoveFailedError('',to_dir,
 
2537
                errors.NotADirectory(to_abs))
 
2538
        if not self.has_filename(to_dir):
 
2539
            raise errors.BzrMoveFailedError('',to_dir,
 
2540
                errors.NotInWorkingDirectory(to_dir))
 
2541
        to_dir_id = inv.path2id(to_dir)
 
2542
        if to_dir_id is None:
 
2543
            raise errors.BzrMoveFailedError('',to_dir,
 
2544
                errors.NotVersionedError(path=to_dir))
 
2545
 
 
2546
        to_dir_ie = inv[to_dir_id]
 
2547
        if to_dir_ie.kind != 'directory':
 
2548
            raise errors.BzrMoveFailedError('',to_dir,
 
2549
                errors.NotADirectory(to_abs))
 
2550
 
 
2551
        # create rename entries and tuples
 
2552
        for from_rel in from_paths:
 
2553
            from_tail = splitpath(from_rel)[-1]
 
2554
            from_id = inv.path2id(from_rel)
 
2555
            if from_id is None:
 
2556
                raise errors.BzrMoveFailedError(from_rel,to_dir,
 
2557
                    errors.NotVersionedError(path=from_rel))
 
2558
 
 
2559
            from_entry = inv[from_id]
 
2560
            from_parent_id = from_entry.parent_id
 
2561
            to_rel = pathjoin(to_dir, from_tail)
 
2562
            rename_entry = InventoryWorkingTree._RenameEntry(
 
2563
                from_rel=from_rel,
 
2564
                from_id=from_id,
 
2565
                from_tail=from_tail,
 
2566
                from_parent_id=from_parent_id,
 
2567
                to_rel=to_rel, to_tail=from_tail,
 
2568
                to_parent_id=to_dir_id)
 
2569
            rename_entries.append(rename_entry)
 
2570
            rename_tuples.append((from_rel, to_rel))
 
2571
 
 
2572
        # determine which move mode to use. checks also for movability
 
2573
        rename_entries = self._determine_mv_mode(rename_entries, after)
 
2574
 
 
2575
        original_modified = self._inventory_is_modified
 
2576
        try:
 
2577
            if len(from_paths):
 
2578
                self._inventory_is_modified = True
 
2579
            self._move(rename_entries)
2643
2580
        except:
2644
 
            self.branch.unlock()
 
2581
            # restore the inventory on error
 
2582
            self._inventory_is_modified = original_modified
2645
2583
            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()
2661
 
        finally:
2662
 
            self.branch.unlock()
2663
 
 
2664
 
 
2665
 
class WorkingTree3(WorkingTree):
 
2584
        self._write_inventory(inv)
 
2585
        return rename_tuples
 
2586
 
 
2587
    @needs_tree_write_lock
 
2588
    def rename_one(self, from_rel, to_rel, after=False):
 
2589
        """Rename one file.
 
2590
 
 
2591
        This can change the directory or the filename or both.
 
2592
 
 
2593
        rename_one has several 'modes' to work. First, it can rename a physical
 
2594
        file and change the file_id. That is the normal mode. Second, it can
 
2595
        only change the file_id without touching any physical file.
 
2596
 
 
2597
        rename_one uses the second mode if 'after == True' and 'to_rel' is not
 
2598
        versioned but present in the working tree.
 
2599
 
 
2600
        rename_one uses the second mode if 'after == False' and 'from_rel' is
 
2601
        versioned but no longer in the working tree, and 'to_rel' is not
 
2602
        versioned but present in the working tree.
 
2603
 
 
2604
        rename_one uses the first mode if 'after == False' and 'from_rel' is
 
2605
        versioned and present in the working tree, and 'to_rel' is not
 
2606
        versioned and not present in the working tree.
 
2607
 
 
2608
        Everything else results in an error.
 
2609
        """
 
2610
        inv = self.inventory
 
2611
        rename_entries = []
 
2612
 
 
2613
        # create rename entries and tuples
 
2614
        from_tail = splitpath(from_rel)[-1]
 
2615
        from_id = inv.path2id(from_rel)
 
2616
        if from_id is None:
 
2617
            # if file is missing in the inventory maybe it's in the basis_tree
 
2618
            basis_tree = self.branch.basis_tree()
 
2619
            from_id = basis_tree.path2id(from_rel)
 
2620
            if from_id is None:
 
2621
                raise errors.BzrRenameFailedError(from_rel,to_rel,
 
2622
                    errors.NotVersionedError(path=from_rel))
 
2623
            # put entry back in the inventory so we can rename it
 
2624
            from_entry = basis_tree.inventory[from_id].copy()
 
2625
            inv.add(from_entry)
 
2626
        else:
 
2627
            from_entry = inv[from_id]
 
2628
        from_parent_id = from_entry.parent_id
 
2629
        to_dir, to_tail = os.path.split(to_rel)
 
2630
        to_dir_id = inv.path2id(to_dir)
 
2631
        rename_entry = InventoryWorkingTree._RenameEntry(from_rel=from_rel,
 
2632
                                     from_id=from_id,
 
2633
                                     from_tail=from_tail,
 
2634
                                     from_parent_id=from_parent_id,
 
2635
                                     to_rel=to_rel, to_tail=to_tail,
 
2636
                                     to_parent_id=to_dir_id)
 
2637
        rename_entries.append(rename_entry)
 
2638
 
 
2639
        # determine which move mode to use. checks also for movability
 
2640
        rename_entries = self._determine_mv_mode(rename_entries, after)
 
2641
 
 
2642
        # check if the target changed directory and if the target directory is
 
2643
        # versioned
 
2644
        if to_dir_id is None:
 
2645
            raise errors.BzrMoveFailedError(from_rel,to_rel,
 
2646
                errors.NotVersionedError(path=to_dir))
 
2647
 
 
2648
        # all checks done. now we can continue with our actual work
 
2649
        mutter('rename_one:\n'
 
2650
               '  from_id   {%s}\n'
 
2651
               '  from_rel: %r\n'
 
2652
               '  to_rel:   %r\n'
 
2653
               '  to_dir    %r\n'
 
2654
               '  to_dir_id {%s}\n',
 
2655
               from_id, from_rel, to_rel, to_dir, to_dir_id)
 
2656
 
 
2657
        self._move(rename_entries)
 
2658
        self._write_inventory(inv)
 
2659
 
 
2660
    class _RenameEntry(object):
 
2661
        def __init__(self, from_rel, from_id, from_tail, from_parent_id,
 
2662
                     to_rel, to_tail, to_parent_id, only_change_inv=False):
 
2663
            self.from_rel = from_rel
 
2664
            self.from_id = from_id
 
2665
            self.from_tail = from_tail
 
2666
            self.from_parent_id = from_parent_id
 
2667
            self.to_rel = to_rel
 
2668
            self.to_tail = to_tail
 
2669
            self.to_parent_id = to_parent_id
 
2670
            self.only_change_inv = only_change_inv
 
2671
 
 
2672
    def _determine_mv_mode(self, rename_entries, after=False):
 
2673
        """Determines for each from-to pair if both inventory and working tree
 
2674
        or only the inventory has to be changed.
 
2675
 
 
2676
        Also does basic plausability tests.
 
2677
        """
 
2678
        inv = self.inventory
 
2679
 
 
2680
        for rename_entry in rename_entries:
 
2681
            # store to local variables for easier reference
 
2682
            from_rel = rename_entry.from_rel
 
2683
            from_id = rename_entry.from_id
 
2684
            to_rel = rename_entry.to_rel
 
2685
            to_id = inv.path2id(to_rel)
 
2686
            only_change_inv = False
 
2687
 
 
2688
            # check the inventory for source and destination
 
2689
            if from_id is None:
 
2690
                raise errors.BzrMoveFailedError(from_rel,to_rel,
 
2691
                    errors.NotVersionedError(path=from_rel))
 
2692
            if to_id is not None:
 
2693
                raise errors.BzrMoveFailedError(from_rel,to_rel,
 
2694
                    errors.AlreadyVersionedError(path=to_rel))
 
2695
 
 
2696
            # try to determine the mode for rename (only change inv or change
 
2697
            # inv and file system)
 
2698
            if after:
 
2699
                if not self.has_filename(to_rel):
 
2700
                    raise errors.BzrMoveFailedError(from_id,to_rel,
 
2701
                        errors.NoSuchFile(path=to_rel,
 
2702
                        extra="New file has not been created yet"))
 
2703
                only_change_inv = True
 
2704
            elif not self.has_filename(from_rel) and self.has_filename(to_rel):
 
2705
                only_change_inv = True
 
2706
            elif self.has_filename(from_rel) and not self.has_filename(to_rel):
 
2707
                only_change_inv = False
 
2708
            elif (not self.case_sensitive
 
2709
                  and from_rel.lower() == to_rel.lower()
 
2710
                  and self.has_filename(from_rel)):
 
2711
                only_change_inv = False
 
2712
            else:
 
2713
                # something is wrong, so lets determine what exactly
 
2714
                if not self.has_filename(from_rel) and \
 
2715
                   not self.has_filename(to_rel):
 
2716
                    raise errors.BzrRenameFailedError(from_rel,to_rel,
 
2717
                        errors.PathsDoNotExist(paths=(str(from_rel),
 
2718
                        str(to_rel))))
 
2719
                else:
 
2720
                    raise errors.RenameFailedFilesExist(from_rel, to_rel)
 
2721
            rename_entry.only_change_inv = only_change_inv
 
2722
        return rename_entries
 
2723
 
 
2724
    def _move(self, rename_entries):
 
2725
        """Moves a list of files.
 
2726
 
 
2727
        Depending on the value of the flag 'only_change_inv', the
 
2728
        file will be moved on the file system or not.
 
2729
        """
 
2730
        inv = self.inventory
 
2731
        moved = []
 
2732
 
 
2733
        for entry in rename_entries:
 
2734
            try:
 
2735
                self._move_entry(entry)
 
2736
            except:
 
2737
                self._rollback_move(moved)
 
2738
                raise
 
2739
            moved.append(entry)
 
2740
 
 
2741
    def _rollback_move(self, moved):
 
2742
        """Try to rollback a previous move in case of an filesystem error."""
 
2743
        inv = self.inventory
 
2744
        for entry in moved:
 
2745
            try:
 
2746
                self._move_entry(WorkingTree._RenameEntry(
 
2747
                    entry.to_rel, entry.from_id,
 
2748
                    entry.to_tail, entry.to_parent_id, entry.from_rel,
 
2749
                    entry.from_tail, entry.from_parent_id,
 
2750
                    entry.only_change_inv))
 
2751
            except errors.BzrMoveFailedError, e:
 
2752
                raise errors.BzrMoveFailedError( '', '', "Rollback failed."
 
2753
                        " The working tree is in an inconsistent state."
 
2754
                        " Please consider doing a 'bzr revert'."
 
2755
                        " Error message is: %s" % e)
 
2756
 
 
2757
    def _move_entry(self, entry):
 
2758
        inv = self.inventory
 
2759
        from_rel_abs = self.abspath(entry.from_rel)
 
2760
        to_rel_abs = self.abspath(entry.to_rel)
 
2761
        if from_rel_abs == to_rel_abs:
 
2762
            raise errors.BzrMoveFailedError(entry.from_rel, entry.to_rel,
 
2763
                "Source and target are identical.")
 
2764
 
 
2765
        if not entry.only_change_inv:
 
2766
            try:
 
2767
                osutils.rename(from_rel_abs, to_rel_abs)
 
2768
            except OSError, e:
 
2769
                raise errors.BzrMoveFailedError(entry.from_rel,
 
2770
                    entry.to_rel, e[1])
 
2771
        inv.rename(entry.from_id, entry.to_parent_id, entry.to_tail)
 
2772
 
 
2773
    @needs_tree_write_lock
 
2774
    def unversion(self, file_ids):
 
2775
        """Remove the file ids in file_ids from the current versioned set.
 
2776
 
 
2777
        When a file_id is unversioned, all of its children are automatically
 
2778
        unversioned.
 
2779
 
 
2780
        :param file_ids: The file ids to stop versioning.
 
2781
        :raises: NoSuchId if any fileid is not currently versioned.
 
2782
        """
 
2783
        for file_id in file_ids:
 
2784
            if file_id not in self._inventory:
 
2785
                raise errors.NoSuchId(self, file_id)
 
2786
        for file_id in file_ids:
 
2787
            if self._inventory.has_id(file_id):
 
2788
                self._inventory.remove_recursive_id(file_id)
 
2789
        if len(file_ids):
 
2790
            # in the future this should just set a dirty bit to wait for the
 
2791
            # final unlock. However, until all methods of workingtree start
 
2792
            # with the current in -memory inventory rather than triggering
 
2793
            # a read, it is more complex - we need to teach read_inventory
 
2794
            # to know when to read, and when to not read first... and possibly
 
2795
            # to save first when the in memory one may be corrupted.
 
2796
            # so for now, we just only write it if it is indeed dirty.
 
2797
            # - RBC 20060907
 
2798
            self._write_inventory(self._inventory)
 
2799
 
 
2800
    def stored_kind(self, file_id):
 
2801
        """See Tree.stored_kind"""
 
2802
        return self.inventory[file_id].kind
 
2803
 
 
2804
    def extras(self):
 
2805
        """Yield all unversioned files in this WorkingTree.
 
2806
 
 
2807
        If there are any unversioned directories then only the directory is
 
2808
        returned, not all its children.  But if there are unversioned files
 
2809
        under a versioned subdirectory, they are returned.
 
2810
 
 
2811
        Currently returned depth-first, sorted by name within directories.
 
2812
        This is the same order used by 'osutils.walkdirs'.
 
2813
        """
 
2814
        ## TODO: Work from given directory downwards
 
2815
        for path, dir_entry in self.inventory.directories():
 
2816
            # mutter("search for unknowns in %r", path)
 
2817
            dirabs = self.abspath(path)
 
2818
            if not isdir(dirabs):
 
2819
                # e.g. directory deleted
 
2820
                continue
 
2821
 
 
2822
            fl = []
 
2823
            for subf in os.listdir(dirabs):
 
2824
                if self.bzrdir.is_control_filename(subf):
 
2825
                    continue
 
2826
                if subf not in dir_entry.children:
 
2827
                    try:
 
2828
                        (subf_norm,
 
2829
                         can_access) = osutils.normalized_filename(subf)
 
2830
                    except UnicodeDecodeError:
 
2831
                        path_os_enc = path.encode(osutils._fs_enc)
 
2832
                        relpath = path_os_enc + '/' + subf
 
2833
                        raise errors.BadFilenameEncoding(relpath,
 
2834
                                                         osutils._fs_enc)
 
2835
                    if subf_norm != subf and can_access:
 
2836
                        if subf_norm not in dir_entry.children:
 
2837
                            fl.append(subf_norm)
 
2838
                    else:
 
2839
                        fl.append(subf)
 
2840
 
 
2841
            fl.sort()
 
2842
            for subf in fl:
 
2843
                subp = pathjoin(path, subf)
 
2844
                yield subp
 
2845
 
 
2846
    def _walkdirs(self, prefix=""):
 
2847
        """Walk the directories of this tree.
 
2848
 
 
2849
           :prefix: is used as the directrory to start with.
 
2850
           returns a generator which yields items in the form:
 
2851
                ((curren_directory_path, fileid),
 
2852
                 [(file1_path, file1_name, file1_kind, None, file1_id,
 
2853
                   file1_kind), ... ])
 
2854
        """
 
2855
        _directory = 'directory'
 
2856
        # get the root in the inventory
 
2857
        inv = self.inventory
 
2858
        top_id = inv.path2id(prefix)
 
2859
        if top_id is None:
 
2860
            pending = []
 
2861
        else:
 
2862
            pending = [(prefix, '', _directory, None, top_id, None)]
 
2863
        while pending:
 
2864
            dirblock = []
 
2865
            currentdir = pending.pop()
 
2866
            # 0 - relpath, 1- basename, 2- kind, 3- stat, 4-id, 5-kind
 
2867
            top_id = currentdir[4]
 
2868
            if currentdir[0]:
 
2869
                relroot = currentdir[0] + '/'
 
2870
            else:
 
2871
                relroot = ""
 
2872
            # FIXME: stash the node in pending
 
2873
            entry = inv[top_id]
 
2874
            if entry.kind == 'directory':
 
2875
                for name, child in entry.sorted_children():
 
2876
                    dirblock.append((relroot + name, name, child.kind, None,
 
2877
                        child.file_id, child.kind
 
2878
                        ))
 
2879
            yield (currentdir[0], entry.file_id), dirblock
 
2880
            # push the user specified dirs from dirblock
 
2881
            for dir in reversed(dirblock):
 
2882
                if dir[2] == _directory:
 
2883
                    pending.append(dir)
 
2884
 
 
2885
 
 
2886
class WorkingTree3(InventoryWorkingTree):
2666
2887
    """This is the Format 3 working tree.
2667
2888
 
2668
2889
    This differs from the base WorkingTree by:
2721
2942
                    raise errors.ConflictFormatError()
2722
2943
            except StopIteration:
2723
2944
                raise errors.ConflictFormatError()
2724
 
            return _mod_conflicts.ConflictList.from_stanzas(RioReader(confile))
 
2945
            reader = _mod_rio.RioReader(confile)
 
2946
            return _mod_conflicts.ConflictList.from_stanzas(reader)
2725
2947
        finally:
2726
2948
            confile.close()
2727
2949
 
2740
2962
            self.branch.unlock()
2741
2963
 
2742
2964
 
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):
 
2965
class WorkingTreeFormatRegistry(controldir.ControlComponentFormatRegistry):
 
2966
    """Registry for working tree formats."""
 
2967
 
 
2968
    def __init__(self, other_registry=None):
 
2969
        super(WorkingTreeFormatRegistry, self).__init__(other_registry)
 
2970
        self._default_format = None
 
2971
        self._default_format_key = None
 
2972
 
 
2973
    def get_default(self):
 
2974
        """Return the current default format."""
 
2975
        if (self._default_format_key is not None and
 
2976
            self._default_format is None):
 
2977
            self._default_format = self.get(self._default_format_key)
 
2978
        return self._default_format
 
2979
 
 
2980
    def set_default(self, format):
 
2981
        self._default_format = format
 
2982
        self._default_format_key = None
 
2983
 
 
2984
    def set_default_key(self, format_string):
 
2985
        self._default_format_key = format_string
 
2986
        self._default_format = None
 
2987
 
 
2988
 
 
2989
format_registry = WorkingTreeFormatRegistry()
 
2990
 
 
2991
 
 
2992
class WorkingTreeFormat(controldir.ControlComponentFormat):
2750
2993
    """An encapsulation of the initialization and open routines for a format.
2751
2994
 
2752
2995
    Formats provide three things:
2764
3007
    object will be created every time regardless.
2765
3008
    """
2766
3009
 
2767
 
    _default_format = None
2768
 
    """The default format used for new trees."""
2769
 
 
2770
 
    _formats = {}
2771
 
    """The known formats."""
2772
 
 
2773
3010
    requires_rich_root = False
2774
3011
 
2775
3012
    upgrade_recommended = False
2776
3013
 
 
3014
    requires_normalized_unicode_filenames = False
 
3015
 
 
3016
    case_sensitive_filename = "FoRMaT"
 
3017
 
 
3018
    missing_parent_conflicts = False
 
3019
    """If this format supports missing parent conflicts."""
 
3020
 
 
3021
    @classmethod
 
3022
    def find_format_string(klass, a_bzrdir):
 
3023
        """Return format name for the working tree object in a_bzrdir."""
 
3024
        try:
 
3025
            transport = a_bzrdir.get_workingtree_transport(None)
 
3026
            return transport.get_bytes("format")
 
3027
        except errors.NoSuchFile:
 
3028
            raise errors.NoWorkingTree(base=transport.base)
 
3029
 
2777
3030
    @classmethod
2778
3031
    def find_format(klass, a_bzrdir):
2779
3032
        """Return the format for the working tree object in a_bzrdir."""
2780
3033
        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)
 
3034
            format_string = klass.find_format_string(a_bzrdir)
 
3035
            return format_registry.get(format_string)
2786
3036
        except KeyError:
2787
3037
            raise errors.UnknownFormatError(format=format_string,
2788
3038
                                            kind="working tree")
2789
3039
 
 
3040
    def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
 
3041
                   accelerator_tree=None, hardlink=False):
 
3042
        """Initialize a new working tree in a_bzrdir.
 
3043
 
 
3044
        :param a_bzrdir: BzrDir to initialize the working tree in.
 
3045
        :param revision_id: allows creating a working tree at a different
 
3046
            revision than the branch is at.
 
3047
        :param from_branch: Branch to checkout
 
3048
        :param accelerator_tree: A tree which can be used for retrieving file
 
3049
            contents more quickly than the revision tree, i.e. a workingtree.
 
3050
            The revision tree will be used for cases where accelerator_tree's
 
3051
            content is different.
 
3052
        :param hardlink: If true, hard-link files from accelerator_tree,
 
3053
            where possible.
 
3054
        """
 
3055
        raise NotImplementedError(self.initialize)
 
3056
 
2790
3057
    def __eq__(self, other):
2791
3058
        return self.__class__ is other.__class__
2792
3059
 
2794
3061
        return not (self == other)
2795
3062
 
2796
3063
    @classmethod
 
3064
    @symbol_versioning.deprecated_method(
 
3065
        symbol_versioning.deprecated_in((2, 4, 0)))
2797
3066
    def get_default_format(klass):
2798
3067
        """Return the current default format."""
2799
 
        return klass._default_format
 
3068
        return format_registry.get_default()
2800
3069
 
2801
3070
    def get_format_string(self):
2802
3071
        """Return the ASCII format string that identifies this format."""
2824
3093
        return False
2825
3094
 
2826
3095
    @classmethod
 
3096
    @symbol_versioning.deprecated_method(
 
3097
        symbol_versioning.deprecated_in((2, 4, 0)))
2827
3098
    def register_format(klass, format):
2828
 
        klass._formats[format.get_format_string()] = format
2829
 
 
2830
 
    @classmethod
 
3099
        format_registry.register(format)
 
3100
 
 
3101
    @classmethod
 
3102
    @symbol_versioning.deprecated_method(
 
3103
        symbol_versioning.deprecated_in((2, 4, 0)))
 
3104
    def register_extra_format(klass, format):
 
3105
        format_registry.register_extra(format)
 
3106
 
 
3107
    @classmethod
 
3108
    @symbol_versioning.deprecated_method(
 
3109
        symbol_versioning.deprecated_in((2, 4, 0)))
 
3110
    def unregister_extra_format(klass, format):
 
3111
        format_registry.unregister_extra(format)
 
3112
 
 
3113
    @classmethod
 
3114
    @symbol_versioning.deprecated_method(
 
3115
        symbol_versioning.deprecated_in((2, 4, 0)))
 
3116
    def get_formats(klass):
 
3117
        return format_registry._get_all()
 
3118
 
 
3119
    @classmethod
 
3120
    @symbol_versioning.deprecated_method(
 
3121
        symbol_versioning.deprecated_in((2, 4, 0)))
2831
3122
    def set_default_format(klass, format):
2832
 
        klass._default_format = format
 
3123
        format_registry.set_default(format)
2833
3124
 
2834
3125
    @classmethod
 
3126
    @symbol_versioning.deprecated_method(
 
3127
        symbol_versioning.deprecated_in((2, 4, 0)))
2835
3128
    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
 
3129
        format_registry.remove(format)
 
3130
 
2920
3131
 
2921
3132
class WorkingTreeFormat3(WorkingTreeFormat):
2922
3133
    """The second working tree format updated to record a format marker.
2932
3143
 
2933
3144
    upgrade_recommended = True
2934
3145
 
 
3146
    missing_parent_conflicts = True
 
3147
 
2935
3148
    def get_format_string(self):
2936
3149
        """See WorkingTreeFormat.get_format_string()."""
2937
3150
        return "Bazaar-NG Working Tree format 3"
3049
3262
        return self.get_format_string()
3050
3263
 
3051
3264
 
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
 
                   ]
 
3265
format_registry.register_lazy("Bazaar Working Tree Format 4 (bzr 0.15)\n",
 
3266
    "bzrlib.workingtree_4", "WorkingTreeFormat4")
 
3267
format_registry.register_lazy("Bazaar Working Tree Format 5 (bzr 1.11)\n",
 
3268
    "bzrlib.workingtree_4", "WorkingTreeFormat5")
 
3269
format_registry.register_lazy("Bazaar Working Tree Format 6 (bzr 1.14)\n",
 
3270
    "bzrlib.workingtree_4", "WorkingTreeFormat6")
 
3271
format_registry.register(WorkingTreeFormat3())
 
3272
format_registry.set_default_key("Bazaar Working Tree Format 6 (bzr 1.14)\n")