Skip to content
GitLab
Switch branch/tag
Find file Normal viewHistoryPermalink
base.py 9.45 KB
Newer Older
echel0n's avatar
Updated copyright notices.    
echel0n committed
1 
# ##############################################################################
echel0n's avatar
Restructured web view folders and classes.  
echel0n committed
2
3
4 
#  Author: echel0n <[email protected]>
#  URL: https://sickrage.ca/
#  Git: https://git.sickrage.ca/SiCKRAGE/sickrage.git
echel0n's avatar
Updated copyright notices.    
echel0n committed
5 
#  -
echel0n's avatar
Restructured web view folders and classes.  
echel0n committed
6 
#  This file is part of SiCKRAGE.
echel0n's avatar
Updated copyright notices.    
echel0n committed
7 
#  -
echel0n's avatar
Restructured web view folders and classes.  
echel0n committed
8
9
10
11 
#  SiCKRAGE 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, either version 3 of the License, or
#  (at your option) any later version.
echel0n's avatar
Updated copyright notices.    
echel0n committed
12 
#  -
echel0n's avatar
Restructured web view folders and classes.  
echel0n committed
13
14
15
16 
#  SiCKRAGE 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.
echel0n's avatar
Updated copyright notices.    
echel0n committed
17 
#  -
echel0n's avatar
Restructured web view folders and classes.  
echel0n committed
18
19 
#  You should have received a copy of the GNU General Public License
#  along with SiCKRAGE.  If not, see <http://www.gnu.org/licenses/>.
echel0n's avatar
Updated copyright notices.    
echel0n committed
20 
# ##############################################################################
echel0n's avatar
Fixed issues with version updating.    
echel0n committed
21 
import functools
echel0n's avatar
Restructured web view folders and classes.  
echel0n committed
22
23 
import time
import traceback
echel0n's avatar
Added static file handlers for new Web-UI to web server    
echel0n committed
24
25 
import types
from concurrent.futures.thread import ThreadPoolExecutor
echel0n's avatar
Implemented abstract class in web base handler    
echel0n committed
26 
from typing import Optional, Awaitable
echel0n's avatar
Restructured web view folders and classes.  
echel0n committed
27
28 
from urllib.parse import urlparse, urljoin
echel0n's avatar
Added bleach to requirements.txt to clean input data from HTML forms    
echel0n committed
29 
import bleach
echel0n's avatar
Refactored getting current user info from decoded token instead of userinfo endpoint    
echel0n committed
30 
from jose import ExpiredSignatureError
echel0n's avatar
Restructured web view folders and classes.  
echel0n committed
31
32 
from keycloak.exceptions import KeycloakClientError
from mako.exceptions import RichTraceback
echel0n's avatar
Moved websocket queue check function to webserver class    
echel0n committed
33
34 
from tornado import locale
from tornado.escape import utf8
echel0n's avatar
Refactored external API to v6    
echel0n committed
35 
from tornado.ioloop import IOLoop
echel0n's avatar
Restructured web view folders and classes.  
echel0n committed
36
37
38 
from tornado.web import RequestHandler

import sickrage
echel0n's avatar
Config settings are now stored and encrypted into a sqlite database    
echel0n committed
39 
from sickrage.core.helpers import is_ip_whitelisted, torrent_webui_url
echel0n's avatar
Restructured web view folders and classes.  
echel0n committed
40
echel0n's avatar
Added function to commit database session after web session is finished.    
echel0n committed
41
echel0n's avatar
Implemented abstract class in web base handler    
echel0n committed
42 
class BaseHandler(RequestHandler):
echel0n's avatar
Restructured web view folders and classes.  
echel0n committed
43
44 
    def __init__(self, application, request, **kwargs):
        super(BaseHandler, self).__init__(application, request, **kwargs)
echel0n's avatar
Added static file handlers for new Web-UI to web server    
echel0n committed
45
echel0n's avatar
Refactored web handlers to return data and call tornado finish on resp from run_async method    
echel0n committed
46 
        self.executor = ThreadPoolExecutor(thread_name_prefix='WEB-Thread')
echel0n's avatar
Feature added to allow downloading NZBs using Synology Download Station    
echel0n committed
47
echel0n's avatar
Restructured web view folders and classes.  
echel0n committed
48
49 
        self.startTime = time.time()
echel0n's avatar
Implemented abstract class in web base handler    
echel0n committed
50
51
52 
    def data_received(self, chunk: bytes) -> Optional[Awaitable[None]]:
        pass
echel0n's avatar
Restructured web view folders and classes.  
echel0n committed
53 
    def get_user_locale(self):
echel0n's avatar
Config settings are now stored and encrypted into a sqlite database    
echel0n committed
54 
        return locale.get(sickrage.app.config.gui.gui_lang)
echel0n's avatar
Restructured web view folders and classes.  
echel0n committed
55
56 

    def write_error(self, status_code, **kwargs):
echel0n's avatar
Do not log 401 and 404 HTTP errors, to much bot scanning activity    
echel0n committed
57 
        if status_code not in [401, 404] and "exc_info" in kwargs:
echel0n's avatar
Restructured web view folders and classes.  
echel0n committed
58 
            exc_info = kwargs["exc_info"]
echel0n's avatar
Refactored web server write_error function to log issues using error handler    
echel0n committed
59 
            error = repr(exc_info[1])
echel0n's avatar
Restructured web view folders and classes.  
echel0n committed
60
echel0n's avatar
Refactored web server write_error function to log issues using error handler    
echel0n committed
61 
            sickrage.app.log.error(error)
echel0n's avatar
Restructured web view folders and classes.  
echel0n committed
62
echel0n's avatar
Refactored web server write_error function to log issues using error handler    
echel0n committed
63
64
65
66
67 
            if self.settings.get("debug"):
                trace_info = ''.join([f"{line}<br>" for line in traceback.format_exception(*exc_info)])
                request_info = ''.join([f"<strong>{k}</strong>: {v}<br>" for k, v in self.request.__dict__.items()])

                self.set_header('Content-Type', 'text/html')
echel0n's avatar
Refactored web handlers to return data and call tornado finish on resp from run_async method    
echel0n committed
68 
                return self.finish(f"""<html>
echel0n's avatar
Refactored web server write_error function to log issues using error handler    
echel0n committed
69
70
71
72
73
74
75
76
77
78
79
80
81 
                                 <title>{error}</title>
                                 <body>
                                    <button onclick="window.location='{sickrage.app.config.general.web_root}/logs/';">View Log(Errors)</button>
                                    <button onclick="window.location='{sickrage.app.config.general.web_root}/home/restart?pid={sickrage.app.pid}&force=1';">Restart SiCKRAGE</button>
                                    <button onclick="window.location='{sickrage.app.config.general.web_root}/logout';">Logout</button>
                                    <h2>Error</h2>
                                    <p>{error}</p>
                                    <h2>Traceback</h2>
                                    <p>{trace_info}</p>
                                    <h2>Request Info</h2>
                                    <p>{request_info}</p>
                                 </body>
                               </html>""")
echel0n's avatar
Restructured web view folders and classes.  
echel0n committed
82
83 

    def get_current_user(self):
echel0n's avatar
Added link/unlink button to `settings -> general -> advanced -> sickrage api`...    
echel0n committed
84 
        if is_ip_whitelisted(self.request.remote_ip):
echel0n's avatar
Refactored SiCKRAGE authorization client interface    
echel0n committed
85 
            return True
echel0n's avatar
Config settings are now stored and encrypted into a sqlite database    
echel0n committed
86 
        elif sickrage.app.config.general.sso_auth_enabled and sickrage.app.auth_server.health:
echel0n's avatar
Refactored gitlab ci/cd script to clone to a depth of 10    
echel0n committed
87 
            try:
echel0n's avatar
Refactored SiCKRAGE authorization client interface    
echel0n committed
88
89
90
91
92 
                access_token = self.get_secure_cookie('_sr_access_token')
                refresh_token = self.get_secure_cookie('_sr_refresh_token')
                if not all([access_token, refresh_token]):
                    return
echel0n's avatar
Added NoneType check for when fetching certs from sickrage auth server    
echel0n committed
93
94
95
96 
                certs = sickrage.app.auth_server.certs()
                if not certs:
                    return
echel0n's avatar
Refactored SiCKRAGE authorization client interface    
echel0n committed
97 
                try:
echel0n's avatar
Added NoneType check for when fetching certs from sickrage auth server    
echel0n committed
98 
                    return sickrage.app.auth_server.decode_token(access_token.decode("utf-8"), certs)
echel0n's avatar
Refactored SiCKRAGE authorization client interface    
echel0n committed
99
100 
                except (KeycloakClientError, ExpiredSignatureError):
                    token = sickrage.app.auth_server.refresh_token(refresh_token.decode("utf-8"))
echel0n's avatar
Refactored SiCKRAGE API status code 204 to return `True` if response is OK    
echel0n committed
101
102
103 
                    if not token:
                        return
echel0n's avatar
Refactored SiCKRAGE authorization client interface    
echel0n committed
104
105 
                    self.set_secure_cookie('_sr_access_token', token['access_token'])
                    self.set_secure_cookie('_sr_refresh_token', token['refresh_token'])
echel0n's avatar
Added NoneType check for when fetching certs from sickrage auth server    
echel0n committed
106 
                    return sickrage.app.auth_server.decode_token(token['access_token'], certs)
echel0n's avatar
Refactored SiCKRAGE authorization client interface    
echel0n committed
107 
            except Exception as e:
echel0n's avatar
Removed debug logging from current_user web base method    
echel0n committed
108 
                return
echel0n's avatar
Config settings are now stored and encrypted into a sqlite database    
echel0n committed
109 
        elif sickrage.app.config.general.local_auth_enabled:
echel0n's avatar
Refactored SiCKRAGE authorization client interface    
echel0n committed
110 
            cookie = self.get_secure_cookie('_sr').decode() if self.get_secure_cookie('_sr') else None
echel0n's avatar
Config settings are now stored and encrypted into a sqlite database    
echel0n committed
111 
            if cookie == sickrage.app.config.general.api_v1_key:
echel0n's avatar
Refactored SiCKRAGE authorization client interface    
echel0n committed
112 
                return True
echel0n's avatar
Restructured web view folders and classes.  
echel0n committed
113
echel0n's avatar
Refactored web handlers to return data and call tornado finish on resp from run_async method    
echel0n committed
114 
    def render(self, template_name, **kwargs):
echel0n's avatar
Restructured web view folders and classes.  
echel0n committed
115
116
117
118
119
120
121
122 
        template_kwargs = {
            'title': "",
            'header': "",
            'topmenu': "",
            'submenu': "",
            'controller': "home",
            'action': "index",
            'srPID': sickrage.app.pid,
echel0n's avatar
Config settings are now stored and encrypted into a sqlite database    
echel0n committed
123 
            'srHttpsEnabled': sickrage.app.config.general.enable_https or bool(self.request.headers.get('X-Forwarded-Proto') == 'https'),
echel0n's avatar
Restructured web view folders and classes.  
echel0n committed
124 
            'srHost': self.request.headers.get('X-Forwarded-Host', self.request.host.split(':')[0]),
echel0n's avatar
Config settings are now stored and encrypted into a sqlite database    
echel0n committed
125
126
127
128
129 
            'srHttpPort': self.request.headers.get('X-Forwarded-Port', sickrage.app.config.general.web_port),
            'srHttpsPort': sickrage.app.config.general.web_port,
            'srHandleReverseProxy': sickrage.app.config.general.handle_reverse_proxy,
            'srDefaultPage': sickrage.app.config.general.default_page.value,
            'srWebRoot': sickrage.app.config.general.web_root,
echel0n's avatar
Restructured web view folders and classes.  
echel0n committed
130
131
132
133
134 
            'srLocale': self.get_user_locale().code,
            'srLocaleDir': sickrage.LOCALE_DIR,
            'srStartTime': self.startTime,
            'makoStartTime': time.time(),
            'overall_stats': None,
echel0n's avatar
Config settings are now stored and encrypted into a sqlite database    
echel0n committed
135 
            'torrent_webui_url': torrent_webui_url(),
echel0n's avatar
Restructured web view folders and classes.  
echel0n committed
136
137
138
139
140
141
142
143 
            'application': self.application,
            'request': self.request,
        }

        template_kwargs.update(self.get_template_namespace())
        template_kwargs.update(kwargs)

        try:
echel0n's avatar
Refactored mako templates to be looked up and stored into template dict...    
echel0n committed
144 
            return self.application.settings['templates'][template_name].render_unicode(**template_kwargs)
echel0n's avatar
Restructured web view folders and classes.  
echel0n committed
145
146
147
148
149
150 
        except Exception:
            kwargs['title'] = _('HTTP Error 500')
            kwargs['header'] = _('HTTP Error 500')
            kwargs['backtrace'] = RichTraceback()
            template_kwargs.update(kwargs)
echel0n's avatar
Fixed issues with manual searches, added session decorator to snatch episode function.    
echel0n committed
151 
            sickrage.app.log.error("%s: %s" % (str(kwargs['backtrace'].error.__class__.__name__), kwargs['backtrace'].error))
echel0n's avatar
Restructured web view folders and classes.  
echel0n committed
152
echel0n's avatar
Refactored mako templates to be looked up and stored into template dict...    
echel0n committed
153 
            return self.application.settings['templates']['errors/500.mako'].render_unicode(**template_kwargs)
echel0n's avatar
Restructured web view folders and classes.  
echel0n committed
154
155
156 

    def set_default_headers(self):
        self.set_header("Access-Control-Allow-Origin", "*")
echel0n's avatar
Added static file handlers for new Web-UI to web server    
echel0n committed
157
158
159 
        self.set_header("Access-Control-Allow-Headers", "Content-Type, Access-Control-Allow-Headers, Authorization, X-Requested-With")
        self.set_header('Access-Control-Allow-Methods', 'POST, GET, PUT, PATCH, DELETE, OPTIONS')
        self.set_header('Cache-Control', 'no-store, no-cache, must-revalidate, max-age=0')
echel0n's avatar
Restructured web view folders and classes.  
echel0n committed
160
echel0n's avatar
Refactored web handlers to return data and call tornado finish on resp from run_async method    
echel0n committed
161
162 
    def redirect(self, url, permanent=True, status=None, add_web_root=True):
        if add_web_root and sickrage.app.config.general.web_root not in url:
echel0n's avatar
Config settings are now stored and encrypted into a sqlite database    
echel0n committed
163 
            url = urljoin(sickrage.app.config.general.web_root + '/', url.lstrip('/'))
echel0n's avatar
Moved websocket queue check function to webserver class    
echel0n committed
164
165
166
167
168
169
170
171
172 

        if self._headers_written:
            raise Exception("Cannot redirect after headers have been written")
        if status is None:
            status = 301 if permanent else 302
        else:
            assert isinstance(status, int) and 300 <= status <= 399
        self.set_status(status)
        self.set_header("Location", utf8(url))
echel0n's avatar
Restructured web view folders and classes.  
echel0n committed
173
174 

    def previous_url(self):
echel0n's avatar
Config settings are now stored and encrypted into a sqlite database    
echel0n committed
175 
        url = urlparse(self.request.headers.get("referer", "/{}/".format(sickrage.app.config.general.default_page.value)))
echel0n's avatar
Restructured web view folders and classes.  
echel0n committed
176
177 
        return url._replace(scheme="", netloc="").geturl()
echel0n's avatar
Refactored web handlers to run in executor in the background, this will...    
echel0n committed
178 
    def _genericMessage(self, subject, message):
echel0n's avatar
Refactored mako templates to be looked up and stored into template dict...    
echel0n committed
179
180
181
182
183
184 
        return self.render('generic_message.mako',
                           message=message,
                           subject=subject,
                           title="",
                           controller='root',
                           action='genericmessage')
echel0n's avatar
Restructured web view folders and classes.  
echel0n committed
185
186 

    def get_url(self, url):
echel0n's avatar
Config settings are now stored and encrypted into a sqlite database    
echel0n committed
187
188 
        if sickrage.app.config.general.web_root not in url:
            url = urljoin(sickrage.app.config.general.web_root + '/', url.lstrip('/'))
echel0n's avatar
Restructured web view folders and classes.  
echel0n committed
189
190
191 
        url = urljoin("{}://{}".format(self.request.protocol, self.request.host), url)
        return url
echel0n's avatar
Added static file handlers for new Web-UI to web server    
echel0n committed
192
193
194 
    def run_async(self, method):
        @functools.wraps(method)
        async def wrapper(self, *args, **kwargs):
echel0n's avatar
Refactored web handlers to return data and call tornado finish on resp from run_async method    
echel0n committed
195
196 
            resp = await IOLoop.current().run_in_executor(self.executor, functools.partial(method, *args, **kwargs))
            self.finish(resp)
echel0n's avatar
Added static file handlers for new Web-UI to web server    
echel0n committed
197
198
199
200
201
202
203
204
205
206 

        return types.MethodType(wrapper, self)

    def prepare(self):
        method_name = self.request.method.lower()
        method = self.run_async(getattr(self, method_name))
        setattr(self, method_name, method)

    def options(self, *args, **kwargs):
        self.set_status(204)
echel0n's avatar
Added bleach to requirements.txt to clean input data from HTML forms    
echel0n committed
207
208
209
210
211
212
213
214 

    def get_argument(self, *args, **kwargs):
        value = super(BaseHandler, self).get_argument(*args, **kwargs)

        try:
            return bleach.clean(value)
        except TypeError:
            return value