← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/transform.py

  • Committer: Ian Clatworthy
  • Date: 2007-08-13 14:33:10 UTC
  • mto: (2733.1.1 ianc-integration)
  • mto: This revision was merged to the branch mainline in revision 2734.
  • Revision ID: ian.clatworthy@internode.on.net-20070813143310-twhj4la0qnupvze8
Added Quick Start Summary

Show diffs side-by-side

added added

removed removed

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