~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/workingtree.py

Merge bzr.dev

Show diffs side-by-side

added added

removed removed

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