~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/workingtree.py

  • Committer: John Arbash Meinel
  • Date: 2009-09-25 21:24:21 UTC
  • mfrom: (4634.52.3 2.0)
  • mto: This revision was merged to the branch mainline in revision 4716.
  • Revision ID: john@arbash-meinel.com-20090925212421-2xhep7gf3e4717op
Merge the 2.0.x stable series into bzr.dev.

This includes the 2.0.0 release and the update for CHKInventory.filter()

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005, 2006 Canonical Ltd
 
1
# Copyright (C) 2005, 2006, 2007, 2008, 2009 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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 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
38
38
 
39
39
from cStringIO import StringIO
40
40
import os
41
 
import re
 
41
import sys
42
42
 
43
43
from bzrlib.lazy_import import lazy_import
44
44
lazy_import(globals(), """
 
45
from bisect import bisect_left
45
46
import collections
46
 
from copy import deepcopy
47
47
import errno
48
 
import fnmatch
 
48
import itertools
 
49
import operator
49
50
import stat
50
 
from time import time
51
 
import warnings
 
51
import re
52
52
 
53
53
import bzrlib
54
54
from bzrlib import (
 
55
    branch,
55
56
    bzrdir,
56
57
    conflicts as _mod_conflicts,
57
58
    errors,
 
59
    generate_ids,
 
60
    globbing,
 
61
    graph as _mod_graph,
 
62
    hashcache,
58
63
    ignores,
 
64
    inventory,
59
65
    merge,
60
 
    osutils,
 
66
    revision as _mod_revision,
 
67
    revisiontree,
61
68
    textui,
 
69
    trace,
62
70
    transform,
63
 
    urlutils,
 
71
    ui,
 
72
    views,
64
73
    xml5,
65
 
    xml6,
 
74
    xml7,
66
75
    )
67
76
import bzrlib.branch
68
77
from bzrlib.transport import get_transport
69
 
import bzrlib.ui
 
78
from bzrlib.workingtree_4 import (
 
79
    WorkingTreeFormat4,
 
80
    WorkingTreeFormat5,
 
81
    WorkingTreeFormat6,
 
82
    )
70
83
""")
71
84
 
72
85
from bzrlib import symbol_versioning
73
86
from bzrlib.decorators import needs_read_lock, needs_write_lock
74
 
from bzrlib.errors import (BzrCheckError,
75
 
                           BzrError,
76
 
                           ConflictFormatError,
77
 
                           WeaveRevisionNotPresent,
78
 
                           NotBranchError,
79
 
                           NoSuchFile,
80
 
                           NotVersionedError,
81
 
                           MergeModifiedFormatError,
82
 
                           UnsupportedOperation,
83
 
                           )
84
 
from bzrlib.inventory import InventoryEntry, Inventory, ROOT_ID
85
 
from bzrlib.lockable_files import LockableFiles, TransportLock
 
87
from bzrlib.lockable_files import LockableFiles
86
88
from bzrlib.lockdir import LockDir
87
89
import bzrlib.mutabletree
88
90
from bzrlib.mutabletree import needs_tree_write_lock
 
91
from bzrlib import osutils
89
92
from bzrlib.osutils import (
90
 
    compact_date,
91
93
    file_kind,
92
94
    isdir,
 
95
    normpath,
93
96
    pathjoin,
 
97
    realpath,
94
98
    safe_unicode,
95
99
    splitpath,
96
 
    rand_chars,
97
 
    normpath,
98
 
    realpath,
99
100
    supports_executable,
100
101
    )
 
102
from bzrlib.filters import filtered_input_file
101
103
from bzrlib.trace import mutter, note
102
104
from bzrlib.transport.local import LocalTransport
103
 
import bzrlib.tree
104
105
from bzrlib.progress import DummyProgress, ProgressPhase
105
 
from bzrlib.revision import NULL_REVISION
106
 
import bzrlib.revisiontree
 
106
from bzrlib.revision import CURRENT_REVISION
107
107
from bzrlib.rio import RioReader, rio_file, Stanza
108
 
from bzrlib.symbol_versioning import (deprecated_passed,
109
 
        deprecated_method,
110
 
        deprecated_function,
111
 
        DEPRECATED_PARAMETER,
112
 
        zero_eight,
113
 
        zero_eleven,
114
 
        )
 
108
from bzrlib.symbol_versioning import (
 
109
    deprecated_passed,
 
110
    DEPRECATED_PARAMETER,
 
111
    )
115
112
 
116
113
 
117
114
MERGE_MODIFIED_HEADER_1 = "BZR merge-modified list format 1"
118
115
CONFLICT_HEADER_1 = "BZR conflict list format 1"
119
116
 
120
 
# the regex removes any weird characters; we don't escape them 
121
 
# but rather just pull them out
122
 
_gen_file_id_re = re.compile(r'[^\w.]')
123
 
_gen_id_suffix = None
124
 
_gen_id_serial = 0
125
 
 
126
 
 
127
 
def _next_id_suffix():
128
 
    """Create a new file id suffix that is reasonably unique.
129
 
    
130
 
    On the first call we combine the current time with 64 bits of randomness
131
 
    to give a highly probably globally unique number. Then each call in the same
132
 
    process adds 1 to a serial number we append to that unique value.
133
 
    """
134
 
    # XXX TODO: change bzrlib.add.smart_add to call workingtree.add() rather 
135
 
    # than having to move the id randomness out of the inner loop like this.
136
 
    # XXX TODO: for the global randomness this uses we should add the thread-id
137
 
    # before the serial #.
138
 
    global _gen_id_suffix, _gen_id_serial
139
 
    if _gen_id_suffix is None:
140
 
        _gen_id_suffix = "-%s-%s-" % (compact_date(time()), rand_chars(16))
141
 
    _gen_id_serial += 1
142
 
    return _gen_id_suffix + str(_gen_id_serial)
143
 
 
144
 
 
145
 
def gen_file_id(name):
146
 
    """Return new file id for the basename 'name'.
147
 
 
148
 
    The uniqueness is supplied from _next_id_suffix.
149
 
    """
150
 
    # The real randomness is in the _next_id_suffix, the
151
 
    # rest of the identifier is just to be nice.
152
 
    # So we:
153
 
    # 1) Remove non-ascii word characters to keep the ids portable
154
 
    # 2) squash to lowercase, so the file id doesn't have to
155
 
    #    be escaped (case insensitive filesystems would bork for ids
156
 
    #    that only differred in case without escaping).
157
 
    # 3) truncate the filename to 20 chars. Long filenames also bork on some
158
 
    #    filesystems
159
 
    # 4) Removing starting '.' characters to prevent the file ids from
160
 
    #    being considered hidden.
161
 
    ascii_word_only = _gen_file_id_re.sub('', name.lower())
162
 
    short_no_dots = ascii_word_only.lstrip('.')[:20]
163
 
    return short_no_dots + _next_id_suffix()
164
 
 
165
 
 
166
 
def gen_root_id():
167
 
    """Return a new tree-root file id."""
168
 
    return gen_file_id('tree_root')
 
117
ERROR_PATH_NOT_FOUND = 3    # WindowsError errno code, equivalent to ENOENT
169
118
 
170
119
 
171
120
class TreeEntry(object):
172
121
    """An entry that implements the minimum interface used by commands.
173
122
 
174
 
    This needs further inspection, it may be better to have 
 
123
    This needs further inspection, it may be better to have
175
124
    InventoryEntries without ids - though that seems wrong. For now,
176
125
    this is a parallel hierarchy to InventoryEntry, and needs to become
177
126
    one of several things: decorates to that hierarchy, children of, or
180
129
    no InventoryEntry available - i.e. for unversioned objects.
181
130
    Perhaps they should be UnversionedEntry et al. ? - RBC 20051003
182
131
    """
183
 
 
 
132
 
184
133
    def __eq__(self, other):
185
134
        # yes, this us ugly, TODO: best practice __eq__ style.
186
135
        return (isinstance(other, TreeEntry)
187
136
                and other.__class__ == self.__class__)
188
 
 
 
137
 
189
138
    def kind_character(self):
190
139
        return "???"
191
140
 
233
182
    not listed in the Inventory and vice versa.
234
183
    """
235
184
 
 
185
    # override this to set the strategy for storing views
 
186
    def _make_views(self):
 
187
        return views.DisabledViews(self)
 
188
 
236
189
    def __init__(self, basedir='.',
237
190
                 branch=DEPRECATED_PARAMETER,
238
191
                 _inventory=None,
240
193
                 _internal=False,
241
194
                 _format=None,
242
195
                 _bzrdir=None):
243
 
        """Construct a WorkingTree for basedir.
 
196
        """Construct a WorkingTree instance. This is not a public API.
244
197
 
245
 
        If the branch is not supplied, it is opened automatically.
246
 
        If the branch is supplied, it must be the branch for this basedir.
247
 
        (branch.base is not cross checked, because for remote branches that
248
 
        would be meaningless).
 
198
        :param branch: A branch to override probing for the branch.
249
199
        """
250
200
        self._format = _format
251
201
        self.bzrdir = _bzrdir
252
202
        if not _internal:
253
 
            # not created via open etc.
254
 
            warnings.warn("WorkingTree() is deprecated as of bzr version 0.8. "
255
 
                 "Please use bzrdir.open_workingtree or WorkingTree.open().",
256
 
                 DeprecationWarning,
257
 
                 stacklevel=2)
258
 
            wt = WorkingTree.open(basedir)
259
 
            self._branch = wt.branch
260
 
            self.basedir = wt.basedir
261
 
            self._control_files = wt._control_files
262
 
            self._hashcache = wt._hashcache
263
 
            self._set_inventory(wt._inventory, dirty=False)
264
 
            self._format = wt._format
265
 
            self.bzrdir = wt.bzrdir
266
 
        from bzrlib.hashcache import HashCache
267
 
        from bzrlib.trace import note, mutter
268
 
        assert isinstance(basedir, basestring), \
269
 
            "base directory %r is not a string" % basedir
 
203
            raise errors.BzrError("Please use bzrdir.open_workingtree or "
 
204
                "WorkingTree.open() to obtain a WorkingTree.")
270
205
        basedir = safe_unicode(basedir)
271
206
        mutter("opening working tree %r", basedir)
272
207
        if deprecated_passed(branch):
273
 
            if not _internal:
274
 
                warnings.warn("WorkingTree(..., branch=XXX) is deprecated as of bzr 0.8."
275
 
                     " Please use bzrdir.open_workingtree() or"
276
 
                     " WorkingTree.open().",
277
 
                     DeprecationWarning,
278
 
                     stacklevel=2
279
 
                     )
280
208
            self._branch = branch
281
209
        else:
282
210
            self._branch = self.bzrdir.open_branch()
287
215
            self._control_files = self.branch.control_files
288
216
        else:
289
217
            # assume all other formats have their own control files.
290
 
            assert isinstance(_control_files, LockableFiles), \
291
 
                    "_control_files must be a LockableFiles, not %r" \
292
 
                    % _control_files
293
218
            self._control_files = _control_files
 
219
        self._transport = self._control_files._transport
294
220
        # update the whole cache up front and write to disk if anything changed;
295
221
        # in the future we might want to do this more selectively
296
222
        # two possible ways offer themselves : in self._unlock, write the cache
297
223
        # if needed, or, when the cache sees a change, append it to the hash
298
224
        # cache file, and have the parser take the most recent entry for a
299
225
        # given path only.
300
 
        cache_filename = self.bzrdir.get_workingtree_transport(None).local_abspath('stat-cache')
301
 
        hc = self._hashcache = HashCache(basedir, cache_filename, self._control_files._file_mode)
 
226
        wt_trans = self.bzrdir.get_workingtree_transport(None)
 
227
        cache_filename = wt_trans.local_abspath('stat-cache')
 
228
        self._hashcache = hashcache.HashCache(basedir, cache_filename,
 
229
            self.bzrdir._get_file_mode(),
 
230
            self._content_filter_stack_provider())
 
231
        hc = self._hashcache
302
232
        hc.read()
303
233
        # is this scan needed ? it makes things kinda slow.
304
234
        #hc.scan()
308
238
            hc.write()
309
239
 
310
240
        if _inventory is None:
 
241
            # This will be acquired on lock_read() or lock_write()
311
242
            self._inventory_is_modified = False
312
 
            self.read_working_inventory()
 
243
            self._inventory = None
313
244
        else:
314
245
            # the caller of __init__ has provided an inventory,
315
246
            # we assume they know what they are doing - as its only
316
247
            # the Format factory and creation methods that are
317
248
            # permitted to do this.
318
249
            self._set_inventory(_inventory, dirty=False)
 
250
        self._detect_case_handling()
 
251
        self._rules_searcher = None
 
252
        self.views = self._make_views()
 
253
 
 
254
    def _detect_case_handling(self):
 
255
        wt_trans = self.bzrdir.get_workingtree_transport(None)
 
256
        try:
 
257
            wt_trans.stat("FoRMaT")
 
258
        except errors.NoSuchFile:
 
259
            self.case_sensitive = True
 
260
        else:
 
261
            self.case_sensitive = False
 
262
 
 
263
        self._setup_directory_is_tree_reference()
319
264
 
320
265
    branch = property(
321
266
        fget=lambda self: self._branch,
336
281
        self._control_files.break_lock()
337
282
        self.branch.break_lock()
338
283
 
 
284
    def _get_check_refs(self):
 
285
        """Return the references needed to perform a check of this tree.
 
286
        
 
287
        The default implementation returns no refs, and is only suitable for
 
288
        trees that have no local caching and can commit on ghosts at any time.
 
289
 
 
290
        :seealso: bzrlib.check for details about check_refs.
 
291
        """
 
292
        return []
 
293
 
 
294
    def requires_rich_root(self):
 
295
        return self._format.requires_rich_root
 
296
 
 
297
    def supports_tree_reference(self):
 
298
        return False
 
299
 
 
300
    def supports_content_filtering(self):
 
301
        return self._format.supports_content_filtering()
 
302
 
 
303
    def supports_views(self):
 
304
        return self.views.supports_views()
 
305
 
339
306
    def _set_inventory(self, inv, dirty):
340
307
        """Set the internal cached inventory.
341
308
 
346
313
            False then the inventory is the same as that on disk and any
347
314
            serialisation would be unneeded overhead.
348
315
        """
349
 
        assert inv.root is not None
350
316
        self._inventory = inv
351
317
        self._inventory_is_modified = dirty
352
318
 
356
322
 
357
323
        """
358
324
        if path is None:
359
 
            path = os.path.getcwdu()
 
325
            path = osutils.getcwd()
360
326
        control = bzrdir.BzrDir.open(path, _unsupported)
361
327
        return control.open_workingtree(_unsupported)
362
 
        
 
328
 
363
329
    @staticmethod
364
330
    def open_containing(path=None):
365
331
        """Open an existing working tree which has its root about path.
366
 
        
 
332
 
367
333
        This probes for a working tree at path and searches upwards from there.
368
334
 
369
335
        Basically we keep looking up until we find the control directory or
387
353
        """
388
354
        return WorkingTree.open(path, _unsupported=True)
389
355
 
 
356
    @staticmethod
 
357
    def find_trees(location):
 
358
        def list_current(transport):
 
359
            return [d for d in transport.list_dir('') if d != '.bzr']
 
360
        def evaluate(bzrdir):
 
361
            try:
 
362
                tree = bzrdir.open_workingtree()
 
363
            except errors.NoWorkingTree:
 
364
                return True, None
 
365
            else:
 
366
                return True, tree
 
367
        transport = get_transport(location)
 
368
        iterator = bzrdir.BzrDir.find_bzrdirs(transport, evaluate=evaluate,
 
369
                                              list_current=list_current)
 
370
        return [t for t in iterator if t is not None]
 
371
 
 
372
    # should be deprecated - this is slow and in any case treating them as a
 
373
    # container is (we now know) bad style -- mbp 20070302
 
374
    ## @deprecated_method(zero_fifteen)
390
375
    def __iter__(self):
391
376
        """Iterate through file_ids for this tree.
392
377
 
398
383
            if osutils.lexists(self.abspath(path)):
399
384
                yield ie.file_id
400
385
 
 
386
    def all_file_ids(self):
 
387
        """See Tree.iter_all_file_ids"""
 
388
        return set(self.inventory)
 
389
 
401
390
    def __repr__(self):
402
391
        return "<%s of %s>" % (self.__class__.__name__,
403
392
                               getattr(self, 'basedir', None))
404
393
 
405
394
    def abspath(self, filename):
406
395
        return pathjoin(self.basedir, filename)
407
 
    
 
396
 
408
397
    def basis_tree(self):
409
398
        """Return RevisionTree for the current last revision.
410
 
        
 
399
 
411
400
        If the left most parent is a ghost then the returned tree will be an
412
 
        empty tree - one obtained by calling repository.revision_tree(None).
 
401
        empty tree - one obtained by calling
 
402
        repository.revision_tree(NULL_REVISION).
413
403
        """
414
404
        try:
415
405
            revision_id = self.get_parent_ids()[0]
417
407
            # no parents, return an empty revision tree.
418
408
            # in the future this should return the tree for
419
409
            # 'empty:' - the implicit root empty tree.
420
 
            return self.branch.repository.revision_tree(None)
421
 
        else:
422
 
            try:
423
 
                xml = self.read_basis_inventory()
424
 
                inv = xml6.serializer_v6.read_inventory_from_string(xml)
425
 
                if inv is not None and inv.revision_id == revision_id:
426
 
                    return bzrlib.revisiontree.RevisionTree(
427
 
                        self.branch.repository, inv, revision_id)
428
 
            except (NoSuchFile, errors.BadInventoryFormat):
429
 
                pass
 
410
            return self.branch.repository.revision_tree(
 
411
                       _mod_revision.NULL_REVISION)
 
412
        try:
 
413
            return self.revision_tree(revision_id)
 
414
        except errors.NoSuchRevision:
 
415
            pass
430
416
        # No cached copy available, retrieve from the repository.
431
417
        # FIXME? RBC 20060403 should we cache the inventory locally
432
418
        # at this point ?
433
419
        try:
434
420
            return self.branch.repository.revision_tree(revision_id)
435
 
        except errors.RevisionNotPresent:
 
421
        except (errors.RevisionNotPresent, errors.NoSuchRevision):
436
422
            # the basis tree *may* be a ghost or a low level error may have
437
 
            # occured. If the revision is present, its a problem, if its not
 
423
            # occurred. If the revision is present, its a problem, if its not
438
424
            # its a ghost.
439
425
            if self.branch.repository.has_revision(revision_id):
440
426
                raise
441
427
            # the basis tree is a ghost so return an empty tree.
442
 
            return self.branch.repository.revision_tree(None)
443
 
 
444
 
    @staticmethod
445
 
    @deprecated_method(zero_eight)
446
 
    def create(branch, directory):
447
 
        """Create a workingtree for branch at directory.
448
 
 
449
 
        If existing_directory already exists it must have a .bzr directory.
450
 
        If it does not exist, it will be created.
451
 
 
452
 
        This returns a new WorkingTree object for the new checkout.
453
 
 
454
 
        TODO FIXME RBC 20060124 when we have checkout formats in place this
455
 
        should accept an optional revisionid to checkout [and reject this if
456
 
        checking out into the same dir as a pre-checkout-aware branch format.]
457
 
 
458
 
        XXX: When BzrDir is present, these should be created through that 
459
 
        interface instead.
460
 
        """
461
 
        warnings.warn('delete WorkingTree.create', stacklevel=3)
462
 
        transport = get_transport(directory)
463
 
        if branch.bzrdir.root_transport.base == transport.base:
464
 
            # same dir 
465
 
            return branch.bzrdir.create_workingtree()
466
 
        # different directory, 
467
 
        # create a branch reference
468
 
        # and now a working tree.
469
 
        raise NotImplementedError
470
 
 
471
 
    @staticmethod
472
 
    @deprecated_method(zero_eight)
473
 
    def create_standalone(directory):
474
 
        """Create a checkout and a branch and a repo at directory.
475
 
 
476
 
        Directory must exist and be empty.
477
 
 
478
 
        please use BzrDir.create_standalone_workingtree
479
 
        """
480
 
        return bzrdir.BzrDir.create_standalone_workingtree(directory)
 
428
            return self.branch.repository.revision_tree(
 
429
                       _mod_revision.NULL_REVISION)
 
430
 
 
431
    def _cleanup(self):
 
432
        self._flush_ignore_list_cache()
481
433
 
482
434
    def relpath(self, path):
483
435
        """Return the local path portion from a given path.
484
 
        
485
 
        The path may be absolute or relative. If its a relative path it is 
 
436
 
 
437
        The path may be absolute or relative. If its a relative path it is
486
438
        interpreted relative to the python current working directory.
487
439
        """
488
440
        return osutils.relpath(self.basedir, path)
490
442
    def has_filename(self, filename):
491
443
        return osutils.lexists(self.abspath(filename))
492
444
 
493
 
    def get_file(self, file_id):
494
 
        return self.get_file_byname(self.id2path(file_id))
495
 
 
496
 
    def get_file_text(self, file_id):
497
 
        return self.get_file(file_id).read()
498
 
 
499
 
    def get_file_byname(self, filename):
500
 
        return file(self.abspath(filename), 'rb')
 
445
    def get_file(self, file_id, path=None, filtered=True):
 
446
        return self.get_file_with_stat(file_id, path, filtered=filtered)[0]
 
447
 
 
448
    def get_file_with_stat(self, file_id, path=None, filtered=True,
 
449
        _fstat=os.fstat):
 
450
        """See Tree.get_file_with_stat."""
 
451
        if path is None:
 
452
            path = self.id2path(file_id)
 
453
        file_obj = self.get_file_byname(path, filtered=False)
 
454
        stat_value = _fstat(file_obj.fileno())
 
455
        if filtered and self.supports_content_filtering():
 
456
            filters = self._content_filter_stack(path)
 
457
            file_obj = filtered_input_file(file_obj, filters)
 
458
        return (file_obj, stat_value)
 
459
 
 
460
    def get_file_text(self, file_id, path=None, filtered=True):
 
461
        return self.get_file(file_id, path=path, filtered=filtered).read()
 
462
 
 
463
    def get_file_byname(self, filename, filtered=True):
 
464
        path = self.abspath(filename)
 
465
        f = file(path, 'rb')
 
466
        if filtered and self.supports_content_filtering():
 
467
            filters = self._content_filter_stack(filename)
 
468
            return filtered_input_file(f, filters)
 
469
        else:
 
470
            return f
 
471
 
 
472
    def get_file_lines(self, file_id, path=None, filtered=True):
 
473
        """See Tree.get_file_lines()"""
 
474
        file = self.get_file(file_id, path, filtered=filtered)
 
475
        try:
 
476
            return file.readlines()
 
477
        finally:
 
478
            file.close()
 
479
 
 
480
    @needs_read_lock
 
481
    def annotate_iter(self, file_id, default_revision=CURRENT_REVISION):
 
482
        """See Tree.annotate_iter
 
483
 
 
484
        This implementation will use the basis tree implementation if possible.
 
485
        Lines not in the basis are attributed to CURRENT_REVISION
 
486
 
 
487
        If there are pending merges, lines added by those merges will be
 
488
        incorrectly attributed to CURRENT_REVISION (but after committing, the
 
489
        attribution will be correct).
 
490
        """
 
491
        maybe_file_parent_keys = []
 
492
        for parent_id in self.get_parent_ids():
 
493
            try:
 
494
                parent_tree = self.revision_tree(parent_id)
 
495
            except errors.NoSuchRevisionInTree:
 
496
                parent_tree = self.branch.repository.revision_tree(parent_id)
 
497
            parent_tree.lock_read()
 
498
            try:
 
499
                if file_id not in parent_tree:
 
500
                    continue
 
501
                ie = parent_tree.inventory[file_id]
 
502
                if ie.kind != 'file':
 
503
                    # Note: this is slightly unnecessary, because symlinks and
 
504
                    # directories have a "text" which is the empty text, and we
 
505
                    # know that won't mess up annotations. But it seems cleaner
 
506
                    continue
 
507
                parent_text_key = (file_id, ie.revision)
 
508
                if parent_text_key not in maybe_file_parent_keys:
 
509
                    maybe_file_parent_keys.append(parent_text_key)
 
510
            finally:
 
511
                parent_tree.unlock()
 
512
        graph = _mod_graph.Graph(self.branch.repository.texts)
 
513
        heads = graph.heads(maybe_file_parent_keys)
 
514
        file_parent_keys = []
 
515
        for key in maybe_file_parent_keys:
 
516
            if key in heads:
 
517
                file_parent_keys.append(key)
 
518
 
 
519
        # Now we have the parents of this content
 
520
        annotator = self.branch.repository.texts.get_annotator()
 
521
        text = self.get_file(file_id).read()
 
522
        this_key =(file_id, default_revision)
 
523
        annotator.add_special_text(this_key, file_parent_keys, text)
 
524
        annotations = [(key[-1], line)
 
525
                       for key, line in annotator.annotate_flat(this_key)]
 
526
        return annotations
 
527
 
 
528
    def _get_ancestors(self, default_revision):
 
529
        ancestors = set([default_revision])
 
530
        for parent_id in self.get_parent_ids():
 
531
            ancestors.update(self.branch.repository.get_ancestry(
 
532
                             parent_id, topo_sorted=False))
 
533
        return ancestors
501
534
 
502
535
    def get_parent_ids(self):
503
536
        """See Tree.get_parent_ids.
504
 
        
 
537
 
505
538
        This implementation reads the pending merges list and last_revision
506
539
        value and uses that to decide what the parents list should be.
507
540
        """
508
 
        last_rev = self._last_revision()
509
 
        if last_rev is None:
 
541
        last_rev = _mod_revision.ensure_null(self._last_revision())
 
542
        if _mod_revision.NULL_REVISION == last_rev:
510
543
            parents = []
511
544
        else:
512
545
            parents = [last_rev]
513
546
        try:
514
 
            merges_file = self._control_files.get_utf8('pending-merges')
515
 
        except NoSuchFile:
 
547
            merges_file = self._transport.get('pending-merges')
 
548
        except errors.NoSuchFile:
516
549
            pass
517
550
        else:
518
551
            for l in merges_file.readlines():
519
 
                parents.append(l.rstrip('\n'))
 
552
                revision_id = l.rstrip('\n')
 
553
                parents.append(revision_id)
520
554
        return parents
521
555
 
522
556
    @needs_read_lock
523
557
    def get_root_id(self):
524
558
        """Return the id of this trees root"""
525
559
        return self._inventory.root.file_id
526
 
        
 
560
 
527
561
    def _get_store_filename(self, file_id):
528
562
        ## XXX: badly named; this is not in the store at all
529
563
        return self.abspath(self.id2path(file_id))
530
564
 
531
565
    @needs_read_lock
532
 
    def clone(self, to_bzrdir, revision_id=None, basis=None):
 
566
    def clone(self, to_bzrdir, revision_id=None):
533
567
        """Duplicate this working tree into to_bzr, including all state.
534
 
        
 
568
 
535
569
        Specifically modified files are kept as modified, but
536
570
        ignored and unknown files are discarded.
537
571
 
538
572
        If you want to make a new line of development, see bzrdir.sprout()
539
573
 
540
574
        revision
541
 
            If not None, the cloned tree will have its last revision set to 
542
 
            revision, and and difference between the source trees last revision
 
575
            If not None, the cloned tree will have its last revision set to
 
576
            revision, and difference between the source trees last revision
543
577
            and this one merged in.
544
 
 
545
 
        basis
546
 
            If not None, a closer copy of a tree which may have some files in
547
 
            common, and which file content should be preferentially copied from.
548
578
        """
549
579
        # assumes the target bzr dir format is compatible.
550
 
        result = self._format.initialize(to_bzrdir)
 
580
        result = to_bzrdir.create_workingtree()
551
581
        self.copy_content_into(result, revision_id)
552
582
        return result
553
583
 
568
598
 
569
599
    def has_id(self, file_id):
570
600
        # files that have been deleted are excluded
571
 
        inv = self._inventory
 
601
        inv = self.inventory
572
602
        if not inv.has_id(file_id):
573
603
            return False
574
604
        path = inv.id2path(file_id)
582
612
    __contains__ = has_id
583
613
 
584
614
    def get_file_size(self, file_id):
585
 
        return os.path.getsize(self.id2abspath(file_id))
 
615
        """See Tree.get_file_size"""
 
616
        # XXX: this returns the on-disk size; it should probably return the
 
617
        # canonical size
 
618
        try:
 
619
            return os.path.getsize(self.id2abspath(file_id))
 
620
        except OSError, e:
 
621
            if e.errno != errno.ENOENT:
 
622
                raise
 
623
            else:
 
624
                return None
586
625
 
587
626
    @needs_read_lock
588
 
    def get_file_sha1(self, file_id, path=None):
 
627
    def get_file_sha1(self, file_id, path=None, stat_value=None):
589
628
        if not path:
590
629
            path = self._inventory.id2path(file_id)
591
 
        return self._hashcache.get_sha1(path)
 
630
        return self._hashcache.get_sha1(path, stat_value)
592
631
 
593
632
    def get_file_mtime(self, file_id, path=None):
594
633
        if not path:
595
 
            path = self._inventory.id2path(file_id)
 
634
            path = self.inventory.id2path(file_id)
596
635
        return os.lstat(self.abspath(path)).st_mtime
597
636
 
 
637
    def _is_executable_from_path_and_stat_from_basis(self, path, stat_result):
 
638
        file_id = self.path2id(path)
 
639
        return self._inventory[file_id].executable
 
640
 
 
641
    def _is_executable_from_path_and_stat_from_stat(self, path, stat_result):
 
642
        mode = stat_result.st_mode
 
643
        return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
 
644
 
598
645
    if not supports_executable():
599
646
        def is_executable(self, file_id, path=None):
600
647
            return self._inventory[file_id].executable
 
648
 
 
649
        _is_executable_from_path_and_stat = \
 
650
            _is_executable_from_path_and_stat_from_basis
601
651
    else:
602
652
        def is_executable(self, file_id, path=None):
603
653
            if not path:
604
 
                path = self._inventory.id2path(file_id)
 
654
                path = self.id2path(file_id)
605
655
            mode = os.lstat(self.abspath(path)).st_mode
606
656
            return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
607
657
 
608
 
    @needs_write_lock
 
658
        _is_executable_from_path_and_stat = \
 
659
            _is_executable_from_path_and_stat_from_stat
 
660
 
 
661
    @needs_tree_write_lock
609
662
    def _add(self, files, ids, kinds):
610
663
        """See MutableTree._add."""
611
664
        # TODO: Re-adding a file that is removed in the working copy
612
665
        # should probably put it back with the previous ID.
613
 
        # the read and write working inventory should not occur in this 
 
666
        # the read and write working inventory should not occur in this
614
667
        # function - they should be part of lock_write and unlock.
615
 
        inv = self.read_working_inventory()
 
668
        inv = self.inventory
616
669
        for f, file_id, kind in zip(files, ids, kinds):
617
 
            assert kind is not None
618
670
            if file_id is None:
619
671
                inv.add_path(f, kind=kind)
620
672
            else:
621
673
                inv.add_path(f, kind=kind, file_id=file_id)
622
 
        self._write_inventory(inv)
 
674
            self._inventory_is_modified = True
623
675
 
624
676
    @needs_tree_write_lock
625
677
    def _gather_kinds(self, files, kinds):
631
683
                    kinds[pos] = file_kind(fullpath)
632
684
                except OSError, e:
633
685
                    if e.errno == errno.ENOENT:
634
 
                        raise NoSuchFile(fullpath)
 
686
                        raise errors.NoSuchFile(fullpath)
635
687
 
636
688
    @needs_write_lock
637
689
    def add_parent_tree_id(self, revision_id, allow_leftmost_as_ghost=False):
646
698
        :param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
647
699
        """
648
700
        parents = self.get_parent_ids() + [revision_id]
649
 
        self.set_parent_ids(parents,
650
 
            allow_leftmost_as_ghost=len(parents) > 1 or allow_leftmost_as_ghost)
 
701
        self.set_parent_ids(parents, allow_leftmost_as_ghost=len(parents) > 1
 
702
            or allow_leftmost_as_ghost)
651
703
 
652
704
    @needs_tree_write_lock
653
705
    def add_parent_tree(self, parent_tuple, allow_leftmost_as_ghost=False):
685
737
        if updated:
686
738
            self.set_parent_ids(parents, allow_leftmost_as_ghost=True)
687
739
 
688
 
    @deprecated_method(zero_eleven)
689
 
    @needs_read_lock
690
 
    def pending_merges(self):
691
 
        """Return a list of pending merges.
692
 
 
693
 
        These are revisions that have been merged into the working
694
 
        directory but not yet committed.
695
 
 
696
 
        As of 0.11 this is deprecated. Please see WorkingTree.get_parent_ids()
697
 
        instead - which is available on all tree objects.
698
 
        """
699
 
        return self.get_parent_ids()[1:]
 
740
    def path_content_summary(self, path, _lstat=os.lstat,
 
741
        _mapper=osutils.file_kind_from_stat_mode):
 
742
        """See Tree.path_content_summary."""
 
743
        abspath = self.abspath(path)
 
744
        try:
 
745
            stat_result = _lstat(abspath)
 
746
        except OSError, e:
 
747
            if getattr(e, 'errno', None) == errno.ENOENT:
 
748
                # no file.
 
749
                return ('missing', None, None, None)
 
750
            # propagate other errors
 
751
            raise
 
752
        kind = _mapper(stat_result.st_mode)
 
753
        if kind == 'file':
 
754
            return self._file_content_summary(path, stat_result)
 
755
        elif kind == 'directory':
 
756
            # perhaps it looks like a plain directory, but it's really a
 
757
            # reference.
 
758
            if self._directory_is_tree_reference(path):
 
759
                kind = 'tree-reference'
 
760
            return kind, None, None, None
 
761
        elif kind == 'symlink':
 
762
            target = osutils.readlink(abspath)
 
763
            return ('symlink', None, None, target)
 
764
        else:
 
765
            return (kind, None, None, None)
 
766
 
 
767
    def _file_content_summary(self, path, stat_result):
 
768
        size = stat_result.st_size
 
769
        executable = self._is_executable_from_path_and_stat(path, stat_result)
 
770
        # try for a stat cache lookup
 
771
        return ('file', size, executable, self._sha_from_stat(
 
772
            path, stat_result))
700
773
 
701
774
    def _check_parents_for_ghosts(self, revision_ids, allow_leftmost_as_ghost):
702
775
        """Common ghost checking functionality from set_parent_*.
712
785
 
713
786
    def _set_merges_from_parent_ids(self, parent_ids):
714
787
        merges = parent_ids[1:]
715
 
        self._control_files.put_utf8('pending-merges', '\n'.join(merges))
 
788
        self._transport.put_bytes('pending-merges', '\n'.join(merges),
 
789
            mode=self.bzrdir._get_file_mode())
 
790
 
 
791
    def _filter_parent_ids_by_ancestry(self, revision_ids):
 
792
        """Check that all merged revisions are proper 'heads'.
 
793
 
 
794
        This will always return the first revision_id, and any merged revisions
 
795
        which are
 
796
        """
 
797
        if len(revision_ids) == 0:
 
798
            return revision_ids
 
799
        graph = self.branch.repository.get_graph()
 
800
        heads = graph.heads(revision_ids)
 
801
        new_revision_ids = revision_ids[:1]
 
802
        for revision_id in revision_ids[1:]:
 
803
            if revision_id in heads and revision_id not in new_revision_ids:
 
804
                new_revision_ids.append(revision_id)
 
805
        if new_revision_ids != revision_ids:
 
806
            trace.mutter('requested to set revision_ids = %s,'
 
807
                         ' but filtered to %s', revision_ids, new_revision_ids)
 
808
        return new_revision_ids
716
809
 
717
810
    @needs_tree_write_lock
718
811
    def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
719
812
        """Set the parent ids to revision_ids.
720
 
        
 
813
 
721
814
        See also set_parent_trees. This api will try to retrieve the tree data
722
815
        for each element of revision_ids from the trees repository. If you have
723
816
        tree data already available, it is more efficient to use
729
822
        """
730
823
        self._check_parents_for_ghosts(revision_ids,
731
824
            allow_leftmost_as_ghost=allow_leftmost_as_ghost)
 
825
        for revision_id in revision_ids:
 
826
            _mod_revision.check_not_reserved_id(revision_id)
 
827
 
 
828
        revision_ids = self._filter_parent_ids_by_ancestry(revision_ids)
732
829
 
733
830
        if len(revision_ids) > 0:
734
831
            self.set_last_revision(revision_ids[0])
735
832
        else:
736
 
            self.set_last_revision(None)
 
833
            self.set_last_revision(_mod_revision.NULL_REVISION)
737
834
 
738
835
        self._set_merges_from_parent_ids(revision_ids)
739
836
 
741
838
    def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
742
839
        """See MutableTree.set_parent_trees."""
743
840
        parent_ids = [rev for (rev, tree) in parents_list]
 
841
        for revision_id in parent_ids:
 
842
            _mod_revision.check_not_reserved_id(revision_id)
744
843
 
745
844
        self._check_parents_for_ghosts(parent_ids,
746
845
            allow_leftmost_as_ghost=allow_leftmost_as_ghost)
747
846
 
 
847
        parent_ids = self._filter_parent_ids_by_ancestry(parent_ids)
 
848
 
748
849
        if len(parent_ids) == 0:
749
 
            leftmost_parent_id = None
 
850
            leftmost_parent_id = _mod_revision.NULL_REVISION
750
851
            leftmost_parent_tree = None
751
852
        else:
752
853
            leftmost_parent_id, leftmost_parent_tree = parents_list[0]
774
875
    def set_merge_modified(self, modified_hashes):
775
876
        def iter_stanzas():
776
877
            for file_id, hash in modified_hashes.iteritems():
777
 
                yield Stanza(file_id=file_id, hash=hash)
 
878
                yield Stanza(file_id=file_id.decode('utf8'), hash=hash)
778
879
        self._put_rio('merge-hashes', iter_stanzas(), MERGE_MODIFIED_HEADER_1)
779
880
 
780
 
    @needs_tree_write_lock
 
881
    def _sha_from_stat(self, path, stat_result):
 
882
        """Get a sha digest from the tree's stat cache.
 
883
 
 
884
        The default implementation assumes no stat cache is present.
 
885
 
 
886
        :param path: The path.
 
887
        :param stat_result: The stat result being looked up.
 
888
        """
 
889
        return None
 
890
 
781
891
    def _put_rio(self, filename, stanzas, header):
 
892
        self._must_be_locked()
782
893
        my_file = rio_file(stanzas, header)
783
 
        self._control_files.put(filename, my_file)
 
894
        self._transport.put_file(filename, my_file,
 
895
            mode=self.bzrdir._get_file_mode())
784
896
 
785
897
    @needs_write_lock # because merge pulls data into the branch.
786
 
    def merge_from_branch(self, branch, to_revision=None):
 
898
    def merge_from_branch(self, branch, to_revision=None, from_revision=None,
 
899
        merge_type=None):
787
900
        """Merge from a branch into this working tree.
788
901
 
789
902
        :param branch: The branch to merge from.
790
 
        :param to_revision: If non-None, the merge will merge to to_revision, but 
791
 
            not beyond it. to_revision does not need to be in the history of
792
 
            the branch when it is supplied. If None, to_revision defaults to
 
903
        :param to_revision: If non-None, the merge will merge to to_revision,
 
904
            but not beyond it. to_revision does not need to be in the history
 
905
            of the branch when it is supplied. If None, to_revision defaults to
793
906
            branch.last_revision().
794
907
        """
795
908
        from bzrlib.merge import Merger, Merge3Merger
796
 
        pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
909
        pb = ui.ui_factory.nested_progress_bar()
797
910
        try:
798
911
            merger = Merger(self.branch, this_tree=self, pb=pb)
799
912
            merger.pp = ProgressPhase("Merge phase", 5, pb)
802
915
            # local alterations
803
916
            merger.check_basis(check_clean=True, require_commits=False)
804
917
            if to_revision is None:
805
 
                to_revision = branch.last_revision()
 
918
                to_revision = _mod_revision.ensure_null(branch.last_revision())
806
919
            merger.other_rev_id = to_revision
807
 
            if merger.other_rev_id is None:
808
 
                raise error.NoCommits(branch)
 
920
            if _mod_revision.is_null(merger.other_rev_id):
 
921
                raise errors.NoCommits(branch)
809
922
            self.branch.fetch(branch, last_revision=merger.other_rev_id)
810
923
            merger.other_basis = merger.other_rev_id
811
924
            merger.other_tree = self.branch.repository.revision_tree(
812
925
                merger.other_rev_id)
 
926
            merger.other_branch = branch
813
927
            merger.pp.next_phase()
814
 
            merger.find_base()
 
928
            if from_revision is None:
 
929
                merger.find_base()
 
930
            else:
 
931
                merger.set_base_revision(from_revision, branch)
815
932
            if merger.base_rev_id == merger.other_rev_id:
816
933
                raise errors.PointlessMerge
817
934
            merger.backup_files = False
818
 
            merger.merge_type = Merge3Merger
 
935
            if merge_type is None:
 
936
                merger.merge_type = Merge3Merger
 
937
            else:
 
938
                merger.merge_type = merge_type
819
939
            merger.set_interesting_files(None)
820
940
            merger.show_base = False
821
941
            merger.reprocess = False
827
947
 
828
948
    @needs_read_lock
829
949
    def merge_modified(self):
 
950
        """Return a dictionary of files modified by a merge.
 
951
 
 
952
        The list is initialized by WorkingTree.set_merge_modified, which is
 
953
        typically called after we make some automatic updates to the tree
 
954
        because of a merge.
 
955
 
 
956
        This returns a map of file_id->sha1, containing only files which are
 
957
        still in the working inventory and have that text hash.
 
958
        """
830
959
        try:
831
 
            hashfile = self._control_files.get('merge-hashes')
832
 
        except NoSuchFile:
 
960
            hashfile = self._transport.get('merge-hashes')
 
961
        except errors.NoSuchFile:
833
962
            return {}
834
 
        merge_hashes = {}
835
963
        try:
836
 
            if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
837
 
                raise MergeModifiedFormatError()
838
 
        except StopIteration:
839
 
            raise MergeModifiedFormatError()
840
 
        for s in RioReader(hashfile):
841
 
            file_id = s.get("file_id")
842
 
            if file_id not in self.inventory:
843
 
                continue
844
 
            hash = s.get("hash")
845
 
            if hash == self.get_file_sha1(file_id):
846
 
                merge_hashes[file_id] = hash
847
 
        return merge_hashes
 
964
            merge_hashes = {}
 
965
            try:
 
966
                if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
 
967
                    raise errors.MergeModifiedFormatError()
 
968
            except StopIteration:
 
969
                raise errors.MergeModifiedFormatError()
 
970
            for s in RioReader(hashfile):
 
971
                # RioReader reads in Unicode, so convert file_ids back to utf8
 
972
                file_id = osutils.safe_file_id(s.get("file_id"), warn=False)
 
973
                if file_id not in self.inventory:
 
974
                    continue
 
975
                text_hash = s.get("hash")
 
976
                if text_hash == self.get_file_sha1(file_id):
 
977
                    merge_hashes[file_id] = text_hash
 
978
            return merge_hashes
 
979
        finally:
 
980
            hashfile.close()
848
981
 
849
982
    @needs_write_lock
850
983
    def mkdir(self, path, file_id=None):
851
984
        """See MutableTree.mkdir()."""
852
985
        if file_id is None:
853
 
            file_id = gen_file_id(os.path.basename(path))
 
986
            file_id = generate_ids.gen_file_id(os.path.basename(path))
854
987
        os.mkdir(self.abspath(path))
855
988
        self.add(path, file_id, 'directory')
856
989
        return file_id
857
990
 
858
991
    def get_symlink_target(self, file_id):
859
 
        return os.readlink(self.id2abspath(file_id))
860
 
 
861
 
    def file_class(self, filename):
862
 
        if self.path2id(filename):
863
 
            return 'V'
864
 
        elif self.is_ignored(filename):
865
 
            return 'I'
866
 
        else:
867
 
            return '?'
 
992
        abspath = self.id2abspath(file_id)
 
993
        target = osutils.readlink(abspath)
 
994
        return target
 
995
 
 
996
    @needs_write_lock
 
997
    def subsume(self, other_tree):
 
998
        def add_children(inventory, entry):
 
999
            for child_entry in entry.children.values():
 
1000
                inventory._byid[child_entry.file_id] = child_entry
 
1001
                if child_entry.kind == 'directory':
 
1002
                    add_children(inventory, child_entry)
 
1003
        if other_tree.get_root_id() == self.get_root_id():
 
1004
            raise errors.BadSubsumeSource(self, other_tree,
 
1005
                                          'Trees have the same root')
 
1006
        try:
 
1007
            other_tree_path = self.relpath(other_tree.basedir)
 
1008
        except errors.PathNotChild:
 
1009
            raise errors.BadSubsumeSource(self, other_tree,
 
1010
                'Tree is not contained by the other')
 
1011
        new_root_parent = self.path2id(osutils.dirname(other_tree_path))
 
1012
        if new_root_parent is None:
 
1013
            raise errors.BadSubsumeSource(self, other_tree,
 
1014
                'Parent directory is not versioned.')
 
1015
        # We need to ensure that the result of a fetch will have a
 
1016
        # versionedfile for the other_tree root, and only fetching into
 
1017
        # RepositoryKnit2 guarantees that.
 
1018
        if not self.branch.repository.supports_rich_root():
 
1019
            raise errors.SubsumeTargetNeedsUpgrade(other_tree)
 
1020
        other_tree.lock_tree_write()
 
1021
        try:
 
1022
            new_parents = other_tree.get_parent_ids()
 
1023
            other_root = other_tree.inventory.root
 
1024
            other_root.parent_id = new_root_parent
 
1025
            other_root.name = osutils.basename(other_tree_path)
 
1026
            self.inventory.add(other_root)
 
1027
            add_children(self.inventory, other_root)
 
1028
            self._write_inventory(self.inventory)
 
1029
            # normally we don't want to fetch whole repositories, but i think
 
1030
            # here we really do want to consolidate the whole thing.
 
1031
            for parent_id in other_tree.get_parent_ids():
 
1032
                self.branch.fetch(other_tree.branch, parent_id)
 
1033
                self.add_parent_tree_id(parent_id)
 
1034
        finally:
 
1035
            other_tree.unlock()
 
1036
        other_tree.bzrdir.retire_bzrdir()
 
1037
 
 
1038
    def _setup_directory_is_tree_reference(self):
 
1039
        if self._branch.repository._format.supports_tree_reference:
 
1040
            self._directory_is_tree_reference = \
 
1041
                self._directory_may_be_tree_reference
 
1042
        else:
 
1043
            self._directory_is_tree_reference = \
 
1044
                self._directory_is_never_tree_reference
 
1045
 
 
1046
    def _directory_is_never_tree_reference(self, relpath):
 
1047
        return False
 
1048
 
 
1049
    def _directory_may_be_tree_reference(self, relpath):
 
1050
        # as a special case, if a directory contains control files then
 
1051
        # it's a tree reference, except that the root of the tree is not
 
1052
        return relpath and osutils.isdir(self.abspath(relpath) + u"/.bzr")
 
1053
        # TODO: We could ask all the control formats whether they
 
1054
        # recognize this directory, but at the moment there's no cheap api
 
1055
        # to do that.  Since we probably can only nest bzr checkouts and
 
1056
        # they always use this name it's ok for now.  -- mbp 20060306
 
1057
        #
 
1058
        # FIXME: There is an unhandled case here of a subdirectory
 
1059
        # containing .bzr but not a branch; that will probably blow up
 
1060
        # when you try to commit it.  It might happen if there is a
 
1061
        # checkout in a subdirectory.  This can be avoided by not adding
 
1062
        # it.  mbp 20070306
 
1063
 
 
1064
    @needs_tree_write_lock
 
1065
    def extract(self, file_id, format=None):
 
1066
        """Extract a subtree from this tree.
 
1067
 
 
1068
        A new branch will be created, relative to the path for this tree.
 
1069
        """
 
1070
        self.flush()
 
1071
        def mkdirs(path):
 
1072
            segments = osutils.splitpath(path)
 
1073
            transport = self.branch.bzrdir.root_transport
 
1074
            for name in segments:
 
1075
                transport = transport.clone(name)
 
1076
                transport.ensure_base()
 
1077
            return transport
 
1078
 
 
1079
        sub_path = self.id2path(file_id)
 
1080
        branch_transport = mkdirs(sub_path)
 
1081
        if format is None:
 
1082
            format = self.bzrdir.cloning_metadir()
 
1083
        branch_transport.ensure_base()
 
1084
        branch_bzrdir = format.initialize_on_transport(branch_transport)
 
1085
        try:
 
1086
            repo = branch_bzrdir.find_repository()
 
1087
        except errors.NoRepositoryPresent:
 
1088
            repo = branch_bzrdir.create_repository()
 
1089
        if not repo.supports_rich_root():
 
1090
            raise errors.RootNotRich()
 
1091
        new_branch = branch_bzrdir.create_branch()
 
1092
        new_branch.pull(self.branch)
 
1093
        for parent_id in self.get_parent_ids():
 
1094
            new_branch.fetch(self.branch, parent_id)
 
1095
        tree_transport = self.bzrdir.root_transport.clone(sub_path)
 
1096
        if tree_transport.base != branch_transport.base:
 
1097
            tree_bzrdir = format.initialize_on_transport(tree_transport)
 
1098
            branch.BranchReferenceFormat().initialize(tree_bzrdir, new_branch)
 
1099
        else:
 
1100
            tree_bzrdir = branch_bzrdir
 
1101
        wt = tree_bzrdir.create_workingtree(_mod_revision.NULL_REVISION)
 
1102
        wt.set_parent_ids(self.get_parent_ids())
 
1103
        my_inv = self.inventory
 
1104
        child_inv = inventory.Inventory(root_id=None)
 
1105
        new_root = my_inv[file_id]
 
1106
        my_inv.remove_recursive_id(file_id)
 
1107
        new_root.parent_id = None
 
1108
        child_inv.add(new_root)
 
1109
        self._write_inventory(my_inv)
 
1110
        wt._write_inventory(child_inv)
 
1111
        return wt
 
1112
 
 
1113
    def _serialize(self, inventory, out_file):
 
1114
        xml5.serializer_v5.write_inventory(self._inventory, out_file,
 
1115
            working=True)
 
1116
 
 
1117
    def _deserialize(selt, in_file):
 
1118
        return xml5.serializer_v5.read_inventory(in_file)
868
1119
 
869
1120
    def flush(self):
870
1121
        """Write the in memory inventory to disk."""
872
1123
        if self._control_files._lock_mode != 'w':
873
1124
            raise errors.NotWriteLocked(self)
874
1125
        sio = StringIO()
875
 
        xml5.serializer_v5.write_inventory(self._inventory, sio)
 
1126
        self._serialize(self._inventory, sio)
876
1127
        sio.seek(0)
877
 
        self._control_files.put('inventory', sio)
 
1128
        self._transport.put_file('inventory', sio,
 
1129
            mode=self.bzrdir._get_file_mode())
878
1130
        self._inventory_is_modified = False
879
1131
 
880
 
    def list_files(self, include_root=False):
881
 
        """Recursively list all files as (path, class, kind, id, entry).
 
1132
    def _kind(self, relpath):
 
1133
        return osutils.file_kind(self.abspath(relpath))
 
1134
 
 
1135
    def list_files(self, include_root=False, from_dir=None, recursive=True):
 
1136
        """List all files as (path, class, kind, id, entry).
882
1137
 
883
1138
        Lists, but does not descend into unversioned directories.
884
 
 
885
1139
        This does not include files that have been deleted in this
886
 
        tree.
 
1140
        tree. Skips the control directory.
887
1141
 
888
 
        Skips the control directory.
 
1142
        :param include_root: if True, do not return an entry for the root
 
1143
        :param from_dir: start from this directory or None for the root
 
1144
        :param recursive: whether to recurse into subdirectories or not
889
1145
        """
890
 
        inv = self._inventory
891
 
        if include_root is True:
 
1146
        # list_files is an iterator, so @needs_read_lock doesn't work properly
 
1147
        # with it. So callers should be careful to always read_lock the tree.
 
1148
        if not self.is_locked():
 
1149
            raise errors.ObjectNotLocked(self)
 
1150
 
 
1151
        inv = self.inventory
 
1152
        if from_dir is None and include_root is True:
892
1153
            yield ('', 'V', 'directory', inv.root.file_id, inv.root)
893
1154
        # Convert these into local objects to save lookup times
894
1155
        pathjoin = osutils.pathjoin
895
 
        file_kind = osutils.file_kind
 
1156
        file_kind = self._kind
896
1157
 
897
1158
        # transport.base ends in a slash, we want the piece
898
1159
        # between the last two slashes
901
1162
        fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
902
1163
 
903
1164
        # directory file_id, relative path, absolute path, reverse sorted children
904
 
        children = os.listdir(self.basedir)
 
1165
        if from_dir is not None:
 
1166
            from_dir_id = inv.path2id(from_dir)
 
1167
            if from_dir_id is None:
 
1168
                # Directory not versioned
 
1169
                return
 
1170
            from_dir_abspath = pathjoin(self.basedir, from_dir)
 
1171
        else:
 
1172
            from_dir_id = inv.root.file_id
 
1173
            from_dir_abspath = self.basedir
 
1174
        children = os.listdir(from_dir_abspath)
905
1175
        children.sort()
906
 
        # jam 20060527 The kernel sized tree seems equivalent whether we 
 
1176
        # jam 20060527 The kernel sized tree seems equivalent whether we
907
1177
        # use a deque and popleft to keep them sorted, or if we use a plain
908
1178
        # list and just reverse() them.
909
1179
        children = collections.deque(children)
910
 
        stack = [(inv.root.file_id, u'', self.basedir, children)]
 
1180
        stack = [(from_dir_id, u'', from_dir_abspath, children)]
911
1181
        while stack:
912
1182
            from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
913
1183
 
929
1199
 
930
1200
                # absolute path
931
1201
                fap = from_dir_abspath + '/' + f
932
 
                
 
1202
 
933
1203
                f_ie = inv.get_child(from_dir_id, f)
934
1204
                if f_ie:
935
1205
                    c = 'V'
958
1228
 
959
1229
                fk = file_kind(fap)
960
1230
 
961
 
                if f_ie:
962
 
                    if f_ie.kind != fk:
963
 
                        raise BzrCheckError("file %r entered as kind %r id %r, "
964
 
                                            "now of kind %r"
965
 
                                            % (fap, f_ie.kind, f_ie.file_id, fk))
966
 
 
967
1231
                # make a last minute entry
968
1232
                if f_ie:
969
1233
                    yield fp[1:], c, fk, f_ie.file_id, f_ie
973
1237
                    except KeyError:
974
1238
                        yield fp[1:], c, fk, None, TreeEntry()
975
1239
                    continue
976
 
                
 
1240
 
977
1241
                if fk != 'directory':
978
1242
                    continue
979
1243
 
980
 
                # But do this child first
981
 
                new_children = os.listdir(fap)
982
 
                new_children.sort()
983
 
                new_children = collections.deque(new_children)
984
 
                stack.append((f_ie.file_id, fp, fap, new_children))
985
 
                # Break out of inner loop, so that we start outer loop with child
986
 
                break
 
1244
                # But do this child first if recursing down
 
1245
                if recursive:
 
1246
                    new_children = os.listdir(fap)
 
1247
                    new_children.sort()
 
1248
                    new_children = collections.deque(new_children)
 
1249
                    stack.append((f_ie.file_id, fp, fap, new_children))
 
1250
                    # Break out of inner loop,
 
1251
                    # so that we start outer loop with child
 
1252
                    break
987
1253
            else:
988
1254
                # if we finished all children, pop it off the stack
989
1255
                stack.pop()
990
1256
 
991
1257
    @needs_tree_write_lock
992
 
    def move(self, from_paths, to_name):
 
1258
    def move(self, from_paths, to_dir=None, after=False, **kwargs):
993
1259
        """Rename files.
994
1260
 
995
 
        to_name must exist in the inventory.
996
 
 
997
 
        If to_name exists and is a directory, the files are moved into
998
 
        it, keeping their old names.  
999
 
 
1000
 
        Note that to_name is only the last component of the new name;
 
1261
        to_dir must exist in the inventory.
 
1262
 
 
1263
        If to_dir exists and is a directory, the files are moved into
 
1264
        it, keeping their old names.
 
1265
 
 
1266
        Note that to_dir is only the last component of the new name;
1001
1267
        this doesn't change the directory.
1002
1268
 
 
1269
        For each entry in from_paths the move mode will be determined
 
1270
        independently.
 
1271
 
 
1272
        The first mode moves the file in the filesystem and updates the
 
1273
        inventory. The second mode only updates the inventory without
 
1274
        touching the file on the filesystem. This is the new mode introduced
 
1275
        in version 0.15.
 
1276
 
 
1277
        move uses the second mode if 'after == True' and the target is not
 
1278
        versioned but present in the working tree.
 
1279
 
 
1280
        move uses the second mode if 'after == False' and the source is
 
1281
        versioned but no longer in the working tree, and the target is not
 
1282
        versioned but present in the working tree.
 
1283
 
 
1284
        move uses the first mode if 'after == False' and the source is
 
1285
        versioned and present in the working tree, and the target is not
 
1286
        versioned and not present in the working tree.
 
1287
 
 
1288
        Everything else results in an error.
 
1289
 
1003
1290
        This returns a list of (from_path, to_path) pairs for each
1004
1291
        entry that is moved.
1005
1292
        """
1006
 
        result = []
1007
 
        ## TODO: Option to move IDs only
1008
 
        assert not isinstance(from_paths, basestring)
 
1293
        rename_entries = []
 
1294
        rename_tuples = []
 
1295
 
 
1296
        # check for deprecated use of signature
 
1297
        if to_dir is None:
 
1298
            to_dir = kwargs.get('to_name', None)
 
1299
            if to_dir is None:
 
1300
                raise TypeError('You must supply a target directory')
 
1301
            else:
 
1302
                symbol_versioning.warn('The parameter to_name was deprecated'
 
1303
                                       ' in version 0.13. Use to_dir instead',
 
1304
                                       DeprecationWarning)
 
1305
 
 
1306
        # check destination directory
 
1307
        if isinstance(from_paths, basestring):
 
1308
            raise ValueError()
1009
1309
        inv = self.inventory
1010
 
        to_abs = self.abspath(to_name)
 
1310
        to_abs = self.abspath(to_dir)
1011
1311
        if not isdir(to_abs):
1012
 
            raise BzrError("destination %r is not a directory" % to_abs)
1013
 
        if not self.has_filename(to_name):
1014
 
            raise BzrError("destination %r not in working directory" % to_abs)
1015
 
        to_dir_id = inv.path2id(to_name)
1016
 
        if to_dir_id is None and to_name != '':
1017
 
            raise BzrError("destination %r is not a versioned directory" % to_name)
 
1312
            raise errors.BzrMoveFailedError('',to_dir,
 
1313
                errors.NotADirectory(to_abs))
 
1314
        if not self.has_filename(to_dir):
 
1315
            raise errors.BzrMoveFailedError('',to_dir,
 
1316
                errors.NotInWorkingDirectory(to_dir))
 
1317
        to_dir_id = inv.path2id(to_dir)
 
1318
        if to_dir_id is None:
 
1319
            raise errors.BzrMoveFailedError('',to_dir,
 
1320
                errors.NotVersionedError(path=str(to_dir)))
 
1321
 
1018
1322
        to_dir_ie = inv[to_dir_id]
1019
1323
        if to_dir_ie.kind != 'directory':
1020
 
            raise BzrError("destination %r is not a directory" % to_abs)
1021
 
 
1022
 
        to_idpath = inv.get_idpath(to_dir_id)
1023
 
 
1024
 
        for f in from_paths:
1025
 
            if not self.has_filename(f):
1026
 
                raise BzrError("%r does not exist in working tree" % f)
1027
 
            f_id = inv.path2id(f)
1028
 
            if f_id is None:
1029
 
                raise BzrError("%r is not versioned" % f)
1030
 
            name_tail = splitpath(f)[-1]
1031
 
            dest_path = pathjoin(to_name, name_tail)
1032
 
            if self.has_filename(dest_path):
1033
 
                raise BzrError("destination %r already exists" % dest_path)
1034
 
            if f_id in to_idpath:
1035
 
                raise BzrError("can't move %r to a subdirectory of itself" % f)
1036
 
 
1037
 
        # OK, so there's a race here, it's possible that someone will
1038
 
        # create a file in this interval and then the rename might be
1039
 
        # left half-done.  But we should have caught most problems.
1040
 
        orig_inv = deepcopy(self.inventory)
 
1324
            raise errors.BzrMoveFailedError('',to_dir,
 
1325
                errors.NotADirectory(to_abs))
 
1326
 
 
1327
        # create rename entries and tuples
 
1328
        for from_rel in from_paths:
 
1329
            from_tail = splitpath(from_rel)[-1]
 
1330
            from_id = inv.path2id(from_rel)
 
1331
            if from_id is None:
 
1332
                raise errors.BzrMoveFailedError(from_rel,to_dir,
 
1333
                    errors.NotVersionedError(path=str(from_rel)))
 
1334
 
 
1335
            from_entry = inv[from_id]
 
1336
            from_parent_id = from_entry.parent_id
 
1337
            to_rel = pathjoin(to_dir, from_tail)
 
1338
            rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
 
1339
                                         from_id=from_id,
 
1340
                                         from_tail=from_tail,
 
1341
                                         from_parent_id=from_parent_id,
 
1342
                                         to_rel=to_rel, to_tail=from_tail,
 
1343
                                         to_parent_id=to_dir_id)
 
1344
            rename_entries.append(rename_entry)
 
1345
            rename_tuples.append((from_rel, to_rel))
 
1346
 
 
1347
        # determine which move mode to use. checks also for movability
 
1348
        rename_entries = self._determine_mv_mode(rename_entries, after)
 
1349
 
1041
1350
        original_modified = self._inventory_is_modified
1042
1351
        try:
1043
1352
            if len(from_paths):
1044
1353
                self._inventory_is_modified = True
1045
 
            for f in from_paths:
1046
 
                name_tail = splitpath(f)[-1]
1047
 
                dest_path = pathjoin(to_name, name_tail)
1048
 
                result.append((f, dest_path))
1049
 
                inv.rename(inv.path2id(f), to_dir_id, name_tail)
1050
 
                try:
1051
 
                    osutils.rename(self.abspath(f), self.abspath(dest_path))
1052
 
                except OSError, e:
1053
 
                    raise BzrError("failed to rename %r to %r: %s" %
1054
 
                                   (f, dest_path, e[1]))
 
1354
            self._move(rename_entries)
1055
1355
        except:
1056
1356
            # restore the inventory on error
1057
 
            self._set_inventory(orig_inv, dirty=original_modified)
 
1357
            self._inventory_is_modified = original_modified
1058
1358
            raise
1059
1359
        self._write_inventory(inv)
1060
 
        return result
 
1360
        return rename_tuples
 
1361
 
 
1362
    def _determine_mv_mode(self, rename_entries, after=False):
 
1363
        """Determines for each from-to pair if both inventory and working tree
 
1364
        or only the inventory has to be changed.
 
1365
 
 
1366
        Also does basic plausability tests.
 
1367
        """
 
1368
        inv = self.inventory
 
1369
 
 
1370
        for rename_entry in rename_entries:
 
1371
            # store to local variables for easier reference
 
1372
            from_rel = rename_entry.from_rel
 
1373
            from_id = rename_entry.from_id
 
1374
            to_rel = rename_entry.to_rel
 
1375
            to_id = inv.path2id(to_rel)
 
1376
            only_change_inv = False
 
1377
 
 
1378
            # check the inventory for source and destination
 
1379
            if from_id is None:
 
1380
                raise errors.BzrMoveFailedError(from_rel,to_rel,
 
1381
                    errors.NotVersionedError(path=str(from_rel)))
 
1382
            if to_id is not None:
 
1383
                raise errors.BzrMoveFailedError(from_rel,to_rel,
 
1384
                    errors.AlreadyVersionedError(path=str(to_rel)))
 
1385
 
 
1386
            # try to determine the mode for rename (only change inv or change
 
1387
            # inv and file system)
 
1388
            if after:
 
1389
                if not self.has_filename(to_rel):
 
1390
                    raise errors.BzrMoveFailedError(from_id,to_rel,
 
1391
                        errors.NoSuchFile(path=str(to_rel),
 
1392
                        extra="New file has not been created yet"))
 
1393
                only_change_inv = True
 
1394
            elif not self.has_filename(from_rel) and self.has_filename(to_rel):
 
1395
                only_change_inv = True
 
1396
            elif self.has_filename(from_rel) and not self.has_filename(to_rel):
 
1397
                only_change_inv = False
 
1398
            elif (not self.case_sensitive
 
1399
                  and from_rel.lower() == to_rel.lower()
 
1400
                  and self.has_filename(from_rel)):
 
1401
                only_change_inv = False
 
1402
            else:
 
1403
                # something is wrong, so lets determine what exactly
 
1404
                if not self.has_filename(from_rel) and \
 
1405
                   not self.has_filename(to_rel):
 
1406
                    raise errors.BzrRenameFailedError(from_rel,to_rel,
 
1407
                        errors.PathsDoNotExist(paths=(str(from_rel),
 
1408
                        str(to_rel))))
 
1409
                else:
 
1410
                    raise errors.RenameFailedFilesExist(from_rel, to_rel)
 
1411
            rename_entry.only_change_inv = only_change_inv
 
1412
        return rename_entries
 
1413
 
 
1414
    def _move(self, rename_entries):
 
1415
        """Moves a list of files.
 
1416
 
 
1417
        Depending on the value of the flag 'only_change_inv', the
 
1418
        file will be moved on the file system or not.
 
1419
        """
 
1420
        inv = self.inventory
 
1421
        moved = []
 
1422
 
 
1423
        for entry in rename_entries:
 
1424
            try:
 
1425
                self._move_entry(entry)
 
1426
            except:
 
1427
                self._rollback_move(moved)
 
1428
                raise
 
1429
            moved.append(entry)
 
1430
 
 
1431
    def _rollback_move(self, moved):
 
1432
        """Try to rollback a previous move in case of an filesystem error."""
 
1433
        inv = self.inventory
 
1434
        for entry in moved:
 
1435
            try:
 
1436
                self._move_entry(WorkingTree._RenameEntry(
 
1437
                    entry.to_rel, entry.from_id,
 
1438
                    entry.to_tail, entry.to_parent_id, entry.from_rel,
 
1439
                    entry.from_tail, entry.from_parent_id,
 
1440
                    entry.only_change_inv))
 
1441
            except errors.BzrMoveFailedError, e:
 
1442
                raise errors.BzrMoveFailedError( '', '', "Rollback failed."
 
1443
                        " The working tree is in an inconsistent state."
 
1444
                        " Please consider doing a 'bzr revert'."
 
1445
                        " Error message is: %s" % e)
 
1446
 
 
1447
    def _move_entry(self, entry):
 
1448
        inv = self.inventory
 
1449
        from_rel_abs = self.abspath(entry.from_rel)
 
1450
        to_rel_abs = self.abspath(entry.to_rel)
 
1451
        if from_rel_abs == to_rel_abs:
 
1452
            raise errors.BzrMoveFailedError(entry.from_rel, entry.to_rel,
 
1453
                "Source and target are identical.")
 
1454
 
 
1455
        if not entry.only_change_inv:
 
1456
            try:
 
1457
                osutils.rename(from_rel_abs, to_rel_abs)
 
1458
            except OSError, e:
 
1459
                raise errors.BzrMoveFailedError(entry.from_rel,
 
1460
                    entry.to_rel, e[1])
 
1461
        inv.rename(entry.from_id, entry.to_parent_id, entry.to_tail)
1061
1462
 
1062
1463
    @needs_tree_write_lock
1063
 
    def rename_one(self, from_rel, to_rel):
 
1464
    def rename_one(self, from_rel, to_rel, after=False):
1064
1465
        """Rename one file.
1065
1466
 
1066
1467
        This can change the directory or the filename or both.
 
1468
 
 
1469
        rename_one has several 'modes' to work. First, it can rename a physical
 
1470
        file and change the file_id. That is the normal mode. Second, it can
 
1471
        only change the file_id without touching any physical file. This is
 
1472
        the new mode introduced in version 0.15.
 
1473
 
 
1474
        rename_one uses the second mode if 'after == True' and 'to_rel' is not
 
1475
        versioned but present in the working tree.
 
1476
 
 
1477
        rename_one uses the second mode if 'after == False' and 'from_rel' is
 
1478
        versioned but no longer in the working tree, and 'to_rel' is not
 
1479
        versioned but present in the working tree.
 
1480
 
 
1481
        rename_one uses the first mode if 'after == False' and 'from_rel' is
 
1482
        versioned and present in the working tree, and 'to_rel' is not
 
1483
        versioned and not present in the working tree.
 
1484
 
 
1485
        Everything else results in an error.
1067
1486
        """
1068
1487
        inv = self.inventory
1069
 
        if not self.has_filename(from_rel):
1070
 
            raise BzrError("can't rename: old working file %r does not exist" % from_rel)
1071
 
        if self.has_filename(to_rel):
1072
 
            raise BzrError("can't rename: new working file %r already exists" % to_rel)
1073
 
 
1074
 
        file_id = inv.path2id(from_rel)
1075
 
        if file_id is None:
1076
 
            raise BzrError("can't rename: old name %r is not versioned" % from_rel)
1077
 
 
1078
 
        entry = inv[file_id]
1079
 
        from_parent = entry.parent_id
1080
 
        from_name = entry.name
1081
 
        
1082
 
        if inv.path2id(to_rel):
1083
 
            raise BzrError("can't rename: new name %r is already versioned" % to_rel)
1084
 
 
 
1488
        rename_entries = []
 
1489
 
 
1490
        # create rename entries and tuples
 
1491
        from_tail = splitpath(from_rel)[-1]
 
1492
        from_id = inv.path2id(from_rel)
 
1493
        if from_id is None:
 
1494
            # if file is missing in the inventory maybe it's in the basis_tree
 
1495
            basis_tree = self.branch.basis_tree()
 
1496
            from_id = basis_tree.path2id(from_rel)
 
1497
            if from_id is None:
 
1498
                raise errors.BzrRenameFailedError(from_rel,to_rel,
 
1499
                    errors.NotVersionedError(path=str(from_rel)))
 
1500
            # put entry back in the inventory so we can rename it
 
1501
            from_entry = basis_tree.inventory[from_id].copy()
 
1502
            inv.add(from_entry)
 
1503
        else:
 
1504
            from_entry = inv[from_id]
 
1505
        from_parent_id = from_entry.parent_id
1085
1506
        to_dir, to_tail = os.path.split(to_rel)
1086
1507
        to_dir_id = inv.path2id(to_dir)
1087
 
        if to_dir_id is None and to_dir != '':
1088
 
            raise BzrError("can't determine destination directory id for %r" % to_dir)
1089
 
 
1090
 
        mutter("rename_one:")
1091
 
        mutter("  file_id    {%s}" % file_id)
1092
 
        mutter("  from_rel   %r" % from_rel)
1093
 
        mutter("  to_rel     %r" % to_rel)
1094
 
        mutter("  to_dir     %r" % to_dir)
1095
 
        mutter("  to_dir_id  {%s}" % to_dir_id)
1096
 
 
1097
 
        inv.rename(file_id, to_dir_id, to_tail)
1098
 
 
1099
 
        from_abs = self.abspath(from_rel)
1100
 
        to_abs = self.abspath(to_rel)
1101
 
        try:
1102
 
            osutils.rename(from_abs, to_abs)
1103
 
        except OSError, e:
1104
 
            inv.rename(file_id, from_parent, from_name)
1105
 
            raise BzrError("failed to rename %r to %r: %s"
1106
 
                    % (from_abs, to_abs, e[1]))
 
1508
        rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
 
1509
                                     from_id=from_id,
 
1510
                                     from_tail=from_tail,
 
1511
                                     from_parent_id=from_parent_id,
 
1512
                                     to_rel=to_rel, to_tail=to_tail,
 
1513
                                     to_parent_id=to_dir_id)
 
1514
        rename_entries.append(rename_entry)
 
1515
 
 
1516
        # determine which move mode to use. checks also for movability
 
1517
        rename_entries = self._determine_mv_mode(rename_entries, after)
 
1518
 
 
1519
        # check if the target changed directory and if the target directory is
 
1520
        # versioned
 
1521
        if to_dir_id is None:
 
1522
            raise errors.BzrMoveFailedError(from_rel,to_rel,
 
1523
                errors.NotVersionedError(path=str(to_dir)))
 
1524
 
 
1525
        # all checks done. now we can continue with our actual work
 
1526
        mutter('rename_one:\n'
 
1527
               '  from_id   {%s}\n'
 
1528
               '  from_rel: %r\n'
 
1529
               '  to_rel:   %r\n'
 
1530
               '  to_dir    %r\n'
 
1531
               '  to_dir_id {%s}\n',
 
1532
               from_id, from_rel, to_rel, to_dir, to_dir_id)
 
1533
 
 
1534
        self._move(rename_entries)
1107
1535
        self._write_inventory(inv)
1108
1536
 
 
1537
    class _RenameEntry(object):
 
1538
        def __init__(self, from_rel, from_id, from_tail, from_parent_id,
 
1539
                     to_rel, to_tail, to_parent_id, only_change_inv=False):
 
1540
            self.from_rel = from_rel
 
1541
            self.from_id = from_id
 
1542
            self.from_tail = from_tail
 
1543
            self.from_parent_id = from_parent_id
 
1544
            self.to_rel = to_rel
 
1545
            self.to_tail = to_tail
 
1546
            self.to_parent_id = to_parent_id
 
1547
            self.only_change_inv = only_change_inv
 
1548
 
1109
1549
    @needs_read_lock
1110
1550
    def unknowns(self):
1111
1551
        """Return all unknown files.
1113
1553
        These are files in the working directory that are not versioned or
1114
1554
        control files or ignored.
1115
1555
        """
1116
 
        for subp in self.extras():
1117
 
            if not self.is_ignored(subp):
1118
 
                yield subp
1119
 
    
 
1556
        # force the extras method to be fully executed before returning, to
 
1557
        # prevent race conditions with the lock
 
1558
        return iter(
 
1559
            [subp for subp in self.extras() if not self.is_ignored(subp)])
 
1560
 
1120
1561
    @needs_tree_write_lock
1121
1562
    def unversion(self, file_ids):
1122
1563
        """Remove the file ids in file_ids from the current versioned set.
1128
1569
        :raises: NoSuchId if any fileid is not currently versioned.
1129
1570
        """
1130
1571
        for file_id in file_ids:
 
1572
            if file_id not in self._inventory:
 
1573
                raise errors.NoSuchId(self, file_id)
 
1574
        for file_id in file_ids:
1131
1575
            if self._inventory.has_id(file_id):
1132
1576
                self._inventory.remove_recursive_id(file_id)
1133
 
            else:
1134
 
                raise errors.NoSuchId(self, file_id)
1135
1577
        if len(file_ids):
1136
 
            # in the future this should just set a dirty bit to wait for the 
 
1578
            # in the future this should just set a dirty bit to wait for the
1137
1579
            # final unlock. However, until all methods of workingtree start
1138
 
            # with the current in -memory inventory rather than triggering 
 
1580
            # with the current in -memory inventory rather than triggering
1139
1581
            # a read, it is more complex - we need to teach read_inventory
1140
1582
            # to know when to read, and when to not read first... and possibly
1141
1583
            # to save first when the in memory one may be corrupted.
1142
1584
            # so for now, we just only write it if it is indeed dirty.
1143
1585
            # - RBC 20060907
1144
1586
            self._write_inventory(self._inventory)
1145
 
    
1146
 
    @deprecated_method(zero_eight)
1147
 
    def iter_conflicts(self):
1148
 
        """List all files in the tree that have text or content conflicts.
1149
 
        DEPRECATED.  Use conflicts instead."""
1150
 
        return self._iter_conflicts()
1151
1587
 
1152
1588
    def _iter_conflicts(self):
1153
1589
        conflicted = set()
1161
1597
                yield stem
1162
1598
 
1163
1599
    @needs_write_lock
1164
 
    def pull(self, source, overwrite=False, stop_revision=None):
1165
 
        top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
1600
    def pull(self, source, overwrite=False, stop_revision=None,
 
1601
             change_reporter=None, possible_transports=None, local=False):
 
1602
        top_pb = ui.ui_factory.nested_progress_bar()
1166
1603
        source.lock_read()
1167
1604
        try:
1168
1605
            pp = ProgressPhase("Pull phase", 2, top_pb)
1169
1606
            pp.next_phase()
1170
 
            old_revision_history = self.branch.revision_history()
 
1607
            old_revision_info = self.branch.last_revision_info()
1171
1608
            basis_tree = self.basis_tree()
1172
 
            count = self.branch.pull(source, overwrite, stop_revision)
1173
 
            new_revision_history = self.branch.revision_history()
1174
 
            if new_revision_history != old_revision_history:
 
1609
            count = self.branch.pull(source, overwrite, stop_revision,
 
1610
                                     possible_transports=possible_transports,
 
1611
                                     local=local)
 
1612
            new_revision_info = self.branch.last_revision_info()
 
1613
            if new_revision_info != old_revision_info:
1175
1614
                pp.next_phase()
1176
 
                if len(old_revision_history):
1177
 
                    other_revision = old_revision_history[-1]
1178
 
                else:
1179
 
                    other_revision = None
1180
1615
                repository = self.branch.repository
1181
 
                pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
1616
                pb = ui.ui_factory.nested_progress_bar()
 
1617
                basis_tree.lock_read()
1182
1618
                try:
1183
1619
                    new_basis_tree = self.branch.basis_tree()
1184
1620
                    merge.merge_inner(
1186
1622
                                new_basis_tree,
1187
1623
                                basis_tree,
1188
1624
                                this_tree=self,
1189
 
                                pb=pb)
 
1625
                                pb=pb,
 
1626
                                change_reporter=change_reporter)
1190
1627
                    if (basis_tree.inventory.root is None and
1191
1628
                        new_basis_tree.inventory.root is not None):
1192
 
                        self.set_root_id(new_basis_tree.inventory.root.file_id)
 
1629
                        self.set_root_id(new_basis_tree.get_root_id())
1193
1630
                finally:
1194
1631
                    pb.finished()
 
1632
                    basis_tree.unlock()
1195
1633
                # TODO - dedup parents list with things merged by pull ?
1196
1634
                # reuse the revisiontree we merged against to set the new
1197
1635
                # tree data.
1198
1636
                parent_trees = [(self.branch.last_revision(), new_basis_tree)]
1199
 
                # we have to pull the merge trees out again, because 
1200
 
                # merge_inner has set the ids. - this corner is not yet 
 
1637
                # we have to pull the merge trees out again, because
 
1638
                # merge_inner has set the ids. - this corner is not yet
1201
1639
                # layered well enough to prevent double handling.
 
1640
                # XXX TODO: Fix the double handling: telling the tree about
 
1641
                # the already known parent data is wasteful.
1202
1642
                merges = self.get_parent_ids()[1:]
1203
1643
                parent_trees.extend([
1204
1644
                    (parent, repository.revision_tree(parent)) for
1220
1660
        # TODO: update the hashcache here ?
1221
1661
 
1222
1662
    def extras(self):
1223
 
        """Yield all unknown files in this WorkingTree.
 
1663
        """Yield all unversioned files in this WorkingTree.
1224
1664
 
1225
 
        If there are any unknown directories then only the directory is
1226
 
        returned, not all its children.  But if there are unknown files
 
1665
        If there are any unversioned directories then only the directory is
 
1666
        returned, not all its children.  But if there are unversioned files
1227
1667
        under a versioned subdirectory, they are returned.
1228
1668
 
1229
1669
        Currently returned depth-first, sorted by name within directories.
 
1670
        This is the same order used by 'osutils.walkdirs'.
1230
1671
        """
1231
1672
        ## TODO: Work from given directory downwards
1232
1673
        for path, dir_entry in self.inventory.directories():
1238
1679
 
1239
1680
            fl = []
1240
1681
            for subf in os.listdir(dirabs):
1241
 
                if subf == '.bzr':
 
1682
                if self.bzrdir.is_control_filename(subf):
1242
1683
                    continue
1243
1684
                if subf not in dir_entry.children:
1244
 
                    subf_norm, can_access = osutils.normalized_filename(subf)
 
1685
                    try:
 
1686
                        (subf_norm,
 
1687
                         can_access) = osutils.normalized_filename(subf)
 
1688
                    except UnicodeDecodeError:
 
1689
                        path_os_enc = path.encode(osutils._fs_enc)
 
1690
                        relpath = path_os_enc + '/' + subf
 
1691
                        raise errors.BadFilenameEncoding(relpath,
 
1692
                                                         osutils._fs_enc)
1245
1693
                    if subf_norm != subf and can_access:
1246
1694
                        if subf_norm not in dir_entry.children:
1247
1695
                            fl.append(subf_norm)
1248
1696
                    else:
1249
1697
                        fl.append(subf)
1250
 
            
 
1698
 
1251
1699
            fl.sort()
1252
1700
            for subf in fl:
1253
1701
                subp = pathjoin(path, subf)
1254
1702
                yield subp
1255
1703
 
1256
 
    def _translate_ignore_rule(self, rule):
1257
 
        """Translate a single ignore rule to a regex.
1258
 
 
1259
 
        There are two types of ignore rules.  Those that do not contain a / are
1260
 
        matched against the tail of the filename (that is, they do not care
1261
 
        what directory the file is in.)  Rules which do contain a slash must
1262
 
        match the entire path.  As a special case, './' at the start of the
1263
 
        string counts as a slash in the string but is removed before matching
1264
 
        (e.g. ./foo.c, ./src/foo.c)
1265
 
 
1266
 
        :return: The translated regex.
1267
 
        """
1268
 
        if rule[:2] in ('./', '.\\'):
1269
 
            # rootdir rule
1270
 
            result = fnmatch.translate(rule[2:])
1271
 
        elif '/' in rule or '\\' in rule:
1272
 
            # path prefix 
1273
 
            result = fnmatch.translate(rule)
1274
 
        else:
1275
 
            # default rule style.
1276
 
            result = "(?:.*/)?(?!.*/)" + fnmatch.translate(rule)
1277
 
        assert result[-1] == '$', "fnmatch.translate did not add the expected $"
1278
 
        return "(" + result + ")"
1279
 
 
1280
 
    def _combine_ignore_rules(self, rules):
1281
 
        """Combine a list of ignore rules into a single regex object.
1282
 
 
1283
 
        Each individual rule is combined with | to form a big regex, which then
1284
 
        has $ added to it to form something like ()|()|()$. The group index for
1285
 
        each subregex's outermost group is placed in a dictionary mapping back 
1286
 
        to the rule. This allows quick identification of the matching rule that
1287
 
        triggered a match.
1288
 
        :return: a list of the compiled regex and the matching-group index 
1289
 
        dictionaries. We return a list because python complains if you try to 
1290
 
        combine more than 100 regexes.
1291
 
        """
1292
 
        result = []
1293
 
        groups = {}
1294
 
        next_group = 0
1295
 
        translated_rules = []
1296
 
        for rule in rules:
1297
 
            translated_rule = self._translate_ignore_rule(rule)
1298
 
            compiled_rule = re.compile(translated_rule)
1299
 
            groups[next_group] = rule
1300
 
            next_group += compiled_rule.groups
1301
 
            translated_rules.append(translated_rule)
1302
 
            if next_group == 99:
1303
 
                result.append((re.compile("|".join(translated_rules)), groups))
1304
 
                groups = {}
1305
 
                next_group = 0
1306
 
                translated_rules = []
1307
 
        if len(translated_rules):
1308
 
            result.append((re.compile("|".join(translated_rules)), groups))
1309
 
        return result
1310
 
 
1311
1704
    def ignored_files(self):
1312
1705
        """Yield list of PATH, IGNORE_PATTERN"""
1313
1706
        for subp in self.extras():
1324
1717
        if ignoreset is not None:
1325
1718
            return ignoreset
1326
1719
 
1327
 
        ignore_globs = set(bzrlib.DEFAULT_IGNORE)
 
1720
        ignore_globs = set()
1328
1721
        ignore_globs.update(ignores.get_runtime_ignores())
1329
 
 
1330
1722
        ignore_globs.update(ignores.get_user_ignores())
1331
 
 
1332
1723
        if self.has_filename(bzrlib.IGNORE_FILENAME):
1333
1724
            f = self.get_file_byname(bzrlib.IGNORE_FILENAME)
1334
1725
            try:
1335
1726
                ignore_globs.update(ignores.parse_ignore_file(f))
1336
1727
            finally:
1337
1728
                f.close()
1338
 
 
1339
1729
        self._ignoreset = ignore_globs
1340
 
        self._ignore_regex = self._combine_ignore_rules(ignore_globs)
1341
1730
        return ignore_globs
1342
1731
 
1343
 
    def _get_ignore_rules_as_regex(self):
1344
 
        """Return a regex of the ignore rules and a mapping dict.
1345
 
 
1346
 
        :return: (ignore rules compiled regex, dictionary mapping rule group 
1347
 
        indices to original rule.)
1348
 
        """
1349
 
        if getattr(self, '_ignoreset', None) is None:
1350
 
            self.get_ignore_list()
1351
 
        return self._ignore_regex
 
1732
    def _flush_ignore_list_cache(self):
 
1733
        """Resets the cached ignore list to force a cache rebuild."""
 
1734
        self._ignoreset = None
 
1735
        self._ignoreglobster = None
1352
1736
 
1353
1737
    def is_ignored(self, filename):
1354
1738
        r"""Check whether the filename matches an ignore pattern.
1359
1743
        If the file is ignored, returns the pattern which caused it to
1360
1744
        be ignored, otherwise None.  So this can simply be used as a
1361
1745
        boolean if desired."""
1362
 
 
1363
 
        # TODO: Use '**' to match directories, and other extended
1364
 
        # globbing stuff from cvs/rsync.
1365
 
 
1366
 
        # XXX: fnmatch is actually not quite what we want: it's only
1367
 
        # approximately the same as real Unix fnmatch, and doesn't
1368
 
        # treat dotfiles correctly and allows * to match /.
1369
 
        # Eventually it should be replaced with something more
1370
 
        # accurate.
1371
 
    
1372
 
        rules = self._get_ignore_rules_as_regex()
1373
 
        for regex, mapping in rules:
1374
 
            match = regex.match(filename)
1375
 
            if match is not None:
1376
 
                # one or more of the groups in mapping will have a non-None
1377
 
                # group match.
1378
 
                groups = match.groups()
1379
 
                rules = [mapping[group] for group in 
1380
 
                    mapping if groups[group] is not None]
1381
 
                return rules[0]
1382
 
        return None
 
1746
        if getattr(self, '_ignoreglobster', None) is None:
 
1747
            self._ignoreglobster = globbing.Globster(self.get_ignore_list())
 
1748
        return self._ignoreglobster.match(filename)
1383
1749
 
1384
1750
    def kind(self, file_id):
1385
1751
        return file_kind(self.id2abspath(file_id))
1386
1752
 
 
1753
    def stored_kind(self, file_id):
 
1754
        """See Tree.stored_kind"""
 
1755
        return self.inventory[file_id].kind
 
1756
 
 
1757
    def _comparison_data(self, entry, path):
 
1758
        abspath = self.abspath(path)
 
1759
        try:
 
1760
            stat_value = os.lstat(abspath)
 
1761
        except OSError, e:
 
1762
            if getattr(e, 'errno', None) == errno.ENOENT:
 
1763
                stat_value = None
 
1764
                kind = None
 
1765
                executable = False
 
1766
            else:
 
1767
                raise
 
1768
        else:
 
1769
            mode = stat_value.st_mode
 
1770
            kind = osutils.file_kind_from_stat_mode(mode)
 
1771
            if not supports_executable():
 
1772
                executable = entry is not None and entry.executable
 
1773
            else:
 
1774
                executable = bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
 
1775
        return kind, executable, stat_value
 
1776
 
 
1777
    def _file_size(self, entry, stat_value):
 
1778
        return stat_value.st_size
 
1779
 
1387
1780
    def last_revision(self):
1388
1781
        """Return the last revision of the branch for this tree.
1389
1782
 
1397
1790
    @needs_read_lock
1398
1791
    def _last_revision(self):
1399
1792
        """helper for get_parent_ids."""
1400
 
        return self.branch.last_revision()
 
1793
        return _mod_revision.ensure_null(self.branch.last_revision())
1401
1794
 
1402
1795
    def is_locked(self):
1403
1796
        return self._control_files.is_locked()
1404
1797
 
 
1798
    def _must_be_locked(self):
 
1799
        if not self.is_locked():
 
1800
            raise errors.ObjectNotLocked(self)
 
1801
 
1405
1802
    def lock_read(self):
1406
1803
        """See Branch.lock_read, and WorkingTree.unlock."""
 
1804
        if not self.is_locked():
 
1805
            self._reset_data()
1407
1806
        self.branch.lock_read()
1408
1807
        try:
1409
1808
            return self._control_files.lock_read()
1413
1812
 
1414
1813
    def lock_tree_write(self):
1415
1814
        """See MutableTree.lock_tree_write, and WorkingTree.unlock."""
 
1815
        if not self.is_locked():
 
1816
            self._reset_data()
1416
1817
        self.branch.lock_read()
1417
1818
        try:
1418
1819
            return self._control_files.lock_write()
1422
1823
 
1423
1824
    def lock_write(self):
1424
1825
        """See MutableTree.lock_write, and WorkingTree.unlock."""
 
1826
        if not self.is_locked():
 
1827
            self._reset_data()
1425
1828
        self.branch.lock_write()
1426
1829
        try:
1427
1830
            return self._control_files.lock_write()
1435
1838
    def _basis_inventory_name(self):
1436
1839
        return 'basis-inventory-cache'
1437
1840
 
 
1841
    def _reset_data(self):
 
1842
        """Reset transient data that cannot be revalidated."""
 
1843
        self._inventory_is_modified = False
 
1844
        result = self._deserialize(self._transport.get('inventory'))
 
1845
        self._set_inventory(result, dirty=False)
 
1846
 
1438
1847
    @needs_tree_write_lock
1439
1848
    def set_last_revision(self, new_revision):
1440
1849
        """Change the last revision in the working tree."""
1443
1852
 
1444
1853
    def _change_last_revision(self, new_revision):
1445
1854
        """Template method part of set_last_revision to perform the change.
1446
 
        
 
1855
 
1447
1856
        This is used to allow WorkingTree3 instances to not affect branch
1448
1857
        when their last revision is set.
1449
1858
        """
1450
 
        if new_revision is None:
 
1859
        if _mod_revision.is_null(new_revision):
1451
1860
            self.branch.set_revision_history([])
1452
1861
            return False
1453
1862
        try:
1459
1868
 
1460
1869
    def _write_basis_inventory(self, xml):
1461
1870
        """Write the basis inventory XML to the basis-inventory file"""
1462
 
        assert isinstance(xml, str), 'serialised xml must be bytestring.'
1463
1871
        path = self._basis_inventory_name()
1464
1872
        sio = StringIO(xml)
1465
 
        self._control_files.put(path, sio)
 
1873
        self._transport.put_file(path, sio,
 
1874
            mode=self.bzrdir._get_file_mode())
1466
1875
 
1467
1876
    def _create_basis_xml_from_inventory(self, revision_id, inventory):
1468
1877
        """Create the text that will be saved in basis-inventory"""
1469
1878
        inventory.revision_id = revision_id
1470
 
        return xml6.serializer_v6.write_inventory_to_string(inventory)
 
1879
        return xml7.serializer_v7.write_inventory_to_string(inventory)
1471
1880
 
1472
1881
    def _cache_basis_inventory(self, new_revision):
1473
1882
        """Cache new_revision as the basis inventory."""
1475
1884
        # as commit already has that ready-to-use [while the format is the
1476
1885
        # same, that is].
1477
1886
        try:
1478
 
            # this double handles the inventory - unpack and repack - 
 
1887
            # this double handles the inventory - unpack and repack -
1479
1888
            # but is easier to understand. We can/should put a conditional
1480
1889
            # in here based on whether the inventory is in the latest format
1481
1890
            # - perhaps we should repack all inventories on a repository
1482
1891
            # upgrade ?
1483
1892
            # the fast path is to copy the raw xml from the repository. If the
1484
 
            # xml contains 'revision_id="', then we assume the right 
 
1893
            # xml contains 'revision_id="', then we assume the right
1485
1894
            # revision_id is set. We must check for this full string, because a
1486
1895
            # root node id can legitimately look like 'revision_id' but cannot
1487
1896
            # contain a '"'.
1488
1897
            xml = self.branch.repository.get_inventory_xml(new_revision)
1489
1898
            firstline = xml.split('\n', 1)[0]
1490
 
            if (not 'revision_id="' in firstline or 
1491
 
                'format="6"' not in firstline):
1492
 
                inv = self.branch.repository.deserialise_inventory(
1493
 
                    new_revision, xml)
 
1899
            if (not 'revision_id="' in firstline or
 
1900
                'format="7"' not in firstline):
 
1901
                inv = self.branch.repository._serializer.read_inventory_from_string(
 
1902
                    xml, new_revision)
1494
1903
                xml = self._create_basis_xml_from_inventory(new_revision, inv)
1495
1904
            self._write_basis_inventory(xml)
1496
1905
        except (errors.NoSuchRevision, errors.RevisionNotPresent):
1499
1908
    def read_basis_inventory(self):
1500
1909
        """Read the cached basis inventory."""
1501
1910
        path = self._basis_inventory_name()
1502
 
        return self._control_files.get(path).read()
1503
 
        
 
1911
        return self._transport.get_bytes(path)
 
1912
 
1504
1913
    @needs_read_lock
1505
1914
    def read_working_inventory(self):
1506
1915
        """Read the working inventory.
1507
 
        
 
1916
 
1508
1917
        :raises errors.InventoryModified: read_working_inventory will fail
1509
1918
            when the current in memory inventory has been modified.
1510
1919
        """
1511
 
        # conceptually this should be an implementation detail of the tree. 
 
1920
        # conceptually this should be an implementation detail of the tree.
1512
1921
        # XXX: Deprecate this.
1513
1922
        # ElementTree does its own conversion from UTF-8, so open in
1514
1923
        # binary.
1515
1924
        if self._inventory_is_modified:
1516
1925
            raise errors.InventoryModified(self)
1517
 
        result = xml5.serializer_v5.read_inventory(
1518
 
            self._control_files.get('inventory'))
 
1926
        result = self._deserialize(self._transport.get('inventory'))
1519
1927
        self._set_inventory(result, dirty=False)
1520
1928
        return result
1521
1929
 
1522
1930
    @needs_tree_write_lock
1523
 
    def remove(self, files, verbose=False, to_file=None):
1524
 
        """Remove nominated files from the working inventory..
1525
 
 
1526
 
        This does not remove their text.  This does not run on XXX on what? RBC
1527
 
 
1528
 
        TODO: Refuse to remove modified files unless --force is given?
1529
 
 
1530
 
        TODO: Do something useful with directories.
1531
 
 
1532
 
        TODO: Should this remove the text or not?  Tough call; not
1533
 
        removing may be useful and the user can just use use rm, and
1534
 
        is the opposite of add.  Removing it is consistent with most
1535
 
        other tools.  Maybe an option.
 
1931
    def remove(self, files, verbose=False, to_file=None, keep_files=True,
 
1932
        force=False):
 
1933
        """Remove nominated files from the working inventory.
 
1934
 
 
1935
        :files: File paths relative to the basedir.
 
1936
        :keep_files: If true, the files will also be kept.
 
1937
        :force: Delete files and directories, even if they are changed and
 
1938
            even if the directories are not empty.
1536
1939
        """
1537
 
        ## TODO: Normalize names
1538
 
        ## TODO: Remove nested loops; better scalability
1539
1940
        if isinstance(files, basestring):
1540
1941
            files = [files]
1541
1942
 
1542
 
        inv = self.inventory
1543
 
 
1544
 
        # do this before any modifications
 
1943
        inv_delta = []
 
1944
 
 
1945
        new_files=set()
 
1946
        unknown_nested_files=set()
 
1947
 
 
1948
        def recurse_directory_to_add_files(directory):
 
1949
            # Recurse directory and add all files
 
1950
            # so we can check if they have changed.
 
1951
            for parent_info, file_infos in\
 
1952
                self.walkdirs(directory):
 
1953
                for relpath, basename, kind, lstat, fileid, kind in file_infos:
 
1954
                    # Is it versioned or ignored?
 
1955
                    if self.path2id(relpath) or self.is_ignored(relpath):
 
1956
                        # Add nested content for deletion.
 
1957
                        new_files.add(relpath)
 
1958
                    else:
 
1959
                        # Files which are not versioned and not ignored
 
1960
                        # should be treated as unknown.
 
1961
                        unknown_nested_files.add((relpath, None, kind))
 
1962
 
 
1963
        for filename in files:
 
1964
            # Get file name into canonical form.
 
1965
            abspath = self.abspath(filename)
 
1966
            filename = self.relpath(abspath)
 
1967
            if len(filename) > 0:
 
1968
                new_files.add(filename)
 
1969
                recurse_directory_to_add_files(filename)
 
1970
 
 
1971
        files = list(new_files)
 
1972
 
 
1973
        if len(files) == 0:
 
1974
            return # nothing to do
 
1975
 
 
1976
        # Sort needed to first handle directory content before the directory
 
1977
        files.sort(reverse=True)
 
1978
 
 
1979
        # Bail out if we are going to delete files we shouldn't
 
1980
        if not keep_files and not force:
 
1981
            has_changed_files = len(unknown_nested_files) > 0
 
1982
            if not has_changed_files:
 
1983
                for (file_id, path, content_change, versioned, parent_id, name,
 
1984
                     kind, executable) in self.iter_changes(self.basis_tree(),
 
1985
                         include_unchanged=True, require_versioned=False,
 
1986
                         want_unversioned=True, specific_files=files):
 
1987
                    if versioned == (False, False):
 
1988
                        # The record is unknown ...
 
1989
                        if not self.is_ignored(path[1]):
 
1990
                            # ... but not ignored
 
1991
                            has_changed_files = True
 
1992
                            break
 
1993
                    elif content_change and (kind[1] is not None):
 
1994
                        # Versioned and changed, but not deleted
 
1995
                        has_changed_files = True
 
1996
                        break
 
1997
 
 
1998
            if has_changed_files:
 
1999
                # Make delta show ALL applicable changes in error message.
 
2000
                tree_delta = self.changes_from(self.basis_tree(),
 
2001
                    require_versioned=False, want_unversioned=True,
 
2002
                    specific_files=files)
 
2003
                for unknown_file in unknown_nested_files:
 
2004
                    if unknown_file not in tree_delta.unversioned:
 
2005
                        tree_delta.unversioned.extend((unknown_file,))
 
2006
                raise errors.BzrRemoveChangedFilesError(tree_delta)
 
2007
 
 
2008
        # Build inv_delta and delete files where applicable,
 
2009
        # do this before any modifications to inventory.
1545
2010
        for f in files:
1546
 
            fid = inv.path2id(f)
 
2011
            fid = self.path2id(f)
 
2012
            message = None
1547
2013
            if not fid:
1548
 
                # TODO: Perhaps make this just a warning, and continue?
1549
 
                # This tends to happen when 
1550
 
                raise NotVersionedError(path=f)
1551
 
            if verbose:
1552
 
                # having remove it, it must be either ignored or unknown
1553
 
                if self.is_ignored(f):
1554
 
                    new_status = 'I'
1555
 
                else:
1556
 
                    new_status = '?'
1557
 
                textui.show_status(new_status, inv[fid].kind, f,
1558
 
                                   to_file=to_file)
1559
 
            del inv[fid]
1560
 
 
1561
 
        self._write_inventory(inv)
 
2014
                message = "%s is not versioned." % (f,)
 
2015
            else:
 
2016
                if verbose:
 
2017
                    # having removed it, it must be either ignored or unknown
 
2018
                    if self.is_ignored(f):
 
2019
                        new_status = 'I'
 
2020
                    else:
 
2021
                        new_status = '?'
 
2022
                    textui.show_status(new_status, self.kind(fid), f,
 
2023
                                       to_file=to_file)
 
2024
                # Unversion file
 
2025
                inv_delta.append((f, None, fid, None))
 
2026
                message = "removed %s" % (f,)
 
2027
 
 
2028
            if not keep_files:
 
2029
                abs_path = self.abspath(f)
 
2030
                if osutils.lexists(abs_path):
 
2031
                    if (osutils.isdir(abs_path) and
 
2032
                        len(os.listdir(abs_path)) > 0):
 
2033
                        if force:
 
2034
                            osutils.rmtree(abs_path)
 
2035
                        else:
 
2036
                            message = "%s is not an empty directory "\
 
2037
                                "and won't be deleted." % (f,)
 
2038
                    else:
 
2039
                        osutils.delete_any(abs_path)
 
2040
                        message = "deleted %s" % (f,)
 
2041
                elif message is not None:
 
2042
                    # Only care if we haven't done anything yet.
 
2043
                    message = "%s does not exist." % (f,)
 
2044
 
 
2045
            # Print only one message (if any) per file.
 
2046
            if message is not None:
 
2047
                note(message)
 
2048
        self.apply_inventory_delta(inv_delta)
1562
2049
 
1563
2050
    @needs_tree_write_lock
1564
 
    def revert(self, filenames, old_tree=None, backups=True, 
1565
 
               pb=DummyProgress()):
 
2051
    def revert(self, filenames=None, old_tree=None, backups=True,
 
2052
               pb=DummyProgress(), report_changes=False):
1566
2053
        from bzrlib.conflicts import resolve
 
2054
        if filenames == []:
 
2055
            filenames = None
 
2056
            symbol_versioning.warn('Using [] to revert all files is deprecated'
 
2057
                ' as of bzr 0.91.  Please use None (the default) instead.',
 
2058
                DeprecationWarning, stacklevel=2)
1567
2059
        if old_tree is None:
1568
 
            old_tree = self.basis_tree()
1569
 
        conflicts = transform.revert(self, old_tree, filenames, backups, pb)
1570
 
        if not len(filenames):
1571
 
            self.set_parent_ids(self.get_parent_ids()[:1])
1572
 
            resolve(self)
 
2060
            basis_tree = self.basis_tree()
 
2061
            basis_tree.lock_read()
 
2062
            old_tree = basis_tree
1573
2063
        else:
1574
 
            resolve(self, filenames, ignore_misses=True)
 
2064
            basis_tree = None
 
2065
        try:
 
2066
            conflicts = transform.revert(self, old_tree, filenames, backups, pb,
 
2067
                                         report_changes)
 
2068
            if filenames is None and len(self.get_parent_ids()) > 1:
 
2069
                parent_trees = []
 
2070
                last_revision = self.last_revision()
 
2071
                if last_revision != _mod_revision.NULL_REVISION:
 
2072
                    if basis_tree is None:
 
2073
                        basis_tree = self.basis_tree()
 
2074
                        basis_tree.lock_read()
 
2075
                    parent_trees.append((last_revision, basis_tree))
 
2076
                self.set_parent_trees(parent_trees)
 
2077
                resolve(self)
 
2078
            else:
 
2079
                resolve(self, filenames, ignore_misses=True, recursive=True)
 
2080
        finally:
 
2081
            if basis_tree is not None:
 
2082
                basis_tree.unlock()
1575
2083
        return conflicts
1576
2084
 
 
2085
    def revision_tree(self, revision_id):
 
2086
        """See Tree.revision_tree.
 
2087
 
 
2088
        WorkingTree can supply revision_trees for the basis revision only
 
2089
        because there is only one cached inventory in the bzr directory.
 
2090
        """
 
2091
        if revision_id == self.last_revision():
 
2092
            try:
 
2093
                xml = self.read_basis_inventory()
 
2094
            except errors.NoSuchFile:
 
2095
                pass
 
2096
            else:
 
2097
                try:
 
2098
                    inv = xml7.serializer_v7.read_inventory_from_string(xml)
 
2099
                    # dont use the repository revision_tree api because we want
 
2100
                    # to supply the inventory.
 
2101
                    if inv.revision_id == revision_id:
 
2102
                        return revisiontree.RevisionTree(self.branch.repository,
 
2103
                            inv, revision_id)
 
2104
                except errors.BadInventoryFormat:
 
2105
                    pass
 
2106
        # raise if there was no inventory, or if we read the wrong inventory.
 
2107
        raise errors.NoSuchRevisionInTree(self, revision_id)
 
2108
 
1577
2109
    # XXX: This method should be deprecated in favour of taking in a proper
1578
2110
    # new Inventory object.
1579
2111
    @needs_tree_write_lock
1580
2112
    def set_inventory(self, new_inventory_list):
1581
2113
        from bzrlib.inventory import (Inventory,
1582
2114
                                      InventoryDirectory,
1583
 
                                      InventoryEntry,
1584
2115
                                      InventoryFile,
1585
2116
                                      InventoryLink)
1586
2117
        inv = Inventory(self.get_root_id())
1588
2119
            name = os.path.basename(path)
1589
2120
            if name == "":
1590
2121
                continue
1591
 
            # fixme, there should be a factory function inv,add_?? 
 
2122
            # fixme, there should be a factory function inv,add_??
1592
2123
            if kind == 'directory':
1593
2124
                inv.add(InventoryDirectory(file_id, name, parent))
1594
2125
            elif kind == 'file':
1596
2127
            elif kind == 'symlink':
1597
2128
                inv.add(InventoryLink(file_id, name, parent))
1598
2129
            else:
1599
 
                raise BzrError("unknown kind %r" % kind)
 
2130
                raise errors.BzrError("unknown kind %r" % kind)
1600
2131
        self._write_inventory(inv)
1601
2132
 
1602
2133
    @needs_tree_write_lock
1603
2134
    def set_root_id(self, file_id):
1604
2135
        """Set the root id for this tree."""
1605
 
        # for compatability 
 
2136
        # for compatability
1606
2137
        if file_id is None:
1607
 
            symbol_versioning.warn(symbol_versioning.zero_twelve
1608
 
                % 'WorkingTree.set_root_id with fileid=None',
1609
 
                DeprecationWarning,
1610
 
                stacklevel=3)
1611
 
            file_id = ROOT_ID
 
2138
            raise ValueError(
 
2139
                'WorkingTree.set_root_id with fileid=None')
 
2140
        file_id = osutils.safe_file_id(file_id)
 
2141
        self._set_root_id(file_id)
 
2142
 
 
2143
    def _set_root_id(self, file_id):
 
2144
        """Set the root id for this tree, in a format specific manner.
 
2145
 
 
2146
        :param file_id: The file id to assign to the root. It must not be
 
2147
            present in the current inventory or an error will occur. It must
 
2148
            not be None, but rather a valid file id.
 
2149
        """
1612
2150
        inv = self._inventory
1613
2151
        orig_root_id = inv.root.file_id
1614
2152
        # TODO: it might be nice to exit early if there was nothing
1630
2168
 
1631
2169
    def unlock(self):
1632
2170
        """See Branch.unlock.
1633
 
        
 
2171
 
1634
2172
        WorkingTree locking just uses the Branch locking facilities.
1635
2173
        This is current because all working trees have an embedded branch
1636
2174
        within them. IF in the future, we were to make branch data shareable
1637
 
        between multiple working trees, i.e. via shared storage, then we 
 
2175
        between multiple working trees, i.e. via shared storage, then we
1638
2176
        would probably want to lock both the local tree, and the branch.
1639
2177
        """
1640
2178
        raise NotImplementedError(self.unlock)
1641
2179
 
1642
 
    def update(self):
 
2180
    def update(self, change_reporter=None, possible_transports=None):
1643
2181
        """Update a working tree along its branch.
1644
2182
 
1645
2183
        This will update the branch if its bound too, which means we have
1664
2202
          basis.
1665
2203
        - Do a 'normal' merge of the old branch basis if it is relevant.
1666
2204
        """
1667
 
        if self.branch.get_master_branch() is not None:
 
2205
        if self.branch.get_bound_location() is not None:
1668
2206
            self.lock_write()
1669
2207
            update_branch = True
1670
2208
        else:
1672
2210
            update_branch = False
1673
2211
        try:
1674
2212
            if update_branch:
1675
 
                old_tip = self.branch.update()
 
2213
                old_tip = self.branch.update(possible_transports)
1676
2214
            else:
1677
2215
                old_tip = None
1678
 
            return self._update_tree(old_tip)
 
2216
            return self._update_tree(old_tip, change_reporter)
1679
2217
        finally:
1680
2218
            self.unlock()
1681
2219
 
1682
2220
    @needs_tree_write_lock
1683
 
    def _update_tree(self, old_tip=None):
 
2221
    def _update_tree(self, old_tip=None, change_reporter=None):
1684
2222
        """Update a tree to the master branch.
1685
2223
 
1686
2224
        :param old_tip: if supplied, the previous tip revision the branch,
1692
2230
        # cant set that until we update the working trees last revision to be
1693
2231
        # one from the new branch, because it will just get absorbed by the
1694
2232
        # parent de-duplication logic.
1695
 
        # 
 
2233
        #
1696
2234
        # We MUST save it even if an error occurs, because otherwise the users
1697
2235
        # local work is unreferenced and will appear to have been lost.
1698
 
        # 
 
2236
        #
1699
2237
        result = 0
1700
2238
        try:
1701
2239
            last_rev = self.get_parent_ids()[0]
1702
2240
        except IndexError:
1703
 
            last_rev = None
1704
 
        if last_rev != self.branch.last_revision():
 
2241
            last_rev = _mod_revision.NULL_REVISION
 
2242
        if last_rev != _mod_revision.ensure_null(self.branch.last_revision()):
1705
2243
            # merge tree state up to new branch tip.
1706
2244
            basis = self.basis_tree()
1707
 
            to_tree = self.branch.basis_tree()
1708
 
            if basis.inventory.root is None:
1709
 
                self.set_root_id(to_tree.inventory.root.file_id)
1710
 
            result += merge.merge_inner(
1711
 
                                  self.branch,
1712
 
                                  to_tree,
1713
 
                                  basis,
1714
 
                                  this_tree=self)
 
2245
            basis.lock_read()
 
2246
            try:
 
2247
                to_tree = self.branch.basis_tree()
 
2248
                if basis.inventory.root is None:
 
2249
                    self.set_root_id(to_tree.get_root_id())
 
2250
                    self.flush()
 
2251
                result += merge.merge_inner(
 
2252
                                      self.branch,
 
2253
                                      to_tree,
 
2254
                                      basis,
 
2255
                                      this_tree=self,
 
2256
                                      change_reporter=change_reporter)
 
2257
            finally:
 
2258
                basis.unlock()
1715
2259
            # TODO - dedup parents list with things merged by pull ?
1716
2260
            # reuse the tree we've updated to to set the basis:
1717
2261
            parent_trees = [(self.branch.last_revision(), to_tree)]
1718
2262
            merges = self.get_parent_ids()[1:]
1719
2263
            # Ideally we ask the tree for the trees here, that way the working
1720
 
            # tree can decide whether to give us teh entire tree or give us a
 
2264
            # tree can decide whether to give us the entire tree or give us a
1721
2265
            # lazy initialised tree. dirstate for instance will have the trees
1722
2266
            # in ram already, whereas a last-revision + basis-inventory tree
1723
2267
            # will not, but also does not need them when setting parents.
1724
2268
            for parent in merges:
1725
2269
                parent_trees.append(
1726
2270
                    (parent, self.branch.repository.revision_tree(parent)))
1727
 
            if old_tip is not None:
 
2271
            if (old_tip is not None and not _mod_revision.is_null(old_tip)):
1728
2272
                parent_trees.append(
1729
2273
                    (old_tip, self.branch.repository.revision_tree(old_tip)))
1730
2274
            self.set_parent_trees(parent_trees)
1733
2277
            # the working tree had the same last-revision as the master
1734
2278
            # branch did. We may still have pivot local work from the local
1735
2279
            # branch into old_tip:
1736
 
            if old_tip is not None:
 
2280
            if (old_tip is not None and not _mod_revision.is_null(old_tip)):
1737
2281
                self.add_parent_tree_id(old_tip)
1738
 
        if old_tip and old_tip != last_rev:
 
2282
        if (old_tip is not None and not _mod_revision.is_null(old_tip)
 
2283
            and old_tip != last_rev):
1739
2284
            # our last revision was not the prior branch last revision
1740
2285
            # and we have converted that last revision to a pending merge.
1741
2286
            # base is somewhere between the branch tip now
1742
2287
            # and the now pending merge
1743
 
            from bzrlib.revision import common_ancestor
1744
 
            try:
1745
 
                base_rev_id = common_ancestor(self.branch.last_revision(),
1746
 
                                              old_tip,
1747
 
                                              self.branch.repository)
1748
 
            except errors.NoCommonAncestor:
1749
 
                base_rev_id = None
 
2288
 
 
2289
            # Since we just modified the working tree and inventory, flush out
 
2290
            # the current state, before we modify it again.
 
2291
            # TODO: jam 20070214 WorkingTree3 doesn't require this, dirstate
 
2292
            #       requires it only because TreeTransform directly munges the
 
2293
            #       inventory and calls tree._write_inventory(). Ultimately we
 
2294
            #       should be able to remove this extra flush.
 
2295
            self.flush()
 
2296
            graph = self.branch.repository.get_graph()
 
2297
            base_rev_id = graph.find_unique_lca(self.branch.last_revision(),
 
2298
                                                old_tip)
1750
2299
            base_tree = self.branch.repository.revision_tree(base_rev_id)
1751
2300
            other_tree = self.branch.repository.revision_tree(old_tip)
1752
2301
            result += merge.merge_inner(
1753
2302
                                  self.branch,
1754
2303
                                  other_tree,
1755
2304
                                  base_tree,
1756
 
                                  this_tree=self)
 
2305
                                  this_tree=self,
 
2306
                                  change_reporter=change_reporter)
1757
2307
        return result
1758
2308
 
 
2309
    def _write_hashcache_if_dirty(self):
 
2310
        """Write out the hashcache if it is dirty."""
 
2311
        if self._hashcache.needs_write:
 
2312
            try:
 
2313
                self._hashcache.write()
 
2314
            except OSError, e:
 
2315
                if e.errno not in (errno.EPERM, errno.EACCES):
 
2316
                    raise
 
2317
                # TODO: jam 20061219 Should this be a warning? A single line
 
2318
                #       warning might be sufficient to let the user know what
 
2319
                #       is going on.
 
2320
                mutter('Could not write hashcache for %s\nError: %s',
 
2321
                       self._hashcache.cache_file_name(), e)
 
2322
 
1759
2323
    @needs_tree_write_lock
1760
2324
    def _write_inventory(self, inv):
1761
2325
        """Write inventory as the current inventory."""
1763
2327
        self.flush()
1764
2328
 
1765
2329
    def set_conflicts(self, arg):
1766
 
        raise UnsupportedOperation(self.set_conflicts, self)
 
2330
        raise errors.UnsupportedOperation(self.set_conflicts, self)
1767
2331
 
1768
2332
    def add_conflicts(self, arg):
1769
 
        raise UnsupportedOperation(self.add_conflicts, self)
 
2333
        raise errors.UnsupportedOperation(self.add_conflicts, self)
1770
2334
 
1771
2335
    @needs_read_lock
1772
2336
    def conflicts(self):
1794
2358
                             file_id=self.path2id(conflicted)))
1795
2359
        return conflicts
1796
2360
 
 
2361
    def walkdirs(self, prefix=""):
 
2362
        """Walk the directories of this tree.
 
2363
 
 
2364
        returns a generator which yields items in the form:
 
2365
                ((curren_directory_path, fileid),
 
2366
                 [(file1_path, file1_name, file1_kind, (lstat), file1_id,
 
2367
                   file1_kind), ... ])
 
2368
 
 
2369
        This API returns a generator, which is only valid during the current
 
2370
        tree transaction - within a single lock_read or lock_write duration.
 
2371
 
 
2372
        If the tree is not locked, it may cause an error to be raised,
 
2373
        depending on the tree implementation.
 
2374
        """
 
2375
        disk_top = self.abspath(prefix)
 
2376
        if disk_top.endswith('/'):
 
2377
            disk_top = disk_top[:-1]
 
2378
        top_strip_len = len(disk_top) + 1
 
2379
        inventory_iterator = self._walkdirs(prefix)
 
2380
        disk_iterator = osutils.walkdirs(disk_top, prefix)
 
2381
        try:
 
2382
            current_disk = disk_iterator.next()
 
2383
            disk_finished = False
 
2384
        except OSError, e:
 
2385
            if not (e.errno == errno.ENOENT or
 
2386
                (sys.platform == 'win32' and e.errno == ERROR_PATH_NOT_FOUND)):
 
2387
                raise
 
2388
            current_disk = None
 
2389
            disk_finished = True
 
2390
        try:
 
2391
            current_inv = inventory_iterator.next()
 
2392
            inv_finished = False
 
2393
        except StopIteration:
 
2394
            current_inv = None
 
2395
            inv_finished = True
 
2396
        while not inv_finished or not disk_finished:
 
2397
            if current_disk:
 
2398
                ((cur_disk_dir_relpath, cur_disk_dir_path_from_top),
 
2399
                    cur_disk_dir_content) = current_disk
 
2400
            else:
 
2401
                ((cur_disk_dir_relpath, cur_disk_dir_path_from_top),
 
2402
                    cur_disk_dir_content) = ((None, None), None)
 
2403
            if not disk_finished:
 
2404
                # strip out .bzr dirs
 
2405
                if (cur_disk_dir_path_from_top[top_strip_len:] == '' and
 
2406
                    len(cur_disk_dir_content) > 0):
 
2407
                    # osutils.walkdirs can be made nicer -
 
2408
                    # yield the path-from-prefix rather than the pathjoined
 
2409
                    # value.
 
2410
                    bzrdir_loc = bisect_left(cur_disk_dir_content,
 
2411
                        ('.bzr', '.bzr'))
 
2412
                    if (bzrdir_loc < len(cur_disk_dir_content)
 
2413
                        and self.bzrdir.is_control_filename(
 
2414
                            cur_disk_dir_content[bzrdir_loc][0])):
 
2415
                        # we dont yield the contents of, or, .bzr itself.
 
2416
                        del cur_disk_dir_content[bzrdir_loc]
 
2417
            if inv_finished:
 
2418
                # everything is unknown
 
2419
                direction = 1
 
2420
            elif disk_finished:
 
2421
                # everything is missing
 
2422
                direction = -1
 
2423
            else:
 
2424
                direction = cmp(current_inv[0][0], cur_disk_dir_relpath)
 
2425
            if direction > 0:
 
2426
                # disk is before inventory - unknown
 
2427
                dirblock = [(relpath, basename, kind, stat, None, None) for
 
2428
                    relpath, basename, kind, stat, top_path in
 
2429
                    cur_disk_dir_content]
 
2430
                yield (cur_disk_dir_relpath, None), dirblock
 
2431
                try:
 
2432
                    current_disk = disk_iterator.next()
 
2433
                except StopIteration:
 
2434
                    disk_finished = True
 
2435
            elif direction < 0:
 
2436
                # inventory is before disk - missing.
 
2437
                dirblock = [(relpath, basename, 'unknown', None, fileid, kind)
 
2438
                    for relpath, basename, dkind, stat, fileid, kind in
 
2439
                    current_inv[1]]
 
2440
                yield (current_inv[0][0], current_inv[0][1]), dirblock
 
2441
                try:
 
2442
                    current_inv = inventory_iterator.next()
 
2443
                except StopIteration:
 
2444
                    inv_finished = True
 
2445
            else:
 
2446
                # versioned present directory
 
2447
                # merge the inventory and disk data together
 
2448
                dirblock = []
 
2449
                for relpath, subiterator in itertools.groupby(sorted(
 
2450
                    current_inv[1] + cur_disk_dir_content,
 
2451
                    key=operator.itemgetter(0)), operator.itemgetter(1)):
 
2452
                    path_elements = list(subiterator)
 
2453
                    if len(path_elements) == 2:
 
2454
                        inv_row, disk_row = path_elements
 
2455
                        # versioned, present file
 
2456
                        dirblock.append((inv_row[0],
 
2457
                            inv_row[1], disk_row[2],
 
2458
                            disk_row[3], inv_row[4],
 
2459
                            inv_row[5]))
 
2460
                    elif len(path_elements[0]) == 5:
 
2461
                        # unknown disk file
 
2462
                        dirblock.append((path_elements[0][0],
 
2463
                            path_elements[0][1], path_elements[0][2],
 
2464
                            path_elements[0][3], None, None))
 
2465
                    elif len(path_elements[0]) == 6:
 
2466
                        # versioned, absent file.
 
2467
                        dirblock.append((path_elements[0][0],
 
2468
                            path_elements[0][1], 'unknown', None,
 
2469
                            path_elements[0][4], path_elements[0][5]))
 
2470
                    else:
 
2471
                        raise NotImplementedError('unreachable code')
 
2472
                yield current_inv[0], dirblock
 
2473
                try:
 
2474
                    current_inv = inventory_iterator.next()
 
2475
                except StopIteration:
 
2476
                    inv_finished = True
 
2477
                try:
 
2478
                    current_disk = disk_iterator.next()
 
2479
                except StopIteration:
 
2480
                    disk_finished = True
 
2481
 
 
2482
    def _walkdirs(self, prefix=""):
 
2483
        """Walk the directories of this tree.
 
2484
 
 
2485
           :prefix: is used as the directrory to start with.
 
2486
           returns a generator which yields items in the form:
 
2487
                ((curren_directory_path, fileid),
 
2488
                 [(file1_path, file1_name, file1_kind, None, file1_id,
 
2489
                   file1_kind), ... ])
 
2490
        """
 
2491
        _directory = 'directory'
 
2492
        # get the root in the inventory
 
2493
        inv = self.inventory
 
2494
        top_id = inv.path2id(prefix)
 
2495
        if top_id is None:
 
2496
            pending = []
 
2497
        else:
 
2498
            pending = [(prefix, '', _directory, None, top_id, None)]
 
2499
        while pending:
 
2500
            dirblock = []
 
2501
            currentdir = pending.pop()
 
2502
            # 0 - relpath, 1- basename, 2- kind, 3- stat, 4-id, 5-kind
 
2503
            top_id = currentdir[4]
 
2504
            if currentdir[0]:
 
2505
                relroot = currentdir[0] + '/'
 
2506
            else:
 
2507
                relroot = ""
 
2508
            # FIXME: stash the node in pending
 
2509
            entry = inv[top_id]
 
2510
            if entry.kind == 'directory':
 
2511
                for name, child in entry.sorted_children():
 
2512
                    dirblock.append((relroot + name, name, child.kind, None,
 
2513
                        child.file_id, child.kind
 
2514
                        ))
 
2515
            yield (currentdir[0], entry.file_id), dirblock
 
2516
            # push the user specified dirs from dirblock
 
2517
            for dir in reversed(dirblock):
 
2518
                if dir[2] == _directory:
 
2519
                    pending.append(dir)
 
2520
 
 
2521
    @needs_tree_write_lock
 
2522
    def auto_resolve(self):
 
2523
        """Automatically resolve text conflicts according to contents.
 
2524
 
 
2525
        Only text conflicts are auto_resolvable. Files with no conflict markers
 
2526
        are considered 'resolved', because bzr always puts conflict markers
 
2527
        into files that have text conflicts.  The corresponding .THIS .BASE and
 
2528
        .OTHER files are deleted, as per 'resolve'.
 
2529
        :return: a tuple of ConflictLists: (un_resolved, resolved).
 
2530
        """
 
2531
        un_resolved = _mod_conflicts.ConflictList()
 
2532
        resolved = _mod_conflicts.ConflictList()
 
2533
        conflict_re = re.compile('^(<{7}|={7}|>{7})')
 
2534
        for conflict in self.conflicts():
 
2535
            if (conflict.typestring != 'text conflict' or
 
2536
                self.kind(conflict.file_id) != 'file'):
 
2537
                un_resolved.append(conflict)
 
2538
                continue
 
2539
            my_file = open(self.id2abspath(conflict.file_id), 'rb')
 
2540
            try:
 
2541
                for line in my_file:
 
2542
                    if conflict_re.search(line):
 
2543
                        un_resolved.append(conflict)
 
2544
                        break
 
2545
                else:
 
2546
                    resolved.append(conflict)
 
2547
            finally:
 
2548
                my_file.close()
 
2549
        resolved.remove_files(self)
 
2550
        self.set_conflicts(un_resolved)
 
2551
        return un_resolved, resolved
 
2552
 
 
2553
    @needs_read_lock
 
2554
    def _check(self, references):
 
2555
        """Check the tree for consistency.
 
2556
 
 
2557
        :param references: A dict with keys matching the items returned by
 
2558
            self._get_check_refs(), and values from looking those keys up in
 
2559
            the repository.
 
2560
        """
 
2561
        tree_basis = self.basis_tree()
 
2562
        tree_basis.lock_read()
 
2563
        try:
 
2564
            repo_basis = references[('trees', self.last_revision())]
 
2565
            if len(list(repo_basis.iter_changes(tree_basis))) > 0:
 
2566
                raise errors.BzrCheckError(
 
2567
                    "Mismatched basis inventory content.")
 
2568
            self._validate()
 
2569
        finally:
 
2570
            tree_basis.unlock()
 
2571
 
 
2572
    def _validate(self):
 
2573
        """Validate internal structures.
 
2574
 
 
2575
        This is meant mostly for the test suite. To give it a chance to detect
 
2576
        corruption after actions have occurred. The default implementation is a
 
2577
        just a no-op.
 
2578
 
 
2579
        :return: None. An exception should be raised if there is an error.
 
2580
        """
 
2581
        return
 
2582
 
 
2583
    @needs_read_lock
 
2584
    def _get_rules_searcher(self, default_searcher):
 
2585
        """See Tree._get_rules_searcher."""
 
2586
        if self._rules_searcher is None:
 
2587
            self._rules_searcher = super(WorkingTree,
 
2588
                self)._get_rules_searcher(default_searcher)
 
2589
        return self._rules_searcher
 
2590
 
 
2591
    def get_shelf_manager(self):
 
2592
        """Return the ShelfManager for this WorkingTree."""
 
2593
        from bzrlib.shelf import ShelfManager
 
2594
        return ShelfManager(self, self._transport)
 
2595
 
1797
2596
 
1798
2597
class WorkingTree2(WorkingTree):
1799
2598
    """This is the Format 2 working tree.
1800
2599
 
1801
 
    This was the first weave based working tree. 
 
2600
    This was the first weave based working tree.
1802
2601
     - uses os locks for locking.
1803
2602
     - uses the branch last-revision.
1804
2603
    """
1805
2604
 
 
2605
    def __init__(self, *args, **kwargs):
 
2606
        super(WorkingTree2, self).__init__(*args, **kwargs)
 
2607
        # WorkingTree2 has more of a constraint that self._inventory must
 
2608
        # exist. Because this is an older format, we don't mind the overhead
 
2609
        # caused by the extra computation here.
 
2610
 
 
2611
        # Newer WorkingTree's should only have self._inventory set when they
 
2612
        # have a read lock.
 
2613
        if self._inventory is None:
 
2614
            self.read_working_inventory()
 
2615
 
 
2616
    def _get_check_refs(self):
 
2617
        """Return the references needed to perform a check of this tree."""
 
2618
        return [('trees', self.last_revision())]
 
2619
 
1806
2620
    def lock_tree_write(self):
1807
2621
        """See WorkingTree.lock_tree_write().
1808
2622
 
1817
2631
            raise
1818
2632
 
1819
2633
    def unlock(self):
 
2634
        # do non-implementation specific cleanup
 
2635
        self._cleanup()
 
2636
 
1820
2637
        # we share control files:
1821
2638
        if self._control_files._lock_count == 3:
1822
2639
            # _inventory_is_modified is always False during a read lock.
1823
2640
            if self._inventory_is_modified:
1824
2641
                self.flush()
1825
 
            if self._hashcache.needs_write:
1826
 
                self._hashcache.write()
 
2642
            self._write_hashcache_if_dirty()
 
2643
 
1827
2644
        # reverse order of locking.
1828
2645
        try:
1829
2646
            return self._control_files.unlock()
1845
2662
    def _last_revision(self):
1846
2663
        """See Mutable.last_revision."""
1847
2664
        try:
1848
 
            return self._control_files.get_utf8('last-revision').read()
1849
 
        except NoSuchFile:
1850
 
            return None
 
2665
            return self._transport.get_bytes('last-revision')
 
2666
        except errors.NoSuchFile:
 
2667
            return _mod_revision.NULL_REVISION
1851
2668
 
1852
2669
    def _change_last_revision(self, revision_id):
1853
2670
        """See WorkingTree._change_last_revision."""
1854
 
        if revision_id is None or revision_id == NULL_REVISION:
 
2671
        if revision_id is None or revision_id == _mod_revision.NULL_REVISION:
1855
2672
            try:
1856
 
                self._control_files._transport.delete('last-revision')
 
2673
                self._transport.delete('last-revision')
1857
2674
            except errors.NoSuchFile:
1858
2675
                pass
1859
2676
            return False
1860
2677
        else:
1861
 
            self._control_files.put_utf8('last-revision', revision_id)
 
2678
            self._transport.put_bytes('last-revision', revision_id,
 
2679
                mode=self.bzrdir._get_file_mode())
1862
2680
            return True
1863
2681
 
 
2682
    def _get_check_refs(self):
 
2683
        """Return the references needed to perform a check of this tree."""
 
2684
        return [('trees', self.last_revision())]
 
2685
 
1864
2686
    @needs_tree_write_lock
1865
2687
    def set_conflicts(self, conflicts):
1866
 
        self._put_rio('conflicts', conflicts.to_stanzas(), 
 
2688
        self._put_rio('conflicts', conflicts.to_stanzas(),
1867
2689
                      CONFLICT_HEADER_1)
1868
2690
 
1869
2691
    @needs_tree_write_lock
1876
2698
    @needs_read_lock
1877
2699
    def conflicts(self):
1878
2700
        try:
1879
 
            confile = self._control_files.get('conflicts')
1880
 
        except NoSuchFile:
 
2701
            confile = self._transport.get('conflicts')
 
2702
        except errors.NoSuchFile:
1881
2703
            return _mod_conflicts.ConflictList()
1882
2704
        try:
1883
 
            if confile.next() != CONFLICT_HEADER_1 + '\n':
1884
 
                raise ConflictFormatError()
1885
 
        except StopIteration:
1886
 
            raise ConflictFormatError()
1887
 
        return _mod_conflicts.ConflictList.from_stanzas(RioReader(confile))
 
2705
            try:
 
2706
                if confile.next() != CONFLICT_HEADER_1 + '\n':
 
2707
                    raise errors.ConflictFormatError()
 
2708
            except StopIteration:
 
2709
                raise errors.ConflictFormatError()
 
2710
            return _mod_conflicts.ConflictList.from_stanzas(RioReader(confile))
 
2711
        finally:
 
2712
            confile.close()
1888
2713
 
1889
2714
    def unlock(self):
 
2715
        # do non-implementation specific cleanup
 
2716
        self._cleanup()
1890
2717
        if self._control_files._lock_count == 1:
1891
2718
            # _inventory_is_modified is always False during a read lock.
1892
2719
            if self._inventory_is_modified:
1893
2720
                self.flush()
1894
 
            if self._hashcache.needs_write:
1895
 
                self._hashcache.write()
 
2721
            self._write_hashcache_if_dirty()
1896
2722
        # reverse order of locking.
1897
2723
        try:
1898
2724
            return self._control_files.unlock()
1905
2731
        if path.endswith(suffix):
1906
2732
            return path[:-len(suffix)]
1907
2733
 
1908
 
@deprecated_function(zero_eight)
1909
 
def is_control_file(filename):
1910
 
    """See WorkingTree.is_control_filename(filename)."""
1911
 
    ## FIXME: better check
1912
 
    filename = normpath(filename)
1913
 
    while filename != '':
1914
 
        head, tail = os.path.split(filename)
1915
 
        ## mutter('check %r for control file' % ((head, tail),))
1916
 
        if tail == '.bzr':
1917
 
            return True
1918
 
        if filename == head:
1919
 
            break
1920
 
        filename = head
1921
 
    return False
1922
 
 
1923
2734
 
1924
2735
class WorkingTreeFormat(object):
1925
2736
    """An encapsulation of the initialization and open routines for a format.
1929
2740
     * a format string,
1930
2741
     * an open routine.
1931
2742
 
1932
 
    Formats are placed in an dict by their format string for reference 
 
2743
    Formats are placed in an dict by their format string for reference
1933
2744
    during workingtree opening. Its not required that these be instances, they
1934
 
    can be classes themselves with class methods - it simply depends on 
 
2745
    can be classes themselves with class methods - it simply depends on
1935
2746
    whether state is needed for a given format or not.
1936
2747
 
1937
2748
    Once a format is deprecated, just deprecate the initialize and open
1938
 
    methods on the format class. Do not deprecate the object, as the 
 
2749
    methods on the format class. Do not deprecate the object, as the
1939
2750
    object will be created every time regardless.
1940
2751
    """
1941
2752
 
1945
2756
    _formats = {}
1946
2757
    """The known formats."""
1947
2758
 
 
2759
    requires_rich_root = False
 
2760
 
 
2761
    upgrade_recommended = False
 
2762
 
1948
2763
    @classmethod
1949
2764
    def find_format(klass, a_bzrdir):
1950
2765
        """Return the format for the working tree object in a_bzrdir."""
1952
2767
            transport = a_bzrdir.get_workingtree_transport(None)
1953
2768
            format_string = transport.get("format").read()
1954
2769
            return klass._formats[format_string]
1955
 
        except NoSuchFile:
 
2770
        except errors.NoSuchFile:
1956
2771
            raise errors.NoWorkingTree(base=transport.base)
1957
2772
        except KeyError:
1958
 
            raise errors.UnknownFormatError(format=format_string)
 
2773
            raise errors.UnknownFormatError(format=format_string,
 
2774
                                            kind="working tree")
 
2775
 
 
2776
    def __eq__(self, other):
 
2777
        return self.__class__ is other.__class__
 
2778
 
 
2779
    def __ne__(self, other):
 
2780
        return not (self == other)
1959
2781
 
1960
2782
    @classmethod
1961
2783
    def get_default_format(klass):
1974
2796
        """Is this format supported?
1975
2797
 
1976
2798
        Supported formats can be initialized and opened.
1977
 
        Unsupported formats may not support initialization or committing or 
 
2799
        Unsupported formats may not support initialization or committing or
1978
2800
        some other features depending on the reason for not being supported.
1979
2801
        """
1980
2802
        return True
1981
2803
 
 
2804
    def supports_content_filtering(self):
 
2805
        """True if this format supports content filtering."""
 
2806
        return False
 
2807
 
 
2808
    def supports_views(self):
 
2809
        """True if this format supports stored views."""
 
2810
        return False
 
2811
 
1982
2812
    @classmethod
1983
2813
    def register_format(klass, format):
1984
2814
        klass._formats[format.get_format_string()] = format
1989
2819
 
1990
2820
    @classmethod
1991
2821
    def unregister_format(klass, format):
1992
 
        assert klass._formats[format.get_format_string()] is format
1993
2822
        del klass._formats[format.get_format_string()]
1994
2823
 
1995
2824
 
1996
 
 
1997
2825
class WorkingTreeFormat2(WorkingTreeFormat):
1998
 
    """The second working tree format. 
 
2826
    """The second working tree format.
1999
2827
 
2000
2828
    This format modified the hash cache from the format 1 hash cache.
2001
2829
    """
2002
2830
 
 
2831
    upgrade_recommended = True
 
2832
 
2003
2833
    def get_format_description(self):
2004
2834
        """See WorkingTreeFormat.get_format_description()."""
2005
2835
        return "Working tree format 2"
2006
2836
 
2007
 
    def stub_initialize_remote(self, control_files):
2008
 
        """As a special workaround create critical control files for a remote working tree
2009
 
        
 
2837
    def _stub_initialize_on_transport(self, transport, file_mode):
 
2838
        """Workaround: create control files for a remote working tree.
 
2839
 
2010
2840
        This ensures that it can later be updated and dealt with locally,
2011
 
        since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with 
 
2841
        since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
2012
2842
        no working tree.  (See bug #43064).
2013
2843
        """
2014
2844
        sio = StringIO()
2015
 
        inv = Inventory()
2016
 
        xml5.serializer_v5.write_inventory(inv, sio)
 
2845
        inv = inventory.Inventory()
 
2846
        xml5.serializer_v5.write_inventory(inv, sio, working=True)
2017
2847
        sio.seek(0)
2018
 
        control_files.put('inventory', sio)
2019
 
 
2020
 
        control_files.put_utf8('pending-merges', '')
2021
 
        
2022
 
 
2023
 
    def initialize(self, a_bzrdir, revision_id=None):
 
2848
        transport.put_file('inventory', sio, file_mode)
 
2849
        transport.put_bytes('pending-merges', '', file_mode)
 
2850
 
 
2851
    def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
 
2852
                   accelerator_tree=None, hardlink=False):
2024
2853
        """See WorkingTreeFormat.initialize()."""
2025
2854
        if not isinstance(a_bzrdir.transport, LocalTransport):
2026
2855
            raise errors.NotLocalUrl(a_bzrdir.transport.base)
2027
 
        branch = a_bzrdir.open_branch()
2028
 
        if revision_id is not None:
2029
 
            branch.lock_write()
2030
 
            try:
2031
 
                revision_history = branch.revision_history()
2032
 
                try:
2033
 
                    position = revision_history.index(revision_id)
2034
 
                except ValueError:
2035
 
                    raise errors.NoSuchRevision(branch, revision_id)
2036
 
                branch.set_revision_history(revision_history[:position + 1])
2037
 
            finally:
2038
 
                branch.unlock()
2039
 
        revision = branch.last_revision()
2040
 
        inv = Inventory()
 
2856
        if from_branch is not None:
 
2857
            branch = from_branch
 
2858
        else:
 
2859
            branch = a_bzrdir.open_branch()
 
2860
        if revision_id is None:
 
2861
            revision_id = _mod_revision.ensure_null(branch.last_revision())
 
2862
        branch.lock_write()
 
2863
        try:
 
2864
            branch.generate_revision_history(revision_id)
 
2865
        finally:
 
2866
            branch.unlock()
 
2867
        inv = inventory.Inventory()
2041
2868
        wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2042
2869
                         branch,
2043
2870
                         inv,
2044
2871
                         _internal=True,
2045
2872
                         _format=self,
2046
2873
                         _bzrdir=a_bzrdir)
2047
 
        basis_tree = branch.repository.revision_tree(revision)
 
2874
        basis_tree = branch.repository.revision_tree(revision_id)
2048
2875
        if basis_tree.inventory.root is not None:
2049
 
            wt.set_root_id(basis_tree.inventory.root.file_id)
 
2876
            wt.set_root_id(basis_tree.get_root_id())
2050
2877
        # set the parent list and cache the basis tree.
2051
 
        wt.set_parent_trees([(revision, basis_tree)])
 
2878
        if _mod_revision.is_null(revision_id):
 
2879
            parent_trees = []
 
2880
        else:
 
2881
            parent_trees = [(revision_id, basis_tree)]
 
2882
        wt.set_parent_trees(parent_trees)
2052
2883
        transform.build_tree(basis_tree, wt)
2053
2884
        return wt
2054
2885
 
2067
2898
            raise NotImplementedError
2068
2899
        if not isinstance(a_bzrdir.transport, LocalTransport):
2069
2900
            raise errors.NotLocalUrl(a_bzrdir.transport.base)
2070
 
        return WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
 
2901
        wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2071
2902
                           _internal=True,
2072
2903
                           _format=self,
2073
2904
                           _bzrdir=a_bzrdir)
2074
 
 
 
2905
        return wt
2075
2906
 
2076
2907
class WorkingTreeFormat3(WorkingTreeFormat):
2077
2908
    """The second working tree format updated to record a format marker.
2085
2916
        - uses a LockDir to guard access for writes.
2086
2917
    """
2087
2918
 
 
2919
    upgrade_recommended = True
 
2920
 
2088
2921
    def get_format_string(self):
2089
2922
        """See WorkingTreeFormat.get_format_string()."""
2090
2923
        return "Bazaar-NG Working Tree format 3"
2096
2929
    _lock_file_name = 'lock'
2097
2930
    _lock_class = LockDir
2098
2931
 
 
2932
    _tree_class = WorkingTree3
 
2933
 
 
2934
    def __get_matchingbzrdir(self):
 
2935
        return bzrdir.BzrDirMetaFormat1()
 
2936
 
 
2937
    _matchingbzrdir = property(__get_matchingbzrdir)
 
2938
 
2099
2939
    def _open_control_files(self, a_bzrdir):
2100
2940
        transport = a_bzrdir.get_workingtree_transport(None)
2101
 
        return LockableFiles(transport, self._lock_file_name, 
 
2941
        return LockableFiles(transport, self._lock_file_name,
2102
2942
                             self._lock_class)
2103
2943
 
2104
 
    def initialize(self, a_bzrdir, revision_id=None):
 
2944
    def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
 
2945
                   accelerator_tree=None, hardlink=False):
2105
2946
        """See WorkingTreeFormat.initialize().
2106
 
        
2107
 
        revision_id allows creating a working tree at a different
2108
 
        revision than the branch is at.
 
2947
 
 
2948
        :param revision_id: if supplied, create a working tree at a different
 
2949
            revision than the branch is at.
 
2950
        :param accelerator_tree: A tree which can be used for retrieving file
 
2951
            contents more quickly than the revision tree, i.e. a workingtree.
 
2952
            The revision tree will be used for cases where accelerator_tree's
 
2953
            content is different.
 
2954
        :param hardlink: If true, hard-link files from accelerator_tree,
 
2955
            where possible.
2109
2956
        """
2110
2957
        if not isinstance(a_bzrdir.transport, LocalTransport):
2111
2958
            raise errors.NotLocalUrl(a_bzrdir.transport.base)
2113
2960
        control_files = self._open_control_files(a_bzrdir)
2114
2961
        control_files.create_lock()
2115
2962
        control_files.lock_write()
2116
 
        control_files.put_utf8('format', self.get_format_string())
2117
 
        branch = a_bzrdir.open_branch()
 
2963
        transport.put_bytes('format', self.get_format_string(),
 
2964
            mode=a_bzrdir._get_file_mode())
 
2965
        if from_branch is not None:
 
2966
            branch = from_branch
 
2967
        else:
 
2968
            branch = a_bzrdir.open_branch()
2118
2969
        if revision_id is None:
2119
 
            revision_id = branch.last_revision()
 
2970
            revision_id = _mod_revision.ensure_null(branch.last_revision())
2120
2971
        # WorkingTree3 can handle an inventory which has a unique root id.
2121
2972
        # as of bzr 0.12. However, bzr 0.11 and earlier fail to handle
2122
2973
        # those trees. And because there isn't a format bump inbetween, we
2123
2974
        # are maintaining compatibility with older clients.
2124
2975
        # inv = Inventory(root_id=gen_root_id())
2125
 
        inv = Inventory()
2126
 
        wt = WorkingTree3(a_bzrdir.root_transport.local_abspath('.'),
 
2976
        inv = self._initial_inventory()
 
2977
        wt = self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
2127
2978
                         branch,
2128
2979
                         inv,
2129
2980
                         _internal=True,
2135
2986
            basis_tree = branch.repository.revision_tree(revision_id)
2136
2987
            # only set an explicit root id if there is one to set.
2137
2988
            if basis_tree.inventory.root is not None:
2138
 
                wt.set_root_id(basis_tree.inventory.root.file_id)
2139
 
            if revision_id == NULL_REVISION:
 
2989
                wt.set_root_id(basis_tree.get_root_id())
 
2990
            if revision_id == _mod_revision.NULL_REVISION:
2140
2991
                wt.set_parent_trees([])
2141
2992
            else:
2142
2993
                wt.set_parent_trees([(revision_id, basis_tree)])
2148
2999
            wt.unlock()
2149
3000
        return wt
2150
3001
 
 
3002
    def _initial_inventory(self):
 
3003
        return inventory.Inventory()
 
3004
 
2151
3005
    def __init__(self):
2152
3006
        super(WorkingTreeFormat3, self).__init__()
2153
 
        self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
2154
3007
 
2155
3008
    def open(self, a_bzrdir, _found=False):
2156
3009
        """Return the WorkingTree object for a_bzrdir
2163
3016
            raise NotImplementedError
2164
3017
        if not isinstance(a_bzrdir.transport, LocalTransport):
2165
3018
            raise errors.NotLocalUrl(a_bzrdir.transport.base)
2166
 
        return self._open(a_bzrdir, self._open_control_files(a_bzrdir))
 
3019
        wt = self._open(a_bzrdir, self._open_control_files(a_bzrdir))
 
3020
        return wt
2167
3021
 
2168
3022
    def _open(self, a_bzrdir, control_files):
2169
3023
        """Open the tree itself.
2170
 
        
 
3024
 
2171
3025
        :param a_bzrdir: the dir for the tree.
2172
3026
        :param control_files: the control files for the tree.
2173
3027
        """
2174
 
        return WorkingTree3(a_bzrdir.root_transport.local_abspath('.'),
2175
 
                           _internal=True,
2176
 
                           _format=self,
2177
 
                           _bzrdir=a_bzrdir,
2178
 
                           _control_files=control_files)
 
3028
        return self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
 
3029
                                _internal=True,
 
3030
                                _format=self,
 
3031
                                _bzrdir=a_bzrdir,
 
3032
                                _control_files=control_files)
2179
3033
 
2180
3034
    def __str__(self):
2181
3035
        return self.get_format_string()
2182
3036
 
2183
3037
 
 
3038
__default_format = WorkingTreeFormat6()
 
3039
WorkingTreeFormat.register_format(__default_format)
 
3040
WorkingTreeFormat.register_format(WorkingTreeFormat5())
 
3041
WorkingTreeFormat.register_format(WorkingTreeFormat4())
 
3042
WorkingTreeFormat.register_format(WorkingTreeFormat3())
 
3043
WorkingTreeFormat.set_default_format(__default_format)
2184
3044
# formats which have no format string are not discoverable
2185
3045
# and not independently creatable, so are not registered.
2186
 
__default_format = WorkingTreeFormat3()
2187
 
WorkingTreeFormat.register_format(__default_format)
2188
 
WorkingTreeFormat.set_default_format(__default_format)
2189
3046
_legacy_formats = [WorkingTreeFormat2(),
2190
3047
                   ]
2191
 
 
2192
 
 
2193
 
class WorkingTreeTestProviderAdapter(object):
2194
 
    """A tool to generate a suite testing multiple workingtree formats at once.
2195
 
 
2196
 
    This is done by copying the test once for each transport and injecting
2197
 
    the transport_server, transport_readonly_server, and workingtree_format
2198
 
    classes into each copy. Each copy is also given a new id() to make it
2199
 
    easy to identify.
2200
 
    """
2201
 
 
2202
 
    def __init__(self, transport_server, transport_readonly_server, formats):
2203
 
        self._transport_server = transport_server
2204
 
        self._transport_readonly_server = transport_readonly_server
2205
 
        self._formats = formats
2206
 
    
2207
 
    def _clone_test(self, test, bzrdir_format, workingtree_format, variation):
2208
 
        """Clone test for adaption."""
2209
 
        new_test = deepcopy(test)
2210
 
        new_test.transport_server = self._transport_server
2211
 
        new_test.transport_readonly_server = self._transport_readonly_server
2212
 
        new_test.bzrdir_format = bzrdir_format
2213
 
        new_test.workingtree_format = workingtree_format
2214
 
        def make_new_test_id():
2215
 
            new_id = "%s(%s)" % (test.id(), variation)
2216
 
            return lambda: new_id
2217
 
        new_test.id = make_new_test_id()
2218
 
        return new_test
2219
 
    
2220
 
    def adapt(self, test):
2221
 
        from bzrlib.tests import TestSuite
2222
 
        result = TestSuite()
2223
 
        for workingtree_format, bzrdir_format in self._formats:
2224
 
            new_test = self._clone_test(
2225
 
                test,
2226
 
                bzrdir_format,
2227
 
                workingtree_format, workingtree_format.__class__.__name__)
2228
 
            result.addTest(new_test)
2229
 
        return result