/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/transform.py

  • Committer: Martin Pool
  • Date: 2008-01-04 23:53:04 UTC
  • mto: (3170.2.1 1.1)
  • mto: This revision was merged to the branch mainline in revision 3185.
  • Revision ID: mbp@sourcefrog.net-20080104235304-ms9b1y63r710qv2i
Prepare 1.1rc1

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/transform.py
1
 
# Copyright (C) 2006 Canonical Ltd
2
 
 
 
1
# Copyright (C) 2006, 2007 Canonical Ltd
 
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
5
5
# the Free Software Foundation; either version 2 of the License, or
6
6
# (at your option) any later version.
7
 
 
 
7
#
8
8
# This program is distributed in the hope that it will be useful,
9
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11
11
# GNU General Public License for more details.
12
 
 
 
12
#
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
18
18
import errno
19
19
from stat import S_ISREG
20
20
 
 
21
from bzrlib.lazy_import import lazy_import
 
22
lazy_import(globals(), """
 
23
from bzrlib import (
 
24
    bzrdir,
 
25
    delta,
 
26
    errors,
 
27
    inventory
 
28
    )
 
29
""")
21
30
from bzrlib.errors import (DuplicateKey, MalformedTransform, NoSuchFile,
22
31
                           ReusingTransform, NotVersionedError, CantMoveRoot,
23
 
                           ExistingLimbo, ImmortalLimbo)
 
32
                           ExistingLimbo, ImmortalLimbo, NoFinalPath,
 
33
                           UnableCreateSymlink)
24
34
from bzrlib.inventory import InventoryEntry
25
35
from bzrlib.osutils import (file_kind, supports_executable, pathjoin, lexists,
26
 
                            delete_any)
 
36
                            delete_any, has_symlinks)
27
37
from bzrlib.progress import DummyProgress, ProgressPhase
 
38
from bzrlib.symbol_versioning import (
 
39
        deprecated_function,
 
40
        zero_fifteen,
 
41
        zero_ninety,
 
42
        )
28
43
from bzrlib.trace import mutter, warning
29
 
import bzrlib.ui 
 
44
from bzrlib import tree
 
45
import bzrlib.ui
 
46
import bzrlib.urlutils as urlutils
30
47
 
31
48
 
32
49
ROOT_PARENT = "root-parent"
39
56
 
40
57
 
41
58
class _TransformResults(object):
42
 
    def __init__(self, modified_paths):
 
59
    def __init__(self, modified_paths, rename_count):
43
60
        object.__init__(self)
44
61
        self.modified_paths = modified_paths
 
62
        self.rename_count = rename_count
45
63
 
46
64
 
47
65
class TreeTransform(object):
48
66
    """Represent a tree transformation.
49
67
    
50
68
    This object is designed to support incremental generation of the transform,
51
 
    in any order.  
 
69
    in any order.
 
70
 
 
71
    However, it gives optimum performance when parent directories are created
 
72
    before their contents.  The transform is then able to put child files
 
73
    directly in their parent directory, avoiding later renames.
52
74
    
53
75
    It is easy to produce malformed transforms, but they are generally
54
76
    harmless.  Attempting to apply a malformed transform will cause an
68
90
     * create_file or create_directory or create_symlink
69
91
     * version_file
70
92
     * set_executability
 
93
 
 
94
    Transform/Transaction ids
 
95
    -------------------------
 
96
    trans_ids are temporary ids assigned to all files involved in a transform.
 
97
    It's possible, even common, that not all files in the Tree have trans_ids.
 
98
 
 
99
    trans_ids are used because filenames and file_ids are not good enough
 
100
    identifiers; filenames change, and not all files have file_ids.  File-ids
 
101
    are also associated with trans-ids, so that moving a file moves its
 
102
    file-id.
 
103
 
 
104
    trans_ids are only valid for the TreeTransform that generated them.
 
105
 
 
106
    Limbo
 
107
    -----
 
108
    Limbo is a temporary directory use to hold new versions of files.
 
109
    Files are added to limbo by create_file, create_directory, create_symlink,
 
110
    and their convenience variants (new_*).  Files may be removed from limbo
 
111
    using cancel_creation.  Files are renamed from limbo into their final
 
112
    location as part of TreeTransform.apply
 
113
 
 
114
    Limbo must be cleaned up, by either calling TreeTransform.apply or
 
115
    calling TreeTransform.finalize.
 
116
 
 
117
    Files are placed into limbo inside their parent directories, where
 
118
    possible.  This reduces subsequent renames, and makes operations involving
 
119
    lots of files faster.  This optimization is only possible if the parent
 
120
    directory is created *before* creating any of its children, so avoid
 
121
    creating children before parents, where possible.
 
122
 
 
123
    Pending-deletion
 
124
    ----------------
 
125
    This temporary directory is used by _FileMover for storing files that are
 
126
    about to be deleted.  In case of rollback, the files will be restored.
 
127
    FileMover does not delete files until it is sure that a rollback will not
 
128
    happen.  
71
129
    """
72
130
    def __init__(self, tree, pb=DummyProgress()):
73
 
        """Note: a write lock is taken on the tree.
 
131
        """Note: a tree_write lock is taken on the tree.
74
132
        
75
 
        Use TreeTransform.finalize() to release the lock
 
133
        Use TreeTransform.finalize() to release the lock (can be omitted if
 
134
        TreeTransform.apply() called).
76
135
        """
77
136
        object.__init__(self)
78
137
        self._tree = tree
79
 
        self._tree.lock_write()
 
138
        self._tree.lock_tree_write()
80
139
        try:
81
140
            control_files = self._tree._control_files
82
 
            self._limbodir = control_files.controlfilename('limbo')
 
141
            self._limbodir = urlutils.local_path_from_url(
 
142
                control_files.controlfilename('limbo'))
83
143
            try:
84
144
                os.mkdir(self._limbodir)
85
145
            except OSError, e:
86
146
                if e.errno == errno.EEXIST:
87
147
                    raise ExistingLimbo(self._limbodir)
 
148
            self._deletiondir = urlutils.local_path_from_url(
 
149
                control_files.controlfilename('pending-deletion'))
 
150
            try:
 
151
                os.mkdir(self._deletiondir)
 
152
            except OSError, e:
 
153
                if e.errno == errno.EEXIST:
 
154
                    raise errors.ExistingPendingDeletion(self._deletiondir)
 
155
 
88
156
        except: 
89
157
            self._tree.unlock()
90
158
            raise
91
159
 
 
160
        # counter used to generate trans-ids (which are locally unique)
92
161
        self._id_number = 0
 
162
        # mapping of trans_id -> new basename
93
163
        self._new_name = {}
 
164
        # mapping of trans_id -> new parent trans_id
94
165
        self._new_parent = {}
 
166
        # mapping of trans_id with new contents -> new file_kind
95
167
        self._new_contents = {}
 
168
        # A mapping of transform ids to their limbo filename
 
169
        self._limbo_files = {}
 
170
        # A mapping of transform ids to a set of the transform ids of children
 
171
        # that their limbo directory has
 
172
        self._limbo_children = {}
 
173
        # Map transform ids to maps of child filename to child transform id
 
174
        self._limbo_children_names = {}
 
175
        # List of transform ids that need to be renamed from limbo into place
 
176
        self._needs_rename = set()
 
177
        # Set of trans_ids whose contents will be removed
96
178
        self._removed_contents = set()
 
179
        # Mapping of trans_id -> new execute-bit value
97
180
        self._new_executability = {}
 
181
        # Mapping of trans_id -> new tree-reference value
 
182
        self._new_reference_revision = {}
 
183
        # Mapping of trans_id -> new file_id
98
184
        self._new_id = {}
 
185
        # Mapping of old file-id -> trans_id
99
186
        self._non_present_ids = {}
 
187
        # Mapping of new file_id -> trans_id
100
188
        self._r_new_id = {}
 
189
        # Set of file_ids that will be removed
101
190
        self._removed_id = set()
 
191
        # Mapping of path in old tree -> trans_id
102
192
        self._tree_path_ids = {}
 
193
        # Mapping trans_id -> path in old tree
103
194
        self._tree_id_paths = {}
 
195
        # Cache of realpath results, to speed up canonical_path
 
196
        self._realpaths = {}
 
197
        # Cache of relpath results, to speed up canonical_path
 
198
        self._relpaths = {}
 
199
        # The trans_id that will be used as the tree root
104
200
        self._new_root = self.trans_id_tree_file_id(tree.get_root_id())
 
201
        # Indictor of whether the transform has been applied
105
202
        self.__done = False
 
203
        # A progress bar
106
204
        self._pb = pb
 
205
        # A counter of how many files have been renamed
 
206
        self.rename_count = 0
107
207
 
108
208
    def __get_root(self):
109
209
        return self._new_root
111
211
    root = property(__get_root)
112
212
 
113
213
    def finalize(self):
114
 
        """Release the working tree lock, if held, clean up limbo dir."""
 
214
        """Release the working tree lock, if held, clean up limbo dir.
 
215
 
 
216
        This is required if apply has not been invoked, but can be invoked
 
217
        even after apply.
 
218
        """
115
219
        if self._tree is None:
116
220
            return
117
221
        try:
118
 
            for trans_id, kind in self._new_contents.iteritems():
119
 
                path = self._limbo_name(trans_id)
 
222
            entries = [(self._limbo_name(t), t, k) for t, k in
 
223
                       self._new_contents.iteritems()]
 
224
            entries.sort(reverse=True)
 
225
            for path, trans_id, kind in entries:
120
226
                if kind == "directory":
121
227
                    os.rmdir(path)
122
228
                else:
126
232
            except OSError:
127
233
                # We don't especially care *why* the dir is immortal.
128
234
                raise ImmortalLimbo(self._limbodir)
 
235
            try:
 
236
                os.rmdir(self._deletiondir)
 
237
            except OSError:
 
238
                raise errors.ImmortalPendingDeletion(self._deletiondir)
129
239
        finally:
130
240
            self._tree.unlock()
131
241
            self._tree = None
147
257
        """Change the path that is assigned to a transaction id."""
148
258
        if trans_id == self._new_root:
149
259
            raise CantMoveRoot
 
260
        previous_parent = self._new_parent.get(trans_id)
 
261
        previous_name = self._new_name.get(trans_id)
150
262
        self._new_name[trans_id] = name
151
263
        self._new_parent[trans_id] = parent
 
264
        if (trans_id in self._limbo_files and
 
265
            trans_id not in self._needs_rename):
 
266
            self._rename_in_limbo([trans_id])
 
267
            self._limbo_children[previous_parent].remove(trans_id)
 
268
            del self._limbo_children_names[previous_parent][previous_name]
 
269
 
 
270
    def _rename_in_limbo(self, trans_ids):
 
271
        """Fix limbo names so that the right final path is produced.
 
272
 
 
273
        This means we outsmarted ourselves-- we tried to avoid renaming
 
274
        these files later by creating them with their final names in their
 
275
        final parents.  But now the previous name or parent is no longer
 
276
        suitable, so we have to rename them.
 
277
 
 
278
        Even for trans_ids that have no new contents, we must remove their
 
279
        entries from _limbo_files, because they are now stale.
 
280
        """
 
281
        for trans_id in trans_ids:
 
282
            old_path = self._limbo_files.pop(trans_id)
 
283
            if trans_id not in self._new_contents:
 
284
                continue
 
285
            new_path = self._limbo_name(trans_id)
 
286
            os.rename(old_path, new_path)
152
287
 
153
288
    def adjust_root_path(self, name, parent):
154
289
        """Emulate moving the root by moving all children, instead.
211
346
    def canonical_path(self, path):
212
347
        """Get the canonical tree-relative path"""
213
348
        # don't follow final symlinks
214
 
        dirname, basename = os.path.split(self._tree.abspath(path))
215
 
        dirname = os.path.realpath(dirname)
216
 
        return self._tree.relpath(pathjoin(dirname, basename))
 
349
        abs = self._tree.abspath(path)
 
350
        if abs in self._relpaths:
 
351
            return self._relpaths[abs]
 
352
        dirname, basename = os.path.split(abs)
 
353
        if dirname not in self._realpaths:
 
354
            self._realpaths[dirname] = os.path.realpath(dirname)
 
355
        dirname = self._realpaths[dirname]
 
356
        abs = pathjoin(dirname, basename)
 
357
        if dirname in self._relpaths:
 
358
            relpath = pathjoin(self._relpaths[dirname], basename)
 
359
            relpath = relpath.rstrip('/\\')
 
360
        else:
 
361
            relpath = self._tree.relpath(abs)
 
362
        self._relpaths[abs] = relpath
 
363
        return relpath
217
364
 
218
365
    def trans_id_tree_path(self, path):
219
366
        """Determine (and maybe set) the transaction ID for a tree path."""
241
388
        New file takes the permissions of any existing file with that id,
242
389
        unless mode_id is specified.
243
390
        """
244
 
        f = file(self._limbo_name(trans_id), 'wb')
245
 
        unique_add(self._new_contents, trans_id, 'file')
246
 
        for segment in contents:
247
 
            f.write(segment)
248
 
        f.close()
 
391
        name = self._limbo_name(trans_id)
 
392
        f = open(name, 'wb')
 
393
        try:
 
394
            try:
 
395
                unique_add(self._new_contents, trans_id, 'file')
 
396
            except:
 
397
                # Clean up the file, it never got registered so
 
398
                # TreeTransform.finalize() won't clean it up.
 
399
                f.close()
 
400
                os.unlink(name)
 
401
                raise
 
402
 
 
403
            f.writelines(contents)
 
404
        finally:
 
405
            f.close()
249
406
        self._set_mode(trans_id, mode_id, S_ISREG)
250
407
 
251
408
    def _set_mode(self, trans_id, mode_id, typefunc):
261
418
        except KeyError:
262
419
            return
263
420
        try:
264
 
            mode = os.stat(old_path).st_mode
 
421
            mode = os.stat(self._tree.abspath(old_path)).st_mode
265
422
        except OSError, e:
266
423
            if e.errno == errno.ENOENT:
267
424
                return
284
441
        target is a bytestring.
285
442
        See also new_symlink.
286
443
        """
287
 
        os.symlink(target, self._limbo_name(trans_id))
288
 
        unique_add(self._new_contents, trans_id, 'symlink')
 
444
        if has_symlinks():
 
445
            os.symlink(target, self._limbo_name(trans_id))
 
446
            unique_add(self._new_contents, trans_id, 'symlink')
 
447
        else:
 
448
            try:
 
449
                path = FinalPaths(self).get_path(trans_id)
 
450
            except KeyError:
 
451
                path = None
 
452
            raise UnableCreateSymlink(path=path)
289
453
 
290
454
    def cancel_creation(self, trans_id):
291
455
        """Cancel the creation of new file contents."""
292
456
        del self._new_contents[trans_id]
 
457
        children = self._limbo_children.get(trans_id)
 
458
        # if this is a limbo directory with children, move them before removing
 
459
        # the directory
 
460
        if children is not None:
 
461
            self._rename_in_limbo(children)
 
462
            del self._limbo_children[trans_id]
 
463
            del self._limbo_children_names[trans_id]
293
464
        delete_any(self._limbo_name(trans_id))
294
465
 
295
466
    def delete_contents(self, trans_id):
319
490
        else:
320
491
            unique_add(self._new_executability, trans_id, executability)
321
492
 
 
493
    def set_tree_reference(self, revision_id, trans_id):
 
494
        """Set the reference associated with a directory"""
 
495
        unique_add(self._new_reference_revision, trans_id, revision_id)
 
496
 
322
497
    def version_file(self, file_id, trans_id):
323
498
        """Schedule a file to become versioned."""
324
499
        assert file_id is not None
381
556
            return None
382
557
        # the file is old; the old id is still valid
383
558
        if self._new_root == trans_id:
384
 
            return self._tree.inventory.root.file_id
 
559
            return self._tree.get_root_id()
385
560
        return self._tree.inventory.path2id(path)
386
561
 
387
562
    def final_file_id(self, trans_id):
426
601
        try:
427
602
            return self._new_name[trans_id]
428
603
        except KeyError:
429
 
            return os.path.basename(self._tree_id_paths[trans_id])
 
604
            try:
 
605
                return os.path.basename(self._tree_id_paths[trans_id])
 
606
            except KeyError:
 
607
                raise NoFinalPath(trans_id, self)
430
608
 
431
609
    def by_parent(self):
432
610
        """Return a map of parent: children for known parents.
445
623
 
446
624
    def path_changed(self, trans_id):
447
625
        """Return True if a trans_id's path has changed."""
448
 
        return trans_id in self._new_name or trans_id in self._new_parent
 
626
        return (trans_id in self._new_name) or (trans_id in self._new_parent)
 
627
 
 
628
    def new_contents(self, trans_id):
 
629
        return (trans_id in self._new_contents)
449
630
 
450
631
    def find_conflicts(self):
451
632
        """Find any violations of inventory or filesystem invariants"""
477
658
                        self.tree_kind(t) == 'directory'])
478
659
        for trans_id in self._removed_id:
479
660
            file_id = self.tree_file_id(trans_id)
480
 
            if self._tree.inventory[file_id].kind in ('directory', 
481
 
                                                      'root_directory'):
 
661
            if file_id is not None:
 
662
                if self._tree.inventory[file_id].kind == 'directory':
 
663
                    parents.append(trans_id)
 
664
            elif self.tree_kind(trans_id) == 'directory':
482
665
                parents.append(trans_id)
483
666
 
484
667
        for parent_id in parents:
494
677
        try:
495
678
            children = os.listdir(self._tree.abspath(path))
496
679
        except OSError, e:
497
 
            if e.errno != errno.ENOENT and e.errno != errno.ESRCH:
 
680
            if e.errno not in (errno.ENOENT, errno.ESRCH, errno.ENOTDIR):
498
681
                raise
499
682
            return
500
683
            
521
704
        if child_id is None:
522
705
            return lexists(self._tree.abspath(childpath))
523
706
        else:
524
 
            if tt.final_parent(child_id) != parent_id:
 
707
            if self.final_parent(child_id) != parent_id:
525
708
                return False
526
 
            if child_id in tt._removed_contents:
 
709
            if child_id in self._removed_contents:
527
710
                # XXX What about dangling file-ids?
528
711
                return False
529
712
            else:
537
720
            parent_id = trans_id
538
721
            while parent_id is not ROOT_PARENT:
539
722
                seen.add(parent_id)
540
 
                parent_id = self.final_parent(parent_id)
 
723
                try:
 
724
                    parent_id = self.final_parent(parent_id)
 
725
                except KeyError:
 
726
                    break
541
727
                if parent_id == trans_id:
542
728
                    conflicts.append(('parent loop', trans_id))
543
729
                if parent_id in seen:
611
797
    def _duplicate_entries(self, by_parent):
612
798
        """No directory may have two entries with the same name."""
613
799
        conflicts = []
 
800
        if (self._new_name, self._new_parent) == ({}, {}):
 
801
            return conflicts
614
802
        for children in by_parent.itervalues():
615
803
            name_ids = [(self.final_name(t), t) for t in children]
 
804
            if not self._tree.case_sensitive:
 
805
                name_ids = [(n.lower(), t) for n, t in name_ids]
616
806
            name_ids.sort()
617
807
            last_name = None
618
808
            last_trans_id = None
619
809
            for name, trans_id in name_ids:
 
810
                try:
 
811
                    kind = self.final_kind(trans_id)
 
812
                except NoSuchFile:
 
813
                    kind = None
 
814
                file_id = self.final_file_id(trans_id)
 
815
                if kind is None and file_id is None:
 
816
                    continue
620
817
                if name == last_name:
621
818
                    conflicts.append(('duplicate', last_trans_id, trans_id,
622
819
                    name))
623
 
                try:
624
 
                    kind = self.final_kind(trans_id)
625
 
                except NoSuchFile:
626
 
                    kind = None
627
 
                file_id = self.final_file_id(trans_id)
628
 
                if kind is not None or file_id is not None:
629
 
                    last_name = name
630
 
                    last_trans_id = trans_id
 
820
                last_name = name
 
821
                last_trans_id = trans_id
631
822
        return conflicts
632
823
 
633
824
    def _duplicate_ids(self):
676
867
            return True
677
868
        return False
678
869
            
679
 
    def apply(self):
 
870
    def apply(self, no_conflicts=False, _mover=None):
680
871
        """Apply all changes to the inventory and filesystem.
681
872
        
682
873
        If filesystem or inventory conflicts are present, MalformedTransform
683
874
        will be thrown.
 
875
 
 
876
        If apply succeeds, finalize is not necessary.
 
877
 
 
878
        :param no_conflicts: if True, the caller guarantees there are no
 
879
            conflicts, so no check is made.
 
880
        :param _mover: Supply an alternate FileMover, for testing
684
881
        """
685
 
        conflicts = self.find_conflicts()
686
 
        if len(conflicts) != 0:
687
 
            raise MalformedTransform(conflicts=conflicts)
688
 
        limbo_inv = {}
 
882
        if not no_conflicts:
 
883
            conflicts = self.find_conflicts()
 
884
            if len(conflicts) != 0:
 
885
                raise MalformedTransform(conflicts=conflicts)
689
886
        inv = self._tree.inventory
 
887
        inventory_delta = []
690
888
        child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
691
889
        try:
692
 
            child_pb.update('Apply phase', 0, 2)
693
 
            self._apply_removals(inv, limbo_inv)
694
 
            child_pb.update('Apply phase', 1, 2)
695
 
            modified_paths = self._apply_insertions(inv, limbo_inv)
 
890
            if _mover is None:
 
891
                mover = _FileMover()
 
892
            else:
 
893
                mover = _mover
 
894
            try:
 
895
                child_pb.update('Apply phase', 0, 2)
 
896
                self._apply_removals(inv, inventory_delta, mover)
 
897
                child_pb.update('Apply phase', 1, 2)
 
898
                modified_paths = self._apply_insertions(inv, inventory_delta,
 
899
                                                        mover)
 
900
            except:
 
901
                mover.rollback()
 
902
                raise
 
903
            else:
 
904
                mover.apply_deletions()
696
905
        finally:
697
906
            child_pb.finished()
698
 
        self._tree._write_inventory(inv)
 
907
        self._tree.apply_inventory_delta(inventory_delta)
699
908
        self.__done = True
700
909
        self.finalize()
701
 
        return _TransformResults(modified_paths)
 
910
        return _TransformResults(modified_paths, self.rename_count)
702
911
 
703
912
    def _limbo_name(self, trans_id):
704
913
        """Generate the limbo name of a file"""
705
 
        return pathjoin(self._limbodir, trans_id)
706
 
 
707
 
    def _apply_removals(self, inv, limbo_inv):
 
914
        limbo_name = self._limbo_files.get(trans_id)
 
915
        if limbo_name is not None:
 
916
            return limbo_name
 
917
        parent = self._new_parent.get(trans_id)
 
918
        # if the parent directory is already in limbo (e.g. when building a
 
919
        # tree), choose a limbo name inside the parent, to reduce further
 
920
        # renames.
 
921
        use_direct_path = False
 
922
        if self._new_contents.get(parent) == 'directory':
 
923
            filename = self._new_name.get(trans_id)
 
924
            if filename is not None:
 
925
                if parent not in self._limbo_children:
 
926
                    self._limbo_children[parent] = set()
 
927
                    self._limbo_children_names[parent] = {}
 
928
                    use_direct_path = True
 
929
                # the direct path can only be used if no other file has
 
930
                # already taken this pathname, i.e. if the name is unused, or
 
931
                # if it is already associated with this trans_id.
 
932
                elif self._tree.case_sensitive:
 
933
                    if (self._limbo_children_names[parent].get(filename)
 
934
                        in (trans_id, None)):
 
935
                        use_direct_path = True
 
936
                else:
 
937
                    for l_filename, l_trans_id in\
 
938
                        self._limbo_children_names[parent].iteritems():
 
939
                        if l_trans_id == trans_id:
 
940
                            continue
 
941
                        if l_filename.lower() == filename.lower():
 
942
                            break
 
943
                    else:
 
944
                        use_direct_path = True
 
945
 
 
946
        if use_direct_path:
 
947
            limbo_name = pathjoin(self._limbo_files[parent], filename)
 
948
            self._limbo_children[parent].add(trans_id)
 
949
            self._limbo_children_names[parent][filename] = trans_id
 
950
        else:
 
951
            limbo_name = pathjoin(self._limbodir, trans_id)
 
952
            self._needs_rename.add(trans_id)
 
953
        self._limbo_files[trans_id] = limbo_name
 
954
        return limbo_name
 
955
 
 
956
    def _apply_removals(self, inv, inventory_delta, mover):
708
957
        """Perform tree operations that remove directory/inventory names.
709
958
        
710
959
        That is, delete files that are to be deleted, and put any files that
720
969
                child_pb.update('removing file', num, len(tree_paths))
721
970
                full_path = self._tree.abspath(path)
722
971
                if trans_id in self._removed_contents:
723
 
                    delete_any(full_path)
 
972
                    mover.pre_delete(full_path, os.path.join(self._deletiondir,
 
973
                                     trans_id))
724
974
                elif trans_id in self._new_name or trans_id in \
725
975
                    self._new_parent:
726
976
                    try:
727
 
                        os.rename(full_path, self._limbo_name(trans_id))
 
977
                        mover.rename(full_path, self._limbo_name(trans_id))
728
978
                    except OSError, e:
729
979
                        if e.errno != errno.ENOENT:
730
980
                            raise
 
981
                    else:
 
982
                        self.rename_count += 1
731
983
                if trans_id in self._removed_id:
732
984
                    if trans_id == self._new_root:
733
 
                        file_id = self._tree.inventory.root.file_id
 
985
                        file_id = self._tree.get_root_id()
734
986
                    else:
735
987
                        file_id = self.tree_file_id(trans_id)
736
 
                    del inv[file_id]
737
 
                elif trans_id in self._new_name or trans_id in self._new_parent:
738
 
                    file_id = self.tree_file_id(trans_id)
739
988
                    if file_id is not None:
740
 
                        limbo_inv[trans_id] = inv[file_id]
741
 
                        del inv[file_id]
 
989
                        inventory_delta.append((path, None, file_id, None))
742
990
        finally:
743
991
            child_pb.finished()
744
992
 
745
 
    def _apply_insertions(self, inv, limbo_inv):
 
993
    def _apply_insertions(self, inv, inventory_delta, mover):
746
994
        """Perform tree operations that insert directory/inventory names.
747
995
        
748
996
        That is, create any files that need to be created, and restore from
752
1000
        new_paths = self.new_paths()
753
1001
        modified_paths = []
754
1002
        child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
1003
        completed_new = []
755
1004
        try:
756
1005
            for num, (path, trans_id) in enumerate(new_paths):
 
1006
                new_entry = None
757
1007
                child_pb.update('adding file', num, len(new_paths))
758
1008
                try:
759
1009
                    kind = self._new_contents[trans_id]
762
1012
                if trans_id in self._new_contents or \
763
1013
                    self.path_changed(trans_id):
764
1014
                    full_path = self._tree.abspath(path)
765
 
                    try:
766
 
                        os.rename(self._limbo_name(trans_id), full_path)
767
 
                    except OSError, e:
768
 
                        # We may be renaming a dangling inventory id
769
 
                        if e.errno != errno.ENOENT:
770
 
                            raise
 
1015
                    if trans_id in self._needs_rename:
 
1016
                        try:
 
1017
                            mover.rename(self._limbo_name(trans_id), full_path)
 
1018
                        except OSError, e:
 
1019
                            # We may be renaming a dangling inventory id
 
1020
                            if e.errno != errno.ENOENT:
 
1021
                                raise
 
1022
                        else:
 
1023
                            self.rename_count += 1
771
1024
                    if trans_id in self._new_contents:
772
1025
                        modified_paths.append(full_path)
773
 
                        del self._new_contents[trans_id]
 
1026
                        completed_new.append(trans_id)
774
1027
 
775
1028
                if trans_id in self._new_id:
776
1029
                    if kind is None:
777
1030
                        kind = file_kind(self._tree.abspath(path))
778
 
                    inv.add_path(path, kind, self._new_id[trans_id])
779
 
                elif trans_id in self._new_name or trans_id in\
780
 
                    self._new_parent:
781
 
                    entry = limbo_inv.get(trans_id)
782
 
                    if entry is not None:
783
 
                        entry.name = self.final_name(trans_id)
784
 
                        parent_path = os.path.dirname(path)
785
 
                        entry.parent_id = \
786
 
                            self._tree.inventory.path2id(parent_path)
787
 
                        inv.add(entry)
788
 
 
789
 
                # requires files and inventory entries to be in place
 
1031
                    if trans_id in self._new_reference_revision:
 
1032
                        new_entry = inventory.TreeReference(
 
1033
                            self._new_id[trans_id],
 
1034
                            self._new_name[trans_id], 
 
1035
                            self.final_file_id(self._new_parent[trans_id]),
 
1036
                            None, self._new_reference_revision[trans_id])
 
1037
                    else:
 
1038
                        new_entry = inventory.make_entry(kind,
 
1039
                            self.final_name(trans_id),
 
1040
                            self.final_file_id(self.final_parent(trans_id)),
 
1041
                            self._new_id[trans_id])
 
1042
                else:
 
1043
                    if trans_id in self._new_name or trans_id in\
 
1044
                        self._new_parent or\
 
1045
                        trans_id in self._new_executability:
 
1046
                        file_id = self.final_file_id(trans_id)
 
1047
                        if file_id is not None:
 
1048
                            entry = inv[file_id]
 
1049
                            new_entry = entry.copy()
 
1050
 
 
1051
                    if trans_id in self._new_name or trans_id in\
 
1052
                        self._new_parent:
 
1053
                            if new_entry is not None:
 
1054
                                new_entry.name = self.final_name(trans_id)
 
1055
                                parent = self.final_parent(trans_id)
 
1056
                                parent_id = self.final_file_id(parent)
 
1057
                                new_entry.parent_id = parent_id
 
1058
 
790
1059
                if trans_id in self._new_executability:
791
 
                    self._set_executability(path, inv, trans_id)
 
1060
                    self._set_executability(path, new_entry, trans_id)
 
1061
                if new_entry is not None:
 
1062
                    if new_entry.file_id in inv:
 
1063
                        old_path = inv.id2path(new_entry.file_id)
 
1064
                    else:
 
1065
                        old_path = None
 
1066
                    inventory_delta.append((old_path, path,
 
1067
                                            new_entry.file_id,
 
1068
                                            new_entry))
792
1069
        finally:
793
1070
            child_pb.finished()
 
1071
        for trans_id in completed_new:
 
1072
            del self._new_contents[trans_id]
794
1073
        return modified_paths
795
1074
 
796
 
    def _set_executability(self, path, inv, trans_id):
 
1075
    def _set_executability(self, path, entry, trans_id):
797
1076
        """Set the executability of versioned files """
798
 
        file_id = inv.path2id(path)
799
1077
        new_executability = self._new_executability[trans_id]
800
 
        inv[file_id].executable = new_executability
 
1078
        entry.executable = new_executability
801
1079
        if supports_executable():
802
1080
            abspath = self._tree.abspath(path)
803
1081
            current_mode = os.stat(abspath).st_mode
829
1107
        parent_id is the transaction id of the parent directory of the file.
830
1108
        contents is an iterator of bytestrings, which will be used to produce
831
1109
        the file.
832
 
        file_id is the inventory ID of the file, if it is to be versioned.
 
1110
        :param file_id: The inventory ID of the file, if it is to be versioned.
 
1111
        :param executable: Only valid when a file_id has been supplied.
833
1112
        """
834
1113
        trans_id = self._new_entry(name, parent_id, file_id)
 
1114
        # TODO: rather than scheduling a set_executable call,
 
1115
        # have create_file create the file with the right mode.
835
1116
        self.create_file(contents, trans_id)
836
1117
        if executable is not None:
837
1118
            self.set_executability(executable, trans_id)
861
1142
        self.create_symlink(target, trans_id)
862
1143
        return trans_id
863
1144
 
 
1145
    def _affected_ids(self):
 
1146
        """Return the set of transform ids affected by the transform"""
 
1147
        trans_ids = set(self._removed_id)
 
1148
        trans_ids.update(self._new_id.keys())
 
1149
        trans_ids.update(self._removed_contents)
 
1150
        trans_ids.update(self._new_contents.keys())
 
1151
        trans_ids.update(self._new_executability.keys())
 
1152
        trans_ids.update(self._new_name.keys())
 
1153
        trans_ids.update(self._new_parent.keys())
 
1154
        return trans_ids
 
1155
 
 
1156
    def _get_file_id_maps(self):
 
1157
        """Return mapping of file_ids to trans_ids in the to and from states"""
 
1158
        trans_ids = self._affected_ids()
 
1159
        from_trans_ids = {}
 
1160
        to_trans_ids = {}
 
1161
        # Build up two dicts: trans_ids associated with file ids in the
 
1162
        # FROM state, vs the TO state.
 
1163
        for trans_id in trans_ids:
 
1164
            from_file_id = self.tree_file_id(trans_id)
 
1165
            if from_file_id is not None:
 
1166
                from_trans_ids[from_file_id] = trans_id
 
1167
            to_file_id = self.final_file_id(trans_id)
 
1168
            if to_file_id is not None:
 
1169
                to_trans_ids[to_file_id] = trans_id
 
1170
        return from_trans_ids, to_trans_ids
 
1171
 
 
1172
    def _from_file_data(self, from_trans_id, from_versioned, file_id):
 
1173
        """Get data about a file in the from (tree) state
 
1174
 
 
1175
        Return a (name, parent, kind, executable) tuple
 
1176
        """
 
1177
        from_path = self._tree_id_paths.get(from_trans_id)
 
1178
        if from_versioned:
 
1179
            # get data from working tree if versioned
 
1180
            from_entry = self._tree.inventory[file_id]
 
1181
            from_name = from_entry.name
 
1182
            from_parent = from_entry.parent_id
 
1183
        else:
 
1184
            from_entry = None
 
1185
            if from_path is None:
 
1186
                # File does not exist in FROM state
 
1187
                from_name = None
 
1188
                from_parent = None
 
1189
            else:
 
1190
                # File exists, but is not versioned.  Have to use path-
 
1191
                # splitting stuff
 
1192
                from_name = os.path.basename(from_path)
 
1193
                tree_parent = self.get_tree_parent(from_trans_id)
 
1194
                from_parent = self.tree_file_id(tree_parent)
 
1195
        if from_path is not None:
 
1196
            from_kind, from_executable, from_stats = \
 
1197
                self._tree._comparison_data(from_entry, from_path)
 
1198
        else:
 
1199
            from_kind = None
 
1200
            from_executable = False
 
1201
        return from_name, from_parent, from_kind, from_executable
 
1202
 
 
1203
    def _to_file_data(self, to_trans_id, from_trans_id, from_executable):
 
1204
        """Get data about a file in the to (target) state
 
1205
 
 
1206
        Return a (name, parent, kind, executable) tuple
 
1207
        """
 
1208
        to_name = self.final_name(to_trans_id)
 
1209
        try:
 
1210
            to_kind = self.final_kind(to_trans_id)
 
1211
        except NoSuchFile:
 
1212
            to_kind = None
 
1213
        to_parent = self.final_file_id(self.final_parent(to_trans_id))
 
1214
        if to_trans_id in self._new_executability:
 
1215
            to_executable = self._new_executability[to_trans_id]
 
1216
        elif to_trans_id == from_trans_id:
 
1217
            to_executable = from_executable
 
1218
        else:
 
1219
            to_executable = False
 
1220
        return to_name, to_parent, to_kind, to_executable
 
1221
 
 
1222
    def _iter_changes(self):
 
1223
        """Produce output in the same format as Tree._iter_changes.
 
1224
 
 
1225
        Will produce nonsensical results if invoked while inventory/filesystem
 
1226
        conflicts (as reported by TreeTransform.find_conflicts()) are present.
 
1227
 
 
1228
        This reads the Transform, but only reproduces changes involving a
 
1229
        file_id.  Files that are not versioned in either of the FROM or TO
 
1230
        states are not reflected.
 
1231
        """
 
1232
        final_paths = FinalPaths(self)
 
1233
        from_trans_ids, to_trans_ids = self._get_file_id_maps()
 
1234
        results = []
 
1235
        # Now iterate through all active file_ids
 
1236
        for file_id in set(from_trans_ids.keys() + to_trans_ids.keys()):
 
1237
            modified = False
 
1238
            from_trans_id = from_trans_ids.get(file_id)
 
1239
            # find file ids, and determine versioning state
 
1240
            if from_trans_id is None:
 
1241
                from_versioned = False
 
1242
                from_trans_id = to_trans_ids[file_id]
 
1243
            else:
 
1244
                from_versioned = True
 
1245
            to_trans_id = to_trans_ids.get(file_id)
 
1246
            if to_trans_id is None:
 
1247
                to_versioned = False
 
1248
                to_trans_id = from_trans_id
 
1249
            else:
 
1250
                to_versioned = True
 
1251
 
 
1252
            from_name, from_parent, from_kind, from_executable = \
 
1253
                self._from_file_data(from_trans_id, from_versioned, file_id)
 
1254
 
 
1255
            to_name, to_parent, to_kind, to_executable = \
 
1256
                self._to_file_data(to_trans_id, from_trans_id, from_executable)
 
1257
 
 
1258
            if not from_versioned:
 
1259
                from_path = None
 
1260
            else:
 
1261
                from_path = self._tree_id_paths.get(from_trans_id)
 
1262
            if not to_versioned:
 
1263
                to_path = None
 
1264
            else:
 
1265
                to_path = final_paths.get_path(to_trans_id)
 
1266
            if from_kind != to_kind:
 
1267
                modified = True
 
1268
            elif to_kind in ('file', 'symlink') and (
 
1269
                to_trans_id != from_trans_id or
 
1270
                to_trans_id in self._new_contents):
 
1271
                modified = True
 
1272
            if (not modified and from_versioned == to_versioned and
 
1273
                from_parent==to_parent and from_name == to_name and
 
1274
                from_executable == to_executable):
 
1275
                continue
 
1276
            results.append((file_id, (from_path, to_path), modified,
 
1277
                   (from_versioned, to_versioned),
 
1278
                   (from_parent, to_parent),
 
1279
                   (from_name, to_name),
 
1280
                   (from_kind, to_kind),
 
1281
                   (from_executable, to_executable)))
 
1282
        return iter(sorted(results, key=lambda x:x[1]))
 
1283
 
 
1284
 
864
1285
def joinpath(parent, child):
865
1286
    """Join tree-relative paths, handling the tree root specially"""
866
1287
    if parent is None or parent == "":
896
1317
            self._known_paths[trans_id] = self._determine_path(trans_id)
897
1318
        return self._known_paths[trans_id]
898
1319
 
 
1320
 
899
1321
def topology_sorted_ids(tree):
900
1322
    """Determine the topological order of the ids in a tree"""
901
1323
    file_ids = list(tree)
902
1324
    file_ids.sort(key=tree.id2path)
903
1325
    return file_ids
904
1326
 
905
 
def build_tree(tree, wt):
906
 
    """Create working tree for a branch, using a Transaction."""
 
1327
 
 
1328
def build_tree(tree, wt, accelerator_tree=None):
 
1329
    """Create working tree for a branch, using a TreeTransform.
 
1330
    
 
1331
    This function should be used on empty trees, having a tree root at most.
 
1332
    (see merge and revert functionality for working with existing trees)
 
1333
 
 
1334
    Existing files are handled like so:
 
1335
    
 
1336
    - Existing bzrdirs take precedence over creating new items.  They are
 
1337
      created as '%s.diverted' % name.
 
1338
    - Otherwise, if the content on disk matches the content we are building,
 
1339
      it is silently replaced.
 
1340
    - Otherwise, conflict resolution will move the old file to 'oldname.moved'.
 
1341
 
 
1342
    :param tree: The tree to convert wt into a copy of
 
1343
    :param wt: The working tree that files will be placed into
 
1344
    :param accelerator_tree: A tree which can be used for retrieving file
 
1345
        contents more quickly than tree itself, i.e. a workingtree.  tree
 
1346
        will be used for cases where accelerator_tree's content is different.
 
1347
    """
 
1348
    wt.lock_tree_write()
 
1349
    try:
 
1350
        tree.lock_read()
 
1351
        try:
 
1352
            if accelerator_tree is not None:
 
1353
                accelerator_tree.lock_read()
 
1354
            try:
 
1355
                return _build_tree(tree, wt, accelerator_tree)
 
1356
            finally:
 
1357
                if accelerator_tree is not None:
 
1358
                    accelerator_tree.unlock()
 
1359
        finally:
 
1360
            tree.unlock()
 
1361
    finally:
 
1362
        wt.unlock()
 
1363
 
 
1364
 
 
1365
def _build_tree(tree, wt, accelerator_tree):
 
1366
    """See build_tree."""
 
1367
    if len(wt.inventory) > 1:  # more than just a root
 
1368
        raise errors.WorkingTreeAlreadyPopulated(base=wt.basedir)
907
1369
    file_trans_id = {}
908
1370
    top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
909
1371
    pp = ProgressPhase("Build phase", 2, top_pb)
 
1372
    if tree.inventory.root is not None:
 
1373
        # This is kind of a hack: we should be altering the root
 
1374
        # as part of the regular tree shape diff logic.
 
1375
        # The conditional test here is to avoid doing an
 
1376
        # expensive operation (flush) every time the root id
 
1377
        # is set within the tree, nor setting the root and thus
 
1378
        # marking the tree as dirty, because we use two different
 
1379
        # idioms here: tree interfaces and inventory interfaces.
 
1380
        if wt.get_root_id() != tree.get_root_id():
 
1381
            wt.set_root_id(tree.get_root_id())
 
1382
            wt.flush()
910
1383
    tt = TreeTransform(wt)
 
1384
    divert = set()
911
1385
    try:
912
1386
        pp.next_phase()
913
 
        file_trans_id[wt.get_root_id()] = tt.trans_id_tree_file_id(wt.get_root_id())
914
 
        file_ids = topology_sorted_ids(tree)
 
1387
        file_trans_id[wt.get_root_id()] = \
 
1388
            tt.trans_id_tree_file_id(wt.get_root_id())
915
1389
        pb = bzrlib.ui.ui_factory.nested_progress_bar()
916
1390
        try:
917
 
            for num, file_id in enumerate(file_ids):
918
 
                pb.update("Building tree", num, len(file_ids))
919
 
                entry = tree.inventory[file_id]
 
1391
            deferred_contents = []
 
1392
            for num, (tree_path, entry) in \
 
1393
                enumerate(tree.inventory.iter_entries_by_dir()):
 
1394
                pb.update("Building tree", num - len(deferred_contents),
 
1395
                          len(tree.inventory))
920
1396
                if entry.parent_id is None:
921
1397
                    continue
 
1398
                reparent = False
 
1399
                file_id = entry.file_id
 
1400
                target_path = wt.abspath(tree_path)
 
1401
                try:
 
1402
                    kind = file_kind(target_path)
 
1403
                except NoSuchFile:
 
1404
                    pass
 
1405
                else:
 
1406
                    if kind == "directory":
 
1407
                        try:
 
1408
                            bzrdir.BzrDir.open(target_path)
 
1409
                        except errors.NotBranchError:
 
1410
                            pass
 
1411
                        else:
 
1412
                            divert.add(file_id)
 
1413
                    if (file_id not in divert and
 
1414
                        _content_match(tree, entry, file_id, kind,
 
1415
                        target_path)):
 
1416
                        tt.delete_contents(tt.trans_id_tree_path(tree_path))
 
1417
                        if kind == 'directory':
 
1418
                            reparent = True
922
1419
                if entry.parent_id not in file_trans_id:
923
 
                    raise repr(entry.parent_id)
 
1420
                    raise AssertionError(
 
1421
                        'entry %s parent id %r is not in file_trans_id %r'
 
1422
                        % (entry, entry.parent_id, file_trans_id))
924
1423
                parent_id = file_trans_id[entry.parent_id]
925
 
                file_trans_id[file_id] = new_by_entry(tt, entry, parent_id, 
926
 
                                                      tree)
 
1424
                if entry.kind == 'file':
 
1425
                    # We *almost* replicate new_by_entry, so that we can defer
 
1426
                    # getting the file text, and get them all at once.
 
1427
                    trans_id = tt.create_path(entry.name, parent_id)
 
1428
                    file_trans_id[file_id] = trans_id
 
1429
                    tt.version_file(entry.file_id, trans_id)
 
1430
                    executable = tree.is_executable(entry.file_id, tree_path)
 
1431
                    if executable is not None:
 
1432
                        tt.set_executability(executable, trans_id)
 
1433
                    deferred_contents.append((entry.file_id, trans_id))
 
1434
                else:
 
1435
                    file_trans_id[file_id] = new_by_entry(tt, entry, parent_id,
 
1436
                                                          tree)
 
1437
                if reparent:
 
1438
                    new_trans_id = file_trans_id[file_id]
 
1439
                    old_parent = tt.trans_id_tree_path(tree_path)
 
1440
                    _reparent_children(tt, old_parent, new_trans_id)
 
1441
            for num, (trans_id, bytes) in enumerate(
 
1442
                _iter_files_bytes_accelerated(tree, accelerator_tree,
 
1443
                                              deferred_contents)):
 
1444
                tt.create_file(bytes, trans_id)
 
1445
                pb.update('Adding file contents',
 
1446
                          (num + len(tree.inventory) - len(deferred_contents)),
 
1447
                          len(tree.inventory))
927
1448
        finally:
928
1449
            pb.finished()
929
1450
        pp.next_phase()
930
 
        tt.apply()
 
1451
        divert_trans = set(file_trans_id[f] for f in divert)
 
1452
        resolver = lambda t, c: resolve_checkout(t, c, divert_trans)
 
1453
        raw_conflicts = resolve_conflicts(tt, pass_func=resolver)
 
1454
        conflicts = cook_conflicts(raw_conflicts, tt)
 
1455
        for conflict in conflicts:
 
1456
            warning(conflict)
 
1457
        try:
 
1458
            wt.add_conflicts(conflicts)
 
1459
        except errors.UnsupportedOperation:
 
1460
            pass
 
1461
        result = tt.apply(no_conflicts=True)
931
1462
    finally:
932
1463
        tt.finalize()
933
1464
        top_pb.finished()
 
1465
    return result
 
1466
 
 
1467
 
 
1468
def _iter_files_bytes_accelerated(tree, accelerator_tree, desired_files):
 
1469
    if accelerator_tree is None:
 
1470
        new_desired_files = desired_files
 
1471
    else:
 
1472
        iter = accelerator_tree._iter_changes(tree, include_unchanged=True)
 
1473
        unchanged = dict((f, p[1]) for (f, p, c, v, d, n, k, e)
 
1474
                         in iter if not c)
 
1475
        new_desired_files = []
 
1476
        for file_id, identifier in desired_files:
 
1477
            accelerator_path = unchanged.get(file_id)
 
1478
            if accelerator_path is None:
 
1479
                new_desired_files.append((file_id, identifier))
 
1480
                continue
 
1481
            contents = accelerator_tree.get_file(file_id, accelerator_path)
 
1482
            try:
 
1483
                want_new = False
 
1484
                contents_bytes = (contents.read(),)
 
1485
            finally:
 
1486
                contents.close()
 
1487
            yield identifier, contents_bytes
 
1488
    for result in tree.iter_files_bytes(new_desired_files):
 
1489
        yield result
 
1490
 
 
1491
 
 
1492
def _reparent_children(tt, old_parent, new_parent):
 
1493
    for child in tt.iter_tree_children(old_parent):
 
1494
        tt.adjust_path(tt.final_name(child), new_parent, child)
 
1495
 
 
1496
def _reparent_transform_children(tt, old_parent, new_parent):
 
1497
    by_parent = tt.by_parent()
 
1498
    for child in by_parent[old_parent]:
 
1499
        tt.adjust_path(tt.final_name(child), new_parent, child)
 
1500
 
 
1501
def _content_match(tree, entry, file_id, kind, target_path):
 
1502
    if entry.kind != kind:
 
1503
        return False
 
1504
    if entry.kind == "directory":
 
1505
        return True
 
1506
    if entry.kind == "file":
 
1507
        if tree.get_file(file_id).read() == file(target_path, 'rb').read():
 
1508
            return True
 
1509
    elif entry.kind == "symlink":
 
1510
        if tree.get_symlink_target(file_id) == os.readlink(target_path):
 
1511
            return True
 
1512
    return False
 
1513
 
 
1514
 
 
1515
def resolve_checkout(tt, conflicts, divert):
 
1516
    new_conflicts = set()
 
1517
    for c_type, conflict in ((c[0], c) for c in conflicts):
 
1518
        # Anything but a 'duplicate' would indicate programmer error
 
1519
        assert c_type == 'duplicate', c_type
 
1520
        # Now figure out which is new and which is old
 
1521
        if tt.new_contents(conflict[1]):
 
1522
            new_file = conflict[1]
 
1523
            old_file = conflict[2]
 
1524
        else:
 
1525
            new_file = conflict[2]
 
1526
            old_file = conflict[1]
 
1527
 
 
1528
        # We should only get here if the conflict wasn't completely
 
1529
        # resolved
 
1530
        final_parent = tt.final_parent(old_file)
 
1531
        if new_file in divert:
 
1532
            new_name = tt.final_name(old_file)+'.diverted'
 
1533
            tt.adjust_path(new_name, final_parent, new_file)
 
1534
            new_conflicts.add((c_type, 'Diverted to',
 
1535
                               new_file, old_file))
 
1536
        else:
 
1537
            new_name = tt.final_name(old_file)+'.moved'
 
1538
            tt.adjust_path(new_name, final_parent, old_file)
 
1539
            new_conflicts.add((c_type, 'Moved existing file to',
 
1540
                               old_file, new_file))
 
1541
    return new_conflicts
 
1542
 
934
1543
 
935
1544
def new_by_entry(tt, entry, parent_id, tree):
936
1545
    """Create a new file according to its inventory entry"""
941
1550
        executable = tree.is_executable(entry.file_id)
942
1551
        return tt.new_file(name, parent_id, contents, entry.file_id, 
943
1552
                           executable)
944
 
    elif kind == 'directory':
945
 
        return tt.new_directory(name, parent_id, entry.file_id)
 
1553
    elif kind in ('directory', 'tree-reference'):
 
1554
        trans_id = tt.new_directory(name, parent_id, entry.file_id)
 
1555
        if kind == 'tree-reference':
 
1556
            tt.set_tree_reference(entry.reference_revision, trans_id)
 
1557
        return trans_id 
946
1558
    elif kind == 'symlink':
947
1559
        target = tree.get_symlink_target(entry.file_id)
948
1560
        return tt.new_symlink(name, parent_id, target, entry.file_id)
 
1561
    else:
 
1562
        raise errors.BadFileKindError(name, kind)
 
1563
 
949
1564
 
950
1565
def create_by_entry(tt, entry, tree, trans_id, lines=None, mode_id=None):
951
1566
    """Create new file contents according to an inventory entry."""
952
1567
    if entry.kind == "file":
953
 
        if lines == None:
 
1568
        if lines is None:
954
1569
            lines = tree.get_file(entry.file_id).readlines()
955
1570
        tt.create_file(lines, trans_id, mode_id=mode_id)
956
1571
    elif entry.kind == "symlink":
958
1573
    elif entry.kind == "directory":
959
1574
        tt.create_directory(trans_id)
960
1575
 
 
1576
 
961
1577
def create_entry_executability(tt, entry, trans_id):
962
1578
    """Set the executability of a trans_id according to an inventory entry"""
963
1579
    if entry.kind == "file":
964
1580
        tt.set_executability(entry.executable, trans_id)
965
1581
 
966
1582
 
 
1583
@deprecated_function(zero_fifteen)
967
1584
def find_interesting(working_tree, target_tree, filenames):
968
 
    """Find the ids corresponding to specified filenames."""
969
 
    if not filenames:
970
 
        interesting_ids = None
971
 
    else:
972
 
        interesting_ids = set()
973
 
        for tree_path in filenames:
974
 
            not_found = True
975
 
            for tree in (working_tree, target_tree):
976
 
                file_id = tree.inventory.path2id(tree_path)
977
 
                if file_id is not None:
978
 
                    interesting_ids.add(file_id)
979
 
                    not_found = False
980
 
            if not_found:
981
 
                raise NotVersionedError(path=tree_path)
982
 
    return interesting_ids
983
 
 
984
 
 
 
1585
    """Find the ids corresponding to specified filenames.
 
1586
    
 
1587
    Deprecated: Please use tree1.paths2ids(filenames, [tree2]).
 
1588
    """
 
1589
    working_tree.lock_read()
 
1590
    try:
 
1591
        target_tree.lock_read()
 
1592
        try:
 
1593
            return working_tree.paths2ids(filenames, [target_tree])
 
1594
        finally:
 
1595
            target_tree.unlock()
 
1596
    finally:
 
1597
        working_tree.unlock()
 
1598
 
 
1599
 
 
1600
@deprecated_function(zero_ninety)
985
1601
def change_entry(tt, file_id, working_tree, target_tree, 
986
1602
                 trans_id_file_id, backups, trans_id, by_parent):
987
1603
    """Replace a file_id's contents with those from a target tree."""
 
1604
    if file_id is None and target_tree is None:
 
1605
        # skip the logic altogether in the deprecation test
 
1606
        return
988
1607
    e_trans_id = trans_id_file_id(file_id)
989
1608
    entry = target_tree.inventory[file_id]
990
1609
    has_contents, contents_mod, meta_mod, = _entry_changes(file_id, entry, 
1023
1642
 
1024
1643
 
1025
1644
def get_backup_name(entry, by_parent, parent_trans_id, tt):
 
1645
    return _get_backup_name(entry.name, by_parent, parent_trans_id, tt)
 
1646
 
 
1647
 
 
1648
def _get_backup_name(name, by_parent, parent_trans_id, tt):
1026
1649
    """Produce a backup-style name that appears to be available"""
1027
1650
    def name_gen():
1028
1651
        counter = 1
1029
1652
        while True:
1030
 
            yield "%s.~%d~" % (entry.name, counter)
 
1653
            yield "%s.~%d~" % (name, counter)
1031
1654
            counter += 1
1032
 
    for name in name_gen():
1033
 
        if not tt.has_named_child(by_parent, parent_trans_id, name):
1034
 
            return name
 
1655
    for new_name in name_gen():
 
1656
        if not tt.has_named_child(by_parent, parent_trans_id, new_name):
 
1657
            return new_name
 
1658
 
1035
1659
 
1036
1660
def _entry_changes(file_id, entry, working_tree):
1037
1661
    """Determine in which ways the inventory entry has changed.
1045
1669
    try:
1046
1670
        working_kind = working_tree.kind(file_id)
1047
1671
        has_contents = True
1048
 
    except OSError, e:
1049
 
        if e.errno != errno.ENOENT:
1050
 
            raise
 
1672
    except NoSuchFile:
1051
1673
        has_contents = False
1052
1674
        contents_mod = True
1053
1675
        meta_mod = False
1054
1676
    if has_contents is True:
1055
 
        real_e_kind = entry.kind
1056
 
        if real_e_kind == 'root_directory':
1057
 
            real_e_kind = 'directory'
1058
 
        if real_e_kind != working_kind:
 
1677
        if entry.kind != working_kind:
1059
1678
            contents_mod, meta_mod = True, False
1060
1679
        else:
1061
1680
            cur_entry._read_tree_state(working_tree.id2path(file_id), 
1065
1684
    return has_contents, contents_mod, meta_mod
1066
1685
 
1067
1686
 
1068
 
def revert(working_tree, target_tree, filenames, backups=False, 
1069
 
           pb=DummyProgress()):
 
1687
def revert(working_tree, target_tree, filenames, backups=False,
 
1688
           pb=DummyProgress(), change_reporter=None):
1070
1689
    """Revert a working tree's contents to those of a target tree."""
1071
 
    interesting_ids = find_interesting(working_tree, target_tree, filenames)
1072
 
    def interesting(file_id):
1073
 
        return interesting_ids is None or file_id in interesting_ids
1074
 
 
 
1690
    target_tree.lock_read()
1075
1691
    tt = TreeTransform(working_tree, pb)
1076
1692
    try:
1077
 
        merge_modified = working_tree.merge_modified()
1078
 
        trans_id = {}
1079
 
        def trans_id_file_id(file_id):
1080
 
            try:
1081
 
                return trans_id[file_id]
1082
 
            except KeyError:
1083
 
                return tt.trans_id_tree_file_id(file_id)
1084
 
 
1085
 
        pp = ProgressPhase("Revert phase", 4, pb)
1086
 
        pp.next_phase()
1087
 
        sorted_interesting = [i for i in topology_sorted_ids(target_tree) if
1088
 
                              interesting(i)]
1089
 
        child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1090
 
        try:
1091
 
            by_parent = tt.by_parent()
1092
 
            for id_num, file_id in enumerate(sorted_interesting):
1093
 
                child_pb.update("Reverting file", id_num+1, 
1094
 
                                len(sorted_interesting))
1095
 
                if file_id not in working_tree.inventory:
1096
 
                    entry = target_tree.inventory[file_id]
1097
 
                    parent_id = trans_id_file_id(entry.parent_id)
1098
 
                    e_trans_id = new_by_entry(tt, entry, parent_id, target_tree)
1099
 
                    trans_id[file_id] = e_trans_id
1100
 
                else:
1101
 
                    backup_this = backups
1102
 
                    if file_id in merge_modified:
1103
 
                        backup_this = False
1104
 
                        del merge_modified[file_id]
1105
 
                    change_entry(tt, file_id, working_tree, target_tree, 
1106
 
                                 trans_id_file_id, backup_this, trans_id,
1107
 
                                 by_parent)
1108
 
        finally:
1109
 
            child_pb.finished()
1110
 
        pp.next_phase()
1111
 
        wt_interesting = [i for i in working_tree.inventory if interesting(i)]
1112
 
        child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1113
 
        try:
1114
 
            for id_num, file_id in enumerate(wt_interesting):
1115
 
                child_pb.update("New file check", id_num+1, 
1116
 
                                len(sorted_interesting))
1117
 
                if file_id not in target_tree:
1118
 
                    trans_id = tt.trans_id_tree_file_id(file_id)
1119
 
                    tt.unversion_file(trans_id)
1120
 
                    if file_id in merge_modified:
 
1693
        pp = ProgressPhase("Revert phase", 3, pb)
 
1694
        pp.next_phase()
 
1695
        child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
1696
        try:
 
1697
            merge_modified = _alter_files(working_tree, target_tree, tt,
 
1698
                                          child_pb, filenames, backups)
 
1699
        finally:
 
1700
            child_pb.finished()
 
1701
        pp.next_phase()
 
1702
        child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
1703
        try:
 
1704
            raw_conflicts = resolve_conflicts(tt, child_pb,
 
1705
                lambda t, c: conflict_pass(t, c, target_tree))
 
1706
        finally:
 
1707
            child_pb.finished()
 
1708
        conflicts = cook_conflicts(raw_conflicts, tt)
 
1709
        if change_reporter:
 
1710
            change_reporter = delta._ChangeReporter(
 
1711
                unversioned_filter=working_tree.is_ignored)
 
1712
            delta.report_changes(tt._iter_changes(), change_reporter)
 
1713
        for conflict in conflicts:
 
1714
            warning(conflict)
 
1715
        pp.next_phase()
 
1716
        tt.apply()
 
1717
        working_tree.set_merge_modified(merge_modified)
 
1718
    finally:
 
1719
        target_tree.unlock()
 
1720
        tt.finalize()
 
1721
        pb.clear()
 
1722
    return conflicts
 
1723
 
 
1724
 
 
1725
def _alter_files(working_tree, target_tree, tt, pb, specific_files,
 
1726
                 backups):
 
1727
    merge_modified = working_tree.merge_modified()
 
1728
    change_list = target_tree._iter_changes(working_tree,
 
1729
        specific_files=specific_files, pb=pb)
 
1730
    if target_tree.inventory.root is None:
 
1731
        skip_root = True
 
1732
    else:
 
1733
        skip_root = False
 
1734
    basis_tree = None
 
1735
    try:
 
1736
        deferred_files = []
 
1737
        for id_num, (file_id, path, changed_content, versioned, parent, name,
 
1738
                kind, executable) in enumerate(change_list):
 
1739
            if skip_root and file_id[0] is not None and parent[0] is None:
 
1740
                continue
 
1741
            trans_id = tt.trans_id_file_id(file_id)
 
1742
            mode_id = None
 
1743
            if changed_content:
 
1744
                keep_content = False
 
1745
                if kind[0] == 'file' and (backups or kind[1] is None):
 
1746
                    wt_sha1 = working_tree.get_file_sha1(file_id)
 
1747
                    if merge_modified.get(file_id) != wt_sha1:
 
1748
                        # acquire the basis tree lazily to prevent the
 
1749
                        # expense of accessing it when it's not needed ?
 
1750
                        # (Guessing, RBC, 200702)
 
1751
                        if basis_tree is None:
 
1752
                            basis_tree = working_tree.basis_tree()
 
1753
                            basis_tree.lock_read()
 
1754
                        if file_id in basis_tree:
 
1755
                            if wt_sha1 != basis_tree.get_file_sha1(file_id):
 
1756
                                keep_content = True
 
1757
                        elif kind[1] is None and not versioned[1]:
 
1758
                            keep_content = True
 
1759
                if kind[0] is not None:
 
1760
                    if not keep_content:
1121
1761
                        tt.delete_contents(trans_id)
1122
 
                        del merge_modified[file_id]
1123
 
        finally:
1124
 
            child_pb.finished()
1125
 
        pp.next_phase()
1126
 
        child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1127
 
        try:
1128
 
            raw_conflicts = resolve_conflicts(tt, child_pb)
1129
 
        finally:
1130
 
            child_pb.finished()
1131
 
        conflicts = cook_conflicts(raw_conflicts, tt)
1132
 
        for conflict in conflicts:
1133
 
            warning(conflict)
1134
 
        pp.next_phase()
1135
 
        tt.apply()
1136
 
        working_tree.set_merge_modified({})
 
1762
                    elif kind[1] is not None:
 
1763
                        parent_trans_id = tt.trans_id_file_id(parent[0])
 
1764
                        by_parent = tt.by_parent()
 
1765
                        backup_name = _get_backup_name(name[0], by_parent,
 
1766
                                                       parent_trans_id, tt)
 
1767
                        tt.adjust_path(backup_name, parent_trans_id, trans_id)
 
1768
                        new_trans_id = tt.create_path(name[0], parent_trans_id)
 
1769
                        if versioned == (True, True):
 
1770
                            tt.unversion_file(trans_id)
 
1771
                            tt.version_file(file_id, new_trans_id)
 
1772
                        # New contents should have the same unix perms as old
 
1773
                        # contents
 
1774
                        mode_id = trans_id
 
1775
                        trans_id = new_trans_id
 
1776
                if kind[1] == 'directory':
 
1777
                    tt.create_directory(trans_id)
 
1778
                elif kind[1] == 'symlink':
 
1779
                    tt.create_symlink(target_tree.get_symlink_target(file_id),
 
1780
                                      trans_id)
 
1781
                elif kind[1] == 'file':
 
1782
                    deferred_files.append((file_id, (trans_id, mode_id)))
 
1783
                    if basis_tree is None:
 
1784
                        basis_tree = working_tree.basis_tree()
 
1785
                        basis_tree.lock_read()
 
1786
                    new_sha1 = target_tree.get_file_sha1(file_id)
 
1787
                    if (file_id in basis_tree and new_sha1 ==
 
1788
                        basis_tree.get_file_sha1(file_id)):
 
1789
                        if file_id in merge_modified:
 
1790
                            del merge_modified[file_id]
 
1791
                    else:
 
1792
                        merge_modified[file_id] = new_sha1
 
1793
 
 
1794
                    # preserve the execute bit when backing up
 
1795
                    if keep_content and executable[0] == executable[1]:
 
1796
                        tt.set_executability(executable[1], trans_id)
 
1797
                else:
 
1798
                    assert kind[1] is None
 
1799
            if versioned == (False, True):
 
1800
                tt.version_file(file_id, trans_id)
 
1801
            if versioned == (True, False):
 
1802
                tt.unversion_file(trans_id)
 
1803
            if (name[1] is not None and 
 
1804
                (name[0] != name[1] or parent[0] != parent[1])):
 
1805
                tt.adjust_path(
 
1806
                    name[1], tt.trans_id_file_id(parent[1]), trans_id)
 
1807
            if executable[0] != executable[1] and kind[1] == "file":
 
1808
                tt.set_executability(executable[1], trans_id)
 
1809
        for (trans_id, mode_id), bytes in target_tree.iter_files_bytes(
 
1810
            deferred_files):
 
1811
            tt.create_file(bytes, trans_id, mode_id)
1137
1812
    finally:
1138
 
        tt.finalize()
1139
 
        pb.clear()
1140
 
    return conflicts
1141
 
 
1142
 
 
1143
 
def resolve_conflicts(tt, pb=DummyProgress()):
 
1813
        if basis_tree is not None:
 
1814
            basis_tree.unlock()
 
1815
    return merge_modified
 
1816
 
 
1817
 
 
1818
def resolve_conflicts(tt, pb=DummyProgress(), pass_func=None):
1144
1819
    """Make many conflict-resolution attempts, but die if they fail"""
 
1820
    if pass_func is None:
 
1821
        pass_func = conflict_pass
1145
1822
    new_conflicts = set()
1146
1823
    try:
1147
1824
        for n in range(10):
1149
1826
            conflicts = tt.find_conflicts()
1150
1827
            if len(conflicts) == 0:
1151
1828
                return new_conflicts
1152
 
            new_conflicts.update(conflict_pass(tt, conflicts))
 
1829
            new_conflicts.update(pass_func(tt, conflicts))
1153
1830
        raise MalformedTransform(conflicts=conflicts)
1154
1831
    finally:
1155
1832
        pb.clear()
1156
1833
 
1157
1834
 
1158
 
def conflict_pass(tt, conflicts):
1159
 
    """Resolve some classes of conflicts."""
 
1835
def conflict_pass(tt, conflicts, path_tree=None):
 
1836
    """Resolve some classes of conflicts.
 
1837
 
 
1838
    :param tt: The transform to resolve conflicts in
 
1839
    :param conflicts: The conflicts to resolve
 
1840
    :param path_tree: A Tree to get supplemental paths from
 
1841
    """
1160
1842
    new_conflicts = set()
1161
1843
    for c_type, conflict in ((c[0], c) for c in conflicts):
1162
1844
        if c_type == 'duplicate id':
1165
1847
                               conflict[1], conflict[2], ))
1166
1848
        elif c_type == 'duplicate':
1167
1849
            # files that were renamed take precedence
1168
 
            new_name = tt.final_name(conflict[1])+'.moved'
1169
1850
            final_parent = tt.final_parent(conflict[1])
1170
1851
            if tt.path_changed(conflict[1]):
1171
 
                tt.adjust_path(new_name, final_parent, conflict[2])
1172
 
                new_conflicts.add((c_type, 'Moved existing file to', 
1173
 
                                   conflict[2], conflict[1]))
 
1852
                existing_file, new_file = conflict[2], conflict[1]
1174
1853
            else:
1175
 
                tt.adjust_path(new_name, final_parent, conflict[1])
1176
 
                new_conflicts.add((c_type, 'Moved existing file to', 
1177
 
                                  conflict[1], conflict[2]))
 
1854
                existing_file, new_file = conflict[1], conflict[2]
 
1855
            new_name = tt.final_name(existing_file)+'.moved'
 
1856
            tt.adjust_path(new_name, final_parent, existing_file)
 
1857
            new_conflicts.add((c_type, 'Moved existing file to', 
 
1858
                               existing_file, new_file))
1178
1859
        elif c_type == 'parent loop':
1179
1860
            # break the loop by undoing one of the ops that caused the loop
1180
1861
            cur = conflict[1]
1188
1869
            trans_id = conflict[1]
1189
1870
            try:
1190
1871
                tt.cancel_deletion(trans_id)
1191
 
                new_conflicts.add((c_type, 'Not deleting', trans_id))
 
1872
                new_conflicts.add(('deleting parent', 'Not deleting', 
 
1873
                                   trans_id))
1192
1874
            except KeyError:
1193
1875
                tt.create_directory(trans_id)
1194
 
                new_conflicts.add((c_type, 'Created directory.', trans_id))
 
1876
                new_conflicts.add((c_type, 'Created directory', trans_id))
 
1877
                try:
 
1878
                    tt.final_name(trans_id)
 
1879
                except NoFinalPath:
 
1880
                    if path_tree is not None:
 
1881
                        file_id = tt.final_file_id(trans_id)
 
1882
                        entry = path_tree.inventory[file_id]
 
1883
                        parent_trans_id = tt.trans_id_file_id(entry.parent_id)
 
1884
                        tt.adjust_path(entry.name, parent_trans_id, trans_id)
1195
1885
        elif c_type == 'unversioned parent':
1196
1886
            tt.version_file(tt.inactive_file_id(conflict[1]), conflict[1])
1197
1887
            new_conflicts.add((c_type, 'Versioned directory', conflict[1]))
 
1888
        elif c_type == 'non-directory parent':
 
1889
            parent_id = conflict[1]
 
1890
            parent_parent = tt.final_parent(parent_id)
 
1891
            parent_name = tt.final_name(parent_id)
 
1892
            parent_file_id = tt.final_file_id(parent_id)
 
1893
            new_parent_id = tt.new_directory(parent_name + '.new',
 
1894
                parent_parent, parent_file_id)
 
1895
            _reparent_transform_children(tt, parent_id, new_parent_id)
 
1896
            tt.unversion_file(parent_id)
 
1897
            new_conflicts.add((c_type, 'Created directory', new_parent_id))
1198
1898
    return new_conflicts
1199
1899
 
 
1900
 
1200
1901
def cook_conflicts(raw_conflicts, tt):
1201
1902
    """Generate a list of cooked conflicts, sorted by file path"""
1202
 
    def key(conflict):
1203
 
        if conflict.path is not None:
1204
 
            return conflict.path, conflict.typestring
1205
 
        elif getattr(conflict, "conflict_path", None) is not None:
1206
 
            return conflict.conflict_path, conflict.typestring
1207
 
        else:
1208
 
            return None, conflict.typestring
 
1903
    from bzrlib.conflicts import Conflict
 
1904
    conflict_iter = iter_cook_conflicts(raw_conflicts, tt)
 
1905
    return sorted(conflict_iter, key=Conflict.sort_key)
1209
1906
 
1210
 
    return sorted(list(iter_cook_conflicts(raw_conflicts, tt)), key=key)
1211
1907
 
1212
1908
def iter_cook_conflicts(raw_conflicts, tt):
1213
1909
    from bzrlib.conflicts import Conflict
1228
1924
                                   file_id=modified_id, 
1229
1925
                                   conflict_path=conflicting_path,
1230
1926
                                   conflict_file_id=conflicting_id)
 
1927
 
 
1928
 
 
1929
class _FileMover(object):
 
1930
    """Moves and deletes files for TreeTransform, tracking operations"""
 
1931
 
 
1932
    def __init__(self):
 
1933
        self.past_renames = []
 
1934
        self.pending_deletions = []
 
1935
 
 
1936
    def rename(self, from_, to):
 
1937
        """Rename a file from one path to another.  Functions like os.rename"""
 
1938
        try:
 
1939
            os.rename(from_, to)
 
1940
        except OSError, e:
 
1941
            if e.errno in (errno.EEXIST, errno.ENOTEMPTY):
 
1942
                raise errors.FileExists(to, str(e))
 
1943
            raise
 
1944
        self.past_renames.append((from_, to))
 
1945
 
 
1946
    def pre_delete(self, from_, to):
 
1947
        """Rename a file out of the way and mark it for deletion.
 
1948
 
 
1949
        Unlike os.unlink, this works equally well for files and directories.
 
1950
        :param from_: The current file path
 
1951
        :param to: A temporary path for the file
 
1952
        """
 
1953
        self.rename(from_, to)
 
1954
        self.pending_deletions.append(to)
 
1955
 
 
1956
    def rollback(self):
 
1957
        """Reverse all renames that have been performed"""
 
1958
        for from_, to in reversed(self.past_renames):
 
1959
            os.rename(to, from_)
 
1960
        # after rollback, don't reuse _FileMover
 
1961
        past_renames = None
 
1962
        pending_deletions = None
 
1963
 
 
1964
    def apply_deletions(self):
 
1965
        """Apply all marked deletions"""
 
1966
        for path in self.pending_deletions:
 
1967
            delete_any(path)
 
1968
        # after apply_deletions, don't reuse _FileMover
 
1969
        past_renames = None
 
1970
        pending_deletions = None