/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

merge from bzr.dev, fix conflicts

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