← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/workingtree.py

  • Committer: Vincent Ladeuil
  • Date: 2013-10-04 09:56:23 UTC
  • mto: (6588.1.1 trunk)
  • mto: This revision was merged to the branch mainline in revision 6589.
  • Revision ID: v.ladeuil+lp@free.fr-20131004095623-xlan34vg0y51gdb5
https://launchpad.net/bugs/1235099
Stricter checks on configuration option names

Show diffs side-by-side

added added

removed removed

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