/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-09-17 23:11:44 UTC
  • mfrom: (2825.2.1 misc-fixen)
  • Revision ID: pqm@pqm.ubuntu.com-20070917231144-u7uxe56m03v95chg
(robertc) Micro-tweaks to sha routines. (Robert Collins)

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
            file_id = osutils.safe_file_id(file_id)
 
457
            path = self.id2path(file_id)
 
458
        return self.get_file_byname(path)
 
459
 
 
460
    def get_file_text(self, file_id):
 
461
        file_id = osutils.safe_file_id(file_id)
 
462
        return self.get_file(file_id).read()
416
463
 
417
464
    def get_file_byname(self, filename):
418
465
        return file(self.abspath(filename), 'rb')
419
466
 
 
467
    @needs_read_lock
 
468
    def annotate_iter(self, file_id, default_revision=CURRENT_REVISION):
 
469
        """See Tree.annotate_iter
 
470
 
 
471
        This implementation will use the basis tree implementation if possible.
 
472
        Lines not in the basis are attributed to CURRENT_REVISION
 
473
 
 
474
        If there are pending merges, lines added by those merges will be
 
475
        incorrectly attributed to CURRENT_REVISION (but after committing, the
 
476
        attribution will be correct).
 
477
        """
 
478
        file_id = osutils.safe_file_id(file_id)
 
479
        basis = self.basis_tree()
 
480
        basis.lock_read()
 
481
        try:
 
482
            changes = self._iter_changes(basis, True, [self.id2path(file_id)],
 
483
                require_versioned=True).next()
 
484
            changed_content, kind = changes[2], changes[6]
 
485
            if not changed_content:
 
486
                return basis.annotate_iter(file_id)
 
487
            if kind[1] is None:
 
488
                return None
 
489
            import annotate
 
490
            if kind[0] != 'file':
 
491
                old_lines = []
 
492
            else:
 
493
                old_lines = list(basis.annotate_iter(file_id))
 
494
            old = [old_lines]
 
495
            for tree in self.branch.repository.revision_trees(
 
496
                self.get_parent_ids()[1:]):
 
497
                if file_id not in tree:
 
498
                    continue
 
499
                old.append(list(tree.annotate_iter(file_id)))
 
500
            return annotate.reannotate(old, self.get_file(file_id).readlines(),
 
501
                                       default_revision)
 
502
        finally:
 
503
            basis.unlock()
 
504
 
 
505
    def _get_ancestors(self, default_revision):
 
506
        ancestors = set([default_revision])
 
507
        for parent_id in self.get_parent_ids():
 
508
            ancestors.update(self.branch.repository.get_ancestry(
 
509
                             parent_id, topo_sorted=False))
 
510
        return ancestors
 
511
 
 
512
    def get_parent_ids(self):
 
513
        """See Tree.get_parent_ids.
 
514
        
 
515
        This implementation reads the pending merges list and last_revision
 
516
        value and uses that to decide what the parents list should be.
 
517
        """
 
518
        last_rev = _mod_revision.ensure_null(self._last_revision())
 
519
        if _mod_revision.NULL_REVISION == last_rev:
 
520
            parents = []
 
521
        else:
 
522
            parents = [last_rev]
 
523
        try:
 
524
            merges_file = self._control_files.get('pending-merges')
 
525
        except errors.NoSuchFile:
 
526
            pass
 
527
        else:
 
528
            for l in merges_file.readlines():
 
529
                revision_id = osutils.safe_revision_id(l.rstrip('\n'))
 
530
                parents.append(revision_id)
 
531
        return parents
 
532
 
 
533
    @needs_read_lock
420
534
    def get_root_id(self):
421
535
        """Return the id of this trees root"""
422
 
        inv = self.read_working_inventory()
423
 
        return inv.root.file_id
 
536
        return self._inventory.root.file_id
424
537
        
425
538
    def _get_store_filename(self, file_id):
426
539
        ## XXX: badly named; this is not in the store at all
 
540
        file_id = osutils.safe_file_id(file_id)
427
541
        return self.abspath(self.id2path(file_id))
428
542
 
429
543
    @needs_read_lock
430
 
    def clone(self, to_bzrdir, revision_id=None, basis=None):
 
544
    def clone(self, to_bzrdir, revision_id=None):
431
545
        """Duplicate this working tree into to_bzr, including all state.
432
546
        
433
547
        Specifically modified files are kept as modified, but
439
553
            If not None, the cloned tree will have its last revision set to 
440
554
            revision, and and difference between the source trees last revision
441
555
            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
556
        """
447
557
        # assumes the target bzr dir format is compatible.
448
558
        result = self._format.initialize(to_bzrdir)
452
562
    @needs_read_lock
453
563
    def copy_content_into(self, tree, revision_id=None):
454
564
        """Copy the current content and user files of this tree into tree."""
 
565
        tree.set_root_id(self.get_root_id())
455
566
        if revision_id is None:
456
 
            transform_tree(tree, self)
 
567
            merge.transform_tree(tree, self)
457
568
        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())
 
569
            # TODO now merge from tree.last_revision to revision (to preserve
 
570
            # user local changes)
 
571
            merge.transform_tree(tree, self)
 
572
            tree.set_parent_ids([revision_id])
476
573
 
477
574
    def id2abspath(self, file_id):
 
575
        file_id = osutils.safe_file_id(file_id)
478
576
        return self.abspath(self.id2path(file_id))
479
577
 
480
578
    def has_id(self, file_id):
481
579
        # files that have been deleted are excluded
482
 
        inv = self._inventory
 
580
        file_id = osutils.safe_file_id(file_id)
 
581
        inv = self.inventory
483
582
        if not inv.has_id(file_id):
484
583
            return False
485
584
        path = inv.id2path(file_id)
486
 
        return bzrlib.osutils.lexists(self.abspath(path))
 
585
        return osutils.lexists(self.abspath(path))
487
586
 
488
587
    def has_or_had_id(self, file_id):
 
588
        file_id = osutils.safe_file_id(file_id)
489
589
        if file_id == self.inventory.root.file_id:
490
590
            return True
491
591
        return self.inventory.has_id(file_id)
493
593
    __contains__ = has_id
494
594
 
495
595
    def get_file_size(self, file_id):
 
596
        file_id = osutils.safe_file_id(file_id)
496
597
        return os.path.getsize(self.id2abspath(file_id))
497
598
 
498
599
    @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():
 
600
    def get_file_sha1(self, file_id, path=None, stat_value=None):
 
601
        file_id = osutils.safe_file_id(file_id)
 
602
        if not path:
 
603
            path = self._inventory.id2path(file_id)
 
604
        return self._hashcache.get_sha1(path, stat_value)
 
605
 
 
606
    def get_file_mtime(self, file_id, path=None):
 
607
        file_id = osutils.safe_file_id(file_id)
 
608
        if not path:
 
609
            path = self.inventory.id2path(file_id)
 
610
        return os.lstat(self.abspath(path)).st_mtime
 
611
 
 
612
    if not supports_executable():
 
613
        def is_executable(self, file_id, path=None):
 
614
            file_id = osutils.safe_file_id(file_id)
505
615
            return self._inventory[file_id].executable
506
 
        else:
507
 
            path = self._inventory.id2path(file_id)
 
616
    else:
 
617
        def is_executable(self, file_id, path=None):
 
618
            if not path:
 
619
                file_id = osutils.safe_file_id(file_id)
 
620
                path = self.id2path(file_id)
508
621
            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
 
        """
 
622
            return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
 
623
 
 
624
    @needs_tree_write_lock
 
625
    def _add(self, files, ids, kinds):
 
626
        """See MutableTree._add."""
534
627
        # TODO: Re-adding a file that is removed in the working copy
535
628
        # 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
 
 
 
629
        # the read and write working inventory should not occur in this 
 
630
        # function - they should be part of lock_write and unlock.
 
631
        inv = self.inventory
 
632
        for f, file_id, kind in zip(files, ids, kinds):
 
633
            assert kind is not None
571
634
            if file_id is None:
572
 
                file_id = gen_file_id(f)
573
 
            inv.add_path(f, kind=kind, file_id=file_id)
 
635
                inv.add_path(f, kind=kind)
 
636
            else:
 
637
                file_id = osutils.safe_file_id(file_id)
 
638
                inv.add_path(f, kind=kind, file_id=file_id)
 
639
            self._inventory_is_modified = True
574
640
 
575
 
            mutter("add file %s file_id:{%s} kind=%r" % (f, file_id, kind))
576
 
        self._write_inventory(inv)
 
641
    @needs_tree_write_lock
 
642
    def _gather_kinds(self, files, kinds):
 
643
        """See MutableTree._gather_kinds."""
 
644
        for pos, f in enumerate(files):
 
645
            if kinds[pos] is None:
 
646
                fullpath = normpath(self.abspath(f))
 
647
                try:
 
648
                    kinds[pos] = file_kind(fullpath)
 
649
                except OSError, e:
 
650
                    if e.errno == errno.ENOENT:
 
651
                        raise errors.NoSuchFile(fullpath)
577
652
 
578
653
    @needs_write_lock
 
654
    def add_parent_tree_id(self, revision_id, allow_leftmost_as_ghost=False):
 
655
        """Add revision_id as a parent.
 
656
 
 
657
        This is equivalent to retrieving the current list of parent ids
 
658
        and setting the list to its value plus revision_id.
 
659
 
 
660
        :param revision_id: The revision id to add to the parent list. It may
 
661
        be a ghost revision as long as its not the first parent to be added,
 
662
        or the allow_leftmost_as_ghost parameter is set True.
 
663
        :param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
 
664
        """
 
665
        parents = self.get_parent_ids() + [revision_id]
 
666
        self.set_parent_ids(parents, allow_leftmost_as_ghost=len(parents) > 1
 
667
            or allow_leftmost_as_ghost)
 
668
 
 
669
    @needs_tree_write_lock
 
670
    def add_parent_tree(self, parent_tuple, allow_leftmost_as_ghost=False):
 
671
        """Add revision_id, tree tuple as a parent.
 
672
 
 
673
        This is equivalent to retrieving the current list of parent trees
 
674
        and setting the list to its value plus parent_tuple. See also
 
675
        add_parent_tree_id - if you only have a parent id available it will be
 
676
        simpler to use that api. If you have the parent already available, using
 
677
        this api is preferred.
 
678
 
 
679
        :param parent_tuple: The (revision id, tree) to add to the parent list.
 
680
            If the revision_id is a ghost, pass None for the tree.
 
681
        :param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
 
682
        """
 
683
        parent_ids = self.get_parent_ids() + [parent_tuple[0]]
 
684
        if len(parent_ids) > 1:
 
685
            # the leftmost may have already been a ghost, preserve that if it
 
686
            # was.
 
687
            allow_leftmost_as_ghost = True
 
688
        self.set_parent_ids(parent_ids,
 
689
            allow_leftmost_as_ghost=allow_leftmost_as_ghost)
 
690
 
 
691
    @needs_tree_write_lock
579
692
    def add_pending_merge(self, *revision_ids):
580
693
        # TODO: Perhaps should check at this point that the
581
694
        # history of the revision is actually present?
582
 
        p = self.pending_merges()
 
695
        parents = self.get_parent_ids()
583
696
        updated = False
584
697
        for rev_id in revision_ids:
585
 
            if rev_id in p:
 
698
            if rev_id in parents:
586
699
                continue
587
 
            p.append(rev_id)
 
700
            parents.append(rev_id)
588
701
            updated = True
589
702
        if updated:
590
 
            self.set_pending_merges(p)
 
703
            self.set_parent_ids(parents, allow_leftmost_as_ghost=True)
591
704
 
 
705
    @deprecated_method(zero_eleven)
592
706
    @needs_read_lock
593
707
    def pending_merges(self):
594
708
        """Return a list of pending merges.
595
709
 
596
710
        These are revisions that have been merged into the working
597
711
        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
 
712
 
 
713
        As of 0.11 this is deprecated. Please see WorkingTree.get_parent_ids()
 
714
        instead - which is available on all tree objects.
 
715
        """
 
716
        return self.get_parent_ids()[1:]
 
717
 
 
718
    def _check_parents_for_ghosts(self, revision_ids, allow_leftmost_as_ghost):
 
719
        """Common ghost checking functionality from set_parent_*.
 
720
 
 
721
        This checks that the left hand-parent exists if there are any
 
722
        revisions present.
 
723
        """
 
724
        if len(revision_ids) > 0:
 
725
            leftmost_id = revision_ids[0]
 
726
            if (not allow_leftmost_as_ghost and not
 
727
                self.branch.repository.has_revision(leftmost_id)):
 
728
                raise errors.GhostRevisionUnusableHere(leftmost_id)
 
729
 
 
730
    def _set_merges_from_parent_ids(self, parent_ids):
 
731
        merges = parent_ids[1:]
 
732
        self._control_files.put_bytes('pending-merges', '\n'.join(merges))
 
733
 
 
734
    @needs_tree_write_lock
 
735
    def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
 
736
        """Set the parent ids to revision_ids.
 
737
        
 
738
        See also set_parent_trees. This api will try to retrieve the tree data
 
739
        for each element of revision_ids from the trees repository. If you have
 
740
        tree data already available, it is more efficient to use
 
741
        set_parent_trees rather than set_parent_ids. set_parent_ids is however
 
742
        an easier API to use.
 
743
 
 
744
        :param revision_ids: The revision_ids to set as the parent ids of this
 
745
            working tree. Any of these may be ghosts.
 
746
        """
 
747
        revision_ids = [osutils.safe_revision_id(r) for r in revision_ids]
 
748
        self._check_parents_for_ghosts(revision_ids,
 
749
            allow_leftmost_as_ghost=allow_leftmost_as_ghost)
 
750
        for revision_id in revision_ids:
 
751
            _mod_revision.check_not_reserved_id(revision_id)
 
752
 
 
753
        if len(revision_ids) > 0:
 
754
            self.set_last_revision(revision_ids[0])
 
755
        else:
 
756
            self.set_last_revision(_mod_revision.NULL_REVISION)
 
757
 
 
758
        self._set_merges_from_parent_ids(revision_ids)
 
759
 
 
760
    @needs_tree_write_lock
 
761
    def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
 
762
        """See MutableTree.set_parent_trees."""
 
763
        parent_ids = [osutils.safe_revision_id(rev) for (rev, tree) in parents_list]
 
764
        for revision_id in parent_ids:
 
765
            _mod_revision.check_not_reserved_id(revision_id)
 
766
 
 
767
        self._check_parents_for_ghosts(parent_ids,
 
768
            allow_leftmost_as_ghost=allow_leftmost_as_ghost)
 
769
 
 
770
        if len(parent_ids) == 0:
 
771
            leftmost_parent_id = _mod_revision.NULL_REVISION
 
772
            leftmost_parent_tree = None
 
773
        else:
 
774
            leftmost_parent_id, leftmost_parent_tree = parents_list[0]
 
775
 
 
776
        if self._change_last_revision(leftmost_parent_id):
 
777
            if leftmost_parent_tree is None:
 
778
                # If we don't have a tree, fall back to reading the
 
779
                # parent tree from the repository.
 
780
                self._cache_basis_inventory(leftmost_parent_id)
 
781
            else:
 
782
                inv = leftmost_parent_tree.inventory
 
783
                xml = self._create_basis_xml_from_inventory(
 
784
                                        leftmost_parent_id, inv)
 
785
                self._write_basis_inventory(xml)
 
786
        self._set_merges_from_parent_ids(parent_ids)
 
787
 
 
788
    @needs_tree_write_lock
611
789
    def set_pending_merges(self, rev_list):
612
 
        self._control_files.put_utf8('pending-merges', '\n'.join(rev_list))
 
790
        parents = self.get_parent_ids()
 
791
        leftmost = parents[:1]
 
792
        new_parents = leftmost + rev_list
 
793
        self.set_parent_ids(new_parents)
613
794
 
614
 
    @needs_write_lock
 
795
    @needs_tree_write_lock
615
796
    def set_merge_modified(self, modified_hashes):
616
797
        def iter_stanzas():
617
798
            for file_id, hash in modified_hashes.iteritems():
618
 
                yield Stanza(file_id=file_id, hash=hash)
 
799
                yield Stanza(file_id=file_id.decode('utf8'), hash=hash)
619
800
        self._put_rio('merge-hashes', iter_stanzas(), MERGE_MODIFIED_HEADER_1)
620
801
 
621
 
    @needs_write_lock
622
802
    def _put_rio(self, filename, stanzas, header):
 
803
        self._must_be_locked()
623
804
        my_file = rio_file(stanzas, header)
624
805
        self._control_files.put(filename, my_file)
625
806
 
 
807
    @needs_write_lock # because merge pulls data into the branch.
 
808
    def merge_from_branch(self, branch, to_revision=None, from_revision=None,
 
809
        merge_type=None):
 
810
        """Merge from a branch into this working tree.
 
811
 
 
812
        :param branch: The branch to merge from.
 
813
        :param to_revision: If non-None, the merge will merge to to_revision,
 
814
            but not beyond it. to_revision does not need to be in the history
 
815
            of the branch when it is supplied. If None, to_revision defaults to
 
816
            branch.last_revision().
 
817
        """
 
818
        from bzrlib.merge import Merger, Merge3Merger
 
819
        pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
820
        try:
 
821
            merger = Merger(self.branch, this_tree=self, pb=pb)
 
822
            merger.pp = ProgressPhase("Merge phase", 5, pb)
 
823
            merger.pp.next_phase()
 
824
            # check that there are no
 
825
            # local alterations
 
826
            merger.check_basis(check_clean=True, require_commits=False)
 
827
            if to_revision is None:
 
828
                to_revision = _mod_revision.ensure_null(branch.last_revision())
 
829
            else:
 
830
                to_revision = osutils.safe_revision_id(to_revision)
 
831
            merger.other_rev_id = to_revision
 
832
            if _mod_revision.is_null(merger.other_rev_id):
 
833
                raise errors.NoCommits(branch)
 
834
            self.branch.fetch(branch, last_revision=merger.other_rev_id)
 
835
            merger.other_basis = merger.other_rev_id
 
836
            merger.other_tree = self.branch.repository.revision_tree(
 
837
                merger.other_rev_id)
 
838
            merger.other_branch = branch
 
839
            merger.pp.next_phase()
 
840
            if from_revision is None:
 
841
                merger.find_base()
 
842
            else:
 
843
                merger.set_base_revision(from_revision, branch)
 
844
            if merger.base_rev_id == merger.other_rev_id:
 
845
                raise errors.PointlessMerge
 
846
            merger.backup_files = False
 
847
            if merge_type is None:
 
848
                merger.merge_type = Merge3Merger
 
849
            else:
 
850
                merger.merge_type = merge_type
 
851
            merger.set_interesting_files(None)
 
852
            merger.show_base = False
 
853
            merger.reprocess = False
 
854
            conflicts = merger.do_merge()
 
855
            merger.set_pending()
 
856
        finally:
 
857
            pb.finished()
 
858
        return conflicts
 
859
 
626
860
    @needs_read_lock
627
861
    def merge_modified(self):
 
862
        """Return a dictionary of files modified by a merge.
 
863
 
 
864
        The list is initialized by WorkingTree.set_merge_modified, which is 
 
865
        typically called after we make some automatic updates to the tree
 
866
        because of a merge.
 
867
 
 
868
        This returns a map of file_id->sha1, containing only files which are
 
869
        still in the working inventory and have that text hash.
 
870
        """
628
871
        try:
629
872
            hashfile = self._control_files.get('merge-hashes')
630
 
        except NoSuchFile:
 
873
        except errors.NoSuchFile:
631
874
            return {}
632
875
        merge_hashes = {}
633
876
        try:
634
877
            if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
635
 
                raise MergeModifiedFormatError()
 
878
                raise errors.MergeModifiedFormatError()
636
879
        except StopIteration:
637
 
            raise MergeModifiedFormatError()
 
880
            raise errors.MergeModifiedFormatError()
638
881
        for s in RioReader(hashfile):
639
 
            file_id = s.get("file_id")
 
882
            # RioReader reads in Unicode, so convert file_ids back to utf8
 
883
            file_id = osutils.safe_file_id(s.get("file_id"), warn=False)
640
884
            if file_id not in self.inventory:
641
885
                continue
642
 
            hash = s.get("hash")
643
 
            if hash == self.get_file_sha1(file_id):
644
 
                merge_hashes[file_id] = hash
 
886
            text_hash = s.get("hash")
 
887
            if text_hash == self.get_file_sha1(file_id):
 
888
                merge_hashes[file_id] = text_hash
645
889
        return merge_hashes
646
890
 
 
891
    @needs_write_lock
 
892
    def mkdir(self, path, file_id=None):
 
893
        """See MutableTree.mkdir()."""
 
894
        if file_id is None:
 
895
            file_id = generate_ids.gen_file_id(os.path.basename(path))
 
896
        os.mkdir(self.abspath(path))
 
897
        self.add(path, file_id, 'directory')
 
898
        return file_id
 
899
 
647
900
    def get_symlink_target(self, file_id):
 
901
        file_id = osutils.safe_file_id(file_id)
648
902
        return os.readlink(self.id2abspath(file_id))
649
903
 
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).
 
904
    @needs_write_lock
 
905
    def subsume(self, other_tree):
 
906
        def add_children(inventory, entry):
 
907
            for child_entry in entry.children.values():
 
908
                inventory._byid[child_entry.file_id] = child_entry
 
909
                if child_entry.kind == 'directory':
 
910
                    add_children(inventory, child_entry)
 
911
        if other_tree.get_root_id() == self.get_root_id():
 
912
            raise errors.BadSubsumeSource(self, other_tree,
 
913
                                          'Trees have the same root')
 
914
        try:
 
915
            other_tree_path = self.relpath(other_tree.basedir)
 
916
        except errors.PathNotChild:
 
917
            raise errors.BadSubsumeSource(self, other_tree,
 
918
                'Tree is not contained by the other')
 
919
        new_root_parent = self.path2id(osutils.dirname(other_tree_path))
 
920
        if new_root_parent is None:
 
921
            raise errors.BadSubsumeSource(self, other_tree,
 
922
                'Parent directory is not versioned.')
 
923
        # We need to ensure that the result of a fetch will have a
 
924
        # versionedfile for the other_tree root, and only fetching into
 
925
        # RepositoryKnit2 guarantees that.
 
926
        if not self.branch.repository.supports_rich_root():
 
927
            raise errors.SubsumeTargetNeedsUpgrade(other_tree)
 
928
        other_tree.lock_tree_write()
 
929
        try:
 
930
            new_parents = other_tree.get_parent_ids()
 
931
            other_root = other_tree.inventory.root
 
932
            other_root.parent_id = new_root_parent
 
933
            other_root.name = osutils.basename(other_tree_path)
 
934
            self.inventory.add(other_root)
 
935
            add_children(self.inventory, other_root)
 
936
            self._write_inventory(self.inventory)
 
937
            # normally we don't want to fetch whole repositories, but i think
 
938
            # here we really do want to consolidate the whole thing.
 
939
            for parent_id in other_tree.get_parent_ids():
 
940
                self.branch.fetch(other_tree.branch, parent_id)
 
941
                self.add_parent_tree_id(parent_id)
 
942
        finally:
 
943
            other_tree.unlock()
 
944
        other_tree.bzrdir.retire_bzrdir()
 
945
 
 
946
    @needs_tree_write_lock
 
947
    def extract(self, file_id, format=None):
 
948
        """Extract a subtree from this tree.
 
949
        
 
950
        A new branch will be created, relative to the path for this tree.
 
951
        """
 
952
        self.flush()
 
953
        def mkdirs(path):
 
954
            segments = osutils.splitpath(path)
 
955
            transport = self.branch.bzrdir.root_transport
 
956
            for name in segments:
 
957
                transport = transport.clone(name)
 
958
                transport.ensure_base()
 
959
            return transport
 
960
            
 
961
        sub_path = self.id2path(file_id)
 
962
        branch_transport = mkdirs(sub_path)
 
963
        if format is None:
 
964
            format = bzrdir.format_registry.make_bzrdir('dirstate-with-subtree')
 
965
        branch_transport.ensure_base()
 
966
        branch_bzrdir = format.initialize_on_transport(branch_transport)
 
967
        try:
 
968
            repo = branch_bzrdir.find_repository()
 
969
        except errors.NoRepositoryPresent:
 
970
            repo = branch_bzrdir.create_repository()
 
971
            assert repo.supports_rich_root()
 
972
        else:
 
973
            if not repo.supports_rich_root():
 
974
                raise errors.RootNotRich()
 
975
        new_branch = branch_bzrdir.create_branch()
 
976
        new_branch.pull(self.branch)
 
977
        for parent_id in self.get_parent_ids():
 
978
            new_branch.fetch(self.branch, parent_id)
 
979
        tree_transport = self.bzrdir.root_transport.clone(sub_path)
 
980
        if tree_transport.base != branch_transport.base:
 
981
            tree_bzrdir = format.initialize_on_transport(tree_transport)
 
982
            branch.BranchReferenceFormat().initialize(tree_bzrdir, new_branch)
 
983
        else:
 
984
            tree_bzrdir = branch_bzrdir
 
985
        wt = tree_bzrdir.create_workingtree(NULL_REVISION)
 
986
        wt.set_parent_ids(self.get_parent_ids())
 
987
        my_inv = self.inventory
 
988
        child_inv = Inventory(root_id=None)
 
989
        new_root = my_inv[file_id]
 
990
        my_inv.remove_recursive_id(file_id)
 
991
        new_root.parent_id = None
 
992
        child_inv.add(new_root)
 
993
        self._write_inventory(my_inv)
 
994
        wt._write_inventory(child_inv)
 
995
        return wt
 
996
 
 
997
    def _serialize(self, inventory, out_file):
 
998
        xml5.serializer_v5.write_inventory(self._inventory, out_file,
 
999
            working=True)
 
1000
 
 
1001
    def _deserialize(selt, in_file):
 
1002
        return xml5.serializer_v5.read_inventory(in_file)
 
1003
 
 
1004
    def flush(self):
 
1005
        """Write the in memory inventory to disk."""
 
1006
        # TODO: Maybe this should only write on dirty ?
 
1007
        if self._control_files._lock_mode != 'w':
 
1008
            raise errors.NotWriteLocked(self)
 
1009
        sio = StringIO()
 
1010
        self._serialize(self._inventory, sio)
 
1011
        sio.seek(0)
 
1012
        self._control_files.put('inventory', sio)
 
1013
        self._inventory_is_modified = False
 
1014
 
 
1015
    def _kind(self, relpath):
 
1016
        return osutils.file_kind(self.abspath(relpath))
 
1017
 
 
1018
    def list_files(self, include_root=False):
 
1019
        """Recursively list all files as (path, class, kind, id, entry).
660
1020
 
661
1021
        Lists, but does not descend into unversioned directories.
662
1022
 
665
1025
 
666
1026
        Skips the control directory.
667
1027
        """
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:
 
1028
        # list_files is an iterator, so @needs_read_lock doesn't work properly
 
1029
        # with it. So callers should be careful to always read_lock the tree.
 
1030
        if not self.is_locked():
 
1031
            raise errors.ObjectNotLocked(self)
 
1032
 
 
1033
        inv = self.inventory
 
1034
        if include_root is True:
 
1035
            yield ('', 'V', 'directory', inv.root.file_id, inv.root)
 
1036
        # Convert these into local objects to save lookup times
 
1037
        pathjoin = osutils.pathjoin
 
1038
        file_kind = self._kind
 
1039
 
 
1040
        # transport.base ends in a slash, we want the piece
 
1041
        # between the last two slashes
 
1042
        transport_base_dir = self.bzrdir.transport.base.rsplit('/', 2)[1]
 
1043
 
 
1044
        fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
 
1045
 
 
1046
        # directory file_id, relative path, absolute path, reverse sorted children
 
1047
        children = os.listdir(self.basedir)
 
1048
        children.sort()
 
1049
        # jam 20060527 The kernel sized tree seems equivalent whether we 
 
1050
        # use a deque and popleft to keep them sorted, or if we use a plain
 
1051
        # list and just reverse() them.
 
1052
        children = collections.deque(children)
 
1053
        stack = [(inv.root.file_id, u'', self.basedir, children)]
 
1054
        while stack:
 
1055
            from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
 
1056
 
 
1057
            while children:
 
1058
                f = children.popleft()
674
1059
                ## TODO: If we find a subdirectory with its own .bzr
675
1060
                ## directory, then that is a separate tree and we
676
1061
                ## should exclude it.
677
1062
 
678
1063
                # the bzrdir for this tree
679
 
                if self.bzrdir.transport.base.endswith(f + '/'):
 
1064
                if transport_base_dir == f:
680
1065
                    continue
681
1066
 
682
 
                # path within tree
683
 
                fp = appendpath(from_dir_relpath, f)
 
1067
                # we know that from_dir_relpath and from_dir_abspath never end in a slash
 
1068
                # and 'f' doesn't begin with one, we can do a string op, rather
 
1069
                # than the checks of pathjoin(), all relative paths will have an extra slash
 
1070
                # at the beginning
 
1071
                fp = from_dir_relpath + '/' + f
684
1072
 
685
1073
                # absolute path
686
 
                fap = appendpath(dp, f)
 
1074
                fap = from_dir_abspath + '/' + f
687
1075
                
688
1076
                f_ie = inv.get_child(from_dir_id, f)
689
1077
                if f_ie:
690
1078
                    c = 'V'
691
 
                elif self.is_ignored(fp):
 
1079
                elif self.is_ignored(fp[1:]):
692
1080
                    c = 'I'
693
1081
                else:
694
 
                    c = '?'
 
1082
                    # we may not have found this file, because of a unicode issue
 
1083
                    f_norm, can_access = osutils.normalized_filename(f)
 
1084
                    if f == f_norm or not can_access:
 
1085
                        # No change, so treat this file normally
 
1086
                        c = '?'
 
1087
                    else:
 
1088
                        # this file can be accessed by a normalized path
 
1089
                        # check again if it is versioned
 
1090
                        # these lines are repeated here for performance
 
1091
                        f = f_norm
 
1092
                        fp = from_dir_relpath + '/' + f
 
1093
                        fap = from_dir_abspath + '/' + f
 
1094
                        f_ie = inv.get_child(from_dir_id, f)
 
1095
                        if f_ie:
 
1096
                            c = 'V'
 
1097
                        elif self.is_ignored(fp[1:]):
 
1098
                            c = 'I'
 
1099
                        else:
 
1100
                            c = '?'
695
1101
 
696
1102
                fk = file_kind(fap)
697
1103
 
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
1104
                # make a last minute entry
705
1105
                if f_ie:
706
 
                    entry = f_ie
 
1106
                    yield fp[1:], c, fk, f_ie.file_id, f_ie
707
1107
                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()
 
1108
                    try:
 
1109
                        yield fp[1:], c, fk, None, fk_entries[fk]()
 
1110
                    except KeyError:
 
1111
                        yield fp[1:], c, fk, None, TreeEntry()
 
1112
                    continue
716
1113
                
717
 
                yield fp, c, fk, (f_ie and f_ie.file_id), entry
718
 
 
719
1114
                if fk != 'directory':
720
1115
                    continue
721
1116
 
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):
 
1117
                # But do this child first
 
1118
                new_children = os.listdir(fap)
 
1119
                new_children.sort()
 
1120
                new_children = collections.deque(new_children)
 
1121
                stack.append((f_ie.file_id, fp, fap, new_children))
 
1122
                # Break out of inner loop,
 
1123
                # so that we start outer loop with child
 
1124
                break
 
1125
            else:
 
1126
                # if we finished all children, pop it off the stack
 
1127
                stack.pop()
 
1128
 
 
1129
    @needs_tree_write_lock
 
1130
    def move(self, from_paths, to_dir=None, after=False, **kwargs):
734
1131
        """Rename files.
735
1132
 
736
 
        to_name must exist in the inventory.
 
1133
        to_dir must exist in the inventory.
737
1134
 
738
 
        If to_name exists and is a directory, the files are moved into
 
1135
        If to_dir exists and is a directory, the files are moved into
739
1136
        it, keeping their old names.  
740
1137
 
741
 
        Note that to_name is only the last component of the new name;
 
1138
        Note that to_dir is only the last component of the new name;
742
1139
        this doesn't change the directory.
743
1140
 
 
1141
        For each entry in from_paths the move mode will be determined
 
1142
        independently.
 
1143
 
 
1144
        The first mode moves the file in the filesystem and updates the
 
1145
        inventory. The second mode only updates the inventory without
 
1146
        touching the file on the filesystem. This is the new mode introduced
 
1147
        in version 0.15.
 
1148
 
 
1149
        move uses the second mode if 'after == True' and the target is not
 
1150
        versioned but present in the working tree.
 
1151
 
 
1152
        move uses the second mode if 'after == False' and the source is
 
1153
        versioned but no longer in the working tree, and the target is not
 
1154
        versioned but present in the working tree.
 
1155
 
 
1156
        move uses the first mode if 'after == False' and the source is
 
1157
        versioned and present in the working tree, and the target is not
 
1158
        versioned and not present in the working tree.
 
1159
 
 
1160
        Everything else results in an error.
 
1161
 
744
1162
        This returns a list of (from_path, to_path) pairs for each
745
1163
        entry that is moved.
746
1164
        """
747
 
        result = []
748
 
        ## TODO: Option to move IDs only
 
1165
        rename_entries = []
 
1166
        rename_tuples = []
 
1167
 
 
1168
        # check for deprecated use of signature
 
1169
        if to_dir is None:
 
1170
            to_dir = kwargs.get('to_name', None)
 
1171
            if to_dir is None:
 
1172
                raise TypeError('You must supply a target directory')
 
1173
            else:
 
1174
                symbol_versioning.warn('The parameter to_name was deprecated'
 
1175
                                       ' in version 0.13. Use to_dir instead',
 
1176
                                       DeprecationWarning)
 
1177
 
 
1178
        # check destination directory
749
1179
        assert not isinstance(from_paths, basestring)
750
1180
        inv = self.inventory
751
 
        to_abs = self.abspath(to_name)
 
1181
        to_abs = self.abspath(to_dir)
752
1182
        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)
 
1183
            raise errors.BzrMoveFailedError('',to_dir,
 
1184
                errors.NotADirectory(to_abs))
 
1185
        if not self.has_filename(to_dir):
 
1186
            raise errors.BzrMoveFailedError('',to_dir,
 
1187
                errors.NotInWorkingDirectory(to_dir))
 
1188
        to_dir_id = inv.path2id(to_dir)
 
1189
        if to_dir_id is None:
 
1190
            raise errors.BzrMoveFailedError('',to_dir,
 
1191
                errors.NotVersionedError(path=str(to_dir)))
 
1192
 
759
1193
        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)
 
1194
        if to_dir_ie.kind != 'directory':
 
1195
            raise errors.BzrMoveFailedError('',to_dir,
 
1196
                errors.NotADirectory(to_abs))
 
1197
 
 
1198
        # create rename entries and tuples
 
1199
        for from_rel in from_paths:
 
1200
            from_tail = splitpath(from_rel)[-1]
 
1201
            from_id = inv.path2id(from_rel)
 
1202
            if from_id is None:
 
1203
                raise errors.BzrMoveFailedError(from_rel,to_dir,
 
1204
                    errors.NotVersionedError(path=str(from_rel)))
 
1205
 
 
1206
            from_entry = inv[from_id]
 
1207
            from_parent_id = from_entry.parent_id
 
1208
            to_rel = pathjoin(to_dir, from_tail)
 
1209
            rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
 
1210
                                         from_id=from_id,
 
1211
                                         from_tail=from_tail,
 
1212
                                         from_parent_id=from_parent_id,
 
1213
                                         to_rel=to_rel, to_tail=from_tail,
 
1214
                                         to_parent_id=to_dir_id)
 
1215
            rename_entries.append(rename_entry)
 
1216
            rename_tuples.append((from_rel, to_rel))
 
1217
 
 
1218
        # determine which move mode to use. checks also for movability
 
1219
        rename_entries = self._determine_mv_mode(rename_entries, after)
 
1220
 
 
1221
        original_modified = self._inventory_is_modified
782
1222
        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"])
 
1223
            if len(from_paths):
 
1224
                self._inventory_is_modified = True
 
1225
            self._move(rename_entries)
794
1226
        except:
795
1227
            # restore the inventory on error
796
 
            self._set_inventory(orig_inv)
 
1228
            self._inventory_is_modified = original_modified
797
1229
            raise
798
1230
        self._write_inventory(inv)
799
 
        return result
800
 
 
801
 
    @needs_write_lock
802
 
    def rename_one(self, from_rel, to_rel):
 
1231
        return rename_tuples
 
1232
 
 
1233
    def _determine_mv_mode(self, rename_entries, after=False):
 
1234
        """Determines for each from-to pair if both inventory and working tree
 
1235
        or only the inventory has to be changed.
 
1236
 
 
1237
        Also does basic plausability tests.
 
1238
        """
 
1239
        inv = self.inventory
 
1240
 
 
1241
        for rename_entry in rename_entries:
 
1242
            # store to local variables for easier reference
 
1243
            from_rel = rename_entry.from_rel
 
1244
            from_id = rename_entry.from_id
 
1245
            to_rel = rename_entry.to_rel
 
1246
            to_id = inv.path2id(to_rel)
 
1247
            only_change_inv = False
 
1248
 
 
1249
            # check the inventory for source and destination
 
1250
            if from_id is None:
 
1251
                raise errors.BzrMoveFailedError(from_rel,to_rel,
 
1252
                    errors.NotVersionedError(path=str(from_rel)))
 
1253
            if to_id is not None:
 
1254
                raise errors.BzrMoveFailedError(from_rel,to_rel,
 
1255
                    errors.AlreadyVersionedError(path=str(to_rel)))
 
1256
 
 
1257
            # try to determine the mode for rename (only change inv or change
 
1258
            # inv and file system)
 
1259
            if after:
 
1260
                if not self.has_filename(to_rel):
 
1261
                    raise errors.BzrMoveFailedError(from_id,to_rel,
 
1262
                        errors.NoSuchFile(path=str(to_rel),
 
1263
                        extra="New file has not been created yet"))
 
1264
                only_change_inv = True
 
1265
            elif not self.has_filename(from_rel) and self.has_filename(to_rel):
 
1266
                only_change_inv = True
 
1267
            elif self.has_filename(from_rel) and not self.has_filename(to_rel):
 
1268
                only_change_inv = False
 
1269
            else:
 
1270
                # something is wrong, so lets determine what exactly
 
1271
                if not self.has_filename(from_rel) and \
 
1272
                   not self.has_filename(to_rel):
 
1273
                    raise errors.BzrRenameFailedError(from_rel,to_rel,
 
1274
                        errors.PathsDoNotExist(paths=(str(from_rel),
 
1275
                        str(to_rel))))
 
1276
                else:
 
1277
                    raise errors.RenameFailedFilesExist(from_rel, to_rel,
 
1278
                        extra="(Use --after to update the Bazaar id)")
 
1279
            rename_entry.only_change_inv = only_change_inv
 
1280
        return rename_entries
 
1281
 
 
1282
    def _move(self, rename_entries):
 
1283
        """Moves a list of files.
 
1284
 
 
1285
        Depending on the value of the flag 'only_change_inv', the
 
1286
        file will be moved on the file system or not.
 
1287
        """
 
1288
        inv = self.inventory
 
1289
        moved = []
 
1290
 
 
1291
        for entry in rename_entries:
 
1292
            try:
 
1293
                self._move_entry(entry)
 
1294
            except:
 
1295
                self._rollback_move(moved)
 
1296
                raise
 
1297
            moved.append(entry)
 
1298
 
 
1299
    def _rollback_move(self, moved):
 
1300
        """Try to rollback a previous move in case of an filesystem error."""
 
1301
        inv = self.inventory
 
1302
        for entry in moved:
 
1303
            try:
 
1304
                self._move_entry(_RenameEntry(entry.to_rel, entry.from_id,
 
1305
                    entry.to_tail, entry.to_parent_id, entry.from_rel,
 
1306
                    entry.from_tail, entry.from_parent_id,
 
1307
                    entry.only_change_inv))
 
1308
            except errors.BzrMoveFailedError, e:
 
1309
                raise errors.BzrMoveFailedError( '', '', "Rollback failed."
 
1310
                        " The working tree is in an inconsistent state."
 
1311
                        " Please consider doing a 'bzr revert'."
 
1312
                        " Error message is: %s" % e)
 
1313
 
 
1314
    def _move_entry(self, entry):
 
1315
        inv = self.inventory
 
1316
        from_rel_abs = self.abspath(entry.from_rel)
 
1317
        to_rel_abs = self.abspath(entry.to_rel)
 
1318
        if from_rel_abs == to_rel_abs:
 
1319
            raise errors.BzrMoveFailedError(entry.from_rel, entry.to_rel,
 
1320
                "Source and target are identical.")
 
1321
 
 
1322
        if not entry.only_change_inv:
 
1323
            try:
 
1324
                osutils.rename(from_rel_abs, to_rel_abs)
 
1325
            except OSError, e:
 
1326
                raise errors.BzrMoveFailedError(entry.from_rel,
 
1327
                    entry.to_rel, e[1])
 
1328
        inv.rename(entry.from_id, entry.to_parent_id, entry.to_tail)
 
1329
 
 
1330
    @needs_tree_write_lock
 
1331
    def rename_one(self, from_rel, to_rel, after=False):
803
1332
        """Rename one file.
804
1333
 
805
1334
        This can change the directory or the filename or both.
 
1335
 
 
1336
        rename_one has several 'modes' to work. First, it can rename a physical
 
1337
        file and change the file_id. That is the normal mode. Second, it can
 
1338
        only change the file_id without touching any physical file. This is
 
1339
        the new mode introduced in version 0.15.
 
1340
 
 
1341
        rename_one uses the second mode if 'after == True' and 'to_rel' is not
 
1342
        versioned but present in the working tree.
 
1343
 
 
1344
        rename_one uses the second mode if 'after == False' and 'from_rel' is
 
1345
        versioned but no longer in the working tree, and 'to_rel' is not
 
1346
        versioned but present in the working tree.
 
1347
 
 
1348
        rename_one uses the first mode if 'after == False' and 'from_rel' is
 
1349
        versioned and present in the working tree, and 'to_rel' is not
 
1350
        versioned and not present in the working tree.
 
1351
 
 
1352
        Everything else results in an error.
806
1353
        """
807
1354
        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
 
 
 
1355
        rename_entries = []
 
1356
 
 
1357
        # create rename entries and tuples
 
1358
        from_tail = splitpath(from_rel)[-1]
 
1359
        from_id = inv.path2id(from_rel)
 
1360
        if from_id is None:
 
1361
            raise errors.BzrRenameFailedError(from_rel,to_rel,
 
1362
                errors.NotVersionedError(path=str(from_rel)))
 
1363
        from_entry = inv[from_id]
 
1364
        from_parent_id = from_entry.parent_id
824
1365
        to_dir, to_tail = os.path.split(to_rel)
825
1366
        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"])
 
1367
        rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
 
1368
                                     from_id=from_id,
 
1369
                                     from_tail=from_tail,
 
1370
                                     from_parent_id=from_parent_id,
 
1371
                                     to_rel=to_rel, to_tail=to_tail,
 
1372
                                     to_parent_id=to_dir_id)
 
1373
        rename_entries.append(rename_entry)
 
1374
 
 
1375
        # determine which move mode to use. checks also for movability
 
1376
        rename_entries = self._determine_mv_mode(rename_entries, after)
 
1377
 
 
1378
        # check if the target changed directory and if the target directory is
 
1379
        # versioned
 
1380
        if to_dir_id is None:
 
1381
            raise errors.BzrMoveFailedError(from_rel,to_rel,
 
1382
                errors.NotVersionedError(path=str(to_dir)))
 
1383
 
 
1384
        # all checks done. now we can continue with our actual work
 
1385
        mutter('rename_one:\n'
 
1386
               '  from_id   {%s}\n'
 
1387
               '  from_rel: %r\n'
 
1388
               '  to_rel:   %r\n'
 
1389
               '  to_dir    %r\n'
 
1390
               '  to_dir_id {%s}\n',
 
1391
               from_id, from_rel, to_rel, to_dir, to_dir_id)
 
1392
 
 
1393
        self._move(rename_entries)
847
1394
        self._write_inventory(inv)
848
1395
 
 
1396
    class _RenameEntry(object):
 
1397
        def __init__(self, from_rel, from_id, from_tail, from_parent_id,
 
1398
                     to_rel, to_tail, to_parent_id, only_change_inv=False):
 
1399
            self.from_rel = from_rel
 
1400
            self.from_id = from_id
 
1401
            self.from_tail = from_tail
 
1402
            self.from_parent_id = from_parent_id
 
1403
            self.to_rel = to_rel
 
1404
            self.to_tail = to_tail
 
1405
            self.to_parent_id = to_parent_id
 
1406
            self.only_change_inv = only_change_inv
 
1407
 
849
1408
    @needs_read_lock
850
1409
    def unknowns(self):
851
1410
        """Return all unknown files.
852
1411
 
853
1412
        These are files in the working directory that are not versioned or
854
1413
        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
 
 
 
1414
        """
 
1415
        # force the extras method to be fully executed before returning, to 
 
1416
        # prevent race conditions with the lock
 
1417
        return iter(
 
1418
            [subp for subp in self.extras() if not self.is_ignored(subp)])
 
1419
 
 
1420
    @needs_tree_write_lock
 
1421
    def unversion(self, file_ids):
 
1422
        """Remove the file ids in file_ids from the current versioned set.
 
1423
 
 
1424
        When a file_id is unversioned, all of its children are automatically
 
1425
        unversioned.
 
1426
 
 
1427
        :param file_ids: The file ids to stop versioning.
 
1428
        :raises: NoSuchId if any fileid is not currently versioned.
 
1429
        """
 
1430
        for file_id in file_ids:
 
1431
            file_id = osutils.safe_file_id(file_id)
 
1432
            if self._inventory.has_id(file_id):
 
1433
                self._inventory.remove_recursive_id(file_id)
 
1434
            else:
 
1435
                raise errors.NoSuchId(self, file_id)
 
1436
        if len(file_ids):
 
1437
            # in the future this should just set a dirty bit to wait for the 
 
1438
            # final unlock. However, until all methods of workingtree start
 
1439
            # with the current in -memory inventory rather than triggering 
 
1440
            # a read, it is more complex - we need to teach read_inventory
 
1441
            # to know when to read, and when to not read first... and possibly
 
1442
            # to save first when the in memory one may be corrupted.
 
1443
            # so for now, we just only write it if it is indeed dirty.
 
1444
            # - RBC 20060907
 
1445
            self._write_inventory(self._inventory)
 
1446
    
873
1447
    @deprecated_method(zero_eight)
874
1448
    def iter_conflicts(self):
875
1449
        """List all files in the tree that have text or content conflicts.
878
1452
 
879
1453
    def _iter_conflicts(self):
880
1454
        conflicted = set()
881
 
        for path in (s[0] for s in self.list_files()):
 
1455
        for info in self.list_files():
 
1456
            path = info[0]
882
1457
            stem = get_conflicted_stem(path)
883
1458
            if stem is None:
884
1459
                continue
887
1462
                yield stem
888
1463
 
889
1464
    @needs_write_lock
890
 
    def pull(self, source, overwrite=False, stop_revision=None):
 
1465
    def pull(self, source, overwrite=False, stop_revision=None,
 
1466
             change_reporter=None):
891
1467
        top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
892
1468
        source.lock_read()
893
1469
        try:
894
1470
            pp = ProgressPhase("Pull phase", 2, top_pb)
895
1471
            pp.next_phase()
896
 
            old_revision_history = self.branch.revision_history()
 
1472
            old_revision_info = self.branch.last_revision_info()
897
1473
            basis_tree = self.basis_tree()
898
1474
            count = self.branch.pull(source, overwrite, stop_revision)
899
 
            new_revision_history = self.branch.revision_history()
900
 
            if new_revision_history != old_revision_history:
 
1475
            new_revision_info = self.branch.last_revision_info()
 
1476
            if new_revision_info != old_revision_info:
901
1477
                pp.next_phase()
902
 
                if len(old_revision_history):
903
 
                    other_revision = old_revision_history[-1]
904
 
                else:
905
 
                    other_revision = None
906
1478
                repository = self.branch.repository
907
1479
                pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
1480
                basis_tree.lock_read()
908
1481
                try:
909
 
                    merge_inner(self.branch,
910
 
                                self.branch.basis_tree(),
911
 
                                basis_tree, 
912
 
                                this_tree=self, 
913
 
                                pb=pb)
 
1482
                    new_basis_tree = self.branch.basis_tree()
 
1483
                    merge.merge_inner(
 
1484
                                self.branch,
 
1485
                                new_basis_tree,
 
1486
                                basis_tree,
 
1487
                                this_tree=self,
 
1488
                                pb=pb,
 
1489
                                change_reporter=change_reporter)
 
1490
                    if (basis_tree.inventory.root is None and
 
1491
                        new_basis_tree.inventory.root is not None):
 
1492
                        self.set_root_id(new_basis_tree.inventory.root.file_id)
914
1493
                finally:
915
1494
                    pb.finished()
916
 
                self.set_last_revision(self.branch.last_revision())
 
1495
                    basis_tree.unlock()
 
1496
                # TODO - dedup parents list with things merged by pull ?
 
1497
                # reuse the revisiontree we merged against to set the new
 
1498
                # tree data.
 
1499
                parent_trees = [(self.branch.last_revision(), new_basis_tree)]
 
1500
                # we have to pull the merge trees out again, because 
 
1501
                # merge_inner has set the ids. - this corner is not yet 
 
1502
                # layered well enough to prevent double handling.
 
1503
                # XXX TODO: Fix the double handling: telling the tree about
 
1504
                # the already known parent data is wasteful.
 
1505
                merges = self.get_parent_ids()[1:]
 
1506
                parent_trees.extend([
 
1507
                    (parent, repository.revision_tree(parent)) for
 
1508
                     parent in merges])
 
1509
                self.set_parent_trees(parent_trees)
917
1510
            return count
918
1511
        finally:
919
1512
            source.unlock()
920
1513
            top_pb.finished()
921
1514
 
 
1515
    @needs_write_lock
 
1516
    def put_file_bytes_non_atomic(self, file_id, bytes):
 
1517
        """See MutableTree.put_file_bytes_non_atomic."""
 
1518
        file_id = osutils.safe_file_id(file_id)
 
1519
        stream = file(self.id2abspath(file_id), 'wb')
 
1520
        try:
 
1521
            stream.write(bytes)
 
1522
        finally:
 
1523
            stream.close()
 
1524
        # TODO: update the hashcache here ?
 
1525
 
922
1526
    def extras(self):
923
 
        """Yield all unknown files in this WorkingTree.
 
1527
        """Yield all unversioned files in this WorkingTree.
924
1528
 
925
 
        If there are any unknown directories then only the directory is
926
 
        returned, not all its children.  But if there are unknown files
 
1529
        If there are any unversioned directories then only the directory is
 
1530
        returned, not all its children.  But if there are unversioned files
927
1531
        under a versioned subdirectory, they are returned.
928
1532
 
929
1533
        Currently returned depth-first, sorted by name within directories.
 
1534
        This is the same order used by 'osutils.walkdirs'.
930
1535
        """
931
1536
        ## TODO: Work from given directory downwards
932
1537
        for path, dir_entry in self.inventory.directories():
933
 
            mutter("search for unknowns in %r", path)
 
1538
            # mutter("search for unknowns in %r", path)
934
1539
            dirabs = self.abspath(path)
935
1540
            if not isdir(dirabs):
936
1541
                # e.g. directory deleted
938
1543
 
939
1544
            fl = []
940
1545
            for subf in os.listdir(dirabs):
941
 
                if (subf != '.bzr'
942
 
                    and (subf not in dir_entry.children)):
943
 
                    fl.append(subf)
 
1546
                if subf == '.bzr':
 
1547
                    continue
 
1548
                if subf not in dir_entry.children:
 
1549
                    subf_norm, can_access = osutils.normalized_filename(subf)
 
1550
                    if subf_norm != subf and can_access:
 
1551
                        if subf_norm not in dir_entry.children:
 
1552
                            fl.append(subf_norm)
 
1553
                    else:
 
1554
                        fl.append(subf)
944
1555
            
945
1556
            fl.sort()
946
1557
            for subf in fl:
947
 
                subp = appendpath(path, subf)
 
1558
                subp = pathjoin(path, subf)
948
1559
                yield subp
949
1560
 
950
 
 
951
1561
    def ignored_files(self):
952
1562
        """Yield list of PATH, IGNORE_PATTERN"""
953
1563
        for subp in self.extras():
954
1564
            pat = self.is_ignored(subp)
955
 
            if pat != None:
 
1565
            if pat is not None:
956
1566
                yield subp, pat
957
1567
 
958
 
 
959
1568
    def get_ignore_list(self):
960
1569
        """Return list of ignore patterns.
961
1570
 
962
1571
        Cached in the Tree object after the first call.
963
1572
        """
964
 
        if hasattr(self, '_ignorelist'):
965
 
            return self._ignorelist
 
1573
        ignoreset = getattr(self, '_ignoreset', None)
 
1574
        if ignoreset is not None:
 
1575
            return ignoreset
966
1576
 
967
 
        l = bzrlib.DEFAULT_IGNORE[:]
 
1577
        ignore_globs = set()
 
1578
        ignore_globs.update(ignores.get_runtime_ignores())
 
1579
        ignore_globs.update(ignores.get_user_ignores())
968
1580
        if self.has_filename(bzrlib.IGNORE_FILENAME):
969
1581
            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
 
1582
            try:
 
1583
                ignore_globs.update(ignores.parse_ignore_file(f))
 
1584
            finally:
 
1585
                f.close()
 
1586
        self._ignoreset = ignore_globs
 
1587
        return ignore_globs
973
1588
 
 
1589
    def _flush_ignore_list_cache(self):
 
1590
        """Resets the cached ignore list to force a cache rebuild."""
 
1591
        self._ignoreset = None
 
1592
        self._ignoreglobster = None
974
1593
 
975
1594
    def is_ignored(self, filename):
976
1595
        r"""Check whether the filename matches an ignore pattern.
981
1600
        If the file is ignored, returns the pattern which caused it to
982
1601
        be ignored, otherwise None.  So this can simply be used as a
983
1602
        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
 
1603
        if getattr(self, '_ignoreglobster', None) is None:
 
1604
            self._ignoreglobster = globbing.Globster(self.get_ignore_list())
 
1605
        return self._ignoreglobster.match(filename)
1012
1606
 
1013
1607
    def kind(self, file_id):
1014
1608
        return file_kind(self.id2abspath(file_id))
1015
1609
 
1016
 
    @needs_read_lock
 
1610
    def _comparison_data(self, entry, path):
 
1611
        abspath = self.abspath(path)
 
1612
        try:
 
1613
            stat_value = os.lstat(abspath)
 
1614
        except OSError, e:
 
1615
            if getattr(e, 'errno', None) == errno.ENOENT:
 
1616
                stat_value = None
 
1617
                kind = None
 
1618
                executable = False
 
1619
            else:
 
1620
                raise
 
1621
        else:
 
1622
            mode = stat_value.st_mode
 
1623
            kind = osutils.file_kind_from_stat_mode(mode)
 
1624
            if not supports_executable():
 
1625
                executable = entry is not None and entry.executable
 
1626
            else:
 
1627
                executable = bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
 
1628
        return kind, executable, stat_value
 
1629
 
 
1630
    def _file_size(self, entry, stat_value):
 
1631
        return stat_value.st_size
 
1632
 
1017
1633
    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().
 
1634
        """Return the last revision of the branch for this tree.
 
1635
 
 
1636
        This format tree does not support a separate marker for last-revision
 
1637
        compared to the branch.
 
1638
 
 
1639
        See MutableTree.last_revision
1023
1640
        """
1024
 
        return self.branch.last_revision()
 
1641
        return self._last_revision()
 
1642
 
 
1643
    @needs_read_lock
 
1644
    def _last_revision(self):
 
1645
        """helper for get_parent_ids."""
 
1646
        return _mod_revision.ensure_null(self.branch.last_revision())
 
1647
 
 
1648
    def is_locked(self):
 
1649
        return self._control_files.is_locked()
 
1650
 
 
1651
    def _must_be_locked(self):
 
1652
        if not self.is_locked():
 
1653
            raise errors.ObjectNotLocked(self)
1025
1654
 
1026
1655
    def lock_read(self):
1027
1656
        """See Branch.lock_read, and WorkingTree.unlock."""
 
1657
        if not self.is_locked():
 
1658
            self._reset_data()
1028
1659
        self.branch.lock_read()
1029
1660
        try:
1030
1661
            return self._control_files.lock_read()
1032
1663
            self.branch.unlock()
1033
1664
            raise
1034
1665
 
 
1666
    def lock_tree_write(self):
 
1667
        """See MutableTree.lock_tree_write, and WorkingTree.unlock."""
 
1668
        if not self.is_locked():
 
1669
            self._reset_data()
 
1670
        self.branch.lock_read()
 
1671
        try:
 
1672
            return self._control_files.lock_write()
 
1673
        except:
 
1674
            self.branch.unlock()
 
1675
            raise
 
1676
 
1035
1677
    def lock_write(self):
1036
 
        """See Branch.lock_write, and WorkingTree.unlock."""
 
1678
        """See MutableTree.lock_write, and WorkingTree.unlock."""
 
1679
        if not self.is_locked():
 
1680
            self._reset_data()
1037
1681
        self.branch.lock_write()
1038
1682
        try:
1039
1683
            return self._control_files.lock_write()
1041
1685
            self.branch.unlock()
1042
1686
            raise
1043
1687
 
 
1688
    def get_physical_lock_status(self):
 
1689
        return self._control_files.get_physical_lock_status()
 
1690
 
1044
1691
    def _basis_inventory_name(self):
1045
 
        return 'basis-inventory'
1046
 
 
1047
 
    @needs_write_lock
 
1692
        return 'basis-inventory-cache'
 
1693
 
 
1694
    def _reset_data(self):
 
1695
        """Reset transient data that cannot be revalidated."""
 
1696
        self._inventory_is_modified = False
 
1697
        result = self._deserialize(self._control_files.get('inventory'))
 
1698
        self._set_inventory(result, dirty=False)
 
1699
 
 
1700
    @needs_tree_write_lock
1048
1701
    def set_last_revision(self, new_revision):
1049
1702
        """Change the last revision in the working tree."""
 
1703
        new_revision = osutils.safe_revision_id(new_revision)
1050
1704
        if self._change_last_revision(new_revision):
1051
1705
            self._cache_basis_inventory(new_revision)
1052
1706
 
1056
1710
        This is used to allow WorkingTree3 instances to not affect branch
1057
1711
        when their last revision is set.
1058
1712
        """
1059
 
        if new_revision is None:
 
1713
        if _mod_revision.is_null(new_revision):
1060
1714
            self.branch.set_revision_history([])
1061
1715
            return False
1062
 
        # current format is locked in with the branch
1063
 
        revision_history = self.branch.revision_history()
1064
1716
        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])
 
1717
            self.branch.generate_revision_history(new_revision)
 
1718
        except errors.NoSuchRevision:
 
1719
            # not present in the repo - dont try to set it deeper than the tip
 
1720
            self.branch.set_revision_history([new_revision])
1069
1721
        return True
1070
1722
 
 
1723
    def _write_basis_inventory(self, xml):
 
1724
        """Write the basis inventory XML to the basis-inventory file"""
 
1725
        assert isinstance(xml, str), 'serialised xml must be bytestring.'
 
1726
        path = self._basis_inventory_name()
 
1727
        sio = StringIO(xml)
 
1728
        self._control_files.put(path, sio)
 
1729
 
 
1730
    def _create_basis_xml_from_inventory(self, revision_id, inventory):
 
1731
        """Create the text that will be saved in basis-inventory"""
 
1732
        # TODO: jam 20070209 This should be redundant, as the revision_id
 
1733
        #       as all callers should have already converted the revision_id to
 
1734
        #       utf8
 
1735
        inventory.revision_id = osutils.safe_revision_id(revision_id)
 
1736
        return xml7.serializer_v7.write_inventory_to_string(inventory)
 
1737
 
1071
1738
    def _cache_basis_inventory(self, new_revision):
1072
1739
        """Cache new_revision as the basis inventory."""
 
1740
        # TODO: this should allow the ready-to-use inventory to be passed in,
 
1741
        # as commit already has that ready-to-use [while the format is the
 
1742
        # same, that is].
1073
1743
        try:
1074
1744
            # this double handles the inventory - unpack and repack - 
1075
1745
            # but is easier to understand. We can/should put a conditional
1076
1746
            # in here based on whether the inventory is in the latest format
1077
1747
            # - perhaps we should repack all inventories on a repository
1078
1748
            # 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:
 
1749
            # the fast path is to copy the raw xml from the repository. If the
 
1750
            # xml contains 'revision_id="', then we assume the right 
 
1751
            # revision_id is set. We must check for this full string, because a
 
1752
            # root node id can legitimately look like 'revision_id' but cannot
 
1753
            # contain a '"'.
 
1754
            xml = self.branch.repository.get_inventory_xml(new_revision)
 
1755
            firstline = xml.split('\n', 1)[0]
 
1756
            if (not 'revision_id="' in firstline or 
 
1757
                'format="7"' not in firstline):
 
1758
                inv = self.branch.repository.deserialise_inventory(
 
1759
                    new_revision, xml)
 
1760
                xml = self._create_basis_xml_from_inventory(new_revision, inv)
 
1761
            self._write_basis_inventory(xml)
 
1762
        except (errors.NoSuchRevision, errors.RevisionNotPresent):
1086
1763
            pass
1087
1764
 
1088
1765
    def read_basis_inventory(self):
1089
1766
        """Read the cached basis inventory."""
1090
1767
        path = self._basis_inventory_name()
1091
 
        return self._control_files.get_utf8(path).read()
 
1768
        return self._control_files.get(path).read()
1092
1769
        
1093
1770
    @needs_read_lock
1094
1771
    def read_working_inventory(self):
1095
 
        """Read the working inventory."""
 
1772
        """Read the working inventory.
 
1773
        
 
1774
        :raises errors.InventoryModified: read_working_inventory will fail
 
1775
            when the current in memory inventory has been modified.
 
1776
        """
 
1777
        # conceptually this should be an implementation detail of the tree. 
 
1778
        # XXX: Deprecate this.
1096
1779
        # ElementTree does its own conversion from UTF-8, so open in
1097
1780
        # binary.
1098
 
        result = bzrlib.xml5.serializer_v5.read_inventory(
1099
 
            self._control_files.get('inventory'))
1100
 
        self._set_inventory(result)
 
1781
        if self._inventory_is_modified:
 
1782
            raise errors.InventoryModified(self)
 
1783
        result = self._deserialize(self._control_files.get('inventory'))
 
1784
        self._set_inventory(result, dirty=False)
1101
1785
        return result
1102
1786
 
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.
 
1787
    @needs_tree_write_lock
 
1788
    def remove(self, files, verbose=False, to_file=None, keep_files=True,
 
1789
        force=False):
 
1790
        """Remove nominated files from the working inventory.
 
1791
 
 
1792
        :files: File paths relative to the basedir.
 
1793
        :keep_files: If true, the files will also be kept.
 
1794
        :force: Delete files and directories, even if they are changed and
 
1795
            even if the directories are not empty.
1117
1796
        """
1118
 
        ## TODO: Normalize names
1119
 
        ## TODO: Remove nested loops; better scalability
1120
1797
        if isinstance(files, basestring):
1121
1798
            files = [files]
1122
1799
 
1123
 
        inv = self.inventory
1124
 
 
1125
 
        # do this before any modifications
 
1800
        inv_delta = []
 
1801
 
 
1802
        new_files=set()
 
1803
        unknown_nested_files=set()
 
1804
 
 
1805
        def recurse_directory_to_add_files(directory):
 
1806
            # Recurse directory and add all files
 
1807
            # so we can check if they have changed.
 
1808
            for parent_info, file_infos in\
 
1809
                osutils.walkdirs(self.abspath(directory),
 
1810
                    directory):
 
1811
                for relpath, basename, kind, lstat, abspath in file_infos:
 
1812
                    # Is it versioned or ignored?
 
1813
                    if self.path2id(relpath) or self.is_ignored(relpath):
 
1814
                        # Add nested content for deletion.
 
1815
                        new_files.add(relpath)
 
1816
                    else:
 
1817
                        # Files which are not versioned and not ignored
 
1818
                        # should be treated as unknown.
 
1819
                        unknown_nested_files.add((relpath, None, kind))
 
1820
 
 
1821
        for filename in files:
 
1822
            # Get file name into canonical form.
 
1823
            abspath = self.abspath(filename)
 
1824
            filename = self.relpath(abspath)
 
1825
            if len(filename) > 0:
 
1826
                new_files.add(filename)
 
1827
                if osutils.isdir(abspath):
 
1828
                    recurse_directory_to_add_files(filename)
 
1829
 
 
1830
        files = list(new_files)
 
1831
 
 
1832
        if len(files) == 0:
 
1833
            return # nothing to do
 
1834
 
 
1835
        # Sort needed to first handle directory content before the directory
 
1836
        files.sort(reverse=True)
 
1837
 
 
1838
        # Bail out if we are going to delete files we shouldn't
 
1839
        if not keep_files and not force:
 
1840
            has_changed_files = len(unknown_nested_files) > 0
 
1841
            if not has_changed_files:
 
1842
                for (file_id, path, content_change, versioned, parent_id, name,
 
1843
                     kind, executable) in self._iter_changes(self.basis_tree(),
 
1844
                         include_unchanged=True, require_versioned=False,
 
1845
                         want_unversioned=True, specific_files=files):
 
1846
                    # Check if it's an unknown (but not ignored) OR
 
1847
                    # changed (but not deleted) :
 
1848
                    if not self.is_ignored(path[1]) and (
 
1849
                        versioned == (False, False) or
 
1850
                        content_change and kind[1] != None):
 
1851
                        has_changed_files = True
 
1852
                        break
 
1853
 
 
1854
            if has_changed_files:
 
1855
                # Make delta show ALL applicable changes in error message.
 
1856
                tree_delta = self.changes_from(self.basis_tree(),
 
1857
                    require_versioned=False, want_unversioned=True,
 
1858
                    specific_files=files)
 
1859
                for unknown_file in unknown_nested_files:
 
1860
                    if unknown_file not in tree_delta.unversioned:
 
1861
                        tree_delta.unversioned.extend((unknown_file,))
 
1862
                raise errors.BzrRemoveChangedFilesError(tree_delta)
 
1863
 
 
1864
        # Build inv_delta and delete files where applicaple,
 
1865
        # do this before any modifications to inventory.
1126
1866
        for f in files:
1127
 
            fid = inv.path2id(f)
 
1867
            fid = self.path2id(f)
 
1868
            message = None
1128
1869
            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
 
1870
                message = "%s is not versioned." % (f,)
 
1871
            else:
 
1872
                if verbose:
 
1873
                    # having removed it, it must be either ignored or unknown
 
1874
                    if self.is_ignored(f):
 
1875
                        new_status = 'I'
 
1876
                    else:
 
1877
                        new_status = '?'
 
1878
                    textui.show_status(new_status, self.kind(fid), f,
 
1879
                                       to_file=to_file)
 
1880
                # Unversion file
 
1881
                inv_delta.append((f, None, fid, None))
 
1882
                message = "removed %s" % (f,)
 
1883
 
 
1884
            if not keep_files:
 
1885
                abs_path = self.abspath(f)
 
1886
                if osutils.lexists(abs_path):
 
1887
                    if (osutils.isdir(abs_path) and
 
1888
                        len(os.listdir(abs_path)) > 0):
 
1889
                        if force:
 
1890
                            osutils.rmtree(abs_path)
 
1891
                        else:
 
1892
                            message = "%s is not an empty directory "\
 
1893
                                "and won't be deleted." % (f,)
 
1894
                    else:
 
1895
                        osutils.delete_any(abs_path)
 
1896
                        message = "deleted %s" % (f,)
 
1897
                elif message is not None:
 
1898
                    # Only care if we haven't done anything yet.
 
1899
                    message = "%s does not exist." % (f,)
 
1900
 
 
1901
            # Print only one message (if any) per file.
 
1902
            if message is not None:
 
1903
                note(message)
 
1904
        self.apply_inventory_delta(inv_delta)
 
1905
 
 
1906
    @needs_tree_write_lock
 
1907
    def revert(self, filenames=None, old_tree=None, backups=True,
 
1908
               pb=DummyProgress(), report_changes=False):
 
1909
        from bzrlib.conflicts import resolve
 
1910
        if filenames == []:
 
1911
            filenames = None
 
1912
            symbol_versioning.warn('Using [] to revert all files is deprecated'
 
1913
                ' as of bzr 0.91.  Please use None (the default) instead.',
 
1914
                DeprecationWarning, stacklevel=2)
1149
1915
        if old_tree is None:
1150
1916
            old_tree = self.basis_tree()
1151
 
        conflicts = revert(self, old_tree, filenames, backups, pb)
1152
 
        if not len(filenames):
1153
 
            self.set_pending_merges([])
 
1917
        conflicts = transform.revert(self, old_tree, filenames, backups, pb,
 
1918
                                     report_changes)
 
1919
        if filenames is None:
 
1920
            self.set_parent_ids(self.get_parent_ids()[:1])
1154
1921
            resolve(self)
1155
1922
        else:
1156
1923
            resolve(self, filenames, ignore_misses=True)
1157
1924
        return conflicts
1158
1925
 
 
1926
    def revision_tree(self, revision_id):
 
1927
        """See Tree.revision_tree.
 
1928
 
 
1929
        WorkingTree can supply revision_trees for the basis revision only
 
1930
        because there is only one cached inventory in the bzr directory.
 
1931
        """
 
1932
        if revision_id == self.last_revision():
 
1933
            try:
 
1934
                xml = self.read_basis_inventory()
 
1935
            except errors.NoSuchFile:
 
1936
                pass
 
1937
            else:
 
1938
                try:
 
1939
                    inv = xml7.serializer_v7.read_inventory_from_string(xml)
 
1940
                    # dont use the repository revision_tree api because we want
 
1941
                    # to supply the inventory.
 
1942
                    if inv.revision_id == revision_id:
 
1943
                        return revisiontree.RevisionTree(self.branch.repository,
 
1944
                            inv, revision_id)
 
1945
                except errors.BadInventoryFormat:
 
1946
                    pass
 
1947
        # raise if there was no inventory, or if we read the wrong inventory.
 
1948
        raise errors.NoSuchRevisionInTree(self, revision_id)
 
1949
 
1159
1950
    # XXX: This method should be deprecated in favour of taking in a proper
1160
1951
    # new Inventory object.
1161
 
    @needs_write_lock
 
1952
    @needs_tree_write_lock
1162
1953
    def set_inventory(self, new_inventory_list):
1163
1954
        from bzrlib.inventory import (Inventory,
1164
1955
                                      InventoryDirectory,
1178
1969
            elif kind == 'symlink':
1179
1970
                inv.add(InventoryLink(file_id, name, parent))
1180
1971
            else:
1181
 
                raise BzrError("unknown kind %r" % kind)
 
1972
                raise errors.BzrError("unknown kind %r" % kind)
1182
1973
        self._write_inventory(inv)
1183
1974
 
1184
 
    @needs_write_lock
 
1975
    @needs_tree_write_lock
1185
1976
    def set_root_id(self, file_id):
1186
1977
        """Set the root id for this tree."""
1187
 
        inv = self.read_working_inventory()
 
1978
        # for compatability 
 
1979
        if file_id is None:
 
1980
            symbol_versioning.warn(symbol_versioning.zero_twelve
 
1981
                % 'WorkingTree.set_root_id with fileid=None',
 
1982
                DeprecationWarning,
 
1983
                stacklevel=3)
 
1984
            file_id = ROOT_ID
 
1985
        else:
 
1986
            file_id = osutils.safe_file_id(file_id)
 
1987
        self._set_root_id(file_id)
 
1988
 
 
1989
    def _set_root_id(self, file_id):
 
1990
        """Set the root id for this tree, in a format specific manner.
 
1991
 
 
1992
        :param file_id: The file id to assign to the root. It must not be 
 
1993
            present in the current inventory or an error will occur. It must
 
1994
            not be None, but rather a valid file id.
 
1995
        """
 
1996
        inv = self._inventory
1188
1997
        orig_root_id = inv.root.file_id
 
1998
        # TODO: it might be nice to exit early if there was nothing
 
1999
        # to do, saving us from trigger a sync on unlock.
 
2000
        self._inventory_is_modified = True
 
2001
        # we preserve the root inventory entry object, but
 
2002
        # unlinkit from the byid index
1189
2003
        del inv._byid[inv.root.file_id]
1190
2004
        inv.root.file_id = file_id
 
2005
        # and link it into the index with the new changed id.
1191
2006
        inv._byid[inv.root.file_id] = inv.root
 
2007
        # and finally update all children to reference the new id.
 
2008
        # XXX: this should be safe to just look at the root.children
 
2009
        # list, not the WHOLE INVENTORY.
1192
2010
        for fid in inv:
1193
2011
            entry = inv[fid]
1194
2012
            if entry.parent_id == orig_root_id:
1195
2013
                entry.parent_id = inv.root.file_id
1196
 
        self._write_inventory(inv)
1197
2014
 
1198
2015
    def unlock(self):
1199
2016
        """See Branch.unlock.
1204
2021
        between multiple working trees, i.e. via shared storage, then we 
1205
2022
        would probably want to lock both the local tree, and the branch.
1206
2023
        """
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
 
2024
        raise NotImplementedError(self.unlock)
1229
2025
 
1230
 
    @needs_write_lock
1231
 
    def update(self):
 
2026
    def update(self, change_reporter=None, possible_transports=None):
1232
2027
        """Update a working tree along its branch.
1233
2028
 
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.
 
2029
        This will update the branch if its bound too, which means we have
 
2030
        multiple trees involved:
 
2031
 
 
2032
        - The new basis tree of the master.
 
2033
        - The old basis tree of the branch.
 
2034
        - The old basis tree of the working tree.
 
2035
        - The current working tree state.
 
2036
 
 
2037
        Pathologically, all three may be different, and non-ancestors of each
 
2038
        other.  Conceptually we want to:
 
2039
 
 
2040
        - Preserve the wt.basis->wt.state changes
 
2041
        - Transform the wt.basis to the new master basis.
 
2042
        - Apply a merge of the old branch basis to get any 'local' changes from
 
2043
          it into the tree.
 
2044
        - Restore the wt.basis->wt.state changes.
1245
2045
 
1246
2046
        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()
 
2047
        - Merge current state -> basis tree of the master w.r.t. the old tree
 
2048
          basis.
 
2049
        - Do a 'normal' merge of the old branch basis if it is relevant.
 
2050
        """
 
2051
        if self.branch.get_master_branch(possible_transports) is not None:
 
2052
            self.lock_write()
 
2053
            update_branch = True
 
2054
        else:
 
2055
            self.lock_tree_write()
 
2056
            update_branch = False
 
2057
        try:
 
2058
            if update_branch:
 
2059
                old_tip = self.branch.update(possible_transports)
 
2060
            else:
 
2061
                old_tip = None
 
2062
            return self._update_tree(old_tip, change_reporter)
 
2063
        finally:
 
2064
            self.unlock()
 
2065
 
 
2066
    @needs_tree_write_lock
 
2067
    def _update_tree(self, old_tip=None, change_reporter=None):
 
2068
        """Update a tree to the master branch.
 
2069
 
 
2070
        :param old_tip: if supplied, the previous tip revision the branch,
 
2071
            before it was changed to the master branch's tip.
 
2072
        """
 
2073
        # here if old_tip is not None, it is the old tip of the branch before
 
2074
        # it was updated from the master branch. This should become a pending
 
2075
        # merge in the working tree to preserve the user existing work.  we
 
2076
        # cant set that until we update the working trees last revision to be
 
2077
        # one from the new branch, because it will just get absorbed by the
 
2078
        # parent de-duplication logic.
 
2079
        # 
 
2080
        # We MUST save it even if an error occurs, because otherwise the users
 
2081
        # local work is unreferenced and will appear to have been lost.
 
2082
        # 
 
2083
        result = 0
 
2084
        try:
 
2085
            last_rev = self.get_parent_ids()[0]
 
2086
        except IndexError:
 
2087
            last_rev = _mod_revision.NULL_REVISION
 
2088
        if last_rev != _mod_revision.ensure_null(self.branch.last_revision()):
 
2089
            # merge tree state up to new branch tip.
 
2090
            basis = self.basis_tree()
 
2091
            basis.lock_read()
 
2092
            try:
1259
2093
                to_tree = self.branch.basis_tree()
1260
 
                result += merge_inner(self.branch,
 
2094
                if basis.inventory.root is None:
 
2095
                    self.set_root_id(to_tree.inventory.root.file_id)
 
2096
                    self.flush()
 
2097
                result += merge.merge_inner(
 
2098
                                      self.branch,
1261
2099
                                      to_tree,
1262
2100
                                      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
 
2101
                                      this_tree=self,
 
2102
                                      change_reporter=change_reporter)
 
2103
            finally:
 
2104
                basis.unlock()
 
2105
            # TODO - dedup parents list with things merged by pull ?
 
2106
            # reuse the tree we've updated to to set the basis:
 
2107
            parent_trees = [(self.branch.last_revision(), to_tree)]
 
2108
            merges = self.get_parent_ids()[1:]
 
2109
            # Ideally we ask the tree for the trees here, that way the working
 
2110
            # tree can decide whether to give us teh entire tree or give us a
 
2111
            # lazy initialised tree. dirstate for instance will have the trees
 
2112
            # in ram already, whereas a last-revision + basis-inventory tree
 
2113
            # will not, but also does not need them when setting parents.
 
2114
            for parent in merges:
 
2115
                parent_trees.append(
 
2116
                    (parent, self.branch.repository.revision_tree(parent)))
 
2117
            if (old_tip is not None and not _mod_revision.is_null(old_tip)):
 
2118
                parent_trees.append(
 
2119
                    (old_tip, self.branch.repository.revision_tree(old_tip)))
 
2120
            self.set_parent_trees(parent_trees)
 
2121
            last_rev = parent_trees[0][0]
 
2122
        else:
 
2123
            # the working tree had the same last-revision as the master
 
2124
            # branch did. We may still have pivot local work from the local
 
2125
            # branch into old_tip:
 
2126
            if (old_tip is not None and not _mod_revision.is_null(old_tip)):
 
2127
                self.add_parent_tree_id(old_tip)
 
2128
        if (old_tip is not None and not _mod_revision.is_null(old_tip)
 
2129
            and old_tip != last_rev):
 
2130
            # our last revision was not the prior branch last revision
 
2131
            # and we have converted that last revision to a pending merge.
 
2132
            # base is somewhere between the branch tip now
 
2133
            # and the now pending merge
 
2134
 
 
2135
            # Since we just modified the working tree and inventory, flush out
 
2136
            # the current state, before we modify it again.
 
2137
            # TODO: jam 20070214 WorkingTree3 doesn't require this, dirstate
 
2138
            #       requires it only because TreeTransform directly munges the
 
2139
            #       inventory and calls tree._write_inventory(). Ultimately we
 
2140
            #       should be able to remove this extra flush.
 
2141
            self.flush()
 
2142
            graph = self.branch.repository.get_graph()
 
2143
            base_rev_id = graph.find_unique_lca(self.branch.last_revision(),
 
2144
                                                old_tip)
 
2145
            base_tree = self.branch.repository.revision_tree(base_rev_id)
 
2146
            other_tree = self.branch.repository.revision_tree(old_tip)
 
2147
            result += merge.merge_inner(
 
2148
                                  self.branch,
 
2149
                                  other_tree,
 
2150
                                  base_tree,
 
2151
                                  this_tree=self,
 
2152
                                  change_reporter=change_reporter)
 
2153
        return result
 
2154
 
 
2155
    def _write_hashcache_if_dirty(self):
 
2156
        """Write out the hashcache if it is dirty."""
 
2157
        if self._hashcache.needs_write:
 
2158
            try:
 
2159
                self._hashcache.write()
 
2160
            except OSError, e:
 
2161
                if e.errno not in (errno.EPERM, errno.EACCES):
 
2162
                    raise
 
2163
                # TODO: jam 20061219 Should this be a warning? A single line
 
2164
                #       warning might be sufficient to let the user know what
 
2165
                #       is going on.
 
2166
                mutter('Could not write hashcache for %s\nError: %s',
 
2167
                       self._hashcache.cache_file_name(), e)
 
2168
 
 
2169
    @needs_tree_write_lock
1288
2170
    def _write_inventory(self, inv):
1289
2171
        """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')
 
2172
        self._set_inventory(inv, dirty=True)
 
2173
        self.flush()
1296
2174
 
1297
2175
    def set_conflicts(self, arg):
1298
 
        raise UnsupportedOperation(self.set_conflicts, self)
 
2176
        raise errors.UnsupportedOperation(self.set_conflicts, self)
 
2177
 
 
2178
    def add_conflicts(self, arg):
 
2179
        raise errors.UnsupportedOperation(self.add_conflicts, self)
1299
2180
 
1300
2181
    @needs_read_lock
1301
2182
    def conflicts(self):
1302
 
        conflicts = ConflictList()
 
2183
        conflicts = _mod_conflicts.ConflictList()
1303
2184
        for conflicted in self._iter_conflicts():
1304
2185
            text = True
1305
2186
            try:
1306
2187
                if file_kind(self.abspath(conflicted)) != "file":
1307
2188
                    text = False
1308
 
            except OSError, e:
1309
 
                if e.errno == errno.ENOENT:
1310
 
                    text = False
1311
 
                else:
1312
 
                    raise
 
2189
            except errors.NoSuchFile:
 
2190
                text = False
1313
2191
            if text is True:
1314
2192
                for suffix in ('.THIS', '.OTHER'):
1315
2193
                    try:
1316
2194
                        kind = file_kind(self.abspath(conflicted+suffix))
1317
 
                    except OSError, e:
1318
 
                        if e.errno == errno.ENOENT:
 
2195
                        if kind != "file":
1319
2196
                            text = False
1320
 
                            break
1321
 
                        else:
1322
 
                            raise
1323
 
                    if kind != "file":
 
2197
                    except errors.NoSuchFile:
1324
2198
                        text = False
 
2199
                    if text == False:
1325
2200
                        break
1326
2201
            ctype = {True: 'text conflict', False: 'contents conflict'}[text]
1327
 
            conflicts.append(Conflict.factory(ctype, path=conflicted,
 
2202
            conflicts.append(_mod_conflicts.Conflict.factory(ctype,
 
2203
                             path=conflicted,
1328
2204
                             file_id=self.path2id(conflicted)))
1329
2205
        return conflicts
1330
2206
 
 
2207
    def walkdirs(self, prefix=""):
 
2208
        """Walk the directories of this tree.
 
2209
 
 
2210
        returns a generator which yields items in the form:
 
2211
                ((curren_directory_path, fileid),
 
2212
                 [(file1_path, file1_name, file1_kind, (lstat), file1_id,
 
2213
                   file1_kind), ... ])
 
2214
 
 
2215
        This API returns a generator, which is only valid during the current
 
2216
        tree transaction - within a single lock_read or lock_write duration.
 
2217
 
 
2218
        If the tree is not locked, it may cause an error to be raised,
 
2219
        depending on the tree implementation.
 
2220
        """
 
2221
        disk_top = self.abspath(prefix)
 
2222
        if disk_top.endswith('/'):
 
2223
            disk_top = disk_top[:-1]
 
2224
        top_strip_len = len(disk_top) + 1
 
2225
        inventory_iterator = self._walkdirs(prefix)
 
2226
        disk_iterator = osutils.walkdirs(disk_top, prefix)
 
2227
        try:
 
2228
            current_disk = disk_iterator.next()
 
2229
            disk_finished = False
 
2230
        except OSError, e:
 
2231
            if not (e.errno == errno.ENOENT or
 
2232
                (sys.platform == 'win32' and e.errno == ERROR_PATH_NOT_FOUND)):
 
2233
                raise
 
2234
            current_disk = None
 
2235
            disk_finished = True
 
2236
        try:
 
2237
            current_inv = inventory_iterator.next()
 
2238
            inv_finished = False
 
2239
        except StopIteration:
 
2240
            current_inv = None
 
2241
            inv_finished = True
 
2242
        while not inv_finished or not disk_finished:
 
2243
            if not disk_finished:
 
2244
                # strip out .bzr dirs
 
2245
                if current_disk[0][1][top_strip_len:] == '':
 
2246
                    # osutils.walkdirs can be made nicer - 
 
2247
                    # yield the path-from-prefix rather than the pathjoined
 
2248
                    # value.
 
2249
                    bzrdir_loc = bisect_left(current_disk[1], ('.bzr', '.bzr'))
 
2250
                    if current_disk[1][bzrdir_loc][0] == '.bzr':
 
2251
                        # we dont yield the contents of, or, .bzr itself.
 
2252
                        del current_disk[1][bzrdir_loc]
 
2253
            if inv_finished:
 
2254
                # everything is unknown
 
2255
                direction = 1
 
2256
            elif disk_finished:
 
2257
                # everything is missing
 
2258
                direction = -1
 
2259
            else:
 
2260
                direction = cmp(current_inv[0][0], current_disk[0][0])
 
2261
            if direction > 0:
 
2262
                # disk is before inventory - unknown
 
2263
                dirblock = [(relpath, basename, kind, stat, None, None) for
 
2264
                    relpath, basename, kind, stat, top_path in current_disk[1]]
 
2265
                yield (current_disk[0][0], None), dirblock
 
2266
                try:
 
2267
                    current_disk = disk_iterator.next()
 
2268
                except StopIteration:
 
2269
                    disk_finished = True
 
2270
            elif direction < 0:
 
2271
                # inventory is before disk - missing.
 
2272
                dirblock = [(relpath, basename, 'unknown', None, fileid, kind)
 
2273
                    for relpath, basename, dkind, stat, fileid, kind in 
 
2274
                    current_inv[1]]
 
2275
                yield (current_inv[0][0], current_inv[0][1]), dirblock
 
2276
                try:
 
2277
                    current_inv = inventory_iterator.next()
 
2278
                except StopIteration:
 
2279
                    inv_finished = True
 
2280
            else:
 
2281
                # versioned present directory
 
2282
                # merge the inventory and disk data together
 
2283
                dirblock = []
 
2284
                for relpath, subiterator in itertools.groupby(sorted(
 
2285
                    current_inv[1] + current_disk[1], key=operator.itemgetter(0)), operator.itemgetter(1)):
 
2286
                    path_elements = list(subiterator)
 
2287
                    if len(path_elements) == 2:
 
2288
                        inv_row, disk_row = path_elements
 
2289
                        # versioned, present file
 
2290
                        dirblock.append((inv_row[0],
 
2291
                            inv_row[1], disk_row[2],
 
2292
                            disk_row[3], inv_row[4],
 
2293
                            inv_row[5]))
 
2294
                    elif len(path_elements[0]) == 5:
 
2295
                        # unknown disk file
 
2296
                        dirblock.append((path_elements[0][0],
 
2297
                            path_elements[0][1], path_elements[0][2],
 
2298
                            path_elements[0][3], None, None))
 
2299
                    elif len(path_elements[0]) == 6:
 
2300
                        # versioned, absent file.
 
2301
                        dirblock.append((path_elements[0][0],
 
2302
                            path_elements[0][1], 'unknown', None,
 
2303
                            path_elements[0][4], path_elements[0][5]))
 
2304
                    else:
 
2305
                        raise NotImplementedError('unreachable code')
 
2306
                yield current_inv[0], dirblock
 
2307
                try:
 
2308
                    current_inv = inventory_iterator.next()
 
2309
                except StopIteration:
 
2310
                    inv_finished = True
 
2311
                try:
 
2312
                    current_disk = disk_iterator.next()
 
2313
                except StopIteration:
 
2314
                    disk_finished = True
 
2315
 
 
2316
    def _walkdirs(self, prefix=""):
 
2317
        """Walk the directories of this tree.
 
2318
 
 
2319
           :prefix: is used as the directrory to start with.
 
2320
           returns a generator which yields items in the form:
 
2321
                ((curren_directory_path, fileid),
 
2322
                 [(file1_path, file1_name, file1_kind, None, file1_id,
 
2323
                   file1_kind), ... ])
 
2324
        """
 
2325
        _directory = 'directory'
 
2326
        # get the root in the inventory
 
2327
        inv = self.inventory
 
2328
        top_id = inv.path2id(prefix)
 
2329
        if top_id is None:
 
2330
            pending = []
 
2331
        else:
 
2332
            pending = [(prefix, '', _directory, None, top_id, None)]
 
2333
        while pending:
 
2334
            dirblock = []
 
2335
            currentdir = pending.pop()
 
2336
            # 0 - relpath, 1- basename, 2- kind, 3- stat, 4-id, 5-kind
 
2337
            top_id = currentdir[4]
 
2338
            if currentdir[0]:
 
2339
                relroot = currentdir[0] + '/'
 
2340
            else:
 
2341
                relroot = ""
 
2342
            # FIXME: stash the node in pending
 
2343
            entry = inv[top_id]
 
2344
            for name, child in entry.sorted_children():
 
2345
                dirblock.append((relroot + name, name, child.kind, None,
 
2346
                    child.file_id, child.kind
 
2347
                    ))
 
2348
            yield (currentdir[0], entry.file_id), dirblock
 
2349
            # push the user specified dirs from dirblock
 
2350
            for dir in reversed(dirblock):
 
2351
                if dir[2] == _directory:
 
2352
                    pending.append(dir)
 
2353
 
 
2354
    @needs_tree_write_lock
 
2355
    def auto_resolve(self):
 
2356
        """Automatically resolve text conflicts according to contents.
 
2357
 
 
2358
        Only text conflicts are auto_resolvable. Files with no conflict markers
 
2359
        are considered 'resolved', because bzr always puts conflict markers
 
2360
        into files that have text conflicts.  The corresponding .THIS .BASE and
 
2361
        .OTHER files are deleted, as per 'resolve'.
 
2362
        :return: a tuple of ConflictLists: (un_resolved, resolved).
 
2363
        """
 
2364
        un_resolved = _mod_conflicts.ConflictList()
 
2365
        resolved = _mod_conflicts.ConflictList()
 
2366
        conflict_re = re.compile('^(<{7}|={7}|>{7})')
 
2367
        for conflict in self.conflicts():
 
2368
            if (conflict.typestring != 'text conflict' or
 
2369
                self.kind(conflict.file_id) != 'file'):
 
2370
                un_resolved.append(conflict)
 
2371
                continue
 
2372
            my_file = open(self.id2abspath(conflict.file_id), 'rb')
 
2373
            try:
 
2374
                for line in my_file:
 
2375
                    if conflict_re.search(line):
 
2376
                        un_resolved.append(conflict)
 
2377
                        break
 
2378
                else:
 
2379
                    resolved.append(conflict)
 
2380
            finally:
 
2381
                my_file.close()
 
2382
        resolved.remove_files(self)
 
2383
        self.set_conflicts(un_resolved)
 
2384
        return un_resolved, resolved
 
2385
 
 
2386
    def _validate(self):
 
2387
        """Validate internal structures.
 
2388
 
 
2389
        This is meant mostly for the test suite. To give it a chance to detect
 
2390
        corruption after actions have occurred. The default implementation is a
 
2391
        just a no-op.
 
2392
 
 
2393
        :return: None. An exception should be raised if there is an error.
 
2394
        """
 
2395
        return
 
2396
 
 
2397
 
 
2398
class WorkingTree2(WorkingTree):
 
2399
    """This is the Format 2 working tree.
 
2400
 
 
2401
    This was the first weave based working tree. 
 
2402
     - uses os locks for locking.
 
2403
     - uses the branch last-revision.
 
2404
    """
 
2405
 
 
2406
    def __init__(self, *args, **kwargs):
 
2407
        super(WorkingTree2, self).__init__(*args, **kwargs)
 
2408
        # WorkingTree2 has more of a constraint that self._inventory must
 
2409
        # exist. Because this is an older format, we don't mind the overhead
 
2410
        # caused by the extra computation here.
 
2411
 
 
2412
        # Newer WorkingTree's should only have self._inventory set when they
 
2413
        # have a read lock.
 
2414
        if self._inventory is None:
 
2415
            self.read_working_inventory()
 
2416
 
 
2417
    def lock_tree_write(self):
 
2418
        """See WorkingTree.lock_tree_write().
 
2419
 
 
2420
        In Format2 WorkingTrees we have a single lock for the branch and tree
 
2421
        so lock_tree_write() degrades to lock_write().
 
2422
        """
 
2423
        self.branch.lock_write()
 
2424
        try:
 
2425
            return self._control_files.lock_write()
 
2426
        except:
 
2427
            self.branch.unlock()
 
2428
            raise
 
2429
 
 
2430
    def unlock(self):
 
2431
        # do non-implementation specific cleanup
 
2432
        self._cleanup()
 
2433
 
 
2434
        # we share control files:
 
2435
        if self._control_files._lock_count == 3:
 
2436
            # _inventory_is_modified is always False during a read lock.
 
2437
            if self._inventory_is_modified:
 
2438
                self.flush()
 
2439
            self._write_hashcache_if_dirty()
 
2440
                    
 
2441
        # reverse order of locking.
 
2442
        try:
 
2443
            return self._control_files.unlock()
 
2444
        finally:
 
2445
            self.branch.unlock()
 
2446
 
1331
2447
 
1332
2448
class WorkingTree3(WorkingTree):
1333
2449
    """This is the Format 3 working tree.
1340
2456
    """
1341
2457
 
1342
2458
    @needs_read_lock
1343
 
    def last_revision(self):
1344
 
        """See WorkingTree.last_revision."""
 
2459
    def _last_revision(self):
 
2460
        """See Mutable.last_revision."""
1345
2461
        try:
1346
 
            return self._control_files.get_utf8('last-revision').read()
1347
 
        except NoSuchFile:
1348
 
            return None
 
2462
            return osutils.safe_revision_id(
 
2463
                        self._control_files.get('last-revision').read())
 
2464
        except errors.NoSuchFile:
 
2465
            return _mod_revision.NULL_REVISION
1349
2466
 
1350
2467
    def _change_last_revision(self, revision_id):
1351
2468
        """See WorkingTree._change_last_revision."""
1356
2473
                pass
1357
2474
            return False
1358
2475
        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)
 
2476
            self._control_files.put_bytes('last-revision', revision_id)
1364
2477
            return True
1365
2478
 
1366
 
    @needs_write_lock
 
2479
    @needs_tree_write_lock
1367
2480
    def set_conflicts(self, conflicts):
1368
2481
        self._put_rio('conflicts', conflicts.to_stanzas(), 
1369
2482
                      CONFLICT_HEADER_1)
1370
2483
 
 
2484
    @needs_tree_write_lock
 
2485
    def add_conflicts(self, new_conflicts):
 
2486
        conflict_set = set(self.conflicts())
 
2487
        conflict_set.update(set(list(new_conflicts)))
 
2488
        self.set_conflicts(_mod_conflicts.ConflictList(sorted(conflict_set,
 
2489
                                       key=_mod_conflicts.Conflict.sort_key)))
 
2490
 
1371
2491
    @needs_read_lock
1372
2492
    def conflicts(self):
1373
2493
        try:
1374
2494
            confile = self._control_files.get('conflicts')
1375
 
        except NoSuchFile:
1376
 
            return ConflictList()
 
2495
        except errors.NoSuchFile:
 
2496
            return _mod_conflicts.ConflictList()
1377
2497
        try:
1378
2498
            if confile.next() != CONFLICT_HEADER_1 + '\n':
1379
 
                raise ConflictFormatError()
 
2499
                raise errors.ConflictFormatError()
1380
2500
        except StopIteration:
1381
 
            raise ConflictFormatError()
1382
 
        return ConflictList.from_stanzas(RioReader(confile))
 
2501
            raise errors.ConflictFormatError()
 
2502
        return _mod_conflicts.ConflictList.from_stanzas(RioReader(confile))
 
2503
 
 
2504
    def unlock(self):
 
2505
        # do non-implementation specific cleanup
 
2506
        self._cleanup()
 
2507
        if self._control_files._lock_count == 1:
 
2508
            # _inventory_is_modified is always False during a read lock.
 
2509
            if self._inventory_is_modified:
 
2510
                self.flush()
 
2511
            self._write_hashcache_if_dirty()
 
2512
        # reverse order of locking.
 
2513
        try:
 
2514
            return self._control_files.unlock()
 
2515
        finally:
 
2516
            self.branch.unlock()
1383
2517
 
1384
2518
 
1385
2519
def get_conflicted_stem(path):
1386
 
    for suffix in CONFLICT_SUFFIXES:
 
2520
    for suffix in _mod_conflicts.CONFLICT_SUFFIXES:
1387
2521
        if path.endswith(suffix):
1388
2522
            return path[:-len(suffix)]
1389
2523
 
 
2524
 
1390
2525
@deprecated_function(zero_eight)
1391
2526
def is_control_file(filename):
1392
2527
    """See WorkingTree.is_control_filename(filename)."""
1427
2562
    _formats = {}
1428
2563
    """The known formats."""
1429
2564
 
 
2565
    requires_rich_root = False
 
2566
 
 
2567
    upgrade_recommended = False
 
2568
 
1430
2569
    @classmethod
1431
2570
    def find_format(klass, a_bzrdir):
1432
2571
        """Return the format for the working tree object in a_bzrdir."""
1434
2573
            transport = a_bzrdir.get_workingtree_transport(None)
1435
2574
            format_string = transport.get("format").read()
1436
2575
            return klass._formats[format_string]
1437
 
        except NoSuchFile:
 
2576
        except errors.NoSuchFile:
1438
2577
            raise errors.NoWorkingTree(base=transport.base)
1439
2578
        except KeyError:
1440
 
            raise errors.UnknownFormatError(format_string)
 
2579
            raise errors.UnknownFormatError(format=format_string)
 
2580
 
 
2581
    def __eq__(self, other):
 
2582
        return self.__class__ is other.__class__
 
2583
 
 
2584
    def __ne__(self, other):
 
2585
        return not (self == other)
1441
2586
 
1442
2587
    @classmethod
1443
2588
    def get_default_format(klass):
1475
2620
        del klass._formats[format.get_format_string()]
1476
2621
 
1477
2622
 
1478
 
 
1479
2623
class WorkingTreeFormat2(WorkingTreeFormat):
1480
2624
    """The second working tree format. 
1481
2625
 
1482
2626
    This format modified the hash cache from the format 1 hash cache.
1483
2627
    """
1484
2628
 
 
2629
    upgrade_recommended = True
 
2630
 
1485
2631
    def get_format_description(self):
1486
2632
        """See WorkingTreeFormat.get_format_description()."""
1487
2633
        return "Working tree format 2"
1488
2634
 
 
2635
    def stub_initialize_remote(self, control_files):
 
2636
        """As a special workaround create critical control files for a remote working tree
 
2637
        
 
2638
        This ensures that it can later be updated and dealt with locally,
 
2639
        since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with 
 
2640
        no working tree.  (See bug #43064).
 
2641
        """
 
2642
        sio = StringIO()
 
2643
        inv = Inventory()
 
2644
        xml5.serializer_v5.write_inventory(inv, sio, working=True)
 
2645
        sio.seek(0)
 
2646
        control_files.put('inventory', sio)
 
2647
 
 
2648
        control_files.put_bytes('pending-merges', '')
 
2649
        
 
2650
 
1489
2651
    def initialize(self, a_bzrdir, revision_id=None):
1490
2652
        """See WorkingTreeFormat.initialize()."""
1491
2653
        if not isinstance(a_bzrdir.transport, LocalTransport):
1492
2654
            raise errors.NotLocalUrl(a_bzrdir.transport.base)
1493
2655
        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,
 
2656
        if revision_id is None:
 
2657
            revision_id = _mod_revision.ensure_null(branch.last_revision())
 
2658
        else:
 
2659
            revision_id = osutils.safe_revision_id(revision_id)
 
2660
        branch.lock_write()
 
2661
        try:
 
2662
            branch.generate_revision_history(revision_id)
 
2663
        finally:
 
2664
            branch.unlock()
 
2665
        inv = Inventory()
 
2666
        wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
1508
2667
                         branch,
1509
2668
                         inv,
1510
2669
                         _internal=True,
1511
2670
                         _format=self,
1512
2671
                         _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)
 
2672
        basis_tree = branch.repository.revision_tree(revision_id)
 
2673
        if basis_tree.inventory.root is not None:
 
2674
            wt.set_root_id(basis_tree.inventory.root.file_id)
 
2675
        # set the parent list and cache the basis tree.
 
2676
        if _mod_revision.is_null(revision_id):
 
2677
            parent_trees = []
 
2678
        else:
 
2679
            parent_trees = [(revision_id, basis_tree)]
 
2680
        wt.set_parent_trees(parent_trees)
 
2681
        transform.build_tree(basis_tree, wt)
1518
2682
        return wt
1519
2683
 
1520
2684
    def __init__(self):
1532
2696
            raise NotImplementedError
1533
2697
        if not isinstance(a_bzrdir.transport, LocalTransport):
1534
2698
            raise errors.NotLocalUrl(a_bzrdir.transport.base)
1535
 
        return WorkingTree(a_bzrdir.root_transport.base,
 
2699
        wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
1536
2700
                           _internal=True,
1537
2701
                           _format=self,
1538
2702
                           _bzrdir=a_bzrdir)
1539
 
 
 
2703
        return wt
1540
2704
 
1541
2705
class WorkingTreeFormat3(WorkingTreeFormat):
1542
2706
    """The second working tree format updated to record a format marker.
1547
2711
          files, separate from the BzrDir format
1548
2712
        - modifies the hash cache format
1549
2713
        - is new in bzr 0.8
1550
 
        - uses a LockDir to guard access to the repository
 
2714
        - uses a LockDir to guard access for writes.
1551
2715
    """
 
2716
    
 
2717
    upgrade_recommended = True
1552
2718
 
1553
2719
    def get_format_string(self):
1554
2720
        """See WorkingTreeFormat.get_format_string()."""
1561
2727
    _lock_file_name = 'lock'
1562
2728
    _lock_class = LockDir
1563
2729
 
 
2730
    _tree_class = WorkingTree3
 
2731
 
 
2732
    def __get_matchingbzrdir(self):
 
2733
        return bzrdir.BzrDirMetaFormat1()
 
2734
 
 
2735
    _matchingbzrdir = property(__get_matchingbzrdir)
 
2736
 
1564
2737
    def _open_control_files(self, a_bzrdir):
1565
2738
        transport = a_bzrdir.get_workingtree_transport(None)
1566
2739
        return LockableFiles(transport, self._lock_file_name, 
1569
2742
    def initialize(self, a_bzrdir, revision_id=None):
1570
2743
        """See WorkingTreeFormat.initialize().
1571
2744
        
1572
 
        revision_id allows creating a working tree at a differnet
 
2745
        revision_id allows creating a working tree at a different
1573
2746
        revision than the branch is at.
1574
2747
        """
1575
2748
        if not isinstance(a_bzrdir.transport, LocalTransport):
1577
2750
        transport = a_bzrdir.get_workingtree_transport(self)
1578
2751
        control_files = self._open_control_files(a_bzrdir)
1579
2752
        control_files.create_lock()
 
2753
        control_files.lock_write()
1580
2754
        control_files.put_utf8('format', self.get_format_string())
1581
2755
        branch = a_bzrdir.open_branch()
1582
2756
        if revision_id is None:
1583
 
            revision_id = branch.last_revision()
1584
 
        inv = Inventory() 
1585
 
        wt = WorkingTree3(a_bzrdir.root_transport.base,
 
2757
            revision_id = _mod_revision.ensure_null(branch.last_revision())
 
2758
        else:
 
2759
            revision_id = osutils.safe_revision_id(revision_id)
 
2760
        # WorkingTree3 can handle an inventory which has a unique root id.
 
2761
        # as of bzr 0.12. However, bzr 0.11 and earlier fail to handle
 
2762
        # those trees. And because there isn't a format bump inbetween, we
 
2763
        # are maintaining compatibility with older clients.
 
2764
        # inv = Inventory(root_id=gen_root_id())
 
2765
        inv = self._initial_inventory()
 
2766
        wt = self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
1586
2767
                         branch,
1587
2768
                         inv,
1588
2769
                         _internal=True,
1589
2770
                         _format=self,
1590
2771
                         _bzrdir=a_bzrdir,
1591
2772
                         _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)
 
2773
        wt.lock_tree_write()
 
2774
        try:
 
2775
            basis_tree = branch.repository.revision_tree(revision_id)
 
2776
            # only set an explicit root id if there is one to set.
 
2777
            if basis_tree.inventory.root is not None:
 
2778
                wt.set_root_id(basis_tree.inventory.root.file_id)
 
2779
            if revision_id == NULL_REVISION:
 
2780
                wt.set_parent_trees([])
 
2781
            else:
 
2782
                wt.set_parent_trees([(revision_id, basis_tree)])
 
2783
            transform.build_tree(basis_tree, wt)
 
2784
        finally:
 
2785
            # Unlock in this order so that the unlock-triggers-flush in
 
2786
            # WorkingTree is given a chance to fire.
 
2787
            control_files.unlock()
 
2788
            wt.unlock()
1597
2789
        return wt
1598
2790
 
 
2791
    def _initial_inventory(self):
 
2792
        return Inventory()
 
2793
 
1599
2794
    def __init__(self):
1600
2795
        super(WorkingTreeFormat3, self).__init__()
1601
 
        self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1602
2796
 
1603
2797
    def open(self, a_bzrdir, _found=False):
1604
2798
        """Return the WorkingTree object for a_bzrdir
1611
2805
            raise NotImplementedError
1612
2806
        if not isinstance(a_bzrdir.transport, LocalTransport):
1613
2807
            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)
 
2808
        wt = self._open(a_bzrdir, self._open_control_files(a_bzrdir))
 
2809
        return wt
 
2810
 
 
2811
    def _open(self, a_bzrdir, control_files):
 
2812
        """Open the tree itself.
 
2813
        
 
2814
        :param a_bzrdir: the dir for the tree.
 
2815
        :param control_files: the control files for the tree.
 
2816
        """
 
2817
        return self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
 
2818
                                _internal=True,
 
2819
                                _format=self,
 
2820
                                _bzrdir=a_bzrdir,
 
2821
                                _control_files=control_files)
1620
2822
 
1621
2823
    def __str__(self):
1622
2824
        return self.get_format_string()
1623
2825
 
1624
2826
 
 
2827
__default_format = WorkingTreeFormat4()
 
2828
WorkingTreeFormat.register_format(__default_format)
 
2829
WorkingTreeFormat.register_format(WorkingTreeFormat3())
 
2830
WorkingTreeFormat.set_default_format(__default_format)
1625
2831
# formats which have no format string are not discoverable
1626
2832
# 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
2833
_legacy_formats = [WorkingTreeFormat2(),
1631
2834
                   ]
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