source/path_accept/plugin.py - master - kushpel/plugins

source/path_accept/plugin.py
82 строки3 KB
yajrendrag
revert
02 дек 2023, 01:06
02 дек 2023, 01:060c2c46a
#!/usr/bin/env python3
# -*- coding: utf-8 -*-

"""
    Written by:               Josh.5 <jsunnex@gmail.com>
    Date:                     8 May 2021, (11:32 PM)
 
    Copyright:
        Copyright (C) 2021 Josh Sunnex

        This program is free software: you can redistribute it and/or modify it under the terms of the GNU General
        Public License as published by the Free Software Foundation, version 3.

        This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the
        implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
        for more details.

        You should have received a copy of the GNU General Public License along with this program.
        If not, see <https://www.gnu.org/licenses/>.

"""
import re
import logging

from unmanic.libs.unplugins.settings import PluginSettings

# Configure plugin logger
logger = logging.getLogger("Unmanic.Plugin.path_accept")

class Settings(PluginSettings):
    settings = {
        "patterns": "",
    }

    form_settings = {
        "patterns": {
            "input_type": "textarea",
            "label":      "Patterns"
        }
    }


def on_library_management_file_test(data):
    """
    Runner function - enables additional actions during the library management file tests.

    The 'data' object argument includes:
        path                            - String containing the full path to the file being tested.
        issues                          - List of currently found issues for not processing the file.
        add_file_to_pending_tasks       - Boolean, is the file currently marked to be added to the queue for processing.

    :param data:
    :return:

    """
    # Configure settings object (maintain compatibility with v1 plugins)
    if data.get('library_id'):
        settings = Settings(library_id=data.get('library_id'))
    else:
        settings = Settings()

    regex_patterns = settings.get_setting('patterns')

    file_path = data.get('path')
    for regex_pattern in regex_patterns.splitlines():
        if not regex_pattern:
            continue

        pattern = re.compile(regex_pattern)
        if pattern.search(file_path):
            # Found a match
            logger.info("file path '{}' matches pattern '{}'.  File not ignored based on path".format(file_path, regex_pattern))
            return data

    data['add_file_to_pending_tasks'] = False
    data['issues'].append({
         'id':      'Path Accept',
         'message': "File should not be accepted because path '{}' did not match any configured regex '{}'".format(
            file_path, regex_patterns),
    })

    return data