← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/transform.py

  • Committer: Ian Clatworthy
  • Date: 2007-12-17 01:45:32 UTC
  • mto: (3119.1.1 ianc-integration)
  • mto: This revision was merged to the branch mainline in revision 3120.
  • Revision ID: ian.clatworthy@internode.on.net-20071217014532-dmbv2mm72nzq0ai6
follow-up tweaks to bzr.dev integration

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/transform.py
1
 
# Copyright (C) 2006-2010 Canonical Ltd
 
1
# Copyright (C) 2006, 2007 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
16
 
17
17
import os
18
18
import errno
19
 
from stat import S_ISREG, S_IEXEC
20
 
import time
 
19
from stat import S_ISREG
21
20
 
22
21
from bzrlib.lazy_import import lazy_import
23
22
lazy_import(globals(), """
24
23
from bzrlib import (
25
 
    annotate,
26
 
    bencode,
27
24
    bzrdir,
28
25
    delta,
29
26
    errors,
30
 
    inventory,
31
 
    multiparent,
32
 
    osutils,
33
 
    revision as _mod_revision,
34
 
    ui,
 
27
    inventory
35
28
    )
36
29
""")
37
30
from bzrlib.errors import (DuplicateKey, MalformedTransform, NoSuchFile,
38
 
                           ReusingTransform, CantMoveRoot,
 
31
                           ReusingTransform, NotVersionedError, CantMoveRoot,
39
32
                           ExistingLimbo, ImmortalLimbo, NoFinalPath,
40
33
                           UnableCreateSymlink)
41
 
from bzrlib.filters import filtered_output_bytes, ContentFilterContext
42
34
from bzrlib.inventory import InventoryEntry
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
 
35
from bzrlib.osutils import (file_kind, supports_executable, pathjoin, lexists,
 
36
                            delete_any, has_symlinks)
 
37
from bzrlib.progress import DummyProgress, ProgressPhase
54
38
from bzrlib.symbol_versioning import (
55
39
        deprecated_function,
56
 
        deprecated_in,
 
40
        zero_fifteen,
 
41
        zero_ninety,
57
42
        )
58
43
from bzrlib.trace import mutter, warning
59
44
from bzrlib import tree
77
62
        self.rename_count = rename_count
78
63
 
79
64
 
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.
 
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).
92
135
        """
93
136
        object.__init__(self)
94
137
        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)
95
161
        self._id_number = 0
96
162
        # mapping of trans_id -> new basename
97
163
        self._new_name = {}
99
165
        self._new_parent = {}
100
166
        # mapping of trans_id with new contents -> new file_kind
101
167
        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()
102
177
        # Set of trans_ids whose contents will be removed
103
178
        self._removed_contents = set()
104
179
        # Mapping of trans_id -> new execute-bit value
111
186
        self._non_present_ids = {}
112
187
        # Mapping of new file_id -> trans_id
113
188
        self._r_new_id = {}
114
 
        # Set of trans_ids that will be removed
 
189
        # Set of file_ids that will be removed
115
190
        self._removed_id = set()
116
191
        # Mapping of path in old tree -> trans_id
117
192
        self._tree_path_ids = {}
118
193
        # Mapping trans_id -> path in old tree
119
194
        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 = {}
120
199
        # The trans_id that will be used as the tree root
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
 
200
        self._new_root = self.trans_id_tree_file_id(tree.get_root_id())
126
201
        # Indictor of whether the transform has been applied
127
 
        self._done = False
 
202
        self.__done = False
128
203
        # A progress bar
129
204
        self._pb = pb
130
 
        # Whether the target is case sensitive
131
 
        self._case_sensitive_target = case_sensitive
132
205
        # A counter of how many files have been renamed
133
206
        self.rename_count = 0
134
207
 
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
 
 
146
208
    def __get_root(self):
147
209
        return self._new_root
148
210
 
149
211
    root = property(__get_root)
150
212
 
 
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
 
151
243
    def _assign_id(self):
152
244
        """Produce a new tranform id"""
153
245
        new_id = "new-%s" % self._id_number
163
255
 
164
256
    def adjust_path(self, name, parent, trans_id):
165
257
        """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")
168
258
        if trans_id == self._new_root:
169
259
            raise CantMoveRoot
 
260
        previous_parent = self._new_parent.get(trans_id)
 
261
        previous_name = self._new_name.get(trans_id)
170
262
        self._new_name[trans_id] = name
171
263
        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)
172
287
 
173
288
    def adjust_root_path(self, name, parent):
174
289
        """Emulate moving the root by moving all children, instead.
175
 
 
 
290
        
176
291
        We do this by undoing the association of root's transaction id with the
177
292
        current tree.  This allows us to create a new directory with that
178
 
        transaction id.  We unversion the root directory and version the
 
293
        transaction id.  We unversion the root directory and version the 
179
294
        physically new directory, and hope someone versions the tree root
180
295
        later.
181
296
        """
184
299
        # force moving all children of root
185
300
        for child_id in self.iter_tree_children(old_root):
186
301
            if child_id != parent:
187
 
                self.adjust_path(self.final_name(child_id),
 
302
                self.adjust_path(self.final_name(child_id), 
188
303
                                 self.final_parent(child_id), child_id)
189
304
            file_id = self.final_file_id(child_id)
190
305
            if file_id is not None:
191
306
                self.unversion_file(child_id)
192
307
            self.version_file(file_id, child_id)
193
 
 
 
308
        
194
309
        # the physical root needs a new transaction id
195
310
        self._tree_path_ids.pop("")
196
311
        self._tree_id_paths.pop(old_root)
202
317
        self.version_file(old_root_file_id, old_root)
203
318
        self.unversion_file(self._new_root)
204
319
 
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
 
 
266
320
    def trans_id_tree_file_id(self, inventory_id):
267
321
        """Determine the transaction id of a working tree file.
268
 
 
 
322
        
269
323
        This reflects only files that already exist, not ones that will be
270
324
        added by transactions.
271
325
        """
272
 
        if inventory_id is None:
273
 
            raise ValueError('None is not a valid file id')
274
 
        path = self._tree.id2path(inventory_id)
 
326
        path = self._tree.inventory.id2path(inventory_id)
275
327
        return self.trans_id_tree_path(path)
276
328
 
277
329
    def trans_id_file_id(self, file_id):
280
332
        a transaction has been unversioned, it is deliberately still returned.
281
333
        (this will likely lead to an unversioned parent conflict.)
282
334
        """
283
 
        if file_id is None:
284
 
            raise ValueError('None is not a valid file id')
285
335
        if file_id in self._r_new_id and self._r_new_id[file_id] is not None:
286
336
            return self._r_new_id[file_id]
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)
 
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
299
364
 
300
365
    def trans_id_tree_path(self, path):
301
366
        """Determine (and maybe set) the transaction ID for a tree path."""
312
377
            return ROOT_PARENT
313
378
        return self.trans_id_tree_path(os.path.dirname(path))
314
379
 
 
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
 
315
466
    def delete_contents(self, trans_id):
316
467
        """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
319
468
        self.tree_kind(trans_id)
320
469
        self._removed_contents.add(trans_id)
321
470
 
347
496
 
348
497
    def version_file(self, file_id, trans_id):
349
498
        """Schedule a file to become versioned."""
350
 
        if file_id is None:
351
 
            raise ValueError()
 
499
        assert file_id is not None
352
500
        unique_add(self._new_id, trans_id, file_id)
353
501
        unique_add(self._r_new_id, file_id, trans_id)
354
502
 
358
506
        del self._new_id[trans_id]
359
507
        del self._r_new_id[file_id]
360
508
 
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.
 
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
366
524
        """
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))
 
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)
395
535
 
396
536
    def final_kind(self, trans_id):
397
537
        """Determine the final file kind, after any changes applied.
398
 
 
 
538
        
399
539
        Raises NoSuchFile if the file does not exist/has no contents.
400
540
        (It is conceivable that a path would be created without the
401
541
        corresponding contents insertion command)
417
557
        # the file is old; the old id is still valid
418
558
        if self._new_root == trans_id:
419
559
            return self._tree.get_root_id()
420
 
        return self._tree.path2id(path)
 
560
        return self._tree.inventory.path2id(path)
421
561
 
422
562
    def final_file_id(self, trans_id):
423
563
        """Determine the file id after any changes are applied, or None.
424
 
 
 
564
        
425
565
        None indicates that the file will not be versioned after changes are
426
566
        applied.
427
567
        """
428
568
        try:
 
569
            # there is a new id for this file
 
570
            assert self._new_id[trans_id] is not None
429
571
            return self._new_id[trans_id]
430
572
        except KeyError:
431
573
            if trans_id in self._removed_id:
466
608
 
467
609
    def by_parent(self):
468
610
        """Return a map of parent: children for known parents.
469
 
 
 
611
        
470
612
        Only new paths and parents of tree files with assigned ids are used.
471
613
        """
472
614
        by_parent = {}
473
615
        items = list(self._new_parent.iteritems())
474
 
        items.extend((t, self.final_parent(t)) for t in
 
616
        items.extend((t, self.final_parent(t)) for t in 
475
617
                      self._tree_id_paths.keys())
476
618
        for trans_id, parent_id in items:
477
619
            if parent_id not in by_parent:
488
630
 
489
631
    def find_conflicts(self):
490
632
        """Find any violations of inventory or filesystem invariants"""
491
 
        if self._done is True:
 
633
        if self.__done is True:
492
634
            raise ReusingTransform()
493
635
        conflicts = []
494
636
        # ensure all children of all existent parents are known
505
647
        conflicts.extend(self._overwrite_conflicts())
506
648
        return conflicts
507
649
 
508
 
    def _check_malformed(self):
509
 
        conflicts = self.find_conflicts()
510
 
        if len(conflicts) != 0:
511
 
            raise MalformedTransform(conflicts=conflicts)
512
 
 
513
650
    def _add_tree_children(self):
514
651
        """Add all the children of all active parents to the known paths.
515
652
 
517
654
        removed.  This is a necessary first step in detecting conflicts.
518
655
        """
519
656
        parents = self.by_parent().keys()
520
 
        parents.extend([t for t in self._removed_contents if
 
657
        parents.extend([t for t in self._removed_contents if 
521
658
                        self.tree_kind(t) == 'directory'])
522
659
        for trans_id in self._removed_id:
523
660
            file_id = self.tree_file_id(trans_id)
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':
 
661
            if self._tree.inventory[file_id].kind == 'directory':
528
662
                parents.append(trans_id)
529
663
 
530
664
        for parent_id in parents:
531
665
            # ensure that all children are registered with the transaction
532
666
            list(self.iter_tree_children(parent_id))
533
667
 
 
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
 
534
687
    def has_named_child(self, by_parent, parent_id, name):
535
688
        try:
536
689
            children = by_parent[parent_id]
590
743
 
591
744
    def _improper_versioning(self):
592
745
        """Cannot version a file with no contents, or a bad type.
593
 
 
 
746
        
594
747
        However, existing entries with no contents are okay.
595
748
        """
596
749
        conflicts = []
606
759
 
607
760
    def _executability_conflicts(self):
608
761
        """Check for bad executability changes.
609
 
 
 
762
        
610
763
        Only versioned files may have their executability set, because
611
764
        1. only versioned entries can have executability under windows
612
765
        2. only files can be executable.  (The execute bit on a directory
645
798
            return conflicts
646
799
        for children in by_parent.itervalues():
647
800
            name_ids = [(self.final_name(t), t) for t in children]
648
 
            if not self._case_sensitive_target:
 
801
            if not self._tree.case_sensitive:
649
802
                name_ids = [(n.lower(), t) for n, t in name_ids]
650
803
            name_ids.sort()
651
804
            last_name = None
670
823
        conflicts = []
671
824
        removed_tree_ids = set((self.tree_file_id(trans_id) for trans_id in
672
825
                                self._removed_id))
673
 
        all_ids = self._tree.all_file_ids()
674
 
        active_tree_ids = all_ids.difference(removed_tree_ids)
 
826
        active_tree_ids = set((f for f in self._tree.inventory if
 
827
                               f not in removed_tree_ids))
675
828
        for trans_id, file_id in self._new_id.iteritems():
676
829
            if file_id in active_tree_ids:
677
830
                old_trans_id = self.trans_id_tree_file_id(file_id)
710
863
                continue
711
864
            return True
712
865
        return False
713
 
 
714
 
    def _set_executability(self, path, trans_id):
 
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
        completed_new = []
 
1001
        try:
 
1002
            for num, (path, trans_id) in enumerate(new_paths):
 
1003
                new_entry = None
 
1004
                child_pb.update('adding file', num, len(new_paths))
 
1005
                try:
 
1006
                    kind = self._new_contents[trans_id]
 
1007
                except KeyError:
 
1008
                    kind = contents = None
 
1009
                if trans_id in self._new_contents or \
 
1010
                    self.path_changed(trans_id):
 
1011
                    full_path = self._tree.abspath(path)
 
1012
                    if trans_id in self._needs_rename:
 
1013
                        try:
 
1014
                            mover.rename(self._limbo_name(trans_id), full_path)
 
1015
                        except OSError, e:
 
1016
                            # We may be renaming a dangling inventory id
 
1017
                            if e.errno != errno.ENOENT:
 
1018
                                raise
 
1019
                        else:
 
1020
                            self.rename_count += 1
 
1021
                    if trans_id in self._new_contents:
 
1022
                        modified_paths.append(full_path)
 
1023
                        completed_new.append(trans_id)
 
1024
 
 
1025
                if trans_id in self._new_id:
 
1026
                    if kind is None:
 
1027
                        kind = file_kind(self._tree.abspath(path))
 
1028
                    if trans_id in self._new_reference_revision:
 
1029
                        new_entry = inventory.TreeReference(
 
1030
                            self._new_id[trans_id],
 
1031
                            self._new_name[trans_id], 
 
1032
                            self.final_file_id(self._new_parent[trans_id]),
 
1033
                            None, self._new_reference_revision[trans_id])
 
1034
                    else:
 
1035
                        new_entry = inventory.make_entry(kind,
 
1036
                            self.final_name(trans_id),
 
1037
                            self.final_file_id(self.final_parent(trans_id)),
 
1038
                            self._new_id[trans_id])
 
1039
                else:
 
1040
                    if trans_id in self._new_name or trans_id in\
 
1041
                        self._new_parent or\
 
1042
                        trans_id in self._new_executability:
 
1043
                        file_id = self.final_file_id(trans_id)
 
1044
                        if file_id is not None:
 
1045
                            entry = inv[file_id]
 
1046
                            new_entry = entry.copy()
 
1047
 
 
1048
                    if trans_id in self._new_name or trans_id in\
 
1049
                        self._new_parent:
 
1050
                            if new_entry is not None:
 
1051
                                new_entry.name = self.final_name(trans_id)
 
1052
                                parent = self.final_parent(trans_id)
 
1053
                                parent_id = self.final_file_id(parent)
 
1054
                                new_entry.parent_id = parent_id
 
1055
 
 
1056
                if trans_id in self._new_executability:
 
1057
                    self._set_executability(path, new_entry, trans_id)
 
1058
                if new_entry is not None:
 
1059
                    if new_entry.file_id in inv:
 
1060
                        old_path = inv.id2path(new_entry.file_id)
 
1061
                    else:
 
1062
                        old_path = None
 
1063
                    inventory_delta.append((old_path, path,
 
1064
                                            new_entry.file_id,
 
1065
                                            new_entry))
 
1066
        finally:
 
1067
            child_pb.finished()
 
1068
        for trans_id in completed_new:
 
1069
            del self._new_contents[trans_id]
 
1070
        return modified_paths
 
1071
 
 
1072
    def _set_executability(self, path, entry, trans_id):
715
1073
        """Set the executability of versioned files """
 
1074
        new_executability = self._new_executability[trans_id]
 
1075
        entry.executable = new_executability
716
1076
        if supports_executable():
717
 
            new_executability = self._new_executability[trans_id]
718
1077
            abspath = self._tree.abspath(path)
719
1078
            current_mode = os.stat(abspath).st_mode
720
1079
            if new_executability:
737
1096
            self.version_file(file_id, trans_id)
738
1097
        return trans_id
739
1098
 
740
 
    def new_file(self, name, parent_id, contents, file_id=None,
 
1099
    def new_file(self, name, parent_id, contents, file_id=None, 
741
1100
                 executable=None):
742
1101
        """Convenience method to create files.
743
 
 
 
1102
        
744
1103
        name is the name of the file to create.
745
1104
        parent_id is the transaction id of the parent directory of the file.
746
1105
        contents is an iterator of bytestrings, which will be used to produce
766
1125
        """
767
1126
        trans_id = self._new_entry(name, parent_id, file_id)
768
1127
        self.create_directory(trans_id)
769
 
        return trans_id
 
1128
        return trans_id 
770
1129
 
771
1130
    def new_symlink(self, name, parent_id, target, file_id=None):
772
1131
        """Convenience method to create symbolic link.
773
 
 
 
1132
        
774
1133
        name is the name of the symlink to create.
775
1134
        parent_id is the transaction id of the parent directory of the symlink.
776
1135
        target is a bytestring of the target of the symlink.
815
1174
        from_path = self._tree_id_paths.get(from_trans_id)
816
1175
        if from_versioned:
817
1176
            # get data from working tree if versioned
818
 
            from_entry = self._tree.iter_entries_by_dir([file_id]).next()[1]
 
1177
            from_entry = self._tree.inventory[file_id]
819
1178
            from_name = from_entry.name
820
1179
            from_parent = from_entry.parent_id
821
1180
        else:
857
1216
            to_executable = False
858
1217
        return to_name, to_parent, to_kind, to_executable
859
1218
 
860
 
    def iter_changes(self):
861
 
        """Produce output in the same format as Tree.iter_changes.
 
1219
    def _iter_changes(self):
 
1220
        """Produce output in the same format as Tree._iter_changes.
862
1221
 
863
1222
        Will produce nonsensical results if invoked while inventory/filesystem
864
1223
        conflicts (as reported by TreeTransform.find_conflicts()) are present.
919
1278
                   (from_executable, to_executable)))
920
1279
        return iter(sorted(results, key=lambda x:x[1]))
921
1280
 
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 lock_read(self):
1802
 
        # Perhaps in theory, this should lock the TreeTransform?
1803
 
        pass
1804
 
 
1805
 
    def unlock(self):
1806
 
        pass
1807
 
 
1808
 
    @property
1809
 
    def inventory(self):
1810
 
        """This Tree does not use inventory as its backing data."""
1811
 
        raise NotImplementedError(_PreviewTree.inventory)
1812
 
 
1813
 
    def get_root_id(self):
1814
 
        return self._transform.final_file_id(self._transform.root)
1815
 
 
1816
 
    def all_file_ids(self):
1817
 
        tree_ids = set(self._transform._tree.all_file_ids())
1818
 
        tree_ids.difference_update(self._transform.tree_file_id(t)
1819
 
                                   for t in self._transform._removed_id)
1820
 
        tree_ids.update(self._transform._new_id.values())
1821
 
        return tree_ids
1822
 
 
1823
 
    def __iter__(self):
1824
 
        return iter(self.all_file_ids())
1825
 
 
1826
 
    def _has_id(self, file_id, fallback_check):
1827
 
        if file_id in self._transform._r_new_id:
1828
 
            return True
1829
 
        elif file_id in set([self._transform.tree_file_id(trans_id) for
1830
 
            trans_id in self._transform._removed_id]):
1831
 
            return False
1832
 
        else:
1833
 
            return fallback_check(file_id)
1834
 
 
1835
 
    def has_id(self, file_id):
1836
 
        return self._has_id(file_id, self._transform._tree.has_id)
1837
 
 
1838
 
    def has_or_had_id(self, file_id):
1839
 
        return self._has_id(file_id, self._transform._tree.has_or_had_id)
1840
 
 
1841
 
    def _path2trans_id(self, path):
1842
 
        # We must not use None here, because that is a valid value to store.
1843
 
        trans_id = self._path2trans_id_cache.get(path, object)
1844
 
        if trans_id is not object:
1845
 
            return trans_id
1846
 
        segments = splitpath(path)
1847
 
        cur_parent = self._transform.root
1848
 
        for cur_segment in segments:
1849
 
            for child in self._all_children(cur_parent):
1850
 
                final_name = self._final_name_cache.get(child)
1851
 
                if final_name is None:
1852
 
                    final_name = self._transform.final_name(child)
1853
 
                    self._final_name_cache[child] = final_name
1854
 
                if final_name == cur_segment:
1855
 
                    cur_parent = child
1856
 
                    break
1857
 
            else:
1858
 
                self._path2trans_id_cache[path] = None
1859
 
                return None
1860
 
        self._path2trans_id_cache[path] = cur_parent
1861
 
        return cur_parent
1862
 
 
1863
 
    def path2id(self, path):
1864
 
        return self._transform.final_file_id(self._path2trans_id(path))
1865
 
 
1866
 
    def id2path(self, file_id):
1867
 
        trans_id = self._transform.trans_id_file_id(file_id)
1868
 
        try:
1869
 
            return self._final_paths._determine_path(trans_id)
1870
 
        except NoFinalPath:
1871
 
            raise errors.NoSuchId(self, file_id)
1872
 
 
1873
 
    def _all_children(self, trans_id):
1874
 
        children = self._all_children_cache.get(trans_id)
1875
 
        if children is not None:
1876
 
            return children
1877
 
        children = set(self._transform.iter_tree_children(trans_id))
1878
 
        # children in the _new_parent set are provided by _by_parent.
1879
 
        children.difference_update(self._transform._new_parent.keys())
1880
 
        children.update(self._by_parent.get(trans_id, []))
1881
 
        self._all_children_cache[trans_id] = children
1882
 
        return children
1883
 
 
1884
 
    def iter_children(self, file_id):
1885
 
        trans_id = self._transform.trans_id_file_id(file_id)
1886
 
        for child_trans_id in self._all_children(trans_id):
1887
 
            yield self._transform.final_file_id(child_trans_id)
1888
 
 
1889
 
    def extras(self):
1890
 
        possible_extras = set(self._transform.trans_id_tree_path(p) for p
1891
 
                              in self._transform._tree.extras())
1892
 
        possible_extras.update(self._transform._new_contents)
1893
 
        possible_extras.update(self._transform._removed_id)
1894
 
        for trans_id in possible_extras:
1895
 
            if self._transform.final_file_id(trans_id) is None:
1896
 
                yield self._final_paths._determine_path(trans_id)
1897
 
 
1898
 
    def _make_inv_entries(self, ordered_entries, specific_file_ids=None,
1899
 
        yield_parents=False):
1900
 
        for trans_id, parent_file_id in ordered_entries:
1901
 
            file_id = self._transform.final_file_id(trans_id)
1902
 
            if file_id is None:
1903
 
                continue
1904
 
            if (specific_file_ids is not None
1905
 
                and file_id not in specific_file_ids):
1906
 
                continue
1907
 
            try:
1908
 
                kind = self._transform.final_kind(trans_id)
1909
 
            except NoSuchFile:
1910
 
                kind = self._transform._tree.stored_kind(file_id)
1911
 
            new_entry = inventory.make_entry(
1912
 
                kind,
1913
 
                self._transform.final_name(trans_id),
1914
 
                parent_file_id, file_id)
1915
 
            yield new_entry, trans_id
1916
 
 
1917
 
    def _list_files_by_dir(self):
1918
 
        todo = [ROOT_PARENT]
1919
 
        ordered_ids = []
1920
 
        while len(todo) > 0:
1921
 
            parent = todo.pop()
1922
 
            parent_file_id = self._transform.final_file_id(parent)
1923
 
            children = list(self._all_children(parent))
1924
 
            paths = dict(zip(children, self._final_paths.get_paths(children)))
1925
 
            children.sort(key=paths.get)
1926
 
            todo.extend(reversed(children))
1927
 
            for trans_id in children:
1928
 
                ordered_ids.append((trans_id, parent_file_id))
1929
 
        return ordered_ids
1930
 
 
1931
 
    def iter_entries_by_dir(self, specific_file_ids=None, yield_parents=False):
1932
 
        # This may not be a maximally efficient implementation, but it is
1933
 
        # reasonably straightforward.  An implementation that grafts the
1934
 
        # TreeTransform changes onto the tree's iter_entries_by_dir results
1935
 
        # might be more efficient, but requires tricky inferences about stack
1936
 
        # position.
1937
 
        ordered_ids = self._list_files_by_dir()
1938
 
        for entry, trans_id in self._make_inv_entries(ordered_ids,
1939
 
            specific_file_ids, yield_parents=yield_parents):
1940
 
            yield unicode(self._final_paths.get_path(trans_id)), entry
1941
 
 
1942
 
    def _iter_entries_for_dir(self, dir_path):
1943
 
        """Return path, entry for items in a directory without recursing down."""
1944
 
        dir_file_id = self.path2id(dir_path)
1945
 
        ordered_ids = []
1946
 
        for file_id in self.iter_children(dir_file_id):
1947
 
            trans_id = self._transform.trans_id_file_id(file_id)
1948
 
            ordered_ids.append((trans_id, file_id))
1949
 
        for entry, trans_id in self._make_inv_entries(ordered_ids):
1950
 
            yield unicode(self._final_paths.get_path(trans_id)), entry
1951
 
 
1952
 
    def list_files(self, include_root=False, from_dir=None, recursive=True):
1953
 
        """See WorkingTree.list_files."""
1954
 
        # XXX This should behave like WorkingTree.list_files, but is really
1955
 
        # more like RevisionTree.list_files.
1956
 
        if recursive:
1957
 
            prefix = None
1958
 
            if from_dir:
1959
 
                prefix = from_dir + '/'
1960
 
            entries = self.iter_entries_by_dir()
1961
 
            for path, entry in entries:
1962
 
                if entry.name == '' and not include_root:
1963
 
                    continue
1964
 
                if prefix:
1965
 
                    if not path.startswith(prefix):
1966
 
                        continue
1967
 
                    path = path[len(prefix):]
1968
 
                yield path, 'V', entry.kind, entry.file_id, entry
1969
 
        else:
1970
 
            if from_dir is None and include_root is True:
1971
 
                root_entry = inventory.make_entry('directory', '',
1972
 
                    ROOT_PARENT, self.get_root_id())
1973
 
                yield '', 'V', 'directory', root_entry.file_id, root_entry
1974
 
            entries = self._iter_entries_for_dir(from_dir or '')
1975
 
            for path, entry in entries:
1976
 
                yield path, 'V', entry.kind, entry.file_id, entry
1977
 
 
1978
 
    def kind(self, file_id):
1979
 
        trans_id = self._transform.trans_id_file_id(file_id)
1980
 
        return self._transform.final_kind(trans_id)
1981
 
 
1982
 
    def stored_kind(self, file_id):
1983
 
        trans_id = self._transform.trans_id_file_id(file_id)
1984
 
        try:
1985
 
            return self._transform._new_contents[trans_id]
1986
 
        except KeyError:
1987
 
            return self._transform._tree.stored_kind(file_id)
1988
 
 
1989
 
    def get_file_mtime(self, file_id, path=None):
1990
 
        """See Tree.get_file_mtime"""
1991
 
        if not self._content_change(file_id):
1992
 
            return self._transform._tree.get_file_mtime(file_id)
1993
 
        return self._stat_limbo_file(file_id).st_mtime
1994
 
 
1995
 
    def _file_size(self, entry, stat_value):
1996
 
        return self.get_file_size(entry.file_id)
1997
 
 
1998
 
    def get_file_size(self, file_id):
1999
 
        """See Tree.get_file_size"""
2000
 
        if self.kind(file_id) == 'file':
2001
 
            return self._transform._tree.get_file_size(file_id)
2002
 
        else:
2003
 
            return None
2004
 
 
2005
 
    def get_file_sha1(self, file_id, path=None, stat_value=None):
2006
 
        trans_id = self._transform.trans_id_file_id(file_id)
2007
 
        kind = self._transform._new_contents.get(trans_id)
2008
 
        if kind is None:
2009
 
            return self._transform._tree.get_file_sha1(file_id)
2010
 
        if kind == 'file':
2011
 
            fileobj = self.get_file(file_id)
2012
 
            try:
2013
 
                return sha_file(fileobj)
2014
 
            finally:
2015
 
                fileobj.close()
2016
 
 
2017
 
    def is_executable(self, file_id, path=None):
2018
 
        if file_id is None:
2019
 
            return False
2020
 
        trans_id = self._transform.trans_id_file_id(file_id)
2021
 
        try:
2022
 
            return self._transform._new_executability[trans_id]
2023
 
        except KeyError:
2024
 
            try:
2025
 
                return self._transform._tree.is_executable(file_id, path)
2026
 
            except OSError, e:
2027
 
                if e.errno == errno.ENOENT:
2028
 
                    return False
2029
 
                raise
2030
 
            except errors.NoSuchId:
2031
 
                return False
2032
 
 
2033
 
    def path_content_summary(self, path):
2034
 
        trans_id = self._path2trans_id(path)
2035
 
        tt = self._transform
2036
 
        tree_path = tt._tree_id_paths.get(trans_id)
2037
 
        kind = tt._new_contents.get(trans_id)
2038
 
        if kind is None:
2039
 
            if tree_path is None or trans_id in tt._removed_contents:
2040
 
                return 'missing', None, None, None
2041
 
            summary = tt._tree.path_content_summary(tree_path)
2042
 
            kind, size, executable, link_or_sha1 = summary
2043
 
        else:
2044
 
            link_or_sha1 = None
2045
 
            limbo_name = tt._limbo_name(trans_id)
2046
 
            if trans_id in tt._new_reference_revision:
2047
 
                kind = 'tree-reference'
2048
 
            if kind == 'file':
2049
 
                statval = os.lstat(limbo_name)
2050
 
                size = statval.st_size
2051
 
                if not supports_executable():
2052
 
                    executable = False
2053
 
                else:
2054
 
                    executable = statval.st_mode & S_IEXEC
2055
 
            else:
2056
 
                size = None
2057
 
                executable = None
2058
 
            if kind == 'symlink':
2059
 
                link_or_sha1 = os.readlink(limbo_name).decode(osutils._fs_enc)
2060
 
        executable = tt._new_executability.get(trans_id, executable)
2061
 
        return kind, size, executable, link_or_sha1
2062
 
 
2063
 
    def iter_changes(self, from_tree, include_unchanged=False,
2064
 
                      specific_files=None, pb=None, extra_trees=None,
2065
 
                      require_versioned=True, want_unversioned=False):
2066
 
        """See InterTree.iter_changes.
2067
 
 
2068
 
        This has a fast path that is only used when the from_tree matches
2069
 
        the transform tree, and no fancy options are supplied.
2070
 
        """
2071
 
        if (from_tree is not self._transform._tree or include_unchanged or
2072
 
            specific_files or want_unversioned):
2073
 
            return tree.InterTree(from_tree, self).iter_changes(
2074
 
                include_unchanged=include_unchanged,
2075
 
                specific_files=specific_files,
2076
 
                pb=pb,
2077
 
                extra_trees=extra_trees,
2078
 
                require_versioned=require_versioned,
2079
 
                want_unversioned=want_unversioned)
2080
 
        if want_unversioned:
2081
 
            raise ValueError('want_unversioned is not supported')
2082
 
        return self._transform.iter_changes()
2083
 
 
2084
 
    def get_file(self, file_id, path=None):
2085
 
        """See Tree.get_file"""
2086
 
        if not self._content_change(file_id):
2087
 
            return self._transform._tree.get_file(file_id, path)
2088
 
        trans_id = self._transform.trans_id_file_id(file_id)
2089
 
        name = self._transform._limbo_name(trans_id)
2090
 
        return open(name, 'rb')
2091
 
 
2092
 
    def get_file_with_stat(self, file_id, path=None):
2093
 
        return self.get_file(file_id, path), None
2094
 
 
2095
 
    def annotate_iter(self, file_id,
2096
 
                      default_revision=_mod_revision.CURRENT_REVISION):
2097
 
        changes = self._iter_changes_cache.get(file_id)
2098
 
        if changes is None:
2099
 
            get_old = True
2100
 
        else:
2101
 
            changed_content, versioned, kind = (changes[2], changes[3],
2102
 
                                                changes[6])
2103
 
            if kind[1] is None:
2104
 
                return None
2105
 
            get_old = (kind[0] == 'file' and versioned[0])
2106
 
        if get_old:
2107
 
            old_annotation = self._transform._tree.annotate_iter(file_id,
2108
 
                default_revision=default_revision)
2109
 
        else:
2110
 
            old_annotation = []
2111
 
        if changes is None:
2112
 
            return old_annotation
2113
 
        if not changed_content:
2114
 
            return old_annotation
2115
 
        # TODO: This is doing something similar to what WT.annotate_iter is
2116
 
        #       doing, however it fails slightly because it doesn't know what
2117
 
        #       the *other* revision_id is, so it doesn't know how to give the
2118
 
        #       other as the origin for some lines, they all get
2119
 
        #       'default_revision'
2120
 
        #       It would be nice to be able to use the new Annotator based
2121
 
        #       approach, as well.
2122
 
        return annotate.reannotate([old_annotation],
2123
 
                                   self.get_file(file_id).readlines(),
2124
 
                                   default_revision)
2125
 
 
2126
 
    def get_symlink_target(self, file_id):
2127
 
        """See Tree.get_symlink_target"""
2128
 
        if not self._content_change(file_id):
2129
 
            return self._transform._tree.get_symlink_target(file_id)
2130
 
        trans_id = self._transform.trans_id_file_id(file_id)
2131
 
        name = self._transform._limbo_name(trans_id)
2132
 
        return osutils.readlink(name)
2133
 
 
2134
 
    def walkdirs(self, prefix=''):
2135
 
        pending = [self._transform.root]
2136
 
        while len(pending) > 0:
2137
 
            parent_id = pending.pop()
2138
 
            children = []
2139
 
            subdirs = []
2140
 
            prefix = prefix.rstrip('/')
2141
 
            parent_path = self._final_paths.get_path(parent_id)
2142
 
            parent_file_id = self._transform.final_file_id(parent_id)
2143
 
            for child_id in self._all_children(parent_id):
2144
 
                path_from_root = self._final_paths.get_path(child_id)
2145
 
                basename = self._transform.final_name(child_id)
2146
 
                file_id = self._transform.final_file_id(child_id)
2147
 
                try:
2148
 
                    kind = self._transform.final_kind(child_id)
2149
 
                    versioned_kind = kind
2150
 
                except NoSuchFile:
2151
 
                    kind = 'unknown'
2152
 
                    versioned_kind = self._transform._tree.stored_kind(file_id)
2153
 
                if versioned_kind == 'directory':
2154
 
                    subdirs.append(child_id)
2155
 
                children.append((path_from_root, basename, kind, None,
2156
 
                                 file_id, versioned_kind))
2157
 
            children.sort()
2158
 
            if parent_path.startswith(prefix):
2159
 
                yield (parent_path, parent_file_id), children
2160
 
            pending.extend(sorted(subdirs, key=self._final_paths.get_path,
2161
 
                                  reverse=True))
2162
 
 
2163
 
    def get_parent_ids(self):
2164
 
        return self._parent_ids
2165
 
 
2166
 
    def set_parent_ids(self, parent_ids):
2167
 
        self._parent_ids = parent_ids
2168
 
 
2169
 
    def get_revision_tree(self, revision_id):
2170
 
        return self._transform._tree.get_revision_tree(revision_id)
2171
 
 
2172
1281
 
2173
1282
def joinpath(parent, child):
2174
1283
    """Join tree-relative paths, handling the tree root specially"""
2190
1299
        self.transform = transform
2191
1300
 
2192
1301
    def _determine_path(self, trans_id):
2193
 
        if (trans_id == self.transform.root or trans_id == ROOT_PARENT):
 
1302
        if trans_id == self.transform.root:
2194
1303
            return ""
2195
1304
        name = self.transform.final_name(trans_id)
2196
1305
        parent_id = self.transform.final_parent(trans_id)
2205
1314
            self._known_paths[trans_id] = self._determine_path(trans_id)
2206
1315
        return self._known_paths[trans_id]
2207
1316
 
2208
 
    def get_paths(self, trans_ids):
2209
 
        return [(self.get_path(t), t) for t in trans_ids]
2210
 
 
2211
 
 
2212
1317
 
2213
1318
def topology_sorted_ids(tree):
2214
1319
    """Determine the topological order of the ids in a tree"""
2217
1322
    return file_ids
2218
1323
 
2219
1324
 
2220
 
def build_tree(tree, wt, accelerator_tree=None, hardlink=False,
2221
 
               delta_from_tree=False):
 
1325
def build_tree(tree, wt):
2222
1326
    """Create working tree for a branch, using a TreeTransform.
2223
 
 
 
1327
    
2224
1328
    This function should be used on empty trees, having a tree root at most.
2225
1329
    (see merge and revert functionality for working with existing trees)
2226
1330
 
2227
1331
    Existing files are handled like so:
2228
 
 
 
1332
    
2229
1333
    - Existing bzrdirs take precedence over creating new items.  They are
2230
1334
      created as '%s.diverted' % name.
2231
1335
    - Otherwise, if the content on disk matches the content we are building,
2232
1336
      it is silently replaced.
2233
1337
    - Otherwise, conflict resolution will move the old file to 'oldname.moved'.
2234
 
 
2235
 
    :param tree: The tree to convert wt into a copy of
2236
 
    :param wt: The working tree that files will be placed into
2237
 
    :param accelerator_tree: A tree which can be used for retrieving file
2238
 
        contents more quickly than tree itself, i.e. a workingtree.  tree
2239
 
        will be used for cases where accelerator_tree's content is different.
2240
 
    :param hardlink: If true, hard-link files to accelerator_tree, where
2241
 
        possible.  accelerator_tree must implement abspath, i.e. be a
2242
 
        working tree.
2243
 
    :param delta_from_tree: If true, build_tree may use the input Tree to
2244
 
        generate the inventory delta.
2245
1338
    """
2246
1339
    wt.lock_tree_write()
2247
1340
    try:
2248
1341
        tree.lock_read()
2249
1342
        try:
2250
 
            if accelerator_tree is not None:
2251
 
                accelerator_tree.lock_read()
2252
 
            try:
2253
 
                return _build_tree(tree, wt, accelerator_tree, hardlink,
2254
 
                                   delta_from_tree)
2255
 
            finally:
2256
 
                if accelerator_tree is not None:
2257
 
                    accelerator_tree.unlock()
 
1343
            return _build_tree(tree, wt)
2258
1344
        finally:
2259
1345
            tree.unlock()
2260
1346
    finally:
2261
1347
        wt.unlock()
2262
1348
 
2263
1349
 
2264
 
def _build_tree(tree, wt, accelerator_tree, hardlink, delta_from_tree):
 
1350
def _build_tree(tree, wt):
2265
1351
    """See build_tree."""
2266
 
    for num, _unused in enumerate(wt.all_file_ids()):
2267
 
        if num > 0:  # more than just a root
2268
 
            raise errors.WorkingTreeAlreadyPopulated(base=wt.basedir)
2269
 
    existing_files = set()
2270
 
    for dir, files in wt.walkdirs():
2271
 
        existing_files.update(f[0] for f in files)
 
1352
    if len(wt.inventory) > 1:  # more than just a root
 
1353
        raise errors.WorkingTreeAlreadyPopulated(base=wt.basedir)
2272
1354
    file_trans_id = {}
2273
1355
    top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
2274
1356
    pp = ProgressPhase("Build phase", 2, top_pb)
2292
1374
        pb = bzrlib.ui.ui_factory.nested_progress_bar()
2293
1375
        try:
2294
1376
            deferred_contents = []
2295
 
            num = 0
2296
 
            total = len(tree.inventory)
2297
 
            if delta_from_tree:
2298
 
                precomputed_delta = []
2299
 
            else:
2300
 
                precomputed_delta = None
2301
1377
            for num, (tree_path, entry) in \
2302
1378
                enumerate(tree.inventory.iter_entries_by_dir()):
2303
 
                pb.update("Building tree", num - len(deferred_contents), total)
 
1379
                pb.update("Building tree", num - len(deferred_contents),
 
1380
                          len(tree.inventory))
2304
1381
                if entry.parent_id is None:
2305
1382
                    continue
2306
1383
                reparent = False
2307
1384
                file_id = entry.file_id
2308
 
                if delta_from_tree:
2309
 
                    precomputed_delta.append((None, tree_path, file_id, entry))
2310
 
                if tree_path in existing_files:
2311
 
                    target_path = wt.abspath(tree_path)
 
1385
                target_path = wt.abspath(tree_path)
 
1386
                try:
2312
1387
                    kind = file_kind(target_path)
 
1388
                except NoSuchFile:
 
1389
                    pass
 
1390
                else:
2313
1391
                    if kind == "directory":
2314
1392
                        try:
2315
1393
                            bzrdir.BzrDir.open(target_path)
2323
1401
                        tt.delete_contents(tt.trans_id_tree_path(tree_path))
2324
1402
                        if kind == 'directory':
2325
1403
                            reparent = True
 
1404
                if entry.parent_id not in file_trans_id:
 
1405
                    raise AssertionError(
 
1406
                        'entry %s parent id %r is not in file_trans_id %r'
 
1407
                        % (entry, entry.parent_id, file_trans_id))
2326
1408
                parent_id = file_trans_id[entry.parent_id]
2327
1409
                if entry.kind == 'file':
2328
1410
                    # We *almost* replicate new_by_entry, so that we can defer
2329
1411
                    # getting the file text, and get them all at once.
2330
1412
                    trans_id = tt.create_path(entry.name, parent_id)
2331
1413
                    file_trans_id[file_id] = trans_id
2332
 
                    tt.version_file(file_id, trans_id)
2333
 
                    executable = tree.is_executable(file_id, tree_path)
2334
 
                    if executable:
 
1414
                    tt.version_file(entry.file_id, trans_id)
 
1415
                    executable = tree.is_executable(entry.file_id, tree_path)
 
1416
                    if executable is not None:
2335
1417
                        tt.set_executability(executable, trans_id)
2336
 
                    trans_data = (trans_id, tree_path)
2337
 
                    deferred_contents.append((file_id, trans_data))
 
1418
                    deferred_contents.append((entry.file_id, trans_id))
2338
1419
                else:
2339
1420
                    file_trans_id[file_id] = new_by_entry(tt, entry, parent_id,
2340
1421
                                                          tree)
2342
1423
                    new_trans_id = file_trans_id[file_id]
2343
1424
                    old_parent = tt.trans_id_tree_path(tree_path)
2344
1425
                    _reparent_children(tt, old_parent, new_trans_id)
2345
 
            offset = num + 1 - len(deferred_contents)
2346
 
            _create_files(tt, tree, deferred_contents, pb, offset,
2347
 
                          accelerator_tree, hardlink)
 
1426
            for num, (trans_id, bytes) in enumerate(
 
1427
                tree.iter_files_bytes(deferred_contents)):
 
1428
                tt.create_file(bytes, trans_id)
 
1429
                pb.update('Adding file contents',
 
1430
                          (num + len(tree.inventory) - len(deferred_contents)),
 
1431
                          len(tree.inventory))
2348
1432
        finally:
2349
1433
            pb.finished()
2350
1434
        pp.next_phase()
2351
1435
        divert_trans = set(file_trans_id[f] for f in divert)
2352
1436
        resolver = lambda t, c: resolve_checkout(t, c, divert_trans)
2353
1437
        raw_conflicts = resolve_conflicts(tt, pass_func=resolver)
2354
 
        if len(raw_conflicts) > 0:
2355
 
            precomputed_delta = None
2356
1438
        conflicts = cook_conflicts(raw_conflicts, tt)
2357
1439
        for conflict in conflicts:
2358
1440
            warning(conflict)
2360
1442
            wt.add_conflicts(conflicts)
2361
1443
        except errors.UnsupportedOperation:
2362
1444
            pass
2363
 
        result = tt.apply(no_conflicts=True,
2364
 
                          precomputed_delta=precomputed_delta)
 
1445
        result = tt.apply()
2365
1446
    finally:
2366
1447
        tt.finalize()
2367
1448
        top_pb.finished()
2368
1449
    return result
2369
1450
 
2370
1451
 
2371
 
def _create_files(tt, tree, desired_files, pb, offset, accelerator_tree,
2372
 
                  hardlink):
2373
 
    total = len(desired_files) + offset
2374
 
    wt = tt._tree
2375
 
    if accelerator_tree is None:
2376
 
        new_desired_files = desired_files
2377
 
    else:
2378
 
        iter = accelerator_tree.iter_changes(tree, include_unchanged=True)
2379
 
        unchanged = [(f, p[1]) for (f, p, c, v, d, n, k, e)
2380
 
                     in iter if not (c or e[0] != e[1])]
2381
 
        if accelerator_tree.supports_content_filtering():
2382
 
            unchanged = [(f, p) for (f, p) in unchanged
2383
 
                         if not accelerator_tree.iter_search_rules([p]).next()]
2384
 
        unchanged = dict(unchanged)
2385
 
        new_desired_files = []
2386
 
        count = 0
2387
 
        for file_id, (trans_id, tree_path) in desired_files:
2388
 
            accelerator_path = unchanged.get(file_id)
2389
 
            if accelerator_path is None:
2390
 
                new_desired_files.append((file_id, (trans_id, tree_path)))
2391
 
                continue
2392
 
            pb.update('Adding file contents', count + offset, total)
2393
 
            if hardlink:
2394
 
                tt.create_hardlink(accelerator_tree.abspath(accelerator_path),
2395
 
                                   trans_id)
2396
 
            else:
2397
 
                contents = accelerator_tree.get_file(file_id, accelerator_path)
2398
 
                if wt.supports_content_filtering():
2399
 
                    filters = wt._content_filter_stack(tree_path)
2400
 
                    contents = filtered_output_bytes(contents, filters,
2401
 
                        ContentFilterContext(tree_path, tree))
2402
 
                try:
2403
 
                    tt.create_file(contents, trans_id)
2404
 
                finally:
2405
 
                    try:
2406
 
                        contents.close()
2407
 
                    except AttributeError:
2408
 
                        # after filtering, contents may no longer be file-like
2409
 
                        pass
2410
 
            count += 1
2411
 
        offset += count
2412
 
    for count, ((trans_id, tree_path), contents) in enumerate(
2413
 
            tree.iter_files_bytes(new_desired_files)):
2414
 
        if wt.supports_content_filtering():
2415
 
            filters = wt._content_filter_stack(tree_path)
2416
 
            contents = filtered_output_bytes(contents, filters,
2417
 
                ContentFilterContext(tree_path, tree))
2418
 
        tt.create_file(contents, trans_id)
2419
 
        pb.update('Adding file contents', count + offset, total)
2420
 
 
2421
 
 
2422
1452
def _reparent_children(tt, old_parent, new_parent):
2423
1453
    for child in tt.iter_tree_children(old_parent):
2424
1454
        tt.adjust_path(tt.final_name(child), new_parent, child)
2425
1455
 
2426
 
def _reparent_transform_children(tt, old_parent, new_parent):
2427
 
    by_parent = tt.by_parent()
2428
 
    for child in by_parent[old_parent]:
2429
 
        tt.adjust_path(tt.final_name(child), new_parent, child)
2430
 
    return by_parent[old_parent]
2431
1456
 
2432
1457
def _content_match(tree, entry, file_id, kind, target_path):
2433
1458
    if entry.kind != kind:
2447
1472
    new_conflicts = set()
2448
1473
    for c_type, conflict in ((c[0], c) for c in conflicts):
2449
1474
        # Anything but a 'duplicate' would indicate programmer error
2450
 
        if c_type != 'duplicate':
2451
 
            raise AssertionError(c_type)
 
1475
        assert c_type == 'duplicate', c_type
2452
1476
        # Now figure out which is new and which is old
2453
1477
        if tt.new_contents(conflict[1]):
2454
1478
            new_file = conflict[1]
2480
1504
    if kind == 'file':
2481
1505
        contents = tree.get_file(entry.file_id).readlines()
2482
1506
        executable = tree.is_executable(entry.file_id)
2483
 
        return tt.new_file(name, parent_id, contents, entry.file_id,
 
1507
        return tt.new_file(name, parent_id, contents, entry.file_id, 
2484
1508
                           executable)
2485
1509
    elif kind in ('directory', 'tree-reference'):
2486
1510
        trans_id = tt.new_directory(name, parent_id, entry.file_id)
2487
1511
        if kind == 'tree-reference':
2488
1512
            tt.set_tree_reference(entry.reference_revision, trans_id)
2489
 
        return trans_id
 
1513
        return trans_id 
2490
1514
    elif kind == 'symlink':
2491
1515
        target = tree.get_symlink_target(entry.file_id)
2492
1516
        return tt.new_symlink(name, parent_id, target, entry.file_id)
2494
1518
        raise errors.BadFileKindError(name, kind)
2495
1519
 
2496
1520
 
2497
 
@deprecated_function(deprecated_in((1, 9, 0)))
2498
1521
def create_by_entry(tt, entry, tree, trans_id, lines=None, mode_id=None):
2499
 
    """Create new file contents according to an inventory entry.
2500
 
 
2501
 
    DEPRECATED.  Use create_from_tree instead.
2502
 
    """
 
1522
    """Create new file contents according to an inventory entry."""
2503
1523
    if entry.kind == "file":
2504
1524
        if lines is None:
2505
1525
            lines = tree.get_file(entry.file_id).readlines()
2510
1530
        tt.create_directory(trans_id)
2511
1531
 
2512
1532
 
2513
 
def create_from_tree(tt, trans_id, tree, file_id, bytes=None,
2514
 
    filter_tree_path=None):
2515
 
    """Create new file contents according to tree contents.
2516
 
    
2517
 
    :param filter_tree_path: the tree path to use to lookup
2518
 
      content filters to apply to the bytes output in the working tree.
2519
 
      This only applies if the working tree supports content filtering.
2520
 
    """
2521
 
    kind = tree.kind(file_id)
2522
 
    if kind == 'directory':
2523
 
        tt.create_directory(trans_id)
2524
 
    elif kind == "file":
2525
 
        if bytes is None:
2526
 
            tree_file = tree.get_file(file_id)
2527
 
            try:
2528
 
                bytes = tree_file.readlines()
2529
 
            finally:
2530
 
                tree_file.close()
2531
 
        wt = tt._tree
2532
 
        if wt.supports_content_filtering() and filter_tree_path is not None:
2533
 
            filters = wt._content_filter_stack(filter_tree_path)
2534
 
            bytes = filtered_output_bytes(bytes, filters,
2535
 
                ContentFilterContext(filter_tree_path, tree))
2536
 
        tt.create_file(bytes, trans_id)
2537
 
    elif kind == "symlink":
2538
 
        tt.create_symlink(tree.get_symlink_target(file_id), trans_id)
2539
 
    else:
2540
 
        raise AssertionError('Unknown kind %r' % kind)
2541
 
 
2542
 
 
2543
1533
def create_entry_executability(tt, entry, trans_id):
2544
1534
    """Set the executability of a trans_id according to an inventory entry"""
2545
1535
    if entry.kind == "file":
2546
1536
        tt.set_executability(entry.executable, trans_id)
2547
1537
 
2548
1538
 
 
1539
@deprecated_function(zero_fifteen)
 
1540
def find_interesting(working_tree, target_tree, filenames):
 
1541
    """Find the ids corresponding to specified filenames.
 
1542
    
 
1543
    Deprecated: Please use tree1.paths2ids(filenames, [tree2]).
 
1544
    """
 
1545
    working_tree.lock_read()
 
1546
    try:
 
1547
        target_tree.lock_read()
 
1548
        try:
 
1549
            return working_tree.paths2ids(filenames, [target_tree])
 
1550
        finally:
 
1551
            target_tree.unlock()
 
1552
    finally:
 
1553
        working_tree.unlock()
 
1554
 
 
1555
 
 
1556
@deprecated_function(zero_ninety)
 
1557
def change_entry(tt, file_id, working_tree, target_tree, 
 
1558
                 trans_id_file_id, backups, trans_id, by_parent):
 
1559
    """Replace a file_id's contents with those from a target tree."""
 
1560
    if file_id is None and target_tree is None:
 
1561
        # skip the logic altogether in the deprecation test
 
1562
        return
 
1563
    e_trans_id = trans_id_file_id(file_id)
 
1564
    entry = target_tree.inventory[file_id]
 
1565
    has_contents, contents_mod, meta_mod, = _entry_changes(file_id, entry, 
 
1566
                                                           working_tree)
 
1567
    if contents_mod:
 
1568
        mode_id = e_trans_id
 
1569
        if has_contents:
 
1570
            if not backups:
 
1571
                tt.delete_contents(e_trans_id)
 
1572
            else:
 
1573
                parent_trans_id = trans_id_file_id(entry.parent_id)
 
1574
                backup_name = get_backup_name(entry, by_parent,
 
1575
                                              parent_trans_id, tt)
 
1576
                tt.adjust_path(backup_name, parent_trans_id, e_trans_id)
 
1577
                tt.unversion_file(e_trans_id)
 
1578
                e_trans_id = tt.create_path(entry.name, parent_trans_id)
 
1579
                tt.version_file(file_id, e_trans_id)
 
1580
                trans_id[file_id] = e_trans_id
 
1581
        create_by_entry(tt, entry, target_tree, e_trans_id, mode_id=mode_id)
 
1582
        create_entry_executability(tt, entry, e_trans_id)
 
1583
 
 
1584
    elif meta_mod:
 
1585
        tt.set_executability(entry.executable, e_trans_id)
 
1586
    if tt.final_name(e_trans_id) != entry.name:
 
1587
        adjust_path  = True
 
1588
    else:
 
1589
        parent_id = tt.final_parent(e_trans_id)
 
1590
        parent_file_id = tt.final_file_id(parent_id)
 
1591
        if parent_file_id != entry.parent_id:
 
1592
            adjust_path = True
 
1593
        else:
 
1594
            adjust_path = False
 
1595
    if adjust_path:
 
1596
        parent_trans_id = trans_id_file_id(entry.parent_id)
 
1597
        tt.adjust_path(entry.name, parent_trans_id, e_trans_id)
 
1598
 
 
1599
 
2549
1600
def get_backup_name(entry, by_parent, parent_trans_id, tt):
2550
1601
    return _get_backup_name(entry.name, by_parent, parent_trans_id, tt)
2551
1602
 
2582
1633
        if entry.kind != working_kind:
2583
1634
            contents_mod, meta_mod = True, False
2584
1635
        else:
2585
 
            cur_entry._read_tree_state(working_tree.id2path(file_id),
 
1636
            cur_entry._read_tree_state(working_tree.id2path(file_id), 
2586
1637
                                       working_tree)
2587
1638
            contents_mod, meta_mod = entry.detect_changes(cur_entry)
2588
1639
            cur_entry._forget_tree_state()
2590
1641
 
2591
1642
 
2592
1643
def revert(working_tree, target_tree, filenames, backups=False,
2593
 
           pb=None, change_reporter=None):
 
1644
           pb=DummyProgress(), change_reporter=None):
2594
1645
    """Revert a working tree's contents to those of a target tree."""
2595
1646
    target_tree.lock_read()
2596
 
    pb = ui.ui_factory.nested_progress_bar()
2597
1647
    tt = TreeTransform(working_tree, pb)
2598
1648
    try:
2599
1649
        pp = ProgressPhase("Revert phase", 3, pb)
2600
 
        conflicts, merge_modified = _prepare_revert_transform(
2601
 
            working_tree, target_tree, tt, filenames, backups, pp)
 
1650
        pp.next_phase()
 
1651
        child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
1652
        try:
 
1653
            merge_modified = _alter_files(working_tree, target_tree, tt,
 
1654
                                          child_pb, filenames, backups)
 
1655
        finally:
 
1656
            child_pb.finished()
 
1657
        pp.next_phase()
 
1658
        child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
1659
        try:
 
1660
            raw_conflicts = resolve_conflicts(tt, child_pb,
 
1661
                lambda t, c: conflict_pass(t, c, target_tree))
 
1662
        finally:
 
1663
            child_pb.finished()
 
1664
        conflicts = cook_conflicts(raw_conflicts, tt)
2602
1665
        if change_reporter:
2603
1666
            change_reporter = delta._ChangeReporter(
2604
1667
                unversioned_filter=working_tree.is_ignored)
2605
 
            delta.report_changes(tt.iter_changes(), change_reporter)
 
1668
            delta.report_changes(tt._iter_changes(), change_reporter)
2606
1669
        for conflict in conflicts:
2607
1670
            warning(conflict)
2608
1671
        pp.next_phase()
2615
1678
    return conflicts
2616
1679
 
2617
1680
 
2618
 
def _prepare_revert_transform(working_tree, target_tree, tt, filenames,
2619
 
                              backups, pp, basis_tree=None,
2620
 
                              merge_modified=None):
2621
 
    child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
2622
 
    try:
2623
 
        if merge_modified is None:
2624
 
            merge_modified = working_tree.merge_modified()
2625
 
        merge_modified = _alter_files(working_tree, target_tree, tt,
2626
 
                                      child_pb, filenames, backups,
2627
 
                                      merge_modified, basis_tree)
2628
 
    finally:
2629
 
        child_pb.finished()
2630
 
    child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
2631
 
    try:
2632
 
        raw_conflicts = resolve_conflicts(tt, child_pb,
2633
 
            lambda t, c: conflict_pass(t, c, target_tree))
2634
 
    finally:
2635
 
        child_pb.finished()
2636
 
    conflicts = cook_conflicts(raw_conflicts, tt)
2637
 
    return conflicts, merge_modified
2638
 
 
2639
 
 
2640
1681
def _alter_files(working_tree, target_tree, tt, pb, specific_files,
2641
 
                 backups, merge_modified, basis_tree=None):
2642
 
    if basis_tree is not None:
2643
 
        basis_tree.lock_read()
2644
 
    change_list = target_tree.iter_changes(working_tree,
 
1682
                 backups):
 
1683
    merge_modified = working_tree.merge_modified()
 
1684
    change_list = target_tree._iter_changes(working_tree,
2645
1685
        specific_files=specific_files, pb=pb)
2646
 
    if target_tree.get_root_id() is None:
 
1686
    if target_tree.inventory.root is None:
2647
1687
        skip_root = True
2648
1688
    else:
2649
1689
        skip_root = False
 
1690
    basis_tree = None
2650
1691
    try:
2651
1692
        deferred_files = []
2652
1693
        for id_num, (file_id, path, changed_content, versioned, parent, name,
2688
1729
                        # contents
2689
1730
                        mode_id = trans_id
2690
1731
                        trans_id = new_trans_id
2691
 
                if kind[1] in ('directory', 'tree-reference'):
 
1732
                if kind[1] == 'directory':
2692
1733
                    tt.create_directory(trans_id)
2693
 
                    if kind[1] == 'tree-reference':
2694
 
                        revision = target_tree.get_reference_revision(file_id,
2695
 
                                                                      path[1])
2696
 
                        tt.set_tree_reference(revision, trans_id)
2697
1734
                elif kind[1] == 'symlink':
2698
1735
                    tt.create_symlink(target_tree.get_symlink_target(file_id),
2699
1736
                                      trans_id)
2713
1750
                    # preserve the execute bit when backing up
2714
1751
                    if keep_content and executable[0] == executable[1]:
2715
1752
                        tt.set_executability(executable[1], trans_id)
2716
 
                elif kind[1] is not None:
2717
 
                    raise AssertionError(kind[1])
 
1753
                else:
 
1754
                    assert kind[1] is None
2718
1755
            if versioned == (False, True):
2719
1756
                tt.version_file(file_id, trans_id)
2720
1757
            if versioned == (True, False):
2721
1758
                tt.unversion_file(trans_id)
2722
 
            if (name[1] is not None and
 
1759
            if (name[1] is not None and 
2723
1760
                (name[0] != name[1] or parent[0] != parent[1])):
2724
 
                if name[1] == '' and parent[1] is None:
2725
 
                    parent_trans = ROOT_PARENT
2726
 
                else:
2727
 
                    parent_trans = tt.trans_id_file_id(parent[1])
2728
 
                if parent[0] is None and versioned[0]:
2729
 
                    tt.adjust_root_path(name[1], parent_trans)
2730
 
                else:
2731
 
                    tt.adjust_path(name[1], parent_trans, trans_id)
 
1761
                tt.adjust_path(
 
1762
                    name[1], tt.trans_id_file_id(parent[1]), trans_id)
2732
1763
            if executable[0] != executable[1] and kind[1] == "file":
2733
1764
                tt.set_executability(executable[1], trans_id)
2734
 
        if working_tree.supports_content_filtering():
2735
 
            for index, ((trans_id, mode_id), bytes) in enumerate(
2736
 
                target_tree.iter_files_bytes(deferred_files)):
2737
 
                file_id = deferred_files[index][0]
2738
 
                # We're reverting a tree to the target tree so using the
2739
 
                # target tree to find the file path seems the best choice
2740
 
                # here IMO - Ian C 27/Oct/2009
2741
 
                filter_tree_path = target_tree.id2path(file_id)
2742
 
                filters = working_tree._content_filter_stack(filter_tree_path)
2743
 
                bytes = filtered_output_bytes(bytes, filters,
2744
 
                    ContentFilterContext(filter_tree_path, working_tree))
2745
 
                tt.create_file(bytes, trans_id, mode_id)
2746
 
        else:
2747
 
            for (trans_id, mode_id), bytes in target_tree.iter_files_bytes(
2748
 
                deferred_files):
2749
 
                tt.create_file(bytes, trans_id, mode_id)
2750
 
        tt.fixup_new_roots()
 
1765
        for (trans_id, mode_id), bytes in target_tree.iter_files_bytes(
 
1766
            deferred_files):
 
1767
            tt.create_file(bytes, trans_id, mode_id)
2751
1768
    finally:
2752
1769
        if basis_tree is not None:
2753
1770
            basis_tree.unlock()
2754
1771
    return merge_modified
2755
1772
 
2756
1773
 
2757
 
def resolve_conflicts(tt, pb=None, pass_func=None):
 
1774
def resolve_conflicts(tt, pb=DummyProgress(), pass_func=None):
2758
1775
    """Make many conflict-resolution attempts, but die if they fail"""
2759
1776
    if pass_func is None:
2760
1777
        pass_func = conflict_pass
2761
1778
    new_conflicts = set()
2762
 
    pb = ui.ui_factory.nested_progress_bar()
2763
1779
    try:
2764
1780
        for n in range(10):
2765
1781
            pb.update('Resolution pass', n+1, 10)
2769
1785
            new_conflicts.update(pass_func(tt, conflicts))
2770
1786
        raise MalformedTransform(conflicts=conflicts)
2771
1787
    finally:
2772
 
        pb.finished()
 
1788
        pb.clear()
2773
1789
 
2774
1790
 
2775
1791
def conflict_pass(tt, conflicts, path_tree=None):
2794
1810
                existing_file, new_file = conflict[1], conflict[2]
2795
1811
            new_name = tt.final_name(existing_file)+'.moved'
2796
1812
            tt.adjust_path(new_name, final_parent, existing_file)
2797
 
            new_conflicts.add((c_type, 'Moved existing file to',
 
1813
            new_conflicts.add((c_type, 'Moved existing file to', 
2798
1814
                               existing_file, new_file))
2799
1815
        elif c_type == 'parent loop':
2800
1816
            # break the loop by undoing one of the ops that caused the loop
2804
1820
            new_conflicts.add((c_type, 'Cancelled move', cur,
2805
1821
                               tt.final_parent(cur),))
2806
1822
            tt.adjust_path(tt.final_name(cur), tt.get_tree_parent(cur), cur)
2807
 
 
 
1823
            
2808
1824
        elif c_type == 'missing parent':
2809
1825
            trans_id = conflict[1]
2810
1826
            try:
2811
1827
                tt.cancel_deletion(trans_id)
2812
 
                new_conflicts.add(('deleting parent', 'Not deleting',
 
1828
                new_conflicts.add(('deleting parent', 'Not deleting', 
2813
1829
                                   trans_id))
2814
1830
            except KeyError:
2815
 
                create = True
 
1831
                tt.create_directory(trans_id)
 
1832
                new_conflicts.add((c_type, 'Created directory', trans_id))
2816
1833
                try:
2817
1834
                    tt.final_name(trans_id)
2818
1835
                except NoFinalPath:
2819
1836
                    if path_tree is not None:
2820
1837
                        file_id = tt.final_file_id(trans_id)
2821
 
                        if file_id is None:
2822
 
                            file_id = tt.inactive_file_id(trans_id)
2823
1838
                        entry = path_tree.inventory[file_id]
2824
 
                        # special-case the other tree root (move its
2825
 
                        # children to current root)
2826
 
                        if entry.parent_id is None:
2827
 
                            create = False
2828
 
                            moved = _reparent_transform_children(
2829
 
                                tt, trans_id, tt.root)
2830
 
                            for child in moved:
2831
 
                                new_conflicts.add((c_type, 'Moved to root',
2832
 
                                                   child))
2833
 
                        else:
2834
 
                            parent_trans_id = tt.trans_id_file_id(
2835
 
                                entry.parent_id)
2836
 
                            tt.adjust_path(entry.name, parent_trans_id,
2837
 
                                           trans_id)
2838
 
                if create:
2839
 
                    tt.create_directory(trans_id)
2840
 
                    new_conflicts.add((c_type, 'Created directory', trans_id))
 
1839
                        parent_trans_id = tt.trans_id_file_id(entry.parent_id)
 
1840
                        tt.adjust_path(entry.name, parent_trans_id, trans_id)
2841
1841
        elif c_type == 'unversioned parent':
2842
 
            file_id = tt.inactive_file_id(conflict[1])
2843
 
            # special-case the other tree root (move its children instead)
2844
 
            if path_tree and file_id in path_tree:
2845
 
                if path_tree.inventory[file_id].parent_id is None:
2846
 
                    continue
2847
 
            tt.version_file(file_id, conflict[1])
 
1842
            tt.version_file(tt.inactive_file_id(conflict[1]), conflict[1])
2848
1843
            new_conflicts.add((c_type, 'Versioned directory', conflict[1]))
2849
 
        elif c_type == 'non-directory parent':
2850
 
            parent_id = conflict[1]
2851
 
            parent_parent = tt.final_parent(parent_id)
2852
 
            parent_name = tt.final_name(parent_id)
2853
 
            parent_file_id = tt.final_file_id(parent_id)
2854
 
            new_parent_id = tt.new_directory(parent_name + '.new',
2855
 
                parent_parent, parent_file_id)
2856
 
            _reparent_transform_children(tt, parent_id, new_parent_id)
2857
 
            if parent_file_id is not None:
2858
 
                tt.unversion_file(parent_id)
2859
 
            new_conflicts.add((c_type, 'Created directory', new_parent_id))
2860
 
        elif c_type == 'versioning no contents':
2861
 
            tt.cancel_versioning(conflict[1])
2862
1844
    return new_conflicts
2863
1845
 
2864
1846
 
2880
1862
        if len(conflict) == 3:
2881
1863
            yield Conflict.factory(c_type, action=action, path=modified_path,
2882
1864
                                     file_id=modified_id)
2883
 
 
 
1865
             
2884
1866
        else:
2885
1867
            conflicting_path = fp.get_path(conflict[3])
2886
1868
            conflicting_id = tt.final_file_id(conflict[3])
2887
1869
            yield Conflict.factory(c_type, action=action, path=modified_path,
2888
 
                                   file_id=modified_id,
 
1870
                                   file_id=modified_id, 
2889
1871
                                   conflict_path=conflicting_path,
2890
1872
                                   conflict_file_id=conflicting_id)
2891
1873
 
2898
1880
        self.pending_deletions = []
2899
1881
 
2900
1882
    def rename(self, from_, to):
2901
 
        """Rename a file from one path to another."""
 
1883
        """Rename a file from one path to another.  Functions like os.rename"""
2902
1884
        try:
2903
 
            osutils.rename(from_, to)
 
1885
            os.rename(from_, to)
2904
1886
        except OSError, e:
2905
1887
            if e.errno in (errno.EEXIST, errno.ENOTEMPTY):
2906
1888
                raise errors.FileExists(to, str(e))
2920
1902
    def rollback(self):
2921
1903
        """Reverse all renames that have been performed"""
2922
1904
        for from_, to in reversed(self.past_renames):
2923
 
            osutils.rename(to, from_)
 
1905
            os.rename(to, from_)
2924
1906
        # after rollback, don't reuse _FileMover
2925
1907
        past_renames = None
2926
1908
        pending_deletions = None