/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: Andrew Bennetts
  • Date: 2008-01-24 03:21:43 UTC
  • mto: This revision was merged to the branch mainline in revision 3200.
  • Revision ID: andrew.bennetts@canonical.com-20080124032143-srxbec60xf9dt3xy
Just use urllib.unquote, as suggested by John's review.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2006 Canonical Ltd
2
 
 
 
1
# Copyright (C) 2006, 2007, 2008 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
17
17
import os
18
18
import errno
19
19
from stat import S_ISREG
 
20
import tempfile
20
21
 
 
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
31
from bzrlib.errors import (DuplicateKey, MalformedTransform, NoSuchFile,
22
32
                           ReusingTransform, NotVersionedError, CantMoveRoot,
23
 
                           ExistingLimbo, ImmortalLimbo)
 
33
                           ExistingLimbo, ImmortalLimbo, NoFinalPath,
 
34
                           UnableCreateSymlink)
24
35
from bzrlib.inventory import InventoryEntry
25
36
from bzrlib.osutils import (file_kind, supports_executable, pathjoin, lexists,
26
 
                            delete_any)
 
37
                            delete_any, has_symlinks)
27
38
from bzrlib.progress import DummyProgress, ProgressPhase
 
39
from bzrlib.symbol_versioning import (
 
40
        deprecated_function,
 
41
        zero_fifteen,
 
42
        zero_ninety,
 
43
        )
28
44
from bzrlib.trace import mutter, warning
29
 
import bzrlib.ui 
 
45
from bzrlib import tree
 
46
import bzrlib.ui
 
47
import bzrlib.urlutils as urlutils
30
48
 
31
49
 
32
50
ROOT_PARENT = "root-parent"
39
57
 
40
58
 
41
59
class _TransformResults(object):
42
 
    def __init__(self, modified_paths):
 
60
    def __init__(self, modified_paths, rename_count):
43
61
        object.__init__(self)
44
62
        self.modified_paths = modified_paths
45
 
 
46
 
 
47
 
class TreeTransform(object):
48
 
    """Represent a tree transformation.
49
 
    
50
 
    This object is designed to support incremental generation of the transform,
51
 
    in any order.  
52
 
    
53
 
    It is easy to produce malformed transforms, but they are generally
54
 
    harmless.  Attempting to apply a malformed transform will cause an
55
 
    exception to be raised before any modifications are made to the tree.  
56
 
 
57
 
    Many kinds of malformed transforms can be corrected with the 
58
 
    resolve_conflicts function.  The remaining ones indicate programming error,
59
 
    such as trying to create a file with no path.
60
 
 
61
 
    Two sets of file creation methods are supplied.  Convenience methods are:
62
 
     * new_file
63
 
     * new_directory
64
 
     * new_symlink
65
 
 
66
 
    These are composed of the low-level methods:
67
 
     * create_path
68
 
     * create_file or create_directory or create_symlink
69
 
     * version_file
70
 
     * set_executability
71
 
    """
72
 
    def __init__(self, tree, pb=DummyProgress()):
73
 
        """Note: a write lock is taken on the tree.
74
 
        
75
 
        Use TreeTransform.finalize() to release the lock
 
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.
76
80
        """
77
81
        object.__init__(self)
78
82
        self._tree = tree
79
 
        self._tree.lock_write()
80
 
        try:
81
 
            control_files = self._tree._control_files
82
 
            self._limbodir = control_files.controlfilename('limbo')
83
 
            try:
84
 
                os.mkdir(self._limbodir)
85
 
            except OSError, e:
86
 
                if e.errno == errno.EEXIST:
87
 
                    raise ExistingLimbo(self._limbodir)
88
 
        except: 
89
 
            self._tree.unlock()
90
 
            raise
91
 
 
 
83
        self._limbodir = limbodir
92
84
        self._id_number = 0
 
85
        # mapping of trans_id -> new basename
93
86
        self._new_name = {}
 
87
        # mapping of trans_id -> new parent trans_id
94
88
        self._new_parent = {}
 
89
        # mapping of trans_id with new contents -> new file_kind
95
90
        self._new_contents = {}
 
91
        # A mapping of transform ids to their limbo filename
 
92
        self._limbo_files = {}
 
93
        # A mapping of transform ids to a set of the transform ids of children
 
94
        # that their limbo directory has
 
95
        self._limbo_children = {}
 
96
        # Map transform ids to maps of child filename to child transform id
 
97
        self._limbo_children_names = {}
 
98
        # List of transform ids that need to be renamed from limbo into place
 
99
        self._needs_rename = set()
 
100
        # Set of trans_ids whose contents will be removed
96
101
        self._removed_contents = set()
 
102
        # Mapping of trans_id -> new execute-bit value
97
103
        self._new_executability = {}
 
104
        # Mapping of trans_id -> new tree-reference value
 
105
        self._new_reference_revision = {}
 
106
        # Mapping of trans_id -> new file_id
98
107
        self._new_id = {}
 
108
        # Mapping of old file-id -> trans_id
99
109
        self._non_present_ids = {}
 
110
        # Mapping of new file_id -> trans_id
100
111
        self._r_new_id = {}
 
112
        # Set of file_ids that will be removed
101
113
        self._removed_id = set()
 
114
        # Mapping of path in old tree -> trans_id
102
115
        self._tree_path_ids = {}
 
116
        # Mapping trans_id -> path in old tree
103
117
        self._tree_id_paths = {}
 
118
        # Cache of realpath results, to speed up canonical_path
 
119
        self._realpaths = {}
 
120
        # Cache of relpath results, to speed up canonical_path
 
121
        self._relpaths = {}
 
122
        # The trans_id that will be used as the tree root
104
123
        self._new_root = self.trans_id_tree_file_id(tree.get_root_id())
105
 
        self.__done = False
 
124
        # Indictor of whether the transform has been applied
 
125
        self._done = False
 
126
        # A progress bar
106
127
        self._pb = pb
 
128
        # Whether the target is case sensitive
 
129
        self._case_sensitive_target = case_sensitive
 
130
        # A counter of how many files have been renamed
 
131
        self.rename_count = 0
107
132
 
108
133
    def __get_root(self):
109
134
        return self._new_root
111
136
    root = property(__get_root)
112
137
 
113
138
    def finalize(self):
114
 
        """Release the working tree lock, if held, clean up limbo dir."""
 
139
        """Release the working tree lock, if held, clean up limbo dir.
 
140
 
 
141
        This is required if apply has not been invoked, but can be invoked
 
142
        even after apply.
 
143
        """
115
144
        if self._tree is None:
116
145
            return
117
146
        try:
118
 
            for trans_id, kind in self._new_contents.iteritems():
119
 
                path = self._limbo_name(trans_id)
 
147
            entries = [(self._limbo_name(t), t, k) for t, k in
 
148
                       self._new_contents.iteritems()]
 
149
            entries.sort(reverse=True)
 
150
            for path, trans_id, kind in entries:
120
151
                if kind == "directory":
121
152
                    os.rmdir(path)
122
153
                else:
126
157
            except OSError:
127
158
                # We don't especially care *why* the dir is immortal.
128
159
                raise ImmortalLimbo(self._limbodir)
 
160
            try:
 
161
                os.rmdir(self._deletiondir)
 
162
            except OSError:
 
163
                raise errors.ImmortalPendingDeletion(self._deletiondir)
129
164
        finally:
130
165
            self._tree.unlock()
131
166
            self._tree = None
147
182
        """Change the path that is assigned to a transaction id."""
148
183
        if trans_id == self._new_root:
149
184
            raise CantMoveRoot
 
185
        previous_parent = self._new_parent.get(trans_id)
 
186
        previous_name = self._new_name.get(trans_id)
150
187
        self._new_name[trans_id] = name
151
188
        self._new_parent[trans_id] = parent
 
189
        if (trans_id in self._limbo_files and
 
190
            trans_id not in self._needs_rename):
 
191
            self._rename_in_limbo([trans_id])
 
192
            self._limbo_children[previous_parent].remove(trans_id)
 
193
            del self._limbo_children_names[previous_parent][previous_name]
 
194
 
 
195
    def _rename_in_limbo(self, trans_ids):
 
196
        """Fix limbo names so that the right final path is produced.
 
197
 
 
198
        This means we outsmarted ourselves-- we tried to avoid renaming
 
199
        these files later by creating them with their final names in their
 
200
        final parents.  But now the previous name or parent is no longer
 
201
        suitable, so we have to rename them.
 
202
 
 
203
        Even for trans_ids that have no new contents, we must remove their
 
204
        entries from _limbo_files, because they are now stale.
 
205
        """
 
206
        for trans_id in trans_ids:
 
207
            old_path = self._limbo_files.pop(trans_id)
 
208
            if trans_id not in self._new_contents:
 
209
                continue
 
210
            new_path = self._limbo_name(trans_id)
 
211
            os.rename(old_path, new_path)
152
212
 
153
213
    def adjust_root_path(self, name, parent):
154
214
        """Emulate moving the root by moving all children, instead.
211
271
    def canonical_path(self, path):
212
272
        """Get the canonical tree-relative path"""
213
273
        # 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))
 
274
        abs = self._tree.abspath(path)
 
275
        if abs in self._relpaths:
 
276
            return self._relpaths[abs]
 
277
        dirname, basename = os.path.split(abs)
 
278
        if dirname not in self._realpaths:
 
279
            self._realpaths[dirname] = os.path.realpath(dirname)
 
280
        dirname = self._realpaths[dirname]
 
281
        abs = pathjoin(dirname, basename)
 
282
        if dirname in self._relpaths:
 
283
            relpath = pathjoin(self._relpaths[dirname], basename)
 
284
            relpath = relpath.rstrip('/\\')
 
285
        else:
 
286
            relpath = self._tree.relpath(abs)
 
287
        self._relpaths[abs] = relpath
 
288
        return relpath
217
289
 
218
290
    def trans_id_tree_path(self, path):
219
291
        """Determine (and maybe set) the transaction ID for a tree path."""
241
313
        New file takes the permissions of any existing file with that id,
242
314
        unless mode_id is specified.
243
315
        """
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()
 
316
        name = self._limbo_name(trans_id)
 
317
        f = open(name, 'wb')
 
318
        try:
 
319
            try:
 
320
                unique_add(self._new_contents, trans_id, 'file')
 
321
            except:
 
322
                # Clean up the file, it never got registered so
 
323
                # TreeTransform.finalize() won't clean it up.
 
324
                f.close()
 
325
                os.unlink(name)
 
326
                raise
 
327
 
 
328
            f.writelines(contents)
 
329
        finally:
 
330
            f.close()
249
331
        self._set_mode(trans_id, mode_id, S_ISREG)
250
332
 
251
333
    def _set_mode(self, trans_id, mode_id, typefunc):
261
343
        except KeyError:
262
344
            return
263
345
        try:
264
 
            mode = os.stat(old_path).st_mode
 
346
            mode = os.stat(self._tree.abspath(old_path)).st_mode
265
347
        except OSError, e:
266
348
            if e.errno == errno.ENOENT:
267
349
                return
284
366
        target is a bytestring.
285
367
        See also new_symlink.
286
368
        """
287
 
        os.symlink(target, self._limbo_name(trans_id))
288
 
        unique_add(self._new_contents, trans_id, 'symlink')
 
369
        if has_symlinks():
 
370
            os.symlink(target, self._limbo_name(trans_id))
 
371
            unique_add(self._new_contents, trans_id, 'symlink')
 
372
        else:
 
373
            try:
 
374
                path = FinalPaths(self).get_path(trans_id)
 
375
            except KeyError:
 
376
                path = None
 
377
            raise UnableCreateSymlink(path=path)
289
378
 
290
379
    def cancel_creation(self, trans_id):
291
380
        """Cancel the creation of new file contents."""
292
381
        del self._new_contents[trans_id]
 
382
        children = self._limbo_children.get(trans_id)
 
383
        # if this is a limbo directory with children, move them before removing
 
384
        # the directory
 
385
        if children is not None:
 
386
            self._rename_in_limbo(children)
 
387
            del self._limbo_children[trans_id]
 
388
            del self._limbo_children_names[trans_id]
293
389
        delete_any(self._limbo_name(trans_id))
294
390
 
295
391
    def delete_contents(self, trans_id):
319
415
        else:
320
416
            unique_add(self._new_executability, trans_id, executability)
321
417
 
 
418
    def set_tree_reference(self, revision_id, trans_id):
 
419
        """Set the reference associated with a directory"""
 
420
        unique_add(self._new_reference_revision, trans_id, revision_id)
 
421
 
322
422
    def version_file(self, file_id, trans_id):
323
423
        """Schedule a file to become versioned."""
324
424
        assert file_id is not None
381
481
            return None
382
482
        # the file is old; the old id is still valid
383
483
        if self._new_root == trans_id:
384
 
            return self._tree.inventory.root.file_id
 
484
            return self._tree.get_root_id()
385
485
        return self._tree.inventory.path2id(path)
386
486
 
387
487
    def final_file_id(self, trans_id):
426
526
        try:
427
527
            return self._new_name[trans_id]
428
528
        except KeyError:
429
 
            return os.path.basename(self._tree_id_paths[trans_id])
 
529
            try:
 
530
                return os.path.basename(self._tree_id_paths[trans_id])
 
531
            except KeyError:
 
532
                raise NoFinalPath(trans_id, self)
430
533
 
431
534
    def by_parent(self):
432
535
        """Return a map of parent: children for known parents.
445
548
 
446
549
    def path_changed(self, trans_id):
447
550
        """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
 
551
        return (trans_id in self._new_name) or (trans_id in self._new_parent)
 
552
 
 
553
    def new_contents(self, trans_id):
 
554
        return (trans_id in self._new_contents)
449
555
 
450
556
    def find_conflicts(self):
451
557
        """Find any violations of inventory or filesystem invariants"""
452
 
        if self.__done is True:
 
558
        if self._done is True:
453
559
            raise ReusingTransform()
454
560
        conflicts = []
455
561
        # ensure all children of all existent parents are known
477
583
                        self.tree_kind(t) == 'directory'])
478
584
        for trans_id in self._removed_id:
479
585
            file_id = self.tree_file_id(trans_id)
480
 
            if self._tree.inventory[file_id].kind in ('directory', 
481
 
                                                      'root_directory'):
 
586
            if file_id is not None:
 
587
                if self._tree.inventory[file_id].kind == 'directory':
 
588
                    parents.append(trans_id)
 
589
            elif self.tree_kind(trans_id) == 'directory':
482
590
                parents.append(trans_id)
483
591
 
484
592
        for parent_id in parents:
494
602
        try:
495
603
            children = os.listdir(self._tree.abspath(path))
496
604
        except OSError, e:
497
 
            if e.errno != errno.ENOENT and e.errno != errno.ESRCH:
 
605
            if e.errno not in (errno.ENOENT, errno.ESRCH, errno.ENOTDIR):
498
606
                raise
499
607
            return
500
608
            
521
629
        if child_id is None:
522
630
            return lexists(self._tree.abspath(childpath))
523
631
        else:
524
 
            if tt.final_parent(child_id) != parent_id:
 
632
            if self.final_parent(child_id) != parent_id:
525
633
                return False
526
 
            if child_id in tt._removed_contents:
 
634
            if child_id in self._removed_contents:
527
635
                # XXX What about dangling file-ids?
528
636
                return False
529
637
            else:
537
645
            parent_id = trans_id
538
646
            while parent_id is not ROOT_PARENT:
539
647
                seen.add(parent_id)
540
 
                parent_id = self.final_parent(parent_id)
 
648
                try:
 
649
                    parent_id = self.final_parent(parent_id)
 
650
                except KeyError:
 
651
                    break
541
652
                if parent_id == trans_id:
542
653
                    conflicts.append(('parent loop', trans_id))
543
654
                if parent_id in seen:
611
722
    def _duplicate_entries(self, by_parent):
612
723
        """No directory may have two entries with the same name."""
613
724
        conflicts = []
 
725
        if (self._new_name, self._new_parent) == ({}, {}):
 
726
            return conflicts
614
727
        for children in by_parent.itervalues():
615
728
            name_ids = [(self.final_name(t), t) for t in children]
 
729
            if not self._case_sensitive_target:
 
730
                name_ids = [(n.lower(), t) for n, t in name_ids]
616
731
            name_ids.sort()
617
732
            last_name = None
618
733
            last_trans_id = None
619
734
            for name, trans_id in name_ids:
 
735
                try:
 
736
                    kind = self.final_kind(trans_id)
 
737
                except NoSuchFile:
 
738
                    kind = None
 
739
                file_id = self.final_file_id(trans_id)
 
740
                if kind is None and file_id is None:
 
741
                    continue
620
742
                if name == last_name:
621
743
                    conflicts.append(('duplicate', last_trans_id, trans_id,
622
744
                    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
 
745
                last_name = name
 
746
                last_trans_id = trans_id
631
747
        return conflicts
632
748
 
633
749
    def _duplicate_ids(self):
675
791
                continue
676
792
            return True
677
793
        return False
678
 
            
679
 
    def apply(self):
680
 
        """Apply all changes to the inventory and filesystem.
681
 
        
682
 
        If filesystem or inventory conflicts are present, MalformedTransform
683
 
        will be thrown.
684
 
        """
685
 
        conflicts = self.find_conflicts()
686
 
        if len(conflicts) != 0:
687
 
            raise MalformedTransform(conflicts=conflicts)
688
 
        limbo_inv = {}
689
 
        inv = self._tree.inventory
690
 
        child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
691
 
        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)
696
 
        finally:
697
 
            child_pb.finished()
698
 
        self._tree._write_inventory(inv)
699
 
        self.__done = True
700
 
        self.finalize()
701
 
        return _TransformResults(modified_paths)
702
794
 
703
795
    def _limbo_name(self, trans_id):
704
796
        """Generate the limbo name of a file"""
705
 
        return pathjoin(self._limbodir, trans_id)
706
 
 
707
 
    def _apply_removals(self, inv, limbo_inv):
708
 
        """Perform tree operations that remove directory/inventory names.
709
 
        
710
 
        That is, delete files that are to be deleted, and put any files that
711
 
        need renaming into limbo.  This must be done in strict child-to-parent
712
 
        order.
713
 
        """
714
 
        tree_paths = list(self._tree_path_ids.iteritems())
715
 
        tree_paths.sort(reverse=True)
716
 
        child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
717
 
        try:
718
 
            for num, data in enumerate(tree_paths):
719
 
                path, trans_id = data
720
 
                child_pb.update('removing file', num, len(tree_paths))
721
 
                full_path = self._tree.abspath(path)
722
 
                if trans_id in self._removed_contents:
723
 
                    delete_any(full_path)
724
 
                elif trans_id in self._new_name or trans_id in \
725
 
                    self._new_parent:
726
 
                    try:
727
 
                        os.rename(full_path, self._limbo_name(trans_id))
728
 
                    except OSError, e:
729
 
                        if e.errno != errno.ENOENT:
730
 
                            raise
731
 
                if trans_id in self._removed_id:
732
 
                    if trans_id == self._new_root:
733
 
                        file_id = self._tree.inventory.root.file_id
 
797
        limbo_name = self._limbo_files.get(trans_id)
 
798
        if limbo_name is not None:
 
799
            return limbo_name
 
800
        parent = self._new_parent.get(trans_id)
 
801
        # if the parent directory is already in limbo (e.g. when building a
 
802
        # tree), choose a limbo name inside the parent, to reduce further
 
803
        # renames.
 
804
        use_direct_path = False
 
805
        if self._new_contents.get(parent) == 'directory':
 
806
            filename = self._new_name.get(trans_id)
 
807
            if filename is not None:
 
808
                if parent not in self._limbo_children:
 
809
                    self._limbo_children[parent] = set()
 
810
                    self._limbo_children_names[parent] = {}
 
811
                    use_direct_path = True
 
812
                # the direct path can only be used if no other file has
 
813
                # already taken this pathname, i.e. if the name is unused, or
 
814
                # if it is already associated with this trans_id.
 
815
                elif self._case_sensitive_target:
 
816
                    if (self._limbo_children_names[parent].get(filename)
 
817
                        in (trans_id, None)):
 
818
                        use_direct_path = True
 
819
                else:
 
820
                    for l_filename, l_trans_id in\
 
821
                        self._limbo_children_names[parent].iteritems():
 
822
                        if l_trans_id == trans_id:
 
823
                            continue
 
824
                        if l_filename.lower() == filename.lower():
 
825
                            break
734
826
                    else:
735
 
                        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
 
                    if file_id is not None:
740
 
                        limbo_inv[trans_id] = inv[file_id]
741
 
                        del inv[file_id]
742
 
        finally:
743
 
            child_pb.finished()
744
 
 
745
 
    def _apply_insertions(self, inv, limbo_inv):
746
 
        """Perform tree operations that insert directory/inventory names.
747
 
        
748
 
        That is, create any files that need to be created, and restore from
749
 
        limbo any files that needed renaming.  This must be done in strict
750
 
        parent-to-child order.
751
 
        """
752
 
        new_paths = self.new_paths()
753
 
        modified_paths = []
754
 
        child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
755
 
        try:
756
 
            for num, (path, trans_id) in enumerate(new_paths):
757
 
                child_pb.update('adding file', num, len(new_paths))
758
 
                try:
759
 
                    kind = self._new_contents[trans_id]
760
 
                except KeyError:
761
 
                    kind = contents = None
762
 
                if trans_id in self._new_contents or \
763
 
                    self.path_changed(trans_id):
764
 
                    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
771
 
                    if trans_id in self._new_contents:
772
 
                        modified_paths.append(full_path)
773
 
                        del self._new_contents[trans_id]
774
 
 
775
 
                if trans_id in self._new_id:
776
 
                    if kind is None:
777
 
                        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
790
 
                if trans_id in self._new_executability:
791
 
                    self._set_executability(path, inv, trans_id)
792
 
        finally:
793
 
            child_pb.finished()
794
 
        return modified_paths
795
 
 
796
 
    def _set_executability(self, path, inv, trans_id):
 
827
                        use_direct_path = True
 
828
 
 
829
        if use_direct_path:
 
830
            limbo_name = pathjoin(self._limbo_files[parent], filename)
 
831
            self._limbo_children[parent].add(trans_id)
 
832
            self._limbo_children_names[parent][filename] = trans_id
 
833
        else:
 
834
            limbo_name = pathjoin(self._limbodir, trans_id)
 
835
            self._needs_rename.add(trans_id)
 
836
        self._limbo_files[trans_id] = limbo_name
 
837
        return limbo_name
 
838
 
 
839
    def _set_executability(self, path, entry, trans_id):
797
840
        """Set the executability of versioned files """
798
 
        file_id = inv.path2id(path)
799
841
        new_executability = self._new_executability[trans_id]
800
 
        inv[file_id].executable = new_executability
 
842
        entry.executable = new_executability
801
843
        if supports_executable():
802
844
            abspath = self._tree.abspath(path)
803
845
            current_mode = os.stat(abspath).st_mode
829
871
        parent_id is the transaction id of the parent directory of the file.
830
872
        contents is an iterator of bytestrings, which will be used to produce
831
873
        the file.
832
 
        file_id is the inventory ID of the file, if it is to be versioned.
 
874
        :param file_id: The inventory ID of the file, if it is to be versioned.
 
875
        :param executable: Only valid when a file_id has been supplied.
833
876
        """
834
877
        trans_id = self._new_entry(name, parent_id, file_id)
 
878
        # TODO: rather than scheduling a set_executable call,
 
879
        # have create_file create the file with the right mode.
835
880
        self.create_file(contents, trans_id)
836
881
        if executable is not None:
837
882
            self.set_executability(executable, trans_id)
861
906
        self.create_symlink(target, trans_id)
862
907
        return trans_id
863
908
 
 
909
    def _affected_ids(self):
 
910
        """Return the set of transform ids affected by the transform"""
 
911
        trans_ids = set(self._removed_id)
 
912
        trans_ids.update(self._new_id.keys())
 
913
        trans_ids.update(self._removed_contents)
 
914
        trans_ids.update(self._new_contents.keys())
 
915
        trans_ids.update(self._new_executability.keys())
 
916
        trans_ids.update(self._new_name.keys())
 
917
        trans_ids.update(self._new_parent.keys())
 
918
        return trans_ids
 
919
 
 
920
    def _get_file_id_maps(self):
 
921
        """Return mapping of file_ids to trans_ids in the to and from states"""
 
922
        trans_ids = self._affected_ids()
 
923
        from_trans_ids = {}
 
924
        to_trans_ids = {}
 
925
        # Build up two dicts: trans_ids associated with file ids in the
 
926
        # FROM state, vs the TO state.
 
927
        for trans_id in trans_ids:
 
928
            from_file_id = self.tree_file_id(trans_id)
 
929
            if from_file_id is not None:
 
930
                from_trans_ids[from_file_id] = trans_id
 
931
            to_file_id = self.final_file_id(trans_id)
 
932
            if to_file_id is not None:
 
933
                to_trans_ids[to_file_id] = trans_id
 
934
        return from_trans_ids, to_trans_ids
 
935
 
 
936
    def _from_file_data(self, from_trans_id, from_versioned, file_id):
 
937
        """Get data about a file in the from (tree) state
 
938
 
 
939
        Return a (name, parent, kind, executable) tuple
 
940
        """
 
941
        from_path = self._tree_id_paths.get(from_trans_id)
 
942
        if from_versioned:
 
943
            # get data from working tree if versioned
 
944
            from_entry = self._tree.inventory[file_id]
 
945
            from_name = from_entry.name
 
946
            from_parent = from_entry.parent_id
 
947
        else:
 
948
            from_entry = None
 
949
            if from_path is None:
 
950
                # File does not exist in FROM state
 
951
                from_name = None
 
952
                from_parent = None
 
953
            else:
 
954
                # File exists, but is not versioned.  Have to use path-
 
955
                # splitting stuff
 
956
                from_name = os.path.basename(from_path)
 
957
                tree_parent = self.get_tree_parent(from_trans_id)
 
958
                from_parent = self.tree_file_id(tree_parent)
 
959
        if from_path is not None:
 
960
            from_kind, from_executable, from_stats = \
 
961
                self._tree._comparison_data(from_entry, from_path)
 
962
        else:
 
963
            from_kind = None
 
964
            from_executable = False
 
965
        return from_name, from_parent, from_kind, from_executable
 
966
 
 
967
    def _to_file_data(self, to_trans_id, from_trans_id, from_executable):
 
968
        """Get data about a file in the to (target) state
 
969
 
 
970
        Return a (name, parent, kind, executable) tuple
 
971
        """
 
972
        to_name = self.final_name(to_trans_id)
 
973
        try:
 
974
            to_kind = self.final_kind(to_trans_id)
 
975
        except NoSuchFile:
 
976
            to_kind = None
 
977
        to_parent = self.final_file_id(self.final_parent(to_trans_id))
 
978
        if to_trans_id in self._new_executability:
 
979
            to_executable = self._new_executability[to_trans_id]
 
980
        elif to_trans_id == from_trans_id:
 
981
            to_executable = from_executable
 
982
        else:
 
983
            to_executable = False
 
984
        return to_name, to_parent, to_kind, to_executable
 
985
 
 
986
    def _iter_changes(self):
 
987
        """Produce output in the same format as Tree._iter_changes.
 
988
 
 
989
        Will produce nonsensical results if invoked while inventory/filesystem
 
990
        conflicts (as reported by TreeTransform.find_conflicts()) are present.
 
991
 
 
992
        This reads the Transform, but only reproduces changes involving a
 
993
        file_id.  Files that are not versioned in either of the FROM or TO
 
994
        states are not reflected.
 
995
        """
 
996
        final_paths = FinalPaths(self)
 
997
        from_trans_ids, to_trans_ids = self._get_file_id_maps()
 
998
        results = []
 
999
        # Now iterate through all active file_ids
 
1000
        for file_id in set(from_trans_ids.keys() + to_trans_ids.keys()):
 
1001
            modified = False
 
1002
            from_trans_id = from_trans_ids.get(file_id)
 
1003
            # find file ids, and determine versioning state
 
1004
            if from_trans_id is None:
 
1005
                from_versioned = False
 
1006
                from_trans_id = to_trans_ids[file_id]
 
1007
            else:
 
1008
                from_versioned = True
 
1009
            to_trans_id = to_trans_ids.get(file_id)
 
1010
            if to_trans_id is None:
 
1011
                to_versioned = False
 
1012
                to_trans_id = from_trans_id
 
1013
            else:
 
1014
                to_versioned = True
 
1015
 
 
1016
            from_name, from_parent, from_kind, from_executable = \
 
1017
                self._from_file_data(from_trans_id, from_versioned, file_id)
 
1018
 
 
1019
            to_name, to_parent, to_kind, to_executable = \
 
1020
                self._to_file_data(to_trans_id, from_trans_id, from_executable)
 
1021
 
 
1022
            if not from_versioned:
 
1023
                from_path = None
 
1024
            else:
 
1025
                from_path = self._tree_id_paths.get(from_trans_id)
 
1026
            if not to_versioned:
 
1027
                to_path = None
 
1028
            else:
 
1029
                to_path = final_paths.get_path(to_trans_id)
 
1030
            if from_kind != to_kind:
 
1031
                modified = True
 
1032
            elif to_kind in ('file', 'symlink') and (
 
1033
                to_trans_id != from_trans_id or
 
1034
                to_trans_id in self._new_contents):
 
1035
                modified = True
 
1036
            if (not modified and from_versioned == to_versioned and
 
1037
                from_parent==to_parent and from_name == to_name and
 
1038
                from_executable == to_executable):
 
1039
                continue
 
1040
            results.append((file_id, (from_path, to_path), modified,
 
1041
                   (from_versioned, to_versioned),
 
1042
                   (from_parent, to_parent),
 
1043
                   (from_name, to_name),
 
1044
                   (from_kind, to_kind),
 
1045
                   (from_executable, to_executable)))
 
1046
        return iter(sorted(results, key=lambda x:x[1]))
 
1047
 
 
1048
    def get_preview_tree(self):
 
1049
        """Return a tree representing the result of the transform.
 
1050
 
 
1051
        This tree only supports the subset of Tree functionality required
 
1052
        by show_diff_trees.  It must only be compared to tt._tree.
 
1053
        """
 
1054
        return _PreviewTree(self)
 
1055
 
 
1056
 
 
1057
class TreeTransform(TreeTransformBase):
 
1058
    """Represent a tree transformation.
 
1059
 
 
1060
    This object is designed to support incremental generation of the transform,
 
1061
    in any order.
 
1062
 
 
1063
    However, it gives optimum performance when parent directories are created
 
1064
    before their contents.  The transform is then able to put child files
 
1065
    directly in their parent directory, avoiding later renames.
 
1066
 
 
1067
    It is easy to produce malformed transforms, but they are generally
 
1068
    harmless.  Attempting to apply a malformed transform will cause an
 
1069
    exception to be raised before any modifications are made to the tree.
 
1070
 
 
1071
    Many kinds of malformed transforms can be corrected with the
 
1072
    resolve_conflicts function.  The remaining ones indicate programming error,
 
1073
    such as trying to create a file with no path.
 
1074
 
 
1075
    Two sets of file creation methods are supplied.  Convenience methods are:
 
1076
     * new_file
 
1077
     * new_directory
 
1078
     * new_symlink
 
1079
 
 
1080
    These are composed of the low-level methods:
 
1081
     * create_path
 
1082
     * create_file or create_directory or create_symlink
 
1083
     * version_file
 
1084
     * set_executability
 
1085
 
 
1086
    Transform/Transaction ids
 
1087
    -------------------------
 
1088
    trans_ids are temporary ids assigned to all files involved in a transform.
 
1089
    It's possible, even common, that not all files in the Tree have trans_ids.
 
1090
 
 
1091
    trans_ids are used because filenames and file_ids are not good enough
 
1092
    identifiers; filenames change, and not all files have file_ids.  File-ids
 
1093
    are also associated with trans-ids, so that moving a file moves its
 
1094
    file-id.
 
1095
 
 
1096
    trans_ids are only valid for the TreeTransform that generated them.
 
1097
 
 
1098
    Limbo
 
1099
    -----
 
1100
    Limbo is a temporary directory use to hold new versions of files.
 
1101
    Files are added to limbo by create_file, create_directory, create_symlink,
 
1102
    and their convenience variants (new_*).  Files may be removed from limbo
 
1103
    using cancel_creation.  Files are renamed from limbo into their final
 
1104
    location as part of TreeTransform.apply
 
1105
 
 
1106
    Limbo must be cleaned up, by either calling TreeTransform.apply or
 
1107
    calling TreeTransform.finalize.
 
1108
 
 
1109
    Files are placed into limbo inside their parent directories, where
 
1110
    possible.  This reduces subsequent renames, and makes operations involving
 
1111
    lots of files faster.  This optimization is only possible if the parent
 
1112
    directory is created *before* creating any of its children, so avoid
 
1113
    creating children before parents, where possible.
 
1114
 
 
1115
    Pending-deletion
 
1116
    ----------------
 
1117
    This temporary directory is used by _FileMover for storing files that are
 
1118
    about to be deleted.  In case of rollback, the files will be restored.
 
1119
    FileMover does not delete files until it is sure that a rollback will not
 
1120
    happen.
 
1121
    """
 
1122
    def __init__(self, tree, pb=DummyProgress()):
 
1123
        """Note: a tree_write lock is taken on the tree.
 
1124
 
 
1125
        Use TreeTransform.finalize() to release the lock (can be omitted if
 
1126
        TreeTransform.apply() called).
 
1127
        """
 
1128
        tree.lock_tree_write()
 
1129
 
 
1130
        try:
 
1131
            control_files = tree._control_files
 
1132
            limbodir = urlutils.local_path_from_url(
 
1133
                control_files.controlfilename('limbo'))
 
1134
            try:
 
1135
                os.mkdir(limbodir)
 
1136
            except OSError, e:
 
1137
                if e.errno == errno.EEXIST:
 
1138
                    raise ExistingLimbo(limbodir)
 
1139
            self._deletiondir = urlutils.local_path_from_url(
 
1140
                control_files.controlfilename('pending-deletion'))
 
1141
            try:
 
1142
                os.mkdir(self._deletiondir)
 
1143
            except OSError, e:
 
1144
                if e.errno == errno.EEXIST:
 
1145
                    raise errors.ExistingPendingDeletion(self._deletiondir)
 
1146
        except:
 
1147
            tree.unlock()
 
1148
            raise
 
1149
 
 
1150
        TreeTransformBase.__init__(self, tree, limbodir, pb,
 
1151
                                   tree.case_sensitive)
 
1152
 
 
1153
    def apply(self, no_conflicts=False, _mover=None):
 
1154
        """Apply all changes to the inventory and filesystem.
 
1155
 
 
1156
        If filesystem or inventory conflicts are present, MalformedTransform
 
1157
        will be thrown.
 
1158
 
 
1159
        If apply succeeds, finalize is not necessary.
 
1160
 
 
1161
        :param no_conflicts: if True, the caller guarantees there are no
 
1162
            conflicts, so no check is made.
 
1163
        :param _mover: Supply an alternate FileMover, for testing
 
1164
        """
 
1165
        if not no_conflicts:
 
1166
            conflicts = self.find_conflicts()
 
1167
            if len(conflicts) != 0:
 
1168
                raise MalformedTransform(conflicts=conflicts)
 
1169
        inv = self._tree.inventory
 
1170
        inventory_delta = []
 
1171
        child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
1172
        try:
 
1173
            if _mover is None:
 
1174
                mover = _FileMover()
 
1175
            else:
 
1176
                mover = _mover
 
1177
            try:
 
1178
                child_pb.update('Apply phase', 0, 2)
 
1179
                self._apply_removals(inv, inventory_delta, mover)
 
1180
                child_pb.update('Apply phase', 1, 2)
 
1181
                modified_paths = self._apply_insertions(inv, inventory_delta,
 
1182
                                                        mover)
 
1183
            except:
 
1184
                mover.rollback()
 
1185
                raise
 
1186
            else:
 
1187
                mover.apply_deletions()
 
1188
        finally:
 
1189
            child_pb.finished()
 
1190
        self._tree.apply_inventory_delta(inventory_delta)
 
1191
        self._done = True
 
1192
        self.finalize()
 
1193
        return _TransformResults(modified_paths, self.rename_count)
 
1194
 
 
1195
    def _apply_removals(self, inv, inventory_delta, mover):
 
1196
        """Perform tree operations that remove directory/inventory names.
 
1197
 
 
1198
        That is, delete files that are to be deleted, and put any files that
 
1199
        need renaming into limbo.  This must be done in strict child-to-parent
 
1200
        order.
 
1201
        """
 
1202
        tree_paths = list(self._tree_path_ids.iteritems())
 
1203
        tree_paths.sort(reverse=True)
 
1204
        child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
1205
        try:
 
1206
            for num, data in enumerate(tree_paths):
 
1207
                path, trans_id = data
 
1208
                child_pb.update('removing file', num, len(tree_paths))
 
1209
                full_path = self._tree.abspath(path)
 
1210
                if trans_id in self._removed_contents:
 
1211
                    mover.pre_delete(full_path, os.path.join(self._deletiondir,
 
1212
                                     trans_id))
 
1213
                elif trans_id in self._new_name or trans_id in \
 
1214
                    self._new_parent:
 
1215
                    try:
 
1216
                        mover.rename(full_path, self._limbo_name(trans_id))
 
1217
                    except OSError, e:
 
1218
                        if e.errno != errno.ENOENT:
 
1219
                            raise
 
1220
                    else:
 
1221
                        self.rename_count += 1
 
1222
                if trans_id in self._removed_id:
 
1223
                    if trans_id == self._new_root:
 
1224
                        file_id = self._tree.get_root_id()
 
1225
                    else:
 
1226
                        file_id = self.tree_file_id(trans_id)
 
1227
                    if file_id is not None:
 
1228
                        inventory_delta.append((path, None, file_id, None))
 
1229
        finally:
 
1230
            child_pb.finished()
 
1231
 
 
1232
    def _apply_insertions(self, inv, inventory_delta, mover):
 
1233
        """Perform tree operations that insert directory/inventory names.
 
1234
 
 
1235
        That is, create any files that need to be created, and restore from
 
1236
        limbo any files that needed renaming.  This must be done in strict
 
1237
        parent-to-child order.
 
1238
        """
 
1239
        new_paths = self.new_paths()
 
1240
        modified_paths = []
 
1241
        child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
1242
        completed_new = []
 
1243
        try:
 
1244
            for num, (path, trans_id) in enumerate(new_paths):
 
1245
                new_entry = None
 
1246
                child_pb.update('adding file', num, len(new_paths))
 
1247
                try:
 
1248
                    kind = self._new_contents[trans_id]
 
1249
                except KeyError:
 
1250
                    kind = contents = None
 
1251
                if trans_id in self._new_contents or \
 
1252
                    self.path_changed(trans_id):
 
1253
                    full_path = self._tree.abspath(path)
 
1254
                    if trans_id in self._needs_rename:
 
1255
                        try:
 
1256
                            mover.rename(self._limbo_name(trans_id), full_path)
 
1257
                        except OSError, e:
 
1258
                            # We may be renaming a dangling inventory id
 
1259
                            if e.errno != errno.ENOENT:
 
1260
                                raise
 
1261
                        else:
 
1262
                            self.rename_count += 1
 
1263
                    if trans_id in self._new_contents:
 
1264
                        modified_paths.append(full_path)
 
1265
                        completed_new.append(trans_id)
 
1266
 
 
1267
                if trans_id in self._new_id:
 
1268
                    if kind is None:
 
1269
                        kind = file_kind(self._tree.abspath(path))
 
1270
                    if trans_id in self._new_reference_revision:
 
1271
                        new_entry = inventory.TreeReference(
 
1272
                            self._new_id[trans_id],
 
1273
                            self._new_name[trans_id],
 
1274
                            self.final_file_id(self._new_parent[trans_id]),
 
1275
                            None, self._new_reference_revision[trans_id])
 
1276
                    else:
 
1277
                        new_entry = inventory.make_entry(kind,
 
1278
                            self.final_name(trans_id),
 
1279
                            self.final_file_id(self.final_parent(trans_id)),
 
1280
                            self._new_id[trans_id])
 
1281
                else:
 
1282
                    if trans_id in self._new_name or trans_id in\
 
1283
                        self._new_parent or\
 
1284
                        trans_id in self._new_executability:
 
1285
                        file_id = self.final_file_id(trans_id)
 
1286
                        if file_id is not None:
 
1287
                            entry = inv[file_id]
 
1288
                            new_entry = entry.copy()
 
1289
 
 
1290
                    if trans_id in self._new_name or trans_id in\
 
1291
                        self._new_parent:
 
1292
                            if new_entry is not None:
 
1293
                                new_entry.name = self.final_name(trans_id)
 
1294
                                parent = self.final_parent(trans_id)
 
1295
                                parent_id = self.final_file_id(parent)
 
1296
                                new_entry.parent_id = parent_id
 
1297
 
 
1298
                if trans_id in self._new_executability:
 
1299
                    self._set_executability(path, new_entry, trans_id)
 
1300
                if new_entry is not None:
 
1301
                    if new_entry.file_id in inv:
 
1302
                        old_path = inv.id2path(new_entry.file_id)
 
1303
                    else:
 
1304
                        old_path = None
 
1305
                    inventory_delta.append((old_path, path,
 
1306
                                            new_entry.file_id,
 
1307
                                            new_entry))
 
1308
        finally:
 
1309
            child_pb.finished()
 
1310
        for trans_id in completed_new:
 
1311
            del self._new_contents[trans_id]
 
1312
        return modified_paths
 
1313
 
 
1314
 
 
1315
class TransformPreview(TreeTransformBase):
 
1316
    """A TreeTransform for generating preview trees.
 
1317
 
 
1318
    Unlike TreeTransform, this version works when the input tree is a
 
1319
    RevisionTree, rather than a WorkingTree.  As a result, it tends to ignore
 
1320
    unversioned files in the input tree.
 
1321
    """
 
1322
 
 
1323
    def __init__(self, tree, pb=DummyProgress(), case_sensitive=True):
 
1324
        limbodir = tempfile.mkdtemp()
 
1325
        TreeTransformBase.__init__(self, tree, limbodir, pb, case_sensitive)
 
1326
 
 
1327
    def canonical_path(self, path):
 
1328
        return path
 
1329
 
 
1330
    def tree_kind(self, trans_id):
 
1331
        path = self._tree_id_paths.get(trans_id)
 
1332
        if path is None:
 
1333
            raise NoSuchFile(None)
 
1334
        file_id = self._tree.path2id(path)
 
1335
        return self._tree.kind(file_id)
 
1336
 
 
1337
    def _set_mode(self, trans_id, mode_id, typefunc):
 
1338
        """Set the mode of new file contents.
 
1339
        The mode_id is the existing file to get the mode from (often the same
 
1340
        as trans_id).  The operation is only performed if there's a mode match
 
1341
        according to typefunc.
 
1342
        """
 
1343
        # is it ok to ignore this?  probably
 
1344
        pass
 
1345
 
 
1346
    def iter_tree_children(self, parent_id):
 
1347
        """Iterate through the entry's tree children, if any"""
 
1348
        try:
 
1349
            path = self._tree_id_paths[parent_id]
 
1350
        except KeyError:
 
1351
            return
 
1352
        file_id = self.tree_file_id(parent_id)
 
1353
        for child in self._tree.inventory[file_id].children.iterkeys():
 
1354
            childpath = joinpath(path, child)
 
1355
            yield self.trans_id_tree_path(childpath)
 
1356
 
 
1357
 
 
1358
class _PreviewTree(object):
 
1359
    """Partial implementation of Tree to support show_diff_trees"""
 
1360
 
 
1361
    def __init__(self, transform):
 
1362
        self._transform = transform
 
1363
 
 
1364
    def lock_read(self):
 
1365
        # Perhaps in theory, this should lock the TreeTransform?
 
1366
        pass
 
1367
 
 
1368
    def unlock(self):
 
1369
        pass
 
1370
 
 
1371
    def _iter_changes(self, from_tree, include_unchanged=False,
 
1372
                      specific_files=None, pb=None, extra_trees=None,
 
1373
                      require_versioned=True, want_unversioned=False):
 
1374
        """See InterTree._iter_changes.
 
1375
 
 
1376
        This implementation does not support include_unchanged, specific_files,
 
1377
        or want_unversioned.  extra_trees, require_versioned, and pb are
 
1378
        ignored.
 
1379
        """
 
1380
        if from_tree is not self._transform._tree:
 
1381
            raise ValueError('from_tree must be transform source tree.')
 
1382
        if include_unchanged:
 
1383
            raise ValueError('include_unchanged is not supported')
 
1384
        if specific_files is not None:
 
1385
            raise ValueError('specific_files is not supported')
 
1386
        if want_unversioned:
 
1387
            raise ValueError('want_unversioned is not supported')
 
1388
        return self._transform._iter_changes()
 
1389
 
 
1390
    def kind(self, file_id):
 
1391
        trans_id = self._transform.trans_id_file_id(file_id)
 
1392
        return self._transform.final_kind(trans_id)
 
1393
 
 
1394
    def get_file_mtime(self, file_id, path=None):
 
1395
        """See Tree.get_file_mtime"""
 
1396
        trans_id = self._transform.trans_id_file_id(file_id)
 
1397
        name = self._transform._limbo_name(trans_id)
 
1398
        return os.stat(name).st_mtime
 
1399
 
 
1400
    def get_file(self, file_id):
 
1401
        """See Tree.get_file"""
 
1402
        trans_id = self._transform.trans_id_file_id(file_id)
 
1403
        name = self._transform._limbo_name(trans_id)
 
1404
        return open(name, 'rb')
 
1405
 
 
1406
    def paths2ids(self, specific_files, trees=None, require_versioned=False):
 
1407
        """See Tree.paths2ids"""
 
1408
        return 'not_empty'
 
1409
 
 
1410
 
864
1411
def joinpath(parent, child):
865
1412
    """Join tree-relative paths, handling the tree root specially"""
866
1413
    if parent is None or parent == "":
896
1443
            self._known_paths[trans_id] = self._determine_path(trans_id)
897
1444
        return self._known_paths[trans_id]
898
1445
 
 
1446
 
899
1447
def topology_sorted_ids(tree):
900
1448
    """Determine the topological order of the ids in a tree"""
901
1449
    file_ids = list(tree)
902
1450
    file_ids.sort(key=tree.id2path)
903
1451
    return file_ids
904
1452
 
905
 
def build_tree(tree, wt):
906
 
    """Create working tree for a branch, using a Transaction."""
 
1453
 
 
1454
def build_tree(tree, wt, accelerator_tree=None):
 
1455
    """Create working tree for a branch, using a TreeTransform.
 
1456
    
 
1457
    This function should be used on empty trees, having a tree root at most.
 
1458
    (see merge and revert functionality for working with existing trees)
 
1459
 
 
1460
    Existing files are handled like so:
 
1461
    
 
1462
    - Existing bzrdirs take precedence over creating new items.  They are
 
1463
      created as '%s.diverted' % name.
 
1464
    - Otherwise, if the content on disk matches the content we are building,
 
1465
      it is silently replaced.
 
1466
    - Otherwise, conflict resolution will move the old file to 'oldname.moved'.
 
1467
 
 
1468
    :param tree: The tree to convert wt into a copy of
 
1469
    :param wt: The working tree that files will be placed into
 
1470
    :param accelerator_tree: A tree which can be used for retrieving file
 
1471
        contents more quickly than tree itself, i.e. a workingtree.  tree
 
1472
        will be used for cases where accelerator_tree's content is different.
 
1473
    """
 
1474
    wt.lock_tree_write()
 
1475
    try:
 
1476
        tree.lock_read()
 
1477
        try:
 
1478
            if accelerator_tree is not None:
 
1479
                accelerator_tree.lock_read()
 
1480
            try:
 
1481
                return _build_tree(tree, wt, accelerator_tree)
 
1482
            finally:
 
1483
                if accelerator_tree is not None:
 
1484
                    accelerator_tree.unlock()
 
1485
        finally:
 
1486
            tree.unlock()
 
1487
    finally:
 
1488
        wt.unlock()
 
1489
 
 
1490
 
 
1491
def _build_tree(tree, wt, accelerator_tree):
 
1492
    """See build_tree."""
 
1493
    if len(wt.inventory) > 1:  # more than just a root
 
1494
        raise errors.WorkingTreeAlreadyPopulated(base=wt.basedir)
907
1495
    file_trans_id = {}
908
1496
    top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
909
1497
    pp = ProgressPhase("Build phase", 2, top_pb)
 
1498
    if tree.inventory.root is not None:
 
1499
        # This is kind of a hack: we should be altering the root
 
1500
        # as part of the regular tree shape diff logic.
 
1501
        # The conditional test here is to avoid doing an
 
1502
        # expensive operation (flush) every time the root id
 
1503
        # is set within the tree, nor setting the root and thus
 
1504
        # marking the tree as dirty, because we use two different
 
1505
        # idioms here: tree interfaces and inventory interfaces.
 
1506
        if wt.get_root_id() != tree.get_root_id():
 
1507
            wt.set_root_id(tree.get_root_id())
 
1508
            wt.flush()
910
1509
    tt = TreeTransform(wt)
 
1510
    divert = set()
911
1511
    try:
912
1512
        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)
 
1513
        file_trans_id[wt.get_root_id()] = \
 
1514
            tt.trans_id_tree_file_id(wt.get_root_id())
915
1515
        pb = bzrlib.ui.ui_factory.nested_progress_bar()
916
1516
        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]
 
1517
            deferred_contents = []
 
1518
            for num, (tree_path, entry) in \
 
1519
                enumerate(tree.inventory.iter_entries_by_dir()):
 
1520
                pb.update("Building tree", num - len(deferred_contents),
 
1521
                          len(tree.inventory))
920
1522
                if entry.parent_id is None:
921
1523
                    continue
 
1524
                reparent = False
 
1525
                file_id = entry.file_id
 
1526
                target_path = wt.abspath(tree_path)
 
1527
                try:
 
1528
                    kind = file_kind(target_path)
 
1529
                except NoSuchFile:
 
1530
                    pass
 
1531
                else:
 
1532
                    if kind == "directory":
 
1533
                        try:
 
1534
                            bzrdir.BzrDir.open(target_path)
 
1535
                        except errors.NotBranchError:
 
1536
                            pass
 
1537
                        else:
 
1538
                            divert.add(file_id)
 
1539
                    if (file_id not in divert and
 
1540
                        _content_match(tree, entry, file_id, kind,
 
1541
                        target_path)):
 
1542
                        tt.delete_contents(tt.trans_id_tree_path(tree_path))
 
1543
                        if kind == 'directory':
 
1544
                            reparent = True
922
1545
                if entry.parent_id not in file_trans_id:
923
 
                    raise repr(entry.parent_id)
 
1546
                    raise AssertionError(
 
1547
                        'entry %s parent id %r is not in file_trans_id %r'
 
1548
                        % (entry, entry.parent_id, file_trans_id))
924
1549
                parent_id = file_trans_id[entry.parent_id]
925
 
                file_trans_id[file_id] = new_by_entry(tt, entry, parent_id, 
926
 
                                                      tree)
 
1550
                if entry.kind == 'file':
 
1551
                    # We *almost* replicate new_by_entry, so that we can defer
 
1552
                    # getting the file text, and get them all at once.
 
1553
                    trans_id = tt.create_path(entry.name, parent_id)
 
1554
                    file_trans_id[file_id] = trans_id
 
1555
                    tt.version_file(entry.file_id, trans_id)
 
1556
                    executable = tree.is_executable(entry.file_id, tree_path)
 
1557
                    if executable is not None:
 
1558
                        tt.set_executability(executable, trans_id)
 
1559
                    deferred_contents.append((entry.file_id, trans_id))
 
1560
                else:
 
1561
                    file_trans_id[file_id] = new_by_entry(tt, entry, parent_id,
 
1562
                                                          tree)
 
1563
                if reparent:
 
1564
                    new_trans_id = file_trans_id[file_id]
 
1565
                    old_parent = tt.trans_id_tree_path(tree_path)
 
1566
                    _reparent_children(tt, old_parent, new_trans_id)
 
1567
            for num, (trans_id, bytes) in enumerate(
 
1568
                _iter_files_bytes_accelerated(tree, accelerator_tree,
 
1569
                                              deferred_contents)):
 
1570
                tt.create_file(bytes, trans_id)
 
1571
                pb.update('Adding file contents',
 
1572
                          (num + len(tree.inventory) - len(deferred_contents)),
 
1573
                          len(tree.inventory))
927
1574
        finally:
928
1575
            pb.finished()
929
1576
        pp.next_phase()
930
 
        tt.apply()
 
1577
        divert_trans = set(file_trans_id[f] for f in divert)
 
1578
        resolver = lambda t, c: resolve_checkout(t, c, divert_trans)
 
1579
        raw_conflicts = resolve_conflicts(tt, pass_func=resolver)
 
1580
        conflicts = cook_conflicts(raw_conflicts, tt)
 
1581
        for conflict in conflicts:
 
1582
            warning(conflict)
 
1583
        try:
 
1584
            wt.add_conflicts(conflicts)
 
1585
        except errors.UnsupportedOperation:
 
1586
            pass
 
1587
        result = tt.apply(no_conflicts=True)
931
1588
    finally:
932
1589
        tt.finalize()
933
1590
        top_pb.finished()
 
1591
    return result
 
1592
 
 
1593
 
 
1594
def _iter_files_bytes_accelerated(tree, accelerator_tree, desired_files):
 
1595
    if accelerator_tree is None:
 
1596
        new_desired_files = desired_files
 
1597
    else:
 
1598
        iter = accelerator_tree._iter_changes(tree, include_unchanged=True)
 
1599
        unchanged = dict((f, p[1]) for (f, p, c, v, d, n, k, e)
 
1600
                         in iter if not c)
 
1601
        new_desired_files = []
 
1602
        for file_id, identifier in desired_files:
 
1603
            accelerator_path = unchanged.get(file_id)
 
1604
            if accelerator_path is None:
 
1605
                new_desired_files.append((file_id, identifier))
 
1606
                continue
 
1607
            contents = accelerator_tree.get_file(file_id, accelerator_path)
 
1608
            try:
 
1609
                want_new = False
 
1610
                contents_bytes = (contents.read(),)
 
1611
            finally:
 
1612
                contents.close()
 
1613
            yield identifier, contents_bytes
 
1614
    for result in tree.iter_files_bytes(new_desired_files):
 
1615
        yield result
 
1616
 
 
1617
 
 
1618
def _reparent_children(tt, old_parent, new_parent):
 
1619
    for child in tt.iter_tree_children(old_parent):
 
1620
        tt.adjust_path(tt.final_name(child), new_parent, child)
 
1621
 
 
1622
def _reparent_transform_children(tt, old_parent, new_parent):
 
1623
    by_parent = tt.by_parent()
 
1624
    for child in by_parent[old_parent]:
 
1625
        tt.adjust_path(tt.final_name(child), new_parent, child)
 
1626
 
 
1627
def _content_match(tree, entry, file_id, kind, target_path):
 
1628
    if entry.kind != kind:
 
1629
        return False
 
1630
    if entry.kind == "directory":
 
1631
        return True
 
1632
    if entry.kind == "file":
 
1633
        if tree.get_file(file_id).read() == file(target_path, 'rb').read():
 
1634
            return True
 
1635
    elif entry.kind == "symlink":
 
1636
        if tree.get_symlink_target(file_id) == os.readlink(target_path):
 
1637
            return True
 
1638
    return False
 
1639
 
 
1640
 
 
1641
def resolve_checkout(tt, conflicts, divert):
 
1642
    new_conflicts = set()
 
1643
    for c_type, conflict in ((c[0], c) for c in conflicts):
 
1644
        # Anything but a 'duplicate' would indicate programmer error
 
1645
        assert c_type == 'duplicate', c_type
 
1646
        # Now figure out which is new and which is old
 
1647
        if tt.new_contents(conflict[1]):
 
1648
            new_file = conflict[1]
 
1649
            old_file = conflict[2]
 
1650
        else:
 
1651
            new_file = conflict[2]
 
1652
            old_file = conflict[1]
 
1653
 
 
1654
        # We should only get here if the conflict wasn't completely
 
1655
        # resolved
 
1656
        final_parent = tt.final_parent(old_file)
 
1657
        if new_file in divert:
 
1658
            new_name = tt.final_name(old_file)+'.diverted'
 
1659
            tt.adjust_path(new_name, final_parent, new_file)
 
1660
            new_conflicts.add((c_type, 'Diverted to',
 
1661
                               new_file, old_file))
 
1662
        else:
 
1663
            new_name = tt.final_name(old_file)+'.moved'
 
1664
            tt.adjust_path(new_name, final_parent, old_file)
 
1665
            new_conflicts.add((c_type, 'Moved existing file to',
 
1666
                               old_file, new_file))
 
1667
    return new_conflicts
 
1668
 
934
1669
 
935
1670
def new_by_entry(tt, entry, parent_id, tree):
936
1671
    """Create a new file according to its inventory entry"""
941
1676
        executable = tree.is_executable(entry.file_id)
942
1677
        return tt.new_file(name, parent_id, contents, entry.file_id, 
943
1678
                           executable)
944
 
    elif kind == 'directory':
945
 
        return tt.new_directory(name, parent_id, entry.file_id)
 
1679
    elif kind in ('directory', 'tree-reference'):
 
1680
        trans_id = tt.new_directory(name, parent_id, entry.file_id)
 
1681
        if kind == 'tree-reference':
 
1682
            tt.set_tree_reference(entry.reference_revision, trans_id)
 
1683
        return trans_id 
946
1684
    elif kind == 'symlink':
947
1685
        target = tree.get_symlink_target(entry.file_id)
948
1686
        return tt.new_symlink(name, parent_id, target, entry.file_id)
 
1687
    else:
 
1688
        raise errors.BadFileKindError(name, kind)
 
1689
 
949
1690
 
950
1691
def create_by_entry(tt, entry, tree, trans_id, lines=None, mode_id=None):
951
1692
    """Create new file contents according to an inventory entry."""
952
1693
    if entry.kind == "file":
953
 
        if lines == None:
 
1694
        if lines is None:
954
1695
            lines = tree.get_file(entry.file_id).readlines()
955
1696
        tt.create_file(lines, trans_id, mode_id=mode_id)
956
1697
    elif entry.kind == "symlink":
958
1699
    elif entry.kind == "directory":
959
1700
        tt.create_directory(trans_id)
960
1701
 
 
1702
 
961
1703
def create_entry_executability(tt, entry, trans_id):
962
1704
    """Set the executability of a trans_id according to an inventory entry"""
963
1705
    if entry.kind == "file":
964
1706
        tt.set_executability(entry.executable, trans_id)
965
1707
 
966
1708
 
 
1709
@deprecated_function(zero_fifteen)
967
1710
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
 
 
 
1711
    """Find the ids corresponding to specified filenames.
 
1712
    
 
1713
    Deprecated: Please use tree1.paths2ids(filenames, [tree2]).
 
1714
    """
 
1715
    working_tree.lock_read()
 
1716
    try:
 
1717
        target_tree.lock_read()
 
1718
        try:
 
1719
            return working_tree.paths2ids(filenames, [target_tree])
 
1720
        finally:
 
1721
            target_tree.unlock()
 
1722
    finally:
 
1723
        working_tree.unlock()
 
1724
 
 
1725
 
 
1726
@deprecated_function(zero_ninety)
985
1727
def change_entry(tt, file_id, working_tree, target_tree, 
986
1728
                 trans_id_file_id, backups, trans_id, by_parent):
987
1729
    """Replace a file_id's contents with those from a target tree."""
 
1730
    if file_id is None and target_tree is None:
 
1731
        # skip the logic altogether in the deprecation test
 
1732
        return
988
1733
    e_trans_id = trans_id_file_id(file_id)
989
1734
    entry = target_tree.inventory[file_id]
990
1735
    has_contents, contents_mod, meta_mod, = _entry_changes(file_id, entry, 
1023
1768
 
1024
1769
 
1025
1770
def get_backup_name(entry, by_parent, parent_trans_id, tt):
 
1771
    return _get_backup_name(entry.name, by_parent, parent_trans_id, tt)
 
1772
 
 
1773
 
 
1774
def _get_backup_name(name, by_parent, parent_trans_id, tt):
1026
1775
    """Produce a backup-style name that appears to be available"""
1027
1776
    def name_gen():
1028
1777
        counter = 1
1029
1778
        while True:
1030
 
            yield "%s.~%d~" % (entry.name, counter)
 
1779
            yield "%s.~%d~" % (name, counter)
1031
1780
            counter += 1
1032
 
    for name in name_gen():
1033
 
        if not tt.has_named_child(by_parent, parent_trans_id, name):
1034
 
            return name
 
1781
    for new_name in name_gen():
 
1782
        if not tt.has_named_child(by_parent, parent_trans_id, new_name):
 
1783
            return new_name
 
1784
 
1035
1785
 
1036
1786
def _entry_changes(file_id, entry, working_tree):
1037
1787
    """Determine in which ways the inventory entry has changed.
1045
1795
    try:
1046
1796
        working_kind = working_tree.kind(file_id)
1047
1797
        has_contents = True
1048
 
    except OSError, e:
1049
 
        if e.errno != errno.ENOENT:
1050
 
            raise
 
1798
    except NoSuchFile:
1051
1799
        has_contents = False
1052
1800
        contents_mod = True
1053
1801
        meta_mod = False
1054
1802
    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:
 
1803
        if entry.kind != working_kind:
1059
1804
            contents_mod, meta_mod = True, False
1060
1805
        else:
1061
1806
            cur_entry._read_tree_state(working_tree.id2path(file_id), 
1065
1810
    return has_contents, contents_mod, meta_mod
1066
1811
 
1067
1812
 
1068
 
def revert(working_tree, target_tree, filenames, backups=False, 
1069
 
           pb=DummyProgress()):
 
1813
def revert(working_tree, target_tree, filenames, backups=False,
 
1814
           pb=DummyProgress(), change_reporter=None):
1070
1815
    """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
 
 
 
1816
    target_tree.lock_read()
1075
1817
    tt = TreeTransform(working_tree, pb)
1076
1818
    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:
 
1819
        pp = ProgressPhase("Revert phase", 3, pb)
 
1820
        pp.next_phase()
 
1821
        child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
1822
        try:
 
1823
            merge_modified = _alter_files(working_tree, target_tree, tt,
 
1824
                                          child_pb, filenames, backups)
 
1825
        finally:
 
1826
            child_pb.finished()
 
1827
        pp.next_phase()
 
1828
        child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
1829
        try:
 
1830
            raw_conflicts = resolve_conflicts(tt, child_pb,
 
1831
                lambda t, c: conflict_pass(t, c, target_tree))
 
1832
        finally:
 
1833
            child_pb.finished()
 
1834
        conflicts = cook_conflicts(raw_conflicts, tt)
 
1835
        if change_reporter:
 
1836
            change_reporter = delta._ChangeReporter(
 
1837
                unversioned_filter=working_tree.is_ignored)
 
1838
            delta.report_changes(tt._iter_changes(), change_reporter)
 
1839
        for conflict in conflicts:
 
1840
            warning(conflict)
 
1841
        pp.next_phase()
 
1842
        tt.apply()
 
1843
        working_tree.set_merge_modified(merge_modified)
 
1844
    finally:
 
1845
        target_tree.unlock()
 
1846
        tt.finalize()
 
1847
        pb.clear()
 
1848
    return conflicts
 
1849
 
 
1850
 
 
1851
def _alter_files(working_tree, target_tree, tt, pb, specific_files,
 
1852
                 backups):
 
1853
    merge_modified = working_tree.merge_modified()
 
1854
    change_list = target_tree._iter_changes(working_tree,
 
1855
        specific_files=specific_files, pb=pb)
 
1856
    if target_tree.inventory.root is None:
 
1857
        skip_root = True
 
1858
    else:
 
1859
        skip_root = False
 
1860
    basis_tree = None
 
1861
    try:
 
1862
        deferred_files = []
 
1863
        for id_num, (file_id, path, changed_content, versioned, parent, name,
 
1864
                kind, executable) in enumerate(change_list):
 
1865
            if skip_root and file_id[0] is not None and parent[0] is None:
 
1866
                continue
 
1867
            trans_id = tt.trans_id_file_id(file_id)
 
1868
            mode_id = None
 
1869
            if changed_content:
 
1870
                keep_content = False
 
1871
                if kind[0] == 'file' and (backups or kind[1] is None):
 
1872
                    wt_sha1 = working_tree.get_file_sha1(file_id)
 
1873
                    if merge_modified.get(file_id) != wt_sha1:
 
1874
                        # acquire the basis tree lazily to prevent the
 
1875
                        # expense of accessing it when it's not needed ?
 
1876
                        # (Guessing, RBC, 200702)
 
1877
                        if basis_tree is None:
 
1878
                            basis_tree = working_tree.basis_tree()
 
1879
                            basis_tree.lock_read()
 
1880
                        if file_id in basis_tree:
 
1881
                            if wt_sha1 != basis_tree.get_file_sha1(file_id):
 
1882
                                keep_content = True
 
1883
                        elif kind[1] is None and not versioned[1]:
 
1884
                            keep_content = True
 
1885
                if kind[0] is not None:
 
1886
                    if not keep_content:
1121
1887
                        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({})
 
1888
                    elif kind[1] is not None:
 
1889
                        parent_trans_id = tt.trans_id_file_id(parent[0])
 
1890
                        by_parent = tt.by_parent()
 
1891
                        backup_name = _get_backup_name(name[0], by_parent,
 
1892
                                                       parent_trans_id, tt)
 
1893
                        tt.adjust_path(backup_name, parent_trans_id, trans_id)
 
1894
                        new_trans_id = tt.create_path(name[0], parent_trans_id)
 
1895
                        if versioned == (True, True):
 
1896
                            tt.unversion_file(trans_id)
 
1897
                            tt.version_file(file_id, new_trans_id)
 
1898
                        # New contents should have the same unix perms as old
 
1899
                        # contents
 
1900
                        mode_id = trans_id
 
1901
                        trans_id = new_trans_id
 
1902
                if kind[1] == 'directory':
 
1903
                    tt.create_directory(trans_id)
 
1904
                elif kind[1] == 'symlink':
 
1905
                    tt.create_symlink(target_tree.get_symlink_target(file_id),
 
1906
                                      trans_id)
 
1907
                elif kind[1] == 'file':
 
1908
                    deferred_files.append((file_id, (trans_id, mode_id)))
 
1909
                    if basis_tree is None:
 
1910
                        basis_tree = working_tree.basis_tree()
 
1911
                        basis_tree.lock_read()
 
1912
                    new_sha1 = target_tree.get_file_sha1(file_id)
 
1913
                    if (file_id in basis_tree and new_sha1 ==
 
1914
                        basis_tree.get_file_sha1(file_id)):
 
1915
                        if file_id in merge_modified:
 
1916
                            del merge_modified[file_id]
 
1917
                    else:
 
1918
                        merge_modified[file_id] = new_sha1
 
1919
 
 
1920
                    # preserve the execute bit when backing up
 
1921
                    if keep_content and executable[0] == executable[1]:
 
1922
                        tt.set_executability(executable[1], trans_id)
 
1923
                else:
 
1924
                    assert kind[1] is None
 
1925
            if versioned == (False, True):
 
1926
                tt.version_file(file_id, trans_id)
 
1927
            if versioned == (True, False):
 
1928
                tt.unversion_file(trans_id)
 
1929
            if (name[1] is not None and 
 
1930
                (name[0] != name[1] or parent[0] != parent[1])):
 
1931
                tt.adjust_path(
 
1932
                    name[1], tt.trans_id_file_id(parent[1]), trans_id)
 
1933
            if executable[0] != executable[1] and kind[1] == "file":
 
1934
                tt.set_executability(executable[1], trans_id)
 
1935
        for (trans_id, mode_id), bytes in target_tree.iter_files_bytes(
 
1936
            deferred_files):
 
1937
            tt.create_file(bytes, trans_id, mode_id)
1137
1938
    finally:
1138
 
        tt.finalize()
1139
 
        pb.clear()
1140
 
    return conflicts
1141
 
 
1142
 
 
1143
 
def resolve_conflicts(tt, pb=DummyProgress()):
 
1939
        if basis_tree is not None:
 
1940
            basis_tree.unlock()
 
1941
    return merge_modified
 
1942
 
 
1943
 
 
1944
def resolve_conflicts(tt, pb=DummyProgress(), pass_func=None):
1144
1945
    """Make many conflict-resolution attempts, but die if they fail"""
 
1946
    if pass_func is None:
 
1947
        pass_func = conflict_pass
1145
1948
    new_conflicts = set()
1146
1949
    try:
1147
1950
        for n in range(10):
1149
1952
            conflicts = tt.find_conflicts()
1150
1953
            if len(conflicts) == 0:
1151
1954
                return new_conflicts
1152
 
            new_conflicts.update(conflict_pass(tt, conflicts))
 
1955
            new_conflicts.update(pass_func(tt, conflicts))
1153
1956
        raise MalformedTransform(conflicts=conflicts)
1154
1957
    finally:
1155
1958
        pb.clear()
1156
1959
 
1157
1960
 
1158
 
def conflict_pass(tt, conflicts):
1159
 
    """Resolve some classes of conflicts."""
 
1961
def conflict_pass(tt, conflicts, path_tree=None):
 
1962
    """Resolve some classes of conflicts.
 
1963
 
 
1964
    :param tt: The transform to resolve conflicts in
 
1965
    :param conflicts: The conflicts to resolve
 
1966
    :param path_tree: A Tree to get supplemental paths from
 
1967
    """
1160
1968
    new_conflicts = set()
1161
1969
    for c_type, conflict in ((c[0], c) for c in conflicts):
1162
1970
        if c_type == 'duplicate id':
1165
1973
                               conflict[1], conflict[2], ))
1166
1974
        elif c_type == 'duplicate':
1167
1975
            # files that were renamed take precedence
1168
 
            new_name = tt.final_name(conflict[1])+'.moved'
1169
1976
            final_parent = tt.final_parent(conflict[1])
1170
1977
            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]))
 
1978
                existing_file, new_file = conflict[2], conflict[1]
1174
1979
            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]))
 
1980
                existing_file, new_file = conflict[1], conflict[2]
 
1981
            new_name = tt.final_name(existing_file)+'.moved'
 
1982
            tt.adjust_path(new_name, final_parent, existing_file)
 
1983
            new_conflicts.add((c_type, 'Moved existing file to', 
 
1984
                               existing_file, new_file))
1178
1985
        elif c_type == 'parent loop':
1179
1986
            # break the loop by undoing one of the ops that caused the loop
1180
1987
            cur = conflict[1]
1188
1995
            trans_id = conflict[1]
1189
1996
            try:
1190
1997
                tt.cancel_deletion(trans_id)
1191
 
                new_conflicts.add((c_type, 'Not deleting', trans_id))
 
1998
                new_conflicts.add(('deleting parent', 'Not deleting', 
 
1999
                                   trans_id))
1192
2000
            except KeyError:
1193
2001
                tt.create_directory(trans_id)
1194
 
                new_conflicts.add((c_type, 'Created directory.', trans_id))
 
2002
                new_conflicts.add((c_type, 'Created directory', trans_id))
 
2003
                try:
 
2004
                    tt.final_name(trans_id)
 
2005
                except NoFinalPath:
 
2006
                    if path_tree is not None:
 
2007
                        file_id = tt.final_file_id(trans_id)
 
2008
                        entry = path_tree.inventory[file_id]
 
2009
                        parent_trans_id = tt.trans_id_file_id(entry.parent_id)
 
2010
                        tt.adjust_path(entry.name, parent_trans_id, trans_id)
1195
2011
        elif c_type == 'unversioned parent':
1196
2012
            tt.version_file(tt.inactive_file_id(conflict[1]), conflict[1])
1197
2013
            new_conflicts.add((c_type, 'Versioned directory', conflict[1]))
 
2014
        elif c_type == 'non-directory parent':
 
2015
            parent_id = conflict[1]
 
2016
            parent_parent = tt.final_parent(parent_id)
 
2017
            parent_name = tt.final_name(parent_id)
 
2018
            parent_file_id = tt.final_file_id(parent_id)
 
2019
            new_parent_id = tt.new_directory(parent_name + '.new',
 
2020
                parent_parent, parent_file_id)
 
2021
            _reparent_transform_children(tt, parent_id, new_parent_id)
 
2022
            tt.unversion_file(parent_id)
 
2023
            new_conflicts.add((c_type, 'Created directory', new_parent_id))
1198
2024
    return new_conflicts
1199
2025
 
 
2026
 
1200
2027
def cook_conflicts(raw_conflicts, tt):
1201
2028
    """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
 
2029
    from bzrlib.conflicts import Conflict
 
2030
    conflict_iter = iter_cook_conflicts(raw_conflicts, tt)
 
2031
    return sorted(conflict_iter, key=Conflict.sort_key)
1209
2032
 
1210
 
    return sorted(list(iter_cook_conflicts(raw_conflicts, tt)), key=key)
1211
2033
 
1212
2034
def iter_cook_conflicts(raw_conflicts, tt):
1213
2035
    from bzrlib.conflicts import Conflict
1228
2050
                                   file_id=modified_id, 
1229
2051
                                   conflict_path=conflicting_path,
1230
2052
                                   conflict_file_id=conflicting_id)
 
2053
 
 
2054
 
 
2055
class _FileMover(object):
 
2056
    """Moves and deletes files for TreeTransform, tracking operations"""
 
2057
 
 
2058
    def __init__(self):
 
2059
        self.past_renames = []
 
2060
        self.pending_deletions = []
 
2061
 
 
2062
    def rename(self, from_, to):
 
2063
        """Rename a file from one path to another.  Functions like os.rename"""
 
2064
        try:
 
2065
            os.rename(from_, to)
 
2066
        except OSError, e:
 
2067
            if e.errno in (errno.EEXIST, errno.ENOTEMPTY):
 
2068
                raise errors.FileExists(to, str(e))
 
2069
            raise
 
2070
        self.past_renames.append((from_, to))
 
2071
 
 
2072
    def pre_delete(self, from_, to):
 
2073
        """Rename a file out of the way and mark it for deletion.
 
2074
 
 
2075
        Unlike os.unlink, this works equally well for files and directories.
 
2076
        :param from_: The current file path
 
2077
        :param to: A temporary path for the file
 
2078
        """
 
2079
        self.rename(from_, to)
 
2080
        self.pending_deletions.append(to)
 
2081
 
 
2082
    def rollback(self):
 
2083
        """Reverse all renames that have been performed"""
 
2084
        for from_, to in reversed(self.past_renames):
 
2085
            os.rename(to, from_)
 
2086
        # after rollback, don't reuse _FileMover
 
2087
        past_renames = None
 
2088
        pending_deletions = None
 
2089
 
 
2090
    def apply_deletions(self):
 
2091
        """Apply all marked deletions"""
 
2092
        for path in self.pending_deletions:
 
2093
            delete_any(path)
 
2094
        # after apply_deletions, don't reuse _FileMover
 
2095
        past_renames = None
 
2096
        pending_deletions = None