← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/workingtree.py

  • Committer: Vincent Ladeuil
  • Date: 2010-03-10 09:33:04 UTC
  • mto: (5082.1.1 integration)
  • mto: This revision was merged to the branch mainline in revision 5083.
  • Revision ID: v.ladeuil+lp@free.fr-20100310093304-4245t4tazd4sxoav
Cleanup test from overly cautious checks.

Show diffs side-by-side

added added

removed removed

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