~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/transform.py

  • Committer: John Arbash Meinel
  • Date: 2010-02-16 16:08:40 UTC
  • mfrom: (4797.2.15 2.1)
  • mto: (4797.2.16 2.1)
  • mto: This revision was merged to the branch mainline in revision 5037.
  • Revision ID: john@arbash-meinel.com-20100216160840-xwbpuu0v89gq8lej
Tags: bzr-2.1.0
bring in the latest 2.1 changes

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2006-2011 Canonical Ltd
 
1
# Copyright (C) 2006-2010 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
19
19
from stat import S_ISREG, S_IEXEC
20
20
import time
21
21
 
22
 
from bzrlib import (
23
 
    errors,
24
 
    lazy_import,
25
 
    registry,
26
 
    trace,
27
 
    tree,
28
 
    )
29
 
lazy_import.lazy_import(globals(), """
 
22
from bzrlib.lazy_import import lazy_import
 
23
lazy_import(globals(), """
30
24
from bzrlib import (
31
25
    annotate,
32
26
    bencode,
33
27
    bzrdir,
34
 
    commit,
35
 
    conflicts,
36
28
    delta,
37
29
    errors,
38
30
    inventory,
39
31
    multiparent,
40
32
    osutils,
41
33
    revision as _mod_revision,
42
 
    ui,
43
 
    urlutils,
44
34
    )
45
35
""")
46
36
from bzrlib.errors import (DuplicateKey, MalformedTransform, NoSuchFile,
47
 
                           ReusingTransform, CantMoveRoot,
 
37
                           ReusingTransform, NotVersionedError, CantMoveRoot,
48
38
                           ExistingLimbo, ImmortalLimbo, NoFinalPath,
49
39
                           UnableCreateSymlink)
50
40
from bzrlib.filters import filtered_output_bytes, ContentFilterContext
 
41
from bzrlib.inventory import InventoryEntry
51
42
from bzrlib.osutils import (
52
43
    delete_any,
53
44
    file_kind,
54
45
    has_symlinks,
 
46
    lexists,
55
47
    pathjoin,
56
48
    sha_file,
57
49
    splitpath,
58
50
    supports_executable,
59
 
    )
60
 
from bzrlib.progress import ProgressPhase
 
51
)
 
52
from bzrlib.progress import DummyProgress, ProgressPhase
61
53
from bzrlib.symbol_versioning import (
62
 
    deprecated_function,
63
 
    deprecated_in,
64
 
    deprecated_method,
65
 
    )
 
54
        deprecated_function,
 
55
        deprecated_in,
 
56
        )
 
57
from bzrlib.trace import mutter, warning
 
58
from bzrlib import tree
 
59
import bzrlib.ui
 
60
import bzrlib.urlutils as urlutils
66
61
 
67
62
 
68
63
ROOT_PARENT = "root-parent"
69
64
 
 
65
 
70
66
def unique_add(map, key, value):
71
67
    if key in map:
72
68
        raise DuplicateKey(key=key)
73
69
    map[key] = value
74
70
 
75
71
 
76
 
 
77
72
class _TransformResults(object):
78
73
    def __init__(self, modified_paths, rename_count):
79
74
        object.__init__(self)
84
79
class TreeTransformBase(object):
85
80
    """The base class for TreeTransform and its kin."""
86
81
 
87
 
    def __init__(self, tree, pb=None,
 
82
    def __init__(self, tree, pb=DummyProgress(),
88
83
                 case_sensitive=True):
89
84
        """Constructor.
90
85
 
91
86
        :param tree: The tree that will be transformed, but not necessarily
92
87
            the output tree.
93
 
        :param pb: ignored
 
88
        :param pb: A ProgressTask indicating how much progress is being made
94
89
        :param case_sensitive: If True, the target of the transform is
95
90
            case sensitive, not just case preserving.
96
91
        """
103
98
        self._new_parent = {}
104
99
        # mapping of trans_id with new contents -> new file_kind
105
100
        self._new_contents = {}
106
 
        # mapping of trans_id => (sha1 of content, stat_value)
107
 
        self._observed_sha1s = {}
108
101
        # Set of trans_ids whose contents will be removed
109
102
        self._removed_contents = set()
110
103
        # Mapping of trans_id -> new execute-bit value
129
122
            self._new_root = self.trans_id_tree_file_id(root_id)
130
123
        else:
131
124
            self._new_root = None
132
 
        # Indicator of whether the transform has been applied
 
125
        # Indictor of whether the transform has been applied
133
126
        self._done = False
134
127
        # A progress bar
135
128
        self._pb = pb
138
131
        # A counter of how many files have been renamed
139
132
        self.rename_count = 0
140
133
 
141
 
    def __enter__(self):
142
 
        """Support Context Manager API."""
143
 
        return self
144
 
 
145
 
    def __exit__(self, exc_type, exc_val, exc_tb):
146
 
        """Support Context Manager API."""
147
 
        self.finalize()
148
 
 
149
134
    def finalize(self):
150
135
        """Release the working tree lock, if held.
151
136
 
226
211
        This means that the old root trans-id becomes obsolete, so it is
227
212
        recommended only to invoke this after the root trans-id has become
228
213
        irrelevant.
229
 
 
230
214
        """
231
215
        new_roots = [k for k, v in self._new_parent.iteritems() if v is
232
216
                     ROOT_PARENT]
238
222
            self._new_root = new_roots[0]
239
223
            return
240
224
        old_new_root = new_roots[0]
 
225
        # TODO: What to do if a old_new_root is present, but self._new_root is
 
226
        #       not listed as being removed? This code explicitly unversions
 
227
        #       the old root and versions it with the new file_id. Though that
 
228
        #       seems like an incomplete delta
 
229
 
241
230
        # unversion the new root's directory.
242
 
        if self.final_kind(self._new_root) is None:
243
 
            file_id = self.final_file_id(old_new_root)
244
 
        else:
245
 
            file_id = self.final_file_id(self._new_root)
 
231
        file_id = self.final_file_id(old_new_root)
246
232
        if old_new_root in self._new_id:
247
233
            self.cancel_versioning(old_new_root)
248
234
        else:
252
238
        if (self.tree_file_id(self._new_root) is not None and
253
239
            self._new_root not in self._removed_id):
254
240
            self.unversion_file(self._new_root)
255
 
        if file_id is not None:
256
 
            self.version_file(file_id, self._new_root)
 
241
        self.version_file(file_id, self._new_root)
257
242
 
258
243
        # Now move children of new root into old root directory.
259
244
        # Ensure all children are registered with the transaction, but don't
328
313
 
329
314
    def delete_contents(self, trans_id):
330
315
        """Schedule the contents of a path entry for deletion"""
331
 
        kind = self.tree_kind(trans_id)
332
 
        if kind is not None:
333
 
            self._removed_contents.add(trans_id)
 
316
        # Ensure that the object exists in the WorkingTree, this will raise an
 
317
        # exception if there is a problem
 
318
        self.tree_kind(trans_id)
 
319
        self._removed_contents.add(trans_id)
334
320
 
335
321
    def cancel_deletion(self, trans_id):
336
322
        """Cancel a scheduled deletion"""
393
379
        return sorted(FinalPaths(self).get_paths(new_ids))
394
380
 
395
381
    def _inventory_altered(self):
396
 
        """Determine which trans_ids need new Inventory entries.
397
 
 
398
 
        An new entry is needed when anything that would be reflected by an
399
 
        inventory entry changes, including file name, file_id, parent file_id,
400
 
        file kind, and the execute bit.
401
 
 
402
 
        Some care is taken to return entries with real changes, not cases
403
 
        where the value is deleted and then restored to its original value,
404
 
        but some actually unchanged values may be returned.
405
 
 
406
 
        :returns: A list of (path, trans_id) for all items requiring an
407
 
            inventory change. Ordered by path.
408
 
        """
409
 
        changed_ids = set()
410
 
        # Find entries whose file_ids are new (or changed).
411
 
        new_file_id = set(t for t in self._new_id
412
 
                          if self._new_id[t] != self.tree_file_id(t))
413
 
        for id_set in [self._new_name, self._new_parent, new_file_id,
 
382
        """Get the trans_ids and paths of files needing new inv entries."""
 
383
        new_ids = set()
 
384
        for id_set in [self._new_name, self._new_parent, self._new_id,
414
385
                       self._new_executability]:
415
 
            changed_ids.update(id_set)
416
 
        # removing implies a kind change
 
386
            new_ids.update(id_set)
417
387
        changed_kind = set(self._removed_contents)
418
 
        # so does adding
419
388
        changed_kind.intersection_update(self._new_contents)
420
 
        # Ignore entries that are already known to have changed.
421
 
        changed_kind.difference_update(changed_ids)
422
 
        #  to keep only the truly changed ones
423
 
        changed_kind = (t for t in changed_kind
424
 
                        if self.tree_kind(t) != self.final_kind(t))
425
 
        # all kind changes will alter the inventory
426
 
        changed_ids.update(changed_kind)
427
 
        # To find entries with changed parent_ids, find parents which existed,
428
 
        # but changed file_id.
429
 
        changed_file_id = set(t for t in new_file_id if t in self._removed_id)
430
 
        # Now add all their children to the set.
431
 
        for parent_trans_id in new_file_id:
432
 
            changed_ids.update(self.iter_tree_children(parent_trans_id))
433
 
        return sorted(FinalPaths(self).get_paths(changed_ids))
 
389
        changed_kind.difference_update(new_ids)
 
390
        changed_kind = (t for t in changed_kind if self.tree_kind(t) !=
 
391
                        self.final_kind(t))
 
392
        new_ids.update(changed_kind)
 
393
        return sorted(FinalPaths(self).get_paths(new_ids))
434
394
 
435
395
    def final_kind(self, trans_id):
436
396
        """Determine the final file kind, after any changes applied.
437
397
 
438
 
        :return: None if the file does not exist/has no contents.  (It is
439
 
            conceivable that a path would be created without the corresponding
440
 
            contents insertion command)
 
398
        Raises NoSuchFile if the file does not exist/has no contents.
 
399
        (It is conceivable that a path would be created without the
 
400
        corresponding contents insertion command)
441
401
        """
442
402
        if trans_id in self._new_contents:
443
403
            return self._new_contents[trans_id]
444
404
        elif trans_id in self._removed_contents:
445
 
            return None
 
405
            raise NoSuchFile(None)
446
406
        else:
447
407
            return self.tree_kind(trans_id)
448
408
 
561
521
        for trans_id in self._removed_id:
562
522
            file_id = self.tree_file_id(trans_id)
563
523
            if file_id is not None:
564
 
                # XXX: This seems like something that should go via a different
565
 
                #      indirection.
566
524
                if self._tree.inventory[file_id].kind == 'directory':
567
525
                    parents.append(trans_id)
568
526
            elif self.tree_kind(trans_id) == 'directory':
572
530
            # ensure that all children are registered with the transaction
573
531
            list(self.iter_tree_children(parent_id))
574
532
 
575
 
    @deprecated_method(deprecated_in((2, 3, 0)))
576
533
    def has_named_child(self, by_parent, parent_id, name):
577
 
        return self._has_named_child(
578
 
            name, parent_id, known_children=by_parent.get(parent_id, []))
579
 
 
580
 
    def _has_named_child(self, name, parent_id, known_children):
581
 
        """Does a parent already have a name child.
582
 
 
583
 
        :param name: The searched for name.
584
 
 
585
 
        :param parent_id: The parent for which the check is made.
586
 
 
587
 
        :param known_children: The already known children. This should have
588
 
            been recently obtained from `self.by_parent.get(parent_id)`
589
 
            (or will be if None is passed).
590
 
        """
591
 
        if known_children is None:
592
 
            known_children = self.by_parent().get(parent_id, [])
593
 
        for child in known_children:
 
534
        try:
 
535
            children = by_parent[parent_id]
 
536
        except KeyError:
 
537
            children = []
 
538
        for child in children:
594
539
            if self.final_name(child) == name:
595
540
                return True
596
 
        parent_path = self._tree_id_paths.get(parent_id, None)
597
 
        if parent_path is None:
598
 
            # No parent... no children
 
541
        try:
 
542
            path = self._tree_id_paths[parent_id]
 
543
        except KeyError:
599
544
            return False
600
 
        child_path = joinpath(parent_path, name)
601
 
        child_id = self._tree_path_ids.get(child_path, None)
 
545
        childpath = joinpath(path, name)
 
546
        child_id = self._tree_path_ids.get(childpath)
602
547
        if child_id is None:
603
 
            # Not known by the tree transform yet, check the filesystem
604
 
            return osutils.lexists(self._tree.abspath(child_path))
 
548
            return lexists(self._tree.abspath(childpath))
605
549
        else:
606
 
            raise AssertionError('child_id is missing: %s, %s, %s'
607
 
                                 % (name, parent_id, child_id))
608
 
 
609
 
    def _available_backup_name(self, name, target_id):
610
 
        """Find an available backup name.
611
 
 
612
 
        :param name: The basename of the file.
613
 
 
614
 
        :param target_id: The directory trans_id where the backup should 
615
 
            be placed.
616
 
        """
617
 
        known_children = self.by_parent().get(target_id, [])
618
 
        return osutils.available_backup_name(
619
 
            name,
620
 
            lambda base: self._has_named_child(
621
 
                base, target_id, known_children))
 
550
            if self.final_parent(child_id) != parent_id:
 
551
                return False
 
552
            if child_id in self._removed_contents:
 
553
                # XXX What about dangling file-ids?
 
554
                return False
 
555
            else:
 
556
                return True
622
557
 
623
558
    def _parent_loops(self):
624
559
        """No entry should be its own ancestor"""
659
594
        """
660
595
        conflicts = []
661
596
        for trans_id in self._new_id.iterkeys():
662
 
            kind = self.final_kind(trans_id)
663
 
            if kind is None:
 
597
            try:
 
598
                kind = self.final_kind(trans_id)
 
599
            except NoSuchFile:
664
600
                conflicts.append(('versioning no contents', trans_id))
665
601
                continue
666
 
            if not inventory.InventoryEntry.versionable_kind(kind):
 
602
            if not InventoryEntry.versionable_kind(kind):
667
603
                conflicts.append(('versioning bad kind', trans_id, kind))
668
604
        return conflicts
669
605
 
680
616
            if self.final_file_id(trans_id) is None:
681
617
                conflicts.append(('unversioned executability', trans_id))
682
618
            else:
683
 
                if self.final_kind(trans_id) != "file":
 
619
                try:
 
620
                    non_file = self.final_kind(trans_id) != "file"
 
621
                except NoSuchFile:
 
622
                    non_file = True
 
623
                if non_file is True:
684
624
                    conflicts.append(('non-file executability', trans_id))
685
625
        return conflicts
686
626
 
688
628
        """Check for overwrites (not permitted on Win32)"""
689
629
        conflicts = []
690
630
        for trans_id in self._new_contents:
691
 
            if self.tree_kind(trans_id) is None:
 
631
            try:
 
632
                self.tree_kind(trans_id)
 
633
            except NoSuchFile:
692
634
                continue
693
635
            if trans_id not in self._removed_contents:
694
636
                conflicts.append(('overwrite', trans_id,
701
643
        if (self._new_name, self._new_parent) == ({}, {}):
702
644
            return conflicts
703
645
        for children in by_parent.itervalues():
704
 
            name_ids = []
705
 
            for child_tid in children:
706
 
                name = self.final_name(child_tid)
707
 
                if name is not None:
708
 
                    # Keep children only if they still exist in the end
709
 
                    if not self._case_sensitive_target:
710
 
                        name = name.lower()
711
 
                    name_ids.append((name, child_tid))
 
646
            name_ids = [(self.final_name(t), t) for t in children]
 
647
            if not self._case_sensitive_target:
 
648
                name_ids = [(n.lower(), t) for n, t in name_ids]
712
649
            name_ids.sort()
713
650
            last_name = None
714
651
            last_trans_id = None
715
652
            for name, trans_id in name_ids:
716
 
                kind = self.final_kind(trans_id)
 
653
                try:
 
654
                    kind = self.final_kind(trans_id)
 
655
                except NoSuchFile:
 
656
                    kind = None
717
657
                file_id = self.final_file_id(trans_id)
718
658
                if kind is None and file_id is None:
719
659
                    continue
738
678
        return conflicts
739
679
 
740
680
    def _parent_type_conflicts(self, by_parent):
741
 
        """Children must have a directory parent"""
 
681
        """parents must have directory 'contents'."""
742
682
        conflicts = []
743
683
        for parent_id, children in by_parent.iteritems():
744
684
            if parent_id is ROOT_PARENT:
745
685
                continue
746
 
            no_children = True
747
 
            for child_id in children:
748
 
                if self.final_kind(child_id) is not None:
749
 
                    no_children = False
750
 
                    break
751
 
            if no_children:
 
686
            if not self._any_contents(children):
752
687
                continue
753
 
            # There is at least a child, so we need an existing directory to
754
 
            # contain it.
755
 
            kind = self.final_kind(parent_id)
 
688
            for child in children:
 
689
                try:
 
690
                    self.final_kind(child)
 
691
                except NoSuchFile:
 
692
                    continue
 
693
            try:
 
694
                kind = self.final_kind(parent_id)
 
695
            except NoSuchFile:
 
696
                kind = None
756
697
            if kind is None:
757
 
                # The directory will be deleted
758
698
                conflicts.append(('missing parent', parent_id))
759
699
            elif kind != "directory":
760
 
                # Meh, we need a *directory* to put something in it
761
700
                conflicts.append(('non-directory parent', parent_id))
762
701
        return conflicts
763
702
 
 
703
    def _any_contents(self, trans_ids):
 
704
        """Return true if any of the trans_ids, will have contents."""
 
705
        for trans_id in trans_ids:
 
706
            try:
 
707
                kind = self.final_kind(trans_id)
 
708
            except NoSuchFile:
 
709
                continue
 
710
            return True
 
711
        return False
 
712
 
764
713
    def _set_executability(self, path, trans_id):
765
714
        """Set the executability of versioned files """
766
715
        if supports_executable():
788
737
        return trans_id
789
738
 
790
739
    def new_file(self, name, parent_id, contents, file_id=None,
791
 
                 executable=None, sha1=None):
 
740
                 executable=None):
792
741
        """Convenience method to create files.
793
742
 
794
743
        name is the name of the file to create.
801
750
        trans_id = self._new_entry(name, parent_id, file_id)
802
751
        # TODO: rather than scheduling a set_executable call,
803
752
        # have create_file create the file with the right mode.
804
 
        self.create_file(contents, trans_id, sha1=sha1)
 
753
        self.create_file(contents, trans_id)
805
754
        if executable is not None:
806
755
            self.set_executability(executable, trans_id)
807
756
        return trans_id
830
779
        self.create_symlink(target, trans_id)
831
780
        return trans_id
832
781
 
833
 
    def new_orphan(self, trans_id, parent_id):
834
 
        """Schedule an item to be orphaned.
835
 
 
836
 
        When a directory is about to be removed, its children, if they are not
837
 
        versioned are moved out of the way: they don't have a parent anymore.
838
 
 
839
 
        :param trans_id: The trans_id of the existing item.
840
 
        :param parent_id: The parent trans_id of the item.
841
 
        """
842
 
        raise NotImplementedError(self.new_orphan)
843
 
 
844
 
    def _get_potential_orphans(self, dir_id):
845
 
        """Find the potential orphans in a directory.
846
 
 
847
 
        A directory can't be safely deleted if there are versioned files in it.
848
 
        If all the contained files are unversioned then they can be orphaned.
849
 
 
850
 
        The 'None' return value means that the directory contains at least one
851
 
        versioned file and should not be deleted.
852
 
 
853
 
        :param dir_id: The directory trans id.
854
 
 
855
 
        :return: A list of the orphan trans ids or None if at least one
856
 
             versioned file is present.
857
 
        """
858
 
        orphans = []
859
 
        # Find the potential orphans, stop if one item should be kept
860
 
        for child_tid in self.by_parent()[dir_id]:
861
 
            if child_tid in self._removed_contents:
862
 
                # The child is removed as part of the transform. Since it was
863
 
                # versioned before, it's not an orphan
864
 
                continue
865
 
            elif self.final_file_id(child_tid) is None:
866
 
                # The child is not versioned
867
 
                orphans.append(child_tid)
868
 
            else:
869
 
                # We have a versioned file here, searching for orphans is
870
 
                # meaningless.
871
 
                orphans = None
872
 
                break
873
 
        return orphans
874
 
 
875
782
    def _affected_ids(self):
876
783
        """Return the set of transform ids affected by the transform"""
877
784
        trans_ids = set(self._removed_id)
936
843
        Return a (name, parent, kind, executable) tuple
937
844
        """
938
845
        to_name = self.final_name(to_trans_id)
939
 
        to_kind = self.final_kind(to_trans_id)
 
846
        try:
 
847
            to_kind = self.final_kind(to_trans_id)
 
848
        except NoSuchFile:
 
849
            to_kind = None
940
850
        to_parent = self.final_file_id(self.final_parent(to_trans_id))
941
851
        if to_trans_id in self._new_executability:
942
852
            to_executable = self._new_executability[to_trans_id]
1016
926
        """
1017
927
        return _PreviewTree(self)
1018
928
 
1019
 
    def commit(self, branch, message, merge_parents=None, strict=False,
1020
 
               timestamp=None, timezone=None, committer=None, authors=None,
1021
 
               revprops=None, revision_id=None):
 
929
    def commit(self, branch, message, merge_parents=None, strict=False):
1022
930
        """Commit the result of this TreeTransform to a branch.
1023
931
 
1024
932
        :param branch: The branch to commit to.
1025
933
        :param message: The message to attach to the commit.
1026
 
        :param merge_parents: Additional parent revision-ids specified by
1027
 
            pending merges.
1028
 
        :param strict: If True, abort the commit if there are unversioned
1029
 
            files.
1030
 
        :param timestamp: if not None, seconds-since-epoch for the time and
1031
 
            date.  (May be a float.)
1032
 
        :param timezone: Optional timezone for timestamp, as an offset in
1033
 
            seconds.
1034
 
        :param committer: Optional committer in email-id format.
1035
 
            (e.g. "J Random Hacker <jrandom@example.com>")
1036
 
        :param authors: Optional list of authors in email-id format.
1037
 
        :param revprops: Optional dictionary of revision properties.
1038
 
        :param revision_id: Optional revision id.  (Specifying a revision-id
1039
 
            may reduce performance for some non-native formats.)
 
934
        :param merge_parents: Additional parents specified by pending merges.
1040
935
        :return: The revision_id of the revision committed.
1041
936
        """
1042
937
        self._check_malformed()
1059
954
        if self._tree.get_revision_id() != last_rev_id:
1060
955
            raise ValueError('TreeTransform not based on branch basis: %s' %
1061
956
                             self._tree.get_revision_id())
1062
 
        revprops = commit.Commit.update_revprops(revprops, branch, authors)
1063
 
        builder = branch.get_commit_builder(parent_ids,
1064
 
                                            timestamp=timestamp,
1065
 
                                            timezone=timezone,
1066
 
                                            committer=committer,
1067
 
                                            revprops=revprops,
1068
 
                                            revision_id=revision_id)
 
957
        builder = branch.get_commit_builder(parent_ids)
1069
958
        preview = self.get_preview_tree()
1070
959
        list(builder.record_iter_changes(preview, last_rev_id,
1071
960
                                         self.iter_changes()))
1173
1062
class DiskTreeTransform(TreeTransformBase):
1174
1063
    """Tree transform storing its contents on disk."""
1175
1064
 
1176
 
    def __init__(self, tree, limbodir, pb=None,
 
1065
    def __init__(self, tree, limbodir, pb=DummyProgress(),
1177
1066
                 case_sensitive=True):
1178
1067
        """Constructor.
1179
1068
        :param tree: The tree that will be transformed, but not necessarily
1180
1069
            the output tree.
1181
1070
        :param limbodir: A directory where new files can be stored until
1182
1071
            they are installed in their proper places
1183
 
        :param pb: ignored
 
1072
        :param pb: A ProgressBar indicating how much progress is being made
1184
1073
        :param case_sensitive: If True, the target of the transform is
1185
1074
            case sensitive, not just case preserving.
1186
1075
        """
1189
1078
        self._deletiondir = None
1190
1079
        # A mapping of transform ids to their limbo filename
1191
1080
        self._limbo_files = {}
1192
 
        self._possibly_stale_limbo_files = set()
1193
1081
        # A mapping of transform ids to a set of the transform ids of children
1194
1082
        # that their limbo directory has
1195
1083
        self._limbo_children = {}
1208
1096
        if self._tree is None:
1209
1097
            return
1210
1098
        try:
1211
 
            limbo_paths = self._limbo_files.values() + list(
1212
 
                self._possibly_stale_limbo_files)
1213
 
            limbo_paths = sorted(limbo_paths, reverse=True)
1214
 
            for path in limbo_paths:
1215
 
                try:
1216
 
                    delete_any(path)
1217
 
                except OSError, e:
1218
 
                    if e.errno != errno.ENOENT:
1219
 
                        raise
1220
 
                    # XXX: warn? perhaps we just got interrupted at an
1221
 
                    # inconvenient moment, but perhaps files are disappearing
1222
 
                    # from under us?
 
1099
            entries = [(self._limbo_name(t), t, k) for t, k in
 
1100
                       self._new_contents.iteritems()]
 
1101
            entries.sort(reverse=True)
 
1102
            for path, trans_id, kind in entries:
 
1103
                delete_any(path)
1223
1104
            try:
1224
1105
                delete_any(self._limbodir)
1225
1106
            except OSError:
1274
1155
        entries from _limbo_files, because they are now stale.
1275
1156
        """
1276
1157
        for trans_id in trans_ids:
1277
 
            old_path = self._limbo_files[trans_id]
1278
 
            self._possibly_stale_limbo_files.add(old_path)
1279
 
            del self._limbo_files[trans_id]
 
1158
            old_path = self._limbo_files.pop(trans_id)
1280
1159
            if trans_id not in self._new_contents:
1281
1160
                continue
1282
1161
            new_path = self._limbo_name(trans_id)
1283
1162
            os.rename(old_path, new_path)
1284
 
            self._possibly_stale_limbo_files.remove(old_path)
1285
1163
            for descendant in self._limbo_descendants(trans_id):
1286
1164
                desc_path = self._limbo_files[descendant]
1287
1165
                desc_path = new_path + desc_path[len(old_path):]
1294
1172
            descendants.update(self._limbo_descendants(descendant))
1295
1173
        return descendants
1296
1174
 
1297
 
    def create_file(self, contents, trans_id, mode_id=None, sha1=None):
 
1175
    def create_file(self, contents, trans_id, mode_id=None):
1298
1176
        """Schedule creation of a new file.
1299
1177
 
1300
 
        :seealso: new_file.
1301
 
 
1302
 
        :param contents: an iterator of strings, all of which will be written
1303
 
            to the target destination.
1304
 
        :param trans_id: TreeTransform handle
1305
 
        :param mode_id: If not None, force the mode of the target file to match
1306
 
            the mode of the object referenced by mode_id.
1307
 
            Otherwise, we will try to preserve mode bits of an existing file.
1308
 
        :param sha1: If the sha1 of this content is already known, pass it in.
1309
 
            We can use it to prevent future sha1 computations.
 
1178
        See also new_file.
 
1179
 
 
1180
        Contents is an iterator of strings, all of which will be written
 
1181
        to the target destination.
 
1182
 
 
1183
        New file takes the permissions of any existing file with that id,
 
1184
        unless mode_id is specified.
1310
1185
        """
1311
1186
        name = self._limbo_name(trans_id)
1312
1187
        f = open(name, 'wb')
1313
1188
        try:
1314
 
            unique_add(self._new_contents, trans_id, 'file')
 
1189
            try:
 
1190
                unique_add(self._new_contents, trans_id, 'file')
 
1191
            except:
 
1192
                # Clean up the file, it never got registered so
 
1193
                # TreeTransform.finalize() won't clean it up.
 
1194
                f.close()
 
1195
                os.unlink(name)
 
1196
                raise
 
1197
 
1315
1198
            f.writelines(contents)
1316
1199
        finally:
1317
1200
            f.close()
1318
1201
        self._set_mtime(name)
1319
1202
        self._set_mode(trans_id, mode_id, S_ISREG)
1320
 
        # It is unfortunate we have to use lstat instead of fstat, but we just
1321
 
        # used utime and chmod on the file, so we need the accurate final
1322
 
        # details.
1323
 
        if sha1 is not None:
1324
 
            self._observed_sha1s[trans_id] = (sha1, osutils.lstat(name))
1325
1203
 
1326
1204
    def _read_file_chunks(self, trans_id):
1327
1205
        cur_file = open(self._limbo_name(trans_id), 'rb')
1386
1264
    def cancel_creation(self, trans_id):
1387
1265
        """Cancel the creation of new file contents."""
1388
1266
        del self._new_contents[trans_id]
1389
 
        if trans_id in self._observed_sha1s:
1390
 
            del self._observed_sha1s[trans_id]
1391
1267
        children = self._limbo_children.get(trans_id)
1392
1268
        # if this is a limbo directory with children, move them before removing
1393
1269
        # the directory
1397
1273
            del self._limbo_children_names[trans_id]
1398
1274
        delete_any(self._limbo_name(trans_id))
1399
1275
 
1400
 
    def new_orphan(self, trans_id, parent_id):
1401
 
        # FIXME: There is no tree config, so we use the branch one (it's weird
1402
 
        # to define it this way as orphaning can only occur in a working tree,
1403
 
        # but that's all we have (for now). It will find the option in
1404
 
        # locations.conf or bazaar.conf though) -- vila 20100916
1405
 
        conf = self._tree.branch.get_config()
1406
 
        conf_var_name = 'bzr.transform.orphan_policy'
1407
 
        orphan_policy = conf.get_user_option(conf_var_name)
1408
 
        default_policy = orphaning_registry.default_key
1409
 
        if orphan_policy is None:
1410
 
            orphan_policy = default_policy
1411
 
        if orphan_policy not in orphaning_registry:
1412
 
            trace.warning('%s (from %s) is not a known policy, defaulting '
1413
 
                'to %s' % (orphan_policy, conf_var_name, default_policy))
1414
 
            orphan_policy = default_policy
1415
 
        handle_orphan = orphaning_registry.get(orphan_policy)
1416
 
        handle_orphan(self, trans_id, parent_id)
1417
 
 
1418
 
 
1419
 
class OrphaningError(errors.BzrError):
1420
 
 
1421
 
    # Only bugs could lead to such exception being seen by the user
1422
 
    internal_error = True
1423
 
    _fmt = "Error while orphaning %s in %s directory"
1424
 
 
1425
 
    def __init__(self, orphan, parent):
1426
 
        errors.BzrError.__init__(self)
1427
 
        self.orphan = orphan
1428
 
        self.parent = parent
1429
 
 
1430
 
 
1431
 
class OrphaningForbidden(OrphaningError):
1432
 
 
1433
 
    _fmt = "Policy: %s doesn't allow creating orphans."
1434
 
 
1435
 
    def __init__(self, policy):
1436
 
        errors.BzrError.__init__(self)
1437
 
        self.policy = policy
1438
 
 
1439
 
 
1440
 
def move_orphan(tt, orphan_id, parent_id):
1441
 
    """See TreeTransformBase.new_orphan.
1442
 
 
1443
 
    This creates a new orphan in the `bzr-orphans` dir at the root of the
1444
 
    `TreeTransform`.
1445
 
 
1446
 
    :param tt: The TreeTransform orphaning `trans_id`.
1447
 
 
1448
 
    :param orphan_id: The trans id that should be orphaned.
1449
 
 
1450
 
    :param parent_id: The orphan parent trans id.
1451
 
    """
1452
 
    # Add the orphan dir if it doesn't exist
1453
 
    orphan_dir_basename = 'bzr-orphans'
1454
 
    od_id = tt.trans_id_tree_path(orphan_dir_basename)
1455
 
    if tt.final_kind(od_id) is None:
1456
 
        tt.create_directory(od_id)
1457
 
    parent_path = tt._tree_id_paths[parent_id]
1458
 
    # Find a name that doesn't exist yet in the orphan dir
1459
 
    actual_name = tt.final_name(orphan_id)
1460
 
    new_name = tt._available_backup_name(actual_name, od_id)
1461
 
    tt.adjust_path(new_name, od_id, orphan_id)
1462
 
    trace.warning('%s has been orphaned in %s'
1463
 
                  % (joinpath(parent_path, actual_name), orphan_dir_basename))
1464
 
 
1465
 
 
1466
 
def refuse_orphan(tt, orphan_id, parent_id):
1467
 
    """See TreeTransformBase.new_orphan.
1468
 
 
1469
 
    This refuses to create orphan, letting the caller handle the conflict.
1470
 
    """
1471
 
    raise OrphaningForbidden('never')
1472
 
 
1473
 
 
1474
 
orphaning_registry = registry.Registry()
1475
 
orphaning_registry.register(
1476
 
    'conflict', refuse_orphan,
1477
 
    'Leave orphans in place and create a conflict on the directory.')
1478
 
orphaning_registry.register(
1479
 
    'move', move_orphan,
1480
 
    'Move orphans into the bzr-orphans directory.')
1481
 
orphaning_registry._set_default_key('conflict')
1482
 
 
1483
1276
 
1484
1277
class TreeTransform(DiskTreeTransform):
1485
1278
    """Represent a tree transformation.
1546
1339
    FileMover does not delete files until it is sure that a rollback will not
1547
1340
    happen.
1548
1341
    """
1549
 
    def __init__(self, tree, pb=None):
 
1342
    def __init__(self, tree, pb=DummyProgress()):
1550
1343
        """Note: a tree_write lock is taken on the tree.
1551
1344
 
1552
1345
        Use TreeTransform.finalize() to release the lock (can be omitted if
1603
1396
    def tree_kind(self, trans_id):
1604
1397
        """Determine the file kind in the working tree.
1605
1398
 
1606
 
        :returns: The file kind or None if the file does not exist
 
1399
        Raises NoSuchFile if the file does not exist
1607
1400
        """
1608
1401
        path = self._tree_id_paths.get(trans_id)
1609
1402
        if path is None:
1610
 
            return None
 
1403
            raise NoSuchFile(None)
1611
1404
        try:
1612
1405
            return file_kind(self._tree.abspath(path))
1613
 
        except errors.NoSuchFile:
1614
 
            return None
 
1406
        except OSError, e:
 
1407
            if e.errno != errno.ENOENT:
 
1408
                raise
 
1409
            else:
 
1410
                raise NoSuchFile(path)
1615
1411
 
1616
1412
    def _set_mode(self, trans_id, mode_id, typefunc):
1617
1413
        """Set the mode of new file contents.
1723
1519
        """
1724
1520
        if not no_conflicts:
1725
1521
            self._check_malformed()
1726
 
        child_pb = ui.ui_factory.nested_progress_bar()
 
1522
        child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1727
1523
        try:
1728
1524
            if precomputed_delta is None:
1729
1525
                child_pb.update('Apply phase', 0, 2)
1748
1544
                mover.apply_deletions()
1749
1545
        finally:
1750
1546
            child_pb.finished()
1751
 
        if self.final_file_id(self.root) is None:
1752
 
            inventory_delta = [e for e in inventory_delta if e[0] != '']
1753
1547
        self._tree.apply_inventory_delta(inventory_delta)
1754
 
        self._apply_observed_sha1s()
1755
1548
        self._done = True
1756
1549
        self.finalize()
1757
1550
        return _TransformResults(modified_paths, self.rename_count)
1759
1552
    def _generate_inventory_delta(self):
1760
1553
        """Generate an inventory delta for the current transform."""
1761
1554
        inventory_delta = []
1762
 
        child_pb = ui.ui_factory.nested_progress_bar()
 
1555
        child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1763
1556
        new_paths = self._inventory_altered()
1764
1557
        total_entries = len(new_paths) + len(self._removed_id)
1765
1558
        try:
1789
1582
                if file_id is None:
1790
1583
                    continue
1791
1584
                needs_entry = False
1792
 
                kind = self.final_kind(trans_id)
1793
 
                if kind is None:
 
1585
                try:
 
1586
                    kind = self.final_kind(trans_id)
 
1587
                except NoSuchFile:
1794
1588
                    kind = self._tree.stored_kind(file_id)
1795
1589
                parent_trans_id = self.final_parent(trans_id)
1796
1590
                parent_file_id = new_path_file_ids.get(parent_trans_id)
1827
1621
        """
1828
1622
        tree_paths = list(self._tree_path_ids.iteritems())
1829
1623
        tree_paths.sort(reverse=True)
1830
 
        child_pb = ui.ui_factory.nested_progress_bar()
 
1624
        child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1831
1625
        try:
1832
 
            for num, (path, trans_id) in enumerate(tree_paths):
1833
 
                # do not attempt to move root into a subdirectory of itself.
1834
 
                if path == '':
1835
 
                    continue
 
1626
            for num, data in enumerate(tree_paths):
 
1627
                path, trans_id = data
1836
1628
                child_pb.update('removing file', num, len(tree_paths))
1837
1629
                full_path = self._tree.abspath(path)
1838
1630
                if trans_id in self._removed_contents:
1842
1634
                      or trans_id in self._new_parent):
1843
1635
                    try:
1844
1636
                        mover.rename(full_path, self._limbo_name(trans_id))
1845
 
                    except errors.TransformRenameFailed, e:
 
1637
                    except OSError, e:
1846
1638
                        if e.errno != errno.ENOENT:
1847
1639
                            raise
1848
1640
                    else:
1864
1656
        modified_paths = []
1865
1657
        new_path_file_ids = dict((t, self.final_file_id(t)) for p, t in
1866
1658
                                 new_paths)
1867
 
        child_pb = ui.ui_factory.nested_progress_bar()
 
1659
        child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1868
1660
        try:
1869
1661
            for num, (path, trans_id) in enumerate(new_paths):
1870
1662
                if (num % 10) == 0:
1873
1665
                if trans_id in self._needs_rename:
1874
1666
                    try:
1875
1667
                        mover.rename(self._limbo_name(trans_id), full_path)
1876
 
                    except errors.TransformRenameFailed, e:
 
1668
                    except OSError, e:
1877
1669
                        # We may be renaming a dangling inventory id
1878
1670
                        if e.errno != errno.ENOENT:
1879
1671
                            raise
1880
1672
                    else:
1881
1673
                        self.rename_count += 1
1882
 
                    # TODO: if trans_id in self._observed_sha1s, we should
1883
 
                    #       re-stat the final target, since ctime will be
1884
 
                    #       updated by the change.
1885
1674
                if (trans_id in self._new_contents or
1886
1675
                    self.path_changed(trans_id)):
1887
1676
                    if trans_id in self._new_contents:
1888
1677
                        modified_paths.append(full_path)
1889
1678
                if trans_id in self._new_executability:
1890
1679
                    self._set_executability(path, trans_id)
1891
 
                if trans_id in self._observed_sha1s:
1892
 
                    o_sha1, o_st_val = self._observed_sha1s[trans_id]
1893
 
                    st = osutils.lstat(full_path)
1894
 
                    self._observed_sha1s[trans_id] = (o_sha1, st)
1895
1680
        finally:
1896
1681
            child_pb.finished()
1897
 
        for path, trans_id in new_paths:
1898
 
            # new_paths includes stuff like workingtree conflicts. Only the
1899
 
            # stuff in new_contents actually comes from limbo.
1900
 
            if trans_id in self._limbo_files:
1901
 
                del self._limbo_files[trans_id]
1902
1682
        self._new_contents.clear()
1903
1683
        return modified_paths
1904
1684
 
1905
 
    def _apply_observed_sha1s(self):
1906
 
        """After we have finished renaming everything, update observed sha1s
1907
 
 
1908
 
        This has to be done after self._tree.apply_inventory_delta, otherwise
1909
 
        it doesn't know anything about the files we are updating. Also, we want
1910
 
        to do this as late as possible, so that most entries end up cached.
1911
 
        """
1912
 
        # TODO: this doesn't update the stat information for directories. So
1913
 
        #       the first 'bzr status' will still need to rewrite
1914
 
        #       .bzr/checkout/dirstate. However, we at least don't need to
1915
 
        #       re-read all of the files.
1916
 
        # TODO: If the operation took a while, we could do a time.sleep(3) here
1917
 
        #       to allow the clock to tick over and ensure we won't have any
1918
 
        #       problems. (we could observe start time, and finish time, and if
1919
 
        #       it is less than eg 10% overhead, add a sleep call.)
1920
 
        paths = FinalPaths(self)
1921
 
        for trans_id, observed in self._observed_sha1s.iteritems():
1922
 
            path = paths.get_path(trans_id)
1923
 
            # We could get the file_id, but dirstate prefers to use the path
1924
 
            # anyway, and it is 'cheaper' to determine.
1925
 
            # file_id = self._new_id[trans_id]
1926
 
            self._tree._observed_sha1(None, path, observed)
1927
 
 
1928
1685
 
1929
1686
class TransformPreview(DiskTreeTransform):
1930
1687
    """A TreeTransform for generating preview trees.
1934
1691
    unversioned files in the input tree.
1935
1692
    """
1936
1693
 
1937
 
    def __init__(self, tree, pb=None, case_sensitive=True):
 
1694
    def __init__(self, tree, pb=DummyProgress(), case_sensitive=True):
1938
1695
        tree.lock_read()
1939
1696
        limbodir = osutils.mkdtemp(prefix='bzr-limbo-')
1940
1697
        DiskTreeTransform.__init__(self, tree, limbodir, pb, case_sensitive)
1945
1702
    def tree_kind(self, trans_id):
1946
1703
        path = self._tree_id_paths.get(trans_id)
1947
1704
        if path is None:
1948
 
            return None
1949
 
        kind = self._tree.path_content_summary(path)[0]
1950
 
        if kind == 'missing':
1951
 
            kind = None
1952
 
        return kind
 
1705
            raise NoSuchFile(None)
 
1706
        file_id = self._tree.path2id(path)
 
1707
        return self._tree.kind(file_id)
1953
1708
 
1954
1709
    def _set_mode(self, trans_id, mode_id, typefunc):
1955
1710
        """Set the mode of new file contents.
1975
1730
            childpath = joinpath(path, child)
1976
1731
            yield self.trans_id_tree_path(childpath)
1977
1732
 
1978
 
    def new_orphan(self, trans_id, parent_id):
1979
 
        raise NotImplementedError(self.new_orphan)
1980
 
 
1981
 
 
1982
 
class _PreviewTree(tree.InventoryTree):
 
1733
 
 
1734
class _PreviewTree(tree.Tree):
1983
1735
    """Partial implementation of Tree to support show_diff_trees"""
1984
1736
 
1985
1737
    def __init__(self, transform):
2014
1766
                yield self._get_repository().revision_tree(revision_id)
2015
1767
 
2016
1768
    def _get_file_revision(self, file_id, vf, tree_revision):
2017
 
        parent_keys = [(file_id, t.get_file_revision(file_id)) for t in
 
1769
        parent_keys = [(file_id, self._file_revision(t, file_id)) for t in
2018
1770
                       self._iter_parent_trees()]
2019
1771
        vf.add_lines((file_id, tree_revision), parent_keys,
2020
 
                     self.get_file_lines(file_id))
 
1772
                     self.get_file(file_id).readlines())
2021
1773
        repo = self._get_repository()
2022
1774
        base_vf = repo.texts
2023
1775
        if base_vf not in vf.fallback_versionedfiles:
2024
1776
            vf.fallback_versionedfiles.append(base_vf)
2025
1777
        return tree_revision
2026
1778
 
2027
 
    def _stat_limbo_file(self, file_id=None, trans_id=None):
2028
 
        if trans_id is None:
2029
 
            trans_id = self._transform.trans_id_file_id(file_id)
 
1779
    def _stat_limbo_file(self, file_id):
 
1780
        trans_id = self._transform.trans_id_file_id(file_id)
2030
1781
        name = self._transform._limbo_name(trans_id)
2031
1782
        return os.lstat(name)
2032
1783
 
2046
1797
            executable = self.is_executable(file_id, path)
2047
1798
        return kind, executable, None
2048
1799
 
2049
 
    def is_locked(self):
2050
 
        return False
2051
 
 
2052
1800
    def lock_read(self):
2053
1801
        # Perhaps in theory, this should lock the TreeTransform?
2054
 
        return self
 
1802
        pass
2055
1803
 
2056
1804
    def unlock(self):
2057
1805
        pass
2155
1903
            if (specific_file_ids is not None
2156
1904
                and file_id not in specific_file_ids):
2157
1905
                continue
2158
 
            kind = self._transform.final_kind(trans_id)
2159
 
            if kind is None:
 
1906
            try:
 
1907
                kind = self._transform.final_kind(trans_id)
 
1908
            except NoSuchFile:
2160
1909
                kind = self._transform._tree.stored_kind(file_id)
2161
1910
            new_entry = inventory.make_entry(
2162
1911
                kind,
2247
1996
 
2248
1997
    def get_file_size(self, file_id):
2249
1998
        """See Tree.get_file_size"""
2250
 
        trans_id = self._transform.trans_id_file_id(file_id)
2251
 
        kind = self._transform.final_kind(trans_id)
2252
 
        if kind != 'file':
2253
 
            return None
2254
 
        if trans_id in self._transform._new_contents:
2255
 
            return self._stat_limbo_file(trans_id=trans_id).st_size
2256
1999
        if self.kind(file_id) == 'file':
2257
2000
            return self._transform._tree.get_file_size(file_id)
2258
2001
        else:
2259
2002
            return None
2260
2003
 
2261
 
    def get_file_verifier(self, file_id, path=None, stat_value=None):
2262
 
        trans_id = self._transform.trans_id_file_id(file_id)
2263
 
        kind = self._transform._new_contents.get(trans_id)
2264
 
        if kind is None:
2265
 
            return self._transform._tree.get_file_verifier(file_id)
2266
 
        if kind == 'file':
2267
 
            fileobj = self.get_file(file_id)
2268
 
            try:
2269
 
                return ("SHA1", sha_file(fileobj))
2270
 
            finally:
2271
 
                fileobj.close()
2272
 
 
2273
2004
    def get_file_sha1(self, file_id, path=None, stat_value=None):
2274
2005
        trans_id = self._transform.trans_id_file_id(file_id)
2275
2006
        kind = self._transform._new_contents.get(trans_id)
2298
2029
            except errors.NoSuchId:
2299
2030
                return False
2300
2031
 
2301
 
    def has_filename(self, path):
2302
 
        trans_id = self._path2trans_id(path)
2303
 
        if trans_id in self._transform._new_contents:
2304
 
            return True
2305
 
        elif trans_id in self._transform._removed_contents:
2306
 
            return False
2307
 
        else:
2308
 
            return self._transform._tree.has_filename(path)
2309
 
 
2310
2032
    def path_content_summary(self, path):
2311
2033
        trans_id = self._path2trans_id(path)
2312
2034
        tt = self._transform
2400
2122
                                   self.get_file(file_id).readlines(),
2401
2123
                                   default_revision)
2402
2124
 
2403
 
    def get_symlink_target(self, file_id, path=None):
 
2125
    def get_symlink_target(self, file_id):
2404
2126
        """See Tree.get_symlink_target"""
2405
2127
        if not self._content_change(file_id):
2406
2128
            return self._transform._tree.get_symlink_target(file_id)
2421
2143
                path_from_root = self._final_paths.get_path(child_id)
2422
2144
                basename = self._transform.final_name(child_id)
2423
2145
                file_id = self._transform.final_file_id(child_id)
2424
 
                kind  = self._transform.final_kind(child_id)
2425
 
                if kind is not None:
 
2146
                try:
 
2147
                    kind = self._transform.final_kind(child_id)
2426
2148
                    versioned_kind = kind
2427
 
                else:
 
2149
                except NoSuchFile:
2428
2150
                    kind = 'unknown'
2429
2151
                    versioned_kind = self._transform._tree.stored_kind(file_id)
2430
2152
                if versioned_kind == 'directory':
2543
2265
    for num, _unused in enumerate(wt.all_file_ids()):
2544
2266
        if num > 0:  # more than just a root
2545
2267
            raise errors.WorkingTreeAlreadyPopulated(base=wt.basedir)
 
2268
    existing_files = set()
 
2269
    for dir, files in wt.walkdirs():
 
2270
        existing_files.update(f[0] for f in files)
2546
2271
    file_trans_id = {}
2547
 
    top_pb = ui.ui_factory.nested_progress_bar()
 
2272
    top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
2548
2273
    pp = ProgressPhase("Build phase", 2, top_pb)
2549
2274
    if tree.inventory.root is not None:
2550
2275
        # This is kind of a hack: we should be altering the root
2563
2288
        pp.next_phase()
2564
2289
        file_trans_id[wt.get_root_id()] = \
2565
2290
            tt.trans_id_tree_file_id(wt.get_root_id())
2566
 
        pb = ui.ui_factory.nested_progress_bar()
 
2291
        pb = bzrlib.ui.ui_factory.nested_progress_bar()
2567
2292
        try:
2568
2293
            deferred_contents = []
2569
2294
            num = 0
2572
2297
                precomputed_delta = []
2573
2298
            else:
2574
2299
                precomputed_delta = None
2575
 
            # Check if tree inventory has content. If so, we populate
2576
 
            # existing_files with the directory content. If there are no
2577
 
            # entries we skip populating existing_files as its not used.
2578
 
            # This improves performance and unncessary work on large
2579
 
            # directory trees. (#501307)
2580
 
            if total > 0:
2581
 
                existing_files = set()
2582
 
                for dir, files in wt.walkdirs():
2583
 
                    existing_files.update(f[0] for f in files)
2584
2300
            for num, (tree_path, entry) in \
2585
2301
                enumerate(tree.inventory.iter_entries_by_dir()):
2586
2302
                pb.update("Building tree", num - len(deferred_contents), total)
2616
2332
                    executable = tree.is_executable(file_id, tree_path)
2617
2333
                    if executable:
2618
2334
                        tt.set_executability(executable, trans_id)
2619
 
                    trans_data = (trans_id, tree_path, entry.text_sha1)
 
2335
                    trans_data = (trans_id, tree_path)
2620
2336
                    deferred_contents.append((file_id, trans_data))
2621
2337
                else:
2622
2338
                    file_trans_id[file_id] = new_by_entry(tt, entry, parent_id,
2638
2354
            precomputed_delta = None
2639
2355
        conflicts = cook_conflicts(raw_conflicts, tt)
2640
2356
        for conflict in conflicts:
2641
 
            trace.warning(unicode(conflict))
 
2357
            warning(conflict)
2642
2358
        try:
2643
2359
            wt.add_conflicts(conflicts)
2644
2360
        except errors.UnsupportedOperation:
2667
2383
        unchanged = dict(unchanged)
2668
2384
        new_desired_files = []
2669
2385
        count = 0
2670
 
        for file_id, (trans_id, tree_path, text_sha1) in desired_files:
 
2386
        for file_id, (trans_id, tree_path) in desired_files:
2671
2387
            accelerator_path = unchanged.get(file_id)
2672
2388
            if accelerator_path is None:
2673
 
                new_desired_files.append((file_id,
2674
 
                    (trans_id, tree_path, text_sha1)))
 
2389
                new_desired_files.append((file_id, (trans_id, tree_path)))
2675
2390
                continue
2676
2391
            pb.update('Adding file contents', count + offset, total)
2677
2392
            if hardlink:
2684
2399
                    contents = filtered_output_bytes(contents, filters,
2685
2400
                        ContentFilterContext(tree_path, tree))
2686
2401
                try:
2687
 
                    tt.create_file(contents, trans_id, sha1=text_sha1)
 
2402
                    tt.create_file(contents, trans_id)
2688
2403
                finally:
2689
2404
                    try:
2690
2405
                        contents.close()
2693
2408
                        pass
2694
2409
            count += 1
2695
2410
        offset += count
2696
 
    for count, ((trans_id, tree_path, text_sha1), contents) in enumerate(
 
2411
    for count, ((trans_id, tree_path), contents) in enumerate(
2697
2412
            tree.iter_files_bytes(new_desired_files)):
2698
2413
        if wt.supports_content_filtering():
2699
2414
            filters = wt._content_filter_stack(tree_path)
2700
2415
            contents = filtered_output_bytes(contents, filters,
2701
2416
                ContentFilterContext(tree_path, tree))
2702
 
        tt.create_file(contents, trans_id, sha1=text_sha1)
 
2417
        tt.create_file(contents, trans_id)
2703
2418
        pb.update('Adding file contents', count + offset, total)
2704
2419
 
2705
2420
 
2707
2422
    for child in tt.iter_tree_children(old_parent):
2708
2423
        tt.adjust_path(tt.final_name(child), new_parent, child)
2709
2424
 
2710
 
 
2711
2425
def _reparent_transform_children(tt, old_parent, new_parent):
2712
2426
    by_parent = tt.by_parent()
2713
2427
    for child in by_parent[old_parent]:
2714
2428
        tt.adjust_path(tt.final_name(child), new_parent, child)
2715
2429
    return by_parent[old_parent]
2716
2430
 
2717
 
 
2718
2431
def _content_match(tree, entry, file_id, kind, target_path):
2719
2432
    if entry.kind != kind:
2720
2433
        return False
2721
2434
    if entry.kind == "directory":
2722
2435
        return True
2723
2436
    if entry.kind == "file":
2724
 
        f = file(target_path, 'rb')
2725
 
        try:
2726
 
            if tree.get_file_text(file_id) == f.read():
2727
 
                return True
2728
 
        finally:
2729
 
            f.close()
 
2437
        if tree.get_file(file_id).read() == file(target_path, 'rb').read():
 
2438
            return True
2730
2439
    elif entry.kind == "symlink":
2731
2440
        if tree.get_symlink_target(file_id) == os.readlink(target_path):
2732
2441
            return True
2784
2493
        raise errors.BadFileKindError(name, kind)
2785
2494
 
2786
2495
 
 
2496
@deprecated_function(deprecated_in((1, 9, 0)))
 
2497
def create_by_entry(tt, entry, tree, trans_id, lines=None, mode_id=None):
 
2498
    """Create new file contents according to an inventory entry.
 
2499
 
 
2500
    DEPRECATED.  Use create_from_tree instead.
 
2501
    """
 
2502
    if entry.kind == "file":
 
2503
        if lines is None:
 
2504
            lines = tree.get_file(entry.file_id).readlines()
 
2505
        tt.create_file(lines, trans_id, mode_id=mode_id)
 
2506
    elif entry.kind == "symlink":
 
2507
        tt.create_symlink(tree.get_symlink_target(entry.file_id), trans_id)
 
2508
    elif entry.kind == "directory":
 
2509
        tt.create_directory(trans_id)
 
2510
 
 
2511
 
2787
2512
def create_from_tree(tt, trans_id, tree, file_id, bytes=None,
2788
2513
    filter_tree_path=None):
2789
2514
    """Create new file contents according to tree contents.
2820
2545
        tt.set_executability(entry.executable, trans_id)
2821
2546
 
2822
2547
 
2823
 
@deprecated_function(deprecated_in((2, 3, 0)))
2824
2548
def get_backup_name(entry, by_parent, parent_trans_id, tt):
2825
2549
    return _get_backup_name(entry.name, by_parent, parent_trans_id, tt)
2826
2550
 
2827
2551
 
2828
 
@deprecated_function(deprecated_in((2, 3, 0)))
2829
2552
def _get_backup_name(name, by_parent, parent_trans_id, tt):
2830
2553
    """Produce a backup-style name that appears to be available"""
2831
2554
    def name_gen():
2866
2589
 
2867
2590
 
2868
2591
def revert(working_tree, target_tree, filenames, backups=False,
2869
 
           pb=None, change_reporter=None):
 
2592
           pb=DummyProgress(), change_reporter=None):
2870
2593
    """Revert a working tree's contents to those of a target tree."""
2871
2594
    target_tree.lock_read()
2872
 
    pb = ui.ui_factory.nested_progress_bar()
2873
2595
    tt = TreeTransform(working_tree, pb)
2874
2596
    try:
2875
2597
        pp = ProgressPhase("Revert phase", 3, pb)
2880
2602
                unversioned_filter=working_tree.is_ignored)
2881
2603
            delta.report_changes(tt.iter_changes(), change_reporter)
2882
2604
        for conflict in conflicts:
2883
 
            trace.warning(unicode(conflict))
 
2605
            warning(conflict)
2884
2606
        pp.next_phase()
2885
2607
        tt.apply()
2886
2608
        working_tree.set_merge_modified(merge_modified)
2894
2616
def _prepare_revert_transform(working_tree, target_tree, tt, filenames,
2895
2617
                              backups, pp, basis_tree=None,
2896
2618
                              merge_modified=None):
2897
 
    child_pb = ui.ui_factory.nested_progress_bar()
 
2619
    pp.next_phase()
 
2620
    child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
2898
2621
    try:
2899
2622
        if merge_modified is None:
2900
2623
            merge_modified = working_tree.merge_modified()
2903
2626
                                      merge_modified, basis_tree)
2904
2627
    finally:
2905
2628
        child_pb.finished()
2906
 
    child_pb = ui.ui_factory.nested_progress_bar()
 
2629
    pp.next_phase()
 
2630
    child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
2907
2631
    try:
2908
2632
        raw_conflicts = resolve_conflicts(tt, child_pb,
2909
2633
            lambda t, c: conflict_pass(t, c, target_tree))
2917
2641
                 backups, merge_modified, basis_tree=None):
2918
2642
    if basis_tree is not None:
2919
2643
        basis_tree.lock_read()
2920
 
    # We ask the working_tree for its changes relative to the target, rather
2921
 
    # than the target changes relative to the working tree. Because WT4 has an
2922
 
    # optimizer to compare itself to a target, but no optimizer for the
2923
 
    # reverse.
2924
 
    change_list = working_tree.iter_changes(target_tree,
 
2644
    change_list = target_tree.iter_changes(working_tree,
2925
2645
        specific_files=specific_files, pb=pb)
2926
2646
    if target_tree.get_root_id() is None:
2927
2647
        skip_root = True
2931
2651
        deferred_files = []
2932
2652
        for id_num, (file_id, path, changed_content, versioned, parent, name,
2933
2653
                kind, executable) in enumerate(change_list):
2934
 
            target_path, wt_path = path
2935
 
            target_versioned, wt_versioned = versioned
2936
 
            target_parent, wt_parent = parent
2937
 
            target_name, wt_name = name
2938
 
            target_kind, wt_kind = kind
2939
 
            target_executable, wt_executable = executable
2940
 
            if skip_root and wt_parent is None:
 
2654
            if skip_root and file_id[0] is not None and parent[0] is None:
2941
2655
                continue
2942
2656
            trans_id = tt.trans_id_file_id(file_id)
2943
2657
            mode_id = None
2944
2658
            if changed_content:
2945
2659
                keep_content = False
2946
 
                if wt_kind == 'file' and (backups or target_kind is None):
 
2660
                if kind[0] == 'file' and (backups or kind[1] is None):
2947
2661
                    wt_sha1 = working_tree.get_file_sha1(file_id)
2948
2662
                    if merge_modified.get(file_id) != wt_sha1:
2949
2663
                        # acquire the basis tree lazily to prevent the
2952
2666
                        if basis_tree is None:
2953
2667
                            basis_tree = working_tree.basis_tree()
2954
2668
                            basis_tree.lock_read()
2955
 
                        if basis_tree.has_id(file_id):
 
2669
                        if file_id in basis_tree:
2956
2670
                            if wt_sha1 != basis_tree.get_file_sha1(file_id):
2957
2671
                                keep_content = True
2958
 
                        elif target_kind is None and not target_versioned:
 
2672
                        elif kind[1] is None and not versioned[1]:
2959
2673
                            keep_content = True
2960
 
                if wt_kind is not None:
 
2674
                if kind[0] is not None:
2961
2675
                    if not keep_content:
2962
2676
                        tt.delete_contents(trans_id)
2963
 
                    elif target_kind is not None:
2964
 
                        parent_trans_id = tt.trans_id_file_id(wt_parent)
2965
 
                        backup_name = tt._available_backup_name(
2966
 
                            wt_name, parent_trans_id)
 
2677
                    elif kind[1] is not None:
 
2678
                        parent_trans_id = tt.trans_id_file_id(parent[0])
 
2679
                        by_parent = tt.by_parent()
 
2680
                        backup_name = _get_backup_name(name[0], by_parent,
 
2681
                                                       parent_trans_id, tt)
2967
2682
                        tt.adjust_path(backup_name, parent_trans_id, trans_id)
2968
 
                        new_trans_id = tt.create_path(wt_name, parent_trans_id)
2969
 
                        if wt_versioned and target_versioned:
 
2683
                        new_trans_id = tt.create_path(name[0], parent_trans_id)
 
2684
                        if versioned == (True, True):
2970
2685
                            tt.unversion_file(trans_id)
2971
2686
                            tt.version_file(file_id, new_trans_id)
2972
2687
                        # New contents should have the same unix perms as old
2973
2688
                        # contents
2974
2689
                        mode_id = trans_id
2975
2690
                        trans_id = new_trans_id
2976
 
                if target_kind in ('directory', 'tree-reference'):
 
2691
                if kind[1] in ('directory', 'tree-reference'):
2977
2692
                    tt.create_directory(trans_id)
2978
 
                    if target_kind == 'tree-reference':
 
2693
                    if kind[1] == 'tree-reference':
2979
2694
                        revision = target_tree.get_reference_revision(file_id,
2980
 
                                                                      target_path)
 
2695
                                                                      path[1])
2981
2696
                        tt.set_tree_reference(revision, trans_id)
2982
 
                elif target_kind == 'symlink':
 
2697
                elif kind[1] == 'symlink':
2983
2698
                    tt.create_symlink(target_tree.get_symlink_target(file_id),
2984
2699
                                      trans_id)
2985
 
                elif target_kind == 'file':
 
2700
                elif kind[1] == 'file':
2986
2701
                    deferred_files.append((file_id, (trans_id, mode_id)))
2987
2702
                    if basis_tree is None:
2988
2703
                        basis_tree = working_tree.basis_tree()
2989
2704
                        basis_tree.lock_read()
2990
2705
                    new_sha1 = target_tree.get_file_sha1(file_id)
2991
 
                    if (basis_tree.has_id(file_id) and
2992
 
                        new_sha1 == basis_tree.get_file_sha1(file_id)):
 
2706
                    if (file_id in basis_tree and new_sha1 ==
 
2707
                        basis_tree.get_file_sha1(file_id)):
2993
2708
                        if file_id in merge_modified:
2994
2709
                            del merge_modified[file_id]
2995
2710
                    else:
2996
2711
                        merge_modified[file_id] = new_sha1
2997
2712
 
2998
2713
                    # preserve the execute bit when backing up
2999
 
                    if keep_content and wt_executable == target_executable:
3000
 
                        tt.set_executability(target_executable, trans_id)
3001
 
                elif target_kind is not None:
3002
 
                    raise AssertionError(target_kind)
3003
 
            if not wt_versioned and target_versioned:
 
2714
                    if keep_content and executable[0] == executable[1]:
 
2715
                        tt.set_executability(executable[1], trans_id)
 
2716
                elif kind[1] is not None:
 
2717
                    raise AssertionError(kind[1])
 
2718
            if versioned == (False, True):
3004
2719
                tt.version_file(file_id, trans_id)
3005
 
            if wt_versioned and not target_versioned:
 
2720
            if versioned == (True, False):
3006
2721
                tt.unversion_file(trans_id)
3007
 
            if (target_name is not None and
3008
 
                (wt_name != target_name or wt_parent != target_parent)):
3009
 
                if target_name == '' and target_parent is None:
 
2722
            if (name[1] is not None and
 
2723
                (name[0] != name[1] or parent[0] != parent[1])):
 
2724
                if name[1] == '' and parent[1] is None:
3010
2725
                    parent_trans = ROOT_PARENT
3011
2726
                else:
3012
 
                    parent_trans = tt.trans_id_file_id(target_parent)
3013
 
                if wt_parent is None and wt_versioned:
3014
 
                    tt.adjust_root_path(target_name, parent_trans)
 
2727
                    parent_trans = tt.trans_id_file_id(parent[1])
 
2728
                if parent[0] is None and versioned[0]:
 
2729
                    tt.adjust_root_path(name[1], parent_trans)
3015
2730
                else:
3016
 
                    tt.adjust_path(target_name, parent_trans, trans_id)
3017
 
            if wt_executable != target_executable and target_kind == "file":
3018
 
                tt.set_executability(target_executable, trans_id)
 
2731
                    tt.adjust_path(name[1], parent_trans, trans_id)
 
2732
            if executable[0] != executable[1] and kind[1] == "file":
 
2733
                tt.set_executability(executable[1], trans_id)
3019
2734
        if working_tree.supports_content_filtering():
3020
2735
            for index, ((trans_id, mode_id), bytes) in enumerate(
3021
2736
                target_tree.iter_files_bytes(deferred_files)):
3039
2754
    return merge_modified
3040
2755
 
3041
2756
 
3042
 
def resolve_conflicts(tt, pb=None, pass_func=None):
 
2757
def resolve_conflicts(tt, pb=DummyProgress(), pass_func=None):
3043
2758
    """Make many conflict-resolution attempts, but die if they fail"""
3044
2759
    if pass_func is None:
3045
2760
        pass_func = conflict_pass
3046
2761
    new_conflicts = set()
3047
 
    pb = ui.ui_factory.nested_progress_bar()
3048
2762
    try:
3049
2763
        for n in range(10):
3050
2764
            pb.update('Resolution pass', n+1, 10)
3054
2768
            new_conflicts.update(pass_func(tt, conflicts))
3055
2769
        raise MalformedTransform(conflicts=conflicts)
3056
2770
    finally:
3057
 
        pb.finished()
 
2771
        pb.clear()
3058
2772
 
3059
2773
 
3060
2774
def conflict_pass(tt, conflicts, path_tree=None):
3092
2806
 
3093
2807
        elif c_type == 'missing parent':
3094
2808
            trans_id = conflict[1]
3095
 
            if trans_id in tt._removed_contents:
3096
 
                cancel_deletion = True
3097
 
                orphans = tt._get_potential_orphans(trans_id)
3098
 
                if orphans:
3099
 
                    cancel_deletion = False
3100
 
                    # All children are orphans
3101
 
                    for o in orphans:
3102
 
                        try:
3103
 
                            tt.new_orphan(o, trans_id)
3104
 
                        except OrphaningError:
3105
 
                            # Something bad happened so we cancel the directory
3106
 
                            # deletion which will leave it in place with a
3107
 
                            # conflict. The user can deal with it from there.
3108
 
                            # Note that this also catch the case where we don't
3109
 
                            # want to create orphans and leave the directory in
3110
 
                            # place.
3111
 
                            cancel_deletion = True
3112
 
                            break
3113
 
                if cancel_deletion:
3114
 
                    # Cancel the directory deletion
3115
 
                    tt.cancel_deletion(trans_id)
3116
 
                    new_conflicts.add(('deleting parent', 'Not deleting',
3117
 
                                       trans_id))
3118
 
            else:
 
2809
            try:
 
2810
                tt.cancel_deletion(trans_id)
 
2811
                new_conflicts.add(('deleting parent', 'Not deleting',
 
2812
                                   trans_id))
 
2813
            except KeyError:
3119
2814
                create = True
3120
2815
                try:
3121
2816
                    tt.final_name(trans_id)
3124
2819
                        file_id = tt.final_file_id(trans_id)
3125
2820
                        if file_id is None:
3126
2821
                            file_id = tt.inactive_file_id(trans_id)
3127
 
                        _, entry = path_tree.iter_entries_by_dir(
3128
 
                            [file_id]).next()
 
2822
                        entry = path_tree.inventory[file_id]
3129
2823
                        # special-case the other tree root (move its
3130
2824
                        # children to current root)
3131
2825
                        if entry.parent_id is None:
3132
 
                            create = False
 
2826
                            create=False
3133
2827
                            moved = _reparent_transform_children(
3134
2828
                                tt, trans_id, tt.root)
3135
2829
                            for child in moved:
3146
2840
        elif c_type == 'unversioned parent':
3147
2841
            file_id = tt.inactive_file_id(conflict[1])
3148
2842
            # special-case the other tree root (move its children instead)
3149
 
            if path_tree and path_tree.has_id(file_id):
3150
 
                if path_tree.path2id('') == file_id:
3151
 
                    # This is the root entry, skip it
 
2843
            if path_tree and file_id in path_tree:
 
2844
                if path_tree.inventory[file_id].parent_id is None:
3152
2845
                    continue
3153
2846
            tt.version_file(file_id, conflict[1])
3154
2847
            new_conflicts.add((c_type, 'Versioned directory', conflict[1]))
3170
2863
 
3171
2864
def cook_conflicts(raw_conflicts, tt):
3172
2865
    """Generate a list of cooked conflicts, sorted by file path"""
 
2866
    from bzrlib.conflicts import Conflict
3173
2867
    conflict_iter = iter_cook_conflicts(raw_conflicts, tt)
3174
 
    return sorted(conflict_iter, key=conflicts.Conflict.sort_key)
 
2868
    return sorted(conflict_iter, key=Conflict.sort_key)
3175
2869
 
3176
2870
 
3177
2871
def iter_cook_conflicts(raw_conflicts, tt):
 
2872
    from bzrlib.conflicts import Conflict
3178
2873
    fp = FinalPaths(tt)
3179
2874
    for conflict in raw_conflicts:
3180
2875
        c_type = conflict[0]
3182
2877
        modified_path = fp.get_path(conflict[2])
3183
2878
        modified_id = tt.final_file_id(conflict[2])
3184
2879
        if len(conflict) == 3:
3185
 
            yield conflicts.Conflict.factory(
3186
 
                c_type, action=action, path=modified_path, file_id=modified_id)
 
2880
            yield Conflict.factory(c_type, action=action, path=modified_path,
 
2881
                                     file_id=modified_id)
3187
2882
 
3188
2883
        else:
3189
2884
            conflicting_path = fp.get_path(conflict[3])
3190
2885
            conflicting_id = tt.final_file_id(conflict[3])
3191
 
            yield conflicts.Conflict.factory(
3192
 
                c_type, action=action, path=modified_path,
3193
 
                file_id=modified_id,
3194
 
                conflict_path=conflicting_path,
3195
 
                conflict_file_id=conflicting_id)
 
2886
            yield Conflict.factory(c_type, action=action, path=modified_path,
 
2887
                                   file_id=modified_id,
 
2888
                                   conflict_path=conflicting_path,
 
2889
                                   conflict_file_id=conflicting_id)
3196
2890
 
3197
2891
 
3198
2892
class _FileMover(object):
3203
2897
        self.pending_deletions = []
3204
2898
 
3205
2899
    def rename(self, from_, to):
3206
 
        """Rename a file from one path to another."""
 
2900
        """Rename a file from one path to another.  Functions like os.rename"""
3207
2901
        try:
3208
2902
            os.rename(from_, to)
3209
2903
        except OSError, e:
3210
2904
            if e.errno in (errno.EEXIST, errno.ENOTEMPTY):
3211
2905
                raise errors.FileExists(to, str(e))
3212
 
            # normal OSError doesn't include filenames so it's hard to see where
3213
 
            # the problem is, see https://bugs.launchpad.net/bzr/+bug/491763
3214
 
            raise errors.TransformRenameFailed(from_, to, str(e), e.errno)
 
2906
            raise
3215
2907
        self.past_renames.append((from_, to))
3216
2908
 
3217
2909
    def pre_delete(self, from_, to):
3227
2919
    def rollback(self):
3228
2920
        """Reverse all renames that have been performed"""
3229
2921
        for from_, to in reversed(self.past_renames):
3230
 
            try:
3231
 
                os.rename(to, from_)
3232
 
            except OSError, e:
3233
 
                raise errors.TransformRenameFailed(to, from_, str(e), e.errno)
 
2922
            os.rename(to, from_)
3234
2923
        # after rollback, don't reuse _FileMover
3235
2924
        past_renames = None
3236
2925
        pending_deletions = None