]> git.ipfire.org Git - ipfire.org.git/blob - src/web/base.py
b92ad74fa109e8375c6efb396962c3f59116dfe3
[ipfire.org.git] / src / web / base.py
1 #!/usr/bin/python
2
3 import datetime
4 import dateutil.parser
5 import functools
6 import http.client
7 import ipaddress
8 import logging
9 import time
10 import tornado.locale
11 import tornado.web
12
13 from ..decorators import *
14 from .. import util
15
16 def blacklisted(method):
17 @tornado.gen.coroutine
18 @functools.wraps(method)
19 def wrapper(self, *args, **kwargs):
20 # Check if remote is blacklisted
21 is_blacklisted = yield self.remote.is_blacklisted()
22
23 # If so, redirect to the blocked page
24 if is_blacklisted:
25 logging.warning("%s is blacklisted" % self.remote)
26
27 return self.redirect("https://www.ipfire.org/blocked")
28
29 return method(self, *args, **kwargs)
30
31 return wrapper
32
33 class ratelimit(object):
34 def __init__(self, minutes=15, requests=180):
35 self.minutes = minutes
36 self.requests = requests
37
38 def __call__(self, method):
39 @functools.wraps(method)
40 def wrapper(handler, *args, **kwargs):
41 # Pass the request to the rate limiter and get a request object
42 req = handler.backend.ratelimiter.handle_request(handler.request,
43 handler, minutes=self.minutes, limit=self.requests)
44
45 # If the rate limit has been reached, we won't allow
46 # processing the request and therefore send HTTP error code 429.
47 if req.is_ratelimited():
48 raise tornado.web.HTTPError(429, "Rate limit exceeded")
49
50 return method(handler, *args, **kwargs)
51
52 return wrapper
53
54
55 class BaseHandler(tornado.web.RequestHandler):
56 def set_expires(self, seconds):
57 # For HTTP/1.1
58 self.add_header("Cache-Control", "max-age=%s, must-revalidate" % seconds)
59
60 # For HTTP/1.0
61 expires = datetime.datetime.utcnow() + datetime.timedelta(seconds=seconds)
62 self.add_header("Expires", expires)
63
64 def write_error(self, status_code, **kwargs):
65 # Translate code into message
66 try:
67 message = http.client.responses[status_code]
68 except KeyError:
69 message = None
70
71 self.render("error.html", status_code=status_code, message=message, **kwargs)
72
73 def xsrf_form_html(self, *args, **kwargs):
74 # Set Vary: Cookie header
75 self.add_header("Vary", "Cookie")
76
77 return super().xsrf_form_html(*args, **kwargs)
78
79 @property
80 def hostname(self):
81 # Remove the development prefix
82 return self.request.host.replace(".dev.", ".")
83
84 def get_template_namespace(self):
85 ns = tornado.web.RequestHandler.get_template_namespace(self)
86
87 now = datetime.date.today()
88
89 ns.update({
90 "backend" : self.backend,
91 "debug" : self.application.settings.get("debug", False),
92 "format_size" : util.format_size,
93 "format_time" : util.format_time,
94 "hostname" : self.hostname,
95 "now" : now,
96 "year" : now.year,
97 })
98
99 return ns
100
101 def get_remote_ip(self):
102 # Fix for clients behind a proxy that sends "X-Forwarded-For".
103 remote_ips = self.request.remote_ip.split(", ")
104
105 for remote_ip in remote_ips:
106 try:
107 addr = ipaddress.ip_address(remote_ip)
108 except ValueError:
109 # Skip invalid IP addresses.
110 continue
111
112 # Check if the given IP address is from a
113 # private network.
114 if addr.is_private:
115 continue
116
117 return remote_ip
118
119 # Return the last IP if nothing else worked
120 return remote_ips.pop()
121
122 @lazy_property
123 def remote(self):
124 address = self.get_remote_ip()
125
126 if address:
127 return self.backend.geoip.lookup(address)
128
129 @lazy_property
130 def current_country_code(self):
131 remote_ip = self.get_remote_ip()
132
133 if remote_ip:
134 return self.backend.geoip.get_country(remote_ip)
135
136 def get_remote_location(self):
137 if not hasattr(self, "__remote_location"):
138 remote_ip = self.get_remote_ip()
139
140 self.__remote_location = self.geoip.get_location(remote_ip)
141
142 return self.__remote_location
143
144 def get_argument_int(self, *args, **kwargs):
145 arg = self.get_argument(*args, **kwargs)
146
147 if arg is None or arg == "":
148 return
149
150 try:
151 return int(arg)
152 except ValueError:
153 raise tornado.web.HTTPError(400)
154
155 def get_argument_date(self, arg, *args, **kwargs):
156 value = self.get_argument(arg, *args, **kwargs)
157 if value is None:
158 return
159
160 try:
161 return dateutil.parser.parse(value)
162 except ValueError:
163 raise tornado.web.HTTPError(400)
164
165 def get_file(self, name):
166 try:
167 file = self.request.files[name][0]
168
169 return file["filename"], file["body"], file["content_type"]
170 except KeyError:
171 return None
172
173 # Login stuff
174
175 def get_current_user(self):
176 session_id = self.get_cookie("session_id")
177 if not session_id:
178 return
179
180 # Get account from the session object
181 account = self.backend.accounts.get_by_session(session_id, self.request.host)
182
183 # If the account was not found or the session was not valid
184 # any more, we will remove the cookie.
185 if not account:
186 self.clear_cookie("session_id")
187
188 return account
189
190 @property
191 def backend(self):
192 return self.application.backend
193
194 @property
195 def db(self):
196 return self.backend.db
197
198 @property
199 def accounts(self):
200 return self.backend.accounts
201
202 @property
203 def downloads(self):
204 return self.backend.downloads
205
206 @property
207 def fireinfo(self):
208 return self.backend.fireinfo
209
210 @property
211 def iuse(self):
212 return self.backend.iuse
213
214 @property
215 def memcached(self):
216 return self.backend.memcache
217
218 @property
219 def mirrors(self):
220 return self.backend.mirrors
221
222 @property
223 def netboot(self):
224 return self.backend.netboot
225
226 @property
227 def releases(self):
228 return self.backend.releases
229
230 @property
231 def geoip(self):
232 return self.backend.geoip
233
234 @property
235 def talk(self):
236 return self.backend.talk
237
238
239 class NotFoundHandler(BaseHandler):
240 def prepare(self):
241 # Raises 404 as soon as it is called
242 raise tornado.web.HTTPError(404)
243
244
245 class ErrorHandler(BaseHandler):
246 """
247 Raises any error we want
248 """
249 def get(self, code):
250 try:
251 code = int(code)
252 except:
253 raise tornado.web.HTTPError(400)
254
255 raise tornado.web.HTTPError(code)
256
257
258 class BlockedHandler(BaseHandler):
259 def get(self):
260 # 403 - Forbidden
261 self.set_status(403)
262
263 self.render("static/blocked.html", address=self.get_remote_ip())