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

maya_umbrella/vaccines/vaccine3.py

@@ -1,34 +1,42 @@
 # Import built-in modules
 import glob
-import os.path
-import re
-
-# Import third-party modules
-import maya.cmds as cmds
+import os
 
 # Import local modules
-from maya_umbrella.filesystem import read_file
-from maya_umbrella.filesystem import rename
+from maya_umbrella.constants import JOB_SCRIPTS_VIRUS_SIGNATURES
+from maya_umbrella.filesystem import check_virus_by_signature
+from maya_umbrella.filesystem import check_virus_file_by_signature
+from maya_umbrella.maya_funs import cmds
+from maya_umbrella.maya_funs import get_attr_value
+from maya_umbrella.maya_funs import get_reference_file_by_node
+from maya_umbrella.maya_funs import is_maya_standalone
 from maya_umbrella.vaccine import AbstractVaccine
 
 
 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*;"
+    """A class for handling the virus2024429 virus."""
+
+    virus_name = "Virus2024429"
 
-    def collect_bad_nodes(self):
+    def collect_infected_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)):
-                self.api.add_bad_node(script_node)
             # check vaccine
             if "_gene" in script_node:
-                self.api.add_bad_node(script_node)
+                self.report_issue(script_node)
+                self.api.add_infected_node(script_node)
+                self.api.add_infected_reference_file(get_reference_file_by_node(script_node))
+            if "uifiguration" in script_node:
+                for attr_name in ("before", "notes"):
+                    script_string = get_attr_value(script_node, attr_name)
+                    if not script_string:
+                        continue
+                if check_virus_by_signature(script_string, JOB_SCRIPTS_VIRUS_SIGNATURES):
+                    self.report_issue(script_node)
+                    self.api.add_infected_node(script_node)
+                    self.api.add_infected_reference_file(get_reference_file_by_node(script_node))
 
-    def collect_bad_mel_files(self):
+    def collect_infected_mel_files(self):
         """Collect all bad MEL files related to the virus."""
         # check usersetup.mel
         # C:/Users/hallong/Documents/maya/scripts/usersetup.mel
@@ -38,9 +46,9 @@ class Vaccine(AbstractVaccine):
             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.api.add_bad_file(rename(usersetup_mel))
+                if check_virus_file_by_signature(usersetup_mel):
+                    self.report_issue(usersetup_mel)
+                    self.api.add_infected_file(usersetup_mel)
 
     def collect_script_jobs(self):
         """Collect all script jobs related to the virus."""
@@ -48,31 +56,25 @@ class Vaccine(AbstractVaccine):
             "leukocyte",
             "execute",
         ]
-
         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)
+                    self.api.add_infected_script_job(script_job)
 
     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()
-            try:
-                check = re.findall(self.hik_regex, data)
-            except TypeError:
-                check = []
-            if len(check) > 0:
+            if check_virus_file_by_signature(hik_mel):
                 self.report_issue(hik_mel)
-                with open(hik_mel, "wb") as f:
-                    f.write(re.sub(self.hik_regex, "", data))
-                self.logger.info("Remove virus code from %s", hik_mel)
+                self.api.add_infected_file(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)
+        self.api.add_malicious_file(os.path.join(os.getenv("APPDATA"), "syssst"))
+        self.collect_infected_mel_files()
+        self.collect_infected_nodes()
+        # This only works for Maya Gui model.
+        if not is_maya_standalone():
+            self.collect_script_jobs()
+        self.api.add_additionally_fix_function(self.fix_bad_hik_files)

{maya_umbrella-0.4.1.dist-info → maya_umbrella-0.6.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: maya_umbrella
-Version: 0.4.1
+Version: 0.6.0
 Summary: Check and fix maya virus.
 Home-page: https://github.com/loonghao/maya_umbrella
 License: MIT
@@ -28,8 +28,9 @@ Description-Content-Type: text/markdown
 [![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)
+[![Downloads](https://static.pepy.tech/badge/maya-umbrella)](https://pepy.tech/project/maya-umbrella)
+[![Downloads](https://static.pepy.tech/badge/maya-umbrella/month)](https://pepy.tech/project/maya-umbrella)
+[![Downloads](https://static.pepy.tech/badge/maya-umbrella/week)](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)
@@ -42,13 +43,33 @@ Description-Content-Type: text/markdown
 [![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](https://img.shields.io/badge/all_contributors-5-orange.svg?style=flat-square)](#contributors-)
 <!-- ALL-CONTRIBUTORS-BADGE:END -->
 
-Check and fix maya virus.
+This tool is designed to provide a robust solution for identifying and resolving any potential viruses within Autodesk
+Maya.
+It ensures a secure and seamless user experience by proactively scanning for threats and effectively neutralizing them.
 
+It can be provided as an API for seamless integration into your existing pipeline.
 
-# 发开环境设置
+# 安装
+maya_umbrella是以标准pipy包去发布的，所以我们可以通过pip install去安装
+```shell
+your/maya-root/mayapy -m pip install maya-umbrella
+```
+更新版本
+```shell
+your/maya-root/mayapy -m pip install maya-umbrella --upgrade
+```
+卸载
+```shell
+your/maya-root/mayapy -m pip uninstall  maya-umbrella
+```
+
+# 开发环境设置
+
+Set up the development environment using a virtual environment,
+and it is recommended to use Python 3.8 or higher versions.
 
 通过虚拟环境去设置开发环境, 推荐python-3.8以上的版本
 
@@ -88,6 +109,14 @@ manual_test_in_maya.start()
 nox -s ruff_check
 ```
 
+# 生成安装包
+
+执行下面的命令可以在<repo>/.zip下面创建zip，参数 `--version` 当前工具的版本号
+
+```shell
+nox -s make-zip -- --version 0.5.0
+```
+
 # 环境变量
 
 我们可以通过下列环境变量去修改maya_umbrella的一些设置，方便有pipeline的公司可以更好的集成
@@ -108,6 +137,45 @@ MAYA_UMBRELLA_LOG_NAME
 
 ```shell
 MAYA_UMBRELLA_LOG_LEVEL
+```
+修改杀毒后文件的备份文件夹名称， 默认是`_virus`
+比如:
+你文件路径是  `c:/your/path/file.ma`
+那么备份文件路径是 `c:/your/path/_maya_umbrella/file.ma`
+```shell
+MAYA_UMBRELLA_BACKUP_FOLDER_NAME
+```
+默认的显示语言，包含日志打印输出等，默认是根据你当前maya的界面语言来设置的，当然我们也可以通过下面的环境变量去设置
+```shell
+MAYA_UMBRELLA_LANG
+```
+
+忽略保存到备份文件夹，*请注意，如果你不清楚这个会导致的后果请不要轻易修改*，默认批量杀毒后会把源文件自动备份到当前文件的备份文件夹.
+```shell
+MAYA_UMBRELLA_IGNORE_BACKUP
+```
+如果忽略请设置为
+```shell
+SET MAYA_UMBRELLA_IGNORE_BACKUP=true
+```
+
+# API
+获取当前场景没有被修复的病毒文件
+
+```python
+from maya_umbrella import MayaVirusDefender
+
+api = MayaVirusDefender()
+print(api.get_unfixed_references())
+```
+
+批量修复文件
+```python
+from maya_umbrella import MayaVirusScanner
+
+api = MayaVirusScanner()
+print(api.scan_files_from_pattern("your/path/*.m[ab]"))
+
 ```
 
 ## Contributors ✨
@@ -124,6 +192,7 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
       <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>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/uncleschen"><img src="https://avatars.githubusercontent.com/u/37014389?v=4?s=100" width="100px;" alt="Unclechen"/><br /><sub><b>Unclechen</b></sub></a><br /><a href="https://github.com/loonghao/maya_umbrella/commits?author=uncleschen" title="Tests">⚠️</a></td>
     </tr>
   </tbody>
 </table>

maya_umbrella-0.6.0.dist-info/RECORD

@@ -0,0 +1,28 @@
+maya_umbrella/__init__.py,sha256=uHgbJ-AL3NOfDNB55_7a4_c-OAuP4X8eQ_Yi1udaA0I,401
+maya_umbrella/__version__.py,sha256=cID1jLnC_vj48GgMN6Yb1FA3JsQ95zNmCHmRYE8TFhY,22
+maya_umbrella/cleaner.py,sha256=5EC3w4qRkIsr9AIZneEV8ljhxaOw385Gj2C2KTrzyJg,5044
+maya_umbrella/collector.py,sha256=rAFmvY8Isdle89ezn2-H36hSJd77iBvPBLRPzruCycA,13111
+maya_umbrella/constants.py,sha256=2sl0dL0U82mwu-Msda9B8-USxr89Wu2yu6SYiuaaJZk,539
+maya_umbrella/defender.py,sha256=K5EERl9bwd0IY_ilvnNYXYaQpIe-DUGep-buEb3qLV8,5601
+maya_umbrella/filesystem.py,sha256=CY3MlOXi_fJ8NTITvgotyPiZHyzM4uZQTgMmOYD25T0,8333
+maya_umbrella/hooks/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+maya_umbrella/hooks/delete_turtle.py,sha256=OPFRFH1iwonHvETndrP87MZQlJLhxpe564AJE3KyJY8,761
+maya_umbrella/hooks/delete_unknown_plugin_node.py,sha256=xbJvihfjZBhF946ugVqj2IpY_VjOBZt_8KO5omDrJhw,1281
+maya_umbrella/hooks/fix_model_panel.py,sha256=dLuMOz5uQ1nqAboNWMCx-Bi_gHM3FQNTlGxPG5wRYEs,556
+maya_umbrella/hooks/fix_on_model_change_3dc.py,sha256=o4WEQPcHNzaTMXdNnHZWWNCYlHfLxcSFYXR4YW0ZLwk,484
+maya_umbrella/i18n.py,sha256=NCC6isPdchv3yRBS2F4Cguu1bVyi0VoMMcI4YOIxBtU,2683
+maya_umbrella/locales/en_US.json,sha256=LW2gPgO2YJIYR5UfcIBuxW_DS7rf4gkjeVuADqs1V5s,962
+maya_umbrella/locales/zh_CN.json,sha256=UsuRN2yaxxc9LE-7NQkbMqrkjXjNhNegS0QRkQLSTiE,1006
+maya_umbrella/log.py,sha256=IJweFEBTThL6_mW86jAAPKyWNvI79CrMifs5vO3t6ks,1338
+maya_umbrella/maya_funs.py,sha256=WDvREjzLfEsPND0RU-2ErbWgsU6MsILqVBW219p8sZo,3394
+maya_umbrella/scanner.py,sha256=zqo7_Znu1OLI7WrqPBgU1aAxlp19UKVI24s2E-xC6Z8,3710
+maya_umbrella/signatures.py,sha256=RkEXChch7tdqA9Yq6YQ8AMnK2ra6ih0dfnpeZy5FkYs,354
+maya_umbrella/vaccine.py,sha256=aBW6pdT4tD4OMBPZ-d3E4_n16Rylz-2gb7JWzMZVPK0,1022
+maya_umbrella/vaccines/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+maya_umbrella/vaccines/vaccine1.py,sha256=WLo1uJElTLSjVCf5CBtRNU4HKs63my5mkHiGqTfnNEE,489
+maya_umbrella/vaccines/vaccine2.py,sha256=yvHpnrQ6Jts9_zCy8WRJcbxz0CVSRAPkn2vF552atQs,2123
+maya_umbrella/vaccines/vaccine3.py,sha256=d89Ocj1AmsZt9YJjggjDJqAWXcckGLMl-6u8jXeAPjg,3493
+maya_umbrella-0.6.0.dist-info/LICENSE,sha256=tJf0Pz8q_65AjEkm3872K1cl4jGil28vJO5Ko_LhUqc,1060
+maya_umbrella-0.6.0.dist-info/METADATA,sha256=JYAKRBCSJIq-vbrfRfehI97VuZPzAyyTo9drpkgofI0,9178
+maya_umbrella-0.6.0.dist-info/WHEEL,sha256=IrRNNNJ-uuL1ggO5qMvT1GGhQVdQU54d6ZpYqEZfEWo,92
+maya_umbrella-0.6.0.dist-info/RECORD,,

maya_umbrella/core.py

@@ -1,117 +0,0 @@
-# Import built-in modules
-import logging
-
-# 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 MayaVirusDefender(object):
-    callback_ids = []
-    remove_callbacks = []
-    _bad_files = []
-    _vaccines = []
-    callback_maps = {
-        "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, 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():
-            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):
-        """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 collect(self):
-        """Collect all issues related to the Maya virus."""
-        for vaccine in self.vaccines:
-            vaccine.collect_issues()
-
-    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):
-        """Start the MayaVirusDefender."""
-        self._callback()

maya_umbrella-0.4.1.dist-info/RECORD

@@ -1,20 +0,0 @@
-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,,