]> git.ipfire.org Git - ipfire.org.git/blame_incremental - src/web/__init__.py
people: Render an avatar with letter if no avatar exists
[ipfire.org.git] / src / web / __init__.py
... / ...
CommitLineData
1#/usr/bin/python
2
3import logging
4import itertools
5import os.path
6import phonenumbers
7import phonenumbers.geocoder
8import tornado.locale
9import tornado.options
10import tornado.web
11
12import ipfire
13import ipfire.countries
14
15from .handlers import *
16
17from . import auth
18from . import blog
19from . import boot
20from . import donate
21from . import download
22from . import fireinfo
23from . import iuse
24from . import location
25from . import mirrors
26from . import newsletter
27from . import nopaste
28from . import people
29from . import ui_modules
30from . import wiki
31
32class Application(tornado.web.Application):
33 def __init__(self, config, **kwargs):
34 # Initialize backend
35 self.backend = ipfire.Backend(config)
36
37 settings = {
38 # Do not compress responses
39 "gzip" : False,
40
41 # Enable XSRF cookies
42 "xsrf_cookies" : True,
43
44 # Login
45 "login_url" : "/login",
46
47 # Setup directory structure
48 "static_path" : self.backend.config.get("global", "static_dir"),
49 "template_path" : self.backend.config.get("global", "templates_dir"),
50
51 # UI Methods
52 "ui_methods" : {
53 "format_country_name" : self.format_country_name,
54 "format_language_name" : self.format_language_name,
55 "format_month_name" : self.format_month_name,
56 "format_phone_number" : self.format_phone_number,
57 "format_phone_number_to_e164" : self.format_phone_number_to_e164,
58 "format_phone_number_location" : self.format_phone_number_location,
59 "grouper" : grouper,
60 },
61
62 # UI Modules
63 "ui_modules" : {
64 # Blog
65 "BlogHistoryNavigation": blog.HistoryNavigationModule,
66 "BlogList" : blog.ListModule,
67 "BlogPost" : blog.PostModule,
68 "BlogPosts" : blog.PostsModule,
69
70 # Boot
71 "BootMenuConfig" : boot.MenuConfigModule,
72 "BootMenuHeader" : boot.MenuHeaderModule,
73 "BootMenuSeparator" : boot.MenuSeparatorModule,
74
75 # People
76 "AccountsList" : people.AccountsListModule,
77 "Agent" : people.AgentModule,
78 "CDR" : people.CDRModule,
79 "Channels" : people.ChannelsModule,
80 "MOS" : people.MOSModule,
81 "NewAccounts" : people.NewAccountsModule,
82 "Password" : people.PasswordModule,
83 "Registrations" : people.RegistrationsModule,
84 "SIPStatus" : people.SIPStatusModule,
85
86 # Nopaste
87 "Code" : nopaste.CodeModule,
88
89 # Fireinfo
90 "FireinfoDeviceTable" : fireinfo.DeviceTableModule,
91 "FireinfoDeviceAndGroupsTable"
92 : fireinfo.DeviceAndGroupsTableModule,
93
94 # Wiki
95 "WikiDiff" : wiki.WikiDiffModule,
96 "WikiNavbar" : wiki.WikiNavbarModule,
97 "WikiList" : wiki.WikiListModule,
98
99 # Misc
100 "ChristmasBanner" : ui_modules.ChristmasBannerModule,
101 "Markdown" : ui_modules.MarkdownModule,
102 "Map" : ui_modules.MapModule,
103 "ProgressBar" : ui_modules.ProgressBarModule,
104 },
105
106 # Call this when a page wasn't found
107 "default_handler_class" : base.NotFoundHandler,
108 }
109 settings.update(kwargs)
110
111 tornado.web.Application.__init__(self, **settings)
112
113 authentication_handlers = [
114 (r"/login", auth.LoginHandler),
115 (r"/logout", auth.LogoutHandler),
116 ]
117
118 self.add_handlers(r"(dev|www)\.ipfire\.org", [
119 # Entry site that lead the user to index
120 (r"/", IndexHandler),
121
122 # Download sites
123 (r"/downloads", tornado.web.RedirectHandler, { "url" : "/download" }),
124 (r"/download", download.IndexHandler),
125 (r"/download/([0-9a-z\-\.]+)", download.ReleaseHandler),
126
127 # Donate
128 (r"/donate", donate.DonateHandler),
129 (r"/donate/thank-you", donate.ThankYouHandler),
130 (r"/donate/error", donate.ErrorHandler),
131 (r"/donation", tornado.web.RedirectHandler, { "url" : "/donate" }),
132
133 # Newsletter
134 (r"/newsletter/subscribe", newsletter.SubscribeHandler),
135
136 # RSS feed
137 (r"/news.rss", tornado.web.RedirectHandler, { "url" : "https://blog.ipfire.org/feed.xml" }),
138
139 # Redirect news articles to blog
140 (r"/news/(.*)", handlers.NewsHandler),
141
142 # Static Pages
143 (r"/features", StaticHandler, { "template" : "features.html" }),
144 (r"/legal", StaticHandler, { "template" : "legal.html" }),
145 (r"/support", StaticHandler, { "template" : "support.html" }),
146
147 # Handle old pages that have moved elsewhere
148 (r"/imprint", tornado.web.RedirectHandler, { "url" : "/legal" }),
149 (r"/(de|en)/(.*)", LangCompatHandler),
150
151 # Export arbitrary error pages
152 (r"/error/([45][0-9]{2})", base.ErrorHandler),
153
154 # Block page
155 (r"/blocked", base.BlockedHandler),
156 ])
157
158 # blog.ipfire.org
159 self.add_handlers(r"blog(\.dev)?\.ipfire\.org", [
160 (r"/", blog.IndexHandler),
161 (r"/authors/(\w+)", blog.AuthorHandler),
162 (r"/compose", blog.ComposeHandler),
163 (r"/drafts", blog.DraftsHandler),
164 (r"/post/([0-9a-z\-\._]+)", blog.PostHandler),
165 (r"/post/([0-9a-z\-\._]+)/delete", blog.DeleteHandler),
166 (r"/post/([0-9a-z\-\._]+)/edit", blog.EditHandler),
167 (r"/post/([0-9a-z\-\._]+)/publish", blog.PublishHandler),
168 (r"/search", blog.SearchHandler),
169 (r"/tags/([0-9a-z\-\.]+)", blog.TagHandler),
170 (r"/years/([0-9]+)", blog.YearHandler),
171
172 # RSS Feed
173 (r"/feed.xml", blog.FeedHandler),
174 ] + authentication_handlers)
175
176 # downloads.ipfire.org
177 self.add_handlers(r"downloads?(\.dev)?\.ipfire\.org", [
178 (r"/", tornado.web.RedirectHandler, { "url" : "https://www.ipfire.org/" }),
179 (r"/release/(.*)", download.ReleaseRedirectHandler),
180 (r"/(.*)", download.FileHandler),
181 ])
182
183 # mirrors.ipfire.org
184 self.add_handlers(r"mirrors(\.dev)?\.ipfire\.org", [
185 (r"/", mirrors.IndexHandler),
186 (r"/mirrors/(.*)", mirrors.MirrorHandler),
187 ])
188
189 # planet.ipfire.org
190 self.add_handlers(r"planet(\.dev)?\.ipfire\.org", [
191 (r"/", tornado.web.RedirectHandler, { "url" : "https://blog.ipfire.org/" }),
192 (r"/post/([A-Za-z0-9_-]+)", handlers.PlanetPostHandler),
193 (r"/user/([a-z0-9_-]+)", handlers.PlanetUserHandler),
194
195 # RSS
196 (r"/rss", tornado.web.RedirectHandler, { "url" : "https://blog.ipfire.org/feed.xml" }),
197 (r"/user/([a-z0-9_-]+)/rss", tornado.web.RedirectHandler, { "url" : "https://blog.ipfire.org/feed.xml" }),
198 (r"/news.rss", tornado.web.RedirectHandler, { "url" : "https://blog.ipfire.org/feed.xml" }),
199 ])
200
201 # fireinfo.ipfire.org
202 self.add_handlers(r"fireinfo(\.dev)?\.ipfire\.org", [
203 (r"/", fireinfo.IndexHandler),
204
205 # Vendors
206 (r"/vendors", fireinfo.VendorsHandler),
207 (r"/vendors/(pci|usb)/([0-9a-f]{4})", fireinfo.VendorHandler),
208
209 # Driver
210 (r"/drivers/(.*)", fireinfo.DriverDetail),
211
212 # Show profiles
213 (r"/profile/random", fireinfo.RandomProfileHandler),
214 (r"/profile/([a-z0-9]{40})", fireinfo.ProfileHandler),
215
216 # Stats
217 (r"/processors", fireinfo.ProcessorsHandler),
218 (r"/releases", fireinfo.ReleasesHandler),
219
220 # Send profiles
221 (r"/send/([a-z0-9]+)", fireinfo.ProfileSendHandler),
222 ])
223
224 # i-use.ipfire.org
225 self.add_handlers(r"i-use(\.dev)?\.ipfire\.org", [
226 (r"/", tornado.web.RedirectHandler, { "url" : "https://www.ipfire.org/" }),
227 (r"/profile/([a-f0-9]{40})/([0-9]+).png", iuse.ImageHandler),
228 ])
229
230 # boot.ipfire.org
231 BOOT_STATIC_PATH = os.path.join(self.settings["static_path"], "netboot")
232 self.add_handlers(r"boot(\.dev)?\.ipfire\.org", [
233 (r"/", tornado.web.RedirectHandler, { "url" : "https://wiki.ipfire.org/installation/pxe" }),
234
235 # Configurations
236 (r"/premenu.cfg", boot.PremenuCfgHandler),
237 (r"/menu.gpxe", boot.MenuGPXEHandler),
238 (r"/menu.cfg", boot.MenuCfgHandler),
239
240 # Static files
241 (r"/(boot\.png|pxelinux\.0|menu\.c32|vesamenu\.c32)",
242 tornado.web.StaticFileHandler, { "path" : BOOT_STATIC_PATH }),
243 ])
244
245 # nopaste.ipfire.org
246 self.add_handlers(r"nopaste(\.dev)?\.ipfire\.org", [
247 (r"/", nopaste.CreateHandler),
248 (r"/raw/(.*)", nopaste.RawHandler),
249 (r"/view/(.*)", nopaste.ViewHandler),
250 ] + authentication_handlers)
251
252 # location.ipfire.org
253 self.add_handlers(r"location(\.dev)?\.ipfire\.org", [
254 (r"/", location.IndexHandler),
255 (r"/how\-to\-use", StaticHandler, { "template" : "../location/how-to-use.html" }),
256 (r"/lookup/(.+)/blacklists", location.BlacklistsHandler),
257 (r"/lookup/(.+)", location.LookupHandler),
258 ])
259
260 # geoip.ipfire.org
261 self.add_handlers(r"geoip(\.dev)?\.ipfire\.org", [
262 (r"/", tornado.web.RedirectHandler, { "url" : "https://location.ipfire.org/" }),
263 ])
264
265 # talk.ipfire.org
266 self.add_handlers(r"talk(\.dev)?\.ipfire\.org", [
267 (r"/", tornado.web.RedirectHandler, { "url" : "https://people.ipfire.org/" }),
268 ])
269
270 # people.ipfire.org
271 self.add_handlers(r"people(\.dev)?\.ipfire\.org", [
272 (r"/", people.IndexHandler),
273 (r"/activate/([a-z_][a-z0-9_-]{0,31})/(\w+)", auth.ActivateHandler),
274 (r"/conferences", people.ConferencesHandler),
275 (r"/groups", people.GroupsHandler),
276 (r"/groups/([a-z_][a-z0-9_-]{0,31})", people.GroupHandler),
277 (r"/register", auth.RegisterHandler),
278 (r"/search", people.SearchHandler),
279 (r"/users", people.UsersHandler),
280 (r"/users/([a-z_][a-z0-9_-]{0,31})", people.UserHandler),
281 (r"/users/([a-z_][a-z0-9_-]{0,31})\.jpg", people.AvatarHandler),
282 (r"/users/([a-z_][a-z0-9_-]{0,31})/calls/([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})", people.CallHandler),
283 (r"/users/([a-z_][a-z0-9_-]{0,31})/calls(?:/(\d{4}-\d{2}-\d{2}))?", people.CallsHandler),
284 (r"/users/([a-z_][a-z0-9_-]{0,31})/edit", people.UserEditHandler),
285 (r"/users/([a-z_][a-z0-9_-]{0,31})/passwd", people.UserPasswdHandler),
286 (r"/users/([a-z_][a-z0-9_-]{0,31})/sip", people.SIPHandler),
287
288 # Promotional Consent Stuff
289 (r"/subscribe", people.SubscribeHandler),
290 (r"/unsubscribe", people.UnsubscribeHandler),
291
292 # Single-Sign-On for Discourse
293 (r"/sso/discourse", people.SSODiscourse),
294
295 # Password Reset
296 (r"/password\-reset", auth.PasswordResetInitiationHandler),
297 (r"/password\-reset/([a-z_][a-z0-9_-]{0,31})/(\w+)", auth.PasswordResetHandler),
298
299 # API
300 (r"/api/check/uid", auth.APICheckUID),
301 ] + authentication_handlers)
302
303 # wiki.ipfire.org
304 self.add_handlers(r"wiki(\.dev)?\.ipfire\.org",
305 authentication_handlers + [
306
307 # Actions
308 (r"((?:[A-Za-z0-9\-_\/]+)?(?:.*)\.(?:\w+))/_delete", wiki.ActionDeleteHandler),
309 (r"([A-Za-z0-9\-_\/]+)?/_edit", wiki.ActionEditHandler),
310 (r"([A-Za-z0-9\-_\/]+)?/_render", wiki.ActionRenderHandler),
311 (r"([A-Za-z0-9\-_\/]+)?/_(watch|unwatch)", wiki.ActionWatchHandler),
312 (r"/actions/restore", wiki.ActionRestoreHandler),
313 (r"/actions/upload", wiki.ActionUploadHandler),
314
315 # Handlers
316 (r"/recent\-changes", wiki.RecentChangesHandler),
317 (r"/search", wiki.SearchHandler),
318 (r"/watchlist", wiki.WatchlistHandler),
319
320 # Media
321 (r"([A-Za-z0-9\-_\/]+)?/_files", wiki.FilesHandler),
322 (r"((?!/static)(?:[A-Za-z0-9\-_\/]+)?(?:.*)\.(?:\w+))$", wiki.FileHandler),
323
324 # Render pages
325 (r"([A-Za-z0-9\-_\/]+)?", wiki.PageHandler),
326 ])
327
328 # ipfire.org
329 self.add_handlers(r"ipfire\.org", [
330 (r".*", tornado.web.RedirectHandler, { "url" : "https://www.ipfire.org" })
331 ])
332
333 logging.info("Successfully initialied application")
334
335 def format_country_name(self, handler, country_code):
336 return ipfire.countries.get_name(country_code)
337
338 def format_language_name(self, handler, language):
339 _ = handler.locale.translate
340
341 if language == "de":
342 return _("German")
343 elif language == "en":
344 return _("English")
345 elif language == "es":
346 return _("Spanish")
347 elif language == "fr":
348 return _("French")
349 elif language == "it":
350 return _("Italian")
351 elif language == "nl":
352 return _("Dutch")
353 elif language == "pl":
354 return _("Polish")
355 elif language == "pt":
356 return _("Portuguese")
357 elif language == "ru":
358 return _("Russian")
359 elif language == "tr":
360 return _("Turkish")
361
362 return language
363
364 def format_month_name(self, handler, month):
365 _ = handler.locale.translate
366
367 if month == 1:
368 return _("January")
369 elif month == 2:
370 return _("February")
371 elif month == 3:
372 return _("March")
373 elif month == 4:
374 return _("April")
375 elif month == 5:
376 return _("May")
377 elif month == 6:
378 return _("June")
379 elif month == 7:
380 return _("July")
381 elif month == 8:
382 return _("August")
383 elif month == 9:
384 return _("September")
385 elif month == 10:
386 return _("October")
387 elif month == 11:
388 return _("November")
389 elif month == 12:
390 return _("December")
391
392 return month
393
394 def format_phone_number(self, handler, number):
395 if not isinstance(number, phonenumbers.PhoneNumber):
396 try:
397 number = phonenumbers.parse(number, None)
398 except phonenumbers.phonenumberutil.NumberParseException:
399 return number
400
401 return phonenumbers.format_number(number, phonenumbers.PhoneNumberFormat.INTERNATIONAL)
402
403 def format_phone_number_to_e164(self, handler, number):
404 return phonenumbers.format_number(number, phonenumbers.PhoneNumberFormat.E164)
405
406 def format_phone_number_location(self, handler, number):
407 s = [
408 phonenumbers.geocoder.description_for_number(number, handler.locale.code),
409 phonenumbers.region_code_for_number(number),
410 ]
411
412 return ", ".join((e for e in s if e))
413
414
415def grouper(handler, iterator, n):
416 """
417 Returns groups of n from the iterator
418 """
419 i = iter(iterator)
420
421 while True:
422 ret = list(itertools.islice(i, 0, n))
423 if not ret:
424 break
425
426 yield ret