~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/workingtree.py

  • Committer: Martin Pool
  • Date: 2009-08-20 04:53:23 UTC
  • mto: This revision was merged to the branch mainline in revision 4632.
  • Revision ID: mbp@sourcefrog.net-20090820045323-4hsicfa87pdq3l29
Correction to xdg_cache_dir and add a simple test

Show diffs side-by-side

added added

removed removed

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