← 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-08-13 14:33:10 UTC
  • mto: (2733.1.1 ianc-integration)
  • mto: This revision was merged to the branch mainline in revision 2734.
  • Revision ID: ian.clatworthy@internode.on.net-20070813143310-twhj4la0qnupvze8
Added Quick Start Summary

Show diffs side-by-side

added added

removed removed

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