/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 03:11:07 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-20060527031107-6969266aa397354e
Adding a benchmark which checks 'bzr status' time after a commit.

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