LimitedMediaServer/plugin_methods.py at main · mgatelabs/LimitedMediaServer · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
from typing import List, Dict


def plugin_string_arg(arg_name: str, arg_id: str, arg_description: str = '', prefix_lang_id: str = ''):
    return {
        "name": arg_name,
        "id": arg_id,
        "type": "string",
        "description": arg_description,
        "values": [],
        "prefix_lang_id": prefix_lang_id,
    }


def plugin_filename_arg(arg_name: str, arg_id: str, arg_description: str = '', prefix_lang_id: str = ''):
    return {
        "name": arg_name,
        "id": arg_id,
        "type": "filename",
        "description": arg_description,
        "values": [],
        "prefix_lang_id": prefix_lang_id,
    }


def plugin_long_string_arg(arg_name: str, arg_id: str, arg_description: str = '', prefix_lang_id: str = ''):
    return {
        "name": arg_name,
        "id": arg_id,
        "type": "longstring",
        "description": arg_description,
        "values": [],
        "prefix_lang_id": prefix_lang_id,
    }


def plugin_url_arg(arg_name: str, arg_id: str, arg_description: str = '', prefix_lang_id: str = '', clear_after: str = 'no', arg1: str = '', arg2: str = '', arg3: str = '', arg4: str = ''):
    return {
        "name": arg_name,
        "id": arg_id,
        "type": "url",
        "description": arg_description,
        "values": [],
        "prefix_lang_id": prefix_lang_id,
        "clear_after": clear_after,
        "arg1": arg1,
        "arg2": arg2,
        "arg3": arg3,
        "arg4": arg4,
    }


def plugin_select_arg(arg_name: str, arg_id: str, default_value: str, values: List[Dict[str, str]],
                      arg_description: str = '', prefix_lang_id: str = '', adv: str = ''):
    return {
        "name": arg_name,
        "id": arg_id,
        "type": "select",
        "default": default_value,
        "description": arg_description,
        "values": values,
        "prefix_lang_id": prefix_lang_id,
        "adv": adv,
    }


def plugin_select_values(*args) -> list:
    # Check if the number of arguments is divisible by 2 and > 0
    if len(args) == 0 or (len(args) % 2) != 0:
        raise ValueError("The number of arguments must be divisible by 2 and greater than 0.")

    # Create a list of dicts, pairing each consecutive argument
    result = [{"name": args[i], "id": args[i + 1]} for i in range(0, len(args), 2)]

    return result


PLUGIN_VALUES_Y_N = plugin_select_values("No", 'n', 'Yes', 'y')


def plugin_media_folder_chooser_move_folder_arg(arg_name: str, arg_id: str, arg_description: str = '',
                                                prefix_lang_id: str = ''):
    return {
        "name": arg_name,
        "id": arg_id,
        "type": "mfcmf",
        "description": arg_description,
        "values": [],
        "prefix_lang_id": prefix_lang_id,
    }


def plugin_media_folder_chooser_folder_arg(arg_name: str, arg_id: str, arg_description: str = '',
                                           prefix_lang_id: str = ''):
    return {
        "name": arg_name,
        "id": arg_id,
        "type": "mfc",
        "description": arg_description,
        "values": [],
        "prefix_lang_id": prefix_lang_id,
    }


def plugin_media_folder_display_arg(arg_name: str, arg_id: str, arg_description: str = '', prefix_lang_id: str = ''):
    return {
        "name": arg_name,
        "id": arg_id,
        "type": "mfd",
        "description": arg_description,
        "values": [],
        "prefix_lang_id": prefix_lang_id,
    }


def add_logging_arg(args: list) -> list:
    """
    Add a logging argument to the list of arguments.

    Args:
        args (list): The original list of arguments.

    Returns:
        list: The updated list of arguments with the logging argument added.
    """
    result = args.copy()  # Copy the original arguments list

    # Append the logging argument to the list
    result.append(plugin_select_arg("Logging Level", "_logging_level", "20", DEFAULT_LOGGING_VALUES, prefix_lang_id='com', adv='Y'))
    result.append(plugin_select_arg("Prevent Duplicate Tasks", "_duplicate_checking", "y", PLUGIN_VALUES_Y_N, prefix_lang_id='com', adv='Y'))

    # Ensure each argument has a description
    for row in result:
        if 'description' not in row:
            row['description'] = ''

    return result


DEFAULT_LOGGING_VALUES = plugin_select_values("Trace", '0', "Debug", '10', "Info", '20', "Warning", '30', "Error", '40', "Critical", '50')