import datetime import re import threading import traceback from pathlib import Path from typing import List, Tuple, Dict, Any, Optional import pytz from apscheduler.schedulers.background import BackgroundScheduler from apscheduler.triggers.cron import CronTrigger from watchdog.events import FileSystemEventHandler from watchdog.observers import Observer from watchdog.observers.polling import PollingObserver from app import schemas from app.core.config import settings from app.core.event import eventmanager, Event from app.log import logger from app.plugins import _PluginBase from app.schemas import NotificationType from app.schemas.types import EventType from app.utils.system import SystemUtils lock = threading.Lock() class FileMonitorHandler(FileSystemEventHandler): """ 目录监控响应类 """ def __init__(self, monpath: str, sync: Any, **kwargs): super(FileMonitorHandler, self).__init__(**kwargs) self._watch_path = monpath self.sync = sync def on_created(self, event): self.sync.event_handler(event=event, text="创建", mon_path=self._watch_path, event_path=event.src_path) def on_moved(self, event): self.sync.event_handler(event=event, text="移动", mon_path=self._watch_path, event_path=event.dest_path) class LinkMonitor(_PluginBase): # 插件名称 plugin_name = "实时硬链接" # 插件描述 plugin_desc = "监控目录文件变化,按原文件名硬链接。" # 插件图标 plugin_icon = "Linkace_C.png" # 插件版本 plugin_version = "1.6" # 插件作者 plugin_author = "jxxghp" # 作者主页 author_url = "https://github.com/jxxghp" # 插件配置项ID前缀 plugin_config_prefix = "linkmonitor_" # 加载顺序 plugin_order = 4 # 可使用的用户级别 auth_level = 1 # 私有属性 _scheduler = None _observer = [] _enabled = False _notify = False _onlyonce = False _cron = None _size = 0 # 转移方式 _monitor_dirs = "" _exclude_keywords = "" # 模式 compatibility/fast _mode = "fast" # 存储源目录与目的目录关系 _dirconf: Dict[str, Optional[Path]] = {} # 存储源目录转移方式 _transferconf: Dict[str, Optional[str]] = {} # 退出事件 _event = threading.Event() def init_plugin(self, config: dict = None): # 清空配置 self._dirconf = {} self._transferconf = {} # 读取配置 if config: self._enabled = config.get("enabled") self._notify = config.get("notify") self._onlyonce = config.get("onlyonce") self._mode = config.get("mode") self._monitor_dirs = config.get("monitor_dirs") or "" self._exclude_keywords = config.get("exclude_keywords") or "" self._cron = config.get("cron") self._size = config.get("size") or 0 # 停止现有任务 self.stop_service() if self._enabled or self._onlyonce: # 读取目录配置 monitor_dirs = self._monitor_dirs.split("\n") if not monitor_dirs: return for mon_path in monitor_dirs: # 格式源目录:目的目录 if not mon_path: continue # 存储目的目录 if SystemUtils.is_windows(): if mon_path.count(":") > 1: paths = [mon_path.split(":")[0] + ":" + mon_path.split(":")[1], mon_path.split(":")[2] + ":" + mon_path.split(":")[3]] else: paths = [mon_path] else: paths = mon_path.split(":") # 目的目录 if len(paths) > 1: mon_path = paths[0] target_path = Path(paths[1]) self._dirconf[mon_path] = target_path else: logger.warn(f"{mon_path} 未配置目的目录,将不会进行硬链接") self.systemmessage.put(f"{mon_path} 未配置目的目录,将不会进行硬链接!", title="实时硬链接") continue # 启用目录监控 if self._enabled: # 检查媒体库目录是不是下载目录的子目录 try: if target_path and target_path.is_relative_to(Path(mon_path)): logger.warn(f"{target_path} 是监控目录 {mon_path} 的子目录,无法监控") self.systemmessage.put(f"{target_path} 是下载目录 {mon_path} 的子目录,无法监控", title="实时硬链接") continue except Exception as e: logger.debug(str(e)) pass try: if self._mode == "compatibility": # 兼容模式,目录同步性能降低且NAS不能休眠,但可以兼容挂载的远程共享目录如SMB observer = PollingObserver(timeout=10) else: # 内部处理系统操作类型选择最优解 observer = Observer(timeout=10) self._observer.append(observer) observer.schedule(FileMonitorHandler(mon_path, self), path=mon_path, recursive=True) observer.daemon = True observer.start() logger.info(f"{mon_path} 的目录监控服务启动") except Exception as e: err_msg = str(e) if "inotify" in err_msg and "reached" in err_msg: logger.warn( f"目录监控服务启动出现异常:{err_msg},请在宿主机上(不是docker容器内)执行以下命令并重启:" + """ echo fs.inotify.max_user_watches=524288 | sudo tee -a /etc/sysctl.conf echo fs.inotify.max_user_instances=524288 | sudo tee -a /etc/sysctl.conf sudo sysctl -p """) else: logger.error(f"{mon_path} 启动目录监控失败:{err_msg}") self.systemmessage.put(f"{mon_path} 启动目录监控失败:{err_msg}", title="实时硬链接") # 运行一次定时服务 if self._onlyonce: # 定时服务管理器 self._scheduler = BackgroundScheduler(timezone=settings.TZ) logger.info("目录监控服务启动,立即运行一次") self._scheduler.add_job(func=self.sync_all, trigger='date', run_date=datetime.datetime.now( tz=pytz.timezone(settings.TZ)) + datetime.timedelta(seconds=3) ) # 关闭一次性开关 self._onlyonce = False # 保存配置 self.__update_config() # 启动定时服务 if self._scheduler.get_jobs(): self._scheduler.print_jobs() self._scheduler.start() def __update_config(self): """ 更新配置 """ self.update_config({ "enabled": self._enabled, "notify": self._notify, "onlyonce": self._onlyonce, "mode": self._mode, "monitor_dirs": self._monitor_dirs, "exclude_keywords": self._exclude_keywords, "cron": self._cron, "size": self._size }) @eventmanager.register(EventType.PluginAction) def remote_sync(self, event: Event): """ 远程全量同步 """ if event: event_data = event.event_data if not event_data or event_data.get("action") != "realtime_link": return self.post_message(channel=event.event_data.get("channel"), title="开始实时硬链接 ...", userid=event.event_data.get("user")) self.sync_all() if event: self.post_message(channel=event.event_data.get("channel"), title="实时硬链接完成!", userid=event.event_data.get("user")) def sync_all(self): """ 立即运行一次,全量同步目录中所有文件 """ logger.info("开始全量实时硬链接 ...") # 遍历所有监控目录 for mon_path in self._dirconf.keys(): # 遍历目录下所有文件 for file_path in SystemUtils.list_files(Path(mon_path), ['.*']): self.__handle_file(event_path=str(file_path), mon_path=mon_path) logger.info("全量实时硬链接完成!") def event_handler(self, event, mon_path: str, text: str, event_path: str): """ 处理文件变化 :param event: 事件 :param mon_path: 监控目录 :param text: 事件描述 :param event_path: 事件文件路径 """ if not event.is_directory: # 文件发生变化 logger.debug("文件%s:%s" % (text, event_path)) self.__handle_file(event_path=event_path, mon_path=mon_path) @staticmethod def _link_file(src_path: Path, mon_path: str, target_path: Path, transfer_type: str = "link") -> Tuple[bool, str]: """ 对文件做纯链接处理,不做识别重命名,则监控模块调用 :param : 来源渠道 :param src_path: 源文件 :param target_path: 目标目录 :param transfer_type: 转移方式 """ # 计算相对路径 try: rel_path = src_path.relative_to(Path(mon_path)) except ValueError: return False, "文件路径不在监控目录内" new_path = target_path / rel_path if new_path.exists(): return True, "目标路径文件已存在" else: # 创建目标目录 if not new_path.parent.exists(): new_path.parent.mkdir(parents=True, exist_ok=True) # 转移 if transfer_type == "copy": code, errmsg = SystemUtils.copy(src_path, new_path) else: code, errmsg = SystemUtils.link(src_path, new_path) return True if code == 0 else False, errmsg def __handle_file(self, event_path: str, mon_path: str): """ 同步一个文件 :param event_path: 事件文件路径 :param mon_path: 监控目录 """ file_path = Path(event_path) try: if not file_path.exists(): return # 全程加锁 with lock: # 回收站及隐藏的文件不处理 if event_path.find('/@Recycle/') != -1 \ or event_path.find('/#recycle/') != -1 \ or event_path.find('/.') != -1 \ or event_path.find('/@eaDir') != -1: logger.debug(f"{event_path} 是回收站或隐藏的文件") return # 命中过滤关键字不处理 if self._exclude_keywords: for keyword in self._exclude_keywords.split("\n"): if keyword and re.findall(keyword, event_path): logger.info(f"{event_path} 命中过滤关键字 {keyword},不处理") return # 判断文件大小 if self._size and float(self._size) > 0 and file_path.stat().st_size < float(self._size) * 1024: logger.info(f"{event_path} 文件大小小于最小文件大小,复制...") _transfer_type = "copy" else: _transfer_type = "link" # 查询转移目的目录 target: Path = self._dirconf.get(mon_path) if not target: logger.warn(f"{mon_path} 未配置目的目录,将不会进行硬链接") return # 开始硬连接 state, errmsg = self._link_file(src_path=file_path, mon_path=mon_path, target_path=target, transfer_type=_transfer_type) if not state: # 转移失败 logger.warn(f"{file_path.name} 硬链接失败:{errmsg}") if self._notify: self.post_message( mtype=NotificationType.Manual, title=f"{file_path.name} 硬链接失败!", text=f"原因:{errmsg or '未知'}" ) return # 转移成功 logger.info(f"{file_path.name} 硬链接成功") if self._notify: self.post_message( mtype=NotificationType.Manual, title=f"{file_path.name} 硬链接完成!", text=f"目标目录:{target}" ) except Exception as e: logger.error("目录监控发生错误:%s - %s" % (str(e), traceback.format_exc())) def get_state(self) -> bool: return self._enabled @staticmethod def get_command() -> List[Dict[str, Any]]: """ 定义远程控制命令 :return: 命令关键字、事件、描述、附带数据 """ return [{ "cmd": "/realtime_link", "event": EventType.PluginAction, "desc": "实时硬链接", "category": "管理", "data": { "action": "realtime_link" } }] def get_api(self) -> List[Dict[str, Any]]: return [{ "path": "/realtime_link", "endpoint": self.sync, "methods": ["GET"], "summary": "实时硬链接", "description": "实时硬链接", }] def get_service(self) -> List[Dict[str, Any]]: """ 注册插件公共服务 [{ "id": "服务ID", "name": "服务名称", "trigger": "触发器:cron/interval/date/CronTrigger.from_crontab()", "func": self.xxx, "kwargs": {} # 定时器参数 }] """ if self._enabled and self._cron: return [{ "id": "LinkMonitor", "name": "全量硬链接定时服务", "trigger": CronTrigger.from_crontab(self._cron), "func": self.sync_all, "kwargs": {} }] def sync(self, apikey: str) -> schemas.Response: """ API调用目录同步 """ if apikey != settings.API_TOKEN: return schemas.Response(success=False, message="API密钥错误") self.sync_all() return schemas.Response(success=True) def get_form(self) -> Tuple[List[dict], Dict[str, Any]]: return [ { 'component': 'VForm', 'content': [ { 'component': 'VRow', 'content': [ { 'component': 'VCol', 'props': { 'cols': 12, 'md': 4 }, 'content': [ { 'component': 'VSwitch', 'props': { 'model': 'enabled', 'label': '启用插件', } } ] }, { 'component': 'VCol', 'props': { 'cols': 12, 'md': 4 }, 'content': [ { 'component': 'VSwitch', 'props': { 'model': 'notify', 'label': '发送通知', } } ] }, { 'component': 'VCol', 'props': { 'cols': 12, 'md': 4 }, 'content': [ { 'component': 'VSwitch', 'props': { 'model': 'onlyonce', 'label': '立即运行一次', } } ] } ] }, { 'component': 'VRow', 'content': [ { 'component': 'VCol', 'props': { 'cols': 12, 'md': 4 }, 'content': [ { 'component': 'VSelect', 'props': { 'model': 'mode', 'label': '监控模式', 'items': [ {'title': '兼容模式', 'value': 'compatibility'}, {'title': '性能模式', 'value': 'fast'} ] } } ] }, { 'component': 'VCol', 'props': { 'cols': 12, 'md': 4 }, 'content': [ { 'component': 'VTextField', 'props': { 'model': 'cron', 'label': '定时全量同步周期', 'placeholder': '5位cron表达式,留空关闭' } } ] }, { 'component': 'VCol', 'props': { 'cols': 12, 'md': 4 }, 'content': [ { 'component': 'VTextField', 'props': { 'model': 'size', 'label': '最小文件大小(KB)', 'placeholder': '' } } ] } ] }, { 'component': 'VRow', 'content': [ { 'component': 'VCol', 'props': { 'cols': 12 }, 'content': [ { 'component': 'VTextarea', 'props': { 'model': 'monitor_dirs', 'label': '监控目录', 'rows': 5, 'placeholder': '每一行一个目录,支持以下几种配置方式:\n' '监控目录\n' '监控目录:转移目的目录\n' } } ] } ] }, { 'component': 'VRow', 'content': [ { 'component': 'VCol', 'props': { 'cols': 12, }, 'content': [ { 'component': 'VTextarea', 'props': { 'model': 'exclude_keywords', 'label': '排除关键词', 'rows': 2, 'placeholder': '每一行一个关键词' } } ] } ] }, { 'component': 'VRow', 'content': [ { 'component': 'VCol', 'props': { 'cols': 12, }, 'content': [ { 'component': 'VAlert', 'props': { 'type': 'info', 'variant': 'tonal', 'text': '最小文件大小:小于最小文件大小的文件将直接复制,其余则硬链接。' } } ] } ] } ] } ], { "enabled": False, "notify": False, "onlyonce": False, "mode": "fast", "monitor_dirs": "", "exclude_keywords": "", "cron": "", "size": "" } def get_page(self) -> List[dict]: pass def stop_service(self): """ 退出插件 """ if self._observer: for observer in self._observer: try: observer.stop() observer.join() except Exception as e: print(str(e)) self._observer = [] if self._scheduler: self._scheduler.remove_all_jobs() if self._scheduler.running: self._event.set() self._scheduler.shutdown() self._event.clear() self._scheduler = None