/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to bzrlib/workingtree.py

  • Committer: Jelmer Vernooij
  • Date: 2011-05-03 23:54:46 UTC
  • mto: This revision was merged to the branch mainline in revision 5830.
  • Revision ID: jelmer@samba.org-20110503235446-1rsduyaabkjz8hha
Move WorkingTree3 to bzrlib.workingtree_3.

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