~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/transform.py

  • Committer: Alexander Belchenko
  • Date: 2007-01-30 23:05:35 UTC
  • mto: This revision was merged to the branch mainline in revision 2259.
  • Revision ID: bialix@ukr.net-20070130230535-kx1rd478rtigyc3v
standalone installer: win98 support

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2006, 2007, 2008 Canonical Ltd
 
1
# Copyright (C) 2006 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
17
17
import os
18
18
import errno
19
19
from stat import S_ISREG
20
 
import tempfile
21
20
 
22
 
from bzrlib.lazy_import import lazy_import
23
 
lazy_import(globals(), """
24
 
from bzrlib import (
25
 
    bzrdir,
26
 
    delta,
27
 
    errors,
28
 
    inventory
29
 
    )
30
 
""")
 
21
from bzrlib import bzrdir, errors
31
22
from bzrlib.errors import (DuplicateKey, MalformedTransform, NoSuchFile,
32
23
                           ReusingTransform, NotVersionedError, CantMoveRoot,
33
 
                           ExistingLimbo, ImmortalLimbo, NoFinalPath,
34
 
                           UnableCreateSymlink)
 
24
                           ExistingLimbo, ImmortalLimbo, NoFinalPath)
35
25
from bzrlib.inventory import InventoryEntry
36
26
from bzrlib.osutils import (file_kind, supports_executable, pathjoin, lexists,
37
 
                            delete_any, has_symlinks)
 
27
                            delete_any)
38
28
from bzrlib.progress import DummyProgress, ProgressPhase
39
 
from bzrlib.symbol_versioning import (
40
 
        deprecated_function,
41
 
        zero_fifteen,
42
 
        zero_ninety,
43
 
        )
44
29
from bzrlib.trace import mutter, warning
45
30
from bzrlib import tree
46
 
import bzrlib.ui
 
31
import bzrlib.ui 
47
32
import bzrlib.urlutils as urlutils
48
33
 
49
34
 
57
42
 
58
43
 
59
44
class _TransformResults(object):
60
 
    def __init__(self, modified_paths, rename_count):
 
45
    def __init__(self, modified_paths):
61
46
        object.__init__(self)
62
47
        self.modified_paths = modified_paths
63
 
        self.rename_count = rename_count
64
 
 
65
 
 
66
 
class TreeTransformBase(object):
67
 
    """The base class for TreeTransform and TreeTransformBase"""
68
 
 
69
 
    def __init__(self, tree, limbodir, pb=DummyProgress(),
70
 
                 case_sensitive=True):
71
 
        """Constructor.
72
 
 
73
 
        :param tree: The tree that will be transformed, but not necessarily
74
 
            the output tree.
75
 
        :param limbodir: A directory where new files can be stored until
76
 
            they are installed in their proper places
77
 
        :param pb: A ProgressBar indicating how much progress is being made
78
 
        :param case_sensitive: If True, the target of the transform is
79
 
            case sensitive, not just case preserving.
 
48
 
 
49
 
 
50
class TreeTransform(object):
 
51
    """Represent a tree transformation.
 
52
    
 
53
    This object is designed to support incremental generation of the transform,
 
54
    in any order.  
 
55
    
 
56
    It is easy to produce malformed transforms, but they are generally
 
57
    harmless.  Attempting to apply a malformed transform will cause an
 
58
    exception to be raised before any modifications are made to the tree.  
 
59
 
 
60
    Many kinds of malformed transforms can be corrected with the 
 
61
    resolve_conflicts function.  The remaining ones indicate programming error,
 
62
    such as trying to create a file with no path.
 
63
 
 
64
    Two sets of file creation methods are supplied.  Convenience methods are:
 
65
     * new_file
 
66
     * new_directory
 
67
     * new_symlink
 
68
 
 
69
    These are composed of the low-level methods:
 
70
     * create_path
 
71
     * create_file or create_directory or create_symlink
 
72
     * version_file
 
73
     * set_executability
 
74
    """
 
75
    def __init__(self, tree, pb=DummyProgress()):
 
76
        """Note: a tree_write lock is taken on the tree.
 
77
        
 
78
        Use TreeTransform.finalize() to release the lock
80
79
        """
81
80
        object.__init__(self)
82
81
        self._tree = tree
83
 
        self._limbodir = limbodir
84
 
        self._deletiondir = None
 
82
        self._tree.lock_tree_write()
 
83
        try:
 
84
            control_files = self._tree._control_files
 
85
            self._limbodir = urlutils.local_path_from_url(
 
86
                control_files.controlfilename('limbo'))
 
87
            try:
 
88
                os.mkdir(self._limbodir)
 
89
            except OSError, e:
 
90
                if e.errno == errno.EEXIST:
 
91
                    raise ExistingLimbo(self._limbodir)
 
92
        except: 
 
93
            self._tree.unlock()
 
94
            raise
 
95
 
85
96
        self._id_number = 0
86
 
        # mapping of trans_id -> new basename
87
97
        self._new_name = {}
88
 
        # mapping of trans_id -> new parent trans_id
89
98
        self._new_parent = {}
90
 
        # mapping of trans_id with new contents -> new file_kind
91
99
        self._new_contents = {}
92
 
        # A mapping of transform ids to their limbo filename
93
 
        self._limbo_files = {}
94
 
        # A mapping of transform ids to a set of the transform ids of children
95
 
        # that their limbo directory has
96
 
        self._limbo_children = {}
97
 
        # Map transform ids to maps of child filename to child transform id
98
 
        self._limbo_children_names = {}
99
 
        # List of transform ids that need to be renamed from limbo into place
100
 
        self._needs_rename = set()
101
 
        # Set of trans_ids whose contents will be removed
102
100
        self._removed_contents = set()
103
 
        # Mapping of trans_id -> new execute-bit value
104
101
        self._new_executability = {}
105
 
        # Mapping of trans_id -> new tree-reference value
106
 
        self._new_reference_revision = {}
107
 
        # Mapping of trans_id -> new file_id
108
102
        self._new_id = {}
109
 
        # Mapping of old file-id -> trans_id
110
103
        self._non_present_ids = {}
111
 
        # Mapping of new file_id -> trans_id
112
104
        self._r_new_id = {}
113
 
        # Set of file_ids that will be removed
114
105
        self._removed_id = set()
115
 
        # Mapping of path in old tree -> trans_id
116
106
        self._tree_path_ids = {}
117
 
        # Mapping trans_id -> path in old tree
118
107
        self._tree_id_paths = {}
 
108
        self._realpaths = {}
119
109
        # Cache of realpath results, to speed up canonical_path
120
 
        self._realpaths = {}
 
110
        self._relpaths = {}
121
111
        # Cache of relpath results, to speed up canonical_path
122
 
        self._relpaths = {}
123
 
        # The trans_id that will be used as the tree root
124
112
        self._new_root = self.trans_id_tree_file_id(tree.get_root_id())
125
 
        # Indictor of whether the transform has been applied
126
 
        self._done = False
127
 
        # A progress bar
 
113
        self.__done = False
128
114
        self._pb = pb
129
 
        # Whether the target is case sensitive
130
 
        self._case_sensitive_target = case_sensitive
131
 
        # A counter of how many files have been renamed
132
 
        self.rename_count = 0
133
115
 
134
116
    def __get_root(self):
135
117
        return self._new_root
137
119
    root = property(__get_root)
138
120
 
139
121
    def finalize(self):
140
 
        """Release the working tree lock, if held, clean up limbo dir.
141
 
 
142
 
        This is required if apply has not been invoked, but can be invoked
143
 
        even after apply.
144
 
        """
 
122
        """Release the working tree lock, if held, clean up limbo dir."""
145
123
        if self._tree is None:
146
124
            return
147
125
        try:
148
 
            entries = [(self._limbo_name(t), t, k) for t, k in
149
 
                       self._new_contents.iteritems()]
150
 
            entries.sort(reverse=True)
151
 
            for path, trans_id, kind in entries:
 
126
            for trans_id, kind in self._new_contents.iteritems():
 
127
                path = self._limbo_name(trans_id)
152
128
                if kind == "directory":
153
129
                    os.rmdir(path)
154
130
                else:
158
134
            except OSError:
159
135
                # We don't especially care *why* the dir is immortal.
160
136
                raise ImmortalLimbo(self._limbodir)
161
 
            try:
162
 
                if self._deletiondir is not None:
163
 
                    os.rmdir(self._deletiondir)
164
 
            except OSError:
165
 
                raise errors.ImmortalPendingDeletion(self._deletiondir)
166
137
        finally:
167
138
            self._tree.unlock()
168
139
            self._tree = None
184
155
        """Change the path that is assigned to a transaction id."""
185
156
        if trans_id == self._new_root:
186
157
            raise CantMoveRoot
187
 
        previous_parent = self._new_parent.get(trans_id)
188
 
        previous_name = self._new_name.get(trans_id)
189
158
        self._new_name[trans_id] = name
190
159
        self._new_parent[trans_id] = parent
191
 
        if (trans_id in self._limbo_files and
192
 
            trans_id not in self._needs_rename):
193
 
            self._rename_in_limbo([trans_id])
194
 
            self._limbo_children[previous_parent].remove(trans_id)
195
 
            del self._limbo_children_names[previous_parent][previous_name]
196
 
 
197
 
    def _rename_in_limbo(self, trans_ids):
198
 
        """Fix limbo names so that the right final path is produced.
199
 
 
200
 
        This means we outsmarted ourselves-- we tried to avoid renaming
201
 
        these files later by creating them with their final names in their
202
 
        final parents.  But now the previous name or parent is no longer
203
 
        suitable, so we have to rename them.
204
 
 
205
 
        Even for trans_ids that have no new contents, we must remove their
206
 
        entries from _limbo_files, because they are now stale.
207
 
        """
208
 
        for trans_id in trans_ids:
209
 
            old_path = self._limbo_files.pop(trans_id)
210
 
            if trans_id not in self._new_contents:
211
 
                continue
212
 
            new_path = self._limbo_name(trans_id)
213
 
            os.rename(old_path, new_path)
214
160
 
215
161
    def adjust_root_path(self, name, parent):
216
162
        """Emulate moving the root by moving all children, instead.
250
196
        This reflects only files that already exist, not ones that will be
251
197
        added by transactions.
252
198
        """
253
 
        path = self._tree.id2path(inventory_id)
 
199
        path = self._tree.inventory.id2path(inventory_id)
254
200
        return self.trans_id_tree_path(path)
255
201
 
256
202
    def trans_id_file_id(self, file_id):
327
273
                os.unlink(name)
328
274
                raise
329
275
 
330
 
            f.writelines(contents)
 
276
            for segment in contents:
 
277
                f.write(segment)
331
278
        finally:
332
279
            f.close()
333
280
        self._set_mode(trans_id, mode_id, S_ISREG)
354
301
        if typefunc(mode):
355
302
            os.chmod(self._limbo_name(trans_id), mode)
356
303
 
357
 
    def create_hardlink(self, path, trans_id):
358
 
        """Schedule creation of a hard link"""
359
 
        name = self._limbo_name(trans_id)
360
 
        try:
361
 
            os.link(path, name)
362
 
        except OSError, e:
363
 
            if e.errno != errno.EPERM:
364
 
                raise
365
 
            raise errors.HardLinkNotSupported(path)
366
 
        try:
367
 
            unique_add(self._new_contents, trans_id, 'file')
368
 
        except:
369
 
            # Clean up the file, it never got registered so
370
 
            # TreeTransform.finalize() won't clean it up.
371
 
            os.unlink(name)
372
 
            raise
373
 
 
374
304
    def create_directory(self, trans_id):
375
305
        """Schedule creation of a new directory.
376
306
        
385
315
        target is a bytestring.
386
316
        See also new_symlink.
387
317
        """
388
 
        if has_symlinks():
389
 
            os.symlink(target, self._limbo_name(trans_id))
390
 
            unique_add(self._new_contents, trans_id, 'symlink')
391
 
        else:
392
 
            try:
393
 
                path = FinalPaths(self).get_path(trans_id)
394
 
            except KeyError:
395
 
                path = None
396
 
            raise UnableCreateSymlink(path=path)
 
318
        os.symlink(target, self._limbo_name(trans_id))
 
319
        unique_add(self._new_contents, trans_id, 'symlink')
397
320
 
398
321
    def cancel_creation(self, trans_id):
399
322
        """Cancel the creation of new file contents."""
400
323
        del self._new_contents[trans_id]
401
 
        children = self._limbo_children.get(trans_id)
402
 
        # if this is a limbo directory with children, move them before removing
403
 
        # the directory
404
 
        if children is not None:
405
 
            self._rename_in_limbo(children)
406
 
            del self._limbo_children[trans_id]
407
 
            del self._limbo_children_names[trans_id]
408
324
        delete_any(self._limbo_name(trans_id))
409
325
 
410
326
    def delete_contents(self, trans_id):
434
350
        else:
435
351
            unique_add(self._new_executability, trans_id, executability)
436
352
 
437
 
    def set_tree_reference(self, revision_id, trans_id):
438
 
        """Set the reference associated with a directory"""
439
 
        unique_add(self._new_reference_revision, trans_id, revision_id)
440
 
 
441
353
    def version_file(self, file_id, trans_id):
442
354
        """Schedule a file to become versioned."""
443
355
        assert file_id is not None
500
412
            return None
501
413
        # the file is old; the old id is still valid
502
414
        if self._new_root == trans_id:
503
 
            return self._tree.get_root_id()
 
415
            return self._tree.inventory.root.file_id
504
416
        return self._tree.inventory.path2id(path)
505
417
 
506
418
    def final_file_id(self, trans_id):
574
486
 
575
487
    def find_conflicts(self):
576
488
        """Find any violations of inventory or filesystem invariants"""
577
 
        if self._done is True:
 
489
        if self.__done is True:
578
490
            raise ReusingTransform()
579
491
        conflicts = []
580
492
        # ensure all children of all existent parents are known
602
514
                        self.tree_kind(t) == 'directory'])
603
515
        for trans_id in self._removed_id:
604
516
            file_id = self.tree_file_id(trans_id)
605
 
            if file_id is not None:
606
 
                if self._tree.inventory[file_id].kind == 'directory':
607
 
                    parents.append(trans_id)
608
 
            elif self.tree_kind(trans_id) == 'directory':
 
517
            if self._tree.inventory[file_id].kind == 'directory':
609
518
                parents.append(trans_id)
610
519
 
611
520
        for parent_id in parents:
621
530
        try:
622
531
            children = os.listdir(self._tree.abspath(path))
623
532
        except OSError, e:
624
 
            if e.errno not in (errno.ENOENT, errno.ESRCH, errno.ENOTDIR):
 
533
            if e.errno != errno.ENOENT and e.errno != errno.ESRCH:
625
534
                raise
626
535
            return
627
536
            
741
650
    def _duplicate_entries(self, by_parent):
742
651
        """No directory may have two entries with the same name."""
743
652
        conflicts = []
744
 
        if (self._new_name, self._new_parent) == ({}, {}):
745
 
            return conflicts
746
653
        for children in by_parent.itervalues():
747
654
            name_ids = [(self.final_name(t), t) for t in children]
748
 
            if not self._case_sensitive_target:
749
 
                name_ids = [(n.lower(), t) for n, t in name_ids]
750
655
            name_ids.sort()
751
656
            last_name = None
752
657
            last_trans_id = None
770
675
        conflicts = []
771
676
        removed_tree_ids = set((self.tree_file_id(trans_id) for trans_id in
772
677
                                self._removed_id))
773
 
        all_ids = self._tree.all_file_ids()
774
 
        active_tree_ids = all_ids.difference(removed_tree_ids)
 
678
        active_tree_ids = set((f for f in self._tree.inventory if
 
679
                               f not in removed_tree_ids))
775
680
        for trans_id, file_id in self._new_id.iteritems():
776
681
            if file_id in active_tree_ids:
777
682
                old_trans_id = self.trans_id_tree_file_id(file_id)
810
715
                continue
811
716
            return True
812
717
        return False
 
718
            
 
719
    def apply(self):
 
720
        """Apply all changes to the inventory and filesystem.
 
721
        
 
722
        If filesystem or inventory conflicts are present, MalformedTransform
 
723
        will be thrown.
 
724
        """
 
725
        conflicts = self.find_conflicts()
 
726
        if len(conflicts) != 0:
 
727
            raise MalformedTransform(conflicts=conflicts)
 
728
        limbo_inv = {}
 
729
        inv = self._tree.inventory
 
730
        child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
731
        try:
 
732
            child_pb.update('Apply phase', 0, 2)
 
733
            self._apply_removals(inv, limbo_inv)
 
734
            child_pb.update('Apply phase', 1, 2)
 
735
            modified_paths = self._apply_insertions(inv, limbo_inv)
 
736
        finally:
 
737
            child_pb.finished()
 
738
        self._tree._write_inventory(inv)
 
739
        self.__done = True
 
740
        self.finalize()
 
741
        return _TransformResults(modified_paths)
813
742
 
814
743
    def _limbo_name(self, trans_id):
815
744
        """Generate the limbo name of a file"""
816
 
        limbo_name = self._limbo_files.get(trans_id)
817
 
        if limbo_name is not None:
818
 
            return limbo_name
819
 
        parent = self._new_parent.get(trans_id)
820
 
        # if the parent directory is already in limbo (e.g. when building a
821
 
        # tree), choose a limbo name inside the parent, to reduce further
822
 
        # renames.
823
 
        use_direct_path = False
824
 
        if self._new_contents.get(parent) == 'directory':
825
 
            filename = self._new_name.get(trans_id)
826
 
            if filename is not None:
827
 
                if parent not in self._limbo_children:
828
 
                    self._limbo_children[parent] = set()
829
 
                    self._limbo_children_names[parent] = {}
830
 
                    use_direct_path = True
831
 
                # the direct path can only be used if no other file has
832
 
                # already taken this pathname, i.e. if the name is unused, or
833
 
                # if it is already associated with this trans_id.
834
 
                elif self._case_sensitive_target:
835
 
                    if (self._limbo_children_names[parent].get(filename)
836
 
                        in (trans_id, None)):
837
 
                        use_direct_path = True
838
 
                else:
839
 
                    for l_filename, l_trans_id in\
840
 
                        self._limbo_children_names[parent].iteritems():
841
 
                        if l_trans_id == trans_id:
842
 
                            continue
843
 
                        if l_filename.lower() == filename.lower():
844
 
                            break
 
745
        return pathjoin(self._limbodir, trans_id)
 
746
 
 
747
    def _apply_removals(self, inv, limbo_inv):
 
748
        """Perform tree operations that remove directory/inventory names.
 
749
        
 
750
        That is, delete files that are to be deleted, and put any files that
 
751
        need renaming into limbo.  This must be done in strict child-to-parent
 
752
        order.
 
753
        """
 
754
        tree_paths = list(self._tree_path_ids.iteritems())
 
755
        tree_paths.sort(reverse=True)
 
756
        child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
757
        try:
 
758
            for num, data in enumerate(tree_paths):
 
759
                path, trans_id = data
 
760
                child_pb.update('removing file', num, len(tree_paths))
 
761
                full_path = self._tree.abspath(path)
 
762
                if trans_id in self._removed_contents:
 
763
                    delete_any(full_path)
 
764
                elif trans_id in self._new_name or trans_id in \
 
765
                    self._new_parent:
 
766
                    try:
 
767
                        os.rename(full_path, self._limbo_name(trans_id))
 
768
                    except OSError, e:
 
769
                        if e.errno != errno.ENOENT:
 
770
                            raise
 
771
                if trans_id in self._removed_id:
 
772
                    if trans_id == self._new_root:
 
773
                        file_id = self._tree.inventory.root.file_id
845
774
                    else:
846
 
                        use_direct_path = True
847
 
 
848
 
        if use_direct_path:
849
 
            limbo_name = pathjoin(self._limbo_files[parent], filename)
850
 
            self._limbo_children[parent].add(trans_id)
851
 
            self._limbo_children_names[parent][filename] = trans_id
852
 
        else:
853
 
            limbo_name = pathjoin(self._limbodir, trans_id)
854
 
            self._needs_rename.add(trans_id)
855
 
        self._limbo_files[trans_id] = limbo_name
856
 
        return limbo_name
857
 
 
858
 
    def _set_executability(self, path, entry, trans_id):
 
775
                        file_id = self.tree_file_id(trans_id)
 
776
                    del inv[file_id]
 
777
                elif trans_id in self._new_name or trans_id in self._new_parent:
 
778
                    file_id = self.tree_file_id(trans_id)
 
779
                    if file_id is not None:
 
780
                        limbo_inv[trans_id] = inv[file_id]
 
781
                        del inv[file_id]
 
782
        finally:
 
783
            child_pb.finished()
 
784
 
 
785
    def _apply_insertions(self, inv, limbo_inv):
 
786
        """Perform tree operations that insert directory/inventory names.
 
787
        
 
788
        That is, create any files that need to be created, and restore from
 
789
        limbo any files that needed renaming.  This must be done in strict
 
790
        parent-to-child order.
 
791
        """
 
792
        new_paths = self.new_paths()
 
793
        modified_paths = []
 
794
        child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
795
        try:
 
796
            for num, (path, trans_id) in enumerate(new_paths):
 
797
                child_pb.update('adding file', num, len(new_paths))
 
798
                try:
 
799
                    kind = self._new_contents[trans_id]
 
800
                except KeyError:
 
801
                    kind = contents = None
 
802
                if trans_id in self._new_contents or \
 
803
                    self.path_changed(trans_id):
 
804
                    full_path = self._tree.abspath(path)
 
805
                    try:
 
806
                        os.rename(self._limbo_name(trans_id), full_path)
 
807
                    except OSError, e:
 
808
                        # We may be renaming a dangling inventory id
 
809
                        if e.errno != errno.ENOENT:
 
810
                            raise
 
811
                    if trans_id in self._new_contents:
 
812
                        modified_paths.append(full_path)
 
813
                        del self._new_contents[trans_id]
 
814
 
 
815
                if trans_id in self._new_id:
 
816
                    if kind is None:
 
817
                        kind = file_kind(self._tree.abspath(path))
 
818
                    inv.add_path(path, kind, self._new_id[trans_id])
 
819
                elif trans_id in self._new_name or trans_id in\
 
820
                    self._new_parent:
 
821
                    entry = limbo_inv.get(trans_id)
 
822
                    if entry is not None:
 
823
                        entry.name = self.final_name(trans_id)
 
824
                        parent_path = os.path.dirname(path)
 
825
                        entry.parent_id = \
 
826
                            self._tree.inventory.path2id(parent_path)
 
827
                        inv.add(entry)
 
828
 
 
829
                # requires files and inventory entries to be in place
 
830
                if trans_id in self._new_executability:
 
831
                    self._set_executability(path, inv, trans_id)
 
832
        finally:
 
833
            child_pb.finished()
 
834
        return modified_paths
 
835
 
 
836
    def _set_executability(self, path, inv, trans_id):
859
837
        """Set the executability of versioned files """
 
838
        file_id = inv.path2id(path)
860
839
        new_executability = self._new_executability[trans_id]
861
 
        entry.executable = new_executability
 
840
        inv[file_id].executable = new_executability
862
841
        if supports_executable():
863
842
            abspath = self._tree.abspath(path)
864
843
            current_mode = os.stat(abspath).st_mode
925
904
        self.create_symlink(target, trans_id)
926
905
        return trans_id
927
906
 
928
 
    def _affected_ids(self):
929
 
        """Return the set of transform ids affected by the transform"""
930
 
        trans_ids = set(self._removed_id)
931
 
        trans_ids.update(self._new_id.keys())
932
 
        trans_ids.update(self._removed_contents)
933
 
        trans_ids.update(self._new_contents.keys())
934
 
        trans_ids.update(self._new_executability.keys())
935
 
        trans_ids.update(self._new_name.keys())
936
 
        trans_ids.update(self._new_parent.keys())
937
 
        return trans_ids
938
 
 
939
 
    def _get_file_id_maps(self):
940
 
        """Return mapping of file_ids to trans_ids in the to and from states"""
941
 
        trans_ids = self._affected_ids()
942
 
        from_trans_ids = {}
943
 
        to_trans_ids = {}
944
 
        # Build up two dicts: trans_ids associated with file ids in the
945
 
        # FROM state, vs the TO state.
946
 
        for trans_id in trans_ids:
947
 
            from_file_id = self.tree_file_id(trans_id)
948
 
            if from_file_id is not None:
949
 
                from_trans_ids[from_file_id] = trans_id
950
 
            to_file_id = self.final_file_id(trans_id)
951
 
            if to_file_id is not None:
952
 
                to_trans_ids[to_file_id] = trans_id
953
 
        return from_trans_ids, to_trans_ids
954
 
 
955
 
    def _from_file_data(self, from_trans_id, from_versioned, file_id):
956
 
        """Get data about a file in the from (tree) state
957
 
 
958
 
        Return a (name, parent, kind, executable) tuple
959
 
        """
960
 
        from_path = self._tree_id_paths.get(from_trans_id)
961
 
        if from_versioned:
962
 
            # get data from working tree if versioned
963
 
            from_entry = self._tree.inventory[file_id]
964
 
            from_name = from_entry.name
965
 
            from_parent = from_entry.parent_id
966
 
        else:
967
 
            from_entry = None
968
 
            if from_path is None:
969
 
                # File does not exist in FROM state
970
 
                from_name = None
971
 
                from_parent = None
972
 
            else:
973
 
                # File exists, but is not versioned.  Have to use path-
974
 
                # splitting stuff
975
 
                from_name = os.path.basename(from_path)
976
 
                tree_parent = self.get_tree_parent(from_trans_id)
977
 
                from_parent = self.tree_file_id(tree_parent)
978
 
        if from_path is not None:
979
 
            from_kind, from_executable, from_stats = \
980
 
                self._tree._comparison_data(from_entry, from_path)
981
 
        else:
982
 
            from_kind = None
983
 
            from_executable = False
984
 
        return from_name, from_parent, from_kind, from_executable
985
 
 
986
 
    def _to_file_data(self, to_trans_id, from_trans_id, from_executable):
987
 
        """Get data about a file in the to (target) state
988
 
 
989
 
        Return a (name, parent, kind, executable) tuple
990
 
        """
991
 
        to_name = self.final_name(to_trans_id)
992
 
        try:
993
 
            to_kind = self.final_kind(to_trans_id)
994
 
        except NoSuchFile:
995
 
            to_kind = None
996
 
        to_parent = self.final_file_id(self.final_parent(to_trans_id))
997
 
        if to_trans_id in self._new_executability:
998
 
            to_executable = self._new_executability[to_trans_id]
999
 
        elif to_trans_id == from_trans_id:
1000
 
            to_executable = from_executable
1001
 
        else:
1002
 
            to_executable = False
1003
 
        return to_name, to_parent, to_kind, to_executable
1004
 
 
1005
 
    def iter_changes(self):
1006
 
        """Produce output in the same format as Tree.iter_changes.
1007
 
 
1008
 
        Will produce nonsensical results if invoked while inventory/filesystem
1009
 
        conflicts (as reported by TreeTransform.find_conflicts()) are present.
1010
 
 
1011
 
        This reads the Transform, but only reproduces changes involving a
1012
 
        file_id.  Files that are not versioned in either of the FROM or TO
1013
 
        states are not reflected.
1014
 
        """
1015
 
        final_paths = FinalPaths(self)
1016
 
        from_trans_ids, to_trans_ids = self._get_file_id_maps()
1017
 
        results = []
1018
 
        # Now iterate through all active file_ids
1019
 
        for file_id in set(from_trans_ids.keys() + to_trans_ids.keys()):
1020
 
            modified = False
1021
 
            from_trans_id = from_trans_ids.get(file_id)
1022
 
            # find file ids, and determine versioning state
1023
 
            if from_trans_id is None:
1024
 
                from_versioned = False
1025
 
                from_trans_id = to_trans_ids[file_id]
1026
 
            else:
1027
 
                from_versioned = True
1028
 
            to_trans_id = to_trans_ids.get(file_id)
1029
 
            if to_trans_id is None:
1030
 
                to_versioned = False
1031
 
                to_trans_id = from_trans_id
1032
 
            else:
1033
 
                to_versioned = True
1034
 
 
1035
 
            from_name, from_parent, from_kind, from_executable = \
1036
 
                self._from_file_data(from_trans_id, from_versioned, file_id)
1037
 
 
1038
 
            to_name, to_parent, to_kind, to_executable = \
1039
 
                self._to_file_data(to_trans_id, from_trans_id, from_executable)
1040
 
 
1041
 
            if not from_versioned:
1042
 
                from_path = None
1043
 
            else:
1044
 
                from_path = self._tree_id_paths.get(from_trans_id)
1045
 
            if not to_versioned:
1046
 
                to_path = None
1047
 
            else:
1048
 
                to_path = final_paths.get_path(to_trans_id)
1049
 
            if from_kind != to_kind:
1050
 
                modified = True
1051
 
            elif to_kind in ('file', 'symlink') and (
1052
 
                to_trans_id != from_trans_id or
1053
 
                to_trans_id in self._new_contents):
1054
 
                modified = True
1055
 
            if (not modified and from_versioned == to_versioned and
1056
 
                from_parent==to_parent and from_name == to_name and
1057
 
                from_executable == to_executable):
1058
 
                continue
1059
 
            results.append((file_id, (from_path, to_path), modified,
1060
 
                   (from_versioned, to_versioned),
1061
 
                   (from_parent, to_parent),
1062
 
                   (from_name, to_name),
1063
 
                   (from_kind, to_kind),
1064
 
                   (from_executable, to_executable)))
1065
 
        return iter(sorted(results, key=lambda x:x[1]))
1066
 
 
1067
 
    def get_preview_tree(self):
1068
 
        """Return a tree representing the result of the transform.
1069
 
 
1070
 
        This tree only supports the subset of Tree functionality required
1071
 
        by show_diff_trees.  It must only be compared to tt._tree.
1072
 
        """
1073
 
        return _PreviewTree(self)
1074
 
 
1075
 
 
1076
 
class TreeTransform(TreeTransformBase):
1077
 
    """Represent a tree transformation.
1078
 
 
1079
 
    This object is designed to support incremental generation of the transform,
1080
 
    in any order.
1081
 
 
1082
 
    However, it gives optimum performance when parent directories are created
1083
 
    before their contents.  The transform is then able to put child files
1084
 
    directly in their parent directory, avoiding later renames.
1085
 
 
1086
 
    It is easy to produce malformed transforms, but they are generally
1087
 
    harmless.  Attempting to apply a malformed transform will cause an
1088
 
    exception to be raised before any modifications are made to the tree.
1089
 
 
1090
 
    Many kinds of malformed transforms can be corrected with the
1091
 
    resolve_conflicts function.  The remaining ones indicate programming error,
1092
 
    such as trying to create a file with no path.
1093
 
 
1094
 
    Two sets of file creation methods are supplied.  Convenience methods are:
1095
 
     * new_file
1096
 
     * new_directory
1097
 
     * new_symlink
1098
 
 
1099
 
    These are composed of the low-level methods:
1100
 
     * create_path
1101
 
     * create_file or create_directory or create_symlink
1102
 
     * version_file
1103
 
     * set_executability
1104
 
 
1105
 
    Transform/Transaction ids
1106
 
    -------------------------
1107
 
    trans_ids are temporary ids assigned to all files involved in a transform.
1108
 
    It's possible, even common, that not all files in the Tree have trans_ids.
1109
 
 
1110
 
    trans_ids are used because filenames and file_ids are not good enough
1111
 
    identifiers; filenames change, and not all files have file_ids.  File-ids
1112
 
    are also associated with trans-ids, so that moving a file moves its
1113
 
    file-id.
1114
 
 
1115
 
    trans_ids are only valid for the TreeTransform that generated them.
1116
 
 
1117
 
    Limbo
1118
 
    -----
1119
 
    Limbo is a temporary directory use to hold new versions of files.
1120
 
    Files are added to limbo by create_file, create_directory, create_symlink,
1121
 
    and their convenience variants (new_*).  Files may be removed from limbo
1122
 
    using cancel_creation.  Files are renamed from limbo into their final
1123
 
    location as part of TreeTransform.apply
1124
 
 
1125
 
    Limbo must be cleaned up, by either calling TreeTransform.apply or
1126
 
    calling TreeTransform.finalize.
1127
 
 
1128
 
    Files are placed into limbo inside their parent directories, where
1129
 
    possible.  This reduces subsequent renames, and makes operations involving
1130
 
    lots of files faster.  This optimization is only possible if the parent
1131
 
    directory is created *before* creating any of its children, so avoid
1132
 
    creating children before parents, where possible.
1133
 
 
1134
 
    Pending-deletion
1135
 
    ----------------
1136
 
    This temporary directory is used by _FileMover for storing files that are
1137
 
    about to be deleted.  In case of rollback, the files will be restored.
1138
 
    FileMover does not delete files until it is sure that a rollback will not
1139
 
    happen.
1140
 
    """
1141
 
    def __init__(self, tree, pb=DummyProgress()):
1142
 
        """Note: a tree_write lock is taken on the tree.
1143
 
 
1144
 
        Use TreeTransform.finalize() to release the lock (can be omitted if
1145
 
        TreeTransform.apply() called).
1146
 
        """
1147
 
        tree.lock_tree_write()
1148
 
 
1149
 
        try:
1150
 
            control_files = tree._control_files
1151
 
            limbodir = urlutils.local_path_from_url(
1152
 
                control_files.controlfilename('limbo'))
1153
 
            try:
1154
 
                os.mkdir(limbodir)
1155
 
            except OSError, e:
1156
 
                if e.errno == errno.EEXIST:
1157
 
                    raise ExistingLimbo(limbodir)
1158
 
            deletiondir = urlutils.local_path_from_url(
1159
 
                control_files.controlfilename('pending-deletion'))
1160
 
            try:
1161
 
                os.mkdir(deletiondir)
1162
 
            except OSError, e:
1163
 
                if e.errno == errno.EEXIST:
1164
 
                    raise errors.ExistingPendingDeletion(deletiondir)
1165
 
        except:
1166
 
            tree.unlock()
1167
 
            raise
1168
 
 
1169
 
        TreeTransformBase.__init__(self, tree, limbodir, pb,
1170
 
                                   tree.case_sensitive)
1171
 
        self._deletiondir = deletiondir
1172
 
 
1173
 
    def apply(self, no_conflicts=False, _mover=None):
1174
 
        """Apply all changes to the inventory and filesystem.
1175
 
 
1176
 
        If filesystem or inventory conflicts are present, MalformedTransform
1177
 
        will be thrown.
1178
 
 
1179
 
        If apply succeeds, finalize is not necessary.
1180
 
 
1181
 
        :param no_conflicts: if True, the caller guarantees there are no
1182
 
            conflicts, so no check is made.
1183
 
        :param _mover: Supply an alternate FileMover, for testing
1184
 
        """
1185
 
        if not no_conflicts:
1186
 
            conflicts = self.find_conflicts()
1187
 
            if len(conflicts) != 0:
1188
 
                raise MalformedTransform(conflicts=conflicts)
1189
 
        inventory_delta = []
1190
 
        child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1191
 
        try:
1192
 
            if _mover is None:
1193
 
                mover = _FileMover()
1194
 
            else:
1195
 
                mover = _mover
1196
 
            try:
1197
 
                child_pb.update('Apply phase', 0, 2)
1198
 
                self._apply_removals(inventory_delta, mover)
1199
 
                child_pb.update('Apply phase', 1, 2)
1200
 
                modified_paths = self._apply_insertions(inventory_delta, mover)
1201
 
            except:
1202
 
                mover.rollback()
1203
 
                raise
1204
 
            else:
1205
 
                mover.apply_deletions()
1206
 
        finally:
1207
 
            child_pb.finished()
1208
 
        self._tree.apply_inventory_delta(inventory_delta)
1209
 
        self._done = True
1210
 
        self.finalize()
1211
 
        return _TransformResults(modified_paths, self.rename_count)
1212
 
 
1213
 
    def _apply_removals(self, inventory_delta, mover):
1214
 
        """Perform tree operations that remove directory/inventory names.
1215
 
 
1216
 
        That is, delete files that are to be deleted, and put any files that
1217
 
        need renaming into limbo.  This must be done in strict child-to-parent
1218
 
        order.
1219
 
        """
1220
 
        tree_paths = list(self._tree_path_ids.iteritems())
1221
 
        tree_paths.sort(reverse=True)
1222
 
        child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1223
 
        try:
1224
 
            for num, data in enumerate(tree_paths):
1225
 
                path, trans_id = data
1226
 
                child_pb.update('removing file', num, len(tree_paths))
1227
 
                full_path = self._tree.abspath(path)
1228
 
                if trans_id in self._removed_contents:
1229
 
                    mover.pre_delete(full_path, os.path.join(self._deletiondir,
1230
 
                                     trans_id))
1231
 
                elif trans_id in self._new_name or trans_id in \
1232
 
                    self._new_parent:
1233
 
                    try:
1234
 
                        mover.rename(full_path, self._limbo_name(trans_id))
1235
 
                    except OSError, e:
1236
 
                        if e.errno != errno.ENOENT:
1237
 
                            raise
1238
 
                    else:
1239
 
                        self.rename_count += 1
1240
 
                if trans_id in self._removed_id:
1241
 
                    if trans_id == self._new_root:
1242
 
                        file_id = self._tree.get_root_id()
1243
 
                    else:
1244
 
                        file_id = self.tree_file_id(trans_id)
1245
 
                    assert file_id is not None
1246
 
                    # File-id isn't really being deleted, just moved
1247
 
                    if file_id in self._r_new_id:
1248
 
                        continue
1249
 
                    inventory_delta.append((path, None, file_id, None))
1250
 
        finally:
1251
 
            child_pb.finished()
1252
 
 
1253
 
    def _apply_insertions(self, inventory_delta, mover):
1254
 
        """Perform tree operations that insert directory/inventory names.
1255
 
 
1256
 
        That is, create any files that need to be created, and restore from
1257
 
        limbo any files that needed renaming.  This must be done in strict
1258
 
        parent-to-child order.
1259
 
        """
1260
 
        new_paths = self.new_paths()
1261
 
        modified_paths = []
1262
 
        child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1263
 
        completed_new = []
1264
 
        try:
1265
 
            for num, (path, trans_id) in enumerate(new_paths):
1266
 
                new_entry = None
1267
 
                child_pb.update('adding file', num, len(new_paths))
1268
 
                if trans_id in self._new_contents or \
1269
 
                    self.path_changed(trans_id):
1270
 
                    full_path = self._tree.abspath(path)
1271
 
                    if trans_id in self._needs_rename:
1272
 
                        try:
1273
 
                            mover.rename(self._limbo_name(trans_id), full_path)
1274
 
                        except OSError, e:
1275
 
                            # We may be renaming a dangling inventory id
1276
 
                            if e.errno != errno.ENOENT:
1277
 
                                raise
1278
 
                        else:
1279
 
                            self.rename_count += 1
1280
 
                    if trans_id in self._new_contents:
1281
 
                        modified_paths.append(full_path)
1282
 
                        completed_new.append(trans_id)
1283
 
                file_id = self.final_file_id(trans_id)
1284
 
                if file_id is not None and (trans_id in self._new_id or
1285
 
                    trans_id in self._new_name or trans_id in self._new_parent
1286
 
                    or trans_id in self._new_executability):
1287
 
                    try:
1288
 
                        kind = self.final_kind(trans_id)
1289
 
                    except NoSuchFile:
1290
 
                        kind = self._tree.stored_kind(file_id)
1291
 
                    if trans_id in self._new_reference_revision:
1292
 
                        new_entry = inventory.TreeReference(
1293
 
                            self.final_file_id(trans_id),
1294
 
                            self._new_name[trans_id],
1295
 
                            self.final_file_id(self._new_parent[trans_id]),
1296
 
                            None, self._new_reference_revision[trans_id])
1297
 
                    else:
1298
 
                        new_entry = inventory.make_entry(kind,
1299
 
                            self.final_name(trans_id),
1300
 
                            self.final_file_id(self.final_parent(trans_id)),
1301
 
                            self.final_file_id(trans_id))
1302
 
                    try:
1303
 
                        old_path = self._tree.id2path(new_entry.file_id)
1304
 
                    except errors.NoSuchId:
1305
 
                        old_path = None
1306
 
                    inventory_delta.append((old_path, path, new_entry.file_id,
1307
 
                                            new_entry))
1308
 
 
1309
 
                if trans_id in self._new_executability:
1310
 
                    self._set_executability(path, new_entry, trans_id)
1311
 
        finally:
1312
 
            child_pb.finished()
1313
 
        for trans_id in completed_new:
1314
 
            del self._new_contents[trans_id]
1315
 
        return modified_paths
1316
 
 
1317
 
 
1318
 
class TransformPreview(TreeTransformBase):
1319
 
    """A TreeTransform for generating preview trees.
1320
 
 
1321
 
    Unlike TreeTransform, this version works when the input tree is a
1322
 
    RevisionTree, rather than a WorkingTree.  As a result, it tends to ignore
1323
 
    unversioned files in the input tree.
1324
 
    """
1325
 
 
1326
 
    def __init__(self, tree, pb=DummyProgress(), case_sensitive=True):
1327
 
        tree.lock_read()
1328
 
        limbodir = tempfile.mkdtemp(prefix='bzr-limbo-')
1329
 
        TreeTransformBase.__init__(self, tree, limbodir, pb, case_sensitive)
1330
 
 
1331
 
    def canonical_path(self, path):
1332
 
        return path
1333
 
 
1334
 
    def tree_kind(self, trans_id):
1335
 
        path = self._tree_id_paths.get(trans_id)
1336
 
        if path is None:
1337
 
            raise NoSuchFile(None)
1338
 
        file_id = self._tree.path2id(path)
1339
 
        return self._tree.kind(file_id)
1340
 
 
1341
 
    def _set_mode(self, trans_id, mode_id, typefunc):
1342
 
        """Set the mode of new file contents.
1343
 
        The mode_id is the existing file to get the mode from (often the same
1344
 
        as trans_id).  The operation is only performed if there's a mode match
1345
 
        according to typefunc.
1346
 
        """
1347
 
        # is it ok to ignore this?  probably
1348
 
        pass
1349
 
 
1350
 
    def iter_tree_children(self, parent_id):
1351
 
        """Iterate through the entry's tree children, if any"""
1352
 
        try:
1353
 
            path = self._tree_id_paths[parent_id]
1354
 
        except KeyError:
1355
 
            return
1356
 
        file_id = self.tree_file_id(parent_id)
1357
 
        for child in self._tree.inventory[file_id].children.iterkeys():
1358
 
            childpath = joinpath(path, child)
1359
 
            yield self.trans_id_tree_path(childpath)
1360
 
 
1361
 
 
1362
 
class _PreviewTree(object):
1363
 
    """Partial implementation of Tree to support show_diff_trees"""
1364
 
 
1365
 
    def __init__(self, transform):
1366
 
        self._transform = transform
1367
 
 
1368
 
    def lock_read(self):
1369
 
        # Perhaps in theory, this should lock the TreeTransform?
1370
 
        pass
1371
 
 
1372
 
    def unlock(self):
1373
 
        pass
1374
 
 
1375
 
    def iter_changes(self, from_tree, include_unchanged=False,
1376
 
                      specific_files=None, pb=None, extra_trees=None,
1377
 
                      require_versioned=True, want_unversioned=False):
1378
 
        """See InterTree.iter_changes.
1379
 
 
1380
 
        This implementation does not support include_unchanged, specific_files,
1381
 
        or want_unversioned.  extra_trees, require_versioned, and pb are
1382
 
        ignored.
1383
 
        """
1384
 
        if from_tree is not self._transform._tree:
1385
 
            raise ValueError('from_tree must be transform source tree.')
1386
 
        if include_unchanged:
1387
 
            raise ValueError('include_unchanged is not supported')
1388
 
        if specific_files is not None:
1389
 
            raise ValueError('specific_files is not supported')
1390
 
        if want_unversioned:
1391
 
            raise ValueError('want_unversioned is not supported')
1392
 
        return self._transform.iter_changes()
1393
 
 
1394
 
    def kind(self, file_id):
1395
 
        trans_id = self._transform.trans_id_file_id(file_id)
1396
 
        return self._transform.final_kind(trans_id)
1397
 
 
1398
 
    def get_file_mtime(self, file_id, path=None):
1399
 
        """See Tree.get_file_mtime"""
1400
 
        trans_id = self._transform.trans_id_file_id(file_id)
1401
 
        name = self._transform._limbo_name(trans_id)
1402
 
        return os.stat(name).st_mtime
1403
 
 
1404
 
    def get_file(self, file_id):
1405
 
        """See Tree.get_file"""
1406
 
        trans_id = self._transform.trans_id_file_id(file_id)
1407
 
        name = self._transform._limbo_name(trans_id)
1408
 
        return open(name, 'rb')
1409
 
 
1410
 
    def get_symlink_target(self, file_id):
1411
 
        """See Tree.get_symlink_target"""
1412
 
        trans_id = self._transform.trans_id_file_id(file_id)
1413
 
        name = self._transform._limbo_name(trans_id)
1414
 
        return os.readlink(name)
1415
 
 
1416
 
    def paths2ids(self, specific_files, trees=None, require_versioned=False):
1417
 
        """See Tree.paths2ids"""
1418
 
        return 'not_empty'
1419
 
 
1420
 
 
1421
907
def joinpath(parent, child):
1422
908
    """Join tree-relative paths, handling the tree root specially"""
1423
909
    if parent is None or parent == "":
1453
939
            self._known_paths[trans_id] = self._determine_path(trans_id)
1454
940
        return self._known_paths[trans_id]
1455
941
 
1456
 
 
1457
942
def topology_sorted_ids(tree):
1458
943
    """Determine the topological order of the ids in a tree"""
1459
944
    file_ids = list(tree)
1461
946
    return file_ids
1462
947
 
1463
948
 
1464
 
def build_tree(tree, wt, accelerator_tree=None, hardlink=False):
 
949
def build_tree(tree, wt):
1465
950
    """Create working tree for a branch, using a TreeTransform.
1466
951
    
1467
952
    This function should be used on empty trees, having a tree root at most.
1474
959
    - Otherwise, if the content on disk matches the content we are building,
1475
960
      it is silently replaced.
1476
961
    - Otherwise, conflict resolution will move the old file to 'oldname.moved'.
1477
 
 
1478
 
    :param tree: The tree to convert wt into a copy of
1479
 
    :param wt: The working tree that files will be placed into
1480
 
    :param accelerator_tree: A tree which can be used for retrieving file
1481
 
        contents more quickly than tree itself, i.e. a workingtree.  tree
1482
 
        will be used for cases where accelerator_tree's content is different.
1483
 
    :param hardlink: If true, hard-link files to accelerator_tree, where
1484
 
        possible.  accelerator_tree must implement abspath, i.e. be a
1485
 
        working tree.
1486
962
    """
1487
 
    wt.lock_tree_write()
1488
 
    try:
1489
 
        tree.lock_read()
1490
 
        try:
1491
 
            if accelerator_tree is not None:
1492
 
                accelerator_tree.lock_read()
1493
 
            try:
1494
 
                return _build_tree(tree, wt, accelerator_tree, hardlink)
1495
 
            finally:
1496
 
                if accelerator_tree is not None:
1497
 
                    accelerator_tree.unlock()
1498
 
        finally:
1499
 
            tree.unlock()
1500
 
    finally:
1501
 
        wt.unlock()
1502
 
 
1503
 
 
1504
 
def _build_tree(tree, wt, accelerator_tree, hardlink):
1505
 
    """See build_tree."""
1506
 
    for num, _unused in enumerate(wt.all_file_ids()):
1507
 
        if num > 0:  # more than just a root
1508
 
            raise errors.WorkingTreeAlreadyPopulated(base=wt.basedir)
 
963
    if len(wt.inventory) > 1:  # more than just a root
 
964
        raise errors.WorkingTreeAlreadyPopulated(base=wt.basedir)
1509
965
    file_trans_id = {}
1510
966
    top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1511
967
    pp = ProgressPhase("Build phase", 2, top_pb)
1512
968
    if tree.inventory.root is not None:
1513
 
        # This is kind of a hack: we should be altering the root
1514
 
        # as part of the regular tree shape diff logic.
1515
 
        # The conditional test here is to avoid doing an
1516
 
        # expensive operation (flush) every time the root id
1517
 
        # is set within the tree, nor setting the root and thus
1518
 
        # marking the tree as dirty, because we use two different
1519
 
        # idioms here: tree interfaces and inventory interfaces.
1520
 
        if wt.get_root_id() != tree.get_root_id():
1521
 
            wt.set_root_id(tree.get_root_id())
1522
 
            wt.flush()
 
969
        wt.set_root_id(tree.inventory.root.file_id)
1523
970
    tt = TreeTransform(wt)
1524
971
    divert = set()
1525
972
    try:
1528
975
            tt.trans_id_tree_file_id(wt.get_root_id())
1529
976
        pb = bzrlib.ui.ui_factory.nested_progress_bar()
1530
977
        try:
1531
 
            deferred_contents = []
1532
 
            num = 0
1533
978
            for num, (tree_path, entry) in \
1534
979
                enumerate(tree.inventory.iter_entries_by_dir()):
1535
 
                pb.update("Building tree", num - len(deferred_contents),
1536
 
                          len(tree.inventory))
 
980
                pb.update("Building tree", num, len(tree.inventory))
1537
981
                if entry.parent_id is None:
1538
982
                    continue
1539
983
                reparent = False
1558
1002
                        if kind == 'directory':
1559
1003
                            reparent = True
1560
1004
                if entry.parent_id not in file_trans_id:
1561
 
                    raise AssertionError(
1562
 
                        'entry %s parent id %r is not in file_trans_id %r'
1563
 
                        % (entry, entry.parent_id, file_trans_id))
 
1005
                    raise repr(entry.parent_id)
1564
1006
                parent_id = file_trans_id[entry.parent_id]
1565
 
                if entry.kind == 'file':
1566
 
                    # We *almost* replicate new_by_entry, so that we can defer
1567
 
                    # getting the file text, and get them all at once.
1568
 
                    trans_id = tt.create_path(entry.name, parent_id)
1569
 
                    file_trans_id[file_id] = trans_id
1570
 
                    tt.version_file(entry.file_id, trans_id)
1571
 
                    executable = tree.is_executable(entry.file_id, tree_path)
1572
 
                    if executable is not None:
1573
 
                        tt.set_executability(executable, trans_id)
1574
 
                    deferred_contents.append((entry.file_id, trans_id))
1575
 
                else:
1576
 
                    file_trans_id[file_id] = new_by_entry(tt, entry, parent_id,
1577
 
                                                          tree)
 
1007
                file_trans_id[file_id] = new_by_entry(tt, entry, parent_id,
 
1008
                                                      tree)
1578
1009
                if reparent:
1579
1010
                    new_trans_id = file_trans_id[file_id]
1580
1011
                    old_parent = tt.trans_id_tree_path(tree_path)
1581
1012
                    _reparent_children(tt, old_parent, new_trans_id)
1582
 
            offset = num + 1 - len(deferred_contents)
1583
 
            _create_files(tt, tree, deferred_contents, pb, offset,
1584
 
                          accelerator_tree, hardlink)
1585
1013
        finally:
1586
1014
            pb.finished()
1587
1015
        pp.next_phase()
1595
1023
            wt.add_conflicts(conflicts)
1596
1024
        except errors.UnsupportedOperation:
1597
1025
            pass
1598
 
        result = tt.apply(no_conflicts=True)
 
1026
        tt.apply()
1599
1027
    finally:
1600
1028
        tt.finalize()
1601
1029
        top_pb.finished()
1602
 
    return result
1603
 
 
1604
 
 
1605
 
def _create_files(tt, tree, desired_files, pb, offset, accelerator_tree,
1606
 
                  hardlink):
1607
 
    total = len(desired_files) + offset
1608
 
    if accelerator_tree is None:
1609
 
        new_desired_files = desired_files
1610
 
    else:
1611
 
        iter = accelerator_tree.iter_changes(tree, include_unchanged=True)
1612
 
        unchanged = dict((f, p[1]) for (f, p, c, v, d, n, k, e)
1613
 
                         in iter if not (c or e[0] != e[1]))
1614
 
        new_desired_files = []
1615
 
        count = 0
1616
 
        for file_id, trans_id in desired_files:
1617
 
            accelerator_path = unchanged.get(file_id)
1618
 
            if accelerator_path is None:
1619
 
                new_desired_files.append((file_id, trans_id))
1620
 
                continue
1621
 
            pb.update('Adding file contents', count + offset, total)
1622
 
            if hardlink:
1623
 
                tt.create_hardlink(accelerator_tree.abspath(accelerator_path),
1624
 
                                   trans_id)
1625
 
            else:
1626
 
                contents = accelerator_tree.get_file(file_id, accelerator_path)
1627
 
                try:
1628
 
                    tt.create_file(contents, trans_id)
1629
 
                finally:
1630
 
                    contents.close()
1631
 
            count += 1
1632
 
        offset += count
1633
 
    for count, (trans_id, contents) in enumerate(tree.iter_files_bytes(
1634
 
                                                 new_desired_files)):
1635
 
        tt.create_file(contents, trans_id)
1636
 
        pb.update('Adding file contents', count + offset, total)
1637
1030
 
1638
1031
 
1639
1032
def _reparent_children(tt, old_parent, new_parent):
1640
1033
    for child in tt.iter_tree_children(old_parent):
1641
1034
        tt.adjust_path(tt.final_name(child), new_parent, child)
1642
1035
 
1643
 
def _reparent_transform_children(tt, old_parent, new_parent):
1644
 
    by_parent = tt.by_parent()
1645
 
    for child in by_parent[old_parent]:
1646
 
        tt.adjust_path(tt.final_name(child), new_parent, child)
1647
1036
 
1648
1037
def _content_match(tree, entry, file_id, kind, target_path):
1649
1038
    if entry.kind != kind:
1697
1086
        executable = tree.is_executable(entry.file_id)
1698
1087
        return tt.new_file(name, parent_id, contents, entry.file_id, 
1699
1088
                           executable)
1700
 
    elif kind in ('directory', 'tree-reference'):
1701
 
        trans_id = tt.new_directory(name, parent_id, entry.file_id)
1702
 
        if kind == 'tree-reference':
1703
 
            tt.set_tree_reference(entry.reference_revision, trans_id)
1704
 
        return trans_id 
 
1089
    elif kind == 'directory':
 
1090
        return tt.new_directory(name, parent_id, entry.file_id)
1705
1091
    elif kind == 'symlink':
1706
1092
        target = tree.get_symlink_target(entry.file_id)
1707
1093
        return tt.new_symlink(name, parent_id, target, entry.file_id)
1708
 
    else:
1709
 
        raise errors.BadFileKindError(name, kind)
1710
 
 
1711
1094
 
1712
1095
def create_by_entry(tt, entry, tree, trans_id, lines=None, mode_id=None):
1713
1096
    """Create new file contents according to an inventory entry."""
1720
1103
    elif entry.kind == "directory":
1721
1104
        tt.create_directory(trans_id)
1722
1105
 
1723
 
 
1724
1106
def create_entry_executability(tt, entry, trans_id):
1725
1107
    """Set the executability of a trans_id according to an inventory entry"""
1726
1108
    if entry.kind == "file":
1727
1109
        tt.set_executability(entry.executable, trans_id)
1728
1110
 
1729
1111
 
1730
 
@deprecated_function(zero_fifteen)
1731
1112
def find_interesting(working_tree, target_tree, filenames):
1732
 
    """Find the ids corresponding to specified filenames.
1733
 
    
1734
 
    Deprecated: Please use tree1.paths2ids(filenames, [tree2]).
1735
 
    """
1736
 
    working_tree.lock_read()
1737
 
    try:
1738
 
        target_tree.lock_read()
1739
 
        try:
1740
 
            return working_tree.paths2ids(filenames, [target_tree])
1741
 
        finally:
1742
 
            target_tree.unlock()
1743
 
    finally:
1744
 
        working_tree.unlock()
1745
 
 
1746
 
 
1747
 
@deprecated_function(zero_ninety)
 
1113
    """Find the ids corresponding to specified filenames."""
 
1114
    trees = (working_tree, target_tree)
 
1115
    return tree.find_ids_across_trees(filenames, trees)
 
1116
 
 
1117
 
1748
1118
def change_entry(tt, file_id, working_tree, target_tree, 
1749
1119
                 trans_id_file_id, backups, trans_id, by_parent):
1750
1120
    """Replace a file_id's contents with those from a target tree."""
1751
 
    if file_id is None and target_tree is None:
1752
 
        # skip the logic altogether in the deprecation test
1753
 
        return
1754
1121
    e_trans_id = trans_id_file_id(file_id)
1755
1122
    entry = target_tree.inventory[file_id]
1756
1123
    has_contents, contents_mod, meta_mod, = _entry_changes(file_id, entry, 
1831
1198
    return has_contents, contents_mod, meta_mod
1832
1199
 
1833
1200
 
1834
 
def revert(working_tree, target_tree, filenames, backups=False,
1835
 
           pb=DummyProgress(), change_reporter=None):
 
1201
def revert(working_tree, target_tree, filenames, backups=False, 
 
1202
           pb=DummyProgress()):
1836
1203
    """Revert a working tree's contents to those of a target tree."""
1837
 
    target_tree.lock_read()
 
1204
    interesting_ids = find_interesting(working_tree, target_tree, filenames)
1838
1205
    tt = TreeTransform(working_tree, pb)
1839
1206
    try:
1840
1207
        pp = ProgressPhase("Revert phase", 3, pb)
1841
1208
        pp.next_phase()
1842
1209
        child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1843
1210
        try:
1844
 
            merge_modified = _alter_files(working_tree, target_tree, tt,
1845
 
                                          child_pb, filenames, backups)
 
1211
            _alter_files(working_tree, target_tree, tt, child_pb, 
 
1212
                         interesting_ids, backups)
1846
1213
        finally:
1847
1214
            child_pb.finished()
1848
1215
        pp.next_phase()
1849
1216
        child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1850
1217
        try:
1851
 
            raw_conflicts = resolve_conflicts(tt, child_pb,
1852
 
                lambda t, c: conflict_pass(t, c, target_tree))
 
1218
            raw_conflicts = resolve_conflicts(tt, child_pb)
1853
1219
        finally:
1854
1220
            child_pb.finished()
1855
1221
        conflicts = cook_conflicts(raw_conflicts, tt)
1856
 
        if change_reporter:
1857
 
            change_reporter = delta._ChangeReporter(
1858
 
                unversioned_filter=working_tree.is_ignored)
1859
 
            delta.report_changes(tt.iter_changes(), change_reporter)
1860
1222
        for conflict in conflicts:
1861
1223
            warning(conflict)
1862
1224
        pp.next_phase()
1863
1225
        tt.apply()
1864
 
        working_tree.set_merge_modified(merge_modified)
 
1226
        working_tree.set_merge_modified({})
1865
1227
    finally:
1866
 
        target_tree.unlock()
1867
1228
        tt.finalize()
1868
1229
        pb.clear()
1869
1230
    return conflicts
1870
1231
 
1871
1232
 
1872
 
def _alter_files(working_tree, target_tree, tt, pb, specific_files,
1873
 
                 backups):
 
1233
def _alter_files(working_tree, target_tree, tt, pb, interesting_ids, backups):
1874
1234
    merge_modified = working_tree.merge_modified()
1875
 
    change_list = target_tree.iter_changes(working_tree,
1876
 
        specific_files=specific_files, pb=pb)
 
1235
    iterator = target_tree._iter_changes(working_tree, 
 
1236
                                         specific_file_ids=interesting_ids,
 
1237
                                         pb=pb)
1877
1238
    if target_tree.inventory.root is None:
1878
1239
        skip_root = True
1879
1240
    else:
1880
1241
        skip_root = False
1881
1242
    basis_tree = None
1882
 
    try:
1883
 
        deferred_files = []
1884
 
        for id_num, (file_id, path, changed_content, versioned, parent, name,
1885
 
                kind, executable) in enumerate(change_list):
1886
 
            if skip_root and file_id[0] is not None and parent[0] is None:
1887
 
                continue
1888
 
            trans_id = tt.trans_id_file_id(file_id)
1889
 
            mode_id = None
1890
 
            if changed_content:
1891
 
                keep_content = False
1892
 
                if kind[0] == 'file' and (backups or kind[1] is None):
1893
 
                    wt_sha1 = working_tree.get_file_sha1(file_id)
1894
 
                    if merge_modified.get(file_id) != wt_sha1:
1895
 
                        # acquire the basis tree lazily to prevent the
1896
 
                        # expense of accessing it when it's not needed ?
1897
 
                        # (Guessing, RBC, 200702)
1898
 
                        if basis_tree is None:
1899
 
                            basis_tree = working_tree.basis_tree()
1900
 
                            basis_tree.lock_read()
1901
 
                        if file_id in basis_tree:
1902
 
                            if wt_sha1 != basis_tree.get_file_sha1(file_id):
1903
 
                                keep_content = True
1904
 
                        elif kind[1] is None and not versioned[1]:
1905
 
                            keep_content = True
1906
 
                if kind[0] is not None:
1907
 
                    if not keep_content:
1908
 
                        tt.delete_contents(trans_id)
1909
 
                    elif kind[1] is not None:
1910
 
                        parent_trans_id = tt.trans_id_file_id(parent[0])
1911
 
                        by_parent = tt.by_parent()
1912
 
                        backup_name = _get_backup_name(name[0], by_parent,
1913
 
                                                       parent_trans_id, tt)
1914
 
                        tt.adjust_path(backup_name, parent_trans_id, trans_id)
1915
 
                        new_trans_id = tt.create_path(name[0], parent_trans_id)
1916
 
                        if versioned == (True, True):
1917
 
                            tt.unversion_file(trans_id)
1918
 
                            tt.version_file(file_id, new_trans_id)
1919
 
                        # New contents should have the same unix perms as old
1920
 
                        # contents
1921
 
                        mode_id = trans_id
1922
 
                        trans_id = new_trans_id
1923
 
                if kind[1] == 'directory':
1924
 
                    tt.create_directory(trans_id)
1925
 
                elif kind[1] == 'symlink':
1926
 
                    tt.create_symlink(target_tree.get_symlink_target(file_id),
1927
 
                                      trans_id)
1928
 
                elif kind[1] == 'file':
1929
 
                    deferred_files.append((file_id, (trans_id, mode_id)))
 
1243
    for id_num, (file_id, path, changed_content, versioned, parent, name, kind,
 
1244
                 executable) in enumerate(iterator):
 
1245
        if skip_root and file_id[0] is not None and parent[0] is None:
 
1246
            continue
 
1247
        trans_id = tt.trans_id_file_id(file_id)
 
1248
        mode_id = None
 
1249
        if changed_content:
 
1250
            keep_content = False
 
1251
            if kind[0] == 'file' and (backups or kind[1] is None):
 
1252
                wt_sha1 = working_tree.get_file_sha1(file_id)
 
1253
                if merge_modified.get(file_id) != wt_sha1:
1930
1254
                    if basis_tree is None:
1931
1255
                        basis_tree = working_tree.basis_tree()
1932
 
                        basis_tree.lock_read()
1933
 
                    new_sha1 = target_tree.get_file_sha1(file_id)
1934
 
                    if (file_id in basis_tree and new_sha1 ==
1935
 
                        basis_tree.get_file_sha1(file_id)):
1936
 
                        if file_id in merge_modified:
1937
 
                            del merge_modified[file_id]
1938
 
                    else:
1939
 
                        merge_modified[file_id] = new_sha1
1940
 
 
1941
 
                    # preserve the execute bit when backing up
1942
 
                    if keep_content and executable[0] == executable[1]:
1943
 
                        tt.set_executability(executable[1], trans_id)
1944
 
                else:
1945
 
                    assert kind[1] is None
1946
 
            if versioned == (False, True):
1947
 
                tt.version_file(file_id, trans_id)
1948
 
            if versioned == (True, False):
1949
 
                tt.unversion_file(trans_id)
1950
 
            if (name[1] is not None and 
1951
 
                (name[0] != name[1] or parent[0] != parent[1])):
1952
 
                tt.adjust_path(
1953
 
                    name[1], tt.trans_id_file_id(parent[1]), trans_id)
1954
 
            if executable[0] != executable[1] and kind[1] == "file":
1955
 
                tt.set_executability(executable[1], trans_id)
1956
 
        for (trans_id, mode_id), bytes in target_tree.iter_files_bytes(
1957
 
            deferred_files):
1958
 
            tt.create_file(bytes, trans_id, mode_id)
1959
 
    finally:
1960
 
        if basis_tree is not None:
1961
 
            basis_tree.unlock()
1962
 
    return merge_modified
 
1256
                    if file_id in basis_tree:
 
1257
                        if wt_sha1 != basis_tree.get_file_sha1(file_id):
 
1258
                            keep_content = True
 
1259
                    elif kind[1] is None and not versioned[1]:
 
1260
                        keep_content = True
 
1261
            if kind[0] is not None:
 
1262
                if not keep_content:
 
1263
                    tt.delete_contents(trans_id)
 
1264
                elif kind[1] is not None:
 
1265
                    parent_trans_id = tt.trans_id_file_id(parent[0])
 
1266
                    by_parent = tt.by_parent()
 
1267
                    backup_name = _get_backup_name(name[0], by_parent,
 
1268
                                                   parent_trans_id, tt)
 
1269
                    tt.adjust_path(backup_name, parent_trans_id, trans_id)
 
1270
                    new_trans_id = tt.create_path(name[0], parent_trans_id)
 
1271
                    if versioned == (True, True):
 
1272
                        tt.unversion_file(trans_id)
 
1273
                        tt.version_file(file_id, new_trans_id)
 
1274
                    # New contents should have the same unix perms as old
 
1275
                    # contents
 
1276
                    mode_id = trans_id
 
1277
                    trans_id = new_trans_id
 
1278
            if kind[1] == 'directory':
 
1279
                tt.create_directory(trans_id)
 
1280
            elif kind[1] == 'symlink':
 
1281
                tt.create_symlink(target_tree.get_symlink_target(file_id),
 
1282
                                  trans_id)
 
1283
            elif kind[1] == 'file':
 
1284
                tt.create_file(target_tree.get_file_lines(file_id),
 
1285
                               trans_id, mode_id)
 
1286
                # preserve the execute bit when backing up
 
1287
                if keep_content and executable[0] == executable[1]:
 
1288
                    tt.set_executability(executable[1], trans_id)
 
1289
            else:
 
1290
                assert kind[1] is None
 
1291
        if versioned == (False, True):
 
1292
            tt.version_file(file_id, trans_id)
 
1293
        if versioned == (True, False):
 
1294
            tt.unversion_file(trans_id)
 
1295
        if (name[1] is not None and 
 
1296
            (name[0] != name[1] or parent[0] != parent[1])):
 
1297
            tt.adjust_path(name[1], tt.trans_id_file_id(parent[1]), trans_id)
 
1298
        if executable[0] != executable[1] and kind[1] == "file":
 
1299
            tt.set_executability(executable[1], trans_id)
1963
1300
 
1964
1301
 
1965
1302
def resolve_conflicts(tt, pb=DummyProgress(), pass_func=None):
1979
1316
        pb.clear()
1980
1317
 
1981
1318
 
1982
 
def conflict_pass(tt, conflicts, path_tree=None):
1983
 
    """Resolve some classes of conflicts.
1984
 
 
1985
 
    :param tt: The transform to resolve conflicts in
1986
 
    :param conflicts: The conflicts to resolve
1987
 
    :param path_tree: A Tree to get supplemental paths from
1988
 
    """
 
1319
def conflict_pass(tt, conflicts):
 
1320
    """Resolve some classes of conflicts."""
1989
1321
    new_conflicts = set()
1990
1322
    for c_type, conflict in ((c[0], c) for c in conflicts):
1991
1323
        if c_type == 'duplicate id':
1994
1326
                               conflict[1], conflict[2], ))
1995
1327
        elif c_type == 'duplicate':
1996
1328
            # files that were renamed take precedence
 
1329
            new_name = tt.final_name(conflict[1])+'.moved'
1997
1330
            final_parent = tt.final_parent(conflict[1])
1998
1331
            if tt.path_changed(conflict[1]):
1999
 
                existing_file, new_file = conflict[2], conflict[1]
 
1332
                tt.adjust_path(new_name, final_parent, conflict[2])
 
1333
                new_conflicts.add((c_type, 'Moved existing file to', 
 
1334
                                   conflict[2], conflict[1]))
2000
1335
            else:
2001
 
                existing_file, new_file = conflict[1], conflict[2]
2002
 
            new_name = tt.final_name(existing_file)+'.moved'
2003
 
            tt.adjust_path(new_name, final_parent, existing_file)
2004
 
            new_conflicts.add((c_type, 'Moved existing file to', 
2005
 
                               existing_file, new_file))
 
1336
                tt.adjust_path(new_name, final_parent, conflict[1])
 
1337
                new_conflicts.add((c_type, 'Moved existing file to', 
 
1338
                                  conflict[1], conflict[2]))
2006
1339
        elif c_type == 'parent loop':
2007
1340
            # break the loop by undoing one of the ops that caused the loop
2008
1341
            cur = conflict[1]
2021
1354
            except KeyError:
2022
1355
                tt.create_directory(trans_id)
2023
1356
                new_conflicts.add((c_type, 'Created directory', trans_id))
2024
 
                try:
2025
 
                    tt.final_name(trans_id)
2026
 
                except NoFinalPath:
2027
 
                    if path_tree is not None:
2028
 
                        file_id = tt.final_file_id(trans_id)
2029
 
                        entry = path_tree.inventory[file_id]
2030
 
                        parent_trans_id = tt.trans_id_file_id(entry.parent_id)
2031
 
                        tt.adjust_path(entry.name, parent_trans_id, trans_id)
2032
1357
        elif c_type == 'unversioned parent':
2033
1358
            tt.version_file(tt.inactive_file_id(conflict[1]), conflict[1])
2034
1359
            new_conflicts.add((c_type, 'Versioned directory', conflict[1]))
2035
 
        elif c_type == 'non-directory parent':
2036
 
            parent_id = conflict[1]
2037
 
            parent_parent = tt.final_parent(parent_id)
2038
 
            parent_name = tt.final_name(parent_id)
2039
 
            parent_file_id = tt.final_file_id(parent_id)
2040
 
            new_parent_id = tt.new_directory(parent_name + '.new',
2041
 
                parent_parent, parent_file_id)
2042
 
            _reparent_transform_children(tt, parent_id, new_parent_id)
2043
 
            if parent_file_id is not None:
2044
 
                tt.unversion_file(parent_id)
2045
 
            new_conflicts.add((c_type, 'Created directory', new_parent_id))
2046
1360
    return new_conflicts
2047
1361
 
2048
1362
 
2072
1386
                                   file_id=modified_id, 
2073
1387
                                   conflict_path=conflicting_path,
2074
1388
                                   conflict_file_id=conflicting_id)
2075
 
 
2076
 
 
2077
 
class _FileMover(object):
2078
 
    """Moves and deletes files for TreeTransform, tracking operations"""
2079
 
 
2080
 
    def __init__(self):
2081
 
        self.past_renames = []
2082
 
        self.pending_deletions = []
2083
 
 
2084
 
    def rename(self, from_, to):
2085
 
        """Rename a file from one path to another.  Functions like os.rename"""
2086
 
        try:
2087
 
            os.rename(from_, to)
2088
 
        except OSError, e:
2089
 
            if e.errno in (errno.EEXIST, errno.ENOTEMPTY):
2090
 
                raise errors.FileExists(to, str(e))
2091
 
            raise
2092
 
        self.past_renames.append((from_, to))
2093
 
 
2094
 
    def pre_delete(self, from_, to):
2095
 
        """Rename a file out of the way and mark it for deletion.
2096
 
 
2097
 
        Unlike os.unlink, this works equally well for files and directories.
2098
 
        :param from_: The current file path
2099
 
        :param to: A temporary path for the file
2100
 
        """
2101
 
        self.rename(from_, to)
2102
 
        self.pending_deletions.append(to)
2103
 
 
2104
 
    def rollback(self):
2105
 
        """Reverse all renames that have been performed"""
2106
 
        for from_, to in reversed(self.past_renames):
2107
 
            os.rename(to, from_)
2108
 
        # after rollback, don't reuse _FileMover
2109
 
        past_renames = None
2110
 
        pending_deletions = None
2111
 
 
2112
 
    def apply_deletions(self):
2113
 
        """Apply all marked deletions"""
2114
 
        for path in self.pending_deletions:
2115
 
            delete_any(path)
2116
 
        # after apply_deletions, don't reuse _FileMover
2117
 
        past_renames = None
2118
 
        pending_deletions = None