maya-umbrella 0.5.0__tar.gz → 0.6.1__tar.gz

{maya_umbrella-0.5.0 → maya_umbrella-0.6.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: maya_umbrella
-Version: 0.5.0
+Version: 0.6.1
 Summary: Check and fix maya virus.
 Home-page: https://github.com/loonghao/maya_umbrella
 License: MIT
@@ -43,18 +43,32 @@ 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 -->
 
-This tool is designed to provide a robust solution for identifying and resolving any potential viruses within Autodesk Maya. 
+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, 
+Set up the development environment using a virtual environment,
 and it is recommended to use Python 3.8 or higher versions.
 
 通过虚拟环境去设置开发环境, 推荐python-3.8以上的版本
@@ -95,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的公司可以更好的集成
@@ -115,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 ✨
@@ -131,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.5.0 → maya_umbrella-0.6.1}/README.md

@@ -18,18 +18,32 @@
 [![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 -->
 
-This tool is designed to provide a robust solution for identifying and resolving any potential viruses within Autodesk Maya. 
+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, 
+Set up the development environment using a virtual environment,
 and it is recommended to use Python 3.8 or higher versions.
 
 通过虚拟环境去设置开发环境, 推荐python-3.8以上的版本
@@ -70,6 +84,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的公司可以更好的集成
@@ -90,6 +112,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 ✨
@@ -106,6 +167,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.1/maya_umbrella/__init__.py

@@ -0,0 +1,9 @@
+# Import local modules
+from maya_umbrella.cleaner import MayaVirusCleaner
+from maya_umbrella.collector import MayaVirusCollector
+from maya_umbrella.defender import MayaVirusDefender
+from maya_umbrella.defender import context_defender
+from maya_umbrella.scanner import MayaVirusScanner
+
+
+__all__ = ["MayaVirusDefender", "MayaVirusCleaner", "MayaVirusCollector", "MayaVirusScanner", "context_defender"]

maya_umbrella-0.6.1/maya_umbrella/__version__.py

@@ -0,0 +1 @@
+__version__ = "0.6.1"

maya_umbrella-0.6.1/maya_umbrella/cleaner.py

@@ -0,0 +1,111 @@
+# Import built-in modules
+import glob
+import logging
+import os
+import re
+
+# Import local modules
+from maya_umbrella.constants import FILE_VIRUS_SIGNATURES
+from maya_umbrella.filesystem import remove_virus_file_by_signature
+from maya_umbrella.filesystem import safe_remove_file
+from maya_umbrella.filesystem import safe_rmtree
+from maya_umbrella.i18n import Translator
+from maya_umbrella.maya_funs import check_reference_node_exists
+from maya_umbrella.maya_funs import cmds
+
+
+class MayaVirusCleaner(object):
+    """A class to clean Maya virus files.
+
+    Attributes:
+        logger (Logger): Logger object for logging purposes.
+        translator (Translator): Translator object for translation purposes.
+        collector (MayaVirusCollector): MayaVirusCollector object for collecting issues.
+    """
+    def __init__(self, collector, logger=None):
+        """Initialize the MayaVirusCleaner.
+
+        Args:
+            collector (MayaVirusCollector): MayaVirusCollector object for collecting issues.
+            logger (Logger, optional): Logger object for logging purposes. Defaults to None, which creates a new logger.
+        """
+        self.logger = logger or logging.getLogger(__name__)
+        self.translator = Translator()
+        self.collector = collector
+
+    def callback_remove_rename_temp_files(self, *args, **kwargs):
+        """Remove temporary files in the local script path."""
+        self.logger.debug("Removing temporary files in %s", self.collector.local_script_path)
+        for temp_file in glob.glob(os.path.join(self.collector.local_script_path, "._*")):
+            safe_remove_file(temp_file)
+
+    def fix_script_jobs(self):
+        """Fix infected script jobs."""
+        for script_job in self.collector.infected_script_jobs:
+            script_num = int(re.findall(r"^(\d+):", script_job)[0])
+            self.logger.debug("Kill script job %s", script_job)
+            cmds.scriptJob(kill=script_num, force=True)
+            self.collector.remove_infected_script_job(script_job)
+
+    def fix_malicious_files(self):
+        """Fix malicious files."""
+        for file_ in self.collector.malicious_files:
+            if os.path.exists(file_):
+                if os.path.isfile(file_):
+                    self.logger.debug(self.translator.translate("remove_file", name=file_))
+                    safe_remove_file(file_)
+                    self.collector.remove_malicious_file(file_)
+                else:
+                    self.logger.debug(self.translator.translate("remove_path", name=file_))
+                    safe_rmtree(file_)
+                    self.collector.remove_malicious_file(file_)
+
+    def fix_infected_nodes(self):
+        """Fix infected nodes."""
+        for node in self.collector.infected_nodes:
+            is_referenced = check_reference_node_exists(node)
+            if is_referenced:
+                try:
+                    self.logger.debug(self.translator.translate("fix_infected_reference_nodes", name=node))
+                    cmds.setAttr("{node}.before".format(node=node), "", type="string")
+                    cmds.setAttr("{node}.after".format(node=node), "", type="string")
+                    cmds.setAttr("{node}.scriptType".format(node=node), 0)
+                    self.collector.remove_infected_node(node)
+                except Exception as e:
+                    self.logger.debug(e)
+            else:
+                try:
+                    cmds.lockNode(node, lock=False)
+                except ValueError:
+                    pass
+                try:
+                    self.logger.debug(self.translator.translate("fix_infected_nodes", name=node))
+                    cmds.delete(node)
+                except ValueError:
+                    pass
+                self.collector.remove_infected_node(node)
+
+    def setup_default_callbacks(self):
+        """Set up default callbacks."""
+        self.collector.add_maya_initialized_callback(self.callback_remove_rename_temp_files)
+        self.collector.add_maya_exiting_callback(self.callback_remove_rename_temp_files)
+
+    def fix_infected_files(self):
+        """Fix infected files."""
+        for file_path in self.collector.infected_files:
+            self.logger.info(self.translator.translate("fix_infected_files", name=file_path))
+            remove_virus_file_by_signature(file_path, FILE_VIRUS_SIGNATURES)
+            self.collector.remove_infected_file(file_path)
+
+    def fix(self):
+        """Fix all issues related to the Maya virus."""
+        if self.collector.have_issues:
+            maya_file = cmds.file(query=True, sceneName=True, shortName=True) or "empty/scene"
+            self.logger.info(self.translator.translate("start_fix_issues", name=maya_file))
+            self.fix_malicious_files()
+            self.fix_infected_files()
+            self.fix_infected_nodes()
+            self.fix_script_jobs()
+            for func in self.collector.get_additionally_fix_funcs():
+                func()
+            self.logger.info(self.translator.translate("finish_fix_issues", name=maya_file))