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