/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/workingtree.py

  • Committer: John Arbash Meinel
  • Date: 2006-05-27 06:18:34 UTC
  • mto: (1711.2.26 jam-integration)
  • mto: This revision was merged to the branch mainline in revision 1734.
  • Revision ID: john@arbash-meinel.com-20060527061834-27459f9cd8d908f0
Trying multiple things to get WorkingTree.list_files time down

Show diffs side-by-side

added added

removed removed

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