src/web/__init__.py

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