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