/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: Martin Pool
  • Date: 2006-06-20 05:32:16 UTC
  • mfrom: (1797 +trunk)
  • mto: This revision was merged to the branch mainline in revision 1798.
  • Revision ID: mbp@sourcefrog.net-20060620053216-817857d7ca3e9d1f
[merge] bzr.dev

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
# Copyright (C) 2005, 2006 Canonical Ltd
 
2
 
 
3
# This program is free software; you can redistribute it and/or modify
 
4
# it under the terms of the GNU General Public License as published by
 
5
# the Free Software Foundation; either version 2 of the License, or
 
6
# (at your option) any later version.
 
7
 
 
8
# This program is distributed in the hope that it will be useful,
 
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
 
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
11
# GNU General Public License for more details.
 
12
 
 
13
# You should have received a copy of the GNU General Public License
 
14
# along with this program; if not, write to the Free Software
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
16
 
 
17
"""WorkingTree object and friends.
 
18
 
 
19
A WorkingTree represents the editable working copy of a branch.
 
20
Operations which represent the WorkingTree are also done here, 
 
21
such as renaming or adding files.  The WorkingTree has an inventory 
 
22
which is updated by these operations.  A commit produces a 
 
23
new revision based on the workingtree and its inventory.
 
24
 
 
25
At the moment every WorkingTree has its own branch.  Remote
 
26
WorkingTrees aren't supported.
 
27
 
 
28
To get a WorkingTree, call bzrdir.open_workingtree() or
 
29
WorkingTree.open(dir).
 
30
"""
 
31
 
 
32
MERGE_MODIFIED_HEADER_1 = "BZR merge-modified list format 1"
 
33
CONFLICT_HEADER_1 = "BZR conflict list format 1"
 
34
 
 
35
# TODO: Give the workingtree sole responsibility for the working inventory;
 
36
# remove the variable and references to it from the branch.  This may require
 
37
# updating the commit code so as to update the inventory within the working
 
38
# copy, and making sure there's only one WorkingTree for any directory on disk.
 
39
# At the moment they may alias the inventory and have old copies of it in
 
40
# memory.  (Now done? -- mbp 20060309)
 
41
 
 
42
from binascii import hexlify
 
43
import collections
 
44
from copy import deepcopy
 
45
from cStringIO import StringIO
 
46
import errno
 
47
import fnmatch
 
48
import os
 
49
import re
 
50
import stat
 
51
from time import time
 
52
import warnings
 
53
 
 
54
from bzrlib.atomicfile import AtomicFile
 
55
from bzrlib.conflicts import Conflict, ConflictList, CONFLICT_SUFFIXES
 
56
import bzrlib.bzrdir as bzrdir
 
57
from bzrlib.decorators import needs_read_lock, needs_write_lock
 
58
import bzrlib.errors as errors
 
59
from bzrlib.errors import (BzrCheckError,
 
60
                           BzrError,
 
61
                           ConflictFormatError,
 
62
                           WeaveRevisionNotPresent,
 
63
                           NotBranchError,
 
64
                           NoSuchFile,
 
65
                           NotVersionedError,
 
66
                           MergeModifiedFormatError,
 
67
                           UnsupportedOperation,
 
68
                           )
 
69
from bzrlib.inventory import InventoryEntry, Inventory
 
70
from bzrlib.lockable_files import LockableFiles, TransportLock
 
71
from bzrlib.lockdir import LockDir
 
72
from bzrlib.merge import merge_inner, transform_tree
 
73
from bzrlib.osutils import (
 
74
                            abspath,
 
75
                            compact_date,
 
76
                            file_kind,
 
77
                            isdir,
 
78
                            getcwd,
 
79
                            pathjoin,
 
80
                            pumpfile,
 
81
                            safe_unicode,
 
82
                            splitpath,
 
83
                            rand_chars,
 
84
                            normpath,
 
85
                            realpath,
 
86
                            relpath,
 
87
                            rename,
 
88
                            supports_executable,
 
89
                            )
 
90
from bzrlib.progress import DummyProgress, ProgressPhase
 
91
from bzrlib.revision import NULL_REVISION
 
92
from bzrlib.rio import RioReader, rio_file, Stanza
 
93
from bzrlib.symbol_versioning import (deprecated_passed,
 
94
        deprecated_method,
 
95
        deprecated_function,
 
96
        DEPRECATED_PARAMETER,
 
97
        zero_eight,
 
98
        )
 
99
 
 
100
from bzrlib.textui import show_status
 
101
import bzrlib.tree
 
102
from bzrlib.transform import build_tree
 
103
from bzrlib.trace import mutter, note
 
104
from bzrlib.transport import get_transport
 
105
from bzrlib.transport.local import LocalTransport
 
106
import bzrlib.urlutils as urlutils
 
107
import bzrlib.ui
 
108
import bzrlib.xml5
 
109
 
 
110
 
 
111
# the regex here does the following:
 
112
# 1) remove any weird characters; we don't escape them but rather
 
113
# just pull them out
 
114
 # 2) match leading '.'s to make it not hidden
 
115
_gen_file_id_re = re.compile(r'[^\w.]|(^\.*)')
 
116
_gen_id_suffix = None
 
117
_gen_id_serial = 0
 
118
 
 
119
 
 
120
def _next_id_suffix():
 
121
    """Create a new file id suffix that is reasonably unique.
 
122
    
 
123
    On the first call we combine the current time with 64 bits of randomness
 
124
    to give a highly probably globally unique number. Then each call in the same
 
125
    process adds 1 to a serial number we append to that unique value.
 
126
    """
 
127
    # XXX TODO: change bzrlib.add.smart_add to call workingtree.add() rather 
 
128
    # than having to move the id randomness out of the inner loop like this.
 
129
    # XXX TODO: for the global randomness this uses we should add the thread-id
 
130
    # before the serial #.
 
131
    global _gen_id_suffix, _gen_id_serial
 
132
    if _gen_id_suffix is None:
 
133
        _gen_id_suffix = "-%s-%s-" % (compact_date(time()), rand_chars(16))
 
134
    _gen_id_serial += 1
 
135
    return _gen_id_suffix + str(_gen_id_serial)
 
136
 
 
137
 
 
138
def gen_file_id(name):
 
139
    """Return new file id for the basename 'name'.
 
140
 
 
141
    The uniqueness is supplied from _next_id_suffix.
 
142
    """
 
143
    # XXX TODO: squash the filename to lowercase.
 
144
    # XXX TODO: truncate the filename to something like 20 or 30 chars.
 
145
    # XXX TODO: consider what to do with ids that look like illegal filepaths
 
146
    # on platforms we support.
 
147
    return _gen_file_id_re.sub('', name) + _next_id_suffix()
 
148
 
 
149
 
 
150
def gen_root_id():
 
151
    """Return a new tree-root file id."""
 
152
    return gen_file_id('TREE_ROOT')
 
153
 
 
154
 
 
155
class TreeEntry(object):
 
156
    """An entry that implements the minimum interface used by commands.
 
157
 
 
158
    This needs further inspection, it may be better to have 
 
159
    InventoryEntries without ids - though that seems wrong. For now,
 
160
    this is a parallel hierarchy to InventoryEntry, and needs to become
 
161
    one of several things: decorates to that hierarchy, children of, or
 
162
    parents of it.
 
163
    Another note is that these objects are currently only used when there is
 
164
    no InventoryEntry available - i.e. for unversioned objects.
 
165
    Perhaps they should be UnversionedEntry et al. ? - RBC 20051003
 
166
    """
 
167
 
 
168
    def __eq__(self, other):
 
169
        # yes, this us ugly, TODO: best practice __eq__ style.
 
170
        return (isinstance(other, TreeEntry)
 
171
                and other.__class__ == self.__class__)
 
172
 
 
173
    def kind_character(self):
 
174
        return "???"
 
175
 
 
176
 
 
177
class TreeDirectory(TreeEntry):
 
178
    """See TreeEntry. This is a directory in a working tree."""
 
179
 
 
180
    def __eq__(self, other):
 
181
        return (isinstance(other, TreeDirectory)
 
182
                and other.__class__ == self.__class__)
 
183
 
 
184
    def kind_character(self):
 
185
        return "/"
 
186
 
 
187
 
 
188
class TreeFile(TreeEntry):
 
189
    """See TreeEntry. This is a regular file in a working tree."""
 
190
 
 
191
    def __eq__(self, other):
 
192
        return (isinstance(other, TreeFile)
 
193
                and other.__class__ == self.__class__)
 
194
 
 
195
    def kind_character(self):
 
196
        return ''
 
197
 
 
198
 
 
199
class TreeLink(TreeEntry):
 
200
    """See TreeEntry. This is a symlink in a working tree."""
 
201
 
 
202
    def __eq__(self, other):
 
203
        return (isinstance(other, TreeLink)
 
204
                and other.__class__ == self.__class__)
 
205
 
 
206
    def kind_character(self):
 
207
        return ''
 
208
 
 
209
 
 
210
class WorkingTree(bzrlib.tree.Tree):
 
211
    """Working copy tree.
 
212
 
 
213
    The inventory is held in the `Branch` working-inventory, and the
 
214
    files are in a directory on disk.
 
215
 
 
216
    It is possible for a `WorkingTree` to have a filename which is
 
217
    not listed in the Inventory and vice versa.
 
218
    """
 
219
 
 
220
    def __init__(self, basedir='.',
 
221
                 branch=DEPRECATED_PARAMETER,
 
222
                 _inventory=None,
 
223
                 _control_files=None,
 
224
                 _internal=False,
 
225
                 _format=None,
 
226
                 _bzrdir=None):
 
227
        """Construct a WorkingTree for basedir.
 
228
 
 
229
        If the branch is not supplied, it is opened automatically.
 
230
        If the branch is supplied, it must be the branch for this basedir.
 
231
        (branch.base is not cross checked, because for remote branches that
 
232
        would be meaningless).
 
233
        """
 
234
        self._format = _format
 
235
        self.bzrdir = _bzrdir
 
236
        if not _internal:
 
237
            # not created via open etc.
 
238
            warnings.warn("WorkingTree() is deprecated as of bzr version 0.8. "
 
239
                 "Please use bzrdir.open_workingtree or WorkingTree.open().",
 
240
                 DeprecationWarning,
 
241
                 stacklevel=2)
 
242
            wt = WorkingTree.open(basedir)
 
243
            self._branch = wt.branch
 
244
            self.basedir = wt.basedir
 
245
            self._control_files = wt._control_files
 
246
            self._hashcache = wt._hashcache
 
247
            self._set_inventory(wt._inventory)
 
248
            self._format = wt._format
 
249
            self.bzrdir = wt.bzrdir
 
250
        from bzrlib.hashcache import HashCache
 
251
        from bzrlib.trace import note, mutter
 
252
        assert isinstance(basedir, basestring), \
 
253
            "base directory %r is not a string" % basedir
 
254
        basedir = safe_unicode(basedir)
 
255
        mutter("opening working tree %r", basedir)
 
256
        if deprecated_passed(branch):
 
257
            if not _internal:
 
258
                warnings.warn("WorkingTree(..., branch=XXX) is deprecated as of bzr 0.8."
 
259
                     " Please use bzrdir.open_workingtree() or"
 
260
                     " WorkingTree.open().",
 
261
                     DeprecationWarning,
 
262
                     stacklevel=2
 
263
                     )
 
264
            self._branch = branch
 
265
        else:
 
266
            self._branch = self.bzrdir.open_branch()
 
267
        self.basedir = realpath(basedir)
 
268
        # if branch is at our basedir and is a format 6 or less
 
269
        if isinstance(self._format, WorkingTreeFormat2):
 
270
            # share control object
 
271
            self._control_files = self.branch.control_files
 
272
        else:
 
273
            # only ready for format 3
 
274
            assert isinstance(self._format, WorkingTreeFormat3)
 
275
            assert isinstance(_control_files, LockableFiles), \
 
276
                    "_control_files must be a LockableFiles, not %r" \
 
277
                    % _control_files
 
278
            self._control_files = _control_files
 
279
        # update the whole cache up front and write to disk if anything changed;
 
280
        # in the future we might want to do this more selectively
 
281
        # two possible ways offer themselves : in self._unlock, write the cache
 
282
        # if needed, or, when the cache sees a change, append it to the hash
 
283
        # cache file, and have the parser take the most recent entry for a
 
284
        # given path only.
 
285
        cache_filename = self.bzrdir.get_workingtree_transport(None).local_abspath('stat-cache')
 
286
        hc = self._hashcache = HashCache(basedir, cache_filename, self._control_files._file_mode)
 
287
        hc.read()
 
288
        # is this scan needed ? it makes things kinda slow.
 
289
        #hc.scan()
 
290
 
 
291
        if hc.needs_write:
 
292
            mutter("write hc")
 
293
            hc.write()
 
294
 
 
295
        if _inventory is None:
 
296
            self._set_inventory(self.read_working_inventory())
 
297
        else:
 
298
            self._set_inventory(_inventory)
 
299
 
 
300
    branch = property(
 
301
        fget=lambda self: self._branch,
 
302
        doc="""The branch this WorkingTree is connected to.
 
303
 
 
304
            This cannot be set - it is reflective of the actual disk structure
 
305
            the working tree has been constructed from.
 
306
            """)
 
307
 
 
308
    def break_lock(self):
 
309
        """Break a lock if one is present from another instance.
 
310
 
 
311
        Uses the ui factory to ask for confirmation if the lock may be from
 
312
        an active process.
 
313
 
 
314
        This will probe the repository for its lock as well.
 
315
        """
 
316
        self._control_files.break_lock()
 
317
        self.branch.break_lock()
 
318
 
 
319
    def _set_inventory(self, inv):
 
320
        self._inventory = inv
 
321
        self.path2id = self._inventory.path2id
 
322
 
 
323
    def is_control_filename(self, filename):
 
324
        """True if filename is the name of a control file in this tree.
 
325
        
 
326
        :param filename: A filename within the tree. This is a relative path
 
327
        from the root of this tree.
 
328
 
 
329
        This is true IF and ONLY IF the filename is part of the meta data
 
330
        that bzr controls in this tree. I.E. a random .bzr directory placed
 
331
        on disk will not be a control file for this tree.
 
332
        """
 
333
        return self.bzrdir.is_control_filename(filename)
 
334
 
 
335
    @staticmethod
 
336
    def open(path=None, _unsupported=False):
 
337
        """Open an existing working tree at path.
 
338
 
 
339
        """
 
340
        if path is None:
 
341
            path = os.path.getcwdu()
 
342
        control = bzrdir.BzrDir.open(path, _unsupported)
 
343
        return control.open_workingtree(_unsupported)
 
344
        
 
345
    @staticmethod
 
346
    def open_containing(path=None):
 
347
        """Open an existing working tree which has its root about path.
 
348
        
 
349
        This probes for a working tree at path and searches upwards from there.
 
350
 
 
351
        Basically we keep looking up until we find the control directory or
 
352
        run into /.  If there isn't one, raises NotBranchError.
 
353
        TODO: give this a new exception.
 
354
        If there is one, it is returned, along with the unused portion of path.
 
355
 
 
356
        :return: The WorkingTree that contains 'path', and the rest of path
 
357
        """
 
358
        if path is None:
 
359
            path = os.getcwdu()
 
360
        control, relpath = bzrdir.BzrDir.open_containing(path)
 
361
 
 
362
        return control.open_workingtree(), relpath
 
363
 
 
364
    @staticmethod
 
365
    def open_downlevel(path=None):
 
366
        """Open an unsupported working tree.
 
367
 
 
368
        Only intended for advanced situations like upgrading part of a bzrdir.
 
369
        """
 
370
        return WorkingTree.open(path, _unsupported=True)
 
371
 
 
372
    def __iter__(self):
 
373
        """Iterate through file_ids for this tree.
 
374
 
 
375
        file_ids are in a WorkingTree if they are in the working inventory
 
376
        and the working file exists.
 
377
        """
 
378
        inv = self._inventory
 
379
        for path, ie in inv.iter_entries():
 
380
            if bzrlib.osutils.lexists(self.abspath(path)):
 
381
                yield ie.file_id
 
382
 
 
383
    def __repr__(self):
 
384
        return "<%s of %s>" % (self.__class__.__name__,
 
385
                               getattr(self, 'basedir', None))
 
386
 
 
387
    def abspath(self, filename):
 
388
        return pathjoin(self.basedir, filename)
 
389
    
 
390
    def basis_tree(self):
 
391
        """Return RevisionTree for the current last revision."""
 
392
        revision_id = self.last_revision()
 
393
        if revision_id is not None:
 
394
            try:
 
395
                xml = self.read_basis_inventory()
 
396
                inv = bzrlib.xml5.serializer_v5.read_inventory_from_string(xml)
 
397
            except NoSuchFile:
 
398
                inv = None
 
399
            if inv is not None and inv.revision_id == revision_id:
 
400
                return bzrlib.tree.RevisionTree(self.branch.repository, inv,
 
401
                                                revision_id)
 
402
        # FIXME? RBC 20060403 should we cache the inventory here ?
 
403
        return self.branch.repository.revision_tree(revision_id)
 
404
 
 
405
    @staticmethod
 
406
    @deprecated_method(zero_eight)
 
407
    def create(branch, directory):
 
408
        """Create a workingtree for branch at directory.
 
409
 
 
410
        If existing_directory already exists it must have a .bzr directory.
 
411
        If it does not exist, it will be created.
 
412
 
 
413
        This returns a new WorkingTree object for the new checkout.
 
414
 
 
415
        TODO FIXME RBC 20060124 when we have checkout formats in place this
 
416
        should accept an optional revisionid to checkout [and reject this if
 
417
        checking out into the same dir as a pre-checkout-aware branch format.]
 
418
 
 
419
        XXX: When BzrDir is present, these should be created through that 
 
420
        interface instead.
 
421
        """
 
422
        warnings.warn('delete WorkingTree.create', stacklevel=3)
 
423
        transport = get_transport(directory)
 
424
        if branch.bzrdir.root_transport.base == transport.base:
 
425
            # same dir 
 
426
            return branch.bzrdir.create_workingtree()
 
427
        # different directory, 
 
428
        # create a branch reference
 
429
        # and now a working tree.
 
430
        raise NotImplementedError
 
431
 
 
432
    @staticmethod
 
433
    @deprecated_method(zero_eight)
 
434
    def create_standalone(directory):
 
435
        """Create a checkout and a branch and a repo at directory.
 
436
 
 
437
        Directory must exist and be empty.
 
438
 
 
439
        please use BzrDir.create_standalone_workingtree
 
440
        """
 
441
        return bzrdir.BzrDir.create_standalone_workingtree(directory)
 
442
 
 
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 relpath(self.basedir, path)
 
450
 
 
451
    def has_filename(self, filename):
 
452
        return bzrlib.osutils.lexists(self.abspath(filename))
 
453
 
 
454
    def get_file(self, file_id):
 
455
        return self.get_file_byname(self.id2path(file_id))
 
456
 
 
457
    def get_file_byname(self, filename):
 
458
        return file(self.abspath(filename), 'rb')
 
459
 
 
460
    def get_parent_ids(self):
 
461
        """See Tree.get_parent_ids.
 
462
        
 
463
        This implementation reads the pending merges list and last_revision
 
464
        value and uses that to decide what the parents list should be.
 
465
        """
 
466
        last_rev = self.last_revision()
 
467
        if last_rev is None:
 
468
            parents = []
 
469
        else:
 
470
            parents = [last_rev]
 
471
        other_parents = self.pending_merges()
 
472
        return parents + other_parents
 
473
 
 
474
    def get_root_id(self):
 
475
        """Return the id of this trees root"""
 
476
        inv = self.read_working_inventory()
 
477
        return inv.root.file_id
 
478
        
 
479
    def _get_store_filename(self, file_id):
 
480
        ## XXX: badly named; this is not in the store at all
 
481
        return self.abspath(self.id2path(file_id))
 
482
 
 
483
    @needs_read_lock
 
484
    def clone(self, to_bzrdir, revision_id=None, basis=None):
 
485
        """Duplicate this working tree into to_bzr, including all state.
 
486
        
 
487
        Specifically modified files are kept as modified, but
 
488
        ignored and unknown files are discarded.
 
489
 
 
490
        If you want to make a new line of development, see bzrdir.sprout()
 
491
 
 
492
        revision
 
493
            If not None, the cloned tree will have its last revision set to 
 
494
            revision, and and difference between the source trees last revision
 
495
            and this one merged in.
 
496
 
 
497
        basis
 
498
            If not None, a closer copy of a tree which may have some files in
 
499
            common, and which file content should be preferentially copied from.
 
500
        """
 
501
        # assumes the target bzr dir format is compatible.
 
502
        result = self._format.initialize(to_bzrdir)
 
503
        self.copy_content_into(result, revision_id)
 
504
        return result
 
505
 
 
506
    @needs_read_lock
 
507
    def copy_content_into(self, tree, revision_id=None):
 
508
        """Copy the current content and user files of this tree into tree."""
 
509
        if revision_id is None:
 
510
            transform_tree(tree, self)
 
511
        else:
 
512
            # TODO now merge from tree.last_revision to revision
 
513
            transform_tree(tree, self)
 
514
            tree.set_last_revision(revision_id)
 
515
 
 
516
    @needs_write_lock
 
517
    def commit(self, message=None, revprops=None, *args, **kwargs):
 
518
        # avoid circular imports
 
519
        from bzrlib.commit import Commit
 
520
        if revprops is None:
 
521
            revprops = {}
 
522
        if not 'branch-nick' in revprops:
 
523
            revprops['branch-nick'] = self.branch.nick
 
524
        # args for wt.commit start at message from the Commit.commit method,
 
525
        # but with branch a kwarg now, passing in args as is results in the
 
526
        #message being used for the branch
 
527
        args = (DEPRECATED_PARAMETER, message, ) + args
 
528
        committed_id = Commit().commit( working_tree=self, revprops=revprops,
 
529
            *args, **kwargs)
 
530
        self._set_inventory(self.read_working_inventory())
 
531
        return committed_id
 
532
 
 
533
    def id2abspath(self, file_id):
 
534
        return self.abspath(self.id2path(file_id))
 
535
 
 
536
    def has_id(self, file_id):
 
537
        # files that have been deleted are excluded
 
538
        inv = self._inventory
 
539
        if not inv.has_id(file_id):
 
540
            return False
 
541
        path = inv.id2path(file_id)
 
542
        return bzrlib.osutils.lexists(self.abspath(path))
 
543
 
 
544
    def has_or_had_id(self, file_id):
 
545
        if file_id == self.inventory.root.file_id:
 
546
            return True
 
547
        return self.inventory.has_id(file_id)
 
548
 
 
549
    __contains__ = has_id
 
550
 
 
551
    def get_file_size(self, file_id):
 
552
        return os.path.getsize(self.id2abspath(file_id))
 
553
 
 
554
    @needs_read_lock
 
555
    def get_file_sha1(self, file_id, path=None):
 
556
        if not path:
 
557
            path = self._inventory.id2path(file_id)
 
558
        return self._hashcache.get_sha1(path)
 
559
 
 
560
    def get_file_mtime(self, file_id, path=None):
 
561
        if not path:
 
562
            path = self._inventory.id2path(file_id)
 
563
        return os.lstat(self.abspath(path)).st_mtime
 
564
 
 
565
    if not supports_executable():
 
566
        def is_executable(self, file_id, path=None):
 
567
            return self._inventory[file_id].executable
 
568
    else:
 
569
        def is_executable(self, file_id, path=None):
 
570
            if not path:
 
571
                path = self._inventory.id2path(file_id)
 
572
            mode = os.lstat(self.abspath(path)).st_mode
 
573
            return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
 
574
 
 
575
    @needs_write_lock
 
576
    def add(self, files, ids=None):
 
577
        """Make files versioned.
 
578
 
 
579
        Note that the command line normally calls smart_add instead,
 
580
        which can automatically recurse.
 
581
 
 
582
        This adds the files to the inventory, so that they will be
 
583
        recorded by the next commit.
 
584
 
 
585
        files
 
586
            List of paths to add, relative to the base of the tree.
 
587
 
 
588
        ids
 
589
            If set, use these instead of automatically generated ids.
 
590
            Must be the same length as the list of files, but may
 
591
            contain None for ids that are to be autogenerated.
 
592
 
 
593
        TODO: Perhaps have an option to add the ids even if the files do
 
594
              not (yet) exist.
 
595
 
 
596
        TODO: Perhaps callback with the ids and paths as they're added.
 
597
        """
 
598
        # TODO: Re-adding a file that is removed in the working copy
 
599
        # should probably put it back with the previous ID.
 
600
        if isinstance(files, basestring):
 
601
            assert(ids is None or isinstance(ids, basestring))
 
602
            files = [files]
 
603
            if ids is not None:
 
604
                ids = [ids]
 
605
 
 
606
        if ids is None:
 
607
            ids = [None] * len(files)
 
608
        else:
 
609
            assert(len(ids) == len(files))
 
610
 
 
611
        inv = self.read_working_inventory()
 
612
        for f,file_id in zip(files, ids):
 
613
            if self.is_control_filename(f):
 
614
                raise errors.ForbiddenControlFileError(filename=f)
 
615
 
 
616
            fp = splitpath(f)
 
617
 
 
618
            if len(fp) == 0:
 
619
                raise BzrError("cannot add top-level %r" % f)
 
620
 
 
621
            fullpath = normpath(self.abspath(f))
 
622
            try:
 
623
                kind = file_kind(fullpath)
 
624
            except OSError, e:
 
625
                if e.errno == errno.ENOENT:
 
626
                    raise NoSuchFile(fullpath)
 
627
            if not InventoryEntry.versionable_kind(kind):
 
628
                raise errors.BadFileKindError(filename=f, kind=kind)
 
629
            if file_id is None:
 
630
                inv.add_path(f, kind=kind)
 
631
            else:
 
632
                inv.add_path(f, kind=kind, file_id=file_id)
 
633
 
 
634
        self._write_inventory(inv)
 
635
 
 
636
    @needs_write_lock
 
637
    def add_pending_merge(self, *revision_ids):
 
638
        # TODO: Perhaps should check at this point that the
 
639
        # history of the revision is actually present?
 
640
        p = self.pending_merges()
 
641
        updated = False
 
642
        for rev_id in revision_ids:
 
643
            if rev_id in p:
 
644
                continue
 
645
            p.append(rev_id)
 
646
            updated = True
 
647
        if updated:
 
648
            self.set_pending_merges(p)
 
649
 
 
650
    @needs_read_lock
 
651
    def pending_merges(self):
 
652
        """Return a list of pending merges.
 
653
 
 
654
        These are revisions that have been merged into the working
 
655
        directory but not yet committed.
 
656
        """
 
657
        try:
 
658
            merges_file = self._control_files.get_utf8('pending-merges')
 
659
        except OSError, e:
 
660
            if e.errno != errno.ENOENT:
 
661
                raise
 
662
            return []
 
663
        p = []
 
664
        for l in merges_file.readlines():
 
665
            p.append(l.rstrip('\n'))
 
666
        return p
 
667
 
 
668
    @needs_write_lock
 
669
    def set_pending_merges(self, rev_list):
 
670
        self._control_files.put_utf8('pending-merges', '\n'.join(rev_list))
 
671
 
 
672
    @needs_write_lock
 
673
    def set_merge_modified(self, modified_hashes):
 
674
        def iter_stanzas():
 
675
            for file_id, hash in modified_hashes.iteritems():
 
676
                yield Stanza(file_id=file_id, hash=hash)
 
677
        self._put_rio('merge-hashes', iter_stanzas(), MERGE_MODIFIED_HEADER_1)
 
678
 
 
679
    @needs_write_lock
 
680
    def _put_rio(self, filename, stanzas, header):
 
681
        my_file = rio_file(stanzas, header)
 
682
        self._control_files.put(filename, my_file)
 
683
 
 
684
    @needs_read_lock
 
685
    def merge_modified(self):
 
686
        try:
 
687
            hashfile = self._control_files.get('merge-hashes')
 
688
        except NoSuchFile:
 
689
            return {}
 
690
        merge_hashes = {}
 
691
        try:
 
692
            if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
 
693
                raise MergeModifiedFormatError()
 
694
        except StopIteration:
 
695
            raise MergeModifiedFormatError()
 
696
        for s in RioReader(hashfile):
 
697
            file_id = s.get("file_id")
 
698
            if file_id not in self.inventory:
 
699
                continue
 
700
            hash = s.get("hash")
 
701
            if hash == self.get_file_sha1(file_id):
 
702
                merge_hashes[file_id] = hash
 
703
        return merge_hashes
 
704
 
 
705
    def get_symlink_target(self, file_id):
 
706
        return os.readlink(self.id2abspath(file_id))
 
707
 
 
708
    def file_class(self, filename):
 
709
        if self.path2id(filename):
 
710
            return 'V'
 
711
        elif self.is_ignored(filename):
 
712
            return 'I'
 
713
        else:
 
714
            return '?'
 
715
 
 
716
    def list_files(self):
 
717
        """Recursively list all files as (path, class, kind, id, entry).
 
718
 
 
719
        Lists, but does not descend into unversioned directories.
 
720
 
 
721
        This does not include files that have been deleted in this
 
722
        tree.
 
723
 
 
724
        Skips the control directory.
 
725
        """
 
726
        inv = self._inventory
 
727
        # Convert these into local objects to save lookup times
 
728
        pathjoin = bzrlib.osutils.pathjoin
 
729
        file_kind = bzrlib.osutils.file_kind
 
730
 
 
731
        # transport.base ends in a slash, we want the piece
 
732
        # between the last two slashes
 
733
        transport_base_dir = self.bzrdir.transport.base.rsplit('/', 2)[1]
 
734
 
 
735
        fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
 
736
 
 
737
        # directory file_id, relative path, absolute path, reverse sorted children
 
738
        children = os.listdir(self.basedir)
 
739
        children.sort()
 
740
        # jam 20060527 The kernel sized tree seems equivalent whether we 
 
741
        # use a deque and popleft to keep them sorted, or if we use a plain
 
742
        # list and just reverse() them.
 
743
        children = collections.deque(children)
 
744
        stack = [(inv.root.file_id, u'', self.basedir, children)]
 
745
        while stack:
 
746
            from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
 
747
 
 
748
            while children:
 
749
                f = children.popleft()
 
750
                ## TODO: If we find a subdirectory with its own .bzr
 
751
                ## directory, then that is a separate tree and we
 
752
                ## should exclude it.
 
753
 
 
754
                # the bzrdir for this tree
 
755
                if transport_base_dir == f:
 
756
                    continue
 
757
 
 
758
                # we know that from_dir_relpath and from_dir_abspath never end in a slash
 
759
                # and 'f' doesn't begin with one, we can do a string op, rather
 
760
                # than the checks of pathjoin(), all relative paths will have an extra slash
 
761
                # at the beginning
 
762
                fp = from_dir_relpath + '/' + f
 
763
 
 
764
                # absolute path
 
765
                fap = from_dir_abspath + '/' + f
 
766
                
 
767
                f_ie = inv.get_child(from_dir_id, f)
 
768
                if f_ie:
 
769
                    c = 'V'
 
770
                elif self.is_ignored(fp[1:]):
 
771
                    c = 'I'
 
772
                else:
 
773
                    c = '?'
 
774
 
 
775
                fk = file_kind(fap)
 
776
 
 
777
                if f_ie:
 
778
                    if f_ie.kind != fk:
 
779
                        raise BzrCheckError("file %r entered as kind %r id %r, "
 
780
                                            "now of kind %r"
 
781
                                            % (fap, f_ie.kind, f_ie.file_id, fk))
 
782
 
 
783
                # make a last minute entry
 
784
                if f_ie:
 
785
                    yield fp[1:], c, fk, f_ie.file_id, f_ie
 
786
                else:
 
787
                    try:
 
788
                        yield fp[1:], c, fk, None, fk_entries[fk]()
 
789
                    except KeyError:
 
790
                        yield fp[1:], c, fk, None, TreeEntry()
 
791
                    continue
 
792
                
 
793
                if fk != 'directory':
 
794
                    continue
 
795
 
 
796
                # But do this child first
 
797
                new_children = os.listdir(fap)
 
798
                new_children.sort()
 
799
                new_children = collections.deque(new_children)
 
800
                stack.append((f_ie.file_id, fp, fap, new_children))
 
801
                # Break out of inner loop, so that we start outer loop with child
 
802
                break
 
803
            else:
 
804
                # if we finished all children, pop it off the stack
 
805
                stack.pop()
 
806
 
 
807
 
 
808
    @needs_write_lock
 
809
    def move(self, from_paths, to_name):
 
810
        """Rename files.
 
811
 
 
812
        to_name must exist in the inventory.
 
813
 
 
814
        If to_name exists and is a directory, the files are moved into
 
815
        it, keeping their old names.  
 
816
 
 
817
        Note that to_name is only the last component of the new name;
 
818
        this doesn't change the directory.
 
819
 
 
820
        This returns a list of (from_path, to_path) pairs for each
 
821
        entry that is moved.
 
822
        """
 
823
        result = []
 
824
        ## TODO: Option to move IDs only
 
825
        assert not isinstance(from_paths, basestring)
 
826
        inv = self.inventory
 
827
        to_abs = self.abspath(to_name)
 
828
        if not isdir(to_abs):
 
829
            raise BzrError("destination %r is not a directory" % to_abs)
 
830
        if not self.has_filename(to_name):
 
831
            raise BzrError("destination %r not in working directory" % to_abs)
 
832
        to_dir_id = inv.path2id(to_name)
 
833
        if to_dir_id == None and to_name != '':
 
834
            raise BzrError("destination %r is not a versioned directory" % to_name)
 
835
        to_dir_ie = inv[to_dir_id]
 
836
        if to_dir_ie.kind not in ('directory', 'root_directory'):
 
837
            raise BzrError("destination %r is not a directory" % to_abs)
 
838
 
 
839
        to_idpath = inv.get_idpath(to_dir_id)
 
840
 
 
841
        for f in from_paths:
 
842
            if not self.has_filename(f):
 
843
                raise BzrError("%r does not exist in working tree" % f)
 
844
            f_id = inv.path2id(f)
 
845
            if f_id == None:
 
846
                raise BzrError("%r is not versioned" % f)
 
847
            name_tail = splitpath(f)[-1]
 
848
            dest_path = pathjoin(to_name, name_tail)
 
849
            if self.has_filename(dest_path):
 
850
                raise BzrError("destination %r already exists" % dest_path)
 
851
            if f_id in to_idpath:
 
852
                raise BzrError("can't move %r to a subdirectory of itself" % f)
 
853
 
 
854
        # OK, so there's a race here, it's possible that someone will
 
855
        # create a file in this interval and then the rename might be
 
856
        # left half-done.  But we should have caught most problems.
 
857
        orig_inv = deepcopy(self.inventory)
 
858
        try:
 
859
            for f in from_paths:
 
860
                name_tail = splitpath(f)[-1]
 
861
                dest_path = pathjoin(to_name, name_tail)
 
862
                result.append((f, dest_path))
 
863
                inv.rename(inv.path2id(f), to_dir_id, name_tail)
 
864
                try:
 
865
                    rename(self.abspath(f), self.abspath(dest_path))
 
866
                except OSError, e:
 
867
                    raise BzrError("failed to rename %r to %r: %s" %
 
868
                                   (f, dest_path, e[1]),
 
869
                            ["rename rolled back"])
 
870
        except:
 
871
            # restore the inventory on error
 
872
            self._set_inventory(orig_inv)
 
873
            raise
 
874
        self._write_inventory(inv)
 
875
        return result
 
876
 
 
877
    @needs_write_lock
 
878
    def rename_one(self, from_rel, to_rel):
 
879
        """Rename one file.
 
880
 
 
881
        This can change the directory or the filename or both.
 
882
        """
 
883
        inv = self.inventory
 
884
        if not self.has_filename(from_rel):
 
885
            raise BzrError("can't rename: old working file %r does not exist" % from_rel)
 
886
        if self.has_filename(to_rel):
 
887
            raise BzrError("can't rename: new working file %r already exists" % to_rel)
 
888
 
 
889
        file_id = inv.path2id(from_rel)
 
890
        if file_id == None:
 
891
            raise BzrError("can't rename: old name %r is not versioned" % from_rel)
 
892
 
 
893
        entry = inv[file_id]
 
894
        from_parent = entry.parent_id
 
895
        from_name = entry.name
 
896
        
 
897
        if inv.path2id(to_rel):
 
898
            raise BzrError("can't rename: new name %r is already versioned" % to_rel)
 
899
 
 
900
        to_dir, to_tail = os.path.split(to_rel)
 
901
        to_dir_id = inv.path2id(to_dir)
 
902
        if to_dir_id == None and to_dir != '':
 
903
            raise BzrError("can't determine destination directory id for %r" % to_dir)
 
904
 
 
905
        mutter("rename_one:")
 
906
        mutter("  file_id    {%s}" % file_id)
 
907
        mutter("  from_rel   %r" % from_rel)
 
908
        mutter("  to_rel     %r" % to_rel)
 
909
        mutter("  to_dir     %r" % to_dir)
 
910
        mutter("  to_dir_id  {%s}" % to_dir_id)
 
911
 
 
912
        inv.rename(file_id, to_dir_id, to_tail)
 
913
 
 
914
        from_abs = self.abspath(from_rel)
 
915
        to_abs = self.abspath(to_rel)
 
916
        try:
 
917
            rename(from_abs, to_abs)
 
918
        except OSError, e:
 
919
            inv.rename(file_id, from_parent, from_name)
 
920
            raise BzrError("failed to rename %r to %r: %s"
 
921
                    % (from_abs, to_abs, e[1]),
 
922
                    ["rename rolled back"])
 
923
        self._write_inventory(inv)
 
924
 
 
925
    @needs_read_lock
 
926
    def unknowns(self):
 
927
        """Return all unknown files.
 
928
 
 
929
        These are files in the working directory that are not versioned or
 
930
        control files or ignored.
 
931
        
 
932
        >>> from bzrlib.bzrdir import ScratchDir
 
933
        >>> d = ScratchDir(files=['foo', 'foo~'])
 
934
        >>> b = d.open_branch()
 
935
        >>> tree = d.open_workingtree()
 
936
        >>> map(str, tree.unknowns())
 
937
        ['foo']
 
938
        >>> tree.add('foo')
 
939
        >>> list(b.unknowns())
 
940
        []
 
941
        >>> tree.remove('foo')
 
942
        >>> list(b.unknowns())
 
943
        [u'foo']
 
944
        """
 
945
        for subp in self.extras():
 
946
            if not self.is_ignored(subp):
 
947
                yield subp
 
948
 
 
949
    @deprecated_method(zero_eight)
 
950
    def iter_conflicts(self):
 
951
        """List all files in the tree that have text or content conflicts.
 
952
        DEPRECATED.  Use conflicts instead."""
 
953
        return self._iter_conflicts()
 
954
 
 
955
    def _iter_conflicts(self):
 
956
        conflicted = set()
 
957
        for info in self.list_files():
 
958
            path = info[0]
 
959
            stem = get_conflicted_stem(path)
 
960
            if stem is None:
 
961
                continue
 
962
            if stem not in conflicted:
 
963
                conflicted.add(stem)
 
964
                yield stem
 
965
 
 
966
    @needs_write_lock
 
967
    def pull(self, source, overwrite=False, stop_revision=None):
 
968
        top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
969
        source.lock_read()
 
970
        try:
 
971
            pp = ProgressPhase("Pull phase", 2, top_pb)
 
972
            pp.next_phase()
 
973
            old_revision_history = self.branch.revision_history()
 
974
            basis_tree = self.basis_tree()
 
975
            count = self.branch.pull(source, overwrite, stop_revision)
 
976
            new_revision_history = self.branch.revision_history()
 
977
            if new_revision_history != old_revision_history:
 
978
                pp.next_phase()
 
979
                if len(old_revision_history):
 
980
                    other_revision = old_revision_history[-1]
 
981
                else:
 
982
                    other_revision = None
 
983
                repository = self.branch.repository
 
984
                pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
985
                try:
 
986
                    merge_inner(self.branch,
 
987
                                self.branch.basis_tree(),
 
988
                                basis_tree, 
 
989
                                this_tree=self, 
 
990
                                pb=pb)
 
991
                finally:
 
992
                    pb.finished()
 
993
                self.set_last_revision(self.branch.last_revision())
 
994
            return count
 
995
        finally:
 
996
            source.unlock()
 
997
            top_pb.finished()
 
998
 
 
999
    def extras(self):
 
1000
        """Yield all unknown files in this WorkingTree.
 
1001
 
 
1002
        If there are any unknown directories then only the directory is
 
1003
        returned, not all its children.  But if there are unknown files
 
1004
        under a versioned subdirectory, they are returned.
 
1005
 
 
1006
        Currently returned depth-first, sorted by name within directories.
 
1007
        """
 
1008
        ## TODO: Work from given directory downwards
 
1009
        for path, dir_entry in self.inventory.directories():
 
1010
            mutter("search for unknowns in %r", path)
 
1011
            dirabs = self.abspath(path)
 
1012
            if not isdir(dirabs):
 
1013
                # e.g. directory deleted
 
1014
                continue
 
1015
 
 
1016
            fl = []
 
1017
            for subf in os.listdir(dirabs):
 
1018
                if (subf != '.bzr'
 
1019
                    and (subf not in dir_entry.children)):
 
1020
                    fl.append(subf)
 
1021
            
 
1022
            fl.sort()
 
1023
            for subf in fl:
 
1024
                subp = pathjoin(path, subf)
 
1025
                yield subp
 
1026
 
 
1027
    def _translate_ignore_rule(self, rule):
 
1028
        """Translate a single ignore rule to a regex.
 
1029
 
 
1030
        There are two types of ignore rules.  Those that do not contain a / are
 
1031
        matched against the tail of the filename (that is, they do not care
 
1032
        what directory the file is in.)  Rules which do contain a slash must
 
1033
        match the entire path.  As a special case, './' at the start of the
 
1034
        string counts as a slash in the string but is removed before matching
 
1035
        (e.g. ./foo.c, ./src/foo.c)
 
1036
 
 
1037
        :return: The translated regex.
 
1038
        """
 
1039
        if rule[:2] in ('./', '.\\'):
 
1040
            # rootdir rule
 
1041
            result = fnmatch.translate(rule[2:])
 
1042
        elif '/' in rule or '\\' in rule:
 
1043
            # path prefix 
 
1044
            result = fnmatch.translate(rule)
 
1045
        else:
 
1046
            # default rule style.
 
1047
            result = "(?:.*/)?(?!.*/)" + fnmatch.translate(rule)
 
1048
        assert result[-1] == '$', "fnmatch.translate did not add the expected $"
 
1049
        return "(" + result + ")"
 
1050
 
 
1051
    def _combine_ignore_rules(self, rules):
 
1052
        """Combine a list of ignore rules into a single regex object.
 
1053
 
 
1054
        Each individual rule is combined with | to form a big regex, which then
 
1055
        has $ added to it to form something like ()|()|()$. The group index for
 
1056
        each subregex's outermost group is placed in a dictionary mapping back 
 
1057
        to the rule. This allows quick identification of the matching rule that
 
1058
        triggered a match.
 
1059
        :return: a list of the compiled regex and the matching-group index 
 
1060
        dictionaries. We return a list because python complains if you try to 
 
1061
        combine more than 100 regexes.
 
1062
        """
 
1063
        result = []
 
1064
        groups = {}
 
1065
        next_group = 0
 
1066
        translated_rules = []
 
1067
        for rule in rules:
 
1068
            translated_rule = self._translate_ignore_rule(rule)
 
1069
            compiled_rule = re.compile(translated_rule)
 
1070
            groups[next_group] = rule
 
1071
            next_group += compiled_rule.groups
 
1072
            translated_rules.append(translated_rule)
 
1073
            if next_group == 99:
 
1074
                result.append((re.compile("|".join(translated_rules)), groups))
 
1075
                groups = {}
 
1076
                next_group = 0
 
1077
                translated_rules = []
 
1078
        if len(translated_rules):
 
1079
            result.append((re.compile("|".join(translated_rules)), groups))
 
1080
        return result
 
1081
 
 
1082
    def ignored_files(self):
 
1083
        """Yield list of PATH, IGNORE_PATTERN"""
 
1084
        for subp in self.extras():
 
1085
            pat = self.is_ignored(subp)
 
1086
            if pat != None:
 
1087
                yield subp, pat
 
1088
 
 
1089
    def get_ignore_list(self):
 
1090
        """Return list of ignore patterns.
 
1091
 
 
1092
        Cached in the Tree object after the first call.
 
1093
        """
 
1094
        if hasattr(self, '_ignorelist'):
 
1095
            return self._ignorelist
 
1096
 
 
1097
        l = bzrlib.DEFAULT_IGNORE[:]
 
1098
        if self.has_filename(bzrlib.IGNORE_FILENAME):
 
1099
            f = self.get_file_byname(bzrlib.IGNORE_FILENAME)
 
1100
            l.extend([line.rstrip("\n\r").decode('utf-8') 
 
1101
                      for line in f.readlines()])
 
1102
        self._ignorelist = l
 
1103
        self._ignore_regex = self._combine_ignore_rules(l)
 
1104
        return l
 
1105
 
 
1106
    def _get_ignore_rules_as_regex(self):
 
1107
        """Return a regex of the ignore rules and a mapping dict.
 
1108
 
 
1109
        :return: (ignore rules compiled regex, dictionary mapping rule group 
 
1110
        indices to original rule.)
 
1111
        """
 
1112
        if getattr(self, '_ignorelist', None) is None:
 
1113
            self.get_ignore_list()
 
1114
        return self._ignore_regex
 
1115
 
 
1116
    def is_ignored(self, filename):
 
1117
        r"""Check whether the filename matches an ignore pattern.
 
1118
 
 
1119
        Patterns containing '/' or '\' need to match the whole path;
 
1120
        others match against only the last component.
 
1121
 
 
1122
        If the file is ignored, returns the pattern which caused it to
 
1123
        be ignored, otherwise None.  So this can simply be used as a
 
1124
        boolean if desired."""
 
1125
 
 
1126
        # TODO: Use '**' to match directories, and other extended
 
1127
        # globbing stuff from cvs/rsync.
 
1128
 
 
1129
        # XXX: fnmatch is actually not quite what we want: it's only
 
1130
        # approximately the same as real Unix fnmatch, and doesn't
 
1131
        # treat dotfiles correctly and allows * to match /.
 
1132
        # Eventually it should be replaced with something more
 
1133
        # accurate.
 
1134
    
 
1135
        rules = self._get_ignore_rules_as_regex()
 
1136
        for regex, mapping in rules:
 
1137
            match = regex.match(filename)
 
1138
            if match is not None:
 
1139
                # one or more of the groups in mapping will have a non-None group 
 
1140
                # match.
 
1141
                groups = match.groups()
 
1142
                rules = [mapping[group] for group in 
 
1143
                    mapping if groups[group] is not None]
 
1144
                return rules[0]
 
1145
        return None
 
1146
 
 
1147
    def kind(self, file_id):
 
1148
        return file_kind(self.id2abspath(file_id))
 
1149
 
 
1150
    @needs_read_lock
 
1151
    def last_revision(self):
 
1152
        """Return the last revision id of this working tree.
 
1153
 
 
1154
        In early branch formats this was == the branch last_revision,
 
1155
        but that cannot be relied upon - for working tree operations,
 
1156
        always use tree.last_revision().
 
1157
        """
 
1158
        return self.branch.last_revision()
 
1159
 
 
1160
    def is_locked(self):
 
1161
        return self._control_files.is_locked()
 
1162
 
 
1163
    def lock_read(self):
 
1164
        """See Branch.lock_read, and WorkingTree.unlock."""
 
1165
        self.branch.lock_read()
 
1166
        try:
 
1167
            return self._control_files.lock_read()
 
1168
        except:
 
1169
            self.branch.unlock()
 
1170
            raise
 
1171
 
 
1172
    def lock_write(self):
 
1173
        """See Branch.lock_write, and WorkingTree.unlock."""
 
1174
        self.branch.lock_write()
 
1175
        try:
 
1176
            return self._control_files.lock_write()
 
1177
        except:
 
1178
            self.branch.unlock()
 
1179
            raise
 
1180
 
 
1181
    def get_physical_lock_status(self):
 
1182
        return self._control_files.get_physical_lock_status()
 
1183
 
 
1184
    def _basis_inventory_name(self):
 
1185
        return 'basis-inventory'
 
1186
 
 
1187
    @needs_write_lock
 
1188
    def set_last_revision(self, new_revision):
 
1189
        """Change the last revision in the working tree."""
 
1190
        if self._change_last_revision(new_revision):
 
1191
            self._cache_basis_inventory(new_revision)
 
1192
 
 
1193
    def _change_last_revision(self, new_revision):
 
1194
        """Template method part of set_last_revision to perform the change.
 
1195
        
 
1196
        This is used to allow WorkingTree3 instances to not affect branch
 
1197
        when their last revision is set.
 
1198
        """
 
1199
        if new_revision is None:
 
1200
            self.branch.set_revision_history([])
 
1201
            return False
 
1202
        # current format is locked in with the branch
 
1203
        revision_history = self.branch.revision_history()
 
1204
        try:
 
1205
            position = revision_history.index(new_revision)
 
1206
        except ValueError:
 
1207
            raise errors.NoSuchRevision(self.branch, new_revision)
 
1208
        self.branch.set_revision_history(revision_history[:position + 1])
 
1209
        return True
 
1210
 
 
1211
    def _cache_basis_inventory(self, new_revision):
 
1212
        """Cache new_revision as the basis inventory."""
 
1213
        # TODO: this should allow the ready-to-use inventory to be passed in,
 
1214
        # as commit already has that ready-to-use [while the format is the
 
1215
        # same, that is].
 
1216
        try:
 
1217
            # this double handles the inventory - unpack and repack - 
 
1218
            # but is easier to understand. We can/should put a conditional
 
1219
            # in here based on whether the inventory is in the latest format
 
1220
            # - perhaps we should repack all inventories on a repository
 
1221
            # upgrade ?
 
1222
            # the fast path is to copy the raw xml from the repository. If the
 
1223
            # xml contains 'revision_id="', then we assume the right 
 
1224
            # revision_id is set. We must check for this full string, because a
 
1225
            # root node id can legitimately look like 'revision_id' but cannot
 
1226
            # contain a '"'.
 
1227
            xml = self.branch.repository.get_inventory_xml(new_revision)
 
1228
            if not 'revision_id="' in xml.split('\n', 1)[0]:
 
1229
                inv = self.branch.repository.deserialise_inventory(
 
1230
                    new_revision, xml)
 
1231
                inv.revision_id = new_revision
 
1232
                xml = bzrlib.xml5.serializer_v5.write_inventory_to_string(inv)
 
1233
            assert isinstance(xml, str), 'serialised xml must be bytestring.'
 
1234
            path = self._basis_inventory_name()
 
1235
            sio = StringIO(xml)
 
1236
            self._control_files.put(path, sio)
 
1237
        except WeaveRevisionNotPresent:
 
1238
            pass
 
1239
 
 
1240
    def read_basis_inventory(self):
 
1241
        """Read the cached basis inventory."""
 
1242
        path = self._basis_inventory_name()
 
1243
        return self._control_files.get(path).read()
 
1244
        
 
1245
    @needs_read_lock
 
1246
    def read_working_inventory(self):
 
1247
        """Read the working inventory."""
 
1248
        # ElementTree does its own conversion from UTF-8, so open in
 
1249
        # binary.
 
1250
        result = bzrlib.xml5.serializer_v5.read_inventory(
 
1251
            self._control_files.get('inventory'))
 
1252
        self._set_inventory(result)
 
1253
        return result
 
1254
 
 
1255
    @needs_write_lock
 
1256
    def remove(self, files, verbose=False, to_file=None):
 
1257
        """Remove nominated files from the working inventory..
 
1258
 
 
1259
        This does not remove their text.  This does not run on XXX on what? RBC
 
1260
 
 
1261
        TODO: Refuse to remove modified files unless --force is given?
 
1262
 
 
1263
        TODO: Do something useful with directories.
 
1264
 
 
1265
        TODO: Should this remove the text or not?  Tough call; not
 
1266
        removing may be useful and the user can just use use rm, and
 
1267
        is the opposite of add.  Removing it is consistent with most
 
1268
        other tools.  Maybe an option.
 
1269
        """
 
1270
        ## TODO: Normalize names
 
1271
        ## TODO: Remove nested loops; better scalability
 
1272
        if isinstance(files, basestring):
 
1273
            files = [files]
 
1274
 
 
1275
        inv = self.inventory
 
1276
 
 
1277
        # do this before any modifications
 
1278
        for f in files:
 
1279
            fid = inv.path2id(f)
 
1280
            if not fid:
 
1281
                # TODO: Perhaps make this just a warning, and continue?
 
1282
                # This tends to happen when 
 
1283
                raise NotVersionedError(path=f)
 
1284
            if verbose:
 
1285
                # having remove it, it must be either ignored or unknown
 
1286
                if self.is_ignored(f):
 
1287
                    new_status = 'I'
 
1288
                else:
 
1289
                    new_status = '?'
 
1290
                show_status(new_status, inv[fid].kind, f, to_file=to_file)
 
1291
            del inv[fid]
 
1292
 
 
1293
        self._write_inventory(inv)
 
1294
 
 
1295
    @needs_write_lock
 
1296
    def revert(self, filenames, old_tree=None, backups=True, 
 
1297
               pb=DummyProgress()):
 
1298
        from transform import revert
 
1299
        from conflicts import resolve
 
1300
        if old_tree is None:
 
1301
            old_tree = self.basis_tree()
 
1302
        conflicts = revert(self, old_tree, filenames, backups, pb)
 
1303
        if not len(filenames):
 
1304
            self.set_pending_merges([])
 
1305
            resolve(self)
 
1306
        else:
 
1307
            resolve(self, filenames, ignore_misses=True)
 
1308
        return conflicts
 
1309
 
 
1310
    # XXX: This method should be deprecated in favour of taking in a proper
 
1311
    # new Inventory object.
 
1312
    @needs_write_lock
 
1313
    def set_inventory(self, new_inventory_list):
 
1314
        from bzrlib.inventory import (Inventory,
 
1315
                                      InventoryDirectory,
 
1316
                                      InventoryEntry,
 
1317
                                      InventoryFile,
 
1318
                                      InventoryLink)
 
1319
        inv = Inventory(self.get_root_id())
 
1320
        for path, file_id, parent, kind in new_inventory_list:
 
1321
            name = os.path.basename(path)
 
1322
            if name == "":
 
1323
                continue
 
1324
            # fixme, there should be a factory function inv,add_?? 
 
1325
            if kind == 'directory':
 
1326
                inv.add(InventoryDirectory(file_id, name, parent))
 
1327
            elif kind == 'file':
 
1328
                inv.add(InventoryFile(file_id, name, parent))
 
1329
            elif kind == 'symlink':
 
1330
                inv.add(InventoryLink(file_id, name, parent))
 
1331
            else:
 
1332
                raise BzrError("unknown kind %r" % kind)
 
1333
        self._write_inventory(inv)
 
1334
 
 
1335
    @needs_write_lock
 
1336
    def set_root_id(self, file_id):
 
1337
        """Set the root id for this tree."""
 
1338
        inv = self.read_working_inventory()
 
1339
        orig_root_id = inv.root.file_id
 
1340
        del inv._byid[inv.root.file_id]
 
1341
        inv.root.file_id = file_id
 
1342
        inv._byid[inv.root.file_id] = inv.root
 
1343
        for fid in inv:
 
1344
            entry = inv[fid]
 
1345
            if entry.parent_id == orig_root_id:
 
1346
                entry.parent_id = inv.root.file_id
 
1347
        self._write_inventory(inv)
 
1348
 
 
1349
    def unlock(self):
 
1350
        """See Branch.unlock.
 
1351
        
 
1352
        WorkingTree locking just uses the Branch locking facilities.
 
1353
        This is current because all working trees have an embedded branch
 
1354
        within them. IF in the future, we were to make branch data shareable
 
1355
        between multiple working trees, i.e. via shared storage, then we 
 
1356
        would probably want to lock both the local tree, and the branch.
 
1357
        """
 
1358
        # FIXME: We want to write out the hashcache only when the last lock on
 
1359
        # this working copy is released.  Peeking at the lock count is a bit
 
1360
        # of a nasty hack; probably it's better to have a transaction object,
 
1361
        # which can do some finalization when it's either successfully or
 
1362
        # unsuccessfully completed.  (Denys's original patch did that.)
 
1363
        # RBC 20060206 hooking into transaction will couple lock and transaction
 
1364
        # wrongly. Hooking into unlock on the control files object is fine though.
 
1365
        
 
1366
        # TODO: split this per format so there is no ugly if block
 
1367
        if self._hashcache.needs_write and (
 
1368
            # dedicated lock files
 
1369
            self._control_files._lock_count==1 or 
 
1370
            # shared lock files
 
1371
            (self._control_files is self.branch.control_files and 
 
1372
             self._control_files._lock_count==3)):
 
1373
            self._hashcache.write()
 
1374
        # reverse order of locking.
 
1375
        try:
 
1376
            return self._control_files.unlock()
 
1377
        finally:
 
1378
            self.branch.unlock()
 
1379
 
 
1380
    @needs_write_lock
 
1381
    def update(self):
 
1382
        """Update a working tree along its branch.
 
1383
 
 
1384
        This will update the branch if its bound too, which means we have multiple trees involved:
 
1385
        The new basis tree of the master.
 
1386
        The old basis tree of the branch.
 
1387
        The old basis tree of the working tree.
 
1388
        The current working tree state.
 
1389
        pathologically all three may be different, and non ancestors of each other.
 
1390
        Conceptually we want to:
 
1391
        Preserve the wt.basis->wt.state changes
 
1392
        Transform the wt.basis to the new master basis.
 
1393
        Apply a merge of the old branch basis to get any 'local' changes from it into the tree.
 
1394
        Restore the wt.basis->wt.state changes.
 
1395
 
 
1396
        There isn't a single operation at the moment to do that, so we:
 
1397
        Merge current state -> basis tree of the master w.r.t. the old tree basis.
 
1398
        Do a 'normal' merge of the old branch basis if it is relevant.
 
1399
        """
 
1400
        old_tip = self.branch.update()
 
1401
        if old_tip is not None:
 
1402
            self.add_pending_merge(old_tip)
 
1403
        self.branch.lock_read()
 
1404
        try:
 
1405
            result = 0
 
1406
            if self.last_revision() != self.branch.last_revision():
 
1407
                # merge tree state up to new branch tip.
 
1408
                basis = self.basis_tree()
 
1409
                to_tree = self.branch.basis_tree()
 
1410
                result += merge_inner(self.branch,
 
1411
                                      to_tree,
 
1412
                                      basis,
 
1413
                                      this_tree=self)
 
1414
                self.set_last_revision(self.branch.last_revision())
 
1415
            if old_tip and old_tip != self.last_revision():
 
1416
                # our last revision was not the prior branch last revision
 
1417
                # and we have converted that last revision to a pending merge.
 
1418
                # base is somewhere between the branch tip now
 
1419
                # and the now pending merge
 
1420
                from bzrlib.revision import common_ancestor
 
1421
                try:
 
1422
                    base_rev_id = common_ancestor(self.branch.last_revision(),
 
1423
                                                  old_tip,
 
1424
                                                  self.branch.repository)
 
1425
                except errors.NoCommonAncestor:
 
1426
                    base_rev_id = None
 
1427
                base_tree = self.branch.repository.revision_tree(base_rev_id)
 
1428
                other_tree = self.branch.repository.revision_tree(old_tip)
 
1429
                result += merge_inner(self.branch,
 
1430
                                      other_tree,
 
1431
                                      base_tree,
 
1432
                                      this_tree=self)
 
1433
            return result
 
1434
        finally:
 
1435
            self.branch.unlock()
 
1436
 
 
1437
    @needs_write_lock
 
1438
    def _write_inventory(self, inv):
 
1439
        """Write inventory as the current inventory."""
 
1440
        sio = StringIO()
 
1441
        bzrlib.xml5.serializer_v5.write_inventory(inv, sio)
 
1442
        sio.seek(0)
 
1443
        self._control_files.put('inventory', sio)
 
1444
        self._set_inventory(inv)
 
1445
        mutter('wrote working inventory')
 
1446
 
 
1447
    def set_conflicts(self, arg):
 
1448
        raise UnsupportedOperation(self.set_conflicts, self)
 
1449
 
 
1450
    @needs_read_lock
 
1451
    def conflicts(self):
 
1452
        conflicts = ConflictList()
 
1453
        for conflicted in self._iter_conflicts():
 
1454
            text = True
 
1455
            try:
 
1456
                if file_kind(self.abspath(conflicted)) != "file":
 
1457
                    text = False
 
1458
            except errors.NoSuchFile:
 
1459
                text = False
 
1460
            if text is True:
 
1461
                for suffix in ('.THIS', '.OTHER'):
 
1462
                    try:
 
1463
                        kind = file_kind(self.abspath(conflicted+suffix))
 
1464
                        if kind != "file":
 
1465
                            text = False
 
1466
                    except errors.NoSuchFile:
 
1467
                        text = False
 
1468
                    if text == False:
 
1469
                        break
 
1470
            ctype = {True: 'text conflict', False: 'contents conflict'}[text]
 
1471
            conflicts.append(Conflict.factory(ctype, path=conflicted,
 
1472
                             file_id=self.path2id(conflicted)))
 
1473
        return conflicts
 
1474
 
 
1475
 
 
1476
class WorkingTree3(WorkingTree):
 
1477
    """This is the Format 3 working tree.
 
1478
 
 
1479
    This differs from the base WorkingTree by:
 
1480
     - having its own file lock
 
1481
     - having its own last-revision property.
 
1482
 
 
1483
    This is new in bzr 0.8
 
1484
    """
 
1485
 
 
1486
    @needs_read_lock
 
1487
    def last_revision(self):
 
1488
        """See WorkingTree.last_revision."""
 
1489
        try:
 
1490
            return self._control_files.get_utf8('last-revision').read()
 
1491
        except NoSuchFile:
 
1492
            return None
 
1493
 
 
1494
    def _change_last_revision(self, revision_id):
 
1495
        """See WorkingTree._change_last_revision."""
 
1496
        if revision_id is None or revision_id == NULL_REVISION:
 
1497
            try:
 
1498
                self._control_files._transport.delete('last-revision')
 
1499
            except errors.NoSuchFile:
 
1500
                pass
 
1501
            return False
 
1502
        else:
 
1503
            try:
 
1504
                self.branch.revision_history().index(revision_id)
 
1505
            except ValueError:
 
1506
                raise errors.NoSuchRevision(self.branch, revision_id)
 
1507
            self._control_files.put_utf8('last-revision', revision_id)
 
1508
            return True
 
1509
 
 
1510
    @needs_write_lock
 
1511
    def set_conflicts(self, conflicts):
 
1512
        self._put_rio('conflicts', conflicts.to_stanzas(), 
 
1513
                      CONFLICT_HEADER_1)
 
1514
 
 
1515
    @needs_read_lock
 
1516
    def conflicts(self):
 
1517
        try:
 
1518
            confile = self._control_files.get('conflicts')
 
1519
        except NoSuchFile:
 
1520
            return ConflictList()
 
1521
        try:
 
1522
            if confile.next() != CONFLICT_HEADER_1 + '\n':
 
1523
                raise ConflictFormatError()
 
1524
        except StopIteration:
 
1525
            raise ConflictFormatError()
 
1526
        return ConflictList.from_stanzas(RioReader(confile))
 
1527
 
 
1528
 
 
1529
def get_conflicted_stem(path):
 
1530
    for suffix in CONFLICT_SUFFIXES:
 
1531
        if path.endswith(suffix):
 
1532
            return path[:-len(suffix)]
 
1533
 
 
1534
@deprecated_function(zero_eight)
 
1535
def is_control_file(filename):
 
1536
    """See WorkingTree.is_control_filename(filename)."""
 
1537
    ## FIXME: better check
 
1538
    filename = normpath(filename)
 
1539
    while filename != '':
 
1540
        head, tail = os.path.split(filename)
 
1541
        ## mutter('check %r for control file' % ((head, tail),))
 
1542
        if tail == '.bzr':
 
1543
            return True
 
1544
        if filename == head:
 
1545
            break
 
1546
        filename = head
 
1547
    return False
 
1548
 
 
1549
 
 
1550
class WorkingTreeFormat(object):
 
1551
    """An encapsulation of the initialization and open routines for a format.
 
1552
 
 
1553
    Formats provide three things:
 
1554
     * An initialization routine,
 
1555
     * a format string,
 
1556
     * an open routine.
 
1557
 
 
1558
    Formats are placed in an dict by their format string for reference 
 
1559
    during workingtree opening. Its not required that these be instances, they
 
1560
    can be classes themselves with class methods - it simply depends on 
 
1561
    whether state is needed for a given format or not.
 
1562
 
 
1563
    Once a format is deprecated, just deprecate the initialize and open
 
1564
    methods on the format class. Do not deprecate the object, as the 
 
1565
    object will be created every time regardless.
 
1566
    """
 
1567
 
 
1568
    _default_format = None
 
1569
    """The default format used for new trees."""
 
1570
 
 
1571
    _formats = {}
 
1572
    """The known formats."""
 
1573
 
 
1574
    @classmethod
 
1575
    def find_format(klass, a_bzrdir):
 
1576
        """Return the format for the working tree object in a_bzrdir."""
 
1577
        try:
 
1578
            transport = a_bzrdir.get_workingtree_transport(None)
 
1579
            format_string = transport.get("format").read()
 
1580
            return klass._formats[format_string]
 
1581
        except NoSuchFile:
 
1582
            raise errors.NoWorkingTree(base=transport.base)
 
1583
        except KeyError:
 
1584
            raise errors.UnknownFormatError(format=format_string)
 
1585
 
 
1586
    @classmethod
 
1587
    def get_default_format(klass):
 
1588
        """Return the current default format."""
 
1589
        return klass._default_format
 
1590
 
 
1591
    def get_format_string(self):
 
1592
        """Return the ASCII format string that identifies this format."""
 
1593
        raise NotImplementedError(self.get_format_string)
 
1594
 
 
1595
    def get_format_description(self):
 
1596
        """Return the short description for this format."""
 
1597
        raise NotImplementedError(self.get_format_description)
 
1598
 
 
1599
    def is_supported(self):
 
1600
        """Is this format supported?
 
1601
 
 
1602
        Supported formats can be initialized and opened.
 
1603
        Unsupported formats may not support initialization or committing or 
 
1604
        some other features depending on the reason for not being supported.
 
1605
        """
 
1606
        return True
 
1607
 
 
1608
    @classmethod
 
1609
    def register_format(klass, format):
 
1610
        klass._formats[format.get_format_string()] = format
 
1611
 
 
1612
    @classmethod
 
1613
    def set_default_format(klass, format):
 
1614
        klass._default_format = format
 
1615
 
 
1616
    @classmethod
 
1617
    def unregister_format(klass, format):
 
1618
        assert klass._formats[format.get_format_string()] is format
 
1619
        del klass._formats[format.get_format_string()]
 
1620
 
 
1621
 
 
1622
 
 
1623
class WorkingTreeFormat2(WorkingTreeFormat):
 
1624
    """The second working tree format. 
 
1625
 
 
1626
    This format modified the hash cache from the format 1 hash cache.
 
1627
    """
 
1628
 
 
1629
    def get_format_description(self):
 
1630
        """See WorkingTreeFormat.get_format_description()."""
 
1631
        return "Working tree format 2"
 
1632
 
 
1633
    def stub_initialize_remote(self, control_files):
 
1634
        """As a special workaround create critical control files for a remote working tree
 
1635
        
 
1636
        This ensures that it can later be updated and dealt with locally,
 
1637
        since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with 
 
1638
        no working tree.  (See bug #43064).
 
1639
        """
 
1640
        sio = StringIO()
 
1641
        inv = Inventory()
 
1642
        bzrlib.xml5.serializer_v5.write_inventory(inv, sio)
 
1643
        sio.seek(0)
 
1644
        control_files.put('inventory', sio)
 
1645
 
 
1646
        control_files.put_utf8('pending-merges', '')
 
1647
        
 
1648
 
 
1649
    def initialize(self, a_bzrdir, revision_id=None):
 
1650
        """See WorkingTreeFormat.initialize()."""
 
1651
        if not isinstance(a_bzrdir.transport, LocalTransport):
 
1652
            raise errors.NotLocalUrl(a_bzrdir.transport.base)
 
1653
        branch = a_bzrdir.open_branch()
 
1654
        if revision_id is not None:
 
1655
            branch.lock_write()
 
1656
            try:
 
1657
                revision_history = branch.revision_history()
 
1658
                try:
 
1659
                    position = revision_history.index(revision_id)
 
1660
                except ValueError:
 
1661
                    raise errors.NoSuchRevision(branch, revision_id)
 
1662
                branch.set_revision_history(revision_history[:position + 1])
 
1663
            finally:
 
1664
                branch.unlock()
 
1665
        revision = branch.last_revision()
 
1666
        inv = Inventory() 
 
1667
        wt = WorkingTree(a_bzrdir.root_transport.local_abspath('.'),
 
1668
                         branch,
 
1669
                         inv,
 
1670
                         _internal=True,
 
1671
                         _format=self,
 
1672
                         _bzrdir=a_bzrdir)
 
1673
        wt._write_inventory(inv)
 
1674
        wt.set_root_id(inv.root.file_id)
 
1675
        wt.set_last_revision(revision)
 
1676
        wt.set_pending_merges([])
 
1677
        build_tree(wt.basis_tree(), wt)
 
1678
        return wt
 
1679
 
 
1680
    def __init__(self):
 
1681
        super(WorkingTreeFormat2, self).__init__()
 
1682
        self._matchingbzrdir = bzrdir.BzrDirFormat6()
 
1683
 
 
1684
    def open(self, a_bzrdir, _found=False):
 
1685
        """Return the WorkingTree object for a_bzrdir
 
1686
 
 
1687
        _found is a private parameter, do not use it. It is used to indicate
 
1688
               if format probing has already been done.
 
1689
        """
 
1690
        if not _found:
 
1691
            # we are being called directly and must probe.
 
1692
            raise NotImplementedError
 
1693
        if not isinstance(a_bzrdir.transport, LocalTransport):
 
1694
            raise errors.NotLocalUrl(a_bzrdir.transport.base)
 
1695
        return WorkingTree(a_bzrdir.root_transport.local_abspath('.'),
 
1696
                           _internal=True,
 
1697
                           _format=self,
 
1698
                           _bzrdir=a_bzrdir)
 
1699
 
 
1700
 
 
1701
class WorkingTreeFormat3(WorkingTreeFormat):
 
1702
    """The second working tree format updated to record a format marker.
 
1703
 
 
1704
    This format:
 
1705
        - exists within a metadir controlling .bzr
 
1706
        - includes an explicit version marker for the workingtree control
 
1707
          files, separate from the BzrDir format
 
1708
        - modifies the hash cache format
 
1709
        - is new in bzr 0.8
 
1710
        - uses a LockDir to guard access to the repository
 
1711
    """
 
1712
 
 
1713
    def get_format_string(self):
 
1714
        """See WorkingTreeFormat.get_format_string()."""
 
1715
        return "Bazaar-NG Working Tree format 3"
 
1716
 
 
1717
    def get_format_description(self):
 
1718
        """See WorkingTreeFormat.get_format_description()."""
 
1719
        return "Working tree format 3"
 
1720
 
 
1721
    _lock_file_name = 'lock'
 
1722
    _lock_class = LockDir
 
1723
 
 
1724
    def _open_control_files(self, a_bzrdir):
 
1725
        transport = a_bzrdir.get_workingtree_transport(None)
 
1726
        return LockableFiles(transport, self._lock_file_name, 
 
1727
                             self._lock_class)
 
1728
 
 
1729
    def initialize(self, a_bzrdir, revision_id=None):
 
1730
        """See WorkingTreeFormat.initialize().
 
1731
        
 
1732
        revision_id allows creating a working tree at a different
 
1733
        revision than the branch is at.
 
1734
        """
 
1735
        if not isinstance(a_bzrdir.transport, LocalTransport):
 
1736
            raise errors.NotLocalUrl(a_bzrdir.transport.base)
 
1737
        transport = a_bzrdir.get_workingtree_transport(self)
 
1738
        control_files = self._open_control_files(a_bzrdir)
 
1739
        control_files.create_lock()
 
1740
        control_files.lock_write()
 
1741
        control_files.put_utf8('format', self.get_format_string())
 
1742
        branch = a_bzrdir.open_branch()
 
1743
        if revision_id is None:
 
1744
            revision_id = branch.last_revision()
 
1745
        inv = Inventory() 
 
1746
        wt = WorkingTree3(a_bzrdir.root_transport.local_abspath('.'),
 
1747
                         branch,
 
1748
                         inv,
 
1749
                         _internal=True,
 
1750
                         _format=self,
 
1751
                         _bzrdir=a_bzrdir,
 
1752
                         _control_files=control_files)
 
1753
        wt.lock_write()
 
1754
        try:
 
1755
            wt._write_inventory(inv)
 
1756
            wt.set_root_id(inv.root.file_id)
 
1757
            wt.set_last_revision(revision_id)
 
1758
            wt.set_pending_merges([])
 
1759
            build_tree(wt.basis_tree(), wt)
 
1760
        finally:
 
1761
            wt.unlock()
 
1762
            control_files.unlock()
 
1763
        return wt
 
1764
 
 
1765
    def __init__(self):
 
1766
        super(WorkingTreeFormat3, self).__init__()
 
1767
        self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
 
1768
 
 
1769
    def open(self, a_bzrdir, _found=False):
 
1770
        """Return the WorkingTree object for a_bzrdir
 
1771
 
 
1772
        _found is a private parameter, do not use it. It is used to indicate
 
1773
               if format probing has already been done.
 
1774
        """
 
1775
        if not _found:
 
1776
            # we are being called directly and must probe.
 
1777
            raise NotImplementedError
 
1778
        if not isinstance(a_bzrdir.transport, LocalTransport):
 
1779
            raise errors.NotLocalUrl(a_bzrdir.transport.base)
 
1780
        control_files = self._open_control_files(a_bzrdir)
 
1781
        return WorkingTree3(a_bzrdir.root_transport.local_abspath('.'),
 
1782
                           _internal=True,
 
1783
                           _format=self,
 
1784
                           _bzrdir=a_bzrdir,
 
1785
                           _control_files=control_files)
 
1786
 
 
1787
    def __str__(self):
 
1788
        return self.get_format_string()
 
1789
 
 
1790
 
 
1791
# formats which have no format string are not discoverable
 
1792
# and not independently creatable, so are not registered.
 
1793
__default_format = WorkingTreeFormat3()
 
1794
WorkingTreeFormat.register_format(__default_format)
 
1795
WorkingTreeFormat.set_default_format(__default_format)
 
1796
_legacy_formats = [WorkingTreeFormat2(),
 
1797
                   ]
 
1798
 
 
1799
 
 
1800
class WorkingTreeTestProviderAdapter(object):
 
1801
    """A tool to generate a suite testing multiple workingtree formats at once.
 
1802
 
 
1803
    This is done by copying the test once for each transport and injecting
 
1804
    the transport_server, transport_readonly_server, and workingtree_format
 
1805
    classes into each copy. Each copy is also given a new id() to make it
 
1806
    easy to identify.
 
1807
    """
 
1808
 
 
1809
    def __init__(self, transport_server, transport_readonly_server, formats):
 
1810
        self._transport_server = transport_server
 
1811
        self._transport_readonly_server = transport_readonly_server
 
1812
        self._formats = formats
 
1813
    
 
1814
    def adapt(self, test):
 
1815
        from bzrlib.tests import TestSuite
 
1816
        result = TestSuite()
 
1817
        for workingtree_format, bzrdir_format in self._formats:
 
1818
            new_test = deepcopy(test)
 
1819
            new_test.transport_server = self._transport_server
 
1820
            new_test.transport_readonly_server = self._transport_readonly_server
 
1821
            new_test.bzrdir_format = bzrdir_format
 
1822
            new_test.workingtree_format = workingtree_format
 
1823
            def make_new_test_id():
 
1824
                new_id = "%s(%s)" % (new_test.id(), workingtree_format.__class__.__name__)
 
1825
                return lambda: new_id
 
1826
            new_test.id = make_new_test_id()
 
1827
            result.addTest(new_test)
 
1828
        return result