turtle_killer.py

import os
import shutil

import maya.cmds as cmds
import maya.mel as mel
import maya.api.OpenMaya as om


def kill_the_turtle():
    """
    This will try find and delete everything relating to the turtle plugin.
    This includes:
    1. Finding all nodes in the scene and deleting them.
    2. Unloading the plugin if it is loaded.
    3. Looks for the mll plugin and deletes it.
    4. Deletes the shelf inside Maya.
    5. Deletes the shelf mel file from disk.
    """

    # -- look in scene if there are any turtle nodes
    counter = 0
    for turtle in find_turtle_nodes():
        try:
            unlock_and_delete(turtle)
            counter += 1
        except Exception as e:
            if e:
                om.MGlobal.displayError("Could not delete {0} successfully.".format(turtle))

    om.MGlobal.displayInfo("Found and deleted {0} Turtle Nodes.".format(counter))

    # -- check if it is loaded and unload it
    unload_turtle_plugin()

    # -- find where the turtle rests, and take him out.
    hunt_down_turtle_path()

    # -- delete the shelf if there is one.
    delete_turtle_maya_shelve()

    # -- delete the saved turtle shelf
    delete_saved_turtle_shelf()


def find_turtle_nodes():
    """
    find all possible Turtle nodes within the current maya scene.

    :return: turtle nodes found
    :rtype: list[str]
    """

    return [turtle for turtle in cmds.ls("Turtle*")]


def unlock_and_delete(turtle):
    """
    turtle nodes are locked by default, we unlock the node, then we can delete it.

    :param str turtle: turtle node that has been found in the scene
    """

    # -- unlock the node before it can be deleted.
    cmds.lockNode(turtle, lock=False)

    # -- delete the node
    cmds.delete(turtle)

    om.MGlobal.displayInfo("Deleted {0} successfully.".format(turtle))


def unload_turtle_plugin():
    """
    Check if the node is currently loaded, if we do operations such as delete on the node while still loaded,
    could cause corrupt scenes down the line.
    """
    # -- check if the plugin is loaded
    if cmds.pluginInfo("Turtle.mll", query=True, loaded=True):
        cmds.unloadPlugin("Turtle.mll", force=True)


def hunt_down_turtle_path():
    """
    Try find the path from the node (can only be done if loaded).
    As an extra precautionary step we look in the maya bin folder for the node (normal installation destination)
    Because we cannot delete items unless we have admin rights, we move the turtle file to a custom directory that does
    not need admin rights and delete the node off of the machine.
    """
    turtle_path = None
    move_path = join_file_path(os.path.expanduser("~"), "maya")

    # -- try query the node for the path
    try:
        turtle_path = cmds.pluginInfo("Turtle.mll", query=True, path=True)
    except Exception as e:
        if e:
            om.MGlobal.displayInfo("Could not find the path from the node.")

    # -- if turtle path is still None, we try look in the maya bin directory
    if not turtle_path:
        turtle_path = join_file_path(get_maya_bin_plugin_path(), "Turtle.mll")

    # -- if the path has been found we hunt it down
    if turtle_path:
        if os.path.exists(turtle_path) and os.path.isfile(turtle_path):
            try:
                # -- move the node
                move_file_destination(turtle_path, move_path)
                om.MGlobal.displayInfo("Moved the Turtle node to: {0}".format(move_path))

                # -- delete the node
                os.remove(os.path.join(move_path, "Turtle.mll"))
                om.MGlobal.displayInfo("Turtle node has been deleted.")
            except Exception as e:
                if e:
                    om.MGlobal.displayError("Could not delete the turtle plugin.")


def delete_turtle_maya_shelve():
    """
    We try delete the TURTLE shelf if it is loaded.
    """

    try:
        # -- finally, if there is a shelf, delete it!!
        top_level_shelves = mel.eval("$tmpVar=$gShelfTopLevel")
        shelves = cmds.tabLayout(top_level_shelves, query=True, childArray=True)
        if "TURTLE" in shelves:
            cmds.deleteUI("TURTLE")
    except Exception as e:
        if e:
            om.MGlobal.displayError("Could not delete the turtle shelf.")


def move_file_destination(path, move_path):
    """
    Helper function to move files from one destination to another.

    :param str path: source path to get file from
    :param str move_path: destination path to move the file to
    """
    shutil.move(path, move_path)


def join_file_path(path, *kwargs):
    """
    Helper function to join user defined file paths correctly.

    :param str path: the main path that the user would start with
    :param kwargs: optional extra items to add to the final path
    :return: normalized file path
    :rtype: str
    """
    return os.path.normpath(os.path.join(path, *kwargs))


def get_maya_bin_plugin_path():
    """
    We know that the turtle plugin path gets installed in the bin directory,
    we get the maya plugin path and target the bin directory.

    :return: plugin path
    :rtype: str
    """

    # -- iterate over all plugin paths found
    for path in os.environ['MAYA_PLUG_IN_PATH'].split(";"):
        if "bin" not in path:
            continue

        return path or ""


def delete_saved_turtle_shelf():
    """
    We look for the shelf that has been saved by the turtle and delete it off of the machine.
    """

    # -- default shelf name
    turtle_shelf = "shelf_TURTLE.mel"
    path = join_file_path(os.path.expanduser("~"), "maya", cmds.about(version=True), "prefs", "shelves")

    for shelves in os.listdir(path):
        if shelves == turtle_shelf:
            os.remove(os.path.join(path, turtle_shelf))
            om.MGlobal.displayInfo("Turtle Shelf has been deleted from disk.")