/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to bzrlib/workingtree.py

  • Committer: John Arbash Meinel
  • Date: 2007-03-14 20:15:52 UTC
  • mto: (2353.4.2 locking)
  • mto: This revision was merged to the branch mainline in revision 2360.
  • Revision ID: john@arbash-meinel.com-20070314201552-bjtfua57456dviep
Update the lock code and test code so that if more than one
lock implementation is available, they will both be tested.

It is quite a bit of overhead, for a case where we are likely to only have 1
real lock implementation per platform, but hey, for now we have 2.

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