/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: Robert Collins
  • Date: 2010-05-06 11:08:10 UTC
  • mto: This revision was merged to the branch mainline in revision 5223.
  • Revision ID: robertc@robertcollins.net-20100506110810-h3j07fh5gmw54s25
Cleaner matcher matching revised unlocking protocol.

Show diffs side-by-side

added added

removed removed

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