/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/transform.py

First attempt to merge .dev and resolve the conflicts (but tests are 
failing)

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/transform.py
1
 
# Copyright (C) 2006 Canonical Ltd
 
1
# Copyright (C) 2006, 2007, 2008 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
16
16
 
17
17
import os
18
18
import errno
19
 
from stat import S_ISREG
 
19
from stat import S_ISREG, S_IEXEC
 
20
import tempfile
20
21
 
21
 
from bzrlib import bzrdir, errors
 
22
from bzrlib.lazy_import import lazy_import
 
23
lazy_import(globals(), """
 
24
from bzrlib import (
 
25
    annotate,
 
26
    bzrdir,
 
27
    delta,
 
28
    errors,
 
29
    inventory,
 
30
    osutils,
 
31
    revision as _mod_revision,
 
32
    )
 
33
""")
22
34
from bzrlib.errors import (DuplicateKey, MalformedTransform, NoSuchFile,
23
35
                           ReusingTransform, NotVersionedError, CantMoveRoot,
24
 
                           ExistingLimbo, ImmortalLimbo)
 
36
                           ExistingLimbo, ImmortalLimbo, NoFinalPath,
 
37
                           UnableCreateSymlink)
25
38
from bzrlib.inventory import InventoryEntry
26
 
from bzrlib.osutils import (file_kind, supports_executable, pathjoin, lexists,
27
 
                            delete_any)
 
39
from bzrlib.osutils import (
 
40
    delete_any,
 
41
    file_kind,
 
42
    has_symlinks,
 
43
    lexists,
 
44
    pathjoin,
 
45
    splitpath,
 
46
    supports_executable,
 
47
)
28
48
from bzrlib.progress import DummyProgress, ProgressPhase
 
49
from bzrlib.symbol_versioning import (
 
50
        deprecated_function,
 
51
        )
29
52
from bzrlib.trace import mutter, warning
30
53
from bzrlib import tree
31
 
import bzrlib.ui 
 
54
import bzrlib.ui
32
55
import bzrlib.urlutils as urlutils
33
56
 
34
57
 
42
65
 
43
66
 
44
67
class _TransformResults(object):
45
 
    def __init__(self, modified_paths):
 
68
    def __init__(self, modified_paths, rename_count):
46
69
        object.__init__(self)
47
70
        self.modified_paths = modified_paths
48
 
 
49
 
 
50
 
class TreeTransform(object):
51
 
    """Represent a tree transformation.
52
 
    
53
 
    This object is designed to support incremental generation of the transform,
54
 
    in any order.  
55
 
    
56
 
    It is easy to produce malformed transforms, but they are generally
57
 
    harmless.  Attempting to apply a malformed transform will cause an
58
 
    exception to be raised before any modifications are made to the tree.  
59
 
 
60
 
    Many kinds of malformed transforms can be corrected with the 
61
 
    resolve_conflicts function.  The remaining ones indicate programming error,
62
 
    such as trying to create a file with no path.
63
 
 
64
 
    Two sets of file creation methods are supplied.  Convenience methods are:
65
 
     * new_file
66
 
     * new_directory
67
 
     * new_symlink
68
 
 
69
 
    These are composed of the low-level methods:
70
 
     * create_path
71
 
     * create_file or create_directory or create_symlink
72
 
     * version_file
73
 
     * set_executability
74
 
    """
75
 
    def __init__(self, tree, pb=DummyProgress()):
76
 
        """Note: a tree_write lock is taken on the tree.
77
 
        
78
 
        Use TreeTransform.finalize() to release the lock
 
71
        self.rename_count = rename_count
 
72
 
 
73
 
 
74
class TreeTransformBase(object):
 
75
    """The base class for TreeTransform and TreeTransformBase"""
 
76
 
 
77
    def __init__(self, tree, limbodir, pb=DummyProgress(),
 
78
                 case_sensitive=True):
 
79
        """Constructor.
 
80
 
 
81
        :param tree: The tree that will be transformed, but not necessarily
 
82
            the output tree.
 
83
        :param limbodir: A directory where new files can be stored until
 
84
            they are installed in their proper places
 
85
        :param pb: A ProgressBar indicating how much progress is being made
 
86
        :param case_sensitive: If True, the target of the transform is
 
87
            case sensitive, not just case preserving.
79
88
        """
80
89
        object.__init__(self)
81
90
        self._tree = tree
82
 
        self._tree.lock_tree_write()
83
 
        try:
84
 
            control_files = self._tree._control_files
85
 
            self._limbodir = urlutils.local_path_from_url(
86
 
                control_files.controlfilename('limbo'))
87
 
            try:
88
 
                os.mkdir(self._limbodir)
89
 
            except OSError, e:
90
 
                if e.errno == errno.EEXIST:
91
 
                    raise ExistingLimbo(self._limbodir)
92
 
        except: 
93
 
            self._tree.unlock()
94
 
            raise
95
 
 
 
91
        self._limbodir = limbodir
 
92
        self._deletiondir = None
96
93
        self._id_number = 0
 
94
        # mapping of trans_id -> new basename
97
95
        self._new_name = {}
 
96
        # mapping of trans_id -> new parent trans_id
98
97
        self._new_parent = {}
 
98
        # mapping of trans_id with new contents -> new file_kind
99
99
        self._new_contents = {}
 
100
        # A mapping of transform ids to their limbo filename
 
101
        self._limbo_files = {}
 
102
        # A mapping of transform ids to a set of the transform ids of children
 
103
        # that their limbo directory has
 
104
        self._limbo_children = {}
 
105
        # Map transform ids to maps of child filename to child transform id
 
106
        self._limbo_children_names = {}
 
107
        # List of transform ids that need to be renamed from limbo into place
 
108
        self._needs_rename = set()
 
109
        # Set of trans_ids whose contents will be removed
100
110
        self._removed_contents = set()
 
111
        # Mapping of trans_id -> new execute-bit value
101
112
        self._new_executability = {}
 
113
        # Mapping of trans_id -> new tree-reference value
 
114
        self._new_reference_revision = {}
 
115
        # Mapping of trans_id -> new file_id
102
116
        self._new_id = {}
 
117
        # Mapping of old file-id -> trans_id
103
118
        self._non_present_ids = {}
 
119
        # Mapping of new file_id -> trans_id
104
120
        self._r_new_id = {}
 
121
        # Set of file_ids that will be removed
105
122
        self._removed_id = set()
 
123
        # Mapping of path in old tree -> trans_id
106
124
        self._tree_path_ids = {}
 
125
        # Mapping trans_id -> path in old tree
107
126
        self._tree_id_paths = {}
 
127
        # Cache of realpath results, to speed up canonical_path
108
128
        self._realpaths = {}
109
 
        # Cache of realpath results, to speed up canonical_path
 
129
        # Cache of relpath results, to speed up canonical_path
110
130
        self._relpaths = {}
111
 
        # Cache of relpath results, to speed up canonical_path
 
131
        # The trans_id that will be used as the tree root
112
132
        self._new_root = self.trans_id_tree_file_id(tree.get_root_id())
113
 
        self.__done = False
 
133
        # Indictor of whether the transform has been applied
 
134
        self._done = False
 
135
        # A progress bar
114
136
        self._pb = pb
 
137
        # Whether the target is case sensitive
 
138
        self._case_sensitive_target = case_sensitive
 
139
        # A counter of how many files have been renamed
 
140
        self.rename_count = 0
115
141
 
116
142
    def __get_root(self):
117
143
        return self._new_root
119
145
    root = property(__get_root)
120
146
 
121
147
    def finalize(self):
122
 
        """Release the working tree lock, if held, clean up limbo dir."""
 
148
        """Release the working tree lock, if held, clean up limbo dir.
 
149
 
 
150
        This is required if apply has not been invoked, but can be invoked
 
151
        even after apply.
 
152
        """
123
153
        if self._tree is None:
124
154
            return
125
155
        try:
126
 
            for trans_id, kind in self._new_contents.iteritems():
127
 
                path = self._limbo_name(trans_id)
 
156
            entries = [(self._limbo_name(t), t, k) for t, k in
 
157
                       self._new_contents.iteritems()]
 
158
            entries.sort(reverse=True)
 
159
            for path, trans_id, kind in entries:
128
160
                if kind == "directory":
129
161
                    os.rmdir(path)
130
162
                else:
134
166
            except OSError:
135
167
                # We don't especially care *why* the dir is immortal.
136
168
                raise ImmortalLimbo(self._limbodir)
 
169
            try:
 
170
                if self._deletiondir is not None:
 
171
                    os.rmdir(self._deletiondir)
 
172
            except OSError:
 
173
                raise errors.ImmortalPendingDeletion(self._deletiondir)
137
174
        finally:
138
175
            self._tree.unlock()
139
176
            self._tree = None
155
192
        """Change the path that is assigned to a transaction id."""
156
193
        if trans_id == self._new_root:
157
194
            raise CantMoveRoot
 
195
        previous_parent = self._new_parent.get(trans_id)
 
196
        previous_name = self._new_name.get(trans_id)
158
197
        self._new_name[trans_id] = name
159
198
        self._new_parent[trans_id] = parent
 
199
        if (trans_id in self._limbo_files and
 
200
            trans_id not in self._needs_rename):
 
201
            self._rename_in_limbo([trans_id])
 
202
            self._limbo_children[previous_parent].remove(trans_id)
 
203
            del self._limbo_children_names[previous_parent][previous_name]
 
204
 
 
205
    def _rename_in_limbo(self, trans_ids):
 
206
        """Fix limbo names so that the right final path is produced.
 
207
 
 
208
        This means we outsmarted ourselves-- we tried to avoid renaming
 
209
        these files later by creating them with their final names in their
 
210
        final parents.  But now the previous name or parent is no longer
 
211
        suitable, so we have to rename them.
 
212
 
 
213
        Even for trans_ids that have no new contents, we must remove their
 
214
        entries from _limbo_files, because they are now stale.
 
215
        """
 
216
        for trans_id in trans_ids:
 
217
            old_path = self._limbo_files.pop(trans_id)
 
218
            if trans_id not in self._new_contents:
 
219
                continue
 
220
            new_path = self._limbo_name(trans_id)
 
221
            os.rename(old_path, new_path)
160
222
 
161
223
    def adjust_root_path(self, name, parent):
162
224
        """Emulate moving the root by moving all children, instead.
196
258
        This reflects only files that already exist, not ones that will be
197
259
        added by transactions.
198
260
        """
199
 
        path = self._tree.inventory.id2path(inventory_id)
 
261
        path = self._tree.id2path(inventory_id)
200
262
        return self.trans_id_tree_path(path)
201
263
 
202
264
    def trans_id_file_id(self, file_id):
273
335
                os.unlink(name)
274
336
                raise
275
337
 
276
 
            for segment in contents:
277
 
                f.write(segment)
 
338
            f.writelines(contents)
278
339
        finally:
279
340
            f.close()
280
341
        self._set_mode(trans_id, mode_id, S_ISREG)
292
353
        except KeyError:
293
354
            return
294
355
        try:
295
 
            mode = os.stat(old_path).st_mode
 
356
            mode = os.stat(self._tree.abspath(old_path)).st_mode
296
357
        except OSError, e:
297
 
            if e.errno == errno.ENOENT:
 
358
            if e.errno in (errno.ENOENT, errno.ENOTDIR):
 
359
                # Either old_path doesn't exist, or the parent of the
 
360
                # target is not a directory (but will be one eventually)
 
361
                # Either way, we know it doesn't exist *right now*
 
362
                # See also bug #248448
298
363
                return
299
364
            else:
300
365
                raise
301
366
        if typefunc(mode):
302
367
            os.chmod(self._limbo_name(trans_id), mode)
303
368
 
 
369
    def create_hardlink(self, path, trans_id):
 
370
        """Schedule creation of a hard link"""
 
371
        name = self._limbo_name(trans_id)
 
372
        try:
 
373
            os.link(path, name)
 
374
        except OSError, e:
 
375
            if e.errno != errno.EPERM:
 
376
                raise
 
377
            raise errors.HardLinkNotSupported(path)
 
378
        try:
 
379
            unique_add(self._new_contents, trans_id, 'file')
 
380
        except:
 
381
            # Clean up the file, it never got registered so
 
382
            # TreeTransform.finalize() won't clean it up.
 
383
            os.unlink(name)
 
384
            raise
 
385
 
304
386
    def create_directory(self, trans_id):
305
387
        """Schedule creation of a new directory.
306
388
        
315
397
        target is a bytestring.
316
398
        See also new_symlink.
317
399
        """
318
 
        os.symlink(target, self._limbo_name(trans_id))
319
 
        unique_add(self._new_contents, trans_id, 'symlink')
 
400
        if has_symlinks():
 
401
            os.symlink(target, self._limbo_name(trans_id))
 
402
            unique_add(self._new_contents, trans_id, 'symlink')
 
403
        else:
 
404
            try:
 
405
                path = FinalPaths(self).get_path(trans_id)
 
406
            except KeyError:
 
407
                path = None
 
408
            raise UnableCreateSymlink(path=path)
320
409
 
321
410
    def cancel_creation(self, trans_id):
322
411
        """Cancel the creation of new file contents."""
323
412
        del self._new_contents[trans_id]
 
413
        children = self._limbo_children.get(trans_id)
 
414
        # if this is a limbo directory with children, move them before removing
 
415
        # the directory
 
416
        if children is not None:
 
417
            self._rename_in_limbo(children)
 
418
            del self._limbo_children[trans_id]
 
419
            del self._limbo_children_names[trans_id]
324
420
        delete_any(self._limbo_name(trans_id))
325
421
 
326
422
    def delete_contents(self, trans_id):
350
446
        else:
351
447
            unique_add(self._new_executability, trans_id, executability)
352
448
 
 
449
    def set_tree_reference(self, revision_id, trans_id):
 
450
        """Set the reference associated with a directory"""
 
451
        unique_add(self._new_reference_revision, trans_id, revision_id)
 
452
 
353
453
    def version_file(self, file_id, trans_id):
354
454
        """Schedule a file to become versioned."""
355
 
        assert file_id is not None
 
455
        if file_id is None:
 
456
            raise ValueError()
356
457
        unique_add(self._new_id, trans_id, file_id)
357
458
        unique_add(self._r_new_id, file_id, trans_id)
358
459
 
362
463
        del self._new_id[trans_id]
363
464
        del self._r_new_id[file_id]
364
465
 
365
 
    def new_paths(self):
366
 
        """Determine the paths of all new and changed files"""
367
 
        new_ids = set()
368
 
        fp = FinalPaths(self)
369
 
        for id_set in (self._new_name, self._new_parent, self._new_contents,
370
 
                       self._new_id, self._new_executability):
371
 
            new_ids.update(id_set)
372
 
        new_paths = [(fp.get_path(t), t) for t in new_ids]
373
 
        new_paths.sort()
374
 
        return new_paths
 
466
    def new_paths(self, filesystem_only=False):
 
467
        """Determine the paths of all new and changed files.
 
468
 
 
469
        :param filesystem_only: if True, only calculate values for files
 
470
            that require renames or execute bit changes.
 
471
        """
 
472
        new_ids = set()
 
473
        if filesystem_only:
 
474
            stale_ids = self._needs_rename.difference(self._new_name)
 
475
            stale_ids.difference_update(self._new_parent)
 
476
            stale_ids.difference_update(self._new_contents)
 
477
            stale_ids.difference_update(self._new_id)
 
478
            needs_rename = self._needs_rename.difference(stale_ids)
 
479
            id_sets = (needs_rename, self._new_executability)
 
480
        else:
 
481
            id_sets = (self._new_name, self._new_parent, self._new_contents,
 
482
                       self._new_id, self._new_executability)
 
483
        for id_set in id_sets:
 
484
            new_ids.update(id_set)
 
485
        return sorted(FinalPaths(self).get_paths(new_ids))
 
486
 
 
487
    def _inventory_altered(self):
 
488
        """Get the trans_ids and paths of files needing new inv entries."""
 
489
        new_ids = set()
 
490
        for id_set in [self._new_name, self._new_parent, self._new_id,
 
491
                       self._new_executability]:
 
492
            new_ids.update(id_set)
 
493
        changed_kind = set(self._removed_contents)
 
494
        changed_kind.intersection_update(self._new_contents)
 
495
        changed_kind.difference_update(new_ids)
 
496
        changed_kind = (t for t in changed_kind if self.tree_kind(t) !=
 
497
                        self.final_kind(t))
 
498
        new_ids.update(changed_kind)
 
499
        return sorted(FinalPaths(self).get_paths(new_ids))
375
500
 
376
501
    def tree_kind(self, trans_id):
377
502
        """Determine the file kind in the working tree.
412
537
            return None
413
538
        # the file is old; the old id is still valid
414
539
        if self._new_root == trans_id:
415
 
            return self._tree.inventory.root.file_id
 
540
            return self._tree.get_root_id()
416
541
        return self._tree.inventory.path2id(path)
417
542
 
418
543
    def final_file_id(self, trans_id):
422
547
        applied.
423
548
        """
424
549
        try:
425
 
            # there is a new id for this file
426
 
            assert self._new_id[trans_id] is not None
427
550
            return self._new_id[trans_id]
428
551
        except KeyError:
429
552
            if trans_id in self._removed_id:
457
580
        try:
458
581
            return self._new_name[trans_id]
459
582
        except KeyError:
460
 
            return os.path.basename(self._tree_id_paths[trans_id])
 
583
            try:
 
584
                return os.path.basename(self._tree_id_paths[trans_id])
 
585
            except KeyError:
 
586
                raise NoFinalPath(trans_id, self)
461
587
 
462
588
    def by_parent(self):
463
589
        """Return a map of parent: children for known parents.
483
609
 
484
610
    def find_conflicts(self):
485
611
        """Find any violations of inventory or filesystem invariants"""
486
 
        if self.__done is True:
 
612
        if self._done is True:
487
613
            raise ReusingTransform()
488
614
        conflicts = []
489
615
        # ensure all children of all existent parents are known
511
637
                        self.tree_kind(t) == 'directory'])
512
638
        for trans_id in self._removed_id:
513
639
            file_id = self.tree_file_id(trans_id)
514
 
            if self._tree.inventory[file_id].kind == 'directory':
 
640
            if file_id is not None:
 
641
                if self._tree.inventory[file_id].kind == 'directory':
 
642
                    parents.append(trans_id)
 
643
            elif self.tree_kind(trans_id) == 'directory':
515
644
                parents.append(trans_id)
516
645
 
517
646
        for parent_id in parents:
527
656
        try:
528
657
            children = os.listdir(self._tree.abspath(path))
529
658
        except OSError, e:
530
 
            if e.errno != errno.ENOENT and e.errno != errno.ESRCH:
 
659
            if not (osutils._is_error_enotdir(e)
 
660
                    or e.errno in (errno.ENOENT, errno.ESRCH)):
531
661
                raise
532
662
            return
533
 
            
 
663
 
534
664
        for child in children:
535
665
            childpath = joinpath(path, child)
536
666
            if self._tree.is_control_filename(childpath):
570
700
            parent_id = trans_id
571
701
            while parent_id is not ROOT_PARENT:
572
702
                seen.add(parent_id)
573
 
                parent_id = self.final_parent(parent_id)
 
703
                try:
 
704
                    parent_id = self.final_parent(parent_id)
 
705
                except KeyError:
 
706
                    break
574
707
                if parent_id == trans_id:
575
708
                    conflicts.append(('parent loop', trans_id))
576
709
                if parent_id in seen:
644
777
    def _duplicate_entries(self, by_parent):
645
778
        """No directory may have two entries with the same name."""
646
779
        conflicts = []
 
780
        if (self._new_name, self._new_parent) == ({}, {}):
 
781
            return conflicts
647
782
        for children in by_parent.itervalues():
648
783
            name_ids = [(self.final_name(t), t) for t in children]
 
784
            if not self._case_sensitive_target:
 
785
                name_ids = [(n.lower(), t) for n, t in name_ids]
649
786
            name_ids.sort()
650
787
            last_name = None
651
788
            last_trans_id = None
669
806
        conflicts = []
670
807
        removed_tree_ids = set((self.tree_file_id(trans_id) for trans_id in
671
808
                                self._removed_id))
672
 
        active_tree_ids = set((f for f in self._tree.inventory if
673
 
                               f not in removed_tree_ids))
 
809
        all_ids = self._tree.all_file_ids()
 
810
        active_tree_ids = all_ids.difference(removed_tree_ids)
674
811
        for trans_id, file_id in self._new_id.iteritems():
675
812
            if file_id in active_tree_ids:
676
813
                old_trans_id = self.trans_id_tree_file_id(file_id)
709
846
                continue
710
847
            return True
711
848
        return False
712
 
            
713
 
    def apply(self):
714
 
        """Apply all changes to the inventory and filesystem.
715
 
        
716
 
        If filesystem or inventory conflicts are present, MalformedTransform
717
 
        will be thrown.
718
 
        """
719
 
        conflicts = self.find_conflicts()
720
 
        if len(conflicts) != 0:
721
 
            raise MalformedTransform(conflicts=conflicts)
722
 
        limbo_inv = {}
723
 
        inv = self._tree.inventory
724
 
        child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
725
 
        try:
726
 
            child_pb.update('Apply phase', 0, 2)
727
 
            self._apply_removals(inv, limbo_inv)
728
 
            child_pb.update('Apply phase', 1, 2)
729
 
            modified_paths = self._apply_insertions(inv, limbo_inv)
730
 
        finally:
731
 
            child_pb.finished()
732
 
        self._tree._write_inventory(inv)
733
 
        self.__done = True
734
 
        self.finalize()
735
 
        return _TransformResults(modified_paths)
736
849
 
737
850
    def _limbo_name(self, trans_id):
738
851
        """Generate the limbo name of a file"""
739
 
        return pathjoin(self._limbodir, trans_id)
740
 
 
741
 
    def _apply_removals(self, inv, limbo_inv):
742
 
        """Perform tree operations that remove directory/inventory names.
743
 
        
744
 
        That is, delete files that are to be deleted, and put any files that
745
 
        need renaming into limbo.  This must be done in strict child-to-parent
746
 
        order.
747
 
        """
748
 
        tree_paths = list(self._tree_path_ids.iteritems())
749
 
        tree_paths.sort(reverse=True)
750
 
        child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
751
 
        try:
752
 
            for num, data in enumerate(tree_paths):
753
 
                path, trans_id = data
754
 
                child_pb.update('removing file', num, len(tree_paths))
755
 
                full_path = self._tree.abspath(path)
756
 
                if trans_id in self._removed_contents:
757
 
                    delete_any(full_path)
758
 
                elif trans_id in self._new_name or trans_id in \
759
 
                    self._new_parent:
760
 
                    try:
761
 
                        os.rename(full_path, self._limbo_name(trans_id))
762
 
                    except OSError, e:
763
 
                        if e.errno != errno.ENOENT:
764
 
                            raise
765
 
                if trans_id in self._removed_id:
766
 
                    if trans_id == self._new_root:
767
 
                        file_id = self._tree.inventory.root.file_id
 
852
        limbo_name = self._limbo_files.get(trans_id)
 
853
        if limbo_name is not None:
 
854
            return limbo_name
 
855
        parent = self._new_parent.get(trans_id)
 
856
        # if the parent directory is already in limbo (e.g. when building a
 
857
        # tree), choose a limbo name inside the parent, to reduce further
 
858
        # renames.
 
859
        use_direct_path = False
 
860
        if self._new_contents.get(parent) == 'directory':
 
861
            filename = self._new_name.get(trans_id)
 
862
            if filename is not None:
 
863
                if parent not in self._limbo_children:
 
864
                    self._limbo_children[parent] = set()
 
865
                    self._limbo_children_names[parent] = {}
 
866
                    use_direct_path = True
 
867
                # the direct path can only be used if no other file has
 
868
                # already taken this pathname, i.e. if the name is unused, or
 
869
                # if it is already associated with this trans_id.
 
870
                elif self._case_sensitive_target:
 
871
                    if (self._limbo_children_names[parent].get(filename)
 
872
                        in (trans_id, None)):
 
873
                        use_direct_path = True
 
874
                else:
 
875
                    for l_filename, l_trans_id in\
 
876
                        self._limbo_children_names[parent].iteritems():
 
877
                        if l_trans_id == trans_id:
 
878
                            continue
 
879
                        if l_filename.lower() == filename.lower():
 
880
                            break
768
881
                    else:
769
 
                        file_id = self.tree_file_id(trans_id)
770
 
                    del inv[file_id]
771
 
                elif trans_id in self._new_name or trans_id in self._new_parent:
772
 
                    file_id = self.tree_file_id(trans_id)
773
 
                    if file_id is not None:
774
 
                        limbo_inv[trans_id] = inv[file_id]
775
 
                        del inv[file_id]
776
 
        finally:
777
 
            child_pb.finished()
778
 
 
779
 
    def _apply_insertions(self, inv, limbo_inv):
780
 
        """Perform tree operations that insert directory/inventory names.
781
 
        
782
 
        That is, create any files that need to be created, and restore from
783
 
        limbo any files that needed renaming.  This must be done in strict
784
 
        parent-to-child order.
785
 
        """
786
 
        new_paths = self.new_paths()
787
 
        modified_paths = []
788
 
        child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
789
 
        try:
790
 
            for num, (path, trans_id) in enumerate(new_paths):
791
 
                child_pb.update('adding file', num, len(new_paths))
792
 
                try:
793
 
                    kind = self._new_contents[trans_id]
794
 
                except KeyError:
795
 
                    kind = contents = None
796
 
                if trans_id in self._new_contents or \
797
 
                    self.path_changed(trans_id):
798
 
                    full_path = self._tree.abspath(path)
799
 
                    try:
800
 
                        os.rename(self._limbo_name(trans_id), full_path)
801
 
                    except OSError, e:
802
 
                        # We may be renaming a dangling inventory id
803
 
                        if e.errno != errno.ENOENT:
804
 
                            raise
805
 
                    if trans_id in self._new_contents:
806
 
                        modified_paths.append(full_path)
807
 
                        del self._new_contents[trans_id]
808
 
 
809
 
                if trans_id in self._new_id:
810
 
                    if kind is None:
811
 
                        kind = file_kind(self._tree.abspath(path))
812
 
                    inv.add_path(path, kind, self._new_id[trans_id])
813
 
                elif trans_id in self._new_name or trans_id in\
814
 
                    self._new_parent:
815
 
                    entry = limbo_inv.get(trans_id)
816
 
                    if entry is not None:
817
 
                        entry.name = self.final_name(trans_id)
818
 
                        parent_path = os.path.dirname(path)
819
 
                        entry.parent_id = \
820
 
                            self._tree.inventory.path2id(parent_path)
821
 
                        inv.add(entry)
822
 
 
823
 
                # requires files and inventory entries to be in place
824
 
                if trans_id in self._new_executability:
825
 
                    self._set_executability(path, inv, trans_id)
826
 
        finally:
827
 
            child_pb.finished()
828
 
        return modified_paths
829
 
 
830
 
    def _set_executability(self, path, inv, trans_id):
 
882
                        use_direct_path = True
 
883
 
 
884
        if use_direct_path:
 
885
            limbo_name = pathjoin(self._limbo_files[parent], filename)
 
886
            self._limbo_children[parent].add(trans_id)
 
887
            self._limbo_children_names[parent][filename] = trans_id
 
888
        else:
 
889
            limbo_name = pathjoin(self._limbodir, trans_id)
 
890
            self._needs_rename.add(trans_id)
 
891
        self._limbo_files[trans_id] = limbo_name
 
892
        return limbo_name
 
893
 
 
894
    def _set_executability(self, path, trans_id):
831
895
        """Set the executability of versioned files """
832
 
        file_id = inv.path2id(path)
833
 
        new_executability = self._new_executability[trans_id]
834
 
        inv[file_id].executable = new_executability
835
896
        if supports_executable():
 
897
            new_executability = self._new_executability[trans_id]
836
898
            abspath = self._tree.abspath(path)
837
899
            current_mode = os.stat(abspath).st_mode
838
900
            if new_executability:
898
960
        self.create_symlink(target, trans_id)
899
961
        return trans_id
900
962
 
 
963
    def _affected_ids(self):
 
964
        """Return the set of transform ids affected by the transform"""
 
965
        trans_ids = set(self._removed_id)
 
966
        trans_ids.update(self._new_id.keys())
 
967
        trans_ids.update(self._removed_contents)
 
968
        trans_ids.update(self._new_contents.keys())
 
969
        trans_ids.update(self._new_executability.keys())
 
970
        trans_ids.update(self._new_name.keys())
 
971
        trans_ids.update(self._new_parent.keys())
 
972
        return trans_ids
 
973
 
 
974
    def _get_file_id_maps(self):
 
975
        """Return mapping of file_ids to trans_ids in the to and from states"""
 
976
        trans_ids = self._affected_ids()
 
977
        from_trans_ids = {}
 
978
        to_trans_ids = {}
 
979
        # Build up two dicts: trans_ids associated with file ids in the
 
980
        # FROM state, vs the TO state.
 
981
        for trans_id in trans_ids:
 
982
            from_file_id = self.tree_file_id(trans_id)
 
983
            if from_file_id is not None:
 
984
                from_trans_ids[from_file_id] = trans_id
 
985
            to_file_id = self.final_file_id(trans_id)
 
986
            if to_file_id is not None:
 
987
                to_trans_ids[to_file_id] = trans_id
 
988
        return from_trans_ids, to_trans_ids
 
989
 
 
990
    def _from_file_data(self, from_trans_id, from_versioned, file_id):
 
991
        """Get data about a file in the from (tree) state
 
992
 
 
993
        Return a (name, parent, kind, executable) tuple
 
994
        """
 
995
        from_path = self._tree_id_paths.get(from_trans_id)
 
996
        if from_versioned:
 
997
            # get data from working tree if versioned
 
998
            from_entry = self._tree.inventory[file_id]
 
999
            from_name = from_entry.name
 
1000
            from_parent = from_entry.parent_id
 
1001
        else:
 
1002
            from_entry = None
 
1003
            if from_path is None:
 
1004
                # File does not exist in FROM state
 
1005
                from_name = None
 
1006
                from_parent = None
 
1007
            else:
 
1008
                # File exists, but is not versioned.  Have to use path-
 
1009
                # splitting stuff
 
1010
                from_name = os.path.basename(from_path)
 
1011
                tree_parent = self.get_tree_parent(from_trans_id)
 
1012
                from_parent = self.tree_file_id(tree_parent)
 
1013
        if from_path is not None:
 
1014
            from_kind, from_executable, from_stats = \
 
1015
                self._tree._comparison_data(from_entry, from_path)
 
1016
        else:
 
1017
            from_kind = None
 
1018
            from_executable = False
 
1019
        return from_name, from_parent, from_kind, from_executable
 
1020
 
 
1021
    def _to_file_data(self, to_trans_id, from_trans_id, from_executable):
 
1022
        """Get data about a file in the to (target) state
 
1023
 
 
1024
        Return a (name, parent, kind, executable) tuple
 
1025
        """
 
1026
        to_name = self.final_name(to_trans_id)
 
1027
        try:
 
1028
            to_kind = self.final_kind(to_trans_id)
 
1029
        except NoSuchFile:
 
1030
            to_kind = None
 
1031
        to_parent = self.final_file_id(self.final_parent(to_trans_id))
 
1032
        if to_trans_id in self._new_executability:
 
1033
            to_executable = self._new_executability[to_trans_id]
 
1034
        elif to_trans_id == from_trans_id:
 
1035
            to_executable = from_executable
 
1036
        else:
 
1037
            to_executable = False
 
1038
        return to_name, to_parent, to_kind, to_executable
 
1039
 
 
1040
    def iter_changes(self):
 
1041
        """Produce output in the same format as Tree.iter_changes.
 
1042
 
 
1043
        Will produce nonsensical results if invoked while inventory/filesystem
 
1044
        conflicts (as reported by TreeTransform.find_conflicts()) are present.
 
1045
 
 
1046
        This reads the Transform, but only reproduces changes involving a
 
1047
        file_id.  Files that are not versioned in either of the FROM or TO
 
1048
        states are not reflected.
 
1049
        """
 
1050
        final_paths = FinalPaths(self)
 
1051
        from_trans_ids, to_trans_ids = self._get_file_id_maps()
 
1052
        results = []
 
1053
        # Now iterate through all active file_ids
 
1054
        for file_id in set(from_trans_ids.keys() + to_trans_ids.keys()):
 
1055
            modified = False
 
1056
            from_trans_id = from_trans_ids.get(file_id)
 
1057
            # find file ids, and determine versioning state
 
1058
            if from_trans_id is None:
 
1059
                from_versioned = False
 
1060
                from_trans_id = to_trans_ids[file_id]
 
1061
            else:
 
1062
                from_versioned = True
 
1063
            to_trans_id = to_trans_ids.get(file_id)
 
1064
            if to_trans_id is None:
 
1065
                to_versioned = False
 
1066
                to_trans_id = from_trans_id
 
1067
            else:
 
1068
                to_versioned = True
 
1069
 
 
1070
            from_name, from_parent, from_kind, from_executable = \
 
1071
                self._from_file_data(from_trans_id, from_versioned, file_id)
 
1072
 
 
1073
            to_name, to_parent, to_kind, to_executable = \
 
1074
                self._to_file_data(to_trans_id, from_trans_id, from_executable)
 
1075
 
 
1076
            if not from_versioned:
 
1077
                from_path = None
 
1078
            else:
 
1079
                from_path = self._tree_id_paths.get(from_trans_id)
 
1080
            if not to_versioned:
 
1081
                to_path = None
 
1082
            else:
 
1083
                to_path = final_paths.get_path(to_trans_id)
 
1084
            if from_kind != to_kind:
 
1085
                modified = True
 
1086
            elif to_kind in ('file', 'symlink') and (
 
1087
                to_trans_id != from_trans_id or
 
1088
                to_trans_id in self._new_contents):
 
1089
                modified = True
 
1090
            if (not modified and from_versioned == to_versioned and
 
1091
                from_parent==to_parent and from_name == to_name and
 
1092
                from_executable == to_executable):
 
1093
                continue
 
1094
            results.append((file_id, (from_path, to_path), modified,
 
1095
                   (from_versioned, to_versioned),
 
1096
                   (from_parent, to_parent),
 
1097
                   (from_name, to_name),
 
1098
                   (from_kind, to_kind),
 
1099
                   (from_executable, to_executable)))
 
1100
        return iter(sorted(results, key=lambda x:x[1]))
 
1101
 
 
1102
    def get_preview_tree(self):
 
1103
        """Return a tree representing the result of the transform.
 
1104
 
 
1105
        This tree only supports the subset of Tree functionality required
 
1106
        by show_diff_trees.  It must only be compared to tt._tree.
 
1107
        """
 
1108
        return _PreviewTree(self)
 
1109
 
 
1110
 
 
1111
class TreeTransform(TreeTransformBase):
 
1112
    """Represent a tree transformation.
 
1113
 
 
1114
    This object is designed to support incremental generation of the transform,
 
1115
    in any order.
 
1116
 
 
1117
    However, it gives optimum performance when parent directories are created
 
1118
    before their contents.  The transform is then able to put child files
 
1119
    directly in their parent directory, avoiding later renames.
 
1120
 
 
1121
    It is easy to produce malformed transforms, but they are generally
 
1122
    harmless.  Attempting to apply a malformed transform will cause an
 
1123
    exception to be raised before any modifications are made to the tree.
 
1124
 
 
1125
    Many kinds of malformed transforms can be corrected with the
 
1126
    resolve_conflicts function.  The remaining ones indicate programming error,
 
1127
    such as trying to create a file with no path.
 
1128
 
 
1129
    Two sets of file creation methods are supplied.  Convenience methods are:
 
1130
     * new_file
 
1131
     * new_directory
 
1132
     * new_symlink
 
1133
 
 
1134
    These are composed of the low-level methods:
 
1135
     * create_path
 
1136
     * create_file or create_directory or create_symlink
 
1137
     * version_file
 
1138
     * set_executability
 
1139
 
 
1140
    Transform/Transaction ids
 
1141
    -------------------------
 
1142
    trans_ids are temporary ids assigned to all files involved in a transform.
 
1143
    It's possible, even common, that not all files in the Tree have trans_ids.
 
1144
 
 
1145
    trans_ids are used because filenames and file_ids are not good enough
 
1146
    identifiers; filenames change, and not all files have file_ids.  File-ids
 
1147
    are also associated with trans-ids, so that moving a file moves its
 
1148
    file-id.
 
1149
 
 
1150
    trans_ids are only valid for the TreeTransform that generated them.
 
1151
 
 
1152
    Limbo
 
1153
    -----
 
1154
    Limbo is a temporary directory use to hold new versions of files.
 
1155
    Files are added to limbo by create_file, create_directory, create_symlink,
 
1156
    and their convenience variants (new_*).  Files may be removed from limbo
 
1157
    using cancel_creation.  Files are renamed from limbo into their final
 
1158
    location as part of TreeTransform.apply
 
1159
 
 
1160
    Limbo must be cleaned up, by either calling TreeTransform.apply or
 
1161
    calling TreeTransform.finalize.
 
1162
 
 
1163
    Files are placed into limbo inside their parent directories, where
 
1164
    possible.  This reduces subsequent renames, and makes operations involving
 
1165
    lots of files faster.  This optimization is only possible if the parent
 
1166
    directory is created *before* creating any of its children, so avoid
 
1167
    creating children before parents, where possible.
 
1168
 
 
1169
    Pending-deletion
 
1170
    ----------------
 
1171
    This temporary directory is used by _FileMover for storing files that are
 
1172
    about to be deleted.  In case of rollback, the files will be restored.
 
1173
    FileMover does not delete files until it is sure that a rollback will not
 
1174
    happen.
 
1175
    """
 
1176
    def __init__(self, tree, pb=DummyProgress()):
 
1177
        """Note: a tree_write lock is taken on the tree.
 
1178
 
 
1179
        Use TreeTransform.finalize() to release the lock (can be omitted if
 
1180
        TreeTransform.apply() called).
 
1181
        """
 
1182
        tree.lock_tree_write()
 
1183
 
 
1184
        try:
 
1185
            limbodir = urlutils.local_path_from_url(
 
1186
                tree._transport.abspath('limbo'))
 
1187
            try:
 
1188
                os.mkdir(limbodir)
 
1189
            except OSError, e:
 
1190
                if e.errno == errno.EEXIST:
 
1191
                    raise ExistingLimbo(limbodir)
 
1192
            deletiondir = urlutils.local_path_from_url(
 
1193
                tree._transport.abspath('pending-deletion'))
 
1194
            try:
 
1195
                os.mkdir(deletiondir)
 
1196
            except OSError, e:
 
1197
                if e.errno == errno.EEXIST:
 
1198
                    raise errors.ExistingPendingDeletion(deletiondir)
 
1199
        except:
 
1200
            tree.unlock()
 
1201
            raise
 
1202
 
 
1203
        TreeTransformBase.__init__(self, tree, limbodir, pb,
 
1204
                                   tree.case_sensitive)
 
1205
        self._deletiondir = deletiondir
 
1206
 
 
1207
    def apply(self, no_conflicts=False, precomputed_delta=None, _mover=None):
 
1208
        """Apply all changes to the inventory and filesystem.
 
1209
 
 
1210
        If filesystem or inventory conflicts are present, MalformedTransform
 
1211
        will be thrown.
 
1212
 
 
1213
        If apply succeeds, finalize is not necessary.
 
1214
 
 
1215
        :param no_conflicts: if True, the caller guarantees there are no
 
1216
            conflicts, so no check is made.
 
1217
        :param precomputed_delta: An inventory delta to use instead of
 
1218
            calculating one.
 
1219
        :param _mover: Supply an alternate FileMover, for testing
 
1220
        """
 
1221
        if not no_conflicts:
 
1222
            conflicts = self.find_conflicts()
 
1223
            if len(conflicts) != 0:
 
1224
                raise MalformedTransform(conflicts=conflicts)
 
1225
        child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
1226
        try:
 
1227
            if precomputed_delta is None:
 
1228
                child_pb.update('Apply phase', 0, 2)
 
1229
                inventory_delta = self._generate_inventory_delta()
 
1230
                offset = 1
 
1231
            else:
 
1232
                inventory_delta = precomputed_delta
 
1233
                offset = 0
 
1234
            if _mover is None:
 
1235
                mover = _FileMover()
 
1236
            else:
 
1237
                mover = _mover
 
1238
            try:
 
1239
                child_pb.update('Apply phase', 0 + offset, 2 + offset)
 
1240
                self._apply_removals(mover)
 
1241
                child_pb.update('Apply phase', 1 + offset, 2 + offset)
 
1242
                modified_paths = self._apply_insertions(mover)
 
1243
            except:
 
1244
                mover.rollback()
 
1245
                raise
 
1246
            else:
 
1247
                mover.apply_deletions()
 
1248
        finally:
 
1249
            child_pb.finished()
 
1250
        self._tree.apply_inventory_delta(inventory_delta)
 
1251
        self._done = True
 
1252
        self.finalize()
 
1253
        return _TransformResults(modified_paths, self.rename_count)
 
1254
 
 
1255
    def _generate_inventory_delta(self):
 
1256
        """Generate an inventory delta for the current transform."""
 
1257
        inventory_delta = []
 
1258
        child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
1259
        new_paths = self._inventory_altered()
 
1260
        total_entries = len(new_paths) + len(self._removed_id)
 
1261
        try:
 
1262
            for num, trans_id in enumerate(self._removed_id):
 
1263
                if (num % 10) == 0:
 
1264
                    child_pb.update('removing file', num, total_entries)
 
1265
                if trans_id == self._new_root:
 
1266
                    file_id = self._tree.get_root_id()
 
1267
                else:
 
1268
                    file_id = self.tree_file_id(trans_id)
 
1269
                # File-id isn't really being deleted, just moved
 
1270
                if file_id in self._r_new_id:
 
1271
                    continue
 
1272
                path = self._tree_id_paths[trans_id]
 
1273
                inventory_delta.append((path, None, file_id, None))
 
1274
            new_path_file_ids = dict((t, self.final_file_id(t)) for p, t in
 
1275
                                     new_paths)
 
1276
            entries = self._tree.iter_entries_by_dir(
 
1277
                new_path_file_ids.values())
 
1278
            old_paths = dict((e.file_id, p) for p, e in entries)
 
1279
            final_kinds = {}
 
1280
            for num, (path, trans_id) in enumerate(new_paths):
 
1281
                if (num % 10) == 0:
 
1282
                    child_pb.update('adding file',
 
1283
                                    num + len(self._removed_id), total_entries)
 
1284
                file_id = new_path_file_ids[trans_id]
 
1285
                if file_id is None:
 
1286
                    continue
 
1287
                needs_entry = False
 
1288
                try:
 
1289
                    kind = self.final_kind(trans_id)
 
1290
                except NoSuchFile:
 
1291
                    kind = self._tree.stored_kind(file_id)
 
1292
                parent_trans_id = self.final_parent(trans_id)
 
1293
                parent_file_id = new_path_file_ids.get(parent_trans_id)
 
1294
                if parent_file_id is None:
 
1295
                    parent_file_id = self.final_file_id(parent_trans_id)
 
1296
                if trans_id in self._new_reference_revision:
 
1297
                    new_entry = inventory.TreeReference(
 
1298
                        file_id,
 
1299
                        self._new_name[trans_id],
 
1300
                        self.final_file_id(self._new_parent[trans_id]),
 
1301
                        None, self._new_reference_revision[trans_id])
 
1302
                else:
 
1303
                    new_entry = inventory.make_entry(kind,
 
1304
                        self.final_name(trans_id),
 
1305
                        parent_file_id, file_id)
 
1306
                old_path = old_paths.get(new_entry.file_id)
 
1307
                new_executability = self._new_executability.get(trans_id)
 
1308
                if new_executability is not None:
 
1309
                    new_entry.executable = new_executability
 
1310
                inventory_delta.append(
 
1311
                    (old_path, path, new_entry.file_id, new_entry))
 
1312
        finally:
 
1313
            child_pb.finished()
 
1314
        return inventory_delta
 
1315
 
 
1316
    def _apply_removals(self, mover):
 
1317
        """Perform tree operations that remove directory/inventory names.
 
1318
 
 
1319
        That is, delete files that are to be deleted, and put any files that
 
1320
        need renaming into limbo.  This must be done in strict child-to-parent
 
1321
        order.
 
1322
 
 
1323
        If inventory_delta is None, no inventory delta generation is performed.
 
1324
        """
 
1325
        tree_paths = list(self._tree_path_ids.iteritems())
 
1326
        tree_paths.sort(reverse=True)
 
1327
        kind_changes = set()
 
1328
        child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
1329
        try:
 
1330
            for num, data in enumerate(tree_paths):
 
1331
                path, trans_id = data
 
1332
                child_pb.update('removing file', num, len(tree_paths))
 
1333
                full_path = self._tree.abspath(path)
 
1334
                if trans_id in self._removed_contents:
 
1335
                    mover.pre_delete(full_path, os.path.join(self._deletiondir,
 
1336
                                     trans_id))
 
1337
                elif trans_id in self._new_name or trans_id in \
 
1338
                    self._new_parent:
 
1339
                    try:
 
1340
                        mover.rename(full_path, self._limbo_name(trans_id))
 
1341
                    except OSError, e:
 
1342
                        if e.errno != errno.ENOENT:
 
1343
                            raise
 
1344
                    else:
 
1345
                        self.rename_count += 1
 
1346
        finally:
 
1347
            child_pb.finished()
 
1348
        return kind_changes
 
1349
 
 
1350
    def _apply_insertions(self, mover):
 
1351
        """Perform tree operations that insert directory/inventory names.
 
1352
 
 
1353
        That is, create any files that need to be created, and restore from
 
1354
        limbo any files that needed renaming.  This must be done in strict
 
1355
        parent-to-child order.
 
1356
 
 
1357
        If inventory_delta is None, no inventory delta is calculated, and
 
1358
        no list of modified paths is returned.
 
1359
 
 
1360
        kind_changes is a set of trans ids where the entry has changed
 
1361
        kind, and so an inventory delta entry should be created for them.
 
1362
        """
 
1363
        new_paths = self.new_paths(filesystem_only=True)
 
1364
        modified_paths = []
 
1365
        new_path_file_ids = dict((t, self.final_file_id(t)) for p, t in
 
1366
                                 new_paths)
 
1367
        child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
1368
        try:
 
1369
            for num, (path, trans_id) in enumerate(new_paths):
 
1370
                if (num % 10) == 0:
 
1371
                    child_pb.update('adding file', num, len(new_paths))
 
1372
                full_path = self._tree.abspath(path)
 
1373
                if trans_id in self._needs_rename:
 
1374
                    try:
 
1375
                        mover.rename(self._limbo_name(trans_id), full_path)
 
1376
                    except OSError, e:
 
1377
                        # We may be renaming a dangling inventory id
 
1378
                        if e.errno != errno.ENOENT:
 
1379
                            raise
 
1380
                    else:
 
1381
                        self.rename_count += 1
 
1382
                if (trans_id in self._new_contents or
 
1383
                    self.path_changed(trans_id)):
 
1384
                    if trans_id in self._new_contents:
 
1385
                        modified_paths.append(full_path)
 
1386
                if trans_id in self._new_executability:
 
1387
                    self._set_executability(path, trans_id)
 
1388
        finally:
 
1389
            child_pb.finished()
 
1390
        self._new_contents.clear()
 
1391
        return modified_paths
 
1392
 
 
1393
 
 
1394
class TransformPreview(TreeTransformBase):
 
1395
    """A TreeTransform for generating preview trees.
 
1396
 
 
1397
    Unlike TreeTransform, this version works when the input tree is a
 
1398
    RevisionTree, rather than a WorkingTree.  As a result, it tends to ignore
 
1399
    unversioned files in the input tree.
 
1400
    """
 
1401
 
 
1402
    def __init__(self, tree, pb=DummyProgress(), case_sensitive=True):
 
1403
        tree.lock_read()
 
1404
        limbodir = tempfile.mkdtemp(prefix='bzr-limbo-')
 
1405
        TreeTransformBase.__init__(self, tree, limbodir, pb, case_sensitive)
 
1406
 
 
1407
    def canonical_path(self, path):
 
1408
        return path
 
1409
 
 
1410
    def tree_kind(self, trans_id):
 
1411
        path = self._tree_id_paths.get(trans_id)
 
1412
        if path is None:
 
1413
            raise NoSuchFile(None)
 
1414
        file_id = self._tree.path2id(path)
 
1415
        return self._tree.kind(file_id)
 
1416
 
 
1417
    def _set_mode(self, trans_id, mode_id, typefunc):
 
1418
        """Set the mode of new file contents.
 
1419
        The mode_id is the existing file to get the mode from (often the same
 
1420
        as trans_id).  The operation is only performed if there's a mode match
 
1421
        according to typefunc.
 
1422
        """
 
1423
        # is it ok to ignore this?  probably
 
1424
        pass
 
1425
 
 
1426
    def iter_tree_children(self, parent_id):
 
1427
        """Iterate through the entry's tree children, if any"""
 
1428
        try:
 
1429
            path = self._tree_id_paths[parent_id]
 
1430
        except KeyError:
 
1431
            return
 
1432
        file_id = self.tree_file_id(parent_id)
 
1433
        if file_id is None:
 
1434
            return
 
1435
        children = getattr(self._tree.inventory[file_id], 'children', {})
 
1436
        for child in children:
 
1437
            childpath = joinpath(path, child)
 
1438
            yield self.trans_id_tree_path(childpath)
 
1439
 
 
1440
 
 
1441
class _PreviewTree(tree.Tree):
 
1442
    """Partial implementation of Tree to support show_diff_trees"""
 
1443
 
 
1444
    def __init__(self, transform):
 
1445
        self._transform = transform
 
1446
        self._final_paths = FinalPaths(transform)
 
1447
        self.__by_parent = None
 
1448
        self._parent_ids = []
 
1449
 
 
1450
    def _changes(self, file_id):
 
1451
        for changes in self._transform.iter_changes():
 
1452
            if changes[0] == file_id:
 
1453
                return changes
 
1454
 
 
1455
    def _content_change(self, file_id):
 
1456
        """Return True if the content of this file changed"""
 
1457
        changes = self._changes(file_id)
 
1458
        # changes[2] is true if the file content changed.  See
 
1459
        # InterTree.iter_changes.
 
1460
        return (changes is not None and changes[2])
 
1461
 
 
1462
    def _get_repository(self):
 
1463
        repo = getattr(self._transform._tree, '_repository', None)
 
1464
        if repo is None:
 
1465
            repo = self._transform._tree.branch.repository
 
1466
        return repo
 
1467
 
 
1468
    def _iter_parent_trees(self):
 
1469
        for revision_id in self.get_parent_ids():
 
1470
            try:
 
1471
                yield self.revision_tree(revision_id)
 
1472
            except errors.NoSuchRevisionInTree:
 
1473
                yield self._get_repository().revision_tree(revision_id)
 
1474
 
 
1475
    def _get_file_revision(self, file_id, vf, tree_revision):
 
1476
        parent_keys = [(file_id, self._file_revision(t, file_id)) for t in
 
1477
                       self._iter_parent_trees()]
 
1478
        vf.add_lines((file_id, tree_revision), parent_keys,
 
1479
                     self.get_file(file_id).readlines())
 
1480
        repo = self._get_repository()
 
1481
        base_vf = repo.texts
 
1482
        if base_vf not in vf.fallback_versionedfiles:
 
1483
            vf.fallback_versionedfiles.append(base_vf)
 
1484
        return tree_revision
 
1485
 
 
1486
    def _stat_limbo_file(self, file_id):
 
1487
        trans_id = self._transform.trans_id_file_id(file_id)
 
1488
        name = self._transform._limbo_name(trans_id)
 
1489
        return os.lstat(name)
 
1490
 
 
1491
    @property
 
1492
    def _by_parent(self):
 
1493
        if self.__by_parent is None:
 
1494
            self.__by_parent = self._transform.by_parent()
 
1495
        return self.__by_parent
 
1496
 
 
1497
    def lock_read(self):
 
1498
        # Perhaps in theory, this should lock the TreeTransform?
 
1499
        pass
 
1500
 
 
1501
    def unlock(self):
 
1502
        pass
 
1503
 
 
1504
    @property
 
1505
    def inventory(self):
 
1506
        """This Tree does not use inventory as its backing data."""
 
1507
        raise NotImplementedError(_PreviewTree.inventory)
 
1508
 
 
1509
    def get_root_id(self):
 
1510
        return self._transform.final_file_id(self._transform.root)
 
1511
 
 
1512
    def all_file_ids(self):
 
1513
        tree_ids = set(self._transform._tree.all_file_ids())
 
1514
        tree_ids.difference_update(self._transform.tree_file_id(t)
 
1515
                                   for t in self._transform._removed_id)
 
1516
        tree_ids.update(self._transform._new_id.values())
 
1517
        return tree_ids
 
1518
 
 
1519
    def __iter__(self):
 
1520
        return iter(self.all_file_ids())
 
1521
 
 
1522
    def paths2ids(self, specific_files, trees=None, require_versioned=False):
 
1523
        """See Tree.paths2ids"""
 
1524
        to_find = set(specific_files)
 
1525
        result = set()
 
1526
        for (file_id, paths, changed, versioned, parent, name, kind,
 
1527
             executable) in self._transform.iter_changes():
 
1528
            if paths[1] in to_find:
 
1529
                result.append(file_id)
 
1530
                to_find.remove(paths[1])
 
1531
        result.update(self._transform._tree.paths2ids(to_find,
 
1532
                      trees=[], require_versioned=require_versioned))
 
1533
        return result
 
1534
 
 
1535
    def _path2trans_id(self, path):
 
1536
        segments = splitpath(path)
 
1537
        cur_parent = self._transform.root
 
1538
        for cur_segment in segments:
 
1539
            for child in self._all_children(cur_parent):
 
1540
                if self._transform.final_name(child) == cur_segment:
 
1541
                    cur_parent = child
 
1542
                    break
 
1543
            else:
 
1544
                return None
 
1545
        return cur_parent
 
1546
 
 
1547
    def path2id(self, path):
 
1548
        return self._transform.final_file_id(self._path2trans_id(path))
 
1549
 
 
1550
    def id2path(self, file_id):
 
1551
        trans_id = self._transform.trans_id_file_id(file_id)
 
1552
        try:
 
1553
            return self._final_paths._determine_path(trans_id)
 
1554
        except NoFinalPath:
 
1555
            raise errors.NoSuchId(self, file_id)
 
1556
 
 
1557
    def _all_children(self, trans_id):
 
1558
        children = set(self._transform.iter_tree_children(trans_id))
 
1559
        # children in the _new_parent set are provided by _by_parent.
 
1560
        children.difference_update(self._transform._new_parent.keys())
 
1561
        children.update(self._by_parent.get(trans_id, []))
 
1562
        return children
 
1563
 
 
1564
    def _make_inv_entries(self, ordered_entries, specific_file_ids):
 
1565
        for trans_id, parent_file_id in ordered_entries:
 
1566
            file_id = self._transform.final_file_id(trans_id)
 
1567
            if file_id is None:
 
1568
                continue
 
1569
            if (specific_file_ids is not None
 
1570
                and file_id not in specific_file_ids):
 
1571
                continue
 
1572
            try:
 
1573
                kind = self._transform.final_kind(trans_id)
 
1574
            except NoSuchFile:
 
1575
                kind = self._transform._tree.stored_kind(file_id)
 
1576
            new_entry = inventory.make_entry(
 
1577
                kind,
 
1578
                self._transform.final_name(trans_id),
 
1579
                parent_file_id, file_id)
 
1580
            yield new_entry, trans_id
 
1581
 
 
1582
    def iter_entries_by_dir(self, specific_file_ids=None):
 
1583
        # This may not be a maximally efficient implementation, but it is
 
1584
        # reasonably straightforward.  An implementation that grafts the
 
1585
        # TreeTransform changes onto the tree's iter_entries_by_dir results
 
1586
        # might be more efficient, but requires tricky inferences about stack
 
1587
        # position.
 
1588
        todo = [ROOT_PARENT]
 
1589
        ordered_ids = []
 
1590
        while len(todo) > 0:
 
1591
            parent = todo.pop()
 
1592
            parent_file_id = self._transform.final_file_id(parent)
 
1593
            children = list(self._all_children(parent))
 
1594
            paths = dict(zip(children, self._final_paths.get_paths(children)))
 
1595
            children.sort(key=paths.get)
 
1596
            todo.extend(reversed(children))
 
1597
            for trans_id in children:
 
1598
                ordered_ids.append((trans_id, parent_file_id))
 
1599
        for entry, trans_id in self._make_inv_entries(ordered_ids,
 
1600
                                                      specific_file_ids):
 
1601
            yield unicode(self._final_paths.get_path(trans_id)), entry
 
1602
 
 
1603
    def kind(self, file_id):
 
1604
        trans_id = self._transform.trans_id_file_id(file_id)
 
1605
        return self._transform.final_kind(trans_id)
 
1606
 
 
1607
    def stored_kind(self, file_id):
 
1608
        trans_id = self._transform.trans_id_file_id(file_id)
 
1609
        try:
 
1610
            return self._transform._new_contents[trans_id]
 
1611
        except KeyError:
 
1612
            return self._transform._tree.stored_kind(file_id)
 
1613
 
 
1614
    def get_file_mtime(self, file_id, path=None):
 
1615
        """See Tree.get_file_mtime"""
 
1616
        if not self._content_change(file_id):
 
1617
            return self._transform._tree.get_file_mtime(file_id, path)
 
1618
        return self._stat_limbo_file(file_id).st_mtime
 
1619
 
 
1620
    def get_file_size(self, file_id):
 
1621
        """See Tree.get_file_size"""
 
1622
        if self.kind(file_id) == 'file':
 
1623
            return self._transform._tree.get_file_size(file_id)
 
1624
        else:
 
1625
            return None
 
1626
 
 
1627
    def get_file_sha1(self, file_id, path=None, stat_value=None):
 
1628
        return self._transform._tree.get_file_sha1(file_id)
 
1629
 
 
1630
    def is_executable(self, file_id, path=None):
 
1631
        trans_id = self._transform.trans_id_file_id(file_id)
 
1632
        try:
 
1633
            return self._transform._new_executability[trans_id]
 
1634
        except KeyError:
 
1635
            return self._transform._tree.is_executable(file_id, path)
 
1636
 
 
1637
    def path_content_summary(self, path):
 
1638
        trans_id = self._path2trans_id(path)
 
1639
        tt = self._transform
 
1640
        tree_path = tt._tree_id_paths.get(trans_id)
 
1641
        kind = tt._new_contents.get(trans_id)
 
1642
        if kind is None:
 
1643
            if tree_path is None or trans_id in tt._removed_contents:
 
1644
                return 'missing', None, None, None
 
1645
            summary = tt._tree.path_content_summary(tree_path)
 
1646
            kind, size, executable, link_or_sha1 = summary
 
1647
        else:
 
1648
            link_or_sha1 = None
 
1649
            limbo_name = tt._limbo_name(trans_id)
 
1650
            if trans_id in tt._new_reference_revision:
 
1651
                kind = 'tree-reference'
 
1652
            if kind == 'file':
 
1653
                statval = os.lstat(limbo_name)
 
1654
                size = statval.st_size
 
1655
                if not supports_executable():
 
1656
                    executable = None
 
1657
                else:
 
1658
                    executable = statval.st_mode & S_IEXEC
 
1659
            else:
 
1660
                size = None
 
1661
                executable = None
 
1662
            if kind == 'symlink':
 
1663
                link_or_sha1 = os.readlink(limbo_name)
 
1664
        if supports_executable():
 
1665
            executable = tt._new_executability.get(trans_id, executable)
 
1666
        return kind, size, executable, link_or_sha1
 
1667
 
 
1668
    def iter_changes(self, from_tree, include_unchanged=False,
 
1669
                      specific_files=None, pb=None, extra_trees=None,
 
1670
                      require_versioned=True, want_unversioned=False):
 
1671
        """See InterTree.iter_changes.
 
1672
 
 
1673
        This implementation does not support include_unchanged, specific_files,
 
1674
        or want_unversioned.  extra_trees, require_versioned, and pb are
 
1675
        ignored.
 
1676
        """
 
1677
        if from_tree is not self._transform._tree:
 
1678
            raise ValueError('from_tree must be transform source tree.')
 
1679
        if include_unchanged:
 
1680
            raise ValueError('include_unchanged is not supported')
 
1681
        if specific_files is not None:
 
1682
            raise ValueError('specific_files is not supported')
 
1683
        if want_unversioned:
 
1684
            raise ValueError('want_unversioned is not supported')
 
1685
        return self._transform.iter_changes()
 
1686
 
 
1687
    def get_file(self, file_id, path=None):
 
1688
        """See Tree.get_file"""
 
1689
        if not self._content_change(file_id):
 
1690
            return self._transform._tree.get_file(file_id, path)
 
1691
        trans_id = self._transform.trans_id_file_id(file_id)
 
1692
        name = self._transform._limbo_name(trans_id)
 
1693
        return open(name, 'rb')
 
1694
 
 
1695
    def get_file_text(self, file_id):
 
1696
        text_file = self.get_file(file_id)
 
1697
        try:
 
1698
            return text_file.read()
 
1699
        finally:
 
1700
            text_file.close()
 
1701
 
 
1702
    def annotate_iter(self, file_id,
 
1703
                      default_revision=_mod_revision.CURRENT_REVISION):
 
1704
        changes = self._changes(file_id)
 
1705
        if changes is None:
 
1706
            get_old = True
 
1707
        else:
 
1708
            changed_content, versioned, kind = (changes[2], changes[3],
 
1709
                                                changes[6])
 
1710
            if kind[1] is None:
 
1711
                return None
 
1712
            get_old = (kind[0] == 'file' and versioned[0])
 
1713
        if get_old:
 
1714
            old_annotation = self._transform._tree.annotate_iter(file_id,
 
1715
                default_revision=default_revision)
 
1716
        else:
 
1717
            old_annotation = []
 
1718
        if changes is None:
 
1719
            return old_annotation
 
1720
        if not changed_content:
 
1721
            return old_annotation
 
1722
        return annotate.reannotate([old_annotation],
 
1723
                                   self.get_file(file_id).readlines(),
 
1724
                                   default_revision)
 
1725
 
 
1726
    def get_symlink_target(self, file_id):
 
1727
        """See Tree.get_symlink_target"""
 
1728
        if not self._content_change(file_id):
 
1729
            return self._transform._tree.get_symlink_target(file_id)
 
1730
        trans_id = self._transform.trans_id_file_id(file_id)
 
1731
        name = self._transform._limbo_name(trans_id)
 
1732
        return os.readlink(name)
 
1733
 
 
1734
    def list_files(self, include_root=False):
 
1735
        return self._transform._tree.list_files(include_root)
 
1736
 
 
1737
    def walkdirs(self, prefix=""):
 
1738
        return self._transform._tree.walkdirs(prefix)
 
1739
 
 
1740
    def get_parent_ids(self):
 
1741
        return self._parent_ids
 
1742
 
 
1743
    def set_parent_ids(self, parent_ids):
 
1744
        self._parent_ids = parent_ids
 
1745
 
 
1746
    def get_revision_tree(self, revision_id):
 
1747
        return self._transform._tree.get_revision_tree(revision_id)
 
1748
 
 
1749
 
901
1750
def joinpath(parent, child):
902
1751
    """Join tree-relative paths, handling the tree root specially"""
903
1752
    if parent is None or parent == "":
933
1782
            self._known_paths[trans_id] = self._determine_path(trans_id)
934
1783
        return self._known_paths[trans_id]
935
1784
 
 
1785
    def get_paths(self, trans_ids):
 
1786
        return [(self.get_path(t), t) for t in trans_ids]
 
1787
 
 
1788
 
 
1789
 
936
1790
def topology_sorted_ids(tree):
937
1791
    """Determine the topological order of the ids in a tree"""
938
1792
    file_ids = list(tree)
940
1794
    return file_ids
941
1795
 
942
1796
 
943
 
def build_tree(tree, wt):
 
1797
def build_tree(tree, wt, accelerator_tree=None, hardlink=False,
 
1798
               delta_from_tree=False):
944
1799
    """Create working tree for a branch, using a TreeTransform.
945
1800
    
946
1801
    This function should be used on empty trees, having a tree root at most.
953
1808
    - Otherwise, if the content on disk matches the content we are building,
954
1809
      it is silently replaced.
955
1810
    - Otherwise, conflict resolution will move the old file to 'oldname.moved'.
 
1811
 
 
1812
    :param tree: The tree to convert wt into a copy of
 
1813
    :param wt: The working tree that files will be placed into
 
1814
    :param accelerator_tree: A tree which can be used for retrieving file
 
1815
        contents more quickly than tree itself, i.e. a workingtree.  tree
 
1816
        will be used for cases where accelerator_tree's content is different.
 
1817
    :param hardlink: If true, hard-link files to accelerator_tree, where
 
1818
        possible.  accelerator_tree must implement abspath, i.e. be a
 
1819
        working tree.
 
1820
    :param delta_from_tree: If true, build_tree may use the input Tree to
 
1821
        generate the inventory delta.
956
1822
    """
957
 
    assert 2 > len(wt.inventory)
 
1823
    wt.lock_tree_write()
 
1824
    try:
 
1825
        tree.lock_read()
 
1826
        try:
 
1827
            if accelerator_tree is not None:
 
1828
                accelerator_tree.lock_read()
 
1829
            try:
 
1830
                return _build_tree(tree, wt, accelerator_tree, hardlink,
 
1831
                                   delta_from_tree)
 
1832
            finally:
 
1833
                if accelerator_tree is not None:
 
1834
                    accelerator_tree.unlock()
 
1835
        finally:
 
1836
            tree.unlock()
 
1837
    finally:
 
1838
        wt.unlock()
 
1839
 
 
1840
 
 
1841
def _build_tree(tree, wt, accelerator_tree, hardlink, delta_from_tree):
 
1842
    """See build_tree."""
 
1843
    for num, _unused in enumerate(wt.all_file_ids()):
 
1844
        if num > 0:  # more than just a root
 
1845
            raise errors.WorkingTreeAlreadyPopulated(base=wt.basedir)
 
1846
    existing_files = set()
 
1847
    for dir, files in wt.walkdirs():
 
1848
        existing_files.update(f[0] for f in files)
958
1849
    file_trans_id = {}
959
1850
    top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
960
1851
    pp = ProgressPhase("Build phase", 2, top_pb)
 
1852
    if tree.inventory.root is not None:
 
1853
        # This is kind of a hack: we should be altering the root
 
1854
        # as part of the regular tree shape diff logic.
 
1855
        # The conditional test here is to avoid doing an
 
1856
        # expensive operation (flush) every time the root id
 
1857
        # is set within the tree, nor setting the root and thus
 
1858
        # marking the tree as dirty, because we use two different
 
1859
        # idioms here: tree interfaces and inventory interfaces.
 
1860
        if wt.get_root_id() != tree.get_root_id():
 
1861
            wt.set_root_id(tree.get_root_id())
 
1862
            wt.flush()
961
1863
    tt = TreeTransform(wt)
962
1864
    divert = set()
963
1865
    try:
966
1868
            tt.trans_id_tree_file_id(wt.get_root_id())
967
1869
        pb = bzrlib.ui.ui_factory.nested_progress_bar()
968
1870
        try:
 
1871
            deferred_contents = []
 
1872
            num = 0
 
1873
            total = len(tree.inventory)
 
1874
            if delta_from_tree:
 
1875
                precomputed_delta = []
 
1876
            else:
 
1877
                precomputed_delta = None
969
1878
            for num, (tree_path, entry) in \
970
1879
                enumerate(tree.inventory.iter_entries_by_dir()):
971
 
                pb.update("Building tree", num, len(tree.inventory))
 
1880
                pb.update("Building tree", num - len(deferred_contents), total)
972
1881
                if entry.parent_id is None:
973
1882
                    continue
974
1883
                reparent = False
975
1884
                file_id = entry.file_id
976
 
                target_path = wt.abspath(tree_path)
977
 
                try:
 
1885
                if delta_from_tree:
 
1886
                    precomputed_delta.append((None, tree_path, file_id, entry))
 
1887
                if tree_path in existing_files:
 
1888
                    target_path = wt.abspath(tree_path)
978
1889
                    kind = file_kind(target_path)
979
 
                except NoSuchFile:
980
 
                    pass
981
 
                else:
982
1890
                    if kind == "directory":
983
1891
                        try:
984
1892
                            bzrdir.BzrDir.open(target_path)
992
1900
                        tt.delete_contents(tt.trans_id_tree_path(tree_path))
993
1901
                        if kind == 'directory':
994
1902
                            reparent = True
995
 
                if entry.parent_id not in file_trans_id:
996
 
                    raise repr(entry.parent_id)
997
1903
                parent_id = file_trans_id[entry.parent_id]
998
 
                file_trans_id[file_id] = new_by_entry(tt, entry, parent_id,
999
 
                                                      tree)
 
1904
                if entry.kind == 'file':
 
1905
                    # We *almost* replicate new_by_entry, so that we can defer
 
1906
                    # getting the file text, and get them all at once.
 
1907
                    trans_id = tt.create_path(entry.name, parent_id)
 
1908
                    file_trans_id[file_id] = trans_id
 
1909
                    tt.version_file(file_id, trans_id)
 
1910
                    executable = tree.is_executable(file_id, tree_path)
 
1911
                    if executable:
 
1912
                        tt.set_executability(executable, trans_id)
 
1913
                    deferred_contents.append((file_id, trans_id))
 
1914
                else:
 
1915
                    file_trans_id[file_id] = new_by_entry(tt, entry, parent_id,
 
1916
                                                          tree)
1000
1917
                if reparent:
1001
1918
                    new_trans_id = file_trans_id[file_id]
1002
1919
                    old_parent = tt.trans_id_tree_path(tree_path)
1003
1920
                    _reparent_children(tt, old_parent, new_trans_id)
 
1921
            offset = num + 1 - len(deferred_contents)
 
1922
            _create_files(tt, tree, deferred_contents, pb, offset,
 
1923
                          accelerator_tree, hardlink)
1004
1924
        finally:
1005
1925
            pb.finished()
1006
1926
        pp.next_phase()
1007
1927
        divert_trans = set(file_trans_id[f] for f in divert)
1008
1928
        resolver = lambda t, c: resolve_checkout(t, c, divert_trans)
1009
1929
        raw_conflicts = resolve_conflicts(tt, pass_func=resolver)
 
1930
        if len(raw_conflicts) > 0:
 
1931
            precomputed_delta = None
1010
1932
        conflicts = cook_conflicts(raw_conflicts, tt)
1011
1933
        for conflict in conflicts:
1012
1934
            warning(conflict)
1014
1936
            wt.add_conflicts(conflicts)
1015
1937
        except errors.UnsupportedOperation:
1016
1938
            pass
1017
 
        tt.apply()
 
1939
        result = tt.apply(no_conflicts=True,
 
1940
                          precomputed_delta=precomputed_delta)
1018
1941
    finally:
1019
1942
        tt.finalize()
1020
1943
        top_pb.finished()
 
1944
    return result
 
1945
 
 
1946
 
 
1947
def _create_files(tt, tree, desired_files, pb, offset, accelerator_tree,
 
1948
                  hardlink):
 
1949
    total = len(desired_files) + offset
 
1950
    if accelerator_tree is None:
 
1951
        new_desired_files = desired_files
 
1952
    else:
 
1953
        iter = accelerator_tree.iter_changes(tree, include_unchanged=True)
 
1954
        unchanged = dict((f, p[1]) for (f, p, c, v, d, n, k, e)
 
1955
                         in iter if not (c or e[0] != e[1]))
 
1956
        new_desired_files = []
 
1957
        count = 0
 
1958
        for file_id, trans_id in desired_files:
 
1959
            accelerator_path = unchanged.get(file_id)
 
1960
            if accelerator_path is None:
 
1961
                new_desired_files.append((file_id, trans_id))
 
1962
                continue
 
1963
            pb.update('Adding file contents', count + offset, total)
 
1964
            if hardlink:
 
1965
                tt.create_hardlink(accelerator_tree.abspath(accelerator_path),
 
1966
                                   trans_id)
 
1967
            else:
 
1968
                contents = accelerator_tree.get_file(file_id, accelerator_path)
 
1969
                try:
 
1970
                    tt.create_file(contents, trans_id)
 
1971
                finally:
 
1972
                    contents.close()
 
1973
            count += 1
 
1974
        offset += count
 
1975
    for count, (trans_id, contents) in enumerate(tree.iter_files_bytes(
 
1976
                                                 new_desired_files)):
 
1977
        tt.create_file(contents, trans_id)
 
1978
        pb.update('Adding file contents', count + offset, total)
1021
1979
 
1022
1980
 
1023
1981
def _reparent_children(tt, old_parent, new_parent):
1024
1982
    for child in tt.iter_tree_children(old_parent):
1025
1983
        tt.adjust_path(tt.final_name(child), new_parent, child)
1026
1984
 
 
1985
def _reparent_transform_children(tt, old_parent, new_parent):
 
1986
    by_parent = tt.by_parent()
 
1987
    for child in by_parent[old_parent]:
 
1988
        tt.adjust_path(tt.final_name(child), new_parent, child)
 
1989
    return by_parent[old_parent]
1027
1990
 
1028
1991
def _content_match(tree, entry, file_id, kind, target_path):
1029
1992
    if entry.kind != kind:
1043
2006
    new_conflicts = set()
1044
2007
    for c_type, conflict in ((c[0], c) for c in conflicts):
1045
2008
        # Anything but a 'duplicate' would indicate programmer error
1046
 
        assert c_type == 'duplicate', c_type
 
2009
        if c_type != 'duplicate':
 
2010
            raise AssertionError(c_type)
1047
2011
        # Now figure out which is new and which is old
1048
2012
        if tt.new_contents(conflict[1]):
1049
2013
            new_file = conflict[1]
1077
2041
        executable = tree.is_executable(entry.file_id)
1078
2042
        return tt.new_file(name, parent_id, contents, entry.file_id, 
1079
2043
                           executable)
1080
 
    elif kind == 'directory':
1081
 
        return tt.new_directory(name, parent_id, entry.file_id)
 
2044
    elif kind in ('directory', 'tree-reference'):
 
2045
        trans_id = tt.new_directory(name, parent_id, entry.file_id)
 
2046
        if kind == 'tree-reference':
 
2047
            tt.set_tree_reference(entry.reference_revision, trans_id)
 
2048
        return trans_id 
1082
2049
    elif kind == 'symlink':
1083
2050
        target = tree.get_symlink_target(entry.file_id)
1084
2051
        return tt.new_symlink(name, parent_id, target, entry.file_id)
 
2052
    else:
 
2053
        raise errors.BadFileKindError(name, kind)
 
2054
 
1085
2055
 
1086
2056
def create_by_entry(tt, entry, tree, trans_id, lines=None, mode_id=None):
1087
2057
    """Create new file contents according to an inventory entry."""
1094
2064
    elif entry.kind == "directory":
1095
2065
        tt.create_directory(trans_id)
1096
2066
 
 
2067
 
1097
2068
def create_entry_executability(tt, entry, trans_id):
1098
2069
    """Set the executability of a trans_id according to an inventory entry"""
1099
2070
    if entry.kind == "file":
1100
2071
        tt.set_executability(entry.executable, trans_id)
1101
2072
 
1102
2073
 
1103
 
def find_interesting(working_tree, target_tree, filenames):
1104
 
    """Find the ids corresponding to specified filenames."""
1105
 
    trees = (working_tree, target_tree)
1106
 
    return tree.find_ids_across_trees(filenames, trees)
1107
 
 
1108
 
 
1109
 
def change_entry(tt, file_id, working_tree, target_tree, 
1110
 
                 trans_id_file_id, backups, trans_id, by_parent):
1111
 
    """Replace a file_id's contents with those from a target tree."""
1112
 
    e_trans_id = trans_id_file_id(file_id)
1113
 
    entry = target_tree.inventory[file_id]
1114
 
    has_contents, contents_mod, meta_mod, = _entry_changes(file_id, entry, 
1115
 
                                                           working_tree)
1116
 
    if contents_mod:
1117
 
        mode_id = e_trans_id
1118
 
        if has_contents:
1119
 
            if not backups:
1120
 
                tt.delete_contents(e_trans_id)
1121
 
            else:
1122
 
                parent_trans_id = trans_id_file_id(entry.parent_id)
1123
 
                backup_name = get_backup_name(entry, by_parent,
1124
 
                                              parent_trans_id, tt)
1125
 
                tt.adjust_path(backup_name, parent_trans_id, e_trans_id)
1126
 
                tt.unversion_file(e_trans_id)
1127
 
                e_trans_id = tt.create_path(entry.name, parent_trans_id)
1128
 
                tt.version_file(file_id, e_trans_id)
1129
 
                trans_id[file_id] = e_trans_id
1130
 
        create_by_entry(tt, entry, target_tree, e_trans_id, mode_id=mode_id)
1131
 
        create_entry_executability(tt, entry, e_trans_id)
1132
 
 
1133
 
    elif meta_mod:
1134
 
        tt.set_executability(entry.executable, e_trans_id)
1135
 
    if tt.final_name(e_trans_id) != entry.name:
1136
 
        adjust_path  = True
1137
 
    else:
1138
 
        parent_id = tt.final_parent(e_trans_id)
1139
 
        parent_file_id = tt.final_file_id(parent_id)
1140
 
        if parent_file_id != entry.parent_id:
1141
 
            adjust_path = True
1142
 
        else:
1143
 
            adjust_path = False
1144
 
    if adjust_path:
1145
 
        parent_trans_id = trans_id_file_id(entry.parent_id)
1146
 
        tt.adjust_path(entry.name, parent_trans_id, e_trans_id)
1147
 
 
1148
 
 
1149
2074
def get_backup_name(entry, by_parent, parent_trans_id, tt):
 
2075
    return _get_backup_name(entry.name, by_parent, parent_trans_id, tt)
 
2076
 
 
2077
 
 
2078
def _get_backup_name(name, by_parent, parent_trans_id, tt):
1150
2079
    """Produce a backup-style name that appears to be available"""
1151
2080
    def name_gen():
1152
2081
        counter = 1
1153
2082
        while True:
1154
 
            yield "%s.~%d~" % (entry.name, counter)
 
2083
            yield "%s.~%d~" % (name, counter)
1155
2084
            counter += 1
1156
 
    for name in name_gen():
1157
 
        if not tt.has_named_child(by_parent, parent_trans_id, name):
1158
 
            return name
 
2085
    for new_name in name_gen():
 
2086
        if not tt.has_named_child(by_parent, parent_trans_id, new_name):
 
2087
            return new_name
 
2088
 
1159
2089
 
1160
2090
def _entry_changes(file_id, entry, working_tree):
1161
2091
    """Determine in which ways the inventory entry has changed.
1184
2114
    return has_contents, contents_mod, meta_mod
1185
2115
 
1186
2116
 
1187
 
def revert(working_tree, target_tree, filenames, backups=False, 
1188
 
           pb=DummyProgress()):
 
2117
def revert(working_tree, target_tree, filenames, backups=False,
 
2118
           pb=DummyProgress(), change_reporter=None):
1189
2119
    """Revert a working tree's contents to those of a target tree."""
1190
 
    interesting_ids = find_interesting(working_tree, target_tree, filenames)
1191
 
    def interesting(file_id):
1192
 
        return interesting_ids is None or (file_id in interesting_ids)
1193
 
 
 
2120
    target_tree.lock_read()
1194
2121
    tt = TreeTransform(working_tree, pb)
1195
2122
    try:
1196
 
        merge_modified = working_tree.merge_modified()
1197
 
        trans_id = {}
1198
 
        def trans_id_file_id(file_id):
1199
 
            try:
1200
 
                return trans_id[file_id]
1201
 
            except KeyError:
1202
 
                return tt.trans_id_tree_file_id(file_id)
1203
 
 
1204
 
        pp = ProgressPhase("Revert phase", 4, pb)
1205
 
        pp.next_phase()
1206
 
        sorted_interesting = [i for i in topology_sorted_ids(target_tree) if
1207
 
                              interesting(i)]
1208
 
        child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1209
 
        try:
1210
 
            by_parent = tt.by_parent()
1211
 
            for id_num, file_id in enumerate(sorted_interesting):
1212
 
                child_pb.update("Reverting file", id_num+1, 
1213
 
                                len(sorted_interesting))
1214
 
                if file_id not in working_tree.inventory:
1215
 
                    entry = target_tree.inventory[file_id]
1216
 
                    parent_id = trans_id_file_id(entry.parent_id)
1217
 
                    e_trans_id = new_by_entry(tt, entry, parent_id, target_tree)
1218
 
                    trans_id[file_id] = e_trans_id
1219
 
                else:
1220
 
                    backup_this = backups
1221
 
                    if file_id in merge_modified:
1222
 
                        backup_this = False
1223
 
                        del merge_modified[file_id]
1224
 
                    change_entry(tt, file_id, working_tree, target_tree, 
1225
 
                                 trans_id_file_id, backup_this, trans_id,
1226
 
                                 by_parent)
1227
 
        finally:
1228
 
            child_pb.finished()
1229
 
        pp.next_phase()
1230
 
        wt_interesting = [i for i in working_tree.inventory if interesting(i)]
1231
 
        child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1232
 
        try:
1233
 
            for id_num, file_id in enumerate(wt_interesting):
1234
 
                child_pb.update("New file check", id_num+1, 
1235
 
                                len(sorted_interesting))
1236
 
                if file_id not in target_tree:
1237
 
                    trans_id = tt.trans_id_tree_file_id(file_id)
1238
 
                    tt.unversion_file(trans_id)
1239
 
                    try:
1240
 
                        file_kind = working_tree.kind(file_id)
1241
 
                    except NoSuchFile:
1242
 
                        file_kind = None
1243
 
                    if file_kind != 'file' and file_kind is not None:
1244
 
                        keep_contents = False
1245
 
                        delete_merge_modified = False
1246
 
                    else:
1247
 
                        if (file_id in merge_modified and 
1248
 
                            merge_modified[file_id] == 
1249
 
                            working_tree.get_file_sha1(file_id)):
1250
 
                            keep_contents = False
1251
 
                            delete_merge_modified = True
1252
 
                        else:
1253
 
                            keep_contents = True
1254
 
                            delete_merge_modified = False
1255
 
                    if not keep_contents:
 
2123
        pp = ProgressPhase("Revert phase", 3, pb)
 
2124
        pp.next_phase()
 
2125
        child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
2126
        try:
 
2127
            merge_modified = _alter_files(working_tree, target_tree, tt,
 
2128
                                          child_pb, filenames, backups)
 
2129
        finally:
 
2130
            child_pb.finished()
 
2131
        pp.next_phase()
 
2132
        child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
2133
        try:
 
2134
            raw_conflicts = resolve_conflicts(tt, child_pb,
 
2135
                lambda t, c: conflict_pass(t, c, target_tree))
 
2136
        finally:
 
2137
            child_pb.finished()
 
2138
        conflicts = cook_conflicts(raw_conflicts, tt)
 
2139
        if change_reporter:
 
2140
            change_reporter = delta._ChangeReporter(
 
2141
                unversioned_filter=working_tree.is_ignored)
 
2142
            delta.report_changes(tt.iter_changes(), change_reporter)
 
2143
        for conflict in conflicts:
 
2144
            warning(conflict)
 
2145
        pp.next_phase()
 
2146
        tt.apply()
 
2147
        working_tree.set_merge_modified(merge_modified)
 
2148
    finally:
 
2149
        target_tree.unlock()
 
2150
        tt.finalize()
 
2151
        pb.clear()
 
2152
    return conflicts
 
2153
 
 
2154
 
 
2155
def _alter_files(working_tree, target_tree, tt, pb, specific_files,
 
2156
                 backups):
 
2157
    merge_modified = working_tree.merge_modified()
 
2158
    change_list = target_tree.iter_changes(working_tree,
 
2159
        specific_files=specific_files, pb=pb)
 
2160
    if target_tree.inventory.root is None:
 
2161
        skip_root = True
 
2162
    else:
 
2163
        skip_root = False
 
2164
    basis_tree = None
 
2165
    try:
 
2166
        deferred_files = []
 
2167
        for id_num, (file_id, path, changed_content, versioned, parent, name,
 
2168
                kind, executable) in enumerate(change_list):
 
2169
            if skip_root and file_id[0] is not None and parent[0] is None:
 
2170
                continue
 
2171
            trans_id = tt.trans_id_file_id(file_id)
 
2172
            mode_id = None
 
2173
            if changed_content:
 
2174
                keep_content = False
 
2175
                if kind[0] == 'file' and (backups or kind[1] is None):
 
2176
                    wt_sha1 = working_tree.get_file_sha1(file_id)
 
2177
                    if merge_modified.get(file_id) != wt_sha1:
 
2178
                        # acquire the basis tree lazily to prevent the
 
2179
                        # expense of accessing it when it's not needed ?
 
2180
                        # (Guessing, RBC, 200702)
 
2181
                        if basis_tree is None:
 
2182
                            basis_tree = working_tree.basis_tree()
 
2183
                            basis_tree.lock_read()
 
2184
                        if file_id in basis_tree:
 
2185
                            if wt_sha1 != basis_tree.get_file_sha1(file_id):
 
2186
                                keep_content = True
 
2187
                        elif kind[1] is None and not versioned[1]:
 
2188
                            keep_content = True
 
2189
                if kind[0] is not None:
 
2190
                    if not keep_content:
1256
2191
                        tt.delete_contents(trans_id)
1257
 
                    if delete_merge_modified:
1258
 
                        del merge_modified[file_id]
1259
 
        finally:
1260
 
            child_pb.finished()
1261
 
        pp.next_phase()
1262
 
        child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1263
 
        try:
1264
 
            raw_conflicts = resolve_conflicts(tt, child_pb)
1265
 
        finally:
1266
 
            child_pb.finished()
1267
 
        conflicts = cook_conflicts(raw_conflicts, tt)
1268
 
        for conflict in conflicts:
1269
 
            warning(conflict)
1270
 
        pp.next_phase()
1271
 
        tt.apply()
1272
 
        working_tree.set_merge_modified({})
 
2192
                    elif kind[1] is not None:
 
2193
                        parent_trans_id = tt.trans_id_file_id(parent[0])
 
2194
                        by_parent = tt.by_parent()
 
2195
                        backup_name = _get_backup_name(name[0], by_parent,
 
2196
                                                       parent_trans_id, tt)
 
2197
                        tt.adjust_path(backup_name, parent_trans_id, trans_id)
 
2198
                        new_trans_id = tt.create_path(name[0], parent_trans_id)
 
2199
                        if versioned == (True, True):
 
2200
                            tt.unversion_file(trans_id)
 
2201
                            tt.version_file(file_id, new_trans_id)
 
2202
                        # New contents should have the same unix perms as old
 
2203
                        # contents
 
2204
                        mode_id = trans_id
 
2205
                        trans_id = new_trans_id
 
2206
                if kind[1] == 'directory':
 
2207
                    tt.create_directory(trans_id)
 
2208
                elif kind[1] == 'symlink':
 
2209
                    tt.create_symlink(target_tree.get_symlink_target(file_id),
 
2210
                                      trans_id)
 
2211
                elif kind[1] == 'file':
 
2212
                    deferred_files.append((file_id, (trans_id, mode_id)))
 
2213
                    if basis_tree is None:
 
2214
                        basis_tree = working_tree.basis_tree()
 
2215
                        basis_tree.lock_read()
 
2216
                    new_sha1 = target_tree.get_file_sha1(file_id)
 
2217
                    if (file_id in basis_tree and new_sha1 ==
 
2218
                        basis_tree.get_file_sha1(file_id)):
 
2219
                        if file_id in merge_modified:
 
2220
                            del merge_modified[file_id]
 
2221
                    else:
 
2222
                        merge_modified[file_id] = new_sha1
 
2223
 
 
2224
                    # preserve the execute bit when backing up
 
2225
                    if keep_content and executable[0] == executable[1]:
 
2226
                        tt.set_executability(executable[1], trans_id)
 
2227
                elif kind[1] is not None:
 
2228
                    raise AssertionError(kind[1])
 
2229
            if versioned == (False, True):
 
2230
                tt.version_file(file_id, trans_id)
 
2231
            if versioned == (True, False):
 
2232
                tt.unversion_file(trans_id)
 
2233
            if (name[1] is not None and 
 
2234
                (name[0] != name[1] or parent[0] != parent[1])):
 
2235
                tt.adjust_path(
 
2236
                    name[1], tt.trans_id_file_id(parent[1]), trans_id)
 
2237
            if executable[0] != executable[1] and kind[1] == "file":
 
2238
                tt.set_executability(executable[1], trans_id)
 
2239
        for (trans_id, mode_id), bytes in target_tree.iter_files_bytes(
 
2240
            deferred_files):
 
2241
            tt.create_file(bytes, trans_id, mode_id)
1273
2242
    finally:
1274
 
        tt.finalize()
1275
 
        pb.clear()
1276
 
    return conflicts
 
2243
        if basis_tree is not None:
 
2244
            basis_tree.unlock()
 
2245
    return merge_modified
1277
2246
 
1278
2247
 
1279
2248
def resolve_conflicts(tt, pb=DummyProgress(), pass_func=None):
1293
2262
        pb.clear()
1294
2263
 
1295
2264
 
1296
 
def conflict_pass(tt, conflicts):
1297
 
    """Resolve some classes of conflicts."""
 
2265
def conflict_pass(tt, conflicts, path_tree=None):
 
2266
    """Resolve some classes of conflicts.
 
2267
 
 
2268
    :param tt: The transform to resolve conflicts in
 
2269
    :param conflicts: The conflicts to resolve
 
2270
    :param path_tree: A Tree to get supplemental paths from
 
2271
    """
1298
2272
    new_conflicts = set()
1299
2273
    for c_type, conflict in ((c[0], c) for c in conflicts):
1300
2274
        if c_type == 'duplicate id':
1303
2277
                               conflict[1], conflict[2], ))
1304
2278
        elif c_type == 'duplicate':
1305
2279
            # files that were renamed take precedence
1306
 
            new_name = tt.final_name(conflict[1])+'.moved'
1307
2280
            final_parent = tt.final_parent(conflict[1])
1308
2281
            if tt.path_changed(conflict[1]):
1309
 
                tt.adjust_path(new_name, final_parent, conflict[2])
1310
 
                new_conflicts.add((c_type, 'Moved existing file to', 
1311
 
                                   conflict[2], conflict[1]))
 
2282
                existing_file, new_file = conflict[2], conflict[1]
1312
2283
            else:
1313
 
                tt.adjust_path(new_name, final_parent, conflict[1])
1314
 
                new_conflicts.add((c_type, 'Moved existing file to', 
1315
 
                                  conflict[1], conflict[2]))
 
2284
                existing_file, new_file = conflict[1], conflict[2]
 
2285
            new_name = tt.final_name(existing_file)+'.moved'
 
2286
            tt.adjust_path(new_name, final_parent, existing_file)
 
2287
            new_conflicts.add((c_type, 'Moved existing file to', 
 
2288
                               existing_file, new_file))
1316
2289
        elif c_type == 'parent loop':
1317
2290
            # break the loop by undoing one of the ops that caused the loop
1318
2291
            cur = conflict[1]
1329
2302
                new_conflicts.add(('deleting parent', 'Not deleting', 
1330
2303
                                   trans_id))
1331
2304
            except KeyError:
1332
 
                tt.create_directory(trans_id)
1333
 
                new_conflicts.add((c_type, 'Created directory', trans_id))
 
2305
                create = True
 
2306
                try:
 
2307
                    tt.final_name(trans_id)
 
2308
                except NoFinalPath:
 
2309
                    if path_tree is not None:
 
2310
                        file_id = tt.final_file_id(trans_id)
 
2311
                        if file_id is None:
 
2312
                            file_id = tt.inactive_file_id(trans_id)
 
2313
                        entry = path_tree.inventory[file_id]
 
2314
                        # special-case the other tree root (move its
 
2315
                        # children to current root)
 
2316
                        if entry.parent_id is None:
 
2317
                            create=False
 
2318
                            moved = _reparent_transform_children(
 
2319
                                tt, trans_id, tt.root)
 
2320
                            for child in moved:
 
2321
                                new_conflicts.add((c_type, 'Moved to root',
 
2322
                                                   child))
 
2323
                        else:
 
2324
                            parent_trans_id = tt.trans_id_file_id(
 
2325
                                entry.parent_id)
 
2326
                            tt.adjust_path(entry.name, parent_trans_id,
 
2327
                                           trans_id)
 
2328
                if create:
 
2329
                    tt.create_directory(trans_id)
 
2330
                    new_conflicts.add((c_type, 'Created directory', trans_id))
1334
2331
        elif c_type == 'unversioned parent':
1335
 
            tt.version_file(tt.inactive_file_id(conflict[1]), conflict[1])
 
2332
            file_id = tt.inactive_file_id(conflict[1])
 
2333
            # special-case the other tree root (move its children instead)
 
2334
            if path_tree and file_id in path_tree:
 
2335
                if path_tree.inventory[file_id].parent_id is None:
 
2336
                    continue
 
2337
            tt.version_file(file_id, conflict[1])
1336
2338
            new_conflicts.add((c_type, 'Versioned directory', conflict[1]))
 
2339
        elif c_type == 'non-directory parent':
 
2340
            parent_id = conflict[1]
 
2341
            parent_parent = tt.final_parent(parent_id)
 
2342
            parent_name = tt.final_name(parent_id)
 
2343
            parent_file_id = tt.final_file_id(parent_id)
 
2344
            new_parent_id = tt.new_directory(parent_name + '.new',
 
2345
                parent_parent, parent_file_id)
 
2346
            _reparent_transform_children(tt, parent_id, new_parent_id)
 
2347
            if parent_file_id is not None:
 
2348
                tt.unversion_file(parent_id)
 
2349
            new_conflicts.add((c_type, 'Created directory', new_parent_id))
1337
2350
    return new_conflicts
1338
2351
 
1339
2352
 
1363
2376
                                   file_id=modified_id, 
1364
2377
                                   conflict_path=conflicting_path,
1365
2378
                                   conflict_file_id=conflicting_id)
 
2379
 
 
2380
 
 
2381
class _FileMover(object):
 
2382
    """Moves and deletes files for TreeTransform, tracking operations"""
 
2383
 
 
2384
    def __init__(self):
 
2385
        self.past_renames = []
 
2386
        self.pending_deletions = []
 
2387
 
 
2388
    def rename(self, from_, to):
 
2389
        """Rename a file from one path to another.  Functions like os.rename"""
 
2390
        try:
 
2391
            os.rename(from_, to)
 
2392
        except OSError, e:
 
2393
            if e.errno in (errno.EEXIST, errno.ENOTEMPTY):
 
2394
                raise errors.FileExists(to, str(e))
 
2395
            raise
 
2396
        self.past_renames.append((from_, to))
 
2397
 
 
2398
    def pre_delete(self, from_, to):
 
2399
        """Rename a file out of the way and mark it for deletion.
 
2400
 
 
2401
        Unlike os.unlink, this works equally well for files and directories.
 
2402
        :param from_: The current file path
 
2403
        :param to: A temporary path for the file
 
2404
        """
 
2405
        self.rename(from_, to)
 
2406
        self.pending_deletions.append(to)
 
2407
 
 
2408
    def rollback(self):
 
2409
        """Reverse all renames that have been performed"""
 
2410
        for from_, to in reversed(self.past_renames):
 
2411
            os.rename(to, from_)
 
2412
        # after rollback, don't reuse _FileMover
 
2413
        past_renames = None
 
2414
        pending_deletions = None
 
2415
 
 
2416
    def apply_deletions(self):
 
2417
        """Apply all marked deletions"""
 
2418
        for path in self.pending_deletions:
 
2419
            delete_any(path)
 
2420
        # after apply_deletions, don't reuse _FileMover
 
2421
        past_renames = None
 
2422
        pending_deletions = None