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
 
 
44
from copy import deepcopy
 
 
45
from cStringIO import StringIO
 
 
53
from bzrlib.atomicfile import AtomicFile
 
 
54
from bzrlib.branch import (Branch,
 
 
56
from bzrlib.conflicts import Conflict, ConflictList, CONFLICT_SUFFIXES
 
 
57
import bzrlib.bzrdir as bzrdir
 
 
58
from bzrlib.decorators import needs_read_lock, needs_write_lock
 
 
59
import bzrlib.errors as errors
 
 
60
from bzrlib.errors import (BzrCheckError,
 
 
64
                           WeaveRevisionNotPresent,
 
 
68
                           MergeModifiedFormatError,
 
 
71
from bzrlib.inventory import InventoryEntry, Inventory
 
 
72
from bzrlib.lockable_files import LockableFiles, TransportLock
 
 
73
from bzrlib.lockdir import LockDir
 
 
74
from bzrlib.merge import merge_inner, transform_tree
 
 
75
from bzrlib.osutils import (
 
 
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
 
 
102
import bzrlib.urlutils as urlutils
 
 
107
# the regex here does the following:
 
 
108
# 1) remove any weird characters; we don't escape them but rather
 
 
110
 # 2) match leading '.'s to make it not hidden
 
 
111
_gen_file_id_re = re.compile(r'[^\w.]|(^\.*)')
 
 
112
_gen_id_suffix = None
 
 
116
def _next_id_suffix():
 
 
117
    """Create a new file id suffix that is reasonably unique.
 
 
119
    On the first call we combine the current time with 64 bits of randomness
 
 
120
    to give a highly probably globally unique number. Then each call in the same
 
 
121
    process adds 1 to a serial number we append to that unique value.
 
 
123
    # XXX TODO: change bzrlib.add.smart_add to call workingtree.add() rather 
 
 
124
    # than having to move the id randomness out of the inner loop like this.
 
 
125
    # XXX TODO: for the global randomness this uses we should add the thread-id
 
 
126
    # before the serial #.
 
 
127
    global _gen_id_suffix, _gen_id_serial
 
 
128
    if _gen_id_suffix is None:
 
 
129
        _gen_id_suffix = "-%s-%s-" % (compact_date(time()), rand_chars(16))
 
 
131
    return _gen_id_suffix + str(_gen_id_serial)
 
 
134
def gen_file_id(name):
 
 
135
    """Return new file id for the basename 'name'.
 
 
137
    The uniqueness is supplied from _next_id_suffix.
 
 
139
    # XXX TODO: squash the filename to lowercase.
 
 
140
    # XXX TODO: truncate the filename to something like 20 or 30 chars.
 
 
141
    # XXX TODO: consider what to do with ids that look like illegal filepaths
 
 
142
    # on platforms we support.
 
 
143
    return _gen_file_id_re.sub('', name) + _next_id_suffix()
 
 
147
    """Return a new tree-root file id."""
 
 
148
    return gen_file_id('TREE_ROOT')
 
 
151
class TreeEntry(object):
 
 
152
    """An entry that implements the minimum interface used by commands.
 
 
154
    This needs further inspection, it may be better to have 
 
 
155
    InventoryEntries without ids - though that seems wrong. For now,
 
 
156
    this is a parallel hierarchy to InventoryEntry, and needs to become
 
 
157
    one of several things: decorates to that hierarchy, children of, or
 
 
159
    Another note is that these objects are currently only used when there is
 
 
160
    no InventoryEntry available - i.e. for unversioned objects.
 
 
161
    Perhaps they should be UnversionedEntry et al. ? - RBC 20051003
 
 
164
    def __eq__(self, other):
 
 
165
        # yes, this us ugly, TODO: best practice __eq__ style.
 
 
166
        return (isinstance(other, TreeEntry)
 
 
167
                and other.__class__ == self.__class__)
 
 
169
    def kind_character(self):
 
 
173
class TreeDirectory(TreeEntry):
 
 
174
    """See TreeEntry. This is a directory in a working tree."""
 
 
176
    def __eq__(self, other):
 
 
177
        return (isinstance(other, TreeDirectory)
 
 
178
                and other.__class__ == self.__class__)
 
 
180
    def kind_character(self):
 
 
184
class TreeFile(TreeEntry):
 
 
185
    """See TreeEntry. This is a regular file in a working tree."""
 
 
187
    def __eq__(self, other):
 
 
188
        return (isinstance(other, TreeFile)
 
 
189
                and other.__class__ == self.__class__)
 
 
191
    def kind_character(self):
 
 
195
class TreeLink(TreeEntry):
 
 
196
    """See TreeEntry. This is a symlink in a working tree."""
 
 
198
    def __eq__(self, other):
 
 
199
        return (isinstance(other, TreeLink)
 
 
200
                and other.__class__ == self.__class__)
 
 
202
    def kind_character(self):
 
 
206
class WorkingTree(bzrlib.tree.Tree):
 
 
207
    """Working copy tree.
 
 
209
    The inventory is held in the `Branch` working-inventory, and the
 
 
210
    files are in a directory on disk.
 
 
212
    It is possible for a `WorkingTree` to have a filename which is
 
 
213
    not listed in the Inventory and vice versa.
 
 
216
    def __init__(self, basedir='.',
 
 
217
                 branch=DEPRECATED_PARAMETER,
 
 
223
        """Construct a WorkingTree for basedir.
 
 
225
        If the branch is not supplied, it is opened automatically.
 
 
226
        If the branch is supplied, it must be the branch for this basedir.
 
 
227
        (branch.base is not cross checked, because for remote branches that
 
 
228
        would be meaningless).
 
 
230
        self._format = _format
 
 
231
        self.bzrdir = _bzrdir
 
 
233
            # not created via open etc.
 
 
234
            warn("WorkingTree() is deprecated as of bzr version 0.8. "
 
 
235
                 "Please use bzrdir.open_workingtree or WorkingTree.open().",
 
 
238
            wt = WorkingTree.open(basedir)
 
 
239
            self._branch = wt.branch
 
 
240
            self.basedir = wt.basedir
 
 
241
            self._control_files = wt._control_files
 
 
242
            self._hashcache = wt._hashcache
 
 
243
            self._set_inventory(wt._inventory)
 
 
244
            self._format = wt._format
 
 
245
            self.bzrdir = wt.bzrdir
 
 
246
        from bzrlib.hashcache import HashCache
 
 
247
        from bzrlib.trace import note, mutter
 
 
248
        assert isinstance(basedir, basestring), \
 
 
249
            "base directory %r is not a string" % basedir
 
 
250
        basedir = safe_unicode(basedir)
 
 
251
        mutter("opening working tree %r", basedir)
 
 
252
        if deprecated_passed(branch):
 
 
254
                warn("WorkingTree(..., branch=XXX) is deprecated as of bzr 0.8."
 
 
255
                     " Please use bzrdir.open_workingtree() or"
 
 
256
                     " WorkingTree.open().",
 
 
260
            self._branch = branch
 
 
262
            self._branch = self.bzrdir.open_branch()
 
 
263
        assert isinstance(self.branch, Branch), \
 
 
264
            "branch %r is not a Branch" % self.branch
 
 
265
        self.basedir = realpath(basedir)
 
 
266
        # if branch is at our basedir and is a format 6 or less
 
 
267
        if isinstance(self._format, WorkingTreeFormat2):
 
 
268
            # share control object
 
 
269
            self._control_files = self.branch.control_files
 
 
271
            # only ready for format 3
 
 
272
            assert isinstance(self._format, WorkingTreeFormat3)
 
 
273
            assert isinstance(_control_files, LockableFiles), \
 
 
274
                    "_control_files must be a LockableFiles, not %r" \
 
 
276
            self._control_files = _control_files
 
 
277
        # update the whole cache up front and write to disk if anything changed;
 
 
278
        # in the future we might want to do this more selectively
 
 
279
        # two possible ways offer themselves : in self._unlock, write the cache
 
 
280
        # if needed, or, when the cache sees a change, append it to the hash
 
 
281
        # cache file, and have the parser take the most recent entry for a
 
 
283
        cache_filename = self.bzrdir.get_workingtree_transport(None).local_abspath('stat-cache')
 
 
284
        hc = self._hashcache = HashCache(basedir, cache_filename, self._control_files._file_mode)
 
 
286
        # is this scan needed ? it makes things kinda slow.
 
 
293
        if _inventory is None:
 
 
294
            self._set_inventory(self.read_working_inventory())
 
 
296
            self._set_inventory(_inventory)
 
 
299
        fget=lambda self: self._branch,
 
 
300
        doc="""The branch this WorkingTree is connected to.
 
 
302
            This cannot be set - it is reflective of the actual disk structure
 
 
303
            the working tree has been constructed from.
 
 
306
    def break_lock(self):
 
 
307
        """Break a lock if one is present from another instance.
 
 
309
        Uses the ui factory to ask for confirmation if the lock may be from
 
 
312
        This will probe the repository for its lock as well.
 
 
314
        self._control_files.break_lock()
 
 
315
        self.branch.break_lock()
 
 
317
    def _set_inventory(self, inv):
 
 
318
        self._inventory = inv
 
 
319
        self.path2id = self._inventory.path2id
 
 
321
    def is_control_filename(self, filename):
 
 
322
        """True if filename is the name of a control file in this tree.
 
 
324
        :param filename: A filename within the tree. This is a relative path
 
 
325
        from the root of this tree.
 
 
327
        This is true IF and ONLY IF the filename is part of the meta data
 
 
328
        that bzr controls in this tree. I.E. a random .bzr directory placed
 
 
329
        on disk will not be a control file for this tree.
 
 
331
        return self.bzrdir.is_control_filename(filename)
 
 
334
    def open(path=None, _unsupported=False):
 
 
335
        """Open an existing working tree at path.
 
 
339
            path = os.path.getcwdu()
 
 
340
        control = bzrdir.BzrDir.open(path, _unsupported)
 
 
341
        return control.open_workingtree(_unsupported)
 
 
344
    def open_containing(path=None):
 
 
345
        """Open an existing working tree which has its root about path.
 
 
347
        This probes for a working tree at path and searches upwards from there.
 
 
349
        Basically we keep looking up until we find the control directory or
 
 
350
        run into /.  If there isn't one, raises NotBranchError.
 
 
351
        TODO: give this a new exception.
 
 
352
        If there is one, it is returned, along with the unused portion of path.
 
 
354
        :return: The WorkingTree that contains 'path', and the rest of path
 
 
358
        control, relpath = bzrdir.BzrDir.open_containing(path)
 
 
360
        return control.open_workingtree(), relpath
 
 
363
    def open_downlevel(path=None):
 
 
364
        """Open an unsupported working tree.
 
 
366
        Only intended for advanced situations like upgrading part of a bzrdir.
 
 
368
        return WorkingTree.open(path, _unsupported=True)
 
 
371
        """Iterate through file_ids for this tree.
 
 
373
        file_ids are in a WorkingTree if they are in the working inventory
 
 
374
        and the working file exists.
 
 
376
        inv = self._inventory
 
 
377
        for path, ie in inv.iter_entries():
 
 
378
            if bzrlib.osutils.lexists(self.abspath(path)):
 
 
382
        return "<%s of %s>" % (self.__class__.__name__,
 
 
383
                               getattr(self, 'basedir', None))
 
 
385
    def abspath(self, filename):
 
 
386
        return pathjoin(self.basedir, filename)
 
 
388
    def basis_tree(self):
 
 
389
        """Return RevisionTree for the current last revision."""
 
 
390
        revision_id = self.last_revision()
 
 
391
        if revision_id is not None:
 
 
393
                xml = self.read_basis_inventory()
 
 
394
                inv = bzrlib.xml5.serializer_v5.read_inventory_from_string(xml)
 
 
397
            if inv is not None and inv.revision_id == revision_id:
 
 
398
                return bzrlib.tree.RevisionTree(self.branch.repository, inv,
 
 
400
        # FIXME? RBC 20060403 should we cache the inventory here ?
 
 
401
        return self.branch.repository.revision_tree(revision_id)
 
 
404
    @deprecated_method(zero_eight)
 
 
405
    def create(branch, directory):
 
 
406
        """Create a workingtree for branch at directory.
 
 
408
        If existing_directory already exists it must have a .bzr directory.
 
 
409
        If it does not exist, it will be created.
 
 
411
        This returns a new WorkingTree object for the new checkout.
 
 
413
        TODO FIXME RBC 20060124 when we have checkout formats in place this
 
 
414
        should accept an optional revisionid to checkout [and reject this if
 
 
415
        checking out into the same dir as a pre-checkout-aware branch format.]
 
 
417
        XXX: When BzrDir is present, these should be created through that 
 
 
420
        warn('delete WorkingTree.create', stacklevel=3)
 
 
421
        transport = get_transport(directory)
 
 
422
        if branch.bzrdir.root_transport.base == transport.base:
 
 
424
            return branch.bzrdir.create_workingtree()
 
 
425
        # different directory, 
 
 
426
        # create a branch reference
 
 
427
        # and now a working tree.
 
 
428
        raise NotImplementedError
 
 
431
    @deprecated_method(zero_eight)
 
 
432
    def create_standalone(directory):
 
 
433
        """Create a checkout and a branch and a repo at directory.
 
 
435
        Directory must exist and be empty.
 
 
437
        please use BzrDir.create_standalone_workingtree
 
 
439
        return bzrdir.BzrDir.create_standalone_workingtree(directory)
 
 
441
    def relpath(self, path):
 
 
442
        """Return the local path portion from a given path.
 
 
444
        The path may be absolute or relative. If its a relative path it is 
 
 
445
        interpreted relative to the python current working directory.
 
 
447
        return relpath(self.basedir, path)
 
 
449
    def has_filename(self, filename):
 
 
450
        return bzrlib.osutils.lexists(self.abspath(filename))
 
 
452
    def get_file(self, file_id):
 
 
453
        return self.get_file_byname(self.id2path(file_id))
 
 
455
    def get_file_byname(self, filename):
 
 
456
        return file(self.abspath(filename), 'rb')
 
 
458
    def get_root_id(self):
 
 
459
        """Return the id of this trees root"""
 
 
460
        inv = self.read_working_inventory()
 
 
461
        return inv.root.file_id
 
 
463
    def _get_store_filename(self, file_id):
 
 
464
        ## XXX: badly named; this is not in the store at all
 
 
465
        return self.abspath(self.id2path(file_id))
 
 
468
    def clone(self, to_bzrdir, revision_id=None, basis=None):
 
 
469
        """Duplicate this working tree into to_bzr, including all state.
 
 
471
        Specifically modified files are kept as modified, but
 
 
472
        ignored and unknown files are discarded.
 
 
474
        If you want to make a new line of development, see bzrdir.sprout()
 
 
477
            If not None, the cloned tree will have its last revision set to 
 
 
478
            revision, and and difference between the source trees last revision
 
 
479
            and this one merged in.
 
 
482
            If not None, a closer copy of a tree which may have some files in
 
 
483
            common, and which file content should be preferentially copied from.
 
 
485
        # assumes the target bzr dir format is compatible.
 
 
486
        result = self._format.initialize(to_bzrdir)
 
 
487
        self.copy_content_into(result, revision_id)
 
 
491
    def copy_content_into(self, tree, revision_id=None):
 
 
492
        """Copy the current content and user files of this tree into tree."""
 
 
493
        if revision_id is None:
 
 
494
            transform_tree(tree, self)
 
 
496
            # TODO now merge from tree.last_revision to revision
 
 
497
            transform_tree(tree, self)
 
 
498
            tree.set_last_revision(revision_id)
 
 
501
    def commit(self, message=None, revprops=None, *args, **kwargs):
 
 
502
        # avoid circular imports
 
 
503
        from bzrlib.commit import Commit
 
 
506
        if not 'branch-nick' in revprops:
 
 
507
            revprops['branch-nick'] = self.branch.nick
 
 
508
        # args for wt.commit start at message from the Commit.commit method,
 
 
509
        # but with branch a kwarg now, passing in args as is results in the
 
 
510
        #message being used for the branch
 
 
511
        args = (DEPRECATED_PARAMETER, message, ) + args
 
 
512
        committed_id = Commit().commit( working_tree=self, revprops=revprops,
 
 
514
        self._set_inventory(self.read_working_inventory())
 
 
517
    def id2abspath(self, file_id):
 
 
518
        return self.abspath(self.id2path(file_id))
 
 
520
    def has_id(self, file_id):
 
 
521
        # files that have been deleted are excluded
 
 
522
        inv = self._inventory
 
 
523
        if not inv.has_id(file_id):
 
 
525
        path = inv.id2path(file_id)
 
 
526
        return bzrlib.osutils.lexists(self.abspath(path))
 
 
528
    def has_or_had_id(self, file_id):
 
 
529
        if file_id == self.inventory.root.file_id:
 
 
531
        return self.inventory.has_id(file_id)
 
 
533
    __contains__ = has_id
 
 
535
    def get_file_size(self, file_id):
 
 
536
        return os.path.getsize(self.id2abspath(file_id))
 
 
539
    def get_file_sha1(self, file_id, path=None):
 
 
541
            path = self._inventory.id2path(file_id)
 
 
542
        return self._hashcache.get_sha1(path)
 
 
544
    def get_file_mtime(self, file_id, path=None):
 
 
546
            path = self._inventory.id2path(file_id)
 
 
547
        return os.lstat(self.abspath(path)).st_mtime
 
 
549
    if not supports_executable():
 
 
550
        def is_executable(self, file_id, path=None):
 
 
551
            return self._inventory[file_id].executable
 
 
553
        def is_executable(self, file_id, path=None):
 
 
555
                path = self._inventory.id2path(file_id)
 
 
556
            mode = os.lstat(self.abspath(path)).st_mode
 
 
557
            return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
 
 
560
    def add(self, files, ids=None):
 
 
561
        """Make files versioned.
 
 
563
        Note that the command line normally calls smart_add instead,
 
 
564
        which can automatically recurse.
 
 
566
        This adds the files to the inventory, so that they will be
 
 
567
        recorded by the next commit.
 
 
570
            List of paths to add, relative to the base of the tree.
 
 
573
            If set, use these instead of automatically generated ids.
 
 
574
            Must be the same length as the list of files, but may
 
 
575
            contain None for ids that are to be autogenerated.
 
 
577
        TODO: Perhaps have an option to add the ids even if the files do
 
 
580
        TODO: Perhaps callback with the ids and paths as they're added.
 
 
582
        # TODO: Re-adding a file that is removed in the working copy
 
 
583
        # should probably put it back with the previous ID.
 
 
584
        if isinstance(files, basestring):
 
 
585
            assert(ids is None or isinstance(ids, basestring))
 
 
591
            ids = [None] * len(files)
 
 
593
            assert(len(ids) == len(files))
 
 
595
        inv = self.read_working_inventory()
 
 
596
        for f,file_id in zip(files, ids):
 
 
597
            if self.is_control_filename(f):
 
 
598
                raise BzrError("cannot add control file %s" % quotefn(f))
 
 
603
                raise BzrError("cannot add top-level %r" % f)
 
 
605
            fullpath = normpath(self.abspath(f))
 
 
608
                kind = file_kind(fullpath)
 
 
610
                if e.errno == errno.ENOENT:
 
 
611
                    raise NoSuchFile(fullpath)
 
 
612
                # maybe something better?
 
 
613
                raise BzrError('cannot add: not a regular file, symlink or directory: %s' % quotefn(f))
 
 
615
            if not InventoryEntry.versionable_kind(kind):
 
 
616
                raise BzrError('cannot add: not a versionable file ('
 
 
617
                               'i.e. regular file, symlink or directory): %s' % quotefn(f))
 
 
620
                inv.add_path(f, kind=kind)
 
 
622
                inv.add_path(f, kind=kind, file_id=file_id)
 
 
624
        self._write_inventory(inv)
 
 
627
    def add_pending_merge(self, *revision_ids):
 
 
628
        # TODO: Perhaps should check at this point that the
 
 
629
        # history of the revision is actually present?
 
 
630
        p = self.pending_merges()
 
 
632
        for rev_id in revision_ids:
 
 
638
            self.set_pending_merges(p)
 
 
641
    def pending_merges(self):
 
 
642
        """Return a list of pending merges.
 
 
644
        These are revisions that have been merged into the working
 
 
645
        directory but not yet committed.
 
 
648
            merges_file = self._control_files.get_utf8('pending-merges')
 
 
650
            if e.errno != errno.ENOENT:
 
 
654
        for l in merges_file.readlines():
 
 
655
            p.append(l.rstrip('\n'))
 
 
659
    def set_pending_merges(self, rev_list):
 
 
660
        self._control_files.put_utf8('pending-merges', '\n'.join(rev_list))
 
 
663
    def set_merge_modified(self, modified_hashes):
 
 
665
            for file_id, hash in modified_hashes.iteritems():
 
 
666
                yield Stanza(file_id=file_id, hash=hash)
 
 
667
        self._put_rio('merge-hashes', iter_stanzas(), MERGE_MODIFIED_HEADER_1)
 
 
670
    def _put_rio(self, filename, stanzas, header):
 
 
671
        my_file = rio_file(stanzas, header)
 
 
672
        self._control_files.put(filename, my_file)
 
 
675
    def merge_modified(self):
 
 
677
            hashfile = self._control_files.get('merge-hashes')
 
 
682
            if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
 
 
683
                raise MergeModifiedFormatError()
 
 
684
        except StopIteration:
 
 
685
            raise MergeModifiedFormatError()
 
 
686
        for s in RioReader(hashfile):
 
 
687
            file_id = s.get("file_id")
 
 
688
            if file_id not in self.inventory:
 
 
691
            if hash == self.get_file_sha1(file_id):
 
 
692
                merge_hashes[file_id] = hash
 
 
695
    def get_symlink_target(self, file_id):
 
 
696
        return os.readlink(self.id2abspath(file_id))
 
 
698
    def file_class(self, filename):
 
 
699
        if self.path2id(filename):
 
 
701
        elif self.is_ignored(filename):
 
 
706
    def list_files(self):
 
 
707
        """Recursively list all files as (path, class, kind, id, entry).
 
 
709
        Lists, but does not descend into unversioned directories.
 
 
711
        This does not include files that have been deleted in this
 
 
714
        Skips the control directory.
 
 
716
        inv = self._inventory
 
 
717
        # Convert these into local objects to save lookup times
 
 
718
        pathjoin = bzrlib.osutils.pathjoin
 
 
719
        file_kind = bzrlib.osutils.file_kind
 
 
721
        # transport.base ends in a slash, we want the piece
 
 
722
        # between the last two slashes
 
 
723
        transport_base_dir = self.bzrdir.transport.base.rsplit('/', 2)[1]
 
 
725
        fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
 
 
727
        # directory file_id, relative path, absolute path, reverse sorted children
 
 
728
        children = os.listdir(self.basedir)
 
 
730
        # jam 20060527 The kernel sized tree seems equivalent whether we 
 
 
731
        # use a deque and popleft to keep them sorted, or if we use a plain
 
 
732
        # list and just reverse() them.
 
 
733
        children = collections.deque(children)
 
 
734
        stack = [(inv.root.file_id, u'', self.basedir, children)]
 
 
736
            from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
 
 
739
                f = children.popleft()
 
 
740
                ## TODO: If we find a subdirectory with its own .bzr
 
 
741
                ## directory, then that is a separate tree and we
 
 
742
                ## should exclude it.
 
 
744
                # the bzrdir for this tree
 
 
745
                if transport_base_dir == f:
 
 
748
                # we know that from_dir_relpath and from_dir_abspath never end in a slash
 
 
749
                # and 'f' doesn't begin with one, we can do a string op, rather
 
 
750
                # than the checks of pathjoin(), all relative paths will have an extra slash
 
 
752
                fp = from_dir_relpath + '/' + f
 
 
755
                fap = from_dir_abspath + '/' + f
 
 
757
                f_ie = inv.get_child(from_dir_id, f)
 
 
760
                elif self.is_ignored(fp[1:]):
 
 
769
                        raise BzrCheckError("file %r entered as kind %r id %r, "
 
 
771
                                            % (fap, f_ie.kind, f_ie.file_id, fk))
 
 
773
                # make a last minute entry
 
 
775
                    yield fp[1:], c, fk, f_ie.file_id, f_ie
 
 
778
                        yield fp[1:], c, fk, None, fk_entries[fk]()
 
 
780
                        yield fp[1:], c, fk, None, TreeEntry()
 
 
783
                if fk != 'directory':
 
 
786
                # But do this child first
 
 
787
                new_children = os.listdir(fap)
 
 
789
                new_children = collections.deque(new_children)
 
 
790
                stack.append((f_ie.file_id, fp, fap, new_children))
 
 
791
                # Break out of inner loop, so that we start outer loop with child
 
 
794
                # if we finished all children, pop it off the stack
 
 
799
    def move(self, from_paths, to_name):
 
 
802
        to_name must exist in the inventory.
 
 
804
        If to_name exists and is a directory, the files are moved into
 
 
805
        it, keeping their old names.  
 
 
807
        Note that to_name is only the last component of the new name;
 
 
808
        this doesn't change the directory.
 
 
810
        This returns a list of (from_path, to_path) pairs for each
 
 
814
        ## TODO: Option to move IDs only
 
 
815
        assert not isinstance(from_paths, basestring)
 
 
817
        to_abs = self.abspath(to_name)
 
 
818
        if not isdir(to_abs):
 
 
819
            raise BzrError("destination %r is not a directory" % to_abs)
 
 
820
        if not self.has_filename(to_name):
 
 
821
            raise BzrError("destination %r not in working directory" % to_abs)
 
 
822
        to_dir_id = inv.path2id(to_name)
 
 
823
        if to_dir_id == None and to_name != '':
 
 
824
            raise BzrError("destination %r is not a versioned directory" % to_name)
 
 
825
        to_dir_ie = inv[to_dir_id]
 
 
826
        if to_dir_ie.kind not in ('directory', 'root_directory'):
 
 
827
            raise BzrError("destination %r is not a directory" % to_abs)
 
 
829
        to_idpath = inv.get_idpath(to_dir_id)
 
 
832
            if not self.has_filename(f):
 
 
833
                raise BzrError("%r does not exist in working tree" % f)
 
 
834
            f_id = inv.path2id(f)
 
 
836
                raise BzrError("%r is not versioned" % f)
 
 
837
            name_tail = splitpath(f)[-1]
 
 
838
            dest_path = pathjoin(to_name, name_tail)
 
 
839
            if self.has_filename(dest_path):
 
 
840
                raise BzrError("destination %r already exists" % dest_path)
 
 
841
            if f_id in to_idpath:
 
 
842
                raise BzrError("can't move %r to a subdirectory of itself" % f)
 
 
844
        # OK, so there's a race here, it's possible that someone will
 
 
845
        # create a file in this interval and then the rename might be
 
 
846
        # left half-done.  But we should have caught most problems.
 
 
847
        orig_inv = deepcopy(self.inventory)
 
 
850
                name_tail = splitpath(f)[-1]
 
 
851
                dest_path = pathjoin(to_name, name_tail)
 
 
852
                result.append((f, dest_path))
 
 
853
                inv.rename(inv.path2id(f), to_dir_id, name_tail)
 
 
855
                    rename(self.abspath(f), self.abspath(dest_path))
 
 
857
                    raise BzrError("failed to rename %r to %r: %s" %
 
 
858
                                   (f, dest_path, e[1]),
 
 
859
                            ["rename rolled back"])
 
 
861
            # restore the inventory on error
 
 
862
            self._set_inventory(orig_inv)
 
 
864
        self._write_inventory(inv)
 
 
868
    def rename_one(self, from_rel, to_rel):
 
 
871
        This can change the directory or the filename or both.
 
 
874
        if not self.has_filename(from_rel):
 
 
875
            raise BzrError("can't rename: old working file %r does not exist" % from_rel)
 
 
876
        if self.has_filename(to_rel):
 
 
877
            raise BzrError("can't rename: new working file %r already exists" % to_rel)
 
 
879
        file_id = inv.path2id(from_rel)
 
 
881
            raise BzrError("can't rename: old name %r is not versioned" % from_rel)
 
 
884
        from_parent = entry.parent_id
 
 
885
        from_name = entry.name
 
 
887
        if inv.path2id(to_rel):
 
 
888
            raise BzrError("can't rename: new name %r is already versioned" % to_rel)
 
 
890
        to_dir, to_tail = os.path.split(to_rel)
 
 
891
        to_dir_id = inv.path2id(to_dir)
 
 
892
        if to_dir_id == None and to_dir != '':
 
 
893
            raise BzrError("can't determine destination directory id for %r" % to_dir)
 
 
895
        mutter("rename_one:")
 
 
896
        mutter("  file_id    {%s}" % file_id)
 
 
897
        mutter("  from_rel   %r" % from_rel)
 
 
898
        mutter("  to_rel     %r" % to_rel)
 
 
899
        mutter("  to_dir     %r" % to_dir)
 
 
900
        mutter("  to_dir_id  {%s}" % to_dir_id)
 
 
902
        inv.rename(file_id, to_dir_id, to_tail)
 
 
904
        from_abs = self.abspath(from_rel)
 
 
905
        to_abs = self.abspath(to_rel)
 
 
907
            rename(from_abs, to_abs)
 
 
909
            inv.rename(file_id, from_parent, from_name)
 
 
910
            raise BzrError("failed to rename %r to %r: %s"
 
 
911
                    % (from_abs, to_abs, e[1]),
 
 
912
                    ["rename rolled back"])
 
 
913
        self._write_inventory(inv)
 
 
917
        """Return all unknown files.
 
 
919
        These are files in the working directory that are not versioned or
 
 
920
        control files or ignored.
 
 
922
        >>> from bzrlib.bzrdir import ScratchDir
 
 
923
        >>> d = ScratchDir(files=['foo', 'foo~'])
 
 
924
        >>> b = d.open_branch()
 
 
925
        >>> tree = d.open_workingtree()
 
 
926
        >>> map(str, tree.unknowns())
 
 
929
        >>> list(b.unknowns())
 
 
931
        >>> tree.remove('foo')
 
 
932
        >>> list(b.unknowns())
 
 
935
        for subp in self.extras():
 
 
936
            if not self.is_ignored(subp):
 
 
939
    @deprecated_method(zero_eight)
 
 
940
    def iter_conflicts(self):
 
 
941
        """List all files in the tree that have text or content conflicts.
 
 
942
        DEPRECATED.  Use conflicts instead."""
 
 
943
        return self._iter_conflicts()
 
 
945
    def _iter_conflicts(self):
 
 
947
        for info in self.list_files():
 
 
949
            stem = get_conflicted_stem(path)
 
 
952
            if stem not in conflicted:
 
 
957
    def pull(self, source, overwrite=False, stop_revision=None):
 
 
958
        top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
 
961
            pp = ProgressPhase("Pull phase", 2, top_pb)
 
 
963
            old_revision_history = self.branch.revision_history()
 
 
964
            basis_tree = self.basis_tree()
 
 
965
            count = self.branch.pull(source, overwrite, stop_revision)
 
 
966
            new_revision_history = self.branch.revision_history()
 
 
967
            if new_revision_history != old_revision_history:
 
 
969
                if len(old_revision_history):
 
 
970
                    other_revision = old_revision_history[-1]
 
 
972
                    other_revision = None
 
 
973
                repository = self.branch.repository
 
 
974
                pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
 
976
                    merge_inner(self.branch,
 
 
977
                                self.branch.basis_tree(),
 
 
983
                self.set_last_revision(self.branch.last_revision())
 
 
990
        """Yield all unknown files in this WorkingTree.
 
 
992
        If there are any unknown directories then only the directory is
 
 
993
        returned, not all its children.  But if there are unknown files
 
 
994
        under a versioned subdirectory, they are returned.
 
 
996
        Currently returned depth-first, sorted by name within directories.
 
 
998
        ## TODO: Work from given directory downwards
 
 
999
        for path, dir_entry in self.inventory.directories():
 
 
1000
            mutter("search for unknowns in %r", path)
 
 
1001
            dirabs = self.abspath(path)
 
 
1002
            if not isdir(dirabs):
 
 
1003
                # e.g. directory deleted
 
 
1007
            for subf in os.listdir(dirabs):
 
 
1009
                    and (subf not in dir_entry.children)):
 
 
1014
                subp = pathjoin(path, subf)
 
 
1017
    def _translate_ignore_rule(self, rule):
 
 
1018
        """Translate a single ignore rule to a regex.
 
 
1020
        There are two types of ignore rules.  Those that do not contain a / are
 
 
1021
        matched against the tail of the filename (that is, they do not care
 
 
1022
        what directory the file is in.)  Rules which do contain a slash must
 
 
1023
        match the entire path.  As a special case, './' at the start of the
 
 
1024
        string counts as a slash in the string but is removed before matching
 
 
1025
        (e.g. ./foo.c, ./src/foo.c)
 
 
1027
        :return: The translated regex.
 
 
1029
        if rule[:2] in ('./', '.\\'):
 
 
1031
            result = fnmatch.translate(rule[2:])
 
 
1032
        elif '/' in rule or '\\' in rule:
 
 
1034
            result = fnmatch.translate(rule)
 
 
1036
            # default rule style.
 
 
1037
            result = "(?:.*/)?(?!.*/)" + fnmatch.translate(rule)
 
 
1038
        assert result[-1] == '$', "fnmatch.translate did not add the expected $"
 
 
1039
        return "(" + result + ")"
 
 
1041
    def _combine_ignore_rules(self, rules):
 
 
1042
        """Combine a list of ignore rules into a single regex object.
 
 
1044
        Each individual rule is combined with | to form a big regex, which then
 
 
1045
        has $ added to it to form something like ()|()|()$. The group index for
 
 
1046
        each subregex's outermost group is placed in a dictionary mapping back 
 
 
1047
        to the rule. This allows quick identification of the matching rule that
 
 
1049
        :return: a list of the compiled regex and the matching-group index 
 
 
1050
        dictionaries. We return a list because python complains if you try to 
 
 
1051
        combine more than 100 regexes.
 
 
1056
        translated_rules = []
 
 
1058
            translated_rule = self._translate_ignore_rule(rule)
 
 
1059
            compiled_rule = re.compile(translated_rule)
 
 
1060
            groups[next_group] = rule
 
 
1061
            next_group += compiled_rule.groups
 
 
1062
            translated_rules.append(translated_rule)
 
 
1063
            if next_group == 99:
 
 
1064
                result.append((re.compile("|".join(translated_rules)), groups))
 
 
1067
                translated_rules = []
 
 
1068
        if len(translated_rules):
 
 
1069
            result.append((re.compile("|".join(translated_rules)), groups))
 
 
1072
    def ignored_files(self):
 
 
1073
        """Yield list of PATH, IGNORE_PATTERN"""
 
 
1074
        for subp in self.extras():
 
 
1075
            pat = self.is_ignored(subp)
 
 
1079
    def get_ignore_list(self):
 
 
1080
        """Return list of ignore patterns.
 
 
1082
        Cached in the Tree object after the first call.
 
 
1084
        if hasattr(self, '_ignorelist'):
 
 
1085
            return self._ignorelist
 
 
1087
        l = bzrlib.DEFAULT_IGNORE[:]
 
 
1088
        if self.has_filename(bzrlib.IGNORE_FILENAME):
 
 
1089
            f = self.get_file_byname(bzrlib.IGNORE_FILENAME)
 
 
1090
            l.extend([line.rstrip("\n\r").decode('utf-8') 
 
 
1091
                      for line in f.readlines()])
 
 
1092
        self._ignorelist = l
 
 
1093
        self._ignore_regex = self._combine_ignore_rules(l)
 
 
1096
    def _get_ignore_rules_as_regex(self):
 
 
1097
        """Return a regex of the ignore rules and a mapping dict.
 
 
1099
        :return: (ignore rules compiled regex, dictionary mapping rule group 
 
 
1100
        indices to original rule.)
 
 
1102
        if getattr(self, '_ignorelist', None) is None:
 
 
1103
            self.get_ignore_list()
 
 
1104
        return self._ignore_regex
 
 
1106
    def is_ignored(self, filename):
 
 
1107
        r"""Check whether the filename matches an ignore pattern.
 
 
1109
        Patterns containing '/' or '\' need to match the whole path;
 
 
1110
        others match against only the last component.
 
 
1112
        If the file is ignored, returns the pattern which caused it to
 
 
1113
        be ignored, otherwise None.  So this can simply be used as a
 
 
1114
        boolean if desired."""
 
 
1116
        # TODO: Use '**' to match directories, and other extended
 
 
1117
        # globbing stuff from cvs/rsync.
 
 
1119
        # XXX: fnmatch is actually not quite what we want: it's only
 
 
1120
        # approximately the same as real Unix fnmatch, and doesn't
 
 
1121
        # treat dotfiles correctly and allows * to match /.
 
 
1122
        # Eventually it should be replaced with something more
 
 
1125
        rules = self._get_ignore_rules_as_regex()
 
 
1126
        for regex, mapping in rules:
 
 
1127
            match = regex.match(filename)
 
 
1128
            if match is not None:
 
 
1129
                # one or more of the groups in mapping will have a non-None group 
 
 
1131
                groups = match.groups()
 
 
1132
                rules = [mapping[group] for group in 
 
 
1133
                    mapping if groups[group] is not None]
 
 
1137
    def kind(self, file_id):
 
 
1138
        return file_kind(self.id2abspath(file_id))
 
 
1141
    def last_revision(self):
 
 
1142
        """Return the last revision id of this working tree.
 
 
1144
        In early branch formats this was == the branch last_revision,
 
 
1145
        but that cannot be relied upon - for working tree operations,
 
 
1146
        always use tree.last_revision().
 
 
1148
        return self.branch.last_revision()
 
 
1150
    def is_locked(self):
 
 
1151
        return self._control_files.is_locked()
 
 
1153
    def lock_read(self):
 
 
1154
        """See Branch.lock_read, and WorkingTree.unlock."""
 
 
1155
        self.branch.lock_read()
 
 
1157
            return self._control_files.lock_read()
 
 
1159
            self.branch.unlock()
 
 
1162
    def lock_write(self):
 
 
1163
        """See Branch.lock_write, and WorkingTree.unlock."""
 
 
1164
        self.branch.lock_write()
 
 
1166
            return self._control_files.lock_write()
 
 
1168
            self.branch.unlock()
 
 
1171
    def get_physical_lock_status(self):
 
 
1172
        return self._control_files.get_physical_lock_status()
 
 
1174
    def _basis_inventory_name(self):
 
 
1175
        return 'basis-inventory'
 
 
1178
    def set_last_revision(self, new_revision):
 
 
1179
        """Change the last revision in the working tree."""
 
 
1180
        if self._change_last_revision(new_revision):
 
 
1181
            self._cache_basis_inventory(new_revision)
 
 
1183
    def _change_last_revision(self, new_revision):
 
 
1184
        """Template method part of set_last_revision to perform the change.
 
 
1186
        This is used to allow WorkingTree3 instances to not affect branch
 
 
1187
        when their last revision is set.
 
 
1189
        if new_revision is None:
 
 
1190
            self.branch.set_revision_history([])
 
 
1192
        # current format is locked in with the branch
 
 
1193
        revision_history = self.branch.revision_history()
 
 
1195
            position = revision_history.index(new_revision)
 
 
1197
            raise errors.NoSuchRevision(self.branch, new_revision)
 
 
1198
        self.branch.set_revision_history(revision_history[:position + 1])
 
 
1201
    def _cache_basis_inventory(self, new_revision):
 
 
1202
        """Cache new_revision as the basis inventory."""
 
 
1203
        # TODO: this should allow the ready-to-use inventory to be passed in,
 
 
1204
        # as commit already has that ready-to-use [while the format is the
 
 
1207
            # this double handles the inventory - unpack and repack - 
 
 
1208
            # but is easier to understand. We can/should put a conditional
 
 
1209
            # in here based on whether the inventory is in the latest format
 
 
1210
            # - perhaps we should repack all inventories on a repository
 
 
1212
            # the fast path is to copy the raw xml from the repository. If the
 
 
1213
            # xml contains 'revision_id="', then we assume the right 
 
 
1214
            # revision_id is set. We must check for this full string, because a
 
 
1215
            # root node id can legitimately look like 'revision_id' but cannot
 
 
1217
            xml = self.branch.repository.get_inventory_xml(new_revision)
 
 
1218
            if not 'revision_id="' in xml.split('\n', 1)[0]:
 
 
1219
                inv = self.branch.repository.deserialise_inventory(
 
 
1221
                inv.revision_id = new_revision
 
 
1222
                xml = bzrlib.xml5.serializer_v5.write_inventory_to_string(inv)
 
 
1223
            assert isinstance(xml, str), 'serialised xml must be bytestring.'
 
 
1224
            path = self._basis_inventory_name()
 
 
1226
            self._control_files.put(path, sio)
 
 
1227
        except WeaveRevisionNotPresent:
 
 
1230
    def read_basis_inventory(self):
 
 
1231
        """Read the cached basis inventory."""
 
 
1232
        path = self._basis_inventory_name()
 
 
1233
        return self._control_files.get(path).read()
 
 
1236
    def read_working_inventory(self):
 
 
1237
        """Read the working inventory."""
 
 
1238
        # ElementTree does its own conversion from UTF-8, so open in
 
 
1240
        result = bzrlib.xml5.serializer_v5.read_inventory(
 
 
1241
            self._control_files.get('inventory'))
 
 
1242
        self._set_inventory(result)
 
 
1246
    def remove(self, files, verbose=False, to_file=None):
 
 
1247
        """Remove nominated files from the working inventory..
 
 
1249
        This does not remove their text.  This does not run on XXX on what? RBC
 
 
1251
        TODO: Refuse to remove modified files unless --force is given?
 
 
1253
        TODO: Do something useful with directories.
 
 
1255
        TODO: Should this remove the text or not?  Tough call; not
 
 
1256
        removing may be useful and the user can just use use rm, and
 
 
1257
        is the opposite of add.  Removing it is consistent with most
 
 
1258
        other tools.  Maybe an option.
 
 
1260
        ## TODO: Normalize names
 
 
1261
        ## TODO: Remove nested loops; better scalability
 
 
1262
        if isinstance(files, basestring):
 
 
1265
        inv = self.inventory
 
 
1267
        # do this before any modifications
 
 
1269
            fid = inv.path2id(f)
 
 
1271
                # TODO: Perhaps make this just a warning, and continue?
 
 
1272
                # This tends to happen when 
 
 
1273
                raise NotVersionedError(path=f)
 
 
1274
            mutter("remove inventory entry %s {%s}", quotefn(f), fid)
 
 
1276
                # having remove it, it must be either ignored or unknown
 
 
1277
                if self.is_ignored(f):
 
 
1281
                show_status(new_status, inv[fid].kind, quotefn(f), to_file=to_file)
 
 
1284
        self._write_inventory(inv)
 
 
1287
    def revert(self, filenames, old_tree=None, backups=True, 
 
 
1288
               pb=DummyProgress()):
 
 
1289
        from transform import revert
 
 
1290
        from conflicts import resolve
 
 
1291
        if old_tree is None:
 
 
1292
            old_tree = self.basis_tree()
 
 
1293
        conflicts = revert(self, old_tree, filenames, backups, pb)
 
 
1294
        if not len(filenames):
 
 
1295
            self.set_pending_merges([])
 
 
1298
            resolve(self, filenames, ignore_misses=True)
 
 
1301
    # XXX: This method should be deprecated in favour of taking in a proper
 
 
1302
    # new Inventory object.
 
 
1304
    def set_inventory(self, new_inventory_list):
 
 
1305
        from bzrlib.inventory import (Inventory,
 
 
1310
        inv = Inventory(self.get_root_id())
 
 
1311
        for path, file_id, parent, kind in new_inventory_list:
 
 
1312
            name = os.path.basename(path)
 
 
1315
            # fixme, there should be a factory function inv,add_?? 
 
 
1316
            if kind == 'directory':
 
 
1317
                inv.add(InventoryDirectory(file_id, name, parent))
 
 
1318
            elif kind == 'file':
 
 
1319
                inv.add(InventoryFile(file_id, name, parent))
 
 
1320
            elif kind == 'symlink':
 
 
1321
                inv.add(InventoryLink(file_id, name, parent))
 
 
1323
                raise BzrError("unknown kind %r" % kind)
 
 
1324
        self._write_inventory(inv)
 
 
1327
    def set_root_id(self, file_id):
 
 
1328
        """Set the root id for this tree."""
 
 
1329
        inv = self.read_working_inventory()
 
 
1330
        orig_root_id = inv.root.file_id
 
 
1331
        del inv._byid[inv.root.file_id]
 
 
1332
        inv.root.file_id = file_id
 
 
1333
        inv._byid[inv.root.file_id] = inv.root
 
 
1336
            if entry.parent_id == orig_root_id:
 
 
1337
                entry.parent_id = inv.root.file_id
 
 
1338
        self._write_inventory(inv)
 
 
1341
        """See Branch.unlock.
 
 
1343
        WorkingTree locking just uses the Branch locking facilities.
 
 
1344
        This is current because all working trees have an embedded branch
 
 
1345
        within them. IF in the future, we were to make branch data shareable
 
 
1346
        between multiple working trees, i.e. via shared storage, then we 
 
 
1347
        would probably want to lock both the local tree, and the branch.
 
 
1349
        # FIXME: We want to write out the hashcache only when the last lock on
 
 
1350
        # this working copy is released.  Peeking at the lock count is a bit
 
 
1351
        # of a nasty hack; probably it's better to have a transaction object,
 
 
1352
        # which can do some finalization when it's either successfully or
 
 
1353
        # unsuccessfully completed.  (Denys's original patch did that.)
 
 
1354
        # RBC 20060206 hooking into transaction will couple lock and transaction
 
 
1355
        # wrongly. Hooking into unlock on the control files object is fine though.
 
 
1357
        # TODO: split this per format so there is no ugly if block
 
 
1358
        if self._hashcache.needs_write and (
 
 
1359
            # dedicated lock files
 
 
1360
            self._control_files._lock_count==1 or 
 
 
1362
            (self._control_files is self.branch.control_files and 
 
 
1363
             self._control_files._lock_count==3)):
 
 
1364
            self._hashcache.write()
 
 
1365
        # reverse order of locking.
 
 
1367
            return self._control_files.unlock()
 
 
1369
            self.branch.unlock()
 
 
1373
        """Update a working tree along its branch.
 
 
1375
        This will update the branch if its bound too, which means we have multiple trees involved:
 
 
1376
        The new basis tree of the master.
 
 
1377
        The old basis tree of the branch.
 
 
1378
        The old basis tree of the working tree.
 
 
1379
        The current working tree state.
 
 
1380
        pathologically all three may be different, and non ancestors of each other.
 
 
1381
        Conceptually we want to:
 
 
1382
        Preserve the wt.basis->wt.state changes
 
 
1383
        Transform the wt.basis to the new master basis.
 
 
1384
        Apply a merge of the old branch basis to get any 'local' changes from it into the tree.
 
 
1385
        Restore the wt.basis->wt.state changes.
 
 
1387
        There isn't a single operation at the moment to do that, so we:
 
 
1388
        Merge current state -> basis tree of the master w.r.t. the old tree basis.
 
 
1389
        Do a 'normal' merge of the old branch basis if it is relevant.
 
 
1391
        old_tip = self.branch.update()
 
 
1392
        if old_tip is not None:
 
 
1393
            self.add_pending_merge(old_tip)
 
 
1394
        self.branch.lock_read()
 
 
1397
            if self.last_revision() != self.branch.last_revision():
 
 
1398
                # merge tree state up to new branch tip.
 
 
1399
                basis = self.basis_tree()
 
 
1400
                to_tree = self.branch.basis_tree()
 
 
1401
                result += merge_inner(self.branch,
 
 
1405
                self.set_last_revision(self.branch.last_revision())
 
 
1406
            if old_tip and old_tip != self.last_revision():
 
 
1407
                # our last revision was not the prior branch last revision
 
 
1408
                # and we have converted that last revision to a pending merge.
 
 
1409
                # base is somewhere between the branch tip now
 
 
1410
                # and the now pending merge
 
 
1411
                from bzrlib.revision import common_ancestor
 
 
1413
                    base_rev_id = common_ancestor(self.branch.last_revision(),
 
 
1415
                                                  self.branch.repository)
 
 
1416
                except errors.NoCommonAncestor:
 
 
1418
                base_tree = self.branch.repository.revision_tree(base_rev_id)
 
 
1419
                other_tree = self.branch.repository.revision_tree(old_tip)
 
 
1420
                result += merge_inner(self.branch,
 
 
1426
            self.branch.unlock()
 
 
1429
    def _write_inventory(self, inv):
 
 
1430
        """Write inventory as the current inventory."""
 
 
1432
        bzrlib.xml5.serializer_v5.write_inventory(inv, sio)
 
 
1434
        self._control_files.put('inventory', sio)
 
 
1435
        self._set_inventory(inv)
 
 
1436
        mutter('wrote working inventory')
 
 
1438
    def set_conflicts(self, arg):
 
 
1439
        raise UnsupportedOperation(self.set_conflicts, self)
 
 
1442
    def conflicts(self):
 
 
1443
        conflicts = ConflictList()
 
 
1444
        for conflicted in self._iter_conflicts():
 
 
1447
                if file_kind(self.abspath(conflicted)) != "file":
 
 
1449
            except errors.NoSuchFile:
 
 
1452
                for suffix in ('.THIS', '.OTHER'):
 
 
1454
                        kind = file_kind(self.abspath(conflicted+suffix))
 
 
1457
                    except errors.NoSuchFile:
 
 
1461
            ctype = {True: 'text conflict', False: 'contents conflict'}[text]
 
 
1462
            conflicts.append(Conflict.factory(ctype, path=conflicted,
 
 
1463
                             file_id=self.path2id(conflicted)))
 
 
1467
class WorkingTree3(WorkingTree):
 
 
1468
    """This is the Format 3 working tree.
 
 
1470
    This differs from the base WorkingTree by:
 
 
1471
     - having its own file lock
 
 
1472
     - having its own last-revision property.
 
 
1474
    This is new in bzr 0.8
 
 
1478
    def last_revision(self):
 
 
1479
        """See WorkingTree.last_revision."""
 
 
1481
            return self._control_files.get_utf8('last-revision').read()
 
 
1485
    def _change_last_revision(self, revision_id):
 
 
1486
        """See WorkingTree._change_last_revision."""
 
 
1487
        if revision_id is None or revision_id == NULL_REVISION:
 
 
1489
                self._control_files._transport.delete('last-revision')
 
 
1490
            except errors.NoSuchFile:
 
 
1495
                self.branch.revision_history().index(revision_id)
 
 
1497
                raise errors.NoSuchRevision(self.branch, revision_id)
 
 
1498
            self._control_files.put_utf8('last-revision', revision_id)
 
 
1502
    def set_conflicts(self, conflicts):
 
 
1503
        self._put_rio('conflicts', conflicts.to_stanzas(), 
 
 
1507
    def conflicts(self):
 
 
1509
            confile = self._control_files.get('conflicts')
 
 
1511
            return ConflictList()
 
 
1513
            if confile.next() != CONFLICT_HEADER_1 + '\n':
 
 
1514
                raise ConflictFormatError()
 
 
1515
        except StopIteration:
 
 
1516
            raise ConflictFormatError()
 
 
1517
        return ConflictList.from_stanzas(RioReader(confile))
 
 
1520
def get_conflicted_stem(path):
 
 
1521
    for suffix in CONFLICT_SUFFIXES:
 
 
1522
        if path.endswith(suffix):
 
 
1523
            return path[:-len(suffix)]
 
 
1525
@deprecated_function(zero_eight)
 
 
1526
def is_control_file(filename):
 
 
1527
    """See WorkingTree.is_control_filename(filename)."""
 
 
1528
    ## FIXME: better check
 
 
1529
    filename = normpath(filename)
 
 
1530
    while filename != '':
 
 
1531
        head, tail = os.path.split(filename)
 
 
1532
        ## mutter('check %r for control file' % ((head, tail),))
 
 
1535
        if filename == head:
 
 
1541
class WorkingTreeFormat(object):
 
 
1542
    """An encapsulation of the initialization and open routines for a format.
 
 
1544
    Formats provide three things:
 
 
1545
     * An initialization routine,
 
 
1549
    Formats are placed in an dict by their format string for reference 
 
 
1550
    during workingtree opening. Its not required that these be instances, they
 
 
1551
    can be classes themselves with class methods - it simply depends on 
 
 
1552
    whether state is needed for a given format or not.
 
 
1554
    Once a format is deprecated, just deprecate the initialize and open
 
 
1555
    methods on the format class. Do not deprecate the object, as the 
 
 
1556
    object will be created every time regardless.
 
 
1559
    _default_format = None
 
 
1560
    """The default format used for new trees."""
 
 
1563
    """The known formats."""
 
 
1566
    def find_format(klass, a_bzrdir):
 
 
1567
        """Return the format for the working tree object in a_bzrdir."""
 
 
1569
            transport = a_bzrdir.get_workingtree_transport(None)
 
 
1570
            format_string = transport.get("format").read()
 
 
1571
            return klass._formats[format_string]
 
 
1573
            raise errors.NoWorkingTree(base=transport.base)
 
 
1575
            raise errors.UnknownFormatError(format_string)
 
 
1578
    def get_default_format(klass):
 
 
1579
        """Return the current default format."""
 
 
1580
        return klass._default_format
 
 
1582
    def get_format_string(self):
 
 
1583
        """Return the ASCII format string that identifies this format."""
 
 
1584
        raise NotImplementedError(self.get_format_string)
 
 
1586
    def get_format_description(self):
 
 
1587
        """Return the short description for this format."""
 
 
1588
        raise NotImplementedError(self.get_format_description)
 
 
1590
    def is_supported(self):
 
 
1591
        """Is this format supported?
 
 
1593
        Supported formats can be initialized and opened.
 
 
1594
        Unsupported formats may not support initialization or committing or 
 
 
1595
        some other features depending on the reason for not being supported.
 
 
1600
    def register_format(klass, format):
 
 
1601
        klass._formats[format.get_format_string()] = format
 
 
1604
    def set_default_format(klass, format):
 
 
1605
        klass._default_format = format
 
 
1608
    def unregister_format(klass, format):
 
 
1609
        assert klass._formats[format.get_format_string()] is format
 
 
1610
        del klass._formats[format.get_format_string()]
 
 
1614
class WorkingTreeFormat2(WorkingTreeFormat):
 
 
1615
    """The second working tree format. 
 
 
1617
    This format modified the hash cache from the format 1 hash cache.
 
 
1620
    def get_format_description(self):
 
 
1621
        """See WorkingTreeFormat.get_format_description()."""
 
 
1622
        return "Working tree format 2"
 
 
1624
    def stub_initialize_remote(self, control_files):
 
 
1625
        """As a special workaround create critical control files for a remote working tree
 
 
1627
        This ensures that it can later be updated and dealt with locally,
 
 
1628
        since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with 
 
 
1629
        no working tree.  (See bug #43064).
 
 
1633
        bzrlib.xml5.serializer_v5.write_inventory(inv, sio)
 
 
1635
        control_files.put('inventory', sio)
 
 
1637
        control_files.put_utf8('pending-merges', '')
 
 
1640
    def initialize(self, a_bzrdir, revision_id=None):
 
 
1641
        """See WorkingTreeFormat.initialize()."""
 
 
1642
        if not isinstance(a_bzrdir.transport, LocalTransport):
 
 
1643
            raise errors.NotLocalUrl(a_bzrdir.transport.base)
 
 
1644
        branch = a_bzrdir.open_branch()
 
 
1645
        if revision_id is not None:
 
 
1648
                revision_history = branch.revision_history()
 
 
1650
                    position = revision_history.index(revision_id)
 
 
1652
                    raise errors.NoSuchRevision(branch, revision_id)
 
 
1653
                branch.set_revision_history(revision_history[:position + 1])
 
 
1656
        revision = branch.last_revision()
 
 
1658
        wt = WorkingTree(a_bzrdir.root_transport.local_abspath('.'),
 
 
1664
        wt._write_inventory(inv)
 
 
1665
        wt.set_root_id(inv.root.file_id)
 
 
1666
        wt.set_last_revision(revision)
 
 
1667
        wt.set_pending_merges([])
 
 
1668
        build_tree(wt.basis_tree(), wt)
 
 
1672
        super(WorkingTreeFormat2, self).__init__()
 
 
1673
        self._matchingbzrdir = bzrdir.BzrDirFormat6()
 
 
1675
    def open(self, a_bzrdir, _found=False):
 
 
1676
        """Return the WorkingTree object for a_bzrdir
 
 
1678
        _found is a private parameter, do not use it. It is used to indicate
 
 
1679
               if format probing has already been done.
 
 
1682
            # we are being called directly and must probe.
 
 
1683
            raise NotImplementedError
 
 
1684
        if not isinstance(a_bzrdir.transport, LocalTransport):
 
 
1685
            raise errors.NotLocalUrl(a_bzrdir.transport.base)
 
 
1686
        return WorkingTree(a_bzrdir.root_transport.local_abspath('.'),
 
 
1692
class WorkingTreeFormat3(WorkingTreeFormat):
 
 
1693
    """The second working tree format updated to record a format marker.
 
 
1696
        - exists within a metadir controlling .bzr
 
 
1697
        - includes an explicit version marker for the workingtree control
 
 
1698
          files, separate from the BzrDir format
 
 
1699
        - modifies the hash cache format
 
 
1701
        - uses a LockDir to guard access to the repository
 
 
1704
    def get_format_string(self):
 
 
1705
        """See WorkingTreeFormat.get_format_string()."""
 
 
1706
        return "Bazaar-NG Working Tree format 3"
 
 
1708
    def get_format_description(self):
 
 
1709
        """See WorkingTreeFormat.get_format_description()."""
 
 
1710
        return "Working tree format 3"
 
 
1712
    _lock_file_name = 'lock'
 
 
1713
    _lock_class = LockDir
 
 
1715
    def _open_control_files(self, a_bzrdir):
 
 
1716
        transport = a_bzrdir.get_workingtree_transport(None)
 
 
1717
        return LockableFiles(transport, self._lock_file_name, 
 
 
1720
    def initialize(self, a_bzrdir, revision_id=None):
 
 
1721
        """See WorkingTreeFormat.initialize().
 
 
1723
        revision_id allows creating a working tree at a different
 
 
1724
        revision than the branch is at.
 
 
1726
        if not isinstance(a_bzrdir.transport, LocalTransport):
 
 
1727
            raise errors.NotLocalUrl(a_bzrdir.transport.base)
 
 
1728
        transport = a_bzrdir.get_workingtree_transport(self)
 
 
1729
        control_files = self._open_control_files(a_bzrdir)
 
 
1730
        control_files.create_lock()
 
 
1731
        control_files.lock_write()
 
 
1732
        control_files.put_utf8('format', self.get_format_string())
 
 
1733
        branch = a_bzrdir.open_branch()
 
 
1734
        if revision_id is None:
 
 
1735
            revision_id = branch.last_revision()
 
 
1737
        wt = WorkingTree3(a_bzrdir.root_transport.local_abspath('.'),
 
 
1743
                         _control_files=control_files)
 
 
1746
            wt._write_inventory(inv)
 
 
1747
            wt.set_root_id(inv.root.file_id)
 
 
1748
            wt.set_last_revision(revision_id)
 
 
1749
            wt.set_pending_merges([])
 
 
1750
            build_tree(wt.basis_tree(), wt)
 
 
1753
            control_files.unlock()
 
 
1757
        super(WorkingTreeFormat3, self).__init__()
 
 
1758
        self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
 
 
1760
    def open(self, a_bzrdir, _found=False):
 
 
1761
        """Return the WorkingTree object for a_bzrdir
 
 
1763
        _found is a private parameter, do not use it. It is used to indicate
 
 
1764
               if format probing has already been done.
 
 
1767
            # we are being called directly and must probe.
 
 
1768
            raise NotImplementedError
 
 
1769
        if not isinstance(a_bzrdir.transport, LocalTransport):
 
 
1770
            raise errors.NotLocalUrl(a_bzrdir.transport.base)
 
 
1771
        control_files = self._open_control_files(a_bzrdir)
 
 
1772
        return WorkingTree3(a_bzrdir.root_transport.local_abspath('.'),
 
 
1776
                           _control_files=control_files)
 
 
1779
        return self.get_format_string()
 
 
1782
# formats which have no format string are not discoverable
 
 
1783
# and not independently creatable, so are not registered.
 
 
1784
__default_format = WorkingTreeFormat3()
 
 
1785
WorkingTreeFormat.register_format(__default_format)
 
 
1786
WorkingTreeFormat.set_default_format(__default_format)
 
 
1787
_legacy_formats = [WorkingTreeFormat2(),
 
 
1791
class WorkingTreeTestProviderAdapter(object):
 
 
1792
    """A tool to generate a suite testing multiple workingtree formats at once.
 
 
1794
    This is done by copying the test once for each transport and injecting
 
 
1795
    the transport_server, transport_readonly_server, and workingtree_format
 
 
1796
    classes into each copy. Each copy is also given a new id() to make it
 
 
1800
    def __init__(self, transport_server, transport_readonly_server, formats):
 
 
1801
        self._transport_server = transport_server
 
 
1802
        self._transport_readonly_server = transport_readonly_server
 
 
1803
        self._formats = formats
 
 
1805
    def adapt(self, test):
 
 
1806
        from bzrlib.tests import TestSuite
 
 
1807
        result = TestSuite()
 
 
1808
        for workingtree_format, bzrdir_format in self._formats:
 
 
1809
            new_test = deepcopy(test)
 
 
1810
            new_test.transport_server = self._transport_server
 
 
1811
            new_test.transport_readonly_server = self._transport_readonly_server
 
 
1812
            new_test.bzrdir_format = bzrdir_format
 
 
1813
            new_test.workingtree_format = workingtree_format
 
 
1814
            def make_new_test_id():
 
 
1815
                new_id = "%s(%s)" % (new_test.id(), workingtree_format.__class__.__name__)
 
 
1816
                return lambda: new_id
 
 
1817
            new_test.id = make_new_test_id()
 
 
1818
            result.addTest(new_test)