~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/workingtree.py

New utility function symbol_versioning.deprecation_string. Returns the
formatted string for a callable, deprecation format pair. (Robert Collins)

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