← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/transform.py

  • Committer: Robert Collins
  • Date: 2010-05-06 23:54:05 UTC
  • mto: This revision was merged to the branch mainline in revision 5223.
  • Revision ID: robertc@robertcollins.net-20100506235405-wii4elupfhzl3jvy
Add __str__ to the new helper classes.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/transform.py
1
 
# Copyright (C) 2006, 2007 Canonical Ltd
 
1
# Copyright (C) 2006-2010 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
12
12
#
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
16
 
17
17
import os
18
18
import errno
19
 
from stat import S_ISREG
 
19
from stat import S_ISREG, S_IEXEC
 
20
import time
20
21
 
21
22
from bzrlib.lazy_import import lazy_import
22
23
lazy_import(globals(), """
23
24
from bzrlib import (
 
25
    annotate,
 
26
    bencode,
24
27
    bzrdir,
25
28
    delta,
26
29
    errors,
27
 
    inventory
 
30
    inventory,
 
31
    multiparent,
 
32
    osutils,
 
33
    revision as _mod_revision,
 
34
    ui,
28
35
    )
29
36
""")
30
37
from bzrlib.errors import (DuplicateKey, MalformedTransform, NoSuchFile,
31
 
                           ReusingTransform, NotVersionedError, CantMoveRoot,
 
38
                           ReusingTransform, CantMoveRoot,
32
39
                           ExistingLimbo, ImmortalLimbo, NoFinalPath,
33
40
                           UnableCreateSymlink)
 
41
from bzrlib.filters import filtered_output_bytes, ContentFilterContext
34
42
from bzrlib.inventory import InventoryEntry
35
 
from bzrlib.osutils import (file_kind, supports_executable, pathjoin, lexists,
36
 
                            delete_any, has_symlinks)
37
 
from bzrlib.progress import DummyProgress, ProgressPhase
 
43
from bzrlib.osutils import (
 
44
    delete_any,
 
45
    file_kind,
 
46
    has_symlinks,
 
47
    lexists,
 
48
    pathjoin,
 
49
    sha_file,
 
50
    splitpath,
 
51
    supports_executable,
 
52
)
 
53
from bzrlib.progress import ProgressPhase
38
54
from bzrlib.symbol_versioning import (
39
55
        deprecated_function,
40
 
        zero_fifteen,
41
 
        zero_ninety,
 
56
        deprecated_in,
42
57
        )
43
58
from bzrlib.trace import mutter, warning
44
59
from bzrlib import tree
62
77
        self.rename_count = rename_count
63
78
 
64
79
 
65
 
class TreeTransform(object):
66
 
    """Represent a tree transformation.
67
 
    
68
 
    This object is designed to support incremental generation of the transform,
69
 
    in any order.
70
 
 
71
 
    However, it gives optimum performance when parent directories are created
72
 
    before their contents.  The transform is then able to put child files
73
 
    directly in their parent directory, avoiding later renames.
74
 
    
75
 
    It is easy to produce malformed transforms, but they are generally
76
 
    harmless.  Attempting to apply a malformed transform will cause an
77
 
    exception to be raised before any modifications are made to the tree.  
78
 
 
79
 
    Many kinds of malformed transforms can be corrected with the 
80
 
    resolve_conflicts function.  The remaining ones indicate programming error,
81
 
    such as trying to create a file with no path.
82
 
 
83
 
    Two sets of file creation methods are supplied.  Convenience methods are:
84
 
     * new_file
85
 
     * new_directory
86
 
     * new_symlink
87
 
 
88
 
    These are composed of the low-level methods:
89
 
     * create_path
90
 
     * create_file or create_directory or create_symlink
91
 
     * version_file
92
 
     * set_executability
93
 
 
94
 
    Transform/Transaction ids
95
 
    -------------------------
96
 
    trans_ids are temporary ids assigned to all files involved in a transform.
97
 
    It's possible, even common, that not all files in the Tree have trans_ids.
98
 
 
99
 
    trans_ids are used because filenames and file_ids are not good enough
100
 
    identifiers; filenames change, and not all files have file_ids.  File-ids
101
 
    are also associated with trans-ids, so that moving a file moves its
102
 
    file-id.
103
 
 
104
 
    trans_ids are only valid for the TreeTransform that generated them.
105
 
 
106
 
    Limbo
107
 
    -----
108
 
    Limbo is a temporary directory use to hold new versions of files.
109
 
    Files are added to limbo by create_file, create_directory, create_symlink,
110
 
    and their convenience variants (new_*).  Files may be removed from limbo
111
 
    using cancel_creation.  Files are renamed from limbo into their final
112
 
    location as part of TreeTransform.apply
113
 
 
114
 
    Limbo must be cleaned up, by either calling TreeTransform.apply or
115
 
    calling TreeTransform.finalize.
116
 
 
117
 
    Files are placed into limbo inside their parent directories, where
118
 
    possible.  This reduces subsequent renames, and makes operations involving
119
 
    lots of files faster.  This optimization is only possible if the parent
120
 
    directory is created *before* creating any of its children, so avoid
121
 
    creating children before parents, where possible.
122
 
 
123
 
    Pending-deletion
124
 
    ----------------
125
 
    This temporary directory is used by _FileMover for storing files that are
126
 
    about to be deleted.  In case of rollback, the files will be restored.
127
 
    FileMover does not delete files until it is sure that a rollback will not
128
 
    happen.  
129
 
    """
130
 
    def __init__(self, tree, pb=DummyProgress()):
131
 
        """Note: a tree_write lock is taken on the tree.
132
 
        
133
 
        Use TreeTransform.finalize() to release the lock (can be omitted if
134
 
        TreeTransform.apply() called).
 
80
class TreeTransformBase(object):
 
81
    """The base class for TreeTransform and its kin."""
 
82
 
 
83
    def __init__(self, tree, pb=None,
 
84
                 case_sensitive=True):
 
85
        """Constructor.
 
86
 
 
87
        :param tree: The tree that will be transformed, but not necessarily
 
88
            the output tree.
 
89
        :param pb: ignored
 
90
        :param case_sensitive: If True, the target of the transform is
 
91
            case sensitive, not just case preserving.
135
92
        """
136
93
        object.__init__(self)
137
94
        self._tree = tree
138
 
        self._tree.lock_tree_write()
139
 
        try:
140
 
            control_files = self._tree._control_files
141
 
            self._limbodir = urlutils.local_path_from_url(
142
 
                control_files.controlfilename('limbo'))
143
 
            try:
144
 
                os.mkdir(self._limbodir)
145
 
            except OSError, e:
146
 
                if e.errno == errno.EEXIST:
147
 
                    raise ExistingLimbo(self._limbodir)
148
 
            self._deletiondir = urlutils.local_path_from_url(
149
 
                control_files.controlfilename('pending-deletion'))
150
 
            try:
151
 
                os.mkdir(self._deletiondir)
152
 
            except OSError, e:
153
 
                if e.errno == errno.EEXIST:
154
 
                    raise errors.ExistingPendingDeletion(self._deletiondir)
155
 
 
156
 
        except: 
157
 
            self._tree.unlock()
158
 
            raise
159
 
 
160
 
        # counter used to generate trans-ids (which are locally unique)
161
95
        self._id_number = 0
162
96
        # mapping of trans_id -> new basename
163
97
        self._new_name = {}
165
99
        self._new_parent = {}
166
100
        # mapping of trans_id with new contents -> new file_kind
167
101
        self._new_contents = {}
168
 
        # A mapping of transform ids to their limbo filename
169
 
        self._limbo_files = {}
170
 
        # A mapping of transform ids to a set of the transform ids of children
171
 
        # that their limbo directory has
172
 
        self._limbo_children = {}
173
 
        # Map transform ids to maps of child filename to child transform id
174
 
        self._limbo_children_names = {}
175
 
        # List of transform ids that need to be renamed from limbo into place
176
 
        self._needs_rename = set()
177
102
        # Set of trans_ids whose contents will be removed
178
103
        self._removed_contents = set()
179
104
        # Mapping of trans_id -> new execute-bit value
186
111
        self._non_present_ids = {}
187
112
        # Mapping of new file_id -> trans_id
188
113
        self._r_new_id = {}
189
 
        # Set of file_ids that will be removed
 
114
        # Set of trans_ids that will be removed
190
115
        self._removed_id = set()
191
116
        # Mapping of path in old tree -> trans_id
192
117
        self._tree_path_ids = {}
193
118
        # Mapping trans_id -> path in old tree
194
119
        self._tree_id_paths = {}
195
 
        # Cache of realpath results, to speed up canonical_path
196
 
        self._realpaths = {}
197
 
        # Cache of relpath results, to speed up canonical_path
198
 
        self._relpaths = {}
199
120
        # The trans_id that will be used as the tree root
200
 
        self._new_root = self.trans_id_tree_file_id(tree.get_root_id())
 
121
        root_id = tree.get_root_id()
 
122
        if root_id is not None:
 
123
            self._new_root = self.trans_id_tree_file_id(root_id)
 
124
        else:
 
125
            self._new_root = None
201
126
        # Indictor of whether the transform has been applied
202
 
        self.__done = False
 
127
        self._done = False
203
128
        # A progress bar
204
129
        self._pb = pb
 
130
        # Whether the target is case sensitive
 
131
        self._case_sensitive_target = case_sensitive
205
132
        # A counter of how many files have been renamed
206
133
        self.rename_count = 0
207
134
 
 
135
    def finalize(self):
 
136
        """Release the working tree lock, if held.
 
137
 
 
138
        This is required if apply has not been invoked, but can be invoked
 
139
        even after apply.
 
140
        """
 
141
        if self._tree is None:
 
142
            return
 
143
        self._tree.unlock()
 
144
        self._tree = None
 
145
 
208
146
    def __get_root(self):
209
147
        return self._new_root
210
148
 
211
149
    root = property(__get_root)
212
150
 
213
 
    def finalize(self):
214
 
        """Release the working tree lock, if held, clean up limbo dir.
215
 
 
216
 
        This is required if apply has not been invoked, but can be invoked
217
 
        even after apply.
218
 
        """
219
 
        if self._tree is None:
220
 
            return
221
 
        try:
222
 
            entries = [(self._limbo_name(t), t, k) for t, k in
223
 
                       self._new_contents.iteritems()]
224
 
            entries.sort(reverse=True)
225
 
            for path, trans_id, kind in entries:
226
 
                if kind == "directory":
227
 
                    os.rmdir(path)
228
 
                else:
229
 
                    os.unlink(path)
230
 
            try:
231
 
                os.rmdir(self._limbodir)
232
 
            except OSError:
233
 
                # We don't especially care *why* the dir is immortal.
234
 
                raise ImmortalLimbo(self._limbodir)
235
 
            try:
236
 
                os.rmdir(self._deletiondir)
237
 
            except OSError:
238
 
                raise errors.ImmortalPendingDeletion(self._deletiondir)
239
 
        finally:
240
 
            self._tree.unlock()
241
 
            self._tree = None
242
 
 
243
151
    def _assign_id(self):
244
152
        """Produce a new tranform id"""
245
153
        new_id = "new-%s" % self._id_number
255
163
 
256
164
    def adjust_path(self, name, parent, trans_id):
257
165
        """Change the path that is assigned to a transaction id."""
 
166
        if parent is None:
 
167
            raise ValueError("Parent trans-id may not be None")
258
168
        if trans_id == self._new_root:
259
169
            raise CantMoveRoot
260
 
        previous_parent = self._new_parent.get(trans_id)
261
 
        previous_name = self._new_name.get(trans_id)
262
170
        self._new_name[trans_id] = name
263
171
        self._new_parent[trans_id] = parent
264
 
        if (trans_id in self._limbo_files and
265
 
            trans_id not in self._needs_rename):
266
 
            self._rename_in_limbo([trans_id])
267
 
            self._limbo_children[previous_parent].remove(trans_id)
268
 
            del self._limbo_children_names[previous_parent][previous_name]
269
 
 
270
 
    def _rename_in_limbo(self, trans_ids):
271
 
        """Fix limbo names so that the right final path is produced.
272
 
 
273
 
        This means we outsmarted ourselves-- we tried to avoid renaming
274
 
        these files later by creating them with their final names in their
275
 
        final parents.  But now the previous name or parent is no longer
276
 
        suitable, so we have to rename them.
277
 
 
278
 
        Even for trans_ids that have no new contents, we must remove their
279
 
        entries from _limbo_files, because they are now stale.
280
 
        """
281
 
        for trans_id in trans_ids:
282
 
            old_path = self._limbo_files.pop(trans_id)
283
 
            if trans_id not in self._new_contents:
284
 
                continue
285
 
            new_path = self._limbo_name(trans_id)
286
 
            os.rename(old_path, new_path)
287
172
 
288
173
    def adjust_root_path(self, name, parent):
289
174
        """Emulate moving the root by moving all children, instead.
290
 
        
 
175
 
291
176
        We do this by undoing the association of root's transaction id with the
292
177
        current tree.  This allows us to create a new directory with that
293
 
        transaction id.  We unversion the root directory and version the 
 
178
        transaction id.  We unversion the root directory and version the
294
179
        physically new directory, and hope someone versions the tree root
295
180
        later.
296
181
        """
299
184
        # force moving all children of root
300
185
        for child_id in self.iter_tree_children(old_root):
301
186
            if child_id != parent:
302
 
                self.adjust_path(self.final_name(child_id), 
 
187
                self.adjust_path(self.final_name(child_id),
303
188
                                 self.final_parent(child_id), child_id)
304
189
            file_id = self.final_file_id(child_id)
305
190
            if file_id is not None:
306
191
                self.unversion_file(child_id)
307
192
            self.version_file(file_id, child_id)
308
 
        
 
193
 
309
194
        # the physical root needs a new transaction id
310
195
        self._tree_path_ids.pop("")
311
196
        self._tree_id_paths.pop(old_root)
317
202
        self.version_file(old_root_file_id, old_root)
318
203
        self.unversion_file(self._new_root)
319
204
 
 
205
    def fixup_new_roots(self):
 
206
        """Reinterpret requests to change the root directory
 
207
 
 
208
        Instead of creating a root directory, or moving an existing directory,
 
209
        all the attributes and children of the new root are applied to the
 
210
        existing root directory.
 
211
 
 
212
        This means that the old root trans-id becomes obsolete, so it is
 
213
        recommended only to invoke this after the root trans-id has become
 
214
        irrelevant.
 
215
        """
 
216
        new_roots = [k for k, v in self._new_parent.iteritems() if v is
 
217
                     ROOT_PARENT]
 
218
        if len(new_roots) < 1:
 
219
            return
 
220
        if len(new_roots) != 1:
 
221
            raise ValueError('A tree cannot have two roots!')
 
222
        if self._new_root is None:
 
223
            self._new_root = new_roots[0]
 
224
            return
 
225
        old_new_root = new_roots[0]
 
226
        # TODO: What to do if a old_new_root is present, but self._new_root is
 
227
        #       not listed as being removed? This code explicitly unversions
 
228
        #       the old root and versions it with the new file_id. Though that
 
229
        #       seems like an incomplete delta
 
230
 
 
231
        # unversion the new root's directory.
 
232
        file_id = self.final_file_id(old_new_root)
 
233
        if old_new_root in self._new_id:
 
234
            self.cancel_versioning(old_new_root)
 
235
        else:
 
236
            self.unversion_file(old_new_root)
 
237
        # if, at this stage, root still has an old file_id, zap it so we can
 
238
        # stick a new one in.
 
239
        if (self.tree_file_id(self._new_root) is not None and
 
240
            self._new_root not in self._removed_id):
 
241
            self.unversion_file(self._new_root)
 
242
        self.version_file(file_id, self._new_root)
 
243
 
 
244
        # Now move children of new root into old root directory.
 
245
        # Ensure all children are registered with the transaction, but don't
 
246
        # use directly-- some tree children have new parents
 
247
        list(self.iter_tree_children(old_new_root))
 
248
        # Move all children of new root into old root directory.
 
249
        for child in self.by_parent().get(old_new_root, []):
 
250
            self.adjust_path(self.final_name(child), self._new_root, child)
 
251
 
 
252
        # Ensure old_new_root has no directory.
 
253
        if old_new_root in self._new_contents:
 
254
            self.cancel_creation(old_new_root)
 
255
        else:
 
256
            self.delete_contents(old_new_root)
 
257
 
 
258
        # prevent deletion of root directory.
 
259
        if self._new_root in self._removed_contents:
 
260
            self.cancel_deletion(self._new_root)
 
261
 
 
262
        # destroy path info for old_new_root.
 
263
        del self._new_parent[old_new_root]
 
264
        del self._new_name[old_new_root]
 
265
 
320
266
    def trans_id_tree_file_id(self, inventory_id):
321
267
        """Determine the transaction id of a working tree file.
322
 
        
 
268
 
323
269
        This reflects only files that already exist, not ones that will be
324
270
        added by transactions.
325
271
        """
326
 
        path = self._tree.inventory.id2path(inventory_id)
 
272
        if inventory_id is None:
 
273
            raise ValueError('None is not a valid file id')
 
274
        path = self._tree.id2path(inventory_id)
327
275
        return self.trans_id_tree_path(path)
328
276
 
329
277
    def trans_id_file_id(self, file_id):
332
280
        a transaction has been unversioned, it is deliberately still returned.
333
281
        (this will likely lead to an unversioned parent conflict.)
334
282
        """
 
283
        if file_id is None:
 
284
            raise ValueError('None is not a valid file id')
335
285
        if file_id in self._r_new_id and self._r_new_id[file_id] is not None:
336
286
            return self._r_new_id[file_id]
337
 
        elif file_id in self._tree.inventory:
338
 
            return self.trans_id_tree_file_id(file_id)
339
 
        elif file_id in self._non_present_ids:
340
 
            return self._non_present_ids[file_id]
341
 
        else:
342
 
            trans_id = self._assign_id()
343
 
            self._non_present_ids[file_id] = trans_id
344
 
            return trans_id
345
 
 
346
 
    def canonical_path(self, path):
347
 
        """Get the canonical tree-relative path"""
348
 
        # don't follow final symlinks
349
 
        abs = self._tree.abspath(path)
350
 
        if abs in self._relpaths:
351
 
            return self._relpaths[abs]
352
 
        dirname, basename = os.path.split(abs)
353
 
        if dirname not in self._realpaths:
354
 
            self._realpaths[dirname] = os.path.realpath(dirname)
355
 
        dirname = self._realpaths[dirname]
356
 
        abs = pathjoin(dirname, basename)
357
 
        if dirname in self._relpaths:
358
 
            relpath = pathjoin(self._relpaths[dirname], basename)
359
 
            relpath = relpath.rstrip('/\\')
360
 
        else:
361
 
            relpath = self._tree.relpath(abs)
362
 
        self._relpaths[abs] = relpath
363
 
        return relpath
 
287
        else:
 
288
            try:
 
289
                self._tree.iter_entries_by_dir([file_id]).next()
 
290
            except StopIteration:
 
291
                if file_id in self._non_present_ids:
 
292
                    return self._non_present_ids[file_id]
 
293
                else:
 
294
                    trans_id = self._assign_id()
 
295
                    self._non_present_ids[file_id] = trans_id
 
296
                    return trans_id
 
297
            else:
 
298
                return self.trans_id_tree_file_id(file_id)
364
299
 
365
300
    def trans_id_tree_path(self, path):
366
301
        """Determine (and maybe set) the transaction ID for a tree path."""
377
312
            return ROOT_PARENT
378
313
        return self.trans_id_tree_path(os.path.dirname(path))
379
314
 
380
 
    def create_file(self, contents, trans_id, mode_id=None):
381
 
        """Schedule creation of a new file.
382
 
 
383
 
        See also new_file.
384
 
        
385
 
        Contents is an iterator of strings, all of which will be written
386
 
        to the target destination.
387
 
 
388
 
        New file takes the permissions of any existing file with that id,
389
 
        unless mode_id is specified.
390
 
        """
391
 
        name = self._limbo_name(trans_id)
392
 
        f = open(name, 'wb')
393
 
        try:
394
 
            try:
395
 
                unique_add(self._new_contents, trans_id, 'file')
396
 
            except:
397
 
                # Clean up the file, it never got registered so
398
 
                # TreeTransform.finalize() won't clean it up.
399
 
                f.close()
400
 
                os.unlink(name)
401
 
                raise
402
 
 
403
 
            f.writelines(contents)
404
 
        finally:
405
 
            f.close()
406
 
        self._set_mode(trans_id, mode_id, S_ISREG)
407
 
 
408
 
    def _set_mode(self, trans_id, mode_id, typefunc):
409
 
        """Set the mode of new file contents.
410
 
        The mode_id is the existing file to get the mode from (often the same
411
 
        as trans_id).  The operation is only performed if there's a mode match
412
 
        according to typefunc.
413
 
        """
414
 
        if mode_id is None:
415
 
            mode_id = trans_id
416
 
        try:
417
 
            old_path = self._tree_id_paths[mode_id]
418
 
        except KeyError:
419
 
            return
420
 
        try:
421
 
            mode = os.stat(self._tree.abspath(old_path)).st_mode
422
 
        except OSError, e:
423
 
            if e.errno == errno.ENOENT:
424
 
                return
425
 
            else:
426
 
                raise
427
 
        if typefunc(mode):
428
 
            os.chmod(self._limbo_name(trans_id), mode)
429
 
 
430
 
    def create_directory(self, trans_id):
431
 
        """Schedule creation of a new directory.
432
 
        
433
 
        See also new_directory.
434
 
        """
435
 
        os.mkdir(self._limbo_name(trans_id))
436
 
        unique_add(self._new_contents, trans_id, 'directory')
437
 
 
438
 
    def create_symlink(self, target, trans_id):
439
 
        """Schedule creation of a new symbolic link.
440
 
 
441
 
        target is a bytestring.
442
 
        See also new_symlink.
443
 
        """
444
 
        if has_symlinks():
445
 
            os.symlink(target, self._limbo_name(trans_id))
446
 
            unique_add(self._new_contents, trans_id, 'symlink')
447
 
        else:
448
 
            try:
449
 
                path = FinalPaths(self).get_path(trans_id)
450
 
            except KeyError:
451
 
                path = None
452
 
            raise UnableCreateSymlink(path=path)
453
 
 
454
 
    def cancel_creation(self, trans_id):
455
 
        """Cancel the creation of new file contents."""
456
 
        del self._new_contents[trans_id]
457
 
        children = self._limbo_children.get(trans_id)
458
 
        # if this is a limbo directory with children, move them before removing
459
 
        # the directory
460
 
        if children is not None:
461
 
            self._rename_in_limbo(children)
462
 
            del self._limbo_children[trans_id]
463
 
            del self._limbo_children_names[trans_id]
464
 
        delete_any(self._limbo_name(trans_id))
465
 
 
466
315
    def delete_contents(self, trans_id):
467
316
        """Schedule the contents of a path entry for deletion"""
 
317
        # Ensure that the object exists in the WorkingTree, this will raise an
 
318
        # exception if there is a problem
468
319
        self.tree_kind(trans_id)
469
320
        self._removed_contents.add(trans_id)
470
321
 
496
347
 
497
348
    def version_file(self, file_id, trans_id):
498
349
        """Schedule a file to become versioned."""
499
 
        assert file_id is not None
 
350
        if file_id is None:
 
351
            raise ValueError()
500
352
        unique_add(self._new_id, trans_id, file_id)
501
353
        unique_add(self._r_new_id, file_id, trans_id)
502
354
 
506
358
        del self._new_id[trans_id]
507
359
        del self._r_new_id[file_id]
508
360
 
509
 
    def new_paths(self):
510
 
        """Determine the paths of all new and changed files"""
511
 
        new_ids = set()
512
 
        fp = FinalPaths(self)
513
 
        for id_set in (self._new_name, self._new_parent, self._new_contents,
514
 
                       self._new_id, self._new_executability):
515
 
            new_ids.update(id_set)
516
 
        new_paths = [(fp.get_path(t), t) for t in new_ids]
517
 
        new_paths.sort()
518
 
        return new_paths
519
 
 
520
 
    def tree_kind(self, trans_id):
521
 
        """Determine the file kind in the working tree.
522
 
 
523
 
        Raises NoSuchFile if the file does not exist
 
361
    def new_paths(self, filesystem_only=False):
 
362
        """Determine the paths of all new and changed files.
 
363
 
 
364
        :param filesystem_only: if True, only calculate values for files
 
365
            that require renames or execute bit changes.
524
366
        """
525
 
        path = self._tree_id_paths.get(trans_id)
526
 
        if path is None:
527
 
            raise NoSuchFile(None)
528
 
        try:
529
 
            return file_kind(self._tree.abspath(path))
530
 
        except OSError, e:
531
 
            if e.errno != errno.ENOENT:
532
 
                raise
533
 
            else:
534
 
                raise NoSuchFile(path)
 
367
        new_ids = set()
 
368
        if filesystem_only:
 
369
            stale_ids = self._needs_rename.difference(self._new_name)
 
370
            stale_ids.difference_update(self._new_parent)
 
371
            stale_ids.difference_update(self._new_contents)
 
372
            stale_ids.difference_update(self._new_id)
 
373
            needs_rename = self._needs_rename.difference(stale_ids)
 
374
            id_sets = (needs_rename, self._new_executability)
 
375
        else:
 
376
            id_sets = (self._new_name, self._new_parent, self._new_contents,
 
377
                       self._new_id, self._new_executability)
 
378
        for id_set in id_sets:
 
379
            new_ids.update(id_set)
 
380
        return sorted(FinalPaths(self).get_paths(new_ids))
 
381
 
 
382
    def _inventory_altered(self):
 
383
        """Get the trans_ids and paths of files needing new inv entries."""
 
384
        new_ids = set()
 
385
        for id_set in [self._new_name, self._new_parent, self._new_id,
 
386
                       self._new_executability]:
 
387
            new_ids.update(id_set)
 
388
        changed_kind = set(self._removed_contents)
 
389
        changed_kind.intersection_update(self._new_contents)
 
390
        changed_kind.difference_update(new_ids)
 
391
        changed_kind = (t for t in changed_kind if self.tree_kind(t) !=
 
392
                        self.final_kind(t))
 
393
        new_ids.update(changed_kind)
 
394
        return sorted(FinalPaths(self).get_paths(new_ids))
535
395
 
536
396
    def final_kind(self, trans_id):
537
397
        """Determine the final file kind, after any changes applied.
538
 
        
 
398
 
539
399
        Raises NoSuchFile if the file does not exist/has no contents.
540
400
        (It is conceivable that a path would be created without the
541
401
        corresponding contents insertion command)
557
417
        # the file is old; the old id is still valid
558
418
        if self._new_root == trans_id:
559
419
            return self._tree.get_root_id()
560
 
        return self._tree.inventory.path2id(path)
 
420
        return self._tree.path2id(path)
561
421
 
562
422
    def final_file_id(self, trans_id):
563
423
        """Determine the file id after any changes are applied, or None.
564
 
        
 
424
 
565
425
        None indicates that the file will not be versioned after changes are
566
426
        applied.
567
427
        """
568
428
        try:
569
 
            # there is a new id for this file
570
 
            assert self._new_id[trans_id] is not None
571
429
            return self._new_id[trans_id]
572
430
        except KeyError:
573
431
            if trans_id in self._removed_id:
608
466
 
609
467
    def by_parent(self):
610
468
        """Return a map of parent: children for known parents.
611
 
        
 
469
 
612
470
        Only new paths and parents of tree files with assigned ids are used.
613
471
        """
614
472
        by_parent = {}
615
473
        items = list(self._new_parent.iteritems())
616
 
        items.extend((t, self.final_parent(t)) for t in 
 
474
        items.extend((t, self.final_parent(t)) for t in
617
475
                      self._tree_id_paths.keys())
618
476
        for trans_id, parent_id in items:
619
477
            if parent_id not in by_parent:
630
488
 
631
489
    def find_conflicts(self):
632
490
        """Find any violations of inventory or filesystem invariants"""
633
 
        if self.__done is True:
 
491
        if self._done is True:
634
492
            raise ReusingTransform()
635
493
        conflicts = []
636
494
        # ensure all children of all existent parents are known
647
505
        conflicts.extend(self._overwrite_conflicts())
648
506
        return conflicts
649
507
 
 
508
    def _check_malformed(self):
 
509
        conflicts = self.find_conflicts()
 
510
        if len(conflicts) != 0:
 
511
            raise MalformedTransform(conflicts=conflicts)
 
512
 
650
513
    def _add_tree_children(self):
651
514
        """Add all the children of all active parents to the known paths.
652
515
 
654
517
        removed.  This is a necessary first step in detecting conflicts.
655
518
        """
656
519
        parents = self.by_parent().keys()
657
 
        parents.extend([t for t in self._removed_contents if 
 
520
        parents.extend([t for t in self._removed_contents if
658
521
                        self.tree_kind(t) == 'directory'])
659
522
        for trans_id in self._removed_id:
660
523
            file_id = self.tree_file_id(trans_id)
661
 
            if self._tree.inventory[file_id].kind == 'directory':
 
524
            if file_id is not None:
 
525
                if self._tree.inventory[file_id].kind == 'directory':
 
526
                    parents.append(trans_id)
 
527
            elif self.tree_kind(trans_id) == 'directory':
662
528
                parents.append(trans_id)
663
529
 
664
530
        for parent_id in parents:
665
531
            # ensure that all children are registered with the transaction
666
532
            list(self.iter_tree_children(parent_id))
667
533
 
668
 
    def iter_tree_children(self, parent_id):
669
 
        """Iterate through the entry's tree children, if any"""
670
 
        try:
671
 
            path = self._tree_id_paths[parent_id]
672
 
        except KeyError:
673
 
            return
674
 
        try:
675
 
            children = os.listdir(self._tree.abspath(path))
676
 
        except OSError, e:
677
 
            if e.errno != errno.ENOENT and e.errno != errno.ESRCH:
678
 
                raise
679
 
            return
680
 
            
681
 
        for child in children:
682
 
            childpath = joinpath(path, child)
683
 
            if self._tree.is_control_filename(childpath):
684
 
                continue
685
 
            yield self.trans_id_tree_path(childpath)
686
 
 
687
534
    def has_named_child(self, by_parent, parent_id, name):
688
535
        try:
689
536
            children = by_parent[parent_id]
743
590
 
744
591
    def _improper_versioning(self):
745
592
        """Cannot version a file with no contents, or a bad type.
746
 
        
 
593
 
747
594
        However, existing entries with no contents are okay.
748
595
        """
749
596
        conflicts = []
759
606
 
760
607
    def _executability_conflicts(self):
761
608
        """Check for bad executability changes.
762
 
        
 
609
 
763
610
        Only versioned files may have their executability set, because
764
611
        1. only versioned entries can have executability under windows
765
612
        2. only files can be executable.  (The execute bit on a directory
798
645
            return conflicts
799
646
        for children in by_parent.itervalues():
800
647
            name_ids = [(self.final_name(t), t) for t in children]
801
 
            if not self._tree.case_sensitive:
 
648
            if not self._case_sensitive_target:
802
649
                name_ids = [(n.lower(), t) for n, t in name_ids]
803
650
            name_ids.sort()
804
651
            last_name = None
823
670
        conflicts = []
824
671
        removed_tree_ids = set((self.tree_file_id(trans_id) for trans_id in
825
672
                                self._removed_id))
826
 
        active_tree_ids = set((f for f in self._tree.inventory if
827
 
                               f not in removed_tree_ids))
 
673
        all_ids = self._tree.all_file_ids()
 
674
        active_tree_ids = all_ids.difference(removed_tree_ids)
828
675
        for trans_id, file_id in self._new_id.iteritems():
829
676
            if file_id in active_tree_ids:
830
677
                old_trans_id = self.trans_id_tree_file_id(file_id)
863
710
                continue
864
711
            return True
865
712
        return False
866
 
            
867
 
    def apply(self, no_conflicts=False, _mover=None):
868
 
        """Apply all changes to the inventory and filesystem.
869
 
        
870
 
        If filesystem or inventory conflicts are present, MalformedTransform
871
 
        will be thrown.
872
 
 
873
 
        If apply succeeds, finalize is not necessary.
874
 
 
875
 
        :param no_conflicts: if True, the caller guarantees there are no
876
 
            conflicts, so no check is made.
877
 
        :param _mover: Supply an alternate FileMover, for testing
878
 
        """
879
 
        if not no_conflicts:
880
 
            conflicts = self.find_conflicts()
881
 
            if len(conflicts) != 0:
882
 
                raise MalformedTransform(conflicts=conflicts)
883
 
        inv = self._tree.inventory
884
 
        inventory_delta = []
885
 
        child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
886
 
        try:
887
 
            if _mover is None:
888
 
                mover = _FileMover()
889
 
            else:
890
 
                mover = _mover
891
 
            try:
892
 
                child_pb.update('Apply phase', 0, 2)
893
 
                self._apply_removals(inv, inventory_delta, mover)
894
 
                child_pb.update('Apply phase', 1, 2)
895
 
                modified_paths = self._apply_insertions(inv, inventory_delta,
896
 
                                                        mover)
897
 
            except:
898
 
                mover.rollback()
899
 
                raise
900
 
            else:
901
 
                mover.apply_deletions()
902
 
        finally:
903
 
            child_pb.finished()
904
 
        self._tree.apply_inventory_delta(inventory_delta)
905
 
        self.__done = True
906
 
        self.finalize()
907
 
        return _TransformResults(modified_paths, self.rename_count)
908
 
 
909
 
    def _limbo_name(self, trans_id):
910
 
        """Generate the limbo name of a file"""
911
 
        limbo_name = self._limbo_files.get(trans_id)
912
 
        if limbo_name is not None:
913
 
            return limbo_name
914
 
        parent = self._new_parent.get(trans_id)
915
 
        # if the parent directory is already in limbo (e.g. when building a
916
 
        # tree), choose a limbo name inside the parent, to reduce further
917
 
        # renames.
918
 
        use_direct_path = False
919
 
        if self._new_contents.get(parent) == 'directory':
920
 
            filename = self._new_name.get(trans_id)
921
 
            if filename is not None:
922
 
                if parent not in self._limbo_children:
923
 
                    self._limbo_children[parent] = set()
924
 
                    self._limbo_children_names[parent] = {}
925
 
                    use_direct_path = True
926
 
                # the direct path can only be used if no other file has
927
 
                # already taken this pathname, i.e. if the name is unused, or
928
 
                # if it is already associated with this trans_id.
929
 
                elif self._tree.case_sensitive:
930
 
                    if (self._limbo_children_names[parent].get(filename)
931
 
                        in (trans_id, None)):
932
 
                        use_direct_path = True
933
 
                else:
934
 
                    for l_filename, l_trans_id in\
935
 
                        self._limbo_children_names[parent].iteritems():
936
 
                        if l_trans_id == trans_id:
937
 
                            continue
938
 
                        if l_filename.lower() == filename.lower():
939
 
                            break
940
 
                    else:
941
 
                        use_direct_path = True
942
 
 
943
 
        if use_direct_path:
944
 
            limbo_name = pathjoin(self._limbo_files[parent], filename)
945
 
            self._limbo_children[parent].add(trans_id)
946
 
            self._limbo_children_names[parent][filename] = trans_id
947
 
        else:
948
 
            limbo_name = pathjoin(self._limbodir, trans_id)
949
 
            self._needs_rename.add(trans_id)
950
 
        self._limbo_files[trans_id] = limbo_name
951
 
        return limbo_name
952
 
 
953
 
    def _apply_removals(self, inv, inventory_delta, mover):
954
 
        """Perform tree operations that remove directory/inventory names.
955
 
        
956
 
        That is, delete files that are to be deleted, and put any files that
957
 
        need renaming into limbo.  This must be done in strict child-to-parent
958
 
        order.
959
 
        """
960
 
        tree_paths = list(self._tree_path_ids.iteritems())
961
 
        tree_paths.sort(reverse=True)
962
 
        child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
963
 
        try:
964
 
            for num, data in enumerate(tree_paths):
965
 
                path, trans_id = data
966
 
                child_pb.update('removing file', num, len(tree_paths))
967
 
                full_path = self._tree.abspath(path)
968
 
                if trans_id in self._removed_contents:
969
 
                    mover.pre_delete(full_path, os.path.join(self._deletiondir,
970
 
                                     trans_id))
971
 
                elif trans_id in self._new_name or trans_id in \
972
 
                    self._new_parent:
973
 
                    try:
974
 
                        mover.rename(full_path, self._limbo_name(trans_id))
975
 
                    except OSError, e:
976
 
                        if e.errno != errno.ENOENT:
977
 
                            raise
978
 
                    else:
979
 
                        self.rename_count += 1
980
 
                if trans_id in self._removed_id:
981
 
                    if trans_id == self._new_root:
982
 
                        file_id = self._tree.get_root_id()
983
 
                    else:
984
 
                        file_id = self.tree_file_id(trans_id)
985
 
                    assert file_id is not None
986
 
                    inventory_delta.append((path, None, file_id, None))
987
 
        finally:
988
 
            child_pb.finished()
989
 
 
990
 
    def _apply_insertions(self, inv, inventory_delta, mover):
991
 
        """Perform tree operations that insert directory/inventory names.
992
 
        
993
 
        That is, create any files that need to be created, and restore from
994
 
        limbo any files that needed renaming.  This must be done in strict
995
 
        parent-to-child order.
996
 
        """
997
 
        new_paths = self.new_paths()
998
 
        modified_paths = []
999
 
        child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1000
 
        try:
1001
 
            for num, (path, trans_id) in enumerate(new_paths):
1002
 
                new_entry = None
1003
 
                child_pb.update('adding file', num, len(new_paths))
1004
 
                try:
1005
 
                    kind = self._new_contents[trans_id]
1006
 
                except KeyError:
1007
 
                    kind = contents = None
1008
 
                if trans_id in self._new_contents or \
1009
 
                    self.path_changed(trans_id):
1010
 
                    full_path = self._tree.abspath(path)
1011
 
                    if trans_id in self._needs_rename:
1012
 
                        try:
1013
 
                            mover.rename(self._limbo_name(trans_id), full_path)
1014
 
                        except OSError, e:
1015
 
                            # We may be renaming a dangling inventory id
1016
 
                            if e.errno != errno.ENOENT:
1017
 
                                raise
1018
 
                        else:
1019
 
                            self.rename_count += 1
1020
 
                    if trans_id in self._new_contents:
1021
 
                        modified_paths.append(full_path)
1022
 
                        del self._new_contents[trans_id]
1023
 
 
1024
 
                if trans_id in self._new_id:
1025
 
                    if kind is None:
1026
 
                        kind = file_kind(self._tree.abspath(path))
1027
 
                    if trans_id in self._new_reference_revision:
1028
 
                        new_entry = inventory.TreeReference(
1029
 
                            self._new_id[trans_id],
1030
 
                            self._new_name[trans_id], 
1031
 
                            self.final_file_id(self._new_parent[trans_id]),
1032
 
                            None, self._new_reference_revision[trans_id])
1033
 
                    else:
1034
 
                        new_entry = inventory.make_entry(kind,
1035
 
                            self.final_name(trans_id),
1036
 
                            self.final_file_id(self.final_parent(trans_id)),
1037
 
                            self._new_id[trans_id])
1038
 
                else:
1039
 
                    if trans_id in self._new_name or trans_id in\
1040
 
                        self._new_parent or\
1041
 
                        trans_id in self._new_executability:
1042
 
                        file_id = self.final_file_id(trans_id)
1043
 
                        if file_id is not None:
1044
 
                            entry = inv[file_id]
1045
 
                            new_entry = entry.copy()
1046
 
 
1047
 
                    if trans_id in self._new_name or trans_id in\
1048
 
                        self._new_parent:
1049
 
                            if new_entry is not None:
1050
 
                                new_entry.name = self.final_name(trans_id)
1051
 
                                parent = self.final_parent(trans_id)
1052
 
                                parent_id = self.final_file_id(parent)
1053
 
                                new_entry.parent_id = parent_id
1054
 
 
1055
 
                if trans_id in self._new_executability:
1056
 
                    self._set_executability(path, new_entry, trans_id)
1057
 
                if new_entry is not None:
1058
 
                    if new_entry.file_id in inv:
1059
 
                        old_path = inv.id2path(new_entry.file_id)
1060
 
                    else:
1061
 
                        old_path = None
1062
 
                    inventory_delta.append((old_path, path,
1063
 
                                            new_entry.file_id,
1064
 
                                            new_entry))
1065
 
        finally:
1066
 
            child_pb.finished()
1067
 
        return modified_paths
1068
 
 
1069
 
    def _set_executability(self, path, entry, trans_id):
 
713
 
 
714
    def _set_executability(self, path, trans_id):
1070
715
        """Set the executability of versioned files """
1071
 
        new_executability = self._new_executability[trans_id]
1072
 
        entry.executable = new_executability
1073
716
        if supports_executable():
 
717
            new_executability = self._new_executability[trans_id]
1074
718
            abspath = self._tree.abspath(path)
1075
719
            current_mode = os.stat(abspath).st_mode
1076
720
            if new_executability:
1093
737
            self.version_file(file_id, trans_id)
1094
738
        return trans_id
1095
739
 
1096
 
    def new_file(self, name, parent_id, contents, file_id=None, 
 
740
    def new_file(self, name, parent_id, contents, file_id=None,
1097
741
                 executable=None):
1098
742
        """Convenience method to create files.
1099
 
        
 
743
 
1100
744
        name is the name of the file to create.
1101
745
        parent_id is the transaction id of the parent directory of the file.
1102
746
        contents is an iterator of bytestrings, which will be used to produce
1122
766
        """
1123
767
        trans_id = self._new_entry(name, parent_id, file_id)
1124
768
        self.create_directory(trans_id)
1125
 
        return trans_id 
 
769
        return trans_id
1126
770
 
1127
771
    def new_symlink(self, name, parent_id, target, file_id=None):
1128
772
        """Convenience method to create symbolic link.
1129
 
        
 
773
 
1130
774
        name is the name of the symlink to create.
1131
775
        parent_id is the transaction id of the parent directory of the symlink.
1132
776
        target is a bytestring of the target of the symlink.
1171
815
        from_path = self._tree_id_paths.get(from_trans_id)
1172
816
        if from_versioned:
1173
817
            # get data from working tree if versioned
1174
 
            from_entry = self._tree.inventory[file_id]
 
818
            from_entry = self._tree.iter_entries_by_dir([file_id]).next()[1]
1175
819
            from_name = from_entry.name
1176
820
            from_parent = from_entry.parent_id
1177
821
        else:
1213
857
            to_executable = False
1214
858
        return to_name, to_parent, to_kind, to_executable
1215
859
 
1216
 
    def _iter_changes(self):
1217
 
        """Produce output in the same format as Tree._iter_changes.
 
860
    def iter_changes(self):
 
861
        """Produce output in the same format as Tree.iter_changes.
1218
862
 
1219
863
        Will produce nonsensical results if invoked while inventory/filesystem
1220
864
        conflicts (as reported by TreeTransform.find_conflicts()) are present.
1275
919
                   (from_executable, to_executable)))
1276
920
        return iter(sorted(results, key=lambda x:x[1]))
1277
921
 
 
922
    def get_preview_tree(self):
 
923
        """Return a tree representing the result of the transform.
 
924
 
 
925
        The tree is a snapshot, and altering the TreeTransform will invalidate
 
926
        it.
 
927
        """
 
928
        return _PreviewTree(self)
 
929
 
 
930
    def commit(self, branch, message, merge_parents=None, strict=False):
 
931
        """Commit the result of this TreeTransform to a branch.
 
932
 
 
933
        :param branch: The branch to commit to.
 
934
        :param message: The message to attach to the commit.
 
935
        :param merge_parents: Additional parents specified by pending merges.
 
936
        :return: The revision_id of the revision committed.
 
937
        """
 
938
        self._check_malformed()
 
939
        if strict:
 
940
            unversioned = set(self._new_contents).difference(set(self._new_id))
 
941
            for trans_id in unversioned:
 
942
                if self.final_file_id(trans_id) is None:
 
943
                    raise errors.StrictCommitFailed()
 
944
 
 
945
        revno, last_rev_id = branch.last_revision_info()
 
946
        if last_rev_id == _mod_revision.NULL_REVISION:
 
947
            if merge_parents is not None:
 
948
                raise ValueError('Cannot supply merge parents for first'
 
949
                                 ' commit.')
 
950
            parent_ids = []
 
951
        else:
 
952
            parent_ids = [last_rev_id]
 
953
            if merge_parents is not None:
 
954
                parent_ids.extend(merge_parents)
 
955
        if self._tree.get_revision_id() != last_rev_id:
 
956
            raise ValueError('TreeTransform not based on branch basis: %s' %
 
957
                             self._tree.get_revision_id())
 
958
        builder = branch.get_commit_builder(parent_ids)
 
959
        preview = self.get_preview_tree()
 
960
        list(builder.record_iter_changes(preview, last_rev_id,
 
961
                                         self.iter_changes()))
 
962
        builder.finish_inventory()
 
963
        revision_id = builder.commit(message)
 
964
        branch.set_last_revision_info(revno + 1, revision_id)
 
965
        return revision_id
 
966
 
 
967
    def _text_parent(self, trans_id):
 
968
        file_id = self.tree_file_id(trans_id)
 
969
        try:
 
970
            if file_id is None or self._tree.kind(file_id) != 'file':
 
971
                return None
 
972
        except errors.NoSuchFile:
 
973
            return None
 
974
        return file_id
 
975
 
 
976
    def _get_parents_texts(self, trans_id):
 
977
        """Get texts for compression parents of this file."""
 
978
        file_id = self._text_parent(trans_id)
 
979
        if file_id is None:
 
980
            return ()
 
981
        return (self._tree.get_file_text(file_id),)
 
982
 
 
983
    def _get_parents_lines(self, trans_id):
 
984
        """Get lines for compression parents of this file."""
 
985
        file_id = self._text_parent(trans_id)
 
986
        if file_id is None:
 
987
            return ()
 
988
        return (self._tree.get_file_lines(file_id),)
 
989
 
 
990
    def serialize(self, serializer):
 
991
        """Serialize this TreeTransform.
 
992
 
 
993
        :param serializer: A Serialiser like pack.ContainerSerializer.
 
994
        """
 
995
        new_name = dict((k, v.encode('utf-8')) for k, v in
 
996
                        self._new_name.items())
 
997
        new_executability = dict((k, int(v)) for k, v in
 
998
                                 self._new_executability.items())
 
999
        tree_path_ids = dict((k.encode('utf-8'), v)
 
1000
                             for k, v in self._tree_path_ids.items())
 
1001
        attribs = {
 
1002
            '_id_number': self._id_number,
 
1003
            '_new_name': new_name,
 
1004
            '_new_parent': self._new_parent,
 
1005
            '_new_executability': new_executability,
 
1006
            '_new_id': self._new_id,
 
1007
            '_tree_path_ids': tree_path_ids,
 
1008
            '_removed_id': list(self._removed_id),
 
1009
            '_removed_contents': list(self._removed_contents),
 
1010
            '_non_present_ids': self._non_present_ids,
 
1011
            }
 
1012
        yield serializer.bytes_record(bencode.bencode(attribs),
 
1013
                                      (('attribs',),))
 
1014
        for trans_id, kind in self._new_contents.items():
 
1015
            if kind == 'file':
 
1016
                lines = osutils.chunks_to_lines(
 
1017
                    self._read_file_chunks(trans_id))
 
1018
                parents = self._get_parents_lines(trans_id)
 
1019
                mpdiff = multiparent.MultiParent.from_lines(lines, parents)
 
1020
                content = ''.join(mpdiff.to_patch())
 
1021
            if kind == 'directory':
 
1022
                content = ''
 
1023
            if kind == 'symlink':
 
1024
                content = self._read_symlink_target(trans_id)
 
1025
            yield serializer.bytes_record(content, ((trans_id, kind),))
 
1026
 
 
1027
    def deserialize(self, records):
 
1028
        """Deserialize a stored TreeTransform.
 
1029
 
 
1030
        :param records: An iterable of (names, content) tuples, as per
 
1031
            pack.ContainerPushParser.
 
1032
        """
 
1033
        names, content = records.next()
 
1034
        attribs = bencode.bdecode(content)
 
1035
        self._id_number = attribs['_id_number']
 
1036
        self._new_name = dict((k, v.decode('utf-8'))
 
1037
                            for k, v in attribs['_new_name'].items())
 
1038
        self._new_parent = attribs['_new_parent']
 
1039
        self._new_executability = dict((k, bool(v)) for k, v in
 
1040
            attribs['_new_executability'].items())
 
1041
        self._new_id = attribs['_new_id']
 
1042
        self._r_new_id = dict((v, k) for k, v in self._new_id.items())
 
1043
        self._tree_path_ids = {}
 
1044
        self._tree_id_paths = {}
 
1045
        for bytepath, trans_id in attribs['_tree_path_ids'].items():
 
1046
            path = bytepath.decode('utf-8')
 
1047
            self._tree_path_ids[path] = trans_id
 
1048
            self._tree_id_paths[trans_id] = path
 
1049
        self._removed_id = set(attribs['_removed_id'])
 
1050
        self._removed_contents = set(attribs['_removed_contents'])
 
1051
        self._non_present_ids = attribs['_non_present_ids']
 
1052
        for ((trans_id, kind),), content in records:
 
1053
            if kind == 'file':
 
1054
                mpdiff = multiparent.MultiParent.from_patch(content)
 
1055
                lines = mpdiff.to_lines(self._get_parents_texts(trans_id))
 
1056
                self.create_file(lines, trans_id)
 
1057
            if kind == 'directory':
 
1058
                self.create_directory(trans_id)
 
1059
            if kind == 'symlink':
 
1060
                self.create_symlink(content.decode('utf-8'), trans_id)
 
1061
 
 
1062
 
 
1063
class DiskTreeTransform(TreeTransformBase):
 
1064
    """Tree transform storing its contents on disk."""
 
1065
 
 
1066
    def __init__(self, tree, limbodir, pb=None,
 
1067
                 case_sensitive=True):
 
1068
        """Constructor.
 
1069
        :param tree: The tree that will be transformed, but not necessarily
 
1070
            the output tree.
 
1071
        :param limbodir: A directory where new files can be stored until
 
1072
            they are installed in their proper places
 
1073
        :param pb: ignored
 
1074
        :param case_sensitive: If True, the target of the transform is
 
1075
            case sensitive, not just case preserving.
 
1076
        """
 
1077
        TreeTransformBase.__init__(self, tree, pb, case_sensitive)
 
1078
        self._limbodir = limbodir
 
1079
        self._deletiondir = None
 
1080
        # A mapping of transform ids to their limbo filename
 
1081
        self._limbo_files = {}
 
1082
        # A mapping of transform ids to a set of the transform ids of children
 
1083
        # that their limbo directory has
 
1084
        self._limbo_children = {}
 
1085
        # Map transform ids to maps of child filename to child transform id
 
1086
        self._limbo_children_names = {}
 
1087
        # List of transform ids that need to be renamed from limbo into place
 
1088
        self._needs_rename = set()
 
1089
        self._creation_mtime = None
 
1090
 
 
1091
    def finalize(self):
 
1092
        """Release the working tree lock, if held, clean up limbo dir.
 
1093
 
 
1094
        This is required if apply has not been invoked, but can be invoked
 
1095
        even after apply.
 
1096
        """
 
1097
        if self._tree is None:
 
1098
            return
 
1099
        try:
 
1100
            entries = [(self._limbo_name(t), t, k) for t, k in
 
1101
                       self._new_contents.iteritems()]
 
1102
            entries.sort(reverse=True)
 
1103
            for path, trans_id, kind in entries:
 
1104
                delete_any(path)
 
1105
            try:
 
1106
                delete_any(self._limbodir)
 
1107
            except OSError:
 
1108
                # We don't especially care *why* the dir is immortal.
 
1109
                raise ImmortalLimbo(self._limbodir)
 
1110
            try:
 
1111
                if self._deletiondir is not None:
 
1112
                    delete_any(self._deletiondir)
 
1113
            except OSError:
 
1114
                raise errors.ImmortalPendingDeletion(self._deletiondir)
 
1115
        finally:
 
1116
            TreeTransformBase.finalize(self)
 
1117
 
 
1118
    def _limbo_name(self, trans_id):
 
1119
        """Generate the limbo name of a file"""
 
1120
        limbo_name = self._limbo_files.get(trans_id)
 
1121
        if limbo_name is None:
 
1122
            limbo_name = self._generate_limbo_path(trans_id)
 
1123
            self._limbo_files[trans_id] = limbo_name
 
1124
        return limbo_name
 
1125
 
 
1126
    def _generate_limbo_path(self, trans_id):
 
1127
        """Generate a limbo path using the trans_id as the relative path.
 
1128
 
 
1129
        This is suitable as a fallback, and when the transform should not be
 
1130
        sensitive to the path encoding of the limbo directory.
 
1131
        """
 
1132
        self._needs_rename.add(trans_id)
 
1133
        return pathjoin(self._limbodir, trans_id)
 
1134
 
 
1135
    def adjust_path(self, name, parent, trans_id):
 
1136
        previous_parent = self._new_parent.get(trans_id)
 
1137
        previous_name = self._new_name.get(trans_id)
 
1138
        TreeTransformBase.adjust_path(self, name, parent, trans_id)
 
1139
        if (trans_id in self._limbo_files and
 
1140
            trans_id not in self._needs_rename):
 
1141
            self._rename_in_limbo([trans_id])
 
1142
            if previous_parent != parent:
 
1143
                self._limbo_children[previous_parent].remove(trans_id)
 
1144
            if previous_parent != parent or previous_name != name:
 
1145
                del self._limbo_children_names[previous_parent][previous_name]
 
1146
 
 
1147
    def _rename_in_limbo(self, trans_ids):
 
1148
        """Fix limbo names so that the right final path is produced.
 
1149
 
 
1150
        This means we outsmarted ourselves-- we tried to avoid renaming
 
1151
        these files later by creating them with their final names in their
 
1152
        final parents.  But now the previous name or parent is no longer
 
1153
        suitable, so we have to rename them.
 
1154
 
 
1155
        Even for trans_ids that have no new contents, we must remove their
 
1156
        entries from _limbo_files, because they are now stale.
 
1157
        """
 
1158
        for trans_id in trans_ids:
 
1159
            old_path = self._limbo_files.pop(trans_id)
 
1160
            if trans_id not in self._new_contents:
 
1161
                continue
 
1162
            new_path = self._limbo_name(trans_id)
 
1163
            osutils.rename(old_path, new_path)
 
1164
            for descendant in self._limbo_descendants(trans_id):
 
1165
                desc_path = self._limbo_files[descendant]
 
1166
                desc_path = new_path + desc_path[len(old_path):]
 
1167
                self._limbo_files[descendant] = desc_path
 
1168
 
 
1169
    def _limbo_descendants(self, trans_id):
 
1170
        """Return the set of trans_ids whose limbo paths descend from this."""
 
1171
        descendants = set(self._limbo_children.get(trans_id, []))
 
1172
        for descendant in list(descendants):
 
1173
            descendants.update(self._limbo_descendants(descendant))
 
1174
        return descendants
 
1175
 
 
1176
    def create_file(self, contents, trans_id, mode_id=None):
 
1177
        """Schedule creation of a new file.
 
1178
 
 
1179
        See also new_file.
 
1180
 
 
1181
        Contents is an iterator of strings, all of which will be written
 
1182
        to the target destination.
 
1183
 
 
1184
        New file takes the permissions of any existing file with that id,
 
1185
        unless mode_id is specified.
 
1186
        """
 
1187
        name = self._limbo_name(trans_id)
 
1188
        f = open(name, 'wb')
 
1189
        try:
 
1190
            try:
 
1191
                unique_add(self._new_contents, trans_id, 'file')
 
1192
            except:
 
1193
                # Clean up the file, it never got registered so
 
1194
                # TreeTransform.finalize() won't clean it up.
 
1195
                f.close()
 
1196
                os.unlink(name)
 
1197
                raise
 
1198
 
 
1199
            f.writelines(contents)
 
1200
        finally:
 
1201
            f.close()
 
1202
        self._set_mtime(name)
 
1203
        self._set_mode(trans_id, mode_id, S_ISREG)
 
1204
 
 
1205
    def _read_file_chunks(self, trans_id):
 
1206
        cur_file = open(self._limbo_name(trans_id), 'rb')
 
1207
        try:
 
1208
            return cur_file.readlines()
 
1209
        finally:
 
1210
            cur_file.close()
 
1211
 
 
1212
    def _read_symlink_target(self, trans_id):
 
1213
        return os.readlink(self._limbo_name(trans_id))
 
1214
 
 
1215
    def _set_mtime(self, path):
 
1216
        """All files that are created get the same mtime.
 
1217
 
 
1218
        This time is set by the first object to be created.
 
1219
        """
 
1220
        if self._creation_mtime is None:
 
1221
            self._creation_mtime = time.time()
 
1222
        os.utime(path, (self._creation_mtime, self._creation_mtime))
 
1223
 
 
1224
    def create_hardlink(self, path, trans_id):
 
1225
        """Schedule creation of a hard link"""
 
1226
        name = self._limbo_name(trans_id)
 
1227
        try:
 
1228
            os.link(path, name)
 
1229
        except OSError, e:
 
1230
            if e.errno != errno.EPERM:
 
1231
                raise
 
1232
            raise errors.HardLinkNotSupported(path)
 
1233
        try:
 
1234
            unique_add(self._new_contents, trans_id, 'file')
 
1235
        except:
 
1236
            # Clean up the file, it never got registered so
 
1237
            # TreeTransform.finalize() won't clean it up.
 
1238
            os.unlink(name)
 
1239
            raise
 
1240
 
 
1241
    def create_directory(self, trans_id):
 
1242
        """Schedule creation of a new directory.
 
1243
 
 
1244
        See also new_directory.
 
1245
        """
 
1246
        os.mkdir(self._limbo_name(trans_id))
 
1247
        unique_add(self._new_contents, trans_id, 'directory')
 
1248
 
 
1249
    def create_symlink(self, target, trans_id):
 
1250
        """Schedule creation of a new symbolic link.
 
1251
 
 
1252
        target is a bytestring.
 
1253
        See also new_symlink.
 
1254
        """
 
1255
        if has_symlinks():
 
1256
            os.symlink(target, self._limbo_name(trans_id))
 
1257
            unique_add(self._new_contents, trans_id, 'symlink')
 
1258
        else:
 
1259
            try:
 
1260
                path = FinalPaths(self).get_path(trans_id)
 
1261
            except KeyError:
 
1262
                path = None
 
1263
            raise UnableCreateSymlink(path=path)
 
1264
 
 
1265
    def cancel_creation(self, trans_id):
 
1266
        """Cancel the creation of new file contents."""
 
1267
        del self._new_contents[trans_id]
 
1268
        children = self._limbo_children.get(trans_id)
 
1269
        # if this is a limbo directory with children, move them before removing
 
1270
        # the directory
 
1271
        if children is not None:
 
1272
            self._rename_in_limbo(children)
 
1273
            del self._limbo_children[trans_id]
 
1274
            del self._limbo_children_names[trans_id]
 
1275
        delete_any(self._limbo_name(trans_id))
 
1276
 
 
1277
 
 
1278
class TreeTransform(DiskTreeTransform):
 
1279
    """Represent a tree transformation.
 
1280
 
 
1281
    This object is designed to support incremental generation of the transform,
 
1282
    in any order.
 
1283
 
 
1284
    However, it gives optimum performance when parent directories are created
 
1285
    before their contents.  The transform is then able to put child files
 
1286
    directly in their parent directory, avoiding later renames.
 
1287
 
 
1288
    It is easy to produce malformed transforms, but they are generally
 
1289
    harmless.  Attempting to apply a malformed transform will cause an
 
1290
    exception to be raised before any modifications are made to the tree.
 
1291
 
 
1292
    Many kinds of malformed transforms can be corrected with the
 
1293
    resolve_conflicts function.  The remaining ones indicate programming error,
 
1294
    such as trying to create a file with no path.
 
1295
 
 
1296
    Two sets of file creation methods are supplied.  Convenience methods are:
 
1297
     * new_file
 
1298
     * new_directory
 
1299
     * new_symlink
 
1300
 
 
1301
    These are composed of the low-level methods:
 
1302
     * create_path
 
1303
     * create_file or create_directory or create_symlink
 
1304
     * version_file
 
1305
     * set_executability
 
1306
 
 
1307
    Transform/Transaction ids
 
1308
    -------------------------
 
1309
    trans_ids are temporary ids assigned to all files involved in a transform.
 
1310
    It's possible, even common, that not all files in the Tree have trans_ids.
 
1311
 
 
1312
    trans_ids are used because filenames and file_ids are not good enough
 
1313
    identifiers; filenames change, and not all files have file_ids.  File-ids
 
1314
    are also associated with trans-ids, so that moving a file moves its
 
1315
    file-id.
 
1316
 
 
1317
    trans_ids are only valid for the TreeTransform that generated them.
 
1318
 
 
1319
    Limbo
 
1320
    -----
 
1321
    Limbo is a temporary directory use to hold new versions of files.
 
1322
    Files are added to limbo by create_file, create_directory, create_symlink,
 
1323
    and their convenience variants (new_*).  Files may be removed from limbo
 
1324
    using cancel_creation.  Files are renamed from limbo into their final
 
1325
    location as part of TreeTransform.apply
 
1326
 
 
1327
    Limbo must be cleaned up, by either calling TreeTransform.apply or
 
1328
    calling TreeTransform.finalize.
 
1329
 
 
1330
    Files are placed into limbo inside their parent directories, where
 
1331
    possible.  This reduces subsequent renames, and makes operations involving
 
1332
    lots of files faster.  This optimization is only possible if the parent
 
1333
    directory is created *before* creating any of its children, so avoid
 
1334
    creating children before parents, where possible.
 
1335
 
 
1336
    Pending-deletion
 
1337
    ----------------
 
1338
    This temporary directory is used by _FileMover for storing files that are
 
1339
    about to be deleted.  In case of rollback, the files will be restored.
 
1340
    FileMover does not delete files until it is sure that a rollback will not
 
1341
    happen.
 
1342
    """
 
1343
    def __init__(self, tree, pb=None):
 
1344
        """Note: a tree_write lock is taken on the tree.
 
1345
 
 
1346
        Use TreeTransform.finalize() to release the lock (can be omitted if
 
1347
        TreeTransform.apply() called).
 
1348
        """
 
1349
        tree.lock_tree_write()
 
1350
 
 
1351
        try:
 
1352
            limbodir = urlutils.local_path_from_url(
 
1353
                tree._transport.abspath('limbo'))
 
1354
            try:
 
1355
                os.mkdir(limbodir)
 
1356
            except OSError, e:
 
1357
                if e.errno == errno.EEXIST:
 
1358
                    raise ExistingLimbo(limbodir)
 
1359
            deletiondir = urlutils.local_path_from_url(
 
1360
                tree._transport.abspath('pending-deletion'))
 
1361
            try:
 
1362
                os.mkdir(deletiondir)
 
1363
            except OSError, e:
 
1364
                if e.errno == errno.EEXIST:
 
1365
                    raise errors.ExistingPendingDeletion(deletiondir)
 
1366
        except:
 
1367
            tree.unlock()
 
1368
            raise
 
1369
 
 
1370
        # Cache of realpath results, to speed up canonical_path
 
1371
        self._realpaths = {}
 
1372
        # Cache of relpath results, to speed up canonical_path
 
1373
        self._relpaths = {}
 
1374
        DiskTreeTransform.__init__(self, tree, limbodir, pb,
 
1375
                                   tree.case_sensitive)
 
1376
        self._deletiondir = deletiondir
 
1377
 
 
1378
    def canonical_path(self, path):
 
1379
        """Get the canonical tree-relative path"""
 
1380
        # don't follow final symlinks
 
1381
        abs = self._tree.abspath(path)
 
1382
        if abs in self._relpaths:
 
1383
            return self._relpaths[abs]
 
1384
        dirname, basename = os.path.split(abs)
 
1385
        if dirname not in self._realpaths:
 
1386
            self._realpaths[dirname] = os.path.realpath(dirname)
 
1387
        dirname = self._realpaths[dirname]
 
1388
        abs = pathjoin(dirname, basename)
 
1389
        if dirname in self._relpaths:
 
1390
            relpath = pathjoin(self._relpaths[dirname], basename)
 
1391
            relpath = relpath.rstrip('/\\')
 
1392
        else:
 
1393
            relpath = self._tree.relpath(abs)
 
1394
        self._relpaths[abs] = relpath
 
1395
        return relpath
 
1396
 
 
1397
    def tree_kind(self, trans_id):
 
1398
        """Determine the file kind in the working tree.
 
1399
 
 
1400
        Raises NoSuchFile if the file does not exist
 
1401
        """
 
1402
        path = self._tree_id_paths.get(trans_id)
 
1403
        if path is None:
 
1404
            raise NoSuchFile(None)
 
1405
        try:
 
1406
            return file_kind(self._tree.abspath(path))
 
1407
        except OSError, e:
 
1408
            if e.errno != errno.ENOENT:
 
1409
                raise
 
1410
            else:
 
1411
                raise NoSuchFile(path)
 
1412
 
 
1413
    def _set_mode(self, trans_id, mode_id, typefunc):
 
1414
        """Set the mode of new file contents.
 
1415
        The mode_id is the existing file to get the mode from (often the same
 
1416
        as trans_id).  The operation is only performed if there's a mode match
 
1417
        according to typefunc.
 
1418
        """
 
1419
        if mode_id is None:
 
1420
            mode_id = trans_id
 
1421
        try:
 
1422
            old_path = self._tree_id_paths[mode_id]
 
1423
        except KeyError:
 
1424
            return
 
1425
        try:
 
1426
            mode = os.stat(self._tree.abspath(old_path)).st_mode
 
1427
        except OSError, e:
 
1428
            if e.errno in (errno.ENOENT, errno.ENOTDIR):
 
1429
                # Either old_path doesn't exist, or the parent of the
 
1430
                # target is not a directory (but will be one eventually)
 
1431
                # Either way, we know it doesn't exist *right now*
 
1432
                # See also bug #248448
 
1433
                return
 
1434
            else:
 
1435
                raise
 
1436
        if typefunc(mode):
 
1437
            os.chmod(self._limbo_name(trans_id), mode)
 
1438
 
 
1439
    def iter_tree_children(self, parent_id):
 
1440
        """Iterate through the entry's tree children, if any"""
 
1441
        try:
 
1442
            path = self._tree_id_paths[parent_id]
 
1443
        except KeyError:
 
1444
            return
 
1445
        try:
 
1446
            children = os.listdir(self._tree.abspath(path))
 
1447
        except OSError, e:
 
1448
            if not (osutils._is_error_enotdir(e)
 
1449
                    or e.errno in (errno.ENOENT, errno.ESRCH)):
 
1450
                raise
 
1451
            return
 
1452
 
 
1453
        for child in children:
 
1454
            childpath = joinpath(path, child)
 
1455
            if self._tree.is_control_filename(childpath):
 
1456
                continue
 
1457
            yield self.trans_id_tree_path(childpath)
 
1458
 
 
1459
    def _generate_limbo_path(self, trans_id):
 
1460
        """Generate a limbo path using the final path if possible.
 
1461
 
 
1462
        This optimizes the performance of applying the tree transform by
 
1463
        avoiding renames.  These renames can be avoided only when the parent
 
1464
        directory is already scheduled for creation.
 
1465
 
 
1466
        If the final path cannot be used, falls back to using the trans_id as
 
1467
        the relpath.
 
1468
        """
 
1469
        parent = self._new_parent.get(trans_id)
 
1470
        # if the parent directory is already in limbo (e.g. when building a
 
1471
        # tree), choose a limbo name inside the parent, to reduce further
 
1472
        # renames.
 
1473
        use_direct_path = False
 
1474
        if self._new_contents.get(parent) == 'directory':
 
1475
            filename = self._new_name.get(trans_id)
 
1476
            if filename is not None:
 
1477
                if parent not in self._limbo_children:
 
1478
                    self._limbo_children[parent] = set()
 
1479
                    self._limbo_children_names[parent] = {}
 
1480
                    use_direct_path = True
 
1481
                # the direct path can only be used if no other file has
 
1482
                # already taken this pathname, i.e. if the name is unused, or
 
1483
                # if it is already associated with this trans_id.
 
1484
                elif self._case_sensitive_target:
 
1485
                    if (self._limbo_children_names[parent].get(filename)
 
1486
                        in (trans_id, None)):
 
1487
                        use_direct_path = True
 
1488
                else:
 
1489
                    for l_filename, l_trans_id in\
 
1490
                        self._limbo_children_names[parent].iteritems():
 
1491
                        if l_trans_id == trans_id:
 
1492
                            continue
 
1493
                        if l_filename.lower() == filename.lower():
 
1494
                            break
 
1495
                    else:
 
1496
                        use_direct_path = True
 
1497
 
 
1498
        if not use_direct_path:
 
1499
            return DiskTreeTransform._generate_limbo_path(self, trans_id)
 
1500
 
 
1501
        limbo_name = pathjoin(self._limbo_files[parent], filename)
 
1502
        self._limbo_children[parent].add(trans_id)
 
1503
        self._limbo_children_names[parent][filename] = trans_id
 
1504
        return limbo_name
 
1505
 
 
1506
 
 
1507
    def apply(self, no_conflicts=False, precomputed_delta=None, _mover=None):
 
1508
        """Apply all changes to the inventory and filesystem.
 
1509
 
 
1510
        If filesystem or inventory conflicts are present, MalformedTransform
 
1511
        will be thrown.
 
1512
 
 
1513
        If apply succeeds, finalize is not necessary.
 
1514
 
 
1515
        :param no_conflicts: if True, the caller guarantees there are no
 
1516
            conflicts, so no check is made.
 
1517
        :param precomputed_delta: An inventory delta to use instead of
 
1518
            calculating one.
 
1519
        :param _mover: Supply an alternate FileMover, for testing
 
1520
        """
 
1521
        if not no_conflicts:
 
1522
            self._check_malformed()
 
1523
        child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
1524
        try:
 
1525
            if precomputed_delta is None:
 
1526
                child_pb.update('Apply phase', 0, 2)
 
1527
                inventory_delta = self._generate_inventory_delta()
 
1528
                offset = 1
 
1529
            else:
 
1530
                inventory_delta = precomputed_delta
 
1531
                offset = 0
 
1532
            if _mover is None:
 
1533
                mover = _FileMover()
 
1534
            else:
 
1535
                mover = _mover
 
1536
            try:
 
1537
                child_pb.update('Apply phase', 0 + offset, 2 + offset)
 
1538
                self._apply_removals(mover)
 
1539
                child_pb.update('Apply phase', 1 + offset, 2 + offset)
 
1540
                modified_paths = self._apply_insertions(mover)
 
1541
            except:
 
1542
                mover.rollback()
 
1543
                raise
 
1544
            else:
 
1545
                mover.apply_deletions()
 
1546
        finally:
 
1547
            child_pb.finished()
 
1548
        self._tree.apply_inventory_delta(inventory_delta)
 
1549
        self._done = True
 
1550
        self.finalize()
 
1551
        return _TransformResults(modified_paths, self.rename_count)
 
1552
 
 
1553
    def _generate_inventory_delta(self):
 
1554
        """Generate an inventory delta for the current transform."""
 
1555
        inventory_delta = []
 
1556
        child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
1557
        new_paths = self._inventory_altered()
 
1558
        total_entries = len(new_paths) + len(self._removed_id)
 
1559
        try:
 
1560
            for num, trans_id in enumerate(self._removed_id):
 
1561
                if (num % 10) == 0:
 
1562
                    child_pb.update('removing file', num, total_entries)
 
1563
                if trans_id == self._new_root:
 
1564
                    file_id = self._tree.get_root_id()
 
1565
                else:
 
1566
                    file_id = self.tree_file_id(trans_id)
 
1567
                # File-id isn't really being deleted, just moved
 
1568
                if file_id in self._r_new_id:
 
1569
                    continue
 
1570
                path = self._tree_id_paths[trans_id]
 
1571
                inventory_delta.append((path, None, file_id, None))
 
1572
            new_path_file_ids = dict((t, self.final_file_id(t)) for p, t in
 
1573
                                     new_paths)
 
1574
            entries = self._tree.iter_entries_by_dir(
 
1575
                new_path_file_ids.values())
 
1576
            old_paths = dict((e.file_id, p) for p, e in entries)
 
1577
            final_kinds = {}
 
1578
            for num, (path, trans_id) in enumerate(new_paths):
 
1579
                if (num % 10) == 0:
 
1580
                    child_pb.update('adding file',
 
1581
                                    num + len(self._removed_id), total_entries)
 
1582
                file_id = new_path_file_ids[trans_id]
 
1583
                if file_id is None:
 
1584
                    continue
 
1585
                needs_entry = False
 
1586
                try:
 
1587
                    kind = self.final_kind(trans_id)
 
1588
                except NoSuchFile:
 
1589
                    kind = self._tree.stored_kind(file_id)
 
1590
                parent_trans_id = self.final_parent(trans_id)
 
1591
                parent_file_id = new_path_file_ids.get(parent_trans_id)
 
1592
                if parent_file_id is None:
 
1593
                    parent_file_id = self.final_file_id(parent_trans_id)
 
1594
                if trans_id in self._new_reference_revision:
 
1595
                    new_entry = inventory.TreeReference(
 
1596
                        file_id,
 
1597
                        self._new_name[trans_id],
 
1598
                        self.final_file_id(self._new_parent[trans_id]),
 
1599
                        None, self._new_reference_revision[trans_id])
 
1600
                else:
 
1601
                    new_entry = inventory.make_entry(kind,
 
1602
                        self.final_name(trans_id),
 
1603
                        parent_file_id, file_id)
 
1604
                old_path = old_paths.get(new_entry.file_id)
 
1605
                new_executability = self._new_executability.get(trans_id)
 
1606
                if new_executability is not None:
 
1607
                    new_entry.executable = new_executability
 
1608
                inventory_delta.append(
 
1609
                    (old_path, path, new_entry.file_id, new_entry))
 
1610
        finally:
 
1611
            child_pb.finished()
 
1612
        return inventory_delta
 
1613
 
 
1614
    def _apply_removals(self, mover):
 
1615
        """Perform tree operations that remove directory/inventory names.
 
1616
 
 
1617
        That is, delete files that are to be deleted, and put any files that
 
1618
        need renaming into limbo.  This must be done in strict child-to-parent
 
1619
        order.
 
1620
 
 
1621
        If inventory_delta is None, no inventory delta generation is performed.
 
1622
        """
 
1623
        tree_paths = list(self._tree_path_ids.iteritems())
 
1624
        tree_paths.sort(reverse=True)
 
1625
        child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
1626
        try:
 
1627
            for num, data in enumerate(tree_paths):
 
1628
                path, trans_id = data
 
1629
                child_pb.update('removing file', num, len(tree_paths))
 
1630
                full_path = self._tree.abspath(path)
 
1631
                if trans_id in self._removed_contents:
 
1632
                    delete_path = os.path.join(self._deletiondir, trans_id)
 
1633
                    mover.pre_delete(full_path, delete_path)
 
1634
                elif (trans_id in self._new_name
 
1635
                      or trans_id in self._new_parent):
 
1636
                    try:
 
1637
                        mover.rename(full_path, self._limbo_name(trans_id))
 
1638
                    except OSError, e:
 
1639
                        if e.errno != errno.ENOENT:
 
1640
                            raise
 
1641
                    else:
 
1642
                        self.rename_count += 1
 
1643
        finally:
 
1644
            child_pb.finished()
 
1645
 
 
1646
    def _apply_insertions(self, mover):
 
1647
        """Perform tree operations that insert directory/inventory names.
 
1648
 
 
1649
        That is, create any files that need to be created, and restore from
 
1650
        limbo any files that needed renaming.  This must be done in strict
 
1651
        parent-to-child order.
 
1652
 
 
1653
        If inventory_delta is None, no inventory delta is calculated, and
 
1654
        no list of modified paths is returned.
 
1655
        """
 
1656
        new_paths = self.new_paths(filesystem_only=True)
 
1657
        modified_paths = []
 
1658
        new_path_file_ids = dict((t, self.final_file_id(t)) for p, t in
 
1659
                                 new_paths)
 
1660
        child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
1661
        try:
 
1662
            for num, (path, trans_id) in enumerate(new_paths):
 
1663
                if (num % 10) == 0:
 
1664
                    child_pb.update('adding file', num, len(new_paths))
 
1665
                full_path = self._tree.abspath(path)
 
1666
                if trans_id in self._needs_rename:
 
1667
                    try:
 
1668
                        mover.rename(self._limbo_name(trans_id), full_path)
 
1669
                    except OSError, e:
 
1670
                        # We may be renaming a dangling inventory id
 
1671
                        if e.errno != errno.ENOENT:
 
1672
                            raise
 
1673
                    else:
 
1674
                        self.rename_count += 1
 
1675
                if (trans_id in self._new_contents or
 
1676
                    self.path_changed(trans_id)):
 
1677
                    if trans_id in self._new_contents:
 
1678
                        modified_paths.append(full_path)
 
1679
                if trans_id in self._new_executability:
 
1680
                    self._set_executability(path, trans_id)
 
1681
        finally:
 
1682
            child_pb.finished()
 
1683
        self._new_contents.clear()
 
1684
        return modified_paths
 
1685
 
 
1686
 
 
1687
class TransformPreview(DiskTreeTransform):
 
1688
    """A TreeTransform for generating preview trees.
 
1689
 
 
1690
    Unlike TreeTransform, this version works when the input tree is a
 
1691
    RevisionTree, rather than a WorkingTree.  As a result, it tends to ignore
 
1692
    unversioned files in the input tree.
 
1693
    """
 
1694
 
 
1695
    def __init__(self, tree, pb=None, case_sensitive=True):
 
1696
        tree.lock_read()
 
1697
        limbodir = osutils.mkdtemp(prefix='bzr-limbo-')
 
1698
        DiskTreeTransform.__init__(self, tree, limbodir, pb, case_sensitive)
 
1699
 
 
1700
    def canonical_path(self, path):
 
1701
        return path
 
1702
 
 
1703
    def tree_kind(self, trans_id):
 
1704
        path = self._tree_id_paths.get(trans_id)
 
1705
        if path is None:
 
1706
            raise NoSuchFile(None)
 
1707
        file_id = self._tree.path2id(path)
 
1708
        return self._tree.kind(file_id)
 
1709
 
 
1710
    def _set_mode(self, trans_id, mode_id, typefunc):
 
1711
        """Set the mode of new file contents.
 
1712
        The mode_id is the existing file to get the mode from (often the same
 
1713
        as trans_id).  The operation is only performed if there's a mode match
 
1714
        according to typefunc.
 
1715
        """
 
1716
        # is it ok to ignore this?  probably
 
1717
        pass
 
1718
 
 
1719
    def iter_tree_children(self, parent_id):
 
1720
        """Iterate through the entry's tree children, if any"""
 
1721
        try:
 
1722
            path = self._tree_id_paths[parent_id]
 
1723
        except KeyError:
 
1724
            return
 
1725
        file_id = self.tree_file_id(parent_id)
 
1726
        if file_id is None:
 
1727
            return
 
1728
        entry = self._tree.iter_entries_by_dir([file_id]).next()[1]
 
1729
        children = getattr(entry, 'children', {})
 
1730
        for child in children:
 
1731
            childpath = joinpath(path, child)
 
1732
            yield self.trans_id_tree_path(childpath)
 
1733
 
 
1734
 
 
1735
class _PreviewTree(tree.Tree):
 
1736
    """Partial implementation of Tree to support show_diff_trees"""
 
1737
 
 
1738
    def __init__(self, transform):
 
1739
        self._transform = transform
 
1740
        self._final_paths = FinalPaths(transform)
 
1741
        self.__by_parent = None
 
1742
        self._parent_ids = []
 
1743
        self._all_children_cache = {}
 
1744
        self._path2trans_id_cache = {}
 
1745
        self._final_name_cache = {}
 
1746
        self._iter_changes_cache = dict((c[0], c) for c in
 
1747
                                        self._transform.iter_changes())
 
1748
 
 
1749
    def _content_change(self, file_id):
 
1750
        """Return True if the content of this file changed"""
 
1751
        changes = self._iter_changes_cache.get(file_id)
 
1752
        # changes[2] is true if the file content changed.  See
 
1753
        # InterTree.iter_changes.
 
1754
        return (changes is not None and changes[2])
 
1755
 
 
1756
    def _get_repository(self):
 
1757
        repo = getattr(self._transform._tree, '_repository', None)
 
1758
        if repo is None:
 
1759
            repo = self._transform._tree.branch.repository
 
1760
        return repo
 
1761
 
 
1762
    def _iter_parent_trees(self):
 
1763
        for revision_id in self.get_parent_ids():
 
1764
            try:
 
1765
                yield self.revision_tree(revision_id)
 
1766
            except errors.NoSuchRevisionInTree:
 
1767
                yield self._get_repository().revision_tree(revision_id)
 
1768
 
 
1769
    def _get_file_revision(self, file_id, vf, tree_revision):
 
1770
        parent_keys = [(file_id, self._file_revision(t, file_id)) for t in
 
1771
                       self._iter_parent_trees()]
 
1772
        vf.add_lines((file_id, tree_revision), parent_keys,
 
1773
                     self.get_file(file_id).readlines())
 
1774
        repo = self._get_repository()
 
1775
        base_vf = repo.texts
 
1776
        if base_vf not in vf.fallback_versionedfiles:
 
1777
            vf.fallback_versionedfiles.append(base_vf)
 
1778
        return tree_revision
 
1779
 
 
1780
    def _stat_limbo_file(self, file_id):
 
1781
        trans_id = self._transform.trans_id_file_id(file_id)
 
1782
        name = self._transform._limbo_name(trans_id)
 
1783
        return os.lstat(name)
 
1784
 
 
1785
    @property
 
1786
    def _by_parent(self):
 
1787
        if self.__by_parent is None:
 
1788
            self.__by_parent = self._transform.by_parent()
 
1789
        return self.__by_parent
 
1790
 
 
1791
    def _comparison_data(self, entry, path):
 
1792
        kind, size, executable, link_or_sha1 = self.path_content_summary(path)
 
1793
        if kind == 'missing':
 
1794
            kind = None
 
1795
            executable = False
 
1796
        else:
 
1797
            file_id = self._transform.final_file_id(self._path2trans_id(path))
 
1798
            executable = self.is_executable(file_id, path)
 
1799
        return kind, executable, None
 
1800
 
 
1801
    def is_locked(self):
 
1802
        return False
 
1803
 
 
1804
    def lock_read(self):
 
1805
        # Perhaps in theory, this should lock the TreeTransform?
 
1806
        return self
 
1807
 
 
1808
    def unlock(self):
 
1809
        pass
 
1810
 
 
1811
    @property
 
1812
    def inventory(self):
 
1813
        """This Tree does not use inventory as its backing data."""
 
1814
        raise NotImplementedError(_PreviewTree.inventory)
 
1815
 
 
1816
    def get_root_id(self):
 
1817
        return self._transform.final_file_id(self._transform.root)
 
1818
 
 
1819
    def all_file_ids(self):
 
1820
        tree_ids = set(self._transform._tree.all_file_ids())
 
1821
        tree_ids.difference_update(self._transform.tree_file_id(t)
 
1822
                                   for t in self._transform._removed_id)
 
1823
        tree_ids.update(self._transform._new_id.values())
 
1824
        return tree_ids
 
1825
 
 
1826
    def __iter__(self):
 
1827
        return iter(self.all_file_ids())
 
1828
 
 
1829
    def _has_id(self, file_id, fallback_check):
 
1830
        if file_id in self._transform._r_new_id:
 
1831
            return True
 
1832
        elif file_id in set([self._transform.tree_file_id(trans_id) for
 
1833
            trans_id in self._transform._removed_id]):
 
1834
            return False
 
1835
        else:
 
1836
            return fallback_check(file_id)
 
1837
 
 
1838
    def has_id(self, file_id):
 
1839
        return self._has_id(file_id, self._transform._tree.has_id)
 
1840
 
 
1841
    def has_or_had_id(self, file_id):
 
1842
        return self._has_id(file_id, self._transform._tree.has_or_had_id)
 
1843
 
 
1844
    def _path2trans_id(self, path):
 
1845
        # We must not use None here, because that is a valid value to store.
 
1846
        trans_id = self._path2trans_id_cache.get(path, object)
 
1847
        if trans_id is not object:
 
1848
            return trans_id
 
1849
        segments = splitpath(path)
 
1850
        cur_parent = self._transform.root
 
1851
        for cur_segment in segments:
 
1852
            for child in self._all_children(cur_parent):
 
1853
                final_name = self._final_name_cache.get(child)
 
1854
                if final_name is None:
 
1855
                    final_name = self._transform.final_name(child)
 
1856
                    self._final_name_cache[child] = final_name
 
1857
                if final_name == cur_segment:
 
1858
                    cur_parent = child
 
1859
                    break
 
1860
            else:
 
1861
                self._path2trans_id_cache[path] = None
 
1862
                return None
 
1863
        self._path2trans_id_cache[path] = cur_parent
 
1864
        return cur_parent
 
1865
 
 
1866
    def path2id(self, path):
 
1867
        return self._transform.final_file_id(self._path2trans_id(path))
 
1868
 
 
1869
    def id2path(self, file_id):
 
1870
        trans_id = self._transform.trans_id_file_id(file_id)
 
1871
        try:
 
1872
            return self._final_paths._determine_path(trans_id)
 
1873
        except NoFinalPath:
 
1874
            raise errors.NoSuchId(self, file_id)
 
1875
 
 
1876
    def _all_children(self, trans_id):
 
1877
        children = self._all_children_cache.get(trans_id)
 
1878
        if children is not None:
 
1879
            return children
 
1880
        children = set(self._transform.iter_tree_children(trans_id))
 
1881
        # children in the _new_parent set are provided by _by_parent.
 
1882
        children.difference_update(self._transform._new_parent.keys())
 
1883
        children.update(self._by_parent.get(trans_id, []))
 
1884
        self._all_children_cache[trans_id] = children
 
1885
        return children
 
1886
 
 
1887
    def iter_children(self, file_id):
 
1888
        trans_id = self._transform.trans_id_file_id(file_id)
 
1889
        for child_trans_id in self._all_children(trans_id):
 
1890
            yield self._transform.final_file_id(child_trans_id)
 
1891
 
 
1892
    def extras(self):
 
1893
        possible_extras = set(self._transform.trans_id_tree_path(p) for p
 
1894
                              in self._transform._tree.extras())
 
1895
        possible_extras.update(self._transform._new_contents)
 
1896
        possible_extras.update(self._transform._removed_id)
 
1897
        for trans_id in possible_extras:
 
1898
            if self._transform.final_file_id(trans_id) is None:
 
1899
                yield self._final_paths._determine_path(trans_id)
 
1900
 
 
1901
    def _make_inv_entries(self, ordered_entries, specific_file_ids=None,
 
1902
        yield_parents=False):
 
1903
        for trans_id, parent_file_id in ordered_entries:
 
1904
            file_id = self._transform.final_file_id(trans_id)
 
1905
            if file_id is None:
 
1906
                continue
 
1907
            if (specific_file_ids is not None
 
1908
                and file_id not in specific_file_ids):
 
1909
                continue
 
1910
            try:
 
1911
                kind = self._transform.final_kind(trans_id)
 
1912
            except NoSuchFile:
 
1913
                kind = self._transform._tree.stored_kind(file_id)
 
1914
            new_entry = inventory.make_entry(
 
1915
                kind,
 
1916
                self._transform.final_name(trans_id),
 
1917
                parent_file_id, file_id)
 
1918
            yield new_entry, trans_id
 
1919
 
 
1920
    def _list_files_by_dir(self):
 
1921
        todo = [ROOT_PARENT]
 
1922
        ordered_ids = []
 
1923
        while len(todo) > 0:
 
1924
            parent = todo.pop()
 
1925
            parent_file_id = self._transform.final_file_id(parent)
 
1926
            children = list(self._all_children(parent))
 
1927
            paths = dict(zip(children, self._final_paths.get_paths(children)))
 
1928
            children.sort(key=paths.get)
 
1929
            todo.extend(reversed(children))
 
1930
            for trans_id in children:
 
1931
                ordered_ids.append((trans_id, parent_file_id))
 
1932
        return ordered_ids
 
1933
 
 
1934
    def iter_entries_by_dir(self, specific_file_ids=None, yield_parents=False):
 
1935
        # This may not be a maximally efficient implementation, but it is
 
1936
        # reasonably straightforward.  An implementation that grafts the
 
1937
        # TreeTransform changes onto the tree's iter_entries_by_dir results
 
1938
        # might be more efficient, but requires tricky inferences about stack
 
1939
        # position.
 
1940
        ordered_ids = self._list_files_by_dir()
 
1941
        for entry, trans_id in self._make_inv_entries(ordered_ids,
 
1942
            specific_file_ids, yield_parents=yield_parents):
 
1943
            yield unicode(self._final_paths.get_path(trans_id)), entry
 
1944
 
 
1945
    def _iter_entries_for_dir(self, dir_path):
 
1946
        """Return path, entry for items in a directory without recursing down."""
 
1947
        dir_file_id = self.path2id(dir_path)
 
1948
        ordered_ids = []
 
1949
        for file_id in self.iter_children(dir_file_id):
 
1950
            trans_id = self._transform.trans_id_file_id(file_id)
 
1951
            ordered_ids.append((trans_id, file_id))
 
1952
        for entry, trans_id in self._make_inv_entries(ordered_ids):
 
1953
            yield unicode(self._final_paths.get_path(trans_id)), entry
 
1954
 
 
1955
    def list_files(self, include_root=False, from_dir=None, recursive=True):
 
1956
        """See WorkingTree.list_files."""
 
1957
        # XXX This should behave like WorkingTree.list_files, but is really
 
1958
        # more like RevisionTree.list_files.
 
1959
        if recursive:
 
1960
            prefix = None
 
1961
            if from_dir:
 
1962
                prefix = from_dir + '/'
 
1963
            entries = self.iter_entries_by_dir()
 
1964
            for path, entry in entries:
 
1965
                if entry.name == '' and not include_root:
 
1966
                    continue
 
1967
                if prefix:
 
1968
                    if not path.startswith(prefix):
 
1969
                        continue
 
1970
                    path = path[len(prefix):]
 
1971
                yield path, 'V', entry.kind, entry.file_id, entry
 
1972
        else:
 
1973
            if from_dir is None and include_root is True:
 
1974
                root_entry = inventory.make_entry('directory', '',
 
1975
                    ROOT_PARENT, self.get_root_id())
 
1976
                yield '', 'V', 'directory', root_entry.file_id, root_entry
 
1977
            entries = self._iter_entries_for_dir(from_dir or '')
 
1978
            for path, entry in entries:
 
1979
                yield path, 'V', entry.kind, entry.file_id, entry
 
1980
 
 
1981
    def kind(self, file_id):
 
1982
        trans_id = self._transform.trans_id_file_id(file_id)
 
1983
        return self._transform.final_kind(trans_id)
 
1984
 
 
1985
    def stored_kind(self, file_id):
 
1986
        trans_id = self._transform.trans_id_file_id(file_id)
 
1987
        try:
 
1988
            return self._transform._new_contents[trans_id]
 
1989
        except KeyError:
 
1990
            return self._transform._tree.stored_kind(file_id)
 
1991
 
 
1992
    def get_file_mtime(self, file_id, path=None):
 
1993
        """See Tree.get_file_mtime"""
 
1994
        if not self._content_change(file_id):
 
1995
            return self._transform._tree.get_file_mtime(file_id)
 
1996
        return self._stat_limbo_file(file_id).st_mtime
 
1997
 
 
1998
    def _file_size(self, entry, stat_value):
 
1999
        return self.get_file_size(entry.file_id)
 
2000
 
 
2001
    def get_file_size(self, file_id):
 
2002
        """See Tree.get_file_size"""
 
2003
        if self.kind(file_id) == 'file':
 
2004
            return self._transform._tree.get_file_size(file_id)
 
2005
        else:
 
2006
            return None
 
2007
 
 
2008
    def get_file_sha1(self, file_id, path=None, stat_value=None):
 
2009
        trans_id = self._transform.trans_id_file_id(file_id)
 
2010
        kind = self._transform._new_contents.get(trans_id)
 
2011
        if kind is None:
 
2012
            return self._transform._tree.get_file_sha1(file_id)
 
2013
        if kind == 'file':
 
2014
            fileobj = self.get_file(file_id)
 
2015
            try:
 
2016
                return sha_file(fileobj)
 
2017
            finally:
 
2018
                fileobj.close()
 
2019
 
 
2020
    def is_executable(self, file_id, path=None):
 
2021
        if file_id is None:
 
2022
            return False
 
2023
        trans_id = self._transform.trans_id_file_id(file_id)
 
2024
        try:
 
2025
            return self._transform._new_executability[trans_id]
 
2026
        except KeyError:
 
2027
            try:
 
2028
                return self._transform._tree.is_executable(file_id, path)
 
2029
            except OSError, e:
 
2030
                if e.errno == errno.ENOENT:
 
2031
                    return False
 
2032
                raise
 
2033
            except errors.NoSuchId:
 
2034
                return False
 
2035
 
 
2036
    def path_content_summary(self, path):
 
2037
        trans_id = self._path2trans_id(path)
 
2038
        tt = self._transform
 
2039
        tree_path = tt._tree_id_paths.get(trans_id)
 
2040
        kind = tt._new_contents.get(trans_id)
 
2041
        if kind is None:
 
2042
            if tree_path is None or trans_id in tt._removed_contents:
 
2043
                return 'missing', None, None, None
 
2044
            summary = tt._tree.path_content_summary(tree_path)
 
2045
            kind, size, executable, link_or_sha1 = summary
 
2046
        else:
 
2047
            link_or_sha1 = None
 
2048
            limbo_name = tt._limbo_name(trans_id)
 
2049
            if trans_id in tt._new_reference_revision:
 
2050
                kind = 'tree-reference'
 
2051
            if kind == 'file':
 
2052
                statval = os.lstat(limbo_name)
 
2053
                size = statval.st_size
 
2054
                if not supports_executable():
 
2055
                    executable = False
 
2056
                else:
 
2057
                    executable = statval.st_mode & S_IEXEC
 
2058
            else:
 
2059
                size = None
 
2060
                executable = None
 
2061
            if kind == 'symlink':
 
2062
                link_or_sha1 = os.readlink(limbo_name).decode(osutils._fs_enc)
 
2063
        executable = tt._new_executability.get(trans_id, executable)
 
2064
        return kind, size, executable, link_or_sha1
 
2065
 
 
2066
    def iter_changes(self, from_tree, include_unchanged=False,
 
2067
                      specific_files=None, pb=None, extra_trees=None,
 
2068
                      require_versioned=True, want_unversioned=False):
 
2069
        """See InterTree.iter_changes.
 
2070
 
 
2071
        This has a fast path that is only used when the from_tree matches
 
2072
        the transform tree, and no fancy options are supplied.
 
2073
        """
 
2074
        if (from_tree is not self._transform._tree or include_unchanged or
 
2075
            specific_files or want_unversioned):
 
2076
            return tree.InterTree(from_tree, self).iter_changes(
 
2077
                include_unchanged=include_unchanged,
 
2078
                specific_files=specific_files,
 
2079
                pb=pb,
 
2080
                extra_trees=extra_trees,
 
2081
                require_versioned=require_versioned,
 
2082
                want_unversioned=want_unversioned)
 
2083
        if want_unversioned:
 
2084
            raise ValueError('want_unversioned is not supported')
 
2085
        return self._transform.iter_changes()
 
2086
 
 
2087
    def get_file(self, file_id, path=None):
 
2088
        """See Tree.get_file"""
 
2089
        if not self._content_change(file_id):
 
2090
            return self._transform._tree.get_file(file_id, path)
 
2091
        trans_id = self._transform.trans_id_file_id(file_id)
 
2092
        name = self._transform._limbo_name(trans_id)
 
2093
        return open(name, 'rb')
 
2094
 
 
2095
    def get_file_with_stat(self, file_id, path=None):
 
2096
        return self.get_file(file_id, path), None
 
2097
 
 
2098
    def annotate_iter(self, file_id,
 
2099
                      default_revision=_mod_revision.CURRENT_REVISION):
 
2100
        changes = self._iter_changes_cache.get(file_id)
 
2101
        if changes is None:
 
2102
            get_old = True
 
2103
        else:
 
2104
            changed_content, versioned, kind = (changes[2], changes[3],
 
2105
                                                changes[6])
 
2106
            if kind[1] is None:
 
2107
                return None
 
2108
            get_old = (kind[0] == 'file' and versioned[0])
 
2109
        if get_old:
 
2110
            old_annotation = self._transform._tree.annotate_iter(file_id,
 
2111
                default_revision=default_revision)
 
2112
        else:
 
2113
            old_annotation = []
 
2114
        if changes is None:
 
2115
            return old_annotation
 
2116
        if not changed_content:
 
2117
            return old_annotation
 
2118
        # TODO: This is doing something similar to what WT.annotate_iter is
 
2119
        #       doing, however it fails slightly because it doesn't know what
 
2120
        #       the *other* revision_id is, so it doesn't know how to give the
 
2121
        #       other as the origin for some lines, they all get
 
2122
        #       'default_revision'
 
2123
        #       It would be nice to be able to use the new Annotator based
 
2124
        #       approach, as well.
 
2125
        return annotate.reannotate([old_annotation],
 
2126
                                   self.get_file(file_id).readlines(),
 
2127
                                   default_revision)
 
2128
 
 
2129
    def get_symlink_target(self, file_id):
 
2130
        """See Tree.get_symlink_target"""
 
2131
        if not self._content_change(file_id):
 
2132
            return self._transform._tree.get_symlink_target(file_id)
 
2133
        trans_id = self._transform.trans_id_file_id(file_id)
 
2134
        name = self._transform._limbo_name(trans_id)
 
2135
        return osutils.readlink(name)
 
2136
 
 
2137
    def walkdirs(self, prefix=''):
 
2138
        pending = [self._transform.root]
 
2139
        while len(pending) > 0:
 
2140
            parent_id = pending.pop()
 
2141
            children = []
 
2142
            subdirs = []
 
2143
            prefix = prefix.rstrip('/')
 
2144
            parent_path = self._final_paths.get_path(parent_id)
 
2145
            parent_file_id = self._transform.final_file_id(parent_id)
 
2146
            for child_id in self._all_children(parent_id):
 
2147
                path_from_root = self._final_paths.get_path(child_id)
 
2148
                basename = self._transform.final_name(child_id)
 
2149
                file_id = self._transform.final_file_id(child_id)
 
2150
                try:
 
2151
                    kind = self._transform.final_kind(child_id)
 
2152
                    versioned_kind = kind
 
2153
                except NoSuchFile:
 
2154
                    kind = 'unknown'
 
2155
                    versioned_kind = self._transform._tree.stored_kind(file_id)
 
2156
                if versioned_kind == 'directory':
 
2157
                    subdirs.append(child_id)
 
2158
                children.append((path_from_root, basename, kind, None,
 
2159
                                 file_id, versioned_kind))
 
2160
            children.sort()
 
2161
            if parent_path.startswith(prefix):
 
2162
                yield (parent_path, parent_file_id), children
 
2163
            pending.extend(sorted(subdirs, key=self._final_paths.get_path,
 
2164
                                  reverse=True))
 
2165
 
 
2166
    def get_parent_ids(self):
 
2167
        return self._parent_ids
 
2168
 
 
2169
    def set_parent_ids(self, parent_ids):
 
2170
        self._parent_ids = parent_ids
 
2171
 
 
2172
    def get_revision_tree(self, revision_id):
 
2173
        return self._transform._tree.get_revision_tree(revision_id)
 
2174
 
1278
2175
 
1279
2176
def joinpath(parent, child):
1280
2177
    """Join tree-relative paths, handling the tree root specially"""
1296
2193
        self.transform = transform
1297
2194
 
1298
2195
    def _determine_path(self, trans_id):
1299
 
        if trans_id == self.transform.root:
 
2196
        if (trans_id == self.transform.root or trans_id == ROOT_PARENT):
1300
2197
            return ""
1301
2198
        name = self.transform.final_name(trans_id)
1302
2199
        parent_id = self.transform.final_parent(trans_id)
1311
2208
            self._known_paths[trans_id] = self._determine_path(trans_id)
1312
2209
        return self._known_paths[trans_id]
1313
2210
 
 
2211
    def get_paths(self, trans_ids):
 
2212
        return [(self.get_path(t), t) for t in trans_ids]
 
2213
 
 
2214
 
1314
2215
 
1315
2216
def topology_sorted_ids(tree):
1316
2217
    """Determine the topological order of the ids in a tree"""
1319
2220
    return file_ids
1320
2221
 
1321
2222
 
1322
 
def build_tree(tree, wt):
 
2223
def build_tree(tree, wt, accelerator_tree=None, hardlink=False,
 
2224
               delta_from_tree=False):
1323
2225
    """Create working tree for a branch, using a TreeTransform.
1324
 
    
 
2226
 
1325
2227
    This function should be used on empty trees, having a tree root at most.
1326
2228
    (see merge and revert functionality for working with existing trees)
1327
2229
 
1328
2230
    Existing files are handled like so:
1329
 
    
 
2231
 
1330
2232
    - Existing bzrdirs take precedence over creating new items.  They are
1331
2233
      created as '%s.diverted' % name.
1332
2234
    - Otherwise, if the content on disk matches the content we are building,
1333
2235
      it is silently replaced.
1334
2236
    - Otherwise, conflict resolution will move the old file to 'oldname.moved'.
 
2237
 
 
2238
    :param tree: The tree to convert wt into a copy of
 
2239
    :param wt: The working tree that files will be placed into
 
2240
    :param accelerator_tree: A tree which can be used for retrieving file
 
2241
        contents more quickly than tree itself, i.e. a workingtree.  tree
 
2242
        will be used for cases where accelerator_tree's content is different.
 
2243
    :param hardlink: If true, hard-link files to accelerator_tree, where
 
2244
        possible.  accelerator_tree must implement abspath, i.e. be a
 
2245
        working tree.
 
2246
    :param delta_from_tree: If true, build_tree may use the input Tree to
 
2247
        generate the inventory delta.
1335
2248
    """
1336
2249
    wt.lock_tree_write()
1337
2250
    try:
1338
2251
        tree.lock_read()
1339
2252
        try:
1340
 
            return _build_tree(tree, wt)
 
2253
            if accelerator_tree is not None:
 
2254
                accelerator_tree.lock_read()
 
2255
            try:
 
2256
                return _build_tree(tree, wt, accelerator_tree, hardlink,
 
2257
                                   delta_from_tree)
 
2258
            finally:
 
2259
                if accelerator_tree is not None:
 
2260
                    accelerator_tree.unlock()
1341
2261
        finally:
1342
2262
            tree.unlock()
1343
2263
    finally:
1344
2264
        wt.unlock()
1345
2265
 
1346
2266
 
1347
 
def _build_tree(tree, wt):
 
2267
def _build_tree(tree, wt, accelerator_tree, hardlink, delta_from_tree):
1348
2268
    """See build_tree."""
1349
 
    if len(wt.inventory) > 1:  # more than just a root
1350
 
        raise errors.WorkingTreeAlreadyPopulated(base=wt.basedir)
 
2269
    for num, _unused in enumerate(wt.all_file_ids()):
 
2270
        if num > 0:  # more than just a root
 
2271
            raise errors.WorkingTreeAlreadyPopulated(base=wt.basedir)
 
2272
    existing_files = set()
 
2273
    for dir, files in wt.walkdirs():
 
2274
        existing_files.update(f[0] for f in files)
1351
2275
    file_trans_id = {}
1352
2276
    top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1353
2277
    pp = ProgressPhase("Build phase", 2, top_pb)
1371
2295
        pb = bzrlib.ui.ui_factory.nested_progress_bar()
1372
2296
        try:
1373
2297
            deferred_contents = []
 
2298
            num = 0
 
2299
            total = len(tree.inventory)
 
2300
            if delta_from_tree:
 
2301
                precomputed_delta = []
 
2302
            else:
 
2303
                precomputed_delta = None
1374
2304
            for num, (tree_path, entry) in \
1375
2305
                enumerate(tree.inventory.iter_entries_by_dir()):
1376
 
                pb.update("Building tree", num - len(deferred_contents),
1377
 
                          len(tree.inventory))
 
2306
                pb.update("Building tree", num - len(deferred_contents), total)
1378
2307
                if entry.parent_id is None:
1379
2308
                    continue
1380
2309
                reparent = False
1381
2310
                file_id = entry.file_id
1382
 
                target_path = wt.abspath(tree_path)
1383
 
                try:
 
2311
                if delta_from_tree:
 
2312
                    precomputed_delta.append((None, tree_path, file_id, entry))
 
2313
                if tree_path in existing_files:
 
2314
                    target_path = wt.abspath(tree_path)
1384
2315
                    kind = file_kind(target_path)
1385
 
                except NoSuchFile:
1386
 
                    pass
1387
 
                else:
1388
2316
                    if kind == "directory":
1389
2317
                        try:
1390
2318
                            bzrdir.BzrDir.open(target_path)
1398
2326
                        tt.delete_contents(tt.trans_id_tree_path(tree_path))
1399
2327
                        if kind == 'directory':
1400
2328
                            reparent = True
1401
 
                if entry.parent_id not in file_trans_id:
1402
 
                    raise AssertionError(
1403
 
                        'entry %s parent id %r is not in file_trans_id %r'
1404
 
                        % (entry, entry.parent_id, file_trans_id))
1405
2329
                parent_id = file_trans_id[entry.parent_id]
1406
2330
                if entry.kind == 'file':
1407
2331
                    # We *almost* replicate new_by_entry, so that we can defer
1408
2332
                    # getting the file text, and get them all at once.
1409
2333
                    trans_id = tt.create_path(entry.name, parent_id)
1410
2334
                    file_trans_id[file_id] = trans_id
1411
 
                    tt.version_file(entry.file_id, trans_id)
1412
 
                    executable = tree.is_executable(entry.file_id, tree_path)
1413
 
                    if executable is not None:
 
2335
                    tt.version_file(file_id, trans_id)
 
2336
                    executable = tree.is_executable(file_id, tree_path)
 
2337
                    if executable:
1414
2338
                        tt.set_executability(executable, trans_id)
1415
 
                    deferred_contents.append((entry.file_id, trans_id))
 
2339
                    trans_data = (trans_id, tree_path)
 
2340
                    deferred_contents.append((file_id, trans_data))
1416
2341
                else:
1417
2342
                    file_trans_id[file_id] = new_by_entry(tt, entry, parent_id,
1418
2343
                                                          tree)
1420
2345
                    new_trans_id = file_trans_id[file_id]
1421
2346
                    old_parent = tt.trans_id_tree_path(tree_path)
1422
2347
                    _reparent_children(tt, old_parent, new_trans_id)
1423
 
            for num, (trans_id, bytes) in enumerate(
1424
 
                tree.iter_files_bytes(deferred_contents)):
1425
 
                tt.create_file(bytes, trans_id)
1426
 
                pb.update('Adding file contents',
1427
 
                          (num + len(tree.inventory) - len(deferred_contents)),
1428
 
                          len(tree.inventory))
 
2348
            offset = num + 1 - len(deferred_contents)
 
2349
            _create_files(tt, tree, deferred_contents, pb, offset,
 
2350
                          accelerator_tree, hardlink)
1429
2351
        finally:
1430
2352
            pb.finished()
1431
2353
        pp.next_phase()
1432
2354
        divert_trans = set(file_trans_id[f] for f in divert)
1433
2355
        resolver = lambda t, c: resolve_checkout(t, c, divert_trans)
1434
2356
        raw_conflicts = resolve_conflicts(tt, pass_func=resolver)
 
2357
        if len(raw_conflicts) > 0:
 
2358
            precomputed_delta = None
1435
2359
        conflicts = cook_conflicts(raw_conflicts, tt)
1436
2360
        for conflict in conflicts:
1437
2361
            warning(conflict)
1439
2363
            wt.add_conflicts(conflicts)
1440
2364
        except errors.UnsupportedOperation:
1441
2365
            pass
1442
 
        result = tt.apply()
 
2366
        result = tt.apply(no_conflicts=True,
 
2367
                          precomputed_delta=precomputed_delta)
1443
2368
    finally:
1444
2369
        tt.finalize()
1445
2370
        top_pb.finished()
1446
2371
    return result
1447
2372
 
1448
2373
 
 
2374
def _create_files(tt, tree, desired_files, pb, offset, accelerator_tree,
 
2375
                  hardlink):
 
2376
    total = len(desired_files) + offset
 
2377
    wt = tt._tree
 
2378
    if accelerator_tree is None:
 
2379
        new_desired_files = desired_files
 
2380
    else:
 
2381
        iter = accelerator_tree.iter_changes(tree, include_unchanged=True)
 
2382
        unchanged = [(f, p[1]) for (f, p, c, v, d, n, k, e)
 
2383
                     in iter if not (c or e[0] != e[1])]
 
2384
        if accelerator_tree.supports_content_filtering():
 
2385
            unchanged = [(f, p) for (f, p) in unchanged
 
2386
                         if not accelerator_tree.iter_search_rules([p]).next()]
 
2387
        unchanged = dict(unchanged)
 
2388
        new_desired_files = []
 
2389
        count = 0
 
2390
        for file_id, (trans_id, tree_path) in desired_files:
 
2391
            accelerator_path = unchanged.get(file_id)
 
2392
            if accelerator_path is None:
 
2393
                new_desired_files.append((file_id, (trans_id, tree_path)))
 
2394
                continue
 
2395
            pb.update('Adding file contents', count + offset, total)
 
2396
            if hardlink:
 
2397
                tt.create_hardlink(accelerator_tree.abspath(accelerator_path),
 
2398
                                   trans_id)
 
2399
            else:
 
2400
                contents = accelerator_tree.get_file(file_id, accelerator_path)
 
2401
                if wt.supports_content_filtering():
 
2402
                    filters = wt._content_filter_stack(tree_path)
 
2403
                    contents = filtered_output_bytes(contents, filters,
 
2404
                        ContentFilterContext(tree_path, tree))
 
2405
                try:
 
2406
                    tt.create_file(contents, trans_id)
 
2407
                finally:
 
2408
                    try:
 
2409
                        contents.close()
 
2410
                    except AttributeError:
 
2411
                        # after filtering, contents may no longer be file-like
 
2412
                        pass
 
2413
            count += 1
 
2414
        offset += count
 
2415
    for count, ((trans_id, tree_path), contents) in enumerate(
 
2416
            tree.iter_files_bytes(new_desired_files)):
 
2417
        if wt.supports_content_filtering():
 
2418
            filters = wt._content_filter_stack(tree_path)
 
2419
            contents = filtered_output_bytes(contents, filters,
 
2420
                ContentFilterContext(tree_path, tree))
 
2421
        tt.create_file(contents, trans_id)
 
2422
        pb.update('Adding file contents', count + offset, total)
 
2423
 
 
2424
 
1449
2425
def _reparent_children(tt, old_parent, new_parent):
1450
2426
    for child in tt.iter_tree_children(old_parent):
1451
2427
        tt.adjust_path(tt.final_name(child), new_parent, child)
1452
2428
 
 
2429
def _reparent_transform_children(tt, old_parent, new_parent):
 
2430
    by_parent = tt.by_parent()
 
2431
    for child in by_parent[old_parent]:
 
2432
        tt.adjust_path(tt.final_name(child), new_parent, child)
 
2433
    return by_parent[old_parent]
1453
2434
 
1454
2435
def _content_match(tree, entry, file_id, kind, target_path):
1455
2436
    if entry.kind != kind:
1469
2450
    new_conflicts = set()
1470
2451
    for c_type, conflict in ((c[0], c) for c in conflicts):
1471
2452
        # Anything but a 'duplicate' would indicate programmer error
1472
 
        assert c_type == 'duplicate', c_type
 
2453
        if c_type != 'duplicate':
 
2454
            raise AssertionError(c_type)
1473
2455
        # Now figure out which is new and which is old
1474
2456
        if tt.new_contents(conflict[1]):
1475
2457
            new_file = conflict[1]
1501
2483
    if kind == 'file':
1502
2484
        contents = tree.get_file(entry.file_id).readlines()
1503
2485
        executable = tree.is_executable(entry.file_id)
1504
 
        return tt.new_file(name, parent_id, contents, entry.file_id, 
 
2486
        return tt.new_file(name, parent_id, contents, entry.file_id,
1505
2487
                           executable)
1506
2488
    elif kind in ('directory', 'tree-reference'):
1507
2489
        trans_id = tt.new_directory(name, parent_id, entry.file_id)
1508
2490
        if kind == 'tree-reference':
1509
2491
            tt.set_tree_reference(entry.reference_revision, trans_id)
1510
 
        return trans_id 
 
2492
        return trans_id
1511
2493
    elif kind == 'symlink':
1512
2494
        target = tree.get_symlink_target(entry.file_id)
1513
2495
        return tt.new_symlink(name, parent_id, target, entry.file_id)
1515
2497
        raise errors.BadFileKindError(name, kind)
1516
2498
 
1517
2499
 
 
2500
@deprecated_function(deprecated_in((1, 9, 0)))
1518
2501
def create_by_entry(tt, entry, tree, trans_id, lines=None, mode_id=None):
1519
 
    """Create new file contents according to an inventory entry."""
 
2502
    """Create new file contents according to an inventory entry.
 
2503
 
 
2504
    DEPRECATED.  Use create_from_tree instead.
 
2505
    """
1520
2506
    if entry.kind == "file":
1521
2507
        if lines is None:
1522
2508
            lines = tree.get_file(entry.file_id).readlines()
1527
2513
        tt.create_directory(trans_id)
1528
2514
 
1529
2515
 
 
2516
def create_from_tree(tt, trans_id, tree, file_id, bytes=None,
 
2517
    filter_tree_path=None):
 
2518
    """Create new file contents according to tree contents.
 
2519
    
 
2520
    :param filter_tree_path: the tree path to use to lookup
 
2521
      content filters to apply to the bytes output in the working tree.
 
2522
      This only applies if the working tree supports content filtering.
 
2523
    """
 
2524
    kind = tree.kind(file_id)
 
2525
    if kind == 'directory':
 
2526
        tt.create_directory(trans_id)
 
2527
    elif kind == "file":
 
2528
        if bytes is None:
 
2529
            tree_file = tree.get_file(file_id)
 
2530
            try:
 
2531
                bytes = tree_file.readlines()
 
2532
            finally:
 
2533
                tree_file.close()
 
2534
        wt = tt._tree
 
2535
        if wt.supports_content_filtering() and filter_tree_path is not None:
 
2536
            filters = wt._content_filter_stack(filter_tree_path)
 
2537
            bytes = filtered_output_bytes(bytes, filters,
 
2538
                ContentFilterContext(filter_tree_path, tree))
 
2539
        tt.create_file(bytes, trans_id)
 
2540
    elif kind == "symlink":
 
2541
        tt.create_symlink(tree.get_symlink_target(file_id), trans_id)
 
2542
    else:
 
2543
        raise AssertionError('Unknown kind %r' % kind)
 
2544
 
 
2545
 
1530
2546
def create_entry_executability(tt, entry, trans_id):
1531
2547
    """Set the executability of a trans_id according to an inventory entry"""
1532
2548
    if entry.kind == "file":
1533
2549
        tt.set_executability(entry.executable, trans_id)
1534
2550
 
1535
2551
 
1536
 
@deprecated_function(zero_fifteen)
1537
 
def find_interesting(working_tree, target_tree, filenames):
1538
 
    """Find the ids corresponding to specified filenames.
1539
 
    
1540
 
    Deprecated: Please use tree1.paths2ids(filenames, [tree2]).
1541
 
    """
1542
 
    working_tree.lock_read()
1543
 
    try:
1544
 
        target_tree.lock_read()
1545
 
        try:
1546
 
            return working_tree.paths2ids(filenames, [target_tree])
1547
 
        finally:
1548
 
            target_tree.unlock()
1549
 
    finally:
1550
 
        working_tree.unlock()
1551
 
 
1552
 
 
1553
 
@deprecated_function(zero_ninety)
1554
 
def change_entry(tt, file_id, working_tree, target_tree, 
1555
 
                 trans_id_file_id, backups, trans_id, by_parent):
1556
 
    """Replace a file_id's contents with those from a target tree."""
1557
 
    if file_id is None and target_tree is None:
1558
 
        # skip the logic altogether in the deprecation test
1559
 
        return
1560
 
    e_trans_id = trans_id_file_id(file_id)
1561
 
    entry = target_tree.inventory[file_id]
1562
 
    has_contents, contents_mod, meta_mod, = _entry_changes(file_id, entry, 
1563
 
                                                           working_tree)
1564
 
    if contents_mod:
1565
 
        mode_id = e_trans_id
1566
 
        if has_contents:
1567
 
            if not backups:
1568
 
                tt.delete_contents(e_trans_id)
1569
 
            else:
1570
 
                parent_trans_id = trans_id_file_id(entry.parent_id)
1571
 
                backup_name = get_backup_name(entry, by_parent,
1572
 
                                              parent_trans_id, tt)
1573
 
                tt.adjust_path(backup_name, parent_trans_id, e_trans_id)
1574
 
                tt.unversion_file(e_trans_id)
1575
 
                e_trans_id = tt.create_path(entry.name, parent_trans_id)
1576
 
                tt.version_file(file_id, e_trans_id)
1577
 
                trans_id[file_id] = e_trans_id
1578
 
        create_by_entry(tt, entry, target_tree, e_trans_id, mode_id=mode_id)
1579
 
        create_entry_executability(tt, entry, e_trans_id)
1580
 
 
1581
 
    elif meta_mod:
1582
 
        tt.set_executability(entry.executable, e_trans_id)
1583
 
    if tt.final_name(e_trans_id) != entry.name:
1584
 
        adjust_path  = True
1585
 
    else:
1586
 
        parent_id = tt.final_parent(e_trans_id)
1587
 
        parent_file_id = tt.final_file_id(parent_id)
1588
 
        if parent_file_id != entry.parent_id:
1589
 
            adjust_path = True
1590
 
        else:
1591
 
            adjust_path = False
1592
 
    if adjust_path:
1593
 
        parent_trans_id = trans_id_file_id(entry.parent_id)
1594
 
        tt.adjust_path(entry.name, parent_trans_id, e_trans_id)
1595
 
 
1596
 
 
1597
2552
def get_backup_name(entry, by_parent, parent_trans_id, tt):
1598
2553
    return _get_backup_name(entry.name, by_parent, parent_trans_id, tt)
1599
2554
 
1630
2585
        if entry.kind != working_kind:
1631
2586
            contents_mod, meta_mod = True, False
1632
2587
        else:
1633
 
            cur_entry._read_tree_state(working_tree.id2path(file_id), 
 
2588
            cur_entry._read_tree_state(working_tree.id2path(file_id),
1634
2589
                                       working_tree)
1635
2590
            contents_mod, meta_mod = entry.detect_changes(cur_entry)
1636
2591
            cur_entry._forget_tree_state()
1638
2593
 
1639
2594
 
1640
2595
def revert(working_tree, target_tree, filenames, backups=False,
1641
 
           pb=DummyProgress(), change_reporter=None):
 
2596
           pb=None, change_reporter=None):
1642
2597
    """Revert a working tree's contents to those of a target tree."""
1643
2598
    target_tree.lock_read()
 
2599
    pb = ui.ui_factory.nested_progress_bar()
1644
2600
    tt = TreeTransform(working_tree, pb)
1645
2601
    try:
1646
2602
        pp = ProgressPhase("Revert phase", 3, pb)
1647
 
        pp.next_phase()
1648
 
        child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1649
 
        try:
1650
 
            merge_modified = _alter_files(working_tree, target_tree, tt,
1651
 
                                          child_pb, filenames, backups)
1652
 
        finally:
1653
 
            child_pb.finished()
1654
 
        pp.next_phase()
1655
 
        child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1656
 
        try:
1657
 
            raw_conflicts = resolve_conflicts(tt, child_pb,
1658
 
                lambda t, c: conflict_pass(t, c, target_tree))
1659
 
        finally:
1660
 
            child_pb.finished()
1661
 
        conflicts = cook_conflicts(raw_conflicts, tt)
 
2603
        conflicts, merge_modified = _prepare_revert_transform(
 
2604
            working_tree, target_tree, tt, filenames, backups, pp)
1662
2605
        if change_reporter:
1663
2606
            change_reporter = delta._ChangeReporter(
1664
2607
                unversioned_filter=working_tree.is_ignored)
1665
 
            delta.report_changes(tt._iter_changes(), change_reporter)
 
2608
            delta.report_changes(tt.iter_changes(), change_reporter)
1666
2609
        for conflict in conflicts:
1667
2610
            warning(conflict)
1668
2611
        pp.next_phase()
1675
2618
    return conflicts
1676
2619
 
1677
2620
 
 
2621
def _prepare_revert_transform(working_tree, target_tree, tt, filenames,
 
2622
                              backups, pp, basis_tree=None,
 
2623
                              merge_modified=None):
 
2624
    child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
2625
    try:
 
2626
        if merge_modified is None:
 
2627
            merge_modified = working_tree.merge_modified()
 
2628
        merge_modified = _alter_files(working_tree, target_tree, tt,
 
2629
                                      child_pb, filenames, backups,
 
2630
                                      merge_modified, basis_tree)
 
2631
    finally:
 
2632
        child_pb.finished()
 
2633
    child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
2634
    try:
 
2635
        raw_conflicts = resolve_conflicts(tt, child_pb,
 
2636
            lambda t, c: conflict_pass(t, c, target_tree))
 
2637
    finally:
 
2638
        child_pb.finished()
 
2639
    conflicts = cook_conflicts(raw_conflicts, tt)
 
2640
    return conflicts, merge_modified
 
2641
 
 
2642
 
1678
2643
def _alter_files(working_tree, target_tree, tt, pb, specific_files,
1679
 
                 backups):
1680
 
    merge_modified = working_tree.merge_modified()
1681
 
    change_list = target_tree._iter_changes(working_tree,
 
2644
                 backups, merge_modified, basis_tree=None):
 
2645
    if basis_tree is not None:
 
2646
        basis_tree.lock_read()
 
2647
    change_list = target_tree.iter_changes(working_tree,
1682
2648
        specific_files=specific_files, pb=pb)
1683
 
    if target_tree.inventory.root is None:
 
2649
    if target_tree.get_root_id() is None:
1684
2650
        skip_root = True
1685
2651
    else:
1686
2652
        skip_root = False
1687
 
    basis_tree = None
1688
2653
    try:
1689
2654
        deferred_files = []
1690
2655
        for id_num, (file_id, path, changed_content, versioned, parent, name,
1726
2691
                        # contents
1727
2692
                        mode_id = trans_id
1728
2693
                        trans_id = new_trans_id
1729
 
                if kind[1] == 'directory':
 
2694
                if kind[1] in ('directory', 'tree-reference'):
1730
2695
                    tt.create_directory(trans_id)
 
2696
                    if kind[1] == 'tree-reference':
 
2697
                        revision = target_tree.get_reference_revision(file_id,
 
2698
                                                                      path[1])
 
2699
                        tt.set_tree_reference(revision, trans_id)
1731
2700
                elif kind[1] == 'symlink':
1732
2701
                    tt.create_symlink(target_tree.get_symlink_target(file_id),
1733
2702
                                      trans_id)
1747
2716
                    # preserve the execute bit when backing up
1748
2717
                    if keep_content and executable[0] == executable[1]:
1749
2718
                        tt.set_executability(executable[1], trans_id)
1750
 
                else:
1751
 
                    assert kind[1] is None
 
2719
                elif kind[1] is not None:
 
2720
                    raise AssertionError(kind[1])
1752
2721
            if versioned == (False, True):
1753
2722
                tt.version_file(file_id, trans_id)
1754
2723
            if versioned == (True, False):
1755
2724
                tt.unversion_file(trans_id)
1756
 
            if (name[1] is not None and 
 
2725
            if (name[1] is not None and
1757
2726
                (name[0] != name[1] or parent[0] != parent[1])):
1758
 
                tt.adjust_path(
1759
 
                    name[1], tt.trans_id_file_id(parent[1]), trans_id)
 
2727
                if name[1] == '' and parent[1] is None:
 
2728
                    parent_trans = ROOT_PARENT
 
2729
                else:
 
2730
                    parent_trans = tt.trans_id_file_id(parent[1])
 
2731
                if parent[0] is None and versioned[0]:
 
2732
                    tt.adjust_root_path(name[1], parent_trans)
 
2733
                else:
 
2734
                    tt.adjust_path(name[1], parent_trans, trans_id)
1760
2735
            if executable[0] != executable[1] and kind[1] == "file":
1761
2736
                tt.set_executability(executable[1], trans_id)
1762
 
        for (trans_id, mode_id), bytes in target_tree.iter_files_bytes(
1763
 
            deferred_files):
1764
 
            tt.create_file(bytes, trans_id, mode_id)
 
2737
        if working_tree.supports_content_filtering():
 
2738
            for index, ((trans_id, mode_id), bytes) in enumerate(
 
2739
                target_tree.iter_files_bytes(deferred_files)):
 
2740
                file_id = deferred_files[index][0]
 
2741
                # We're reverting a tree to the target tree so using the
 
2742
                # target tree to find the file path seems the best choice
 
2743
                # here IMO - Ian C 27/Oct/2009
 
2744
                filter_tree_path = target_tree.id2path(file_id)
 
2745
                filters = working_tree._content_filter_stack(filter_tree_path)
 
2746
                bytes = filtered_output_bytes(bytes, filters,
 
2747
                    ContentFilterContext(filter_tree_path, working_tree))
 
2748
                tt.create_file(bytes, trans_id, mode_id)
 
2749
        else:
 
2750
            for (trans_id, mode_id), bytes in target_tree.iter_files_bytes(
 
2751
                deferred_files):
 
2752
                tt.create_file(bytes, trans_id, mode_id)
 
2753
        tt.fixup_new_roots()
1765
2754
    finally:
1766
2755
        if basis_tree is not None:
1767
2756
            basis_tree.unlock()
1768
2757
    return merge_modified
1769
2758
 
1770
2759
 
1771
 
def resolve_conflicts(tt, pb=DummyProgress(), pass_func=None):
 
2760
def resolve_conflicts(tt, pb=None, pass_func=None):
1772
2761
    """Make many conflict-resolution attempts, but die if they fail"""
1773
2762
    if pass_func is None:
1774
2763
        pass_func = conflict_pass
1775
2764
    new_conflicts = set()
 
2765
    pb = ui.ui_factory.nested_progress_bar()
1776
2766
    try:
1777
2767
        for n in range(10):
1778
2768
            pb.update('Resolution pass', n+1, 10)
1782
2772
            new_conflicts.update(pass_func(tt, conflicts))
1783
2773
        raise MalformedTransform(conflicts=conflicts)
1784
2774
    finally:
1785
 
        pb.clear()
 
2775
        pb.finished()
1786
2776
 
1787
2777
 
1788
2778
def conflict_pass(tt, conflicts, path_tree=None):
1807
2797
                existing_file, new_file = conflict[1], conflict[2]
1808
2798
            new_name = tt.final_name(existing_file)+'.moved'
1809
2799
            tt.adjust_path(new_name, final_parent, existing_file)
1810
 
            new_conflicts.add((c_type, 'Moved existing file to', 
 
2800
            new_conflicts.add((c_type, 'Moved existing file to',
1811
2801
                               existing_file, new_file))
1812
2802
        elif c_type == 'parent loop':
1813
2803
            # break the loop by undoing one of the ops that caused the loop
1817
2807
            new_conflicts.add((c_type, 'Cancelled move', cur,
1818
2808
                               tt.final_parent(cur),))
1819
2809
            tt.adjust_path(tt.final_name(cur), tt.get_tree_parent(cur), cur)
1820
 
            
 
2810
 
1821
2811
        elif c_type == 'missing parent':
1822
2812
            trans_id = conflict[1]
1823
2813
            try:
1824
2814
                tt.cancel_deletion(trans_id)
1825
 
                new_conflicts.add(('deleting parent', 'Not deleting', 
 
2815
                new_conflicts.add(('deleting parent', 'Not deleting',
1826
2816
                                   trans_id))
1827
2817
            except KeyError:
1828
 
                tt.create_directory(trans_id)
1829
 
                new_conflicts.add((c_type, 'Created directory', trans_id))
 
2818
                create = True
1830
2819
                try:
1831
2820
                    tt.final_name(trans_id)
1832
2821
                except NoFinalPath:
1833
2822
                    if path_tree is not None:
1834
2823
                        file_id = tt.final_file_id(trans_id)
 
2824
                        if file_id is None:
 
2825
                            file_id = tt.inactive_file_id(trans_id)
1835
2826
                        entry = path_tree.inventory[file_id]
1836
 
                        parent_trans_id = tt.trans_id_file_id(entry.parent_id)
1837
 
                        tt.adjust_path(entry.name, parent_trans_id, trans_id)
 
2827
                        # special-case the other tree root (move its
 
2828
                        # children to current root)
 
2829
                        if entry.parent_id is None:
 
2830
                            create = False
 
2831
                            moved = _reparent_transform_children(
 
2832
                                tt, trans_id, tt.root)
 
2833
                            for child in moved:
 
2834
                                new_conflicts.add((c_type, 'Moved to root',
 
2835
                                                   child))
 
2836
                        else:
 
2837
                            parent_trans_id = tt.trans_id_file_id(
 
2838
                                entry.parent_id)
 
2839
                            tt.adjust_path(entry.name, parent_trans_id,
 
2840
                                           trans_id)
 
2841
                if create:
 
2842
                    tt.create_directory(trans_id)
 
2843
                    new_conflicts.add((c_type, 'Created directory', trans_id))
1838
2844
        elif c_type == 'unversioned parent':
1839
 
            tt.version_file(tt.inactive_file_id(conflict[1]), conflict[1])
 
2845
            file_id = tt.inactive_file_id(conflict[1])
 
2846
            # special-case the other tree root (move its children instead)
 
2847
            if path_tree and file_id in path_tree:
 
2848
                if path_tree.inventory[file_id].parent_id is None:
 
2849
                    continue
 
2850
            tt.version_file(file_id, conflict[1])
1840
2851
            new_conflicts.add((c_type, 'Versioned directory', conflict[1]))
 
2852
        elif c_type == 'non-directory parent':
 
2853
            parent_id = conflict[1]
 
2854
            parent_parent = tt.final_parent(parent_id)
 
2855
            parent_name = tt.final_name(parent_id)
 
2856
            parent_file_id = tt.final_file_id(parent_id)
 
2857
            new_parent_id = tt.new_directory(parent_name + '.new',
 
2858
                parent_parent, parent_file_id)
 
2859
            _reparent_transform_children(tt, parent_id, new_parent_id)
 
2860
            if parent_file_id is not None:
 
2861
                tt.unversion_file(parent_id)
 
2862
            new_conflicts.add((c_type, 'Created directory', new_parent_id))
 
2863
        elif c_type == 'versioning no contents':
 
2864
            tt.cancel_versioning(conflict[1])
1841
2865
    return new_conflicts
1842
2866
 
1843
2867
 
1859
2883
        if len(conflict) == 3:
1860
2884
            yield Conflict.factory(c_type, action=action, path=modified_path,
1861
2885
                                     file_id=modified_id)
1862
 
             
 
2886
 
1863
2887
        else:
1864
2888
            conflicting_path = fp.get_path(conflict[3])
1865
2889
            conflicting_id = tt.final_file_id(conflict[3])
1866
2890
            yield Conflict.factory(c_type, action=action, path=modified_path,
1867
 
                                   file_id=modified_id, 
 
2891
                                   file_id=modified_id,
1868
2892
                                   conflict_path=conflicting_path,
1869
2893
                                   conflict_file_id=conflicting_id)
1870
2894
 
1877
2901
        self.pending_deletions = []
1878
2902
 
1879
2903
    def rename(self, from_, to):
1880
 
        """Rename a file from one path to another.  Functions like os.rename"""
 
2904
        """Rename a file from one path to another."""
1881
2905
        try:
1882
 
            os.rename(from_, to)
 
2906
            osutils.rename(from_, to)
1883
2907
        except OSError, e:
1884
2908
            if e.errno in (errno.EEXIST, errno.ENOTEMPTY):
1885
2909
                raise errors.FileExists(to, str(e))
1899
2923
    def rollback(self):
1900
2924
        """Reverse all renames that have been performed"""
1901
2925
        for from_, to in reversed(self.past_renames):
1902
 
            os.rename(to, from_)
 
2926
            osutils.rename(to, from_)
1903
2927
        # after rollback, don't reuse _FileMover
1904
2928
        past_renames = None
1905
2929
        pending_deletions = None