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

#!/usr/bin/python

from __future__ import division

import hashlib
import logging
import operator
import re
import socket
import textile
import tornado.escape
import tornado.locale
import tornado.web
import unicodedata

from .. import database

class UIModule(tornado.web.UIModule):
	@property
	def accounts(self):
		return self.handler.accounts

	@property
	def advertisements(self):
		return self.handler.advertisements

	@property
	def banners(self):
		return self.handler.banners

	@property
	def memcached(self):
		return self.handler.memcached

	@property
	def releases(self):
		return self.handler.releases

	@property
	def geoip(self):
		return self.handler.geoip

	@property
	def talk(self):
		return self.handler.talk


class AdvertisementModule(UIModule):
	def render(self, where):
		assert where in ("download-splash",), where

		ad = self.advertisements.get(where)
		if not ad:
			return ""

		# Mark that advert has been shown.
		ad.update_impressions()

		return self.render_string("modules/ads/%s.html" % where, ad=ad)


class FireinfoDeviceTableModule(UIModule):
	def render(self, devices):
		return self.render_string("fireinfo/modules/table-devices.html",
				devices=devices)


class FireinfoDeviceAndGroupsTableModule(UIModule):
	def render(self, devices):
		_ = self.locale.translate

		groups = {}

		for device in devices:
			if not groups.has_key(device.cls):
				groups[device.cls] = []

			groups[device.cls].append(device)

		# Sort all devices
		for key in groups.keys():
			groups[key].sort()

		# Order the groups by their name
		groups = groups.items()
		groups.sort()

		return self.render_string("fireinfo/modules/table-devices-and-groups.html",
				groups=groups)


class FireinfoGeoTableModule(UIModule):
	def render(self, items):
		countries = []
		other_countries = []
		for code, value in items:
			# Skip the satellite providers in this ranking
			if code in (None, "A1", "A2"):
				continue

			name = self.geoip.get_country_name(code)

			# Don't add countries with a small share on the list
			if value < 0.01:
				other_countries.append(name)
				continue

			country = database.Row({
				"code"  : code,
				"name"  : name,
				"value" : value,
			})
			countries.append(country)

		return self.render_string("fireinfo/modules/table-geo.html",
			countries=countries, other_countries=other_countries)


class LanguageNameModule(UIModule):
	def render(self, language):
		_ = self.locale.translate

		if language == "de":
			return _("German")
		elif language == "en":
			return _("English")
		elif language == "es":
			return _("Spanish")
		elif language == "fr":
			return _("French")
		elif language == "it":
			return _("Italian")
		elif language == "nl":
			return _("Dutch")
		elif language == "pl":
			return _("Polish")
		elif language == "pt":
			return _("Portuguese")
		elif language == "ru":
			return _("Russian")
		elif language == "tr":
			return _("Turkish")

		return language


class MapModule(UIModule):
	def render(self, latitude, longitude):
		return self.render_string("modules/map.html", latitude=latitude, longitude=longitude)


class MenuModule(UIModule):
	def render(self):
		return self.render_string("modules/menu.html")


class MirrorItemModule(UIModule):
	def render(self, item):
		return self.render_string("modules/mirror-item.html", item=item)


class MirrorsTableModule(UIModule):
	def render(self, mirrors, preferred_mirrors=[]):
		return self.render_string("modules/mirrors-table.html",
			mirrors=mirrors, preferred_mirrors=preferred_mirrors)


class NetBootMenuConfigModule(UIModule):
	def render(self, release, arch=None, platform=None):
		return self.render_string("netboot/menu-config.cfg", release=release,
			arch=arch, platform=platform)


class NetBootMenuHeaderModule(UIModule):
	def render(self, title, releases, arch=None, platform=None):
		id = unicodedata.normalize("NFKD", unicode(title)).encode("ascii", "ignore")
		id = re.sub(r"[^\w]+", " ", id)
		id = "-".join(id.lower().strip().split())

		return self.render_string("netboot/menu-header.cfg", id=id,
			title=title, releases=releases, arch=arch, platform=platform)


class NetBootMenuSeparatorModule(UIModule):
	def render(self):
		return self.render_string("netboot/menu-separator.cfg")


class SidebarItemModule(UIModule):
	def render(self):
		return self.render_string("modules/sidebar-item.html")


class SidebarReleaseModule(UIModule):
	def render(self):
		return self.render_string("modules/sidebar-release.html",
			latest=self.releases.get_latest())


class ReleaseItemModule(UIModule):
	def render(self, release, latest=False):
		arches = ("x86_64", "i586", "arm")

		downloads = []
		for arch in arches:
			files = []

			for file in release.files:
				if not file.arch == arch:
					continue

				files.append(file)

			if files:
				downloads.append((arch, files))

		return self.render_string("modules/release-item.html",
			release=release, latest=latest, downloads=downloads)


class SidebarBannerModule(UIModule):
	def render(self, item=None):
		if not item:
			item = self.banners.get_random()

		return self.render_string("modules/sidebar-banner.html", item=item)


class DownloadButtonModule(UIModule):
	def render(self, release, text="Download now!"):
		best_image = None

		for file in release.files:
			if (release.sname < "ipfire-2.19-core100" or file.arch == "x86_64") \
					and file.type == "iso":
				best_image = file
				break

		# Show nothing when there was no image found.
		if not best_image:
			return ""

		return self.render_string("modules/download-button.html",
			release=release, image=best_image)


class ProgressBarModule(UIModule):
	def render(self, value, colour=None):
		value *= 100

		return self.render_string("modules/progress-bar.html",
			colour=colour, value=value)


class TalkContactModule(UIModule):
        def render(self, number, name=None, application=None):
                account = self.accounts.get_by_sip_id(number)

                return self.render_string("talk/modules/contact.html",
                        account=account, number=number, name=name, application=application)


class TalkCallLogModule(UIModule):
	def render(self, account=None, viewer=None):
		if (account is None or not self.current_user == account) \
				and not self.current_user.is_admin():
			raise RuntimeException("Insufficient permissions")

		if viewer is None:
			viewer = self.current_user

		calls = self.talk.get_call_log(account)

		return self.render_string("talk/modules/call-log.html",
			calls=calls, viewer=viewer)


class TalkLinesModule(UIModule):
	def render(self, account=None, show_account=False):
		if (account is None or not self.current_user == account) \
				and not self.current_user.is_admin():
			raise RuntimeException("Insufficient permissions")

		lines = self.talk.get_lines(account)

		return self.render_string("talk/modules/lines.html",
			show_account=show_account, lines=lines)


class TalkOngoingCallsModule(UIModule):
	def render(self, account=None, debug=False):
		if (account is None or not self.current_user == account) \
				and not self.current_user.is_admin():
			raise RuntimeException("Insufficient permissions")

		channels = self.talk.get_channels()

		return self.render_string("talk/modules/ongoing-calls.html",
			account=account, channels=channels, debug=debug)


class DonationBoxModule(UIModule):
	def render(self, reason_for_transfer=None):
		if reason_for_transfer:
			reason_for_transfer = "IPFire.org - %s" % reason_for_transfer

		return self.render_string("modules/donation-box.html",
			reason_for_transfer=reason_for_transfer)


class DonationButtonModule(UIModule):
	# https://developer.paypal.com/docs/classic/paypal-payments-standard/integration-guide/Appx_websitestandard_htmlvariables/
	COUNTRIES = (
		"AU",
		"AT",
		"BE",
		"BR",
		"CA",
		"CH",
		"CN",
		"DE",
		"ES",
		"GB",
		"FR",
		"IT",
		"NL",
		"PL",
		"PT",
		"RU",
		"US",
	)

	LOCALES = (
		"da_DK",
		"he_IL",
		"id_ID",
		"ja_JP",
		"no_NO",
		"pt_BR",
		"ru_RU",
		"sv_SE",
		"th_TH",
		"zh_CN",
		"zh_HK",
		"zh_TW",
	)

	def render(self, reason_for_transfer=None, currency="EUR"):
		if not reason_for_transfer:
			reason_for_transfer = "IPFire.org"

		primary = (currency == "EUR")

		return self.render_string("modules/donation-button.html", primary=primary,
			reason_for_transfer=reason_for_transfer, currency=currency, lc=self.lc)

	@property
	def lc(self):
		"""
			Returns the locale of the user
		"""
		try:
			locale, delimiter, encoding = self.locale.code.partition(".")

			# Break for languages in specific countries
			if locale in self.LOCALES:
				return locale

			lang, delimiter, country_code = locale.partition("_")

			if country_code and country_code in self.COUNTRIES:
				return country_code

			lang = lang.upper()
			if lang in self.COUNTRIES:
				return lang
		except:
			pass

		# If anything goes wrong, fall back to GB
		return "GB"


class DonationInputBoxModule(DonationButtonModule):
	def render(self):
		currencies = ("EUR", "USD", "GBP", "CHF", "AUD", "NZD", "CAD")

		return self.render_string("modules/donation-input-box.html",
			currencies=currencies, lc=self.lc)
Commit	Line	Data
81675874	1	#!/usr/bin/python
81675874	2
91a446f0 MT	3	from __future__ import division
91a446f0 MT	4
de683d7c	5	import hashlib
940227cb	6	import logging
91a446f0	7	import operator
9068dba1	8	import re
940227cb MT	9	import socket
	10	import textile
	11	import tornado.escape
6af40477	12	import tornado.locale
feb02477	13	import tornado.web
9068dba1	14	import unicodedata
81675874	15
a95c2f97	16	from .. import database
494d80e6	17
81675874	18	class UIModule(tornado.web.UIModule):
940227cb MT	19	@property
	20	def accounts(self):
	21	return self.handler.accounts
81675874	22
a0048e66 MT	23	@property
	24	def advertisements(self):
	25	return self.handler.advertisements
	26
d0d074e0	27	@property
940227cb MT	28	def banners(self):
940227cb MT	29	return self.handler.banners
d0d074e0	30
de683d7c MT	31	@property
	32	def memcached(self):
	33	return self.handler.memcached
	34
940227cb MT	35	@property
	36	def releases(self):
	37	return self.handler.releases
81675874	38
638e9782 MT	39	@property
	40	def geoip(self):
	41	return self.handler.geoip
	42
77431b9c MT	43	@property
	44	def talk(self):
	45	return self.handler.talk
	46
5a1018ab	47
a0048e66 MT	48	class AdvertisementModule(UIModule):
	49	def render(self, where):
	50	assert where in ("download-splash",), where
	51
	52	ad = self.advertisements.get(where)
	53	if not ad:
	54	return ""
	55
	56	# Mark that advert has been shown.
	57	ad.update_impressions()
	58
	59	return self.render_string("modules/ads/%s.html" % where, ad=ad)
	60
	61
66862195 MT	62	class FireinfoDeviceTableModule(UIModule):
	63	def render(self, devices):
	64	return self.render_string("fireinfo/modules/table-devices.html",
	65	devices=devices)
	66
	67
	68	class FireinfoDeviceAndGroupsTableModule(UIModule):
	69	def render(self, devices):
	70	_ = self.locale.translate
	71
	72	groups = {}
	73
	74	for device in devices:
	75	if not groups.has_key(device.cls):
	76	groups[device.cls] = []
	77
	78	groups[device.cls].append(device)
	79
	80	# Sort all devices
	81	for key in groups.keys():
	82	groups[key].sort()
	83
	84	# Order the groups by their name
	85	groups = groups.items()
	86	groups.sort()
	87
	88	return self.render_string("fireinfo/modules/table-devices-and-groups.html",
	89	groups=groups)
	90
	91
	92	class FireinfoGeoTableModule(UIModule):
	93	def render(self, items):
	94	countries = []
	95	other_countries = []
	96	for code, value in items:
	97	# Skip the satellite providers in this ranking
	98	if code in (None, "A1", "A2"):
	99	continue
	100
	101	name = self.geoip.get_country_name(code)
	102
	103	# Don't add countries with a small share on the list
	104	if value < 0.01:
	105	other_countries.append(name)
	106	continue
	107
a95c2f97	108	country = database.Row({
66862195 MT	109	"code" : code,
	110	"name" : name,
	111	"value" : value,
	112	})
	113	countries.append(country)
	114
66862195 MT	115	return self.render_string("fireinfo/modules/table-geo.html",
	116	countries=countries, other_countries=other_countries)
	117
	118
	119	class LanguageNameModule(UIModule):
	120	def render(self, language):
	121	_ = self.locale.translate
	122
	123	if language == "de":
	124	return _("German")
	125	elif language == "en":
	126	return _("English")
	127	elif language == "es":
	128	return _("Spanish")
	129	elif language == "fr":
	130	return _("French")
	131	elif language == "it":
	132	return _("Italian")
	133	elif language == "nl":
	134	return _("Dutch")
	135	elif language == "pl":
	136	return _("Polish")
	137	elif language == "pt":
	138	return _("Portuguese")
	139	elif language == "ru":
	140	return _("Russian")
	141	elif language == "tr":
	142	return _("Turkish")
	143
	144	return language
	145
	146
9068dba1 MT	147	class MapModule(UIModule):
	148	def render(self, latitude, longitude):
	149	return self.render_string("modules/map.html", latitude=latitude, longitude=longitude)
	150
	151
940227cb MT	152	class MenuModule(UIModule):
940227cb MT	153	def render(self):
60024cc8	154	return self.render_string("modules/menu.html")
81675874	155
81675874	156
9068dba1 MT	157	class MirrorItemModule(UIModule):
	158	def render(self, item):
	159	return self.render_string("modules/mirror-item.html", item=item)
	160
	161
	162	class MirrorsTableModule(UIModule):
	163	def render(self, mirrors, preferred_mirrors=[]):
	164	return self.render_string("modules/mirrors-table.html",
	165	mirrors=mirrors, preferred_mirrors=preferred_mirrors)
	166
	167
	168	class NetBootMenuConfigModule(UIModule):
37b5c0cf MT	169	def render(self, release, arch=None, platform=None):
	170	return self.render_string("netboot/menu-config.cfg", release=release,
	171	arch=arch, platform=platform)
9068dba1 MT	172
	173
	174	class NetBootMenuHeaderModule(UIModule):
37b5c0cf	175	def render(self, title, releases, arch=None, platform=None):
9068dba1 MT	176	id = unicodedata.normalize("NFKD", unicode(title)).encode("ascii", "ignore")
	177	id = re.sub(r"[^\w]+", " ", id)
	178	id = "-".join(id.lower().strip().split())
	179
	180	return self.render_string("netboot/menu-header.cfg", id=id,
37b5c0cf	181	title=title, releases=releases, arch=arch, platform=platform)
9068dba1 MT	182
	183
	184	class NetBootMenuSeparatorModule(UIModule):
	185	def render(self):
	186	return self.render_string("netboot/menu-separator.cfg")
	187
	188
81675874	189	class SidebarItemModule(UIModule):
	190	def render(self):
	191	return self.render_string("modules/sidebar-item.html")
	192
	193
	194	class SidebarReleaseModule(UIModule):
81675874	195	def render(self):
81675874	196	return self.render_string("modules/sidebar-release.html",
940227cb	197	latest=self.releases.get_latest())
81675874	198
	199
	200	class ReleaseItemModule(UIModule):
60024cc8	201	def render(self, release, latest=False):
6371bfda	202	arches = ("x86_64", "i586", "arm")
60024cc8	203
110e8687	204	downloads = []
6371bfda	205	for arch in arches:
110e8687 MT	206	files = []
	207
	208	for file in release.files:
	209	if not file.arch == arch:
	210	continue
	211
	212	files.append(file)
	213
	214	if files:
	215	downloads.append((arch, files))
60024cc8 MT	216
60024cc8 MT	217	return self.render_string("modules/release-item.html",
110e8687	218	release=release, latest=latest, downloads=downloads)
81675874	219
	220
	221	class SidebarBannerModule(UIModule):
940227cb MT	222	def render(self, item=None):
	223	if not item:
	224	item = self.banners.get_random()
	225
81675874	226	return self.render_string("modules/sidebar-banner.html", item=item)
	227
	228
60024cc8 MT	229	class DownloadButtonModule(UIModule):
	230	def render(self, release, text="Download now!"):
	231	best_image = None
	232
	233	for file in release.files:
6371bfda MT	234	if (release.sname < "ipfire-2.19-core100" or file.arch == "x86_64") \
6371bfda MT	235	and file.type == "iso":
60024cc8 MT	236	best_image = file
	237	break
	238
	239	# Show nothing when there was no image found.
	240	if not best_image:
	241	return ""
	242
	243	return self.render_string("modules/download-button.html",
	244	release=release, image=best_image)
	245
	246
66862195 MT	247	class ProgressBarModule(UIModule):
	248	def render(self, value, colour=None):
	249	value *= 100
	250
	251	return self.render_string("modules/progress-bar.html",
	252	colour=colour, value=value)
	253
	254
5ac74b02	255	class TalkContactModule(UIModule):
56851b01	256	def render(self, number, name=None, application=None):
5ac74b02 MT	257	account = self.accounts.get_by_sip_id(number)
	258
	259	return self.render_string("talk/modules/contact.html",
56851b01	260	account=account, number=number, name=name, application=application)
5ac74b02 MT	261
5ac74b02 MT	262
66862195	263	class TalkCallLogModule(UIModule):
77431b9c MT	264	def render(self, account=None, viewer=None):
	265	if (account is None or not self.current_user == account) \
	266	and not self.current_user.is_admin():
	267	raise RuntimeException("Insufficient permissions")
	268
	269	if viewer is None:
	270	viewer = self.current_user
	271
	272	calls = self.talk.get_call_log(account)
	273
	274	return self.render_string("talk/modules/call-log.html",
	275	calls=calls, viewer=viewer)
	276
	277
	278	class TalkLinesModule(UIModule):
	279	def render(self, account=None, show_account=False):
	280	if (account is None or not self.current_user == account) \
	281	and not self.current_user.is_admin():
	282	raise RuntimeException("Insufficient permissions")
	283
	284	lines = self.talk.get_lines(account)
	285
	286	return self.render_string("talk/modules/lines.html",
	287	show_account=show_account, lines=lines)
66862195 MT	288
	289
	290	class TalkOngoingCallsModule(UIModule):
5ac74b02	291	def render(self, account=None, debug=False):
77431b9c MT	292	if (account is None or not self.current_user == account) \
	293	and not self.current_user.is_admin():
	294	raise RuntimeException("Insufficient permissions")
	295
5ac74b02	296	channels = self.talk.get_channels()
77431b9c	297
5ac74b02 MT	298	return self.render_string("talk/modules/ongoing-calls.html",
5ac74b02 MT	299	account=account, channels=channels, debug=debug)
66862195 MT	300
66862195 MT	301
7771acea	302	class DonationBoxModule(UIModule):
e00c06b9	303	def render(self, reason_for_transfer=None):
353880e5 MT	304	if reason_for_transfer:
	305	reason_for_transfer = "IPFire.org - %s" % reason_for_transfer
	306
	307	return self.render_string("modules/donation-box.html",
e00c06b9 MT	308	reason_for_transfer=reason_for_transfer)
	309
	310
	311	class DonationButtonModule(UIModule):
069e18f5 MT	312	# https://developer.paypal.com/docs/classic/paypal-payments-standard/integration-guide/Appx_websitestandard_htmlvariables/
	313	COUNTRIES = (
	314	"AU",
	315	"AT",
	316	"BE",
	317	"BR",
	318	"CA",
	319	"CH",
	320	"CN",
	321	"DE",
	322	"ES",
	323	"GB",
	324	"FR",
	325	"IT",
	326	"NL",
	327	"PL",
	328	"PT",
	329	"RU",
	330	"US",
	331	)
	332
	333	LOCALES = (
	334	"da_DK",
	335	"he_IL",
	336	"id_ID",
	337	"ja_JP",
	338	"no_NO",
	339	"pt_BR",
	340	"ru_RU",
	341	"sv_SE",
	342	"th_TH",
	343	"zh_CN",
	344	"zh_HK",
	345	"zh_TW",
	346	)
	347
e00c06b9 MT	348	def render(self, reason_for_transfer=None, currency="EUR"):
	349	if not reason_for_transfer:
	350	reason_for_transfer = "IPFire.org"
	351
	352	primary = (currency == "EUR")
	353
	354	return self.render_string("modules/donation-button.html", primary=primary,
069e18f5 MT	355	reason_for_transfer=reason_for_transfer, currency=currency, lc=self.lc)
	356
	357	@property
	358	def lc(self):
	359	"""
	360	Returns the locale of the user
	361	"""
	362	try:
	363	locale, delimiter, encoding = self.locale.code.partition(".")
	364
	365	# Break for languages in specific countries
	366	if locale in self.LOCALES:
	367	return locale
	368
	369	lang, delimiter, country_code = locale.partition("_")
069e18f5 MT	370
	371	if country_code and country_code in self.COUNTRIES:
	372	return country_code
	373
	374	lang = lang.upper()
	375	if lang in self.COUNTRIES:
	376	return lang
	377	except:
	378	pass
	379
	380	# If anything goes wrong, fall back to GB
	381	return "GB"
60b0917c MT	382
	383
	384	class DonationInputBoxModule(DonationButtonModule):
	385	def render(self):
	386	currencies = ("EUR", "USD", "GBP", "CHF", "AUD", "NZD", "CAD")
	387
	388	return self.render_string("modules/donation-input-box.html",
	389	currencies=currencies, lc=self.lc)