/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/workingtree.py

  • Committer: John Arbash Meinel
  • Date: 2007-10-10 21:18:06 UTC
  • mto: This revision was merged to the branch mainline in revision 2909.
  • Revision ID: john@arbash-meinel.com-20071010211806-2j9rg6wzrqh7yy4u
Switch from __new__ to __init__ to avoid potential pyrex upgrade problems.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005-2010 Canonical Ltd
 
1
# Copyright (C) 2005, 2006, 2007 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
12
12
#
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
16
 
17
17
"""WorkingTree object and friends.
18
18
 
19
19
A WorkingTree represents the editable working copy of a branch.
20
 
Operations which represent the WorkingTree are also done here,
21
 
such as renaming or adding files.  The WorkingTree has an inventory
22
 
which is updated by these operations.  A commit produces a
 
20
Operations which represent the WorkingTree are also done here, 
 
21
such as renaming or adding files.  The WorkingTree has an inventory 
 
22
which is updated by these operations.  A commit produces a 
23
23
new revision based on the workingtree and its inventory.
24
24
 
25
25
At the moment every WorkingTree has its own branch.  Remote
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
38
 
33
39
from cStringIO import StringIO
34
40
import os
42
48
import itertools
43
49
import operator
44
50
import stat
 
51
from time import time
 
52
import warnings
45
53
import re
46
54
 
47
55
import bzrlib
49
57
    branch,
50
58
    bzrdir,
51
59
    conflicts as _mod_conflicts,
 
60
    dirstate,
52
61
    errors,
53
62
    generate_ids,
54
63
    globbing,
55
 
    graph as _mod_graph,
56
64
    hashcache,
57
65
    ignores,
58
 
    inventory,
59
66
    merge,
 
67
    osutils,
60
68
    revision as _mod_revision,
61
69
    revisiontree,
 
70
    repository,
 
71
    textui,
62
72
    trace,
63
73
    transform,
64
74
    ui,
65
 
    views,
 
75
    urlutils,
66
76
    xml5,
 
77
    xml6,
67
78
    xml7,
68
79
    )
69
80
import bzrlib.branch
70
81
from bzrlib.transport import get_transport
71
 
from bzrlib.workingtree_4 import (
72
 
    WorkingTreeFormat4,
73
 
    WorkingTreeFormat5,
74
 
    WorkingTreeFormat6,
75
 
    )
 
82
import bzrlib.ui
 
83
from bzrlib.workingtree_4 import WorkingTreeFormat4
76
84
""")
77
85
 
78
86
from bzrlib import symbol_versioning
79
87
from bzrlib.decorators import needs_read_lock, needs_write_lock
80
 
from bzrlib.lock import LogicalLockResult
81
 
from bzrlib.lockable_files import LockableFiles
 
88
from bzrlib.inventory import InventoryEntry, Inventory, ROOT_ID, TreeReference
 
89
from bzrlib.lockable_files import LockableFiles, TransportLock
82
90
from bzrlib.lockdir import LockDir
83
91
import bzrlib.mutabletree
84
92
from bzrlib.mutabletree import needs_tree_write_lock
85
 
from bzrlib import osutils
86
93
from bzrlib.osutils import (
 
94
    compact_date,
87
95
    file_kind,
88
96
    isdir,
89
97
    normpath,
90
98
    pathjoin,
 
99
    rand_chars,
91
100
    realpath,
92
101
    safe_unicode,
93
102
    splitpath,
94
103
    supports_executable,
95
104
    )
96
 
from bzrlib.filters import filtered_input_file
97
105
from bzrlib.trace import mutter, note
98
106
from bzrlib.transport.local import LocalTransport
99
 
from bzrlib.revision import CURRENT_REVISION
 
107
from bzrlib.progress import DummyProgress, ProgressPhase
 
108
from bzrlib.revision import NULL_REVISION, CURRENT_REVISION
100
109
from bzrlib.rio import RioReader, rio_file, Stanza
101
 
from bzrlib.symbol_versioning import (
102
 
    deprecated_passed,
103
 
    DEPRECATED_PARAMETER,
104
 
    )
 
110
from bzrlib.symbol_versioning import (deprecated_passed,
 
111
        deprecated_method,
 
112
        deprecated_function,
 
113
        DEPRECATED_PARAMETER,
 
114
        zero_eight,
 
115
        zero_eleven,
 
116
        zero_thirteen,
 
117
        )
105
118
 
106
119
 
107
120
MERGE_MODIFIED_HEADER_1 = "BZR merge-modified list format 1"
108
 
# TODO: Modifying the conflict objects or their type is currently nearly
109
 
# impossible as there is no clear relationship between the working tree format
110
 
# and the conflict list file format.
111
121
CONFLICT_HEADER_1 = "BZR conflict list format 1"
112
122
 
113
123
ERROR_PATH_NOT_FOUND = 3    # WindowsError errno code, equivalent to ENOENT
114
124
 
115
125
 
 
126
@deprecated_function(zero_thirteen)
 
127
def gen_file_id(name):
 
128
    """Return new file id for the basename 'name'.
 
129
 
 
130
    Use bzrlib.generate_ids.gen_file_id() instead
 
131
    """
 
132
    return generate_ids.gen_file_id(name)
 
133
 
 
134
 
 
135
@deprecated_function(zero_thirteen)
 
136
def gen_root_id():
 
137
    """Return a new tree-root file id.
 
138
 
 
139
    This has been deprecated in favor of bzrlib.generate_ids.gen_root_id()
 
140
    """
 
141
    return generate_ids.gen_root_id()
 
142
 
 
143
 
116
144
class TreeEntry(object):
117
145
    """An entry that implements the minimum interface used by commands.
118
146
 
119
 
    This needs further inspection, it may be better to have
 
147
    This needs further inspection, it may be better to have 
120
148
    InventoryEntries without ids - though that seems wrong. For now,
121
149
    this is a parallel hierarchy to InventoryEntry, and needs to become
122
150
    one of several things: decorates to that hierarchy, children of, or
125
153
    no InventoryEntry available - i.e. for unversioned objects.
126
154
    Perhaps they should be UnversionedEntry et al. ? - RBC 20051003
127
155
    """
128
 
 
 
156
 
129
157
    def __eq__(self, other):
130
158
        # yes, this us ugly, TODO: best practice __eq__ style.
131
159
        return (isinstance(other, TreeEntry)
132
160
                and other.__class__ == self.__class__)
133
 
 
 
161
 
134
162
    def kind_character(self):
135
163
        return "???"
136
164
 
168
196
        return ''
169
197
 
170
198
 
171
 
class WorkingTree(bzrlib.mutabletree.MutableTree,
172
 
    bzrdir.ControlComponent):
 
199
class WorkingTree(bzrlib.mutabletree.MutableTree):
173
200
    """Working copy tree.
174
201
 
175
202
    The inventory is held in the `Branch` working-inventory, and the
179
206
    not listed in the Inventory and vice versa.
180
207
    """
181
208
 
182
 
    # override this to set the strategy for storing views
183
 
    def _make_views(self):
184
 
        return views.DisabledViews(self)
185
 
 
186
209
    def __init__(self, basedir='.',
187
210
                 branch=DEPRECATED_PARAMETER,
188
211
                 _inventory=None,
199
222
        if not _internal:
200
223
            raise errors.BzrError("Please use bzrdir.open_workingtree or "
201
224
                "WorkingTree.open() to obtain a WorkingTree.")
 
225
        assert isinstance(basedir, basestring), \
 
226
            "base directory %r is not a string" % basedir
202
227
        basedir = safe_unicode(basedir)
203
228
        mutter("opening working tree %r", basedir)
204
229
        if deprecated_passed(branch):
212
237
            self._control_files = self.branch.control_files
213
238
        else:
214
239
            # assume all other formats have their own control files.
 
240
            assert isinstance(_control_files, LockableFiles), \
 
241
                    "_control_files must be a LockableFiles, not %r" \
 
242
                    % _control_files
215
243
            self._control_files = _control_files
216
 
        self._transport = self._control_files._transport
217
244
        # update the whole cache up front and write to disk if anything changed;
218
245
        # in the future we might want to do this more selectively
219
246
        # two possible ways offer themselves : in self._unlock, write the cache
223
250
        wt_trans = self.bzrdir.get_workingtree_transport(None)
224
251
        cache_filename = wt_trans.local_abspath('stat-cache')
225
252
        self._hashcache = hashcache.HashCache(basedir, cache_filename,
226
 
            self.bzrdir._get_file_mode(),
227
 
            self._content_filter_stack_provider())
 
253
                                              self._control_files._file_mode)
228
254
        hc = self._hashcache
229
255
        hc.read()
230
256
        # is this scan needed ? it makes things kinda slow.
244
270
            # the Format factory and creation methods that are
245
271
            # permitted to do this.
246
272
            self._set_inventory(_inventory, dirty=False)
247
 
        self._detect_case_handling()
248
 
        self._rules_searcher = None
249
 
        self.views = self._make_views()
250
 
 
251
 
    @property
252
 
    def user_transport(self):
253
 
        return self.bzrdir.user_transport
254
 
 
255
 
    @property
256
 
    def control_transport(self):
257
 
        return self._transport
258
 
 
259
 
    def _detect_case_handling(self):
260
 
        wt_trans = self.bzrdir.get_workingtree_transport(None)
261
 
        try:
262
 
            wt_trans.stat("FoRMaT")
263
 
        except errors.NoSuchFile:
264
 
            self.case_sensitive = True
265
 
        else:
266
 
            self.case_sensitive = False
267
 
 
268
 
        self._setup_directory_is_tree_reference()
269
273
 
270
274
    branch = property(
271
275
        fget=lambda self: self._branch,
286
290
        self._control_files.break_lock()
287
291
        self.branch.break_lock()
288
292
 
289
 
    def _get_check_refs(self):
290
 
        """Return the references needed to perform a check of this tree.
291
 
        
292
 
        The default implementation returns no refs, and is only suitable for
293
 
        trees that have no local caching and can commit on ghosts at any time.
294
 
 
295
 
        :seealso: bzrlib.check for details about check_refs.
296
 
        """
297
 
        return []
298
 
 
299
293
    def requires_rich_root(self):
300
294
        return self._format.requires_rich_root
301
295
 
302
296
    def supports_tree_reference(self):
303
297
        return False
304
298
 
305
 
    def supports_content_filtering(self):
306
 
        return self._format.supports_content_filtering()
307
 
 
308
 
    def supports_views(self):
309
 
        return self.views.supports_views()
310
 
 
311
299
    def _set_inventory(self, inv, dirty):
312
300
        """Set the internal cached inventory.
313
301
 
318
306
            False then the inventory is the same as that on disk and any
319
307
            serialisation would be unneeded overhead.
320
308
        """
 
309
        assert inv.root is not None
321
310
        self._inventory = inv
322
311
        self._inventory_is_modified = dirty
323
312
 
327
316
 
328
317
        """
329
318
        if path is None:
330
 
            path = osutils.getcwd()
 
319
            path = os.path.getcwdu()
331
320
        control = bzrdir.BzrDir.open(path, _unsupported)
332
321
        return control.open_workingtree(_unsupported)
333
 
 
 
322
        
334
323
    @staticmethod
335
324
    def open_containing(path=None):
336
325
        """Open an existing working tree which has its root about path.
337
 
 
 
326
        
338
327
        This probes for a working tree at path and searches upwards from there.
339
328
 
340
329
        Basically we keep looking up until we find the control directory or
358
347
        """
359
348
        return WorkingTree.open(path, _unsupported=True)
360
349
 
361
 
    @staticmethod
362
 
    def find_trees(location):
363
 
        def list_current(transport):
364
 
            return [d for d in transport.list_dir('') if d != '.bzr']
365
 
        def evaluate(bzrdir):
366
 
            try:
367
 
                tree = bzrdir.open_workingtree()
368
 
            except errors.NoWorkingTree:
369
 
                return True, None
370
 
            else:
371
 
                return True, tree
372
 
        transport = get_transport(location)
373
 
        iterator = bzrdir.BzrDir.find_bzrdirs(transport, evaluate=evaluate,
374
 
                                              list_current=list_current)
375
 
        return [t for t in iterator if t is not None]
376
 
 
377
350
    # should be deprecated - this is slow and in any case treating them as a
378
351
    # container is (we now know) bad style -- mbp 20070302
379
352
    ## @deprecated_method(zero_fifteen)
388
361
            if osutils.lexists(self.abspath(path)):
389
362
                yield ie.file_id
390
363
 
391
 
    def all_file_ids(self):
392
 
        """See Tree.iter_all_file_ids"""
393
 
        return set(self.inventory)
394
 
 
395
364
    def __repr__(self):
396
365
        return "<%s of %s>" % (self.__class__.__name__,
397
366
                               getattr(self, 'basedir', None))
401
370
 
402
371
    def basis_tree(self):
403
372
        """Return RevisionTree for the current last revision.
404
 
 
 
373
        
405
374
        If the left most parent is a ghost then the returned tree will be an
406
 
        empty tree - one obtained by calling
407
 
        repository.revision_tree(NULL_REVISION).
 
375
        empty tree - one obtained by calling repository.revision_tree(None).
408
376
        """
409
377
        try:
410
378
            revision_id = self.get_parent_ids()[0]
412
380
            # no parents, return an empty revision tree.
413
381
            # in the future this should return the tree for
414
382
            # 'empty:' - the implicit root empty tree.
415
 
            return self.branch.repository.revision_tree(
416
 
                       _mod_revision.NULL_REVISION)
 
383
            return self.branch.repository.revision_tree(None)
417
384
        try:
418
385
            return self.revision_tree(revision_id)
419
386
        except errors.NoSuchRevision:
423
390
        # at this point ?
424
391
        try:
425
392
            return self.branch.repository.revision_tree(revision_id)
426
 
        except (errors.RevisionNotPresent, errors.NoSuchRevision):
 
393
        except errors.RevisionNotPresent:
427
394
            # the basis tree *may* be a ghost or a low level error may have
428
 
            # occurred. If the revision is present, its a problem, if its not
 
395
            # occured. If the revision is present, its a problem, if its not
429
396
            # its a ghost.
430
397
            if self.branch.repository.has_revision(revision_id):
431
398
                raise
432
399
            # the basis tree is a ghost so return an empty tree.
433
 
            return self.branch.repository.revision_tree(
434
 
                       _mod_revision.NULL_REVISION)
 
400
            return self.branch.repository.revision_tree(None)
435
401
 
436
402
    def _cleanup(self):
437
403
        self._flush_ignore_list_cache()
438
404
 
 
405
    @staticmethod
 
406
    @deprecated_method(zero_eight)
 
407
    def create(branch, directory):
 
408
        """Create a workingtree for branch at directory.
 
409
 
 
410
        If existing_directory already exists it must have a .bzr directory.
 
411
        If it does not exist, it will be created.
 
412
 
 
413
        This returns a new WorkingTree object for the new checkout.
 
414
 
 
415
        TODO FIXME RBC 20060124 when we have checkout formats in place this
 
416
        should accept an optional revisionid to checkout [and reject this if
 
417
        checking out into the same dir as a pre-checkout-aware branch format.]
 
418
 
 
419
        XXX: When BzrDir is present, these should be created through that 
 
420
        interface instead.
 
421
        """
 
422
        warnings.warn('delete WorkingTree.create', stacklevel=3)
 
423
        transport = get_transport(directory)
 
424
        if branch.bzrdir.root_transport.base == transport.base:
 
425
            # same dir 
 
426
            return branch.bzrdir.create_workingtree()
 
427
        # different directory, 
 
428
        # create a branch reference
 
429
        # and now a working tree.
 
430
        raise NotImplementedError
 
431
 
 
432
    @staticmethod
 
433
    @deprecated_method(zero_eight)
 
434
    def create_standalone(directory):
 
435
        """Create a checkout and a branch and a repo at directory.
 
436
 
 
437
        Directory must exist and be empty.
 
438
 
 
439
        please use BzrDir.create_standalone_workingtree
 
440
        """
 
441
        return bzrdir.BzrDir.create_standalone_workingtree(directory)
 
442
 
439
443
    def relpath(self, path):
440
444
        """Return the local path portion from a given path.
441
 
 
442
 
        The path may be absolute or relative. If its a relative path it is
 
445
        
 
446
        The path may be absolute or relative. If its a relative path it is 
443
447
        interpreted relative to the python current working directory.
444
448
        """
445
449
        return osutils.relpath(self.basedir, path)
447
451
    def has_filename(self, filename):
448
452
        return osutils.lexists(self.abspath(filename))
449
453
 
450
 
    def get_file(self, file_id, path=None, filtered=True):
451
 
        return self.get_file_with_stat(file_id, path, filtered=filtered)[0]
452
 
 
453
 
    def get_file_with_stat(self, file_id, path=None, filtered=True,
454
 
        _fstat=os.fstat):
455
 
        """See Tree.get_file_with_stat."""
 
454
    def get_file(self, file_id, path=None):
456
455
        if path is None:
457
456
            path = self.id2path(file_id)
458
 
        file_obj = self.get_file_byname(path, filtered=False)
459
 
        stat_value = _fstat(file_obj.fileno())
460
 
        if filtered and self.supports_content_filtering():
461
 
            filters = self._content_filter_stack(path)
462
 
            file_obj = filtered_input_file(file_obj, filters)
463
 
        return (file_obj, stat_value)
464
 
 
465
 
    def get_file_text(self, file_id, path=None, filtered=True):
466
 
        return self.get_file(file_id, path=path, filtered=filtered).read()
467
 
 
468
 
    def get_file_byname(self, filename, filtered=True):
469
 
        path = self.abspath(filename)
470
 
        f = file(path, 'rb')
471
 
        if filtered and self.supports_content_filtering():
472
 
            filters = self._content_filter_stack(filename)
473
 
            return filtered_input_file(f, filters)
474
 
        else:
475
 
            return f
476
 
 
477
 
    def get_file_lines(self, file_id, path=None, filtered=True):
478
 
        """See Tree.get_file_lines()"""
479
 
        file = self.get_file(file_id, path, filtered=filtered)
480
 
        try:
481
 
            return file.readlines()
482
 
        finally:
483
 
            file.close()
 
457
        return self.get_file_byname(path)
 
458
 
 
459
    def get_file_text(self, file_id):
 
460
        return self.get_file(file_id).read()
 
461
 
 
462
    def get_file_byname(self, filename):
 
463
        return file(self.abspath(filename), 'rb')
484
464
 
485
465
    @needs_read_lock
486
466
    def annotate_iter(self, file_id, default_revision=CURRENT_REVISION):
493
473
        incorrectly attributed to CURRENT_REVISION (but after committing, the
494
474
        attribution will be correct).
495
475
        """
496
 
        maybe_file_parent_keys = []
497
 
        for parent_id in self.get_parent_ids():
498
 
            try:
499
 
                parent_tree = self.revision_tree(parent_id)
500
 
            except errors.NoSuchRevisionInTree:
501
 
                parent_tree = self.branch.repository.revision_tree(parent_id)
502
 
            parent_tree.lock_read()
503
 
            try:
504
 
                if file_id not in parent_tree:
505
 
                    continue
506
 
                ie = parent_tree.inventory[file_id]
507
 
                if ie.kind != 'file':
508
 
                    # Note: this is slightly unnecessary, because symlinks and
509
 
                    # directories have a "text" which is the empty text, and we
510
 
                    # know that won't mess up annotations. But it seems cleaner
511
 
                    continue
512
 
                parent_text_key = (file_id, ie.revision)
513
 
                if parent_text_key not in maybe_file_parent_keys:
514
 
                    maybe_file_parent_keys.append(parent_text_key)
515
 
            finally:
516
 
                parent_tree.unlock()
517
 
        graph = _mod_graph.Graph(self.branch.repository.texts)
518
 
        heads = graph.heads(maybe_file_parent_keys)
519
 
        file_parent_keys = []
520
 
        for key in maybe_file_parent_keys:
521
 
            if key in heads:
522
 
                file_parent_keys.append(key)
523
 
 
524
 
        # Now we have the parents of this content
525
 
        annotator = self.branch.repository.texts.get_annotator()
526
 
        text = self.get_file(file_id).read()
527
 
        this_key =(file_id, default_revision)
528
 
        annotator.add_special_text(this_key, file_parent_keys, text)
529
 
        annotations = [(key[-1], line)
530
 
                       for key, line in annotator.annotate_flat(this_key)]
531
 
        return annotations
 
476
        basis = self.basis_tree()
 
477
        basis.lock_read()
 
478
        try:
 
479
            changes = self._iter_changes(basis, True, [self.id2path(file_id)],
 
480
                require_versioned=True).next()
 
481
            changed_content, kind = changes[2], changes[6]
 
482
            if not changed_content:
 
483
                return basis.annotate_iter(file_id)
 
484
            if kind[1] is None:
 
485
                return None
 
486
            import annotate
 
487
            if kind[0] != 'file':
 
488
                old_lines = []
 
489
            else:
 
490
                old_lines = list(basis.annotate_iter(file_id))
 
491
            old = [old_lines]
 
492
            for tree in self.branch.repository.revision_trees(
 
493
                self.get_parent_ids()[1:]):
 
494
                if file_id not in tree:
 
495
                    continue
 
496
                old.append(list(tree.annotate_iter(file_id)))
 
497
            return annotate.reannotate(old, self.get_file(file_id).readlines(),
 
498
                                       default_revision)
 
499
        finally:
 
500
            basis.unlock()
532
501
 
533
502
    def _get_ancestors(self, default_revision):
534
503
        ancestors = set([default_revision])
539
508
 
540
509
    def get_parent_ids(self):
541
510
        """See Tree.get_parent_ids.
542
 
 
 
511
        
543
512
        This implementation reads the pending merges list and last_revision
544
513
        value and uses that to decide what the parents list should be.
545
514
        """
549
518
        else:
550
519
            parents = [last_rev]
551
520
        try:
552
 
            merges_bytes = self._transport.get_bytes('pending-merges')
 
521
            merges_file = self._control_files.get('pending-merges')
553
522
        except errors.NoSuchFile:
554
523
            pass
555
524
        else:
556
 
            for l in osutils.split_lines(merges_bytes):
 
525
            for l in merges_file.readlines():
557
526
                revision_id = l.rstrip('\n')
558
527
                parents.append(revision_id)
559
528
        return parents
562
531
    def get_root_id(self):
563
532
        """Return the id of this trees root"""
564
533
        return self._inventory.root.file_id
565
 
 
 
534
        
566
535
    def _get_store_filename(self, file_id):
567
536
        ## XXX: badly named; this is not in the store at all
568
537
        return self.abspath(self.id2path(file_id))
570
539
    @needs_read_lock
571
540
    def clone(self, to_bzrdir, revision_id=None):
572
541
        """Duplicate this working tree into to_bzr, including all state.
573
 
 
 
542
        
574
543
        Specifically modified files are kept as modified, but
575
544
        ignored and unknown files are discarded.
576
545
 
577
546
        If you want to make a new line of development, see bzrdir.sprout()
578
547
 
579
548
        revision
580
 
            If not None, the cloned tree will have its last revision set to
581
 
            revision, and difference between the source trees last revision
 
549
            If not None, the cloned tree will have its last revision set to 
 
550
            revision, and and difference between the source trees last revision
582
551
            and this one merged in.
583
552
        """
584
553
        # assumes the target bzr dir format is compatible.
585
 
        result = to_bzrdir.create_workingtree()
 
554
        result = self._format.initialize(to_bzrdir)
586
555
        self.copy_content_into(result, revision_id)
587
556
        return result
588
557
 
617
586
    __contains__ = has_id
618
587
 
619
588
    def get_file_size(self, file_id):
620
 
        """See Tree.get_file_size"""
621
 
        # XXX: this returns the on-disk size; it should probably return the
622
 
        # canonical size
623
 
        try:
624
 
            return os.path.getsize(self.id2abspath(file_id))
625
 
        except OSError, e:
626
 
            if e.errno != errno.ENOENT:
627
 
                raise
628
 
            else:
629
 
                return None
 
589
        return os.path.getsize(self.id2abspath(file_id))
630
590
 
631
591
    @needs_read_lock
632
592
    def get_file_sha1(self, file_id, path=None, stat_value=None):
639
599
            path = self.inventory.id2path(file_id)
640
600
        return os.lstat(self.abspath(path)).st_mtime
641
601
 
642
 
    def _is_executable_from_path_and_stat_from_basis(self, path, stat_result):
643
 
        file_id = self.path2id(path)
644
 
        if file_id is None:
645
 
            # For unversioned files on win32, we just assume they are not
646
 
            # executable
647
 
            return False
648
 
        return self._inventory[file_id].executable
649
 
 
650
 
    def _is_executable_from_path_and_stat_from_stat(self, path, stat_result):
651
 
        mode = stat_result.st_mode
652
 
        return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
653
 
 
654
602
    if not supports_executable():
655
603
        def is_executable(self, file_id, path=None):
656
604
            return self._inventory[file_id].executable
657
 
 
658
 
        _is_executable_from_path_and_stat = \
659
 
            _is_executable_from_path_and_stat_from_basis
660
605
    else:
661
606
        def is_executable(self, file_id, path=None):
662
607
            if not path:
664
609
            mode = os.lstat(self.abspath(path)).st_mode
665
610
            return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
666
611
 
667
 
        _is_executable_from_path_and_stat = \
668
 
            _is_executable_from_path_and_stat_from_stat
669
 
 
670
612
    @needs_tree_write_lock
671
613
    def _add(self, files, ids, kinds):
672
614
        """See MutableTree._add."""
673
615
        # TODO: Re-adding a file that is removed in the working copy
674
616
        # should probably put it back with the previous ID.
675
 
        # the read and write working inventory should not occur in this
 
617
        # the read and write working inventory should not occur in this 
676
618
        # function - they should be part of lock_write and unlock.
677
619
        inv = self.inventory
678
620
        for f, file_id, kind in zip(files, ids, kinds):
 
621
            assert kind is not None
679
622
            if file_id is None:
680
623
                inv.add_path(f, kind=kind)
681
624
            else:
746
689
        if updated:
747
690
            self.set_parent_ids(parents, allow_leftmost_as_ghost=True)
748
691
 
749
 
    def path_content_summary(self, path, _lstat=os.lstat,
 
692
    def path_content_summary(self, path, _lstat=osutils.lstat,
750
693
        _mapper=osutils.file_kind_from_stat_mode):
751
694
        """See Tree.path_content_summary."""
752
695
        abspath = self.abspath(path)
760
703
            raise
761
704
        kind = _mapper(stat_result.st_mode)
762
705
        if kind == 'file':
763
 
            return self._file_content_summary(path, stat_result)
 
706
            size = stat_result.st_size
 
707
            # try for a stat cache lookup
 
708
            if not supports_executable():
 
709
                executable = None # caller can decide policy.
 
710
            else:
 
711
                mode = stat_result.st_mode
 
712
                executable = bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
 
713
            return (kind, size, executable, self._sha_from_stat(
 
714
                path, stat_result))
764
715
        elif kind == 'directory':
765
716
            # perhaps it looks like a plain directory, but it's really a
766
717
            # reference.
768
719
                kind = 'tree-reference'
769
720
            return kind, None, None, None
770
721
        elif kind == 'symlink':
771
 
            target = osutils.readlink(abspath)
772
 
            return ('symlink', None, None, target)
 
722
            return ('symlink', None, None, os.readlink(abspath))
773
723
        else:
774
724
            return (kind, None, None, None)
775
725
 
776
 
    def _file_content_summary(self, path, stat_result):
777
 
        size = stat_result.st_size
778
 
        executable = self._is_executable_from_path_and_stat(path, stat_result)
779
 
        # try for a stat cache lookup
780
 
        return ('file', size, executable, self._sha_from_stat(
781
 
            path, stat_result))
 
726
    @deprecated_method(zero_eleven)
 
727
    @needs_read_lock
 
728
    def pending_merges(self):
 
729
        """Return a list of pending merges.
 
730
 
 
731
        These are revisions that have been merged into the working
 
732
        directory but not yet committed.
 
733
 
 
734
        As of 0.11 this is deprecated. Please see WorkingTree.get_parent_ids()
 
735
        instead - which is available on all tree objects.
 
736
        """
 
737
        return self.get_parent_ids()[1:]
782
738
 
783
739
    def _check_parents_for_ghosts(self, revision_ids, allow_leftmost_as_ghost):
784
740
        """Common ghost checking functionality from set_parent_*.
794
750
 
795
751
    def _set_merges_from_parent_ids(self, parent_ids):
796
752
        merges = parent_ids[1:]
797
 
        self._transport.put_bytes('pending-merges', '\n'.join(merges),
798
 
            mode=self.bzrdir._get_file_mode())
799
 
 
800
 
    def _filter_parent_ids_by_ancestry(self, revision_ids):
801
 
        """Check that all merged revisions are proper 'heads'.
802
 
 
803
 
        This will always return the first revision_id, and any merged revisions
804
 
        which are
805
 
        """
806
 
        if len(revision_ids) == 0:
807
 
            return revision_ids
808
 
        graph = self.branch.repository.get_graph()
809
 
        heads = graph.heads(revision_ids)
810
 
        new_revision_ids = revision_ids[:1]
811
 
        for revision_id in revision_ids[1:]:
812
 
            if revision_id in heads and revision_id not in new_revision_ids:
813
 
                new_revision_ids.append(revision_id)
814
 
        if new_revision_ids != revision_ids:
815
 
            trace.mutter('requested to set revision_ids = %s,'
816
 
                         ' but filtered to %s', revision_ids, new_revision_ids)
817
 
        return new_revision_ids
 
753
        self._control_files.put_bytes('pending-merges', '\n'.join(merges))
818
754
 
819
755
    @needs_tree_write_lock
820
756
    def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
821
757
        """Set the parent ids to revision_ids.
822
 
 
 
758
        
823
759
        See also set_parent_trees. This api will try to retrieve the tree data
824
760
        for each element of revision_ids from the trees repository. If you have
825
761
        tree data already available, it is more efficient to use
834
770
        for revision_id in revision_ids:
835
771
            _mod_revision.check_not_reserved_id(revision_id)
836
772
 
837
 
        revision_ids = self._filter_parent_ids_by_ancestry(revision_ids)
838
 
 
839
773
        if len(revision_ids) > 0:
840
774
            self.set_last_revision(revision_ids[0])
841
775
        else:
853
787
        self._check_parents_for_ghosts(parent_ids,
854
788
            allow_leftmost_as_ghost=allow_leftmost_as_ghost)
855
789
 
856
 
        parent_ids = self._filter_parent_ids_by_ancestry(parent_ids)
857
 
 
858
790
        if len(parent_ids) == 0:
859
791
            leftmost_parent_id = _mod_revision.NULL_REVISION
860
792
            leftmost_parent_tree = None
900
832
    def _put_rio(self, filename, stanzas, header):
901
833
        self._must_be_locked()
902
834
        my_file = rio_file(stanzas, header)
903
 
        self._transport.put_file(filename, my_file,
904
 
            mode=self.bzrdir._get_file_mode())
 
835
        self._control_files.put(filename, my_file)
905
836
 
906
837
    @needs_write_lock # because merge pulls data into the branch.
907
838
    def merge_from_branch(self, branch, to_revision=None, from_revision=None,
908
 
                          merge_type=None, force=False):
 
839
        merge_type=None):
909
840
        """Merge from a branch into this working tree.
910
841
 
911
842
        :param branch: The branch to merge from.
915
846
            branch.last_revision().
916
847
        """
917
848
        from bzrlib.merge import Merger, Merge3Merger
918
 
        merger = Merger(self.branch, this_tree=self)
919
 
        # check that there are no local alterations
920
 
        if not force and self.has_changes():
921
 
            raise errors.UncommittedChanges(self)
922
 
        if to_revision is None:
923
 
            to_revision = _mod_revision.ensure_null(branch.last_revision())
924
 
        merger.other_rev_id = to_revision
925
 
        if _mod_revision.is_null(merger.other_rev_id):
926
 
            raise errors.NoCommits(branch)
927
 
        self.branch.fetch(branch, last_revision=merger.other_rev_id)
928
 
        merger.other_basis = merger.other_rev_id
929
 
        merger.other_tree = self.branch.repository.revision_tree(
930
 
            merger.other_rev_id)
931
 
        merger.other_branch = branch
932
 
        if from_revision is None:
933
 
            merger.find_base()
934
 
        else:
935
 
            merger.set_base_revision(from_revision, branch)
936
 
        if merger.base_rev_id == merger.other_rev_id:
937
 
            raise errors.PointlessMerge
938
 
        merger.backup_files = False
939
 
        if merge_type is None:
940
 
            merger.merge_type = Merge3Merger
941
 
        else:
942
 
            merger.merge_type = merge_type
943
 
        merger.set_interesting_files(None)
944
 
        merger.show_base = False
945
 
        merger.reprocess = False
946
 
        conflicts = merger.do_merge()
947
 
        merger.set_pending()
 
849
        pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
850
        try:
 
851
            merger = Merger(self.branch, this_tree=self, pb=pb)
 
852
            merger.pp = ProgressPhase("Merge phase", 5, pb)
 
853
            merger.pp.next_phase()
 
854
            # check that there are no
 
855
            # local alterations
 
856
            merger.check_basis(check_clean=True, require_commits=False)
 
857
            if to_revision is None:
 
858
                to_revision = _mod_revision.ensure_null(branch.last_revision())
 
859
            merger.other_rev_id = to_revision
 
860
            if _mod_revision.is_null(merger.other_rev_id):
 
861
                raise errors.NoCommits(branch)
 
862
            self.branch.fetch(branch, last_revision=merger.other_rev_id)
 
863
            merger.other_basis = merger.other_rev_id
 
864
            merger.other_tree = self.branch.repository.revision_tree(
 
865
                merger.other_rev_id)
 
866
            merger.other_branch = branch
 
867
            merger.pp.next_phase()
 
868
            if from_revision is None:
 
869
                merger.find_base()
 
870
            else:
 
871
                merger.set_base_revision(from_revision, branch)
 
872
            if merger.base_rev_id == merger.other_rev_id:
 
873
                raise errors.PointlessMerge
 
874
            merger.backup_files = False
 
875
            if merge_type is None:
 
876
                merger.merge_type = Merge3Merger
 
877
            else:
 
878
                merger.merge_type = merge_type
 
879
            merger.set_interesting_files(None)
 
880
            merger.show_base = False
 
881
            merger.reprocess = False
 
882
            conflicts = merger.do_merge()
 
883
            merger.set_pending()
 
884
        finally:
 
885
            pb.finished()
948
886
        return conflicts
949
887
 
950
888
    @needs_read_lock
951
889
    def merge_modified(self):
952
890
        """Return a dictionary of files modified by a merge.
953
891
 
954
 
        The list is initialized by WorkingTree.set_merge_modified, which is
 
892
        The list is initialized by WorkingTree.set_merge_modified, which is 
955
893
        typically called after we make some automatic updates to the tree
956
894
        because of a merge.
957
895
 
959
897
        still in the working inventory and have that text hash.
960
898
        """
961
899
        try:
962
 
            hashfile = self._transport.get('merge-hashes')
 
900
            hashfile = self._control_files.get('merge-hashes')
963
901
        except errors.NoSuchFile:
964
902
            return {}
 
903
        merge_hashes = {}
965
904
        try:
966
 
            merge_hashes = {}
967
 
            try:
968
 
                if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
969
 
                    raise errors.MergeModifiedFormatError()
970
 
            except StopIteration:
 
905
            if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
971
906
                raise errors.MergeModifiedFormatError()
972
 
            for s in RioReader(hashfile):
973
 
                # RioReader reads in Unicode, so convert file_ids back to utf8
974
 
                file_id = osutils.safe_file_id(s.get("file_id"), warn=False)
975
 
                if file_id not in self.inventory:
976
 
                    continue
977
 
                text_hash = s.get("hash")
978
 
                if text_hash == self.get_file_sha1(file_id):
979
 
                    merge_hashes[file_id] = text_hash
980
 
            return merge_hashes
981
 
        finally:
982
 
            hashfile.close()
 
907
        except StopIteration:
 
908
            raise errors.MergeModifiedFormatError()
 
909
        for s in RioReader(hashfile):
 
910
            # RioReader reads in Unicode, so convert file_ids back to utf8
 
911
            file_id = osutils.safe_file_id(s.get("file_id"), warn=False)
 
912
            if file_id not in self.inventory:
 
913
                continue
 
914
            text_hash = s.get("hash")
 
915
            if text_hash == self.get_file_sha1(file_id):
 
916
                merge_hashes[file_id] = text_hash
 
917
        return merge_hashes
983
918
 
984
919
    @needs_write_lock
985
920
    def mkdir(self, path, file_id=None):
991
926
        return file_id
992
927
 
993
928
    def get_symlink_target(self, file_id):
994
 
        abspath = self.id2abspath(file_id)
995
 
        target = osutils.readlink(abspath)
996
 
        return target
 
929
        return os.readlink(self.id2abspath(file_id))
997
930
 
998
931
    @needs_write_lock
999
932
    def subsume(self, other_tree):
1037
970
            other_tree.unlock()
1038
971
        other_tree.bzrdir.retire_bzrdir()
1039
972
 
1040
 
    def _setup_directory_is_tree_reference(self):
1041
 
        if self._branch.repository._format.supports_tree_reference:
1042
 
            self._directory_is_tree_reference = \
1043
 
                self._directory_may_be_tree_reference
1044
 
        else:
1045
 
            self._directory_is_tree_reference = \
1046
 
                self._directory_is_never_tree_reference
1047
 
 
1048
 
    def _directory_is_never_tree_reference(self, relpath):
1049
 
        return False
1050
 
 
1051
 
    def _directory_may_be_tree_reference(self, relpath):
1052
 
        # as a special case, if a directory contains control files then
 
973
    def _directory_is_tree_reference(self, relpath):
 
974
        # as a special case, if a directory contains control files then 
1053
975
        # it's a tree reference, except that the root of the tree is not
1054
976
        return relpath and osutils.isdir(self.abspath(relpath) + u"/.bzr")
1055
977
        # TODO: We could ask all the control formats whether they
1066
988
    @needs_tree_write_lock
1067
989
    def extract(self, file_id, format=None):
1068
990
        """Extract a subtree from this tree.
1069
 
 
 
991
        
1070
992
        A new branch will be created, relative to the path for this tree.
1071
993
        """
1072
994
        self.flush()
1077
999
                transport = transport.clone(name)
1078
1000
                transport.ensure_base()
1079
1001
            return transport
1080
 
 
 
1002
            
1081
1003
        sub_path = self.id2path(file_id)
1082
1004
        branch_transport = mkdirs(sub_path)
1083
1005
        if format is None:
1084
 
            format = self.bzrdir.cloning_metadir()
 
1006
            format = bzrdir.format_registry.make_bzrdir('dirstate-with-subtree')
1085
1007
        branch_transport.ensure_base()
1086
1008
        branch_bzrdir = format.initialize_on_transport(branch_transport)
1087
1009
        try:
1088
1010
            repo = branch_bzrdir.find_repository()
1089
1011
        except errors.NoRepositoryPresent:
1090
1012
            repo = branch_bzrdir.create_repository()
1091
 
        if not repo.supports_rich_root():
1092
 
            raise errors.RootNotRich()
 
1013
            assert repo.supports_rich_root()
 
1014
        else:
 
1015
            if not repo.supports_rich_root():
 
1016
                raise errors.RootNotRich()
1093
1017
        new_branch = branch_bzrdir.create_branch()
1094
1018
        new_branch.pull(self.branch)
1095
1019
        for parent_id in self.get_parent_ids():
1097
1021
        tree_transport = self.bzrdir.root_transport.clone(sub_path)
1098
1022
        if tree_transport.base != branch_transport.base:
1099
1023
            tree_bzrdir = format.initialize_on_transport(tree_transport)
1100
 
            branch.BranchReferenceFormat().initialize(tree_bzrdir,
1101
 
                target_branch=new_branch)
 
1024
            branch.BranchReferenceFormat().initialize(tree_bzrdir, new_branch)
1102
1025
        else:
1103
1026
            tree_bzrdir = branch_bzrdir
1104
 
        wt = tree_bzrdir.create_workingtree(_mod_revision.NULL_REVISION)
 
1027
        wt = tree_bzrdir.create_workingtree(NULL_REVISION)
1105
1028
        wt.set_parent_ids(self.get_parent_ids())
1106
1029
        my_inv = self.inventory
1107
 
        child_inv = inventory.Inventory(root_id=None)
 
1030
        child_inv = Inventory(root_id=None)
1108
1031
        new_root = my_inv[file_id]
1109
1032
        my_inv.remove_recursive_id(file_id)
1110
1033
        new_root.parent_id = None
1128
1051
        sio = StringIO()
1129
1052
        self._serialize(self._inventory, sio)
1130
1053
        sio.seek(0)
1131
 
        self._transport.put_file('inventory', sio,
1132
 
            mode=self.bzrdir._get_file_mode())
 
1054
        self._control_files.put('inventory', sio)
1133
1055
        self._inventory_is_modified = False
1134
1056
 
1135
1057
    def _kind(self, relpath):
1136
1058
        return osutils.file_kind(self.abspath(relpath))
1137
1059
 
1138
 
    def list_files(self, include_root=False, from_dir=None, recursive=True):
1139
 
        """List all files as (path, class, kind, id, entry).
 
1060
    def list_files(self, include_root=False):
 
1061
        """Recursively list all files as (path, class, kind, id, entry).
1140
1062
 
1141
1063
        Lists, but does not descend into unversioned directories.
 
1064
 
1142
1065
        This does not include files that have been deleted in this
1143
 
        tree. Skips the control directory.
 
1066
        tree.
1144
1067
 
1145
 
        :param include_root: if True, return an entry for the root
1146
 
        :param from_dir: start from this directory or None for the root
1147
 
        :param recursive: whether to recurse into subdirectories or not
 
1068
        Skips the control directory.
1148
1069
        """
1149
1070
        # list_files is an iterator, so @needs_read_lock doesn't work properly
1150
1071
        # with it. So callers should be careful to always read_lock the tree.
1152
1073
            raise errors.ObjectNotLocked(self)
1153
1074
 
1154
1075
        inv = self.inventory
1155
 
        if from_dir is None and include_root is True:
 
1076
        if include_root is True:
1156
1077
            yield ('', 'V', 'directory', inv.root.file_id, inv.root)
1157
1078
        # Convert these into local objects to save lookup times
1158
1079
        pathjoin = osutils.pathjoin
1165
1086
        fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
1166
1087
 
1167
1088
        # 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)
 
1089
        children = os.listdir(self.basedir)
1178
1090
        children.sort()
1179
 
        # jam 20060527 The kernel sized tree seems equivalent whether we
 
1091
        # jam 20060527 The kernel sized tree seems equivalent whether we 
1180
1092
        # use a deque and popleft to keep them sorted, or if we use a plain
1181
1093
        # list and just reverse() them.
1182
1094
        children = collections.deque(children)
1183
 
        stack = [(from_dir_id, u'', from_dir_abspath, children)]
 
1095
        stack = [(inv.root.file_id, u'', self.basedir, children)]
1184
1096
        while stack:
1185
1097
            from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
1186
1098
 
1202
1114
 
1203
1115
                # absolute path
1204
1116
                fap = from_dir_abspath + '/' + f
1205
 
 
 
1117
                
1206
1118
                f_ie = inv.get_child(from_dir_id, f)
1207
1119
                if f_ie:
1208
1120
                    c = 'V'
1240
1152
                    except KeyError:
1241
1153
                        yield fp[1:], c, fk, None, TreeEntry()
1242
1154
                    continue
1243
 
 
 
1155
                
1244
1156
                if fk != 'directory':
1245
1157
                    continue
1246
1158
 
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
 
1159
                # But do this child first
 
1160
                new_children = os.listdir(fap)
 
1161
                new_children.sort()
 
1162
                new_children = collections.deque(new_children)
 
1163
                stack.append((f_ie.file_id, fp, fap, new_children))
 
1164
                # Break out of inner loop,
 
1165
                # so that we start outer loop with child
 
1166
                break
1256
1167
            else:
1257
1168
                # if we finished all children, pop it off the stack
1258
1169
                stack.pop()
1264
1175
        to_dir must exist in the inventory.
1265
1176
 
1266
1177
        If to_dir exists and is a directory, the files are moved into
1267
 
        it, keeping their old names.
 
1178
        it, keeping their old names.  
1268
1179
 
1269
1180
        Note that to_dir is only the last component of the new name;
1270
1181
        this doesn't change the directory.
1307
1218
                                       DeprecationWarning)
1308
1219
 
1309
1220
        # check destination directory
1310
 
        if isinstance(from_paths, basestring):
1311
 
            raise ValueError()
 
1221
        assert not isinstance(from_paths, basestring)
1312
1222
        inv = self.inventory
1313
1223
        to_abs = self.abspath(to_dir)
1314
1224
        if not isdir(to_abs):
1398
1308
                only_change_inv = True
1399
1309
            elif self.has_filename(from_rel) and not self.has_filename(to_rel):
1400
1310
                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
1311
            else:
1406
1312
                # something is wrong, so lets determine what exactly
1407
1313
                if not self.has_filename(from_rel) and \
1410
1316
                        errors.PathsDoNotExist(paths=(str(from_rel),
1411
1317
                        str(to_rel))))
1412
1318
                else:
1413
 
                    raise errors.RenameFailedFilesExist(from_rel, to_rel)
 
1319
                    raise errors.RenameFailedFilesExist(from_rel, to_rel,
 
1320
                        extra="(Use --after to update the Bazaar id)")
1414
1321
            rename_entry.only_change_inv = only_change_inv
1415
1322
        return rename_entries
1416
1323
 
1436
1343
        inv = self.inventory
1437
1344
        for entry in moved:
1438
1345
            try:
1439
 
                self._move_entry(WorkingTree._RenameEntry(
1440
 
                    entry.to_rel, entry.from_id,
 
1346
                self._move_entry(_RenameEntry(entry.to_rel, entry.from_id,
1441
1347
                    entry.to_tail, entry.to_parent_id, entry.from_rel,
1442
1348
                    entry.from_tail, entry.from_parent_id,
1443
1349
                    entry.only_change_inv))
1494
1400
        from_tail = splitpath(from_rel)[-1]
1495
1401
        from_id = inv.path2id(from_rel)
1496
1402
        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]
 
1403
            raise errors.BzrRenameFailedError(from_rel,to_rel,
 
1404
                errors.NotVersionedError(path=str(from_rel)))
 
1405
        from_entry = inv[from_id]
1508
1406
        from_parent_id = from_entry.parent_id
1509
1407
        to_dir, to_tail = os.path.split(to_rel)
1510
1408
        to_dir_id = inv.path2id(to_dir)
1556
1454
        These are files in the working directory that are not versioned or
1557
1455
        control files or ignored.
1558
1456
        """
1559
 
        # force the extras method to be fully executed before returning, to
 
1457
        # force the extras method to be fully executed before returning, to 
1560
1458
        # prevent race conditions with the lock
1561
1459
        return iter(
1562
1460
            [subp for subp in self.extras() if not self.is_ignored(subp)])
1572
1470
        :raises: NoSuchId if any fileid is not currently versioned.
1573
1471
        """
1574
1472
        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
1473
            if self._inventory.has_id(file_id):
1579
1474
                self._inventory.remove_recursive_id(file_id)
 
1475
            else:
 
1476
                raise errors.NoSuchId(self, file_id)
1580
1477
        if len(file_ids):
1581
 
            # in the future this should just set a dirty bit to wait for the
 
1478
            # in the future this should just set a dirty bit to wait for the 
1582
1479
            # final unlock. However, until all methods of workingtree start
1583
 
            # with the current in -memory inventory rather than triggering
 
1480
            # with the current in -memory inventory rather than triggering 
1584
1481
            # a read, it is more complex - we need to teach read_inventory
1585
1482
            # to know when to read, and when to not read first... and possibly
1586
1483
            # to save first when the in memory one may be corrupted.
1587
1484
            # so for now, we just only write it if it is indeed dirty.
1588
1485
            # - RBC 20060907
1589
1486
            self._write_inventory(self._inventory)
 
1487
    
 
1488
    @deprecated_method(zero_eight)
 
1489
    def iter_conflicts(self):
 
1490
        """List all files in the tree that have text or content conflicts.
 
1491
        DEPRECATED.  Use conflicts instead."""
 
1492
        return self._iter_conflicts()
1590
1493
 
1591
1494
    def _iter_conflicts(self):
1592
1495
        conflicted = set()
1601
1504
 
1602
1505
    @needs_write_lock
1603
1506
    def pull(self, source, overwrite=False, stop_revision=None,
1604
 
             change_reporter=None, possible_transports=None, local=False):
 
1507
             change_reporter=None, possible_transports=None):
 
1508
        top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1605
1509
        source.lock_read()
1606
1510
        try:
 
1511
            pp = ProgressPhase("Pull phase", 2, top_pb)
 
1512
            pp.next_phase()
1607
1513
            old_revision_info = self.branch.last_revision_info()
1608
1514
            basis_tree = self.basis_tree()
1609
1515
            count = self.branch.pull(source, overwrite, stop_revision,
1610
 
                                     possible_transports=possible_transports,
1611
 
                                     local=local)
 
1516
                                     possible_transports=possible_transports)
1612
1517
            new_revision_info = self.branch.last_revision_info()
1613
1518
            if new_revision_info != old_revision_info:
 
1519
                pp.next_phase()
1614
1520
                repository = self.branch.repository
 
1521
                pb = bzrlib.ui.ui_factory.nested_progress_bar()
1615
1522
                basis_tree.lock_read()
1616
1523
                try:
1617
1524
                    new_basis_tree = self.branch.basis_tree()
1620
1527
                                new_basis_tree,
1621
1528
                                basis_tree,
1622
1529
                                this_tree=self,
1623
 
                                pb=None,
 
1530
                                pb=pb,
1624
1531
                                change_reporter=change_reporter)
1625
 
                    basis_root_id = basis_tree.get_root_id()
1626
 
                    new_root_id = new_basis_tree.get_root_id()
1627
 
                    if basis_root_id != new_root_id:
1628
 
                        self.set_root_id(new_root_id)
 
1532
                    if (basis_tree.inventory.root is None and
 
1533
                        new_basis_tree.inventory.root is not None):
 
1534
                        self.set_root_id(new_basis_tree.inventory.root.file_id)
1629
1535
                finally:
 
1536
                    pb.finished()
1630
1537
                    basis_tree.unlock()
1631
1538
                # TODO - dedup parents list with things merged by pull ?
1632
1539
                # reuse the revisiontree we merged against to set the new
1633
1540
                # tree data.
1634
1541
                parent_trees = [(self.branch.last_revision(), new_basis_tree)]
1635
 
                # we have to pull the merge trees out again, because
1636
 
                # merge_inner has set the ids. - this corner is not yet
 
1542
                # we have to pull the merge trees out again, because 
 
1543
                # merge_inner has set the ids. - this corner is not yet 
1637
1544
                # layered well enough to prevent double handling.
1638
1545
                # XXX TODO: Fix the double handling: telling the tree about
1639
1546
                # the already known parent data is wasteful.
1645
1552
            return count
1646
1553
        finally:
1647
1554
            source.unlock()
 
1555
            top_pb.finished()
1648
1556
 
1649
1557
    @needs_write_lock
1650
1558
    def put_file_bytes_non_atomic(self, file_id, bytes):
1676
1584
 
1677
1585
            fl = []
1678
1586
            for subf in os.listdir(dirabs):
1679
 
                if self.bzrdir.is_control_filename(subf):
 
1587
                if subf == '.bzr':
1680
1588
                    continue
1681
1589
                if subf not in dir_entry.children:
1682
 
                    try:
1683
 
                        (subf_norm,
1684
 
                         can_access) = osutils.normalized_filename(subf)
1685
 
                    except UnicodeDecodeError:
1686
 
                        path_os_enc = path.encode(osutils._fs_enc)
1687
 
                        relpath = path_os_enc + '/' + subf
1688
 
                        raise errors.BadFilenameEncoding(relpath,
1689
 
                                                         osutils._fs_enc)
 
1590
                    subf_norm, can_access = osutils.normalized_filename(subf)
1690
1591
                    if subf_norm != subf and can_access:
1691
1592
                        if subf_norm not in dir_entry.children:
1692
1593
                            fl.append(subf_norm)
1693
1594
                    else:
1694
1595
                        fl.append(subf)
1695
 
 
 
1596
            
1696
1597
            fl.sort()
1697
1598
            for subf in fl:
1698
1599
                subp = pathjoin(path, subf)
1735
1636
        r"""Check whether the filename matches an ignore pattern.
1736
1637
 
1737
1638
        Patterns containing '/' or '\' need to match the whole path;
1738
 
        others match against only the last component.  Patterns starting
1739
 
        with '!' are ignore exceptions.  Exceptions take precedence
1740
 
        over regular patterns and cause the filename to not be ignored.
 
1639
        others match against only the last component.
1741
1640
 
1742
1641
        If the file is ignored, returns the pattern which caused it to
1743
1642
        be ignored, otherwise None.  So this can simply be used as a
1744
1643
        boolean if desired."""
1745
1644
        if getattr(self, '_ignoreglobster', None) is None:
1746
 
            self._ignoreglobster = globbing.ExceptionGlobster(self.get_ignore_list())
 
1645
            self._ignoreglobster = globbing.Globster(self.get_ignore_list())
1747
1646
        return self._ignoreglobster.match(filename)
1748
1647
 
1749
1648
    def kind(self, file_id):
1750
1649
        return file_kind(self.id2abspath(file_id))
1751
1650
 
1752
 
    def stored_kind(self, file_id):
1753
 
        """See Tree.stored_kind"""
1754
 
        return self.inventory[file_id].kind
1755
 
 
1756
1651
    def _comparison_data(self, entry, path):
1757
1652
        abspath = self.abspath(path)
1758
1653
        try:
1799
1694
            raise errors.ObjectNotLocked(self)
1800
1695
 
1801
1696
    def lock_read(self):
1802
 
        """Lock the tree for reading.
1803
 
 
1804
 
        This also locks the branch, and can be unlocked via self.unlock().
1805
 
 
1806
 
        :return: A bzrlib.lock.LogicalLockResult.
1807
 
        """
 
1697
        """See Branch.lock_read, and WorkingTree.unlock."""
1808
1698
        if not self.is_locked():
1809
1699
            self._reset_data()
1810
1700
        self.branch.lock_read()
1811
1701
        try:
1812
 
            self._control_files.lock_read()
1813
 
            return LogicalLockResult(self.unlock)
 
1702
            return self._control_files.lock_read()
1814
1703
        except:
1815
1704
            self.branch.unlock()
1816
1705
            raise
1817
1706
 
1818
1707
    def lock_tree_write(self):
1819
 
        """See MutableTree.lock_tree_write, and WorkingTree.unlock.
1820
 
 
1821
 
        :return: A bzrlib.lock.LogicalLockResult.
1822
 
        """
 
1708
        """See MutableTree.lock_tree_write, and WorkingTree.unlock."""
1823
1709
        if not self.is_locked():
1824
1710
            self._reset_data()
1825
1711
        self.branch.lock_read()
1826
1712
        try:
1827
 
            self._control_files.lock_write()
1828
 
            return LogicalLockResult(self.unlock)
 
1713
            return self._control_files.lock_write()
1829
1714
        except:
1830
1715
            self.branch.unlock()
1831
1716
            raise
1832
1717
 
1833
1718
    def lock_write(self):
1834
 
        """See MutableTree.lock_write, and WorkingTree.unlock.
1835
 
 
1836
 
        :return: A bzrlib.lock.LogicalLockResult.
1837
 
        """
 
1719
        """See MutableTree.lock_write, and WorkingTree.unlock."""
1838
1720
        if not self.is_locked():
1839
1721
            self._reset_data()
1840
1722
        self.branch.lock_write()
1841
1723
        try:
1842
 
            self._control_files.lock_write()
1843
 
            return LogicalLockResult(self.unlock)
 
1724
            return self._control_files.lock_write()
1844
1725
        except:
1845
1726
            self.branch.unlock()
1846
1727
            raise
1854
1735
    def _reset_data(self):
1855
1736
        """Reset transient data that cannot be revalidated."""
1856
1737
        self._inventory_is_modified = False
1857
 
        f = self._transport.get('inventory')
1858
 
        try:
1859
 
            result = self._deserialize(f)
1860
 
        finally:
1861
 
            f.close()
 
1738
        result = self._deserialize(self._control_files.get('inventory'))
1862
1739
        self._set_inventory(result, dirty=False)
1863
1740
 
1864
1741
    @needs_tree_write_lock
1869
1746
 
1870
1747
    def _change_last_revision(self, new_revision):
1871
1748
        """Template method part of set_last_revision to perform the change.
1872
 
 
 
1749
        
1873
1750
        This is used to allow WorkingTree3 instances to not affect branch
1874
1751
        when their last revision is set.
1875
1752
        """
1885
1762
 
1886
1763
    def _write_basis_inventory(self, xml):
1887
1764
        """Write the basis inventory XML to the basis-inventory file"""
 
1765
        assert isinstance(xml, str), 'serialised xml must be bytestring.'
1888
1766
        path = self._basis_inventory_name()
1889
1767
        sio = StringIO(xml)
1890
 
        self._transport.put_file(path, sio,
1891
 
            mode=self.bzrdir._get_file_mode())
 
1768
        self._control_files.put(path, sio)
1892
1769
 
1893
1770
    def _create_basis_xml_from_inventory(self, revision_id, inventory):
1894
1771
        """Create the text that will be saved in basis-inventory"""
1901
1778
        # as commit already has that ready-to-use [while the format is the
1902
1779
        # same, that is].
1903
1780
        try:
1904
 
            # this double handles the inventory - unpack and repack -
 
1781
            # this double handles the inventory - unpack and repack - 
1905
1782
            # but is easier to understand. We can/should put a conditional
1906
1783
            # in here based on whether the inventory is in the latest format
1907
1784
            # - perhaps we should repack all inventories on a repository
1908
1785
            # upgrade ?
1909
1786
            # the fast path is to copy the raw xml from the repository. If the
1910
 
            # xml contains 'revision_id="', then we assume the right
 
1787
            # xml contains 'revision_id="', then we assume the right 
1911
1788
            # revision_id is set. We must check for this full string, because a
1912
1789
            # root node id can legitimately look like 'revision_id' but cannot
1913
1790
            # contain a '"'.
1914
 
            xml = self.branch.repository._get_inventory_xml(new_revision)
 
1791
            xml = self.branch.repository.get_inventory_xml(new_revision)
1915
1792
            firstline = xml.split('\n', 1)[0]
1916
 
            if (not 'revision_id="' in firstline or
 
1793
            if (not 'revision_id="' in firstline or 
1917
1794
                'format="7"' not in firstline):
1918
 
                inv = self.branch.repository._serializer.read_inventory_from_string(
1919
 
                    xml, new_revision)
 
1795
                inv = self.branch.repository.deserialise_inventory(
 
1796
                    new_revision, xml)
1920
1797
                xml = self._create_basis_xml_from_inventory(new_revision, inv)
1921
1798
            self._write_basis_inventory(xml)
1922
1799
        except (errors.NoSuchRevision, errors.RevisionNotPresent):
1925
1802
    def read_basis_inventory(self):
1926
1803
        """Read the cached basis inventory."""
1927
1804
        path = self._basis_inventory_name()
1928
 
        return self._transport.get_bytes(path)
1929
 
 
 
1805
        return self._control_files.get(path).read()
 
1806
        
1930
1807
    @needs_read_lock
1931
1808
    def read_working_inventory(self):
1932
1809
        """Read the working inventory.
1933
 
 
 
1810
        
1934
1811
        :raises errors.InventoryModified: read_working_inventory will fail
1935
1812
            when the current in memory inventory has been modified.
1936
1813
        """
1937
 
        # conceptually this should be an implementation detail of the tree.
 
1814
        # conceptually this should be an implementation detail of the tree. 
1938
1815
        # XXX: Deprecate this.
1939
1816
        # ElementTree does its own conversion from UTF-8, so open in
1940
1817
        # binary.
1941
1818
        if self._inventory_is_modified:
1942
1819
            raise errors.InventoryModified(self)
1943
 
        f = self._transport.get('inventory')
1944
 
        try:
1945
 
            result = self._deserialize(f)
1946
 
        finally:
1947
 
            f.close()
 
1820
        result = self._deserialize(self._control_files.get('inventory'))
1948
1821
        self._set_inventory(result, dirty=False)
1949
1822
        return result
1950
1823
 
1965
1838
 
1966
1839
        new_files=set()
1967
1840
        unknown_nested_files=set()
1968
 
        if to_file is None:
1969
 
            to_file = sys.stdout
1970
1841
 
1971
1842
        def recurse_directory_to_add_files(directory):
1972
1843
            # Recurse directory and add all files
1973
1844
            # so we can check if they have changed.
1974
 
            for parent_info, file_infos in self.walkdirs(directory):
1975
 
                for relpath, basename, kind, lstat, fileid, kind in file_infos:
 
1845
            for parent_info, file_infos in\
 
1846
                osutils.walkdirs(self.abspath(directory),
 
1847
                    directory):
 
1848
                for relpath, basename, kind, lstat, abspath in file_infos:
1976
1849
                    # Is it versioned or ignored?
1977
1850
                    if self.path2id(relpath) or self.is_ignored(relpath):
1978
1851
                        # Add nested content for deletion.
1988
1861
            filename = self.relpath(abspath)
1989
1862
            if len(filename) > 0:
1990
1863
                new_files.add(filename)
1991
 
                recurse_directory_to_add_files(filename)
 
1864
                if osutils.isdir(abspath):
 
1865
                    recurse_directory_to_add_files(filename)
1992
1866
 
1993
1867
        files = list(new_files)
1994
1868
 
2003
1877
            has_changed_files = len(unknown_nested_files) > 0
2004
1878
            if not has_changed_files:
2005
1879
                for (file_id, path, content_change, versioned, parent_id, name,
2006
 
                     kind, executable) in self.iter_changes(self.basis_tree(),
 
1880
                     kind, executable) in self._iter_changes(self.basis_tree(),
2007
1881
                         include_unchanged=True, require_versioned=False,
2008
1882
                         want_unversioned=True, specific_files=files):
2009
 
                    if versioned == (False, False):
2010
 
                        # The record is unknown ...
2011
 
                        if not self.is_ignored(path[1]):
2012
 
                            # ... but not ignored
2013
 
                            has_changed_files = True
2014
 
                            break
2015
 
                    elif (content_change and (kind[1] is not None) and
2016
 
                            osutils.is_inside_any(files, path[1])):
2017
 
                        # Versioned and changed, but not deleted, and still
2018
 
                        # in one of the dirs to be deleted.
 
1883
                    # Check if it's an unknown (but not ignored) OR
 
1884
                    # changed (but not deleted) :
 
1885
                    if not self.is_ignored(path[1]) and (
 
1886
                        versioned == (False, False) or
 
1887
                        content_change and kind[1] != None):
2019
1888
                        has_changed_files = True
2020
1889
                        break
2021
1890
 
2029
1898
                        tree_delta.unversioned.extend((unknown_file,))
2030
1899
                raise errors.BzrRemoveChangedFilesError(tree_delta)
2031
1900
 
2032
 
        # Build inv_delta and delete files where applicable,
 
1901
        # Build inv_delta and delete files where applicaple,
2033
1902
        # do this before any modifications to inventory.
2034
1903
        for f in files:
2035
1904
            fid = self.path2id(f)
2043
1912
                        new_status = 'I'
2044
1913
                    else:
2045
1914
                        new_status = '?'
2046
 
                    # XXX: Really should be a more abstract reporter interface
2047
 
                    kind_ch = osutils.kind_marker(self.kind(fid))
2048
 
                    to_file.write(new_status + '       ' + f + kind_ch + '\n')
 
1915
                    textui.show_status(new_status, self.kind(fid), f,
 
1916
                                       to_file=to_file)
2049
1917
                # Unversion file
2050
1918
                inv_delta.append((f, None, fid, None))
2051
1919
                message = "removed %s" % (f,)
2074
1942
 
2075
1943
    @needs_tree_write_lock
2076
1944
    def revert(self, filenames=None, old_tree=None, backups=True,
2077
 
               pb=None, report_changes=False):
 
1945
               pb=DummyProgress(), report_changes=False):
2078
1946
        from bzrlib.conflicts import resolve
2079
1947
        if filenames == []:
2080
1948
            filenames = None
2082
1950
                ' as of bzr 0.91.  Please use None (the default) instead.',
2083
1951
                DeprecationWarning, stacklevel=2)
2084
1952
        if old_tree is None:
2085
 
            basis_tree = self.basis_tree()
2086
 
            basis_tree.lock_read()
2087
 
            old_tree = basis_tree
 
1953
            old_tree = self.basis_tree()
 
1954
        conflicts = transform.revert(self, old_tree, filenames, backups, pb,
 
1955
                                     report_changes)
 
1956
        if filenames is None:
 
1957
            self.set_parent_ids(self.get_parent_ids()[:1])
 
1958
            resolve(self)
2088
1959
        else:
2089
 
            basis_tree = None
2090
 
        try:
2091
 
            conflicts = transform.revert(self, old_tree, filenames, backups, pb,
2092
 
                                         report_changes)
2093
 
            if filenames is None and len(self.get_parent_ids()) > 1:
2094
 
                parent_trees = []
2095
 
                last_revision = self.last_revision()
2096
 
                if last_revision != _mod_revision.NULL_REVISION:
2097
 
                    if basis_tree is None:
2098
 
                        basis_tree = self.basis_tree()
2099
 
                        basis_tree.lock_read()
2100
 
                    parent_trees.append((last_revision, basis_tree))
2101
 
                self.set_parent_trees(parent_trees)
2102
 
                resolve(self)
2103
 
            else:
2104
 
                resolve(self, filenames, ignore_misses=True, recursive=True)
2105
 
        finally:
2106
 
            if basis_tree is not None:
2107
 
                basis_tree.unlock()
 
1960
            resolve(self, filenames, ignore_misses=True)
2108
1961
        return conflicts
2109
1962
 
2110
1963
    def revision_tree(self, revision_id):
2137
1990
    def set_inventory(self, new_inventory_list):
2138
1991
        from bzrlib.inventory import (Inventory,
2139
1992
                                      InventoryDirectory,
 
1993
                                      InventoryEntry,
2140
1994
                                      InventoryFile,
2141
1995
                                      InventoryLink)
2142
1996
        inv = Inventory(self.get_root_id())
2144
1998
            name = os.path.basename(path)
2145
1999
            if name == "":
2146
2000
                continue
2147
 
            # fixme, there should be a factory function inv,add_??
 
2001
            # fixme, there should be a factory function inv,add_?? 
2148
2002
            if kind == 'directory':
2149
2003
                inv.add(InventoryDirectory(file_id, name, parent))
2150
2004
            elif kind == 'file':
2158
2012
    @needs_tree_write_lock
2159
2013
    def set_root_id(self, file_id):
2160
2014
        """Set the root id for this tree."""
2161
 
        # for compatability
 
2015
        # for compatability 
2162
2016
        if file_id is None:
2163
 
            raise ValueError(
2164
 
                'WorkingTree.set_root_id with fileid=None')
2165
 
        file_id = osutils.safe_file_id(file_id)
 
2017
            symbol_versioning.warn(symbol_versioning.zero_twelve
 
2018
                % 'WorkingTree.set_root_id with fileid=None',
 
2019
                DeprecationWarning,
 
2020
                stacklevel=3)
 
2021
            file_id = ROOT_ID
 
2022
        else:
 
2023
            file_id = osutils.safe_file_id(file_id)
2166
2024
        self._set_root_id(file_id)
2167
2025
 
2168
2026
    def _set_root_id(self, file_id):
2169
2027
        """Set the root id for this tree, in a format specific manner.
2170
2028
 
2171
 
        :param file_id: The file id to assign to the root. It must not be
 
2029
        :param file_id: The file id to assign to the root. It must not be 
2172
2030
            present in the current inventory or an error will occur. It must
2173
2031
            not be None, but rather a valid file id.
2174
2032
        """
2193
2051
 
2194
2052
    def unlock(self):
2195
2053
        """See Branch.unlock.
2196
 
 
 
2054
        
2197
2055
        WorkingTree locking just uses the Branch locking facilities.
2198
2056
        This is current because all working trees have an embedded branch
2199
2057
        within them. IF in the future, we were to make branch data shareable
2200
 
        between multiple working trees, i.e. via shared storage, then we
 
2058
        between multiple working trees, i.e. via shared storage, then we 
2201
2059
        would probably want to lock both the local tree, and the branch.
2202
2060
        """
2203
2061
        raise NotImplementedError(self.unlock)
2204
2062
 
2205
 
    _marker = object()
2206
 
 
2207
 
    def update(self, change_reporter=None, possible_transports=None,
2208
 
               revision=None, old_tip=_marker):
 
2063
    def update(self, change_reporter=None, possible_transports=None):
2209
2064
        """Update a working tree along its branch.
2210
2065
 
2211
2066
        This will update the branch if its bound too, which means we have
2229
2084
        - Merge current state -> basis tree of the master w.r.t. the old tree
2230
2085
          basis.
2231
2086
        - Do a 'normal' merge of the old branch basis if it is relevant.
2232
 
 
2233
 
        :param revision: The target revision to update to. Must be in the
2234
 
            revision history.
2235
 
        :param old_tip: If branch.update() has already been run, the value it
2236
 
            returned (old tip of the branch or None). _marker is used
2237
 
            otherwise.
2238
2087
        """
2239
 
        if self.branch.get_bound_location() is not None:
 
2088
        if self.branch.get_master_branch(possible_transports) is not None:
2240
2089
            self.lock_write()
2241
 
            update_branch = (old_tip is self._marker)
 
2090
            update_branch = True
2242
2091
        else:
2243
2092
            self.lock_tree_write()
2244
2093
            update_branch = False
2246
2095
            if update_branch:
2247
2096
                old_tip = self.branch.update(possible_transports)
2248
2097
            else:
2249
 
                if old_tip is self._marker:
2250
 
                    old_tip = None
2251
 
            return self._update_tree(old_tip, change_reporter, revision)
 
2098
                old_tip = None
 
2099
            return self._update_tree(old_tip, change_reporter)
2252
2100
        finally:
2253
2101
            self.unlock()
2254
2102
 
2255
2103
    @needs_tree_write_lock
2256
 
    def _update_tree(self, old_tip=None, change_reporter=None, revision=None):
 
2104
    def _update_tree(self, old_tip=None, change_reporter=None):
2257
2105
        """Update a tree to the master branch.
2258
2106
 
2259
2107
        :param old_tip: if supplied, the previous tip revision the branch,
2265
2113
        # cant set that until we update the working trees last revision to be
2266
2114
        # one from the new branch, because it will just get absorbed by the
2267
2115
        # parent de-duplication logic.
2268
 
        #
 
2116
        # 
2269
2117
        # We MUST save it even if an error occurs, because otherwise the users
2270
2118
        # local work is unreferenced and will appear to have been lost.
2271
 
        #
2272
 
        nb_conflicts = 0
 
2119
        # 
 
2120
        result = 0
2273
2121
        try:
2274
2122
            last_rev = self.get_parent_ids()[0]
2275
2123
        except IndexError:
2276
2124
            last_rev = _mod_revision.NULL_REVISION
2277
 
        if revision is None:
2278
 
            revision = self.branch.last_revision()
2279
 
 
2280
 
        old_tip = old_tip or _mod_revision.NULL_REVISION
2281
 
 
2282
 
        if not _mod_revision.is_null(old_tip) and old_tip != last_rev:
2283
 
            # the branch we are bound to was updated
2284
 
            # merge those changes in first
2285
 
            base_tree  = self.basis_tree()
2286
 
            other_tree = self.branch.repository.revision_tree(old_tip)
2287
 
            nb_conflicts = merge.merge_inner(self.branch, other_tree,
2288
 
                                             base_tree, this_tree=self,
2289
 
                                             change_reporter=change_reporter)
2290
 
            if nb_conflicts:
2291
 
                self.add_parent_tree((old_tip, other_tree))
2292
 
                trace.note('Rerun update after fixing the conflicts.')
2293
 
                return nb_conflicts
2294
 
 
2295
 
        if last_rev != _mod_revision.ensure_null(revision):
2296
 
            # the working tree is up to date with the branch
2297
 
            # we can merge the specified revision from master
2298
 
            to_tree = self.branch.repository.revision_tree(revision)
2299
 
            to_root_id = to_tree.get_root_id()
2300
 
 
 
2125
        if last_rev != _mod_revision.ensure_null(self.branch.last_revision()):
 
2126
            # merge tree state up to new branch tip.
2301
2127
            basis = self.basis_tree()
2302
2128
            basis.lock_read()
2303
2129
            try:
2304
 
                if (basis.inventory.root is None
2305
 
                    or basis.inventory.root.file_id != to_root_id):
2306
 
                    self.set_root_id(to_root_id)
 
2130
                to_tree = self.branch.basis_tree()
 
2131
                if basis.inventory.root is None:
 
2132
                    self.set_root_id(to_tree.inventory.root.file_id)
2307
2133
                    self.flush()
 
2134
                result += merge.merge_inner(
 
2135
                                      self.branch,
 
2136
                                      to_tree,
 
2137
                                      basis,
 
2138
                                      this_tree=self,
 
2139
                                      change_reporter=change_reporter)
2308
2140
            finally:
2309
2141
                basis.unlock()
2310
 
 
2311
 
            # determine the branch point
2312
 
            graph = self.branch.repository.get_graph()
2313
 
            base_rev_id = graph.find_unique_lca(self.branch.last_revision(),
2314
 
                                                last_rev)
2315
 
            base_tree = self.branch.repository.revision_tree(base_rev_id)
2316
 
 
2317
 
            nb_conflicts = merge.merge_inner(self.branch, to_tree, base_tree,
2318
 
                                             this_tree=self,
2319
 
                                             change_reporter=change_reporter)
2320
 
            self.set_last_revision(revision)
2321
2142
            # TODO - dedup parents list with things merged by pull ?
2322
2143
            # reuse the tree we've updated to to set the basis:
2323
 
            parent_trees = [(revision, to_tree)]
 
2144
            parent_trees = [(self.branch.last_revision(), to_tree)]
2324
2145
            merges = self.get_parent_ids()[1:]
2325
2146
            # Ideally we ask the tree for the trees here, that way the working
2326
 
            # tree can decide whether to give us the entire tree or give us a
 
2147
            # tree can decide whether to give us teh entire tree or give us a
2327
2148
            # lazy initialised tree. dirstate for instance will have the trees
2328
2149
            # in ram already, whereas a last-revision + basis-inventory tree
2329
2150
            # will not, but also does not need them when setting parents.
2330
2151
            for parent in merges:
2331
2152
                parent_trees.append(
2332
2153
                    (parent, self.branch.repository.revision_tree(parent)))
2333
 
            if not _mod_revision.is_null(old_tip):
 
2154
            if (old_tip is not None and not _mod_revision.is_null(old_tip)):
2334
2155
                parent_trees.append(
2335
2156
                    (old_tip, self.branch.repository.revision_tree(old_tip)))
2336
2157
            self.set_parent_trees(parent_trees)
2337
2158
            last_rev = parent_trees[0][0]
2338
 
        return nb_conflicts
 
2159
        else:
 
2160
            # the working tree had the same last-revision as the master
 
2161
            # branch did. We may still have pivot local work from the local
 
2162
            # branch into old_tip:
 
2163
            if (old_tip is not None and not _mod_revision.is_null(old_tip)):
 
2164
                self.add_parent_tree_id(old_tip)
 
2165
        if (old_tip is not None and not _mod_revision.is_null(old_tip)
 
2166
            and old_tip != last_rev):
 
2167
            # our last revision was not the prior branch last revision
 
2168
            # and we have converted that last revision to a pending merge.
 
2169
            # base is somewhere between the branch tip now
 
2170
            # and the now pending merge
 
2171
 
 
2172
            # Since we just modified the working tree and inventory, flush out
 
2173
            # the current state, before we modify it again.
 
2174
            # TODO: jam 20070214 WorkingTree3 doesn't require this, dirstate
 
2175
            #       requires it only because TreeTransform directly munges the
 
2176
            #       inventory and calls tree._write_inventory(). Ultimately we
 
2177
            #       should be able to remove this extra flush.
 
2178
            self.flush()
 
2179
            graph = self.branch.repository.get_graph()
 
2180
            base_rev_id = graph.find_unique_lca(self.branch.last_revision(),
 
2181
                                                old_tip)
 
2182
            base_tree = self.branch.repository.revision_tree(base_rev_id)
 
2183
            other_tree = self.branch.repository.revision_tree(old_tip)
 
2184
            result += merge.merge_inner(
 
2185
                                  self.branch,
 
2186
                                  other_tree,
 
2187
                                  base_tree,
 
2188
                                  this_tree=self,
 
2189
                                  change_reporter=change_reporter)
 
2190
        return result
2339
2191
 
2340
2192
    def _write_hashcache_if_dirty(self):
2341
2193
        """Write out the hashcache if it is dirty."""
2425
2277
            current_inv = None
2426
2278
            inv_finished = True
2427
2279
        while not inv_finished or not disk_finished:
2428
 
            if current_disk:
2429
 
                ((cur_disk_dir_relpath, cur_disk_dir_path_from_top),
2430
 
                    cur_disk_dir_content) = current_disk
2431
 
            else:
2432
 
                ((cur_disk_dir_relpath, cur_disk_dir_path_from_top),
2433
 
                    cur_disk_dir_content) = ((None, None), None)
2434
2280
            if not disk_finished:
2435
2281
                # strip out .bzr dirs
2436
 
                if (cur_disk_dir_path_from_top[top_strip_len:] == '' and
2437
 
                    len(cur_disk_dir_content) > 0):
2438
 
                    # osutils.walkdirs can be made nicer -
 
2282
                if current_disk[0][1][top_strip_len:] == '':
 
2283
                    # osutils.walkdirs can be made nicer - 
2439
2284
                    # yield the path-from-prefix rather than the pathjoined
2440
2285
                    # value.
2441
 
                    bzrdir_loc = bisect_left(cur_disk_dir_content,
2442
 
                        ('.bzr', '.bzr'))
2443
 
                    if (bzrdir_loc < len(cur_disk_dir_content)
2444
 
                        and self.bzrdir.is_control_filename(
2445
 
                            cur_disk_dir_content[bzrdir_loc][0])):
 
2286
                    bzrdir_loc = bisect_left(current_disk[1], ('.bzr', '.bzr'))
 
2287
                    if current_disk[1][bzrdir_loc][0] == '.bzr':
2446
2288
                        # we dont yield the contents of, or, .bzr itself.
2447
 
                        del cur_disk_dir_content[bzrdir_loc]
 
2289
                        del current_disk[1][bzrdir_loc]
2448
2290
            if inv_finished:
2449
2291
                # everything is unknown
2450
2292
                direction = 1
2452
2294
                # everything is missing
2453
2295
                direction = -1
2454
2296
            else:
2455
 
                direction = cmp(current_inv[0][0], cur_disk_dir_relpath)
 
2297
                direction = cmp(current_inv[0][0], current_disk[0][0])
2456
2298
            if direction > 0:
2457
2299
                # disk is before inventory - unknown
2458
2300
                dirblock = [(relpath, basename, kind, stat, None, None) for
2459
 
                    relpath, basename, kind, stat, top_path in
2460
 
                    cur_disk_dir_content]
2461
 
                yield (cur_disk_dir_relpath, None), dirblock
 
2301
                    relpath, basename, kind, stat, top_path in current_disk[1]]
 
2302
                yield (current_disk[0][0], None), dirblock
2462
2303
                try:
2463
2304
                    current_disk = disk_iterator.next()
2464
2305
                except StopIteration:
2466
2307
            elif direction < 0:
2467
2308
                # inventory is before disk - missing.
2468
2309
                dirblock = [(relpath, basename, 'unknown', None, fileid, kind)
2469
 
                    for relpath, basename, dkind, stat, fileid, kind in
 
2310
                    for relpath, basename, dkind, stat, fileid, kind in 
2470
2311
                    current_inv[1]]
2471
2312
                yield (current_inv[0][0], current_inv[0][1]), dirblock
2472
2313
                try:
2478
2319
                # merge the inventory and disk data together
2479
2320
                dirblock = []
2480
2321
                for relpath, subiterator in itertools.groupby(sorted(
2481
 
                    current_inv[1] + cur_disk_dir_content,
2482
 
                    key=operator.itemgetter(0)), operator.itemgetter(1)):
 
2322
                    current_inv[1] + current_disk[1], key=operator.itemgetter(0)), operator.itemgetter(1)):
2483
2323
                    path_elements = list(subiterator)
2484
2324
                    if len(path_elements) == 2:
2485
2325
                        inv_row, disk_row = path_elements
2538
2378
                relroot = ""
2539
2379
            # FIXME: stash the node in pending
2540
2380
            entry = inv[top_id]
2541
 
            if entry.kind == 'directory':
2542
 
                for name, child in entry.sorted_children():
2543
 
                    dirblock.append((relroot + name, name, child.kind, None,
2544
 
                        child.file_id, child.kind
2545
 
                        ))
 
2381
            for name, child in entry.sorted_children():
 
2382
                dirblock.append((relroot + name, name, child.kind, None,
 
2383
                    child.file_id, child.kind
 
2384
                    ))
2546
2385
            yield (currentdir[0], entry.file_id), dirblock
2547
2386
            # push the user specified dirs from dirblock
2548
2387
            for dir in reversed(dirblock):
2581
2420
        self.set_conflicts(un_resolved)
2582
2421
        return un_resolved, resolved
2583
2422
 
2584
 
    @needs_read_lock
2585
 
    def _check(self, references):
2586
 
        """Check the tree for consistency.
2587
 
 
2588
 
        :param references: A dict with keys matching the items returned by
2589
 
            self._get_check_refs(), and values from looking those keys up in
2590
 
            the repository.
2591
 
        """
2592
 
        tree_basis = self.basis_tree()
2593
 
        tree_basis.lock_read()
2594
 
        try:
2595
 
            repo_basis = references[('trees', self.last_revision())]
2596
 
            if len(list(repo_basis.iter_changes(tree_basis))) > 0:
2597
 
                raise errors.BzrCheckError(
2598
 
                    "Mismatched basis inventory content.")
2599
 
            self._validate()
2600
 
        finally:
2601
 
            tree_basis.unlock()
2602
 
 
2603
2423
    def _validate(self):
2604
2424
        """Validate internal structures.
2605
2425
 
2611
2431
        """
2612
2432
        return
2613
2433
 
2614
 
    def _get_rules_searcher(self, default_searcher):
2615
 
        """See Tree._get_rules_searcher."""
2616
 
        if self._rules_searcher is None:
2617
 
            self._rules_searcher = super(WorkingTree,
2618
 
                self)._get_rules_searcher(default_searcher)
2619
 
        return self._rules_searcher
2620
 
 
2621
 
    def get_shelf_manager(self):
2622
 
        """Return the ShelfManager for this WorkingTree."""
2623
 
        from bzrlib.shelf import ShelfManager
2624
 
        return ShelfManager(self, self._transport)
2625
 
 
2626
2434
 
2627
2435
class WorkingTree2(WorkingTree):
2628
2436
    """This is the Format 2 working tree.
2629
2437
 
2630
 
    This was the first weave based working tree.
 
2438
    This was the first weave based working tree. 
2631
2439
     - uses os locks for locking.
2632
2440
     - uses the branch last-revision.
2633
2441
    """
2643
2451
        if self._inventory is None:
2644
2452
            self.read_working_inventory()
2645
2453
 
2646
 
    def _get_check_refs(self):
2647
 
        """Return the references needed to perform a check of this tree."""
2648
 
        return [('trees', self.last_revision())]
2649
 
 
2650
2454
    def lock_tree_write(self):
2651
2455
        """See WorkingTree.lock_tree_write().
2652
2456
 
2653
2457
        In Format2 WorkingTrees we have a single lock for the branch and tree
2654
2458
        so lock_tree_write() degrades to lock_write().
2655
 
 
2656
 
        :return: An object with an unlock method which will release the lock
2657
 
            obtained.
2658
2459
        """
2659
2460
        self.branch.lock_write()
2660
2461
        try:
2661
 
            self._control_files.lock_write()
2662
 
            return self
 
2462
            return self._control_files.lock_write()
2663
2463
        except:
2664
2464
            self.branch.unlock()
2665
2465
            raise
2674
2474
            if self._inventory_is_modified:
2675
2475
                self.flush()
2676
2476
            self._write_hashcache_if_dirty()
2677
 
 
 
2477
                    
2678
2478
        # reverse order of locking.
2679
2479
        try:
2680
2480
            return self._control_files.unlock()
2696
2496
    def _last_revision(self):
2697
2497
        """See Mutable.last_revision."""
2698
2498
        try:
2699
 
            return self._transport.get_bytes('last-revision')
 
2499
            return self._control_files.get('last-revision').read()
2700
2500
        except errors.NoSuchFile:
2701
2501
            return _mod_revision.NULL_REVISION
2702
2502
 
2703
2503
    def _change_last_revision(self, revision_id):
2704
2504
        """See WorkingTree._change_last_revision."""
2705
 
        if revision_id is None or revision_id == _mod_revision.NULL_REVISION:
 
2505
        if revision_id is None or revision_id == NULL_REVISION:
2706
2506
            try:
2707
 
                self._transport.delete('last-revision')
 
2507
                self._control_files._transport.delete('last-revision')
2708
2508
            except errors.NoSuchFile:
2709
2509
                pass
2710
2510
            return False
2711
2511
        else:
2712
 
            self._transport.put_bytes('last-revision', revision_id,
2713
 
                mode=self.bzrdir._get_file_mode())
 
2512
            self._control_files.put_bytes('last-revision', revision_id)
2714
2513
            return True
2715
2514
 
2716
 
    def _get_check_refs(self):
2717
 
        """Return the references needed to perform a check of this tree."""
2718
 
        return [('trees', self.last_revision())]
2719
 
 
2720
2515
    @needs_tree_write_lock
2721
2516
    def set_conflicts(self, conflicts):
2722
 
        self._put_rio('conflicts', conflicts.to_stanzas(),
 
2517
        self._put_rio('conflicts', conflicts.to_stanzas(), 
2723
2518
                      CONFLICT_HEADER_1)
2724
2519
 
2725
2520
    @needs_tree_write_lock
2732
2527
    @needs_read_lock
2733
2528
    def conflicts(self):
2734
2529
        try:
2735
 
            confile = self._transport.get('conflicts')
 
2530
            confile = self._control_files.get('conflicts')
2736
2531
        except errors.NoSuchFile:
2737
2532
            return _mod_conflicts.ConflictList()
2738
2533
        try:
2739
 
            try:
2740
 
                if confile.next() != CONFLICT_HEADER_1 + '\n':
2741
 
                    raise errors.ConflictFormatError()
2742
 
            except StopIteration:
 
2534
            if confile.next() != CONFLICT_HEADER_1 + '\n':
2743
2535
                raise errors.ConflictFormatError()
2744
 
            return _mod_conflicts.ConflictList.from_stanzas(RioReader(confile))
2745
 
        finally:
2746
 
            confile.close()
 
2536
        except StopIteration:
 
2537
            raise errors.ConflictFormatError()
 
2538
        return _mod_conflicts.ConflictList.from_stanzas(RioReader(confile))
2747
2539
 
2748
2540
    def unlock(self):
2749
2541
        # do non-implementation specific cleanup
2766
2558
            return path[:-len(suffix)]
2767
2559
 
2768
2560
 
 
2561
@deprecated_function(zero_eight)
 
2562
def is_control_file(filename):
 
2563
    """See WorkingTree.is_control_filename(filename)."""
 
2564
    ## FIXME: better check
 
2565
    filename = normpath(filename)
 
2566
    while filename != '':
 
2567
        head, tail = os.path.split(filename)
 
2568
        ## mutter('check %r for control file' % ((head, tail),))
 
2569
        if tail == '.bzr':
 
2570
            return True
 
2571
        if filename == head:
 
2572
            break
 
2573
        filename = head
 
2574
    return False
 
2575
 
 
2576
 
2769
2577
class WorkingTreeFormat(object):
2770
2578
    """An encapsulation of the initialization and open routines for a format.
2771
2579
 
2774
2582
     * a format string,
2775
2583
     * an open routine.
2776
2584
 
2777
 
    Formats are placed in an dict by their format string for reference
 
2585
    Formats are placed in an dict by their format string for reference 
2778
2586
    during workingtree opening. Its not required that these be instances, they
2779
 
    can be classes themselves with class methods - it simply depends on
 
2587
    can be classes themselves with class methods - it simply depends on 
2780
2588
    whether state is needed for a given format or not.
2781
2589
 
2782
2590
    Once a format is deprecated, just deprecate the initialize and open
2783
 
    methods on the format class. Do not deprecate the object, as the
 
2591
    methods on the format class. Do not deprecate the object, as the 
2784
2592
    object will be created every time regardless.
2785
2593
    """
2786
2594
 
2799
2607
        """Return the format for the working tree object in a_bzrdir."""
2800
2608
        try:
2801
2609
            transport = a_bzrdir.get_workingtree_transport(None)
2802
 
            format_string = transport.get_bytes("format")
 
2610
            format_string = transport.get("format").read()
2803
2611
            return klass._formats[format_string]
2804
2612
        except errors.NoSuchFile:
2805
2613
            raise errors.NoWorkingTree(base=transport.base)
2806
2614
        except KeyError:
2807
 
            raise errors.UnknownFormatError(format=format_string,
2808
 
                                            kind="working tree")
 
2615
            raise errors.UnknownFormatError(format=format_string)
2809
2616
 
2810
2617
    def __eq__(self, other):
2811
2618
        return self.__class__ is other.__class__
2830
2637
        """Is this format supported?
2831
2638
 
2832
2639
        Supported formats can be initialized and opened.
2833
 
        Unsupported formats may not support initialization or committing or
 
2640
        Unsupported formats may not support initialization or committing or 
2834
2641
        some other features depending on the reason for not being supported.
2835
2642
        """
2836
2643
        return True
2837
2644
 
2838
 
    def supports_content_filtering(self):
2839
 
        """True if this format supports content filtering."""
2840
 
        return False
2841
 
 
2842
 
    def supports_views(self):
2843
 
        """True if this format supports stored views."""
2844
 
        return False
2845
 
 
2846
2645
    @classmethod
2847
2646
    def register_format(klass, format):
2848
2647
        klass._formats[format.get_format_string()] = format
2853
2652
 
2854
2653
    @classmethod
2855
2654
    def unregister_format(klass, format):
 
2655
        assert klass._formats[format.get_format_string()] is format
2856
2656
        del klass._formats[format.get_format_string()]
2857
2657
 
2858
2658
 
2859
2659
class WorkingTreeFormat2(WorkingTreeFormat):
2860
 
    """The second working tree format.
 
2660
    """The second working tree format. 
2861
2661
 
2862
2662
    This format modified the hash cache from the format 1 hash cache.
2863
2663
    """
2868
2668
        """See WorkingTreeFormat.get_format_description()."""
2869
2669
        return "Working tree format 2"
2870
2670
 
2871
 
    def _stub_initialize_on_transport(self, transport, file_mode):
2872
 
        """Workaround: create control files for a remote working tree.
2873
 
 
 
2671
    def stub_initialize_remote(self, control_files):
 
2672
        """As a special workaround create critical control files for a remote working tree
 
2673
        
2874
2674
        This ensures that it can later be updated and dealt with locally,
2875
 
        since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
 
2675
        since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with 
2876
2676
        no working tree.  (See bug #43064).
2877
2677
        """
2878
2678
        sio = StringIO()
2879
 
        inv = inventory.Inventory()
 
2679
        inv = Inventory()
2880
2680
        xml5.serializer_v5.write_inventory(inv, sio, working=True)
2881
2681
        sio.seek(0)
2882
 
        transport.put_file('inventory', sio, file_mode)
2883
 
        transport.put_bytes('pending-merges', '', file_mode)
2884
 
 
2885
 
    def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
2886
 
                   accelerator_tree=None, hardlink=False):
 
2682
        control_files.put('inventory', sio)
 
2683
 
 
2684
        control_files.put_bytes('pending-merges', '')
 
2685
        
 
2686
 
 
2687
    def initialize(self, a_bzrdir, revision_id=None):
2887
2688
        """See WorkingTreeFormat.initialize()."""
2888
2689
        if not isinstance(a_bzrdir.transport, LocalTransport):
2889
2690
            raise errors.NotLocalUrl(a_bzrdir.transport.base)
2890
 
        if from_branch is not None:
2891
 
            branch = from_branch
2892
 
        else:
2893
 
            branch = a_bzrdir.open_branch()
 
2691
        branch = a_bzrdir.open_branch()
2894
2692
        if revision_id is None:
2895
2693
            revision_id = _mod_revision.ensure_null(branch.last_revision())
2896
2694
        branch.lock_write()
2898
2696
            branch.generate_revision_history(revision_id)
2899
2697
        finally:
2900
2698
            branch.unlock()
2901
 
        inv = inventory.Inventory()
 
2699
        inv = Inventory()
2902
2700
        wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2903
2701
                         branch,
2904
2702
                         inv,
2907
2705
                         _bzrdir=a_bzrdir)
2908
2706
        basis_tree = branch.repository.revision_tree(revision_id)
2909
2707
        if basis_tree.inventory.root is not None:
2910
 
            wt.set_root_id(basis_tree.get_root_id())
 
2708
            wt.set_root_id(basis_tree.inventory.root.file_id)
2911
2709
        # set the parent list and cache the basis tree.
2912
2710
        if _mod_revision.is_null(revision_id):
2913
2711
            parent_trees = []
2949
2747
        - is new in bzr 0.8
2950
2748
        - uses a LockDir to guard access for writes.
2951
2749
    """
2952
 
 
 
2750
    
2953
2751
    upgrade_recommended = True
2954
2752
 
2955
2753
    def get_format_string(self):
2972
2770
 
2973
2771
    def _open_control_files(self, a_bzrdir):
2974
2772
        transport = a_bzrdir.get_workingtree_transport(None)
2975
 
        return LockableFiles(transport, self._lock_file_name,
 
2773
        return LockableFiles(transport, self._lock_file_name, 
2976
2774
                             self._lock_class)
2977
2775
 
2978
 
    def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
2979
 
                   accelerator_tree=None, hardlink=False):
 
2776
    def initialize(self, a_bzrdir, revision_id=None):
2980
2777
        """See WorkingTreeFormat.initialize().
2981
 
 
2982
 
        :param revision_id: if supplied, create a working tree at a different
2983
 
            revision than the branch is at.
2984
 
        :param accelerator_tree: A tree which can be used for retrieving file
2985
 
            contents more quickly than the revision tree, i.e. a workingtree.
2986
 
            The revision tree will be used for cases where accelerator_tree's
2987
 
            content is different.
2988
 
        :param hardlink: If true, hard-link files from accelerator_tree,
2989
 
            where possible.
 
2778
        
 
2779
        revision_id allows creating a working tree at a different
 
2780
        revision than the branch is at.
2990
2781
        """
2991
2782
        if not isinstance(a_bzrdir.transport, LocalTransport):
2992
2783
            raise errors.NotLocalUrl(a_bzrdir.transport.base)
2994
2785
        control_files = self._open_control_files(a_bzrdir)
2995
2786
        control_files.create_lock()
2996
2787
        control_files.lock_write()
2997
 
        transport.put_bytes('format', self.get_format_string(),
2998
 
            mode=a_bzrdir._get_file_mode())
2999
 
        if from_branch is not None:
3000
 
            branch = from_branch
3001
 
        else:
3002
 
            branch = a_bzrdir.open_branch()
 
2788
        control_files.put_utf8('format', self.get_format_string())
 
2789
        branch = a_bzrdir.open_branch()
3003
2790
        if revision_id is None:
3004
2791
            revision_id = _mod_revision.ensure_null(branch.last_revision())
3005
2792
        # WorkingTree3 can handle an inventory which has a unique root id.
3020
2807
            basis_tree = branch.repository.revision_tree(revision_id)
3021
2808
            # only set an explicit root id if there is one to set.
3022
2809
            if basis_tree.inventory.root is not None:
3023
 
                wt.set_root_id(basis_tree.get_root_id())
3024
 
            if revision_id == _mod_revision.NULL_REVISION:
 
2810
                wt.set_root_id(basis_tree.inventory.root.file_id)
 
2811
            if revision_id == NULL_REVISION:
3025
2812
                wt.set_parent_trees([])
3026
2813
            else:
3027
2814
                wt.set_parent_trees([(revision_id, basis_tree)])
3034
2821
        return wt
3035
2822
 
3036
2823
    def _initial_inventory(self):
3037
 
        return inventory.Inventory()
 
2824
        return Inventory()
3038
2825
 
3039
2826
    def __init__(self):
3040
2827
        super(WorkingTreeFormat3, self).__init__()
3055
2842
 
3056
2843
    def _open(self, a_bzrdir, control_files):
3057
2844
        """Open the tree itself.
3058
 
 
 
2845
        
3059
2846
        :param a_bzrdir: the dir for the tree.
3060
2847
        :param control_files: the control files for the tree.
3061
2848
        """
3069
2856
        return self.get_format_string()
3070
2857
 
3071
2858
 
3072
 
__default_format = WorkingTreeFormat6()
 
2859
__default_format = WorkingTreeFormat4()
3073
2860
WorkingTreeFormat.register_format(__default_format)
3074
 
WorkingTreeFormat.register_format(WorkingTreeFormat5())
3075
 
WorkingTreeFormat.register_format(WorkingTreeFormat4())
3076
2861
WorkingTreeFormat.register_format(WorkingTreeFormat3())
3077
2862
WorkingTreeFormat.set_default_format(__default_format)
3078
2863
# formats which have no format string are not discoverable