~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/workingtree.py

  • Committer: Patch Queue Manager
  • Date: 2012-03-12 15:03:17 UTC
  • mfrom: (6491.2.2 lazy-lp-plugin)
  • Revision ID: pqm@pqm.ubuntu.com-20120312150317-nrt00el7ooyvbk94
(jelmer) Lazily load launchpad plugin commands. (Jelmer Vernooij)

Show diffs side-by-side

added added

removed removed

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