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_asn"                   : self.format_asn,
  54                                 "format_country_name"          : self.format_country_name,
  55                                 "format_language_name"         : self.format_language_name,
  56                                 "format_month_name"            : self.format_month_name,
  57                                 "format_phone_number"          : self.format_phone_number,
  58                                 "format_phone_number_to_e164"  : self.format_phone_number_to_e164,
  59                                 "format_phone_number_location" : self.format_phone_number_location,
  60                                 "grouper"                      : grouper,
  61                         },
  62
  63                         # UI Modules
  64                         "ui_modules" : {
  65                                 # Blog
  66                                 "BlogHistoryNavigation": blog.HistoryNavigationModule,
  67                                 "BlogList"             : blog.ListModule,
  68                                 "BlogPost"             : blog.PostModule,
  69                                 "BlogPosts"            : blog.PostsModule,
  70
  71                                 # Boot
  72                                 "BootMenuConfig"       : boot.MenuConfigModule,
  73                                 "BootMenuHeader"       : boot.MenuHeaderModule,
  74                                 "BootMenuSeparator"    : boot.MenuSeparatorModule,
  75
  76                                 # People
  77                                 "AccountsList"         : people.AccountsListModule,
  78                                 "Agent"                : people.AgentModule,
  79                                 "CDR"                  : people.CDRModule,
  80                                 "Channels"             : people.ChannelsModule,
  81                                 "MOS"                  : people.MOSModule,
  82                                 "NewAccounts"          : people.NewAccountsModule,
  83                                 "Password"             : people.PasswordModule,
  84                                 "Registrations"        : people.RegistrationsModule,
  85                                 "SIPStatus"            : people.SIPStatusModule,
  86
  87                                 # Nopaste
  88                                 "Code"                 : nopaste.CodeModule,
  89
  90                                 # Fireinfo
  91                                 "FireinfoDeviceTable"  : fireinfo.DeviceTableModule,
  92                                 "FireinfoDeviceAndGroupsTable"
  93                                                        : fireinfo.DeviceAndGroupsTableModule,
  94
  95                                 # Wiki
  96                                 "WikiDiff"             : wiki.WikiDiffModule,
  97                                 "WikiNavbar"           : wiki.WikiNavbarModule,
  98                                 "WikiList"             : wiki.WikiListModule,
  99
 100                                 # Misc
 101                                 "ChristmasBanner"      : ui_modules.ChristmasBannerModule,
 102                                 "Markdown"             : ui_modules.MarkdownModule,
 103                                 "Map"                  : ui_modules.MapModule,
 104                                 "ProgressBar"          : ui_modules.ProgressBarModule,
 105                         },
 106
 107                         # Call this when a page wasn't found
 108                         "default_handler_class" : base.NotFoundHandler,
 109                 }
 110                 settings.update(kwargs)
 111
 112                 tornado.web.Application.__init__(self, **settings)
 113
 114                 authentication_handlers = [
 115                         (r"/login", auth.LoginHandler),
 116                         (r"/logout", auth.LogoutHandler),
 117                 ]
 118
 119                 self.add_handlers(r"(dev|www)\.ipfire\.org", [
 120                         # Entry site that lead the user to index
 121                         (r"/", IndexHandler),
 122
 123                         # Download sites
 124                         (r"/downloads", tornado.web.RedirectHandler, { "url" : "/download" }),
 125                         (r"/download", download.IndexHandler),
 126                         (r"/download/([0-9a-z\-\.]+)", download.ReleaseHandler),
 127
 128                         # Donate
 129                         (r"/donate", donate.DonateHandler),
 130                         (r"/donate/thank-you", donate.ThankYouHandler),
 131                         (r"/donate/error", donate.ErrorHandler),
 132                         (r"/donation", tornado.web.RedirectHandler, { "url" : "/donate" }),
 133
 134                         # RSS feed
 135                         (r"/news.rss", tornado.web.RedirectHandler, { "url" : "https://blog.ipfire.org/feed.xml" }),
 136
 137                         # Redirect news articles to blog
 138                         (r"/news/(.*)", handlers.NewsHandler),
 139
 140                         # Static Pages
 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
 153                 # blog.ipfire.org
 154                 self.add_handlers(r"blog\.ipfire\.org", [
 155                         (r"/", blog.IndexHandler),
 156                         (r"/authors/(\w+)", blog.AuthorHandler),
 157                         (r"/compose", blog.ComposeHandler),
 158                         (r"/drafts", blog.DraftsHandler),
 159                         (r"/post/([0-9a-z\-\._]+)", blog.PostHandler),
 160                         (r"/post/([0-9a-z\-\._]+)/delete", blog.DeleteHandler),
 161                         (r"/post/([0-9a-z\-\._]+)/edit", blog.EditHandler),
 162                         (r"/post/([0-9a-z\-\._]+)/publish", blog.PublishHandler),
 163                         (r"/search", blog.SearchHandler),
 164                         (r"/tags/([0-9a-z\-\.]+)", blog.TagHandler),
 165                         (r"/years/([0-9]+)", blog.YearHandler),
 166
 167                         # RSS Feed
 168                         (r"/feed.xml", blog.FeedHandler),
 169                 ] + authentication_handlers)
 170
 171                 # downloads.ipfire.org
 172                 self.add_handlers(r"downloads?\.ipfire\.org", [
 173                         (r"/", tornado.web.RedirectHandler, { "url" : "https://www.ipfire.org/" }),
 174                         (r"/release/(.*)", download.ReleaseRedirectHandler),
 175                         (r"/(.*)", download.FileHandler),
 176                 ])
 177
 178                 # mirrors.ipfire.org
 179                 self.add_handlers(r"^mirrors\.ipfire\.org", [
 180                         (r"/", mirrors.IndexHandler),
 181                         (r"/mirrors/(.*)", mirrors.MirrorHandler),
 182                 ])
 183
 184                 # planet.ipfire.org
 185                 self.add_handlers(r"planet\.ipfire\.org", [
 186                         (r"/", tornado.web.RedirectHandler, { "url" : "https://blog.ipfire.org/" }),
 187                         (r"/post/([A-Za-z0-9_-]+)", handlers.PlanetPostHandler),
 188                         (r"/user/([a-z0-9_-]+)", handlers.PlanetUserHandler),
 189
 190                         # RSS
 191                         (r"/rss", tornado.web.RedirectHandler, { "url" : "https://blog.ipfire.org/feed.xml" }),
 192                         (r"/user/([a-z0-9_-]+)/rss", tornado.web.RedirectHandler, { "url" : "https://blog.ipfire.org/feed.xml" }),
 193                         (r"/news.rss", tornado.web.RedirectHandler, { "url" : "https://blog.ipfire.org/feed.xml" }),
 194                 ])
 195
 196                 # fireinfo.ipfire.org
 197                 self.add_handlers(r"fireinfo\.ipfire\.org", [
 198                         (r"/", fireinfo.IndexHandler),
 199
 200                         # Admin
 201                         (r"/admin", fireinfo.AdminIndexHandler),
 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                 ] + authentication_handlers)
 221
 222                 # i-use.ipfire.org
 223                 self.add_handlers(r"i-use\.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\.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\.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\.ipfire\.org", [
 260                         (r"/", tornado.web.RedirectHandler, { "url" : "https://location.ipfire.org/" }),
 261                 ])
 262
 263                 # talk.ipfire.org
 264                 self.add_handlers(r"talk\.ipfire\.org", [
 265                         (r"/", tornado.web.RedirectHandler, { "url" : "https://people.ipfire.org/" }),
 266                 ])
 267
 268                 # people.ipfire.org
 269                 self.add_handlers(r"people\.ipfire\.org", [
 270                         (r"/", people.IndexHandler),
 271                         (r"/activate/([a-z_][a-z0-9_-]{0,31})/(\w+)", auth.ActivateHandler),
 272                         (r"/conferences", people.ConferencesHandler),
 273                         (r"/groups", people.GroupsHandler),
 274                         (r"/groups/([a-z_][a-z0-9_-]{0,31})", people.GroupHandler),
 275                         (r"/register", auth.RegisterHandler),
 276                         (r"/search", people.SearchHandler),
 277                         (r"/users", people.UsersHandler),
 278                         (r"/users/([a-z_][a-z0-9_-]{0,31})", people.UserHandler),
 279                         (r"/users/([a-z_][a-z0-9_-]{0,31})\.jpg", people.AvatarHandler),
 280                         (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),
 281                         (r"/users/([a-z_][a-z0-9_-]{0,31})/calls(?:/(\d{4}-\d{2}-\d{2}))?", people.CallsHandler),
 282                         (r"/users/([a-z_][a-z0-9_-]{0,31})/edit", people.UserEditHandler),
 283                         (r"/users/([a-z_][a-z0-9_-]{0,31})/passwd", people.UserPasswdHandler),
 284                         (r"/users/([a-z_][a-z0-9_-]{0,31})/sip", people.SIPHandler),
 285
 286                         # Promotional Consent Stuff
 287                         (r"/subscribe", people.SubscribeHandler),
 288                         (r"/unsubscribe", people.UnsubscribeHandler),
 289
 290                         # Single-Sign-On for Discourse
 291                         (r"/sso/discourse", people.SSODiscourse),
 292
 293                         # Password Reset
 294                         (r"/password\-reset", auth.PasswordResetInitiationHandler),
 295                         (r"/password\-reset/([a-z_][a-z0-9_-]{0,31})/(\w+)", auth.PasswordResetHandler),
 296
 297                         # Stats
 298                         (r"/stats", people.StatsHandler),
 299
 300                         # API
 301                         (r"/api/check/email", auth.APICheckEmail),
 302                         (r"/api/check/uid", auth.APICheckUID),
 303                 ]  + authentication_handlers)
 304
 305                 # wiki.ipfire.org
 306                 self.add_handlers(r"wiki\.ipfire\.org",
 307                         authentication_handlers + [
 308
 309                         # Actions
 310                         (r"((?:[A-Za-z0-9\-_\/]+)?(?:.*)\.(?:\w+))/_delete", wiki.ActionDeleteHandler),
 311                         (r"([A-Za-z0-9\-_\/]+)?/_edit", wiki.ActionEditHandler),
 312                         (r"([A-Za-z0-9\-_\/]+)?/_render", wiki.ActionRenderHandler),
 313                         (r"([A-Za-z0-9\-_\/]+)?/_(watch|unwatch)", wiki.ActionWatchHandler),
 314                         (r"/actions/restore", wiki.ActionRestoreHandler),
 315                         (r"/actions/upload", wiki.ActionUploadHandler),
 316
 317                         # Handlers
 318                         (r"/recent\-changes", wiki.RecentChangesHandler),
 319                         (r"/search", wiki.SearchHandler),
 320                         (r"/tree", wiki.TreeHandler),
 321                         (r"/watchlist", wiki.WatchlistHandler),
 322
 323                         # Media
 324                         (r"([A-Za-z0-9\-_\/]+)?/_files", wiki.FilesHandler),
 325                         (r"((?!/static)(?:[A-Za-z0-9\-_\/]+)?(?:.*)\.(?:\w+))$", wiki.FileHandler),
 326
 327                         # Render pages
 328                         (r"([A-Za-z0-9\-_\/]+)?", wiki.PageHandler),
 329                 ])
 330
 331                 # ipfire.org
 332                 self.add_handlers(r"ipfire\.org", [
 333                         (r".*", tornado.web.RedirectHandler, { "url" : "https://www.ipfire.org" })
 334                 ])
 335
 336                 logging.info("Successfully initialied application")
 337
 338         def format_asn(self, handler, asn):
 339                 return util.format_asn(asn)
 340
 341         def format_country_name(self, handler, country_code):
 342                 return ipfire.countries.get_name(country_code)
 343
 344         def format_language_name(self, handler, language):
 345                 _ = handler.locale.translate
 346
 347                 if language == "de":
 348                         return _("German")
 349                 elif language == "en":
 350                         return _("English")
 351                 elif language == "es":
 352                         return _("Spanish")
 353                 elif language == "fr":
 354                         return _("French")
 355                 elif language == "it":
 356                         return _("Italian")
 357                 elif language == "nl":
 358                         return _("Dutch")
 359                 elif language == "pl":
 360                         return _("Polish")
 361                 elif language == "pt":
 362                         return _("Portuguese")
 363                 elif language == "ru":
 364                         return _("Russian")
 365                 elif language == "tr":
 366                         return _("Turkish")
 367
 368                 return language
 369
 370         def format_month_name(self, handler, month):
 371                 _ = handler.locale.translate
 372
 373                 if month == 1:
 374                         return _("January")
 375                 elif month == 2:
 376                         return _("February")
 377                 elif month == 3:
 378                         return _("March")
 379                 elif month == 4:
 380                         return _("April")
 381                 elif month == 5:
 382                         return _("May")
 383                 elif month == 6:
 384                         return _("June")
 385                 elif month == 7:
 386                         return _("July")
 387                 elif month == 8:
 388                         return _("August")
 389                 elif month == 9:
 390                         return _("September")
 391                 elif month == 10:
 392                         return _("October")
 393                 elif month == 11:
 394                         return _("November")
 395                 elif month == 12:
 396                         return _("December")
 397
 398                 return month
 399
 400         def format_phone_number(self, handler, number):
 401                 if not isinstance(number, phonenumbers.PhoneNumber):
 402                         try:
 403                                 number = phonenumbers.parse(number, None)
 404                         except phonenumbers.phonenumberutil.NumberParseException:
 405                                 return number
 406
 407                 return phonenumbers.format_number(number, phonenumbers.PhoneNumberFormat.INTERNATIONAL)
 408
 409         def format_phone_number_to_e164(self, handler, number):
 410                 return phonenumbers.format_number(number, phonenumbers.PhoneNumberFormat.E164)
 411
 412         def format_phone_number_location(self, handler, number):
 413                 s = [
 414                         phonenumbers.geocoder.description_for_number(number, handler.locale.code),
 415                         phonenumbers.region_code_for_number(number),
 416                 ]
 417
 418                 return ", ".join((e for e in s if e))
 419
 420
 421 def grouper(handler, iterator, n):
 422         """
 423                 Returns groups of n from the iterator
 424         """
 425         i = iter(iterator)
 426
 427         while True:
 428                 ret = list(itertools.islice(i, 0, n))
 429                 if not ret:
 430                         break
 431
 432                 yield ret