summaryrefslogtreecommitdiff
path: root/server/szurubooru/rest/context.py
blob: a75ca60783b0836f82f51165ca5ef04203eab4b6 (plain)
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
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
from typing import Any, Dict, List, Optional, Union, cast

from szurubooru import errors, model
from szurubooru.func import file_uploads, net

MISSING = object()
Request = Dict[str, Any]
Response = Optional[Dict[str, Any]]


class Context:
    def __init__(
        self,
        env: Dict[str, Any],
        method: str,
        url: str,
        headers: Dict[str, str] = None,
        params: Request = None,
        files: Dict[str, bytes] = None,
    ) -> None:
        self.env = env
        self.method = method
        self.url = url
        self._headers = headers or {}
        self._params = params or {}
        self._files = files or {}

        self.user = model.User()
        self.user.name = None
        self.user.rank = "anonymous"

        self.session = None  # type: Any

    def has_header(self, name: str) -> bool:
        return name in self._headers

    def get_header(self, name: str) -> str:
        return self._headers.get(name, "")

    def has_file(self, name: str, allow_tokens: bool = True) -> bool:
        return (
            name in self._files
            or name + "Url" in self._params
            or (allow_tokens and name + "Token" in self._params)
        )

    def get_file(
        self,
        name: str,
        default: Union[object, bytes] = MISSING,
        use_video_downloader: bool = False,
        allow_tokens: bool = True,
    ) -> bytes:
        if name in self._files and self._files[name]:
            return self._files[name]

        if name + "Url" in self._params:
            return net.download(
                self._params[name + "Url"],
                use_video_downloader=use_video_downloader,
            )

        if allow_tokens and name + "Token" in self._params:
            ret = file_uploads.get(self._params[name + "Token"])
            if ret:
                return ret
            elif default is not MISSING:
                raise errors.MissingOrExpiredRequiredFileError(
                    "Required file %r is missing or has expired." % name
                )

        if default is not MISSING:
            return cast(bytes, default)
        raise errors.MissingRequiredFileError(
            "Required file %r is missing." % name
        )

    def has_param(self, name: str) -> bool:
        return name in self._params

    def get_param(self, name: str) -> Any:
        return self._params[name]

    def get_param_as_list(
        self, name: str, default: Union[object, List[Any]] = MISSING
    ) -> List[Any]:
        if name not in self._params:
            if default is not MISSING:
                return cast(List[Any], default)
            raise errors.MissingRequiredParameterError(
                "Required parameter %r is missing." % name
            )
        value = self._params[name]
        if type(value) is str:
            if "," in value:
                return value.split(",")
            return [value]
        if type(value) is list:
            return value
        raise errors.InvalidParameterError(
            "Parameter %r must be a list." % name
        )

    def get_param_as_int_list(
        self, name: str, default: Union[object, List[int]] = MISSING
    ) -> List[int]:
        ret = self.get_param_as_list(name, default)
        for item in ret:
            if type(item) is not int:
                raise errors.InvalidParameterError(
                    "Parameter %r must be a list of integer values." % name
                )
        return ret

    def get_param_as_string_list(
        self, name: str, default: Union[object, List[str]] = MISSING
    ) -> List[str]:
        ret = self.get_param_as_list(name, default)
        for item in ret:
            if type(item) is not str:
                raise errors.InvalidParameterError(
                    "Parameter %r must be a list of string values." % name
                )
        return ret

    def get_param_as_string(
        self, name: str, default: Union[object, str] = MISSING
    ) -> str:
        if name not in self._params:
            if default is not MISSING:
                return cast(str, default)
            raise errors.MissingRequiredParameterError(
                "Required parameter %r is missing." % name
            )
        value = self._params[name]
        try:
            if value is None:
                return ""
            if type(value) is list:
                return ",".join(value)
            if type(value) is int or type(value) is float:
                return str(value)
            if type(value) is str:
                return value
        except TypeError:
            pass
        raise errors.InvalidParameterError(
            "Parameter %r must be a string value." % name
        )

    def get_param_as_int(
        self,
        name: str,
        default: Union[object, int] = MISSING,
        min: Optional[int] = None,
        max: Optional[int] = None,
    ) -> int:
        if name not in self._params:
            if default is not MISSING:
                return cast(int, default)
            raise errors.MissingRequiredParameterError(
                "Required parameter %r is missing." % name
            )
        value = self._params[name]
        try:
            value = int(value)
            if min is not None and value < min:
                raise errors.InvalidParameterError(
                    "Parameter %r must be at least %r." % (name, min)
                )
            if max is not None and value > max:
                raise errors.InvalidParameterError(
                    "Parameter %r may not exceed %r." % (name, max)
                )
            return value
        except (ValueError, TypeError):
            pass
        raise errors.InvalidParameterError(
            "Parameter %r must be an integer value." % name
        )

    def get_param_as_float(
            self,
            name: str,
            default: Union[object, float] = MISSING,
            min: Optional[float] = None,
            max: Optional[float] = None) -> float:
        if name not in self._params:
            if default is not MISSING:
                return cast(float, default)
            raise errors.MissingRequiredParameterError(
                "Required parameter %r is missing." % name)
        value = self._params[name]
        try:
            value = float(value)
            if min is not None and value < min:
                raise errors.InvalidParameterError(
                    "Parameter %r must be at least %r." % (name, min))
            if max is not None and value > max:
                raise errors.InvalidParameterError(
                    "Parameter %r may not exceed %r." % (name, max))
            return value
        except (ValueError, TypeError):
            pass
        raise errors.InvalidParameterError(
            "Parameter %r must be a float value." % name)

    def get_param_as_bool(
        self, name: str, default: Union[object, bool] = MISSING
    ) -> bool:
        if name not in self._params:
            if default is not MISSING:
                return cast(bool, default)
            raise errors.MissingRequiredParameterError(
                "Required parameter %r is missing." % name
            )
        value = self._params[name]
        try:
            value = str(value).lower()
        except TypeError:
            pass
        if value in ["1", "y", "yes", "yeah", "yep", "yup", "t", "true"]:
            return True
        if value in ["0", "n", "no", "nope", "f", "false"]:
            return False
        raise errors.InvalidParameterError(
            "Parameter %r must be a boolean value." % name
        )