/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar
3008.1.29 by Aaron Bentley
Add docstrings, rename TT.__doc
1
# Copyright (C) 2006, 2007, 2008 Canonical Ltd
1887.1.1 by Adeodato Simó
Do not separate paragraphs in the copyright statement with blank lines,
2
#
1534.7.106 by Aaron Bentley
Cleaned up imports, added copyright statements
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.
1887.1.1 by Adeodato Simó
Do not separate paragraphs in the copyright statement with blank lines,
7
#
1534.7.106 by Aaron Bentley
Cleaned up imports, added copyright statements
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.
1887.1.1 by Adeodato Simó
Do not separate paragraphs in the copyright statement with blank lines,
12
#
1534.7.106 by Aaron Bentley
Cleaned up imports, added copyright statements
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
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
1534.7.1 by Aaron Bentley
Got creation of a versioned file working
17
import os
1534.7.106 by Aaron Bentley
Cleaned up imports, added copyright statements
18
import errno
3363.2.27 by Aaron Bentley
Make path_content_summary a core API
19
from stat import S_ISREG, S_IEXEC
3008.1.1 by Aaron Bentley
Start work allowing previews of transforms
20
import tempfile
1534.7.106 by Aaron Bentley
Cleaned up imports, added copyright statements
21
1551.11.12 by Aaron Bentley
Changes from review
22
from bzrlib.lazy_import import lazy_import
23
lazy_import(globals(), """
2100.3.21 by Aaron Bentley
Work on checking out by-reference trees
24
from bzrlib import (
3363.2.33 by Aaron Bentley
Implement PreviewTree.annotate_iter
25
    annotate,
2100.3.21 by Aaron Bentley
Work on checking out by-reference trees
26
    bzrdir,
2100.3.31 by Aaron Bentley
Merged bzr.dev (17 tests failing)
27
    delta,
2100.3.21 by Aaron Bentley
Work on checking out by-reference trees
28
    errors,
3363.2.4 by Aaron Bentley
Get significant portions of PreviewTree implemented and passing tests
29
    inventory,
30
    revision as _mod_revision,
2100.3.21 by Aaron Bentley
Work on checking out by-reference trees
31
    )
1551.11.12 by Aaron Bentley
Changes from review
32
""")
1534.7.32 by Aaron Bentley
Got conflict handling working when conflicts involve existing files
33
from bzrlib.errors import (DuplicateKey, MalformedTransform, NoSuchFile,
1534.7.162 by Aaron Bentley
Handle failures creating/deleting the Limbo directory
34
                           ReusingTransform, NotVersionedError, CantMoveRoot,
3006.2.1 by Alexander Belchenko
workaround for bug #81689: give a proper error message instead of traceback when symlink cannot be created (e.g. on Windows)
35
                           ExistingLimbo, ImmortalLimbo, NoFinalPath,
36
                           UnableCreateSymlink)
1534.7.106 by Aaron Bentley
Cleaned up imports, added copyright statements
37
from bzrlib.inventory import InventoryEntry
3363.2.19 by Aaron Bentley
Make PreviewTree.path2id correct
38
from bzrlib.osutils import (
39
    delete_any,
40
    file_kind,
41
    has_symlinks,
42
    lexists,
43
    pathjoin,
44
    splitpath,
45
    supports_executable,
46
)
1551.2.34 by Aaron Bentley
Refactored the revert phases
47
from bzrlib.progress import DummyProgress, ProgressPhase
2687.2.1 by Martin Pool
Rename upcoming release from 0.19 to 0.90
48
from bzrlib.symbol_versioning import (
49
        deprecated_function,
50
        )
1534.7.173 by Aaron Bentley
Added conflict warnings to revert
51
from bzrlib.trace import mutter, warning
1551.7.14 by Aaron Bentley
Use specified_file_ids instead of is_inside_any in compare_trees
52
from bzrlib import tree
2255.2.152 by Martin Pool
(broken) merge aaron's workingtree format changes
53
import bzrlib.ui
1685.1.45 by John Arbash Meinel
Moved url functions into bzrlib.urlutils
54
import bzrlib.urlutils as urlutils
1534.7.31 by Aaron Bentley
Changed tree root parent to ROOT_PARENT
55
1534.7.167 by Aaron Bentley
PEP8 and comment cleanups
56
1534.7.31 by Aaron Bentley
Changed tree root parent to ROOT_PARENT
57
ROOT_PARENT = "root-parent"
58
1534.7.167 by Aaron Bentley
PEP8 and comment cleanups
59
1534.7.1 by Aaron Bentley
Got creation of a versioned file working
60
def unique_add(map, key, value):
61
    if key in map:
1534.7.5 by Aaron Bentley
Got unique_add under test
62
        raise DuplicateKey(key=key)
1534.7.1 by Aaron Bentley
Got creation of a versioned file working
63
    map[key] = value
64
1534.7.167 by Aaron Bentley
PEP8 and comment cleanups
65
1534.7.191 by Aaron Bentley
Got transform.apply to list modified paths
66
class _TransformResults(object):
2502.1.5 by Aaron Bentley
Cleanup
67
    def __init__(self, modified_paths, rename_count):
1534.7.191 by Aaron Bentley
Got transform.apply to list modified paths
68
        object.__init__(self)
69
        self.modified_paths = modified_paths
2502.1.5 by Aaron Bentley
Cleanup
70
        self.rename_count = rename_count
1534.7.191 by Aaron Bentley
Got transform.apply to list modified paths
71
72
3008.1.1 by Aaron Bentley
Start work allowing previews of transforms
73
class TreeTransformBase(object):
3008.1.29 by Aaron Bentley
Add docstrings, rename TT.__doc
74
    """The base class for TreeTransform and TreeTransformBase"""
3008.1.1 by Aaron Bentley
Start work allowing previews of transforms
75
3008.1.15 by Aaron Bentley
Make case_sensitive an aspect of the transform, not the source tree
76
    def __init__(self, tree, limbodir, pb=DummyProgress(),
77
                 case_sensitive=True):
3008.1.29 by Aaron Bentley
Add docstrings, rename TT.__doc
78
        """Constructor.
79
80
        :param tree: The tree that will be transformed, but not necessarily
81
            the output tree.
82
        :param limbodir: A directory where new files can be stored until
83
            they are installed in their proper places
84
        :param pb: A ProgressBar indicating how much progress is being made
85
        :param case_sensitive: If True, the target of the transform is
86
            case sensitive, not just case preserving.
87
        """
1534.7.1 by Aaron Bentley
Got creation of a versioned file working
88
        object.__init__(self)
89
        self._tree = tree
3008.1.1 by Aaron Bentley
Start work allowing previews of transforms
90
        self._limbodir = limbodir
3199.1.5 by Vincent Ladeuil
Fix two more leaking tmp dirs, by reworking TransformPreview lock handling.
91
        self._deletiondir = None
1534.7.1 by Aaron Bentley
Got creation of a versioned file working
92
        self._id_number = 0
1551.19.1 by Aaron Bentley
Documentation update for TreeTransform, suggested by Michael Hudson
93
        # mapping of trans_id -> new basename
1534.7.1 by Aaron Bentley
Got creation of a versioned file working
94
        self._new_name = {}
1551.19.1 by Aaron Bentley
Documentation update for TreeTransform, suggested by Michael Hudson
95
        # mapping of trans_id -> new parent trans_id
1534.7.1 by Aaron Bentley
Got creation of a versioned file working
96
        self._new_parent = {}
1551.19.1 by Aaron Bentley
Documentation update for TreeTransform, suggested by Michael Hudson
97
        # mapping of trans_id with new contents -> new file_kind
1534.7.4 by Aaron Bentley
Unified all file types as 'contents'
98
        self._new_contents = {}
2502.1.5 by Aaron Bentley
Cleanup
99
        # A mapping of transform ids to their limbo filename
2502.1.1 by Aaron Bentley
Ensure renames only root children are renamed when building trees
100
        self._limbo_files = {}
2502.1.5 by Aaron Bentley
Cleanup
101
        # A mapping of transform ids to a set of the transform ids of children
2502.1.6 by Aaron Bentley
Update from review comments
102
        # that their limbo directory has
2502.1.2 by Aaron Bentley
Make the limited-renames functionality safer in the general case
103
        self._limbo_children = {}
2502.1.5 by Aaron Bentley
Cleanup
104
        # Map transform ids to maps of child filename to child transform id
2502.1.4 by Aaron Bentley
Ensure we only reuse limbo names appropriately
105
        self._limbo_children_names = {}
2502.1.5 by Aaron Bentley
Cleanup
106
        # List of transform ids that need to be renamed from limbo into place
2502.1.1 by Aaron Bentley
Ensure renames only root children are renamed when building trees
107
        self._needs_rename = set()
1551.19.1 by Aaron Bentley
Documentation update for TreeTransform, suggested by Michael Hudson
108
        # Set of trans_ids whose contents will be removed
1534.7.34 by Aaron Bentley
Proper conflicts for removals
109
        self._removed_contents = set()
1551.19.1 by Aaron Bentley
Documentation update for TreeTransform, suggested by Michael Hudson
110
        # Mapping of trans_id -> new execute-bit value
1534.7.25 by Aaron Bentley
Added set_executability
111
        self._new_executability = {}
1551.19.1 by Aaron Bentley
Documentation update for TreeTransform, suggested by Michael Hudson
112
        # Mapping of trans_id -> new tree-reference value
2100.3.21 by Aaron Bentley
Work on checking out by-reference trees
113
        self._new_reference_revision = {}
1551.19.1 by Aaron Bentley
Documentation update for TreeTransform, suggested by Michael Hudson
114
        # Mapping of trans_id -> new file_id
1534.7.1 by Aaron Bentley
Got creation of a versioned file working
115
        self._new_id = {}
1551.19.1 by Aaron Bentley
Documentation update for TreeTransform, suggested by Michael Hudson
116
        # Mapping of old file-id -> trans_id
1534.7.143 by Aaron Bentley
Prevented get_trans_id from automatically versioning file ids
117
        self._non_present_ids = {}
1551.19.1 by Aaron Bentley
Documentation update for TreeTransform, suggested by Michael Hudson
118
        # Mapping of new file_id -> trans_id
1534.7.75 by Aaron Bentley
Added reverse-lookup for versioned files and get_trans_id
119
        self._r_new_id = {}
1551.19.1 by Aaron Bentley
Documentation update for TreeTransform, suggested by Michael Hudson
120
        # Set of file_ids that will be removed
1534.7.39 by Aaron Bentley
Ensured that files can be unversioned (de-versioned?)
121
        self._removed_id = set()
1551.19.1 by Aaron Bentley
Documentation update for TreeTransform, suggested by Michael Hudson
122
        # Mapping of path in old tree -> trans_id
1534.7.7 by Aaron Bentley
Added support for all-file path ids
123
        self._tree_path_ids = {}
1551.19.1 by Aaron Bentley
Documentation update for TreeTransform, suggested by Michael Hudson
124
        # Mapping trans_id -> path in old tree
1534.7.8 by Aaron Bentley
Added TreeTransform.final_kind
125
        self._tree_id_paths = {}
2502.1.5 by Aaron Bentley
Cleanup
126
        # Cache of realpath results, to speed up canonical_path
1534.10.31 by Aaron Bentley
Add caching to speed canonical_path
127
        self._realpaths = {}
2502.1.5 by Aaron Bentley
Cleanup
128
        # Cache of relpath results, to speed up canonical_path
1534.10.31 by Aaron Bentley
Add caching to speed canonical_path
129
        self._relpaths = {}
1551.19.1 by Aaron Bentley
Documentation update for TreeTransform, suggested by Michael Hudson
130
        # The trans_id that will be used as the tree root
3363.2.25 by Aaron Bentley
More removals of post-tree support
131
        self._new_root = self.trans_id_tree_file_id(tree.get_root_id())
1551.19.1 by Aaron Bentley
Documentation update for TreeTransform, suggested by Michael Hudson
132
        # Indictor of whether the transform has been applied
3008.1.29 by Aaron Bentley
Add docstrings, rename TT.__doc
133
        self._done = False
1551.19.1 by Aaron Bentley
Documentation update for TreeTransform, suggested by Michael Hudson
134
        # A progress bar
1534.9.1 by Aaron Bentley
Added progress bars to merge
135
        self._pb = pb
3008.1.15 by Aaron Bentley
Make case_sensitive an aspect of the transform, not the source tree
136
        # Whether the target is case sensitive
137
        self._case_sensitive_target = case_sensitive
1551.19.1 by Aaron Bentley
Documentation update for TreeTransform, suggested by Michael Hudson
138
        # A counter of how many files have been renamed
2502.1.1 by Aaron Bentley
Ensure renames only root children are renamed when building trees
139
        self.rename_count = 0
1534.7.1 by Aaron Bentley
Got creation of a versioned file working
140
1534.7.132 by Aaron Bentley
Got cooked conflicts working
141
    def __get_root(self):
142
        return self._new_root
143
144
    root = property(__get_root)
145
1534.7.1 by Aaron Bentley
Got creation of a versioned file working
146
    def finalize(self):
2502.1.6 by Aaron Bentley
Update from review comments
147
        """Release the working tree lock, if held, clean up limbo dir.
148
149
        This is required if apply has not been invoked, but can be invoked
150
        even after apply.
151
        """
1534.7.1 by Aaron Bentley
Got creation of a versioned file working
152
        if self._tree is None:
153
            return
1534.7.162 by Aaron Bentley
Handle failures creating/deleting the Limbo directory
154
        try:
2502.1.7 by Aaron Bentley
Fix finalize deletion ordering
155
            entries = [(self._limbo_name(t), t, k) for t, k in
156
                       self._new_contents.iteritems()]
2502.1.8 by Aaron Bentley
Updates from review comments
157
            entries.sort(reverse=True)
158
            for path, trans_id, kind in entries:
1534.7.162 by Aaron Bentley
Handle failures creating/deleting the Limbo directory
159
                if kind == "directory":
160
                    os.rmdir(path)
161
                else:
162
                    os.unlink(path)
163
            try:
164
                os.rmdir(self._limbodir)
165
            except OSError:
166
                # We don't especially care *why* the dir is immortal.
167
                raise ImmortalLimbo(self._limbodir)
2733.2.11 by Aaron Bentley
Detect irregularities with the pending-deletion directory
168
            try:
3199.1.5 by Vincent Ladeuil
Fix two more leaking tmp dirs, by reworking TransformPreview lock handling.
169
                if self._deletiondir is not None:
170
                    os.rmdir(self._deletiondir)
2733.2.11 by Aaron Bentley
Detect irregularities with the pending-deletion directory
171
            except OSError:
172
                raise errors.ImmortalPendingDeletion(self._deletiondir)
1534.7.162 by Aaron Bentley
Handle failures creating/deleting the Limbo directory
173
        finally:
174
            self._tree.unlock()
175
            self._tree = None
1534.7.1 by Aaron Bentley
Got creation of a versioned file working
176
177
    def _assign_id(self):
178
        """Produce a new tranform id"""
179
        new_id = "new-%s" % self._id_number
180
        self._id_number +=1
181
        return new_id
182
183
    def create_path(self, name, parent):
184
        """Assign a transaction id to a new path"""
185
        trans_id = self._assign_id()
186
        unique_add(self._new_name, trans_id, name)
187
        unique_add(self._new_parent, trans_id, parent)
188
        return trans_id
189
1534.7.6 by Aaron Bentley
Added conflict handling
190
    def adjust_path(self, name, parent, trans_id):
1534.7.21 by Aaron Bentley
Updated docstrings
191
        """Change the path that is assigned to a transaction id."""
1534.7.66 by Aaron Bentley
Ensured we don't accidentally move the root directory
192
        if trans_id == self._new_root:
193
            raise CantMoveRoot
2502.1.2 by Aaron Bentley
Make the limited-renames functionality safer in the general case
194
        previous_parent = self._new_parent.get(trans_id)
2502.1.4 by Aaron Bentley
Ensure we only reuse limbo names appropriately
195
        previous_name = self._new_name.get(trans_id)
1534.7.6 by Aaron Bentley
Added conflict handling
196
        self._new_name[trans_id] = name
197
        self._new_parent[trans_id] = parent
2502.1.2 by Aaron Bentley
Make the limited-renames functionality safer in the general case
198
        if (trans_id in self._limbo_files and
199
            trans_id not in self._needs_rename):
200
            self._rename_in_limbo([trans_id])
201
            self._limbo_children[previous_parent].remove(trans_id)
2502.1.4 by Aaron Bentley
Ensure we only reuse limbo names appropriately
202
            del self._limbo_children_names[previous_parent][previous_name]
2502.1.2 by Aaron Bentley
Make the limited-renames functionality safer in the general case
203
204
    def _rename_in_limbo(self, trans_ids):
2502.1.6 by Aaron Bentley
Update from review comments
205
        """Fix limbo names so that the right final path is produced.
2502.1.2 by Aaron Bentley
Make the limited-renames functionality safer in the general case
206
207
        This means we outsmarted ourselves-- we tried to avoid renaming
2502.1.6 by Aaron Bentley
Update from review comments
208
        these files later by creating them with their final names in their
209
        final parents.  But now the previous name or parent is no longer
2502.1.2 by Aaron Bentley
Make the limited-renames functionality safer in the general case
210
        suitable, so we have to rename them.
2502.1.14 by Aaron Bentley
Style update suggested by Robert
211
212
        Even for trans_ids that have no new contents, we must remove their
213
        entries from _limbo_files, because they are now stale.
2502.1.2 by Aaron Bentley
Make the limited-renames functionality safer in the general case
214
        """
215
        for trans_id in trans_ids:
2502.1.14 by Aaron Bentley
Style update suggested by Robert
216
            old_path = self._limbo_files.pop(trans_id)
2502.1.13 by Aaron Bentley
Updates from review
217
            if trans_id not in self._new_contents:
218
                continue
2502.1.14 by Aaron Bentley
Style update suggested by Robert
219
            new_path = self._limbo_name(trans_id)
2502.1.13 by Aaron Bentley
Updates from review
220
            os.rename(old_path, new_path)
1534.7.6 by Aaron Bentley
Added conflict handling
221
1534.7.68 by Aaron Bentley
Got semi-reasonable root directory renaming working
222
    def adjust_root_path(self, name, parent):
223
        """Emulate moving the root by moving all children, instead.
224
        
225
        We do this by undoing the association of root's transaction id with the
226
        current tree.  This allows us to create a new directory with that
1534.7.69 by Aaron Bentley
Got real root moves working
227
        transaction id.  We unversion the root directory and version the 
228
        physically new directory, and hope someone versions the tree root
229
        later.
1534.7.68 by Aaron Bentley
Got semi-reasonable root directory renaming working
230
        """
231
        old_root = self._new_root
232
        old_root_file_id = self.final_file_id(old_root)
233
        # force moving all children of root
234
        for child_id in self.iter_tree_children(old_root):
235
            if child_id != parent:
236
                self.adjust_path(self.final_name(child_id), 
237
                                 self.final_parent(child_id), child_id)
1534.7.69 by Aaron Bentley
Got real root moves working
238
            file_id = self.final_file_id(child_id)
239
            if file_id is not None:
240
                self.unversion_file(child_id)
241
            self.version_file(file_id, child_id)
1534.7.68 by Aaron Bentley
Got semi-reasonable root directory renaming working
242
        
243
        # the physical root needs a new transaction id
244
        self._tree_path_ids.pop("")
245
        self._tree_id_paths.pop(old_root)
1534.7.181 by Aaron Bentley
Renamed a bunch of functions
246
        self._new_root = self.trans_id_tree_file_id(self._tree.get_root_id())
1534.7.68 by Aaron Bentley
Got semi-reasonable root directory renaming working
247
        if parent == old_root:
248
            parent = self._new_root
249
        self.adjust_path(name, parent, old_root)
250
        self.create_directory(old_root)
1534.7.69 by Aaron Bentley
Got real root moves working
251
        self.version_file(old_root_file_id, old_root)
252
        self.unversion_file(self._new_root)
1534.7.68 by Aaron Bentley
Got semi-reasonable root directory renaming working
253
1534.7.181 by Aaron Bentley
Renamed a bunch of functions
254
    def trans_id_tree_file_id(self, inventory_id):
1534.7.1 by Aaron Bentley
Got creation of a versioned file working
255
        """Determine the transaction id of a working tree file.
256
        
257
        This reflects only files that already exist, not ones that will be
258
        added by transactions.
259
        """
3146.8.1 by Aaron Bentley
Fix two tree.inventory uses in checkout
260
        path = self._tree.id2path(inventory_id)
1534.7.181 by Aaron Bentley
Renamed a bunch of functions
261
        return self.trans_id_tree_path(path)
1534.7.7 by Aaron Bentley
Added support for all-file path ids
262
1534.7.181 by Aaron Bentley
Renamed a bunch of functions
263
    def trans_id_file_id(self, file_id):
1534.7.156 by Aaron Bentley
PEP8 fixes
264
        """Determine or set the transaction id associated with a file ID.
1534.7.75 by Aaron Bentley
Added reverse-lookup for versioned files and get_trans_id
265
        A new id is only created for file_ids that were never present.  If
266
        a transaction has been unversioned, it is deliberately still returned.
267
        (this will likely lead to an unversioned parent conflict.)
268
        """
269
        if file_id in self._r_new_id and self._r_new_id[file_id] is not None:
270
            return self._r_new_id[file_id]
271
        elif file_id in self._tree.inventory:
1534.7.181 by Aaron Bentley
Renamed a bunch of functions
272
            return self.trans_id_tree_file_id(file_id)
1534.7.143 by Aaron Bentley
Prevented get_trans_id from automatically versioning file ids
273
        elif file_id in self._non_present_ids:
274
            return self._non_present_ids[file_id]
1534.7.75 by Aaron Bentley
Added reverse-lookup for versioned files and get_trans_id
275
        else:
276
            trans_id = self._assign_id()
1534.7.143 by Aaron Bentley
Prevented get_trans_id from automatically versioning file ids
277
            self._non_present_ids[file_id] = trans_id
1534.7.75 by Aaron Bentley
Added reverse-lookup for versioned files and get_trans_id
278
            return trans_id
279
1534.7.12 by Aaron Bentley
Added canonical_path function
280
    def canonical_path(self, path):
281
        """Get the canonical tree-relative path"""
282
        # don't follow final symlinks
1534.10.31 by Aaron Bentley
Add caching to speed canonical_path
283
        abs = self._tree.abspath(path)
284
        if abs in self._relpaths:
285
            return self._relpaths[abs]
286
        dirname, basename = os.path.split(abs)
287
        if dirname not in self._realpaths:
288
            self._realpaths[dirname] = os.path.realpath(dirname)
289
        dirname = self._realpaths[dirname]
290
        abs = pathjoin(dirname, basename)
291
        if dirname in self._relpaths:
292
            relpath = pathjoin(self._relpaths[dirname], basename)
1534.10.32 by Aaron Bentley
Test and fix case where name has trailing slash
293
            relpath = relpath.rstrip('/\\')
1534.10.31 by Aaron Bentley
Add caching to speed canonical_path
294
        else:
295
            relpath = self._tree.relpath(abs)
296
        self._relpaths[abs] = relpath
297
        return relpath
1534.7.12 by Aaron Bentley
Added canonical_path function
298
1534.7.181 by Aaron Bentley
Renamed a bunch of functions
299
    def trans_id_tree_path(self, path):
1534.7.7 by Aaron Bentley
Added support for all-file path ids
300
        """Determine (and maybe set) the transaction ID for a tree path."""
1534.7.12 by Aaron Bentley
Added canonical_path function
301
        path = self.canonical_path(path)
1534.7.7 by Aaron Bentley
Added support for all-file path ids
302
        if path not in self._tree_path_ids:
303
            self._tree_path_ids[path] = self._assign_id()
1534.7.8 by Aaron Bentley
Added TreeTransform.final_kind
304
            self._tree_id_paths[self._tree_path_ids[path]] = path
1534.7.7 by Aaron Bentley
Added support for all-file path ids
305
        return self._tree_path_ids[path]
1534.7.1 by Aaron Bentley
Got creation of a versioned file working
306
1534.7.16 by Aaron Bentley
Added get_tree_parent
307
    def get_tree_parent(self, trans_id):
1534.7.31 by Aaron Bentley
Changed tree root parent to ROOT_PARENT
308
        """Determine id of the parent in the tree."""
1534.7.16 by Aaron Bentley
Added get_tree_parent
309
        path = self._tree_id_paths[trans_id]
310
        if path == "":
1534.7.31 by Aaron Bentley
Changed tree root parent to ROOT_PARENT
311
            return ROOT_PARENT
1534.7.181 by Aaron Bentley
Renamed a bunch of functions
312
        return self.trans_id_tree_path(os.path.dirname(path))
1534.7.16 by Aaron Bentley
Added get_tree_parent
313
1534.7.117 by Aaron Bentley
Simplified permission handling of existing files in transform.
314
    def create_file(self, contents, trans_id, mode_id=None):
1534.7.21 by Aaron Bentley
Updated docstrings
315
        """Schedule creation of a new file.
316
317
        See also new_file.
1534.7.1 by Aaron Bentley
Got creation of a versioned file working
318
        
319
        Contents is an iterator of strings, all of which will be written
1534.7.21 by Aaron Bentley
Updated docstrings
320
        to the target destination.
1534.7.117 by Aaron Bentley
Simplified permission handling of existing files in transform.
321
322
        New file takes the permissions of any existing file with that id,
323
        unless mode_id is specified.
1534.7.1 by Aaron Bentley
Got creation of a versioned file working
324
        """
1711.7.22 by John Arbash Meinel
transform: cleanup the temporary file even if unique_add fails.
325
        name = self._limbo_name(trans_id)
326
        f = open(name, 'wb')
1711.7.8 by John Arbash Meinel
Use try/finally inside create_file for TreeTransform to ensure the file handle gets closed
327
        try:
1711.7.22 by John Arbash Meinel
transform: cleanup the temporary file even if unique_add fails.
328
            try:
329
                unique_add(self._new_contents, trans_id, 'file')
330
            except:
331
                # Clean up the file, it never got registered so
332
                # TreeTransform.finalize() won't clean it up.
333
                f.close()
334
                os.unlink(name)
335
                raise
336
2247.1.2 by John Arbash Meinel
Switch from for line in foo: f.write(line) to f.writelines(foo)
337
            f.writelines(contents)
1711.7.8 by John Arbash Meinel
Use try/finally inside create_file for TreeTransform to ensure the file handle gets closed
338
        finally:
339
            f.close()
1534.7.117 by Aaron Bentley
Simplified permission handling of existing files in transform.
340
        self._set_mode(trans_id, mode_id, S_ISREG)
341
342
    def _set_mode(self, trans_id, mode_id, typefunc):
1534.7.157 by Aaron Bentley
Added more docs
343
        """Set the mode of new file contents.
344
        The mode_id is the existing file to get the mode from (often the same
345
        as trans_id).  The operation is only performed if there's a mode match
346
        according to typefunc.
347
        """
1534.7.117 by Aaron Bentley
Simplified permission handling of existing files in transform.
348
        if mode_id is None:
349
            mode_id = trans_id
350
        try:
351
            old_path = self._tree_id_paths[mode_id]
352
        except KeyError:
353
            return
354
        try:
2027.1.1 by John Arbash Meinel
Fix bug #56549, and write a direct test that the right path is being statted
355
            mode = os.stat(self._tree.abspath(old_path)).st_mode
1534.7.117 by Aaron Bentley
Simplified permission handling of existing files in transform.
356
        except OSError, e:
3535.6.2 by James Westby
Fixes from review. Thanks Aaron and John.
357
            if e.errno in (errno.ENOENT, errno.ENOTDIR):
358
                # Either old_path doesn't exist, or the parent of the
359
                # target is not a directory (but will be one eventually)
360
                # Either way, we know it doesn't exist *right now*
361
                # See also bug #248448
3535.6.1 by James Westby
Handle a file turning in to a directory in TreeTransform.
362
                return
1534.7.117 by Aaron Bentley
Simplified permission handling of existing files in transform.
363
            else:
364
                raise
365
        if typefunc(mode):
366
            os.chmod(self._limbo_name(trans_id), mode)
1534.7.1 by Aaron Bentley
Got creation of a versioned file working
367
3136.1.1 by Aaron Bentley
Add support for hardlinks to TreeTransform
368
    def create_hardlink(self, path, trans_id):
369
        """Schedule creation of a hard link"""
370
        name = self._limbo_name(trans_id)
3136.1.10 by Aaron Bentley
Clean error if filesystem does not support hard-links
371
        try:
372
            os.link(path, name)
373
        except OSError, e:
374
            if e.errno != errno.EPERM:
375
                raise
376
            raise errors.HardLinkNotSupported(path)
3136.1.1 by Aaron Bentley
Add support for hardlinks to TreeTransform
377
        try:
378
            unique_add(self._new_contents, trans_id, 'file')
379
        except:
380
            # Clean up the file, it never got registered so
381
            # TreeTransform.finalize() won't clean it up.
382
            os.unlink(name)
383
            raise
384
1534.7.20 by Aaron Bentley
Added directory handling
385
    def create_directory(self, trans_id):
1534.7.21 by Aaron Bentley
Updated docstrings
386
        """Schedule creation of a new directory.
387
        
388
        See also new_directory.
389
        """
1534.7.73 by Aaron Bentley
Changed model again. Now iterator is used immediately.
390
        os.mkdir(self._limbo_name(trans_id))
391
        unique_add(self._new_contents, trans_id, 'directory')
1534.7.20 by Aaron Bentley
Added directory handling
392
1534.7.22 by Aaron Bentley
Added symlink support
393
    def create_symlink(self, target, trans_id):
394
        """Schedule creation of a new symbolic link.
395
396
        target is a bytestring.
397
        See also new_symlink.
398
        """
3006.2.1 by Alexander Belchenko
workaround for bug #81689: give a proper error message instead of traceback when symlink cannot be created (e.g. on Windows)
399
        if has_symlinks():
400
            os.symlink(target, self._limbo_name(trans_id))
401
            unique_add(self._new_contents, trans_id, 'symlink')
402
        else:
3006.2.2 by Alexander Belchenko
tests added.
403
            try:
404
                path = FinalPaths(self).get_path(trans_id)
405
            except KeyError:
406
                path = None
407
            raise UnableCreateSymlink(path=path)
1534.7.22 by Aaron Bentley
Added symlink support
408
1534.7.129 by Aaron Bentley
Converted test cases to Tree Transform
409
    def cancel_creation(self, trans_id):
1534.7.157 by Aaron Bentley
Added more docs
410
        """Cancel the creation of new file contents."""
1534.7.129 by Aaron Bentley
Converted test cases to Tree Transform
411
        del self._new_contents[trans_id]
2502.1.2 by Aaron Bentley
Make the limited-renames functionality safer in the general case
412
        children = self._limbo_children.get(trans_id)
413
        # if this is a limbo directory with children, move them before removing
414
        # the directory
415
        if children is not None:
416
            self._rename_in_limbo(children)
417
            del self._limbo_children[trans_id]
2502.1.4 by Aaron Bentley
Ensure we only reuse limbo names appropriately
418
            del self._limbo_children_names[trans_id]
1558.12.9 by Aaron Bentley
Handle resolving conflicts with directories properly
419
        delete_any(self._limbo_name(trans_id))
1534.7.129 by Aaron Bentley
Converted test cases to Tree Transform
420
1534.7.34 by Aaron Bentley
Proper conflicts for removals
421
    def delete_contents(self, trans_id):
422
        """Schedule the contents of a path entry for deletion"""
1534.7.130 by Aaron Bentley
More conflict handling, test porting
423
        self.tree_kind(trans_id)
1534.7.34 by Aaron Bentley
Proper conflicts for removals
424
        self._removed_contents.add(trans_id)
425
1534.7.61 by Aaron Bentley
Handled parent loops, missing parents, unversioned parents
426
    def cancel_deletion(self, trans_id):
427
        """Cancel a scheduled deletion"""
428
        self._removed_contents.remove(trans_id)
429
1534.7.39 by Aaron Bentley
Ensured that files can be unversioned (de-versioned?)
430
    def unversion_file(self, trans_id):
431
        """Schedule a path entry to become unversioned"""
432
        self._removed_id.add(trans_id)
433
434
    def delete_versioned(self, trans_id):
435
        """Delete and unversion a versioned file"""
436
        self.delete_contents(trans_id)
437
        self.unversion_file(trans_id)
438
1534.7.25 by Aaron Bentley
Added set_executability
439
    def set_executability(self, executability, trans_id):
1534.7.167 by Aaron Bentley
PEP8 and comment cleanups
440
        """Schedule setting of the 'execute' bit
441
        To unschedule, set to None
442
        """
1534.7.26 by Aaron Bentley
Added conflicts for setting executability on unversioned/non-file entries
443
        if executability is None:
444
            del self._new_executability[trans_id]
445
        else:
446
            unique_add(self._new_executability, trans_id, executability)
1534.7.25 by Aaron Bentley
Added set_executability
447
2100.3.21 by Aaron Bentley
Work on checking out by-reference trees
448
    def set_tree_reference(self, revision_id, trans_id):
449
        """Set the reference associated with a directory"""
450
        unique_add(self._new_reference_revision, trans_id, revision_id)
451
1534.7.1 by Aaron Bentley
Got creation of a versioned file working
452
    def version_file(self, file_id, trans_id):
1534.7.21 by Aaron Bentley
Updated docstrings
453
        """Schedule a file to become versioned."""
3376.2.4 by Martin Pool
Remove every assert statement from bzrlib!
454
        if file_id is None:
455
            raise ValueError()
1534.7.1 by Aaron Bentley
Got creation of a versioned file working
456
        unique_add(self._new_id, trans_id, file_id)
1534.7.75 by Aaron Bentley
Added reverse-lookup for versioned files and get_trans_id
457
        unique_add(self._r_new_id, file_id, trans_id)
1534.7.1 by Aaron Bentley
Got creation of a versioned file working
458
1534.7.105 by Aaron Bentley
Got merge with rename working
459
    def cancel_versioning(self, trans_id):
460
        """Undo a previous versioning of a file"""
461
        file_id = self._new_id[trans_id]
462
        del self._new_id[trans_id]
463
        del self._r_new_id[file_id]
464
3453.2.3 by Aaron Bentley
Enable using a precomputed inventory delta for build_tree.
465
    def new_paths(self, filesystem_only=False):
466
        """Determine the paths of all new and changed files.
467
3453.2.11 by Aaron Bentley
Updates from review
468
        :param filesystem_only: if True, only calculate values for files
469
            that require renames or execute bit changes.
3453.2.3 by Aaron Bentley
Enable using a precomputed inventory delta for build_tree.
470
        """
1534.7.1 by Aaron Bentley
Got creation of a versioned file working
471
        new_ids = set()
3453.2.3 by Aaron Bentley
Enable using a precomputed inventory delta for build_tree.
472
        if filesystem_only:
473
            id_sets = (self._needs_rename, self._new_executability)
474
        else:
475
            id_sets = (self._new_name, self._new_parent, self._new_contents,
476
                       self._new_id, self._new_executability)
477
        for id_set in id_sets:
1534.7.1 by Aaron Bentley
Got creation of a versioned file working
478
            new_ids.update(id_set)
3453.2.3 by Aaron Bentley
Enable using a precomputed inventory delta for build_tree.
479
        return sorted(FinalPaths(self).get_paths(new_ids))
1534.7.6 by Aaron Bentley
Added conflict handling
480
1534.7.34 by Aaron Bentley
Proper conflicts for removals
481
    def tree_kind(self, trans_id):
1534.7.40 by Aaron Bentley
Updated docs
482
        """Determine the file kind in the working tree.
483
484
        Raises NoSuchFile if the file does not exist
485
        """
1534.7.34 by Aaron Bentley
Proper conflicts for removals
486
        path = self._tree_id_paths.get(trans_id)
487
        if path is None:
488
            raise NoSuchFile(None)
489
        try:
490
            return file_kind(self._tree.abspath(path))
491
        except OSError, e:
492
            if e.errno != errno.ENOENT:
493
                raise
494
            else:
495
                raise NoSuchFile(path)
496
1534.7.8 by Aaron Bentley
Added TreeTransform.final_kind
497
    def final_kind(self, trans_id):
1534.7.156 by Aaron Bentley
PEP8 fixes
498
        """Determine the final file kind, after any changes applied.
1534.7.8 by Aaron Bentley
Added TreeTransform.final_kind
499
        
500
        Raises NoSuchFile if the file does not exist/has no contents.
501
        (It is conceivable that a path would be created without the
502
        corresponding contents insertion command)
503
        """
504
        if trans_id in self._new_contents:
1534.7.73 by Aaron Bentley
Changed model again. Now iterator is used immediately.
505
            return self._new_contents[trans_id]
1534.7.34 by Aaron Bentley
Proper conflicts for removals
506
        elif trans_id in self._removed_contents:
507
            raise NoSuchFile(None)
1534.7.8 by Aaron Bentley
Added TreeTransform.final_kind
508
        else:
1534.7.34 by Aaron Bentley
Proper conflicts for removals
509
            return self.tree_kind(trans_id)
1534.7.8 by Aaron Bentley
Added TreeTransform.final_kind
510
1534.7.181 by Aaron Bentley
Renamed a bunch of functions
511
    def tree_file_id(self, trans_id):
1534.7.41 by Aaron Bentley
Got inventory ID movement working
512
        """Determine the file id associated with the trans_id in the tree"""
513
        try:
514
            path = self._tree_id_paths[trans_id]
515
        except KeyError:
516
            # the file is a new, unversioned file, or invalid trans_id
517
            return None
518
        # the file is old; the old id is still valid
1534.7.68 by Aaron Bentley
Got semi-reasonable root directory renaming working
519
        if self._new_root == trans_id:
2946.3.3 by John Arbash Meinel
Prefer tree.get_root_id() as more explicit than tree.path2id('')
520
            return self._tree.get_root_id()
1534.7.148 by Aaron Bentley
Handled the remaining file versioning case
521
        return self._tree.inventory.path2id(path)
1534.7.41 by Aaron Bentley
Got inventory ID movement working
522
1534.7.13 by Aaron Bentley
Implemented final_file_id
523
    def final_file_id(self, trans_id):
1534.7.156 by Aaron Bentley
PEP8 fixes
524
        """Determine the file id after any changes are applied, or None.
1534.7.21 by Aaron Bentley
Updated docstrings
525
        
526
        None indicates that the file will not be versioned after changes are
527
        applied.
528
        """
1534.7.13 by Aaron Bentley
Implemented final_file_id
529
        try:
530
            return self._new_id[trans_id]
531
        except KeyError:
1534.7.39 by Aaron Bentley
Ensured that files can be unversioned (de-versioned?)
532
            if trans_id in self._removed_id:
533
                return None
1534.7.181 by Aaron Bentley
Renamed a bunch of functions
534
        return self.tree_file_id(trans_id)
1534.7.13 by Aaron Bentley
Implemented final_file_id
535
1534.7.148 by Aaron Bentley
Handled the remaining file versioning case
536
    def inactive_file_id(self, trans_id):
1534.7.157 by Aaron Bentley
Added more docs
537
        """Return the inactive file_id associated with a transaction id.
1534.7.148 by Aaron Bentley
Handled the remaining file versioning case
538
        That is, the one in the tree or in non_present_ids.
539
        The file_id may actually be active, too.
540
        """
1534.7.181 by Aaron Bentley
Renamed a bunch of functions
541
        file_id = self.tree_file_id(trans_id)
1534.7.148 by Aaron Bentley
Handled the remaining file versioning case
542
        if file_id is not None:
543
            return file_id
544
        for key, value in self._non_present_ids.iteritems():
545
            if value == trans_id:
546
                return key
547
1534.7.17 by Aaron Bentley
Added final_parent function
548
    def final_parent(self, trans_id):
1534.7.156 by Aaron Bentley
PEP8 fixes
549
        """Determine the parent file_id, after any changes are applied.
1534.7.21 by Aaron Bentley
Updated docstrings
550
1534.7.31 by Aaron Bentley
Changed tree root parent to ROOT_PARENT
551
        ROOT_PARENT is returned for the tree root.
1534.7.21 by Aaron Bentley
Updated docstrings
552
        """
1534.7.17 by Aaron Bentley
Added final_parent function
553
        try:
554
            return self._new_parent[trans_id]
555
        except KeyError:
556
            return self.get_tree_parent(trans_id)
557
1534.7.32 by Aaron Bentley
Got conflict handling working when conflicts involve existing files
558
    def final_name(self, trans_id):
1534.7.40 by Aaron Bentley
Updated docs
559
        """Determine the final filename, after all changes are applied."""
1534.7.32 by Aaron Bentley
Got conflict handling working when conflicts involve existing files
560
        try:
561
            return self._new_name[trans_id]
562
        except KeyError:
1731.1.33 by Aaron Bentley
Revert no-special-root changes
563
            try:
564
                return os.path.basename(self._tree_id_paths[trans_id])
565
            except KeyError:
566
                raise NoFinalPath(trans_id, self)
1534.7.32 by Aaron Bentley
Got conflict handling working when conflicts involve existing files
567
1534.10.28 by Aaron Bentley
Use numbered backup files
568
    def by_parent(self):
1534.7.40 by Aaron Bentley
Updated docs
569
        """Return a map of parent: children for known parents.
570
        
571
        Only new paths and parents of tree files with assigned ids are used.
572
        """
1534.7.6 by Aaron Bentley
Added conflict handling
573
        by_parent = {}
1534.7.32 by Aaron Bentley
Got conflict handling working when conflicts involve existing files
574
        items = list(self._new_parent.iteritems())
1534.7.76 by Aaron Bentley
Fixed final_parent, for the case where finding a parent adds tree id paths.
575
        items.extend((t, self.final_parent(t)) for t in 
576
                      self._tree_id_paths.keys())
1534.7.32 by Aaron Bentley
Got conflict handling working when conflicts involve existing files
577
        for trans_id, parent_id in items:
1534.7.6 by Aaron Bentley
Added conflict handling
578
            if parent_id not in by_parent:
579
                by_parent[parent_id] = set()
580
            by_parent[parent_id].add(trans_id)
1534.7.32 by Aaron Bentley
Got conflict handling working when conflicts involve existing files
581
        return by_parent
1534.7.11 by Aaron Bentley
Refactored conflict handling
582
1534.7.57 by Aaron Bentley
Enhanced conflict resolution.
583
    def path_changed(self, trans_id):
1534.7.157 by Aaron Bentley
Added more docs
584
        """Return True if a trans_id's path has changed."""
1711.9.11 by John Arbash Meinel
change return foo in bar to return (foo in bar)
585
        return (trans_id in self._new_name) or (trans_id in self._new_parent)
1534.7.57 by Aaron Bentley
Enhanced conflict resolution.
586
1966.1.2 by Aaron Bentley
Divert files instead of failing to create them, update from review
587
    def new_contents(self, trans_id):
588
        return (trans_id in self._new_contents)
589
1534.7.32 by Aaron Bentley
Got conflict handling working when conflicts involve existing files
590
    def find_conflicts(self):
1534.7.40 by Aaron Bentley
Updated docs
591
        """Find any violations of inventory or filesystem invariants"""
3008.1.29 by Aaron Bentley
Add docstrings, rename TT.__doc
592
        if self._done is True:
1534.7.32 by Aaron Bentley
Got conflict handling working when conflicts involve existing files
593
            raise ReusingTransform()
594
        conflicts = []
595
        # ensure all children of all existent parents are known
596
        # all children of non-existent parents are known, by definition.
597
        self._add_tree_children()
1534.10.28 by Aaron Bentley
Use numbered backup files
598
        by_parent = self.by_parent()
1534.7.15 by Aaron Bentley
Add conflict types related to versioning
599
        conflicts.extend(self._unversioned_parents(by_parent))
1534.7.19 by Aaron Bentley
Added tests for parent loops
600
        conflicts.extend(self._parent_loops())
1534.7.11 by Aaron Bentley
Refactored conflict handling
601
        conflicts.extend(self._duplicate_entries(by_parent))
1534.7.50 by Aaron Bentley
Detect duplicate inventory ids
602
        conflicts.extend(self._duplicate_ids())
1534.7.11 by Aaron Bentley
Refactored conflict handling
603
        conflicts.extend(self._parent_type_conflicts(by_parent))
1534.7.15 by Aaron Bentley
Add conflict types related to versioning
604
        conflicts.extend(self._improper_versioning())
1534.7.26 by Aaron Bentley
Added conflicts for setting executability on unversioned/non-file entries
605
        conflicts.extend(self._executability_conflicts())
1534.7.152 by Aaron Bentley
Fixed overwrites
606
        conflicts.extend(self._overwrite_conflicts())
1534.7.15 by Aaron Bentley
Add conflict types related to versioning
607
        return conflicts
608
1534.7.32 by Aaron Bentley
Got conflict handling working when conflicts involve existing files
609
    def _add_tree_children(self):
1534.7.156 by Aaron Bentley
PEP8 fixes
610
        """Add all the children of all active parents to the known paths.
1534.7.40 by Aaron Bentley
Updated docs
611
612
        Active parents are those which gain children, and those which are
613
        removed.  This is a necessary first step in detecting conflicts.
614
        """
1534.10.28 by Aaron Bentley
Use numbered backup files
615
        parents = self.by_parent().keys()
1534.7.34 by Aaron Bentley
Proper conflicts for removals
616
        parents.extend([t for t in self._removed_contents if 
617
                        self.tree_kind(t) == 'directory'])
1534.7.50 by Aaron Bentley
Detect duplicate inventory ids
618
        for trans_id in self._removed_id:
1534.7.181 by Aaron Bentley
Renamed a bunch of functions
619
            file_id = self.tree_file_id(trans_id)
3144.4.2 by Aaron Bentley
Handle non-directory parent conflicts (abentley, #177390)
620
            if file_id is not None:
621
                if self._tree.inventory[file_id].kind == 'directory':
622
                    parents.append(trans_id)
623
            elif self.tree_kind(trans_id) == 'directory':
1534.7.50 by Aaron Bentley
Detect duplicate inventory ids
624
                parents.append(trans_id)
625
1534.7.32 by Aaron Bentley
Got conflict handling working when conflicts involve existing files
626
        for parent_id in parents:
1534.7.67 by Aaron Bentley
Refactored _add_tree_children
627
            # ensure that all children are registered with the transaction
628
            list(self.iter_tree_children(parent_id))
629
630
    def iter_tree_children(self, parent_id):
631
        """Iterate through the entry's tree children, if any"""
632
        try:
633
            path = self._tree_id_paths[parent_id]
634
        except KeyError:
635
            return
636
        try:
637
            children = os.listdir(self._tree.abspath(path))
638
        except OSError, e:
3144.4.1 by Aaron Bentley
Handle trying to list parents of a non-directory
639
            if e.errno not in (errno.ENOENT, errno.ESRCH, errno.ENOTDIR):
1534.7.67 by Aaron Bentley
Refactored _add_tree_children
640
                raise
641
            return
642
            
643
        for child in children:
644
            childpath = joinpath(path, child)
1534.7.180 by Aaron Bentley
Merge from mainline
645
            if self._tree.is_control_filename(childpath):
1534.7.67 by Aaron Bentley
Refactored _add_tree_children
646
                continue
1534.7.181 by Aaron Bentley
Renamed a bunch of functions
647
            yield self.trans_id_tree_path(childpath)
1534.7.32 by Aaron Bentley
Got conflict handling working when conflicts involve existing files
648
1534.10.28 by Aaron Bentley
Use numbered backup files
649
    def has_named_child(self, by_parent, parent_id, name):
650
        try:
651
            children = by_parent[parent_id]
652
        except KeyError:
653
            children = []
654
        for child in children:
655
            if self.final_name(child) == name:
656
                return True
657
        try:
658
            path = self._tree_id_paths[parent_id]
659
        except KeyError:
660
            return False
661
        childpath = joinpath(path, name)
662
        child_id = self._tree_path_ids.get(childpath)
663
        if child_id is None:
664
            return lexists(self._tree.abspath(childpath))
665
        else:
1773.4.1 by Martin Pool
Add pyflakes makefile target; fix many warnings
666
            if self.final_parent(child_id) != parent_id:
1534.10.28 by Aaron Bentley
Use numbered backup files
667
                return False
1773.4.1 by Martin Pool
Add pyflakes makefile target; fix many warnings
668
            if child_id in self._removed_contents:
1534.10.28 by Aaron Bentley
Use numbered backup files
669
                # XXX What about dangling file-ids?
670
                return False
671
            else:
672
                return True
673
1534.7.19 by Aaron Bentley
Added tests for parent loops
674
    def _parent_loops(self):
675
        """No entry should be its own ancestor"""
676
        conflicts = []
677
        for trans_id in self._new_parent:
678
            seen = set()
679
            parent_id = trans_id
1534.7.31 by Aaron Bentley
Changed tree root parent to ROOT_PARENT
680
            while parent_id is not ROOT_PARENT:
1534.7.19 by Aaron Bentley
Added tests for parent loops
681
                seen.add(parent_id)
1731.1.33 by Aaron Bentley
Revert no-special-root changes
682
                try:
683
                    parent_id = self.final_parent(parent_id)
684
                except KeyError:
685
                    break
1534.7.19 by Aaron Bentley
Added tests for parent loops
686
                if parent_id == trans_id:
687
                    conflicts.append(('parent loop', trans_id))
688
                if parent_id in seen:
689
                    break
690
        return conflicts
691
1534.7.15 by Aaron Bentley
Add conflict types related to versioning
692
    def _unversioned_parents(self, by_parent):
693
        """If parent directories are versioned, children must be versioned."""
694
        conflicts = []
695
        for parent_id, children in by_parent.iteritems():
1534.7.32 by Aaron Bentley
Got conflict handling working when conflicts involve existing files
696
            if parent_id is ROOT_PARENT:
697
                continue
1534.7.15 by Aaron Bentley
Add conflict types related to versioning
698
            if self.final_file_id(parent_id) is not None:
699
                continue
700
            for child_id in children:
701
                if self.final_file_id(child_id) is not None:
702
                    conflicts.append(('unversioned parent', parent_id))
703
                    break;
704
        return conflicts
705
706
    def _improper_versioning(self):
1534.7.156 by Aaron Bentley
PEP8 fixes
707
        """Cannot version a file with no contents, or a bad type.
1534.7.15 by Aaron Bentley
Add conflict types related to versioning
708
        
709
        However, existing entries with no contents are okay.
710
        """
711
        conflicts = []
712
        for trans_id in self._new_id.iterkeys():
713
            try:
714
                kind = self.final_kind(trans_id)
715
            except NoSuchFile:
716
                conflicts.append(('versioning no contents', trans_id))
717
                continue
718
            if not InventoryEntry.versionable_kind(kind):
1534.7.20 by Aaron Bentley
Added directory handling
719
                conflicts.append(('versioning bad kind', trans_id, kind))
1534.7.11 by Aaron Bentley
Refactored conflict handling
720
        return conflicts
721
1534.7.26 by Aaron Bentley
Added conflicts for setting executability on unversioned/non-file entries
722
    def _executability_conflicts(self):
1534.7.40 by Aaron Bentley
Updated docs
723
        """Check for bad executability changes.
724
        
725
        Only versioned files may have their executability set, because
726
        1. only versioned entries can have executability under windows
727
        2. only files can be executable.  (The execute bit on a directory
728
           does not indicate searchability)
729
        """
1534.7.26 by Aaron Bentley
Added conflicts for setting executability on unversioned/non-file entries
730
        conflicts = []
731
        for trans_id in self._new_executability:
732
            if self.final_file_id(trans_id) is None:
733
                conflicts.append(('unversioned executability', trans_id))
1534.7.34 by Aaron Bentley
Proper conflicts for removals
734
            else:
735
                try:
736
                    non_file = self.final_kind(trans_id) != "file"
737
                except NoSuchFile:
738
                    non_file = True
739
                if non_file is True:
740
                    conflicts.append(('non-file executability', trans_id))
1534.7.26 by Aaron Bentley
Added conflicts for setting executability on unversioned/non-file entries
741
        return conflicts
742
1534.7.152 by Aaron Bentley
Fixed overwrites
743
    def _overwrite_conflicts(self):
744
        """Check for overwrites (not permitted on Win32)"""
745
        conflicts = []
746
        for trans_id in self._new_contents:
747
            try:
748
                self.tree_kind(trans_id)
749
            except NoSuchFile:
750
                continue
751
            if trans_id not in self._removed_contents:
752
                conflicts.append(('overwrite', trans_id,
753
                                 self.final_name(trans_id)))
754
        return conflicts
755
1534.7.11 by Aaron Bentley
Refactored conflict handling
756
    def _duplicate_entries(self, by_parent):
757
        """No directory may have two entries with the same name."""
758
        conflicts = []
2590.2.16 by Aaron Bentley
Shortcut duplicate_entries conflict check if no new names introduced
759
        if (self._new_name, self._new_parent) == ({}, {}):
760
            return conflicts
1534.7.6 by Aaron Bentley
Added conflict handling
761
        for children in by_parent.itervalues():
1534.7.32 by Aaron Bentley
Got conflict handling working when conflicts involve existing files
762
            name_ids = [(self.final_name(t), t) for t in children]
3008.1.15 by Aaron Bentley
Make case_sensitive an aspect of the transform, not the source tree
763
            if not self._case_sensitive_target:
3034.4.1 by Aaron Bentley
Start handling case-insensitivity
764
                name_ids = [(n.lower(), t) for n, t in name_ids]
1534.7.6 by Aaron Bentley
Added conflict handling
765
            name_ids.sort()
766
            last_name = None
767
            last_trans_id = None
768
            for name, trans_id in name_ids:
1966.1.1 by Aaron Bentley
Implement disk-content merge and conflict resolution for build_tree
769
                try:
770
                    kind = self.final_kind(trans_id)
771
                except NoSuchFile:
772
                    kind = None
773
                file_id = self.final_file_id(trans_id)
774
                if kind is None and file_id is None:
775
                    continue
1534.7.6 by Aaron Bentley
Added conflict handling
776
                if name == last_name:
1534.7.32 by Aaron Bentley
Got conflict handling working when conflicts involve existing files
777
                    conflicts.append(('duplicate', last_trans_id, trans_id,
778
                    name))
1966.1.1 by Aaron Bentley
Implement disk-content merge and conflict resolution for build_tree
779
                last_name = name
780
                last_trans_id = trans_id
1534.7.11 by Aaron Bentley
Refactored conflict handling
781
        return conflicts
782
1534.7.50 by Aaron Bentley
Detect duplicate inventory ids
783
    def _duplicate_ids(self):
784
        """Each inventory id may only be used once"""
785
        conflicts = []
1534.7.181 by Aaron Bentley
Renamed a bunch of functions
786
        removed_tree_ids = set((self.tree_file_id(trans_id) for trans_id in
1534.7.50 by Aaron Bentley
Detect duplicate inventory ids
787
                                self._removed_id))
3146.8.16 by Aaron Bentley
Updates from review
788
        all_ids = self._tree.all_file_ids()
789
        active_tree_ids = all_ids.difference(removed_tree_ids)
1534.7.50 by Aaron Bentley
Detect duplicate inventory ids
790
        for trans_id, file_id in self._new_id.iteritems():
791
            if file_id in active_tree_ids:
1534.7.181 by Aaron Bentley
Renamed a bunch of functions
792
                old_trans_id = self.trans_id_tree_file_id(file_id)
1534.7.50 by Aaron Bentley
Detect duplicate inventory ids
793
                conflicts.append(('duplicate id', old_trans_id, trans_id))
794
        return conflicts
795
1534.7.11 by Aaron Bentley
Refactored conflict handling
796
    def _parent_type_conflicts(self, by_parent):
797
        """parents must have directory 'contents'."""
798
        conflicts = []
1534.7.37 by Aaron Bentley
Allowed removed dirs to have content-free children.
799
        for parent_id, children in by_parent.iteritems():
1534.7.32 by Aaron Bentley
Got conflict handling working when conflicts involve existing files
800
            if parent_id is ROOT_PARENT:
801
                continue
1534.7.37 by Aaron Bentley
Allowed removed dirs to have content-free children.
802
            if not self._any_contents(children):
803
                continue
804
            for child in children:
805
                try:
806
                    self.final_kind(child)
807
                except NoSuchFile:
808
                    continue
1534.7.10 by Aaron Bentley
Implemented missing parent and non-directory parent conflicts
809
            try:
810
                kind = self.final_kind(parent_id)
811
            except NoSuchFile:
812
                kind = None
813
            if kind is None:
814
                conflicts.append(('missing parent', parent_id))
815
            elif kind != "directory":
816
                conflicts.append(('non-directory parent', parent_id))
1534.7.6 by Aaron Bentley
Added conflict handling
817
        return conflicts
1534.7.37 by Aaron Bentley
Allowed removed dirs to have content-free children.
818
819
    def _any_contents(self, trans_ids):
820
        """Return true if any of the trans_ids, will have contents."""
821
        for trans_id in trans_ids:
822
            try:
823
                kind = self.final_kind(trans_id)
824
            except NoSuchFile:
825
                continue
826
            return True
827
        return False
1534.7.35 by Aaron Bentley
Got file renaming working
828
2502.1.14 by Aaron Bentley
Style update suggested by Robert
829
    def _limbo_name(self, trans_id):
1534.7.72 by Aaron Bentley
Moved new content generation to pre-renames
830
        """Generate the limbo name of a file"""
2502.1.14 by Aaron Bentley
Style update suggested by Robert
831
        limbo_name = self._limbo_files.get(trans_id)
832
        if limbo_name is not None:
833
            return limbo_name
2502.1.3 by Aaron Bentley
Don't cause errors when creating contents for trans_ids with no parent/name
834
        parent = self._new_parent.get(trans_id)
2502.1.2 by Aaron Bentley
Make the limited-renames functionality safer in the general case
835
        # if the parent directory is already in limbo (e.g. when building a
836
        # tree), choose a limbo name inside the parent, to reduce further
837
        # renames.
2502.1.4 by Aaron Bentley
Ensure we only reuse limbo names appropriately
838
        use_direct_path = False
839
        if self._new_contents.get(parent) == 'directory':
840
            filename = self._new_name.get(trans_id)
841
            if filename is not None:
842
                if parent not in self._limbo_children:
843
                    self._limbo_children[parent] = set()
844
                    self._limbo_children_names[parent] = {}
845
                    use_direct_path = True
2502.1.6 by Aaron Bentley
Update from review comments
846
                # the direct path can only be used if no other file has
847
                # already taken this pathname, i.e. if the name is unused, or
848
                # if it is already associated with this trans_id.
3008.1.15 by Aaron Bentley
Make case_sensitive an aspect of the transform, not the source tree
849
                elif self._case_sensitive_target:
3034.4.1 by Aaron Bentley
Start handling case-insensitivity
850
                    if (self._limbo_children_names[parent].get(filename)
851
                        in (trans_id, None)):
852
                        use_direct_path = True
853
                else:
854
                    for l_filename, l_trans_id in\
855
                        self._limbo_children_names[parent].iteritems():
856
                        if l_trans_id == trans_id:
857
                            continue
858
                        if l_filename.lower() == filename.lower():
859
                            break
860
                    else:
861
                        use_direct_path = True
862
2502.1.4 by Aaron Bentley
Ensure we only reuse limbo names appropriately
863
        if use_direct_path:
864
            limbo_name = pathjoin(self._limbo_files[parent], filename)
2502.1.2 by Aaron Bentley
Make the limited-renames functionality safer in the general case
865
            self._limbo_children[parent].add(trans_id)
2502.1.4 by Aaron Bentley
Ensure we only reuse limbo names appropriately
866
            self._limbo_children_names[parent][filename] = trans_id
2502.1.1 by Aaron Bentley
Ensure renames only root children are renamed when building trees
867
        else:
868
            limbo_name = pathjoin(self._limbodir, trans_id)
869
            self._needs_rename.add(trans_id)
870
        self._limbo_files[trans_id] = limbo_name
871
        return limbo_name
1534.7.72 by Aaron Bentley
Moved new content generation to pre-renames
872
2376.2.4 by Aaron Bentley
Switch TreeTransform to use WT.apply_inventory_delta
873
    def _set_executability(self, path, entry, trans_id):
1534.7.40 by Aaron Bentley
Updated docs
874
        """Set the executability of versioned files """
1534.7.25 by Aaron Bentley
Added set_executability
875
        new_executability = self._new_executability[trans_id]
3453.2.3 by Aaron Bentley
Enable using a precomputed inventory delta for build_tree.
876
        if entry is not None:
877
            entry.executable = new_executability
1534.7.25 by Aaron Bentley
Added set_executability
878
        if supports_executable():
879
            abspath = self._tree.abspath(path)
880
            current_mode = os.stat(abspath).st_mode
881
            if new_executability:
882
                umask = os.umask(0)
883
                os.umask(umask)
884
                to_mode = current_mode | (0100 & ~umask)
885
                # Enable x-bit for others only if they can read it.
886
                if current_mode & 0004:
887
                    to_mode |= 0001 & ~umask
888
                if current_mode & 0040:
889
                    to_mode |= 0010 & ~umask
890
            else:
891
                to_mode = current_mode & ~0111
892
            os.chmod(abspath, to_mode)
893
1534.7.23 by Aaron Bentley
Transform.new_entry -> Transform._new_entry
894
    def _new_entry(self, name, parent_id, file_id):
1534.7.21 by Aaron Bentley
Updated docstrings
895
        """Helper function to create a new filesystem entry."""
1534.7.2 by Aaron Bentley
Added convenience function
896
        trans_id = self.create_path(name, parent_id)
897
        if file_id is not None:
898
            self.version_file(file_id, trans_id)
899
        return trans_id
900
1534.7.27 by Aaron Bentley
Added execute bit to new_file method
901
    def new_file(self, name, parent_id, contents, file_id=None, 
902
                 executable=None):
1534.7.156 by Aaron Bentley
PEP8 fixes
903
        """Convenience method to create files.
1534.7.21 by Aaron Bentley
Updated docstrings
904
        
905
        name is the name of the file to create.
906
        parent_id is the transaction id of the parent directory of the file.
907
        contents is an iterator of bytestrings, which will be used to produce
908
        the file.
1740.2.4 by Aaron Bentley
Update transform tests and docs
909
        :param file_id: The inventory ID of the file, if it is to be versioned.
910
        :param executable: Only valid when a file_id has been supplied.
1534.7.21 by Aaron Bentley
Updated docstrings
911
        """
1534.7.23 by Aaron Bentley
Transform.new_entry -> Transform._new_entry
912
        trans_id = self._new_entry(name, parent_id, file_id)
1740.2.4 by Aaron Bentley
Update transform tests and docs
913
        # TODO: rather than scheduling a set_executable call,
914
        # have create_file create the file with the right mode.
1534.7.20 by Aaron Bentley
Added directory handling
915
        self.create_file(contents, trans_id)
1534.7.27 by Aaron Bentley
Added execute bit to new_file method
916
        if executable is not None:
917
            self.set_executability(executable, trans_id)
1534.7.20 by Aaron Bentley
Added directory handling
918
        return trans_id
919
920
    def new_directory(self, name, parent_id, file_id=None):
1534.7.156 by Aaron Bentley
PEP8 fixes
921
        """Convenience method to create directories.
1534.7.21 by Aaron Bentley
Updated docstrings
922
923
        name is the name of the directory to create.
924
        parent_id is the transaction id of the parent directory of the
925
        directory.
926
        file_id is the inventory ID of the directory, if it is to be versioned.
927
        """
1534.7.23 by Aaron Bentley
Transform.new_entry -> Transform._new_entry
928
        trans_id = self._new_entry(name, parent_id, file_id)
1534.7.20 by Aaron Bentley
Added directory handling
929
        self.create_directory(trans_id)
930
        return trans_id 
931
1534.7.22 by Aaron Bentley
Added symlink support
932
    def new_symlink(self, name, parent_id, target, file_id=None):
1534.7.156 by Aaron Bentley
PEP8 fixes
933
        """Convenience method to create symbolic link.
1534.7.22 by Aaron Bentley
Added symlink support
934
        
935
        name is the name of the symlink to create.
936
        parent_id is the transaction id of the parent directory of the symlink.
937
        target is a bytestring of the target of the symlink.
938
        file_id is the inventory ID of the file, if it is to be versioned.
939
        """
1534.7.23 by Aaron Bentley
Transform.new_entry -> Transform._new_entry
940
        trans_id = self._new_entry(name, parent_id, file_id)
1534.7.22 by Aaron Bentley
Added symlink support
941
        self.create_symlink(target, trans_id)
942
        return trans_id
943
1551.11.12 by Aaron Bentley
Changes from review
944
    def _affected_ids(self):
945
        """Return the set of transform ids affected by the transform"""
1551.11.1 by Aaron Bentley
Initial work on converting TreeTransform to iter_changes format
946
        trans_ids = set(self._removed_id)
947
        trans_ids.update(self._new_id.keys())
1551.11.2 by Aaron Bentley
Get kind change detection working for iter_changes
948
        trans_ids.update(self._removed_contents)
949
        trans_ids.update(self._new_contents.keys())
950
        trans_ids.update(self._new_executability.keys())
951
        trans_ids.update(self._new_name.keys())
952
        trans_ids.update(self._new_parent.keys())
1551.11.12 by Aaron Bentley
Changes from review
953
        return trans_ids
954
955
    def _get_file_id_maps(self):
956
        """Return mapping of file_ids to trans_ids in the to and from states"""
957
        trans_ids = self._affected_ids()
1551.11.1 by Aaron Bentley
Initial work on converting TreeTransform to iter_changes format
958
        from_trans_ids = {}
959
        to_trans_ids = {}
960
        # Build up two dicts: trans_ids associated with file ids in the
961
        # FROM state, vs the TO state.
962
        for trans_id in trans_ids:
963
            from_file_id = self.tree_file_id(trans_id)
964
            if from_file_id is not None:
965
                from_trans_ids[from_file_id] = trans_id
966
            to_file_id = self.final_file_id(trans_id)
967
            if to_file_id is not None:
968
                to_trans_ids[to_file_id] = trans_id
1551.11.12 by Aaron Bentley
Changes from review
969
        return from_trans_ids, to_trans_ids
970
971
    def _from_file_data(self, from_trans_id, from_versioned, file_id):
972
        """Get data about a file in the from (tree) state
973
974
        Return a (name, parent, kind, executable) tuple
975
        """
976
        from_path = self._tree_id_paths.get(from_trans_id)
977
        if from_versioned:
978
            # get data from working tree if versioned
979
            from_entry = self._tree.inventory[file_id]
980
            from_name = from_entry.name
981
            from_parent = from_entry.parent_id
982
        else:
983
            from_entry = None
984
            if from_path is None:
985
                # File does not exist in FROM state
986
                from_name = None
987
                from_parent = None
988
            else:
989
                # File exists, but is not versioned.  Have to use path-
990
                # splitting stuff
991
                from_name = os.path.basename(from_path)
992
                tree_parent = self.get_tree_parent(from_trans_id)
993
                from_parent = self.tree_file_id(tree_parent)
994
        if from_path is not None:
995
            from_kind, from_executable, from_stats = \
996
                self._tree._comparison_data(from_entry, from_path)
997
        else:
998
            from_kind = None
999
            from_executable = False
1000
        return from_name, from_parent, from_kind, from_executable
1001
1002
    def _to_file_data(self, to_trans_id, from_trans_id, from_executable):
1003
        """Get data about a file in the to (target) state
1004
1005
        Return a (name, parent, kind, executable) tuple
1006
        """
1007
        to_name = self.final_name(to_trans_id)
1008
        try:
1009
            to_kind = self.final_kind(to_trans_id)
1010
        except NoSuchFile:
1011
            to_kind = None
1012
        to_parent = self.final_file_id(self.final_parent(to_trans_id))
1013
        if to_trans_id in self._new_executability:
1014
            to_executable = self._new_executability[to_trans_id]
1015
        elif to_trans_id == from_trans_id:
1016
            to_executable = from_executable
1017
        else:
1018
            to_executable = False
1019
        return to_name, to_parent, to_kind, to_executable
1020
3254.1.1 by Aaron Bentley
Make Tree.iter_changes a public method
1021
    def iter_changes(self):
1022
        """Produce output in the same format as Tree.iter_changes.
1551.11.12 by Aaron Bentley
Changes from review
1023
1024
        Will produce nonsensical results if invoked while inventory/filesystem
1025
        conflicts (as reported by TreeTransform.find_conflicts()) are present.
1026
1027
        This reads the Transform, but only reproduces changes involving a
1028
        file_id.  Files that are not versioned in either of the FROM or TO
1029
        states are not reflected.
1030
        """
1031
        final_paths = FinalPaths(self)
1032
        from_trans_ids, to_trans_ids = self._get_file_id_maps()
1551.11.4 by Aaron Bentley
Sort output of Transform.iter_changes by path
1033
        results = []
1551.11.1 by Aaron Bentley
Initial work on converting TreeTransform to iter_changes format
1034
        # Now iterate through all active file_ids
1035
        for file_id in set(from_trans_ids.keys() + to_trans_ids.keys()):
1551.11.7 by Aaron Bentley
Stop modified flag bleeding into later changes
1036
            modified = False
1551.11.1 by Aaron Bentley
Initial work on converting TreeTransform to iter_changes format
1037
            from_trans_id = from_trans_ids.get(file_id)
1038
            # find file ids, and determine versioning state
1039
            if from_trans_id is None:
1040
                from_versioned = False
1041
                from_trans_id = to_trans_ids[file_id]
1042
            else:
1043
                from_versioned = True
1044
            to_trans_id = to_trans_ids.get(file_id)
1045
            if to_trans_id is None:
1046
                to_versioned = False
1047
                to_trans_id = from_trans_id
1048
            else:
1049
                to_versioned = True
1551.11.12 by Aaron Bentley
Changes from review
1050
1051
            from_name, from_parent, from_kind, from_executable = \
1052
                self._from_file_data(from_trans_id, from_versioned, file_id)
1053
1054
            to_name, to_parent, to_kind, to_executable = \
1055
                self._to_file_data(to_trans_id, from_trans_id, from_executable)
1056
2255.7.96 by Robert Collins
Change _iter_changes interface to yield both old and new paths.
1057
            if not from_versioned:
1058
                from_path = None
1059
            else:
1060
                from_path = self._tree_id_paths.get(from_trans_id)
1061
            if not to_versioned:
1062
                to_path = None
1063
            else:
1064
                to_path = final_paths.get_path(to_trans_id)
1551.11.1 by Aaron Bentley
Initial work on converting TreeTransform to iter_changes format
1065
            if from_kind != to_kind:
1066
                modified = True
1551.10.37 by Aaron Bentley
recommit of TreeTransform._iter_changes fix with missing files
1067
            elif to_kind in ('file', 'symlink') and (
1551.11.2 by Aaron Bentley
Get kind change detection working for iter_changes
1068
                to_trans_id != from_trans_id or
1069
                to_trans_id in self._new_contents):
1070
                modified = True
1071
            if (not modified and from_versioned == to_versioned and
1072
                from_parent==to_parent and from_name == to_name and
1073
                from_executable == to_executable):
1074
                continue
2255.7.96 by Robert Collins
Change _iter_changes interface to yield both old and new paths.
1075
            results.append((file_id, (from_path, to_path), modified,
1551.11.1 by Aaron Bentley
Initial work on converting TreeTransform to iter_changes format
1076
                   (from_versioned, to_versioned),
1551.11.2 by Aaron Bentley
Get kind change detection working for iter_changes
1077
                   (from_parent, to_parent),
1551.11.1 by Aaron Bentley
Initial work on converting TreeTransform to iter_changes format
1078
                   (from_name, to_name),
1079
                   (from_kind, to_kind),
1551.11.4 by Aaron Bentley
Sort output of Transform.iter_changes by path
1080
                   (from_executable, to_executable)))
1081
        return iter(sorted(results, key=lambda x:x[1]))
1551.11.1 by Aaron Bentley
Initial work on converting TreeTransform to iter_changes format
1082
3008.1.7 by Michael Hudson
move apply and helpers to TreeTransform from TreeTransformBase
1083
    def get_preview_tree(self):
3008.1.17 by Aaron Bentley
Test unused parameters of preview_tree._iter_changes
1084
        """Return a tree representing the result of the transform.
1085
1086
        This tree only supports the subset of Tree functionality required
1087
        by show_diff_trees.  It must only be compared to tt._tree.
1088
        """
1089
        return _PreviewTree(self)
1090
1551.11.1 by Aaron Bentley
Initial work on converting TreeTransform to iter_changes format
1091
3008.1.1 by Aaron Bentley
Start work allowing previews of transforms
1092
class TreeTransform(TreeTransformBase):
1093
    """Represent a tree transformation.
3008.1.19 by Aaron Bentley
Remove trailing whitespace
1094
3008.1.1 by Aaron Bentley
Start work allowing previews of transforms
1095
    This object is designed to support incremental generation of the transform,
1096
    in any order.
1097
1098
    However, it gives optimum performance when parent directories are created
1099
    before their contents.  The transform is then able to put child files
1100
    directly in their parent directory, avoiding later renames.
3008.1.19 by Aaron Bentley
Remove trailing whitespace
1101
3008.1.1 by Aaron Bentley
Start work allowing previews of transforms
1102
    It is easy to produce malformed transforms, but they are generally
1103
    harmless.  Attempting to apply a malformed transform will cause an
3008.1.19 by Aaron Bentley
Remove trailing whitespace
1104
    exception to be raised before any modifications are made to the tree.
3008.1.1 by Aaron Bentley
Start work allowing previews of transforms
1105
3008.1.19 by Aaron Bentley
Remove trailing whitespace
1106
    Many kinds of malformed transforms can be corrected with the
3008.1.1 by Aaron Bentley
Start work allowing previews of transforms
1107
    resolve_conflicts function.  The remaining ones indicate programming error,
1108
    such as trying to create a file with no path.
1109
1110
    Two sets of file creation methods are supplied.  Convenience methods are:
1111
     * new_file
1112
     * new_directory
1113
     * new_symlink
1114
1115
    These are composed of the low-level methods:
1116
     * create_path
1117
     * create_file or create_directory or create_symlink
1118
     * version_file
1119
     * set_executability
3008.1.13 by Michael Hudson
merge bzr.dev
1120
1121
    Transform/Transaction ids
1122
    -------------------------
1123
    trans_ids are temporary ids assigned to all files involved in a transform.
1124
    It's possible, even common, that not all files in the Tree have trans_ids.
1125
1126
    trans_ids are used because filenames and file_ids are not good enough
1127
    identifiers; filenames change, and not all files have file_ids.  File-ids
1128
    are also associated with trans-ids, so that moving a file moves its
1129
    file-id.
1130
1131
    trans_ids are only valid for the TreeTransform that generated them.
1132
1133
    Limbo
1134
    -----
1135
    Limbo is a temporary directory use to hold new versions of files.
1136
    Files are added to limbo by create_file, create_directory, create_symlink,
1137
    and their convenience variants (new_*).  Files may be removed from limbo
1138
    using cancel_creation.  Files are renamed from limbo into their final
1139
    location as part of TreeTransform.apply
1140
1141
    Limbo must be cleaned up, by either calling TreeTransform.apply or
1142
    calling TreeTransform.finalize.
1143
1144
    Files are placed into limbo inside their parent directories, where
1145
    possible.  This reduces subsequent renames, and makes operations involving
1146
    lots of files faster.  This optimization is only possible if the parent
1147
    directory is created *before* creating any of its children, so avoid
1148
    creating children before parents, where possible.
1149
1150
    Pending-deletion
1151
    ----------------
1152
    This temporary directory is used by _FileMover for storing files that are
1153
    about to be deleted.  In case of rollback, the files will be restored.
1154
    FileMover does not delete files until it is sure that a rollback will not
3008.1.19 by Aaron Bentley
Remove trailing whitespace
1155
    happen.
3008.1.1 by Aaron Bentley
Start work allowing previews of transforms
1156
    """
1157
    def __init__(self, tree, pb=DummyProgress()):
1158
        """Note: a tree_write lock is taken on the tree.
1159
1160
        Use TreeTransform.finalize() to release the lock (can be omitted if
1161
        TreeTransform.apply() called).
1162
        """
1163
        tree.lock_tree_write()
3008.1.13 by Michael Hudson
merge bzr.dev
1164
3008.1.1 by Aaron Bentley
Start work allowing previews of transforms
1165
        try:
1166
            limbodir = urlutils.local_path_from_url(
3407.2.8 by Martin Pool
Deprecate LockableFiles.controlfilename
1167
                tree._transport.abspath('limbo'))
3008.1.1 by Aaron Bentley
Start work allowing previews of transforms
1168
            try:
1169
                os.mkdir(limbodir)
1170
            except OSError, e:
1171
                if e.errno == errno.EEXIST:
1172
                    raise ExistingLimbo(limbodir)
3199.1.5 by Vincent Ladeuil
Fix two more leaking tmp dirs, by reworking TransformPreview lock handling.
1173
            deletiondir = urlutils.local_path_from_url(
3407.2.8 by Martin Pool
Deprecate LockableFiles.controlfilename
1174
                tree._transport.abspath('pending-deletion'))
3008.1.1 by Aaron Bentley
Start work allowing previews of transforms
1175
            try:
3199.1.5 by Vincent Ladeuil
Fix two more leaking tmp dirs, by reworking TransformPreview lock handling.
1176
                os.mkdir(deletiondir)
3008.1.1 by Aaron Bentley
Start work allowing previews of transforms
1177
            except OSError, e:
1178
                if e.errno == errno.EEXIST:
3199.1.5 by Vincent Ladeuil
Fix two more leaking tmp dirs, by reworking TransformPreview lock handling.
1179
                    raise errors.ExistingPendingDeletion(deletiondir)
3008.1.1 by Aaron Bentley
Start work allowing previews of transforms
1180
        except:
1181
            tree.unlock()
1182
            raise
3008.1.13 by Michael Hudson
merge bzr.dev
1183
3008.1.15 by Aaron Bentley
Make case_sensitive an aspect of the transform, not the source tree
1184
        TreeTransformBase.__init__(self, tree, limbodir, pb,
1185
                                   tree.case_sensitive)
3199.1.5 by Vincent Ladeuil
Fix two more leaking tmp dirs, by reworking TransformPreview lock handling.
1186
        self._deletiondir = deletiondir
3008.1.1 by Aaron Bentley
Start work allowing previews of transforms
1187
3453.2.3 by Aaron Bentley
Enable using a precomputed inventory delta for build_tree.
1188
    def apply(self, no_conflicts=False, precomputed_delta=None, _mover=None):
3008.1.7 by Michael Hudson
move apply and helpers to TreeTransform from TreeTransformBase
1189
        """Apply all changes to the inventory and filesystem.
3008.1.19 by Aaron Bentley
Remove trailing whitespace
1190
3008.1.7 by Michael Hudson
move apply and helpers to TreeTransform from TreeTransformBase
1191
        If filesystem or inventory conflicts are present, MalformedTransform
1192
        will be thrown.
1193
1194
        If apply succeeds, finalize is not necessary.
1195
1196
        :param no_conflicts: if True, the caller guarantees there are no
1197
            conflicts, so no check is made.
3453.2.11 by Aaron Bentley
Updates from review
1198
        :param precomputed_delta: An inventory delta to use instead of
1199
            calculating one.
3008.1.7 by Michael Hudson
move apply and helpers to TreeTransform from TreeTransformBase
1200
        :param _mover: Supply an alternate FileMover, for testing
1201
        """
1202
        if not no_conflicts:
1203
            conflicts = self.find_conflicts()
1204
            if len(conflicts) != 0:
1205
                raise MalformedTransform(conflicts=conflicts)
3453.2.3 by Aaron Bentley
Enable using a precomputed inventory delta for build_tree.
1206
        if precomputed_delta is None:
1207
            new_inventory_delta = []
1208
            inventory_delta = new_inventory_delta
1209
        else:
1210
            new_inventory_delta = None
1211
            inventory_delta = precomputed_delta
3008.1.7 by Michael Hudson
move apply and helpers to TreeTransform from TreeTransformBase
1212
        child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1213
        try:
1214
            if _mover is None:
1215
                mover = _FileMover()
1216
            else:
1217
                mover = _mover
1218
            try:
1219
                child_pb.update('Apply phase', 0, 2)
3453.2.3 by Aaron Bentley
Enable using a precomputed inventory delta for build_tree.
1220
                self._apply_removals(new_inventory_delta, mover)
3008.1.7 by Michael Hudson
move apply and helpers to TreeTransform from TreeTransformBase
1221
                child_pb.update('Apply phase', 1, 2)
3453.2.3 by Aaron Bentley
Enable using a precomputed inventory delta for build_tree.
1222
                modified_paths = self._apply_insertions(new_inventory_delta,
1223
                                                        mover)
3008.1.7 by Michael Hudson
move apply and helpers to TreeTransform from TreeTransformBase
1224
            except:
1225
                mover.rollback()
1226
                raise
1227
            else:
1228
                mover.apply_deletions()
1229
        finally:
1230
            child_pb.finished()
1231
        self._tree.apply_inventory_delta(inventory_delta)
3008.1.29 by Aaron Bentley
Add docstrings, rename TT.__doc
1232
        self._done = True
3008.1.7 by Michael Hudson
move apply and helpers to TreeTransform from TreeTransformBase
1233
        self.finalize()
1234
        return _TransformResults(modified_paths, self.rename_count)
1235
3146.8.18 by Aaron Bentley
Merge with dev
1236
    def _apply_removals(self, inventory_delta, mover):
3008.1.7 by Michael Hudson
move apply and helpers to TreeTransform from TreeTransformBase
1237
        """Perform tree operations that remove directory/inventory names.
3008.1.19 by Aaron Bentley
Remove trailing whitespace
1238
3008.1.7 by Michael Hudson
move apply and helpers to TreeTransform from TreeTransformBase
1239
        That is, delete files that are to be deleted, and put any files that
1240
        need renaming into limbo.  This must be done in strict child-to-parent
1241
        order.
3453.2.11 by Aaron Bentley
Updates from review
1242
1243
        If inventory_delta is None, no inventory delta generation is performed.
3008.1.7 by Michael Hudson
move apply and helpers to TreeTransform from TreeTransformBase
1244
        """
1245
        tree_paths = list(self._tree_path_ids.iteritems())
1246
        tree_paths.sort(reverse=True)
1247
        child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1248
        try:
1249
            for num, data in enumerate(tree_paths):
1250
                path, trans_id = data
1251
                child_pb.update('removing file', num, len(tree_paths))
1252
                full_path = self._tree.abspath(path)
1253
                if trans_id in self._removed_contents:
1254
                    mover.pre_delete(full_path, os.path.join(self._deletiondir,
1255
                                     trans_id))
1256
                elif trans_id in self._new_name or trans_id in \
1257
                    self._new_parent:
1258
                    try:
1259
                        mover.rename(full_path, self._limbo_name(trans_id))
1260
                    except OSError, e:
1261
                        if e.errno != errno.ENOENT:
1262
                            raise
1263
                    else:
1264
                        self.rename_count += 1
3453.2.11 by Aaron Bentley
Updates from review
1265
                if (trans_id in self._removed_id
1266
                    and inventory_delta is not None):
3008.1.7 by Michael Hudson
move apply and helpers to TreeTransform from TreeTransformBase
1267
                    if trans_id == self._new_root:
1268
                        file_id = self._tree.get_root_id()
1269
                    else:
1270
                        file_id = self.tree_file_id(trans_id)
3146.8.18 by Aaron Bentley
Merge with dev
1271
                    # File-id isn't really being deleted, just moved
1272
                    if file_id in self._r_new_id:
1273
                        continue
3453.2.11 by Aaron Bentley
Updates from review
1274
                    inventory_delta.append((path, None, file_id, None))
3008.1.7 by Michael Hudson
move apply and helpers to TreeTransform from TreeTransformBase
1275
        finally:
1276
            child_pb.finished()
1277
3146.8.18 by Aaron Bentley
Merge with dev
1278
    def _apply_insertions(self, inventory_delta, mover):
3008.1.7 by Michael Hudson
move apply and helpers to TreeTransform from TreeTransformBase
1279
        """Perform tree operations that insert directory/inventory names.
3008.1.19 by Aaron Bentley
Remove trailing whitespace
1280
3008.1.7 by Michael Hudson
move apply and helpers to TreeTransform from TreeTransformBase
1281
        That is, create any files that need to be created, and restore from
1282
        limbo any files that needed renaming.  This must be done in strict
1283
        parent-to-child order.
3453.2.3 by Aaron Bentley
Enable using a precomputed inventory delta for build_tree.
1284
1285
        If inventory_delta is None, no inventory delta is calculated, and
1286
        no list of modified paths is returned.
3008.1.7 by Michael Hudson
move apply and helpers to TreeTransform from TreeTransformBase
1287
        """
3453.2.3 by Aaron Bentley
Enable using a precomputed inventory delta for build_tree.
1288
        new_paths = self.new_paths(filesystem_only=(inventory_delta is None))
3008.1.7 by Michael Hudson
move apply and helpers to TreeTransform from TreeTransformBase
1289
        modified_paths = []
3008.1.16 by Aaron Bentley
Merge with bzr.dev
1290
        completed_new = []
3453.2.2 by Aaron Bentley
Avoid unnecessary file_id lookups
1291
        new_path_file_ids = dict((t, self.final_file_id(t)) for p, t in
1292
                                 new_paths)
3453.2.11 by Aaron Bentley
Updates from review
1293
        if inventory_delta is not None:
1294
            entries = self._tree.iter_entries_by_dir(
1295
                new_path_file_ids.values())
1296
            old_paths = dict((e.file_id, p) for p, e in entries)
3453.2.1 by Aaron Bentley
Speed up apply_insertions using iter_entries_by_dir instead of id2path
1297
        child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
3008.1.7 by Michael Hudson
move apply and helpers to TreeTransform from TreeTransformBase
1298
        try:
1299
            for num, (path, trans_id) in enumerate(new_paths):
1300
                new_entry = None
3453.2.1 by Aaron Bentley
Speed up apply_insertions using iter_entries_by_dir instead of id2path
1301
                if (num % 10) == 0:
1302
                    child_pb.update('adding file', num, len(new_paths))
3453.2.3 by Aaron Bentley
Enable using a precomputed inventory delta for build_tree.
1303
                full_path = self._tree.abspath(path)
1304
                if trans_id in self._needs_rename:
1305
                    try:
1306
                        mover.rename(self._limbo_name(trans_id), full_path)
1307
                    except OSError, e:
1308
                        # We may be renaming a dangling inventory id
1309
                        if e.errno != errno.ENOENT:
1310
                            raise
1311
                    else:
1312
                        self.rename_count += 1
1313
                if inventory_delta is not None:
1314
                    if (trans_id in self._new_contents or
1315
                        self.path_changed(trans_id)):
1316
                        if trans_id in self._new_contents:
1317
                            modified_paths.append(full_path)
1318
                            completed_new.append(trans_id)
1319
                    file_id = new_path_file_ids[trans_id]
1320
                    if file_id is not None and (trans_id in self._new_id or
3453.2.10 by Aaron Bentley
Fix long lines
1321
                        trans_id in self._new_name or
1322
                        trans_id in self._new_parent
3453.2.3 by Aaron Bentley
Enable using a precomputed inventory delta for build_tree.
1323
                        or trans_id in self._new_executability):
3008.1.7 by Michael Hudson
move apply and helpers to TreeTransform from TreeTransformBase
1324
                        try:
3453.2.3 by Aaron Bentley
Enable using a precomputed inventory delta for build_tree.
1325
                            kind = self.final_kind(trans_id)
1326
                        except NoSuchFile:
1327
                            kind = self._tree.stored_kind(file_id)
1328
                        parent_trans_id = self.final_parent(trans_id)
1329
                        parent_file_id = new_path_file_ids.get(parent_trans_id)
1330
                        if parent_file_id is None:
3453.2.10 by Aaron Bentley
Fix long lines
1331
                            parent_file_id = self.final_file_id(
1332
                                parent_trans_id)
3453.2.3 by Aaron Bentley
Enable using a precomputed inventory delta for build_tree.
1333
                        if trans_id in self._new_reference_revision:
1334
                            new_entry = inventory.TreeReference(
1335
                                file_id,
1336
                                self._new_name[trans_id],
1337
                                self.final_file_id(self._new_parent[trans_id]),
1338
                                None, self._new_reference_revision[trans_id])
3008.1.7 by Michael Hudson
move apply and helpers to TreeTransform from TreeTransformBase
1339
                        else:
3453.2.3 by Aaron Bentley
Enable using a precomputed inventory delta for build_tree.
1340
                            new_entry = inventory.make_entry(kind,
1341
                                self.final_name(trans_id),
1342
                                parent_file_id, file_id)
1343
                        old_path = old_paths.get(new_entry.file_id)
1344
                        inventory_delta.append(
1345
                            (old_path, path, new_entry.file_id, new_entry))
3008.1.7 by Michael Hudson
move apply and helpers to TreeTransform from TreeTransformBase
1346
1347
                if trans_id in self._new_executability:
1348
                    self._set_executability(path, new_entry, trans_id)
1349
        finally:
1350
            child_pb.finished()
3453.2.3 by Aaron Bentley
Enable using a precomputed inventory delta for build_tree.
1351
        if inventory_delta is None:
1352
            self._new_contents.clear()
1353
        else:
1354
            for trans_id in completed_new:
1355
                del self._new_contents[trans_id]
3008.1.7 by Michael Hudson
move apply and helpers to TreeTransform from TreeTransformBase
1356
        return modified_paths
1357
3008.1.1 by Aaron Bentley
Start work allowing previews of transforms
1358
1359
class TransformPreview(TreeTransformBase):
3008.1.29 by Aaron Bentley
Add docstrings, rename TT.__doc
1360
    """A TreeTransform for generating preview trees.
1361
1362
    Unlike TreeTransform, this version works when the input tree is a
1363
    RevisionTree, rather than a WorkingTree.  As a result, it tends to ignore
1364
    unversioned files in the input tree.
1365
    """
3008.1.1 by Aaron Bentley
Start work allowing previews of transforms
1366
3008.1.15 by Aaron Bentley
Make case_sensitive an aspect of the transform, not the source tree
1367
    def __init__(self, tree, pb=DummyProgress(), case_sensitive=True):
3199.1.5 by Vincent Ladeuil
Fix two more leaking tmp dirs, by reworking TransformPreview lock handling.
1368
        tree.lock_read()
3199.1.4 by Vincent Ladeuil
Fix 16 leaked tmp dirs. Probably indicates a lock handling problem with TransformPreview
1369
        limbodir = tempfile.mkdtemp(prefix='bzr-limbo-')
3008.1.15 by Aaron Bentley
Make case_sensitive an aspect of the transform, not the source tree
1370
        TreeTransformBase.__init__(self, tree, limbodir, pb, case_sensitive)
3008.1.1 by Aaron Bentley
Start work allowing previews of transforms
1371
1372
    def canonical_path(self, path):
1373
        return path
1374
3008.1.9 by Michael Hudson
wanton hacking that lets me write an efficient version of get_diff_as_merged
1375
    def tree_kind(self, trans_id):
1376
        path = self._tree_id_paths.get(trans_id)
3008.2.1 by Aaron Bentley
Ensure conflict resolution works
1377
        if path is None:
1378
            raise NoSuchFile(None)
3008.1.9 by Michael Hudson
wanton hacking that lets me write an efficient version of get_diff_as_merged
1379
        file_id = self._tree.path2id(path)
1380
        return self._tree.kind(file_id)
1381
1382
    def _set_mode(self, trans_id, mode_id, typefunc):
1383
        """Set the mode of new file contents.
1384
        The mode_id is the existing file to get the mode from (often the same
1385
        as trans_id).  The operation is only performed if there's a mode match
1386
        according to typefunc.
1387
        """
1388
        # is it ok to ignore this?  probably
1389
        pass
1390
1391
    def iter_tree_children(self, parent_id):
1392
        """Iterate through the entry's tree children, if any"""
3008.2.1 by Aaron Bentley
Ensure conflict resolution works
1393
        try:
1394
            path = self._tree_id_paths[parent_id]
1395
        except KeyError:
1396
            return
1397
        file_id = self.tree_file_id(parent_id)
3363.5.2 by Aaron Bentley
Massive simplification of path2id
1398
        if file_id is None:
1399
            return
3363.2.23 by Aaron Bentley
Fix iter_entries_by_dir ordering
1400
        children = getattr(self._tree.inventory[file_id], 'children', {})
1401
        for child in children:
3008.2.1 by Aaron Bentley
Ensure conflict resolution works
1402
            childpath = joinpath(path, child)
1403
            yield self.trans_id_tree_path(childpath)
3008.1.1 by Aaron Bentley
Start work allowing previews of transforms
1404
3008.1.29 by Aaron Bentley
Add docstrings, rename TT.__doc
1405
3363.2.4 by Aaron Bentley
Get significant portions of PreviewTree implemented and passing tests
1406
class _PreviewTree(tree.Tree):
3008.1.29 by Aaron Bentley
Add docstrings, rename TT.__doc
1407
    """Partial implementation of Tree to support show_diff_trees"""
3008.1.1 by Aaron Bentley
Start work allowing previews of transforms
1408
1409
    def __init__(self, transform):
1410
        self._transform = transform
3363.2.4 by Aaron Bentley
Get significant portions of PreviewTree implemented and passing tests
1411
        self._final_paths = FinalPaths(transform)
3363.2.21 by Aaron Bentley
Implement iter_entries_by_dir
1412
        self.__by_parent = None
3363.2.4 by Aaron Bentley
Get significant portions of PreviewTree implemented and passing tests
1413
1414
    def _changes(self, file_id):
1415
        for changes in self._transform.iter_changes():
3363.2.9 by Aaron Bentley
Fix up some refactorings
1416
            if changes[0] == file_id:
3363.2.4 by Aaron Bentley
Get significant portions of PreviewTree implemented and passing tests
1417
                return changes
1418
1419
    def _content_change(self, file_id):
3363.3.3 by Aaron Bentley
Updates from review
1420
        """Return True if the content of this file changed"""
3363.2.4 by Aaron Bentley
Get significant portions of PreviewTree implemented and passing tests
1421
        changes = self._changes(file_id)
3363.3.3 by Aaron Bentley
Updates from review
1422
        # changes[2] is true if the file content changed.  See
1423
        # InterTree.iter_changes.
3363.2.4 by Aaron Bentley
Get significant portions of PreviewTree implemented and passing tests
1424
        return (changes is not None and changes[2])
1425
1426
    def _get_file_revision(self, file_id, vf, tree_revision):
1427
        return self._transform._tree._get_file_revision(file_id, vf,
1428
                                                        tree_revision)
3008.1.1 by Aaron Bentley
Start work allowing previews of transforms
1429
3363.2.9 by Aaron Bentley
Fix up some refactorings
1430
    def _stat_limbo_file(self, file_id):
3363.2.7 by Aaron Bentley
Implement alterntative-to-inventory tests
1431
        trans_id = self._transform.trans_id_file_id(file_id)
1432
        name = self._transform._limbo_name(trans_id)
1433
        return os.lstat(name)
1434
3363.2.21 by Aaron Bentley
Implement iter_entries_by_dir
1435
    @property
1436
    def _by_parent(self):
1437
        if self.__by_parent is None:
1438
            self.__by_parent = self._transform.by_parent()
1439
        return self.__by_parent
1440
3008.1.1 by Aaron Bentley
Start work allowing previews of transforms
1441
    def lock_read(self):
3008.1.18 by Aaron Bentley
Get supported PreviewTree functionality under test
1442
        # Perhaps in theory, this should lock the TreeTransform?
3008.1.1 by Aaron Bentley
Start work allowing previews of transforms
1443
        pass
1444
1445
    def unlock(self):
1446
        pass
1447
3363.2.7 by Aaron Bentley
Implement alterntative-to-inventory tests
1448
    @property
1449
    def inventory(self):
1450
        """This Tree does not use inventory as its backing data."""
1451
        raise NotImplementedError(_PreviewTree.inventory)
1452
3363.2.4 by Aaron Bentley
Get significant portions of PreviewTree implemented and passing tests
1453
    def get_root_id(self):
1454
        return self._transform.final_file_id(self._transform.root)
1455
1456
    def all_file_ids(self):
3363.2.18 by Aaron Bentley
Implement correct all_file_ids for PreviewTree
1457
        tree_ids = set(self._transform._tree.all_file_ids())
1458
        tree_ids.difference_update(self._transform.tree_file_id(t)
1459
                                   for t in self._transform._removed_id)
1460
        tree_ids.update(self._transform._new_id.values())
1461
        return tree_ids
3363.2.4 by Aaron Bentley
Get significant portions of PreviewTree implemented and passing tests
1462
1463
    def __iter__(self):
1464
        return iter(self.all_file_ids())
1465
1466
    def paths2ids(self, specific_files, trees=None, require_versioned=False):
1467
        """See Tree.paths2ids"""
1468
        to_find = set(specific_files)
1469
        result = set()
1470
        for (file_id, paths, changed, versioned, parent, name, kind,
1471
             executable) in self._transform.iter_changes():
1472
            if paths[1] in to_find:
1473
                result.append(file_id)
1474
                to_find.remove(paths[1])
1475
        result.update(self._transform._tree.paths2ids(to_find,
1476
                      trees=[], require_versioned=require_versioned))
1477
        return result
1478
3363.5.2 by Aaron Bentley
Massive simplification of path2id
1479
    def _path2trans_id(self, path):
1480
        segments = splitpath(path)
3363.2.19 by Aaron Bentley
Make PreviewTree.path2id correct
1481
        cur_parent = self._transform.root
3363.5.2 by Aaron Bentley
Massive simplification of path2id
1482
        for cur_segment in segments:
1483
            for child in self._all_children(cur_parent):
3363.2.19 by Aaron Bentley
Make PreviewTree.path2id correct
1484
                if self._transform.final_name(child) == cur_segment:
1485
                    cur_parent = child
1486
                    break
1487
            else:
3363.5.2 by Aaron Bentley
Massive simplification of path2id
1488
                return None
1489
        return cur_parent
3363.2.26 by Aaron Bentley
Get symlinks working
1490
3363.2.20 by Aaron Bentley
Split path2id into smaller pieces
1491
    def path2id(self, path):
3363.5.2 by Aaron Bentley
Massive simplification of path2id
1492
        return self._transform.final_file_id(self._path2trans_id(path))
3363.2.4 by Aaron Bentley
Get significant portions of PreviewTree implemented and passing tests
1493
1494
    def id2path(self, file_id):
1495
        trans_id = self._transform.trans_id_file_id(file_id)
1496
        try:
1497
            return self._final_paths._determine_path(trans_id)
1498
        except NoFinalPath:
1499
            raise errors.NoSuchId(self, file_id)
1500
3363.2.21 by Aaron Bentley
Implement iter_entries_by_dir
1501
    def _all_children(self, trans_id):
1502
        children = set(self._transform.iter_tree_children(trans_id))
1503
        # children in the _new_parent set are provided by _by_parent.
1504
        children.difference_update(self._transform._new_parent.keys())
1505
        children.update(self._by_parent.get(trans_id, []))
1506
        return children
1507
1508
    def _make_inv_entries(self, ordered_entries, specific_file_ids):
1509
        for trans_id, parent_file_id in ordered_entries:
1510
            file_id = self._transform.final_file_id(trans_id)
1511
            if file_id is None:
1512
                continue
1513
            if (specific_file_ids is not None
1514
                and file_id not in specific_file_ids):
1515
                continue
1516
            try:
1517
                kind = self._transform.final_kind(trans_id)
1518
            except NoSuchFile:
1519
                kind = self._transform._tree.stored_kind(file_id)
1520
            new_entry = inventory.make_entry(
1521
                kind,
1522
                self._transform.final_name(trans_id),
1523
                parent_file_id, file_id)
1524
            yield new_entry, trans_id
1525
3363.2.4 by Aaron Bentley
Get significant portions of PreviewTree implemented and passing tests
1526
    def iter_entries_by_dir(self, specific_file_ids=None):
3363.2.21 by Aaron Bentley
Implement iter_entries_by_dir
1527
        # This may not be a maximally efficient implementation, but it is
1528
        # reasonably straightforward.  An implementation that grafts the
1529
        # TreeTransform changes onto the tree's iter_entries_by_dir results
1530
        # might be more efficient, but requires tricky inferences about stack
1531
        # position.
1532
        todo = [ROOT_PARENT]
1533
        ordered_ids = []
1534
        while len(todo) > 0:
1535
            parent = todo.pop()
1536
            parent_file_id = self._transform.final_file_id(parent)
3363.2.23 by Aaron Bentley
Fix iter_entries_by_dir ordering
1537
            children = list(self._all_children(parent))
1538
            paths = dict(zip(children, self._final_paths.get_paths(children)))
1539
            children.sort(key=paths.get)
3363.5.4 by Aaron Bentley
Fix iteration order of iter_entries_by_dir
1540
            todo.extend(reversed(children))
3363.2.21 by Aaron Bentley
Implement iter_entries_by_dir
1541
            for trans_id in children:
1542
                ordered_ids.append((trans_id, parent_file_id))
1543
        for entry, trans_id in self._make_inv_entries(ordered_ids,
1544
                                                      specific_file_ids):
3363.2.23 by Aaron Bentley
Fix iter_entries_by_dir ordering
1545
            yield unicode(self._final_paths.get_path(trans_id)), entry
3363.2.4 by Aaron Bentley
Get significant portions of PreviewTree implemented and passing tests
1546
1547
    def kind(self, file_id):
1548
        trans_id = self._transform.trans_id_file_id(file_id)
1549
        return self._transform.final_kind(trans_id)
1550
1551
    def stored_kind(self, file_id):
3363.2.36 by Aaron Bentley
Fix PreviewTree.stored_kind
1552
        trans_id = self._transform.trans_id_file_id(file_id)
1553
        try:
1554
            return self._transform._new_contents[trans_id]
1555
        except KeyError:
1556
            return self._transform._tree.stored_kind(file_id)
3363.2.4 by Aaron Bentley
Get significant portions of PreviewTree implemented and passing tests
1557
1558
    def get_file_mtime(self, file_id, path=None):
1559
        """See Tree.get_file_mtime"""
1560
        if not self._content_change(file_id):
1561
            return self._transform._tree.get_file_mtime(file_id, path)
3363.2.9 by Aaron Bentley
Fix up some refactorings
1562
        return self._stat_limbo_file(file_id).st_mtime
3363.2.7 by Aaron Bentley
Implement alterntative-to-inventory tests
1563
1564
    def get_file_size(self, file_id):
3363.3.3 by Aaron Bentley
Updates from review
1565
        """See Tree.get_file_size"""
3363.2.7 by Aaron Bentley
Implement alterntative-to-inventory tests
1566
        if self.kind(file_id) == 'file':
1567
            return self._transform._tree.get_file_size(file_id)
3363.3.3 by Aaron Bentley
Updates from review
1568
        else:
1569
            return None
3363.2.7 by Aaron Bentley
Implement alterntative-to-inventory tests
1570
1571
    def get_file_sha1(self, file_id, path=None, stat_value=None):
1572
        return self._transform._tree.get_file_sha1(file_id)
1573
1574
    def is_executable(self, file_id, path=None):
3363.2.37 by Aaron Bentley
Fix is_executable
1575
        trans_id = self._transform.trans_id_file_id(file_id)
1576
        try:
1577
            return self._transform._new_executability[trans_id]
1578
        except KeyError:
1579
            return self._transform._tree.is_executable(file_id, path)
3363.2.4 by Aaron Bentley
Get significant portions of PreviewTree implemented and passing tests
1580
1581
    def path_content_summary(self, path):
3363.6.1 by Aaron Bentley
Merge with preview-tree-changed
1582
        trans_id = self._path2trans_id(path)
3363.2.27 by Aaron Bentley
Make path_content_summary a core API
1583
        tt = self._transform
3363.6.1 by Aaron Bentley
Merge with preview-tree-changed
1584
        tree_path = tt._tree_id_paths.get(trans_id)
3363.2.27 by Aaron Bentley
Make path_content_summary a core API
1585
        kind = tt._new_contents.get(trans_id)
1586
        if kind is None:
3363.6.1 by Aaron Bentley
Merge with preview-tree-changed
1587
            if tree_path is None or trans_id in tt._removed_contents:
3363.2.27 by Aaron Bentley
Make path_content_summary a core API
1588
                return 'missing', None, None, None
1589
            summary = tt._tree.path_content_summary(tree_path)
1590
            kind, size, executable, link_or_sha1 = summary
1591
        else:
1592
            link_or_sha1 = None
1593
            limbo_name = tt._limbo_name(trans_id)
1594
            if trans_id in tt._new_reference_revision:
1595
                kind = 'tree-reference'
1596
            if kind == 'file':
1597
                statval = os.lstat(limbo_name)
1598
                size = statval.st_size
1599
                if not supports_executable():
1600
                    executable = None
1601
                else:
1602
                    executable = statval.st_mode & S_IEXEC
1603
            else:
1604
                size = None
1605
                executable = None
1606
            if kind == 'symlink':
1607
                link_or_sha1 = os.readlink(limbo_name)
1608
        if supports_executable():
1609
            executable = tt._new_executability.get(trans_id, executable)
1610
        return kind, size, executable, link_or_sha1
3363.2.4 by Aaron Bentley
Get significant portions of PreviewTree implemented and passing tests
1611
3254.1.1 by Aaron Bentley
Make Tree.iter_changes a public method
1612
    def iter_changes(self, from_tree, include_unchanged=False,
3008.1.17 by Aaron Bentley
Test unused parameters of preview_tree._iter_changes
1613
                      specific_files=None, pb=None, extra_trees=None,
1614
                      require_versioned=True, want_unversioned=False):
3254.1.1 by Aaron Bentley
Make Tree.iter_changes a public method
1615
        """See InterTree.iter_changes.
3008.1.17 by Aaron Bentley
Test unused parameters of preview_tree._iter_changes
1616
1617
        This implementation does not support include_unchanged, specific_files,
1618
        or want_unversioned.  extra_trees, require_versioned, and pb are
1619
        ignored.
1620
        """
1621
        if from_tree is not self._transform._tree:
1622
            raise ValueError('from_tree must be transform source tree.')
1623
        if include_unchanged:
1624
            raise ValueError('include_unchanged is not supported')
1625
        if specific_files is not None:
1626
            raise ValueError('specific_files is not supported')
1627
        if want_unversioned:
1628
            raise ValueError('want_unversioned is not supported')
3254.1.1 by Aaron Bentley
Make Tree.iter_changes a public method
1629
        return self._transform.iter_changes()
3008.1.1 by Aaron Bentley
Start work allowing previews of transforms
1630
3363.2.4 by Aaron Bentley
Get significant portions of PreviewTree implemented and passing tests
1631
    def get_file(self, file_id, path=None):
3008.1.20 by Aaron Bentley
Add some docstrings
1632
        """See Tree.get_file"""
3363.2.4 by Aaron Bentley
Get significant portions of PreviewTree implemented and passing tests
1633
        if not self._content_change(file_id):
1634
            return self._transform._tree.get_file(file_id, path)
3008.1.3 by Aaron Bentley
Support basic diff
1635
        trans_id = self._transform.trans_id_file_id(file_id)
1636
        name = self._transform._limbo_name(trans_id)
1637
        return open(name, 'rb')
1638
3363.2.4 by Aaron Bentley
Get significant portions of PreviewTree implemented and passing tests
1639
    def get_file_text(self, file_id):
1640
        text_file = self.get_file(file_id)
1641
        try:
1642
            return text_file.read()
1643
        finally:
1644
            text_file.close()
1645
1646
    def annotate_iter(self, file_id,
1647
                      default_revision=_mod_revision.CURRENT_REVISION):
3363.2.33 by Aaron Bentley
Implement PreviewTree.annotate_iter
1648
        changes = self._changes(file_id)
3363.2.35 by Aaron Bentley
Update to get tests passing
1649
        if changes is None:
1650
            get_old = True
3363.2.33 by Aaron Bentley
Implement PreviewTree.annotate_iter
1651
        else:
3363.2.35 by Aaron Bentley
Update to get tests passing
1652
            changed_content, versioned, kind = (changes[2], changes[3],
1653
                                                changes[6])
1654
            if kind[1] is None:
1655
                return None
1656
            get_old = (kind[0] == 'file' and versioned[0])
1657
        if get_old:
3363.2.33 by Aaron Bentley
Implement PreviewTree.annotate_iter
1658
            old_annotation = self._transform._tree.annotate_iter(file_id,
1659
                default_revision=default_revision)
3363.2.35 by Aaron Bentley
Update to get tests passing
1660
        else:
1661
            old_annotation = []
1662
        if changes is None:
1663
            return old_annotation
3363.2.33 by Aaron Bentley
Implement PreviewTree.annotate_iter
1664
        if not changed_content:
1665
            return old_annotation
1666
        return annotate.reannotate([old_annotation],
1667
                                   self.get_file(file_id).readlines(),
1668
                                   default_revision)
3363.2.4 by Aaron Bentley
Get significant portions of PreviewTree implemented and passing tests
1669
3228.1.1 by James Henstridge
* Add get_symlink_target() method to bzrlib.transform._PreviewTree, so
1670
    def get_symlink_target(self, file_id):
1671
        """See Tree.get_symlink_target"""
3363.2.29 by Aaron Bentley
Remove unneeded changes
1672
        if not self._content_change(file_id):
1673
            return self._transform._tree.get_symlink_target(file_id)
3228.1.1 by James Henstridge
* Add get_symlink_target() method to bzrlib.transform._PreviewTree, so
1674
        trans_id = self._transform.trans_id_file_id(file_id)
3363.2.29 by Aaron Bentley
Remove unneeded changes
1675
        name = self._transform._limbo_name(trans_id)
1676
        return os.readlink(name)
3228.1.1 by James Henstridge
* Add get_symlink_target() method to bzrlib.transform._PreviewTree, so
1677
3363.2.4 by Aaron Bentley
Get significant portions of PreviewTree implemented and passing tests
1678
    def list_files(self, include_root=False):
1679
        return self._transform._tree.list_files(include_root)
1680
1681
    def walkdirs(self, prefix=""):
1682
        return self._transform._tree.walkdirs(prefix)
1683
1684
    def get_parent_ids(self):
1685
        return self._transform._tree.get_parent_ids()
1686
1687
    def get_revision_tree(self, revision_id):
1688
        return self._transform._tree.get_revision_tree(revision_id)
3008.1.1 by Aaron Bentley
Start work allowing previews of transforms
1689
1690
1534.7.32 by Aaron Bentley
Got conflict handling working when conflicts involve existing files
1691
def joinpath(parent, child):
1534.7.40 by Aaron Bentley
Updated docs
1692
    """Join tree-relative paths, handling the tree root specially"""
1534.7.32 by Aaron Bentley
Got conflict handling working when conflicts involve existing files
1693
    if parent is None or parent == "":
1694
        return child
1695
    else:
1534.7.166 by Aaron Bentley
Swapped os.path.join for pathjoin everywhere
1696
        return pathjoin(parent, child)
1534.7.1 by Aaron Bentley
Got creation of a versioned file working
1697
1534.7.167 by Aaron Bentley
PEP8 and comment cleanups
1698
1534.7.1 by Aaron Bentley
Got creation of a versioned file working
1699
class FinalPaths(object):
1759.2.2 by Jelmer Vernooij
Revert some of my spelling fixes and fix some typos after review by Aaron.
1700
    """Make path calculation cheap by memoizing paths.
1534.7.21 by Aaron Bentley
Updated docstrings
1701
1702
    The underlying tree must not be manipulated between calls, or else
1703
    the results will likely be incorrect.
1704
    """
1534.7.132 by Aaron Bentley
Got cooked conflicts working
1705
    def __init__(self, transform):
1534.7.1 by Aaron Bentley
Got creation of a versioned file working
1706
        object.__init__(self)
1707
        self._known_paths = {}
1534.7.33 by Aaron Bentley
Fixed naming
1708
        self.transform = transform
1534.7.1 by Aaron Bentley
Got creation of a versioned file working
1709
1710
    def _determine_path(self, trans_id):
1534.7.132 by Aaron Bentley
Got cooked conflicts working
1711
        if trans_id == self.transform.root:
1534.7.1 by Aaron Bentley
Got creation of a versioned file working
1712
            return ""
1534.7.33 by Aaron Bentley
Fixed naming
1713
        name = self.transform.final_name(trans_id)
1714
        parent_id = self.transform.final_parent(trans_id)
1534.7.132 by Aaron Bentley
Got cooked conflicts working
1715
        if parent_id == self.transform.root:
1534.7.1 by Aaron Bentley
Got creation of a versioned file working
1716
            return name
1717
        else:
1534.7.166 by Aaron Bentley
Swapped os.path.join for pathjoin everywhere
1718
            return pathjoin(self.get_path(parent_id), name)
1534.7.1 by Aaron Bentley
Got creation of a versioned file working
1719
1720
    def get_path(self, trans_id):
1534.7.157 by Aaron Bentley
Added more docs
1721
        """Find the final path associated with a trans_id"""
1534.7.1 by Aaron Bentley
Got creation of a versioned file working
1722
        if trans_id not in self._known_paths:
1723
            self._known_paths[trans_id] = self._determine_path(trans_id)
1724
        return self._known_paths[trans_id]
1534.7.28 by Aaron Bentley
Nearly-working build_tree replacement
1725
3453.2.3 by Aaron Bentley
Enable using a precomputed inventory delta for build_tree.
1726
    def get_paths(self, trans_ids):
1727
        return [(self.get_path(t), t) for t in trans_ids]
1728
1729
3006.2.2 by Alexander Belchenko
tests added.
1730
1534.7.30 by Aaron Bentley
Factored out topological id sorting
1731
def topology_sorted_ids(tree):
1534.7.40 by Aaron Bentley
Updated docs
1732
    """Determine the topological order of the ids in a tree"""
1534.7.30 by Aaron Bentley
Factored out topological id sorting
1733
    file_ids = list(tree)
1734
    file_ids.sort(key=tree.id2path)
1735
    return file_ids
1534.7.28 by Aaron Bentley
Nearly-working build_tree replacement
1736
1966.1.1 by Aaron Bentley
Implement disk-content merge and conflict resolution for build_tree
1737
3453.2.3 by Aaron Bentley
Enable using a precomputed inventory delta for build_tree.
1738
def build_tree(tree, wt, accelerator_tree=None, hardlink=False,
3453.2.6 by Aaron Bentley
Rename mutate_tree to delta_from_tree, add comment
1739
               delta_from_tree=False):
1966.1.1 by Aaron Bentley
Implement disk-content merge and conflict resolution for build_tree
1740
    """Create working tree for a branch, using a TreeTransform.
1741
    
1966.1.2 by Aaron Bentley
Divert files instead of failing to create them, update from review
1742
    This function should be used on empty trees, having a tree root at most.
1743
    (see merge and revert functionality for working with existing trees)
1744
1966.1.1 by Aaron Bentley
Implement disk-content merge and conflict resolution for build_tree
1745
    Existing files are handled like so:
1746
    
1966.1.2 by Aaron Bentley
Divert files instead of failing to create them, update from review
1747
    - Existing bzrdirs take precedence over creating new items.  They are
1748
      created as '%s.diverted' % name.
1966.1.1 by Aaron Bentley
Implement disk-content merge and conflict resolution for build_tree
1749
    - Otherwise, if the content on disk matches the content we are building,
1750
      it is silently replaced.
1751
    - Otherwise, conflict resolution will move the old file to 'oldname.moved'.
3123.5.17 by Aaron Bentley
Update docs
1752
1753
    :param tree: The tree to convert wt into a copy of
1754
    :param wt: The working tree that files will be placed into
1755
    :param accelerator_tree: A tree which can be used for retrieving file
1756
        contents more quickly than tree itself, i.e. a workingtree.  tree
1757
        will be used for cases where accelerator_tree's content is different.
3136.1.2 by Aaron Bentley
Implement hard-linking for build_tree
1758
    :param hardlink: If true, hard-link files to accelerator_tree, where
3136.1.4 by Aaron Bentley
Avoid id2abspath calls
1759
        possible.  accelerator_tree must implement abspath, i.e. be a
3136.1.2 by Aaron Bentley
Implement hard-linking for build_tree
1760
        working tree.
3453.2.6 by Aaron Bentley
Rename mutate_tree to delta_from_tree, add comment
1761
    :param delta_from_tree: If true, build_tree may use the input Tree to
1762
        generate the inventory delta.
1966.1.1 by Aaron Bentley
Implement disk-content merge and conflict resolution for build_tree
1763
    """
2255.7.51 by Robert Collins
Lock build_tree trees in write-first order, to support older formats that dont do lock_tree_write nicely.
1764
    wt.lock_tree_write()
2255.7.49 by Robert Collins
Lock trees passed in to build_tree.
1765
    try:
2255.7.51 by Robert Collins
Lock build_tree trees in write-first order, to support older formats that dont do lock_tree_write nicely.
1766
        tree.lock_read()
2255.7.49 by Robert Collins
Lock trees passed in to build_tree.
1767
        try:
3123.5.1 by Aaron Bentley
Make build-tree able to use an additional 'accelerator' tree
1768
            if accelerator_tree is not None:
1769
                accelerator_tree.lock_read()
1770
            try:
3453.2.3 by Aaron Bentley
Enable using a precomputed inventory delta for build_tree.
1771
                return _build_tree(tree, wt, accelerator_tree, hardlink,
3453.2.6 by Aaron Bentley
Rename mutate_tree to delta_from_tree, add comment
1772
                                   delta_from_tree)
3123.5.1 by Aaron Bentley
Make build-tree able to use an additional 'accelerator' tree
1773
            finally:
1774
                if accelerator_tree is not None:
1775
                    accelerator_tree.unlock()
2255.7.49 by Robert Collins
Lock trees passed in to build_tree.
1776
        finally:
2255.7.51 by Robert Collins
Lock build_tree trees in write-first order, to support older formats that dont do lock_tree_write nicely.
1777
            tree.unlock()
2255.7.49 by Robert Collins
Lock trees passed in to build_tree.
1778
    finally:
2255.7.51 by Robert Collins
Lock build_tree trees in write-first order, to support older formats that dont do lock_tree_write nicely.
1779
        wt.unlock()
2255.7.49 by Robert Collins
Lock trees passed in to build_tree.
1780
3006.2.2 by Alexander Belchenko
tests added.
1781
3453.2.6 by Aaron Bentley
Rename mutate_tree to delta_from_tree, add comment
1782
def _build_tree(tree, wt, accelerator_tree, hardlink, delta_from_tree):
2255.7.49 by Robert Collins
Lock trees passed in to build_tree.
1783
    """See build_tree."""
3146.8.17 by Aaron Bentley
Change to explicit file_id list
1784
    for num, _unused in enumerate(wt.all_file_ids()):
3146.8.16 by Aaron Bentley
Updates from review
1785
        if num > 0:  # more than just a root
1786
            raise errors.WorkingTreeAlreadyPopulated(base=wt.basedir)
3453.2.5 by Aaron Bentley
Avoid statting tons of non-existant files when building from scratch
1787
    existing_files = set()
1788
    for dir, files in wt.walkdirs():
1789
        existing_files.update(f[0] for f in files)
1534.7.28 by Aaron Bentley
Nearly-working build_tree replacement
1790
    file_trans_id = {}
1558.11.1 by Aaron Bentley
Progress indicator for tree builts
1791
    top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1792
    pp = ProgressPhase("Build phase", 2, top_pb)
2255.2.183 by Martin Pool
add missing _must_be_locked and a better message
1793
    if tree.inventory.root is not None:
2502.1.6 by Aaron Bentley
Update from review comments
1794
        # This is kind of a hack: we should be altering the root
1795
        # as part of the regular tree shape diff logic.
1796
        # The conditional test here is to avoid doing an
2255.2.194 by Robert Collins
[BROKEN] Many updates to stop using experimental formats in tests.
1797
        # expensive operation (flush) every time the root id
1798
        # is set within the tree, nor setting the root and thus
1799
        # marking the tree as dirty, because we use two different
1800
        # idioms here: tree interfaces and inventory interfaces.
2946.3.3 by John Arbash Meinel
Prefer tree.get_root_id() as more explicit than tree.path2id('')
1801
        if wt.get_root_id() != tree.get_root_id():
1802
            wt.set_root_id(tree.get_root_id())
2255.2.194 by Robert Collins
[BROKEN] Many updates to stop using experimental formats in tests.
1803
            wt.flush()
1534.7.28 by Aaron Bentley
Nearly-working build_tree replacement
1804
    tt = TreeTransform(wt)
1966.1.2 by Aaron Bentley
Divert files instead of failing to create them, update from review
1805
    divert = set()
1534.7.28 by Aaron Bentley
Nearly-working build_tree replacement
1806
    try:
1558.11.1 by Aaron Bentley
Progress indicator for tree builts
1807
        pp.next_phase()
1966.1.1 by Aaron Bentley
Implement disk-content merge and conflict resolution for build_tree
1808
        file_trans_id[wt.get_root_id()] = \
1809
            tt.trans_id_tree_file_id(wt.get_root_id())
1558.11.1 by Aaron Bentley
Progress indicator for tree builts
1810
        pb = bzrlib.ui.ui_factory.nested_progress_bar()
1811
        try:
2708.1.2 by Aaron Bentley
Use extract_files_bytes for build_tree
1812
            deferred_contents = []
3136.1.2 by Aaron Bentley
Implement hard-linking for build_tree
1813
            num = 0
3483.1.1 by Ian Clatworthy
minor _build_tree cleanups
1814
            total = len(tree.inventory)
3453.2.6 by Aaron Bentley
Rename mutate_tree to delta_from_tree, add comment
1815
            if delta_from_tree:
3453.2.3 by Aaron Bentley
Enable using a precomputed inventory delta for build_tree.
1816
                precomputed_delta = []
1817
            else:
1818
                precomputed_delta = None
1966.1.2 by Aaron Bentley
Divert files instead of failing to create them, update from review
1819
            for num, (tree_path, entry) in \
1820
                enumerate(tree.inventory.iter_entries_by_dir()):
3483.1.1 by Ian Clatworthy
minor _build_tree cleanups
1821
                pb.update("Building tree", num - len(deferred_contents), total)
1558.11.1 by Aaron Bentley
Progress indicator for tree builts
1822
                if entry.parent_id is None:
1823
                    continue
1966.1.1 by Aaron Bentley
Implement disk-content merge and conflict resolution for build_tree
1824
                reparent = False
1966.1.2 by Aaron Bentley
Divert files instead of failing to create them, update from review
1825
                file_id = entry.file_id
3453.2.6 by Aaron Bentley
Rename mutate_tree to delta_from_tree, add comment
1826
                if delta_from_tree:
3453.2.3 by Aaron Bentley
Enable using a precomputed inventory delta for build_tree.
1827
                    precomputed_delta.append((None, tree_path, file_id, entry))
3453.2.5 by Aaron Bentley
Avoid statting tons of non-existant files when building from scratch
1828
                if tree_path in existing_files:
1829
                    target_path = wt.abspath(tree_path)
1966.1.1 by Aaron Bentley
Implement disk-content merge and conflict resolution for build_tree
1830
                    kind = file_kind(target_path)
1831
                    if kind == "directory":
1832
                        try:
1833
                            bzrdir.BzrDir.open(target_path)
1834
                        except errors.NotBranchError:
1835
                            pass
1836
                        else:
1966.1.2 by Aaron Bentley
Divert files instead of failing to create them, update from review
1837
                            divert.add(file_id)
1838
                    if (file_id not in divert and
1839
                        _content_match(tree, entry, file_id, kind,
1840
                        target_path)):
1966.1.1 by Aaron Bentley
Implement disk-content merge and conflict resolution for build_tree
1841
                        tt.delete_contents(tt.trans_id_tree_path(tree_path))
1842
                        if kind == 'directory':
1843
                            reparent = True
1558.11.1 by Aaron Bentley
Progress indicator for tree builts
1844
                parent_id = file_trans_id[entry.parent_id]
2708.1.8 by Aaron Bentley
rename extract_files_bytest to iter_files_bytes, fix build_tree / progress
1845
                if entry.kind == 'file':
2708.1.2 by Aaron Bentley
Use extract_files_bytes for build_tree
1846
                    # We *almost* replicate new_by_entry, so that we can defer
1847
                    # getting the file text, and get them all at once.
1848
                    trans_id = tt.create_path(entry.name, parent_id)
2708.1.8 by Aaron Bentley
rename extract_files_bytest to iter_files_bytes, fix build_tree / progress
1849
                    file_trans_id[file_id] = trans_id
3483.1.1 by Ian Clatworthy
minor _build_tree cleanups
1850
                    tt.version_file(file_id, trans_id)
1851
                    executable = tree.is_executable(file_id, tree_path)
3453.2.3 by Aaron Bentley
Enable using a precomputed inventory delta for build_tree.
1852
                    if executable:
2708.1.8 by Aaron Bentley
rename extract_files_bytest to iter_files_bytes, fix build_tree / progress
1853
                        tt.set_executability(executable, trans_id)
3483.1.1 by Ian Clatworthy
minor _build_tree cleanups
1854
                    deferred_contents.append((file_id, trans_id))
2708.1.2 by Aaron Bentley
Use extract_files_bytes for build_tree
1855
                else:
1856
                    file_trans_id[file_id] = new_by_entry(tt, entry, parent_id,
1857
                                                          tree)
1966.1.1 by Aaron Bentley
Implement disk-content merge and conflict resolution for build_tree
1858
                if reparent:
1859
                    new_trans_id = file_trans_id[file_id]
1860
                    old_parent = tt.trans_id_tree_path(tree_path)
1861
                    _reparent_children(tt, old_parent, new_trans_id)
3136.1.11 by Aaron Bentley
Updates from review
1862
            offset = num + 1 - len(deferred_contents)
3136.1.2 by Aaron Bentley
Implement hard-linking for build_tree
1863
            _create_files(tt, tree, deferred_contents, pb, offset,
1864
                          accelerator_tree, hardlink)
1558.11.1 by Aaron Bentley
Progress indicator for tree builts
1865
        finally:
1866
            pb.finished()
1867
        pp.next_phase()
1966.1.2 by Aaron Bentley
Divert files instead of failing to create them, update from review
1868
        divert_trans = set(file_trans_id[f] for f in divert)
1869
        resolver = lambda t, c: resolve_checkout(t, c, divert_trans)
1870
        raw_conflicts = resolve_conflicts(tt, pass_func=resolver)
3453.2.4 by Aaron Bentley
Disable fast-path when conflicts are encountered
1871
        if len(raw_conflicts) > 0:
1872
            precomputed_delta = None
1966.1.1 by Aaron Bentley
Implement disk-content merge and conflict resolution for build_tree
1873
        conflicts = cook_conflicts(raw_conflicts, tt)
1874
        for conflict in conflicts:
1875
            warning(conflict)
1876
        try:
1877
            wt.add_conflicts(conflicts)
1878
        except errors.UnsupportedOperation:
1879
            pass
3453.2.3 by Aaron Bentley
Enable using a precomputed inventory delta for build_tree.
1880
        result = tt.apply(no_conflicts=True,
1881
                          precomputed_delta=precomputed_delta)
1534.7.47 by Aaron Bentley
Started work on 'revert'
1882
    finally:
1883
        tt.finalize()
1558.11.1 by Aaron Bentley
Progress indicator for tree builts
1884
        top_pb.finished()
2502.1.5 by Aaron Bentley
Cleanup
1885
    return result
1534.7.47 by Aaron Bentley
Started work on 'revert'
1886
1966.1.1 by Aaron Bentley
Implement disk-content merge and conflict resolution for build_tree
1887
3136.1.2 by Aaron Bentley
Implement hard-linking for build_tree
1888
def _create_files(tt, tree, desired_files, pb, offset, accelerator_tree,
1889
                  hardlink):
1890
    total = len(desired_files) + offset
3123.5.5 by Aaron Bentley
Split out _iter_files_bytes_accelerated
1891
    if accelerator_tree is None:
1892
        new_desired_files = desired_files
1893
    else:
3254.1.1 by Aaron Bentley
Make Tree.iter_changes a public method
1894
        iter = accelerator_tree.iter_changes(tree, include_unchanged=True)
3137.1.1 by Aaron Bentley
Fix build_tree acceleration when file is moved in accelerator_tree
1895
        unchanged = dict((f, p[1]) for (f, p, c, v, d, n, k, e)
3136.1.2 by Aaron Bentley
Implement hard-linking for build_tree
1896
                         in iter if not (c or e[0] != e[1]))
3123.5.5 by Aaron Bentley
Split out _iter_files_bytes_accelerated
1897
        new_desired_files = []
3136.1.2 by Aaron Bentley
Implement hard-linking for build_tree
1898
        count = 0
1899
        for file_id, trans_id in desired_files:
3123.5.13 by Aaron Bentley
Accelerate further by using iter_changes
1900
            accelerator_path = unchanged.get(file_id)
3123.5.12 by Aaron Bentley
Try to optimize iter_changes_accelerated
1901
            if accelerator_path is None:
3136.1.2 by Aaron Bentley
Implement hard-linking for build_tree
1902
                new_desired_files.append((file_id, trans_id))
3123.5.12 by Aaron Bentley
Try to optimize iter_changes_accelerated
1903
                continue
3136.1.11 by Aaron Bentley
Updates from review
1904
            pb.update('Adding file contents', count + offset, total)
3136.1.2 by Aaron Bentley
Implement hard-linking for build_tree
1905
            if hardlink:
3136.1.4 by Aaron Bentley
Avoid id2abspath calls
1906
                tt.create_hardlink(accelerator_tree.abspath(accelerator_path),
3136.1.2 by Aaron Bentley
Implement hard-linking for build_tree
1907
                                   trans_id)
1908
            else:
1909
                contents = accelerator_tree.get_file(file_id, accelerator_path)
1910
                try:
1911
                    tt.create_file(contents, trans_id)
1912
                finally:
1913
                    contents.close()
1914
            count += 1
1915
        offset += count
1916
    for count, (trans_id, contents) in enumerate(tree.iter_files_bytes(
1917
                                                 new_desired_files)):
1918
        tt.create_file(contents, trans_id)
3136.1.11 by Aaron Bentley
Updates from review
1919
        pb.update('Adding file contents', count + offset, total)
3123.5.5 by Aaron Bentley
Split out _iter_files_bytes_accelerated
1920
1921
1966.1.1 by Aaron Bentley
Implement disk-content merge and conflict resolution for build_tree
1922
def _reparent_children(tt, old_parent, new_parent):
1923
    for child in tt.iter_tree_children(old_parent):
1924
        tt.adjust_path(tt.final_name(child), new_parent, child)
1925
3144.4.2 by Aaron Bentley
Handle non-directory parent conflicts (abentley, #177390)
1926
def _reparent_transform_children(tt, old_parent, new_parent):
1927
    by_parent = tt.by_parent()
1928
    for child in by_parent[old_parent]:
1929
        tt.adjust_path(tt.final_name(child), new_parent, child)
1551.19.32 by Aaron Bentley
Don't traceback when adding files to a deleted root (abentley, #210092)
1930
    return by_parent[old_parent]
1966.1.1 by Aaron Bentley
Implement disk-content merge and conflict resolution for build_tree
1931
1932
def _content_match(tree, entry, file_id, kind, target_path):
1933
    if entry.kind != kind:
1934
        return False
1935
    if entry.kind == "directory":
1936
        return True
1937
    if entry.kind == "file":
1938
        if tree.get_file(file_id).read() == file(target_path, 'rb').read():
1939
            return True
1940
    elif entry.kind == "symlink":
1941
        if tree.get_symlink_target(file_id) == os.readlink(target_path):
1942
            return True
1943
    return False
1944
1945
1966.1.2 by Aaron Bentley
Divert files instead of failing to create them, update from review
1946
def resolve_checkout(tt, conflicts, divert):
1966.1.1 by Aaron Bentley
Implement disk-content merge and conflict resolution for build_tree
1947
    new_conflicts = set()
1948
    for c_type, conflict in ((c[0], c) for c in conflicts):
1949
        # Anything but a 'duplicate' would indicate programmer error
3376.2.4 by Martin Pool
Remove every assert statement from bzrlib!
1950
        if c_type != 'duplicate':
1951
            raise AssertionError(c_type)
1966.1.1 by Aaron Bentley
Implement disk-content merge and conflict resolution for build_tree
1952
        # Now figure out which is new and which is old
1966.1.2 by Aaron Bentley
Divert files instead of failing to create them, update from review
1953
        if tt.new_contents(conflict[1]):
1966.1.1 by Aaron Bentley
Implement disk-content merge and conflict resolution for build_tree
1954
            new_file = conflict[1]
1955
            old_file = conflict[2]
1956
        else:
1957
            new_file = conflict[2]
1958
            old_file = conflict[1]
1959
1960
        # We should only get here if the conflict wasn't completely
1961
        # resolved
1962
        final_parent = tt.final_parent(old_file)
1966.1.2 by Aaron Bentley
Divert files instead of failing to create them, update from review
1963
        if new_file in divert:
1964
            new_name = tt.final_name(old_file)+'.diverted'
1965
            tt.adjust_path(new_name, final_parent, new_file)
1966
            new_conflicts.add((c_type, 'Diverted to',
1967
                               new_file, old_file))
1968
        else:
1969
            new_name = tt.final_name(old_file)+'.moved'
1970
            tt.adjust_path(new_name, final_parent, old_file)
1971
            new_conflicts.add((c_type, 'Moved existing file to',
1972
                               old_file, new_file))
1966.1.1 by Aaron Bentley
Implement disk-content merge and conflict resolution for build_tree
1973
    return new_conflicts
1974
1975
1534.7.47 by Aaron Bentley
Started work on 'revert'
1976
def new_by_entry(tt, entry, parent_id, tree):
1534.7.157 by Aaron Bentley
Added more docs
1977
    """Create a new file according to its inventory entry"""
1534.7.47 by Aaron Bentley
Started work on 'revert'
1978
    name = entry.name
1979
    kind = entry.kind
1980
    if kind == 'file':
1534.7.79 by Aaron Bentley
Stopped calling get_file_lines on WorkingTree
1981
        contents = tree.get_file(entry.file_id).readlines()
1534.7.47 by Aaron Bentley
Started work on 'revert'
1982
        executable = tree.is_executable(entry.file_id)
1983
        return tt.new_file(name, parent_id, contents, entry.file_id, 
1984
                           executable)
2100.3.21 by Aaron Bentley
Work on checking out by-reference trees
1985
    elif kind in ('directory', 'tree-reference'):
1986
        trans_id = tt.new_directory(name, parent_id, entry.file_id)
1987
        if kind == 'tree-reference':
1988
            tt.set_tree_reference(entry.reference_revision, trans_id)
1989
        return trans_id 
1534.7.47 by Aaron Bentley
Started work on 'revert'
1990
    elif kind == 'symlink':
1534.7.183 by Aaron Bentley
Fixed build_tree with symlinks
1991
        target = tree.get_symlink_target(entry.file_id)
1992
        return tt.new_symlink(name, parent_id, target, entry.file_id)
2100.3.21 by Aaron Bentley
Work on checking out by-reference trees
1993
    else:
1994
        raise errors.BadFileKindError(name, kind)
1534.7.47 by Aaron Bentley
Started work on 'revert'
1995
3006.2.2 by Alexander Belchenko
tests added.
1996
1534.7.117 by Aaron Bentley
Simplified permission handling of existing files in transform.
1997
def create_by_entry(tt, entry, tree, trans_id, lines=None, mode_id=None):
1534.7.157 by Aaron Bentley
Added more docs
1998
    """Create new file contents according to an inventory entry."""
1534.7.47 by Aaron Bentley
Started work on 'revert'
1999
    if entry.kind == "file":
1963.2.6 by Robey Pointer
pychecker is on crack; go back to using 'is None'.
2000
        if lines is None:
1534.7.97 by Aaron Bentley
Ensured foo.BASE is a directory if there's a conflict
2001
            lines = tree.get_file(entry.file_id).readlines()
1534.7.117 by Aaron Bentley
Simplified permission handling of existing files in transform.
2002
        tt.create_file(lines, trans_id, mode_id=mode_id)
1534.7.47 by Aaron Bentley
Started work on 'revert'
2003
    elif entry.kind == "symlink":
1534.7.101 by Aaron Bentley
Got conflicts on symlinks working properly
2004
        tt.create_symlink(tree.get_symlink_target(entry.file_id), trans_id)
1534.7.47 by Aaron Bentley
Started work on 'revert'
2005
    elif entry.kind == "directory":
1534.7.51 by Aaron Bentley
New approach to revert
2006
        tt.create_directory(trans_id)
1534.7.47 by Aaron Bentley
Started work on 'revert'
2007
3006.2.2 by Alexander Belchenko
tests added.
2008
1534.7.89 by Aaron Bentley
Handle all content types in three-way
2009
def create_entry_executability(tt, entry, trans_id):
1534.7.157 by Aaron Bentley
Added more docs
2010
    """Set the executability of a trans_id according to an inventory entry"""
1534.7.89 by Aaron Bentley
Handle all content types in three-way
2011
    if entry.kind == "file":
2012
        tt.set_executability(entry.executable, trans_id)
1534.7.47 by Aaron Bentley
Started work on 'revert'
2013
1534.7.157 by Aaron Bentley
Added more docs
2014
1534.10.28 by Aaron Bentley
Use numbered backup files
2015
def get_backup_name(entry, by_parent, parent_trans_id, tt):
2012.1.12 by Aaron Bentley
Use iter_changes for revert
2016
    return _get_backup_name(entry.name, by_parent, parent_trans_id, tt)
2017
2018
2019
def _get_backup_name(name, by_parent, parent_trans_id, tt):
1534.10.28 by Aaron Bentley
Use numbered backup files
2020
    """Produce a backup-style name that appears to be available"""
2021
    def name_gen():
2022
        counter = 1
2023
        while True:
2012.1.12 by Aaron Bentley
Use iter_changes for revert
2024
            yield "%s.~%d~" % (name, counter)
1534.10.28 by Aaron Bentley
Use numbered backup files
2025
            counter += 1
2012.1.12 by Aaron Bentley
Use iter_changes for revert
2026
    for new_name in name_gen():
2027
        if not tt.has_named_child(by_parent, parent_trans_id, new_name):
2028
            return new_name
2029
1534.10.28 by Aaron Bentley
Use numbered backup files
2030
1534.7.55 by Aaron Bentley
Fixed up the change detection
2031
def _entry_changes(file_id, entry, working_tree):
1534.7.156 by Aaron Bentley
PEP8 fixes
2032
    """Determine in which ways the inventory entry has changed.
1534.7.55 by Aaron Bentley
Fixed up the change detection
2033
2034
    Returns booleans: has_contents, content_mod, meta_mod
2035
    has_contents means there are currently contents, but they differ
2036
    contents_mod means contents need to be modified
2037
    meta_mod means the metadata needs to be modified
2038
    """
2039
    cur_entry = working_tree.inventory[file_id]
2040
    try:
2041
        working_kind = working_tree.kind(file_id)
2042
        has_contents = True
1757.2.4 by Robert Collins
Teach file_kind about NoSuchFile, reducing duplicate code, and add user files before entering the main loop in smart_add.
2043
    except NoSuchFile:
1534.7.55 by Aaron Bentley
Fixed up the change detection
2044
        has_contents = False
2045
        contents_mod = True
2046
        meta_mod = False
2047
    if has_contents is True:
1731.1.1 by Aaron Bentley
Make root entry an InventoryDirectory, make EmptyTree really empty
2048
        if entry.kind != working_kind:
1534.7.55 by Aaron Bentley
Fixed up the change detection
2049
            contents_mod, meta_mod = True, False
2050
        else:
2051
            cur_entry._read_tree_state(working_tree.id2path(file_id), 
2052
                                       working_tree)
2053
            contents_mod, meta_mod = entry.detect_changes(cur_entry)
1534.7.175 by Aaron Bentley
Ensured revert writes a normal inventory
2054
            cur_entry._forget_tree_state()
1534.7.55 by Aaron Bentley
Fixed up the change detection
2055
    return has_contents, contents_mod, meta_mod
2056
1534.7.56 by Aaron Bentley
Implemented the backup file detritus
2057
2255.2.53 by Robert Collins
Teach TreeTransform to lock basis_trees if it acquires them, fixing revert on a dirstate working tree.
2058
def revert(working_tree, target_tree, filenames, backups=False,
2225.1.1 by Aaron Bentley
Added revert change display, with tests
2059
           pb=DummyProgress(), change_reporter=None):
1534.7.157 by Aaron Bentley
Added more docs
2060
    """Revert a working tree's contents to those of a target tree."""
2255.2.53 by Robert Collins
Teach TreeTransform to lock basis_trees if it acquires them, fixing revert on a dirstate working tree.
2061
    target_tree.lock_read()
1534.9.7 by Aaron Bentley
Show progress bars in revert
2062
    tt = TreeTransform(working_tree, pb)
1534.7.47 by Aaron Bentley
Started work on 'revert'
2063
    try:
2012.1.12 by Aaron Bentley
Use iter_changes for revert
2064
        pp = ProgressPhase("Revert phase", 3, pb)
3363.2.25 by Aaron Bentley
More removals of post-tree support
2065
        pp.next_phase()
2066
        child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
2067
        try:
2068
            merge_modified = _alter_files(working_tree, target_tree, tt,
2069
                                          child_pb, filenames, backups)
2070
        finally:
2071
            child_pb.finished()
2072
        pp.next_phase()
2073
        child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
2074
        try:
2075
            raw_conflicts = resolve_conflicts(tt, child_pb,
2076
                lambda t, c: conflict_pass(t, c, target_tree))
2077
        finally:
2078
            child_pb.finished()
2079
        conflicts = cook_conflicts(raw_conflicts, tt)
1551.11.5 by Aaron Bentley
cleanup
2080
        if change_reporter:
1551.10.25 by Aaron Bentley
Make ChangeReporter private
2081
            change_reporter = delta._ChangeReporter(
2255.7.98 by Robert Collins
Merge bzr.dev.
2082
                unversioned_filter=working_tree.is_ignored)
3254.1.1 by Aaron Bentley
Make Tree.iter_changes a public method
2083
            delta.report_changes(tt.iter_changes(), change_reporter)
1551.11.6 by Aaron Bentley
Emit change listings before conflict warnings
2084
        for conflict in conflicts:
2085
            warning(conflict)
2086
        pp.next_phase()
1534.7.28 by Aaron Bentley
Nearly-working build_tree replacement
2087
        tt.apply()
2499.1.1 by Aaron Bentley
Revert does not try to preserve file contents produced by revert
2088
        working_tree.set_merge_modified(merge_modified)
1534.7.28 by Aaron Bentley
Nearly-working build_tree replacement
2089
    finally:
2255.2.53 by Robert Collins
Teach TreeTransform to lock basis_trees if it acquires them, fixing revert on a dirstate working tree.
2090
        target_tree.unlock()
1534.7.28 by Aaron Bentley
Nearly-working build_tree replacement
2091
        tt.finalize()
1534.9.4 by Aaron Bentley
Added progress bars to revert.
2092
        pb.clear()
1558.7.13 by Aaron Bentley
WorkingTree.revert returns conflicts
2093
    return conflicts
1534.7.51 by Aaron Bentley
New approach to revert
2094
1534.7.57 by Aaron Bentley
Enhanced conflict resolution.
2095
2255.2.149 by Robert Collins
Crufty but existing _iter_changes implementation for WorkingTreeFormat4.
2096
def _alter_files(working_tree, target_tree, tt, pb, specific_files,
3363.2.22 by Aaron Bentley
Remove PreviewTreePost scenarios
2097
                 backups):
2098
    merge_modified = working_tree.merge_modified()
3254.1.1 by Aaron Bentley
Make Tree.iter_changes a public method
2099
    change_list = target_tree.iter_changes(working_tree,
2255.2.149 by Robert Collins
Crufty but existing _iter_changes implementation for WorkingTreeFormat4.
2100
        specific_files=specific_files, pb=pb)
2012.1.12 by Aaron Bentley
Use iter_changes for revert
2101
    if target_tree.inventory.root is None:
2102
        skip_root = True
2103
    else:
2104
        skip_root = False
3363.2.22 by Aaron Bentley
Remove PreviewTreePost scenarios
2105
    basis_tree = None
2255.2.53 by Robert Collins
Teach TreeTransform to lock basis_trees if it acquires them, fixing revert on a dirstate working tree.
2106
    try:
2708.1.5 by Aaron Bentley
Use Tree.extract_files_bytes in revert
2107
        deferred_files = []
2255.2.53 by Robert Collins
Teach TreeTransform to lock basis_trees if it acquires them, fixing revert on a dirstate working tree.
2108
        for id_num, (file_id, path, changed_content, versioned, parent, name,
2109
                kind, executable) in enumerate(change_list):
2110
            if skip_root and file_id[0] is not None and parent[0] is None:
2111
                continue
2112
            trans_id = tt.trans_id_file_id(file_id)
2113
            mode_id = None
2114
            if changed_content:
2115
                keep_content = False
2116
                if kind[0] == 'file' and (backups or kind[1] is None):
2117
                    wt_sha1 = working_tree.get_file_sha1(file_id)
2118
                    if merge_modified.get(file_id) != wt_sha1:
2502.1.6 by Aaron Bentley
Update from review comments
2119
                        # acquire the basis tree lazily to prevent the
2120
                        # expense of accessing it when it's not needed ?
2121
                        # (Guessing, RBC, 200702)
2255.2.53 by Robert Collins
Teach TreeTransform to lock basis_trees if it acquires them, fixing revert on a dirstate working tree.
2122
                        if basis_tree is None:
2123
                            basis_tree = working_tree.basis_tree()
2124
                            basis_tree.lock_read()
2125
                        if file_id in basis_tree:
2126
                            if wt_sha1 != basis_tree.get_file_sha1(file_id):
2127
                                keep_content = True
2128
                        elif kind[1] is None and not versioned[1]:
2012.1.12 by Aaron Bentley
Use iter_changes for revert
2129
                            keep_content = True
2255.2.53 by Robert Collins
Teach TreeTransform to lock basis_trees if it acquires them, fixing revert on a dirstate working tree.
2130
                if kind[0] is not None:
2131
                    if not keep_content:
2132
                        tt.delete_contents(trans_id)
2133
                    elif kind[1] is not None:
2134
                        parent_trans_id = tt.trans_id_file_id(parent[0])
2135
                        by_parent = tt.by_parent()
2136
                        backup_name = _get_backup_name(name[0], by_parent,
2137
                                                       parent_trans_id, tt)
2138
                        tt.adjust_path(backup_name, parent_trans_id, trans_id)
2139
                        new_trans_id = tt.create_path(name[0], parent_trans_id)
2140
                        if versioned == (True, True):
2141
                            tt.unversion_file(trans_id)
2142
                            tt.version_file(file_id, new_trans_id)
2143
                        # New contents should have the same unix perms as old
2144
                        # contents
2145
                        mode_id = trans_id
2146
                        trans_id = new_trans_id
2147
                if kind[1] == 'directory':
2148
                    tt.create_directory(trans_id)
2149
                elif kind[1] == 'symlink':
2150
                    tt.create_symlink(target_tree.get_symlink_target(file_id),
2151
                                      trans_id)
2152
                elif kind[1] == 'file':
2708.1.6 by Aaron Bentley
Turn extract_files_bytes into an iterator
2153
                    deferred_files.append((file_id, (trans_id, mode_id)))
2499.1.1 by Aaron Bentley
Revert does not try to preserve file contents produced by revert
2154
                    if basis_tree is None:
2155
                        basis_tree = working_tree.basis_tree()
2156
                        basis_tree.lock_read()
2157
                    new_sha1 = target_tree.get_file_sha1(file_id)
2158
                    if (file_id in basis_tree and new_sha1 ==
2159
                        basis_tree.get_file_sha1(file_id)):
2160
                        if file_id in merge_modified:
2161
                            del merge_modified[file_id]
2162
                    else:
2163
                        merge_modified[file_id] = new_sha1
2164
2255.2.53 by Robert Collins
Teach TreeTransform to lock basis_trees if it acquires them, fixing revert on a dirstate working tree.
2165
                    # preserve the execute bit when backing up
2166
                    if keep_content and executable[0] == executable[1]:
2167
                        tt.set_executability(executable[1], trans_id)
3376.2.11 by Martin Pool
Compare to None using is/is not not ==
2168
                elif kind[1] is not None:
3376.2.4 by Martin Pool
Remove every assert statement from bzrlib!
2169
                    raise AssertionError(kind[1])
2255.2.53 by Robert Collins
Teach TreeTransform to lock basis_trees if it acquires them, fixing revert on a dirstate working tree.
2170
            if versioned == (False, True):
2171
                tt.version_file(file_id, trans_id)
2172
            if versioned == (True, False):
2173
                tt.unversion_file(trans_id)
3363.2.25 by Aaron Bentley
More removals of post-tree support
2174
            if (name[1] is not None and 
2255.2.53 by Robert Collins
Teach TreeTransform to lock basis_trees if it acquires them, fixing revert on a dirstate working tree.
2175
                (name[0] != name[1] or parent[0] != parent[1])):
3363.2.25 by Aaron Bentley
More removals of post-tree support
2176
                tt.adjust_path(
2177
                    name[1], tt.trans_id_file_id(parent[1]), trans_id)
2255.2.53 by Robert Collins
Teach TreeTransform to lock basis_trees if it acquires them, fixing revert on a dirstate working tree.
2178
            if executable[0] != executable[1] and kind[1] == "file":
2179
                tt.set_executability(executable[1], trans_id)
2708.1.8 by Aaron Bentley
rename extract_files_bytest to iter_files_bytes, fix build_tree / progress
2180
        for (trans_id, mode_id), bytes in target_tree.iter_files_bytes(
2708.1.6 by Aaron Bentley
Turn extract_files_bytes into an iterator
2181
            deferred_files):
2182
            tt.create_file(bytes, trans_id, mode_id)
2255.2.53 by Robert Collins
Teach TreeTransform to lock basis_trees if it acquires them, fixing revert on a dirstate working tree.
2183
    finally:
2184
        if basis_tree is not None:
2185
            basis_tree.unlock()
2499.1.1 by Aaron Bentley
Revert does not try to preserve file contents produced by revert
2186
    return merge_modified
2012.1.12 by Aaron Bentley
Use iter_changes for revert
2187
2188
1966.1.1 by Aaron Bentley
Implement disk-content merge and conflict resolution for build_tree
2189
def resolve_conflicts(tt, pb=DummyProgress(), pass_func=None):
1534.7.57 by Aaron Bentley
Enhanced conflict resolution.
2190
    """Make many conflict-resolution attempts, but die if they fail"""
1966.1.1 by Aaron Bentley
Implement disk-content merge and conflict resolution for build_tree
2191
    if pass_func is None:
2192
        pass_func = conflict_pass
1534.7.169 by Aaron Bentley
Add filesystem/inventory conflicts to conflict output
2193
    new_conflicts = set()
1534.9.1 by Aaron Bentley
Added progress bars to merge
2194
    try:
2195
        for n in range(10):
2196
            pb.update('Resolution pass', n+1, 10)
2197
            conflicts = tt.find_conflicts()
2198
            if len(conflicts) == 0:
2199
                return new_conflicts
1966.1.1 by Aaron Bentley
Implement disk-content merge and conflict resolution for build_tree
2200
            new_conflicts.update(pass_func(tt, conflicts))
1534.9.1 by Aaron Bentley
Added progress bars to merge
2201
        raise MalformedTransform(conflicts=conflicts)
2202
    finally:
2203
        pb.clear()
1534.7.57 by Aaron Bentley
Enhanced conflict resolution.
2204
2205
2590.2.8 by Aaron Bentley
Restore conflict handling changes
2206
def conflict_pass(tt, conflicts, path_tree=None):
2207
    """Resolve some classes of conflicts.
2208
2209
    :param tt: The transform to resolve conflicts in
2210
    :param conflicts: The conflicts to resolve
2211
    :param path_tree: A Tree to get supplemental paths from
2212
    """
1534.7.169 by Aaron Bentley
Add filesystem/inventory conflicts to conflict output
2213
    new_conflicts = set()
1534.7.61 by Aaron Bentley
Handled parent loops, missing parents, unversioned parents
2214
    for c_type, conflict in ((c[0], c) for c in conflicts):
2215
        if c_type == 'duplicate id':
1534.7.51 by Aaron Bentley
New approach to revert
2216
            tt.unversion_file(conflict[1])
1534.7.170 by Aaron Bentley
Cleaned up filesystem conflict handling
2217
            new_conflicts.add((c_type, 'Unversioned existing file',
2218
                               conflict[1], conflict[2], ))
1534.7.61 by Aaron Bentley
Handled parent loops, missing parents, unversioned parents
2219
        elif c_type == 'duplicate':
1534.7.57 by Aaron Bentley
Enhanced conflict resolution.
2220
            # files that were renamed take precedence
2221
            final_parent = tt.final_parent(conflict[1])
2222
            if tt.path_changed(conflict[1]):
3034.4.1 by Aaron Bentley
Start handling case-insensitivity
2223
                existing_file, new_file = conflict[2], conflict[1]
1534.7.57 by Aaron Bentley
Enhanced conflict resolution.
2224
            else:
3034.4.1 by Aaron Bentley
Start handling case-insensitivity
2225
                existing_file, new_file = conflict[1], conflict[2]
2226
            new_name = tt.final_name(existing_file)+'.moved'
2227
            tt.adjust_path(new_name, final_parent, existing_file)
2228
            new_conflicts.add((c_type, 'Moved existing file to', 
2229
                               existing_file, new_file))
1534.7.61 by Aaron Bentley
Handled parent loops, missing parents, unversioned parents
2230
        elif c_type == 'parent loop':
2231
            # break the loop by undoing one of the ops that caused the loop
2232
            cur = conflict[1]
2233
            while not tt.path_changed(cur):
2234
                cur = tt.final_parent(cur)
1534.7.170 by Aaron Bentley
Cleaned up filesystem conflict handling
2235
            new_conflicts.add((c_type, 'Cancelled move', cur,
2236
                               tt.final_parent(cur),))
1534.7.61 by Aaron Bentley
Handled parent loops, missing parents, unversioned parents
2237
            tt.adjust_path(tt.final_name(cur), tt.get_tree_parent(cur), cur)
1534.7.169 by Aaron Bentley
Add filesystem/inventory conflicts to conflict output
2238
            
1534.7.61 by Aaron Bentley
Handled parent loops, missing parents, unversioned parents
2239
        elif c_type == 'missing parent':
1534.7.128 by Aaron Bentley
Got missing contents test working
2240
            trans_id = conflict[1]
2241
            try:
2242
                tt.cancel_deletion(trans_id)
1551.8.22 by Aaron Bentley
Improve message when OTHER deletes an in-use tree
2243
                new_conflicts.add(('deleting parent', 'Not deleting', 
2244
                                   trans_id))
1534.7.128 by Aaron Bentley
Got missing contents test working
2245
            except KeyError:
1551.19.32 by Aaron Bentley
Don't traceback when adding files to a deleted root (abentley, #210092)
2246
                create = True
2590.2.8 by Aaron Bentley
Restore conflict handling changes
2247
                try:
2248
                    tt.final_name(trans_id)
2249
                except NoFinalPath:
1551.19.6 by Aaron Bentley
Revert doesn't crash restoring a file from a deleted directory
2250
                    if path_tree is not None:
2251
                        file_id = tt.final_file_id(trans_id)
1551.19.32 by Aaron Bentley
Don't traceback when adding files to a deleted root (abentley, #210092)
2252
                        if file_id is None:
2253
                            file_id = tt.inactive_file_id(trans_id)
1551.19.6 by Aaron Bentley
Revert doesn't crash restoring a file from a deleted directory
2254
                        entry = path_tree.inventory[file_id]
1551.19.32 by Aaron Bentley
Don't traceback when adding files to a deleted root (abentley, #210092)
2255
                        # special-case the other tree root (move its
2256
                        # children to current root)
2257
                        if entry.parent_id is None:
2258
                            create=False
2259
                            moved = _reparent_transform_children(
2260
                                tt, trans_id, tt.root)
2261
                            for child in moved:
2262
                                new_conflicts.add((c_type, 'Moved to root',
2263
                                                   child))
2264
                        else:
2265
                            parent_trans_id = tt.trans_id_file_id(
2266
                                entry.parent_id)
2267
                            tt.adjust_path(entry.name, parent_trans_id,
2268
                                           trans_id)
2269
                if create:
2270
                    tt.create_directory(trans_id)
2271
                    new_conflicts.add((c_type, 'Created directory', trans_id))
1534.7.61 by Aaron Bentley
Handled parent loops, missing parents, unversioned parents
2272
        elif c_type == 'unversioned parent':
1551.19.32 by Aaron Bentley
Don't traceback when adding files to a deleted root (abentley, #210092)
2273
            file_id = tt.inactive_file_id(conflict[1])
2274
            # special-case the other tree root (move its children instead)
2275
            if path_tree and file_id in path_tree:
2276
                if path_tree.inventory[file_id].parent_id is None:
2277
                    continue
2278
            tt.version_file(file_id, conflict[1])
1534.7.171 by Aaron Bentley
Implemented stringifying filesystem conflicts
2279
            new_conflicts.add((c_type, 'Versioned directory', conflict[1]))
3144.4.2 by Aaron Bentley
Handle non-directory parent conflicts (abentley, #177390)
2280
        elif c_type == 'non-directory parent':
2281
            parent_id = conflict[1]
2282
            parent_parent = tt.final_parent(parent_id)
2283
            parent_name = tt.final_name(parent_id)
2284
            parent_file_id = tt.final_file_id(parent_id)
2285
            new_parent_id = tt.new_directory(parent_name + '.new',
2286
                parent_parent, parent_file_id)
2287
            _reparent_transform_children(tt, parent_id, new_parent_id)
3146.8.19 by Aaron Bentley
Merge with bzr.dev
2288
            if parent_file_id is not None:
2289
                tt.unversion_file(parent_id)
3144.4.2 by Aaron Bentley
Handle non-directory parent conflicts (abentley, #177390)
2290
            new_conflicts.add((c_type, 'Created directory', new_parent_id))
1534.7.169 by Aaron Bentley
Add filesystem/inventory conflicts to conflict output
2291
    return new_conflicts
2292
1666.1.4 by Robert Collins
* 'Metadir' is now the default disk format. This improves behaviour in
2293
1534.7.169 by Aaron Bentley
Add filesystem/inventory conflicts to conflict output
2294
def cook_conflicts(raw_conflicts, tt):
1534.7.170 by Aaron Bentley
Cleaned up filesystem conflict handling
2295
    """Generate a list of cooked conflicts, sorted by file path"""
1666.1.4 by Robert Collins
* 'Metadir' is now the default disk format. This improves behaviour in
2296
    from bzrlib.conflicts import Conflict
2297
    conflict_iter = iter_cook_conflicts(raw_conflicts, tt)
2298
    return sorted(conflict_iter, key=Conflict.sort_key)
1534.7.170 by Aaron Bentley
Cleaned up filesystem conflict handling
2299
1534.7.169 by Aaron Bentley
Add filesystem/inventory conflicts to conflict output
2300
2301
def iter_cook_conflicts(raw_conflicts, tt):
1534.10.19 by Aaron Bentley
Stanza conversion, cooking
2302
    from bzrlib.conflicts import Conflict
1534.7.170 by Aaron Bentley
Cleaned up filesystem conflict handling
2303
    fp = FinalPaths(tt)
1534.7.169 by Aaron Bentley
Add filesystem/inventory conflicts to conflict output
2304
    for conflict in raw_conflicts:
2305
        c_type = conflict[0]
1534.7.170 by Aaron Bentley
Cleaned up filesystem conflict handling
2306
        action = conflict[1]
2307
        modified_path = fp.get_path(conflict[2])
2308
        modified_id = tt.final_file_id(conflict[2])
2309
        if len(conflict) == 3:
1534.10.19 by Aaron Bentley
Stanza conversion, cooking
2310
            yield Conflict.factory(c_type, action=action, path=modified_path,
2311
                                     file_id=modified_id)
2312
             
1534.7.170 by Aaron Bentley
Cleaned up filesystem conflict handling
2313
        else:
2314
            conflicting_path = fp.get_path(conflict[3])
2315
            conflicting_id = tt.final_file_id(conflict[3])
1534.10.19 by Aaron Bentley
Stanza conversion, cooking
2316
            yield Conflict.factory(c_type, action=action, path=modified_path,
2317
                                   file_id=modified_id, 
2318
                                   conflict_path=conflicting_path,
2319
                                   conflict_file_id=conflicting_id)
2733.2.1 by Aaron Bentley
Implement FileMover, to support TreeTransform rollback
2320
2321
2322
class _FileMover(object):
2733.2.9 by Aaron Bentley
Update docstrings
2323
    """Moves and deletes files for TreeTransform, tracking operations"""
2733.2.1 by Aaron Bentley
Implement FileMover, to support TreeTransform rollback
2324
2325
    def __init__(self):
2326
        self.past_renames = []
2733.2.5 by Aaron Bentley
Implement FileMover.pre_delete and FileMover.apply_deletions
2327
        self.pending_deletions = []
2733.2.1 by Aaron Bentley
Implement FileMover, to support TreeTransform rollback
2328
2329
    def rename(self, from_, to):
2733.2.9 by Aaron Bentley
Update docstrings
2330
        """Rename a file from one path to another.  Functions like os.rename"""
3063.1.1 by Alexander Belchenko
Catch OSError 17 (file exists) in final phase of tree transform and show filename to user (#111758).
2331
        try:
2332
            os.rename(from_, to)
2333
        except OSError, e:
3063.1.3 by Aaron Bentley
Update for Linux
2334
            if e.errno in (errno.EEXIST, errno.ENOTEMPTY):
3063.1.1 by Alexander Belchenko
Catch OSError 17 (file exists) in final phase of tree transform and show filename to user (#111758).
2335
                raise errors.FileExists(to, str(e))
2336
            raise
2733.2.1 by Aaron Bentley
Implement FileMover, to support TreeTransform rollback
2337
        self.past_renames.append((from_, to))
2338
2733.2.5 by Aaron Bentley
Implement FileMover.pre_delete and FileMover.apply_deletions
2339
    def pre_delete(self, from_, to):
2733.2.9 by Aaron Bentley
Update docstrings
2340
        """Rename a file out of the way and mark it for deletion.
2341
2342
        Unlike os.unlink, this works equally well for files and directories.
2343
        :param from_: The current file path
2344
        :param to: A temporary path for the file
2345
        """
2733.2.5 by Aaron Bentley
Implement FileMover.pre_delete and FileMover.apply_deletions
2346
        self.rename(from_, to)
2347
        self.pending_deletions.append(to)
2348
2733.2.1 by Aaron Bentley
Implement FileMover, to support TreeTransform rollback
2349
    def rollback(self):
2733.2.9 by Aaron Bentley
Update docstrings
2350
        """Reverse all renames that have been performed"""
2733.2.1 by Aaron Bentley
Implement FileMover, to support TreeTransform rollback
2351
        for from_, to in reversed(self.past_renames):
2352
            os.rename(to, from_)
2733.2.12 by Aaron Bentley
Updates from review
2353
        # after rollback, don't reuse _FileMover
2354
        past_renames = None
2355
        pending_deletions = None
2733.2.5 by Aaron Bentley
Implement FileMover.pre_delete and FileMover.apply_deletions
2356
2357
    def apply_deletions(self):
2733.2.9 by Aaron Bentley
Update docstrings
2358
        """Apply all marked deletions"""
2733.2.5 by Aaron Bentley
Implement FileMover.pre_delete and FileMover.apply_deletions
2359
        for path in self.pending_deletions:
2360
            delete_any(path)
2733.2.12 by Aaron Bentley
Updates from review
2361
        # after apply_deletions, don't reuse _FileMover
2362
        past_renames = None
2363
        pending_deletions = None