← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/transform.py

  • Committer: John Arbash Meinel
  • Date: 2006-10-05 22:42:09 UTC
  • mto: This revision was merged to the branch mainline in revision 2071.
  • Revision ID: john@arbash-meinel.com-20061005224209-6847d92c751c2dc1
Now that mkdtemp and rmtree are lazy, they should not be directly improted.

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