← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/transform.py

(jelmer) Migrate launchpad plugin configuration to config stacks API.
 (Jelmer Vernooij)

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/transform.py
1
 
# Copyright (C) 2006, 2007 Canonical Ltd
 
1
# Copyright (C) 2006-2011 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
12
12
#
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
16
 
 
17
from __future__ import absolute_import
16
18
 
17
19
import os
18
20
import errno
19
 
from stat import S_ISREG
 
21
from stat import S_ISREG, S_IEXEC
 
22
import time
20
23
 
21
 
from bzrlib.lazy_import import lazy_import
22
 
lazy_import(globals(), """
23
 
from bzrlib import (
24
 
    bzrdir,
 
24
from bzrlib import (
 
25
    config as _mod_config,
 
26
    errors,
 
27
    lazy_import,
 
28
    registry,
 
29
    trace,
 
30
    tree,
 
31
    )
 
32
lazy_import.lazy_import(globals(), """
 
33
from bzrlib import (
 
34
    annotate,
 
35
    bencode,
 
36
    controldir,
 
37
    commit,
 
38
    conflicts,
25
39
    delta,
26
 
    errors,
27
 
    inventory
 
40
    inventory,
 
41
    multiparent,
 
42
    osutils,
 
43
    revision as _mod_revision,
 
44
    ui,
 
45
    urlutils,
28
46
    )
 
47
from bzrlib.i18n import gettext
29
48
""")
30
 
from bzrlib.errors import (DuplicateKey, MalformedTransform, NoSuchFile,
31
 
                           ReusingTransform, NotVersionedError, CantMoveRoot,
32
 
                           ExistingLimbo, ImmortalLimbo, NoFinalPath)
33
 
from bzrlib.inventory import InventoryEntry
34
 
from bzrlib.osutils import (file_kind, supports_executable, pathjoin, lexists,
35
 
                            delete_any)
36
 
from bzrlib.progress import DummyProgress, ProgressPhase
 
49
from bzrlib.errors import (DuplicateKey, MalformedTransform,
 
50
                           ReusingTransform, CantMoveRoot,
 
51
                           ImmortalLimbo, NoFinalPath,
 
52
                           UnableCreateSymlink)
 
53
from bzrlib.filters import filtered_output_bytes, ContentFilterContext
 
54
from bzrlib.mutabletree import MutableTree
 
55
from bzrlib.osutils import (
 
56
    delete_any,
 
57
    file_kind,
 
58
    has_symlinks,
 
59
    pathjoin,
 
60
    sha_file,
 
61
    splitpath,
 
62
    )
 
63
from bzrlib.progress import ProgressPhase
37
64
from bzrlib.symbol_versioning import (
38
 
        deprecated_function,
39
 
        zero_fifteen,
40
 
        zero_ninety,
41
 
        )
42
 
from bzrlib.trace import mutter, warning
43
 
from bzrlib import tree
44
 
import bzrlib.ui
45
 
import bzrlib.urlutils as urlutils
 
65
    deprecated_function,
 
66
    deprecated_in,
 
67
    deprecated_method,
 
68
    )
46
69
 
47
70
 
48
71
ROOT_PARENT = "root-parent"
49
72
 
50
 
 
51
73
def unique_add(map, key, value):
52
74
    if key in map:
53
75
        raise DuplicateKey(key=key)
54
76
    map[key] = value
55
77
 
56
78
 
 
79
 
57
80
class _TransformResults(object):
58
81
    def __init__(self, modified_paths, rename_count):
59
82
        object.__init__(self)
61
84
        self.rename_count = rename_count
62
85
 
63
86
 
64
 
class TreeTransform(object):
65
 
    """Represent a tree transformation.
66
 
    
67
 
    This object is designed to support incremental generation of the transform,
68
 
    in any order.
69
 
 
70
 
    However, it gives optimum performance when parent directories are created
71
 
    before their contents.  The transform is then able to put child files
72
 
    directly in their parent directory, avoiding later renames.
73
 
    
74
 
    It is easy to produce malformed transforms, but they are generally
75
 
    harmless.  Attempting to apply a malformed transform will cause an
76
 
    exception to be raised before any modifications are made to the tree.  
77
 
 
78
 
    Many kinds of malformed transforms can be corrected with the 
79
 
    resolve_conflicts function.  The remaining ones indicate programming error,
80
 
    such as trying to create a file with no path.
81
 
 
82
 
    Two sets of file creation methods are supplied.  Convenience methods are:
83
 
     * new_file
84
 
     * new_directory
85
 
     * new_symlink
86
 
 
87
 
    These are composed of the low-level methods:
88
 
     * create_path
89
 
     * create_file or create_directory or create_symlink
90
 
     * version_file
91
 
     * set_executability
92
 
    """
93
 
    def __init__(self, tree, pb=DummyProgress()):
94
 
        """Note: a tree_write lock is taken on the tree.
95
 
        
96
 
        Use TreeTransform.finalize() to release the lock (can be omitted if
97
 
        TreeTransform.apply() called).
 
87
class TreeTransformBase(object):
 
88
    """The base class for TreeTransform and its kin."""
 
89
 
 
90
    def __init__(self, tree, pb=None,
 
91
                 case_sensitive=True):
 
92
        """Constructor.
 
93
 
 
94
        :param tree: The tree that will be transformed, but not necessarily
 
95
            the output tree.
 
96
        :param pb: ignored
 
97
        :param case_sensitive: If True, the target of the transform is
 
98
            case sensitive, not just case preserving.
98
99
        """
99
100
        object.__init__(self)
100
101
        self._tree = tree
101
 
        self._tree.lock_tree_write()
102
 
        try:
103
 
            control_files = self._tree._control_files
104
 
            self._limbodir = urlutils.local_path_from_url(
105
 
                control_files.controlfilename('limbo'))
106
 
            try:
107
 
                os.mkdir(self._limbodir)
108
 
            except OSError, e:
109
 
                if e.errno == errno.EEXIST:
110
 
                    raise ExistingLimbo(self._limbodir)
111
 
            self._deletiondir = urlutils.local_path_from_url(
112
 
                control_files.controlfilename('pending-deletion'))
113
 
            try:
114
 
                os.mkdir(self._deletiondir)
115
 
            except OSError, e:
116
 
                if e.errno == errno.EEXIST:
117
 
                    raise errors.ExistingPendingDeletion(self._deletiondir)
118
 
 
119
 
        except: 
120
 
            self._tree.unlock()
121
 
            raise
122
 
 
123
102
        self._id_number = 0
 
103
        # mapping of trans_id -> new basename
124
104
        self._new_name = {}
 
105
        # mapping of trans_id -> new parent trans_id
125
106
        self._new_parent = {}
 
107
        # mapping of trans_id with new contents -> new file_kind
126
108
        self._new_contents = {}
127
 
        # A mapping of transform ids to their limbo filename
128
 
        self._limbo_files = {}
129
 
        # A mapping of transform ids to a set of the transform ids of children
130
 
        # that their limbo directory has
131
 
        self._limbo_children = {}
132
 
        # Map transform ids to maps of child filename to child transform id
133
 
        self._limbo_children_names = {}
134
 
        # List of transform ids that need to be renamed from limbo into place
135
 
        self._needs_rename = set()
 
109
        # mapping of trans_id => (sha1 of content, stat_value)
 
110
        self._observed_sha1s = {}
 
111
        # Set of trans_ids whose contents will be removed
136
112
        self._removed_contents = set()
 
113
        # Mapping of trans_id -> new execute-bit value
137
114
        self._new_executability = {}
 
115
        # Mapping of trans_id -> new tree-reference value
138
116
        self._new_reference_revision = {}
 
117
        # Mapping of trans_id -> new file_id
139
118
        self._new_id = {}
 
119
        # Mapping of old file-id -> trans_id
140
120
        self._non_present_ids = {}
 
121
        # Mapping of new file_id -> trans_id
141
122
        self._r_new_id = {}
 
123
        # Set of trans_ids that will be removed
142
124
        self._removed_id = set()
 
125
        # Mapping of path in old tree -> trans_id
143
126
        self._tree_path_ids = {}
 
127
        # Mapping trans_id -> path in old tree
144
128
        self._tree_id_paths = {}
145
 
        # Cache of realpath results, to speed up canonical_path
146
 
        self._realpaths = {}
147
 
        # Cache of relpath results, to speed up canonical_path
148
 
        self._relpaths = {}
149
 
        self._new_root = self.trans_id_tree_file_id(tree.get_root_id())
150
 
        self.__done = False
 
129
        # The trans_id that will be used as the tree root
 
130
        root_id = tree.get_root_id()
 
131
        if root_id is not None:
 
132
            self._new_root = self.trans_id_tree_file_id(root_id)
 
133
        else:
 
134
            self._new_root = None
 
135
        # Indicator of whether the transform has been applied
 
136
        self._done = False
 
137
        # A progress bar
151
138
        self._pb = pb
 
139
        # Whether the target is case sensitive
 
140
        self._case_sensitive_target = case_sensitive
 
141
        # A counter of how many files have been renamed
152
142
        self.rename_count = 0
153
143
 
 
144
    def __enter__(self):
 
145
        """Support Context Manager API."""
 
146
        return self
 
147
 
 
148
    def __exit__(self, exc_type, exc_val, exc_tb):
 
149
        """Support Context Manager API."""
 
150
        self.finalize()
 
151
 
 
152
    def finalize(self):
 
153
        """Release the working tree lock, if held.
 
154
 
 
155
        This is required if apply has not been invoked, but can be invoked
 
156
        even after apply.
 
157
        """
 
158
        if self._tree is None:
 
159
            return
 
160
        for hook in MutableTree.hooks['post_transform']:
 
161
            hook(self._tree, self)
 
162
        self._tree.unlock()
 
163
        self._tree = None
 
164
 
154
165
    def __get_root(self):
155
166
        return self._new_root
156
167
 
157
168
    root = property(__get_root)
158
169
 
159
 
    def finalize(self):
160
 
        """Release the working tree lock, if held, clean up limbo dir.
161
 
 
162
 
        This is required if apply has not been invoked, but can be invoked
163
 
        even after apply.
164
 
        """
165
 
        if self._tree is None:
166
 
            return
167
 
        try:
168
 
            entries = [(self._limbo_name(t), t, k) for t, k in
169
 
                       self._new_contents.iteritems()]
170
 
            entries.sort(reverse=True)
171
 
            for path, trans_id, kind in entries:
172
 
                if kind == "directory":
173
 
                    os.rmdir(path)
174
 
                else:
175
 
                    os.unlink(path)
176
 
            try:
177
 
                os.rmdir(self._limbodir)
178
 
            except OSError:
179
 
                # We don't especially care *why* the dir is immortal.
180
 
                raise ImmortalLimbo(self._limbodir)
181
 
            try:
182
 
                os.rmdir(self._deletiondir)
183
 
            except OSError:
184
 
                raise errors.ImmortalPendingDeletion(self._deletiondir)
185
 
        finally:
186
 
            self._tree.unlock()
187
 
            self._tree = None
188
 
 
189
170
    def _assign_id(self):
190
171
        """Produce a new tranform id"""
191
172
        new_id = "new-%s" % self._id_number
201
182
 
202
183
    def adjust_path(self, name, parent, trans_id):
203
184
        """Change the path that is assigned to a transaction id."""
 
185
        if parent is None:
 
186
            raise ValueError("Parent trans-id may not be None")
204
187
        if trans_id == self._new_root:
205
188
            raise CantMoveRoot
206
 
        previous_parent = self._new_parent.get(trans_id)
207
 
        previous_name = self._new_name.get(trans_id)
208
189
        self._new_name[trans_id] = name
209
190
        self._new_parent[trans_id] = parent
210
 
        if (trans_id in self._limbo_files and
211
 
            trans_id not in self._needs_rename):
212
 
            self._rename_in_limbo([trans_id])
213
 
            self._limbo_children[previous_parent].remove(trans_id)
214
 
            del self._limbo_children_names[previous_parent][previous_name]
215
 
 
216
 
    def _rename_in_limbo(self, trans_ids):
217
 
        """Fix limbo names so that the right final path is produced.
218
 
 
219
 
        This means we outsmarted ourselves-- we tried to avoid renaming
220
 
        these files later by creating them with their final names in their
221
 
        final parents.  But now the previous name or parent is no longer
222
 
        suitable, so we have to rename them.
223
 
 
224
 
        Even for trans_ids that have no new contents, we must remove their
225
 
        entries from _limbo_files, because they are now stale.
226
 
        """
227
 
        for trans_id in trans_ids:
228
 
            old_path = self._limbo_files.pop(trans_id)
229
 
            if trans_id not in self._new_contents:
230
 
                continue
231
 
            new_path = self._limbo_name(trans_id)
232
 
            os.rename(old_path, new_path)
233
191
 
234
192
    def adjust_root_path(self, name, parent):
235
193
        """Emulate moving the root by moving all children, instead.
236
 
        
 
194
 
237
195
        We do this by undoing the association of root's transaction id with the
238
196
        current tree.  This allows us to create a new directory with that
239
 
        transaction id.  We unversion the root directory and version the 
 
197
        transaction id.  We unversion the root directory and version the
240
198
        physically new directory, and hope someone versions the tree root
241
199
        later.
242
200
        """
245
203
        # force moving all children of root
246
204
        for child_id in self.iter_tree_children(old_root):
247
205
            if child_id != parent:
248
 
                self.adjust_path(self.final_name(child_id), 
 
206
                self.adjust_path(self.final_name(child_id),
249
207
                                 self.final_parent(child_id), child_id)
250
208
            file_id = self.final_file_id(child_id)
251
209
            if file_id is not None:
252
210
                self.unversion_file(child_id)
253
211
            self.version_file(file_id, child_id)
254
 
        
 
212
 
255
213
        # the physical root needs a new transaction id
256
214
        self._tree_path_ids.pop("")
257
215
        self._tree_id_paths.pop(old_root)
263
221
        self.version_file(old_root_file_id, old_root)
264
222
        self.unversion_file(self._new_root)
265
223
 
 
224
    def fixup_new_roots(self):
 
225
        """Reinterpret requests to change the root directory
 
226
 
 
227
        Instead of creating a root directory, or moving an existing directory,
 
228
        all the attributes and children of the new root are applied to the
 
229
        existing root directory.
 
230
 
 
231
        This means that the old root trans-id becomes obsolete, so it is
 
232
        recommended only to invoke this after the root trans-id has become
 
233
        irrelevant.
 
234
 
 
235
        """
 
236
        new_roots = [k for k, v in self._new_parent.iteritems() if v ==
 
237
                     ROOT_PARENT]
 
238
        if len(new_roots) < 1:
 
239
            return
 
240
        if len(new_roots) != 1:
 
241
            raise ValueError('A tree cannot have two roots!')
 
242
        if self._new_root is None:
 
243
            self._new_root = new_roots[0]
 
244
            return
 
245
        old_new_root = new_roots[0]
 
246
        # unversion the new root's directory.
 
247
        if self.final_kind(self._new_root) is None:
 
248
            file_id = self.final_file_id(old_new_root)
 
249
        else:
 
250
            file_id = self.final_file_id(self._new_root)
 
251
        if old_new_root in self._new_id:
 
252
            self.cancel_versioning(old_new_root)
 
253
        else:
 
254
            self.unversion_file(old_new_root)
 
255
        # if, at this stage, root still has an old file_id, zap it so we can
 
256
        # stick a new one in.
 
257
        if (self.tree_file_id(self._new_root) is not None and
 
258
            self._new_root not in self._removed_id):
 
259
            self.unversion_file(self._new_root)
 
260
        if file_id is not None:
 
261
            self.version_file(file_id, self._new_root)
 
262
 
 
263
        # Now move children of new root into old root directory.
 
264
        # Ensure all children are registered with the transaction, but don't
 
265
        # use directly-- some tree children have new parents
 
266
        list(self.iter_tree_children(old_new_root))
 
267
        # Move all children of new root into old root directory.
 
268
        for child in self.by_parent().get(old_new_root, []):
 
269
            self.adjust_path(self.final_name(child), self._new_root, child)
 
270
 
 
271
        # Ensure old_new_root has no directory.
 
272
        if old_new_root in self._new_contents:
 
273
            self.cancel_creation(old_new_root)
 
274
        else:
 
275
            self.delete_contents(old_new_root)
 
276
 
 
277
        # prevent deletion of root directory.
 
278
        if self._new_root in self._removed_contents:
 
279
            self.cancel_deletion(self._new_root)
 
280
 
 
281
        # destroy path info for old_new_root.
 
282
        del self._new_parent[old_new_root]
 
283
        del self._new_name[old_new_root]
 
284
 
266
285
    def trans_id_tree_file_id(self, inventory_id):
267
286
        """Determine the transaction id of a working tree file.
268
 
        
 
287
 
269
288
        This reflects only files that already exist, not ones that will be
270
289
        added by transactions.
271
290
        """
272
 
        path = self._tree.inventory.id2path(inventory_id)
 
291
        if inventory_id is None:
 
292
            raise ValueError('None is not a valid file id')
 
293
        path = self._tree.id2path(inventory_id)
273
294
        return self.trans_id_tree_path(path)
274
295
 
275
296
    def trans_id_file_id(self, file_id):
278
299
        a transaction has been unversioned, it is deliberately still returned.
279
300
        (this will likely lead to an unversioned parent conflict.)
280
301
        """
 
302
        if file_id is None:
 
303
            raise ValueError('None is not a valid file id')
281
304
        if file_id in self._r_new_id and self._r_new_id[file_id] is not None:
282
305
            return self._r_new_id[file_id]
283
 
        elif file_id in self._tree.inventory:
284
 
            return self.trans_id_tree_file_id(file_id)
285
 
        elif file_id in self._non_present_ids:
286
 
            return self._non_present_ids[file_id]
287
 
        else:
288
 
            trans_id = self._assign_id()
289
 
            self._non_present_ids[file_id] = trans_id
290
 
            return trans_id
291
 
 
292
 
    def canonical_path(self, path):
293
 
        """Get the canonical tree-relative path"""
294
 
        # don't follow final symlinks
295
 
        abs = self._tree.abspath(path)
296
 
        if abs in self._relpaths:
297
 
            return self._relpaths[abs]
298
 
        dirname, basename = os.path.split(abs)
299
 
        if dirname not in self._realpaths:
300
 
            self._realpaths[dirname] = os.path.realpath(dirname)
301
 
        dirname = self._realpaths[dirname]
302
 
        abs = pathjoin(dirname, basename)
303
 
        if dirname in self._relpaths:
304
 
            relpath = pathjoin(self._relpaths[dirname], basename)
305
 
            relpath = relpath.rstrip('/\\')
306
 
        else:
307
 
            relpath = self._tree.relpath(abs)
308
 
        self._relpaths[abs] = relpath
309
 
        return relpath
 
306
        else:
 
307
            try:
 
308
                self._tree.iter_entries_by_dir([file_id]).next()
 
309
            except StopIteration:
 
310
                if file_id in self._non_present_ids:
 
311
                    return self._non_present_ids[file_id]
 
312
                else:
 
313
                    trans_id = self._assign_id()
 
314
                    self._non_present_ids[file_id] = trans_id
 
315
                    return trans_id
 
316
            else:
 
317
                return self.trans_id_tree_file_id(file_id)
310
318
 
311
319
    def trans_id_tree_path(self, path):
312
320
        """Determine (and maybe set) the transaction ID for a tree path."""
323
331
            return ROOT_PARENT
324
332
        return self.trans_id_tree_path(os.path.dirname(path))
325
333
 
326
 
    def create_file(self, contents, trans_id, mode_id=None):
327
 
        """Schedule creation of a new file.
328
 
 
329
 
        See also new_file.
330
 
        
331
 
        Contents is an iterator of strings, all of which will be written
332
 
        to the target destination.
333
 
 
334
 
        New file takes the permissions of any existing file with that id,
335
 
        unless mode_id is specified.
336
 
        """
337
 
        name = self._limbo_name(trans_id)
338
 
        f = open(name, 'wb')
339
 
        try:
340
 
            try:
341
 
                unique_add(self._new_contents, trans_id, 'file')
342
 
            except:
343
 
                # Clean up the file, it never got registered so
344
 
                # TreeTransform.finalize() won't clean it up.
345
 
                f.close()
346
 
                os.unlink(name)
347
 
                raise
348
 
 
349
 
            f.writelines(contents)
350
 
        finally:
351
 
            f.close()
352
 
        self._set_mode(trans_id, mode_id, S_ISREG)
353
 
 
354
 
    def _set_mode(self, trans_id, mode_id, typefunc):
355
 
        """Set the mode of new file contents.
356
 
        The mode_id is the existing file to get the mode from (often the same
357
 
        as trans_id).  The operation is only performed if there's a mode match
358
 
        according to typefunc.
359
 
        """
360
 
        if mode_id is None:
361
 
            mode_id = trans_id
362
 
        try:
363
 
            old_path = self._tree_id_paths[mode_id]
364
 
        except KeyError:
365
 
            return
366
 
        try:
367
 
            mode = os.stat(self._tree.abspath(old_path)).st_mode
368
 
        except OSError, e:
369
 
            if e.errno == errno.ENOENT:
370
 
                return
371
 
            else:
372
 
                raise
373
 
        if typefunc(mode):
374
 
            os.chmod(self._limbo_name(trans_id), mode)
375
 
 
376
 
    def create_directory(self, trans_id):
377
 
        """Schedule creation of a new directory.
378
 
        
379
 
        See also new_directory.
380
 
        """
381
 
        os.mkdir(self._limbo_name(trans_id))
382
 
        unique_add(self._new_contents, trans_id, 'directory')
383
 
 
384
 
    def create_symlink(self, target, trans_id):
385
 
        """Schedule creation of a new symbolic link.
386
 
 
387
 
        target is a bytestring.
388
 
        See also new_symlink.
389
 
        """
390
 
        os.symlink(target, self._limbo_name(trans_id))
391
 
        unique_add(self._new_contents, trans_id, 'symlink')
392
 
 
393
 
    def cancel_creation(self, trans_id):
394
 
        """Cancel the creation of new file contents."""
395
 
        del self._new_contents[trans_id]
396
 
        children = self._limbo_children.get(trans_id)
397
 
        # if this is a limbo directory with children, move them before removing
398
 
        # the directory
399
 
        if children is not None:
400
 
            self._rename_in_limbo(children)
401
 
            del self._limbo_children[trans_id]
402
 
            del self._limbo_children_names[trans_id]
403
 
        delete_any(self._limbo_name(trans_id))
404
 
 
405
334
    def delete_contents(self, trans_id):
406
335
        """Schedule the contents of a path entry for deletion"""
407
 
        self.tree_kind(trans_id)
408
 
        self._removed_contents.add(trans_id)
 
336
        kind = self.tree_kind(trans_id)
 
337
        if kind is not None:
 
338
            self._removed_contents.add(trans_id)
409
339
 
410
340
    def cancel_deletion(self, trans_id):
411
341
        """Cancel a scheduled deletion"""
435
365
 
436
366
    def version_file(self, file_id, trans_id):
437
367
        """Schedule a file to become versioned."""
438
 
        assert file_id is not None
 
368
        if file_id is None:
 
369
            raise ValueError()
439
370
        unique_add(self._new_id, trans_id, file_id)
440
371
        unique_add(self._r_new_id, file_id, trans_id)
441
372
 
445
376
        del self._new_id[trans_id]
446
377
        del self._r_new_id[file_id]
447
378
 
448
 
    def new_paths(self):
449
 
        """Determine the paths of all new and changed files"""
 
379
    def new_paths(self, filesystem_only=False):
 
380
        """Determine the paths of all new and changed files.
 
381
 
 
382
        :param filesystem_only: if True, only calculate values for files
 
383
            that require renames or execute bit changes.
 
384
        """
450
385
        new_ids = set()
451
 
        fp = FinalPaths(self)
452
 
        for id_set in (self._new_name, self._new_parent, self._new_contents,
453
 
                       self._new_id, self._new_executability):
 
386
        if filesystem_only:
 
387
            stale_ids = self._needs_rename.difference(self._new_name)
 
388
            stale_ids.difference_update(self._new_parent)
 
389
            stale_ids.difference_update(self._new_contents)
 
390
            stale_ids.difference_update(self._new_id)
 
391
            needs_rename = self._needs_rename.difference(stale_ids)
 
392
            id_sets = (needs_rename, self._new_executability)
 
393
        else:
 
394
            id_sets = (self._new_name, self._new_parent, self._new_contents,
 
395
                       self._new_id, self._new_executability)
 
396
        for id_set in id_sets:
454
397
            new_ids.update(id_set)
455
 
        new_paths = [(fp.get_path(t), t) for t in new_ids]
456
 
        new_paths.sort()
457
 
        return new_paths
458
 
 
459
 
    def tree_kind(self, trans_id):
460
 
        """Determine the file kind in the working tree.
461
 
 
462
 
        Raises NoSuchFile if the file does not exist
 
398
        return sorted(FinalPaths(self).get_paths(new_ids))
 
399
 
 
400
    def _inventory_altered(self):
 
401
        """Determine which trans_ids need new Inventory entries.
 
402
 
 
403
        An new entry is needed when anything that would be reflected by an
 
404
        inventory entry changes, including file name, file_id, parent file_id,
 
405
        file kind, and the execute bit.
 
406
 
 
407
        Some care is taken to return entries with real changes, not cases
 
408
        where the value is deleted and then restored to its original value,
 
409
        but some actually unchanged values may be returned.
 
410
 
 
411
        :returns: A list of (path, trans_id) for all items requiring an
 
412
            inventory change. Ordered by path.
463
413
        """
464
 
        path = self._tree_id_paths.get(trans_id)
465
 
        if path is None:
466
 
            raise NoSuchFile(None)
467
 
        try:
468
 
            return file_kind(self._tree.abspath(path))
469
 
        except OSError, e:
470
 
            if e.errno != errno.ENOENT:
471
 
                raise
472
 
            else:
473
 
                raise NoSuchFile(path)
 
414
        changed_ids = set()
 
415
        # Find entries whose file_ids are new (or changed).
 
416
        new_file_id = set(t for t in self._new_id
 
417
                          if self._new_id[t] != self.tree_file_id(t))
 
418
        for id_set in [self._new_name, self._new_parent, new_file_id,
 
419
                       self._new_executability]:
 
420
            changed_ids.update(id_set)
 
421
        # removing implies a kind change
 
422
        changed_kind = set(self._removed_contents)
 
423
        # so does adding
 
424
        changed_kind.intersection_update(self._new_contents)
 
425
        # Ignore entries that are already known to have changed.
 
426
        changed_kind.difference_update(changed_ids)
 
427
        #  to keep only the truly changed ones
 
428
        changed_kind = (t for t in changed_kind
 
429
                        if self.tree_kind(t) != self.final_kind(t))
 
430
        # all kind changes will alter the inventory
 
431
        changed_ids.update(changed_kind)
 
432
        # To find entries with changed parent_ids, find parents which existed,
 
433
        # but changed file_id.
 
434
        changed_file_id = set(t for t in new_file_id if t in self._removed_id)
 
435
        # Now add all their children to the set.
 
436
        for parent_trans_id in new_file_id:
 
437
            changed_ids.update(self.iter_tree_children(parent_trans_id))
 
438
        return sorted(FinalPaths(self).get_paths(changed_ids))
474
439
 
475
440
    def final_kind(self, trans_id):
476
441
        """Determine the final file kind, after any changes applied.
477
 
        
478
 
        Raises NoSuchFile if the file does not exist/has no contents.
479
 
        (It is conceivable that a path would be created without the
480
 
        corresponding contents insertion command)
 
442
 
 
443
        :return: None if the file does not exist/has no contents.  (It is
 
444
            conceivable that a path would be created without the corresponding
 
445
            contents insertion command)
481
446
        """
482
447
        if trans_id in self._new_contents:
483
448
            return self._new_contents[trans_id]
484
449
        elif trans_id in self._removed_contents:
485
 
            raise NoSuchFile(None)
 
450
            return None
486
451
        else:
487
452
            return self.tree_kind(trans_id)
488
453
 
495
460
            return None
496
461
        # the file is old; the old id is still valid
497
462
        if self._new_root == trans_id:
498
 
            return self._tree.inventory.root.file_id
499
 
        return self._tree.inventory.path2id(path)
 
463
            return self._tree.get_root_id()
 
464
        return self._tree.path2id(path)
500
465
 
501
466
    def final_file_id(self, trans_id):
502
467
        """Determine the file id after any changes are applied, or None.
503
 
        
 
468
 
504
469
        None indicates that the file will not be versioned after changes are
505
470
        applied.
506
471
        """
507
472
        try:
508
 
            # there is a new id for this file
509
 
            assert self._new_id[trans_id] is not None
510
473
            return self._new_id[trans_id]
511
474
        except KeyError:
512
475
            if trans_id in self._removed_id:
547
510
 
548
511
    def by_parent(self):
549
512
        """Return a map of parent: children for known parents.
550
 
        
 
513
 
551
514
        Only new paths and parents of tree files with assigned ids are used.
552
515
        """
553
516
        by_parent = {}
554
517
        items = list(self._new_parent.iteritems())
555
 
        items.extend((t, self.final_parent(t)) for t in 
 
518
        items.extend((t, self.final_parent(t)) for t in
556
519
                      self._tree_id_paths.keys())
557
520
        for trans_id, parent_id in items:
558
521
            if parent_id not in by_parent:
569
532
 
570
533
    def find_conflicts(self):
571
534
        """Find any violations of inventory or filesystem invariants"""
572
 
        if self.__done is True:
 
535
        if self._done is True:
573
536
            raise ReusingTransform()
574
537
        conflicts = []
575
538
        # ensure all children of all existent parents are known
586
549
        conflicts.extend(self._overwrite_conflicts())
587
550
        return conflicts
588
551
 
 
552
    def _check_malformed(self):
 
553
        conflicts = self.find_conflicts()
 
554
        if len(conflicts) != 0:
 
555
            raise MalformedTransform(conflicts=conflicts)
 
556
 
589
557
    def _add_tree_children(self):
590
558
        """Add all the children of all active parents to the known paths.
591
559
 
593
561
        removed.  This is a necessary first step in detecting conflicts.
594
562
        """
595
563
        parents = self.by_parent().keys()
596
 
        parents.extend([t for t in self._removed_contents if 
 
564
        parents.extend([t for t in self._removed_contents if
597
565
                        self.tree_kind(t) == 'directory'])
598
566
        for trans_id in self._removed_id:
599
567
            file_id = self.tree_file_id(trans_id)
600
 
            if self._tree.inventory[file_id].kind == 'directory':
 
568
            if file_id is not None:
 
569
                if self._tree.stored_kind(file_id) == 'directory':
 
570
                    parents.append(trans_id)
 
571
            elif self.tree_kind(trans_id) == 'directory':
601
572
                parents.append(trans_id)
602
573
 
603
574
        for parent_id in parents:
604
575
            # ensure that all children are registered with the transaction
605
576
            list(self.iter_tree_children(parent_id))
606
577
 
607
 
    def iter_tree_children(self, parent_id):
608
 
        """Iterate through the entry's tree children, if any"""
609
 
        try:
610
 
            path = self._tree_id_paths[parent_id]
611
 
        except KeyError:
612
 
            return
613
 
        try:
614
 
            children = os.listdir(self._tree.abspath(path))
615
 
        except OSError, e:
616
 
            if e.errno != errno.ENOENT and e.errno != errno.ESRCH:
617
 
                raise
618
 
            return
619
 
            
620
 
        for child in children:
621
 
            childpath = joinpath(path, child)
622
 
            if self._tree.is_control_filename(childpath):
623
 
                continue
624
 
            yield self.trans_id_tree_path(childpath)
625
 
 
 
578
    @deprecated_method(deprecated_in((2, 3, 0)))
626
579
    def has_named_child(self, by_parent, parent_id, name):
627
 
        try:
628
 
            children = by_parent[parent_id]
629
 
        except KeyError:
630
 
            children = []
631
 
        for child in children:
 
580
        return self._has_named_child(
 
581
            name, parent_id, known_children=by_parent.get(parent_id, []))
 
582
 
 
583
    def _has_named_child(self, name, parent_id, known_children):
 
584
        """Does a parent already have a name child.
 
585
 
 
586
        :param name: The searched for name.
 
587
 
 
588
        :param parent_id: The parent for which the check is made.
 
589
 
 
590
        :param known_children: The already known children. This should have
 
591
            been recently obtained from `self.by_parent.get(parent_id)`
 
592
            (or will be if None is passed).
 
593
        """
 
594
        if known_children is None:
 
595
            known_children = self.by_parent().get(parent_id, [])
 
596
        for child in known_children:
632
597
            if self.final_name(child) == name:
633
598
                return True
634
 
        try:
635
 
            path = self._tree_id_paths[parent_id]
636
 
        except KeyError:
 
599
        parent_path = self._tree_id_paths.get(parent_id, None)
 
600
        if parent_path is None:
 
601
            # No parent... no children
637
602
            return False
638
 
        childpath = joinpath(path, name)
639
 
        child_id = self._tree_path_ids.get(childpath)
 
603
        child_path = joinpath(parent_path, name)
 
604
        child_id = self._tree_path_ids.get(child_path, None)
640
605
        if child_id is None:
641
 
            return lexists(self._tree.abspath(childpath))
 
606
            # Not known by the tree transform yet, check the filesystem
 
607
            return osutils.lexists(self._tree.abspath(child_path))
642
608
        else:
643
 
            if self.final_parent(child_id) != parent_id:
644
 
                return False
645
 
            if child_id in self._removed_contents:
646
 
                # XXX What about dangling file-ids?
647
 
                return False
648
 
            else:
649
 
                return True
 
609
            raise AssertionError('child_id is missing: %s, %s, %s'
 
610
                                 % (name, parent_id, child_id))
 
611
 
 
612
    def _available_backup_name(self, name, target_id):
 
613
        """Find an available backup name.
 
614
 
 
615
        :param name: The basename of the file.
 
616
 
 
617
        :param target_id: The directory trans_id where the backup should 
 
618
            be placed.
 
619
        """
 
620
        known_children = self.by_parent().get(target_id, [])
 
621
        return osutils.available_backup_name(
 
622
            name,
 
623
            lambda base: self._has_named_child(
 
624
                base, target_id, known_children))
650
625
 
651
626
    def _parent_loops(self):
652
627
        """No entry should be its own ancestor"""
654
629
        for trans_id in self._new_parent:
655
630
            seen = set()
656
631
            parent_id = trans_id
657
 
            while parent_id is not ROOT_PARENT:
 
632
            while parent_id != ROOT_PARENT:
658
633
                seen.add(parent_id)
659
634
                try:
660
635
                    parent_id = self.final_parent(parent_id)
670
645
        """If parent directories are versioned, children must be versioned."""
671
646
        conflicts = []
672
647
        for parent_id, children in by_parent.iteritems():
673
 
            if parent_id is ROOT_PARENT:
 
648
            if parent_id == ROOT_PARENT:
674
649
                continue
675
650
            if self.final_file_id(parent_id) is not None:
676
651
                continue
682
657
 
683
658
    def _improper_versioning(self):
684
659
        """Cannot version a file with no contents, or a bad type.
685
 
        
 
660
 
686
661
        However, existing entries with no contents are okay.
687
662
        """
688
663
        conflicts = []
689
664
        for trans_id in self._new_id.iterkeys():
690
 
            try:
691
 
                kind = self.final_kind(trans_id)
692
 
            except NoSuchFile:
 
665
            kind = self.final_kind(trans_id)
 
666
            if kind is None:
693
667
                conflicts.append(('versioning no contents', trans_id))
694
668
                continue
695
 
            if not InventoryEntry.versionable_kind(kind):
 
669
            if not inventory.InventoryEntry.versionable_kind(kind):
696
670
                conflicts.append(('versioning bad kind', trans_id, kind))
697
671
        return conflicts
698
672
 
699
673
    def _executability_conflicts(self):
700
674
        """Check for bad executability changes.
701
 
        
 
675
 
702
676
        Only versioned files may have their executability set, because
703
677
        1. only versioned entries can have executability under windows
704
678
        2. only files can be executable.  (The execute bit on a directory
709
683
            if self.final_file_id(trans_id) is None:
710
684
                conflicts.append(('unversioned executability', trans_id))
711
685
            else:
712
 
                try:
713
 
                    non_file = self.final_kind(trans_id) != "file"
714
 
                except NoSuchFile:
715
 
                    non_file = True
716
 
                if non_file is True:
 
686
                if self.final_kind(trans_id) != "file":
717
687
                    conflicts.append(('non-file executability', trans_id))
718
688
        return conflicts
719
689
 
721
691
        """Check for overwrites (not permitted on Win32)"""
722
692
        conflicts = []
723
693
        for trans_id in self._new_contents:
724
 
            try:
725
 
                self.tree_kind(trans_id)
726
 
            except NoSuchFile:
 
694
            if self.tree_kind(trans_id) is None:
727
695
                continue
728
696
            if trans_id not in self._removed_contents:
729
697
                conflicts.append(('overwrite', trans_id,
736
704
        if (self._new_name, self._new_parent) == ({}, {}):
737
705
            return conflicts
738
706
        for children in by_parent.itervalues():
739
 
            name_ids = [(self.final_name(t), t) for t in children]
 
707
            name_ids = []
 
708
            for child_tid in children:
 
709
                name = self.final_name(child_tid)
 
710
                if name is not None:
 
711
                    # Keep children only if they still exist in the end
 
712
                    if not self._case_sensitive_target:
 
713
                        name = name.lower()
 
714
                    name_ids.append((name, child_tid))
740
715
            name_ids.sort()
741
716
            last_name = None
742
717
            last_trans_id = None
743
718
            for name, trans_id in name_ids:
744
 
                try:
745
 
                    kind = self.final_kind(trans_id)
746
 
                except NoSuchFile:
747
 
                    kind = None
 
719
                kind = self.final_kind(trans_id)
748
720
                file_id = self.final_file_id(trans_id)
749
721
                if kind is None and file_id is None:
750
722
                    continue
760
732
        conflicts = []
761
733
        removed_tree_ids = set((self.tree_file_id(trans_id) for trans_id in
762
734
                                self._removed_id))
763
 
        active_tree_ids = set((f for f in self._tree.inventory if
764
 
                               f not in removed_tree_ids))
 
735
        all_ids = self._tree.all_file_ids()
 
736
        active_tree_ids = all_ids.difference(removed_tree_ids)
765
737
        for trans_id, file_id in self._new_id.iteritems():
766
738
            if file_id in active_tree_ids:
767
739
                old_trans_id = self.trans_id_tree_file_id(file_id)
769
741
        return conflicts
770
742
 
771
743
    def _parent_type_conflicts(self, by_parent):
772
 
        """parents must have directory 'contents'."""
 
744
        """Children must have a directory parent"""
773
745
        conflicts = []
774
746
        for parent_id, children in by_parent.iteritems():
775
 
            if parent_id is ROOT_PARENT:
776
 
                continue
777
 
            if not self._any_contents(children):
778
 
                continue
779
 
            for child in children:
780
 
                try:
781
 
                    self.final_kind(child)
782
 
                except NoSuchFile:
783
 
                    continue
784
 
            try:
785
 
                kind = self.final_kind(parent_id)
786
 
            except NoSuchFile:
787
 
                kind = None
 
747
            if parent_id == ROOT_PARENT:
 
748
                continue
 
749
            no_children = True
 
750
            for child_id in children:
 
751
                if self.final_kind(child_id) is not None:
 
752
                    no_children = False
 
753
                    break
 
754
            if no_children:
 
755
                continue
 
756
            # There is at least a child, so we need an existing directory to
 
757
            # contain it.
 
758
            kind = self.final_kind(parent_id)
788
759
            if kind is None:
 
760
                # The directory will be deleted
789
761
                conflicts.append(('missing parent', parent_id))
790
762
            elif kind != "directory":
 
763
                # Meh, we need a *directory* to put something in it
791
764
                conflicts.append(('non-directory parent', parent_id))
792
765
        return conflicts
793
766
 
794
 
    def _any_contents(self, trans_ids):
795
 
        """Return true if any of the trans_ids, will have contents."""
796
 
        for trans_id in trans_ids:
797
 
            try:
798
 
                kind = self.final_kind(trans_id)
799
 
            except NoSuchFile:
800
 
                continue
801
 
            return True
802
 
        return False
803
 
            
804
 
    def apply(self, no_conflicts=False, _mover=None):
805
 
        """Apply all changes to the inventory and filesystem.
806
 
        
807
 
        If filesystem or inventory conflicts are present, MalformedTransform
808
 
        will be thrown.
809
 
 
810
 
        If apply succeeds, finalize is not necessary.
811
 
 
812
 
        :param no_conflicts: if True, the caller guarantees there are no
813
 
            conflicts, so no check is made.
814
 
        :param _mover: Supply an alternate FileMover, for testing
815
 
        """
816
 
        if not no_conflicts:
817
 
            conflicts = self.find_conflicts()
818
 
            if len(conflicts) != 0:
819
 
                raise MalformedTransform(conflicts=conflicts)
820
 
        inv = self._tree.inventory
821
 
        inventory_delta = []
822
 
        child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
823
 
        try:
824
 
            if _mover is None:
825
 
                mover = _FileMover()
826
 
            else:
827
 
                mover = _mover
828
 
            try:
829
 
                child_pb.update('Apply phase', 0, 2)
830
 
                self._apply_removals(inv, inventory_delta, mover)
831
 
                child_pb.update('Apply phase', 1, 2)
832
 
                modified_paths = self._apply_insertions(inv, inventory_delta,
833
 
                                                        mover)
834
 
            except:
835
 
                mover.rollback()
836
 
                raise
837
 
            else:
838
 
                mover.apply_deletions()
839
 
        finally:
840
 
            child_pb.finished()
841
 
        self._tree.apply_inventory_delta(inventory_delta)
842
 
        self.__done = True
843
 
        self.finalize()
844
 
        return _TransformResults(modified_paths, self.rename_count)
845
 
 
846
 
    def _limbo_name(self, trans_id):
847
 
        """Generate the limbo name of a file"""
848
 
        limbo_name = self._limbo_files.get(trans_id)
849
 
        if limbo_name is not None:
850
 
            return limbo_name
851
 
        parent = self._new_parent.get(trans_id)
852
 
        # if the parent directory is already in limbo (e.g. when building a
853
 
        # tree), choose a limbo name inside the parent, to reduce further
854
 
        # renames.
855
 
        use_direct_path = False
856
 
        if self._new_contents.get(parent) == 'directory':
857
 
            filename = self._new_name.get(trans_id)
858
 
            if filename is not None:
859
 
                if parent not in self._limbo_children:
860
 
                    self._limbo_children[parent] = set()
861
 
                    self._limbo_children_names[parent] = {}
862
 
                    use_direct_path = True
863
 
                # the direct path can only be used if no other file has
864
 
                # already taken this pathname, i.e. if the name is unused, or
865
 
                # if it is already associated with this trans_id.
866
 
                elif (self._limbo_children_names[parent].get(filename)
867
 
                      in (trans_id, None)):
868
 
                    use_direct_path = True
869
 
        if use_direct_path:
870
 
            limbo_name = pathjoin(self._limbo_files[parent], filename)
871
 
            self._limbo_children[parent].add(trans_id)
872
 
            self._limbo_children_names[parent][filename] = trans_id
873
 
        else:
874
 
            limbo_name = pathjoin(self._limbodir, trans_id)
875
 
            self._needs_rename.add(trans_id)
876
 
        self._limbo_files[trans_id] = limbo_name
877
 
        return limbo_name
878
 
 
879
 
    def _apply_removals(self, inv, inventory_delta, mover):
880
 
        """Perform tree operations that remove directory/inventory names.
881
 
        
882
 
        That is, delete files that are to be deleted, and put any files that
883
 
        need renaming into limbo.  This must be done in strict child-to-parent
884
 
        order.
885
 
        """
886
 
        tree_paths = list(self._tree_path_ids.iteritems())
887
 
        tree_paths.sort(reverse=True)
888
 
        child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
889
 
        try:
890
 
            for num, data in enumerate(tree_paths):
891
 
                path, trans_id = data
892
 
                child_pb.update('removing file', num, len(tree_paths))
893
 
                full_path = self._tree.abspath(path)
894
 
                if trans_id in self._removed_contents:
895
 
                    mover.pre_delete(full_path, os.path.join(self._deletiondir,
896
 
                                     trans_id))
897
 
                elif trans_id in self._new_name or trans_id in \
898
 
                    self._new_parent:
899
 
                    try:
900
 
                        mover.rename(full_path, self._limbo_name(trans_id))
901
 
                    except OSError, e:
902
 
                        if e.errno != errno.ENOENT:
903
 
                            raise
904
 
                    else:
905
 
                        self.rename_count += 1
906
 
                if trans_id in self._removed_id:
907
 
                    if trans_id == self._new_root:
908
 
                        file_id = self._tree.inventory.root.file_id
909
 
                    else:
910
 
                        file_id = self.tree_file_id(trans_id)
911
 
                    assert file_id is not None
912
 
                    inventory_delta.append((path, None, file_id, None))
913
 
        finally:
914
 
            child_pb.finished()
915
 
 
916
 
    def _apply_insertions(self, inv, inventory_delta, mover):
917
 
        """Perform tree operations that insert directory/inventory names.
918
 
        
919
 
        That is, create any files that need to be created, and restore from
920
 
        limbo any files that needed renaming.  This must be done in strict
921
 
        parent-to-child order.
922
 
        """
923
 
        new_paths = self.new_paths()
924
 
        modified_paths = []
925
 
        child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
926
 
        try:
927
 
            for num, (path, trans_id) in enumerate(new_paths):
928
 
                new_entry = None
929
 
                child_pb.update('adding file', num, len(new_paths))
930
 
                try:
931
 
                    kind = self._new_contents[trans_id]
932
 
                except KeyError:
933
 
                    kind = contents = None
934
 
                if trans_id in self._new_contents or \
935
 
                    self.path_changed(trans_id):
936
 
                    full_path = self._tree.abspath(path)
937
 
                    if trans_id in self._needs_rename:
938
 
                        try:
939
 
                            mover.rename(self._limbo_name(trans_id), full_path)
940
 
                        except OSError, e:
941
 
                            # We may be renaming a dangling inventory id
942
 
                            if e.errno != errno.ENOENT:
943
 
                                raise
944
 
                        else:
945
 
                            self.rename_count += 1
946
 
                    if trans_id in self._new_contents:
947
 
                        modified_paths.append(full_path)
948
 
                        del self._new_contents[trans_id]
949
 
 
950
 
                if trans_id in self._new_id:
951
 
                    if kind is None:
952
 
                        kind = file_kind(self._tree.abspath(path))
953
 
                    if trans_id in self._new_reference_revision:
954
 
                        new_entry = inventory.TreeReference(
955
 
                            self._new_id[trans_id],
956
 
                            self._new_name[trans_id], 
957
 
                            self.final_file_id(self._new_parent[trans_id]),
958
 
                            None, self._new_reference_revision[trans_id])
959
 
                    else:
960
 
                        new_entry = inventory.make_entry(kind,
961
 
                            self.final_name(trans_id),
962
 
                            self.final_file_id(self.final_parent(trans_id)),
963
 
                            self._new_id[trans_id])
964
 
                else:
965
 
                    if trans_id in self._new_name or trans_id in\
966
 
                        self._new_parent or\
967
 
                        trans_id in self._new_executability:
968
 
                        file_id = self.final_file_id(trans_id)
969
 
                        if file_id is not None:
970
 
                            entry = inv[file_id]
971
 
                            new_entry = entry.copy()
972
 
 
973
 
                    if trans_id in self._new_name or trans_id in\
974
 
                        self._new_parent:
975
 
                            if new_entry is not None:
976
 
                                new_entry.name = self.final_name(trans_id)
977
 
                                parent = self.final_parent(trans_id)
978
 
                                parent_id = self.final_file_id(parent)
979
 
                                new_entry.parent_id = parent_id
980
 
 
981
 
                if trans_id in self._new_executability:
982
 
                    self._set_executability(path, new_entry, trans_id)
983
 
                if new_entry is not None:
984
 
                    if new_entry.file_id in inv:
985
 
                        old_path = inv.id2path(new_entry.file_id)
986
 
                    else:
987
 
                        old_path = None
988
 
                    inventory_delta.append((old_path, path,
989
 
                                            new_entry.file_id,
990
 
                                            new_entry))
991
 
        finally:
992
 
            child_pb.finished()
993
 
        return modified_paths
994
 
 
995
 
    def _set_executability(self, path, entry, trans_id):
 
767
    def _set_executability(self, path, trans_id):
996
768
        """Set the executability of versioned files """
997
 
        new_executability = self._new_executability[trans_id]
998
 
        entry.executable = new_executability
999
 
        if supports_executable():
 
769
        if self._tree._supports_executable():
 
770
            new_executability = self._new_executability[trans_id]
1000
771
            abspath = self._tree.abspath(path)
1001
772
            current_mode = os.stat(abspath).st_mode
1002
773
            if new_executability:
1010
781
                    to_mode |= 0010 & ~umask
1011
782
            else:
1012
783
                to_mode = current_mode & ~0111
1013
 
            os.chmod(abspath, to_mode)
 
784
            osutils.chmod_if_possible(abspath, to_mode)
1014
785
 
1015
786
    def _new_entry(self, name, parent_id, file_id):
1016
787
        """Helper function to create a new filesystem entry."""
1019
790
            self.version_file(file_id, trans_id)
1020
791
        return trans_id
1021
792
 
1022
 
    def new_file(self, name, parent_id, contents, file_id=None, 
1023
 
                 executable=None):
 
793
    def new_file(self, name, parent_id, contents, file_id=None,
 
794
                 executable=None, sha1=None):
1024
795
        """Convenience method to create files.
1025
 
        
 
796
 
1026
797
        name is the name of the file to create.
1027
798
        parent_id is the transaction id of the parent directory of the file.
1028
799
        contents is an iterator of bytestrings, which will be used to produce
1033
804
        trans_id = self._new_entry(name, parent_id, file_id)
1034
805
        # TODO: rather than scheduling a set_executable call,
1035
806
        # have create_file create the file with the right mode.
1036
 
        self.create_file(contents, trans_id)
 
807
        self.create_file(contents, trans_id, sha1=sha1)
1037
808
        if executable is not None:
1038
809
            self.set_executability(executable, trans_id)
1039
810
        return trans_id
1048
819
        """
1049
820
        trans_id = self._new_entry(name, parent_id, file_id)
1050
821
        self.create_directory(trans_id)
1051
 
        return trans_id 
 
822
        return trans_id
1052
823
 
1053
824
    def new_symlink(self, name, parent_id, target, file_id=None):
1054
825
        """Convenience method to create symbolic link.
1055
 
        
 
826
 
1056
827
        name is the name of the symlink to create.
1057
828
        parent_id is the transaction id of the parent directory of the symlink.
1058
829
        target is a bytestring of the target of the symlink.
1062
833
        self.create_symlink(target, trans_id)
1063
834
        return trans_id
1064
835
 
 
836
    def new_orphan(self, trans_id, parent_id):
 
837
        """Schedule an item to be orphaned.
 
838
 
 
839
        When a directory is about to be removed, its children, if they are not
 
840
        versioned are moved out of the way: they don't have a parent anymore.
 
841
 
 
842
        :param trans_id: The trans_id of the existing item.
 
843
        :param parent_id: The parent trans_id of the item.
 
844
        """
 
845
        raise NotImplementedError(self.new_orphan)
 
846
 
 
847
    def _get_potential_orphans(self, dir_id):
 
848
        """Find the potential orphans in a directory.
 
849
 
 
850
        A directory can't be safely deleted if there are versioned files in it.
 
851
        If all the contained files are unversioned then they can be orphaned.
 
852
 
 
853
        The 'None' return value means that the directory contains at least one
 
854
        versioned file and should not be deleted.
 
855
 
 
856
        :param dir_id: The directory trans id.
 
857
 
 
858
        :return: A list of the orphan trans ids or None if at least one
 
859
             versioned file is present.
 
860
        """
 
861
        orphans = []
 
862
        # Find the potential orphans, stop if one item should be kept
 
863
        for child_tid in self.by_parent()[dir_id]:
 
864
            if child_tid in self._removed_contents:
 
865
                # The child is removed as part of the transform. Since it was
 
866
                # versioned before, it's not an orphan
 
867
                continue
 
868
            elif self.final_file_id(child_tid) is None:
 
869
                # The child is not versioned
 
870
                orphans.append(child_tid)
 
871
            else:
 
872
                # We have a versioned file here, searching for orphans is
 
873
                # meaningless.
 
874
                orphans = None
 
875
                break
 
876
        return orphans
 
877
 
1065
878
    def _affected_ids(self):
1066
879
        """Return the set of transform ids affected by the transform"""
1067
880
        trans_ids = set(self._removed_id)
1097
910
        from_path = self._tree_id_paths.get(from_trans_id)
1098
911
        if from_versioned:
1099
912
            # get data from working tree if versioned
1100
 
            from_entry = self._tree.inventory[file_id]
 
913
            from_entry = self._tree.iter_entries_by_dir([file_id]).next()[1]
1101
914
            from_name = from_entry.name
1102
915
            from_parent = from_entry.parent_id
1103
916
        else:
1126
939
        Return a (name, parent, kind, executable) tuple
1127
940
        """
1128
941
        to_name = self.final_name(to_trans_id)
1129
 
        try:
1130
 
            to_kind = self.final_kind(to_trans_id)
1131
 
        except NoSuchFile:
1132
 
            to_kind = None
 
942
        to_kind = self.final_kind(to_trans_id)
1133
943
        to_parent = self.final_file_id(self.final_parent(to_trans_id))
1134
944
        if to_trans_id in self._new_executability:
1135
945
            to_executable = self._new_executability[to_trans_id]
1139
949
            to_executable = False
1140
950
        return to_name, to_parent, to_kind, to_executable
1141
951
 
1142
 
    def _iter_changes(self):
1143
 
        """Produce output in the same format as Tree._iter_changes.
 
952
    def iter_changes(self):
 
953
        """Produce output in the same format as Tree.iter_changes.
1144
954
 
1145
955
        Will produce nonsensical results if invoked while inventory/filesystem
1146
956
        conflicts (as reported by TreeTransform.find_conflicts()) are present.
1201
1011
                   (from_executable, to_executable)))
1202
1012
        return iter(sorted(results, key=lambda x:x[1]))
1203
1013
 
 
1014
    def get_preview_tree(self):
 
1015
        """Return a tree representing the result of the transform.
 
1016
 
 
1017
        The tree is a snapshot, and altering the TreeTransform will invalidate
 
1018
        it.
 
1019
        """
 
1020
        return _PreviewTree(self)
 
1021
 
 
1022
    def commit(self, branch, message, merge_parents=None, strict=False,
 
1023
               timestamp=None, timezone=None, committer=None, authors=None,
 
1024
               revprops=None, revision_id=None):
 
1025
        """Commit the result of this TreeTransform to a branch.
 
1026
 
 
1027
        :param branch: The branch to commit to.
 
1028
        :param message: The message to attach to the commit.
 
1029
        :param merge_parents: Additional parent revision-ids specified by
 
1030
            pending merges.
 
1031
        :param strict: If True, abort the commit if there are unversioned
 
1032
            files.
 
1033
        :param timestamp: if not None, seconds-since-epoch for the time and
 
1034
            date.  (May be a float.)
 
1035
        :param timezone: Optional timezone for timestamp, as an offset in
 
1036
            seconds.
 
1037
        :param committer: Optional committer in email-id format.
 
1038
            (e.g. "J Random Hacker <jrandom@example.com>")
 
1039
        :param authors: Optional list of authors in email-id format.
 
1040
        :param revprops: Optional dictionary of revision properties.
 
1041
        :param revision_id: Optional revision id.  (Specifying a revision-id
 
1042
            may reduce performance for some non-native formats.)
 
1043
        :return: The revision_id of the revision committed.
 
1044
        """
 
1045
        self._check_malformed()
 
1046
        if strict:
 
1047
            unversioned = set(self._new_contents).difference(set(self._new_id))
 
1048
            for trans_id in unversioned:
 
1049
                if self.final_file_id(trans_id) is None:
 
1050
                    raise errors.StrictCommitFailed()
 
1051
 
 
1052
        revno, last_rev_id = branch.last_revision_info()
 
1053
        if last_rev_id == _mod_revision.NULL_REVISION:
 
1054
            if merge_parents is not None:
 
1055
                raise ValueError('Cannot supply merge parents for first'
 
1056
                                 ' commit.')
 
1057
            parent_ids = []
 
1058
        else:
 
1059
            parent_ids = [last_rev_id]
 
1060
            if merge_parents is not None:
 
1061
                parent_ids.extend(merge_parents)
 
1062
        if self._tree.get_revision_id() != last_rev_id:
 
1063
            raise ValueError('TreeTransform not based on branch basis: %s' %
 
1064
                             self._tree.get_revision_id())
 
1065
        revprops = commit.Commit.update_revprops(revprops, branch, authors)
 
1066
        builder = branch.get_commit_builder(parent_ids,
 
1067
                                            timestamp=timestamp,
 
1068
                                            timezone=timezone,
 
1069
                                            committer=committer,
 
1070
                                            revprops=revprops,
 
1071
                                            revision_id=revision_id)
 
1072
        preview = self.get_preview_tree()
 
1073
        list(builder.record_iter_changes(preview, last_rev_id,
 
1074
                                         self.iter_changes()))
 
1075
        builder.finish_inventory()
 
1076
        revision_id = builder.commit(message)
 
1077
        branch.set_last_revision_info(revno + 1, revision_id)
 
1078
        return revision_id
 
1079
 
 
1080
    def _text_parent(self, trans_id):
 
1081
        file_id = self.tree_file_id(trans_id)
 
1082
        try:
 
1083
            if file_id is None or self._tree.kind(file_id) != 'file':
 
1084
                return None
 
1085
        except errors.NoSuchFile:
 
1086
            return None
 
1087
        return file_id
 
1088
 
 
1089
    def _get_parents_texts(self, trans_id):
 
1090
        """Get texts for compression parents of this file."""
 
1091
        file_id = self._text_parent(trans_id)
 
1092
        if file_id is None:
 
1093
            return ()
 
1094
        return (self._tree.get_file_text(file_id),)
 
1095
 
 
1096
    def _get_parents_lines(self, trans_id):
 
1097
        """Get lines for compression parents of this file."""
 
1098
        file_id = self._text_parent(trans_id)
 
1099
        if file_id is None:
 
1100
            return ()
 
1101
        return (self._tree.get_file_lines(file_id),)
 
1102
 
 
1103
    def serialize(self, serializer):
 
1104
        """Serialize this TreeTransform.
 
1105
 
 
1106
        :param serializer: A Serialiser like pack.ContainerSerializer.
 
1107
        """
 
1108
        new_name = dict((k, v.encode('utf-8')) for k, v in
 
1109
                        self._new_name.items())
 
1110
        new_executability = dict((k, int(v)) for k, v in
 
1111
                                 self._new_executability.items())
 
1112
        tree_path_ids = dict((k.encode('utf-8'), v)
 
1113
                             for k, v in self._tree_path_ids.items())
 
1114
        attribs = {
 
1115
            '_id_number': self._id_number,
 
1116
            '_new_name': new_name,
 
1117
            '_new_parent': self._new_parent,
 
1118
            '_new_executability': new_executability,
 
1119
            '_new_id': self._new_id,
 
1120
            '_tree_path_ids': tree_path_ids,
 
1121
            '_removed_id': list(self._removed_id),
 
1122
            '_removed_contents': list(self._removed_contents),
 
1123
            '_non_present_ids': self._non_present_ids,
 
1124
            }
 
1125
        yield serializer.bytes_record(bencode.bencode(attribs),
 
1126
                                      (('attribs',),))
 
1127
        for trans_id, kind in self._new_contents.items():
 
1128
            if kind == 'file':
 
1129
                lines = osutils.chunks_to_lines(
 
1130
                    self._read_file_chunks(trans_id))
 
1131
                parents = self._get_parents_lines(trans_id)
 
1132
                mpdiff = multiparent.MultiParent.from_lines(lines, parents)
 
1133
                content = ''.join(mpdiff.to_patch())
 
1134
            if kind == 'directory':
 
1135
                content = ''
 
1136
            if kind == 'symlink':
 
1137
                content = self._read_symlink_target(trans_id)
 
1138
            yield serializer.bytes_record(content, ((trans_id, kind),))
 
1139
 
 
1140
    def deserialize(self, records):
 
1141
        """Deserialize a stored TreeTransform.
 
1142
 
 
1143
        :param records: An iterable of (names, content) tuples, as per
 
1144
            pack.ContainerPushParser.
 
1145
        """
 
1146
        names, content = records.next()
 
1147
        attribs = bencode.bdecode(content)
 
1148
        self._id_number = attribs['_id_number']
 
1149
        self._new_name = dict((k, v.decode('utf-8'))
 
1150
                            for k, v in attribs['_new_name'].items())
 
1151
        self._new_parent = attribs['_new_parent']
 
1152
        self._new_executability = dict((k, bool(v)) for k, v in
 
1153
            attribs['_new_executability'].items())
 
1154
        self._new_id = attribs['_new_id']
 
1155
        self._r_new_id = dict((v, k) for k, v in self._new_id.items())
 
1156
        self._tree_path_ids = {}
 
1157
        self._tree_id_paths = {}
 
1158
        for bytepath, trans_id in attribs['_tree_path_ids'].items():
 
1159
            path = bytepath.decode('utf-8')
 
1160
            self._tree_path_ids[path] = trans_id
 
1161
            self._tree_id_paths[trans_id] = path
 
1162
        self._removed_id = set(attribs['_removed_id'])
 
1163
        self._removed_contents = set(attribs['_removed_contents'])
 
1164
        self._non_present_ids = attribs['_non_present_ids']
 
1165
        for ((trans_id, kind),), content in records:
 
1166
            if kind == 'file':
 
1167
                mpdiff = multiparent.MultiParent.from_patch(content)
 
1168
                lines = mpdiff.to_lines(self._get_parents_texts(trans_id))
 
1169
                self.create_file(lines, trans_id)
 
1170
            if kind == 'directory':
 
1171
                self.create_directory(trans_id)
 
1172
            if kind == 'symlink':
 
1173
                self.create_symlink(content.decode('utf-8'), trans_id)
 
1174
 
 
1175
 
 
1176
class DiskTreeTransform(TreeTransformBase):
 
1177
    """Tree transform storing its contents on disk."""
 
1178
 
 
1179
    def __init__(self, tree, limbodir, pb=None,
 
1180
                 case_sensitive=True):
 
1181
        """Constructor.
 
1182
        :param tree: The tree that will be transformed, but not necessarily
 
1183
            the output tree.
 
1184
        :param limbodir: A directory where new files can be stored until
 
1185
            they are installed in their proper places
 
1186
        :param pb: ignored
 
1187
        :param case_sensitive: If True, the target of the transform is
 
1188
            case sensitive, not just case preserving.
 
1189
        """
 
1190
        TreeTransformBase.__init__(self, tree, pb, case_sensitive)
 
1191
        self._limbodir = limbodir
 
1192
        self._deletiondir = None
 
1193
        # A mapping of transform ids to their limbo filename
 
1194
        self._limbo_files = {}
 
1195
        self._possibly_stale_limbo_files = set()
 
1196
        # A mapping of transform ids to a set of the transform ids of children
 
1197
        # that their limbo directory has
 
1198
        self._limbo_children = {}
 
1199
        # Map transform ids to maps of child filename to child transform id
 
1200
        self._limbo_children_names = {}
 
1201
        # List of transform ids that need to be renamed from limbo into place
 
1202
        self._needs_rename = set()
 
1203
        self._creation_mtime = None
 
1204
 
 
1205
    def finalize(self):
 
1206
        """Release the working tree lock, if held, clean up limbo dir.
 
1207
 
 
1208
        This is required if apply has not been invoked, but can be invoked
 
1209
        even after apply.
 
1210
        """
 
1211
        if self._tree is None:
 
1212
            return
 
1213
        try:
 
1214
            limbo_paths = self._limbo_files.values() + list(
 
1215
                self._possibly_stale_limbo_files)
 
1216
            limbo_paths = sorted(limbo_paths, reverse=True)
 
1217
            for path in limbo_paths:
 
1218
                try:
 
1219
                    delete_any(path)
 
1220
                except OSError, e:
 
1221
                    if e.errno != errno.ENOENT:
 
1222
                        raise
 
1223
                    # XXX: warn? perhaps we just got interrupted at an
 
1224
                    # inconvenient moment, but perhaps files are disappearing
 
1225
                    # from under us?
 
1226
            try:
 
1227
                delete_any(self._limbodir)
 
1228
            except OSError:
 
1229
                # We don't especially care *why* the dir is immortal.
 
1230
                raise ImmortalLimbo(self._limbodir)
 
1231
            try:
 
1232
                if self._deletiondir is not None:
 
1233
                    delete_any(self._deletiondir)
 
1234
            except OSError:
 
1235
                raise errors.ImmortalPendingDeletion(self._deletiondir)
 
1236
        finally:
 
1237
            TreeTransformBase.finalize(self)
 
1238
 
 
1239
    def _limbo_supports_executable(self):
 
1240
        """Check if the limbo path supports the executable bit."""
 
1241
        # FIXME: Check actual file system capabilities of limbodir
 
1242
        return osutils.supports_executable()
 
1243
 
 
1244
    def _limbo_name(self, trans_id):
 
1245
        """Generate the limbo name of a file"""
 
1246
        limbo_name = self._limbo_files.get(trans_id)
 
1247
        if limbo_name is None:
 
1248
            limbo_name = self._generate_limbo_path(trans_id)
 
1249
            self._limbo_files[trans_id] = limbo_name
 
1250
        return limbo_name
 
1251
 
 
1252
    def _generate_limbo_path(self, trans_id):
 
1253
        """Generate a limbo path using the trans_id as the relative path.
 
1254
 
 
1255
        This is suitable as a fallback, and when the transform should not be
 
1256
        sensitive to the path encoding of the limbo directory.
 
1257
        """
 
1258
        self._needs_rename.add(trans_id)
 
1259
        return pathjoin(self._limbodir, trans_id)
 
1260
 
 
1261
    def adjust_path(self, name, parent, trans_id):
 
1262
        previous_parent = self._new_parent.get(trans_id)
 
1263
        previous_name = self._new_name.get(trans_id)
 
1264
        TreeTransformBase.adjust_path(self, name, parent, trans_id)
 
1265
        if (trans_id in self._limbo_files and
 
1266
            trans_id not in self._needs_rename):
 
1267
            self._rename_in_limbo([trans_id])
 
1268
            if previous_parent != parent:
 
1269
                self._limbo_children[previous_parent].remove(trans_id)
 
1270
            if previous_parent != parent or previous_name != name:
 
1271
                del self._limbo_children_names[previous_parent][previous_name]
 
1272
 
 
1273
    def _rename_in_limbo(self, trans_ids):
 
1274
        """Fix limbo names so that the right final path is produced.
 
1275
 
 
1276
        This means we outsmarted ourselves-- we tried to avoid renaming
 
1277
        these files later by creating them with their final names in their
 
1278
        final parents.  But now the previous name or parent is no longer
 
1279
        suitable, so we have to rename them.
 
1280
 
 
1281
        Even for trans_ids that have no new contents, we must remove their
 
1282
        entries from _limbo_files, because they are now stale.
 
1283
        """
 
1284
        for trans_id in trans_ids:
 
1285
            old_path = self._limbo_files[trans_id]
 
1286
            self._possibly_stale_limbo_files.add(old_path)
 
1287
            del self._limbo_files[trans_id]
 
1288
            if trans_id not in self._new_contents:
 
1289
                continue
 
1290
            new_path = self._limbo_name(trans_id)
 
1291
            os.rename(old_path, new_path)
 
1292
            self._possibly_stale_limbo_files.remove(old_path)
 
1293
            for descendant in self._limbo_descendants(trans_id):
 
1294
                desc_path = self._limbo_files[descendant]
 
1295
                desc_path = new_path + desc_path[len(old_path):]
 
1296
                self._limbo_files[descendant] = desc_path
 
1297
 
 
1298
    def _limbo_descendants(self, trans_id):
 
1299
        """Return the set of trans_ids whose limbo paths descend from this."""
 
1300
        descendants = set(self._limbo_children.get(trans_id, []))
 
1301
        for descendant in list(descendants):
 
1302
            descendants.update(self._limbo_descendants(descendant))
 
1303
        return descendants
 
1304
 
 
1305
    def create_file(self, contents, trans_id, mode_id=None, sha1=None):
 
1306
        """Schedule creation of a new file.
 
1307
 
 
1308
        :seealso: new_file.
 
1309
 
 
1310
        :param contents: an iterator of strings, all of which will be written
 
1311
            to the target destination.
 
1312
        :param trans_id: TreeTransform handle
 
1313
        :param mode_id: If not None, force the mode of the target file to match
 
1314
            the mode of the object referenced by mode_id.
 
1315
            Otherwise, we will try to preserve mode bits of an existing file.
 
1316
        :param sha1: If the sha1 of this content is already known, pass it in.
 
1317
            We can use it to prevent future sha1 computations.
 
1318
        """
 
1319
        name = self._limbo_name(trans_id)
 
1320
        f = open(name, 'wb')
 
1321
        try:
 
1322
            unique_add(self._new_contents, trans_id, 'file')
 
1323
            f.writelines(contents)
 
1324
        finally:
 
1325
            f.close()
 
1326
        self._set_mtime(name)
 
1327
        self._set_mode(trans_id, mode_id, S_ISREG)
 
1328
        # It is unfortunate we have to use lstat instead of fstat, but we just
 
1329
        # used utime and chmod on the file, so we need the accurate final
 
1330
        # details.
 
1331
        if sha1 is not None:
 
1332
            self._observed_sha1s[trans_id] = (sha1, osutils.lstat(name))
 
1333
 
 
1334
    def _read_file_chunks(self, trans_id):
 
1335
        cur_file = open(self._limbo_name(trans_id), 'rb')
 
1336
        try:
 
1337
            return cur_file.readlines()
 
1338
        finally:
 
1339
            cur_file.close()
 
1340
 
 
1341
    def _read_symlink_target(self, trans_id):
 
1342
        return os.readlink(self._limbo_name(trans_id))
 
1343
 
 
1344
    def _set_mtime(self, path):
 
1345
        """All files that are created get the same mtime.
 
1346
 
 
1347
        This time is set by the first object to be created.
 
1348
        """
 
1349
        if self._creation_mtime is None:
 
1350
            self._creation_mtime = time.time()
 
1351
        os.utime(path, (self._creation_mtime, self._creation_mtime))
 
1352
 
 
1353
    def create_hardlink(self, path, trans_id):
 
1354
        """Schedule creation of a hard link"""
 
1355
        name = self._limbo_name(trans_id)
 
1356
        try:
 
1357
            os.link(path, name)
 
1358
        except OSError, e:
 
1359
            if e.errno != errno.EPERM:
 
1360
                raise
 
1361
            raise errors.HardLinkNotSupported(path)
 
1362
        try:
 
1363
            unique_add(self._new_contents, trans_id, 'file')
 
1364
        except:
 
1365
            # Clean up the file, it never got registered so
 
1366
            # TreeTransform.finalize() won't clean it up.
 
1367
            os.unlink(name)
 
1368
            raise
 
1369
 
 
1370
    def create_directory(self, trans_id):
 
1371
        """Schedule creation of a new directory.
 
1372
 
 
1373
        See also new_directory.
 
1374
        """
 
1375
        os.mkdir(self._limbo_name(trans_id))
 
1376
        unique_add(self._new_contents, trans_id, 'directory')
 
1377
 
 
1378
    def create_symlink(self, target, trans_id):
 
1379
        """Schedule creation of a new symbolic link.
 
1380
 
 
1381
        target is a bytestring.
 
1382
        See also new_symlink.
 
1383
        """
 
1384
        if has_symlinks():
 
1385
            os.symlink(target, self._limbo_name(trans_id))
 
1386
            unique_add(self._new_contents, trans_id, 'symlink')
 
1387
        else:
 
1388
            try:
 
1389
                path = FinalPaths(self).get_path(trans_id)
 
1390
            except KeyError:
 
1391
                path = None
 
1392
            raise UnableCreateSymlink(path=path)
 
1393
 
 
1394
    def cancel_creation(self, trans_id):
 
1395
        """Cancel the creation of new file contents."""
 
1396
        del self._new_contents[trans_id]
 
1397
        if trans_id in self._observed_sha1s:
 
1398
            del self._observed_sha1s[trans_id]
 
1399
        children = self._limbo_children.get(trans_id)
 
1400
        # if this is a limbo directory with children, move them before removing
 
1401
        # the directory
 
1402
        if children is not None:
 
1403
            self._rename_in_limbo(children)
 
1404
            del self._limbo_children[trans_id]
 
1405
            del self._limbo_children_names[trans_id]
 
1406
        delete_any(self._limbo_name(trans_id))
 
1407
 
 
1408
    def new_orphan(self, trans_id, parent_id):
 
1409
        conf = self._tree.get_config_stack()
 
1410
        handle_orphan = conf.get('bzr.transform.orphan_policy')
 
1411
        handle_orphan(self, trans_id, parent_id)
 
1412
 
 
1413
 
 
1414
class OrphaningError(errors.BzrError):
 
1415
 
 
1416
    # Only bugs could lead to such exception being seen by the user
 
1417
    internal_error = True
 
1418
    _fmt = "Error while orphaning %s in %s directory"
 
1419
 
 
1420
    def __init__(self, orphan, parent):
 
1421
        errors.BzrError.__init__(self)
 
1422
        self.orphan = orphan
 
1423
        self.parent = parent
 
1424
 
 
1425
 
 
1426
class OrphaningForbidden(OrphaningError):
 
1427
 
 
1428
    _fmt = "Policy: %s doesn't allow creating orphans."
 
1429
 
 
1430
    def __init__(self, policy):
 
1431
        errors.BzrError.__init__(self)
 
1432
        self.policy = policy
 
1433
 
 
1434
 
 
1435
def move_orphan(tt, orphan_id, parent_id):
 
1436
    """See TreeTransformBase.new_orphan.
 
1437
 
 
1438
    This creates a new orphan in the `bzr-orphans` dir at the root of the
 
1439
    `TreeTransform`.
 
1440
 
 
1441
    :param tt: The TreeTransform orphaning `trans_id`.
 
1442
 
 
1443
    :param orphan_id: The trans id that should be orphaned.
 
1444
 
 
1445
    :param parent_id: The orphan parent trans id.
 
1446
    """
 
1447
    # Add the orphan dir if it doesn't exist
 
1448
    orphan_dir_basename = 'bzr-orphans'
 
1449
    od_id = tt.trans_id_tree_path(orphan_dir_basename)
 
1450
    if tt.final_kind(od_id) is None:
 
1451
        tt.create_directory(od_id)
 
1452
    parent_path = tt._tree_id_paths[parent_id]
 
1453
    # Find a name that doesn't exist yet in the orphan dir
 
1454
    actual_name = tt.final_name(orphan_id)
 
1455
    new_name = tt._available_backup_name(actual_name, od_id)
 
1456
    tt.adjust_path(new_name, od_id, orphan_id)
 
1457
    trace.warning('%s has been orphaned in %s'
 
1458
                  % (joinpath(parent_path, actual_name), orphan_dir_basename))
 
1459
 
 
1460
 
 
1461
def refuse_orphan(tt, orphan_id, parent_id):
 
1462
    """See TreeTransformBase.new_orphan.
 
1463
 
 
1464
    This refuses to create orphan, letting the caller handle the conflict.
 
1465
    """
 
1466
    raise OrphaningForbidden('never')
 
1467
 
 
1468
 
 
1469
orphaning_registry = registry.Registry()
 
1470
orphaning_registry.register(
 
1471
    'conflict', refuse_orphan,
 
1472
    'Leave orphans in place and create a conflict on the directory.')
 
1473
orphaning_registry.register(
 
1474
    'move', move_orphan,
 
1475
    'Move orphans into the bzr-orphans directory.')
 
1476
orphaning_registry._set_default_key('conflict')
 
1477
 
 
1478
 
 
1479
opt_transform_orphan = _mod_config.RegistryOption(
 
1480
    'bzr.transform.orphan_policy', orphaning_registry,
 
1481
    help='Policy for orphaned files during transform operations.',
 
1482
    invalid='warning')
 
1483
 
 
1484
 
 
1485
class TreeTransform(DiskTreeTransform):
 
1486
    """Represent a tree transformation.
 
1487
 
 
1488
    This object is designed to support incremental generation of the transform,
 
1489
    in any order.
 
1490
 
 
1491
    However, it gives optimum performance when parent directories are created
 
1492
    before their contents.  The transform is then able to put child files
 
1493
    directly in their parent directory, avoiding later renames.
 
1494
 
 
1495
    It is easy to produce malformed transforms, but they are generally
 
1496
    harmless.  Attempting to apply a malformed transform will cause an
 
1497
    exception to be raised before any modifications are made to the tree.
 
1498
 
 
1499
    Many kinds of malformed transforms can be corrected with the
 
1500
    resolve_conflicts function.  The remaining ones indicate programming error,
 
1501
    such as trying to create a file with no path.
 
1502
 
 
1503
    Two sets of file creation methods are supplied.  Convenience methods are:
 
1504
     * new_file
 
1505
     * new_directory
 
1506
     * new_symlink
 
1507
 
 
1508
    These are composed of the low-level methods:
 
1509
     * create_path
 
1510
     * create_file or create_directory or create_symlink
 
1511
     * version_file
 
1512
     * set_executability
 
1513
 
 
1514
    Transform/Transaction ids
 
1515
    -------------------------
 
1516
    trans_ids are temporary ids assigned to all files involved in a transform.
 
1517
    It's possible, even common, that not all files in the Tree have trans_ids.
 
1518
 
 
1519
    trans_ids are used because filenames and file_ids are not good enough
 
1520
    identifiers; filenames change, and not all files have file_ids.  File-ids
 
1521
    are also associated with trans-ids, so that moving a file moves its
 
1522
    file-id.
 
1523
 
 
1524
    trans_ids are only valid for the TreeTransform that generated them.
 
1525
 
 
1526
    Limbo
 
1527
    -----
 
1528
    Limbo is a temporary directory use to hold new versions of files.
 
1529
    Files are added to limbo by create_file, create_directory, create_symlink,
 
1530
    and their convenience variants (new_*).  Files may be removed from limbo
 
1531
    using cancel_creation.  Files are renamed from limbo into their final
 
1532
    location as part of TreeTransform.apply
 
1533
 
 
1534
    Limbo must be cleaned up, by either calling TreeTransform.apply or
 
1535
    calling TreeTransform.finalize.
 
1536
 
 
1537
    Files are placed into limbo inside their parent directories, where
 
1538
    possible.  This reduces subsequent renames, and makes operations involving
 
1539
    lots of files faster.  This optimization is only possible if the parent
 
1540
    directory is created *before* creating any of its children, so avoid
 
1541
    creating children before parents, where possible.
 
1542
 
 
1543
    Pending-deletion
 
1544
    ----------------
 
1545
    This temporary directory is used by _FileMover for storing files that are
 
1546
    about to be deleted.  In case of rollback, the files will be restored.
 
1547
    FileMover does not delete files until it is sure that a rollback will not
 
1548
    happen.
 
1549
    """
 
1550
    def __init__(self, tree, pb=None):
 
1551
        """Note: a tree_write lock is taken on the tree.
 
1552
 
 
1553
        Use TreeTransform.finalize() to release the lock (can be omitted if
 
1554
        TreeTransform.apply() called).
 
1555
        """
 
1556
        tree.lock_tree_write()
 
1557
 
 
1558
        try:
 
1559
            limbodir = urlutils.local_path_from_url(
 
1560
                tree._transport.abspath('limbo'))
 
1561
            osutils.ensure_empty_directory_exists(
 
1562
                limbodir,
 
1563
                errors.ExistingLimbo)
 
1564
            deletiondir = urlutils.local_path_from_url(
 
1565
                tree._transport.abspath('pending-deletion'))
 
1566
            osutils.ensure_empty_directory_exists(
 
1567
                deletiondir,
 
1568
                errors.ExistingPendingDeletion)
 
1569
        except:
 
1570
            tree.unlock()
 
1571
            raise
 
1572
 
 
1573
        # Cache of realpath results, to speed up canonical_path
 
1574
        self._realpaths = {}
 
1575
        # Cache of relpath results, to speed up canonical_path
 
1576
        self._relpaths = {}
 
1577
        DiskTreeTransform.__init__(self, tree, limbodir, pb,
 
1578
                                   tree.case_sensitive)
 
1579
        self._deletiondir = deletiondir
 
1580
 
 
1581
    def canonical_path(self, path):
 
1582
        """Get the canonical tree-relative path"""
 
1583
        # don't follow final symlinks
 
1584
        abs = self._tree.abspath(path)
 
1585
        if abs in self._relpaths:
 
1586
            return self._relpaths[abs]
 
1587
        dirname, basename = os.path.split(abs)
 
1588
        if dirname not in self._realpaths:
 
1589
            self._realpaths[dirname] = os.path.realpath(dirname)
 
1590
        dirname = self._realpaths[dirname]
 
1591
        abs = pathjoin(dirname, basename)
 
1592
        if dirname in self._relpaths:
 
1593
            relpath = pathjoin(self._relpaths[dirname], basename)
 
1594
            relpath = relpath.rstrip('/\\')
 
1595
        else:
 
1596
            relpath = self._tree.relpath(abs)
 
1597
        self._relpaths[abs] = relpath
 
1598
        return relpath
 
1599
 
 
1600
    def tree_kind(self, trans_id):
 
1601
        """Determine the file kind in the working tree.
 
1602
 
 
1603
        :returns: The file kind or None if the file does not exist
 
1604
        """
 
1605
        path = self._tree_id_paths.get(trans_id)
 
1606
        if path is None:
 
1607
            return None
 
1608
        try:
 
1609
            return file_kind(self._tree.abspath(path))
 
1610
        except errors.NoSuchFile:
 
1611
            return None
 
1612
 
 
1613
    def _set_mode(self, trans_id, mode_id, typefunc):
 
1614
        """Set the mode of new file contents.
 
1615
        The mode_id is the existing file to get the mode from (often the same
 
1616
        as trans_id).  The operation is only performed if there's a mode match
 
1617
        according to typefunc.
 
1618
        """
 
1619
        if mode_id is None:
 
1620
            mode_id = trans_id
 
1621
        try:
 
1622
            old_path = self._tree_id_paths[mode_id]
 
1623
        except KeyError:
 
1624
            return
 
1625
        try:
 
1626
            mode = os.stat(self._tree.abspath(old_path)).st_mode
 
1627
        except OSError, e:
 
1628
            if e.errno in (errno.ENOENT, errno.ENOTDIR):
 
1629
                # Either old_path doesn't exist, or the parent of the
 
1630
                # target is not a directory (but will be one eventually)
 
1631
                # Either way, we know it doesn't exist *right now*
 
1632
                # See also bug #248448
 
1633
                return
 
1634
            else:
 
1635
                raise
 
1636
        if typefunc(mode):
 
1637
            osutils.chmod_if_possible(self._limbo_name(trans_id), mode)
 
1638
 
 
1639
    def iter_tree_children(self, parent_id):
 
1640
        """Iterate through the entry's tree children, if any"""
 
1641
        try:
 
1642
            path = self._tree_id_paths[parent_id]
 
1643
        except KeyError:
 
1644
            return
 
1645
        try:
 
1646
            children = os.listdir(self._tree.abspath(path))
 
1647
        except OSError, e:
 
1648
            if not (osutils._is_error_enotdir(e)
 
1649
                    or e.errno in (errno.ENOENT, errno.ESRCH)):
 
1650
                raise
 
1651
            return
 
1652
 
 
1653
        for child in children:
 
1654
            childpath = joinpath(path, child)
 
1655
            if self._tree.is_control_filename(childpath):
 
1656
                continue
 
1657
            yield self.trans_id_tree_path(childpath)
 
1658
 
 
1659
    def _generate_limbo_path(self, trans_id):
 
1660
        """Generate a limbo path using the final path if possible.
 
1661
 
 
1662
        This optimizes the performance of applying the tree transform by
 
1663
        avoiding renames.  These renames can be avoided only when the parent
 
1664
        directory is already scheduled for creation.
 
1665
 
 
1666
        If the final path cannot be used, falls back to using the trans_id as
 
1667
        the relpath.
 
1668
        """
 
1669
        parent = self._new_parent.get(trans_id)
 
1670
        # if the parent directory is already in limbo (e.g. when building a
 
1671
        # tree), choose a limbo name inside the parent, to reduce further
 
1672
        # renames.
 
1673
        use_direct_path = False
 
1674
        if self._new_contents.get(parent) == 'directory':
 
1675
            filename = self._new_name.get(trans_id)
 
1676
            if filename is not None:
 
1677
                if parent not in self._limbo_children:
 
1678
                    self._limbo_children[parent] = set()
 
1679
                    self._limbo_children_names[parent] = {}
 
1680
                    use_direct_path = True
 
1681
                # the direct path can only be used if no other file has
 
1682
                # already taken this pathname, i.e. if the name is unused, or
 
1683
                # if it is already associated with this trans_id.
 
1684
                elif self._case_sensitive_target:
 
1685
                    if (self._limbo_children_names[parent].get(filename)
 
1686
                        in (trans_id, None)):
 
1687
                        use_direct_path = True
 
1688
                else:
 
1689
                    for l_filename, l_trans_id in\
 
1690
                        self._limbo_children_names[parent].iteritems():
 
1691
                        if l_trans_id == trans_id:
 
1692
                            continue
 
1693
                        if l_filename.lower() == filename.lower():
 
1694
                            break
 
1695
                    else:
 
1696
                        use_direct_path = True
 
1697
 
 
1698
        if not use_direct_path:
 
1699
            return DiskTreeTransform._generate_limbo_path(self, trans_id)
 
1700
 
 
1701
        limbo_name = pathjoin(self._limbo_files[parent], filename)
 
1702
        self._limbo_children[parent].add(trans_id)
 
1703
        self._limbo_children_names[parent][filename] = trans_id
 
1704
        return limbo_name
 
1705
 
 
1706
 
 
1707
    def apply(self, no_conflicts=False, precomputed_delta=None, _mover=None):
 
1708
        """Apply all changes to the inventory and filesystem.
 
1709
 
 
1710
        If filesystem or inventory conflicts are present, MalformedTransform
 
1711
        will be thrown.
 
1712
 
 
1713
        If apply succeeds, finalize is not necessary.
 
1714
 
 
1715
        :param no_conflicts: if True, the caller guarantees there are no
 
1716
            conflicts, so no check is made.
 
1717
        :param precomputed_delta: An inventory delta to use instead of
 
1718
            calculating one.
 
1719
        :param _mover: Supply an alternate FileMover, for testing
 
1720
        """
 
1721
        for hook in MutableTree.hooks['pre_transform']:
 
1722
            hook(self._tree, self)
 
1723
        if not no_conflicts:
 
1724
            self._check_malformed()
 
1725
        child_pb = ui.ui_factory.nested_progress_bar()
 
1726
        try:
 
1727
            if precomputed_delta is None:
 
1728
                child_pb.update(gettext('Apply phase'), 0, 2)
 
1729
                inventory_delta = self._generate_inventory_delta()
 
1730
                offset = 1
 
1731
            else:
 
1732
                inventory_delta = precomputed_delta
 
1733
                offset = 0
 
1734
            if _mover is None:
 
1735
                mover = _FileMover()
 
1736
            else:
 
1737
                mover = _mover
 
1738
            try:
 
1739
                child_pb.update(gettext('Apply phase'), 0 + offset, 2 + offset)
 
1740
                self._apply_removals(mover)
 
1741
                child_pb.update(gettext('Apply phase'), 1 + offset, 2 + offset)
 
1742
                modified_paths = self._apply_insertions(mover)
 
1743
            except:
 
1744
                mover.rollback()
 
1745
                raise
 
1746
            else:
 
1747
                mover.apply_deletions()
 
1748
        finally:
 
1749
            child_pb.finished()
 
1750
        if self.final_file_id(self.root) is None:
 
1751
            inventory_delta = [e for e in inventory_delta if e[0] != '']
 
1752
        self._tree.apply_inventory_delta(inventory_delta)
 
1753
        self._apply_observed_sha1s()
 
1754
        self._done = True
 
1755
        self.finalize()
 
1756
        return _TransformResults(modified_paths, self.rename_count)
 
1757
 
 
1758
    def _generate_inventory_delta(self):
 
1759
        """Generate an inventory delta for the current transform."""
 
1760
        inventory_delta = []
 
1761
        child_pb = ui.ui_factory.nested_progress_bar()
 
1762
        new_paths = self._inventory_altered()
 
1763
        total_entries = len(new_paths) + len(self._removed_id)
 
1764
        try:
 
1765
            for num, trans_id in enumerate(self._removed_id):
 
1766
                if (num % 10) == 0:
 
1767
                    child_pb.update(gettext('removing file'), num, total_entries)
 
1768
                if trans_id == self._new_root:
 
1769
                    file_id = self._tree.get_root_id()
 
1770
                else:
 
1771
                    file_id = self.tree_file_id(trans_id)
 
1772
                # File-id isn't really being deleted, just moved
 
1773
                if file_id in self._r_new_id:
 
1774
                    continue
 
1775
                path = self._tree_id_paths[trans_id]
 
1776
                inventory_delta.append((path, None, file_id, None))
 
1777
            new_path_file_ids = dict((t, self.final_file_id(t)) for p, t in
 
1778
                                     new_paths)
 
1779
            entries = self._tree.iter_entries_by_dir(
 
1780
                new_path_file_ids.values())
 
1781
            old_paths = dict((e.file_id, p) for p, e in entries)
 
1782
            final_kinds = {}
 
1783
            for num, (path, trans_id) in enumerate(new_paths):
 
1784
                if (num % 10) == 0:
 
1785
                    child_pb.update(gettext('adding file'),
 
1786
                                    num + len(self._removed_id), total_entries)
 
1787
                file_id = new_path_file_ids[trans_id]
 
1788
                if file_id is None:
 
1789
                    continue
 
1790
                needs_entry = False
 
1791
                kind = self.final_kind(trans_id)
 
1792
                if kind is None:
 
1793
                    kind = self._tree.stored_kind(file_id)
 
1794
                parent_trans_id = self.final_parent(trans_id)
 
1795
                parent_file_id = new_path_file_ids.get(parent_trans_id)
 
1796
                if parent_file_id is None:
 
1797
                    parent_file_id = self.final_file_id(parent_trans_id)
 
1798
                if trans_id in self._new_reference_revision:
 
1799
                    new_entry = inventory.TreeReference(
 
1800
                        file_id,
 
1801
                        self._new_name[trans_id],
 
1802
                        self.final_file_id(self._new_parent[trans_id]),
 
1803
                        None, self._new_reference_revision[trans_id])
 
1804
                else:
 
1805
                    new_entry = inventory.make_entry(kind,
 
1806
                        self.final_name(trans_id),
 
1807
                        parent_file_id, file_id)
 
1808
                old_path = old_paths.get(new_entry.file_id)
 
1809
                new_executability = self._new_executability.get(trans_id)
 
1810
                if new_executability is not None:
 
1811
                    new_entry.executable = new_executability
 
1812
                inventory_delta.append(
 
1813
                    (old_path, path, new_entry.file_id, new_entry))
 
1814
        finally:
 
1815
            child_pb.finished()
 
1816
        return inventory_delta
 
1817
 
 
1818
    def _apply_removals(self, mover):
 
1819
        """Perform tree operations that remove directory/inventory names.
 
1820
 
 
1821
        That is, delete files that are to be deleted, and put any files that
 
1822
        need renaming into limbo.  This must be done in strict child-to-parent
 
1823
        order.
 
1824
 
 
1825
        If inventory_delta is None, no inventory delta generation is performed.
 
1826
        """
 
1827
        tree_paths = list(self._tree_path_ids.iteritems())
 
1828
        tree_paths.sort(reverse=True)
 
1829
        child_pb = ui.ui_factory.nested_progress_bar()
 
1830
        try:
 
1831
            for num, (path, trans_id) in enumerate(tree_paths):
 
1832
                # do not attempt to move root into a subdirectory of itself.
 
1833
                if path == '':
 
1834
                    continue
 
1835
                child_pb.update(gettext('removing file'), num, len(tree_paths))
 
1836
                full_path = self._tree.abspath(path)
 
1837
                if trans_id in self._removed_contents:
 
1838
                    delete_path = os.path.join(self._deletiondir, trans_id)
 
1839
                    mover.pre_delete(full_path, delete_path)
 
1840
                elif (trans_id in self._new_name
 
1841
                      or trans_id in self._new_parent):
 
1842
                    try:
 
1843
                        mover.rename(full_path, self._limbo_name(trans_id))
 
1844
                    except errors.TransformRenameFailed, e:
 
1845
                        if e.errno != errno.ENOENT:
 
1846
                            raise
 
1847
                    else:
 
1848
                        self.rename_count += 1
 
1849
        finally:
 
1850
            child_pb.finished()
 
1851
 
 
1852
    def _apply_insertions(self, mover):
 
1853
        """Perform tree operations that insert directory/inventory names.
 
1854
 
 
1855
        That is, create any files that need to be created, and restore from
 
1856
        limbo any files that needed renaming.  This must be done in strict
 
1857
        parent-to-child order.
 
1858
 
 
1859
        If inventory_delta is None, no inventory delta is calculated, and
 
1860
        no list of modified paths is returned.
 
1861
        """
 
1862
        new_paths = self.new_paths(filesystem_only=True)
 
1863
        modified_paths = []
 
1864
        new_path_file_ids = dict((t, self.final_file_id(t)) for p, t in
 
1865
                                 new_paths)
 
1866
        child_pb = ui.ui_factory.nested_progress_bar()
 
1867
        try:
 
1868
            for num, (path, trans_id) in enumerate(new_paths):
 
1869
                if (num % 10) == 0:
 
1870
                    child_pb.update(gettext('adding file'), num, len(new_paths))
 
1871
                full_path = self._tree.abspath(path)
 
1872
                if trans_id in self._needs_rename:
 
1873
                    try:
 
1874
                        mover.rename(self._limbo_name(trans_id), full_path)
 
1875
                    except errors.TransformRenameFailed, e:
 
1876
                        # We may be renaming a dangling inventory id
 
1877
                        if e.errno != errno.ENOENT:
 
1878
                            raise
 
1879
                    else:
 
1880
                        self.rename_count += 1
 
1881
                    # TODO: if trans_id in self._observed_sha1s, we should
 
1882
                    #       re-stat the final target, since ctime will be
 
1883
                    #       updated by the change.
 
1884
                if (trans_id in self._new_contents or
 
1885
                    self.path_changed(trans_id)):
 
1886
                    if trans_id in self._new_contents:
 
1887
                        modified_paths.append(full_path)
 
1888
                if trans_id in self._new_executability:
 
1889
                    self._set_executability(path, trans_id)
 
1890
                if trans_id in self._observed_sha1s:
 
1891
                    o_sha1, o_st_val = self._observed_sha1s[trans_id]
 
1892
                    st = osutils.lstat(full_path)
 
1893
                    self._observed_sha1s[trans_id] = (o_sha1, st)
 
1894
        finally:
 
1895
            child_pb.finished()
 
1896
        for path, trans_id in new_paths:
 
1897
            # new_paths includes stuff like workingtree conflicts. Only the
 
1898
            # stuff in new_contents actually comes from limbo.
 
1899
            if trans_id in self._limbo_files:
 
1900
                del self._limbo_files[trans_id]
 
1901
        self._new_contents.clear()
 
1902
        return modified_paths
 
1903
 
 
1904
    def _apply_observed_sha1s(self):
 
1905
        """After we have finished renaming everything, update observed sha1s
 
1906
 
 
1907
        This has to be done after self._tree.apply_inventory_delta, otherwise
 
1908
        it doesn't know anything about the files we are updating. Also, we want
 
1909
        to do this as late as possible, so that most entries end up cached.
 
1910
        """
 
1911
        # TODO: this doesn't update the stat information for directories. So
 
1912
        #       the first 'bzr status' will still need to rewrite
 
1913
        #       .bzr/checkout/dirstate. However, we at least don't need to
 
1914
        #       re-read all of the files.
 
1915
        # TODO: If the operation took a while, we could do a time.sleep(3) here
 
1916
        #       to allow the clock to tick over and ensure we won't have any
 
1917
        #       problems. (we could observe start time, and finish time, and if
 
1918
        #       it is less than eg 10% overhead, add a sleep call.)
 
1919
        paths = FinalPaths(self)
 
1920
        for trans_id, observed in self._observed_sha1s.iteritems():
 
1921
            path = paths.get_path(trans_id)
 
1922
            # We could get the file_id, but dirstate prefers to use the path
 
1923
            # anyway, and it is 'cheaper' to determine.
 
1924
            # file_id = self._new_id[trans_id]
 
1925
            self._tree._observed_sha1(None, path, observed)
 
1926
 
 
1927
 
 
1928
class TransformPreview(DiskTreeTransform):
 
1929
    """A TreeTransform for generating preview trees.
 
1930
 
 
1931
    Unlike TreeTransform, this version works when the input tree is a
 
1932
    RevisionTree, rather than a WorkingTree.  As a result, it tends to ignore
 
1933
    unversioned files in the input tree.
 
1934
    """
 
1935
 
 
1936
    def __init__(self, tree, pb=None, case_sensitive=True):
 
1937
        tree.lock_read()
 
1938
        limbodir = osutils.mkdtemp(prefix='bzr-limbo-')
 
1939
        DiskTreeTransform.__init__(self, tree, limbodir, pb, case_sensitive)
 
1940
 
 
1941
    def canonical_path(self, path):
 
1942
        return path
 
1943
 
 
1944
    def tree_kind(self, trans_id):
 
1945
        path = self._tree_id_paths.get(trans_id)
 
1946
        if path is None:
 
1947
            return None
 
1948
        kind = self._tree.path_content_summary(path)[0]
 
1949
        if kind == 'missing':
 
1950
            kind = None
 
1951
        return kind
 
1952
 
 
1953
    def _set_mode(self, trans_id, mode_id, typefunc):
 
1954
        """Set the mode of new file contents.
 
1955
        The mode_id is the existing file to get the mode from (often the same
 
1956
        as trans_id).  The operation is only performed if there's a mode match
 
1957
        according to typefunc.
 
1958
        """
 
1959
        # is it ok to ignore this?  probably
 
1960
        pass
 
1961
 
 
1962
    def iter_tree_children(self, parent_id):
 
1963
        """Iterate through the entry's tree children, if any"""
 
1964
        try:
 
1965
            path = self._tree_id_paths[parent_id]
 
1966
        except KeyError:
 
1967
            return
 
1968
        file_id = self.tree_file_id(parent_id)
 
1969
        if file_id is None:
 
1970
            return
 
1971
        entry = self._tree.iter_entries_by_dir([file_id]).next()[1]
 
1972
        children = getattr(entry, 'children', {})
 
1973
        for child in children:
 
1974
            childpath = joinpath(path, child)
 
1975
            yield self.trans_id_tree_path(childpath)
 
1976
 
 
1977
    def new_orphan(self, trans_id, parent_id):
 
1978
        raise NotImplementedError(self.new_orphan)
 
1979
 
 
1980
 
 
1981
class _PreviewTree(tree.InventoryTree):
 
1982
    """Partial implementation of Tree to support show_diff_trees"""
 
1983
 
 
1984
    def __init__(self, transform):
 
1985
        self._transform = transform
 
1986
        self._final_paths = FinalPaths(transform)
 
1987
        self.__by_parent = None
 
1988
        self._parent_ids = []
 
1989
        self._all_children_cache = {}
 
1990
        self._path2trans_id_cache = {}
 
1991
        self._final_name_cache = {}
 
1992
        self._iter_changes_cache = dict((c[0], c) for c in
 
1993
                                        self._transform.iter_changes())
 
1994
 
 
1995
    def _content_change(self, file_id):
 
1996
        """Return True if the content of this file changed"""
 
1997
        changes = self._iter_changes_cache.get(file_id)
 
1998
        # changes[2] is true if the file content changed.  See
 
1999
        # InterTree.iter_changes.
 
2000
        return (changes is not None and changes[2])
 
2001
 
 
2002
    def _get_repository(self):
 
2003
        repo = getattr(self._transform._tree, '_repository', None)
 
2004
        if repo is None:
 
2005
            repo = self._transform._tree.branch.repository
 
2006
        return repo
 
2007
 
 
2008
    def _iter_parent_trees(self):
 
2009
        for revision_id in self.get_parent_ids():
 
2010
            try:
 
2011
                yield self.revision_tree(revision_id)
 
2012
            except errors.NoSuchRevisionInTree:
 
2013
                yield self._get_repository().revision_tree(revision_id)
 
2014
 
 
2015
    def _get_file_revision(self, file_id, vf, tree_revision):
 
2016
        parent_keys = [(file_id, t.get_file_revision(file_id)) for t in
 
2017
                       self._iter_parent_trees()]
 
2018
        vf.add_lines((file_id, tree_revision), parent_keys,
 
2019
                     self.get_file_lines(file_id))
 
2020
        repo = self._get_repository()
 
2021
        base_vf = repo.texts
 
2022
        if base_vf not in vf.fallback_versionedfiles:
 
2023
            vf.fallback_versionedfiles.append(base_vf)
 
2024
        return tree_revision
 
2025
 
 
2026
    def _stat_limbo_file(self, file_id=None, trans_id=None):
 
2027
        if trans_id is None:
 
2028
            trans_id = self._transform.trans_id_file_id(file_id)
 
2029
        name = self._transform._limbo_name(trans_id)
 
2030
        return os.lstat(name)
 
2031
 
 
2032
    @property
 
2033
    def _by_parent(self):
 
2034
        if self.__by_parent is None:
 
2035
            self.__by_parent = self._transform.by_parent()
 
2036
        return self.__by_parent
 
2037
 
 
2038
    def _comparison_data(self, entry, path):
 
2039
        kind, size, executable, link_or_sha1 = self.path_content_summary(path)
 
2040
        if kind == 'missing':
 
2041
            kind = None
 
2042
            executable = False
 
2043
        else:
 
2044
            file_id = self._transform.final_file_id(self._path2trans_id(path))
 
2045
            executable = self.is_executable(file_id, path)
 
2046
        return kind, executable, None
 
2047
 
 
2048
    def is_locked(self):
 
2049
        return False
 
2050
 
 
2051
    def lock_read(self):
 
2052
        # Perhaps in theory, this should lock the TreeTransform?
 
2053
        return self
 
2054
 
 
2055
    def unlock(self):
 
2056
        pass
 
2057
 
 
2058
    @property
 
2059
    @deprecated_method(deprecated_in((2, 5, 0)))
 
2060
    def inventory(self):
 
2061
        """This Tree does not use inventory as its backing data."""
 
2062
        raise NotImplementedError(_PreviewTree.inventory)
 
2063
 
 
2064
    @property
 
2065
    def root_inventory(self):
 
2066
        """This Tree does not use inventory as its backing data."""
 
2067
        raise NotImplementedError(_PreviewTree.root_inventory)
 
2068
 
 
2069
    def get_root_id(self):
 
2070
        return self._transform.final_file_id(self._transform.root)
 
2071
 
 
2072
    def all_file_ids(self):
 
2073
        tree_ids = set(self._transform._tree.all_file_ids())
 
2074
        tree_ids.difference_update(self._transform.tree_file_id(t)
 
2075
                                   for t in self._transform._removed_id)
 
2076
        tree_ids.update(self._transform._new_id.values())
 
2077
        return tree_ids
 
2078
 
 
2079
    def __iter__(self):
 
2080
        return iter(self.all_file_ids())
 
2081
 
 
2082
    def _has_id(self, file_id, fallback_check):
 
2083
        if file_id in self._transform._r_new_id:
 
2084
            return True
 
2085
        elif file_id in set([self._transform.tree_file_id(trans_id) for
 
2086
            trans_id in self._transform._removed_id]):
 
2087
            return False
 
2088
        else:
 
2089
            return fallback_check(file_id)
 
2090
 
 
2091
    def has_id(self, file_id):
 
2092
        return self._has_id(file_id, self._transform._tree.has_id)
 
2093
 
 
2094
    def has_or_had_id(self, file_id):
 
2095
        return self._has_id(file_id, self._transform._tree.has_or_had_id)
 
2096
 
 
2097
    def _path2trans_id(self, path):
 
2098
        # We must not use None here, because that is a valid value to store.
 
2099
        trans_id = self._path2trans_id_cache.get(path, object)
 
2100
        if trans_id is not object:
 
2101
            return trans_id
 
2102
        segments = splitpath(path)
 
2103
        cur_parent = self._transform.root
 
2104
        for cur_segment in segments:
 
2105
            for child in self._all_children(cur_parent):
 
2106
                final_name = self._final_name_cache.get(child)
 
2107
                if final_name is None:
 
2108
                    final_name = self._transform.final_name(child)
 
2109
                    self._final_name_cache[child] = final_name
 
2110
                if final_name == cur_segment:
 
2111
                    cur_parent = child
 
2112
                    break
 
2113
            else:
 
2114
                self._path2trans_id_cache[path] = None
 
2115
                return None
 
2116
        self._path2trans_id_cache[path] = cur_parent
 
2117
        return cur_parent
 
2118
 
 
2119
    def path2id(self, path):
 
2120
        return self._transform.final_file_id(self._path2trans_id(path))
 
2121
 
 
2122
    def id2path(self, file_id):
 
2123
        trans_id = self._transform.trans_id_file_id(file_id)
 
2124
        try:
 
2125
            return self._final_paths._determine_path(trans_id)
 
2126
        except NoFinalPath:
 
2127
            raise errors.NoSuchId(self, file_id)
 
2128
 
 
2129
    def _all_children(self, trans_id):
 
2130
        children = self._all_children_cache.get(trans_id)
 
2131
        if children is not None:
 
2132
            return children
 
2133
        children = set(self._transform.iter_tree_children(trans_id))
 
2134
        # children in the _new_parent set are provided by _by_parent.
 
2135
        children.difference_update(self._transform._new_parent.keys())
 
2136
        children.update(self._by_parent.get(trans_id, []))
 
2137
        self._all_children_cache[trans_id] = children
 
2138
        return children
 
2139
 
 
2140
    def iter_children(self, file_id):
 
2141
        trans_id = self._transform.trans_id_file_id(file_id)
 
2142
        for child_trans_id in self._all_children(trans_id):
 
2143
            yield self._transform.final_file_id(child_trans_id)
 
2144
 
 
2145
    def extras(self):
 
2146
        possible_extras = set(self._transform.trans_id_tree_path(p) for p
 
2147
                              in self._transform._tree.extras())
 
2148
        possible_extras.update(self._transform._new_contents)
 
2149
        possible_extras.update(self._transform._removed_id)
 
2150
        for trans_id in possible_extras:
 
2151
            if self._transform.final_file_id(trans_id) is None:
 
2152
                yield self._final_paths._determine_path(trans_id)
 
2153
 
 
2154
    def _make_inv_entries(self, ordered_entries, specific_file_ids=None,
 
2155
        yield_parents=False):
 
2156
        for trans_id, parent_file_id in ordered_entries:
 
2157
            file_id = self._transform.final_file_id(trans_id)
 
2158
            if file_id is None:
 
2159
                continue
 
2160
            if (specific_file_ids is not None
 
2161
                and file_id not in specific_file_ids):
 
2162
                continue
 
2163
            kind = self._transform.final_kind(trans_id)
 
2164
            if kind is None:
 
2165
                kind = self._transform._tree.stored_kind(file_id)
 
2166
            new_entry = inventory.make_entry(
 
2167
                kind,
 
2168
                self._transform.final_name(trans_id),
 
2169
                parent_file_id, file_id)
 
2170
            yield new_entry, trans_id
 
2171
 
 
2172
    def _list_files_by_dir(self):
 
2173
        todo = [ROOT_PARENT]
 
2174
        ordered_ids = []
 
2175
        while len(todo) > 0:
 
2176
            parent = todo.pop()
 
2177
            parent_file_id = self._transform.final_file_id(parent)
 
2178
            children = list(self._all_children(parent))
 
2179
            paths = dict(zip(children, self._final_paths.get_paths(children)))
 
2180
            children.sort(key=paths.get)
 
2181
            todo.extend(reversed(children))
 
2182
            for trans_id in children:
 
2183
                ordered_ids.append((trans_id, parent_file_id))
 
2184
        return ordered_ids
 
2185
 
 
2186
    def iter_entries_by_dir(self, specific_file_ids=None, yield_parents=False):
 
2187
        # This may not be a maximally efficient implementation, but it is
 
2188
        # reasonably straightforward.  An implementation that grafts the
 
2189
        # TreeTransform changes onto the tree's iter_entries_by_dir results
 
2190
        # might be more efficient, but requires tricky inferences about stack
 
2191
        # position.
 
2192
        ordered_ids = self._list_files_by_dir()
 
2193
        for entry, trans_id in self._make_inv_entries(ordered_ids,
 
2194
            specific_file_ids, yield_parents=yield_parents):
 
2195
            yield unicode(self._final_paths.get_path(trans_id)), entry
 
2196
 
 
2197
    def _iter_entries_for_dir(self, dir_path):
 
2198
        """Return path, entry for items in a directory without recursing down."""
 
2199
        dir_file_id = self.path2id(dir_path)
 
2200
        ordered_ids = []
 
2201
        for file_id in self.iter_children(dir_file_id):
 
2202
            trans_id = self._transform.trans_id_file_id(file_id)
 
2203
            ordered_ids.append((trans_id, file_id))
 
2204
        for entry, trans_id in self._make_inv_entries(ordered_ids):
 
2205
            yield unicode(self._final_paths.get_path(trans_id)), entry
 
2206
 
 
2207
    def list_files(self, include_root=False, from_dir=None, recursive=True):
 
2208
        """See WorkingTree.list_files."""
 
2209
        # XXX This should behave like WorkingTree.list_files, but is really
 
2210
        # more like RevisionTree.list_files.
 
2211
        if recursive:
 
2212
            prefix = None
 
2213
            if from_dir:
 
2214
                prefix = from_dir + '/'
 
2215
            entries = self.iter_entries_by_dir()
 
2216
            for path, entry in entries:
 
2217
                if entry.name == '' and not include_root:
 
2218
                    continue
 
2219
                if prefix:
 
2220
                    if not path.startswith(prefix):
 
2221
                        continue
 
2222
                    path = path[len(prefix):]
 
2223
                yield path, 'V', entry.kind, entry.file_id, entry
 
2224
        else:
 
2225
            if from_dir is None and include_root is True:
 
2226
                root_entry = inventory.make_entry('directory', '',
 
2227
                    ROOT_PARENT, self.get_root_id())
 
2228
                yield '', 'V', 'directory', root_entry.file_id, root_entry
 
2229
            entries = self._iter_entries_for_dir(from_dir or '')
 
2230
            for path, entry in entries:
 
2231
                yield path, 'V', entry.kind, entry.file_id, entry
 
2232
 
 
2233
    def kind(self, file_id):
 
2234
        trans_id = self._transform.trans_id_file_id(file_id)
 
2235
        return self._transform.final_kind(trans_id)
 
2236
 
 
2237
    def stored_kind(self, file_id):
 
2238
        trans_id = self._transform.trans_id_file_id(file_id)
 
2239
        try:
 
2240
            return self._transform._new_contents[trans_id]
 
2241
        except KeyError:
 
2242
            return self._transform._tree.stored_kind(file_id)
 
2243
 
 
2244
    def get_file_mtime(self, file_id, path=None):
 
2245
        """See Tree.get_file_mtime"""
 
2246
        if not self._content_change(file_id):
 
2247
            return self._transform._tree.get_file_mtime(file_id)
 
2248
        return self._stat_limbo_file(file_id).st_mtime
 
2249
 
 
2250
    def _file_size(self, entry, stat_value):
 
2251
        return self.get_file_size(entry.file_id)
 
2252
 
 
2253
    def get_file_size(self, file_id):
 
2254
        """See Tree.get_file_size"""
 
2255
        trans_id = self._transform.trans_id_file_id(file_id)
 
2256
        kind = self._transform.final_kind(trans_id)
 
2257
        if kind != 'file':
 
2258
            return None
 
2259
        if trans_id in self._transform._new_contents:
 
2260
            return self._stat_limbo_file(trans_id=trans_id).st_size
 
2261
        if self.kind(file_id) == 'file':
 
2262
            return self._transform._tree.get_file_size(file_id)
 
2263
        else:
 
2264
            return None
 
2265
 
 
2266
    def get_file_verifier(self, file_id, path=None, stat_value=None):
 
2267
        trans_id = self._transform.trans_id_file_id(file_id)
 
2268
        kind = self._transform._new_contents.get(trans_id)
 
2269
        if kind is None:
 
2270
            return self._transform._tree.get_file_verifier(file_id)
 
2271
        if kind == 'file':
 
2272
            fileobj = self.get_file(file_id)
 
2273
            try:
 
2274
                return ("SHA1", sha_file(fileobj))
 
2275
            finally:
 
2276
                fileobj.close()
 
2277
 
 
2278
    def get_file_sha1(self, file_id, path=None, stat_value=None):
 
2279
        trans_id = self._transform.trans_id_file_id(file_id)
 
2280
        kind = self._transform._new_contents.get(trans_id)
 
2281
        if kind is None:
 
2282
            return self._transform._tree.get_file_sha1(file_id)
 
2283
        if kind == 'file':
 
2284
            fileobj = self.get_file(file_id)
 
2285
            try:
 
2286
                return sha_file(fileobj)
 
2287
            finally:
 
2288
                fileobj.close()
 
2289
 
 
2290
    def is_executable(self, file_id, path=None):
 
2291
        if file_id is None:
 
2292
            return False
 
2293
        trans_id = self._transform.trans_id_file_id(file_id)
 
2294
        try:
 
2295
            return self._transform._new_executability[trans_id]
 
2296
        except KeyError:
 
2297
            try:
 
2298
                return self._transform._tree.is_executable(file_id, path)
 
2299
            except OSError, e:
 
2300
                if e.errno == errno.ENOENT:
 
2301
                    return False
 
2302
                raise
 
2303
            except errors.NoSuchId:
 
2304
                return False
 
2305
 
 
2306
    def has_filename(self, path):
 
2307
        trans_id = self._path2trans_id(path)
 
2308
        if trans_id in self._transform._new_contents:
 
2309
            return True
 
2310
        elif trans_id in self._transform._removed_contents:
 
2311
            return False
 
2312
        else:
 
2313
            return self._transform._tree.has_filename(path)
 
2314
 
 
2315
    def path_content_summary(self, path):
 
2316
        trans_id = self._path2trans_id(path)
 
2317
        tt = self._transform
 
2318
        tree_path = tt._tree_id_paths.get(trans_id)
 
2319
        kind = tt._new_contents.get(trans_id)
 
2320
        if kind is None:
 
2321
            if tree_path is None or trans_id in tt._removed_contents:
 
2322
                return 'missing', None, None, None
 
2323
            summary = tt._tree.path_content_summary(tree_path)
 
2324
            kind, size, executable, link_or_sha1 = summary
 
2325
        else:
 
2326
            link_or_sha1 = None
 
2327
            limbo_name = tt._limbo_name(trans_id)
 
2328
            if trans_id in tt._new_reference_revision:
 
2329
                kind = 'tree-reference'
 
2330
            if kind == 'file':
 
2331
                statval = os.lstat(limbo_name)
 
2332
                size = statval.st_size
 
2333
                if not tt._limbo_supports_executable():
 
2334
                    executable = False
 
2335
                else:
 
2336
                    executable = statval.st_mode & S_IEXEC
 
2337
            else:
 
2338
                size = None
 
2339
                executable = None
 
2340
            if kind == 'symlink':
 
2341
                link_or_sha1 = os.readlink(limbo_name).decode(osutils._fs_enc)
 
2342
        executable = tt._new_executability.get(trans_id, executable)
 
2343
        return kind, size, executable, link_or_sha1
 
2344
 
 
2345
    def iter_changes(self, from_tree, include_unchanged=False,
 
2346
                      specific_files=None, pb=None, extra_trees=None,
 
2347
                      require_versioned=True, want_unversioned=False):
 
2348
        """See InterTree.iter_changes.
 
2349
 
 
2350
        This has a fast path that is only used when the from_tree matches
 
2351
        the transform tree, and no fancy options are supplied.
 
2352
        """
 
2353
        if (from_tree is not self._transform._tree or include_unchanged or
 
2354
            specific_files or want_unversioned):
 
2355
            return tree.InterTree(from_tree, self).iter_changes(
 
2356
                include_unchanged=include_unchanged,
 
2357
                specific_files=specific_files,
 
2358
                pb=pb,
 
2359
                extra_trees=extra_trees,
 
2360
                require_versioned=require_versioned,
 
2361
                want_unversioned=want_unversioned)
 
2362
        if want_unversioned:
 
2363
            raise ValueError('want_unversioned is not supported')
 
2364
        return self._transform.iter_changes()
 
2365
 
 
2366
    def get_file(self, file_id, path=None):
 
2367
        """See Tree.get_file"""
 
2368
        if not self._content_change(file_id):
 
2369
            return self._transform._tree.get_file(file_id, path)
 
2370
        trans_id = self._transform.trans_id_file_id(file_id)
 
2371
        name = self._transform._limbo_name(trans_id)
 
2372
        return open(name, 'rb')
 
2373
 
 
2374
    def get_file_with_stat(self, file_id, path=None):
 
2375
        return self.get_file(file_id, path), None
 
2376
 
 
2377
    def annotate_iter(self, file_id,
 
2378
                      default_revision=_mod_revision.CURRENT_REVISION):
 
2379
        changes = self._iter_changes_cache.get(file_id)
 
2380
        if changes is None:
 
2381
            get_old = True
 
2382
        else:
 
2383
            changed_content, versioned, kind = (changes[2], changes[3],
 
2384
                                                changes[6])
 
2385
            if kind[1] is None:
 
2386
                return None
 
2387
            get_old = (kind[0] == 'file' and versioned[0])
 
2388
        if get_old:
 
2389
            old_annotation = self._transform._tree.annotate_iter(file_id,
 
2390
                default_revision=default_revision)
 
2391
        else:
 
2392
            old_annotation = []
 
2393
        if changes is None:
 
2394
            return old_annotation
 
2395
        if not changed_content:
 
2396
            return old_annotation
 
2397
        # TODO: This is doing something similar to what WT.annotate_iter is
 
2398
        #       doing, however it fails slightly because it doesn't know what
 
2399
        #       the *other* revision_id is, so it doesn't know how to give the
 
2400
        #       other as the origin for some lines, they all get
 
2401
        #       'default_revision'
 
2402
        #       It would be nice to be able to use the new Annotator based
 
2403
        #       approach, as well.
 
2404
        return annotate.reannotate([old_annotation],
 
2405
                                   self.get_file(file_id).readlines(),
 
2406
                                   default_revision)
 
2407
 
 
2408
    def get_symlink_target(self, file_id, path=None):
 
2409
        """See Tree.get_symlink_target"""
 
2410
        if not self._content_change(file_id):
 
2411
            return self._transform._tree.get_symlink_target(file_id)
 
2412
        trans_id = self._transform.trans_id_file_id(file_id)
 
2413
        name = self._transform._limbo_name(trans_id)
 
2414
        return osutils.readlink(name)
 
2415
 
 
2416
    def walkdirs(self, prefix=''):
 
2417
        pending = [self._transform.root]
 
2418
        while len(pending) > 0:
 
2419
            parent_id = pending.pop()
 
2420
            children = []
 
2421
            subdirs = []
 
2422
            prefix = prefix.rstrip('/')
 
2423
            parent_path = self._final_paths.get_path(parent_id)
 
2424
            parent_file_id = self._transform.final_file_id(parent_id)
 
2425
            for child_id in self._all_children(parent_id):
 
2426
                path_from_root = self._final_paths.get_path(child_id)
 
2427
                basename = self._transform.final_name(child_id)
 
2428
                file_id = self._transform.final_file_id(child_id)
 
2429
                kind  = self._transform.final_kind(child_id)
 
2430
                if kind is not None:
 
2431
                    versioned_kind = kind
 
2432
                else:
 
2433
                    kind = 'unknown'
 
2434
                    versioned_kind = self._transform._tree.stored_kind(file_id)
 
2435
                if versioned_kind == 'directory':
 
2436
                    subdirs.append(child_id)
 
2437
                children.append((path_from_root, basename, kind, None,
 
2438
                                 file_id, versioned_kind))
 
2439
            children.sort()
 
2440
            if parent_path.startswith(prefix):
 
2441
                yield (parent_path, parent_file_id), children
 
2442
            pending.extend(sorted(subdirs, key=self._final_paths.get_path,
 
2443
                                  reverse=True))
 
2444
 
 
2445
    def get_parent_ids(self):
 
2446
        return self._parent_ids
 
2447
 
 
2448
    def set_parent_ids(self, parent_ids):
 
2449
        self._parent_ids = parent_ids
 
2450
 
 
2451
    def get_revision_tree(self, revision_id):
 
2452
        return self._transform._tree.get_revision_tree(revision_id)
 
2453
 
1204
2454
 
1205
2455
def joinpath(parent, child):
1206
2456
    """Join tree-relative paths, handling the tree root specially"""
1222
2472
        self.transform = transform
1223
2473
 
1224
2474
    def _determine_path(self, trans_id):
1225
 
        if trans_id == self.transform.root:
 
2475
        if (trans_id == self.transform.root or trans_id == ROOT_PARENT):
1226
2476
            return ""
1227
2477
        name = self.transform.final_name(trans_id)
1228
2478
        parent_id = self.transform.final_parent(trans_id)
1237
2487
            self._known_paths[trans_id] = self._determine_path(trans_id)
1238
2488
        return self._known_paths[trans_id]
1239
2489
 
 
2490
    def get_paths(self, trans_ids):
 
2491
        return [(self.get_path(t), t) for t in trans_ids]
 
2492
 
 
2493
 
 
2494
 
1240
2495
def topology_sorted_ids(tree):
1241
2496
    """Determine the topological order of the ids in a tree"""
1242
2497
    file_ids = list(tree)
1244
2499
    return file_ids
1245
2500
 
1246
2501
 
1247
 
def build_tree(tree, wt):
 
2502
def build_tree(tree, wt, accelerator_tree=None, hardlink=False,
 
2503
               delta_from_tree=False):
1248
2504
    """Create working tree for a branch, using a TreeTransform.
1249
 
    
 
2505
 
1250
2506
    This function should be used on empty trees, having a tree root at most.
1251
2507
    (see merge and revert functionality for working with existing trees)
1252
2508
 
1253
2509
    Existing files are handled like so:
1254
 
    
 
2510
 
1255
2511
    - Existing bzrdirs take precedence over creating new items.  They are
1256
2512
      created as '%s.diverted' % name.
1257
2513
    - Otherwise, if the content on disk matches the content we are building,
1258
2514
      it is silently replaced.
1259
2515
    - Otherwise, conflict resolution will move the old file to 'oldname.moved'.
 
2516
 
 
2517
    :param tree: The tree to convert wt into a copy of
 
2518
    :param wt: The working tree that files will be placed into
 
2519
    :param accelerator_tree: A tree which can be used for retrieving file
 
2520
        contents more quickly than tree itself, i.e. a workingtree.  tree
 
2521
        will be used for cases where accelerator_tree's content is different.
 
2522
    :param hardlink: If true, hard-link files to accelerator_tree, where
 
2523
        possible.  accelerator_tree must implement abspath, i.e. be a
 
2524
        working tree.
 
2525
    :param delta_from_tree: If true, build_tree may use the input Tree to
 
2526
        generate the inventory delta.
1260
2527
    """
1261
2528
    wt.lock_tree_write()
1262
2529
    try:
1263
2530
        tree.lock_read()
1264
2531
        try:
1265
 
            return _build_tree(tree, wt)
 
2532
            if accelerator_tree is not None:
 
2533
                accelerator_tree.lock_read()
 
2534
            try:
 
2535
                return _build_tree(tree, wt, accelerator_tree, hardlink,
 
2536
                                   delta_from_tree)
 
2537
            finally:
 
2538
                if accelerator_tree is not None:
 
2539
                    accelerator_tree.unlock()
1266
2540
        finally:
1267
2541
            tree.unlock()
1268
2542
    finally:
1269
2543
        wt.unlock()
1270
2544
 
1271
 
def _build_tree(tree, wt):
 
2545
 
 
2546
def _build_tree(tree, wt, accelerator_tree, hardlink, delta_from_tree):
1272
2547
    """See build_tree."""
1273
 
    if len(wt.inventory) > 1:  # more than just a root
1274
 
        raise errors.WorkingTreeAlreadyPopulated(base=wt.basedir)
 
2548
    for num, _unused in enumerate(wt.all_file_ids()):
 
2549
        if num > 0:  # more than just a root
 
2550
            raise errors.WorkingTreeAlreadyPopulated(base=wt.basedir)
1275
2551
    file_trans_id = {}
1276
 
    top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
2552
    top_pb = ui.ui_factory.nested_progress_bar()
1277
2553
    pp = ProgressPhase("Build phase", 2, top_pb)
1278
 
    if tree.inventory.root is not None:
 
2554
    if tree.get_root_id() is not None:
1279
2555
        # This is kind of a hack: we should be altering the root
1280
2556
        # as part of the regular tree shape diff logic.
1281
2557
        # The conditional test here is to avoid doing an
1283
2559
        # is set within the tree, nor setting the root and thus
1284
2560
        # marking the tree as dirty, because we use two different
1285
2561
        # idioms here: tree interfaces and inventory interfaces.
1286
 
        if wt.path2id('') != tree.inventory.root.file_id:
1287
 
            wt.set_root_id(tree.inventory.root.file_id)
 
2562
        if wt.get_root_id() != tree.get_root_id():
 
2563
            wt.set_root_id(tree.get_root_id())
1288
2564
            wt.flush()
1289
2565
    tt = TreeTransform(wt)
1290
2566
    divert = set()
1292
2568
        pp.next_phase()
1293
2569
        file_trans_id[wt.get_root_id()] = \
1294
2570
            tt.trans_id_tree_file_id(wt.get_root_id())
1295
 
        pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
2571
        pb = ui.ui_factory.nested_progress_bar()
1296
2572
        try:
1297
2573
            deferred_contents = []
 
2574
            num = 0
 
2575
            total = len(tree.all_file_ids())
 
2576
            if delta_from_tree:
 
2577
                precomputed_delta = []
 
2578
            else:
 
2579
                precomputed_delta = None
 
2580
            # Check if tree inventory has content. If so, we populate
 
2581
            # existing_files with the directory content. If there are no
 
2582
            # entries we skip populating existing_files as its not used.
 
2583
            # This improves performance and unncessary work on large
 
2584
            # directory trees. (#501307)
 
2585
            if total > 0:
 
2586
                existing_files = set()
 
2587
                for dir, files in wt.walkdirs():
 
2588
                    existing_files.update(f[0] for f in files)
1298
2589
            for num, (tree_path, entry) in \
1299
 
                enumerate(tree.inventory.iter_entries_by_dir()):
1300
 
                pb.update("Building tree", num - len(deferred_contents),
1301
 
                          len(tree.inventory))
 
2590
                enumerate(tree.iter_entries_by_dir()):
 
2591
                pb.update(gettext("Building tree"), num - len(deferred_contents), total)
1302
2592
                if entry.parent_id is None:
1303
2593
                    continue
1304
2594
                reparent = False
1305
2595
                file_id = entry.file_id
1306
 
                target_path = wt.abspath(tree_path)
1307
 
                try:
 
2596
                if delta_from_tree:
 
2597
                    precomputed_delta.append((None, tree_path, file_id, entry))
 
2598
                if tree_path in existing_files:
 
2599
                    target_path = wt.abspath(tree_path)
1308
2600
                    kind = file_kind(target_path)
1309
 
                except NoSuchFile:
1310
 
                    pass
1311
 
                else:
1312
2601
                    if kind == "directory":
1313
2602
                        try:
1314
 
                            bzrdir.BzrDir.open(target_path)
 
2603
                            controldir.ControlDir.open(target_path)
1315
2604
                        except errors.NotBranchError:
1316
2605
                            pass
1317
2606
                        else:
1322
2611
                        tt.delete_contents(tt.trans_id_tree_path(tree_path))
1323
2612
                        if kind == 'directory':
1324
2613
                            reparent = True
1325
 
                if entry.parent_id not in file_trans_id:
1326
 
                    raise AssertionError(
1327
 
                        'entry %s parent id %r is not in file_trans_id %r'
1328
 
                        % (entry, entry.parent_id, file_trans_id))
1329
2614
                parent_id = file_trans_id[entry.parent_id]
1330
2615
                if entry.kind == 'file':
1331
2616
                    # We *almost* replicate new_by_entry, so that we can defer
1332
2617
                    # getting the file text, and get them all at once.
1333
2618
                    trans_id = tt.create_path(entry.name, parent_id)
1334
2619
                    file_trans_id[file_id] = trans_id
1335
 
                    tt.version_file(entry.file_id, trans_id)
1336
 
                    executable = tree.is_executable(entry.file_id, tree_path)
1337
 
                    if executable is not None:
 
2620
                    tt.version_file(file_id, trans_id)
 
2621
                    executable = tree.is_executable(file_id, tree_path)
 
2622
                    if executable:
1338
2623
                        tt.set_executability(executable, trans_id)
1339
 
                    deferred_contents.append((entry.file_id, trans_id))
 
2624
                    trans_data = (trans_id, tree_path, entry.text_sha1)
 
2625
                    deferred_contents.append((file_id, trans_data))
1340
2626
                else:
1341
2627
                    file_trans_id[file_id] = new_by_entry(tt, entry, parent_id,
1342
2628
                                                          tree)
1344
2630
                    new_trans_id = file_trans_id[file_id]
1345
2631
                    old_parent = tt.trans_id_tree_path(tree_path)
1346
2632
                    _reparent_children(tt, old_parent, new_trans_id)
1347
 
            for num, (trans_id, bytes) in enumerate(
1348
 
                tree.iter_files_bytes(deferred_contents)):
1349
 
                tt.create_file(bytes, trans_id)
1350
 
                pb.update('Adding file contents',
1351
 
                          (num + len(tree.inventory) - len(deferred_contents)),
1352
 
                          len(tree.inventory))
 
2633
            offset = num + 1 - len(deferred_contents)
 
2634
            _create_files(tt, tree, deferred_contents, pb, offset,
 
2635
                          accelerator_tree, hardlink)
1353
2636
        finally:
1354
2637
            pb.finished()
1355
2638
        pp.next_phase()
1356
2639
        divert_trans = set(file_trans_id[f] for f in divert)
1357
2640
        resolver = lambda t, c: resolve_checkout(t, c, divert_trans)
1358
2641
        raw_conflicts = resolve_conflicts(tt, pass_func=resolver)
 
2642
        if len(raw_conflicts) > 0:
 
2643
            precomputed_delta = None
1359
2644
        conflicts = cook_conflicts(raw_conflicts, tt)
1360
2645
        for conflict in conflicts:
1361
 
            warning(conflict)
 
2646
            trace.warning(unicode(conflict))
1362
2647
        try:
1363
2648
            wt.add_conflicts(conflicts)
1364
2649
        except errors.UnsupportedOperation:
1365
2650
            pass
1366
 
        result = tt.apply()
 
2651
        result = tt.apply(no_conflicts=True,
 
2652
                          precomputed_delta=precomputed_delta)
1367
2653
    finally:
1368
2654
        tt.finalize()
1369
2655
        top_pb.finished()
1370
2656
    return result
1371
2657
 
1372
2658
 
 
2659
def _create_files(tt, tree, desired_files, pb, offset, accelerator_tree,
 
2660
                  hardlink):
 
2661
    total = len(desired_files) + offset
 
2662
    wt = tt._tree
 
2663
    if accelerator_tree is None:
 
2664
        new_desired_files = desired_files
 
2665
    else:
 
2666
        iter = accelerator_tree.iter_changes(tree, include_unchanged=True)
 
2667
        unchanged = [(f, p[1]) for (f, p, c, v, d, n, k, e)
 
2668
                     in iter if not (c or e[0] != e[1])]
 
2669
        if accelerator_tree.supports_content_filtering():
 
2670
            unchanged = [(f, p) for (f, p) in unchanged
 
2671
                         if not accelerator_tree.iter_search_rules([p]).next()]
 
2672
        unchanged = dict(unchanged)
 
2673
        new_desired_files = []
 
2674
        count = 0
 
2675
        for file_id, (trans_id, tree_path, text_sha1) in desired_files:
 
2676
            accelerator_path = unchanged.get(file_id)
 
2677
            if accelerator_path is None:
 
2678
                new_desired_files.append((file_id,
 
2679
                    (trans_id, tree_path, text_sha1)))
 
2680
                continue
 
2681
            pb.update(gettext('Adding file contents'), count + offset, total)
 
2682
            if hardlink:
 
2683
                tt.create_hardlink(accelerator_tree.abspath(accelerator_path),
 
2684
                                   trans_id)
 
2685
            else:
 
2686
                contents = accelerator_tree.get_file(file_id, accelerator_path)
 
2687
                if wt.supports_content_filtering():
 
2688
                    filters = wt._content_filter_stack(tree_path)
 
2689
                    contents = filtered_output_bytes(contents, filters,
 
2690
                        ContentFilterContext(tree_path, tree))
 
2691
                try:
 
2692
                    tt.create_file(contents, trans_id, sha1=text_sha1)
 
2693
                finally:
 
2694
                    try:
 
2695
                        contents.close()
 
2696
                    except AttributeError:
 
2697
                        # after filtering, contents may no longer be file-like
 
2698
                        pass
 
2699
            count += 1
 
2700
        offset += count
 
2701
    for count, ((trans_id, tree_path, text_sha1), contents) in enumerate(
 
2702
            tree.iter_files_bytes(new_desired_files)):
 
2703
        if wt.supports_content_filtering():
 
2704
            filters = wt._content_filter_stack(tree_path)
 
2705
            contents = filtered_output_bytes(contents, filters,
 
2706
                ContentFilterContext(tree_path, tree))
 
2707
        tt.create_file(contents, trans_id, sha1=text_sha1)
 
2708
        pb.update(gettext('Adding file contents'), count + offset, total)
 
2709
 
 
2710
 
1373
2711
def _reparent_children(tt, old_parent, new_parent):
1374
2712
    for child in tt.iter_tree_children(old_parent):
1375
2713
        tt.adjust_path(tt.final_name(child), new_parent, child)
1376
2714
 
1377
2715
 
 
2716
def _reparent_transform_children(tt, old_parent, new_parent):
 
2717
    by_parent = tt.by_parent()
 
2718
    for child in by_parent[old_parent]:
 
2719
        tt.adjust_path(tt.final_name(child), new_parent, child)
 
2720
    return by_parent[old_parent]
 
2721
 
 
2722
 
1378
2723
def _content_match(tree, entry, file_id, kind, target_path):
1379
2724
    if entry.kind != kind:
1380
2725
        return False
1381
2726
    if entry.kind == "directory":
1382
2727
        return True
1383
2728
    if entry.kind == "file":
1384
 
        if tree.get_file(file_id).read() == file(target_path, 'rb').read():
1385
 
            return True
 
2729
        f = file(target_path, 'rb')
 
2730
        try:
 
2731
            if tree.get_file_text(file_id) == f.read():
 
2732
                return True
 
2733
        finally:
 
2734
            f.close()
1386
2735
    elif entry.kind == "symlink":
1387
2736
        if tree.get_symlink_target(file_id) == os.readlink(target_path):
1388
2737
            return True
1393
2742
    new_conflicts = set()
1394
2743
    for c_type, conflict in ((c[0], c) for c in conflicts):
1395
2744
        # Anything but a 'duplicate' would indicate programmer error
1396
 
        assert c_type == 'duplicate', c_type
 
2745
        if c_type != 'duplicate':
 
2746
            raise AssertionError(c_type)
1397
2747
        # Now figure out which is new and which is old
1398
2748
        if tt.new_contents(conflict[1]):
1399
2749
            new_file = conflict[1]
1425
2775
    if kind == 'file':
1426
2776
        contents = tree.get_file(entry.file_id).readlines()
1427
2777
        executable = tree.is_executable(entry.file_id)
1428
 
        return tt.new_file(name, parent_id, contents, entry.file_id, 
 
2778
        return tt.new_file(name, parent_id, contents, entry.file_id,
1429
2779
                           executable)
1430
2780
    elif kind in ('directory', 'tree-reference'):
1431
2781
        trans_id = tt.new_directory(name, parent_id, entry.file_id)
1432
2782
        if kind == 'tree-reference':
1433
2783
            tt.set_tree_reference(entry.reference_revision, trans_id)
1434
 
        return trans_id 
 
2784
        return trans_id
1435
2785
    elif kind == 'symlink':
1436
2786
        target = tree.get_symlink_target(entry.file_id)
1437
2787
        return tt.new_symlink(name, parent_id, target, entry.file_id)
1438
2788
    else:
1439
2789
        raise errors.BadFileKindError(name, kind)
1440
2790
 
1441
 
def create_by_entry(tt, entry, tree, trans_id, lines=None, mode_id=None):
1442
 
    """Create new file contents according to an inventory entry."""
1443
 
    if entry.kind == "file":
1444
 
        if lines is None:
1445
 
            lines = tree.get_file(entry.file_id).readlines()
1446
 
        tt.create_file(lines, trans_id, mode_id=mode_id)
1447
 
    elif entry.kind == "symlink":
1448
 
        tt.create_symlink(tree.get_symlink_target(entry.file_id), trans_id)
1449
 
    elif entry.kind == "directory":
 
2791
 
 
2792
def create_from_tree(tt, trans_id, tree, file_id, bytes=None,
 
2793
    filter_tree_path=None):
 
2794
    """Create new file contents according to tree contents.
 
2795
    
 
2796
    :param filter_tree_path: the tree path to use to lookup
 
2797
      content filters to apply to the bytes output in the working tree.
 
2798
      This only applies if the working tree supports content filtering.
 
2799
    """
 
2800
    kind = tree.kind(file_id)
 
2801
    if kind == 'directory':
1450
2802
        tt.create_directory(trans_id)
 
2803
    elif kind == "file":
 
2804
        if bytes is None:
 
2805
            tree_file = tree.get_file(file_id)
 
2806
            try:
 
2807
                bytes = tree_file.readlines()
 
2808
            finally:
 
2809
                tree_file.close()
 
2810
        wt = tt._tree
 
2811
        if wt.supports_content_filtering() and filter_tree_path is not None:
 
2812
            filters = wt._content_filter_stack(filter_tree_path)
 
2813
            bytes = filtered_output_bytes(bytes, filters,
 
2814
                ContentFilterContext(filter_tree_path, tree))
 
2815
        tt.create_file(bytes, trans_id)
 
2816
    elif kind == "symlink":
 
2817
        tt.create_symlink(tree.get_symlink_target(file_id), trans_id)
 
2818
    else:
 
2819
        raise AssertionError('Unknown kind %r' % kind)
 
2820
 
1451
2821
 
1452
2822
def create_entry_executability(tt, entry, trans_id):
1453
2823
    """Set the executability of a trans_id according to an inventory entry"""
1455
2825
        tt.set_executability(entry.executable, trans_id)
1456
2826
 
1457
2827
 
1458
 
@deprecated_function(zero_fifteen)
1459
 
def find_interesting(working_tree, target_tree, filenames):
1460
 
    """Find the ids corresponding to specified filenames.
1461
 
    
1462
 
    Deprecated: Please use tree1.paths2ids(filenames, [tree2]).
1463
 
    """
1464
 
    working_tree.lock_read()
1465
 
    try:
1466
 
        target_tree.lock_read()
1467
 
        try:
1468
 
            return working_tree.paths2ids(filenames, [target_tree])
1469
 
        finally:
1470
 
            target_tree.unlock()
1471
 
    finally:
1472
 
        working_tree.unlock()
1473
 
 
1474
 
 
1475
 
@deprecated_function(zero_ninety)
1476
 
def change_entry(tt, file_id, working_tree, target_tree, 
1477
 
                 trans_id_file_id, backups, trans_id, by_parent):
1478
 
    """Replace a file_id's contents with those from a target tree."""
1479
 
    if file_id is None and target_tree is None:
1480
 
        # skip the logic altogether in the deprecation test
1481
 
        return
1482
 
    e_trans_id = trans_id_file_id(file_id)
1483
 
    entry = target_tree.inventory[file_id]
1484
 
    has_contents, contents_mod, meta_mod, = _entry_changes(file_id, entry, 
1485
 
                                                           working_tree)
1486
 
    if contents_mod:
1487
 
        mode_id = e_trans_id
1488
 
        if has_contents:
1489
 
            if not backups:
1490
 
                tt.delete_contents(e_trans_id)
1491
 
            else:
1492
 
                parent_trans_id = trans_id_file_id(entry.parent_id)
1493
 
                backup_name = get_backup_name(entry, by_parent,
1494
 
                                              parent_trans_id, tt)
1495
 
                tt.adjust_path(backup_name, parent_trans_id, e_trans_id)
1496
 
                tt.unversion_file(e_trans_id)
1497
 
                e_trans_id = tt.create_path(entry.name, parent_trans_id)
1498
 
                tt.version_file(file_id, e_trans_id)
1499
 
                trans_id[file_id] = e_trans_id
1500
 
        create_by_entry(tt, entry, target_tree, e_trans_id, mode_id=mode_id)
1501
 
        create_entry_executability(tt, entry, e_trans_id)
1502
 
 
1503
 
    elif meta_mod:
1504
 
        tt.set_executability(entry.executable, e_trans_id)
1505
 
    if tt.final_name(e_trans_id) != entry.name:
1506
 
        adjust_path  = True
1507
 
    else:
1508
 
        parent_id = tt.final_parent(e_trans_id)
1509
 
        parent_file_id = tt.final_file_id(parent_id)
1510
 
        if parent_file_id != entry.parent_id:
1511
 
            adjust_path = True
1512
 
        else:
1513
 
            adjust_path = False
1514
 
    if adjust_path:
1515
 
        parent_trans_id = trans_id_file_id(entry.parent_id)
1516
 
        tt.adjust_path(entry.name, parent_trans_id, e_trans_id)
1517
 
 
1518
 
 
 
2828
@deprecated_function(deprecated_in((2, 3, 0)))
1519
2829
def get_backup_name(entry, by_parent, parent_trans_id, tt):
1520
2830
    return _get_backup_name(entry.name, by_parent, parent_trans_id, tt)
1521
2831
 
1522
2832
 
 
2833
@deprecated_function(deprecated_in((2, 3, 0)))
1523
2834
def _get_backup_name(name, by_parent, parent_trans_id, tt):
1524
2835
    """Produce a backup-style name that appears to be available"""
1525
2836
    def name_gen():
1532
2843
            return new_name
1533
2844
 
1534
2845
 
1535
 
def _entry_changes(file_id, entry, working_tree):
1536
 
    """Determine in which ways the inventory entry has changed.
1537
 
 
1538
 
    Returns booleans: has_contents, content_mod, meta_mod
1539
 
    has_contents means there are currently contents, but they differ
1540
 
    contents_mod means contents need to be modified
1541
 
    meta_mod means the metadata needs to be modified
1542
 
    """
1543
 
    cur_entry = working_tree.inventory[file_id]
1544
 
    try:
1545
 
        working_kind = working_tree.kind(file_id)
1546
 
        has_contents = True
1547
 
    except NoSuchFile:
1548
 
        has_contents = False
1549
 
        contents_mod = True
1550
 
        meta_mod = False
1551
 
    if has_contents is True:
1552
 
        if entry.kind != working_kind:
1553
 
            contents_mod, meta_mod = True, False
1554
 
        else:
1555
 
            cur_entry._read_tree_state(working_tree.id2path(file_id), 
1556
 
                                       working_tree)
1557
 
            contents_mod, meta_mod = entry.detect_changes(cur_entry)
1558
 
            cur_entry._forget_tree_state()
1559
 
    return has_contents, contents_mod, meta_mod
1560
 
 
1561
 
 
1562
2846
def revert(working_tree, target_tree, filenames, backups=False,
1563
 
           pb=DummyProgress(), change_reporter=None):
 
2847
           pb=None, change_reporter=None):
1564
2848
    """Revert a working tree's contents to those of a target tree."""
1565
2849
    target_tree.lock_read()
 
2850
    pb = ui.ui_factory.nested_progress_bar()
1566
2851
    tt = TreeTransform(working_tree, pb)
1567
2852
    try:
1568
2853
        pp = ProgressPhase("Revert phase", 3, pb)
1569
 
        pp.next_phase()
1570
 
        child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1571
 
        try:
1572
 
            merge_modified = _alter_files(working_tree, target_tree, tt,
1573
 
                                          child_pb, filenames, backups)
1574
 
        finally:
1575
 
            child_pb.finished()
1576
 
        pp.next_phase()
1577
 
        child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1578
 
        try:
1579
 
            raw_conflicts = resolve_conflicts(tt, child_pb)
1580
 
        finally:
1581
 
            child_pb.finished()
1582
 
        conflicts = cook_conflicts(raw_conflicts, tt)
 
2854
        conflicts, merge_modified = _prepare_revert_transform(
 
2855
            working_tree, target_tree, tt, filenames, backups, pp)
1583
2856
        if change_reporter:
1584
2857
            change_reporter = delta._ChangeReporter(
1585
2858
                unversioned_filter=working_tree.is_ignored)
1586
 
            delta.report_changes(tt._iter_changes(), change_reporter)
 
2859
            delta.report_changes(tt.iter_changes(), change_reporter)
1587
2860
        for conflict in conflicts:
1588
 
            warning(conflict)
 
2861
            trace.warning(unicode(conflict))
1589
2862
        pp.next_phase()
1590
2863
        tt.apply()
1591
2864
        working_tree.set_merge_modified(merge_modified)
1596
2869
    return conflicts
1597
2870
 
1598
2871
 
 
2872
def _prepare_revert_transform(working_tree, target_tree, tt, filenames,
 
2873
                              backups, pp, basis_tree=None,
 
2874
                              merge_modified=None):
 
2875
    child_pb = ui.ui_factory.nested_progress_bar()
 
2876
    try:
 
2877
        if merge_modified is None:
 
2878
            merge_modified = working_tree.merge_modified()
 
2879
        merge_modified = _alter_files(working_tree, target_tree, tt,
 
2880
                                      child_pb, filenames, backups,
 
2881
                                      merge_modified, basis_tree)
 
2882
    finally:
 
2883
        child_pb.finished()
 
2884
    child_pb = ui.ui_factory.nested_progress_bar()
 
2885
    try:
 
2886
        raw_conflicts = resolve_conflicts(tt, child_pb,
 
2887
            lambda t, c: conflict_pass(t, c, target_tree))
 
2888
    finally:
 
2889
        child_pb.finished()
 
2890
    conflicts = cook_conflicts(raw_conflicts, tt)
 
2891
    return conflicts, merge_modified
 
2892
 
 
2893
 
1599
2894
def _alter_files(working_tree, target_tree, tt, pb, specific_files,
1600
 
                 backups):
1601
 
    merge_modified = working_tree.merge_modified()
1602
 
    change_list = target_tree._iter_changes(working_tree,
 
2895
                 backups, merge_modified, basis_tree=None):
 
2896
    if basis_tree is not None:
 
2897
        basis_tree.lock_read()
 
2898
    # We ask the working_tree for its changes relative to the target, rather
 
2899
    # than the target changes relative to the working tree. Because WT4 has an
 
2900
    # optimizer to compare itself to a target, but no optimizer for the
 
2901
    # reverse.
 
2902
    change_list = working_tree.iter_changes(target_tree,
1603
2903
        specific_files=specific_files, pb=pb)
1604
 
    if target_tree.inventory.root is None:
 
2904
    if target_tree.get_root_id() is None:
1605
2905
        skip_root = True
1606
2906
    else:
1607
2907
        skip_root = False
1608
 
    basis_tree = None
1609
2908
    try:
1610
2909
        deferred_files = []
1611
2910
        for id_num, (file_id, path, changed_content, versioned, parent, name,
1612
2911
                kind, executable) in enumerate(change_list):
1613
 
            if skip_root and file_id[0] is not None and parent[0] is None:
 
2912
            target_path, wt_path = path
 
2913
            target_versioned, wt_versioned = versioned
 
2914
            target_parent, wt_parent = parent
 
2915
            target_name, wt_name = name
 
2916
            target_kind, wt_kind = kind
 
2917
            target_executable, wt_executable = executable
 
2918
            if skip_root and wt_parent is None:
1614
2919
                continue
1615
2920
            trans_id = tt.trans_id_file_id(file_id)
1616
2921
            mode_id = None
1617
2922
            if changed_content:
1618
2923
                keep_content = False
1619
 
                if kind[0] == 'file' and (backups or kind[1] is None):
 
2924
                if wt_kind == 'file' and (backups or target_kind is None):
1620
2925
                    wt_sha1 = working_tree.get_file_sha1(file_id)
1621
2926
                    if merge_modified.get(file_id) != wt_sha1:
1622
2927
                        # acquire the basis tree lazily to prevent the
1625
2930
                        if basis_tree is None:
1626
2931
                            basis_tree = working_tree.basis_tree()
1627
2932
                            basis_tree.lock_read()
1628
 
                        if file_id in basis_tree:
 
2933
                        if basis_tree.has_id(file_id):
1629
2934
                            if wt_sha1 != basis_tree.get_file_sha1(file_id):
1630
2935
                                keep_content = True
1631
 
                        elif kind[1] is None and not versioned[1]:
 
2936
                        elif target_kind is None and not target_versioned:
1632
2937
                            keep_content = True
1633
 
                if kind[0] is not None:
 
2938
                if wt_kind is not None:
1634
2939
                    if not keep_content:
1635
2940
                        tt.delete_contents(trans_id)
1636
 
                    elif kind[1] is not None:
1637
 
                        parent_trans_id = tt.trans_id_file_id(parent[0])
1638
 
                        by_parent = tt.by_parent()
1639
 
                        backup_name = _get_backup_name(name[0], by_parent,
1640
 
                                                       parent_trans_id, tt)
 
2941
                    elif target_kind is not None:
 
2942
                        parent_trans_id = tt.trans_id_file_id(wt_parent)
 
2943
                        backup_name = tt._available_backup_name(
 
2944
                            wt_name, parent_trans_id)
1641
2945
                        tt.adjust_path(backup_name, parent_trans_id, trans_id)
1642
 
                        new_trans_id = tt.create_path(name[0], parent_trans_id)
1643
 
                        if versioned == (True, True):
 
2946
                        new_trans_id = tt.create_path(wt_name, parent_trans_id)
 
2947
                        if wt_versioned and target_versioned:
1644
2948
                            tt.unversion_file(trans_id)
1645
2949
                            tt.version_file(file_id, new_trans_id)
1646
2950
                        # New contents should have the same unix perms as old
1647
2951
                        # contents
1648
2952
                        mode_id = trans_id
1649
2953
                        trans_id = new_trans_id
1650
 
                if kind[1] == 'directory':
 
2954
                if target_kind in ('directory', 'tree-reference'):
1651
2955
                    tt.create_directory(trans_id)
1652
 
                elif kind[1] == 'symlink':
 
2956
                    if target_kind == 'tree-reference':
 
2957
                        revision = target_tree.get_reference_revision(file_id,
 
2958
                                                                      target_path)
 
2959
                        tt.set_tree_reference(revision, trans_id)
 
2960
                elif target_kind == 'symlink':
1653
2961
                    tt.create_symlink(target_tree.get_symlink_target(file_id),
1654
2962
                                      trans_id)
1655
 
                elif kind[1] == 'file':
 
2963
                elif target_kind == 'file':
1656
2964
                    deferred_files.append((file_id, (trans_id, mode_id)))
1657
2965
                    if basis_tree is None:
1658
2966
                        basis_tree = working_tree.basis_tree()
1659
2967
                        basis_tree.lock_read()
1660
2968
                    new_sha1 = target_tree.get_file_sha1(file_id)
1661
 
                    if (file_id in basis_tree and new_sha1 ==
1662
 
                        basis_tree.get_file_sha1(file_id)):
 
2969
                    if (basis_tree.has_id(file_id) and
 
2970
                        new_sha1 == basis_tree.get_file_sha1(file_id)):
1663
2971
                        if file_id in merge_modified:
1664
2972
                            del merge_modified[file_id]
1665
2973
                    else:
1666
2974
                        merge_modified[file_id] = new_sha1
1667
2975
 
1668
2976
                    # preserve the execute bit when backing up
1669
 
                    if keep_content and executable[0] == executable[1]:
1670
 
                        tt.set_executability(executable[1], trans_id)
1671
 
                else:
1672
 
                    assert kind[1] is None
1673
 
            if versioned == (False, True):
 
2977
                    if keep_content and wt_executable == target_executable:
 
2978
                        tt.set_executability(target_executable, trans_id)
 
2979
                elif target_kind is not None:
 
2980
                    raise AssertionError(target_kind)
 
2981
            if not wt_versioned and target_versioned:
1674
2982
                tt.version_file(file_id, trans_id)
1675
 
            if versioned == (True, False):
 
2983
            if wt_versioned and not target_versioned:
1676
2984
                tt.unversion_file(trans_id)
1677
 
            if (name[1] is not None and 
1678
 
                (name[0] != name[1] or parent[0] != parent[1])):
1679
 
                tt.adjust_path(
1680
 
                    name[1], tt.trans_id_file_id(parent[1]), trans_id)
1681
 
            if executable[0] != executable[1] and kind[1] == "file":
1682
 
                tt.set_executability(executable[1], trans_id)
1683
 
        for (trans_id, mode_id), bytes in target_tree.iter_files_bytes(
1684
 
            deferred_files):
1685
 
            tt.create_file(bytes, trans_id, mode_id)
 
2985
            if (target_name is not None and
 
2986
                (wt_name != target_name or wt_parent != target_parent)):
 
2987
                if target_name == '' and target_parent is None:
 
2988
                    parent_trans = ROOT_PARENT
 
2989
                else:
 
2990
                    parent_trans = tt.trans_id_file_id(target_parent)
 
2991
                if wt_parent is None and wt_versioned:
 
2992
                    tt.adjust_root_path(target_name, parent_trans)
 
2993
                else:
 
2994
                    tt.adjust_path(target_name, parent_trans, trans_id)
 
2995
            if wt_executable != target_executable and target_kind == "file":
 
2996
                tt.set_executability(target_executable, trans_id)
 
2997
        if working_tree.supports_content_filtering():
 
2998
            for index, ((trans_id, mode_id), bytes) in enumerate(
 
2999
                target_tree.iter_files_bytes(deferred_files)):
 
3000
                file_id = deferred_files[index][0]
 
3001
                # We're reverting a tree to the target tree so using the
 
3002
                # target tree to find the file path seems the best choice
 
3003
                # here IMO - Ian C 27/Oct/2009
 
3004
                filter_tree_path = target_tree.id2path(file_id)
 
3005
                filters = working_tree._content_filter_stack(filter_tree_path)
 
3006
                bytes = filtered_output_bytes(bytes, filters,
 
3007
                    ContentFilterContext(filter_tree_path, working_tree))
 
3008
                tt.create_file(bytes, trans_id, mode_id)
 
3009
        else:
 
3010
            for (trans_id, mode_id), bytes in target_tree.iter_files_bytes(
 
3011
                deferred_files):
 
3012
                tt.create_file(bytes, trans_id, mode_id)
 
3013
        tt.fixup_new_roots()
1686
3014
    finally:
1687
3015
        if basis_tree is not None:
1688
3016
            basis_tree.unlock()
1689
3017
    return merge_modified
1690
3018
 
1691
3019
 
1692
 
def resolve_conflicts(tt, pb=DummyProgress(), pass_func=None):
 
3020
def resolve_conflicts(tt, pb=None, pass_func=None):
1693
3021
    """Make many conflict-resolution attempts, but die if they fail"""
1694
3022
    if pass_func is None:
1695
3023
        pass_func = conflict_pass
1696
3024
    new_conflicts = set()
 
3025
    pb = ui.ui_factory.nested_progress_bar()
1697
3026
    try:
1698
3027
        for n in range(10):
1699
 
            pb.update('Resolution pass', n+1, 10)
 
3028
            pb.update(gettext('Resolution pass'), n+1, 10)
1700
3029
            conflicts = tt.find_conflicts()
1701
3030
            if len(conflicts) == 0:
1702
3031
                return new_conflicts
1703
3032
            new_conflicts.update(pass_func(tt, conflicts))
1704
3033
        raise MalformedTransform(conflicts=conflicts)
1705
3034
    finally:
1706
 
        pb.clear()
 
3035
        pb.finished()
1707
3036
 
1708
3037
 
1709
3038
def conflict_pass(tt, conflicts, path_tree=None):
1721
3050
                               conflict[1], conflict[2], ))
1722
3051
        elif c_type == 'duplicate':
1723
3052
            # files that were renamed take precedence
1724
 
            new_name = tt.final_name(conflict[1])+'.moved'
1725
3053
            final_parent = tt.final_parent(conflict[1])
1726
3054
            if tt.path_changed(conflict[1]):
1727
 
                tt.adjust_path(new_name, final_parent, conflict[2])
1728
 
                new_conflicts.add((c_type, 'Moved existing file to', 
1729
 
                                   conflict[2], conflict[1]))
 
3055
                existing_file, new_file = conflict[2], conflict[1]
1730
3056
            else:
1731
 
                tt.adjust_path(new_name, final_parent, conflict[1])
1732
 
                new_conflicts.add((c_type, 'Moved existing file to', 
1733
 
                                  conflict[1], conflict[2]))
 
3057
                existing_file, new_file = conflict[1], conflict[2]
 
3058
            new_name = tt.final_name(existing_file) + '.moved'
 
3059
            tt.adjust_path(new_name, final_parent, existing_file)
 
3060
            new_conflicts.add((c_type, 'Moved existing file to',
 
3061
                               existing_file, new_file))
1734
3062
        elif c_type == 'parent loop':
1735
3063
            # break the loop by undoing one of the ops that caused the loop
1736
3064
            cur = conflict[1]
1739
3067
            new_conflicts.add((c_type, 'Cancelled move', cur,
1740
3068
                               tt.final_parent(cur),))
1741
3069
            tt.adjust_path(tt.final_name(cur), tt.get_tree_parent(cur), cur)
1742
 
            
 
3070
 
1743
3071
        elif c_type == 'missing parent':
1744
3072
            trans_id = conflict[1]
1745
 
            try:
1746
 
                tt.cancel_deletion(trans_id)
1747
 
                new_conflicts.add(('deleting parent', 'Not deleting', 
1748
 
                                   trans_id))
1749
 
            except KeyError:
1750
 
                tt.create_directory(trans_id)
1751
 
                new_conflicts.add((c_type, 'Created directory', trans_id))
 
3073
            if trans_id in tt._removed_contents:
 
3074
                cancel_deletion = True
 
3075
                orphans = tt._get_potential_orphans(trans_id)
 
3076
                if orphans:
 
3077
                    cancel_deletion = False
 
3078
                    # All children are orphans
 
3079
                    for o in orphans:
 
3080
                        try:
 
3081
                            tt.new_orphan(o, trans_id)
 
3082
                        except OrphaningError:
 
3083
                            # Something bad happened so we cancel the directory
 
3084
                            # deletion which will leave it in place with a
 
3085
                            # conflict. The user can deal with it from there.
 
3086
                            # Note that this also catch the case where we don't
 
3087
                            # want to create orphans and leave the directory in
 
3088
                            # place.
 
3089
                            cancel_deletion = True
 
3090
                            break
 
3091
                if cancel_deletion:
 
3092
                    # Cancel the directory deletion
 
3093
                    tt.cancel_deletion(trans_id)
 
3094
                    new_conflicts.add(('deleting parent', 'Not deleting',
 
3095
                                       trans_id))
 
3096
            else:
 
3097
                create = True
1752
3098
                try:
1753
3099
                    tt.final_name(trans_id)
1754
3100
                except NoFinalPath:
1755
 
                    file_id = tt.final_file_id(trans_id)
1756
 
                    entry = path_tree.inventory[file_id]
1757
 
                    parent_trans_id = tt.trans_id_file_id(entry.parent_id)
1758
 
                    tt.adjust_path(entry.name, parent_trans_id, trans_id)
 
3101
                    if path_tree is not None:
 
3102
                        file_id = tt.final_file_id(trans_id)
 
3103
                        if file_id is None:
 
3104
                            file_id = tt.inactive_file_id(trans_id)
 
3105
                        _, entry = path_tree.iter_entries_by_dir(
 
3106
                            [file_id]).next()
 
3107
                        # special-case the other tree root (move its
 
3108
                        # children to current root)
 
3109
                        if entry.parent_id is None:
 
3110
                            create = False
 
3111
                            moved = _reparent_transform_children(
 
3112
                                tt, trans_id, tt.root)
 
3113
                            for child in moved:
 
3114
                                new_conflicts.add((c_type, 'Moved to root',
 
3115
                                                   child))
 
3116
                        else:
 
3117
                            parent_trans_id = tt.trans_id_file_id(
 
3118
                                entry.parent_id)
 
3119
                            tt.adjust_path(entry.name, parent_trans_id,
 
3120
                                           trans_id)
 
3121
                if create:
 
3122
                    tt.create_directory(trans_id)
 
3123
                    new_conflicts.add((c_type, 'Created directory', trans_id))
1759
3124
        elif c_type == 'unversioned parent':
1760
 
            tt.version_file(tt.inactive_file_id(conflict[1]), conflict[1])
 
3125
            file_id = tt.inactive_file_id(conflict[1])
 
3126
            # special-case the other tree root (move its children instead)
 
3127
            if path_tree and path_tree.has_id(file_id):
 
3128
                if path_tree.path2id('') == file_id:
 
3129
                    # This is the root entry, skip it
 
3130
                    continue
 
3131
            tt.version_file(file_id, conflict[1])
1761
3132
            new_conflicts.add((c_type, 'Versioned directory', conflict[1]))
 
3133
        elif c_type == 'non-directory parent':
 
3134
            parent_id = conflict[1]
 
3135
            parent_parent = tt.final_parent(parent_id)
 
3136
            parent_name = tt.final_name(parent_id)
 
3137
            parent_file_id = tt.final_file_id(parent_id)
 
3138
            new_parent_id = tt.new_directory(parent_name + '.new',
 
3139
                parent_parent, parent_file_id)
 
3140
            _reparent_transform_children(tt, parent_id, new_parent_id)
 
3141
            if parent_file_id is not None:
 
3142
                tt.unversion_file(parent_id)
 
3143
            new_conflicts.add((c_type, 'Created directory', new_parent_id))
 
3144
        elif c_type == 'versioning no contents':
 
3145
            tt.cancel_versioning(conflict[1])
1762
3146
    return new_conflicts
1763
3147
 
1764
3148
 
1765
3149
def cook_conflicts(raw_conflicts, tt):
1766
3150
    """Generate a list of cooked conflicts, sorted by file path"""
1767
 
    from bzrlib.conflicts import Conflict
1768
3151
    conflict_iter = iter_cook_conflicts(raw_conflicts, tt)
1769
 
    return sorted(conflict_iter, key=Conflict.sort_key)
 
3152
    return sorted(conflict_iter, key=conflicts.Conflict.sort_key)
1770
3153
 
1771
3154
 
1772
3155
def iter_cook_conflicts(raw_conflicts, tt):
1773
 
    from bzrlib.conflicts import Conflict
1774
3156
    fp = FinalPaths(tt)
1775
3157
    for conflict in raw_conflicts:
1776
3158
        c_type = conflict[0]
1778
3160
        modified_path = fp.get_path(conflict[2])
1779
3161
        modified_id = tt.final_file_id(conflict[2])
1780
3162
        if len(conflict) == 3:
1781
 
            yield Conflict.factory(c_type, action=action, path=modified_path,
1782
 
                                     file_id=modified_id)
1783
 
             
 
3163
            yield conflicts.Conflict.factory(
 
3164
                c_type, action=action, path=modified_path, file_id=modified_id)
 
3165
 
1784
3166
        else:
1785
3167
            conflicting_path = fp.get_path(conflict[3])
1786
3168
            conflicting_id = tt.final_file_id(conflict[3])
1787
 
            yield Conflict.factory(c_type, action=action, path=modified_path,
1788
 
                                   file_id=modified_id, 
1789
 
                                   conflict_path=conflicting_path,
1790
 
                                   conflict_file_id=conflicting_id)
 
3169
            yield conflicts.Conflict.factory(
 
3170
                c_type, action=action, path=modified_path,
 
3171
                file_id=modified_id,
 
3172
                conflict_path=conflicting_path,
 
3173
                conflict_file_id=conflicting_id)
1791
3174
 
1792
3175
 
1793
3176
class _FileMover(object):
1798
3181
        self.pending_deletions = []
1799
3182
 
1800
3183
    def rename(self, from_, to):
1801
 
        """Rename a file from one path to another.  Functions like os.rename"""
1802
 
        os.rename(from_, to)
 
3184
        """Rename a file from one path to another."""
 
3185
        try:
 
3186
            os.rename(from_, to)
 
3187
        except OSError, e:
 
3188
            if e.errno in (errno.EEXIST, errno.ENOTEMPTY):
 
3189
                raise errors.FileExists(to, str(e))
 
3190
            # normal OSError doesn't include filenames so it's hard to see where
 
3191
            # the problem is, see https://bugs.launchpad.net/bzr/+bug/491763
 
3192
            raise errors.TransformRenameFailed(from_, to, str(e), e.errno)
1803
3193
        self.past_renames.append((from_, to))
1804
3194
 
1805
3195
    def pre_delete(self, from_, to):
1815
3205
    def rollback(self):
1816
3206
        """Reverse all renames that have been performed"""
1817
3207
        for from_, to in reversed(self.past_renames):
1818
 
            os.rename(to, from_)
 
3208
            try:
 
3209
                os.rename(to, from_)
 
3210
            except OSError, e:
 
3211
                raise errors.TransformRenameFailed(to, from_, str(e), e.errno)
1819
3212
        # after rollback, don't reuse _FileMover
1820
3213
        past_renames = None
1821
3214
        pending_deletions = None