~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/workingtree.py

  • Committer: Jelmer Vernooij
  • Date: 2011-05-01 21:02:50 UTC
  • mto: This revision was merged to the branch mainline in revision 5842.
  • Revision ID: jelmer@samba.org-20110501210250-24jq6hrxxc9psvzf
Actually use branch format 5 in branch format 5 test.

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