/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: Martin Pool
  • Date: 2009-11-14 11:24:42 UTC
  • mto: This revision was merged to the branch mainline in revision 4828.
  • Revision ID: mbp@sourcefrog.net-20091114112442-xwig0pkucv2ax3xd
Delete bzrlib.textui

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