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