6 import phonenumbers
.geocoder
12 import ipfire
.countries
15 from .handlers
import *
17 from . import analytics
23 from . import downloads
24 from . import fireinfo
27 from . import location
29 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 "AnalyticsSummary" : analytics
.SummaryModule
,
68 "Password" : auth
.PasswordModule
,
71 "BlogHistoryNavigation": blog
.HistoryNavigationModule
,
72 "BlogList" : blog
.ListModule
,
75 "BootMenuConfig" : boot
.MenuConfigModule
,
76 "BootMenuHeader" : boot
.MenuHeaderModule
,
77 "BootMenuSeparator" : boot
.MenuSeparatorModule
,
80 "DocsDiff" : docs
.DiffModule
,
81 "DocsHeader" : docs
.HeaderModule
,
82 "DocsList" : docs
.ListModule
,
85 "Code" : nopaste
.CodeModule
,
88 "FireinfoDeviceTable" : fireinfo
.DeviceTableModule
,
89 "FireinfoDeviceAndGroupsTable"
90 : fireinfo
.DeviceAndGroupsTableModule
,
93 "UsersList" : users
.ListModule
,
96 "VoIPConferences" : voip
.ConferencesModule
,
97 "VoIPOutboundRegistrations" :
98 voip
.OutboundRegistrationsModule
,
99 "VoIPQueues" : voip
.QueuesModule
,
100 "VoIPRegistrations" : voip
.RegistrationsModule
,
103 "IPFireLogo" : ui_modules
.IPFireLogoModule
,
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
"/analytics", analytics
.IndexHandler
),
127 (r
"/analytics/docs", analytics
.DocsHandler
),
130 (r
"/join", auth
.JoinHandler
),
131 (r
"/login", auth
.LoginHandler
),
132 (r
"/logout", auth
.LogoutHandler
),
133 (r
"/activate/([a-z_][a-z0-9_-]{0,31})/(\w+)", auth
.ActivateHandler
),
136 (r
"/blog", blog
.IndexHandler
),
137 (r
"/blog/drafts", blog
.DraftsHandler
),
138 (r
"/blog/feed.xml", blog
.FeedHandler
),
139 (r
"/blog/write", blog
.WriteHandler
),
140 (r
"/blog/years/([0-9]{4})", blog
.YearHandler
),
141 (r
"/blog/([0-9a-z\-\._]+)", blog
.PostHandler
),
142 (r
"/blog/([0-9a-z\-\._]+)/delete", blog
.DeleteHandler
),
143 (r
"/blog/([0-9a-z\-\._]+)/edit", blog
.EditHandler
),
144 (r
"/blog/([0-9a-z\-\._]+)/publish", blog
.PublishHandler
),
145 (r
"/blog/([0-9a-z\-\._]+)/debug/email", blog
.DebugEmailHandler
),
148 (r
"/docs/recent\-changes", docs
.RecentChangesHandler
),
149 (r
"/docs/search", docs
.SearchHandler
),
150 (r
"/docs/tree", docs
.TreeHandler
),
151 (r
"/docs/watchlist", docs
.WatchlistHandler
),
152 (r
"/docs/_restore", docs
.RestoreHandler
),
153 (r
"/docs/_upload", docs
.UploadHandler
),
154 (r
"/docs(/[A-Za-z0-9\-_\/]+)?/_edit", docs
.EditHandler
),
155 (r
"/docs(/[A-Za-z0-9\-_\/]+)?/_render", docs
.RenderHandler
),
156 (r
"/docs(/[A-Za-z0-9\-_\/]+)?/_(watch|unwatch)", docs
.WatchHandler
),
157 (r
"/docs(/[A-Za-z0-9\-_\/]+)?/_files", docs
.FilesHandler
),
158 (r
"/docs(/[A-Za-z0-9\-_\/]+(?:.*)\.(?:\w+))/_delete", docs
.DeleteFileHandler
),
159 (r
"/docs(/[A-Za-z0-9\-_\/]+(?:.*)\.(?:\w+))$", docs
.FileHandler
),
160 (r
"/docs(/[A-Za-z0-9\-_\/]+)?", docs
.PageHandler
),
163 (r
"/downloads", downloads
.IndexHandler
),
164 (r
"/downloads/cloud", StaticHandler
, { "template" : "downloads/cloud.html" }),
165 (r
"/downloads/mirrors", downloads
.MirrorsHandler
),
166 (r
"/downloads/thank-you", downloads
.ThankYouHandler
),
167 (r
"/downloads/([0-9a-z\-\.]+)", downloads
.ReleaseHandler
),
170 (r
"/donate", donate
.DonateHandler
),
171 (r
"/donate/thank-you", donate
.ThankYouHandler
),
172 (r
"/donate/error", donate
.ErrorHandler
),
175 (r
"/lists", lists
.IndexHandler
),
178 (r
"/password\-reset", auth
.PasswordResetInitiationHandler
),
179 (r
"/password\-reset/([a-z_][a-z0-9_-]{0,31})/(\w+)", auth
.PasswordResetHandler
),
180 (r
"/.well-known/change-password", auth
.WellKnownChangePasswordHandler
),
183 (r
"/projects/location", location
.IndexHandler
),
184 (r
"/projects/location/download", StaticHandler
, { "template" : "location/download.html" }),
185 (r
"/projects/location/how\-to\-use", StaticHandler
, { "template" : "location/how-to-use.html" }),
186 (r
"/projects/location/lookup/(.+)", location
.LookupHandler
),
188 # Single-Sign-On for Discourse
189 (r
"/sso/discourse", auth
.SSODiscourse
),
192 (r
"/users/groups", users
.GroupIndexHandler
),
193 (r
"/users/groups/([a-z_][a-z0-9_-]{0,31})", users
.GroupShowHandler
),
196 (r
"/users", users
.IndexHandler
),
197 (r
"/users/([a-z_][a-z0-9_-]{0,31})", users
.ShowHandler
),
198 (r
"/users/([a-z_][a-z0-9_-]{0,31})\.jpg", users
.AvatarHandler
),
199 (r
"/users/([a-z_][a-z0-9_-]{0,31})/delete", users
.DeleteHandler
),
200 (r
"/users/([a-z_][a-z0-9_-]{0,31})/edit", users
.EditHandler
),
201 (r
"/users/([a-z_][a-z0-9_-]{0,31})/passwd", users
.PasswdHandler
),
203 # Promotional Consent Stuff
204 (r
"/subscribe", users
.SubscribeHandler
),
205 (r
"/unsubscribe", users
.UnsubscribeHandler
),
208 (r
"/voip", voip
.IndexHandler
),
211 (r
"/about", StaticHandler
, { "template" : "static/about.html" }),
212 (r
"/legal", StaticHandler
, { "template" : "static/legal.html" }),
213 (r
"/help", StaticHandler
, { "template" : "static/help.html" }),
214 (r
"/sitemap", StaticHandler
, { "template" : "static/sitemap.html" }),
217 (r
"/api/check/email", auth
.APICheckEmail
),
218 (r
"/api/check/uid", auth
.APICheckUID
),
220 # Handle old pages that have moved elsewhere
221 (r
"/blog/authors/(\w+)", tornado
.web
.RedirectHandler
, { "url" : "/users/{0}" }),
222 (r
"/donation", tornado
.web
.RedirectHandler
, { "url" : "/donate" }),
223 (r
"/download", tornado
.web
.RedirectHandler
, { "url" : "/downloads" }),
224 (r
"/download/([0-9a-z\-\.]+)", tornado
.web
.RedirectHandler
, { "url" : "/downloads/{0}" }),
225 (r
"/features", tornado
.web
.RedirectHandler
, { "url" : "/about" }),
226 (r
"/imprint", tornado
.web
.RedirectHandler
, { "url" : "/legal" }),
227 (r
"/news.rss", tornado
.web
.RedirectHandler
, { "url" : "/blog/feed.xml" }),
228 (r
"/news/(.*)", tornado
.web
.RedirectHandler
, { "url" : "/blog/{0}" }),
229 (r
"/support", tornado
.web
.RedirectHandler
, { "url" : "/help"}),
230 (r
"/(de|en)/(.*)", tornado
.web
.RedirectHandler
, { "url" : "/{0}"}),
232 # Export arbitrary error pages
233 (r
"/error/([45][0-9]{2})", base
.ErrorHandler
),
235 # Serve any static files
236 (r
"/static/(.*)", tornado
.web
.StaticFileHandler
, { "path" : self
.settings
.get("static_path") }),
239 # blog.ipfire.org - LEGACY REDIRECTION
240 self
.add_handlers(r
"blog\.([a-z]+\.dev\.)?ipfire\.org", [
241 (r
"/", tornado
.web
.RedirectHandler
, { "url" : "https://www.ipfire.org/blog" }),
242 (r
"/authors/(\w+)", tornado
.web
.RedirectHandler
, { "url" : "https://www.ipfire.org/blog/authors/{0}" }),
243 (r
"/post/([0-9a-z\-\._]+)", tornado
.web
.RedirectHandler
, { "url" : "https://www.ipfire.org/blog/{0}" }),
244 (r
"/tags/([0-9a-z\-\.]+)", tornado
.web
.RedirectHandler
, { "url" : "https://www.ipfire.org/blog/tags/{0}" }),
247 (r
"/feed.xml", tornado
.web
.RedirectHandler
, { "url" : "https://www.ipfire.org/blog/feed.xml" }),
250 # downloads.ipfire.org
251 self
.add_handlers(r
"downloads\.([a-z]+\.dev\.)?ipfire\.org", [
252 (r
"/", tornado
.web
.RedirectHandler
, { "url" : "https://www.ipfire.org/download" }),
253 (r
"/release/(.*)", tornado
.web
.RedirectHandler
, { "url" : "https://www.ipfire.org/download/{0}" }),
254 (r
"/(.*)", downloads
.FileHandler
),
258 self
.add_handlers(r
"mirrors\.([a-z]+\.dev\.)?ipfire\.org", [
259 (r
"/", tornado
.web
.RedirectHandler
, { "url" : "https://www.ipfire.org/download/mirrors" }),
260 (r
"/mirrors/(.*)", tornado
.web
.RedirectHandler
, { "url" : "https://www.ipfire.org/download/mirrors/{0}" }),
264 self
.add_handlers(r
"planet\.([a-z]+\.dev\.)?ipfire\.org", [
265 (r
"/", tornado
.web
.RedirectHandler
, { "url" : "https://blog.ipfire.org/" }),
266 (r
"/post/([A-Za-z0-9_-]+)", tornado
.web
.RedirectHandler
, { "url" : "https://www.ipfire.org/blog/{0}" }),
267 (r
"/user/([a-z0-9_-]+)", tornado
.web
.RedirectHandler
, { "url" : "https://www.ipfire.org/blog/authors/{0}" }),
270 (r
"/rss", tornado
.web
.RedirectHandler
, { "url" : "https://blog.ipfire.org/feed.xml" }),
271 (r
"/user/([a-z0-9_-]+)/rss", tornado
.web
.RedirectHandler
, { "url" : "https://blog.ipfire.org/feed.xml" }),
272 (r
"/news.rss", tornado
.web
.RedirectHandler
, { "url" : "https://blog.ipfire.org/feed.xml" }),
275 # fireinfo.ipfire.org
276 self
.add_handlers(r
"fireinfo\.([a-z]+\.dev\.)?ipfire\.org", [
277 (r
"/", fireinfo
.IndexHandler
),
280 (r
"/admin", fireinfo
.AdminIndexHandler
),
283 (r
"/vendors", fireinfo
.VendorsHandler
),
284 (r
"/vendors/(pci|usb)/([0-9a-f]{4})", fireinfo
.VendorHandler
),
287 (r
"/drivers/(.*)", fireinfo
.DriverDetail
),
290 (r
"/profile/random", fireinfo
.RandomProfileHandler
),
291 (r
"/profile/([a-z0-9]{40})", fireinfo
.ProfileHandler
),
294 (r
"/processors", fireinfo
.ProcessorsHandler
),
295 (r
"/releases", fireinfo
.ReleasesHandler
),
298 (r
"/send/([a-z0-9]+)", fireinfo
.ProfileSendHandler
),
300 # Serve any static files
301 (r
"/static/(.*)", tornado
.web
.StaticFileHandler
, { "path" : self
.settings
.get("static_path") }),
302 ] + authentication_handlers
)
305 self
.add_handlers(r
"i-use\.([a-z]+\.dev\.)?ipfire\.org", [
306 (r
"/", tornado
.web
.RedirectHandler
, { "url" : "https://www.ipfire.org/" }),
307 (r
"/profile/([a-f0-9]{40})/([0-9]+).png", iuse
.ImageHandler
),
311 BOOT_STATIC_PATH
= os
.path
.join(self
.settings
["static_path"], "netboot")
312 self
.add_handlers(r
"boot\.([a-z]+\.dev\.)?ipfire\.org", [
313 (r
"/", tornado
.web
.RedirectHandler
, { "url" : "https://wiki.ipfire.org/installation/pxe" }),
316 (r
"/premenu.cfg", boot
.PremenuCfgHandler
),
317 (r
"/menu.gpxe", boot
.MenuGPXEHandler
),
318 (r
"/menu.cfg", boot
.MenuCfgHandler
),
321 (r
"/(boot\.png|pxelinux\.0|menu\.c32|vesamenu\.c32)",
322 tornado
.web
.StaticFileHandler
, { "path" : BOOT_STATIC_PATH
}),
326 self
.add_handlers(r
"nopaste\.([a-z]+\.dev\.)?ipfire\.org", [
327 (r
"/", nopaste
.CreateHandler
),
328 (r
"/raw/(.*)", nopaste
.RawHandler
),
329 (r
"/view/(.*)", nopaste
.ViewHandler
),
331 # Serve any static files
332 (r
"/static/(.*)", tornado
.web
.StaticFileHandler
, { "path" : self
.settings
.get("static_path") }),
333 ] + authentication_handlers
)
335 # location.ipfire.org
336 self
.add_handlers(r
"location\.([a-z]+\.dev\.)?ipfire\.org", [
337 (r
"/(.*)", tornado
.web
.RedirectHandler
, { "url" : "https://www.ipfire.org/projects/location/{0}" }),
341 self
.add_handlers(r
"geoip\.([a-z]+\.dev\.)?ipfire\.org", [
342 (r
"/", tornado
.web
.RedirectHandler
, { "url" : "https://location.ipfire.org/" }),
346 self
.add_handlers(r
"talk\.([a-z]+\.dev\.)?ipfire\.org", [
347 (r
"/", tornado
.web
.RedirectHandler
, { "url" : "https://people.ipfire.org/" }),
351 self
.add_handlers(r
"people\.([a-z]+\.dev\.)?ipfire\.org", [
352 (r
"/", tornado
.web
.RedirectHandler
, { "url" : "https://www.ipfire.org/users" }),
353 (r
"/register", tornado
.web
.RedirectHandler
, { "url" : "https://www.ipfire.org/join" }),
354 (r
"/users", tornado
.web
.RedirectHandler
, { "url" : "https://www.ipfire.org/users" }),
355 (r
"/users/([a-z_][a-z0-9_-]{0,31})", tornado
.web
.RedirectHandler
, { "url" : "https://www.ipfire.org/users/{0}" }),
356 (r
"/users/([a-z_][a-z0-9_-]{0,31})\.jpg", tornado
.web
.RedirectHandler
, { "url" : "https://www.ipfire.org/users/{0}.jpg" }),
360 self
.add_handlers(r
"wiki\.([a-z]+\.dev\.)?ipfire\.org", [
361 (r
"/(.*)", tornado
.web
.RedirectHandler
, { "url" : "https://www.ipfire.org/docs/{0}" }),
365 self
.add_handlers(r
"(.*)ipfire\.org", [
366 (r
".*", tornado
.web
.RedirectHandler
, { "url" : "https://www.ipfire.org" })
369 logging
.info("Successfully initialied application")
371 def format_country_name(self
, handler
, country_code
):
372 return self
.backend
.get_country_name(country_code
)
374 def format_language_name(self
, handler
, language
):
375 _
= handler
.locale
.translate
379 elif language
== "en":
381 elif language
== "es":
383 elif language
== "fr":
385 elif language
== "it":
387 elif language
== "nl":
389 elif language
== "pl":
391 elif language
== "pt":
392 return _("Portuguese")
393 elif language
== "ru":
395 elif language
== "tr":
400 def format_month_name(self
, handler
, month
):
401 _
= handler
.locale
.translate
420 return _("September")
430 def format_phone_number(self
, handler
, number
):
431 if not isinstance(number
, phonenumbers
.PhoneNumber
):
433 number
= phonenumbers
.parse(number
, None)
434 except phonenumbers
.phonenumberutil
.NumberParseException
:
437 return phonenumbers
.format_number(number
, phonenumbers
.PhoneNumberFormat
.INTERNATIONAL
)
439 def format_phone_number_to_e164(self
, handler
, number
):
440 return phonenumbers
.format_number(number
, phonenumbers
.PhoneNumberFormat
.E164
)
442 def format_phone_number_location(self
, handler
, number
):
444 phonenumbers
.geocoder
.description_for_number(number
, handler
.locale
.code
),
445 phonenumbers
.region_code_for_number(number
),
448 return ", ".join((e
for e
in s
if e
))