/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:23:07 UTC
  • mto: This revision was merged to the branch mainline in revision 4828.
  • Revision ID: mbp@sourcefrog.net-20091114112307-gezkfgg9ymipqv96
Further cleanup of removal reporting code

Show diffs side-by-side

added added

removed removed

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