19
19
A WorkingTree represents the editable working copy of a branch.
 
20
20
Operations which represent the WorkingTree are also done here,
 
21
 
such as renaming or adding files.  The WorkingTree has an inventory
 
22
 
which is updated by these operations.  A commit produces a
 
23
 
new revision based on the workingtree and its inventory.
 
 
21
such as renaming or adding files.
 
25
23
At the moment every WorkingTree has its own branch.  Remote
 
26
24
WorkingTrees aren't supported.
 
28
 
To get a WorkingTree, call bzrdir.open_workingtree() or
 
 
26
To get a WorkingTree, call controldir.open_workingtree() or
 
29
27
WorkingTree.open(dir).
 
 
30
from __future__ import absolute_import
 
33
 
from cStringIO import StringIO
 
37
 
from bzrlib.lazy_import import lazy_import
 
 
40
from .lazy_import import lazy_import
 
38
41
lazy_import(globals(), """
 
39
 
from bisect import bisect_left
 
51
46
    conflicts as _mod_conflicts,
 
 
49
    filters as _mod_filters,
 
60
52
    revision as _mod_revision,
 
70
 
from bzrlib.transport import get_transport
 
71
 
from bzrlib.workingtree_4 import (
 
78
 
from bzrlib import symbol_versioning
 
79
 
from bzrlib.decorators import needs_read_lock, needs_write_lock
 
80
 
from bzrlib.lockable_files import LockableFiles
 
81
 
from bzrlib.lockdir import LockDir
 
82
 
import bzrlib.mutabletree
 
83
 
from bzrlib.mutabletree import needs_tree_write_lock
 
84
 
from bzrlib import osutils
 
85
 
from bzrlib.osutils import (
 
95
 
from bzrlib.filters import filtered_input_file
 
96
 
from bzrlib.trace import mutter, note
 
97
 
from bzrlib.transport.local import LocalTransport
 
98
 
from bzrlib.revision import CURRENT_REVISION
 
99
 
from bzrlib.rio import RioReader, rio_file, Stanza
 
100
 
from bzrlib.symbol_versioning import (
 
102
 
    DEPRECATED_PARAMETER,
 
106
 
MERGE_MODIFIED_HEADER_1 = "BZR merge-modified list format 1"
 
107
 
# TODO: Modifying the conflict objects or their type is currently nearly
 
108
 
# impossible as there is no clear relationship between the working tree format
 
109
 
# and the conflict list file format.
 
110
 
CONFLICT_HEADER_1 = "BZR conflict list format 1"
 
 
63
from .i18n import gettext
 
 
64
from . import mutabletree
 
 
68
from .trace import mutter, note
 
112
71
ERROR_PATH_NOT_FOUND = 3    # WindowsError errno code, equivalent to ENOENT
 
115
 
class TreeEntry(object):
 
116
 
    """An entry that implements the minimum interface used by commands.
 
118
 
    This needs further inspection, it may be better to have
 
119
 
    InventoryEntries without ids - though that seems wrong. For now,
 
120
 
    this is a parallel hierarchy to InventoryEntry, and needs to become
 
121
 
    one of several things: decorates to that hierarchy, children of, or
 
123
 
    Another note is that these objects are currently only used when there is
 
124
 
    no InventoryEntry available - i.e. for unversioned objects.
 
125
 
    Perhaps they should be UnversionedEntry et al. ? - RBC 20051003
 
128
 
    def __eq__(self, other):
 
129
 
        # yes, this us ugly, TODO: best practice __eq__ style.
 
130
 
        return (isinstance(other, TreeEntry)
 
131
 
                and other.__class__ == self.__class__)
 
133
 
    def kind_character(self):
 
137
 
class TreeDirectory(TreeEntry):
 
138
 
    """See TreeEntry. This is a directory in a working tree."""
 
140
 
    def __eq__(self, other):
 
141
 
        return (isinstance(other, TreeDirectory)
 
142
 
                and other.__class__ == self.__class__)
 
144
 
    def kind_character(self):
 
148
 
class TreeFile(TreeEntry):
 
149
 
    """See TreeEntry. This is a regular file in a working tree."""
 
151
 
    def __eq__(self, other):
 
152
 
        return (isinstance(other, TreeFile)
 
153
 
                and other.__class__ == self.__class__)
 
155
 
    def kind_character(self):
 
159
 
class TreeLink(TreeEntry):
 
160
 
    """See TreeEntry. This is a symlink in a working tree."""
 
162
 
    def __eq__(self, other):
 
163
 
        return (isinstance(other, TreeLink)
 
164
 
                and other.__class__ == self.__class__)
 
166
 
    def kind_character(self):
 
170
 
class WorkingTree(bzrlib.mutabletree.MutableTree,
 
171
 
    bzrdir.ControlComponent):
 
 
74
class SettingFileIdUnsupported(errors.BzrError):
 
 
76
    _fmt = "This format does not support setting file ids."
 
 
79
class ShelvingUnsupported(errors.BzrError):
 
 
81
    _fmt = "This format does not support shelving changes."
 
 
84
class WorkingTree(mutabletree.MutableTree,
 
 
85
    controldir.ControlComponent):
 
172
86
    """Working copy tree.
 
174
 
    The inventory is held in the `Branch` working-inventory, and the
 
175
 
    files are in a directory on disk.
 
177
 
    It is possible for a `WorkingTree` to have a filename which is
 
178
 
    not listed in the Inventory and vice versa.
 
 
88
    :ivar basedir: The root of the tree on disk. This is a unicode path object
 
 
89
        (as opposed to a URL).
 
181
92
    # override this to set the strategy for storing views
 
 
183
94
        return views.DisabledViews(self)
 
185
96
    def __init__(self, basedir='.',
 
186
 
                 branch=DEPRECATED_PARAMETER,
 
192
102
        """Construct a WorkingTree instance. This is not a public API.
 
194
104
        :param branch: A branch to override probing for the branch.
 
196
106
        self._format = _format
 
197
 
        self.bzrdir = _bzrdir
 
 
107
        self.controldir = _controldir
 
198
108
        if not _internal:
 
199
 
            raise errors.BzrError("Please use bzrdir.open_workingtree or "
 
 
109
            raise errors.BzrError("Please use controldir.open_workingtree or "
 
200
110
                "WorkingTree.open() to obtain a WorkingTree.")
 
201
 
        basedir = safe_unicode(basedir)
 
 
111
        basedir = osutils.safe_unicode(basedir)
 
202
112
        mutter("opening working tree %r", basedir)
 
203
 
        if deprecated_passed(branch):
 
 
113
        if branch is not None:
 
204
114
            self._branch = branch
 
206
 
            self._branch = self.bzrdir.open_branch()
 
207
 
        self.basedir = realpath(basedir)
 
208
 
        # if branch is at our basedir and is a format 6 or less
 
209
 
        if isinstance(self._format, WorkingTreeFormat2):
 
210
 
            # share control object
 
211
 
            self._control_files = self.branch.control_files
 
213
 
            # assume all other formats have their own control files.
 
214
 
            self._control_files = _control_files
 
215
 
        self._transport = self._control_files._transport
 
216
 
        # update the whole cache up front and write to disk if anything changed;
 
217
 
        # in the future we might want to do this more selectively
 
218
 
        # two possible ways offer themselves : in self._unlock, write the cache
 
219
 
        # if needed, or, when the cache sees a change, append it to the hash
 
220
 
        # cache file, and have the parser take the most recent entry for a
 
222
 
        wt_trans = self.bzrdir.get_workingtree_transport(None)
 
223
 
        cache_filename = wt_trans.local_abspath('stat-cache')
 
224
 
        self._hashcache = hashcache.HashCache(basedir, cache_filename,
 
225
 
            self.bzrdir._get_file_mode(),
 
226
 
            self._content_filter_stack_provider())
 
229
 
        # is this scan needed ? it makes things kinda slow.
 
236
 
        if _inventory is None:
 
237
 
            # This will be acquired on lock_read() or lock_write()
 
238
 
            self._inventory_is_modified = False
 
239
 
            self._inventory = None
 
241
 
            # the caller of __init__ has provided an inventory,
 
242
 
            # we assume they know what they are doing - as its only
 
243
 
            # the Format factory and creation methods that are
 
244
 
            # permitted to do this.
 
245
 
            self._set_inventory(_inventory, dirty=False)
 
246
 
        self._detect_case_handling()
 
 
116
            self._branch = self.controldir.open_branch()
 
 
117
        self.basedir = osutils.realpath(basedir)
 
 
118
        self._transport = _transport
 
247
119
        self._rules_searcher = None
 
248
120
        self.views = self._make_views()
 
251
123
    def user_transport(self):
 
252
 
        return self.bzrdir.user_transport
 
 
124
        return self.controldir.user_transport
 
255
127
    def control_transport(self):
 
256
128
        return self._transport
 
258
 
    def _detect_case_handling(self):
 
259
 
        wt_trans = self.bzrdir.get_workingtree_transport(None)
 
261
 
            wt_trans.stat("FoRMaT")
 
262
 
        except errors.NoSuchFile:
 
263
 
            self.case_sensitive = True
 
265
 
            self.case_sensitive = False
 
267
 
        self._setup_directory_is_tree_reference()
 
 
130
    def is_control_filename(self, filename):
 
 
131
        """True if filename is the name of a control file in this tree.
 
 
133
        :param filename: A filename within the tree. This is a relative path
 
 
134
            from the root of this tree.
 
 
136
        This is true IF and ONLY IF the filename is part of the meta data
 
 
137
        that bzr controls in this tree. I.E. a random .bzr directory placed
 
 
138
        on disk will not be a control file for this tree.
 
 
140
        return self.controldir.is_control_filename(filename)
 
269
142
    branch = property(
 
270
143
        fget=lambda self: self._branch,
 
 
347
217
            path = osutils.getcwd()
 
348
 
        control, relpath = bzrdir.BzrDir.open_containing(path)
 
 
218
        control, relpath = controldir.ControlDir.open_containing(path)
 
350
219
        return control.open_workingtree(), relpath
 
 
222
    def open_containing_paths(file_list, default_directory=None,
 
 
223
                              canonicalize=True, apply_view=True):
 
 
224
        """Open the WorkingTree that contains a set of paths.
 
 
226
        Fail if the paths given are not all in a single tree.
 
 
228
        This is used for the many command-line interfaces that take a list of
 
 
229
        any number of files and that require they all be in the same tree.
 
 
231
        if default_directory is None:
 
 
232
            default_directory = u'.'
 
 
233
        # recommended replacement for builtins.internal_tree_files
 
 
234
        if file_list is None or len(file_list) == 0:
 
 
235
            tree = WorkingTree.open_containing(default_directory)[0]
 
 
236
            # XXX: doesn't really belong here, and seems to have the strange
 
 
237
            # side effect of making it return a bunch of files, not the whole
 
 
238
            # tree -- mbp 20100716
 
 
239
            if tree.supports_views() and apply_view:
 
 
240
                view_files = tree.views.lookup_view()
 
 
242
                    file_list = view_files
 
 
243
                    view_str = views.view_display_str(view_files)
 
 
244
                    note(gettext("Ignoring files outside view. View is %s") % view_str)
 
 
245
            return tree, file_list
 
 
246
        if default_directory == u'.':
 
 
249
            seed = default_directory
 
 
250
            file_list = [osutils.pathjoin(default_directory, f)
 
 
252
        tree = WorkingTree.open_containing(seed)[0]
 
 
253
        return tree, tree.safe_relpath_files(file_list, canonicalize,
 
 
254
                                             apply_view=apply_view)
 
 
256
    def safe_relpath_files(self, file_list, canonicalize=True, apply_view=True):
 
 
257
        """Convert file_list into a list of relpaths in tree.
 
 
259
        :param self: A tree to operate on.
 
 
260
        :param file_list: A list of user provided paths or None.
 
 
261
        :param apply_view: if True and a view is set, apply it or check that
 
 
262
            specified files are within it
 
 
263
        :return: A list of relative paths.
 
 
264
        :raises errors.PathNotChild: When a provided path is in a different self
 
 
267
        if file_list is None:
 
 
269
        if self.supports_views() and apply_view:
 
 
270
            view_files = self.views.lookup_view()
 
 
274
        # self.relpath exists as a "thunk" to osutils, but canonical_relpath
 
 
275
        # doesn't - fix that up here before we enter the loop.
 
 
277
            fixer = lambda p: osutils.canonical_relpath(self.basedir, p)
 
 
280
        for filename in file_list:
 
 
281
            relpath = fixer(osutils.dereference_path(filename))
 
 
282
            if view_files and not osutils.is_inside_any(view_files, relpath):
 
 
283
                raise views.FileOutsideView(filename, view_files)
 
 
284
            new_list.append(relpath)
 
353
288
    def open_downlevel(path=None):
 
354
289
        """Open an unsupported working tree.
 
356
 
        Only intended for advanced situations like upgrading part of a bzrdir.
 
 
291
        Only intended for advanced situations like upgrading part of a controldir.
 
358
293
        return WorkingTree.open(path, _unsupported=True)
 
361
296
    def find_trees(location):
 
362
297
        def list_current(transport):
 
363
 
            return [d for d in transport.list_dir('') if d != '.bzr']
 
364
 
        def evaluate(bzrdir):
 
 
298
            return [d for d in transport.list_dir('')
 
 
299
                    if not controldir.is_control_filename(d)]
 
 
300
        def evaluate(controldir):
 
366
 
                tree = bzrdir.open_workingtree()
 
 
302
                tree = controldir.open_workingtree()
 
367
303
            except errors.NoWorkingTree:
 
368
304
                return True, None
 
370
306
                return True, tree
 
371
 
        transport = get_transport(location)
 
372
 
        iterator = bzrdir.BzrDir.find_bzrdirs(transport, evaluate=evaluate,
 
 
307
        t = transport.get_transport(location)
 
 
308
        iterator = controldir.ControlDir.find_controldirs(t, evaluate=evaluate,
 
373
309
                                              list_current=list_current)
 
374
 
        return [t for t in iterator if t is not None]
 
376
 
    # should be deprecated - this is slow and in any case treating them as a
 
377
 
    # container is (we now know) bad style -- mbp 20070302
 
378
 
    ## @deprecated_method(zero_fifteen)
 
380
 
        """Iterate through file_ids for this tree.
 
382
 
        file_ids are in a WorkingTree if they are in the working inventory
 
383
 
        and the working file exists.
 
385
 
        inv = self._inventory
 
386
 
        for path, ie in inv.iter_entries():
 
387
 
            if osutils.lexists(self.abspath(path)):
 
390
 
    def all_file_ids(self):
 
391
 
        """See Tree.iter_all_file_ids"""
 
392
 
        return set(self.inventory)
 
 
310
        return [tr for tr in iterator if tr is not None]
 
394
312
    def __repr__(self):
 
395
313
        return "<%s of %s>" % (self.__class__.__name__,
 
396
314
                               getattr(self, 'basedir', None))
 
398
316
    def abspath(self, filename):
 
399
 
        return pathjoin(self.basedir, filename)
 
 
317
        return osutils.pathjoin(self.basedir, filename)
 
401
319
    def basis_tree(self):
 
402
320
        """Return RevisionTree for the current last revision.
 
 
446
361
    def has_filename(self, filename):
 
447
362
        return osutils.lexists(self.abspath(filename))
 
449
 
    def get_file(self, file_id, path=None, filtered=True):
 
450
 
        return self.get_file_with_stat(file_id, path, filtered=filtered)[0]
 
 
364
    def get_file(self, path, file_id=None, filtered=True):
 
 
365
        return self.get_file_with_stat(path, file_id, filtered=filtered)[0]
 
452
 
    def get_file_with_stat(self, file_id, path=None, filtered=True,
 
 
367
    def get_file_with_stat(self, path, file_id=None, filtered=True,
 
 
368
                           _fstat=osutils.fstat):
 
454
369
        """See Tree.get_file_with_stat."""
 
456
 
            path = self.id2path(file_id)
 
457
 
        file_obj = self.get_file_byname(path, filtered=False)
 
 
370
        abspath = self.abspath(path)
 
 
371
        file_obj = file(abspath, 'rb')
 
458
372
        stat_value = _fstat(file_obj.fileno())
 
459
373
        if filtered and self.supports_content_filtering():
 
460
374
            filters = self._content_filter_stack(path)
 
461
 
            file_obj = filtered_input_file(file_obj, filters)
 
 
375
            file_obj = _mod_filters.filtered_input_file(file_obj, filters)
 
462
376
        return (file_obj, stat_value)
 
464
 
    def get_file_text(self, file_id, path=None, filtered=True):
 
465
 
        return self.get_file(file_id, path=path, filtered=filtered).read()
 
467
 
    def get_file_byname(self, filename, filtered=True):
 
468
 
        path = self.abspath(filename)
 
470
 
        if filtered and self.supports_content_filtering():
 
471
 
            filters = self._content_filter_stack(filename)
 
472
 
            return filtered_input_file(f, filters)
 
476
 
    def get_file_lines(self, file_id, path=None, filtered=True):
 
 
378
    def get_file_text(self, path, file_id=None, filtered=True):
 
 
379
        my_file = self.get_file(path, file_id, filtered=filtered)
 
 
381
            return my_file.read()
 
 
385
    def get_file_lines(self, path, file_id=None, filtered=True):
 
477
386
        """See Tree.get_file_lines()"""
 
478
 
        file = self.get_file(file_id, path, filtered=filtered)
 
 
387
        file = self.get_file(path, file_id, filtered=filtered)
 
480
389
            return file.readlines()
 
485
 
    def annotate_iter(self, file_id, default_revision=CURRENT_REVISION):
 
486
 
        """See Tree.annotate_iter
 
488
 
        This implementation will use the basis tree implementation if possible.
 
489
 
        Lines not in the basis are attributed to CURRENT_REVISION
 
491
 
        If there are pending merges, lines added by those merges will be
 
492
 
        incorrectly attributed to CURRENT_REVISION (but after committing, the
 
493
 
        attribution will be correct).
 
495
 
        maybe_file_parent_keys = []
 
496
 
        for parent_id in self.get_parent_ids():
 
498
 
                parent_tree = self.revision_tree(parent_id)
 
499
 
            except errors.NoSuchRevisionInTree:
 
500
 
                parent_tree = self.branch.repository.revision_tree(parent_id)
 
501
 
            parent_tree.lock_read()
 
503
 
                if file_id not in parent_tree:
 
505
 
                ie = parent_tree.inventory[file_id]
 
506
 
                if ie.kind != 'file':
 
507
 
                    # Note: this is slightly unnecessary, because symlinks and
 
508
 
                    # directories have a "text" which is the empty text, and we
 
509
 
                    # know that won't mess up annotations. But it seems cleaner
 
511
 
                parent_text_key = (file_id, ie.revision)
 
512
 
                if parent_text_key not in maybe_file_parent_keys:
 
513
 
                    maybe_file_parent_keys.append(parent_text_key)
 
516
 
        graph = _mod_graph.Graph(self.branch.repository.texts)
 
517
 
        heads = graph.heads(maybe_file_parent_keys)
 
518
 
        file_parent_keys = []
 
519
 
        for key in maybe_file_parent_keys:
 
521
 
                file_parent_keys.append(key)
 
523
 
        # Now we have the parents of this content
 
524
 
        annotator = self.branch.repository.texts.get_annotator()
 
525
 
        text = self.get_file(file_id).read()
 
526
 
        this_key =(file_id, default_revision)
 
527
 
        annotator.add_special_text(this_key, file_parent_keys, text)
 
528
 
        annotations = [(key[-1], line)
 
529
 
                       for key, line in annotator.annotate_flat(this_key)]
 
532
 
    def _get_ancestors(self, default_revision):
 
533
 
        ancestors = set([default_revision])
 
534
 
        for parent_id in self.get_parent_ids():
 
535
 
            ancestors.update(self.branch.repository.get_ancestry(
 
536
 
                             parent_id, topo_sorted=False))
 
539
393
    def get_parent_ids(self):
 
540
394
        """See Tree.get_parent_ids.
 
 
557
411
                parents.append(revision_id)
 
561
414
    def get_root_id(self):
 
562
415
        """Return the id of this trees root"""
 
563
 
        return self._inventory.root.file_id
 
565
 
    def _get_store_filename(self, file_id):
 
566
 
        ## XXX: badly named; this is not in the store at all
 
567
 
        return self.abspath(self.id2path(file_id))
 
570
 
    def clone(self, to_bzrdir, revision_id=None):
 
 
416
        raise NotImplementedError(self.get_root_id)
 
 
418
    def clone(self, to_controldir, revision_id=None):
 
571
419
        """Duplicate this working tree into to_bzr, including all state.
 
573
421
        Specifically modified files are kept as modified, but
 
574
422
        ignored and unknown files are discarded.
 
576
 
        If you want to make a new line of development, see bzrdir.sprout()
 
 
424
        If you want to make a new line of development, see ControlDir.sprout()
 
579
427
            If not None, the cloned tree will have its last revision set to
 
580
428
            revision, and difference between the source trees last revision
 
581
429
            and this one merged in.
 
583
 
        # assumes the target bzr dir format is compatible.
 
584
 
        result = to_bzrdir.create_workingtree()
 
585
 
        self.copy_content_into(result, revision_id)
 
 
431
        with self.lock_read():
 
 
432
            # assumes the target bzr dir format is compatible.
 
 
433
            result = to_controldir.create_workingtree()
 
 
434
            self.copy_content_into(result, revision_id)
 
589
437
    def copy_content_into(self, tree, revision_id=None):
 
590
438
        """Copy the current content and user files of this tree into tree."""
 
591
 
        tree.set_root_id(self.get_root_id())
 
592
 
        if revision_id is None:
 
593
 
            merge.transform_tree(tree, self)
 
595
 
            # TODO now merge from tree.last_revision to revision (to preserve
 
596
 
            # user local changes)
 
597
 
            merge.transform_tree(tree, self)
 
598
 
            tree.set_parent_ids([revision_id])
 
 
439
        with self.lock_read():
 
 
440
            tree.set_root_id(self.get_root_id())
 
 
441
            if revision_id is None:
 
 
442
                merge.transform_tree(tree, self)
 
 
444
                # TODO now merge from tree.last_revision to revision (to
 
 
445
                # preserve user local changes)
 
 
447
                    other_tree = self.revision_tree(revision_id)
 
 
448
                except errors.NoSuchRevision:
 
 
449
                    other_tree = self.branch.repository.revision_tree(
 
 
452
                merge.transform_tree(tree, other_tree)
 
 
453
                if revision_id == _mod_revision.NULL_REVISION:
 
 
456
                    new_parents = [revision_id]
 
 
457
                tree.set_parent_ids(new_parents)
 
600
459
    def id2abspath(self, file_id):
 
601
460
        return self.abspath(self.id2path(file_id))
 
603
 
    def has_id(self, file_id):
 
604
 
        # files that have been deleted are excluded
 
606
 
        if not inv.has_id(file_id):
 
608
 
        path = inv.id2path(file_id)
 
609
 
        return osutils.lexists(self.abspath(path))
 
611
 
    def has_or_had_id(self, file_id):
 
612
 
        if file_id == self.inventory.root.file_id:
 
614
 
        return self.inventory.has_id(file_id)
 
616
 
    __contains__ = has_id
 
618
 
    def get_file_size(self, file_id):
 
 
462
    def get_file_size(self, path, file_id=None):
 
619
463
        """See Tree.get_file_size"""
 
620
464
        # XXX: this returns the on-disk size; it should probably return the
 
623
 
            return os.path.getsize(self.id2abspath(file_id))
 
 
467
            return os.path.getsize(self.abspath(path))
 
625
469
            if e.errno != errno.ENOENT:
 
631
 
    def get_file_sha1(self, file_id, path=None, stat_value=None):
 
633
 
            path = self._inventory.id2path(file_id)
 
634
 
        return self._hashcache.get_sha1(path, stat_value)
 
636
 
    def get_file_mtime(self, file_id, path=None):
 
638
 
            path = self.inventory.id2path(file_id)
 
639
 
        return os.lstat(self.abspath(path)).st_mtime
 
641
 
    def _is_executable_from_path_and_stat_from_basis(self, path, stat_result):
 
642
 
        file_id = self.path2id(path)
 
644
 
            # For unversioned files on win32, we just assume they are not
 
647
 
        return self._inventory[file_id].executable
 
649
 
    def _is_executable_from_path_and_stat_from_stat(self, path, stat_result):
 
650
 
        mode = stat_result.st_mode
 
651
 
        return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
 
653
 
    if not supports_executable():
 
654
 
        def is_executable(self, file_id, path=None):
 
655
 
            return self._inventory[file_id].executable
 
657
 
        _is_executable_from_path_and_stat = \
 
658
 
            _is_executable_from_path_and_stat_from_basis
 
660
 
        def is_executable(self, file_id, path=None):
 
662
 
                path = self.id2path(file_id)
 
663
 
            mode = os.lstat(self.abspath(path)).st_mode
 
664
 
            return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
 
666
 
        _is_executable_from_path_and_stat = \
 
667
 
            _is_executable_from_path_and_stat_from_stat
 
669
 
    @needs_tree_write_lock
 
670
 
    def _add(self, files, ids, kinds):
 
671
 
        """See MutableTree._add."""
 
672
 
        # TODO: Re-adding a file that is removed in the working copy
 
673
 
        # should probably put it back with the previous ID.
 
674
 
        # the read and write working inventory should not occur in this
 
675
 
        # function - they should be part of lock_write and unlock.
 
677
 
        for f, file_id, kind in zip(files, ids, kinds):
 
679
 
                inv.add_path(f, kind=kind)
 
681
 
                inv.add_path(f, kind=kind, file_id=file_id)
 
682
 
            self._inventory_is_modified = True
 
684
 
    @needs_tree_write_lock
 
685
474
    def _gather_kinds(self, files, kinds):
 
686
475
        """See MutableTree._gather_kinds."""
 
687
 
        for pos, f in enumerate(files):
 
688
 
            if kinds[pos] is None:
 
689
 
                fullpath = normpath(self.abspath(f))
 
691
 
                    kinds[pos] = file_kind(fullpath)
 
693
 
                    if e.errno == errno.ENOENT:
 
694
 
                        raise errors.NoSuchFile(fullpath)
 
 
476
        with self.lock_tree_write():
 
 
477
            for pos, f in enumerate(files):
 
 
478
                if kinds[pos] is None:
 
 
479
                    fullpath = osutils.normpath(self.abspath(f))
 
 
481
                        kinds[pos] = osutils.file_kind(fullpath)
 
 
483
                        if e.errno == errno.ENOENT:
 
 
484
                            raise errors.NoSuchFile(fullpath)
 
697
486
    def add_parent_tree_id(self, revision_id, allow_leftmost_as_ghost=False):
 
698
487
        """Add revision_id as a parent.
 
 
828
617
        :param revision_ids: The revision_ids to set as the parent ids of this
 
829
618
            working tree. Any of these may be ghosts.
 
831
 
        self._check_parents_for_ghosts(revision_ids,
 
832
 
            allow_leftmost_as_ghost=allow_leftmost_as_ghost)
 
833
 
        for revision_id in revision_ids:
 
834
 
            _mod_revision.check_not_reserved_id(revision_id)
 
836
 
        revision_ids = self._filter_parent_ids_by_ancestry(revision_ids)
 
838
 
        if len(revision_ids) > 0:
 
839
 
            self.set_last_revision(revision_ids[0])
 
841
 
            self.set_last_revision(_mod_revision.NULL_REVISION)
 
843
 
        self._set_merges_from_parent_ids(revision_ids)
 
845
 
    @needs_tree_write_lock
 
846
 
    def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
 
847
 
        """See MutableTree.set_parent_trees."""
 
848
 
        parent_ids = [rev for (rev, tree) in parents_list]
 
849
 
        for revision_id in parent_ids:
 
850
 
            _mod_revision.check_not_reserved_id(revision_id)
 
852
 
        self._check_parents_for_ghosts(parent_ids,
 
853
 
            allow_leftmost_as_ghost=allow_leftmost_as_ghost)
 
855
 
        parent_ids = self._filter_parent_ids_by_ancestry(parent_ids)
 
857
 
        if len(parent_ids) == 0:
 
858
 
            leftmost_parent_id = _mod_revision.NULL_REVISION
 
859
 
            leftmost_parent_tree = None
 
861
 
            leftmost_parent_id, leftmost_parent_tree = parents_list[0]
 
863
 
        if self._change_last_revision(leftmost_parent_id):
 
864
 
            if leftmost_parent_tree is None:
 
865
 
                # If we don't have a tree, fall back to reading the
 
866
 
                # parent tree from the repository.
 
867
 
                self._cache_basis_inventory(leftmost_parent_id)
 
 
620
        with self.lock_tree_write():
 
 
621
            self._check_parents_for_ghosts(revision_ids,
 
 
622
                allow_leftmost_as_ghost=allow_leftmost_as_ghost)
 
 
623
            for revision_id in revision_ids:
 
 
624
                _mod_revision.check_not_reserved_id(revision_id)
 
 
626
            revision_ids = self._filter_parent_ids_by_ancestry(revision_ids)
 
 
628
            if len(revision_ids) > 0:
 
 
629
                self.set_last_revision(revision_ids[0])
 
869
 
                inv = leftmost_parent_tree.inventory
 
870
 
                xml = self._create_basis_xml_from_inventory(
 
871
 
                                        leftmost_parent_id, inv)
 
872
 
                self._write_basis_inventory(xml)
 
873
 
        self._set_merges_from_parent_ids(parent_ids)
 
875
 
    @needs_tree_write_lock
 
 
631
                self.set_last_revision(_mod_revision.NULL_REVISION)
 
 
633
            self._set_merges_from_parent_ids(revision_ids)
 
876
635
    def set_pending_merges(self, rev_list):
 
877
 
        parents = self.get_parent_ids()
 
878
 
        leftmost = parents[:1]
 
879
 
        new_parents = leftmost + rev_list
 
880
 
        self.set_parent_ids(new_parents)
 
 
636
        with self.lock_tree_write():
 
 
637
            parents = self.get_parent_ids()
 
 
638
            leftmost = parents[:1]
 
 
639
            new_parents = leftmost + rev_list
 
 
640
            self.set_parent_ids(new_parents)
 
882
 
    @needs_tree_write_lock
 
883
642
    def set_merge_modified(self, modified_hashes):
 
885
 
            for file_id, hash in modified_hashes.iteritems():
 
886
 
                yield Stanza(file_id=file_id.decode('utf8'), hash=hash)
 
887
 
        self._put_rio('merge-hashes', iter_stanzas(), MERGE_MODIFIED_HEADER_1)
 
 
643
        """Set the merge modified hashes."""
 
 
644
        raise NotImplementedError(self.set_merge_modified)
 
889
646
    def _sha_from_stat(self, path, stat_result):
 
890
647
        """Get a sha digest from the tree's stat cache.
 
 
913
663
            of the branch when it is supplied. If None, to_revision defaults to
 
914
664
            branch.last_revision().
 
916
 
        from bzrlib.merge import Merger, Merge3Merger
 
917
 
        merger = Merger(self.branch, this_tree=self)
 
918
 
        # check that there are no local alterations
 
919
 
        if not force and self.has_changes():
 
920
 
            raise errors.UncommittedChanges(self)
 
921
 
        if to_revision is None:
 
922
 
            to_revision = _mod_revision.ensure_null(branch.last_revision())
 
923
 
        merger.other_rev_id = to_revision
 
924
 
        if _mod_revision.is_null(merger.other_rev_id):
 
925
 
            raise errors.NoCommits(branch)
 
926
 
        self.branch.fetch(branch, last_revision=merger.other_rev_id)
 
927
 
        merger.other_basis = merger.other_rev_id
 
928
 
        merger.other_tree = self.branch.repository.revision_tree(
 
930
 
        merger.other_branch = branch
 
931
 
        if from_revision is None:
 
934
 
            merger.set_base_revision(from_revision, branch)
 
935
 
        if merger.base_rev_id == merger.other_rev_id:
 
936
 
            raise errors.PointlessMerge
 
937
 
        merger.backup_files = False
 
938
 
        if merge_type is None:
 
939
 
            merger.merge_type = Merge3Merger
 
941
 
            merger.merge_type = merge_type
 
942
 
        merger.set_interesting_files(None)
 
943
 
        merger.show_base = False
 
944
 
        merger.reprocess = False
 
945
 
        conflicts = merger.do_merge()
 
 
666
        from .merge import Merger, Merge3Merger
 
 
667
        with self.lock_write():
 
 
668
            merger = Merger(self.branch, this_tree=self)
 
 
669
            # check that there are no local alterations
 
 
670
            if not force and self.has_changes():
 
 
671
                raise errors.UncommittedChanges(self)
 
 
672
            if to_revision is None:
 
 
673
                to_revision = _mod_revision.ensure_null(branch.last_revision())
 
 
674
            merger.other_rev_id = to_revision
 
 
675
            if _mod_revision.is_null(merger.other_rev_id):
 
 
676
                raise errors.NoCommits(branch)
 
 
677
            self.branch.fetch(branch, last_revision=merger.other_rev_id)
 
 
678
            merger.other_basis = merger.other_rev_id
 
 
679
            merger.other_tree = self.branch.repository.revision_tree(
 
 
681
            merger.other_branch = branch
 
 
682
            if from_revision is None:
 
 
685
                merger.set_base_revision(from_revision, branch)
 
 
686
            if merger.base_rev_id == merger.other_rev_id:
 
 
687
                raise errors.PointlessMerge
 
 
688
            merger.backup_files = False
 
 
689
            if merge_type is None:
 
 
690
                merger.merge_type = Merge3Merger
 
 
692
                merger.merge_type = merge_type
 
 
693
            merger.set_interesting_files(None)
 
 
694
            merger.show_base = False
 
 
695
            merger.reprocess = False
 
 
696
            conflicts = merger.do_merge()
 
950
700
    def merge_modified(self):
 
951
701
        """Return a dictionary of files modified by a merge.
 
 
955
705
        because of a merge.
 
957
707
        This returns a map of file_id->sha1, containing only files which are
 
958
 
        still in the working inventory and have that text hash.
 
 
708
        still in the working tree and have that text hash.
 
961
 
            hashfile = self._transport.get('merge-hashes')
 
962
 
        except errors.NoSuchFile:
 
967
 
                if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
 
968
 
                    raise errors.MergeModifiedFormatError()
 
969
 
            except StopIteration:
 
970
 
                raise errors.MergeModifiedFormatError()
 
971
 
            for s in RioReader(hashfile):
 
972
 
                # RioReader reads in Unicode, so convert file_ids back to utf8
 
973
 
                file_id = osutils.safe_file_id(s.get("file_id"), warn=False)
 
974
 
                if file_id not in self.inventory:
 
976
 
                text_hash = s.get("hash")
 
977
 
                if text_hash == self.get_file_sha1(file_id):
 
978
 
                    merge_hashes[file_id] = text_hash
 
 
710
        raise NotImplementedError(self.merge_modified)
 
984
712
    def mkdir(self, path, file_id=None):
 
985
713
        """See MutableTree.mkdir()."""
 
986
714
        if file_id is None:
 
987
 
            file_id = generate_ids.gen_file_id(os.path.basename(path))
 
988
 
        os.mkdir(self.abspath(path))
 
989
 
        self.add(path, file_id, 'directory')
 
 
715
            if self.supports_setting_file_ids():
 
 
716
                file_id = generate_ids.gen_file_id(os.path.basename(path))
 
 
718
            if not self.supports_setting_file_ids():
 
 
719
                raise SettingFileIdUnsupported()
 
 
720
        with self.lock_write():
 
 
721
            os.mkdir(self.abspath(path))
 
 
722
            self.add(path, file_id, 'directory')
 
992
 
    def get_symlink_target(self, file_id):
 
993
 
        abspath = self.id2abspath(file_id)
 
 
725
    def get_symlink_target(self, path, file_id=None):
 
 
727
            abspath = self.abspath(path)
 
 
729
            abspath = self.id2abspath(file_id)
 
994
730
        target = osutils.readlink(abspath)
 
998
733
    def subsume(self, other_tree):
 
999
 
        def add_children(inventory, entry):
 
1000
 
            for child_entry in entry.children.values():
 
1001
 
                inventory._byid[child_entry.file_id] = child_entry
 
1002
 
                if child_entry.kind == 'directory':
 
1003
 
                    add_children(inventory, child_entry)
 
1004
 
        if other_tree.get_root_id() == self.get_root_id():
 
1005
 
            raise errors.BadSubsumeSource(self, other_tree,
 
1006
 
                                          'Trees have the same root')
 
1008
 
            other_tree_path = self.relpath(other_tree.basedir)
 
1009
 
        except errors.PathNotChild:
 
1010
 
            raise errors.BadSubsumeSource(self, other_tree,
 
1011
 
                'Tree is not contained by the other')
 
1012
 
        new_root_parent = self.path2id(osutils.dirname(other_tree_path))
 
1013
 
        if new_root_parent is None:
 
1014
 
            raise errors.BadSubsumeSource(self, other_tree,
 
1015
 
                'Parent directory is not versioned.')
 
1016
 
        # We need to ensure that the result of a fetch will have a
 
1017
 
        # versionedfile for the other_tree root, and only fetching into
 
1018
 
        # RepositoryKnit2 guarantees that.
 
1019
 
        if not self.branch.repository.supports_rich_root():
 
1020
 
            raise errors.SubsumeTargetNeedsUpgrade(other_tree)
 
1021
 
        other_tree.lock_tree_write()
 
1023
 
            new_parents = other_tree.get_parent_ids()
 
1024
 
            other_root = other_tree.inventory.root
 
1025
 
            other_root.parent_id = new_root_parent
 
1026
 
            other_root.name = osutils.basename(other_tree_path)
 
1027
 
            self.inventory.add(other_root)
 
1028
 
            add_children(self.inventory, other_root)
 
1029
 
            self._write_inventory(self.inventory)
 
1030
 
            # normally we don't want to fetch whole repositories, but i think
 
1031
 
            # here we really do want to consolidate the whole thing.
 
1032
 
            for parent_id in other_tree.get_parent_ids():
 
1033
 
                self.branch.fetch(other_tree.branch, parent_id)
 
1034
 
                self.add_parent_tree_id(parent_id)
 
1037
 
        other_tree.bzrdir.retire_bzrdir()
 
 
734
        raise NotImplementedError(self.subsume)
 
1039
736
    def _setup_directory_is_tree_reference(self):
 
1040
737
        if self._branch.repository._format.supports_tree_reference:
 
 
1062
759
        # checkout in a subdirectory.  This can be avoided by not adding
 
1063
760
        # it.  mbp 20070306
 
1065
 
    @needs_tree_write_lock
 
1066
 
    def extract(self, file_id, format=None):
 
 
762
    def extract(self, path, file_id=None, format=None):
 
1067
763
        """Extract a subtree from this tree.
 
1069
765
        A new branch will be created, relative to the path for this tree.
 
1073
 
            segments = osutils.splitpath(path)
 
1074
 
            transport = self.branch.bzrdir.root_transport
 
1075
 
            for name in segments:
 
1076
 
                transport = transport.clone(name)
 
1077
 
                transport.ensure_base()
 
1080
 
        sub_path = self.id2path(file_id)
 
1081
 
        branch_transport = mkdirs(sub_path)
 
1083
 
            format = self.bzrdir.cloning_metadir()
 
1084
 
        branch_transport.ensure_base()
 
1085
 
        branch_bzrdir = format.initialize_on_transport(branch_transport)
 
1087
 
            repo = branch_bzrdir.find_repository()
 
1088
 
        except errors.NoRepositoryPresent:
 
1089
 
            repo = branch_bzrdir.create_repository()
 
1090
 
        if not repo.supports_rich_root():
 
1091
 
            raise errors.RootNotRich()
 
1092
 
        new_branch = branch_bzrdir.create_branch()
 
1093
 
        new_branch.pull(self.branch)
 
1094
 
        for parent_id in self.get_parent_ids():
 
1095
 
            new_branch.fetch(self.branch, parent_id)
 
1096
 
        tree_transport = self.bzrdir.root_transport.clone(sub_path)
 
1097
 
        if tree_transport.base != branch_transport.base:
 
1098
 
            tree_bzrdir = format.initialize_on_transport(tree_transport)
 
1099
 
            branch.BranchReferenceFormat().initialize(tree_bzrdir,
 
1100
 
                target_branch=new_branch)
 
1102
 
            tree_bzrdir = branch_bzrdir
 
1103
 
        wt = tree_bzrdir.create_workingtree(_mod_revision.NULL_REVISION)
 
1104
 
        wt.set_parent_ids(self.get_parent_ids())
 
1105
 
        my_inv = self.inventory
 
1106
 
        child_inv = inventory.Inventory(root_id=None)
 
1107
 
        new_root = my_inv[file_id]
 
1108
 
        my_inv.remove_recursive_id(file_id)
 
1109
 
        new_root.parent_id = None
 
1110
 
        child_inv.add(new_root)
 
1111
 
        self._write_inventory(my_inv)
 
1112
 
        wt._write_inventory(child_inv)
 
1115
 
    def _serialize(self, inventory, out_file):
 
1116
 
        xml5.serializer_v5.write_inventory(self._inventory, out_file,
 
1119
 
    def _deserialize(selt, in_file):
 
1120
 
        return xml5.serializer_v5.read_inventory(in_file)
 
 
767
        raise NotImplementedError(self.extract)
 
1122
769
    def flush(self):
 
1123
 
        """Write the in memory inventory to disk."""
 
1124
 
        # TODO: Maybe this should only write on dirty ?
 
1125
 
        if self._control_files._lock_mode != 'w':
 
1126
 
            raise errors.NotWriteLocked(self)
 
1128
 
        self._serialize(self._inventory, sio)
 
1130
 
        self._transport.put_file('inventory', sio,
 
1131
 
            mode=self.bzrdir._get_file_mode())
 
1132
 
        self._inventory_is_modified = False
 
 
770
        """Write the in memory meta data to disk."""
 
 
771
        raise NotImplementedError(self.flush)
 
1134
 
    def _kind(self, relpath):
 
 
773
    def kind(self, relpath, file_id=None):
 
 
774
        if file_id is not None:
 
 
775
            return osutils.file_kind(self.id2abspath(file_id))
 
1135
776
        return osutils.file_kind(self.abspath(relpath))
 
1137
778
    def list_files(self, include_root=False, from_dir=None, recursive=True):
 
 
1145
786
        :param from_dir: start from this directory or None for the root
 
1146
787
        :param recursive: whether to recurse into subdirectories or not
 
1148
 
        # list_files is an iterator, so @needs_read_lock doesn't work properly
 
1149
 
        # with it. So callers should be careful to always read_lock the tree.
 
1150
 
        if not self.is_locked():
 
1151
 
            raise errors.ObjectNotLocked(self)
 
1153
 
        inv = self.inventory
 
1154
 
        if from_dir is None and include_root is True:
 
1155
 
            yield ('', 'V', 'directory', inv.root.file_id, inv.root)
 
1156
 
        # Convert these into local objects to save lookup times
 
1157
 
        pathjoin = osutils.pathjoin
 
1158
 
        file_kind = self._kind
 
1160
 
        # transport.base ends in a slash, we want the piece
 
1161
 
        # between the last two slashes
 
1162
 
        transport_base_dir = self.bzrdir.transport.base.rsplit('/', 2)[1]
 
1164
 
        fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
 
1166
 
        # directory file_id, relative path, absolute path, reverse sorted children
 
1167
 
        if from_dir is not None:
 
1168
 
            from_dir_id = inv.path2id(from_dir)
 
1169
 
            if from_dir_id is None:
 
1170
 
                # Directory not versioned
 
1172
 
            from_dir_abspath = pathjoin(self.basedir, from_dir)
 
1174
 
            from_dir_id = inv.root.file_id
 
1175
 
            from_dir_abspath = self.basedir
 
1176
 
        children = os.listdir(from_dir_abspath)
 
1178
 
        # jam 20060527 The kernel sized tree seems equivalent whether we
 
1179
 
        # use a deque and popleft to keep them sorted, or if we use a plain
 
1180
 
        # list and just reverse() them.
 
1181
 
        children = collections.deque(children)
 
1182
 
        stack = [(from_dir_id, u'', from_dir_abspath, children)]
 
1184
 
            from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
 
1187
 
                f = children.popleft()
 
1188
 
                ## TODO: If we find a subdirectory with its own .bzr
 
1189
 
                ## directory, then that is a separate tree and we
 
1190
 
                ## should exclude it.
 
1192
 
                # the bzrdir for this tree
 
1193
 
                if transport_base_dir == f:
 
1196
 
                # we know that from_dir_relpath and from_dir_abspath never end in a slash
 
1197
 
                # and 'f' doesn't begin with one, we can do a string op, rather
 
1198
 
                # than the checks of pathjoin(), all relative paths will have an extra slash
 
1200
 
                fp = from_dir_relpath + '/' + f
 
1203
 
                fap = from_dir_abspath + '/' + f
 
1205
 
                f_ie = inv.get_child(from_dir_id, f)
 
1208
 
                elif self.is_ignored(fp[1:]):
 
1211
 
                    # we may not have found this file, because of a unicode issue
 
1212
 
                    f_norm, can_access = osutils.normalized_filename(f)
 
1213
 
                    if f == f_norm or not can_access:
 
1214
 
                        # No change, so treat this file normally
 
1217
 
                        # this file can be accessed by a normalized path
 
1218
 
                        # check again if it is versioned
 
1219
 
                        # these lines are repeated here for performance
 
1221
 
                        fp = from_dir_relpath + '/' + f
 
1222
 
                        fap = from_dir_abspath + '/' + f
 
1223
 
                        f_ie = inv.get_child(from_dir_id, f)
 
1226
 
                        elif self.is_ignored(fp[1:]):
 
1233
 
                # make a last minute entry
 
1235
 
                    yield fp[1:], c, fk, f_ie.file_id, f_ie
 
1238
 
                        yield fp[1:], c, fk, None, fk_entries[fk]()
 
1240
 
                        yield fp[1:], c, fk, None, TreeEntry()
 
1243
 
                if fk != 'directory':
 
1246
 
                # But do this child first if recursing down
 
1248
 
                    new_children = os.listdir(fap)
 
1250
 
                    new_children = collections.deque(new_children)
 
1251
 
                    stack.append((f_ie.file_id, fp, fap, new_children))
 
1252
 
                    # Break out of inner loop,
 
1253
 
                    # so that we start outer loop with child
 
1256
 
                # if we finished all children, pop it off the stack
 
1259
 
    @needs_tree_write_lock
 
1260
 
    def move(self, from_paths, to_dir=None, after=False, **kwargs):
 
 
789
        raise NotImplementedError(self.list_files)
 
 
791
    def move(self, from_paths, to_dir=None, after=False):
 
1261
792
        """Rename files.
 
1263
 
        to_dir must exist in the inventory.
 
 
794
        to_dir must be known to the working tree.
 
1265
796
        If to_dir exists and is a directory, the files are moved into
 
1266
797
        it, keeping their old names.
 
 
1292
822
        This returns a list of (from_path, to_path) pairs for each
 
1293
823
        entry that is moved.
 
1298
 
        # check for deprecated use of signature
 
1300
 
            to_dir = kwargs.get('to_name', None)
 
1302
 
                raise TypeError('You must supply a target directory')
 
1304
 
                symbol_versioning.warn('The parameter to_name was deprecated'
 
1305
 
                                       ' in version 0.13. Use to_dir instead',
 
1308
 
        # check destination directory
 
1309
 
        if isinstance(from_paths, basestring):
 
1311
 
        inv = self.inventory
 
1312
 
        to_abs = self.abspath(to_dir)
 
1313
 
        if not isdir(to_abs):
 
1314
 
            raise errors.BzrMoveFailedError('',to_dir,
 
1315
 
                errors.NotADirectory(to_abs))
 
1316
 
        if not self.has_filename(to_dir):
 
1317
 
            raise errors.BzrMoveFailedError('',to_dir,
 
1318
 
                errors.NotInWorkingDirectory(to_dir))
 
1319
 
        to_dir_id = inv.path2id(to_dir)
 
1320
 
        if to_dir_id is None:
 
1321
 
            raise errors.BzrMoveFailedError('',to_dir,
 
1322
 
                errors.NotVersionedError(path=str(to_dir)))
 
1324
 
        to_dir_ie = inv[to_dir_id]
 
1325
 
        if to_dir_ie.kind != 'directory':
 
1326
 
            raise errors.BzrMoveFailedError('',to_dir,
 
1327
 
                errors.NotADirectory(to_abs))
 
1329
 
        # create rename entries and tuples
 
1330
 
        for from_rel in from_paths:
 
1331
 
            from_tail = splitpath(from_rel)[-1]
 
1332
 
            from_id = inv.path2id(from_rel)
 
1334
 
                raise errors.BzrMoveFailedError(from_rel,to_dir,
 
1335
 
                    errors.NotVersionedError(path=str(from_rel)))
 
1337
 
            from_entry = inv[from_id]
 
1338
 
            from_parent_id = from_entry.parent_id
 
1339
 
            to_rel = pathjoin(to_dir, from_tail)
 
1340
 
            rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
 
1342
 
                                         from_tail=from_tail,
 
1343
 
                                         from_parent_id=from_parent_id,
 
1344
 
                                         to_rel=to_rel, to_tail=from_tail,
 
1345
 
                                         to_parent_id=to_dir_id)
 
1346
 
            rename_entries.append(rename_entry)
 
1347
 
            rename_tuples.append((from_rel, to_rel))
 
1349
 
        # determine which move mode to use. checks also for movability
 
1350
 
        rename_entries = self._determine_mv_mode(rename_entries, after)
 
1352
 
        original_modified = self._inventory_is_modified
 
1355
 
                self._inventory_is_modified = True
 
1356
 
            self._move(rename_entries)
 
1358
 
            # restore the inventory on error
 
1359
 
            self._inventory_is_modified = original_modified
 
1361
 
        self._write_inventory(inv)
 
1362
 
        return rename_tuples
 
1364
 
    def _determine_mv_mode(self, rename_entries, after=False):
 
1365
 
        """Determines for each from-to pair if both inventory and working tree
 
1366
 
        or only the inventory has to be changed.
 
1368
 
        Also does basic plausability tests.
 
1370
 
        inv = self.inventory
 
1372
 
        for rename_entry in rename_entries:
 
1373
 
            # store to local variables for easier reference
 
1374
 
            from_rel = rename_entry.from_rel
 
1375
 
            from_id = rename_entry.from_id
 
1376
 
            to_rel = rename_entry.to_rel
 
1377
 
            to_id = inv.path2id(to_rel)
 
1378
 
            only_change_inv = False
 
1380
 
            # check the inventory for source and destination
 
1382
 
                raise errors.BzrMoveFailedError(from_rel,to_rel,
 
1383
 
                    errors.NotVersionedError(path=str(from_rel)))
 
1384
 
            if to_id is not None:
 
1385
 
                raise errors.BzrMoveFailedError(from_rel,to_rel,
 
1386
 
                    errors.AlreadyVersionedError(path=str(to_rel)))
 
1388
 
            # try to determine the mode for rename (only change inv or change
 
1389
 
            # inv and file system)
 
1391
 
                if not self.has_filename(to_rel):
 
1392
 
                    raise errors.BzrMoveFailedError(from_id,to_rel,
 
1393
 
                        errors.NoSuchFile(path=str(to_rel),
 
1394
 
                        extra="New file has not been created yet"))
 
1395
 
                only_change_inv = True
 
1396
 
            elif not self.has_filename(from_rel) and self.has_filename(to_rel):
 
1397
 
                only_change_inv = True
 
1398
 
            elif self.has_filename(from_rel) and not self.has_filename(to_rel):
 
1399
 
                only_change_inv = False
 
1400
 
            elif (not self.case_sensitive
 
1401
 
                  and from_rel.lower() == to_rel.lower()
 
1402
 
                  and self.has_filename(from_rel)):
 
1403
 
                only_change_inv = False
 
1405
 
                # something is wrong, so lets determine what exactly
 
1406
 
                if not self.has_filename(from_rel) and \
 
1407
 
                   not self.has_filename(to_rel):
 
1408
 
                    raise errors.BzrRenameFailedError(from_rel,to_rel,
 
1409
 
                        errors.PathsDoNotExist(paths=(str(from_rel),
 
1412
 
                    raise errors.RenameFailedFilesExist(from_rel, to_rel)
 
1413
 
            rename_entry.only_change_inv = only_change_inv
 
1414
 
        return rename_entries
 
1416
 
    def _move(self, rename_entries):
 
1417
 
        """Moves a list of files.
 
1419
 
        Depending on the value of the flag 'only_change_inv', the
 
1420
 
        file will be moved on the file system or not.
 
1422
 
        inv = self.inventory
 
1425
 
        for entry in rename_entries:
 
1427
 
                self._move_entry(entry)
 
1429
 
                self._rollback_move(moved)
 
1433
 
    def _rollback_move(self, moved):
 
1434
 
        """Try to rollback a previous move in case of an filesystem error."""
 
1435
 
        inv = self.inventory
 
1438
 
                self._move_entry(WorkingTree._RenameEntry(
 
1439
 
                    entry.to_rel, entry.from_id,
 
1440
 
                    entry.to_tail, entry.to_parent_id, entry.from_rel,
 
1441
 
                    entry.from_tail, entry.from_parent_id,
 
1442
 
                    entry.only_change_inv))
 
1443
 
            except errors.BzrMoveFailedError, e:
 
1444
 
                raise errors.BzrMoveFailedError( '', '', "Rollback failed."
 
1445
 
                        " The working tree is in an inconsistent state."
 
1446
 
                        " Please consider doing a 'bzr revert'."
 
1447
 
                        " Error message is: %s" % e)
 
1449
 
    def _move_entry(self, entry):
 
1450
 
        inv = self.inventory
 
1451
 
        from_rel_abs = self.abspath(entry.from_rel)
 
1452
 
        to_rel_abs = self.abspath(entry.to_rel)
 
1453
 
        if from_rel_abs == to_rel_abs:
 
1454
 
            raise errors.BzrMoveFailedError(entry.from_rel, entry.to_rel,
 
1455
 
                "Source and target are identical.")
 
1457
 
        if not entry.only_change_inv:
 
1459
 
                osutils.rename(from_rel_abs, to_rel_abs)
 
1461
 
                raise errors.BzrMoveFailedError(entry.from_rel,
 
1463
 
        inv.rename(entry.from_id, entry.to_parent_id, entry.to_tail)
 
1465
 
    @needs_tree_write_lock
 
1466
 
    def rename_one(self, from_rel, to_rel, after=False):
 
1469
 
        This can change the directory or the filename or both.
 
1471
 
        rename_one has several 'modes' to work. First, it can rename a physical
 
1472
 
        file and change the file_id. That is the normal mode. Second, it can
 
1473
 
        only change the file_id without touching any physical file. This is
 
1474
 
        the new mode introduced in version 0.15.
 
1476
 
        rename_one uses the second mode if 'after == True' and 'to_rel' is not
 
1477
 
        versioned but present in the working tree.
 
1479
 
        rename_one uses the second mode if 'after == False' and 'from_rel' is
 
1480
 
        versioned but no longer in the working tree, and 'to_rel' is not
 
1481
 
        versioned but present in the working tree.
 
1483
 
        rename_one uses the first mode if 'after == False' and 'from_rel' is
 
1484
 
        versioned and present in the working tree, and 'to_rel' is not
 
1485
 
        versioned and not present in the working tree.
 
1487
 
        Everything else results in an error.
 
1489
 
        inv = self.inventory
 
1492
 
        # create rename entries and tuples
 
1493
 
        from_tail = splitpath(from_rel)[-1]
 
1494
 
        from_id = inv.path2id(from_rel)
 
1496
 
            # if file is missing in the inventory maybe it's in the basis_tree
 
1497
 
            basis_tree = self.branch.basis_tree()
 
1498
 
            from_id = basis_tree.path2id(from_rel)
 
1500
 
                raise errors.BzrRenameFailedError(from_rel,to_rel,
 
1501
 
                    errors.NotVersionedError(path=str(from_rel)))
 
1502
 
            # put entry back in the inventory so we can rename it
 
1503
 
            from_entry = basis_tree.inventory[from_id].copy()
 
1506
 
            from_entry = inv[from_id]
 
1507
 
        from_parent_id = from_entry.parent_id
 
1508
 
        to_dir, to_tail = os.path.split(to_rel)
 
1509
 
        to_dir_id = inv.path2id(to_dir)
 
1510
 
        rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
 
1512
 
                                     from_tail=from_tail,
 
1513
 
                                     from_parent_id=from_parent_id,
 
1514
 
                                     to_rel=to_rel, to_tail=to_tail,
 
1515
 
                                     to_parent_id=to_dir_id)
 
1516
 
        rename_entries.append(rename_entry)
 
1518
 
        # determine which move mode to use. checks also for movability
 
1519
 
        rename_entries = self._determine_mv_mode(rename_entries, after)
 
1521
 
        # check if the target changed directory and if the target directory is
 
1523
 
        if to_dir_id is None:
 
1524
 
            raise errors.BzrMoveFailedError(from_rel,to_rel,
 
1525
 
                errors.NotVersionedError(path=str(to_dir)))
 
1527
 
        # all checks done. now we can continue with our actual work
 
1528
 
        mutter('rename_one:\n'
 
1533
 
               '  to_dir_id {%s}\n',
 
1534
 
               from_id, from_rel, to_rel, to_dir, to_dir_id)
 
1536
 
        self._move(rename_entries)
 
1537
 
        self._write_inventory(inv)
 
1539
 
    class _RenameEntry(object):
 
1540
 
        def __init__(self, from_rel, from_id, from_tail, from_parent_id,
 
1541
 
                     to_rel, to_tail, to_parent_id, only_change_inv=False):
 
1542
 
            self.from_rel = from_rel
 
1543
 
            self.from_id = from_id
 
1544
 
            self.from_tail = from_tail
 
1545
 
            self.from_parent_id = from_parent_id
 
1546
 
            self.to_rel = to_rel
 
1547
 
            self.to_tail = to_tail
 
1548
 
            self.to_parent_id = to_parent_id
 
1549
 
            self.only_change_inv = only_change_inv
 
 
825
        raise NotImplementedError(self.move)
 
 
827
    def copy_one(self, from_rel, to_rel):
 
 
828
        """Copy a file in the tree to a new location.
 
 
830
        This default implementation just copies the file, then
 
 
833
        :param from_rel: From location (relative to tree root)
 
 
834
        :param to_rel: Target location (relative to tree root)
 
 
836
        shutil.copyfile(self.abspath(from_rel), self.abspath(to_rel))
 
1552
839
    def unknowns(self):
 
1553
840
        """Return all unknown files.
 
1555
842
        These are files in the working directory that are not versioned or
 
1556
843
        control files or ignored.
 
1558
 
        # force the extras method to be fully executed before returning, to
 
1559
 
        # prevent race conditions with the lock
 
1561
 
            [subp for subp in self.extras() if not self.is_ignored(subp)])
 
1563
 
    @needs_tree_write_lock
 
1564
 
    def unversion(self, file_ids):
 
1565
 
        """Remove the file ids in file_ids from the current versioned set.
 
1567
 
        When a file_id is unversioned, all of its children are automatically
 
 
845
        with self.lock_read():
 
 
846
            # force the extras method to be fully executed before returning, to
 
 
847
            # prevent race conditions with the lock
 
 
849
                [subp for subp in self.extras() if not self.is_ignored(subp)])
 
 
851
    def unversion(self, paths):
 
 
852
        """Remove the path in pahs from the current versioned set.
 
 
854
        When a path is unversioned, all of its children are automatically
 
1570
 
        :param file_ids: The file ids to stop versioning.
 
1571
 
        :raises: NoSuchId if any fileid is not currently versioned.
 
 
857
        :param paths: The paths to stop versioning.
 
 
858
        :raises NoSuchFile: if any path is not currently versioned.
 
1573
 
        for file_id in file_ids:
 
1574
 
            if file_id not in self._inventory:
 
1575
 
                raise errors.NoSuchId(self, file_id)
 
1576
 
        for file_id in file_ids:
 
1577
 
            if self._inventory.has_id(file_id):
 
1578
 
                self._inventory.remove_recursive_id(file_id)
 
1580
 
            # in the future this should just set a dirty bit to wait for the
 
1581
 
            # final unlock. However, until all methods of workingtree start
 
1582
 
            # with the current in -memory inventory rather than triggering
 
1583
 
            # a read, it is more complex - we need to teach read_inventory
 
1584
 
            # to know when to read, and when to not read first... and possibly
 
1585
 
            # to save first when the in memory one may be corrupted.
 
1586
 
            # so for now, we just only write it if it is indeed dirty.
 
1588
 
            self._write_inventory(self._inventory)
 
1590
 
    def _iter_conflicts(self):
 
1592
 
        for info in self.list_files():
 
1594
 
            stem = get_conflicted_stem(path)
 
1597
 
            if stem not in conflicted:
 
1598
 
                conflicted.add(stem)
 
 
860
        raise NotImplementedError(self.unversion)
 
1602
862
    def pull(self, source, overwrite=False, stop_revision=None,
 
1603
 
             change_reporter=None, possible_transports=None, local=False):
 
 
863
             change_reporter=None, possible_transports=None, local=False,
 
 
865
        with self.lock_write(), source.lock_read():
 
1606
866
            old_revision_info = self.branch.last_revision_info()
 
1607
867
            basis_tree = self.basis_tree()
 
1608
868
            count = self.branch.pull(source, overwrite, stop_revision,
 
 
1786
979
        return self._last_revision()
 
1789
981
    def _last_revision(self):
 
1790
982
        """helper for get_parent_ids."""
 
1791
 
        return _mod_revision.ensure_null(self.branch.last_revision())
 
 
983
        with self.lock_read():
 
 
984
            return _mod_revision.ensure_null(self.branch.last_revision())
 
1793
986
    def is_locked(self):
 
1794
 
        return self._control_files.is_locked()
 
1796
 
    def _must_be_locked(self):
 
1797
 
        if not self.is_locked():
 
1798
 
            raise errors.ObjectNotLocked(self)
 
 
987
        """Check if this tree is locked."""
 
 
988
        raise NotImplementedError(self.is_locked)
 
1800
990
    def lock_read(self):
 
1801
 
        """See Branch.lock_read, and WorkingTree.unlock."""
 
1802
 
        if not self.is_locked():
 
1804
 
        self.branch.lock_read()
 
1806
 
            return self._control_files.lock_read()
 
1808
 
            self.branch.unlock()
 
 
991
        """Lock the tree for reading.
 
 
993
        This also locks the branch, and can be unlocked via self.unlock().
 
 
995
        :return: A breezy.lock.LogicalLockResult.
 
 
997
        raise NotImplementedError(self.lock_read)
 
1811
999
    def lock_tree_write(self):
 
1812
 
        """See MutableTree.lock_tree_write, and WorkingTree.unlock."""
 
1813
 
        if not self.is_locked():
 
1815
 
        self.branch.lock_read()
 
1817
 
            return self._control_files.lock_write()
 
1819
 
            self.branch.unlock()
 
 
1000
        """See MutableTree.lock_tree_write, and WorkingTree.unlock.
 
 
1002
        :return: A breezy.lock.LogicalLockResult.
 
 
1004
        raise NotImplementedError(self.lock_tree_write)
 
1822
1006
    def lock_write(self):
 
1823
 
        """See MutableTree.lock_write, and WorkingTree.unlock."""
 
1824
 
        if not self.is_locked():
 
1826
 
        self.branch.lock_write()
 
1828
 
            return self._control_files.lock_write()
 
1830
 
            self.branch.unlock()
 
 
1007
        """See MutableTree.lock_write, and WorkingTree.unlock.
 
 
1009
        :return: A breezy.lock.LogicalLockResult.
 
 
1011
        raise NotImplementedError(self.lock_write)
 
1833
1013
    def get_physical_lock_status(self):
 
1834
 
        return self._control_files.get_physical_lock_status()
 
1836
 
    def _basis_inventory_name(self):
 
1837
 
        return 'basis-inventory-cache'
 
1839
 
    def _reset_data(self):
 
1840
 
        """Reset transient data that cannot be revalidated."""
 
1841
 
        self._inventory_is_modified = False
 
1842
 
        f = self._transport.get('inventory')
 
1844
 
            result = self._deserialize(f)
 
1847
 
        self._set_inventory(result, dirty=False)
 
1849
 
    @needs_tree_write_lock
 
 
1014
        raise NotImplementedError(self.get_physical_lock_status)
 
1850
1016
    def set_last_revision(self, new_revision):
 
1851
1017
        """Change the last revision in the working tree."""
 
1852
 
        if self._change_last_revision(new_revision):
 
1853
 
            self._cache_basis_inventory(new_revision)
 
 
1018
        raise NotImplementedError(self.set_last_revision)
 
1855
1020
    def _change_last_revision(self, new_revision):
 
1856
1021
        """Template method part of set_last_revision to perform the change.
 
 
1859
1024
        when their last revision is set.
 
1861
1026
        if _mod_revision.is_null(new_revision):
 
1862
 
            self.branch.set_revision_history([])
 
 
1027
            self.branch.set_last_revision_info(0, new_revision)
 
 
1029
        _mod_revision.check_not_reserved_id(new_revision)
 
1865
1031
            self.branch.generate_revision_history(new_revision)
 
1866
1032
        except errors.NoSuchRevision:
 
1867
1033
            # not present in the repo - dont try to set it deeper than the tip
 
1868
 
            self.branch.set_revision_history([new_revision])
 
 
1034
            self.branch._set_revision_history([new_revision])
 
1871
 
    def _write_basis_inventory(self, xml):
 
1872
 
        """Write the basis inventory XML to the basis-inventory file"""
 
1873
 
        path = self._basis_inventory_name()
 
1875
 
        self._transport.put_file(path, sio,
 
1876
 
            mode=self.bzrdir._get_file_mode())
 
1878
 
    def _create_basis_xml_from_inventory(self, revision_id, inventory):
 
1879
 
        """Create the text that will be saved in basis-inventory"""
 
1880
 
        inventory.revision_id = revision_id
 
1881
 
        return xml7.serializer_v7.write_inventory_to_string(inventory)
 
1883
 
    def _cache_basis_inventory(self, new_revision):
 
1884
 
        """Cache new_revision as the basis inventory."""
 
1885
 
        # TODO: this should allow the ready-to-use inventory to be passed in,
 
1886
 
        # as commit already has that ready-to-use [while the format is the
 
1889
 
            # this double handles the inventory - unpack and repack -
 
1890
 
            # but is easier to understand. We can/should put a conditional
 
1891
 
            # in here based on whether the inventory is in the latest format
 
1892
 
            # - perhaps we should repack all inventories on a repository
 
1894
 
            # the fast path is to copy the raw xml from the repository. If the
 
1895
 
            # xml contains 'revision_id="', then we assume the right
 
1896
 
            # revision_id is set. We must check for this full string, because a
 
1897
 
            # root node id can legitimately look like 'revision_id' but cannot
 
1899
 
            xml = self.branch.repository._get_inventory_xml(new_revision)
 
1900
 
            firstline = xml.split('\n', 1)[0]
 
1901
 
            if (not 'revision_id="' in firstline or
 
1902
 
                'format="7"' not in firstline):
 
1903
 
                inv = self.branch.repository._serializer.read_inventory_from_string(
 
1905
 
                xml = self._create_basis_xml_from_inventory(new_revision, inv)
 
1906
 
            self._write_basis_inventory(xml)
 
1907
 
        except (errors.NoSuchRevision, errors.RevisionNotPresent):
 
1910
 
    def read_basis_inventory(self):
 
1911
 
        """Read the cached basis inventory."""
 
1912
 
        path = self._basis_inventory_name()
 
1913
 
        return self._transport.get_bytes(path)
 
1916
 
    def read_working_inventory(self):
 
1917
 
        """Read the working inventory.
 
1919
 
        :raises errors.InventoryModified: read_working_inventory will fail
 
1920
 
            when the current in memory inventory has been modified.
 
1922
 
        # conceptually this should be an implementation detail of the tree.
 
1923
 
        # XXX: Deprecate this.
 
1924
 
        # ElementTree does its own conversion from UTF-8, so open in
 
1926
 
        if self._inventory_is_modified:
 
1927
 
            raise errors.InventoryModified(self)
 
1928
 
        f = self._transport.get('inventory')
 
1930
 
            result = self._deserialize(f)
 
1933
 
        self._set_inventory(result, dirty=False)
 
1936
 
    @needs_tree_write_lock
 
1937
1037
    def remove(self, files, verbose=False, to_file=None, keep_files=True,
 
1939
 
        """Remove nominated files from the working inventory.
 
 
1039
        """Remove nominated files from the working tree metadata.
 
1941
1041
        :files: File paths relative to the basedir.
 
1942
1042
        :keep_files: If true, the files will also be kept.
 
1943
1043
        :force: Delete files and directories, even if they are changed and
 
1944
1044
            even if the directories are not empty.
 
1946
 
        if isinstance(files, basestring):
 
1952
 
        unknown_nested_files=set()
 
1954
 
            to_file = sys.stdout
 
1956
 
        def recurse_directory_to_add_files(directory):
 
1957
 
            # Recurse directory and add all files
 
1958
 
            # so we can check if they have changed.
 
1959
 
            for parent_info, file_infos in\
 
1960
 
                self.walkdirs(directory):
 
1961
 
                for relpath, basename, kind, lstat, fileid, kind in file_infos:
 
1962
 
                    # Is it versioned or ignored?
 
1963
 
                    if self.path2id(relpath) or self.is_ignored(relpath):
 
1964
 
                        # Add nested content for deletion.
 
1965
 
                        new_files.add(relpath)
 
1967
 
                        # Files which are not versioned and not ignored
 
1968
 
                        # should be treated as unknown.
 
1969
 
                        unknown_nested_files.add((relpath, None, kind))
 
1971
 
        for filename in files:
 
1972
 
            # Get file name into canonical form.
 
1973
 
            abspath = self.abspath(filename)
 
1974
 
            filename = self.relpath(abspath)
 
1975
 
            if len(filename) > 0:
 
1976
 
                new_files.add(filename)
 
1977
 
                recurse_directory_to_add_files(filename)
 
1979
 
        files = list(new_files)
 
1982
 
            return # nothing to do
 
1984
 
        # Sort needed to first handle directory content before the directory
 
1985
 
        files.sort(reverse=True)
 
1987
 
        # Bail out if we are going to delete files we shouldn't
 
1988
 
        if not keep_files and not force:
 
1989
 
            has_changed_files = len(unknown_nested_files) > 0
 
1990
 
            if not has_changed_files:
 
1991
 
                for (file_id, path, content_change, versioned, parent_id, name,
 
1992
 
                     kind, executable) in self.iter_changes(self.basis_tree(),
 
1993
 
                         include_unchanged=True, require_versioned=False,
 
1994
 
                         want_unversioned=True, specific_files=files):
 
1995
 
                    if versioned == (False, False):
 
1996
 
                        # The record is unknown ...
 
1997
 
                        if not self.is_ignored(path[1]):
 
1998
 
                            # ... but not ignored
 
1999
 
                            has_changed_files = True
 
2001
 
                    elif content_change and (kind[1] is not None):
 
2002
 
                        # Versioned and changed, but not deleted
 
2003
 
                        has_changed_files = True
 
2006
 
            if has_changed_files:
 
2007
 
                # Make delta show ALL applicable changes in error message.
 
2008
 
                tree_delta = self.changes_from(self.basis_tree(),
 
2009
 
                    require_versioned=False, want_unversioned=True,
 
2010
 
                    specific_files=files)
 
2011
 
                for unknown_file in unknown_nested_files:
 
2012
 
                    if unknown_file not in tree_delta.unversioned:
 
2013
 
                        tree_delta.unversioned.extend((unknown_file,))
 
2014
 
                raise errors.BzrRemoveChangedFilesError(tree_delta)
 
2016
 
        # Build inv_delta and delete files where applicable,
 
2017
 
        # do this before any modifications to inventory.
 
2019
 
            fid = self.path2id(f)
 
2022
 
                message = "%s is not versioned." % (f,)
 
2025
 
                    # having removed it, it must be either ignored or unknown
 
2026
 
                    if self.is_ignored(f):
 
2030
 
                    # XXX: Really should be a more abstract reporter interface
 
2031
 
                    kind_ch = osutils.kind_marker(self.kind(fid))
 
2032
 
                    to_file.write(new_status + '       ' + f + kind_ch + '\n')
 
2034
 
                inv_delta.append((f, None, fid, None))
 
2035
 
                message = "removed %s" % (f,)
 
2038
 
                abs_path = self.abspath(f)
 
2039
 
                if osutils.lexists(abs_path):
 
2040
 
                    if (osutils.isdir(abs_path) and
 
2041
 
                        len(os.listdir(abs_path)) > 0):
 
2043
 
                            osutils.rmtree(abs_path)
 
2045
 
                            message = "%s is not an empty directory "\
 
2046
 
                                "and won't be deleted." % (f,)
 
2048
 
                        osutils.delete_any(abs_path)
 
2049
 
                        message = "deleted %s" % (f,)
 
2050
 
                elif message is not None:
 
2051
 
                    # Only care if we haven't done anything yet.
 
2052
 
                    message = "%s does not exist." % (f,)
 
2054
 
            # Print only one message (if any) per file.
 
2055
 
            if message is not None:
 
2057
 
        self.apply_inventory_delta(inv_delta)
 
2059
 
    @needs_tree_write_lock
 
 
1046
        raise NotImplementedError(self.remove)
 
2060
1048
    def revert(self, filenames=None, old_tree=None, backups=True,
 
2061
1049
               pb=None, report_changes=False):
 
2062
 
        from bzrlib.conflicts import resolve
 
2065
 
            symbol_versioning.warn('Using [] to revert all files is deprecated'
 
2066
 
                ' as of bzr 0.91.  Please use None (the default) instead.',
 
2067
 
                DeprecationWarning, stacklevel=2)
 
2068
 
        if old_tree is None:
 
2069
 
            basis_tree = self.basis_tree()
 
2070
 
            basis_tree.lock_read()
 
2071
 
            old_tree = basis_tree
 
2075
 
            conflicts = transform.revert(self, old_tree, filenames, backups, pb,
 
2077
 
            if filenames is None and len(self.get_parent_ids()) > 1:
 
2079
 
                last_revision = self.last_revision()
 
2080
 
                if last_revision != _mod_revision.NULL_REVISION:
 
2081
 
                    if basis_tree is None:
 
2082
 
                        basis_tree = self.basis_tree()
 
2083
 
                        basis_tree.lock_read()
 
2084
 
                    parent_trees.append((last_revision, basis_tree))
 
2085
 
                self.set_parent_trees(parent_trees)
 
 
1050
        from .conflicts import resolve
 
 
1051
        with self.lock_tree_write():
 
 
1052
            if old_tree is None:
 
 
1053
                basis_tree = self.basis_tree()
 
 
1054
                basis_tree.lock_read()
 
 
1055
                old_tree = basis_tree
 
2088
 
                resolve(self, filenames, ignore_misses=True, recursive=True)
 
2090
 
            if basis_tree is not None:
 
 
1059
                conflicts = transform.revert(self, old_tree, filenames, backups, pb,
 
 
1061
                if filenames is None and len(self.get_parent_ids()) > 1:
 
 
1063
                    last_revision = self.last_revision()
 
 
1064
                    if last_revision != _mod_revision.NULL_REVISION:
 
 
1065
                        if basis_tree is None:
 
 
1066
                            basis_tree = self.basis_tree()
 
 
1067
                            basis_tree.lock_read()
 
 
1068
                        parent_trees.append((last_revision, basis_tree))
 
 
1069
                    self.set_parent_trees(parent_trees)
 
 
1072
                    resolve(self, filenames, ignore_misses=True, recursive=True)
 
 
1074
                if basis_tree is not None:
 
 
1078
    def store_uncommitted(self):
 
 
1079
        """Store uncommitted changes from the tree in the branch."""
 
 
1080
        raise NotImplementedError(self.store_uncommitted)
 
 
1082
    def restore_uncommitted(self):
 
 
1083
        """Restore uncommitted changes from the branch into the tree."""
 
 
1084
        raise NotImplementedError(self.restore_uncommitted)
 
2094
1086
    def revision_tree(self, revision_id):
 
2095
1087
        """See Tree.revision_tree.
 
2097
 
        WorkingTree can supply revision_trees for the basis revision only
 
2098
 
        because there is only one cached inventory in the bzr directory.
 
 
1089
        For trees that can be obtained from the working tree, this
 
 
1090
        will do so. For other trees, it will fall back to the repository.
 
2100
 
        if revision_id == self.last_revision():
 
2102
 
                xml = self.read_basis_inventory()
 
2103
 
            except errors.NoSuchFile:
 
2107
 
                    inv = xml7.serializer_v7.read_inventory_from_string(xml)
 
2108
 
                    # dont use the repository revision_tree api because we want
 
2109
 
                    # to supply the inventory.
 
2110
 
                    if inv.revision_id == revision_id:
 
2111
 
                        return revisiontree.RevisionTree(self.branch.repository,
 
2113
 
                except errors.BadInventoryFormat:
 
2115
 
        # raise if there was no inventory, or if we read the wrong inventory.
 
2116
 
        raise errors.NoSuchRevisionInTree(self, revision_id)
 
2118
 
    # XXX: This method should be deprecated in favour of taking in a proper
 
2119
 
    # new Inventory object.
 
2120
 
    @needs_tree_write_lock
 
2121
 
    def set_inventory(self, new_inventory_list):
 
2122
 
        from bzrlib.inventory import (Inventory,
 
2126
 
        inv = Inventory(self.get_root_id())
 
2127
 
        for path, file_id, parent, kind in new_inventory_list:
 
2128
 
            name = os.path.basename(path)
 
2131
 
            # fixme, there should be a factory function inv,add_??
 
2132
 
            if kind == 'directory':
 
2133
 
                inv.add(InventoryDirectory(file_id, name, parent))
 
2134
 
            elif kind == 'file':
 
2135
 
                inv.add(InventoryFile(file_id, name, parent))
 
2136
 
            elif kind == 'symlink':
 
2137
 
                inv.add(InventoryLink(file_id, name, parent))
 
2139
 
                raise errors.BzrError("unknown kind %r" % kind)
 
2140
 
        self._write_inventory(inv)
 
2142
 
    @needs_tree_write_lock
 
 
1092
        raise NotImplementedError(self.revision_tree)
 
2143
1094
    def set_root_id(self, file_id):
 
2144
1095
        """Set the root id for this tree."""
 
2148
 
                'WorkingTree.set_root_id with fileid=None')
 
2149
 
        file_id = osutils.safe_file_id(file_id)
 
2150
 
        self._set_root_id(file_id)
 
 
1096
        if not self.supports_setting_file_ids():
 
 
1097
            raise SettingFileIdUnsupported()
 
 
1098
        with self.lock_tree_write():
 
 
1102
                    'WorkingTree.set_root_id with fileid=None')
 
 
1103
            file_id = osutils.safe_file_id(file_id)
 
 
1104
            self._set_root_id(file_id)
 
2152
1106
    def _set_root_id(self, file_id):
 
2153
1107
        """Set the root id for this tree, in a format specific manner.
 
 
2253
1191
        # We MUST save it even if an error occurs, because otherwise the users
 
2254
1192
        # local work is unreferenced and will appear to have been lost.
 
2258
 
            last_rev = self.get_parent_ids()[0]
 
2260
 
            last_rev = _mod_revision.NULL_REVISION
 
2261
 
        if revision is None:
 
2262
 
            revision = self.branch.last_revision()
 
2264
 
        old_tip = old_tip or _mod_revision.NULL_REVISION
 
2266
 
        if not _mod_revision.is_null(old_tip) and old_tip != last_rev:
 
2267
 
            # the branch we are bound to was updated
 
2268
 
            # merge those changes in first
 
2269
 
            base_tree  = self.basis_tree()
 
2270
 
            other_tree = self.branch.repository.revision_tree(old_tip)
 
2271
 
            nb_conflicts = merge.merge_inner(self.branch, other_tree,
 
2272
 
                                             base_tree, this_tree=self,
 
2273
 
                                             change_reporter=change_reporter)
 
2275
 
                self.add_parent_tree((old_tip, other_tree))
 
2276
 
                trace.note('Rerun update after fixing the conflicts.')
 
2279
 
        if last_rev != _mod_revision.ensure_null(revision):
 
2280
 
            # the working tree is up to date with the branch
 
2281
 
            # we can merge the specified revision from master
 
2282
 
            to_tree = self.branch.repository.revision_tree(revision)
 
2283
 
            to_root_id = to_tree.get_root_id()
 
2285
 
            basis = self.basis_tree()
 
2288
 
                if (basis.inventory.root is None
 
2289
 
                    or basis.inventory.root.file_id != to_root_id):
 
2290
 
                    self.set_root_id(to_root_id)
 
2295
 
            # determine the branch point
 
2296
 
            graph = self.branch.repository.get_graph()
 
2297
 
            base_rev_id = graph.find_unique_lca(self.branch.last_revision(),
 
2299
 
            base_tree = self.branch.repository.revision_tree(base_rev_id)
 
2301
 
            nb_conflicts = merge.merge_inner(self.branch, to_tree, base_tree,
 
2303
 
                                             change_reporter=change_reporter)
 
2304
 
            self.set_last_revision(revision)
 
2305
 
            # TODO - dedup parents list with things merged by pull ?
 
2306
 
            # reuse the tree we've updated to to set the basis:
 
2307
 
            parent_trees = [(revision, to_tree)]
 
2308
 
            merges = self.get_parent_ids()[1:]
 
2309
 
            # Ideally we ask the tree for the trees here, that way the working
 
2310
 
            # tree can decide whether to give us the entire tree or give us a
 
2311
 
            # lazy initialised tree. dirstate for instance will have the trees
 
2312
 
            # in ram already, whereas a last-revision + basis-inventory tree
 
2313
 
            # will not, but also does not need them when setting parents.
 
2314
 
            for parent in merges:
 
2315
 
                parent_trees.append(
 
2316
 
                    (parent, self.branch.repository.revision_tree(parent)))
 
2317
 
            if not _mod_revision.is_null(old_tip):
 
2318
 
                parent_trees.append(
 
2319
 
                    (old_tip, self.branch.repository.revision_tree(old_tip)))
 
2320
 
            self.set_parent_trees(parent_trees)
 
2321
 
            last_rev = parent_trees[0][0]
 
2324
 
    def _write_hashcache_if_dirty(self):
 
2325
 
        """Write out the hashcache if it is dirty."""
 
2326
 
        if self._hashcache.needs_write:
 
2328
 
                self._hashcache.write()
 
2330
 
                if e.errno not in (errno.EPERM, errno.EACCES):
 
2332
 
                # TODO: jam 20061219 Should this be a warning? A single line
 
2333
 
                #       warning might be sufficient to let the user know what
 
2335
 
                mutter('Could not write hashcache for %s\nError: %s',
 
2336
 
                       self._hashcache.cache_file_name(), e)
 
2338
 
    @needs_tree_write_lock
 
2339
 
    def _write_inventory(self, inv):
 
2340
 
        """Write inventory as the current inventory."""
 
2341
 
        self._set_inventory(inv, dirty=True)
 
 
1194
        with self.lock_tree_write():
 
 
1197
                last_rev = self.get_parent_ids()[0]
 
 
1199
                last_rev = _mod_revision.NULL_REVISION
 
 
1200
            if revision is None:
 
 
1201
                revision = self.branch.last_revision()
 
 
1203
            old_tip = old_tip or _mod_revision.NULL_REVISION
 
 
1205
            if not _mod_revision.is_null(old_tip) and old_tip != last_rev:
 
 
1206
                # the branch we are bound to was updated
 
 
1207
                # merge those changes in first
 
 
1208
                base_tree  = self.basis_tree()
 
 
1209
                other_tree = self.branch.repository.revision_tree(old_tip)
 
 
1210
                nb_conflicts = merge.merge_inner(self.branch, other_tree,
 
 
1211
                                                 base_tree, this_tree=self,
 
 
1212
                                                 change_reporter=change_reporter,
 
 
1213
                                                 show_base=show_base)
 
 
1215
                    self.add_parent_tree((old_tip, other_tree))
 
 
1216
                    note(gettext('Rerun update after fixing the conflicts.'))
 
 
1219
            if last_rev != _mod_revision.ensure_null(revision):
 
 
1220
                # the working tree is up to date with the branch
 
 
1221
                # we can merge the specified revision from master
 
 
1222
                to_tree = self.branch.repository.revision_tree(revision)
 
 
1223
                to_root_id = to_tree.get_root_id()
 
 
1225
                basis = self.basis_tree()
 
 
1226
                with basis.lock_read():
 
 
1227
                    if (basis.get_root_id() is None or basis.get_root_id() != to_root_id):
 
 
1228
                        self.set_root_id(to_root_id)
 
 
1231
                # determine the branch point
 
 
1232
                graph = self.branch.repository.get_graph()
 
 
1233
                base_rev_id = graph.find_unique_lca(self.branch.last_revision(),
 
 
1235
                base_tree = self.branch.repository.revision_tree(base_rev_id)
 
 
1237
                nb_conflicts = merge.merge_inner(self.branch, to_tree, base_tree,
 
 
1239
                                                 change_reporter=change_reporter,
 
 
1240
                                                 show_base=show_base)
 
 
1241
                self.set_last_revision(revision)
 
 
1242
                # TODO - dedup parents list with things merged by pull ?
 
 
1243
                # reuse the tree we've updated to to set the basis:
 
 
1244
                parent_trees = [(revision, to_tree)]
 
 
1245
                merges = self.get_parent_ids()[1:]
 
 
1246
                # Ideally we ask the tree for the trees here, that way the working
 
 
1247
                # tree can decide whether to give us the entire tree or give us a
 
 
1248
                # lazy initialised tree. dirstate for instance will have the trees
 
 
1249
                # in ram already, whereas a last-revision + basis-inventory tree
 
 
1250
                # will not, but also does not need them when setting parents.
 
 
1251
                for parent in merges:
 
 
1252
                    parent_trees.append(
 
 
1253
                        (parent, self.branch.repository.revision_tree(parent)))
 
 
1254
                if not _mod_revision.is_null(old_tip):
 
 
1255
                    parent_trees.append(
 
 
1256
                        (old_tip, self.branch.repository.revision_tree(old_tip)))
 
 
1257
                self.set_parent_trees(parent_trees)
 
 
1258
                last_rev = parent_trees[0][0]
 
2344
1261
    def set_conflicts(self, arg):
 
2345
1262
        raise errors.UnsupportedOperation(self.set_conflicts, self)
 
 
2387
1281
        If the tree is not locked, it may cause an error to be raised,
 
2388
1282
        depending on the tree implementation.
 
2390
 
        disk_top = self.abspath(prefix)
 
2391
 
        if disk_top.endswith('/'):
 
2392
 
            disk_top = disk_top[:-1]
 
2393
 
        top_strip_len = len(disk_top) + 1
 
2394
 
        inventory_iterator = self._walkdirs(prefix)
 
2395
 
        disk_iterator = osutils.walkdirs(disk_top, prefix)
 
2397
 
            current_disk = disk_iterator.next()
 
2398
 
            disk_finished = False
 
2400
 
            if not (e.errno == errno.ENOENT or
 
2401
 
                (sys.platform == 'win32' and e.errno == ERROR_PATH_NOT_FOUND)):
 
2404
 
            disk_finished = True
 
2406
 
            current_inv = inventory_iterator.next()
 
2407
 
            inv_finished = False
 
2408
 
        except StopIteration:
 
2411
 
        while not inv_finished or not disk_finished:
 
2413
 
                ((cur_disk_dir_relpath, cur_disk_dir_path_from_top),
 
2414
 
                    cur_disk_dir_content) = current_disk
 
2416
 
                ((cur_disk_dir_relpath, cur_disk_dir_path_from_top),
 
2417
 
                    cur_disk_dir_content) = ((None, None), None)
 
2418
 
            if not disk_finished:
 
2419
 
                # strip out .bzr dirs
 
2420
 
                if (cur_disk_dir_path_from_top[top_strip_len:] == '' and
 
2421
 
                    len(cur_disk_dir_content) > 0):
 
2422
 
                    # osutils.walkdirs can be made nicer -
 
2423
 
                    # yield the path-from-prefix rather than the pathjoined
 
2425
 
                    bzrdir_loc = bisect_left(cur_disk_dir_content,
 
2427
 
                    if (bzrdir_loc < len(cur_disk_dir_content)
 
2428
 
                        and self.bzrdir.is_control_filename(
 
2429
 
                            cur_disk_dir_content[bzrdir_loc][0])):
 
2430
 
                        # we dont yield the contents of, or, .bzr itself.
 
2431
 
                        del cur_disk_dir_content[bzrdir_loc]
 
2433
 
                # everything is unknown
 
2436
 
                # everything is missing
 
2439
 
                direction = cmp(current_inv[0][0], cur_disk_dir_relpath)
 
2441
 
                # disk is before inventory - unknown
 
2442
 
                dirblock = [(relpath, basename, kind, stat, None, None) for
 
2443
 
                    relpath, basename, kind, stat, top_path in
 
2444
 
                    cur_disk_dir_content]
 
2445
 
                yield (cur_disk_dir_relpath, None), dirblock
 
2447
 
                    current_disk = disk_iterator.next()
 
2448
 
                except StopIteration:
 
2449
 
                    disk_finished = True
 
2451
 
                # inventory is before disk - missing.
 
2452
 
                dirblock = [(relpath, basename, 'unknown', None, fileid, kind)
 
2453
 
                    for relpath, basename, dkind, stat, fileid, kind in
 
2455
 
                yield (current_inv[0][0], current_inv[0][1]), dirblock
 
2457
 
                    current_inv = inventory_iterator.next()
 
2458
 
                except StopIteration:
 
2461
 
                # versioned present directory
 
2462
 
                # merge the inventory and disk data together
 
2464
 
                for relpath, subiterator in itertools.groupby(sorted(
 
2465
 
                    current_inv[1] + cur_disk_dir_content,
 
2466
 
                    key=operator.itemgetter(0)), operator.itemgetter(1)):
 
2467
 
                    path_elements = list(subiterator)
 
2468
 
                    if len(path_elements) == 2:
 
2469
 
                        inv_row, disk_row = path_elements
 
2470
 
                        # versioned, present file
 
2471
 
                        dirblock.append((inv_row[0],
 
2472
 
                            inv_row[1], disk_row[2],
 
2473
 
                            disk_row[3], inv_row[4],
 
2475
 
                    elif len(path_elements[0]) == 5:
 
2477
 
                        dirblock.append((path_elements[0][0],
 
2478
 
                            path_elements[0][1], path_elements[0][2],
 
2479
 
                            path_elements[0][3], None, None))
 
2480
 
                    elif len(path_elements[0]) == 6:
 
2481
 
                        # versioned, absent file.
 
2482
 
                        dirblock.append((path_elements[0][0],
 
2483
 
                            path_elements[0][1], 'unknown', None,
 
2484
 
                            path_elements[0][4], path_elements[0][5]))
 
2486
 
                        raise NotImplementedError('unreachable code')
 
2487
 
                yield current_inv[0], dirblock
 
2489
 
                    current_inv = inventory_iterator.next()
 
2490
 
                except StopIteration:
 
2493
 
                    current_disk = disk_iterator.next()
 
2494
 
                except StopIteration:
 
2495
 
                    disk_finished = True
 
2497
 
    def _walkdirs(self, prefix=""):
 
2498
 
        """Walk the directories of this tree.
 
2500
 
           :prefix: is used as the directrory to start with.
 
2501
 
           returns a generator which yields items in the form:
 
2502
 
                ((curren_directory_path, fileid),
 
2503
 
                 [(file1_path, file1_name, file1_kind, None, file1_id,
 
2506
 
        _directory = 'directory'
 
2507
 
        # get the root in the inventory
 
2508
 
        inv = self.inventory
 
2509
 
        top_id = inv.path2id(prefix)
 
2513
 
            pending = [(prefix, '', _directory, None, top_id, None)]
 
2516
 
            currentdir = pending.pop()
 
2517
 
            # 0 - relpath, 1- basename, 2- kind, 3- stat, 4-id, 5-kind
 
2518
 
            top_id = currentdir[4]
 
2520
 
                relroot = currentdir[0] + '/'
 
2523
 
            # FIXME: stash the node in pending
 
2525
 
            if entry.kind == 'directory':
 
2526
 
                for name, child in entry.sorted_children():
 
2527
 
                    dirblock.append((relroot + name, name, child.kind, None,
 
2528
 
                        child.file_id, child.kind
 
2530
 
            yield (currentdir[0], entry.file_id), dirblock
 
2531
 
            # push the user specified dirs from dirblock
 
2532
 
            for dir in reversed(dirblock):
 
2533
 
                if dir[2] == _directory:
 
2536
 
    @needs_tree_write_lock
 
 
1284
        raise NotImplementedError(self.walkdirs)
 
2537
1286
    def auto_resolve(self):
 
2538
1287
        """Automatically resolve text conflicts according to contents.
 
 
2541
1290
        are considered 'resolved', because bzr always puts conflict markers
 
2542
1291
        into files that have text conflicts.  The corresponding .THIS .BASE and
 
2543
1292
        .OTHER files are deleted, as per 'resolve'.
 
2544
1294
        :return: a tuple of ConflictLists: (un_resolved, resolved).
 
2546
 
        un_resolved = _mod_conflicts.ConflictList()
 
2547
 
        resolved = _mod_conflicts.ConflictList()
 
2548
 
        conflict_re = re.compile('^(<{7}|={7}|>{7})')
 
2549
 
        for conflict in self.conflicts():
 
2550
 
            if (conflict.typestring != 'text conflict' or
 
2551
 
                self.kind(conflict.file_id) != 'file'):
 
2552
 
                un_resolved.append(conflict)
 
2554
 
            my_file = open(self.id2abspath(conflict.file_id), 'rb')
 
2556
 
                for line in my_file:
 
2557
 
                    if conflict_re.search(line):
 
2558
 
                        un_resolved.append(conflict)
 
2561
 
                    resolved.append(conflict)
 
2564
 
        resolved.remove_files(self)
 
2565
 
        self.set_conflicts(un_resolved)
 
2566
 
        return un_resolved, resolved
 
2569
 
    def _check(self, references):
 
2570
 
        """Check the tree for consistency.
 
2572
 
        :param references: A dict with keys matching the items returned by
 
2573
 
            self._get_check_refs(), and values from looking those keys up in
 
2576
 
        tree_basis = self.basis_tree()
 
2577
 
        tree_basis.lock_read()
 
2579
 
            repo_basis = references[('trees', self.last_revision())]
 
2580
 
            if len(list(repo_basis.iter_changes(tree_basis))) > 0:
 
2581
 
                raise errors.BzrCheckError(
 
2582
 
                    "Mismatched basis inventory content.")
 
 
1296
        with self.lock_tree_write():
 
 
1297
            un_resolved = _mod_conflicts.ConflictList()
 
 
1298
            resolved = _mod_conflicts.ConflictList()
 
 
1299
            conflict_re = re.compile('^(<{7}|={7}|>{7})')
 
 
1300
            for conflict in self.conflicts():
 
 
1301
                if (conflict.typestring != 'text conflict' or
 
 
1302
                    self.kind(self.id2path(conflict.file_id), conflict.file_id) != 'file'):
 
 
1303
                    un_resolved.append(conflict)
 
 
1305
                my_file = open(self.id2abspath(conflict.file_id), 'rb')
 
 
1307
                    for line in my_file:
 
 
1308
                        if conflict_re.search(line):
 
 
1309
                            un_resolved.append(conflict)
 
 
1312
                        resolved.append(conflict)
 
 
1315
            resolved.remove_files(self)
 
 
1316
            self.set_conflicts(un_resolved)
 
 
1317
            return un_resolved, resolved
 
2587
1319
    def _validate(self):
 
2588
1320
        """Validate internal structures.
 
 
2605
1349
    def get_shelf_manager(self):
 
2606
1350
        """Return the ShelfManager for this WorkingTree."""
 
2607
 
        from bzrlib.shelf import ShelfManager
 
2608
 
        return ShelfManager(self, self._transport)
 
2611
 
class WorkingTree2(WorkingTree):
 
2612
 
    """This is the Format 2 working tree.
 
2614
 
    This was the first weave based working tree.
 
2615
 
     - uses os locks for locking.
 
2616
 
     - uses the branch last-revision.
 
2619
 
    def __init__(self, *args, **kwargs):
 
2620
 
        super(WorkingTree2, self).__init__(*args, **kwargs)
 
2621
 
        # WorkingTree2 has more of a constraint that self._inventory must
 
2622
 
        # exist. Because this is an older format, we don't mind the overhead
 
2623
 
        # caused by the extra computation here.
 
2625
 
        # Newer WorkingTree's should only have self._inventory set when they
 
2627
 
        if self._inventory is None:
 
2628
 
            self.read_working_inventory()
 
2630
 
    def _get_check_refs(self):
 
2631
 
        """Return the references needed to perform a check of this tree."""
 
2632
 
        return [('trees', self.last_revision())]
 
2634
 
    def lock_tree_write(self):
 
2635
 
        """See WorkingTree.lock_tree_write().
 
2637
 
        In Format2 WorkingTrees we have a single lock for the branch and tree
 
2638
 
        so lock_tree_write() degrades to lock_write().
 
2640
 
        self.branch.lock_write()
 
2642
 
            return self._control_files.lock_write()
 
2644
 
            self.branch.unlock()
 
2648
 
        # do non-implementation specific cleanup
 
2651
 
        # we share control files:
 
2652
 
        if self._control_files._lock_count == 3:
 
2653
 
            # _inventory_is_modified is always False during a read lock.
 
2654
 
            if self._inventory_is_modified:
 
2656
 
            self._write_hashcache_if_dirty()
 
2658
 
        # reverse order of locking.
 
2660
 
            return self._control_files.unlock()
 
2662
 
            self.branch.unlock()
 
2665
 
class WorkingTree3(WorkingTree):
 
2666
 
    """This is the Format 3 working tree.
 
2668
 
    This differs from the base WorkingTree by:
 
2669
 
     - having its own file lock
 
2670
 
     - having its own last-revision property.
 
2672
 
    This is new in bzr 0.8
 
2676
 
    def _last_revision(self):
 
2677
 
        """See Mutable.last_revision."""
 
2679
 
            return self._transport.get_bytes('last-revision')
 
2680
 
        except errors.NoSuchFile:
 
2681
 
            return _mod_revision.NULL_REVISION
 
2683
 
    def _change_last_revision(self, revision_id):
 
2684
 
        """See WorkingTree._change_last_revision."""
 
2685
 
        if revision_id is None or revision_id == _mod_revision.NULL_REVISION:
 
2687
 
                self._transport.delete('last-revision')
 
2688
 
            except errors.NoSuchFile:
 
2692
 
            self._transport.put_bytes('last-revision', revision_id,
 
2693
 
                mode=self.bzrdir._get_file_mode())
 
2696
 
    def _get_check_refs(self):
 
2697
 
        """Return the references needed to perform a check of this tree."""
 
2698
 
        return [('trees', self.last_revision())]
 
2700
 
    @needs_tree_write_lock
 
2701
 
    def set_conflicts(self, conflicts):
 
2702
 
        self._put_rio('conflicts', conflicts.to_stanzas(),
 
2705
 
    @needs_tree_write_lock
 
2706
 
    def add_conflicts(self, new_conflicts):
 
2707
 
        conflict_set = set(self.conflicts())
 
2708
 
        conflict_set.update(set(list(new_conflicts)))
 
2709
 
        self.set_conflicts(_mod_conflicts.ConflictList(sorted(conflict_set,
 
2710
 
                                       key=_mod_conflicts.Conflict.sort_key)))
 
2713
 
    def conflicts(self):
 
2715
 
            confile = self._transport.get('conflicts')
 
2716
 
        except errors.NoSuchFile:
 
2717
 
            return _mod_conflicts.ConflictList()
 
2720
 
                if confile.next() != CONFLICT_HEADER_1 + '\n':
 
2721
 
                    raise errors.ConflictFormatError()
 
2722
 
            except StopIteration:
 
2723
 
                raise errors.ConflictFormatError()
 
2724
 
            return _mod_conflicts.ConflictList.from_stanzas(RioReader(confile))
 
2729
 
        # do non-implementation specific cleanup
 
2731
 
        if self._control_files._lock_count == 1:
 
2732
 
            # _inventory_is_modified is always False during a read lock.
 
2733
 
            if self._inventory_is_modified:
 
2735
 
            self._write_hashcache_if_dirty()
 
2736
 
        # reverse order of locking.
 
2738
 
            return self._control_files.unlock()
 
2740
 
            self.branch.unlock()
 
2743
 
def get_conflicted_stem(path):
 
2744
 
    for suffix in _mod_conflicts.CONFLICT_SUFFIXES:
 
2745
 
        if path.endswith(suffix):
 
2746
 
            return path[:-len(suffix)]
 
2749
 
class WorkingTreeFormat(object):
 
 
1351
        raise NotImplementedError(self.get_shelf_manager)
 
 
1354
class WorkingTreeFormatRegistry(controldir.ControlComponentFormatRegistry):
 
 
1355
    """Registry for working tree formats."""
 
 
1357
    def __init__(self, other_registry=None):
 
 
1358
        super(WorkingTreeFormatRegistry, self).__init__(other_registry)
 
 
1359
        self._default_format = None
 
 
1360
        self._default_format_key = None
 
 
1362
    def get_default(self):
 
 
1363
        """Return the current default format."""
 
 
1364
        if (self._default_format_key is not None and
 
 
1365
            self._default_format is None):
 
 
1366
            self._default_format = self.get(self._default_format_key)
 
 
1367
        return self._default_format
 
 
1369
    def set_default(self, format):
 
 
1370
        """Set the default format."""
 
 
1371
        self._default_format = format
 
 
1372
        self._default_format_key = None
 
 
1374
    def set_default_key(self, format_string):
 
 
1375
        """Set the default format by its format string."""
 
 
1376
        self._default_format_key = format_string
 
 
1377
        self._default_format = None
 
 
1380
format_registry = WorkingTreeFormatRegistry()
 
 
1383
class WorkingTreeFormat(controldir.ControlComponentFormat):
 
2750
1384
    """An encapsulation of the initialization and open routines for a format.
 
2752
1386
    Formats provide three things:
 
 
2823
1463
        """True if this format supports stored views."""
 
2827
 
    def register_format(klass, format):
 
2828
 
        klass._formats[format.get_format_string()] = format
 
2831
 
    def set_default_format(klass, format):
 
2832
 
        klass._default_format = format
 
2835
 
    def unregister_format(klass, format):
 
2836
 
        del klass._formats[format.get_format_string()]
 
2839
 
class WorkingTreeFormat2(WorkingTreeFormat):
 
2840
 
    """The second working tree format.
 
2842
 
    This format modified the hash cache from the format 1 hash cache.
 
2845
 
    upgrade_recommended = True
 
2847
 
    def get_format_description(self):
 
2848
 
        """See WorkingTreeFormat.get_format_description()."""
 
2849
 
        return "Working tree format 2"
 
2851
 
    def _stub_initialize_on_transport(self, transport, file_mode):
 
2852
 
        """Workaround: create control files for a remote working tree.
 
2854
 
        This ensures that it can later be updated and dealt with locally,
 
2855
 
        since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
 
2856
 
        no working tree.  (See bug #43064).
 
2859
 
        inv = inventory.Inventory()
 
2860
 
        xml5.serializer_v5.write_inventory(inv, sio, working=True)
 
2862
 
        transport.put_file('inventory', sio, file_mode)
 
2863
 
        transport.put_bytes('pending-merges', '', file_mode)
 
2865
 
    def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
 
2866
 
                   accelerator_tree=None, hardlink=False):
 
2867
 
        """See WorkingTreeFormat.initialize()."""
 
2868
 
        if not isinstance(a_bzrdir.transport, LocalTransport):
 
2869
 
            raise errors.NotLocalUrl(a_bzrdir.transport.base)
 
2870
 
        if from_branch is not None:
 
2871
 
            branch = from_branch
 
2873
 
            branch = a_bzrdir.open_branch()
 
2874
 
        if revision_id is None:
 
2875
 
            revision_id = _mod_revision.ensure_null(branch.last_revision())
 
2878
 
            branch.generate_revision_history(revision_id)
 
2881
 
        inv = inventory.Inventory()
 
2882
 
        wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
 
2888
 
        basis_tree = branch.repository.revision_tree(revision_id)
 
2889
 
        if basis_tree.inventory.root is not None:
 
2890
 
            wt.set_root_id(basis_tree.get_root_id())
 
2891
 
        # set the parent list and cache the basis tree.
 
2892
 
        if _mod_revision.is_null(revision_id):
 
2895
 
            parent_trees = [(revision_id, basis_tree)]
 
2896
 
        wt.set_parent_trees(parent_trees)
 
2897
 
        transform.build_tree(basis_tree, wt)
 
2901
 
        super(WorkingTreeFormat2, self).__init__()
 
2902
 
        self._matchingbzrdir = bzrdir.BzrDirFormat6()
 
2904
 
    def open(self, a_bzrdir, _found=False):
 
2905
 
        """Return the WorkingTree object for a_bzrdir
 
2907
 
        _found is a private parameter, do not use it. It is used to indicate
 
2908
 
               if format probing has already been done.
 
2911
 
            # we are being called directly and must probe.
 
2912
 
            raise NotImplementedError
 
2913
 
        if not isinstance(a_bzrdir.transport, LocalTransport):
 
2914
 
            raise errors.NotLocalUrl(a_bzrdir.transport.base)
 
2915
 
        wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
 
2921
 
class WorkingTreeFormat3(WorkingTreeFormat):
 
2922
 
    """The second working tree format updated to record a format marker.
 
2925
 
        - exists within a metadir controlling .bzr
 
2926
 
        - includes an explicit version marker for the workingtree control
 
2927
 
          files, separate from the BzrDir format
 
2928
 
        - modifies the hash cache format
 
2930
 
        - uses a LockDir to guard access for writes.
 
2933
 
    upgrade_recommended = True
 
2935
 
    def get_format_string(self):
 
2936
 
        """See WorkingTreeFormat.get_format_string()."""
 
2937
 
        return "Bazaar-NG Working Tree format 3"
 
2939
 
    def get_format_description(self):
 
2940
 
        """See WorkingTreeFormat.get_format_description()."""
 
2941
 
        return "Working tree format 3"
 
2943
 
    _lock_file_name = 'lock'
 
2944
 
    _lock_class = LockDir
 
2946
 
    _tree_class = WorkingTree3
 
2948
 
    def __get_matchingbzrdir(self):
 
2949
 
        return bzrdir.BzrDirMetaFormat1()
 
2951
 
    _matchingbzrdir = property(__get_matchingbzrdir)
 
2953
 
    def _open_control_files(self, a_bzrdir):
 
2954
 
        transport = a_bzrdir.get_workingtree_transport(None)
 
2955
 
        return LockableFiles(transport, self._lock_file_name,
 
2958
 
    def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
 
2959
 
                   accelerator_tree=None, hardlink=False):
 
2960
 
        """See WorkingTreeFormat.initialize().
 
2962
 
        :param revision_id: if supplied, create a working tree at a different
 
2963
 
            revision than the branch is at.
 
2964
 
        :param accelerator_tree: A tree which can be used for retrieving file
 
2965
 
            contents more quickly than the revision tree, i.e. a workingtree.
 
2966
 
            The revision tree will be used for cases where accelerator_tree's
 
2967
 
            content is different.
 
2968
 
        :param hardlink: If true, hard-link files from accelerator_tree,
 
2971
 
        if not isinstance(a_bzrdir.transport, LocalTransport):
 
2972
 
            raise errors.NotLocalUrl(a_bzrdir.transport.base)
 
2973
 
        transport = a_bzrdir.get_workingtree_transport(self)
 
2974
 
        control_files = self._open_control_files(a_bzrdir)
 
2975
 
        control_files.create_lock()
 
2976
 
        control_files.lock_write()
 
2977
 
        transport.put_bytes('format', self.get_format_string(),
 
2978
 
            mode=a_bzrdir._get_file_mode())
 
2979
 
        if from_branch is not None:
 
2980
 
            branch = from_branch
 
2982
 
            branch = a_bzrdir.open_branch()
 
2983
 
        if revision_id is None:
 
2984
 
            revision_id = _mod_revision.ensure_null(branch.last_revision())
 
2985
 
        # WorkingTree3 can handle an inventory which has a unique root id.
 
2986
 
        # as of bzr 0.12. However, bzr 0.11 and earlier fail to handle
 
2987
 
        # those trees. And because there isn't a format bump inbetween, we
 
2988
 
        # are maintaining compatibility with older clients.
 
2989
 
        # inv = Inventory(root_id=gen_root_id())
 
2990
 
        inv = self._initial_inventory()
 
2991
 
        wt = self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
 
2997
 
                         _control_files=control_files)
 
2998
 
        wt.lock_tree_write()
 
3000
 
            basis_tree = branch.repository.revision_tree(revision_id)
 
3001
 
            # only set an explicit root id if there is one to set.
 
3002
 
            if basis_tree.inventory.root is not None:
 
3003
 
                wt.set_root_id(basis_tree.get_root_id())
 
3004
 
            if revision_id == _mod_revision.NULL_REVISION:
 
3005
 
                wt.set_parent_trees([])
 
3007
 
                wt.set_parent_trees([(revision_id, basis_tree)])
 
3008
 
            transform.build_tree(basis_tree, wt)
 
3010
 
            # Unlock in this order so that the unlock-triggers-flush in
 
3011
 
            # WorkingTree is given a chance to fire.
 
3012
 
            control_files.unlock()
 
3016
 
    def _initial_inventory(self):
 
3017
 
        return inventory.Inventory()
 
3020
 
        super(WorkingTreeFormat3, self).__init__()
 
3022
 
    def open(self, a_bzrdir, _found=False):
 
3023
 
        """Return the WorkingTree object for a_bzrdir
 
3025
 
        _found is a private parameter, do not use it. It is used to indicate
 
3026
 
               if format probing has already been done.
 
3029
 
            # we are being called directly and must probe.
 
3030
 
            raise NotImplementedError
 
3031
 
        if not isinstance(a_bzrdir.transport, LocalTransport):
 
3032
 
            raise errors.NotLocalUrl(a_bzrdir.transport.base)
 
3033
 
        wt = self._open(a_bzrdir, self._open_control_files(a_bzrdir))
 
3036
 
    def _open(self, a_bzrdir, control_files):
 
3037
 
        """Open the tree itself.
 
3039
 
        :param a_bzrdir: the dir for the tree.
 
3040
 
        :param control_files: the control files for the tree.
 
3042
 
        return self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
 
3046
 
                                _control_files=control_files)
 
3049
 
        return self.get_format_string()
 
3052
 
__default_format = WorkingTreeFormat6()
 
3053
 
WorkingTreeFormat.register_format(__default_format)
 
3054
 
WorkingTreeFormat.register_format(WorkingTreeFormat5())
 
3055
 
WorkingTreeFormat.register_format(WorkingTreeFormat4())
 
3056
 
WorkingTreeFormat.register_format(WorkingTreeFormat3())
 
3057
 
WorkingTreeFormat.set_default_format(__default_format)
 
3058
 
# formats which have no format string are not discoverable
 
3059
 
# and not independently creatable, so are not registered.
 
3060
 
_legacy_formats = [WorkingTreeFormat2(),
 
 
1466
    def get_controldir_for_branch(self):
 
 
1467
        """Get the control directory format for creating branches.
 
 
1469
        This is to support testing of working tree formats that can not exist
 
 
1470
        in the same control directory as a branch.
 
 
1472
        return self._matchingcontroldir
 
 
1475
format_registry.register_lazy("Bazaar Working Tree Format 4 (bzr 0.15)\n",
 
 
1476
    "breezy.bzr.workingtree_4", "WorkingTreeFormat4")
 
 
1477
format_registry.register_lazy("Bazaar Working Tree Format 5 (bzr 1.11)\n",
 
 
1478
    "breezy.bzr.workingtree_4", "WorkingTreeFormat5")
 
 
1479
format_registry.register_lazy("Bazaar Working Tree Format 6 (bzr 1.14)\n",
 
 
1480
    "breezy.bzr.workingtree_4", "WorkingTreeFormat6")
 
 
1481
format_registry.register_lazy("Bazaar-NG Working Tree format 3",
 
 
1482
    "breezy.bzr.workingtree_3", "WorkingTreeFormat3")
 
 
1483
format_registry.set_default_key("Bazaar Working Tree Format 6 (bzr 1.14)\n")