/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: Robert Collins
  • Date: 2007-10-05 02:41:37 UTC
  • mto: (2592.3.166 repository)
  • mto: This revision was merged to the branch mainline in revision 2896.
  • Revision ID: robertc@robertcollins.net-20071005024137-kn7brcu07nu8cwl1
* The class ``bzrlib.repofmt.knitrepo.KnitRepository3`` has been folded into
  ``KnitRepository`` by parameters to the constructor. (Robert Collins)
* ``bzrlib.xml_serializer.Serializer`` is now responsible for checking that
  mandatory attributes are present on serialisation and deserialisation.
  This fixes some holes in API usage and allows better separation between
  physical storage and object serialisation. (Robert Collins)

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.lockable_files import LockableFiles
 
88
from bzrlib.inventory import InventoryEntry, Inventory, ROOT_ID, TreeReference
 
89
from bzrlib.lockable_files import LockableFiles, TransportLock
81
90
from bzrlib.lockdir import LockDir
82
91
import bzrlib.mutabletree
83
92
from bzrlib.mutabletree import needs_tree_write_lock
84
 
from bzrlib import osutils
85
93
from bzrlib.osutils import (
 
94
    compact_date,
86
95
    file_kind,
87
96
    isdir,
88
97
    normpath,
89
98
    pathjoin,
 
99
    rand_chars,
90
100
    realpath,
91
101
    safe_unicode,
92
102
    splitpath,
93
103
    supports_executable,
94
104
    )
95
 
from bzrlib.filters import filtered_input_file
96
105
from bzrlib.trace import mutter, note
97
106
from bzrlib.transport.local import LocalTransport
98
 
from bzrlib.revision import CURRENT_REVISION
 
107
from bzrlib.progress import DummyProgress, ProgressPhase
 
108
from bzrlib.revision import NULL_REVISION, CURRENT_REVISION
99
109
from bzrlib.rio import RioReader, rio_file, Stanza
100
 
from bzrlib.symbol_versioning import (
101
 
    deprecated_passed,
102
 
    DEPRECATED_PARAMETER,
103
 
    )
 
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
        )
104
118
 
105
119
 
106
120
MERGE_MODIFIED_HEADER_1 = "BZR merge-modified list format 1"
107
 
# TODO: Modifying the conflict objects or their type is currently nearly
108
 
# impossible as there is no clear relationship between the working tree format
109
 
# and the conflict list file format.
110
121
CONFLICT_HEADER_1 = "BZR conflict list format 1"
111
122
 
112
123
ERROR_PATH_NOT_FOUND = 3    # WindowsError errno code, equivalent to ENOENT
113
124
 
114
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
 
115
144
class TreeEntry(object):
116
145
    """An entry that implements the minimum interface used by commands.
117
146
 
118
 
    This needs further inspection, it may be better to have
 
147
    This needs further inspection, it may be better to have 
119
148
    InventoryEntries without ids - though that seems wrong. For now,
120
149
    this is a parallel hierarchy to InventoryEntry, and needs to become
121
150
    one of several things: decorates to that hierarchy, children of, or
124
153
    no InventoryEntry available - i.e. for unversioned objects.
125
154
    Perhaps they should be UnversionedEntry et al. ? - RBC 20051003
126
155
    """
127
 
 
 
156
 
128
157
    def __eq__(self, other):
129
158
        # yes, this us ugly, TODO: best practice __eq__ style.
130
159
        return (isinstance(other, TreeEntry)
131
160
                and other.__class__ == self.__class__)
132
 
 
 
161
 
133
162
    def kind_character(self):
134
163
        return "???"
135
164
 
167
196
        return ''
168
197
 
169
198
 
170
 
class WorkingTree(bzrlib.mutabletree.MutableTree,
171
 
    bzrdir.ControlComponent):
 
199
class WorkingTree(bzrlib.mutabletree.MutableTree):
172
200
    """Working copy tree.
173
201
 
174
202
    The inventory is held in the `Branch` working-inventory, and the
178
206
    not listed in the Inventory and vice versa.
179
207
    """
180
208
 
181
 
    # override this to set the strategy for storing views
182
 
    def _make_views(self):
183
 
        return views.DisabledViews(self)
184
 
 
185
209
    def __init__(self, basedir='.',
186
210
                 branch=DEPRECATED_PARAMETER,
187
211
                 _inventory=None,
198
222
        if not _internal:
199
223
            raise errors.BzrError("Please use bzrdir.open_workingtree or "
200
224
                "WorkingTree.open() to obtain a WorkingTree.")
 
225
        assert isinstance(basedir, basestring), \
 
226
            "base directory %r is not a string" % basedir
201
227
        basedir = safe_unicode(basedir)
202
228
        mutter("opening working tree %r", basedir)
203
229
        if deprecated_passed(branch):
211
237
            self._control_files = self.branch.control_files
212
238
        else:
213
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
214
243
            self._control_files = _control_files
215
 
        self._transport = self._control_files._transport
216
244
        # update the whole cache up front and write to disk if anything changed;
217
245
        # in the future we might want to do this more selectively
218
246
        # two possible ways offer themselves : in self._unlock, write the cache
222
250
        wt_trans = self.bzrdir.get_workingtree_transport(None)
223
251
        cache_filename = wt_trans.local_abspath('stat-cache')
224
252
        self._hashcache = hashcache.HashCache(basedir, cache_filename,
225
 
            self.bzrdir._get_file_mode(),
226
 
            self._content_filter_stack_provider())
 
253
                                              self._control_files._file_mode)
227
254
        hc = self._hashcache
228
255
        hc.read()
229
256
        # is this scan needed ? it makes things kinda slow.
243
270
            # the Format factory and creation methods that are
244
271
            # permitted to do this.
245
272
            self._set_inventory(_inventory, dirty=False)
246
 
        self._detect_case_handling()
247
 
        self._rules_searcher = None
248
 
        self.views = self._make_views()
249
 
 
250
 
    @property
251
 
    def user_transport(self):
252
 
        return self.bzrdir.user_transport
253
 
 
254
 
    @property
255
 
    def control_transport(self):
256
 
        return self._transport
257
 
 
258
 
    def _detect_case_handling(self):
259
 
        wt_trans = self.bzrdir.get_workingtree_transport(None)
260
 
        try:
261
 
            wt_trans.stat("FoRMaT")
262
 
        except errors.NoSuchFile:
263
 
            self.case_sensitive = True
264
 
        else:
265
 
            self.case_sensitive = False
266
 
 
267
 
        self._setup_directory_is_tree_reference()
268
273
 
269
274
    branch = property(
270
275
        fget=lambda self: self._branch,
285
290
        self._control_files.break_lock()
286
291
        self.branch.break_lock()
287
292
 
288
 
    def _get_check_refs(self):
289
 
        """Return the references needed to perform a check of this tree.
290
 
        
291
 
        The default implementation returns no refs, and is only suitable for
292
 
        trees that have no local caching and can commit on ghosts at any time.
293
 
 
294
 
        :seealso: bzrlib.check for details about check_refs.
295
 
        """
296
 
        return []
297
 
 
298
293
    def requires_rich_root(self):
299
294
        return self._format.requires_rich_root
300
295
 
301
296
    def supports_tree_reference(self):
302
297
        return False
303
298
 
304
 
    def supports_content_filtering(self):
305
 
        return self._format.supports_content_filtering()
306
 
 
307
 
    def supports_views(self):
308
 
        return self.views.supports_views()
309
 
 
310
299
    def _set_inventory(self, inv, dirty):
311
300
        """Set the internal cached inventory.
312
301
 
317
306
            False then the inventory is the same as that on disk and any
318
307
            serialisation would be unneeded overhead.
319
308
        """
 
309
        assert inv.root is not None
320
310
        self._inventory = inv
321
311
        self._inventory_is_modified = dirty
322
312
 
326
316
 
327
317
        """
328
318
        if path is None:
329
 
            path = osutils.getcwd()
 
319
            path = os.path.getcwdu()
330
320
        control = bzrdir.BzrDir.open(path, _unsupported)
331
321
        return control.open_workingtree(_unsupported)
332
 
 
 
322
        
333
323
    @staticmethod
334
324
    def open_containing(path=None):
335
325
        """Open an existing working tree which has its root about path.
336
 
 
 
326
        
337
327
        This probes for a working tree at path and searches upwards from there.
338
328
 
339
329
        Basically we keep looking up until we find the control directory or
357
347
        """
358
348
        return WorkingTree.open(path, _unsupported=True)
359
349
 
360
 
    @staticmethod
361
 
    def find_trees(location):
362
 
        def list_current(transport):
363
 
            return [d for d in transport.list_dir('') if d != '.bzr']
364
 
        def evaluate(bzrdir):
365
 
            try:
366
 
                tree = bzrdir.open_workingtree()
367
 
            except errors.NoWorkingTree:
368
 
                return True, None
369
 
            else:
370
 
                return True, tree
371
 
        transport = get_transport(location)
372
 
        iterator = bzrdir.BzrDir.find_bzrdirs(transport, evaluate=evaluate,
373
 
                                              list_current=list_current)
374
 
        return [t for t in iterator if t is not None]
375
 
 
376
350
    # should be deprecated - this is slow and in any case treating them as a
377
351
    # container is (we now know) bad style -- mbp 20070302
378
352
    ## @deprecated_method(zero_fifteen)
387
361
            if osutils.lexists(self.abspath(path)):
388
362
                yield ie.file_id
389
363
 
390
 
    def all_file_ids(self):
391
 
        """See Tree.iter_all_file_ids"""
392
 
        return set(self.inventory)
393
 
 
394
364
    def __repr__(self):
395
365
        return "<%s of %s>" % (self.__class__.__name__,
396
366
                               getattr(self, 'basedir', None))
400
370
 
401
371
    def basis_tree(self):
402
372
        """Return RevisionTree for the current last revision.
403
 
 
 
373
        
404
374
        If the left most parent is a ghost then the returned tree will be an
405
 
        empty tree - one obtained by calling
406
 
        repository.revision_tree(NULL_REVISION).
 
375
        empty tree - one obtained by calling repository.revision_tree(None).
407
376
        """
408
377
        try:
409
378
            revision_id = self.get_parent_ids()[0]
411
380
            # no parents, return an empty revision tree.
412
381
            # in the future this should return the tree for
413
382
            # 'empty:' - the implicit root empty tree.
414
 
            return self.branch.repository.revision_tree(
415
 
                       _mod_revision.NULL_REVISION)
 
383
            return self.branch.repository.revision_tree(None)
416
384
        try:
417
385
            return self.revision_tree(revision_id)
418
386
        except errors.NoSuchRevision:
422
390
        # at this point ?
423
391
        try:
424
392
            return self.branch.repository.revision_tree(revision_id)
425
 
        except (errors.RevisionNotPresent, errors.NoSuchRevision):
 
393
        except errors.RevisionNotPresent:
426
394
            # the basis tree *may* be a ghost or a low level error may have
427
 
            # 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
428
396
            # its a ghost.
429
397
            if self.branch.repository.has_revision(revision_id):
430
398
                raise
431
399
            # the basis tree is a ghost so return an empty tree.
432
 
            return self.branch.repository.revision_tree(
433
 
                       _mod_revision.NULL_REVISION)
 
400
            return self.branch.repository.revision_tree(None)
434
401
 
435
402
    def _cleanup(self):
436
403
        self._flush_ignore_list_cache()
437
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
 
438
443
    def relpath(self, path):
439
444
        """Return the local path portion from a given path.
440
 
 
441
 
        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 
442
447
        interpreted relative to the python current working directory.
443
448
        """
444
449
        return osutils.relpath(self.basedir, path)
446
451
    def has_filename(self, filename):
447
452
        return osutils.lexists(self.abspath(filename))
448
453
 
449
 
    def get_file(self, file_id, path=None, filtered=True):
450
 
        return self.get_file_with_stat(file_id, path, filtered=filtered)[0]
451
 
 
452
 
    def get_file_with_stat(self, file_id, path=None, filtered=True,
453
 
        _fstat=os.fstat):
454
 
        """See Tree.get_file_with_stat."""
 
454
    def get_file(self, file_id, path=None):
455
455
        if path is None:
 
456
            file_id = osutils.safe_file_id(file_id)
456
457
            path = self.id2path(file_id)
457
 
        file_obj = self.get_file_byname(path, filtered=False)
458
 
        stat_value = _fstat(file_obj.fileno())
459
 
        if filtered and self.supports_content_filtering():
460
 
            filters = self._content_filter_stack(path)
461
 
            file_obj = filtered_input_file(file_obj, filters)
462
 
        return (file_obj, stat_value)
463
 
 
464
 
    def get_file_text(self, file_id, path=None, filtered=True):
465
 
        return self.get_file(file_id, path=path, filtered=filtered).read()
466
 
 
467
 
    def get_file_byname(self, filename, filtered=True):
468
 
        path = self.abspath(filename)
469
 
        f = file(path, 'rb')
470
 
        if filtered and self.supports_content_filtering():
471
 
            filters = self._content_filter_stack(filename)
472
 
            return filtered_input_file(f, filters)
473
 
        else:
474
 
            return f
475
 
 
476
 
    def get_file_lines(self, file_id, path=None, filtered=True):
477
 
        """See Tree.get_file_lines()"""
478
 
        file = self.get_file(file_id, path, filtered=filtered)
479
 
        try:
480
 
            return file.readlines()
481
 
        finally:
482
 
            file.close()
 
458
        return self.get_file_byname(path)
 
459
 
 
460
    def get_file_text(self, file_id):
 
461
        file_id = osutils.safe_file_id(file_id)
 
462
        return self.get_file(file_id).read()
 
463
 
 
464
    def get_file_byname(self, filename):
 
465
        return file(self.abspath(filename), 'rb')
483
466
 
484
467
    @needs_read_lock
485
468
    def annotate_iter(self, file_id, default_revision=CURRENT_REVISION):
492
475
        incorrectly attributed to CURRENT_REVISION (but after committing, the
493
476
        attribution will be correct).
494
477
        """
495
 
        maybe_file_parent_keys = []
496
 
        for parent_id in self.get_parent_ids():
497
 
            try:
498
 
                parent_tree = self.revision_tree(parent_id)
499
 
            except errors.NoSuchRevisionInTree:
500
 
                parent_tree = self.branch.repository.revision_tree(parent_id)
501
 
            parent_tree.lock_read()
502
 
            try:
503
 
                if file_id not in parent_tree:
504
 
                    continue
505
 
                ie = parent_tree.inventory[file_id]
506
 
                if ie.kind != 'file':
507
 
                    # Note: this is slightly unnecessary, because symlinks and
508
 
                    # directories have a "text" which is the empty text, and we
509
 
                    # know that won't mess up annotations. But it seems cleaner
510
 
                    continue
511
 
                parent_text_key = (file_id, ie.revision)
512
 
                if parent_text_key not in maybe_file_parent_keys:
513
 
                    maybe_file_parent_keys.append(parent_text_key)
514
 
            finally:
515
 
                parent_tree.unlock()
516
 
        graph = _mod_graph.Graph(self.branch.repository.texts)
517
 
        heads = graph.heads(maybe_file_parent_keys)
518
 
        file_parent_keys = []
519
 
        for key in maybe_file_parent_keys:
520
 
            if key in heads:
521
 
                file_parent_keys.append(key)
522
 
 
523
 
        # Now we have the parents of this content
524
 
        annotator = self.branch.repository.texts.get_annotator()
525
 
        text = self.get_file(file_id).read()
526
 
        this_key =(file_id, default_revision)
527
 
        annotator.add_special_text(this_key, file_parent_keys, text)
528
 
        annotations = [(key[-1], line)
529
 
                       for key, line in annotator.annotate_flat(this_key)]
530
 
        return annotations
 
478
        file_id = osutils.safe_file_id(file_id)
 
479
        basis = self.basis_tree()
 
480
        basis.lock_read()
 
481
        try:
 
482
            changes = self._iter_changes(basis, True, [self.id2path(file_id)],
 
483
                require_versioned=True).next()
 
484
            changed_content, kind = changes[2], changes[6]
 
485
            if not changed_content:
 
486
                return basis.annotate_iter(file_id)
 
487
            if kind[1] is None:
 
488
                return None
 
489
            import annotate
 
490
            if kind[0] != 'file':
 
491
                old_lines = []
 
492
            else:
 
493
                old_lines = list(basis.annotate_iter(file_id))
 
494
            old = [old_lines]
 
495
            for tree in self.branch.repository.revision_trees(
 
496
                self.get_parent_ids()[1:]):
 
497
                if file_id not in tree:
 
498
                    continue
 
499
                old.append(list(tree.annotate_iter(file_id)))
 
500
            return annotate.reannotate(old, self.get_file(file_id).readlines(),
 
501
                                       default_revision)
 
502
        finally:
 
503
            basis.unlock()
531
504
 
532
505
    def _get_ancestors(self, default_revision):
533
506
        ancestors = set([default_revision])
538
511
 
539
512
    def get_parent_ids(self):
540
513
        """See Tree.get_parent_ids.
541
 
 
 
514
        
542
515
        This implementation reads the pending merges list and last_revision
543
516
        value and uses that to decide what the parents list should be.
544
517
        """
548
521
        else:
549
522
            parents = [last_rev]
550
523
        try:
551
 
            merges_bytes = self._transport.get_bytes('pending-merges')
 
524
            merges_file = self._control_files.get('pending-merges')
552
525
        except errors.NoSuchFile:
553
526
            pass
554
527
        else:
555
 
            for l in osutils.split_lines(merges_bytes):
556
 
                revision_id = l.rstrip('\n')
 
528
            for l in merges_file.readlines():
 
529
                revision_id = osutils.safe_revision_id(l.rstrip('\n'))
557
530
                parents.append(revision_id)
558
531
        return parents
559
532
 
561
534
    def get_root_id(self):
562
535
        """Return the id of this trees root"""
563
536
        return self._inventory.root.file_id
564
 
 
 
537
        
565
538
    def _get_store_filename(self, file_id):
566
539
        ## XXX: badly named; this is not in the store at all
 
540
        file_id = osutils.safe_file_id(file_id)
567
541
        return self.abspath(self.id2path(file_id))
568
542
 
569
543
    @needs_read_lock
570
544
    def clone(self, to_bzrdir, revision_id=None):
571
545
        """Duplicate this working tree into to_bzr, including all state.
572
 
 
 
546
        
573
547
        Specifically modified files are kept as modified, but
574
548
        ignored and unknown files are discarded.
575
549
 
576
550
        If you want to make a new line of development, see bzrdir.sprout()
577
551
 
578
552
        revision
579
 
            If not None, the cloned tree will have its last revision set to
580
 
            revision, and difference between the source trees last revision
 
553
            If not None, the cloned tree will have its last revision set to 
 
554
            revision, and and difference between the source trees last revision
581
555
            and this one merged in.
582
556
        """
583
557
        # assumes the target bzr dir format is compatible.
584
 
        result = to_bzrdir.create_workingtree()
 
558
        result = self._format.initialize(to_bzrdir)
585
559
        self.copy_content_into(result, revision_id)
586
560
        return result
587
561
 
598
572
            tree.set_parent_ids([revision_id])
599
573
 
600
574
    def id2abspath(self, file_id):
 
575
        file_id = osutils.safe_file_id(file_id)
601
576
        return self.abspath(self.id2path(file_id))
602
577
 
603
578
    def has_id(self, file_id):
604
579
        # files that have been deleted are excluded
 
580
        file_id = osutils.safe_file_id(file_id)
605
581
        inv = self.inventory
606
582
        if not inv.has_id(file_id):
607
583
            return False
609
585
        return osutils.lexists(self.abspath(path))
610
586
 
611
587
    def has_or_had_id(self, file_id):
 
588
        file_id = osutils.safe_file_id(file_id)
612
589
        if file_id == self.inventory.root.file_id:
613
590
            return True
614
591
        return self.inventory.has_id(file_id)
616
593
    __contains__ = has_id
617
594
 
618
595
    def get_file_size(self, file_id):
619
 
        """See Tree.get_file_size"""
620
 
        # XXX: this returns the on-disk size; it should probably return the
621
 
        # canonical size
622
 
        try:
623
 
            return os.path.getsize(self.id2abspath(file_id))
624
 
        except OSError, e:
625
 
            if e.errno != errno.ENOENT:
626
 
                raise
627
 
            else:
628
 
                return None
 
596
        file_id = osutils.safe_file_id(file_id)
 
597
        return os.path.getsize(self.id2abspath(file_id))
629
598
 
630
599
    @needs_read_lock
631
600
    def get_file_sha1(self, file_id, path=None, stat_value=None):
 
601
        file_id = osutils.safe_file_id(file_id)
632
602
        if not path:
633
603
            path = self._inventory.id2path(file_id)
634
604
        return self._hashcache.get_sha1(path, stat_value)
635
605
 
636
606
    def get_file_mtime(self, file_id, path=None):
 
607
        file_id = osutils.safe_file_id(file_id)
637
608
        if not path:
638
609
            path = self.inventory.id2path(file_id)
639
610
        return os.lstat(self.abspath(path)).st_mtime
640
611
 
641
 
    def _is_executable_from_path_and_stat_from_basis(self, path, stat_result):
642
 
        file_id = self.path2id(path)
643
 
        if file_id is None:
644
 
            # For unversioned files on win32, we just assume they are not
645
 
            # executable
646
 
            return False
647
 
        return self._inventory[file_id].executable
648
 
 
649
 
    def _is_executable_from_path_and_stat_from_stat(self, path, stat_result):
650
 
        mode = stat_result.st_mode
651
 
        return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
652
 
 
653
612
    if not supports_executable():
654
613
        def is_executable(self, file_id, path=None):
 
614
            file_id = osutils.safe_file_id(file_id)
655
615
            return self._inventory[file_id].executable
656
 
 
657
 
        _is_executable_from_path_and_stat = \
658
 
            _is_executable_from_path_and_stat_from_basis
659
616
    else:
660
617
        def is_executable(self, file_id, path=None):
661
618
            if not path:
 
619
                file_id = osutils.safe_file_id(file_id)
662
620
                path = self.id2path(file_id)
663
621
            mode = os.lstat(self.abspath(path)).st_mode
664
622
            return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
665
623
 
666
 
        _is_executable_from_path_and_stat = \
667
 
            _is_executable_from_path_and_stat_from_stat
668
 
 
669
624
    @needs_tree_write_lock
670
625
    def _add(self, files, ids, kinds):
671
626
        """See MutableTree._add."""
672
627
        # TODO: Re-adding a file that is removed in the working copy
673
628
        # should probably put it back with the previous ID.
674
 
        # the read and write working inventory should not occur in this
 
629
        # the read and write working inventory should not occur in this 
675
630
        # function - they should be part of lock_write and unlock.
676
631
        inv = self.inventory
677
632
        for f, file_id, kind in zip(files, ids, kinds):
 
633
            assert kind is not None
678
634
            if file_id is None:
679
635
                inv.add_path(f, kind=kind)
680
636
            else:
 
637
                file_id = osutils.safe_file_id(file_id)
681
638
                inv.add_path(f, kind=kind, file_id=file_id)
682
639
            self._inventory_is_modified = True
683
640
 
745
702
        if updated:
746
703
            self.set_parent_ids(parents, allow_leftmost_as_ghost=True)
747
704
 
748
 
    def path_content_summary(self, path, _lstat=os.lstat,
 
705
    def path_content_summary(self, path, _lstat=osutils.lstat,
749
706
        _mapper=osutils.file_kind_from_stat_mode):
750
707
        """See Tree.path_content_summary."""
751
708
        abspath = self.abspath(path)
759
716
            raise
760
717
        kind = _mapper(stat_result.st_mode)
761
718
        if kind == 'file':
762
 
            return self._file_content_summary(path, stat_result)
 
719
            size = stat_result.st_size
 
720
            # try for a stat cache lookup
 
721
            if not supports_executable():
 
722
                executable = None # caller can decide policy.
 
723
            else:
 
724
                mode = stat_result.st_mode
 
725
                executable = bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
 
726
            return (kind, size, executable, self._sha_from_stat(
 
727
                path, stat_result))
763
728
        elif kind == 'directory':
764
729
            # perhaps it looks like a plain directory, but it's really a
765
730
            # reference.
767
732
                kind = 'tree-reference'
768
733
            return kind, None, None, None
769
734
        elif kind == 'symlink':
770
 
            target = osutils.readlink(abspath)
771
 
            return ('symlink', None, None, target)
 
735
            return ('symlink', None, None, os.readlink(abspath))
772
736
        else:
773
737
            return (kind, None, None, None)
774
738
 
775
 
    def _file_content_summary(self, path, stat_result):
776
 
        size = stat_result.st_size
777
 
        executable = self._is_executable_from_path_and_stat(path, stat_result)
778
 
        # try for a stat cache lookup
779
 
        return ('file', size, executable, self._sha_from_stat(
780
 
            path, stat_result))
 
739
    @deprecated_method(zero_eleven)
 
740
    @needs_read_lock
 
741
    def pending_merges(self):
 
742
        """Return a list of pending merges.
 
743
 
 
744
        These are revisions that have been merged into the working
 
745
        directory but not yet committed.
 
746
 
 
747
        As of 0.11 this is deprecated. Please see WorkingTree.get_parent_ids()
 
748
        instead - which is available on all tree objects.
 
749
        """
 
750
        return self.get_parent_ids()[1:]
781
751
 
782
752
    def _check_parents_for_ghosts(self, revision_ids, allow_leftmost_as_ghost):
783
753
        """Common ghost checking functionality from set_parent_*.
793
763
 
794
764
    def _set_merges_from_parent_ids(self, parent_ids):
795
765
        merges = parent_ids[1:]
796
 
        self._transport.put_bytes('pending-merges', '\n'.join(merges),
797
 
            mode=self.bzrdir._get_file_mode())
798
 
 
799
 
    def _filter_parent_ids_by_ancestry(self, revision_ids):
800
 
        """Check that all merged revisions are proper 'heads'.
801
 
 
802
 
        This will always return the first revision_id, and any merged revisions
803
 
        which are
804
 
        """
805
 
        if len(revision_ids) == 0:
806
 
            return revision_ids
807
 
        graph = self.branch.repository.get_graph()
808
 
        heads = graph.heads(revision_ids)
809
 
        new_revision_ids = revision_ids[:1]
810
 
        for revision_id in revision_ids[1:]:
811
 
            if revision_id in heads and revision_id not in new_revision_ids:
812
 
                new_revision_ids.append(revision_id)
813
 
        if new_revision_ids != revision_ids:
814
 
            trace.mutter('requested to set revision_ids = %s,'
815
 
                         ' but filtered to %s', revision_ids, new_revision_ids)
816
 
        return new_revision_ids
 
766
        self._control_files.put_bytes('pending-merges', '\n'.join(merges))
817
767
 
818
768
    @needs_tree_write_lock
819
769
    def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
820
770
        """Set the parent ids to revision_ids.
821
 
 
 
771
        
822
772
        See also set_parent_trees. This api will try to retrieve the tree data
823
773
        for each element of revision_ids from the trees repository. If you have
824
774
        tree data already available, it is more efficient to use
828
778
        :param revision_ids: The revision_ids to set as the parent ids of this
829
779
            working tree. Any of these may be ghosts.
830
780
        """
 
781
        revision_ids = [osutils.safe_revision_id(r) for r in revision_ids]
831
782
        self._check_parents_for_ghosts(revision_ids,
832
783
            allow_leftmost_as_ghost=allow_leftmost_as_ghost)
833
784
        for revision_id in revision_ids:
834
785
            _mod_revision.check_not_reserved_id(revision_id)
835
786
 
836
 
        revision_ids = self._filter_parent_ids_by_ancestry(revision_ids)
837
 
 
838
787
        if len(revision_ids) > 0:
839
788
            self.set_last_revision(revision_ids[0])
840
789
        else:
845
794
    @needs_tree_write_lock
846
795
    def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
847
796
        """See MutableTree.set_parent_trees."""
848
 
        parent_ids = [rev for (rev, tree) in parents_list]
 
797
        parent_ids = [osutils.safe_revision_id(rev) for (rev, tree) in parents_list]
849
798
        for revision_id in parent_ids:
850
799
            _mod_revision.check_not_reserved_id(revision_id)
851
800
 
852
801
        self._check_parents_for_ghosts(parent_ids,
853
802
            allow_leftmost_as_ghost=allow_leftmost_as_ghost)
854
803
 
855
 
        parent_ids = self._filter_parent_ids_by_ancestry(parent_ids)
856
 
 
857
804
        if len(parent_ids) == 0:
858
805
            leftmost_parent_id = _mod_revision.NULL_REVISION
859
806
            leftmost_parent_tree = None
899
846
    def _put_rio(self, filename, stanzas, header):
900
847
        self._must_be_locked()
901
848
        my_file = rio_file(stanzas, header)
902
 
        self._transport.put_file(filename, my_file,
903
 
            mode=self.bzrdir._get_file_mode())
 
849
        self._control_files.put(filename, my_file)
904
850
 
905
851
    @needs_write_lock # because merge pulls data into the branch.
906
852
    def merge_from_branch(self, branch, to_revision=None, from_revision=None,
907
 
                          merge_type=None, force=False):
 
853
        merge_type=None):
908
854
        """Merge from a branch into this working tree.
909
855
 
910
856
        :param branch: The branch to merge from.
914
860
            branch.last_revision().
915
861
        """
916
862
        from bzrlib.merge import Merger, Merge3Merger
917
 
        merger = Merger(self.branch, this_tree=self)
918
 
        # check that there are no local alterations
919
 
        if not force and self.has_changes():
920
 
            raise errors.UncommittedChanges(self)
921
 
        if to_revision is None:
922
 
            to_revision = _mod_revision.ensure_null(branch.last_revision())
923
 
        merger.other_rev_id = to_revision
924
 
        if _mod_revision.is_null(merger.other_rev_id):
925
 
            raise errors.NoCommits(branch)
926
 
        self.branch.fetch(branch, last_revision=merger.other_rev_id)
927
 
        merger.other_basis = merger.other_rev_id
928
 
        merger.other_tree = self.branch.repository.revision_tree(
929
 
            merger.other_rev_id)
930
 
        merger.other_branch = branch
931
 
        if from_revision is None:
932
 
            merger.find_base()
933
 
        else:
934
 
            merger.set_base_revision(from_revision, branch)
935
 
        if merger.base_rev_id == merger.other_rev_id:
936
 
            raise errors.PointlessMerge
937
 
        merger.backup_files = False
938
 
        if merge_type is None:
939
 
            merger.merge_type = Merge3Merger
940
 
        else:
941
 
            merger.merge_type = merge_type
942
 
        merger.set_interesting_files(None)
943
 
        merger.show_base = False
944
 
        merger.reprocess = False
945
 
        conflicts = merger.do_merge()
946
 
        merger.set_pending()
 
863
        pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
864
        try:
 
865
            merger = Merger(self.branch, this_tree=self, pb=pb)
 
866
            merger.pp = ProgressPhase("Merge phase", 5, pb)
 
867
            merger.pp.next_phase()
 
868
            # check that there are no
 
869
            # local alterations
 
870
            merger.check_basis(check_clean=True, require_commits=False)
 
871
            if to_revision is None:
 
872
                to_revision = _mod_revision.ensure_null(branch.last_revision())
 
873
            else:
 
874
                to_revision = osutils.safe_revision_id(to_revision)
 
875
            merger.other_rev_id = to_revision
 
876
            if _mod_revision.is_null(merger.other_rev_id):
 
877
                raise errors.NoCommits(branch)
 
878
            self.branch.fetch(branch, last_revision=merger.other_rev_id)
 
879
            merger.other_basis = merger.other_rev_id
 
880
            merger.other_tree = self.branch.repository.revision_tree(
 
881
                merger.other_rev_id)
 
882
            merger.other_branch = branch
 
883
            merger.pp.next_phase()
 
884
            if from_revision is None:
 
885
                merger.find_base()
 
886
            else:
 
887
                merger.set_base_revision(from_revision, branch)
 
888
            if merger.base_rev_id == merger.other_rev_id:
 
889
                raise errors.PointlessMerge
 
890
            merger.backup_files = False
 
891
            if merge_type is None:
 
892
                merger.merge_type = Merge3Merger
 
893
            else:
 
894
                merger.merge_type = merge_type
 
895
            merger.set_interesting_files(None)
 
896
            merger.show_base = False
 
897
            merger.reprocess = False
 
898
            conflicts = merger.do_merge()
 
899
            merger.set_pending()
 
900
        finally:
 
901
            pb.finished()
947
902
        return conflicts
948
903
 
949
904
    @needs_read_lock
950
905
    def merge_modified(self):
951
906
        """Return a dictionary of files modified by a merge.
952
907
 
953
 
        The list is initialized by WorkingTree.set_merge_modified, which is
 
908
        The list is initialized by WorkingTree.set_merge_modified, which is 
954
909
        typically called after we make some automatic updates to the tree
955
910
        because of a merge.
956
911
 
958
913
        still in the working inventory and have that text hash.
959
914
        """
960
915
        try:
961
 
            hashfile = self._transport.get('merge-hashes')
 
916
            hashfile = self._control_files.get('merge-hashes')
962
917
        except errors.NoSuchFile:
963
918
            return {}
 
919
        merge_hashes = {}
964
920
        try:
965
 
            merge_hashes = {}
966
 
            try:
967
 
                if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
968
 
                    raise errors.MergeModifiedFormatError()
969
 
            except StopIteration:
 
921
            if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
970
922
                raise errors.MergeModifiedFormatError()
971
 
            for s in RioReader(hashfile):
972
 
                # RioReader reads in Unicode, so convert file_ids back to utf8
973
 
                file_id = osutils.safe_file_id(s.get("file_id"), warn=False)
974
 
                if file_id not in self.inventory:
975
 
                    continue
976
 
                text_hash = s.get("hash")
977
 
                if text_hash == self.get_file_sha1(file_id):
978
 
                    merge_hashes[file_id] = text_hash
979
 
            return merge_hashes
980
 
        finally:
981
 
            hashfile.close()
 
923
        except StopIteration:
 
924
            raise errors.MergeModifiedFormatError()
 
925
        for s in RioReader(hashfile):
 
926
            # RioReader reads in Unicode, so convert file_ids back to utf8
 
927
            file_id = osutils.safe_file_id(s.get("file_id"), warn=False)
 
928
            if file_id not in self.inventory:
 
929
                continue
 
930
            text_hash = s.get("hash")
 
931
            if text_hash == self.get_file_sha1(file_id):
 
932
                merge_hashes[file_id] = text_hash
 
933
        return merge_hashes
982
934
 
983
935
    @needs_write_lock
984
936
    def mkdir(self, path, file_id=None):
990
942
        return file_id
991
943
 
992
944
    def get_symlink_target(self, file_id):
993
 
        abspath = self.id2abspath(file_id)
994
 
        target = osutils.readlink(abspath)
995
 
        return target
 
945
        file_id = osutils.safe_file_id(file_id)
 
946
        return os.readlink(self.id2abspath(file_id))
996
947
 
997
948
    @needs_write_lock
998
949
    def subsume(self, other_tree):
1036
987
            other_tree.unlock()
1037
988
        other_tree.bzrdir.retire_bzrdir()
1038
989
 
1039
 
    def _setup_directory_is_tree_reference(self):
1040
 
        if self._branch.repository._format.supports_tree_reference:
1041
 
            self._directory_is_tree_reference = \
1042
 
                self._directory_may_be_tree_reference
1043
 
        else:
1044
 
            self._directory_is_tree_reference = \
1045
 
                self._directory_is_never_tree_reference
1046
 
 
1047
 
    def _directory_is_never_tree_reference(self, relpath):
1048
 
        return False
1049
 
 
1050
 
    def _directory_may_be_tree_reference(self, relpath):
1051
 
        # as a special case, if a directory contains control files then
 
990
    def _directory_is_tree_reference(self, relpath):
 
991
        # as a special case, if a directory contains control files then 
1052
992
        # it's a tree reference, except that the root of the tree is not
1053
993
        return relpath and osutils.isdir(self.abspath(relpath) + u"/.bzr")
1054
994
        # TODO: We could ask all the control formats whether they
1065
1005
    @needs_tree_write_lock
1066
1006
    def extract(self, file_id, format=None):
1067
1007
        """Extract a subtree from this tree.
1068
 
 
 
1008
        
1069
1009
        A new branch will be created, relative to the path for this tree.
1070
1010
        """
1071
1011
        self.flush()
1076
1016
                transport = transport.clone(name)
1077
1017
                transport.ensure_base()
1078
1018
            return transport
1079
 
 
 
1019
            
1080
1020
        sub_path = self.id2path(file_id)
1081
1021
        branch_transport = mkdirs(sub_path)
1082
1022
        if format is None:
1083
 
            format = self.bzrdir.cloning_metadir()
 
1023
            format = bzrdir.format_registry.make_bzrdir('dirstate-with-subtree')
1084
1024
        branch_transport.ensure_base()
1085
1025
        branch_bzrdir = format.initialize_on_transport(branch_transport)
1086
1026
        try:
1087
1027
            repo = branch_bzrdir.find_repository()
1088
1028
        except errors.NoRepositoryPresent:
1089
1029
            repo = branch_bzrdir.create_repository()
1090
 
        if not repo.supports_rich_root():
1091
 
            raise errors.RootNotRich()
 
1030
            assert repo.supports_rich_root()
 
1031
        else:
 
1032
            if not repo.supports_rich_root():
 
1033
                raise errors.RootNotRich()
1092
1034
        new_branch = branch_bzrdir.create_branch()
1093
1035
        new_branch.pull(self.branch)
1094
1036
        for parent_id in self.get_parent_ids():
1096
1038
        tree_transport = self.bzrdir.root_transport.clone(sub_path)
1097
1039
        if tree_transport.base != branch_transport.base:
1098
1040
            tree_bzrdir = format.initialize_on_transport(tree_transport)
1099
 
            branch.BranchReferenceFormat().initialize(tree_bzrdir,
1100
 
                target_branch=new_branch)
 
1041
            branch.BranchReferenceFormat().initialize(tree_bzrdir, new_branch)
1101
1042
        else:
1102
1043
            tree_bzrdir = branch_bzrdir
1103
 
        wt = tree_bzrdir.create_workingtree(_mod_revision.NULL_REVISION)
 
1044
        wt = tree_bzrdir.create_workingtree(NULL_REVISION)
1104
1045
        wt.set_parent_ids(self.get_parent_ids())
1105
1046
        my_inv = self.inventory
1106
 
        child_inv = inventory.Inventory(root_id=None)
 
1047
        child_inv = Inventory(root_id=None)
1107
1048
        new_root = my_inv[file_id]
1108
1049
        my_inv.remove_recursive_id(file_id)
1109
1050
        new_root.parent_id = None
1127
1068
        sio = StringIO()
1128
1069
        self._serialize(self._inventory, sio)
1129
1070
        sio.seek(0)
1130
 
        self._transport.put_file('inventory', sio,
1131
 
            mode=self.bzrdir._get_file_mode())
 
1071
        self._control_files.put('inventory', sio)
1132
1072
        self._inventory_is_modified = False
1133
1073
 
1134
1074
    def _kind(self, relpath):
1135
1075
        return osutils.file_kind(self.abspath(relpath))
1136
1076
 
1137
 
    def list_files(self, include_root=False, from_dir=None, recursive=True):
1138
 
        """List all files as (path, class, kind, id, entry).
 
1077
    def list_files(self, include_root=False):
 
1078
        """Recursively list all files as (path, class, kind, id, entry).
1139
1079
 
1140
1080
        Lists, but does not descend into unversioned directories.
 
1081
 
1141
1082
        This does not include files that have been deleted in this
1142
 
        tree. Skips the control directory.
 
1083
        tree.
1143
1084
 
1144
 
        :param include_root: if True, return an entry for the root
1145
 
        :param from_dir: start from this directory or None for the root
1146
 
        :param recursive: whether to recurse into subdirectories or not
 
1085
        Skips the control directory.
1147
1086
        """
1148
1087
        # list_files is an iterator, so @needs_read_lock doesn't work properly
1149
1088
        # with it. So callers should be careful to always read_lock the tree.
1151
1090
            raise errors.ObjectNotLocked(self)
1152
1091
 
1153
1092
        inv = self.inventory
1154
 
        if from_dir is None and include_root is True:
 
1093
        if include_root is True:
1155
1094
            yield ('', 'V', 'directory', inv.root.file_id, inv.root)
1156
1095
        # Convert these into local objects to save lookup times
1157
1096
        pathjoin = osutils.pathjoin
1164
1103
        fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
1165
1104
 
1166
1105
        # directory file_id, relative path, absolute path, reverse sorted children
1167
 
        if from_dir is not None:
1168
 
            from_dir_id = inv.path2id(from_dir)
1169
 
            if from_dir_id is None:
1170
 
                # Directory not versioned
1171
 
                return
1172
 
            from_dir_abspath = pathjoin(self.basedir, from_dir)
1173
 
        else:
1174
 
            from_dir_id = inv.root.file_id
1175
 
            from_dir_abspath = self.basedir
1176
 
        children = os.listdir(from_dir_abspath)
 
1106
        children = os.listdir(self.basedir)
1177
1107
        children.sort()
1178
 
        # jam 20060527 The kernel sized tree seems equivalent whether we
 
1108
        # jam 20060527 The kernel sized tree seems equivalent whether we 
1179
1109
        # use a deque and popleft to keep them sorted, or if we use a plain
1180
1110
        # list and just reverse() them.
1181
1111
        children = collections.deque(children)
1182
 
        stack = [(from_dir_id, u'', from_dir_abspath, children)]
 
1112
        stack = [(inv.root.file_id, u'', self.basedir, children)]
1183
1113
        while stack:
1184
1114
            from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
1185
1115
 
1201
1131
 
1202
1132
                # absolute path
1203
1133
                fap = from_dir_abspath + '/' + f
1204
 
 
 
1134
                
1205
1135
                f_ie = inv.get_child(from_dir_id, f)
1206
1136
                if f_ie:
1207
1137
                    c = 'V'
1239
1169
                    except KeyError:
1240
1170
                        yield fp[1:], c, fk, None, TreeEntry()
1241
1171
                    continue
1242
 
 
 
1172
                
1243
1173
                if fk != 'directory':
1244
1174
                    continue
1245
1175
 
1246
 
                # But do this child first if recursing down
1247
 
                if recursive:
1248
 
                    new_children = os.listdir(fap)
1249
 
                    new_children.sort()
1250
 
                    new_children = collections.deque(new_children)
1251
 
                    stack.append((f_ie.file_id, fp, fap, new_children))
1252
 
                    # Break out of inner loop,
1253
 
                    # so that we start outer loop with child
1254
 
                    break
 
1176
                # But do this child first
 
1177
                new_children = os.listdir(fap)
 
1178
                new_children.sort()
 
1179
                new_children = collections.deque(new_children)
 
1180
                stack.append((f_ie.file_id, fp, fap, new_children))
 
1181
                # Break out of inner loop,
 
1182
                # so that we start outer loop with child
 
1183
                break
1255
1184
            else:
1256
1185
                # if we finished all children, pop it off the stack
1257
1186
                stack.pop()
1263
1192
        to_dir must exist in the inventory.
1264
1193
 
1265
1194
        If to_dir exists and is a directory, the files are moved into
1266
 
        it, keeping their old names.
 
1195
        it, keeping their old names.  
1267
1196
 
1268
1197
        Note that to_dir is only the last component of the new name;
1269
1198
        this doesn't change the directory.
1306
1235
                                       DeprecationWarning)
1307
1236
 
1308
1237
        # check destination directory
1309
 
        if isinstance(from_paths, basestring):
1310
 
            raise ValueError()
 
1238
        assert not isinstance(from_paths, basestring)
1311
1239
        inv = self.inventory
1312
1240
        to_abs = self.abspath(to_dir)
1313
1241
        if not isdir(to_abs):
1397
1325
                only_change_inv = True
1398
1326
            elif self.has_filename(from_rel) and not self.has_filename(to_rel):
1399
1327
                only_change_inv = False
1400
 
            elif (not self.case_sensitive
1401
 
                  and from_rel.lower() == to_rel.lower()
1402
 
                  and self.has_filename(from_rel)):
1403
 
                only_change_inv = False
1404
1328
            else:
1405
1329
                # something is wrong, so lets determine what exactly
1406
1330
                if not self.has_filename(from_rel) and \
1409
1333
                        errors.PathsDoNotExist(paths=(str(from_rel),
1410
1334
                        str(to_rel))))
1411
1335
                else:
1412
 
                    raise errors.RenameFailedFilesExist(from_rel, to_rel)
 
1336
                    raise errors.RenameFailedFilesExist(from_rel, to_rel,
 
1337
                        extra="(Use --after to update the Bazaar id)")
1413
1338
            rename_entry.only_change_inv = only_change_inv
1414
1339
        return rename_entries
1415
1340
 
1435
1360
        inv = self.inventory
1436
1361
        for entry in moved:
1437
1362
            try:
1438
 
                self._move_entry(WorkingTree._RenameEntry(
1439
 
                    entry.to_rel, entry.from_id,
 
1363
                self._move_entry(_RenameEntry(entry.to_rel, entry.from_id,
1440
1364
                    entry.to_tail, entry.to_parent_id, entry.from_rel,
1441
1365
                    entry.from_tail, entry.from_parent_id,
1442
1366
                    entry.only_change_inv))
1493
1417
        from_tail = splitpath(from_rel)[-1]
1494
1418
        from_id = inv.path2id(from_rel)
1495
1419
        if from_id is None:
1496
 
            # if file is missing in the inventory maybe it's in the basis_tree
1497
 
            basis_tree = self.branch.basis_tree()
1498
 
            from_id = basis_tree.path2id(from_rel)
1499
 
            if from_id is None:
1500
 
                raise errors.BzrRenameFailedError(from_rel,to_rel,
1501
 
                    errors.NotVersionedError(path=str(from_rel)))
1502
 
            # put entry back in the inventory so we can rename it
1503
 
            from_entry = basis_tree.inventory[from_id].copy()
1504
 
            inv.add(from_entry)
1505
 
        else:
1506
 
            from_entry = inv[from_id]
 
1420
            raise errors.BzrRenameFailedError(from_rel,to_rel,
 
1421
                errors.NotVersionedError(path=str(from_rel)))
 
1422
        from_entry = inv[from_id]
1507
1423
        from_parent_id = from_entry.parent_id
1508
1424
        to_dir, to_tail = os.path.split(to_rel)
1509
1425
        to_dir_id = inv.path2id(to_dir)
1555
1471
        These are files in the working directory that are not versioned or
1556
1472
        control files or ignored.
1557
1473
        """
1558
 
        # force the extras method to be fully executed before returning, to
 
1474
        # force the extras method to be fully executed before returning, to 
1559
1475
        # prevent race conditions with the lock
1560
1476
        return iter(
1561
1477
            [subp for subp in self.extras() if not self.is_ignored(subp)])
1571
1487
        :raises: NoSuchId if any fileid is not currently versioned.
1572
1488
        """
1573
1489
        for file_id in file_ids:
1574
 
            if file_id not in self._inventory:
1575
 
                raise errors.NoSuchId(self, file_id)
1576
 
        for file_id in file_ids:
 
1490
            file_id = osutils.safe_file_id(file_id)
1577
1491
            if self._inventory.has_id(file_id):
1578
1492
                self._inventory.remove_recursive_id(file_id)
 
1493
            else:
 
1494
                raise errors.NoSuchId(self, file_id)
1579
1495
        if len(file_ids):
1580
 
            # in the future this should just set a dirty bit to wait for the
 
1496
            # in the future this should just set a dirty bit to wait for the 
1581
1497
            # final unlock. However, until all methods of workingtree start
1582
 
            # with the current in -memory inventory rather than triggering
 
1498
            # with the current in -memory inventory rather than triggering 
1583
1499
            # a read, it is more complex - we need to teach read_inventory
1584
1500
            # to know when to read, and when to not read first... and possibly
1585
1501
            # to save first when the in memory one may be corrupted.
1586
1502
            # so for now, we just only write it if it is indeed dirty.
1587
1503
            # - RBC 20060907
1588
1504
            self._write_inventory(self._inventory)
 
1505
    
 
1506
    @deprecated_method(zero_eight)
 
1507
    def iter_conflicts(self):
 
1508
        """List all files in the tree that have text or content conflicts.
 
1509
        DEPRECATED.  Use conflicts instead."""
 
1510
        return self._iter_conflicts()
1589
1511
 
1590
1512
    def _iter_conflicts(self):
1591
1513
        conflicted = set()
1600
1522
 
1601
1523
    @needs_write_lock
1602
1524
    def pull(self, source, overwrite=False, stop_revision=None,
1603
 
             change_reporter=None, possible_transports=None, local=False):
 
1525
             change_reporter=None, possible_transports=None):
 
1526
        top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1604
1527
        source.lock_read()
1605
1528
        try:
 
1529
            pp = ProgressPhase("Pull phase", 2, top_pb)
 
1530
            pp.next_phase()
1606
1531
            old_revision_info = self.branch.last_revision_info()
1607
1532
            basis_tree = self.basis_tree()
1608
1533
            count = self.branch.pull(source, overwrite, stop_revision,
1609
 
                                     possible_transports=possible_transports,
1610
 
                                     local=local)
 
1534
                                     possible_transports=possible_transports)
1611
1535
            new_revision_info = self.branch.last_revision_info()
1612
1536
            if new_revision_info != old_revision_info:
 
1537
                pp.next_phase()
1613
1538
                repository = self.branch.repository
 
1539
                pb = bzrlib.ui.ui_factory.nested_progress_bar()
1614
1540
                basis_tree.lock_read()
1615
1541
                try:
1616
1542
                    new_basis_tree = self.branch.basis_tree()
1619
1545
                                new_basis_tree,
1620
1546
                                basis_tree,
1621
1547
                                this_tree=self,
1622
 
                                pb=None,
 
1548
                                pb=pb,
1623
1549
                                change_reporter=change_reporter)
1624
 
                    basis_root_id = basis_tree.get_root_id()
1625
 
                    new_root_id = new_basis_tree.get_root_id()
1626
 
                    if basis_root_id != new_root_id:
1627
 
                        self.set_root_id(new_root_id)
 
1550
                    if (basis_tree.inventory.root is None and
 
1551
                        new_basis_tree.inventory.root is not None):
 
1552
                        self.set_root_id(new_basis_tree.inventory.root.file_id)
1628
1553
                finally:
 
1554
                    pb.finished()
1629
1555
                    basis_tree.unlock()
1630
1556
                # TODO - dedup parents list with things merged by pull ?
1631
1557
                # reuse the revisiontree we merged against to set the new
1632
1558
                # tree data.
1633
1559
                parent_trees = [(self.branch.last_revision(), new_basis_tree)]
1634
 
                # we have to pull the merge trees out again, because
1635
 
                # merge_inner has set the ids. - this corner is not yet
 
1560
                # we have to pull the merge trees out again, because 
 
1561
                # merge_inner has set the ids. - this corner is not yet 
1636
1562
                # layered well enough to prevent double handling.
1637
1563
                # XXX TODO: Fix the double handling: telling the tree about
1638
1564
                # the already known parent data is wasteful.
1644
1570
            return count
1645
1571
        finally:
1646
1572
            source.unlock()
 
1573
            top_pb.finished()
1647
1574
 
1648
1575
    @needs_write_lock
1649
1576
    def put_file_bytes_non_atomic(self, file_id, bytes):
1650
1577
        """See MutableTree.put_file_bytes_non_atomic."""
 
1578
        file_id = osutils.safe_file_id(file_id)
1651
1579
        stream = file(self.id2abspath(file_id), 'wb')
1652
1580
        try:
1653
1581
            stream.write(bytes)
1675
1603
 
1676
1604
            fl = []
1677
1605
            for subf in os.listdir(dirabs):
1678
 
                if self.bzrdir.is_control_filename(subf):
 
1606
                if subf == '.bzr':
1679
1607
                    continue
1680
1608
                if subf not in dir_entry.children:
1681
 
                    try:
1682
 
                        (subf_norm,
1683
 
                         can_access) = osutils.normalized_filename(subf)
1684
 
                    except UnicodeDecodeError:
1685
 
                        path_os_enc = path.encode(osutils._fs_enc)
1686
 
                        relpath = path_os_enc + '/' + subf
1687
 
                        raise errors.BadFilenameEncoding(relpath,
1688
 
                                                         osutils._fs_enc)
 
1609
                    subf_norm, can_access = osutils.normalized_filename(subf)
1689
1610
                    if subf_norm != subf and can_access:
1690
1611
                        if subf_norm not in dir_entry.children:
1691
1612
                            fl.append(subf_norm)
1692
1613
                    else:
1693
1614
                        fl.append(subf)
1694
 
 
 
1615
            
1695
1616
            fl.sort()
1696
1617
            for subf in fl:
1697
1618
                subp = pathjoin(path, subf)
1734
1655
        r"""Check whether the filename matches an ignore pattern.
1735
1656
 
1736
1657
        Patterns containing '/' or '\' need to match the whole path;
1737
 
        others match against only the last component.  Patterns starting
1738
 
        with '!' are ignore exceptions.  Exceptions take precedence
1739
 
        over regular patterns and cause the filename to not be ignored.
 
1658
        others match against only the last component.
1740
1659
 
1741
1660
        If the file is ignored, returns the pattern which caused it to
1742
1661
        be ignored, otherwise None.  So this can simply be used as a
1743
1662
        boolean if desired."""
1744
1663
        if getattr(self, '_ignoreglobster', None) is None:
1745
 
            self._ignoreglobster = globbing.ExceptionGlobster(self.get_ignore_list())
 
1664
            self._ignoreglobster = globbing.Globster(self.get_ignore_list())
1746
1665
        return self._ignoreglobster.match(filename)
1747
1666
 
1748
1667
    def kind(self, file_id):
1749
1668
        return file_kind(self.id2abspath(file_id))
1750
1669
 
1751
 
    def stored_kind(self, file_id):
1752
 
        """See Tree.stored_kind"""
1753
 
        return self.inventory[file_id].kind
1754
 
 
1755
1670
    def _comparison_data(self, entry, path):
1756
1671
        abspath = self.abspath(path)
1757
1672
        try:
1839
1754
    def _reset_data(self):
1840
1755
        """Reset transient data that cannot be revalidated."""
1841
1756
        self._inventory_is_modified = False
1842
 
        f = self._transport.get('inventory')
1843
 
        try:
1844
 
            result = self._deserialize(f)
1845
 
        finally:
1846
 
            f.close()
 
1757
        result = self._deserialize(self._control_files.get('inventory'))
1847
1758
        self._set_inventory(result, dirty=False)
1848
1759
 
1849
1760
    @needs_tree_write_lock
1850
1761
    def set_last_revision(self, new_revision):
1851
1762
        """Change the last revision in the working tree."""
 
1763
        new_revision = osutils.safe_revision_id(new_revision)
1852
1764
        if self._change_last_revision(new_revision):
1853
1765
            self._cache_basis_inventory(new_revision)
1854
1766
 
1855
1767
    def _change_last_revision(self, new_revision):
1856
1768
        """Template method part of set_last_revision to perform the change.
1857
 
 
 
1769
        
1858
1770
        This is used to allow WorkingTree3 instances to not affect branch
1859
1771
        when their last revision is set.
1860
1772
        """
1870
1782
 
1871
1783
    def _write_basis_inventory(self, xml):
1872
1784
        """Write the basis inventory XML to the basis-inventory file"""
 
1785
        assert isinstance(xml, str), 'serialised xml must be bytestring.'
1873
1786
        path = self._basis_inventory_name()
1874
1787
        sio = StringIO(xml)
1875
 
        self._transport.put_file(path, sio,
1876
 
            mode=self.bzrdir._get_file_mode())
 
1788
        self._control_files.put(path, sio)
1877
1789
 
1878
1790
    def _create_basis_xml_from_inventory(self, revision_id, inventory):
1879
1791
        """Create the text that will be saved in basis-inventory"""
1880
 
        inventory.revision_id = revision_id
 
1792
        # TODO: jam 20070209 This should be redundant, as the revision_id
 
1793
        #       as all callers should have already converted the revision_id to
 
1794
        #       utf8
 
1795
        inventory.revision_id = osutils.safe_revision_id(revision_id)
1881
1796
        return xml7.serializer_v7.write_inventory_to_string(inventory)
1882
1797
 
1883
1798
    def _cache_basis_inventory(self, new_revision):
1886
1801
        # as commit already has that ready-to-use [while the format is the
1887
1802
        # same, that is].
1888
1803
        try:
1889
 
            # this double handles the inventory - unpack and repack -
 
1804
            # this double handles the inventory - unpack and repack - 
1890
1805
            # but is easier to understand. We can/should put a conditional
1891
1806
            # in here based on whether the inventory is in the latest format
1892
1807
            # - perhaps we should repack all inventories on a repository
1893
1808
            # upgrade ?
1894
1809
            # the fast path is to copy the raw xml from the repository. If the
1895
 
            # xml contains 'revision_id="', then we assume the right
 
1810
            # xml contains 'revision_id="', then we assume the right 
1896
1811
            # revision_id is set. We must check for this full string, because a
1897
1812
            # root node id can legitimately look like 'revision_id' but cannot
1898
1813
            # contain a '"'.
1899
 
            xml = self.branch.repository._get_inventory_xml(new_revision)
 
1814
            xml = self.branch.repository.get_inventory_xml(new_revision)
1900
1815
            firstline = xml.split('\n', 1)[0]
1901
 
            if (not 'revision_id="' in firstline or
 
1816
            if (not 'revision_id="' in firstline or 
1902
1817
                'format="7"' not in firstline):
1903
 
                inv = self.branch.repository._serializer.read_inventory_from_string(
1904
 
                    xml, new_revision)
 
1818
                inv = self.branch.repository.deserialise_inventory(
 
1819
                    new_revision, xml)
1905
1820
                xml = self._create_basis_xml_from_inventory(new_revision, inv)
1906
1821
            self._write_basis_inventory(xml)
1907
1822
        except (errors.NoSuchRevision, errors.RevisionNotPresent):
1910
1825
    def read_basis_inventory(self):
1911
1826
        """Read the cached basis inventory."""
1912
1827
        path = self._basis_inventory_name()
1913
 
        return self._transport.get_bytes(path)
1914
 
 
 
1828
        return self._control_files.get(path).read()
 
1829
        
1915
1830
    @needs_read_lock
1916
1831
    def read_working_inventory(self):
1917
1832
        """Read the working inventory.
1918
 
 
 
1833
        
1919
1834
        :raises errors.InventoryModified: read_working_inventory will fail
1920
1835
            when the current in memory inventory has been modified.
1921
1836
        """
1922
 
        # conceptually this should be an implementation detail of the tree.
 
1837
        # conceptually this should be an implementation detail of the tree. 
1923
1838
        # XXX: Deprecate this.
1924
1839
        # ElementTree does its own conversion from UTF-8, so open in
1925
1840
        # binary.
1926
1841
        if self._inventory_is_modified:
1927
1842
            raise errors.InventoryModified(self)
1928
 
        f = self._transport.get('inventory')
1929
 
        try:
1930
 
            result = self._deserialize(f)
1931
 
        finally:
1932
 
            f.close()
 
1843
        result = self._deserialize(self._control_files.get('inventory'))
1933
1844
        self._set_inventory(result, dirty=False)
1934
1845
        return result
1935
1846
 
1950
1861
 
1951
1862
        new_files=set()
1952
1863
        unknown_nested_files=set()
1953
 
        if to_file is None:
1954
 
            to_file = sys.stdout
1955
1864
 
1956
1865
        def recurse_directory_to_add_files(directory):
1957
1866
            # Recurse directory and add all files
1958
1867
            # so we can check if they have changed.
1959
1868
            for parent_info, file_infos in\
1960
 
                self.walkdirs(directory):
1961
 
                for relpath, basename, kind, lstat, fileid, kind in file_infos:
 
1869
                osutils.walkdirs(self.abspath(directory),
 
1870
                    directory):
 
1871
                for relpath, basename, kind, lstat, abspath in file_infos:
1962
1872
                    # Is it versioned or ignored?
1963
1873
                    if self.path2id(relpath) or self.is_ignored(relpath):
1964
1874
                        # Add nested content for deletion.
1974
1884
            filename = self.relpath(abspath)
1975
1885
            if len(filename) > 0:
1976
1886
                new_files.add(filename)
1977
 
                recurse_directory_to_add_files(filename)
 
1887
                if osutils.isdir(abspath):
 
1888
                    recurse_directory_to_add_files(filename)
1978
1889
 
1979
1890
        files = list(new_files)
1980
1891
 
1989
1900
            has_changed_files = len(unknown_nested_files) > 0
1990
1901
            if not has_changed_files:
1991
1902
                for (file_id, path, content_change, versioned, parent_id, name,
1992
 
                     kind, executable) in self.iter_changes(self.basis_tree(),
 
1903
                     kind, executable) in self._iter_changes(self.basis_tree(),
1993
1904
                         include_unchanged=True, require_versioned=False,
1994
1905
                         want_unversioned=True, specific_files=files):
1995
 
                    if versioned == (False, False):
1996
 
                        # The record is unknown ...
1997
 
                        if not self.is_ignored(path[1]):
1998
 
                            # ... but not ignored
1999
 
                            has_changed_files = True
2000
 
                            break
2001
 
                    elif content_change and (kind[1] is not None):
2002
 
                        # Versioned and changed, but not deleted
 
1906
                    # Check if it's an unknown (but not ignored) OR
 
1907
                    # changed (but not deleted) :
 
1908
                    if not self.is_ignored(path[1]) and (
 
1909
                        versioned == (False, False) or
 
1910
                        content_change and kind[1] != None):
2003
1911
                        has_changed_files = True
2004
1912
                        break
2005
1913
 
2013
1921
                        tree_delta.unversioned.extend((unknown_file,))
2014
1922
                raise errors.BzrRemoveChangedFilesError(tree_delta)
2015
1923
 
2016
 
        # Build inv_delta and delete files where applicable,
 
1924
        # Build inv_delta and delete files where applicaple,
2017
1925
        # do this before any modifications to inventory.
2018
1926
        for f in files:
2019
1927
            fid = self.path2id(f)
2027
1935
                        new_status = 'I'
2028
1936
                    else:
2029
1937
                        new_status = '?'
2030
 
                    # XXX: Really should be a more abstract reporter interface
2031
 
                    kind_ch = osutils.kind_marker(self.kind(fid))
2032
 
                    to_file.write(new_status + '       ' + f + kind_ch + '\n')
 
1938
                    textui.show_status(new_status, self.kind(fid), f,
 
1939
                                       to_file=to_file)
2033
1940
                # Unversion file
2034
1941
                inv_delta.append((f, None, fid, None))
2035
1942
                message = "removed %s" % (f,)
2058
1965
 
2059
1966
    @needs_tree_write_lock
2060
1967
    def revert(self, filenames=None, old_tree=None, backups=True,
2061
 
               pb=None, report_changes=False):
 
1968
               pb=DummyProgress(), report_changes=False):
2062
1969
        from bzrlib.conflicts import resolve
2063
1970
        if filenames == []:
2064
1971
            filenames = None
2066
1973
                ' as of bzr 0.91.  Please use None (the default) instead.',
2067
1974
                DeprecationWarning, stacklevel=2)
2068
1975
        if old_tree is None:
2069
 
            basis_tree = self.basis_tree()
2070
 
            basis_tree.lock_read()
2071
 
            old_tree = basis_tree
 
1976
            old_tree = self.basis_tree()
 
1977
        conflicts = transform.revert(self, old_tree, filenames, backups, pb,
 
1978
                                     report_changes)
 
1979
        if filenames is None:
 
1980
            self.set_parent_ids(self.get_parent_ids()[:1])
 
1981
            resolve(self)
2072
1982
        else:
2073
 
            basis_tree = None
2074
 
        try:
2075
 
            conflicts = transform.revert(self, old_tree, filenames, backups, pb,
2076
 
                                         report_changes)
2077
 
            if filenames is None and len(self.get_parent_ids()) > 1:
2078
 
                parent_trees = []
2079
 
                last_revision = self.last_revision()
2080
 
                if last_revision != _mod_revision.NULL_REVISION:
2081
 
                    if basis_tree is None:
2082
 
                        basis_tree = self.basis_tree()
2083
 
                        basis_tree.lock_read()
2084
 
                    parent_trees.append((last_revision, basis_tree))
2085
 
                self.set_parent_trees(parent_trees)
2086
 
                resolve(self)
2087
 
            else:
2088
 
                resolve(self, filenames, ignore_misses=True, recursive=True)
2089
 
        finally:
2090
 
            if basis_tree is not None:
2091
 
                basis_tree.unlock()
 
1983
            resolve(self, filenames, ignore_misses=True)
2092
1984
        return conflicts
2093
1985
 
2094
1986
    def revision_tree(self, revision_id):
2121
2013
    def set_inventory(self, new_inventory_list):
2122
2014
        from bzrlib.inventory import (Inventory,
2123
2015
                                      InventoryDirectory,
 
2016
                                      InventoryEntry,
2124
2017
                                      InventoryFile,
2125
2018
                                      InventoryLink)
2126
2019
        inv = Inventory(self.get_root_id())
2128
2021
            name = os.path.basename(path)
2129
2022
            if name == "":
2130
2023
                continue
2131
 
            # fixme, there should be a factory function inv,add_??
 
2024
            # fixme, there should be a factory function inv,add_?? 
2132
2025
            if kind == 'directory':
2133
2026
                inv.add(InventoryDirectory(file_id, name, parent))
2134
2027
            elif kind == 'file':
2142
2035
    @needs_tree_write_lock
2143
2036
    def set_root_id(self, file_id):
2144
2037
        """Set the root id for this tree."""
2145
 
        # for compatability
 
2038
        # for compatability 
2146
2039
        if file_id is None:
2147
 
            raise ValueError(
2148
 
                'WorkingTree.set_root_id with fileid=None')
2149
 
        file_id = osutils.safe_file_id(file_id)
 
2040
            symbol_versioning.warn(symbol_versioning.zero_twelve
 
2041
                % 'WorkingTree.set_root_id with fileid=None',
 
2042
                DeprecationWarning,
 
2043
                stacklevel=3)
 
2044
            file_id = ROOT_ID
 
2045
        else:
 
2046
            file_id = osutils.safe_file_id(file_id)
2150
2047
        self._set_root_id(file_id)
2151
2048
 
2152
2049
    def _set_root_id(self, file_id):
2153
2050
        """Set the root id for this tree, in a format specific manner.
2154
2051
 
2155
 
        :param file_id: The file id to assign to the root. It must not be
 
2052
        :param file_id: The file id to assign to the root. It must not be 
2156
2053
            present in the current inventory or an error will occur. It must
2157
2054
            not be None, but rather a valid file id.
2158
2055
        """
2177
2074
 
2178
2075
    def unlock(self):
2179
2076
        """See Branch.unlock.
2180
 
 
 
2077
        
2181
2078
        WorkingTree locking just uses the Branch locking facilities.
2182
2079
        This is current because all working trees have an embedded branch
2183
2080
        within them. IF in the future, we were to make branch data shareable
2184
 
        between multiple working trees, i.e. via shared storage, then we
 
2081
        between multiple working trees, i.e. via shared storage, then we 
2185
2082
        would probably want to lock both the local tree, and the branch.
2186
2083
        """
2187
2084
        raise NotImplementedError(self.unlock)
2188
2085
 
2189
 
    _marker = object()
2190
 
 
2191
 
    def update(self, change_reporter=None, possible_transports=None,
2192
 
               revision=None, old_tip=_marker):
 
2086
    def update(self, change_reporter=None, possible_transports=None):
2193
2087
        """Update a working tree along its branch.
2194
2088
 
2195
2089
        This will update the branch if its bound too, which means we have
2213
2107
        - Merge current state -> basis tree of the master w.r.t. the old tree
2214
2108
          basis.
2215
2109
        - Do a 'normal' merge of the old branch basis if it is relevant.
2216
 
 
2217
 
        :param revision: The target revision to update to. Must be in the
2218
 
            revision history.
2219
 
        :param old_tip: If branch.update() has already been run, the value it
2220
 
            returned (old tip of the branch or None). _marker is used
2221
 
            otherwise.
2222
2110
        """
2223
 
        if self.branch.get_bound_location() is not None:
 
2111
        if self.branch.get_master_branch(possible_transports) is not None:
2224
2112
            self.lock_write()
2225
 
            update_branch = (old_tip is self._marker)
 
2113
            update_branch = True
2226
2114
        else:
2227
2115
            self.lock_tree_write()
2228
2116
            update_branch = False
2230
2118
            if update_branch:
2231
2119
                old_tip = self.branch.update(possible_transports)
2232
2120
            else:
2233
 
                if old_tip is self._marker:
2234
 
                    old_tip = None
2235
 
            return self._update_tree(old_tip, change_reporter, revision)
 
2121
                old_tip = None
 
2122
            return self._update_tree(old_tip, change_reporter)
2236
2123
        finally:
2237
2124
            self.unlock()
2238
2125
 
2239
2126
    @needs_tree_write_lock
2240
 
    def _update_tree(self, old_tip=None, change_reporter=None, revision=None):
 
2127
    def _update_tree(self, old_tip=None, change_reporter=None):
2241
2128
        """Update a tree to the master branch.
2242
2129
 
2243
2130
        :param old_tip: if supplied, the previous tip revision the branch,
2249
2136
        # cant set that until we update the working trees last revision to be
2250
2137
        # one from the new branch, because it will just get absorbed by the
2251
2138
        # parent de-duplication logic.
2252
 
        #
 
2139
        # 
2253
2140
        # We MUST save it even if an error occurs, because otherwise the users
2254
2141
        # local work is unreferenced and will appear to have been lost.
2255
 
        #
2256
 
        nb_conflicts = 0
 
2142
        # 
 
2143
        result = 0
2257
2144
        try:
2258
2145
            last_rev = self.get_parent_ids()[0]
2259
2146
        except IndexError:
2260
2147
            last_rev = _mod_revision.NULL_REVISION
2261
 
        if revision is None:
2262
 
            revision = self.branch.last_revision()
2263
 
 
2264
 
        old_tip = old_tip or _mod_revision.NULL_REVISION
2265
 
 
2266
 
        if not _mod_revision.is_null(old_tip) and old_tip != last_rev:
2267
 
            # the branch we are bound to was updated
2268
 
            # merge those changes in first
2269
 
            base_tree  = self.basis_tree()
2270
 
            other_tree = self.branch.repository.revision_tree(old_tip)
2271
 
            nb_conflicts = merge.merge_inner(self.branch, other_tree,
2272
 
                                             base_tree, this_tree=self,
2273
 
                                             change_reporter=change_reporter)
2274
 
            if nb_conflicts:
2275
 
                self.add_parent_tree((old_tip, other_tree))
2276
 
                trace.note('Rerun update after fixing the conflicts.')
2277
 
                return nb_conflicts
2278
 
 
2279
 
        if last_rev != _mod_revision.ensure_null(revision):
2280
 
            # the working tree is up to date with the branch
2281
 
            # we can merge the specified revision from master
2282
 
            to_tree = self.branch.repository.revision_tree(revision)
2283
 
            to_root_id = to_tree.get_root_id()
2284
 
 
 
2148
        if last_rev != _mod_revision.ensure_null(self.branch.last_revision()):
 
2149
            # merge tree state up to new branch tip.
2285
2150
            basis = self.basis_tree()
2286
2151
            basis.lock_read()
2287
2152
            try:
2288
 
                if (basis.inventory.root is None
2289
 
                    or basis.inventory.root.file_id != to_root_id):
2290
 
                    self.set_root_id(to_root_id)
 
2153
                to_tree = self.branch.basis_tree()
 
2154
                if basis.inventory.root is None:
 
2155
                    self.set_root_id(to_tree.inventory.root.file_id)
2291
2156
                    self.flush()
 
2157
                result += merge.merge_inner(
 
2158
                                      self.branch,
 
2159
                                      to_tree,
 
2160
                                      basis,
 
2161
                                      this_tree=self,
 
2162
                                      change_reporter=change_reporter)
2292
2163
            finally:
2293
2164
                basis.unlock()
2294
 
 
2295
 
            # determine the branch point
2296
 
            graph = self.branch.repository.get_graph()
2297
 
            base_rev_id = graph.find_unique_lca(self.branch.last_revision(),
2298
 
                                                last_rev)
2299
 
            base_tree = self.branch.repository.revision_tree(base_rev_id)
2300
 
 
2301
 
            nb_conflicts = merge.merge_inner(self.branch, to_tree, base_tree,
2302
 
                                             this_tree=self,
2303
 
                                             change_reporter=change_reporter)
2304
 
            self.set_last_revision(revision)
2305
2165
            # TODO - dedup parents list with things merged by pull ?
2306
2166
            # reuse the tree we've updated to to set the basis:
2307
 
            parent_trees = [(revision, to_tree)]
 
2167
            parent_trees = [(self.branch.last_revision(), to_tree)]
2308
2168
            merges = self.get_parent_ids()[1:]
2309
2169
            # Ideally we ask the tree for the trees here, that way the working
2310
 
            # tree can decide whether to give us the entire tree or give us a
 
2170
            # tree can decide whether to give us teh entire tree or give us a
2311
2171
            # lazy initialised tree. dirstate for instance will have the trees
2312
2172
            # in ram already, whereas a last-revision + basis-inventory tree
2313
2173
            # will not, but also does not need them when setting parents.
2314
2174
            for parent in merges:
2315
2175
                parent_trees.append(
2316
2176
                    (parent, self.branch.repository.revision_tree(parent)))
2317
 
            if not _mod_revision.is_null(old_tip):
 
2177
            if (old_tip is not None and not _mod_revision.is_null(old_tip)):
2318
2178
                parent_trees.append(
2319
2179
                    (old_tip, self.branch.repository.revision_tree(old_tip)))
2320
2180
            self.set_parent_trees(parent_trees)
2321
2181
            last_rev = parent_trees[0][0]
2322
 
        return nb_conflicts
 
2182
        else:
 
2183
            # the working tree had the same last-revision as the master
 
2184
            # branch did. We may still have pivot local work from the local
 
2185
            # branch into old_tip:
 
2186
            if (old_tip is not None and not _mod_revision.is_null(old_tip)):
 
2187
                self.add_parent_tree_id(old_tip)
 
2188
        if (old_tip is not None and not _mod_revision.is_null(old_tip)
 
2189
            and old_tip != last_rev):
 
2190
            # our last revision was not the prior branch last revision
 
2191
            # and we have converted that last revision to a pending merge.
 
2192
            # base is somewhere between the branch tip now
 
2193
            # and the now pending merge
 
2194
 
 
2195
            # Since we just modified the working tree and inventory, flush out
 
2196
            # the current state, before we modify it again.
 
2197
            # TODO: jam 20070214 WorkingTree3 doesn't require this, dirstate
 
2198
            #       requires it only because TreeTransform directly munges the
 
2199
            #       inventory and calls tree._write_inventory(). Ultimately we
 
2200
            #       should be able to remove this extra flush.
 
2201
            self.flush()
 
2202
            graph = self.branch.repository.get_graph()
 
2203
            base_rev_id = graph.find_unique_lca(self.branch.last_revision(),
 
2204
                                                old_tip)
 
2205
            base_tree = self.branch.repository.revision_tree(base_rev_id)
 
2206
            other_tree = self.branch.repository.revision_tree(old_tip)
 
2207
            result += merge.merge_inner(
 
2208
                                  self.branch,
 
2209
                                  other_tree,
 
2210
                                  base_tree,
 
2211
                                  this_tree=self,
 
2212
                                  change_reporter=change_reporter)
 
2213
        return result
2323
2214
 
2324
2215
    def _write_hashcache_if_dirty(self):
2325
2216
        """Write out the hashcache if it is dirty."""
2409
2300
            current_inv = None
2410
2301
            inv_finished = True
2411
2302
        while not inv_finished or not disk_finished:
2412
 
            if current_disk:
2413
 
                ((cur_disk_dir_relpath, cur_disk_dir_path_from_top),
2414
 
                    cur_disk_dir_content) = current_disk
2415
 
            else:
2416
 
                ((cur_disk_dir_relpath, cur_disk_dir_path_from_top),
2417
 
                    cur_disk_dir_content) = ((None, None), None)
2418
2303
            if not disk_finished:
2419
2304
                # strip out .bzr dirs
2420
 
                if (cur_disk_dir_path_from_top[top_strip_len:] == '' and
2421
 
                    len(cur_disk_dir_content) > 0):
2422
 
                    # osutils.walkdirs can be made nicer -
 
2305
                if current_disk[0][1][top_strip_len:] == '':
 
2306
                    # osutils.walkdirs can be made nicer - 
2423
2307
                    # yield the path-from-prefix rather than the pathjoined
2424
2308
                    # value.
2425
 
                    bzrdir_loc = bisect_left(cur_disk_dir_content,
2426
 
                        ('.bzr', '.bzr'))
2427
 
                    if (bzrdir_loc < len(cur_disk_dir_content)
2428
 
                        and self.bzrdir.is_control_filename(
2429
 
                            cur_disk_dir_content[bzrdir_loc][0])):
 
2309
                    bzrdir_loc = bisect_left(current_disk[1], ('.bzr', '.bzr'))
 
2310
                    if current_disk[1][bzrdir_loc][0] == '.bzr':
2430
2311
                        # we dont yield the contents of, or, .bzr itself.
2431
 
                        del cur_disk_dir_content[bzrdir_loc]
 
2312
                        del current_disk[1][bzrdir_loc]
2432
2313
            if inv_finished:
2433
2314
                # everything is unknown
2434
2315
                direction = 1
2436
2317
                # everything is missing
2437
2318
                direction = -1
2438
2319
            else:
2439
 
                direction = cmp(current_inv[0][0], cur_disk_dir_relpath)
 
2320
                direction = cmp(current_inv[0][0], current_disk[0][0])
2440
2321
            if direction > 0:
2441
2322
                # disk is before inventory - unknown
2442
2323
                dirblock = [(relpath, basename, kind, stat, None, None) for
2443
 
                    relpath, basename, kind, stat, top_path in
2444
 
                    cur_disk_dir_content]
2445
 
                yield (cur_disk_dir_relpath, None), dirblock
 
2324
                    relpath, basename, kind, stat, top_path in current_disk[1]]
 
2325
                yield (current_disk[0][0], None), dirblock
2446
2326
                try:
2447
2327
                    current_disk = disk_iterator.next()
2448
2328
                except StopIteration:
2450
2330
            elif direction < 0:
2451
2331
                # inventory is before disk - missing.
2452
2332
                dirblock = [(relpath, basename, 'unknown', None, fileid, kind)
2453
 
                    for relpath, basename, dkind, stat, fileid, kind in
 
2333
                    for relpath, basename, dkind, stat, fileid, kind in 
2454
2334
                    current_inv[1]]
2455
2335
                yield (current_inv[0][0], current_inv[0][1]), dirblock
2456
2336
                try:
2462
2342
                # merge the inventory and disk data together
2463
2343
                dirblock = []
2464
2344
                for relpath, subiterator in itertools.groupby(sorted(
2465
 
                    current_inv[1] + cur_disk_dir_content,
2466
 
                    key=operator.itemgetter(0)), operator.itemgetter(1)):
 
2345
                    current_inv[1] + current_disk[1], key=operator.itemgetter(0)), operator.itemgetter(1)):
2467
2346
                    path_elements = list(subiterator)
2468
2347
                    if len(path_elements) == 2:
2469
2348
                        inv_row, disk_row = path_elements
2522
2401
                relroot = ""
2523
2402
            # FIXME: stash the node in pending
2524
2403
            entry = inv[top_id]
2525
 
            if entry.kind == 'directory':
2526
 
                for name, child in entry.sorted_children():
2527
 
                    dirblock.append((relroot + name, name, child.kind, None,
2528
 
                        child.file_id, child.kind
2529
 
                        ))
 
2404
            for name, child in entry.sorted_children():
 
2405
                dirblock.append((relroot + name, name, child.kind, None,
 
2406
                    child.file_id, child.kind
 
2407
                    ))
2530
2408
            yield (currentdir[0], entry.file_id), dirblock
2531
2409
            # push the user specified dirs from dirblock
2532
2410
            for dir in reversed(dirblock):
2565
2443
        self.set_conflicts(un_resolved)
2566
2444
        return un_resolved, resolved
2567
2445
 
2568
 
    @needs_read_lock
2569
 
    def _check(self, references):
2570
 
        """Check the tree for consistency.
2571
 
 
2572
 
        :param references: A dict with keys matching the items returned by
2573
 
            self._get_check_refs(), and values from looking those keys up in
2574
 
            the repository.
2575
 
        """
2576
 
        tree_basis = self.basis_tree()
2577
 
        tree_basis.lock_read()
2578
 
        try:
2579
 
            repo_basis = references[('trees', self.last_revision())]
2580
 
            if len(list(repo_basis.iter_changes(tree_basis))) > 0:
2581
 
                raise errors.BzrCheckError(
2582
 
                    "Mismatched basis inventory content.")
2583
 
            self._validate()
2584
 
        finally:
2585
 
            tree_basis.unlock()
2586
 
 
2587
2446
    def _validate(self):
2588
2447
        """Validate internal structures.
2589
2448
 
2595
2454
        """
2596
2455
        return
2597
2456
 
2598
 
    def _get_rules_searcher(self, default_searcher):
2599
 
        """See Tree._get_rules_searcher."""
2600
 
        if self._rules_searcher is None:
2601
 
            self._rules_searcher = super(WorkingTree,
2602
 
                self)._get_rules_searcher(default_searcher)
2603
 
        return self._rules_searcher
2604
 
 
2605
 
    def get_shelf_manager(self):
2606
 
        """Return the ShelfManager for this WorkingTree."""
2607
 
        from bzrlib.shelf import ShelfManager
2608
 
        return ShelfManager(self, self._transport)
2609
 
 
2610
2457
 
2611
2458
class WorkingTree2(WorkingTree):
2612
2459
    """This is the Format 2 working tree.
2613
2460
 
2614
 
    This was the first weave based working tree.
 
2461
    This was the first weave based working tree. 
2615
2462
     - uses os locks for locking.
2616
2463
     - uses the branch last-revision.
2617
2464
    """
2627
2474
        if self._inventory is None:
2628
2475
            self.read_working_inventory()
2629
2476
 
2630
 
    def _get_check_refs(self):
2631
 
        """Return the references needed to perform a check of this tree."""
2632
 
        return [('trees', self.last_revision())]
2633
 
 
2634
2477
    def lock_tree_write(self):
2635
2478
        """See WorkingTree.lock_tree_write().
2636
2479
 
2654
2497
            if self._inventory_is_modified:
2655
2498
                self.flush()
2656
2499
            self._write_hashcache_if_dirty()
2657
 
 
 
2500
                    
2658
2501
        # reverse order of locking.
2659
2502
        try:
2660
2503
            return self._control_files.unlock()
2676
2519
    def _last_revision(self):
2677
2520
        """See Mutable.last_revision."""
2678
2521
        try:
2679
 
            return self._transport.get_bytes('last-revision')
 
2522
            return osutils.safe_revision_id(
 
2523
                        self._control_files.get('last-revision').read())
2680
2524
        except errors.NoSuchFile:
2681
2525
            return _mod_revision.NULL_REVISION
2682
2526
 
2683
2527
    def _change_last_revision(self, revision_id):
2684
2528
        """See WorkingTree._change_last_revision."""
2685
 
        if revision_id is None or revision_id == _mod_revision.NULL_REVISION:
 
2529
        if revision_id is None or revision_id == NULL_REVISION:
2686
2530
            try:
2687
 
                self._transport.delete('last-revision')
 
2531
                self._control_files._transport.delete('last-revision')
2688
2532
            except errors.NoSuchFile:
2689
2533
                pass
2690
2534
            return False
2691
2535
        else:
2692
 
            self._transport.put_bytes('last-revision', revision_id,
2693
 
                mode=self.bzrdir._get_file_mode())
 
2536
            self._control_files.put_bytes('last-revision', revision_id)
2694
2537
            return True
2695
2538
 
2696
 
    def _get_check_refs(self):
2697
 
        """Return the references needed to perform a check of this tree."""
2698
 
        return [('trees', self.last_revision())]
2699
 
 
2700
2539
    @needs_tree_write_lock
2701
2540
    def set_conflicts(self, conflicts):
2702
 
        self._put_rio('conflicts', conflicts.to_stanzas(),
 
2541
        self._put_rio('conflicts', conflicts.to_stanzas(), 
2703
2542
                      CONFLICT_HEADER_1)
2704
2543
 
2705
2544
    @needs_tree_write_lock
2712
2551
    @needs_read_lock
2713
2552
    def conflicts(self):
2714
2553
        try:
2715
 
            confile = self._transport.get('conflicts')
 
2554
            confile = self._control_files.get('conflicts')
2716
2555
        except errors.NoSuchFile:
2717
2556
            return _mod_conflicts.ConflictList()
2718
2557
        try:
2719
 
            try:
2720
 
                if confile.next() != CONFLICT_HEADER_1 + '\n':
2721
 
                    raise errors.ConflictFormatError()
2722
 
            except StopIteration:
 
2558
            if confile.next() != CONFLICT_HEADER_1 + '\n':
2723
2559
                raise errors.ConflictFormatError()
2724
 
            return _mod_conflicts.ConflictList.from_stanzas(RioReader(confile))
2725
 
        finally:
2726
 
            confile.close()
 
2560
        except StopIteration:
 
2561
            raise errors.ConflictFormatError()
 
2562
        return _mod_conflicts.ConflictList.from_stanzas(RioReader(confile))
2727
2563
 
2728
2564
    def unlock(self):
2729
2565
        # do non-implementation specific cleanup
2746
2582
            return path[:-len(suffix)]
2747
2583
 
2748
2584
 
 
2585
@deprecated_function(zero_eight)
 
2586
def is_control_file(filename):
 
2587
    """See WorkingTree.is_control_filename(filename)."""
 
2588
    ## FIXME: better check
 
2589
    filename = normpath(filename)
 
2590
    while filename != '':
 
2591
        head, tail = os.path.split(filename)
 
2592
        ## mutter('check %r for control file' % ((head, tail),))
 
2593
        if tail == '.bzr':
 
2594
            return True
 
2595
        if filename == head:
 
2596
            break
 
2597
        filename = head
 
2598
    return False
 
2599
 
 
2600
 
2749
2601
class WorkingTreeFormat(object):
2750
2602
    """An encapsulation of the initialization and open routines for a format.
2751
2603
 
2754
2606
     * a format string,
2755
2607
     * an open routine.
2756
2608
 
2757
 
    Formats are placed in an dict by their format string for reference
 
2609
    Formats are placed in an dict by their format string for reference 
2758
2610
    during workingtree opening. Its not required that these be instances, they
2759
 
    can be classes themselves with class methods - it simply depends on
 
2611
    can be classes themselves with class methods - it simply depends on 
2760
2612
    whether state is needed for a given format or not.
2761
2613
 
2762
2614
    Once a format is deprecated, just deprecate the initialize and open
2763
 
    methods on the format class. Do not deprecate the object, as the
 
2615
    methods on the format class. Do not deprecate the object, as the 
2764
2616
    object will be created every time regardless.
2765
2617
    """
2766
2618
 
2779
2631
        """Return the format for the working tree object in a_bzrdir."""
2780
2632
        try:
2781
2633
            transport = a_bzrdir.get_workingtree_transport(None)
2782
 
            format_string = transport.get_bytes("format")
 
2634
            format_string = transport.get("format").read()
2783
2635
            return klass._formats[format_string]
2784
2636
        except errors.NoSuchFile:
2785
2637
            raise errors.NoWorkingTree(base=transport.base)
2786
2638
        except KeyError:
2787
 
            raise errors.UnknownFormatError(format=format_string,
2788
 
                                            kind="working tree")
 
2639
            raise errors.UnknownFormatError(format=format_string)
2789
2640
 
2790
2641
    def __eq__(self, other):
2791
2642
        return self.__class__ is other.__class__
2810
2661
        """Is this format supported?
2811
2662
 
2812
2663
        Supported formats can be initialized and opened.
2813
 
        Unsupported formats may not support initialization or committing or
 
2664
        Unsupported formats may not support initialization or committing or 
2814
2665
        some other features depending on the reason for not being supported.
2815
2666
        """
2816
2667
        return True
2817
2668
 
2818
 
    def supports_content_filtering(self):
2819
 
        """True if this format supports content filtering."""
2820
 
        return False
2821
 
 
2822
 
    def supports_views(self):
2823
 
        """True if this format supports stored views."""
2824
 
        return False
2825
 
 
2826
2669
    @classmethod
2827
2670
    def register_format(klass, format):
2828
2671
        klass._formats[format.get_format_string()] = format
2833
2676
 
2834
2677
    @classmethod
2835
2678
    def unregister_format(klass, format):
 
2679
        assert klass._formats[format.get_format_string()] is format
2836
2680
        del klass._formats[format.get_format_string()]
2837
2681
 
2838
2682
 
2839
2683
class WorkingTreeFormat2(WorkingTreeFormat):
2840
 
    """The second working tree format.
 
2684
    """The second working tree format. 
2841
2685
 
2842
2686
    This format modified the hash cache from the format 1 hash cache.
2843
2687
    """
2848
2692
        """See WorkingTreeFormat.get_format_description()."""
2849
2693
        return "Working tree format 2"
2850
2694
 
2851
 
    def _stub_initialize_on_transport(self, transport, file_mode):
2852
 
        """Workaround: create control files for a remote working tree.
2853
 
 
 
2695
    def stub_initialize_remote(self, control_files):
 
2696
        """As a special workaround create critical control files for a remote working tree
 
2697
        
2854
2698
        This ensures that it can later be updated and dealt with locally,
2855
 
        since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
 
2699
        since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with 
2856
2700
        no working tree.  (See bug #43064).
2857
2701
        """
2858
2702
        sio = StringIO()
2859
 
        inv = inventory.Inventory()
 
2703
        inv = Inventory()
2860
2704
        xml5.serializer_v5.write_inventory(inv, sio, working=True)
2861
2705
        sio.seek(0)
2862
 
        transport.put_file('inventory', sio, file_mode)
2863
 
        transport.put_bytes('pending-merges', '', file_mode)
2864
 
 
2865
 
    def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
2866
 
                   accelerator_tree=None, hardlink=False):
 
2706
        control_files.put('inventory', sio)
 
2707
 
 
2708
        control_files.put_bytes('pending-merges', '')
 
2709
        
 
2710
 
 
2711
    def initialize(self, a_bzrdir, revision_id=None):
2867
2712
        """See WorkingTreeFormat.initialize()."""
2868
2713
        if not isinstance(a_bzrdir.transport, LocalTransport):
2869
2714
            raise errors.NotLocalUrl(a_bzrdir.transport.base)
2870
 
        if from_branch is not None:
2871
 
            branch = from_branch
2872
 
        else:
2873
 
            branch = a_bzrdir.open_branch()
 
2715
        branch = a_bzrdir.open_branch()
2874
2716
        if revision_id is None:
2875
2717
            revision_id = _mod_revision.ensure_null(branch.last_revision())
 
2718
        else:
 
2719
            revision_id = osutils.safe_revision_id(revision_id)
2876
2720
        branch.lock_write()
2877
2721
        try:
2878
2722
            branch.generate_revision_history(revision_id)
2879
2723
        finally:
2880
2724
            branch.unlock()
2881
 
        inv = inventory.Inventory()
 
2725
        inv = Inventory()
2882
2726
        wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2883
2727
                         branch,
2884
2728
                         inv,
2887
2731
                         _bzrdir=a_bzrdir)
2888
2732
        basis_tree = branch.repository.revision_tree(revision_id)
2889
2733
        if basis_tree.inventory.root is not None:
2890
 
            wt.set_root_id(basis_tree.get_root_id())
 
2734
            wt.set_root_id(basis_tree.inventory.root.file_id)
2891
2735
        # set the parent list and cache the basis tree.
2892
2736
        if _mod_revision.is_null(revision_id):
2893
2737
            parent_trees = []
2929
2773
        - is new in bzr 0.8
2930
2774
        - uses a LockDir to guard access for writes.
2931
2775
    """
2932
 
 
 
2776
    
2933
2777
    upgrade_recommended = True
2934
2778
 
2935
2779
    def get_format_string(self):
2952
2796
 
2953
2797
    def _open_control_files(self, a_bzrdir):
2954
2798
        transport = a_bzrdir.get_workingtree_transport(None)
2955
 
        return LockableFiles(transport, self._lock_file_name,
 
2799
        return LockableFiles(transport, self._lock_file_name, 
2956
2800
                             self._lock_class)
2957
2801
 
2958
 
    def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
2959
 
                   accelerator_tree=None, hardlink=False):
 
2802
    def initialize(self, a_bzrdir, revision_id=None):
2960
2803
        """See WorkingTreeFormat.initialize().
2961
 
 
2962
 
        :param revision_id: if supplied, create a working tree at a different
2963
 
            revision than the branch is at.
2964
 
        :param accelerator_tree: A tree which can be used for retrieving file
2965
 
            contents more quickly than the revision tree, i.e. a workingtree.
2966
 
            The revision tree will be used for cases where accelerator_tree's
2967
 
            content is different.
2968
 
        :param hardlink: If true, hard-link files from accelerator_tree,
2969
 
            where possible.
 
2804
        
 
2805
        revision_id allows creating a working tree at a different
 
2806
        revision than the branch is at.
2970
2807
        """
2971
2808
        if not isinstance(a_bzrdir.transport, LocalTransport):
2972
2809
            raise errors.NotLocalUrl(a_bzrdir.transport.base)
2974
2811
        control_files = self._open_control_files(a_bzrdir)
2975
2812
        control_files.create_lock()
2976
2813
        control_files.lock_write()
2977
 
        transport.put_bytes('format', self.get_format_string(),
2978
 
            mode=a_bzrdir._get_file_mode())
2979
 
        if from_branch is not None:
2980
 
            branch = from_branch
2981
 
        else:
2982
 
            branch = a_bzrdir.open_branch()
 
2814
        control_files.put_utf8('format', self.get_format_string())
 
2815
        branch = a_bzrdir.open_branch()
2983
2816
        if revision_id is None:
2984
2817
            revision_id = _mod_revision.ensure_null(branch.last_revision())
 
2818
        else:
 
2819
            revision_id = osutils.safe_revision_id(revision_id)
2985
2820
        # WorkingTree3 can handle an inventory which has a unique root id.
2986
2821
        # as of bzr 0.12. However, bzr 0.11 and earlier fail to handle
2987
2822
        # those trees. And because there isn't a format bump inbetween, we
3000
2835
            basis_tree = branch.repository.revision_tree(revision_id)
3001
2836
            # only set an explicit root id if there is one to set.
3002
2837
            if basis_tree.inventory.root is not None:
3003
 
                wt.set_root_id(basis_tree.get_root_id())
3004
 
            if revision_id == _mod_revision.NULL_REVISION:
 
2838
                wt.set_root_id(basis_tree.inventory.root.file_id)
 
2839
            if revision_id == NULL_REVISION:
3005
2840
                wt.set_parent_trees([])
3006
2841
            else:
3007
2842
                wt.set_parent_trees([(revision_id, basis_tree)])
3014
2849
        return wt
3015
2850
 
3016
2851
    def _initial_inventory(self):
3017
 
        return inventory.Inventory()
 
2852
        return Inventory()
3018
2853
 
3019
2854
    def __init__(self):
3020
2855
        super(WorkingTreeFormat3, self).__init__()
3035
2870
 
3036
2871
    def _open(self, a_bzrdir, control_files):
3037
2872
        """Open the tree itself.
3038
 
 
 
2873
        
3039
2874
        :param a_bzrdir: the dir for the tree.
3040
2875
        :param control_files: the control files for the tree.
3041
2876
        """
3049
2884
        return self.get_format_string()
3050
2885
 
3051
2886
 
3052
 
__default_format = WorkingTreeFormat6()
 
2887
__default_format = WorkingTreeFormat4()
3053
2888
WorkingTreeFormat.register_format(__default_format)
3054
 
WorkingTreeFormat.register_format(WorkingTreeFormat5())
3055
 
WorkingTreeFormat.register_format(WorkingTreeFormat4())
3056
2889
WorkingTreeFormat.register_format(WorkingTreeFormat3())
3057
2890
WorkingTreeFormat.set_default_format(__default_format)
3058
2891
# formats which have no format string are not discoverable