/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-09-05 05:51:34 UTC
  • mto: (2592.3.126 repository)
  • mto: This revision was merged to the branch mainline in revision 2879.
  • Revision ID: robertc@robertcollins.net-20070905055134-pwbueao0qq6krf9u
nuke _read_tree_state and snapshot from inventory, moving responsibility into the commit builder.

Show diffs side-by-side

added added

removed removed

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