~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/transform.py

  • Committer: Robert Collins
  • Date: 2010-04-08 04:34:03 UTC
  • mfrom: (5138 +trunk)
  • mto: This revision was merged to the branch mainline in revision 5139.
  • Revision ID: robertc@robertcollins.net-20100408043403-56z0d07vdqrx7f3t
Update bugfix for 528114 to trunk.

Show diffs side-by-side

added added

removed removed

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