~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/transform.py

  • Committer: Ian Clatworthy
  • Date: 2009-09-09 15:30:59 UTC
  • mto: (4634.37.2 prepare-2.0)
  • mto: This revision was merged to the branch mainline in revision 4689.
  • Revision ID: ian.clatworthy@canonical.com-20090909153059-sb038agvd38ci2q8
more link fixes in the User Guide

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
14
14
# along with this program; if not, write to the Free Software
15
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
16
 
17
 
from __future__ import absolute_import
18
 
 
19
17
import os
20
18
import errno
21
19
from stat import S_ISREG, S_IEXEC
22
 
import time
23
20
 
24
 
from bzrlib import (
25
 
    config as _mod_config,
26
 
    errors,
27
 
    lazy_import,
28
 
    registry,
29
 
    trace,
30
 
    tree,
31
 
    )
32
 
lazy_import.lazy_import(globals(), """
 
21
from bzrlib.lazy_import import lazy_import
 
22
lazy_import(globals(), """
33
23
from bzrlib import (
34
24
    annotate,
35
25
    bencode,
36
 
    controldir,
37
 
    commit,
38
 
    conflicts,
 
26
    bzrdir,
39
27
    delta,
 
28
    errors,
40
29
    inventory,
41
30
    multiparent,
42
31
    osutils,
43
32
    revision as _mod_revision,
44
 
    ui,
45
 
    urlutils,
46
33
    )
47
 
from bzrlib.i18n import gettext
48
34
""")
49
 
from bzrlib.errors import (DuplicateKey, MalformedTransform,
50
 
                           ReusingTransform, CantMoveRoot,
51
 
                           ImmortalLimbo, NoFinalPath,
 
35
from bzrlib.errors import (DuplicateKey, MalformedTransform, NoSuchFile,
 
36
                           ReusingTransform, NotVersionedError, CantMoveRoot,
 
37
                           ExistingLimbo, ImmortalLimbo, NoFinalPath,
52
38
                           UnableCreateSymlink)
53
39
from bzrlib.filters import filtered_output_bytes, ContentFilterContext
54
 
from bzrlib.mutabletree import MutableTree
 
40
from bzrlib.inventory import InventoryEntry
55
41
from bzrlib.osutils import (
56
42
    delete_any,
57
43
    file_kind,
58
44
    has_symlinks,
 
45
    lexists,
59
46
    pathjoin,
60
47
    sha_file,
61
48
    splitpath,
62
 
    )
63
 
from bzrlib.progress import ProgressPhase
 
49
    supports_executable,
 
50
)
 
51
from bzrlib.progress import DummyProgress, ProgressPhase
64
52
from bzrlib.symbol_versioning import (
65
 
    deprecated_function,
66
 
    deprecated_in,
67
 
    deprecated_method,
68
 
    )
 
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
69
60
 
70
61
 
71
62
ROOT_PARENT = "root-parent"
72
63
 
 
64
 
73
65
def unique_add(map, key, value):
74
66
    if key in map:
75
67
        raise DuplicateKey(key=key)
76
68
    map[key] = value
77
69
 
78
70
 
79
 
 
80
71
class _TransformResults(object):
81
72
    def __init__(self, modified_paths, rename_count):
82
73
        object.__init__(self)
87
78
class TreeTransformBase(object):
88
79
    """The base class for TreeTransform and its kin."""
89
80
 
90
 
    def __init__(self, tree, pb=None,
 
81
    def __init__(self, tree, pb=DummyProgress(),
91
82
                 case_sensitive=True):
92
83
        """Constructor.
93
84
 
94
85
        :param tree: The tree that will be transformed, but not necessarily
95
86
            the output tree.
96
 
        :param pb: ignored
 
87
        :param pb: A ProgressTask indicating how much progress is being made
97
88
        :param case_sensitive: If True, the target of the transform is
98
89
            case sensitive, not just case preserving.
99
90
        """
106
97
        self._new_parent = {}
107
98
        # mapping of trans_id with new contents -> new file_kind
108
99
        self._new_contents = {}
109
 
        # mapping of trans_id => (sha1 of content, stat_value)
110
 
        self._observed_sha1s = {}
111
100
        # Set of trans_ids whose contents will be removed
112
101
        self._removed_contents = set()
113
102
        # Mapping of trans_id -> new execute-bit value
132
121
            self._new_root = self.trans_id_tree_file_id(root_id)
133
122
        else:
134
123
            self._new_root = None
135
 
        # Indicator of whether the transform has been applied
 
124
        # Indictor of whether the transform has been applied
136
125
        self._done = False
137
126
        # A progress bar
138
127
        self._pb = pb
141
130
        # A counter of how many files have been renamed
142
131
        self.rename_count = 0
143
132
 
144
 
    def __enter__(self):
145
 
        """Support Context Manager API."""
146
 
        return self
147
 
 
148
 
    def __exit__(self, exc_type, exc_val, exc_tb):
149
 
        """Support Context Manager API."""
150
 
        self.finalize()
151
 
 
152
133
    def finalize(self):
153
134
        """Release the working tree lock, if held.
154
135
 
157
138
        """
158
139
        if self._tree is None:
159
140
            return
160
 
        for hook in MutableTree.hooks['post_transform']:
161
 
            hook(self._tree, self)
162
141
        self._tree.unlock()
163
142
        self._tree = None
164
143
 
182
161
 
183
162
    def adjust_path(self, name, parent, trans_id):
184
163
        """Change the path that is assigned to a transaction id."""
185
 
        if parent is None:
186
 
            raise ValueError("Parent trans-id may not be None")
187
164
        if trans_id == self._new_root:
188
165
            raise CantMoveRoot
189
166
        self._new_name[trans_id] = name
190
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
191
172
 
192
173
    def adjust_root_path(self, name, parent):
193
174
        """Emulate moving the root by moving all children, instead.
221
202
        self.version_file(old_root_file_id, old_root)
222
203
        self.unversion_file(self._new_root)
223
204
 
224
 
    def fixup_new_roots(self):
225
 
        """Reinterpret requests to change the root directory
226
 
 
227
 
        Instead of creating a root directory, or moving an existing directory,
228
 
        all the attributes and children of the new root are applied to the
229
 
        existing root directory.
230
 
 
231
 
        This means that the old root trans-id becomes obsolete, so it is
232
 
        recommended only to invoke this after the root trans-id has become
233
 
        irrelevant.
234
 
 
235
 
        """
236
 
        new_roots = [k for k, v in self._new_parent.iteritems() if v ==
237
 
                     ROOT_PARENT]
238
 
        if len(new_roots) < 1:
239
 
            return
240
 
        if len(new_roots) != 1:
241
 
            raise ValueError('A tree cannot have two roots!')
242
 
        if self._new_root is None:
243
 
            self._new_root = new_roots[0]
244
 
            return
245
 
        old_new_root = new_roots[0]
246
 
        # unversion the new root's directory.
247
 
        if self.final_kind(self._new_root) is None:
248
 
            file_id = self.final_file_id(old_new_root)
249
 
        else:
250
 
            file_id = self.final_file_id(self._new_root)
251
 
        if old_new_root in self._new_id:
252
 
            self.cancel_versioning(old_new_root)
253
 
        else:
254
 
            self.unversion_file(old_new_root)
255
 
        # if, at this stage, root still has an old file_id, zap it so we can
256
 
        # stick a new one in.
257
 
        if (self.tree_file_id(self._new_root) is not None and
258
 
            self._new_root not in self._removed_id):
259
 
            self.unversion_file(self._new_root)
260
 
        if file_id is not None:
261
 
            self.version_file(file_id, self._new_root)
262
 
 
263
 
        # Now move children of new root into old root directory.
264
 
        # Ensure all children are registered with the transaction, but don't
265
 
        # use directly-- some tree children have new parents
266
 
        list(self.iter_tree_children(old_new_root))
267
 
        # Move all children of new root into old root directory.
268
 
        for child in self.by_parent().get(old_new_root, []):
269
 
            self.adjust_path(self.final_name(child), self._new_root, child)
270
 
 
271
 
        # Ensure old_new_root has no directory.
272
 
        if old_new_root in self._new_contents:
273
 
            self.cancel_creation(old_new_root)
274
 
        else:
275
 
            self.delete_contents(old_new_root)
276
 
 
277
 
        # prevent deletion of root directory.
278
 
        if self._new_root in self._removed_contents:
279
 
            self.cancel_deletion(self._new_root)
280
 
 
281
 
        # destroy path info for old_new_root.
282
 
        del self._new_parent[old_new_root]
283
 
        del self._new_name[old_new_root]
284
 
 
285
205
    def trans_id_tree_file_id(self, inventory_id):
286
206
        """Determine the transaction id of a working tree file.
287
207
 
333
253
 
334
254
    def delete_contents(self, trans_id):
335
255
        """Schedule the contents of a path entry for deletion"""
336
 
        kind = self.tree_kind(trans_id)
337
 
        if kind is not None:
338
 
            self._removed_contents.add(trans_id)
 
256
        self.tree_kind(trans_id)
 
257
        self._removed_contents.add(trans_id)
339
258
 
340
259
    def cancel_deletion(self, trans_id):
341
260
        """Cancel a scheduled deletion"""
398
317
        return sorted(FinalPaths(self).get_paths(new_ids))
399
318
 
400
319
    def _inventory_altered(self):
401
 
        """Determine which trans_ids need new Inventory entries.
402
 
 
403
 
        An new entry is needed when anything that would be reflected by an
404
 
        inventory entry changes, including file name, file_id, parent file_id,
405
 
        file kind, and the execute bit.
406
 
 
407
 
        Some care is taken to return entries with real changes, not cases
408
 
        where the value is deleted and then restored to its original value,
409
 
        but some actually unchanged values may be returned.
410
 
 
411
 
        :returns: A list of (path, trans_id) for all items requiring an
412
 
            inventory change. Ordered by path.
413
 
        """
414
 
        changed_ids = set()
415
 
        # Find entries whose file_ids are new (or changed).
416
 
        new_file_id = set(t for t in self._new_id
417
 
                          if self._new_id[t] != self.tree_file_id(t))
418
 
        for id_set in [self._new_name, self._new_parent, new_file_id,
 
320
        """Get the trans_ids and paths of files needing new inv entries."""
 
321
        new_ids = set()
 
322
        for id_set in [self._new_name, self._new_parent, self._new_id,
419
323
                       self._new_executability]:
420
 
            changed_ids.update(id_set)
421
 
        # removing implies a kind change
 
324
            new_ids.update(id_set)
422
325
        changed_kind = set(self._removed_contents)
423
 
        # so does adding
424
326
        changed_kind.intersection_update(self._new_contents)
425
 
        # Ignore entries that are already known to have changed.
426
 
        changed_kind.difference_update(changed_ids)
427
 
        #  to keep only the truly changed ones
428
 
        changed_kind = (t for t in changed_kind
429
 
                        if self.tree_kind(t) != self.final_kind(t))
430
 
        # all kind changes will alter the inventory
431
 
        changed_ids.update(changed_kind)
432
 
        # To find entries with changed parent_ids, find parents which existed,
433
 
        # but changed file_id.
434
 
        changed_file_id = set(t for t in new_file_id if t in self._removed_id)
435
 
        # Now add all their children to the set.
436
 
        for parent_trans_id in new_file_id:
437
 
            changed_ids.update(self.iter_tree_children(parent_trans_id))
438
 
        return sorted(FinalPaths(self).get_paths(changed_ids))
 
327
        changed_kind.difference_update(new_ids)
 
328
        changed_kind = (t for t in changed_kind if self.tree_kind(t) !=
 
329
                        self.final_kind(t))
 
330
        new_ids.update(changed_kind)
 
331
        return sorted(FinalPaths(self).get_paths(new_ids))
439
332
 
440
333
    def final_kind(self, trans_id):
441
334
        """Determine the final file kind, after any changes applied.
442
335
 
443
 
        :return: None if the file does not exist/has no contents.  (It is
444
 
            conceivable that a path would be created without the corresponding
445
 
            contents insertion command)
 
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)
446
339
        """
447
340
        if trans_id in self._new_contents:
448
341
            return self._new_contents[trans_id]
449
342
        elif trans_id in self._removed_contents:
450
 
            return None
 
343
            raise NoSuchFile(None)
451
344
        else:
452
345
            return self.tree_kind(trans_id)
453
346
 
566
459
        for trans_id in self._removed_id:
567
460
            file_id = self.tree_file_id(trans_id)
568
461
            if file_id is not None:
569
 
                if self._tree.stored_kind(file_id) == 'directory':
 
462
                if self._tree.inventory[file_id].kind == 'directory':
570
463
                    parents.append(trans_id)
571
464
            elif self.tree_kind(trans_id) == 'directory':
572
465
                parents.append(trans_id)
575
468
            # ensure that all children are registered with the transaction
576
469
            list(self.iter_tree_children(parent_id))
577
470
 
578
 
    def _has_named_child(self, name, parent_id, known_children):
579
 
        """Does a parent already have a name child.
580
 
 
581
 
        :param name: The searched for name.
582
 
 
583
 
        :param parent_id: The parent for which the check is made.
584
 
 
585
 
        :param known_children: The already known children. This should have
586
 
            been recently obtained from `self.by_parent.get(parent_id)`
587
 
            (or will be if None is passed).
588
 
        """
589
 
        if known_children is None:
590
 
            known_children = self.by_parent().get(parent_id, [])
591
 
        for child in known_children:
 
471
    def has_named_child(self, by_parent, parent_id, name):
 
472
        try:
 
473
            children = by_parent[parent_id]
 
474
        except KeyError:
 
475
            children = []
 
476
        for child in children:
592
477
            if self.final_name(child) == name:
593
478
                return True
594
 
        parent_path = self._tree_id_paths.get(parent_id, None)
595
 
        if parent_path is None:
596
 
            # No parent... no children
 
479
        try:
 
480
            path = self._tree_id_paths[parent_id]
 
481
        except KeyError:
597
482
            return False
598
 
        child_path = joinpath(parent_path, name)
599
 
        child_id = self._tree_path_ids.get(child_path, None)
 
483
        childpath = joinpath(path, name)
 
484
        child_id = self._tree_path_ids.get(childpath)
600
485
        if child_id is None:
601
 
            # Not known by the tree transform yet, check the filesystem
602
 
            return osutils.lexists(self._tree.abspath(child_path))
 
486
            return lexists(self._tree.abspath(childpath))
603
487
        else:
604
 
            raise AssertionError('child_id is missing: %s, %s, %s'
605
 
                                 % (name, parent_id, child_id))
606
 
 
607
 
    def _available_backup_name(self, name, target_id):
608
 
        """Find an available backup name.
609
 
 
610
 
        :param name: The basename of the file.
611
 
 
612
 
        :param target_id: The directory trans_id where the backup should 
613
 
            be placed.
614
 
        """
615
 
        known_children = self.by_parent().get(target_id, [])
616
 
        return osutils.available_backup_name(
617
 
            name,
618
 
            lambda base: self._has_named_child(
619
 
                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
620
495
 
621
496
    def _parent_loops(self):
622
497
        """No entry should be its own ancestor"""
624
499
        for trans_id in self._new_parent:
625
500
            seen = set()
626
501
            parent_id = trans_id
627
 
            while parent_id != ROOT_PARENT:
 
502
            while parent_id is not ROOT_PARENT:
628
503
                seen.add(parent_id)
629
504
                try:
630
505
                    parent_id = self.final_parent(parent_id)
640
515
        """If parent directories are versioned, children must be versioned."""
641
516
        conflicts = []
642
517
        for parent_id, children in by_parent.iteritems():
643
 
            if parent_id == ROOT_PARENT:
 
518
            if parent_id is ROOT_PARENT:
644
519
                continue
645
520
            if self.final_file_id(parent_id) is not None:
646
521
                continue
657
532
        """
658
533
        conflicts = []
659
534
        for trans_id in self._new_id.iterkeys():
660
 
            kind = self.final_kind(trans_id)
661
 
            if kind is None:
 
535
            try:
 
536
                kind = self.final_kind(trans_id)
 
537
            except NoSuchFile:
662
538
                conflicts.append(('versioning no contents', trans_id))
663
539
                continue
664
 
            if not inventory.InventoryEntry.versionable_kind(kind):
 
540
            if not InventoryEntry.versionable_kind(kind):
665
541
                conflicts.append(('versioning bad kind', trans_id, kind))
666
542
        return conflicts
667
543
 
678
554
            if self.final_file_id(trans_id) is None:
679
555
                conflicts.append(('unversioned executability', trans_id))
680
556
            else:
681
 
                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:
682
562
                    conflicts.append(('non-file executability', trans_id))
683
563
        return conflicts
684
564
 
686
566
        """Check for overwrites (not permitted on Win32)"""
687
567
        conflicts = []
688
568
        for trans_id in self._new_contents:
689
 
            if self.tree_kind(trans_id) is None:
 
569
            try:
 
570
                self.tree_kind(trans_id)
 
571
            except NoSuchFile:
690
572
                continue
691
573
            if trans_id not in self._removed_contents:
692
574
                conflicts.append(('overwrite', trans_id,
699
581
        if (self._new_name, self._new_parent) == ({}, {}):
700
582
            return conflicts
701
583
        for children in by_parent.itervalues():
702
 
            name_ids = []
703
 
            for child_tid in children:
704
 
                name = self.final_name(child_tid)
705
 
                if name is not None:
706
 
                    # Keep children only if they still exist in the end
707
 
                    if not self._case_sensitive_target:
708
 
                        name = name.lower()
709
 
                    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]
710
587
            name_ids.sort()
711
588
            last_name = None
712
589
            last_trans_id = None
713
590
            for name, trans_id in name_ids:
714
 
                kind = self.final_kind(trans_id)
 
591
                try:
 
592
                    kind = self.final_kind(trans_id)
 
593
                except NoSuchFile:
 
594
                    kind = None
715
595
                file_id = self.final_file_id(trans_id)
716
596
                if kind is None and file_id is None:
717
597
                    continue
736
616
        return conflicts
737
617
 
738
618
    def _parent_type_conflicts(self, by_parent):
739
 
        """Children must have a directory parent"""
 
619
        """parents must have directory 'contents'."""
740
620
        conflicts = []
741
621
        for parent_id, children in by_parent.iteritems():
742
 
            if parent_id == ROOT_PARENT:
743
 
                continue
744
 
            no_children = True
745
 
            for child_id in children:
746
 
                if self.final_kind(child_id) is not None:
747
 
                    no_children = False
748
 
                    break
749
 
            if no_children:
750
 
                continue
751
 
            # There is at least a child, so we need an existing directory to
752
 
            # contain it.
753
 
            kind = self.final_kind(parent_id)
 
622
            if parent_id is ROOT_PARENT:
 
623
                continue
 
624
            if not self._any_contents(children):
 
625
                continue
 
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
754
635
            if kind is None:
755
 
                # The directory will be deleted
756
636
                conflicts.append(('missing parent', parent_id))
757
637
            elif kind != "directory":
758
 
                # Meh, we need a *directory* to put something in it
759
638
                conflicts.append(('non-directory parent', parent_id))
760
639
        return conflicts
761
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
 
762
651
    def _set_executability(self, path, trans_id):
763
652
        """Set the executability of versioned files """
764
 
        if self._tree._supports_executable():
 
653
        if supports_executable():
765
654
            new_executability = self._new_executability[trans_id]
766
655
            abspath = self._tree.abspath(path)
767
656
            current_mode = os.stat(abspath).st_mode
776
665
                    to_mode |= 0010 & ~umask
777
666
            else:
778
667
                to_mode = current_mode & ~0111
779
 
            osutils.chmod_if_possible(abspath, to_mode)
 
668
            os.chmod(abspath, to_mode)
780
669
 
781
670
    def _new_entry(self, name, parent_id, file_id):
782
671
        """Helper function to create a new filesystem entry."""
786
675
        return trans_id
787
676
 
788
677
    def new_file(self, name, parent_id, contents, file_id=None,
789
 
                 executable=None, sha1=None):
 
678
                 executable=None):
790
679
        """Convenience method to create files.
791
680
 
792
681
        name is the name of the file to create.
799
688
        trans_id = self._new_entry(name, parent_id, file_id)
800
689
        # TODO: rather than scheduling a set_executable call,
801
690
        # have create_file create the file with the right mode.
802
 
        self.create_file(contents, trans_id, sha1=sha1)
 
691
        self.create_file(contents, trans_id)
803
692
        if executable is not None:
804
693
            self.set_executability(executable, trans_id)
805
694
        return trans_id
828
717
        self.create_symlink(target, trans_id)
829
718
        return trans_id
830
719
 
831
 
    def new_orphan(self, trans_id, parent_id):
832
 
        """Schedule an item to be orphaned.
833
 
 
834
 
        When a directory is about to be removed, its children, if they are not
835
 
        versioned are moved out of the way: they don't have a parent anymore.
836
 
 
837
 
        :param trans_id: The trans_id of the existing item.
838
 
        :param parent_id: The parent trans_id of the item.
839
 
        """
840
 
        raise NotImplementedError(self.new_orphan)
841
 
 
842
 
    def _get_potential_orphans(self, dir_id):
843
 
        """Find the potential orphans in a directory.
844
 
 
845
 
        A directory can't be safely deleted if there are versioned files in it.
846
 
        If all the contained files are unversioned then they can be orphaned.
847
 
 
848
 
        The 'None' return value means that the directory contains at least one
849
 
        versioned file and should not be deleted.
850
 
 
851
 
        :param dir_id: The directory trans id.
852
 
 
853
 
        :return: A list of the orphan trans ids or None if at least one
854
 
             versioned file is present.
855
 
        """
856
 
        orphans = []
857
 
        # Find the potential orphans, stop if one item should be kept
858
 
        for child_tid in self.by_parent()[dir_id]:
859
 
            if child_tid in self._removed_contents:
860
 
                # The child is removed as part of the transform. Since it was
861
 
                # versioned before, it's not an orphan
862
 
                continue
863
 
            elif self.final_file_id(child_tid) is None:
864
 
                # The child is not versioned
865
 
                orphans.append(child_tid)
866
 
            else:
867
 
                # We have a versioned file here, searching for orphans is
868
 
                # meaningless.
869
 
                orphans = None
870
 
                break
871
 
        return orphans
872
 
 
873
720
    def _affected_ids(self):
874
721
        """Return the set of transform ids affected by the transform"""
875
722
        trans_ids = set(self._removed_id)
934
781
        Return a (name, parent, kind, executable) tuple
935
782
        """
936
783
        to_name = self.final_name(to_trans_id)
937
 
        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
938
788
        to_parent = self.final_file_id(self.final_parent(to_trans_id))
939
789
        if to_trans_id in self._new_executability:
940
790
            to_executable = self._new_executability[to_trans_id]
1009
859
    def get_preview_tree(self):
1010
860
        """Return a tree representing the result of the transform.
1011
861
 
1012
 
        The tree is a snapshot, and altering the TreeTransform will invalidate
1013
 
        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.
1014
864
        """
1015
865
        return _PreviewTree(self)
1016
866
 
1017
 
    def commit(self, branch, message, merge_parents=None, strict=False,
1018
 
               timestamp=None, timezone=None, committer=None, authors=None,
1019
 
               revprops=None, revision_id=None):
 
867
    def commit(self, branch, message, merge_parents=None, strict=False):
1020
868
        """Commit the result of this TreeTransform to a branch.
1021
869
 
1022
870
        :param branch: The branch to commit to.
1023
871
        :param message: The message to attach to the commit.
1024
 
        :param merge_parents: Additional parent revision-ids specified by
1025
 
            pending merges.
1026
 
        :param strict: If True, abort the commit if there are unversioned
1027
 
            files.
1028
 
        :param timestamp: if not None, seconds-since-epoch for the time and
1029
 
            date.  (May be a float.)
1030
 
        :param timezone: Optional timezone for timestamp, as an offset in
1031
 
            seconds.
1032
 
        :param committer: Optional committer in email-id format.
1033
 
            (e.g. "J Random Hacker <jrandom@example.com>")
1034
 
        :param authors: Optional list of authors in email-id format.
1035
 
        :param revprops: Optional dictionary of revision properties.
1036
 
        :param revision_id: Optional revision id.  (Specifying a revision-id
1037
 
            may reduce performance for some non-native formats.)
 
872
        :param merge_parents: Additional parents specified by pending merges.
1038
873
        :return: The revision_id of the revision committed.
1039
874
        """
1040
875
        self._check_malformed()
1057
892
        if self._tree.get_revision_id() != last_rev_id:
1058
893
            raise ValueError('TreeTransform not based on branch basis: %s' %
1059
894
                             self._tree.get_revision_id())
1060
 
        revprops = commit.Commit.update_revprops(revprops, branch, authors)
1061
 
        builder = branch.get_commit_builder(parent_ids,
1062
 
                                            timestamp=timestamp,
1063
 
                                            timezone=timezone,
1064
 
                                            committer=committer,
1065
 
                                            revprops=revprops,
1066
 
                                            revision_id=revision_id)
 
895
        builder = branch.get_commit_builder(parent_ids)
1067
896
        preview = self.get_preview_tree()
1068
897
        list(builder.record_iter_changes(preview, last_rev_id,
1069
898
                                         self.iter_changes()))
1171
1000
class DiskTreeTransform(TreeTransformBase):
1172
1001
    """Tree transform storing its contents on disk."""
1173
1002
 
1174
 
    def __init__(self, tree, limbodir, pb=None,
 
1003
    def __init__(self, tree, limbodir, pb=DummyProgress(),
1175
1004
                 case_sensitive=True):
1176
1005
        """Constructor.
1177
1006
        :param tree: The tree that will be transformed, but not necessarily
1178
1007
            the output tree.
1179
1008
        :param limbodir: A directory where new files can be stored until
1180
1009
            they are installed in their proper places
1181
 
        :param pb: ignored
 
1010
        :param pb: A ProgressBar indicating how much progress is being made
1182
1011
        :param case_sensitive: If True, the target of the transform is
1183
1012
            case sensitive, not just case preserving.
1184
1013
        """
1187
1016
        self._deletiondir = None
1188
1017
        # A mapping of transform ids to their limbo filename
1189
1018
        self._limbo_files = {}
1190
 
        self._possibly_stale_limbo_files = set()
1191
1019
        # A mapping of transform ids to a set of the transform ids of children
1192
1020
        # that their limbo directory has
1193
1021
        self._limbo_children = {}
1195
1023
        self._limbo_children_names = {}
1196
1024
        # List of transform ids that need to be renamed from limbo into place
1197
1025
        self._needs_rename = set()
1198
 
        self._creation_mtime = None
1199
1026
 
1200
1027
    def finalize(self):
1201
1028
        """Release the working tree lock, if held, clean up limbo dir.
1206
1033
        if self._tree is None:
1207
1034
            return
1208
1035
        try:
1209
 
            limbo_paths = self._limbo_files.values() + list(
1210
 
                self._possibly_stale_limbo_files)
1211
 
            limbo_paths = sorted(limbo_paths, reverse=True)
1212
 
            for path in limbo_paths:
1213
 
                try:
1214
 
                    delete_any(path)
1215
 
                except OSError, e:
1216
 
                    if e.errno != errno.ENOENT:
1217
 
                        raise
1218
 
                    # XXX: warn? perhaps we just got interrupted at an
1219
 
                    # inconvenient moment, but perhaps files are disappearing
1220
 
                    # from under us?
 
1036
            entries = [(self._limbo_name(t), t, k) for t, k in
 
1037
                       self._new_contents.iteritems()]
 
1038
            entries.sort(reverse=True)
 
1039
            for path, trans_id, kind in entries:
 
1040
                delete_any(path)
1221
1041
            try:
1222
1042
                delete_any(self._limbodir)
1223
1043
            except OSError:
1231
1051
        finally:
1232
1052
            TreeTransformBase.finalize(self)
1233
1053
 
1234
 
    def _limbo_supports_executable(self):
1235
 
        """Check if the limbo path supports the executable bit."""
1236
 
        # FIXME: Check actual file system capabilities of limbodir
1237
 
        return osutils.supports_executable()
1238
 
 
1239
1054
    def _limbo_name(self, trans_id):
1240
1055
        """Generate the limbo name of a file"""
1241
1056
        limbo_name = self._limbo_files.get(trans_id)
1242
 
        if limbo_name is None:
1243
 
            limbo_name = self._generate_limbo_path(trans_id)
1244
 
            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
1245
1096
        return limbo_name
1246
1097
 
1247
 
    def _generate_limbo_path(self, trans_id):
1248
 
        """Generate a limbo path using the trans_id as the relative path.
1249
 
 
1250
 
        This is suitable as a fallback, and when the transform should not be
1251
 
        sensitive to the path encoding of the limbo directory.
1252
 
        """
1253
 
        self._needs_rename.add(trans_id)
1254
 
        return pathjoin(self._limbodir, trans_id)
1255
 
 
1256
1098
    def adjust_path(self, name, parent, trans_id):
1257
1099
        previous_parent = self._new_parent.get(trans_id)
1258
1100
        previous_name = self._new_name.get(trans_id)
1260
1102
        if (trans_id in self._limbo_files and
1261
1103
            trans_id not in self._needs_rename):
1262
1104
            self._rename_in_limbo([trans_id])
1263
 
            if previous_parent != parent:
1264
 
                self._limbo_children[previous_parent].remove(trans_id)
1265
 
            if previous_parent != parent or previous_name != name:
1266
 
                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]
1267
1107
 
1268
1108
    def _rename_in_limbo(self, trans_ids):
1269
1109
        """Fix limbo names so that the right final path is produced.
1277
1117
        entries from _limbo_files, because they are now stale.
1278
1118
        """
1279
1119
        for trans_id in trans_ids:
1280
 
            old_path = self._limbo_files[trans_id]
1281
 
            self._possibly_stale_limbo_files.add(old_path)
1282
 
            del self._limbo_files[trans_id]
 
1120
            old_path = self._limbo_files.pop(trans_id)
1283
1121
            if trans_id not in self._new_contents:
1284
1122
                continue
1285
1123
            new_path = self._limbo_name(trans_id)
1286
1124
            os.rename(old_path, new_path)
1287
 
            self._possibly_stale_limbo_files.remove(old_path)
1288
 
            for descendant in self._limbo_descendants(trans_id):
1289
 
                desc_path = self._limbo_files[descendant]
1290
 
                desc_path = new_path + desc_path[len(old_path):]
1291
 
                self._limbo_files[descendant] = desc_path
1292
 
 
1293
 
    def _limbo_descendants(self, trans_id):
1294
 
        """Return the set of trans_ids whose limbo paths descend from this."""
1295
 
        descendants = set(self._limbo_children.get(trans_id, []))
1296
 
        for descendant in list(descendants):
1297
 
            descendants.update(self._limbo_descendants(descendant))
1298
 
        return descendants
1299
 
 
1300
 
    def create_file(self, contents, trans_id, mode_id=None, sha1=None):
 
1125
 
 
1126
    def create_file(self, contents, trans_id, mode_id=None):
1301
1127
        """Schedule creation of a new file.
1302
1128
 
1303
 
        :seealso: new_file.
1304
 
 
1305
 
        :param contents: an iterator of strings, all of which will be written
1306
 
            to the target destination.
1307
 
        :param trans_id: TreeTransform handle
1308
 
        :param mode_id: If not None, force the mode of the target file to match
1309
 
            the mode of the object referenced by mode_id.
1310
 
            Otherwise, we will try to preserve mode bits of an existing file.
1311
 
        :param sha1: If the sha1 of this content is already known, pass it in.
1312
 
            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.
1313
1136
        """
1314
1137
        name = self._limbo_name(trans_id)
1315
1138
        f = open(name, 'wb')
1316
1139
        try:
1317
 
            unique_add(self._new_contents, trans_id, 'file')
 
1140
            try:
 
1141
                unique_add(self._new_contents, trans_id, 'file')
 
1142
            except:
 
1143
                # Clean up the file, it never got registered so
 
1144
                # TreeTransform.finalize() won't clean it up.
 
1145
                f.close()
 
1146
                os.unlink(name)
 
1147
                raise
 
1148
 
1318
1149
            f.writelines(contents)
1319
1150
        finally:
1320
1151
            f.close()
1321
 
        self._set_mtime(name)
1322
1152
        self._set_mode(trans_id, mode_id, S_ISREG)
1323
 
        # It is unfortunate we have to use lstat instead of fstat, but we just
1324
 
        # used utime and chmod on the file, so we need the accurate final
1325
 
        # details.
1326
 
        if sha1 is not None:
1327
 
            self._observed_sha1s[trans_id] = (sha1, osutils.lstat(name))
1328
1153
 
1329
1154
    def _read_file_chunks(self, trans_id):
1330
1155
        cur_file = open(self._limbo_name(trans_id), 'rb')
1336
1161
    def _read_symlink_target(self, trans_id):
1337
1162
        return os.readlink(self._limbo_name(trans_id))
1338
1163
 
1339
 
    def _set_mtime(self, path):
1340
 
        """All files that are created get the same mtime.
1341
 
 
1342
 
        This time is set by the first object to be created.
1343
 
        """
1344
 
        if self._creation_mtime is None:
1345
 
            self._creation_mtime = time.time()
1346
 
        os.utime(path, (self._creation_mtime, self._creation_mtime))
1347
 
 
1348
1164
    def create_hardlink(self, path, trans_id):
1349
1165
        """Schedule creation of a hard link"""
1350
1166
        name = self._limbo_name(trans_id)
1389
1205
    def cancel_creation(self, trans_id):
1390
1206
        """Cancel the creation of new file contents."""
1391
1207
        del self._new_contents[trans_id]
1392
 
        if trans_id in self._observed_sha1s:
1393
 
            del self._observed_sha1s[trans_id]
1394
1208
        children = self._limbo_children.get(trans_id)
1395
1209
        # if this is a limbo directory with children, move them before removing
1396
1210
        # the directory
1400
1214
            del self._limbo_children_names[trans_id]
1401
1215
        delete_any(self._limbo_name(trans_id))
1402
1216
 
1403
 
    def new_orphan(self, trans_id, parent_id):
1404
 
        conf = self._tree.get_config_stack()
1405
 
        handle_orphan = conf.get('bzr.transform.orphan_policy')
1406
 
        handle_orphan(self, trans_id, parent_id)
1407
 
 
1408
 
 
1409
 
class OrphaningError(errors.BzrError):
1410
 
 
1411
 
    # Only bugs could lead to such exception being seen by the user
1412
 
    internal_error = True
1413
 
    _fmt = "Error while orphaning %s in %s directory"
1414
 
 
1415
 
    def __init__(self, orphan, parent):
1416
 
        errors.BzrError.__init__(self)
1417
 
        self.orphan = orphan
1418
 
        self.parent = parent
1419
 
 
1420
 
 
1421
 
class OrphaningForbidden(OrphaningError):
1422
 
 
1423
 
    _fmt = "Policy: %s doesn't allow creating orphans."
1424
 
 
1425
 
    def __init__(self, policy):
1426
 
        errors.BzrError.__init__(self)
1427
 
        self.policy = policy
1428
 
 
1429
 
 
1430
 
def move_orphan(tt, orphan_id, parent_id):
1431
 
    """See TreeTransformBase.new_orphan.
1432
 
 
1433
 
    This creates a new orphan in the `bzr-orphans` dir at the root of the
1434
 
    `TreeTransform`.
1435
 
 
1436
 
    :param tt: The TreeTransform orphaning `trans_id`.
1437
 
 
1438
 
    :param orphan_id: The trans id that should be orphaned.
1439
 
 
1440
 
    :param parent_id: The orphan parent trans id.
1441
 
    """
1442
 
    # Add the orphan dir if it doesn't exist
1443
 
    orphan_dir_basename = 'bzr-orphans'
1444
 
    od_id = tt.trans_id_tree_path(orphan_dir_basename)
1445
 
    if tt.final_kind(od_id) is None:
1446
 
        tt.create_directory(od_id)
1447
 
    parent_path = tt._tree_id_paths[parent_id]
1448
 
    # Find a name that doesn't exist yet in the orphan dir
1449
 
    actual_name = tt.final_name(orphan_id)
1450
 
    new_name = tt._available_backup_name(actual_name, od_id)
1451
 
    tt.adjust_path(new_name, od_id, orphan_id)
1452
 
    trace.warning('%s has been orphaned in %s'
1453
 
                  % (joinpath(parent_path, actual_name), orphan_dir_basename))
1454
 
 
1455
 
 
1456
 
def refuse_orphan(tt, orphan_id, parent_id):
1457
 
    """See TreeTransformBase.new_orphan.
1458
 
 
1459
 
    This refuses to create orphan, letting the caller handle the conflict.
1460
 
    """
1461
 
    raise OrphaningForbidden('never')
1462
 
 
1463
 
 
1464
 
orphaning_registry = registry.Registry()
1465
 
orphaning_registry.register(
1466
 
    'conflict', refuse_orphan,
1467
 
    'Leave orphans in place and create a conflict on the directory.')
1468
 
orphaning_registry.register(
1469
 
    'move', move_orphan,
1470
 
    'Move orphans into the bzr-orphans directory.')
1471
 
orphaning_registry._set_default_key('conflict')
1472
 
 
1473
 
 
1474
 
opt_transform_orphan = _mod_config.RegistryOption(
1475
 
    'bzr.transform.orphan_policy', orphaning_registry,
1476
 
    help='Policy for orphaned files during transform operations.',
1477
 
    invalid='warning')
1478
 
 
1479
1217
 
1480
1218
class TreeTransform(DiskTreeTransform):
1481
1219
    """Represent a tree transformation.
1542
1280
    FileMover does not delete files until it is sure that a rollback will not
1543
1281
    happen.
1544
1282
    """
1545
 
    def __init__(self, tree, pb=None):
 
1283
    def __init__(self, tree, pb=DummyProgress()):
1546
1284
        """Note: a tree_write lock is taken on the tree.
1547
1285
 
1548
1286
        Use TreeTransform.finalize() to release the lock (can be omitted if
1553
1291
        try:
1554
1292
            limbodir = urlutils.local_path_from_url(
1555
1293
                tree._transport.abspath('limbo'))
1556
 
            osutils.ensure_empty_directory_exists(
1557
 
                limbodir,
1558
 
                errors.ExistingLimbo)
 
1294
            try:
 
1295
                os.mkdir(limbodir)
 
1296
            except OSError, e:
 
1297
                if e.errno == errno.EEXIST:
 
1298
                    raise ExistingLimbo(limbodir)
1559
1299
            deletiondir = urlutils.local_path_from_url(
1560
1300
                tree._transport.abspath('pending-deletion'))
1561
 
            osutils.ensure_empty_directory_exists(
1562
 
                deletiondir,
1563
 
                errors.ExistingPendingDeletion)
 
1301
            try:
 
1302
                os.mkdir(deletiondir)
 
1303
            except OSError, e:
 
1304
                if e.errno == errno.EEXIST:
 
1305
                    raise errors.ExistingPendingDeletion(deletiondir)
1564
1306
        except:
1565
1307
            tree.unlock()
1566
1308
            raise
1595
1337
    def tree_kind(self, trans_id):
1596
1338
        """Determine the file kind in the working tree.
1597
1339
 
1598
 
        :returns: The file kind or None if the file does not exist
 
1340
        Raises NoSuchFile if the file does not exist
1599
1341
        """
1600
1342
        path = self._tree_id_paths.get(trans_id)
1601
1343
        if path is None:
1602
 
            return None
 
1344
            raise NoSuchFile(None)
1603
1345
        try:
1604
1346
            return file_kind(self._tree.abspath(path))
1605
 
        except errors.NoSuchFile:
1606
 
            return None
 
1347
        except OSError, e:
 
1348
            if e.errno != errno.ENOENT:
 
1349
                raise
 
1350
            else:
 
1351
                raise NoSuchFile(path)
1607
1352
 
1608
1353
    def _set_mode(self, trans_id, mode_id, typefunc):
1609
1354
        """Set the mode of new file contents.
1629
1374
            else:
1630
1375
                raise
1631
1376
        if typefunc(mode):
1632
 
            osutils.chmod_if_possible(self._limbo_name(trans_id), mode)
 
1377
            os.chmod(self._limbo_name(trans_id), mode)
1633
1378
 
1634
1379
    def iter_tree_children(self, parent_id):
1635
1380
        """Iterate through the entry's tree children, if any"""
1651
1396
                continue
1652
1397
            yield self.trans_id_tree_path(childpath)
1653
1398
 
1654
 
    def _generate_limbo_path(self, trans_id):
1655
 
        """Generate a limbo path using the final path if possible.
1656
 
 
1657
 
        This optimizes the performance of applying the tree transform by
1658
 
        avoiding renames.  These renames can be avoided only when the parent
1659
 
        directory is already scheduled for creation.
1660
 
 
1661
 
        If the final path cannot be used, falls back to using the trans_id as
1662
 
        the relpath.
1663
 
        """
1664
 
        parent = self._new_parent.get(trans_id)
1665
 
        # if the parent directory is already in limbo (e.g. when building a
1666
 
        # tree), choose a limbo name inside the parent, to reduce further
1667
 
        # renames.
1668
 
        use_direct_path = False
1669
 
        if self._new_contents.get(parent) == 'directory':
1670
 
            filename = self._new_name.get(trans_id)
1671
 
            if filename is not None:
1672
 
                if parent not in self._limbo_children:
1673
 
                    self._limbo_children[parent] = set()
1674
 
                    self._limbo_children_names[parent] = {}
1675
 
                    use_direct_path = True
1676
 
                # the direct path can only be used if no other file has
1677
 
                # already taken this pathname, i.e. if the name is unused, or
1678
 
                # if it is already associated with this trans_id.
1679
 
                elif self._case_sensitive_target:
1680
 
                    if (self._limbo_children_names[parent].get(filename)
1681
 
                        in (trans_id, None)):
1682
 
                        use_direct_path = True
1683
 
                else:
1684
 
                    for l_filename, l_trans_id in\
1685
 
                        self._limbo_children_names[parent].iteritems():
1686
 
                        if l_trans_id == trans_id:
1687
 
                            continue
1688
 
                        if l_filename.lower() == filename.lower():
1689
 
                            break
1690
 
                    else:
1691
 
                        use_direct_path = True
1692
 
 
1693
 
        if not use_direct_path:
1694
 
            return DiskTreeTransform._generate_limbo_path(self, trans_id)
1695
 
 
1696
 
        limbo_name = pathjoin(self._limbo_files[parent], filename)
1697
 
        self._limbo_children[parent].add(trans_id)
1698
 
        self._limbo_children_names[parent][filename] = trans_id
1699
 
        return limbo_name
1700
 
 
1701
 
 
1702
1399
    def apply(self, no_conflicts=False, precomputed_delta=None, _mover=None):
1703
1400
        """Apply all changes to the inventory and filesystem.
1704
1401
 
1713
1410
            calculating one.
1714
1411
        :param _mover: Supply an alternate FileMover, for testing
1715
1412
        """
1716
 
        for hook in MutableTree.hooks['pre_transform']:
1717
 
            hook(self._tree, self)
1718
1413
        if not no_conflicts:
1719
1414
            self._check_malformed()
1720
 
        child_pb = ui.ui_factory.nested_progress_bar()
 
1415
        child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1721
1416
        try:
1722
1417
            if precomputed_delta is None:
1723
 
                child_pb.update(gettext('Apply phase'), 0, 2)
 
1418
                child_pb.update('Apply phase', 0, 2)
1724
1419
                inventory_delta = self._generate_inventory_delta()
1725
1420
                offset = 1
1726
1421
            else:
1731
1426
            else:
1732
1427
                mover = _mover
1733
1428
            try:
1734
 
                child_pb.update(gettext('Apply phase'), 0 + offset, 2 + offset)
 
1429
                child_pb.update('Apply phase', 0 + offset, 2 + offset)
1735
1430
                self._apply_removals(mover)
1736
 
                child_pb.update(gettext('Apply phase'), 1 + offset, 2 + offset)
 
1431
                child_pb.update('Apply phase', 1 + offset, 2 + offset)
1737
1432
                modified_paths = self._apply_insertions(mover)
1738
1433
            except:
1739
1434
                mover.rollback()
1742
1437
                mover.apply_deletions()
1743
1438
        finally:
1744
1439
            child_pb.finished()
1745
 
        if self.final_file_id(self.root) is None:
1746
 
            inventory_delta = [e for e in inventory_delta if e[0] != '']
1747
1440
        self._tree.apply_inventory_delta(inventory_delta)
1748
 
        self._apply_observed_sha1s()
1749
1441
        self._done = True
1750
1442
        self.finalize()
1751
1443
        return _TransformResults(modified_paths, self.rename_count)
1753
1445
    def _generate_inventory_delta(self):
1754
1446
        """Generate an inventory delta for the current transform."""
1755
1447
        inventory_delta = []
1756
 
        child_pb = ui.ui_factory.nested_progress_bar()
 
1448
        child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1757
1449
        new_paths = self._inventory_altered()
1758
1450
        total_entries = len(new_paths) + len(self._removed_id)
1759
1451
        try:
1760
1452
            for num, trans_id in enumerate(self._removed_id):
1761
1453
                if (num % 10) == 0:
1762
 
                    child_pb.update(gettext('removing file'), num, total_entries)
 
1454
                    child_pb.update('removing file', num, total_entries)
1763
1455
                if trans_id == self._new_root:
1764
1456
                    file_id = self._tree.get_root_id()
1765
1457
                else:
1777
1469
            final_kinds = {}
1778
1470
            for num, (path, trans_id) in enumerate(new_paths):
1779
1471
                if (num % 10) == 0:
1780
 
                    child_pb.update(gettext('adding file'),
 
1472
                    child_pb.update('adding file',
1781
1473
                                    num + len(self._removed_id), total_entries)
1782
1474
                file_id = new_path_file_ids[trans_id]
1783
1475
                if file_id is None:
1784
1476
                    continue
1785
1477
                needs_entry = False
1786
 
                kind = self.final_kind(trans_id)
1787
 
                if kind is None:
 
1478
                try:
 
1479
                    kind = self.final_kind(trans_id)
 
1480
                except NoSuchFile:
1788
1481
                    kind = self._tree.stored_kind(file_id)
1789
1482
                parent_trans_id = self.final_parent(trans_id)
1790
1483
                parent_file_id = new_path_file_ids.get(parent_trans_id)
1821
1514
        """
1822
1515
        tree_paths = list(self._tree_path_ids.iteritems())
1823
1516
        tree_paths.sort(reverse=True)
1824
 
        child_pb = ui.ui_factory.nested_progress_bar()
 
1517
        child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1825
1518
        try:
1826
 
            for num, (path, trans_id) in enumerate(tree_paths):
1827
 
                # do not attempt to move root into a subdirectory of itself.
1828
 
                if path == '':
1829
 
                    continue
1830
 
                child_pb.update(gettext('removing file'), num, len(tree_paths))
 
1519
            for num, data in enumerate(tree_paths):
 
1520
                path, trans_id = data
 
1521
                child_pb.update('removing file', num, len(tree_paths))
1831
1522
                full_path = self._tree.abspath(path)
1832
1523
                if trans_id in self._removed_contents:
1833
 
                    delete_path = os.path.join(self._deletiondir, trans_id)
1834
 
                    mover.pre_delete(full_path, delete_path)
1835
 
                elif (trans_id in self._new_name
1836
 
                      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:
1837
1528
                    try:
1838
1529
                        mover.rename(full_path, self._limbo_name(trans_id))
1839
 
                    except errors.TransformRenameFailed, e:
 
1530
                    except OSError, e:
1840
1531
                        if e.errno != errno.ENOENT:
1841
1532
                            raise
1842
1533
                    else:
1858
1549
        modified_paths = []
1859
1550
        new_path_file_ids = dict((t, self.final_file_id(t)) for p, t in
1860
1551
                                 new_paths)
1861
 
        child_pb = ui.ui_factory.nested_progress_bar()
 
1552
        child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1862
1553
        try:
1863
1554
            for num, (path, trans_id) in enumerate(new_paths):
1864
1555
                if (num % 10) == 0:
1865
 
                    child_pb.update(gettext('adding file'), num, len(new_paths))
 
1556
                    child_pb.update('adding file', num, len(new_paths))
1866
1557
                full_path = self._tree.abspath(path)
1867
1558
                if trans_id in self._needs_rename:
1868
1559
                    try:
1869
1560
                        mover.rename(self._limbo_name(trans_id), full_path)
1870
 
                    except errors.TransformRenameFailed, e:
 
1561
                    except OSError, e:
1871
1562
                        # We may be renaming a dangling inventory id
1872
1563
                        if e.errno != errno.ENOENT:
1873
1564
                            raise
1874
1565
                    else:
1875
1566
                        self.rename_count += 1
1876
 
                    # TODO: if trans_id in self._observed_sha1s, we should
1877
 
                    #       re-stat the final target, since ctime will be
1878
 
                    #       updated by the change.
1879
1567
                if (trans_id in self._new_contents or
1880
1568
                    self.path_changed(trans_id)):
1881
1569
                    if trans_id in self._new_contents:
1882
1570
                        modified_paths.append(full_path)
1883
1571
                if trans_id in self._new_executability:
1884
1572
                    self._set_executability(path, trans_id)
1885
 
                if trans_id in self._observed_sha1s:
1886
 
                    o_sha1, o_st_val = self._observed_sha1s[trans_id]
1887
 
                    st = osutils.lstat(full_path)
1888
 
                    self._observed_sha1s[trans_id] = (o_sha1, st)
1889
1573
        finally:
1890
1574
            child_pb.finished()
1891
 
        for path, trans_id in new_paths:
1892
 
            # new_paths includes stuff like workingtree conflicts. Only the
1893
 
            # stuff in new_contents actually comes from limbo.
1894
 
            if trans_id in self._limbo_files:
1895
 
                del self._limbo_files[trans_id]
1896
1575
        self._new_contents.clear()
1897
1576
        return modified_paths
1898
1577
 
1899
 
    def _apply_observed_sha1s(self):
1900
 
        """After we have finished renaming everything, update observed sha1s
1901
 
 
1902
 
        This has to be done after self._tree.apply_inventory_delta, otherwise
1903
 
        it doesn't know anything about the files we are updating. Also, we want
1904
 
        to do this as late as possible, so that most entries end up cached.
1905
 
        """
1906
 
        # TODO: this doesn't update the stat information for directories. So
1907
 
        #       the first 'bzr status' will still need to rewrite
1908
 
        #       .bzr/checkout/dirstate. However, we at least don't need to
1909
 
        #       re-read all of the files.
1910
 
        # TODO: If the operation took a while, we could do a time.sleep(3) here
1911
 
        #       to allow the clock to tick over and ensure we won't have any
1912
 
        #       problems. (we could observe start time, and finish time, and if
1913
 
        #       it is less than eg 10% overhead, add a sleep call.)
1914
 
        paths = FinalPaths(self)
1915
 
        for trans_id, observed in self._observed_sha1s.iteritems():
1916
 
            path = paths.get_path(trans_id)
1917
 
            # We could get the file_id, but dirstate prefers to use the path
1918
 
            # anyway, and it is 'cheaper' to determine.
1919
 
            # file_id = self._new_id[trans_id]
1920
 
            self._tree._observed_sha1(None, path, observed)
1921
 
 
1922
1578
 
1923
1579
class TransformPreview(DiskTreeTransform):
1924
1580
    """A TreeTransform for generating preview trees.
1928
1584
    unversioned files in the input tree.
1929
1585
    """
1930
1586
 
1931
 
    def __init__(self, tree, pb=None, case_sensitive=True):
 
1587
    def __init__(self, tree, pb=DummyProgress(), case_sensitive=True):
1932
1588
        tree.lock_read()
1933
1589
        limbodir = osutils.mkdtemp(prefix='bzr-limbo-')
1934
1590
        DiskTreeTransform.__init__(self, tree, limbodir, pb, case_sensitive)
1939
1595
    def tree_kind(self, trans_id):
1940
1596
        path = self._tree_id_paths.get(trans_id)
1941
1597
        if path is None:
1942
 
            return None
1943
 
        kind = self._tree.path_content_summary(path)[0]
1944
 
        if kind == 'missing':
1945
 
            kind = None
1946
 
        return kind
 
1598
            raise NoSuchFile(None)
 
1599
        file_id = self._tree.path2id(path)
 
1600
        return self._tree.kind(file_id)
1947
1601
 
1948
1602
    def _set_mode(self, trans_id, mode_id, typefunc):
1949
1603
        """Set the mode of new file contents.
1969
1623
            childpath = joinpath(path, child)
1970
1624
            yield self.trans_id_tree_path(childpath)
1971
1625
 
1972
 
    def new_orphan(self, trans_id, parent_id):
1973
 
        raise NotImplementedError(self.new_orphan)
1974
 
 
1975
 
 
1976
 
class _PreviewTree(tree.InventoryTree):
 
1626
 
 
1627
class _PreviewTree(tree.Tree):
1977
1628
    """Partial implementation of Tree to support show_diff_trees"""
1978
1629
 
1979
1630
    def __init__(self, transform):
1984
1635
        self._all_children_cache = {}
1985
1636
        self._path2trans_id_cache = {}
1986
1637
        self._final_name_cache = {}
1987
 
        self._iter_changes_cache = dict((c[0], c) for c in
1988
 
                                        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
1989
1643
 
1990
1644
    def _content_change(self, file_id):
1991
1645
        """Return True if the content of this file changed"""
1992
 
        changes = self._iter_changes_cache.get(file_id)
 
1646
        changes = self._changes(file_id)
1993
1647
        # changes[2] is true if the file content changed.  See
1994
1648
        # InterTree.iter_changes.
1995
1649
        return (changes is not None and changes[2])
2008
1662
                yield self._get_repository().revision_tree(revision_id)
2009
1663
 
2010
1664
    def _get_file_revision(self, file_id, vf, tree_revision):
2011
 
        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
2012
1666
                       self._iter_parent_trees()]
2013
1667
        vf.add_lines((file_id, tree_revision), parent_keys,
2014
 
                     self.get_file_lines(file_id))
 
1668
                     self.get_file(file_id).readlines())
2015
1669
        repo = self._get_repository()
2016
1670
        base_vf = repo.texts
2017
1671
        if base_vf not in vf.fallback_versionedfiles:
2018
1672
            vf.fallback_versionedfiles.append(base_vf)
2019
1673
        return tree_revision
2020
1674
 
2021
 
    def _stat_limbo_file(self, file_id=None, trans_id=None):
2022
 
        if trans_id is None:
2023
 
            trans_id = self._transform.trans_id_file_id(file_id)
 
1675
    def _stat_limbo_file(self, file_id):
 
1676
        trans_id = self._transform.trans_id_file_id(file_id)
2024
1677
        name = self._transform._limbo_name(trans_id)
2025
1678
        return os.lstat(name)
2026
1679
 
2040
1693
            executable = self.is_executable(file_id, path)
2041
1694
        return kind, executable, None
2042
1695
 
2043
 
    def is_locked(self):
2044
 
        return False
2045
 
 
2046
1696
    def lock_read(self):
2047
1697
        # Perhaps in theory, this should lock the TreeTransform?
2048
 
        return self
 
1698
        pass
2049
1699
 
2050
1700
    def unlock(self):
2051
1701
        pass
2052
1702
 
2053
1703
    @property
2054
 
    @deprecated_method(deprecated_in((2, 5, 0)))
2055
1704
    def inventory(self):
2056
1705
        """This Tree does not use inventory as its backing data."""
2057
1706
        raise NotImplementedError(_PreviewTree.inventory)
2058
1707
 
2059
 
    @property
2060
 
    def root_inventory(self):
2061
 
        """This Tree does not use inventory as its backing data."""
2062
 
        raise NotImplementedError(_PreviewTree.root_inventory)
2063
 
 
2064
1708
    def get_root_id(self):
2065
1709
        return self._transform.final_file_id(self._transform.root)
2066
1710
 
2112
1756
        return cur_parent
2113
1757
 
2114
1758
    def path2id(self, path):
2115
 
        if isinstance(path, list):
2116
 
            if path == []:
2117
 
                path = [""]
2118
 
            path = osutils.pathjoin(*path)
2119
1759
        return self._transform.final_file_id(self._path2trans_id(path))
2120
1760
 
2121
1761
    def id2path(self, file_id):
2159
1799
            if (specific_file_ids is not None
2160
1800
                and file_id not in specific_file_ids):
2161
1801
                continue
2162
 
            kind = self._transform.final_kind(trans_id)
2163
 
            if kind is None:
 
1802
            try:
 
1803
                kind = self._transform.final_kind(trans_id)
 
1804
            except NoSuchFile:
2164
1805
                kind = self._transform._tree.stored_kind(file_id)
2165
1806
            new_entry = inventory.make_entry(
2166
1807
                kind,
2182
1823
                ordered_ids.append((trans_id, parent_file_id))
2183
1824
        return ordered_ids
2184
1825
 
2185
 
    def iter_child_entries(self, file_id, path=None):
2186
 
        self.id2path(file_id)
2187
 
        trans_id = self._transform.trans_id_file_id(file_id)
2188
 
        todo = [(child_trans_id, trans_id) for child_trans_id in
2189
 
                self._all_children(trans_id)]
2190
 
        for entry, trans_id in self._make_inv_entries(todo):
2191
 
            yield entry
2192
 
 
2193
1826
    def iter_entries_by_dir(self, specific_file_ids=None, yield_parents=False):
2194
1827
        # This may not be a maximally efficient implementation, but it is
2195
1828
        # reasonably straightforward.  An implementation that grafts the
2251
1884
    def get_file_mtime(self, file_id, path=None):
2252
1885
        """See Tree.get_file_mtime"""
2253
1886
        if not self._content_change(file_id):
2254
 
            return self._transform._tree.get_file_mtime(file_id)
 
1887
            return self._transform._tree.get_file_mtime(file_id, path)
2255
1888
        return self._stat_limbo_file(file_id).st_mtime
2256
1889
 
2257
1890
    def _file_size(self, entry, stat_value):
2259
1892
 
2260
1893
    def get_file_size(self, file_id):
2261
1894
        """See Tree.get_file_size"""
2262
 
        trans_id = self._transform.trans_id_file_id(file_id)
2263
 
        kind = self._transform.final_kind(trans_id)
2264
 
        if kind != 'file':
2265
 
            return None
2266
 
        if trans_id in self._transform._new_contents:
2267
 
            return self._stat_limbo_file(trans_id=trans_id).st_size
2268
1895
        if self.kind(file_id) == 'file':
2269
1896
            return self._transform._tree.get_file_size(file_id)
2270
1897
        else:
2271
1898
            return None
2272
1899
 
2273
 
    def get_file_verifier(self, file_id, path=None, stat_value=None):
2274
 
        trans_id = self._transform.trans_id_file_id(file_id)
2275
 
        kind = self._transform._new_contents.get(trans_id)
2276
 
        if kind is None:
2277
 
            return self._transform._tree.get_file_verifier(file_id)
2278
 
        if kind == 'file':
2279
 
            fileobj = self.get_file(file_id)
2280
 
            try:
2281
 
                return ("SHA1", sha_file(fileobj))
2282
 
            finally:
2283
 
                fileobj.close()
2284
 
 
2285
1900
    def get_file_sha1(self, file_id, path=None, stat_value=None):
2286
1901
        trans_id = self._transform.trans_id_file_id(file_id)
2287
1902
        kind = self._transform._new_contents.get(trans_id)
2310
1925
            except errors.NoSuchId:
2311
1926
                return False
2312
1927
 
2313
 
    def has_filename(self, path):
2314
 
        trans_id = self._path2trans_id(path)
2315
 
        if trans_id in self._transform._new_contents:
2316
 
            return True
2317
 
        elif trans_id in self._transform._removed_contents:
2318
 
            return False
2319
 
        else:
2320
 
            return self._transform._tree.has_filename(path)
2321
 
 
2322
1928
    def path_content_summary(self, path):
2323
1929
        trans_id = self._path2trans_id(path)
2324
1930
        tt = self._transform
2337
1943
            if kind == 'file':
2338
1944
                statval = os.lstat(limbo_name)
2339
1945
                size = statval.st_size
2340
 
                if not tt._limbo_supports_executable():
2341
 
                    executable = False
 
1946
                if not supports_executable():
 
1947
                    executable = None
2342
1948
                else:
2343
1949
                    executable = statval.st_mode & S_IEXEC
2344
1950
            else:
2346
1952
                executable = None
2347
1953
            if kind == 'symlink':
2348
1954
                link_or_sha1 = os.readlink(limbo_name).decode(osutils._fs_enc)
2349
 
        executable = tt._new_executability.get(trans_id, executable)
 
1955
        if supports_executable():
 
1956
            executable = tt._new_executability.get(trans_id, executable)
2350
1957
        return kind, size, executable, link_or_sha1
2351
1958
 
2352
1959
    def iter_changes(self, from_tree, include_unchanged=False,
2383
1990
 
2384
1991
    def annotate_iter(self, file_id,
2385
1992
                      default_revision=_mod_revision.CURRENT_REVISION):
2386
 
        changes = self._iter_changes_cache.get(file_id)
 
1993
        changes = self._changes(file_id)
2387
1994
        if changes is None:
2388
1995
            get_old = True
2389
1996
        else:
2412
2019
                                   self.get_file(file_id).readlines(),
2413
2020
                                   default_revision)
2414
2021
 
2415
 
    def get_symlink_target(self, file_id, path=None):
 
2022
    def get_symlink_target(self, file_id):
2416
2023
        """See Tree.get_symlink_target"""
2417
2024
        if not self._content_change(file_id):
2418
2025
            return self._transform._tree.get_symlink_target(file_id)
2433
2040
                path_from_root = self._final_paths.get_path(child_id)
2434
2041
                basename = self._transform.final_name(child_id)
2435
2042
                file_id = self._transform.final_file_id(child_id)
2436
 
                kind  = self._transform.final_kind(child_id)
2437
 
                if kind is not None:
 
2043
                try:
 
2044
                    kind = self._transform.final_kind(child_id)
2438
2045
                    versioned_kind = kind
2439
 
                else:
 
2046
                except NoSuchFile:
2440
2047
                    kind = 'unknown'
2441
2048
                    versioned_kind = self._transform._tree.stored_kind(file_id)
2442
2049
                if versioned_kind == 'directory':
2555
2162
    for num, _unused in enumerate(wt.all_file_ids()):
2556
2163
        if num > 0:  # more than just a root
2557
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)
2558
2168
    file_trans_id = {}
2559
 
    top_pb = ui.ui_factory.nested_progress_bar()
 
2169
    top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
2560
2170
    pp = ProgressPhase("Build phase", 2, top_pb)
2561
 
    if tree.get_root_id() is not None:
 
2171
    if tree.inventory.root is not None:
2562
2172
        # This is kind of a hack: we should be altering the root
2563
2173
        # as part of the regular tree shape diff logic.
2564
2174
        # The conditional test here is to avoid doing an
2575
2185
        pp.next_phase()
2576
2186
        file_trans_id[wt.get_root_id()] = \
2577
2187
            tt.trans_id_tree_file_id(wt.get_root_id())
2578
 
        pb = ui.ui_factory.nested_progress_bar()
 
2188
        pb = bzrlib.ui.ui_factory.nested_progress_bar()
2579
2189
        try:
2580
2190
            deferred_contents = []
2581
2191
            num = 0
2582
 
            total = len(tree.all_file_ids())
 
2192
            total = len(tree.inventory)
2583
2193
            if delta_from_tree:
2584
2194
                precomputed_delta = []
2585
2195
            else:
2586
2196
                precomputed_delta = None
2587
 
            # Check if tree inventory has content. If so, we populate
2588
 
            # existing_files with the directory content. If there are no
2589
 
            # entries we skip populating existing_files as its not used.
2590
 
            # This improves performance and unncessary work on large
2591
 
            # directory trees. (#501307)
2592
 
            if total > 0:
2593
 
                existing_files = set()
2594
 
                for dir, files in wt.walkdirs():
2595
 
                    existing_files.update(f[0] for f in files)
2596
2197
            for num, (tree_path, entry) in \
2597
 
                enumerate(tree.iter_entries_by_dir()):
2598
 
                pb.update(gettext("Building tree"), num - len(deferred_contents), total)
 
2198
                enumerate(tree.inventory.iter_entries_by_dir()):
 
2199
                pb.update("Building tree", num - len(deferred_contents), total)
2599
2200
                if entry.parent_id is None:
2600
2201
                    continue
2601
2202
                reparent = False
2607
2208
                    kind = file_kind(target_path)
2608
2209
                    if kind == "directory":
2609
2210
                        try:
2610
 
                            controldir.ControlDir.open(target_path)
 
2211
                            bzrdir.BzrDir.open(target_path)
2611
2212
                        except errors.NotBranchError:
2612
2213
                            pass
2613
2214
                        else:
2628
2229
                    executable = tree.is_executable(file_id, tree_path)
2629
2230
                    if executable:
2630
2231
                        tt.set_executability(executable, trans_id)
2631
 
                    trans_data = (trans_id, tree_path, entry.text_sha1)
 
2232
                    trans_data = (trans_id, tree_path)
2632
2233
                    deferred_contents.append((file_id, trans_data))
2633
2234
                else:
2634
2235
                    file_trans_id[file_id] = new_by_entry(tt, entry, parent_id,
2650
2251
            precomputed_delta = None
2651
2252
        conflicts = cook_conflicts(raw_conflicts, tt)
2652
2253
        for conflict in conflicts:
2653
 
            trace.warning(unicode(conflict))
 
2254
            warning(conflict)
2654
2255
        try:
2655
2256
            wt.add_conflicts(conflicts)
2656
2257
        except errors.UnsupportedOperation:
2671
2272
        new_desired_files = desired_files
2672
2273
    else:
2673
2274
        iter = accelerator_tree.iter_changes(tree, include_unchanged=True)
2674
 
        unchanged = [(f, p[1]) for (f, p, c, v, d, n, k, e)
2675
 
                     in iter if not (c or e[0] != e[1])]
2676
 
        if accelerator_tree.supports_content_filtering():
2677
 
            unchanged = [(f, p) for (f, p) in unchanged
2678
 
                         if not accelerator_tree.iter_search_rules([p]).next()]
2679
 
        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]))
2680
2277
        new_desired_files = []
2681
2278
        count = 0
2682
 
        for file_id, (trans_id, tree_path, text_sha1) in desired_files:
 
2279
        for file_id, (trans_id, tree_path) in desired_files:
2683
2280
            accelerator_path = unchanged.get(file_id)
2684
2281
            if accelerator_path is None:
2685
 
                new_desired_files.append((file_id,
2686
 
                    (trans_id, tree_path, text_sha1)))
 
2282
                new_desired_files.append((file_id, (trans_id, tree_path)))
2687
2283
                continue
2688
 
            pb.update(gettext('Adding file contents'), count + offset, total)
 
2284
            pb.update('Adding file contents', count + offset, total)
2689
2285
            if hardlink:
2690
2286
                tt.create_hardlink(accelerator_tree.abspath(accelerator_path),
2691
2287
                                   trans_id)
2696
2292
                    contents = filtered_output_bytes(contents, filters,
2697
2293
                        ContentFilterContext(tree_path, tree))
2698
2294
                try:
2699
 
                    tt.create_file(contents, trans_id, sha1=text_sha1)
 
2295
                    tt.create_file(contents, trans_id)
2700
2296
                finally:
2701
2297
                    try:
2702
2298
                        contents.close()
2705
2301
                        pass
2706
2302
            count += 1
2707
2303
        offset += count
2708
 
    for count, ((trans_id, tree_path, text_sha1), contents) in enumerate(
 
2304
    for count, ((trans_id, tree_path), contents) in enumerate(
2709
2305
            tree.iter_files_bytes(new_desired_files)):
2710
2306
        if wt.supports_content_filtering():
2711
2307
            filters = wt._content_filter_stack(tree_path)
2712
2308
            contents = filtered_output_bytes(contents, filters,
2713
2309
                ContentFilterContext(tree_path, tree))
2714
 
        tt.create_file(contents, trans_id, sha1=text_sha1)
2715
 
        pb.update(gettext('Adding file contents'), count + offset, total)
 
2310
        tt.create_file(contents, trans_id)
 
2311
        pb.update('Adding file contents', count + offset, total)
2716
2312
 
2717
2313
 
2718
2314
def _reparent_children(tt, old_parent, new_parent):
2719
2315
    for child in tt.iter_tree_children(old_parent):
2720
2316
        tt.adjust_path(tt.final_name(child), new_parent, child)
2721
2317
 
2722
 
 
2723
2318
def _reparent_transform_children(tt, old_parent, new_parent):
2724
2319
    by_parent = tt.by_parent()
2725
2320
    for child in by_parent[old_parent]:
2726
2321
        tt.adjust_path(tt.final_name(child), new_parent, child)
2727
2322
    return by_parent[old_parent]
2728
2323
 
2729
 
 
2730
2324
def _content_match(tree, entry, file_id, kind, target_path):
2731
2325
    if entry.kind != kind:
2732
2326
        return False
2733
2327
    if entry.kind == "directory":
2734
2328
        return True
2735
2329
    if entry.kind == "file":
2736
 
        f = file(target_path, 'rb')
2737
 
        try:
2738
 
            if tree.get_file_text(file_id) == f.read():
2739
 
                return True
2740
 
        finally:
2741
 
            f.close()
 
2330
        if tree.get_file(file_id).read() == file(target_path, 'rb').read():
 
2331
            return True
2742
2332
    elif entry.kind == "symlink":
2743
2333
        if tree.get_symlink_target(file_id) == os.readlink(target_path):
2744
2334
            return True
2796
2386
        raise errors.BadFileKindError(name, kind)
2797
2387
 
2798
2388
 
2799
 
def create_from_tree(tt, trans_id, tree, file_id, bytes=None,
2800
 
    filter_tree_path=None):
2801
 
    """Create new file contents according to tree contents.
2802
 
    
2803
 
    :param filter_tree_path: the tree path to use to lookup
2804
 
      content filters to apply to the bytes output in the working tree.
2805
 
      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.
2806
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."""
2807
2407
    kind = tree.kind(file_id)
2808
2408
    if kind == 'directory':
2809
2409
        tt.create_directory(trans_id)
2814
2414
                bytes = tree_file.readlines()
2815
2415
            finally:
2816
2416
                tree_file.close()
2817
 
        wt = tt._tree
2818
 
        if wt.supports_content_filtering() and filter_tree_path is not None:
2819
 
            filters = wt._content_filter_stack(filter_tree_path)
2820
 
            bytes = filtered_output_bytes(bytes, filters,
2821
 
                ContentFilterContext(filter_tree_path, tree))
2822
2417
        tt.create_file(bytes, trans_id)
2823
2418
    elif kind == "symlink":
2824
2419
        tt.create_symlink(tree.get_symlink_target(file_id), trans_id)
2832
2427
        tt.set_executability(entry.executable, trans_id)
2833
2428
 
2834
2429
 
 
2430
def get_backup_name(entry, by_parent, parent_trans_id, tt):
 
2431
    return _get_backup_name(entry.name, by_parent, parent_trans_id, tt)
 
2432
 
 
2433
 
 
2434
def _get_backup_name(name, by_parent, parent_trans_id, tt):
 
2435
    """Produce a backup-style name that appears to be available"""
 
2436
    def name_gen():
 
2437
        counter = 1
 
2438
        while True:
 
2439
            yield "%s.~%d~" % (name, counter)
 
2440
            counter += 1
 
2441
    for new_name in name_gen():
 
2442
        if not tt.has_named_child(by_parent, parent_trans_id, new_name):
 
2443
            return new_name
 
2444
 
 
2445
 
 
2446
def _entry_changes(file_id, entry, working_tree):
 
2447
    """Determine in which ways the inventory entry has changed.
 
2448
 
 
2449
    Returns booleans: has_contents, content_mod, meta_mod
 
2450
    has_contents means there are currently contents, but they differ
 
2451
    contents_mod means contents need to be modified
 
2452
    meta_mod means the metadata needs to be modified
 
2453
    """
 
2454
    cur_entry = working_tree.inventory[file_id]
 
2455
    try:
 
2456
        working_kind = working_tree.kind(file_id)
 
2457
        has_contents = True
 
2458
    except NoSuchFile:
 
2459
        has_contents = False
 
2460
        contents_mod = True
 
2461
        meta_mod = False
 
2462
    if has_contents is True:
 
2463
        if entry.kind != working_kind:
 
2464
            contents_mod, meta_mod = True, False
 
2465
        else:
 
2466
            cur_entry._read_tree_state(working_tree.id2path(file_id),
 
2467
                                       working_tree)
 
2468
            contents_mod, meta_mod = entry.detect_changes(cur_entry)
 
2469
            cur_entry._forget_tree_state()
 
2470
    return has_contents, contents_mod, meta_mod
 
2471
 
 
2472
 
2835
2473
def revert(working_tree, target_tree, filenames, backups=False,
2836
 
           pb=None, change_reporter=None):
 
2474
           pb=DummyProgress(), change_reporter=None):
2837
2475
    """Revert a working tree's contents to those of a target tree."""
2838
2476
    target_tree.lock_read()
2839
 
    pb = ui.ui_factory.nested_progress_bar()
2840
2477
    tt = TreeTransform(working_tree, pb)
2841
2478
    try:
2842
2479
        pp = ProgressPhase("Revert phase", 3, pb)
2847
2484
                unversioned_filter=working_tree.is_ignored)
2848
2485
            delta.report_changes(tt.iter_changes(), change_reporter)
2849
2486
        for conflict in conflicts:
2850
 
            trace.warning(unicode(conflict))
 
2487
            warning(conflict)
2851
2488
        pp.next_phase()
2852
2489
        tt.apply()
2853
2490
        working_tree.set_merge_modified(merge_modified)
2861
2498
def _prepare_revert_transform(working_tree, target_tree, tt, filenames,
2862
2499
                              backups, pp, basis_tree=None,
2863
2500
                              merge_modified=None):
2864
 
    child_pb = ui.ui_factory.nested_progress_bar()
 
2501
    pp.next_phase()
 
2502
    child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
2865
2503
    try:
2866
2504
        if merge_modified is None:
2867
2505
            merge_modified = working_tree.merge_modified()
2870
2508
                                      merge_modified, basis_tree)
2871
2509
    finally:
2872
2510
        child_pb.finished()
2873
 
    child_pb = ui.ui_factory.nested_progress_bar()
 
2511
    pp.next_phase()
 
2512
    child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
2874
2513
    try:
2875
2514
        raw_conflicts = resolve_conflicts(tt, child_pb,
2876
2515
            lambda t, c: conflict_pass(t, c, target_tree))
2884
2523
                 backups, merge_modified, basis_tree=None):
2885
2524
    if basis_tree is not None:
2886
2525
        basis_tree.lock_read()
2887
 
    # We ask the working_tree for its changes relative to the target, rather
2888
 
    # than the target changes relative to the working tree. Because WT4 has an
2889
 
    # optimizer to compare itself to a target, but no optimizer for the
2890
 
    # reverse.
2891
 
    change_list = working_tree.iter_changes(target_tree,
 
2526
    change_list = target_tree.iter_changes(working_tree,
2892
2527
        specific_files=specific_files, pb=pb)
2893
2528
    if target_tree.get_root_id() is None:
2894
2529
        skip_root = True
2898
2533
        deferred_files = []
2899
2534
        for id_num, (file_id, path, changed_content, versioned, parent, name,
2900
2535
                kind, executable) in enumerate(change_list):
2901
 
            target_path, wt_path = path
2902
 
            target_versioned, wt_versioned = versioned
2903
 
            target_parent, wt_parent = parent
2904
 
            target_name, wt_name = name
2905
 
            target_kind, wt_kind = kind
2906
 
            target_executable, wt_executable = executable
2907
 
            if skip_root and wt_parent is None:
 
2536
            if skip_root and file_id[0] is not None and parent[0] is None:
2908
2537
                continue
2909
2538
            trans_id = tt.trans_id_file_id(file_id)
2910
2539
            mode_id = None
2911
2540
            if changed_content:
2912
2541
                keep_content = False
2913
 
                if wt_kind == 'file' and (backups or target_kind is None):
 
2542
                if kind[0] == 'file' and (backups or kind[1] is None):
2914
2543
                    wt_sha1 = working_tree.get_file_sha1(file_id)
2915
2544
                    if merge_modified.get(file_id) != wt_sha1:
2916
2545
                        # acquire the basis tree lazily to prevent the
2919
2548
                        if basis_tree is None:
2920
2549
                            basis_tree = working_tree.basis_tree()
2921
2550
                            basis_tree.lock_read()
2922
 
                        if basis_tree.has_id(file_id):
 
2551
                        if file_id in basis_tree:
2923
2552
                            if wt_sha1 != basis_tree.get_file_sha1(file_id):
2924
2553
                                keep_content = True
2925
 
                        elif target_kind is None and not target_versioned:
 
2554
                        elif kind[1] is None and not versioned[1]:
2926
2555
                            keep_content = True
2927
 
                if wt_kind is not None:
 
2556
                if kind[0] is not None:
2928
2557
                    if not keep_content:
2929
2558
                        tt.delete_contents(trans_id)
2930
 
                    elif target_kind is not None:
2931
 
                        parent_trans_id = tt.trans_id_file_id(wt_parent)
2932
 
                        backup_name = tt._available_backup_name(
2933
 
                            wt_name, parent_trans_id)
 
2559
                    elif kind[1] is not None:
 
2560
                        parent_trans_id = tt.trans_id_file_id(parent[0])
 
2561
                        by_parent = tt.by_parent()
 
2562
                        backup_name = _get_backup_name(name[0], by_parent,
 
2563
                                                       parent_trans_id, tt)
2934
2564
                        tt.adjust_path(backup_name, parent_trans_id, trans_id)
2935
 
                        new_trans_id = tt.create_path(wt_name, parent_trans_id)
2936
 
                        if wt_versioned and target_versioned:
 
2565
                        new_trans_id = tt.create_path(name[0], parent_trans_id)
 
2566
                        if versioned == (True, True):
2937
2567
                            tt.unversion_file(trans_id)
2938
2568
                            tt.version_file(file_id, new_trans_id)
2939
2569
                        # New contents should have the same unix perms as old
2940
2570
                        # contents
2941
2571
                        mode_id = trans_id
2942
2572
                        trans_id = new_trans_id
2943
 
                if target_kind in ('directory', 'tree-reference'):
 
2573
                if kind[1] in ('directory', 'tree-reference'):
2944
2574
                    tt.create_directory(trans_id)
2945
 
                    if target_kind == 'tree-reference':
 
2575
                    if kind[1] == 'tree-reference':
2946
2576
                        revision = target_tree.get_reference_revision(file_id,
2947
 
                                                                      target_path)
 
2577
                                                                      path[1])
2948
2578
                        tt.set_tree_reference(revision, trans_id)
2949
 
                elif target_kind == 'symlink':
 
2579
                elif kind[1] == 'symlink':
2950
2580
                    tt.create_symlink(target_tree.get_symlink_target(file_id),
2951
2581
                                      trans_id)
2952
 
                elif target_kind == 'file':
 
2582
                elif kind[1] == 'file':
2953
2583
                    deferred_files.append((file_id, (trans_id, mode_id)))
2954
2584
                    if basis_tree is None:
2955
2585
                        basis_tree = working_tree.basis_tree()
2956
2586
                        basis_tree.lock_read()
2957
2587
                    new_sha1 = target_tree.get_file_sha1(file_id)
2958
 
                    if (basis_tree.has_id(file_id) and
2959
 
                        new_sha1 == basis_tree.get_file_sha1(file_id)):
 
2588
                    if (file_id in basis_tree and new_sha1 ==
 
2589
                        basis_tree.get_file_sha1(file_id)):
2960
2590
                        if file_id in merge_modified:
2961
2591
                            del merge_modified[file_id]
2962
2592
                    else:
2963
2593
                        merge_modified[file_id] = new_sha1
2964
2594
 
2965
2595
                    # preserve the execute bit when backing up
2966
 
                    if keep_content and wt_executable == target_executable:
2967
 
                        tt.set_executability(target_executable, trans_id)
2968
 
                elif target_kind is not None:
2969
 
                    raise AssertionError(target_kind)
2970
 
            if not wt_versioned and target_versioned:
 
2596
                    if keep_content and executable[0] == executable[1]:
 
2597
                        tt.set_executability(executable[1], trans_id)
 
2598
                elif kind[1] is not None:
 
2599
                    raise AssertionError(kind[1])
 
2600
            if versioned == (False, True):
2971
2601
                tt.version_file(file_id, trans_id)
2972
 
            if wt_versioned and not target_versioned:
 
2602
            if versioned == (True, False):
2973
2603
                tt.unversion_file(trans_id)
2974
 
            if (target_name is not None and
2975
 
                (wt_name != target_name or wt_parent != target_parent)):
2976
 
                if target_name == '' and target_parent is None:
 
2604
            if (name[1] is not None and
 
2605
                (name[0] != name[1] or parent[0] != parent[1])):
 
2606
                if name[1] == '' and parent[1] is None:
2977
2607
                    parent_trans = ROOT_PARENT
2978
2608
                else:
2979
 
                    parent_trans = tt.trans_id_file_id(target_parent)
2980
 
                if wt_parent is None and wt_versioned:
2981
 
                    tt.adjust_root_path(target_name, parent_trans)
2982
 
                else:
2983
 
                    tt.adjust_path(target_name, parent_trans, trans_id)
2984
 
            if wt_executable != target_executable and target_kind == "file":
2985
 
                tt.set_executability(target_executable, trans_id)
2986
 
        if working_tree.supports_content_filtering():
2987
 
            for index, ((trans_id, mode_id), bytes) in enumerate(
2988
 
                target_tree.iter_files_bytes(deferred_files)):
2989
 
                file_id = deferred_files[index][0]
2990
 
                # We're reverting a tree to the target tree so using the
2991
 
                # target tree to find the file path seems the best choice
2992
 
                # here IMO - Ian C 27/Oct/2009
2993
 
                filter_tree_path = target_tree.id2path(file_id)
2994
 
                filters = working_tree._content_filter_stack(filter_tree_path)
2995
 
                bytes = filtered_output_bytes(bytes, filters,
2996
 
                    ContentFilterContext(filter_tree_path, working_tree))
2997
 
                tt.create_file(bytes, trans_id, mode_id)
2998
 
        else:
2999
 
            for (trans_id, mode_id), bytes in target_tree.iter_files_bytes(
3000
 
                deferred_files):
3001
 
                tt.create_file(bytes, trans_id, mode_id)
3002
 
        tt.fixup_new_roots()
 
2609
                    parent_trans = tt.trans_id_file_id(parent[1])
 
2610
                tt.adjust_path(name[1], parent_trans, trans_id)
 
2611
            if executable[0] != executable[1] and kind[1] == "file":
 
2612
                tt.set_executability(executable[1], trans_id)
 
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)
3003
2616
    finally:
3004
2617
        if basis_tree is not None:
3005
2618
            basis_tree.unlock()
3006
2619
    return merge_modified
3007
2620
 
3008
2621
 
3009
 
def resolve_conflicts(tt, pb=None, pass_func=None):
 
2622
def resolve_conflicts(tt, pb=DummyProgress(), pass_func=None):
3010
2623
    """Make many conflict-resolution attempts, but die if they fail"""
3011
2624
    if pass_func is None:
3012
2625
        pass_func = conflict_pass
3013
2626
    new_conflicts = set()
3014
 
    pb = ui.ui_factory.nested_progress_bar()
3015
2627
    try:
3016
2628
        for n in range(10):
3017
 
            pb.update(gettext('Resolution pass'), n+1, 10)
 
2629
            pb.update('Resolution pass', n+1, 10)
3018
2630
            conflicts = tt.find_conflicts()
3019
2631
            if len(conflicts) == 0:
3020
2632
                return new_conflicts
3021
2633
            new_conflicts.update(pass_func(tt, conflicts))
3022
2634
        raise MalformedTransform(conflicts=conflicts)
3023
2635
    finally:
3024
 
        pb.finished()
 
2636
        pb.clear()
3025
2637
 
3026
2638
 
3027
2639
def conflict_pass(tt, conflicts, path_tree=None):
3044
2656
                existing_file, new_file = conflict[2], conflict[1]
3045
2657
            else:
3046
2658
                existing_file, new_file = conflict[1], conflict[2]
3047
 
            new_name = tt.final_name(existing_file) + '.moved'
 
2659
            new_name = tt.final_name(existing_file)+'.moved'
3048
2660
            tt.adjust_path(new_name, final_parent, existing_file)
3049
2661
            new_conflicts.add((c_type, 'Moved existing file to',
3050
2662
                               existing_file, new_file))
3059
2671
 
3060
2672
        elif c_type == 'missing parent':
3061
2673
            trans_id = conflict[1]
3062
 
            if trans_id in tt._removed_contents:
3063
 
                cancel_deletion = True
3064
 
                orphans = tt._get_potential_orphans(trans_id)
3065
 
                if orphans:
3066
 
                    cancel_deletion = False
3067
 
                    # All children are orphans
3068
 
                    for o in orphans:
3069
 
                        try:
3070
 
                            tt.new_orphan(o, trans_id)
3071
 
                        except OrphaningError:
3072
 
                            # Something bad happened so we cancel the directory
3073
 
                            # deletion which will leave it in place with a
3074
 
                            # conflict. The user can deal with it from there.
3075
 
                            # Note that this also catch the case where we don't
3076
 
                            # want to create orphans and leave the directory in
3077
 
                            # place.
3078
 
                            cancel_deletion = True
3079
 
                            break
3080
 
                if cancel_deletion:
3081
 
                    # Cancel the directory deletion
3082
 
                    tt.cancel_deletion(trans_id)
3083
 
                    new_conflicts.add(('deleting parent', 'Not deleting',
3084
 
                                       trans_id))
3085
 
            else:
 
2674
            try:
 
2675
                tt.cancel_deletion(trans_id)
 
2676
                new_conflicts.add(('deleting parent', 'Not deleting',
 
2677
                                   trans_id))
 
2678
            except KeyError:
3086
2679
                create = True
3087
2680
                try:
3088
2681
                    tt.final_name(trans_id)
3091
2684
                        file_id = tt.final_file_id(trans_id)
3092
2685
                        if file_id is None:
3093
2686
                            file_id = tt.inactive_file_id(trans_id)
3094
 
                        _, entry = path_tree.iter_entries_by_dir(
3095
 
                            [file_id]).next()
 
2687
                        entry = path_tree.inventory[file_id]
3096
2688
                        # special-case the other tree root (move its
3097
2689
                        # children to current root)
3098
2690
                        if entry.parent_id is None:
3099
 
                            create = False
 
2691
                            create=False
3100
2692
                            moved = _reparent_transform_children(
3101
2693
                                tt, trans_id, tt.root)
3102
2694
                            for child in moved:
3113
2705
        elif c_type == 'unversioned parent':
3114
2706
            file_id = tt.inactive_file_id(conflict[1])
3115
2707
            # special-case the other tree root (move its children instead)
3116
 
            if path_tree and path_tree.has_id(file_id):
3117
 
                if path_tree.path2id('') == file_id:
3118
 
                    # This is the root entry, skip it
 
2708
            if path_tree and file_id in path_tree:
 
2709
                if path_tree.inventory[file_id].parent_id is None:
3119
2710
                    continue
3120
2711
            tt.version_file(file_id, conflict[1])
3121
2712
            new_conflicts.add((c_type, 'Versioned directory', conflict[1]))
3137
2728
 
3138
2729
def cook_conflicts(raw_conflicts, tt):
3139
2730
    """Generate a list of cooked conflicts, sorted by file path"""
 
2731
    from bzrlib.conflicts import Conflict
3140
2732
    conflict_iter = iter_cook_conflicts(raw_conflicts, tt)
3141
 
    return sorted(conflict_iter, key=conflicts.Conflict.sort_key)
 
2733
    return sorted(conflict_iter, key=Conflict.sort_key)
3142
2734
 
3143
2735
 
3144
2736
def iter_cook_conflicts(raw_conflicts, tt):
 
2737
    from bzrlib.conflicts import Conflict
3145
2738
    fp = FinalPaths(tt)
3146
2739
    for conflict in raw_conflicts:
3147
2740
        c_type = conflict[0]
3149
2742
        modified_path = fp.get_path(conflict[2])
3150
2743
        modified_id = tt.final_file_id(conflict[2])
3151
2744
        if len(conflict) == 3:
3152
 
            yield conflicts.Conflict.factory(
3153
 
                c_type, action=action, path=modified_path, file_id=modified_id)
 
2745
            yield Conflict.factory(c_type, action=action, path=modified_path,
 
2746
                                     file_id=modified_id)
3154
2747
 
3155
2748
        else:
3156
2749
            conflicting_path = fp.get_path(conflict[3])
3157
2750
            conflicting_id = tt.final_file_id(conflict[3])
3158
 
            yield conflicts.Conflict.factory(
3159
 
                c_type, action=action, path=modified_path,
3160
 
                file_id=modified_id,
3161
 
                conflict_path=conflicting_path,
3162
 
                conflict_file_id=conflicting_id)
 
2751
            yield Conflict.factory(c_type, action=action, path=modified_path,
 
2752
                                   file_id=modified_id,
 
2753
                                   conflict_path=conflicting_path,
 
2754
                                   conflict_file_id=conflicting_id)
3163
2755
 
3164
2756
 
3165
2757
class _FileMover(object):
3170
2762
        self.pending_deletions = []
3171
2763
 
3172
2764
    def rename(self, from_, to):
3173
 
        """Rename a file from one path to another."""
 
2765
        """Rename a file from one path to another.  Functions like os.rename"""
3174
2766
        try:
3175
2767
            os.rename(from_, to)
3176
2768
        except OSError, e:
3177
2769
            if e.errno in (errno.EEXIST, errno.ENOTEMPTY):
3178
2770
                raise errors.FileExists(to, str(e))
3179
 
            # normal OSError doesn't include filenames so it's hard to see where
3180
 
            # the problem is, see https://bugs.launchpad.net/bzr/+bug/491763
3181
 
            raise errors.TransformRenameFailed(from_, to, str(e), e.errno)
 
2771
            raise
3182
2772
        self.past_renames.append((from_, to))
3183
2773
 
3184
2774
    def pre_delete(self, from_, to):
3194
2784
    def rollback(self):
3195
2785
        """Reverse all renames that have been performed"""
3196
2786
        for from_, to in reversed(self.past_renames):
3197
 
            try:
3198
 
                os.rename(to, from_)
3199
 
            except OSError, e:
3200
 
                raise errors.TransformRenameFailed(to, from_, str(e), e.errno)
 
2787
            os.rename(to, from_)
3201
2788
        # after rollback, don't reuse _FileMover
3202
2789
        past_renames = None
3203
2790
        pending_deletions = None