← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/transform.py

  • Committer: John Arbash Meinel
  • Date: 2006-05-30 04:44:48 UTC
  • mto: (1711.2.26 jam-integration)
  • mto: This revision was merged to the branch mainline in revision 1734.
  • Revision ID: john@arbash-meinel.com-20060530044448-81612e2e57c3991f
Update documentation and TODO for compare_trees

Show diffs side-by-side

added added

removed removed

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