~bzr-pqm/bzr/bzr.dev

# Copyright (C) 2006, 2007 Canonical Ltd

#

# This program is free software; you can redistribute it and/or modify

# it under the terms of the GNU General Public License as published by

# the Free Software Foundation; either version 2 of the License, or

# (at your option) any later version.

#

# This program is distributed in the hope that it will be useful,

# but WITHOUT ANY WARRANTY; without even the implied warranty of

# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

# GNU General Public License for more details.

#

# You should have received a copy of the GNU General Public License

# along with this program; if not, write to the Free Software

# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

import os

import errno

from stat import S_ISREG

from bzrlib.lazy_import import lazy_import

lazy_import(globals(), """

from bzrlib import (

    bzrdir,

    delta,

    errors,

    inventory

    )

""")

from bzrlib.errors import (DuplicateKey, MalformedTransform, NoSuchFile,

                           ReusingTransform, NotVersionedError, CantMoveRoot,

                           ExistingLimbo, ImmortalLimbo, NoFinalPath,

                           UnableCreateSymlink)

from bzrlib.inventory import InventoryEntry

from bzrlib.osutils import (file_kind, supports_executable, pathjoin, lexists,

                            delete_any, has_symlinks)

from bzrlib.progress import DummyProgress, ProgressPhase

from bzrlib.symbol_versioning import (

        deprecated_function,

        zero_fifteen,

        zero_ninety,

        )

from bzrlib.trace import mutter, warning

from bzrlib import tree

import bzrlib.ui

import bzrlib.urlutils as urlutils

ROOT_PARENT = "root-parent"

def unique_add(map, key, value):

    if key in map:

        raise DuplicateKey(key=key)

    map[key] = value

class _TransformResults(object):

    def __init__(self, modified_paths, rename_count):

        object.__init__(self)

        self.modified_paths = modified_paths

        self.rename_count = rename_count

class TreeTransform(object):

    """Represent a tree transformation.

    This object is designed to support incremental generation of the transform,

    in any order.

    However, it gives optimum performance when parent directories are created

    before their contents.  The transform is then able to put child files

    directly in their parent directory, avoiding later renames.

    It is easy to produce malformed transforms, but they are generally

    harmless.  Attempting to apply a malformed transform will cause an

    exception to be raised before any modifications are made to the tree.  

    Many kinds of malformed transforms can be corrected with the 

    resolve_conflicts function.  The remaining ones indicate programming error,

    such as trying to create a file with no path.

    Two sets of file creation methods are supplied.  Convenience methods are:

     * new_file

     * new_directory

     * new_symlink

    These are composed of the low-level methods:

     * create_path

     * create_file or create_directory or create_symlink

     * version_file

     * set_executability

    Transform/Transaction ids

    -------------------------

    trans_ids are temporary ids assigned to all files involved in a transform.

    It's possible, even common, that not all files in the Tree have trans_ids.

    trans_ids are used because filenames and file_ids are not good enough

    identifiers; filenames change, and not all files have file_ids.  File-ids

    are also associated with trans-ids, so that moving a file moves its

    file-id.

    trans_ids are only valid for the TreeTransform that generated them.

    Limbo

    -----

    Limbo is a temporary directory use to hold new versions of files.

    Files are added to limbo by create_file, create_directory, create_symlink,

    and their convenience variants (new_*).  Files may be removed from limbo

    using cancel_creation.  Files are renamed from limbo into their final

    location as part of TreeTransform.apply

    Limbo must be cleaned up, by either calling TreeTransform.apply or

    calling TreeTransform.finalize.

    Files are placed into limbo inside their parent directories, where

    possible.  This reduces subsequent renames, and makes operations involving

    lots of files faster.  This optimization is only possible if the parent

    directory is created *before* creating any of its children, so avoid

    creating children before parents, where possible.

    Pending-deletion

    ----------------

    This temporary directory is used by _FileMover for storing files that are

    about to be deleted.  In case of rollback, the files will be restored.

    FileMover does not delete files until it is sure that a rollback will not

    happen.  

    """

    def __init__(self, tree, pb=DummyProgress()):

        """Note: a tree_write lock is taken on the tree.

        Use TreeTransform.finalize() to release the lock (can be omitted if

        TreeTransform.apply() called).

        """

        object.__init__(self)

        self._tree = tree

        self._tree.lock_tree_write()

        try:

            control_files = self._tree._control_files

            self._limbodir = urlutils.local_path_from_url(

                control_files.controlfilename('limbo'))

            try:

                os.mkdir(self._limbodir)

            except OSError, e:

                if e.errno == errno.EEXIST:

                    raise ExistingLimbo(self._limbodir)

            self._deletiondir = urlutils.local_path_from_url(

                control_files.controlfilename('pending-deletion'))

            try:

                os.mkdir(self._deletiondir)

            except OSError, e:

                if e.errno == errno.EEXIST:

                    raise errors.ExistingPendingDeletion(self._deletiondir)

        except: 

            self._tree.unlock()

            raise

        # counter used to generate trans-ids (which are locally unique)

        self._id_number = 0

        # mapping of trans_id -> new basename

        self._new_name = {}

        # mapping of trans_id -> new parent trans_id

        self._new_parent = {}

        # mapping of trans_id with new contents -> new file_kind

        self._new_contents = {}

        # A mapping of transform ids to their limbo filename

        self._limbo_files = {}

        # A mapping of transform ids to a set of the transform ids of children

        # that their limbo directory has

        self._limbo_children = {}

        # Map transform ids to maps of child filename to child transform id

        self._limbo_children_names = {}

        # List of transform ids that need to be renamed from limbo into place

        self._needs_rename = set()

        # Set of trans_ids whose contents will be removed

        self._removed_contents = set()

        # Mapping of trans_id -> new execute-bit value

        self._new_executability = {}

        # Mapping of trans_id -> new tree-reference value

        self._new_reference_revision = {}

        # Mapping of trans_id -> new file_id

        self._new_id = {}

        # Mapping of old file-id -> trans_id

        self._non_present_ids = {}

        # Mapping of new file_id -> trans_id

        self._r_new_id = {}

        # Set of file_ids that will be removed

        self._removed_id = set()

        # Mapping of path in old tree -> trans_id

        self._tree_path_ids = {}

        # Mapping trans_id -> path in old tree

        self._tree_id_paths = {}

        # Cache of realpath results, to speed up canonical_path

        self._realpaths = {}

        # Cache of relpath results, to speed up canonical_path

        self._relpaths = {}

        # The trans_id that will be used as the tree root

        self._new_root = self.trans_id_tree_file_id(tree.get_root_id())

        # Indictor of whether the transform has been applied

        self.__done = False

        # A progress bar

        self._pb = pb

        # A counter of how many files have been renamed

        self.rename_count = 0

    def __get_root(self):

        return self._new_root

    root = property(__get_root)

    def finalize(self):

        """Release the working tree lock, if held, clean up limbo dir.

        This is required if apply has not been invoked, but can be invoked

        even after apply.

        """

        if self._tree is None:

            return

        try:

            entries = [(self._limbo_name(t), t, k) for t, k in

                       self._new_contents.iteritems()]

            entries.sort(reverse=True)

            for path, trans_id, kind in entries:

                if kind == "directory":

                    os.rmdir(path)

                else:

                    os.unlink(path)

            try:

                os.rmdir(self._limbodir)

            except OSError:

                # We don't especially care *why* the dir is immortal.

                raise ImmortalLimbo(self._limbodir)

            try:

                os.rmdir(self._deletiondir)

            except OSError:

                raise errors.ImmortalPendingDeletion(self._deletiondir)

        finally:

            self._tree.unlock()

            self._tree = None

    def _assign_id(self):

        """Produce a new tranform id"""

        new_id = "new-%s" % self._id_number

        self._id_number +=1

        return new_id

    def create_path(self, name, parent):

        """Assign a transaction id to a new path"""

        trans_id = self._assign_id()

        unique_add(self._new_name, trans_id, name)

        unique_add(self._new_parent, trans_id, parent)

        return trans_id

    def adjust_path(self, name, parent, trans_id):

        """Change the path that is assigned to a transaction id."""

        if trans_id == self._new_root:

            raise CantMoveRoot

        previous_parent = self._new_parent.get(trans_id)

        previous_name = self._new_name.get(trans_id)

        self._new_name[trans_id] = name

        self._new_parent[trans_id] = parent

        if (trans_id in self._limbo_files and

            trans_id not in self._needs_rename):

            self._rename_in_limbo([trans_id])

            self._limbo_children[previous_parent].remove(trans_id)

            del self._limbo_children_names[previous_parent][previous_name]

    def _rename_in_limbo(self, trans_ids):

        """Fix limbo names so that the right final path is produced.

        This means we outsmarted ourselves-- we tried to avoid renaming

        these files later by creating them with their final names in their

        final parents.  But now the previous name or parent is no longer

        suitable, so we have to rename them.

        Even for trans_ids that have no new contents, we must remove their

        entries from _limbo_files, because they are now stale.

        """

        for trans_id in trans_ids:

            old_path = self._limbo_files.pop(trans_id)

            if trans_id not in self._new_contents:

                continue

            new_path = self._limbo_name(trans_id)

            os.rename(old_path, new_path)

    def adjust_root_path(self, name, parent):

        """Emulate moving the root by moving all children, instead.

        We do this by undoing the association of root's transaction id with the

        current tree.  This allows us to create a new directory with that

        transaction id.  We unversion the root directory and version the 

        physically new directory, and hope someone versions the tree root

        later.

        """

        old_root = self._new_root

        old_root_file_id = self.final_file_id(old_root)

        # force moving all children of root

        for child_id in self.iter_tree_children(old_root):

            if child_id != parent:

                self.adjust_path(self.final_name(child_id), 

                                 self.final_parent(child_id), child_id)

            file_id = self.final_file_id(child_id)

            if file_id is not None:

                self.unversion_file(child_id)

            self.version_file(file_id, child_id)

        # the physical root needs a new transaction id

        self._tree_path_ids.pop("")

        self._tree_id_paths.pop(old_root)

        self._new_root = self.trans_id_tree_file_id(self._tree.get_root_id())

        if parent == old_root:

            parent = self._new_root

        self.adjust_path(name, parent, old_root)

        self.create_directory(old_root)

        self.version_file(old_root_file_id, old_root)

        self.unversion_file(self._new_root)

    def trans_id_tree_file_id(self, inventory_id):

        """Determine the transaction id of a working tree file.

        This reflects only files that already exist, not ones that will be

        added by transactions.

        """

        path = self._tree.inventory.id2path(inventory_id)

        return self.trans_id_tree_path(path)

    def trans_id_file_id(self, file_id):

        """Determine or set the transaction id associated with a file ID.

        A new id is only created for file_ids that were never present.  If

        a transaction has been unversioned, it is deliberately still returned.

        (this will likely lead to an unversioned parent conflict.)

        """

        if file_id in self._r_new_id and self._r_new_id[file_id] is not None:

            return self._r_new_id[file_id]

        elif file_id in self._tree.inventory:

            return self.trans_id_tree_file_id(file_id)

        elif file_id in self._non_present_ids:

            return self._non_present_ids[file_id]

        else:

            trans_id = self._assign_id()

            self._non_present_ids[file_id] = trans_id

            return trans_id

    def canonical_path(self, path):

        """Get the canonical tree-relative path"""

        # don't follow final symlinks

        abs = self._tree.abspath(path)

        if abs in self._relpaths:

            return self._relpaths[abs]

        dirname, basename = os.path.split(abs)

        if dirname not in self._realpaths:

            self._realpaths[dirname] = os.path.realpath(dirname)

        dirname = self._realpaths[dirname]

        abs = pathjoin(dirname, basename)

        if dirname in self._relpaths:

            relpath = pathjoin(self._relpaths[dirname], basename)

            relpath = relpath.rstrip('/\\')

        else:

            relpath = self._tree.relpath(abs)

        self._relpaths[abs] = relpath

        return relpath

    def trans_id_tree_path(self, path):

        """Determine (and maybe set) the transaction ID for a tree path."""

        path = self.canonical_path(path)

        if path not in self._tree_path_ids:

            self._tree_path_ids[path] = self._assign_id()

            self._tree_id_paths[self._tree_path_ids[path]] = path

        return self._tree_path_ids[path]

    def get_tree_parent(self, trans_id):

        """Determine id of the parent in the tree."""

        path = self._tree_id_paths[trans_id]

        if path == "":

            return ROOT_PARENT

        return self.trans_id_tree_path(os.path.dirname(path))

    def create_file(self, contents, trans_id, mode_id=None):

        """Schedule creation of a new file.

        See also new_file.

        Contents is an iterator of strings, all of which will be written

        to the target destination.

        New file takes the permissions of any existing file with that id,

        unless mode_id is specified.

        """

        name = self._limbo_name(trans_id)

        f = open(name, 'wb')

        try:

            try:

                unique_add(self._new_contents, trans_id, 'file')

            except:

                # Clean up the file, it never got registered so

                # TreeTransform.finalize() won't clean it up.

                f.close()

                os.unlink(name)

                raise

            f.writelines(contents)

        finally:

            f.close()

        self._set_mode(trans_id, mode_id, S_ISREG)

    def _set_mode(self, trans_id, mode_id, typefunc):

        """Set the mode of new file contents.

        The mode_id is the existing file to get the mode from (often the same

        as trans_id).  The operation is only performed if there's a mode match

        according to typefunc.

        """

        if mode_id is None:

            mode_id = trans_id

        try:

            old_path = self._tree_id_paths[mode_id]

        except KeyError:

            return

        try:

            mode = os.stat(self._tree.abspath(old_path)).st_mode

        except OSError, e:

            if e.errno == errno.ENOENT:

                return

            else:

                raise

        if typefunc(mode):

            os.chmod(self._limbo_name(trans_id), mode)

    def create_directory(self, trans_id):

        """Schedule creation of a new directory.

        See also new_directory.

        """

        os.mkdir(self._limbo_name(trans_id))

        unique_add(self._new_contents, trans_id, 'directory')

    def create_symlink(self, target, trans_id):

        """Schedule creation of a new symbolic link.

        target is a bytestring.

        See also new_symlink.

        """

        if has_symlinks():

            os.symlink(target, self._limbo_name(trans_id))

            unique_add(self._new_contents, trans_id, 'symlink')

        else:

            try:

                path = FinalPaths(self).get_path(trans_id)

            except KeyError:

                path = None

            raise UnableCreateSymlink(path=path)

    def cancel_creation(self, trans_id):

        """Cancel the creation of new file contents."""

        del self._new_contents[trans_id]

        children = self._limbo_children.get(trans_id)

        # if this is a limbo directory with children, move them before removing

        # the directory

        if children is not None:

            self._rename_in_limbo(children)

            del self._limbo_children[trans_id]

            del self._limbo_children_names[trans_id]

        delete_any(self._limbo_name(trans_id))

    def delete_contents(self, trans_id):

        """Schedule the contents of a path entry for deletion"""

        self.tree_kind(trans_id)

        self._removed_contents.add(trans_id)

    def cancel_deletion(self, trans_id):

        """Cancel a scheduled deletion"""

        self._removed_contents.remove(trans_id)

    def unversion_file(self, trans_id):

        """Schedule a path entry to become unversioned"""

        self._removed_id.add(trans_id)

    def delete_versioned(self, trans_id):

        """Delete and unversion a versioned file"""

        self.delete_contents(trans_id)

        self.unversion_file(trans_id)

    def set_executability(self, executability, trans_id):

        """Schedule setting of the 'execute' bit

        To unschedule, set to None

        """

        if executability is None:

            del self._new_executability[trans_id]

        else:

            unique_add(self._new_executability, trans_id, executability)

    def set_tree_reference(self, revision_id, trans_id):

        """Set the reference associated with a directory"""

        unique_add(self._new_reference_revision, trans_id, revision_id)

    def version_file(self, file_id, trans_id):

        """Schedule a file to become versioned."""

        assert file_id is not None

        unique_add(self._new_id, trans_id, file_id)

        unique_add(self._r_new_id, file_id, trans_id)

    def cancel_versioning(self, trans_id):

        """Undo a previous versioning of a file"""

        file_id = self._new_id[trans_id]

        del self._new_id[trans_id]

        del self._r_new_id[file_id]

    def new_paths(self):

        """Determine the paths of all new and changed files"""

        new_ids = set()

        fp = FinalPaths(self)

        for id_set in (self._new_name, self._new_parent, self._new_contents,

                       self._new_id, self._new_executability):

            new_ids.update(id_set)

        new_paths = [(fp.get_path(t), t) for t in new_ids]

        new_paths.sort()

        return new_paths

    def tree_kind(self, trans_id):

        """Determine the file kind in the working tree.

        Raises NoSuchFile if the file does not exist

        """

        path = self._tree_id_paths.get(trans_id)

        if path is None:

            raise NoSuchFile(None)

        try:

            return file_kind(self._tree.abspath(path))

        except OSError, e:

            if e.errno != errno.ENOENT:

                raise

            else:

                raise NoSuchFile(path)

    def final_kind(self, trans_id):

        """Determine the final file kind, after any changes applied.

        Raises NoSuchFile if the file does not exist/has no contents.

        (It is conceivable that a path would be created without the

        corresponding contents insertion command)

        """

        if trans_id in self._new_contents:

            return self._new_contents[trans_id]

        elif trans_id in self._removed_contents:

            raise NoSuchFile(None)

        else:

            return self.tree_kind(trans_id)

    def tree_file_id(self, trans_id):

        """Determine the file id associated with the trans_id in the tree"""

        try:

            path = self._tree_id_paths[trans_id]

        except KeyError:

            # the file is a new, unversioned file, or invalid trans_id

            return None

        # the file is old; the old id is still valid

        if self._new_root == trans_id:

            return self._tree.get_root_id()

        return self._tree.inventory.path2id(path)

    def final_file_id(self, trans_id):

        """Determine the file id after any changes are applied, or None.

        None indicates that the file will not be versioned after changes are

        applied.

        """

        try:

            # there is a new id for this file

            assert self._new_id[trans_id] is not None

            return self._new_id[trans_id]

        except KeyError:

            if trans_id in self._removed_id:

                return None

        return self.tree_file_id(trans_id)

    def inactive_file_id(self, trans_id):

        """Return the inactive file_id associated with a transaction id.

        That is, the one in the tree or in non_present_ids.

        The file_id may actually be active, too.

        """

        file_id = self.tree_file_id(trans_id)

        if file_id is not None:

            return file_id

        for key, value in self._non_present_ids.iteritems():

            if value == trans_id:

                return key

    def final_parent(self, trans_id):

        """Determine the parent file_id, after any changes are applied.

        ROOT_PARENT is returned for the tree root.

        """

        try:

            return self._new_parent[trans_id]

        except KeyError:

            return self.get_tree_parent(trans_id)

    def final_name(self, trans_id):

        """Determine the final filename, after all changes are applied."""

        try:

            return self._new_name[trans_id]

        except KeyError:

            try:

                return os.path.basename(self._tree_id_paths[trans_id])

            except KeyError:

                raise NoFinalPath(trans_id, self)

    def by_parent(self):

        """Return a map of parent: children for known parents.

        Only new paths and parents of tree files with assigned ids are used.

        """

        by_parent = {}

        items = list(self._new_parent.iteritems())

        items.extend((t, self.final_parent(t)) for t in 

                      self._tree_id_paths.keys())

        for trans_id, parent_id in items:

            if parent_id not in by_parent:

                by_parent[parent_id] = set()

            by_parent[parent_id].add(trans_id)

        return by_parent

    def path_changed(self, trans_id):

        """Return True if a trans_id's path has changed."""

        return (trans_id in self._new_name) or (trans_id in self._new_parent)

    def new_contents(self, trans_id):

        return (trans_id in self._new_contents)

    def find_conflicts(self):

        """Find any violations of inventory or filesystem invariants"""

        if self.__done is True:

            raise ReusingTransform()

        conflicts = []

        # ensure all children of all existent parents are known

        # all children of non-existent parents are known, by definition.

        self._add_tree_children()

        by_parent = self.by_parent()

        conflicts.extend(self._unversioned_parents(by_parent))

        conflicts.extend(self._parent_loops())

        conflicts.extend(self._duplicate_entries(by_parent))

        conflicts.extend(self._duplicate_ids())

        conflicts.extend(self._parent_type_conflicts(by_parent))

        conflicts.extend(self._improper_versioning())

        conflicts.extend(self._executability_conflicts())

        conflicts.extend(self._overwrite_conflicts())