← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/transform.py

(jelmer) Convert bzrlib.smtp_connection to use config stacks. (Jelmer
 Vernooij)

Show diffs side-by-side

added added

removed removed

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