/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to bzrlib/workingtree.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2007-10-17 05:59:11 UTC
  • mfrom: (2903.2.11 commit)
  • Revision ID: pqm@pqm.ubuntu.com-20071017055911-jots6fwy20740n0i
commit produces (but does not yet use) a basis delta and avoids one iter_entries (mbp)

Show diffs side-by-side

added added

removed removed

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