/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-18 02:15:53 UTC
  • mfrom: (3497.3.3 trivial)
  • Revision ID: pqm@pqm.ubuntu.com-20080618021553-nptumo40ezmv5ksr
(mbp) better messages about missing libraries

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
 
331
450
        del self._new_id[trans_id]
332
451
        del self._r_new_id[file_id]
333
452
 
334
 
    def new_paths(self):
335
 
        """Determine the paths of all new and changed files"""
 
453
    def new_paths(self, filesystem_only=False):
 
454
        """Determine the paths of all new and changed files.
 
455
 
 
456
        :param filesystem_only: if True, only calculate values for files
 
457
            that require renames or execute bit changes.
 
458
        """
336
459
        new_ids = set()
337
 
        fp = FinalPaths(self)
338
 
        for id_set in (self._new_name, self._new_parent, self._new_contents,
339
 
                       self._new_id, self._new_executability):
 
460
        if filesystem_only:
 
461
            id_sets = (self._needs_rename, self._new_executability)
 
462
        else:
 
463
            id_sets = (self._new_name, self._new_parent, self._new_contents,
 
464
                       self._new_id, self._new_executability)
 
465
        for id_set in id_sets:
340
466
            new_ids.update(id_set)
341
 
        new_paths = [(fp.get_path(t), t) for t in new_ids]
342
 
        new_paths.sort()
343
 
        return new_paths
 
467
        return sorted(FinalPaths(self).get_paths(new_ids))
344
468
 
345
469
    def tree_kind(self, trans_id):
346
470
        """Determine the file kind in the working tree.
381
505
            return None
382
506
        # the file is old; the old id is still valid
383
507
        if self._new_root == trans_id:
384
 
            return self._tree.inventory.root.file_id
 
508
            return self._tree.get_root_id()
385
509
        return self._tree.inventory.path2id(path)
386
510
 
387
511
    def final_file_id(self, trans_id):
391
515
        applied.
392
516
        """
393
517
        try:
394
 
            # there is a new id for this file
395
 
            assert self._new_id[trans_id] is not None
396
518
            return self._new_id[trans_id]
397
519
        except KeyError:
398
520
            if trans_id in self._removed_id:
426
548
        try:
427
549
            return self._new_name[trans_id]
428
550
        except KeyError:
429
 
            return os.path.basename(self._tree_id_paths[trans_id])
 
551
            try:
 
552
                return os.path.basename(self._tree_id_paths[trans_id])
 
553
            except KeyError:
 
554
                raise NoFinalPath(trans_id, self)
430
555
 
431
556
    def by_parent(self):
432
557
        """Return a map of parent: children for known parents.
445
570
 
446
571
    def path_changed(self, trans_id):
447
572
        """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
 
573
        return (trans_id in self._new_name) or (trans_id in self._new_parent)
 
574
 
 
575
    def new_contents(self, trans_id):
 
576
        return (trans_id in self._new_contents)
449
577
 
450
578
    def find_conflicts(self):
451
579
        """Find any violations of inventory or filesystem invariants"""
452
 
        if self.__done is True:
 
580
        if self._done is True:
453
581
            raise ReusingTransform()
454
582
        conflicts = []
455
583
        # ensure all children of all existent parents are known
477
605
                        self.tree_kind(t) == 'directory'])
478
606
        for trans_id in self._removed_id:
479
607
            file_id = self.tree_file_id(trans_id)
480
 
            if self._tree.inventory[file_id].kind in ('directory', 
481
 
                                                      'root_directory'):
 
608
            if file_id is not None:
 
609
                if self._tree.inventory[file_id].kind == 'directory':
 
610
                    parents.append(trans_id)
 
611
            elif self.tree_kind(trans_id) == 'directory':
482
612
                parents.append(trans_id)
483
613
 
484
614
        for parent_id in parents:
494
624
        try:
495
625
            children = os.listdir(self._tree.abspath(path))
496
626
        except OSError, e:
497
 
            if e.errno != errno.ENOENT and e.errno != errno.ESRCH:
 
627
            if e.errno not in (errno.ENOENT, errno.ESRCH, errno.ENOTDIR):
498
628
                raise
499
629
            return
500
630
            
521
651
        if child_id is None:
522
652
            return lexists(self._tree.abspath(childpath))
523
653
        else:
524
 
            if tt.final_parent(child_id) != parent_id:
 
654
            if self.final_parent(child_id) != parent_id:
525
655
                return False
526
 
            if child_id in tt._removed_contents:
 
656
            if child_id in self._removed_contents:
527
657
                # XXX What about dangling file-ids?
528
658
                return False
529
659
            else:
537
667
            parent_id = trans_id
538
668
            while parent_id is not ROOT_PARENT:
539
669
                seen.add(parent_id)
540
 
                parent_id = self.final_parent(parent_id)
 
670
                try:
 
671
                    parent_id = self.final_parent(parent_id)
 
672
                except KeyError:
 
673
                    break
541
674
                if parent_id == trans_id:
542
675
                    conflicts.append(('parent loop', trans_id))
543
676
                if parent_id in seen:
611
744
    def _duplicate_entries(self, by_parent):
612
745
        """No directory may have two entries with the same name."""
613
746
        conflicts = []
 
747
        if (self._new_name, self._new_parent) == ({}, {}):
 
748
            return conflicts
614
749
        for children in by_parent.itervalues():
615
750
            name_ids = [(self.final_name(t), t) for t in children]
 
751
            if not self._case_sensitive_target:
 
752
                name_ids = [(n.lower(), t) for n, t in name_ids]
616
753
            name_ids.sort()
617
754
            last_name = None
618
755
            last_trans_id = None
619
756
            for name, trans_id in name_ids:
 
757
                try:
 
758
                    kind = self.final_kind(trans_id)
 
759
                except NoSuchFile:
 
760
                    kind = None
 
761
                file_id = self.final_file_id(trans_id)
 
762
                if kind is None and file_id is None:
 
763
                    continue
620
764
                if name == last_name:
621
765
                    conflicts.append(('duplicate', last_trans_id, trans_id,
622
766
                    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
 
767
                last_name = name
 
768
                last_trans_id = trans_id
631
769
        return conflicts
632
770
 
633
771
    def _duplicate_ids(self):
635
773
        conflicts = []
636
774
        removed_tree_ids = set((self.tree_file_id(trans_id) for trans_id in
637
775
                                self._removed_id))
638
 
        active_tree_ids = set((f for f in self._tree.inventory if
639
 
                               f not in removed_tree_ids))
 
776
        all_ids = self._tree.all_file_ids()
 
777
        active_tree_ids = all_ids.difference(removed_tree_ids)
640
778
        for trans_id, file_id in self._new_id.iteritems():
641
779
            if file_id in active_tree_ids:
642
780
                old_trans_id = self.trans_id_tree_file_id(file_id)
675
813
                continue
676
814
            return True
677
815
        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
816
 
703
817
    def _limbo_name(self, trans_id):
704
818
        """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
 
819
        limbo_name = self._limbo_files.get(trans_id)
 
820
        if limbo_name is not None:
 
821
            return limbo_name
 
822
        parent = self._new_parent.get(trans_id)
 
823
        # if the parent directory is already in limbo (e.g. when building a
 
824
        # tree), choose a limbo name inside the parent, to reduce further
 
825
        # renames.
 
826
        use_direct_path = False
 
827
        if self._new_contents.get(parent) == 'directory':
 
828
            filename = self._new_name.get(trans_id)
 
829
            if filename is not None:
 
830
                if parent not in self._limbo_children:
 
831
                    self._limbo_children[parent] = set()
 
832
                    self._limbo_children_names[parent] = {}
 
833
                    use_direct_path = True
 
834
                # the direct path can only be used if no other file has
 
835
                # already taken this pathname, i.e. if the name is unused, or
 
836
                # if it is already associated with this trans_id.
 
837
                elif self._case_sensitive_target:
 
838
                    if (self._limbo_children_names[parent].get(filename)
 
839
                        in (trans_id, None)):
 
840
                        use_direct_path = True
 
841
                else:
 
842
                    for l_filename, l_trans_id in\
 
843
                        self._limbo_children_names[parent].iteritems():
 
844
                        if l_trans_id == trans_id:
 
845
                            continue
 
846
                        if l_filename.lower() == filename.lower():
 
847
                            break
734
848
                    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):
 
849
                        use_direct_path = True
 
850
 
 
851
        if use_direct_path:
 
852
            limbo_name = pathjoin(self._limbo_files[parent], filename)
 
853
            self._limbo_children[parent].add(trans_id)
 
854
            self._limbo_children_names[parent][filename] = trans_id
 
855
        else:
 
856
            limbo_name = pathjoin(self._limbodir, trans_id)
 
857
            self._needs_rename.add(trans_id)
 
858
        self._limbo_files[trans_id] = limbo_name
 
859
        return limbo_name
 
860
 
 
861
    def _set_executability(self, path, entry, trans_id):
797
862
        """Set the executability of versioned files """
798
 
        file_id = inv.path2id(path)
799
863
        new_executability = self._new_executability[trans_id]
800
 
        inv[file_id].executable = new_executability
 
864
        if entry is not None:
 
865
            entry.executable = new_executability
801
866
        if supports_executable():
802
867
            abspath = self._tree.abspath(path)
803
868
            current_mode = os.stat(abspath).st_mode
829
894
        parent_id is the transaction id of the parent directory of the file.
830
895
        contents is an iterator of bytestrings, which will be used to produce
831
896
        the file.
832
 
        file_id is the inventory ID of the file, if it is to be versioned.
 
897
        :param file_id: The inventory ID of the file, if it is to be versioned.
 
898
        :param executable: Only valid when a file_id has been supplied.
833
899
        """
834
900
        trans_id = self._new_entry(name, parent_id, file_id)
 
901
        # TODO: rather than scheduling a set_executable call,
 
902
        # have create_file create the file with the right mode.
835
903
        self.create_file(contents, trans_id)
836
904
        if executable is not None:
837
905
            self.set_executability(executable, trans_id)
861
929
        self.create_symlink(target, trans_id)
862
930
        return trans_id
863
931
 
 
932
    def _affected_ids(self):
 
933
        """Return the set of transform ids affected by the transform"""
 
934
        trans_ids = set(self._removed_id)
 
935
        trans_ids.update(self._new_id.keys())
 
936
        trans_ids.update(self._removed_contents)
 
937
        trans_ids.update(self._new_contents.keys())
 
938
        trans_ids.update(self._new_executability.keys())
 
939
        trans_ids.update(self._new_name.keys())
 
940
        trans_ids.update(self._new_parent.keys())
 
941
        return trans_ids
 
942
 
 
943
    def _get_file_id_maps(self):
 
944
        """Return mapping of file_ids to trans_ids in the to and from states"""
 
945
        trans_ids = self._affected_ids()
 
946
        from_trans_ids = {}
 
947
        to_trans_ids = {}
 
948
        # Build up two dicts: trans_ids associated with file ids in the
 
949
        # FROM state, vs the TO state.
 
950
        for trans_id in trans_ids:
 
951
            from_file_id = self.tree_file_id(trans_id)
 
952
            if from_file_id is not None:
 
953
                from_trans_ids[from_file_id] = trans_id
 
954
            to_file_id = self.final_file_id(trans_id)
 
955
            if to_file_id is not None:
 
956
                to_trans_ids[to_file_id] = trans_id
 
957
        return from_trans_ids, to_trans_ids
 
958
 
 
959
    def _from_file_data(self, from_trans_id, from_versioned, file_id):
 
960
        """Get data about a file in the from (tree) state
 
961
 
 
962
        Return a (name, parent, kind, executable) tuple
 
963
        """
 
964
        from_path = self._tree_id_paths.get(from_trans_id)
 
965
        if from_versioned:
 
966
            # get data from working tree if versioned
 
967
            from_entry = self._tree.inventory[file_id]
 
968
            from_name = from_entry.name
 
969
            from_parent = from_entry.parent_id
 
970
        else:
 
971
            from_entry = None
 
972
            if from_path is None:
 
973
                # File does not exist in FROM state
 
974
                from_name = None
 
975
                from_parent = None
 
976
            else:
 
977
                # File exists, but is not versioned.  Have to use path-
 
978
                # splitting stuff
 
979
                from_name = os.path.basename(from_path)
 
980
                tree_parent = self.get_tree_parent(from_trans_id)
 
981
                from_parent = self.tree_file_id(tree_parent)
 
982
        if from_path is not None:
 
983
            from_kind, from_executable, from_stats = \
 
984
                self._tree._comparison_data(from_entry, from_path)
 
985
        else:
 
986
            from_kind = None
 
987
            from_executable = False
 
988
        return from_name, from_parent, from_kind, from_executable
 
989
 
 
990
    def _to_file_data(self, to_trans_id, from_trans_id, from_executable):
 
991
        """Get data about a file in the to (target) state
 
992
 
 
993
        Return a (name, parent, kind, executable) tuple
 
994
        """
 
995
        to_name = self.final_name(to_trans_id)
 
996
        try:
 
997
            to_kind = self.final_kind(to_trans_id)
 
998
        except NoSuchFile:
 
999
            to_kind = None
 
1000
        to_parent = self.final_file_id(self.final_parent(to_trans_id))
 
1001
        if to_trans_id in self._new_executability:
 
1002
            to_executable = self._new_executability[to_trans_id]
 
1003
        elif to_trans_id == from_trans_id:
 
1004
            to_executable = from_executable
 
1005
        else:
 
1006
            to_executable = False
 
1007
        return to_name, to_parent, to_kind, to_executable
 
1008
 
 
1009
    def iter_changes(self):
 
1010
        """Produce output in the same format as Tree.iter_changes.
 
1011
 
 
1012
        Will produce nonsensical results if invoked while inventory/filesystem
 
1013
        conflicts (as reported by TreeTransform.find_conflicts()) are present.
 
1014
 
 
1015
        This reads the Transform, but only reproduces changes involving a
 
1016
        file_id.  Files that are not versioned in either of the FROM or TO
 
1017
        states are not reflected.
 
1018
        """
 
1019
        final_paths = FinalPaths(self)
 
1020
        from_trans_ids, to_trans_ids = self._get_file_id_maps()
 
1021
        results = []
 
1022
        # Now iterate through all active file_ids
 
1023
        for file_id in set(from_trans_ids.keys() + to_trans_ids.keys()):
 
1024
            modified = False
 
1025
            from_trans_id = from_trans_ids.get(file_id)
 
1026
            # find file ids, and determine versioning state
 
1027
            if from_trans_id is None:
 
1028
                from_versioned = False
 
1029
                from_trans_id = to_trans_ids[file_id]
 
1030
            else:
 
1031
                from_versioned = True
 
1032
            to_trans_id = to_trans_ids.get(file_id)
 
1033
            if to_trans_id is None:
 
1034
                to_versioned = False
 
1035
                to_trans_id = from_trans_id
 
1036
            else:
 
1037
                to_versioned = True
 
1038
 
 
1039
            from_name, from_parent, from_kind, from_executable = \
 
1040
                self._from_file_data(from_trans_id, from_versioned, file_id)
 
1041
 
 
1042
            to_name, to_parent, to_kind, to_executable = \
 
1043
                self._to_file_data(to_trans_id, from_trans_id, from_executable)
 
1044
 
 
1045
            if not from_versioned:
 
1046
                from_path = None
 
1047
            else:
 
1048
                from_path = self._tree_id_paths.get(from_trans_id)
 
1049
            if not to_versioned:
 
1050
                to_path = None
 
1051
            else:
 
1052
                to_path = final_paths.get_path(to_trans_id)
 
1053
            if from_kind != to_kind:
 
1054
                modified = True
 
1055
            elif to_kind in ('file', 'symlink') and (
 
1056
                to_trans_id != from_trans_id or
 
1057
                to_trans_id in self._new_contents):
 
1058
                modified = True
 
1059
            if (not modified and from_versioned == to_versioned and
 
1060
                from_parent==to_parent and from_name == to_name and
 
1061
                from_executable == to_executable):
 
1062
                continue
 
1063
            results.append((file_id, (from_path, to_path), modified,
 
1064
                   (from_versioned, to_versioned),
 
1065
                   (from_parent, to_parent),
 
1066
                   (from_name, to_name),
 
1067
                   (from_kind, to_kind),
 
1068
                   (from_executable, to_executable)))
 
1069
        return iter(sorted(results, key=lambda x:x[1]))
 
1070
 
 
1071
    def get_preview_tree(self):
 
1072
        """Return a tree representing the result of the transform.
 
1073
 
 
1074
        This tree only supports the subset of Tree functionality required
 
1075
        by show_diff_trees.  It must only be compared to tt._tree.
 
1076
        """
 
1077
        return _PreviewTree(self)
 
1078
 
 
1079
 
 
1080
class TreeTransform(TreeTransformBase):
 
1081
    """Represent a tree transformation.
 
1082
 
 
1083
    This object is designed to support incremental generation of the transform,
 
1084
    in any order.
 
1085
 
 
1086
    However, it gives optimum performance when parent directories are created
 
1087
    before their contents.  The transform is then able to put child files
 
1088
    directly in their parent directory, avoiding later renames.
 
1089
 
 
1090
    It is easy to produce malformed transforms, but they are generally
 
1091
    harmless.  Attempting to apply a malformed transform will cause an
 
1092
    exception to be raised before any modifications are made to the tree.
 
1093
 
 
1094
    Many kinds of malformed transforms can be corrected with the
 
1095
    resolve_conflicts function.  The remaining ones indicate programming error,
 
1096
    such as trying to create a file with no path.
 
1097
 
 
1098
    Two sets of file creation methods are supplied.  Convenience methods are:
 
1099
     * new_file
 
1100
     * new_directory
 
1101
     * new_symlink
 
1102
 
 
1103
    These are composed of the low-level methods:
 
1104
     * create_path
 
1105
     * create_file or create_directory or create_symlink
 
1106
     * version_file
 
1107
     * set_executability
 
1108
 
 
1109
    Transform/Transaction ids
 
1110
    -------------------------
 
1111
    trans_ids are temporary ids assigned to all files involved in a transform.
 
1112
    It's possible, even common, that not all files in the Tree have trans_ids.
 
1113
 
 
1114
    trans_ids are used because filenames and file_ids are not good enough
 
1115
    identifiers; filenames change, and not all files have file_ids.  File-ids
 
1116
    are also associated with trans-ids, so that moving a file moves its
 
1117
    file-id.
 
1118
 
 
1119
    trans_ids are only valid for the TreeTransform that generated them.
 
1120
 
 
1121
    Limbo
 
1122
    -----
 
1123
    Limbo is a temporary directory use to hold new versions of files.
 
1124
    Files are added to limbo by create_file, create_directory, create_symlink,
 
1125
    and their convenience variants (new_*).  Files may be removed from limbo
 
1126
    using cancel_creation.  Files are renamed from limbo into their final
 
1127
    location as part of TreeTransform.apply
 
1128
 
 
1129
    Limbo must be cleaned up, by either calling TreeTransform.apply or
 
1130
    calling TreeTransform.finalize.
 
1131
 
 
1132
    Files are placed into limbo inside their parent directories, where
 
1133
    possible.  This reduces subsequent renames, and makes operations involving
 
1134
    lots of files faster.  This optimization is only possible if the parent
 
1135
    directory is created *before* creating any of its children, so avoid
 
1136
    creating children before parents, where possible.
 
1137
 
 
1138
    Pending-deletion
 
1139
    ----------------
 
1140
    This temporary directory is used by _FileMover for storing files that are
 
1141
    about to be deleted.  In case of rollback, the files will be restored.
 
1142
    FileMover does not delete files until it is sure that a rollback will not
 
1143
    happen.
 
1144
    """
 
1145
    def __init__(self, tree, pb=DummyProgress()):
 
1146
        """Note: a tree_write lock is taken on the tree.
 
1147
 
 
1148
        Use TreeTransform.finalize() to release the lock (can be omitted if
 
1149
        TreeTransform.apply() called).
 
1150
        """
 
1151
        tree.lock_tree_write()
 
1152
 
 
1153
        try:
 
1154
            limbodir = urlutils.local_path_from_url(
 
1155
                tree._transport.abspath('limbo'))
 
1156
            try:
 
1157
                os.mkdir(limbodir)
 
1158
            except OSError, e:
 
1159
                if e.errno == errno.EEXIST:
 
1160
                    raise ExistingLimbo(limbodir)
 
1161
            deletiondir = urlutils.local_path_from_url(
 
1162
                tree._transport.abspath('pending-deletion'))
 
1163
            try:
 
1164
                os.mkdir(deletiondir)
 
1165
            except OSError, e:
 
1166
                if e.errno == errno.EEXIST:
 
1167
                    raise errors.ExistingPendingDeletion(deletiondir)
 
1168
        except:
 
1169
            tree.unlock()
 
1170
            raise
 
1171
 
 
1172
        TreeTransformBase.__init__(self, tree, limbodir, pb,
 
1173
                                   tree.case_sensitive)
 
1174
        self._deletiondir = deletiondir
 
1175
 
 
1176
    def apply(self, no_conflicts=False, precomputed_delta=None, _mover=None):
 
1177
        """Apply all changes to the inventory and filesystem.
 
1178
 
 
1179
        If filesystem or inventory conflicts are present, MalformedTransform
 
1180
        will be thrown.
 
1181
 
 
1182
        If apply succeeds, finalize is not necessary.
 
1183
 
 
1184
        :param no_conflicts: if True, the caller guarantees there are no
 
1185
            conflicts, so no check is made.
 
1186
        :param precomputed_delta: An inventory delta to use instead of
 
1187
            calculating one.
 
1188
        :param _mover: Supply an alternate FileMover, for testing
 
1189
        """
 
1190
        if not no_conflicts:
 
1191
            conflicts = self.find_conflicts()
 
1192
            if len(conflicts) != 0:
 
1193
                raise MalformedTransform(conflicts=conflicts)
 
1194
        if precomputed_delta is None:
 
1195
            new_inventory_delta = []
 
1196
            inventory_delta = new_inventory_delta
 
1197
        else:
 
1198
            new_inventory_delta = None
 
1199
            inventory_delta = precomputed_delta
 
1200
        child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
1201
        try:
 
1202
            if _mover is None:
 
1203
                mover = _FileMover()
 
1204
            else:
 
1205
                mover = _mover
 
1206
            try:
 
1207
                child_pb.update('Apply phase', 0, 2)
 
1208
                self._apply_removals(new_inventory_delta, mover)
 
1209
                child_pb.update('Apply phase', 1, 2)
 
1210
                modified_paths = self._apply_insertions(new_inventory_delta,
 
1211
                                                        mover)
 
1212
            except:
 
1213
                mover.rollback()
 
1214
                raise
 
1215
            else:
 
1216
                mover.apply_deletions()
 
1217
        finally:
 
1218
            child_pb.finished()
 
1219
        self._tree.apply_inventory_delta(inventory_delta)
 
1220
        self._done = True
 
1221
        self.finalize()
 
1222
        return _TransformResults(modified_paths, self.rename_count)
 
1223
 
 
1224
    def _apply_removals(self, inventory_delta, mover):
 
1225
        """Perform tree operations that remove directory/inventory names.
 
1226
 
 
1227
        That is, delete files that are to be deleted, and put any files that
 
1228
        need renaming into limbo.  This must be done in strict child-to-parent
 
1229
        order.
 
1230
 
 
1231
        If inventory_delta is None, no inventory delta generation is performed.
 
1232
        """
 
1233
        tree_paths = list(self._tree_path_ids.iteritems())
 
1234
        tree_paths.sort(reverse=True)
 
1235
        child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
1236
        try:
 
1237
            for num, data in enumerate(tree_paths):
 
1238
                path, trans_id = data
 
1239
                child_pb.update('removing file', num, len(tree_paths))
 
1240
                full_path = self._tree.abspath(path)
 
1241
                if trans_id in self._removed_contents:
 
1242
                    mover.pre_delete(full_path, os.path.join(self._deletiondir,
 
1243
                                     trans_id))
 
1244
                elif trans_id in self._new_name or trans_id in \
 
1245
                    self._new_parent:
 
1246
                    try:
 
1247
                        mover.rename(full_path, self._limbo_name(trans_id))
 
1248
                    except OSError, e:
 
1249
                        if e.errno != errno.ENOENT:
 
1250
                            raise
 
1251
                    else:
 
1252
                        self.rename_count += 1
 
1253
                if (trans_id in self._removed_id
 
1254
                    and inventory_delta is not None):
 
1255
                    if trans_id == self._new_root:
 
1256
                        file_id = self._tree.get_root_id()
 
1257
                    else:
 
1258
                        file_id = self.tree_file_id(trans_id)
 
1259
                    # File-id isn't really being deleted, just moved
 
1260
                    if file_id in self._r_new_id:
 
1261
                        continue
 
1262
                    inventory_delta.append((path, None, file_id, None))
 
1263
        finally:
 
1264
            child_pb.finished()
 
1265
 
 
1266
    def _apply_insertions(self, inventory_delta, mover):
 
1267
        """Perform tree operations that insert directory/inventory names.
 
1268
 
 
1269
        That is, create any files that need to be created, and restore from
 
1270
        limbo any files that needed renaming.  This must be done in strict
 
1271
        parent-to-child order.
 
1272
 
 
1273
        If inventory_delta is None, no inventory delta is calculated, and
 
1274
        no list of modified paths is returned.
 
1275
        """
 
1276
        new_paths = self.new_paths(filesystem_only=(inventory_delta is None))
 
1277
        modified_paths = []
 
1278
        completed_new = []
 
1279
        new_path_file_ids = dict((t, self.final_file_id(t)) for p, t in
 
1280
                                 new_paths)
 
1281
        if inventory_delta is not None:
 
1282
            entries = self._tree.iter_entries_by_dir(
 
1283
                new_path_file_ids.values())
 
1284
            old_paths = dict((e.file_id, p) for p, e in entries)
 
1285
        child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
1286
        try:
 
1287
            for num, (path, trans_id) in enumerate(new_paths):
 
1288
                new_entry = None
 
1289
                if (num % 10) == 0:
 
1290
                    child_pb.update('adding file', num, len(new_paths))
 
1291
                full_path = self._tree.abspath(path)
 
1292
                if trans_id in self._needs_rename:
 
1293
                    try:
 
1294
                        mover.rename(self._limbo_name(trans_id), full_path)
 
1295
                    except OSError, e:
 
1296
                        # We may be renaming a dangling inventory id
 
1297
                        if e.errno != errno.ENOENT:
 
1298
                            raise
 
1299
                    else:
 
1300
                        self.rename_count += 1
 
1301
                if inventory_delta is not None:
 
1302
                    if (trans_id in self._new_contents or
 
1303
                        self.path_changed(trans_id)):
 
1304
                        if trans_id in self._new_contents:
 
1305
                            modified_paths.append(full_path)
 
1306
                            completed_new.append(trans_id)
 
1307
                    file_id = new_path_file_ids[trans_id]
 
1308
                    if file_id is not None and (trans_id in self._new_id or
 
1309
                        trans_id in self._new_name or
 
1310
                        trans_id in self._new_parent
 
1311
                        or trans_id in self._new_executability):
 
1312
                        try:
 
1313
                            kind = self.final_kind(trans_id)
 
1314
                        except NoSuchFile:
 
1315
                            kind = self._tree.stored_kind(file_id)
 
1316
                        parent_trans_id = self.final_parent(trans_id)
 
1317
                        parent_file_id = new_path_file_ids.get(parent_trans_id)
 
1318
                        if parent_file_id is None:
 
1319
                            parent_file_id = self.final_file_id(
 
1320
                                parent_trans_id)
 
1321
                        if trans_id in self._new_reference_revision:
 
1322
                            new_entry = inventory.TreeReference(
 
1323
                                file_id,
 
1324
                                self._new_name[trans_id],
 
1325
                                self.final_file_id(self._new_parent[trans_id]),
 
1326
                                None, self._new_reference_revision[trans_id])
 
1327
                        else:
 
1328
                            new_entry = inventory.make_entry(kind,
 
1329
                                self.final_name(trans_id),
 
1330
                                parent_file_id, file_id)
 
1331
                        old_path = old_paths.get(new_entry.file_id)
 
1332
                        inventory_delta.append(
 
1333
                            (old_path, path, new_entry.file_id, new_entry))
 
1334
 
 
1335
                if trans_id in self._new_executability:
 
1336
                    self._set_executability(path, new_entry, trans_id)
 
1337
        finally:
 
1338
            child_pb.finished()
 
1339
        if inventory_delta is None:
 
1340
            self._new_contents.clear()
 
1341
        else:
 
1342
            for trans_id in completed_new:
 
1343
                del self._new_contents[trans_id]
 
1344
        return modified_paths
 
1345
 
 
1346
 
 
1347
class TransformPreview(TreeTransformBase):
 
1348
    """A TreeTransform for generating preview trees.
 
1349
 
 
1350
    Unlike TreeTransform, this version works when the input tree is a
 
1351
    RevisionTree, rather than a WorkingTree.  As a result, it tends to ignore
 
1352
    unversioned files in the input tree.
 
1353
    """
 
1354
 
 
1355
    def __init__(self, tree, pb=DummyProgress(), case_sensitive=True):
 
1356
        tree.lock_read()
 
1357
        limbodir = tempfile.mkdtemp(prefix='bzr-limbo-')
 
1358
        TreeTransformBase.__init__(self, tree, limbodir, pb, case_sensitive)
 
1359
 
 
1360
    def canonical_path(self, path):
 
1361
        return path
 
1362
 
 
1363
    def tree_kind(self, trans_id):
 
1364
        path = self._tree_id_paths.get(trans_id)
 
1365
        if path is None:
 
1366
            raise NoSuchFile(None)
 
1367
        file_id = self._tree.path2id(path)
 
1368
        return self._tree.kind(file_id)
 
1369
 
 
1370
    def _set_mode(self, trans_id, mode_id, typefunc):
 
1371
        """Set the mode of new file contents.
 
1372
        The mode_id is the existing file to get the mode from (often the same
 
1373
        as trans_id).  The operation is only performed if there's a mode match
 
1374
        according to typefunc.
 
1375
        """
 
1376
        # is it ok to ignore this?  probably
 
1377
        pass
 
1378
 
 
1379
    def iter_tree_children(self, parent_id):
 
1380
        """Iterate through the entry's tree children, if any"""
 
1381
        try:
 
1382
            path = self._tree_id_paths[parent_id]
 
1383
        except KeyError:
 
1384
            return
 
1385
        file_id = self.tree_file_id(parent_id)
 
1386
        for child in self._tree.inventory[file_id].children.iterkeys():
 
1387
            childpath = joinpath(path, child)
 
1388
            yield self.trans_id_tree_path(childpath)
 
1389
 
 
1390
 
 
1391
class _PreviewTree(tree.Tree):
 
1392
    """Partial implementation of Tree to support show_diff_trees"""
 
1393
 
 
1394
    def __init__(self, transform):
 
1395
        self._transform = transform
 
1396
        self._final_paths = FinalPaths(transform)
 
1397
 
 
1398
    def _changes(self, file_id):
 
1399
        for changes in self._transform.iter_changes():
 
1400
            if changes[0] == file_id:
 
1401
                return changes
 
1402
 
 
1403
    def _content_change(self, file_id):
 
1404
        """Return True if the content of this file changed"""
 
1405
        changes = self._changes(file_id)
 
1406
        # changes[2] is true if the file content changed.  See
 
1407
        # InterTree.iter_changes.
 
1408
        return (changes is not None and changes[2])
 
1409
 
 
1410
    def _get_file_revision(self, file_id, vf, tree_revision):
 
1411
        return self._transform._tree._get_file_revision(file_id, vf,
 
1412
                                                        tree_revision)
 
1413
 
 
1414
    def _stat_limbo_file(self, file_id):
 
1415
        trans_id = self._transform.trans_id_file_id(file_id)
 
1416
        name = self._transform._limbo_name(trans_id)
 
1417
        return os.lstat(name)
 
1418
 
 
1419
    def lock_read(self):
 
1420
        # Perhaps in theory, this should lock the TreeTransform?
 
1421
        pass
 
1422
 
 
1423
    def unlock(self):
 
1424
        pass
 
1425
 
 
1426
    @property
 
1427
    def inventory(self):
 
1428
        """This Tree does not use inventory as its backing data."""
 
1429
        raise NotImplementedError(_PreviewTree.inventory)
 
1430
 
 
1431
    def get_root_id(self):
 
1432
        return self._transform.final_file_id(self._transform.root)
 
1433
 
 
1434
    def all_file_ids(self):
 
1435
        return self._transform._tree.all_file_ids()
 
1436
 
 
1437
    def __iter__(self):
 
1438
        return iter(self.all_file_ids())
 
1439
 
 
1440
    def paths2ids(self, specific_files, trees=None, require_versioned=False):
 
1441
        """See Tree.paths2ids"""
 
1442
        to_find = set(specific_files)
 
1443
        result = set()
 
1444
        for (file_id, paths, changed, versioned, parent, name, kind,
 
1445
             executable) in self._transform.iter_changes():
 
1446
            if paths[1] in to_find:
 
1447
                result.append(file_id)
 
1448
                to_find.remove(paths[1])
 
1449
        result.update(self._transform._tree.paths2ids(to_find,
 
1450
                      trees=[], require_versioned=require_versioned))
 
1451
        return result
 
1452
 
 
1453
    def path2id(self, path):
 
1454
        return self._transform._tree.path2id(path)
 
1455
 
 
1456
    def id2path(self, file_id):
 
1457
        trans_id = self._transform.trans_id_file_id(file_id)
 
1458
        try:
 
1459
            return self._final_paths._determine_path(trans_id)
 
1460
        except NoFinalPath:
 
1461
            raise errors.NoSuchId(self, file_id)
 
1462
 
 
1463
    def iter_entries_by_dir(self, specific_file_ids=None):
 
1464
        return self._transform._tree.iter_entries_by_dir(specific_file_ids)
 
1465
 
 
1466
    def kind(self, file_id):
 
1467
        trans_id = self._transform.trans_id_file_id(file_id)
 
1468
        return self._transform.final_kind(trans_id)
 
1469
 
 
1470
    def stored_kind(self, file_id):
 
1471
        return self._transform._tree.stored_kind(file_id)
 
1472
 
 
1473
    def get_file_mtime(self, file_id, path=None):
 
1474
        """See Tree.get_file_mtime"""
 
1475
        if not self._content_change(file_id):
 
1476
            return self._transform._tree.get_file_mtime(file_id, path)
 
1477
        return self._stat_limbo_file(file_id).st_mtime
 
1478
 
 
1479
    def get_file_size(self, file_id):
 
1480
        """See Tree.get_file_size"""
 
1481
        if self.kind(file_id) == 'file':
 
1482
            return self._transform._tree.get_file_size(file_id)
 
1483
        else:
 
1484
            return None
 
1485
 
 
1486
    def get_file_sha1(self, file_id, path=None, stat_value=None):
 
1487
        return self._transform._tree.get_file_sha1(file_id)
 
1488
 
 
1489
    def is_executable(self, file_id, path=None):
 
1490
        return self._transform._tree.is_executable(file_id, path)
 
1491
 
 
1492
    def path_content_summary(self, path):
 
1493
        return self._transform._tree.path_content_summary(path)
 
1494
 
 
1495
    def iter_changes(self, from_tree, include_unchanged=False,
 
1496
                      specific_files=None, pb=None, extra_trees=None,
 
1497
                      require_versioned=True, want_unversioned=False):
 
1498
        """See InterTree.iter_changes.
 
1499
 
 
1500
        This implementation does not support include_unchanged, specific_files,
 
1501
        or want_unversioned.  extra_trees, require_versioned, and pb are
 
1502
        ignored.
 
1503
        """
 
1504
        if from_tree is not self._transform._tree:
 
1505
            raise ValueError('from_tree must be transform source tree.')
 
1506
        if include_unchanged:
 
1507
            raise ValueError('include_unchanged is not supported')
 
1508
        if specific_files is not None:
 
1509
            raise ValueError('specific_files is not supported')
 
1510
        if want_unversioned:
 
1511
            raise ValueError('want_unversioned is not supported')
 
1512
        return self._transform.iter_changes()
 
1513
 
 
1514
    def get_file(self, file_id, path=None):
 
1515
        """See Tree.get_file"""
 
1516
        if not self._content_change(file_id):
 
1517
            return self._transform._tree.get_file(file_id, path)
 
1518
        trans_id = self._transform.trans_id_file_id(file_id)
 
1519
        name = self._transform._limbo_name(trans_id)
 
1520
        return open(name, 'rb')
 
1521
 
 
1522
    def get_file_text(self, file_id):
 
1523
        text_file = self.get_file(file_id)
 
1524
        try:
 
1525
            return text_file.read()
 
1526
        finally:
 
1527
            text_file.close()
 
1528
 
 
1529
    def annotate_iter(self, file_id,
 
1530
                      default_revision=_mod_revision.CURRENT_REVISION):
 
1531
        return self._transform._tree.annotate_iter(file_id,
 
1532
            default_revision=default_revision)
 
1533
 
 
1534
    def get_symlink_target(self, file_id):
 
1535
        """See Tree.get_symlink_target"""
 
1536
        if not self._content_change(file_id):
 
1537
            return self._transform._tree.get_symlink_target(file_id)
 
1538
        trans_id = self._transform.trans_id_file_id(file_id)
 
1539
        name = self._transform._limbo_name(trans_id)
 
1540
        return os.readlink(name)
 
1541
 
 
1542
    def list_files(self, include_root=False):
 
1543
        return self._transform._tree.list_files(include_root)
 
1544
 
 
1545
    def walkdirs(self, prefix=""):
 
1546
        return self._transform._tree.walkdirs(prefix)
 
1547
 
 
1548
    def get_parent_ids(self):
 
1549
        return self._transform._tree.get_parent_ids()
 
1550
 
 
1551
    def get_revision_tree(self, revision_id):
 
1552
        return self._transform._tree.get_revision_tree(revision_id)
 
1553
 
 
1554
 
864
1555
def joinpath(parent, child):
865
1556
    """Join tree-relative paths, handling the tree root specially"""
866
1557
    if parent is None or parent == "":
896
1587
            self._known_paths[trans_id] = self._determine_path(trans_id)
897
1588
        return self._known_paths[trans_id]
898
1589
 
 
1590
    def get_paths(self, trans_ids):
 
1591
        return [(self.get_path(t), t) for t in trans_ids]
 
1592
 
 
1593
 
 
1594
 
899
1595
def topology_sorted_ids(tree):
900
1596
    """Determine the topological order of the ids in a tree"""
901
1597
    file_ids = list(tree)
902
1598
    file_ids.sort(key=tree.id2path)
903
1599
    return file_ids
904
1600
 
905
 
def build_tree(tree, wt):
906
 
    """Create working tree for a branch, using a Transaction."""
 
1601
 
 
1602
def build_tree(tree, wt, accelerator_tree=None, hardlink=False,
 
1603
               delta_from_tree=False):
 
1604
    """Create working tree for a branch, using a TreeTransform.
 
1605
    
 
1606
    This function should be used on empty trees, having a tree root at most.
 
1607
    (see merge and revert functionality for working with existing trees)
 
1608
 
 
1609
    Existing files are handled like so:
 
1610
    
 
1611
    - Existing bzrdirs take precedence over creating new items.  They are
 
1612
      created as '%s.diverted' % name.
 
1613
    - Otherwise, if the content on disk matches the content we are building,
 
1614
      it is silently replaced.
 
1615
    - Otherwise, conflict resolution will move the old file to 'oldname.moved'.
 
1616
 
 
1617
    :param tree: The tree to convert wt into a copy of
 
1618
    :param wt: The working tree that files will be placed into
 
1619
    :param accelerator_tree: A tree which can be used for retrieving file
 
1620
        contents more quickly than tree itself, i.e. a workingtree.  tree
 
1621
        will be used for cases where accelerator_tree's content is different.
 
1622
    :param hardlink: If true, hard-link files to accelerator_tree, where
 
1623
        possible.  accelerator_tree must implement abspath, i.e. be a
 
1624
        working tree.
 
1625
    :param delta_from_tree: If true, build_tree may use the input Tree to
 
1626
        generate the inventory delta.
 
1627
    """
 
1628
    wt.lock_tree_write()
 
1629
    try:
 
1630
        tree.lock_read()
 
1631
        try:
 
1632
            if accelerator_tree is not None:
 
1633
                accelerator_tree.lock_read()
 
1634
            try:
 
1635
                return _build_tree(tree, wt, accelerator_tree, hardlink,
 
1636
                                   delta_from_tree)
 
1637
            finally:
 
1638
                if accelerator_tree is not None:
 
1639
                    accelerator_tree.unlock()
 
1640
        finally:
 
1641
            tree.unlock()
 
1642
    finally:
 
1643
        wt.unlock()
 
1644
 
 
1645
 
 
1646
def _build_tree(tree, wt, accelerator_tree, hardlink, delta_from_tree):
 
1647
    """See build_tree."""
 
1648
    for num, _unused in enumerate(wt.all_file_ids()):
 
1649
        if num > 0:  # more than just a root
 
1650
            raise errors.WorkingTreeAlreadyPopulated(base=wt.basedir)
 
1651
    existing_files = set()
 
1652
    for dir, files in wt.walkdirs():
 
1653
        existing_files.update(f[0] for f in files)
907
1654
    file_trans_id = {}
908
1655
    top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
909
1656
    pp = ProgressPhase("Build phase", 2, top_pb)
 
1657
    if tree.inventory.root is not None:
 
1658
        # This is kind of a hack: we should be altering the root
 
1659
        # as part of the regular tree shape diff logic.
 
1660
        # The conditional test here is to avoid doing an
 
1661
        # expensive operation (flush) every time the root id
 
1662
        # is set within the tree, nor setting the root and thus
 
1663
        # marking the tree as dirty, because we use two different
 
1664
        # idioms here: tree interfaces and inventory interfaces.
 
1665
        if wt.get_root_id() != tree.get_root_id():
 
1666
            wt.set_root_id(tree.get_root_id())
 
1667
            wt.flush()
910
1668
    tt = TreeTransform(wt)
 
1669
    divert = set()
911
1670
    try:
912
1671
        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)
 
1672
        file_trans_id[wt.get_root_id()] = \
 
1673
            tt.trans_id_tree_file_id(wt.get_root_id())
915
1674
        pb = bzrlib.ui.ui_factory.nested_progress_bar()
916
1675
        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]
 
1676
            deferred_contents = []
 
1677
            num = 0
 
1678
            total = len(tree.inventory)
 
1679
            if delta_from_tree:
 
1680
                precomputed_delta = []
 
1681
            else:
 
1682
                precomputed_delta = None
 
1683
            for num, (tree_path, entry) in \
 
1684
                enumerate(tree.inventory.iter_entries_by_dir()):
 
1685
                pb.update("Building tree", num - len(deferred_contents), total)
920
1686
                if entry.parent_id is None:
921
1687
                    continue
922
 
                if entry.parent_id not in file_trans_id:
923
 
                    raise repr(entry.parent_id)
 
1688
                reparent = False
 
1689
                file_id = entry.file_id
 
1690
                if delta_from_tree:
 
1691
                    precomputed_delta.append((None, tree_path, file_id, entry))
 
1692
                if tree_path in existing_files:
 
1693
                    target_path = wt.abspath(tree_path)
 
1694
                    kind = file_kind(target_path)
 
1695
                    if kind == "directory":
 
1696
                        try:
 
1697
                            bzrdir.BzrDir.open(target_path)
 
1698
                        except errors.NotBranchError:
 
1699
                            pass
 
1700
                        else:
 
1701
                            divert.add(file_id)
 
1702
                    if (file_id not in divert and
 
1703
                        _content_match(tree, entry, file_id, kind,
 
1704
                        target_path)):
 
1705
                        tt.delete_contents(tt.trans_id_tree_path(tree_path))
 
1706
                        if kind == 'directory':
 
1707
                            reparent = True
924
1708
                parent_id = file_trans_id[entry.parent_id]
925
 
                file_trans_id[file_id] = new_by_entry(tt, entry, parent_id, 
926
 
                                                      tree)
 
1709
                if entry.kind == 'file':
 
1710
                    # We *almost* replicate new_by_entry, so that we can defer
 
1711
                    # getting the file text, and get them all at once.
 
1712
                    trans_id = tt.create_path(entry.name, parent_id)
 
1713
                    file_trans_id[file_id] = trans_id
 
1714
                    tt.version_file(file_id, trans_id)
 
1715
                    executable = tree.is_executable(file_id, tree_path)
 
1716
                    if executable:
 
1717
                        tt.set_executability(executable, trans_id)
 
1718
                    deferred_contents.append((file_id, trans_id))
 
1719
                else:
 
1720
                    file_trans_id[file_id] = new_by_entry(tt, entry, parent_id,
 
1721
                                                          tree)
 
1722
                if reparent:
 
1723
                    new_trans_id = file_trans_id[file_id]
 
1724
                    old_parent = tt.trans_id_tree_path(tree_path)
 
1725
                    _reparent_children(tt, old_parent, new_trans_id)
 
1726
            offset = num + 1 - len(deferred_contents)
 
1727
            _create_files(tt, tree, deferred_contents, pb, offset,
 
1728
                          accelerator_tree, hardlink)
927
1729
        finally:
928
1730
            pb.finished()
929
1731
        pp.next_phase()
930
 
        tt.apply()
 
1732
        divert_trans = set(file_trans_id[f] for f in divert)
 
1733
        resolver = lambda t, c: resolve_checkout(t, c, divert_trans)
 
1734
        raw_conflicts = resolve_conflicts(tt, pass_func=resolver)
 
1735
        if len(raw_conflicts) > 0:
 
1736
            precomputed_delta = None
 
1737
        conflicts = cook_conflicts(raw_conflicts, tt)
 
1738
        for conflict in conflicts:
 
1739
            warning(conflict)
 
1740
        try:
 
1741
            wt.add_conflicts(conflicts)
 
1742
        except errors.UnsupportedOperation:
 
1743
            pass
 
1744
        result = tt.apply(no_conflicts=True,
 
1745
                          precomputed_delta=precomputed_delta)
931
1746
    finally:
932
1747
        tt.finalize()
933
1748
        top_pb.finished()
 
1749
    return result
 
1750
 
 
1751
 
 
1752
def _create_files(tt, tree, desired_files, pb, offset, accelerator_tree,
 
1753
                  hardlink):
 
1754
    total = len(desired_files) + offset
 
1755
    if accelerator_tree is None:
 
1756
        new_desired_files = desired_files
 
1757
    else:
 
1758
        iter = accelerator_tree.iter_changes(tree, include_unchanged=True)
 
1759
        unchanged = dict((f, p[1]) for (f, p, c, v, d, n, k, e)
 
1760
                         in iter if not (c or e[0] != e[1]))
 
1761
        new_desired_files = []
 
1762
        count = 0
 
1763
        for file_id, trans_id in desired_files:
 
1764
            accelerator_path = unchanged.get(file_id)
 
1765
            if accelerator_path is None:
 
1766
                new_desired_files.append((file_id, trans_id))
 
1767
                continue
 
1768
            pb.update('Adding file contents', count + offset, total)
 
1769
            if hardlink:
 
1770
                tt.create_hardlink(accelerator_tree.abspath(accelerator_path),
 
1771
                                   trans_id)
 
1772
            else:
 
1773
                contents = accelerator_tree.get_file(file_id, accelerator_path)
 
1774
                try:
 
1775
                    tt.create_file(contents, trans_id)
 
1776
                finally:
 
1777
                    contents.close()
 
1778
            count += 1
 
1779
        offset += count
 
1780
    for count, (trans_id, contents) in enumerate(tree.iter_files_bytes(
 
1781
                                                 new_desired_files)):
 
1782
        tt.create_file(contents, trans_id)
 
1783
        pb.update('Adding file contents', count + offset, total)
 
1784
 
 
1785
 
 
1786
def _reparent_children(tt, old_parent, new_parent):
 
1787
    for child in tt.iter_tree_children(old_parent):
 
1788
        tt.adjust_path(tt.final_name(child), new_parent, child)
 
1789
 
 
1790
def _reparent_transform_children(tt, old_parent, new_parent):
 
1791
    by_parent = tt.by_parent()
 
1792
    for child in by_parent[old_parent]:
 
1793
        tt.adjust_path(tt.final_name(child), new_parent, child)
 
1794
    return by_parent[old_parent]
 
1795
 
 
1796
def _content_match(tree, entry, file_id, kind, target_path):
 
1797
    if entry.kind != kind:
 
1798
        return False
 
1799
    if entry.kind == "directory":
 
1800
        return True
 
1801
    if entry.kind == "file":
 
1802
        if tree.get_file(file_id).read() == file(target_path, 'rb').read():
 
1803
            return True
 
1804
    elif entry.kind == "symlink":
 
1805
        if tree.get_symlink_target(file_id) == os.readlink(target_path):
 
1806
            return True
 
1807
    return False
 
1808
 
 
1809
 
 
1810
def resolve_checkout(tt, conflicts, divert):
 
1811
    new_conflicts = set()
 
1812
    for c_type, conflict in ((c[0], c) for c in conflicts):
 
1813
        # Anything but a 'duplicate' would indicate programmer error
 
1814
        if c_type != 'duplicate':
 
1815
            raise AssertionError(c_type)
 
1816
        # Now figure out which is new and which is old
 
1817
        if tt.new_contents(conflict[1]):
 
1818
            new_file = conflict[1]
 
1819
            old_file = conflict[2]
 
1820
        else:
 
1821
            new_file = conflict[2]
 
1822
            old_file = conflict[1]
 
1823
 
 
1824
        # We should only get here if the conflict wasn't completely
 
1825
        # resolved
 
1826
        final_parent = tt.final_parent(old_file)
 
1827
        if new_file in divert:
 
1828
            new_name = tt.final_name(old_file)+'.diverted'
 
1829
            tt.adjust_path(new_name, final_parent, new_file)
 
1830
            new_conflicts.add((c_type, 'Diverted to',
 
1831
                               new_file, old_file))
 
1832
        else:
 
1833
            new_name = tt.final_name(old_file)+'.moved'
 
1834
            tt.adjust_path(new_name, final_parent, old_file)
 
1835
            new_conflicts.add((c_type, 'Moved existing file to',
 
1836
                               old_file, new_file))
 
1837
    return new_conflicts
 
1838
 
934
1839
 
935
1840
def new_by_entry(tt, entry, parent_id, tree):
936
1841
    """Create a new file according to its inventory entry"""
941
1846
        executable = tree.is_executable(entry.file_id)
942
1847
        return tt.new_file(name, parent_id, contents, entry.file_id, 
943
1848
                           executable)
944
 
    elif kind == 'directory':
945
 
        return tt.new_directory(name, parent_id, entry.file_id)
 
1849
    elif kind in ('directory', 'tree-reference'):
 
1850
        trans_id = tt.new_directory(name, parent_id, entry.file_id)
 
1851
        if kind == 'tree-reference':
 
1852
            tt.set_tree_reference(entry.reference_revision, trans_id)
 
1853
        return trans_id 
946
1854
    elif kind == 'symlink':
947
1855
        target = tree.get_symlink_target(entry.file_id)
948
1856
        return tt.new_symlink(name, parent_id, target, entry.file_id)
 
1857
    else:
 
1858
        raise errors.BadFileKindError(name, kind)
 
1859
 
949
1860
 
950
1861
def create_by_entry(tt, entry, tree, trans_id, lines=None, mode_id=None):
951
1862
    """Create new file contents according to an inventory entry."""
952
1863
    if entry.kind == "file":
953
 
        if lines == None:
 
1864
        if lines is None:
954
1865
            lines = tree.get_file(entry.file_id).readlines()
955
1866
        tt.create_file(lines, trans_id, mode_id=mode_id)
956
1867
    elif entry.kind == "symlink":
958
1869
    elif entry.kind == "directory":
959
1870
        tt.create_directory(trans_id)
960
1871
 
 
1872
 
961
1873
def create_entry_executability(tt, entry, trans_id):
962
1874
    """Set the executability of a trans_id according to an inventory entry"""
963
1875
    if entry.kind == "file":
964
1876
        tt.set_executability(entry.executable, trans_id)
965
1877
 
966
1878
 
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
1879
def get_backup_name(entry, by_parent, parent_trans_id, tt):
 
1880
    return _get_backup_name(entry.name, by_parent, parent_trans_id, tt)
 
1881
 
 
1882
 
 
1883
def _get_backup_name(name, by_parent, parent_trans_id, tt):
1026
1884
    """Produce a backup-style name that appears to be available"""
1027
1885
    def name_gen():
1028
1886
        counter = 1
1029
1887
        while True:
1030
 
            yield "%s.~%d~" % (entry.name, counter)
 
1888
            yield "%s.~%d~" % (name, counter)
1031
1889
            counter += 1
1032
 
    for name in name_gen():
1033
 
        if not tt.has_named_child(by_parent, parent_trans_id, name):
1034
 
            return name
 
1890
    for new_name in name_gen():
 
1891
        if not tt.has_named_child(by_parent, parent_trans_id, new_name):
 
1892
            return new_name
 
1893
 
1035
1894
 
1036
1895
def _entry_changes(file_id, entry, working_tree):
1037
1896
    """Determine in which ways the inventory entry has changed.
1045
1904
    try:
1046
1905
        working_kind = working_tree.kind(file_id)
1047
1906
        has_contents = True
1048
 
    except OSError, e:
1049
 
        if e.errno != errno.ENOENT:
1050
 
            raise
 
1907
    except NoSuchFile:
1051
1908
        has_contents = False
1052
1909
        contents_mod = True
1053
1910
        meta_mod = False
1054
1911
    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:
 
1912
        if entry.kind != working_kind:
1059
1913
            contents_mod, meta_mod = True, False
1060
1914
        else:
1061
1915
            cur_entry._read_tree_state(working_tree.id2path(file_id), 
1065
1919
    return has_contents, contents_mod, meta_mod
1066
1920
 
1067
1921
 
1068
 
def revert(working_tree, target_tree, filenames, backups=False, 
1069
 
           pb=DummyProgress()):
 
1922
def revert(working_tree, target_tree, filenames, backups=False,
 
1923
           pb=DummyProgress(), change_reporter=None):
1070
1924
    """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
 
 
 
1925
    target_tree.lock_read()
1075
1926
    tt = TreeTransform(working_tree, pb)
1076
1927
    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:
 
1928
        pp = ProgressPhase("Revert phase", 3, pb)
 
1929
        pp.next_phase()
 
1930
        child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
1931
        try:
 
1932
            merge_modified = _alter_files(working_tree, target_tree, tt,
 
1933
                                          child_pb, filenames, backups)
 
1934
        finally:
 
1935
            child_pb.finished()
 
1936
        pp.next_phase()
 
1937
        child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
1938
        try:
 
1939
            raw_conflicts = resolve_conflicts(tt, child_pb,
 
1940
                lambda t, c: conflict_pass(t, c, target_tree))
 
1941
        finally:
 
1942
            child_pb.finished()
 
1943
        conflicts = cook_conflicts(raw_conflicts, tt)
 
1944
        if change_reporter:
 
1945
            change_reporter = delta._ChangeReporter(
 
1946
                unversioned_filter=working_tree.is_ignored)
 
1947
            delta.report_changes(tt.iter_changes(), change_reporter)
 
1948
        for conflict in conflicts:
 
1949
            warning(conflict)
 
1950
        pp.next_phase()
 
1951
        tt.apply()
 
1952
        working_tree.set_merge_modified(merge_modified)
 
1953
    finally:
 
1954
        target_tree.unlock()
 
1955
        tt.finalize()
 
1956
        pb.clear()
 
1957
    return conflicts
 
1958
 
 
1959
 
 
1960
def _alter_files(working_tree, target_tree, tt, pb, specific_files,
 
1961
                 backups):
 
1962
    merge_modified = working_tree.merge_modified()
 
1963
    change_list = target_tree.iter_changes(working_tree,
 
1964
        specific_files=specific_files, pb=pb)
 
1965
    if target_tree.inventory.root is None:
 
1966
        skip_root = True
 
1967
    else:
 
1968
        skip_root = False
 
1969
    basis_tree = None
 
1970
    try:
 
1971
        deferred_files = []
 
1972
        for id_num, (file_id, path, changed_content, versioned, parent, name,
 
1973
                kind, executable) in enumerate(change_list):
 
1974
            if skip_root and file_id[0] is not None and parent[0] is None:
 
1975
                continue
 
1976
            trans_id = tt.trans_id_file_id(file_id)
 
1977
            mode_id = None
 
1978
            if changed_content:
 
1979
                keep_content = False
 
1980
                if kind[0] == 'file' and (backups or kind[1] is None):
 
1981
                    wt_sha1 = working_tree.get_file_sha1(file_id)
 
1982
                    if merge_modified.get(file_id) != wt_sha1:
 
1983
                        # acquire the basis tree lazily to prevent the
 
1984
                        # expense of accessing it when it's not needed ?
 
1985
                        # (Guessing, RBC, 200702)
 
1986
                        if basis_tree is None:
 
1987
                            basis_tree = working_tree.basis_tree()
 
1988
                            basis_tree.lock_read()
 
1989
                        if file_id in basis_tree:
 
1990
                            if wt_sha1 != basis_tree.get_file_sha1(file_id):
 
1991
                                keep_content = True
 
1992
                        elif kind[1] is None and not versioned[1]:
 
1993
                            keep_content = True
 
1994
                if kind[0] is not None:
 
1995
                    if not keep_content:
1121
1996
                        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({})
 
1997
                    elif kind[1] is not None:
 
1998
                        parent_trans_id = tt.trans_id_file_id(parent[0])
 
1999
                        by_parent = tt.by_parent()
 
2000
                        backup_name = _get_backup_name(name[0], by_parent,
 
2001
                                                       parent_trans_id, tt)
 
2002
                        tt.adjust_path(backup_name, parent_trans_id, trans_id)
 
2003
                        new_trans_id = tt.create_path(name[0], parent_trans_id)
 
2004
                        if versioned == (True, True):
 
2005
                            tt.unversion_file(trans_id)
 
2006
                            tt.version_file(file_id, new_trans_id)
 
2007
                        # New contents should have the same unix perms as old
 
2008
                        # contents
 
2009
                        mode_id = trans_id
 
2010
                        trans_id = new_trans_id
 
2011
                if kind[1] == 'directory':
 
2012
                    tt.create_directory(trans_id)
 
2013
                elif kind[1] == 'symlink':
 
2014
                    tt.create_symlink(target_tree.get_symlink_target(file_id),
 
2015
                                      trans_id)
 
2016
                elif kind[1] == 'file':
 
2017
                    deferred_files.append((file_id, (trans_id, mode_id)))
 
2018
                    if basis_tree is None:
 
2019
                        basis_tree = working_tree.basis_tree()
 
2020
                        basis_tree.lock_read()
 
2021
                    new_sha1 = target_tree.get_file_sha1(file_id)
 
2022
                    if (file_id in basis_tree and new_sha1 ==
 
2023
                        basis_tree.get_file_sha1(file_id)):
 
2024
                        if file_id in merge_modified:
 
2025
                            del merge_modified[file_id]
 
2026
                    else:
 
2027
                        merge_modified[file_id] = new_sha1
 
2028
 
 
2029
                    # preserve the execute bit when backing up
 
2030
                    if keep_content and executable[0] == executable[1]:
 
2031
                        tt.set_executability(executable[1], trans_id)
 
2032
                elif kind[1] is not None:
 
2033
                    raise AssertionError(kind[1])
 
2034
            if versioned == (False, True):
 
2035
                tt.version_file(file_id, trans_id)
 
2036
            if versioned == (True, False):
 
2037
                tt.unversion_file(trans_id)
 
2038
            if (name[1] is not None and 
 
2039
                (name[0] != name[1] or parent[0] != parent[1])):
 
2040
                tt.adjust_path(
 
2041
                    name[1], tt.trans_id_file_id(parent[1]), trans_id)
 
2042
            if executable[0] != executable[1] and kind[1] == "file":
 
2043
                tt.set_executability(executable[1], trans_id)
 
2044
        for (trans_id, mode_id), bytes in target_tree.iter_files_bytes(
 
2045
            deferred_files):
 
2046
            tt.create_file(bytes, trans_id, mode_id)
1137
2047
    finally:
1138
 
        tt.finalize()
1139
 
        pb.clear()
1140
 
    return conflicts
1141
 
 
1142
 
 
1143
 
def resolve_conflicts(tt, pb=DummyProgress()):
 
2048
        if basis_tree is not None:
 
2049
            basis_tree.unlock()
 
2050
    return merge_modified
 
2051
 
 
2052
 
 
2053
def resolve_conflicts(tt, pb=DummyProgress(), pass_func=None):
1144
2054
    """Make many conflict-resolution attempts, but die if they fail"""
 
2055
    if pass_func is None:
 
2056
        pass_func = conflict_pass
1145
2057
    new_conflicts = set()
1146
2058
    try:
1147
2059
        for n in range(10):
1149
2061
            conflicts = tt.find_conflicts()
1150
2062
            if len(conflicts) == 0:
1151
2063
                return new_conflicts
1152
 
            new_conflicts.update(conflict_pass(tt, conflicts))
 
2064
            new_conflicts.update(pass_func(tt, conflicts))
1153
2065
        raise MalformedTransform(conflicts=conflicts)
1154
2066
    finally:
1155
2067
        pb.clear()
1156
2068
 
1157
2069
 
1158
 
def conflict_pass(tt, conflicts):
1159
 
    """Resolve some classes of conflicts."""
 
2070
def conflict_pass(tt, conflicts, path_tree=None):
 
2071
    """Resolve some classes of conflicts.
 
2072
 
 
2073
    :param tt: The transform to resolve conflicts in
 
2074
    :param conflicts: The conflicts to resolve
 
2075
    :param path_tree: A Tree to get supplemental paths from
 
2076
    """
1160
2077
    new_conflicts = set()
1161
2078
    for c_type, conflict in ((c[0], c) for c in conflicts):
1162
2079
        if c_type == 'duplicate id':
1165
2082
                               conflict[1], conflict[2], ))
1166
2083
        elif c_type == 'duplicate':
1167
2084
            # files that were renamed take precedence
1168
 
            new_name = tt.final_name(conflict[1])+'.moved'
1169
2085
            final_parent = tt.final_parent(conflict[1])
1170
2086
            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]))
 
2087
                existing_file, new_file = conflict[2], conflict[1]
1174
2088
            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]))
 
2089
                existing_file, new_file = conflict[1], conflict[2]
 
2090
            new_name = tt.final_name(existing_file)+'.moved'
 
2091
            tt.adjust_path(new_name, final_parent, existing_file)
 
2092
            new_conflicts.add((c_type, 'Moved existing file to', 
 
2093
                               existing_file, new_file))
1178
2094
        elif c_type == 'parent loop':
1179
2095
            # break the loop by undoing one of the ops that caused the loop
1180
2096
            cur = conflict[1]
1188
2104
            trans_id = conflict[1]
1189
2105
            try:
1190
2106
                tt.cancel_deletion(trans_id)
1191
 
                new_conflicts.add((c_type, 'Not deleting', trans_id))
 
2107
                new_conflicts.add(('deleting parent', 'Not deleting', 
 
2108
                                   trans_id))
1192
2109
            except KeyError:
1193
 
                tt.create_directory(trans_id)
1194
 
                new_conflicts.add((c_type, 'Created directory.', trans_id))
 
2110
                create = True
 
2111
                try:
 
2112
                    tt.final_name(trans_id)
 
2113
                except NoFinalPath:
 
2114
                    if path_tree is not None:
 
2115
                        file_id = tt.final_file_id(trans_id)
 
2116
                        if file_id is None:
 
2117
                            file_id = tt.inactive_file_id(trans_id)
 
2118
                        entry = path_tree.inventory[file_id]
 
2119
                        # special-case the other tree root (move its
 
2120
                        # children to current root)
 
2121
                        if entry.parent_id is None:
 
2122
                            create=False
 
2123
                            moved = _reparent_transform_children(
 
2124
                                tt, trans_id, tt.root)
 
2125
                            for child in moved:
 
2126
                                new_conflicts.add((c_type, 'Moved to root',
 
2127
                                                   child))
 
2128
                        else:
 
2129
                            parent_trans_id = tt.trans_id_file_id(
 
2130
                                entry.parent_id)
 
2131
                            tt.adjust_path(entry.name, parent_trans_id,
 
2132
                                           trans_id)
 
2133
                if create:
 
2134
                    tt.create_directory(trans_id)
 
2135
                    new_conflicts.add((c_type, 'Created directory', trans_id))
1195
2136
        elif c_type == 'unversioned parent':
1196
 
            tt.version_file(tt.inactive_file_id(conflict[1]), conflict[1])
 
2137
            file_id = tt.inactive_file_id(conflict[1])
 
2138
            # special-case the other tree root (move its children instead)
 
2139
            if path_tree and file_id in path_tree:
 
2140
                if path_tree.inventory[file_id].parent_id is None:
 
2141
                    continue
 
2142
            tt.version_file(file_id, conflict[1])
1197
2143
            new_conflicts.add((c_type, 'Versioned directory', conflict[1]))
 
2144
        elif c_type == 'non-directory parent':
 
2145
            parent_id = conflict[1]
 
2146
            parent_parent = tt.final_parent(parent_id)
 
2147
            parent_name = tt.final_name(parent_id)
 
2148
            parent_file_id = tt.final_file_id(parent_id)
 
2149
            new_parent_id = tt.new_directory(parent_name + '.new',
 
2150
                parent_parent, parent_file_id)
 
2151
            _reparent_transform_children(tt, parent_id, new_parent_id)
 
2152
            if parent_file_id is not None:
 
2153
                tt.unversion_file(parent_id)
 
2154
            new_conflicts.add((c_type, 'Created directory', new_parent_id))
1198
2155
    return new_conflicts
1199
2156
 
 
2157
 
1200
2158
def cook_conflicts(raw_conflicts, tt):
1201
2159
    """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
 
2160
    from bzrlib.conflicts import Conflict
 
2161
    conflict_iter = iter_cook_conflicts(raw_conflicts, tt)
 
2162
    return sorted(conflict_iter, key=Conflict.sort_key)
1209
2163
 
1210
 
    return sorted(list(iter_cook_conflicts(raw_conflicts, tt)), key=key)
1211
2164
 
1212
2165
def iter_cook_conflicts(raw_conflicts, tt):
1213
2166
    from bzrlib.conflicts import Conflict
1228
2181
                                   file_id=modified_id, 
1229
2182
                                   conflict_path=conflicting_path,
1230
2183
                                   conflict_file_id=conflicting_id)
 
2184
 
 
2185
 
 
2186
class _FileMover(object):
 
2187
    """Moves and deletes files for TreeTransform, tracking operations"""
 
2188
 
 
2189
    def __init__(self):
 
2190
        self.past_renames = []
 
2191
        self.pending_deletions = []
 
2192
 
 
2193
    def rename(self, from_, to):
 
2194
        """Rename a file from one path to another.  Functions like os.rename"""
 
2195
        try:
 
2196
            os.rename(from_, to)
 
2197
        except OSError, e:
 
2198
            if e.errno in (errno.EEXIST, errno.ENOTEMPTY):
 
2199
                raise errors.FileExists(to, str(e))
 
2200
            raise
 
2201
        self.past_renames.append((from_, to))
 
2202
 
 
2203
    def pre_delete(self, from_, to):
 
2204
        """Rename a file out of the way and mark it for deletion.
 
2205
 
 
2206
        Unlike os.unlink, this works equally well for files and directories.
 
2207
        :param from_: The current file path
 
2208
        :param to: A temporary path for the file
 
2209
        """
 
2210
        self.rename(from_, to)
 
2211
        self.pending_deletions.append(to)
 
2212
 
 
2213
    def rollback(self):
 
2214
        """Reverse all renames that have been performed"""
 
2215
        for from_, to in reversed(self.past_renames):
 
2216
            os.rename(to, from_)
 
2217
        # after rollback, don't reuse _FileMover
 
2218
        past_renames = None
 
2219
        pending_deletions = None
 
2220
 
 
2221
    def apply_deletions(self):
 
2222
        """Apply all marked deletions"""
 
2223
        for path in self.pending_deletions:
 
2224
            delete_any(path)
 
2225
        # after apply_deletions, don't reuse _FileMover
 
2226
        past_renames = None
 
2227
        pending_deletions = None