src/web/__init__.py

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