6 import phonenumbers
.geocoder
12 import ipfire
.countries
15 from .handlers
import *
22 from . import downloads
23 from . import fireinfo
25 from . import location
28 from . import ui_modules
32 class Application(tornado
.web
.Application
):
33 def __init__(self
, config
, **kwargs
):
35 self
.backend
= ipfire
.Backend(config
)
38 # Do not compress responses
42 "xsrf_cookies" : True,
45 "login_url" : "/login",
47 # Setup directory structure
48 "static_path" : self
.backend
.config
.get("global", "static_dir"),
49 "template_path" : self
.backend
.config
.get("global", "templates_dir"),
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
,
64 "Password" : auth
.PasswordModule
,
67 "BlogHistoryNavigation": blog
.HistoryNavigationModule
,
68 "BlogList" : blog
.ListModule
,
69 "BlogPost" : blog
.PostModule
,
72 "BootMenuConfig" : boot
.MenuConfigModule
,
73 "BootMenuHeader" : boot
.MenuHeaderModule
,
74 "BootMenuSeparator" : boot
.MenuSeparatorModule
,
77 "DocsDiff" : docs
.DiffModule
,
78 "DocsHeader" : docs
.HeaderModule
,
79 "DocsList" : docs
.ListModule
,
82 "Code" : nopaste
.CodeModule
,
85 "FireinfoDeviceTable" : fireinfo
.DeviceTableModule
,
86 "FireinfoDeviceAndGroupsTable"
87 : fireinfo
.DeviceAndGroupsTableModule
,
90 "UsersList" : users
.ListModule
,
93 "VoIPConferences" : voip
.ConferencesModule
,
94 "VoIPOutboundRegistrations" :
95 voip
.OutboundRegistrationsModule
,
96 "VoIPQueues" : voip
.QueuesModule
,
97 "VoIPRegistrations" : voip
.RegistrationsModule
,
100 "ChristmasBanner" : ui_modules
.ChristmasBannerModule
,
101 "Markdown" : ui_modules
.MarkdownModule
,
102 "Map" : ui_modules
.MapModule
,
103 "ProgressBar" : ui_modules
.ProgressBarModule
,
106 # Call this when a page wasn't found
107 "default_handler_class" : base
.NotFoundHandler
,
109 settings
.update(kwargs
)
111 tornado
.web
.Application
.__init
__(self
, **settings
)
113 authentication_handlers
= [
114 (r
"/login", auth
.LoginHandler
),
115 (r
"/logout", auth
.LogoutHandler
),
118 self
.add_handlers(r
"(www\.)?([a-z]+\.dev\.)?ipfire\.org", [
119 # Entry site that lead the user to index
120 (r
"/", IndexHandler
),
123 (r
"/login", auth
.LoginHandler
),
124 (r
"/logout", auth
.LogoutHandler
),
125 (r
"/register", auth
.RegisterHandler
),
128 (r
"/blog", blog
.IndexHandler
),
129 (r
"/blog/compose", blog
.ComposeHandler
),
130 (r
"/blog/drafts", blog
.DraftsHandler
),
131 (r
"/blog/feed.xml", blog
.FeedHandler
),
132 (r
"/blog/tags/([0-9a-z\-\.]+)", blog
.TagHandler
),
133 (r
"/blog/years/([0-9]{4})", blog
.YearHandler
),
134 (r
"/blog/([0-9a-z\-\._]+)", blog
.PostHandler
),
135 (r
"/blog/([0-9a-z\-\._]+)/delete", blog
.DeleteHandler
),
136 (r
"/blog/([0-9a-z\-\._]+)/edit", blog
.EditHandler
),
137 (r
"/blog/([0-9a-z\-\._]+)/publish", blog
.PublishHandler
),
140 (r
"/docs/recent\-changes", docs
.RecentChangesHandler
),
141 (r
"/docs/search", docs
.SearchHandler
),
142 (r
"/docs/tree", docs
.TreeHandler
),
143 (r
"/docs/watchlist", docs
.WatchlistHandler
),
144 (r
"/docs/_restore", docs
.RestoreHandler
),
145 (r
"/docs/_upload", docs
.UploadHandler
),
146 (r
"/docs/([A-Za-z0-9\-_\/]+)?/_edit", docs
.EditHandler
),
147 (r
"/docs/([A-Za-z0-9\-_\/]+)?/_render", docs
.RenderHandler
),
148 (r
"/docs/([A-Za-z0-9\-_\/]+)?/_(watch|unwatch)", docs
.WatchHandler
),
149 (r
"/docs/((?:[A-Za-z0-9\-_\/]+)?(?:.*)\.(?:\w+))/_delete", docs
.DeleteFileHandler
),
150 (r
"/docs((?:[A-Za-z0-9\-_\/]+)?(?:.*)\.(?:\w+))$", docs
.FileHandler
),
151 (r
"/docs([A-Za-z0-9\-_\/]+)?/_files", docs
.FilesHandler
),
152 (r
"/docs([A-Za-z0-9\-_\/]+)?", docs
.PageHandler
),
155 (r
"/downloads", downloads
.IndexHandler
),
156 (r
"/downloads/mirrors", downloads
.MirrorsHandler
),
157 (r
"/downloads/thank-you", downloads
.ThankYouHandler
),
158 (r
"/downloads/([0-9a-z\-\.]+)", downloads
.ReleaseHandler
),
161 (r
"/donate", donate
.DonateHandler
),
162 (r
"/donate/thank-you", donate
.ThankYouHandler
),
163 (r
"/donate/error", donate
.ErrorHandler
),
166 (r
"/password\-reset", auth
.PasswordResetInitiationHandler
),
167 (r
"/password\-reset/([a-z_][a-z0-9_-]{0,31})/(\w+)", auth
.PasswordResetHandler
),
169 # Single-Sign-On for Discourse
170 (r
"/sso/discourse", auth
.SSODiscourse
),
173 (r
"/users/groups", users
.GroupIndexHandler
),
174 (r
"/users/groups/([a-z_][a-z0-9_-]{0,31})", users
.GroupShowHandler
),
177 (r
"/users", users
.IndexHandler
),
178 (r
"/users/([a-z_][a-z0-9_-]{0,31})", users
.ShowHandler
),
179 (r
"/users/([a-z_][a-z0-9_-]{0,31})\.jpg", users
.AvatarHandler
),
180 (r
"/users/([a-z_][a-z0-9_-]{0,31})/delete", users
.DeleteHandler
),
181 (r
"/users/([a-z_][a-z0-9_-]{0,31})/edit", users
.EditHandler
),
182 (r
"/users/([a-z_][a-z0-9_-]{0,31})/passwd", users
.PasswdHandler
),
185 (r
"/voip", voip
.IndexHandler
),
188 (r
"/about", StaticHandler
, { "template" : "about.html" }),
189 (r
"/legal", StaticHandler
, { "template" : "legal.html" }),
190 (r
"/help", StaticHandler
, { "template" : "help.html" }),
193 (r
"/api/check/email", auth
.APICheckEmail
),
194 (r
"/api/check/uid", auth
.APICheckUID
),
196 # Handle old pages that have moved elsewhere
197 (r
"/blog/authors/(\w+)", tornado
.web
.RedirectHandler
, { "url" : "/users/{0}" }),
198 (r
"/donation", tornado
.web
.RedirectHandler
, { "url" : "/donate" }),
199 (r
"/download", tornado
.web
.RedirectHandler
, { "url" : "/downloads" }),
200 (r
"/download/([0-9a-z\-\.]+)", tornado
.web
.RedirectHandler
, { "url" : "/downloads/{0}" }),
201 (r
"/features", tornado
.web
.RedirectHandler
, { "url" : "/about" }),
202 (r
"/imprint", tornado
.web
.RedirectHandler
, { "url" : "/legal" }),
203 (r
"/news.rss", tornado
.web
.RedirectHandler
, { "url" : "/blog/feed.xml" }),
204 (r
"/news/(.*)", tornado
.web
.RedirectHandler
, { "url" : "/blog/{0}" }),
205 (r
"/support", tornado
.web
.RedirectHandler
, { "url" : "/help"}),
206 (r
"/(de|en)/(.*)", tornado
.web
.RedirectHandler
, { "url" : "/{0}"}),
208 # Export arbitrary error pages
209 (r
"/error/([45][0-9]{2})", base
.ErrorHandler
),
211 # Serve any static files
212 (r
"/static/(.*)", tornado
.web
.StaticFileHandler
, { "path" : self
.settings
.get("static_path") }),
215 # blog.ipfire.org - LEGACY REDIRECTION
216 self
.add_handlers(r
"blog\.([a-z]+\.dev\.)?ipfire\.org", [
217 (r
"/", tornado
.web
.RedirectHandler
, { "url" : "https://www.ipfire.org/blog" }),
218 (r
"/authors/(\w+)", tornado
.web
.RedirectHandler
, { "url" : "https://www.ipfire.org/blog/authors/{0}" }),
219 (r
"/post/([0-9a-z\-\._]+)", tornado
.web
.RedirectHandler
, { "url" : "https://www.ipfire.org/blog/{0}" }),
220 (r
"/tags/([0-9a-z\-\.]+)", tornado
.web
.RedirectHandler
, { "url" : "https://www.ipfire.org/blog/tags/{0}" }),
223 (r
"/feed.xml", tornado
.web
.RedirectHandler
, { "url" : "https://www.ipfire.org/blog/feed.xml" }),
226 # downloads.ipfire.org
227 self
.add_handlers(r
"downloads\.([a-z]+\.dev\.)?ipfire\.org", [
228 (r
"/", tornado
.web
.RedirectHandler
, { "url" : "https://www.ipfire.org/download" }),
229 (r
"/release/(.*)", tornado
.web
.RedirectHandler
, { "url" : "https://www.ipfire.org/download/{0}" }),
230 (r
"/(.*)", downloads
.FileHandler
),
234 self
.add_handlers(r
"mirrors\.([a-z]+\.dev\.)?ipfire\.org", [
235 (r
"/", tornado
.web
.RedirectHandler
, { "url" : "https://www.ipfire.org/download/mirrors" }),
236 (r
"/mirrors/(.*)", tornado
.web
.RedirectHandler
, { "url" : "https://www.ipfire.org/download/mirrors/{0}" }),
240 self
.add_handlers(r
"planet\.([a-z]+\.dev\.)?ipfire\.org", [
241 (r
"/", tornado
.web
.RedirectHandler
, { "url" : "https://blog.ipfire.org/" }),
242 (r
"/post/([A-Za-z0-9_-]+)", tornado
.web
.RedirectHandler
, { "url" : "https://www.ipfire.org/blog/{0}" }),
243 (r
"/user/([a-z0-9_-]+)", tornado
.web
.RedirectHandler
, { "url" : "https://www.ipfire.org/blog/authors/{0}" }),
246 (r
"/rss", tornado
.web
.RedirectHandler
, { "url" : "https://blog.ipfire.org/feed.xml" }),
247 (r
"/user/([a-z0-9_-]+)/rss", tornado
.web
.RedirectHandler
, { "url" : "https://blog.ipfire.org/feed.xml" }),
248 (r
"/news.rss", tornado
.web
.RedirectHandler
, { "url" : "https://blog.ipfire.org/feed.xml" }),
251 # fireinfo.ipfire.org
252 self
.add_handlers(r
"fireinfo\.([a-z]+\.dev\.)?ipfire\.org", [
253 (r
"/", fireinfo
.IndexHandler
),
256 (r
"/admin", fireinfo
.AdminIndexHandler
),
259 (r
"/vendors", fireinfo
.VendorsHandler
),
260 (r
"/vendors/(pci|usb)/([0-9a-f]{4})", fireinfo
.VendorHandler
),
263 (r
"/drivers/(.*)", fireinfo
.DriverDetail
),
266 (r
"/profile/random", fireinfo
.RandomProfileHandler
),
267 (r
"/profile/([a-z0-9]{40})", fireinfo
.ProfileHandler
),
270 (r
"/processors", fireinfo
.ProcessorsHandler
),
271 (r
"/releases", fireinfo
.ReleasesHandler
),
274 (r
"/send/([a-z0-9]+)", fireinfo
.ProfileSendHandler
),
276 # Serve any static files
277 (r
"/static/(.*)", tornado
.web
.StaticFileHandler
, { "path" : self
.settings
.get("static_path") }),
278 ] + authentication_handlers
)
281 self
.add_handlers(r
"i-use\.([a-z]+\.dev\.)?ipfire\.org", [
282 (r
"/", tornado
.web
.RedirectHandler
, { "url" : "https://www.ipfire.org/" }),
283 (r
"/profile/([a-f0-9]{40})/([0-9]+).png", iuse
.ImageHandler
),
287 BOOT_STATIC_PATH
= os
.path
.join(self
.settings
["static_path"], "netboot")
288 self
.add_handlers(r
"boot\.([a-z]+\.dev\.)?ipfire\.org", [
289 (r
"/", tornado
.web
.RedirectHandler
, { "url" : "https://wiki.ipfire.org/installation/pxe" }),
292 (r
"/premenu.cfg", boot
.PremenuCfgHandler
),
293 (r
"/menu.gpxe", boot
.MenuGPXEHandler
),
294 (r
"/menu.cfg", boot
.MenuCfgHandler
),
297 (r
"/(boot\.png|pxelinux\.0|menu\.c32|vesamenu\.c32)",
298 tornado
.web
.StaticFileHandler
, { "path" : BOOT_STATIC_PATH
}),
302 self
.add_handlers(r
"nopaste\.([a-z]+\.dev\.)?ipfire\.org", [
303 (r
"/", nopaste
.CreateHandler
),
304 (r
"/raw/(.*)", nopaste
.RawHandler
),
305 (r
"/view/(.*)", nopaste
.ViewHandler
),
307 # Serve any static files
308 (r
"/static/(.*)", tornado
.web
.StaticFileHandler
, { "path" : self
.settings
.get("static_path") }),
309 ] + authentication_handlers
)
311 # location.ipfire.org
312 self
.add_handlers(r
"location\.([a-z]+\.dev\.)?ipfire\.org", [
313 (r
"/", location
.IndexHandler
),
314 (r
"/download", StaticHandler
, { "template" : "../location/download.html" }),
315 (r
"/how\-to\-use", StaticHandler
, { "template" : "../location/how-to-use.html" }),
316 (r
"/lookup/(.+)/blacklists", location
.BlacklistsHandler
),
317 (r
"/lookup/(.+)", location
.LookupHandler
),
319 # Serve any static files
320 (r
"/static/(.*)", tornado
.web
.StaticFileHandler
, { "path" : self
.settings
.get("static_path") }),
324 self
.add_handlers(r
"geoip\.([a-z]+\.dev\.)?ipfire\.org", [
325 (r
"/", tornado
.web
.RedirectHandler
, { "url" : "https://location.ipfire.org/" }),
329 self
.add_handlers(r
"talk\.([a-z]+\.dev\.)?ipfire\.org", [
330 (r
"/", tornado
.web
.RedirectHandler
, { "url" : "https://people.ipfire.org/" }),
334 self
.add_handlers(r
"people\.([a-z]+\.dev\.)?ipfire\.org", [
335 (r
"/", people
.IndexHandler
),
336 (r
"/activate/([a-z_][a-z0-9_-]{0,31})/(\w+)", auth
.ActivateHandler
),
337 (r
"/register", auth
.RegisterHandler
),
339 # Promotional Consent Stuff
340 (r
"/subscribe", people
.SubscribeHandler
),
341 (r
"/unsubscribe", people
.UnsubscribeHandler
),
343 # Serve any static files
344 (r
"/static/(.*)", tornado
.web
.StaticFileHandler
, { "path" : self
.settings
.get("static_path") }),
345 ] + authentication_handlers
)
348 self
.add_handlers(r
"wiki\.([a-z]+\.dev\.)?ipfire\.org", [
349 (r
"/(.*)", tornado
.web
.RedirectHandler
, { "url" : "https://www.ipfire.org/docs/{0}" }),
353 self
.add_handlers(r
"(.*)ipfire\.org", [
354 (r
".*", tornado
.web
.RedirectHandler
, { "url" : "https://www.ipfire.org" })
357 logging
.info("Successfully initialied application")
359 def format_country_name(self
, handler
, country_code
):
360 return self
.backend
.get_country_name(country_code
)
362 def format_language_name(self
, handler
, language
):
363 _
= handler
.locale
.translate
367 elif language
== "en":
369 elif language
== "es":
371 elif language
== "fr":
373 elif language
== "it":
375 elif language
== "nl":
377 elif language
== "pl":
379 elif language
== "pt":
380 return _("Portuguese")
381 elif language
== "ru":
383 elif language
== "tr":
388 def format_month_name(self
, handler
, month
):
389 _
= handler
.locale
.translate
408 return _("September")
418 def format_phone_number(self
, handler
, number
):
419 if not isinstance(number
, phonenumbers
.PhoneNumber
):
421 number
= phonenumbers
.parse(number
, None)
422 except phonenumbers
.phonenumberutil
.NumberParseException
:
425 return phonenumbers
.format_number(number
, phonenumbers
.PhoneNumberFormat
.INTERNATIONAL
)
427 def format_phone_number_to_e164(self
, handler
, number
):
428 return phonenumbers
.format_number(number
, phonenumbers
.PhoneNumberFormat
.E164
)
430 def format_phone_number_location(self
, handler
, number
):
432 phonenumbers
.geocoder
.description_for_number(number
, handler
.locale
.code
),
433 phonenumbers
.region_code_for_number(number
),
436 return ", ".join((e
for e
in s
if e
))