/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-10 10:53:50 UTC
  • mfrom: (3297.4.4 smart-set-revision-info)
  • Revision ID: pqm@pqm.ubuntu.com-20080410105350-e0c4d8n5hqgzqzi7
Add Branch.set_last_revision_info smart request. (Andrew Bennetts)

Show diffs side-by-side

added added

removed removed

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