~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/transform.py

  • Committer: John Ferlito
  • Date: 2009-09-02 04:31:45 UTC
  • mto: (4665.7.1 serve-init)
  • mto: This revision was merged to the branch mainline in revision 4913.
  • Revision ID: johnf@inodes.org-20090902043145-gxdsfw03ilcwbyn5
Add a debian init script for bzr --serve

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2006-2011 Canonical Ltd
 
1
# Copyright (C) 2006, 2007, 2008, 2009 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
17
17
import os
18
18
import errno
19
19
from stat import S_ISREG, S_IEXEC
20
 
import time
21
20
 
22
 
from bzrlib import (
23
 
    errors,
24
 
    lazy_import,
25
 
    registry,
26
 
    trace,
27
 
    tree,
28
 
    )
29
 
lazy_import.lazy_import(globals(), """
 
21
from bzrlib.lazy_import import lazy_import
 
22
lazy_import(globals(), """
30
23
from bzrlib import (
31
24
    annotate,
32
25
    bencode,
33
26
    bzrdir,
34
 
    commit,
35
27
    delta,
36
28
    errors,
37
29
    inventory,
38
30
    multiparent,
39
31
    osutils,
40
32
    revision as _mod_revision,
41
 
    ui,
42
 
    urlutils,
43
33
    )
44
34
""")
45
35
from bzrlib.errors import (DuplicateKey, MalformedTransform, NoSuchFile,
46
 
                           ReusingTransform, CantMoveRoot,
 
36
                           ReusingTransform, NotVersionedError, CantMoveRoot,
47
37
                           ExistingLimbo, ImmortalLimbo, NoFinalPath,
48
38
                           UnableCreateSymlink)
49
39
from bzrlib.filters import filtered_output_bytes, ContentFilterContext
 
40
from bzrlib.inventory import InventoryEntry
50
41
from bzrlib.osutils import (
51
42
    delete_any,
52
43
    file_kind,
53
44
    has_symlinks,
 
45
    lexists,
54
46
    pathjoin,
55
47
    sha_file,
56
48
    splitpath,
57
49
    supports_executable,
58
 
    )
59
 
from bzrlib.progress import ProgressPhase
 
50
)
 
51
from bzrlib.progress import DummyProgress, ProgressPhase
60
52
from bzrlib.symbol_versioning import (
61
 
    deprecated_function,
62
 
    deprecated_in,
63
 
    deprecated_method,
64
 
    )
 
53
        deprecated_function,
 
54
        deprecated_in,
 
55
        )
 
56
from bzrlib.trace import mutter, warning
 
57
from bzrlib import tree
 
58
import bzrlib.ui
 
59
import bzrlib.urlutils as urlutils
65
60
 
66
61
 
67
62
ROOT_PARENT = "root-parent"
68
63
 
 
64
 
69
65
def unique_add(map, key, value):
70
66
    if key in map:
71
67
        raise DuplicateKey(key=key)
72
68
    map[key] = value
73
69
 
74
70
 
75
 
 
76
71
class _TransformResults(object):
77
72
    def __init__(self, modified_paths, rename_count):
78
73
        object.__init__(self)
83
78
class TreeTransformBase(object):
84
79
    """The base class for TreeTransform and its kin."""
85
80
 
86
 
    def __init__(self, tree, pb=None,
 
81
    def __init__(self, tree, pb=DummyProgress(),
87
82
                 case_sensitive=True):
88
83
        """Constructor.
89
84
 
90
85
        :param tree: The tree that will be transformed, but not necessarily
91
86
            the output tree.
92
 
        :param pb: ignored
 
87
        :param pb: A ProgressTask indicating how much progress is being made
93
88
        :param case_sensitive: If True, the target of the transform is
94
89
            case sensitive, not just case preserving.
95
90
        """
102
97
        self._new_parent = {}
103
98
        # mapping of trans_id with new contents -> new file_kind
104
99
        self._new_contents = {}
105
 
        # mapping of trans_id => (sha1 of content, stat_value)
106
 
        self._observed_sha1s = {}
107
100
        # Set of trans_ids whose contents will be removed
108
101
        self._removed_contents = set()
109
102
        # Mapping of trans_id -> new execute-bit value
128
121
            self._new_root = self.trans_id_tree_file_id(root_id)
129
122
        else:
130
123
            self._new_root = None
131
 
        # Indicator of whether the transform has been applied
 
124
        # Indictor of whether the transform has been applied
132
125
        self._done = False
133
126
        # A progress bar
134
127
        self._pb = pb
168
161
 
169
162
    def adjust_path(self, name, parent, trans_id):
170
163
        """Change the path that is assigned to a transaction id."""
171
 
        if parent is None:
172
 
            raise ValueError("Parent trans-id may not be None")
173
164
        if trans_id == self._new_root:
174
165
            raise CantMoveRoot
175
166
        self._new_name[trans_id] = name
176
167
        self._new_parent[trans_id] = parent
 
168
        if parent == ROOT_PARENT:
 
169
            if self._new_root is not None:
 
170
                raise ValueError("Cannot have multiple roots.")
 
171
            self._new_root = trans_id
177
172
 
178
173
    def adjust_root_path(self, name, parent):
179
174
        """Emulate moving the root by moving all children, instead.
207
202
        self.version_file(old_root_file_id, old_root)
208
203
        self.unversion_file(self._new_root)
209
204
 
210
 
    def fixup_new_roots(self):
211
 
        """Reinterpret requests to change the root directory
212
 
 
213
 
        Instead of creating a root directory, or moving an existing directory,
214
 
        all the attributes and children of the new root are applied to the
215
 
        existing root directory.
216
 
 
217
 
        This means that the old root trans-id becomes obsolete, so it is
218
 
        recommended only to invoke this after the root trans-id has become
219
 
        irrelevant.
220
 
        """
221
 
        new_roots = [k for k, v in self._new_parent.iteritems() if v is
222
 
                     ROOT_PARENT]
223
 
        if len(new_roots) < 1:
224
 
            return
225
 
        if len(new_roots) != 1:
226
 
            raise ValueError('A tree cannot have two roots!')
227
 
        if self._new_root is None:
228
 
            self._new_root = new_roots[0]
229
 
            return
230
 
        old_new_root = new_roots[0]
231
 
        # TODO: What to do if a old_new_root is present, but self._new_root is
232
 
        #       not listed as being removed? This code explicitly unversions
233
 
        #       the old root and versions it with the new file_id. Though that
234
 
        #       seems like an incomplete delta
235
 
 
236
 
        # unversion the new root's directory.
237
 
        file_id = self.final_file_id(old_new_root)
238
 
        if old_new_root in self._new_id:
239
 
            self.cancel_versioning(old_new_root)
240
 
        else:
241
 
            self.unversion_file(old_new_root)
242
 
        # if, at this stage, root still has an old file_id, zap it so we can
243
 
        # stick a new one in.
244
 
        if (self.tree_file_id(self._new_root) is not None and
245
 
            self._new_root not in self._removed_id):
246
 
            self.unversion_file(self._new_root)
247
 
        self.version_file(file_id, self._new_root)
248
 
 
249
 
        # Now move children of new root into old root directory.
250
 
        # Ensure all children are registered with the transaction, but don't
251
 
        # use directly-- some tree children have new parents
252
 
        list(self.iter_tree_children(old_new_root))
253
 
        # Move all children of new root into old root directory.
254
 
        for child in self.by_parent().get(old_new_root, []):
255
 
            self.adjust_path(self.final_name(child), self._new_root, child)
256
 
 
257
 
        # Ensure old_new_root has no directory.
258
 
        if old_new_root in self._new_contents:
259
 
            self.cancel_creation(old_new_root)
260
 
        else:
261
 
            self.delete_contents(old_new_root)
262
 
 
263
 
        # prevent deletion of root directory.
264
 
        if self._new_root in self._removed_contents:
265
 
            self.cancel_deletion(self._new_root)
266
 
 
267
 
        # destroy path info for old_new_root.
268
 
        del self._new_parent[old_new_root]
269
 
        del self._new_name[old_new_root]
270
 
 
271
205
    def trans_id_tree_file_id(self, inventory_id):
272
206
        """Determine the transaction id of a working tree file.
273
207
 
319
253
 
320
254
    def delete_contents(self, trans_id):
321
255
        """Schedule the contents of a path entry for deletion"""
322
 
        kind = self.tree_kind(trans_id)
323
 
        if kind is not None:
324
 
            self._removed_contents.add(trans_id)
 
256
        self.tree_kind(trans_id)
 
257
        self._removed_contents.add(trans_id)
325
258
 
326
259
    def cancel_deletion(self, trans_id):
327
260
        """Cancel a scheduled deletion"""
392
325
        changed_kind = set(self._removed_contents)
393
326
        changed_kind.intersection_update(self._new_contents)
394
327
        changed_kind.difference_update(new_ids)
395
 
        changed_kind = (t for t in changed_kind
396
 
                        if self.tree_kind(t) != self.final_kind(t))
 
328
        changed_kind = (t for t in changed_kind if self.tree_kind(t) !=
 
329
                        self.final_kind(t))
397
330
        new_ids.update(changed_kind)
398
331
        return sorted(FinalPaths(self).get_paths(new_ids))
399
332
 
400
333
    def final_kind(self, trans_id):
401
334
        """Determine the final file kind, after any changes applied.
402
335
 
403
 
        :return: None if the file does not exist/has no contents.  (It is
404
 
            conceivable that a path would be created without the corresponding
405
 
            contents insertion command)
 
336
        Raises NoSuchFile if the file does not exist/has no contents.
 
337
        (It is conceivable that a path would be created without the
 
338
        corresponding contents insertion command)
406
339
        """
407
340
        if trans_id in self._new_contents:
408
341
            return self._new_contents[trans_id]
409
342
        elif trans_id in self._removed_contents:
410
 
            return None
 
343
            raise NoSuchFile(None)
411
344
        else:
412
345
            return self.tree_kind(trans_id)
413
346
 
526
459
        for trans_id in self._removed_id:
527
460
            file_id = self.tree_file_id(trans_id)
528
461
            if file_id is not None:
529
 
                # XXX: This seems like something that should go via a different
530
 
                #      indirection.
531
462
                if self._tree.inventory[file_id].kind == 'directory':
532
463
                    parents.append(trans_id)
533
464
            elif self.tree_kind(trans_id) == 'directory':
537
468
            # ensure that all children are registered with the transaction
538
469
            list(self.iter_tree_children(parent_id))
539
470
 
540
 
    @deprecated_method(deprecated_in((2, 3, 0)))
541
471
    def has_named_child(self, by_parent, parent_id, name):
542
 
        return self._has_named_child(
543
 
            name, parent_id, known_children=by_parent.get(parent_id, []))
544
 
 
545
 
    def _has_named_child(self, name, parent_id, known_children):
546
 
        """Does a parent already have a name child.
547
 
 
548
 
        :param name: The searched for name.
549
 
 
550
 
        :param parent_id: The parent for which the check is made.
551
 
 
552
 
        :param known_children: The already known children. This should have
553
 
            been recently obtained from `self.by_parent.get(parent_id)`
554
 
            (or will be if None is passed).
555
 
        """
556
 
        if known_children is None:
557
 
            known_children = self.by_parent().get(parent_id, [])
558
 
        for child in known_children:
 
472
        try:
 
473
            children = by_parent[parent_id]
 
474
        except KeyError:
 
475
            children = []
 
476
        for child in children:
559
477
            if self.final_name(child) == name:
560
478
                return True
561
 
        parent_path = self._tree_id_paths.get(parent_id, None)
562
 
        if parent_path is None:
563
 
            # No parent... no children
 
479
        try:
 
480
            path = self._tree_id_paths[parent_id]
 
481
        except KeyError:
564
482
            return False
565
 
        child_path = joinpath(parent_path, name)
566
 
        child_id = self._tree_path_ids.get(child_path, None)
 
483
        childpath = joinpath(path, name)
 
484
        child_id = self._tree_path_ids.get(childpath)
567
485
        if child_id is None:
568
 
            # Not known by the tree transform yet, check the filesystem
569
 
            return osutils.lexists(self._tree.abspath(child_path))
 
486
            return lexists(self._tree.abspath(childpath))
570
487
        else:
571
 
            raise AssertionError('child_id is missing: %s, %s, %s'
572
 
                                 % (name, parent_id, child_id))
573
 
 
574
 
    def _available_backup_name(self, name, target_id):
575
 
        """Find an available backup name.
576
 
 
577
 
        :param name: The basename of the file.
578
 
 
579
 
        :param target_id: The directory trans_id where the backup should 
580
 
            be placed.
581
 
        """
582
 
        known_children = self.by_parent().get(target_id, [])
583
 
        return osutils.available_backup_name(
584
 
            name,
585
 
            lambda base: self._has_named_child(
586
 
                base, target_id, known_children))
 
488
            if self.final_parent(child_id) != parent_id:
 
489
                return False
 
490
            if child_id in self._removed_contents:
 
491
                # XXX What about dangling file-ids?
 
492
                return False
 
493
            else:
 
494
                return True
587
495
 
588
496
    def _parent_loops(self):
589
497
        """No entry should be its own ancestor"""
624
532
        """
625
533
        conflicts = []
626
534
        for trans_id in self._new_id.iterkeys():
627
 
            kind = self.final_kind(trans_id)
628
 
            if kind is None:
 
535
            try:
 
536
                kind = self.final_kind(trans_id)
 
537
            except NoSuchFile:
629
538
                conflicts.append(('versioning no contents', trans_id))
630
539
                continue
631
 
            if not inventory.InventoryEntry.versionable_kind(kind):
 
540
            if not InventoryEntry.versionable_kind(kind):
632
541
                conflicts.append(('versioning bad kind', trans_id, kind))
633
542
        return conflicts
634
543
 
645
554
            if self.final_file_id(trans_id) is None:
646
555
                conflicts.append(('unversioned executability', trans_id))
647
556
            else:
648
 
                if self.final_kind(trans_id) != "file":
 
557
                try:
 
558
                    non_file = self.final_kind(trans_id) != "file"
 
559
                except NoSuchFile:
 
560
                    non_file = True
 
561
                if non_file is True:
649
562
                    conflicts.append(('non-file executability', trans_id))
650
563
        return conflicts
651
564
 
653
566
        """Check for overwrites (not permitted on Win32)"""
654
567
        conflicts = []
655
568
        for trans_id in self._new_contents:
656
 
            if self.tree_kind(trans_id) is None:
 
569
            try:
 
570
                self.tree_kind(trans_id)
 
571
            except NoSuchFile:
657
572
                continue
658
573
            if trans_id not in self._removed_contents:
659
574
                conflicts.append(('overwrite', trans_id,
666
581
        if (self._new_name, self._new_parent) == ({}, {}):
667
582
            return conflicts
668
583
        for children in by_parent.itervalues():
669
 
            name_ids = []
670
 
            for child_tid in children:
671
 
                name = self.final_name(child_tid)
672
 
                if name is not None:
673
 
                    # Keep children only if they still exist in the end
674
 
                    if not self._case_sensitive_target:
675
 
                        name = name.lower()
676
 
                    name_ids.append((name, child_tid))
 
584
            name_ids = [(self.final_name(t), t) for t in children]
 
585
            if not self._case_sensitive_target:
 
586
                name_ids = [(n.lower(), t) for n, t in name_ids]
677
587
            name_ids.sort()
678
588
            last_name = None
679
589
            last_trans_id = None
680
590
            for name, trans_id in name_ids:
681
 
                kind = self.final_kind(trans_id)
 
591
                try:
 
592
                    kind = self.final_kind(trans_id)
 
593
                except NoSuchFile:
 
594
                    kind = None
682
595
                file_id = self.final_file_id(trans_id)
683
596
                if kind is None and file_id is None:
684
597
                    continue
703
616
        return conflicts
704
617
 
705
618
    def _parent_type_conflicts(self, by_parent):
706
 
        """Children must have a directory parent"""
 
619
        """parents must have directory 'contents'."""
707
620
        conflicts = []
708
621
        for parent_id, children in by_parent.iteritems():
709
622
            if parent_id is ROOT_PARENT:
710
623
                continue
711
 
            no_children = True
712
 
            for child_id in children:
713
 
                if self.final_kind(child_id) is not None:
714
 
                    no_children = False
715
 
                    break
716
 
            if no_children:
 
624
            if not self._any_contents(children):
717
625
                continue
718
 
            # There is at least a child, so we need an existing directory to
719
 
            # contain it.
720
 
            kind = self.final_kind(parent_id)
 
626
            for child in children:
 
627
                try:
 
628
                    self.final_kind(child)
 
629
                except NoSuchFile:
 
630
                    continue
 
631
            try:
 
632
                kind = self.final_kind(parent_id)
 
633
            except NoSuchFile:
 
634
                kind = None
721
635
            if kind is None:
722
 
                # The directory will be deleted
723
636
                conflicts.append(('missing parent', parent_id))
724
637
            elif kind != "directory":
725
 
                # Meh, we need a *directory* to put something in it
726
638
                conflicts.append(('non-directory parent', parent_id))
727
639
        return conflicts
728
640
 
 
641
    def _any_contents(self, trans_ids):
 
642
        """Return true if any of the trans_ids, will have contents."""
 
643
        for trans_id in trans_ids:
 
644
            try:
 
645
                kind = self.final_kind(trans_id)
 
646
            except NoSuchFile:
 
647
                continue
 
648
            return True
 
649
        return False
 
650
 
729
651
    def _set_executability(self, path, trans_id):
730
652
        """Set the executability of versioned files """
731
653
        if supports_executable():
753
675
        return trans_id
754
676
 
755
677
    def new_file(self, name, parent_id, contents, file_id=None,
756
 
                 executable=None, sha1=None):
 
678
                 executable=None):
757
679
        """Convenience method to create files.
758
680
 
759
681
        name is the name of the file to create.
766
688
        trans_id = self._new_entry(name, parent_id, file_id)
767
689
        # TODO: rather than scheduling a set_executable call,
768
690
        # have create_file create the file with the right mode.
769
 
        self.create_file(contents, trans_id, sha1=sha1)
 
691
        self.create_file(contents, trans_id)
770
692
        if executable is not None:
771
693
            self.set_executability(executable, trans_id)
772
694
        return trans_id
795
717
        self.create_symlink(target, trans_id)
796
718
        return trans_id
797
719
 
798
 
    def new_orphan(self, trans_id, parent_id):
799
 
        """Schedule an item to be orphaned.
800
 
 
801
 
        When a directory is about to be removed, its children, if they are not
802
 
        versioned are moved out of the way: they don't have a parent anymore.
803
 
 
804
 
        :param trans_id: The trans_id of the existing item.
805
 
        :param parent_id: The parent trans_id of the item.
806
 
        """
807
 
        raise NotImplementedError(self.new_orphan)
808
 
 
809
 
    def _get_potential_orphans(self, dir_id):
810
 
        """Find the potential orphans in a directory.
811
 
 
812
 
        A directory can't be safely deleted if there are versioned files in it.
813
 
        If all the contained files are unversioned then they can be orphaned.
814
 
 
815
 
        The 'None' return value means that the directory contains at least one
816
 
        versioned file and should not be deleted.
817
 
 
818
 
        :param dir_id: The directory trans id.
819
 
 
820
 
        :return: A list of the orphan trans ids or None if at least one
821
 
             versioned file is present.
822
 
        """
823
 
        orphans = []
824
 
        # Find the potential orphans, stop if one item should be kept
825
 
        for child_tid in self.by_parent()[dir_id]:
826
 
            if child_tid in self._removed_contents:
827
 
                # The child is removed as part of the transform. Since it was
828
 
                # versioned before, it's not an orphan
829
 
                continue
830
 
            elif self.final_file_id(child_tid) is None:
831
 
                # The child is not versioned
832
 
                orphans.append(child_tid)
833
 
            else:
834
 
                # We have a versioned file here, searching for orphans is
835
 
                # meaningless.
836
 
                orphans = None
837
 
                break
838
 
        return orphans
839
 
 
840
720
    def _affected_ids(self):
841
721
        """Return the set of transform ids affected by the transform"""
842
722
        trans_ids = set(self._removed_id)
901
781
        Return a (name, parent, kind, executable) tuple
902
782
        """
903
783
        to_name = self.final_name(to_trans_id)
904
 
        to_kind = self.final_kind(to_trans_id)
 
784
        try:
 
785
            to_kind = self.final_kind(to_trans_id)
 
786
        except NoSuchFile:
 
787
            to_kind = None
905
788
        to_parent = self.final_file_id(self.final_parent(to_trans_id))
906
789
        if to_trans_id in self._new_executability:
907
790
            to_executable = self._new_executability[to_trans_id]
976
859
    def get_preview_tree(self):
977
860
        """Return a tree representing the result of the transform.
978
861
 
979
 
        The tree is a snapshot, and altering the TreeTransform will invalidate
980
 
        it.
 
862
        This tree only supports the subset of Tree functionality required
 
863
        by show_diff_trees.  It must only be compared to tt._tree.
981
864
        """
982
865
        return _PreviewTree(self)
983
866
 
984
 
    def commit(self, branch, message, merge_parents=None, strict=False,
985
 
               timestamp=None, timezone=None, committer=None, authors=None,
986
 
               revprops=None, revision_id=None):
 
867
    def commit(self, branch, message, merge_parents=None, strict=False):
987
868
        """Commit the result of this TreeTransform to a branch.
988
869
 
989
870
        :param branch: The branch to commit to.
990
871
        :param message: The message to attach to the commit.
991
 
        :param merge_parents: Additional parent revision-ids specified by
992
 
            pending merges.
993
 
        :param strict: If True, abort the commit if there are unversioned
994
 
            files.
995
 
        :param timestamp: if not None, seconds-since-epoch for the time and
996
 
            date.  (May be a float.)
997
 
        :param timezone: Optional timezone for timestamp, as an offset in
998
 
            seconds.
999
 
        :param committer: Optional committer in email-id format.
1000
 
            (e.g. "J Random Hacker <jrandom@example.com>")
1001
 
        :param authors: Optional list of authors in email-id format.
1002
 
        :param revprops: Optional dictionary of revision properties.
1003
 
        :param revision_id: Optional revision id.  (Specifying a revision-id
1004
 
            may reduce performance for some non-native formats.)
 
872
        :param merge_parents: Additional parents specified by pending merges.
1005
873
        :return: The revision_id of the revision committed.
1006
874
        """
1007
875
        self._check_malformed()
1024
892
        if self._tree.get_revision_id() != last_rev_id:
1025
893
            raise ValueError('TreeTransform not based on branch basis: %s' %
1026
894
                             self._tree.get_revision_id())
1027
 
        revprops = commit.Commit.update_revprops(revprops, branch, authors)
1028
 
        builder = branch.get_commit_builder(parent_ids,
1029
 
                                            timestamp=timestamp,
1030
 
                                            timezone=timezone,
1031
 
                                            committer=committer,
1032
 
                                            revprops=revprops,
1033
 
                                            revision_id=revision_id)
 
895
        builder = branch.get_commit_builder(parent_ids)
1034
896
        preview = self.get_preview_tree()
1035
897
        list(builder.record_iter_changes(preview, last_rev_id,
1036
898
                                         self.iter_changes()))
1138
1000
class DiskTreeTransform(TreeTransformBase):
1139
1001
    """Tree transform storing its contents on disk."""
1140
1002
 
1141
 
    def __init__(self, tree, limbodir, pb=None,
 
1003
    def __init__(self, tree, limbodir, pb=DummyProgress(),
1142
1004
                 case_sensitive=True):
1143
1005
        """Constructor.
1144
1006
        :param tree: The tree that will be transformed, but not necessarily
1145
1007
            the output tree.
1146
1008
        :param limbodir: A directory where new files can be stored until
1147
1009
            they are installed in their proper places
1148
 
        :param pb: ignored
 
1010
        :param pb: A ProgressBar indicating how much progress is being made
1149
1011
        :param case_sensitive: If True, the target of the transform is
1150
1012
            case sensitive, not just case preserving.
1151
1013
        """
1161
1023
        self._limbo_children_names = {}
1162
1024
        # List of transform ids that need to be renamed from limbo into place
1163
1025
        self._needs_rename = set()
1164
 
        self._creation_mtime = None
1165
1026
 
1166
1027
    def finalize(self):
1167
1028
        """Release the working tree lock, if held, clean up limbo dir.
1193
1054
    def _limbo_name(self, trans_id):
1194
1055
        """Generate the limbo name of a file"""
1195
1056
        limbo_name = self._limbo_files.get(trans_id)
1196
 
        if limbo_name is None:
1197
 
            limbo_name = self._generate_limbo_path(trans_id)
1198
 
            self._limbo_files[trans_id] = limbo_name
 
1057
        if limbo_name is not None:
 
1058
            return limbo_name
 
1059
        parent = self._new_parent.get(trans_id)
 
1060
        # if the parent directory is already in limbo (e.g. when building a
 
1061
        # tree), choose a limbo name inside the parent, to reduce further
 
1062
        # renames.
 
1063
        use_direct_path = False
 
1064
        if self._new_contents.get(parent) == 'directory':
 
1065
            filename = self._new_name.get(trans_id)
 
1066
            if filename is not None:
 
1067
                if parent not in self._limbo_children:
 
1068
                    self._limbo_children[parent] = set()
 
1069
                    self._limbo_children_names[parent] = {}
 
1070
                    use_direct_path = True
 
1071
                # the direct path can only be used if no other file has
 
1072
                # already taken this pathname, i.e. if the name is unused, or
 
1073
                # if it is already associated with this trans_id.
 
1074
                elif self._case_sensitive_target:
 
1075
                    if (self._limbo_children_names[parent].get(filename)
 
1076
                        in (trans_id, None)):
 
1077
                        use_direct_path = True
 
1078
                else:
 
1079
                    for l_filename, l_trans_id in\
 
1080
                        self._limbo_children_names[parent].iteritems():
 
1081
                        if l_trans_id == trans_id:
 
1082
                            continue
 
1083
                        if l_filename.lower() == filename.lower():
 
1084
                            break
 
1085
                    else:
 
1086
                        use_direct_path = True
 
1087
 
 
1088
        if use_direct_path:
 
1089
            limbo_name = pathjoin(self._limbo_files[parent], filename)
 
1090
            self._limbo_children[parent].add(trans_id)
 
1091
            self._limbo_children_names[parent][filename] = trans_id
 
1092
        else:
 
1093
            limbo_name = pathjoin(self._limbodir, trans_id)
 
1094
            self._needs_rename.add(trans_id)
 
1095
        self._limbo_files[trans_id] = limbo_name
1199
1096
        return limbo_name
1200
1097
 
1201
 
    def _generate_limbo_path(self, trans_id):
1202
 
        """Generate a limbo path using the trans_id as the relative path.
1203
 
 
1204
 
        This is suitable as a fallback, and when the transform should not be
1205
 
        sensitive to the path encoding of the limbo directory.
1206
 
        """
1207
 
        self._needs_rename.add(trans_id)
1208
 
        return pathjoin(self._limbodir, trans_id)
1209
 
 
1210
1098
    def adjust_path(self, name, parent, trans_id):
1211
1099
        previous_parent = self._new_parent.get(trans_id)
1212
1100
        previous_name = self._new_name.get(trans_id)
1214
1102
        if (trans_id in self._limbo_files and
1215
1103
            trans_id not in self._needs_rename):
1216
1104
            self._rename_in_limbo([trans_id])
1217
 
            if previous_parent != parent:
1218
 
                self._limbo_children[previous_parent].remove(trans_id)
1219
 
            if previous_parent != parent or previous_name != name:
1220
 
                del self._limbo_children_names[previous_parent][previous_name]
 
1105
            self._limbo_children[previous_parent].remove(trans_id)
 
1106
            del self._limbo_children_names[previous_parent][previous_name]
1221
1107
 
1222
1108
    def _rename_in_limbo(self, trans_ids):
1223
1109
        """Fix limbo names so that the right final path is produced.
1236
1122
                continue
1237
1123
            new_path = self._limbo_name(trans_id)
1238
1124
            os.rename(old_path, new_path)
1239
 
            for descendant in self._limbo_descendants(trans_id):
1240
 
                desc_path = self._limbo_files[descendant]
1241
 
                desc_path = new_path + desc_path[len(old_path):]
1242
 
                self._limbo_files[descendant] = desc_path
1243
 
 
1244
 
    def _limbo_descendants(self, trans_id):
1245
 
        """Return the set of trans_ids whose limbo paths descend from this."""
1246
 
        descendants = set(self._limbo_children.get(trans_id, []))
1247
 
        for descendant in list(descendants):
1248
 
            descendants.update(self._limbo_descendants(descendant))
1249
 
        return descendants
1250
 
 
1251
 
    def create_file(self, contents, trans_id, mode_id=None, sha1=None):
 
1125
 
 
1126
    def create_file(self, contents, trans_id, mode_id=None):
1252
1127
        """Schedule creation of a new file.
1253
1128
 
1254
 
        :seealso: new_file.
1255
 
 
1256
 
        :param contents: an iterator of strings, all of which will be written
1257
 
            to the target destination.
1258
 
        :param trans_id: TreeTransform handle
1259
 
        :param mode_id: If not None, force the mode of the target file to match
1260
 
            the mode of the object referenced by mode_id.
1261
 
            Otherwise, we will try to preserve mode bits of an existing file.
1262
 
        :param sha1: If the sha1 of this content is already known, pass it in.
1263
 
            We can use it to prevent future sha1 computations.
 
1129
        See also new_file.
 
1130
 
 
1131
        Contents is an iterator of strings, all of which will be written
 
1132
        to the target destination.
 
1133
 
 
1134
        New file takes the permissions of any existing file with that id,
 
1135
        unless mode_id is specified.
1264
1136
        """
1265
1137
        name = self._limbo_name(trans_id)
1266
1138
        f = open(name, 'wb')
1273
1145
                f.close()
1274
1146
                os.unlink(name)
1275
1147
                raise
 
1148
 
1276
1149
            f.writelines(contents)
1277
1150
        finally:
1278
1151
            f.close()
1279
 
        self._set_mtime(name)
1280
1152
        self._set_mode(trans_id, mode_id, S_ISREG)
1281
 
        # It is unfortunate we have to use lstat instead of fstat, but we just
1282
 
        # used utime and chmod on the file, so we need the accurate final
1283
 
        # details.
1284
 
        if sha1 is not None:
1285
 
            self._observed_sha1s[trans_id] = (sha1, osutils.lstat(name))
1286
1153
 
1287
1154
    def _read_file_chunks(self, trans_id):
1288
1155
        cur_file = open(self._limbo_name(trans_id), 'rb')
1294
1161
    def _read_symlink_target(self, trans_id):
1295
1162
        return os.readlink(self._limbo_name(trans_id))
1296
1163
 
1297
 
    def _set_mtime(self, path):
1298
 
        """All files that are created get the same mtime.
1299
 
 
1300
 
        This time is set by the first object to be created.
1301
 
        """
1302
 
        if self._creation_mtime is None:
1303
 
            self._creation_mtime = time.time()
1304
 
        os.utime(path, (self._creation_mtime, self._creation_mtime))
1305
 
 
1306
1164
    def create_hardlink(self, path, trans_id):
1307
1165
        """Schedule creation of a hard link"""
1308
1166
        name = self._limbo_name(trans_id)
1347
1205
    def cancel_creation(self, trans_id):
1348
1206
        """Cancel the creation of new file contents."""
1349
1207
        del self._new_contents[trans_id]
1350
 
        if trans_id in self._observed_sha1s:
1351
 
            del self._observed_sha1s[trans_id]
1352
1208
        children = self._limbo_children.get(trans_id)
1353
1209
        # if this is a limbo directory with children, move them before removing
1354
1210
        # the directory
1358
1214
            del self._limbo_children_names[trans_id]
1359
1215
        delete_any(self._limbo_name(trans_id))
1360
1216
 
1361
 
    def new_orphan(self, trans_id, parent_id):
1362
 
        # FIXME: There is no tree config, so we use the branch one (it's weird
1363
 
        # to define it this way as orphaning can only occur in a working tree,
1364
 
        # but that's all we have (for now). It will find the option in
1365
 
        # locations.conf or bazaar.conf though) -- vila 20100916
1366
 
        conf = self._tree.branch.get_config()
1367
 
        conf_var_name = 'bzr.transform.orphan_policy'
1368
 
        orphan_policy = conf.get_user_option(conf_var_name)
1369
 
        default_policy = orphaning_registry.default_key
1370
 
        if orphan_policy is None:
1371
 
            orphan_policy = default_policy
1372
 
        if orphan_policy not in orphaning_registry:
1373
 
            trace.warning('%s (from %s) is not a known policy, defaulting '
1374
 
                'to %s' % (orphan_policy, conf_var_name, default_policy))
1375
 
            orphan_policy = default_policy
1376
 
        handle_orphan = orphaning_registry.get(orphan_policy)
1377
 
        handle_orphan(self, trans_id, parent_id)
1378
 
 
1379
 
 
1380
 
class OrphaningError(errors.BzrError):
1381
 
 
1382
 
    # Only bugs could lead to such exception being seen by the user
1383
 
    internal_error = True
1384
 
    _fmt = "Error while orphaning %s in %s directory"
1385
 
 
1386
 
    def __init__(self, orphan, parent):
1387
 
        errors.BzrError.__init__(self)
1388
 
        self.orphan = orphan
1389
 
        self.parent = parent
1390
 
 
1391
 
 
1392
 
class OrphaningForbidden(OrphaningError):
1393
 
 
1394
 
    _fmt = "Policy: %s doesn't allow creating orphans."
1395
 
 
1396
 
    def __init__(self, policy):
1397
 
        errors.BzrError.__init__(self)
1398
 
        self.policy = policy
1399
 
 
1400
 
 
1401
 
def move_orphan(tt, orphan_id, parent_id):
1402
 
    """See TreeTransformBase.new_orphan.
1403
 
 
1404
 
    This creates a new orphan in the `bzr-orphans` dir at the root of the
1405
 
    `TreeTransform`.
1406
 
 
1407
 
    :param tt: The TreeTransform orphaning `trans_id`.
1408
 
 
1409
 
    :param orphan_id: The trans id that should be orphaned.
1410
 
 
1411
 
    :param parent_id: The orphan parent trans id.
1412
 
    """
1413
 
    # Add the orphan dir if it doesn't exist
1414
 
    orphan_dir_basename = 'bzr-orphans'
1415
 
    od_id = tt.trans_id_tree_path(orphan_dir_basename)
1416
 
    if tt.final_kind(od_id) is None:
1417
 
        tt.create_directory(od_id)
1418
 
    parent_path = tt._tree_id_paths[parent_id]
1419
 
    # Find a name that doesn't exist yet in the orphan dir
1420
 
    actual_name = tt.final_name(orphan_id)
1421
 
    new_name = tt._available_backup_name(actual_name, od_id)
1422
 
    tt.adjust_path(new_name, od_id, orphan_id)
1423
 
    trace.warning('%s has been orphaned in %s'
1424
 
                  % (joinpath(parent_path, actual_name), orphan_dir_basename))
1425
 
 
1426
 
 
1427
 
def refuse_orphan(tt, orphan_id, parent_id):
1428
 
    """See TreeTransformBase.new_orphan.
1429
 
 
1430
 
    This refuses to create orphan, letting the caller handle the conflict.
1431
 
    """
1432
 
    raise OrphaningForbidden('never')
1433
 
 
1434
 
 
1435
 
orphaning_registry = registry.Registry()
1436
 
orphaning_registry.register(
1437
 
    'conflict', refuse_orphan,
1438
 
    'Leave orphans in place and create a conflict on the directory.')
1439
 
orphaning_registry.register(
1440
 
    'move', move_orphan,
1441
 
    'Move orphans into the bzr-orphans directory.')
1442
 
orphaning_registry._set_default_key('conflict')
1443
 
 
1444
1217
 
1445
1218
class TreeTransform(DiskTreeTransform):
1446
1219
    """Represent a tree transformation.
1507
1280
    FileMover does not delete files until it is sure that a rollback will not
1508
1281
    happen.
1509
1282
    """
1510
 
    def __init__(self, tree, pb=None):
 
1283
    def __init__(self, tree, pb=DummyProgress()):
1511
1284
        """Note: a tree_write lock is taken on the tree.
1512
1285
 
1513
1286
        Use TreeTransform.finalize() to release the lock (can be omitted if
1564
1337
    def tree_kind(self, trans_id):
1565
1338
        """Determine the file kind in the working tree.
1566
1339
 
1567
 
        :returns: The file kind or None if the file does not exist
 
1340
        Raises NoSuchFile if the file does not exist
1568
1341
        """
1569
1342
        path = self._tree_id_paths.get(trans_id)
1570
1343
        if path is None:
1571
 
            return None
 
1344
            raise NoSuchFile(None)
1572
1345
        try:
1573
1346
            return file_kind(self._tree.abspath(path))
1574
 
        except errors.NoSuchFile:
1575
 
            return None
 
1347
        except OSError, e:
 
1348
            if e.errno != errno.ENOENT:
 
1349
                raise
 
1350
            else:
 
1351
                raise NoSuchFile(path)
1576
1352
 
1577
1353
    def _set_mode(self, trans_id, mode_id, typefunc):
1578
1354
        """Set the mode of new file contents.
1620
1396
                continue
1621
1397
            yield self.trans_id_tree_path(childpath)
1622
1398
 
1623
 
    def _generate_limbo_path(self, trans_id):
1624
 
        """Generate a limbo path using the final path if possible.
1625
 
 
1626
 
        This optimizes the performance of applying the tree transform by
1627
 
        avoiding renames.  These renames can be avoided only when the parent
1628
 
        directory is already scheduled for creation.
1629
 
 
1630
 
        If the final path cannot be used, falls back to using the trans_id as
1631
 
        the relpath.
1632
 
        """
1633
 
        parent = self._new_parent.get(trans_id)
1634
 
        # if the parent directory is already in limbo (e.g. when building a
1635
 
        # tree), choose a limbo name inside the parent, to reduce further
1636
 
        # renames.
1637
 
        use_direct_path = False
1638
 
        if self._new_contents.get(parent) == 'directory':
1639
 
            filename = self._new_name.get(trans_id)
1640
 
            if filename is not None:
1641
 
                if parent not in self._limbo_children:
1642
 
                    self._limbo_children[parent] = set()
1643
 
                    self._limbo_children_names[parent] = {}
1644
 
                    use_direct_path = True
1645
 
                # the direct path can only be used if no other file has
1646
 
                # already taken this pathname, i.e. if the name is unused, or
1647
 
                # if it is already associated with this trans_id.
1648
 
                elif self._case_sensitive_target:
1649
 
                    if (self._limbo_children_names[parent].get(filename)
1650
 
                        in (trans_id, None)):
1651
 
                        use_direct_path = True
1652
 
                else:
1653
 
                    for l_filename, l_trans_id in\
1654
 
                        self._limbo_children_names[parent].iteritems():
1655
 
                        if l_trans_id == trans_id:
1656
 
                            continue
1657
 
                        if l_filename.lower() == filename.lower():
1658
 
                            break
1659
 
                    else:
1660
 
                        use_direct_path = True
1661
 
 
1662
 
        if not use_direct_path:
1663
 
            return DiskTreeTransform._generate_limbo_path(self, trans_id)
1664
 
 
1665
 
        limbo_name = pathjoin(self._limbo_files[parent], filename)
1666
 
        self._limbo_children[parent].add(trans_id)
1667
 
        self._limbo_children_names[parent][filename] = trans_id
1668
 
        return limbo_name
1669
 
 
1670
 
 
1671
1399
    def apply(self, no_conflicts=False, precomputed_delta=None, _mover=None):
1672
1400
        """Apply all changes to the inventory and filesystem.
1673
1401
 
1684
1412
        """
1685
1413
        if not no_conflicts:
1686
1414
            self._check_malformed()
1687
 
        child_pb = ui.ui_factory.nested_progress_bar()
 
1415
        child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1688
1416
        try:
1689
1417
            if precomputed_delta is None:
1690
1418
                child_pb.update('Apply phase', 0, 2)
1710
1438
        finally:
1711
1439
            child_pb.finished()
1712
1440
        self._tree.apply_inventory_delta(inventory_delta)
1713
 
        self._apply_observed_sha1s()
1714
1441
        self._done = True
1715
1442
        self.finalize()
1716
1443
        return _TransformResults(modified_paths, self.rename_count)
1718
1445
    def _generate_inventory_delta(self):
1719
1446
        """Generate an inventory delta for the current transform."""
1720
1447
        inventory_delta = []
1721
 
        child_pb = ui.ui_factory.nested_progress_bar()
 
1448
        child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1722
1449
        new_paths = self._inventory_altered()
1723
1450
        total_entries = len(new_paths) + len(self._removed_id)
1724
1451
        try:
1748
1475
                if file_id is None:
1749
1476
                    continue
1750
1477
                needs_entry = False
1751
 
                kind = self.final_kind(trans_id)
1752
 
                if kind is None:
 
1478
                try:
 
1479
                    kind = self.final_kind(trans_id)
 
1480
                except NoSuchFile:
1753
1481
                    kind = self._tree.stored_kind(file_id)
1754
1482
                parent_trans_id = self.final_parent(trans_id)
1755
1483
                parent_file_id = new_path_file_ids.get(parent_trans_id)
1786
1514
        """
1787
1515
        tree_paths = list(self._tree_path_ids.iteritems())
1788
1516
        tree_paths.sort(reverse=True)
1789
 
        child_pb = ui.ui_factory.nested_progress_bar()
 
1517
        child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1790
1518
        try:
1791
1519
            for num, data in enumerate(tree_paths):
1792
1520
                path, trans_id = data
1793
1521
                child_pb.update('removing file', num, len(tree_paths))
1794
1522
                full_path = self._tree.abspath(path)
1795
1523
                if trans_id in self._removed_contents:
1796
 
                    delete_path = os.path.join(self._deletiondir, trans_id)
1797
 
                    mover.pre_delete(full_path, delete_path)
1798
 
                elif (trans_id in self._new_name
1799
 
                      or trans_id in self._new_parent):
 
1524
                    mover.pre_delete(full_path, os.path.join(self._deletiondir,
 
1525
                                     trans_id))
 
1526
                elif trans_id in self._new_name or trans_id in \
 
1527
                    self._new_parent:
1800
1528
                    try:
1801
1529
                        mover.rename(full_path, self._limbo_name(trans_id))
1802
 
                    except errors.TransformRenameFailed, e:
 
1530
                    except OSError, e:
1803
1531
                        if e.errno != errno.ENOENT:
1804
1532
                            raise
1805
1533
                    else:
1821
1549
        modified_paths = []
1822
1550
        new_path_file_ids = dict((t, self.final_file_id(t)) for p, t in
1823
1551
                                 new_paths)
1824
 
        child_pb = ui.ui_factory.nested_progress_bar()
 
1552
        child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1825
1553
        try:
1826
1554
            for num, (path, trans_id) in enumerate(new_paths):
1827
1555
                if (num % 10) == 0:
1830
1558
                if trans_id in self._needs_rename:
1831
1559
                    try:
1832
1560
                        mover.rename(self._limbo_name(trans_id), full_path)
1833
 
                    except errors.TransformRenameFailed, e:
 
1561
                    except OSError, e:
1834
1562
                        # We may be renaming a dangling inventory id
1835
1563
                        if e.errno != errno.ENOENT:
1836
1564
                            raise
1837
1565
                    else:
1838
1566
                        self.rename_count += 1
1839
 
                    # TODO: if trans_id in self._observed_sha1s, we should
1840
 
                    #       re-stat the final target, since ctime will be
1841
 
                    #       updated by the change.
1842
1567
                if (trans_id in self._new_contents or
1843
1568
                    self.path_changed(trans_id)):
1844
1569
                    if trans_id in self._new_contents:
1845
1570
                        modified_paths.append(full_path)
1846
1571
                if trans_id in self._new_executability:
1847
1572
                    self._set_executability(path, trans_id)
1848
 
                if trans_id in self._observed_sha1s:
1849
 
                    o_sha1, o_st_val = self._observed_sha1s[trans_id]
1850
 
                    st = osutils.lstat(full_path)
1851
 
                    self._observed_sha1s[trans_id] = (o_sha1, st)
1852
1573
        finally:
1853
1574
            child_pb.finished()
1854
1575
        self._new_contents.clear()
1855
1576
        return modified_paths
1856
1577
 
1857
 
    def _apply_observed_sha1s(self):
1858
 
        """After we have finished renaming everything, update observed sha1s
1859
 
 
1860
 
        This has to be done after self._tree.apply_inventory_delta, otherwise
1861
 
        it doesn't know anything about the files we are updating. Also, we want
1862
 
        to do this as late as possible, so that most entries end up cached.
1863
 
        """
1864
 
        # TODO: this doesn't update the stat information for directories. So
1865
 
        #       the first 'bzr status' will still need to rewrite
1866
 
        #       .bzr/checkout/dirstate. However, we at least don't need to
1867
 
        #       re-read all of the files.
1868
 
        # TODO: If the operation took a while, we could do a time.sleep(3) here
1869
 
        #       to allow the clock to tick over and ensure we won't have any
1870
 
        #       problems. (we could observe start time, and finish time, and if
1871
 
        #       it is less than eg 10% overhead, add a sleep call.)
1872
 
        paths = FinalPaths(self)
1873
 
        for trans_id, observed in self._observed_sha1s.iteritems():
1874
 
            path = paths.get_path(trans_id)
1875
 
            # We could get the file_id, but dirstate prefers to use the path
1876
 
            # anyway, and it is 'cheaper' to determine.
1877
 
            # file_id = self._new_id[trans_id]
1878
 
            self._tree._observed_sha1(None, path, observed)
1879
 
 
1880
1578
 
1881
1579
class TransformPreview(DiskTreeTransform):
1882
1580
    """A TreeTransform for generating preview trees.
1886
1584
    unversioned files in the input tree.
1887
1585
    """
1888
1586
 
1889
 
    def __init__(self, tree, pb=None, case_sensitive=True):
 
1587
    def __init__(self, tree, pb=DummyProgress(), case_sensitive=True):
1890
1588
        tree.lock_read()
1891
1589
        limbodir = osutils.mkdtemp(prefix='bzr-limbo-')
1892
1590
        DiskTreeTransform.__init__(self, tree, limbodir, pb, case_sensitive)
1897
1595
    def tree_kind(self, trans_id):
1898
1596
        path = self._tree_id_paths.get(trans_id)
1899
1597
        if path is None:
1900
 
            return None
 
1598
            raise NoSuchFile(None)
1901
1599
        file_id = self._tree.path2id(path)
1902
 
        try:
1903
 
            return self._tree.kind(file_id)
1904
 
        except errors.NoSuchFile:
1905
 
            return None
 
1600
        return self._tree.kind(file_id)
1906
1601
 
1907
1602
    def _set_mode(self, trans_id, mode_id, typefunc):
1908
1603
        """Set the mode of new file contents.
1928
1623
            childpath = joinpath(path, child)
1929
1624
            yield self.trans_id_tree_path(childpath)
1930
1625
 
1931
 
    def new_orphan(self, trans_id, parent_id):
1932
 
        raise NotImplementedError(self.new_orphan)
1933
 
 
1934
 
 
1935
 
class _PreviewTree(tree.InventoryTree):
 
1626
 
 
1627
class _PreviewTree(tree.Tree):
1936
1628
    """Partial implementation of Tree to support show_diff_trees"""
1937
1629
 
1938
1630
    def __init__(self, transform):
1943
1635
        self._all_children_cache = {}
1944
1636
        self._path2trans_id_cache = {}
1945
1637
        self._final_name_cache = {}
1946
 
        self._iter_changes_cache = dict((c[0], c) for c in
1947
 
                                        self._transform.iter_changes())
 
1638
 
 
1639
    def _changes(self, file_id):
 
1640
        for changes in self._transform.iter_changes():
 
1641
            if changes[0] == file_id:
 
1642
                return changes
1948
1643
 
1949
1644
    def _content_change(self, file_id):
1950
1645
        """Return True if the content of this file changed"""
1951
 
        changes = self._iter_changes_cache.get(file_id)
 
1646
        changes = self._changes(file_id)
1952
1647
        # changes[2] is true if the file content changed.  See
1953
1648
        # InterTree.iter_changes.
1954
1649
        return (changes is not None and changes[2])
1967
1662
                yield self._get_repository().revision_tree(revision_id)
1968
1663
 
1969
1664
    def _get_file_revision(self, file_id, vf, tree_revision):
1970
 
        parent_keys = [(file_id, t.get_file_revision(file_id)) for t in
 
1665
        parent_keys = [(file_id, self._file_revision(t, file_id)) for t in
1971
1666
                       self._iter_parent_trees()]
1972
1667
        vf.add_lines((file_id, tree_revision), parent_keys,
1973
 
                     self.get_file_lines(file_id))
 
1668
                     self.get_file(file_id).readlines())
1974
1669
        repo = self._get_repository()
1975
1670
        base_vf = repo.texts
1976
1671
        if base_vf not in vf.fallback_versionedfiles:
1998
1693
            executable = self.is_executable(file_id, path)
1999
1694
        return kind, executable, None
2000
1695
 
2001
 
    def is_locked(self):
2002
 
        return False
2003
 
 
2004
1696
    def lock_read(self):
2005
1697
        # Perhaps in theory, this should lock the TreeTransform?
2006
 
        return self
 
1698
        pass
2007
1699
 
2008
1700
    def unlock(self):
2009
1701
        pass
2107
1799
            if (specific_file_ids is not None
2108
1800
                and file_id not in specific_file_ids):
2109
1801
                continue
2110
 
            kind = self._transform.final_kind(trans_id)
2111
 
            if kind is None:
 
1802
            try:
 
1803
                kind = self._transform.final_kind(trans_id)
 
1804
            except NoSuchFile:
2112
1805
                kind = self._transform._tree.stored_kind(file_id)
2113
1806
            new_entry = inventory.make_entry(
2114
1807
                kind,
2191
1884
    def get_file_mtime(self, file_id, path=None):
2192
1885
        """See Tree.get_file_mtime"""
2193
1886
        if not self._content_change(file_id):
2194
 
            return self._transform._tree.get_file_mtime(file_id)
 
1887
            return self._transform._tree.get_file_mtime(file_id, path)
2195
1888
        return self._stat_limbo_file(file_id).st_mtime
2196
1889
 
2197
1890
    def _file_size(self, entry, stat_value):
2251
1944
                statval = os.lstat(limbo_name)
2252
1945
                size = statval.st_size
2253
1946
                if not supports_executable():
2254
 
                    executable = False
 
1947
                    executable = None
2255
1948
                else:
2256
1949
                    executable = statval.st_mode & S_IEXEC
2257
1950
            else:
2259
1952
                executable = None
2260
1953
            if kind == 'symlink':
2261
1954
                link_or_sha1 = os.readlink(limbo_name).decode(osutils._fs_enc)
2262
 
        executable = tt._new_executability.get(trans_id, executable)
 
1955
        if supports_executable():
 
1956
            executable = tt._new_executability.get(trans_id, executable)
2263
1957
        return kind, size, executable, link_or_sha1
2264
1958
 
2265
1959
    def iter_changes(self, from_tree, include_unchanged=False,
2296
1990
 
2297
1991
    def annotate_iter(self, file_id,
2298
1992
                      default_revision=_mod_revision.CURRENT_REVISION):
2299
 
        changes = self._iter_changes_cache.get(file_id)
 
1993
        changes = self._changes(file_id)
2300
1994
        if changes is None:
2301
1995
            get_old = True
2302
1996
        else:
2346
2040
                path_from_root = self._final_paths.get_path(child_id)
2347
2041
                basename = self._transform.final_name(child_id)
2348
2042
                file_id = self._transform.final_file_id(child_id)
2349
 
                kind  = self._transform.final_kind(child_id)
2350
 
                if kind is not None:
 
2043
                try:
 
2044
                    kind = self._transform.final_kind(child_id)
2351
2045
                    versioned_kind = kind
2352
 
                else:
 
2046
                except NoSuchFile:
2353
2047
                    kind = 'unknown'
2354
2048
                    versioned_kind = self._transform._tree.stored_kind(file_id)
2355
2049
                if versioned_kind == 'directory':
2468
2162
    for num, _unused in enumerate(wt.all_file_ids()):
2469
2163
        if num > 0:  # more than just a root
2470
2164
            raise errors.WorkingTreeAlreadyPopulated(base=wt.basedir)
 
2165
    existing_files = set()
 
2166
    for dir, files in wt.walkdirs():
 
2167
        existing_files.update(f[0] for f in files)
2471
2168
    file_trans_id = {}
2472
 
    top_pb = ui.ui_factory.nested_progress_bar()
 
2169
    top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
2473
2170
    pp = ProgressPhase("Build phase", 2, top_pb)
2474
2171
    if tree.inventory.root is not None:
2475
2172
        # This is kind of a hack: we should be altering the root
2488
2185
        pp.next_phase()
2489
2186
        file_trans_id[wt.get_root_id()] = \
2490
2187
            tt.trans_id_tree_file_id(wt.get_root_id())
2491
 
        pb = ui.ui_factory.nested_progress_bar()
 
2188
        pb = bzrlib.ui.ui_factory.nested_progress_bar()
2492
2189
        try:
2493
2190
            deferred_contents = []
2494
2191
            num = 0
2497
2194
                precomputed_delta = []
2498
2195
            else:
2499
2196
                precomputed_delta = None
2500
 
            # Check if tree inventory has content. If so, we populate
2501
 
            # existing_files with the directory content. If there are no
2502
 
            # entries we skip populating existing_files as its not used.
2503
 
            # This improves performance and unncessary work on large
2504
 
            # directory trees. (#501307)
2505
 
            if total > 0:
2506
 
                existing_files = set()
2507
 
                for dir, files in wt.walkdirs():
2508
 
                    existing_files.update(f[0] for f in files)
2509
2197
            for num, (tree_path, entry) in \
2510
2198
                enumerate(tree.inventory.iter_entries_by_dir()):
2511
2199
                pb.update("Building tree", num - len(deferred_contents), total)
2541
2229
                    executable = tree.is_executable(file_id, tree_path)
2542
2230
                    if executable:
2543
2231
                        tt.set_executability(executable, trans_id)
2544
 
                    trans_data = (trans_id, tree_path, entry.text_sha1)
 
2232
                    trans_data = (trans_id, tree_path)
2545
2233
                    deferred_contents.append((file_id, trans_data))
2546
2234
                else:
2547
2235
                    file_trans_id[file_id] = new_by_entry(tt, entry, parent_id,
2563
2251
            precomputed_delta = None
2564
2252
        conflicts = cook_conflicts(raw_conflicts, tt)
2565
2253
        for conflict in conflicts:
2566
 
            trace.warning(conflict)
 
2254
            warning(conflict)
2567
2255
        try:
2568
2256
            wt.add_conflicts(conflicts)
2569
2257
        except errors.UnsupportedOperation:
2584
2272
        new_desired_files = desired_files
2585
2273
    else:
2586
2274
        iter = accelerator_tree.iter_changes(tree, include_unchanged=True)
2587
 
        unchanged = [(f, p[1]) for (f, p, c, v, d, n, k, e)
2588
 
                     in iter if not (c or e[0] != e[1])]
2589
 
        if accelerator_tree.supports_content_filtering():
2590
 
            unchanged = [(f, p) for (f, p) in unchanged
2591
 
                         if not accelerator_tree.iter_search_rules([p]).next()]
2592
 
        unchanged = dict(unchanged)
 
2275
        unchanged = dict((f, p[1]) for (f, p, c, v, d, n, k, e)
 
2276
                         in iter if not (c or e[0] != e[1]))
2593
2277
        new_desired_files = []
2594
2278
        count = 0
2595
 
        for file_id, (trans_id, tree_path, text_sha1) in desired_files:
 
2279
        for file_id, (trans_id, tree_path) in desired_files:
2596
2280
            accelerator_path = unchanged.get(file_id)
2597
2281
            if accelerator_path is None:
2598
 
                new_desired_files.append((file_id,
2599
 
                    (trans_id, tree_path, text_sha1)))
 
2282
                new_desired_files.append((file_id, (trans_id, tree_path)))
2600
2283
                continue
2601
2284
            pb.update('Adding file contents', count + offset, total)
2602
2285
            if hardlink:
2609
2292
                    contents = filtered_output_bytes(contents, filters,
2610
2293
                        ContentFilterContext(tree_path, tree))
2611
2294
                try:
2612
 
                    tt.create_file(contents, trans_id, sha1=text_sha1)
 
2295
                    tt.create_file(contents, trans_id)
2613
2296
                finally:
2614
2297
                    try:
2615
2298
                        contents.close()
2618
2301
                        pass
2619
2302
            count += 1
2620
2303
        offset += count
2621
 
    for count, ((trans_id, tree_path, text_sha1), contents) in enumerate(
 
2304
    for count, ((trans_id, tree_path), contents) in enumerate(
2622
2305
            tree.iter_files_bytes(new_desired_files)):
2623
2306
        if wt.supports_content_filtering():
2624
2307
            filters = wt._content_filter_stack(tree_path)
2625
2308
            contents = filtered_output_bytes(contents, filters,
2626
2309
                ContentFilterContext(tree_path, tree))
2627
 
        tt.create_file(contents, trans_id, sha1=text_sha1)
 
2310
        tt.create_file(contents, trans_id)
2628
2311
        pb.update('Adding file contents', count + offset, total)
2629
2312
 
2630
2313
 
2632
2315
    for child in tt.iter_tree_children(old_parent):
2633
2316
        tt.adjust_path(tt.final_name(child), new_parent, child)
2634
2317
 
2635
 
 
2636
2318
def _reparent_transform_children(tt, old_parent, new_parent):
2637
2319
    by_parent = tt.by_parent()
2638
2320
    for child in by_parent[old_parent]:
2639
2321
        tt.adjust_path(tt.final_name(child), new_parent, child)
2640
2322
    return by_parent[old_parent]
2641
2323
 
2642
 
 
2643
2324
def _content_match(tree, entry, file_id, kind, target_path):
2644
2325
    if entry.kind != kind:
2645
2326
        return False
2646
2327
    if entry.kind == "directory":
2647
2328
        return True
2648
2329
    if entry.kind == "file":
2649
 
        f = file(target_path, 'rb')
2650
 
        try:
2651
 
            if tree.get_file_text(file_id) == f.read():
2652
 
                return True
2653
 
        finally:
2654
 
            f.close()
 
2330
        if tree.get_file(file_id).read() == file(target_path, 'rb').read():
 
2331
            return True
2655
2332
    elif entry.kind == "symlink":
2656
2333
        if tree.get_symlink_target(file_id) == os.readlink(target_path):
2657
2334
            return True
2709
2386
        raise errors.BadFileKindError(name, kind)
2710
2387
 
2711
2388
 
2712
 
def create_from_tree(tt, trans_id, tree, file_id, bytes=None,
2713
 
    filter_tree_path=None):
2714
 
    """Create new file contents according to tree contents.
2715
 
    
2716
 
    :param filter_tree_path: the tree path to use to lookup
2717
 
      content filters to apply to the bytes output in the working tree.
2718
 
      This only applies if the working tree supports content filtering.
 
2389
@deprecated_function(deprecated_in((1, 9, 0)))
 
2390
def create_by_entry(tt, entry, tree, trans_id, lines=None, mode_id=None):
 
2391
    """Create new file contents according to an inventory entry.
 
2392
 
 
2393
    DEPRECATED.  Use create_from_tree instead.
2719
2394
    """
 
2395
    if entry.kind == "file":
 
2396
        if lines is None:
 
2397
            lines = tree.get_file(entry.file_id).readlines()
 
2398
        tt.create_file(lines, trans_id, mode_id=mode_id)
 
2399
    elif entry.kind == "symlink":
 
2400
        tt.create_symlink(tree.get_symlink_target(entry.file_id), trans_id)
 
2401
    elif entry.kind == "directory":
 
2402
        tt.create_directory(trans_id)
 
2403
 
 
2404
 
 
2405
def create_from_tree(tt, trans_id, tree, file_id, bytes=None):
 
2406
    """Create new file contents according to tree contents."""
2720
2407
    kind = tree.kind(file_id)
2721
2408
    if kind == 'directory':
2722
2409
        tt.create_directory(trans_id)
2727
2414
                bytes = tree_file.readlines()
2728
2415
            finally:
2729
2416
                tree_file.close()
2730
 
        wt = tt._tree
2731
 
        if wt.supports_content_filtering() and filter_tree_path is not None:
2732
 
            filters = wt._content_filter_stack(filter_tree_path)
2733
 
            bytes = filtered_output_bytes(bytes, filters,
2734
 
                ContentFilterContext(filter_tree_path, tree))
2735
2417
        tt.create_file(bytes, trans_id)
2736
2418
    elif kind == "symlink":
2737
2419
        tt.create_symlink(tree.get_symlink_target(file_id), trans_id)
2745
2427
        tt.set_executability(entry.executable, trans_id)
2746
2428
 
2747
2429
 
2748
 
@deprecated_function(deprecated_in((2, 3, 0)))
2749
2430
def get_backup_name(entry, by_parent, parent_trans_id, tt):
2750
2431
    return _get_backup_name(entry.name, by_parent, parent_trans_id, tt)
2751
2432
 
2752
2433
 
2753
 
@deprecated_function(deprecated_in((2, 3, 0)))
2754
2434
def _get_backup_name(name, by_parent, parent_trans_id, tt):
2755
2435
    """Produce a backup-style name that appears to be available"""
2756
2436
    def name_gen():
2791
2471
 
2792
2472
 
2793
2473
def revert(working_tree, target_tree, filenames, backups=False,
2794
 
           pb=None, change_reporter=None):
 
2474
           pb=DummyProgress(), change_reporter=None):
2795
2475
    """Revert a working tree's contents to those of a target tree."""
2796
2476
    target_tree.lock_read()
2797
 
    pb = ui.ui_factory.nested_progress_bar()
2798
2477
    tt = TreeTransform(working_tree, pb)
2799
2478
    try:
2800
2479
        pp = ProgressPhase("Revert phase", 3, pb)
2805
2484
                unversioned_filter=working_tree.is_ignored)
2806
2485
            delta.report_changes(tt.iter_changes(), change_reporter)
2807
2486
        for conflict in conflicts:
2808
 
            trace.warning(conflict)
 
2487
            warning(conflict)
2809
2488
        pp.next_phase()
2810
2489
        tt.apply()
2811
2490
        working_tree.set_merge_modified(merge_modified)
2819
2498
def _prepare_revert_transform(working_tree, target_tree, tt, filenames,
2820
2499
                              backups, pp, basis_tree=None,
2821
2500
                              merge_modified=None):
2822
 
    child_pb = ui.ui_factory.nested_progress_bar()
 
2501
    pp.next_phase()
 
2502
    child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
2823
2503
    try:
2824
2504
        if merge_modified is None:
2825
2505
            merge_modified = working_tree.merge_modified()
2828
2508
                                      merge_modified, basis_tree)
2829
2509
    finally:
2830
2510
        child_pb.finished()
2831
 
    child_pb = ui.ui_factory.nested_progress_bar()
 
2511
    pp.next_phase()
 
2512
    child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
2832
2513
    try:
2833
2514
        raw_conflicts = resolve_conflicts(tt, child_pb,
2834
2515
            lambda t, c: conflict_pass(t, c, target_tree))
2877
2558
                        tt.delete_contents(trans_id)
2878
2559
                    elif kind[1] is not None:
2879
2560
                        parent_trans_id = tt.trans_id_file_id(parent[0])
2880
 
                        backup_name = tt._available_backup_name(
2881
 
                            name[0], parent_trans_id)
 
2561
                        by_parent = tt.by_parent()
 
2562
                        backup_name = _get_backup_name(name[0], by_parent,
 
2563
                                                       parent_trans_id, tt)
2882
2564
                        tt.adjust_path(backup_name, parent_trans_id, trans_id)
2883
2565
                        new_trans_id = tt.create_path(name[0], parent_trans_id)
2884
2566
                        if versioned == (True, True):
2925
2607
                    parent_trans = ROOT_PARENT
2926
2608
                else:
2927
2609
                    parent_trans = tt.trans_id_file_id(parent[1])
2928
 
                if parent[0] is None and versioned[0]:
2929
 
                    tt.adjust_root_path(name[1], parent_trans)
2930
 
                else:
2931
 
                    tt.adjust_path(name[1], parent_trans, trans_id)
 
2610
                tt.adjust_path(name[1], parent_trans, trans_id)
2932
2611
            if executable[0] != executable[1] and kind[1] == "file":
2933
2612
                tt.set_executability(executable[1], trans_id)
2934
 
        if working_tree.supports_content_filtering():
2935
 
            for index, ((trans_id, mode_id), bytes) in enumerate(
2936
 
                target_tree.iter_files_bytes(deferred_files)):
2937
 
                file_id = deferred_files[index][0]
2938
 
                # We're reverting a tree to the target tree so using the
2939
 
                # target tree to find the file path seems the best choice
2940
 
                # here IMO - Ian C 27/Oct/2009
2941
 
                filter_tree_path = target_tree.id2path(file_id)
2942
 
                filters = working_tree._content_filter_stack(filter_tree_path)
2943
 
                bytes = filtered_output_bytes(bytes, filters,
2944
 
                    ContentFilterContext(filter_tree_path, working_tree))
2945
 
                tt.create_file(bytes, trans_id, mode_id)
2946
 
        else:
2947
 
            for (trans_id, mode_id), bytes in target_tree.iter_files_bytes(
2948
 
                deferred_files):
2949
 
                tt.create_file(bytes, trans_id, mode_id)
2950
 
        tt.fixup_new_roots()
 
2613
        for (trans_id, mode_id), bytes in target_tree.iter_files_bytes(
 
2614
            deferred_files):
 
2615
            tt.create_file(bytes, trans_id, mode_id)
2951
2616
    finally:
2952
2617
        if basis_tree is not None:
2953
2618
            basis_tree.unlock()
2954
2619
    return merge_modified
2955
2620
 
2956
2621
 
2957
 
def resolve_conflicts(tt, pb=None, pass_func=None):
 
2622
def resolve_conflicts(tt, pb=DummyProgress(), pass_func=None):
2958
2623
    """Make many conflict-resolution attempts, but die if they fail"""
2959
2624
    if pass_func is None:
2960
2625
        pass_func = conflict_pass
2961
2626
    new_conflicts = set()
2962
 
    pb = ui.ui_factory.nested_progress_bar()
2963
2627
    try:
2964
2628
        for n in range(10):
2965
2629
            pb.update('Resolution pass', n+1, 10)
2969
2633
            new_conflicts.update(pass_func(tt, conflicts))
2970
2634
        raise MalformedTransform(conflicts=conflicts)
2971
2635
    finally:
2972
 
        pb.finished()
 
2636
        pb.clear()
2973
2637
 
2974
2638
 
2975
2639
def conflict_pass(tt, conflicts, path_tree=None):
3007
2671
 
3008
2672
        elif c_type == 'missing parent':
3009
2673
            trans_id = conflict[1]
3010
 
            if trans_id in tt._removed_contents:
3011
 
                cancel_deletion = True
3012
 
                orphans = tt._get_potential_orphans(trans_id)
3013
 
                if orphans:
3014
 
                    cancel_deletion = False
3015
 
                    # All children are orphans
3016
 
                    for o in orphans:
3017
 
                        try:
3018
 
                            tt.new_orphan(o, trans_id)
3019
 
                        except OrphaningError:
3020
 
                            # Something bad happened so we cancel the directory
3021
 
                            # deletion which will leave it in place with a
3022
 
                            # conflict. The user can deal with it from there.
3023
 
                            # Note that this also catch the case where we don't
3024
 
                            # want to create orphans and leave the directory in
3025
 
                            # place.
3026
 
                            cancel_deletion = True
3027
 
                            break
3028
 
                if cancel_deletion:
3029
 
                    # Cancel the directory deletion
3030
 
                    tt.cancel_deletion(trans_id)
3031
 
                    new_conflicts.add(('deleting parent', 'Not deleting',
3032
 
                                       trans_id))
3033
 
            else:
 
2674
            try:
 
2675
                tt.cancel_deletion(trans_id)
 
2676
                new_conflicts.add(('deleting parent', 'Not deleting',
 
2677
                                   trans_id))
 
2678
            except KeyError:
3034
2679
                create = True
3035
2680
                try:
3036
2681
                    tt.final_name(trans_id)
3039
2684
                        file_id = tt.final_file_id(trans_id)
3040
2685
                        if file_id is None:
3041
2686
                            file_id = tt.inactive_file_id(trans_id)
3042
 
                        _, entry = path_tree.iter_entries_by_dir(
3043
 
                            [file_id]).next()
 
2687
                        entry = path_tree.inventory[file_id]
3044
2688
                        # special-case the other tree root (move its
3045
2689
                        # children to current root)
3046
2690
                        if entry.parent_id is None:
3047
 
                            create = False
 
2691
                            create=False
3048
2692
                            moved = _reparent_transform_children(
3049
2693
                                tt, trans_id, tt.root)
3050
2694
                            for child in moved:
3062
2706
            file_id = tt.inactive_file_id(conflict[1])
3063
2707
            # special-case the other tree root (move its children instead)
3064
2708
            if path_tree and file_id in path_tree:
3065
 
                if path_tree.path2id('') == file_id:
3066
 
                    # This is the root entry, skip it
 
2709
                if path_tree.inventory[file_id].parent_id is None:
3067
2710
                    continue
3068
2711
            tt.version_file(file_id, conflict[1])
3069
2712
            new_conflicts.add((c_type, 'Versioned directory', conflict[1]))
3119
2762
        self.pending_deletions = []
3120
2763
 
3121
2764
    def rename(self, from_, to):
3122
 
        """Rename a file from one path to another."""
 
2765
        """Rename a file from one path to another.  Functions like os.rename"""
3123
2766
        try:
3124
2767
            os.rename(from_, to)
3125
2768
        except OSError, e:
3126
2769
            if e.errno in (errno.EEXIST, errno.ENOTEMPTY):
3127
2770
                raise errors.FileExists(to, str(e))
3128
 
            # normal OSError doesn't include filenames so it's hard to see where
3129
 
            # the problem is, see https://bugs.launchpad.net/bzr/+bug/491763
3130
 
            raise errors.TransformRenameFailed(from_, to, str(e), e.errno)
 
2771
            raise
3131
2772
        self.past_renames.append((from_, to))
3132
2773
 
3133
2774
    def pre_delete(self, from_, to):
3143
2784
    def rollback(self):
3144
2785
        """Reverse all renames that have been performed"""
3145
2786
        for from_, to in reversed(self.past_renames):
3146
 
            try:
3147
 
                os.rename(to, from_)
3148
 
            except OSError, e:
3149
 
                raise errors.TransformRenameFailed(to, from_, str(e), e.errno)
 
2787
            os.rename(to, from_)
3150
2788
        # after rollback, don't reuse _FileMover
3151
2789
        past_renames = None
3152
2790
        pending_deletions = None