← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/transform.py

  • Committer: Robert Collins
  • Date: 2007-04-19 02:27:44 UTC
  • mto: This revision was merged to the branch mainline in revision 2426.
  • Revision ID: robertc@robertcollins.net-20070419022744-pfdqz42kp1wizh43
``make docs`` now creates a man page at ``man1/bzr.1`` fixing bug 107388.
(Robert Collins)

Show diffs side-by-side

added added

removed removed

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