~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/workingtree.py

  • Committer: Martin Pool
  • Date: 2005-05-03 08:00:27 UTC
  • Revision ID: mbp@sourcefrog.net-20050503080027-908edb5b39982198
doc

Show diffs side-by-side

added added

removed removed

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