/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/workingtree.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2009-08-21 03:07:43 UTC
  • mfrom: (4627.2.4 integration)
  • Revision ID: pqm@pqm.ubuntu.com-20090821030743-d3ydo9cq7ajbn0ew
(robertc) Fix many locking errors on windows due to a small bug in
        merge.transform_tree. (Robert Collins)

Show diffs side-by-side

added added

removed removed

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