~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/workingtree.py

  • Committer: Patch Queue Manager
  • Date: 2012-03-28 16:13:49 UTC
  • mfrom: (6499.2.3 948339-config-caching)
  • Revision ID: pqm@pqm.ubuntu.com-20120328161349-2gsc0g11fcu43hlc
(vila) Properly share mutable config sections and save the branch config
 only during the final unlock (Vincent Ladeuil)

Show diffs side-by-side

added added

removed removed

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