/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: John Arbash Meinel
  • Date: 2006-09-12 20:46:42 UTC
  • mto: This revision was merged to the branch mainline in revision 2071.
  • Revision ID: john@arbash-meinel.com-20060912204642-91599869cc863f07
Cleanup, deprecated, and get the tests passing again.

bzrlib.builtins.merge is heavily used by the test suite, though it is
really the wrong place for a function like that.
lazy imports work badly with doctests, but so far none of the doc tested
modules had anything worth testing in that fashion.

Show diffs side-by-side

added added

removed removed

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