1
# Copyright (C) 2005, 2006 Canonical Ltd
 
 
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.
 
 
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.
 
 
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
 
 
17
"""WorkingTree object and friends.
 
 
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.
 
 
25
At the moment every WorkingTree has its own branch.  Remote
 
 
26
WorkingTrees aren't supported.
 
 
28
To get a WorkingTree, call bzrdir.open_workingtree() or
 
 
29
WorkingTree.open(dir).
 
 
32
MERGE_MODIFIED_HEADER_1 = "BZR merge-modified list format 1"
 
 
33
CONFLICT_HEADER_1 = "BZR conflict list format 1"
 
 
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)
 
 
42
from binascii import hexlify
 
 
43
from copy import deepcopy
 
 
44
from cStringIO import StringIO
 
 
52
from bzrlib.atomicfile import AtomicFile
 
 
53
from bzrlib.branch import (Branch,
 
 
55
from bzrlib.conflicts import Conflict, ConflictList, CONFLICT_SUFFIXES
 
 
56
import bzrlib.bzrdir as bzrdir
 
 
57
from bzrlib.decorators import needs_read_lock, needs_write_lock
 
 
58
import bzrlib.errors as errors
 
 
59
from bzrlib.errors import (BzrCheckError,
 
 
63
                           WeaveRevisionNotPresent,
 
 
67
                           MergeModifiedFormatError,
 
 
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 (
 
 
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
 
 
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
 
 
106
# the regex here does the following:
 
 
107
# 1) remove any weird characters; we don't escape them but rather
 
 
109
 # 2) match leading '.'s to make it not hidden
 
 
110
_gen_file_id_re = re.compile(r'[^\w.]|(^\.*)')
 
 
111
_gen_id_suffix = None
 
 
115
def _next_id_suffix():
 
 
116
    """Create a new file id suffix that is reasonably unique.
 
 
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.
 
 
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))
 
 
130
    return _gen_id_suffix + str(_gen_id_serial)
 
 
133
def gen_file_id(name):
 
 
134
    """Return new file id for the basename 'name'.
 
 
136
    The uniqueness is supplied from _next_id_suffix.
 
 
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()
 
 
146
    """Return a new tree-root file id."""
 
 
147
    return gen_file_id('TREE_ROOT')
 
 
150
class TreeEntry(object):
 
 
151
    """An entry that implements the minium interface used by commands.
 
 
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
 
 
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
 
 
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__)
 
 
168
    def kind_character(self):
 
 
172
class TreeDirectory(TreeEntry):
 
 
173
    """See TreeEntry. This is a directory in a working tree."""
 
 
175
    def __eq__(self, other):
 
 
176
        return (isinstance(other, TreeDirectory)
 
 
177
                and other.__class__ == self.__class__)
 
 
179
    def kind_character(self):
 
 
183
class TreeFile(TreeEntry):
 
 
184
    """See TreeEntry. This is a regular file in a working tree."""
 
 
186
    def __eq__(self, other):
 
 
187
        return (isinstance(other, TreeFile)
 
 
188
                and other.__class__ == self.__class__)
 
 
190
    def kind_character(self):
 
 
194
class TreeLink(TreeEntry):
 
 
195
    """See TreeEntry. This is a symlink in a working tree."""
 
 
197
    def __eq__(self, other):
 
 
198
        return (isinstance(other, TreeLink)
 
 
199
                and other.__class__ == self.__class__)
 
 
201
    def kind_character(self):
 
 
205
class WorkingTree(bzrlib.tree.Tree):
 
 
206
    """Working copy tree.
 
 
208
    The inventory is held in the `Branch` working-inventory, and the
 
 
209
    files are in a directory on disk.
 
 
211
    It is possible for a `WorkingTree` to have a filename which is
 
 
212
    not listed in the Inventory and vice versa.
 
 
215
    def __init__(self, basedir='.',
 
 
216
                 branch=DEPRECATED_PARAMETER,
 
 
222
        """Construct a WorkingTree for basedir.
 
 
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).
 
 
229
        self._format = _format
 
 
230
        self.bzrdir = _bzrdir
 
 
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().",
 
 
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):
 
 
253
                warn("WorkingTree(..., branch=XXX) is deprecated as of bzr 0.8."
 
 
254
                     " Please use bzrdir.open_workingtree() or"
 
 
255
                     " WorkingTree.open().",
 
 
259
            self._branch = branch
 
 
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
 
 
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" \
 
 
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
 
 
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)
 
 
285
        # is this scan needed ? it makes things kinda slow.
 
 
292
        if _inventory is None:
 
 
293
            self._set_inventory(self.read_working_inventory())
 
 
295
            self._set_inventory(_inventory)
 
 
298
        fget=lambda self: self._branch,
 
 
299
        doc="""The branch this WorkingTree is connected to.
 
 
301
            This cannot be set - it is reflective of the actual disk structure
 
 
302
            the working tree has been constructed from.
 
 
305
    def break_lock(self):
 
 
306
        """Break a lock if one is present from another instance.
 
 
308
        Uses the ui factory to ask for confirmation if the lock may be from
 
 
311
        This will probe the repository for its lock as well.
 
 
313
        self._control_files.break_lock()
 
 
314
        self.branch.break_lock()
 
 
316
    def _set_inventory(self, inv):
 
 
317
        self._inventory = inv
 
 
318
        self.path2id = self._inventory.path2id
 
 
320
    def is_control_filename(self, filename):
 
 
321
        """True if filename is the name of a control file in this tree.
 
 
323
        :param filename: A filename within the tree. This is a relative path
 
 
324
        from the root of this tree.
 
 
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.
 
 
330
        return self.bzrdir.is_control_filename(filename)
 
 
333
    def open(path=None, _unsupported=False):
 
 
334
        """Open an existing working tree at path.
 
 
338
            path = os.path.getcwdu()
 
 
339
        control = bzrdir.BzrDir.open(path, _unsupported)
 
 
340
        return control.open_workingtree(_unsupported)
 
 
343
    def open_containing(path=None):
 
 
344
        """Open an existing working tree which has its root about path.
 
 
346
        This probes for a working tree at path and searches upwards from there.
 
 
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.
 
 
355
        control, relpath = bzrdir.BzrDir.open_containing(path)
 
 
356
        return control.open_workingtree(), relpath
 
 
359
    def open_downlevel(path=None):
 
 
360
        """Open an unsupported working tree.
 
 
362
        Only intended for advanced situations like upgrading part of a bzrdir.
 
 
364
        return WorkingTree.open(path, _unsupported=True)
 
 
367
        """Iterate through file_ids for this tree.
 
 
369
        file_ids are in a WorkingTree if they are in the working inventory
 
 
370
        and the working file exists.
 
 
372
        inv = self._inventory
 
 
373
        for path, ie in inv.iter_entries():
 
 
374
            if bzrlib.osutils.lexists(self.abspath(path)):
 
 
378
        return "<%s of %s>" % (self.__class__.__name__,
 
 
379
                               getattr(self, 'basedir', None))
 
 
381
    def abspath(self, filename):
 
 
382
        return pathjoin(self.basedir, filename)
 
 
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:
 
 
389
                xml = self.read_basis_inventory()
 
 
390
                inv = bzrlib.xml5.serializer_v5.read_inventory_from_string(xml)
 
 
393
            if inv is not None and inv.revision_id == revision_id:
 
 
394
                return bzrlib.tree.RevisionTree(self.branch.repository, inv,
 
 
396
        # FIXME? RBC 20060403 should we cache the inventory here ?
 
 
397
        return self.branch.repository.revision_tree(revision_id)
 
 
400
    @deprecated_method(zero_eight)
 
 
401
    def create(branch, directory):
 
 
402
        """Create a workingtree for branch at directory.
 
 
404
        If existing_directory already exists it must have a .bzr directory.
 
 
405
        If it does not exist, it will be created.
 
 
407
        This returns a new WorkingTree object for the new checkout.
 
 
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.]
 
 
413
        XXX: When BzrDir is present, these should be created through that 
 
 
416
        warn('delete WorkingTree.create', stacklevel=3)
 
 
417
        transport = get_transport(directory)
 
 
418
        if branch.bzrdir.root_transport.base == transport.base:
 
 
420
            return branch.bzrdir.create_workingtree()
 
 
421
        # different directory, 
 
 
422
        # create a branch reference
 
 
423
        # and now a working tree.
 
 
424
        raise NotImplementedError
 
 
427
    @deprecated_method(zero_eight)
 
 
428
    def create_standalone(directory):
 
 
429
        """Create a checkout and a branch and a repo at directory.
 
 
431
        Directory must exist and be empty.
 
 
433
        please use BzrDir.create_standalone_workingtree
 
 
435
        return bzrdir.BzrDir.create_standalone_workingtree(directory)
 
 
437
    def relpath(self, path):
 
 
438
        """Return the local path portion from a given path.
 
 
440
        The path may be absolute or relative. If its a relative path it is 
 
 
441
        interpreted relative to the python current working directory.
 
 
443
        return relpath(self.basedir, path)
 
 
445
    def has_filename(self, filename):
 
 
446
        return bzrlib.osutils.lexists(self.abspath(filename))
 
 
448
    def get_file(self, file_id):
 
 
449
        return self.get_file_byname(self.id2path(file_id))
 
 
451
    def get_file_byname(self, filename):
 
 
452
        return file(self.abspath(filename), 'rb')
 
 
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
 
 
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))
 
 
464
    def clone(self, to_bzrdir, revision_id=None, basis=None):
 
 
465
        """Duplicate this working tree into to_bzr, including all state.
 
 
467
        Specifically modified files are kept as modified, but
 
 
468
        ignored and unknown files are discarded.
 
 
470
        If you want to make a new line of development, see bzrdir.sprout()
 
 
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.
 
 
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.
 
 
481
        # assumes the target bzr dir format is compatible.
 
 
482
        result = self._format.initialize(to_bzrdir)
 
 
483
        self.copy_content_into(result, revision_id)
 
 
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)
 
 
492
            # TODO now merge from tree.last_revision to revision
 
 
493
            transform_tree(tree, self)
 
 
494
            tree.set_last_revision(revision_id)
 
 
497
    def commit(self, message=None, revprops=None, *args, **kwargs):
 
 
498
        # avoid circular imports
 
 
499
        from bzrlib.commit import Commit
 
 
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())
 
 
511
    def id2abspath(self, file_id):
 
 
512
        return self.abspath(self.id2path(file_id))
 
 
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):
 
 
519
        path = inv.id2path(file_id)
 
 
520
        return bzrlib.osutils.lexists(self.abspath(path))
 
 
522
    def has_or_had_id(self, file_id):
 
 
523
        if file_id == self.inventory.root.file_id:
 
 
525
        return self.inventory.has_id(file_id)
 
 
527
    __contains__ = has_id
 
 
529
    def get_file_size(self, file_id):
 
 
530
        return os.path.getsize(self.id2abspath(file_id))
 
 
533
    def get_file_sha1(self, file_id):
 
 
534
        path = self._inventory.id2path(file_id)
 
 
535
        return self._hashcache.get_sha1(path)
 
 
537
    def is_executable(self, file_id):
 
 
538
        if not supports_executable():
 
 
539
            return self._inventory[file_id].executable
 
 
541
            path = self._inventory.id2path(file_id)
 
 
542
            mode = os.lstat(self.abspath(path)).st_mode
 
 
543
            return bool(stat.S_ISREG(mode) and stat.S_IEXEC&mode)
 
 
546
    def add(self, files, ids=None):
 
 
547
        """Make files versioned.
 
 
549
        Note that the command line normally calls smart_add instead,
 
 
550
        which can automatically recurse.
 
 
552
        This adds the files to the inventory, so that they will be
 
 
553
        recorded by the next commit.
 
 
556
            List of paths to add, relative to the base of the tree.
 
 
559
            If set, use these instead of automatically generated ids.
 
 
560
            Must be the same length as the list of files, but may
 
 
561
            contain None for ids that are to be autogenerated.
 
 
563
        TODO: Perhaps have an option to add the ids even if the files do
 
 
566
        TODO: Perhaps callback with the ids and paths as they're added.
 
 
568
        # TODO: Re-adding a file that is removed in the working copy
 
 
569
        # should probably put it back with the previous ID.
 
 
570
        if isinstance(files, basestring):
 
 
571
            assert(ids is None or isinstance(ids, basestring))
 
 
577
            ids = [None] * len(files)
 
 
579
            assert(len(ids) == len(files))
 
 
581
        inv = self.read_working_inventory()
 
 
582
        for f,file_id in zip(files, ids):
 
 
583
            if self.is_control_filename(f):
 
 
584
                raise BzrError("cannot add control file %s" % quotefn(f))
 
 
589
                raise BzrError("cannot add top-level %r" % f)
 
 
591
            fullpath = normpath(self.abspath(f))
 
 
594
                kind = file_kind(fullpath)
 
 
596
                if e.errno == errno.ENOENT:
 
 
597
                    raise NoSuchFile(fullpath)
 
 
598
                # maybe something better?
 
 
599
                raise BzrError('cannot add: not a regular file, symlink or directory: %s' % quotefn(f))
 
 
601
            if not InventoryEntry.versionable_kind(kind):
 
 
602
                raise BzrError('cannot add: not a versionable file ('
 
 
603
                               'i.e. regular file, symlink or directory): %s' % quotefn(f))
 
 
606
                inv.add_path(f, kind=kind)
 
 
608
                inv.add_path(f, kind=kind, file_id=file_id)
 
 
610
        self._write_inventory(inv)
 
 
613
    def add_pending_merge(self, *revision_ids):
 
 
614
        # TODO: Perhaps should check at this point that the
 
 
615
        # history of the revision is actually present?
 
 
616
        p = self.pending_merges()
 
 
618
        for rev_id in revision_ids:
 
 
624
            self.set_pending_merges(p)
 
 
627
    def pending_merges(self):
 
 
628
        """Return a list of pending merges.
 
 
630
        These are revisions that have been merged into the working
 
 
631
        directory but not yet committed.
 
 
634
            merges_file = self._control_files.get_utf8('pending-merges')
 
 
636
            if e.errno != errno.ENOENT:
 
 
640
        for l in merges_file.readlines():
 
 
641
            p.append(l.rstrip('\n'))
 
 
645
    def set_pending_merges(self, rev_list):
 
 
646
        self._control_files.put_utf8('pending-merges', '\n'.join(rev_list))
 
 
649
    def set_merge_modified(self, modified_hashes):
 
 
651
            for file_id, hash in modified_hashes.iteritems():
 
 
652
                yield Stanza(file_id=file_id, hash=hash)
 
 
653
        self._put_rio('merge-hashes', iter_stanzas(), MERGE_MODIFIED_HEADER_1)
 
 
656
    def _put_rio(self, filename, stanzas, header):
 
 
657
        my_file = rio_file(stanzas, header)
 
 
658
        self._control_files.put(filename, my_file)
 
 
661
    def merge_modified(self):
 
 
663
            hashfile = self._control_files.get('merge-hashes')
 
 
668
            if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
 
 
669
                raise MergeModifiedFormatError()
 
 
670
        except StopIteration:
 
 
671
            raise MergeModifiedFormatError()
 
 
672
        for s in RioReader(hashfile):
 
 
673
            file_id = s.get("file_id")
 
 
674
            if file_id not in self.inventory:
 
 
677
            if hash == self.get_file_sha1(file_id):
 
 
678
                merge_hashes[file_id] = hash
 
 
681
    def get_symlink_target(self, file_id):
 
 
682
        return os.readlink(self.id2abspath(file_id))
 
 
684
    def file_class(self, filename):
 
 
685
        if self.path2id(filename):
 
 
687
        elif self.is_ignored(filename):
 
 
692
    def list_files(self):
 
 
693
        """Recursively list all files as (path, class, kind, id).
 
 
695
        Lists, but does not descend into unversioned directories.
 
 
697
        This does not include files that have been deleted in this
 
 
700
        Skips the control directory.
 
 
702
        inv = self._inventory
 
 
704
        def descend(from_dir_relpath, from_dir_id, dp):
 
 
708
                ## TODO: If we find a subdirectory with its own .bzr
 
 
709
                ## directory, then that is a separate tree and we
 
 
710
                ## should exclude it.
 
 
712
                # the bzrdir for this tree
 
 
713
                if self.bzrdir.transport.base.endswith(f + '/'):
 
 
717
                fp = appendpath(from_dir_relpath, f)
 
 
720
                fap = appendpath(dp, f)
 
 
722
                f_ie = inv.get_child(from_dir_id, f)
 
 
725
                elif self.is_ignored(fp):
 
 
734
                        raise BzrCheckError("file %r entered as kind %r id %r, "
 
 
736
                                            % (fap, f_ie.kind, f_ie.file_id, fk))
 
 
738
                # make a last minute entry
 
 
742
                    if fk == 'directory':
 
 
743
                        entry = TreeDirectory()
 
 
746
                    elif fk == 'symlink':
 
 
751
                yield fp, c, fk, (f_ie and f_ie.file_id), entry
 
 
753
                if fk != 'directory':
 
 
757
                    # don't descend unversioned directories
 
 
760
                for ff in descend(fp, f_ie.file_id, fap):
 
 
763
        for f in descend(u'', inv.root.file_id, self.basedir):
 
 
767
    def move(self, from_paths, to_name):
 
 
770
        to_name must exist in the inventory.
 
 
772
        If to_name exists and is a directory, the files are moved into
 
 
773
        it, keeping their old names.  
 
 
775
        Note that to_name is only the last component of the new name;
 
 
776
        this doesn't change the directory.
 
 
778
        This returns a list of (from_path, to_path) pairs for each
 
 
782
        ## TODO: Option to move IDs only
 
 
783
        assert not isinstance(from_paths, basestring)
 
 
785
        to_abs = self.abspath(to_name)
 
 
786
        if not isdir(to_abs):
 
 
787
            raise BzrError("destination %r is not a directory" % to_abs)
 
 
788
        if not self.has_filename(to_name):
 
 
789
            raise BzrError("destination %r not in working directory" % to_abs)
 
 
790
        to_dir_id = inv.path2id(to_name)
 
 
791
        if to_dir_id == None and to_name != '':
 
 
792
            raise BzrError("destination %r is not a versioned directory" % to_name)
 
 
793
        to_dir_ie = inv[to_dir_id]
 
 
794
        if to_dir_ie.kind not in ('directory', 'root_directory'):
 
 
795
            raise BzrError("destination %r is not a directory" % to_abs)
 
 
797
        to_idpath = inv.get_idpath(to_dir_id)
 
 
800
            if not self.has_filename(f):
 
 
801
                raise BzrError("%r does not exist in working tree" % f)
 
 
802
            f_id = inv.path2id(f)
 
 
804
                raise BzrError("%r is not versioned" % f)
 
 
805
            name_tail = splitpath(f)[-1]
 
 
806
            dest_path = appendpath(to_name, name_tail)
 
 
807
            if self.has_filename(dest_path):
 
 
808
                raise BzrError("destination %r already exists" % dest_path)
 
 
809
            if f_id in to_idpath:
 
 
810
                raise BzrError("can't move %r to a subdirectory of itself" % f)
 
 
812
        # OK, so there's a race here, it's possible that someone will
 
 
813
        # create a file in this interval and then the rename might be
 
 
814
        # left half-done.  But we should have caught most problems.
 
 
815
        orig_inv = deepcopy(self.inventory)
 
 
818
                name_tail = splitpath(f)[-1]
 
 
819
                dest_path = appendpath(to_name, name_tail)
 
 
820
                result.append((f, dest_path))
 
 
821
                inv.rename(inv.path2id(f), to_dir_id, name_tail)
 
 
823
                    rename(self.abspath(f), self.abspath(dest_path))
 
 
825
                    raise BzrError("failed to rename %r to %r: %s" %
 
 
826
                                   (f, dest_path, e[1]),
 
 
827
                            ["rename rolled back"])
 
 
829
            # restore the inventory on error
 
 
830
            self._set_inventory(orig_inv)
 
 
832
        self._write_inventory(inv)
 
 
836
    def rename_one(self, from_rel, to_rel):
 
 
839
        This can change the directory or the filename or both.
 
 
842
        if not self.has_filename(from_rel):
 
 
843
            raise BzrError("can't rename: old working file %r does not exist" % from_rel)
 
 
844
        if self.has_filename(to_rel):
 
 
845
            raise BzrError("can't rename: new working file %r already exists" % to_rel)
 
 
847
        file_id = inv.path2id(from_rel)
 
 
849
            raise BzrError("can't rename: old name %r is not versioned" % from_rel)
 
 
852
        from_parent = entry.parent_id
 
 
853
        from_name = entry.name
 
 
855
        if inv.path2id(to_rel):
 
 
856
            raise BzrError("can't rename: new name %r is already versioned" % to_rel)
 
 
858
        to_dir, to_tail = os.path.split(to_rel)
 
 
859
        to_dir_id = inv.path2id(to_dir)
 
 
860
        if to_dir_id == None and to_dir != '':
 
 
861
            raise BzrError("can't determine destination directory id for %r" % to_dir)
 
 
863
        mutter("rename_one:")
 
 
864
        mutter("  file_id    {%s}" % file_id)
 
 
865
        mutter("  from_rel   %r" % from_rel)
 
 
866
        mutter("  to_rel     %r" % to_rel)
 
 
867
        mutter("  to_dir     %r" % to_dir)
 
 
868
        mutter("  to_dir_id  {%s}" % to_dir_id)
 
 
870
        inv.rename(file_id, to_dir_id, to_tail)
 
 
872
        from_abs = self.abspath(from_rel)
 
 
873
        to_abs = self.abspath(to_rel)
 
 
875
            rename(from_abs, to_abs)
 
 
877
            inv.rename(file_id, from_parent, from_name)
 
 
878
            raise BzrError("failed to rename %r to %r: %s"
 
 
879
                    % (from_abs, to_abs, e[1]),
 
 
880
                    ["rename rolled back"])
 
 
881
        self._write_inventory(inv)
 
 
885
        """Return all unknown files.
 
 
887
        These are files in the working directory that are not versioned or
 
 
888
        control files or ignored.
 
 
890
        >>> from bzrlib.bzrdir import ScratchDir
 
 
891
        >>> d = ScratchDir(files=['foo', 'foo~'])
 
 
892
        >>> b = d.open_branch()
 
 
893
        >>> tree = d.open_workingtree()
 
 
894
        >>> map(str, tree.unknowns())
 
 
897
        >>> list(b.unknowns())
 
 
899
        >>> tree.remove('foo')
 
 
900
        >>> list(b.unknowns())
 
 
903
        for subp in self.extras():
 
 
904
            if not self.is_ignored(subp):
 
 
907
    @deprecated_method(zero_eight)
 
 
908
    def iter_conflicts(self):
 
 
909
        """List all files in the tree that have text or content conflicts.
 
 
910
        DEPRECATED.  Use conflicts instead."""
 
 
911
        return self._iter_conflicts()
 
 
913
    def _iter_conflicts(self):
 
 
915
        for path in (s[0] for s in self.list_files()):
 
 
916
            stem = get_conflicted_stem(path)
 
 
919
            if stem not in conflicted:
 
 
924
    def pull(self, source, overwrite=False, stop_revision=None):
 
 
925
        top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
 
928
            pp = ProgressPhase("Pull phase", 2, top_pb)
 
 
930
            old_revision_history = self.branch.revision_history()
 
 
931
            basis_tree = self.basis_tree()
 
 
932
            count = self.branch.pull(source, overwrite, stop_revision)
 
 
933
            new_revision_history = self.branch.revision_history()
 
 
934
            if new_revision_history != old_revision_history:
 
 
936
                if len(old_revision_history):
 
 
937
                    other_revision = old_revision_history[-1]
 
 
939
                    other_revision = None
 
 
940
                repository = self.branch.repository
 
 
941
                pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
 
943
                    merge_inner(self.branch,
 
 
944
                                self.branch.basis_tree(),
 
 
950
                self.set_last_revision(self.branch.last_revision())
 
 
957
        """Yield all unknown files in this WorkingTree.
 
 
959
        If there are any unknown directories then only the directory is
 
 
960
        returned, not all its children.  But if there are unknown files
 
 
961
        under a versioned subdirectory, they are returned.
 
 
963
        Currently returned depth-first, sorted by name within directories.
 
 
965
        ## TODO: Work from given directory downwards
 
 
966
        for path, dir_entry in self.inventory.directories():
 
 
967
            mutter("search for unknowns in %r", path)
 
 
968
            dirabs = self.abspath(path)
 
 
969
            if not isdir(dirabs):
 
 
970
                # e.g. directory deleted
 
 
974
            for subf in os.listdir(dirabs):
 
 
976
                    and (subf not in dir_entry.children)):
 
 
981
                subp = appendpath(path, subf)
 
 
984
    def _translate_ignore_rule(self, rule):
 
 
985
        """Translate a single ignore rule to a regex.
 
 
987
        There are two types of ignore rules.  Those that do not contain a / are
 
 
988
        matched against the tail of the filename (that is, they do not care
 
 
989
        what directory the file is in.)  Rules which do contain a slash must
 
 
990
        match the entire path.  As a special case, './' at the start of the
 
 
991
        string counts as a slash in the string but is removed before matching
 
 
992
        (e.g. ./foo.c, ./src/foo.c)
 
 
994
        :return: The translated regex.
 
 
996
        if rule[:2] in ('./', '.\\'):
 
 
998
            result = fnmatch.translate(rule[2:])
 
 
999
        elif '/' in rule or '\\' in rule:
 
 
1001
            result = fnmatch.translate(rule)
 
 
1003
            # default rule style.
 
 
1004
            result = "(?:.*/)?(?!.*/)" + fnmatch.translate(rule)
 
 
1005
        assert result[-1] == '$', "fnmatch.translate did not add the expected $"
 
 
1006
        return "(" + result + ")"
 
 
1008
    def _combine_ignore_rules(self, rules):
 
 
1009
        """Combine a list of ignore rules into a single regex object.
 
 
1011
        Each individual rule is combined with | to form a big regex, which then
 
 
1012
        has $ added to it to form something like ()|()|()$. The group index for
 
 
1013
        each subregex's outermost group is placed in a dictionary mapping back 
 
 
1014
        to the rule. This allows quick identification of the matching rule that
 
 
1016
        :return: a list of the compiled regex and the matching-group index 
 
 
1017
        dictionaries. We return a list because python complains if you try to 
 
 
1018
        combine more than 100 regexes.
 
 
1023
        translated_rules = []
 
 
1025
            translated_rule = self._translate_ignore_rule(rule)
 
 
1026
            compiled_rule = re.compile(translated_rule)
 
 
1027
            groups[next_group] = rule
 
 
1028
            next_group += compiled_rule.groups
 
 
1029
            translated_rules.append(translated_rule)
 
 
1030
            if next_group == 99:
 
 
1031
                result.append((re.compile("|".join(translated_rules)), groups))
 
 
1034
                translated_rules = []
 
 
1035
        if len(translated_rules):
 
 
1036
            result.append((re.compile("|".join(translated_rules)), groups))
 
 
1039
    def ignored_files(self):
 
 
1040
        """Yield list of PATH, IGNORE_PATTERN"""
 
 
1041
        for subp in self.extras():
 
 
1042
            pat = self.is_ignored(subp)
 
 
1046
    def get_ignore_list(self):
 
 
1047
        """Return list of ignore patterns.
 
 
1049
        Cached in the Tree object after the first call.
 
 
1051
        if hasattr(self, '_ignorelist'):
 
 
1052
            return self._ignorelist
 
 
1054
        l = bzrlib.DEFAULT_IGNORE[:]
 
 
1055
        if self.has_filename(bzrlib.IGNORE_FILENAME):
 
 
1056
            f = self.get_file_byname(bzrlib.IGNORE_FILENAME)
 
 
1057
            l.extend([line.rstrip("\n\r") for line in f.readlines()])
 
 
1058
        self._ignorelist = l
 
 
1059
        self._ignore_regex = self._combine_ignore_rules(l)
 
 
1062
    def _get_ignore_rules_as_regex(self):
 
 
1063
        """Return a regex of the ignore rules and a mapping dict.
 
 
1065
        :return: (ignore rules compiled regex, dictionary mapping rule group 
 
 
1066
        indices to original rule.)
 
 
1068
        if getattr(self, '_ignorelist', None) is None:
 
 
1069
            self.get_ignore_list()
 
 
1070
        return self._ignore_regex
 
 
1072
    def is_ignored(self, filename):
 
 
1073
        r"""Check whether the filename matches an ignore pattern.
 
 
1075
        Patterns containing '/' or '\' need to match the whole path;
 
 
1076
        others match against only the last component.
 
 
1078
        If the file is ignored, returns the pattern which caused it to
 
 
1079
        be ignored, otherwise None.  So this can simply be used as a
 
 
1080
        boolean if desired."""
 
 
1082
        # TODO: Use '**' to match directories, and other extended
 
 
1083
        # globbing stuff from cvs/rsync.
 
 
1085
        # XXX: fnmatch is actually not quite what we want: it's only
 
 
1086
        # approximately the same as real Unix fnmatch, and doesn't
 
 
1087
        # treat dotfiles correctly and allows * to match /.
 
 
1088
        # Eventually it should be replaced with something more
 
 
1091
        rules = self._get_ignore_rules_as_regex()
 
 
1092
        for regex, mapping in rules:
 
 
1093
            match = regex.match(filename)
 
 
1094
            if match is not None:
 
 
1095
                # one or more of the groups in mapping will have a non-None group 
 
 
1097
                groups = match.groups()
 
 
1098
                rules = [mapping[group] for group in 
 
 
1099
                    mapping if groups[group] is not None]
 
 
1103
    def kind(self, file_id):
 
 
1104
        return file_kind(self.id2abspath(file_id))
 
 
1107
    def last_revision(self):
 
 
1108
        """Return the last revision id of this working tree.
 
 
1110
        In early branch formats this was == the branch last_revision,
 
 
1111
        but that cannot be relied upon - for working tree operations,
 
 
1112
        always use tree.last_revision().
 
 
1114
        return self.branch.last_revision()
 
 
1116
    def is_locked(self):
 
 
1117
        return self._control_files.is_locked()
 
 
1119
    def lock_read(self):
 
 
1120
        """See Branch.lock_read, and WorkingTree.unlock."""
 
 
1121
        self.branch.lock_read()
 
 
1123
            return self._control_files.lock_read()
 
 
1125
            self.branch.unlock()
 
 
1128
    def lock_write(self):
 
 
1129
        """See Branch.lock_write, and WorkingTree.unlock."""
 
 
1130
        self.branch.lock_write()
 
 
1132
            return self._control_files.lock_write()
 
 
1134
            self.branch.unlock()
 
 
1137
    def get_physical_lock_status(self):
 
 
1138
        return self._control_files.get_physical_lock_status()
 
 
1140
    def _basis_inventory_name(self):
 
 
1141
        return 'basis-inventory'
 
 
1144
    def set_last_revision(self, new_revision):
 
 
1145
        """Change the last revision in the working tree."""
 
 
1146
        if self._change_last_revision(new_revision):
 
 
1147
            self._cache_basis_inventory(new_revision)
 
 
1149
    def _change_last_revision(self, new_revision):
 
 
1150
        """Template method part of set_last_revision to perform the change.
 
 
1152
        This is used to allow WorkingTree3 instances to not affect branch
 
 
1153
        when their last revision is set.
 
 
1155
        if new_revision is None:
 
 
1156
            self.branch.set_revision_history([])
 
 
1158
        # current format is locked in with the branch
 
 
1159
        revision_history = self.branch.revision_history()
 
 
1161
            position = revision_history.index(new_revision)
 
 
1163
            raise errors.NoSuchRevision(self.branch, new_revision)
 
 
1164
        self.branch.set_revision_history(revision_history[:position + 1])
 
 
1167
    def _cache_basis_inventory(self, new_revision):
 
 
1168
        """Cache new_revision as the basis inventory."""
 
 
1170
            # this double handles the inventory - unpack and repack - 
 
 
1171
            # but is easier to understand. We can/should put a conditional
 
 
1172
            # in here based on whether the inventory is in the latest format
 
 
1173
            # - perhaps we should repack all inventories on a repository
 
 
1175
            inv = self.branch.repository.get_inventory(new_revision)
 
 
1176
            inv.revision_id = new_revision
 
 
1177
            xml = bzrlib.xml5.serializer_v5.write_inventory_to_string(inv)
 
 
1179
            path = self._basis_inventory_name()
 
 
1180
            self._control_files.put_utf8(path, xml)
 
 
1181
        except WeaveRevisionNotPresent:
 
 
1184
    def read_basis_inventory(self):
 
 
1185
        """Read the cached basis inventory."""
 
 
1186
        path = self._basis_inventory_name()
 
 
1187
        return self._control_files.get_utf8(path).read()
 
 
1190
    def read_working_inventory(self):
 
 
1191
        """Read the working inventory."""
 
 
1192
        # ElementTree does its own conversion from UTF-8, so open in
 
 
1194
        result = bzrlib.xml5.serializer_v5.read_inventory(
 
 
1195
            self._control_files.get('inventory'))
 
 
1196
        self._set_inventory(result)
 
 
1200
    def remove(self, files, verbose=False):
 
 
1201
        """Remove nominated files from the working inventory..
 
 
1203
        This does not remove their text.  This does not run on XXX on what? RBC
 
 
1205
        TODO: Refuse to remove modified files unless --force is given?
 
 
1207
        TODO: Do something useful with directories.
 
 
1209
        TODO: Should this remove the text or not?  Tough call; not
 
 
1210
        removing may be useful and the user can just use use rm, and
 
 
1211
        is the opposite of add.  Removing it is consistent with most
 
 
1212
        other tools.  Maybe an option.
 
 
1214
        ## TODO: Normalize names
 
 
1215
        ## TODO: Remove nested loops; better scalability
 
 
1216
        if isinstance(files, basestring):
 
 
1219
        inv = self.inventory
 
 
1221
        # do this before any modifications
 
 
1223
            fid = inv.path2id(f)
 
 
1225
                # TODO: Perhaps make this just a warning, and continue?
 
 
1226
                # This tends to happen when 
 
 
1227
                raise NotVersionedError(path=f)
 
 
1228
            mutter("remove inventory entry %s {%s}", quotefn(f), fid)
 
 
1230
                # having remove it, it must be either ignored or unknown
 
 
1231
                if self.is_ignored(f):
 
 
1235
                show_status(new_status, inv[fid].kind, quotefn(f))
 
 
1238
        self._write_inventory(inv)
 
 
1241
    def revert(self, filenames, old_tree=None, backups=True, 
 
 
1242
               pb=DummyProgress()):
 
 
1243
        from transform import revert
 
 
1244
        from conflicts import resolve
 
 
1245
        if old_tree is None:
 
 
1246
            old_tree = self.basis_tree()
 
 
1247
        conflicts = revert(self, old_tree, filenames, backups, pb)
 
 
1248
        if not len(filenames):
 
 
1249
            self.set_pending_merges([])
 
 
1252
            resolve(self, filenames, ignore_misses=True)
 
 
1255
    # XXX: This method should be deprecated in favour of taking in a proper
 
 
1256
    # new Inventory object.
 
 
1258
    def set_inventory(self, new_inventory_list):
 
 
1259
        from bzrlib.inventory import (Inventory,
 
 
1264
        inv = Inventory(self.get_root_id())
 
 
1265
        for path, file_id, parent, kind in new_inventory_list:
 
 
1266
            name = os.path.basename(path)
 
 
1269
            # fixme, there should be a factory function inv,add_?? 
 
 
1270
            if kind == 'directory':
 
 
1271
                inv.add(InventoryDirectory(file_id, name, parent))
 
 
1272
            elif kind == 'file':
 
 
1273
                inv.add(InventoryFile(file_id, name, parent))
 
 
1274
            elif kind == 'symlink':
 
 
1275
                inv.add(InventoryLink(file_id, name, parent))
 
 
1277
                raise BzrError("unknown kind %r" % kind)
 
 
1278
        self._write_inventory(inv)
 
 
1281
    def set_root_id(self, file_id):
 
 
1282
        """Set the root id for this tree."""
 
 
1283
        inv = self.read_working_inventory()
 
 
1284
        orig_root_id = inv.root.file_id
 
 
1285
        del inv._byid[inv.root.file_id]
 
 
1286
        inv.root.file_id = file_id
 
 
1287
        inv._byid[inv.root.file_id] = inv.root
 
 
1290
            if entry.parent_id == orig_root_id:
 
 
1291
                entry.parent_id = inv.root.file_id
 
 
1292
        self._write_inventory(inv)
 
 
1295
        """See Branch.unlock.
 
 
1297
        WorkingTree locking just uses the Branch locking facilities.
 
 
1298
        This is current because all working trees have an embedded branch
 
 
1299
        within them. IF in the future, we were to make branch data shareable
 
 
1300
        between multiple working trees, i.e. via shared storage, then we 
 
 
1301
        would probably want to lock both the local tree, and the branch.
 
 
1303
        # FIXME: We want to write out the hashcache only when the last lock on
 
 
1304
        # this working copy is released.  Peeking at the lock count is a bit
 
 
1305
        # of a nasty hack; probably it's better to have a transaction object,
 
 
1306
        # which can do some finalization when it's either successfully or
 
 
1307
        # unsuccessfully completed.  (Denys's original patch did that.)
 
 
1308
        # RBC 20060206 hookinhg into transaction will couple lock and transaction
 
 
1309
        # wrongly. Hookinh into unllock on the control files object is fine though.
 
 
1311
        # TODO: split this per format so there is no ugly if block
 
 
1312
        if self._hashcache.needs_write and (
 
 
1313
            # dedicated lock files
 
 
1314
            self._control_files._lock_count==1 or 
 
 
1316
            (self._control_files is self.branch.control_files and 
 
 
1317
             self._control_files._lock_count==3)):
 
 
1318
            self._hashcache.write()
 
 
1319
        # reverse order of locking.
 
 
1321
            return self._control_files.unlock()
 
 
1323
            self.branch.unlock()
 
 
1327
        """Update a working tree along its branch.
 
 
1329
        This will update the branch if its bound too, which means we have multiple trees involved:
 
 
1330
        The new basis tree of the master.
 
 
1331
        The old basis tree of the branch.
 
 
1332
        The old basis tree of the working tree.
 
 
1333
        The current working tree state.
 
 
1334
        pathologically all three may be different, and non ancestors of each other.
 
 
1335
        Conceptually we want to:
 
 
1336
        Preserve the wt.basis->wt.state changes
 
 
1337
        Transform the wt.basis to the new master basis.
 
 
1338
        Apply a merge of the old branch basis to get any 'local' changes from it into the tree.
 
 
1339
        Restore the wt.basis->wt.state changes.
 
 
1341
        There isn't a single operation at the moment to do that, so we:
 
 
1342
        Merge current state -> basis tree of the master w.r.t. the old tree basis.
 
 
1343
        Do a 'normal' merge of the old branch basis if it is relevant.
 
 
1345
        old_tip = self.branch.update()
 
 
1346
        if old_tip is not None:
 
 
1347
            self.add_pending_merge(old_tip)
 
 
1348
        self.branch.lock_read()
 
 
1351
            if self.last_revision() != self.branch.last_revision():
 
 
1352
                # merge tree state up to new branch tip.
 
 
1353
                basis = self.basis_tree()
 
 
1354
                to_tree = self.branch.basis_tree()
 
 
1355
                result += merge_inner(self.branch,
 
 
1359
                self.set_last_revision(self.branch.last_revision())
 
 
1360
            if old_tip and old_tip != self.last_revision():
 
 
1361
                # our last revision was not the prior branch last reivison
 
 
1362
                # and we have converted that last revision to a pending merge.
 
 
1363
                # base is somewhere between the branch tip now
 
 
1364
                # and the now pending merge
 
 
1365
                from bzrlib.revision import common_ancestor
 
 
1367
                    base_rev_id = common_ancestor(self.branch.last_revision(),
 
 
1369
                                                  self.branch.repository)
 
 
1370
                except errors.NoCommonAncestor:
 
 
1372
                base_tree = self.branch.repository.revision_tree(base_rev_id)
 
 
1373
                other_tree = self.branch.repository.revision_tree(old_tip)
 
 
1374
                result += merge_inner(self.branch,
 
 
1380
            self.branch.unlock()
 
 
1383
    def _write_inventory(self, inv):
 
 
1384
        """Write inventory as the current inventory."""
 
 
1386
        bzrlib.xml5.serializer_v5.write_inventory(inv, sio)
 
 
1388
        self._control_files.put('inventory', sio)
 
 
1389
        self._set_inventory(inv)
 
 
1390
        mutter('wrote working inventory')
 
 
1392
    def set_conflicts(self, arg):
 
 
1393
        raise UnsupportedOperation(self.set_conflicts, self)
 
 
1396
    def conflicts(self):
 
 
1397
        conflicts = ConflictList()
 
 
1398
        for conflicted in self._iter_conflicts():
 
 
1401
                if file_kind(self.abspath(conflicted)) != "file":
 
 
1404
                if e.errno == errno.ENOENT:
 
 
1409
                for suffix in ('.THIS', '.OTHER'):
 
 
1411
                        kind = file_kind(self.abspath(conflicted+suffix))
 
 
1413
                        if e.errno == errno.ENOENT:
 
 
1421
            ctype = {True: 'text conflict', False: 'contents conflict'}[text]
 
 
1422
            conflicts.append(Conflict.factory(ctype, path=conflicted,
 
 
1423
                             file_id=self.path2id(conflicted)))
 
 
1427
class WorkingTree3(WorkingTree):
 
 
1428
    """This is the Format 3 working tree.
 
 
1430
    This differs from the base WorkingTree by:
 
 
1431
     - having its own file lock
 
 
1432
     - having its own last-revision property.
 
 
1434
    This is new in bzr 0.8
 
 
1438
    def last_revision(self):
 
 
1439
        """See WorkingTree.last_revision."""
 
 
1441
            return self._control_files.get_utf8('last-revision').read()
 
 
1445
    def _change_last_revision(self, revision_id):
 
 
1446
        """See WorkingTree._change_last_revision."""
 
 
1447
        if revision_id is None or revision_id == NULL_REVISION:
 
 
1449
                self._control_files._transport.delete('last-revision')
 
 
1450
            except errors.NoSuchFile:
 
 
1455
                self.branch.revision_history().index(revision_id)
 
 
1457
                raise errors.NoSuchRevision(self.branch, revision_id)
 
 
1458
            self._control_files.put_utf8('last-revision', revision_id)
 
 
1462
    def set_conflicts(self, conflicts):
 
 
1463
        self._put_rio('conflicts', conflicts.to_stanzas(), 
 
 
1467
    def conflicts(self):
 
 
1469
            confile = self._control_files.get('conflicts')
 
 
1471
            return ConflictList()
 
 
1473
            if confile.next() != CONFLICT_HEADER_1 + '\n':
 
 
1474
                raise ConflictFormatError()
 
 
1475
        except StopIteration:
 
 
1476
            raise ConflictFormatError()
 
 
1477
        return ConflictList.from_stanzas(RioReader(confile))
 
 
1480
def get_conflicted_stem(path):
 
 
1481
    for suffix in CONFLICT_SUFFIXES:
 
 
1482
        if path.endswith(suffix):
 
 
1483
            return path[:-len(suffix)]
 
 
1485
@deprecated_function(zero_eight)
 
 
1486
def is_control_file(filename):
 
 
1487
    """See WorkingTree.is_control_filename(filename)."""
 
 
1488
    ## FIXME: better check
 
 
1489
    filename = normpath(filename)
 
 
1490
    while filename != '':
 
 
1491
        head, tail = os.path.split(filename)
 
 
1492
        ## mutter('check %r for control file' % ((head, tail),))
 
 
1495
        if filename == head:
 
 
1501
class WorkingTreeFormat(object):
 
 
1502
    """An encapsulation of the initialization and open routines for a format.
 
 
1504
    Formats provide three things:
 
 
1505
     * An initialization routine,
 
 
1509
    Formats are placed in an dict by their format string for reference 
 
 
1510
    during workingtree opening. Its not required that these be instances, they
 
 
1511
    can be classes themselves with class methods - it simply depends on 
 
 
1512
    whether state is needed for a given format or not.
 
 
1514
    Once a format is deprecated, just deprecate the initialize and open
 
 
1515
    methods on the format class. Do not deprecate the object, as the 
 
 
1516
    object will be created every time regardless.
 
 
1519
    _default_format = None
 
 
1520
    """The default format used for new trees."""
 
 
1523
    """The known formats."""
 
 
1526
    def find_format(klass, a_bzrdir):
 
 
1527
        """Return the format for the working tree object in a_bzrdir."""
 
 
1529
            transport = a_bzrdir.get_workingtree_transport(None)
 
 
1530
            format_string = transport.get("format").read()
 
 
1531
            return klass._formats[format_string]
 
 
1533
            raise errors.NoWorkingTree(base=transport.base)
 
 
1535
            raise errors.UnknownFormatError(format_string)
 
 
1538
    def get_default_format(klass):
 
 
1539
        """Return the current default format."""
 
 
1540
        return klass._default_format
 
 
1542
    def get_format_string(self):
 
 
1543
        """Return the ASCII format string that identifies this format."""
 
 
1544
        raise NotImplementedError(self.get_format_string)
 
 
1546
    def get_format_description(self):
 
 
1547
        """Return the short description for this format."""
 
 
1548
        raise NotImplementedError(self.get_format_description)
 
 
1550
    def is_supported(self):
 
 
1551
        """Is this format supported?
 
 
1553
        Supported formats can be initialized and opened.
 
 
1554
        Unsupported formats may not support initialization or committing or 
 
 
1555
        some other features depending on the reason for not being supported.
 
 
1560
    def register_format(klass, format):
 
 
1561
        klass._formats[format.get_format_string()] = format
 
 
1564
    def set_default_format(klass, format):
 
 
1565
        klass._default_format = format
 
 
1568
    def unregister_format(klass, format):
 
 
1569
        assert klass._formats[format.get_format_string()] is format
 
 
1570
        del klass._formats[format.get_format_string()]
 
 
1574
class WorkingTreeFormat2(WorkingTreeFormat):
 
 
1575
    """The second working tree format. 
 
 
1577
    This format modified the hash cache from the format 1 hash cache.
 
 
1580
    def get_format_description(self):
 
 
1581
        """See WorkingTreeFormat.get_format_description()."""
 
 
1582
        return "Working tree format 2"
 
 
1584
    def stub_initialize_remote(self, control_files):
 
 
1585
        """As a special workaround create critical control files for a remote working tree
 
 
1587
        This ensures that it can later be updated and dealt with locally,
 
 
1588
        since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with 
 
 
1589
        no working tree.  (See bug #43064).
 
 
1593
        bzrlib.xml5.serializer_v5.write_inventory(inv, sio)
 
 
1595
        control_files.put('inventory', sio)
 
 
1597
        control_files.put_utf8('pending-merges', '')
 
 
1600
    def initialize(self, a_bzrdir, revision_id=None):
 
 
1601
        """See WorkingTreeFormat.initialize()."""
 
 
1602
        if not isinstance(a_bzrdir.transport, LocalTransport):
 
 
1603
            raise errors.NotLocalUrl(a_bzrdir.transport.base)
 
 
1604
        branch = a_bzrdir.open_branch()
 
 
1605
        if revision_id is not None:
 
 
1608
                revision_history = branch.revision_history()
 
 
1610
                    position = revision_history.index(revision_id)
 
 
1612
                    raise errors.NoSuchRevision(branch, revision_id)
 
 
1613
                branch.set_revision_history(revision_history[:position + 1])
 
 
1616
        revision = branch.last_revision()
 
 
1618
        wt = WorkingTree(a_bzrdir.root_transport.base,
 
 
1624
        wt._write_inventory(inv)
 
 
1625
        wt.set_root_id(inv.root.file_id)
 
 
1626
        wt.set_last_revision(revision)
 
 
1627
        wt.set_pending_merges([])
 
 
1628
        build_tree(wt.basis_tree(), wt)
 
 
1632
        super(WorkingTreeFormat2, self).__init__()
 
 
1633
        self._matchingbzrdir = bzrdir.BzrDirFormat6()
 
 
1635
    def open(self, a_bzrdir, _found=False):
 
 
1636
        """Return the WorkingTree object for a_bzrdir
 
 
1638
        _found is a private parameter, do not use it. It is used to indicate
 
 
1639
               if format probing has already been done.
 
 
1642
            # we are being called directly and must probe.
 
 
1643
            raise NotImplementedError
 
 
1644
        if not isinstance(a_bzrdir.transport, LocalTransport):
 
 
1645
            raise errors.NotLocalUrl(a_bzrdir.transport.base)
 
 
1646
        return WorkingTree(a_bzrdir.root_transport.base,
 
 
1652
class WorkingTreeFormat3(WorkingTreeFormat):
 
 
1653
    """The second working tree format updated to record a format marker.
 
 
1656
        - exists within a metadir controlling .bzr
 
 
1657
        - includes an explicit version marker for the workingtree control
 
 
1658
          files, separate from the BzrDir format
 
 
1659
        - modifies the hash cache format
 
 
1661
        - uses a LockDir to guard access to the repository
 
 
1664
    def get_format_string(self):
 
 
1665
        """See WorkingTreeFormat.get_format_string()."""
 
 
1666
        return "Bazaar-NG Working Tree format 3"
 
 
1668
    def get_format_description(self):
 
 
1669
        """See WorkingTreeFormat.get_format_description()."""
 
 
1670
        return "Working tree format 3"
 
 
1672
    _lock_file_name = 'lock'
 
 
1673
    _lock_class = LockDir
 
 
1675
    def _open_control_files(self, a_bzrdir):
 
 
1676
        transport = a_bzrdir.get_workingtree_transport(None)
 
 
1677
        return LockableFiles(transport, self._lock_file_name, 
 
 
1680
    def initialize(self, a_bzrdir, revision_id=None):
 
 
1681
        """See WorkingTreeFormat.initialize().
 
 
1683
        revision_id allows creating a working tree at a differnet
 
 
1684
        revision than the branch is at.
 
 
1686
        if not isinstance(a_bzrdir.transport, LocalTransport):
 
 
1687
            raise errors.NotLocalUrl(a_bzrdir.transport.base)
 
 
1688
        transport = a_bzrdir.get_workingtree_transport(self)
 
 
1689
        control_files = self._open_control_files(a_bzrdir)
 
 
1690
        control_files.create_lock()
 
 
1691
        control_files.lock_write()
 
 
1692
        control_files.put_utf8('format', self.get_format_string())
 
 
1693
        branch = a_bzrdir.open_branch()
 
 
1694
        if revision_id is None:
 
 
1695
            revision_id = branch.last_revision()
 
 
1697
        wt = WorkingTree3(a_bzrdir.root_transport.base,
 
 
1703
                         _control_files=control_files)
 
 
1706
            wt._write_inventory(inv)
 
 
1707
            wt.set_root_id(inv.root.file_id)
 
 
1708
            wt.set_last_revision(revision_id)
 
 
1709
            wt.set_pending_merges([])
 
 
1710
            build_tree(wt.basis_tree(), wt)
 
 
1713
            control_files.unlock()
 
 
1717
        super(WorkingTreeFormat3, self).__init__()
 
 
1718
        self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
 
 
1720
    def open(self, a_bzrdir, _found=False):
 
 
1721
        """Return the WorkingTree object for a_bzrdir
 
 
1723
        _found is a private parameter, do not use it. It is used to indicate
 
 
1724
               if format probing has already been done.
 
 
1727
            # we are being called directly and must probe.
 
 
1728
            raise NotImplementedError
 
 
1729
        if not isinstance(a_bzrdir.transport, LocalTransport):
 
 
1730
            raise errors.NotLocalUrl(a_bzrdir.transport.base)
 
 
1731
        control_files = self._open_control_files(a_bzrdir)
 
 
1732
        return WorkingTree3(a_bzrdir.root_transport.base,
 
 
1736
                           _control_files=control_files)
 
 
1739
        return self.get_format_string()
 
 
1742
# formats which have no format string are not discoverable
 
 
1743
# and not independently creatable, so are not registered.
 
 
1744
__default_format = WorkingTreeFormat3()
 
 
1745
WorkingTreeFormat.register_format(__default_format)
 
 
1746
WorkingTreeFormat.set_default_format(__default_format)
 
 
1747
_legacy_formats = [WorkingTreeFormat2(),
 
 
1751
class WorkingTreeTestProviderAdapter(object):
 
 
1752
    """A tool to generate a suite testing multiple workingtree formats at once.
 
 
1754
    This is done by copying the test once for each transport and injecting
 
 
1755
    the transport_server, transport_readonly_server, and workingtree_format
 
 
1756
    classes into each copy. Each copy is also given a new id() to make it
 
 
1760
    def __init__(self, transport_server, transport_readonly_server, formats):
 
 
1761
        self._transport_server = transport_server
 
 
1762
        self._transport_readonly_server = transport_readonly_server
 
 
1763
        self._formats = formats
 
 
1765
    def adapt(self, test):
 
 
1766
        from bzrlib.tests import TestSuite
 
 
1767
        result = TestSuite()
 
 
1768
        for workingtree_format, bzrdir_format in self._formats:
 
 
1769
            new_test = deepcopy(test)
 
 
1770
            new_test.transport_server = self._transport_server
 
 
1771
            new_test.transport_readonly_server = self._transport_readonly_server
 
 
1772
            new_test.bzrdir_format = bzrdir_format
 
 
1773
            new_test.workingtree_format = workingtree_format
 
 
1774
            def make_new_test_id():
 
 
1775
                new_id = "%s(%s)" % (new_test.id(), workingtree_format.__class__.__name__)
 
 
1776
                return lambda: new_id
 
 
1777
            new_test.id = make_new_test_id()
 
 
1778
            result.addTest(new_test)