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