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