/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: Aaron Bentley
  • Date: 2006-06-11 21:26:20 UTC
  • mto: This revision was merged to the branch mainline in revision 1764.
  • Revision ID: aaron.bentley@utoronto.ca-20060611212620-2517ff1406176fd9
Rename run_bzr_external -> run_bzr_subprocess, add docstring

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