/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: Andrew Bennetts
  • Date: 2009-11-17 02:34:42 UTC
  • mto: This revision was merged to the branch mainline in revision 4801.
  • Revision ID: andrew.bennetts@canonical.com-20091117023442-8vioar3w20x2y7b5
Add NEWS entry.

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