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
33 class Application(tornado
.web
.Application
):
34 def __init__(self
, config
, **kwargs
):
36 self
.backend
= ipfire
.Backend(config
)
39 # Do not compress responses
43 "xsrf_cookies" : True,
46 "login_url" : "/login",
48 # Setup directory structure
49 "static_path" : self
.backend
.config
.get("global", "static_dir"),
50 "template_path" : self
.backend
.config
.get("global", "templates_dir"),
54 "format_country_name" : self
.format_country_name
,
55 "format_language_name" : self
.format_language_name
,
56 "format_month_name" : self
.format_month_name
,
57 "format_phone_number" : self
.format_phone_number
,
58 "format_phone_number_to_e164" : self
.format_phone_number_to_e164
,
59 "format_phone_number_location" : self
.format_phone_number_location
,
65 "Password" : auth
.PasswordModule
,
68 "BlogHistoryNavigation": blog
.HistoryNavigationModule
,
69 "BlogList" : blog
.ListModule
,
70 "BlogPost" : blog
.PostModule
,
73 "BootMenuConfig" : boot
.MenuConfigModule
,
74 "BootMenuHeader" : boot
.MenuHeaderModule
,
75 "BootMenuSeparator" : boot
.MenuSeparatorModule
,
78 "DocsDiff" : docs
.DiffModule
,
79 "DocsHeader" : docs
.HeaderModule
,
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 "WikiList" : wiki
.WikiListModule
,
103 "ChristmasBanner" : ui_modules
.ChristmasBannerModule
,
104 "Markdown" : ui_modules
.MarkdownModule
,
105 "Map" : ui_modules
.MapModule
,
106 "ProgressBar" : ui_modules
.ProgressBarModule
,
109 # Call this when a page wasn't found
110 "default_handler_class" : base
.NotFoundHandler
,
112 settings
.update(kwargs
)
114 tornado
.web
.Application
.__init
__(self
, **settings
)
116 authentication_handlers
= [
117 (r
"/login", auth
.LoginHandler
),
118 (r
"/logout", auth
.LogoutHandler
),
121 self
.add_handlers(r
"(www\.)?([a-z]+\.dev\.)?ipfire\.org", [
122 # Entry site that lead the user to index
123 (r
"/", IndexHandler
),
126 (r
"/login", auth
.LoginHandler
),
127 (r
"/logout", auth
.LogoutHandler
),
128 (r
"/register", auth
.RegisterHandler
),
131 (r
"/blog", blog
.IndexHandler
),
132 (r
"/blog/authors/(\w+)", blog
.AuthorHandler
),
133 (r
"/blog/compose", blog
.ComposeHandler
),
134 (r
"/blog/drafts", blog
.DraftsHandler
),
135 (r
"/blog/feed.xml", blog
.FeedHandler
),
136 (r
"/blog/search", blog
.SearchHandler
),
137 (r
"/blog/tags/([0-9a-z\-\.]+)", blog
.TagHandler
),
138 (r
"/blog/years/([0-9]{4})", blog
.YearHandler
),
139 (r
"/blog/([0-9a-z\-\._]+)", blog
.PostHandler
),
140 (r
"/blog/([0-9a-z\-\._]+)/delete", blog
.DeleteHandler
),
141 (r
"/blog/([0-9a-z\-\._]+)/edit", blog
.EditHandler
),
142 (r
"/blog/([0-9a-z\-\._]+)/publish", blog
.PublishHandler
),
145 (r
"/docs/recent\-changes", docs
.RecentChangesHandler
),
146 (r
"/docs/search", docs
.SearchHandler
),
147 (r
"/docs/tree", docs
.TreeHandler
),
148 (r
"/docs((?:[A-Za-z0-9\-_\/]+)?(?:.*)\.(?:\w+))$", docs
.FileHandler
),
149 (r
"/docs([A-Za-z0-9\-_\/]+)?", docs
.PageHandler
),
152 (r
"/downloads", downloads
.IndexHandler
),
153 (r
"/downloads/mirrors", downloads
.MirrorsHandler
),
154 (r
"/downloads/thank-you", downloads
.ThankYouHandler
),
155 (r
"/downloads/([0-9a-z\-\.]+)", downloads
.ReleaseHandler
),
158 (r
"/donate", donate
.DonateHandler
),
159 (r
"/donate/thank-you", donate
.ThankYouHandler
),
160 (r
"/donate/error", donate
.ErrorHandler
),
163 (r
"/password\-reset", auth
.PasswordResetInitiationHandler
),
164 (r
"/password\-reset/([a-z_][a-z0-9_-]{0,31})/(\w+)", auth
.PasswordResetHandler
),
166 # Single-Sign-On for Discourse
167 (r
"/sso/discourse", auth
.SSODiscourse
),
170 (r
"/users/groups", users
.GroupIndexHandler
),
171 (r
"/users/groups/([a-z_][a-z0-9_-]{0,31})", users
.GroupShowHandler
),
174 (r
"/users", users
.IndexHandler
),
175 (r
"/users/([a-z_][a-z0-9_-]{0,31})", users
.ShowHandler
),
176 (r
"/users/([a-z_][a-z0-9_-]{0,31})\.jpg", users
.AvatarHandler
),
177 (r
"/users/([a-z_][a-z0-9_-]{0,31})/delete", users
.DeleteHandler
),
178 (r
"/users/([a-z_][a-z0-9_-]{0,31})/edit", users
.EditHandler
),
179 (r
"/users/([a-z_][a-z0-9_-]{0,31})/passwd", users
.PasswdHandler
),
182 (r
"/voip", voip
.IndexHandler
),
185 (r
"/about", StaticHandler
, { "template" : "about.html" }),
186 (r
"/legal", StaticHandler
, { "template" : "legal.html" }),
187 (r
"/help", StaticHandler
, { "template" : "help.html" }),
189 # Handle old pages that have moved elsewhere
190 (r
"/donation", tornado
.web
.RedirectHandler
, { "url" : "/donate" }),
191 (r
"/download", tornado
.web
.RedirectHandler
, { "url" : "/downloads" }),
192 (r
"/download/([0-9a-z\-\.]+)", tornado
.web
.RedirectHandler
, { "url" : "/downloads/{0}" }),
193 (r
"/features", tornado
.web
.RedirectHandler
, { "url" : "/about" }),
194 (r
"/imprint", tornado
.web
.RedirectHandler
, { "url" : "/legal" }),
195 (r
"/news.rss", tornado
.web
.RedirectHandler
, { "url" : "/blog/feed.xml" }),
196 (r
"/news/(.*)", tornado
.web
.RedirectHandler
, { "url" : "/blog/{0}" }),
197 (r
"/support", tornado
.web
.RedirectHandler
, { "url" : "/help"}),
198 (r
"/(de|en)/(.*)", tornado
.web
.RedirectHandler
, { "url" : "/{0}"}),
200 # Export arbitrary error pages
201 (r
"/error/([45][0-9]{2})", base
.ErrorHandler
),
203 # Serve any static files
204 (r
"/static/(.*)", tornado
.web
.StaticFileHandler
, { "path" : self
.settings
.get("static_path") }),
207 # blog.ipfire.org - LEGACY REDIRECTION
208 self
.add_handlers(r
"blog\.([a-z]+\.dev\.)?ipfire\.org", [
209 (r
"/", tornado
.web
.RedirectHandler
, { "url" : "https://www.ipfire.org/blog" }),
210 (r
"/authors/(\w+)", tornado
.web
.RedirectHandler
, { "url" : "https://www.ipfire.org/blog/authors/{0}" }),
211 (r
"/post/([0-9a-z\-\._]+)", tornado
.web
.RedirectHandler
, { "url" : "https://www.ipfire.org/blog/{0}" }),
212 (r
"/tags/([0-9a-z\-\.]+)", tornado
.web
.RedirectHandler
, { "url" : "https://www.ipfire.org/blog/tags/{0}" }),
215 (r
"/feed.xml", tornado
.web
.RedirectHandler
, { "url" : "https://www.ipfire.org/blog/feed.xml" }),
218 # downloads.ipfire.org
219 self
.add_handlers(r
"downloads\.([a-z]+\.dev\.)?ipfire\.org", [
220 (r
"/", tornado
.web
.RedirectHandler
, { "url" : "https://www.ipfire.org/download" }),
221 (r
"/release/(.*)", tornado
.web
.RedirectHandler
, { "url" : "https://www.ipfire.org/download/{0}" }),
222 (r
"/(.*)", downloads
.FileHandler
),
226 self
.add_handlers(r
"mirrors\.([a-z]+\.dev\.)?ipfire\.org", [
227 (r
"/", tornado
.web
.RedirectHandler
, { "url" : "https://www.ipfire.org/download/mirrors" }),
228 (r
"/mirrors/(.*)", tornado
.web
.RedirectHandler
, { "url" : "https://www.ipfire.org/download/mirrors/{0}" }),
232 self
.add_handlers(r
"planet\.([a-z]+\.dev\.)?ipfire\.org", [
233 (r
"/", tornado
.web
.RedirectHandler
, { "url" : "https://blog.ipfire.org/" }),
234 (r
"/post/([A-Za-z0-9_-]+)", tornado
.web
.RedirectHandler
, { "url" : "https://www.ipfire.org/blog/{0}" }),
235 (r
"/user/([a-z0-9_-]+)", tornado
.web
.RedirectHandler
, { "url" : "https://www.ipfire.org/blog/authors/{0}" }),
238 (r
"/rss", tornado
.web
.RedirectHandler
, { "url" : "https://blog.ipfire.org/feed.xml" }),
239 (r
"/user/([a-z0-9_-]+)/rss", tornado
.web
.RedirectHandler
, { "url" : "https://blog.ipfire.org/feed.xml" }),
240 (r
"/news.rss", tornado
.web
.RedirectHandler
, { "url" : "https://blog.ipfire.org/feed.xml" }),
243 # fireinfo.ipfire.org
244 self
.add_handlers(r
"fireinfo\.([a-z]+\.dev\.)?ipfire\.org", [
245 (r
"/", fireinfo
.IndexHandler
),
248 (r
"/admin", fireinfo
.AdminIndexHandler
),
251 (r
"/vendors", fireinfo
.VendorsHandler
),
252 (r
"/vendors/(pci|usb)/([0-9a-f]{4})", fireinfo
.VendorHandler
),
255 (r
"/drivers/(.*)", fireinfo
.DriverDetail
),
258 (r
"/profile/random", fireinfo
.RandomProfileHandler
),
259 (r
"/profile/([a-z0-9]{40})", fireinfo
.ProfileHandler
),
262 (r
"/processors", fireinfo
.ProcessorsHandler
),
263 (r
"/releases", fireinfo
.ReleasesHandler
),
266 (r
"/send/([a-z0-9]+)", fireinfo
.ProfileSendHandler
),
268 # Serve any static files
269 (r
"/static/(.*)", tornado
.web
.StaticFileHandler
, { "path" : self
.settings
.get("static_path") }),
270 ] + authentication_handlers
)
273 self
.add_handlers(r
"i-use\.([a-z]+\.dev\.)?ipfire\.org", [
274 (r
"/", tornado
.web
.RedirectHandler
, { "url" : "https://www.ipfire.org/" }),
275 (r
"/profile/([a-f0-9]{40})/([0-9]+).png", iuse
.ImageHandler
),
279 BOOT_STATIC_PATH
= os
.path
.join(self
.settings
["static_path"], "netboot")
280 self
.add_handlers(r
"boot\.([a-z]+\.dev\.)?ipfire\.org", [
281 (r
"/", tornado
.web
.RedirectHandler
, { "url" : "https://wiki.ipfire.org/installation/pxe" }),
284 (r
"/premenu.cfg", boot
.PremenuCfgHandler
),
285 (r
"/menu.gpxe", boot
.MenuGPXEHandler
),
286 (r
"/menu.cfg", boot
.MenuCfgHandler
),
289 (r
"/(boot\.png|pxelinux\.0|menu\.c32|vesamenu\.c32)",
290 tornado
.web
.StaticFileHandler
, { "path" : BOOT_STATIC_PATH
}),
294 self
.add_handlers(r
"nopaste\.([a-z]+\.dev\.)?ipfire\.org", [
295 (r
"/", nopaste
.CreateHandler
),
296 (r
"/raw/(.*)", nopaste
.RawHandler
),
297 (r
"/view/(.*)", nopaste
.ViewHandler
),
299 # Serve any static files
300 (r
"/static/(.*)", tornado
.web
.StaticFileHandler
, { "path" : self
.settings
.get("static_path") }),
301 ] + authentication_handlers
)
303 # location.ipfire.org
304 self
.add_handlers(r
"location\.([a-z]+\.dev\.)?ipfire\.org", [
305 (r
"/", location
.IndexHandler
),
306 (r
"/download", StaticHandler
, { "template" : "../location/download.html" }),
307 (r
"/how\-to\-use", StaticHandler
, { "template" : "../location/how-to-use.html" }),
308 (r
"/lookup/(.+)/blacklists", location
.BlacklistsHandler
),
309 (r
"/lookup/(.+)", location
.LookupHandler
),
311 # Serve any static files
312 (r
"/static/(.*)", tornado
.web
.StaticFileHandler
, { "path" : self
.settings
.get("static_path") }),
316 self
.add_handlers(r
"geoip\.([a-z]+\.dev\.)?ipfire\.org", [
317 (r
"/", tornado
.web
.RedirectHandler
, { "url" : "https://location.ipfire.org/" }),
321 self
.add_handlers(r
"talk\.([a-z]+\.dev\.)?ipfire\.org", [
322 (r
"/", tornado
.web
.RedirectHandler
, { "url" : "https://people.ipfire.org/" }),
326 self
.add_handlers(r
"people\.([a-z]+\.dev\.)?ipfire\.org", [
327 (r
"/", people
.IndexHandler
),
328 (r
"/activate/([a-z_][a-z0-9_-]{0,31})/(\w+)", auth
.ActivateHandler
),
329 (r
"/register", auth
.RegisterHandler
),
331 # Promotional Consent Stuff
332 (r
"/subscribe", people
.SubscribeHandler
),
333 (r
"/unsubscribe", people
.UnsubscribeHandler
),
335 # Serve any static files
336 (r
"/static/(.*)", tornado
.web
.StaticFileHandler
, { "path" : self
.settings
.get("static_path") }),
339 (r
"/api/check/email", auth
.APICheckEmail
),
340 (r
"/api/check/uid", auth
.APICheckUID
),
341 ] + authentication_handlers
)
344 self
.add_handlers(r
"wiki\.([a-z]+\.dev\.)?ipfire\.org",
345 authentication_handlers
+ [
348 (r
"((?:[A-Za-z0-9\-_\/]+)?(?:.*)\.(?:\w+))/_delete", wiki
.ActionDeleteHandler
),
349 (r
"([A-Za-z0-9\-_\/]+)?/_edit", wiki
.ActionEditHandler
),
350 (r
"([A-Za-z0-9\-_\/]+)?/_render", wiki
.ActionRenderHandler
),
351 (r
"([A-Za-z0-9\-_\/]+)?/_(watch|unwatch)", wiki
.ActionWatchHandler
),
352 (r
"/actions/restore", wiki
.ActionRestoreHandler
),
353 (r
"/actions/upload", wiki
.ActionUploadHandler
),
356 (r
"/watchlist", wiki
.WatchlistHandler
),
359 (r
"([A-Za-z0-9\-_\/]+)?/_files", wiki
.FilesHandler
),
361 # Serve any static files
362 (r
"/static/(.*)", tornado
.web
.StaticFileHandler
, { "path" : self
.settings
.get("static_path") }),
365 (r
"([A-Za-z0-9\-_\/]+)?", tornado
.web
.RedirectHandler
, { "url" : "https://www.ipfire.org/docs{0}" }),
369 self
.add_handlers(r
"(.*)ipfire\.org", [
370 (r
".*", tornado
.web
.RedirectHandler
, { "url" : "https://www.ipfire.org" })
373 logging
.info("Successfully initialied application")
375 def format_country_name(self
, handler
, country_code
):
376 return self
.backend
.get_country_name(country_code
)
378 def format_language_name(self
, handler
, language
):
379 _
= handler
.locale
.translate
383 elif language
== "en":
385 elif language
== "es":
387 elif language
== "fr":
389 elif language
== "it":
391 elif language
== "nl":
393 elif language
== "pl":
395 elif language
== "pt":
396 return _("Portuguese")
397 elif language
== "ru":
399 elif language
== "tr":
404 def format_month_name(self
, handler
, month
):
405 _
= handler
.locale
.translate
424 return _("September")
434 def format_phone_number(self
, handler
, number
):
435 if not isinstance(number
, phonenumbers
.PhoneNumber
):
437 number
= phonenumbers
.parse(number
, None)
438 except phonenumbers
.phonenumberutil
.NumberParseException
:
441 return phonenumbers
.format_number(number
, phonenumbers
.PhoneNumberFormat
.INTERNATIONAL
)
443 def format_phone_number_to_e164(self
, handler
, number
):
444 return phonenumbers
.format_number(number
, phonenumbers
.PhoneNumberFormat
.E164
)
446 def format_phone_number_location(self
, handler
, number
):
448 phonenumbers
.geocoder
.description_for_number(number
, handler
.locale
.code
),
449 phonenumbers
.region_code_for_number(number
),
452 return ", ".join((e
for e
in s
if e
))