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 analytics
  18 from . import auth
  19 from . import blog
  20 from . import boot
  21 from . import docs
  22 from . import donate
  23 from . import downloads
  24 from . import fireinfo
  25 from . import iuse
  26 from . import lists
  27 from . import location
  28 from . import nopaste
  29 from . import ui_modules
  30 from . import users
  31 from . import voip
  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                         "xsrf_cookie_kwargs" : {
  45                                 "secure" : True,
  46                         },
  47
  48                         # Login
  49                         "login_url" : "/login",
  50
  51                         # Setup directory structure
  52                         "static_path"   : self.backend.config.get("global", "static_dir"),
  53                         "template_path" : self.backend.config.get("global", "templates_dir"),
  54
  55                         # UI Methods
  56                         "ui_methods" : {
  57                                 "format_country_name"          : self.format_country_name,
  58                                 "format_language_name"         : self.format_language_name,
  59                                 "format_month_name"            : self.format_month_name,
  60                                 "format_phone_number"          : self.format_phone_number,
  61                                 "format_phone_number_to_e164"  : self.format_phone_number_to_e164,
  62                                 "format_phone_number_location" : self.format_phone_number_location,
  63                         },
  64
  65                         # UI Modules
  66                         "ui_modules" : {
  67                                 # Analytics
  68                                 "AnalyticsSummary"     : analytics.SummaryModule,
  69
  70                                 # Auth
  71                                 "Password"             : auth.PasswordModule,
  72
  73                                 # Blog
  74                                 "BlogHistoryNavigation": blog.HistoryNavigationModule,
  75                                 "BlogList"             : blog.ListModule,
  76
  77                                 # Boot
  78                                 "BootMenuConfig"       : boot.MenuConfigModule,
  79                                 "BootMenuHeader"       : boot.MenuHeaderModule,
  80                                 "BootMenuSeparator"    : boot.MenuSeparatorModule,
  81
  82                                 # Docs
  83                                 "DocsDiff"             : docs.DiffModule,
  84                                 "DocsHeader"           : docs.HeaderModule,
  85                                 "DocsList"             : docs.ListModule,
  86
  87                                 # Nopaste
  88                                 "Code"                 : nopaste.CodeModule,
  89
  90                                 # Fireinfo
  91                                 "FireinfoDeviceTable"  : fireinfo.DeviceTableModule,
  92                                 "FireinfoDeviceAndGroupsTable"
  93                                                        : fireinfo.DeviceAndGroupsTableModule,
  94
  95                                 # Users
  96                                 "UsersList"            : users.ListModule,
  97
  98                                 # VoIP
  99                                 "VoIPConferences"      : voip.ConferencesModule,
 100                                 "VoIPOutboundRegistrations" :
 101                                         voip.OutboundRegistrationsModule,
 102                                 "VoIPQueues"           : voip.QueuesModule,
 103                                 "VoIPRegistrations"    : voip.RegistrationsModule,
 104
 105                                 # Misc
 106                                 "IPFireLogo"           : ui_modules.IPFireLogoModule,
 107                                 "Markdown"             : ui_modules.MarkdownModule,
 108                                 "Map"                  : ui_modules.MapModule,
 109                                 "ProgressBar"          : ui_modules.ProgressBarModule,
 110                         },
 111
 112                         # Call this when a page wasn't found
 113                         "default_handler_class" : base.NotFoundHandler,
 114                 }
 115                 settings.update(kwargs)
 116
 117                 tornado.web.Application.__init__(self, **settings)
 118
 119                 authentication_handlers = [
 120                         (r"/login", auth.LoginHandler),
 121                         (r"/logout", auth.LogoutHandler),
 122                 ]
 123
 124                 self.add_handlers(r"www\.([a-z]+\.dev\.)?ipfire\.org", [
 125                         # Entry site that lead the user to index
 126                         (r"/", IndexHandler),
 127
 128                         # Analytics
 129                         (r"/analytics", analytics.IndexHandler),
 130                         (r"/analytics/docs", analytics.DocsHandler),
 131
 132                         # Authentication
 133                         (r"/join", auth.JoinHandler),
 134                         (r"/login", auth.LoginHandler),
 135                         (r"/logout", auth.LogoutHandler),
 136                         (r"/activate/([a-z_][a-z0-9_-]{0,31})/(\w+)", auth.ActivateHandler),
 137
 138                         # Blog
 139                         (r"/blog", blog.IndexHandler),
 140                         (r"/blog/drafts", blog.DraftsHandler),
 141                         (r"/blog/feed.xml", blog.FeedHandler),
 142                         (r"/blog/write", blog.WriteHandler),
 143                         (r"/blog/years/([0-9]{4})", blog.YearHandler),
 144                         (r"/blog/([0-9a-z\-\._]+)", blog.PostHandler),
 145                         (r"/blog/([0-9a-z\-\._]+)/delete", blog.DeleteHandler),
 146                         (r"/blog/([0-9a-z\-\._]+)/edit", blog.EditHandler),
 147                         (r"/blog/([0-9a-z\-\._]+)/publish", blog.PublishHandler),
 148                         (r"/blog/([0-9a-z\-\._]+)/debug/email", blog.DebugEmailHandler),
 149
 150                         # Docs
 151                         (r"/docs/recent\-changes", docs.RecentChangesHandler),
 152                         (r"/docs/search", docs.SearchHandler),
 153                         (r"/docs/tree", docs.TreeHandler),
 154                         (r"/docs/watchlist", docs.WatchlistHandler),
 155                         (r"/docs/_restore", docs.RestoreHandler),
 156                         (r"/docs/_upload", docs.UploadHandler),
 157                         (r"/docs(/[A-Za-z0-9\-_\/]+)?/_edit", docs.EditHandler),
 158                         (r"/docs(/[A-Za-z0-9\-_\/]+)?/_render", docs.RenderHandler),
 159                         (r"/docs(/[A-Za-z0-9\-_\/]+)?/_(watch|unwatch)", docs.WatchHandler),
 160                         (r"/docs(/[A-Za-z0-9\-_\/]+)?/_files", docs.FilesHandler),
 161                         (r"/docs(/[A-Za-z0-9\-_\/]+(?:.*)\.(?:\w+))/_delete", docs.DeleteFileHandler),
 162                         (r"/docs(/[A-Za-z0-9\-_\/]+(?:.*)\.(?:\w+))$", docs.FileHandler),
 163                         (r"/docs(/[A-Za-z0-9\-_\/]*)?", docs.PageHandler),
 164
 165                         # Downloads
 166                         (r"/downloads", downloads.IndexHandler),
 167                         (r"/downloads/cloud", StaticHandler, { "template" : "downloads/cloud.html" }),
 168                         (r"/downloads/mirrors", downloads.MirrorsHandler),
 169                         (r"/downloads/thank-you", downloads.ThankYouHandler),
 170                         (r"/downloads/([0-9a-z\-\.]+)", downloads.ReleaseHandler),
 171
 172                         # Donate
 173                         (r"/donate", donate.DonateHandler),
 174                         (r"/donate/thank-you", donate.ThankYouHandler),
 175                         (r"/donate/error", donate.ErrorHandler),
 176                         (r"/donate/check-vat-number", donate.CheckVATNumberHandler),
 177
 178                         # Fireinfo
 179                         (r"/fireinfo", fireinfo.IndexHandler),
 180                         (r"/fireinfo/admin", fireinfo.AdminIndexHandler),
 181                         (r"/fireinfo/vendors", fireinfo.VendorsHandler),
 182                         (r"/fireinfo/vendors/(pci|usb)/([0-9a-f]{4})", fireinfo.VendorHandler),
 183                         (r"/fireinfo/drivers/(.*)", fireinfo.DriverDetail),
 184                         (r"/fireinfo/profile/random", fireinfo.RandomProfileHandler),
 185                         (r"/fireinfo/profile/([a-z0-9]{40})", fireinfo.ProfileHandler),
 186                         (r"/fireinfo/processors", fireinfo.ProcessorsHandler),
 187                         (r"/fireinfo/releases", fireinfo.ReleasesHandler),
 188
 189                         # Lists
 190                         (r"/lists", lists.IndexHandler),
 191
 192                         # Password Reset
 193                         (r"/password\-reset", auth.PasswordResetInitiationHandler),
 194                         (r"/password\-reset/([a-z_][a-z0-9_-]{0,31})/(\w+)", auth.PasswordResetHandler),
 195                         (r"/.well-known/change-password", auth.WellKnownChangePasswordHandler),
 196
 197                         # Location
 198                         (r"/location/?", location.IndexHandler),
 199                         (r"/location/download", StaticHandler, { "template" : "location/download.html" }),
 200                         (r"/location/how\-to\-use", StaticHandler, { "template" : "location/how-to-use.html" }),
 201                         (r"/location/lookup/(.+)", location.LookupHandler),
 202
 203                         # Single-Sign-On for Discourse
 204                         (r"/sso/discourse", auth.SSODiscourse),
 205
 206                         # User Groups
 207                         (r"/users/groups", users.GroupIndexHandler),
 208                         (r"/users/groups/([a-z_][a-z0-9_-]{0,31})", users.GroupShowHandler),
 209
 210                         # Users
 211                         (r"/users", users.IndexHandler),
 212                         (r"/users/([a-z_][a-z0-9_-]{0,31})", users.ShowHandler),
 213                         (r"/users/([a-z_][a-z0-9_-]{0,31})\.jpg", users.AvatarHandler),
 214                         (r"/users/([a-z_][a-z0-9_-]{0,31})/delete", users.DeleteHandler),
 215                         (r"/users/([a-z_][a-z0-9_-]{0,31})/edit", users.EditHandler),
 216                         (r"/users/([a-z_][a-z0-9_-]{0,31})/passwd", users.PasswdHandler),
 217
 218                         # Promotional Consent Stuff
 219                         (r"/subscribe", users.SubscribeHandler),
 220                         (r"/unsubscribe", users.UnsubscribeHandler),
 221
 222                         # VoIP
 223                         (r"/voip", voip.IndexHandler),
 224
 225                         # Static Pages
 226                         (r"/about",  StaticHandler, { "template" : "static/about.html" }),
 227                         (r"/legal", StaticHandler, { "template" : "static/legal.html" }),
 228                         (r"/help", StaticHandler, { "template" : "static/help.html" }),
 229                         (r"/partners", StaticHandler, { "template" : "static/partners.html" }),
 230                         (r"/sitemap",  StaticHandler, { "template" : "static/sitemap.html" }),
 231
 232                         # API
 233                         (r"/api/check/email", auth.APICheckEmail),
 234                         (r"/api/check/uid", auth.APICheckUID),
 235
 236                         # Handle old pages that have moved elsewhere
 237                         (r"/blog/authors/(\w+)", tornado.web.RedirectHandler, { "url" : "/users/{0}" }),
 238                         (r"/donation", tornado.web.RedirectHandler, { "url" : "/donate" }),
 239                         (r"/download", tornado.web.RedirectHandler, { "url" : "/downloads" }),
 240                         (r"/download/([0-9a-z\-\.]+)", tornado.web.RedirectHandler, { "url" : "/downloads/{0}" }),
 241                         (r"/features", tornado.web.RedirectHandler, { "url" : "/about" }),
 242                         (r"/imprint", tornado.web.RedirectHandler, { "url" : "/legal" }),
 243                         (r"/news.rss", tornado.web.RedirectHandler, { "url" : "/blog/feed.xml" }),
 244                         (r"/news/(.*)", tornado.web.RedirectHandler, { "url" : "/blog/{0}" }),
 245                         (r"/support", tornado.web.RedirectHandler, { "url" : "/help"}),
 246                         (r"/(de|en)/(.*)", tornado.web.RedirectHandler, { "url" : "/{0}"}),
 247
 248                         # Export arbitrary error pages
 249                         (r"/error/([45][0-9]{2})", base.ErrorHandler),
 250
 251                         # Serve any static files
 252                         (r"/static/(.*)", tornado.web.StaticFileHandler, { "path" : self.settings.get("static_path") }),
 253                 ])
 254
 255                 # blog.ipfire.org - LEGACY REDIRECTION
 256                 self.add_handlers(r"blog\.([a-z]+\.dev\.)?ipfire\.org", [
 257                         (r"/", tornado.web.RedirectHandler, { "url" : "https://www.ipfire.org/blog" }),
 258                         (r"/authors/(\w+)", tornado.web.RedirectHandler, { "url" : "https://www.ipfire.org/blog/authors/{0}" }),
 259                         (r"/post/([0-9a-z\-\._]+)", tornado.web.RedirectHandler, { "url" : "https://www.ipfire.org/blog/{0}" }),
 260                         (r"/tags/([0-9a-z\-\.]+)", tornado.web.RedirectHandler, { "url" : "https://www.ipfire.org/blog/tags/{0}" }),
 261
 262                         # RSS Feed
 263                         (r"/feed.xml", tornado.web.RedirectHandler, { "url" : "https://www.ipfire.org/blog/feed.xml" }),
 264                 ])
 265
 266                 # downloads.ipfire.org
 267                 self.add_handlers(r"downloads\.([a-z]+\.dev\.)?ipfire\.org", [
 268                         (r"/", tornado.web.RedirectHandler, { "url" : "https://www.ipfire.org/download" }),
 269                         (r"/release/(.*)",  tornado.web.RedirectHandler, { "url" : "https://www.ipfire.org/download/{0}" }),
 270                         (r"/(.*)", downloads.FileHandler),
 271                 ])
 272
 273                 # mirrors.ipfire.org
 274                 self.add_handlers(r"mirrors\.([a-z]+\.dev\.)?ipfire\.org", [
 275                         (r"/", tornado.web.RedirectHandler, { "url" : "https://www.ipfire.org/download/mirrors" }),
 276                         (r"/mirrors/(.*)", tornado.web.RedirectHandler, { "url" : "https://www.ipfire.org/download/mirrors/{0}" }),
 277                 ])
 278
 279                 # planet.ipfire.org
 280                 self.add_handlers(r"planet\.([a-z]+\.dev\.)?ipfire\.org", [
 281                         (r"/", tornado.web.RedirectHandler, { "url" : "https://blog.ipfire.org/" }),
 282                         (r"/post/([A-Za-z0-9_-]+)", tornado.web.RedirectHandler, { "url" : "https://www.ipfire.org/blog/{0}" }),
 283                         (r"/user/([a-z0-9_-]+)", tornado.web.RedirectHandler, { "url" : "https://www.ipfire.org/blog/authors/{0}" }),
 284
 285                         # RSS
 286                         (r"/rss", tornado.web.RedirectHandler, { "url" : "https://blog.ipfire.org/feed.xml" }),
 287                         (r"/user/([a-z0-9_-]+)/rss", tornado.web.RedirectHandler, { "url" : "https://blog.ipfire.org/feed.xml" }),
 288                         (r"/news.rss", tornado.web.RedirectHandler, { "url" : "https://blog.ipfire.org/feed.xml" }),
 289                 ])
 290
 291                 # fireinfo.ipfire.org
 292                 self.add_handlers(r"fireinfo\.([a-z]+\.dev\.)?ipfire\.org", [
 293                         # Handle profiles
 294                         (r"/fireinfo/send/([a-z0-9]+)", fireinfo.ProfileSendHandler),
 295
 296                         # Redirect anything else
 297                         (r"(.*)", tornado.web.RedirectHandler, { "url" : "https://www.ipfire.org/fireinfo{0}" }),
 298                 ])
 299
 300                 # i-use.ipfire.org
 301                 self.add_handlers(r"i-use\.([a-z]+\.dev\.)?ipfire\.org", [
 302                         (r"/", tornado.web.RedirectHandler, { "url" : "https://www.ipfire.org/" }),
 303                         (r"/profile/([a-f0-9]{40})/([0-9]+).png", iuse.ImageHandler),
 304                 ])
 305
 306                 # boot.ipfire.org
 307                 BOOT_STATIC_PATH = os.path.join(self.settings["static_path"], "netboot")
 308                 self.add_handlers(r"boot\.([a-z]+\.dev\.)?ipfire\.org", [
 309                         (r"/", tornado.web.RedirectHandler, { "url" : "https://wiki.ipfire.org/installation/pxe" }),
 310
 311                         # Configurations
 312                         (r"/premenu.cfg", boot.PremenuCfgHandler),
 313                         (r"/menu.gpxe", boot.MenuGPXEHandler),
 314                         (r"/menu.cfg", boot.MenuCfgHandler),
 315
 316                         # Static files
 317                         (r"/(boot\.png|pxelinux\.0|menu\.c32|vesamenu\.c32)",
 318                                 tornado.web.StaticFileHandler, { "path" : BOOT_STATIC_PATH }),
 319                 ])
 320
 321                 # nopaste.ipfire.org
 322                 self.add_handlers(r"nopaste\.([a-z]+\.dev\.)?ipfire\.org", [
 323                         (r"/", nopaste.CreateHandler),
 324                         (r"/upload", nopaste.UploadHandler),
 325
 326                         # View
 327                         (r"/raw/(.*)", nopaste.RawHandler),
 328                         (r"/view/(.*)", nopaste.ViewHandler),
 329
 330                         # Serve any static files
 331                         (r"/static/(.*)", tornado.web.StaticFileHandler, { "path" : self.settings.get("static_path") }),
 332                 ] + authentication_handlers)
 333
 334                 # location.ipfire.org
 335                 self.add_handlers(r"location\.([a-z]+\.dev\.)?ipfire\.org", [
 336                         (r"(.*)", tornado.web.RedirectHandler, { "url" : "https://www.ipfire.org/location{0}" }),
 337                 ])
 338
 339                 # geoip.ipfire.org
 340                 self.add_handlers(r"geoip\.([a-z]+\.dev\.)?ipfire\.org", [
 341                         (r"/", tornado.web.RedirectHandler, { "url" : "https://location.ipfire.org/" }),
 342                 ])
 343
 344                 # talk.ipfire.org
 345                 self.add_handlers(r"talk\.([a-z]+\.dev\.)?ipfire\.org", [
 346                         (r"/", tornado.web.RedirectHandler, { "url" : "https://people.ipfire.org/" }),
 347                 ])
 348
 349                 # people.ipfire.org
 350                 self.add_handlers(r"people\.([a-z]+\.dev\.)?ipfire\.org", [
 351                         (r"/", tornado.web.RedirectHandler, { "url" : "https://www.ipfire.org/users" }),
 352                         (r"/register", tornado.web.RedirectHandler, { "url" : "https://www.ipfire.org/join" }),
 353                         (r"/users", tornado.web.RedirectHandler, { "url" : "https://www.ipfire.org/users" }),
 354                         (r"/users/([a-z_][a-z0-9_-]{0,31})", tornado.web.RedirectHandler, { "url" : "https://www.ipfire.org/users/{0}" }),
 355                         (r"/users/([a-z_][a-z0-9_-]{0,31})\.jpg", tornado.web.RedirectHandler, { "url" : "https://www.ipfire.org/users/{0}.jpg" }),
 356                 ])
 357
 358                 # wiki.ipfire.org
 359                 self.add_handlers(r"wiki\.([a-z]+\.dev\.)?ipfire\.org", [
 360                         (r"(.*)", tornado.web.RedirectHandler, { "url" : "https://www.ipfire.org/docs{0}" }),
 361                 ])
 362
 363                 # ipfire.org
 364                 self.add_handlers(r"([a-z]+\.dev\.)?ipfire\.org", [
 365                         (r".*", tornado.web.RedirectHandler, { "url" : "https://www.ipfire.org/" })
 366                 ])
 367
 368                 logging.info("Successfully initialied application")
 369
 370         def format_country_name(self, handler, country_code):
 371                 return self.backend.get_country_name(country_code)
 372
 373         def format_language_name(self, handler, language):
 374                 _ = handler.locale.translate
 375
 376                 if language == "de":
 377                         return _("German")
 378                 elif language == "en":
 379                         return _("English")
 380                 elif language == "es":
 381                         return _("Spanish")
 382                 elif language == "fr":
 383                         return _("French")
 384                 elif language == "it":
 385                         return _("Italian")
 386                 elif language == "nl":
 387                         return _("Dutch")
 388                 elif language == "pl":
 389                         return _("Polish")
 390                 elif language == "pt":
 391                         return _("Portuguese")
 392                 elif language == "ru":
 393                         return _("Russian")
 394                 elif language == "tr":
 395                         return _("Turkish")
 396
 397                 return language
 398
 399         def format_month_name(self, handler, month):
 400                 _ = handler.locale.translate
 401
 402                 if month == 1:
 403                         return _("January")
 404                 elif month == 2:
 405                         return _("February")
 406                 elif month == 3:
 407                         return _("March")
 408                 elif month == 4:
 409                         return _("April")
 410                 elif month == 5:
 411                         return _("May")
 412                 elif month == 6:
 413                         return _("June")
 414                 elif month == 7:
 415                         return _("July")
 416                 elif month == 8:
 417                         return _("August")
 418                 elif month == 9:
 419                         return _("September")
 420                 elif month == 10:
 421                         return _("October")
 422                 elif month == 11:
 423                         return _("November")
 424                 elif month == 12:
 425                         return _("December")
 426
 427                 return month
 428
 429         def format_phone_number(self, handler, number):
 430                 if not isinstance(number, phonenumbers.PhoneNumber):
 431                         try:
 432                                 number = phonenumbers.parse(number, None)
 433                         except phonenumbers.phonenumberutil.NumberParseException:
 434                                 return number
 435
 436                 return phonenumbers.format_number(number, phonenumbers.PhoneNumberFormat.INTERNATIONAL)
 437
 438         def format_phone_number_to_e164(self, handler, number):
 439                 return phonenumbers.format_number(number, phonenumbers.PhoneNumberFormat.E164)
 440
 441         def format_phone_number_location(self, handler, number):
 442                 s = [
 443                         phonenumbers.geocoder.description_for_number(number, handler.locale.code),
 444                         phonenumbers.region_code_for_number(number),
 445                 ]
 446
 447                 return ", ".join((e for e in s if e))