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
  14 from .handlers import *
  15
  16 from . import auth
  17 from . import blog
  18 from . import download
  19 from . import location
  20 from . import newsletter
  21 from . import people
  22 from . import ui_modules
  23
  24 class Application(tornado.web.Application):
  25         def __init__(self, config, **kwargs):
  26                 # Initialize backend
  27                 self.backend = ipfire.Backend(config)
  28
  29                 settings = {
  30                         # Do not compress responses
  31                         "gzip" : False,
  32
  33                         # Enable XSRF cookies
  34                         "xsrf_cookies" : True,
  35
  36                         # Login
  37                         "login_url" : "/login",
  38
  39                         # Setup directory structure
  40                         "static_path"   : self.backend.config.get("global", "static_dir"),
  41                         "template_path" : self.backend.config.get("global", "templates_dir"),
  42
  43                         # UI Modules
  44                         "ui_methods" : {
  45                                 "format_month_name"            : self.format_month_name,
  46                                 "format_phone_number"          : self.format_phone_number,
  47                                 "format_phone_number_to_e164"  : self.format_phone_number_to_e164,
  48                                 "format_phone_number_location" : self.format_phone_number_location,
  49                                 "grouper"                      : grouper,
  50                         },
  51                         "ui_modules" : {
  52                                 # Blog
  53                                 "BlogHistoryNavigation": blog.HistoryNavigationModule,
  54                                 "BlogList"             : blog.ListModule,
  55                                 "BlogPost"             : blog.PostModule,
  56                                 "BlogPosts"            : blog.PostsModule,
  57
  58                                 # Location
  59                                 "Map"                  : ui_modules.MapModule,
  60
  61                                 # Talk
  62                                 "AccountsList"         : people.AccountsListModule,
  63                                 "CDR"                  : people.CDRModule,
  64                                 "Channels"             : people.ChannelsModule,
  65                                 "MOS"                  : people.MOSModule,
  66                                 "Registrations"        : people.RegistrationsModule,
  67                                 "SIPStatus"            : people.SIPStatusModule,
  68
  69                                 # Old modules
  70                                 "LanguageName"         : ui_modules.LanguageNameModule,
  71
  72                                 "MirrorItem"           : ui_modules.MirrorItemModule,
  73                                 "MirrorsTable"         : ui_modules.MirrorsTableModule,
  74                                 "NetBootMenuConfig"    : ui_modules.NetBootMenuConfigModule,
  75                                 "NetBootMenuHeader"    : ui_modules.NetBootMenuHeaderModule,
  76                                 "NetBootMenuSeparator" : ui_modules.NetBootMenuSeparatorModule,
  77                                 "ProgressBar"          : ui_modules.ProgressBarModule,
  78                                 "FireinfoDeviceTable"  : ui_modules.FireinfoDeviceTableModule,
  79                                 "FireinfoDeviceAndGroupsTable" : ui_modules.FireinfoDeviceAndGroupsTableModule,
  80                                 "FireinfoGeoTable"        : ui_modules.FireinfoGeoTableModule,
  81                         },
  82
  83                         # Call this when a page wasn't found
  84                         "default_handler_class" : NotFoundHandler,
  85                 }
  86                 settings.update(kwargs)
  87
  88                 tornado.web.Application.__init__(self, **settings)
  89
  90                 authentication_handlers = [
  91                         (r"/login", auth.LoginHandler),
  92                         (r"/logout", auth.LogoutHandler),
  93                 ]
  94
  95                 self.add_handlers(r"(dev|www)\.ipfire\.(at|org)", [
  96                         # Entry site that lead the user to index
  97                         (r"/", IndexHandler),
  98
  99                         # Download sites
 100                         (r"/downloads", tornado.web.RedirectHandler, { "url" : "/download" }),
 101                         (r"/download", download.IndexHandler),
 102                         (r"/download/([0-9a-z\-\.]+)", download.ReleaseHandler),
 103
 104                         # Donate
 105                         (r"/donate", DonateHandler),
 106                         (r"/donation", tornado.web.RedirectHandler, { "url" : "/donate" }),
 107
 108                         # Newsletter
 109                         (r"/newsletter/subscribe", newsletter.SubscribeHandler),
 110
 111                         # RSS feed
 112                         (r"/news.rss", tornado.web.RedirectHandler, { "url" : "https://blog.ipfire.org/feed.xml" }),
 113
 114                         # Redirect news articles to blog
 115                         (r"/news/(.*)", tornado.web.RedirectHandler, { "url" : "https://blog.ipfire.org/posts/{1}" }),
 116
 117                         # Static Pages
 118                         (r"/chat", StaticHandler, { "template" : "chat.html" }),
 119                         (r"/features", StaticHandler, { "template" : "features.html" }),
 120                         (r"/legal", StaticHandler, { "template" : "legal.html" }),
 121                         (r"/support", StaticHandler, { "template" : "support.html" }),
 122
 123                         # Handle old pages that have moved elsewhere
 124                         (r"/imprint", tornado.web.RedirectHandler, { "url" : "/legal" }),
 125                         (r"/(de|en)/(.*)", LangCompatHandler),
 126
 127                         # Export arbitrary error pages
 128                         (r"/error/([45][0-9]{2})", ErrorHandler),
 129
 130                         # Block page
 131                         (r"/blocked", BlockedHandler),
 132                 ])
 133
 134                 # blog.ipfire.org
 135                 self.add_handlers(r"blog(\.dev)?\.ipfire\.org", [
 136                         (r"/", blog.IndexHandler),
 137                         (r"/authors/(\w+)", blog.AuthorHandler),
 138                         (r"/compose", blog.ComposeHandler),
 139                         (r"/drafts", blog.DraftsHandler),
 140                         (r"/post/([0-9a-z\-\._]+)", blog.PostHandler),
 141                         (r"/post/([0-9a-z\-\._]+)/edit", blog.EditHandler),
 142                         (r"/post/([0-9a-z\-\._]+)/publish", blog.PublishHandler),
 143                         (r"/search", blog.SearchHandler),
 144                         (r"/tags/([0-9a-z\-\.]+)", blog.TagHandler),
 145                         (r"/years/([0-9]+)", blog.YearHandler),
 146
 147                         # RSS Feed
 148                         (r"/feed.xml", blog.FeedHandler),
 149                 ] + authentication_handlers)
 150
 151                 # downloads.ipfire.org
 152                 self.add_handlers(r"downloads?(\.dev)?\.ipfire\.org", [
 153                         (r"/", tornado.web.RedirectHandler, { "url" : "https://www.ipfire.org/" }),
 154                         (r"/(.*)", download.FileHandler),
 155                 ])
 156
 157                 # mirrors.ipfire.org
 158                 self.add_handlers(r"mirrors(\.dev)?\.ipfire\.org", [
 159                         (r"/", MirrorIndexHandler),
 160                         (r"/mirror/(.*)", MirrorItemHandler),
 161                 ])
 162
 163                 # planet.ipfire.org
 164                 self.add_handlers(r"planet(\.dev)?\.ipfire\.org", [
 165                         (r"/", tornado.web.RedirectHandler, { "url" : "https://blog.ipfire.org/" }),
 166                         (r"/post/([A-Za-z0-9_-]+)", tornado.web.RedirectHandler, { "url" : "https://blog.ipfire.org/posts/{1}" }),
 167                         (r"/user/([a-z0-9_-]+)", tornado.web.RedirectHandler, { "url" : "https://blog.ipfire.org/authors/{1}" }),
 168
 169                         # RSS
 170                         (r"/rss", tornado.web.RedirectHandler, { "url" : "https://blog.ipfire.org/feed.xml" }),
 171                         (r"/user/([a-z0-9_-]+)/rss", tornado.web.RedirectHandler, { "url" : "https://blog.ipfire.org/authors/{1}.rss" }),
 172                         (r"/news.rss", tornado.web.RedirectHandler, { "url" : "https://blog.ipfire.org/feed.xml" }),
 173                 ])
 174
 175                 # fireinfo.ipfire.org
 176                 self.add_handlers(r"fireinfo(\.dev)?\.ipfire\.org", [
 177                         (r"/", FireinfoIndexHandler),
 178                         (r"/device/driver/(.*)", FireinfoDeviceDriverDetail),
 179                         (r"/device/vendors", FireinfoDeviceVendorsHandler),
 180                         (r"/device/(pci|usb)/([0-9a-f]{4})", FireinfoDeviceVendorHandler),
 181                         (r"/device/(pci|usb)/([0-9a-f]{4})/([0-9a-f]{4})", FireinfoDeviceModelHandler),
 182
 183                         # Show profiles
 184                         (r"/profile/random", FireinfoRandomProfileHandler),
 185                         (r"/profile/([a-z0-9]{40})", FireinfoProfileDetailHandler),
 186
 187                         # Send profiles.
 188                         (r"/send/([a-z0-9]+)", FireinfoProfileSendHandler),
 189
 190                         # Stats handlers
 191                         (r"/statistics", FireinfoStatsHandler),
 192                         (r"/statistics/processors", FireinfoStatsProcessorsHandler),
 193                         (r"/statistics/processors/(arm|x86)", FireinfoStatsProcessorDetailHandler),
 194                         (r"/statistics/geo-locations", FireinfoStatsGeoHandler),
 195                         (r"/statistics/languages", FireinfoStatsLanguagesHandler),
 196                         (r"/statistics/memory", FireinfoStatsMemoryHandler),
 197                         (r"/statistics/networking", FireinfoStatsNetworkingHandler),
 198                         (r"/statistics/releases", FireinfoStatsReleasesHandler),
 199                         (r"/statistics/virtualization", FireinfoStatsVirtualHandler),
 200
 201                         # Compat handlers
 202                         (r"/stats", tornado.web.RedirectHandler, { "url" : "/statistics" }),
 203                         (r"/stats/cpus", tornado.web.RedirectHandler, { "url" : "/statistics/processors" }),
 204                         (r"/stats/geo", tornado.web.RedirectHandler, { "url" : "/statistics/geo-locations" }),
 205                         (r"/stats/network", tornado.web.RedirectHandler, { "url" : "/statistics/networking" }),
 206                         (r"/stats/oses", tornado.web.RedirectHandler, { "url" : "/statistics/releases" }),
 207                         (r"/stats/virtual", tornado.web.RedirectHandler, { "url" : "/statistics/virtualization" }),
 208                         (r"/vendor/(pci|usb)/([0-9a-f]{4})", FireinfoDeviceVendorCompatHandler),
 209                         (r"/model/(pci|usb)/([0-9a-f]{4})/([0-9a-f]{4})", FireinfoDeviceModelCompatHandler),
 210                 ])
 211
 212                 # i-use.ipfire.org
 213                 self.add_handlers(r"i-use(\.dev)?\.ipfire\.org", [
 214                         (r"/profile/([a-f0-9]{40})/([0-9]+).png", IUseImage),
 215                 ])
 216
 217                 # boot.ipfire.org
 218                 BOOT_STATIC_PATH = os.path.join(self.settings["static_path"], "netboot")
 219                 self.add_handlers(r"boot(\.dev)?\.ipfire\.org", [
 220                         (r"/", tornado.web.RedirectHandler, { "url" : "https://www.ipfire.org/download" }),
 221
 222                         # Configurations
 223                         (r"/premenu.cfg", PremenuCfgHandler),
 224                         (r"/menu.gpxe", MenuGPXEHandler),
 225                         (r"/menu.cfg", MenuCfgHandler),
 226
 227                         # Static files
 228                         (r"/(boot\.png|pxelinux\.0|menu\.c32|vesamenu\.c32)",
 229                                 tornado.web.StaticFileHandler, { "path" : BOOT_STATIC_PATH }),
 230                 ])
 231
 232                 # nopaste.ipfire.org
 233                 self.add_handlers(r"nopaste(\.dev)?\.ipfire\.org", [
 234                         (r"/", NopasteCreateHandler),
 235                         (r"/raw/(.*)", NopasteRawHandler),
 236                         (r"/view/(.*)", NopasteViewHandler),
 237                 ] + authentication_handlers)
 238
 239                 # location.ipfire.org
 240                 self.add_handlers(r"location(\.dev)?\.ipfire\.org", [
 241                         (r"/", location.IndexHandler),
 242                         (r"/lookup/(.+)", location.LookupHandler),
 243                 ])
 244
 245                 # geoip.ipfire.org
 246                 self.add_handlers(r"geoip(\.dev)?\.ipfire\.org", [
 247                         (r"/", tornado.web.RedirectHandler, { "url" : "https://location.ipfire.org/" }),
 248                 ])
 249
 250                 # talk.ipfire.org
 251                 self.add_handlers(r"talk(\.dev)?\.ipfire\.org", [
 252                         (r"/", tornado.web.RedirectHandler, { "url" : "https://people.ipfire.org/" }),
 253                 ])
 254
 255                 # people.ipfire.org
 256                 self.add_handlers(r"people(\.dev)?\.ipfire\.org", [
 257                         (r"/", people.IndexHandler),
 258                         (r"/search", people.SearchHandler),
 259                         (r"/users", people.UsersHandler),
 260                         (r"/users/(\w+)", people.UserHandler),
 261                         (r"/users/(\w+)\.jpg", people.AvatarHandler),
 262                         (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),
 263                         (r"/users/(\w+)/calls(?:/(\d{4}-\d{2}-\d{2}))?", people.CallsHandler),
 264                         (r"/users/(\w+)/edit", people.UserEditHandler),
 265                         (r"/users/(\w+)/passwd", people.UserPasswdHandler),
 266                         (r"/users/(\w+)/ssh-keys", people.SSHKeysIndexHandler),
 267                         (r"/users/(\w+)/ssh-keys/(SHA256\:.*)/delete", people.SSHKeysDeleteHandler),
 268                         (r"/users/(\w+)/ssh-keys/(SHA256\:.*)", people.SSHKeysDownloadHandler),
 269                         (r"/users/(\w+)/ssh-keys/upload", people.SSHKeysUploadHandler),
 270                         (r"/users/(\w+)/sip", people.SIPHandler),
 271                 ]  + authentication_handlers)
 272
 273                 # ipfire.org
 274                 self.add_handlers(r"ipfire\.org", [
 275                         (r".*", tornado.web.RedirectHandler, { "url" : "https://www.ipfire.org" })
 276                 ])
 277
 278                 logging.info("Successfully initialied application")
 279
 280         def format_month_name(self, handler, month):
 281                 _ = handler.locale.translate
 282
 283                 if month == 1:
 284                         return _("January")
 285                 elif month == 2:
 286                         return _("February")
 287                 elif month == 3:
 288                         return _("March")
 289                 elif month == 4:
 290                         return _("April")
 291                 elif month == 5:
 292                         return _("May")
 293                 elif month == 6:
 294                         return _("June")
 295                 elif month == 7:
 296                         return _("July")
 297                 elif month == 8:
 298                         return _("August")
 299                 elif month == 9:
 300                         return _("September")
 301                 elif month == 10:
 302                         return _("October")
 303                 elif month == 11:
 304                         return _("November")
 305                 elif month == 12:
 306                         return _("December")
 307
 308                 return month
 309
 310         def format_phone_number(self, handler, number):
 311                 if not isinstance(number, phonenumbers.PhoneNumber):
 312                         try:
 313                                 number = phonenumbers.parse(number, None)
 314                         except phonenumbers.phonenumberutil.NumberParseException:
 315                                 return number
 316
 317                 return phonenumbers.format_number(number, phonenumbers.PhoneNumberFormat.INTERNATIONAL)
 318
 319         def format_phone_number_to_e164(self, handler, number):
 320                 return phonenumbers.format_number(number, phonenumbers.PhoneNumberFormat.E164)
 321
 322         def format_phone_number_location(self, handler, number):
 323                 s = [
 324                         phonenumbers.geocoder.description_for_number(number, handler.locale.code),
 325                         phonenumbers.region_code_for_number(number),
 326                 ]
 327
 328                 return ", ".join((e for e in s if e))
 329
 330
 331 def grouper(handler, iterator, n):
 332         """
 333                 Returns groups of n from the iterator
 334         """
 335         i = iter(iterator)
 336
 337         while True:
 338                 ret = list(itertools.islice(i, 0, n))
 339                 if not ret:
 340                         break
 341
 342                 yield ret