/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: Canonical.com Patch Queue Manager
  • Date: 2008-02-23 16:08:08 UTC
  • mfrom: (3220.1.5 bug.107593)
  • Revision ID: pqm@pqm.ubuntu.com-20080223160808-81yb25z7tmhlss8q
(Dmitry Vasiliev) Restore auto-detection of plink.exe on Windows
 (bug #107593)

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