← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/transform.py

  • Committer: Ian Clatworthy
  • Date: 2007-08-14 03:59:22 UTC
  • mto: (2733.1.1 ianc-integration)
  • mto: This revision was merged to the branch mainline in revision 2734.
  • Revision ID: ian.clatworthy@internode.on.net-20070814035922-siavg542cwvkf4r5
Fix pretty doc generation so works for all html docs

Show diffs side-by-side

added added

removed removed

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