/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-06-05 03:02:10 UTC
  • mfrom: (3472.1.1 ianc-integration)
  • Revision ID: pqm@pqm.ubuntu.com-20080605030210-xwokghqkg4sqo1xy
Isolate the test HTTPServer from chdir calls (Robert Collins)

Show diffs side-by-side

added added

removed removed

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