~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/transform.py

  • Committer: Vincent Ladeuil
  • Date: 2012-03-13 17:25:29 UTC
  • mfrom: (6499 +trunk)
  • mto: This revision was merged to the branch mainline in revision 6501.
  • Revision ID: v.ladeuil+lp@free.fr-20120313172529-i0suyjnepsor25i7
Merge trunk

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2006-2010 Canonical Ltd
 
1
# Copyright (C) 2006-2011 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
14
14
# along with this program; if not, write to the Free Software
15
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
16
 
 
17
from __future__ import absolute_import
 
18
 
17
19
import os
18
20
import errno
19
21
from stat import S_ISREG, S_IEXEC
20
22
import time
21
23
 
22
 
from bzrlib.lazy_import import lazy_import
23
 
lazy_import(globals(), """
 
24
from bzrlib import (
 
25
    config as _mod_config,
 
26
    errors,
 
27
    lazy_import,
 
28
    registry,
 
29
    trace,
 
30
    tree,
 
31
    )
 
32
lazy_import.lazy_import(globals(), """
24
33
from bzrlib import (
25
34
    annotate,
26
35
    bencode,
27
 
    bzrdir,
 
36
    controldir,
28
37
    commit,
 
38
    conflicts,
29
39
    delta,
30
 
    errors,
31
40
    inventory,
32
41
    multiparent,
33
42
    osutils,
34
43
    revision as _mod_revision,
35
44
    ui,
 
45
    urlutils,
36
46
    )
 
47
from bzrlib.i18n import gettext
37
48
""")
38
 
from bzrlib.errors import (DuplicateKey, MalformedTransform, NoSuchFile,
 
49
from bzrlib.errors import (DuplicateKey, MalformedTransform,
39
50
                           ReusingTransform, CantMoveRoot,
40
 
                           ExistingLimbo, ImmortalLimbo, NoFinalPath,
 
51
                           ImmortalLimbo, NoFinalPath,
41
52
                           UnableCreateSymlink)
42
53
from bzrlib.filters import filtered_output_bytes, ContentFilterContext
43
 
from bzrlib.inventory import InventoryEntry
 
54
from bzrlib.mutabletree import MutableTree
44
55
from bzrlib.osutils import (
45
56
    delete_any,
46
57
    file_kind,
47
58
    has_symlinks,
48
 
    lexists,
49
59
    pathjoin,
50
60
    sha_file,
51
61
    splitpath,
52
 
    supports_executable,
53
 
)
 
62
    )
54
63
from bzrlib.progress import ProgressPhase
55
64
from bzrlib.symbol_versioning import (
56
 
        deprecated_function,
57
 
        deprecated_in,
58
 
        )
59
 
from bzrlib.trace import mutter, warning
60
 
from bzrlib import tree
61
 
import bzrlib.ui
62
 
import bzrlib.urlutils as urlutils
 
65
    deprecated_function,
 
66
    deprecated_in,
 
67
    deprecated_method,
 
68
    )
63
69
 
64
70
 
65
71
ROOT_PARENT = "root-parent"
66
72
 
67
 
 
68
73
def unique_add(map, key, value):
69
74
    if key in map:
70
75
        raise DuplicateKey(key=key)
71
76
    map[key] = value
72
77
 
73
78
 
 
79
 
74
80
class _TransformResults(object):
75
81
    def __init__(self, modified_paths, rename_count):
76
82
        object.__init__(self)
100
106
        self._new_parent = {}
101
107
        # mapping of trans_id with new contents -> new file_kind
102
108
        self._new_contents = {}
 
109
        # mapping of trans_id => (sha1 of content, stat_value)
 
110
        self._observed_sha1s = {}
103
111
        # Set of trans_ids whose contents will be removed
104
112
        self._removed_contents = set()
105
113
        # Mapping of trans_id -> new execute-bit value
124
132
            self._new_root = self.trans_id_tree_file_id(root_id)
125
133
        else:
126
134
            self._new_root = None
127
 
        # Indictor of whether the transform has been applied
 
135
        # Indicator of whether the transform has been applied
128
136
        self._done = False
129
137
        # A progress bar
130
138
        self._pb = pb
133
141
        # A counter of how many files have been renamed
134
142
        self.rename_count = 0
135
143
 
 
144
    def __enter__(self):
 
145
        """Support Context Manager API."""
 
146
        return self
 
147
 
 
148
    def __exit__(self, exc_type, exc_val, exc_tb):
 
149
        """Support Context Manager API."""
 
150
        self.finalize()
 
151
 
136
152
    def finalize(self):
137
153
        """Release the working tree lock, if held.
138
154
 
141
157
        """
142
158
        if self._tree is None:
143
159
            return
 
160
        for hook in MutableTree.hooks['post_transform']:
 
161
            hook(self._tree, self)
144
162
        self._tree.unlock()
145
163
        self._tree = None
146
164
 
213
231
        This means that the old root trans-id becomes obsolete, so it is
214
232
        recommended only to invoke this after the root trans-id has become
215
233
        irrelevant.
 
234
 
216
235
        """
217
 
        new_roots = [k for k, v in self._new_parent.iteritems() if v is
 
236
        new_roots = [k for k, v in self._new_parent.iteritems() if v ==
218
237
                     ROOT_PARENT]
219
238
        if len(new_roots) < 1:
220
239
            return
224
243
            self._new_root = new_roots[0]
225
244
            return
226
245
        old_new_root = new_roots[0]
227
 
        # TODO: What to do if a old_new_root is present, but self._new_root is
228
 
        #       not listed as being removed? This code explicitly unversions
229
 
        #       the old root and versions it with the new file_id. Though that
230
 
        #       seems like an incomplete delta
231
 
 
232
246
        # unversion the new root's directory.
233
 
        file_id = self.final_file_id(old_new_root)
 
247
        if self.final_kind(self._new_root) is None:
 
248
            file_id = self.final_file_id(old_new_root)
 
249
        else:
 
250
            file_id = self.final_file_id(self._new_root)
234
251
        if old_new_root in self._new_id:
235
252
            self.cancel_versioning(old_new_root)
236
253
        else:
240
257
        if (self.tree_file_id(self._new_root) is not None and
241
258
            self._new_root not in self._removed_id):
242
259
            self.unversion_file(self._new_root)
243
 
        self.version_file(file_id, self._new_root)
 
260
        if file_id is not None:
 
261
            self.version_file(file_id, self._new_root)
244
262
 
245
263
        # Now move children of new root into old root directory.
246
264
        # Ensure all children are registered with the transaction, but don't
315
333
 
316
334
    def delete_contents(self, trans_id):
317
335
        """Schedule the contents of a path entry for deletion"""
318
 
        # Ensure that the object exists in the WorkingTree, this will raise an
319
 
        # exception if there is a problem
320
 
        self.tree_kind(trans_id)
321
 
        self._removed_contents.add(trans_id)
 
336
        kind = self.tree_kind(trans_id)
 
337
        if kind is not None:
 
338
            self._removed_contents.add(trans_id)
322
339
 
323
340
    def cancel_deletion(self, trans_id):
324
341
        """Cancel a scheduled deletion"""
381
398
        return sorted(FinalPaths(self).get_paths(new_ids))
382
399
 
383
400
    def _inventory_altered(self):
384
 
        """Get the trans_ids and paths of files needing new inv entries."""
385
 
        new_ids = set()
386
 
        for id_set in [self._new_name, self._new_parent, self._new_id,
 
401
        """Determine which trans_ids need new Inventory entries.
 
402
 
 
403
        An new entry is needed when anything that would be reflected by an
 
404
        inventory entry changes, including file name, file_id, parent file_id,
 
405
        file kind, and the execute bit.
 
406
 
 
407
        Some care is taken to return entries with real changes, not cases
 
408
        where the value is deleted and then restored to its original value,
 
409
        but some actually unchanged values may be returned.
 
410
 
 
411
        :returns: A list of (path, trans_id) for all items requiring an
 
412
            inventory change. Ordered by path.
 
413
        """
 
414
        changed_ids = set()
 
415
        # Find entries whose file_ids are new (or changed).
 
416
        new_file_id = set(t for t in self._new_id
 
417
                          if self._new_id[t] != self.tree_file_id(t))
 
418
        for id_set in [self._new_name, self._new_parent, new_file_id,
387
419
                       self._new_executability]:
388
 
            new_ids.update(id_set)
 
420
            changed_ids.update(id_set)
 
421
        # removing implies a kind change
389
422
        changed_kind = set(self._removed_contents)
 
423
        # so does adding
390
424
        changed_kind.intersection_update(self._new_contents)
391
 
        changed_kind.difference_update(new_ids)
392
 
        changed_kind = (t for t in changed_kind if self.tree_kind(t) !=
393
 
                        self.final_kind(t))
394
 
        new_ids.update(changed_kind)
395
 
        return sorted(FinalPaths(self).get_paths(new_ids))
 
425
        # Ignore entries that are already known to have changed.
 
426
        changed_kind.difference_update(changed_ids)
 
427
        #  to keep only the truly changed ones
 
428
        changed_kind = (t for t in changed_kind
 
429
                        if self.tree_kind(t) != self.final_kind(t))
 
430
        # all kind changes will alter the inventory
 
431
        changed_ids.update(changed_kind)
 
432
        # To find entries with changed parent_ids, find parents which existed,
 
433
        # but changed file_id.
 
434
        changed_file_id = set(t for t in new_file_id if t in self._removed_id)
 
435
        # Now add all their children to the set.
 
436
        for parent_trans_id in new_file_id:
 
437
            changed_ids.update(self.iter_tree_children(parent_trans_id))
 
438
        return sorted(FinalPaths(self).get_paths(changed_ids))
396
439
 
397
440
    def final_kind(self, trans_id):
398
441
        """Determine the final file kind, after any changes applied.
399
442
 
400
 
        Raises NoSuchFile if the file does not exist/has no contents.
401
 
        (It is conceivable that a path would be created without the
402
 
        corresponding contents insertion command)
 
443
        :return: None if the file does not exist/has no contents.  (It is
 
444
            conceivable that a path would be created without the corresponding
 
445
            contents insertion command)
403
446
        """
404
447
        if trans_id in self._new_contents:
405
448
            return self._new_contents[trans_id]
406
449
        elif trans_id in self._removed_contents:
407
 
            raise NoSuchFile(None)
 
450
            return None
408
451
        else:
409
452
            return self.tree_kind(trans_id)
410
453
 
523
566
        for trans_id in self._removed_id:
524
567
            file_id = self.tree_file_id(trans_id)
525
568
            if file_id is not None:
526
 
                if self._tree.inventory[file_id].kind == 'directory':
 
569
                if self._tree.stored_kind(file_id) == 'directory':
527
570
                    parents.append(trans_id)
528
571
            elif self.tree_kind(trans_id) == 'directory':
529
572
                parents.append(trans_id)
532
575
            # ensure that all children are registered with the transaction
533
576
            list(self.iter_tree_children(parent_id))
534
577
 
 
578
    @deprecated_method(deprecated_in((2, 3, 0)))
535
579
    def has_named_child(self, by_parent, parent_id, name):
536
 
        try:
537
 
            children = by_parent[parent_id]
538
 
        except KeyError:
539
 
            children = []
540
 
        for child in children:
 
580
        return self._has_named_child(
 
581
            name, parent_id, known_children=by_parent.get(parent_id, []))
 
582
 
 
583
    def _has_named_child(self, name, parent_id, known_children):
 
584
        """Does a parent already have a name child.
 
585
 
 
586
        :param name: The searched for name.
 
587
 
 
588
        :param parent_id: The parent for which the check is made.
 
589
 
 
590
        :param known_children: The already known children. This should have
 
591
            been recently obtained from `self.by_parent.get(parent_id)`
 
592
            (or will be if None is passed).
 
593
        """
 
594
        if known_children is None:
 
595
            known_children = self.by_parent().get(parent_id, [])
 
596
        for child in known_children:
541
597
            if self.final_name(child) == name:
542
598
                return True
543
 
        try:
544
 
            path = self._tree_id_paths[parent_id]
545
 
        except KeyError:
 
599
        parent_path = self._tree_id_paths.get(parent_id, None)
 
600
        if parent_path is None:
 
601
            # No parent... no children
546
602
            return False
547
 
        childpath = joinpath(path, name)
548
 
        child_id = self._tree_path_ids.get(childpath)
 
603
        child_path = joinpath(parent_path, name)
 
604
        child_id = self._tree_path_ids.get(child_path, None)
549
605
        if child_id is None:
550
 
            return lexists(self._tree.abspath(childpath))
 
606
            # Not known by the tree transform yet, check the filesystem
 
607
            return osutils.lexists(self._tree.abspath(child_path))
551
608
        else:
552
 
            if self.final_parent(child_id) != parent_id:
553
 
                return False
554
 
            if child_id in self._removed_contents:
555
 
                # XXX What about dangling file-ids?
556
 
                return False
557
 
            else:
558
 
                return True
 
609
            raise AssertionError('child_id is missing: %s, %s, %s'
 
610
                                 % (name, parent_id, child_id))
 
611
 
 
612
    def _available_backup_name(self, name, target_id):
 
613
        """Find an available backup name.
 
614
 
 
615
        :param name: The basename of the file.
 
616
 
 
617
        :param target_id: The directory trans_id where the backup should 
 
618
            be placed.
 
619
        """
 
620
        known_children = self.by_parent().get(target_id, [])
 
621
        return osutils.available_backup_name(
 
622
            name,
 
623
            lambda base: self._has_named_child(
 
624
                base, target_id, known_children))
559
625
 
560
626
    def _parent_loops(self):
561
627
        """No entry should be its own ancestor"""
563
629
        for trans_id in self._new_parent:
564
630
            seen = set()
565
631
            parent_id = trans_id
566
 
            while parent_id is not ROOT_PARENT:
 
632
            while parent_id != ROOT_PARENT:
567
633
                seen.add(parent_id)
568
634
                try:
569
635
                    parent_id = self.final_parent(parent_id)
579
645
        """If parent directories are versioned, children must be versioned."""
580
646
        conflicts = []
581
647
        for parent_id, children in by_parent.iteritems():
582
 
            if parent_id is ROOT_PARENT:
 
648
            if parent_id == ROOT_PARENT:
583
649
                continue
584
650
            if self.final_file_id(parent_id) is not None:
585
651
                continue
596
662
        """
597
663
        conflicts = []
598
664
        for trans_id in self._new_id.iterkeys():
599
 
            try:
600
 
                kind = self.final_kind(trans_id)
601
 
            except NoSuchFile:
 
665
            kind = self.final_kind(trans_id)
 
666
            if kind is None:
602
667
                conflicts.append(('versioning no contents', trans_id))
603
668
                continue
604
 
            if not InventoryEntry.versionable_kind(kind):
 
669
            if not inventory.InventoryEntry.versionable_kind(kind):
605
670
                conflicts.append(('versioning bad kind', trans_id, kind))
606
671
        return conflicts
607
672
 
618
683
            if self.final_file_id(trans_id) is None:
619
684
                conflicts.append(('unversioned executability', trans_id))
620
685
            else:
621
 
                try:
622
 
                    non_file = self.final_kind(trans_id) != "file"
623
 
                except NoSuchFile:
624
 
                    non_file = True
625
 
                if non_file is True:
 
686
                if self.final_kind(trans_id) != "file":
626
687
                    conflicts.append(('non-file executability', trans_id))
627
688
        return conflicts
628
689
 
630
691
        """Check for overwrites (not permitted on Win32)"""
631
692
        conflicts = []
632
693
        for trans_id in self._new_contents:
633
 
            try:
634
 
                self.tree_kind(trans_id)
635
 
            except NoSuchFile:
 
694
            if self.tree_kind(trans_id) is None:
636
695
                continue
637
696
            if trans_id not in self._removed_contents:
638
697
                conflicts.append(('overwrite', trans_id,
645
704
        if (self._new_name, self._new_parent) == ({}, {}):
646
705
            return conflicts
647
706
        for children in by_parent.itervalues():
648
 
            name_ids = [(self.final_name(t), t) for t in children]
649
 
            if not self._case_sensitive_target:
650
 
                name_ids = [(n.lower(), t) for n, t in name_ids]
 
707
            name_ids = []
 
708
            for child_tid in children:
 
709
                name = self.final_name(child_tid)
 
710
                if name is not None:
 
711
                    # Keep children only if they still exist in the end
 
712
                    if not self._case_sensitive_target:
 
713
                        name = name.lower()
 
714
                    name_ids.append((name, child_tid))
651
715
            name_ids.sort()
652
716
            last_name = None
653
717
            last_trans_id = None
654
718
            for name, trans_id in name_ids:
655
 
                try:
656
 
                    kind = self.final_kind(trans_id)
657
 
                except NoSuchFile:
658
 
                    kind = None
 
719
                kind = self.final_kind(trans_id)
659
720
                file_id = self.final_file_id(trans_id)
660
721
                if kind is None and file_id is None:
661
722
                    continue
680
741
        return conflicts
681
742
 
682
743
    def _parent_type_conflicts(self, by_parent):
683
 
        """parents must have directory 'contents'."""
 
744
        """Children must have a directory parent"""
684
745
        conflicts = []
685
746
        for parent_id, children in by_parent.iteritems():
686
 
            if parent_id is ROOT_PARENT:
687
 
                continue
688
 
            if not self._any_contents(children):
689
 
                continue
690
 
            for child in children:
691
 
                try:
692
 
                    self.final_kind(child)
693
 
                except NoSuchFile:
694
 
                    continue
695
 
            try:
696
 
                kind = self.final_kind(parent_id)
697
 
            except NoSuchFile:
698
 
                kind = None
 
747
            if parent_id == ROOT_PARENT:
 
748
                continue
 
749
            no_children = True
 
750
            for child_id in children:
 
751
                if self.final_kind(child_id) is not None:
 
752
                    no_children = False
 
753
                    break
 
754
            if no_children:
 
755
                continue
 
756
            # There is at least a child, so we need an existing directory to
 
757
            # contain it.
 
758
            kind = self.final_kind(parent_id)
699
759
            if kind is None:
 
760
                # The directory will be deleted
700
761
                conflicts.append(('missing parent', parent_id))
701
762
            elif kind != "directory":
 
763
                # Meh, we need a *directory* to put something in it
702
764
                conflicts.append(('non-directory parent', parent_id))
703
765
        return conflicts
704
766
 
705
 
    def _any_contents(self, trans_ids):
706
 
        """Return true if any of the trans_ids, will have contents."""
707
 
        for trans_id in trans_ids:
708
 
            try:
709
 
                kind = self.final_kind(trans_id)
710
 
            except NoSuchFile:
711
 
                continue
712
 
            return True
713
 
        return False
714
 
 
715
767
    def _set_executability(self, path, trans_id):
716
768
        """Set the executability of versioned files """
717
 
        if supports_executable():
 
769
        if self._tree._supports_executable():
718
770
            new_executability = self._new_executability[trans_id]
719
771
            abspath = self._tree.abspath(path)
720
772
            current_mode = os.stat(abspath).st_mode
729
781
                    to_mode |= 0010 & ~umask
730
782
            else:
731
783
                to_mode = current_mode & ~0111
732
 
            os.chmod(abspath, to_mode)
 
784
            osutils.chmod_if_possible(abspath, to_mode)
733
785
 
734
786
    def _new_entry(self, name, parent_id, file_id):
735
787
        """Helper function to create a new filesystem entry."""
739
791
        return trans_id
740
792
 
741
793
    def new_file(self, name, parent_id, contents, file_id=None,
742
 
                 executable=None):
 
794
                 executable=None, sha1=None):
743
795
        """Convenience method to create files.
744
796
 
745
797
        name is the name of the file to create.
752
804
        trans_id = self._new_entry(name, parent_id, file_id)
753
805
        # TODO: rather than scheduling a set_executable call,
754
806
        # have create_file create the file with the right mode.
755
 
        self.create_file(contents, trans_id)
 
807
        self.create_file(contents, trans_id, sha1=sha1)
756
808
        if executable is not None:
757
809
            self.set_executability(executable, trans_id)
758
810
        return trans_id
781
833
        self.create_symlink(target, trans_id)
782
834
        return trans_id
783
835
 
 
836
    def new_orphan(self, trans_id, parent_id):
 
837
        """Schedule an item to be orphaned.
 
838
 
 
839
        When a directory is about to be removed, its children, if they are not
 
840
        versioned are moved out of the way: they don't have a parent anymore.
 
841
 
 
842
        :param trans_id: The trans_id of the existing item.
 
843
        :param parent_id: The parent trans_id of the item.
 
844
        """
 
845
        raise NotImplementedError(self.new_orphan)
 
846
 
 
847
    def _get_potential_orphans(self, dir_id):
 
848
        """Find the potential orphans in a directory.
 
849
 
 
850
        A directory can't be safely deleted if there are versioned files in it.
 
851
        If all the contained files are unversioned then they can be orphaned.
 
852
 
 
853
        The 'None' return value means that the directory contains at least one
 
854
        versioned file and should not be deleted.
 
855
 
 
856
        :param dir_id: The directory trans id.
 
857
 
 
858
        :return: A list of the orphan trans ids or None if at least one
 
859
             versioned file is present.
 
860
        """
 
861
        orphans = []
 
862
        # Find the potential orphans, stop if one item should be kept
 
863
        for child_tid in self.by_parent()[dir_id]:
 
864
            if child_tid in self._removed_contents:
 
865
                # The child is removed as part of the transform. Since it was
 
866
                # versioned before, it's not an orphan
 
867
                continue
 
868
            elif self.final_file_id(child_tid) is None:
 
869
                # The child is not versioned
 
870
                orphans.append(child_tid)
 
871
            else:
 
872
                # We have a versioned file here, searching for orphans is
 
873
                # meaningless.
 
874
                orphans = None
 
875
                break
 
876
        return orphans
 
877
 
784
878
    def _affected_ids(self):
785
879
        """Return the set of transform ids affected by the transform"""
786
880
        trans_ids = set(self._removed_id)
845
939
        Return a (name, parent, kind, executable) tuple
846
940
        """
847
941
        to_name = self.final_name(to_trans_id)
848
 
        try:
849
 
            to_kind = self.final_kind(to_trans_id)
850
 
        except NoSuchFile:
851
 
            to_kind = None
 
942
        to_kind = self.final_kind(to_trans_id)
852
943
        to_parent = self.final_file_id(self.final_parent(to_trans_id))
853
944
        if to_trans_id in self._new_executability:
854
945
            to_executable = self._new_executability[to_trans_id]
1101
1192
        self._deletiondir = None
1102
1193
        # A mapping of transform ids to their limbo filename
1103
1194
        self._limbo_files = {}
 
1195
        self._possibly_stale_limbo_files = set()
1104
1196
        # A mapping of transform ids to a set of the transform ids of children
1105
1197
        # that their limbo directory has
1106
1198
        self._limbo_children = {}
1119
1211
        if self._tree is None:
1120
1212
            return
1121
1213
        try:
1122
 
            entries = [(self._limbo_name(t), t, k) for t, k in
1123
 
                       self._new_contents.iteritems()]
1124
 
            entries.sort(reverse=True)
1125
 
            for path, trans_id, kind in entries:
1126
 
                delete_any(path)
 
1214
            limbo_paths = self._limbo_files.values() + list(
 
1215
                self._possibly_stale_limbo_files)
 
1216
            limbo_paths = sorted(limbo_paths, reverse=True)
 
1217
            for path in limbo_paths:
 
1218
                try:
 
1219
                    delete_any(path)
 
1220
                except OSError, e:
 
1221
                    if e.errno != errno.ENOENT:
 
1222
                        raise
 
1223
                    # XXX: warn? perhaps we just got interrupted at an
 
1224
                    # inconvenient moment, but perhaps files are disappearing
 
1225
                    # from under us?
1127
1226
            try:
1128
1227
                delete_any(self._limbodir)
1129
1228
            except OSError:
1137
1236
        finally:
1138
1237
            TreeTransformBase.finalize(self)
1139
1238
 
 
1239
    def _limbo_supports_executable(self):
 
1240
        """Check if the limbo path supports the executable bit."""
 
1241
        # FIXME: Check actual file system capabilities of limbodir
 
1242
        return osutils.supports_executable()
 
1243
 
1140
1244
    def _limbo_name(self, trans_id):
1141
1245
        """Generate the limbo name of a file"""
1142
1246
        limbo_name = self._limbo_files.get(trans_id)
1178
1282
        entries from _limbo_files, because they are now stale.
1179
1283
        """
1180
1284
        for trans_id in trans_ids:
1181
 
            old_path = self._limbo_files.pop(trans_id)
 
1285
            old_path = self._limbo_files[trans_id]
 
1286
            self._possibly_stale_limbo_files.add(old_path)
 
1287
            del self._limbo_files[trans_id]
1182
1288
            if trans_id not in self._new_contents:
1183
1289
                continue
1184
1290
            new_path = self._limbo_name(trans_id)
1185
1291
            os.rename(old_path, new_path)
 
1292
            self._possibly_stale_limbo_files.remove(old_path)
1186
1293
            for descendant in self._limbo_descendants(trans_id):
1187
1294
                desc_path = self._limbo_files[descendant]
1188
1295
                desc_path = new_path + desc_path[len(old_path):]
1195
1302
            descendants.update(self._limbo_descendants(descendant))
1196
1303
        return descendants
1197
1304
 
1198
 
    def create_file(self, contents, trans_id, mode_id=None):
 
1305
    def create_file(self, contents, trans_id, mode_id=None, sha1=None):
1199
1306
        """Schedule creation of a new file.
1200
1307
 
1201
 
        See also new_file.
1202
 
 
1203
 
        Contents is an iterator of strings, all of which will be written
1204
 
        to the target destination.
1205
 
 
1206
 
        New file takes the permissions of any existing file with that id,
1207
 
        unless mode_id is specified.
 
1308
        :seealso: new_file.
 
1309
 
 
1310
        :param contents: an iterator of strings, all of which will be written
 
1311
            to the target destination.
 
1312
        :param trans_id: TreeTransform handle
 
1313
        :param mode_id: If not None, force the mode of the target file to match
 
1314
            the mode of the object referenced by mode_id.
 
1315
            Otherwise, we will try to preserve mode bits of an existing file.
 
1316
        :param sha1: If the sha1 of this content is already known, pass it in.
 
1317
            We can use it to prevent future sha1 computations.
1208
1318
        """
1209
1319
        name = self._limbo_name(trans_id)
1210
1320
        f = open(name, 'wb')
1211
1321
        try:
1212
 
            try:
1213
 
                unique_add(self._new_contents, trans_id, 'file')
1214
 
            except:
1215
 
                # Clean up the file, it never got registered so
1216
 
                # TreeTransform.finalize() won't clean it up.
1217
 
                f.close()
1218
 
                os.unlink(name)
1219
 
                raise
1220
 
 
 
1322
            unique_add(self._new_contents, trans_id, 'file')
1221
1323
            f.writelines(contents)
1222
1324
        finally:
1223
1325
            f.close()
1224
1326
        self._set_mtime(name)
1225
1327
        self._set_mode(trans_id, mode_id, S_ISREG)
 
1328
        # It is unfortunate we have to use lstat instead of fstat, but we just
 
1329
        # used utime and chmod on the file, so we need the accurate final
 
1330
        # details.
 
1331
        if sha1 is not None:
 
1332
            self._observed_sha1s[trans_id] = (sha1, osutils.lstat(name))
1226
1333
 
1227
1334
    def _read_file_chunks(self, trans_id):
1228
1335
        cur_file = open(self._limbo_name(trans_id), 'rb')
1287
1394
    def cancel_creation(self, trans_id):
1288
1395
        """Cancel the creation of new file contents."""
1289
1396
        del self._new_contents[trans_id]
 
1397
        if trans_id in self._observed_sha1s:
 
1398
            del self._observed_sha1s[trans_id]
1290
1399
        children = self._limbo_children.get(trans_id)
1291
1400
        # if this is a limbo directory with children, move them before removing
1292
1401
        # the directory
1296
1405
            del self._limbo_children_names[trans_id]
1297
1406
        delete_any(self._limbo_name(trans_id))
1298
1407
 
 
1408
    def new_orphan(self, trans_id, parent_id):
 
1409
        conf = self._tree.get_config_stack()
 
1410
        handle_orphan = conf.get('bzr.transform.orphan_policy')
 
1411
        handle_orphan(self, trans_id, parent_id)
 
1412
 
 
1413
 
 
1414
class OrphaningError(errors.BzrError):
 
1415
 
 
1416
    # Only bugs could lead to such exception being seen by the user
 
1417
    internal_error = True
 
1418
    _fmt = "Error while orphaning %s in %s directory"
 
1419
 
 
1420
    def __init__(self, orphan, parent):
 
1421
        errors.BzrError.__init__(self)
 
1422
        self.orphan = orphan
 
1423
        self.parent = parent
 
1424
 
 
1425
 
 
1426
class OrphaningForbidden(OrphaningError):
 
1427
 
 
1428
    _fmt = "Policy: %s doesn't allow creating orphans."
 
1429
 
 
1430
    def __init__(self, policy):
 
1431
        errors.BzrError.__init__(self)
 
1432
        self.policy = policy
 
1433
 
 
1434
 
 
1435
def move_orphan(tt, orphan_id, parent_id):
 
1436
    """See TreeTransformBase.new_orphan.
 
1437
 
 
1438
    This creates a new orphan in the `bzr-orphans` dir at the root of the
 
1439
    `TreeTransform`.
 
1440
 
 
1441
    :param tt: The TreeTransform orphaning `trans_id`.
 
1442
 
 
1443
    :param orphan_id: The trans id that should be orphaned.
 
1444
 
 
1445
    :param parent_id: The orphan parent trans id.
 
1446
    """
 
1447
    # Add the orphan dir if it doesn't exist
 
1448
    orphan_dir_basename = 'bzr-orphans'
 
1449
    od_id = tt.trans_id_tree_path(orphan_dir_basename)
 
1450
    if tt.final_kind(od_id) is None:
 
1451
        tt.create_directory(od_id)
 
1452
    parent_path = tt._tree_id_paths[parent_id]
 
1453
    # Find a name that doesn't exist yet in the orphan dir
 
1454
    actual_name = tt.final_name(orphan_id)
 
1455
    new_name = tt._available_backup_name(actual_name, od_id)
 
1456
    tt.adjust_path(new_name, od_id, orphan_id)
 
1457
    trace.warning('%s has been orphaned in %s'
 
1458
                  % (joinpath(parent_path, actual_name), orphan_dir_basename))
 
1459
 
 
1460
 
 
1461
def refuse_orphan(tt, orphan_id, parent_id):
 
1462
    """See TreeTransformBase.new_orphan.
 
1463
 
 
1464
    This refuses to create orphan, letting the caller handle the conflict.
 
1465
    """
 
1466
    raise OrphaningForbidden('never')
 
1467
 
 
1468
 
 
1469
orphaning_registry = registry.Registry()
 
1470
orphaning_registry.register(
 
1471
    'conflict', refuse_orphan,
 
1472
    'Leave orphans in place and create a conflict on the directory.')
 
1473
orphaning_registry.register(
 
1474
    'move', move_orphan,
 
1475
    'Move orphans into the bzr-orphans directory.')
 
1476
orphaning_registry._set_default_key('conflict')
 
1477
 
 
1478
 
 
1479
opt_transform_orphan = _mod_config.RegistryOption(
 
1480
    'bzr.transform.orphan_policy', orphaning_registry,
 
1481
    help='Policy for orphaned files during transform operations.',
 
1482
    invalid='warning')
 
1483
 
1299
1484
 
1300
1485
class TreeTransform(DiskTreeTransform):
1301
1486
    """Represent a tree transformation.
1373
1558
        try:
1374
1559
            limbodir = urlutils.local_path_from_url(
1375
1560
                tree._transport.abspath('limbo'))
1376
 
            try:
1377
 
                os.mkdir(limbodir)
1378
 
            except OSError, e:
1379
 
                if e.errno == errno.EEXIST:
1380
 
                    raise ExistingLimbo(limbodir)
 
1561
            osutils.ensure_empty_directory_exists(
 
1562
                limbodir,
 
1563
                errors.ExistingLimbo)
1381
1564
            deletiondir = urlutils.local_path_from_url(
1382
1565
                tree._transport.abspath('pending-deletion'))
1383
 
            try:
1384
 
                os.mkdir(deletiondir)
1385
 
            except OSError, e:
1386
 
                if e.errno == errno.EEXIST:
1387
 
                    raise errors.ExistingPendingDeletion(deletiondir)
 
1566
            osutils.ensure_empty_directory_exists(
 
1567
                deletiondir,
 
1568
                errors.ExistingPendingDeletion)
1388
1569
        except:
1389
1570
            tree.unlock()
1390
1571
            raise
1419
1600
    def tree_kind(self, trans_id):
1420
1601
        """Determine the file kind in the working tree.
1421
1602
 
1422
 
        Raises NoSuchFile if the file does not exist
 
1603
        :returns: The file kind or None if the file does not exist
1423
1604
        """
1424
1605
        path = self._tree_id_paths.get(trans_id)
1425
1606
        if path is None:
1426
 
            raise NoSuchFile(None)
 
1607
            return None
1427
1608
        try:
1428
1609
            return file_kind(self._tree.abspath(path))
1429
 
        except OSError, e:
1430
 
            if e.errno != errno.ENOENT:
1431
 
                raise
1432
 
            else:
1433
 
                raise NoSuchFile(path)
 
1610
        except errors.NoSuchFile:
 
1611
            return None
1434
1612
 
1435
1613
    def _set_mode(self, trans_id, mode_id, typefunc):
1436
1614
        """Set the mode of new file contents.
1456
1634
            else:
1457
1635
                raise
1458
1636
        if typefunc(mode):
1459
 
            os.chmod(self._limbo_name(trans_id), mode)
 
1637
            osutils.chmod_if_possible(self._limbo_name(trans_id), mode)
1460
1638
 
1461
1639
    def iter_tree_children(self, parent_id):
1462
1640
        """Iterate through the entry's tree children, if any"""
1540
1718
            calculating one.
1541
1719
        :param _mover: Supply an alternate FileMover, for testing
1542
1720
        """
 
1721
        for hook in MutableTree.hooks['pre_transform']:
 
1722
            hook(self._tree, self)
1543
1723
        if not no_conflicts:
1544
1724
            self._check_malformed()
1545
 
        child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
1725
        child_pb = ui.ui_factory.nested_progress_bar()
1546
1726
        try:
1547
1727
            if precomputed_delta is None:
1548
 
                child_pb.update('Apply phase', 0, 2)
 
1728
                child_pb.update(gettext('Apply phase'), 0, 2)
1549
1729
                inventory_delta = self._generate_inventory_delta()
1550
1730
                offset = 1
1551
1731
            else:
1556
1736
            else:
1557
1737
                mover = _mover
1558
1738
            try:
1559
 
                child_pb.update('Apply phase', 0 + offset, 2 + offset)
 
1739
                child_pb.update(gettext('Apply phase'), 0 + offset, 2 + offset)
1560
1740
                self._apply_removals(mover)
1561
 
                child_pb.update('Apply phase', 1 + offset, 2 + offset)
 
1741
                child_pb.update(gettext('Apply phase'), 1 + offset, 2 + offset)
1562
1742
                modified_paths = self._apply_insertions(mover)
1563
1743
            except:
1564
1744
                mover.rollback()
1567
1747
                mover.apply_deletions()
1568
1748
        finally:
1569
1749
            child_pb.finished()
 
1750
        if self.final_file_id(self.root) is None:
 
1751
            inventory_delta = [e for e in inventory_delta if e[0] != '']
1570
1752
        self._tree.apply_inventory_delta(inventory_delta)
 
1753
        self._apply_observed_sha1s()
1571
1754
        self._done = True
1572
1755
        self.finalize()
1573
1756
        return _TransformResults(modified_paths, self.rename_count)
1575
1758
    def _generate_inventory_delta(self):
1576
1759
        """Generate an inventory delta for the current transform."""
1577
1760
        inventory_delta = []
1578
 
        child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
1761
        child_pb = ui.ui_factory.nested_progress_bar()
1579
1762
        new_paths = self._inventory_altered()
1580
1763
        total_entries = len(new_paths) + len(self._removed_id)
1581
1764
        try:
1582
1765
            for num, trans_id in enumerate(self._removed_id):
1583
1766
                if (num % 10) == 0:
1584
 
                    child_pb.update('removing file', num, total_entries)
 
1767
                    child_pb.update(gettext('removing file'), num, total_entries)
1585
1768
                if trans_id == self._new_root:
1586
1769
                    file_id = self._tree.get_root_id()
1587
1770
                else:
1599
1782
            final_kinds = {}
1600
1783
            for num, (path, trans_id) in enumerate(new_paths):
1601
1784
                if (num % 10) == 0:
1602
 
                    child_pb.update('adding file',
 
1785
                    child_pb.update(gettext('adding file'),
1603
1786
                                    num + len(self._removed_id), total_entries)
1604
1787
                file_id = new_path_file_ids[trans_id]
1605
1788
                if file_id is None:
1606
1789
                    continue
1607
1790
                needs_entry = False
1608
 
                try:
1609
 
                    kind = self.final_kind(trans_id)
1610
 
                except NoSuchFile:
 
1791
                kind = self.final_kind(trans_id)
 
1792
                if kind is None:
1611
1793
                    kind = self._tree.stored_kind(file_id)
1612
1794
                parent_trans_id = self.final_parent(trans_id)
1613
1795
                parent_file_id = new_path_file_ids.get(parent_trans_id)
1644
1826
        """
1645
1827
        tree_paths = list(self._tree_path_ids.iteritems())
1646
1828
        tree_paths.sort(reverse=True)
1647
 
        child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
1829
        child_pb = ui.ui_factory.nested_progress_bar()
1648
1830
        try:
1649
 
            for num, data in enumerate(tree_paths):
1650
 
                path, trans_id = data
1651
 
                child_pb.update('removing file', num, len(tree_paths))
 
1831
            for num, (path, trans_id) in enumerate(tree_paths):
 
1832
                # do not attempt to move root into a subdirectory of itself.
 
1833
                if path == '':
 
1834
                    continue
 
1835
                child_pb.update(gettext('removing file'), num, len(tree_paths))
1652
1836
                full_path = self._tree.abspath(path)
1653
1837
                if trans_id in self._removed_contents:
1654
1838
                    delete_path = os.path.join(self._deletiondir, trans_id)
1679
1863
        modified_paths = []
1680
1864
        new_path_file_ids = dict((t, self.final_file_id(t)) for p, t in
1681
1865
                                 new_paths)
1682
 
        child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
1866
        child_pb = ui.ui_factory.nested_progress_bar()
1683
1867
        try:
1684
1868
            for num, (path, trans_id) in enumerate(new_paths):
1685
1869
                if (num % 10) == 0:
1686
 
                    child_pb.update('adding file', num, len(new_paths))
 
1870
                    child_pb.update(gettext('adding file'), num, len(new_paths))
1687
1871
                full_path = self._tree.abspath(path)
1688
1872
                if trans_id in self._needs_rename:
1689
1873
                    try:
1694
1878
                            raise
1695
1879
                    else:
1696
1880
                        self.rename_count += 1
 
1881
                    # TODO: if trans_id in self._observed_sha1s, we should
 
1882
                    #       re-stat the final target, since ctime will be
 
1883
                    #       updated by the change.
1697
1884
                if (trans_id in self._new_contents or
1698
1885
                    self.path_changed(trans_id)):
1699
1886
                    if trans_id in self._new_contents:
1700
1887
                        modified_paths.append(full_path)
1701
1888
                if trans_id in self._new_executability:
1702
1889
                    self._set_executability(path, trans_id)
 
1890
                if trans_id in self._observed_sha1s:
 
1891
                    o_sha1, o_st_val = self._observed_sha1s[trans_id]
 
1892
                    st = osutils.lstat(full_path)
 
1893
                    self._observed_sha1s[trans_id] = (o_sha1, st)
1703
1894
        finally:
1704
1895
            child_pb.finished()
 
1896
        for path, trans_id in new_paths:
 
1897
            # new_paths includes stuff like workingtree conflicts. Only the
 
1898
            # stuff in new_contents actually comes from limbo.
 
1899
            if trans_id in self._limbo_files:
 
1900
                del self._limbo_files[trans_id]
1705
1901
        self._new_contents.clear()
1706
1902
        return modified_paths
1707
1903
 
 
1904
    def _apply_observed_sha1s(self):
 
1905
        """After we have finished renaming everything, update observed sha1s
 
1906
 
 
1907
        This has to be done after self._tree.apply_inventory_delta, otherwise
 
1908
        it doesn't know anything about the files we are updating. Also, we want
 
1909
        to do this as late as possible, so that most entries end up cached.
 
1910
        """
 
1911
        # TODO: this doesn't update the stat information for directories. So
 
1912
        #       the first 'bzr status' will still need to rewrite
 
1913
        #       .bzr/checkout/dirstate. However, we at least don't need to
 
1914
        #       re-read all of the files.
 
1915
        # TODO: If the operation took a while, we could do a time.sleep(3) here
 
1916
        #       to allow the clock to tick over and ensure we won't have any
 
1917
        #       problems. (we could observe start time, and finish time, and if
 
1918
        #       it is less than eg 10% overhead, add a sleep call.)
 
1919
        paths = FinalPaths(self)
 
1920
        for trans_id, observed in self._observed_sha1s.iteritems():
 
1921
            path = paths.get_path(trans_id)
 
1922
            # We could get the file_id, but dirstate prefers to use the path
 
1923
            # anyway, and it is 'cheaper' to determine.
 
1924
            # file_id = self._new_id[trans_id]
 
1925
            self._tree._observed_sha1(None, path, observed)
 
1926
 
1708
1927
 
1709
1928
class TransformPreview(DiskTreeTransform):
1710
1929
    """A TreeTransform for generating preview trees.
1725
1944
    def tree_kind(self, trans_id):
1726
1945
        path = self._tree_id_paths.get(trans_id)
1727
1946
        if path is None:
1728
 
            raise NoSuchFile(None)
1729
 
        file_id = self._tree.path2id(path)
1730
 
        return self._tree.kind(file_id)
 
1947
            return None
 
1948
        kind = self._tree.path_content_summary(path)[0]
 
1949
        if kind == 'missing':
 
1950
            kind = None
 
1951
        return kind
1731
1952
 
1732
1953
    def _set_mode(self, trans_id, mode_id, typefunc):
1733
1954
        """Set the mode of new file contents.
1753
1974
            childpath = joinpath(path, child)
1754
1975
            yield self.trans_id_tree_path(childpath)
1755
1976
 
1756
 
 
1757
 
class _PreviewTree(tree.Tree):
 
1977
    def new_orphan(self, trans_id, parent_id):
 
1978
        raise NotImplementedError(self.new_orphan)
 
1979
 
 
1980
 
 
1981
class _PreviewTree(tree.InventoryTree):
1758
1982
    """Partial implementation of Tree to support show_diff_trees"""
1759
1983
 
1760
1984
    def __init__(self, transform):
1789
2013
                yield self._get_repository().revision_tree(revision_id)
1790
2014
 
1791
2015
    def _get_file_revision(self, file_id, vf, tree_revision):
1792
 
        parent_keys = [(file_id, self._file_revision(t, file_id)) for t in
 
2016
        parent_keys = [(file_id, t.get_file_revision(file_id)) for t in
1793
2017
                       self._iter_parent_trees()]
1794
2018
        vf.add_lines((file_id, tree_revision), parent_keys,
1795
2019
                     self.get_file_lines(file_id))
1799
2023
            vf.fallback_versionedfiles.append(base_vf)
1800
2024
        return tree_revision
1801
2025
 
1802
 
    def _stat_limbo_file(self, file_id):
1803
 
        trans_id = self._transform.trans_id_file_id(file_id)
 
2026
    def _stat_limbo_file(self, file_id=None, trans_id=None):
 
2027
        if trans_id is None:
 
2028
            trans_id = self._transform.trans_id_file_id(file_id)
1804
2029
        name = self._transform._limbo_name(trans_id)
1805
2030
        return os.lstat(name)
1806
2031
 
1831
2056
        pass
1832
2057
 
1833
2058
    @property
 
2059
    @deprecated_method(deprecated_in((2, 5, 0)))
1834
2060
    def inventory(self):
1835
2061
        """This Tree does not use inventory as its backing data."""
1836
2062
        raise NotImplementedError(_PreviewTree.inventory)
1837
2063
 
 
2064
    @property
 
2065
    def root_inventory(self):
 
2066
        """This Tree does not use inventory as its backing data."""
 
2067
        raise NotImplementedError(_PreviewTree.root_inventory)
 
2068
 
1838
2069
    def get_root_id(self):
1839
2070
        return self._transform.final_file_id(self._transform.root)
1840
2071
 
1886
2117
        return cur_parent
1887
2118
 
1888
2119
    def path2id(self, path):
 
2120
        if isinstance(path, list):
 
2121
            if path == []:
 
2122
                path = [""]
 
2123
            path = osutils.pathjoin(*path)
1889
2124
        return self._transform.final_file_id(self._path2trans_id(path))
1890
2125
 
1891
2126
    def id2path(self, file_id):
1929
2164
            if (specific_file_ids is not None
1930
2165
                and file_id not in specific_file_ids):
1931
2166
                continue
1932
 
            try:
1933
 
                kind = self._transform.final_kind(trans_id)
1934
 
            except NoSuchFile:
 
2167
            kind = self._transform.final_kind(trans_id)
 
2168
            if kind is None:
1935
2169
                kind = self._transform._tree.stored_kind(file_id)
1936
2170
            new_entry = inventory.make_entry(
1937
2171
                kind,
2022
2256
 
2023
2257
    def get_file_size(self, file_id):
2024
2258
        """See Tree.get_file_size"""
 
2259
        trans_id = self._transform.trans_id_file_id(file_id)
 
2260
        kind = self._transform.final_kind(trans_id)
 
2261
        if kind != 'file':
 
2262
            return None
 
2263
        if trans_id in self._transform._new_contents:
 
2264
            return self._stat_limbo_file(trans_id=trans_id).st_size
2025
2265
        if self.kind(file_id) == 'file':
2026
2266
            return self._transform._tree.get_file_size(file_id)
2027
2267
        else:
2028
2268
            return None
2029
2269
 
 
2270
    def get_file_verifier(self, file_id, path=None, stat_value=None):
 
2271
        trans_id = self._transform.trans_id_file_id(file_id)
 
2272
        kind = self._transform._new_contents.get(trans_id)
 
2273
        if kind is None:
 
2274
            return self._transform._tree.get_file_verifier(file_id)
 
2275
        if kind == 'file':
 
2276
            fileobj = self.get_file(file_id)
 
2277
            try:
 
2278
                return ("SHA1", sha_file(fileobj))
 
2279
            finally:
 
2280
                fileobj.close()
 
2281
 
2030
2282
    def get_file_sha1(self, file_id, path=None, stat_value=None):
2031
2283
        trans_id = self._transform.trans_id_file_id(file_id)
2032
2284
        kind = self._transform._new_contents.get(trans_id)
2055
2307
            except errors.NoSuchId:
2056
2308
                return False
2057
2309
 
 
2310
    def has_filename(self, path):
 
2311
        trans_id = self._path2trans_id(path)
 
2312
        if trans_id in self._transform._new_contents:
 
2313
            return True
 
2314
        elif trans_id in self._transform._removed_contents:
 
2315
            return False
 
2316
        else:
 
2317
            return self._transform._tree.has_filename(path)
 
2318
 
2058
2319
    def path_content_summary(self, path):
2059
2320
        trans_id = self._path2trans_id(path)
2060
2321
        tt = self._transform
2073
2334
            if kind == 'file':
2074
2335
                statval = os.lstat(limbo_name)
2075
2336
                size = statval.st_size
2076
 
                if not supports_executable():
 
2337
                if not tt._limbo_supports_executable():
2077
2338
                    executable = False
2078
2339
                else:
2079
2340
                    executable = statval.st_mode & S_IEXEC
2148
2409
                                   self.get_file(file_id).readlines(),
2149
2410
                                   default_revision)
2150
2411
 
2151
 
    def get_symlink_target(self, file_id):
 
2412
    def get_symlink_target(self, file_id, path=None):
2152
2413
        """See Tree.get_symlink_target"""
2153
2414
        if not self._content_change(file_id):
2154
2415
            return self._transform._tree.get_symlink_target(file_id)
2169
2430
                path_from_root = self._final_paths.get_path(child_id)
2170
2431
                basename = self._transform.final_name(child_id)
2171
2432
                file_id = self._transform.final_file_id(child_id)
2172
 
                try:
2173
 
                    kind = self._transform.final_kind(child_id)
 
2433
                kind  = self._transform.final_kind(child_id)
 
2434
                if kind is not None:
2174
2435
                    versioned_kind = kind
2175
 
                except NoSuchFile:
 
2436
                else:
2176
2437
                    kind = 'unknown'
2177
2438
                    versioned_kind = self._transform._tree.stored_kind(file_id)
2178
2439
                if versioned_kind == 'directory':
2292
2553
        if num > 0:  # more than just a root
2293
2554
            raise errors.WorkingTreeAlreadyPopulated(base=wt.basedir)
2294
2555
    file_trans_id = {}
2295
 
    top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
2556
    top_pb = ui.ui_factory.nested_progress_bar()
2296
2557
    pp = ProgressPhase("Build phase", 2, top_pb)
2297
 
    if tree.inventory.root is not None:
 
2558
    if tree.get_root_id() is not None:
2298
2559
        # This is kind of a hack: we should be altering the root
2299
2560
        # as part of the regular tree shape diff logic.
2300
2561
        # The conditional test here is to avoid doing an
2311
2572
        pp.next_phase()
2312
2573
        file_trans_id[wt.get_root_id()] = \
2313
2574
            tt.trans_id_tree_file_id(wt.get_root_id())
2314
 
        pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
2575
        pb = ui.ui_factory.nested_progress_bar()
2315
2576
        try:
2316
2577
            deferred_contents = []
2317
2578
            num = 0
2318
 
            total = len(tree.inventory)
 
2579
            total = len(tree.all_file_ids())
2319
2580
            if delta_from_tree:
2320
2581
                precomputed_delta = []
2321
2582
            else:
2330
2591
                for dir, files in wt.walkdirs():
2331
2592
                    existing_files.update(f[0] for f in files)
2332
2593
            for num, (tree_path, entry) in \
2333
 
                enumerate(tree.inventory.iter_entries_by_dir()):
2334
 
                pb.update("Building tree", num - len(deferred_contents), total)
 
2594
                enumerate(tree.iter_entries_by_dir()):
 
2595
                pb.update(gettext("Building tree"), num - len(deferred_contents), total)
2335
2596
                if entry.parent_id is None:
2336
2597
                    continue
2337
2598
                reparent = False
2343
2604
                    kind = file_kind(target_path)
2344
2605
                    if kind == "directory":
2345
2606
                        try:
2346
 
                            bzrdir.BzrDir.open(target_path)
 
2607
                            controldir.ControlDir.open(target_path)
2347
2608
                        except errors.NotBranchError:
2348
2609
                            pass
2349
2610
                        else:
2364
2625
                    executable = tree.is_executable(file_id, tree_path)
2365
2626
                    if executable:
2366
2627
                        tt.set_executability(executable, trans_id)
2367
 
                    trans_data = (trans_id, tree_path)
 
2628
                    trans_data = (trans_id, tree_path, entry.text_sha1)
2368
2629
                    deferred_contents.append((file_id, trans_data))
2369
2630
                else:
2370
2631
                    file_trans_id[file_id] = new_by_entry(tt, entry, parent_id,
2386
2647
            precomputed_delta = None
2387
2648
        conflicts = cook_conflicts(raw_conflicts, tt)
2388
2649
        for conflict in conflicts:
2389
 
            warning(conflict)
 
2650
            trace.warning(unicode(conflict))
2390
2651
        try:
2391
2652
            wt.add_conflicts(conflicts)
2392
2653
        except errors.UnsupportedOperation:
2415
2676
        unchanged = dict(unchanged)
2416
2677
        new_desired_files = []
2417
2678
        count = 0
2418
 
        for file_id, (trans_id, tree_path) in desired_files:
 
2679
        for file_id, (trans_id, tree_path, text_sha1) in desired_files:
2419
2680
            accelerator_path = unchanged.get(file_id)
2420
2681
            if accelerator_path is None:
2421
 
                new_desired_files.append((file_id, (trans_id, tree_path)))
 
2682
                new_desired_files.append((file_id,
 
2683
                    (trans_id, tree_path, text_sha1)))
2422
2684
                continue
2423
 
            pb.update('Adding file contents', count + offset, total)
 
2685
            pb.update(gettext('Adding file contents'), count + offset, total)
2424
2686
            if hardlink:
2425
2687
                tt.create_hardlink(accelerator_tree.abspath(accelerator_path),
2426
2688
                                   trans_id)
2431
2693
                    contents = filtered_output_bytes(contents, filters,
2432
2694
                        ContentFilterContext(tree_path, tree))
2433
2695
                try:
2434
 
                    tt.create_file(contents, trans_id)
 
2696
                    tt.create_file(contents, trans_id, sha1=text_sha1)
2435
2697
                finally:
2436
2698
                    try:
2437
2699
                        contents.close()
2440
2702
                        pass
2441
2703
            count += 1
2442
2704
        offset += count
2443
 
    for count, ((trans_id, tree_path), contents) in enumerate(
 
2705
    for count, ((trans_id, tree_path, text_sha1), contents) in enumerate(
2444
2706
            tree.iter_files_bytes(new_desired_files)):
2445
2707
        if wt.supports_content_filtering():
2446
2708
            filters = wt._content_filter_stack(tree_path)
2447
2709
            contents = filtered_output_bytes(contents, filters,
2448
2710
                ContentFilterContext(tree_path, tree))
2449
 
        tt.create_file(contents, trans_id)
2450
 
        pb.update('Adding file contents', count + offset, total)
 
2711
        tt.create_file(contents, trans_id, sha1=text_sha1)
 
2712
        pb.update(gettext('Adding file contents'), count + offset, total)
2451
2713
 
2452
2714
 
2453
2715
def _reparent_children(tt, old_parent, new_parent):
2454
2716
    for child in tt.iter_tree_children(old_parent):
2455
2717
        tt.adjust_path(tt.final_name(child), new_parent, child)
2456
2718
 
 
2719
 
2457
2720
def _reparent_transform_children(tt, old_parent, new_parent):
2458
2721
    by_parent = tt.by_parent()
2459
2722
    for child in by_parent[old_parent]:
2460
2723
        tt.adjust_path(tt.final_name(child), new_parent, child)
2461
2724
    return by_parent[old_parent]
2462
2725
 
 
2726
 
2463
2727
def _content_match(tree, entry, file_id, kind, target_path):
2464
2728
    if entry.kind != kind:
2465
2729
        return False
2565
2829
        tt.set_executability(entry.executable, trans_id)
2566
2830
 
2567
2831
 
 
2832
@deprecated_function(deprecated_in((2, 3, 0)))
2568
2833
def get_backup_name(entry, by_parent, parent_trans_id, tt):
2569
2834
    return _get_backup_name(entry.name, by_parent, parent_trans_id, tt)
2570
2835
 
2571
2836
 
 
2837
@deprecated_function(deprecated_in((2, 3, 0)))
2572
2838
def _get_backup_name(name, by_parent, parent_trans_id, tt):
2573
2839
    """Produce a backup-style name that appears to be available"""
2574
2840
    def name_gen():
2581
2847
            return new_name
2582
2848
 
2583
2849
 
2584
 
def _entry_changes(file_id, entry, working_tree):
2585
 
    """Determine in which ways the inventory entry has changed.
2586
 
 
2587
 
    Returns booleans: has_contents, content_mod, meta_mod
2588
 
    has_contents means there are currently contents, but they differ
2589
 
    contents_mod means contents need to be modified
2590
 
    meta_mod means the metadata needs to be modified
2591
 
    """
2592
 
    cur_entry = working_tree.inventory[file_id]
2593
 
    try:
2594
 
        working_kind = working_tree.kind(file_id)
2595
 
        has_contents = True
2596
 
    except NoSuchFile:
2597
 
        has_contents = False
2598
 
        contents_mod = True
2599
 
        meta_mod = False
2600
 
    if has_contents is True:
2601
 
        if entry.kind != working_kind:
2602
 
            contents_mod, meta_mod = True, False
2603
 
        else:
2604
 
            cur_entry._read_tree_state(working_tree.id2path(file_id),
2605
 
                                       working_tree)
2606
 
            contents_mod, meta_mod = entry.detect_changes(cur_entry)
2607
 
            cur_entry._forget_tree_state()
2608
 
    return has_contents, contents_mod, meta_mod
2609
 
 
2610
 
 
2611
2850
def revert(working_tree, target_tree, filenames, backups=False,
2612
2851
           pb=None, change_reporter=None):
2613
2852
    """Revert a working tree's contents to those of a target tree."""
2623
2862
                unversioned_filter=working_tree.is_ignored)
2624
2863
            delta.report_changes(tt.iter_changes(), change_reporter)
2625
2864
        for conflict in conflicts:
2626
 
            warning(conflict)
 
2865
            trace.warning(unicode(conflict))
2627
2866
        pp.next_phase()
2628
2867
        tt.apply()
2629
2868
        working_tree.set_merge_modified(merge_modified)
2637
2876
def _prepare_revert_transform(working_tree, target_tree, tt, filenames,
2638
2877
                              backups, pp, basis_tree=None,
2639
2878
                              merge_modified=None):
2640
 
    child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
2879
    child_pb = ui.ui_factory.nested_progress_bar()
2641
2880
    try:
2642
2881
        if merge_modified is None:
2643
2882
            merge_modified = working_tree.merge_modified()
2646
2885
                                      merge_modified, basis_tree)
2647
2886
    finally:
2648
2887
        child_pb.finished()
2649
 
    child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
2888
    child_pb = ui.ui_factory.nested_progress_bar()
2650
2889
    try:
2651
2890
        raw_conflicts = resolve_conflicts(tt, child_pb,
2652
2891
            lambda t, c: conflict_pass(t, c, target_tree))
2660
2899
                 backups, merge_modified, basis_tree=None):
2661
2900
    if basis_tree is not None:
2662
2901
        basis_tree.lock_read()
2663
 
    change_list = target_tree.iter_changes(working_tree,
 
2902
    # We ask the working_tree for its changes relative to the target, rather
 
2903
    # than the target changes relative to the working tree. Because WT4 has an
 
2904
    # optimizer to compare itself to a target, but no optimizer for the
 
2905
    # reverse.
 
2906
    change_list = working_tree.iter_changes(target_tree,
2664
2907
        specific_files=specific_files, pb=pb)
2665
2908
    if target_tree.get_root_id() is None:
2666
2909
        skip_root = True
2670
2913
        deferred_files = []
2671
2914
        for id_num, (file_id, path, changed_content, versioned, parent, name,
2672
2915
                kind, executable) in enumerate(change_list):
2673
 
            if skip_root and file_id[0] is not None and parent[0] is None:
 
2916
            target_path, wt_path = path
 
2917
            target_versioned, wt_versioned = versioned
 
2918
            target_parent, wt_parent = parent
 
2919
            target_name, wt_name = name
 
2920
            target_kind, wt_kind = kind
 
2921
            target_executable, wt_executable = executable
 
2922
            if skip_root and wt_parent is None:
2674
2923
                continue
2675
2924
            trans_id = tt.trans_id_file_id(file_id)
2676
2925
            mode_id = None
2677
2926
            if changed_content:
2678
2927
                keep_content = False
2679
 
                if kind[0] == 'file' and (backups or kind[1] is None):
 
2928
                if wt_kind == 'file' and (backups or target_kind is None):
2680
2929
                    wt_sha1 = working_tree.get_file_sha1(file_id)
2681
2930
                    if merge_modified.get(file_id) != wt_sha1:
2682
2931
                        # acquire the basis tree lazily to prevent the
2685
2934
                        if basis_tree is None:
2686
2935
                            basis_tree = working_tree.basis_tree()
2687
2936
                            basis_tree.lock_read()
2688
 
                        if file_id in basis_tree:
 
2937
                        if basis_tree.has_id(file_id):
2689
2938
                            if wt_sha1 != basis_tree.get_file_sha1(file_id):
2690
2939
                                keep_content = True
2691
 
                        elif kind[1] is None and not versioned[1]:
 
2940
                        elif target_kind is None and not target_versioned:
2692
2941
                            keep_content = True
2693
 
                if kind[0] is not None:
 
2942
                if wt_kind is not None:
2694
2943
                    if not keep_content:
2695
2944
                        tt.delete_contents(trans_id)
2696
 
                    elif kind[1] is not None:
2697
 
                        parent_trans_id = tt.trans_id_file_id(parent[0])
2698
 
                        by_parent = tt.by_parent()
2699
 
                        backup_name = _get_backup_name(name[0], by_parent,
2700
 
                                                       parent_trans_id, tt)
 
2945
                    elif target_kind is not None:
 
2946
                        parent_trans_id = tt.trans_id_file_id(wt_parent)
 
2947
                        backup_name = tt._available_backup_name(
 
2948
                            wt_name, parent_trans_id)
2701
2949
                        tt.adjust_path(backup_name, parent_trans_id, trans_id)
2702
 
                        new_trans_id = tt.create_path(name[0], parent_trans_id)
2703
 
                        if versioned == (True, True):
 
2950
                        new_trans_id = tt.create_path(wt_name, parent_trans_id)
 
2951
                        if wt_versioned and target_versioned:
2704
2952
                            tt.unversion_file(trans_id)
2705
2953
                            tt.version_file(file_id, new_trans_id)
2706
2954
                        # New contents should have the same unix perms as old
2707
2955
                        # contents
2708
2956
                        mode_id = trans_id
2709
2957
                        trans_id = new_trans_id
2710
 
                if kind[1] in ('directory', 'tree-reference'):
 
2958
                if target_kind in ('directory', 'tree-reference'):
2711
2959
                    tt.create_directory(trans_id)
2712
 
                    if kind[1] == 'tree-reference':
 
2960
                    if target_kind == 'tree-reference':
2713
2961
                        revision = target_tree.get_reference_revision(file_id,
2714
 
                                                                      path[1])
 
2962
                                                                      target_path)
2715
2963
                        tt.set_tree_reference(revision, trans_id)
2716
 
                elif kind[1] == 'symlink':
 
2964
                elif target_kind == 'symlink':
2717
2965
                    tt.create_symlink(target_tree.get_symlink_target(file_id),
2718
2966
                                      trans_id)
2719
 
                elif kind[1] == 'file':
 
2967
                elif target_kind == 'file':
2720
2968
                    deferred_files.append((file_id, (trans_id, mode_id)))
2721
2969
                    if basis_tree is None:
2722
2970
                        basis_tree = working_tree.basis_tree()
2723
2971
                        basis_tree.lock_read()
2724
2972
                    new_sha1 = target_tree.get_file_sha1(file_id)
2725
 
                    if (file_id in basis_tree and new_sha1 ==
2726
 
                        basis_tree.get_file_sha1(file_id)):
 
2973
                    if (basis_tree.has_id(file_id) and
 
2974
                        new_sha1 == basis_tree.get_file_sha1(file_id)):
2727
2975
                        if file_id in merge_modified:
2728
2976
                            del merge_modified[file_id]
2729
2977
                    else:
2730
2978
                        merge_modified[file_id] = new_sha1
2731
2979
 
2732
2980
                    # preserve the execute bit when backing up
2733
 
                    if keep_content and executable[0] == executable[1]:
2734
 
                        tt.set_executability(executable[1], trans_id)
2735
 
                elif kind[1] is not None:
2736
 
                    raise AssertionError(kind[1])
2737
 
            if versioned == (False, True):
 
2981
                    if keep_content and wt_executable == target_executable:
 
2982
                        tt.set_executability(target_executable, trans_id)
 
2983
                elif target_kind is not None:
 
2984
                    raise AssertionError(target_kind)
 
2985
            if not wt_versioned and target_versioned:
2738
2986
                tt.version_file(file_id, trans_id)
2739
 
            if versioned == (True, False):
 
2987
            if wt_versioned and not target_versioned:
2740
2988
                tt.unversion_file(trans_id)
2741
 
            if (name[1] is not None and
2742
 
                (name[0] != name[1] or parent[0] != parent[1])):
2743
 
                if name[1] == '' and parent[1] is None:
 
2989
            if (target_name is not None and
 
2990
                (wt_name != target_name or wt_parent != target_parent)):
 
2991
                if target_name == '' and target_parent is None:
2744
2992
                    parent_trans = ROOT_PARENT
2745
2993
                else:
2746
 
                    parent_trans = tt.trans_id_file_id(parent[1])
2747
 
                if parent[0] is None and versioned[0]:
2748
 
                    tt.adjust_root_path(name[1], parent_trans)
 
2994
                    parent_trans = tt.trans_id_file_id(target_parent)
 
2995
                if wt_parent is None and wt_versioned:
 
2996
                    tt.adjust_root_path(target_name, parent_trans)
2749
2997
                else:
2750
 
                    tt.adjust_path(name[1], parent_trans, trans_id)
2751
 
            if executable[0] != executable[1] and kind[1] == "file":
2752
 
                tt.set_executability(executable[1], trans_id)
 
2998
                    tt.adjust_path(target_name, parent_trans, trans_id)
 
2999
            if wt_executable != target_executable and target_kind == "file":
 
3000
                tt.set_executability(target_executable, trans_id)
2753
3001
        if working_tree.supports_content_filtering():
2754
3002
            for index, ((trans_id, mode_id), bytes) in enumerate(
2755
3003
                target_tree.iter_files_bytes(deferred_files)):
2781
3029
    pb = ui.ui_factory.nested_progress_bar()
2782
3030
    try:
2783
3031
        for n in range(10):
2784
 
            pb.update('Resolution pass', n+1, 10)
 
3032
            pb.update(gettext('Resolution pass'), n+1, 10)
2785
3033
            conflicts = tt.find_conflicts()
2786
3034
            if len(conflicts) == 0:
2787
3035
                return new_conflicts
2811
3059
                existing_file, new_file = conflict[2], conflict[1]
2812
3060
            else:
2813
3061
                existing_file, new_file = conflict[1], conflict[2]
2814
 
            new_name = tt.final_name(existing_file)+'.moved'
 
3062
            new_name = tt.final_name(existing_file) + '.moved'
2815
3063
            tt.adjust_path(new_name, final_parent, existing_file)
2816
3064
            new_conflicts.add((c_type, 'Moved existing file to',
2817
3065
                               existing_file, new_file))
2826
3074
 
2827
3075
        elif c_type == 'missing parent':
2828
3076
            trans_id = conflict[1]
2829
 
            try:
2830
 
                tt.cancel_deletion(trans_id)
2831
 
                new_conflicts.add(('deleting parent', 'Not deleting',
2832
 
                                   trans_id))
2833
 
            except KeyError:
 
3077
            if trans_id in tt._removed_contents:
 
3078
                cancel_deletion = True
 
3079
                orphans = tt._get_potential_orphans(trans_id)
 
3080
                if orphans:
 
3081
                    cancel_deletion = False
 
3082
                    # All children are orphans
 
3083
                    for o in orphans:
 
3084
                        try:
 
3085
                            tt.new_orphan(o, trans_id)
 
3086
                        except OrphaningError:
 
3087
                            # Something bad happened so we cancel the directory
 
3088
                            # deletion which will leave it in place with a
 
3089
                            # conflict. The user can deal with it from there.
 
3090
                            # Note that this also catch the case where we don't
 
3091
                            # want to create orphans and leave the directory in
 
3092
                            # place.
 
3093
                            cancel_deletion = True
 
3094
                            break
 
3095
                if cancel_deletion:
 
3096
                    # Cancel the directory deletion
 
3097
                    tt.cancel_deletion(trans_id)
 
3098
                    new_conflicts.add(('deleting parent', 'Not deleting',
 
3099
                                       trans_id))
 
3100
            else:
2834
3101
                create = True
2835
3102
                try:
2836
3103
                    tt.final_name(trans_id)
2839
3106
                        file_id = tt.final_file_id(trans_id)
2840
3107
                        if file_id is None:
2841
3108
                            file_id = tt.inactive_file_id(trans_id)
2842
 
                        entry = path_tree.inventory[file_id]
 
3109
                        _, entry = path_tree.iter_entries_by_dir(
 
3110
                            [file_id]).next()
2843
3111
                        # special-case the other tree root (move its
2844
3112
                        # children to current root)
2845
3113
                        if entry.parent_id is None:
2860
3128
        elif c_type == 'unversioned parent':
2861
3129
            file_id = tt.inactive_file_id(conflict[1])
2862
3130
            # special-case the other tree root (move its children instead)
2863
 
            if path_tree and file_id in path_tree:
2864
 
                if path_tree.inventory[file_id].parent_id is None:
 
3131
            if path_tree and path_tree.has_id(file_id):
 
3132
                if path_tree.path2id('') == file_id:
 
3133
                    # This is the root entry, skip it
2865
3134
                    continue
2866
3135
            tt.version_file(file_id, conflict[1])
2867
3136
            new_conflicts.add((c_type, 'Versioned directory', conflict[1]))
2883
3152
 
2884
3153
def cook_conflicts(raw_conflicts, tt):
2885
3154
    """Generate a list of cooked conflicts, sorted by file path"""
2886
 
    from bzrlib.conflicts import Conflict
2887
3155
    conflict_iter = iter_cook_conflicts(raw_conflicts, tt)
2888
 
    return sorted(conflict_iter, key=Conflict.sort_key)
 
3156
    return sorted(conflict_iter, key=conflicts.Conflict.sort_key)
2889
3157
 
2890
3158
 
2891
3159
def iter_cook_conflicts(raw_conflicts, tt):
2892
 
    from bzrlib.conflicts import Conflict
2893
3160
    fp = FinalPaths(tt)
2894
3161
    for conflict in raw_conflicts:
2895
3162
        c_type = conflict[0]
2897
3164
        modified_path = fp.get_path(conflict[2])
2898
3165
        modified_id = tt.final_file_id(conflict[2])
2899
3166
        if len(conflict) == 3:
2900
 
            yield Conflict.factory(c_type, action=action, path=modified_path,
2901
 
                                     file_id=modified_id)
 
3167
            yield conflicts.Conflict.factory(
 
3168
                c_type, action=action, path=modified_path, file_id=modified_id)
2902
3169
 
2903
3170
        else:
2904
3171
            conflicting_path = fp.get_path(conflict[3])
2905
3172
            conflicting_id = tt.final_file_id(conflict[3])
2906
 
            yield Conflict.factory(c_type, action=action, path=modified_path,
2907
 
                                   file_id=modified_id,
2908
 
                                   conflict_path=conflicting_path,
2909
 
                                   conflict_file_id=conflicting_id)
 
3173
            yield conflicts.Conflict.factory(
 
3174
                c_type, action=action, path=modified_path,
 
3175
                file_id=modified_id,
 
3176
                conflict_path=conflicting_path,
 
3177
                conflict_file_id=conflicting_id)
2910
3178
 
2911
3179
 
2912
3180
class _FileMover(object):
2944
3212
            try:
2945
3213
                os.rename(to, from_)
2946
3214
            except OSError, e:
2947
 
                raise errors.TransformRenameFailed(to, from_, str(e), e.errno)                
 
3215
                raise errors.TransformRenameFailed(to, from_, str(e), e.errno)
2948
3216
        # after rollback, don't reuse _FileMover
2949
3217
        past_renames = None
2950
3218
        pending_deletions = None