web: Rename base module

[ipfire.org.git] / src / web / __init__.py

#/usr/bin/python

import logging
import itertools
import os.path
import phonenumbers
import phonenumbers.geocoder
import tornado.locale
import tornado.options
import tornado.web

import ipfire

from .handlers import *

from . import auth
from . import blog
from . import download
from . import location
from . import newsletter
from . import nopaste
from . import people
from . import ui_modules

class Application(tornado.web.Application):
	def __init__(self, config, **kwargs):
		# Initialize backend
		self.backend = ipfire.Backend(config)

		settings = {
			# Do not compress responses
			"gzip" : False,

			# Enable XSRF cookies
			"xsrf_cookies" : True,

			# Login
			"login_url" : "/login",

			# Setup directory structure
			"static_path"   : self.backend.config.get("global", "static_dir"),
			"template_path" : self.backend.config.get("global", "templates_dir"),

			# UI Modules
			"ui_methods" : {
				"format_month_name"            : self.format_month_name,
				"format_phone_number"          : self.format_phone_number,
				"format_phone_number_to_e164"  : self.format_phone_number_to_e164,
				"format_phone_number_location" : self.format_phone_number_location,
				"grouper"                      : grouper,
			},
			"ui_modules" : {
				# Blog
				"BlogHistoryNavigation": blog.HistoryNavigationModule,
				"BlogList"             : blog.ListModule,
				"BlogPost"             : blog.PostModule,
				"BlogPosts"            : blog.PostsModule,

				# Location
				"Map"                  : ui_modules.MapModule,

				# Talk
				"AccountsList"         : people.AccountsListModule,
				"CDR"                  : people.CDRModule,
				"Channels"             : people.ChannelsModule,
				"MOS"                  : people.MOSModule,
				"Password"             : people.PasswordModule,
				"Registrations"        : people.RegistrationsModule,
				"SIPStatus"            : people.SIPStatusModule,

				# Nopaste
				"Code"                 : nopaste.CodeModule,

				# Old modules
				"LanguageName"         : ui_modules.LanguageNameModule,

				"MirrorItem"           : ui_modules.MirrorItemModule,
				"MirrorsTable"         : ui_modules.MirrorsTableModule,
				"NetBootMenuConfig"    : ui_modules.NetBootMenuConfigModule,
				"NetBootMenuHeader"    : ui_modules.NetBootMenuHeaderModule,
				"NetBootMenuSeparator" : ui_modules.NetBootMenuSeparatorModule,
				"ProgressBar"          : ui_modules.ProgressBarModule,
				"FireinfoDeviceTable"  : ui_modules.FireinfoDeviceTableModule,
				"FireinfoDeviceAndGroupsTable" : ui_modules.FireinfoDeviceAndGroupsTableModule,
				"FireinfoGeoTable"        : ui_modules.FireinfoGeoTableModule,
			},

			# Call this when a page wasn't found
			"default_handler_class" : NotFoundHandler,
		}
		settings.update(kwargs)

		tornado.web.Application.__init__(self, **settings)

		authentication_handlers = [
			(r"/login", auth.LoginHandler),
			(r"/logout", auth.LogoutHandler),
		]

		self.add_handlers(r"(dev|www)\.ipfire\.(at|org)", [
			# Entry site that lead the user to index
			(r"/", IndexHandler),

			# Download sites
			(r"/downloads", tornado.web.RedirectHandler, { "url" : "/download" }),
			(r"/download", download.IndexHandler),
			(r"/download/([0-9a-z\-\.]+)", download.ReleaseHandler),

			# Donate
			(r"/donate", DonateHandler),
			(r"/donation", tornado.web.RedirectHandler, { "url" : "/donate" }),

			# Newsletter
			(r"/newsletter/subscribe", newsletter.SubscribeHandler),

			# RSS feed
			(r"/news.rss", tornado.web.RedirectHandler, { "url" : "https://blog.ipfire.org/feed.xml" }),

			# Redirect news articles to blog
			(r"/news/(.*)", tornado.web.RedirectHandler, { "url" : "https://blog.ipfire.org/posts/{1}" }),

			# Static Pages
			(r"/chat", StaticHandler, { "template" : "chat.html" }),
			(r"/features", StaticHandler, { "template" : "features.html" }),
			(r"/legal", StaticHandler, { "template" : "legal.html" }),
			(r"/support", StaticHandler, { "template" : "support.html" }),

			# Handle old pages that have moved elsewhere
			(r"/imprint", tornado.web.RedirectHandler, { "url" : "/legal" }),
			(r"/(de|en)/(.*)", LangCompatHandler),

			# Export arbitrary error pages
			(r"/error/([45][0-9]{2})", ErrorHandler),

			# Block page
			(r"/blocked", BlockedHandler),
		])

		# blog.ipfire.org
		self.add_handlers(r"blog(\.dev)?\.ipfire\.org", [
			(r"/", blog.IndexHandler),
			(r"/authors/(\w+)", blog.AuthorHandler),
			(r"/compose", blog.ComposeHandler),
			(r"/drafts", blog.DraftsHandler),
			(r"/post/([0-9a-z\-\._]+)", blog.PostHandler),
			(r"/post/([0-9a-z\-\._]+)/edit", blog.EditHandler),
			(r"/post/([0-9a-z\-\._]+)/publish", blog.PublishHandler),
			(r"/search", blog.SearchHandler),
			(r"/tags/([0-9a-z\-\.]+)", blog.TagHandler),
			(r"/years/([0-9]+)", blog.YearHandler),

			# RSS Feed
			(r"/feed.xml", blog.FeedHandler),
		] + authentication_handlers)

		# downloads.ipfire.org
		self.add_handlers(r"downloads?(\.dev)?\.ipfire\.org", [
			(r"/", tornado.web.RedirectHandler, { "url" : "https://www.ipfire.org/" }),
			(r"/(.*)", download.FileHandler),
		])

		# mirrors.ipfire.org
		self.add_handlers(r"mirrors(\.dev)?\.ipfire\.org", [
			(r"/", MirrorIndexHandler),
			(r"/mirror/(.*)", MirrorItemHandler),
		])

		# planet.ipfire.org
		self.add_handlers(r"planet(\.dev)?\.ipfire\.org", [
			(r"/", tornado.web.RedirectHandler, { "url" : "https://blog.ipfire.org/" }),
			(r"/post/([A-Za-z0-9_-]+)", tornado.web.RedirectHandler, { "url" : "https://blog.ipfire.org/posts/{1}" }),
			(r"/user/([a-z0-9_-]+)", tornado.web.RedirectHandler, { "url" : "https://blog.ipfire.org/authors/{1}" }),

			# RSS
			(r"/rss", tornado.web.RedirectHandler, { "url" : "https://blog.ipfire.org/feed.xml" }),
			(r"/user/([a-z0-9_-]+)/rss", tornado.web.RedirectHandler, { "url" : "https://blog.ipfire.org/authors/{1}.rss" }),
			(r"/news.rss", tornado.web.RedirectHandler, { "url" : "https://blog.ipfire.org/feed.xml" }),
		])

		# fireinfo.ipfire.org
		self.add_handlers(r"fireinfo(\.dev)?\.ipfire\.org", [
			(r"/", FireinfoIndexHandler),
			(r"/device/driver/(.*)", FireinfoDeviceDriverDetail),
			(r"/device/vendors", FireinfoDeviceVendorsHandler),
			(r"/device/(pci|usb)/([0-9a-f]{4})", FireinfoDeviceVendorHandler),
			(r"/device/(pci|usb)/([0-9a-f]{4})/([0-9a-f]{4})", FireinfoDeviceModelHandler),

			# Show profiles
			(r"/profile/random", FireinfoRandomProfileHandler),
			(r"/profile/([a-z0-9]{40})", FireinfoProfileDetailHandler),

			# Send profiles.
			(r"/send/([a-z0-9]+)", FireinfoProfileSendHandler),

			# Stats handlers
			(r"/statistics", FireinfoStatsHandler),
			(r"/statistics/processors", FireinfoStatsProcessorsHandler),
			(r"/statistics/processors/(arm|x86)", FireinfoStatsProcessorDetailHandler),
			(r"/statistics/geo-locations", FireinfoStatsGeoHandler),
			(r"/statistics/languages", FireinfoStatsLanguagesHandler),
			(r"/statistics/memory", FireinfoStatsMemoryHandler),
			(r"/statistics/networking", FireinfoStatsNetworkingHandler),
			(r"/statistics/releases", FireinfoStatsReleasesHandler),
			(r"/statistics/virtualization", FireinfoStatsVirtualHandler),

			# Compat handlers
			(r"/stats", tornado.web.RedirectHandler, { "url" : "/statistics" }),
			(r"/stats/cpus", tornado.web.RedirectHandler, { "url" : "/statistics/processors" }),
			(r"/stats/geo", tornado.web.RedirectHandler, { "url" : "/statistics/geo-locations" }),
			(r"/stats/network", tornado.web.RedirectHandler, { "url" : "/statistics/networking" }),
			(r"/stats/oses", tornado.web.RedirectHandler, { "url" : "/statistics/releases" }),
			(r"/stats/virtual", tornado.web.RedirectHandler, { "url" : "/statistics/virtualization" }),
			(r"/vendor/(pci|usb)/([0-9a-f]{4})", FireinfoDeviceVendorCompatHandler),
			(r"/model/(pci|usb)/([0-9a-f]{4})/([0-9a-f]{4})", FireinfoDeviceModelCompatHandler),
		])

		# i-use.ipfire.org
		self.add_handlers(r"i-use(\.dev)?\.ipfire\.org", [
			(r"/profile/([a-f0-9]{40})/([0-9]+).png", IUseImage),
		])

		# boot.ipfire.org
		BOOT_STATIC_PATH = os.path.join(self.settings["static_path"], "netboot")
		self.add_handlers(r"boot(\.dev)?\.ipfire\.org", [
			(r"/", tornado.web.RedirectHandler, { "url" : "https://www.ipfire.org/download" }),

			# Configurations
			(r"/premenu.cfg", PremenuCfgHandler),
			(r"/menu.gpxe", MenuGPXEHandler),
			(r"/menu.cfg", MenuCfgHandler),

			# Static files
			(r"/(boot\.png|pxelinux\.0|menu\.c32|vesamenu\.c32)",
				tornado.web.StaticFileHandler, { "path" : BOOT_STATIC_PATH }),
		])

		# nopaste.ipfire.org
		self.add_handlers(r"nopaste(\.dev)?\.ipfire\.org", [
			(r"/", nopaste.CreateHandler),
			(r"/raw/(.*)", nopaste.RawHandler),
			(r"/view/(.*)", nopaste.ViewHandler),
		] + authentication_handlers)

		# location.ipfire.org
		self.add_handlers(r"location(\.dev)?\.ipfire\.org", [
			(r"/", location.IndexHandler),
			(r"/lookup/(.+)", location.LookupHandler),
		])

		# geoip.ipfire.org
		self.add_handlers(r"geoip(\.dev)?\.ipfire\.org", [
			(r"/", tornado.web.RedirectHandler, { "url" : "https://location.ipfire.org/" }),
		])

		# talk.ipfire.org
		self.add_handlers(r"talk(\.dev)?\.ipfire\.org", [
			(r"/", tornado.web.RedirectHandler, { "url" : "https://people.ipfire.org/" }),
		])

		# people.ipfire.org
		self.add_handlers(r"people(\.dev)?\.ipfire\.org", [
			(r"/", people.IndexHandler),
			(r"/conferences", people.ConferencesHandler),
			(r"/search", people.SearchHandler),
			(r"/users", people.UsersHandler),
			(r"/users/(\w+)", people.UserHandler),
			(r"/users/(\w+)\.jpg", people.AvatarHandler),
			(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),
			(r"/users/(\w+)/calls(?:/(\d{4}-\d{2}-\d{2}))?", people.CallsHandler),
			(r"/users/(\w+)/edit", people.UserEditHandler),
			(r"/users/(\w+)/passwd", people.UserPasswdHandler),
			(r"/users/(\w+)/ssh-keys", people.SSHKeysIndexHandler),
			(r"/users/(\w+)/ssh-keys/(SHA256\:.*)/delete", people.SSHKeysDeleteHandler),
			(r"/users/(\w+)/ssh-keys/(SHA256\:.*)", people.SSHKeysDownloadHandler),
			(r"/users/(\w+)/ssh-keys/upload", people.SSHKeysUploadHandler),
			(r"/users/(\w+)/sip", people.SIPHandler),
		]  + authentication_handlers)

		# ipfire.org
		self.add_handlers(r"ipfire\.org", [
			(r".*", tornado.web.RedirectHandler, { "url" : "https://www.ipfire.org" })
		])

		logging.info("Successfully initialied application")

	def format_month_name(self, handler, month):
		_ = handler.locale.translate

		if month == 1:
			return _("January")
		elif month == 2:
			return _("February")
		elif month == 3:
			return _("March")
		elif month == 4:
			return _("April")
		elif month == 5:
			return _("May")
		elif month == 6:
			return _("June")
		elif month == 7:
			return _("July")
		elif month == 8:
			return _("August")
		elif month == 9:
			return _("September")
		elif month == 10:
			return _("October")
		elif month == 11:
			return _("November")
		elif month == 12:
			return _("December")

		return month

	def format_phone_number(self, handler, number):
		if not isinstance(number, phonenumbers.PhoneNumber):
			try:
				number = phonenumbers.parse(number, None)
			except phonenumbers.phonenumberutil.NumberParseException:
				return number

		return phonenumbers.format_number(number, phonenumbers.PhoneNumberFormat.INTERNATIONAL)

	def format_phone_number_to_e164(self, handler, number):
		return phonenumbers.format_number(number, phonenumbers.PhoneNumberFormat.E164)

	def format_phone_number_location(self, handler, number):
		s = [
			phonenumbers.geocoder.description_for_number(number, handler.locale.code),
			phonenumbers.region_code_for_number(number),
		]

		return ", ".join((e for e in s if e))


def grouper(handler, iterator, n):
	"""
		Returns groups of n from the iterator
	"""
	i = iter(iterator)

	while True:
		ret = list(itertools.islice(i, 0, n))
		if not ret:
			break

		yield ret