/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to bzrlib/workingtree.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2010-08-05 05:02:15 UTC
  • mfrom: (5365.1.1 docs)
  • Revision ID: pqm@pqm.ubuntu.com-20100805050215-tbk9eoxr7x6z3nsl
(spiv) Fixed small formatting issue. (Alexander Belchenko)

Show diffs side-by-side

added added

removed removed

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