maya-umbrella 0.3.0__py2.py3-none-any.whl → 0.4.1__py2.py3-none-any.whl

maya_umbrella/__init__.py

@@ -1,5 +1,5 @@
 # Import local modules
-from maya_umbrella.core import Defender
+from maya_umbrella.core import MayaVirusDefender
 
 
-__all__ = ["Defender"]
+__all__ = ["MayaVirusDefender"]

maya_umbrella/__version__.py

@@ -1 +1 @@
-__version__ = "0.3.0"
+__version__ = "0.4.1"

maya_umbrella/constants.py

@@ -0,0 +1,5 @@
+PACKAGE_NAME = "maya_umbrella"
+
+LOG_FORMAT = "%(asctime)s [%(levelname)s] %(name)s: %(message)s"
+
+LOG_MAX_BYTES = 1024 * 1024 * 5

maya_umbrella/core.py

@@ -1,76 +1,117 @@
 # Import built-in modules
 import logging
-import re
 
 # Import third-party modules
 import maya.api.OpenMaya as om
+import maya.cmds as cmds
 
 # Import local modules
 from maya_umbrella.filesystem import get_hooks
 from maya_umbrella.filesystem import get_vaccines
 from maya_umbrella.filesystem import load_hook
+from maya_umbrella.log import setup_logger
+from maya_umbrella.vaccine import MayaVirusCleaner
 
 
-class Defender(object):
+class MayaVirusDefender(object):
     callback_ids = []
     remove_callbacks = []
     _bad_files = []
     _vaccines = []
     callback_maps = {
-        "afterOpen": om.MSceneMessage.kAfterOpen,
-        "afterImport": om.MSceneMessage.kAfterImport,
-        "afterImportReference": om.MSceneMessage.kAfterImportReference,
-        "afterLoadReference": om.MSceneMessage.kAfterLoadReference,
-        "beforeSave": om.MSceneMessage.kBeforeSave,
-        "beforeImport": om.MSceneMessage.kBeforeImport,
-        "beforeLoadReference": om.MSceneMessage.kBeforeLoadReference,
-        "beforeImportReference": om.MSceneMessage.kBeforeImportReference,
-        "beforeMayaExiting": om.MSceneMessage.kMayaExiting,
+        "after_open": om.MSceneMessage.kAfterOpen,
+        "maya_initialized": om.MSceneMessage.kMayaInitialized,
+        "after_import": om.MSceneMessage.kAfterImport,
+        "after_import_reference": om.MSceneMessage.kAfterImportReference,
+        "after_load_reference": om.MSceneMessage.kAfterLoadReference,
+        "before_save": om.MSceneMessage.kBeforeSave,
+        "before_import": om.MSceneMessage.kBeforeImport,
+        "before_load_reference": om.MSceneMessage.kBeforeLoadReference,
+        "before_import_reference": om.MSceneMessage.kBeforeImportReference,
+        "maya_exiting": om.MSceneMessage.kMayaExiting,
     }
 
-    def __init__(self):
-        self.logger = logging.getLogger(__name__)
+    def __init__(self, auto_fix=True):
+        """Initialize the MayaVirusDefender.
+
+        Args:
+            auto_fix (bool): Whether to automatically fix issues.
+        """
+        logger = logging.getLogger(__name__)
+        self.auto_fix = auto_fix
+        self.logger = setup_logger(logger)
+        self.virus_cleaner = MayaVirusCleaner(self.logger)
         self.load_vaccines()
 
     def load_vaccines(self):
+        """Load all vaccines."""
         for vaccine in get_vaccines():
-            self._vaccines.append(load_hook(vaccine).Vaccine(self.logger))
+            vaccine_class = load_hook(vaccine).Vaccine
+            try:
+                self._vaccines.append(vaccine_class(api=self.virus_cleaner, logger=self.logger))
+            except Exception as e:
+                self.logger.error("Error loading vaccine: %s", e)
 
     @property
     def vaccines(self):
+        """Get all loaded vaccines.
+
+        Returns:
+            list: A list of loaded vaccines.
+        """
         return self._vaccines
 
     def run_hooks(self):
-        for hook in get_hooks():
-            self.logger.info("run_hooks: %s", hook)
-            load_hook(hook).hook(self.logger)
+        """Run all hooks, only works in non-batch mode."""
+        if not cmds.about(batch=True):
+            for hook_file in get_hooks():
+                self.logger.debug("run_hook: %s", hook_file)
+                try:
+                    load_hook(hook_file).hook(virus_cleaner=self.virus_cleaner)
+                except Exception as e:
+                    self.logger.error("Error running hook: %s", e)
 
-    def setup(self):
-        for name, callback in self.callback_maps.items():
-            matched = re.search(r"(?P<name>(after|before))", name)
-            if matched:
-                method_name = matched.group("name")
-                self.logger.info("setup %s.", name)
-                self.callback_ids.append(
-                    {name: om.MSceneMessage.addCallback(callback, getattr(self, "{0}_callback".format(method_name)))}
-                )
-
-        self.start()
-
-    def before_callback(self, *args, **kwargs):
-        self.logger.info("before_callback.")
+    def collect(self):
+        """Collect all issues related to the Maya virus."""
         for vaccine in self.vaccines:
-            vaccine.before_callback()
-        self.run_hooks()
+            vaccine.collect_issues()
 
-    def after_callback(self, *args, **kwargs):
-        self.logger.info("after_callback.")
-        for vaccine in self.vaccines:
-            vaccine.after_callback()
-        self.run_hooks()
+    def fix(self):
+        """Fix all issues related to the Maya virus."""
+        self.virus_cleaner.fix_all_issues()
+
+    def report(self):
+        """Report all issues related to the Maya virus."""
+        self.virus_cleaner.reset_all_issues()
+        self.collect()
+        self.virus_cleaner.report_all_issues()
+
+    def setup(self):
+        """Set up the MayaVirusDefender."""
+        self.virus_cleaner.setup_default_callbacks()
+        for name, callbacks in self.virus_cleaner.registered_callbacks.items():
+            maya_callback = self.callback_maps[name]
+            self.logger.debug("%s setup.", name)
+            for func in callbacks:
+                self.callback_ids.append(om.MSceneMessage.addCallback(maya_callback, func))
+        for name, callbacks in self.callback_maps.items():
+            self.logger.debug("setup callback %s.", name)
+            self.callback_ids.append(om.MSceneMessage.addCallback(callbacks, self._callback))
+
+    def _callback(self, *args, **kwargs):
+        """Callback function for MayaVirusDefender.
+
+        Args:
+            *args: Variable length argument list.
+            **kwargs: Arbitrary keyword arguments.
+        """
+        if self.auto_fix:
+            self.collect()
+            self.fix()
+            self.run_hooks()
+        else:
+            self.report()
 
     def start(self):
-        for vaccine in self.vaccines:
-            self.logger.info("process for vaccine: {0}".format(vaccine.virus_name))
-            vaccine.process()
-        self.run_hooks()
+        """Start the MayaVirusDefender."""
+        self._callback()

maya_umbrella/filesystem.py

@@ -6,6 +6,10 @@ import os
 import random
 import shutil
 import string
+import tempfile
+
+# Import local modules
+from maya_umbrella.constants import PACKAGE_NAME
 
 
 def this_root():
@@ -17,7 +21,7 @@ def safe_remove_file(file_path):
     """Remove the file at the given path without raising an error if the file does not exist."""
     try:
         os.remove(file_path)
-    except (IOError, OSError):
+    except OSError:
         pass
 
 
@@ -25,7 +29,7 @@ def safe_rmtree(path):
     """Remove the directory at the given path without raising an error if the directory does not exist."""
     try:
         shutil.rmtree(path)
-    except (IOError, OSError):
+    except OSError:
         pass
 
 
@@ -106,5 +110,34 @@ def get_hooks():
 
 
 def get_vaccines():
+    """Get a list of all vaccine files.
+
+    Returns:
+        list: A list of vaccine files.
+    """
     pattern = os.path.join(this_root(), "vaccines", "*.py")
     return [vaccine for vaccine in glob.glob(pattern) if "__init__" not in vaccine]
+
+
+def get_log_root():
+    """Get the log root directory.
+
+    Returns:
+        str: The log root directory.
+    """
+    return os.getenv("MAYA_UMBRELLA_LOG_ROOT", tempfile.gettempdir())
+
+
+def get_log_file():
+    """Get the path of the log file.
+
+    Returns:
+        str: The path of the log file.
+    """
+    root = get_log_root()
+    try:
+        os.makedirs(root)
+    except OSError:
+        pass
+    name = os.getenv("MAYA_UMBRELLA_LOG_NAME", PACKAGE_NAME)
+    return os.path.join(root, "{name}.log".format(name=name))

maya_umbrella/hooks/delete_turtle.py

@@ -3,11 +3,16 @@ import maya.cmds as cmds
 import maya.mel as mel
 
 
-def hook(logger):
+def hook(virus_cleaner):
     for plugin in ["Turtle.mll", "mayatomr.mll"]:
         if cmds.pluginInfo(plugin, q=1, loaded=1):
             cmds.unloadPlugin(plugin, f=1)
-    turtle_nodes = ["TurtleRenderOptions", "TurtleUIOptions", "TurtleBakeLayerManager", "TurtleDefaultBakeLayer"]
+    turtle_nodes = [
+        "TurtleRenderOptions",
+        "TurtleUIOptions",
+        "TurtleBakeLayerManager",
+        "TurtleDefaultBakeLayer",
+    ]
     for node in turtle_nodes:
         if cmds.objExists(node):
             cmds.lockNode(node, lock=1)

maya_umbrella/hooks/delete_unknown_plugin_node.py

@@ -2,28 +2,29 @@
 import maya.cmds as cmds
 
 
-def hook(logger):
+def hook(virus_cleaner):
     unknown_node = cmds.ls(type="unknown")
     unknown_plugin = cmds.unknownPlugin(query=True, l=True)
     if unknown_node:
         for nodeObj in unknown_node:
             if cmds.objExists(nodeObj):
                 if cmds.referenceQuery(nodeObj, isNodeReferenced=True):
-                    logger.warning("Node from reference, skip.  {}".format(nodeObj))
+                    virus_cleaner.logger.warning("Node from reference, skip. {}".format(nodeObj))
                     continue
                 if cmds.lockNode(nodeObj, query=True)[0]:
                     try:
                         cmds.lockNode(nodeObj, lock=False)
-                    except Exception as e:
-                        logger.warning("The node is locked and cannot be unlocked. skip  {}".format(nodeObj))
+                    except Exception:
+                        virus_cleaner.logger.warning(
+                            "The node is locked and cannot be unlocked. skip {}".format(nodeObj))
                         continue
                 try:
                     cmds.delete(nodeObj)
-                    logger.warning("Delete node :  {}".format(nodeObj))
-                except Exception as e:
+                    virus_cleaner.logger.warning("Delete node: {}".format(nodeObj))
+                except Exception:
                     pass
 
     if unknown_plugin:
         for plugObj in unknown_plugin:
             cmds.unknownPlugin(plugObj, remove=True)
-            logger.warning("Delete plug-in :  {}".format(plugObj))
+            virus_cleaner.logger.warning("Delete plug-in: {}".format(plugObj))

maya_umbrella/hooks/fix_model_panel.py

@@ -2,13 +2,12 @@
 import maya.cmds as cmds
 
 
-def hook(logger):
+def hook(virus_cleaner):
     for model_panel in cmds.getPanel(typ="modelPanel"):
-
         # Get callback of the model editor
         callback = cmds.modelEditor(model_panel, query=True, editorChanged=True)
 
         # If the callback is the erroneous `CgAbBlastPanelOptChangeCallback`
         if callback == "CgAbBlastPanelOptChangeCallback":
-            # Remove the callbacks from the editor
+            virus_cleaner.logger.info("Remove the callbacks from the editor")
             cmds.modelEditor(model_panel, edit=True, editorChanged="")

maya_umbrella/hooks/fix_on_model_change_3dc.py

@@ -3,12 +3,17 @@ import maya.cmds as cmds
 import maya.mel as mel
 
 
-def hook(logger):
-    mel.eval('global proc onModelChange3dc(string $a){}')
-
+def hook(virus_cleaner):
+    try:
+        mel.eval("global proc onModelChange3dc(string $a){}")
+    except Exception:
+        pass
     try:
         cmds.delete("fixCgAbBlastPanelOptChangeCallback")
-    except:
+    except Exception:
+        pass
+    try:
+        script = "global proc CgAbBlastPanelOptChangeCallback(string $i){}"
+        mel.eval(script)
+    except Exception:
         pass
-    script = "global proc CgAbBlastPanelOptChangeCallback(string $i){}"
-    mel.eval(script)

maya_umbrella/log.py

@@ -0,0 +1,37 @@
+# Import built-in modules
+import logging.handlers
+import os
+
+# Import local modules
+from maya_umbrella.constants import LOG_FORMAT
+from maya_umbrella.constants import LOG_MAX_BYTES
+from maya_umbrella.constants import PACKAGE_NAME
+from maya_umbrella.filesystem import get_log_file
+
+
+def setup_logger(logger=None, logfile=None, log_level=None):
+    """Set up the logger with the specified log file and log level.
+
+    Args:
+        logger (logging.Logger, optional): The logger to set up. Defaults to the logger for the package.
+        logfile (str, optional): The path to the log file. Defaults to the log file returned by `get_log_file()`.
+        log_level (int, optional): The log level. Defaults to `logging.INFO`.
+
+    Returns:
+        logging.Logger: The set up logger.
+    """
+    logger = logger or logging.getLogger(PACKAGE_NAME)
+    log_level = log_level or os.getenv("MAYA_UMBRELLA_LOG_LEVEL", "INFO")
+    logger.setLevel(log_level)
+    logfile = logfile or get_log_file()
+    if not len(logger.handlers):
+        filehandler = logging.handlers.RotatingFileHandler(
+            logfile,
+            mode="a",
+            backupCount=7,
+            delay=True,
+            maxBytes=LOG_MAX_BYTES,
+        )
+        filehandler.setFormatter(logging.Formatter(LOG_FORMAT))
+        logger.addHandler(filehandler)
+    return logger

maya_umbrella/vaccine.py

@@ -1,4 +1,5 @@
 # Import built-in modules
+from collections import defaultdict
 import glob
 import logging
 import os
@@ -11,70 +12,211 @@ from maya_umbrella.filesystem import safe_remove_file
 from maya_umbrella.filesystem import safe_rmtree
 
 
-class BaseVaccine(object):
-    virus_name = None
-
+class MayaVirusCleaner(object):
     _bad_files = []
+    _bad_nodes = []
+    _bad_script_nodes = []
+    _bad_script_jobs = []
+    _registered_callbacks = defaultdict(list)
+    _fix_funcs = []
 
-    def __init__(self, logger=None):
-        self._logger = logger or logging.getLogger(__name__)
+    def __init__(self, logger=None, auto_fix=True):
+        self.logger = logger or logging.getLogger(__name__)
+        self.auto_fix = auto_fix
 
     @property
     def user_app_dir(self):
+        """Return the user application directory."""
         return cmds.internalVar(userAppDir=True)
 
+    @property
+    def maya_file(self):
+        """Return the current Maya file."""
+        return cmds.file(q=True, sn=True)
+
     @property
     def maya_install_root(self):
+        """Return the Maya installation root directory."""
         return os.environ["MAYA_LOCATION"]
 
     @property
     def user_script_path(self):
+        """Return the user script directory."""
         return cmds.internalVar(userScriptDir=True)
 
     @property
     def local_script_path(self):
+        """Return the local script directory."""
         return os.path.join(self.user_app_dir, "scripts")
 
     @property
     def bad_files(self):
-        return []
+        """Return a list of bad files."""
+        return [path for path in list(set(self._bad_files)) if os.path.exists(path)]
 
     @property
     def bad_nodes(self):
-        return []
+        """Return a list of bad nodes."""
+        return list(set(self._bad_nodes))
 
     @property
     def bad_script_nodes(self):
-        return []
+        """Return a list of bad script nodes."""
+        return list(set(self._bad_script_nodes))
+
+    @property
+    def bad_script_jobs(self):
+        """Return a list of bad script jobs."""
+        return list(set(self._bad_script_jobs))
+
+    def callback_remove_rename_temp_files(self, *args, **kwargs):
+        """
+        Remove temporary files in the local script path.
+        """
+        self.logger.info("Removing temporary files in %s", self.local_script_path)
+        [safe_remove_file(temp_file) for temp_file in glob.glob(os.path.join(self.local_script_path, "._*"))]
+
+    @property
+    def registered_callbacks(self):
+        return self._registered_callbacks
+
+    def add_bad_files(self, files):
+        self._bad_files.extend(files)
+
+    def add_bad_file(self, file):
+        self._bad_files.append(file)
+
+    def add_bad_nodes(self, nodes):
+        self._bad_nodes.extend(nodes)
+
+    def add_bad_node(self, node):
+        self._bad_nodes.append(node)
+
+    def add_bad_script_jobs(self, jobs):
+        self._bad_script_jobs.extend(jobs)
+
+    def add_bad_script_job(self, job):
+        self._bad_script_jobs.append(job)
+
+    def add_bad_script_nodes(self, nodes):
+        self._bad_script_nodes.extend(nodes)
+
+    def add_bad_script_node(self, node):
+        self._bad_script_nodes.append(node)
 
-    def collect(self):
-        self._bad_files.extend([temp_file for temp_file in glob.glob(os.path.join(self.local_script_path, "._*"))])
+    def register_callback(self, callback_name, callback):
+        """Register a callback to be executed before or after processing."""
+        self._registered_callbacks[callback_name].append(callback)
 
-    def remove_bad_files(self):
-        self.collect()
+    def add_after_open_callback(self, callback):
+        self.register_callback("after_open", callback)
+
+    def add_maya_initialized_callback(self, callback):
+        self.register_callback("maya_initialized", callback)
+
+    def add_after_import_callback(self, callback):
+        self.register_callback("after_import", callback)
+
+    def add_after_import_reference_callback(self, callback):
+        self.register_callback("after_import_reference", callback)
+
+    def add_after_load_reference_callback(self, callback):
+        self.register_callback("after_load_reference", callback)
+
+    def add_before_save_callback(self, callback):
+        self.register_callback("before_save", callback)
+
+    def add_before_import_callback(self, callback):
+        self.register_callback("before_import", callback)
+
+    def add_before_load_reference_callback(self, callback):
+        self.register_callback("before_load_reference", callback)
+
+    def add_before_import_reference_callback(self, callback):
+        self.register_callback("before_import_reference", callback)
+
+    def add_maya_exiting_callback(self, callback):
+        self.register_callback("maya_exiting", callback)
+
+    def setup_default_callbacks(self):
+        self.add_maya_initialized_callback(self.callback_remove_rename_temp_files)
+        self.add_maya_exiting_callback(self.callback_remove_rename_temp_files)
+
+    def add_fix_function(self, func):
+        self._fix_funcs.append(func)
+
+    # fix
+
+    def fix_script_jobs(self):
+        for script_job in self.bad_script_jobs:
+            script_num = int(script_job.split(":", 1)[0])
+            self.logger.info("Kill script job %s", script_job)
+            cmds.scriptJob(kill=script_num, force=True)
+            self._bad_script_jobs.remove(script_job)
+
+    def fix_bad_files(self):
         for file_ in self.bad_files:
             if os.path.exists(file_):
                 if os.path.isfile(file_):
-                    self._logger.info("Removing {}".format(file_))
+                    self.logger.info("Removing %s", file_)
                     safe_remove_file(file_)
+                    self._bad_files.remove(file_)
                 else:
-                    self._logger.info("Removing folder {}".format(file_))
+                    self.logger.info("Removing folder %s", file_)
                     safe_rmtree(file_)
+                    self._bad_files.remove(file_)
 
-    def delete_bad_nodes(self):
+    def fix_bad_nodes(self):
         for node in self.bad_nodes:
-            self._logger.info("Deleting %s", node)
-            cmds.lockNode(node, l=False)
-            cmds.delete(node)
+            self.logger.info("Deleting %s", node)
+            try:
+                cmds.lockNode(node, lock=False)
+            except ValueError:
+                pass
+            try:
+                cmds.delete(node)
+            except ValueError:
+                pass
+            self._bad_nodes.remove(node)
+
+    def fix_all_issues(self):
+        """Fix all issues related to the Maya virus."""
+        self.fix_bad_files()
+        self.fix_bad_nodes()
+        self.fix_script_jobs()
+        for func in self._fix_funcs:
+            func()
+
+    def report_all_issues(self):
+        """Report all issues related to the Maya virus."""
+        self.logger.info("Bad files: %s", self.bad_files)
+        self.logger.info("Bad nodes: %s", self.bad_nodes)
+        self.logger.info("Bad script jobs: %s", self.bad_script_jobs)
+
+    def reset_all_issues(self):
+        """Reset all issues related to the Maya virus."""
+        self._bad_files = []
+        self._bad_nodes = []
+        self._bad_script_nodes = []
+        self._bad_script_jobs = []
+
+
+class AbstractVaccine(object):
+    virus_name = None
+
+    def __init__(self, api, logger):
+        """Abstract class for Vaccine.
+
+        Args:
+            api (MayaVirusCleaner): The VaccineAPI instance.
+            logger (Logger): The logger instance.
 
-    def before_callback(self, *args, **kwargs):
-        self.remove_bad_files()
-        self.delete_bad_nodes()
+        """
+        self.api = api
+        self.logger = logger
 
-    def after_callback(self, *args, **kwargs):
-        self.remove_bad_files()
-        self.delete_bad_nodes()
+    def collect_issues(self):
+        raise NotImplementedError
 
-    def process(self):
-        self.before_callback()
-        self.after_callback()
+    def report_issue(self, name):
+        self.logger.warning("%s: Infected by Malware!", name)

maya_umbrella/vaccines/vaccine1.py

@@ -1,19 +1,17 @@
 # Import built-in modules
-import os.path
+import os
 
 # Import local modules
-from maya_umbrella.vaccine import BaseVaccine
+from maya_umbrella.vaccine import AbstractVaccine
 
 
-class Vaccine(BaseVaccine):
+class Vaccine(AbstractVaccine):
     virus_name = "pu tian tong qi"
 
-    def __init__(self, logger=None):
-        super(Vaccine, self).__init__(logger)
-
-    @property
-    def bad_files(self):
-        return [
-            os.path.join(self.local_script_path, "fuckVirus.py"),
-            os.path.join(self.local_script_path, "fuckVirus.pyc"),
-        ]
+    def collect_issues(self):
+        self.api.add_bad_files(
+            [
+                os.path.join(self.api.local_script_path, "fuckVirus.py"),
+                os.path.join(self.api.local_script_path, "fuckVirus.pyc"),
+            ],
+        )

maya_umbrella/vaccines/vaccine2.py

@@ -7,22 +7,14 @@ import maya.cmds as cmds
 # Import local modules
 from maya_umbrella.filesystem import read_file
 from maya_umbrella.filesystem import rename
-from maya_umbrella.vaccine import BaseVaccine
+from maya_umbrella.vaccine import AbstractVaccine
 
 
-class Vaccine(BaseVaccine):
+class Vaccine(AbstractVaccine):
     virus_name = "zei jian kang"
-    _bad_files = []
 
-    def __init__(self, logger=None):
-        super(Vaccine, self).__init__(logger)
-
-    @property
-    def bad_files(self):
-        return [os.path.join(self.local_script_path, "vaccine.py"), os.path.join(self.local_script_path, "vaccine.pyc")]
-
-    def _get_nodes(self):
-        bad_script_nodes = []
+    def collect_bad_nodes(self):
+        """Collect all bad nodes related to the virus."""
         for script_node in cmds.ls(type="script"):
             if cmds.referenceQuery(script_node, isNodeReferenced=True):
                 continue
@@ -32,34 +24,37 @@ class Vaccine(BaseVaccine):
                 if not script_string:
                     continue
                 if "internalVar" in script_string or "userSetup" in script_string or "fuckVirus" in script_string:
-                    self._logger.warning("script node {} has internalVar or userSetup or fuckVirus".format(script_node))
-                    bad_script_nodes.append(script_node)
-        return bad_script_nodes
-
-    @property
-    def bad_nodes(self):
-        return self._get_nodes()
-
-    def check_usersetup_py(self):
+                    self.report_issue(script_node)
+                    self.api.add_bad_node(script_node)
+
+    def collect_issues(self):
+        """Collect all issues related to the virus."""
+        self.api.add_bad_files(
+            [
+                os.path.join(self.api.local_script_path, "vaccine.py"),
+                os.path.join(self.api.local_script_path, "vaccine.pyc"),
+            ],
+        )
+        self.collect_bad_usersetup_py()
+        self.collect_bad_nodes()
+
+    def collect_bad_usersetup_py(self):
+        """Collect all bad userSetup.py files related to the virus."""
         for usersetup_py in [
-            os.path.join(self.local_script_path, "vaccine.py"),
-            os.path.join(self.user_script_path, "vaccine.py"),
-            os.path.join(self.local_script_path, "userSetup.py"),
-            os.path.join(self.user_script_path, "userSetup.py"),
+            os.path.join(self.api.local_script_path, "vaccine.py"),
+            os.path.join(self.api.user_script_path, "vaccine.py"),
+            os.path.join(self.api.local_script_path, "userSetup.py"),
+            os.path.join(self.api.user_script_path, "userSetup.py"),
         ]:
             if os.path.exists(usersetup_py):
                 data = read_file(usersetup_py)
                 if "petri_dish_path = cmds.internalVar(userAppDir=True) + 'scripts/userSetup.py" in data:
-                    self._logger.warning("vaccine.py found : Infected by Malware!")
-                    self._bad_files.append(rename(usersetup_py))
+                    self.report_issue("vaccine.py")
+                    self.api.add_bad_file(rename(usersetup_py))
 
                 if (
                     "cmds.evalDeferred('leukocyte = vaccine.phage()')" in data
                     and "cmds.evalDeferred('leukocyte.occupation()')" in data
                 ):
-                    self._logger.warning("userSetup.py : Infected by Malware!")
-                    self._bad_files.append(rename(usersetup_py))
-
-    def before_callback(self, *args, **kwargs):
-        self.check_usersetup_py()
-        super(Vaccine, self).before_callback(args, kwargs)
+                    self.report_issue("userSetup.py")
+                    self.api.add_bad_file(rename(usersetup_py))

maya_umbrella/vaccines/vaccine3.py

@@ -9,65 +9,54 @@ import maya.cmds as cmds
 # Import local modules
 from maya_umbrella.filesystem import read_file
 from maya_umbrella.filesystem import rename
-from maya_umbrella.vaccine import BaseVaccine
+from maya_umbrella.vaccine import AbstractVaccine
 
 
-class Vaccine(BaseVaccine):
+class Vaccine(AbstractVaccine):
     virus_name = "virus2024429"
     hik_regex = r"python\(\"import base64;\s*pyCode\s*=\s*base64\.urlsafe_b64decode\([\'\"].*?[\"\']\);\s*exec\s*\(\s*pyCode\s*\)\"\)\s*;"
-    _bad_files = []
 
-    def __init__(self, logger=None):
-        super(Vaccine, self).__init__(logger)
-
-    @property
-    def bad_files(self):
-        return self._bad_files
-
-    @property
-    def get_syssst_dir(self):
-        return os.path.join(os.getenv("APPDATA"), "syssst")
-
-    def _get_nodes(self):
-        bad_expression = []
+    def collect_bad_nodes(self):
+        """Collect all bad nodes related to the virus."""
         for script_node in cmds.ls(type="script"):
             if cmds.referenceQuery(script_node, isNodeReferenced=True):
                 continue
             # check uifiguration
             if cmds.objExists("{}.KGMScriptProtector".format(script_node)):
-                bad_expression.append(script_node)
+                self.api.add_bad_node(script_node)
             # check vaccine
             if "_gene" in script_node:
-                bad_expression.append(script_node)
-
-        return bad_expression
+                self.api.add_bad_node(script_node)
 
-    def check_usersetup_mel(self):
+    def collect_bad_mel_files(self):
+        """Collect all bad MEL files related to the virus."""
         # check usersetup.mel
         # C:/Users/hallong/Documents/maya/scripts/usersetup.mel
         # C:/Users/hallong/Documents/maya/xxxx/scripts/usersetup.mel
         for usersetup_mel in [
-            os.path.join(self.local_script_path, "usersetup.mel"),
-            os.path.join(self.user_script_path, "usersetup.mel"),
+            os.path.join(self.api.local_script_path, "usersetup.mel"),
+            os.path.join(self.api.user_script_path, "usersetup.mel"),
         ]:
             if os.path.exists(usersetup_mel):
                 data = read_file(usersetup_mel)
                 if "import base64; pyCode = base64.urlsafe_b64decode" in data:
-                    self._bad_files.append(rename(usersetup_mel))
+                    self.api.add_bad_file(rename(usersetup_mel))
 
-    @property
-    def bad_nodes(self):
-        return self._get_nodes()
+    def collect_script_jobs(self):
+        """Collect all script jobs related to the virus."""
+        virus_gene = [
+            "leukocyte",
+            "execute",
+        ]
 
-    def before_callback(self, *args, **kwargs):
-        self._bad_files.extend([self.get_syssst_dir])
-        self.check_usersetup_mel()
-        self.fix_hik_files()
-        self.fix_script_job()
-        super(Vaccine, self).before_callback(args, kwargs)
+        for script_job in cmds.scriptJob(listJobs=True):
+            for virus in virus_gene:
+                if virus in script_job:
+                    self.api.add_bad_script_jobs(script_job)
 
-    def fix_hik_files(self):
-        pattern = os.path.join(self.maya_install_root, "resources/l10n/*/plug-ins/mayaHIK.pres.mel")
+    def fix_bad_hik_files(self):
+        """Fix all bad HIK files related to the virus."""
+        pattern = os.path.join(self.api.maya_install_root, "resources/l10n/*/plug-ins/mayaHIK.pres.mel")
         for hik_mel in glob.glob(pattern):
             with open(hik_mel, "rb") as f:
                 data = f.read()
@@ -76,35 +65,14 @@ class Vaccine(BaseVaccine):
             except TypeError:
                 check = []
             if len(check) > 0:
+                self.report_issue(hik_mel)
                 with open(hik_mel, "wb") as f:
                     f.write(re.sub(self.hik_regex, "", data))
-                self._logger.warning("Remove virus code from {}".format(hik_mel))
-
-    def fix_script_job(self):
-        virus_gene = [
-            "leukocyte",
-            "execute",
-        ]
-
-        def get_virus_script_jobs():
-            """Traverse the list of virus script job name.
-            Returns:
-                list: Malicious virus script job name.
-            """
-            return [
-                scriptjob
-                for scriptjob in cmds.scriptJob(listJobs=True)
-                for virus in virus_gene
-                if virus in scriptjob
-            ]
-
-        for script_job in get_virus_script_jobs():
-            script_num = int(script_job.split(":", 1)[0])
-            self._logger.info("Kill script job {}".format(script_job))
-            cmds.scriptJob(kill=script_num, force=True)
-
-    def after_callback(self, *args, **kwargs):
-        """After callback."""
-        self.check_usersetup_mel()
-        self.fix_hik_files()
-        super(Vaccine, self).after_callback(args, kwargs)
+                self.logger.info("Remove virus code from %s", hik_mel)
+
+    def collect_issues(self):
+        """Collect all issues related to the virus."""
+        self.api.add_bad_file(os.path.join(os.getenv("APPDATA"), "syssst"))
+        self.collect_bad_mel_files()
+        self.collect_bad_nodes()
+        self.api.add_fix_function(self.fix_bad_hik_files)

maya_umbrella-0.4.1.dist-info/METADATA

@@ -0,0 +1,138 @@
+Metadata-Version: 2.1
+Name: maya_umbrella
+Version: 0.4.1
+Summary: Check and fix maya virus.
+Home-page: https://github.com/loonghao/maya_umbrella
+License: MIT
+Keywords: notifiers,python,Maya,dcc
+Author: longhao
+Author-email: hal.long@outlook.com
+Requires-Python: >=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*, !=3.5.*
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 2
+Classifier: Programming Language :: Python :: 2.7
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.6
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Project-URL: Documentation, https://github.com/loonghao/maya_umbrella
+Project-URL: Repository, https://github.com/loonghao/maya_umbrella
+Description-Content-Type: text/markdown
+
+# maya-umbrella
+
+[![Python Version](https://img.shields.io/pypi/pyversions/maya-umbrella)](https://img.shields.io/pypi/pyversions/maya-umbrella)
+[![Nox](https://img.shields.io/badge/%F0%9F%A6%8A-Nox-D85E00.svg)](https://github.com/wntrblm/nox)
+[![PyPI Version](https://img.shields.io/pypi/v/maya-umbrella?color=green)](https://pypi.org/project/maya-umbrella/)
+[![Downloads Status](https://img.shields.io/pypi/dw/maya-umbrella)](https://pypi.org/project/maya-umbrella/)
+[![Downloads](https://pepy.tech/badge/maya-umbrella)](https://pepy.tech/project/maya-umbrella)
+[![License](https://img.shields.io/pypi/l/maya-umbrella)](https://pypi.org/project/maya-umbrella/)
+[![PyPI Format](https://img.shields.io/pypi/format/maya-umbrella)](https://pypi.org/project/maya-umbrella/)
+[![Maintenance](https://img.shields.io/badge/Maintained%3F-yes-green.svg)](https://github.com/loonghao/maya-umbrella/graphs/commit-activity)
+[![maya-2024](https://img.shields.io/badge/maya-2024-green)](https://img.shields.io/badge/maya-2024-green)
+[![maya-2023](https://img.shields.io/badge/maya-2023-green)](https://img.shields.io/badge/maya-2023-green)
+[![maya-2022](https://img.shields.io/badge/maya-2022-green)](https://img.shields.io/badge/maya-2022-green)
+[![maya-2021](https://img.shields.io/badge/maya-2021-green)](https://img.shields.io/badge/maya-2021-green)
+[![maya-2020](https://img.shields.io/badge/maya-2020-green)](https://img.shields.io/badge/maya-2020-green)
+[![maya-2019](https://img.shields.io/badge/maya-2019-green)](https://img.shields.io/badge/maya-2019-green)
+[![maya-2018](https://img.shields.io/badge/maya-2018-green)](https://img.shields.io/badge/maya-2018-green)
+
+<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
+[![All Contributors](https://img.shields.io/badge/all_contributors-4-orange.svg?style=flat-square)](#contributors-)
+<!-- ALL-CONTRIBUTORS-BADGE:END -->
+
+Check and fix maya virus.
+
+
+# 发开环境设置
+
+通过虚拟环境去设置开发环境, 推荐python-3.8以上的版本
+
+```shell
+pip install nox poetry
+```
+
+# 开发调试
+
+```shell
+nox -s maya-2020
+```
+
+## 在maya中测试
+
+通过`nox -s maya-xxx`, 启动maya.
+nox会动态根据你本地安装得maya去注册nox session, 比如你本地安装了`maya-2020`，那么通过`nox -s maya-2018`
+
+启动maya后在脚本编辑器中执行下面得代码，就会动态的从`<repo>/tests/virus/`里面去open ma文件去进行测试.
+
+```python
+import manual_test_in_maya
+
+manual_test_in_maya.start()
+```
+
+## 增加新的疫苗
+
+在`<repo>/maya_umbrella/vaccines/` 新建一个py, 因为有很多病毒没有具体的名字代号，我们统一以`vaccine<id>.py`
+继承`from maya_umbrella.vaccine import AbstractVaccine`并且class名字叫`Vaccine`即可, 然后去写具体的收集病毒逻辑
+
+## 代码检查
+
+我们可以利用封装好的`nox`命令去执行进行代码检查
+
+```shell
+nox -s ruff_check
+```
+
+# 环境变量
+
+我们可以通过下列环境变量去修改maya_umbrella的一些设置，方便有pipeline的公司可以更好的集成
+
+修改maya umbrella的日志保存目录，默认是windows temp目录
+
+```shell
+MAYA_UMBRELLA_LOG_ROOT
+```
+
+修改maya umbrella的日志文件名称, 默认是`maya_umbrella`
+
+```shell
+MAYA_UMBRELLA_LOG_NAME
+```
+
+设置日志级别，默认是info, 可以是debug可以看到更多的日志信息
+
+```shell
+MAYA_UMBRELLA_LOG_LEVEL
+```
+
+## Contributors ✨
+
+Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
+
+<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
+<!-- prettier-ignore-start -->
+<!-- markdownlint-disable -->
+<table>
+  <tbody>
+    <tr>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/loonghao"><img src="https://avatars1.githubusercontent.com/u/13111745?v=4?s=100" width="100px;" alt="Hal"/><br /><sub><b>Hal</b></sub></a><br /><a href="https://github.com/loonghao/maya_umbrella/commits?author=loonghao" title="Code">💻</a> <a href="#infra-loonghao" title="Infrastructure (Hosting, Build-Tools, etc)">🚇</a> <a href="https://github.com/loonghao/maya_umbrella/commits?author=loonghao" title="Tests">⚠️</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/hotwinter0"><img src="https://avatars.githubusercontent.com/u/106237305?v=4?s=100" width="100px;" alt="hotwinter0"/><br /><sub><b>hotwinter0</b></sub></a><br /><a href="https://github.com/loonghao/maya_umbrella/commits?author=hotwinter0" title="Tests">⚠️</a> <a href="https://github.com/loonghao/maya_umbrella/commits?author=hotwinter0" title="Code">💻</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/lingyunfx"><img src="https://avatars.githubusercontent.com/u/73666629?v=4?s=100" width="100px;" alt="lingyunfx"/><br /><sub><b>lingyunfx</b></sub></a><br /><a href="https://github.com/loonghao/maya_umbrella/commits?author=lingyunfx" title="Tests">⚠️</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/yjjjj"><img src="https://avatars.githubusercontent.com/u/12741735?v=4?s=100" width="100px;" alt="yjjjj"/><br /><sub><b>yjjjj</b></sub></a><br /><a href="https://github.com/loonghao/maya_umbrella/commits?author=yjjjj" title="Tests">⚠️</a> <a href="https://github.com/loonghao/maya_umbrella/commits?author=yjjjj" title="Code">💻</a></td>
+    </tr>
+  </tbody>
+</table>
+
+<!-- markdownlint-restore -->
+<!-- prettier-ignore-end -->
+
+<!-- ALL-CONTRIBUTORS-LIST:END -->
+
+This project follows the [all-contributors](https://allcontributors.org) specification.
+Contributions of any kind are welcome!
+

maya_umbrella-0.4.1.dist-info/RECORD

@@ -0,0 +1,20 @@
+maya_umbrella/__init__.py,sha256=039hJesYFSc1aXypFRo1PVQvqowJJ9Q_bAdfcEQI2qk,106
+maya_umbrella/__version__.py,sha256=pMtTmSUht-XtbR_7Doz6bsQqopJJd8rZ8I8zy2HwwoA,22
+maya_umbrella/constants.py,sha256=SuD8OP8e0Kh3a9ohyS5_MXjo5pHNQ8MWEPtJ6puZfIU,130
+maya_umbrella/core.py,sha256=kUaDyDPwD92e2D3GIRPRUMZ2MAnf7DlaGBbBl753NwY,4112
+maya_umbrella/filesystem.py,sha256=EwOtPvl9UhjOu2YYW1hyIbmqsdcseu6ye0Bnuzf2khU,4125
+maya_umbrella/hooks/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+maya_umbrella/hooks/delete_turtle.py,sha256=G5zzMFn9L9lSydvFiscUIqSgLbHZlWUV0lfUtnhvQUw,734
+maya_umbrella/hooks/delete_unknown_plugin_node.py,sha256=PxufrH9eqUP6Y28bseTWmCaO_0M4zeHzexIJpws9Q2U,1246
+maya_umbrella/hooks/fix_model_panel.py,sha256=DLXPo_E9Q1C6a3Dpye4jWCSqfjZxG0iBduMhORV5vKo,546
+maya_umbrella/hooks/fix_on_model_change_3dc.py,sha256=PPnU70Ed_TW9j5nkQnbQ2EEGVo5jm5T6gimzOQYbgCY,457
+maya_umbrella/log.py,sha256=IJweFEBTThL6_mW86jAAPKyWNvI79CrMifs5vO3t6ks,1338
+maya_umbrella/vaccine.py,sha256=W6JhnA7j4rjltF8jIoAXVMFq3v1d_dTyZaQGhq2dkWk,7033
+maya_umbrella/vaccines/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+maya_umbrella/vaccines/vaccine1.py,sha256=oM41xlB49YPl_S760TqFyosDVIAIZOzsqkcL5sh679s,430
+maya_umbrella/vaccines/vaccine2.py,sha256=XRnQFSvbTXxgr8FZ8eU6s_h_Uwyt429a93gyfDyglic,2526
+maya_umbrella/vaccines/vaccine3.py,sha256=KLGSSLPqTjrVjcrT65wQNuM31MoDBFTc0kmAoLzu2NI,3053
+maya_umbrella-0.4.1.dist-info/LICENSE,sha256=tJf0Pz8q_65AjEkm3872K1cl4jGil28vJO5Ko_LhUqc,1060
+maya_umbrella-0.4.1.dist-info/METADATA,sha256=Vx3UbEyZHJnpJtVk2nak1RUgU4ZZ1MDjEm84CcdzcJo,6710
+maya_umbrella-0.4.1.dist-info/WHEEL,sha256=IrRNNNJ-uuL1ggO5qMvT1GGhQVdQU54d6ZpYqEZfEWo,92
+maya_umbrella-0.4.1.dist-info/RECORD,,

maya_umbrella-0.3.0.dist-info/METADATA

@@ -1,85 +0,0 @@
-Metadata-Version: 2.1
-Name: maya_umbrella
-Version: 0.3.0
-Summary: Check and fix maya virus.
-Home-page: https://github.com/loonghao/maya_umbrella
-License: MIT
-Keywords: notifiers,python,Maya,dcc
-Author: longhao
-Author-email: hal.long@outlook.com
-Requires-Python: >=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*, !=3.5.*
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Programming Language :: Python :: 2
-Classifier: Programming Language :: Python :: 2.7
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.6
-Classifier: Programming Language :: Python :: 3.7
-Classifier: Programming Language :: Python :: 3.8
-Classifier: Programming Language :: Python :: 3.9
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
-Classifier: Programming Language :: Python :: 3.12
-Project-URL: Documentation, https://github.com/loonghao/maya_umbrella
-Project-URL: Repository, https://github.com/loonghao/maya_umbrella
-Description-Content-Type: text/markdown
-
-# maya_umbrella
-
-Check and fix maya virus.
-
-[![Nox](https://img.shields.io/badge/%F0%9F%A6%8A-Nox-D85E00.svg)](https://github.com/wntrblm/nox)
-<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
-[![All Contributors](https://img.shields.io/badge/all_contributors-1-orange.svg?style=flat-square)](#contributors-)
-<!-- ALL-CONTRIBUTORS-BADGE:END --> 
-
-
-
-
-
-# 发开环境设置
-python 版本 3.9
-
-```shell
-pip install nox poetry
-```
-
-# 开发调试
-
-```shell
-nox -s maya-2020
-```
-
-## 在maya中测试
-通过`nox -s maya-xxx`, 启动maya. 
-nox会动态根据你本地安装得maya去注册nox session, 比如你本地安装了`maya-2020`，那么通过`nox -s maya-2018`
-
-启动maya后在脚本编辑器中执行下面得代码，就会动态的从`<repo>/tests/virus/`里面去open ma文件去进行测试.
-```python
-import manual_test_in_maya
-
-manual_test_in_maya.start()
-```
-
-## Contributors ✨
-
-Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
-
-<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
-<!-- prettier-ignore-start -->
-<!-- markdownlint-disable -->
-<table>
-  <tbody>
-    <tr>
-      <td align="center" valign="top" width="14.28%"><a href="https://github.com/loonghao"><img src="https://avatars1.githubusercontent.com/u/13111745?v=4?s=100" width="100px;" alt="Hal"/><br /><sub><b>Hal</b></sub></a><br /><a href="https://github.com/loonghao/maya_umbrella/commits?author=loonghao" title="Code">💻</a></td>
-    </tr>
-  </tbody>
-</table>
-
-<!-- markdownlint-restore -->
-<!-- prettier-ignore-end -->
-
-<!-- ALL-CONTRIBUTORS-LIST:END -->
-
-This project follows the [all-contributors](https://allcontributors.org) specification.
-Contributions of any kind are welcome!
-

maya_umbrella-0.3.0.dist-info/RECORD

@@ -1,18 +0,0 @@
-maya_umbrella/__init__.py,sha256=XrGd2g7JVWk-K48K1SHETv1su1cDUj4rzeu36U8VOSc,88
-maya_umbrella/__version__.py,sha256=VrXpHDu3erkzwl_WXrqINBm9xWkcyUy53IQOj042dOs,22
-maya_umbrella/core.py,sha256=YVMYLsWGZZup1FRgRGaMRj25jbopw8kByOSsjxMaLKg,2512
-maya_umbrella/filesystem.py,sha256=U6G4lG4-kbTc2lMVlpg3Umd0u0HVkU2i-AuiEFegDXU,3434
-maya_umbrella/hooks/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-maya_umbrella/hooks/delete_turtle.py,sha256=EYVXPYi7lBtlUqDFzS0NsftNomZtVBRD-uO705M4KN4,688
-maya_umbrella/hooks/delete_unknown_plugin_node.py,sha256=JO0Y2FILrwP7rCW2dOqe_AMhe0OhMtZGHF3w2UAafew,1170
-maya_umbrella/hooks/fix_model_panel.py,sha256=cJ65n0_OnFtyKYTnir6S3EluArb8qen1VoIQCpyHtCM,513
-maya_umbrella/hooks/fix_on_model_change_3dc.py,sha256=iXXBZNiNYMnp8J0waBKPsEo_4TsTgD8zsV7mDbMM26E,341
-maya_umbrella/vaccine.py,sha256=8ekUaa0xaizTOeDzDPtnsyVcj1puP_TUqXg5pdf2bGM,2045
-maya_umbrella/vaccines/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-maya_umbrella/vaccines/vaccine1.py,sha256=gWz7wl38Uy8s1gRSgcf5g9kN9WrD510zaLuh8FgxYVk,460
-maya_umbrella/vaccines/vaccine2.py,sha256=dt0CHfHZHmbUCWF58jBpgAVrIikISdkTFrYMcLr82Dw,2659
-maya_umbrella/vaccines/vaccine3.py,sha256=e6sM4JFst_yLkX4wwW7KeHIZkI5i9WoCER1uzUUcPJQ,3756
-maya_umbrella-0.3.0.dist-info/LICENSE,sha256=tJf0Pz8q_65AjEkm3872K1cl4jGil28vJO5Ko_LhUqc,1060
-maya_umbrella-0.3.0.dist-info/METADATA,sha256=DMn3Ff9evgj3noS6eh1Kh1o2UBeoZRPIljkmKGzVlzA,2818
-maya_umbrella-0.3.0.dist-info/WHEEL,sha256=IrRNNNJ-uuL1ggO5qMvT1GGhQVdQU54d6ZpYqEZfEWo,92
-maya_umbrella-0.3.0.dist-info/RECORD,,