[people/shoehn/ipfire.org.git] / webapp / 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

import backend

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 news(self):
		return self.handler.news

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

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


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 = backend.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):
		return self.render_string("netboot/menu-config.cfg", release=release)


class NetBootMenuHeaderModule(UIModule):
	def render(self, title, releases):
		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)


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


class NewsItemModule(UIModule):
	def get_author(self, author):
		# Get name of author
		author = self.accounts.find(author)
		if author:
			return author.name
		else:
			_ = self.locale.translate
			return _("Unknown author")

	def render(self, item, uncut=True, announcement=False, show_heading=True):
		# Get author
		item.author = self.get_author(item.author_id)

		if not uncut and len(item.text) >= 400:
			item.text = item.text[:400] + "..."

		# Render text
		item.text = textile.textile(item.text.decode("utf8"))

		return self.render_string("modules/news-item.html", item=item,
			uncut=uncut, announcement=announcement, show_heading=show_heading)


class NewsLineModule(UIModule):
	def render(self, item):
		return self.render_string("modules/news-line.html", item=item)


class NewsTableModule(UIModule):
	def render(self, news):
		return self.render_string("modules/news-table.html", news=news)


class NewsYearNavigationModule(UIModule):
	def render(self, active=None):
		try:
			active = int(active)
		except:
			active = None

		return self.render_string("modules/news-year-nav.html",
			active=active, years=self.news.years)


class PlanetSearchBoxModule(UIModule):
	def render(self, query=None):
		years = self.planet.get_years()

		return self.render_string("modules/planet/search-box.html",
			query=query, years=years)


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 = ("i586", "arm")

		downloads = []
		for arch in ("i586", "arm"):
			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 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 PlanetAuthorBoxModule(UIModule):
	def render(self, author):
		return self.render_string("planet/modules/author-box.html", author=author)


class PlanetEntryModule(UIModule):
	def render(self, entry, show_avatar=True):
		return self.render_string("modules/planet-entry.html",
			entry=entry, show_avatar=show_avatar)


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

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


class TalkCallLogModule(UIModule):
	def render(self, calls):
		return self.render_string("talk/modules/call-log.html", calls=calls)


class TalkOngoingCallsModule(UIModule):
	def render(self, calls):
		return self.render_string("talk/modules/ongoing-calls.html", calls=calls)


class TrackerPeerListModule(UIModule):
	def render(self, peers):
		# Guess country code and hostname of the host
		for peer in peers:
			country_code = self.geoip.get_country(peer["ip"])
			if country_code:
				peer["country_code"] = country_code.lower()
			else:
				peer["country_code"] = "unknown"

			try:
				peer["hostname"] = socket.gethostbyaddr(peer["ip"])[0]
			except:
				peer["hostname"] = ""

		return self.render_string("modules/tracker-peerlist.html",
			peers=[backend.database.Row(p) for p in peers])


class WishlistModule(UIModule):
	def render(self, wishes, short=False):
		return self.render_string("wishlist/modules/wishlist.html",
			wishes=wishes, short=short)


class WishModule(UIModule):
	def render(self, wish, short=False):
		progress_bar = "progress-bar-warning"

		if wish.percentage >= 100:
			progress_bar = "progress-bar-success"

		return self.render_string("wishlist/modules/wish.html",
			wish=wish, short=short, progress_bar=progress_bar)


class WishlistItemsModule(UIModule):
	def render(self, wishlist_items):
		return self.render_string("modules/wishlist-items.html",
			wishlist_items=wishlist_items)


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):
	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)
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
494d80e6 MT	16	import backend
494d80e6 MT	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
7771acea MT	43	@property
	44	def news(self):
	45	return self.handler.news
	46
fa7e1a0a MT	47	@property
	48	def planet(self):
	49	return self.handler.planet
	50
e64ce07e MT	51	@property
	52	def wishlist(self):
	53	return self.handler.wishlist
	54
5a1018ab	55
a0048e66 MT	56	class AdvertisementModule(UIModule):
	57	def render(self, where):
	58	assert where in ("download-splash",), where
	59
	60	ad = self.advertisements.get(where)
	61	if not ad:
	62	return ""
	63
	64	# Mark that advert has been shown.
	65	ad.update_impressions()
	66
	67	return self.render_string("modules/ads/%s.html" % where, ad=ad)
	68
	69
66862195 MT	70	class FireinfoDeviceTableModule(UIModule):
	71	def render(self, devices):
	72	return self.render_string("fireinfo/modules/table-devices.html",
	73	devices=devices)
	74
	75
	76	class FireinfoDeviceAndGroupsTableModule(UIModule):
	77	def render(self, devices):
	78	_ = self.locale.translate
	79
	80	groups = {}
	81
	82	for device in devices:
	83	if not groups.has_key(device.cls):
	84	groups[device.cls] = []
	85
	86	groups[device.cls].append(device)
	87
	88	# Sort all devices
	89	for key in groups.keys():
	90	groups[key].sort()
	91
	92	# Order the groups by their name
	93	groups = groups.items()
	94	groups.sort()
	95
	96	return self.render_string("fireinfo/modules/table-devices-and-groups.html",
	97	groups=groups)
	98
	99
	100	class FireinfoGeoTableModule(UIModule):
	101	def render(self, items):
	102	countries = []
	103	other_countries = []
	104	for code, value in items:
	105	# Skip the satellite providers in this ranking
	106	if code in (None, "A1", "A2"):
	107	continue
	108
	109	name = self.geoip.get_country_name(code)
	110
	111	# Don't add countries with a small share on the list
	112	if value < 0.01:
	113	other_countries.append(name)
	114	continue
	115
494d80e6	116	country = backend.database.Row({
66862195 MT	117	"code" : code,
	118	"name" : name,
	119	"value" : value,
	120	})
	121	countries.append(country)
	122
66862195 MT	123	return self.render_string("fireinfo/modules/table-geo.html",
	124	countries=countries, other_countries=other_countries)
	125
	126
	127	class LanguageNameModule(UIModule):
	128	def render(self, language):
	129	_ = self.locale.translate
	130
	131	if language == "de":
	132	return _("German")
	133	elif language == "en":
	134	return _("English")
	135	elif language == "es":
	136	return _("Spanish")
	137	elif language == "fr":
	138	return _("French")
	139	elif language == "it":
	140	return _("Italian")
	141	elif language == "nl":
	142	return _("Dutch")
	143	elif language == "pl":
	144	return _("Polish")
	145	elif language == "pt":
	146	return _("Portuguese")
	147	elif language == "ru":
	148	return _("Russian")
	149	elif language == "tr":
	150	return _("Turkish")
	151
	152	return language
	153
	154
9068dba1 MT	155	class MapModule(UIModule):
	156	def render(self, latitude, longitude):
	157	return self.render_string("modules/map.html", latitude=latitude, longitude=longitude)
	158
	159
940227cb MT	160	class MenuModule(UIModule):
940227cb MT	161	def render(self):
60024cc8	162	return self.render_string("modules/menu.html")
81675874	163
81675874	164
9068dba1 MT	165	class MirrorItemModule(UIModule):
	166	def render(self, item):
	167	return self.render_string("modules/mirror-item.html", item=item)
	168
	169
	170	class MirrorsTableModule(UIModule):
	171	def render(self, mirrors, preferred_mirrors=[]):
	172	return self.render_string("modules/mirrors-table.html",
	173	mirrors=mirrors, preferred_mirrors=preferred_mirrors)
	174
	175
	176	class NetBootMenuConfigModule(UIModule):
	177	def render(self, release):
	178	return self.render_string("netboot/menu-config.cfg", release=release)
	179
	180
	181	class NetBootMenuHeaderModule(UIModule):
	182	def render(self, title, releases):
	183	id = unicodedata.normalize("NFKD", unicode(title)).encode("ascii", "ignore")
	184	id = re.sub(r"[^\w]+", " ", id)
	185	id = "-".join(id.lower().strip().split())
	186
	187	return self.render_string("netboot/menu-header.cfg", id=id,
	188	title=title, releases=releases)
	189
	190
	191	class NetBootMenuSeparatorModule(UIModule):
	192	def render(self):
	193	return self.render_string("netboot/menu-separator.cfg")
	194
	195
81675874	196	class NewsItemModule(UIModule):
940227cb MT	197	def get_author(self, author):
	198	# Get name of author
	199	author = self.accounts.find(author)
	200	if author:
2fed2438	201	return author.name
940227cb MT	202	else:
	203	_ = self.locale.translate
	204	return _("Unknown author")
	205
60024cc8	206	def render(self, item, uncut=True, announcement=False, show_heading=True):
940227cb MT	207	# Get author
940227cb MT	208	item.author = self.get_author(item.author_id)
81675874	209
940227cb MT	210	if not uncut and len(item.text) >= 400:
940227cb MT	211	item.text = item.text[:400] + "..."
81675874	212
940227cb	213	# Render text
e46e8df8	214	item.text = textile.textile(item.text.decode("utf8"))
81675874	215
60024cc8 MT	216	return self.render_string("modules/news-item.html", item=item,
60024cc8 MT	217	uncut=uncut, announcement=announcement, show_heading=show_heading)
940227cb MT	218
940227cb MT	219
7771acea	220	class NewsLineModule(UIModule):
940227cb MT	221	def render(self, item):
	222	return self.render_string("modules/news-line.html", item=item)
	223
	224
7771acea MT	225	class NewsTableModule(UIModule):
	226	def render(self, news):
	227	return self.render_string("modules/news-table.html", news=news)
	228
	229
	230	class NewsYearNavigationModule(UIModule):
	231	def render(self, active=None):
	232	try:
	233	active = int(active)
	234	except:
	235	active = None
	236
	237	return self.render_string("modules/news-year-nav.html",
	238	active=active, years=self.news.years)
	239
	240
fa7e1a0a MT	241	class PlanetSearchBoxModule(UIModule):
	242	def render(self, query=None):
	243	years = self.planet.get_years()
	244
	245	return self.render_string("modules/planet/search-box.html",
	246	query=query, years=years)
	247
	248
81675874	249	class SidebarItemModule(UIModule):
	250	def render(self):
	251	return self.render_string("modules/sidebar-item.html")
	252
	253
	254	class SidebarReleaseModule(UIModule):
81675874	255	def render(self):
81675874	256	return self.render_string("modules/sidebar-release.html",
940227cb	257	latest=self.releases.get_latest())
81675874	258
	259
	260	class ReleaseItemModule(UIModule):
60024cc8	261	def render(self, release, latest=False):
110e8687	262	arches = ("i586", "arm")
60024cc8	263
110e8687 MT	264	downloads = []
	265	for arch in ("i586", "arm"):
	266	files = []
	267
	268	for file in release.files:
	269	if not file.arch == arch:
	270	continue
	271
	272	files.append(file)
	273
	274	if files:
	275	downloads.append((arch, files))
60024cc8 MT	276
60024cc8 MT	277	return self.render_string("modules/release-item.html",
110e8687	278	release=release, latest=latest, downloads=downloads)
81675874	279
	280
	281	class SidebarBannerModule(UIModule):
940227cb MT	282	def render(self, item=None):
	283	if not item:
	284	item = self.banners.get_random()
	285
81675874	286	return self.render_string("modules/sidebar-banner.html", item=item)
	287
	288
60024cc8 MT	289	class DownloadButtonModule(UIModule):
	290	def render(self, release, text="Download now!"):
	291	best_image = None
	292
	293	for file in release.files:
	294	if file.type == "iso":
	295	best_image = file
	296	break
	297
	298	# Show nothing when there was no image found.
	299	if not best_image:
	300	return ""
	301
	302	return self.render_string("modules/download-button.html",
	303	release=release, image=best_image)
	304
	305
d88b8f41 MT	306	class PlanetAuthorBoxModule(UIModule):
	307	def render(self, author):
	308	return self.render_string("planet/modules/author-box.html", author=author)
	309
	310
940227cb	311	class PlanetEntryModule(UIModule):
60024cc8	312	def render(self, entry, show_avatar=True):
940227cb	313	return self.render_string("modules/planet-entry.html",
60024cc8	314	entry=entry, show_avatar=show_avatar)
d0d074e0 MT	315
d0d074e0 MT	316
66862195 MT	317	class ProgressBarModule(UIModule):
	318	def render(self, value, colour=None):
	319	value *= 100
	320
	321	return self.render_string("modules/progress-bar.html",
	322	colour=colour, value=value)
	323
	324
	325	class TalkCallLogModule(UIModule):
	326	def render(self, calls):
	327	return self.render_string("talk/modules/call-log.html", calls=calls)
	328
	329
	330	class TalkOngoingCallsModule(UIModule):
	331	def render(self, calls):
	332	return self.render_string("talk/modules/ongoing-calls.html", calls=calls)
	333
	334
940227cb	335	class TrackerPeerListModule(UIModule):
6d524cba	336	def render(self, peers):
940227cb MT	337	# Guess country code and hostname of the host
940227cb MT	338	for peer in peers:
6d524cba MT	339	country_code = self.geoip.get_country(peer["ip"])
6d524cba MT	340	if country_code:
66862195 MT	341	peer["country_code"] = country_code.lower()
	342	else:
	343	peer["country_code"] = "unknown"
d0d074e0	344
940227cb MT	345	try:
	346	peer["hostname"] = socket.gethostbyaddr(peer["ip"])[0]
	347	except:
	348	peer["hostname"] = ""
d0d074e0	349
940227cb	350	return self.render_string("modules/tracker-peerlist.html",
e46e8df8	351	peers=[backend.database.Row(p) for p in peers])
372efc19 MT	352
372efc19 MT	353
7771acea MT	354	class WishlistModule(UIModule):
	355	def render(self, wishes, short=False):
	356	return self.render_string("wishlist/modules/wishlist.html",
	357	wishes=wishes, short=short)
	358
	359
	360	class WishModule(UIModule):
	361	def render(self, wish, short=False):
3907b320	362	progress_bar = "progress-bar-warning"
7771acea	363
f60b79ce	364	if wish.percentage >= 100:
3907b320	365	progress_bar = "progress-bar-success"
7771acea MT	366
	367	return self.render_string("wishlist/modules/wish.html",
	368	wish=wish, short=short, progress_bar=progress_bar)
	369
	370
e64ce07e MT	371	class WishlistItemsModule(UIModule):
	372	def render(self, wishlist_items):
	373	return self.render_string("modules/wishlist-items.html",
	374	wishlist_items=wishlist_items)
	375
	376
7771acea	377	class DonationBoxModule(UIModule):
e00c06b9	378	def render(self, reason_for_transfer=None):
353880e5 MT	379	if reason_for_transfer:
	380	reason_for_transfer = "IPFire.org - %s" % reason_for_transfer
	381
	382	return self.render_string("modules/donation-box.html",
e00c06b9 MT	383	reason_for_transfer=reason_for_transfer)
	384
	385
	386	class DonationButtonModule(UIModule):
	387	def render(self, reason_for_transfer=None, currency="EUR"):
	388	if not reason_for_transfer:
	389	reason_for_transfer = "IPFire.org"
	390
	391	primary = (currency == "EUR")
	392
	393	return self.render_string("modules/donation-button.html", primary=primary,
	394	reason_for_transfer=reason_for_transfer, currency=currency)