/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

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2008-04-28 18:43:56 UTC
  • mfrom: (3363.2.11 preview-tree-changed)
  • Revision ID: pqm@pqm.ubuntu.com-20080428184356-qic5mhqzrgxlwwhs
(abentley) Get _PreviewTree under test

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/transform.py
1
 
# Copyright (C) 2006 Canonical Ltd
2
 
 
 
1
# Copyright (C) 2006, 2007, 2008 Canonical Ltd
 
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
5
5
# the Free Software Foundation; either version 2 of the License, or
6
6
# (at your option) any later version.
7
 
 
 
7
#
8
8
# This program is distributed in the hope that it will be useful,
9
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11
11
# GNU General Public License for more details.
12
 
 
 
12
#
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
17
17
import os
18
18
import errno
19
19
from stat import S_ISREG
 
20
import tempfile
20
21
 
 
22
from bzrlib.lazy_import import lazy_import
 
23
lazy_import(globals(), """
 
24
from bzrlib import (
 
25
    bzrdir,
 
26
    delta,
 
27
    errors,
 
28
    inventory,
 
29
    revision as _mod_revision,
 
30
    )
 
31
""")
21
32
from bzrlib.errors import (DuplicateKey, MalformedTransform, NoSuchFile,
22
33
                           ReusingTransform, NotVersionedError, CantMoveRoot,
23
 
                           ExistingLimbo, ImmortalLimbo)
 
34
                           ExistingLimbo, ImmortalLimbo, NoFinalPath,
 
35
                           UnableCreateSymlink)
24
36
from bzrlib.inventory import InventoryEntry
25
37
from bzrlib.osutils import (file_kind, supports_executable, pathjoin, lexists,
26
 
                            delete_any)
 
38
                            delete_any, has_symlinks)
27
39
from bzrlib.progress import DummyProgress, ProgressPhase
 
40
from bzrlib.symbol_versioning import (
 
41
        deprecated_function,
 
42
        zero_fifteen,
 
43
        zero_ninety,
 
44
        )
28
45
from bzrlib.trace import mutter, warning
29
 
import bzrlib.ui 
 
46
from bzrlib import tree
 
47
import bzrlib.ui
 
48
import bzrlib.urlutils as urlutils
30
49
 
31
50
 
32
51
ROOT_PARENT = "root-parent"
39
58
 
40
59
 
41
60
class _TransformResults(object):
42
 
    def __init__(self, modified_paths):
 
61
    def __init__(self, modified_paths, rename_count):
43
62
        object.__init__(self)
44
63
        self.modified_paths = modified_paths
45
 
 
46
 
 
47
 
class TreeTransform(object):
48
 
    """Represent a tree transformation.
49
 
    
50
 
    This object is designed to support incremental generation of the transform,
51
 
    in any order.  
52
 
    
53
 
    It is easy to produce malformed transforms, but they are generally
54
 
    harmless.  Attempting to apply a malformed transform will cause an
55
 
    exception to be raised before any modifications are made to the tree.  
56
 
 
57
 
    Many kinds of malformed transforms can be corrected with the 
58
 
    resolve_conflicts function.  The remaining ones indicate programming error,
59
 
    such as trying to create a file with no path.
60
 
 
61
 
    Two sets of file creation methods are supplied.  Convenience methods are:
62
 
     * new_file
63
 
     * new_directory
64
 
     * new_symlink
65
 
 
66
 
    These are composed of the low-level methods:
67
 
     * create_path
68
 
     * create_file or create_directory or create_symlink
69
 
     * version_file
70
 
     * set_executability
71
 
    """
72
 
    def __init__(self, tree, pb=DummyProgress()):
73
 
        """Note: a write lock is taken on the tree.
74
 
        
75
 
        Use TreeTransform.finalize() to release the lock
 
64
        self.rename_count = rename_count
 
65
 
 
66
 
 
67
class TreeTransformBase(object):
 
68
    """The base class for TreeTransform and TreeTransformBase"""
 
69
 
 
70
    def __init__(self, tree, limbodir, pb=DummyProgress(),
 
71
                 case_sensitive=True):
 
72
        """Constructor.
 
73
 
 
74
        :param tree: The tree that will be transformed, but not necessarily
 
75
            the output tree.
 
76
        :param limbodir: A directory where new files can be stored until
 
77
            they are installed in their proper places
 
78
        :param pb: A ProgressBar indicating how much progress is being made
 
79
        :param case_sensitive: If True, the target of the transform is
 
80
            case sensitive, not just case preserving.
76
81
        """
77
82
        object.__init__(self)
78
83
        self._tree = tree
79
 
        self._tree.lock_write()
80
 
        try:
81
 
            control_files = self._tree._control_files
82
 
            self._limbodir = control_files.controlfilename('limbo')
83
 
            try:
84
 
                os.mkdir(self._limbodir)
85
 
            except OSError, e:
86
 
                if e.errno == errno.EEXIST:
87
 
                    raise ExistingLimbo(self._limbodir)
88
 
        except: 
89
 
            self._tree.unlock()
90
 
            raise
91
 
 
 
84
        self._limbodir = limbodir
 
85
        self._deletiondir = None
92
86
        self._id_number = 0
 
87
        # mapping of trans_id -> new basename
93
88
        self._new_name = {}
 
89
        # mapping of trans_id -> new parent trans_id
94
90
        self._new_parent = {}
 
91
        # mapping of trans_id with new contents -> new file_kind
95
92
        self._new_contents = {}
 
93
        # A mapping of transform ids to their limbo filename
 
94
        self._limbo_files = {}
 
95
        # A mapping of transform ids to a set of the transform ids of children
 
96
        # that their limbo directory has
 
97
        self._limbo_children = {}
 
98
        # Map transform ids to maps of child filename to child transform id
 
99
        self._limbo_children_names = {}
 
100
        # List of transform ids that need to be renamed from limbo into place
 
101
        self._needs_rename = set()
 
102
        # Set of trans_ids whose contents will be removed
96
103
        self._removed_contents = set()
 
104
        # Mapping of trans_id -> new execute-bit value
97
105
        self._new_executability = {}
 
106
        # Mapping of trans_id -> new tree-reference value
 
107
        self._new_reference_revision = {}
 
108
        # Mapping of trans_id -> new file_id
98
109
        self._new_id = {}
 
110
        # Mapping of old file-id -> trans_id
99
111
        self._non_present_ids = {}
 
112
        # Mapping of new file_id -> trans_id
100
113
        self._r_new_id = {}
 
114
        # Set of file_ids that will be removed
101
115
        self._removed_id = set()
 
116
        # Mapping of path in old tree -> trans_id
102
117
        self._tree_path_ids = {}
 
118
        # Mapping trans_id -> path in old tree
103
119
        self._tree_id_paths = {}
 
120
        # Cache of realpath results, to speed up canonical_path
 
121
        self._realpaths = {}
 
122
        # Cache of relpath results, to speed up canonical_path
 
123
        self._relpaths = {}
 
124
        # The trans_id that will be used as the tree root
104
125
        self._new_root = self.trans_id_tree_file_id(tree.get_root_id())
105
 
        self.__done = False
 
126
        # Indictor of whether the transform has been applied
 
127
        self._done = False
 
128
        # A progress bar
106
129
        self._pb = pb
 
130
        # Whether the target is case sensitive
 
131
        self._case_sensitive_target = case_sensitive
 
132
        # A counter of how many files have been renamed
 
133
        self.rename_count = 0
107
134
 
108
135
    def __get_root(self):
109
136
        return self._new_root
111
138
    root = property(__get_root)
112
139
 
113
140
    def finalize(self):
114
 
        """Release the working tree lock, if held, clean up limbo dir."""
 
141
        """Release the working tree lock, if held, clean up limbo dir.
 
142
 
 
143
        This is required if apply has not been invoked, but can be invoked
 
144
        even after apply.
 
145
        """
115
146
        if self._tree is None:
116
147
            return
117
148
        try:
118
 
            for trans_id, kind in self._new_contents.iteritems():
119
 
                path = self._limbo_name(trans_id)
 
149
            entries = [(self._limbo_name(t), t, k) for t, k in
 
150
                       self._new_contents.iteritems()]
 
151
            entries.sort(reverse=True)
 
152
            for path, trans_id, kind in entries:
120
153
                if kind == "directory":
121
154
                    os.rmdir(path)
122
155
                else:
126
159
            except OSError:
127
160
                # We don't especially care *why* the dir is immortal.
128
161
                raise ImmortalLimbo(self._limbodir)
 
162
            try:
 
163
                if self._deletiondir is not None:
 
164
                    os.rmdir(self._deletiondir)
 
165
            except OSError:
 
166
                raise errors.ImmortalPendingDeletion(self._deletiondir)
129
167
        finally:
130
168
            self._tree.unlock()
131
169
            self._tree = None
147
185
        """Change the path that is assigned to a transaction id."""
148
186
        if trans_id == self._new_root:
149
187
            raise CantMoveRoot
 
188
        previous_parent = self._new_parent.get(trans_id)
 
189
        previous_name = self._new_name.get(trans_id)
150
190
        self._new_name[trans_id] = name
151
191
        self._new_parent[trans_id] = parent
 
192
        if (trans_id in self._limbo_files and
 
193
            trans_id not in self._needs_rename):
 
194
            self._rename_in_limbo([trans_id])
 
195
            self._limbo_children[previous_parent].remove(trans_id)
 
196
            del self._limbo_children_names[previous_parent][previous_name]
 
197
 
 
198
    def _rename_in_limbo(self, trans_ids):
 
199
        """Fix limbo names so that the right final path is produced.
 
200
 
 
201
        This means we outsmarted ourselves-- we tried to avoid renaming
 
202
        these files later by creating them with their final names in their
 
203
        final parents.  But now the previous name or parent is no longer
 
204
        suitable, so we have to rename them.
 
205
 
 
206
        Even for trans_ids that have no new contents, we must remove their
 
207
        entries from _limbo_files, because they are now stale.
 
208
        """
 
209
        for trans_id in trans_ids:
 
210
            old_path = self._limbo_files.pop(trans_id)
 
211
            if trans_id not in self._new_contents:
 
212
                continue
 
213
            new_path = self._limbo_name(trans_id)
 
214
            os.rename(old_path, new_path)
152
215
 
153
216
    def adjust_root_path(self, name, parent):
154
217
        """Emulate moving the root by moving all children, instead.
188
251
        This reflects only files that already exist, not ones that will be
189
252
        added by transactions.
190
253
        """
191
 
        path = self._tree.inventory.id2path(inventory_id)
 
254
        path = self._tree.id2path(inventory_id)
192
255
        return self.trans_id_tree_path(path)
193
256
 
194
257
    def trans_id_file_id(self, file_id):
211
274
    def canonical_path(self, path):
212
275
        """Get the canonical tree-relative path"""
213
276
        # don't follow final symlinks
214
 
        dirname, basename = os.path.split(self._tree.abspath(path))
215
 
        dirname = os.path.realpath(dirname)
216
 
        return self._tree.relpath(pathjoin(dirname, basename))
 
277
        abs = self._tree.abspath(path)
 
278
        if abs in self._relpaths:
 
279
            return self._relpaths[abs]
 
280
        dirname, basename = os.path.split(abs)
 
281
        if dirname not in self._realpaths:
 
282
            self._realpaths[dirname] = os.path.realpath(dirname)
 
283
        dirname = self._realpaths[dirname]
 
284
        abs = pathjoin(dirname, basename)
 
285
        if dirname in self._relpaths:
 
286
            relpath = pathjoin(self._relpaths[dirname], basename)
 
287
            relpath = relpath.rstrip('/\\')
 
288
        else:
 
289
            relpath = self._tree.relpath(abs)
 
290
        self._relpaths[abs] = relpath
 
291
        return relpath
217
292
 
218
293
    def trans_id_tree_path(self, path):
219
294
        """Determine (and maybe set) the transaction ID for a tree path."""
241
316
        New file takes the permissions of any existing file with that id,
242
317
        unless mode_id is specified.
243
318
        """
244
 
        f = file(self._limbo_name(trans_id), 'wb')
245
 
        unique_add(self._new_contents, trans_id, 'file')
246
 
        for segment in contents:
247
 
            f.write(segment)
248
 
        f.close()
 
319
        name = self._limbo_name(trans_id)
 
320
        f = open(name, 'wb')
 
321
        try:
 
322
            try:
 
323
                unique_add(self._new_contents, trans_id, 'file')
 
324
            except:
 
325
                # Clean up the file, it never got registered so
 
326
                # TreeTransform.finalize() won't clean it up.
 
327
                f.close()
 
328
                os.unlink(name)
 
329
                raise
 
330
 
 
331
            f.writelines(contents)
 
332
        finally:
 
333
            f.close()
249
334
        self._set_mode(trans_id, mode_id, S_ISREG)
250
335
 
251
336
    def _set_mode(self, trans_id, mode_id, typefunc):
261
346
        except KeyError:
262
347
            return
263
348
        try:
264
 
            mode = os.stat(old_path).st_mode
 
349
            mode = os.stat(self._tree.abspath(old_path)).st_mode
265
350
        except OSError, e:
266
351
            if e.errno == errno.ENOENT:
267
352
                return
270
355
        if typefunc(mode):
271
356
            os.chmod(self._limbo_name(trans_id), mode)
272
357
 
 
358
    def create_hardlink(self, path, trans_id):
 
359
        """Schedule creation of a hard link"""
 
360
        name = self._limbo_name(trans_id)
 
361
        try:
 
362
            os.link(path, name)
 
363
        except OSError, e:
 
364
            if e.errno != errno.EPERM:
 
365
                raise
 
366
            raise errors.HardLinkNotSupported(path)
 
367
        try:
 
368
            unique_add(self._new_contents, trans_id, 'file')
 
369
        except:
 
370
            # Clean up the file, it never got registered so
 
371
            # TreeTransform.finalize() won't clean it up.
 
372
            os.unlink(name)
 
373
            raise
 
374
 
273
375
    def create_directory(self, trans_id):
274
376
        """Schedule creation of a new directory.
275
377
        
284
386
        target is a bytestring.
285
387
        See also new_symlink.
286
388
        """
287
 
        os.symlink(target, self._limbo_name(trans_id))
288
 
        unique_add(self._new_contents, trans_id, 'symlink')
 
389
        if has_symlinks():
 
390
            os.symlink(target, self._limbo_name(trans_id))
 
391
            unique_add(self._new_contents, trans_id, 'symlink')
 
392
        else:
 
393
            try:
 
394
                path = FinalPaths(self).get_path(trans_id)
 
395
            except KeyError:
 
396
                path = None
 
397
            raise UnableCreateSymlink(path=path)
289
398
 
290
399
    def cancel_creation(self, trans_id):
291
400
        """Cancel the creation of new file contents."""
292
401
        del self._new_contents[trans_id]
 
402
        children = self._limbo_children.get(trans_id)
 
403
        # if this is a limbo directory with children, move them before removing
 
404
        # the directory
 
405
        if children is not None:
 
406
            self._rename_in_limbo(children)
 
407
            del self._limbo_children[trans_id]
 
408
            del self._limbo_children_names[trans_id]
293
409
        delete_any(self._limbo_name(trans_id))
294
410
 
295
411
    def delete_contents(self, trans_id):
319
435
        else:
320
436
            unique_add(self._new_executability, trans_id, executability)
321
437
 
 
438
    def set_tree_reference(self, revision_id, trans_id):
 
439
        """Set the reference associated with a directory"""
 
440
        unique_add(self._new_reference_revision, trans_id, revision_id)
 
441
 
322
442
    def version_file(self, file_id, trans_id):
323
443
        """Schedule a file to become versioned."""
324
444
        assert file_id is not None
381
501
            return None
382
502
        # the file is old; the old id is still valid
383
503
        if self._new_root == trans_id:
384
 
            return self._tree.inventory.root.file_id
 
504
            return self._tree.get_root_id()
385
505
        return self._tree.inventory.path2id(path)
386
506
 
387
507
    def final_file_id(self, trans_id):
426
546
        try:
427
547
            return self._new_name[trans_id]
428
548
        except KeyError:
429
 
            return os.path.basename(self._tree_id_paths[trans_id])
 
549
            try:
 
550
                return os.path.basename(self._tree_id_paths[trans_id])
 
551
            except KeyError:
 
552
                raise NoFinalPath(trans_id, self)
430
553
 
431
554
    def by_parent(self):
432
555
        """Return a map of parent: children for known parents.
445
568
 
446
569
    def path_changed(self, trans_id):
447
570
        """Return True if a trans_id's path has changed."""
448
 
        return trans_id in self._new_name or trans_id in self._new_parent
 
571
        return (trans_id in self._new_name) or (trans_id in self._new_parent)
 
572
 
 
573
    def new_contents(self, trans_id):
 
574
        return (trans_id in self._new_contents)
449
575
 
450
576
    def find_conflicts(self):
451
577
        """Find any violations of inventory or filesystem invariants"""
452
 
        if self.__done is True:
 
578
        if self._done is True:
453
579
            raise ReusingTransform()
454
580
        conflicts = []
455
581
        # ensure all children of all existent parents are known
477
603
                        self.tree_kind(t) == 'directory'])
478
604
        for trans_id in self._removed_id:
479
605
            file_id = self.tree_file_id(trans_id)
480
 
            if self._tree.inventory[file_id].kind in ('directory', 
481
 
                                                      'root_directory'):
 
606
            if file_id is not None:
 
607
                if self._tree.inventory[file_id].kind == 'directory':
 
608
                    parents.append(trans_id)
 
609
            elif self.tree_kind(trans_id) == 'directory':
482
610
                parents.append(trans_id)
483
611
 
484
612
        for parent_id in parents:
494
622
        try:
495
623
            children = os.listdir(self._tree.abspath(path))
496
624
        except OSError, e:
497
 
            if e.errno != errno.ENOENT and e.errno != errno.ESRCH:
 
625
            if e.errno not in (errno.ENOENT, errno.ESRCH, errno.ENOTDIR):
498
626
                raise
499
627
            return
500
628
            
521
649
        if child_id is None:
522
650
            return lexists(self._tree.abspath(childpath))
523
651
        else:
524
 
            if tt.final_parent(child_id) != parent_id:
 
652
            if self.final_parent(child_id) != parent_id:
525
653
                return False
526
 
            if child_id in tt._removed_contents:
 
654
            if child_id in self._removed_contents:
527
655
                # XXX What about dangling file-ids?
528
656
                return False
529
657
            else:
537
665
            parent_id = trans_id
538
666
            while parent_id is not ROOT_PARENT:
539
667
                seen.add(parent_id)
540
 
                parent_id = self.final_parent(parent_id)
 
668
                try:
 
669
                    parent_id = self.final_parent(parent_id)
 
670
                except KeyError:
 
671
                    break
541
672
                if parent_id == trans_id:
542
673
                    conflicts.append(('parent loop', trans_id))
543
674
                if parent_id in seen:
611
742
    def _duplicate_entries(self, by_parent):
612
743
        """No directory may have two entries with the same name."""
613
744
        conflicts = []
 
745
        if (self._new_name, self._new_parent) == ({}, {}):
 
746
            return conflicts
614
747
        for children in by_parent.itervalues():
615
748
            name_ids = [(self.final_name(t), t) for t in children]
 
749
            if not self._case_sensitive_target:
 
750
                name_ids = [(n.lower(), t) for n, t in name_ids]
616
751
            name_ids.sort()
617
752
            last_name = None
618
753
            last_trans_id = None
619
754
            for name, trans_id in name_ids:
 
755
                try:
 
756
                    kind = self.final_kind(trans_id)
 
757
                except NoSuchFile:
 
758
                    kind = None
 
759
                file_id = self.final_file_id(trans_id)
 
760
                if kind is None and file_id is None:
 
761
                    continue
620
762
                if name == last_name:
621
763
                    conflicts.append(('duplicate', last_trans_id, trans_id,
622
764
                    name))
623
 
                try:
624
 
                    kind = self.final_kind(trans_id)
625
 
                except NoSuchFile:
626
 
                    kind = None
627
 
                file_id = self.final_file_id(trans_id)
628
 
                if kind is not None or file_id is not None:
629
 
                    last_name = name
630
 
                    last_trans_id = trans_id
 
765
                last_name = name
 
766
                last_trans_id = trans_id
631
767
        return conflicts
632
768
 
633
769
    def _duplicate_ids(self):
635
771
        conflicts = []
636
772
        removed_tree_ids = set((self.tree_file_id(trans_id) for trans_id in
637
773
                                self._removed_id))
638
 
        active_tree_ids = set((f for f in self._tree.inventory if
639
 
                               f not in removed_tree_ids))
 
774
        all_ids = self._tree.all_file_ids()
 
775
        active_tree_ids = all_ids.difference(removed_tree_ids)
640
776
        for trans_id, file_id in self._new_id.iteritems():
641
777
            if file_id in active_tree_ids:
642
778
                old_trans_id = self.trans_id_tree_file_id(file_id)
675
811
                continue
676
812
            return True
677
813
        return False
678
 
            
679
 
    def apply(self):
680
 
        """Apply all changes to the inventory and filesystem.
681
 
        
682
 
        If filesystem or inventory conflicts are present, MalformedTransform
683
 
        will be thrown.
684
 
        """
685
 
        conflicts = self.find_conflicts()
686
 
        if len(conflicts) != 0:
687
 
            raise MalformedTransform(conflicts=conflicts)
688
 
        limbo_inv = {}
689
 
        inv = self._tree.inventory
690
 
        child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
691
 
        try:
692
 
            child_pb.update('Apply phase', 0, 2)
693
 
            self._apply_removals(inv, limbo_inv)
694
 
            child_pb.update('Apply phase', 1, 2)
695
 
            modified_paths = self._apply_insertions(inv, limbo_inv)
696
 
        finally:
697
 
            child_pb.finished()
698
 
        self._tree._write_inventory(inv)
699
 
        self.__done = True
700
 
        self.finalize()
701
 
        return _TransformResults(modified_paths)
702
814
 
703
815
    def _limbo_name(self, trans_id):
704
816
        """Generate the limbo name of a file"""
705
 
        return pathjoin(self._limbodir, trans_id)
706
 
 
707
 
    def _apply_removals(self, inv, limbo_inv):
708
 
        """Perform tree operations that remove directory/inventory names.
709
 
        
710
 
        That is, delete files that are to be deleted, and put any files that
711
 
        need renaming into limbo.  This must be done in strict child-to-parent
712
 
        order.
713
 
        """
714
 
        tree_paths = list(self._tree_path_ids.iteritems())
715
 
        tree_paths.sort(reverse=True)
716
 
        child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
717
 
        try:
718
 
            for num, data in enumerate(tree_paths):
719
 
                path, trans_id = data
720
 
                child_pb.update('removing file', num, len(tree_paths))
721
 
                full_path = self._tree.abspath(path)
722
 
                if trans_id in self._removed_contents:
723
 
                    delete_any(full_path)
724
 
                elif trans_id in self._new_name or trans_id in \
725
 
                    self._new_parent:
726
 
                    try:
727
 
                        os.rename(full_path, self._limbo_name(trans_id))
728
 
                    except OSError, e:
729
 
                        if e.errno != errno.ENOENT:
730
 
                            raise
731
 
                if trans_id in self._removed_id:
732
 
                    if trans_id == self._new_root:
733
 
                        file_id = self._tree.inventory.root.file_id
 
817
        limbo_name = self._limbo_files.get(trans_id)
 
818
        if limbo_name is not None:
 
819
            return limbo_name
 
820
        parent = self._new_parent.get(trans_id)
 
821
        # if the parent directory is already in limbo (e.g. when building a
 
822
        # tree), choose a limbo name inside the parent, to reduce further
 
823
        # renames.
 
824
        use_direct_path = False
 
825
        if self._new_contents.get(parent) == 'directory':
 
826
            filename = self._new_name.get(trans_id)
 
827
            if filename is not None:
 
828
                if parent not in self._limbo_children:
 
829
                    self._limbo_children[parent] = set()
 
830
                    self._limbo_children_names[parent] = {}
 
831
                    use_direct_path = True
 
832
                # the direct path can only be used if no other file has
 
833
                # already taken this pathname, i.e. if the name is unused, or
 
834
                # if it is already associated with this trans_id.
 
835
                elif self._case_sensitive_target:
 
836
                    if (self._limbo_children_names[parent].get(filename)
 
837
                        in (trans_id, None)):
 
838
                        use_direct_path = True
 
839
                else:
 
840
                    for l_filename, l_trans_id in\
 
841
                        self._limbo_children_names[parent].iteritems():
 
842
                        if l_trans_id == trans_id:
 
843
                            continue
 
844
                        if l_filename.lower() == filename.lower():
 
845
                            break
734
846
                    else:
735
 
                        file_id = self.tree_file_id(trans_id)
736
 
                    del inv[file_id]
737
 
                elif trans_id in self._new_name or trans_id in self._new_parent:
738
 
                    file_id = self.tree_file_id(trans_id)
739
 
                    if file_id is not None:
740
 
                        limbo_inv[trans_id] = inv[file_id]
741
 
                        del inv[file_id]
742
 
        finally:
743
 
            child_pb.finished()
744
 
 
745
 
    def _apply_insertions(self, inv, limbo_inv):
746
 
        """Perform tree operations that insert directory/inventory names.
747
 
        
748
 
        That is, create any files that need to be created, and restore from
749
 
        limbo any files that needed renaming.  This must be done in strict
750
 
        parent-to-child order.
751
 
        """
752
 
        new_paths = self.new_paths()
753
 
        modified_paths = []
754
 
        child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
755
 
        try:
756
 
            for num, (path, trans_id) in enumerate(new_paths):
757
 
                child_pb.update('adding file', num, len(new_paths))
758
 
                try:
759
 
                    kind = self._new_contents[trans_id]
760
 
                except KeyError:
761
 
                    kind = contents = None
762
 
                if trans_id in self._new_contents or \
763
 
                    self.path_changed(trans_id):
764
 
                    full_path = self._tree.abspath(path)
765
 
                    try:
766
 
                        os.rename(self._limbo_name(trans_id), full_path)
767
 
                    except OSError, e:
768
 
                        # We may be renaming a dangling inventory id
769
 
                        if e.errno != errno.ENOENT:
770
 
                            raise
771
 
                    if trans_id in self._new_contents:
772
 
                        modified_paths.append(full_path)
773
 
                        del self._new_contents[trans_id]
774
 
 
775
 
                if trans_id in self._new_id:
776
 
                    if kind is None:
777
 
                        kind = file_kind(self._tree.abspath(path))
778
 
                    inv.add_path(path, kind, self._new_id[trans_id])
779
 
                elif trans_id in self._new_name or trans_id in\
780
 
                    self._new_parent:
781
 
                    entry = limbo_inv.get(trans_id)
782
 
                    if entry is not None:
783
 
                        entry.name = self.final_name(trans_id)
784
 
                        parent_path = os.path.dirname(path)
785
 
                        entry.parent_id = \
786
 
                            self._tree.inventory.path2id(parent_path)
787
 
                        inv.add(entry)
788
 
 
789
 
                # requires files and inventory entries to be in place
790
 
                if trans_id in self._new_executability:
791
 
                    self._set_executability(path, inv, trans_id)
792
 
        finally:
793
 
            child_pb.finished()
794
 
        return modified_paths
795
 
 
796
 
    def _set_executability(self, path, inv, trans_id):
 
847
                        use_direct_path = True
 
848
 
 
849
        if use_direct_path:
 
850
            limbo_name = pathjoin(self._limbo_files[parent], filename)
 
851
            self._limbo_children[parent].add(trans_id)
 
852
            self._limbo_children_names[parent][filename] = trans_id
 
853
        else:
 
854
            limbo_name = pathjoin(self._limbodir, trans_id)
 
855
            self._needs_rename.add(trans_id)
 
856
        self._limbo_files[trans_id] = limbo_name
 
857
        return limbo_name
 
858
 
 
859
    def _set_executability(self, path, entry, trans_id):
797
860
        """Set the executability of versioned files """
798
 
        file_id = inv.path2id(path)
799
861
        new_executability = self._new_executability[trans_id]
800
 
        inv[file_id].executable = new_executability
 
862
        entry.executable = new_executability
801
863
        if supports_executable():
802
864
            abspath = self._tree.abspath(path)
803
865
            current_mode = os.stat(abspath).st_mode
829
891
        parent_id is the transaction id of the parent directory of the file.
830
892
        contents is an iterator of bytestrings, which will be used to produce
831
893
        the file.
832
 
        file_id is the inventory ID of the file, if it is to be versioned.
 
894
        :param file_id: The inventory ID of the file, if it is to be versioned.
 
895
        :param executable: Only valid when a file_id has been supplied.
833
896
        """
834
897
        trans_id = self._new_entry(name, parent_id, file_id)
 
898
        # TODO: rather than scheduling a set_executable call,
 
899
        # have create_file create the file with the right mode.
835
900
        self.create_file(contents, trans_id)
836
901
        if executable is not None:
837
902
            self.set_executability(executable, trans_id)
861
926
        self.create_symlink(target, trans_id)
862
927
        return trans_id
863
928
 
 
929
    def _affected_ids(self):
 
930
        """Return the set of transform ids affected by the transform"""
 
931
        trans_ids = set(self._removed_id)
 
932
        trans_ids.update(self._new_id.keys())
 
933
        trans_ids.update(self._removed_contents)
 
934
        trans_ids.update(self._new_contents.keys())
 
935
        trans_ids.update(self._new_executability.keys())
 
936
        trans_ids.update(self._new_name.keys())
 
937
        trans_ids.update(self._new_parent.keys())
 
938
        return trans_ids
 
939
 
 
940
    def _get_file_id_maps(self):
 
941
        """Return mapping of file_ids to trans_ids in the to and from states"""
 
942
        trans_ids = self._affected_ids()
 
943
        from_trans_ids = {}
 
944
        to_trans_ids = {}
 
945
        # Build up two dicts: trans_ids associated with file ids in the
 
946
        # FROM state, vs the TO state.
 
947
        for trans_id in trans_ids:
 
948
            from_file_id = self.tree_file_id(trans_id)
 
949
            if from_file_id is not None:
 
950
                from_trans_ids[from_file_id] = trans_id
 
951
            to_file_id = self.final_file_id(trans_id)
 
952
            if to_file_id is not None:
 
953
                to_trans_ids[to_file_id] = trans_id
 
954
        return from_trans_ids, to_trans_ids
 
955
 
 
956
    def _from_file_data(self, from_trans_id, from_versioned, file_id):
 
957
        """Get data about a file in the from (tree) state
 
958
 
 
959
        Return a (name, parent, kind, executable) tuple
 
960
        """
 
961
        from_path = self._tree_id_paths.get(from_trans_id)
 
962
        if from_versioned:
 
963
            # get data from working tree if versioned
 
964
            from_entry = self._tree.inventory[file_id]
 
965
            from_name = from_entry.name
 
966
            from_parent = from_entry.parent_id
 
967
        else:
 
968
            from_entry = None
 
969
            if from_path is None:
 
970
                # File does not exist in FROM state
 
971
                from_name = None
 
972
                from_parent = None
 
973
            else:
 
974
                # File exists, but is not versioned.  Have to use path-
 
975
                # splitting stuff
 
976
                from_name = os.path.basename(from_path)
 
977
                tree_parent = self.get_tree_parent(from_trans_id)
 
978
                from_parent = self.tree_file_id(tree_parent)
 
979
        if from_path is not None:
 
980
            from_kind, from_executable, from_stats = \
 
981
                self._tree._comparison_data(from_entry, from_path)
 
982
        else:
 
983
            from_kind = None
 
984
            from_executable = False
 
985
        return from_name, from_parent, from_kind, from_executable
 
986
 
 
987
    def _to_file_data(self, to_trans_id, from_trans_id, from_executable):
 
988
        """Get data about a file in the to (target) state
 
989
 
 
990
        Return a (name, parent, kind, executable) tuple
 
991
        """
 
992
        to_name = self.final_name(to_trans_id)
 
993
        try:
 
994
            to_kind = self.final_kind(to_trans_id)
 
995
        except NoSuchFile:
 
996
            to_kind = None
 
997
        to_parent = self.final_file_id(self.final_parent(to_trans_id))
 
998
        if to_trans_id in self._new_executability:
 
999
            to_executable = self._new_executability[to_trans_id]
 
1000
        elif to_trans_id == from_trans_id:
 
1001
            to_executable = from_executable
 
1002
        else:
 
1003
            to_executable = False
 
1004
        return to_name, to_parent, to_kind, to_executable
 
1005
 
 
1006
    def iter_changes(self):
 
1007
        """Produce output in the same format as Tree.iter_changes.
 
1008
 
 
1009
        Will produce nonsensical results if invoked while inventory/filesystem
 
1010
        conflicts (as reported by TreeTransform.find_conflicts()) are present.
 
1011
 
 
1012
        This reads the Transform, but only reproduces changes involving a
 
1013
        file_id.  Files that are not versioned in either of the FROM or TO
 
1014
        states are not reflected.
 
1015
        """
 
1016
        final_paths = FinalPaths(self)
 
1017
        from_trans_ids, to_trans_ids = self._get_file_id_maps()
 
1018
        results = []
 
1019
        # Now iterate through all active file_ids
 
1020
        for file_id in set(from_trans_ids.keys() + to_trans_ids.keys()):
 
1021
            modified = False
 
1022
            from_trans_id = from_trans_ids.get(file_id)
 
1023
            # find file ids, and determine versioning state
 
1024
            if from_trans_id is None:
 
1025
                from_versioned = False
 
1026
                from_trans_id = to_trans_ids[file_id]
 
1027
            else:
 
1028
                from_versioned = True
 
1029
            to_trans_id = to_trans_ids.get(file_id)
 
1030
            if to_trans_id is None:
 
1031
                to_versioned = False
 
1032
                to_trans_id = from_trans_id
 
1033
            else:
 
1034
                to_versioned = True
 
1035
 
 
1036
            from_name, from_parent, from_kind, from_executable = \
 
1037
                self._from_file_data(from_trans_id, from_versioned, file_id)
 
1038
 
 
1039
            to_name, to_parent, to_kind, to_executable = \
 
1040
                self._to_file_data(to_trans_id, from_trans_id, from_executable)
 
1041
 
 
1042
            if not from_versioned:
 
1043
                from_path = None
 
1044
            else:
 
1045
                from_path = self._tree_id_paths.get(from_trans_id)
 
1046
            if not to_versioned:
 
1047
                to_path = None
 
1048
            else:
 
1049
                to_path = final_paths.get_path(to_trans_id)
 
1050
            if from_kind != to_kind:
 
1051
                modified = True
 
1052
            elif to_kind in ('file', 'symlink') and (
 
1053
                to_trans_id != from_trans_id or
 
1054
                to_trans_id in self._new_contents):
 
1055
                modified = True
 
1056
            if (not modified and from_versioned == to_versioned and
 
1057
                from_parent==to_parent and from_name == to_name and
 
1058
                from_executable == to_executable):
 
1059
                continue
 
1060
            results.append((file_id, (from_path, to_path), modified,
 
1061
                   (from_versioned, to_versioned),
 
1062
                   (from_parent, to_parent),
 
1063
                   (from_name, to_name),
 
1064
                   (from_kind, to_kind),
 
1065
                   (from_executable, to_executable)))
 
1066
        return iter(sorted(results, key=lambda x:x[1]))
 
1067
 
 
1068
    def get_preview_tree(self):
 
1069
        """Return a tree representing the result of the transform.
 
1070
 
 
1071
        This tree only supports the subset of Tree functionality required
 
1072
        by show_diff_trees.  It must only be compared to tt._tree.
 
1073
        """
 
1074
        return _PreviewTree(self)
 
1075
 
 
1076
 
 
1077
class TreeTransform(TreeTransformBase):
 
1078
    """Represent a tree transformation.
 
1079
 
 
1080
    This object is designed to support incremental generation of the transform,
 
1081
    in any order.
 
1082
 
 
1083
    However, it gives optimum performance when parent directories are created
 
1084
    before their contents.  The transform is then able to put child files
 
1085
    directly in their parent directory, avoiding later renames.
 
1086
 
 
1087
    It is easy to produce malformed transforms, but they are generally
 
1088
    harmless.  Attempting to apply a malformed transform will cause an
 
1089
    exception to be raised before any modifications are made to the tree.
 
1090
 
 
1091
    Many kinds of malformed transforms can be corrected with the
 
1092
    resolve_conflicts function.  The remaining ones indicate programming error,
 
1093
    such as trying to create a file with no path.
 
1094
 
 
1095
    Two sets of file creation methods are supplied.  Convenience methods are:
 
1096
     * new_file
 
1097
     * new_directory
 
1098
     * new_symlink
 
1099
 
 
1100
    These are composed of the low-level methods:
 
1101
     * create_path
 
1102
     * create_file or create_directory or create_symlink
 
1103
     * version_file
 
1104
     * set_executability
 
1105
 
 
1106
    Transform/Transaction ids
 
1107
    -------------------------
 
1108
    trans_ids are temporary ids assigned to all files involved in a transform.
 
1109
    It's possible, even common, that not all files in the Tree have trans_ids.
 
1110
 
 
1111
    trans_ids are used because filenames and file_ids are not good enough
 
1112
    identifiers; filenames change, and not all files have file_ids.  File-ids
 
1113
    are also associated with trans-ids, so that moving a file moves its
 
1114
    file-id.
 
1115
 
 
1116
    trans_ids are only valid for the TreeTransform that generated them.
 
1117
 
 
1118
    Limbo
 
1119
    -----
 
1120
    Limbo is a temporary directory use to hold new versions of files.
 
1121
    Files are added to limbo by create_file, create_directory, create_symlink,
 
1122
    and their convenience variants (new_*).  Files may be removed from limbo
 
1123
    using cancel_creation.  Files are renamed from limbo into their final
 
1124
    location as part of TreeTransform.apply
 
1125
 
 
1126
    Limbo must be cleaned up, by either calling TreeTransform.apply or
 
1127
    calling TreeTransform.finalize.
 
1128
 
 
1129
    Files are placed into limbo inside their parent directories, where
 
1130
    possible.  This reduces subsequent renames, and makes operations involving
 
1131
    lots of files faster.  This optimization is only possible if the parent
 
1132
    directory is created *before* creating any of its children, so avoid
 
1133
    creating children before parents, where possible.
 
1134
 
 
1135
    Pending-deletion
 
1136
    ----------------
 
1137
    This temporary directory is used by _FileMover for storing files that are
 
1138
    about to be deleted.  In case of rollback, the files will be restored.
 
1139
    FileMover does not delete files until it is sure that a rollback will not
 
1140
    happen.
 
1141
    """
 
1142
    def __init__(self, tree, pb=DummyProgress()):
 
1143
        """Note: a tree_write lock is taken on the tree.
 
1144
 
 
1145
        Use TreeTransform.finalize() to release the lock (can be omitted if
 
1146
        TreeTransform.apply() called).
 
1147
        """
 
1148
        tree.lock_tree_write()
 
1149
 
 
1150
        try:
 
1151
            control_files = tree._control_files
 
1152
            limbodir = urlutils.local_path_from_url(
 
1153
                control_files.controlfilename('limbo'))
 
1154
            try:
 
1155
                os.mkdir(limbodir)
 
1156
            except OSError, e:
 
1157
                if e.errno == errno.EEXIST:
 
1158
                    raise ExistingLimbo(limbodir)
 
1159
            deletiondir = urlutils.local_path_from_url(
 
1160
                control_files.controlfilename('pending-deletion'))
 
1161
            try:
 
1162
                os.mkdir(deletiondir)
 
1163
            except OSError, e:
 
1164
                if e.errno == errno.EEXIST:
 
1165
                    raise errors.ExistingPendingDeletion(deletiondir)
 
1166
        except:
 
1167
            tree.unlock()
 
1168
            raise
 
1169
 
 
1170
        TreeTransformBase.__init__(self, tree, limbodir, pb,
 
1171
                                   tree.case_sensitive)
 
1172
        self._deletiondir = deletiondir
 
1173
 
 
1174
    def apply(self, no_conflicts=False, _mover=None):
 
1175
        """Apply all changes to the inventory and filesystem.
 
1176
 
 
1177
        If filesystem or inventory conflicts are present, MalformedTransform
 
1178
        will be thrown.
 
1179
 
 
1180
        If apply succeeds, finalize is not necessary.
 
1181
 
 
1182
        :param no_conflicts: if True, the caller guarantees there are no
 
1183
            conflicts, so no check is made.
 
1184
        :param _mover: Supply an alternate FileMover, for testing
 
1185
        """
 
1186
        if not no_conflicts:
 
1187
            conflicts = self.find_conflicts()
 
1188
            if len(conflicts) != 0:
 
1189
                raise MalformedTransform(conflicts=conflicts)
 
1190
        inventory_delta = []
 
1191
        child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
1192
        try:
 
1193
            if _mover is None:
 
1194
                mover = _FileMover()
 
1195
            else:
 
1196
                mover = _mover
 
1197
            try:
 
1198
                child_pb.update('Apply phase', 0, 2)
 
1199
                self._apply_removals(inventory_delta, mover)
 
1200
                child_pb.update('Apply phase', 1, 2)
 
1201
                modified_paths = self._apply_insertions(inventory_delta, mover)
 
1202
            except:
 
1203
                mover.rollback()
 
1204
                raise
 
1205
            else:
 
1206
                mover.apply_deletions()
 
1207
        finally:
 
1208
            child_pb.finished()
 
1209
        self._tree.apply_inventory_delta(inventory_delta)
 
1210
        self._done = True
 
1211
        self.finalize()
 
1212
        return _TransformResults(modified_paths, self.rename_count)
 
1213
 
 
1214
    def _apply_removals(self, inventory_delta, mover):
 
1215
        """Perform tree operations that remove directory/inventory names.
 
1216
 
 
1217
        That is, delete files that are to be deleted, and put any files that
 
1218
        need renaming into limbo.  This must be done in strict child-to-parent
 
1219
        order.
 
1220
        """
 
1221
        tree_paths = list(self._tree_path_ids.iteritems())
 
1222
        tree_paths.sort(reverse=True)
 
1223
        child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
1224
        try:
 
1225
            for num, data in enumerate(tree_paths):
 
1226
                path, trans_id = data
 
1227
                child_pb.update('removing file', num, len(tree_paths))
 
1228
                full_path = self._tree.abspath(path)
 
1229
                if trans_id in self._removed_contents:
 
1230
                    mover.pre_delete(full_path, os.path.join(self._deletiondir,
 
1231
                                     trans_id))
 
1232
                elif trans_id in self._new_name or trans_id in \
 
1233
                    self._new_parent:
 
1234
                    try:
 
1235
                        mover.rename(full_path, self._limbo_name(trans_id))
 
1236
                    except OSError, e:
 
1237
                        if e.errno != errno.ENOENT:
 
1238
                            raise
 
1239
                    else:
 
1240
                        self.rename_count += 1
 
1241
                if trans_id in self._removed_id:
 
1242
                    if trans_id == self._new_root:
 
1243
                        file_id = self._tree.get_root_id()
 
1244
                    else:
 
1245
                        file_id = self.tree_file_id(trans_id)
 
1246
                    assert file_id is not None
 
1247
                    # File-id isn't really being deleted, just moved
 
1248
                    if file_id in self._r_new_id:
 
1249
                        continue
 
1250
                    inventory_delta.append((path, None, file_id, None))
 
1251
        finally:
 
1252
            child_pb.finished()
 
1253
 
 
1254
    def _apply_insertions(self, inventory_delta, mover):
 
1255
        """Perform tree operations that insert directory/inventory names.
 
1256
 
 
1257
        That is, create any files that need to be created, and restore from
 
1258
        limbo any files that needed renaming.  This must be done in strict
 
1259
        parent-to-child order.
 
1260
        """
 
1261
        new_paths = self.new_paths()
 
1262
        modified_paths = []
 
1263
        child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
1264
        completed_new = []
 
1265
        try:
 
1266
            for num, (path, trans_id) in enumerate(new_paths):
 
1267
                new_entry = None
 
1268
                child_pb.update('adding file', num, len(new_paths))
 
1269
                if trans_id in self._new_contents or \
 
1270
                    self.path_changed(trans_id):
 
1271
                    full_path = self._tree.abspath(path)
 
1272
                    if trans_id in self._needs_rename:
 
1273
                        try:
 
1274
                            mover.rename(self._limbo_name(trans_id), full_path)
 
1275
                        except OSError, e:
 
1276
                            # We may be renaming a dangling inventory id
 
1277
                            if e.errno != errno.ENOENT:
 
1278
                                raise
 
1279
                        else:
 
1280
                            self.rename_count += 1
 
1281
                    if trans_id in self._new_contents:
 
1282
                        modified_paths.append(full_path)
 
1283
                        completed_new.append(trans_id)
 
1284
                file_id = self.final_file_id(trans_id)
 
1285
                if file_id is not None and (trans_id in self._new_id or
 
1286
                    trans_id in self._new_name or trans_id in self._new_parent
 
1287
                    or trans_id in self._new_executability):
 
1288
                    try:
 
1289
                        kind = self.final_kind(trans_id)
 
1290
                    except NoSuchFile:
 
1291
                        kind = self._tree.stored_kind(file_id)
 
1292
                    if trans_id in self._new_reference_revision:
 
1293
                        new_entry = inventory.TreeReference(
 
1294
                            self.final_file_id(trans_id),
 
1295
                            self._new_name[trans_id],
 
1296
                            self.final_file_id(self._new_parent[trans_id]),
 
1297
                            None, self._new_reference_revision[trans_id])
 
1298
                    else:
 
1299
                        new_entry = inventory.make_entry(kind,
 
1300
                            self.final_name(trans_id),
 
1301
                            self.final_file_id(self.final_parent(trans_id)),
 
1302
                            self.final_file_id(trans_id))
 
1303
                    try:
 
1304
                        old_path = self._tree.id2path(new_entry.file_id)
 
1305
                    except errors.NoSuchId:
 
1306
                        old_path = None
 
1307
                    inventory_delta.append((old_path, path, new_entry.file_id,
 
1308
                                            new_entry))
 
1309
 
 
1310
                if trans_id in self._new_executability:
 
1311
                    self._set_executability(path, new_entry, trans_id)
 
1312
        finally:
 
1313
            child_pb.finished()
 
1314
        for trans_id in completed_new:
 
1315
            del self._new_contents[trans_id]
 
1316
        return modified_paths
 
1317
 
 
1318
 
 
1319
class TransformPreview(TreeTransformBase):
 
1320
    """A TreeTransform for generating preview trees.
 
1321
 
 
1322
    Unlike TreeTransform, this version works when the input tree is a
 
1323
    RevisionTree, rather than a WorkingTree.  As a result, it tends to ignore
 
1324
    unversioned files in the input tree.
 
1325
    """
 
1326
 
 
1327
    def __init__(self, tree, pb=DummyProgress(), case_sensitive=True):
 
1328
        tree.lock_read()
 
1329
        limbodir = tempfile.mkdtemp(prefix='bzr-limbo-')
 
1330
        TreeTransformBase.__init__(self, tree, limbodir, pb, case_sensitive)
 
1331
 
 
1332
    def canonical_path(self, path):
 
1333
        return path
 
1334
 
 
1335
    def tree_kind(self, trans_id):
 
1336
        path = self._tree_id_paths.get(trans_id)
 
1337
        if path is None:
 
1338
            raise NoSuchFile(None)
 
1339
        file_id = self._tree.path2id(path)
 
1340
        return self._tree.kind(file_id)
 
1341
 
 
1342
    def _set_mode(self, trans_id, mode_id, typefunc):
 
1343
        """Set the mode of new file contents.
 
1344
        The mode_id is the existing file to get the mode from (often the same
 
1345
        as trans_id).  The operation is only performed if there's a mode match
 
1346
        according to typefunc.
 
1347
        """
 
1348
        # is it ok to ignore this?  probably
 
1349
        pass
 
1350
 
 
1351
    def iter_tree_children(self, parent_id):
 
1352
        """Iterate through the entry's tree children, if any"""
 
1353
        try:
 
1354
            path = self._tree_id_paths[parent_id]
 
1355
        except KeyError:
 
1356
            return
 
1357
        file_id = self.tree_file_id(parent_id)
 
1358
        for child in self._tree.inventory[file_id].children.iterkeys():
 
1359
            childpath = joinpath(path, child)
 
1360
            yield self.trans_id_tree_path(childpath)
 
1361
 
 
1362
 
 
1363
class _PreviewTree(tree.Tree):
 
1364
    """Partial implementation of Tree to support show_diff_trees"""
 
1365
 
 
1366
    def __init__(self, transform):
 
1367
        self._transform = transform
 
1368
        self._final_paths = FinalPaths(transform)
 
1369
 
 
1370
    def _changes(self, file_id):
 
1371
        for changes in self._transform.iter_changes():
 
1372
            if changes[0] == file_id:
 
1373
                return changes
 
1374
 
 
1375
    def _content_change(self, file_id):
 
1376
        changes = self._changes(file_id)
 
1377
        return (changes is not None and changes[2])
 
1378
 
 
1379
    def _get_file_revision(self, file_id, vf, tree_revision):
 
1380
        return self._transform._tree._get_file_revision(file_id, vf,
 
1381
                                                        tree_revision)
 
1382
 
 
1383
    def _stat_limbo_file(self, file_id):
 
1384
        trans_id = self._transform.trans_id_file_id(file_id)
 
1385
        name = self._transform._limbo_name(trans_id)
 
1386
        return os.lstat(name)
 
1387
 
 
1388
    def lock_read(self):
 
1389
        # Perhaps in theory, this should lock the TreeTransform?
 
1390
        pass
 
1391
 
 
1392
    def unlock(self):
 
1393
        pass
 
1394
 
 
1395
    @property
 
1396
    def inventory(self):
 
1397
        """This Tree does not use inventory as its backing data."""
 
1398
        raise NotImplementedError(_PreviewTree.inventory)
 
1399
 
 
1400
    def get_root_id(self):
 
1401
        return self._transform.final_file_id(self._transform.root)
 
1402
 
 
1403
    def all_file_ids(self):
 
1404
        return self._transform._tree.all_file_ids()
 
1405
 
 
1406
    def __iter__(self):
 
1407
        return iter(self.all_file_ids())
 
1408
 
 
1409
    def paths2ids(self, specific_files, trees=None, require_versioned=False):
 
1410
        """See Tree.paths2ids"""
 
1411
        to_find = set(specific_files)
 
1412
        result = set()
 
1413
        for (file_id, paths, changed, versioned, parent, name, kind,
 
1414
             executable) in self._transform.iter_changes():
 
1415
            if paths[1] in to_find:
 
1416
                result.append(file_id)
 
1417
                to_find.remove(paths[1])
 
1418
        result.update(self._transform._tree.paths2ids(to_find,
 
1419
                      trees=[], require_versioned=require_versioned))
 
1420
        return result
 
1421
 
 
1422
    def path2id(self, path):
 
1423
        return self._transform._tree.path2id(path)
 
1424
 
 
1425
    def id2path(self, file_id):
 
1426
        trans_id = self._transform.trans_id_file_id(file_id)
 
1427
        try:
 
1428
            return self._final_paths._determine_path(trans_id)
 
1429
        except NoFinalPath:
 
1430
            raise errors.NoSuchId(self, file_id)
 
1431
 
 
1432
    def iter_entries_by_dir(self, specific_file_ids=None):
 
1433
        return self._transform._tree.iter_entries_by_dir(specific_file_ids)
 
1434
 
 
1435
    def kind(self, file_id):
 
1436
        trans_id = self._transform.trans_id_file_id(file_id)
 
1437
        return self._transform.final_kind(trans_id)
 
1438
 
 
1439
    def stored_kind(self, file_id):
 
1440
        return self._transform._tree.stored_kind(file_id)
 
1441
 
 
1442
    def get_file_mtime(self, file_id, path=None):
 
1443
        """See Tree.get_file_mtime"""
 
1444
        if not self._content_change(file_id):
 
1445
            return self._transform._tree.get_file_mtime(file_id, path)
 
1446
        return self._stat_limbo_file(file_id).st_mtime
 
1447
 
 
1448
    def get_file_size(self, file_id):
 
1449
        if self.kind(file_id) == 'file':
 
1450
            return self._transform._tree.get_file_size(file_id)
 
1451
 
 
1452
    def get_file_sha1(self, file_id, path=None, stat_value=None):
 
1453
        return self._transform._tree.get_file_sha1(file_id)
 
1454
 
 
1455
    def is_executable(self, file_id, path=None):
 
1456
        return self._transform._tree.is_executable(file_id, path)
 
1457
 
 
1458
    def path_content_summary(self, path):
 
1459
        return self._transform._tree.path_content_summary(path)
 
1460
 
 
1461
    def iter_changes(self, from_tree, include_unchanged=False,
 
1462
                      specific_files=None, pb=None, extra_trees=None,
 
1463
                      require_versioned=True, want_unversioned=False):
 
1464
        """See InterTree.iter_changes.
 
1465
 
 
1466
        This implementation does not support include_unchanged, specific_files,
 
1467
        or want_unversioned.  extra_trees, require_versioned, and pb are
 
1468
        ignored.
 
1469
        """
 
1470
        if from_tree is not self._transform._tree:
 
1471
            raise ValueError('from_tree must be transform source tree.')
 
1472
        if include_unchanged:
 
1473
            raise ValueError('include_unchanged is not supported')
 
1474
        if specific_files is not None:
 
1475
            raise ValueError('specific_files is not supported')
 
1476
        if want_unversioned:
 
1477
            raise ValueError('want_unversioned is not supported')
 
1478
        return self._transform.iter_changes()
 
1479
 
 
1480
    def get_file(self, file_id, path=None):
 
1481
        """See Tree.get_file"""
 
1482
        if not self._content_change(file_id):
 
1483
            return self._transform._tree.get_file(file_id, path)
 
1484
        trans_id = self._transform.trans_id_file_id(file_id)
 
1485
        name = self._transform._limbo_name(trans_id)
 
1486
        return open(name, 'rb')
 
1487
 
 
1488
    def get_file_text(self, file_id):
 
1489
        text_file = self.get_file(file_id)
 
1490
        try:
 
1491
            return text_file.read()
 
1492
        finally:
 
1493
            text_file.close()
 
1494
 
 
1495
    def annotate_iter(self, file_id,
 
1496
                      default_revision=_mod_revision.CURRENT_REVISION):
 
1497
        return self._transform._tree.annotate_iter(file_id,
 
1498
            default_revision=default_revision)
 
1499
 
 
1500
    def get_symlink_target(self, file_id):
 
1501
        """See Tree.get_symlink_target"""
 
1502
        if not self._content_change(file_id):
 
1503
            return self._transform._tree.get_symlink_target(file_id)
 
1504
        trans_id = self._transform.trans_id_file_id(file_id)
 
1505
        name = self._transform._limbo_name(trans_id)
 
1506
        return os.readlink(name)
 
1507
 
 
1508
    def list_files(self, include_root=False):
 
1509
        return self._transform._tree.list_files(include_root)
 
1510
 
 
1511
    def walkdirs(self, prefix=""):
 
1512
        return self._transform._tree.walkdirs(prefix)
 
1513
 
 
1514
    def get_parent_ids(self):
 
1515
        return self._transform._tree.get_parent_ids()
 
1516
 
 
1517
    def get_revision_tree(self, revision_id):
 
1518
        return self._transform._tree.get_revision_tree(revision_id)
 
1519
 
 
1520
 
864
1521
def joinpath(parent, child):
865
1522
    """Join tree-relative paths, handling the tree root specially"""
866
1523
    if parent is None or parent == "":
896
1553
            self._known_paths[trans_id] = self._determine_path(trans_id)
897
1554
        return self._known_paths[trans_id]
898
1555
 
 
1556
 
899
1557
def topology_sorted_ids(tree):
900
1558
    """Determine the topological order of the ids in a tree"""
901
1559
    file_ids = list(tree)
902
1560
    file_ids.sort(key=tree.id2path)
903
1561
    return file_ids
904
1562
 
905
 
def build_tree(tree, wt):
906
 
    """Create working tree for a branch, using a Transaction."""
 
1563
 
 
1564
def build_tree(tree, wt, accelerator_tree=None, hardlink=False):
 
1565
    """Create working tree for a branch, using a TreeTransform.
 
1566
    
 
1567
    This function should be used on empty trees, having a tree root at most.
 
1568
    (see merge and revert functionality for working with existing trees)
 
1569
 
 
1570
    Existing files are handled like so:
 
1571
    
 
1572
    - Existing bzrdirs take precedence over creating new items.  They are
 
1573
      created as '%s.diverted' % name.
 
1574
    - Otherwise, if the content on disk matches the content we are building,
 
1575
      it is silently replaced.
 
1576
    - Otherwise, conflict resolution will move the old file to 'oldname.moved'.
 
1577
 
 
1578
    :param tree: The tree to convert wt into a copy of
 
1579
    :param wt: The working tree that files will be placed into
 
1580
    :param accelerator_tree: A tree which can be used for retrieving file
 
1581
        contents more quickly than tree itself, i.e. a workingtree.  tree
 
1582
        will be used for cases where accelerator_tree's content is different.
 
1583
    :param hardlink: If true, hard-link files to accelerator_tree, where
 
1584
        possible.  accelerator_tree must implement abspath, i.e. be a
 
1585
        working tree.
 
1586
    """
 
1587
    wt.lock_tree_write()
 
1588
    try:
 
1589
        tree.lock_read()
 
1590
        try:
 
1591
            if accelerator_tree is not None:
 
1592
                accelerator_tree.lock_read()
 
1593
            try:
 
1594
                return _build_tree(tree, wt, accelerator_tree, hardlink)
 
1595
            finally:
 
1596
                if accelerator_tree is not None:
 
1597
                    accelerator_tree.unlock()
 
1598
        finally:
 
1599
            tree.unlock()
 
1600
    finally:
 
1601
        wt.unlock()
 
1602
 
 
1603
 
 
1604
def _build_tree(tree, wt, accelerator_tree, hardlink):
 
1605
    """See build_tree."""
 
1606
    for num, _unused in enumerate(wt.all_file_ids()):
 
1607
        if num > 0:  # more than just a root
 
1608
            raise errors.WorkingTreeAlreadyPopulated(base=wt.basedir)
907
1609
    file_trans_id = {}
908
1610
    top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
909
1611
    pp = ProgressPhase("Build phase", 2, top_pb)
 
1612
    if tree.inventory.root is not None:
 
1613
        # This is kind of a hack: we should be altering the root
 
1614
        # as part of the regular tree shape diff logic.
 
1615
        # The conditional test here is to avoid doing an
 
1616
        # expensive operation (flush) every time the root id
 
1617
        # is set within the tree, nor setting the root and thus
 
1618
        # marking the tree as dirty, because we use two different
 
1619
        # idioms here: tree interfaces and inventory interfaces.
 
1620
        if wt.get_root_id() != tree.get_root_id():
 
1621
            wt.set_root_id(tree.get_root_id())
 
1622
            wt.flush()
910
1623
    tt = TreeTransform(wt)
 
1624
    divert = set()
911
1625
    try:
912
1626
        pp.next_phase()
913
 
        file_trans_id[wt.get_root_id()] = tt.trans_id_tree_file_id(wt.get_root_id())
914
 
        file_ids = topology_sorted_ids(tree)
 
1627
        file_trans_id[wt.get_root_id()] = \
 
1628
            tt.trans_id_tree_file_id(wt.get_root_id())
915
1629
        pb = bzrlib.ui.ui_factory.nested_progress_bar()
916
1630
        try:
917
 
            for num, file_id in enumerate(file_ids):
918
 
                pb.update("Building tree", num, len(file_ids))
919
 
                entry = tree.inventory[file_id]
 
1631
            deferred_contents = []
 
1632
            num = 0
 
1633
            for num, (tree_path, entry) in \
 
1634
                enumerate(tree.inventory.iter_entries_by_dir()):
 
1635
                pb.update("Building tree", num - len(deferred_contents),
 
1636
                          len(tree.inventory))
920
1637
                if entry.parent_id is None:
921
1638
                    continue
 
1639
                reparent = False
 
1640
                file_id = entry.file_id
 
1641
                target_path = wt.abspath(tree_path)
 
1642
                try:
 
1643
                    kind = file_kind(target_path)
 
1644
                except NoSuchFile:
 
1645
                    pass
 
1646
                else:
 
1647
                    if kind == "directory":
 
1648
                        try:
 
1649
                            bzrdir.BzrDir.open(target_path)
 
1650
                        except errors.NotBranchError:
 
1651
                            pass
 
1652
                        else:
 
1653
                            divert.add(file_id)
 
1654
                    if (file_id not in divert and
 
1655
                        _content_match(tree, entry, file_id, kind,
 
1656
                        target_path)):
 
1657
                        tt.delete_contents(tt.trans_id_tree_path(tree_path))
 
1658
                        if kind == 'directory':
 
1659
                            reparent = True
922
1660
                if entry.parent_id not in file_trans_id:
923
 
                    raise repr(entry.parent_id)
 
1661
                    raise AssertionError(
 
1662
                        'entry %s parent id %r is not in file_trans_id %r'
 
1663
                        % (entry, entry.parent_id, file_trans_id))
924
1664
                parent_id = file_trans_id[entry.parent_id]
925
 
                file_trans_id[file_id] = new_by_entry(tt, entry, parent_id, 
926
 
                                                      tree)
 
1665
                if entry.kind == 'file':
 
1666
                    # We *almost* replicate new_by_entry, so that we can defer
 
1667
                    # getting the file text, and get them all at once.
 
1668
                    trans_id = tt.create_path(entry.name, parent_id)
 
1669
                    file_trans_id[file_id] = trans_id
 
1670
                    tt.version_file(entry.file_id, trans_id)
 
1671
                    executable = tree.is_executable(entry.file_id, tree_path)
 
1672
                    if executable is not None:
 
1673
                        tt.set_executability(executable, trans_id)
 
1674
                    deferred_contents.append((entry.file_id, trans_id))
 
1675
                else:
 
1676
                    file_trans_id[file_id] = new_by_entry(tt, entry, parent_id,
 
1677
                                                          tree)
 
1678
                if reparent:
 
1679
                    new_trans_id = file_trans_id[file_id]
 
1680
                    old_parent = tt.trans_id_tree_path(tree_path)
 
1681
                    _reparent_children(tt, old_parent, new_trans_id)
 
1682
            offset = num + 1 - len(deferred_contents)
 
1683
            _create_files(tt, tree, deferred_contents, pb, offset,
 
1684
                          accelerator_tree, hardlink)
927
1685
        finally:
928
1686
            pb.finished()
929
1687
        pp.next_phase()
930
 
        tt.apply()
 
1688
        divert_trans = set(file_trans_id[f] for f in divert)
 
1689
        resolver = lambda t, c: resolve_checkout(t, c, divert_trans)
 
1690
        raw_conflicts = resolve_conflicts(tt, pass_func=resolver)
 
1691
        conflicts = cook_conflicts(raw_conflicts, tt)
 
1692
        for conflict in conflicts:
 
1693
            warning(conflict)
 
1694
        try:
 
1695
            wt.add_conflicts(conflicts)
 
1696
        except errors.UnsupportedOperation:
 
1697
            pass
 
1698
        result = tt.apply(no_conflicts=True)
931
1699
    finally:
932
1700
        tt.finalize()
933
1701
        top_pb.finished()
 
1702
    return result
 
1703
 
 
1704
 
 
1705
def _create_files(tt, tree, desired_files, pb, offset, accelerator_tree,
 
1706
                  hardlink):
 
1707
    total = len(desired_files) + offset
 
1708
    if accelerator_tree is None:
 
1709
        new_desired_files = desired_files
 
1710
    else:
 
1711
        iter = accelerator_tree.iter_changes(tree, include_unchanged=True)
 
1712
        unchanged = dict((f, p[1]) for (f, p, c, v, d, n, k, e)
 
1713
                         in iter if not (c or e[0] != e[1]))
 
1714
        new_desired_files = []
 
1715
        count = 0
 
1716
        for file_id, trans_id in desired_files:
 
1717
            accelerator_path = unchanged.get(file_id)
 
1718
            if accelerator_path is None:
 
1719
                new_desired_files.append((file_id, trans_id))
 
1720
                continue
 
1721
            pb.update('Adding file contents', count + offset, total)
 
1722
            if hardlink:
 
1723
                tt.create_hardlink(accelerator_tree.abspath(accelerator_path),
 
1724
                                   trans_id)
 
1725
            else:
 
1726
                contents = accelerator_tree.get_file(file_id, accelerator_path)
 
1727
                try:
 
1728
                    tt.create_file(contents, trans_id)
 
1729
                finally:
 
1730
                    contents.close()
 
1731
            count += 1
 
1732
        offset += count
 
1733
    for count, (trans_id, contents) in enumerate(tree.iter_files_bytes(
 
1734
                                                 new_desired_files)):
 
1735
        tt.create_file(contents, trans_id)
 
1736
        pb.update('Adding file contents', count + offset, total)
 
1737
 
 
1738
 
 
1739
def _reparent_children(tt, old_parent, new_parent):
 
1740
    for child in tt.iter_tree_children(old_parent):
 
1741
        tt.adjust_path(tt.final_name(child), new_parent, child)
 
1742
 
 
1743
def _reparent_transform_children(tt, old_parent, new_parent):
 
1744
    by_parent = tt.by_parent()
 
1745
    for child in by_parent[old_parent]:
 
1746
        tt.adjust_path(tt.final_name(child), new_parent, child)
 
1747
    return by_parent[old_parent]
 
1748
 
 
1749
def _content_match(tree, entry, file_id, kind, target_path):
 
1750
    if entry.kind != kind:
 
1751
        return False
 
1752
    if entry.kind == "directory":
 
1753
        return True
 
1754
    if entry.kind == "file":
 
1755
        if tree.get_file(file_id).read() == file(target_path, 'rb').read():
 
1756
            return True
 
1757
    elif entry.kind == "symlink":
 
1758
        if tree.get_symlink_target(file_id) == os.readlink(target_path):
 
1759
            return True
 
1760
    return False
 
1761
 
 
1762
 
 
1763
def resolve_checkout(tt, conflicts, divert):
 
1764
    new_conflicts = set()
 
1765
    for c_type, conflict in ((c[0], c) for c in conflicts):
 
1766
        # Anything but a 'duplicate' would indicate programmer error
 
1767
        assert c_type == 'duplicate', c_type
 
1768
        # Now figure out which is new and which is old
 
1769
        if tt.new_contents(conflict[1]):
 
1770
            new_file = conflict[1]
 
1771
            old_file = conflict[2]
 
1772
        else:
 
1773
            new_file = conflict[2]
 
1774
            old_file = conflict[1]
 
1775
 
 
1776
        # We should only get here if the conflict wasn't completely
 
1777
        # resolved
 
1778
        final_parent = tt.final_parent(old_file)
 
1779
        if new_file in divert:
 
1780
            new_name = tt.final_name(old_file)+'.diverted'
 
1781
            tt.adjust_path(new_name, final_parent, new_file)
 
1782
            new_conflicts.add((c_type, 'Diverted to',
 
1783
                               new_file, old_file))
 
1784
        else:
 
1785
            new_name = tt.final_name(old_file)+'.moved'
 
1786
            tt.adjust_path(new_name, final_parent, old_file)
 
1787
            new_conflicts.add((c_type, 'Moved existing file to',
 
1788
                               old_file, new_file))
 
1789
    return new_conflicts
 
1790
 
934
1791
 
935
1792
def new_by_entry(tt, entry, parent_id, tree):
936
1793
    """Create a new file according to its inventory entry"""
941
1798
        executable = tree.is_executable(entry.file_id)
942
1799
        return tt.new_file(name, parent_id, contents, entry.file_id, 
943
1800
                           executable)
944
 
    elif kind == 'directory':
945
 
        return tt.new_directory(name, parent_id, entry.file_id)
 
1801
    elif kind in ('directory', 'tree-reference'):
 
1802
        trans_id = tt.new_directory(name, parent_id, entry.file_id)
 
1803
        if kind == 'tree-reference':
 
1804
            tt.set_tree_reference(entry.reference_revision, trans_id)
 
1805
        return trans_id 
946
1806
    elif kind == 'symlink':
947
1807
        target = tree.get_symlink_target(entry.file_id)
948
1808
        return tt.new_symlink(name, parent_id, target, entry.file_id)
 
1809
    else:
 
1810
        raise errors.BadFileKindError(name, kind)
 
1811
 
949
1812
 
950
1813
def create_by_entry(tt, entry, tree, trans_id, lines=None, mode_id=None):
951
1814
    """Create new file contents according to an inventory entry."""
952
1815
    if entry.kind == "file":
953
 
        if lines == None:
 
1816
        if lines is None:
954
1817
            lines = tree.get_file(entry.file_id).readlines()
955
1818
        tt.create_file(lines, trans_id, mode_id=mode_id)
956
1819
    elif entry.kind == "symlink":
958
1821
    elif entry.kind == "directory":
959
1822
        tt.create_directory(trans_id)
960
1823
 
 
1824
 
961
1825
def create_entry_executability(tt, entry, trans_id):
962
1826
    """Set the executability of a trans_id according to an inventory entry"""
963
1827
    if entry.kind == "file":
964
1828
        tt.set_executability(entry.executable, trans_id)
965
1829
 
966
1830
 
 
1831
@deprecated_function(zero_fifteen)
967
1832
def find_interesting(working_tree, target_tree, filenames):
968
 
    """Find the ids corresponding to specified filenames."""
969
 
    if not filenames:
970
 
        interesting_ids = None
971
 
    else:
972
 
        interesting_ids = set()
973
 
        for tree_path in filenames:
974
 
            not_found = True
975
 
            for tree in (working_tree, target_tree):
976
 
                file_id = tree.inventory.path2id(tree_path)
977
 
                if file_id is not None:
978
 
                    interesting_ids.add(file_id)
979
 
                    not_found = False
980
 
            if not_found:
981
 
                raise NotVersionedError(path=tree_path)
982
 
    return interesting_ids
983
 
 
984
 
 
 
1833
    """Find the ids corresponding to specified filenames.
 
1834
    
 
1835
    Deprecated: Please use tree1.paths2ids(filenames, [tree2]).
 
1836
    """
 
1837
    working_tree.lock_read()
 
1838
    try:
 
1839
        target_tree.lock_read()
 
1840
        try:
 
1841
            return working_tree.paths2ids(filenames, [target_tree])
 
1842
        finally:
 
1843
            target_tree.unlock()
 
1844
    finally:
 
1845
        working_tree.unlock()
 
1846
 
 
1847
 
 
1848
@deprecated_function(zero_ninety)
985
1849
def change_entry(tt, file_id, working_tree, target_tree, 
986
1850
                 trans_id_file_id, backups, trans_id, by_parent):
987
1851
    """Replace a file_id's contents with those from a target tree."""
 
1852
    if file_id is None and target_tree is None:
 
1853
        # skip the logic altogether in the deprecation test
 
1854
        return
988
1855
    e_trans_id = trans_id_file_id(file_id)
989
1856
    entry = target_tree.inventory[file_id]
990
1857
    has_contents, contents_mod, meta_mod, = _entry_changes(file_id, entry, 
1023
1890
 
1024
1891
 
1025
1892
def get_backup_name(entry, by_parent, parent_trans_id, tt):
 
1893
    return _get_backup_name(entry.name, by_parent, parent_trans_id, tt)
 
1894
 
 
1895
 
 
1896
def _get_backup_name(name, by_parent, parent_trans_id, tt):
1026
1897
    """Produce a backup-style name that appears to be available"""
1027
1898
    def name_gen():
1028
1899
        counter = 1
1029
1900
        while True:
1030
 
            yield "%s.~%d~" % (entry.name, counter)
 
1901
            yield "%s.~%d~" % (name, counter)
1031
1902
            counter += 1
1032
 
    for name in name_gen():
1033
 
        if not tt.has_named_child(by_parent, parent_trans_id, name):
1034
 
            return name
 
1903
    for new_name in name_gen():
 
1904
        if not tt.has_named_child(by_parent, parent_trans_id, new_name):
 
1905
            return new_name
 
1906
 
1035
1907
 
1036
1908
def _entry_changes(file_id, entry, working_tree):
1037
1909
    """Determine in which ways the inventory entry has changed.
1045
1917
    try:
1046
1918
        working_kind = working_tree.kind(file_id)
1047
1919
        has_contents = True
1048
 
    except OSError, e:
1049
 
        if e.errno != errno.ENOENT:
1050
 
            raise
 
1920
    except NoSuchFile:
1051
1921
        has_contents = False
1052
1922
        contents_mod = True
1053
1923
        meta_mod = False
1054
1924
    if has_contents is True:
1055
 
        real_e_kind = entry.kind
1056
 
        if real_e_kind == 'root_directory':
1057
 
            real_e_kind = 'directory'
1058
 
        if real_e_kind != working_kind:
 
1925
        if entry.kind != working_kind:
1059
1926
            contents_mod, meta_mod = True, False
1060
1927
        else:
1061
1928
            cur_entry._read_tree_state(working_tree.id2path(file_id), 
1065
1932
    return has_contents, contents_mod, meta_mod
1066
1933
 
1067
1934
 
1068
 
def revert(working_tree, target_tree, filenames, backups=False, 
1069
 
           pb=DummyProgress()):
 
1935
def revert(working_tree, target_tree, filenames, backups=False,
 
1936
           pb=DummyProgress(), change_reporter=None):
1070
1937
    """Revert a working tree's contents to those of a target tree."""
1071
 
    interesting_ids = find_interesting(working_tree, target_tree, filenames)
1072
 
    def interesting(file_id):
1073
 
        return interesting_ids is None or file_id in interesting_ids
1074
 
 
 
1938
    target_tree.lock_read()
1075
1939
    tt = TreeTransform(working_tree, pb)
1076
1940
    try:
1077
 
        merge_modified = working_tree.merge_modified()
1078
 
        trans_id = {}
1079
 
        def trans_id_file_id(file_id):
1080
 
            try:
1081
 
                return trans_id[file_id]
1082
 
            except KeyError:
1083
 
                return tt.trans_id_tree_file_id(file_id)
1084
 
 
1085
 
        pp = ProgressPhase("Revert phase", 4, pb)
1086
 
        pp.next_phase()
1087
 
        sorted_interesting = [i for i in topology_sorted_ids(target_tree) if
1088
 
                              interesting(i)]
1089
 
        child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1090
 
        try:
1091
 
            by_parent = tt.by_parent()
1092
 
            for id_num, file_id in enumerate(sorted_interesting):
1093
 
                child_pb.update("Reverting file", id_num+1, 
1094
 
                                len(sorted_interesting))
1095
 
                if file_id not in working_tree.inventory:
1096
 
                    entry = target_tree.inventory[file_id]
1097
 
                    parent_id = trans_id_file_id(entry.parent_id)
1098
 
                    e_trans_id = new_by_entry(tt, entry, parent_id, target_tree)
1099
 
                    trans_id[file_id] = e_trans_id
1100
 
                else:
1101
 
                    backup_this = backups
1102
 
                    if file_id in merge_modified:
1103
 
                        backup_this = False
1104
 
                        del merge_modified[file_id]
1105
 
                    change_entry(tt, file_id, working_tree, target_tree, 
1106
 
                                 trans_id_file_id, backup_this, trans_id,
1107
 
                                 by_parent)
1108
 
        finally:
1109
 
            child_pb.finished()
1110
 
        pp.next_phase()
1111
 
        wt_interesting = [i for i in working_tree.inventory if interesting(i)]
1112
 
        child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1113
 
        try:
1114
 
            for id_num, file_id in enumerate(wt_interesting):
1115
 
                child_pb.update("New file check", id_num+1, 
1116
 
                                len(sorted_interesting))
1117
 
                if file_id not in target_tree:
1118
 
                    trans_id = tt.trans_id_tree_file_id(file_id)
1119
 
                    tt.unversion_file(trans_id)
1120
 
                    if file_id in merge_modified:
 
1941
        pp = ProgressPhase("Revert phase", 3, pb)
 
1942
        conflicts, merge_modified = _prepare_revert_transform(
 
1943
            working_tree, target_tree, tt, filenames, backups, pp)
 
1944
        if change_reporter:
 
1945
            change_reporter = delta._ChangeReporter(
 
1946
                unversioned_filter=working_tree.is_ignored)
 
1947
            delta.report_changes(tt.iter_changes(), change_reporter)
 
1948
        for conflict in conflicts:
 
1949
            warning(conflict)
 
1950
        pp.next_phase()
 
1951
        tt.apply()
 
1952
        working_tree.set_merge_modified(merge_modified)
 
1953
    finally:
 
1954
        target_tree.unlock()
 
1955
        tt.finalize()
 
1956
        pb.clear()
 
1957
    return conflicts
 
1958
 
 
1959
 
 
1960
def _prepare_revert_transform(working_tree, target_tree, tt, filenames,
 
1961
                              backups, pp):
 
1962
    pp.next_phase()
 
1963
    child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
1964
    try:
 
1965
        merge_modified = _alter_files(working_tree, target_tree, tt,
 
1966
                                      child_pb, filenames, backups)
 
1967
    finally:
 
1968
        child_pb.finished()
 
1969
    pp.next_phase()
 
1970
    child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
1971
    try:
 
1972
        raw_conflicts = resolve_conflicts(tt, child_pb,
 
1973
            lambda t, c: conflict_pass(t, c, target_tree))
 
1974
    finally:
 
1975
        child_pb.finished()
 
1976
    conflicts = cook_conflicts(raw_conflicts, tt)
 
1977
    return conflicts, merge_modified
 
1978
 
 
1979
 
 
1980
def _alter_files(working_tree, target_tree, tt, pb, specific_files,
 
1981
                 backups):
 
1982
    merge_modified = working_tree.merge_modified()
 
1983
    change_list = target_tree.iter_changes(working_tree,
 
1984
        specific_files=specific_files, pb=pb)
 
1985
    if target_tree.inventory.root is None:
 
1986
        skip_root = True
 
1987
    else:
 
1988
        skip_root = False
 
1989
    basis_tree = None
 
1990
    try:
 
1991
        deferred_files = []
 
1992
        for id_num, (file_id, path, changed_content, versioned, parent, name,
 
1993
                kind, executable) in enumerate(change_list):
 
1994
            if skip_root and file_id[0] is not None and parent[0] is None:
 
1995
                continue
 
1996
            trans_id = tt.trans_id_file_id(file_id)
 
1997
            mode_id = None
 
1998
            if changed_content:
 
1999
                keep_content = False
 
2000
                if kind[0] == 'file' and (backups or kind[1] is None):
 
2001
                    wt_sha1 = working_tree.get_file_sha1(file_id)
 
2002
                    if merge_modified.get(file_id) != wt_sha1:
 
2003
                        # acquire the basis tree lazily to prevent the
 
2004
                        # expense of accessing it when it's not needed ?
 
2005
                        # (Guessing, RBC, 200702)
 
2006
                        if basis_tree is None:
 
2007
                            basis_tree = working_tree.basis_tree()
 
2008
                            basis_tree.lock_read()
 
2009
                        if file_id in basis_tree:
 
2010
                            if wt_sha1 != basis_tree.get_file_sha1(file_id):
 
2011
                                keep_content = True
 
2012
                        elif kind[1] is None and not versioned[1]:
 
2013
                            keep_content = True
 
2014
                if kind[0] is not None:
 
2015
                    if not keep_content:
1121
2016
                        tt.delete_contents(trans_id)
1122
 
                        del merge_modified[file_id]
1123
 
        finally:
1124
 
            child_pb.finished()
1125
 
        pp.next_phase()
1126
 
        child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1127
 
        try:
1128
 
            raw_conflicts = resolve_conflicts(tt, child_pb)
1129
 
        finally:
1130
 
            child_pb.finished()
1131
 
        conflicts = cook_conflicts(raw_conflicts, tt)
1132
 
        for conflict in conflicts:
1133
 
            warning(conflict)
1134
 
        pp.next_phase()
1135
 
        tt.apply()
1136
 
        working_tree.set_merge_modified({})
 
2017
                    elif kind[1] is not None:
 
2018
                        parent_trans_id = tt.trans_id_file_id(parent[0])
 
2019
                        by_parent = tt.by_parent()
 
2020
                        backup_name = _get_backup_name(name[0], by_parent,
 
2021
                                                       parent_trans_id, tt)
 
2022
                        tt.adjust_path(backup_name, parent_trans_id, trans_id)
 
2023
                        new_trans_id = tt.create_path(name[0], parent_trans_id)
 
2024
                        if versioned == (True, True):
 
2025
                            tt.unversion_file(trans_id)
 
2026
                            tt.version_file(file_id, new_trans_id)
 
2027
                        # New contents should have the same unix perms as old
 
2028
                        # contents
 
2029
                        mode_id = trans_id
 
2030
                        trans_id = new_trans_id
 
2031
                if kind[1] == 'directory':
 
2032
                    tt.create_directory(trans_id)
 
2033
                elif kind[1] == 'symlink':
 
2034
                    tt.create_symlink(target_tree.get_symlink_target(file_id),
 
2035
                                      trans_id)
 
2036
                elif kind[1] == 'file':
 
2037
                    deferred_files.append((file_id, (trans_id, mode_id)))
 
2038
                    if basis_tree is None:
 
2039
                        basis_tree = working_tree.basis_tree()
 
2040
                        basis_tree.lock_read()
 
2041
                    new_sha1 = target_tree.get_file_sha1(file_id)
 
2042
                    if (file_id in basis_tree and new_sha1 ==
 
2043
                        basis_tree.get_file_sha1(file_id)):
 
2044
                        if file_id in merge_modified:
 
2045
                            del merge_modified[file_id]
 
2046
                    else:
 
2047
                        merge_modified[file_id] = new_sha1
 
2048
 
 
2049
                    # preserve the execute bit when backing up
 
2050
                    if keep_content and executable[0] == executable[1]:
 
2051
                        tt.set_executability(executable[1], trans_id)
 
2052
                else:
 
2053
                    assert kind[1] is None
 
2054
            if versioned == (False, True):
 
2055
                tt.version_file(file_id, trans_id)
 
2056
            if versioned == (True, False):
 
2057
                tt.unversion_file(trans_id)
 
2058
            if (name[1] is not None and 
 
2059
                (name[0] != name[1] or parent[0] != parent[1])):
 
2060
                tt.adjust_path(
 
2061
                    name[1], tt.trans_id_file_id(parent[1]), trans_id)
 
2062
            if executable[0] != executable[1] and kind[1] == "file":
 
2063
                tt.set_executability(executable[1], trans_id)
 
2064
        for (trans_id, mode_id), bytes in target_tree.iter_files_bytes(
 
2065
            deferred_files):
 
2066
            tt.create_file(bytes, trans_id, mode_id)
1137
2067
    finally:
1138
 
        tt.finalize()
1139
 
        pb.clear()
1140
 
    return conflicts
1141
 
 
1142
 
 
1143
 
def resolve_conflicts(tt, pb=DummyProgress()):
 
2068
        if basis_tree is not None:
 
2069
            basis_tree.unlock()
 
2070
    return merge_modified
 
2071
 
 
2072
 
 
2073
def resolve_conflicts(tt, pb=DummyProgress(), pass_func=None):
1144
2074
    """Make many conflict-resolution attempts, but die if they fail"""
 
2075
    if pass_func is None:
 
2076
        pass_func = conflict_pass
1145
2077
    new_conflicts = set()
1146
2078
    try:
1147
2079
        for n in range(10):
1149
2081
            conflicts = tt.find_conflicts()
1150
2082
            if len(conflicts) == 0:
1151
2083
                return new_conflicts
1152
 
            new_conflicts.update(conflict_pass(tt, conflicts))
 
2084
            new_conflicts.update(pass_func(tt, conflicts))
1153
2085
        raise MalformedTransform(conflicts=conflicts)
1154
2086
    finally:
1155
2087
        pb.clear()
1156
2088
 
1157
2089
 
1158
 
def conflict_pass(tt, conflicts):
1159
 
    """Resolve some classes of conflicts."""
 
2090
def conflict_pass(tt, conflicts, path_tree=None):
 
2091
    """Resolve some classes of conflicts.
 
2092
 
 
2093
    :param tt: The transform to resolve conflicts in
 
2094
    :param conflicts: The conflicts to resolve
 
2095
    :param path_tree: A Tree to get supplemental paths from
 
2096
    """
1160
2097
    new_conflicts = set()
1161
2098
    for c_type, conflict in ((c[0], c) for c in conflicts):
1162
2099
        if c_type == 'duplicate id':
1165
2102
                               conflict[1], conflict[2], ))
1166
2103
        elif c_type == 'duplicate':
1167
2104
            # files that were renamed take precedence
1168
 
            new_name = tt.final_name(conflict[1])+'.moved'
1169
2105
            final_parent = tt.final_parent(conflict[1])
1170
2106
            if tt.path_changed(conflict[1]):
1171
 
                tt.adjust_path(new_name, final_parent, conflict[2])
1172
 
                new_conflicts.add((c_type, 'Moved existing file to', 
1173
 
                                   conflict[2], conflict[1]))
 
2107
                existing_file, new_file = conflict[2], conflict[1]
1174
2108
            else:
1175
 
                tt.adjust_path(new_name, final_parent, conflict[1])
1176
 
                new_conflicts.add((c_type, 'Moved existing file to', 
1177
 
                                  conflict[1], conflict[2]))
 
2109
                existing_file, new_file = conflict[1], conflict[2]
 
2110
            new_name = tt.final_name(existing_file)+'.moved'
 
2111
            tt.adjust_path(new_name, final_parent, existing_file)
 
2112
            new_conflicts.add((c_type, 'Moved existing file to', 
 
2113
                               existing_file, new_file))
1178
2114
        elif c_type == 'parent loop':
1179
2115
            # break the loop by undoing one of the ops that caused the loop
1180
2116
            cur = conflict[1]
1188
2124
            trans_id = conflict[1]
1189
2125
            try:
1190
2126
                tt.cancel_deletion(trans_id)
1191
 
                new_conflicts.add((c_type, 'Not deleting', trans_id))
 
2127
                new_conflicts.add(('deleting parent', 'Not deleting', 
 
2128
                                   trans_id))
1192
2129
            except KeyError:
1193
 
                tt.create_directory(trans_id)
1194
 
                new_conflicts.add((c_type, 'Created directory.', trans_id))
 
2130
                create = True
 
2131
                try:
 
2132
                    tt.final_name(trans_id)
 
2133
                except NoFinalPath:
 
2134
                    if path_tree is not None:
 
2135
                        file_id = tt.final_file_id(trans_id)
 
2136
                        if file_id is None:
 
2137
                            file_id = tt.inactive_file_id(trans_id)
 
2138
                        entry = path_tree.inventory[file_id]
 
2139
                        # special-case the other tree root (move its
 
2140
                        # children to current root)
 
2141
                        if entry.parent_id is None:
 
2142
                            create=False
 
2143
                            moved = _reparent_transform_children(
 
2144
                                tt, trans_id, tt.root)
 
2145
                            for child in moved:
 
2146
                                new_conflicts.add((c_type, 'Moved to root',
 
2147
                                                   child))
 
2148
                        else:
 
2149
                            parent_trans_id = tt.trans_id_file_id(
 
2150
                                entry.parent_id)
 
2151
                            tt.adjust_path(entry.name, parent_trans_id,
 
2152
                                           trans_id)
 
2153
                if create:
 
2154
                    tt.create_directory(trans_id)
 
2155
                    new_conflicts.add((c_type, 'Created directory', trans_id))
1195
2156
        elif c_type == 'unversioned parent':
1196
 
            tt.version_file(tt.inactive_file_id(conflict[1]), conflict[1])
 
2157
            file_id = tt.inactive_file_id(conflict[1])
 
2158
            # special-case the other tree root (move its children instead)
 
2159
            if path_tree and file_id in path_tree:
 
2160
                if path_tree.inventory[file_id].parent_id is None:
 
2161
                    continue
 
2162
            tt.version_file(file_id, conflict[1])
1197
2163
            new_conflicts.add((c_type, 'Versioned directory', conflict[1]))
 
2164
        elif c_type == 'non-directory parent':
 
2165
            parent_id = conflict[1]
 
2166
            parent_parent = tt.final_parent(parent_id)
 
2167
            parent_name = tt.final_name(parent_id)
 
2168
            parent_file_id = tt.final_file_id(parent_id)
 
2169
            new_parent_id = tt.new_directory(parent_name + '.new',
 
2170
                parent_parent, parent_file_id)
 
2171
            _reparent_transform_children(tt, parent_id, new_parent_id)
 
2172
            if parent_file_id is not None:
 
2173
                tt.unversion_file(parent_id)
 
2174
            new_conflicts.add((c_type, 'Created directory', new_parent_id))
1198
2175
    return new_conflicts
1199
2176
 
 
2177
 
1200
2178
def cook_conflicts(raw_conflicts, tt):
1201
2179
    """Generate a list of cooked conflicts, sorted by file path"""
1202
 
    def key(conflict):
1203
 
        if conflict.path is not None:
1204
 
            return conflict.path, conflict.typestring
1205
 
        elif getattr(conflict, "conflict_path", None) is not None:
1206
 
            return conflict.conflict_path, conflict.typestring
1207
 
        else:
1208
 
            return None, conflict.typestring
 
2180
    from bzrlib.conflicts import Conflict
 
2181
    conflict_iter = iter_cook_conflicts(raw_conflicts, tt)
 
2182
    return sorted(conflict_iter, key=Conflict.sort_key)
1209
2183
 
1210
 
    return sorted(list(iter_cook_conflicts(raw_conflicts, tt)), key=key)
1211
2184
 
1212
2185
def iter_cook_conflicts(raw_conflicts, tt):
1213
2186
    from bzrlib.conflicts import Conflict
1228
2201
                                   file_id=modified_id, 
1229
2202
                                   conflict_path=conflicting_path,
1230
2203
                                   conflict_file_id=conflicting_id)
 
2204
 
 
2205
 
 
2206
class _FileMover(object):
 
2207
    """Moves and deletes files for TreeTransform, tracking operations"""
 
2208
 
 
2209
    def __init__(self):
 
2210
        self.past_renames = []
 
2211
        self.pending_deletions = []
 
2212
 
 
2213
    def rename(self, from_, to):
 
2214
        """Rename a file from one path to another.  Functions like os.rename"""
 
2215
        try:
 
2216
            os.rename(from_, to)
 
2217
        except OSError, e:
 
2218
            if e.errno in (errno.EEXIST, errno.ENOTEMPTY):
 
2219
                raise errors.FileExists(to, str(e))
 
2220
            raise
 
2221
        self.past_renames.append((from_, to))
 
2222
 
 
2223
    def pre_delete(self, from_, to):
 
2224
        """Rename a file out of the way and mark it for deletion.
 
2225
 
 
2226
        Unlike os.unlink, this works equally well for files and directories.
 
2227
        :param from_: The current file path
 
2228
        :param to: A temporary path for the file
 
2229
        """
 
2230
        self.rename(from_, to)
 
2231
        self.pending_deletions.append(to)
 
2232
 
 
2233
    def rollback(self):
 
2234
        """Reverse all renames that have been performed"""
 
2235
        for from_, to in reversed(self.past_renames):
 
2236
            os.rename(to, from_)
 
2237
        # after rollback, don't reuse _FileMover
 
2238
        past_renames = None
 
2239
        pending_deletions = None
 
2240
 
 
2241
    def apply_deletions(self):
 
2242
        """Apply all marked deletions"""
 
2243
        for path in self.pending_deletions:
 
2244
            delete_any(path)
 
2245
        # after apply_deletions, don't reuse _FileMover
 
2246
        past_renames = None
 
2247
        pending_deletions = None