src/web/__init__.py

   1 #/usr/bin/python
   2
   3 import logging
   4 import os.path
   5 import phonenumbers
   6 import phonenumbers.geocoder
   7 import tornado.locale
   8 import tornado.options
   9 import tornado.web
  10
  11 import ipfire
  12 import ipfire.countries
  13 from .. import util
  14
  15 from .handlers import *
  16
  17 from . import auth
  18 from . import blog
  19 from . import boot
  20 from . import docs
  21 from . import donate
  22 from . import downloads
  23 from . import fireinfo
  24 from . import iuse
  25 from . import location
  26 from . import nopaste
  27 from . import people
  28 from . import ui_modules
  29 from . import users
  30 from . import voip
  31 from . import wiki
  32
  33 class Application(tornado.web.Application):
  34         def __init__(self, config, **kwargs):
  35                 # Initialize backend
  36                 self.backend = ipfire.Backend(config)
  37
  38                 settings = {
  39                         # Do not compress responses
  40                         "gzip" : False,
  41
  42                         # Enable XSRF cookies
  43                         "xsrf_cookies" : True,
  44
  45                         # Login
  46                         "login_url" : "/login",
  47
  48                         # Setup directory structure
  49                         "static_path"   : self.backend.config.get("global", "static_dir"),
  50                         "template_path" : self.backend.config.get("global", "templates_dir"),
  51
  52                         # UI Methods
  53                         "ui_methods" : {
  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,
  60                         },
  61
  62                         # UI Modules
  63                         "ui_modules" : {
  64                                 # Auth
  65                                 "Password"             : auth.PasswordModule,
  66
  67                                 # Blog
  68                                 "BlogHistoryNavigation": blog.HistoryNavigationModule,
  69                                 "BlogList"             : blog.ListModule,
  70                                 "BlogPost"             : blog.PostModule,
  71
  72                                 # Boot
  73                                 "BootMenuConfig"       : boot.MenuConfigModule,
  74                                 "BootMenuHeader"       : boot.MenuHeaderModule,
  75                                 "BootMenuSeparator"    : boot.MenuSeparatorModule,
  76
  77                                 # Docs
  78                                 "DocsDiff"             : docs.DiffModule,
  79                                 "DocsHeader"           : docs.HeaderModule,
  80
  81                                 # Nopaste
  82                                 "Code"                 : nopaste.CodeModule,
  83
  84                                 # Fireinfo
  85                                 "FireinfoDeviceTable"  : fireinfo.DeviceTableModule,
  86                                 "FireinfoDeviceAndGroupsTable"
  87                                                        : fireinfo.DeviceAndGroupsTableModule,
  88
  89                                 # Users
  90                                 "UsersList"            : users.ListModule,
  91
  92                                 # VoIP
  93                                 "VoIPConferences"      : voip.ConferencesModule,
  94                                 "VoIPOutboundRegistrations" :
  95                                         voip.OutboundRegistrationsModule,
  96                                 "VoIPQueues"           : voip.QueuesModule,
  97                                 "VoIPRegistrations"    : voip.RegistrationsModule,
  98
  99                                 # Wiki
 100                                 "WikiList"             : wiki.WikiListModule,
 101
 102                                 # Misc
 103                                 "ChristmasBanner"      : ui_modules.ChristmasBannerModule,
 104                                 "Markdown"             : ui_modules.MarkdownModule,
 105                                 "Map"                  : ui_modules.MapModule,
 106                                 "ProgressBar"          : ui_modules.ProgressBarModule,
 107                         },
 108
 109                         # Call this when a page wasn't found
 110                         "default_handler_class" : base.NotFoundHandler,
 111                 }
 112                 settings.update(kwargs)
 113
 114                 tornado.web.Application.__init__(self, **settings)
 115
 116                 authentication_handlers = [
 117                         (r"/login", auth.LoginHandler),
 118                         (r"/logout", auth.LogoutHandler),
 119                 ]
 120
 121                 self.add_handlers(r"(www\.)?([a-z]+\.dev\.)?ipfire\.org", [
 122                         # Entry site that lead the user to index
 123                         (r"/", IndexHandler),
 124
 125                         # Authentication
 126                         (r"/login", auth.LoginHandler),
 127                         (r"/logout", auth.LogoutHandler),
 128                         (r"/register", auth.RegisterHandler),
 129
 130                         # Blog
 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),
 143
 144                         # Docs
 145                         (r"/docs/recent\-changes", docs.RecentChangesHandler),
 146                         (r"/docs/search", docs.SearchHandler),
 147                         (r"/docs/tree", docs.TreeHandler),
 148                         (r"/docs/watchlist", docs.WatchlistHandler),
 149                         (r"/docs((?:[A-Za-z0-9\-_\/]+)?(?:.*)\.(?:\w+))$", docs.FileHandler),
 150                         (r"/docs([A-Za-z0-9\-_\/]+)?", docs.PageHandler),
 151
 152                         # Downloads
 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),
 157
 158                         # Donate
 159                         (r"/donate", donate.DonateHandler),
 160                         (r"/donate/thank-you", donate.ThankYouHandler),
 161                         (r"/donate/error", donate.ErrorHandler),
 162
 163                         # Password Reset
 164                         (r"/password\-reset", auth.PasswordResetInitiationHandler),
 165                         (r"/password\-reset/([a-z_][a-z0-9_-]{0,31})/(\w+)", auth.PasswordResetHandler),
 166
 167                         # Single-Sign-On for Discourse
 168                         (r"/sso/discourse", auth.SSODiscourse),
 169
 170                         # User Groups
 171                         (r"/users/groups", users.GroupIndexHandler),
 172                         (r"/users/groups/([a-z_][a-z0-9_-]{0,31})", users.GroupShowHandler),
 173
 174                         # Users
 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),
 181
 182                         # VoIP
 183                         (r"/voip", voip.IndexHandler),
 184
 185                         # Static Pages
 186                         (r"/about",  StaticHandler, { "template" : "about.html" }),
 187                         (r"/legal", StaticHandler, { "template" : "legal.html" }),
 188                         (r"/help", StaticHandler, { "template" : "help.html" }),
 189
 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}"}),
 200
 201                         # Export arbitrary error pages
 202                         (r"/error/([45][0-9]{2})", base.ErrorHandler),
 203
 204                         # Serve any static files
 205                         (r"/static/(.*)", tornado.web.StaticFileHandler, { "path" : self.settings.get("static_path") }),
 206                 ])
 207
 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}" }),
 214
 215                         # RSS Feed
 216                         (r"/feed.xml", tornado.web.RedirectHandler, { "url" : "https://www.ipfire.org/blog/feed.xml" }),
 217                 ])
 218
 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),
 224                 ])
 225
 226                 # mirrors.ipfire.org
 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}" }),
 230                 ])
 231
 232                 # planet.ipfire.org
 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}" }),
 237
 238                         # RSS
 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" }),
 242                 ])
 243
 244                 # fireinfo.ipfire.org
 245                 self.add_handlers(r"fireinfo\.([a-z]+\.dev\.)?ipfire\.org", [
 246                         (r"/", fireinfo.IndexHandler),
 247
 248                         # Admin
 249                         (r"/admin", fireinfo.AdminIndexHandler),
 250
 251                         # Vendors
 252                         (r"/vendors", fireinfo.VendorsHandler),
 253                         (r"/vendors/(pci|usb)/([0-9a-f]{4})", fireinfo.VendorHandler),
 254
 255                         # Driver
 256                         (r"/drivers/(.*)", fireinfo.DriverDetail),
 257
 258                         # Show profiles
 259                         (r"/profile/random", fireinfo.RandomProfileHandler),
 260                         (r"/profile/([a-z0-9]{40})", fireinfo.ProfileHandler),
 261
 262                         # Stats
 263                         (r"/processors", fireinfo.ProcessorsHandler),
 264                         (r"/releases", fireinfo.ReleasesHandler),
 265
 266                         # Send profiles
 267                         (r"/send/([a-z0-9]+)", fireinfo.ProfileSendHandler),
 268
 269                         # Serve any static files
 270                         (r"/static/(.*)", tornado.web.StaticFileHandler, { "path" : self.settings.get("static_path") }),
 271                 ] + authentication_handlers)
 272
 273                 # i-use.ipfire.org
 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),
 277                 ])
 278
 279                 # boot.ipfire.org
 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" }),
 283
 284                         # Configurations
 285                         (r"/premenu.cfg", boot.PremenuCfgHandler),
 286                         (r"/menu.gpxe", boot.MenuGPXEHandler),
 287                         (r"/menu.cfg", boot.MenuCfgHandler),
 288
 289                         # Static files
 290                         (r"/(boot\.png|pxelinux\.0|menu\.c32|vesamenu\.c32)",
 291                                 tornado.web.StaticFileHandler, { "path" : BOOT_STATIC_PATH }),
 292                 ])
 293
 294                 # nopaste.ipfire.org
 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),
 299
 300                         # Serve any static files
 301                         (r"/static/(.*)", tornado.web.StaticFileHandler, { "path" : self.settings.get("static_path") }),
 302                 ] + authentication_handlers)
 303
 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),
 311
 312                         # Serve any static files
 313                         (r"/static/(.*)", tornado.web.StaticFileHandler, { "path" : self.settings.get("static_path") }),
 314                 ])
 315
 316                 # geoip.ipfire.org
 317                 self.add_handlers(r"geoip\.([a-z]+\.dev\.)?ipfire\.org", [
 318                         (r"/", tornado.web.RedirectHandler, { "url" : "https://location.ipfire.org/" }),
 319                 ])
 320
 321                 # talk.ipfire.org
 322                 self.add_handlers(r"talk\.([a-z]+\.dev\.)?ipfire\.org", [
 323                         (r"/", tornado.web.RedirectHandler, { "url" : "https://people.ipfire.org/" }),
 324                 ])
 325
 326                 # 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"/register", auth.RegisterHandler),
 331
 332                         # Promotional Consent Stuff
 333                         (r"/subscribe", people.SubscribeHandler),
 334                         (r"/unsubscribe", people.UnsubscribeHandler),
 335
 336                         # Serve any static files
 337                         (r"/static/(.*)", tornado.web.StaticFileHandler, { "path" : self.settings.get("static_path") }),
 338
 339                         # API
 340                         (r"/api/check/email", auth.APICheckEmail),
 341                         (r"/api/check/uid", auth.APICheckUID),
 342                 ]  + authentication_handlers)
 343
 344                 # wiki.ipfire.org
 345                 self.add_handlers(r"wiki\.([a-z]+\.dev\.)?ipfire\.org",
 346                         authentication_handlers + [
 347
 348                         # Actions
 349                         (r"((?:[A-Za-z0-9\-_\/]+)?(?:.*)\.(?:\w+))/_delete", wiki.ActionDeleteHandler),
 350                         (r"([A-Za-z0-9\-_\/]+)?/_edit", wiki.ActionEditHandler),
 351                         (r"([A-Za-z0-9\-_\/]+)?/_render", wiki.ActionRenderHandler),
 352                         (r"([A-Za-z0-9\-_\/]+)?/_(watch|unwatch)", wiki.ActionWatchHandler),
 353                         (r"/actions/restore", wiki.ActionRestoreHandler),
 354                         (r"/actions/upload", wiki.ActionUploadHandler),
 355
 356                         # Media
 357                         (r"([A-Za-z0-9\-_\/]+)?/_files", wiki.FilesHandler),
 358
 359                         # Serve any static files
 360                         (r"/static/(.*)", tornado.web.StaticFileHandler, { "path" : self.settings.get("static_path") }),
 361
 362                         # Render pages
 363                         (r"([A-Za-z0-9\-_\/]+)?", tornado.web.RedirectHandler, { "url" : "https://www.ipfire.org/docs{0}" }),
 364                 ])
 365
 366                 # ipfire.org
 367                 self.add_handlers(r"(.*)ipfire\.org", [
 368                         (r".*", tornado.web.RedirectHandler, { "url" : "https://www.ipfire.org" })
 369                 ])
 370
 371                 logging.info("Successfully initialied application")
 372
 373         def format_country_name(self, handler, country_code):
 374                 return self.backend.get_country_name(country_code)
 375
 376         def format_language_name(self, handler, language):
 377                 _ = handler.locale.translate
 378
 379                 if language == "de":
 380                         return _("German")
 381                 elif language == "en":
 382                         return _("English")
 383                 elif language == "es":
 384                         return _("Spanish")
 385                 elif language == "fr":
 386                         return _("French")
 387                 elif language == "it":
 388                         return _("Italian")
 389                 elif language == "nl":
 390                         return _("Dutch")
 391                 elif language == "pl":
 392                         return _("Polish")
 393                 elif language == "pt":
 394                         return _("Portuguese")
 395                 elif language == "ru":
 396                         return _("Russian")
 397                 elif language == "tr":
 398                         return _("Turkish")
 399
 400                 return language
 401
 402         def format_month_name(self, handler, month):
 403                 _ = handler.locale.translate
 404
 405                 if month == 1:
 406                         return _("January")
 407                 elif month == 2:
 408                         return _("February")
 409                 elif month == 3:
 410                         return _("March")
 411                 elif month == 4:
 412                         return _("April")
 413                 elif month == 5:
 414                         return _("May")
 415                 elif month == 6:
 416                         return _("June")
 417                 elif month == 7:
 418                         return _("July")
 419                 elif month == 8:
 420                         return _("August")
 421                 elif month == 9:
 422                         return _("September")
 423                 elif month == 10:
 424                         return _("October")
 425                 elif month == 11:
 426                         return _("November")
 427                 elif month == 12:
 428                         return _("December")
 429
 430                 return month
 431
 432         def format_phone_number(self, handler, number):
 433                 if not isinstance(number, phonenumbers.PhoneNumber):
 434                         try:
 435                                 number = phonenumbers.parse(number, None)
 436                         except phonenumbers.phonenumberutil.NumberParseException:
 437                                 return number
 438
 439                 return phonenumbers.format_number(number, phonenumbers.PhoneNumberFormat.INTERNATIONAL)
 440
 441         def format_phone_number_to_e164(self, handler, number):
 442                 return phonenumbers.format_number(number, phonenumbers.PhoneNumberFormat.E164)
 443
 444         def format_phone_number_location(self, handler, number):
 445                 s = [
 446                         phonenumbers.geocoder.description_for_number(number, handler.locale.code),
 447                         phonenumbers.region_code_for_number(number),
 448                 ]
 449
 450                 return ", ".join((e for e in s if e))