1
# Copyright (C) 2006, 2007 Canonical Ltd
 
 
3
# This program is free software; you can redistribute it and/or modify
 
 
4
# it under the terms of the GNU General Public License as published by
 
 
5
# the Free Software Foundation; either version 2 of the License, or
 
 
6
# (at your option) any later version.
 
 
8
# This program is distributed in the hope that it will be useful,
 
 
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
 
 
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
 
11
# GNU General Public License for more details.
 
 
13
# You should have received a copy of the GNU General Public License
 
 
14
# along with this program; if not, write to the Free Software
 
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
 
19
from stat import S_ISREG
 
 
21
from bzrlib.lazy_import import lazy_import
 
 
22
lazy_import(globals(), """
 
 
30
from bzrlib.errors import (DuplicateKey, MalformedTransform, NoSuchFile,
 
 
31
                           ReusingTransform, NotVersionedError, CantMoveRoot,
 
 
32
                           ExistingLimbo, ImmortalLimbo, NoFinalPath)
 
 
33
from bzrlib.inventory import InventoryEntry
 
 
34
from bzrlib.osutils import (file_kind, supports_executable, pathjoin, lexists,
 
 
36
from bzrlib.progress import DummyProgress, ProgressPhase
 
 
37
from bzrlib.symbol_versioning import deprecated_function, zero_fifteen
 
 
38
from bzrlib.trace import mutter, warning
 
 
39
from bzrlib import tree
 
 
41
import bzrlib.urlutils as urlutils
 
 
44
ROOT_PARENT = "root-parent"
 
 
47
def unique_add(map, key, value):
 
 
49
        raise DuplicateKey(key=key)
 
 
53
class _TransformResults(object):
 
 
54
    def __init__(self, modified_paths, rename_count):
 
 
56
        self.modified_paths = modified_paths
 
 
57
        self.rename_count = rename_count
 
 
60
class TreeTransform(object):
 
 
61
    """Represent a tree transformation.
 
 
63
    This object is designed to support incremental generation of the transform,
 
 
66
    However, it gives optimum performance when parent directories are created
 
 
67
    before their contents.  The transform is then able to put child files
 
 
68
    directly in their parent directory, avoiding later renames.
 
 
70
    It is easy to produce malformed transforms, but they are generally
 
 
71
    harmless.  Attempting to apply a malformed transform will cause an
 
 
72
    exception to be raised before any modifications are made to the tree.  
 
 
74
    Many kinds of malformed transforms can be corrected with the 
 
 
75
    resolve_conflicts function.  The remaining ones indicate programming error,
 
 
76
    such as trying to create a file with no path.
 
 
78
    Two sets of file creation methods are supplied.  Convenience methods are:
 
 
83
    These are composed of the low-level methods:
 
 
85
     * create_file or create_directory or create_symlink
 
 
89
    def __init__(self, tree, pb=DummyProgress()):
 
 
90
        """Note: a tree_write lock is taken on the tree.
 
 
92
        Use TreeTransform.finalize() to release the lock (can be omitted if
 
 
93
        TreeTransform.apply() called).
 
 
97
        self._tree.lock_tree_write()
 
 
99
            control_files = self._tree._control_files
 
 
100
            self._limbodir = urlutils.local_path_from_url(
 
 
101
                control_files.controlfilename('limbo'))
 
 
103
                os.mkdir(self._limbodir)
 
 
105
                if e.errno == errno.EEXIST:
 
 
106
                    raise ExistingLimbo(self._limbodir)
 
 
113
        self._new_parent = {}
 
 
114
        self._new_contents = {}
 
 
115
        # A mapping of transform ids to their limbo filename
 
 
116
        self._limbo_files = {}
 
 
117
        # A mapping of transform ids to a set of the transform ids of children
 
 
118
        # that their limbo directory has
 
 
119
        self._limbo_children = {}
 
 
120
        # Map transform ids to maps of child filename to child transform id
 
 
121
        self._limbo_children_names = {}
 
 
122
        # List of transform ids that need to be renamed from limbo into place
 
 
123
        self._needs_rename = set()
 
 
124
        self._removed_contents = set()
 
 
125
        self._new_executability = {}
 
 
126
        self._new_reference_revision = {}
 
 
128
        self._non_present_ids = {}
 
 
130
        self._removed_id = set()
 
 
131
        self._tree_path_ids = {}
 
 
132
        self._tree_id_paths = {}
 
 
133
        # Cache of realpath results, to speed up canonical_path
 
 
135
        # Cache of relpath results, to speed up canonical_path
 
 
137
        self._new_root = self.trans_id_tree_file_id(tree.get_root_id())
 
 
140
        self.rename_count = 0
 
 
142
    def __get_root(self):
 
 
143
        return self._new_root
 
 
145
    root = property(__get_root)
 
 
148
        """Release the working tree lock, if held, clean up limbo dir.
 
 
150
        This is required if apply has not been invoked, but can be invoked
 
 
153
        if self._tree is None:
 
 
156
            entries = [(self._limbo_name(t), t, k) for t, k in
 
 
157
                       self._new_contents.iteritems()]
 
 
158
            entries.sort(reverse=True)
 
 
159
            for path, trans_id, kind in entries:
 
 
160
                if kind == "directory":
 
 
165
                os.rmdir(self._limbodir)
 
 
167
                # We don't especially care *why* the dir is immortal.
 
 
168
                raise ImmortalLimbo(self._limbodir)
 
 
173
    def _assign_id(self):
 
 
174
        """Produce a new tranform id"""
 
 
175
        new_id = "new-%s" % self._id_number
 
 
179
    def create_path(self, name, parent):
 
 
180
        """Assign a transaction id to a new path"""
 
 
181
        trans_id = self._assign_id()
 
 
182
        unique_add(self._new_name, trans_id, name)
 
 
183
        unique_add(self._new_parent, trans_id, parent)
 
 
186
    def adjust_path(self, name, parent, trans_id):
 
 
187
        """Change the path that is assigned to a transaction id."""
 
 
188
        if trans_id == self._new_root:
 
 
190
        previous_parent = self._new_parent.get(trans_id)
 
 
191
        previous_name = self._new_name.get(trans_id)
 
 
192
        self._new_name[trans_id] = name
 
 
193
        self._new_parent[trans_id] = parent
 
 
194
        if (trans_id in self._limbo_files and
 
 
195
            trans_id not in self._needs_rename):
 
 
196
            self._rename_in_limbo([trans_id])
 
 
197
            self._limbo_children[previous_parent].remove(trans_id)
 
 
198
            del self._limbo_children_names[previous_parent][previous_name]
 
 
200
    def _rename_in_limbo(self, trans_ids):
 
 
201
        """Fix limbo names so that the right final path is produced.
 
 
203
        This means we outsmarted ourselves-- we tried to avoid renaming
 
 
204
        these files later by creating them with their final names in their
 
 
205
        final parents.  But now the previous name or parent is no longer
 
 
206
        suitable, so we have to rename them.
 
 
208
        Even for trans_ids that have no new contents, we must remove their
 
 
209
        entries from _limbo_files, because they are now stale.
 
 
211
        for trans_id in trans_ids:
 
 
212
            old_path = self._limbo_files.pop(trans_id)
 
 
213
            if trans_id not in self._new_contents:
 
 
215
            new_path = self._limbo_name(trans_id)
 
 
216
            os.rename(old_path, new_path)
 
 
218
    def adjust_root_path(self, name, parent):
 
 
219
        """Emulate moving the root by moving all children, instead.
 
 
221
        We do this by undoing the association of root's transaction id with the
 
 
222
        current tree.  This allows us to create a new directory with that
 
 
223
        transaction id.  We unversion the root directory and version the 
 
 
224
        physically new directory, and hope someone versions the tree root
 
 
227
        old_root = self._new_root
 
 
228
        old_root_file_id = self.final_file_id(old_root)
 
 
229
        # force moving all children of root
 
 
230
        for child_id in self.iter_tree_children(old_root):
 
 
231
            if child_id != parent:
 
 
232
                self.adjust_path(self.final_name(child_id), 
 
 
233
                                 self.final_parent(child_id), child_id)
 
 
234
            file_id = self.final_file_id(child_id)
 
 
235
            if file_id is not None:
 
 
236
                self.unversion_file(child_id)
 
 
237
            self.version_file(file_id, child_id)
 
 
239
        # the physical root needs a new transaction id
 
 
240
        self._tree_path_ids.pop("")
 
 
241
        self._tree_id_paths.pop(old_root)
 
 
242
        self._new_root = self.trans_id_tree_file_id(self._tree.get_root_id())
 
 
243
        if parent == old_root:
 
 
244
            parent = self._new_root
 
 
245
        self.adjust_path(name, parent, old_root)
 
 
246
        self.create_directory(old_root)
 
 
247
        self.version_file(old_root_file_id, old_root)
 
 
248
        self.unversion_file(self._new_root)
 
 
250
    def trans_id_tree_file_id(self, inventory_id):
 
 
251
        """Determine the transaction id of a working tree file.
 
 
253
        This reflects only files that already exist, not ones that will be
 
 
254
        added by transactions.
 
 
256
        path = self._tree.inventory.id2path(inventory_id)
 
 
257
        return self.trans_id_tree_path(path)
 
 
259
    def trans_id_file_id(self, file_id):
 
 
260
        """Determine or set the transaction id associated with a file ID.
 
 
261
        A new id is only created for file_ids that were never present.  If
 
 
262
        a transaction has been unversioned, it is deliberately still returned.
 
 
263
        (this will likely lead to an unversioned parent conflict.)
 
 
265
        if file_id in self._r_new_id and self._r_new_id[file_id] is not None:
 
 
266
            return self._r_new_id[file_id]
 
 
267
        elif file_id in self._tree.inventory:
 
 
268
            return self.trans_id_tree_file_id(file_id)
 
 
269
        elif file_id in self._non_present_ids:
 
 
270
            return self._non_present_ids[file_id]
 
 
272
            trans_id = self._assign_id()
 
 
273
            self._non_present_ids[file_id] = trans_id
 
 
276
    def canonical_path(self, path):
 
 
277
        """Get the canonical tree-relative path"""
 
 
278
        # don't follow final symlinks
 
 
279
        abs = self._tree.abspath(path)
 
 
280
        if abs in self._relpaths:
 
 
281
            return self._relpaths[abs]
 
 
282
        dirname, basename = os.path.split(abs)
 
 
283
        if dirname not in self._realpaths:
 
 
284
            self._realpaths[dirname] = os.path.realpath(dirname)
 
 
285
        dirname = self._realpaths[dirname]
 
 
286
        abs = pathjoin(dirname, basename)
 
 
287
        if dirname in self._relpaths:
 
 
288
            relpath = pathjoin(self._relpaths[dirname], basename)
 
 
289
            relpath = relpath.rstrip('/\\')
 
 
291
            relpath = self._tree.relpath(abs)
 
 
292
        self._relpaths[abs] = relpath
 
 
295
    def trans_id_tree_path(self, path):
 
 
296
        """Determine (and maybe set) the transaction ID for a tree path."""
 
 
297
        path = self.canonical_path(path)
 
 
298
        if path not in self._tree_path_ids:
 
 
299
            self._tree_path_ids[path] = self._assign_id()
 
 
300
            self._tree_id_paths[self._tree_path_ids[path]] = path
 
 
301
        return self._tree_path_ids[path]
 
 
303
    def get_tree_parent(self, trans_id):
 
 
304
        """Determine id of the parent in the tree."""
 
 
305
        path = self._tree_id_paths[trans_id]
 
 
308
        return self.trans_id_tree_path(os.path.dirname(path))
 
 
310
    def create_file(self, contents, trans_id, mode_id=None):
 
 
311
        """Schedule creation of a new file.
 
 
315
        Contents is an iterator of strings, all of which will be written
 
 
316
        to the target destination.
 
 
318
        New file takes the permissions of any existing file with that id,
 
 
319
        unless mode_id is specified.
 
 
321
        name = self._limbo_name(trans_id)
 
 
325
                unique_add(self._new_contents, trans_id, 'file')
 
 
327
                # Clean up the file, it never got registered so
 
 
328
                # TreeTransform.finalize() won't clean it up.
 
 
333
            f.writelines(contents)
 
 
336
        self._set_mode(trans_id, mode_id, S_ISREG)
 
 
338
    def _set_mode(self, trans_id, mode_id, typefunc):
 
 
339
        """Set the mode of new file contents.
 
 
340
        The mode_id is the existing file to get the mode from (often the same
 
 
341
        as trans_id).  The operation is only performed if there's a mode match
 
 
342
        according to typefunc.
 
 
347
            old_path = self._tree_id_paths[mode_id]
 
 
351
            mode = os.stat(self._tree.abspath(old_path)).st_mode
 
 
353
            if e.errno == errno.ENOENT:
 
 
358
            os.chmod(self._limbo_name(trans_id), mode)
 
 
360
    def create_directory(self, trans_id):
 
 
361
        """Schedule creation of a new directory.
 
 
363
        See also new_directory.
 
 
365
        os.mkdir(self._limbo_name(trans_id))
 
 
366
        unique_add(self._new_contents, trans_id, 'directory')
 
 
368
    def create_symlink(self, target, trans_id):
 
 
369
        """Schedule creation of a new symbolic link.
 
 
371
        target is a bytestring.
 
 
372
        See also new_symlink.
 
 
374
        os.symlink(target, self._limbo_name(trans_id))
 
 
375
        unique_add(self._new_contents, trans_id, 'symlink')
 
 
377
    def cancel_creation(self, trans_id):
 
 
378
        """Cancel the creation of new file contents."""
 
 
379
        del self._new_contents[trans_id]
 
 
380
        children = self._limbo_children.get(trans_id)
 
 
381
        # if this is a limbo directory with children, move them before removing
 
 
383
        if children is not None:
 
 
384
            self._rename_in_limbo(children)
 
 
385
            del self._limbo_children[trans_id]
 
 
386
            del self._limbo_children_names[trans_id]
 
 
387
        delete_any(self._limbo_name(trans_id))
 
 
389
    def delete_contents(self, trans_id):
 
 
390
        """Schedule the contents of a path entry for deletion"""
 
 
391
        self.tree_kind(trans_id)
 
 
392
        self._removed_contents.add(trans_id)
 
 
394
    def cancel_deletion(self, trans_id):
 
 
395
        """Cancel a scheduled deletion"""
 
 
396
        self._removed_contents.remove(trans_id)
 
 
398
    def unversion_file(self, trans_id):
 
 
399
        """Schedule a path entry to become unversioned"""
 
 
400
        self._removed_id.add(trans_id)
 
 
402
    def delete_versioned(self, trans_id):
 
 
403
        """Delete and unversion a versioned file"""
 
 
404
        self.delete_contents(trans_id)
 
 
405
        self.unversion_file(trans_id)
 
 
407
    def set_executability(self, executability, trans_id):
 
 
408
        """Schedule setting of the 'execute' bit
 
 
409
        To unschedule, set to None
 
 
411
        if executability is None:
 
 
412
            del self._new_executability[trans_id]
 
 
414
            unique_add(self._new_executability, trans_id, executability)
 
 
416
    def set_tree_reference(self, revision_id, trans_id):
 
 
417
        """Set the reference associated with a directory"""
 
 
418
        unique_add(self._new_reference_revision, trans_id, revision_id)
 
 
420
    def version_file(self, file_id, trans_id):
 
 
421
        """Schedule a file to become versioned."""
 
 
422
        assert file_id is not None
 
 
423
        unique_add(self._new_id, trans_id, file_id)
 
 
424
        unique_add(self._r_new_id, file_id, trans_id)
 
 
426
    def cancel_versioning(self, trans_id):
 
 
427
        """Undo a previous versioning of a file"""
 
 
428
        file_id = self._new_id[trans_id]
 
 
429
        del self._new_id[trans_id]
 
 
430
        del self._r_new_id[file_id]
 
 
433
        """Determine the paths of all new and changed files"""
 
 
435
        fp = FinalPaths(self)
 
 
436
        for id_set in (self._new_name, self._new_parent, self._new_contents,
 
 
437
                       self._new_id, self._new_executability):
 
 
438
            new_ids.update(id_set)
 
 
439
        new_paths = [(fp.get_path(t), t) for t in new_ids]
 
 
443
    def tree_kind(self, trans_id):
 
 
444
        """Determine the file kind in the working tree.
 
 
446
        Raises NoSuchFile if the file does not exist
 
 
448
        path = self._tree_id_paths.get(trans_id)
 
 
450
            raise NoSuchFile(None)
 
 
452
            return file_kind(self._tree.abspath(path))
 
 
454
            if e.errno != errno.ENOENT:
 
 
457
                raise NoSuchFile(path)
 
 
459
    def final_kind(self, trans_id):
 
 
460
        """Determine the final file kind, after any changes applied.
 
 
462
        Raises NoSuchFile if the file does not exist/has no contents.
 
 
463
        (It is conceivable that a path would be created without the
 
 
464
        corresponding contents insertion command)
 
 
466
        if trans_id in self._new_contents:
 
 
467
            return self._new_contents[trans_id]
 
 
468
        elif trans_id in self._removed_contents:
 
 
469
            raise NoSuchFile(None)
 
 
471
            return self.tree_kind(trans_id)
 
 
473
    def tree_file_id(self, trans_id):
 
 
474
        """Determine the file id associated with the trans_id in the tree"""
 
 
476
            path = self._tree_id_paths[trans_id]
 
 
478
            # the file is a new, unversioned file, or invalid trans_id
 
 
480
        # the file is old; the old id is still valid
 
 
481
        if self._new_root == trans_id:
 
 
482
            return self._tree.inventory.root.file_id
 
 
483
        return self._tree.inventory.path2id(path)
 
 
485
    def final_file_id(self, trans_id):
 
 
486
        """Determine the file id after any changes are applied, or None.
 
 
488
        None indicates that the file will not be versioned after changes are
 
 
492
            # there is a new id for this file
 
 
493
            assert self._new_id[trans_id] is not None
 
 
494
            return self._new_id[trans_id]
 
 
496
            if trans_id in self._removed_id:
 
 
498
        return self.tree_file_id(trans_id)
 
 
500
    def inactive_file_id(self, trans_id):
 
 
501
        """Return the inactive file_id associated with a transaction id.
 
 
502
        That is, the one in the tree or in non_present_ids.
 
 
503
        The file_id may actually be active, too.
 
 
505
        file_id = self.tree_file_id(trans_id)
 
 
506
        if file_id is not None:
 
 
508
        for key, value in self._non_present_ids.iteritems():
 
 
509
            if value == trans_id:
 
 
512
    def final_parent(self, trans_id):
 
 
513
        """Determine the parent file_id, after any changes are applied.
 
 
515
        ROOT_PARENT is returned for the tree root.
 
 
518
            return self._new_parent[trans_id]
 
 
520
            return self.get_tree_parent(trans_id)
 
 
522
    def final_name(self, trans_id):
 
 
523
        """Determine the final filename, after all changes are applied."""
 
 
525
            return self._new_name[trans_id]
 
 
528
                return os.path.basename(self._tree_id_paths[trans_id])
 
 
530
                raise NoFinalPath(trans_id, self)
 
 
533
        """Return a map of parent: children for known parents.
 
 
535
        Only new paths and parents of tree files with assigned ids are used.
 
 
538
        items = list(self._new_parent.iteritems())
 
 
539
        items.extend((t, self.final_parent(t)) for t in 
 
 
540
                      self._tree_id_paths.keys())
 
 
541
        for trans_id, parent_id in items:
 
 
542
            if parent_id not in by_parent:
 
 
543
                by_parent[parent_id] = set()
 
 
544
            by_parent[parent_id].add(trans_id)
 
 
547
    def path_changed(self, trans_id):
 
 
548
        """Return True if a trans_id's path has changed."""
 
 
549
        return (trans_id in self._new_name) or (trans_id in self._new_parent)
 
 
551
    def new_contents(self, trans_id):
 
 
552
        return (trans_id in self._new_contents)
 
 
554
    def find_conflicts(self):
 
 
555
        """Find any violations of inventory or filesystem invariants"""
 
 
556
        if self.__done is True:
 
 
557
            raise ReusingTransform()
 
 
559
        # ensure all children of all existent parents are known
 
 
560
        # all children of non-existent parents are known, by definition.
 
 
561
        self._add_tree_children()
 
 
562
        by_parent = self.by_parent()
 
 
563
        conflicts.extend(self._unversioned_parents(by_parent))
 
 
564
        conflicts.extend(self._parent_loops())
 
 
565
        conflicts.extend(self._duplicate_entries(by_parent))
 
 
566
        conflicts.extend(self._duplicate_ids())
 
 
567
        conflicts.extend(self._parent_type_conflicts(by_parent))
 
 
568
        conflicts.extend(self._improper_versioning())
 
 
569
        conflicts.extend(self._executability_conflicts())
 
 
570
        conflicts.extend(self._overwrite_conflicts())
 
 
573
    def _add_tree_children(self):
 
 
574
        """Add all the children of all active parents to the known paths.
 
 
576
        Active parents are those which gain children, and those which are
 
 
577
        removed.  This is a necessary first step in detecting conflicts.
 
 
579
        parents = self.by_parent().keys()
 
 
580
        parents.extend([t for t in self._removed_contents if 
 
 
581
                        self.tree_kind(t) == 'directory'])
 
 
582
        for trans_id in self._removed_id:
 
 
583
            file_id = self.tree_file_id(trans_id)
 
 
584
            if self._tree.inventory[file_id].kind == 'directory':
 
 
585
                parents.append(trans_id)
 
 
587
        for parent_id in parents:
 
 
588
            # ensure that all children are registered with the transaction
 
 
589
            list(self.iter_tree_children(parent_id))
 
 
591
    def iter_tree_children(self, parent_id):
 
 
592
        """Iterate through the entry's tree children, if any"""
 
 
594
            path = self._tree_id_paths[parent_id]
 
 
598
            children = os.listdir(self._tree.abspath(path))
 
 
600
            if e.errno != errno.ENOENT and e.errno != errno.ESRCH:
 
 
604
        for child in children:
 
 
605
            childpath = joinpath(path, child)
 
 
606
            if self._tree.is_control_filename(childpath):
 
 
608
            yield self.trans_id_tree_path(childpath)
 
 
610
    def has_named_child(self, by_parent, parent_id, name):
 
 
612
            children = by_parent[parent_id]
 
 
615
        for child in children:
 
 
616
            if self.final_name(child) == name:
 
 
619
            path = self._tree_id_paths[parent_id]
 
 
622
        childpath = joinpath(path, name)
 
 
623
        child_id = self._tree_path_ids.get(childpath)
 
 
625
            return lexists(self._tree.abspath(childpath))
 
 
627
            if self.final_parent(child_id) != parent_id:
 
 
629
            if child_id in self._removed_contents:
 
 
630
                # XXX What about dangling file-ids?
 
 
635
    def _parent_loops(self):
 
 
636
        """No entry should be its own ancestor"""
 
 
638
        for trans_id in self._new_parent:
 
 
641
            while parent_id is not ROOT_PARENT:
 
 
644
                    parent_id = self.final_parent(parent_id)
 
 
647
                if parent_id == trans_id:
 
 
648
                    conflicts.append(('parent loop', trans_id))
 
 
649
                if parent_id in seen:
 
 
653
    def _unversioned_parents(self, by_parent):
 
 
654
        """If parent directories are versioned, children must be versioned."""
 
 
656
        for parent_id, children in by_parent.iteritems():
 
 
657
            if parent_id is ROOT_PARENT:
 
 
659
            if self.final_file_id(parent_id) is not None:
 
 
661
            for child_id in children:
 
 
662
                if self.final_file_id(child_id) is not None:
 
 
663
                    conflicts.append(('unversioned parent', parent_id))
 
 
667
    def _improper_versioning(self):
 
 
668
        """Cannot version a file with no contents, or a bad type.
 
 
670
        However, existing entries with no contents are okay.
 
 
673
        for trans_id in self._new_id.iterkeys():
 
 
675
                kind = self.final_kind(trans_id)
 
 
677
                conflicts.append(('versioning no contents', trans_id))
 
 
679
            if not InventoryEntry.versionable_kind(kind):
 
 
680
                conflicts.append(('versioning bad kind', trans_id, kind))
 
 
683
    def _executability_conflicts(self):
 
 
684
        """Check for bad executability changes.
 
 
686
        Only versioned files may have their executability set, because
 
 
687
        1. only versioned entries can have executability under windows
 
 
688
        2. only files can be executable.  (The execute bit on a directory
 
 
689
           does not indicate searchability)
 
 
692
        for trans_id in self._new_executability:
 
 
693
            if self.final_file_id(trans_id) is None:
 
 
694
                conflicts.append(('unversioned executability', trans_id))
 
 
697
                    non_file = self.final_kind(trans_id) != "file"
 
 
701
                    conflicts.append(('non-file executability', trans_id))
 
 
704
    def _overwrite_conflicts(self):
 
 
705
        """Check for overwrites (not permitted on Win32)"""
 
 
707
        for trans_id in self._new_contents:
 
 
709
                self.tree_kind(trans_id)
 
 
712
            if trans_id not in self._removed_contents:
 
 
713
                conflicts.append(('overwrite', trans_id,
 
 
714
                                 self.final_name(trans_id)))
 
 
717
    def _duplicate_entries(self, by_parent):
 
 
718
        """No directory may have two entries with the same name."""
 
 
720
        for children in by_parent.itervalues():
 
 
721
            name_ids = [(self.final_name(t), t) for t in children]
 
 
725
            for name, trans_id in name_ids:
 
 
727
                    kind = self.final_kind(trans_id)
 
 
730
                file_id = self.final_file_id(trans_id)
 
 
731
                if kind is None and file_id is None:
 
 
733
                if name == last_name:
 
 
734
                    conflicts.append(('duplicate', last_trans_id, trans_id,
 
 
737
                last_trans_id = trans_id
 
 
740
    def _duplicate_ids(self):
 
 
741
        """Each inventory id may only be used once"""
 
 
743
        removed_tree_ids = set((self.tree_file_id(trans_id) for trans_id in
 
 
745
        active_tree_ids = set((f for f in self._tree.inventory if
 
 
746
                               f not in removed_tree_ids))
 
 
747
        for trans_id, file_id in self._new_id.iteritems():
 
 
748
            if file_id in active_tree_ids:
 
 
749
                old_trans_id = self.trans_id_tree_file_id(file_id)
 
 
750
                conflicts.append(('duplicate id', old_trans_id, trans_id))
 
 
753
    def _parent_type_conflicts(self, by_parent):
 
 
754
        """parents must have directory 'contents'."""
 
 
756
        for parent_id, children in by_parent.iteritems():
 
 
757
            if parent_id is ROOT_PARENT:
 
 
759
            if not self._any_contents(children):
 
 
761
            for child in children:
 
 
763
                    self.final_kind(child)
 
 
767
                kind = self.final_kind(parent_id)
 
 
771
                conflicts.append(('missing parent', parent_id))
 
 
772
            elif kind != "directory":
 
 
773
                conflicts.append(('non-directory parent', parent_id))
 
 
776
    def _any_contents(self, trans_ids):
 
 
777
        """Return true if any of the trans_ids, will have contents."""
 
 
778
        for trans_id in trans_ids:
 
 
780
                kind = self.final_kind(trans_id)
 
 
787
        """Apply all changes to the inventory and filesystem.
 
 
789
        If filesystem or inventory conflicts are present, MalformedTransform
 
 
792
        If apply succeeds, finalize is not necessary.
 
 
794
        conflicts = self.find_conflicts()
 
 
795
        if len(conflicts) != 0:
 
 
796
            raise MalformedTransform(conflicts=conflicts)
 
 
797
        inv = self._tree.inventory
 
 
799
        child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
 
801
            child_pb.update('Apply phase', 0, 2)
 
 
802
            self._apply_removals(inv, inventory_delta)
 
 
803
            child_pb.update('Apply phase', 1, 2)
 
 
804
            modified_paths = self._apply_insertions(inv, inventory_delta)
 
 
807
        self._tree.apply_inventory_delta(inventory_delta)
 
 
810
        return _TransformResults(modified_paths, self.rename_count)
 
 
812
    def _limbo_name(self, trans_id):
 
 
813
        """Generate the limbo name of a file"""
 
 
814
        limbo_name = self._limbo_files.get(trans_id)
 
 
815
        if limbo_name is not None:
 
 
817
        parent = self._new_parent.get(trans_id)
 
 
818
        # if the parent directory is already in limbo (e.g. when building a
 
 
819
        # tree), choose a limbo name inside the parent, to reduce further
 
 
821
        use_direct_path = False
 
 
822
        if self._new_contents.get(parent) == 'directory':
 
 
823
            filename = self._new_name.get(trans_id)
 
 
824
            if filename is not None:
 
 
825
                if parent not in self._limbo_children:
 
 
826
                    self._limbo_children[parent] = set()
 
 
827
                    self._limbo_children_names[parent] = {}
 
 
828
                    use_direct_path = True
 
 
829
                # the direct path can only be used if no other file has
 
 
830
                # already taken this pathname, i.e. if the name is unused, or
 
 
831
                # if it is already associated with this trans_id.
 
 
832
                elif (self._limbo_children_names[parent].get(filename)
 
 
833
                      in (trans_id, None)):
 
 
834
                    use_direct_path = True
 
 
836
            limbo_name = pathjoin(self._limbo_files[parent], filename)
 
 
837
            self._limbo_children[parent].add(trans_id)
 
 
838
            self._limbo_children_names[parent][filename] = trans_id
 
 
840
            limbo_name = pathjoin(self._limbodir, trans_id)
 
 
841
            self._needs_rename.add(trans_id)
 
 
842
        self._limbo_files[trans_id] = limbo_name
 
 
845
    def _apply_removals(self, inv, inventory_delta):
 
 
846
        """Perform tree operations that remove directory/inventory names.
 
 
848
        That is, delete files that are to be deleted, and put any files that
 
 
849
        need renaming into limbo.  This must be done in strict child-to-parent
 
 
852
        tree_paths = list(self._tree_path_ids.iteritems())
 
 
853
        tree_paths.sort(reverse=True)
 
 
854
        child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
 
856
            for num, data in enumerate(tree_paths):
 
 
857
                path, trans_id = data
 
 
858
                child_pb.update('removing file', num, len(tree_paths))
 
 
859
                full_path = self._tree.abspath(path)
 
 
860
                if trans_id in self._removed_contents:
 
 
861
                    delete_any(full_path)
 
 
862
                elif trans_id in self._new_name or trans_id in \
 
 
865
                        os.rename(full_path, self._limbo_name(trans_id))
 
 
867
                        if e.errno != errno.ENOENT:
 
 
870
                        self.rename_count += 1
 
 
871
                if trans_id in self._removed_id:
 
 
872
                    if trans_id == self._new_root:
 
 
873
                        file_id = self._tree.inventory.root.file_id
 
 
875
                        file_id = self.tree_file_id(trans_id)
 
 
876
                    assert file_id is not None
 
 
877
                    inventory_delta.append((path, None, file_id, None))
 
 
881
    def _apply_insertions(self, inv, inventory_delta):
 
 
882
        """Perform tree operations that insert directory/inventory names.
 
 
884
        That is, create any files that need to be created, and restore from
 
 
885
        limbo any files that needed renaming.  This must be done in strict
 
 
886
        parent-to-child order.
 
 
888
        new_paths = self.new_paths()
 
 
890
        child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
 
892
            for num, (path, trans_id) in enumerate(new_paths):
 
 
894
                child_pb.update('adding file', num, len(new_paths))
 
 
896
                    kind = self._new_contents[trans_id]
 
 
898
                    kind = contents = None
 
 
899
                if trans_id in self._new_contents or \
 
 
900
                    self.path_changed(trans_id):
 
 
901
                    full_path = self._tree.abspath(path)
 
 
902
                    if trans_id in self._needs_rename:
 
 
904
                            os.rename(self._limbo_name(trans_id), full_path)
 
 
906
                            # We may be renaming a dangling inventory id
 
 
907
                            if e.errno != errno.ENOENT:
 
 
910
                            self.rename_count += 1
 
 
911
                    if trans_id in self._new_contents:
 
 
912
                        modified_paths.append(full_path)
 
 
913
                        del self._new_contents[trans_id]
 
 
915
                if trans_id in self._new_id:
 
 
917
                        kind = file_kind(self._tree.abspath(path))
 
 
918
                    if trans_id in self._new_reference_revision:
 
 
919
                        new_entry = inventory.TreeReference(
 
 
920
                            self._new_id[trans_id],
 
 
921
                            self._new_name[trans_id], 
 
 
922
                            self.final_file_id(self._new_parent[trans_id]),
 
 
923
                            None, self._new_reference_revision[trans_id])
 
 
925
                        new_entry = inventory.make_entry(kind,
 
 
926
                            self.final_name(trans_id),
 
 
927
                            self.final_file_id(self.final_parent(trans_id)),
 
 
928
                            self._new_id[trans_id])
 
 
930
                    if trans_id in self._new_name or trans_id in\
 
 
932
                        trans_id in self._new_executability:
 
 
933
                        file_id = self.final_file_id(trans_id)
 
 
934
                        if file_id is not None:
 
 
936
                            new_entry = entry.copy()
 
 
938
                    if trans_id in self._new_name or trans_id in\
 
 
940
                            if new_entry is not None:
 
 
941
                                new_entry.name = self.final_name(trans_id)
 
 
942
                                parent = self.final_parent(trans_id)
 
 
943
                                parent_id = self.final_file_id(parent)
 
 
944
                                new_entry.parent_id = parent_id
 
 
946
                if trans_id in self._new_executability:
 
 
947
                    self._set_executability(path, new_entry, trans_id)
 
 
948
                if new_entry is not None:
 
 
949
                    if new_entry.file_id in inv:
 
 
950
                        old_path = inv.id2path(new_entry.file_id)
 
 
953
                    inventory_delta.append((old_path, path,
 
 
958
        return modified_paths
 
 
960
    def _set_executability(self, path, entry, trans_id):
 
 
961
        """Set the executability of versioned files """
 
 
962
        new_executability = self._new_executability[trans_id]
 
 
963
        entry.executable = new_executability
 
 
964
        if supports_executable():
 
 
965
            abspath = self._tree.abspath(path)
 
 
966
            current_mode = os.stat(abspath).st_mode
 
 
967
            if new_executability:
 
 
970
                to_mode = current_mode | (0100 & ~umask)
 
 
971
                # Enable x-bit for others only if they can read it.
 
 
972
                if current_mode & 0004:
 
 
973
                    to_mode |= 0001 & ~umask
 
 
974
                if current_mode & 0040:
 
 
975
                    to_mode |= 0010 & ~umask
 
 
977
                to_mode = current_mode & ~0111
 
 
978
            os.chmod(abspath, to_mode)
 
 
980
    def _new_entry(self, name, parent_id, file_id):
 
 
981
        """Helper function to create a new filesystem entry."""
 
 
982
        trans_id = self.create_path(name, parent_id)
 
 
983
        if file_id is not None:
 
 
984
            self.version_file(file_id, trans_id)
 
 
987
    def new_file(self, name, parent_id, contents, file_id=None, 
 
 
989
        """Convenience method to create files.
 
 
991
        name is the name of the file to create.
 
 
992
        parent_id is the transaction id of the parent directory of the file.
 
 
993
        contents is an iterator of bytestrings, which will be used to produce
 
 
995
        :param file_id: The inventory ID of the file, if it is to be versioned.
 
 
996
        :param executable: Only valid when a file_id has been supplied.
 
 
998
        trans_id = self._new_entry(name, parent_id, file_id)
 
 
999
        # TODO: rather than scheduling a set_executable call,
 
 
1000
        # have create_file create the file with the right mode.
 
 
1001
        self.create_file(contents, trans_id)
 
 
1002
        if executable is not None:
 
 
1003
            self.set_executability(executable, trans_id)
 
 
1006
    def new_directory(self, name, parent_id, file_id=None):
 
 
1007
        """Convenience method to create directories.
 
 
1009
        name is the name of the directory to create.
 
 
1010
        parent_id is the transaction id of the parent directory of the
 
 
1012
        file_id is the inventory ID of the directory, if it is to be versioned.
 
 
1014
        trans_id = self._new_entry(name, parent_id, file_id)
 
 
1015
        self.create_directory(trans_id)
 
 
1018
    def new_symlink(self, name, parent_id, target, file_id=None):
 
 
1019
        """Convenience method to create symbolic link.
 
 
1021
        name is the name of the symlink to create.
 
 
1022
        parent_id is the transaction id of the parent directory of the symlink.
 
 
1023
        target is a bytestring of the target of the symlink.
 
 
1024
        file_id is the inventory ID of the file, if it is to be versioned.
 
 
1026
        trans_id = self._new_entry(name, parent_id, file_id)
 
 
1027
        self.create_symlink(target, trans_id)
 
 
1030
    def _affected_ids(self):
 
 
1031
        """Return the set of transform ids affected by the transform"""
 
 
1032
        trans_ids = set(self._removed_id)
 
 
1033
        trans_ids.update(self._new_id.keys())
 
 
1034
        trans_ids.update(self._removed_contents)
 
 
1035
        trans_ids.update(self._new_contents.keys())
 
 
1036
        trans_ids.update(self._new_executability.keys())
 
 
1037
        trans_ids.update(self._new_name.keys())
 
 
1038
        trans_ids.update(self._new_parent.keys())
 
 
1041
    def _get_file_id_maps(self):
 
 
1042
        """Return mapping of file_ids to trans_ids in the to and from states"""
 
 
1043
        trans_ids = self._affected_ids()
 
 
1046
        # Build up two dicts: trans_ids associated with file ids in the
 
 
1047
        # FROM state, vs the TO state.
 
 
1048
        for trans_id in trans_ids:
 
 
1049
            from_file_id = self.tree_file_id(trans_id)
 
 
1050
            if from_file_id is not None:
 
 
1051
                from_trans_ids[from_file_id] = trans_id
 
 
1052
            to_file_id = self.final_file_id(trans_id)
 
 
1053
            if to_file_id is not None:
 
 
1054
                to_trans_ids[to_file_id] = trans_id
 
 
1055
        return from_trans_ids, to_trans_ids
 
 
1057
    def _from_file_data(self, from_trans_id, from_versioned, file_id):
 
 
1058
        """Get data about a file in the from (tree) state
 
 
1060
        Return a (name, parent, kind, executable) tuple
 
 
1062
        from_path = self._tree_id_paths.get(from_trans_id)
 
 
1064
            # get data from working tree if versioned
 
 
1065
            from_entry = self._tree.inventory[file_id]
 
 
1066
            from_name = from_entry.name
 
 
1067
            from_parent = from_entry.parent_id
 
 
1070
            if from_path is None:
 
 
1071
                # File does not exist in FROM state
 
 
1075
                # File exists, but is not versioned.  Have to use path-
 
 
1077
                from_name = os.path.basename(from_path)
 
 
1078
                tree_parent = self.get_tree_parent(from_trans_id)
 
 
1079
                from_parent = self.tree_file_id(tree_parent)
 
 
1080
        if from_path is not None:
 
 
1081
            from_kind, from_executable, from_stats = \
 
 
1082
                self._tree._comparison_data(from_entry, from_path)
 
 
1085
            from_executable = False
 
 
1086
        return from_name, from_parent, from_kind, from_executable
 
 
1088
    def _to_file_data(self, to_trans_id, from_trans_id, from_executable):
 
 
1089
        """Get data about a file in the to (target) state
 
 
1091
        Return a (name, parent, kind, executable) tuple
 
 
1093
        to_name = self.final_name(to_trans_id)
 
 
1095
            to_kind = self.final_kind(to_trans_id)
 
 
1098
        to_parent = self.final_file_id(self.final_parent(to_trans_id))
 
 
1099
        if to_trans_id in self._new_executability:
 
 
1100
            to_executable = self._new_executability[to_trans_id]
 
 
1101
        elif to_trans_id == from_trans_id:
 
 
1102
            to_executable = from_executable
 
 
1104
            to_executable = False
 
 
1105
        return to_name, to_parent, to_kind, to_executable
 
 
1107
    def _iter_changes(self):
 
 
1108
        """Produce output in the same format as Tree._iter_changes.
 
 
1110
        Will produce nonsensical results if invoked while inventory/filesystem
 
 
1111
        conflicts (as reported by TreeTransform.find_conflicts()) are present.
 
 
1113
        This reads the Transform, but only reproduces changes involving a
 
 
1114
        file_id.  Files that are not versioned in either of the FROM or TO
 
 
1115
        states are not reflected.
 
 
1117
        final_paths = FinalPaths(self)
 
 
1118
        from_trans_ids, to_trans_ids = self._get_file_id_maps()
 
 
1120
        # Now iterate through all active file_ids
 
 
1121
        for file_id in set(from_trans_ids.keys() + to_trans_ids.keys()):
 
 
1123
            from_trans_id = from_trans_ids.get(file_id)
 
 
1124
            # find file ids, and determine versioning state
 
 
1125
            if from_trans_id is None:
 
 
1126
                from_versioned = False
 
 
1127
                from_trans_id = to_trans_ids[file_id]
 
 
1129
                from_versioned = True
 
 
1130
            to_trans_id = to_trans_ids.get(file_id)
 
 
1131
            if to_trans_id is None:
 
 
1132
                to_versioned = False
 
 
1133
                to_trans_id = from_trans_id
 
 
1137
            from_name, from_parent, from_kind, from_executable = \
 
 
1138
                self._from_file_data(from_trans_id, from_versioned, file_id)
 
 
1140
            to_name, to_parent, to_kind, to_executable = \
 
 
1141
                self._to_file_data(to_trans_id, from_trans_id, from_executable)
 
 
1143
            if not from_versioned:
 
 
1146
                from_path = self._tree_id_paths.get(from_trans_id)
 
 
1147
            if not to_versioned:
 
 
1150
                to_path = final_paths.get_path(to_trans_id)
 
 
1151
            if from_kind != to_kind:
 
 
1153
            elif to_kind in ('file', 'symlink') and (
 
 
1154
                to_trans_id != from_trans_id or
 
 
1155
                to_trans_id in self._new_contents):
 
 
1157
            if (not modified and from_versioned == to_versioned and
 
 
1158
                from_parent==to_parent and from_name == to_name and
 
 
1159
                from_executable == to_executable):
 
 
1161
            results.append((file_id, (from_path, to_path), modified,
 
 
1162
                   (from_versioned, to_versioned),
 
 
1163
                   (from_parent, to_parent),
 
 
1164
                   (from_name, to_name),
 
 
1165
                   (from_kind, to_kind),
 
 
1166
                   (from_executable, to_executable)))
 
 
1167
        return iter(sorted(results, key=lambda x:x[1]))
 
 
1170
def joinpath(parent, child):
 
 
1171
    """Join tree-relative paths, handling the tree root specially"""
 
 
1172
    if parent is None or parent == "":
 
 
1175
        return pathjoin(parent, child)
 
 
1178
class FinalPaths(object):
 
 
1179
    """Make path calculation cheap by memoizing paths.
 
 
1181
    The underlying tree must not be manipulated between calls, or else
 
 
1182
    the results will likely be incorrect.
 
 
1184
    def __init__(self, transform):
 
 
1185
        object.__init__(self)
 
 
1186
        self._known_paths = {}
 
 
1187
        self.transform = transform
 
 
1189
    def _determine_path(self, trans_id):
 
 
1190
        if trans_id == self.transform.root:
 
 
1192
        name = self.transform.final_name(trans_id)
 
 
1193
        parent_id = self.transform.final_parent(trans_id)
 
 
1194
        if parent_id == self.transform.root:
 
 
1197
            return pathjoin(self.get_path(parent_id), name)
 
 
1199
    def get_path(self, trans_id):
 
 
1200
        """Find the final path associated with a trans_id"""
 
 
1201
        if trans_id not in self._known_paths:
 
 
1202
            self._known_paths[trans_id] = self._determine_path(trans_id)
 
 
1203
        return self._known_paths[trans_id]
 
 
1205
def topology_sorted_ids(tree):
 
 
1206
    """Determine the topological order of the ids in a tree"""
 
 
1207
    file_ids = list(tree)
 
 
1208
    file_ids.sort(key=tree.id2path)
 
 
1212
def build_tree(tree, wt):
 
 
1213
    """Create working tree for a branch, using a TreeTransform.
 
 
1215
    This function should be used on empty trees, having a tree root at most.
 
 
1216
    (see merge and revert functionality for working with existing trees)
 
 
1218
    Existing files are handled like so:
 
 
1220
    - Existing bzrdirs take precedence over creating new items.  They are
 
 
1221
      created as '%s.diverted' % name.
 
 
1222
    - Otherwise, if the content on disk matches the content we are building,
 
 
1223
      it is silently replaced.
 
 
1224
    - Otherwise, conflict resolution will move the old file to 'oldname.moved'.
 
 
1226
    wt.lock_tree_write()
 
 
1230
            return _build_tree(tree, wt)
 
 
1236
def _build_tree(tree, wt):
 
 
1237
    """See build_tree."""
 
 
1238
    if len(wt.inventory) > 1:  # more than just a root
 
 
1239
        raise errors.WorkingTreeAlreadyPopulated(base=wt.basedir)
 
 
1241
    top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
 
1242
    pp = ProgressPhase("Build phase", 2, top_pb)
 
 
1243
    if tree.inventory.root is not None:
 
 
1244
        # This is kind of a hack: we should be altering the root
 
 
1245
        # as part of the regular tree shape diff logic.
 
 
1246
        # The conditional test here is to avoid doing an
 
 
1247
        # expensive operation (flush) every time the root id
 
 
1248
        # is set within the tree, nor setting the root and thus
 
 
1249
        # marking the tree as dirty, because we use two different
 
 
1250
        # idioms here: tree interfaces and inventory interfaces.
 
 
1251
        if wt.path2id('') != tree.inventory.root.file_id:
 
 
1252
            wt.set_root_id(tree.inventory.root.file_id)
 
 
1254
    tt = TreeTransform(wt)
 
 
1258
        file_trans_id[wt.get_root_id()] = \
 
 
1259
            tt.trans_id_tree_file_id(wt.get_root_id())
 
 
1260
        pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
 
1262
            for num, (tree_path, entry) in \
 
 
1263
                enumerate(tree.inventory.iter_entries_by_dir()):
 
 
1264
                pb.update("Building tree", num, len(tree.inventory))
 
 
1265
                if entry.parent_id is None:
 
 
1268
                file_id = entry.file_id
 
 
1269
                target_path = wt.abspath(tree_path)
 
 
1271
                    kind = file_kind(target_path)
 
 
1275
                    if kind == "directory":
 
 
1277
                            bzrdir.BzrDir.open(target_path)
 
 
1278
                        except errors.NotBranchError:
 
 
1282
                    if (file_id not in divert and
 
 
1283
                        _content_match(tree, entry, file_id, kind,
 
 
1285
                        tt.delete_contents(tt.trans_id_tree_path(tree_path))
 
 
1286
                        if kind == 'directory':
 
 
1288
                if entry.parent_id not in file_trans_id:
 
 
1289
                    raise AssertionError(
 
 
1290
                        'entry %s parent id %r is not in file_trans_id %r'
 
 
1291
                        % (entry, entry.parent_id, file_trans_id))
 
 
1292
                parent_id = file_trans_id[entry.parent_id]
 
 
1293
                file_trans_id[file_id] = new_by_entry(tt, entry, parent_id,
 
 
1296
                    new_trans_id = file_trans_id[file_id]
 
 
1297
                    old_parent = tt.trans_id_tree_path(tree_path)
 
 
1298
                    _reparent_children(tt, old_parent, new_trans_id)
 
 
1302
        divert_trans = set(file_trans_id[f] for f in divert)
 
 
1303
        resolver = lambda t, c: resolve_checkout(t, c, divert_trans)
 
 
1304
        raw_conflicts = resolve_conflicts(tt, pass_func=resolver)
 
 
1305
        conflicts = cook_conflicts(raw_conflicts, tt)
 
 
1306
        for conflict in conflicts:
 
 
1309
            wt.add_conflicts(conflicts)
 
 
1310
        except errors.UnsupportedOperation:
 
 
1319
def _reparent_children(tt, old_parent, new_parent):
 
 
1320
    for child in tt.iter_tree_children(old_parent):
 
 
1321
        tt.adjust_path(tt.final_name(child), new_parent, child)
 
 
1324
def _content_match(tree, entry, file_id, kind, target_path):
 
 
1325
    if entry.kind != kind:
 
 
1327
    if entry.kind == "directory":
 
 
1329
    if entry.kind == "file":
 
 
1330
        if tree.get_file(file_id).read() == file(target_path, 'rb').read():
 
 
1332
    elif entry.kind == "symlink":
 
 
1333
        if tree.get_symlink_target(file_id) == os.readlink(target_path):
 
 
1338
def resolve_checkout(tt, conflicts, divert):
 
 
1339
    new_conflicts = set()
 
 
1340
    for c_type, conflict in ((c[0], c) for c in conflicts):
 
 
1341
        # Anything but a 'duplicate' would indicate programmer error
 
 
1342
        assert c_type == 'duplicate', c_type
 
 
1343
        # Now figure out which is new and which is old
 
 
1344
        if tt.new_contents(conflict[1]):
 
 
1345
            new_file = conflict[1]
 
 
1346
            old_file = conflict[2]
 
 
1348
            new_file = conflict[2]
 
 
1349
            old_file = conflict[1]
 
 
1351
        # We should only get here if the conflict wasn't completely
 
 
1353
        final_parent = tt.final_parent(old_file)
 
 
1354
        if new_file in divert:
 
 
1355
            new_name = tt.final_name(old_file)+'.diverted'
 
 
1356
            tt.adjust_path(new_name, final_parent, new_file)
 
 
1357
            new_conflicts.add((c_type, 'Diverted to',
 
 
1358
                               new_file, old_file))
 
 
1360
            new_name = tt.final_name(old_file)+'.moved'
 
 
1361
            tt.adjust_path(new_name, final_parent, old_file)
 
 
1362
            new_conflicts.add((c_type, 'Moved existing file to',
 
 
1363
                               old_file, new_file))
 
 
1364
    return new_conflicts
 
 
1367
def new_by_entry(tt, entry, parent_id, tree):
 
 
1368
    """Create a new file according to its inventory entry"""
 
 
1372
        contents = tree.get_file(entry.file_id).readlines()
 
 
1373
        executable = tree.is_executable(entry.file_id)
 
 
1374
        return tt.new_file(name, parent_id, contents, entry.file_id, 
 
 
1376
    elif kind in ('directory', 'tree-reference'):
 
 
1377
        trans_id = tt.new_directory(name, parent_id, entry.file_id)
 
 
1378
        if kind == 'tree-reference':
 
 
1379
            tt.set_tree_reference(entry.reference_revision, trans_id)
 
 
1381
    elif kind == 'symlink':
 
 
1382
        target = tree.get_symlink_target(entry.file_id)
 
 
1383
        return tt.new_symlink(name, parent_id, target, entry.file_id)
 
 
1385
        raise errors.BadFileKindError(name, kind)
 
 
1387
def create_by_entry(tt, entry, tree, trans_id, lines=None, mode_id=None):
 
 
1388
    """Create new file contents according to an inventory entry."""
 
 
1389
    if entry.kind == "file":
 
 
1391
            lines = tree.get_file(entry.file_id).readlines()
 
 
1392
        tt.create_file(lines, trans_id, mode_id=mode_id)
 
 
1393
    elif entry.kind == "symlink":
 
 
1394
        tt.create_symlink(tree.get_symlink_target(entry.file_id), trans_id)
 
 
1395
    elif entry.kind == "directory":
 
 
1396
        tt.create_directory(trans_id)
 
 
1398
def create_entry_executability(tt, entry, trans_id):
 
 
1399
    """Set the executability of a trans_id according to an inventory entry"""
 
 
1400
    if entry.kind == "file":
 
 
1401
        tt.set_executability(entry.executable, trans_id)
 
 
1404
@deprecated_function(zero_fifteen)
 
 
1405
def find_interesting(working_tree, target_tree, filenames):
 
 
1406
    """Find the ids corresponding to specified filenames.
 
 
1408
    Deprecated: Please use tree1.paths2ids(filenames, [tree2]).
 
 
1410
    working_tree.lock_read()
 
 
1412
        target_tree.lock_read()
 
 
1414
            return working_tree.paths2ids(filenames, [target_tree])
 
 
1416
            target_tree.unlock()
 
 
1418
        working_tree.unlock()
 
 
1421
def change_entry(tt, file_id, working_tree, target_tree, 
 
 
1422
                 trans_id_file_id, backups, trans_id, by_parent):
 
 
1423
    """Replace a file_id's contents with those from a target tree."""
 
 
1424
    e_trans_id = trans_id_file_id(file_id)
 
 
1425
    entry = target_tree.inventory[file_id]
 
 
1426
    has_contents, contents_mod, meta_mod, = _entry_changes(file_id, entry, 
 
 
1429
        mode_id = e_trans_id
 
 
1432
                tt.delete_contents(e_trans_id)
 
 
1434
                parent_trans_id = trans_id_file_id(entry.parent_id)
 
 
1435
                backup_name = get_backup_name(entry, by_parent,
 
 
1436
                                              parent_trans_id, tt)
 
 
1437
                tt.adjust_path(backup_name, parent_trans_id, e_trans_id)
 
 
1438
                tt.unversion_file(e_trans_id)
 
 
1439
                e_trans_id = tt.create_path(entry.name, parent_trans_id)
 
 
1440
                tt.version_file(file_id, e_trans_id)
 
 
1441
                trans_id[file_id] = e_trans_id
 
 
1442
        create_by_entry(tt, entry, target_tree, e_trans_id, mode_id=mode_id)
 
 
1443
        create_entry_executability(tt, entry, e_trans_id)
 
 
1446
        tt.set_executability(entry.executable, e_trans_id)
 
 
1447
    if tt.final_name(e_trans_id) != entry.name:
 
 
1450
        parent_id = tt.final_parent(e_trans_id)
 
 
1451
        parent_file_id = tt.final_file_id(parent_id)
 
 
1452
        if parent_file_id != entry.parent_id:
 
 
1457
        parent_trans_id = trans_id_file_id(entry.parent_id)
 
 
1458
        tt.adjust_path(entry.name, parent_trans_id, e_trans_id)
 
 
1461
def get_backup_name(entry, by_parent, parent_trans_id, tt):
 
 
1462
    return _get_backup_name(entry.name, by_parent, parent_trans_id, tt)
 
 
1465
def _get_backup_name(name, by_parent, parent_trans_id, tt):
 
 
1466
    """Produce a backup-style name that appears to be available"""
 
 
1470
            yield "%s.~%d~" % (name, counter)
 
 
1472
    for new_name in name_gen():
 
 
1473
        if not tt.has_named_child(by_parent, parent_trans_id, new_name):
 
 
1477
def _entry_changes(file_id, entry, working_tree):
 
 
1478
    """Determine in which ways the inventory entry has changed.
 
 
1480
    Returns booleans: has_contents, content_mod, meta_mod
 
 
1481
    has_contents means there are currently contents, but they differ
 
 
1482
    contents_mod means contents need to be modified
 
 
1483
    meta_mod means the metadata needs to be modified
 
 
1485
    cur_entry = working_tree.inventory[file_id]
 
 
1487
        working_kind = working_tree.kind(file_id)
 
 
1490
        has_contents = False
 
 
1493
    if has_contents is True:
 
 
1494
        if entry.kind != working_kind:
 
 
1495
            contents_mod, meta_mod = True, False
 
 
1497
            cur_entry._read_tree_state(working_tree.id2path(file_id), 
 
 
1499
            contents_mod, meta_mod = entry.detect_changes(cur_entry)
 
 
1500
            cur_entry._forget_tree_state()
 
 
1501
    return has_contents, contents_mod, meta_mod
 
 
1504
def revert(working_tree, target_tree, filenames, backups=False,
 
 
1505
           pb=DummyProgress(), change_reporter=None):
 
 
1506
    """Revert a working tree's contents to those of a target tree."""
 
 
1507
    target_tree.lock_read()
 
 
1508
    tt = TreeTransform(working_tree, pb)
 
 
1510
        pp = ProgressPhase("Revert phase", 3, pb)
 
 
1512
        child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
 
1514
            merge_modified = _alter_files(working_tree, target_tree, tt,
 
 
1515
                                          child_pb, filenames, backups)
 
 
1519
        child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
 
1521
            raw_conflicts = resolve_conflicts(tt, child_pb)
 
 
1524
        conflicts = cook_conflicts(raw_conflicts, tt)
 
 
1526
            change_reporter = delta._ChangeReporter(
 
 
1527
                unversioned_filter=working_tree.is_ignored)
 
 
1528
            delta.report_changes(tt._iter_changes(), change_reporter)
 
 
1529
        for conflict in conflicts:
 
 
1533
        working_tree.set_merge_modified(merge_modified)
 
 
1535
        target_tree.unlock()
 
 
1541
def _alter_files(working_tree, target_tree, tt, pb, specific_files,
 
 
1543
    merge_modified = working_tree.merge_modified()
 
 
1544
    change_list = target_tree._iter_changes(working_tree,
 
 
1545
        specific_files=specific_files, pb=pb)
 
 
1546
    if target_tree.inventory.root is None:
 
 
1552
        for id_num, (file_id, path, changed_content, versioned, parent, name,
 
 
1553
                kind, executable) in enumerate(change_list):
 
 
1554
            if skip_root and file_id[0] is not None and parent[0] is None:
 
 
1556
            trans_id = tt.trans_id_file_id(file_id)
 
 
1559
                keep_content = False
 
 
1560
                if kind[0] == 'file' and (backups or kind[1] is None):
 
 
1561
                    wt_sha1 = working_tree.get_file_sha1(file_id)
 
 
1562
                    if merge_modified.get(file_id) != wt_sha1:
 
 
1563
                        # acquire the basis tree lazily to prevent the
 
 
1564
                        # expense of accessing it when it's not needed ?
 
 
1565
                        # (Guessing, RBC, 200702)
 
 
1566
                        if basis_tree is None:
 
 
1567
                            basis_tree = working_tree.basis_tree()
 
 
1568
                            basis_tree.lock_read()
 
 
1569
                        if file_id in basis_tree:
 
 
1570
                            if wt_sha1 != basis_tree.get_file_sha1(file_id):
 
 
1572
                        elif kind[1] is None and not versioned[1]:
 
 
1574
                if kind[0] is not None:
 
 
1575
                    if not keep_content:
 
 
1576
                        tt.delete_contents(trans_id)
 
 
1577
                    elif kind[1] is not None:
 
 
1578
                        parent_trans_id = tt.trans_id_file_id(parent[0])
 
 
1579
                        by_parent = tt.by_parent()
 
 
1580
                        backup_name = _get_backup_name(name[0], by_parent,
 
 
1581
                                                       parent_trans_id, tt)
 
 
1582
                        tt.adjust_path(backup_name, parent_trans_id, trans_id)
 
 
1583
                        new_trans_id = tt.create_path(name[0], parent_trans_id)
 
 
1584
                        if versioned == (True, True):
 
 
1585
                            tt.unversion_file(trans_id)
 
 
1586
                            tt.version_file(file_id, new_trans_id)
 
 
1587
                        # New contents should have the same unix perms as old
 
 
1590
                        trans_id = new_trans_id
 
 
1591
                if kind[1] == 'directory':
 
 
1592
                    tt.create_directory(trans_id)
 
 
1593
                elif kind[1] == 'symlink':
 
 
1594
                    tt.create_symlink(target_tree.get_symlink_target(file_id),
 
 
1596
                elif kind[1] == 'file':
 
 
1597
                    tt.create_file(target_tree.get_file_lines(file_id),
 
 
1599
                    if basis_tree is None:
 
 
1600
                        basis_tree = working_tree.basis_tree()
 
 
1601
                        basis_tree.lock_read()
 
 
1602
                    new_sha1 = target_tree.get_file_sha1(file_id)
 
 
1603
                    if (file_id in basis_tree and new_sha1 ==
 
 
1604
                        basis_tree.get_file_sha1(file_id)):
 
 
1605
                        if file_id in merge_modified:
 
 
1606
                            del merge_modified[file_id]
 
 
1608
                        merge_modified[file_id] = new_sha1
 
 
1610
                    # preserve the execute bit when backing up
 
 
1611
                    if keep_content and executable[0] == executable[1]:
 
 
1612
                        tt.set_executability(executable[1], trans_id)
 
 
1614
                    assert kind[1] is None
 
 
1615
            if versioned == (False, True):
 
 
1616
                tt.version_file(file_id, trans_id)
 
 
1617
            if versioned == (True, False):
 
 
1618
                tt.unversion_file(trans_id)
 
 
1619
            if (name[1] is not None and 
 
 
1620
                (name[0] != name[1] or parent[0] != parent[1])):
 
 
1622
                    name[1], tt.trans_id_file_id(parent[1]), trans_id)
 
 
1623
            if executable[0] != executable[1] and kind[1] == "file":
 
 
1624
                tt.set_executability(executable[1], trans_id)
 
 
1626
        if basis_tree is not None:
 
 
1628
    return merge_modified
 
 
1631
def resolve_conflicts(tt, pb=DummyProgress(), pass_func=None):
 
 
1632
    """Make many conflict-resolution attempts, but die if they fail"""
 
 
1633
    if pass_func is None:
 
 
1634
        pass_func = conflict_pass
 
 
1635
    new_conflicts = set()
 
 
1638
            pb.update('Resolution pass', n+1, 10)
 
 
1639
            conflicts = tt.find_conflicts()
 
 
1640
            if len(conflicts) == 0:
 
 
1641
                return new_conflicts
 
 
1642
            new_conflicts.update(pass_func(tt, conflicts))
 
 
1643
        raise MalformedTransform(conflicts=conflicts)
 
 
1648
def conflict_pass(tt, conflicts, path_tree=None):
 
 
1649
    """Resolve some classes of conflicts.
 
 
1651
    :param tt: The transform to resolve conflicts in
 
 
1652
    :param conflicts: The conflicts to resolve
 
 
1653
    :param path_tree: A Tree to get supplemental paths from
 
 
1655
    new_conflicts = set()
 
 
1656
    for c_type, conflict in ((c[0], c) for c in conflicts):
 
 
1657
        if c_type == 'duplicate id':
 
 
1658
            tt.unversion_file(conflict[1])
 
 
1659
            new_conflicts.add((c_type, 'Unversioned existing file',
 
 
1660
                               conflict[1], conflict[2], ))
 
 
1661
        elif c_type == 'duplicate':
 
 
1662
            # files that were renamed take precedence
 
 
1663
            new_name = tt.final_name(conflict[1])+'.moved'
 
 
1664
            final_parent = tt.final_parent(conflict[1])
 
 
1665
            if tt.path_changed(conflict[1]):
 
 
1666
                tt.adjust_path(new_name, final_parent, conflict[2])
 
 
1667
                new_conflicts.add((c_type, 'Moved existing file to', 
 
 
1668
                                   conflict[2], conflict[1]))
 
 
1670
                tt.adjust_path(new_name, final_parent, conflict[1])
 
 
1671
                new_conflicts.add((c_type, 'Moved existing file to', 
 
 
1672
                                  conflict[1], conflict[2]))
 
 
1673
        elif c_type == 'parent loop':
 
 
1674
            # break the loop by undoing one of the ops that caused the loop
 
 
1676
            while not tt.path_changed(cur):
 
 
1677
                cur = tt.final_parent(cur)
 
 
1678
            new_conflicts.add((c_type, 'Cancelled move', cur,
 
 
1679
                               tt.final_parent(cur),))
 
 
1680
            tt.adjust_path(tt.final_name(cur), tt.get_tree_parent(cur), cur)
 
 
1682
        elif c_type == 'missing parent':
 
 
1683
            trans_id = conflict[1]
 
 
1685
                tt.cancel_deletion(trans_id)
 
 
1686
                new_conflicts.add(('deleting parent', 'Not deleting', 
 
 
1689
                tt.create_directory(trans_id)
 
 
1690
                new_conflicts.add((c_type, 'Created directory', trans_id))
 
 
1692
                    tt.final_name(trans_id)
 
 
1694
                    file_id = tt.final_file_id(trans_id)
 
 
1695
                    entry = path_tree.inventory[file_id]
 
 
1696
                    parent_trans_id = tt.trans_id_file_id(entry.parent_id)
 
 
1697
                    tt.adjust_path(entry.name, parent_trans_id, trans_id)
 
 
1698
        elif c_type == 'unversioned parent':
 
 
1699
            tt.version_file(tt.inactive_file_id(conflict[1]), conflict[1])
 
 
1700
            new_conflicts.add((c_type, 'Versioned directory', conflict[1]))
 
 
1701
    return new_conflicts
 
 
1704
def cook_conflicts(raw_conflicts, tt):
 
 
1705
    """Generate a list of cooked conflicts, sorted by file path"""
 
 
1706
    from bzrlib.conflicts import Conflict
 
 
1707
    conflict_iter = iter_cook_conflicts(raw_conflicts, tt)
 
 
1708
    return sorted(conflict_iter, key=Conflict.sort_key)
 
 
1711
def iter_cook_conflicts(raw_conflicts, tt):
 
 
1712
    from bzrlib.conflicts import Conflict
 
 
1714
    for conflict in raw_conflicts:
 
 
1715
        c_type = conflict[0]
 
 
1716
        action = conflict[1]
 
 
1717
        modified_path = fp.get_path(conflict[2])
 
 
1718
        modified_id = tt.final_file_id(conflict[2])
 
 
1719
        if len(conflict) == 3:
 
 
1720
            yield Conflict.factory(c_type, action=action, path=modified_path,
 
 
1721
                                     file_id=modified_id)
 
 
1724
            conflicting_path = fp.get_path(conflict[3])
 
 
1725
            conflicting_id = tt.final_file_id(conflict[3])
 
 
1726
            yield Conflict.factory(c_type, action=action, path=modified_path,
 
 
1727
                                   file_id=modified_id, 
 
 
1728
                                   conflict_path=conflicting_path,
 
 
1729
                                   conflict_file_id=conflicting_id)