/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to bzrlib/workingtree.py

  • Committer: Martin Pool
  • Date: 2009-11-26 01:42:06 UTC
  • mfrom: (4827 +trunk)
  • mto: This revision was merged to the branch mainline in revision 4828.
  • Revision ID: mbp@sourcefrog.net-20091126014206-qvf8jfpwpro558r4
merge news

Show diffs side-by-side

added added

removed removed

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