/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/workingtree.py

  • Committer: Marius Kruger
  • Date: 2008-12-14 03:22:01 UTC
  • mto: This revision was merged to the branch mainline in revision 3909.
  • Revision ID: amanic@gmail.com-20081214032201-lx059v3ts0pihvcf
add test_list_tags_revision_filtering

Show diffs side-by-side

added added

removed removed

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