~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/transform.py

  • Committer: Vincent Ladeuil
  • Date: 2010-04-26 13:51:08 UTC
  • mto: (5184.2.1 integration)
  • mto: This revision was merged to the branch mainline in revision 5185.
  • Revision ID: v.ladeuil+lp@free.fr-20100426135108-vwmfphc2xg1w058c
Random cleanups to catch up with copyright updates in trunk.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2006, 2007, 2008 Canonical Ltd
 
1
# Copyright (C) 2006-2010 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
17
17
import os
18
18
import errno
19
19
from stat import S_ISREG, S_IEXEC
 
20
import time
20
21
 
21
22
from bzrlib.lazy_import import lazy_import
22
23
lazy_import(globals(), """
23
24
from bzrlib import (
24
25
    annotate,
 
26
    bencode,
25
27
    bzrdir,
26
28
    delta,
27
29
    errors,
29
31
    multiparent,
30
32
    osutils,
31
33
    revision as _mod_revision,
 
34
    ui,
32
35
    )
33
 
from bzrlib.util import bencode
34
36
""")
35
37
from bzrlib.errors import (DuplicateKey, MalformedTransform, NoSuchFile,
36
38
                           ReusingTransform, NotVersionedError, CantMoveRoot,
48
50
    splitpath,
49
51
    supports_executable,
50
52
)
51
 
from bzrlib.progress import DummyProgress, ProgressPhase
 
53
from bzrlib.progress import ProgressPhase
52
54
from bzrlib.symbol_versioning import (
53
55
        deprecated_function,
54
56
        deprecated_in,
76
78
 
77
79
 
78
80
class TreeTransformBase(object):
79
 
    """The base class for TreeTransform and TreeTransformBase"""
 
81
    """The base class for TreeTransform and its kin."""
80
82
 
81
 
    def __init__(self, tree, limbodir, pb=DummyProgress(),
 
83
    def __init__(self, tree, pb=None,
82
84
                 case_sensitive=True):
83
85
        """Constructor.
84
86
 
85
87
        :param tree: The tree that will be transformed, but not necessarily
86
88
            the output tree.
87
 
        :param limbodir: A directory where new files can be stored until
88
 
            they are installed in their proper places
89
 
        :param pb: A ProgressBar indicating how much progress is being made
 
89
        :param pb: ignored
90
90
        :param case_sensitive: If True, the target of the transform is
91
91
            case sensitive, not just case preserving.
92
92
        """
93
93
        object.__init__(self)
94
94
        self._tree = tree
95
 
        self._limbodir = limbodir
96
 
        self._deletiondir = None
97
95
        self._id_number = 0
98
96
        # mapping of trans_id -> new basename
99
97
        self._new_name = {}
101
99
        self._new_parent = {}
102
100
        # mapping of trans_id with new contents -> new file_kind
103
101
        self._new_contents = {}
104
 
        # A mapping of transform ids to their limbo filename
105
 
        self._limbo_files = {}
106
 
        # A mapping of transform ids to a set of the transform ids of children
107
 
        # that their limbo directory has
108
 
        self._limbo_children = {}
109
 
        # Map transform ids to maps of child filename to child transform id
110
 
        self._limbo_children_names = {}
111
 
        # List of transform ids that need to be renamed from limbo into place
112
 
        self._needs_rename = set()
113
102
        # Set of trans_ids whose contents will be removed
114
103
        self._removed_contents = set()
115
104
        # Mapping of trans_id -> new execute-bit value
128
117
        self._tree_path_ids = {}
129
118
        # Mapping trans_id -> path in old tree
130
119
        self._tree_id_paths = {}
131
 
        # Cache of realpath results, to speed up canonical_path
132
 
        self._realpaths = {}
133
 
        # Cache of relpath results, to speed up canonical_path
134
 
        self._relpaths = {}
135
120
        # The trans_id that will be used as the tree root
136
121
        root_id = tree.get_root_id()
137
122
        if root_id is not None:
147
132
        # A counter of how many files have been renamed
148
133
        self.rename_count = 0
149
134
 
 
135
    def finalize(self):
 
136
        """Release the working tree lock, if held.
 
137
 
 
138
        This is required if apply has not been invoked, but can be invoked
 
139
        even after apply.
 
140
        """
 
141
        if self._tree is None:
 
142
            return
 
143
        self._tree.unlock()
 
144
        self._tree = None
 
145
 
150
146
    def __get_root(self):
151
147
        return self._new_root
152
148
 
153
149
    root = property(__get_root)
154
150
 
155
 
    def finalize(self):
156
 
        """Release the working tree lock, if held, clean up limbo dir.
157
 
 
158
 
        This is required if apply has not been invoked, but can be invoked
159
 
        even after apply.
160
 
        """
161
 
        if self._tree is None:
162
 
            return
163
 
        try:
164
 
            entries = [(self._limbo_name(t), t, k) for t, k in
165
 
                       self._new_contents.iteritems()]
166
 
            entries.sort(reverse=True)
167
 
            for path, trans_id, kind in entries:
168
 
                if kind == "directory":
169
 
                    os.rmdir(path)
170
 
                else:
171
 
                    os.unlink(path)
172
 
            try:
173
 
                os.rmdir(self._limbodir)
174
 
            except OSError:
175
 
                # We don't especially care *why* the dir is immortal.
176
 
                raise ImmortalLimbo(self._limbodir)
177
 
            try:
178
 
                if self._deletiondir is not None:
179
 
                    os.rmdir(self._deletiondir)
180
 
            except OSError:
181
 
                raise errors.ImmortalPendingDeletion(self._deletiondir)
182
 
        finally:
183
 
            self._tree.unlock()
184
 
            self._tree = None
185
 
 
186
151
    def _assign_id(self):
187
152
        """Produce a new tranform id"""
188
153
        new_id = "new-%s" % self._id_number
198
163
 
199
164
    def adjust_path(self, name, parent, trans_id):
200
165
        """Change the path that is assigned to a transaction id."""
 
166
        if parent is None:
 
167
            raise ValueError("Parent trans-id may not be None")
201
168
        if trans_id == self._new_root:
202
169
            raise CantMoveRoot
203
 
        previous_parent = self._new_parent.get(trans_id)
204
 
        previous_name = self._new_name.get(trans_id)
205
170
        self._new_name[trans_id] = name
206
171
        self._new_parent[trans_id] = parent
207
 
        if parent == ROOT_PARENT:
208
 
            if self._new_root is not None:
209
 
                raise ValueError("Cannot have multiple roots.")
210
 
            self._new_root = trans_id
211
 
        if (trans_id in self._limbo_files and
212
 
            trans_id not in self._needs_rename):
213
 
            self._rename_in_limbo([trans_id])
214
 
            self._limbo_children[previous_parent].remove(trans_id)
215
 
            del self._limbo_children_names[previous_parent][previous_name]
216
 
 
217
 
    def _rename_in_limbo(self, trans_ids):
218
 
        """Fix limbo names so that the right final path is produced.
219
 
 
220
 
        This means we outsmarted ourselves-- we tried to avoid renaming
221
 
        these files later by creating them with their final names in their
222
 
        final parents.  But now the previous name or parent is no longer
223
 
        suitable, so we have to rename them.
224
 
 
225
 
        Even for trans_ids that have no new contents, we must remove their
226
 
        entries from _limbo_files, because they are now stale.
227
 
        """
228
 
        for trans_id in trans_ids:
229
 
            old_path = self._limbo_files.pop(trans_id)
230
 
            if trans_id not in self._new_contents:
231
 
                continue
232
 
            new_path = self._limbo_name(trans_id)
233
 
            os.rename(old_path, new_path)
234
172
 
235
173
    def adjust_root_path(self, name, parent):
236
174
        """Emulate moving the root by moving all children, instead.
264
202
        self.version_file(old_root_file_id, old_root)
265
203
        self.unversion_file(self._new_root)
266
204
 
 
205
    def fixup_new_roots(self):
 
206
        """Reinterpret requests to change the root directory
 
207
 
 
208
        Instead of creating a root directory, or moving an existing directory,
 
209
        all the attributes and children of the new root are applied to the
 
210
        existing root directory.
 
211
 
 
212
        This means that the old root trans-id becomes obsolete, so it is
 
213
        recommended only to invoke this after the root trans-id has become
 
214
        irrelevant.
 
215
        """
 
216
        new_roots = [k for k, v in self._new_parent.iteritems() if v is
 
217
                     ROOT_PARENT]
 
218
        if len(new_roots) < 1:
 
219
            return
 
220
        if len(new_roots) != 1:
 
221
            raise ValueError('A tree cannot have two roots!')
 
222
        if self._new_root is None:
 
223
            self._new_root = new_roots[0]
 
224
            return
 
225
        old_new_root = new_roots[0]
 
226
        # TODO: What to do if a old_new_root is present, but self._new_root is
 
227
        #       not listed as being removed? This code explicitly unversions
 
228
        #       the old root and versions it with the new file_id. Though that
 
229
        #       seems like an incomplete delta
 
230
 
 
231
        # unversion the new root's directory.
 
232
        file_id = self.final_file_id(old_new_root)
 
233
        if old_new_root in self._new_id:
 
234
            self.cancel_versioning(old_new_root)
 
235
        else:
 
236
            self.unversion_file(old_new_root)
 
237
        # if, at this stage, root still has an old file_id, zap it so we can
 
238
        # stick a new one in.
 
239
        if (self.tree_file_id(self._new_root) is not None and
 
240
            self._new_root not in self._removed_id):
 
241
            self.unversion_file(self._new_root)
 
242
        self.version_file(file_id, self._new_root)
 
243
 
 
244
        # Now move children of new root into old root directory.
 
245
        # Ensure all children are registered with the transaction, but don't
 
246
        # use directly-- some tree children have new parents
 
247
        list(self.iter_tree_children(old_new_root))
 
248
        # Move all children of new root into old root directory.
 
249
        for child in self.by_parent().get(old_new_root, []):
 
250
            self.adjust_path(self.final_name(child), self._new_root, child)
 
251
 
 
252
        # Ensure old_new_root has no directory.
 
253
        if old_new_root in self._new_contents:
 
254
            self.cancel_creation(old_new_root)
 
255
        else:
 
256
            self.delete_contents(old_new_root)
 
257
 
 
258
        # prevent deletion of root directory.
 
259
        if self._new_root in self._removed_contents:
 
260
            self.cancel_deletion(self._new_root)
 
261
 
 
262
        # destroy path info for old_new_root.
 
263
        del self._new_parent[old_new_root]
 
264
        del self._new_name[old_new_root]
 
265
 
267
266
    def trans_id_tree_file_id(self, inventory_id):
268
267
        """Determine the transaction id of a working tree file.
269
268
 
298
297
            else:
299
298
                return self.trans_id_tree_file_id(file_id)
300
299
 
301
 
    def canonical_path(self, path):
302
 
        """Get the canonical tree-relative path"""
303
 
        # don't follow final symlinks
304
 
        abs = self._tree.abspath(path)
305
 
        if abs in self._relpaths:
306
 
            return self._relpaths[abs]
307
 
        dirname, basename = os.path.split(abs)
308
 
        if dirname not in self._realpaths:
309
 
            self._realpaths[dirname] = os.path.realpath(dirname)
310
 
        dirname = self._realpaths[dirname]
311
 
        abs = pathjoin(dirname, basename)
312
 
        if dirname in self._relpaths:
313
 
            relpath = pathjoin(self._relpaths[dirname], basename)
314
 
            relpath = relpath.rstrip('/\\')
315
 
        else:
316
 
            relpath = self._tree.relpath(abs)
317
 
        self._relpaths[abs] = relpath
318
 
        return relpath
319
 
 
320
300
    def trans_id_tree_path(self, path):
321
301
        """Determine (and maybe set) the transaction ID for a tree path."""
322
302
        path = self.canonical_path(path)
332
312
            return ROOT_PARENT
333
313
        return self.trans_id_tree_path(os.path.dirname(path))
334
314
 
335
 
    def create_file(self, contents, trans_id, mode_id=None):
336
 
        """Schedule creation of a new file.
337
 
 
338
 
        See also new_file.
339
 
 
340
 
        Contents is an iterator of strings, all of which will be written
341
 
        to the target destination.
342
 
 
343
 
        New file takes the permissions of any existing file with that id,
344
 
        unless mode_id is specified.
345
 
        """
346
 
        name = self._limbo_name(trans_id)
347
 
        f = open(name, 'wb')
348
 
        try:
349
 
            try:
350
 
                unique_add(self._new_contents, trans_id, 'file')
351
 
            except:
352
 
                # Clean up the file, it never got registered so
353
 
                # TreeTransform.finalize() won't clean it up.
354
 
                f.close()
355
 
                os.unlink(name)
356
 
                raise
357
 
 
358
 
            f.writelines(contents)
359
 
        finally:
360
 
            f.close()
361
 
        self._set_mode(trans_id, mode_id, S_ISREG)
362
 
 
363
 
    def _set_mode(self, trans_id, mode_id, typefunc):
364
 
        """Set the mode of new file contents.
365
 
        The mode_id is the existing file to get the mode from (often the same
366
 
        as trans_id).  The operation is only performed if there's a mode match
367
 
        according to typefunc.
368
 
        """
369
 
        if mode_id is None:
370
 
            mode_id = trans_id
371
 
        try:
372
 
            old_path = self._tree_id_paths[mode_id]
373
 
        except KeyError:
374
 
            return
375
 
        try:
376
 
            mode = os.stat(self._tree.abspath(old_path)).st_mode
377
 
        except OSError, e:
378
 
            if e.errno in (errno.ENOENT, errno.ENOTDIR):
379
 
                # Either old_path doesn't exist, or the parent of the
380
 
                # target is not a directory (but will be one eventually)
381
 
                # Either way, we know it doesn't exist *right now*
382
 
                # See also bug #248448
383
 
                return
384
 
            else:
385
 
                raise
386
 
        if typefunc(mode):
387
 
            os.chmod(self._limbo_name(trans_id), mode)
388
 
 
389
 
    def create_hardlink(self, path, trans_id):
390
 
        """Schedule creation of a hard link"""
391
 
        name = self._limbo_name(trans_id)
392
 
        try:
393
 
            os.link(path, name)
394
 
        except OSError, e:
395
 
            if e.errno != errno.EPERM:
396
 
                raise
397
 
            raise errors.HardLinkNotSupported(path)
398
 
        try:
399
 
            unique_add(self._new_contents, trans_id, 'file')
400
 
        except:
401
 
            # Clean up the file, it never got registered so
402
 
            # TreeTransform.finalize() won't clean it up.
403
 
            os.unlink(name)
404
 
            raise
405
 
 
406
 
    def create_directory(self, trans_id):
407
 
        """Schedule creation of a new directory.
408
 
 
409
 
        See also new_directory.
410
 
        """
411
 
        os.mkdir(self._limbo_name(trans_id))
412
 
        unique_add(self._new_contents, trans_id, 'directory')
413
 
 
414
 
    def create_symlink(self, target, trans_id):
415
 
        """Schedule creation of a new symbolic link.
416
 
 
417
 
        target is a bytestring.
418
 
        See also new_symlink.
419
 
        """
420
 
        if has_symlinks():
421
 
            os.symlink(target, self._limbo_name(trans_id))
422
 
            unique_add(self._new_contents, trans_id, 'symlink')
423
 
        else:
424
 
            try:
425
 
                path = FinalPaths(self).get_path(trans_id)
426
 
            except KeyError:
427
 
                path = None
428
 
            raise UnableCreateSymlink(path=path)
429
 
 
430
 
    def cancel_creation(self, trans_id):
431
 
        """Cancel the creation of new file contents."""
432
 
        del self._new_contents[trans_id]
433
 
        children = self._limbo_children.get(trans_id)
434
 
        # if this is a limbo directory with children, move them before removing
435
 
        # the directory
436
 
        if children is not None:
437
 
            self._rename_in_limbo(children)
438
 
            del self._limbo_children[trans_id]
439
 
            del self._limbo_children_names[trans_id]
440
 
        delete_any(self._limbo_name(trans_id))
441
 
 
442
315
    def delete_contents(self, trans_id):
443
316
        """Schedule the contents of a path entry for deletion"""
 
317
        # Ensure that the object exists in the WorkingTree, this will raise an
 
318
        # exception if there is a problem
444
319
        self.tree_kind(trans_id)
445
320
        self._removed_contents.add(trans_id)
446
321
 
518
393
        new_ids.update(changed_kind)
519
394
        return sorted(FinalPaths(self).get_paths(new_ids))
520
395
 
521
 
    def tree_kind(self, trans_id):
522
 
        """Determine the file kind in the working tree.
523
 
 
524
 
        Raises NoSuchFile if the file does not exist
525
 
        """
526
 
        path = self._tree_id_paths.get(trans_id)
527
 
        if path is None:
528
 
            raise NoSuchFile(None)
529
 
        try:
530
 
            return file_kind(self._tree.abspath(path))
531
 
        except OSError, e:
532
 
            if e.errno != errno.ENOENT:
533
 
                raise
534
 
            else:
535
 
                raise NoSuchFile(path)
536
 
 
537
396
    def final_kind(self, trans_id):
538
397
        """Determine the final file kind, after any changes applied.
539
398
 
646
505
        conflicts.extend(self._overwrite_conflicts())
647
506
        return conflicts
648
507
 
 
508
    def _check_malformed(self):
 
509
        conflicts = self.find_conflicts()
 
510
        if len(conflicts) != 0:
 
511
            raise MalformedTransform(conflicts=conflicts)
 
512
 
649
513
    def _add_tree_children(self):
650
514
        """Add all the children of all active parents to the known paths.
651
515
 
667
531
            # ensure that all children are registered with the transaction
668
532
            list(self.iter_tree_children(parent_id))
669
533
 
670
 
    def iter_tree_children(self, parent_id):
671
 
        """Iterate through the entry's tree children, if any"""
672
 
        try:
673
 
            path = self._tree_id_paths[parent_id]
674
 
        except KeyError:
675
 
            return
676
 
        try:
677
 
            children = os.listdir(self._tree.abspath(path))
678
 
        except OSError, e:
679
 
            if not (osutils._is_error_enotdir(e)
680
 
                    or e.errno in (errno.ENOENT, errno.ESRCH)):
681
 
                raise
682
 
            return
683
 
 
684
 
        for child in children:
685
 
            childpath = joinpath(path, child)
686
 
            if self._tree.is_control_filename(childpath):
687
 
                continue
688
 
            yield self.trans_id_tree_path(childpath)
689
 
 
690
534
    def has_named_child(self, by_parent, parent_id, name):
691
535
        try:
692
536
            children = by_parent[parent_id]
867
711
            return True
868
712
        return False
869
713
 
870
 
    def _limbo_name(self, trans_id):
871
 
        """Generate the limbo name of a file"""
872
 
        limbo_name = self._limbo_files.get(trans_id)
873
 
        if limbo_name is not None:
874
 
            return limbo_name
875
 
        parent = self._new_parent.get(trans_id)
876
 
        # if the parent directory is already in limbo (e.g. when building a
877
 
        # tree), choose a limbo name inside the parent, to reduce further
878
 
        # renames.
879
 
        use_direct_path = False
880
 
        if self._new_contents.get(parent) == 'directory':
881
 
            filename = self._new_name.get(trans_id)
882
 
            if filename is not None:
883
 
                if parent not in self._limbo_children:
884
 
                    self._limbo_children[parent] = set()
885
 
                    self._limbo_children_names[parent] = {}
886
 
                    use_direct_path = True
887
 
                # the direct path can only be used if no other file has
888
 
                # already taken this pathname, i.e. if the name is unused, or
889
 
                # if it is already associated with this trans_id.
890
 
                elif self._case_sensitive_target:
891
 
                    if (self._limbo_children_names[parent].get(filename)
892
 
                        in (trans_id, None)):
893
 
                        use_direct_path = True
894
 
                else:
895
 
                    for l_filename, l_trans_id in\
896
 
                        self._limbo_children_names[parent].iteritems():
897
 
                        if l_trans_id == trans_id:
898
 
                            continue
899
 
                        if l_filename.lower() == filename.lower():
900
 
                            break
901
 
                    else:
902
 
                        use_direct_path = True
903
 
 
904
 
        if use_direct_path:
905
 
            limbo_name = pathjoin(self._limbo_files[parent], filename)
906
 
            self._limbo_children[parent].add(trans_id)
907
 
            self._limbo_children_names[parent][filename] = trans_id
908
 
        else:
909
 
            limbo_name = pathjoin(self._limbodir, trans_id)
910
 
            self._needs_rename.add(trans_id)
911
 
        self._limbo_files[trans_id] = limbo_name
912
 
        return limbo_name
913
 
 
914
714
    def _set_executability(self, path, trans_id):
915
715
        """Set the executability of versioned files """
916
716
        if supports_executable():
1122
922
    def get_preview_tree(self):
1123
923
        """Return a tree representing the result of the transform.
1124
924
 
1125
 
        This tree only supports the subset of Tree functionality required
1126
 
        by show_diff_trees.  It must only be compared to tt._tree.
 
925
        The tree is a snapshot, and altering the TreeTransform will invalidate
 
926
        it.
1127
927
        """
1128
928
        return _PreviewTree(self)
1129
929
 
 
930
    def commit(self, branch, message, merge_parents=None, strict=False):
 
931
        """Commit the result of this TreeTransform to a branch.
 
932
 
 
933
        :param branch: The branch to commit to.
 
934
        :param message: The message to attach to the commit.
 
935
        :param merge_parents: Additional parents specified by pending merges.
 
936
        :return: The revision_id of the revision committed.
 
937
        """
 
938
        self._check_malformed()
 
939
        if strict:
 
940
            unversioned = set(self._new_contents).difference(set(self._new_id))
 
941
            for trans_id in unversioned:
 
942
                if self.final_file_id(trans_id) is None:
 
943
                    raise errors.StrictCommitFailed()
 
944
 
 
945
        revno, last_rev_id = branch.last_revision_info()
 
946
        if last_rev_id == _mod_revision.NULL_REVISION:
 
947
            if merge_parents is not None:
 
948
                raise ValueError('Cannot supply merge parents for first'
 
949
                                 ' commit.')
 
950
            parent_ids = []
 
951
        else:
 
952
            parent_ids = [last_rev_id]
 
953
            if merge_parents is not None:
 
954
                parent_ids.extend(merge_parents)
 
955
        if self._tree.get_revision_id() != last_rev_id:
 
956
            raise ValueError('TreeTransform not based on branch basis: %s' %
 
957
                             self._tree.get_revision_id())
 
958
        builder = branch.get_commit_builder(parent_ids)
 
959
        preview = self.get_preview_tree()
 
960
        list(builder.record_iter_changes(preview, last_rev_id,
 
961
                                         self.iter_changes()))
 
962
        builder.finish_inventory()
 
963
        revision_id = builder.commit(message)
 
964
        branch.set_last_revision_info(revno + 1, revision_id)
 
965
        return revision_id
 
966
 
1130
967
    def _text_parent(self, trans_id):
1131
968
        file_id = self.tree_file_id(trans_id)
1132
969
        try:
1176
1013
                                      (('attribs',),))
1177
1014
        for trans_id, kind in self._new_contents.items():
1178
1015
            if kind == 'file':
1179
 
                cur_file = open(self._limbo_name(trans_id), 'rb')
1180
 
                try:
1181
 
                    lines = osutils.chunks_to_lines(cur_file.readlines())
1182
 
                finally:
1183
 
                    cur_file.close()
 
1016
                lines = osutils.chunks_to_lines(
 
1017
                    self._read_file_chunks(trans_id))
1184
1018
                parents = self._get_parents_lines(trans_id)
1185
1019
                mpdiff = multiparent.MultiParent.from_lines(lines, parents)
1186
1020
                content = ''.join(mpdiff.to_patch())
1187
1021
            if kind == 'directory':
1188
1022
                content = ''
1189
1023
            if kind == 'symlink':
1190
 
                content = os.readlink(self._limbo_name(trans_id))
 
1024
                content = self._read_symlink_target(trans_id)
1191
1025
            yield serializer.bytes_record(content, ((trans_id, kind),))
1192
1026
 
1193
 
 
1194
1027
    def deserialize(self, records):
1195
1028
        """Deserialize a stored TreeTransform.
1196
1029
 
1227
1060
                self.create_symlink(content.decode('utf-8'), trans_id)
1228
1061
 
1229
1062
 
1230
 
class TreeTransform(TreeTransformBase):
 
1063
class DiskTreeTransform(TreeTransformBase):
 
1064
    """Tree transform storing its contents on disk."""
 
1065
 
 
1066
    def __init__(self, tree, limbodir, pb=None,
 
1067
                 case_sensitive=True):
 
1068
        """Constructor.
 
1069
        :param tree: The tree that will be transformed, but not necessarily
 
1070
            the output tree.
 
1071
        :param limbodir: A directory where new files can be stored until
 
1072
            they are installed in their proper places
 
1073
        :param pb: ignored
 
1074
        :param case_sensitive: If True, the target of the transform is
 
1075
            case sensitive, not just case preserving.
 
1076
        """
 
1077
        TreeTransformBase.__init__(self, tree, pb, case_sensitive)
 
1078
        self._limbodir = limbodir
 
1079
        self._deletiondir = None
 
1080
        # A mapping of transform ids to their limbo filename
 
1081
        self._limbo_files = {}
 
1082
        # A mapping of transform ids to a set of the transform ids of children
 
1083
        # that their limbo directory has
 
1084
        self._limbo_children = {}
 
1085
        # Map transform ids to maps of child filename to child transform id
 
1086
        self._limbo_children_names = {}
 
1087
        # List of transform ids that need to be renamed from limbo into place
 
1088
        self._needs_rename = set()
 
1089
        self._creation_mtime = None
 
1090
 
 
1091
    def finalize(self):
 
1092
        """Release the working tree lock, if held, clean up limbo dir.
 
1093
 
 
1094
        This is required if apply has not been invoked, but can be invoked
 
1095
        even after apply.
 
1096
        """
 
1097
        if self._tree is None:
 
1098
            return
 
1099
        try:
 
1100
            entries = [(self._limbo_name(t), t, k) for t, k in
 
1101
                       self._new_contents.iteritems()]
 
1102
            entries.sort(reverse=True)
 
1103
            for path, trans_id, kind in entries:
 
1104
                delete_any(path)
 
1105
            try:
 
1106
                delete_any(self._limbodir)
 
1107
            except OSError:
 
1108
                # We don't especially care *why* the dir is immortal.
 
1109
                raise ImmortalLimbo(self._limbodir)
 
1110
            try:
 
1111
                if self._deletiondir is not None:
 
1112
                    delete_any(self._deletiondir)
 
1113
            except OSError:
 
1114
                raise errors.ImmortalPendingDeletion(self._deletiondir)
 
1115
        finally:
 
1116
            TreeTransformBase.finalize(self)
 
1117
 
 
1118
    def _limbo_name(self, trans_id):
 
1119
        """Generate the limbo name of a file"""
 
1120
        limbo_name = self._limbo_files.get(trans_id)
 
1121
        if limbo_name is None:
 
1122
            limbo_name = self._generate_limbo_path(trans_id)
 
1123
            self._limbo_files[trans_id] = limbo_name
 
1124
        return limbo_name
 
1125
 
 
1126
    def _generate_limbo_path(self, trans_id):
 
1127
        """Generate a limbo path using the trans_id as the relative path.
 
1128
 
 
1129
        This is suitable as a fallback, and when the transform should not be
 
1130
        sensitive to the path encoding of the limbo directory.
 
1131
        """
 
1132
        self._needs_rename.add(trans_id)
 
1133
        return pathjoin(self._limbodir, trans_id)
 
1134
 
 
1135
    def adjust_path(self, name, parent, trans_id):
 
1136
        previous_parent = self._new_parent.get(trans_id)
 
1137
        previous_name = self._new_name.get(trans_id)
 
1138
        TreeTransformBase.adjust_path(self, name, parent, trans_id)
 
1139
        if (trans_id in self._limbo_files and
 
1140
            trans_id not in self._needs_rename):
 
1141
            self._rename_in_limbo([trans_id])
 
1142
            if previous_parent != parent:
 
1143
                self._limbo_children[previous_parent].remove(trans_id)
 
1144
            if previous_parent != parent or previous_name != name:
 
1145
                del self._limbo_children_names[previous_parent][previous_name]
 
1146
 
 
1147
    def _rename_in_limbo(self, trans_ids):
 
1148
        """Fix limbo names so that the right final path is produced.
 
1149
 
 
1150
        This means we outsmarted ourselves-- we tried to avoid renaming
 
1151
        these files later by creating them with their final names in their
 
1152
        final parents.  But now the previous name or parent is no longer
 
1153
        suitable, so we have to rename them.
 
1154
 
 
1155
        Even for trans_ids that have no new contents, we must remove their
 
1156
        entries from _limbo_files, because they are now stale.
 
1157
        """
 
1158
        for trans_id in trans_ids:
 
1159
            old_path = self._limbo_files.pop(trans_id)
 
1160
            if trans_id not in self._new_contents:
 
1161
                continue
 
1162
            new_path = self._limbo_name(trans_id)
 
1163
            os.rename(old_path, new_path)
 
1164
            for descendant in self._limbo_descendants(trans_id):
 
1165
                desc_path = self._limbo_files[descendant]
 
1166
                desc_path = new_path + desc_path[len(old_path):]
 
1167
                self._limbo_files[descendant] = desc_path
 
1168
 
 
1169
    def _limbo_descendants(self, trans_id):
 
1170
        """Return the set of trans_ids whose limbo paths descend from this."""
 
1171
        descendants = set(self._limbo_children.get(trans_id, []))
 
1172
        for descendant in list(descendants):
 
1173
            descendants.update(self._limbo_descendants(descendant))
 
1174
        return descendants
 
1175
 
 
1176
    def create_file(self, contents, trans_id, mode_id=None):
 
1177
        """Schedule creation of a new file.
 
1178
 
 
1179
        See also new_file.
 
1180
 
 
1181
        Contents is an iterator of strings, all of which will be written
 
1182
        to the target destination.
 
1183
 
 
1184
        New file takes the permissions of any existing file with that id,
 
1185
        unless mode_id is specified.
 
1186
        """
 
1187
        name = self._limbo_name(trans_id)
 
1188
        f = open(name, 'wb')
 
1189
        try:
 
1190
            try:
 
1191
                unique_add(self._new_contents, trans_id, 'file')
 
1192
            except:
 
1193
                # Clean up the file, it never got registered so
 
1194
                # TreeTransform.finalize() won't clean it up.
 
1195
                f.close()
 
1196
                os.unlink(name)
 
1197
                raise
 
1198
 
 
1199
            f.writelines(contents)
 
1200
        finally:
 
1201
            f.close()
 
1202
        self._set_mtime(name)
 
1203
        self._set_mode(trans_id, mode_id, S_ISREG)
 
1204
 
 
1205
    def _read_file_chunks(self, trans_id):
 
1206
        cur_file = open(self._limbo_name(trans_id), 'rb')
 
1207
        try:
 
1208
            return cur_file.readlines()
 
1209
        finally:
 
1210
            cur_file.close()
 
1211
 
 
1212
    def _read_symlink_target(self, trans_id):
 
1213
        return os.readlink(self._limbo_name(trans_id))
 
1214
 
 
1215
    def _set_mtime(self, path):
 
1216
        """All files that are created get the same mtime.
 
1217
 
 
1218
        This time is set by the first object to be created.
 
1219
        """
 
1220
        if self._creation_mtime is None:
 
1221
            self._creation_mtime = time.time()
 
1222
        os.utime(path, (self._creation_mtime, self._creation_mtime))
 
1223
 
 
1224
    def create_hardlink(self, path, trans_id):
 
1225
        """Schedule creation of a hard link"""
 
1226
        name = self._limbo_name(trans_id)
 
1227
        try:
 
1228
            os.link(path, name)
 
1229
        except OSError, e:
 
1230
            if e.errno != errno.EPERM:
 
1231
                raise
 
1232
            raise errors.HardLinkNotSupported(path)
 
1233
        try:
 
1234
            unique_add(self._new_contents, trans_id, 'file')
 
1235
        except:
 
1236
            # Clean up the file, it never got registered so
 
1237
            # TreeTransform.finalize() won't clean it up.
 
1238
            os.unlink(name)
 
1239
            raise
 
1240
 
 
1241
    def create_directory(self, trans_id):
 
1242
        """Schedule creation of a new directory.
 
1243
 
 
1244
        See also new_directory.
 
1245
        """
 
1246
        os.mkdir(self._limbo_name(trans_id))
 
1247
        unique_add(self._new_contents, trans_id, 'directory')
 
1248
 
 
1249
    def create_symlink(self, target, trans_id):
 
1250
        """Schedule creation of a new symbolic link.
 
1251
 
 
1252
        target is a bytestring.
 
1253
        See also new_symlink.
 
1254
        """
 
1255
        if has_symlinks():
 
1256
            os.symlink(target, self._limbo_name(trans_id))
 
1257
            unique_add(self._new_contents, trans_id, 'symlink')
 
1258
        else:
 
1259
            try:
 
1260
                path = FinalPaths(self).get_path(trans_id)
 
1261
            except KeyError:
 
1262
                path = None
 
1263
            raise UnableCreateSymlink(path=path)
 
1264
 
 
1265
    def cancel_creation(self, trans_id):
 
1266
        """Cancel the creation of new file contents."""
 
1267
        del self._new_contents[trans_id]
 
1268
        children = self._limbo_children.get(trans_id)
 
1269
        # if this is a limbo directory with children, move them before removing
 
1270
        # the directory
 
1271
        if children is not None:
 
1272
            self._rename_in_limbo(children)
 
1273
            del self._limbo_children[trans_id]
 
1274
            del self._limbo_children_names[trans_id]
 
1275
        delete_any(self._limbo_name(trans_id))
 
1276
 
 
1277
 
 
1278
class TreeTransform(DiskTreeTransform):
1231
1279
    """Represent a tree transformation.
1232
1280
 
1233
1281
    This object is designed to support incremental generation of the transform,
1292
1340
    FileMover does not delete files until it is sure that a rollback will not
1293
1341
    happen.
1294
1342
    """
1295
 
    def __init__(self, tree, pb=DummyProgress()):
 
1343
    def __init__(self, tree, pb=None):
1296
1344
        """Note: a tree_write lock is taken on the tree.
1297
1345
 
1298
1346
        Use TreeTransform.finalize() to release the lock (can be omitted if
1319
1367
            tree.unlock()
1320
1368
            raise
1321
1369
 
1322
 
        TreeTransformBase.__init__(self, tree, limbodir, pb,
 
1370
        # Cache of realpath results, to speed up canonical_path
 
1371
        self._realpaths = {}
 
1372
        # Cache of relpath results, to speed up canonical_path
 
1373
        self._relpaths = {}
 
1374
        DiskTreeTransform.__init__(self, tree, limbodir, pb,
1323
1375
                                   tree.case_sensitive)
1324
1376
        self._deletiondir = deletiondir
1325
1377
 
 
1378
    def canonical_path(self, path):
 
1379
        """Get the canonical tree-relative path"""
 
1380
        # don't follow final symlinks
 
1381
        abs = self._tree.abspath(path)
 
1382
        if abs in self._relpaths:
 
1383
            return self._relpaths[abs]
 
1384
        dirname, basename = os.path.split(abs)
 
1385
        if dirname not in self._realpaths:
 
1386
            self._realpaths[dirname] = os.path.realpath(dirname)
 
1387
        dirname = self._realpaths[dirname]
 
1388
        abs = pathjoin(dirname, basename)
 
1389
        if dirname in self._relpaths:
 
1390
            relpath = pathjoin(self._relpaths[dirname], basename)
 
1391
            relpath = relpath.rstrip('/\\')
 
1392
        else:
 
1393
            relpath = self._tree.relpath(abs)
 
1394
        self._relpaths[abs] = relpath
 
1395
        return relpath
 
1396
 
 
1397
    def tree_kind(self, trans_id):
 
1398
        """Determine the file kind in the working tree.
 
1399
 
 
1400
        Raises NoSuchFile if the file does not exist
 
1401
        """
 
1402
        path = self._tree_id_paths.get(trans_id)
 
1403
        if path is None:
 
1404
            raise NoSuchFile(None)
 
1405
        try:
 
1406
            return file_kind(self._tree.abspath(path))
 
1407
        except OSError, e:
 
1408
            if e.errno != errno.ENOENT:
 
1409
                raise
 
1410
            else:
 
1411
                raise NoSuchFile(path)
 
1412
 
 
1413
    def _set_mode(self, trans_id, mode_id, typefunc):
 
1414
        """Set the mode of new file contents.
 
1415
        The mode_id is the existing file to get the mode from (often the same
 
1416
        as trans_id).  The operation is only performed if there's a mode match
 
1417
        according to typefunc.
 
1418
        """
 
1419
        if mode_id is None:
 
1420
            mode_id = trans_id
 
1421
        try:
 
1422
            old_path = self._tree_id_paths[mode_id]
 
1423
        except KeyError:
 
1424
            return
 
1425
        try:
 
1426
            mode = os.stat(self._tree.abspath(old_path)).st_mode
 
1427
        except OSError, e:
 
1428
            if e.errno in (errno.ENOENT, errno.ENOTDIR):
 
1429
                # Either old_path doesn't exist, or the parent of the
 
1430
                # target is not a directory (but will be one eventually)
 
1431
                # Either way, we know it doesn't exist *right now*
 
1432
                # See also bug #248448
 
1433
                return
 
1434
            else:
 
1435
                raise
 
1436
        if typefunc(mode):
 
1437
            os.chmod(self._limbo_name(trans_id), mode)
 
1438
 
 
1439
    def iter_tree_children(self, parent_id):
 
1440
        """Iterate through the entry's tree children, if any"""
 
1441
        try:
 
1442
            path = self._tree_id_paths[parent_id]
 
1443
        except KeyError:
 
1444
            return
 
1445
        try:
 
1446
            children = os.listdir(self._tree.abspath(path))
 
1447
        except OSError, e:
 
1448
            if not (osutils._is_error_enotdir(e)
 
1449
                    or e.errno in (errno.ENOENT, errno.ESRCH)):
 
1450
                raise
 
1451
            return
 
1452
 
 
1453
        for child in children:
 
1454
            childpath = joinpath(path, child)
 
1455
            if self._tree.is_control_filename(childpath):
 
1456
                continue
 
1457
            yield self.trans_id_tree_path(childpath)
 
1458
 
 
1459
    def _generate_limbo_path(self, trans_id):
 
1460
        """Generate a limbo path using the final path if possible.
 
1461
 
 
1462
        This optimizes the performance of applying the tree transform by
 
1463
        avoiding renames.  These renames can be avoided only when the parent
 
1464
        directory is already scheduled for creation.
 
1465
 
 
1466
        If the final path cannot be used, falls back to using the trans_id as
 
1467
        the relpath.
 
1468
        """
 
1469
        parent = self._new_parent.get(trans_id)
 
1470
        # if the parent directory is already in limbo (e.g. when building a
 
1471
        # tree), choose a limbo name inside the parent, to reduce further
 
1472
        # renames.
 
1473
        use_direct_path = False
 
1474
        if self._new_contents.get(parent) == 'directory':
 
1475
            filename = self._new_name.get(trans_id)
 
1476
            if filename is not None:
 
1477
                if parent not in self._limbo_children:
 
1478
                    self._limbo_children[parent] = set()
 
1479
                    self._limbo_children_names[parent] = {}
 
1480
                    use_direct_path = True
 
1481
                # the direct path can only be used if no other file has
 
1482
                # already taken this pathname, i.e. if the name is unused, or
 
1483
                # if it is already associated with this trans_id.
 
1484
                elif self._case_sensitive_target:
 
1485
                    if (self._limbo_children_names[parent].get(filename)
 
1486
                        in (trans_id, None)):
 
1487
                        use_direct_path = True
 
1488
                else:
 
1489
                    for l_filename, l_trans_id in\
 
1490
                        self._limbo_children_names[parent].iteritems():
 
1491
                        if l_trans_id == trans_id:
 
1492
                            continue
 
1493
                        if l_filename.lower() == filename.lower():
 
1494
                            break
 
1495
                    else:
 
1496
                        use_direct_path = True
 
1497
 
 
1498
        if not use_direct_path:
 
1499
            return DiskTreeTransform._generate_limbo_path(self, trans_id)
 
1500
 
 
1501
        limbo_name = pathjoin(self._limbo_files[parent], filename)
 
1502
        self._limbo_children[parent].add(trans_id)
 
1503
        self._limbo_children_names[parent][filename] = trans_id
 
1504
        return limbo_name
 
1505
 
 
1506
 
1326
1507
    def apply(self, no_conflicts=False, precomputed_delta=None, _mover=None):
1327
1508
        """Apply all changes to the inventory and filesystem.
1328
1509
 
1338
1519
        :param _mover: Supply an alternate FileMover, for testing
1339
1520
        """
1340
1521
        if not no_conflicts:
1341
 
            conflicts = self.find_conflicts()
1342
 
            if len(conflicts) != 0:
1343
 
                raise MalformedTransform(conflicts=conflicts)
 
1522
            self._check_malformed()
1344
1523
        child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1345
1524
        try:
1346
1525
            if precomputed_delta is None:
1450
1629
                child_pb.update('removing file', num, len(tree_paths))
1451
1630
                full_path = self._tree.abspath(path)
1452
1631
                if trans_id in self._removed_contents:
1453
 
                    mover.pre_delete(full_path, os.path.join(self._deletiondir,
1454
 
                                     trans_id))
1455
 
                elif trans_id in self._new_name or trans_id in \
1456
 
                    self._new_parent:
 
1632
                    delete_path = os.path.join(self._deletiondir, trans_id)
 
1633
                    mover.pre_delete(full_path, delete_path)
 
1634
                elif (trans_id in self._new_name
 
1635
                      or trans_id in self._new_parent):
1457
1636
                    try:
1458
1637
                        mover.rename(full_path, self._limbo_name(trans_id))
1459
1638
                    except OSError, e:
1505
1684
        return modified_paths
1506
1685
 
1507
1686
 
1508
 
class TransformPreview(TreeTransformBase):
 
1687
class TransformPreview(DiskTreeTransform):
1509
1688
    """A TreeTransform for generating preview trees.
1510
1689
 
1511
1690
    Unlike TreeTransform, this version works when the input tree is a
1513
1692
    unversioned files in the input tree.
1514
1693
    """
1515
1694
 
1516
 
    def __init__(self, tree, pb=DummyProgress(), case_sensitive=True):
 
1695
    def __init__(self, tree, pb=None, case_sensitive=True):
1517
1696
        tree.lock_read()
1518
1697
        limbodir = osutils.mkdtemp(prefix='bzr-limbo-')
1519
 
        TreeTransformBase.__init__(self, tree, limbodir, pb, case_sensitive)
 
1698
        DiskTreeTransform.__init__(self, tree, limbodir, pb, case_sensitive)
1520
1699
 
1521
1700
    def canonical_path(self, path):
1522
1701
        return path
1564
1743
        self._all_children_cache = {}
1565
1744
        self._path2trans_id_cache = {}
1566
1745
        self._final_name_cache = {}
1567
 
 
1568
 
    def _changes(self, file_id):
1569
 
        for changes in self._transform.iter_changes():
1570
 
            if changes[0] == file_id:
1571
 
                return changes
 
1746
        self._iter_changes_cache = dict((c[0], c) for c in
 
1747
                                        self._transform.iter_changes())
1572
1748
 
1573
1749
    def _content_change(self, file_id):
1574
1750
        """Return True if the content of this file changed"""
1575
 
        changes = self._changes(file_id)
 
1751
        changes = self._iter_changes_cache.get(file_id)
1576
1752
        # changes[2] is true if the file content changed.  See
1577
1753
        # InterTree.iter_changes.
1578
1754
        return (changes is not None and changes[2])
1647
1823
    def __iter__(self):
1648
1824
        return iter(self.all_file_ids())
1649
1825
 
1650
 
    def has_id(self, file_id):
 
1826
    def _has_id(self, file_id, fallback_check):
1651
1827
        if file_id in self._transform._r_new_id:
1652
1828
            return True
1653
1829
        elif file_id in set([self._transform.tree_file_id(trans_id) for
1654
1830
            trans_id in self._transform._removed_id]):
1655
1831
            return False
1656
1832
        else:
1657
 
            return self._transform._tree.has_id(file_id)
 
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)
1658
1840
 
1659
1841
    def _path2trans_id(self, path):
1660
1842
        # We must not use None here, because that is a valid value to store.
1713
1895
            if self._transform.final_file_id(trans_id) is None:
1714
1896
                yield self._final_paths._determine_path(trans_id)
1715
1897
 
1716
 
    def _make_inv_entries(self, ordered_entries, specific_file_ids):
 
1898
    def _make_inv_entries(self, ordered_entries, specific_file_ids=None,
 
1899
        yield_parents=False):
1717
1900
        for trans_id, parent_file_id in ordered_entries:
1718
1901
            file_id = self._transform.final_file_id(trans_id)
1719
1902
            if file_id is None:
1745
1928
                ordered_ids.append((trans_id, parent_file_id))
1746
1929
        return ordered_ids
1747
1930
 
1748
 
    def iter_entries_by_dir(self, specific_file_ids=None):
 
1931
    def iter_entries_by_dir(self, specific_file_ids=None, yield_parents=False):
1749
1932
        # This may not be a maximally efficient implementation, but it is
1750
1933
        # reasonably straightforward.  An implementation that grafts the
1751
1934
        # TreeTransform changes onto the tree's iter_entries_by_dir results
1753
1936
        # position.
1754
1937
        ordered_ids = self._list_files_by_dir()
1755
1938
        for entry, trans_id in self._make_inv_entries(ordered_ids,
1756
 
                                                      specific_file_ids):
1757
 
            yield unicode(self._final_paths.get_path(trans_id)), entry
1758
 
 
1759
 
    def list_files(self, include_root=False):
1760
 
        """See Tree.list_files."""
 
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."""
1761
1954
        # XXX This should behave like WorkingTree.list_files, but is really
1762
1955
        # more like RevisionTree.list_files.
1763
 
        for path, entry in self.iter_entries_by_dir():
1764
 
            if entry.name == '' and not include_root:
1765
 
                continue
1766
 
            yield path, 'V', entry.kind, entry.file_id, entry
 
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
1767
1977
 
1768
1978
    def kind(self, file_id):
1769
1979
        trans_id = self._transform.trans_id_file_id(file_id)
1779
1989
    def get_file_mtime(self, file_id, path=None):
1780
1990
        """See Tree.get_file_mtime"""
1781
1991
        if not self._content_change(file_id):
1782
 
            return self._transform._tree.get_file_mtime(file_id, path)
 
1992
            return self._transform._tree.get_file_mtime(file_id)
1783
1993
        return self._stat_limbo_file(file_id).st_mtime
1784
1994
 
1785
1995
    def _file_size(self, entry, stat_value):
1839
2049
                statval = os.lstat(limbo_name)
1840
2050
                size = statval.st_size
1841
2051
                if not supports_executable():
1842
 
                    executable = None
 
2052
                    executable = False
1843
2053
                else:
1844
2054
                    executable = statval.st_mode & S_IEXEC
1845
2055
            else:
1847
2057
                executable = None
1848
2058
            if kind == 'symlink':
1849
2059
                link_or_sha1 = os.readlink(limbo_name).decode(osutils._fs_enc)
1850
 
        if supports_executable():
1851
 
            executable = tt._new_executability.get(trans_id, executable)
 
2060
        executable = tt._new_executability.get(trans_id, executable)
1852
2061
        return kind, size, executable, link_or_sha1
1853
2062
 
1854
2063
    def iter_changes(self, from_tree, include_unchanged=False,
1880
2089
        name = self._transform._limbo_name(trans_id)
1881
2090
        return open(name, 'rb')
1882
2091
 
 
2092
    def get_file_with_stat(self, file_id, path=None):
 
2093
        return self.get_file(file_id, path), None
 
2094
 
1883
2095
    def annotate_iter(self, file_id,
1884
2096
                      default_revision=_mod_revision.CURRENT_REVISION):
1885
 
        changes = self._changes(file_id)
 
2097
        changes = self._iter_changes_cache.get(file_id)
1886
2098
        if changes is None:
1887
2099
            get_old = True
1888
2100
        else:
1900
2112
            return old_annotation
1901
2113
        if not changed_content:
1902
2114
            return old_annotation
 
2115
        # TODO: This is doing something similar to what WT.annotate_iter is
 
2116
        #       doing, however it fails slightly because it doesn't know what
 
2117
        #       the *other* revision_id is, so it doesn't know how to give the
 
2118
        #       other as the origin for some lines, they all get
 
2119
        #       'default_revision'
 
2120
        #       It would be nice to be able to use the new Annotator based
 
2121
        #       approach, as well.
1903
2122
        return annotate.reannotate([old_annotation],
1904
2123
                                   self.get_file(file_id).readlines(),
1905
2124
                                   default_revision)
1910
2129
            return self._transform._tree.get_symlink_target(file_id)
1911
2130
        trans_id = self._transform.trans_id_file_id(file_id)
1912
2131
        name = self._transform._limbo_name(trans_id)
1913
 
        return os.readlink(name)
 
2132
        return osutils.readlink(name)
1914
2133
 
1915
2134
    def walkdirs(self, prefix=''):
1916
2135
        pending = [self._transform.root]
1971
2190
        self.transform = transform
1972
2191
 
1973
2192
    def _determine_path(self, trans_id):
1974
 
        if trans_id == self.transform.root:
 
2193
        if (trans_id == self.transform.root or trans_id == ROOT_PARENT):
1975
2194
            return ""
1976
2195
        name = self.transform.final_name(trans_id)
1977
2196
        parent_id = self.transform.final_parent(trans_id)
2152
2371
def _create_files(tt, tree, desired_files, pb, offset, accelerator_tree,
2153
2372
                  hardlink):
2154
2373
    total = len(desired_files) + offset
 
2374
    wt = tt._tree
2155
2375
    if accelerator_tree is None:
2156
2376
        new_desired_files = desired_files
2157
2377
    else:
2158
2378
        iter = accelerator_tree.iter_changes(tree, include_unchanged=True)
2159
 
        unchanged = dict((f, p[1]) for (f, p, c, v, d, n, k, e)
2160
 
                         in iter if not (c or e[0] != e[1]))
 
2379
        unchanged = [(f, p[1]) for (f, p, c, v, d, n, k, e)
 
2380
                     in iter if not (c or e[0] != e[1])]
 
2381
        if accelerator_tree.supports_content_filtering():
 
2382
            unchanged = [(f, p) for (f, p) in unchanged
 
2383
                         if not accelerator_tree.iter_search_rules([p]).next()]
 
2384
        unchanged = dict(unchanged)
2161
2385
        new_desired_files = []
2162
2386
        count = 0
2163
2387
        for file_id, (trans_id, tree_path) in desired_files:
2171
2395
                                   trans_id)
2172
2396
            else:
2173
2397
                contents = accelerator_tree.get_file(file_id, accelerator_path)
2174
 
                if tree.supports_content_filtering():
2175
 
                    filters = tree._content_filter_stack(tree_path)
 
2398
                if wt.supports_content_filtering():
 
2399
                    filters = wt._content_filter_stack(tree_path)
2176
2400
                    contents = filtered_output_bytes(contents, filters,
2177
2401
                        ContentFilterContext(tree_path, tree))
2178
2402
                try:
2187
2411
        offset += count
2188
2412
    for count, ((trans_id, tree_path), contents) in enumerate(
2189
2413
            tree.iter_files_bytes(new_desired_files)):
2190
 
        if tree.supports_content_filtering():
2191
 
            filters = tree._content_filter_stack(tree_path)
 
2414
        if wt.supports_content_filtering():
 
2415
            filters = wt._content_filter_stack(tree_path)
2192
2416
            contents = filtered_output_bytes(contents, filters,
2193
2417
                ContentFilterContext(tree_path, tree))
2194
2418
        tt.create_file(contents, trans_id)
2286
2510
        tt.create_directory(trans_id)
2287
2511
 
2288
2512
 
2289
 
def create_from_tree(tt, trans_id, tree, file_id, bytes=None):
2290
 
    """Create new file contents according to tree contents."""
 
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
    """
2291
2521
    kind = tree.kind(file_id)
2292
2522
    if kind == 'directory':
2293
2523
        tt.create_directory(trans_id)
2298
2528
                bytes = tree_file.readlines()
2299
2529
            finally:
2300
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))
2301
2536
        tt.create_file(bytes, trans_id)
2302
2537
    elif kind == "symlink":
2303
2538
        tt.create_symlink(tree.get_symlink_target(file_id), trans_id)
2355
2590
 
2356
2591
 
2357
2592
def revert(working_tree, target_tree, filenames, backups=False,
2358
 
           pb=DummyProgress(), change_reporter=None):
 
2593
           pb=None, change_reporter=None):
2359
2594
    """Revert a working tree's contents to those of a target tree."""
2360
2595
    target_tree.lock_read()
 
2596
    pb = ui.ui_factory.nested_progress_bar()
2361
2597
    tt = TreeTransform(working_tree, pb)
2362
2598
    try:
2363
2599
        pp = ProgressPhase("Revert phase", 3, pb)
2382
2618
def _prepare_revert_transform(working_tree, target_tree, tt, filenames,
2383
2619
                              backups, pp, basis_tree=None,
2384
2620
                              merge_modified=None):
2385
 
    pp.next_phase()
2386
2621
    child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
2387
2622
    try:
2388
2623
        if merge_modified is None:
2392
2627
                                      merge_modified, basis_tree)
2393
2628
    finally:
2394
2629
        child_pb.finished()
2395
 
    pp.next_phase()
2396
2630
    child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
2397
2631
    try:
2398
2632
        raw_conflicts = resolve_conflicts(tt, child_pb,
2491
2725
                    parent_trans = ROOT_PARENT
2492
2726
                else:
2493
2727
                    parent_trans = tt.trans_id_file_id(parent[1])
2494
 
                tt.adjust_path(name[1], parent_trans, trans_id)
 
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)
2495
2732
            if executable[0] != executable[1] and kind[1] == "file":
2496
2733
                tt.set_executability(executable[1], trans_id)
2497
 
        for (trans_id, mode_id), bytes in target_tree.iter_files_bytes(
2498
 
            deferred_files):
2499
 
            tt.create_file(bytes, trans_id, mode_id)
 
2734
        if working_tree.supports_content_filtering():
 
2735
            for index, ((trans_id, mode_id), bytes) in enumerate(
 
2736
                target_tree.iter_files_bytes(deferred_files)):
 
2737
                file_id = deferred_files[index][0]
 
2738
                # We're reverting a tree to the target tree so using the
 
2739
                # target tree to find the file path seems the best choice
 
2740
                # here IMO - Ian C 27/Oct/2009
 
2741
                filter_tree_path = target_tree.id2path(file_id)
 
2742
                filters = working_tree._content_filter_stack(filter_tree_path)
 
2743
                bytes = filtered_output_bytes(bytes, filters,
 
2744
                    ContentFilterContext(filter_tree_path, working_tree))
 
2745
                tt.create_file(bytes, trans_id, mode_id)
 
2746
        else:
 
2747
            for (trans_id, mode_id), bytes in target_tree.iter_files_bytes(
 
2748
                deferred_files):
 
2749
                tt.create_file(bytes, trans_id, mode_id)
 
2750
        tt.fixup_new_roots()
2500
2751
    finally:
2501
2752
        if basis_tree is not None:
2502
2753
            basis_tree.unlock()
2503
2754
    return merge_modified
2504
2755
 
2505
2756
 
2506
 
def resolve_conflicts(tt, pb=DummyProgress(), pass_func=None):
 
2757
def resolve_conflicts(tt, pb=None, pass_func=None):
2507
2758
    """Make many conflict-resolution attempts, but die if they fail"""
2508
2759
    if pass_func is None:
2509
2760
        pass_func = conflict_pass
2510
2761
    new_conflicts = set()
 
2762
    pb = ui.ui_factory.nested_progress_bar()
2511
2763
    try:
2512
2764
        for n in range(10):
2513
2765
            pb.update('Resolution pass', n+1, 10)
2517
2769
            new_conflicts.update(pass_func(tt, conflicts))
2518
2770
        raise MalformedTransform(conflicts=conflicts)
2519
2771
    finally:
2520
 
        pb.clear()
 
2772
        pb.finished()
2521
2773
 
2522
2774
 
2523
2775
def conflict_pass(tt, conflicts, path_tree=None):
2572
2824
                        # special-case the other tree root (move its
2573
2825
                        # children to current root)
2574
2826
                        if entry.parent_id is None:
2575
 
                            create=False
 
2827
                            create = False
2576
2828
                            moved = _reparent_transform_children(
2577
2829
                                tt, trans_id, tt.root)
2578
2830
                            for child in moved: