~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/workingtree.py

  • Committer: Martin Pool
  • Date: 2005-05-03 02:39:45 UTC
  • Revision ID: mbp@sourcefrog.net-20050503023945-542829ff748301e8
- more documentation of revfile+annotation

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
 
    if not supports_executable():
539
 
        def is_executable(self, file_id, path=None):
540
 
            return self._inventory[file_id].executable
541
 
    else:
542
 
        def is_executable(self, file_id, path=None):
543
 
            if not path:
544
 
                path = self._inventory.id2path(file_id)
545
 
            mode = os.lstat(self.abspath(path)).st_mode
546
 
            return bool(stat.S_ISREG(mode) and stat.S_IEXEC&mode)
547
 
 
548
 
    @needs_write_lock
549
 
    def add(self, files, ids=None):
550
 
        """Make files versioned.
551
 
 
552
 
        Note that the command line normally calls smart_add instead,
553
 
        which can automatically recurse.
554
 
 
555
 
        This adds the files to the inventory, so that they will be
556
 
        recorded by the next commit.
557
 
 
558
 
        files
559
 
            List of paths to add, relative to the base of the tree.
560
 
 
561
 
        ids
562
 
            If set, use these instead of automatically generated ids.
563
 
            Must be the same length as the list of files, but may
564
 
            contain None for ids that are to be autogenerated.
565
 
 
566
 
        TODO: Perhaps have an option to add the ids even if the files do
567
 
              not (yet) exist.
568
 
 
569
 
        TODO: Perhaps callback with the ids and paths as they're added.
570
 
        """
571
 
        # TODO: Re-adding a file that is removed in the working copy
572
 
        # should probably put it back with the previous ID.
573
 
        if isinstance(files, basestring):
574
 
            assert(ids is None or isinstance(ids, basestring))
575
 
            files = [files]
576
 
            if ids is not None:
577
 
                ids = [ids]
578
 
 
579
 
        if ids is None:
580
 
            ids = [None] * len(files)
581
 
        else:
582
 
            assert(len(ids) == len(files))
583
 
 
584
 
        inv = self.read_working_inventory()
585
 
        for f,file_id in zip(files, ids):
586
 
            if self.is_control_filename(f):
587
 
                raise BzrError("cannot add control file %s" % quotefn(f))
588
 
 
589
 
            fp = splitpath(f)
590
 
 
591
 
            if len(fp) == 0:
592
 
                raise BzrError("cannot add top-level %r" % f)
593
 
 
594
 
            fullpath = normpath(self.abspath(f))
595
 
 
596
 
            try:
597
 
                kind = file_kind(fullpath)
598
 
            except OSError, e:
599
 
                if e.errno == errno.ENOENT:
600
 
                    raise NoSuchFile(fullpath)
601
 
                # maybe something better?
602
 
                raise BzrError('cannot add: not a regular file, symlink or directory: %s' % quotefn(f))
603
 
 
604
 
            if not InventoryEntry.versionable_kind(kind):
605
 
                raise BzrError('cannot add: not a versionable file ('
606
 
                               'i.e. regular file, symlink or directory): %s' % quotefn(f))
607
 
 
608
 
            if file_id is None:
609
 
                inv.add_path(f, kind=kind)
610
 
            else:
611
 
                inv.add_path(f, kind=kind, file_id=file_id)
612
 
 
613
 
        self._write_inventory(inv)
614
 
 
615
 
    @needs_write_lock
616
 
    def add_pending_merge(self, *revision_ids):
617
 
        # TODO: Perhaps should check at this point that the
618
 
        # history of the revision is actually present?
619
 
        p = self.pending_merges()
620
 
        updated = False
621
 
        for rev_id in revision_ids:
622
 
            if rev_id in p:
623
 
                continue
624
 
            p.append(rev_id)
625
 
            updated = True
626
 
        if updated:
627
 
            self.set_pending_merges(p)
628
 
 
629
 
    @needs_read_lock
630
 
    def pending_merges(self):
631
 
        """Return a list of pending merges.
632
 
 
633
 
        These are revisions that have been merged into the working
634
 
        directory but not yet committed.
635
 
        """
636
 
        try:
637
 
            merges_file = self._control_files.get_utf8('pending-merges')
638
 
        except OSError, e:
639
 
            if e.errno != errno.ENOENT:
640
 
                raise
641
 
            return []
642
 
        p = []
643
 
        for l in merges_file.readlines():
644
 
            p.append(l.rstrip('\n'))
645
 
        return p
646
 
 
647
 
    @needs_write_lock
648
 
    def set_pending_merges(self, rev_list):
649
 
        self._control_files.put_utf8('pending-merges', '\n'.join(rev_list))
650
 
 
651
 
    @needs_write_lock
652
 
    def set_merge_modified(self, modified_hashes):
653
 
        def iter_stanzas():
654
 
            for file_id, hash in modified_hashes.iteritems():
655
 
                yield Stanza(file_id=file_id, hash=hash)
656
 
        self._put_rio('merge-hashes', iter_stanzas(), MERGE_MODIFIED_HEADER_1)
657
 
 
658
 
    @needs_write_lock
659
 
    def _put_rio(self, filename, stanzas, header):
660
 
        my_file = rio_file(stanzas, header)
661
 
        self._control_files.put(filename, my_file)
662
 
 
663
 
    @needs_read_lock
664
 
    def merge_modified(self):
665
 
        try:
666
 
            hashfile = self._control_files.get('merge-hashes')
667
 
        except NoSuchFile:
668
 
            return {}
669
 
        merge_hashes = {}
670
 
        try:
671
 
            if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
672
 
                raise MergeModifiedFormatError()
673
 
        except StopIteration:
674
 
            raise MergeModifiedFormatError()
675
 
        for s in RioReader(hashfile):
676
 
            file_id = s.get("file_id")
677
 
            if file_id not in self.inventory:
678
 
                continue
679
 
            hash = s.get("hash")
680
 
            if hash == self.get_file_sha1(file_id):
681
 
                merge_hashes[file_id] = hash
682
 
        return merge_hashes
683
 
 
684
 
    def get_symlink_target(self, file_id):
685
 
        return os.readlink(self.id2abspath(file_id))
686
 
 
687
 
    def file_class(self, filename):
688
 
        if self.path2id(filename):
689
 
            return 'V'
690
 
        elif self.is_ignored(filename):
691
 
            return 'I'
692
 
        else:
693
 
            return '?'
694
 
 
695
 
    def list_files(self):
696
 
        """Recursively list all files as (path, class, kind, id, entry).
697
 
 
698
 
        Lists, but does not descend into unversioned directories.
699
 
 
700
 
        This does not include files that have been deleted in this
701
 
        tree.
702
 
 
703
 
        Skips the control directory.
704
 
        """
705
 
        inv = self._inventory
706
 
        # Convert these into local objects to save lookup times
707
 
        pathjoin = bzrlib.osutils.pathjoin
708
 
        file_kind = bzrlib.osutils.file_kind
709
 
 
710
 
        # transport.base ends in a slash, we want the piece
711
 
        # between the last two slashes
712
 
        transport_base_dir = self.bzrdir.transport.base.rsplit('/', 2)[1]
713
 
 
714
 
        fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
715
 
 
716
 
        # directory file_id, relative path, absolute path, reverse sorted children
717
 
        children = os.listdir(self.basedir)
718
 
        children.sort()
719
 
        # jam 20060527 The kernel sized tree seems equivalent whether we 
720
 
        # use a deque and popleft to keep them sorted, or if we use a plain
721
 
        # list and just reverse() them.
722
 
        children = collections.deque(children)
723
 
        stack = [(inv.root.file_id, u'', self.basedir, children)]
724
 
        while stack:
725
 
            from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
726
 
 
727
 
            while children:
728
 
                f = children.popleft()
729
 
                ## TODO: If we find a subdirectory with its own .bzr
730
 
                ## directory, then that is a separate tree and we
731
 
                ## should exclude it.
732
 
 
733
 
                # the bzrdir for this tree
734
 
                if transport_base_dir == f:
735
 
                    continue
736
 
 
737
 
                # we know that from_dir_relpath and from_dir_abspath never end in a slash
738
 
                # and 'f' doesn't begin with one, we can do a string op, rather
739
 
                # than the checks of pathjoin(), all relative paths will have an extra slash
740
 
                # at the beginning
741
 
                fp = from_dir_relpath + '/' + f
742
 
 
743
 
                # absolute path
744
 
                fap = from_dir_abspath + '/' + f
745
 
                
746
 
                f_ie = inv.get_child(from_dir_id, f)
747
 
                if f_ie:
748
 
                    c = 'V'
749
 
                elif self.is_ignored(fp[1:]):
750
 
                    c = 'I'
751
 
                else:
752
 
                    c = '?'
753
 
 
754
 
                fk = file_kind(fap)
755
 
 
756
 
                if f_ie:
757
 
                    if f_ie.kind != fk:
758
 
                        raise BzrCheckError("file %r entered as kind %r id %r, "
759
 
                                            "now of kind %r"
760
 
                                            % (fap, f_ie.kind, f_ie.file_id, fk))
761
 
 
762
 
                # make a last minute entry
763
 
                if f_ie:
764
 
                    yield fp[1:], c, fk, f_ie.file_id, f_ie
765
 
                else:
766
 
                    try:
767
 
                        yield fp[1:], c, fk, None, fk_entries[fk]()
768
 
                    except KeyError:
769
 
                        yield fp[1:], c, fk, None, TreeEntry()
770
 
                    continue
771
 
                
772
 
                if fk != 'directory':
773
 
                    continue
774
 
 
775
 
                # But do this child first
776
 
                new_children = os.listdir(fap)
777
 
                new_children.sort()
778
 
                new_children = collections.deque(new_children)
779
 
                stack.append((f_ie.file_id, fp, fap, new_children))
780
 
                # Break out of inner loop, so that we start outer loop with child
781
 
                break
782
 
            else:
783
 
                # if we finished all children, pop it off the stack
784
 
                stack.pop()
785
 
 
786
 
 
787
 
    @needs_write_lock
788
 
    def move(self, from_paths, to_name):
789
 
        """Rename files.
790
 
 
791
 
        to_name must exist in the inventory.
792
 
 
793
 
        If to_name exists and is a directory, the files are moved into
794
 
        it, keeping their old names.  
795
 
 
796
 
        Note that to_name is only the last component of the new name;
797
 
        this doesn't change the directory.
798
 
 
799
 
        This returns a list of (from_path, to_path) pairs for each
800
 
        entry that is moved.
801
 
        """
802
 
        result = []
803
 
        ## TODO: Option to move IDs only
804
 
        assert not isinstance(from_paths, basestring)
805
 
        inv = self.inventory
806
 
        to_abs = self.abspath(to_name)
807
 
        if not isdir(to_abs):
808
 
            raise BzrError("destination %r is not a directory" % to_abs)
809
 
        if not self.has_filename(to_name):
810
 
            raise BzrError("destination %r not in working directory" % to_abs)
811
 
        to_dir_id = inv.path2id(to_name)
812
 
        if to_dir_id == None and to_name != '':
813
 
            raise BzrError("destination %r is not a versioned directory" % to_name)
814
 
        to_dir_ie = inv[to_dir_id]
815
 
        if to_dir_ie.kind not in ('directory', 'root_directory'):
816
 
            raise BzrError("destination %r is not a directory" % to_abs)
817
 
 
818
 
        to_idpath = inv.get_idpath(to_dir_id)
819
 
 
820
 
        for f in from_paths:
821
 
            if not self.has_filename(f):
822
 
                raise BzrError("%r does not exist in working tree" % f)
823
 
            f_id = inv.path2id(f)
824
 
            if f_id == None:
825
 
                raise BzrError("%r is not versioned" % f)
826
 
            name_tail = splitpath(f)[-1]
827
 
            dest_path = pathjoin(to_name, name_tail)
828
 
            if self.has_filename(dest_path):
829
 
                raise BzrError("destination %r already exists" % dest_path)
830
 
            if f_id in to_idpath:
831
 
                raise BzrError("can't move %r to a subdirectory of itself" % f)
832
 
 
833
 
        # OK, so there's a race here, it's possible that someone will
834
 
        # create a file in this interval and then the rename might be
835
 
        # left half-done.  But we should have caught most problems.
836
 
        orig_inv = deepcopy(self.inventory)
837
 
        try:
838
 
            for f in from_paths:
839
 
                name_tail = splitpath(f)[-1]
840
 
                dest_path = pathjoin(to_name, name_tail)
841
 
                result.append((f, dest_path))
842
 
                inv.rename(inv.path2id(f), to_dir_id, name_tail)
843
 
                try:
844
 
                    rename(self.abspath(f), self.abspath(dest_path))
845
 
                except OSError, e:
846
 
                    raise BzrError("failed to rename %r to %r: %s" %
847
 
                                   (f, dest_path, e[1]),
848
 
                            ["rename rolled back"])
849
 
        except:
850
 
            # restore the inventory on error
851
 
            self._set_inventory(orig_inv)
852
 
            raise
853
 
        self._write_inventory(inv)
854
 
        return result
855
 
 
856
 
    @needs_write_lock
857
 
    def rename_one(self, from_rel, to_rel):
858
 
        """Rename one file.
859
 
 
860
 
        This can change the directory or the filename or both.
861
 
        """
862
 
        inv = self.inventory
863
 
        if not self.has_filename(from_rel):
864
 
            raise BzrError("can't rename: old working file %r does not exist" % from_rel)
865
 
        if self.has_filename(to_rel):
866
 
            raise BzrError("can't rename: new working file %r already exists" % to_rel)
867
 
 
868
 
        file_id = inv.path2id(from_rel)
869
 
        if file_id == None:
870
 
            raise BzrError("can't rename: old name %r is not versioned" % from_rel)
871
 
 
872
 
        entry = inv[file_id]
873
 
        from_parent = entry.parent_id
874
 
        from_name = entry.name
875
 
        
876
 
        if inv.path2id(to_rel):
877
 
            raise BzrError("can't rename: new name %r is already versioned" % to_rel)
878
 
 
879
 
        to_dir, to_tail = os.path.split(to_rel)
880
 
        to_dir_id = inv.path2id(to_dir)
881
 
        if to_dir_id == None and to_dir != '':
882
 
            raise BzrError("can't determine destination directory id for %r" % to_dir)
883
 
 
884
 
        mutter("rename_one:")
885
 
        mutter("  file_id    {%s}" % file_id)
886
 
        mutter("  from_rel   %r" % from_rel)
887
 
        mutter("  to_rel     %r" % to_rel)
888
 
        mutter("  to_dir     %r" % to_dir)
889
 
        mutter("  to_dir_id  {%s}" % to_dir_id)
890
 
 
891
 
        inv.rename(file_id, to_dir_id, to_tail)
892
 
 
893
 
        from_abs = self.abspath(from_rel)
894
 
        to_abs = self.abspath(to_rel)
895
 
        try:
896
 
            rename(from_abs, to_abs)
897
 
        except OSError, e:
898
 
            inv.rename(file_id, from_parent, from_name)
899
 
            raise BzrError("failed to rename %r to %r: %s"
900
 
                    % (from_abs, to_abs, e[1]),
901
 
                    ["rename rolled back"])
902
 
        self._write_inventory(inv)
903
 
 
904
 
    @needs_read_lock
905
 
    def unknowns(self):
906
 
        """Return all unknown files.
907
 
 
908
 
        These are files in the working directory that are not versioned or
909
 
        control files or ignored.
910
 
        
911
 
        >>> from bzrlib.bzrdir import ScratchDir
912
 
        >>> d = ScratchDir(files=['foo', 'foo~'])
913
 
        >>> b = d.open_branch()
914
 
        >>> tree = d.open_workingtree()
915
 
        >>> map(str, tree.unknowns())
916
 
        ['foo']
917
 
        >>> tree.add('foo')
918
 
        >>> list(b.unknowns())
919
 
        []
920
 
        >>> tree.remove('foo')
921
 
        >>> list(b.unknowns())
922
 
        [u'foo']
923
 
        """
924
 
        for subp in self.extras():
925
 
            if not self.is_ignored(subp):
926
 
                yield subp
927
 
 
928
 
    @deprecated_method(zero_eight)
929
 
    def iter_conflicts(self):
930
 
        """List all files in the tree that have text or content conflicts.
931
 
        DEPRECATED.  Use conflicts instead."""
932
 
        return self._iter_conflicts()
933
 
 
934
 
    def _iter_conflicts(self):
935
 
        conflicted = set()
936
 
        for info in self.list_files():
937
 
            path = info[0]
938
 
            stem = get_conflicted_stem(path)
939
 
            if stem is None:
940
 
                continue
941
 
            if stem not in conflicted:
942
 
                conflicted.add(stem)
943
 
                yield stem
944
 
 
945
 
    @needs_write_lock
946
 
    def pull(self, source, overwrite=False, stop_revision=None):
947
 
        top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
948
 
        source.lock_read()
949
 
        try:
950
 
            pp = ProgressPhase("Pull phase", 2, top_pb)
951
 
            pp.next_phase()
952
 
            old_revision_history = self.branch.revision_history()
953
 
            basis_tree = self.basis_tree()
954
 
            count = self.branch.pull(source, overwrite, stop_revision)
955
 
            new_revision_history = self.branch.revision_history()
956
 
            if new_revision_history != old_revision_history:
957
 
                pp.next_phase()
958
 
                if len(old_revision_history):
959
 
                    other_revision = old_revision_history[-1]
960
 
                else:
961
 
                    other_revision = None
962
 
                repository = self.branch.repository
963
 
                pb = bzrlib.ui.ui_factory.nested_progress_bar()
964
 
                try:
965
 
                    merge_inner(self.branch,
966
 
                                self.branch.basis_tree(),
967
 
                                basis_tree, 
968
 
                                this_tree=self, 
969
 
                                pb=pb)
970
 
                finally:
971
 
                    pb.finished()
972
 
                self.set_last_revision(self.branch.last_revision())
973
 
            return count
974
 
        finally:
975
 
            source.unlock()
976
 
            top_pb.finished()
977
 
 
978
 
    def extras(self):
979
 
        """Yield all unknown files in this WorkingTree.
980
 
 
981
 
        If there are any unknown directories then only the directory is
982
 
        returned, not all its children.  But if there are unknown files
983
 
        under a versioned subdirectory, they are returned.
984
 
 
985
 
        Currently returned depth-first, sorted by name within directories.
986
 
        """
987
 
        ## TODO: Work from given directory downwards
988
 
        for path, dir_entry in self.inventory.directories():
989
 
            mutter("search for unknowns in %r", path)
990
 
            dirabs = self.abspath(path)
991
 
            if not isdir(dirabs):
992
 
                # e.g. directory deleted
993
 
                continue
994
 
 
995
 
            fl = []
996
 
            for subf in os.listdir(dirabs):
997
 
                if (subf != '.bzr'
998
 
                    and (subf not in dir_entry.children)):
999
 
                    fl.append(subf)
1000
 
            
1001
 
            fl.sort()
1002
 
            for subf in fl:
1003
 
                subp = pathjoin(path, subf)
1004
 
                yield subp
1005
 
 
1006
 
    def _translate_ignore_rule(self, rule):
1007
 
        """Translate a single ignore rule to a regex.
1008
 
 
1009
 
        There are two types of ignore rules.  Those that do not contain a / are
1010
 
        matched against the tail of the filename (that is, they do not care
1011
 
        what directory the file is in.)  Rules which do contain a slash must
1012
 
        match the entire path.  As a special case, './' at the start of the
1013
 
        string counts as a slash in the string but is removed before matching
1014
 
        (e.g. ./foo.c, ./src/foo.c)
1015
 
 
1016
 
        :return: The translated regex.
1017
 
        """
1018
 
        if rule[:2] in ('./', '.\\'):
1019
 
            # rootdir rule
1020
 
            result = fnmatch.translate(rule[2:])
1021
 
        elif '/' in rule or '\\' in rule:
1022
 
            # path prefix 
1023
 
            result = fnmatch.translate(rule)
1024
 
        else:
1025
 
            # default rule style.
1026
 
            result = "(?:.*/)?(?!.*/)" + fnmatch.translate(rule)
1027
 
        assert result[-1] == '$', "fnmatch.translate did not add the expected $"
1028
 
        return "(" + result + ")"
1029
 
 
1030
 
    def _combine_ignore_rules(self, rules):
1031
 
        """Combine a list of ignore rules into a single regex object.
1032
 
 
1033
 
        Each individual rule is combined with | to form a big regex, which then
1034
 
        has $ added to it to form something like ()|()|()$. The group index for
1035
 
        each subregex's outermost group is placed in a dictionary mapping back 
1036
 
        to the rule. This allows quick identification of the matching rule that
1037
 
        triggered a match.
1038
 
        :return: a list of the compiled regex and the matching-group index 
1039
 
        dictionaries. We return a list because python complains if you try to 
1040
 
        combine more than 100 regexes.
1041
 
        """
1042
 
        result = []
1043
 
        groups = {}
1044
 
        next_group = 0
1045
 
        translated_rules = []
1046
 
        for rule in rules:
1047
 
            translated_rule = self._translate_ignore_rule(rule)
1048
 
            compiled_rule = re.compile(translated_rule)
1049
 
            groups[next_group] = rule
1050
 
            next_group += compiled_rule.groups
1051
 
            translated_rules.append(translated_rule)
1052
 
            if next_group == 99:
1053
 
                result.append((re.compile("|".join(translated_rules)), groups))
1054
 
                groups = {}
1055
 
                next_group = 0
1056
 
                translated_rules = []
1057
 
        if len(translated_rules):
1058
 
            result.append((re.compile("|".join(translated_rules)), groups))
1059
 
        return result
1060
 
 
1061
 
    def ignored_files(self):
1062
 
        """Yield list of PATH, IGNORE_PATTERN"""
1063
 
        for subp in self.extras():
1064
 
            pat = self.is_ignored(subp)
1065
 
            if pat != None:
1066
 
                yield subp, pat
1067
 
 
1068
 
    def get_ignore_list(self):
1069
 
        """Return list of ignore patterns.
1070
 
 
1071
 
        Cached in the Tree object after the first call.
1072
 
        """
1073
 
        if hasattr(self, '_ignorelist'):
1074
 
            return self._ignorelist
1075
 
 
1076
 
        l = bzrlib.DEFAULT_IGNORE[:]
1077
 
        if self.has_filename(bzrlib.IGNORE_FILENAME):
1078
 
            f = self.get_file_byname(bzrlib.IGNORE_FILENAME)
1079
 
            l.extend([line.rstrip("\n\r") for line in f.readlines()])
1080
 
        self._ignorelist = l
1081
 
        self._ignore_regex = self._combine_ignore_rules(l)
1082
 
        return l
1083
 
 
1084
 
    def _get_ignore_rules_as_regex(self):
1085
 
        """Return a regex of the ignore rules and a mapping dict.
1086
 
 
1087
 
        :return: (ignore rules compiled regex, dictionary mapping rule group 
1088
 
        indices to original rule.)
1089
 
        """
1090
 
        if getattr(self, '_ignorelist', None) is None:
1091
 
            self.get_ignore_list()
1092
 
        return self._ignore_regex
1093
 
 
1094
 
    def is_ignored(self, filename):
1095
 
        r"""Check whether the filename matches an ignore pattern.
1096
 
 
1097
 
        Patterns containing '/' or '\' need to match the whole path;
1098
 
        others match against only the last component.
1099
 
 
1100
 
        If the file is ignored, returns the pattern which caused it to
1101
 
        be ignored, otherwise None.  So this can simply be used as a
1102
 
        boolean if desired."""
1103
 
 
1104
 
        # TODO: Use '**' to match directories, and other extended
1105
 
        # globbing stuff from cvs/rsync.
1106
 
 
1107
 
        # XXX: fnmatch is actually not quite what we want: it's only
1108
 
        # approximately the same as real Unix fnmatch, and doesn't
1109
 
        # treat dotfiles correctly and allows * to match /.
1110
 
        # Eventually it should be replaced with something more
1111
 
        # accurate.
1112
 
    
1113
 
        rules = self._get_ignore_rules_as_regex()
1114
 
        for regex, mapping in rules:
1115
 
            match = regex.match(filename)
1116
 
            if match is not None:
1117
 
                # one or more of the groups in mapping will have a non-None group 
1118
 
                # match.
1119
 
                groups = match.groups()
1120
 
                rules = [mapping[group] for group in 
1121
 
                    mapping if groups[group] is not None]
1122
 
                return rules[0]
1123
 
        return None
1124
 
 
1125
 
    def kind(self, file_id):
1126
 
        return file_kind(self.id2abspath(file_id))
1127
 
 
1128
 
    @needs_read_lock
1129
 
    def last_revision(self):
1130
 
        """Return the last revision id of this working tree.
1131
 
 
1132
 
        In early branch formats this was == the branch last_revision,
1133
 
        but that cannot be relied upon - for working tree operations,
1134
 
        always use tree.last_revision().
1135
 
        """
1136
 
        return self.branch.last_revision()
1137
 
 
1138
 
    def is_locked(self):
1139
 
        return self._control_files.is_locked()
1140
 
 
1141
 
    def lock_read(self):
1142
 
        """See Branch.lock_read, and WorkingTree.unlock."""
1143
 
        self.branch.lock_read()
1144
 
        try:
1145
 
            return self._control_files.lock_read()
1146
 
        except:
1147
 
            self.branch.unlock()
1148
 
            raise
1149
 
 
1150
 
    def lock_write(self):
1151
 
        """See Branch.lock_write, and WorkingTree.unlock."""
1152
 
        self.branch.lock_write()
1153
 
        try:
1154
 
            return self._control_files.lock_write()
1155
 
        except:
1156
 
            self.branch.unlock()
1157
 
            raise
1158
 
 
1159
 
    def get_physical_lock_status(self):
1160
 
        return self._control_files.get_physical_lock_status()
1161
 
 
1162
 
    def _basis_inventory_name(self):
1163
 
        return 'basis-inventory'
1164
 
 
1165
 
    @needs_write_lock
1166
 
    def set_last_revision(self, new_revision):
1167
 
        """Change the last revision in the working tree."""
1168
 
        if self._change_last_revision(new_revision):
1169
 
            self._cache_basis_inventory(new_revision)
1170
 
 
1171
 
    def _change_last_revision(self, new_revision):
1172
 
        """Template method part of set_last_revision to perform the change.
1173
 
        
1174
 
        This is used to allow WorkingTree3 instances to not affect branch
1175
 
        when their last revision is set.
1176
 
        """
1177
 
        if new_revision is None:
1178
 
            self.branch.set_revision_history([])
1179
 
            return False
1180
 
        # current format is locked in with the branch
1181
 
        revision_history = self.branch.revision_history()
1182
 
        try:
1183
 
            position = revision_history.index(new_revision)
1184
 
        except ValueError:
1185
 
            raise errors.NoSuchRevision(self.branch, new_revision)
1186
 
        self.branch.set_revision_history(revision_history[:position + 1])
1187
 
        return True
1188
 
 
1189
 
    def _cache_basis_inventory(self, new_revision):
1190
 
        """Cache new_revision as the basis inventory."""
1191
 
        try:
1192
 
            # this double handles the inventory - unpack and repack - 
1193
 
            # but is easier to understand. We can/should put a conditional
1194
 
            # in here based on whether the inventory is in the latest format
1195
 
            # - perhaps we should repack all inventories on a repository
1196
 
            # upgrade ?
1197
 
            inv = self.branch.repository.get_inventory(new_revision)
1198
 
            inv.revision_id = new_revision
1199
 
            xml = bzrlib.xml5.serializer_v5.write_inventory_to_string(inv)
1200
 
 
1201
 
            path = self._basis_inventory_name()
1202
 
            self._control_files.put_utf8(path, xml)
1203
 
        except WeaveRevisionNotPresent:
1204
 
            pass
1205
 
 
1206
 
    def read_basis_inventory(self):
1207
 
        """Read the cached basis inventory."""
1208
 
        path = self._basis_inventory_name()
1209
 
        return self._control_files.get_utf8(path).read()
1210
 
        
1211
 
    @needs_read_lock
1212
 
    def read_working_inventory(self):
1213
 
        """Read the working inventory."""
1214
 
        # ElementTree does its own conversion from UTF-8, so open in
1215
 
        # binary.
1216
 
        result = bzrlib.xml5.serializer_v5.read_inventory(
1217
 
            self._control_files.get('inventory'))
1218
 
        self._set_inventory(result)
1219
 
        return result
1220
 
 
1221
 
    @needs_write_lock
1222
 
    def remove(self, files, verbose=False):
1223
 
        """Remove nominated files from the working inventory..
1224
 
 
1225
 
        This does not remove their text.  This does not run on XXX on what? RBC
1226
 
 
1227
 
        TODO: Refuse to remove modified files unless --force is given?
1228
 
 
1229
 
        TODO: Do something useful with directories.
1230
 
 
1231
 
        TODO: Should this remove the text or not?  Tough call; not
1232
 
        removing may be useful and the user can just use use rm, and
1233
 
        is the opposite of add.  Removing it is consistent with most
1234
 
        other tools.  Maybe an option.
1235
 
        """
1236
 
        ## TODO: Normalize names
1237
 
        ## TODO: Remove nested loops; better scalability
1238
 
        if isinstance(files, basestring):
1239
 
            files = [files]
1240
 
 
1241
 
        inv = self.inventory
1242
 
 
1243
 
        # do this before any modifications
1244
 
        for f in files:
1245
 
            fid = inv.path2id(f)
1246
 
            if not fid:
1247
 
                # TODO: Perhaps make this just a warning, and continue?
1248
 
                # This tends to happen when 
1249
 
                raise NotVersionedError(path=f)
1250
 
            mutter("remove inventory entry %s {%s}", quotefn(f), fid)
1251
 
            if verbose:
1252
 
                # having remove it, it must be either ignored or unknown
1253
 
                if self.is_ignored(f):
1254
 
                    new_status = 'I'
1255
 
                else:
1256
 
                    new_status = '?'
1257
 
                show_status(new_status, inv[fid].kind, quotefn(f))
1258
 
            del inv[fid]
1259
 
 
1260
 
        self._write_inventory(inv)
1261
 
 
1262
 
    @needs_write_lock
1263
 
    def revert(self, filenames, old_tree=None, backups=True, 
1264
 
               pb=DummyProgress()):
1265
 
        from transform import revert
1266
 
        from conflicts import resolve
1267
 
        if old_tree is None:
1268
 
            old_tree = self.basis_tree()
1269
 
        conflicts = revert(self, old_tree, filenames, backups, pb)
1270
 
        if not len(filenames):
1271
 
            self.set_pending_merges([])
1272
 
            resolve(self)
1273
 
        else:
1274
 
            resolve(self, filenames, ignore_misses=True)
1275
 
        return conflicts
1276
 
 
1277
 
    # XXX: This method should be deprecated in favour of taking in a proper
1278
 
    # new Inventory object.
1279
 
    @needs_write_lock
1280
 
    def set_inventory(self, new_inventory_list):
1281
 
        from bzrlib.inventory import (Inventory,
1282
 
                                      InventoryDirectory,
1283
 
                                      InventoryEntry,
1284
 
                                      InventoryFile,
1285
 
                                      InventoryLink)
1286
 
        inv = Inventory(self.get_root_id())
1287
 
        for path, file_id, parent, kind in new_inventory_list:
1288
 
            name = os.path.basename(path)
1289
 
            if name == "":
1290
 
                continue
1291
 
            # fixme, there should be a factory function inv,add_?? 
1292
 
            if kind == 'directory':
1293
 
                inv.add(InventoryDirectory(file_id, name, parent))
1294
 
            elif kind == 'file':
1295
 
                inv.add(InventoryFile(file_id, name, parent))
1296
 
            elif kind == 'symlink':
1297
 
                inv.add(InventoryLink(file_id, name, parent))
1298
 
            else:
1299
 
                raise BzrError("unknown kind %r" % kind)
1300
 
        self._write_inventory(inv)
1301
 
 
1302
 
    @needs_write_lock
1303
 
    def set_root_id(self, file_id):
1304
 
        """Set the root id for this tree."""
1305
 
        inv = self.read_working_inventory()
1306
 
        orig_root_id = inv.root.file_id
1307
 
        del inv._byid[inv.root.file_id]
1308
 
        inv.root.file_id = file_id
1309
 
        inv._byid[inv.root.file_id] = inv.root
1310
 
        for fid in inv:
1311
 
            entry = inv[fid]
1312
 
            if entry.parent_id == orig_root_id:
1313
 
                entry.parent_id = inv.root.file_id
1314
 
        self._write_inventory(inv)
1315
 
 
1316
 
    def unlock(self):
1317
 
        """See Branch.unlock.
1318
 
        
1319
 
        WorkingTree locking just uses the Branch locking facilities.
1320
 
        This is current because all working trees have an embedded branch
1321
 
        within them. IF in the future, we were to make branch data shareable
1322
 
        between multiple working trees, i.e. via shared storage, then we 
1323
 
        would probably want to lock both the local tree, and the branch.
1324
 
        """
1325
 
        # FIXME: We want to write out the hashcache only when the last lock on
1326
 
        # this working copy is released.  Peeking at the lock count is a bit
1327
 
        # of a nasty hack; probably it's better to have a transaction object,
1328
 
        # which can do some finalization when it's either successfully or
1329
 
        # unsuccessfully completed.  (Denys's original patch did that.)
1330
 
        # RBC 20060206 hookinhg into transaction will couple lock and transaction
1331
 
        # wrongly. Hookinh into unllock on the control files object is fine though.
1332
 
        
1333
 
        # TODO: split this per format so there is no ugly if block
1334
 
        if self._hashcache.needs_write and (
1335
 
            # dedicated lock files
1336
 
            self._control_files._lock_count==1 or 
1337
 
            # shared lock files
1338
 
            (self._control_files is self.branch.control_files and 
1339
 
             self._control_files._lock_count==3)):
1340
 
            self._hashcache.write()
1341
 
        # reverse order of locking.
1342
 
        try:
1343
 
            return self._control_files.unlock()
1344
 
        finally:
1345
 
            self.branch.unlock()
1346
 
 
1347
 
    @needs_write_lock
1348
 
    def update(self):
1349
 
        """Update a working tree along its branch.
1350
 
 
1351
 
        This will update the branch if its bound too, which means we have multiple trees involved:
1352
 
        The new basis tree of the master.
1353
 
        The old basis tree of the branch.
1354
 
        The old basis tree of the working tree.
1355
 
        The current working tree state.
1356
 
        pathologically all three may be different, and non ancestors of each other.
1357
 
        Conceptually we want to:
1358
 
        Preserve the wt.basis->wt.state changes
1359
 
        Transform the wt.basis to the new master basis.
1360
 
        Apply a merge of the old branch basis to get any 'local' changes from it into the tree.
1361
 
        Restore the wt.basis->wt.state changes.
1362
 
 
1363
 
        There isn't a single operation at the moment to do that, so we:
1364
 
        Merge current state -> basis tree of the master w.r.t. the old tree basis.
1365
 
        Do a 'normal' merge of the old branch basis if it is relevant.
1366
 
        """
1367
 
        old_tip = self.branch.update()
1368
 
        if old_tip is not None:
1369
 
            self.add_pending_merge(old_tip)
1370
 
        self.branch.lock_read()
1371
 
        try:
1372
 
            result = 0
1373
 
            if self.last_revision() != self.branch.last_revision():
1374
 
                # merge tree state up to new branch tip.
1375
 
                basis = self.basis_tree()
1376
 
                to_tree = self.branch.basis_tree()
1377
 
                result += merge_inner(self.branch,
1378
 
                                      to_tree,
1379
 
                                      basis,
1380
 
                                      this_tree=self)
1381
 
                self.set_last_revision(self.branch.last_revision())
1382
 
            if old_tip and old_tip != self.last_revision():
1383
 
                # our last revision was not the prior branch last reivison
1384
 
                # and we have converted that last revision to a pending merge.
1385
 
                # base is somewhere between the branch tip now
1386
 
                # and the now pending merge
1387
 
                from bzrlib.revision import common_ancestor
1388
 
                try:
1389
 
                    base_rev_id = common_ancestor(self.branch.last_revision(),
1390
 
                                                  old_tip,
1391
 
                                                  self.branch.repository)
1392
 
                except errors.NoCommonAncestor:
1393
 
                    base_rev_id = None
1394
 
                base_tree = self.branch.repository.revision_tree(base_rev_id)
1395
 
                other_tree = self.branch.repository.revision_tree(old_tip)
1396
 
                result += merge_inner(self.branch,
1397
 
                                      other_tree,
1398
 
                                      base_tree,
1399
 
                                      this_tree=self)
1400
 
            return result
1401
 
        finally:
1402
 
            self.branch.unlock()
1403
 
 
1404
 
    @needs_write_lock
1405
 
    def _write_inventory(self, inv):
1406
 
        """Write inventory as the current inventory."""
1407
 
        sio = StringIO()
1408
 
        bzrlib.xml5.serializer_v5.write_inventory(inv, sio)
1409
 
        sio.seek(0)
1410
 
        self._control_files.put('inventory', sio)
1411
 
        self._set_inventory(inv)
1412
 
        mutter('wrote working inventory')
1413
 
 
1414
 
    def set_conflicts(self, arg):
1415
 
        raise UnsupportedOperation(self.set_conflicts, self)
1416
 
 
1417
 
    @needs_read_lock
1418
 
    def conflicts(self):
1419
 
        conflicts = ConflictList()
1420
 
        for conflicted in self._iter_conflicts():
1421
 
            text = True
1422
 
            try:
1423
 
                if file_kind(self.abspath(conflicted)) != "file":
1424
 
                    text = False
1425
 
            except OSError, e:
1426
 
                if e.errno == errno.ENOENT:
1427
 
                    text = False
1428
 
                else:
1429
 
                    raise
1430
 
            if text is True:
1431
 
                for suffix in ('.THIS', '.OTHER'):
1432
 
                    try:
1433
 
                        kind = file_kind(self.abspath(conflicted+suffix))
1434
 
                    except OSError, e:
1435
 
                        if e.errno == errno.ENOENT:
1436
 
                            text = False
1437
 
                            break
1438
 
                        else:
1439
 
                            raise
1440
 
                    if kind != "file":
1441
 
                        text = False
1442
 
                        break
1443
 
            ctype = {True: 'text conflict', False: 'contents conflict'}[text]
1444
 
            conflicts.append(Conflict.factory(ctype, path=conflicted,
1445
 
                             file_id=self.path2id(conflicted)))
1446
 
        return conflicts
1447
 
 
1448
 
 
1449
 
class WorkingTree3(WorkingTree):
1450
 
    """This is the Format 3 working tree.
1451
 
 
1452
 
    This differs from the base WorkingTree by:
1453
 
     - having its own file lock
1454
 
     - having its own last-revision property.
1455
 
 
1456
 
    This is new in bzr 0.8
1457
 
    """
1458
 
 
1459
 
    @needs_read_lock
1460
 
    def last_revision(self):
1461
 
        """See WorkingTree.last_revision."""
1462
 
        try:
1463
 
            return self._control_files.get_utf8('last-revision').read()
1464
 
        except NoSuchFile:
1465
 
            return None
1466
 
 
1467
 
    def _change_last_revision(self, revision_id):
1468
 
        """See WorkingTree._change_last_revision."""
1469
 
        if revision_id is None or revision_id == NULL_REVISION:
1470
 
            try:
1471
 
                self._control_files._transport.delete('last-revision')
1472
 
            except errors.NoSuchFile:
1473
 
                pass
1474
 
            return False
1475
 
        else:
1476
 
            try:
1477
 
                self.branch.revision_history().index(revision_id)
1478
 
            except ValueError:
1479
 
                raise errors.NoSuchRevision(self.branch, revision_id)
1480
 
            self._control_files.put_utf8('last-revision', revision_id)
1481
 
            return True
1482
 
 
1483
 
    @needs_write_lock
1484
 
    def set_conflicts(self, conflicts):
1485
 
        self._put_rio('conflicts', conflicts.to_stanzas(), 
1486
 
                      CONFLICT_HEADER_1)
1487
 
 
1488
 
    @needs_read_lock
1489
 
    def conflicts(self):
1490
 
        try:
1491
 
            confile = self._control_files.get('conflicts')
1492
 
        except NoSuchFile:
1493
 
            return ConflictList()
1494
 
        try:
1495
 
            if confile.next() != CONFLICT_HEADER_1 + '\n':
1496
 
                raise ConflictFormatError()
1497
 
        except StopIteration:
1498
 
            raise ConflictFormatError()
1499
 
        return ConflictList.from_stanzas(RioReader(confile))
1500
 
 
1501
 
 
1502
 
def get_conflicted_stem(path):
1503
 
    for suffix in CONFLICT_SUFFIXES:
1504
 
        if path.endswith(suffix):
1505
 
            return path[:-len(suffix)]
1506
 
 
1507
 
@deprecated_function(zero_eight)
1508
 
def is_control_file(filename):
1509
 
    """See WorkingTree.is_control_filename(filename)."""
1510
 
    ## FIXME: better check
1511
 
    filename = normpath(filename)
1512
 
    while filename != '':
1513
 
        head, tail = os.path.split(filename)
1514
 
        ## mutter('check %r for control file' % ((head, tail),))
1515
 
        if tail == '.bzr':
1516
 
            return True
1517
 
        if filename == head:
1518
 
            break
1519
 
        filename = head
1520
 
    return False
1521
 
 
1522
 
 
1523
 
class WorkingTreeFormat(object):
1524
 
    """An encapsulation of the initialization and open routines for a format.
1525
 
 
1526
 
    Formats provide three things:
1527
 
     * An initialization routine,
1528
 
     * a format string,
1529
 
     * an open routine.
1530
 
 
1531
 
    Formats are placed in an dict by their format string for reference 
1532
 
    during workingtree opening. Its not required that these be instances, they
1533
 
    can be classes themselves with class methods - it simply depends on 
1534
 
    whether state is needed for a given format or not.
1535
 
 
1536
 
    Once a format is deprecated, just deprecate the initialize and open
1537
 
    methods on the format class. Do not deprecate the object, as the 
1538
 
    object will be created every time regardless.
1539
 
    """
1540
 
 
1541
 
    _default_format = None
1542
 
    """The default format used for new trees."""
1543
 
 
1544
 
    _formats = {}
1545
 
    """The known formats."""
1546
 
 
1547
 
    @classmethod
1548
 
    def find_format(klass, a_bzrdir):
1549
 
        """Return the format for the working tree object in a_bzrdir."""
1550
 
        try:
1551
 
            transport = a_bzrdir.get_workingtree_transport(None)
1552
 
            format_string = transport.get("format").read()
1553
 
            return klass._formats[format_string]
1554
 
        except NoSuchFile:
1555
 
            raise errors.NoWorkingTree(base=transport.base)
1556
 
        except KeyError:
1557
 
            raise errors.UnknownFormatError(format_string)
1558
 
 
1559
 
    @classmethod
1560
 
    def get_default_format(klass):
1561
 
        """Return the current default format."""
1562
 
        return klass._default_format
1563
 
 
1564
 
    def get_format_string(self):
1565
 
        """Return the ASCII format string that identifies this format."""
1566
 
        raise NotImplementedError(self.get_format_string)
1567
 
 
1568
 
    def get_format_description(self):
1569
 
        """Return the short description for this format."""
1570
 
        raise NotImplementedError(self.get_format_description)
1571
 
 
1572
 
    def is_supported(self):
1573
 
        """Is this format supported?
1574
 
 
1575
 
        Supported formats can be initialized and opened.
1576
 
        Unsupported formats may not support initialization or committing or 
1577
 
        some other features depending on the reason for not being supported.
1578
 
        """
1579
 
        return True
1580
 
 
1581
 
    @classmethod
1582
 
    def register_format(klass, format):
1583
 
        klass._formats[format.get_format_string()] = format
1584
 
 
1585
 
    @classmethod
1586
 
    def set_default_format(klass, format):
1587
 
        klass._default_format = format
1588
 
 
1589
 
    @classmethod
1590
 
    def unregister_format(klass, format):
1591
 
        assert klass._formats[format.get_format_string()] is format
1592
 
        del klass._formats[format.get_format_string()]
1593
 
 
1594
 
 
1595
 
 
1596
 
class WorkingTreeFormat2(WorkingTreeFormat):
1597
 
    """The second working tree format. 
1598
 
 
1599
 
    This format modified the hash cache from the format 1 hash cache.
1600
 
    """
1601
 
 
1602
 
    def get_format_description(self):
1603
 
        """See WorkingTreeFormat.get_format_description()."""
1604
 
        return "Working tree format 2"
1605
 
 
1606
 
    def stub_initialize_remote(self, control_files):
1607
 
        """As a special workaround create critical control files for a remote working tree
1608
 
        
1609
 
        This ensures that it can later be updated and dealt with locally,
1610
 
        since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with 
1611
 
        no working tree.  (See bug #43064).
1612
 
        """
1613
 
        sio = StringIO()
1614
 
        inv = Inventory()
1615
 
        bzrlib.xml5.serializer_v5.write_inventory(inv, sio)
1616
 
        sio.seek(0)
1617
 
        control_files.put('inventory', sio)
1618
 
 
1619
 
        control_files.put_utf8('pending-merges', '')
1620
 
        
1621
 
 
1622
 
    def initialize(self, a_bzrdir, revision_id=None):
1623
 
        """See WorkingTreeFormat.initialize()."""
1624
 
        if not isinstance(a_bzrdir.transport, LocalTransport):
1625
 
            raise errors.NotLocalUrl(a_bzrdir.transport.base)
1626
 
        branch = a_bzrdir.open_branch()
1627
 
        if revision_id is not None:
1628
 
            branch.lock_write()
1629
 
            try:
1630
 
                revision_history = branch.revision_history()
1631
 
                try:
1632
 
                    position = revision_history.index(revision_id)
1633
 
                except ValueError:
1634
 
                    raise errors.NoSuchRevision(branch, revision_id)
1635
 
                branch.set_revision_history(revision_history[:position + 1])
1636
 
            finally:
1637
 
                branch.unlock()
1638
 
        revision = branch.last_revision()
1639
 
        inv = Inventory() 
1640
 
        wt = WorkingTree(a_bzrdir.root_transport.base,
1641
 
                         branch,
1642
 
                         inv,
1643
 
                         _internal=True,
1644
 
                         _format=self,
1645
 
                         _bzrdir=a_bzrdir)
1646
 
        wt._write_inventory(inv)
1647
 
        wt.set_root_id(inv.root.file_id)
1648
 
        wt.set_last_revision(revision)
1649
 
        wt.set_pending_merges([])
1650
 
        build_tree(wt.basis_tree(), wt)
1651
 
        return wt
1652
 
 
1653
 
    def __init__(self):
1654
 
        super(WorkingTreeFormat2, self).__init__()
1655
 
        self._matchingbzrdir = bzrdir.BzrDirFormat6()
1656
 
 
1657
 
    def open(self, a_bzrdir, _found=False):
1658
 
        """Return the WorkingTree object for a_bzrdir
1659
 
 
1660
 
        _found is a private parameter, do not use it. It is used to indicate
1661
 
               if format probing has already been done.
1662
 
        """
1663
 
        if not _found:
1664
 
            # we are being called directly and must probe.
1665
 
            raise NotImplementedError
1666
 
        if not isinstance(a_bzrdir.transport, LocalTransport):
1667
 
            raise errors.NotLocalUrl(a_bzrdir.transport.base)
1668
 
        return WorkingTree(a_bzrdir.root_transport.base,
1669
 
                           _internal=True,
1670
 
                           _format=self,
1671
 
                           _bzrdir=a_bzrdir)
1672
 
 
1673
 
 
1674
 
class WorkingTreeFormat3(WorkingTreeFormat):
1675
 
    """The second working tree format updated to record a format marker.
1676
 
 
1677
 
    This format:
1678
 
        - exists within a metadir controlling .bzr
1679
 
        - includes an explicit version marker for the workingtree control
1680
 
          files, separate from the BzrDir format
1681
 
        - modifies the hash cache format
1682
 
        - is new in bzr 0.8
1683
 
        - uses a LockDir to guard access to the repository
1684
 
    """
1685
 
 
1686
 
    def get_format_string(self):
1687
 
        """See WorkingTreeFormat.get_format_string()."""
1688
 
        return "Bazaar-NG Working Tree format 3"
1689
 
 
1690
 
    def get_format_description(self):
1691
 
        """See WorkingTreeFormat.get_format_description()."""
1692
 
        return "Working tree format 3"
1693
 
 
1694
 
    _lock_file_name = 'lock'
1695
 
    _lock_class = LockDir
1696
 
 
1697
 
    def _open_control_files(self, a_bzrdir):
1698
 
        transport = a_bzrdir.get_workingtree_transport(None)
1699
 
        return LockableFiles(transport, self._lock_file_name, 
1700
 
                             self._lock_class)
1701
 
 
1702
 
    def initialize(self, a_bzrdir, revision_id=None):
1703
 
        """See WorkingTreeFormat.initialize().
1704
 
        
1705
 
        revision_id allows creating a working tree at a differnet
1706
 
        revision than the branch is at.
1707
 
        """
1708
 
        if not isinstance(a_bzrdir.transport, LocalTransport):
1709
 
            raise errors.NotLocalUrl(a_bzrdir.transport.base)
1710
 
        transport = a_bzrdir.get_workingtree_transport(self)
1711
 
        control_files = self._open_control_files(a_bzrdir)
1712
 
        control_files.create_lock()
1713
 
        control_files.lock_write()
1714
 
        control_files.put_utf8('format', self.get_format_string())
1715
 
        branch = a_bzrdir.open_branch()
1716
 
        if revision_id is None:
1717
 
            revision_id = branch.last_revision()
1718
 
        inv = Inventory() 
1719
 
        wt = WorkingTree3(a_bzrdir.root_transport.base,
1720
 
                         branch,
1721
 
                         inv,
1722
 
                         _internal=True,
1723
 
                         _format=self,
1724
 
                         _bzrdir=a_bzrdir,
1725
 
                         _control_files=control_files)
1726
 
        wt.lock_write()
1727
 
        try:
1728
 
            wt._write_inventory(inv)
1729
 
            wt.set_root_id(inv.root.file_id)
1730
 
            wt.set_last_revision(revision_id)
1731
 
            wt.set_pending_merges([])
1732
 
            build_tree(wt.basis_tree(), wt)
1733
 
        finally:
1734
 
            wt.unlock()
1735
 
            control_files.unlock()
1736
 
        return wt
1737
 
 
1738
 
    def __init__(self):
1739
 
        super(WorkingTreeFormat3, self).__init__()
1740
 
        self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1741
 
 
1742
 
    def open(self, a_bzrdir, _found=False):
1743
 
        """Return the WorkingTree object for a_bzrdir
1744
 
 
1745
 
        _found is a private parameter, do not use it. It is used to indicate
1746
 
               if format probing has already been done.
1747
 
        """
1748
 
        if not _found:
1749
 
            # we are being called directly and must probe.
1750
 
            raise NotImplementedError
1751
 
        if not isinstance(a_bzrdir.transport, LocalTransport):
1752
 
            raise errors.NotLocalUrl(a_bzrdir.transport.base)
1753
 
        control_files = self._open_control_files(a_bzrdir)
1754
 
        return WorkingTree3(a_bzrdir.root_transport.base,
1755
 
                           _internal=True,
1756
 
                           _format=self,
1757
 
                           _bzrdir=a_bzrdir,
1758
 
                           _control_files=control_files)
1759
 
 
1760
 
    def __str__(self):
1761
 
        return self.get_format_string()
1762
 
 
1763
 
 
1764
 
# formats which have no format string are not discoverable
1765
 
# and not independently creatable, so are not registered.
1766
 
__default_format = WorkingTreeFormat3()
1767
 
WorkingTreeFormat.register_format(__default_format)
1768
 
WorkingTreeFormat.set_default_format(__default_format)
1769
 
_legacy_formats = [WorkingTreeFormat2(),
1770
 
                   ]
1771
 
 
1772
 
 
1773
 
class WorkingTreeTestProviderAdapter(object):
1774
 
    """A tool to generate a suite testing multiple workingtree formats at once.
1775
 
 
1776
 
    This is done by copying the test once for each transport and injecting
1777
 
    the transport_server, transport_readonly_server, and workingtree_format
1778
 
    classes into each copy. Each copy is also given a new id() to make it
1779
 
    easy to identify.
1780
 
    """
1781
 
 
1782
 
    def __init__(self, transport_server, transport_readonly_server, formats):
1783
 
        self._transport_server = transport_server
1784
 
        self._transport_readonly_server = transport_readonly_server
1785
 
        self._formats = formats
1786
 
    
1787
 
    def adapt(self, test):
1788
 
        from bzrlib.tests import TestSuite
1789
 
        result = TestSuite()
1790
 
        for workingtree_format, bzrdir_format in self._formats:
1791
 
            new_test = deepcopy(test)
1792
 
            new_test.transport_server = self._transport_server
1793
 
            new_test.transport_readonly_server = self._transport_readonly_server
1794
 
            new_test.bzrdir_format = bzrdir_format
1795
 
            new_test.workingtree_format = workingtree_format
1796
 
            def make_new_test_id():
1797
 
                new_id = "%s(%s)" % (new_test.id(), workingtree_format.__class__.__name__)
1798
 
                return lambda: new_id
1799
 
            new_test.id = make_new_test_id()
1800
 
            result.addTest(new_test)
1801
 
        return result