← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/transform.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2008-08-14 17:25:43 UTC
  • mfrom: (3620.2.2 rules.disable)
  • Revision ID: pqm@pqm.ubuntu.com-20080814172543-nl22gdcodusa8rt0
(robertc) Disable .bzrrules from being read from the WT

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/transform.py
1
 
# Copyright (C) 2006-2010 Canonical Ltd
 
1
# Copyright (C) 2006, 2007, 2008 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
12
12
#
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
16
 
17
17
import os
18
18
import errno
19
19
from stat import S_ISREG, S_IEXEC
20
 
import time
 
20
import tempfile
21
21
 
22
22
from bzrlib.lazy_import import lazy_import
23
23
lazy_import(globals(), """
24
24
from bzrlib import (
25
25
    annotate,
26
 
    bencode,
27
26
    bzrdir,
28
27
    delta,
29
28
    errors,
30
29
    inventory,
31
 
    multiparent,
32
30
    osutils,
33
31
    revision as _mod_revision,
34
 
    ui,
35
32
    )
36
33
""")
37
34
from bzrlib.errors import (DuplicateKey, MalformedTransform, NoSuchFile,
38
 
                           ReusingTransform, CantMoveRoot,
 
35
                           ReusingTransform, NotVersionedError, CantMoveRoot,
39
36
                           ExistingLimbo, ImmortalLimbo, NoFinalPath,
40
37
                           UnableCreateSymlink)
41
 
from bzrlib.filters import filtered_output_bytes, ContentFilterContext
42
38
from bzrlib.inventory import InventoryEntry
43
39
from bzrlib.osutils import (
44
40
    delete_any,
46
42
    has_symlinks,
47
43
    lexists,
48
44
    pathjoin,
49
 
    sha_file,
50
45
    splitpath,
51
46
    supports_executable,
52
47
)
53
 
from bzrlib.progress import ProgressPhase
 
48
from bzrlib.progress import DummyProgress, ProgressPhase
54
49
from bzrlib.symbol_versioning import (
55
50
        deprecated_function,
56
 
        deprecated_in,
57
51
        )
58
52
from bzrlib.trace import mutter, warning
59
53
from bzrlib import tree
78
72
 
79
73
 
80
74
class TreeTransformBase(object):
81
 
    """The base class for TreeTransform and its kin."""
 
75
    """The base class for TreeTransform and TreeTransformBase"""
82
76
 
83
 
    def __init__(self, tree, pb=None,
 
77
    def __init__(self, tree, limbodir, pb=DummyProgress(),
84
78
                 case_sensitive=True):
85
79
        """Constructor.
86
80
 
87
81
        :param tree: The tree that will be transformed, but not necessarily
88
82
            the output tree.
89
 
        :param pb: ignored
 
83
        :param limbodir: A directory where new files can be stored until
 
84
            they are installed in their proper places
 
85
        :param pb: A ProgressBar indicating how much progress is being made
90
86
        :param case_sensitive: If True, the target of the transform is
91
87
            case sensitive, not just case preserving.
92
88
        """
93
89
        object.__init__(self)
94
90
        self._tree = tree
 
91
        self._limbodir = limbodir
 
92
        self._deletiondir = None
95
93
        self._id_number = 0
96
94
        # mapping of trans_id -> new basename
97
95
        self._new_name = {}
99
97
        self._new_parent = {}
100
98
        # mapping of trans_id with new contents -> new file_kind
101
99
        self._new_contents = {}
 
100
        # A mapping of transform ids to their limbo filename
 
101
        self._limbo_files = {}
 
102
        # A mapping of transform ids to a set of the transform ids of children
 
103
        # that their limbo directory has
 
104
        self._limbo_children = {}
 
105
        # Map transform ids to maps of child filename to child transform id
 
106
        self._limbo_children_names = {}
 
107
        # List of transform ids that need to be renamed from limbo into place
 
108
        self._needs_rename = set()
102
109
        # Set of trans_ids whose contents will be removed
103
110
        self._removed_contents = set()
104
111
        # Mapping of trans_id -> new execute-bit value
111
118
        self._non_present_ids = {}
112
119
        # Mapping of new file_id -> trans_id
113
120
        self._r_new_id = {}
114
 
        # Set of trans_ids that will be removed
 
121
        # Set of file_ids that will be removed
115
122
        self._removed_id = set()
116
123
        # Mapping of path in old tree -> trans_id
117
124
        self._tree_path_ids = {}
118
125
        # Mapping trans_id -> path in old tree
119
126
        self._tree_id_paths = {}
 
127
        # Cache of realpath results, to speed up canonical_path
 
128
        self._realpaths = {}
 
129
        # Cache of relpath results, to speed up canonical_path
 
130
        self._relpaths = {}
120
131
        # The trans_id that will be used as the tree root
121
 
        root_id = tree.get_root_id()
122
 
        if root_id is not None:
123
 
            self._new_root = self.trans_id_tree_file_id(root_id)
124
 
        else:
125
 
            self._new_root = None
 
132
        self._new_root = self.trans_id_tree_file_id(tree.get_root_id())
126
133
        # Indictor of whether the transform has been applied
127
134
        self._done = False
128
135
        # A progress bar
132
139
        # A counter of how many files have been renamed
133
140
        self.rename_count = 0
134
141
 
135
 
    def finalize(self):
136
 
        """Release the working tree lock, if held.
137
 
 
138
 
        This is required if apply has not been invoked, but can be invoked
139
 
        even after apply.
140
 
        """
141
 
        if self._tree is None:
142
 
            return
143
 
        self._tree.unlock()
144
 
        self._tree = None
145
 
 
146
142
    def __get_root(self):
147
143
        return self._new_root
148
144
 
149
145
    root = property(__get_root)
150
146
 
 
147
    def finalize(self):
 
148
        """Release the working tree lock, if held, clean up limbo dir.
 
149
 
 
150
        This is required if apply has not been invoked, but can be invoked
 
151
        even after apply.
 
152
        """
 
153
        if self._tree is None:
 
154
            return
 
155
        try:
 
156
            entries = [(self._limbo_name(t), t, k) for t, k in
 
157
                       self._new_contents.iteritems()]
 
158
            entries.sort(reverse=True)
 
159
            for path, trans_id, kind in entries:
 
160
                if kind == "directory":
 
161
                    os.rmdir(path)
 
162
                else:
 
163
                    os.unlink(path)
 
164
            try:
 
165
                os.rmdir(self._limbodir)
 
166
            except OSError:
 
167
                # We don't especially care *why* the dir is immortal.
 
168
                raise ImmortalLimbo(self._limbodir)
 
169
            try:
 
170
                if self._deletiondir is not None:
 
171
                    os.rmdir(self._deletiondir)
 
172
            except OSError:
 
173
                raise errors.ImmortalPendingDeletion(self._deletiondir)
 
174
        finally:
 
175
            self._tree.unlock()
 
176
            self._tree = None
 
177
 
151
178
    def _assign_id(self):
152
179
        """Produce a new tranform id"""
153
180
        new_id = "new-%s" % self._id_number
163
190
 
164
191
    def adjust_path(self, name, parent, trans_id):
165
192
        """Change the path that is assigned to a transaction id."""
166
 
        if parent is None:
167
 
            raise ValueError("Parent trans-id may not be None")
168
193
        if trans_id == self._new_root:
169
194
            raise CantMoveRoot
 
195
        previous_parent = self._new_parent.get(trans_id)
 
196
        previous_name = self._new_name.get(trans_id)
170
197
        self._new_name[trans_id] = name
171
198
        self._new_parent[trans_id] = parent
 
199
        if (trans_id in self._limbo_files and
 
200
            trans_id not in self._needs_rename):
 
201
            self._rename_in_limbo([trans_id])
 
202
            self._limbo_children[previous_parent].remove(trans_id)
 
203
            del self._limbo_children_names[previous_parent][previous_name]
 
204
 
 
205
    def _rename_in_limbo(self, trans_ids):
 
206
        """Fix limbo names so that the right final path is produced.
 
207
 
 
208
        This means we outsmarted ourselves-- we tried to avoid renaming
 
209
        these files later by creating them with their final names in their
 
210
        final parents.  But now the previous name or parent is no longer
 
211
        suitable, so we have to rename them.
 
212
 
 
213
        Even for trans_ids that have no new contents, we must remove their
 
214
        entries from _limbo_files, because they are now stale.
 
215
        """
 
216
        for trans_id in trans_ids:
 
217
            old_path = self._limbo_files.pop(trans_id)
 
218
            if trans_id not in self._new_contents:
 
219
                continue
 
220
            new_path = self._limbo_name(trans_id)
 
221
            os.rename(old_path, new_path)
172
222
 
173
223
    def adjust_root_path(self, name, parent):
174
224
        """Emulate moving the root by moving all children, instead.
175
 
 
 
225
        
176
226
        We do this by undoing the association of root's transaction id with the
177
227
        current tree.  This allows us to create a new directory with that
178
 
        transaction id.  We unversion the root directory and version the
 
228
        transaction id.  We unversion the root directory and version the 
179
229
        physically new directory, and hope someone versions the tree root
180
230
        later.
181
231
        """
184
234
        # force moving all children of root
185
235
        for child_id in self.iter_tree_children(old_root):
186
236
            if child_id != parent:
187
 
                self.adjust_path(self.final_name(child_id),
 
237
                self.adjust_path(self.final_name(child_id), 
188
238
                                 self.final_parent(child_id), child_id)
189
239
            file_id = self.final_file_id(child_id)
190
240
            if file_id is not None:
191
241
                self.unversion_file(child_id)
192
242
            self.version_file(file_id, child_id)
193
 
 
 
243
        
194
244
        # the physical root needs a new transaction id
195
245
        self._tree_path_ids.pop("")
196
246
        self._tree_id_paths.pop(old_root)
202
252
        self.version_file(old_root_file_id, old_root)
203
253
        self.unversion_file(self._new_root)
204
254
 
205
 
    def fixup_new_roots(self):
206
 
        """Reinterpret requests to change the root directory
207
 
 
208
 
        Instead of creating a root directory, or moving an existing directory,
209
 
        all the attributes and children of the new root are applied to the
210
 
        existing root directory.
211
 
 
212
 
        This means that the old root trans-id becomes obsolete, so it is
213
 
        recommended only to invoke this after the root trans-id has become
214
 
        irrelevant.
215
 
        """
216
 
        new_roots = [k for k, v in self._new_parent.iteritems() if v is
217
 
                     ROOT_PARENT]
218
 
        if len(new_roots) < 1:
219
 
            return
220
 
        if len(new_roots) != 1:
221
 
            raise ValueError('A tree cannot have two roots!')
222
 
        if self._new_root is None:
223
 
            self._new_root = new_roots[0]
224
 
            return
225
 
        old_new_root = new_roots[0]
226
 
        # TODO: What to do if a old_new_root is present, but self._new_root is
227
 
        #       not listed as being removed? This code explicitly unversions
228
 
        #       the old root and versions it with the new file_id. Though that
229
 
        #       seems like an incomplete delta
230
 
 
231
 
        # unversion the new root's directory.
232
 
        file_id = self.final_file_id(old_new_root)
233
 
        if old_new_root in self._new_id:
234
 
            self.cancel_versioning(old_new_root)
235
 
        else:
236
 
            self.unversion_file(old_new_root)
237
 
        # if, at this stage, root still has an old file_id, zap it so we can
238
 
        # stick a new one in.
239
 
        if (self.tree_file_id(self._new_root) is not None and
240
 
            self._new_root not in self._removed_id):
241
 
            self.unversion_file(self._new_root)
242
 
        self.version_file(file_id, self._new_root)
243
 
 
244
 
        # Now move children of new root into old root directory.
245
 
        # Ensure all children are registered with the transaction, but don't
246
 
        # use directly-- some tree children have new parents
247
 
        list(self.iter_tree_children(old_new_root))
248
 
        # Move all children of new root into old root directory.
249
 
        for child in self.by_parent().get(old_new_root, []):
250
 
            self.adjust_path(self.final_name(child), self._new_root, child)
251
 
 
252
 
        # Ensure old_new_root has no directory.
253
 
        if old_new_root in self._new_contents:
254
 
            self.cancel_creation(old_new_root)
255
 
        else:
256
 
            self.delete_contents(old_new_root)
257
 
 
258
 
        # prevent deletion of root directory.
259
 
        if self._new_root in self._removed_contents:
260
 
            self.cancel_deletion(self._new_root)
261
 
 
262
 
        # destroy path info for old_new_root.
263
 
        del self._new_parent[old_new_root]
264
 
        del self._new_name[old_new_root]
265
 
 
266
255
    def trans_id_tree_file_id(self, inventory_id):
267
256
        """Determine the transaction id of a working tree file.
268
 
 
 
257
        
269
258
        This reflects only files that already exist, not ones that will be
270
259
        added by transactions.
271
260
        """
272
 
        if inventory_id is None:
273
 
            raise ValueError('None is not a valid file id')
274
261
        path = self._tree.id2path(inventory_id)
275
262
        return self.trans_id_tree_path(path)
276
263
 
280
267
        a transaction has been unversioned, it is deliberately still returned.
281
268
        (this will likely lead to an unversioned parent conflict.)
282
269
        """
283
 
        if file_id is None:
284
 
            raise ValueError('None is not a valid file id')
285
270
        if file_id in self._r_new_id and self._r_new_id[file_id] is not None:
286
271
            return self._r_new_id[file_id]
287
 
        else:
288
 
            try:
289
 
                self._tree.iter_entries_by_dir([file_id]).next()
290
 
            except StopIteration:
291
 
                if file_id in self._non_present_ids:
292
 
                    return self._non_present_ids[file_id]
293
 
                else:
294
 
                    trans_id = self._assign_id()
295
 
                    self._non_present_ids[file_id] = trans_id
296
 
                    return trans_id
297
 
            else:
298
 
                return self.trans_id_tree_file_id(file_id)
 
272
        elif file_id in self._tree.inventory:
 
273
            return self.trans_id_tree_file_id(file_id)
 
274
        elif file_id in self._non_present_ids:
 
275
            return self._non_present_ids[file_id]
 
276
        else:
 
277
            trans_id = self._assign_id()
 
278
            self._non_present_ids[file_id] = trans_id
 
279
            return trans_id
 
280
 
 
281
    def canonical_path(self, path):
 
282
        """Get the canonical tree-relative path"""
 
283
        # don't follow final symlinks
 
284
        abs = self._tree.abspath(path)
 
285
        if abs in self._relpaths:
 
286
            return self._relpaths[abs]
 
287
        dirname, basename = os.path.split(abs)
 
288
        if dirname not in self._realpaths:
 
289
            self._realpaths[dirname] = os.path.realpath(dirname)
 
290
        dirname = self._realpaths[dirname]
 
291
        abs = pathjoin(dirname, basename)
 
292
        if dirname in self._relpaths:
 
293
            relpath = pathjoin(self._relpaths[dirname], basename)
 
294
            relpath = relpath.rstrip('/\\')
 
295
        else:
 
296
            relpath = self._tree.relpath(abs)
 
297
        self._relpaths[abs] = relpath
 
298
        return relpath
299
299
 
300
300
    def trans_id_tree_path(self, path):
301
301
        """Determine (and maybe set) the transaction ID for a tree path."""
312
312
            return ROOT_PARENT
313
313
        return self.trans_id_tree_path(os.path.dirname(path))
314
314
 
 
315
    def create_file(self, contents, trans_id, mode_id=None):
 
316
        """Schedule creation of a new file.
 
317
 
 
318
        See also new_file.
 
319
        
 
320
        Contents is an iterator of strings, all of which will be written
 
321
        to the target destination.
 
322
 
 
323
        New file takes the permissions of any existing file with that id,
 
324
        unless mode_id is specified.
 
325
        """
 
326
        name = self._limbo_name(trans_id)
 
327
        f = open(name, 'wb')
 
328
        try:
 
329
            try:
 
330
                unique_add(self._new_contents, trans_id, 'file')
 
331
            except:
 
332
                # Clean up the file, it never got registered so
 
333
                # TreeTransform.finalize() won't clean it up.
 
334
                f.close()
 
335
                os.unlink(name)
 
336
                raise
 
337
 
 
338
            f.writelines(contents)
 
339
        finally:
 
340
            f.close()
 
341
        self._set_mode(trans_id, mode_id, S_ISREG)
 
342
 
 
343
    def _set_mode(self, trans_id, mode_id, typefunc):
 
344
        """Set the mode of new file contents.
 
345
        The mode_id is the existing file to get the mode from (often the same
 
346
        as trans_id).  The operation is only performed if there's a mode match
 
347
        according to typefunc.
 
348
        """
 
349
        if mode_id is None:
 
350
            mode_id = trans_id
 
351
        try:
 
352
            old_path = self._tree_id_paths[mode_id]
 
353
        except KeyError:
 
354
            return
 
355
        try:
 
356
            mode = os.stat(self._tree.abspath(old_path)).st_mode
 
357
        except OSError, e:
 
358
            if e.errno in (errno.ENOENT, errno.ENOTDIR):
 
359
                # Either old_path doesn't exist, or the parent of the
 
360
                # target is not a directory (but will be one eventually)
 
361
                # Either way, we know it doesn't exist *right now*
 
362
                # See also bug #248448
 
363
                return
 
364
            else:
 
365
                raise
 
366
        if typefunc(mode):
 
367
            os.chmod(self._limbo_name(trans_id), mode)
 
368
 
 
369
    def create_hardlink(self, path, trans_id):
 
370
        """Schedule creation of a hard link"""
 
371
        name = self._limbo_name(trans_id)
 
372
        try:
 
373
            os.link(path, name)
 
374
        except OSError, e:
 
375
            if e.errno != errno.EPERM:
 
376
                raise
 
377
            raise errors.HardLinkNotSupported(path)
 
378
        try:
 
379
            unique_add(self._new_contents, trans_id, 'file')
 
380
        except:
 
381
            # Clean up the file, it never got registered so
 
382
            # TreeTransform.finalize() won't clean it up.
 
383
            os.unlink(name)
 
384
            raise
 
385
 
 
386
    def create_directory(self, trans_id):
 
387
        """Schedule creation of a new directory.
 
388
        
 
389
        See also new_directory.
 
390
        """
 
391
        os.mkdir(self._limbo_name(trans_id))
 
392
        unique_add(self._new_contents, trans_id, 'directory')
 
393
 
 
394
    def create_symlink(self, target, trans_id):
 
395
        """Schedule creation of a new symbolic link.
 
396
 
 
397
        target is a bytestring.
 
398
        See also new_symlink.
 
399
        """
 
400
        if has_symlinks():
 
401
            os.symlink(target, self._limbo_name(trans_id))
 
402
            unique_add(self._new_contents, trans_id, 'symlink')
 
403
        else:
 
404
            try:
 
405
                path = FinalPaths(self).get_path(trans_id)
 
406
            except KeyError:
 
407
                path = None
 
408
            raise UnableCreateSymlink(path=path)
 
409
 
 
410
    def cancel_creation(self, trans_id):
 
411
        """Cancel the creation of new file contents."""
 
412
        del self._new_contents[trans_id]
 
413
        children = self._limbo_children.get(trans_id)
 
414
        # if this is a limbo directory with children, move them before removing
 
415
        # the directory
 
416
        if children is not None:
 
417
            self._rename_in_limbo(children)
 
418
            del self._limbo_children[trans_id]
 
419
            del self._limbo_children_names[trans_id]
 
420
        delete_any(self._limbo_name(trans_id))
 
421
 
315
422
    def delete_contents(self, trans_id):
316
423
        """Schedule the contents of a path entry for deletion"""
317
 
        # Ensure that the object exists in the WorkingTree, this will raise an
318
 
        # exception if there is a problem
319
424
        self.tree_kind(trans_id)
320
425
        self._removed_contents.add(trans_id)
321
426
 
393
498
        new_ids.update(changed_kind)
394
499
        return sorted(FinalPaths(self).get_paths(new_ids))
395
500
 
 
501
    def tree_kind(self, trans_id):
 
502
        """Determine the file kind in the working tree.
 
503
 
 
504
        Raises NoSuchFile if the file does not exist
 
505
        """
 
506
        path = self._tree_id_paths.get(trans_id)
 
507
        if path is None:
 
508
            raise NoSuchFile(None)
 
509
        try:
 
510
            return file_kind(self._tree.abspath(path))
 
511
        except OSError, e:
 
512
            if e.errno != errno.ENOENT:
 
513
                raise
 
514
            else:
 
515
                raise NoSuchFile(path)
 
516
 
396
517
    def final_kind(self, trans_id):
397
518
        """Determine the final file kind, after any changes applied.
398
 
 
 
519
        
399
520
        Raises NoSuchFile if the file does not exist/has no contents.
400
521
        (It is conceivable that a path would be created without the
401
522
        corresponding contents insertion command)
417
538
        # the file is old; the old id is still valid
418
539
        if self._new_root == trans_id:
419
540
            return self._tree.get_root_id()
420
 
        return self._tree.path2id(path)
 
541
        return self._tree.inventory.path2id(path)
421
542
 
422
543
    def final_file_id(self, trans_id):
423
544
        """Determine the file id after any changes are applied, or None.
424
 
 
 
545
        
425
546
        None indicates that the file will not be versioned after changes are
426
547
        applied.
427
548
        """
466
587
 
467
588
    def by_parent(self):
468
589
        """Return a map of parent: children for known parents.
469
 
 
 
590
        
470
591
        Only new paths and parents of tree files with assigned ids are used.
471
592
        """
472
593
        by_parent = {}
473
594
        items = list(self._new_parent.iteritems())
474
 
        items.extend((t, self.final_parent(t)) for t in
 
595
        items.extend((t, self.final_parent(t)) for t in 
475
596
                      self._tree_id_paths.keys())
476
597
        for trans_id, parent_id in items:
477
598
            if parent_id not in by_parent:
505
626
        conflicts.extend(self._overwrite_conflicts())
506
627
        return conflicts
507
628
 
508
 
    def _check_malformed(self):
509
 
        conflicts = self.find_conflicts()
510
 
        if len(conflicts) != 0:
511
 
            raise MalformedTransform(conflicts=conflicts)
512
 
 
513
629
    def _add_tree_children(self):
514
630
        """Add all the children of all active parents to the known paths.
515
631
 
517
633
        removed.  This is a necessary first step in detecting conflicts.
518
634
        """
519
635
        parents = self.by_parent().keys()
520
 
        parents.extend([t for t in self._removed_contents if
 
636
        parents.extend([t for t in self._removed_contents if 
521
637
                        self.tree_kind(t) == 'directory'])
522
638
        for trans_id in self._removed_id:
523
639
            file_id = self.tree_file_id(trans_id)
531
647
            # ensure that all children are registered with the transaction
532
648
            list(self.iter_tree_children(parent_id))
533
649
 
 
650
    def iter_tree_children(self, parent_id):
 
651
        """Iterate through the entry's tree children, if any"""
 
652
        try:
 
653
            path = self._tree_id_paths[parent_id]
 
654
        except KeyError:
 
655
            return
 
656
        try:
 
657
            children = os.listdir(self._tree.abspath(path))
 
658
        except OSError, e:
 
659
            if not (osutils._is_error_enotdir(e)
 
660
                    or e.errno in (errno.ENOENT, errno.ESRCH)):
 
661
                raise
 
662
            return
 
663
 
 
664
        for child in children:
 
665
            childpath = joinpath(path, child)
 
666
            if self._tree.is_control_filename(childpath):
 
667
                continue
 
668
            yield self.trans_id_tree_path(childpath)
 
669
 
534
670
    def has_named_child(self, by_parent, parent_id, name):
535
671
        try:
536
672
            children = by_parent[parent_id]
590
726
 
591
727
    def _improper_versioning(self):
592
728
        """Cannot version a file with no contents, or a bad type.
593
 
 
 
729
        
594
730
        However, existing entries with no contents are okay.
595
731
        """
596
732
        conflicts = []
606
742
 
607
743
    def _executability_conflicts(self):
608
744
        """Check for bad executability changes.
609
 
 
 
745
        
610
746
        Only versioned files may have their executability set, because
611
747
        1. only versioned entries can have executability under windows
612
748
        2. only files can be executable.  (The execute bit on a directory
711
847
            return True
712
848
        return False
713
849
 
 
850
    def _limbo_name(self, trans_id):
 
851
        """Generate the limbo name of a file"""
 
852
        limbo_name = self._limbo_files.get(trans_id)
 
853
        if limbo_name is not None:
 
854
            return limbo_name
 
855
        parent = self._new_parent.get(trans_id)
 
856
        # if the parent directory is already in limbo (e.g. when building a
 
857
        # tree), choose a limbo name inside the parent, to reduce further
 
858
        # renames.
 
859
        use_direct_path = False
 
860
        if self._new_contents.get(parent) == 'directory':
 
861
            filename = self._new_name.get(trans_id)
 
862
            if filename is not None:
 
863
                if parent not in self._limbo_children:
 
864
                    self._limbo_children[parent] = set()
 
865
                    self._limbo_children_names[parent] = {}
 
866
                    use_direct_path = True
 
867
                # the direct path can only be used if no other file has
 
868
                # already taken this pathname, i.e. if the name is unused, or
 
869
                # if it is already associated with this trans_id.
 
870
                elif self._case_sensitive_target:
 
871
                    if (self._limbo_children_names[parent].get(filename)
 
872
                        in (trans_id, None)):
 
873
                        use_direct_path = True
 
874
                else:
 
875
                    for l_filename, l_trans_id in\
 
876
                        self._limbo_children_names[parent].iteritems():
 
877
                        if l_trans_id == trans_id:
 
878
                            continue
 
879
                        if l_filename.lower() == filename.lower():
 
880
                            break
 
881
                    else:
 
882
                        use_direct_path = True
 
883
 
 
884
        if use_direct_path:
 
885
            limbo_name = pathjoin(self._limbo_files[parent], filename)
 
886
            self._limbo_children[parent].add(trans_id)
 
887
            self._limbo_children_names[parent][filename] = trans_id
 
888
        else:
 
889
            limbo_name = pathjoin(self._limbodir, trans_id)
 
890
            self._needs_rename.add(trans_id)
 
891
        self._limbo_files[trans_id] = limbo_name
 
892
        return limbo_name
 
893
 
714
894
    def _set_executability(self, path, trans_id):
715
895
        """Set the executability of versioned files """
716
896
        if supports_executable():
737
917
            self.version_file(file_id, trans_id)
738
918
        return trans_id
739
919
 
740
 
    def new_file(self, name, parent_id, contents, file_id=None,
 
920
    def new_file(self, name, parent_id, contents, file_id=None, 
741
921
                 executable=None):
742
922
        """Convenience method to create files.
743
 
 
 
923
        
744
924
        name is the name of the file to create.
745
925
        parent_id is the transaction id of the parent directory of the file.
746
926
        contents is an iterator of bytestrings, which will be used to produce
766
946
        """
767
947
        trans_id = self._new_entry(name, parent_id, file_id)
768
948
        self.create_directory(trans_id)
769
 
        return trans_id
 
949
        return trans_id 
770
950
 
771
951
    def new_symlink(self, name, parent_id, target, file_id=None):
772
952
        """Convenience method to create symbolic link.
773
 
 
 
953
        
774
954
        name is the name of the symlink to create.
775
955
        parent_id is the transaction id of the parent directory of the symlink.
776
956
        target is a bytestring of the target of the symlink.
815
995
        from_path = self._tree_id_paths.get(from_trans_id)
816
996
        if from_versioned:
817
997
            # get data from working tree if versioned
818
 
            from_entry = self._tree.iter_entries_by_dir([file_id]).next()[1]
 
998
            from_entry = self._tree.inventory[file_id]
819
999
            from_name = from_entry.name
820
1000
            from_parent = from_entry.parent_id
821
1001
        else:
922
1102
    def get_preview_tree(self):
923
1103
        """Return a tree representing the result of the transform.
924
1104
 
925
 
        The tree is a snapshot, and altering the TreeTransform will invalidate
926
 
        it.
 
1105
        This tree only supports the subset of Tree functionality required
 
1106
        by show_diff_trees.  It must only be compared to tt._tree.
927
1107
        """
928
1108
        return _PreviewTree(self)
929
1109
 
930
 
    def commit(self, branch, message, merge_parents=None, strict=False):
931
 
        """Commit the result of this TreeTransform to a branch.
932
 
 
933
 
        :param branch: The branch to commit to.
934
 
        :param message: The message to attach to the commit.
935
 
        :param merge_parents: Additional parents specified by pending merges.
936
 
        :return: The revision_id of the revision committed.
937
 
        """
938
 
        self._check_malformed()
939
 
        if strict:
940
 
            unversioned = set(self._new_contents).difference(set(self._new_id))
941
 
            for trans_id in unversioned:
942
 
                if self.final_file_id(trans_id) is None:
943
 
                    raise errors.StrictCommitFailed()
944
 
 
945
 
        revno, last_rev_id = branch.last_revision_info()
946
 
        if last_rev_id == _mod_revision.NULL_REVISION:
947
 
            if merge_parents is not None:
948
 
                raise ValueError('Cannot supply merge parents for first'
949
 
                                 ' commit.')
950
 
            parent_ids = []
951
 
        else:
952
 
            parent_ids = [last_rev_id]
953
 
            if merge_parents is not None:
954
 
                parent_ids.extend(merge_parents)
955
 
        if self._tree.get_revision_id() != last_rev_id:
956
 
            raise ValueError('TreeTransform not based on branch basis: %s' %
957
 
                             self._tree.get_revision_id())
958
 
        builder = branch.get_commit_builder(parent_ids)
959
 
        preview = self.get_preview_tree()
960
 
        list(builder.record_iter_changes(preview, last_rev_id,
961
 
                                         self.iter_changes()))
962
 
        builder.finish_inventory()
963
 
        revision_id = builder.commit(message)
964
 
        branch.set_last_revision_info(revno + 1, revision_id)
965
 
        return revision_id
966
 
 
967
 
    def _text_parent(self, trans_id):
968
 
        file_id = self.tree_file_id(trans_id)
969
 
        try:
970
 
            if file_id is None or self._tree.kind(file_id) != 'file':
971
 
                return None
972
 
        except errors.NoSuchFile:
973
 
            return None
974
 
        return file_id
975
 
 
976
 
    def _get_parents_texts(self, trans_id):
977
 
        """Get texts for compression parents of this file."""
978
 
        file_id = self._text_parent(trans_id)
979
 
        if file_id is None:
980
 
            return ()
981
 
        return (self._tree.get_file_text(file_id),)
982
 
 
983
 
    def _get_parents_lines(self, trans_id):
984
 
        """Get lines for compression parents of this file."""
985
 
        file_id = self._text_parent(trans_id)
986
 
        if file_id is None:
987
 
            return ()
988
 
        return (self._tree.get_file_lines(file_id),)
989
 
 
990
 
    def serialize(self, serializer):
991
 
        """Serialize this TreeTransform.
992
 
 
993
 
        :param serializer: A Serialiser like pack.ContainerSerializer.
994
 
        """
995
 
        new_name = dict((k, v.encode('utf-8')) for k, v in
996
 
                        self._new_name.items())
997
 
        new_executability = dict((k, int(v)) for k, v in
998
 
                                 self._new_executability.items())
999
 
        tree_path_ids = dict((k.encode('utf-8'), v)
1000
 
                             for k, v in self._tree_path_ids.items())
1001
 
        attribs = {
1002
 
            '_id_number': self._id_number,
1003
 
            '_new_name': new_name,
1004
 
            '_new_parent': self._new_parent,
1005
 
            '_new_executability': new_executability,
1006
 
            '_new_id': self._new_id,
1007
 
            '_tree_path_ids': tree_path_ids,
1008
 
            '_removed_id': list(self._removed_id),
1009
 
            '_removed_contents': list(self._removed_contents),
1010
 
            '_non_present_ids': self._non_present_ids,
1011
 
            }
1012
 
        yield serializer.bytes_record(bencode.bencode(attribs),
1013
 
                                      (('attribs',),))
1014
 
        for trans_id, kind in self._new_contents.items():
1015
 
            if kind == 'file':
1016
 
                lines = osutils.chunks_to_lines(
1017
 
                    self._read_file_chunks(trans_id))
1018
 
                parents = self._get_parents_lines(trans_id)
1019
 
                mpdiff = multiparent.MultiParent.from_lines(lines, parents)
1020
 
                content = ''.join(mpdiff.to_patch())
1021
 
            if kind == 'directory':
1022
 
                content = ''
1023
 
            if kind == 'symlink':
1024
 
                content = self._read_symlink_target(trans_id)
1025
 
            yield serializer.bytes_record(content, ((trans_id, kind),))
1026
 
 
1027
 
    def deserialize(self, records):
1028
 
        """Deserialize a stored TreeTransform.
1029
 
 
1030
 
        :param records: An iterable of (names, content) tuples, as per
1031
 
            pack.ContainerPushParser.
1032
 
        """
1033
 
        names, content = records.next()
1034
 
        attribs = bencode.bdecode(content)
1035
 
        self._id_number = attribs['_id_number']
1036
 
        self._new_name = dict((k, v.decode('utf-8'))
1037
 
                            for k, v in attribs['_new_name'].items())
1038
 
        self._new_parent = attribs['_new_parent']
1039
 
        self._new_executability = dict((k, bool(v)) for k, v in
1040
 
            attribs['_new_executability'].items())
1041
 
        self._new_id = attribs['_new_id']
1042
 
        self._r_new_id = dict((v, k) for k, v in self._new_id.items())
1043
 
        self._tree_path_ids = {}
1044
 
        self._tree_id_paths = {}
1045
 
        for bytepath, trans_id in attribs['_tree_path_ids'].items():
1046
 
            path = bytepath.decode('utf-8')
1047
 
            self._tree_path_ids[path] = trans_id
1048
 
            self._tree_id_paths[trans_id] = path
1049
 
        self._removed_id = set(attribs['_removed_id'])
1050
 
        self._removed_contents = set(attribs['_removed_contents'])
1051
 
        self._non_present_ids = attribs['_non_present_ids']
1052
 
        for ((trans_id, kind),), content in records:
1053
 
            if kind == 'file':
1054
 
                mpdiff = multiparent.MultiParent.from_patch(content)
1055
 
                lines = mpdiff.to_lines(self._get_parents_texts(trans_id))
1056
 
                self.create_file(lines, trans_id)
1057
 
            if kind == 'directory':
1058
 
                self.create_directory(trans_id)
1059
 
            if kind == 'symlink':
1060
 
                self.create_symlink(content.decode('utf-8'), trans_id)
1061
 
 
1062
 
 
1063
 
class DiskTreeTransform(TreeTransformBase):
1064
 
    """Tree transform storing its contents on disk."""
1065
 
 
1066
 
    def __init__(self, tree, limbodir, pb=None,
1067
 
                 case_sensitive=True):
1068
 
        """Constructor.
1069
 
        :param tree: The tree that will be transformed, but not necessarily
1070
 
            the output tree.
1071
 
        :param limbodir: A directory where new files can be stored until
1072
 
            they are installed in their proper places
1073
 
        :param pb: ignored
1074
 
        :param case_sensitive: If True, the target of the transform is
1075
 
            case sensitive, not just case preserving.
1076
 
        """
1077
 
        TreeTransformBase.__init__(self, tree, pb, case_sensitive)
1078
 
        self._limbodir = limbodir
1079
 
        self._deletiondir = None
1080
 
        # A mapping of transform ids to their limbo filename
1081
 
        self._limbo_files = {}
1082
 
        # A mapping of transform ids to a set of the transform ids of children
1083
 
        # that their limbo directory has
1084
 
        self._limbo_children = {}
1085
 
        # Map transform ids to maps of child filename to child transform id
1086
 
        self._limbo_children_names = {}
1087
 
        # List of transform ids that need to be renamed from limbo into place
1088
 
        self._needs_rename = set()
1089
 
        self._creation_mtime = None
1090
 
 
1091
 
    def finalize(self):
1092
 
        """Release the working tree lock, if held, clean up limbo dir.
1093
 
 
1094
 
        This is required if apply has not been invoked, but can be invoked
1095
 
        even after apply.
1096
 
        """
1097
 
        if self._tree is None:
1098
 
            return
1099
 
        try:
1100
 
            entries = [(self._limbo_name(t), t, k) for t, k in
1101
 
                       self._new_contents.iteritems()]
1102
 
            entries.sort(reverse=True)
1103
 
            for path, trans_id, kind in entries:
1104
 
                delete_any(path)
1105
 
            try:
1106
 
                delete_any(self._limbodir)
1107
 
            except OSError:
1108
 
                # We don't especially care *why* the dir is immortal.
1109
 
                raise ImmortalLimbo(self._limbodir)
1110
 
            try:
1111
 
                if self._deletiondir is not None:
1112
 
                    delete_any(self._deletiondir)
1113
 
            except OSError:
1114
 
                raise errors.ImmortalPendingDeletion(self._deletiondir)
1115
 
        finally:
1116
 
            TreeTransformBase.finalize(self)
1117
 
 
1118
 
    def _limbo_name(self, trans_id):
1119
 
        """Generate the limbo name of a file"""
1120
 
        limbo_name = self._limbo_files.get(trans_id)
1121
 
        if limbo_name is None:
1122
 
            limbo_name = self._generate_limbo_path(trans_id)
1123
 
            self._limbo_files[trans_id] = limbo_name
1124
 
        return limbo_name
1125
 
 
1126
 
    def _generate_limbo_path(self, trans_id):
1127
 
        """Generate a limbo path using the trans_id as the relative path.
1128
 
 
1129
 
        This is suitable as a fallback, and when the transform should not be
1130
 
        sensitive to the path encoding of the limbo directory.
1131
 
        """
1132
 
        self._needs_rename.add(trans_id)
1133
 
        return pathjoin(self._limbodir, trans_id)
1134
 
 
1135
 
    def adjust_path(self, name, parent, trans_id):
1136
 
        previous_parent = self._new_parent.get(trans_id)
1137
 
        previous_name = self._new_name.get(trans_id)
1138
 
        TreeTransformBase.adjust_path(self, name, parent, trans_id)
1139
 
        if (trans_id in self._limbo_files and
1140
 
            trans_id not in self._needs_rename):
1141
 
            self._rename_in_limbo([trans_id])
1142
 
            if previous_parent != parent:
1143
 
                self._limbo_children[previous_parent].remove(trans_id)
1144
 
            if previous_parent != parent or previous_name != name:
1145
 
                del self._limbo_children_names[previous_parent][previous_name]
1146
 
 
1147
 
    def _rename_in_limbo(self, trans_ids):
1148
 
        """Fix limbo names so that the right final path is produced.
1149
 
 
1150
 
        This means we outsmarted ourselves-- we tried to avoid renaming
1151
 
        these files later by creating them with their final names in their
1152
 
        final parents.  But now the previous name or parent is no longer
1153
 
        suitable, so we have to rename them.
1154
 
 
1155
 
        Even for trans_ids that have no new contents, we must remove their
1156
 
        entries from _limbo_files, because they are now stale.
1157
 
        """
1158
 
        for trans_id in trans_ids:
1159
 
            old_path = self._limbo_files.pop(trans_id)
1160
 
            if trans_id not in self._new_contents:
1161
 
                continue
1162
 
            new_path = self._limbo_name(trans_id)
1163
 
            osutils.rename(old_path, new_path)
1164
 
            for descendant in self._limbo_descendants(trans_id):
1165
 
                desc_path = self._limbo_files[descendant]
1166
 
                desc_path = new_path + desc_path[len(old_path):]
1167
 
                self._limbo_files[descendant] = desc_path
1168
 
 
1169
 
    def _limbo_descendants(self, trans_id):
1170
 
        """Return the set of trans_ids whose limbo paths descend from this."""
1171
 
        descendants = set(self._limbo_children.get(trans_id, []))
1172
 
        for descendant in list(descendants):
1173
 
            descendants.update(self._limbo_descendants(descendant))
1174
 
        return descendants
1175
 
 
1176
 
    def create_file(self, contents, trans_id, mode_id=None):
1177
 
        """Schedule creation of a new file.
1178
 
 
1179
 
        See also new_file.
1180
 
 
1181
 
        Contents is an iterator of strings, all of which will be written
1182
 
        to the target destination.
1183
 
 
1184
 
        New file takes the permissions of any existing file with that id,
1185
 
        unless mode_id is specified.
1186
 
        """
1187
 
        name = self._limbo_name(trans_id)
1188
 
        f = open(name, 'wb')
1189
 
        try:
1190
 
            try:
1191
 
                unique_add(self._new_contents, trans_id, 'file')
1192
 
            except:
1193
 
                # Clean up the file, it never got registered so
1194
 
                # TreeTransform.finalize() won't clean it up.
1195
 
                f.close()
1196
 
                os.unlink(name)
1197
 
                raise
1198
 
 
1199
 
            f.writelines(contents)
1200
 
        finally:
1201
 
            f.close()
1202
 
        self._set_mtime(name)
1203
 
        self._set_mode(trans_id, mode_id, S_ISREG)
1204
 
 
1205
 
    def _read_file_chunks(self, trans_id):
1206
 
        cur_file = open(self._limbo_name(trans_id), 'rb')
1207
 
        try:
1208
 
            return cur_file.readlines()
1209
 
        finally:
1210
 
            cur_file.close()
1211
 
 
1212
 
    def _read_symlink_target(self, trans_id):
1213
 
        return os.readlink(self._limbo_name(trans_id))
1214
 
 
1215
 
    def _set_mtime(self, path):
1216
 
        """All files that are created get the same mtime.
1217
 
 
1218
 
        This time is set by the first object to be created.
1219
 
        """
1220
 
        if self._creation_mtime is None:
1221
 
            self._creation_mtime = time.time()
1222
 
        os.utime(path, (self._creation_mtime, self._creation_mtime))
1223
 
 
1224
 
    def create_hardlink(self, path, trans_id):
1225
 
        """Schedule creation of a hard link"""
1226
 
        name = self._limbo_name(trans_id)
1227
 
        try:
1228
 
            os.link(path, name)
1229
 
        except OSError, e:
1230
 
            if e.errno != errno.EPERM:
1231
 
                raise
1232
 
            raise errors.HardLinkNotSupported(path)
1233
 
        try:
1234
 
            unique_add(self._new_contents, trans_id, 'file')
1235
 
        except:
1236
 
            # Clean up the file, it never got registered so
1237
 
            # TreeTransform.finalize() won't clean it up.
1238
 
            os.unlink(name)
1239
 
            raise
1240
 
 
1241
 
    def create_directory(self, trans_id):
1242
 
        """Schedule creation of a new directory.
1243
 
 
1244
 
        See also new_directory.
1245
 
        """
1246
 
        os.mkdir(self._limbo_name(trans_id))
1247
 
        unique_add(self._new_contents, trans_id, 'directory')
1248
 
 
1249
 
    def create_symlink(self, target, trans_id):
1250
 
        """Schedule creation of a new symbolic link.
1251
 
 
1252
 
        target is a bytestring.
1253
 
        See also new_symlink.
1254
 
        """
1255
 
        if has_symlinks():
1256
 
            os.symlink(target, self._limbo_name(trans_id))
1257
 
            unique_add(self._new_contents, trans_id, 'symlink')
1258
 
        else:
1259
 
            try:
1260
 
                path = FinalPaths(self).get_path(trans_id)
1261
 
            except KeyError:
1262
 
                path = None
1263
 
            raise UnableCreateSymlink(path=path)
1264
 
 
1265
 
    def cancel_creation(self, trans_id):
1266
 
        """Cancel the creation of new file contents."""
1267
 
        del self._new_contents[trans_id]
1268
 
        children = self._limbo_children.get(trans_id)
1269
 
        # if this is a limbo directory with children, move them before removing
1270
 
        # the directory
1271
 
        if children is not None:
1272
 
            self._rename_in_limbo(children)
1273
 
            del self._limbo_children[trans_id]
1274
 
            del self._limbo_children_names[trans_id]
1275
 
        delete_any(self._limbo_name(trans_id))
1276
 
 
1277
 
 
1278
 
class TreeTransform(DiskTreeTransform):
 
1110
 
 
1111
class TreeTransform(TreeTransformBase):
1279
1112
    """Represent a tree transformation.
1280
1113
 
1281
1114
    This object is designed to support incremental generation of the transform,
1340
1173
    FileMover does not delete files until it is sure that a rollback will not
1341
1174
    happen.
1342
1175
    """
1343
 
    def __init__(self, tree, pb=None):
 
1176
    def __init__(self, tree, pb=DummyProgress()):
1344
1177
        """Note: a tree_write lock is taken on the tree.
1345
1178
 
1346
1179
        Use TreeTransform.finalize() to release the lock (can be omitted if
1367
1200
            tree.unlock()
1368
1201
            raise
1369
1202
 
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,
 
1203
        TreeTransformBase.__init__(self, tree, limbodir, pb,
1375
1204
                                   tree.case_sensitive)
1376
1205
        self._deletiondir = deletiondir
1377
1206
 
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
1207
    def apply(self, no_conflicts=False, precomputed_delta=None, _mover=None):
1508
1208
        """Apply all changes to the inventory and filesystem.
1509
1209
 
1519
1219
        :param _mover: Supply an alternate FileMover, for testing
1520
1220
        """
1521
1221
        if not no_conflicts:
1522
 
            self._check_malformed()
 
1222
            conflicts = self.find_conflicts()
 
1223
            if len(conflicts) != 0:
 
1224
                raise MalformedTransform(conflicts=conflicts)
1523
1225
        child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1524
1226
        try:
1525
1227
            if precomputed_delta is None:
1622
1324
        """
1623
1325
        tree_paths = list(self._tree_path_ids.iteritems())
1624
1326
        tree_paths.sort(reverse=True)
 
1327
        kind_changes = set()
1625
1328
        child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1626
1329
        try:
1627
1330
            for num, data in enumerate(tree_paths):
1629
1332
                child_pb.update('removing file', num, len(tree_paths))
1630
1333
                full_path = self._tree.abspath(path)
1631
1334
                if trans_id in self._removed_contents:
1632
 
                    delete_path = os.path.join(self._deletiondir, trans_id)
1633
 
                    mover.pre_delete(full_path, delete_path)
1634
 
                elif (trans_id in self._new_name
1635
 
                      or trans_id in self._new_parent):
 
1335
                    mover.pre_delete(full_path, os.path.join(self._deletiondir,
 
1336
                                     trans_id))
 
1337
                elif trans_id in self._new_name or trans_id in \
 
1338
                    self._new_parent:
1636
1339
                    try:
1637
1340
                        mover.rename(full_path, self._limbo_name(trans_id))
1638
1341
                    except OSError, e:
1642
1345
                        self.rename_count += 1
1643
1346
        finally:
1644
1347
            child_pb.finished()
 
1348
        return kind_changes
1645
1349
 
1646
1350
    def _apply_insertions(self, mover):
1647
1351
        """Perform tree operations that insert directory/inventory names.
1652
1356
 
1653
1357
        If inventory_delta is None, no inventory delta is calculated, and
1654
1358
        no list of modified paths is returned.
 
1359
 
 
1360
        kind_changes is a set of trans ids where the entry has changed
 
1361
        kind, and so an inventory delta entry should be created for them.
1655
1362
        """
1656
1363
        new_paths = self.new_paths(filesystem_only=True)
1657
1364
        modified_paths = []
1684
1391
        return modified_paths
1685
1392
 
1686
1393
 
1687
 
class TransformPreview(DiskTreeTransform):
 
1394
class TransformPreview(TreeTransformBase):
1688
1395
    """A TreeTransform for generating preview trees.
1689
1396
 
1690
1397
    Unlike TreeTransform, this version works when the input tree is a
1692
1399
    unversioned files in the input tree.
1693
1400
    """
1694
1401
 
1695
 
    def __init__(self, tree, pb=None, case_sensitive=True):
 
1402
    def __init__(self, tree, pb=DummyProgress(), case_sensitive=True):
1696
1403
        tree.lock_read()
1697
 
        limbodir = osutils.mkdtemp(prefix='bzr-limbo-')
1698
 
        DiskTreeTransform.__init__(self, tree, limbodir, pb, case_sensitive)
 
1404
        limbodir = tempfile.mkdtemp(prefix='bzr-limbo-')
 
1405
        TreeTransformBase.__init__(self, tree, limbodir, pb, case_sensitive)
1699
1406
 
1700
1407
    def canonical_path(self, path):
1701
1408
        return path
1725
1432
        file_id = self.tree_file_id(parent_id)
1726
1433
        if file_id is None:
1727
1434
            return
1728
 
        entry = self._tree.iter_entries_by_dir([file_id]).next()[1]
1729
 
        children = getattr(entry, 'children', {})
 
1435
        children = getattr(self._tree.inventory[file_id], 'children', {})
1730
1436
        for child in children:
1731
1437
            childpath = joinpath(path, child)
1732
1438
            yield self.trans_id_tree_path(childpath)
1740
1446
        self._final_paths = FinalPaths(transform)
1741
1447
        self.__by_parent = None
1742
1448
        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())
 
1449
 
 
1450
    def _changes(self, file_id):
 
1451
        for changes in self._transform.iter_changes():
 
1452
            if changes[0] == file_id:
 
1453
                return changes
1748
1454
 
1749
1455
    def _content_change(self, file_id):
1750
1456
        """Return True if the content of this file changed"""
1751
 
        changes = self._iter_changes_cache.get(file_id)
 
1457
        changes = self._changes(file_id)
1752
1458
        # changes[2] is true if the file content changed.  See
1753
1459
        # InterTree.iter_changes.
1754
1460
        return (changes is not None and changes[2])
1788
1494
            self.__by_parent = self._transform.by_parent()
1789
1495
        return self.__by_parent
1790
1496
 
1791
 
    def _comparison_data(self, entry, path):
1792
 
        kind, size, executable, link_or_sha1 = self.path_content_summary(path)
1793
 
        if kind == 'missing':
1794
 
            kind = None
1795
 
            executable = False
1796
 
        else:
1797
 
            file_id = self._transform.final_file_id(self._path2trans_id(path))
1798
 
            executable = self.is_executable(file_id, path)
1799
 
        return kind, executable, None
1800
 
 
1801
1497
    def lock_read(self):
1802
1498
        # Perhaps in theory, this should lock the TreeTransform?
1803
1499
        pass
1823
1519
    def __iter__(self):
1824
1520
        return iter(self.all_file_ids())
1825
1521
 
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)
 
1522
    def paths2ids(self, specific_files, trees=None, require_versioned=False):
 
1523
        """See Tree.paths2ids"""
 
1524
        to_find = set(specific_files)
 
1525
        result = set()
 
1526
        for (file_id, paths, changed, versioned, parent, name, kind,
 
1527
             executable) in self._transform.iter_changes():
 
1528
            if paths[1] in to_find:
 
1529
                result.append(file_id)
 
1530
                to_find.remove(paths[1])
 
1531
        result.update(self._transform._tree.paths2ids(to_find,
 
1532
                      trees=[], require_versioned=require_versioned))
 
1533
        return result
1840
1534
 
1841
1535
    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
1536
        segments = splitpath(path)
1847
1537
        cur_parent = self._transform.root
1848
1538
        for cur_segment in segments:
1849
1539
            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:
 
1540
                if self._transform.final_name(child) == cur_segment:
1855
1541
                    cur_parent = child
1856
1542
                    break
1857
1543
            else:
1858
 
                self._path2trans_id_cache[path] = None
1859
1544
                return None
1860
 
        self._path2trans_id_cache[path] = cur_parent
1861
1545
        return cur_parent
1862
1546
 
1863
1547
    def path2id(self, path):
1871
1555
            raise errors.NoSuchId(self, file_id)
1872
1556
 
1873
1557
    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
1558
        children = set(self._transform.iter_tree_children(trans_id))
1878
1559
        # children in the _new_parent set are provided by _by_parent.
1879
1560
        children.difference_update(self._transform._new_parent.keys())
1880
1561
        children.update(self._by_parent.get(trans_id, []))
1881
 
        self._all_children_cache[trans_id] = children
1882
1562
        return children
1883
1563
 
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):
 
1564
    def _make_inv_entries(self, ordered_entries, specific_file_ids):
1900
1565
        for trans_id, parent_file_id in ordered_entries:
1901
1566
            file_id = self._transform.final_file_id(trans_id)
1902
1567
            if file_id is None:
1914
1579
                parent_file_id, file_id)
1915
1580
            yield new_entry, trans_id
1916
1581
 
1917
 
    def _list_files_by_dir(self):
 
1582
    def iter_entries_by_dir(self, specific_file_ids=None):
 
1583
        # This may not be a maximally efficient implementation, but it is
 
1584
        # reasonably straightforward.  An implementation that grafts the
 
1585
        # TreeTransform changes onto the tree's iter_entries_by_dir results
 
1586
        # might be more efficient, but requires tricky inferences about stack
 
1587
        # position.
1918
1588
        todo = [ROOT_PARENT]
1919
1589
        ordered_ids = []
1920
1590
        while len(todo) > 0:
1926
1596
            todo.extend(reversed(children))
1927
1597
            for trans_id in children:
1928
1598
                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
1599
        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
 
1600
                                                      specific_file_ids):
 
1601
            yield unicode(self._final_paths.get_path(trans_id)), entry
1977
1602
 
1978
1603
    def kind(self, file_id):
1979
1604
        trans_id = self._transform.trans_id_file_id(file_id)
1989
1614
    def get_file_mtime(self, file_id, path=None):
1990
1615
        """See Tree.get_file_mtime"""
1991
1616
        if not self._content_change(file_id):
1992
 
            return self._transform._tree.get_file_mtime(file_id)
 
1617
            return self._transform._tree.get_file_mtime(file_id, path)
1993
1618
        return self._stat_limbo_file(file_id).st_mtime
1994
1619
 
1995
 
    def _file_size(self, entry, stat_value):
1996
 
        return self.get_file_size(entry.file_id)
1997
 
 
1998
1620
    def get_file_size(self, file_id):
1999
1621
        """See Tree.get_file_size"""
2000
1622
        if self.kind(file_id) == 'file':
2003
1625
            return None
2004
1626
 
2005
1627
    def get_file_sha1(self, file_id, path=None, stat_value=None):
2006
 
        trans_id = self._transform.trans_id_file_id(file_id)
2007
 
        kind = self._transform._new_contents.get(trans_id)
2008
 
        if kind is None:
2009
 
            return self._transform._tree.get_file_sha1(file_id)
2010
 
        if kind == 'file':
2011
 
            fileobj = self.get_file(file_id)
2012
 
            try:
2013
 
                return sha_file(fileobj)
2014
 
            finally:
2015
 
                fileobj.close()
 
1628
        return self._transform._tree.get_file_sha1(file_id)
2016
1629
 
2017
1630
    def is_executable(self, file_id, path=None):
2018
 
        if file_id is None:
2019
 
            return False
2020
1631
        trans_id = self._transform.trans_id_file_id(file_id)
2021
1632
        try:
2022
1633
            return self._transform._new_executability[trans_id]
2023
1634
        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
 
1635
            return self._transform._tree.is_executable(file_id, path)
2032
1636
 
2033
1637
    def path_content_summary(self, path):
2034
1638
        trans_id = self._path2trans_id(path)
2049
1653
                statval = os.lstat(limbo_name)
2050
1654
                size = statval.st_size
2051
1655
                if not supports_executable():
2052
 
                    executable = False
 
1656
                    executable = None
2053
1657
                else:
2054
1658
                    executable = statval.st_mode & S_IEXEC
2055
1659
            else:
2056
1660
                size = None
2057
1661
                executable = None
2058
1662
            if kind == 'symlink':
2059
 
                link_or_sha1 = os.readlink(limbo_name).decode(osutils._fs_enc)
2060
 
        executable = tt._new_executability.get(trans_id, executable)
 
1663
                link_or_sha1 = os.readlink(limbo_name)
 
1664
        if supports_executable():
 
1665
            executable = tt._new_executability.get(trans_id, executable)
2061
1666
        return kind, size, executable, link_or_sha1
2062
1667
 
2063
1668
    def iter_changes(self, from_tree, include_unchanged=False,
2065
1670
                      require_versioned=True, want_unversioned=False):
2066
1671
        """See InterTree.iter_changes.
2067
1672
 
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.
 
1673
        This implementation does not support include_unchanged, specific_files,
 
1674
        or want_unversioned.  extra_trees, require_versioned, and pb are
 
1675
        ignored.
2070
1676
        """
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)
 
1677
        if from_tree is not self._transform._tree:
 
1678
            raise ValueError('from_tree must be transform source tree.')
 
1679
        if include_unchanged:
 
1680
            raise ValueError('include_unchanged is not supported')
 
1681
        if specific_files is not None:
 
1682
            raise ValueError('specific_files is not supported')
2080
1683
        if want_unversioned:
2081
1684
            raise ValueError('want_unversioned is not supported')
2082
1685
        return self._transform.iter_changes()
2089
1692
        name = self._transform._limbo_name(trans_id)
2090
1693
        return open(name, 'rb')
2091
1694
 
2092
 
    def get_file_with_stat(self, file_id, path=None):
2093
 
        return self.get_file(file_id, path), None
 
1695
    def get_file_text(self, file_id):
 
1696
        text_file = self.get_file(file_id)
 
1697
        try:
 
1698
            return text_file.read()
 
1699
        finally:
 
1700
            text_file.close()
2094
1701
 
2095
1702
    def annotate_iter(self, file_id,
2096
1703
                      default_revision=_mod_revision.CURRENT_REVISION):
2097
 
        changes = self._iter_changes_cache.get(file_id)
 
1704
        changes = self._changes(file_id)
2098
1705
        if changes is None:
2099
1706
            get_old = True
2100
1707
        else:
2112
1719
            return old_annotation
2113
1720
        if not changed_content:
2114
1721
            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
1722
        return annotate.reannotate([old_annotation],
2123
1723
                                   self.get_file(file_id).readlines(),
2124
1724
                                   default_revision)
2129
1729
            return self._transform._tree.get_symlink_target(file_id)
2130
1730
        trans_id = self._transform.trans_id_file_id(file_id)
2131
1731
        name = self._transform._limbo_name(trans_id)
2132
 
        return osutils.readlink(name)
2133
 
 
2134
 
    def walkdirs(self, prefix=''):
2135
 
        pending = [self._transform.root]
2136
 
        while len(pending) > 0:
2137
 
            parent_id = pending.pop()
2138
 
            children = []
2139
 
            subdirs = []
2140
 
            prefix = prefix.rstrip('/')
2141
 
            parent_path = self._final_paths.get_path(parent_id)
2142
 
            parent_file_id = self._transform.final_file_id(parent_id)
2143
 
            for child_id in self._all_children(parent_id):
2144
 
                path_from_root = self._final_paths.get_path(child_id)
2145
 
                basename = self._transform.final_name(child_id)
2146
 
                file_id = self._transform.final_file_id(child_id)
2147
 
                try:
2148
 
                    kind = self._transform.final_kind(child_id)
2149
 
                    versioned_kind = kind
2150
 
                except NoSuchFile:
2151
 
                    kind = 'unknown'
2152
 
                    versioned_kind = self._transform._tree.stored_kind(file_id)
2153
 
                if versioned_kind == 'directory':
2154
 
                    subdirs.append(child_id)
2155
 
                children.append((path_from_root, basename, kind, None,
2156
 
                                 file_id, versioned_kind))
2157
 
            children.sort()
2158
 
            if parent_path.startswith(prefix):
2159
 
                yield (parent_path, parent_file_id), children
2160
 
            pending.extend(sorted(subdirs, key=self._final_paths.get_path,
2161
 
                                  reverse=True))
 
1732
        return os.readlink(name)
 
1733
 
 
1734
    def list_files(self, include_root=False):
 
1735
        return self._transform._tree.list_files(include_root)
 
1736
 
 
1737
    def walkdirs(self, prefix=""):
 
1738
        return self._transform._tree.walkdirs(prefix)
2162
1739
 
2163
1740
    def get_parent_ids(self):
2164
1741
        return self._parent_ids
2190
1767
        self.transform = transform
2191
1768
 
2192
1769
    def _determine_path(self, trans_id):
2193
 
        if (trans_id == self.transform.root or trans_id == ROOT_PARENT):
 
1770
        if trans_id == self.transform.root:
2194
1771
            return ""
2195
1772
        name = self.transform.final_name(trans_id)
2196
1773
        parent_id = self.transform.final_parent(trans_id)
2220
1797
def build_tree(tree, wt, accelerator_tree=None, hardlink=False,
2221
1798
               delta_from_tree=False):
2222
1799
    """Create working tree for a branch, using a TreeTransform.
2223
 
 
 
1800
    
2224
1801
    This function should be used on empty trees, having a tree root at most.
2225
1802
    (see merge and revert functionality for working with existing trees)
2226
1803
 
2227
1804
    Existing files are handled like so:
2228
 
 
 
1805
    
2229
1806
    - Existing bzrdirs take precedence over creating new items.  They are
2230
1807
      created as '%s.diverted' % name.
2231
1808
    - Otherwise, if the content on disk matches the content we are building,
2333
1910
                    executable = tree.is_executable(file_id, tree_path)
2334
1911
                    if executable:
2335
1912
                        tt.set_executability(executable, trans_id)
2336
 
                    trans_data = (trans_id, tree_path)
2337
 
                    deferred_contents.append((file_id, trans_data))
 
1913
                    deferred_contents.append((file_id, trans_id))
2338
1914
                else:
2339
1915
                    file_trans_id[file_id] = new_by_entry(tt, entry, parent_id,
2340
1916
                                                          tree)
2371
1947
def _create_files(tt, tree, desired_files, pb, offset, accelerator_tree,
2372
1948
                  hardlink):
2373
1949
    total = len(desired_files) + offset
2374
 
    wt = tt._tree
2375
1950
    if accelerator_tree is None:
2376
1951
        new_desired_files = desired_files
2377
1952
    else:
2378
1953
        iter = accelerator_tree.iter_changes(tree, include_unchanged=True)
2379
 
        unchanged = [(f, p[1]) for (f, p, c, v, d, n, k, e)
2380
 
                     in iter if not (c or e[0] != e[1])]
2381
 
        if accelerator_tree.supports_content_filtering():
2382
 
            unchanged = [(f, p) for (f, p) in unchanged
2383
 
                         if not accelerator_tree.iter_search_rules([p]).next()]
2384
 
        unchanged = dict(unchanged)
 
1954
        unchanged = dict((f, p[1]) for (f, p, c, v, d, n, k, e)
 
1955
                         in iter if not (c or e[0] != e[1]))
2385
1956
        new_desired_files = []
2386
1957
        count = 0
2387
 
        for file_id, (trans_id, tree_path) in desired_files:
 
1958
        for file_id, trans_id in desired_files:
2388
1959
            accelerator_path = unchanged.get(file_id)
2389
1960
            if accelerator_path is None:
2390
 
                new_desired_files.append((file_id, (trans_id, tree_path)))
 
1961
                new_desired_files.append((file_id, trans_id))
2391
1962
                continue
2392
1963
            pb.update('Adding file contents', count + offset, total)
2393
1964
            if hardlink:
2395
1966
                                   trans_id)
2396
1967
            else:
2397
1968
                contents = accelerator_tree.get_file(file_id, accelerator_path)
2398
 
                if wt.supports_content_filtering():
2399
 
                    filters = wt._content_filter_stack(tree_path)
2400
 
                    contents = filtered_output_bytes(contents, filters,
2401
 
                        ContentFilterContext(tree_path, tree))
2402
1969
                try:
2403
1970
                    tt.create_file(contents, trans_id)
2404
1971
                finally:
2405
 
                    try:
2406
 
                        contents.close()
2407
 
                    except AttributeError:
2408
 
                        # after filtering, contents may no longer be file-like
2409
 
                        pass
 
1972
                    contents.close()
2410
1973
            count += 1
2411
1974
        offset += count
2412
 
    for count, ((trans_id, tree_path), contents) in enumerate(
2413
 
            tree.iter_files_bytes(new_desired_files)):
2414
 
        if wt.supports_content_filtering():
2415
 
            filters = wt._content_filter_stack(tree_path)
2416
 
            contents = filtered_output_bytes(contents, filters,
2417
 
                ContentFilterContext(tree_path, tree))
 
1975
    for count, (trans_id, contents) in enumerate(tree.iter_files_bytes(
 
1976
                                                 new_desired_files)):
2418
1977
        tt.create_file(contents, trans_id)
2419
1978
        pb.update('Adding file contents', count + offset, total)
2420
1979
 
2480
2039
    if kind == 'file':
2481
2040
        contents = tree.get_file(entry.file_id).readlines()
2482
2041
        executable = tree.is_executable(entry.file_id)
2483
 
        return tt.new_file(name, parent_id, contents, entry.file_id,
 
2042
        return tt.new_file(name, parent_id, contents, entry.file_id, 
2484
2043
                           executable)
2485
2044
    elif kind in ('directory', 'tree-reference'):
2486
2045
        trans_id = tt.new_directory(name, parent_id, entry.file_id)
2487
2046
        if kind == 'tree-reference':
2488
2047
            tt.set_tree_reference(entry.reference_revision, trans_id)
2489
 
        return trans_id
 
2048
        return trans_id 
2490
2049
    elif kind == 'symlink':
2491
2050
        target = tree.get_symlink_target(entry.file_id)
2492
2051
        return tt.new_symlink(name, parent_id, target, entry.file_id)
2494
2053
        raise errors.BadFileKindError(name, kind)
2495
2054
 
2496
2055
 
2497
 
@deprecated_function(deprecated_in((1, 9, 0)))
2498
2056
def create_by_entry(tt, entry, tree, trans_id, lines=None, mode_id=None):
2499
 
    """Create new file contents according to an inventory entry.
2500
 
 
2501
 
    DEPRECATED.  Use create_from_tree instead.
2502
 
    """
 
2057
    """Create new file contents according to an inventory entry."""
2503
2058
    if entry.kind == "file":
2504
2059
        if lines is None:
2505
2060
            lines = tree.get_file(entry.file_id).readlines()
2510
2065
        tt.create_directory(trans_id)
2511
2066
 
2512
2067
 
2513
 
def create_from_tree(tt, trans_id, tree, file_id, bytes=None,
2514
 
    filter_tree_path=None):
2515
 
    """Create new file contents according to tree contents.
2516
 
    
2517
 
    :param filter_tree_path: the tree path to use to lookup
2518
 
      content filters to apply to the bytes output in the working tree.
2519
 
      This only applies if the working tree supports content filtering.
2520
 
    """
2521
 
    kind = tree.kind(file_id)
2522
 
    if kind == 'directory':
2523
 
        tt.create_directory(trans_id)
2524
 
    elif kind == "file":
2525
 
        if bytes is None:
2526
 
            tree_file = tree.get_file(file_id)
2527
 
            try:
2528
 
                bytes = tree_file.readlines()
2529
 
            finally:
2530
 
                tree_file.close()
2531
 
        wt = tt._tree
2532
 
        if wt.supports_content_filtering() and filter_tree_path is not None:
2533
 
            filters = wt._content_filter_stack(filter_tree_path)
2534
 
            bytes = filtered_output_bytes(bytes, filters,
2535
 
                ContentFilterContext(filter_tree_path, tree))
2536
 
        tt.create_file(bytes, trans_id)
2537
 
    elif kind == "symlink":
2538
 
        tt.create_symlink(tree.get_symlink_target(file_id), trans_id)
2539
 
    else:
2540
 
        raise AssertionError('Unknown kind %r' % kind)
2541
 
 
2542
 
 
2543
2068
def create_entry_executability(tt, entry, trans_id):
2544
2069
    """Set the executability of a trans_id according to an inventory entry"""
2545
2070
    if entry.kind == "file":
2582
2107
        if entry.kind != working_kind:
2583
2108
            contents_mod, meta_mod = True, False
2584
2109
        else:
2585
 
            cur_entry._read_tree_state(working_tree.id2path(file_id),
 
2110
            cur_entry._read_tree_state(working_tree.id2path(file_id), 
2586
2111
                                       working_tree)
2587
2112
            contents_mod, meta_mod = entry.detect_changes(cur_entry)
2588
2113
            cur_entry._forget_tree_state()
2590
2115
 
2591
2116
 
2592
2117
def revert(working_tree, target_tree, filenames, backups=False,
2593
 
           pb=None, change_reporter=None):
 
2118
           pb=DummyProgress(), change_reporter=None):
2594
2119
    """Revert a working tree's contents to those of a target tree."""
2595
2120
    target_tree.lock_read()
2596
 
    pb = ui.ui_factory.nested_progress_bar()
2597
2121
    tt = TreeTransform(working_tree, pb)
2598
2122
    try:
2599
2123
        pp = ProgressPhase("Revert phase", 3, pb)
2600
 
        conflicts, merge_modified = _prepare_revert_transform(
2601
 
            working_tree, target_tree, tt, filenames, backups, pp)
 
2124
        pp.next_phase()
 
2125
        child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
2126
        try:
 
2127
            merge_modified = _alter_files(working_tree, target_tree, tt,
 
2128
                                          child_pb, filenames, backups)
 
2129
        finally:
 
2130
            child_pb.finished()
 
2131
        pp.next_phase()
 
2132
        child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
2133
        try:
 
2134
            raw_conflicts = resolve_conflicts(tt, child_pb,
 
2135
                lambda t, c: conflict_pass(t, c, target_tree))
 
2136
        finally:
 
2137
            child_pb.finished()
 
2138
        conflicts = cook_conflicts(raw_conflicts, tt)
2602
2139
        if change_reporter:
2603
2140
            change_reporter = delta._ChangeReporter(
2604
2141
                unversioned_filter=working_tree.is_ignored)
2615
2152
    return conflicts
2616
2153
 
2617
2154
 
2618
 
def _prepare_revert_transform(working_tree, target_tree, tt, filenames,
2619
 
                              backups, pp, basis_tree=None,
2620
 
                              merge_modified=None):
2621
 
    child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
2622
 
    try:
2623
 
        if merge_modified is None:
2624
 
            merge_modified = working_tree.merge_modified()
2625
 
        merge_modified = _alter_files(working_tree, target_tree, tt,
2626
 
                                      child_pb, filenames, backups,
2627
 
                                      merge_modified, basis_tree)
2628
 
    finally:
2629
 
        child_pb.finished()
2630
 
    child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
2631
 
    try:
2632
 
        raw_conflicts = resolve_conflicts(tt, child_pb,
2633
 
            lambda t, c: conflict_pass(t, c, target_tree))
2634
 
    finally:
2635
 
        child_pb.finished()
2636
 
    conflicts = cook_conflicts(raw_conflicts, tt)
2637
 
    return conflicts, merge_modified
2638
 
 
2639
 
 
2640
2155
def _alter_files(working_tree, target_tree, tt, pb, specific_files,
2641
 
                 backups, merge_modified, basis_tree=None):
2642
 
    if basis_tree is not None:
2643
 
        basis_tree.lock_read()
 
2156
                 backups):
 
2157
    merge_modified = working_tree.merge_modified()
2644
2158
    change_list = target_tree.iter_changes(working_tree,
2645
2159
        specific_files=specific_files, pb=pb)
2646
 
    if target_tree.get_root_id() is None:
 
2160
    if target_tree.inventory.root is None:
2647
2161
        skip_root = True
2648
2162
    else:
2649
2163
        skip_root = False
 
2164
    basis_tree = None
2650
2165
    try:
2651
2166
        deferred_files = []
2652
2167
        for id_num, (file_id, path, changed_content, versioned, parent, name,
2688
2203
                        # contents
2689
2204
                        mode_id = trans_id
2690
2205
                        trans_id = new_trans_id
2691
 
                if kind[1] in ('directory', 'tree-reference'):
 
2206
                if kind[1] == 'directory':
2692
2207
                    tt.create_directory(trans_id)
2693
 
                    if kind[1] == 'tree-reference':
2694
 
                        revision = target_tree.get_reference_revision(file_id,
2695
 
                                                                      path[1])
2696
 
                        tt.set_tree_reference(revision, trans_id)
2697
2208
                elif kind[1] == 'symlink':
2698
2209
                    tt.create_symlink(target_tree.get_symlink_target(file_id),
2699
2210
                                      trans_id)
2719
2230
                tt.version_file(file_id, trans_id)
2720
2231
            if versioned == (True, False):
2721
2232
                tt.unversion_file(trans_id)
2722
 
            if (name[1] is not None and
 
2233
            if (name[1] is not None and 
2723
2234
                (name[0] != name[1] or parent[0] != parent[1])):
2724
 
                if name[1] == '' and parent[1] is None:
2725
 
                    parent_trans = ROOT_PARENT
2726
 
                else:
2727
 
                    parent_trans = tt.trans_id_file_id(parent[1])
2728
 
                if parent[0] is None and versioned[0]:
2729
 
                    tt.adjust_root_path(name[1], parent_trans)
2730
 
                else:
2731
 
                    tt.adjust_path(name[1], parent_trans, trans_id)
 
2235
                tt.adjust_path(
 
2236
                    name[1], tt.trans_id_file_id(parent[1]), trans_id)
2732
2237
            if executable[0] != executable[1] and kind[1] == "file":
2733
2238
                tt.set_executability(executable[1], trans_id)
2734
 
        if working_tree.supports_content_filtering():
2735
 
            for index, ((trans_id, mode_id), bytes) in enumerate(
2736
 
                target_tree.iter_files_bytes(deferred_files)):
2737
 
                file_id = deferred_files[index][0]
2738
 
                # We're reverting a tree to the target tree so using the
2739
 
                # target tree to find the file path seems the best choice
2740
 
                # here IMO - Ian C 27/Oct/2009
2741
 
                filter_tree_path = target_tree.id2path(file_id)
2742
 
                filters = working_tree._content_filter_stack(filter_tree_path)
2743
 
                bytes = filtered_output_bytes(bytes, filters,
2744
 
                    ContentFilterContext(filter_tree_path, working_tree))
2745
 
                tt.create_file(bytes, trans_id, mode_id)
2746
 
        else:
2747
 
            for (trans_id, mode_id), bytes in target_tree.iter_files_bytes(
2748
 
                deferred_files):
2749
 
                tt.create_file(bytes, trans_id, mode_id)
2750
 
        tt.fixup_new_roots()
 
2239
        for (trans_id, mode_id), bytes in target_tree.iter_files_bytes(
 
2240
            deferred_files):
 
2241
            tt.create_file(bytes, trans_id, mode_id)
2751
2242
    finally:
2752
2243
        if basis_tree is not None:
2753
2244
            basis_tree.unlock()
2754
2245
    return merge_modified
2755
2246
 
2756
2247
 
2757
 
def resolve_conflicts(tt, pb=None, pass_func=None):
 
2248
def resolve_conflicts(tt, pb=DummyProgress(), pass_func=None):
2758
2249
    """Make many conflict-resolution attempts, but die if they fail"""
2759
2250
    if pass_func is None:
2760
2251
        pass_func = conflict_pass
2761
2252
    new_conflicts = set()
2762
 
    pb = ui.ui_factory.nested_progress_bar()
2763
2253
    try:
2764
2254
        for n in range(10):
2765
2255
            pb.update('Resolution pass', n+1, 10)
2769
2259
            new_conflicts.update(pass_func(tt, conflicts))
2770
2260
        raise MalformedTransform(conflicts=conflicts)
2771
2261
    finally:
2772
 
        pb.finished()
 
2262
        pb.clear()
2773
2263
 
2774
2264
 
2775
2265
def conflict_pass(tt, conflicts, path_tree=None):
2794
2284
                existing_file, new_file = conflict[1], conflict[2]
2795
2285
            new_name = tt.final_name(existing_file)+'.moved'
2796
2286
            tt.adjust_path(new_name, final_parent, existing_file)
2797
 
            new_conflicts.add((c_type, 'Moved existing file to',
 
2287
            new_conflicts.add((c_type, 'Moved existing file to', 
2798
2288
                               existing_file, new_file))
2799
2289
        elif c_type == 'parent loop':
2800
2290
            # break the loop by undoing one of the ops that caused the loop
2804
2294
            new_conflicts.add((c_type, 'Cancelled move', cur,
2805
2295
                               tt.final_parent(cur),))
2806
2296
            tt.adjust_path(tt.final_name(cur), tt.get_tree_parent(cur), cur)
2807
 
 
 
2297
            
2808
2298
        elif c_type == 'missing parent':
2809
2299
            trans_id = conflict[1]
2810
2300
            try:
2811
2301
                tt.cancel_deletion(trans_id)
2812
 
                new_conflicts.add(('deleting parent', 'Not deleting',
 
2302
                new_conflicts.add(('deleting parent', 'Not deleting', 
2813
2303
                                   trans_id))
2814
2304
            except KeyError:
2815
2305
                create = True
2824
2314
                        # special-case the other tree root (move its
2825
2315
                        # children to current root)
2826
2316
                        if entry.parent_id is None:
2827
 
                            create = False
 
2317
                            create=False
2828
2318
                            moved = _reparent_transform_children(
2829
2319
                                tt, trans_id, tt.root)
2830
2320
                            for child in moved:
2857
2347
            if parent_file_id is not None:
2858
2348
                tt.unversion_file(parent_id)
2859
2349
            new_conflicts.add((c_type, 'Created directory', new_parent_id))
2860
 
        elif c_type == 'versioning no contents':
2861
 
            tt.cancel_versioning(conflict[1])
2862
2350
    return new_conflicts
2863
2351
 
2864
2352
 
2880
2368
        if len(conflict) == 3:
2881
2369
            yield Conflict.factory(c_type, action=action, path=modified_path,
2882
2370
                                     file_id=modified_id)
2883
 
 
 
2371
             
2884
2372
        else:
2885
2373
            conflicting_path = fp.get_path(conflict[3])
2886
2374
            conflicting_id = tt.final_file_id(conflict[3])
2887
2375
            yield Conflict.factory(c_type, action=action, path=modified_path,
2888
 
                                   file_id=modified_id,
 
2376
                                   file_id=modified_id, 
2889
2377
                                   conflict_path=conflicting_path,
2890
2378
                                   conflict_file_id=conflicting_id)
2891
2379
 
2898
2386
        self.pending_deletions = []
2899
2387
 
2900
2388
    def rename(self, from_, to):
2901
 
        """Rename a file from one path to another."""
 
2389
        """Rename a file from one path to another.  Functions like os.rename"""
2902
2390
        try:
2903
 
            osutils.rename(from_, to)
 
2391
            os.rename(from_, to)
2904
2392
        except OSError, e:
2905
2393
            if e.errno in (errno.EEXIST, errno.ENOTEMPTY):
2906
2394
                raise errors.FileExists(to, str(e))
2920
2408
    def rollback(self):
2921
2409
        """Reverse all renames that have been performed"""
2922
2410
        for from_, to in reversed(self.past_renames):
2923
 
            osutils.rename(to, from_)
 
2411
            os.rename(to, from_)
2924
2412
        # after rollback, don't reuse _FileMover
2925
2413
        past_renames = None
2926
2414
        pending_deletions = None