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