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 (
 
 
91
from bzrlib.progress import DummyProgress, ProgressPhase
 
 
92
from bzrlib.revision import NULL_REVISION
 
 
93
from bzrlib.rio import RioReader, rio_file, Stanza
 
 
94
from bzrlib.symbol_versioning import *
 
 
95
from bzrlib.textui import show_status
 
 
97
from bzrlib.transform import build_tree
 
 
98
from bzrlib.trace import mutter, note
 
 
99
from bzrlib.transport import get_transport
 
 
100
from bzrlib.transport.local import LocalTransport
 
 
105
# the regex here does the following:
 
 
106
# 1) remove any weird characters; we don't escape them but rather
 
 
108
 # 2) match leading '.'s to make it not hidden
 
 
109
_gen_file_id_re = re.compile(r'[^\w.]|(^\.*)')
 
 
110
_gen_id_suffix = None
 
 
114
def _next_id_suffix():
 
 
115
    """Create a new file id suffix that is reasonably unique.
 
 
117
    On the first call we combine the current time with 64 bits of randomness
 
 
118
    to give a highly probably globally unique number. Then each call in the same
 
 
119
    process adds 1 to a serial number we append to that unique value.
 
 
121
    # XXX TODO: change bzrlib.add.smart_add to call workingtree.add() rather 
 
 
122
    # than having to move the id randomness out of the inner loop like this.
 
 
123
    # XXX TODO: for the global randomness this uses we should add the thread-id
 
 
124
    # before the serial #.
 
 
125
    global _gen_id_suffix, _gen_id_serial
 
 
126
    if _gen_id_suffix is None:
 
 
127
        _gen_id_suffix = "-%s-%s-" % (compact_date(time()), rand_chars(16))
 
 
129
    return _gen_id_suffix + str(_gen_id_serial)
 
 
132
def gen_file_id(name):
 
 
133
    """Return new file id for the basename 'name'.
 
 
135
    The uniqueness is supplied from _next_id_suffix.
 
 
137
    # XXX TODO: squash the filename to lowercase.
 
 
138
    # XXX TODO: truncate the filename to something like 20 or 30 chars.
 
 
139
    # XXX TODO: consider what to do with ids that look like illegal filepaths
 
 
140
    # on platforms we support.
 
 
141
    return _gen_file_id_re.sub('', name) + _next_id_suffix()
 
 
145
    """Return a new tree-root file id."""
 
 
146
    return gen_file_id('TREE_ROOT')
 
 
149
class TreeEntry(object):
 
 
150
    """An entry that implements the minium interface used by commands.
 
 
152
    This needs further inspection, it may be better to have 
 
 
153
    InventoryEntries without ids - though that seems wrong. For now,
 
 
154
    this is a parallel hierarchy to InventoryEntry, and needs to become
 
 
155
    one of several things: decorates to that hierarchy, children of, or
 
 
157
    Another note is that these objects are currently only used when there is
 
 
158
    no InventoryEntry available - i.e. for unversioned objects.
 
 
159
    Perhaps they should be UnversionedEntry et al. ? - RBC 20051003
 
 
162
    def __eq__(self, other):
 
 
163
        # yes, this us ugly, TODO: best practice __eq__ style.
 
 
164
        return (isinstance(other, TreeEntry)
 
 
165
                and other.__class__ == self.__class__)
 
 
167
    def kind_character(self):
 
 
171
class TreeDirectory(TreeEntry):
 
 
172
    """See TreeEntry. This is a directory in a working tree."""
 
 
174
    def __eq__(self, other):
 
 
175
        return (isinstance(other, TreeDirectory)
 
 
176
                and other.__class__ == self.__class__)
 
 
178
    def kind_character(self):
 
 
182
class TreeFile(TreeEntry):
 
 
183
    """See TreeEntry. This is a regular file in a working tree."""
 
 
185
    def __eq__(self, other):
 
 
186
        return (isinstance(other, TreeFile)
 
 
187
                and other.__class__ == self.__class__)
 
 
189
    def kind_character(self):
 
 
193
class TreeLink(TreeEntry):
 
 
194
    """See TreeEntry. This is a symlink in a working tree."""
 
 
196
    def __eq__(self, other):
 
 
197
        return (isinstance(other, TreeLink)
 
 
198
                and other.__class__ == self.__class__)
 
 
200
    def kind_character(self):
 
 
204
class WorkingTree(bzrlib.tree.Tree):
 
 
205
    """Working copy tree.
 
 
207
    The inventory is held in the `Branch` working-inventory, and the
 
 
208
    files are in a directory on disk.
 
 
210
    It is possible for a `WorkingTree` to have a filename which is
 
 
211
    not listed in the Inventory and vice versa.
 
 
214
    def __init__(self, basedir='.',
 
 
215
                 branch=DEPRECATED_PARAMETER,
 
 
221
        """Construct a WorkingTree for basedir.
 
 
223
        If the branch is not supplied, it is opened automatically.
 
 
224
        If the branch is supplied, it must be the branch for this basedir.
 
 
225
        (branch.base is not cross checked, because for remote branches that
 
 
226
        would be meaningless).
 
 
228
        self._format = _format
 
 
229
        self.bzrdir = _bzrdir
 
 
231
            # not created via open etc.
 
 
232
            warn("WorkingTree() is deprecated as of bzr version 0.8. "
 
 
233
                 "Please use bzrdir.open_workingtree or WorkingTree.open().",
 
 
236
            wt = WorkingTree.open(basedir)
 
 
237
            self._branch = wt.branch
 
 
238
            self.basedir = wt.basedir
 
 
239
            self._control_files = wt._control_files
 
 
240
            self._hashcache = wt._hashcache
 
 
241
            self._set_inventory(wt._inventory)
 
 
242
            self._format = wt._format
 
 
243
            self.bzrdir = wt.bzrdir
 
 
244
        from bzrlib.hashcache import HashCache
 
 
245
        from bzrlib.trace import note, mutter
 
 
246
        assert isinstance(basedir, basestring), \
 
 
247
            "base directory %r is not a string" % basedir
 
 
248
        basedir = safe_unicode(basedir)
 
 
249
        mutter("opening working tree %r", basedir)
 
 
250
        if deprecated_passed(branch):
 
 
252
                warn("WorkingTree(..., branch=XXX) is deprecated as of bzr 0.8."
 
 
253
                     " Please use bzrdir.open_workingtree() or"
 
 
254
                     " WorkingTree.open().",
 
 
258
            self._branch = branch
 
 
260
            self._branch = self.bzrdir.open_branch()
 
 
261
        assert isinstance(self.branch, Branch), \
 
 
262
            "branch %r is not a Branch" % self.branch
 
 
263
        self.basedir = realpath(basedir)
 
 
264
        # if branch is at our basedir and is a format 6 or less
 
 
265
        if isinstance(self._format, WorkingTreeFormat2):
 
 
266
            # share control object
 
 
267
            self._control_files = self.branch.control_files
 
 
269
            # only ready for format 3
 
 
270
            assert isinstance(self._format, WorkingTreeFormat3)
 
 
271
            assert isinstance(_control_files, LockableFiles), \
 
 
272
                    "_control_files must be a LockableFiles, not %r" \
 
 
274
            self._control_files = _control_files
 
 
275
        # update the whole cache up front and write to disk if anything changed;
 
 
276
        # in the future we might want to do this more selectively
 
 
277
        # two possible ways offer themselves : in self._unlock, write the cache
 
 
278
        # if needed, or, when the cache sees a change, append it to the hash
 
 
279
        # cache file, and have the parser take the most recent entry for a
 
 
281
        cache_filename = self.bzrdir.get_workingtree_transport(None).abspath('stat-cache')
 
 
282
        hc = self._hashcache = HashCache(basedir, cache_filename, self._control_files._file_mode)
 
 
284
        # is this scan needed ? it makes things kinda slow.
 
 
291
        if _inventory is None:
 
 
292
            self._set_inventory(self.read_working_inventory())
 
 
294
            self._set_inventory(_inventory)
 
 
297
        fget=lambda self: self._branch,
 
 
298
        doc="""The branch this WorkingTree is connected to.
 
 
300
            This cannot be set - it is reflective of the actual disk structure
 
 
301
            the working tree has been constructed from.
 
 
304
    def break_lock(self):
 
 
305
        """Break a lock if one is present from another instance.
 
 
307
        Uses the ui factory to ask for confirmation if the lock may be from
 
 
310
        This will probe the repository for its lock as well.
 
 
312
        self._control_files.break_lock()
 
 
313
        self.branch.break_lock()
 
 
315
    def _set_inventory(self, inv):
 
 
316
        self._inventory = inv
 
 
317
        self.path2id = self._inventory.path2id
 
 
319
    def is_control_filename(self, filename):
 
 
320
        """True if filename is the name of a control file in this tree.
 
 
322
        :param filename: A filename within the tree. This is a relative path
 
 
323
        from the root of this tree.
 
 
325
        This is true IF and ONLY IF the filename is part of the meta data
 
 
326
        that bzr controls in this tree. I.E. a random .bzr directory placed
 
 
327
        on disk will not be a control file for this tree.
 
 
329
        return self.bzrdir.is_control_filename(filename)
 
 
332
    def open(path=None, _unsupported=False):
 
 
333
        """Open an existing working tree at path.
 
 
337
            path = os.path.getcwdu()
 
 
338
        control = bzrdir.BzrDir.open(path, _unsupported)
 
 
339
        return control.open_workingtree(_unsupported)
 
 
342
    def open_containing(path=None):
 
 
343
        """Open an existing working tree which has its root about path.
 
 
345
        This probes for a working tree at path and searches upwards from there.
 
 
347
        Basically we keep looking up until we find the control directory or
 
 
348
        run into /.  If there isn't one, raises NotBranchError.
 
 
349
        TODO: give this a new exception.
 
 
350
        If there is one, it is returned, along with the unused portion of path.
 
 
354
        control, relpath = bzrdir.BzrDir.open_containing(path)
 
 
355
        return control.open_workingtree(), relpath
 
 
358
    def open_downlevel(path=None):
 
 
359
        """Open an unsupported working tree.
 
 
361
        Only intended for advanced situations like upgrading part of a bzrdir.
 
 
363
        return WorkingTree.open(path, _unsupported=True)
 
 
366
        """Iterate through file_ids for this tree.
 
 
368
        file_ids are in a WorkingTree if they are in the working inventory
 
 
369
        and the working file exists.
 
 
371
        inv = self._inventory
 
 
372
        for path, ie in inv.iter_entries():
 
 
373
            if bzrlib.osutils.lexists(self.abspath(path)):
 
 
377
        return "<%s of %s>" % (self.__class__.__name__,
 
 
378
                               getattr(self, 'basedir', None))
 
 
380
    def abspath(self, filename):
 
 
381
        return pathjoin(self.basedir, filename)
 
 
383
    def basis_tree(self):
 
 
384
        """Return RevisionTree for the current last revision."""
 
 
385
        revision_id = self.last_revision()
 
 
386
        if revision_id is not None:
 
 
388
                xml = self.read_basis_inventory()
 
 
389
                inv = bzrlib.xml5.serializer_v5.read_inventory_from_string(xml)
 
 
392
            if inv is not None and inv.revision_id == revision_id:
 
 
393
                return bzrlib.tree.RevisionTree(self.branch.repository, inv,
 
 
395
        # FIXME? RBC 20060403 should we cache the inventory here ?
 
 
396
        return self.branch.repository.revision_tree(revision_id)
 
 
399
    @deprecated_method(zero_eight)
 
 
400
    def create(branch, directory):
 
 
401
        """Create a workingtree for branch at directory.
 
 
403
        If existing_directory already exists it must have a .bzr directory.
 
 
404
        If it does not exist, it will be created.
 
 
406
        This returns a new WorkingTree object for the new checkout.
 
 
408
        TODO FIXME RBC 20060124 when we have checkout formats in place this
 
 
409
        should accept an optional revisionid to checkout [and reject this if
 
 
410
        checking out into the same dir as a pre-checkout-aware branch format.]
 
 
412
        XXX: When BzrDir is present, these should be created through that 
 
 
415
        warn('delete WorkingTree.create', stacklevel=3)
 
 
416
        transport = get_transport(directory)
 
 
417
        if branch.bzrdir.root_transport.base == transport.base:
 
 
419
            return branch.bzrdir.create_workingtree()
 
 
420
        # different directory, 
 
 
421
        # create a branch reference
 
 
422
        # and now a working tree.
 
 
423
        raise NotImplementedError
 
 
426
    @deprecated_method(zero_eight)
 
 
427
    def create_standalone(directory):
 
 
428
        """Create a checkout and a branch and a repo at directory.
 
 
430
        Directory must exist and be empty.
 
 
432
        please use BzrDir.create_standalone_workingtree
 
 
434
        return bzrdir.BzrDir.create_standalone_workingtree(directory)
 
 
436
    def relpath(self, path):
 
 
437
        """Return the local path portion from a given path.
 
 
439
        The path may be absolute or relative. If its a relative path it is 
 
 
440
        interpreted relative to the python current working directory.
 
 
442
        return relpath(self.basedir, path)
 
 
444
    def has_filename(self, filename):
 
 
445
        return bzrlib.osutils.lexists(self.abspath(filename))
 
 
447
    def get_file(self, file_id):
 
 
448
        return self.get_file_byname(self.id2path(file_id))
 
 
450
    def get_file_byname(self, filename):
 
 
451
        return file(self.abspath(filename), 'rb')
 
 
453
    def get_root_id(self):
 
 
454
        """Return the id of this trees root"""
 
 
455
        inv = self.read_working_inventory()
 
 
456
        return inv.root.file_id
 
 
458
    def _get_store_filename(self, file_id):
 
 
459
        ## XXX: badly named; this is not in the store at all
 
 
460
        return self.abspath(self.id2path(file_id))
 
 
463
    def clone(self, to_bzrdir, revision_id=None, basis=None):
 
 
464
        """Duplicate this working tree into to_bzr, including all state.
 
 
466
        Specifically modified files are kept as modified, but
 
 
467
        ignored and unknown files are discarded.
 
 
469
        If you want to make a new line of development, see bzrdir.sprout()
 
 
472
            If not None, the cloned tree will have its last revision set to 
 
 
473
            revision, and and difference between the source trees last revision
 
 
474
            and this one merged in.
 
 
477
            If not None, a closer copy of a tree which may have some files in
 
 
478
            common, and which file content should be preferentially copied from.
 
 
480
        # assumes the target bzr dir format is compatible.
 
 
481
        result = self._format.initialize(to_bzrdir)
 
 
482
        self.copy_content_into(result, revision_id)
 
 
486
    def copy_content_into(self, tree, revision_id=None):
 
 
487
        """Copy the current content and user files of this tree into tree."""
 
 
488
        if revision_id is None:
 
 
489
            transform_tree(tree, self)
 
 
491
            # TODO now merge from tree.last_revision to revision
 
 
492
            transform_tree(tree, self)
 
 
493
            tree.set_last_revision(revision_id)
 
 
496
    def commit(self, message=None, revprops=None, *args, **kwargs):
 
 
497
        # avoid circular imports
 
 
498
        from bzrlib.commit import Commit
 
 
501
        if not 'branch-nick' in revprops:
 
 
502
            revprops['branch-nick'] = self.branch.nick
 
 
503
        # args for wt.commit start at message from the Commit.commit method,
 
 
504
        # but with branch a kwarg now, passing in args as is results in the
 
 
505
        #message being used for the branch
 
 
506
        args = (DEPRECATED_PARAMETER, message, ) + args
 
 
507
        Commit().commit(working_tree=self, revprops=revprops, *args, **kwargs)
 
 
508
        self._set_inventory(self.read_working_inventory())
 
 
510
    def id2abspath(self, file_id):
 
 
511
        return self.abspath(self.id2path(file_id))
 
 
513
    def has_id(self, file_id):
 
 
514
        # files that have been deleted are excluded
 
 
515
        inv = self._inventory
 
 
516
        if not inv.has_id(file_id):
 
 
518
        path = inv.id2path(file_id)
 
 
519
        return bzrlib.osutils.lexists(self.abspath(path))
 
 
521
    def has_or_had_id(self, file_id):
 
 
522
        if file_id == self.inventory.root.file_id:
 
 
524
        return self.inventory.has_id(file_id)
 
 
526
    __contains__ = has_id
 
 
528
    def get_file_size(self, file_id):
 
 
529
        return os.path.getsize(self.id2abspath(file_id))
 
 
532
    def get_file_sha1(self, file_id):
 
 
533
        path = self._inventory.id2path(file_id)
 
 
534
        return self._hashcache.get_sha1(path)
 
 
536
    def is_executable(self, file_id):
 
 
537
        if not supports_executable():
 
 
538
            return self._inventory[file_id].executable
 
 
540
            path = self._inventory.id2path(file_id)
 
 
541
            mode = os.lstat(self.abspath(path)).st_mode
 
 
542
            return bool(stat.S_ISREG(mode) and stat.S_IEXEC&mode)
 
 
545
    def add(self, files, ids=None):
 
 
546
        """Make files versioned.
 
 
548
        Note that the command line normally calls smart_add instead,
 
 
549
        which can automatically recurse.
 
 
551
        This adds the files to the inventory, so that they will be
 
 
552
        recorded by the next commit.
 
 
555
            List of paths to add, relative to the base of the tree.
 
 
558
            If set, use these instead of automatically generated ids.
 
 
559
            Must be the same length as the list of files, but may
 
 
560
            contain None for ids that are to be autogenerated.
 
 
562
        TODO: Perhaps have an option to add the ids even if the files do
 
 
565
        TODO: Perhaps callback with the ids and paths as they're added.
 
 
567
        # TODO: Re-adding a file that is removed in the working copy
 
 
568
        # should probably put it back with the previous ID.
 
 
569
        if isinstance(files, basestring):
 
 
570
            assert(ids is None or isinstance(ids, basestring))
 
 
576
            ids = [None] * len(files)
 
 
578
            assert(len(ids) == len(files))
 
 
580
        inv = self.read_working_inventory()
 
 
581
        for f,file_id in zip(files, ids):
 
 
582
            if self.is_control_filename(f):
 
 
583
                raise BzrError("cannot add control file %s" % quotefn(f))
 
 
588
                raise BzrError("cannot add top-level %r" % f)
 
 
590
            fullpath = normpath(self.abspath(f))
 
 
593
                kind = file_kind(fullpath)
 
 
595
                if e.errno == errno.ENOENT:
 
 
596
                    raise NoSuchFile(fullpath)
 
 
597
                # maybe something better?
 
 
598
                raise BzrError('cannot add: not a regular file, symlink or directory: %s' % quotefn(f))
 
 
600
            if not InventoryEntry.versionable_kind(kind):
 
 
601
                raise BzrError('cannot add: not a versionable file ('
 
 
602
                               'i.e. regular file, symlink or directory): %s' % quotefn(f))
 
 
605
                inv.add_path(f, kind=kind)
 
 
607
                inv.add_path(f, kind=kind, file_id=file_id)
 
 
609
        self._write_inventory(inv)
 
 
612
    def add_pending_merge(self, *revision_ids):
 
 
613
        # TODO: Perhaps should check at this point that the
 
 
614
        # history of the revision is actually present?
 
 
615
        p = self.pending_merges()
 
 
617
        for rev_id in revision_ids:
 
 
623
            self.set_pending_merges(p)
 
 
626
    def pending_merges(self):
 
 
627
        """Return a list of pending merges.
 
 
629
        These are revisions that have been merged into the working
 
 
630
        directory but not yet committed.
 
 
633
            merges_file = self._control_files.get_utf8('pending-merges')
 
 
635
            if e.errno != errno.ENOENT:
 
 
639
        for l in merges_file.readlines():
 
 
640
            p.append(l.rstrip('\n'))
 
 
644
    def set_pending_merges(self, rev_list):
 
 
645
        self._control_files.put_utf8('pending-merges', '\n'.join(rev_list))
 
 
648
    def set_merge_modified(self, modified_hashes):
 
 
650
            for file_id, hash in modified_hashes.iteritems():
 
 
651
                yield Stanza(file_id=file_id, hash=hash)
 
 
652
        self._put_rio('merge-hashes', iter_stanzas(), MERGE_MODIFIED_HEADER_1)
 
 
655
    def _put_rio(self, filename, stanzas, header):
 
 
656
        my_file = rio_file(stanzas, header)
 
 
657
        self._control_files.put(filename, my_file)
 
 
660
    def merge_modified(self):
 
 
662
            hashfile = self._control_files.get('merge-hashes')
 
 
667
            if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
 
 
668
                raise MergeModifiedFormatError()
 
 
669
        except StopIteration:
 
 
670
            raise MergeModifiedFormatError()
 
 
671
        for s in RioReader(hashfile):
 
 
672
            file_id = s.get("file_id")
 
 
673
            if file_id not in self.inventory:
 
 
676
            if hash == self.get_file_sha1(file_id):
 
 
677
                merge_hashes[file_id] = hash
 
 
680
    def get_symlink_target(self, file_id):
 
 
681
        return os.readlink(self.id2abspath(file_id))
 
 
683
    def file_class(self, filename):
 
 
684
        if self.path2id(filename):
 
 
686
        elif self.is_ignored(filename):
 
 
691
    def list_files(self):
 
 
692
        """Recursively list all files as (path, class, kind, id).
 
 
694
        Lists, but does not descend into unversioned directories.
 
 
696
        This does not include files that have been deleted in this
 
 
699
        Skips the control directory.
 
 
701
        inv = self._inventory
 
 
703
        def descend(from_dir_relpath, from_dir_id, dp):
 
 
707
                ## TODO: If we find a subdirectory with its own .bzr
 
 
708
                ## directory, then that is a separate tree and we
 
 
709
                ## should exclude it.
 
 
711
                # the bzrdir for this tree
 
 
712
                if self.bzrdir.transport.base.endswith(f + '/'):
 
 
716
                fp = pathjoin(from_dir_relpath, f)
 
 
719
                fap = pathjoin(dp, f)
 
 
721
                f_ie = inv.get_child(from_dir_id, f)
 
 
724
                elif self.is_ignored(fp):
 
 
733
                        raise BzrCheckError("file %r entered as kind %r id %r, "
 
 
735
                                            % (fap, f_ie.kind, f_ie.file_id, fk))
 
 
737
                # make a last minute entry
 
 
741
                    if fk == 'directory':
 
 
742
                        entry = TreeDirectory()
 
 
745
                    elif fk == 'symlink':
 
 
750
                yield fp, c, fk, (f_ie and f_ie.file_id), entry
 
 
752
                if fk != 'directory':
 
 
756
                    # don't descend unversioned directories
 
 
759
                for ff in descend(fp, f_ie.file_id, fap):
 
 
762
        for f in descend(u'', inv.root.file_id, self.basedir):
 
 
766
    def move(self, from_paths, to_name):
 
 
769
        to_name must exist in the inventory.
 
 
771
        If to_name exists and is a directory, the files are moved into
 
 
772
        it, keeping their old names.  
 
 
774
        Note that to_name is only the last component of the new name;
 
 
775
        this doesn't change the directory.
 
 
777
        This returns a list of (from_path, to_path) pairs for each
 
 
781
        ## TODO: Option to move IDs only
 
 
782
        assert not isinstance(from_paths, basestring)
 
 
784
        to_abs = self.abspath(to_name)
 
 
785
        if not isdir(to_abs):
 
 
786
            raise BzrError("destination %r is not a directory" % to_abs)
 
 
787
        if not self.has_filename(to_name):
 
 
788
            raise BzrError("destination %r not in working directory" % to_abs)
 
 
789
        to_dir_id = inv.path2id(to_name)
 
 
790
        if to_dir_id == None and to_name != '':
 
 
791
            raise BzrError("destination %r is not a versioned directory" % to_name)
 
 
792
        to_dir_ie = inv[to_dir_id]
 
 
793
        if to_dir_ie.kind not in ('directory', 'root_directory'):
 
 
794
            raise BzrError("destination %r is not a directory" % to_abs)
 
 
796
        to_idpath = inv.get_idpath(to_dir_id)
 
 
799
            if not self.has_filename(f):
 
 
800
                raise BzrError("%r does not exist in working tree" % f)
 
 
801
            f_id = inv.path2id(f)
 
 
803
                raise BzrError("%r is not versioned" % f)
 
 
804
            name_tail = splitpath(f)[-1]
 
 
805
            dest_path = pathjoin(to_name, name_tail)
 
 
806
            if self.has_filename(dest_path):
 
 
807
                raise BzrError("destination %r already exists" % dest_path)
 
 
808
            if f_id in to_idpath:
 
 
809
                raise BzrError("can't move %r to a subdirectory of itself" % f)
 
 
811
        # OK, so there's a race here, it's possible that someone will
 
 
812
        # create a file in this interval and then the rename might be
 
 
813
        # left half-done.  But we should have caught most problems.
 
 
814
        orig_inv = deepcopy(self.inventory)
 
 
817
                name_tail = splitpath(f)[-1]
 
 
818
                dest_path = pathjoin(to_name, name_tail)
 
 
819
                result.append((f, dest_path))
 
 
820
                inv.rename(inv.path2id(f), to_dir_id, name_tail)
 
 
822
                    rename(self.abspath(f), self.abspath(dest_path))
 
 
824
                    raise BzrError("failed to rename %r to %r: %s" %
 
 
825
                                   (f, dest_path, e[1]),
 
 
826
                            ["rename rolled back"])
 
 
828
            # restore the inventory on error
 
 
829
            self._set_inventory(orig_inv)
 
 
831
        self._write_inventory(inv)
 
 
835
    def rename_one(self, from_rel, to_rel):
 
 
838
        This can change the directory or the filename or both.
 
 
841
        if not self.has_filename(from_rel):
 
 
842
            raise BzrError("can't rename: old working file %r does not exist" % from_rel)
 
 
843
        if self.has_filename(to_rel):
 
 
844
            raise BzrError("can't rename: new working file %r already exists" % to_rel)
 
 
846
        file_id = inv.path2id(from_rel)
 
 
848
            raise BzrError("can't rename: old name %r is not versioned" % from_rel)
 
 
851
        from_parent = entry.parent_id
 
 
852
        from_name = entry.name
 
 
854
        if inv.path2id(to_rel):
 
 
855
            raise BzrError("can't rename: new name %r is already versioned" % to_rel)
 
 
857
        to_dir, to_tail = os.path.split(to_rel)
 
 
858
        to_dir_id = inv.path2id(to_dir)
 
 
859
        if to_dir_id == None and to_dir != '':
 
 
860
            raise BzrError("can't determine destination directory id for %r" % to_dir)
 
 
862
        mutter("rename_one:")
 
 
863
        mutter("  file_id    {%s}" % file_id)
 
 
864
        mutter("  from_rel   %r" % from_rel)
 
 
865
        mutter("  to_rel     %r" % to_rel)
 
 
866
        mutter("  to_dir     %r" % to_dir)
 
 
867
        mutter("  to_dir_id  {%s}" % to_dir_id)
 
 
869
        inv.rename(file_id, to_dir_id, to_tail)
 
 
871
        from_abs = self.abspath(from_rel)
 
 
872
        to_abs = self.abspath(to_rel)
 
 
874
            rename(from_abs, to_abs)
 
 
876
            inv.rename(file_id, from_parent, from_name)
 
 
877
            raise BzrError("failed to rename %r to %r: %s"
 
 
878
                    % (from_abs, to_abs, e[1]),
 
 
879
                    ["rename rolled back"])
 
 
880
        self._write_inventory(inv)
 
 
884
        """Return all unknown files.
 
 
886
        These are files in the working directory that are not versioned or
 
 
887
        control files or ignored.
 
 
889
        >>> from bzrlib.bzrdir import ScratchDir
 
 
890
        >>> d = ScratchDir(files=['foo', 'foo~'])
 
 
891
        >>> b = d.open_branch()
 
 
892
        >>> tree = d.open_workingtree()
 
 
893
        >>> map(str, tree.unknowns())
 
 
896
        >>> list(b.unknowns())
 
 
898
        >>> tree.remove('foo')
 
 
899
        >>> list(b.unknowns())
 
 
902
        for subp in self.extras():
 
 
903
            if not self.is_ignored(subp):
 
 
906
    @deprecated_method(zero_eight)
 
 
907
    def iter_conflicts(self):
 
 
908
        """List all files in the tree that have text or content conflicts.
 
 
909
        DEPRECATED.  Use conflicts instead."""
 
 
910
        return self._iter_conflicts()
 
 
912
    def _iter_conflicts(self):
 
 
914
        for path in (s[0] for s in self.list_files()):
 
 
915
            stem = get_conflicted_stem(path)
 
 
918
            if stem not in conflicted:
 
 
923
    def pull(self, source, overwrite=False, stop_revision=None):
 
 
924
        top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
 
927
            pp = ProgressPhase("Pull phase", 2, top_pb)
 
 
929
            old_revision_history = self.branch.revision_history()
 
 
930
            basis_tree = self.basis_tree()
 
 
931
            count = self.branch.pull(source, overwrite, stop_revision)
 
 
932
            new_revision_history = self.branch.revision_history()
 
 
933
            if new_revision_history != old_revision_history:
 
 
935
                if len(old_revision_history):
 
 
936
                    other_revision = old_revision_history[-1]
 
 
938
                    other_revision = None
 
 
939
                repository = self.branch.repository
 
 
940
                pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
 
942
                    merge_inner(self.branch,
 
 
943
                                self.branch.basis_tree(),
 
 
949
                self.set_last_revision(self.branch.last_revision())
 
 
956
        """Yield all unknown files in this WorkingTree.
 
 
958
        If there are any unknown directories then only the directory is
 
 
959
        returned, not all its children.  But if there are unknown files
 
 
960
        under a versioned subdirectory, they are returned.
 
 
962
        Currently returned depth-first, sorted by name within directories.
 
 
964
        ## TODO: Work from given directory downwards
 
 
965
        for path, dir_entry in self.inventory.directories():
 
 
966
            mutter("search for unknowns in %r", path)
 
 
967
            dirabs = self.abspath(path)
 
 
968
            if not isdir(dirabs):
 
 
969
                # e.g. directory deleted
 
 
973
            for subf in os.listdir(dirabs):
 
 
975
                    and (subf not in dir_entry.children)):
 
 
980
                subp = pathjoin(path, subf)
 
 
983
    def _translate_ignore_rule(self, rule):
 
 
984
        """Translate a single ignore rule to a regex.
 
 
986
        There are two types of ignore rules.  Those that do not contain a / are
 
 
987
        matched against the tail of the filename (that is, they do not care
 
 
988
        what directory the file is in.)  Rules which do contain a slash must
 
 
989
        match the entire path.  As a special case, './' at the start of the
 
 
990
        string counts as a slash in the string but is removed before matching
 
 
991
        (e.g. ./foo.c, ./src/foo.c)
 
 
993
        :return: The translated regex.
 
 
995
        if rule[:2] in ('./', '.\\'):
 
 
997
            result = fnmatch.translate(rule[2:])
 
 
998
        elif '/' in rule or '\\' in rule:
 
 
1000
            result = fnmatch.translate(rule)
 
 
1002
            # default rule style.
 
 
1003
            result = "(?:.*/)?(?!.*/)" + fnmatch.translate(rule)
 
 
1004
        assert result[-1] == '$', "fnmatch.translate did not add the expected $"
 
 
1005
        return "(" + result + ")"
 
 
1007
    def _combine_ignore_rules(self, rules):
 
 
1008
        """Combine a list of ignore rules into a single regex object.
 
 
1010
        Each individual rule is combined with | to form a big regex, which then
 
 
1011
        has $ added to it to form something like ()|()|()$. The group index for
 
 
1012
        each subregex's outermost group is placed in a dictionary mapping back 
 
 
1013
        to the rule. This allows quick identification of the matching rule that
 
 
1015
        :return: a list of the compiled regex and the matching-group index 
 
 
1016
        dictionaries. We return a list because python complains if you try to 
 
 
1017
        combine more than 100 regexes.
 
 
1022
        translated_rules = []
 
 
1024
            translated_rule = self._translate_ignore_rule(rule)
 
 
1025
            compiled_rule = re.compile(translated_rule)
 
 
1026
            groups[next_group] = rule
 
 
1027
            next_group += compiled_rule.groups
 
 
1028
            translated_rules.append(translated_rule)
 
 
1029
            if next_group == 99:
 
 
1030
                result.append((re.compile("|".join(translated_rules)), groups))
 
 
1033
                translated_rules = []
 
 
1034
        if len(translated_rules):
 
 
1035
            result.append((re.compile("|".join(translated_rules)), groups))
 
 
1038
    def ignored_files(self):
 
 
1039
        """Yield list of PATH, IGNORE_PATTERN"""
 
 
1040
        for subp in self.extras():
 
 
1041
            pat = self.is_ignored(subp)
 
 
1045
    def get_ignore_list(self):
 
 
1046
        """Return list of ignore patterns.
 
 
1048
        Cached in the Tree object after the first call.
 
 
1050
        if hasattr(self, '_ignorelist'):
 
 
1051
            return self._ignorelist
 
 
1053
        l = bzrlib.DEFAULT_IGNORE[:]
 
 
1054
        if self.has_filename(bzrlib.IGNORE_FILENAME):
 
 
1055
            f = self.get_file_byname(bzrlib.IGNORE_FILENAME)
 
 
1056
            l.extend([line.rstrip("\n\r") for line in f.readlines()])
 
 
1057
        self._ignorelist = l
 
 
1058
        self._ignore_regex = self._combine_ignore_rules(l)
 
 
1061
    def _get_ignore_rules_as_regex(self):
 
 
1062
        """Return a regex of the ignore rules and a mapping dict.
 
 
1064
        :return: (ignore rules compiled regex, dictionary mapping rule group 
 
 
1065
        indices to original rule.)
 
 
1067
        if getattr(self, '_ignorelist', None) is None:
 
 
1068
            self.get_ignore_list()
 
 
1069
        return self._ignore_regex
 
 
1071
    def is_ignored(self, filename):
 
 
1072
        r"""Check whether the filename matches an ignore pattern.
 
 
1074
        Patterns containing '/' or '\' need to match the whole path;
 
 
1075
        others match against only the last component.
 
 
1077
        If the file is ignored, returns the pattern which caused it to
 
 
1078
        be ignored, otherwise None.  So this can simply be used as a
 
 
1079
        boolean if desired."""
 
 
1081
        # TODO: Use '**' to match directories, and other extended
 
 
1082
        # globbing stuff from cvs/rsync.
 
 
1084
        # XXX: fnmatch is actually not quite what we want: it's only
 
 
1085
        # approximately the same as real Unix fnmatch, and doesn't
 
 
1086
        # treat dotfiles correctly and allows * to match /.
 
 
1087
        # Eventually it should be replaced with something more
 
 
1090
        rules = self._get_ignore_rules_as_regex()
 
 
1091
        for regex, mapping in rules:
 
 
1092
            match = regex.match(filename)
 
 
1093
            if match is not None:
 
 
1094
                # one or more of the groups in mapping will have a non-None group 
 
 
1096
                groups = match.groups()
 
 
1097
                rules = [mapping[group] for group in 
 
 
1098
                    mapping if groups[group] is not None]
 
 
1102
    def kind(self, file_id):
 
 
1103
        return file_kind(self.id2abspath(file_id))
 
 
1106
    def last_revision(self):
 
 
1107
        """Return the last revision id of this working tree.
 
 
1109
        In early branch formats this was == the branch last_revision,
 
 
1110
        but that cannot be relied upon - for working tree operations,
 
 
1111
        always use tree.last_revision().
 
 
1113
        return self.branch.last_revision()
 
 
1115
    def is_locked(self):
 
 
1116
        return self._control_files.is_locked()
 
 
1118
    def lock_read(self):
 
 
1119
        """See Branch.lock_read, and WorkingTree.unlock."""
 
 
1120
        self.branch.lock_read()
 
 
1122
            return self._control_files.lock_read()
 
 
1124
            self.branch.unlock()
 
 
1127
    def lock_write(self):
 
 
1128
        """See Branch.lock_write, and WorkingTree.unlock."""
 
 
1129
        self.branch.lock_write()
 
 
1131
            return self._control_files.lock_write()
 
 
1133
            self.branch.unlock()
 
 
1136
    def get_physical_lock_status(self):
 
 
1137
        return self._control_files.get_physical_lock_status()
 
 
1139
    def _basis_inventory_name(self):
 
 
1140
        return 'basis-inventory'
 
 
1143
    def set_last_revision(self, new_revision):
 
 
1144
        """Change the last revision in the working tree."""
 
 
1145
        if self._change_last_revision(new_revision):
 
 
1146
            self._cache_basis_inventory(new_revision)
 
 
1148
    def _change_last_revision(self, new_revision):
 
 
1149
        """Template method part of set_last_revision to perform the change.
 
 
1151
        This is used to allow WorkingTree3 instances to not affect branch
 
 
1152
        when their last revision is set.
 
 
1154
        if new_revision is None:
 
 
1155
            self.branch.set_revision_history([])
 
 
1157
        # current format is locked in with the branch
 
 
1158
        revision_history = self.branch.revision_history()
 
 
1160
            position = revision_history.index(new_revision)
 
 
1162
            raise errors.NoSuchRevision(self.branch, new_revision)
 
 
1163
        self.branch.set_revision_history(revision_history[:position + 1])
 
 
1166
    def _cache_basis_inventory(self, new_revision):
 
 
1167
        """Cache new_revision as the basis inventory."""
 
 
1169
            # this double handles the inventory - unpack and repack - 
 
 
1170
            # but is easier to understand. We can/should put a conditional
 
 
1171
            # in here based on whether the inventory is in the latest format
 
 
1172
            # - perhaps we should repack all inventories on a repository
 
 
1174
            inv = self.branch.repository.get_inventory(new_revision)
 
 
1175
            inv.revision_id = new_revision
 
 
1176
            xml = bzrlib.xml5.serializer_v5.write_inventory_to_string(inv)
 
 
1178
            path = self._basis_inventory_name()
 
 
1179
            self._control_files.put_utf8(path, xml)
 
 
1180
        except WeaveRevisionNotPresent:
 
 
1183
    def read_basis_inventory(self):
 
 
1184
        """Read the cached basis inventory."""
 
 
1185
        path = self._basis_inventory_name()
 
 
1186
        return self._control_files.get_utf8(path).read()
 
 
1189
    def read_working_inventory(self):
 
 
1190
        """Read the working inventory."""
 
 
1191
        # ElementTree does its own conversion from UTF-8, so open in
 
 
1193
        result = bzrlib.xml5.serializer_v5.read_inventory(
 
 
1194
            self._control_files.get('inventory'))
 
 
1195
        self._set_inventory(result)
 
 
1199
    def remove(self, files, verbose=False):
 
 
1200
        """Remove nominated files from the working inventory..
 
 
1202
        This does not remove their text.  This does not run on XXX on what? RBC
 
 
1204
        TODO: Refuse to remove modified files unless --force is given?
 
 
1206
        TODO: Do something useful with directories.
 
 
1208
        TODO: Should this remove the text or not?  Tough call; not
 
 
1209
        removing may be useful and the user can just use use rm, and
 
 
1210
        is the opposite of add.  Removing it is consistent with most
 
 
1211
        other tools.  Maybe an option.
 
 
1213
        ## TODO: Normalize names
 
 
1214
        ## TODO: Remove nested loops; better scalability
 
 
1215
        if isinstance(files, basestring):
 
 
1218
        inv = self.inventory
 
 
1220
        # do this before any modifications
 
 
1222
            fid = inv.path2id(f)
 
 
1224
                # TODO: Perhaps make this just a warning, and continue?
 
 
1225
                # This tends to happen when 
 
 
1226
                raise NotVersionedError(path=f)
 
 
1227
            mutter("remove inventory entry %s {%s}", quotefn(f), fid)
 
 
1229
                # having remove it, it must be either ignored or unknown
 
 
1230
                if self.is_ignored(f):
 
 
1234
                show_status(new_status, inv[fid].kind, quotefn(f))
 
 
1237
        self._write_inventory(inv)
 
 
1240
    def revert(self, filenames, old_tree=None, backups=True, 
 
 
1241
               pb=DummyProgress()):
 
 
1242
        from transform import revert
 
 
1243
        from conflicts import resolve
 
 
1244
        if old_tree is None:
 
 
1245
            old_tree = self.basis_tree()
 
 
1246
        conflicts = revert(self, old_tree, filenames, backups, pb)
 
 
1247
        if not len(filenames):
 
 
1248
            self.set_pending_merges([])
 
 
1251
            resolve(self, filenames, ignore_misses=True)
 
 
1254
    # XXX: This method should be deprecated in favour of taking in a proper
 
 
1255
    # new Inventory object.
 
 
1257
    def set_inventory(self, new_inventory_list):
 
 
1258
        from bzrlib.inventory import (Inventory,
 
 
1263
        inv = Inventory(self.get_root_id())
 
 
1264
        for path, file_id, parent, kind in new_inventory_list:
 
 
1265
            name = os.path.basename(path)
 
 
1268
            # fixme, there should be a factory function inv,add_?? 
 
 
1269
            if kind == 'directory':
 
 
1270
                inv.add(InventoryDirectory(file_id, name, parent))
 
 
1271
            elif kind == 'file':
 
 
1272
                inv.add(InventoryFile(file_id, name, parent))
 
 
1273
            elif kind == 'symlink':
 
 
1274
                inv.add(InventoryLink(file_id, name, parent))
 
 
1276
                raise BzrError("unknown kind %r" % kind)
 
 
1277
        self._write_inventory(inv)
 
 
1280
    def set_root_id(self, file_id):
 
 
1281
        """Set the root id for this tree."""
 
 
1282
        inv = self.read_working_inventory()
 
 
1283
        orig_root_id = inv.root.file_id
 
 
1284
        del inv._byid[inv.root.file_id]
 
 
1285
        inv.root.file_id = file_id
 
 
1286
        inv._byid[inv.root.file_id] = inv.root
 
 
1289
            if entry.parent_id == orig_root_id:
 
 
1290
                entry.parent_id = inv.root.file_id
 
 
1291
        self._write_inventory(inv)
 
 
1294
        """See Branch.unlock.
 
 
1296
        WorkingTree locking just uses the Branch locking facilities.
 
 
1297
        This is current because all working trees have an embedded branch
 
 
1298
        within them. IF in the future, we were to make branch data shareable
 
 
1299
        between multiple working trees, i.e. via shared storage, then we 
 
 
1300
        would probably want to lock both the local tree, and the branch.
 
 
1302
        # FIXME: We want to write out the hashcache only when the last lock on
 
 
1303
        # this working copy is released.  Peeking at the lock count is a bit
 
 
1304
        # of a nasty hack; probably it's better to have a transaction object,
 
 
1305
        # which can do some finalization when it's either successfully or
 
 
1306
        # unsuccessfully completed.  (Denys's original patch did that.)
 
 
1307
        # RBC 20060206 hookinhg into transaction will couple lock and transaction
 
 
1308
        # wrongly. Hookinh into unllock on the control files object is fine though.
 
 
1310
        # TODO: split this per format so there is no ugly if block
 
 
1311
        if self._hashcache.needs_write and (
 
 
1312
            # dedicated lock files
 
 
1313
            self._control_files._lock_count==1 or 
 
 
1315
            (self._control_files is self.branch.control_files and 
 
 
1316
             self._control_files._lock_count==3)):
 
 
1317
            self._hashcache.write()
 
 
1318
        # reverse order of locking.
 
 
1320
            return self._control_files.unlock()
 
 
1322
            self.branch.unlock()
 
 
1326
        """Update a working tree along its branch.
 
 
1328
        This will update the branch if its bound too, which means we have multiple trees involved:
 
 
1329
        The new basis tree of the master.
 
 
1330
        The old basis tree of the branch.
 
 
1331
        The old basis tree of the working tree.
 
 
1332
        The current working tree state.
 
 
1333
        pathologically all three may be different, and non ancestors of each other.
 
 
1334
        Conceptually we want to:
 
 
1335
        Preserve the wt.basis->wt.state changes
 
 
1336
        Transform the wt.basis to the new master basis.
 
 
1337
        Apply a merge of the old branch basis to get any 'local' changes from it into the tree.
 
 
1338
        Restore the wt.basis->wt.state changes.
 
 
1340
        There isn't a single operation at the moment to do that, so we:
 
 
1341
        Merge current state -> basis tree of the master w.r.t. the old tree basis.
 
 
1342
        Do a 'normal' merge of the old branch basis if it is relevant.
 
 
1344
        old_tip = self.branch.update()
 
 
1345
        if old_tip is not None:
 
 
1346
            self.add_pending_merge(old_tip)
 
 
1347
        self.branch.lock_read()
 
 
1350
            if self.last_revision() != self.branch.last_revision():
 
 
1351
                # merge tree state up to new branch tip.
 
 
1352
                basis = self.basis_tree()
 
 
1353
                to_tree = self.branch.basis_tree()
 
 
1354
                result += merge_inner(self.branch,
 
 
1358
                self.set_last_revision(self.branch.last_revision())
 
 
1359
            if old_tip and old_tip != self.last_revision():
 
 
1360
                # our last revision was not the prior branch last reivison
 
 
1361
                # and we have converted that last revision to a pending merge.
 
 
1362
                # base is somewhere between the branch tip now
 
 
1363
                # and the now pending merge
 
 
1364
                from bzrlib.revision import common_ancestor
 
 
1366
                    base_rev_id = common_ancestor(self.branch.last_revision(),
 
 
1368
                                                  self.branch.repository)
 
 
1369
                except errors.NoCommonAncestor:
 
 
1371
                base_tree = self.branch.repository.revision_tree(base_rev_id)
 
 
1372
                other_tree = self.branch.repository.revision_tree(old_tip)
 
 
1373
                result += merge_inner(self.branch,
 
 
1379
            self.branch.unlock()
 
 
1382
    def _write_inventory(self, inv):
 
 
1383
        """Write inventory as the current inventory."""
 
 
1385
        bzrlib.xml5.serializer_v5.write_inventory(inv, sio)
 
 
1387
        self._control_files.put('inventory', sio)
 
 
1388
        self._set_inventory(inv)
 
 
1389
        mutter('wrote working inventory')
 
 
1391
    def set_conflicts(self, arg):
 
 
1392
        raise UnsupportedOperation(self.set_conflicts, self)
 
 
1395
    def conflicts(self):
 
 
1396
        conflicts = ConflictList()
 
 
1397
        for conflicted in self._iter_conflicts():
 
 
1400
                if file_kind(self.abspath(conflicted)) != "file":
 
 
1403
                if e.errno == errno.ENOENT:
 
 
1408
                for suffix in ('.THIS', '.OTHER'):
 
 
1410
                        kind = file_kind(self.abspath(conflicted+suffix))
 
 
1412
                        if e.errno == errno.ENOENT:
 
 
1420
            ctype = {True: 'text conflict', False: 'contents conflict'}[text]
 
 
1421
            conflicts.append(Conflict.factory(ctype, path=conflicted,
 
 
1422
                             file_id=self.path2id(conflicted)))
 
 
1426
class WorkingTree3(WorkingTree):
 
 
1427
    """This is the Format 3 working tree.
 
 
1429
    This differs from the base WorkingTree by:
 
 
1430
     - having its own file lock
 
 
1431
     - having its own last-revision property.
 
 
1433
    This is new in bzr 0.8
 
 
1437
    def last_revision(self):
 
 
1438
        """See WorkingTree.last_revision."""
 
 
1440
            return self._control_files.get_utf8('last-revision').read()
 
 
1444
    def _change_last_revision(self, revision_id):
 
 
1445
        """See WorkingTree._change_last_revision."""
 
 
1446
        if revision_id is None or revision_id == NULL_REVISION:
 
 
1448
                self._control_files._transport.delete('last-revision')
 
 
1449
            except errors.NoSuchFile:
 
 
1454
                self.branch.revision_history().index(revision_id)
 
 
1456
                raise errors.NoSuchRevision(self.branch, revision_id)
 
 
1457
            self._control_files.put_utf8('last-revision', revision_id)
 
 
1461
    def set_conflicts(self, conflicts):
 
 
1462
        self._put_rio('conflicts', conflicts.to_stanzas(), 
 
 
1466
    def conflicts(self):
 
 
1468
            confile = self._control_files.get('conflicts')
 
 
1470
            return ConflictList()
 
 
1472
            if confile.next() != CONFLICT_HEADER_1 + '\n':
 
 
1473
                raise ConflictFormatError()
 
 
1474
        except StopIteration:
 
 
1475
            raise ConflictFormatError()
 
 
1476
        return ConflictList.from_stanzas(RioReader(confile))
 
 
1479
def get_conflicted_stem(path):
 
 
1480
    for suffix in CONFLICT_SUFFIXES:
 
 
1481
        if path.endswith(suffix):
 
 
1482
            return path[:-len(suffix)]
 
 
1484
@deprecated_function(zero_eight)
 
 
1485
def is_control_file(filename):
 
 
1486
    """See WorkingTree.is_control_filename(filename)."""
 
 
1487
    ## FIXME: better check
 
 
1488
    filename = normpath(filename)
 
 
1489
    while filename != '':
 
 
1490
        head, tail = os.path.split(filename)
 
 
1491
        ## mutter('check %r for control file' % ((head, tail),))
 
 
1494
        if filename == head:
 
 
1500
class WorkingTreeFormat(object):
 
 
1501
    """An encapsulation of the initialization and open routines for a format.
 
 
1503
    Formats provide three things:
 
 
1504
     * An initialization routine,
 
 
1508
    Formats are placed in an dict by their format string for reference 
 
 
1509
    during workingtree opening. Its not required that these be instances, they
 
 
1510
    can be classes themselves with class methods - it simply depends on 
 
 
1511
    whether state is needed for a given format or not.
 
 
1513
    Once a format is deprecated, just deprecate the initialize and open
 
 
1514
    methods on the format class. Do not deprecate the object, as the 
 
 
1515
    object will be created every time regardless.
 
 
1518
    _default_format = None
 
 
1519
    """The default format used for new trees."""
 
 
1522
    """The known formats."""
 
 
1525
    def find_format(klass, a_bzrdir):
 
 
1526
        """Return the format for the working tree object in a_bzrdir."""
 
 
1528
            transport = a_bzrdir.get_workingtree_transport(None)
 
 
1529
            format_string = transport.get("format").read()
 
 
1530
            return klass._formats[format_string]
 
 
1532
            raise errors.NoWorkingTree(base=transport.base)
 
 
1534
            raise errors.UnknownFormatError(format_string)
 
 
1537
    def get_default_format(klass):
 
 
1538
        """Return the current default format."""
 
 
1539
        return klass._default_format
 
 
1541
    def get_format_string(self):
 
 
1542
        """Return the ASCII format string that identifies this format."""
 
 
1543
        raise NotImplementedError(self.get_format_string)
 
 
1545
    def get_format_description(self):
 
 
1546
        """Return the short description for this format."""
 
 
1547
        raise NotImplementedError(self.get_format_description)
 
 
1549
    def is_supported(self):
 
 
1550
        """Is this format supported?
 
 
1552
        Supported formats can be initialized and opened.
 
 
1553
        Unsupported formats may not support initialization or committing or 
 
 
1554
        some other features depending on the reason for not being supported.
 
 
1559
    def register_format(klass, format):
 
 
1560
        klass._formats[format.get_format_string()] = format
 
 
1563
    def set_default_format(klass, format):
 
 
1564
        klass._default_format = format
 
 
1567
    def unregister_format(klass, format):
 
 
1568
        assert klass._formats[format.get_format_string()] is format
 
 
1569
        del klass._formats[format.get_format_string()]
 
 
1573
class WorkingTreeFormat2(WorkingTreeFormat):
 
 
1574
    """The second working tree format. 
 
 
1576
    This format modified the hash cache from the format 1 hash cache.
 
 
1579
    def get_format_description(self):
 
 
1580
        """See WorkingTreeFormat.get_format_description()."""
 
 
1581
        return "Working tree format 2"
 
 
1583
    def stub_initialize_remote(self, control_files):
 
 
1584
        """As a special workaround create critical control files for a remote working tree
 
 
1586
        This ensures that it can later be updated and dealt with locally,
 
 
1587
        since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with 
 
 
1588
        no working tree.  (See bug #43064).
 
 
1592
        bzrlib.xml5.serializer_v5.write_inventory(inv, sio)
 
 
1594
        control_files.put('inventory', sio)
 
 
1596
        control_files.put_utf8('pending-merges', '')
 
 
1599
    def initialize(self, a_bzrdir, revision_id=None):
 
 
1600
        """See WorkingTreeFormat.initialize()."""
 
 
1601
        if not isinstance(a_bzrdir.transport, LocalTransport):
 
 
1602
            raise errors.NotLocalUrl(a_bzrdir.transport.base)
 
 
1603
        branch = a_bzrdir.open_branch()
 
 
1604
        if revision_id is not None:
 
 
1607
                revision_history = branch.revision_history()
 
 
1609
                    position = revision_history.index(revision_id)
 
 
1611
                    raise errors.NoSuchRevision(branch, revision_id)
 
 
1612
                branch.set_revision_history(revision_history[:position + 1])
 
 
1615
        revision = branch.last_revision()
 
 
1617
        wt = WorkingTree(a_bzrdir.root_transport.base,
 
 
1623
        wt._write_inventory(inv)
 
 
1624
        wt.set_root_id(inv.root.file_id)
 
 
1625
        wt.set_last_revision(revision)
 
 
1626
        wt.set_pending_merges([])
 
 
1627
        build_tree(wt.basis_tree(), wt)
 
 
1631
        super(WorkingTreeFormat2, self).__init__()
 
 
1632
        self._matchingbzrdir = bzrdir.BzrDirFormat6()
 
 
1634
    def open(self, a_bzrdir, _found=False):
 
 
1635
        """Return the WorkingTree object for a_bzrdir
 
 
1637
        _found is a private parameter, do not use it. It is used to indicate
 
 
1638
               if format probing has already been done.
 
 
1641
            # we are being called directly and must probe.
 
 
1642
            raise NotImplementedError
 
 
1643
        if not isinstance(a_bzrdir.transport, LocalTransport):
 
 
1644
            raise errors.NotLocalUrl(a_bzrdir.transport.base)
 
 
1645
        return WorkingTree(a_bzrdir.root_transport.base,
 
 
1651
class WorkingTreeFormat3(WorkingTreeFormat):
 
 
1652
    """The second working tree format updated to record a format marker.
 
 
1655
        - exists within a metadir controlling .bzr
 
 
1656
        - includes an explicit version marker for the workingtree control
 
 
1657
          files, separate from the BzrDir format
 
 
1658
        - modifies the hash cache format
 
 
1660
        - uses a LockDir to guard access to the repository
 
 
1663
    def get_format_string(self):
 
 
1664
        """See WorkingTreeFormat.get_format_string()."""
 
 
1665
        return "Bazaar-NG Working Tree format 3"
 
 
1667
    def get_format_description(self):
 
 
1668
        """See WorkingTreeFormat.get_format_description()."""
 
 
1669
        return "Working tree format 3"
 
 
1671
    _lock_file_name = 'lock'
 
 
1672
    _lock_class = LockDir
 
 
1674
    def _open_control_files(self, a_bzrdir):
 
 
1675
        transport = a_bzrdir.get_workingtree_transport(None)
 
 
1676
        return LockableFiles(transport, self._lock_file_name, 
 
 
1679
    def initialize(self, a_bzrdir, revision_id=None):
 
 
1680
        """See WorkingTreeFormat.initialize().
 
 
1682
        revision_id allows creating a working tree at a differnet
 
 
1683
        revision than the branch is at.
 
 
1685
        if not isinstance(a_bzrdir.transport, LocalTransport):
 
 
1686
            raise errors.NotLocalUrl(a_bzrdir.transport.base)
 
 
1687
        transport = a_bzrdir.get_workingtree_transport(self)
 
 
1688
        control_files = self._open_control_files(a_bzrdir)
 
 
1689
        control_files.create_lock()
 
 
1690
        control_files.lock_write()
 
 
1691
        control_files.put_utf8('format', self.get_format_string())
 
 
1692
        branch = a_bzrdir.open_branch()
 
 
1693
        if revision_id is None:
 
 
1694
            revision_id = branch.last_revision()
 
 
1696
        wt = WorkingTree3(a_bzrdir.root_transport.base,
 
 
1702
                         _control_files=control_files)
 
 
1705
            wt._write_inventory(inv)
 
 
1706
            wt.set_root_id(inv.root.file_id)
 
 
1707
            wt.set_last_revision(revision_id)
 
 
1708
            wt.set_pending_merges([])
 
 
1709
            build_tree(wt.basis_tree(), wt)
 
 
1712
            control_files.unlock()
 
 
1716
        super(WorkingTreeFormat3, self).__init__()
 
 
1717
        self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
 
 
1719
    def open(self, a_bzrdir, _found=False):
 
 
1720
        """Return the WorkingTree object for a_bzrdir
 
 
1722
        _found is a private parameter, do not use it. It is used to indicate
 
 
1723
               if format probing has already been done.
 
 
1726
            # we are being called directly and must probe.
 
 
1727
            raise NotImplementedError
 
 
1728
        if not isinstance(a_bzrdir.transport, LocalTransport):
 
 
1729
            raise errors.NotLocalUrl(a_bzrdir.transport.base)
 
 
1730
        control_files = self._open_control_files(a_bzrdir)
 
 
1731
        return WorkingTree3(a_bzrdir.root_transport.base,
 
 
1735
                           _control_files=control_files)
 
 
1738
        return self.get_format_string()
 
 
1741
# formats which have no format string are not discoverable
 
 
1742
# and not independently creatable, so are not registered.
 
 
1743
__default_format = WorkingTreeFormat3()
 
 
1744
WorkingTreeFormat.register_format(__default_format)
 
 
1745
WorkingTreeFormat.set_default_format(__default_format)
 
 
1746
_legacy_formats = [WorkingTreeFormat2(),
 
 
1750
class WorkingTreeTestProviderAdapter(object):
 
 
1751
    """A tool to generate a suite testing multiple workingtree formats at once.
 
 
1753
    This is done by copying the test once for each transport and injecting
 
 
1754
    the transport_server, transport_readonly_server, and workingtree_format
 
 
1755
    classes into each copy. Each copy is also given a new id() to make it
 
 
1759
    def __init__(self, transport_server, transport_readonly_server, formats):
 
 
1760
        self._transport_server = transport_server
 
 
1761
        self._transport_readonly_server = transport_readonly_server
 
 
1762
        self._formats = formats
 
 
1764
    def adapt(self, test):
 
 
1765
        from bzrlib.tests import TestSuite
 
 
1766
        result = TestSuite()
 
 
1767
        for workingtree_format, bzrdir_format in self._formats:
 
 
1768
            new_test = deepcopy(test)
 
 
1769
            new_test.transport_server = self._transport_server
 
 
1770
            new_test.transport_readonly_server = self._transport_readonly_server
 
 
1771
            new_test.bzrdir_format = bzrdir_format
 
 
1772
            new_test.workingtree_format = workingtree_format
 
 
1773
            def make_new_test_id():
 
 
1774
                new_id = "%s(%s)" % (new_test.id(), workingtree_format.__class__.__name__)
 
 
1775
                return lambda: new_id
 
 
1776
            new_test.id = make_new_test_id()
 
 
1777
            result.addTest(new_test)