MoviePilot/app/modules/filemanager/storage/__init__.py

from abc import ABCMeta, abstractmethod
from pathlib import Path
from typing import Optional, List, Union

from app import schemas
from app.helper.storage import StorageHelper


class StorageBase(metaclass=ABCMeta):
    """
    存储基类
    """
    schema = None
    transtype = {}

    def __init__(self):
        self.storagehelper = StorageHelper()

    def get_config(self) -> Optional[schemas.StorageConf]:
        """
        获取配置
        """
        return self.storagehelper.get_storage(self.schema.value)

    def set_config(self, conf: dict):
        """
        设置配置
        """
        self.storagehelper.set_storage(self.schema.value, conf)

    def support_transtype(self) -> dict:
        """
        支持的整理方式
        """
        return self.transtype

    def is_support_transtype(self, transtype: str) -> bool:
        """
        是否支持整理方式
        """
        return transtype in self.transtype

    @abstractmethod
    def check(self) -> bool:
        """
        检查存储是否可用
        """
        pass
    
    @abstractmethod
    def list(self, fileitm: schemas.FileItem) -> Optional[List[schemas.FileItem]]:
        """
        浏览文件
        """
        pass

    @abstractmethod
    def create_folder(self, fileitm: schemas.FileItem, name: str) -> Optional[schemas.FileItem]:
        """
        创建目录
        """
        pass

    @abstractmethod
    def get_folder(self, path: Path) -> Optional[schemas.FileItem]:
        """
        获取目录
        """
        pass

    @abstractmethod
    def delete(self, fileitm: schemas.FileItem) -> bool:
        """
        删除文件
        """
        pass

    @abstractmethod
    def rename(self, fileitm: schemas.FileItem, name: str) -> bool:
        """
        重命名文件
        """
        pass

    @abstractmethod
    def download(self, fileitm: schemas.FileItem, path: Path) -> bool:
        """
        下载文件，保存到本地
        """
        pass

    @abstractmethod
    def upload(self, fileitm: schemas.FileItem, path: Path) -> Optional[schemas.FileItem]:
        """
        上传文件
        """
        pass
    
    @abstractmethod
    def detail(self, fileitm: schemas.FileItem) -> Optional[schemas.FileItem]:
        """
        获取文件详情
        """
        pass

    @abstractmethod
    def copy(self, fileitm: schemas.FileItem, target_file: Path) -> bool:
        """
        复制文件
        """
        pass

    @abstractmethod
    def move(self, fileitm: schemas.FileItem, target: Union[schemas.FileItem, Path]) -> bool:
        """
        移动文件
        """
        pass

    @abstractmethod
    def link(self, fileitm: schemas.FileItem, target_file: Path) -> bool:
        """
        硬链接文件
        """
        pass

    @abstractmethod
    def softlink(self, fileitm: schemas.FileItem, target_file: Path) -> bool:
        """
        软链接文件
        """
        pass