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 "BlogHistoryNavigation": blog
.HistoryNavigationModule
,
66 "BlogList" : blog
.ListModule
,
67 "BlogPost" : blog
.PostModule
,
70 "BootMenuConfig" : boot
.MenuConfigModule
,
71 "BootMenuHeader" : boot
.MenuHeaderModule
,
72 "BootMenuSeparator" : boot
.MenuSeparatorModule
,
75 "DocsHeader" : docs
.HeaderModule
,
78 "Agent" : people
.AgentModule
,
79 "CDR" : people
.CDRModule
,
80 "Channels" : people
.ChannelsModule
,
81 "MOS" : people
.MOSModule
,
82 "Password" : people
.PasswordModule
,
83 "Registrations" : people
.RegistrationsModule
,
86 "Code" : nopaste
.CodeModule
,
89 "FireinfoDeviceTable" : fireinfo
.DeviceTableModule
,
90 "FireinfoDeviceAndGroupsTable"
91 : fireinfo
.DeviceAndGroupsTableModule
,
94 "UsersList" : users
.ListModule
,
97 "VoIPOutboundRegistrations" :
98 voip
.OutboundRegistrationsModule
,
99 "VoIPQueues" : voip
.QueuesModule
,
100 "VoIPRegistrations" : voip
.RegistrationsModule
,
103 "WikiDiff" : wiki
.WikiDiffModule
,
104 "WikiList" : wiki
.WikiListModule
,
107 "ChristmasBanner" : ui_modules
.ChristmasBannerModule
,
108 "Markdown" : ui_modules
.MarkdownModule
,
109 "Map" : ui_modules
.MapModule
,
110 "ProgressBar" : ui_modules
.ProgressBarModule
,
113 # Call this when a page wasn't found
114 "default_handler_class" : base
.NotFoundHandler
,
116 settings
.update(kwargs
)
118 tornado
.web
.Application
.__init
__(self
, **settings
)
120 authentication_handlers
= [
121 (r
"/login", auth
.LoginHandler
),
122 (r
"/logout", auth
.LogoutHandler
),
125 self
.add_handlers(r
"(www\.)?([a-z]+\.dev\.)?ipfire\.org", [
126 # Entry site that lead the user to index
127 (r
"/", IndexHandler
),
130 (r
"/login", auth
.LoginHandler
),
131 (r
"/logout", auth
.LogoutHandler
),
132 (r
"/register", auth
.RegisterHandler
),
135 (r
"/blog", blog
.IndexHandler
),
136 (r
"/blog/authors/(\w+)", blog
.AuthorHandler
),
137 (r
"/blog/compose", blog
.ComposeHandler
),
138 (r
"/blog/drafts", blog
.DraftsHandler
),
139 (r
"/blog/feed.xml", blog
.FeedHandler
),
140 (r
"/blog/search", blog
.SearchHandler
),
141 (r
"/blog/tags/([0-9a-z\-\.]+)", blog
.TagHandler
),
142 (r
"/blog/years/([0-9]{4})", blog
.YearHandler
),
143 (r
"/blog/([0-9a-z\-\._]+)", blog
.PostHandler
),
144 (r
"/blog/([0-9a-z\-\._]+)/delete", blog
.DeleteHandler
),
145 (r
"/blog/([0-9a-z\-\._]+)/edit", blog
.EditHandler
),
146 (r
"/blog/([0-9a-z\-\._]+)/publish", blog
.PublishHandler
),
149 (r
"/docs((?:[A-Za-z0-9\-_\/]+)?(?:.*)\.(?:\w+))$", docs
.FileHandler
),
150 (r
"/docs([A-Za-z0-9\-_\/]+)?", docs
.PageHandler
),
153 (r
"/downloads", downloads
.IndexHandler
),
154 (r
"/downloads/mirrors", downloads
.MirrorsHandler
),
155 (r
"/downloads/thank-you", downloads
.ThankYouHandler
),
156 (r
"/downloads/([0-9a-z\-\.]+)", downloads
.ReleaseHandler
),
159 (r
"/donate", donate
.DonateHandler
),
160 (r
"/donate/thank-you", donate
.ThankYouHandler
),
161 (r
"/donate/error", donate
.ErrorHandler
),
164 (r
"/password\-reset", auth
.PasswordResetInitiationHandler
),
165 (r
"/password\-reset/([a-z_][a-z0-9_-]{0,31})/(\w+)", auth
.PasswordResetHandler
),
167 # Single-Sign-On for Discourse
168 (r
"/sso/discourse", auth
.SSODiscourse
),
171 (r
"/users/groups", users
.GroupIndexHandler
),
172 (r
"/users/groups/([a-z_][a-z0-9_-]{0,31})", users
.GroupShowHandler
),
175 (r
"/users", users
.IndexHandler
),
176 (r
"/users/([a-z_][a-z0-9_-]{0,31})", users
.ShowHandler
),
177 (r
"/users/([a-z_][a-z0-9_-]{0,31})\.jpg", users
.AvatarHandler
),
178 (r
"/users/([a-z_][a-z0-9_-]{0,31})/delete", users
.DeleteHandler
),
179 (r
"/users/([a-z_][a-z0-9_-]{0,31})/edit", users
.EditHandler
),
180 (r
"/users/([a-z_][a-z0-9_-]{0,31})/passwd", users
.PasswdHandler
),
183 (r
"/voip", voip
.IndexHandler
),
186 (r
"/about", StaticHandler
, { "template" : "about.html" }),
187 (r
"/legal", StaticHandler
, { "template" : "legal.html" }),
188 (r
"/help", StaticHandler
, { "template" : "help.html" }),
190 # Handle old pages that have moved elsewhere
191 (r
"/donation", tornado
.web
.RedirectHandler
, { "url" : "/donate" }),
192 (r
"/download", tornado
.web
.RedirectHandler
, { "url" : "/downloads" }),
193 (r
"/download/([0-9a-z\-\.]+)", tornado
.web
.RedirectHandler
, { "url" : "/downloads/{0}" }),
194 (r
"/features", tornado
.web
.RedirectHandler
, { "url" : "/about" }),
195 (r
"/imprint", tornado
.web
.RedirectHandler
, { "url" : "/legal" }),
196 (r
"/news.rss", tornado
.web
.RedirectHandler
, { "url" : "/blog/feed.xml" }),
197 (r
"/news/(.*)", tornado
.web
.RedirectHandler
, { "url" : "/blog/{0}" }),
198 (r
"/support", tornado
.web
.RedirectHandler
, { "url" : "/help"}),
199 (r
"/(de|en)/(.*)", tornado
.web
.RedirectHandler
, { "url" : "/{0}"}),
201 # Export arbitrary error pages
202 (r
"/error/([45][0-9]{2})", base
.ErrorHandler
),
204 # Serve any static files
205 (r
"/static/(.*)", tornado
.web
.StaticFileHandler
, { "path" : self
.settings
.get("static_path") }),
208 # blog.ipfire.org - LEGACY REDIRECTION
209 self
.add_handlers(r
"blog\.([a-z]+\.dev\.)?ipfire\.org", [
210 (r
"/", tornado
.web
.RedirectHandler
, { "url" : "https://www.ipfire.org/blog" }),
211 (r
"/authors/(\w+)", tornado
.web
.RedirectHandler
, { "url" : "https://www.ipfire.org/blog/authors/{0}" }),
212 (r
"/post/([0-9a-z\-\._]+)", tornado
.web
.RedirectHandler
, { "url" : "https://www.ipfire.org/blog/{0}" }),
213 (r
"/tags/([0-9a-z\-\.]+)", tornado
.web
.RedirectHandler
, { "url" : "https://www.ipfire.org/blog/tags/{0}" }),
216 (r
"/feed.xml", tornado
.web
.RedirectHandler
, { "url" : "https://www.ipfire.org/blog/feed.xml" }),
219 # downloads.ipfire.org
220 self
.add_handlers(r
"downloads\.([a-z]+\.dev\.)?ipfire\.org", [
221 (r
"/", tornado
.web
.RedirectHandler
, { "url" : "https://www.ipfire.org/download" }),
222 (r
"/release/(.*)", tornado
.web
.RedirectHandler
, { "url" : "https://www.ipfire.org/download/{0}" }),
223 (r
"/(.*)", downloads
.FileHandler
),
227 self
.add_handlers(r
"mirrors\.([a-z]+\.dev\.)?ipfire\.org", [
228 (r
"/", tornado
.web
.RedirectHandler
, { "url" : "https://www.ipfire.org/download/mirrors" }),
229 (r
"/mirrors/(.*)", tornado
.web
.RedirectHandler
, { "url" : "https://www.ipfire.org/download/mirrors/{0}" }),
233 self
.add_handlers(r
"planet\.([a-z]+\.dev\.)?ipfire\.org", [
234 (r
"/", tornado
.web
.RedirectHandler
, { "url" : "https://blog.ipfire.org/" }),
235 (r
"/post/([A-Za-z0-9_-]+)", tornado
.web
.RedirectHandler
, { "url" : "https://www.ipfire.org/blog/{0}" }),
236 (r
"/user/([a-z0-9_-]+)", tornado
.web
.RedirectHandler
, { "url" : "https://www.ipfire.org/blog/authors/{0}" }),
239 (r
"/rss", tornado
.web
.RedirectHandler
, { "url" : "https://blog.ipfire.org/feed.xml" }),
240 (r
"/user/([a-z0-9_-]+)/rss", tornado
.web
.RedirectHandler
, { "url" : "https://blog.ipfire.org/feed.xml" }),
241 (r
"/news.rss", tornado
.web
.RedirectHandler
, { "url" : "https://blog.ipfire.org/feed.xml" }),
244 # fireinfo.ipfire.org
245 self
.add_handlers(r
"fireinfo\.([a-z]+\.dev\.)?ipfire\.org", [
246 (r
"/", fireinfo
.IndexHandler
),
249 (r
"/admin", fireinfo
.AdminIndexHandler
),
252 (r
"/vendors", fireinfo
.VendorsHandler
),
253 (r
"/vendors/(pci|usb)/([0-9a-f]{4})", fireinfo
.VendorHandler
),
256 (r
"/drivers/(.*)", fireinfo
.DriverDetail
),
259 (r
"/profile/random", fireinfo
.RandomProfileHandler
),
260 (r
"/profile/([a-z0-9]{40})", fireinfo
.ProfileHandler
),
263 (r
"/processors", fireinfo
.ProcessorsHandler
),
264 (r
"/releases", fireinfo
.ReleasesHandler
),
267 (r
"/send/([a-z0-9]+)", fireinfo
.ProfileSendHandler
),
269 # Serve any static files
270 (r
"/static/(.*)", tornado
.web
.StaticFileHandler
, { "path" : self
.settings
.get("static_path") }),
271 ] + authentication_handlers
)
274 self
.add_handlers(r
"i-use\.([a-z]+\.dev\.)?ipfire\.org", [
275 (r
"/", tornado
.web
.RedirectHandler
, { "url" : "https://www.ipfire.org/" }),
276 (r
"/profile/([a-f0-9]{40})/([0-9]+).png", iuse
.ImageHandler
),
280 BOOT_STATIC_PATH
= os
.path
.join(self
.settings
["static_path"], "netboot")
281 self
.add_handlers(r
"boot\.([a-z]+\.dev\.)?ipfire\.org", [
282 (r
"/", tornado
.web
.RedirectHandler
, { "url" : "https://wiki.ipfire.org/installation/pxe" }),
285 (r
"/premenu.cfg", boot
.PremenuCfgHandler
),
286 (r
"/menu.gpxe", boot
.MenuGPXEHandler
),
287 (r
"/menu.cfg", boot
.MenuCfgHandler
),
290 (r
"/(boot\.png|pxelinux\.0|menu\.c32|vesamenu\.c32)",
291 tornado
.web
.StaticFileHandler
, { "path" : BOOT_STATIC_PATH
}),
295 self
.add_handlers(r
"nopaste\.([a-z]+\.dev\.)?ipfire\.org", [
296 (r
"/", nopaste
.CreateHandler
),
297 (r
"/raw/(.*)", nopaste
.RawHandler
),
298 (r
"/view/(.*)", nopaste
.ViewHandler
),
300 # Serve any static files
301 (r
"/static/(.*)", tornado
.web
.StaticFileHandler
, { "path" : self
.settings
.get("static_path") }),
302 ] + authentication_handlers
)
304 # location.ipfire.org
305 self
.add_handlers(r
"location\.([a-z]+\.dev\.)?ipfire\.org", [
306 (r
"/", location
.IndexHandler
),
307 (r
"/download", StaticHandler
, { "template" : "../location/download.html" }),
308 (r
"/how\-to\-use", StaticHandler
, { "template" : "../location/how-to-use.html" }),
309 (r
"/lookup/(.+)/blacklists", location
.BlacklistsHandler
),
310 (r
"/lookup/(.+)", location
.LookupHandler
),
312 # Serve any static files
313 (r
"/static/(.*)", tornado
.web
.StaticFileHandler
, { "path" : self
.settings
.get("static_path") }),
317 self
.add_handlers(r
"geoip\.([a-z]+\.dev\.)?ipfire\.org", [
318 (r
"/", tornado
.web
.RedirectHandler
, { "url" : "https://location.ipfire.org/" }),
322 self
.add_handlers(r
"talk\.([a-z]+\.dev\.)?ipfire\.org", [
323 (r
"/", tornado
.web
.RedirectHandler
, { "url" : "https://people.ipfire.org/" }),
327 self
.add_handlers(r
"people\.([a-z]+\.dev\.)?ipfire\.org", [
328 (r
"/", people
.IndexHandler
),
329 (r
"/activate/([a-z_][a-z0-9_-]{0,31})/(\w+)", auth
.ActivateHandler
),
330 (r
"/conferences", people
.ConferencesHandler
),
331 (r
"/register", auth
.RegisterHandler
),
332 (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
),
333 (r
"/users/([a-z_][a-z0-9_-]{0,31})/calls(?:/(\d{4}-\d{2}-\d{2}))?", people
.CallsHandler
),
334 (r
"/users/([a-z_][a-z0-9_-]{0,31})/sip", people
.SIPHandler
),
336 # Promotional Consent Stuff
337 (r
"/subscribe", people
.SubscribeHandler
),
338 (r
"/unsubscribe", people
.UnsubscribeHandler
),
340 # Serve any static files
341 (r
"/static/(.*)", tornado
.web
.StaticFileHandler
, { "path" : self
.settings
.get("static_path") }),
344 (r
"/api/check/email", auth
.APICheckEmail
),
345 (r
"/api/check/uid", auth
.APICheckUID
),
346 ] + authentication_handlers
)
349 self
.add_handlers(r
"wiki\.([a-z]+\.dev\.)?ipfire\.org",
350 authentication_handlers
+ [
353 (r
"((?:[A-Za-z0-9\-_\/]+)?(?:.*)\.(?:\w+))/_delete", wiki
.ActionDeleteHandler
),
354 (r
"([A-Za-z0-9\-_\/]+)?/_edit", wiki
.ActionEditHandler
),
355 (r
"([A-Za-z0-9\-_\/]+)?/_render", wiki
.ActionRenderHandler
),
356 (r
"([A-Za-z0-9\-_\/]+)?/_(watch|unwatch)", wiki
.ActionWatchHandler
),
357 (r
"/actions/restore", wiki
.ActionRestoreHandler
),
358 (r
"/actions/upload", wiki
.ActionUploadHandler
),
361 (r
"/recent\-changes", wiki
.RecentChangesHandler
),
362 (r
"/search", wiki
.SearchHandler
),
363 (r
"/tree", wiki
.TreeHandler
),
364 (r
"/watchlist", wiki
.WatchlistHandler
),
367 (r
"([A-Za-z0-9\-_\/]+)?/_files", wiki
.FilesHandler
),
369 # Serve any static files
370 (r
"/static/(.*)", tornado
.web
.StaticFileHandler
, { "path" : self
.settings
.get("static_path") }),
373 (r
"([A-Za-z0-9\-_\/]+)?", wiki
.PageHandler
),
377 self
.add_handlers(r
"(.*)ipfire\.org", [
378 (r
".*", tornado
.web
.RedirectHandler
, { "url" : "https://www.ipfire.org" })
381 logging
.info("Successfully initialied application")
383 def format_country_name(self
, handler
, country_code
):
384 return self
.backend
.get_country_name(country_code
)
386 def format_language_name(self
, handler
, language
):
387 _
= handler
.locale
.translate
391 elif language
== "en":
393 elif language
== "es":
395 elif language
== "fr":
397 elif language
== "it":
399 elif language
== "nl":
401 elif language
== "pl":
403 elif language
== "pt":
404 return _("Portuguese")
405 elif language
== "ru":
407 elif language
== "tr":
412 def format_month_name(self
, handler
, month
):
413 _
= handler
.locale
.translate
432 return _("September")
442 def format_phone_number(self
, handler
, number
):
443 if not isinstance(number
, phonenumbers
.PhoneNumber
):
445 number
= phonenumbers
.parse(number
, None)
446 except phonenumbers
.phonenumberutil
.NumberParseException
:
449 return phonenumbers
.format_number(number
, phonenumbers
.PhoneNumberFormat
.INTERNATIONAL
)
451 def format_phone_number_to_e164(self
, handler
, number
):
452 return phonenumbers
.format_number(number
, phonenumbers
.PhoneNumberFormat
.E164
)
454 def format_phone_number_location(self
, handler
, number
):
456 phonenumbers
.geocoder
.description_for_number(number
, handler
.locale
.code
),
457 phonenumbers
.region_code_for_number(number
),
460 return ", ".join((e
for e
in s
if e
))