~bzr-pqm/bzr/bzr.dev

4325.3.1 by Johan Walles
Don't reinvent osutils.minimum_path_selection().
1
# Copyright (C) 2005, 2006, 2007, 2008, 2009 Canonical Ltd
2255.2.3 by Robert Collins
Split out working tree format 4 to its own file, create stub dirstate revision object, start working on dirstate.set_parent_trees - a key failure point.
2
#
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
7
#
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11
# GNU General Public License for more details.
12
#
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
4183.7.1 by Sabin Iacob
update FSF mailing address
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
2255.2.3 by Robert Collins
Split out working tree format 4 to its own file, create stub dirstate revision object, start working on dirstate.set_parent_trees - a key failure point.
16
17
"""WorkingTree4 format and implementation.
18
19
WorkingTree4 provides the dirstate based working tree logic.
20
21
To get a WorkingTree, call bzrdir.open_workingtree() or
22
WorkingTree.open(dir).
23
"""
24
2255.2.31 by Robert Collins
Work in progress to make merge_inner work with dirstate trees.
25
from cStringIO import StringIO
2255.2.3 by Robert Collins
Split out working tree format 4 to its own file, create stub dirstate revision object, start working on dirstate.set_parent_trees - a key failure point.
26
import os
2255.2.138 by John Arbash Meinel
implement several new WorkingTree.move() tests
27
import sys
2255.2.3 by Robert Collins
Split out working tree format 4 to its own file, create stub dirstate revision object, start working on dirstate.set_parent_trees - a key failure point.
28
29
from bzrlib.lazy_import import lazy_import
30
lazy_import(globals(), """
31
from bisect import bisect_left
32
import collections
33
from copy import deepcopy
34
import errno
35
import itertools
36
import operator
37
import stat
38
from time import time
39
import warnings
40
41
import bzrlib
42
from bzrlib import (
43
    bzrdir,
2255.2.114 by John Arbash Meinel
_get_inventory: 2.09 => 1.93s by tweaking some of the inner _generate_inventory loops
44
    cache_utf8,
2255.2.3 by Robert Collins
Split out working tree format 4 to its own file, create stub dirstate revision object, start working on dirstate.set_parent_trees - a key failure point.
45
    conflicts as _mod_conflicts,
2745.1.1 by Robert Collins
Add a number of -Devil checkpoints.
46
    debug,
2255.2.149 by Robert Collins
Crufty but existing _iter_changes implementation for WorkingTreeFormat4.
47
    delta,
2255.2.3 by Robert Collins
Split out working tree format 4 to its own file, create stub dirstate revision object, start working on dirstate.set_parent_trees - a key failure point.
48
    dirstate,
49
    errors,
50
    generate_ids,
51
    globbing,
52
    ignores,
53
    merge,
54
    osutils,
2598.5.2 by Aaron Bentley
Got all tests passing with Branch returning 'null:' for null revision
55
    revision as _mod_revision,
2255.2.117 by Robert Collins
Add an InterDirStateTree InterTree optimiser.
56
    revisiontree,
2255.2.3 by Robert Collins
Split out working tree format 4 to its own file, create stub dirstate revision object, start working on dirstate.set_parent_trees - a key failure point.
57
    textui,
2745.1.2 by Robert Collins
Ensure mutter_callsite is not directly called on a lazy_load object, to make the stacklevel parameter work correctly.
58
    trace,
2255.2.3 by Robert Collins
Split out working tree format 4 to its own file, create stub dirstate revision object, start working on dirstate.set_parent_trees - a key failure point.
59
    transform,
60
    urlutils,
3586.2.13 by Ian Clatworthy
fix wt5 to use views, correcting an earlier merge
61
    views,
2255.2.3 by Robert Collins
Split out working tree format 4 to its own file, create stub dirstate revision object, start working on dirstate.set_parent_trees - a key failure point.
62
    xml5,
63
    xml6,
64
    )
65
import bzrlib.branch
66
from bzrlib.transport import get_transport
67
import bzrlib.ui
68
""")
69
70
from bzrlib import symbol_versioning
71
from bzrlib.decorators import needs_read_lock, needs_write_lock
3368.2.53 by Ian Clatworthy
sha1 calculation done by workingtree layer now
72
from bzrlib.filters import filtered_input_file, internal_size_sha_file_byname
2255.2.74 by Robert Collins
Minor performance optimisation in _generate_inventory by avoiding normalisation checks and just using a factory to create the inventory entries.
73
from bzrlib.inventory import InventoryEntry, Inventory, ROOT_ID, entry_factory
2255.2.3 by Robert Collins
Split out working tree format 4 to its own file, create stub dirstate revision object, start working on dirstate.set_parent_trees - a key failure point.
74
import bzrlib.mutabletree
75
from bzrlib.mutabletree import needs_tree_write_lock
76
from bzrlib.osutils import (
2255.2.202 by Martin Pool
WorkingTree_4.kind should report tree-references if they're
77
    file_kind,
2255.2.3 by Robert Collins
Split out working tree format 4 to its own file, create stub dirstate revision object, start working on dirstate.set_parent_trees - a key failure point.
78
    isdir,
79
    normpath,
80
    pathjoin,
81
    rand_chars,
82
    realpath,
83
    safe_unicode,
84
    splitpath,
85
    )
86
from bzrlib.trace import mutter, note
87
from bzrlib.transport.local import LocalTransport
2255.2.117 by Robert Collins
Add an InterDirStateTree InterTree optimiser.
88
from bzrlib.tree import InterTree
2255.2.3 by Robert Collins
Split out working tree format 4 to its own file, create stub dirstate revision object, start working on dirstate.set_parent_trees - a key failure point.
89
from bzrlib.progress import DummyProgress, ProgressPhase
90
from bzrlib.revision import NULL_REVISION, CURRENT_REVISION
91
from bzrlib.rio import RioReader, rio_file, Stanza
92
from bzrlib.symbol_versioning import (deprecated_passed,
93
        deprecated_method,
94
        deprecated_function,
95
        DEPRECATED_PARAMETER,
96
        )
97
from bzrlib.tree import Tree
2255.2.59 by Robert Collins
All WorkingTree4 and dirstate tests passing.
98
from bzrlib.workingtree import WorkingTree, WorkingTree3, WorkingTreeFormat3
2255.2.3 by Robert Collins
Split out working tree format 4 to its own file, create stub dirstate revision object, start working on dirstate.set_parent_trees - a key failure point.
99
100
3907.2.3 by Ian Clatworthy
DirStateWorkingTree and DirStateWorkingTreeFormat base classes introduced
101
class DirStateWorkingTree(WorkingTree3):
2255.2.3 by Robert Collins
Split out working tree format 4 to its own file, create stub dirstate revision object, start working on dirstate.set_parent_trees - a key failure point.
102
    def __init__(self, basedir,
103
                 branch,
104
                 _control_files=None,
105
                 _format=None,
106
                 _bzrdir=None):
107
        """Construct a WorkingTree for basedir.
108
109
        If the branch is not supplied, it is opened automatically.
110
        If the branch is supplied, it must be the branch for this basedir.
111
        (branch.base is not cross checked, because for remote branches that
112
        would be meaningless).
113
        """
114
        self._format = _format
115
        self.bzrdir = _bzrdir
116
        basedir = safe_unicode(basedir)
117
        mutter("opening working tree %r", basedir)
118
        self._branch = branch
119
        self.basedir = realpath(basedir)
120
        # if branch is at our basedir and is a format 6 or less
121
        # assume all other formats have their own control files.
122
        self._control_files = _control_files
3407.2.1 by Martin Pool
Deprecate LockableFiles.get
123
        self._transport = self._control_files._transport
2255.2.3 by Robert Collins
Split out working tree format 4 to its own file, create stub dirstate revision object, start working on dirstate.set_parent_trees - a key failure point.
124
        self._dirty = None
2255.2.15 by Robert Collins
Dirstate - truncate state file fixing bug in saving a smaller file, get more tree_implementation tests passing.
125
        #-------------
126
        # during a read or write lock these objects are set, and are
127
        # None the rest of the time.
2255.2.3 by Robert Collins
Split out working tree format 4 to its own file, create stub dirstate revision object, start working on dirstate.set_parent_trees - a key failure point.
128
        self._dirstate = None
2255.2.15 by Robert Collins
Dirstate - truncate state file fixing bug in saving a smaller file, get more tree_implementation tests passing.
129
        self._inventory = None
130
        #-------------
2974.2.2 by John Arbash Meinel
Only one test failed, because it was incorrectly succeeding.
131
        self._setup_directory_is_tree_reference()
3034.4.3 by Aaron Bentley
Add case-sensitivity handling to WorkingTree
132
        self._detect_case_handling()
3398.1.24 by Ian Clatworthy
make iter_search_rules a tree method
133
        self._rules_searcher = None
3586.1.4 by Ian Clatworthy
first cut at tree-level view tests
134
        self.views = self._make_views()
3696.4.10 by Robert Collins
Basic first cut of full-pyrex iter_changes.
135
        #--- allow tests to select the dirstate iter_changes implementation
136
        self._iter_changes = dirstate._process_entry
2255.2.3 by Robert Collins
Split out working tree format 4 to its own file, create stub dirstate revision object, start working on dirstate.set_parent_trees - a key failure point.
137
2255.2.22 by Robert Collins
Dirstate: implement WorkingTree4.unversion, letting some test_commit tests pass.
138
    @needs_tree_write_lock
2255.2.12 by Robert Collins
Partial implementation of WorkingTree4._add.
139
    def _add(self, files, ids, kinds):
140
        """See MutableTree._add."""
141
        state = self.current_dirstate()
142
        for f, file_id, kind in zip(files, ids, kinds):
2255.2.14 by Robert Collins
Dirstate: fix adding of directories to setup the next directories block, and test representation of symlinks. Also fix iter_rows to not reset the dirty bit.
143
            f = f.strip('/')
2255.7.74 by Robert Collins
Test adding of roots to trees, it was broken on WorkingTree4.
144
            if self.path2id(f):
145
                # special case tree root handling.
146
                if f == '' and self.path2id(f) == ROOT_ID:
147
                    state.set_path_id('', generate_ids.gen_file_id(f))
148
                continue
2255.2.12 by Robert Collins
Partial implementation of WorkingTree4._add.
149
            if file_id is None:
2255.2.20 by Robert Collins
Bypass irrelevant basis_inventory tests for dirstate.
150
                file_id = generate_ids.gen_file_id(f)
2255.2.43 by Robert Collins
WorkingTree4.add must not require a file to exist to add it when kind etc is given.
151
            # deliberately add the file with no cached stat or sha1
152
            # - on the first access it will be gathered, and we can
153
            # always change this once tests are all passing.
154
            state.add(f, file_id, kind, None, '')
2255.7.67 by Robert Collins
Fix test_inv - make setting WorkingTree4._dirty use a helper to reduce code duplication, and reset the inventory when we dont manually update it, if it exists.
155
        self._make_dirty(reset_inventory=True)
156
157
    def _make_dirty(self, reset_inventory):
158
        """Make the tree state dirty.
159
160
        :param reset_inventory: True if the cached inventory should be removed
161
            (presuming there is one).
162
        """
2255.2.16 by Robert Collins
Implement WorkingTreeFormat4._write_inventory for better compatability with existing code, letting more test_test_trees pass, now up to test_tree_with_subdirs_and_all_content_types.
163
        self._dirty = True
2255.7.67 by Robert Collins
Fix test_inv - make setting WorkingTree4._dirty use a helper to reduce code duplication, and reset the inventory when we dont manually update it, if it exists.
164
        if reset_inventory and self._inventory is not None:
165
            self._inventory = None
2255.2.12 by Robert Collins
Partial implementation of WorkingTree4._add.
166
2255.2.158 by Martin Pool
Most of the integration of dirstate and subtree
167
    @needs_tree_write_lock
168
    def add_reference(self, sub_tree):
169
        # use standard implementation, which calls back to self._add
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
170
        #
2255.2.158 by Martin Pool
Most of the integration of dirstate and subtree
171
        # So we don't store the reference_revision in the working dirstate,
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
172
        # it's just recorded at the moment of commit.
2255.2.158 by Martin Pool
Most of the integration of dirstate and subtree
173
        self._add_reference(sub_tree)
174
2255.2.149 by Robert Collins
Crufty but existing _iter_changes implementation for WorkingTreeFormat4.
175
    def break_lock(self):
176
        """Break a lock if one is present from another instance.
177
178
        Uses the ui factory to ask for confirmation if the lock may be from
179
        an active process.
180
181
        This will probe the repository for its lock as well.
182
        """
183
        # if the dirstate is locked by an active process, reject the break lock
184
        # call.
185
        try:
186
            if self._dirstate is None:
187
                clear = True
188
            else:
189
                clear = False
190
            state = self._current_dirstate()
191
            if state._lock_token is not None:
192
                # we already have it locked. sheese, cant break our own lock.
193
                raise errors.LockActive(self.basedir)
194
            else:
195
                try:
196
                    # try for a write lock - need permission to get one anyhow
197
                    # to break locks.
198
                    state.lock_write()
199
                except errors.LockContention:
200
                    # oslocks fail when a process is still live: fail.
201
                    # TODO: get the locked lockdir info and give to the user to
202
                    # assist in debugging.
203
                    raise errors.LockActive(self.basedir)
204
                else:
205
                    state.unlock()
206
        finally:
207
            if clear:
208
                self._dirstate = None
209
        self._control_files.break_lock()
210
        self.branch.break_lock()
211
2255.2.158 by Martin Pool
Most of the integration of dirstate and subtree
212
    def _comparison_data(self, entry, path):
213
        kind, executable, stat_value = \
214
            WorkingTree3._comparison_data(self, entry, path)
2255.2.205 by Martin Pool
factor out WorkingTree4._directory_is_tree_reference
215
        # it looks like a plain directory, but it's really a reference -- see
216
        # also kind()
4100.2.4 by Aaron Bentley
More support for not autodetecting tree refs
217
        if (self._repo_supports_tree_reference and kind == 'directory'
218
            and entry is not None and entry.kind == 'tree-reference'):
2255.2.158 by Martin Pool
Most of the integration of dirstate and subtree
219
            kind = 'tree-reference'
220
        return kind, executable, stat_value
221
2255.7.74 by Robert Collins
Test adding of roots to trees, it was broken on WorkingTree4.
222
    @needs_write_lock
223
    def commit(self, message=None, revprops=None, *args, **kwargs):
224
        # mark the tree as dirty post commit - commit
225
        # can change the current versioned list by doing deletes.
226
        result = WorkingTree3.commit(self, message, revprops, *args, **kwargs)
227
        self._make_dirty(reset_inventory=True)
228
        return result
229
2255.2.3 by Robert Collins
Split out working tree format 4 to its own file, create stub dirstate revision object, start working on dirstate.set_parent_trees - a key failure point.
230
    def current_dirstate(self):
2255.10.2 by John Arbash Meinel
Update to dirstate locking.
231
        """Return the current dirstate object.
2255.2.3 by Robert Collins
Split out working tree format 4 to its own file, create stub dirstate revision object, start working on dirstate.set_parent_trees - a key failure point.
232
233
        This is not part of the tree interface and only exposed for ease of
234
        testing.
235
2255.10.2 by John Arbash Meinel
Update to dirstate locking.
236
        :raises errors.NotWriteLocked: when not in a lock.
2255.2.3 by Robert Collins
Split out working tree format 4 to its own file, create stub dirstate revision object, start working on dirstate.set_parent_trees - a key failure point.
237
        """
2255.2.158 by Martin Pool
Most of the integration of dirstate and subtree
238
        self._must_be_locked()
2255.2.149 by Robert Collins
Crufty but existing _iter_changes implementation for WorkingTreeFormat4.
239
        return self._current_dirstate()
240
241
    def _current_dirstate(self):
242
        """Internal function that does not check lock status.
2255.10.2 by John Arbash Meinel
Update to dirstate locking.
243
2255.2.149 by Robert Collins
Crufty but existing _iter_changes implementation for WorkingTreeFormat4.
244
        This is needed for break_lock which also needs the dirstate.
245
        """
2255.2.3 by Robert Collins
Split out working tree format 4 to its own file, create stub dirstate revision object, start working on dirstate.set_parent_trees - a key failure point.
246
        if self._dirstate is not None:
247
            return self._dirstate
248
        local_path = self.bzrdir.get_workingtree_transport(None
249
            ).local_abspath('dirstate')
3368.2.4 by Ian Clatworthy
make content filter lookup a tree responsibility
250
        self._dirstate = dirstate.DirState.on_file(local_path,
3368.2.52 by Ian Clatworthy
merge bzr.dev r4164
251
            self._sha1_provider())
2255.2.3 by Robert Collins
Split out working tree format 4 to its own file, create stub dirstate revision object, start working on dirstate.set_parent_trees - a key failure point.
252
        return self._dirstate
253
3368.2.52 by Ian Clatworthy
merge bzr.dev r4164
254
    def _sha1_provider(self):
255
        """A function that returns a SHA1Provider suitable for this tree.
256
257
        :return: None if content filtering is not supported by this tree.
258
          Otherwise, a SHA1Provider is returned that sha's the canonical
259
          form of files, i.e. after read filters are applied.
260
        """
3368.2.53 by Ian Clatworthy
sha1 calculation done by workingtree layer now
261
        if self.supports_content_filtering():
262
            return ContentFilterAwareSHA1Provider(self)
263
        else:
264
            return None
3368.2.52 by Ian Clatworthy
merge bzr.dev r4164
265
2255.2.81 by Robert Collins
WorkingTree4: Implement filter_unversioned_files to use dirstate bisection.
266
    def filter_unversioned_files(self, paths):
2255.7.62 by Robert Collins
Update the Tree.filter_unversioned_files docstring to reflect what the existing implementations actually do, and change the WorkingTree4 implementation to match a newly created test for it.
267
        """Filter out paths that are versioned.
2255.2.81 by Robert Collins
WorkingTree4: Implement filter_unversioned_files to use dirstate bisection.
268
269
        :return: set of paths.
270
        """
271
        # TODO: make a generic multi-bisect routine roughly that should list
272
        # the paths, then process one half at a time recursively, and feed the
273
        # results of each bisect in further still
274
        paths = sorted(paths)
275
        result = set()
2255.2.176 by Martin Pool
Merge dirstate and some small cleanups
276
        state = self.current_dirstate()
2255.2.81 by Robert Collins
WorkingTree4: Implement filter_unversioned_files to use dirstate bisection.
277
        # TODO we want a paths_to_dirblocks helper I think
278
        for path in paths:
279
            dirname, basename = os.path.split(path.encode('utf8'))
2255.2.96 by Robert Collins
Restore dirstate to all tests passing condition.
280
            _, _, _, path_is_versioned = state._get_block_entry_index(
281
                dirname, basename, 0)
2255.7.62 by Robert Collins
Update the Tree.filter_unversioned_files docstring to reflect what the existing implementations actually do, and change the WorkingTree4 implementation to match a newly created test for it.
282
            if not path_is_versioned:
2255.2.81 by Robert Collins
WorkingTree4: Implement filter_unversioned_files to use dirstate bisection.
283
                result.add(path)
284
        return result
285
2255.2.22 by Robert Collins
Dirstate: implement WorkingTree4.unversion, letting some test_commit tests pass.
286
    def flush(self):
287
        """Write all cached data to disk."""
2255.2.39 by Robert Collins
WorkingTree4: flush can only be used during write locks.
288
        if self._control_files._lock_mode != 'w':
289
            raise errors.NotWriteLocked(self)
2255.2.22 by Robert Collins
Dirstate: implement WorkingTree4.unversion, letting some test_commit tests pass.
290
        self.current_dirstate().save()
291
        self._inventory = None
292
        self._dirty = False
293
2323.4.2 by Robert Collins
Fix the behaviour of dirstate optimised iter_changes recursing its disk iterator into subtrees inappropriately.
294
    @needs_tree_write_lock
295
    def _gather_kinds(self, files, kinds):
296
        """See MutableTree._gather_kinds."""
297
        for pos, f in enumerate(files):
298
            if kinds[pos] is None:
299
                kinds[pos] = self._kind(f)
300
2255.2.34 by Robert Collins
Fix WorkingTree4 parent_ids logic to use the dirstate to answer parent ids list queries.
301
    def _generate_inventory(self):
302
        """Create and set self.inventory from the dirstate object.
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
303
2255.2.34 by Robert Collins
Fix WorkingTree4 parent_ids logic to use the dirstate to answer parent ids list queries.
304
        This is relatively expensive: we have to walk the entire dirstate.
305
        Ideally we would not, and can deprecate this function.
306
        """
2255.2.82 by Robert Collins
various notes about find_ids_across_trees
307
        #: uncomment to trap on inventory requests.
308
        # import pdb;pdb.set_trace()
2255.2.75 by Robert Collins
Correct generation of revisiontree inventories to handle out of order parents.
309
        state = self.current_dirstate()
310
        state._read_dirblocks_if_needed()
2255.2.87 by Robert Collins
core dirstate tests passing with new structure.
311
        root_key, current_entry = self._get_entry(path='')
2255.2.107 by John Arbash Meinel
(working), fix dirstate to use utf8 file ids.
312
        current_id = root_key[2]
3376.2.4 by Martin Pool
Remove every assert statement from bzrlib!
313
        if not (current_entry[0][0] == 'd'): # directory
314
            raise AssertionError(current_entry)
2255.2.75 by Robert Collins
Correct generation of revisiontree inventories to handle out of order parents.
315
        inv = Inventory(root_id=current_id)
2255.2.114 by John Arbash Meinel
_get_inventory: 2.09 => 1.93s by tweaking some of the inner _generate_inventory loops
316
        # Turn some things into local variables
317
        minikind_to_kind = dirstate.DirState._minikind_to_kind
318
        factory = entry_factory
319
        utf8_decode = cache_utf8._utf8_decode
2255.2.115 by John Arbash Meinel
_get_inventory 1.75s: Directly update the inventory state rather than using inv.add()
320
        inv_byid = inv._byid
2255.2.73 by Robert Collins
50% speedup in the dirstate->inventory conversion logic by caching the parent ids as we walk the tree. Some further work would be to maintain a stack of parents as we know we visit depth first.
321
        # we could do this straight out of the dirstate; it might be fast
322
        # and should be profiled - RBC 20070216
2255.2.115 by John Arbash Meinel
_get_inventory 1.75s: Directly update the inventory state rather than using inv.add()
323
        parent_ies = {'' : inv.root}
2255.2.96 by Robert Collins
Restore dirstate to all tests passing condition.
324
        for block in state._dirblocks[1:]: # skip the root
2255.2.77 by Robert Collins
Tune working inventory generation more: walk the blocks, skipping deleted rows.
325
            dirname = block[0]
2255.2.96 by Robert Collins
Restore dirstate to all tests passing condition.
326
            try:
2255.8.4 by John Arbash Meinel
Rather than using split hunks, implement a bisect_dirblocks
327
                parent_ie = parent_ies[dirname]
2255.2.96 by Robert Collins
Restore dirstate to all tests passing condition.
328
            except KeyError:
329
                # all the paths in this block are not versioned in this tree
330
                continue
2255.2.87 by Robert Collins
core dirstate tests passing with new structure.
331
            for key, entry in block[1]:
2255.2.114 by John Arbash Meinel
_get_inventory: 2.09 => 1.93s by tweaking some of the inner _generate_inventory loops
332
                minikind, link_or_sha1, size, executable, stat = entry[0]
333
                if minikind in ('a', 'r'): # absent, relocated
2255.2.87 by Robert Collins
core dirstate tests passing with new structure.
334
                    # a parent tree only entry
335
                    continue
2255.2.107 by John Arbash Meinel
(working), fix dirstate to use utf8 file ids.
336
                name = key[1]
2255.2.114 by John Arbash Meinel
_get_inventory: 2.09 => 1.93s by tweaking some of the inner _generate_inventory loops
337
                name_unicode = utf8_decode(name)[0]
2255.2.107 by John Arbash Meinel
(working), fix dirstate to use utf8 file ids.
338
                file_id = key[2]
2255.2.114 by John Arbash Meinel
_get_inventory: 2.09 => 1.93s by tweaking some of the inner _generate_inventory loops
339
                kind = minikind_to_kind[minikind]
2255.2.115 by John Arbash Meinel
_get_inventory 1.75s: Directly update the inventory state rather than using inv.add()
340
                inv_entry = factory[kind](file_id, name_unicode,
341
                                          parent_ie.file_id)
2255.2.77 by Robert Collins
Tune working inventory generation more: walk the blocks, skipping deleted rows.
342
                if kind == 'file':
2325.3.4 by John Arbash Meinel
Rather than setting the executable bit for every file, properly create the working inventory to include it.
343
                    # This is only needed on win32, where this is the only way
344
                    # we know the executable bit.
345
                    inv_entry.executable = executable
2255.2.87 by Robert Collins
core dirstate tests passing with new structure.
346
                    # not strictly needed: working tree
2325.3.4 by John Arbash Meinel
Rather than setting the executable bit for every file, properly create the working inventory to include it.
347
                    #inv_entry.text_size = size
348
                    #inv_entry.text_sha1 = sha1
2255.2.77 by Robert Collins
Tune working inventory generation more: walk the blocks, skipping deleted rows.
349
                elif kind == 'directory':
2255.2.87 by Robert Collins
core dirstate tests passing with new structure.
350
                    # add this entry to the parent map.
2255.2.115 by John Arbash Meinel
_get_inventory 1.75s: Directly update the inventory state rather than using inv.add()
351
                    parent_ies[(dirname + '/' + name).strip('/')] = inv_entry
2255.2.194 by Robert Collins
[BROKEN] Many updates to stop using experimental formats in tests.
352
                elif kind == 'tree-reference':
3376.2.4 by Martin Pool
Remove every assert statement from bzrlib!
353
                    if not self._repo_supports_tree_reference:
4183.5.2 by Robert Collins
Support tree-reference in record_iter_changes.
354
                        raise errors.UnsupportedOperation(
355
                            self._generate_inventory,
356
                            self.branch.repository)
2255.2.218 by Robert Collins
Make the nested tree commit smoke test be more rigourous.
357
                    inv_entry.reference_revision = link_or_sha1 or None
2338.4.5 by Marien Zwart
Make an assert actually assert something.
358
                elif kind != 'symlink':
2348.1.1 by Martin Pool
(marienz) fixes for error committing merge with symlinks in dirstate
359
                    raise AssertionError("unknown kind %r" % kind)
2255.2.115 by John Arbash Meinel
_get_inventory 1.75s: Directly update the inventory state rather than using inv.add()
360
                # These checks cost us around 40ms on a 55k entry tree
3376.2.4 by Martin Pool
Remove every assert statement from bzrlib!
361
                if file_id in inv_byid:
362
                    raise AssertionError('file_id %s already in'
363
                        ' inventory as %s' % (file_id, inv_byid[file_id]))
364
                if name_unicode in parent_ie.children:
365
                    raise AssertionError('name %r already in parent'
366
                        % (name_unicode,))
2255.2.115 by John Arbash Meinel
_get_inventory 1.75s: Directly update the inventory state rather than using inv.add()
367
                inv_byid[file_id] = inv_entry
368
                parent_ie.children[name_unicode] = inv_entry
2255.2.34 by Robert Collins
Fix WorkingTree4 parent_ids logic to use the dirstate to answer parent ids list queries.
369
        self._inventory = inv
370
2255.2.87 by Robert Collins
core dirstate tests passing with new structure.
371
    def _get_entry(self, file_id=None, path=None):
372
        """Get the dirstate row for file_id or path.
373
374
        If either file_id or path is supplied, it is used as the key to lookup.
375
        If both are supplied, the fastest lookup is used, and an error is
376
        raised if they do not both point at the same row.
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
377
2255.2.87 by Robert Collins
core dirstate tests passing with new structure.
378
        :param file_id: An optional unicode file_id to be looked up.
379
        :param path: An optional unicode path to be looked up.
380
        :return: The dirstate row tuple for path/file_id, or (None, None)
381
        """
382
        if file_id is None and path is None:
383
            raise errors.BzrError('must supply file_id or path')
384
        state = self.current_dirstate()
385
        if path is not None:
386
            path = path.encode('utf8')
387
        return state._get_entry(0, fileid_utf8=file_id, path_utf8=path)
388
2255.2.31 by Robert Collins
Work in progress to make merge_inner work with dirstate trees.
389
    def get_file_sha1(self, file_id, path=None, stat_value=None):
2255.2.88 by Robert Collins
Significant steps back to operation.
390
        # check file id is valid unconditionally.
2255.10.1 by John Arbash Meinel
Update WorkingTree4 so that it doesn't use a HashCache,
391
        entry = self._get_entry(file_id=file_id, path=path)
1551.15.56 by Aaron Bentley
Raise NoSuchId when get_file_sha1 is invoked with a baed file id
392
        if entry[0] is None:
393
            raise errors.NoSuchId(self, file_id)
2255.2.73 by Robert Collins
50% speedup in the dirstate->inventory conversion logic by caching the parent ids as we walk the tree. Some further work would be to maintain a stack of parents as we know we visit depth first.
394
        if path is None:
2255.10.1 by John Arbash Meinel
Update WorkingTree4 so that it doesn't use a HashCache,
395
            path = pathjoin(entry[0][0], entry[0][1]).decode('utf8')
396
397
        file_abspath = self.abspath(path)
398
        state = self.current_dirstate()
2485.3.3 by John Arbash Meinel
Avoid extra work in inner 'DirState.update_entry' code.
399
        if stat_value is None:
2499.3.1 by Aaron Bentley
Fix Workingtree4.get_file_sha1 on missing files
400
            try:
401
                stat_value = os.lstat(file_abspath)
402
            except OSError, e:
403
                if e.errno == errno.ENOENT:
404
                    return None
405
                else:
406
                    raise
3696.4.1 by Robert Collins
Refactor to allow a pluggable dirstate update_entry with interface tests.
407
        link_or_sha1 = dirstate.update_entry(state, entry, file_abspath,
408
            stat_value=stat_value)
2255.10.3 by John Arbash Meinel
(broken) Change get_sha1_for_entry into update_entry
409
        if entry[1][0][0] == 'f':
3709.4.1 by Robert Collins
Sha files for the stat cache more lazily rather than on first-examination, allowing less overall sha calculations to occur.
410
            if link_or_sha1 is None:
411
                file_obj, statvalue = self.get_file_with_stat(file_id, path)
412
                try:
413
                    sha1 = osutils.sha_file(file_obj)
414
                finally:
415
                    file_obj.close()
416
                self._observed_sha1(file_id, path, (sha1, statvalue))
417
                return sha1
418
            else:
419
                return link_or_sha1
2255.10.3 by John Arbash Meinel
(broken) Change get_sha1_for_entry into update_entry
420
        return None
2255.2.31 by Robert Collins
Work in progress to make merge_inner work with dirstate trees.
421
2255.2.17 by Robert Collins
tweaks - finishes off all the test_test_trees tests for dirstate.
422
    def _get_inventory(self):
423
        """Get the inventory for the tree. This is only valid within a lock."""
2745.1.1 by Robert Collins
Add a number of -Devil checkpoints.
424
        if 'evil' in debug.debug_flags:
2745.1.2 by Robert Collins
Ensure mutter_callsite is not directly called on a lazy_load object, to make the stacklevel parameter work correctly.
425
            trace.mutter_callsite(2,
2745.1.1 by Robert Collins
Add a number of -Devil checkpoints.
426
                "accessing .inventory forces a size of tree translation.")
2255.2.17 by Robert Collins
tweaks - finishes off all the test_test_trees tests for dirstate.
427
        if self._inventory is not None:
428
            return self._inventory
2255.2.158 by Martin Pool
Most of the integration of dirstate and subtree
429
        self._must_be_locked()
2255.2.17 by Robert Collins
tweaks - finishes off all the test_test_trees tests for dirstate.
430
        self._generate_inventory()
431
        return self._inventory
432
433
    inventory = property(_get_inventory,
434
                         doc="Inventory of this Tree")
435
436
    @needs_read_lock
2255.2.34 by Robert Collins
Fix WorkingTree4 parent_ids logic to use the dirstate to answer parent ids list queries.
437
    def get_parent_ids(self):
438
        """See Tree.get_parent_ids.
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
439
2255.2.34 by Robert Collins
Fix WorkingTree4 parent_ids logic to use the dirstate to answer parent ids list queries.
440
        This implementation requests the ids list from the dirstate file.
441
        """
442
        return self.current_dirstate().get_parent_ids()
443
2255.2.226 by Robert Collins
Get merge_nested finally working: change nested tree iterators to take file_ids, and ensure the right branch is connected to in the merge logic. May not be suitable for shared repositories yet.
444
    def get_reference_revision(self, file_id, path=None):
2255.2.158 by Martin Pool
Most of the integration of dirstate and subtree
445
        # referenced tree's revision is whatever's currently there
2255.2.226 by Robert Collins
Get merge_nested finally working: change nested tree iterators to take file_ids, and ensure the right branch is connected to in the merge logic. May not be suitable for shared repositories yet.
446
        return self.get_nested_tree(file_id, path).last_revision()
2255.2.158 by Martin Pool
Most of the integration of dirstate and subtree
447
2255.2.226 by Robert Collins
Get merge_nested finally working: change nested tree iterators to take file_ids, and ensure the right branch is connected to in the merge logic. May not be suitable for shared repositories yet.
448
    def get_nested_tree(self, file_id, path=None):
2255.2.158 by Martin Pool
Most of the integration of dirstate and subtree
449
        if path is None:
2255.2.226 by Robert Collins
Get merge_nested finally working: change nested tree iterators to take file_ids, and ensure the right branch is connected to in the merge logic. May not be suitable for shared repositories yet.
450
            path = self.id2path(file_id)
451
        # else: check file_id is at path?
2255.2.158 by Martin Pool
Most of the integration of dirstate and subtree
452
        return WorkingTree.open(self.abspath(path))
453
2255.2.34 by Robert Collins
Fix WorkingTree4 parent_ids logic to use the dirstate to answer parent ids list queries.
454
    @needs_read_lock
2255.2.17 by Robert Collins
tweaks - finishes off all the test_test_trees tests for dirstate.
455
    def get_root_id(self):
456
        """Return the id of this trees root"""
2255.2.107 by John Arbash Meinel
(working), fix dirstate to use utf8 file ids.
457
        return self._get_entry(path='')[0][2]
2255.2.31 by Robert Collins
Work in progress to make merge_inner work with dirstate trees.
458
2255.2.22 by Robert Collins
Dirstate: implement WorkingTree4.unversion, letting some test_commit tests pass.
459
    def has_id(self, file_id):
460
        state = self.current_dirstate()
2255.2.92 by James Westby
Make the WorkingTree4 has_id use the new _get_entry rather than _get_row.
461
        row, parents = self._get_entry(file_id=file_id)
2255.2.31 by Robert Collins
Work in progress to make merge_inner work with dirstate trees.
462
        if row is None:
463
            return False
464
        return osutils.lexists(pathjoin(
2255.2.22 by Robert Collins
Dirstate: implement WorkingTree4.unversion, letting some test_commit tests pass.
465
                    self.basedir, row[0].decode('utf8'), row[1].decode('utf8')))
466
2255.2.15 by Robert Collins
Dirstate - truncate state file fixing bug in saving a smaller file, get more tree_implementation tests passing.
467
    @needs_read_lock
2255.2.144 by John Arbash Meinel
Simplify update_minimal a bit more, by making id_index a
468
    def id2path(self, file_id):
2511.1.3 by Ian Clatworthy
remove implicit read locks for kind() and is_executable() in wt4
469
        "Convert a file-id to a path."
2255.2.144 by John Arbash Meinel
Simplify update_minimal a bit more, by making id_index a
470
        state = self.current_dirstate()
2255.2.147 by John Arbash Meinel
Move fast id => path lookups down into DirState
471
        entry = self._get_entry(file_id=file_id)
472
        if entry == (None, None):
2255.11.5 by Martin Pool
Tree.id2path should raise NoSuchId, not return None.
473
            raise errors.NoSuchId(tree=self, file_id=file_id)
2255.2.147 by John Arbash Meinel
Move fast id => path lookups down into DirState
474
        path_utf8 = osutils.pathjoin(entry[0][0], entry[0][1])
475
        return path_utf8.decode('utf8')
2255.2.15 by Robert Collins
Dirstate - truncate state file fixing bug in saving a smaller file, get more tree_implementation tests passing.
476
2911.5.4 by John Arbash Meinel
Switch around to properly look up the executable bit in the basis.
477
    def _is_executable_from_path_and_stat_from_basis(self, path, stat_result):
478
        entry = self._get_entry(path=path)
479
        if entry == (None, None):
480
            return False # Missing entries are not executable
481
        return entry[1][0][3] # Executable?
482
2325.3.2 by John Arbash Meinel
Implement is_executable for WorkingTree4 and win32
483
    if not osutils.supports_executable():
484
        def is_executable(self, file_id, path=None):
2511.1.3 by Ian Clatworthy
remove implicit read locks for kind() and is_executable() in wt4
485
            """Test if a file is executable or not.
486
487
            Note: The caller is expected to take a read-lock before calling this.
488
            """
2325.3.2 by John Arbash Meinel
Implement is_executable for WorkingTree4 and win32
489
            entry = self._get_entry(file_id=file_id, path=path)
490
            if entry == (None, None):
491
                return False
492
            return entry[1][0][3]
2911.5.4 by John Arbash Meinel
Switch around to properly look up the executable bit in the basis.
493
494
        _is_executable_from_path_and_stat = \
495
            _is_executable_from_path_and_stat_from_basis
2325.3.2 by John Arbash Meinel
Implement is_executable for WorkingTree4 and win32
496
    else:
497
        def is_executable(self, file_id, path=None):
2511.1.3 by Ian Clatworthy
remove implicit read locks for kind() and is_executable() in wt4
498
            """Test if a file is executable or not.
499
500
            Note: The caller is expected to take a read-lock before calling this.
501
            """
3146.4.5 by Aaron Bentley
Require a read lock in POSIX is_exectuable implementations, matching win32
502
            self._must_be_locked()
2325.3.2 by John Arbash Meinel
Implement is_executable for WorkingTree4 and win32
503
            if not path:
504
                path = self.id2path(file_id)
505
            mode = os.lstat(self.abspath(path)).st_mode
506
            return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
507
3146.8.16 by Aaron Bentley
Updates from review
508
    def all_file_ids(self):
3146.8.2 by Aaron Bentley
Introduce iter_all_file_ids, to avoid hitting Inventory for this case
509
        """See Tree.iter_all_file_ids"""
510
        self._must_be_locked()
3146.8.16 by Aaron Bentley
Updates from review
511
        result = set()
3146.8.2 by Aaron Bentley
Introduce iter_all_file_ids, to avoid hitting Inventory for this case
512
        for key, tree_details in self.current_dirstate()._iter_entries():
513
            if tree_details[0][0] in ('a', 'r'): # relocated
514
                continue
3146.8.16 by Aaron Bentley
Updates from review
515
            result.add(key[2])
516
        return result
3146.8.2 by Aaron Bentley
Introduce iter_all_file_ids, to avoid hitting Inventory for this case
517
2255.2.15 by Robert Collins
Dirstate - truncate state file fixing bug in saving a smaller file, get more tree_implementation tests passing.
518
    @needs_read_lock
519
    def __iter__(self):
520
        """Iterate through file_ids for this tree.
521
522
        file_ids are in a WorkingTree if they are in the working inventory
523
        and the working file exists.
524
        """
525
        result = []
2255.2.88 by Robert Collins
Significant steps back to operation.
526
        for key, tree_details in self.current_dirstate()._iter_entries():
2255.2.113 by John Arbash Meinel
545ms, 600ms: Switch memory model from storing kind to using minikind
527
            if tree_details[0][0] in ('a', 'r'): # absent, relocated
2255.2.88 by Robert Collins
Significant steps back to operation.
528
                # not relevant to the working tree
2255.2.15 by Robert Collins
Dirstate - truncate state file fixing bug in saving a smaller file, get more tree_implementation tests passing.
529
                continue
2255.2.88 by Robert Collins
Significant steps back to operation.
530
            path = pathjoin(self.basedir, key[0].decode('utf8'), key[1].decode('utf8'))
2255.2.15 by Robert Collins
Dirstate - truncate state file fixing bug in saving a smaller file, get more tree_implementation tests passing.
531
            if osutils.lexists(path):
2255.2.107 by John Arbash Meinel
(working), fix dirstate to use utf8 file ids.
532
                result.append(key[2])
2255.2.15 by Robert Collins
Dirstate - truncate state file fixing bug in saving a smaller file, get more tree_implementation tests passing.
533
        return iter(result)
534
2255.2.226 by Robert Collins
Get merge_nested finally working: change nested tree iterators to take file_ids, and ensure the right branch is connected to in the merge logic. May not be suitable for shared repositories yet.
535
    def iter_references(self):
3504.2.1 by John Arbash Meinel
Shortcut iter_references when we know references aren't supported.
536
        if not self._repo_supports_tree_reference:
537
            # When the repo doesn't support references, we will have nothing to
538
            # return
539
            return
2255.2.226 by Robert Collins
Get merge_nested finally working: change nested tree iterators to take file_ids, and ensure the right branch is connected to in the merge logic. May not be suitable for shared repositories yet.
540
        for key, tree_details in self.current_dirstate()._iter_entries():
541
            if tree_details[0][0] in ('a', 'r'): # absent, relocated
542
                # not relevant to the working tree
543
                continue
544
            if not key[1]:
545
                # the root is not a reference.
546
                continue
3504.2.1 by John Arbash Meinel
Shortcut iter_references when we know references aren't supported.
547
            relpath = pathjoin(key[0].decode('utf8'), key[1].decode('utf8'))
2255.2.229 by Robert Collins
Fix remaining test failures.
548
            try:
3504.2.1 by John Arbash Meinel
Shortcut iter_references when we know references aren't supported.
549
                if self._kind(relpath) == 'tree-reference':
550
                    yield relpath, key[2]
2255.2.229 by Robert Collins
Fix remaining test failures.
551
            except errors.NoSuchFile:
552
                # path is missing on disk.
553
                continue
2255.2.226 by Robert Collins
Get merge_nested finally working: change nested tree iterators to take file_ids, and ensure the right branch is connected to in the merge logic. May not be suitable for shared repositories yet.
554
3709.3.2 by Robert Collins
Race-free stat-fingerprint updating during commit via a new method get_file_with_stat.
555
    def _observed_sha1(self, file_id, path, (sha1, statvalue)):
3709.3.1 by Robert Collins
First cut - make it work - at updating the tree stat cache during commit.
556
        """See MutableTree._observed_sha1."""
557
        state = self.current_dirstate()
558
        entry = self._get_entry(file_id=file_id, path=path)
559
        state._observed_sha1(entry, sha1, statvalue)
560
2255.2.158 by Martin Pool
Most of the integration of dirstate and subtree
561
    def kind(self, file_id):
2255.2.202 by Martin Pool
WorkingTree_4.kind should report tree-references if they're
562
        """Return the kind of a file.
563
564
        This is always the actual kind that's on disk, regardless of what it
565
        was added as.
2511.1.3 by Ian Clatworthy
remove implicit read locks for kind() and is_executable() in wt4
566
567
        Note: The caller is expected to take a read-lock before calling this.
2255.2.202 by Martin Pool
WorkingTree_4.kind should report tree-references if they're
568
        """
569
        relpath = self.id2path(file_id)
3376.2.11 by Martin Pool
Compare to None using is/is not not ==
570
        if relpath is None:
3376.2.4 by Martin Pool
Remove every assert statement from bzrlib!
571
            raise AssertionError(
572
                "path for id {%s} is None!" % file_id)
2255.2.226 by Robert Collins
Get merge_nested finally working: change nested tree iterators to take file_ids, and ensure the right branch is connected to in the merge logic. May not be suitable for shared repositories yet.
573
        return self._kind(relpath)
574
575
    def _kind(self, relpath):
2255.2.202 by Martin Pool
WorkingTree_4.kind should report tree-references if they're
576
        abspath = self.abspath(relpath)
577
        kind = file_kind(abspath)
4100.2.1 by Aaron Bentley
Disable autodetection of tree references
578
        if (self._repo_supports_tree_reference and kind == 'directory'):
579
            entry = self._get_entry(path=relpath)
580
            if entry[1] is not None:
4100.2.4 by Aaron Bentley
More support for not autodetecting tree refs
581
                if entry[1][0][0] == 't':
4100.2.1 by Aaron Bentley
Disable autodetection of tree references
582
                    kind = 'tree-reference'
2255.2.158 by Martin Pool
Most of the integration of dirstate and subtree
583
        return kind
584
2255.2.21 by Robert Collins
Add WorkingTree4._last_revision, making workingtree_implementations.test_changes_from pass.
585
    @needs_read_lock
586
    def _last_revision(self):
587
        """See Mutable.last_revision."""
588
        parent_ids = self.current_dirstate().get_parent_ids()
589
        if parent_ids:
2255.2.84 by John Arbash Meinel
Remove now-unecessary encode/decode calls for revision ids.
590
            return parent_ids[0]
2255.2.21 by Robert Collins
Add WorkingTree4._last_revision, making workingtree_implementations.test_changes_from pass.
591
        else:
2598.5.10 by Aaron Bentley
Return NULL_REVISION instead of None for the null revision
592
            return _mod_revision.NULL_REVISION
2255.2.21 by Robert Collins
Add WorkingTree4._last_revision, making workingtree_implementations.test_changes_from pass.
593
2255.5.2 by John Arbash Meinel
(broken) lock and unlock the DirState object when locking and unlocking the Tree itself
594
    def lock_read(self):
2255.10.2 by John Arbash Meinel
Update to dirstate locking.
595
        """See Branch.lock_read, and WorkingTree.unlock."""
596
        self.branch.lock_read()
597
        try:
598
            self._control_files.lock_read()
599
            try:
600
                state = self.current_dirstate()
601
                if not state._lock_token:
602
                    state.lock_read()
2255.2.232 by Robert Collins
Make WorkingTree4 report support for references based on the repositories capabilities.
603
                # set our support for tree references from the repository in
604
                # use.
605
                self._repo_supports_tree_reference = getattr(
2323.5.16 by Martin Pool
rename support_tree_reference to supports_
606
                    self.branch.repository._format, "supports_tree_reference",
2255.2.232 by Robert Collins
Make WorkingTree4 report support for references based on the repositories capabilities.
607
                    False)
2255.10.2 by John Arbash Meinel
Update to dirstate locking.
608
            except:
609
                self._control_files.unlock()
610
                raise
611
        except:
612
            self.branch.unlock()
613
            raise
614
615
    def _lock_self_write(self):
616
        """This should be called after the branch is locked."""
617
        try:
618
            self._control_files.lock_write()
619
            try:
620
                state = self.current_dirstate()
621
                if not state._lock_token:
622
                    state.lock_write()
2255.2.232 by Robert Collins
Make WorkingTree4 report support for references based on the repositories capabilities.
623
                # set our support for tree references from the repository in
624
                # use.
625
                self._repo_supports_tree_reference = getattr(
2323.5.16 by Martin Pool
rename support_tree_reference to supports_
626
                    self.branch.repository._format, "supports_tree_reference",
2255.2.232 by Robert Collins
Make WorkingTree4 report support for references based on the repositories capabilities.
627
                    False)
2255.10.2 by John Arbash Meinel
Update to dirstate locking.
628
            except:
629
                self._control_files.unlock()
630
                raise
631
        except:
632
            self.branch.unlock()
633
            raise
2255.5.2 by John Arbash Meinel
(broken) lock and unlock the DirState object when locking and unlocking the Tree itself
634
635
    def lock_tree_write(self):
2255.10.2 by John Arbash Meinel
Update to dirstate locking.
636
        """See MutableTree.lock_tree_write, and WorkingTree.unlock."""
637
        self.branch.lock_read()
638
        self._lock_self_write()
2255.5.2 by John Arbash Meinel
(broken) lock and unlock the DirState object when locking and unlocking the Tree itself
639
640
    def lock_write(self):
2255.10.2 by John Arbash Meinel
Update to dirstate locking.
641
        """See MutableTree.lock_write, and WorkingTree.unlock."""
642
        self.branch.lock_write()
643
        self._lock_self_write()
2255.5.2 by John Arbash Meinel
(broken) lock and unlock the DirState object when locking and unlocking the Tree itself
644
2255.2.59 by Robert Collins
All WorkingTree4 and dirstate tests passing.
645
    @needs_tree_write_lock
2255.2.137 by John Arbash Meinel
Move the WorkingTree.move() tests into their own module
646
    def move(self, from_paths, to_dir, after=False):
2255.2.59 by Robert Collins
All WorkingTree4 and dirstate tests passing.
647
        """See WorkingTree.move()."""
2255.7.46 by Robert Collins
Fix WorkingTree4.move to return the moved paths, and update the tree implementation tests for move to check them.
648
        result = []
2255.2.59 by Robert Collins
All WorkingTree4 and dirstate tests passing.
649
        if not from_paths:
2255.7.46 by Robert Collins
Fix WorkingTree4.move to return the moved paths, and update the tree implementation tests for move to check them.
650
            return result
2255.2.59 by Robert Collins
All WorkingTree4 and dirstate tests passing.
651
        state = self.current_dirstate()
3376.2.4 by Martin Pool
Remove every assert statement from bzrlib!
652
        if isinstance(from_paths, basestring):
653
            raise ValueError()
2255.2.59 by Robert Collins
All WorkingTree4 and dirstate tests passing.
654
        to_dir_utf8 = to_dir.encode('utf8')
2255.2.96 by Robert Collins
Restore dirstate to all tests passing condition.
655
        to_entry_dirname, to_basename = os.path.split(to_dir_utf8)
2255.2.146 by John Arbash Meinel
Implement move_directory by factoring out move_one
656
        id_index = state._get_id_index()
2255.2.59 by Robert Collins
All WorkingTree4 and dirstate tests passing.
657
        # check destination directory
658
        # get the details for it
2255.2.96 by Robert Collins
Restore dirstate to all tests passing condition.
659
        to_entry_block_index, to_entry_entry_index, dir_present, entry_present = \
660
            state._get_block_entry_index(to_entry_dirname, to_basename, 0)
661
        if not entry_present:
2255.2.59 by Robert Collins
All WorkingTree4 and dirstate tests passing.
662
            raise errors.BzrMoveFailedError('', to_dir,
2255.7.71 by Robert Collins
Fix blackbox test_mv usage of inventory, and the errors raised by workingtree4.move - though that should be made into a workingtree conformance test.
663
                errors.NotVersionedError(to_dir))
2255.2.96 by Robert Collins
Restore dirstate to all tests passing condition.
664
        to_entry = state._dirblocks[to_entry_block_index][1][to_entry_entry_index]
2255.2.59 by Robert Collins
All WorkingTree4 and dirstate tests passing.
665
        # get a handle on the block itself.
666
        to_block_index = state._ensure_block(
2255.2.96 by Robert Collins
Restore dirstate to all tests passing condition.
667
            to_entry_block_index, to_entry_entry_index, to_dir_utf8)
2255.2.59 by Robert Collins
All WorkingTree4 and dirstate tests passing.
668
        to_block = state._dirblocks[to_block_index]
669
        to_abs = self.abspath(to_dir)
670
        if not isdir(to_abs):
671
            raise errors.BzrMoveFailedError('',to_dir,
672
                errors.NotADirectory(to_abs))
673
2255.2.113 by John Arbash Meinel
545ms, 600ms: Switch memory model from storing kind to using minikind
674
        if to_entry[1][0][0] != 'd':
2255.2.59 by Robert Collins
All WorkingTree4 and dirstate tests passing.
675
            raise errors.BzrMoveFailedError('',to_dir,
676
                errors.NotADirectory(to_abs))
677
678
        if self._inventory is not None:
679
            update_inventory = True
680
            inv = self.inventory
3201.2.1 by Lukáš Lalinský
Make 'mv a b' work for already renamed directories, like it does for files
681
            to_dir_id = to_entry[0][2]
2255.2.59 by Robert Collins
All WorkingTree4 and dirstate tests passing.
682
            to_dir_ie = inv[to_dir_id]
683
        else:
684
            update_inventory = False
685
2255.2.146 by John Arbash Meinel
Implement move_directory by factoring out move_one
686
        rollbacks = []
687
        def move_one(old_entry, from_path_utf8, minikind, executable,
688
                     fingerprint, packed_stat, size,
689
                     to_block, to_key, to_path_utf8):
690
            state._make_absent(old_entry)
691
            from_key = old_entry[0]
692
            rollbacks.append(
693
                lambda:state.update_minimal(from_key,
694
                    minikind,
695
                    executable=executable,
696
                    fingerprint=fingerprint,
697
                    packed_stat=packed_stat,
698
                    size=size,
699
                    path_utf8=from_path_utf8))
700
            state.update_minimal(to_key,
701
                    minikind,
702
                    executable=executable,
703
                    fingerprint=fingerprint,
704
                    packed_stat=packed_stat,
705
                    size=size,
706
                    path_utf8=to_path_utf8)
707
            added_entry_index, _ = state._find_entry_index(to_key, to_block[1])
708
            new_entry = to_block[1][added_entry_index]
709
            rollbacks.append(lambda:state._make_absent(new_entry))
710
2255.2.59 by Robert Collins
All WorkingTree4 and dirstate tests passing.
711
        for from_rel in from_paths:
712
            # from_rel is 'pathinroot/foo/bar'
2255.2.146 by John Arbash Meinel
Implement move_directory by factoring out move_one
713
            from_rel_utf8 = from_rel.encode('utf8')
714
            from_dirname, from_tail = osutils.split(from_rel)
715
            from_dirname, from_tail_utf8 = osutils.split(from_rel_utf8)
2255.2.96 by Robert Collins
Restore dirstate to all tests passing condition.
716
            from_entry = self._get_entry(path=from_rel)
717
            if from_entry == (None, None):
2255.2.59 by Robert Collins
All WorkingTree4 and dirstate tests passing.
718
                raise errors.BzrMoveFailedError(from_rel,to_dir,
719
                    errors.NotVersionedError(path=str(from_rel)))
720
2255.2.107 by John Arbash Meinel
(working), fix dirstate to use utf8 file ids.
721
            from_id = from_entry[0][2]
2255.2.59 by Robert Collins
All WorkingTree4 and dirstate tests passing.
722
            to_rel = pathjoin(to_dir, from_tail)
2255.2.146 by John Arbash Meinel
Implement move_directory by factoring out move_one
723
            to_rel_utf8 = pathjoin(to_dir_utf8, from_tail_utf8)
2255.2.96 by Robert Collins
Restore dirstate to all tests passing condition.
724
            item_to_entry = self._get_entry(path=to_rel)
725
            if item_to_entry != (None, None):
2255.2.59 by Robert Collins
All WorkingTree4 and dirstate tests passing.
726
                raise errors.BzrMoveFailedError(from_rel, to_rel,
727
                    "Target is already versioned.")
728
729
            if from_rel == to_rel:
730
                raise errors.BzrMoveFailedError(from_rel, to_rel,
731
                    "Source and target are identical.")
732
733
            from_missing = not self.has_filename(from_rel)
734
            to_missing = not self.has_filename(to_rel)
735
            if after:
736
                move_file = False
737
            else:
738
                move_file = True
739
            if to_missing:
740
                if not move_file:
741
                    raise errors.BzrMoveFailedError(from_rel, to_rel,
742
                        errors.NoSuchFile(path=to_rel,
743
                        extra="New file has not been created yet"))
744
                elif from_missing:
745
                    # neither path exists
746
                    raise errors.BzrRenameFailedError(from_rel, to_rel,
747
                        errors.PathsDoNotExist(paths=(from_rel, to_rel)))
748
            else:
749
                if from_missing: # implicitly just update our path mapping
750
                    move_file = False
2255.2.139 by John Arbash Meinel
test cases for moving after a file has already been moved.
751
                elif not after:
2967.3.6 by Daniel Watkins
Extracted the string from every use of RenameFailedFilesExist to RenameFailedFilesExist itself.
752
                    raise errors.RenameFailedFilesExist(from_rel, to_rel)
2255.2.59 by Robert Collins
All WorkingTree4 and dirstate tests passing.
753
754
            rollbacks = []
755
            def rollback_rename():
756
                """A single rename has failed, roll it back."""
2255.2.236 by Martin Pool
Review cleanups: mostly updating or removing todo comments.
757
                # roll back everything, even if we encounter trouble doing one
758
                # of them.
759
                #
760
                # TODO: at least log the other exceptions rather than just
761
                # losing them mbp 20070307
2255.2.138 by John Arbash Meinel
implement several new WorkingTree.move() tests
762
                exc_info = None
2255.2.59 by Robert Collins
All WorkingTree4 and dirstate tests passing.
763
                for rollback in reversed(rollbacks):
764
                    try:
765
                        rollback()
2255.2.96 by Robert Collins
Restore dirstate to all tests passing condition.
766
                    except Exception, e:
2255.2.138 by John Arbash Meinel
implement several new WorkingTree.move() tests
767
                        exc_info = sys.exc_info()
768
                if exc_info:
769
                    raise exc_info[0], exc_info[1], exc_info[2]
2255.2.59 by Robert Collins
All WorkingTree4 and dirstate tests passing.
770
771
            # perform the disk move first - its the most likely failure point.
2255.2.139 by John Arbash Meinel
test cases for moving after a file has already been moved.
772
            if move_file:
773
                from_rel_abs = self.abspath(from_rel)
774
                to_rel_abs = self.abspath(to_rel)
775
                try:
776
                    osutils.rename(from_rel_abs, to_rel_abs)
777
                except OSError, e:
778
                    raise errors.BzrMoveFailedError(from_rel, to_rel, e[1])
2255.2.140 by John Arbash Meinel
Update tests to ensure basis tree is not modified
779
                rollbacks.append(lambda: osutils.rename(to_rel_abs, from_rel_abs))
2255.2.59 by Robert Collins
All WorkingTree4 and dirstate tests passing.
780
            try:
781
                # perform the rename in the inventory next if needed: its easy
782
                # to rollback
783
                if update_inventory:
784
                    # rename the entry
785
                    from_entry = inv[from_id]
786
                    current_parent = from_entry.parent_id
787
                    inv.rename(from_id, to_dir_id, from_tail)
788
                    rollbacks.append(
789
                        lambda: inv.rename(from_id, current_parent, from_tail))
790
                # finally do the rename in the dirstate, which is a little
791
                # tricky to rollback, but least likely to need it.
2255.2.96 by Robert Collins
Restore dirstate to all tests passing condition.
792
                old_block_index, old_entry_index, dir_present, file_present = \
2255.2.146 by John Arbash Meinel
Implement move_directory by factoring out move_one
793
                    state._get_block_entry_index(from_dirname, from_tail_utf8, 0)
2255.2.59 by Robert Collins
All WorkingTree4 and dirstate tests passing.
794
                old_block = state._dirblocks[old_block_index][1]
2255.2.146 by John Arbash Meinel
Implement move_directory by factoring out move_one
795
                old_entry = old_block[old_entry_index]
796
                from_key, old_entry_details = old_entry
797
                cur_details = old_entry_details[0]
2255.2.59 by Robert Collins
All WorkingTree4 and dirstate tests passing.
798
                # remove the old row
2255.2.96 by Robert Collins
Restore dirstate to all tests passing condition.
799
                to_key = ((to_block[0],) + from_key[1:3])
2255.2.146 by John Arbash Meinel
Implement move_directory by factoring out move_one
800
                minikind = cur_details[0]
801
                move_one(old_entry, from_path_utf8=from_rel_utf8,
802
                         minikind=minikind,
803
                         executable=cur_details[3],
804
                         fingerprint=cur_details[1],
805
                         packed_stat=cur_details[4],
806
                         size=cur_details[2],
807
                         to_block=to_block,
808
                         to_key=to_key,
809
                         to_path_utf8=to_rel_utf8)
810
811
                if minikind == 'd':
812
                    def update_dirblock(from_dir, to_key, to_dir_utf8):
2438.1.5 by John Arbash Meinel
Fix the bug by not iterating over the same list we are modifying.
813
                        """Recursively update all entries in this dirblock."""
3376.2.4 by Martin Pool
Remove every assert statement from bzrlib!
814
                        if from_dir == '':
815
                            raise AssertionError("renaming root not supported")
2255.2.146 by John Arbash Meinel
Implement move_directory by factoring out move_one
816
                        from_key = (from_dir, '')
817
                        from_block_idx, present = \
818
                            state._find_block_index_from_key(from_key)
819
                        if not present:
820
                            # This is the old record, if it isn't present, then
821
                            # there is theoretically nothing to update.
822
                            # (Unless it isn't present because of lazy loading,
823
                            # but we don't do that yet)
824
                            return
825
                        from_block = state._dirblocks[from_block_idx]
826
                        to_block_index, to_entry_index, _, _ = \
827
                            state._get_block_entry_index(to_key[0], to_key[1], 0)
828
                        to_block_index = state._ensure_block(
829
                            to_block_index, to_entry_index, to_dir_utf8)
830
                        to_block = state._dirblocks[to_block_index]
2438.1.5 by John Arbash Meinel
Fix the bug by not iterating over the same list we are modifying.
831
832
                        # Grab a copy since move_one may update the list.
833
                        for entry in from_block[1][:]:
3376.2.4 by Martin Pool
Remove every assert statement from bzrlib!
834
                            if not (entry[0][0] == from_dir):
835
                                raise AssertionError()
2255.2.146 by John Arbash Meinel
Implement move_directory by factoring out move_one
836
                            cur_details = entry[1][0]
837
                            to_key = (to_dir_utf8, entry[0][1], entry[0][2])
838
                            from_path_utf8 = osutils.pathjoin(entry[0][0], entry[0][1])
839
                            to_path_utf8 = osutils.pathjoin(to_dir_utf8, entry[0][1])
840
                            minikind = cur_details[0]
2438.1.10 by John Arbash Meinel
Make WT4.move() properly handle moving a directory with a renamed child.
841
                            if minikind in 'ar':
2438.1.8 by John Arbash Meinel
Fix the case when renaming a directory with deleted children.
842
                                # Deleted children of a renamed directory
843
                                # Do not need to be updated.
2438.1.10 by John Arbash Meinel
Make WT4.move() properly handle moving a directory with a renamed child.
844
                                # Children that have been renamed out of this
845
                                # directory should also not be updated
2438.1.8 by John Arbash Meinel
Fix the case when renaming a directory with deleted children.
846
                                continue
2255.2.146 by John Arbash Meinel
Implement move_directory by factoring out move_one
847
                            move_one(entry, from_path_utf8=from_path_utf8,
848
                                     minikind=minikind,
849
                                     executable=cur_details[3],
850
                                     fingerprint=cur_details[1],
851
                                     packed_stat=cur_details[4],
852
                                     size=cur_details[2],
853
                                     to_block=to_block,
854
                                     to_key=to_key,
2371.2.1 by John Arbash Meinel
Update DirState._validate() to detect rename errors.
855
                                     to_path_utf8=to_path_utf8)
2255.2.146 by John Arbash Meinel
Implement move_directory by factoring out move_one
856
                            if minikind == 'd':
857
                                # We need to move all the children of this
858
                                # entry
859
                                update_dirblock(from_path_utf8, to_key,
860
                                                to_path_utf8)
861
                    update_dirblock(from_rel_utf8, to_key, to_rel_utf8)
2255.2.59 by Robert Collins
All WorkingTree4 and dirstate tests passing.
862
            except:
863
                rollback_rename()
864
                raise
2255.7.46 by Robert Collins
Fix WorkingTree4.move to return the moved paths, and update the tree implementation tests for move to check them.
865
            result.append((from_rel, to_rel))
2255.2.59 by Robert Collins
All WorkingTree4 and dirstate tests passing.
866
            state._dirblock_state = dirstate.DirState.IN_MEMORY_MODIFIED
2255.7.67 by Robert Collins
Fix test_inv - make setting WorkingTree4._dirty use a helper to reduce code duplication, and reset the inventory when we dont manually update it, if it exists.
867
            self._make_dirty(reset_inventory=False)
2255.2.59 by Robert Collins
All WorkingTree4 and dirstate tests passing.
868
2255.7.46 by Robert Collins
Fix WorkingTree4.move to return the moved paths, and update the tree implementation tests for move to check them.
869
        return result
2255.2.59 by Robert Collins
All WorkingTree4 and dirstate tests passing.
870
2255.2.158 by Martin Pool
Most of the integration of dirstate and subtree
871
    def _must_be_locked(self):
872
        if not self._control_files._lock_count:
873
            raise errors.ObjectNotLocked(self)
874
2255.2.3 by Robert Collins
Split out working tree format 4 to its own file, create stub dirstate revision object, start working on dirstate.set_parent_trees - a key failure point.
875
    def _new_tree(self):
876
        """Initialize the state in this tree to be a new tree."""
877
        self._dirty = True
878
879
    @needs_read_lock
2255.2.17 by Robert Collins
tweaks - finishes off all the test_test_trees tests for dirstate.
880
    def path2id(self, path):
881
        """Return the id for path in this tree."""
2255.7.56 by Robert Collins
Document behaviour of tree.path2id("path/").
882
        path = path.strip('/')
2255.2.88 by Robert Collins
Significant steps back to operation.
883
        entry = self._get_entry(path=path)
884
        if entry == (None, None):
2255.2.59 by Robert Collins
All WorkingTree4 and dirstate tests passing.
885
            return None
2255.2.107 by John Arbash Meinel
(working), fix dirstate to use utf8 file ids.
886
        return entry[0][2]
2255.2.17 by Robert Collins
tweaks - finishes off all the test_test_trees tests for dirstate.
887
2255.2.104 by Robert Collins
Add WorkingTree4.paths2ids which is inventory-usage free if the trees being examined are in the dirstate.
888
    def paths2ids(self, paths, trees=[], require_versioned=True):
889
        """See Tree.paths2ids().
2255.7.24 by John Arbash Meinel
Rework cmd_inventory so that it uses paths2ids and locks the trees for read.
890
2255.2.104 by Robert Collins
Add WorkingTree4.paths2ids which is inventory-usage free if the trees being examined are in the dirstate.
891
        This specialisation fast-paths the case where all the trees are in the
892
        dirstate.
893
        """
894
        if paths is None:
895
            return None
896
        parents = self.get_parent_ids()
897
        for tree in trees:
898
            if not (isinstance(tree, DirStateRevisionTree) and tree._revision_id in
899
                parents):
3907.2.3 by Ian Clatworthy
DirStateWorkingTree and DirStateWorkingTreeFormat base classes introduced
900
                return super(DirStateWorkingTree, self).paths2ids(paths,
901
                    trees, require_versioned)
2255.2.104 by Robert Collins
Add WorkingTree4.paths2ids which is inventory-usage free if the trees being examined are in the dirstate.
902
        search_indexes = [0] + [1 + parents.index(tree._revision_id) for tree in trees]
903
        # -- make all paths utf8 --
904
        paths_utf8 = set()
905
        for path in paths:
906
            paths_utf8.add(path.encode('utf8'))
907
        paths = paths_utf8
908
        # -- paths is now a utf8 path set --
909
        # -- get the state object and prepare it.
910
        state = self.current_dirstate()
2255.2.133 by John Arbash Meinel
Implement _paths2ids using bisect recursive rather than loading
911
        if False and (state._dirblock_state == dirstate.DirState.NOT_IN_MEMORY
912
            and '' not in paths):
913
            paths2ids = self._paths2ids_using_bisect
914
        else:
915
            paths2ids = self._paths2ids_in_memory
916
        return paths2ids(paths, search_indexes,
917
                         require_versioned=require_versioned)
918
919
    def _paths2ids_in_memory(self, paths, search_indexes,
920
                             require_versioned=True):
921
        state = self.current_dirstate()
2255.2.104 by Robert Collins
Add WorkingTree4.paths2ids which is inventory-usage free if the trees being examined are in the dirstate.
922
        state._read_dirblocks_if_needed()
923
        def _entries_for_path(path):
924
            """Return a list with all the entries that match path for all ids.
925
            """
926
            dirname, basename = os.path.split(path)
927
            key = (dirname, basename, '')
928
            block_index, present = state._find_block_index_from_key(key)
929
            if not present:
930
                # the block which should contain path is absent.
931
                return []
932
            result = []
933
            block = state._dirblocks[block_index][1]
934
            entry_index, _ = state._find_entry_index(key, block)
935
            # we may need to look at multiple entries at this path: walk while the paths match.
936
            while (entry_index < len(block) and
937
                block[entry_index][0][0:2] == key[0:2]):
938
                result.append(block[entry_index])
939
                entry_index += 1
940
            return result
941
        if require_versioned:
2255.2.149 by Robert Collins
Crufty but existing _iter_changes implementation for WorkingTreeFormat4.
942
            # -- check all supplied paths are versioned in a search tree. --
2255.2.104 by Robert Collins
Add WorkingTree4.paths2ids which is inventory-usage free if the trees being examined are in the dirstate.
943
            all_versioned = True
944
            for path in paths:
945
                path_entries = _entries_for_path(path)
946
                if not path_entries:
947
                    # this specified path is not present at all: error
948
                    all_versioned = False
949
                    break
950
                found_versioned = False
951
                # for each id at this path
952
                for entry in path_entries:
953
                    # for each tree.
954
                    for index in search_indexes:
2255.2.113 by John Arbash Meinel
545ms, 600ms: Switch memory model from storing kind to using minikind
955
                        if entry[1][index][0] != 'a': # absent
2255.2.104 by Robert Collins
Add WorkingTree4.paths2ids which is inventory-usage free if the trees being examined are in the dirstate.
956
                            found_versioned = True
957
                            # all good: found a versioned cell
958
                            break
959
                if not found_versioned:
2255.2.113 by John Arbash Meinel
545ms, 600ms: Switch memory model from storing kind to using minikind
960
                    # none of the indexes was not 'absent' at all ids for this
2255.2.104 by Robert Collins
Add WorkingTree4.paths2ids which is inventory-usage free if the trees being examined are in the dirstate.
961
                    # path.
962
                    all_versioned = False
963
                    break
964
            if not all_versioned:
965
                raise errors.PathsNotVersionedError(paths)
966
        # -- remove redundancy in supplied paths to prevent over-scanning --
2825.7.1 by Robert Collins
* Partial commits are now approximately 40% faster by walking over the
967
        search_paths = osutils.minimum_path_selection(paths)
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
968
        # sketch:
2255.2.104 by Robert Collins
Add WorkingTree4.paths2ids which is inventory-usage free if the trees being examined are in the dirstate.
969
        # for all search_indexs in each path at or under each element of
970
        # search_paths, if the detail is relocated: add the id, and add the
971
        # relocated path as one to search if its not searched already. If the
972
        # detail is not relocated, add the id.
973
        searched_paths = set()
974
        found_ids = set()
975
        def _process_entry(entry):
976
            """Look at search_indexes within entry.
977
978
            If a specific tree's details are relocated, add the relocation
979
            target to search_paths if not searched already. If it is absent, do
980
            nothing. Otherwise add the id to found_ids.
981
            """
982
            for index in search_indexes:
2255.2.113 by John Arbash Meinel
545ms, 600ms: Switch memory model from storing kind to using minikind
983
                if entry[1][index][0] == 'r': # relocated
2255.2.104 by Robert Collins
Add WorkingTree4.paths2ids which is inventory-usage free if the trees being examined are in the dirstate.
984
                    if not osutils.is_inside_any(searched_paths, entry[1][index][1]):
985
                        search_paths.add(entry[1][index][1])
2255.2.113 by John Arbash Meinel
545ms, 600ms: Switch memory model from storing kind to using minikind
986
                elif entry[1][index][0] != 'a': # absent
2255.2.104 by Robert Collins
Add WorkingTree4.paths2ids which is inventory-usage free if the trees being examined are in the dirstate.
987
                    found_ids.add(entry[0][2])
988
        while search_paths:
989
            current_root = search_paths.pop()
990
            searched_paths.add(current_root)
991
            # process the entries for this containing directory: the rest will be
992
            # found by their parents recursively.
993
            root_entries = _entries_for_path(current_root)
994
            if not root_entries:
995
                # this specified path is not present at all, skip it.
996
                continue
997
            for entry in root_entries:
998
                _process_entry(entry)
999
            initial_key = (current_root, '', '')
1000
            block_index, _ = state._find_block_index_from_key(initial_key)
1001
            while (block_index < len(state._dirblocks) and
1002
                osutils.is_inside(current_root, state._dirblocks[block_index][0])):
1003
                for entry in state._dirblocks[block_index][1]:
1004
                    _process_entry(entry)
1005
                block_index += 1
1006
        return found_ids
1007
2255.2.133 by John Arbash Meinel
Implement _paths2ids using bisect recursive rather than loading
1008
    def _paths2ids_using_bisect(self, paths, search_indexes,
1009
                                require_versioned=True):
1010
        state = self.current_dirstate()
1011
        found_ids = set()
1012
1013
        split_paths = sorted(osutils.split(p) for p in paths)
1014
        found = state._bisect_recursive(split_paths)
1015
1016
        if require_versioned:
1017
            found_dir_names = set(dir_name_id[:2] for dir_name_id in found)
1018
            for dir_name in split_paths:
1019
                if dir_name not in found_dir_names:
1020
                    raise errors.PathsNotVersionedError(paths)
1021
1022
        for dir_name_id, trees_info in found.iteritems():
1023
            for index in search_indexes:
1024
                if trees_info[index][0] not in ('r', 'a'):
1025
                    found_ids.add(dir_name_id[2])
1026
        return found_ids
1027
2255.2.45 by Robert Collins
Dirstate - fix revision_tree() behaviour to match the interface contract.
1028
    def read_working_inventory(self):
1029
        """Read the working inventory.
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
1030
2255.2.45 by Robert Collins
Dirstate - fix revision_tree() behaviour to match the interface contract.
1031
        This is a meaningless operation for dirstate, but we obey it anyhow.
1032
        """
1033
        return self.inventory
1034
2255.2.17 by Robert Collins
tweaks - finishes off all the test_test_trees tests for dirstate.
1035
    @needs_read_lock
2255.2.3 by Robert Collins
Split out working tree format 4 to its own file, create stub dirstate revision object, start working on dirstate.set_parent_trees - a key failure point.
1036
    def revision_tree(self, revision_id):
1037
        """See Tree.revision_tree.
1038
1039
        WorkingTree4 supplies revision_trees for any basis tree.
1040
        """
1041
        dirstate = self.current_dirstate()
1042
        parent_ids = dirstate.get_parent_ids()
1043
        if revision_id not in parent_ids:
1044
            raise errors.NoSuchRevisionInTree(self, revision_id)
2255.2.45 by Robert Collins
Dirstate - fix revision_tree() behaviour to match the interface contract.
1045
        if revision_id in dirstate.get_ghosts():
1046
            raise errors.NoSuchRevisionInTree(self, revision_id)
2255.2.3 by Robert Collins
Split out working tree format 4 to its own file, create stub dirstate revision object, start working on dirstate.set_parent_trees - a key failure point.
1047
        return DirStateRevisionTree(dirstate, revision_id,
1048
            self.branch.repository)
1049
2255.2.22 by Robert Collins
Dirstate: implement WorkingTree4.unversion, letting some test_commit tests pass.
1050
    @needs_tree_write_lock
2255.2.37 by Robert Collins
Get TestExecutable.test_06_pull working on DirState: fix cloning and the set_last_revision api on WorkingTree4.
1051
    def set_last_revision(self, new_revision):
1052
        """Change the last revision in the working tree."""
1053
        parents = self.get_parent_ids()
1054
        if new_revision in (NULL_REVISION, None):
3376.2.4 by Martin Pool
Remove every assert statement from bzrlib!
1055
            if len(parents) >= 2:
1056
                raise AssertionError(
1057
                    "setting the last parent to none with a pending merge is "
1058
                    "unsupported.")
2255.2.37 by Robert Collins
Get TestExecutable.test_06_pull working on DirState: fix cloning and the set_last_revision api on WorkingTree4.
1059
            self.set_parent_ids([])
1060
        else:
2255.2.56 by Robert Collins
Dirstate: bring set_last_revision into line with the tested API.
1061
            self.set_parent_ids([new_revision] + parents[1:],
1062
                allow_leftmost_as_ghost=True)
2255.2.37 by Robert Collins
Get TestExecutable.test_06_pull working on DirState: fix cloning and the set_last_revision api on WorkingTree4.
1063
1064
    @needs_tree_write_lock
2255.2.3 by Robert Collins
Split out working tree format 4 to its own file, create stub dirstate revision object, start working on dirstate.set_parent_trees - a key failure point.
1065
    def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
1066
        """Set the parent ids to revision_ids.
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
1067
2255.2.3 by Robert Collins
Split out working tree format 4 to its own file, create stub dirstate revision object, start working on dirstate.set_parent_trees - a key failure point.
1068
        See also set_parent_trees. This api will try to retrieve the tree data
1069
        for each element of revision_ids from the trees repository. If you have
1070
        tree data already available, it is more efficient to use
1071
        set_parent_trees rather than set_parent_ids. set_parent_ids is however
1072
        an easier API to use.
1073
1074
        :param revision_ids: The revision_ids to set as the parent ids of this
1075
            working tree. Any of these may be ghosts.
1076
        """
1077
        trees = []
1078
        for revision_id in revision_ids:
1079
            try:
1080
                revtree = self.branch.repository.revision_tree(revision_id)
2255.2.24 by John Arbash Meinel
When adding ghosts revision_tree() raises RevisionNotPresent because of Knit, not NoSuchRevision
1081
                # TODO: jam 20070213 KnitVersionedFile raises
1082
                #       RevisionNotPresent rather than NoSuchRevision if a
1083
                #       given revision_id is not present. Should Repository be
1084
                #       catching it and re-raising NoSuchRevision?
1085
            except (errors.NoSuchRevision, errors.RevisionNotPresent):
2255.2.3 by Robert Collins
Split out working tree format 4 to its own file, create stub dirstate revision object, start working on dirstate.set_parent_trees - a key failure point.
1086
                revtree = None
1087
            trees.append((revision_id, revtree))
1088
        self.set_parent_trees(trees,
1089
            allow_leftmost_as_ghost=allow_leftmost_as_ghost)
1090
2255.2.22 by Robert Collins
Dirstate: implement WorkingTree4.unversion, letting some test_commit tests pass.
1091
    @needs_tree_write_lock
2255.2.3 by Robert Collins
Split out working tree format 4 to its own file, create stub dirstate revision object, start working on dirstate.set_parent_trees - a key failure point.
1092
    def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
1093
        """Set the parents of the working tree.
1094
2255.2.84 by John Arbash Meinel
Remove now-unecessary encode/decode calls for revision ids.
1095
        :param parents_list: A list of (revision_id, tree) tuples.
2255.2.3 by Robert Collins
Split out working tree format 4 to its own file, create stub dirstate revision object, start working on dirstate.set_parent_trees - a key failure point.
1096
            If tree is None, then that element is treated as an unreachable
1097
            parent tree - i.e. a ghost.
1098
        """
1099
        dirstate = self.current_dirstate()
1100
        if len(parents_list) > 0:
1101
            if not allow_leftmost_as_ghost and parents_list[0][1] is None:
2255.2.42 by Robert Collins
Fix WorkingTree4.set_parent_trees.
1102
                raise errors.GhostRevisionUnusableHere(parents_list[0][0])
2255.2.3 by Robert Collins
Split out working tree format 4 to its own file, create stub dirstate revision object, start working on dirstate.set_parent_trees - a key failure point.
1103
        real_trees = []
1104
        ghosts = []
3462.1.2 by John Arbash Meinel
Change WT.set_parent_(ids/trees) to filter out ancestors.
1105
1106
        parent_ids = [rev_id for rev_id, tree in parents_list]
1107
        graph = self.branch.repository.get_graph()
1108
        heads = graph.heads(parent_ids)
1109
        accepted_revisions = set()
1110
2255.2.84 by John Arbash Meinel
Remove now-unecessary encode/decode calls for revision ids.
1111
        # convert absent trees to the null tree, which we convert back to
2255.2.3 by Robert Collins
Split out working tree format 4 to its own file, create stub dirstate revision object, start working on dirstate.set_parent_trees - a key failure point.
1112
        # missing on access.
1113
        for rev_id, tree in parents_list:
3462.1.2 by John Arbash Meinel
Change WT.set_parent_(ids/trees) to filter out ancestors.
1114
            if len(accepted_revisions) > 0:
1115
                # we always accept the first tree
1116
                if rev_id in accepted_revisions or rev_id not in heads:
1117
                    # We have already included either this tree, or its
1118
                    # descendent, so we skip it.
1119
                    continue
2598.5.2 by Aaron Bentley
Got all tests passing with Branch returning 'null:' for null revision
1120
            _mod_revision.check_not_reserved_id(rev_id)
2255.2.3 by Robert Collins
Split out working tree format 4 to its own file, create stub dirstate revision object, start working on dirstate.set_parent_trees - a key failure point.
1121
            if tree is not None:
1122
                real_trees.append((rev_id, tree))
1123
            else:
1124
                real_trees.append((rev_id,
3668.5.1 by Jelmer Vernooij
Use NULL_REVISION rather than None for Repository.revision_tree().
1125
                    self.branch.repository.revision_tree(
1126
                        _mod_revision.NULL_REVISION)))
2255.2.3 by Robert Collins
Split out working tree format 4 to its own file, create stub dirstate revision object, start working on dirstate.set_parent_trees - a key failure point.
1127
                ghosts.append(rev_id)
3462.1.2 by John Arbash Meinel
Change WT.set_parent_(ids/trees) to filter out ancestors.
1128
            accepted_revisions.add(rev_id)
2255.2.3 by Robert Collins
Split out working tree format 4 to its own file, create stub dirstate revision object, start working on dirstate.set_parent_trees - a key failure point.
1129
        dirstate.set_parent_trees(real_trees, ghosts=ghosts)
2255.7.67 by Robert Collins
Fix test_inv - make setting WorkingTree4._dirty use a helper to reduce code duplication, and reset the inventory when we dont manually update it, if it exists.
1130
        self._make_dirty(reset_inventory=False)
2255.2.3 by Robert Collins
Split out working tree format 4 to its own file, create stub dirstate revision object, start working on dirstate.set_parent_trees - a key failure point.
1131
2255.2.15 by Robert Collins
Dirstate - truncate state file fixing bug in saving a smaller file, get more tree_implementation tests passing.
1132
    def _set_root_id(self, file_id):
1133
        """See WorkingTree.set_root_id."""
2255.2.37 by Robert Collins
Get TestExecutable.test_06_pull working on DirState: fix cloning and the set_last_revision api on WorkingTree4.
1134
        state = self.current_dirstate()
1135
        state.set_path_id('', file_id)
2255.7.67 by Robert Collins
Fix test_inv - make setting WorkingTree4._dirty use a helper to reduce code duplication, and reset the inventory when we dont manually update it, if it exists.
1136
        if state._dirblock_state == dirstate.DirState.IN_MEMORY_MODIFIED:
1137
            self._make_dirty(reset_inventory=True)
2255.2.15 by Robert Collins
Dirstate - truncate state file fixing bug in saving a smaller file, get more tree_implementation tests passing.
1138
2776.1.8 by Robert Collins
Retrieve the sha from the dirstate for path_content_summary on hash cache hits; slight performance hit but a big win for incremental commits.
1139
    def _sha_from_stat(self, path, stat_result):
1140
        """Get a sha digest from the tree's stat cache.
1141
1142
        The default implementation assumes no stat cache is present.
1143
1144
        :param path: The path.
1145
        :param stat_result: The stat result being looked up.
1146
        """
2929.1.1 by Robert Collins
Use a dict to access stat cache information from dirstate.
1147
        return self.current_dirstate().sha1_from_stat(path, stat_result)
2776.1.8 by Robert Collins
Retrieve the sha from the dirstate for path_content_summary on hash cache hits; slight performance hit but a big win for incremental commits.
1148
2255.2.232 by Robert Collins
Make WorkingTree4 report support for references based on the repositories capabilities.
1149
    @needs_read_lock
1150
    def supports_tree_reference(self):
1151
        return self._repo_supports_tree_reference
1152
2255.2.3 by Robert Collins
Split out working tree format 4 to its own file, create stub dirstate revision object, start working on dirstate.set_parent_trees - a key failure point.
1153
    def unlock(self):
1154
        """Unlock in format 4 trees needs to write the entire dirstate."""
2665.3.3 by Daniel Watkins
Added _cleanup() to the unlock() method of all implementations of WorkingTree so that the cached ignore definitions are wiped when a lock is lost.
1155
        # do non-implementation specific cleanup
1156
        self._cleanup()
1157
2255.2.3 by Robert Collins
Split out working tree format 4 to its own file, create stub dirstate revision object, start working on dirstate.set_parent_trees - a key failure point.
1158
        if self._control_files._lock_count == 1:
1159
            # eventually we should do signature checking during read locks for
1160
            # dirstate updates.
1161
            if self._control_files._lock_mode == 'w':
1162
                if self._dirty:
1163
                    self.flush()
2255.5.2 by John Arbash Meinel
(broken) lock and unlock the DirState object when locking and unlocking the Tree itself
1164
            if self._dirstate is not None:
2255.10.2 by John Arbash Meinel
Update to dirstate locking.
1165
                # This is a no-op if there are no modifications.
1166
                self._dirstate.save()
2255.5.2 by John Arbash Meinel
(broken) lock and unlock the DirState object when locking and unlocking the Tree itself
1167
                self._dirstate.unlock()
2255.10.2 by John Arbash Meinel
Update to dirstate locking.
1168
            # TODO: jam 20070301 We shouldn't have to wipe the dirstate at this
1169
            #       point. Instead, it could check if the header has been
1170
            #       modified when it is locked, and if not, it can hang on to
1171
            #       the data it has in memory.
2255.2.3 by Robert Collins
Split out working tree format 4 to its own file, create stub dirstate revision object, start working on dirstate.set_parent_trees - a key failure point.
1172
            self._dirstate = None
2255.2.15 by Robert Collins
Dirstate - truncate state file fixing bug in saving a smaller file, get more tree_implementation tests passing.
1173
            self._inventory = None
2255.2.3 by Robert Collins
Split out working tree format 4 to its own file, create stub dirstate revision object, start working on dirstate.set_parent_trees - a key failure point.
1174
        # reverse order of locking.
1175
        try:
1176
            return self._control_files.unlock()
1177
        finally:
1178
            self.branch.unlock()
1179
2255.2.22 by Robert Collins
Dirstate: implement WorkingTree4.unversion, letting some test_commit tests pass.
1180
    @needs_tree_write_lock
1181
    def unversion(self, file_ids):
1182
        """Remove the file ids in file_ids from the current versioned set.
1183
1184
        When a file_id is unversioned, all of its children are automatically
1185
        unversioned.
1186
1187
        :param file_ids: The file ids to stop versioning.
1188
        :raises: NoSuchId if any fileid is not currently versioned.
1189
        """
1190
        if not file_ids:
1191
            return
1192
        state = self.current_dirstate()
1193
        state._read_dirblocks_if_needed()
2858.2.1 by Martin Pool
Remove most calls to safe_file_id and safe_revision_id.
1194
        ids_to_unversion = set(file_ids)
2255.2.22 by Robert Collins
Dirstate: implement WorkingTree4.unversion, letting some test_commit tests pass.
1195
        paths_to_unversion = set()
1196
        # sketch:
1197
        # check if the root is to be unversioned, if so, assert for now.
2255.2.93 by Robert Collins
Dirstate - update WorkingTree4.unversion to the new layout, other tests still borked.
1198
        # walk the state marking unversioned things as absent.
2255.2.22 by Robert Collins
Dirstate: implement WorkingTree4.unversion, letting some test_commit tests pass.
1199
        # if there are any un-unversioned ids at the end, raise
2255.2.96 by Robert Collins
Restore dirstate to all tests passing condition.
1200
        for key, details in state._dirblocks[0][1]:
2255.2.113 by John Arbash Meinel
545ms, 600ms: Switch memory model from storing kind to using minikind
1201
            if (details[0][0] not in ('a', 'r') and # absent or relocated
2255.2.93 by Robert Collins
Dirstate - update WorkingTree4.unversion to the new layout, other tests still borked.
1202
                key[2] in ids_to_unversion):
1203
                # I haven't written the code to unversion / yet - it should be
1204
                # supported.
1205
                raise errors.BzrError('Unversioning the / is not currently supported')
1206
        block_index = 0
1207
        while block_index < len(state._dirblocks):
1208
            # process one directory at a time.
1209
            block = state._dirblocks[block_index]
2255.2.22 by Robert Collins
Dirstate: implement WorkingTree4.unversion, letting some test_commit tests pass.
1210
            # first check: is the path one to remove - it or its children
1211
            delete_block = False
1212
            for path in paths_to_unversion:
1213
                if (block[0].startswith(path) and
1214
                    (len(block[0]) == len(path) or
1215
                     block[0][len(path)] == '/')):
2255.2.93 by Robert Collins
Dirstate - update WorkingTree4.unversion to the new layout, other tests still borked.
1216
                    # this entire block should be deleted - its the block for a
1217
                    # path to unversion; or the child of one
2255.2.22 by Robert Collins
Dirstate: implement WorkingTree4.unversion, letting some test_commit tests pass.
1218
                    delete_block = True
1219
                    break
1220
            # TODO: trim paths_to_unversion as we pass by paths
1221
            if delete_block:
2255.2.93 by Robert Collins
Dirstate - update WorkingTree4.unversion to the new layout, other tests still borked.
1222
                # this block is to be deleted: process it.
1223
                # TODO: we can special case the no-parents case and
1224
                # just forget the whole block.
1225
                entry_index = 0
1226
                while entry_index < len(block[1]):
2255.7.41 by John Arbash Meinel
WorkingTree.unversion() should not raise if unversioning a child and a parent.
1227
                    # Mark this file id as having been removed
2363.2.3 by John Arbash Meinel
Just check if the entry is absent before calling _make_absent.
1228
                    entry = block[1][entry_index]
1229
                    ids_to_unversion.discard(entry[0][2])
2922.2.4 by John Arbash Meinel
Fix bug #114615 by teaching unversion() to not touch renamed entries.
1230
                    if (entry[1][0][0] in 'ar' # don't remove absent or renamed
1231
                                               # entries
2363.2.3 by John Arbash Meinel
Just check if the entry is absent before calling _make_absent.
1232
                        or not state._make_absent(entry)):
2255.2.93 by Robert Collins
Dirstate - update WorkingTree4.unversion to the new layout, other tests still borked.
1233
                        entry_index += 1
1234
                # go to the next block. (At the moment we dont delete empty
1235
                # dirblocks)
1236
                block_index += 1
2255.2.22 by Robert Collins
Dirstate: implement WorkingTree4.unversion, letting some test_commit tests pass.
1237
                continue
2255.2.93 by Robert Collins
Dirstate - update WorkingTree4.unversion to the new layout, other tests still borked.
1238
            entry_index = 0
1239
            while entry_index < len(block[1]):
1240
                entry = block[1][entry_index]
2255.2.113 by John Arbash Meinel
545ms, 600ms: Switch memory model from storing kind to using minikind
1241
                if (entry[1][0][0] in ('a', 'r') or # absent, relocated
2255.2.93 by Robert Collins
Dirstate - update WorkingTree4.unversion to the new layout, other tests still borked.
1242
                    # ^ some parent row.
1243
                    entry[0][2] not in ids_to_unversion):
1244
                    # ^ not an id to unversion
1245
                    entry_index += 1
1246
                    continue
2255.2.113 by John Arbash Meinel
545ms, 600ms: Switch memory model from storing kind to using minikind
1247
                if entry[1][0][0] == 'd':
2255.7.41 by John Arbash Meinel
WorkingTree.unversion() should not raise if unversioning a child and a parent.
1248
                    paths_to_unversion.add(pathjoin(entry[0][0], entry[0][1]))
2255.2.93 by Robert Collins
Dirstate - update WorkingTree4.unversion to the new layout, other tests still borked.
1249
                if not state._make_absent(entry):
1250
                    entry_index += 1
1251
                # we have unversioned this id
1252
                ids_to_unversion.remove(entry[0][2])
1253
            block_index += 1
2255.2.22 by Robert Collins
Dirstate: implement WorkingTree4.unversion, letting some test_commit tests pass.
1254
        if ids_to_unversion:
1255
            raise errors.NoSuchId(self, iter(ids_to_unversion).next())
2255.7.67 by Robert Collins
Fix test_inv - make setting WorkingTree4._dirty use a helper to reduce code duplication, and reset the inventory when we dont manually update it, if it exists.
1256
        self._make_dirty(reset_inventory=False)
2255.2.22 by Robert Collins
Dirstate: implement WorkingTree4.unversion, letting some test_commit tests pass.
1257
        # have to change the legacy inventory too.
1258
        if self._inventory is not None:
1259
            for file_id in file_ids:
2255.2.33 by Robert Collins
Correct thunko in refactoring a few commits back.
1260
                self._inventory.remove_recursive_id(file_id)
2255.2.22 by Robert Collins
Dirstate: implement WorkingTree4.unversion, letting some test_commit tests pass.
1261
3146.8.5 by Aaron Bentley
Get apply_inventory_delta kinda working, but not children
1262
    @needs_tree_write_lock
3146.8.12 by Aaron Bentley
Add a flush to rename_one
1263
    def rename_one(self, from_rel, to_rel, after=False):
1264
        """See WorkingTree.rename_one"""
1265
        self.flush()
1266
        WorkingTree.rename_one(self, from_rel, to_rel, after)
1267
1268
    @needs_tree_write_lock
3146.8.5 by Aaron Bentley
Get apply_inventory_delta kinda working, but not children
1269
    def apply_inventory_delta(self, changes):
1270
        """See MutableTree.apply_inventory_delta"""
3146.8.11 by Aaron Bentley
Fix dirstate/inventory dance, mark dirstate modified and in memory
1271
        state = self.current_dirstate()
3146.8.15 by Aaron Bentley
Cleanup and docs
1272
        state.update_by_delta(changes)
3146.8.11 by Aaron Bentley
Fix dirstate/inventory dance, mark dirstate modified and in memory
1273
        self._make_dirty(reset_inventory=True)
3146.8.5 by Aaron Bentley
Get apply_inventory_delta kinda working, but not children
1274
2929.2.1 by Robert Collins
* Commit updates the state of the working tree via a delta rather than
1275
    def update_basis_by_delta(self, new_revid, delta):
1276
        """See MutableTree.update_basis_by_delta."""
3376.2.4 by Martin Pool
Remove every assert statement from bzrlib!
1277
        if self.last_revision() == new_revid:
1278
            raise AssertionError()
2929.2.1 by Robert Collins
* Commit updates the state of the working tree via a delta rather than
1279
        self.current_dirstate().update_basis_by_delta(delta, new_revid)
1280
2371.2.1 by John Arbash Meinel
Update DirState._validate() to detect rename errors.
1281
    @needs_read_lock
1282
    def _validate(self):
1283
        self._dirstate._validate()
1284
2255.2.16 by Robert Collins
Implement WorkingTreeFormat4._write_inventory for better compatability with existing code, letting more test_test_trees pass, now up to test_tree_with_subdirs_and_all_content_types.
1285
    @needs_tree_write_lock
1286
    def _write_inventory(self, inv):
1287
        """Write inventory as the current inventory."""
3376.2.4 by Martin Pool
Remove every assert statement from bzrlib!
1288
        if self._dirty:
1289
            raise AssertionError("attempting to write an inventory when the "
1290
                "dirstate is dirty will lose pending changes")
2255.2.16 by Robert Collins
Implement WorkingTreeFormat4._write_inventory for better compatability with existing code, letting more test_test_trees pass, now up to test_tree_with_subdirs_and_all_content_types.
1291
        self.current_dirstate().set_state_from_inventory(inv)
2255.7.67 by Robert Collins
Fix test_inv - make setting WorkingTree4._dirty use a helper to reduce code duplication, and reset the inventory when we dont manually update it, if it exists.
1292
        self._make_dirty(reset_inventory=False)
1293
        if self._inventory is not None:
1294
            self._inventory = inv
2255.2.16 by Robert Collins
Implement WorkingTreeFormat4._write_inventory for better compatability with existing code, letting more test_test_trees pass, now up to test_tree_with_subdirs_and_all_content_types.
1295
        self.flush()
1296
2255.2.3 by Robert Collins
Split out working tree format 4 to its own file, create stub dirstate revision object, start working on dirstate.set_parent_trees - a key failure point.
1297
3368.2.53 by Ian Clatworthy
sha1 calculation done by workingtree layer now
1298
class ContentFilterAwareSHA1Provider(dirstate.SHA1Provider):
1299
1300
    def __init__(self, tree):
1301
        self.tree = tree
1302
1303
    def sha1(self, abspath):
4241.14.2 by Vincent Ladeuil
Fixed as per John's review feedback.
1304
        """See dirstate.SHA1Provider.sha1()."""
4241.14.1 by Vincent Ladeuil
Fix bug #355454 by casting to unicode.
1305
        filters = self.tree._content_filter_stack(
1306
            self.tree.relpath(osutils.safe_unicode(abspath)))
3368.2.53 by Ian Clatworthy
sha1 calculation done by workingtree layer now
1307
        return internal_size_sha_file_byname(abspath, filters)[1]
1308
1309
    def stat_and_sha1(self, abspath):
4241.14.2 by Vincent Ladeuil
Fixed as per John's review feedback.
1310
        """See dirstate.SHA1Provider.stat_and_sha1()."""
4241.14.1 by Vincent Ladeuil
Fix bug #355454 by casting to unicode.
1311
        filters = self.tree._content_filter_stack(
1312
            self.tree.relpath(osutils.safe_unicode(abspath)))
3368.2.53 by Ian Clatworthy
sha1 calculation done by workingtree layer now
1313
        file_obj = file(abspath, 'rb', 65000)
1314
        try:
1315
            statvalue = os.fstat(file_obj.fileno())
1316
            if filters:
1317
                file_obj = filtered_input_file(file_obj, filters)
1318
            sha1 = osutils.size_sha_file(file_obj)[1]
1319
        finally:
1320
            file_obj.close()
1321
        return statvalue, sha1
1322
1323
3907.2.3 by Ian Clatworthy
DirStateWorkingTree and DirStateWorkingTreeFormat base classes introduced
1324
class WorkingTree4(DirStateWorkingTree):
1325
    """This is the Format 4 working tree.
1326
1327
    This differs from WorkingTree3 by:
1328
     - Having a consolidated internal dirstate, stored in a
1329
       randomly-accessible sorted file on disk.
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
1330
     - Not having a regular inventory attribute.  One can be synthesized
3907.2.3 by Ian Clatworthy
DirStateWorkingTree and DirStateWorkingTreeFormat base classes introduced
1331
       on demand but this is expensive and should be avoided.
1332
1333
    This is new in bzr 0.15.
1334
    """
1335
1336
1337
class WorkingTree5(DirStateWorkingTree):
1338
    """This is the Format 5 working tree.
1339
1340
    This differs from WorkingTree4 by:
1341
     - Supporting content filtering.
4210.4.2 by Ian Clatworthy
split filtered views support out into WorkingTreeFormat6
1342
1343
    This is new in bzr 1.11.
1344
    """
1345
1346
1347
class WorkingTree6(DirStateWorkingTree):
1348
    """This is the Format 6 working tree.
1349
1350
    This differs from WorkingTree5 by:
3907.2.3 by Ian Clatworthy
DirStateWorkingTree and DirStateWorkingTreeFormat base classes introduced
1351
     - Supporting a current view that may mask the set of files in a tree
1352
       impacted by most user operations.
1353
4210.4.2 by Ian Clatworthy
split filtered views support out into WorkingTreeFormat6
1354
    This is new in bzr 1.14.
3907.2.3 by Ian Clatworthy
DirStateWorkingTree and DirStateWorkingTreeFormat base classes introduced
1355
    """
1356
3586.2.13 by Ian Clatworthy
fix wt5 to use views, correcting an earlier merge
1357
    def _make_views(self):
1358
        return views.PathBasedViews(self)
1359
3907.2.3 by Ian Clatworthy
DirStateWorkingTree and DirStateWorkingTreeFormat base classes introduced
1360
1361
class DirStateWorkingTreeFormat(WorkingTreeFormat3):
3123.5.2 by Aaron Bentley
Allow checkout --files_from
1362
    def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
3136.1.3 by Aaron Bentley
Implement hard-link support for branch and checkout
1363
                   accelerator_tree=None, hardlink=False):
2255.2.3 by Robert Collins
Split out working tree format 4 to its own file, create stub dirstate revision object, start working on dirstate.set_parent_trees - a key failure point.
1364
        """See WorkingTreeFormat.initialize().
2255.2.84 by John Arbash Meinel
Remove now-unecessary encode/decode calls for revision ids.
1365
2255.2.166 by Martin Pool
(broken) Add Tree.get_root_id() & test
1366
        :param revision_id: allows creating a working tree at a different
2255.2.3 by Robert Collins
Split out working tree format 4 to its own file, create stub dirstate revision object, start working on dirstate.set_parent_trees - a key failure point.
1367
        revision than the branch is at.
3123.5.17 by Aaron Bentley
Update docs
1368
        :param accelerator_tree: A tree which can be used for retrieving file
1369
            contents more quickly than the revision tree, i.e. a workingtree.
1370
            The revision tree will be used for cases where accelerator_tree's
1371
            content is different.
3136.1.3 by Aaron Bentley
Implement hard-link support for branch and checkout
1372
        :param hardlink: If true, hard-link files from accelerator_tree,
1373
            where possible.
2255.2.166 by Martin Pool
(broken) Add Tree.get_root_id() & test
1374
1551.15.6 by Aaron Bentley
Use ROOT_ID when the repository supports old clients (Bug #107168)
1375
        These trees get an initial random root id, if their repository supports
1376
        rich root data, TREE_ROOT otherwise.
2255.2.3 by Robert Collins
Split out working tree format 4 to its own file, create stub dirstate revision object, start working on dirstate.set_parent_trees - a key failure point.
1377
        """
1378
        if not isinstance(a_bzrdir.transport, LocalTransport):
1379
            raise errors.NotLocalUrl(a_bzrdir.transport.base)
1380
        transport = a_bzrdir.get_workingtree_transport(self)
1381
        control_files = self._open_control_files(a_bzrdir)
1382
        control_files.create_lock()
1383
        control_files.lock_write()
3407.2.5 by Martin Pool
Deprecate LockableFiles.put_utf8
1384
        transport.put_bytes('format', self.get_format_string(),
3407.2.18 by Martin Pool
BzrDir takes responsibility for default file/dir modes
1385
            mode=a_bzrdir._get_file_mode())
2955.5.3 by Vincent Ladeuil
Fix second unwanted connection by providing the right branch to create_checkout.
1386
        if from_branch is not None:
1387
            branch = from_branch
1388
        else:
1389
            branch = a_bzrdir.open_branch()
2255.2.3 by Robert Collins
Split out working tree format 4 to its own file, create stub dirstate revision object, start working on dirstate.set_parent_trees - a key failure point.
1390
        if revision_id is None:
1391
            revision_id = branch.last_revision()
1392
        local_path = transport.local_abspath('dirstate')
2255.2.166 by Martin Pool
(broken) Add Tree.get_root_id() & test
1393
        # write out new dirstate (must exist when we create the tree)
2255.5.2 by John Arbash Meinel
(broken) lock and unlock the DirState object when locking and unlocking the Tree itself
1394
        state = dirstate.DirState.initialize(local_path)
1395
        state.unlock()
2371.2.1 by John Arbash Meinel
Update DirState._validate() to detect rename errors.
1396
        del state
3588.2.1 by Ian Clatworthy
make it easier to subclass WorkingTreeFormat4
1397
        wt = self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
2255.2.3 by Robert Collins
Split out working tree format 4 to its own file, create stub dirstate revision object, start working on dirstate.set_parent_trees - a key failure point.
1398
                         branch,
1399
                         _format=self,
1400
                         _bzrdir=a_bzrdir,
1401
                         _control_files=control_files)
1402
        wt._new_tree()
2255.7.42 by Robert Collins
WorkingTree4 only needs a tree write lock during initialize, not a deep write lock.
1403
        wt.lock_tree_write()
2255.2.3 by Robert Collins
Split out working tree format 4 to its own file, create stub dirstate revision object, start working on dirstate.set_parent_trees - a key failure point.
1404
        try:
3588.2.1 by Ian Clatworthy
make it easier to subclass WorkingTreeFormat4
1405
            self._init_custom_control_files(wt)
2255.2.167 by Martin Pool
Change WorkingTree4.initialize to only get a random root id if not based on a revisiontree
1406
            if revision_id in (None, NULL_REVISION):
1551.15.6 by Aaron Bentley
Use ROOT_ID when the repository supports old clients (Bug #107168)
1407
                if branch.repository.supports_rich_root():
1408
                    wt._set_root_id(generate_ids.gen_root_id())
1409
                else:
1410
                    wt._set_root_id(ROOT_ID)
2255.2.166 by Martin Pool
(broken) Add Tree.get_root_id() & test
1411
                wt.flush()
3123.5.14 by Aaron Bentley
Avoid Repository.revision_tree in common-case branching
1412
            basis = None
1413
            # frequently, we will get here due to branching.  The accelerator
1414
            # tree will be the tree from the branch, so the desired basis
1415
            # tree will often be a parent of the accelerator tree.
1416
            if accelerator_tree is not None:
1417
                try:
1418
                    basis = accelerator_tree.revision_tree(revision_id)
1419
                except errors.NoSuchRevision:
1420
                    pass
1421
            if basis is None:
1422
                basis = branch.repository.revision_tree(revision_id)
1423
            if revision_id == NULL_REVISION:
1424
                parents_list = []
1425
            else:
1426
                parents_list = [(revision_id, basis)]
1427
            basis.lock_read()
3136.1.10 by Aaron Bentley
Clean error if filesystem does not support hard-links
1428
            try:
1429
                wt.set_parent_trees(parents_list, allow_leftmost_as_ghost=True)
2255.2.177 by Martin Pool
merge dirstate sorting fix, add more validation tests
1430
                wt.flush()
3136.1.10 by Aaron Bentley
Clean error if filesystem does not support hard-links
1431
                # if the basis has a root id we have to use that; otherwise we
1432
                # use a new random one
1433
                basis_root_id = basis.get_root_id()
1434
                if basis_root_id is not None:
1435
                    wt._set_root_id(basis_root_id)
1436
                    wt.flush()
4377.1.1 by Ian Clatworthy
speed up branch-in-a-shared-repo for development6-rich-root format
1437
                # If content filtering is supported, do not use the accelerator
1438
                # tree - the cost of transforming the content both ways and
1439
                # checking for changed content can outweight the gains it gives.
1440
                # Note: do NOT move this logic up higher - using the basis from
1441
                # the accelerator tree is still desirable because that can save
1442
                # a minute or more of processing on large trees!
1443
                if wt.supports_content_filtering():
1444
                    accelerator_tree = None
3453.2.6 by Aaron Bentley
Rename mutate_tree to delta_from_tree, add comment
1445
                # delta_from_tree is safe even for DirStateRevisionTrees,
1446
                # because wt4.apply_inventory_delta does not mutate the input
1447
                # inventory entries.
3136.1.10 by Aaron Bentley
Clean error if filesystem does not support hard-links
1448
                transform.build_tree(basis, wt, accelerator_tree,
3453.2.6 by Aaron Bentley
Rename mutate_tree to delta_from_tree, add comment
1449
                                     hardlink=hardlink, delta_from_tree=True)
3136.1.10 by Aaron Bentley
Clean error if filesystem does not support hard-links
1450
            finally:
1451
                basis.unlock()
2255.2.3 by Robert Collins
Split out working tree format 4 to its own file, create stub dirstate revision object, start working on dirstate.set_parent_trees - a key failure point.
1452
        finally:
1453
            control_files.unlock()
1454
            wt.unlock()
1455
        return wt
1456
3588.2.1 by Ian Clatworthy
make it easier to subclass WorkingTreeFormat4
1457
    def _init_custom_control_files(self, wt):
1458
        """Subclasses with custom control files should override this method.
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
1459
3588.2.1 by Ian Clatworthy
make it easier to subclass WorkingTreeFormat4
1460
        The working tree and control files are locked for writing when this
1461
        method is called.
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
1462
3588.2.1 by Ian Clatworthy
make it easier to subclass WorkingTreeFormat4
1463
        :param wt: the WorkingTree object
1464
        """
1465
2255.2.3 by Robert Collins
Split out working tree format 4 to its own file, create stub dirstate revision object, start working on dirstate.set_parent_trees - a key failure point.
1466
    def _open(self, a_bzrdir, control_files):
1467
        """Open the tree itself.
2255.2.84 by John Arbash Meinel
Remove now-unecessary encode/decode calls for revision ids.
1468
2255.2.3 by Robert Collins
Split out working tree format 4 to its own file, create stub dirstate revision object, start working on dirstate.set_parent_trees - a key failure point.
1469
        :param a_bzrdir: the dir for the tree.
1470
        :param control_files: the control files for the tree.
1471
        """
3588.2.1 by Ian Clatworthy
make it easier to subclass WorkingTreeFormat4
1472
        return self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
2255.2.3 by Robert Collins
Split out working tree format 4 to its own file, create stub dirstate revision object, start working on dirstate.set_parent_trees - a key failure point.
1473
                           branch=a_bzrdir.open_branch(),
1474
                           _format=self,
1475
                           _bzrdir=a_bzrdir,
1476
                           _control_files=control_files)
1477
2255.2.158 by Martin Pool
Most of the integration of dirstate and subtree
1478
    def __get_matchingbzrdir(self):
4241.1.1 by Ian Clatworthy
tree code cleanups from brisbane-core
1479
        return self._get_matchingbzrdir()
1480
1481
    def _get_matchingbzrdir(self):
1482
        """Overrideable method to get a bzrdir for testing."""
2255.2.158 by Martin Pool
Most of the integration of dirstate and subtree
1483
        # please test against something that will let us do tree references
1484
        return bzrdir.format_registry.make_bzrdir(
2255.2.194 by Robert Collins
[BROKEN] Many updates to stop using experimental formats in tests.
1485
            'dirstate-with-subtree')
2255.2.158 by Martin Pool
Most of the integration of dirstate and subtree
1486
1487
    _matchingbzrdir = property(__get_matchingbzrdir)
1488
2255.2.3 by Robert Collins
Split out working tree format 4 to its own file, create stub dirstate revision object, start working on dirstate.set_parent_trees - a key failure point.
1489
3907.2.3 by Ian Clatworthy
DirStateWorkingTree and DirStateWorkingTreeFormat base classes introduced
1490
class WorkingTreeFormat4(DirStateWorkingTreeFormat):
1491
    """The first consolidated dirstate working tree format.
1492
1493
    This format:
1494
        - exists within a metadir controlling .bzr
1495
        - includes an explicit version marker for the workingtree control
1496
          files, separate from the BzrDir format
1497
        - modifies the hash cache format
1498
        - is new in bzr 0.15
1499
        - uses a LockDir to guard access to it.
1500
    """
1501
1502
    upgrade_recommended = False
1503
1504
    _tree_class = WorkingTree4
1505
1506
    def get_format_string(self):
1507
        """See WorkingTreeFormat.get_format_string()."""
1508
        return "Bazaar Working Tree Format 4 (bzr 0.15)\n"
1509
1510
    def get_format_description(self):
1511
        """See WorkingTreeFormat.get_format_description()."""
1512
        return "Working tree format 4"
1513
1514
1515
class WorkingTreeFormat5(DirStateWorkingTreeFormat):
4210.4.2 by Ian Clatworthy
split filtered views support out into WorkingTreeFormat6
1516
    """WorkingTree format supporting content filtering.
3907.2.3 by Ian Clatworthy
DirStateWorkingTree and DirStateWorkingTreeFormat base classes introduced
1517
    """
1518
1519
    upgrade_recommended = False
1520
1521
    _tree_class = WorkingTree5
1522
1523
    def get_format_string(self):
1524
        """See WorkingTreeFormat.get_format_string()."""
1525
        return "Bazaar Working Tree Format 5 (bzr 1.11)\n"
1526
1527
    def get_format_description(self):
1528
        """See WorkingTreeFormat.get_format_description()."""
1529
        return "Working tree format 5"
1530
4210.4.2 by Ian Clatworthy
split filtered views support out into WorkingTreeFormat6
1531
    def supports_content_filtering(self):
1532
        return True
1533
1534
1535
class WorkingTreeFormat6(DirStateWorkingTreeFormat):
1536
    """WorkingTree format supporting views.
1537
    """
1538
1539
    upgrade_recommended = False
1540
1541
    _tree_class = WorkingTree6
1542
1543
    def get_format_string(self):
1544
        """See WorkingTreeFormat.get_format_string()."""
1545
        return "Bazaar Working Tree Format 6 (bzr 1.14)\n"
1546
1547
    def get_format_description(self):
1548
        """See WorkingTreeFormat.get_format_description()."""
1549
        return "Working tree format 6"
1550
3907.2.3 by Ian Clatworthy
DirStateWorkingTree and DirStateWorkingTreeFormat base classes introduced
1551
    def _init_custom_control_files(self, wt):
1552
        """Subclasses with custom control files should override this method."""
1553
        wt._transport.put_bytes('views', '', mode=wt.bzrdir._get_file_mode())
1554
1555
    def supports_content_filtering(self):
1556
        return True
1557
1558
    def supports_views(self):
1559
        return True
1560
1561
2255.2.3 by Robert Collins
Split out working tree format 4 to its own file, create stub dirstate revision object, start working on dirstate.set_parent_trees - a key failure point.
1562
class DirStateRevisionTree(Tree):
1563
    """A revision tree pulling the inventory from a dirstate."""
1564
1565
    def __init__(self, dirstate, revision_id, repository):
1566
        self._dirstate = dirstate
2858.2.1 by Martin Pool
Remove most calls to safe_file_id and safe_revision_id.
1567
        self._revision_id = revision_id
2255.2.3 by Robert Collins
Split out working tree format 4 to its own file, create stub dirstate revision object, start working on dirstate.set_parent_trees - a key failure point.
1568
        self._repository = repository
1569
        self._inventory = None
2255.2.38 by Robert Collins
Fix WorkingTree4.pull to work.
1570
        self._locked = 0
2255.5.2 by John Arbash Meinel
(broken) lock and unlock the DirState object when locking and unlocking the Tree itself
1571
        self._dirstate_locked = False
3504.2.1 by John Arbash Meinel
Shortcut iter_references when we know references aren't supported.
1572
        self._repo_supports_tree_reference = getattr(
1573
            repository._format, "supports_tree_reference",
1574
            False)
2255.2.3 by Robert Collins
Split out working tree format 4 to its own file, create stub dirstate revision object, start working on dirstate.set_parent_trees - a key failure point.
1575
2255.2.184 by Martin Pool
Fixes for some comparison tests; repr of DirStateRevisionTree
1576
    def __repr__(self):
1577
        return "<%s of %s in %s>" % \
1578
            (self.__class__.__name__, self._revision_id, self._dirstate)
1579
1551.15.46 by Aaron Bentley
Move plan merge to tree
1580
    def annotate_iter(self, file_id,
1581
                      default_revision=_mod_revision.CURRENT_REVISION):
2255.2.69 by John Arbash Meinel
Implement annotate_iter, get_revision_id, and walkdirs so that all tree_implementations now pass
1582
        """See Tree.annotate_iter"""
3350.6.4 by Robert Collins
First cut at pluralised VersionedFiles. Some rather massive API incompatabilities, primarily because of the difficulty of coherence among competing stores.
1583
        text_key = (file_id, self.inventory[file_id].revision)
1584
        annotations = self._repository.texts.annotate(text_key)
3350.6.10 by Martin Pool
VersionedFiles review cleanups
1585
        return [(key[-1], line) for (key, line) in annotations]
2255.2.69 by John Arbash Meinel
Implement annotate_iter, get_revision_id, and walkdirs so that all tree_implementations now pass
1586
1551.15.46 by Aaron Bentley
Move plan merge to tree
1587
    def _get_ancestors(self, default_revision):
1588
        return set(self._repository.get_ancestry(self._revision_id,
1589
                                                 topo_sorted=False))
2255.2.3 by Robert Collins
Split out working tree format 4 to its own file, create stub dirstate revision object, start working on dirstate.set_parent_trees - a key failure point.
1590
    def _comparison_data(self, entry, path):
2255.2.182 by Martin Pool
merge dirstate and trunk
1591
        """See Tree._comparison_data."""
2255.2.3 by Robert Collins
Split out working tree format 4 to its own file, create stub dirstate revision object, start working on dirstate.set_parent_trees - a key failure point.
1592
        if entry is None:
1593
            return None, False, None
1594
        # trust the entry as RevisionTree does, but this may not be
1595
        # sensible: the entry might not have come from us?
1596
        return entry.kind, entry.executable, None
1597
2255.2.10 by Robert Collins
Now all tests matching dirstate pass - added generation of inventories for parent trees.
1598
    def _file_size(self, entry, stat_value):
1599
        return entry.text_size
1600
2255.2.78 by Robert Collins
Really finish the prior commit.
1601
    def filter_unversioned_files(self, paths):
1602
        """Filter out paths that are not versioned.
1603
1604
        :return: set of paths.
1605
        """
1606
        pred = self.has_filename
1607
        return set((p for p in paths if not pred(p)))
1608
2255.2.166 by Martin Pool
(broken) Add Tree.get_root_id() & test
1609
    def get_root_id(self):
1610
        return self.path2id('')
1611
3016.1.1 by Aaron Bentley
Update DirStateRevisionTree to avoid using inventory
1612
    def id2path(self, file_id):
1613
        "Convert a file-id to a path."
1614
        entry = self._get_entry(file_id=file_id)
1615
        if entry == (None, None):
1616
            raise errors.NoSuchId(tree=self, file_id=file_id)
1617
        path_utf8 = osutils.pathjoin(entry[0][0], entry[0][1])
1618
        return path_utf8.decode('utf8')
1619
3504.2.1 by John Arbash Meinel
Shortcut iter_references when we know references aren't supported.
1620
    def iter_references(self):
1621
        if not self._repo_supports_tree_reference:
1622
            # When the repo doesn't support references, we will have nothing to
1623
            # return
1624
            return iter([])
1625
        # Otherwise, fall back to the default implementation
1626
        return super(DirStateRevisionTree, self).iter_references()
1627
2255.2.134 by John Arbash Meinel
Add a tree-test for get_symlink_target
1628
    def _get_parent_index(self):
1629
        """Return the index in the dirstate referenced by this tree."""
1630
        return self._dirstate.get_parent_ids().index(self._revision_id) + 1
1631
2255.2.98 by Robert Collins
Perform path2id lookups in dirstate revision trees from the dirstate index without requiring an inventory.
1632
    def _get_entry(self, file_id=None, path=None):
1633
        """Get the dirstate row for file_id or path.
1634
1635
        If either file_id or path is supplied, it is used as the key to lookup.
1636
        If both are supplied, the fastest lookup is used, and an error is
1637
        raised if they do not both point at the same row.
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
1638
2255.2.98 by Robert Collins
Perform path2id lookups in dirstate revision trees from the dirstate index without requiring an inventory.
1639
        :param file_id: An optional unicode file_id to be looked up.
1640
        :param path: An optional unicode path to be looked up.
1641
        :return: The dirstate row tuple for path/file_id, or (None, None)
1642
        """
1643
        if file_id is None and path is None:
1644
            raise errors.BzrError('must supply file_id or path')
1645
        if path is not None:
1646
            path = path.encode('utf8')
4377.3.4 by Ian Clatworthy
back out tree-level cache of dirstate entries as agreed during review
1647
        parent_index = self._get_parent_index()
1648
        return self._dirstate._get_entry(parent_index, fileid_utf8=file_id, path_utf8=path)
2255.2.98 by Robert Collins
Perform path2id lookups in dirstate revision trees from the dirstate index without requiring an inventory.
1649
2255.2.3 by Robert Collins
Split out working tree format 4 to its own file, create stub dirstate revision object, start working on dirstate.set_parent_trees - a key failure point.
1650
    def _generate_inventory(self):
1651
        """Create and set self.inventory from the dirstate object.
2255.2.84 by John Arbash Meinel
Remove now-unecessary encode/decode calls for revision ids.
1652
2255.2.158 by Martin Pool
Most of the integration of dirstate and subtree
1653
        (So this is only called the first time the inventory is requested for
2255.2.182 by Martin Pool
merge dirstate and trunk
1654
        this tree; it then remains in memory until it's out of date.)
2255.2.158 by Martin Pool
Most of the integration of dirstate and subtree
1655
2255.2.3 by Robert Collins
Split out working tree format 4 to its own file, create stub dirstate revision object, start working on dirstate.set_parent_trees - a key failure point.
1656
        This is relatively expensive: we have to walk the entire dirstate.
2255.2.158 by Martin Pool
Most of the integration of dirstate and subtree
1657
        """
3376.2.4 by Martin Pool
Remove every assert statement from bzrlib!
1658
        if not self._locked:
1659
            raise AssertionError(
1660
                'cannot generate inventory of an unlocked '
1661
                'dirstate revision tree')
2255.2.87 by Robert Collins
core dirstate tests passing with new structure.
1662
        # separate call for profiling - makes it clear where the costs are.
1663
        self._dirstate._read_dirblocks_if_needed()
3376.2.4 by Martin Pool
Remove every assert statement from bzrlib!
1664
        if self._revision_id not in self._dirstate.get_parent_ids():
1665
            raise AssertionError(
1666
                'parent %s has disappeared from %s' % (
1667
                self._revision_id, self._dirstate.get_parent_ids()))
2255.2.87 by Robert Collins
core dirstate tests passing with new structure.
1668
        parent_index = self._dirstate.get_parent_ids().index(self._revision_id) + 1
1669
        # This is identical now to the WorkingTree _generate_inventory except
1670
        # for the tree index use.
1671
        root_key, current_entry = self._dirstate._get_entry(parent_index, path_utf8='')
2255.2.107 by John Arbash Meinel
(working), fix dirstate to use utf8 file ids.
1672
        current_id = root_key[2]
3376.2.4 by Martin Pool
Remove every assert statement from bzrlib!
1673
        if current_entry[parent_index][0] != 'd':
1674
            raise AssertionError()
2255.2.87 by Robert Collins
core dirstate tests passing with new structure.
1675
        inv = Inventory(root_id=current_id, revision_id=self._revision_id)
1676
        inv.root.revision = current_entry[parent_index][4]
2255.2.114 by John Arbash Meinel
_get_inventory: 2.09 => 1.93s by tweaking some of the inner _generate_inventory loops
1677
        # Turn some things into local variables
1678
        minikind_to_kind = dirstate.DirState._minikind_to_kind
1679
        factory = entry_factory
1680
        utf8_decode = cache_utf8._utf8_decode
2255.2.115 by John Arbash Meinel
_get_inventory 1.75s: Directly update the inventory state rather than using inv.add()
1681
        inv_byid = inv._byid
2255.2.73 by Robert Collins
50% speedup in the dirstate->inventory conversion logic by caching the parent ids as we walk the tree. Some further work would be to maintain a stack of parents as we know we visit depth first.
1682
        # we could do this straight out of the dirstate; it might be fast
1683
        # and should be profiled - RBC 20070216
2255.2.115 by John Arbash Meinel
_get_inventory 1.75s: Directly update the inventory state rather than using inv.add()
1684
        parent_ies = {'' : inv.root}
2255.2.96 by Robert Collins
Restore dirstate to all tests passing condition.
1685
        for block in self._dirstate._dirblocks[1:]: #skip root
2255.2.87 by Robert Collins
core dirstate tests passing with new structure.
1686
            dirname = block[0]
2255.2.96 by Robert Collins
Restore dirstate to all tests passing condition.
1687
            try:
2255.2.115 by John Arbash Meinel
_get_inventory 1.75s: Directly update the inventory state rather than using inv.add()
1688
                parent_ie = parent_ies[dirname]
2255.2.96 by Robert Collins
Restore dirstate to all tests passing condition.
1689
            except KeyError:
1690
                # all the paths in this block are not versioned in this tree
1691
                continue
2255.2.87 by Robert Collins
core dirstate tests passing with new structure.
1692
            for key, entry in block[1]:
2255.2.158 by Martin Pool
Most of the integration of dirstate and subtree
1693
                minikind, fingerprint, size, executable, revid = entry[parent_index]
2255.2.114 by John Arbash Meinel
_get_inventory: 2.09 => 1.93s by tweaking some of the inner _generate_inventory loops
1694
                if minikind in ('a', 'r'): # absent, relocated
2255.2.87 by Robert Collins
core dirstate tests passing with new structure.
1695
                    # not this tree
1696
                    continue
2255.2.107 by John Arbash Meinel
(working), fix dirstate to use utf8 file ids.
1697
                name = key[1]
2255.2.114 by John Arbash Meinel
_get_inventory: 2.09 => 1.93s by tweaking some of the inner _generate_inventory loops
1698
                name_unicode = utf8_decode(name)[0]
2255.2.107 by John Arbash Meinel
(working), fix dirstate to use utf8 file ids.
1699
                file_id = key[2]
2255.2.114 by John Arbash Meinel
_get_inventory: 2.09 => 1.93s by tweaking some of the inner _generate_inventory loops
1700
                kind = minikind_to_kind[minikind]
2255.2.115 by John Arbash Meinel
_get_inventory 1.75s: Directly update the inventory state rather than using inv.add()
1701
                inv_entry = factory[kind](file_id, name_unicode,
1702
                                          parent_ie.file_id)
2255.2.87 by Robert Collins
core dirstate tests passing with new structure.
1703
                inv_entry.revision = revid
1704
                if kind == 'file':
1705
                    inv_entry.executable = executable
1706
                    inv_entry.text_size = size
2255.2.158 by Martin Pool
Most of the integration of dirstate and subtree
1707
                    inv_entry.text_sha1 = fingerprint
2255.2.87 by Robert Collins
core dirstate tests passing with new structure.
1708
                elif kind == 'directory':
2255.2.115 by John Arbash Meinel
_get_inventory 1.75s: Directly update the inventory state rather than using inv.add()
1709
                    parent_ies[(dirname + '/' + name).strip('/')] = inv_entry
2255.2.93 by Robert Collins
Dirstate - update WorkingTree4.unversion to the new layout, other tests still borked.
1710
                elif kind == 'symlink':
1711
                    inv_entry.executable = False
2338.4.1 by Marien Zwart
Fix committing merges in a dirstate tree with a symlink.
1712
                    inv_entry.text_size = None
2255.2.158 by Martin Pool
Most of the integration of dirstate and subtree
1713
                    inv_entry.symlink_target = utf8_decode(fingerprint)[0]
1714
                elif kind == 'tree-reference':
2255.2.218 by Robert Collins
Make the nested tree commit smoke test be more rigourous.
1715
                    inv_entry.reference_revision = fingerprint or None
2255.2.87 by Robert Collins
core dirstate tests passing with new structure.
1716
                else:
2255.2.158 by Martin Pool
Most of the integration of dirstate and subtree
1717
                    raise AssertionError("cannot convert entry %r into an InventoryEntry"
1718
                            % entry)
2255.2.115 by John Arbash Meinel
_get_inventory 1.75s: Directly update the inventory state rather than using inv.add()
1719
                # These checks cost us around 40ms on a 55k entry tree
3376.2.4 by Martin Pool
Remove every assert statement from bzrlib!
1720
                if file_id in inv_byid:
1721
                    raise AssertionError('file_id %s already in'
1722
                        ' inventory as %s' % (file_id, inv_byid[file_id]))
1723
                if name_unicode in parent_ie.children:
1724
                    raise AssertionError('name %r already in parent'
1725
                        % (name_unicode,))
2255.2.115 by John Arbash Meinel
_get_inventory 1.75s: Directly update the inventory state rather than using inv.add()
1726
                inv_byid[file_id] = inv_entry
1727
                parent_ie.children[name_unicode] = inv_entry
2255.2.3 by Robert Collins
Split out working tree format 4 to its own file, create stub dirstate revision object, start working on dirstate.set_parent_trees - a key failure point.
1728
        self._inventory = inv
1729
2255.7.36 by John Arbash Meinel
All trees should implement get_file_mtime()
1730
    def get_file_mtime(self, file_id, path=None):
1731
        """Return the modification time for this record.
1732
1733
        We return the timestamp of the last-changed revision.
1734
        """
1735
        # Make sure the file exists
1736
        entry = self._get_entry(file_id, path=path)
1737
        if entry == (None, None): # do we raise?
1738
            return None
1739
        parent_index = self._get_parent_index()
1740
        last_changed_revision = entry[1][parent_index][4]
1741
        return self._repository.get_revision(last_changed_revision).timestamp
1742
2255.2.31 by Robert Collins
Work in progress to make merge_inner work with dirstate trees.
1743
    def get_file_sha1(self, file_id, path=None, stat_value=None):
2255.10.1 by John Arbash Meinel
Update WorkingTree4 so that it doesn't use a HashCache,
1744
        entry = self._get_entry(file_id=file_id, path=path)
1745
        parent_index = self._get_parent_index()
1746
        parent_details = entry[1][parent_index]
1747
        if parent_details[0] == 'f':
1748
            return parent_details[1]
2255.2.31 by Robert Collins
Work in progress to make merge_inner work with dirstate trees.
1749
        return None
1750
2743.3.3 by Ian Clatworthy
Skip path lookup for tree.get_file() when we already know the path
1751
    def get_file(self, file_id, path=None):
2255.2.31 by Robert Collins
Work in progress to make merge_inner work with dirstate trees.
1752
        return StringIO(self.get_file_text(file_id))
1753
1754
    def get_file_size(self, file_id):
3363.3.4 by Aaron Bentley
Add get_file_size to Tree interface
1755
        """See Tree.get_file_size"""
2255.2.31 by Robert Collins
Work in progress to make merge_inner work with dirstate trees.
1756
        return self.inventory[file_id].text_size
1757
3774.1.1 by Aaron Bentley
Test Tree.get_file_text() and supply default implementation.
1758
    def get_file_text(self, file_id, path=None):
4202.1.1 by John Arbash Meinel
Update Repository.iter_files_bytes() to return an iterable of bytestrings.
1759
        _, content = list(self.iter_files_bytes([(file_id, None)]))[0]
1760
        return ''.join(content)
2255.2.31 by Robert Collins
Work in progress to make merge_inner work with dirstate trees.
1761
2255.2.226 by Robert Collins
Get merge_nested finally working: change nested tree iterators to take file_ids, and ensure the right branch is connected to in the merge logic. May not be suitable for shared repositories yet.
1762
    def get_reference_revision(self, file_id, path=None):
1763
        return self.inventory[file_id].reference_revision
2255.2.218 by Robert Collins
Make the nested tree commit smoke test be more rigourous.
1764
2708.1.7 by Aaron Bentley
Rename extract_files_bytes to iter_files_bytes
1765
    def iter_files_bytes(self, desired_files):
1766
        """See Tree.iter_files_bytes.
2708.1.4 by Aaron Bentley
RevisionTree and DirStateRevisionTree use Repository.extract_files_bytes
1767
2708.1.7 by Aaron Bentley
Rename extract_files_bytes to iter_files_bytes
1768
        This version is implemented on top of Repository.iter_files_bytes"""
2708.1.6 by Aaron Bentley
Turn extract_files_bytes into an iterator
1769
        parent_index = self._get_parent_index()
2708.1.11 by Aaron Bentley
Test and tweak error handling
1770
        repo_desired_files = []
1771
        for file_id, identifier in desired_files:
1772
            entry = self._get_entry(file_id)
1773
            if entry == (None, None):
1774
                raise errors.NoSuchId(self, file_id)
1775
            repo_desired_files.append((file_id, entry[1][parent_index][4],
1776
                                       identifier))
2708.1.7 by Aaron Bentley
Rename extract_files_bytes to iter_files_bytes
1777
        return self._repository.iter_files_bytes(repo_desired_files)
2708.1.4 by Aaron Bentley
RevisionTree and DirStateRevisionTree use Repository.extract_files_bytes
1778
2255.2.134 by John Arbash Meinel
Add a tree-test for get_symlink_target
1779
    def get_symlink_target(self, file_id):
1780
        entry = self._get_entry(file_id=file_id)
1781
        parent_index = self._get_parent_index()
1782
        if entry[1][parent_index][0] != 'l':
1783
            return None
1784
        else:
4216.3.1 by Robert Collins
Fix Tree.get_symlink_target to decode from the disk encoding to get a unicode encoded string.
1785
            target = entry[1][parent_index][1]
1786
            target = target.decode('utf8')
1787
            return target
2255.2.134 by John Arbash Meinel
Add a tree-test for get_symlink_target
1788
2255.2.69 by John Arbash Meinel
Implement annotate_iter, get_revision_id, and walkdirs so that all tree_implementations now pass
1789
    def get_revision_id(self):
1790
        """Return the revision id for this tree."""
1791
        return self._revision_id
1792
2255.2.31 by Robert Collins
Work in progress to make merge_inner work with dirstate trees.
1793
    def _get_inventory(self):
1794
        if self._inventory is not None:
1795
            return self._inventory
2255.2.182 by Martin Pool
merge dirstate and trunk
1796
        self._must_be_locked()
2255.2.31 by Robert Collins
Work in progress to make merge_inner work with dirstate trees.
1797
        self._generate_inventory()
1798
        return self._inventory
1799
1800
    inventory = property(_get_inventory,
1801
                         doc="Inventory of this Tree")
1802
2255.2.3 by Robert Collins
Split out working tree format 4 to its own file, create stub dirstate revision object, start working on dirstate.set_parent_trees - a key failure point.
1803
    def get_parent_ids(self):
1804
        """The parents of a tree in the dirstate are not cached."""
1805
        return self._repository.get_revision(self._revision_id).parent_ids
1806
2255.2.30 by Robert Collins
Some workingtree_implementations/test_workingtree.py test work - add DirStateRevisionTree.has_filename, locks around appropriate calls in tests.
1807
    def has_filename(self, filename):
2255.2.104 by Robert Collins
Add WorkingTree4.paths2ids which is inventory-usage free if the trees being examined are in the dirstate.
1808
        return bool(self.path2id(filename))
2255.2.30 by Robert Collins
Some workingtree_implementations/test_workingtree.py test work - add DirStateRevisionTree.has_filename, locks around appropriate calls in tests.
1809
2255.2.182 by Martin Pool
merge dirstate and trunk
1810
    def kind(self, file_id):
3016.1.1 by Aaron Bentley
Update DirStateRevisionTree to avoid using inventory
1811
        entry = self._get_entry(file_id=file_id)[1]
3376.2.11 by Martin Pool
Compare to None using is/is not not ==
1812
        if entry is None:
3016.1.1 by Aaron Bentley
Update DirStateRevisionTree to avoid using inventory
1813
            raise errors.NoSuchId(tree=self, file_id=file_id)
1814
        return dirstate.DirState._minikind_to_kind[entry[1][0]]
2255.2.182 by Martin Pool
merge dirstate and trunk
1815
3146.8.4 by Aaron Bentley
Eliminate direct use of inventory from transform application
1816
    def stored_kind(self, file_id):
1817
        """See Tree.stored_kind"""
1818
        return self.kind(file_id)
1819
2776.1.7 by Robert Collins
* New method on ``bzrlib.tree.Tree`` ``path_content_summary`` provides a
1820
    def path_content_summary(self, path):
1821
        """See Tree.path_content_summary."""
1822
        id = self.inventory.path2id(path)
1823
        if id is None:
1824
            return ('missing', None, None, None)
1825
        entry = self._inventory[id]
1826
        kind = entry.kind
1827
        if kind == 'file':
1828
            return (kind, entry.text_size, entry.executable, entry.text_sha1)
1829
        elif kind == 'symlink':
1830
            return (kind, None, None, entry.symlink_target)
1831
        else:
1832
            return (kind, None, None, None)
1833
2255.2.31 by Robert Collins
Work in progress to make merge_inner work with dirstate trees.
1834
    def is_executable(self, file_id, path=None):
1835
        ie = self.inventory[file_id]
1836
        if ie.kind != "file":
2255.2.84 by John Arbash Meinel
Remove now-unecessary encode/decode calls for revision ids.
1837
            return None
2255.2.31 by Robert Collins
Work in progress to make merge_inner work with dirstate trees.
1838
        return ie.executable
1839
2255.2.71 by John Arbash Meinel
Add a test for list_files, and implement it for DirStateRevisionTree
1840
    def list_files(self, include_root=False):
1841
        # We use a standard implementation, because DirStateRevisionTree is
1842
        # dealing with one of the parents of the current state
1843
        inv = self._get_inventory()
1844
        entries = inv.iter_entries()
1845
        if self.inventory.root is not None and not include_root:
1846
            entries.next()
1847
        for path, entry in entries:
1848
            yield path, 'V', entry.kind, entry.file_id, entry
2255.2.84 by John Arbash Meinel
Remove now-unecessary encode/decode calls for revision ids.
1849
2255.2.3 by Robert Collins
Split out working tree format 4 to its own file, create stub dirstate revision object, start working on dirstate.set_parent_trees - a key failure point.
1850
    def lock_read(self):
1851
        """Lock the tree for a set of operations."""
2255.2.79 by Robert Collins
Take out repository locks from Dirstate revision trees, to improve file text access performance.
1852
        if not self._locked:
1853
            self._repository.lock_read()
2255.5.2 by John Arbash Meinel
(broken) lock and unlock the DirState object when locking and unlocking the Tree itself
1854
            if self._dirstate._lock_token is None:
1855
                self._dirstate.lock_read()
1856
                self._dirstate_locked = True
2255.2.38 by Robert Collins
Fix WorkingTree4.pull to work.
1857
        self._locked += 1
2255.2.3 by Robert Collins
Split out working tree format 4 to its own file, create stub dirstate revision object, start working on dirstate.set_parent_trees - a key failure point.
1858
2255.2.183 by Martin Pool
add missing _must_be_locked and a better message
1859
    def _must_be_locked(self):
1860
        if not self._locked:
1861
            raise errors.ObjectNotLocked(self)
1862
2255.2.98 by Robert Collins
Perform path2id lookups in dirstate revision trees from the dirstate index without requiring an inventory.
1863
    @needs_read_lock
2255.2.65 by John Arbash Meinel
override path2id because it should be optimized anyway
1864
    def path2id(self, path):
1865
        """Return the id for path in this tree."""
2255.2.98 by Robert Collins
Perform path2id lookups in dirstate revision trees from the dirstate index without requiring an inventory.
1866
        # lookup by path: faster than splitting and walking the ivnentory.
1867
        entry = self._get_entry(path=path)
1868
        if entry == (None, None):
1869
            return None
2255.2.107 by John Arbash Meinel
(working), fix dirstate to use utf8 file ids.
1870
        return entry[0][2]
2255.2.65 by John Arbash Meinel
override path2id because it should be optimized anyway
1871
2255.2.3 by Robert Collins
Split out working tree format 4 to its own file, create stub dirstate revision object, start working on dirstate.set_parent_trees - a key failure point.
1872
    def unlock(self):
1873
        """Unlock, freeing any cache memory used during the lock."""
1874
        # outside of a lock, the inventory is suspect: release it.
2255.2.38 by Robert Collins
Fix WorkingTree4.pull to work.
1875
        self._locked -=1
1876
        if not self._locked:
1877
            self._inventory = None
2255.5.2 by John Arbash Meinel
(broken) lock and unlock the DirState object when locking and unlocking the Tree itself
1878
            self._locked = 0
1879
            if self._dirstate_locked:
1880
                self._dirstate.unlock()
1881
                self._dirstate_locked = False
2255.2.79 by Robert Collins
Take out repository locks from Dirstate revision trees, to improve file text access performance.
1882
            self._repository.unlock()
2255.2.69 by John Arbash Meinel
Implement annotate_iter, get_revision_id, and walkdirs so that all tree_implementations now pass
1883
3504.2.1 by John Arbash Meinel
Shortcut iter_references when we know references aren't supported.
1884
    @needs_read_lock
1885
    def supports_tree_reference(self):
1886
        return self._repo_supports_tree_reference
1887
2255.2.69 by John Arbash Meinel
Implement annotate_iter, get_revision_id, and walkdirs so that all tree_implementations now pass
1888
    def walkdirs(self, prefix=""):
2255.2.236 by Martin Pool
Review cleanups: mostly updating or removing todo comments.
1889
        # TODO: jam 20070215 This is the lazy way by using the RevisionTree
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
1890
        # implementation based on an inventory.
2255.2.236 by Martin Pool
Review cleanups: mostly updating or removing todo comments.
1891
        # This should be cleaned up to use the much faster Dirstate code
1892
        # So for now, we just build up the parent inventory, and extract
1893
        # it the same way RevisionTree does.
2255.2.69 by John Arbash Meinel
Implement annotate_iter, get_revision_id, and walkdirs so that all tree_implementations now pass
1894
        _directory = 'directory'
2255.2.70 by John Arbash Meinel
Minor improvements to DirStateRevisionTree.walkdirs()
1895
        inv = self._get_inventory()
2255.2.69 by John Arbash Meinel
Implement annotate_iter, get_revision_id, and walkdirs so that all tree_implementations now pass
1896
        top_id = inv.path2id(prefix)
1897
        if top_id is None:
1898
            pending = []
1899
        else:
2255.2.70 by John Arbash Meinel
Minor improvements to DirStateRevisionTree.walkdirs()
1900
            pending = [(prefix, top_id)]
2255.2.69 by John Arbash Meinel
Implement annotate_iter, get_revision_id, and walkdirs so that all tree_implementations now pass
1901
        while pending:
1902
            dirblock = []
2255.2.70 by John Arbash Meinel
Minor improvements to DirStateRevisionTree.walkdirs()
1903
            relpath, file_id = pending.pop()
1904
            # 0 - relpath, 1- file-id
1905
            if relpath:
1906
                relroot = relpath + '/'
2255.2.69 by John Arbash Meinel
Implement annotate_iter, get_revision_id, and walkdirs so that all tree_implementations now pass
1907
            else:
1908
                relroot = ""
1909
            # FIXME: stash the node in pending
2255.2.70 by John Arbash Meinel
Minor improvements to DirStateRevisionTree.walkdirs()
1910
            entry = inv[file_id]
2255.2.69 by John Arbash Meinel
Implement annotate_iter, get_revision_id, and walkdirs so that all tree_implementations now pass
1911
            for name, child in entry.sorted_children():
1912
                toppath = relroot + name
1913
                dirblock.append((toppath, name, child.kind, None,
1914
                    child.file_id, child.kind
1915
                    ))
2255.2.70 by John Arbash Meinel
Minor improvements to DirStateRevisionTree.walkdirs()
1916
            yield (relpath, entry.file_id), dirblock
2255.2.69 by John Arbash Meinel
Implement annotate_iter, get_revision_id, and walkdirs so that all tree_implementations now pass
1917
            # push the user specified dirs from dirblock
1918
            for dir in reversed(dirblock):
1919
                if dir[2] == _directory:
2255.2.70 by John Arbash Meinel
Minor improvements to DirStateRevisionTree.walkdirs()
1920
                    pending.append((dir[0], dir[4]))
2255.2.117 by Robert Collins
Add an InterDirStateTree InterTree optimiser.
1921
1922
1923
class InterDirStateTree(InterTree):
2255.13.3 by Martin Pool
Comments and better assertions in InterDirStateTree
1924
    """Fast path optimiser for changes_from with dirstate trees.
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
1925
1926
    This is used only when both trees are in the dirstate working file, and
1927
    the source is any parent within the dirstate, and the destination is
2255.13.3 by Martin Pool
Comments and better assertions in InterDirStateTree
1928
    the current working tree of the same dirstate.
1929
    """
1930
    # this could be generalized to allow comparisons between any trees in the
1931
    # dirstate, and possibly between trees stored in different dirstates.
2255.2.117 by Robert Collins
Add an InterDirStateTree InterTree optimiser.
1932
2255.2.122 by Robert Collins
Alter intertree implementation tests to let dirstate inter-trees be correctly parameterised.
1933
    def __init__(self, source, target):
1934
        super(InterDirStateTree, self).__init__(source, target)
1935
        if not InterDirStateTree.is_compatible(source, target):
1936
            raise Exception, "invalid source %r and target %r" % (source, target)
1937
2255.2.117 by Robert Collins
Add an InterDirStateTree InterTree optimiser.
1938
    @staticmethod
2255.2.122 by Robert Collins
Alter intertree implementation tests to let dirstate inter-trees be correctly parameterised.
1939
    def make_source_parent_tree(source, target):
1940
        """Change the source tree into a parent of the target."""
1941
        revid = source.commit('record tree')
1942
        target.branch.repository.fetch(source.branch.repository, revid)
1943
        target.set_parent_ids([revid])
1944
        return target.basis_tree(), target
2255.7.25 by John Arbash Meinel
Shave off 200+ ms of 'time bzr status' in lp tree
1945
3696.4.10 by Robert Collins
Basic first cut of full-pyrex iter_changes.
1946
    @classmethod
3696.4.15 by Robert Collins
Merge bzr.dev.
1947
    def make_source_parent_tree_python_dirstate(klass, test_case, source, target):
3696.4.10 by Robert Collins
Basic first cut of full-pyrex iter_changes.
1948
        result = klass.make_source_parent_tree(source, target)
1949
        result[1]._iter_changes = dirstate.ProcessEntryPython
1950
        return result
1951
1952
    @classmethod
3696.4.15 by Robert Collins
Merge bzr.dev.
1953
    def make_source_parent_tree_compiled_dirstate(klass, test_case, source, target):
3696.4.10 by Robert Collins
Basic first cut of full-pyrex iter_changes.
1954
        from bzrlib.tests.test__dirstate_helpers import \
1955
            CompiledDirstateHelpersFeature
1956
        if not CompiledDirstateHelpersFeature.available():
1957
            from bzrlib.tests import UnavailableFeature
1958
            raise UnavailableFeature(CompiledDirstateHelpersFeature)
1959
        from bzrlib._dirstate_helpers_c import ProcessEntryC
1960
        result = klass.make_source_parent_tree(source, target)
1961
        result[1]._iter_changes = ProcessEntryC
1962
        return result
1963
2255.2.117 by Robert Collins
Add an InterDirStateTree InterTree optimiser.
1964
    _matching_from_tree_format = WorkingTreeFormat4()
1965
    _matching_to_tree_format = WorkingTreeFormat4()
3363.14.11 by Aaron Bentley
Fix intertree tests with dirstate
1966
1967
    @classmethod
1968
    def _test_mutable_trees_to_test_trees(klass, test_case, source, target):
3696.4.15 by Robert Collins
Merge bzr.dev.
1969
        # This method shouldn't be called, because we have python and C
1970
        # specific flavours.
1971
        raise NotImplementedError
2255.2.122 by Robert Collins
Alter intertree implementation tests to let dirstate inter-trees be correctly parameterised.
1972
3254.1.1 by Aaron Bentley
Make Tree.iter_changes a public method
1973
    def iter_changes(self, include_unchanged=False,
2255.2.149 by Robert Collins
Crufty but existing _iter_changes implementation for WorkingTreeFormat4.
1974
                      specific_files=None, pb=None, extra_trees=[],
2255.7.85 by Robert Collins
Teach _iter_changes to gather unversioned path details upon request.
1975
                      require_versioned=True, want_unversioned=False):
2255.2.122 by Robert Collins
Alter intertree implementation tests to let dirstate inter-trees be correctly parameterised.
1976
        """Return the changes from source to target.
1977
3254.1.1 by Aaron Bentley
Make Tree.iter_changes a public method
1978
        :return: An iterator that yields tuples. See InterTree.iter_changes
2255.2.149 by Robert Collins
Crufty but existing _iter_changes implementation for WorkingTreeFormat4.
1979
            for details.
2255.2.122 by Robert Collins
Alter intertree implementation tests to let dirstate inter-trees be correctly parameterised.
1980
        :param specific_files: An optional list of file paths to restrict the
1981
            comparison to. When mapping filenames to ids, all matches in all
1982
            trees (including optional extra_trees) are used, and all children of
1983
            matched directories are included.
2255.2.149 by Robert Collins
Crufty but existing _iter_changes implementation for WorkingTreeFormat4.
1984
        :param include_unchanged: An optional boolean requesting the inclusion of
2255.2.122 by Robert Collins
Alter intertree implementation tests to let dirstate inter-trees be correctly parameterised.
1985
            unchanged entries in the result.
1986
        :param extra_trees: An optional list of additional trees to use when
1987
            mapping the contents of specific_files (paths) to file_ids.
2255.2.149 by Robert Collins
Crufty but existing _iter_changes implementation for WorkingTreeFormat4.
1988
        :param require_versioned: If True, all files in specific_files must be
1989
            versioned in one of source, target, extra_trees or
1990
            PathsNotVersionedError is raised.
2255.7.85 by Robert Collins
Teach _iter_changes to gather unversioned path details upon request.
1991
        :param want_unversioned: Should unversioned files be returned in the
1992
            output. An unversioned file is defined as one with (False, False)
1993
            for the versioned pair.
2255.2.122 by Robert Collins
Alter intertree implementation tests to let dirstate inter-trees be correctly parameterised.
1994
        """
1995
        # NB: show_status depends on being able to pass in non-versioned files
1996
        # and report them as unknown
2255.2.155 by Martin Pool
Better assertion message from InterDirStateTree._iter_changes
1997
        # TODO: handle extra trees in the dirstate.
2974.2.1 by John Arbash Meinel
Re-enable the fast path for the no-parent commit case.
1998
        if (extra_trees or specific_files == []):
2255.2.155 by Martin Pool
Better assertion message from InterDirStateTree._iter_changes
1999
            # we can't fast-path these cases (yet)
3696.4.10 by Robert Collins
Basic first cut of full-pyrex iter_changes.
2000
            return super(InterDirStateTree, self).iter_changes(
2255.2.149 by Robert Collins
Crufty but existing _iter_changes implementation for WorkingTreeFormat4.
2001
                include_unchanged, specific_files, pb, extra_trees,
3696.4.10 by Robert Collins
Basic first cut of full-pyrex iter_changes.
2002
                require_versioned, want_unversioned=want_unversioned)
2255.7.1 by John Arbash Meinel
_iter_changes should return Unicode paths.
2003
        parent_ids = self.target.get_parent_ids()
3376.2.4 by Martin Pool
Remove every assert statement from bzrlib!
2004
        if not (self.source._revision_id in parent_ids
2005
                or self.source._revision_id == NULL_REVISION):
2006
            raise AssertionError(
2007
                "revision {%s} is not stored in {%s}, but %s "
2008
                "can only be used for trees stored in the dirstate"
2009
                % (self.source._revision_id, self.target, self.iter_changes))
2255.2.149 by Robert Collins
Crufty but existing _iter_changes implementation for WorkingTreeFormat4.
2010
        target_index = 0
2255.7.1 by John Arbash Meinel
_iter_changes should return Unicode paths.
2011
        if self.source._revision_id == NULL_REVISION:
2012
            source_index = None
2013
            indices = (target_index,)
2014
        else:
3376.2.4 by Martin Pool
Remove every assert statement from bzrlib!
2015
            if not (self.source._revision_id in parent_ids):
2016
                raise AssertionError(
2017
                    "Failure: source._revision_id: %s not in target.parent_ids(%s)" % (
2018
                    self.source._revision_id, parent_ids))
2255.7.1 by John Arbash Meinel
_iter_changes should return Unicode paths.
2019
            source_index = 1 + parent_ids.index(self.source._revision_id)
2974.2.1 by John Arbash Meinel
Re-enable the fast path for the no-parent commit case.
2020
            indices = (source_index, target_index)
2255.2.149 by Robert Collins
Crufty but existing _iter_changes implementation for WorkingTreeFormat4.
2021
        # -- make all specific_files utf8 --
2022
        if specific_files:
2023
            specific_files_utf8 = set()
2024
            for path in specific_files:
3696.4.10 by Robert Collins
Basic first cut of full-pyrex iter_changes.
2025
                # Note, if there are many specific files, using cache_utf8
2026
                # would be good here.
2255.2.149 by Robert Collins
Crufty but existing _iter_changes implementation for WorkingTreeFormat4.
2027
                specific_files_utf8.add(path.encode('utf8'))
2028
            specific_files = specific_files_utf8
2029
        else:
2030
            specific_files = set([''])
2031
        # -- specific_files is now a utf8 path set --
4325.3.1 by Johan Walles
Don't reinvent osutils.minimum_path_selection().
2032
2255.2.149 by Robert Collins
Crufty but existing _iter_changes implementation for WorkingTreeFormat4.
2033
        # -- get the state object and prepare it.
2034
        state = self.target.current_dirstate()
2035
        state._read_dirblocks_if_needed()
2036
        if require_versioned:
2037
            # -- check all supplied paths are versioned in a search tree. --
2038
            all_versioned = True
2039
            for path in specific_files:
3696.4.10 by Robert Collins
Basic first cut of full-pyrex iter_changes.
2040
                path_entries = state._entries_for_path(path)
2255.2.149 by Robert Collins
Crufty but existing _iter_changes implementation for WorkingTreeFormat4.
2041
                if not path_entries:
2042
                    # this specified path is not present at all: error
2043
                    all_versioned = False
2044
                    break
2045
                found_versioned = False
2046
                # for each id at this path
2047
                for entry in path_entries:
2048
                    # for each tree.
2255.7.1 by John Arbash Meinel
_iter_changes should return Unicode paths.
2049
                    for index in indices:
2255.2.149 by Robert Collins
Crufty but existing _iter_changes implementation for WorkingTreeFormat4.
2050
                        if entry[1][index][0] != 'a': # absent
2051
                            found_versioned = True
2052
                            # all good: found a versioned cell
2053
                            break
2054
                if not found_versioned:
2055
                    # none of the indexes was not 'absent' at all ids for this
2056
                    # path.
2057
                    all_versioned = False
2058
                    break
2059
            if not all_versioned:
2255.7.62 by Robert Collins
Update the Tree.filter_unversioned_files docstring to reflect what the existing implementations actually do, and change the WorkingTree4 implementation to match a newly created test for it.
2060
                raise errors.PathsNotVersionedError(specific_files)
2255.2.149 by Robert Collins
Crufty but existing _iter_changes implementation for WorkingTreeFormat4.
2061
        # -- remove redundancy in supplied specific_files to prevent over-scanning --
4325.3.1 by Johan Walles
Don't reinvent osutils.minimum_path_selection().
2062
        search_specific_files = osutils.minimum_path_selection(specific_files)
3696.4.10 by Robert Collins
Basic first cut of full-pyrex iter_changes.
2063
2064
        use_filesystem_for_exec = (sys.platform != 'win32')
2065
        iter_changes = self.target._iter_changes(include_unchanged,
2066
            use_filesystem_for_exec, search_specific_files, state,
2067
            source_index, target_index, want_unversioned, self.target)
2068
        return iter_changes.iter_changes()
2255.2.149 by Robert Collins
Crufty but existing _iter_changes implementation for WorkingTreeFormat4.
2069
2255.2.117 by Robert Collins
Add an InterDirStateTree InterTree optimiser.
2070
    @staticmethod
2071
    def is_compatible(source, target):
2072
        # the target must be a dirstate working tree
3907.2.3 by Ian Clatworthy
DirStateWorkingTree and DirStateWorkingTreeFormat base classes introduced
2073
        if not isinstance(target, DirStateWorkingTree):
2255.2.117 by Robert Collins
Add an InterDirStateTree InterTree optimiser.
2074
            return False
3907.2.3 by Ian Clatworthy
DirStateWorkingTree and DirStateWorkingTreeFormat base classes introduced
2075
        # the source must be a revtree or dirstate rev tree.
2255.2.117 by Robert Collins
Add an InterDirStateTree InterTree optimiser.
2076
        if not isinstance(source,
2077
            (revisiontree.RevisionTree, DirStateRevisionTree)):
2078
            return False
2079
        # the source revid must be in the target dirstate
2080
        if not (source._revision_id == NULL_REVISION or
2081
            source._revision_id in target.get_parent_ids()):
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
2082
            # TODO: what about ghosts? it may well need to
2255.2.117 by Robert Collins
Add an InterDirStateTree InterTree optimiser.
2083
            # check for them explicitly.
2084
            return False
2085
        return True
2086
2087
InterTree.register_optimiser(InterDirStateTree)
2255.12.1 by Robert Collins
Implement upgrade for working trees.
2088
2089
2090
class Converter3to4(object):
2091
    """Perform an in-place upgrade of format 3 to format 4 trees."""
2092
2093
    def __init__(self):
2094
        self.target_format = WorkingTreeFormat4()
2095
2096
    def convert(self, tree):
2097
        # lock the control files not the tree, so that we dont get tree
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
2098
        # on-unlock behaviours, and so that noone else diddles with the
2255.12.1 by Robert Collins
Implement upgrade for working trees.
2099
        # tree during upgrade.
2100
        tree._control_files.lock_write()
2101
        try:
2334.1.3 by John Arbash Meinel
When upgrading, we can't assume that WorkingTree._inventory is valid, because that is now
2102
            tree.read_working_inventory()
2255.12.1 by Robert Collins
Implement upgrade for working trees.
2103
            self.create_dirstate_data(tree)
2104
            self.update_format(tree)
2105
            self.remove_xml_files(tree)
2106
        finally:
2107
            tree._control_files.unlock()
2108
2109
    def create_dirstate_data(self, tree):
2110
        """Create the dirstate based data for tree."""
2111
        local_path = tree.bzrdir.get_workingtree_transport(None
2112
            ).local_abspath('dirstate')
2113
        state = dirstate.DirState.from_tree(tree, local_path)
2114
        state.save()
2115
        state.unlock()
2116
2117
    def remove_xml_files(self, tree):
2118
        """Remove the oldformat 3 data."""
2119
        transport = tree.bzrdir.get_workingtree_transport(None)
2120
        for path in ['basis-inventory-cache', 'inventory', 'last-revision',
2121
            'pending-merges', 'stat-cache']:
2255.2.194 by Robert Collins
[BROKEN] Many updates to stop using experimental formats in tests.
2122
            try:
2123
                transport.delete(path)
2124
            except errors.NoSuchFile:
2125
                # some files are optional - just deal.
2126
                pass
2255.12.1 by Robert Collins
Implement upgrade for working trees.
2127
2128
    def update_format(self, tree):
2129
        """Change the format marker."""
3407.2.14 by Martin Pool
Remove more cases of getting transport via control_files
2130
        tree._transport.put_bytes('format',
3407.2.5 by Martin Pool
Deprecate LockableFiles.put_utf8
2131
            self.target_format.get_format_string(),
3407.2.18 by Martin Pool
BzrDir takes responsibility for default file/dir modes
2132
            mode=tree.bzrdir._get_file_mode())
3907.2.3 by Ian Clatworthy
DirStateWorkingTree and DirStateWorkingTreeFormat base classes introduced
2133
2134
2135
class Converter4to5(object):
2136
    """Perform an in-place upgrade of format 4 to format 5 trees."""
2137
2138
    def __init__(self):
2139
        self.target_format = WorkingTreeFormat5()
2140
2141
    def convert(self, tree):
2142
        # lock the control files not the tree, so that we don't get tree
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
2143
        # on-unlock behaviours, and so that no-one else diddles with the
3907.2.3 by Ian Clatworthy
DirStateWorkingTree and DirStateWorkingTreeFormat base classes introduced
2144
        # tree during upgrade.
2145
        tree._control_files.lock_write()
2146
        try:
4210.4.2 by Ian Clatworthy
split filtered views support out into WorkingTreeFormat6
2147
            self.update_format(tree)
2148
        finally:
2149
            tree._control_files.unlock()
2150
2151
    def update_format(self, tree):
2152
        """Change the format marker."""
2153
        tree._transport.put_bytes('format',
2154
            self.target_format.get_format_string(),
2155
            mode=tree.bzrdir._get_file_mode())
2156
2157
2158
class Converter4or5to6(object):
2159
    """Perform an in-place upgrade of format 4 or 5 to format 6 trees."""
2160
2161
    def __init__(self):
2162
        self.target_format = WorkingTreeFormat6()
2163
2164
    def convert(self, tree):
2165
        # lock the control files not the tree, so that we don't get tree
2166
        # on-unlock behaviours, and so that no-one else diddles with the
2167
        # tree during upgrade.
2168
        tree._control_files.lock_write()
2169
        try:
3907.2.3 by Ian Clatworthy
DirStateWorkingTree and DirStateWorkingTreeFormat base classes introduced
2170
            self.init_custom_control_files(tree)
2171
            self.update_format(tree)
2172
        finally:
2173
            tree._control_files.unlock()
2174
2175
    def init_custom_control_files(self, tree):
2176
        """Initialize custom control files."""
2177
        tree._transport.put_bytes('views', '',
2178
            mode=tree.bzrdir._get_file_mode())
2179
2180
    def update_format(self, tree):
2181
        """Change the format marker."""
2182
        tree._transport.put_bytes('format',
2183
            self.target_format.get_format_string(),
2184
            mode=tree.bzrdir._get_file_mode())