/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 09:06:37 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-20060527090637-e79e7f56c20f70c3
Switch iter_entries from being a recursive function and using pathjoin

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