~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/workingtree.py

  • Committer: Patch Queue Manager
  • Date: 2011-09-22 14:12:18 UTC
  • mfrom: (6155.3.1 jam)
  • Revision ID: pqm@pqm.ubuntu.com-20110922141218-86s4uu6nqvourw4f
(jameinel) Cleanup comments bzrlib/smart/__init__.py (John A Meinel)

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