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