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 donate
  21 from . import download
  22 from . import fireinfo
  23 from . import iuse
  24 from . import location
  25 from . import nopaste
  26 from . import people
  27 from . import ui_modules
  28 from . import users
  29 from . import wiki
  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                                 # Blog
  63                                 "BlogHistoryNavigation": blog.HistoryNavigationModule,
  64                                 "BlogList"             : blog.ListModule,
  65                                 "BlogPost"             : blog.PostModule,
  66
  67                                 # Boot
  68                                 "BootMenuConfig"       : boot.MenuConfigModule,
  69                                 "BootMenuHeader"       : boot.MenuHeaderModule,
  70                                 "BootMenuSeparator"    : boot.MenuSeparatorModule,
  71
  72                                 # People
  73                                 "AccountsList"         : people.AccountsListModule,
  74                                 "Agent"                : people.AgentModule,
  75                                 "CDR"                  : people.CDRModule,
  76                                 "Channels"             : people.ChannelsModule,
  77                                 "MOS"                  : people.MOSModule,
  78                                 "Password"             : people.PasswordModule,
  79                                 "Registrations"        : people.RegistrationsModule,
  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                                 # Wiki
  93                                 "WikiDiff"             : wiki.WikiDiffModule,
  94                                 "WikiNavbar"           : wiki.WikiNavbarModule,
  95                                 "WikiList"             : wiki.WikiListModule,
  96
  97                                 # Misc
  98                                 "ChristmasBanner"      : ui_modules.ChristmasBannerModule,
  99                                 "Markdown"             : ui_modules.MarkdownModule,
 100                                 "Map"                  : ui_modules.MapModule,
 101                                 "ProgressBar"          : ui_modules.ProgressBarModule,
 102                         },
 103
 104                         # Call this when a page wasn't found
 105                         "default_handler_class" : base.NotFoundHandler,
 106                 }
 107                 settings.update(kwargs)
 108
 109                 tornado.web.Application.__init__(self, **settings)
 110
 111                 authentication_handlers = [
 112                         (r"/login", auth.LoginHandler),
 113                         (r"/logout", auth.LogoutHandler),
 114                 ]
 115
 116                 self.add_handlers(r"(www\.)?([a-z]+\.dev\.)?ipfire\.org", [
 117                         # Entry site that lead the user to index
 118                         (r"/", IndexHandler),
 119                         (r"/about", AboutHandler),
 120
 121                         # Authentication
 122                         (r"/login", auth.LoginHandler),
 123                         (r"/logout", auth.LogoutHandler),
 124                         (r"/register", auth.RegisterHandler),
 125
 126                         # Blog
 127                         (r"/blog", blog.IndexHandler),
 128                         (r"/blog/authors/(\w+)", blog.AuthorHandler),
 129                         (r"/blog/compose", blog.ComposeHandler),
 130                         (r"/blog/drafts", blog.DraftsHandler),
 131                         (r"/blog/feed.xml", blog.FeedHandler),
 132                         (r"/blog/search", blog.SearchHandler),
 133                         (r"/blog/tags/([0-9a-z\-\.]+)", blog.TagHandler),
 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                         # Download sites
 141                         (r"/downloads", tornado.web.RedirectHandler, { "url" : "/download" }),
 142                         (r"/download", download.IndexHandler),
 143                         (r"/download/mirrors", download.MirrorsHandler),
 144                         (r"/download/thank-you", download.ThankYouHandler),
 145                         (r"/download/([0-9a-z\-\.]+)", download.ReleaseHandler),
 146
 147                         # Donate
 148                         (r"/donate", donate.DonateHandler),
 149                         (r"/donate/thank-you", donate.ThankYouHandler),
 150                         (r"/donate/error", donate.ErrorHandler),
 151                         (r"/donation", tornado.web.RedirectHandler, { "url" : "/donate" }),
 152
 153                         # Users
 154                         (r"/users", users.IndexHandler),
 155                         (r"/users/([a-z_][a-z0-9_-]{0,31})", users.ShowHandler),
 156                         (r"/users/([a-z_][a-z0-9_-]{0,31})\.jpg", users.AvatarHandler),
 157
 158                         # RSS feed
 159                         (r"/news.rss", tornado.web.RedirectHandler, { "url" : "https://blog.ipfire.org/feed.xml" }),
 160
 161                         # Redirect news articles to blog
 162                         (r"/news/(.*)", handlers.NewsHandler),
 163
 164                         # Static Pages
 165                         (r"/features", StaticHandler, { "template" : "features.html" }),
 166                         (r"/legal", StaticHandler, { "template" : "legal.html" }),
 167                         (r"/help", StaticHandler, { "template" : "help.html" }),
 168
 169                         # Handle old pages that have moved elsewhere
 170                         (r"/imprint", tornado.web.RedirectHandler, { "url" : "/legal" }),
 171                         (r"/(de|en)/(.*)", LangCompatHandler),
 172                         (r"/support", tornado.web.RedirectHandler, { "url" : "/help"}),
 173
 174                         # Export arbitrary error pages
 175                         (r"/error/([45][0-9]{2})", base.ErrorHandler),
 176
 177                         # Serve any static files
 178                         (r"/static/(.*)", tornado.web.StaticFileHandler, { "path" : self.settings.get("static_path") }),
 179                 ])
 180
 181                 # blog.ipfire.org - LEGACY REDIRECTION
 182                 self.add_handlers(r"blog\.([a-z]+\.dev\.)?ipfire\.org", [
 183                         (r"/", tornado.web.RedirectHandler, { "url" : "https://www.ipfire.org/blog" }),
 184                         (r"/authors/(\w+)", tornado.web.RedirectHandler, { "url" : "https://www.ipfire.org/blog/authors/{0}" }),
 185                         (r"/post/([0-9a-z\-\._]+)", tornado.web.RedirectHandler, { "url" : "https://www.ipfire.org/blog/{0}" }),
 186                         (r"/tags/([0-9a-z\-\.]+)", tornado.web.RedirectHandler, { "url" : "https://www.ipfire.org/blog/tags/{0}" }),
 187
 188                         # RSS Feed
 189                         (r"/feed.xml", tornado.web.RedirectHandler, { "url" : "https://www.ipfire.org/blog/feed.xml" }),
 190                 ])
 191
 192                 # downloads.ipfire.org
 193                 self.add_handlers(r"downloads\.([a-z]+\.dev\.)?ipfire\.org", [
 194                         (r"/", tornado.web.RedirectHandler, { "url" : "https://www.ipfire.org/download" }),
 195                         (r"/release/(.*)",  tornado.web.RedirectHandler, { "url" : "https://www.ipfire.org/download/{0}" }),
 196                         (r"/(.*)", download.FileHandler),
 197                 ])
 198
 199                 # mirrors.ipfire.org
 200                 self.add_handlers(r"mirrors\.([a-z]+\.dev\.)?ipfire\.org", [
 201                         (r"/", tornado.web.RedirectHandler, { "url" : "https://www.ipfire.org/download/mirrors" }),
 202                         (r"/mirrors/(.*)", tornado.web.RedirectHandler, { "url" : "https://www.ipfire.org/download/mirrors/{0}" }),
 203                 ])
 204
 205                 # planet.ipfire.org
 206                 self.add_handlers(r"planet\.([a-z]+\.dev\.)?ipfire\.org", [
 207                         (r"/", tornado.web.RedirectHandler, { "url" : "https://blog.ipfire.org/" }),
 208                         (r"/post/([A-Za-z0-9_-]+)", handlers.PlanetPostHandler),
 209                         (r"/user/([a-z0-9_-]+)", handlers.PlanetUserHandler),
 210
 211                         # RSS
 212                         (r"/rss", tornado.web.RedirectHandler, { "url" : "https://blog.ipfire.org/feed.xml" }),
 213                         (r"/user/([a-z0-9_-]+)/rss", tornado.web.RedirectHandler, { "url" : "https://blog.ipfire.org/feed.xml" }),
 214                         (r"/news.rss", tornado.web.RedirectHandler, { "url" : "https://blog.ipfire.org/feed.xml" }),
 215                 ])
 216
 217                 # fireinfo.ipfire.org
 218                 self.add_handlers(r"fireinfo\.([a-z]+\.dev\.)?ipfire\.org", [
 219                         (r"/", fireinfo.IndexHandler),
 220
 221                         # Admin
 222                         (r"/admin", fireinfo.AdminIndexHandler),
 223
 224                         # Vendors
 225                         (r"/vendors", fireinfo.VendorsHandler),
 226                         (r"/vendors/(pci|usb)/([0-9a-f]{4})", fireinfo.VendorHandler),
 227
 228                         # Driver
 229                         (r"/drivers/(.*)", fireinfo.DriverDetail),
 230
 231                         # Show profiles
 232                         (r"/profile/random", fireinfo.RandomProfileHandler),
 233                         (r"/profile/([a-z0-9]{40})", fireinfo.ProfileHandler),
 234
 235                         # Stats
 236                         (r"/processors", fireinfo.ProcessorsHandler),
 237                         (r"/releases", fireinfo.ReleasesHandler),
 238
 239                         # Send profiles
 240                         (r"/send/([a-z0-9]+)", fireinfo.ProfileSendHandler),
 241
 242                         # Serve any static files
 243                         (r"/static/(.*)", tornado.web.StaticFileHandler, { "path" : self.settings.get("static_path") }),
 244                 ] + authentication_handlers)
 245
 246                 # i-use.ipfire.org
 247                 self.add_handlers(r"i-use\.([a-z]+\.dev\.)?ipfire\.org", [
 248                         (r"/", tornado.web.RedirectHandler, { "url" : "https://www.ipfire.org/" }),
 249                         (r"/profile/([a-f0-9]{40})/([0-9]+).png", iuse.ImageHandler),
 250                 ])
 251
 252                 # boot.ipfire.org
 253                 BOOT_STATIC_PATH = os.path.join(self.settings["static_path"], "netboot")
 254                 self.add_handlers(r"boot\.([a-z]+\.dev\.)?ipfire\.org", [
 255                         (r"/", tornado.web.RedirectHandler, { "url" : "https://wiki.ipfire.org/installation/pxe" }),
 256
 257                         # Configurations
 258                         (r"/premenu.cfg", boot.PremenuCfgHandler),
 259                         (r"/menu.gpxe", boot.MenuGPXEHandler),
 260                         (r"/menu.cfg", boot.MenuCfgHandler),
 261
 262                         # Static files
 263                         (r"/(boot\.png|pxelinux\.0|menu\.c32|vesamenu\.c32)",
 264                                 tornado.web.StaticFileHandler, { "path" : BOOT_STATIC_PATH }),
 265                 ])
 266
 267                 # nopaste.ipfire.org
 268                 self.add_handlers(r"nopaste\.([a-z]+\.dev\.)?ipfire\.org", [
 269                         (r"/", nopaste.CreateHandler),
 270                         (r"/raw/(.*)", nopaste.RawHandler),
 271                         (r"/view/(.*)", nopaste.ViewHandler),
 272
 273                         # Serve any static files
 274                         (r"/static/(.*)", tornado.web.StaticFileHandler, { "path" : self.settings.get("static_path") }),
 275                 ] + authentication_handlers)
 276
 277                 # location.ipfire.org
 278                 self.add_handlers(r"location\.([a-z]+\.dev\.)?ipfire\.org", [
 279                         (r"/", location.IndexHandler),
 280                         (r"/download", StaticHandler, { "template" : "../location/download.html" }),
 281                         (r"/how\-to\-use", StaticHandler, { "template" : "../location/how-to-use.html" }),
 282                         (r"/lookup/(.+)/blacklists", location.BlacklistsHandler),
 283                         (r"/lookup/(.+)", location.LookupHandler),
 284
 285                         # Serve any static files
 286                         (r"/static/(.*)", tornado.web.StaticFileHandler, { "path" : self.settings.get("static_path") }),
 287                 ])
 288
 289                 # geoip.ipfire.org
 290                 self.add_handlers(r"geoip\.([a-z]+\.dev\.)?ipfire\.org", [
 291                         (r"/", tornado.web.RedirectHandler, { "url" : "https://location.ipfire.org/" }),
 292                 ])
 293
 294                 # talk.ipfire.org
 295                 self.add_handlers(r"talk\.([a-z]+\.dev\.)?ipfire\.org", [
 296                         (r"/", tornado.web.RedirectHandler, { "url" : "https://people.ipfire.org/" }),
 297                 ])
 298
 299                 # people.ipfire.org
 300                 self.add_handlers(r"people\.([a-z]+\.dev\.)?ipfire\.org", [
 301                         (r"/", people.IndexHandler),
 302                         (r"/activate/([a-z_][a-z0-9_-]{0,31})/(\w+)", auth.ActivateHandler),
 303                         (r"/conferences", people.ConferencesHandler),
 304                         (r"/groups", people.GroupsHandler),
 305                         (r"/groups/([a-z_][a-z0-9_-]{0,31})", people.GroupHandler),
 306                         (r"/register", auth.RegisterHandler),
 307                         (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),
 308                         (r"/users/([a-z_][a-z0-9_-]{0,31})/calls(?:/(\d{4}-\d{2}-\d{2}))?", people.CallsHandler),
 309                         (r"/users/([a-z_][a-z0-9_-]{0,31})/edit", people.UserEditHandler),
 310                         (r"/users/([a-z_][a-z0-9_-]{0,31})/passwd", people.UserPasswdHandler),
 311                         (r"/users/([a-z_][a-z0-9_-]{0,31})/sip", people.SIPHandler),
 312
 313                         # Promotional Consent Stuff
 314                         (r"/subscribe", people.SubscribeHandler),
 315                         (r"/unsubscribe", people.UnsubscribeHandler),
 316
 317                         # Single-Sign-On for Discourse
 318                         (r"/sso/discourse", people.SSODiscourse),
 319
 320                         # Password Reset
 321                         (r"/password\-reset", auth.PasswordResetInitiationHandler),
 322                         (r"/password\-reset/([a-z_][a-z0-9_-]{0,31})/(\w+)", auth.PasswordResetHandler),
 323
 324                         # Serve any static files
 325                         (r"/static/(.*)", tornado.web.StaticFileHandler, { "path" : self.settings.get("static_path") }),
 326
 327                         # API
 328                         (r"/api/check/email", auth.APICheckEmail),
 329                         (r"/api/check/uid", auth.APICheckUID),
 330                 ]  + authentication_handlers)
 331
 332                 # wiki.ipfire.org
 333                 self.add_handlers(r"wiki\.([a-z]+\.dev\.)?ipfire\.org",
 334                         authentication_handlers + [
 335
 336                         # Actions
 337                         (r"((?:[A-Za-z0-9\-_\/]+)?(?:.*)\.(?:\w+))/_delete", wiki.ActionDeleteHandler),
 338                         (r"([A-Za-z0-9\-_\/]+)?/_edit", wiki.ActionEditHandler),
 339                         (r"([A-Za-z0-9\-_\/]+)?/_render", wiki.ActionRenderHandler),
 340                         (r"([A-Za-z0-9\-_\/]+)?/_(watch|unwatch)", wiki.ActionWatchHandler),
 341                         (r"/actions/restore", wiki.ActionRestoreHandler),
 342                         (r"/actions/upload", wiki.ActionUploadHandler),
 343
 344                         # Handlers
 345                         (r"/recent\-changes", wiki.RecentChangesHandler),
 346                         (r"/search", wiki.SearchHandler),
 347                         (r"/tree", wiki.TreeHandler),
 348                         (r"/watchlist", wiki.WatchlistHandler),
 349
 350                         # Media
 351                         (r"([A-Za-z0-9\-_\/]+)?/_files", wiki.FilesHandler),
 352                         (r"((?!/static)(?:[A-Za-z0-9\-_\/]+)?(?:.*)\.(?:\w+))$", wiki.FileHandler),
 353
 354                         # Serve any static files
 355                         (r"/static/(.*)", tornado.web.StaticFileHandler, { "path" : self.settings.get("static_path") }),
 356
 357                         # Render pages
 358                         (r"([A-Za-z0-9\-_\/]+)?", wiki.PageHandler),
 359                 ])
 360
 361                 # ipfire.org
 362                 self.add_handlers(r"(.*)ipfire\.org", [
 363                         (r".*", tornado.web.RedirectHandler, { "url" : "https://www.ipfire.org" })
 364                 ])
 365
 366                 logging.info("Successfully initialied application")
 367
 368         def format_country_name(self, handler, country_code):
 369                 return self.backend.get_country_name(country_code)
 370
 371         def format_language_name(self, handler, language):
 372                 _ = handler.locale.translate
 373
 374                 if language == "de":
 375                         return _("German")
 376                 elif language == "en":
 377                         return _("English")
 378                 elif language == "es":
 379                         return _("Spanish")
 380                 elif language == "fr":
 381                         return _("French")
 382                 elif language == "it":
 383                         return _("Italian")
 384                 elif language == "nl":
 385                         return _("Dutch")
 386                 elif language == "pl":
 387                         return _("Polish")
 388                 elif language == "pt":
 389                         return _("Portuguese")
 390                 elif language == "ru":
 391                         return _("Russian")
 392                 elif language == "tr":
 393                         return _("Turkish")
 394
 395                 return language
 396
 397         def format_month_name(self, handler, month):
 398                 _ = handler.locale.translate
 399
 400                 if month == 1:
 401                         return _("January")
 402                 elif month == 2:
 403                         return _("February")
 404                 elif month == 3:
 405                         return _("March")
 406                 elif month == 4:
 407                         return _("April")
 408                 elif month == 5:
 409                         return _("May")
 410                 elif month == 6:
 411                         return _("June")
 412                 elif month == 7:
 413                         return _("July")
 414                 elif month == 8:
 415                         return _("August")
 416                 elif month == 9:
 417                         return _("September")
 418                 elif month == 10:
 419                         return _("October")
 420                 elif month == 11:
 421                         return _("November")
 422                 elif month == 12:
 423                         return _("December")
 424
 425                 return month
 426
 427         def format_phone_number(self, handler, number):
 428                 if not isinstance(number, phonenumbers.PhoneNumber):
 429                         try:
 430                                 number = phonenumbers.parse(number, None)
 431                         except phonenumbers.phonenumberutil.NumberParseException:
 432                                 return number
 433
 434                 return phonenumbers.format_number(number, phonenumbers.PhoneNumberFormat.INTERNATIONAL)
 435
 436         def format_phone_number_to_e164(self, handler, number):
 437                 return phonenumbers.format_number(number, phonenumbers.PhoneNumberFormat.E164)
 438
 439         def format_phone_number_location(self, handler, number):
 440                 s = [
 441                         phonenumbers.geocoder.description_for_number(number, handler.locale.code),
 442                         phonenumbers.region_code_for_number(number),
 443                 ]
 444
 445                 return ", ".join((e for e in s if e))