/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-11 01:03:53 UTC
  • mfrom: (2810.1.1 tag-overwrite)
  • Revision ID: pqm@pqm.ubuntu.com-20070911010353-6lu7ek40rbjhj86o
(lukas) Overwrite conflicting tags by push|pull --overwrite

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