~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/workingtree.py

  • Committer: Patch Queue Manager
  • Date: 2016-02-01 19:13:13 UTC
  • mfrom: (6614.2.2 trunk)
  • Revision ID: pqm@pqm.ubuntu.com-20160201191313-wdfvmfff1djde6oq
(vila) Release 2.7.0 (Vincent Ladeuil)

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
29
29
WorkingTree.open(dir).
30
30
"""
31
31
 
 
32
from __future__ import absolute_import
32
33
 
33
34
from cStringIO import StringIO
34
35
import os
44
45
import stat
45
46
import re
46
47
 
47
 
import bzrlib
48
48
from bzrlib import (
49
49
    branch,
50
 
    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,
 
63
    shelf,
64
64
    transform,
65
65
    transport,
66
66
    ui,
68
68
    xml5,
69
69
    xml7,
70
70
    )
71
 
from bzrlib.workingtree_4 import (
72
 
    WorkingTreeFormat4,
73
 
    WorkingTreeFormat5,
74
 
    WorkingTreeFormat6,
75
 
    )
76
71
""")
77
72
 
78
 
from bzrlib import symbol_versioning
 
73
# Explicitly import bzrlib.bzrdir so that the BzrProber
 
74
# is guaranteed to be registered.
 
75
from bzrlib import (
 
76
    bzrdir,
 
77
    symbol_versioning,
 
78
    )
 
79
 
79
80
from bzrlib.decorators import needs_read_lock, needs_write_lock
 
81
from bzrlib.i18n import gettext
80
82
from bzrlib.lock import LogicalLockResult
81
 
from bzrlib.lockable_files import LockableFiles
82
 
from bzrlib.lockdir import LockDir
83
83
import bzrlib.mutabletree
84
84
from bzrlib.mutabletree import needs_tree_write_lock
85
85
from bzrlib import osutils
91
91
    realpath,
92
92
    safe_unicode,
93
93
    splitpath,
94
 
    supports_executable,
95
94
    )
96
 
from bzrlib.filters import filtered_input_file
97
95
from bzrlib.trace import mutter, note
98
 
from bzrlib.transport.local import LocalTransport
99
96
from bzrlib.revision import CURRENT_REVISION
100
 
from bzrlib.rio import RioReader, rio_file, Stanza
101
97
from bzrlib.symbol_versioning import (
102
98
    deprecated_passed,
103
99
    DEPRECATED_PARAMETER,
172
168
    controldir.ControlComponent):
173
169
    """Working copy tree.
174
170
 
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
171
    :ivar basedir: The root of the tree on disk. This is a unicode path object
182
172
        (as opposed to a URL).
183
173
    """
188
178
 
189
179
    def __init__(self, basedir='.',
190
180
                 branch=DEPRECATED_PARAMETER,
191
 
                 _inventory=None,
192
 
                 _control_files=None,
193
181
                 _internal=False,
 
182
                 _transport=None,
194
183
                 _format=None,
195
184
                 _bzrdir=None):
196
185
        """Construct a WorkingTree instance. This is not a public API.
209
198
        else:
210
199
            self._branch = self.bzrdir.open_branch()
211
200
        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
219
 
        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()
 
201
        self._transport = _transport
251
202
        self._rules_searcher = None
252
203
        self.views = self._make_views()
253
204
 
259
210
    def control_transport(self):
260
211
        return self._transport
261
212
 
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()
 
213
    def is_control_filename(self, filename):
 
214
        """True if filename is the name of a control file in this tree.
 
215
 
 
216
        :param filename: A filename within the tree. This is a relative path
 
217
            from the root of this tree.
 
218
 
 
219
        This is true IF and ONLY IF the filename is part of the meta data
 
220
        that bzr controls in this tree. I.E. a random .bzr directory placed
 
221
        on disk will not be a control file for this tree.
 
222
        """
 
223
        return self.bzrdir.is_control_filename(filename)
272
224
 
273
225
    branch = property(
274
226
        fget=lambda self: self._branch,
278
230
            the working tree has been constructed from.
279
231
            """)
280
232
 
 
233
    def has_versioned_directories(self):
 
234
        """See `Tree.has_versioned_directories`."""
 
235
        return self._format.supports_versioned_directories
 
236
 
 
237
    def _supports_executable(self):
 
238
        if sys.platform == 'win32':
 
239
            return False
 
240
        # FIXME: Ideally this should check the file system
 
241
        return True
 
242
 
281
243
    def break_lock(self):
282
244
        """Break a lock if one is present from another instance.
283
245
 
286
248
 
287
249
        This will probe the repository for its lock as well.
288
250
        """
289
 
        self._control_files.break_lock()
290
 
        self.branch.break_lock()
291
 
 
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 []
 
251
        raise NotImplementedError(self.break_lock)
301
252
 
302
253
    def requires_rich_root(self):
303
254
        return self._format.requires_rich_root
311
262
    def supports_views(self):
312
263
        return self.views.supports_views()
313
264
 
314
 
    def _set_inventory(self, inv, dirty):
315
 
        """Set the internal cached inventory.
 
265
    def get_config_stack(self):
 
266
        """Retrieve the config stack for this tree.
316
267
 
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.
 
268
        :return: A ``bzrlib.config.Stack``
323
269
        """
324
 
        self._inventory = inv
325
 
        self._inventory_is_modified = dirty
 
270
        # For the moment, just provide the branch config stack.
 
271
        return self.branch.get_config_stack()
326
272
 
327
273
    @staticmethod
328
274
    def open(path=None, _unsupported=False):
331
277
        """
332
278
        if path is None:
333
279
            path = osutils.getcwd()
334
 
        control = bzrdir.BzrDir.open(path, _unsupported)
335
 
        return control.open_workingtree(_unsupported)
 
280
        control = controldir.ControlDir.open(path, _unsupported=_unsupported)
 
281
        return control.open_workingtree(unsupported=_unsupported)
336
282
 
337
283
    @staticmethod
338
284
    def open_containing(path=None):
349
295
        """
350
296
        if path is None:
351
297
            path = osutils.getcwd()
352
 
        control, relpath = bzrdir.BzrDir.open_containing(path)
 
298
        control, relpath = controldir.ControlDir.open_containing(path)
353
299
        return control.open_workingtree(), relpath
354
300
 
355
301
    @staticmethod
356
 
    def open_containing_paths(file_list, default_directory='.',
357
 
        canonicalize=True, apply_view=True):
 
302
    def open_containing_paths(file_list, default_directory=None,
 
303
                              canonicalize=True, apply_view=True):
358
304
        """Open the WorkingTree that contains a set of paths.
359
305
 
360
306
        Fail if the paths given are not all in a single tree.
362
308
        This is used for the many command-line interfaces that take a list of
363
309
        any number of files and that require they all be in the same tree.
364
310
        """
 
311
        if default_directory is None:
 
312
            default_directory = u'.'
365
313
        # recommended replacement for builtins.internal_tree_files
366
314
        if file_list is None or len(file_list) == 0:
367
315
            tree = WorkingTree.open_containing(default_directory)[0]
373
321
                if view_files:
374
322
                    file_list = view_files
375
323
                    view_str = views.view_display_str(view_files)
376
 
                    note("Ignoring files outside view. View is %s" % view_str)
 
324
                    note(gettext("Ignoring files outside view. View is %s") % view_str)
377
325
            return tree, file_list
378
 
        tree = WorkingTree.open_containing(file_list[0])[0]
 
326
        if default_directory == u'.':
 
327
            seed = file_list[0]
 
328
        else:
 
329
            seed = default_directory
 
330
            file_list = [osutils.pathjoin(default_directory, f)
 
331
                         for f in file_list]
 
332
        tree = WorkingTree.open_containing(seed)[0]
379
333
        return tree, tree.safe_relpath_files(file_list, canonicalize,
380
 
            apply_view=apply_view)
 
334
                                             apply_view=apply_view)
381
335
 
382
336
    def safe_relpath_files(self, file_list, canonicalize=True, apply_view=True):
383
337
        """Convert file_list into a list of relpaths in tree.
430
384
            else:
431
385
                return True, tree
432
386
        t = transport.get_transport(location)
433
 
        iterator = bzrdir.BzrDir.find_bzrdirs(t, evaluate=evaluate,
 
387
        iterator = controldir.ControlDir.find_bzrdirs(t, evaluate=evaluate,
434
388
                                              list_current=list_current)
435
389
        return [tr for tr in iterator if tr is not None]
436
390
 
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
 
    def all_file_ids(self):
452
 
        """See Tree.iter_all_file_ids"""
453
 
        return set(self.inventory)
454
 
 
455
391
    def __repr__(self):
456
392
        return "<%s of %s>" % (self.__class__.__name__,
457
393
                               getattr(self, 'basedir', None))
511
447
        return self.get_file_with_stat(file_id, path, filtered=filtered)[0]
512
448
 
513
449
    def get_file_with_stat(self, file_id, path=None, filtered=True,
514
 
        _fstat=os.fstat):
 
450
                           _fstat=osutils.fstat):
515
451
        """See Tree.get_file_with_stat."""
516
452
        if path is None:
517
453
            path = self.id2path(file_id)
519
455
        stat_value = _fstat(file_obj.fileno())
520
456
        if filtered and self.supports_content_filtering():
521
457
            filters = self._content_filter_stack(path)
522
 
            file_obj = filtered_input_file(file_obj, filters)
 
458
            file_obj = _mod_filters.filtered_input_file(file_obj, filters)
523
459
        return (file_obj, stat_value)
524
460
 
525
461
    def get_file_text(self, file_id, path=None, filtered=True):
534
470
        f = file(path, 'rb')
535
471
        if filtered and self.supports_content_filtering():
536
472
            filters = self._content_filter_stack(filename)
537
 
            return filtered_input_file(f, filters)
 
473
            return _mod_filters.filtered_input_file(f, filters)
538
474
        else:
539
475
            return f
540
476
 
546
482
        finally:
547
483
            file.close()
548
484
 
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
485
    def get_parent_ids(self):
605
486
        """See Tree.get_parent_ids.
606
487
 
622
503
                parents.append(revision_id)
623
504
        return parents
624
505
 
625
 
    @needs_read_lock
626
506
    def get_root_id(self):
627
507
        """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))
 
508
        raise NotImplementedError(self.get_root_id)
633
509
 
634
510
    @needs_read_lock
635
 
    def clone(self, to_bzrdir, revision_id=None):
 
511
    def clone(self, to_controldir, revision_id=None):
636
512
        """Duplicate this working tree into to_bzr, including all state.
637
513
 
638
514
        Specifically modified files are kept as modified, but
639
515
        ignored and unknown files are discarded.
640
516
 
641
 
        If you want to make a new line of development, see bzrdir.sprout()
 
517
        If you want to make a new line of development, see ControlDir.sprout()
642
518
 
643
519
        revision
644
520
            If not None, the cloned tree will have its last revision set to
646
522
            and this one merged in.
647
523
        """
648
524
        # assumes the target bzr dir format is compatible.
649
 
        result = to_bzrdir.create_workingtree()
 
525
        result = to_controldir.create_workingtree()
650
526
        self.copy_content_into(result, revision_id)
651
527
        return result
652
528
 
659
535
        else:
660
536
            # TODO now merge from tree.last_revision to revision (to preserve
661
537
            # user local changes)
662
 
            merge.transform_tree(tree, self)
663
 
            tree.set_parent_ids([revision_id])
 
538
            try:
 
539
                other_tree = self.revision_tree(revision_id)
 
540
            except errors.NoSuchRevision:
 
541
                other_tree = self.branch.repository.revision_tree(revision_id)
 
542
 
 
543
            merge.transform_tree(tree, other_tree)
 
544
            if revision_id == _mod_revision.NULL_REVISION:
 
545
                new_parents = []
 
546
            else:
 
547
                new_parents = [revision_id]
 
548
            tree.set_parent_ids(new_parents)
664
549
 
665
550
    def id2abspath(self, file_id):
666
551
        return self.abspath(self.id2path(file_id))
667
552
 
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
 
553
    def _check_for_tree_references(self, iterator):
 
554
        """See if directories have become tree-references."""
 
555
        blocked_parent_ids = set()
 
556
        for path, ie in iterator:
 
557
            if ie.parent_id in blocked_parent_ids:
 
558
                # This entry was pruned because one of its parents became a
 
559
                # TreeReference. If this is a directory, mark it as blocked.
 
560
                if ie.kind == 'directory':
 
561
                    blocked_parent_ids.add(ie.file_id)
 
562
                continue
 
563
            if ie.kind == 'directory' and self._directory_is_tree_reference(path):
 
564
                # This InventoryDirectory needs to be a TreeReference
 
565
                ie = inventory.TreeReference(ie.file_id, ie.name, ie.parent_id)
 
566
                blocked_parent_ids.add(ie.file_id)
 
567
            yield path, ie
 
568
 
 
569
    def iter_entries_by_dir(self, specific_file_ids=None, yield_parents=False):
 
570
        """See Tree.iter_entries_by_dir()"""
 
571
        # The only trick here is that if we supports_tree_reference then we
 
572
        # need to detect if a directory becomes a tree-reference.
 
573
        iterator = super(WorkingTree, self).iter_entries_by_dir(
 
574
                specific_file_ids=specific_file_ids,
 
575
                yield_parents=yield_parents)
 
576
        if not self.supports_tree_reference():
 
577
            return iterator
 
578
        else:
 
579
            return self._check_for_tree_references(iterator)
682
580
 
683
581
    def get_file_size(self, file_id):
684
582
        """See Tree.get_file_size"""
692
590
            else:
693
591
                return None
694
592
 
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
593
    @needs_tree_write_lock
750
594
    def _gather_kinds(self, files, kinds):
751
595
        """See MutableTree._gather_kinds."""
766
610
        and setting the list to its value plus revision_id.
767
611
 
768
612
        :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.
 
613
            be a ghost revision as long as its not the first parent to be
 
614
            added, or the allow_leftmost_as_ghost parameter is set True.
771
615
        :param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
772
616
        """
773
617
        parents = self.get_parent_ids() + [revision_id]
876
720
            if revision_id in heads and revision_id not in new_revision_ids:
877
721
                new_revision_ids.append(revision_id)
878
722
        if new_revision_ids != revision_ids:
879
 
            trace.mutter('requested to set revision_ids = %s,'
 
723
            mutter('requested to set revision_ids = %s,'
880
724
                         ' but filtered to %s', revision_ids, new_revision_ids)
881
725
        return new_revision_ids
882
726
 
908
752
        self._set_merges_from_parent_ids(revision_ids)
909
753
 
910
754
    @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
755
    def set_pending_merges(self, rev_list):
942
756
        parents = self.get_parent_ids()
943
757
        leftmost = parents[:1]
946
760
 
947
761
    @needs_tree_write_lock
948
762
    def set_merge_modified(self, modified_hashes):
949
 
        def iter_stanzas():
950
 
            for file_id, hash in modified_hashes.iteritems():
951
 
                yield Stanza(file_id=file_id.decode('utf8'), hash=hash)
952
 
        self._put_rio('merge-hashes', iter_stanzas(), MERGE_MODIFIED_HEADER_1)
 
763
        """Set the merge modified hashes."""
 
764
        raise NotImplementedError(self.set_merge_modified)
953
765
 
954
766
    def _sha_from_stat(self, path, stat_result):
955
767
        """Get a sha digest from the tree's stat cache.
961
773
        """
962
774
        return None
963
775
 
964
 
    def _put_rio(self, filename, stanzas, header):
965
 
        self._must_be_locked()
966
 
        my_file = rio_file(stanzas, header)
967
 
        self._transport.put_file(filename, my_file,
968
 
            mode=self.bzrdir._get_file_mode())
969
 
 
970
776
    @needs_write_lock # because merge pulls data into the branch.
971
777
    def merge_from_branch(self, branch, to_revision=None, from_revision=None,
972
778
                          merge_type=None, force=False):
1011
817
        merger.set_pending()
1012
818
        return conflicts
1013
819
 
1014
 
    @needs_read_lock
1015
820
    def merge_modified(self):
1016
821
        """Return a dictionary of files modified by a merge.
1017
822
 
1022
827
        This returns a map of file_id->sha1, containing only files which are
1023
828
        still in the working inventory and have that text hash.
1024
829
        """
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()
 
830
        raise NotImplementedError(self.merge_modified)
1047
831
 
1048
832
    @needs_write_lock
1049
833
    def mkdir(self, path, file_id=None):
1054
838
        self.add(path, file_id, 'directory')
1055
839
        return file_id
1056
840
 
1057
 
    def get_symlink_target(self, file_id):
1058
 
        abspath = self.id2abspath(file_id)
 
841
    def get_symlink_target(self, file_id, path=None):
 
842
        if path is not None:
 
843
            abspath = self.abspath(path)
 
844
        else:
 
845
            abspath = self.id2abspath(file_id)
1059
846
        target = osutils.readlink(abspath)
1060
847
        return target
1061
848
 
1062
 
    @needs_write_lock
1063
849
    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()
 
850
        raise NotImplementedError(self.subsume)
1103
851
 
1104
852
    def _setup_directory_is_tree_reference(self):
1105
853
        if self._branch.repository._format.supports_tree_reference:
1127
875
        # checkout in a subdirectory.  This can be avoided by not adding
1128
876
        # it.  mbp 20070306
1129
877
 
1130
 
    @needs_tree_write_lock
1131
878
    def extract(self, file_id, format=None):
1132
879
        """Extract a subtree from this tree.
1133
880
 
1134
881
        A new branch will be created, relative to the path for this tree.
1135
882
        """
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)
 
883
        raise NotImplementedError(self.extract)
1186
884
 
1187
885
    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
 
886
        """Write the in memory meta data to disk."""
 
887
        raise NotImplementedError(self.flush)
1198
888
 
1199
889
    def _kind(self, relpath):
1200
890
        return osutils.file_kind(self.abspath(relpath))
1210
900
        :param from_dir: start from this directory or None for the root
1211
901
        :param recursive: whether to recurse into subdirectories or not
1212
902
        """
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
 
903
        raise NotImplementedError(self.list_files)
 
904
 
1330
905
    def move(self, from_paths, to_dir=None, after=False):
1331
906
        """Rename files.
1332
907
 
1333
 
        to_dir must exist in the inventory.
 
908
        to_dir must be known to the working tree.
1334
909
 
1335
910
        If to_dir exists and is a directory, the files are moved into
1336
911
        it, keeping their old names.
1342
917
        independently.
1343
918
 
1344
919
        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.
 
920
        working tree metadata. The second mode only updates the working tree
 
921
        metadata without touching the file on the filesystem.
1348
922
 
1349
923
        move uses the second mode if 'after == True' and the target is not
1350
924
        versioned but present in the working tree.
1362
936
        This returns a list of (from_path, to_path) pairs for each
1363
937
        entry that is moved.
1364
938
        """
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)
 
939
        raise NotImplementedError(self.move)
1527
940
 
1528
941
    @needs_tree_write_lock
1529
942
    def rename_one(self, from_rel, to_rel, after=False):
1533
946
 
1534
947
        rename_one has several 'modes' to work. First, it can rename a physical
1535
948
        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.
 
949
        only change the file_id without touching any physical file.
1538
950
 
1539
 
        rename_one uses the second mode if 'after == True' and 'to_rel' is not
1540
 
        versioned but present in the working tree.
 
951
        rename_one uses the second mode if 'after == True' and 'to_rel' is
 
952
        either not versioned or newly added, and present in the working tree.
1541
953
 
1542
954
        rename_one uses the second mode if 'after == False' and 'from_rel' is
1543
955
        versioned but no longer in the working tree, and 'to_rel' is not
1549
961
 
1550
962
        Everything else results in an error.
1551
963
        """
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
 
964
        raise NotImplementedError(self.rename_one)
1613
965
 
1614
966
    @needs_read_lock
1615
967
    def unknowns(self):
1623
975
        return iter(
1624
976
            [subp for subp in self.extras() if not self.is_ignored(subp)])
1625
977
 
1626
 
    @needs_tree_write_lock
1627
978
    def unversion(self, file_ids):
1628
979
        """Remove the file ids in file_ids from the current versioned set.
1629
980
 
1633
984
        :param file_ids: The file ids to stop versioning.
1634
985
        :raises: NoSuchId if any fileid is not currently versioned.
1635
986
        """
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
 
987
        raise NotImplementedError(self.unversion)
1663
988
 
1664
989
    @needs_write_lock
1665
990
    def pull(self, source, overwrite=False, stop_revision=None,
1666
 
             change_reporter=None, possible_transports=None, local=False):
 
991
             change_reporter=None, possible_transports=None, local=False,
 
992
             show_base=False):
1667
993
        source.lock_read()
1668
994
        try:
1669
995
            old_revision_info = self.branch.last_revision_info()
1674
1000
            new_revision_info = self.branch.last_revision_info()
1675
1001
            if new_revision_info != old_revision_info:
1676
1002
                repository = self.branch.repository
 
1003
                if repository._format.fast_deltas:
 
1004
                    parent_ids = self.get_parent_ids()
 
1005
                    if parent_ids:
 
1006
                        basis_id = parent_ids[0]
 
1007
                        basis_tree = repository.revision_tree(basis_id)
1677
1008
                basis_tree.lock_read()
1678
1009
                try:
1679
1010
                    new_basis_tree = self.branch.basis_tree()
1683
1014
                                basis_tree,
1684
1015
                                this_tree=self,
1685
1016
                                pb=None,
1686
 
                                change_reporter=change_reporter)
 
1017
                                change_reporter=change_reporter,
 
1018
                                show_base=show_base)
1687
1019
                    basis_root_id = basis_tree.get_root_id()
1688
1020
                    new_root_id = new_basis_tree.get_root_id()
1689
 
                    if basis_root_id != new_root_id:
 
1021
                    if new_root_id is not None and basis_root_id != new_root_id:
1690
1022
                        self.set_root_id(new_root_id)
1691
1023
                finally:
1692
1024
                    basis_tree.unlock()
1693
1025
                # TODO - dedup parents list with things merged by pull ?
1694
1026
                # reuse the revisiontree we merged against to set the new
1695
1027
                # tree data.
1696
 
                parent_trees = [(self.branch.last_revision(), new_basis_tree)]
 
1028
                parent_trees = []
 
1029
                if self.branch.last_revision() != _mod_revision.NULL_REVISION:
 
1030
                    parent_trees.append(
 
1031
                        (self.branch.last_revision(), new_basis_tree))
1697
1032
                # we have to pull the merge trees out again, because
1698
1033
                # merge_inner has set the ids. - this corner is not yet
1699
1034
                # layered well enough to prevent double handling.
1716
1051
            stream.write(bytes)
1717
1052
        finally:
1718
1053
            stream.close()
1719
 
        # TODO: update the hashcache here ?
1720
1054
 
1721
1055
    def extras(self):
1722
1056
        """Yield all unversioned files in this WorkingTree.
1728
1062
        Currently returned depth-first, sorted by name within directories.
1729
1063
        This is the same order used by 'osutils.walkdirs'.
1730
1064
        """
1731
 
        ## TODO: Work from given directory downwards
1732
 
        for path, dir_entry in self.inventory.directories():
1733
 
            # mutter("search for unknowns in %r", path)
1734
 
            dirabs = self.abspath(path)
1735
 
            if not isdir(dirabs):
1736
 
                # e.g. directory deleted
1737
 
                continue
1738
 
 
1739
 
            fl = []
1740
 
            for subf in os.listdir(dirabs):
1741
 
                if self.bzrdir.is_control_filename(subf):
1742
 
                    continue
1743
 
                if subf not in dir_entry.children:
1744
 
                    try:
1745
 
                        (subf_norm,
1746
 
                         can_access) = osutils.normalized_filename(subf)
1747
 
                    except UnicodeDecodeError:
1748
 
                        path_os_enc = path.encode(osutils._fs_enc)
1749
 
                        relpath = path_os_enc + '/' + subf
1750
 
                        raise errors.BadFilenameEncoding(relpath,
1751
 
                                                         osutils._fs_enc)
1752
 
                    if subf_norm != subf and can_access:
1753
 
                        if subf_norm not in dir_entry.children:
1754
 
                            fl.append(subf_norm)
1755
 
                    else:
1756
 
                        fl.append(subf)
1757
 
 
1758
 
            fl.sort()
1759
 
            for subf in fl:
1760
 
                subp = pathjoin(path, subf)
1761
 
                yield subp
 
1065
        raise NotImplementedError(self.extras)
1762
1066
 
1763
1067
    def ignored_files(self):
1764
1068
        """Yield list of PATH, IGNORE_PATTERN"""
1813
1117
 
1814
1118
    def stored_kind(self, file_id):
1815
1119
        """See Tree.stored_kind"""
1816
 
        return self.inventory[file_id].kind
 
1120
        raise NotImplementedError(self.stored_kind)
1817
1121
 
1818
1122
    def _comparison_data(self, entry, path):
1819
1123
        abspath = self.abspath(path)
1829
1133
        else:
1830
1134
            mode = stat_value.st_mode
1831
1135
            kind = osutils.file_kind_from_stat_mode(mode)
1832
 
            if not supports_executable():
 
1136
            if not self._supports_executable():
1833
1137
                executable = entry is not None and entry.executable
1834
1138
            else:
1835
1139
                executable = bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
1854
1158
        return _mod_revision.ensure_null(self.branch.last_revision())
1855
1159
 
1856
1160
    def is_locked(self):
1857
 
        return self._control_files.is_locked()
1858
 
 
1859
 
    def _must_be_locked(self):
1860
 
        if not self.is_locked():
1861
 
            raise errors.ObjectNotLocked(self)
 
1161
        """Check if this tree is locked."""
 
1162
        raise NotImplementedError(self.is_locked)
1862
1163
 
1863
1164
    def lock_read(self):
1864
1165
        """Lock the tree for reading.
1867
1168
 
1868
1169
        :return: A bzrlib.lock.LogicalLockResult.
1869
1170
        """
1870
 
        if not self.is_locked():
1871
 
            self._reset_data()
1872
 
        self.branch.lock_read()
1873
 
        try:
1874
 
            self._control_files.lock_read()
1875
 
            return LogicalLockResult(self.unlock)
1876
 
        except:
1877
 
            self.branch.unlock()
1878
 
            raise
 
1171
        raise NotImplementedError(self.lock_read)
1879
1172
 
1880
1173
    def lock_tree_write(self):
1881
1174
        """See MutableTree.lock_tree_write, and WorkingTree.unlock.
1882
1175
 
1883
1176
        :return: A bzrlib.lock.LogicalLockResult.
1884
1177
        """
1885
 
        if not self.is_locked():
1886
 
            self._reset_data()
1887
 
        self.branch.lock_read()
1888
 
        try:
1889
 
            self._control_files.lock_write()
1890
 
            return LogicalLockResult(self.unlock)
1891
 
        except:
1892
 
            self.branch.unlock()
1893
 
            raise
 
1178
        raise NotImplementedError(self.lock_tree_write)
1894
1179
 
1895
1180
    def lock_write(self):
1896
1181
        """See MutableTree.lock_write, and WorkingTree.unlock.
1897
1182
 
1898
1183
        :return: A bzrlib.lock.LogicalLockResult.
1899
1184
        """
1900
 
        if not self.is_locked():
1901
 
            self._reset_data()
1902
 
        self.branch.lock_write()
1903
 
        try:
1904
 
            self._control_files.lock_write()
1905
 
            return LogicalLockResult(self.unlock)
1906
 
        except:
1907
 
            self.branch.unlock()
1908
 
            raise
 
1185
        raise NotImplementedError(self.lock_write)
1909
1186
 
1910
1187
    def get_physical_lock_status(self):
1911
 
        return self._control_files.get_physical_lock_status()
1912
 
 
1913
 
    def _basis_inventory_name(self):
1914
 
        return 'basis-inventory-cache'
1915
 
 
1916
 
    def _reset_data(self):
1917
 
        """Reset transient data that cannot be revalidated."""
1918
 
        self._inventory_is_modified = False
1919
 
        f = self._transport.get('inventory')
1920
 
        try:
1921
 
            result = self._deserialize(f)
1922
 
        finally:
1923
 
            f.close()
1924
 
        self._set_inventory(result, dirty=False)
1925
 
 
1926
 
    @needs_tree_write_lock
 
1188
        raise NotImplementedError(self.get_physical_lock_status)
 
1189
 
1927
1190
    def set_last_revision(self, new_revision):
1928
1191
        """Change the last revision in the working tree."""
1929
 
        if self._change_last_revision(new_revision):
1930
 
            self._cache_basis_inventory(new_revision)
 
1192
        raise NotImplementedError(self.set_last_revision)
1931
1193
 
1932
1194
    def _change_last_revision(self, new_revision):
1933
1195
        """Template method part of set_last_revision to perform the change.
1936
1198
        when their last revision is set.
1937
1199
        """
1938
1200
        if _mod_revision.is_null(new_revision):
1939
 
            self.branch.set_revision_history([])
 
1201
            self.branch.set_last_revision_info(0, new_revision)
1940
1202
            return False
 
1203
        _mod_revision.check_not_reserved_id(new_revision)
1941
1204
        try:
1942
1205
            self.branch.generate_revision_history(new_revision)
1943
1206
        except errors.NoSuchRevision:
1944
1207
            # not present in the repo - dont try to set it deeper than the tip
1945
 
            self.branch.set_revision_history([new_revision])
 
1208
            self.branch._set_revision_history([new_revision])
1946
1209
        return True
1947
1210
 
1948
 
    def _write_basis_inventory(self, xml):
1949
 
        """Write the basis inventory XML to the basis-inventory file"""
1950
 
        path = self._basis_inventory_name()
1951
 
        sio = StringIO(xml)
1952
 
        self._transport.put_file(path, sio,
1953
 
            mode=self.bzrdir._get_file_mode())
1954
 
 
1955
 
    def _create_basis_xml_from_inventory(self, revision_id, inventory):
1956
 
        """Create the text that will be saved in basis-inventory"""
1957
 
        inventory.revision_id = revision_id
1958
 
        return xml7.serializer_v7.write_inventory_to_string(inventory)
1959
 
 
1960
 
    def _cache_basis_inventory(self, new_revision):
1961
 
        """Cache new_revision as the basis inventory."""
1962
 
        # TODO: this should allow the ready-to-use inventory to be passed in,
1963
 
        # as commit already has that ready-to-use [while the format is the
1964
 
        # same, that is].
1965
 
        try:
1966
 
            # this double handles the inventory - unpack and repack -
1967
 
            # but is easier to understand. We can/should put a conditional
1968
 
            # in here based on whether the inventory is in the latest format
1969
 
            # - perhaps we should repack all inventories on a repository
1970
 
            # upgrade ?
1971
 
            # the fast path is to copy the raw xml from the repository. If the
1972
 
            # xml contains 'revision_id="', then we assume the right
1973
 
            # revision_id is set. We must check for this full string, because a
1974
 
            # root node id can legitimately look like 'revision_id' but cannot
1975
 
            # contain a '"'.
1976
 
            xml = self.branch.repository._get_inventory_xml(new_revision)
1977
 
            firstline = xml.split('\n', 1)[0]
1978
 
            if (not 'revision_id="' in firstline or
1979
 
                'format="7"' not in firstline):
1980
 
                inv = self.branch.repository._serializer.read_inventory_from_string(
1981
 
                    xml, new_revision)
1982
 
                xml = self._create_basis_xml_from_inventory(new_revision, inv)
1983
 
            self._write_basis_inventory(xml)
1984
 
        except (errors.NoSuchRevision, errors.RevisionNotPresent):
1985
 
            pass
1986
 
 
1987
 
    def read_basis_inventory(self):
1988
 
        """Read the cached basis inventory."""
1989
 
        path = self._basis_inventory_name()
1990
 
        return self._transport.get_bytes(path)
1991
 
 
1992
 
    @needs_read_lock
1993
 
    def read_working_inventory(self):
1994
 
        """Read the working inventory.
1995
 
 
1996
 
        :raises errors.InventoryModified: read_working_inventory will fail
1997
 
            when the current in memory inventory has been modified.
1998
 
        """
1999
 
        # conceptually this should be an implementation detail of the tree.
2000
 
        # XXX: Deprecate this.
2001
 
        # ElementTree does its own conversion from UTF-8, so open in
2002
 
        # binary.
2003
 
        if self._inventory_is_modified:
2004
 
            raise errors.InventoryModified(self)
2005
 
        f = self._transport.get('inventory')
2006
 
        try:
2007
 
            result = self._deserialize(f)
2008
 
        finally:
2009
 
            f.close()
2010
 
        self._set_inventory(result, dirty=False)
2011
 
        return result
2012
 
 
2013
1211
    @needs_tree_write_lock
2014
1212
    def remove(self, files, verbose=False, to_file=None, keep_files=True,
2015
1213
        force=False):
2016
 
        """Remove nominated files from the working inventory.
 
1214
        """Remove nominated files from the working tree metadata.
2017
1215
 
2018
1216
        :files: File paths relative to the basedir.
2019
1217
        :keep_files: If true, the files will also be kept.
2078
1276
                    files_to_backup.append(path[1])
2079
1277
 
2080
1278
        def backup(file_to_backup):
2081
 
            backup_name = self.bzrdir.generate_backup_name(file_to_backup)
 
1279
            backup_name = self.bzrdir._available_backup_name(file_to_backup)
2082
1280
            osutils.rename(abs_path, self.abspath(backup_name))
2083
 
            return "removed %s (but kept a copy: %s)" % (file_to_backup, backup_name)
 
1281
            return "removed %s (but kept a copy: %s)" % (file_to_backup,
 
1282
                                                         backup_name)
2084
1283
 
2085
1284
        # Build inv_delta and delete files where applicable,
2086
 
        # do this before any modifications to inventory.
 
1285
        # do this before any modifications to meta data.
2087
1286
        for f in files:
2088
1287
            fid = self.path2id(f)
2089
1288
            message = None
2132
1331
    def revert(self, filenames=None, old_tree=None, backups=True,
2133
1332
               pb=None, report_changes=False):
2134
1333
        from bzrlib.conflicts import resolve
2135
 
        if filenames == []:
2136
 
            filenames = None
2137
 
            symbol_versioning.warn('Using [] to revert all files is deprecated'
2138
 
                ' as of bzr 0.91.  Please use None (the default) instead.',
2139
 
                DeprecationWarning, stacklevel=2)
2140
1334
        if old_tree is None:
2141
1335
            basis_tree = self.basis_tree()
2142
1336
            basis_tree.lock_read()
2163
1357
                basis_tree.unlock()
2164
1358
        return conflicts
2165
1359
 
 
1360
    @needs_write_lock
 
1361
    def store_uncommitted(self):
 
1362
        """Store uncommitted changes from the tree in the branch."""
 
1363
        target_tree = self.basis_tree()
 
1364
        shelf_creator = shelf.ShelfCreator(self, target_tree)
 
1365
        try:
 
1366
            if not shelf_creator.shelve_all():
 
1367
                return
 
1368
            self.branch.store_uncommitted(shelf_creator)
 
1369
            shelf_creator.transform()
 
1370
        finally:
 
1371
            shelf_creator.finalize()
 
1372
        note('Uncommitted changes stored in branch "%s".', self.branch.nick)
 
1373
 
 
1374
    @needs_write_lock
 
1375
    def restore_uncommitted(self):
 
1376
        """Restore uncommitted changes from the branch into the tree."""
 
1377
        unshelver = self.branch.get_unshelver(self)
 
1378
        if unshelver is None:
 
1379
            return
 
1380
        try:
 
1381
            merger = unshelver.make_merger()
 
1382
            merger.ignore_zero = True
 
1383
            merger.do_merge()
 
1384
            self.branch.store_uncommitted(None)
 
1385
        finally:
 
1386
            unshelver.finalize()
 
1387
 
2166
1388
    def revision_tree(self, revision_id):
2167
1389
        """See Tree.revision_tree.
2168
1390
 
2169
1391
        WorkingTree can supply revision_trees for the basis revision only
2170
1392
        because there is only one cached inventory in the bzr directory.
2171
1393
        """
2172
 
        if revision_id == self.last_revision():
2173
 
            try:
2174
 
                xml = self.read_basis_inventory()
2175
 
            except errors.NoSuchFile:
2176
 
                pass
2177
 
            else:
2178
 
                try:
2179
 
                    inv = xml7.serializer_v7.read_inventory_from_string(xml)
2180
 
                    # dont use the repository revision_tree api because we want
2181
 
                    # to supply the inventory.
2182
 
                    if inv.revision_id == revision_id:
2183
 
                        return revisiontree.RevisionTree(self.branch.repository,
2184
 
                            inv, revision_id)
2185
 
                except errors.BadInventoryFormat:
2186
 
                    pass
2187
 
        # raise if there was no inventory, or if we read the wrong inventory.
2188
 
        raise errors.NoSuchRevisionInTree(self, revision_id)
2189
 
 
2190
 
    # XXX: This method should be deprecated in favour of taking in a proper
2191
 
    # new Inventory object.
2192
 
    @needs_tree_write_lock
2193
 
    def set_inventory(self, new_inventory_list):
2194
 
        from bzrlib.inventory import (Inventory,
2195
 
                                      InventoryDirectory,
2196
 
                                      InventoryFile,
2197
 
                                      InventoryLink)
2198
 
        inv = Inventory(self.get_root_id())
2199
 
        for path, file_id, parent, kind in new_inventory_list:
2200
 
            name = os.path.basename(path)
2201
 
            if name == "":
2202
 
                continue
2203
 
            # fixme, there should be a factory function inv,add_??
2204
 
            if kind == 'directory':
2205
 
                inv.add(InventoryDirectory(file_id, name, parent))
2206
 
            elif kind == 'file':
2207
 
                inv.add(InventoryFile(file_id, name, parent))
2208
 
            elif kind == 'symlink':
2209
 
                inv.add(InventoryLink(file_id, name, parent))
2210
 
            else:
2211
 
                raise errors.BzrError("unknown kind %r" % kind)
2212
 
        self._write_inventory(inv)
 
1394
        raise NotImplementedError(self.revision_tree)
2213
1395
 
2214
1396
    @needs_tree_write_lock
2215
1397
    def set_root_id(self, file_id):
2228
1410
            present in the current inventory or an error will occur. It must
2229
1411
            not be None, but rather a valid file id.
2230
1412
        """
2231
 
        inv = self._inventory
2232
 
        orig_root_id = inv.root.file_id
2233
 
        # TODO: it might be nice to exit early if there was nothing
2234
 
        # to do, saving us from trigger a sync on unlock.
2235
 
        self._inventory_is_modified = True
2236
 
        # we preserve the root inventory entry object, but
2237
 
        # unlinkit from the byid index
2238
 
        del inv._byid[inv.root.file_id]
2239
 
        inv.root.file_id = file_id
2240
 
        # and link it into the index with the new changed id.
2241
 
        inv._byid[inv.root.file_id] = inv.root
2242
 
        # and finally update all children to reference the new id.
2243
 
        # XXX: this should be safe to just look at the root.children
2244
 
        # list, not the WHOLE INVENTORY.
2245
 
        for fid in inv:
2246
 
            entry = inv[fid]
2247
 
            if entry.parent_id == orig_root_id:
2248
 
                entry.parent_id = inv.root.file_id
 
1413
        raise NotImplementedError(self._set_root_id)
2249
1414
 
2250
1415
    def unlock(self):
2251
1416
        """See Branch.unlock.
2261
1426
    _marker = object()
2262
1427
 
2263
1428
    def update(self, change_reporter=None, possible_transports=None,
2264
 
               revision=None, old_tip=_marker):
 
1429
               revision=None, old_tip=_marker, show_base=False):
2265
1430
        """Update a working tree along its branch.
2266
1431
 
2267
1432
        This will update the branch if its bound too, which means we have
2282
1447
        - Restore the wt.basis->wt.state changes.
2283
1448
 
2284
1449
        There isn't a single operation at the moment to do that, so we:
 
1450
 
2285
1451
        - Merge current state -> basis tree of the master w.r.t. the old tree
2286
1452
          basis.
2287
1453
        - Do a 'normal' merge of the old branch basis if it is relevant.
2304
1470
            else:
2305
1471
                if old_tip is self._marker:
2306
1472
                    old_tip = None
2307
 
            return self._update_tree(old_tip, change_reporter, revision)
 
1473
            return self._update_tree(old_tip, change_reporter, revision, show_base)
2308
1474
        finally:
2309
1475
            self.unlock()
2310
1476
 
2311
1477
    @needs_tree_write_lock
2312
 
    def _update_tree(self, old_tip=None, change_reporter=None, revision=None):
 
1478
    def _update_tree(self, old_tip=None, change_reporter=None, revision=None,
 
1479
                     show_base=False):
2313
1480
        """Update a tree to the master branch.
2314
1481
 
2315
1482
        :param old_tip: if supplied, the previous tip revision the branch,
2342
1509
            other_tree = self.branch.repository.revision_tree(old_tip)
2343
1510
            nb_conflicts = merge.merge_inner(self.branch, other_tree,
2344
1511
                                             base_tree, this_tree=self,
2345
 
                                             change_reporter=change_reporter)
 
1512
                                             change_reporter=change_reporter,
 
1513
                                             show_base=show_base)
2346
1514
            if nb_conflicts:
2347
1515
                self.add_parent_tree((old_tip, other_tree))
2348
 
                trace.note('Rerun update after fixing the conflicts.')
 
1516
                note(gettext('Rerun update after fixing the conflicts.'))
2349
1517
                return nb_conflicts
2350
1518
 
2351
1519
        if last_rev != _mod_revision.ensure_null(revision):
2357
1525
            basis = self.basis_tree()
2358
1526
            basis.lock_read()
2359
1527
            try:
2360
 
                if (basis.inventory.root is None
2361
 
                    or basis.inventory.root.file_id != to_root_id):
 
1528
                if (basis.get_root_id() is None or basis.get_root_id() != to_root_id):
2362
1529
                    self.set_root_id(to_root_id)
2363
1530
                    self.flush()
2364
1531
            finally:
2372
1539
 
2373
1540
            nb_conflicts = merge.merge_inner(self.branch, to_tree, base_tree,
2374
1541
                                             this_tree=self,
2375
 
                                             change_reporter=change_reporter)
 
1542
                                             change_reporter=change_reporter,
 
1543
                                             show_base=show_base)
2376
1544
            self.set_last_revision(revision)
2377
1545
            # TODO - dedup parents list with things merged by pull ?
2378
1546
            # reuse the tree we've updated to to set the basis:
2393
1561
            last_rev = parent_trees[0][0]
2394
1562
        return nb_conflicts
2395
1563
 
2396
 
    def _write_hashcache_if_dirty(self):
2397
 
        """Write out the hashcache if it is dirty."""
2398
 
        if self._hashcache.needs_write:
2399
 
            try:
2400
 
                self._hashcache.write()
2401
 
            except OSError, e:
2402
 
                if e.errno not in (errno.EPERM, errno.EACCES):
2403
 
                    raise
2404
 
                # TODO: jam 20061219 Should this be a warning? A single line
2405
 
                #       warning might be sufficient to let the user know what
2406
 
                #       is going on.
2407
 
                mutter('Could not write hashcache for %s\nError: %s',
2408
 
                       self._hashcache.cache_file_name(), e)
2409
 
 
2410
 
    @needs_tree_write_lock
2411
 
    def _write_inventory(self, inv):
2412
 
        """Write inventory as the current inventory."""
2413
 
        self._set_inventory(inv, dirty=True)
2414
 
        self.flush()
2415
 
 
2416
1564
    def set_conflicts(self, arg):
2417
1565
        raise errors.UnsupportedOperation(self.set_conflicts, self)
2418
1566
 
2419
1567
    def add_conflicts(self, arg):
2420
1568
        raise errors.UnsupportedOperation(self.add_conflicts, self)
2421
1569
 
2422
 
    @needs_read_lock
2423
1570
    def conflicts(self):
2424
 
        conflicts = _mod_conflicts.ConflictList()
2425
 
        for conflicted in self._iter_conflicts():
2426
 
            text = True
2427
 
            try:
2428
 
                if file_kind(self.abspath(conflicted)) != "file":
2429
 
                    text = False
2430
 
            except errors.NoSuchFile:
2431
 
                text = False
2432
 
            if text is True:
2433
 
                for suffix in ('.THIS', '.OTHER'):
2434
 
                    try:
2435
 
                        kind = file_kind(self.abspath(conflicted+suffix))
2436
 
                        if kind != "file":
2437
 
                            text = False
2438
 
                    except errors.NoSuchFile:
2439
 
                        text = False
2440
 
                    if text == False:
2441
 
                        break
2442
 
            ctype = {True: 'text conflict', False: 'contents conflict'}[text]
2443
 
            conflicts.append(_mod_conflicts.Conflict.factory(ctype,
2444
 
                             path=conflicted,
2445
 
                             file_id=self.path2id(conflicted)))
2446
 
        return conflicts
 
1571
        raise NotImplementedError(self.conflicts)
2447
1572
 
2448
1573
    def walkdirs(self, prefix=""):
2449
1574
        """Walk the directories of this tree.
2569
1694
    def _walkdirs(self, prefix=""):
2570
1695
        """Walk the directories of this tree.
2571
1696
 
2572
 
           :prefix: is used as the directrory to start with.
2573
 
           returns a generator which yields items in the form:
2574
 
                ((curren_directory_path, fileid),
2575
 
                 [(file1_path, file1_name, file1_kind, None, file1_id,
2576
 
                   file1_kind), ... ])
 
1697
        :param prefix: is used as the directrory to start with.
 
1698
        :returns: a generator which yields items in the form::
 
1699
 
 
1700
            ((curren_directory_path, fileid),
 
1701
             [(file1_path, file1_name, file1_kind, None, file1_id,
 
1702
               file1_kind), ... ])
2577
1703
        """
2578
 
        _directory = 'directory'
2579
 
        # get the root in the inventory
2580
 
        inv = self.inventory
2581
 
        top_id = inv.path2id(prefix)
2582
 
        if top_id is None:
2583
 
            pending = []
2584
 
        else:
2585
 
            pending = [(prefix, '', _directory, None, top_id, None)]
2586
 
        while pending:
2587
 
            dirblock = []
2588
 
            currentdir = pending.pop()
2589
 
            # 0 - relpath, 1- basename, 2- kind, 3- stat, 4-id, 5-kind
2590
 
            top_id = currentdir[4]
2591
 
            if currentdir[0]:
2592
 
                relroot = currentdir[0] + '/'
2593
 
            else:
2594
 
                relroot = ""
2595
 
            # FIXME: stash the node in pending
2596
 
            entry = inv[top_id]
2597
 
            if entry.kind == 'directory':
2598
 
                for name, child in entry.sorted_children():
2599
 
                    dirblock.append((relroot + name, name, child.kind, None,
2600
 
                        child.file_id, child.kind
2601
 
                        ))
2602
 
            yield (currentdir[0], entry.file_id), dirblock
2603
 
            # push the user specified dirs from dirblock
2604
 
            for dir in reversed(dirblock):
2605
 
                if dir[2] == _directory:
2606
 
                    pending.append(dir)
 
1704
        raise NotImplementedError(self._walkdirs)
2607
1705
 
2608
1706
    @needs_tree_write_lock
2609
1707
    def auto_resolve(self):
2613
1711
        are considered 'resolved', because bzr always puts conflict markers
2614
1712
        into files that have text conflicts.  The corresponding .THIS .BASE and
2615
1713
        .OTHER files are deleted, as per 'resolve'.
 
1714
 
2616
1715
        :return: a tuple of ConflictLists: (un_resolved, resolved).
2617
1716
        """
2618
1717
        un_resolved = _mod_conflicts.ConflictList()
2637
1736
        self.set_conflicts(un_resolved)
2638
1737
        return un_resolved, resolved
2639
1738
 
2640
 
    @needs_read_lock
2641
 
    def _check(self, references):
2642
 
        """Check the tree for consistency.
2643
 
 
2644
 
        :param references: A dict with keys matching the items returned by
2645
 
            self._get_check_refs(), and values from looking those keys up in
2646
 
            the repository.
2647
 
        """
2648
 
        tree_basis = self.basis_tree()
2649
 
        tree_basis.lock_read()
2650
 
        try:
2651
 
            repo_basis = references[('trees', self.last_revision())]
2652
 
            if len(list(repo_basis.iter_changes(tree_basis))) > 0:
2653
 
                raise errors.BzrCheckError(
2654
 
                    "Mismatched basis inventory content.")
2655
 
            self._validate()
2656
 
        finally:
2657
 
            tree_basis.unlock()
2658
 
 
2659
1739
    def _validate(self):
2660
1740
        """Validate internal structures.
2661
1741
 
2667
1747
        """
2668
1748
        return
2669
1749
 
 
1750
    def check_state(self):
 
1751
        """Check that the working state is/isn't valid."""
 
1752
        raise NotImplementedError(self.check_state)
 
1753
 
 
1754
    def reset_state(self, revision_ids=None):
 
1755
        """Reset the state of the working tree.
 
1756
 
 
1757
        This does a hard-reset to a last-known-good state. This is a way to
 
1758
        fix if something got corrupted (like the .bzr/checkout/dirstate file)
 
1759
        """
 
1760
        raise NotImplementedError(self.reset_state)
 
1761
 
2670
1762
    def _get_rules_searcher(self, default_searcher):
2671
1763
        """See Tree._get_rules_searcher."""
2672
1764
        if self._rules_searcher is None:
2680
1772
        return ShelfManager(self, self._transport)
2681
1773
 
2682
1774
 
2683
 
class WorkingTree2(WorkingTree):
2684
 
    """This is the Format 2 working tree.
2685
 
 
2686
 
    This was the first weave based working tree.
2687
 
     - uses os locks for locking.
2688
 
     - uses the branch last-revision.
 
1775
class InventoryWorkingTree(WorkingTree,
 
1776
        bzrlib.mutabletree.MutableInventoryTree):
 
1777
    """Base class for working trees that are inventory-oriented.
 
1778
 
 
1779
    The inventory is held in the `Branch` working-inventory, and the
 
1780
    files are in a directory on disk.
 
1781
 
 
1782
    It is possible for a `WorkingTree` to have a filename which is
 
1783
    not listed in the Inventory and vice versa.
2689
1784
    """
2690
1785
 
2691
 
    def __init__(self, *args, **kwargs):
2692
 
        super(WorkingTree2, self).__init__(*args, **kwargs)
2693
 
        # WorkingTree2 has more of a constraint that self._inventory must
2694
 
        # exist. Because this is an older format, we don't mind the overhead
2695
 
        # caused by the extra computation here.
2696
 
 
2697
 
        # Newer WorkingTree's should only have self._inventory set when they
2698
 
        # have a read lock.
2699
 
        if self._inventory is None:
2700
 
            self.read_working_inventory()
2701
 
 
2702
 
    def _get_check_refs(self):
2703
 
        """Return the references needed to perform a check of this tree."""
2704
 
        return [('trees', self.last_revision())]
 
1786
    def __init__(self, basedir='.',
 
1787
                 branch=DEPRECATED_PARAMETER,
 
1788
                 _inventory=None,
 
1789
                 _control_files=None,
 
1790
                 _internal=False,
 
1791
                 _format=None,
 
1792
                 _bzrdir=None):
 
1793
        """Construct a InventoryWorkingTree instance. This is not a public API.
 
1794
 
 
1795
        :param branch: A branch to override probing for the branch.
 
1796
        """
 
1797
        super(InventoryWorkingTree, self).__init__(basedir=basedir,
 
1798
            branch=branch, _transport=_control_files._transport,
 
1799
            _internal=_internal, _format=_format, _bzrdir=_bzrdir)
 
1800
 
 
1801
        self._control_files = _control_files
 
1802
        self._detect_case_handling()
 
1803
 
 
1804
        if _inventory is None:
 
1805
            # This will be acquired on lock_read() or lock_write()
 
1806
            self._inventory_is_modified = False
 
1807
            self._inventory = None
 
1808
        else:
 
1809
            # the caller of __init__ has provided an inventory,
 
1810
            # we assume they know what they are doing - as its only
 
1811
            # the Format factory and creation methods that are
 
1812
            # permitted to do this.
 
1813
            self._set_inventory(_inventory, dirty=False)
 
1814
 
 
1815
    def _set_inventory(self, inv, dirty):
 
1816
        """Set the internal cached inventory.
 
1817
 
 
1818
        :param inv: The inventory to set.
 
1819
        :param dirty: A boolean indicating whether the inventory is the same
 
1820
            logical inventory as whats on disk. If True the inventory is not
 
1821
            the same and should be written to disk or data will be lost, if
 
1822
            False then the inventory is the same as that on disk and any
 
1823
            serialisation would be unneeded overhead.
 
1824
        """
 
1825
        self._inventory = inv
 
1826
        self._inventory_is_modified = dirty
 
1827
 
 
1828
    def _detect_case_handling(self):
 
1829
        wt_trans = self.bzrdir.get_workingtree_transport(None)
 
1830
        try:
 
1831
            wt_trans.stat(self._format.case_sensitive_filename)
 
1832
        except errors.NoSuchFile:
 
1833
            self.case_sensitive = True
 
1834
        else:
 
1835
            self.case_sensitive = False
 
1836
 
 
1837
        self._setup_directory_is_tree_reference()
 
1838
 
 
1839
    def _serialize(self, inventory, out_file):
 
1840
        xml5.serializer_v5.write_inventory(self._inventory, out_file,
 
1841
            working=True)
 
1842
 
 
1843
    def _deserialize(selt, in_file):
 
1844
        return xml5.serializer_v5.read_inventory(in_file)
 
1845
 
 
1846
    def break_lock(self):
 
1847
        """Break a lock if one is present from another instance.
 
1848
 
 
1849
        Uses the ui factory to ask for confirmation if the lock may be from
 
1850
        an active process.
 
1851
 
 
1852
        This will probe the repository for its lock as well.
 
1853
        """
 
1854
        self._control_files.break_lock()
 
1855
        self.branch.break_lock()
 
1856
 
 
1857
    def is_locked(self):
 
1858
        return self._control_files.is_locked()
 
1859
 
 
1860
    def _must_be_locked(self):
 
1861
        if not self.is_locked():
 
1862
            raise errors.ObjectNotLocked(self)
 
1863
 
 
1864
    def lock_read(self):
 
1865
        """Lock the tree for reading.
 
1866
 
 
1867
        This also locks the branch, and can be unlocked via self.unlock().
 
1868
 
 
1869
        :return: A bzrlib.lock.LogicalLockResult.
 
1870
        """
 
1871
        if not self.is_locked():
 
1872
            self._reset_data()
 
1873
        self.branch.lock_read()
 
1874
        try:
 
1875
            self._control_files.lock_read()
 
1876
            return LogicalLockResult(self.unlock)
 
1877
        except:
 
1878
            self.branch.unlock()
 
1879
            raise
2705
1880
 
2706
1881
    def lock_tree_write(self):
2707
 
        """See WorkingTree.lock_tree_write().
2708
 
 
2709
 
        In Format2 WorkingTrees we have a single lock for the branch and tree
2710
 
        so lock_tree_write() degrades to lock_write().
2711
 
 
2712
 
        :return: An object with an unlock method which will release the lock
2713
 
            obtained.
2714
 
        """
 
1882
        """See MutableTree.lock_tree_write, and WorkingTree.unlock.
 
1883
 
 
1884
        :return: A bzrlib.lock.LogicalLockResult.
 
1885
        """
 
1886
        if not self.is_locked():
 
1887
            self._reset_data()
 
1888
        self.branch.lock_read()
 
1889
        try:
 
1890
            self._control_files.lock_write()
 
1891
            return LogicalLockResult(self.unlock)
 
1892
        except:
 
1893
            self.branch.unlock()
 
1894
            raise
 
1895
 
 
1896
    def lock_write(self):
 
1897
        """See MutableTree.lock_write, and WorkingTree.unlock.
 
1898
 
 
1899
        :return: A bzrlib.lock.LogicalLockResult.
 
1900
        """
 
1901
        if not self.is_locked():
 
1902
            self._reset_data()
2715
1903
        self.branch.lock_write()
2716
1904
        try:
2717
1905
            self._control_files.lock_write()
2718
 
            return self
 
1906
            return LogicalLockResult(self.unlock)
2719
1907
        except:
2720
1908
            self.branch.unlock()
2721
1909
            raise
2722
1910
 
2723
 
    def unlock(self):
2724
 
        # do non-implementation specific cleanup
2725
 
        self._cleanup()
2726
 
 
2727
 
        # we share control files:
2728
 
        if self._control_files._lock_count == 3:
2729
 
            # _inventory_is_modified is always False during a read lock.
2730
 
            if self._inventory_is_modified:
2731
 
                self.flush()
2732
 
            self._write_hashcache_if_dirty()
2733
 
 
2734
 
        # reverse order of locking.
 
1911
    def get_physical_lock_status(self):
 
1912
        return self._control_files.get_physical_lock_status()
 
1913
 
 
1914
    @needs_tree_write_lock
 
1915
    def _write_inventory(self, inv):
 
1916
        """Write inventory as the current inventory."""
 
1917
        self._set_inventory(inv, dirty=True)
 
1918
        self.flush()
 
1919
 
 
1920
    # XXX: This method should be deprecated in favour of taking in a proper
 
1921
    # new Inventory object.
 
1922
    @needs_tree_write_lock
 
1923
    def set_inventory(self, new_inventory_list):
 
1924
        from bzrlib.inventory import (Inventory,
 
1925
                                      InventoryDirectory,
 
1926
                                      InventoryFile,
 
1927
                                      InventoryLink)
 
1928
        inv = Inventory(self.get_root_id())
 
1929
        for path, file_id, parent, kind in new_inventory_list:
 
1930
            name = os.path.basename(path)
 
1931
            if name == "":
 
1932
                continue
 
1933
            # fixme, there should be a factory function inv,add_??
 
1934
            if kind == 'directory':
 
1935
                inv.add(InventoryDirectory(file_id, name, parent))
 
1936
            elif kind == 'file':
 
1937
                inv.add(InventoryFile(file_id, name, parent))
 
1938
            elif kind == 'symlink':
 
1939
                inv.add(InventoryLink(file_id, name, parent))
 
1940
            else:
 
1941
                raise errors.BzrError("unknown kind %r" % kind)
 
1942
        self._write_inventory(inv)
 
1943
 
 
1944
    def _write_basis_inventory(self, xml):
 
1945
        """Write the basis inventory XML to the basis-inventory file"""
 
1946
        path = self._basis_inventory_name()
 
1947
        sio = StringIO(xml)
 
1948
        self._transport.put_file(path, sio,
 
1949
            mode=self.bzrdir._get_file_mode())
 
1950
 
 
1951
    def _reset_data(self):
 
1952
        """Reset transient data that cannot be revalidated."""
 
1953
        self._inventory_is_modified = False
 
1954
        f = self._transport.get('inventory')
2735
1955
        try:
2736
 
            return self._control_files.unlock()
 
1956
            result = self._deserialize(f)
2737
1957
        finally:
2738
 
            self.branch.unlock()
2739
 
 
2740
 
 
2741
 
class WorkingTree3(WorkingTree):
2742
 
    """This is the Format 3 working tree.
2743
 
 
2744
 
    This differs from the base WorkingTree by:
2745
 
     - having its own file lock
2746
 
     - having its own last-revision property.
2747
 
 
2748
 
    This is new in bzr 0.8
2749
 
    """
2750
 
 
2751
 
    @needs_read_lock
2752
 
    def _last_revision(self):
2753
 
        """See Mutable.last_revision."""
 
1958
            f.close()
 
1959
        self._set_inventory(result, dirty=False)
 
1960
 
 
1961
    def _set_root_id(self, file_id):
 
1962
        """Set the root id for this tree, in a format specific manner.
 
1963
 
 
1964
        :param file_id: The file id to assign to the root. It must not be
 
1965
            present in the current inventory or an error will occur. It must
 
1966
            not be None, but rather a valid file id.
 
1967
        """
 
1968
        inv = self._inventory
 
1969
        orig_root_id = inv.root.file_id
 
1970
        # TODO: it might be nice to exit early if there was nothing
 
1971
        # to do, saving us from trigger a sync on unlock.
 
1972
        self._inventory_is_modified = True
 
1973
        # we preserve the root inventory entry object, but
 
1974
        # unlinkit from the byid index
 
1975
        del inv._byid[inv.root.file_id]
 
1976
        inv.root.file_id = file_id
 
1977
        # and link it into the index with the new changed id.
 
1978
        inv._byid[inv.root.file_id] = inv.root
 
1979
        # and finally update all children to reference the new id.
 
1980
        # XXX: this should be safe to just look at the root.children
 
1981
        # list, not the WHOLE INVENTORY.
 
1982
        for fid in inv:
 
1983
            entry = inv[fid]
 
1984
            if entry.parent_id == orig_root_id:
 
1985
                entry.parent_id = inv.root.file_id
 
1986
 
 
1987
    @needs_tree_write_lock
 
1988
    def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
 
1989
        """See MutableTree.set_parent_trees."""
 
1990
        parent_ids = [rev for (rev, tree) in parents_list]
 
1991
        for revision_id in parent_ids:
 
1992
            _mod_revision.check_not_reserved_id(revision_id)
 
1993
 
 
1994
        self._check_parents_for_ghosts(parent_ids,
 
1995
            allow_leftmost_as_ghost=allow_leftmost_as_ghost)
 
1996
 
 
1997
        parent_ids = self._filter_parent_ids_by_ancestry(parent_ids)
 
1998
 
 
1999
        if len(parent_ids) == 0:
 
2000
            leftmost_parent_id = _mod_revision.NULL_REVISION
 
2001
            leftmost_parent_tree = None
 
2002
        else:
 
2003
            leftmost_parent_id, leftmost_parent_tree = parents_list[0]
 
2004
 
 
2005
        if self._change_last_revision(leftmost_parent_id):
 
2006
            if leftmost_parent_tree is None:
 
2007
                # If we don't have a tree, fall back to reading the
 
2008
                # parent tree from the repository.
 
2009
                self._cache_basis_inventory(leftmost_parent_id)
 
2010
            else:
 
2011
                inv = leftmost_parent_tree.root_inventory
 
2012
                xml = self._create_basis_xml_from_inventory(
 
2013
                                        leftmost_parent_id, inv)
 
2014
                self._write_basis_inventory(xml)
 
2015
        self._set_merges_from_parent_ids(parent_ids)
 
2016
 
 
2017
    def _cache_basis_inventory(self, new_revision):
 
2018
        """Cache new_revision as the basis inventory."""
 
2019
        # TODO: this should allow the ready-to-use inventory to be passed in,
 
2020
        # as commit already has that ready-to-use [while the format is the
 
2021
        # same, that is].
2754
2022
        try:
2755
 
            return self._transport.get_bytes('last-revision')
2756
 
        except errors.NoSuchFile:
2757
 
            return _mod_revision.NULL_REVISION
2758
 
 
2759
 
    def _change_last_revision(self, revision_id):
2760
 
        """See WorkingTree._change_last_revision."""
2761
 
        if revision_id is None or revision_id == _mod_revision.NULL_REVISION:
2762
 
            try:
2763
 
                self._transport.delete('last-revision')
2764
 
            except errors.NoSuchFile:
2765
 
                pass
2766
 
            return False
2767
 
        else:
2768
 
            self._transport.put_bytes('last-revision', revision_id,
2769
 
                mode=self.bzrdir._get_file_mode())
2770
 
            return True
2771
 
 
2772
 
    def _get_check_refs(self):
2773
 
        """Return the references needed to perform a check of this tree."""
2774
 
        return [('trees', self.last_revision())]
 
2023
            # this double handles the inventory - unpack and repack -
 
2024
            # but is easier to understand. We can/should put a conditional
 
2025
            # in here based on whether the inventory is in the latest format
 
2026
            # - perhaps we should repack all inventories on a repository
 
2027
            # upgrade ?
 
2028
            # the fast path is to copy the raw xml from the repository. If the
 
2029
            # xml contains 'revision_id="', then we assume the right
 
2030
            # revision_id is set. We must check for this full string, because a
 
2031
            # root node id can legitimately look like 'revision_id' but cannot
 
2032
            # contain a '"'.
 
2033
            xml = self.branch.repository._get_inventory_xml(new_revision)
 
2034
            firstline = xml.split('\n', 1)[0]
 
2035
            if (not 'revision_id="' in firstline or
 
2036
                'format="7"' not in firstline):
 
2037
                inv = self.branch.repository._serializer.read_inventory_from_string(
 
2038
                    xml, new_revision)
 
2039
                xml = self._create_basis_xml_from_inventory(new_revision, inv)
 
2040
            self._write_basis_inventory(xml)
 
2041
        except (errors.NoSuchRevision, errors.RevisionNotPresent):
 
2042
            pass
 
2043
 
 
2044
    def _basis_inventory_name(self):
 
2045
        return 'basis-inventory-cache'
 
2046
 
 
2047
    def _create_basis_xml_from_inventory(self, revision_id, inventory):
 
2048
        """Create the text that will be saved in basis-inventory"""
 
2049
        inventory.revision_id = revision_id
 
2050
        return xml7.serializer_v7.write_inventory_to_string(inventory)
2775
2051
 
2776
2052
    @needs_tree_write_lock
2777
2053
    def set_conflicts(self, conflicts):
2797
2073
                    raise errors.ConflictFormatError()
2798
2074
            except StopIteration:
2799
2075
                raise errors.ConflictFormatError()
2800
 
            return _mod_conflicts.ConflictList.from_stanzas(RioReader(confile))
 
2076
            reader = _mod_rio.RioReader(confile)
 
2077
            return _mod_conflicts.ConflictList.from_stanzas(reader)
2801
2078
        finally:
2802
2079
            confile.close()
2803
2080
 
2804
 
    def unlock(self):
2805
 
        # do non-implementation specific cleanup
2806
 
        self._cleanup()
2807
 
        if self._control_files._lock_count == 1:
2808
 
            # _inventory_is_modified is always False during a read lock.
2809
 
            if self._inventory_is_modified:
2810
 
                self.flush()
2811
 
            self._write_hashcache_if_dirty()
2812
 
        # reverse order of locking.
2813
 
        try:
2814
 
            return self._control_files.unlock()
2815
 
        finally:
2816
 
            self.branch.unlock()
2817
 
 
2818
 
 
2819
 
def get_conflicted_stem(path):
2820
 
    for suffix in _mod_conflicts.CONFLICT_SUFFIXES:
2821
 
        if path.endswith(suffix):
2822
 
            return path[:-len(suffix)]
2823
 
 
2824
 
 
2825
 
class WorkingTreeFormat(object):
 
2081
    def read_basis_inventory(self):
 
2082
        """Read the cached basis inventory."""
 
2083
        path = self._basis_inventory_name()
 
2084
        return self._transport.get_bytes(path)
 
2085
 
 
2086
    @needs_read_lock
 
2087
    def read_working_inventory(self):
 
2088
        """Read the working inventory.
 
2089
 
 
2090
        :raises errors.InventoryModified: read_working_inventory will fail
 
2091
            when the current in memory inventory has been modified.
 
2092
        """
 
2093
        # conceptually this should be an implementation detail of the tree.
 
2094
        # XXX: Deprecate this.
 
2095
        # ElementTree does its own conversion from UTF-8, so open in
 
2096
        # binary.
 
2097
        if self._inventory_is_modified:
 
2098
            raise errors.InventoryModified(self)
 
2099
        f = self._transport.get('inventory')
 
2100
        try:
 
2101
            result = self._deserialize(f)
 
2102
        finally:
 
2103
            f.close()
 
2104
        self._set_inventory(result, dirty=False)
 
2105
        return result
 
2106
 
 
2107
    @needs_read_lock
 
2108
    def get_root_id(self):
 
2109
        """Return the id of this trees root"""
 
2110
        return self._inventory.root.file_id
 
2111
 
 
2112
    def has_id(self, file_id):
 
2113
        # files that have been deleted are excluded
 
2114
        inv, inv_file_id = self._unpack_file_id(file_id)
 
2115
        if not inv.has_id(inv_file_id):
 
2116
            return False
 
2117
        path = inv.id2path(inv_file_id)
 
2118
        return osutils.lexists(self.abspath(path))
 
2119
 
 
2120
    def has_or_had_id(self, file_id):
 
2121
        if file_id == self.get_root_id():
 
2122
            return True
 
2123
        inv, inv_file_id = self._unpack_file_id(file_id)
 
2124
        return inv.has_id(inv_file_id)
 
2125
 
 
2126
    def all_file_ids(self):
 
2127
        """Iterate through file_ids for this tree.
 
2128
 
 
2129
        file_ids are in a WorkingTree if they are in the working inventory
 
2130
        and the working file exists.
 
2131
        """
 
2132
        ret = set()
 
2133
        for path, ie in self.iter_entries_by_dir():
 
2134
            ret.add(ie.file_id)
 
2135
        return ret
 
2136
 
 
2137
    @needs_tree_write_lock
 
2138
    def set_last_revision(self, new_revision):
 
2139
        """Change the last revision in the working tree."""
 
2140
        if self._change_last_revision(new_revision):
 
2141
            self._cache_basis_inventory(new_revision)
 
2142
 
 
2143
    def _get_check_refs(self):
 
2144
        """Return the references needed to perform a check of this tree.
 
2145
        
 
2146
        The default implementation returns no refs, and is only suitable for
 
2147
        trees that have no local caching and can commit on ghosts at any time.
 
2148
 
 
2149
        :seealso: bzrlib.check for details about check_refs.
 
2150
        """
 
2151
        return []
 
2152
 
 
2153
    @needs_read_lock
 
2154
    def _check(self, references):
 
2155
        """Check the tree for consistency.
 
2156
 
 
2157
        :param references: A dict with keys matching the items returned by
 
2158
            self._get_check_refs(), and values from looking those keys up in
 
2159
            the repository.
 
2160
        """
 
2161
        tree_basis = self.basis_tree()
 
2162
        tree_basis.lock_read()
 
2163
        try:
 
2164
            repo_basis = references[('trees', self.last_revision())]
 
2165
            if len(list(repo_basis.iter_changes(tree_basis))) > 0:
 
2166
                raise errors.BzrCheckError(
 
2167
                    "Mismatched basis inventory content.")
 
2168
            self._validate()
 
2169
        finally:
 
2170
            tree_basis.unlock()
 
2171
 
 
2172
    @needs_read_lock
 
2173
    def check_state(self):
 
2174
        """Check that the working state is/isn't valid."""
 
2175
        check_refs = self._get_check_refs()
 
2176
        refs = {}
 
2177
        for ref in check_refs:
 
2178
            kind, value = ref
 
2179
            if kind == 'trees':
 
2180
                refs[ref] = self.branch.repository.revision_tree(value)
 
2181
        self._check(refs)
 
2182
 
 
2183
    @needs_tree_write_lock
 
2184
    def reset_state(self, revision_ids=None):
 
2185
        """Reset the state of the working tree.
 
2186
 
 
2187
        This does a hard-reset to a last-known-good state. This is a way to
 
2188
        fix if something got corrupted (like the .bzr/checkout/dirstate file)
 
2189
        """
 
2190
        if revision_ids is None:
 
2191
            revision_ids = self.get_parent_ids()
 
2192
        if not revision_ids:
 
2193
            rt = self.branch.repository.revision_tree(
 
2194
                _mod_revision.NULL_REVISION)
 
2195
        else:
 
2196
            rt = self.branch.repository.revision_tree(revision_ids[0])
 
2197
        self._write_inventory(rt.root_inventory)
 
2198
        self.set_parent_ids(revision_ids)
 
2199
 
 
2200
    def flush(self):
 
2201
        """Write the in memory inventory to disk."""
 
2202
        # TODO: Maybe this should only write on dirty ?
 
2203
        if self._control_files._lock_mode != 'w':
 
2204
            raise errors.NotWriteLocked(self)
 
2205
        sio = StringIO()
 
2206
        self._serialize(self._inventory, sio)
 
2207
        sio.seek(0)
 
2208
        self._transport.put_file('inventory', sio,
 
2209
            mode=self.bzrdir._get_file_mode())
 
2210
        self._inventory_is_modified = False
 
2211
 
 
2212
    def get_file_mtime(self, file_id, path=None):
 
2213
        """See Tree.get_file_mtime."""
 
2214
        if not path:
 
2215
            path = self.id2path(file_id)
 
2216
        try:
 
2217
            return os.lstat(self.abspath(path)).st_mtime
 
2218
        except OSError, e:
 
2219
            if e.errno == errno.ENOENT:
 
2220
                raise errors.FileTimestampUnavailable(path)
 
2221
            raise
 
2222
 
 
2223
    def _is_executable_from_path_and_stat_from_basis(self, path, stat_result):
 
2224
        inv, file_id = self._path2inv_file_id(path)
 
2225
        if file_id is None:
 
2226
            # For unversioned files on win32, we just assume they are not
 
2227
            # executable
 
2228
            return False
 
2229
        return inv[file_id].executable
 
2230
 
 
2231
    def _is_executable_from_path_and_stat_from_stat(self, path, stat_result):
 
2232
        mode = stat_result.st_mode
 
2233
        return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
 
2234
 
 
2235
    def is_executable(self, file_id, path=None):
 
2236
        if not self._supports_executable():
 
2237
            inv, inv_file_id = self._unpack_file_id(file_id)
 
2238
            return inv[inv_file_id].executable
 
2239
        else:
 
2240
            if not path:
 
2241
                path = self.id2path(file_id)
 
2242
            mode = os.lstat(self.abspath(path)).st_mode
 
2243
            return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
 
2244
 
 
2245
    def _is_executable_from_path_and_stat(self, path, stat_result):
 
2246
        if not self._supports_executable():
 
2247
            return self._is_executable_from_path_and_stat_from_basis(path, stat_result)
 
2248
        else:
 
2249
            return self._is_executable_from_path_and_stat_from_stat(path, stat_result)
 
2250
 
 
2251
    @needs_tree_write_lock
 
2252
    def _add(self, files, ids, kinds):
 
2253
        """See MutableTree._add."""
 
2254
        # TODO: Re-adding a file that is removed in the working copy
 
2255
        # should probably put it back with the previous ID.
 
2256
        # the read and write working inventory should not occur in this
 
2257
        # function - they should be part of lock_write and unlock.
 
2258
        # FIXME: nested trees
 
2259
        inv = self.root_inventory
 
2260
        for f, file_id, kind in zip(files, ids, kinds):
 
2261
            if file_id is None:
 
2262
                inv.add_path(f, kind=kind)
 
2263
            else:
 
2264
                inv.add_path(f, kind=kind, file_id=file_id)
 
2265
            self._inventory_is_modified = True
 
2266
 
 
2267
    def revision_tree(self, revision_id):
 
2268
        """See WorkingTree.revision_id."""
 
2269
        if revision_id == self.last_revision():
 
2270
            try:
 
2271
                xml = self.read_basis_inventory()
 
2272
            except errors.NoSuchFile:
 
2273
                pass
 
2274
            else:
 
2275
                try:
 
2276
                    inv = xml7.serializer_v7.read_inventory_from_string(xml)
 
2277
                    # dont use the repository revision_tree api because we want
 
2278
                    # to supply the inventory.
 
2279
                    if inv.revision_id == revision_id:
 
2280
                        return revisiontree.InventoryRevisionTree(
 
2281
                            self.branch.repository, inv, revision_id)
 
2282
                except errors.BadInventoryFormat:
 
2283
                    pass
 
2284
        # raise if there was no inventory, or if we read the wrong inventory.
 
2285
        raise errors.NoSuchRevisionInTree(self, revision_id)
 
2286
 
 
2287
    @needs_read_lock
 
2288
    def annotate_iter(self, file_id, default_revision=CURRENT_REVISION):
 
2289
        """See Tree.annotate_iter
 
2290
 
 
2291
        This implementation will use the basis tree implementation if possible.
 
2292
        Lines not in the basis are attributed to CURRENT_REVISION
 
2293
 
 
2294
        If there are pending merges, lines added by those merges will be
 
2295
        incorrectly attributed to CURRENT_REVISION (but after committing, the
 
2296
        attribution will be correct).
 
2297
        """
 
2298
        maybe_file_parent_keys = []
 
2299
        for parent_id in self.get_parent_ids():
 
2300
            try:
 
2301
                parent_tree = self.revision_tree(parent_id)
 
2302
            except errors.NoSuchRevisionInTree:
 
2303
                parent_tree = self.branch.repository.revision_tree(parent_id)
 
2304
            parent_tree.lock_read()
 
2305
            try:
 
2306
                try:
 
2307
                    kind = parent_tree.kind(file_id)
 
2308
                except errors.NoSuchId:
 
2309
                    continue
 
2310
                if kind != 'file':
 
2311
                    # Note: this is slightly unnecessary, because symlinks and
 
2312
                    # directories have a "text" which is the empty text, and we
 
2313
                    # know that won't mess up annotations. But it seems cleaner
 
2314
                    continue
 
2315
                parent_text_key = (
 
2316
                    file_id, parent_tree.get_file_revision(file_id))
 
2317
                if parent_text_key not in maybe_file_parent_keys:
 
2318
                    maybe_file_parent_keys.append(parent_text_key)
 
2319
            finally:
 
2320
                parent_tree.unlock()
 
2321
        graph = _mod_graph.Graph(self.branch.repository.texts)
 
2322
        heads = graph.heads(maybe_file_parent_keys)
 
2323
        file_parent_keys = []
 
2324
        for key in maybe_file_parent_keys:
 
2325
            if key in heads:
 
2326
                file_parent_keys.append(key)
 
2327
 
 
2328
        # Now we have the parents of this content
 
2329
        annotator = self.branch.repository.texts.get_annotator()
 
2330
        text = self.get_file_text(file_id)
 
2331
        this_key =(file_id, default_revision)
 
2332
        annotator.add_special_text(this_key, file_parent_keys, text)
 
2333
        annotations = [(key[-1], line)
 
2334
                       for key, line in annotator.annotate_flat(this_key)]
 
2335
        return annotations
 
2336
 
 
2337
    def _put_rio(self, filename, stanzas, header):
 
2338
        self._must_be_locked()
 
2339
        my_file = _mod_rio.rio_file(stanzas, header)
 
2340
        self._transport.put_file(filename, my_file,
 
2341
            mode=self.bzrdir._get_file_mode())
 
2342
 
 
2343
    @needs_tree_write_lock
 
2344
    def set_merge_modified(self, modified_hashes):
 
2345
        def iter_stanzas():
 
2346
            for file_id, hash in modified_hashes.iteritems():
 
2347
                yield _mod_rio.Stanza(file_id=file_id.decode('utf8'),
 
2348
                    hash=hash)
 
2349
        self._put_rio('merge-hashes', iter_stanzas(), MERGE_MODIFIED_HEADER_1)
 
2350
 
 
2351
    @needs_read_lock
 
2352
    def merge_modified(self):
 
2353
        """Return a dictionary of files modified by a merge.
 
2354
 
 
2355
        The list is initialized by WorkingTree.set_merge_modified, which is
 
2356
        typically called after we make some automatic updates to the tree
 
2357
        because of a merge.
 
2358
 
 
2359
        This returns a map of file_id->sha1, containing only files which are
 
2360
        still in the working inventory and have that text hash.
 
2361
        """
 
2362
        try:
 
2363
            hashfile = self._transport.get('merge-hashes')
 
2364
        except errors.NoSuchFile:
 
2365
            return {}
 
2366
        try:
 
2367
            merge_hashes = {}
 
2368
            try:
 
2369
                if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
 
2370
                    raise errors.MergeModifiedFormatError()
 
2371
            except StopIteration:
 
2372
                raise errors.MergeModifiedFormatError()
 
2373
            for s in _mod_rio.RioReader(hashfile):
 
2374
                # RioReader reads in Unicode, so convert file_ids back to utf8
 
2375
                file_id = osutils.safe_file_id(s.get("file_id"), warn=False)
 
2376
                if not self.has_id(file_id):
 
2377
                    continue
 
2378
                text_hash = s.get("hash")
 
2379
                if text_hash == self.get_file_sha1(file_id):
 
2380
                    merge_hashes[file_id] = text_hash
 
2381
            return merge_hashes
 
2382
        finally:
 
2383
            hashfile.close()
 
2384
 
 
2385
    @needs_write_lock
 
2386
    def subsume(self, other_tree):
 
2387
        def add_children(inventory, entry):
 
2388
            for child_entry in entry.children.values():
 
2389
                inventory._byid[child_entry.file_id] = child_entry
 
2390
                if child_entry.kind == 'directory':
 
2391
                    add_children(inventory, child_entry)
 
2392
        if other_tree.get_root_id() == self.get_root_id():
 
2393
            raise errors.BadSubsumeSource(self, other_tree,
 
2394
                                          'Trees have the same root')
 
2395
        try:
 
2396
            other_tree_path = self.relpath(other_tree.basedir)
 
2397
        except errors.PathNotChild:
 
2398
            raise errors.BadSubsumeSource(self, other_tree,
 
2399
                'Tree is not contained by the other')
 
2400
        new_root_parent = self.path2id(osutils.dirname(other_tree_path))
 
2401
        if new_root_parent is None:
 
2402
            raise errors.BadSubsumeSource(self, other_tree,
 
2403
                'Parent directory is not versioned.')
 
2404
        # We need to ensure that the result of a fetch will have a
 
2405
        # versionedfile for the other_tree root, and only fetching into
 
2406
        # RepositoryKnit2 guarantees that.
 
2407
        if not self.branch.repository.supports_rich_root():
 
2408
            raise errors.SubsumeTargetNeedsUpgrade(other_tree)
 
2409
        other_tree.lock_tree_write()
 
2410
        try:
 
2411
            new_parents = other_tree.get_parent_ids()
 
2412
            other_root = other_tree.root_inventory.root
 
2413
            other_root.parent_id = new_root_parent
 
2414
            other_root.name = osutils.basename(other_tree_path)
 
2415
            self.root_inventory.add(other_root)
 
2416
            add_children(self.root_inventory, other_root)
 
2417
            self._write_inventory(self.root_inventory)
 
2418
            # normally we don't want to fetch whole repositories, but i think
 
2419
            # here we really do want to consolidate the whole thing.
 
2420
            for parent_id in other_tree.get_parent_ids():
 
2421
                self.branch.fetch(other_tree.branch, parent_id)
 
2422
                self.add_parent_tree_id(parent_id)
 
2423
        finally:
 
2424
            other_tree.unlock()
 
2425
        other_tree.bzrdir.retire_bzrdir()
 
2426
 
 
2427
    @needs_tree_write_lock
 
2428
    def extract(self, file_id, format=None):
 
2429
        """Extract a subtree from this tree.
 
2430
 
 
2431
        A new branch will be created, relative to the path for this tree.
 
2432
        """
 
2433
        self.flush()
 
2434
        def mkdirs(path):
 
2435
            segments = osutils.splitpath(path)
 
2436
            transport = self.branch.bzrdir.root_transport
 
2437
            for name in segments:
 
2438
                transport = transport.clone(name)
 
2439
                transport.ensure_base()
 
2440
            return transport
 
2441
 
 
2442
        sub_path = self.id2path(file_id)
 
2443
        branch_transport = mkdirs(sub_path)
 
2444
        if format is None:
 
2445
            format = self.bzrdir.cloning_metadir()
 
2446
        branch_transport.ensure_base()
 
2447
        branch_bzrdir = format.initialize_on_transport(branch_transport)
 
2448
        try:
 
2449
            repo = branch_bzrdir.find_repository()
 
2450
        except errors.NoRepositoryPresent:
 
2451
            repo = branch_bzrdir.create_repository()
 
2452
        if not repo.supports_rich_root():
 
2453
            raise errors.RootNotRich()
 
2454
        new_branch = branch_bzrdir.create_branch()
 
2455
        new_branch.pull(self.branch)
 
2456
        for parent_id in self.get_parent_ids():
 
2457
            new_branch.fetch(self.branch, parent_id)
 
2458
        tree_transport = self.bzrdir.root_transport.clone(sub_path)
 
2459
        if tree_transport.base != branch_transport.base:
 
2460
            tree_bzrdir = format.initialize_on_transport(tree_transport)
 
2461
            tree_bzrdir.set_branch_reference(new_branch)
 
2462
        else:
 
2463
            tree_bzrdir = branch_bzrdir
 
2464
        wt = tree_bzrdir.create_workingtree(_mod_revision.NULL_REVISION)
 
2465
        wt.set_parent_ids(self.get_parent_ids())
 
2466
        # FIXME: Support nested trees
 
2467
        my_inv = self.root_inventory
 
2468
        child_inv = inventory.Inventory(root_id=None)
 
2469
        new_root = my_inv[file_id]
 
2470
        my_inv.remove_recursive_id(file_id)
 
2471
        new_root.parent_id = None
 
2472
        child_inv.add(new_root)
 
2473
        self._write_inventory(my_inv)
 
2474
        wt._write_inventory(child_inv)
 
2475
        return wt
 
2476
 
 
2477
    def list_files(self, include_root=False, from_dir=None, recursive=True):
 
2478
        """List all files as (path, class, kind, id, entry).
 
2479
 
 
2480
        Lists, but does not descend into unversioned directories.
 
2481
        This does not include files that have been deleted in this
 
2482
        tree. Skips the control directory.
 
2483
 
 
2484
        :param include_root: if True, return an entry for the root
 
2485
        :param from_dir: start from this directory or None for the root
 
2486
        :param recursive: whether to recurse into subdirectories or not
 
2487
        """
 
2488
        # list_files is an iterator, so @needs_read_lock doesn't work properly
 
2489
        # with it. So callers should be careful to always read_lock the tree.
 
2490
        if not self.is_locked():
 
2491
            raise errors.ObjectNotLocked(self)
 
2492
 
 
2493
        if from_dir is None and include_root is True:
 
2494
            yield ('', 'V', 'directory', self.get_root_id(), self.root_inventory.root)
 
2495
        # Convert these into local objects to save lookup times
 
2496
        pathjoin = osutils.pathjoin
 
2497
        file_kind = self._kind
 
2498
 
 
2499
        # transport.base ends in a slash, we want the piece
 
2500
        # between the last two slashes
 
2501
        transport_base_dir = self.bzrdir.transport.base.rsplit('/', 2)[1]
 
2502
 
 
2503
        fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
 
2504
 
 
2505
        # directory file_id, relative path, absolute path, reverse sorted children
 
2506
        if from_dir is not None:
 
2507
            inv, from_dir_id = self._path2inv_file_id(from_dir)
 
2508
            if from_dir_id is None:
 
2509
                # Directory not versioned
 
2510
                return
 
2511
            from_dir_abspath = pathjoin(self.basedir, from_dir)
 
2512
        else:
 
2513
            inv = self.root_inventory
 
2514
            from_dir_id = inv.root.file_id
 
2515
            from_dir_abspath = self.basedir
 
2516
        children = os.listdir(from_dir_abspath)
 
2517
        children.sort()
 
2518
        # jam 20060527 The kernel sized tree seems equivalent whether we
 
2519
        # use a deque and popleft to keep them sorted, or if we use a plain
 
2520
        # list and just reverse() them.
 
2521
        children = collections.deque(children)
 
2522
        stack = [(from_dir_id, u'', from_dir_abspath, children)]
 
2523
        while stack:
 
2524
            from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
 
2525
 
 
2526
            while children:
 
2527
                f = children.popleft()
 
2528
                ## TODO: If we find a subdirectory with its own .bzr
 
2529
                ## directory, then that is a separate tree and we
 
2530
                ## should exclude it.
 
2531
 
 
2532
                # the bzrdir for this tree
 
2533
                if transport_base_dir == f:
 
2534
                    continue
 
2535
 
 
2536
                # we know that from_dir_relpath and from_dir_abspath never end in a slash
 
2537
                # and 'f' doesn't begin with one, we can do a string op, rather
 
2538
                # than the checks of pathjoin(), all relative paths will have an extra slash
 
2539
                # at the beginning
 
2540
                fp = from_dir_relpath + '/' + f
 
2541
 
 
2542
                # absolute path
 
2543
                fap = from_dir_abspath + '/' + f
 
2544
 
 
2545
                dir_ie = inv[from_dir_id]
 
2546
                if dir_ie.kind == 'directory':
 
2547
                    f_ie = dir_ie.children.get(f)
 
2548
                else:
 
2549
                    f_ie = None
 
2550
                if f_ie:
 
2551
                    c = 'V'
 
2552
                elif self.is_ignored(fp[1:]):
 
2553
                    c = 'I'
 
2554
                else:
 
2555
                    # we may not have found this file, because of a unicode
 
2556
                    # issue, or because the directory was actually a symlink.
 
2557
                    f_norm, can_access = osutils.normalized_filename(f)
 
2558
                    if f == f_norm or not can_access:
 
2559
                        # No change, so treat this file normally
 
2560
                        c = '?'
 
2561
                    else:
 
2562
                        # this file can be accessed by a normalized path
 
2563
                        # check again if it is versioned
 
2564
                        # these lines are repeated here for performance
 
2565
                        f = f_norm
 
2566
                        fp = from_dir_relpath + '/' + f
 
2567
                        fap = from_dir_abspath + '/' + f
 
2568
                        f_ie = inv.get_child(from_dir_id, f)
 
2569
                        if f_ie:
 
2570
                            c = 'V'
 
2571
                        elif self.is_ignored(fp[1:]):
 
2572
                            c = 'I'
 
2573
                        else:
 
2574
                            c = '?'
 
2575
 
 
2576
                fk = file_kind(fap)
 
2577
 
 
2578
                # make a last minute entry
 
2579
                if f_ie:
 
2580
                    yield fp[1:], c, fk, f_ie.file_id, f_ie
 
2581
                else:
 
2582
                    try:
 
2583
                        yield fp[1:], c, fk, None, fk_entries[fk]()
 
2584
                    except KeyError:
 
2585
                        yield fp[1:], c, fk, None, TreeEntry()
 
2586
                    continue
 
2587
 
 
2588
                if fk != 'directory':
 
2589
                    continue
 
2590
 
 
2591
                # But do this child first if recursing down
 
2592
                if recursive:
 
2593
                    new_children = os.listdir(fap)
 
2594
                    new_children.sort()
 
2595
                    new_children = collections.deque(new_children)
 
2596
                    stack.append((f_ie.file_id, fp, fap, new_children))
 
2597
                    # Break out of inner loop,
 
2598
                    # so that we start outer loop with child
 
2599
                    break
 
2600
            else:
 
2601
                # if we finished all children, pop it off the stack
 
2602
                stack.pop()
 
2603
 
 
2604
    @needs_tree_write_lock
 
2605
    def move(self, from_paths, to_dir=None, after=False):
 
2606
        """Rename files.
 
2607
 
 
2608
        to_dir must exist in the inventory.
 
2609
 
 
2610
        If to_dir exists and is a directory, the files are moved into
 
2611
        it, keeping their old names.
 
2612
 
 
2613
        Note that to_dir is only the last component of the new name;
 
2614
        this doesn't change the directory.
 
2615
 
 
2616
        For each entry in from_paths the move mode will be determined
 
2617
        independently.
 
2618
 
 
2619
        The first mode moves the file in the filesystem and updates the
 
2620
        inventory. The second mode only updates the inventory without
 
2621
        touching the file on the filesystem.
 
2622
 
 
2623
        move uses the second mode if 'after == True' and the target is
 
2624
        either not versioned or newly added, and present in the working tree.
 
2625
 
 
2626
        move uses the second mode if 'after == False' and the source is
 
2627
        versioned but no longer in the working tree, and the target is not
 
2628
        versioned but present in the working tree.
 
2629
 
 
2630
        move uses the first mode if 'after == False' and the source is
 
2631
        versioned and present in the working tree, and the target is not
 
2632
        versioned and not present in the working tree.
 
2633
 
 
2634
        Everything else results in an error.
 
2635
 
 
2636
        This returns a list of (from_path, to_path) pairs for each
 
2637
        entry that is moved.
 
2638
        """
 
2639
        rename_entries = []
 
2640
        rename_tuples = []
 
2641
 
 
2642
        invs_to_write = set()
 
2643
 
 
2644
        # check for deprecated use of signature
 
2645
        if to_dir is None:
 
2646
            raise TypeError('You must supply a target directory')
 
2647
        # check destination directory
 
2648
        if isinstance(from_paths, basestring):
 
2649
            raise ValueError()
 
2650
        to_abs = self.abspath(to_dir)
 
2651
        if not isdir(to_abs):
 
2652
            raise errors.BzrMoveFailedError('',to_dir,
 
2653
                errors.NotADirectory(to_abs))
 
2654
        if not self.has_filename(to_dir):
 
2655
            raise errors.BzrMoveFailedError('',to_dir,
 
2656
                errors.NotInWorkingDirectory(to_dir))
 
2657
        to_inv, to_dir_id = self._path2inv_file_id(to_dir)
 
2658
        if to_dir_id is None:
 
2659
            raise errors.BzrMoveFailedError('',to_dir,
 
2660
                errors.NotVersionedError(path=to_dir))
 
2661
 
 
2662
        to_dir_ie = to_inv[to_dir_id]
 
2663
        if to_dir_ie.kind != 'directory':
 
2664
            raise errors.BzrMoveFailedError('',to_dir,
 
2665
                errors.NotADirectory(to_abs))
 
2666
 
 
2667
        # create rename entries and tuples
 
2668
        for from_rel in from_paths:
 
2669
            from_tail = splitpath(from_rel)[-1]
 
2670
            from_inv, from_id = self._path2inv_file_id(from_rel)
 
2671
            if from_id is None:
 
2672
                raise errors.BzrMoveFailedError(from_rel,to_dir,
 
2673
                    errors.NotVersionedError(path=from_rel))
 
2674
 
 
2675
            from_entry = from_inv[from_id]
 
2676
            from_parent_id = from_entry.parent_id
 
2677
            to_rel = pathjoin(to_dir, from_tail)
 
2678
            rename_entry = InventoryWorkingTree._RenameEntry(
 
2679
                from_rel=from_rel,
 
2680
                from_id=from_id,
 
2681
                from_tail=from_tail,
 
2682
                from_parent_id=from_parent_id,
 
2683
                to_rel=to_rel, to_tail=from_tail,
 
2684
                to_parent_id=to_dir_id)
 
2685
            rename_entries.append(rename_entry)
 
2686
            rename_tuples.append((from_rel, to_rel))
 
2687
 
 
2688
        # determine which move mode to use. checks also for movability
 
2689
        rename_entries = self._determine_mv_mode(rename_entries, after)
 
2690
 
 
2691
        original_modified = self._inventory_is_modified
 
2692
        try:
 
2693
            if len(from_paths):
 
2694
                self._inventory_is_modified = True
 
2695
            self._move(rename_entries)
 
2696
        except:
 
2697
            # restore the inventory on error
 
2698
            self._inventory_is_modified = original_modified
 
2699
            raise
 
2700
        #FIXME: Should potentially also write the from_invs
 
2701
        self._write_inventory(to_inv)
 
2702
        return rename_tuples
 
2703
 
 
2704
    @needs_tree_write_lock
 
2705
    def rename_one(self, from_rel, to_rel, after=False):
 
2706
        """Rename one file.
 
2707
 
 
2708
        This can change the directory or the filename or both.
 
2709
 
 
2710
        rename_one has several 'modes' to work. First, it can rename a physical
 
2711
        file and change the file_id. That is the normal mode. Second, it can
 
2712
        only change the file_id without touching any physical file.
 
2713
 
 
2714
        rename_one uses the second mode if 'after == True' and 'to_rel' is not
 
2715
        versioned but present in the working tree.
 
2716
 
 
2717
        rename_one uses the second mode if 'after == False' and 'from_rel' is
 
2718
        versioned but no longer in the working tree, and 'to_rel' is not
 
2719
        versioned but present in the working tree.
 
2720
 
 
2721
        rename_one uses the first mode if 'after == False' and 'from_rel' is
 
2722
        versioned and present in the working tree, and 'to_rel' is not
 
2723
        versioned and not present in the working tree.
 
2724
 
 
2725
        Everything else results in an error.
 
2726
        """
 
2727
        rename_entries = []
 
2728
 
 
2729
        # create rename entries and tuples
 
2730
        from_tail = splitpath(from_rel)[-1]
 
2731
        from_inv, from_id = self._path2inv_file_id(from_rel)
 
2732
        if from_id is None:
 
2733
            # if file is missing in the inventory maybe it's in the basis_tree
 
2734
            basis_tree = self.branch.basis_tree()
 
2735
            from_id = basis_tree.path2id(from_rel)
 
2736
            if from_id is None:
 
2737
                raise errors.BzrRenameFailedError(from_rel,to_rel,
 
2738
                    errors.NotVersionedError(path=from_rel))
 
2739
            # put entry back in the inventory so we can rename it
 
2740
            from_entry = basis_tree.root_inventory[from_id].copy()
 
2741
            from_inv.add(from_entry)
 
2742
        else:
 
2743
            from_inv, from_inv_id = self._unpack_file_id(from_id)
 
2744
            from_entry = from_inv[from_inv_id]
 
2745
        from_parent_id = from_entry.parent_id
 
2746
        to_dir, to_tail = os.path.split(to_rel)
 
2747
        to_inv, to_dir_id = self._path2inv_file_id(to_dir)
 
2748
        rename_entry = InventoryWorkingTree._RenameEntry(from_rel=from_rel,
 
2749
                                     from_id=from_id,
 
2750
                                     from_tail=from_tail,
 
2751
                                     from_parent_id=from_parent_id,
 
2752
                                     to_rel=to_rel, to_tail=to_tail,
 
2753
                                     to_parent_id=to_dir_id)
 
2754
        rename_entries.append(rename_entry)
 
2755
 
 
2756
        # determine which move mode to use. checks also for movability
 
2757
        rename_entries = self._determine_mv_mode(rename_entries, after)
 
2758
 
 
2759
        # check if the target changed directory and if the target directory is
 
2760
        # versioned
 
2761
        if to_dir_id is None:
 
2762
            raise errors.BzrMoveFailedError(from_rel,to_rel,
 
2763
                errors.NotVersionedError(path=to_dir))
 
2764
 
 
2765
        # all checks done. now we can continue with our actual work
 
2766
        mutter('rename_one:\n'
 
2767
               '  from_id   {%s}\n'
 
2768
               '  from_rel: %r\n'
 
2769
               '  to_rel:   %r\n'
 
2770
               '  to_dir    %r\n'
 
2771
               '  to_dir_id {%s}\n',
 
2772
               from_id, from_rel, to_rel, to_dir, to_dir_id)
 
2773
 
 
2774
        self._move(rename_entries)
 
2775
        self._write_inventory(to_inv)
 
2776
 
 
2777
    class _RenameEntry(object):
 
2778
        def __init__(self, from_rel, from_id, from_tail, from_parent_id,
 
2779
                     to_rel, to_tail, to_parent_id, only_change_inv=False,
 
2780
                     change_id=False):
 
2781
            self.from_rel = from_rel
 
2782
            self.from_id = from_id
 
2783
            self.from_tail = from_tail
 
2784
            self.from_parent_id = from_parent_id
 
2785
            self.to_rel = to_rel
 
2786
            self.to_tail = to_tail
 
2787
            self.to_parent_id = to_parent_id
 
2788
            self.change_id = change_id
 
2789
            self.only_change_inv = only_change_inv
 
2790
 
 
2791
    def _determine_mv_mode(self, rename_entries, after=False):
 
2792
        """Determines for each from-to pair if both inventory and working tree
 
2793
        or only the inventory has to be changed.
 
2794
 
 
2795
        Also does basic plausability tests.
 
2796
        """
 
2797
        # FIXME: Handling of nested trees
 
2798
        inv = self.root_inventory
 
2799
 
 
2800
        for rename_entry in rename_entries:
 
2801
            # store to local variables for easier reference
 
2802
            from_rel = rename_entry.from_rel
 
2803
            from_id = rename_entry.from_id
 
2804
            to_rel = rename_entry.to_rel
 
2805
            to_id = inv.path2id(to_rel)
 
2806
            only_change_inv = False
 
2807
            change_id = False
 
2808
 
 
2809
            # check the inventory for source and destination
 
2810
            if from_id is None:
 
2811
                raise errors.BzrMoveFailedError(from_rel,to_rel,
 
2812
                    errors.NotVersionedError(path=from_rel))
 
2813
            if to_id is not None:
 
2814
                allowed = False
 
2815
                # allow it with --after but only if dest is newly added
 
2816
                if after:
 
2817
                    basis = self.basis_tree()
 
2818
                    basis.lock_read()
 
2819
                    try:
 
2820
                        if not basis.has_id(to_id):
 
2821
                            rename_entry.change_id = True
 
2822
                            allowed = True
 
2823
                    finally:
 
2824
                        basis.unlock()
 
2825
                if not allowed:
 
2826
                    raise errors.BzrMoveFailedError(from_rel,to_rel,
 
2827
                        errors.AlreadyVersionedError(path=to_rel))
 
2828
 
 
2829
            # try to determine the mode for rename (only change inv or change
 
2830
            # inv and file system)
 
2831
            if after:
 
2832
                if not self.has_filename(to_rel):
 
2833
                    raise errors.BzrMoveFailedError(from_id,to_rel,
 
2834
                        errors.NoSuchFile(path=to_rel,
 
2835
                        extra="New file has not been created yet"))
 
2836
                only_change_inv = True
 
2837
            elif not self.has_filename(from_rel) and self.has_filename(to_rel):
 
2838
                only_change_inv = True
 
2839
            elif self.has_filename(from_rel) and not self.has_filename(to_rel):
 
2840
                only_change_inv = False
 
2841
            elif (not self.case_sensitive
 
2842
                  and from_rel.lower() == to_rel.lower()
 
2843
                  and self.has_filename(from_rel)):
 
2844
                only_change_inv = False
 
2845
            else:
 
2846
                # something is wrong, so lets determine what exactly
 
2847
                if not self.has_filename(from_rel) and \
 
2848
                   not self.has_filename(to_rel):
 
2849
                    raise errors.BzrRenameFailedError(from_rel, to_rel,
 
2850
                        errors.PathsDoNotExist(paths=(from_rel, to_rel)))
 
2851
                else:
 
2852
                    raise errors.RenameFailedFilesExist(from_rel, to_rel)
 
2853
            rename_entry.only_change_inv = only_change_inv
 
2854
        return rename_entries
 
2855
 
 
2856
    def _move(self, rename_entries):
 
2857
        """Moves a list of files.
 
2858
 
 
2859
        Depending on the value of the flag 'only_change_inv', the
 
2860
        file will be moved on the file system or not.
 
2861
        """
 
2862
        moved = []
 
2863
 
 
2864
        for entry in rename_entries:
 
2865
            try:
 
2866
                self._move_entry(entry)
 
2867
            except:
 
2868
                self._rollback_move(moved)
 
2869
                raise
 
2870
            moved.append(entry)
 
2871
 
 
2872
    def _rollback_move(self, moved):
 
2873
        """Try to rollback a previous move in case of an filesystem error."""
 
2874
        for entry in moved:
 
2875
            try:
 
2876
                self._move_entry(WorkingTree._RenameEntry(
 
2877
                    entry.to_rel, entry.from_id,
 
2878
                    entry.to_tail, entry.to_parent_id, entry.from_rel,
 
2879
                    entry.from_tail, entry.from_parent_id,
 
2880
                    entry.only_change_inv))
 
2881
            except errors.BzrMoveFailedError, e:
 
2882
                raise errors.BzrMoveFailedError( '', '', "Rollback failed."
 
2883
                        " The working tree is in an inconsistent state."
 
2884
                        " Please consider doing a 'bzr revert'."
 
2885
                        " Error message is: %s" % e)
 
2886
 
 
2887
    def _move_entry(self, entry):
 
2888
        inv = self.root_inventory
 
2889
        from_rel_abs = self.abspath(entry.from_rel)
 
2890
        to_rel_abs = self.abspath(entry.to_rel)
 
2891
        if from_rel_abs == to_rel_abs:
 
2892
            raise errors.BzrMoveFailedError(entry.from_rel, entry.to_rel,
 
2893
                "Source and target are identical.")
 
2894
 
 
2895
        if not entry.only_change_inv:
 
2896
            try:
 
2897
                osutils.rename(from_rel_abs, to_rel_abs)
 
2898
            except OSError, e:
 
2899
                raise errors.BzrMoveFailedError(entry.from_rel,
 
2900
                    entry.to_rel, e[1])
 
2901
        if entry.change_id:
 
2902
            to_id = inv.path2id(entry.to_rel)
 
2903
            inv.remove_recursive_id(to_id)
 
2904
        inv.rename(entry.from_id, entry.to_parent_id, entry.to_tail)
 
2905
 
 
2906
    @needs_tree_write_lock
 
2907
    def unversion(self, file_ids):
 
2908
        """Remove the file ids in file_ids from the current versioned set.
 
2909
 
 
2910
        When a file_id is unversioned, all of its children are automatically
 
2911
        unversioned.
 
2912
 
 
2913
        :param file_ids: The file ids to stop versioning.
 
2914
        :raises: NoSuchId if any fileid is not currently versioned.
 
2915
        """
 
2916
        for file_id in file_ids:
 
2917
            if not self._inventory.has_id(file_id):
 
2918
                raise errors.NoSuchId(self, file_id)
 
2919
        for file_id in file_ids:
 
2920
            if self._inventory.has_id(file_id):
 
2921
                self._inventory.remove_recursive_id(file_id)
 
2922
        if len(file_ids):
 
2923
            # in the future this should just set a dirty bit to wait for the
 
2924
            # final unlock. However, until all methods of workingtree start
 
2925
            # with the current in -memory inventory rather than triggering
 
2926
            # a read, it is more complex - we need to teach read_inventory
 
2927
            # to know when to read, and when to not read first... and possibly
 
2928
            # to save first when the in memory one may be corrupted.
 
2929
            # so for now, we just only write it if it is indeed dirty.
 
2930
            # - RBC 20060907
 
2931
            self._write_inventory(self._inventory)
 
2932
 
 
2933
    def stored_kind(self, file_id):
 
2934
        """See Tree.stored_kind"""
 
2935
        inv, inv_file_id = self._unpack_file_id(file_id)
 
2936
        return inv[inv_file_id].kind
 
2937
 
 
2938
    def extras(self):
 
2939
        """Yield all unversioned files in this WorkingTree.
 
2940
 
 
2941
        If there are any unversioned directories then only the directory is
 
2942
        returned, not all its children.  But if there are unversioned files
 
2943
        under a versioned subdirectory, they are returned.
 
2944
 
 
2945
        Currently returned depth-first, sorted by name within directories.
 
2946
        This is the same order used by 'osutils.walkdirs'.
 
2947
        """
 
2948
        ## TODO: Work from given directory downwards
 
2949
        for path, dir_entry in self.iter_entries_by_dir():
 
2950
            if dir_entry.kind != 'directory':
 
2951
                continue
 
2952
            # mutter("search for unknowns in %r", path)
 
2953
            dirabs = self.abspath(path)
 
2954
            if not isdir(dirabs):
 
2955
                # e.g. directory deleted
 
2956
                continue
 
2957
 
 
2958
            fl = []
 
2959
            for subf in os.listdir(dirabs):
 
2960
                if self.bzrdir.is_control_filename(subf):
 
2961
                    continue
 
2962
                if subf not in dir_entry.children:
 
2963
                    try:
 
2964
                        (subf_norm,
 
2965
                         can_access) = osutils.normalized_filename(subf)
 
2966
                    except UnicodeDecodeError:
 
2967
                        path_os_enc = path.encode(osutils._fs_enc)
 
2968
                        relpath = path_os_enc + '/' + subf
 
2969
                        raise errors.BadFilenameEncoding(relpath,
 
2970
                                                         osutils._fs_enc)
 
2971
                    if subf_norm != subf and can_access:
 
2972
                        if subf_norm not in dir_entry.children:
 
2973
                            fl.append(subf_norm)
 
2974
                    else:
 
2975
                        fl.append(subf)
 
2976
 
 
2977
            fl.sort()
 
2978
            for subf in fl:
 
2979
                subp = pathjoin(path, subf)
 
2980
                yield subp
 
2981
 
 
2982
    def _walkdirs(self, prefix=""):
 
2983
        """Walk the directories of this tree.
 
2984
 
 
2985
        :param prefix: is used as the directrory to start with.
 
2986
        :returns: a generator which yields items in the form::
 
2987
 
 
2988
            ((curren_directory_path, fileid),
 
2989
             [(file1_path, file1_name, file1_kind, None, file1_id,
 
2990
               file1_kind), ... ])
 
2991
        """
 
2992
        _directory = 'directory'
 
2993
        # get the root in the inventory
 
2994
        inv, top_id = self._path2inv_file_id(prefix)
 
2995
        if top_id is None:
 
2996
            pending = []
 
2997
        else:
 
2998
            pending = [(prefix, '', _directory, None, top_id, None)]
 
2999
        while pending:
 
3000
            dirblock = []
 
3001
            currentdir = pending.pop()
 
3002
            # 0 - relpath, 1- basename, 2- kind, 3- stat, 4-id, 5-kind
 
3003
            top_id = currentdir[4]
 
3004
            if currentdir[0]:
 
3005
                relroot = currentdir[0] + '/'
 
3006
            else:
 
3007
                relroot = ""
 
3008
            # FIXME: stash the node in pending
 
3009
            entry = inv[top_id]
 
3010
            if entry.kind == 'directory':
 
3011
                for name, child in entry.sorted_children():
 
3012
                    dirblock.append((relroot + name, name, child.kind, None,
 
3013
                        child.file_id, child.kind
 
3014
                        ))
 
3015
            yield (currentdir[0], entry.file_id), dirblock
 
3016
            # push the user specified dirs from dirblock
 
3017
            for dir in reversed(dirblock):
 
3018
                if dir[2] == _directory:
 
3019
                    pending.append(dir)
 
3020
 
 
3021
    @needs_write_lock
 
3022
    def update_feature_flags(self, updated_flags):
 
3023
        """Update the feature flags for this branch.
 
3024
 
 
3025
        :param updated_flags: Dictionary mapping feature names to necessities
 
3026
            A necessity can be None to indicate the feature should be removed
 
3027
        """
 
3028
        self._format._update_feature_flags(updated_flags)
 
3029
        self.control_transport.put_bytes('format', self._format.as_string())
 
3030
 
 
3031
 
 
3032
class WorkingTreeFormatRegistry(controldir.ControlComponentFormatRegistry):
 
3033
    """Registry for working tree formats."""
 
3034
 
 
3035
    def __init__(self, other_registry=None):
 
3036
        super(WorkingTreeFormatRegistry, self).__init__(other_registry)
 
3037
        self._default_format = None
 
3038
        self._default_format_key = None
 
3039
 
 
3040
    def get_default(self):
 
3041
        """Return the current default format."""
 
3042
        if (self._default_format_key is not None and
 
3043
            self._default_format is None):
 
3044
            self._default_format = self.get(self._default_format_key)
 
3045
        return self._default_format
 
3046
 
 
3047
    def set_default(self, format):
 
3048
        """Set the default format."""
 
3049
        self._default_format = format
 
3050
        self._default_format_key = None
 
3051
 
 
3052
    def set_default_key(self, format_string):
 
3053
        """Set the default format by its format string."""
 
3054
        self._default_format_key = format_string
 
3055
        self._default_format = None
 
3056
 
 
3057
 
 
3058
format_registry = WorkingTreeFormatRegistry()
 
3059
 
 
3060
 
 
3061
class WorkingTreeFormat(controldir.ControlComponentFormat):
2826
3062
    """An encapsulation of the initialization and open routines for a format.
2827
3063
 
2828
3064
    Formats provide three things:
2840
3076
    object will be created every time regardless.
2841
3077
    """
2842
3078
 
2843
 
    _default_format = None
2844
 
    """The default format used for new trees."""
2845
 
 
2846
 
    _formats = {}
2847
 
    """The known formats."""
2848
 
 
2849
3079
    requires_rich_root = False
2850
3080
 
2851
3081
    upgrade_recommended = False
2852
3082
 
2853
 
    @classmethod
2854
 
    def find_format(klass, a_bzrdir):
2855
 
        """Return the format for the working tree object in a_bzrdir."""
2856
 
        try:
2857
 
            transport = a_bzrdir.get_workingtree_transport(None)
2858
 
            format_string = transport.get_bytes("format")
2859
 
            return klass._formats[format_string]
2860
 
        except errors.NoSuchFile:
2861
 
            raise errors.NoWorkingTree(base=transport.base)
2862
 
        except KeyError:
2863
 
            raise errors.UnknownFormatError(format=format_string,
2864
 
                                            kind="working tree")
 
3083
    requires_normalized_unicode_filenames = False
 
3084
 
 
3085
    case_sensitive_filename = "FoRMaT"
 
3086
 
 
3087
    missing_parent_conflicts = False
 
3088
    """If this format supports missing parent conflicts."""
 
3089
 
 
3090
    supports_versioned_directories = None
 
3091
 
 
3092
    def initialize(self, controldir, revision_id=None, from_branch=None,
 
3093
                   accelerator_tree=None, hardlink=False):
 
3094
        """Initialize a new working tree in controldir.
 
3095
 
 
3096
        :param controldir: ControlDir to initialize the working tree in.
 
3097
        :param revision_id: allows creating a working tree at a different
 
3098
            revision than the branch is at.
 
3099
        :param from_branch: Branch to checkout
 
3100
        :param accelerator_tree: A tree which can be used for retrieving file
 
3101
            contents more quickly than the revision tree, i.e. a workingtree.
 
3102
            The revision tree will be used for cases where accelerator_tree's
 
3103
            content is different.
 
3104
        :param hardlink: If true, hard-link files from accelerator_tree,
 
3105
            where possible.
 
3106
        """
 
3107
        raise NotImplementedError(self.initialize)
2865
3108
 
2866
3109
    def __eq__(self, other):
2867
3110
        return self.__class__ is other.__class__
2869
3112
    def __ne__(self, other):
2870
3113
        return not (self == other)
2871
3114
 
2872
 
    @classmethod
2873
 
    def get_default_format(klass):
2874
 
        """Return the current default format."""
2875
 
        return klass._default_format
2876
 
 
2877
 
    def get_format_string(self):
2878
 
        """Return the ASCII format string that identifies this format."""
2879
 
        raise NotImplementedError(self.get_format_string)
2880
 
 
2881
3115
    def get_format_description(self):
2882
3116
        """Return the short description for this format."""
2883
3117
        raise NotImplementedError(self.get_format_description)
2899
3133
        """True if this format supports stored views."""
2900
3134
        return False
2901
3135
 
2902
 
    @classmethod
2903
 
    def register_format(klass, format):
2904
 
        klass._formats[format.get_format_string()] = format
2905
 
 
2906
 
    @classmethod
2907
 
    def set_default_format(klass, format):
2908
 
        klass._default_format = format
2909
 
 
2910
 
    @classmethod
2911
 
    def unregister_format(klass, format):
2912
 
        del klass._formats[format.get_format_string()]
2913
 
 
2914
 
 
2915
 
class WorkingTreeFormat2(WorkingTreeFormat):
2916
 
    """The second working tree format.
2917
 
 
2918
 
    This format modified the hash cache from the format 1 hash cache.
2919
 
    """
2920
 
 
2921
 
    upgrade_recommended = True
2922
 
 
2923
 
    def get_format_description(self):
2924
 
        """See WorkingTreeFormat.get_format_description()."""
2925
 
        return "Working tree format 2"
2926
 
 
2927
 
    def _stub_initialize_on_transport(self, transport, file_mode):
2928
 
        """Workaround: create control files for a remote working tree.
2929
 
 
2930
 
        This ensures that it can later be updated and dealt with locally,
2931
 
        since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
2932
 
        no working tree.  (See bug #43064).
2933
 
        """
2934
 
        sio = StringIO()
2935
 
        inv = inventory.Inventory()
2936
 
        xml5.serializer_v5.write_inventory(inv, sio, working=True)
2937
 
        sio.seek(0)
2938
 
        transport.put_file('inventory', sio, file_mode)
2939
 
        transport.put_bytes('pending-merges', '', file_mode)
2940
 
 
2941
 
    def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
2942
 
                   accelerator_tree=None, hardlink=False):
2943
 
        """See WorkingTreeFormat.initialize()."""
2944
 
        if not isinstance(a_bzrdir.transport, LocalTransport):
2945
 
            raise errors.NotLocalUrl(a_bzrdir.transport.base)
2946
 
        if from_branch is not None:
2947
 
            branch = from_branch
2948
 
        else:
2949
 
            branch = a_bzrdir.open_branch()
2950
 
        if revision_id is None:
2951
 
            revision_id = _mod_revision.ensure_null(branch.last_revision())
2952
 
        branch.lock_write()
2953
 
        try:
2954
 
            branch.generate_revision_history(revision_id)
2955
 
        finally:
2956
 
            branch.unlock()
2957
 
        inv = inventory.Inventory()
2958
 
        wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2959
 
                         branch,
2960
 
                         inv,
2961
 
                         _internal=True,
2962
 
                         _format=self,
2963
 
                         _bzrdir=a_bzrdir)
2964
 
        basis_tree = branch.repository.revision_tree(revision_id)
2965
 
        if basis_tree.inventory.root is not None:
2966
 
            wt.set_root_id(basis_tree.get_root_id())
2967
 
        # set the parent list and cache the basis tree.
2968
 
        if _mod_revision.is_null(revision_id):
2969
 
            parent_trees = []
2970
 
        else:
2971
 
            parent_trees = [(revision_id, basis_tree)]
2972
 
        wt.set_parent_trees(parent_trees)
2973
 
        transform.build_tree(basis_tree, wt)
2974
 
        return wt
2975
 
 
2976
 
    def __init__(self):
2977
 
        super(WorkingTreeFormat2, self).__init__()
2978
 
        self._matchingbzrdir = bzrdir.BzrDirFormat6()
2979
 
 
2980
 
    def open(self, a_bzrdir, _found=False):
2981
 
        """Return the WorkingTree object for a_bzrdir
2982
 
 
2983
 
        _found is a private parameter, do not use it. It is used to indicate
2984
 
               if format probing has already been done.
2985
 
        """
2986
 
        if not _found:
2987
 
            # we are being called directly and must probe.
2988
 
            raise NotImplementedError
2989
 
        if not isinstance(a_bzrdir.transport, LocalTransport):
2990
 
            raise errors.NotLocalUrl(a_bzrdir.transport.base)
2991
 
        wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2992
 
                           _internal=True,
2993
 
                           _format=self,
2994
 
                           _bzrdir=a_bzrdir)
2995
 
        return wt
2996
 
 
2997
 
class WorkingTreeFormat3(WorkingTreeFormat):
2998
 
    """The second working tree format updated to record a format marker.
2999
 
 
3000
 
    This format:
3001
 
        - exists within a metadir controlling .bzr
3002
 
        - includes an explicit version marker for the workingtree control
3003
 
          files, separate from the BzrDir format
3004
 
        - modifies the hash cache format
3005
 
        - is new in bzr 0.8
3006
 
        - uses a LockDir to guard access for writes.
3007
 
    """
3008
 
 
3009
 
    upgrade_recommended = True
3010
 
 
3011
 
    def get_format_string(self):
3012
 
        """See WorkingTreeFormat.get_format_string()."""
3013
 
        return "Bazaar-NG Working Tree format 3"
3014
 
 
3015
 
    def get_format_description(self):
3016
 
        """See WorkingTreeFormat.get_format_description()."""
3017
 
        return "Working tree format 3"
3018
 
 
3019
 
    _lock_file_name = 'lock'
3020
 
    _lock_class = LockDir
3021
 
 
3022
 
    _tree_class = WorkingTree3
3023
 
 
3024
 
    def __get_matchingbzrdir(self):
3025
 
        return bzrdir.BzrDirMetaFormat1()
3026
 
 
3027
 
    _matchingbzrdir = property(__get_matchingbzrdir)
3028
 
 
3029
 
    def _open_control_files(self, a_bzrdir):
3030
 
        transport = a_bzrdir.get_workingtree_transport(None)
3031
 
        return LockableFiles(transport, self._lock_file_name,
3032
 
                             self._lock_class)
3033
 
 
3034
 
    def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
3035
 
                   accelerator_tree=None, hardlink=False):
3036
 
        """See WorkingTreeFormat.initialize().
3037
 
 
3038
 
        :param revision_id: if supplied, create a working tree at a different
3039
 
            revision than the branch is at.
3040
 
        :param accelerator_tree: A tree which can be used for retrieving file
3041
 
            contents more quickly than the revision tree, i.e. a workingtree.
3042
 
            The revision tree will be used for cases where accelerator_tree's
3043
 
            content is different.
3044
 
        :param hardlink: If true, hard-link files from accelerator_tree,
3045
 
            where possible.
3046
 
        """
3047
 
        if not isinstance(a_bzrdir.transport, LocalTransport):
3048
 
            raise errors.NotLocalUrl(a_bzrdir.transport.base)
3049
 
        transport = a_bzrdir.get_workingtree_transport(self)
3050
 
        control_files = self._open_control_files(a_bzrdir)
3051
 
        control_files.create_lock()
3052
 
        control_files.lock_write()
3053
 
        transport.put_bytes('format', self.get_format_string(),
3054
 
            mode=a_bzrdir._get_file_mode())
3055
 
        if from_branch is not None:
3056
 
            branch = from_branch
3057
 
        else:
3058
 
            branch = a_bzrdir.open_branch()
3059
 
        if revision_id is None:
3060
 
            revision_id = _mod_revision.ensure_null(branch.last_revision())
3061
 
        # WorkingTree3 can handle an inventory which has a unique root id.
3062
 
        # as of bzr 0.12. However, bzr 0.11 and earlier fail to handle
3063
 
        # those trees. And because there isn't a format bump inbetween, we
3064
 
        # are maintaining compatibility with older clients.
3065
 
        # inv = Inventory(root_id=gen_root_id())
3066
 
        inv = self._initial_inventory()
3067
 
        wt = self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
3068
 
                         branch,
3069
 
                         inv,
3070
 
                         _internal=True,
3071
 
                         _format=self,
3072
 
                         _bzrdir=a_bzrdir,
3073
 
                         _control_files=control_files)
3074
 
        wt.lock_tree_write()
3075
 
        try:
3076
 
            basis_tree = branch.repository.revision_tree(revision_id)
3077
 
            # only set an explicit root id if there is one to set.
3078
 
            if basis_tree.inventory.root is not None:
3079
 
                wt.set_root_id(basis_tree.get_root_id())
3080
 
            if revision_id == _mod_revision.NULL_REVISION:
3081
 
                wt.set_parent_trees([])
3082
 
            else:
3083
 
                wt.set_parent_trees([(revision_id, basis_tree)])
3084
 
            transform.build_tree(basis_tree, wt)
3085
 
        finally:
3086
 
            # Unlock in this order so that the unlock-triggers-flush in
3087
 
            # WorkingTree is given a chance to fire.
3088
 
            control_files.unlock()
3089
 
            wt.unlock()
3090
 
        return wt
3091
 
 
3092
 
    def _initial_inventory(self):
3093
 
        return inventory.Inventory()
3094
 
 
3095
 
    def __init__(self):
3096
 
        super(WorkingTreeFormat3, self).__init__()
3097
 
 
3098
 
    def open(self, a_bzrdir, _found=False):
3099
 
        """Return the WorkingTree object for a_bzrdir
3100
 
 
3101
 
        _found is a private parameter, do not use it. It is used to indicate
3102
 
               if format probing has already been done.
3103
 
        """
3104
 
        if not _found:
3105
 
            # we are being called directly and must probe.
3106
 
            raise NotImplementedError
3107
 
        if not isinstance(a_bzrdir.transport, LocalTransport):
3108
 
            raise errors.NotLocalUrl(a_bzrdir.transport.base)
3109
 
        wt = self._open(a_bzrdir, self._open_control_files(a_bzrdir))
3110
 
        return wt
3111
 
 
3112
 
    def _open(self, a_bzrdir, control_files):
3113
 
        """Open the tree itself.
3114
 
 
3115
 
        :param a_bzrdir: the dir for the tree.
3116
 
        :param control_files: the control files for the tree.
3117
 
        """
3118
 
        return self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
3119
 
                                _internal=True,
3120
 
                                _format=self,
3121
 
                                _bzrdir=a_bzrdir,
3122
 
                                _control_files=control_files)
3123
 
 
3124
 
    def __str__(self):
3125
 
        return self.get_format_string()
3126
 
 
3127
 
 
3128
 
__default_format = WorkingTreeFormat6()
3129
 
WorkingTreeFormat.register_format(__default_format)
3130
 
WorkingTreeFormat.register_format(WorkingTreeFormat5())
3131
 
WorkingTreeFormat.register_format(WorkingTreeFormat4())
3132
 
WorkingTreeFormat.register_format(WorkingTreeFormat3())
3133
 
WorkingTreeFormat.set_default_format(__default_format)
3134
 
# formats which have no format string are not discoverable
3135
 
# and not independently creatable, so are not registered.
3136
 
_legacy_formats = [WorkingTreeFormat2(),
3137
 
                   ]
 
3136
    def get_controldir_for_branch(self):
 
3137
        """Get the control directory format for creating branches.
 
3138
 
 
3139
        This is to support testing of working tree formats that can not exist
 
3140
        in the same control directory as a branch.
 
3141
        """
 
3142
        return self._matchingbzrdir
 
3143
 
 
3144
 
 
3145
class WorkingTreeFormatMetaDir(bzrdir.BzrFormat, WorkingTreeFormat):
 
3146
    """Base class for working trees that live in bzr meta directories."""
 
3147
 
 
3148
    def __init__(self):
 
3149
        WorkingTreeFormat.__init__(self)
 
3150
        bzrdir.BzrFormat.__init__(self)
 
3151
 
 
3152
    @classmethod
 
3153
    def find_format_string(klass, controldir):
 
3154
        """Return format name for the working tree object in controldir."""
 
3155
        try:
 
3156
            transport = controldir.get_workingtree_transport(None)
 
3157
            return transport.get_bytes("format")
 
3158
        except errors.NoSuchFile:
 
3159
            raise errors.NoWorkingTree(base=transport.base)
 
3160
 
 
3161
    @classmethod
 
3162
    def find_format(klass, controldir):
 
3163
        """Return the format for the working tree object in controldir."""
 
3164
        format_string = klass.find_format_string(controldir)
 
3165
        return klass._find_format(format_registry, 'working tree',
 
3166
                format_string)
 
3167
 
 
3168
    def check_support_status(self, allow_unsupported, recommend_upgrade=True,
 
3169
            basedir=None):
 
3170
        WorkingTreeFormat.check_support_status(self,
 
3171
            allow_unsupported=allow_unsupported, recommend_upgrade=recommend_upgrade,
 
3172
            basedir=basedir)
 
3173
        bzrdir.BzrFormat.check_support_status(self, allow_unsupported=allow_unsupported,
 
3174
            recommend_upgrade=recommend_upgrade, basedir=basedir)
 
3175
 
 
3176
    def get_controldir_for_branch(self):
 
3177
        """Get the control directory format for creating branches.
 
3178
 
 
3179
        This is to support testing of working tree formats that can not exist
 
3180
        in the same control directory as a branch.
 
3181
        """
 
3182
        return self._matchingbzrdir
 
3183
 
 
3184
 
 
3185
class WorkingTreeFormatMetaDir(bzrdir.BzrFormat, WorkingTreeFormat):
 
3186
    """Base class for working trees that live in bzr meta directories."""
 
3187
 
 
3188
    def __init__(self):
 
3189
        WorkingTreeFormat.__init__(self)
 
3190
        bzrdir.BzrFormat.__init__(self)
 
3191
 
 
3192
    @classmethod
 
3193
    def find_format_string(klass, controldir):
 
3194
        """Return format name for the working tree object in controldir."""
 
3195
        try:
 
3196
            transport = controldir.get_workingtree_transport(None)
 
3197
            return transport.get_bytes("format")
 
3198
        except errors.NoSuchFile:
 
3199
            raise errors.NoWorkingTree(base=transport.base)
 
3200
 
 
3201
    @classmethod
 
3202
    def find_format(klass, controldir):
 
3203
        """Return the format for the working tree object in controldir."""
 
3204
        format_string = klass.find_format_string(controldir)
 
3205
        return klass._find_format(format_registry, 'working tree',
 
3206
                format_string)
 
3207
 
 
3208
    def check_support_status(self, allow_unsupported, recommend_upgrade=True,
 
3209
            basedir=None):
 
3210
        WorkingTreeFormat.check_support_status(self,
 
3211
            allow_unsupported=allow_unsupported, recommend_upgrade=recommend_upgrade,
 
3212
            basedir=basedir)
 
3213
        bzrdir.BzrFormat.check_support_status(self, allow_unsupported=allow_unsupported,
 
3214
            recommend_upgrade=recommend_upgrade, basedir=basedir)
 
3215
 
 
3216
 
 
3217
format_registry.register_lazy("Bazaar Working Tree Format 4 (bzr 0.15)\n",
 
3218
    "bzrlib.workingtree_4", "WorkingTreeFormat4")
 
3219
format_registry.register_lazy("Bazaar Working Tree Format 5 (bzr 1.11)\n",
 
3220
    "bzrlib.workingtree_4", "WorkingTreeFormat5")
 
3221
format_registry.register_lazy("Bazaar Working Tree Format 6 (bzr 1.14)\n",
 
3222
    "bzrlib.workingtree_4", "WorkingTreeFormat6")
 
3223
format_registry.register_lazy("Bazaar-NG Working Tree format 3",
 
3224
    "bzrlib.workingtree_3", "WorkingTreeFormat3")
 
3225
format_registry.set_default_key("Bazaar Working Tree Format 6 (bzr 1.14)\n")