~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/workingtree.py

Late bind to PatienceSequenceMatcher to allow plugin to override.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005, 2006, 2007 Canonical Ltd
2
 
#
 
1
# Copyright (C) 2005, 2006 Canonical Ltd
 
2
 
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
5
5
# the Free Software Foundation; either version 2 of the License, or
6
6
# (at your option) any later version.
7
 
#
 
7
 
8
8
# This program is distributed in the hope that it will be useful,
9
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11
11
# GNU General Public License for more details.
12
 
#
 
12
 
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
29
29
WorkingTree.open(dir).
30
30
"""
31
31
 
 
32
MERGE_MODIFIED_HEADER_1 = "BZR merge-modified list format 1"
 
33
CONFLICT_HEADER_1 = "BZR conflict list format 1"
 
34
 
32
35
# TODO: Give the workingtree sole responsibility for the working inventory;
33
36
# remove the variable and references to it from the branch.  This may require
34
37
# updating the commit code so as to update the inventory within the working
36
39
# At the moment they may alias the inventory and have old copies of it in
37
40
# memory.  (Now done? -- mbp 20060309)
38
41
 
 
42
from binascii import hexlify
 
43
from copy import deepcopy
39
44
from cStringIO import StringIO
 
45
import errno
 
46
import fnmatch
40
47
import os
41
 
import sys
42
 
 
43
 
from bzrlib.lazy_import import lazy_import
44
 
lazy_import(globals(), """
45
 
from bisect import bisect_left
46
 
import collections
47
 
import errno
48
 
import itertools
49
 
import operator
 
48
import re
50
49
import stat
51
50
from time import time
52
 
import warnings
53
 
import re
54
 
 
55
 
import bzrlib
56
 
from bzrlib import (
57
 
    branch,
58
 
    bzrdir,
59
 
    conflicts as _mod_conflicts,
60
 
    dirstate,
61
 
    errors,
62
 
    generate_ids,
63
 
    globbing,
64
 
    hashcache,
65
 
    ignores,
66
 
    merge,
67
 
    revision as _mod_revision,
68
 
    revisiontree,
69
 
    repository,
70
 
    textui,
71
 
    trace,
72
 
    transform,
73
 
    ui,
74
 
    urlutils,
75
 
    xml5,
76
 
    xml6,
77
 
    xml7,
78
 
    )
79
 
import bzrlib.branch
80
 
from bzrlib.transport import get_transport
81
 
import bzrlib.ui
82
 
from bzrlib.workingtree_4 import WorkingTreeFormat4
83
 
""")
84
 
 
85
 
from bzrlib import symbol_versioning
 
51
 
 
52
from bzrlib.atomicfile import AtomicFile
 
53
from bzrlib.branch import (Branch,
 
54
                           quotefn)
 
55
from bzrlib.conflicts import Conflict, ConflictList, CONFLICT_SUFFIXES
 
56
import bzrlib.bzrdir as bzrdir
86
57
from bzrlib.decorators import needs_read_lock, needs_write_lock
87
 
from bzrlib.inventory import InventoryEntry, Inventory, ROOT_ID, TreeReference
 
58
import bzrlib.errors as errors
 
59
from bzrlib.errors import (BzrCheckError,
 
60
                           BzrError,
 
61
                           ConflictFormatError,
 
62
                           DivergedBranches,
 
63
                           WeaveRevisionNotPresent,
 
64
                           NotBranchError,
 
65
                           NoSuchFile,
 
66
                           NotVersionedError,
 
67
                           MergeModifiedFormatError,
 
68
                           UnsupportedOperation,
 
69
                           )
 
70
from bzrlib.inventory import InventoryEntry, Inventory
88
71
from bzrlib.lockable_files import LockableFiles, TransportLock
89
72
from bzrlib.lockdir import LockDir
90
 
import bzrlib.mutabletree
91
 
from bzrlib.mutabletree import needs_tree_write_lock
92
 
from bzrlib import osutils
 
73
from bzrlib.merge import merge_inner, transform_tree
93
74
from bzrlib.osutils import (
94
 
    compact_date,
95
 
    file_kind,
96
 
    isdir,
97
 
    normpath,
98
 
    pathjoin,
99
 
    rand_chars,
100
 
    realpath,
101
 
    safe_unicode,
102
 
    splitpath,
103
 
    supports_executable,
104
 
    )
 
75
                            abspath,
 
76
                            appendpath,
 
77
                            compact_date,
 
78
                            file_kind,
 
79
                            isdir,
 
80
                            getcwd,
 
81
                            pathjoin,
 
82
                            pumpfile,
 
83
                            safe_unicode,
 
84
                            splitpath,
 
85
                            rand_chars,
 
86
                            normpath,
 
87
                            realpath,
 
88
                            relpath,
 
89
                            rename,
 
90
                            supports_executable,
 
91
                            )
 
92
from bzrlib.progress import DummyProgress, ProgressPhase
 
93
from bzrlib.revision import NULL_REVISION
 
94
from bzrlib.rio import RioReader, rio_file, Stanza
 
95
from bzrlib.symbol_versioning import *
 
96
from bzrlib.textui import show_status
 
97
import bzrlib.tree
 
98
from bzrlib.transform import build_tree
105
99
from bzrlib.trace import mutter, note
 
100
from bzrlib.transport import get_transport
106
101
from bzrlib.transport.local import LocalTransport
107
 
from bzrlib.progress import DummyProgress, ProgressPhase
108
 
from bzrlib.revision import NULL_REVISION, CURRENT_REVISION
109
 
from bzrlib.rio import RioReader, rio_file, Stanza
110
 
from bzrlib.symbol_versioning import (deprecated_passed,
111
 
        deprecated_method,
112
 
        deprecated_function,
113
 
        DEPRECATED_PARAMETER,
114
 
        )
115
 
 
116
 
 
117
 
MERGE_MODIFIED_HEADER_1 = "BZR merge-modified list format 1"
118
 
CONFLICT_HEADER_1 = "BZR conflict list format 1"
119
 
 
120
 
ERROR_PATH_NOT_FOUND = 3    # WindowsError errno code, equivalent to ENOENT
 
102
import bzrlib.ui
 
103
import bzrlib.xml5
 
104
 
 
105
 
 
106
# the regex here does the following:
 
107
# 1) remove any weird characters; we don't escape them but rather
 
108
# just pull them out
 
109
 # 2) match leading '.'s to make it not hidden
 
110
_gen_file_id_re = re.compile(r'[^\w.]|(^\.*)')
 
111
_gen_id_suffix = None
 
112
_gen_id_serial = 0
 
113
 
 
114
 
 
115
def _next_id_suffix():
 
116
    """Create a new file id suffix that is reasonably unique.
 
117
    
 
118
    On the first call we combine the current time with 64 bits of randomness
 
119
    to give a highly probably globally unique number. Then each call in the same
 
120
    process adds 1 to a serial number we append to that unique value.
 
121
    """
 
122
    # XXX TODO: change bzrlib.add.smart_add to call workingtree.add() rather 
 
123
    # than having to move the id randomness out of the inner loop like this.
 
124
    # XXX TODO: for the global randomness this uses we should add the thread-id
 
125
    # before the serial #.
 
126
    global _gen_id_suffix, _gen_id_serial
 
127
    if _gen_id_suffix is None:
 
128
        _gen_id_suffix = "-%s-%s-" % (compact_date(time()), rand_chars(16))
 
129
    _gen_id_serial += 1
 
130
    return _gen_id_suffix + str(_gen_id_serial)
 
131
 
 
132
 
 
133
def gen_file_id(name):
 
134
    """Return new file id for the basename 'name'.
 
135
 
 
136
    The uniqueness is supplied from _next_id_suffix.
 
137
    """
 
138
    # XXX TODO: squash the filename to lowercase.
 
139
    # XXX TODO: truncate the filename to something like 20 or 30 chars.
 
140
    # XXX TODO: consider what to do with ids that look like illegal filepaths
 
141
    # on platforms we support.
 
142
    return _gen_file_id_re.sub('', name) + _next_id_suffix()
 
143
 
 
144
 
 
145
def gen_root_id():
 
146
    """Return a new tree-root file id."""
 
147
    return gen_file_id('TREE_ROOT')
121
148
 
122
149
 
123
150
class TreeEntry(object):
124
 
    """An entry that implements the minimum interface used by commands.
 
151
    """An entry that implements the minium interface used by commands.
125
152
 
126
153
    This needs further inspection, it may be better to have 
127
154
    InventoryEntries without ids - though that seems wrong. For now,
175
202
        return ''
176
203
 
177
204
 
178
 
class WorkingTree(bzrlib.mutabletree.MutableTree):
 
205
class WorkingTree(bzrlib.tree.Tree):
179
206
    """Working copy tree.
180
207
 
181
208
    The inventory is held in the `Branch` working-inventory, and the
192
219
                 _internal=False,
193
220
                 _format=None,
194
221
                 _bzrdir=None):
195
 
        """Construct a WorkingTree instance. This is not a public API.
 
222
        """Construct a WorkingTree for basedir.
196
223
 
197
 
        :param branch: A branch to override probing for the branch.
 
224
        If the branch is not supplied, it is opened automatically.
 
225
        If the branch is supplied, it must be the branch for this basedir.
 
226
        (branch.base is not cross checked, because for remote branches that
 
227
        would be meaningless).
198
228
        """
199
229
        self._format = _format
200
230
        self.bzrdir = _bzrdir
201
231
        if not _internal:
202
 
            raise errors.BzrError("Please use bzrdir.open_workingtree or "
203
 
                "WorkingTree.open() to obtain a WorkingTree.")
 
232
            # not created via open etc.
 
233
            warn("WorkingTree() is deprecated as of bzr version 0.8. "
 
234
                 "Please use bzrdir.open_workingtree or WorkingTree.open().",
 
235
                 DeprecationWarning,
 
236
                 stacklevel=2)
 
237
            wt = WorkingTree.open(basedir)
 
238
            self._branch = wt.branch
 
239
            self.basedir = wt.basedir
 
240
            self._control_files = wt._control_files
 
241
            self._hashcache = wt._hashcache
 
242
            self._set_inventory(wt._inventory)
 
243
            self._format = wt._format
 
244
            self.bzrdir = wt.bzrdir
 
245
        from bzrlib.hashcache import HashCache
 
246
        from bzrlib.trace import note, mutter
 
247
        assert isinstance(basedir, basestring), \
 
248
            "base directory %r is not a string" % basedir
204
249
        basedir = safe_unicode(basedir)
205
250
        mutter("opening working tree %r", basedir)
206
251
        if deprecated_passed(branch):
 
252
            if not _internal:
 
253
                warn("WorkingTree(..., branch=XXX) is deprecated as of bzr 0.8."
 
254
                     " Please use bzrdir.open_workingtree() or"
 
255
                     " WorkingTree.open().",
 
256
                     DeprecationWarning,
 
257
                     stacklevel=2
 
258
                     )
207
259
            self._branch = branch
208
260
        else:
209
261
            self._branch = self.bzrdir.open_branch()
 
262
        assert isinstance(self.branch, Branch), \
 
263
            "branch %r is not a Branch" % self.branch
210
264
        self.basedir = realpath(basedir)
211
265
        # if branch is at our basedir and is a format 6 or less
212
266
        if isinstance(self._format, WorkingTreeFormat2):
213
267
            # share control object
214
268
            self._control_files = self.branch.control_files
215
269
        else:
216
 
            # assume all other formats have their own control files.
 
270
            # only ready for format 3
 
271
            assert isinstance(self._format, WorkingTreeFormat3)
 
272
            assert isinstance(_control_files, LockableFiles), \
 
273
                    "_control_files must be a LockableFiles, not %r" \
 
274
                    % _control_files
217
275
            self._control_files = _control_files
218
 
        self._transport = self._control_files._transport
219
276
        # update the whole cache up front and write to disk if anything changed;
220
277
        # in the future we might want to do this more selectively
221
278
        # two possible ways offer themselves : in self._unlock, write the cache
222
279
        # if needed, or, when the cache sees a change, append it to the hash
223
280
        # cache file, and have the parser take the most recent entry for a
224
281
        # given path only.
225
 
        wt_trans = self.bzrdir.get_workingtree_transport(None)
226
 
        cache_filename = wt_trans.local_abspath('stat-cache')
227
 
        self._hashcache = hashcache.HashCache(basedir, cache_filename,
228
 
            self.bzrdir._get_file_mode())
229
 
        hc = self._hashcache
 
282
        cache_filename = self.bzrdir.get_workingtree_transport(None).abspath('stat-cache')
 
283
        hc = self._hashcache = HashCache(basedir, cache_filename, self._control_files._file_mode)
230
284
        hc.read()
231
285
        # is this scan needed ? it makes things kinda slow.
232
 
        #hc.scan()
 
286
        hc.scan()
233
287
 
234
288
        if hc.needs_write:
235
289
            mutter("write hc")
236
290
            hc.write()
237
291
 
238
292
        if _inventory is None:
239
 
            # This will be acquired on lock_read() or lock_write()
240
 
            self._inventory_is_modified = False
241
 
            self._inventory = None
242
 
        else:
243
 
            # the caller of __init__ has provided an inventory,
244
 
            # we assume they know what they are doing - as its only
245
 
            # the Format factory and creation methods that are
246
 
            # permitted to do this.
247
 
            self._set_inventory(_inventory, dirty=False)
248
 
        self._detect_case_handling()
249
 
        self._rules_searcher = None
250
 
 
251
 
    def _detect_case_handling(self):
252
 
        wt_trans = self.bzrdir.get_workingtree_transport(None)
253
 
        try:
254
 
            wt_trans.stat("FoRMaT")
255
 
        except errors.NoSuchFile:
256
 
            self.case_sensitive = True
257
 
        else:
258
 
            self.case_sensitive = False
259
 
 
260
 
        self._setup_directory_is_tree_reference()
 
293
            self._set_inventory(self.read_working_inventory())
 
294
        else:
 
295
            self._set_inventory(_inventory)
261
296
 
262
297
    branch = property(
263
298
        fget=lambda self: self._branch,
278
313
        self._control_files.break_lock()
279
314
        self.branch.break_lock()
280
315
 
281
 
    def requires_rich_root(self):
282
 
        return self._format.requires_rich_root
283
 
 
284
 
    def supports_tree_reference(self):
285
 
        return False
286
 
 
287
 
    def _set_inventory(self, inv, dirty):
288
 
        """Set the internal cached inventory.
289
 
 
290
 
        :param inv: The inventory to set.
291
 
        :param dirty: A boolean indicating whether the inventory is the same
292
 
            logical inventory as whats on disk. If True the inventory is not
293
 
            the same and should be written to disk or data will be lost, if
294
 
            False then the inventory is the same as that on disk and any
295
 
            serialisation would be unneeded overhead.
296
 
        """
 
316
    def _set_inventory(self, inv):
297
317
        self._inventory = inv
298
 
        self._inventory_is_modified = dirty
 
318
        self.path2id = self._inventory.path2id
 
319
 
 
320
    def is_control_filename(self, filename):
 
321
        """True if filename is the name of a control file in this tree.
 
322
        
 
323
        :param filename: A filename within the tree. This is a relative path
 
324
        from the root of this tree.
 
325
 
 
326
        This is true IF and ONLY IF the filename is part of the meta data
 
327
        that bzr controls in this tree. I.E. a random .bzr directory placed
 
328
        on disk will not be a control file for this tree.
 
329
        """
 
330
        return self.bzrdir.is_control_filename(filename)
299
331
 
300
332
    @staticmethod
301
333
    def open(path=None, _unsupported=False):
317
349
        run into /.  If there isn't one, raises NotBranchError.
318
350
        TODO: give this a new exception.
319
351
        If there is one, it is returned, along with the unused portion of path.
320
 
 
321
 
        :return: The WorkingTree that contains 'path', and the rest of path
322
352
        """
323
353
        if path is None:
324
 
            path = osutils.getcwd()
 
354
            path = os.getcwdu()
325
355
        control, relpath = bzrdir.BzrDir.open_containing(path)
326
 
 
327
356
        return control.open_workingtree(), relpath
328
357
 
329
358
    @staticmethod
334
363
        """
335
364
        return WorkingTree.open(path, _unsupported=True)
336
365
 
337
 
    @staticmethod
338
 
    def find_trees(location):
339
 
        def list_current(transport):
340
 
            return [d for d in transport.list_dir('') if d != '.bzr']
341
 
        def evaluate(bzrdir):
342
 
            try:
343
 
                tree = bzrdir.open_workingtree()
344
 
            except errors.NoWorkingTree:
345
 
                return True, None
346
 
            else:
347
 
                return True, tree
348
 
        transport = get_transport(location)
349
 
        iterator = bzrdir.BzrDir.find_bzrdirs(transport, evaluate=evaluate,
350
 
                                              list_current=list_current)
351
 
        return [t for t in iterator if t is not None]
352
 
 
353
 
    # should be deprecated - this is slow and in any case treating them as a
354
 
    # container is (we now know) bad style -- mbp 20070302
355
 
    ## @deprecated_method(zero_fifteen)
356
366
    def __iter__(self):
357
367
        """Iterate through file_ids for this tree.
358
368
 
361
371
        """
362
372
        inv = self._inventory
363
373
        for path, ie in inv.iter_entries():
364
 
            if osutils.lexists(self.abspath(path)):
 
374
            if bzrlib.osutils.lexists(self.abspath(path)):
365
375
                yield ie.file_id
366
376
 
367
 
    def all_file_ids(self):
368
 
        """See Tree.iter_all_file_ids"""
369
 
        return set(self.inventory)
370
 
 
371
377
    def __repr__(self):
372
378
        return "<%s of %s>" % (self.__class__.__name__,
373
379
                               getattr(self, 'basedir', None))
374
380
 
375
381
    def abspath(self, filename):
376
382
        return pathjoin(self.basedir, filename)
377
 
 
 
383
    
378
384
    def basis_tree(self):
379
 
        """Return RevisionTree for the current last revision.
380
 
        
381
 
        If the left most parent is a ghost then the returned tree will be an
382
 
        empty tree - one obtained by calling repository.revision_tree(None).
383
 
        """
384
 
        try:
385
 
            revision_id = self.get_parent_ids()[0]
386
 
        except IndexError:
387
 
            # no parents, return an empty revision tree.
388
 
            # in the future this should return the tree for
389
 
            # 'empty:' - the implicit root empty tree.
390
 
            return self.branch.repository.revision_tree(None)
391
 
        try:
392
 
            return self.revision_tree(revision_id)
393
 
        except errors.NoSuchRevision:
394
 
            pass
395
 
        # No cached copy available, retrieve from the repository.
396
 
        # FIXME? RBC 20060403 should we cache the inventory locally
397
 
        # at this point ?
398
 
        try:
399
 
            return self.branch.repository.revision_tree(revision_id)
400
 
        except (errors.RevisionNotPresent, errors.NoSuchRevision):
401
 
            # the basis tree *may* be a ghost or a low level error may have
402
 
            # occured. If the revision is present, its a problem, if its not
403
 
            # its a ghost.
404
 
            if self.branch.repository.has_revision(revision_id):
405
 
                raise
406
 
            # the basis tree is a ghost so return an empty tree.
407
 
            return self.branch.repository.revision_tree(None)
408
 
 
409
 
    def _cleanup(self):
410
 
        self._flush_ignore_list_cache()
 
385
        """Return RevisionTree for the current last revision."""
 
386
        revision_id = self.last_revision()
 
387
        if revision_id is not None:
 
388
            try:
 
389
                xml = self.read_basis_inventory()
 
390
                inv = bzrlib.xml5.serializer_v5.read_inventory_from_string(xml)
 
391
            except NoSuchFile:
 
392
                inv = None
 
393
            if inv is not None and inv.revision_id == revision_id:
 
394
                return bzrlib.tree.RevisionTree(self.branch.repository, inv,
 
395
                                                revision_id)
 
396
        # FIXME? RBC 20060403 should we cache the inventory here ?
 
397
        return self.branch.repository.revision_tree(revision_id)
 
398
 
 
399
    @staticmethod
 
400
    @deprecated_method(zero_eight)
 
401
    def create(branch, directory):
 
402
        """Create a workingtree for branch at directory.
 
403
 
 
404
        If existing_directory already exists it must have a .bzr directory.
 
405
        If it does not exist, it will be created.
 
406
 
 
407
        This returns a new WorkingTree object for the new checkout.
 
408
 
 
409
        TODO FIXME RBC 20060124 when we have checkout formats in place this
 
410
        should accept an optional revisionid to checkout [and reject this if
 
411
        checking out into the same dir as a pre-checkout-aware branch format.]
 
412
 
 
413
        XXX: When BzrDir is present, these should be created through that 
 
414
        interface instead.
 
415
        """
 
416
        warn('delete WorkingTree.create', stacklevel=3)
 
417
        transport = get_transport(directory)
 
418
        if branch.bzrdir.root_transport.base == transport.base:
 
419
            # same dir 
 
420
            return branch.bzrdir.create_workingtree()
 
421
        # different directory, 
 
422
        # create a branch reference
 
423
        # and now a working tree.
 
424
        raise NotImplementedError
 
425
 
 
426
    @staticmethod
 
427
    @deprecated_method(zero_eight)
 
428
    def create_standalone(directory):
 
429
        """Create a checkout and a branch and a repo at directory.
 
430
 
 
431
        Directory must exist and be empty.
 
432
 
 
433
        please use BzrDir.create_standalone_workingtree
 
434
        """
 
435
        return bzrdir.BzrDir.create_standalone_workingtree(directory)
411
436
 
412
437
    def relpath(self, path):
413
438
        """Return the local path portion from a given path.
415
440
        The path may be absolute or relative. If its a relative path it is 
416
441
        interpreted relative to the python current working directory.
417
442
        """
418
 
        return osutils.relpath(self.basedir, path)
 
443
        return relpath(self.basedir, path)
419
444
 
420
445
    def has_filename(self, filename):
421
 
        return osutils.lexists(self.abspath(filename))
422
 
 
423
 
    def get_file(self, file_id, path=None):
424
 
        if path is None:
425
 
            path = self.id2path(file_id)
426
 
        return self.get_file_byname(path)
427
 
 
428
 
    def get_file_text(self, file_id):
429
 
        return self.get_file(file_id).read()
 
446
        return bzrlib.osutils.lexists(self.abspath(filename))
 
447
 
 
448
    def get_file(self, file_id):
 
449
        return self.get_file_byname(self.id2path(file_id))
430
450
 
431
451
    def get_file_byname(self, filename):
432
452
        return file(self.abspath(filename), 'rb')
433
453
 
434
 
    @needs_read_lock
435
 
    def annotate_iter(self, file_id, default_revision=CURRENT_REVISION):
436
 
        """See Tree.annotate_iter
437
 
 
438
 
        This implementation will use the basis tree implementation if possible.
439
 
        Lines not in the basis are attributed to CURRENT_REVISION
440
 
 
441
 
        If there are pending merges, lines added by those merges will be
442
 
        incorrectly attributed to CURRENT_REVISION (but after committing, the
443
 
        attribution will be correct).
444
 
        """
445
 
        basis = self.basis_tree()
446
 
        basis.lock_read()
447
 
        try:
448
 
            changes = self.iter_changes(basis, True, [self.id2path(file_id)],
449
 
                require_versioned=True).next()
450
 
            changed_content, kind = changes[2], changes[6]
451
 
            if not changed_content:
452
 
                return basis.annotate_iter(file_id)
453
 
            if kind[1] is None:
454
 
                return None
455
 
            import annotate
456
 
            if kind[0] != 'file':
457
 
                old_lines = []
458
 
            else:
459
 
                old_lines = list(basis.annotate_iter(file_id))
460
 
            old = [old_lines]
461
 
            for tree in self.branch.repository.revision_trees(
462
 
                self.get_parent_ids()[1:]):
463
 
                if file_id not in tree:
464
 
                    continue
465
 
                old.append(list(tree.annotate_iter(file_id)))
466
 
            return annotate.reannotate(old, self.get_file(file_id).readlines(),
467
 
                                       default_revision)
468
 
        finally:
469
 
            basis.unlock()
470
 
 
471
 
    def _get_ancestors(self, default_revision):
472
 
        ancestors = set([default_revision])
473
 
        for parent_id in self.get_parent_ids():
474
 
            ancestors.update(self.branch.repository.get_ancestry(
475
 
                             parent_id, topo_sorted=False))
476
 
        return ancestors
477
 
 
478
 
    def get_parent_ids(self):
479
 
        """See Tree.get_parent_ids.
480
 
        
481
 
        This implementation reads the pending merges list and last_revision
482
 
        value and uses that to decide what the parents list should be.
483
 
        """
484
 
        last_rev = _mod_revision.ensure_null(self._last_revision())
485
 
        if _mod_revision.NULL_REVISION == last_rev:
486
 
            parents = []
487
 
        else:
488
 
            parents = [last_rev]
489
 
        try:
490
 
            merges_file = self._transport.get('pending-merges')
491
 
        except errors.NoSuchFile:
492
 
            pass
493
 
        else:
494
 
            for l in merges_file.readlines():
495
 
                revision_id = l.rstrip('\n')
496
 
                parents.append(revision_id)
497
 
        return parents
498
 
 
499
 
    @needs_read_lock
500
454
    def get_root_id(self):
501
455
        """Return the id of this trees root"""
502
 
        return self._inventory.root.file_id
 
456
        inv = self.read_working_inventory()
 
457
        return inv.root.file_id
503
458
        
504
459
    def _get_store_filename(self, file_id):
505
460
        ## XXX: badly named; this is not in the store at all
506
461
        return self.abspath(self.id2path(file_id))
507
462
 
508
463
    @needs_read_lock
509
 
    def clone(self, to_bzrdir, revision_id=None):
 
464
    def clone(self, to_bzrdir, revision_id=None, basis=None):
510
465
        """Duplicate this working tree into to_bzr, including all state.
511
466
        
512
467
        Specifically modified files are kept as modified, but
518
473
            If not None, the cloned tree will have its last revision set to 
519
474
            revision, and and difference between the source trees last revision
520
475
            and this one merged in.
 
476
 
 
477
        basis
 
478
            If not None, a closer copy of a tree which may have some files in
 
479
            common, and which file content should be preferentially copied from.
521
480
        """
522
481
        # assumes the target bzr dir format is compatible.
523
 
        result = to_bzrdir.create_workingtree()
 
482
        result = self._format.initialize(to_bzrdir)
524
483
        self.copy_content_into(result, revision_id)
525
484
        return result
526
485
 
527
486
    @needs_read_lock
528
487
    def copy_content_into(self, tree, revision_id=None):
529
488
        """Copy the current content and user files of this tree into tree."""
530
 
        tree.set_root_id(self.get_root_id())
531
489
        if revision_id is None:
532
 
            merge.transform_tree(tree, self)
 
490
            transform_tree(tree, self)
533
491
        else:
534
 
            # TODO now merge from tree.last_revision to revision (to preserve
535
 
            # user local changes)
536
 
            merge.transform_tree(tree, self)
537
 
            tree.set_parent_ids([revision_id])
 
492
            # TODO now merge from tree.last_revision to revision
 
493
            transform_tree(tree, self)
 
494
            tree.set_last_revision(revision_id)
 
495
 
 
496
    @needs_write_lock
 
497
    def commit(self, message=None, revprops=None, *args, **kwargs):
 
498
        # avoid circular imports
 
499
        from bzrlib.commit import Commit
 
500
        if revprops is None:
 
501
            revprops = {}
 
502
        if not 'branch-nick' in revprops:
 
503
            revprops['branch-nick'] = self.branch.nick
 
504
        # args for wt.commit start at message from the Commit.commit method,
 
505
        # but with branch a kwarg now, passing in args as is results in the
 
506
        #message being used for the branch
 
507
        args = (DEPRECATED_PARAMETER, message, ) + args
 
508
        Commit().commit(working_tree=self, revprops=revprops, *args, **kwargs)
 
509
        self._set_inventory(self.read_working_inventory())
538
510
 
539
511
    def id2abspath(self, file_id):
540
512
        return self.abspath(self.id2path(file_id))
541
513
 
542
514
    def has_id(self, file_id):
543
515
        # files that have been deleted are excluded
544
 
        inv = self.inventory
 
516
        inv = self._inventory
545
517
        if not inv.has_id(file_id):
546
518
            return False
547
519
        path = inv.id2path(file_id)
548
 
        return osutils.lexists(self.abspath(path))
 
520
        return bzrlib.osutils.lexists(self.abspath(path))
549
521
 
550
522
    def has_or_had_id(self, file_id):
551
523
        if file_id == self.inventory.root.file_id:
555
527
    __contains__ = has_id
556
528
 
557
529
    def get_file_size(self, file_id):
558
 
        """See Tree.get_file_size"""
559
 
        try:
560
 
            return os.path.getsize(self.id2abspath(file_id))
561
 
        except OSError, e:
562
 
            if e.errno != errno.ENOENT:
563
 
                raise
564
 
            else:
565
 
                return None
 
530
        return os.path.getsize(self.id2abspath(file_id))
566
531
 
567
532
    @needs_read_lock
568
 
    def get_file_sha1(self, file_id, path=None, stat_value=None):
569
 
        if not path:
 
533
    def get_file_sha1(self, file_id):
 
534
        path = self._inventory.id2path(file_id)
 
535
        return self._hashcache.get_sha1(path)
 
536
 
 
537
    def is_executable(self, file_id):
 
538
        if not supports_executable():
 
539
            return self._inventory[file_id].executable
 
540
        else:
570
541
            path = self._inventory.id2path(file_id)
571
 
        return self._hashcache.get_sha1(path, stat_value)
572
 
 
573
 
    def get_file_mtime(self, file_id, path=None):
574
 
        if not path:
575
 
            path = self.inventory.id2path(file_id)
576
 
        return os.lstat(self.abspath(path)).st_mtime
577
 
 
578
 
    def _is_executable_from_path_and_stat_from_basis(self, path, stat_result):
579
 
        file_id = self.path2id(path)
580
 
        return self._inventory[file_id].executable
581
 
 
582
 
    def _is_executable_from_path_and_stat_from_stat(self, path, stat_result):
583
 
        mode = stat_result.st_mode
584
 
        return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
585
 
 
586
 
    if not supports_executable():
587
 
        def is_executable(self, file_id, path=None):
588
 
            return self._inventory[file_id].executable
589
 
 
590
 
        _is_executable_from_path_and_stat = \
591
 
            _is_executable_from_path_and_stat_from_basis
592
 
    else:
593
 
        def is_executable(self, file_id, path=None):
594
 
            if not path:
595
 
                path = self.id2path(file_id)
596
542
            mode = os.lstat(self.abspath(path)).st_mode
597
 
            return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
598
 
 
599
 
        _is_executable_from_path_and_stat = \
600
 
            _is_executable_from_path_and_stat_from_stat
601
 
 
602
 
    @needs_tree_write_lock
603
 
    def _add(self, files, ids, kinds):
604
 
        """See MutableTree._add."""
 
543
            return bool(stat.S_ISREG(mode) and stat.S_IEXEC&mode)
 
544
 
 
545
    @needs_write_lock
 
546
    def add(self, files, ids=None):
 
547
        """Make files versioned.
 
548
 
 
549
        Note that the command line normally calls smart_add instead,
 
550
        which can automatically recurse.
 
551
 
 
552
        This adds the files to the inventory, so that they will be
 
553
        recorded by the next commit.
 
554
 
 
555
        files
 
556
            List of paths to add, relative to the base of the tree.
 
557
 
 
558
        ids
 
559
            If set, use these instead of automatically generated ids.
 
560
            Must be the same length as the list of files, but may
 
561
            contain None for ids that are to be autogenerated.
 
562
 
 
563
        TODO: Perhaps have an option to add the ids even if the files do
 
564
              not (yet) exist.
 
565
 
 
566
        TODO: Perhaps callback with the ids and paths as they're added.
 
567
        """
605
568
        # TODO: Re-adding a file that is removed in the working copy
606
569
        # should probably put it back with the previous ID.
607
 
        # the read and write working inventory should not occur in this 
608
 
        # function - they should be part of lock_write and unlock.
609
 
        inv = self.inventory
610
 
        for f, file_id, kind in zip(files, ids, kinds):
 
570
        if isinstance(files, basestring):
 
571
            assert(ids is None or isinstance(ids, basestring))
 
572
            files = [files]
 
573
            if ids is not None:
 
574
                ids = [ids]
 
575
 
 
576
        if ids is None:
 
577
            ids = [None] * len(files)
 
578
        else:
 
579
            assert(len(ids) == len(files))
 
580
 
 
581
        inv = self.read_working_inventory()
 
582
        for f,file_id in zip(files, ids):
 
583
            if self.is_control_filename(f):
 
584
                raise BzrError("cannot add control file %s" % quotefn(f))
 
585
 
 
586
            fp = splitpath(f)
 
587
 
 
588
            if len(fp) == 0:
 
589
                raise BzrError("cannot add top-level %r" % f)
 
590
 
 
591
            fullpath = normpath(self.abspath(f))
 
592
 
 
593
            try:
 
594
                kind = file_kind(fullpath)
 
595
            except OSError, e:
 
596
                if e.errno == errno.ENOENT:
 
597
                    raise NoSuchFile(fullpath)
 
598
                # maybe something better?
 
599
                raise BzrError('cannot add: not a regular file, symlink or directory: %s' % quotefn(f))
 
600
 
 
601
            if not InventoryEntry.versionable_kind(kind):
 
602
                raise BzrError('cannot add: not a versionable file ('
 
603
                               'i.e. regular file, symlink or directory): %s' % quotefn(f))
 
604
 
611
605
            if file_id is None:
612
606
                inv.add_path(f, kind=kind)
613
607
            else:
614
608
                inv.add_path(f, kind=kind, file_id=file_id)
615
 
            self._inventory_is_modified = True
616
609
 
617
 
    @needs_tree_write_lock
618
 
    def _gather_kinds(self, files, kinds):
619
 
        """See MutableTree._gather_kinds."""
620
 
        for pos, f in enumerate(files):
621
 
            if kinds[pos] is None:
622
 
                fullpath = normpath(self.abspath(f))
623
 
                try:
624
 
                    kinds[pos] = file_kind(fullpath)
625
 
                except OSError, e:
626
 
                    if e.errno == errno.ENOENT:
627
 
                        raise errors.NoSuchFile(fullpath)
 
610
        self._write_inventory(inv)
628
611
 
629
612
    @needs_write_lock
630
 
    def add_parent_tree_id(self, revision_id, allow_leftmost_as_ghost=False):
631
 
        """Add revision_id as a parent.
632
 
 
633
 
        This is equivalent to retrieving the current list of parent ids
634
 
        and setting the list to its value plus revision_id.
635
 
 
636
 
        :param revision_id: The revision id to add to the parent list. It may
637
 
        be a ghost revision as long as its not the first parent to be added,
638
 
        or the allow_leftmost_as_ghost parameter is set True.
639
 
        :param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
640
 
        """
641
 
        parents = self.get_parent_ids() + [revision_id]
642
 
        self.set_parent_ids(parents, allow_leftmost_as_ghost=len(parents) > 1
643
 
            or allow_leftmost_as_ghost)
644
 
 
645
 
    @needs_tree_write_lock
646
 
    def add_parent_tree(self, parent_tuple, allow_leftmost_as_ghost=False):
647
 
        """Add revision_id, tree tuple as a parent.
648
 
 
649
 
        This is equivalent to retrieving the current list of parent trees
650
 
        and setting the list to its value plus parent_tuple. See also
651
 
        add_parent_tree_id - if you only have a parent id available it will be
652
 
        simpler to use that api. If you have the parent already available, using
653
 
        this api is preferred.
654
 
 
655
 
        :param parent_tuple: The (revision id, tree) to add to the parent list.
656
 
            If the revision_id is a ghost, pass None for the tree.
657
 
        :param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
658
 
        """
659
 
        parent_ids = self.get_parent_ids() + [parent_tuple[0]]
660
 
        if len(parent_ids) > 1:
661
 
            # the leftmost may have already been a ghost, preserve that if it
662
 
            # was.
663
 
            allow_leftmost_as_ghost = True
664
 
        self.set_parent_ids(parent_ids,
665
 
            allow_leftmost_as_ghost=allow_leftmost_as_ghost)
666
 
 
667
 
    @needs_tree_write_lock
668
613
    def add_pending_merge(self, *revision_ids):
669
614
        # TODO: Perhaps should check at this point that the
670
615
        # history of the revision is actually present?
671
 
        parents = self.get_parent_ids()
 
616
        p = self.pending_merges()
672
617
        updated = False
673
618
        for rev_id in revision_ids:
674
 
            if rev_id in parents:
 
619
            if rev_id in p:
675
620
                continue
676
 
            parents.append(rev_id)
 
621
            p.append(rev_id)
677
622
            updated = True
678
623
        if updated:
679
 
            self.set_parent_ids(parents, allow_leftmost_as_ghost=True)
680
 
 
681
 
    def path_content_summary(self, path, _lstat=os.lstat,
682
 
        _mapper=osutils.file_kind_from_stat_mode):
683
 
        """See Tree.path_content_summary."""
684
 
        abspath = self.abspath(path)
 
624
            self.set_pending_merges(p)
 
625
 
 
626
    @needs_read_lock
 
627
    def pending_merges(self):
 
628
        """Return a list of pending merges.
 
629
 
 
630
        These are revisions that have been merged into the working
 
631
        directory but not yet committed.
 
632
        """
685
633
        try:
686
 
            stat_result = _lstat(abspath)
 
634
            merges_file = self._control_files.get_utf8('pending-merges')
687
635
        except OSError, e:
688
 
            if getattr(e, 'errno', None) == errno.ENOENT:
689
 
                # no file.
690
 
                return ('missing', None, None, None)
691
 
            # propagate other errors
692
 
            raise
693
 
        kind = _mapper(stat_result.st_mode)
694
 
        if kind == 'file':
695
 
            size = stat_result.st_size
696
 
            # try for a stat cache lookup
697
 
            executable = self._is_executable_from_path_and_stat(path, stat_result)
698
 
            return (kind, size, executable, self._sha_from_stat(
699
 
                path, stat_result))
700
 
        elif kind == 'directory':
701
 
            # perhaps it looks like a plain directory, but it's really a
702
 
            # reference.
703
 
            if self._directory_is_tree_reference(path):
704
 
                kind = 'tree-reference'
705
 
            return kind, None, None, None
706
 
        elif kind == 'symlink':
707
 
            return ('symlink', None, None, os.readlink(abspath))
708
 
        else:
709
 
            return (kind, None, None, None)
710
 
 
711
 
    def _check_parents_for_ghosts(self, revision_ids, allow_leftmost_as_ghost):
712
 
        """Common ghost checking functionality from set_parent_*.
713
 
 
714
 
        This checks that the left hand-parent exists if there are any
715
 
        revisions present.
716
 
        """
717
 
        if len(revision_ids) > 0:
718
 
            leftmost_id = revision_ids[0]
719
 
            if (not allow_leftmost_as_ghost and not
720
 
                self.branch.repository.has_revision(leftmost_id)):
721
 
                raise errors.GhostRevisionUnusableHere(leftmost_id)
722
 
 
723
 
    def _set_merges_from_parent_ids(self, parent_ids):
724
 
        merges = parent_ids[1:]
725
 
        self._transport.put_bytes('pending-merges', '\n'.join(merges),
726
 
            mode=self._control_files._file_mode)
727
 
 
728
 
    def _filter_parent_ids_by_ancestry(self, revision_ids):
729
 
        """Check that all merged revisions are proper 'heads'.
730
 
 
731
 
        This will always return the first revision_id, and any merged revisions
732
 
        which are 
733
 
        """
734
 
        if len(revision_ids) == 0:
735
 
            return revision_ids
736
 
        graph = self.branch.repository.get_graph()
737
 
        heads = graph.heads(revision_ids)
738
 
        new_revision_ids = revision_ids[:1]
739
 
        for revision_id in revision_ids[1:]:
740
 
            if revision_id in heads and revision_id not in new_revision_ids:
741
 
                new_revision_ids.append(revision_id)
742
 
        if new_revision_ids != revision_ids:
743
 
            trace.mutter('requested to set revision_ids = %s,'
744
 
                         ' but filtered to %s', revision_ids, new_revision_ids)
745
 
        return new_revision_ids
746
 
 
747
 
    @needs_tree_write_lock
748
 
    def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
749
 
        """Set the parent ids to revision_ids.
750
 
        
751
 
        See also set_parent_trees. This api will try to retrieve the tree data
752
 
        for each element of revision_ids from the trees repository. If you have
753
 
        tree data already available, it is more efficient to use
754
 
        set_parent_trees rather than set_parent_ids. set_parent_ids is however
755
 
        an easier API to use.
756
 
 
757
 
        :param revision_ids: The revision_ids to set as the parent ids of this
758
 
            working tree. Any of these may be ghosts.
759
 
        """
760
 
        self._check_parents_for_ghosts(revision_ids,
761
 
            allow_leftmost_as_ghost=allow_leftmost_as_ghost)
762
 
        for revision_id in revision_ids:
763
 
            _mod_revision.check_not_reserved_id(revision_id)
764
 
 
765
 
        revision_ids = self._filter_parent_ids_by_ancestry(revision_ids)
766
 
 
767
 
        if len(revision_ids) > 0:
768
 
            self.set_last_revision(revision_ids[0])
769
 
        else:
770
 
            self.set_last_revision(_mod_revision.NULL_REVISION)
771
 
 
772
 
        self._set_merges_from_parent_ids(revision_ids)
773
 
 
774
 
    @needs_tree_write_lock
775
 
    def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
776
 
        """See MutableTree.set_parent_trees."""
777
 
        parent_ids = [rev for (rev, tree) in parents_list]
778
 
        for revision_id in parent_ids:
779
 
            _mod_revision.check_not_reserved_id(revision_id)
780
 
 
781
 
        self._check_parents_for_ghosts(parent_ids,
782
 
            allow_leftmost_as_ghost=allow_leftmost_as_ghost)
783
 
 
784
 
        parent_ids = self._filter_parent_ids_by_ancestry(parent_ids)
785
 
 
786
 
        if len(parent_ids) == 0:
787
 
            leftmost_parent_id = _mod_revision.NULL_REVISION
788
 
            leftmost_parent_tree = None
789
 
        else:
790
 
            leftmost_parent_id, leftmost_parent_tree = parents_list[0]
791
 
 
792
 
        if self._change_last_revision(leftmost_parent_id):
793
 
            if leftmost_parent_tree is None:
794
 
                # If we don't have a tree, fall back to reading the
795
 
                # parent tree from the repository.
796
 
                self._cache_basis_inventory(leftmost_parent_id)
797
 
            else:
798
 
                inv = leftmost_parent_tree.inventory
799
 
                xml = self._create_basis_xml_from_inventory(
800
 
                                        leftmost_parent_id, inv)
801
 
                self._write_basis_inventory(xml)
802
 
        self._set_merges_from_parent_ids(parent_ids)
803
 
 
804
 
    @needs_tree_write_lock
 
636
            if e.errno != errno.ENOENT:
 
637
                raise
 
638
            return []
 
639
        p = []
 
640
        for l in merges_file.readlines():
 
641
            p.append(l.rstrip('\n'))
 
642
        return p
 
643
 
 
644
    @needs_write_lock
805
645
    def set_pending_merges(self, rev_list):
806
 
        parents = self.get_parent_ids()
807
 
        leftmost = parents[:1]
808
 
        new_parents = leftmost + rev_list
809
 
        self.set_parent_ids(new_parents)
 
646
        self._control_files.put_utf8('pending-merges', '\n'.join(rev_list))
810
647
 
811
 
    @needs_tree_write_lock
 
648
    @needs_write_lock
812
649
    def set_merge_modified(self, modified_hashes):
813
650
        def iter_stanzas():
814
651
            for file_id, hash in modified_hashes.iteritems():
815
 
                yield Stanza(file_id=file_id.decode('utf8'), hash=hash)
 
652
                yield Stanza(file_id=file_id, hash=hash)
816
653
        self._put_rio('merge-hashes', iter_stanzas(), MERGE_MODIFIED_HEADER_1)
817
654
 
818
 
    def _sha_from_stat(self, path, stat_result):
819
 
        """Get a sha digest from the tree's stat cache.
820
 
 
821
 
        The default implementation assumes no stat cache is present.
822
 
 
823
 
        :param path: The path.
824
 
        :param stat_result: The stat result being looked up.
825
 
        """
826
 
        return None
827
 
 
 
655
    @needs_write_lock
828
656
    def _put_rio(self, filename, stanzas, header):
829
 
        self._must_be_locked()
830
657
        my_file = rio_file(stanzas, header)
831
 
        self._transport.put_file(filename, my_file,
832
 
            mode=self._control_files._file_mode)
833
 
 
834
 
    @needs_write_lock # because merge pulls data into the branch.
835
 
    def merge_from_branch(self, branch, to_revision=None, from_revision=None,
836
 
        merge_type=None):
837
 
        """Merge from a branch into this working tree.
838
 
 
839
 
        :param branch: The branch to merge from.
840
 
        :param to_revision: If non-None, the merge will merge to to_revision,
841
 
            but not beyond it. to_revision does not need to be in the history
842
 
            of the branch when it is supplied. If None, to_revision defaults to
843
 
            branch.last_revision().
844
 
        """
845
 
        from bzrlib.merge import Merger, Merge3Merger
846
 
        pb = bzrlib.ui.ui_factory.nested_progress_bar()
847
 
        try:
848
 
            merger = Merger(self.branch, this_tree=self, pb=pb)
849
 
            merger.pp = ProgressPhase("Merge phase", 5, pb)
850
 
            merger.pp.next_phase()
851
 
            # check that there are no
852
 
            # local alterations
853
 
            merger.check_basis(check_clean=True, require_commits=False)
854
 
            if to_revision is None:
855
 
                to_revision = _mod_revision.ensure_null(branch.last_revision())
856
 
            merger.other_rev_id = to_revision
857
 
            if _mod_revision.is_null(merger.other_rev_id):
858
 
                raise errors.NoCommits(branch)
859
 
            self.branch.fetch(branch, last_revision=merger.other_rev_id)
860
 
            merger.other_basis = merger.other_rev_id
861
 
            merger.other_tree = self.branch.repository.revision_tree(
862
 
                merger.other_rev_id)
863
 
            merger.other_branch = branch
864
 
            merger.pp.next_phase()
865
 
            if from_revision is None:
866
 
                merger.find_base()
867
 
            else:
868
 
                merger.set_base_revision(from_revision, branch)
869
 
            if merger.base_rev_id == merger.other_rev_id:
870
 
                raise errors.PointlessMerge
871
 
            merger.backup_files = False
872
 
            if merge_type is None:
873
 
                merger.merge_type = Merge3Merger
874
 
            else:
875
 
                merger.merge_type = merge_type
876
 
            merger.set_interesting_files(None)
877
 
            merger.show_base = False
878
 
            merger.reprocess = False
879
 
            conflicts = merger.do_merge()
880
 
            merger.set_pending()
881
 
        finally:
882
 
            pb.finished()
883
 
        return conflicts
 
658
        self._control_files.put(filename, my_file)
884
659
 
885
660
    @needs_read_lock
886
661
    def merge_modified(self):
887
 
        """Return a dictionary of files modified by a merge.
888
 
 
889
 
        The list is initialized by WorkingTree.set_merge_modified, which is 
890
 
        typically called after we make some automatic updates to the tree
891
 
        because of a merge.
892
 
 
893
 
        This returns a map of file_id->sha1, containing only files which are
894
 
        still in the working inventory and have that text hash.
895
 
        """
896
662
        try:
897
 
            hashfile = self._transport.get('merge-hashes')
898
 
        except errors.NoSuchFile:
 
663
            hashfile = self._control_files.get('merge-hashes')
 
664
        except NoSuchFile:
899
665
            return {}
900
666
        merge_hashes = {}
901
667
        try:
902
668
            if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
903
 
                raise errors.MergeModifiedFormatError()
 
669
                raise MergeModifiedFormatError()
904
670
        except StopIteration:
905
 
            raise errors.MergeModifiedFormatError()
 
671
            raise MergeModifiedFormatError()
906
672
        for s in RioReader(hashfile):
907
 
            # RioReader reads in Unicode, so convert file_ids back to utf8
908
 
            file_id = osutils.safe_file_id(s.get("file_id"), warn=False)
 
673
            file_id = s.get("file_id")
909
674
            if file_id not in self.inventory:
910
675
                continue
911
 
            text_hash = s.get("hash")
912
 
            if text_hash == self.get_file_sha1(file_id):
913
 
                merge_hashes[file_id] = text_hash
 
676
            hash = s.get("hash")
 
677
            if hash == self.get_file_sha1(file_id):
 
678
                merge_hashes[file_id] = hash
914
679
        return merge_hashes
915
680
 
916
 
    @needs_write_lock
917
 
    def mkdir(self, path, file_id=None):
918
 
        """See MutableTree.mkdir()."""
919
 
        if file_id is None:
920
 
            file_id = generate_ids.gen_file_id(os.path.basename(path))
921
 
        os.mkdir(self.abspath(path))
922
 
        self.add(path, file_id, 'directory')
923
 
        return file_id
924
 
 
925
681
    def get_symlink_target(self, file_id):
926
682
        return os.readlink(self.id2abspath(file_id))
927
683
 
928
 
    @needs_write_lock
929
 
    def subsume(self, other_tree):
930
 
        def add_children(inventory, entry):
931
 
            for child_entry in entry.children.values():
932
 
                inventory._byid[child_entry.file_id] = child_entry
933
 
                if child_entry.kind == 'directory':
934
 
                    add_children(inventory, child_entry)
935
 
        if other_tree.get_root_id() == self.get_root_id():
936
 
            raise errors.BadSubsumeSource(self, other_tree,
937
 
                                          'Trees have the same root')
938
 
        try:
939
 
            other_tree_path = self.relpath(other_tree.basedir)
940
 
        except errors.PathNotChild:
941
 
            raise errors.BadSubsumeSource(self, other_tree,
942
 
                'Tree is not contained by the other')
943
 
        new_root_parent = self.path2id(osutils.dirname(other_tree_path))
944
 
        if new_root_parent is None:
945
 
            raise errors.BadSubsumeSource(self, other_tree,
946
 
                'Parent directory is not versioned.')
947
 
        # We need to ensure that the result of a fetch will have a
948
 
        # versionedfile for the other_tree root, and only fetching into
949
 
        # RepositoryKnit2 guarantees that.
950
 
        if not self.branch.repository.supports_rich_root():
951
 
            raise errors.SubsumeTargetNeedsUpgrade(other_tree)
952
 
        other_tree.lock_tree_write()
953
 
        try:
954
 
            new_parents = other_tree.get_parent_ids()
955
 
            other_root = other_tree.inventory.root
956
 
            other_root.parent_id = new_root_parent
957
 
            other_root.name = osutils.basename(other_tree_path)
958
 
            self.inventory.add(other_root)
959
 
            add_children(self.inventory, other_root)
960
 
            self._write_inventory(self.inventory)
961
 
            # normally we don't want to fetch whole repositories, but i think
962
 
            # here we really do want to consolidate the whole thing.
963
 
            for parent_id in other_tree.get_parent_ids():
964
 
                self.branch.fetch(other_tree.branch, parent_id)
965
 
                self.add_parent_tree_id(parent_id)
966
 
        finally:
967
 
            other_tree.unlock()
968
 
        other_tree.bzrdir.retire_bzrdir()
969
 
 
970
 
    def _setup_directory_is_tree_reference(self):
971
 
        if self._branch.repository._format.supports_tree_reference:
972
 
            self._directory_is_tree_reference = \
973
 
                self._directory_may_be_tree_reference
974
 
        else:
975
 
            self._directory_is_tree_reference = \
976
 
                self._directory_is_never_tree_reference
977
 
 
978
 
    def _directory_is_never_tree_reference(self, relpath):
979
 
        return False
980
 
 
981
 
    def _directory_may_be_tree_reference(self, relpath):
982
 
        # as a special case, if a directory contains control files then 
983
 
        # it's a tree reference, except that the root of the tree is not
984
 
        return relpath and osutils.isdir(self.abspath(relpath) + u"/.bzr")
985
 
        # TODO: We could ask all the control formats whether they
986
 
        # recognize this directory, but at the moment there's no cheap api
987
 
        # to do that.  Since we probably can only nest bzr checkouts and
988
 
        # they always use this name it's ok for now.  -- mbp 20060306
989
 
        #
990
 
        # FIXME: There is an unhandled case here of a subdirectory
991
 
        # containing .bzr but not a branch; that will probably blow up
992
 
        # when you try to commit it.  It might happen if there is a
993
 
        # checkout in a subdirectory.  This can be avoided by not adding
994
 
        # it.  mbp 20070306
995
 
 
996
 
    @needs_tree_write_lock
997
 
    def extract(self, file_id, format=None):
998
 
        """Extract a subtree from this tree.
999
 
        
1000
 
        A new branch will be created, relative to the path for this tree.
1001
 
        """
1002
 
        self.flush()
1003
 
        def mkdirs(path):
1004
 
            segments = osutils.splitpath(path)
1005
 
            transport = self.branch.bzrdir.root_transport
1006
 
            for name in segments:
1007
 
                transport = transport.clone(name)
1008
 
                transport.ensure_base()
1009
 
            return transport
1010
 
            
1011
 
        sub_path = self.id2path(file_id)
1012
 
        branch_transport = mkdirs(sub_path)
1013
 
        if format is None:
1014
 
            format = self.bzrdir.cloning_metadir()
1015
 
        branch_transport.ensure_base()
1016
 
        branch_bzrdir = format.initialize_on_transport(branch_transport)
1017
 
        try:
1018
 
            repo = branch_bzrdir.find_repository()
1019
 
        except errors.NoRepositoryPresent:
1020
 
            repo = branch_bzrdir.create_repository()
1021
 
        if not repo.supports_rich_root():
1022
 
            raise errors.RootNotRich()
1023
 
        new_branch = branch_bzrdir.create_branch()
1024
 
        new_branch.pull(self.branch)
1025
 
        for parent_id in self.get_parent_ids():
1026
 
            new_branch.fetch(self.branch, parent_id)
1027
 
        tree_transport = self.bzrdir.root_transport.clone(sub_path)
1028
 
        if tree_transport.base != branch_transport.base:
1029
 
            tree_bzrdir = format.initialize_on_transport(tree_transport)
1030
 
            branch.BranchReferenceFormat().initialize(tree_bzrdir, new_branch)
1031
 
        else:
1032
 
            tree_bzrdir = branch_bzrdir
1033
 
        wt = tree_bzrdir.create_workingtree(NULL_REVISION)
1034
 
        wt.set_parent_ids(self.get_parent_ids())
1035
 
        my_inv = self.inventory
1036
 
        child_inv = Inventory(root_id=None)
1037
 
        new_root = my_inv[file_id]
1038
 
        my_inv.remove_recursive_id(file_id)
1039
 
        new_root.parent_id = None
1040
 
        child_inv.add(new_root)
1041
 
        self._write_inventory(my_inv)
1042
 
        wt._write_inventory(child_inv)
1043
 
        return wt
1044
 
 
1045
 
    def _serialize(self, inventory, out_file):
1046
 
        xml5.serializer_v5.write_inventory(self._inventory, out_file,
1047
 
            working=True)
1048
 
 
1049
 
    def _deserialize(selt, in_file):
1050
 
        return xml5.serializer_v5.read_inventory(in_file)
1051
 
 
1052
 
    def flush(self):
1053
 
        """Write the in memory inventory to disk."""
1054
 
        # TODO: Maybe this should only write on dirty ?
1055
 
        if self._control_files._lock_mode != 'w':
1056
 
            raise errors.NotWriteLocked(self)
1057
 
        sio = StringIO()
1058
 
        self._serialize(self._inventory, sio)
1059
 
        sio.seek(0)
1060
 
        self._transport.put_file('inventory', sio,
1061
 
            mode=self._control_files._file_mode)
1062
 
        self._inventory_is_modified = False
1063
 
 
1064
 
    def _kind(self, relpath):
1065
 
        return osutils.file_kind(self.abspath(relpath))
1066
 
 
1067
 
    def list_files(self, include_root=False):
1068
 
        """Recursively list all files as (path, class, kind, id, entry).
 
684
    def file_class(self, filename):
 
685
        if self.path2id(filename):
 
686
            return 'V'
 
687
        elif self.is_ignored(filename):
 
688
            return 'I'
 
689
        else:
 
690
            return '?'
 
691
 
 
692
    def list_files(self):
 
693
        """Recursively list all files as (path, class, kind, id).
1069
694
 
1070
695
        Lists, but does not descend into unversioned directories.
1071
696
 
1074
699
 
1075
700
        Skips the control directory.
1076
701
        """
1077
 
        # list_files is an iterator, so @needs_read_lock doesn't work properly
1078
 
        # with it. So callers should be careful to always read_lock the tree.
1079
 
        if not self.is_locked():
1080
 
            raise errors.ObjectNotLocked(self)
1081
 
 
1082
 
        inv = self.inventory
1083
 
        if include_root is True:
1084
 
            yield ('', 'V', 'directory', inv.root.file_id, inv.root)
1085
 
        # Convert these into local objects to save lookup times
1086
 
        pathjoin = osutils.pathjoin
1087
 
        file_kind = self._kind
1088
 
 
1089
 
        # transport.base ends in a slash, we want the piece
1090
 
        # between the last two slashes
1091
 
        transport_base_dir = self.bzrdir.transport.base.rsplit('/', 2)[1]
1092
 
 
1093
 
        fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
1094
 
 
1095
 
        # directory file_id, relative path, absolute path, reverse sorted children
1096
 
        children = os.listdir(self.basedir)
1097
 
        children.sort()
1098
 
        # jam 20060527 The kernel sized tree seems equivalent whether we 
1099
 
        # use a deque and popleft to keep them sorted, or if we use a plain
1100
 
        # list and just reverse() them.
1101
 
        children = collections.deque(children)
1102
 
        stack = [(inv.root.file_id, u'', self.basedir, children)]
1103
 
        while stack:
1104
 
            from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
1105
 
 
1106
 
            while children:
1107
 
                f = children.popleft()
 
702
        inv = self._inventory
 
703
 
 
704
        def descend(from_dir_relpath, from_dir_id, dp):
 
705
            ls = os.listdir(dp)
 
706
            ls.sort()
 
707
            for f in ls:
1108
708
                ## TODO: If we find a subdirectory with its own .bzr
1109
709
                ## directory, then that is a separate tree and we
1110
710
                ## should exclude it.
1111
711
 
1112
712
                # the bzrdir for this tree
1113
 
                if transport_base_dir == f:
 
713
                if self.bzrdir.transport.base.endswith(f + '/'):
1114
714
                    continue
1115
715
 
1116
 
                # we know that from_dir_relpath and from_dir_abspath never end in a slash
1117
 
                # and 'f' doesn't begin with one, we can do a string op, rather
1118
 
                # than the checks of pathjoin(), all relative paths will have an extra slash
1119
 
                # at the beginning
1120
 
                fp = from_dir_relpath + '/' + f
 
716
                # path within tree
 
717
                fp = appendpath(from_dir_relpath, f)
1121
718
 
1122
719
                # absolute path
1123
 
                fap = from_dir_abspath + '/' + f
 
720
                fap = appendpath(dp, f)
1124
721
                
1125
722
                f_ie = inv.get_child(from_dir_id, f)
1126
723
                if f_ie:
1127
724
                    c = 'V'
1128
 
                elif self.is_ignored(fp[1:]):
 
725
                elif self.is_ignored(fp):
1129
726
                    c = 'I'
1130
727
                else:
1131
 
                    # we may not have found this file, because of a unicode issue
1132
 
                    f_norm, can_access = osutils.normalized_filename(f)
1133
 
                    if f == f_norm or not can_access:
1134
 
                        # No change, so treat this file normally
1135
 
                        c = '?'
1136
 
                    else:
1137
 
                        # this file can be accessed by a normalized path
1138
 
                        # check again if it is versioned
1139
 
                        # these lines are repeated here for performance
1140
 
                        f = f_norm
1141
 
                        fp = from_dir_relpath + '/' + f
1142
 
                        fap = from_dir_abspath + '/' + f
1143
 
                        f_ie = inv.get_child(from_dir_id, f)
1144
 
                        if f_ie:
1145
 
                            c = 'V'
1146
 
                        elif self.is_ignored(fp[1:]):
1147
 
                            c = 'I'
1148
 
                        else:
1149
 
                            c = '?'
 
728
                    c = '?'
1150
729
 
1151
730
                fk = file_kind(fap)
1152
731
 
 
732
                if f_ie:
 
733
                    if f_ie.kind != fk:
 
734
                        raise BzrCheckError("file %r entered as kind %r id %r, "
 
735
                                            "now of kind %r"
 
736
                                            % (fap, f_ie.kind, f_ie.file_id, fk))
 
737
 
1153
738
                # make a last minute entry
1154
739
                if f_ie:
1155
 
                    yield fp[1:], c, fk, f_ie.file_id, f_ie
 
740
                    entry = f_ie
1156
741
                else:
1157
 
                    try:
1158
 
                        yield fp[1:], c, fk, None, fk_entries[fk]()
1159
 
                    except KeyError:
1160
 
                        yield fp[1:], c, fk, None, TreeEntry()
1161
 
                    continue
 
742
                    if fk == 'directory':
 
743
                        entry = TreeDirectory()
 
744
                    elif fk == 'file':
 
745
                        entry = TreeFile()
 
746
                    elif fk == 'symlink':
 
747
                        entry = TreeLink()
 
748
                    else:
 
749
                        entry = TreeEntry()
1162
750
                
 
751
                yield fp, c, fk, (f_ie and f_ie.file_id), entry
 
752
 
1163
753
                if fk != 'directory':
1164
754
                    continue
1165
755
 
1166
 
                # But do this child first
1167
 
                new_children = os.listdir(fap)
1168
 
                new_children.sort()
1169
 
                new_children = collections.deque(new_children)
1170
 
                stack.append((f_ie.file_id, fp, fap, new_children))
1171
 
                # Break out of inner loop,
1172
 
                # so that we start outer loop with child
1173
 
                break
1174
 
            else:
1175
 
                # if we finished all children, pop it off the stack
1176
 
                stack.pop()
1177
 
 
1178
 
    @needs_tree_write_lock
1179
 
    def move(self, from_paths, to_dir=None, after=False, **kwargs):
 
756
                if c != 'V':
 
757
                    # don't descend unversioned directories
 
758
                    continue
 
759
                
 
760
                for ff in descend(fp, f_ie.file_id, fap):
 
761
                    yield ff
 
762
 
 
763
        for f in descend(u'', inv.root.file_id, self.basedir):
 
764
            yield f
 
765
 
 
766
    @needs_write_lock
 
767
    def move(self, from_paths, to_name):
1180
768
        """Rename files.
1181
769
 
1182
 
        to_dir must exist in the inventory.
 
770
        to_name must exist in the inventory.
1183
771
 
1184
 
        If to_dir exists and is a directory, the files are moved into
 
772
        If to_name exists and is a directory, the files are moved into
1185
773
        it, keeping their old names.  
1186
774
 
1187
 
        Note that to_dir is only the last component of the new name;
 
775
        Note that to_name is only the last component of the new name;
1188
776
        this doesn't change the directory.
1189
777
 
1190
 
        For each entry in from_paths the move mode will be determined
1191
 
        independently.
1192
 
 
1193
 
        The first mode moves the file in the filesystem and updates the
1194
 
        inventory. The second mode only updates the inventory without
1195
 
        touching the file on the filesystem. This is the new mode introduced
1196
 
        in version 0.15.
1197
 
 
1198
 
        move uses the second mode if 'after == True' and the target is not
1199
 
        versioned but present in the working tree.
1200
 
 
1201
 
        move uses the second mode if 'after == False' and the source is
1202
 
        versioned but no longer in the working tree, and the target is not
1203
 
        versioned but present in the working tree.
1204
 
 
1205
 
        move uses the first mode if 'after == False' and the source is
1206
 
        versioned and present in the working tree, and the target is not
1207
 
        versioned and not present in the working tree.
1208
 
 
1209
 
        Everything else results in an error.
1210
 
 
1211
778
        This returns a list of (from_path, to_path) pairs for each
1212
779
        entry that is moved.
1213
780
        """
1214
 
        rename_entries = []
1215
 
        rename_tuples = []
1216
 
 
1217
 
        # check for deprecated use of signature
1218
 
        if to_dir is None:
1219
 
            to_dir = kwargs.get('to_name', None)
1220
 
            if to_dir is None:
1221
 
                raise TypeError('You must supply a target directory')
1222
 
            else:
1223
 
                symbol_versioning.warn('The parameter to_name was deprecated'
1224
 
                                       ' in version 0.13. Use to_dir instead',
1225
 
                                       DeprecationWarning)
1226
 
 
1227
 
        # check destination directory
1228
 
        if isinstance(from_paths, basestring):
1229
 
            raise ValueError()
 
781
        result = []
 
782
        ## TODO: Option to move IDs only
 
783
        assert not isinstance(from_paths, basestring)
1230
784
        inv = self.inventory
1231
 
        to_abs = self.abspath(to_dir)
 
785
        to_abs = self.abspath(to_name)
1232
786
        if not isdir(to_abs):
1233
 
            raise errors.BzrMoveFailedError('',to_dir,
1234
 
                errors.NotADirectory(to_abs))
1235
 
        if not self.has_filename(to_dir):
1236
 
            raise errors.BzrMoveFailedError('',to_dir,
1237
 
                errors.NotInWorkingDirectory(to_dir))
1238
 
        to_dir_id = inv.path2id(to_dir)
1239
 
        if to_dir_id is None:
1240
 
            raise errors.BzrMoveFailedError('',to_dir,
1241
 
                errors.NotVersionedError(path=str(to_dir)))
1242
 
 
 
787
            raise BzrError("destination %r is not a directory" % to_abs)
 
788
        if not self.has_filename(to_name):
 
789
            raise BzrError("destination %r not in working directory" % to_abs)
 
790
        to_dir_id = inv.path2id(to_name)
 
791
        if to_dir_id == None and to_name != '':
 
792
            raise BzrError("destination %r is not a versioned directory" % to_name)
1243
793
        to_dir_ie = inv[to_dir_id]
1244
 
        if to_dir_ie.kind != 'directory':
1245
 
            raise errors.BzrMoveFailedError('',to_dir,
1246
 
                errors.NotADirectory(to_abs))
1247
 
 
1248
 
        # create rename entries and tuples
1249
 
        for from_rel in from_paths:
1250
 
            from_tail = splitpath(from_rel)[-1]
1251
 
            from_id = inv.path2id(from_rel)
1252
 
            if from_id is None:
1253
 
                raise errors.BzrMoveFailedError(from_rel,to_dir,
1254
 
                    errors.NotVersionedError(path=str(from_rel)))
1255
 
 
1256
 
            from_entry = inv[from_id]
1257
 
            from_parent_id = from_entry.parent_id
1258
 
            to_rel = pathjoin(to_dir, from_tail)
1259
 
            rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
1260
 
                                         from_id=from_id,
1261
 
                                         from_tail=from_tail,
1262
 
                                         from_parent_id=from_parent_id,
1263
 
                                         to_rel=to_rel, to_tail=from_tail,
1264
 
                                         to_parent_id=to_dir_id)
1265
 
            rename_entries.append(rename_entry)
1266
 
            rename_tuples.append((from_rel, to_rel))
1267
 
 
1268
 
        # determine which move mode to use. checks also for movability
1269
 
        rename_entries = self._determine_mv_mode(rename_entries, after)
1270
 
 
1271
 
        original_modified = self._inventory_is_modified
 
794
        if to_dir_ie.kind not in ('directory', 'root_directory'):
 
795
            raise BzrError("destination %r is not a directory" % to_abs)
 
796
 
 
797
        to_idpath = inv.get_idpath(to_dir_id)
 
798
 
 
799
        for f in from_paths:
 
800
            if not self.has_filename(f):
 
801
                raise BzrError("%r does not exist in working tree" % f)
 
802
            f_id = inv.path2id(f)
 
803
            if f_id == None:
 
804
                raise BzrError("%r is not versioned" % f)
 
805
            name_tail = splitpath(f)[-1]
 
806
            dest_path = appendpath(to_name, name_tail)
 
807
            if self.has_filename(dest_path):
 
808
                raise BzrError("destination %r already exists" % dest_path)
 
809
            if f_id in to_idpath:
 
810
                raise BzrError("can't move %r to a subdirectory of itself" % f)
 
811
 
 
812
        # OK, so there's a race here, it's possible that someone will
 
813
        # create a file in this interval and then the rename might be
 
814
        # left half-done.  But we should have caught most problems.
 
815
        orig_inv = deepcopy(self.inventory)
1272
816
        try:
1273
 
            if len(from_paths):
1274
 
                self._inventory_is_modified = True
1275
 
            self._move(rename_entries)
 
817
            for f in from_paths:
 
818
                name_tail = splitpath(f)[-1]
 
819
                dest_path = appendpath(to_name, name_tail)
 
820
                result.append((f, dest_path))
 
821
                inv.rename(inv.path2id(f), to_dir_id, name_tail)
 
822
                try:
 
823
                    rename(self.abspath(f), self.abspath(dest_path))
 
824
                except OSError, e:
 
825
                    raise BzrError("failed to rename %r to %r: %s" %
 
826
                                   (f, dest_path, e[1]),
 
827
                            ["rename rolled back"])
1276
828
        except:
1277
829
            # restore the inventory on error
1278
 
            self._inventory_is_modified = original_modified
 
830
            self._set_inventory(orig_inv)
1279
831
            raise
1280
832
        self._write_inventory(inv)
1281
 
        return rename_tuples
1282
 
 
1283
 
    def _determine_mv_mode(self, rename_entries, after=False):
1284
 
        """Determines for each from-to pair if both inventory and working tree
1285
 
        or only the inventory has to be changed.
1286
 
 
1287
 
        Also does basic plausability tests.
1288
 
        """
1289
 
        inv = self.inventory
1290
 
 
1291
 
        for rename_entry in rename_entries:
1292
 
            # store to local variables for easier reference
1293
 
            from_rel = rename_entry.from_rel
1294
 
            from_id = rename_entry.from_id
1295
 
            to_rel = rename_entry.to_rel
1296
 
            to_id = inv.path2id(to_rel)
1297
 
            only_change_inv = False
1298
 
 
1299
 
            # check the inventory for source and destination
1300
 
            if from_id is None:
1301
 
                raise errors.BzrMoveFailedError(from_rel,to_rel,
1302
 
                    errors.NotVersionedError(path=str(from_rel)))
1303
 
            if to_id is not None:
1304
 
                raise errors.BzrMoveFailedError(from_rel,to_rel,
1305
 
                    errors.AlreadyVersionedError(path=str(to_rel)))
1306
 
 
1307
 
            # try to determine the mode for rename (only change inv or change
1308
 
            # inv and file system)
1309
 
            if after:
1310
 
                if not self.has_filename(to_rel):
1311
 
                    raise errors.BzrMoveFailedError(from_id,to_rel,
1312
 
                        errors.NoSuchFile(path=str(to_rel),
1313
 
                        extra="New file has not been created yet"))
1314
 
                only_change_inv = True
1315
 
            elif not self.has_filename(from_rel) and self.has_filename(to_rel):
1316
 
                only_change_inv = True
1317
 
            elif self.has_filename(from_rel) and not self.has_filename(to_rel):
1318
 
                only_change_inv = False
1319
 
            elif (not self.case_sensitive
1320
 
                  and from_rel.lower() == to_rel.lower()
1321
 
                  and self.has_filename(from_rel)):
1322
 
                only_change_inv = False
1323
 
            else:
1324
 
                # something is wrong, so lets determine what exactly
1325
 
                if not self.has_filename(from_rel) and \
1326
 
                   not self.has_filename(to_rel):
1327
 
                    raise errors.BzrRenameFailedError(from_rel,to_rel,
1328
 
                        errors.PathsDoNotExist(paths=(str(from_rel),
1329
 
                        str(to_rel))))
1330
 
                else:
1331
 
                    raise errors.RenameFailedFilesExist(from_rel, to_rel)
1332
 
            rename_entry.only_change_inv = only_change_inv
1333
 
        return rename_entries
1334
 
 
1335
 
    def _move(self, rename_entries):
1336
 
        """Moves a list of files.
1337
 
 
1338
 
        Depending on the value of the flag 'only_change_inv', the
1339
 
        file will be moved on the file system or not.
1340
 
        """
1341
 
        inv = self.inventory
1342
 
        moved = []
1343
 
 
1344
 
        for entry in rename_entries:
1345
 
            try:
1346
 
                self._move_entry(entry)
1347
 
            except:
1348
 
                self._rollback_move(moved)
1349
 
                raise
1350
 
            moved.append(entry)
1351
 
 
1352
 
    def _rollback_move(self, moved):
1353
 
        """Try to rollback a previous move in case of an filesystem error."""
1354
 
        inv = self.inventory
1355
 
        for entry in moved:
1356
 
            try:
1357
 
                self._move_entry(_RenameEntry(entry.to_rel, entry.from_id,
1358
 
                    entry.to_tail, entry.to_parent_id, entry.from_rel,
1359
 
                    entry.from_tail, entry.from_parent_id,
1360
 
                    entry.only_change_inv))
1361
 
            except errors.BzrMoveFailedError, e:
1362
 
                raise errors.BzrMoveFailedError( '', '', "Rollback failed."
1363
 
                        " The working tree is in an inconsistent state."
1364
 
                        " Please consider doing a 'bzr revert'."
1365
 
                        " Error message is: %s" % e)
1366
 
 
1367
 
    def _move_entry(self, entry):
1368
 
        inv = self.inventory
1369
 
        from_rel_abs = self.abspath(entry.from_rel)
1370
 
        to_rel_abs = self.abspath(entry.to_rel)
1371
 
        if from_rel_abs == to_rel_abs:
1372
 
            raise errors.BzrMoveFailedError(entry.from_rel, entry.to_rel,
1373
 
                "Source and target are identical.")
1374
 
 
1375
 
        if not entry.only_change_inv:
1376
 
            try:
1377
 
                osutils.rename(from_rel_abs, to_rel_abs)
1378
 
            except OSError, e:
1379
 
                raise errors.BzrMoveFailedError(entry.from_rel,
1380
 
                    entry.to_rel, e[1])
1381
 
        inv.rename(entry.from_id, entry.to_parent_id, entry.to_tail)
1382
 
 
1383
 
    @needs_tree_write_lock
1384
 
    def rename_one(self, from_rel, to_rel, after=False):
 
833
        return result
 
834
 
 
835
    @needs_write_lock
 
836
    def rename_one(self, from_rel, to_rel):
1385
837
        """Rename one file.
1386
838
 
1387
839
        This can change the directory or the filename or both.
1388
 
 
1389
 
        rename_one has several 'modes' to work. First, it can rename a physical
1390
 
        file and change the file_id. That is the normal mode. Second, it can
1391
 
        only change the file_id without touching any physical file. This is
1392
 
        the new mode introduced in version 0.15.
1393
 
 
1394
 
        rename_one uses the second mode if 'after == True' and 'to_rel' is not
1395
 
        versioned but present in the working tree.
1396
 
 
1397
 
        rename_one uses the second mode if 'after == False' and 'from_rel' is
1398
 
        versioned but no longer in the working tree, and 'to_rel' is not
1399
 
        versioned but present in the working tree.
1400
 
 
1401
 
        rename_one uses the first mode if 'after == False' and 'from_rel' is
1402
 
        versioned and present in the working tree, and 'to_rel' is not
1403
 
        versioned and not present in the working tree.
1404
 
 
1405
 
        Everything else results in an error.
1406
840
        """
1407
841
        inv = self.inventory
1408
 
        rename_entries = []
1409
 
 
1410
 
        # create rename entries and tuples
1411
 
        from_tail = splitpath(from_rel)[-1]
1412
 
        from_id = inv.path2id(from_rel)
1413
 
        if from_id is None:
1414
 
            raise errors.BzrRenameFailedError(from_rel,to_rel,
1415
 
                errors.NotVersionedError(path=str(from_rel)))
1416
 
        from_entry = inv[from_id]
1417
 
        from_parent_id = from_entry.parent_id
 
842
        if not self.has_filename(from_rel):
 
843
            raise BzrError("can't rename: old working file %r does not exist" % from_rel)
 
844
        if self.has_filename(to_rel):
 
845
            raise BzrError("can't rename: new working file %r already exists" % to_rel)
 
846
 
 
847
        file_id = inv.path2id(from_rel)
 
848
        if file_id == None:
 
849
            raise BzrError("can't rename: old name %r is not versioned" % from_rel)
 
850
 
 
851
        entry = inv[file_id]
 
852
        from_parent = entry.parent_id
 
853
        from_name = entry.name
 
854
        
 
855
        if inv.path2id(to_rel):
 
856
            raise BzrError("can't rename: new name %r is already versioned" % to_rel)
 
857
 
1418
858
        to_dir, to_tail = os.path.split(to_rel)
1419
859
        to_dir_id = inv.path2id(to_dir)
1420
 
        rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
1421
 
                                     from_id=from_id,
1422
 
                                     from_tail=from_tail,
1423
 
                                     from_parent_id=from_parent_id,
1424
 
                                     to_rel=to_rel, to_tail=to_tail,
1425
 
                                     to_parent_id=to_dir_id)
1426
 
        rename_entries.append(rename_entry)
1427
 
 
1428
 
        # determine which move mode to use. checks also for movability
1429
 
        rename_entries = self._determine_mv_mode(rename_entries, after)
1430
 
 
1431
 
        # check if the target changed directory and if the target directory is
1432
 
        # versioned
1433
 
        if to_dir_id is None:
1434
 
            raise errors.BzrMoveFailedError(from_rel,to_rel,
1435
 
                errors.NotVersionedError(path=str(to_dir)))
1436
 
 
1437
 
        # all checks done. now we can continue with our actual work
1438
 
        mutter('rename_one:\n'
1439
 
               '  from_id   {%s}\n'
1440
 
               '  from_rel: %r\n'
1441
 
               '  to_rel:   %r\n'
1442
 
               '  to_dir    %r\n'
1443
 
               '  to_dir_id {%s}\n',
1444
 
               from_id, from_rel, to_rel, to_dir, to_dir_id)
1445
 
 
1446
 
        self._move(rename_entries)
 
860
        if to_dir_id == None and to_dir != '':
 
861
            raise BzrError("can't determine destination directory id for %r" % to_dir)
 
862
 
 
863
        mutter("rename_one:")
 
864
        mutter("  file_id    {%s}" % file_id)
 
865
        mutter("  from_rel   %r" % from_rel)
 
866
        mutter("  to_rel     %r" % to_rel)
 
867
        mutter("  to_dir     %r" % to_dir)
 
868
        mutter("  to_dir_id  {%s}" % to_dir_id)
 
869
 
 
870
        inv.rename(file_id, to_dir_id, to_tail)
 
871
 
 
872
        from_abs = self.abspath(from_rel)
 
873
        to_abs = self.abspath(to_rel)
 
874
        try:
 
875
            rename(from_abs, to_abs)
 
876
        except OSError, e:
 
877
            inv.rename(file_id, from_parent, from_name)
 
878
            raise BzrError("failed to rename %r to %r: %s"
 
879
                    % (from_abs, to_abs, e[1]),
 
880
                    ["rename rolled back"])
1447
881
        self._write_inventory(inv)
1448
882
 
1449
 
    class _RenameEntry(object):
1450
 
        def __init__(self, from_rel, from_id, from_tail, from_parent_id,
1451
 
                     to_rel, to_tail, to_parent_id, only_change_inv=False):
1452
 
            self.from_rel = from_rel
1453
 
            self.from_id = from_id
1454
 
            self.from_tail = from_tail
1455
 
            self.from_parent_id = from_parent_id
1456
 
            self.to_rel = to_rel
1457
 
            self.to_tail = to_tail
1458
 
            self.to_parent_id = to_parent_id
1459
 
            self.only_change_inv = only_change_inv
1460
 
 
1461
883
    @needs_read_lock
1462
884
    def unknowns(self):
1463
885
        """Return all unknown files.
1464
886
 
1465
887
        These are files in the working directory that are not versioned or
1466
888
        control files or ignored.
1467
 
        """
1468
 
        # force the extras method to be fully executed before returning, to 
1469
 
        # prevent race conditions with the lock
1470
 
        return iter(
1471
 
            [subp for subp in self.extras() if not self.is_ignored(subp)])
1472
 
 
1473
 
    @needs_tree_write_lock
1474
 
    def unversion(self, file_ids):
1475
 
        """Remove the file ids in file_ids from the current versioned set.
1476
 
 
1477
 
        When a file_id is unversioned, all of its children are automatically
1478
 
        unversioned.
1479
 
 
1480
 
        :param file_ids: The file ids to stop versioning.
1481
 
        :raises: NoSuchId if any fileid is not currently versioned.
1482
 
        """
1483
 
        for file_id in file_ids:
1484
 
            if self._inventory.has_id(file_id):
1485
 
                self._inventory.remove_recursive_id(file_id)
1486
 
            else:
1487
 
                raise errors.NoSuchId(self, file_id)
1488
 
        if len(file_ids):
1489
 
            # in the future this should just set a dirty bit to wait for the 
1490
 
            # final unlock. However, until all methods of workingtree start
1491
 
            # with the current in -memory inventory rather than triggering 
1492
 
            # a read, it is more complex - we need to teach read_inventory
1493
 
            # to know when to read, and when to not read first... and possibly
1494
 
            # to save first when the in memory one may be corrupted.
1495
 
            # so for now, we just only write it if it is indeed dirty.
1496
 
            # - RBC 20060907
1497
 
            self._write_inventory(self._inventory)
1498
 
    
 
889
        
 
890
        >>> from bzrlib.bzrdir import ScratchDir
 
891
        >>> d = ScratchDir(files=['foo', 'foo~'])
 
892
        >>> b = d.open_branch()
 
893
        >>> tree = d.open_workingtree()
 
894
        >>> map(str, tree.unknowns())
 
895
        ['foo']
 
896
        >>> tree.add('foo')
 
897
        >>> list(b.unknowns())
 
898
        []
 
899
        >>> tree.remove('foo')
 
900
        >>> list(b.unknowns())
 
901
        [u'foo']
 
902
        """
 
903
        for subp in self.extras():
 
904
            if not self.is_ignored(subp):
 
905
                yield subp
 
906
 
 
907
    @deprecated_method(zero_eight)
 
908
    def iter_conflicts(self):
 
909
        """List all files in the tree that have text or content conflicts.
 
910
        DEPRECATED.  Use conflicts instead."""
 
911
        return self._iter_conflicts()
 
912
 
1499
913
    def _iter_conflicts(self):
1500
914
        conflicted = set()
1501
 
        for info in self.list_files():
1502
 
            path = info[0]
 
915
        for path in (s[0] for s in self.list_files()):
1503
916
            stem = get_conflicted_stem(path)
1504
917
            if stem is None:
1505
918
                continue
1508
921
                yield stem
1509
922
 
1510
923
    @needs_write_lock
1511
 
    def pull(self, source, overwrite=False, stop_revision=None,
1512
 
             change_reporter=None, possible_transports=None):
 
924
    def pull(self, source, overwrite=False, stop_revision=None):
1513
925
        top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1514
926
        source.lock_read()
1515
927
        try:
1516
928
            pp = ProgressPhase("Pull phase", 2, top_pb)
1517
929
            pp.next_phase()
1518
 
            old_revision_info = self.branch.last_revision_info()
 
930
            old_revision_history = self.branch.revision_history()
1519
931
            basis_tree = self.basis_tree()
1520
 
            count = self.branch.pull(source, overwrite, stop_revision,
1521
 
                                     possible_transports=possible_transports)
1522
 
            new_revision_info = self.branch.last_revision_info()
1523
 
            if new_revision_info != old_revision_info:
 
932
            count = self.branch.pull(source, overwrite, stop_revision)
 
933
            new_revision_history = self.branch.revision_history()
 
934
            if new_revision_history != old_revision_history:
1524
935
                pp.next_phase()
 
936
                if len(old_revision_history):
 
937
                    other_revision = old_revision_history[-1]
 
938
                else:
 
939
                    other_revision = None
1525
940
                repository = self.branch.repository
1526
941
                pb = bzrlib.ui.ui_factory.nested_progress_bar()
1527
 
                basis_tree.lock_read()
1528
942
                try:
1529
 
                    new_basis_tree = self.branch.basis_tree()
1530
 
                    merge.merge_inner(
1531
 
                                self.branch,
1532
 
                                new_basis_tree,
1533
 
                                basis_tree,
1534
 
                                this_tree=self,
1535
 
                                pb=pb,
1536
 
                                change_reporter=change_reporter)
1537
 
                    if (basis_tree.inventory.root is None and
1538
 
                        new_basis_tree.inventory.root is not None):
1539
 
                        self.set_root_id(new_basis_tree.get_root_id())
 
943
                    merge_inner(self.branch,
 
944
                                self.branch.basis_tree(),
 
945
                                basis_tree, 
 
946
                                this_tree=self, 
 
947
                                pb=pb)
1540
948
                finally:
1541
949
                    pb.finished()
1542
 
                    basis_tree.unlock()
1543
 
                # TODO - dedup parents list with things merged by pull ?
1544
 
                # reuse the revisiontree we merged against to set the new
1545
 
                # tree data.
1546
 
                parent_trees = [(self.branch.last_revision(), new_basis_tree)]
1547
 
                # we have to pull the merge trees out again, because 
1548
 
                # merge_inner has set the ids. - this corner is not yet 
1549
 
                # layered well enough to prevent double handling.
1550
 
                # XXX TODO: Fix the double handling: telling the tree about
1551
 
                # the already known parent data is wasteful.
1552
 
                merges = self.get_parent_ids()[1:]
1553
 
                parent_trees.extend([
1554
 
                    (parent, repository.revision_tree(parent)) for
1555
 
                     parent in merges])
1556
 
                self.set_parent_trees(parent_trees)
 
950
                self.set_last_revision(self.branch.last_revision())
1557
951
            return count
1558
952
        finally:
1559
953
            source.unlock()
1560
954
            top_pb.finished()
1561
955
 
1562
 
    @needs_write_lock
1563
 
    def put_file_bytes_non_atomic(self, file_id, bytes):
1564
 
        """See MutableTree.put_file_bytes_non_atomic."""
1565
 
        stream = file(self.id2abspath(file_id), 'wb')
1566
 
        try:
1567
 
            stream.write(bytes)
1568
 
        finally:
1569
 
            stream.close()
1570
 
        # TODO: update the hashcache here ?
1571
 
 
1572
956
    def extras(self):
1573
 
        """Yield all unversioned files in this WorkingTree.
 
957
        """Yield all unknown files in this WorkingTree.
1574
958
 
1575
 
        If there are any unversioned directories then only the directory is
1576
 
        returned, not all its children.  But if there are unversioned files
 
959
        If there are any unknown directories then only the directory is
 
960
        returned, not all its children.  But if there are unknown files
1577
961
        under a versioned subdirectory, they are returned.
1578
962
 
1579
963
        Currently returned depth-first, sorted by name within directories.
1580
 
        This is the same order used by 'osutils.walkdirs'.
1581
964
        """
1582
965
        ## TODO: Work from given directory downwards
1583
966
        for path, dir_entry in self.inventory.directories():
1584
 
            # mutter("search for unknowns in %r", path)
 
967
            mutter("search for unknowns in %r", path)
1585
968
            dirabs = self.abspath(path)
1586
969
            if not isdir(dirabs):
1587
970
                # e.g. directory deleted
1589
972
 
1590
973
            fl = []
1591
974
            for subf in os.listdir(dirabs):
1592
 
                if subf == '.bzr':
1593
 
                    continue
1594
 
                if subf not in dir_entry.children:
1595
 
                    try:
1596
 
                        (subf_norm,
1597
 
                         can_access) = osutils.normalized_filename(subf)
1598
 
                    except UnicodeDecodeError:
1599
 
                        path_os_enc = path.encode(osutils._fs_enc)
1600
 
                        relpath = path_os_enc + '/' + subf
1601
 
                        raise errors.BadFilenameEncoding(relpath,
1602
 
                                                         osutils._fs_enc)
1603
 
                    if subf_norm != subf and can_access:
1604
 
                        if subf_norm not in dir_entry.children:
1605
 
                            fl.append(subf_norm)
1606
 
                    else:
1607
 
                        fl.append(subf)
 
975
                if (subf != '.bzr'
 
976
                    and (subf not in dir_entry.children)):
 
977
                    fl.append(subf)
1608
978
            
1609
979
            fl.sort()
1610
980
            for subf in fl:
1611
 
                subp = pathjoin(path, subf)
 
981
                subp = appendpath(path, subf)
1612
982
                yield subp
1613
983
 
 
984
    def _translate_ignore_rule(self, rule):
 
985
        """Translate a single ignore rule to a regex.
 
986
 
 
987
        There are two types of ignore rules.  Those that do not contain a / are
 
988
        matched against the tail of the filename (that is, they do not care
 
989
        what directory the file is in.)  Rules which do contain a slash must
 
990
        match the entire path.  As a special case, './' at the start of the
 
991
        string counts as a slash in the string but is removed before matching
 
992
        (e.g. ./foo.c, ./src/foo.c)
 
993
 
 
994
        :return: The translated regex.
 
995
        """
 
996
        if rule[:2] in ('./', '.\\'):
 
997
            # rootdir rule
 
998
            result = fnmatch.translate(rule[2:])
 
999
        elif '/' in rule or '\\' in rule:
 
1000
            # path prefix 
 
1001
            result = fnmatch.translate(rule)
 
1002
        else:
 
1003
            # default rule style.
 
1004
            result = "(?:.*/)?(?!.*/)" + fnmatch.translate(rule)
 
1005
        assert result[-1] == '$', "fnmatch.translate did not add the expected $"
 
1006
        return "(" + result + ")"
 
1007
 
 
1008
    def _combine_ignore_rules(self, rules):
 
1009
        """Combine a list of ignore rules into a single regex object.
 
1010
 
 
1011
        Each individual rule is combined with | to form a big regex, which then
 
1012
        has $ added to it to form something like ()|()|()$. The group index for
 
1013
        each subregex's outermost group is placed in a dictionary mapping back 
 
1014
        to the rule. This allows quick identification of the matching rule that
 
1015
        triggered a match.
 
1016
        :return: a list of the compiled regex and the matching-group index 
 
1017
        dictionaries. We return a list because python complains if you try to 
 
1018
        combine more than 100 regexes.
 
1019
        """
 
1020
        result = []
 
1021
        groups = {}
 
1022
        next_group = 0
 
1023
        translated_rules = []
 
1024
        for rule in rules:
 
1025
            translated_rule = self._translate_ignore_rule(rule)
 
1026
            compiled_rule = re.compile(translated_rule)
 
1027
            groups[next_group] = rule
 
1028
            next_group += compiled_rule.groups
 
1029
            translated_rules.append(translated_rule)
 
1030
            if next_group == 99:
 
1031
                result.append((re.compile("|".join(translated_rules)), groups))
 
1032
                groups = {}
 
1033
                next_group = 0
 
1034
                translated_rules = []
 
1035
        if len(translated_rules):
 
1036
            result.append((re.compile("|".join(translated_rules)), groups))
 
1037
        return result
 
1038
 
1614
1039
    def ignored_files(self):
1615
1040
        """Yield list of PATH, IGNORE_PATTERN"""
1616
1041
        for subp in self.extras():
1617
1042
            pat = self.is_ignored(subp)
1618
 
            if pat is not None:
 
1043
            if pat != None:
1619
1044
                yield subp, pat
1620
1045
 
1621
1046
    def get_ignore_list(self):
1623
1048
 
1624
1049
        Cached in the Tree object after the first call.
1625
1050
        """
1626
 
        ignoreset = getattr(self, '_ignoreset', None)
1627
 
        if ignoreset is not None:
1628
 
            return ignoreset
 
1051
        if hasattr(self, '_ignorelist'):
 
1052
            return self._ignorelist
1629
1053
 
1630
 
        ignore_globs = set()
1631
 
        ignore_globs.update(ignores.get_runtime_ignores())
1632
 
        ignore_globs.update(ignores.get_user_ignores())
 
1054
        l = bzrlib.DEFAULT_IGNORE[:]
1633
1055
        if self.has_filename(bzrlib.IGNORE_FILENAME):
1634
1056
            f = self.get_file_byname(bzrlib.IGNORE_FILENAME)
1635
 
            try:
1636
 
                ignore_globs.update(ignores.parse_ignore_file(f))
1637
 
            finally:
1638
 
                f.close()
1639
 
        self._ignoreset = ignore_globs
1640
 
        return ignore_globs
1641
 
 
1642
 
    def _flush_ignore_list_cache(self):
1643
 
        """Resets the cached ignore list to force a cache rebuild."""
1644
 
        self._ignoreset = None
1645
 
        self._ignoreglobster = None
 
1057
            l.extend([line.rstrip("\n\r") for line in f.readlines()])
 
1058
        self._ignorelist = l
 
1059
        self._ignore_regex = self._combine_ignore_rules(l)
 
1060
        return l
 
1061
 
 
1062
    def _get_ignore_rules_as_regex(self):
 
1063
        """Return a regex of the ignore rules and a mapping dict.
 
1064
 
 
1065
        :return: (ignore rules compiled regex, dictionary mapping rule group 
 
1066
        indices to original rule.)
 
1067
        """
 
1068
        if getattr(self, '_ignorelist', None) is None:
 
1069
            self.get_ignore_list()
 
1070
        return self._ignore_regex
1646
1071
 
1647
1072
    def is_ignored(self, filename):
1648
1073
        r"""Check whether the filename matches an ignore pattern.
1653
1078
        If the file is ignored, returns the pattern which caused it to
1654
1079
        be ignored, otherwise None.  So this can simply be used as a
1655
1080
        boolean if desired."""
1656
 
        if getattr(self, '_ignoreglobster', None) is None:
1657
 
            self._ignoreglobster = globbing.Globster(self.get_ignore_list())
1658
 
        return self._ignoreglobster.match(filename)
 
1081
 
 
1082
        # TODO: Use '**' to match directories, and other extended
 
1083
        # globbing stuff from cvs/rsync.
 
1084
 
 
1085
        # XXX: fnmatch is actually not quite what we want: it's only
 
1086
        # approximately the same as real Unix fnmatch, and doesn't
 
1087
        # treat dotfiles correctly and allows * to match /.
 
1088
        # Eventually it should be replaced with something more
 
1089
        # accurate.
 
1090
    
 
1091
        rules = self._get_ignore_rules_as_regex()
 
1092
        for regex, mapping in rules:
 
1093
            match = regex.match(filename)
 
1094
            if match is not None:
 
1095
                # one or more of the groups in mapping will have a non-None group 
 
1096
                # match.
 
1097
                groups = match.groups()
 
1098
                rules = [mapping[group] for group in 
 
1099
                    mapping if groups[group] is not None]
 
1100
                return rules[0]
 
1101
        return None
1659
1102
 
1660
1103
    def kind(self, file_id):
1661
1104
        return file_kind(self.id2abspath(file_id))
1662
1105
 
1663
 
    def stored_kind(self, file_id):
1664
 
        """See Tree.stored_kind"""
1665
 
        return self.inventory[file_id].kind
1666
 
 
1667
 
    def _comparison_data(self, entry, path):
1668
 
        abspath = self.abspath(path)
1669
 
        try:
1670
 
            stat_value = os.lstat(abspath)
1671
 
        except OSError, e:
1672
 
            if getattr(e, 'errno', None) == errno.ENOENT:
1673
 
                stat_value = None
1674
 
                kind = None
1675
 
                executable = False
1676
 
            else:
1677
 
                raise
1678
 
        else:
1679
 
            mode = stat_value.st_mode
1680
 
            kind = osutils.file_kind_from_stat_mode(mode)
1681
 
            if not supports_executable():
1682
 
                executable = entry is not None and entry.executable
1683
 
            else:
1684
 
                executable = bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
1685
 
        return kind, executable, stat_value
1686
 
 
1687
 
    def _file_size(self, entry, stat_value):
1688
 
        return stat_value.st_size
1689
 
 
 
1106
    @needs_read_lock
1690
1107
    def last_revision(self):
1691
 
        """Return the last revision of the branch for this tree.
1692
 
 
1693
 
        This format tree does not support a separate marker for last-revision
1694
 
        compared to the branch.
1695
 
 
1696
 
        See MutableTree.last_revision
 
1108
        """Return the last revision id of this working tree.
 
1109
 
 
1110
        In early branch formats this was == the branch last_revision,
 
1111
        but that cannot be relied upon - for working tree operations,
 
1112
        always use tree.last_revision().
1697
1113
        """
1698
 
        return self._last_revision()
1699
 
 
1700
 
    @needs_read_lock
1701
 
    def _last_revision(self):
1702
 
        """helper for get_parent_ids."""
1703
 
        return _mod_revision.ensure_null(self.branch.last_revision())
 
1114
        return self.branch.last_revision()
1704
1115
 
1705
1116
    def is_locked(self):
1706
1117
        return self._control_files.is_locked()
1707
1118
 
1708
 
    def _must_be_locked(self):
1709
 
        if not self.is_locked():
1710
 
            raise errors.ObjectNotLocked(self)
1711
 
 
1712
1119
    def lock_read(self):
1713
1120
        """See Branch.lock_read, and WorkingTree.unlock."""
1714
 
        if not self.is_locked():
1715
 
            self._reset_data()
1716
1121
        self.branch.lock_read()
1717
1122
        try:
1718
1123
            return self._control_files.lock_read()
1720
1125
            self.branch.unlock()
1721
1126
            raise
1722
1127
 
1723
 
    def lock_tree_write(self):
1724
 
        """See MutableTree.lock_tree_write, and WorkingTree.unlock."""
1725
 
        if not self.is_locked():
1726
 
            self._reset_data()
1727
 
        self.branch.lock_read()
1728
 
        try:
1729
 
            return self._control_files.lock_write()
1730
 
        except:
1731
 
            self.branch.unlock()
1732
 
            raise
1733
 
 
1734
1128
    def lock_write(self):
1735
 
        """See MutableTree.lock_write, and WorkingTree.unlock."""
1736
 
        if not self.is_locked():
1737
 
            self._reset_data()
 
1129
        """See Branch.lock_write, and WorkingTree.unlock."""
1738
1130
        self.branch.lock_write()
1739
1131
        try:
1740
1132
            return self._control_files.lock_write()
1746
1138
        return self._control_files.get_physical_lock_status()
1747
1139
 
1748
1140
    def _basis_inventory_name(self):
1749
 
        return 'basis-inventory-cache'
1750
 
 
1751
 
    def _reset_data(self):
1752
 
        """Reset transient data that cannot be revalidated."""
1753
 
        self._inventory_is_modified = False
1754
 
        result = self._deserialize(self._transport.get('inventory'))
1755
 
        self._set_inventory(result, dirty=False)
1756
 
 
1757
 
    @needs_tree_write_lock
 
1141
        return 'basis-inventory'
 
1142
 
 
1143
    @needs_write_lock
1758
1144
    def set_last_revision(self, new_revision):
1759
1145
        """Change the last revision in the working tree."""
1760
1146
        if self._change_last_revision(new_revision):
1766
1152
        This is used to allow WorkingTree3 instances to not affect branch
1767
1153
        when their last revision is set.
1768
1154
        """
1769
 
        if _mod_revision.is_null(new_revision):
 
1155
        if new_revision is None:
1770
1156
            self.branch.set_revision_history([])
1771
1157
            return False
 
1158
        # current format is locked in with the branch
 
1159
        revision_history = self.branch.revision_history()
1772
1160
        try:
1773
 
            self.branch.generate_revision_history(new_revision)
1774
 
        except errors.NoSuchRevision:
1775
 
            # not present in the repo - dont try to set it deeper than the tip
1776
 
            self.branch.set_revision_history([new_revision])
 
1161
            position = revision_history.index(new_revision)
 
1162
        except ValueError:
 
1163
            raise errors.NoSuchRevision(self.branch, new_revision)
 
1164
        self.branch.set_revision_history(revision_history[:position + 1])
1777
1165
        return True
1778
1166
 
1779
 
    def _write_basis_inventory(self, xml):
1780
 
        """Write the basis inventory XML to the basis-inventory file"""
1781
 
        path = self._basis_inventory_name()
1782
 
        sio = StringIO(xml)
1783
 
        self._transport.put_file(path, sio,
1784
 
            mode=self._control_files._file_mode)
1785
 
 
1786
 
    def _create_basis_xml_from_inventory(self, revision_id, inventory):
1787
 
        """Create the text that will be saved in basis-inventory"""
1788
 
        inventory.revision_id = revision_id
1789
 
        return xml7.serializer_v7.write_inventory_to_string(inventory)
1790
 
 
1791
1167
    def _cache_basis_inventory(self, new_revision):
1792
1168
        """Cache new_revision as the basis inventory."""
1793
 
        # TODO: this should allow the ready-to-use inventory to be passed in,
1794
 
        # as commit already has that ready-to-use [while the format is the
1795
 
        # same, that is].
1796
1169
        try:
1797
1170
            # this double handles the inventory - unpack and repack - 
1798
1171
            # but is easier to understand. We can/should put a conditional
1799
1172
            # in here based on whether the inventory is in the latest format
1800
1173
            # - perhaps we should repack all inventories on a repository
1801
1174
            # upgrade ?
1802
 
            # the fast path is to copy the raw xml from the repository. If the
1803
 
            # xml contains 'revision_id="', then we assume the right 
1804
 
            # revision_id is set. We must check for this full string, because a
1805
 
            # root node id can legitimately look like 'revision_id' but cannot
1806
 
            # contain a '"'.
1807
 
            xml = self.branch.repository.get_inventory_xml(new_revision)
1808
 
            firstline = xml.split('\n', 1)[0]
1809
 
            if (not 'revision_id="' in firstline or 
1810
 
                'format="7"' not in firstline):
1811
 
                inv = self.branch.repository.deserialise_inventory(
1812
 
                    new_revision, xml)
1813
 
                xml = self._create_basis_xml_from_inventory(new_revision, inv)
1814
 
            self._write_basis_inventory(xml)
1815
 
        except (errors.NoSuchRevision, errors.RevisionNotPresent):
 
1175
            inv = self.branch.repository.get_inventory(new_revision)
 
1176
            inv.revision_id = new_revision
 
1177
            xml = bzrlib.xml5.serializer_v5.write_inventory_to_string(inv)
 
1178
 
 
1179
            path = self._basis_inventory_name()
 
1180
            self._control_files.put_utf8(path, xml)
 
1181
        except WeaveRevisionNotPresent:
1816
1182
            pass
1817
1183
 
1818
1184
    def read_basis_inventory(self):
1819
1185
        """Read the cached basis inventory."""
1820
1186
        path = self._basis_inventory_name()
1821
 
        return self._transport.get_bytes(path)
 
1187
        return self._control_files.get_utf8(path).read()
1822
1188
        
1823
1189
    @needs_read_lock
1824
1190
    def read_working_inventory(self):
1825
 
        """Read the working inventory.
1826
 
        
1827
 
        :raises errors.InventoryModified: read_working_inventory will fail
1828
 
            when the current in memory inventory has been modified.
1829
 
        """
1830
 
        # conceptually this should be an implementation detail of the tree. 
1831
 
        # XXX: Deprecate this.
 
1191
        """Read the working inventory."""
1832
1192
        # ElementTree does its own conversion from UTF-8, so open in
1833
1193
        # binary.
1834
 
        if self._inventory_is_modified:
1835
 
            raise errors.InventoryModified(self)
1836
 
        result = self._deserialize(self._transport.get('inventory'))
1837
 
        self._set_inventory(result, dirty=False)
 
1194
        result = bzrlib.xml5.serializer_v5.read_inventory(
 
1195
            self._control_files.get('inventory'))
 
1196
        self._set_inventory(result)
1838
1197
        return result
1839
1198
 
1840
 
    @needs_tree_write_lock
1841
 
    def remove(self, files, verbose=False, to_file=None, keep_files=True,
1842
 
        force=False):
1843
 
        """Remove nominated files from the working inventory.
1844
 
 
1845
 
        :files: File paths relative to the basedir.
1846
 
        :keep_files: If true, the files will also be kept.
1847
 
        :force: Delete files and directories, even if they are changed and
1848
 
            even if the directories are not empty.
 
1199
    @needs_write_lock
 
1200
    def remove(self, files, verbose=False):
 
1201
        """Remove nominated files from the working inventory..
 
1202
 
 
1203
        This does not remove their text.  This does not run on XXX on what? RBC
 
1204
 
 
1205
        TODO: Refuse to remove modified files unless --force is given?
 
1206
 
 
1207
        TODO: Do something useful with directories.
 
1208
 
 
1209
        TODO: Should this remove the text or not?  Tough call; not
 
1210
        removing may be useful and the user can just use use rm, and
 
1211
        is the opposite of add.  Removing it is consistent with most
 
1212
        other tools.  Maybe an option.
1849
1213
        """
 
1214
        ## TODO: Normalize names
 
1215
        ## TODO: Remove nested loops; better scalability
1850
1216
        if isinstance(files, basestring):
1851
1217
            files = [files]
1852
1218
 
1853
 
        inv_delta = []
1854
 
 
1855
 
        new_files=set()
1856
 
        unknown_nested_files=set()
1857
 
 
1858
 
        def recurse_directory_to_add_files(directory):
1859
 
            # Recurse directory and add all files
1860
 
            # so we can check if they have changed.
1861
 
            for parent_info, file_infos in\
1862
 
                self.walkdirs(directory):
1863
 
                for relpath, basename, kind, lstat, fileid, kind in file_infos:
1864
 
                    # Is it versioned or ignored?
1865
 
                    if self.path2id(relpath) or self.is_ignored(relpath):
1866
 
                        # Add nested content for deletion.
1867
 
                        new_files.add(relpath)
1868
 
                    else:
1869
 
                        # Files which are not versioned and not ignored
1870
 
                        # should be treated as unknown.
1871
 
                        unknown_nested_files.add((relpath, None, kind))
1872
 
 
1873
 
        for filename in files:
1874
 
            # Get file name into canonical form.
1875
 
            abspath = self.abspath(filename)
1876
 
            filename = self.relpath(abspath)
1877
 
            if len(filename) > 0:
1878
 
                new_files.add(filename)
1879
 
                recurse_directory_to_add_files(filename)
1880
 
 
1881
 
        files = list(new_files)
1882
 
 
1883
 
        if len(files) == 0:
1884
 
            return # nothing to do
1885
 
 
1886
 
        # Sort needed to first handle directory content before the directory
1887
 
        files.sort(reverse=True)
1888
 
 
1889
 
        # Bail out if we are going to delete files we shouldn't
1890
 
        if not keep_files and not force:
1891
 
            has_changed_files = len(unknown_nested_files) > 0
1892
 
            if not has_changed_files:
1893
 
                for (file_id, path, content_change, versioned, parent_id, name,
1894
 
                     kind, executable) in self.iter_changes(self.basis_tree(),
1895
 
                         include_unchanged=True, require_versioned=False,
1896
 
                         want_unversioned=True, specific_files=files):
1897
 
                    if versioned == (False, False):
1898
 
                        # The record is unknown ...
1899
 
                        if not self.is_ignored(path[1]):
1900
 
                            # ... but not ignored
1901
 
                            has_changed_files = True
1902
 
                            break
1903
 
                    elif content_change and (kind[1] is not None):
1904
 
                        # Versioned and changed, but not deleted
1905
 
                        has_changed_files = True
1906
 
                        break
1907
 
 
1908
 
            if has_changed_files:
1909
 
                # Make delta show ALL applicable changes in error message.
1910
 
                tree_delta = self.changes_from(self.basis_tree(),
1911
 
                    require_versioned=False, want_unversioned=True,
1912
 
                    specific_files=files)
1913
 
                for unknown_file in unknown_nested_files:
1914
 
                    if unknown_file not in tree_delta.unversioned:
1915
 
                        tree_delta.unversioned.extend((unknown_file,))
1916
 
                raise errors.BzrRemoveChangedFilesError(tree_delta)
1917
 
 
1918
 
        # Build inv_delta and delete files where applicaple,
1919
 
        # do this before any modifications to inventory.
 
1219
        inv = self.inventory
 
1220
 
 
1221
        # do this before any modifications
1920
1222
        for f in files:
1921
 
            fid = self.path2id(f)
1922
 
            message = None
 
1223
            fid = inv.path2id(f)
1923
1224
            if not fid:
1924
 
                message = "%s is not versioned." % (f,)
1925
 
            else:
1926
 
                if verbose:
1927
 
                    # having removed it, it must be either ignored or unknown
1928
 
                    if self.is_ignored(f):
1929
 
                        new_status = 'I'
1930
 
                    else:
1931
 
                        new_status = '?'
1932
 
                    textui.show_status(new_status, self.kind(fid), f,
1933
 
                                       to_file=to_file)
1934
 
                # Unversion file
1935
 
                inv_delta.append((f, None, fid, None))
1936
 
                message = "removed %s" % (f,)
1937
 
 
1938
 
            if not keep_files:
1939
 
                abs_path = self.abspath(f)
1940
 
                if osutils.lexists(abs_path):
1941
 
                    if (osutils.isdir(abs_path) and
1942
 
                        len(os.listdir(abs_path)) > 0):
1943
 
                        if force:
1944
 
                            osutils.rmtree(abs_path)
1945
 
                        else:
1946
 
                            message = "%s is not an empty directory "\
1947
 
                                "and won't be deleted." % (f,)
1948
 
                    else:
1949
 
                        osutils.delete_any(abs_path)
1950
 
                        message = "deleted %s" % (f,)
1951
 
                elif message is not None:
1952
 
                    # Only care if we haven't done anything yet.
1953
 
                    message = "%s does not exist." % (f,)
1954
 
 
1955
 
            # Print only one message (if any) per file.
1956
 
            if message is not None:
1957
 
                note(message)
1958
 
        self.apply_inventory_delta(inv_delta)
1959
 
 
1960
 
    @needs_tree_write_lock
1961
 
    def revert(self, filenames=None, old_tree=None, backups=True,
1962
 
               pb=DummyProgress(), report_changes=False):
1963
 
        from bzrlib.conflicts import resolve
1964
 
        if filenames == []:
1965
 
            filenames = None
1966
 
            symbol_versioning.warn('Using [] to revert all files is deprecated'
1967
 
                ' as of bzr 0.91.  Please use None (the default) instead.',
1968
 
                DeprecationWarning, stacklevel=2)
 
1225
                # TODO: Perhaps make this just a warning, and continue?
 
1226
                # This tends to happen when 
 
1227
                raise NotVersionedError(path=f)
 
1228
            mutter("remove inventory entry %s {%s}", quotefn(f), fid)
 
1229
            if verbose:
 
1230
                # having remove it, it must be either ignored or unknown
 
1231
                if self.is_ignored(f):
 
1232
                    new_status = 'I'
 
1233
                else:
 
1234
                    new_status = '?'
 
1235
                show_status(new_status, inv[fid].kind, quotefn(f))
 
1236
            del inv[fid]
 
1237
 
 
1238
        self._write_inventory(inv)
 
1239
 
 
1240
    @needs_write_lock
 
1241
    def revert(self, filenames, old_tree=None, backups=True, 
 
1242
               pb=DummyProgress()):
 
1243
        from transform import revert
 
1244
        from conflicts import resolve
1969
1245
        if old_tree is None:
1970
 
            basis_tree = self.basis_tree()
1971
 
            basis_tree.lock_read()
1972
 
            old_tree = basis_tree
 
1246
            old_tree = self.basis_tree()
 
1247
        conflicts = revert(self, old_tree, filenames, backups, pb)
 
1248
        if not len(filenames):
 
1249
            self.set_pending_merges([])
 
1250
            resolve(self)
1973
1251
        else:
1974
 
            basis_tree = None
1975
 
        try:
1976
 
            conflicts = transform.revert(self, old_tree, filenames, backups, pb,
1977
 
                                         report_changes)
1978
 
            if filenames is None and len(self.get_parent_ids()) > 1:
1979
 
                parent_trees = []
1980
 
                last_revision = self.last_revision()
1981
 
                if last_revision != NULL_REVISION:
1982
 
                    if basis_tree is None:
1983
 
                        basis_tree = self.basis_tree()
1984
 
                        basis_tree.lock_read()
1985
 
                    parent_trees.append((last_revision, basis_tree))
1986
 
                self.set_parent_trees(parent_trees)
1987
 
                resolve(self)
1988
 
            else:
1989
 
                resolve(self, filenames, ignore_misses=True, recursive=True)
1990
 
        finally:
1991
 
            if basis_tree is not None:
1992
 
                basis_tree.unlock()
 
1252
            resolve(self, filenames, ignore_misses=True)
1993
1253
        return conflicts
1994
1254
 
1995
 
    def revision_tree(self, revision_id):
1996
 
        """See Tree.revision_tree.
1997
 
 
1998
 
        WorkingTree can supply revision_trees for the basis revision only
1999
 
        because there is only one cached inventory in the bzr directory.
2000
 
        """
2001
 
        if revision_id == self.last_revision():
2002
 
            try:
2003
 
                xml = self.read_basis_inventory()
2004
 
            except errors.NoSuchFile:
2005
 
                pass
2006
 
            else:
2007
 
                try:
2008
 
                    inv = xml7.serializer_v7.read_inventory_from_string(xml)
2009
 
                    # dont use the repository revision_tree api because we want
2010
 
                    # to supply the inventory.
2011
 
                    if inv.revision_id == revision_id:
2012
 
                        return revisiontree.RevisionTree(self.branch.repository,
2013
 
                            inv, revision_id)
2014
 
                except errors.BadInventoryFormat:
2015
 
                    pass
2016
 
        # raise if there was no inventory, or if we read the wrong inventory.
2017
 
        raise errors.NoSuchRevisionInTree(self, revision_id)
2018
 
 
2019
1255
    # XXX: This method should be deprecated in favour of taking in a proper
2020
1256
    # new Inventory object.
2021
 
    @needs_tree_write_lock
 
1257
    @needs_write_lock
2022
1258
    def set_inventory(self, new_inventory_list):
2023
1259
        from bzrlib.inventory import (Inventory,
2024
1260
                                      InventoryDirectory,
2038
1274
            elif kind == 'symlink':
2039
1275
                inv.add(InventoryLink(file_id, name, parent))
2040
1276
            else:
2041
 
                raise errors.BzrError("unknown kind %r" % kind)
 
1277
                raise BzrError("unknown kind %r" % kind)
2042
1278
        self._write_inventory(inv)
2043
1279
 
2044
 
    @needs_tree_write_lock
 
1280
    @needs_write_lock
2045
1281
    def set_root_id(self, file_id):
2046
1282
        """Set the root id for this tree."""
2047
 
        # for compatability 
2048
 
        if file_id is None:
2049
 
            raise ValueError(
2050
 
                'WorkingTree.set_root_id with fileid=None')
2051
 
        file_id = osutils.safe_file_id(file_id)
2052
 
        self._set_root_id(file_id)
2053
 
 
2054
 
    def _set_root_id(self, file_id):
2055
 
        """Set the root id for this tree, in a format specific manner.
2056
 
 
2057
 
        :param file_id: The file id to assign to the root. It must not be 
2058
 
            present in the current inventory or an error will occur. It must
2059
 
            not be None, but rather a valid file id.
2060
 
        """
2061
 
        inv = self._inventory
 
1283
        inv = self.read_working_inventory()
2062
1284
        orig_root_id = inv.root.file_id
2063
 
        # TODO: it might be nice to exit early if there was nothing
2064
 
        # to do, saving us from trigger a sync on unlock.
2065
 
        self._inventory_is_modified = True
2066
 
        # we preserve the root inventory entry object, but
2067
 
        # unlinkit from the byid index
2068
1285
        del inv._byid[inv.root.file_id]
2069
1286
        inv.root.file_id = file_id
2070
 
        # and link it into the index with the new changed id.
2071
1287
        inv._byid[inv.root.file_id] = inv.root
2072
 
        # and finally update all children to reference the new id.
2073
 
        # XXX: this should be safe to just look at the root.children
2074
 
        # list, not the WHOLE INVENTORY.
2075
1288
        for fid in inv:
2076
1289
            entry = inv[fid]
2077
1290
            if entry.parent_id == orig_root_id:
2078
1291
                entry.parent_id = inv.root.file_id
 
1292
        self._write_inventory(inv)
2079
1293
 
2080
1294
    def unlock(self):
2081
1295
        """See Branch.unlock.
2086
1300
        between multiple working trees, i.e. via shared storage, then we 
2087
1301
        would probably want to lock both the local tree, and the branch.
2088
1302
        """
2089
 
        raise NotImplementedError(self.unlock)
 
1303
        # FIXME: We want to write out the hashcache only when the last lock on
 
1304
        # this working copy is released.  Peeking at the lock count is a bit
 
1305
        # of a nasty hack; probably it's better to have a transaction object,
 
1306
        # which can do some finalization when it's either successfully or
 
1307
        # unsuccessfully completed.  (Denys's original patch did that.)
 
1308
        # RBC 20060206 hookinhg into transaction will couple lock and transaction
 
1309
        # wrongly. Hookinh into unllock on the control files object is fine though.
 
1310
        
 
1311
        # TODO: split this per format so there is no ugly if block
 
1312
        if self._hashcache.needs_write and (
 
1313
            # dedicated lock files
 
1314
            self._control_files._lock_count==1 or 
 
1315
            # shared lock files
 
1316
            (self._control_files is self.branch.control_files and 
 
1317
             self._control_files._lock_count==3)):
 
1318
            self._hashcache.write()
 
1319
        # reverse order of locking.
 
1320
        try:
 
1321
            return self._control_files.unlock()
 
1322
        finally:
 
1323
            self.branch.unlock()
2090
1324
 
2091
 
    def update(self, change_reporter=None, possible_transports=None):
 
1325
    @needs_write_lock
 
1326
    def update(self):
2092
1327
        """Update a working tree along its branch.
2093
1328
 
2094
 
        This will update the branch if its bound too, which means we have
2095
 
        multiple trees involved:
2096
 
 
2097
 
        - The new basis tree of the master.
2098
 
        - The old basis tree of the branch.
2099
 
        - The old basis tree of the working tree.
2100
 
        - The current working tree state.
2101
 
 
2102
 
        Pathologically, all three may be different, and non-ancestors of each
2103
 
        other.  Conceptually we want to:
2104
 
 
2105
 
        - Preserve the wt.basis->wt.state changes
2106
 
        - Transform the wt.basis to the new master basis.
2107
 
        - Apply a merge of the old branch basis to get any 'local' changes from
2108
 
          it into the tree.
2109
 
        - Restore the wt.basis->wt.state changes.
 
1329
        This will update the branch if its bound too, which means we have multiple trees involved:
 
1330
        The new basis tree of the master.
 
1331
        The old basis tree of the branch.
 
1332
        The old basis tree of the working tree.
 
1333
        The current working tree state.
 
1334
        pathologically all three may be different, and non ancestors of each other.
 
1335
        Conceptually we want to:
 
1336
        Preserve the wt.basis->wt.state changes
 
1337
        Transform the wt.basis to the new master basis.
 
1338
        Apply a merge of the old branch basis to get any 'local' changes from it into the tree.
 
1339
        Restore the wt.basis->wt.state changes.
2110
1340
 
2111
1341
        There isn't a single operation at the moment to do that, so we:
2112
 
        - Merge current state -> basis tree of the master w.r.t. the old tree
2113
 
          basis.
2114
 
        - Do a 'normal' merge of the old branch basis if it is relevant.
2115
 
        """
2116
 
        if self.branch.get_bound_location() is not None:
2117
 
            self.lock_write()
2118
 
            update_branch = True
2119
 
        else:
2120
 
            self.lock_tree_write()
2121
 
            update_branch = False
2122
 
        try:
2123
 
            if update_branch:
2124
 
                old_tip = self.branch.update(possible_transports)
2125
 
            else:
2126
 
                old_tip = None
2127
 
            return self._update_tree(old_tip, change_reporter)
2128
 
        finally:
2129
 
            self.unlock()
2130
 
 
2131
 
    @needs_tree_write_lock
2132
 
    def _update_tree(self, old_tip=None, change_reporter=None):
2133
 
        """Update a tree to the master branch.
2134
 
 
2135
 
        :param old_tip: if supplied, the previous tip revision the branch,
2136
 
            before it was changed to the master branch's tip.
2137
 
        """
2138
 
        # here if old_tip is not None, it is the old tip of the branch before
2139
 
        # it was updated from the master branch. This should become a pending
2140
 
        # merge in the working tree to preserve the user existing work.  we
2141
 
        # cant set that until we update the working trees last revision to be
2142
 
        # one from the new branch, because it will just get absorbed by the
2143
 
        # parent de-duplication logic.
2144
 
        # 
2145
 
        # We MUST save it even if an error occurs, because otherwise the users
2146
 
        # local work is unreferenced and will appear to have been lost.
2147
 
        # 
2148
 
        result = 0
2149
 
        try:
2150
 
            last_rev = self.get_parent_ids()[0]
2151
 
        except IndexError:
2152
 
            last_rev = _mod_revision.NULL_REVISION
2153
 
        if last_rev != _mod_revision.ensure_null(self.branch.last_revision()):
2154
 
            # merge tree state up to new branch tip.
2155
 
            basis = self.basis_tree()
2156
 
            basis.lock_read()
2157
 
            try:
 
1342
        Merge current state -> basis tree of the master w.r.t. the old tree basis.
 
1343
        Do a 'normal' merge of the old branch basis if it is relevant.
 
1344
        """
 
1345
        old_tip = self.branch.update()
 
1346
        if old_tip is not None:
 
1347
            self.add_pending_merge(old_tip)
 
1348
        self.branch.lock_read()
 
1349
        try:
 
1350
            result = 0
 
1351
            if self.last_revision() != self.branch.last_revision():
 
1352
                # merge tree state up to new branch tip.
 
1353
                basis = self.basis_tree()
2158
1354
                to_tree = self.branch.basis_tree()
2159
 
                if basis.inventory.root is None:
2160
 
                    self.set_root_id(to_tree.get_root_id())
2161
 
                    self.flush()
2162
 
                result += merge.merge_inner(
2163
 
                                      self.branch,
 
1355
                result += merge_inner(self.branch,
2164
1356
                                      to_tree,
2165
1357
                                      basis,
2166
 
                                      this_tree=self,
2167
 
                                      change_reporter=change_reporter)
2168
 
            finally:
2169
 
                basis.unlock()
2170
 
            # TODO - dedup parents list with things merged by pull ?
2171
 
            # reuse the tree we've updated to to set the basis:
2172
 
            parent_trees = [(self.branch.last_revision(), to_tree)]
2173
 
            merges = self.get_parent_ids()[1:]
2174
 
            # Ideally we ask the tree for the trees here, that way the working
2175
 
            # tree can decide whether to give us teh entire tree or give us a
2176
 
            # lazy initialised tree. dirstate for instance will have the trees
2177
 
            # in ram already, whereas a last-revision + basis-inventory tree
2178
 
            # will not, but also does not need them when setting parents.
2179
 
            for parent in merges:
2180
 
                parent_trees.append(
2181
 
                    (parent, self.branch.repository.revision_tree(parent)))
2182
 
            if (old_tip is not None and not _mod_revision.is_null(old_tip)):
2183
 
                parent_trees.append(
2184
 
                    (old_tip, self.branch.repository.revision_tree(old_tip)))
2185
 
            self.set_parent_trees(parent_trees)
2186
 
            last_rev = parent_trees[0][0]
2187
 
        else:
2188
 
            # the working tree had the same last-revision as the master
2189
 
            # branch did. We may still have pivot local work from the local
2190
 
            # branch into old_tip:
2191
 
            if (old_tip is not None and not _mod_revision.is_null(old_tip)):
2192
 
                self.add_parent_tree_id(old_tip)
2193
 
        if (old_tip is not None and not _mod_revision.is_null(old_tip)
2194
 
            and old_tip != last_rev):
2195
 
            # our last revision was not the prior branch last revision
2196
 
            # and we have converted that last revision to a pending merge.
2197
 
            # base is somewhere between the branch tip now
2198
 
            # and the now pending merge
2199
 
 
2200
 
            # Since we just modified the working tree and inventory, flush out
2201
 
            # the current state, before we modify it again.
2202
 
            # TODO: jam 20070214 WorkingTree3 doesn't require this, dirstate
2203
 
            #       requires it only because TreeTransform directly munges the
2204
 
            #       inventory and calls tree._write_inventory(). Ultimately we
2205
 
            #       should be able to remove this extra flush.
2206
 
            self.flush()
2207
 
            graph = self.branch.repository.get_graph()
2208
 
            base_rev_id = graph.find_unique_lca(self.branch.last_revision(),
2209
 
                                                old_tip)
2210
 
            base_tree = self.branch.repository.revision_tree(base_rev_id)
2211
 
            other_tree = self.branch.repository.revision_tree(old_tip)
2212
 
            result += merge.merge_inner(
2213
 
                                  self.branch,
2214
 
                                  other_tree,
2215
 
                                  base_tree,
2216
 
                                  this_tree=self,
2217
 
                                  change_reporter=change_reporter)
2218
 
        return result
2219
 
 
2220
 
    def _write_hashcache_if_dirty(self):
2221
 
        """Write out the hashcache if it is dirty."""
2222
 
        if self._hashcache.needs_write:
2223
 
            try:
2224
 
                self._hashcache.write()
2225
 
            except OSError, e:
2226
 
                if e.errno not in (errno.EPERM, errno.EACCES):
2227
 
                    raise
2228
 
                # TODO: jam 20061219 Should this be a warning? A single line
2229
 
                #       warning might be sufficient to let the user know what
2230
 
                #       is going on.
2231
 
                mutter('Could not write hashcache for %s\nError: %s',
2232
 
                       self._hashcache.cache_file_name(), e)
2233
 
 
2234
 
    @needs_tree_write_lock
 
1358
                                      this_tree=self)
 
1359
                self.set_last_revision(self.branch.last_revision())
 
1360
            if old_tip and old_tip != self.last_revision():
 
1361
                # our last revision was not the prior branch last reivison
 
1362
                # and we have converted that last revision to a pending merge.
 
1363
                # base is somewhere between the branch tip now
 
1364
                # and the now pending merge
 
1365
                from bzrlib.revision import common_ancestor
 
1366
                try:
 
1367
                    base_rev_id = common_ancestor(self.branch.last_revision(),
 
1368
                                                  old_tip,
 
1369
                                                  self.branch.repository)
 
1370
                except errors.NoCommonAncestor:
 
1371
                    base_rev_id = None
 
1372
                base_tree = self.branch.repository.revision_tree(base_rev_id)
 
1373
                other_tree = self.branch.repository.revision_tree(old_tip)
 
1374
                result += merge_inner(self.branch,
 
1375
                                      other_tree,
 
1376
                                      base_tree,
 
1377
                                      this_tree=self)
 
1378
            return result
 
1379
        finally:
 
1380
            self.branch.unlock()
 
1381
 
 
1382
    @needs_write_lock
2235
1383
    def _write_inventory(self, inv):
2236
1384
        """Write inventory as the current inventory."""
2237
 
        self._set_inventory(inv, dirty=True)
2238
 
        self.flush()
 
1385
        sio = StringIO()
 
1386
        bzrlib.xml5.serializer_v5.write_inventory(inv, sio)
 
1387
        sio.seek(0)
 
1388
        self._control_files.put('inventory', sio)
 
1389
        self._set_inventory(inv)
 
1390
        mutter('wrote working inventory')
2239
1391
 
2240
1392
    def set_conflicts(self, arg):
2241
 
        raise errors.UnsupportedOperation(self.set_conflicts, self)
2242
 
 
2243
 
    def add_conflicts(self, arg):
2244
 
        raise errors.UnsupportedOperation(self.add_conflicts, self)
 
1393
        raise UnsupportedOperation(self.set_conflicts, self)
2245
1394
 
2246
1395
    @needs_read_lock
2247
1396
    def conflicts(self):
2248
 
        conflicts = _mod_conflicts.ConflictList()
 
1397
        conflicts = ConflictList()
2249
1398
        for conflicted in self._iter_conflicts():
2250
1399
            text = True
2251
1400
            try:
2252
1401
                if file_kind(self.abspath(conflicted)) != "file":
2253
1402
                    text = False
2254
 
            except errors.NoSuchFile:
2255
 
                text = False
 
1403
            except OSError, e:
 
1404
                if e.errno == errno.ENOENT:
 
1405
                    text = False
 
1406
                else:
 
1407
                    raise
2256
1408
            if text is True:
2257
1409
                for suffix in ('.THIS', '.OTHER'):
2258
1410
                    try:
2259
1411
                        kind = file_kind(self.abspath(conflicted+suffix))
2260
 
                        if kind != "file":
 
1412
                    except OSError, e:
 
1413
                        if e.errno == errno.ENOENT:
2261
1414
                            text = False
2262
 
                    except errors.NoSuchFile:
 
1415
                            break
 
1416
                        else:
 
1417
                            raise
 
1418
                    if kind != "file":
2263
1419
                        text = False
2264
 
                    if text == False:
2265
1420
                        break
2266
1421
            ctype = {True: 'text conflict', False: 'contents conflict'}[text]
2267
 
            conflicts.append(_mod_conflicts.Conflict.factory(ctype,
2268
 
                             path=conflicted,
 
1422
            conflicts.append(Conflict.factory(ctype, path=conflicted,
2269
1423
                             file_id=self.path2id(conflicted)))
2270
1424
        return conflicts
2271
1425
 
2272
 
    def walkdirs(self, prefix=""):
2273
 
        """Walk the directories of this tree.
2274
 
 
2275
 
        returns a generator which yields items in the form:
2276
 
                ((curren_directory_path, fileid),
2277
 
                 [(file1_path, file1_name, file1_kind, (lstat), file1_id,
2278
 
                   file1_kind), ... ])
2279
 
 
2280
 
        This API returns a generator, which is only valid during the current
2281
 
        tree transaction - within a single lock_read or lock_write duration.
2282
 
 
2283
 
        If the tree is not locked, it may cause an error to be raised,
2284
 
        depending on the tree implementation.
2285
 
        """
2286
 
        disk_top = self.abspath(prefix)
2287
 
        if disk_top.endswith('/'):
2288
 
            disk_top = disk_top[:-1]
2289
 
        top_strip_len = len(disk_top) + 1
2290
 
        inventory_iterator = self._walkdirs(prefix)
2291
 
        disk_iterator = osutils.walkdirs(disk_top, prefix)
2292
 
        try:
2293
 
            current_disk = disk_iterator.next()
2294
 
            disk_finished = False
2295
 
        except OSError, e:
2296
 
            if not (e.errno == errno.ENOENT or
2297
 
                (sys.platform == 'win32' and e.errno == ERROR_PATH_NOT_FOUND)):
2298
 
                raise
2299
 
            current_disk = None
2300
 
            disk_finished = True
2301
 
        try:
2302
 
            current_inv = inventory_iterator.next()
2303
 
            inv_finished = False
2304
 
        except StopIteration:
2305
 
            current_inv = None
2306
 
            inv_finished = True
2307
 
        while not inv_finished or not disk_finished:
2308
 
            if current_disk:
2309
 
                ((cur_disk_dir_relpath, cur_disk_dir_path_from_top),
2310
 
                    cur_disk_dir_content) = current_disk
2311
 
            else:
2312
 
                ((cur_disk_dir_relpath, cur_disk_dir_path_from_top),
2313
 
                    cur_disk_dir_content) = ((None, None), None)
2314
 
            if not disk_finished:
2315
 
                # strip out .bzr dirs
2316
 
                if (cur_disk_dir_path_from_top[top_strip_len:] == '' and
2317
 
                    len(cur_disk_dir_content) > 0):
2318
 
                    # osutils.walkdirs can be made nicer -
2319
 
                    # yield the path-from-prefix rather than the pathjoined
2320
 
                    # value.
2321
 
                    bzrdir_loc = bisect_left(cur_disk_dir_content,
2322
 
                        ('.bzr', '.bzr'))
2323
 
                    if cur_disk_dir_content[bzrdir_loc][0] == '.bzr':
2324
 
                        # we dont yield the contents of, or, .bzr itself.
2325
 
                        del cur_disk_dir_content[bzrdir_loc]
2326
 
            if inv_finished:
2327
 
                # everything is unknown
2328
 
                direction = 1
2329
 
            elif disk_finished:
2330
 
                # everything is missing
2331
 
                direction = -1
2332
 
            else:
2333
 
                direction = cmp(current_inv[0][0], cur_disk_dir_relpath)
2334
 
            if direction > 0:
2335
 
                # disk is before inventory - unknown
2336
 
                dirblock = [(relpath, basename, kind, stat, None, None) for
2337
 
                    relpath, basename, kind, stat, top_path in
2338
 
                    cur_disk_dir_content]
2339
 
                yield (cur_disk_dir_relpath, None), dirblock
2340
 
                try:
2341
 
                    current_disk = disk_iterator.next()
2342
 
                except StopIteration:
2343
 
                    disk_finished = True
2344
 
            elif direction < 0:
2345
 
                # inventory is before disk - missing.
2346
 
                dirblock = [(relpath, basename, 'unknown', None, fileid, kind)
2347
 
                    for relpath, basename, dkind, stat, fileid, kind in
2348
 
                    current_inv[1]]
2349
 
                yield (current_inv[0][0], current_inv[0][1]), dirblock
2350
 
                try:
2351
 
                    current_inv = inventory_iterator.next()
2352
 
                except StopIteration:
2353
 
                    inv_finished = True
2354
 
            else:
2355
 
                # versioned present directory
2356
 
                # merge the inventory and disk data together
2357
 
                dirblock = []
2358
 
                for relpath, subiterator in itertools.groupby(sorted(
2359
 
                    current_inv[1] + cur_disk_dir_content,
2360
 
                    key=operator.itemgetter(0)), operator.itemgetter(1)):
2361
 
                    path_elements = list(subiterator)
2362
 
                    if len(path_elements) == 2:
2363
 
                        inv_row, disk_row = path_elements
2364
 
                        # versioned, present file
2365
 
                        dirblock.append((inv_row[0],
2366
 
                            inv_row[1], disk_row[2],
2367
 
                            disk_row[3], inv_row[4],
2368
 
                            inv_row[5]))
2369
 
                    elif len(path_elements[0]) == 5:
2370
 
                        # unknown disk file
2371
 
                        dirblock.append((path_elements[0][0],
2372
 
                            path_elements[0][1], path_elements[0][2],
2373
 
                            path_elements[0][3], None, None))
2374
 
                    elif len(path_elements[0]) == 6:
2375
 
                        # versioned, absent file.
2376
 
                        dirblock.append((path_elements[0][0],
2377
 
                            path_elements[0][1], 'unknown', None,
2378
 
                            path_elements[0][4], path_elements[0][5]))
2379
 
                    else:
2380
 
                        raise NotImplementedError('unreachable code')
2381
 
                yield current_inv[0], dirblock
2382
 
                try:
2383
 
                    current_inv = inventory_iterator.next()
2384
 
                except StopIteration:
2385
 
                    inv_finished = True
2386
 
                try:
2387
 
                    current_disk = disk_iterator.next()
2388
 
                except StopIteration:
2389
 
                    disk_finished = True
2390
 
 
2391
 
    def _walkdirs(self, prefix=""):
2392
 
        """Walk the directories of this tree.
2393
 
 
2394
 
           :prefix: is used as the directrory to start with.
2395
 
           returns a generator which yields items in the form:
2396
 
                ((curren_directory_path, fileid),
2397
 
                 [(file1_path, file1_name, file1_kind, None, file1_id,
2398
 
                   file1_kind), ... ])
2399
 
        """
2400
 
        _directory = 'directory'
2401
 
        # get the root in the inventory
2402
 
        inv = self.inventory
2403
 
        top_id = inv.path2id(prefix)
2404
 
        if top_id is None:
2405
 
            pending = []
2406
 
        else:
2407
 
            pending = [(prefix, '', _directory, None, top_id, None)]
2408
 
        while pending:
2409
 
            dirblock = []
2410
 
            currentdir = pending.pop()
2411
 
            # 0 - relpath, 1- basename, 2- kind, 3- stat, 4-id, 5-kind
2412
 
            top_id = currentdir[4]
2413
 
            if currentdir[0]:
2414
 
                relroot = currentdir[0] + '/'
2415
 
            else:
2416
 
                relroot = ""
2417
 
            # FIXME: stash the node in pending
2418
 
            entry = inv[top_id]
2419
 
            if entry.kind == 'directory':
2420
 
                for name, child in entry.sorted_children():
2421
 
                    dirblock.append((relroot + name, name, child.kind, None,
2422
 
                        child.file_id, child.kind
2423
 
                        ))
2424
 
            yield (currentdir[0], entry.file_id), dirblock
2425
 
            # push the user specified dirs from dirblock
2426
 
            for dir in reversed(dirblock):
2427
 
                if dir[2] == _directory:
2428
 
                    pending.append(dir)
2429
 
 
2430
 
    @needs_tree_write_lock
2431
 
    def auto_resolve(self):
2432
 
        """Automatically resolve text conflicts according to contents.
2433
 
 
2434
 
        Only text conflicts are auto_resolvable. Files with no conflict markers
2435
 
        are considered 'resolved', because bzr always puts conflict markers
2436
 
        into files that have text conflicts.  The corresponding .THIS .BASE and
2437
 
        .OTHER files are deleted, as per 'resolve'.
2438
 
        :return: a tuple of ConflictLists: (un_resolved, resolved).
2439
 
        """
2440
 
        un_resolved = _mod_conflicts.ConflictList()
2441
 
        resolved = _mod_conflicts.ConflictList()
2442
 
        conflict_re = re.compile('^(<{7}|={7}|>{7})')
2443
 
        for conflict in self.conflicts():
2444
 
            if (conflict.typestring != 'text conflict' or
2445
 
                self.kind(conflict.file_id) != 'file'):
2446
 
                un_resolved.append(conflict)
2447
 
                continue
2448
 
            my_file = open(self.id2abspath(conflict.file_id), 'rb')
2449
 
            try:
2450
 
                for line in my_file:
2451
 
                    if conflict_re.search(line):
2452
 
                        un_resolved.append(conflict)
2453
 
                        break
2454
 
                else:
2455
 
                    resolved.append(conflict)
2456
 
            finally:
2457
 
                my_file.close()
2458
 
        resolved.remove_files(self)
2459
 
        self.set_conflicts(un_resolved)
2460
 
        return un_resolved, resolved
2461
 
 
2462
 
    @needs_read_lock
2463
 
    def _check(self):
2464
 
        tree_basis = self.basis_tree()
2465
 
        tree_basis.lock_read()
2466
 
        try:
2467
 
            repo_basis = self.branch.repository.revision_tree(
2468
 
                self.last_revision())
2469
 
            if len(list(repo_basis.iter_changes(tree_basis))) > 0:
2470
 
                raise errors.BzrCheckError(
2471
 
                    "Mismatched basis inventory content.")
2472
 
            self._validate()
2473
 
        finally:
2474
 
            tree_basis.unlock()
2475
 
 
2476
 
    def _validate(self):
2477
 
        """Validate internal structures.
2478
 
 
2479
 
        This is meant mostly for the test suite. To give it a chance to detect
2480
 
        corruption after actions have occurred. The default implementation is a
2481
 
        just a no-op.
2482
 
 
2483
 
        :return: None. An exception should be raised if there is an error.
2484
 
        """
2485
 
        return
2486
 
 
2487
 
    @needs_read_lock
2488
 
    def _get_rules_searcher(self, default_searcher):
2489
 
        """See Tree._get_rules_searcher."""
2490
 
        if self._rules_searcher is None:
2491
 
            self._rules_searcher = super(WorkingTree,
2492
 
                self)._get_rules_searcher(default_searcher)
2493
 
        return self._rules_searcher
2494
 
 
2495
 
 
2496
 
class WorkingTree2(WorkingTree):
2497
 
    """This is the Format 2 working tree.
2498
 
 
2499
 
    This was the first weave based working tree. 
2500
 
     - uses os locks for locking.
2501
 
     - uses the branch last-revision.
2502
 
    """
2503
 
 
2504
 
    def __init__(self, *args, **kwargs):
2505
 
        super(WorkingTree2, self).__init__(*args, **kwargs)
2506
 
        # WorkingTree2 has more of a constraint that self._inventory must
2507
 
        # exist. Because this is an older format, we don't mind the overhead
2508
 
        # caused by the extra computation here.
2509
 
 
2510
 
        # Newer WorkingTree's should only have self._inventory set when they
2511
 
        # have a read lock.
2512
 
        if self._inventory is None:
2513
 
            self.read_working_inventory()
2514
 
 
2515
 
    def lock_tree_write(self):
2516
 
        """See WorkingTree.lock_tree_write().
2517
 
 
2518
 
        In Format2 WorkingTrees we have a single lock for the branch and tree
2519
 
        so lock_tree_write() degrades to lock_write().
2520
 
        """
2521
 
        self.branch.lock_write()
2522
 
        try:
2523
 
            return self._control_files.lock_write()
2524
 
        except:
2525
 
            self.branch.unlock()
2526
 
            raise
2527
 
 
2528
 
    def unlock(self):
2529
 
        # do non-implementation specific cleanup
2530
 
        self._cleanup()
2531
 
 
2532
 
        # we share control files:
2533
 
        if self._control_files._lock_count == 3:
2534
 
            # _inventory_is_modified is always False during a read lock.
2535
 
            if self._inventory_is_modified:
2536
 
                self.flush()
2537
 
            self._write_hashcache_if_dirty()
2538
 
                    
2539
 
        # reverse order of locking.
2540
 
        try:
2541
 
            return self._control_files.unlock()
2542
 
        finally:
2543
 
            self.branch.unlock()
2544
 
 
2545
1426
 
2546
1427
class WorkingTree3(WorkingTree):
2547
1428
    """This is the Format 3 working tree.
2554
1435
    """
2555
1436
 
2556
1437
    @needs_read_lock
2557
 
    def _last_revision(self):
2558
 
        """See Mutable.last_revision."""
 
1438
    def last_revision(self):
 
1439
        """See WorkingTree.last_revision."""
2559
1440
        try:
2560
 
            return self._transport.get_bytes('last-revision')
2561
 
        except errors.NoSuchFile:
2562
 
            return _mod_revision.NULL_REVISION
 
1441
            return self._control_files.get_utf8('last-revision').read()
 
1442
        except NoSuchFile:
 
1443
            return None
2563
1444
 
2564
1445
    def _change_last_revision(self, revision_id):
2565
1446
        """See WorkingTree._change_last_revision."""
2566
1447
        if revision_id is None or revision_id == NULL_REVISION:
2567
1448
            try:
2568
 
                self._transport.delete('last-revision')
 
1449
                self._control_files._transport.delete('last-revision')
2569
1450
            except errors.NoSuchFile:
2570
1451
                pass
2571
1452
            return False
2572
1453
        else:
2573
 
            self._transport.put_bytes('last-revision', revision_id,
2574
 
                mode=self._control_files._file_mode)
 
1454
            try:
 
1455
                self.branch.revision_history().index(revision_id)
 
1456
            except ValueError:
 
1457
                raise errors.NoSuchRevision(self.branch, revision_id)
 
1458
            self._control_files.put_utf8('last-revision', revision_id)
2575
1459
            return True
2576
1460
 
2577
 
    @needs_tree_write_lock
 
1461
    @needs_write_lock
2578
1462
    def set_conflicts(self, conflicts):
2579
1463
        self._put_rio('conflicts', conflicts.to_stanzas(), 
2580
1464
                      CONFLICT_HEADER_1)
2581
1465
 
2582
 
    @needs_tree_write_lock
2583
 
    def add_conflicts(self, new_conflicts):
2584
 
        conflict_set = set(self.conflicts())
2585
 
        conflict_set.update(set(list(new_conflicts)))
2586
 
        self.set_conflicts(_mod_conflicts.ConflictList(sorted(conflict_set,
2587
 
                                       key=_mod_conflicts.Conflict.sort_key)))
2588
 
 
2589
1466
    @needs_read_lock
2590
1467
    def conflicts(self):
2591
1468
        try:
2592
 
            confile = self._transport.get('conflicts')
2593
 
        except errors.NoSuchFile:
2594
 
            return _mod_conflicts.ConflictList()
 
1469
            confile = self._control_files.get('conflicts')
 
1470
        except NoSuchFile:
 
1471
            return ConflictList()
2595
1472
        try:
2596
1473
            if confile.next() != CONFLICT_HEADER_1 + '\n':
2597
 
                raise errors.ConflictFormatError()
 
1474
                raise ConflictFormatError()
2598
1475
        except StopIteration:
2599
 
            raise errors.ConflictFormatError()
2600
 
        return _mod_conflicts.ConflictList.from_stanzas(RioReader(confile))
2601
 
 
2602
 
    def unlock(self):
2603
 
        # do non-implementation specific cleanup
2604
 
        self._cleanup()
2605
 
        if self._control_files._lock_count == 1:
2606
 
            # _inventory_is_modified is always False during a read lock.
2607
 
            if self._inventory_is_modified:
2608
 
                self.flush()
2609
 
            self._write_hashcache_if_dirty()
2610
 
        # reverse order of locking.
2611
 
        try:
2612
 
            return self._control_files.unlock()
2613
 
        finally:
2614
 
            self.branch.unlock()
 
1476
            raise ConflictFormatError()
 
1477
        return ConflictList.from_stanzas(RioReader(confile))
2615
1478
 
2616
1479
 
2617
1480
def get_conflicted_stem(path):
2618
 
    for suffix in _mod_conflicts.CONFLICT_SUFFIXES:
 
1481
    for suffix in CONFLICT_SUFFIXES:
2619
1482
        if path.endswith(suffix):
2620
1483
            return path[:-len(suffix)]
2621
1484
 
 
1485
@deprecated_function(zero_eight)
 
1486
def is_control_file(filename):
 
1487
    """See WorkingTree.is_control_filename(filename)."""
 
1488
    ## FIXME: better check
 
1489
    filename = normpath(filename)
 
1490
    while filename != '':
 
1491
        head, tail = os.path.split(filename)
 
1492
        ## mutter('check %r for control file' % ((head, tail),))
 
1493
        if tail == '.bzr':
 
1494
            return True
 
1495
        if filename == head:
 
1496
            break
 
1497
        filename = head
 
1498
    return False
 
1499
 
2622
1500
 
2623
1501
class WorkingTreeFormat(object):
2624
1502
    """An encapsulation of the initialization and open routines for a format.
2644
1522
    _formats = {}
2645
1523
    """The known formats."""
2646
1524
 
2647
 
    requires_rich_root = False
2648
 
 
2649
 
    upgrade_recommended = False
2650
 
 
2651
1525
    @classmethod
2652
1526
    def find_format(klass, a_bzrdir):
2653
1527
        """Return the format for the working tree object in a_bzrdir."""
2655
1529
            transport = a_bzrdir.get_workingtree_transport(None)
2656
1530
            format_string = transport.get("format").read()
2657
1531
            return klass._formats[format_string]
2658
 
        except errors.NoSuchFile:
 
1532
        except NoSuchFile:
2659
1533
            raise errors.NoWorkingTree(base=transport.base)
2660
1534
        except KeyError:
2661
 
            raise errors.UnknownFormatError(format=format_string,
2662
 
                                            kind="working tree")
2663
 
 
2664
 
    def __eq__(self, other):
2665
 
        return self.__class__ is other.__class__
2666
 
 
2667
 
    def __ne__(self, other):
2668
 
        return not (self == other)
 
1535
            raise errors.UnknownFormatError(format_string)
2669
1536
 
2670
1537
    @classmethod
2671
1538
    def get_default_format(klass):
2699
1566
 
2700
1567
    @classmethod
2701
1568
    def unregister_format(klass, format):
 
1569
        assert klass._formats[format.get_format_string()] is format
2702
1570
        del klass._formats[format.get_format_string()]
2703
1571
 
2704
1572
 
 
1573
 
2705
1574
class WorkingTreeFormat2(WorkingTreeFormat):
2706
1575
    """The second working tree format. 
2707
1576
 
2708
1577
    This format modified the hash cache from the format 1 hash cache.
2709
1578
    """
2710
1579
 
2711
 
    upgrade_recommended = True
2712
 
 
2713
1580
    def get_format_description(self):
2714
1581
        """See WorkingTreeFormat.get_format_description()."""
2715
1582
        return "Working tree format 2"
2716
1583
 
2717
 
    def _stub_initialize_on_transport(self, transport, file_mode):
2718
 
        """Workaround: create control files for a remote working tree.
2719
 
 
 
1584
    def stub_initialize_remote(self, control_files):
 
1585
        """As a special workaround create critical control files for a remote working tree
 
1586
        
2720
1587
        This ensures that it can later be updated and dealt with locally,
2721
 
        since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
 
1588
        since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with 
2722
1589
        no working tree.  (See bug #43064).
2723
1590
        """
2724
1591
        sio = StringIO()
2725
1592
        inv = Inventory()
2726
 
        xml5.serializer_v5.write_inventory(inv, sio, working=True)
 
1593
        bzrlib.xml5.serializer_v5.write_inventory(inv, sio)
2727
1594
        sio.seek(0)
2728
 
        transport.put_file('inventory', sio, file_mode)
2729
 
        transport.put_bytes('pending-merges', '', file_mode)
2730
 
 
2731
 
    def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
2732
 
                   accelerator_tree=None, hardlink=False):
 
1595
        control_files.put('inventory', sio)
 
1596
 
 
1597
        control_files.put_utf8('pending-merges', '')
 
1598
        
 
1599
 
 
1600
    def initialize(self, a_bzrdir, revision_id=None):
2733
1601
        """See WorkingTreeFormat.initialize()."""
2734
1602
        if not isinstance(a_bzrdir.transport, LocalTransport):
2735
1603
            raise errors.NotLocalUrl(a_bzrdir.transport.base)
2736
 
        if from_branch is not None:
2737
 
            branch = from_branch
2738
 
        else:
2739
 
            branch = a_bzrdir.open_branch()
2740
 
        if revision_id is None:
2741
 
            revision_id = _mod_revision.ensure_null(branch.last_revision())
2742
 
        branch.lock_write()
2743
 
        try:
2744
 
            branch.generate_revision_history(revision_id)
2745
 
        finally:
2746
 
            branch.unlock()
2747
 
        inv = Inventory()
2748
 
        wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
 
1604
        branch = a_bzrdir.open_branch()
 
1605
        if revision_id is not None:
 
1606
            branch.lock_write()
 
1607
            try:
 
1608
                revision_history = branch.revision_history()
 
1609
                try:
 
1610
                    position = revision_history.index(revision_id)
 
1611
                except ValueError:
 
1612
                    raise errors.NoSuchRevision(branch, revision_id)
 
1613
                branch.set_revision_history(revision_history[:position + 1])
 
1614
            finally:
 
1615
                branch.unlock()
 
1616
        revision = branch.last_revision()
 
1617
        inv = Inventory() 
 
1618
        wt = WorkingTree(a_bzrdir.root_transport.base,
2749
1619
                         branch,
2750
1620
                         inv,
2751
1621
                         _internal=True,
2752
1622
                         _format=self,
2753
1623
                         _bzrdir=a_bzrdir)
2754
 
        basis_tree = branch.repository.revision_tree(revision_id)
2755
 
        if basis_tree.inventory.root is not None:
2756
 
            wt.set_root_id(basis_tree.get_root_id())
2757
 
        # set the parent list and cache the basis tree.
2758
 
        if _mod_revision.is_null(revision_id):
2759
 
            parent_trees = []
2760
 
        else:
2761
 
            parent_trees = [(revision_id, basis_tree)]
2762
 
        wt.set_parent_trees(parent_trees)
2763
 
        transform.build_tree(basis_tree, wt)
 
1624
        wt._write_inventory(inv)
 
1625
        wt.set_root_id(inv.root.file_id)
 
1626
        wt.set_last_revision(revision)
 
1627
        wt.set_pending_merges([])
 
1628
        build_tree(wt.basis_tree(), wt)
2764
1629
        return wt
2765
1630
 
2766
1631
    def __init__(self):
2778
1643
            raise NotImplementedError
2779
1644
        if not isinstance(a_bzrdir.transport, LocalTransport):
2780
1645
            raise errors.NotLocalUrl(a_bzrdir.transport.base)
2781
 
        wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
 
1646
        return WorkingTree(a_bzrdir.root_transport.base,
2782
1647
                           _internal=True,
2783
1648
                           _format=self,
2784
1649
                           _bzrdir=a_bzrdir)
2785
 
        return wt
 
1650
 
2786
1651
 
2787
1652
class WorkingTreeFormat3(WorkingTreeFormat):
2788
1653
    """The second working tree format updated to record a format marker.
2793
1658
          files, separate from the BzrDir format
2794
1659
        - modifies the hash cache format
2795
1660
        - is new in bzr 0.8
2796
 
        - uses a LockDir to guard access for writes.
 
1661
        - uses a LockDir to guard access to the repository
2797
1662
    """
2798
 
    
2799
 
    upgrade_recommended = True
2800
1663
 
2801
1664
    def get_format_string(self):
2802
1665
        """See WorkingTreeFormat.get_format_string()."""
2809
1672
    _lock_file_name = 'lock'
2810
1673
    _lock_class = LockDir
2811
1674
 
2812
 
    _tree_class = WorkingTree3
2813
 
 
2814
 
    def __get_matchingbzrdir(self):
2815
 
        return bzrdir.BzrDirMetaFormat1()
2816
 
 
2817
 
    _matchingbzrdir = property(__get_matchingbzrdir)
2818
 
 
2819
1675
    def _open_control_files(self, a_bzrdir):
2820
1676
        transport = a_bzrdir.get_workingtree_transport(None)
2821
1677
        return LockableFiles(transport, self._lock_file_name, 
2822
1678
                             self._lock_class)
2823
1679
 
2824
 
    def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
2825
 
                   accelerator_tree=None, hardlink=False):
 
1680
    def initialize(self, a_bzrdir, revision_id=None):
2826
1681
        """See WorkingTreeFormat.initialize().
2827
1682
        
2828
 
        :param revision_id: if supplied, create a working tree at a different
2829
 
            revision than the branch is at.
2830
 
        :param accelerator_tree: A tree which can be used for retrieving file
2831
 
            contents more quickly than the revision tree, i.e. a workingtree.
2832
 
            The revision tree will be used for cases where accelerator_tree's
2833
 
            content is different.
2834
 
        :param hardlink: If true, hard-link files from accelerator_tree,
2835
 
            where possible.
 
1683
        revision_id allows creating a working tree at a differnet
 
1684
        revision than the branch is at.
2836
1685
        """
2837
1686
        if not isinstance(a_bzrdir.transport, LocalTransport):
2838
1687
            raise errors.NotLocalUrl(a_bzrdir.transport.base)
2840
1689
        control_files = self._open_control_files(a_bzrdir)
2841
1690
        control_files.create_lock()
2842
1691
        control_files.lock_write()
2843
 
        transport.put_bytes('format', self.get_format_string(),
2844
 
            mode=control_files._file_mode)
2845
 
        if from_branch is not None:
2846
 
            branch = from_branch
2847
 
        else:
2848
 
            branch = a_bzrdir.open_branch()
 
1692
        control_files.put_utf8('format', self.get_format_string())
 
1693
        branch = a_bzrdir.open_branch()
2849
1694
        if revision_id is None:
2850
 
            revision_id = _mod_revision.ensure_null(branch.last_revision())
2851
 
        # WorkingTree3 can handle an inventory which has a unique root id.
2852
 
        # as of bzr 0.12. However, bzr 0.11 and earlier fail to handle
2853
 
        # those trees. And because there isn't a format bump inbetween, we
2854
 
        # are maintaining compatibility with older clients.
2855
 
        # inv = Inventory(root_id=gen_root_id())
2856
 
        inv = self._initial_inventory()
2857
 
        wt = self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
 
1695
            revision_id = branch.last_revision()
 
1696
        inv = Inventory() 
 
1697
        wt = WorkingTree3(a_bzrdir.root_transport.base,
2858
1698
                         branch,
2859
1699
                         inv,
2860
1700
                         _internal=True,
2861
1701
                         _format=self,
2862
1702
                         _bzrdir=a_bzrdir,
2863
1703
                         _control_files=control_files)
2864
 
        wt.lock_tree_write()
 
1704
        wt.lock_write()
2865
1705
        try:
2866
 
            basis_tree = branch.repository.revision_tree(revision_id)
2867
 
            # only set an explicit root id if there is one to set.
2868
 
            if basis_tree.inventory.root is not None:
2869
 
                wt.set_root_id(basis_tree.get_root_id())
2870
 
            if revision_id == NULL_REVISION:
2871
 
                wt.set_parent_trees([])
2872
 
            else:
2873
 
                wt.set_parent_trees([(revision_id, basis_tree)])
2874
 
            transform.build_tree(basis_tree, wt)
 
1706
            wt._write_inventory(inv)
 
1707
            wt.set_root_id(inv.root.file_id)
 
1708
            wt.set_last_revision(revision_id)
 
1709
            wt.set_pending_merges([])
 
1710
            build_tree(wt.basis_tree(), wt)
2875
1711
        finally:
2876
 
            # Unlock in this order so that the unlock-triggers-flush in
2877
 
            # WorkingTree is given a chance to fire.
 
1712
            wt.unlock()
2878
1713
            control_files.unlock()
2879
 
            wt.unlock()
2880
1714
        return wt
2881
1715
 
2882
 
    def _initial_inventory(self):
2883
 
        return Inventory()
2884
 
 
2885
1716
    def __init__(self):
2886
1717
        super(WorkingTreeFormat3, self).__init__()
 
1718
        self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
2887
1719
 
2888
1720
    def open(self, a_bzrdir, _found=False):
2889
1721
        """Return the WorkingTree object for a_bzrdir
2896
1728
            raise NotImplementedError
2897
1729
        if not isinstance(a_bzrdir.transport, LocalTransport):
2898
1730
            raise errors.NotLocalUrl(a_bzrdir.transport.base)
2899
 
        wt = self._open(a_bzrdir, self._open_control_files(a_bzrdir))
2900
 
        return wt
2901
 
 
2902
 
    def _open(self, a_bzrdir, control_files):
2903
 
        """Open the tree itself.
2904
 
        
2905
 
        :param a_bzrdir: the dir for the tree.
2906
 
        :param control_files: the control files for the tree.
2907
 
        """
2908
 
        return self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
2909
 
                                _internal=True,
2910
 
                                _format=self,
2911
 
                                _bzrdir=a_bzrdir,
2912
 
                                _control_files=control_files)
 
1731
        control_files = self._open_control_files(a_bzrdir)
 
1732
        return WorkingTree3(a_bzrdir.root_transport.base,
 
1733
                           _internal=True,
 
1734
                           _format=self,
 
1735
                           _bzrdir=a_bzrdir,
 
1736
                           _control_files=control_files)
2913
1737
 
2914
1738
    def __str__(self):
2915
1739
        return self.get_format_string()
2916
1740
 
2917
1741
 
2918
 
__default_format = WorkingTreeFormat4()
 
1742
# formats which have no format string are not discoverable
 
1743
# and not independently creatable, so are not registered.
 
1744
__default_format = WorkingTreeFormat3()
2919
1745
WorkingTreeFormat.register_format(__default_format)
2920
 
WorkingTreeFormat.register_format(WorkingTreeFormat3())
2921
1746
WorkingTreeFormat.set_default_format(__default_format)
2922
 
# formats which have no format string are not discoverable
2923
 
# and not independently creatable, so are not registered.
2924
1747
_legacy_formats = [WorkingTreeFormat2(),
2925
1748
                   ]
 
1749
 
 
1750
 
 
1751
class WorkingTreeTestProviderAdapter(object):
 
1752
    """A tool to generate a suite testing multiple workingtree formats at once.
 
1753
 
 
1754
    This is done by copying the test once for each transport and injecting
 
1755
    the transport_server, transport_readonly_server, and workingtree_format
 
1756
    classes into each copy. Each copy is also given a new id() to make it
 
1757
    easy to identify.
 
1758
    """
 
1759
 
 
1760
    def __init__(self, transport_server, transport_readonly_server, formats):
 
1761
        self._transport_server = transport_server
 
1762
        self._transport_readonly_server = transport_readonly_server
 
1763
        self._formats = formats
 
1764
    
 
1765
    def adapt(self, test):
 
1766
        from bzrlib.tests import TestSuite
 
1767
        result = TestSuite()
 
1768
        for workingtree_format, bzrdir_format in self._formats:
 
1769
            new_test = deepcopy(test)
 
1770
            new_test.transport_server = self._transport_server
 
1771
            new_test.transport_readonly_server = self._transport_readonly_server
 
1772
            new_test.bzrdir_format = bzrdir_format
 
1773
            new_test.workingtree_format = workingtree_format
 
1774
            def make_new_test_id():
 
1775
                new_id = "%s(%s)" % (new_test.id(), workingtree_format.__class__.__name__)
 
1776
                return lambda: new_id
 
1777
            new_test.id = make_new_test_id()
 
1778
            result.addTest(new_test)
 
1779
        return result