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
  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 newsletter
  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                                 "CDR"                  : people.CDRModule,
  78                                 "Channels"             : people.ChannelsModule,
  79                                 "MOS"                  : people.MOSModule,
  80                                 "NewAccounts"          : people.NewAccountsModule,
  81                                 "Password"             : people.PasswordModule,
  82                                 "Registrations"        : people.RegistrationsModule,
  83                                 "SIPStatus"            : people.SIPStatusModule,
  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                                 "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\.org", [
 116                         # Entry site that lead the user to index
 117                         (r"/", IndexHandler),
 118
 119                         # Download sites
 120                         (r"/downloads", tornado.web.RedirectHandler, { "url" : "/download" }),
 121                         (r"/download", download.IndexHandler),
 122                         (r"/download/([0-9a-z\-\.]+)", download.ReleaseHandler),
 123
 124                         # Donate
 125                         (r"/donate", donate.DonateHandler),
 126                         (r"/donate/thank-you", donate.ThankYouHandler),
 127                         (r"/donate/error", donate.ErrorHandler),
 128                         (r"/donation", tornado.web.RedirectHandler, { "url" : "/donate" }),
 129
 130                         # Newsletter
 131                         (r"/newsletter/subscribe", newsletter.SubscribeHandler),
 132
 133                         # RSS feed
 134                         (r"/news.rss", tornado.web.RedirectHandler, { "url" : "https://blog.ipfire.org/feed.xml" }),
 135
 136                         # Redirect news articles to blog
 137                         (r"/news/(.*)", handlers.NewsHandler),
 138
 139                         # Static Pages
 140                         (r"/chat", StaticHandler, { "template" : "chat.html" }),
 141                         (r"/features", StaticHandler, { "template" : "features.html" }),
 142                         (r"/legal", StaticHandler, { "template" : "legal.html" }),
 143                         (r"/support", StaticHandler, { "template" : "support.html" }),
 144
 145                         # Handle old pages that have moved elsewhere
 146                         (r"/imprint", tornado.web.RedirectHandler, { "url" : "/legal" }),
 147                         (r"/(de|en)/(.*)", LangCompatHandler),
 148
 149                         # Export arbitrary error pages
 150                         (r"/error/([45][0-9]{2})", base.ErrorHandler),
 151
 152                         # Block page
 153                         (r"/blocked", base.BlockedHandler),
 154                 ])
 155
 156                 # blog.ipfire.org
 157                 self.add_handlers(r"blog(\.dev)?\.ipfire\.org", [
 158                         (r"/", blog.IndexHandler),
 159                         (r"/authors/(\w+)", blog.AuthorHandler),
 160                         (r"/compose", blog.ComposeHandler),
 161                         (r"/drafts", blog.DraftsHandler),
 162                         (r"/post/([0-9a-z\-\._]+)", blog.PostHandler),
 163                         (r"/post/([0-9a-z\-\._]+)/delete", blog.DeleteHandler),
 164                         (r"/post/([0-9a-z\-\._]+)/edit", blog.EditHandler),
 165                         (r"/post/([0-9a-z\-\._]+)/publish", blog.PublishHandler),
 166                         (r"/search", blog.SearchHandler),
 167                         (r"/tags/([0-9a-z\-\.]+)", blog.TagHandler),
 168                         (r"/years/([0-9]+)", blog.YearHandler),
 169
 170                         # RSS Feed
 171                         (r"/feed.xml", blog.FeedHandler),
 172                 ] + authentication_handlers)
 173
 174                 # downloads.ipfire.org
 175                 self.add_handlers(r"downloads?(\.dev)?\.ipfire\.org", [
 176                         (r"/", tornado.web.RedirectHandler, { "url" : "https://www.ipfire.org/" }),
 177                         (r"/release/(.*)", download.ReleaseRedirectHandler),
 178                         (r"/(.*)", download.FileHandler),
 179                 ])
 180
 181                 # mirrors.ipfire.org
 182                 self.add_handlers(r"mirrors(\.dev)?\.ipfire\.org", [
 183                         (r"/", mirrors.IndexHandler),
 184                         (r"/mirrors/(.*)", mirrors.MirrorHandler),
 185                 ])
 186
 187                 # planet.ipfire.org
 188                 self.add_handlers(r"planet(\.dev)?\.ipfire\.org", [
 189                         (r"/", tornado.web.RedirectHandler, { "url" : "https://blog.ipfire.org/" }),
 190                         (r"/post/([A-Za-z0-9_-]+)", handlers.PlanetPostHandler),
 191                         (r"/user/([a-z0-9_-]+)", handlers.PlanetUserHandler),
 192
 193                         # RSS
 194                         (r"/rss", tornado.web.RedirectHandler, { "url" : "https://blog.ipfire.org/feed.xml" }),
 195                         (r"/user/([a-z0-9_-]+)/rss", tornado.web.RedirectHandler, { "url" : "https://blog.ipfire.org/feed.xml" }),
 196                         (r"/news.rss", tornado.web.RedirectHandler, { "url" : "https://blog.ipfire.org/feed.xml" }),
 197                 ])
 198
 199                 # fireinfo.ipfire.org
 200                 self.add_handlers(r"fireinfo(\.dev)?\.ipfire\.org", [
 201                         (r"/", fireinfo.IndexHandler),
 202
 203                         # Vendors
 204                         (r"/vendors", fireinfo.VendorsHandler),
 205                         (r"/vendors/(pci|usb)/([0-9a-f]{4})", fireinfo.VendorHandler),
 206
 207                         # Driver
 208                         (r"/drivers/(.*)", fireinfo.DriverDetail),
 209
 210                         # Show profiles
 211                         (r"/profile/random", fireinfo.RandomProfileHandler),
 212                         (r"/profile/([a-z0-9]{40})", fireinfo.ProfileHandler),
 213
 214                         # Stats
 215                         (r"/processors", fireinfo.ProcessorsHandler),
 216                         (r"/releases", fireinfo.ReleasesHandler),
 217
 218                         # Send profiles
 219                         (r"/send/([a-z0-9]+)", fireinfo.ProfileSendHandler),
 220                 ])
 221
 222                 # i-use.ipfire.org
 223                 self.add_handlers(r"i-use(\.dev)?\.ipfire\.org", [
 224                         (r"/", tornado.web.RedirectHandler, { "url" : "https://www.ipfire.org/" }),
 225                         (r"/profile/([a-f0-9]{40})/([0-9]+).png", iuse.ImageHandler),
 226                 ])
 227
 228                 # boot.ipfire.org
 229                 BOOT_STATIC_PATH = os.path.join(self.settings["static_path"], "netboot")
 230                 self.add_handlers(r"boot(\.dev)?\.ipfire\.org", [
 231                         (r"/", tornado.web.RedirectHandler, { "url" : "https://wiki.ipfire.org/installation/pxe" }),
 232
 233                         # Configurations
 234                         (r"/premenu.cfg", boot.PremenuCfgHandler),
 235                         (r"/menu.gpxe", boot.MenuGPXEHandler),
 236                         (r"/menu.cfg", boot.MenuCfgHandler),
 237
 238                         # Static files
 239                         (r"/(boot\.png|pxelinux\.0|menu\.c32|vesamenu\.c32)",
 240                                 tornado.web.StaticFileHandler, { "path" : BOOT_STATIC_PATH }),
 241                 ])
 242
 243                 # nopaste.ipfire.org
 244                 self.add_handlers(r"nopaste(\.dev)?\.ipfire\.org", [
 245                         (r"/", nopaste.CreateHandler),
 246                         (r"/raw/(.*)", nopaste.RawHandler),
 247                         (r"/view/(.*)", nopaste.ViewHandler),
 248                 ] + authentication_handlers)
 249
 250                 # location.ipfire.org
 251                 self.add_handlers(r"location(\.dev)?\.ipfire\.org", [
 252                         (r"/", location.IndexHandler),
 253                         (r"/how\-to\-use", StaticHandler, { "template" : "../location/how-to-use.html" }),
 254                         (r"/lookup/(.+)/blacklists", location.BlacklistsHandler),
 255                         (r"/lookup/(.+)", location.LookupHandler),
 256                 ])
 257
 258                 # geoip.ipfire.org
 259                 self.add_handlers(r"geoip(\.dev)?\.ipfire\.org", [
 260                         (r"/", tornado.web.RedirectHandler, { "url" : "https://location.ipfire.org/" }),
 261                 ])
 262
 263                 # talk.ipfire.org
 264                 self.add_handlers(r"talk(\.dev)?\.ipfire\.org", [
 265                         (r"/", tornado.web.RedirectHandler, { "url" : "https://people.ipfire.org/" }),
 266                 ])
 267
 268                 # people.ipfire.org
 269                 self.add_handlers(r"people(\.dev)?\.ipfire\.org", [
 270                         (r"/", people.IndexHandler),
 271                         (r"/activate/(\w+)/(\w+)", auth.ActivateHandler),
 272                         (r"/conferences", people.ConferencesHandler),
 273                         (r"/register", auth.RegisterHandler),
 274                         (r"/search", people.SearchHandler),
 275                         (r"/users", people.UsersHandler),
 276                         (r"/users/(\w+)", people.UserHandler),
 277                         (r"/users/(\w+)\.jpg", people.AvatarHandler),
 278                         (r"/users/(\w+)/calls/([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})", people.CallHandler),
 279                         (r"/users/(\w+)/calls(?:/(\d{4}-\d{2}-\d{2}))?", people.CallsHandler),
 280                         (r"/users/(\w+)/edit", people.UserEditHandler),
 281                         (r"/users/(\w+)/passwd", people.UserPasswdHandler),
 282                         (r"/users/(\w+)/ssh-keys", people.SSHKeysIndexHandler),
 283                         (r"/users/(\w+)/ssh-keys/(SHA256\:.*)/delete", people.SSHKeysDeleteHandler),
 284                         (r"/users/(\w+)/ssh-keys/(SHA256\:.*)", people.SSHKeysDownloadHandler),
 285                         (r"/users/(\w+)/ssh-keys/upload", people.SSHKeysUploadHandler),
 286                         (r"/users/(\w+)/sip", people.SIPHandler),
 287
 288                         # Single-Sign-On for Discourse
 289                         (r"/sso/discourse", people.SSODiscourse),
 290                 ]  + authentication_handlers)
 291
 292                 # wiki.ipfire.org
 293                 self.add_handlers(r"wiki(\.dev)?\.ipfire\.org",
 294                         authentication_handlers + [
 295
 296                         # Actions
 297                         (r"((?:[A-Za-z0-9\-_\/]+)?(?:.*)\.(?:\w+))/_delete", wiki.ActionDeleteHandler),
 298                         (r"([A-Za-z0-9\-_\/]+)?/_edit", wiki.ActionEditHandler),
 299                         (r"([A-Za-z0-9\-_\/]+)?/_render", wiki.ActionRenderHandler),
 300                         (r"([A-Za-z0-9\-_\/]+)?/_(watch|unwatch)", wiki.ActionWatchHandler),
 301                         (r"/actions/restore", wiki.ActionRestoreHandler),
 302                         (r"/actions/upload", wiki.ActionUploadHandler),
 303
 304                         # Handlers
 305                         (r"/recent\-changes", wiki.RecentChangesHandler),
 306                         (r"/search", wiki.SearchHandler),
 307                         (r"/watchlist", wiki.WatchlistHandler),
 308
 309                         # Media
 310                         (r"([A-Za-z0-9\-_\/]+)?/_files", wiki.FilesHandler),
 311                         (r"((?!/static)(?:[A-Za-z0-9\-_\/]+)?(?:.*)\.(?:\w+))$", wiki.FileHandler),
 312
 313                         # Render pages
 314                         (r"([A-Za-z0-9\-_\/]+)?", wiki.PageHandler),
 315                 ])
 316
 317                 # ipfire.org
 318                 self.add_handlers(r"ipfire\.org", [
 319                         (r".*", tornado.web.RedirectHandler, { "url" : "https://www.ipfire.org" })
 320                 ])
 321
 322                 logging.info("Successfully initialied application")
 323
 324         def format_country_name(self, handler, country_code):
 325                 return ipfire.countries.get_name(country_code)
 326
 327         def format_language_name(self, handler, language):
 328                 _ = handler.locale.translate
 329
 330                 if language == "de":
 331                         return _("German")
 332                 elif language == "en":
 333                         return _("English")
 334                 elif language == "es":
 335                         return _("Spanish")
 336                 elif language == "fr":
 337                         return _("French")
 338                 elif language == "it":
 339                         return _("Italian")
 340                 elif language == "nl":
 341                         return _("Dutch")
 342                 elif language == "pl":
 343                         return _("Polish")
 344                 elif language == "pt":
 345                         return _("Portuguese")
 346                 elif language == "ru":
 347                         return _("Russian")
 348                 elif language == "tr":
 349                         return _("Turkish")
 350
 351                 return language
 352
 353         def format_month_name(self, handler, month):
 354                 _ = handler.locale.translate
 355
 356                 if month == 1:
 357                         return _("January")
 358                 elif month == 2:
 359                         return _("February")
 360                 elif month == 3:
 361                         return _("March")
 362                 elif month == 4:
 363                         return _("April")
 364                 elif month == 5:
 365                         return _("May")
 366                 elif month == 6:
 367                         return _("June")
 368                 elif month == 7:
 369                         return _("July")
 370                 elif month == 8:
 371                         return _("August")
 372                 elif month == 9:
 373                         return _("September")
 374                 elif month == 10:
 375                         return _("October")
 376                 elif month == 11:
 377                         return _("November")
 378                 elif month == 12:
 379                         return _("December")
 380
 381                 return month
 382
 383         def format_phone_number(self, handler, number):
 384                 if not isinstance(number, phonenumbers.PhoneNumber):
 385                         try:
 386                                 number = phonenumbers.parse(number, None)
 387                         except phonenumbers.phonenumberutil.NumberParseException:
 388                                 return number
 389
 390                 return phonenumbers.format_number(number, phonenumbers.PhoneNumberFormat.INTERNATIONAL)
 391
 392         def format_phone_number_to_e164(self, handler, number):
 393                 return phonenumbers.format_number(number, phonenumbers.PhoneNumberFormat.E164)
 394
 395         def format_phone_number_location(self, handler, number):
 396                 s = [
 397                         phonenumbers.geocoder.description_for_number(number, handler.locale.code),
 398                         phonenumbers.region_code_for_number(number),
 399                 ]
 400
 401                 return ", ".join((e for e in s if e))
 402
 403
 404 def grouper(handler, iterator, n):
 405         """
 406                 Returns groups of n from the iterator
 407         """
 408         i = iter(iterator)
 409
 410         while True:
 411                 ret = list(itertools.islice(i, 0, n))
 412                 if not ret:
 413                         break
 414
 415                 yield ret