[pbs.git] / web / ui_modules.py

#!/usr/bin/python

import pytz
import re
import string
import textile
import tornado.escape
import tornado.web

import backend.users
from backend.constants import *

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

	@property
	def settings(self):
		return self.pakfire.settings


class TextModule(UIModule):
	__cache = {}

	LINK = """<a href="%s" target="_blank">%s</a>"""

	@property
	def bugzilla_url(self):
		return self.settings.get("bugzilla_url", "")

	@property
	def bugzilla_pattern(self):
		if not self.__cache.has_key("bugzilla_pattern"):
			self.__cache["bugzilla_pattern"] = re.compile(BUGZILLA_PATTERN)

		return self.__cache["bugzilla_pattern"]

	@property
	def bugzilla_repl(self):
		return self.LINK % (self.bugzilla_url % { "bugid" : r"\2" }, r"\1\2")

	@property
	def cve_url(self):
		return self.settings.get("cve_url", "")

	@property
	def cve_pattern(self):
		if not self.__cache.has_key("cve_pattern"):
			self.__cache["cve_pattern"] = re.compile(CVE_PATTERN)

		return self.__cache["cve_pattern"]

	@property
	def cve_repl(self):
		return self.LINK % (self.cve_url % r"\3", r"\1\2\3")

	def render(self, text, pre=False, remove_linebreaks=True):
		link = """<a href="%s" target="_blank">%s</a>"""

		if remove_linebreaks:
			text = text.replace("\n", " ")

		# Escape the text and create make urls clickable.
		text = tornado.escape.xhtml_escape(text)
		text = tornado.escape.linkify(text, shorten=True,
			extra_params='target="_blank"')

		# Search for bug ids that need to be linked to bugzilla.
		if self.bugzilla_url:
			text = re.sub(self.bugzilla_pattern, self.bugzilla_repl, text, re.I|re.U)

		# Search for CVE numbers and create hyperlinks.
		if self.cve_url:
			text = re.sub(self.cve_pattern, self.cve_repl, text, re.I|re.U)

		if pre:
			return "<pre>%s</pre>" % text

		return textile.textile(text)


class ModalModule(UIModule):
	def render(self, what, **kwargs):
		what = "modules/modal-%s.html" % what

		return self.render_string(what, **kwargs)


class BuildHeadlineModule(UIModule):
	def render(self, prefix, build, short=False, shorter=False):
		if shorter:
			short = True

		return self.render_string("modules/build-headline.html",
			prefix=prefix, build=build, pkg=build.pkg, short=short, shorter=shorter)


class BugsTableModule(UIModule):
	def render(self, pkg, bugs):
		return self.render_string("modules/bugs-table.html",
			pkg=pkg, bugs=bugs)


class ChangelogModule(UIModule):
	def render(self, name=None, builds=None, *args, **kwargs):
		if not builds:
			builds = self.pakfire.builds.get_changelog(name, *args, **kwargs)

		return self.render_string("modules/changelog/index.html", builds=builds)


class ChangelogEntryModule(UIModule):
	def render(self, build):
		return self.render_string("modules/changelog/entry.html", build=build)


class CommitsTableModule(UIModule):
	def render(self, distro, source, commits, full_format=True):
		return self.render_string("modules/commits-table.html",
			distro=distro, source=source, commits=commits,
			full_format=full_format)


class FooterModule(UIModule):
	def render(self):
		return self.render_string("modules/footer.html")


class PackagesTableModule(UIModule):
	def render(self, job, packages):
		return self.render_string("modules/packages-table.html", job=job,
			packages=packages)


class PackageTable2Module(UIModule):
	def render(self, packages):
		return self.render_string("modules/package-table-detail.html",
			packages=packages)


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


class LogFilesTableModule(UIModule):
	def render(self, job, files):
		return self.render_string("modules/log-files-table.html", job=job,
			files=files)


class PackageHeaderModule(UIModule):
	def render(self, pkg):
		return self.render_string("modules/package-header.html", pkg=pkg)


class PackageFilesTableModule(UIModule):
	def render(self, pkg, filelist):
		return self.render_string("modules/packages-files-table.html",
			pkg=pkg, filelist=filelist)


class BuildTableModule(UIModule):
	def render(self, builds, **kwargs):
		settings = dict(
			show_user = False,
			show_repo = False,
			show_repo_time = False,
			show_can_move_forward = False,
			show_when = True,
		)
		settings.update(kwargs)

		return self.render_string("modules/build-table.html",
			builds=builds, **settings)


class BuildStateWarningsModule(UIModule):
	def render(self, build):
		return self.render_string("modules/build-state-warnings.html", build=build)


class JobsTableModule(UIModule):
	def render(self, build, jobs=None, type="release"):
		if jobs is None:
			jobs = build.jobs

		return self.render_string("modules/jobs-table.html", build=build,
			jobs=jobs, type=type)


class JobsListModule(UIModule):
	def render(self, jobs, show_builder=False):
		return self.render_string("modules/jobs-list.html", jobs=jobs,
			show_builder=show_builder)


class RepositoryTableModule(UIModule):
	def render(self, distro, repos):
		return self.render_string("modules/repository-table.html",
			distro=distro, repos=repos)


class SourceTableModule(UIModule):
	def render(self, distro, sources):
		return self.render_string("modules/source-table.html",
			distro=distro, sources=sources)


class CommentsTableModule(UIModule):
	def render(self, comments, show_package=False, show_user=True):
		pkgs, users = {}, {}
		for comment in comments:
			if show_package:
				try:
					pkg = pkgs[comment.pkg_id]
				except KeyError:
					pkg = pkgs[comment.pkg_id] = \
						self.pakfire.packages.get_by_id(comment.pkg_id)

				comment["pkg"] = pkg

			if show_user:
				try:
					user = users[comment.user_id]
				except KeyError:
					user = users[comment.user_id] = \
						self.pakfire.users.get_by_id(comment.user_id)

				comment["user"] = user

		return self.render_string("modules/comments-table.html",
			comments=comments, show_package=show_package, show_user=show_user)


class LogModule(UIModule):
	def render(self, entries, **args):
		return self.render_string("modules/log.html",
			entries=entries, args=args)


class LogEntryModule(UIModule):
	def render(self, entry, small=None, **args):
		if small or entry.system_msg:
			template = "modules/log-entry-small.html"
		else:
			template = "modules/log-entry.html"

		return self.render_string(template, entry=entry, u=entry.user, **args)


class LogEntryCommentModule(LogEntryModule):
	def render(self, entry, **args):
		return self.render_string("modules/log-entry-comment.html",
			entry=entry, u=entry.user, **args)


class MaintainerModule(UIModule):
	def render(self, maintainer):
		if isinstance(maintainer, backend.users.User):
			type = "user"
		else:
			type = "string"

		return self.render_string("modules/maintainer.html",
			type=type, maintainer=maintainer)


class BuildLogModule(UIModule):
	# XXX deprecated
	def render(self, messages):
		_ = self.locale.translate

		for message in messages:
			try:
				msg = LOG2MSG[message.message]
				message["message"] = _(msg)
			except KeyError:
				pass

		return self.render_string("modules/build-log.html", messages=messages)


class LogTableModule(UIModule):
	def render(self, messages, links=["pkg",]):
		for message in messages:
			try:
				message["message"] = LOG2MSG[message.message]
			except KeyError:
				pass

			if message.build_id:
				message["build"] = self.pakfire.builds.get_by_id(message.build_id)

			elif message.pkg_id:
				message["pkg"] = self.pakfire.packages.get_by_id(message.pkg_id)

		return self.render_string("modules/log-table.html",
			messages=messages, links=links)


class UsersTableModule(UIModule):
	def render(self, users):
		return self.render_string("modules/user-table.html", users=users)


class BuildOffsetModule(UIModule):
	def render(self):
		return self.render_string("modules/build-offset.html")


class RepoActionsTableModule(UIModule):
	def render(self, repo):
		actions = repo.get_actions()

		return self.render_string("modules/repo-actions-table.html",
			repo=repo, actions=actions)


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


class WatchersSidebarTableModule(UIModule):
	def css_files(self):
		return "css/watchers-sidebar-table.css"

	def render(self, build, watchers, limit=5):
		# Sort the watchers by their realname.
		watchers.sort(key=lambda watcher: watcher.realname)

		return self.render_string("modules/watchers-sidebar-table.html",
			build=build, watchers=watchers, limit=limit)


class SelectLocaleModule(UIModule):
	LOCALE_NAMES = (
		# local code, English name, name
		("ca_ES", u"Catalan", "Catal\xc3\xa0"),
		("da_DK", u"Danish", u"Dansk"),
		("de_DE", u"German", u"Deutsch"),
		("en_GB", u"English (UK)", u"English (UK)"),
		("en_US", u"English (US)", u"English (US)"),
		("es_ES", u"Spanish (Spain)", u"Espa\xf1ol (Espa\xf1a)"),
		("es_LA", u"Spanish", u"Espa\xf1ol"),
		("fr_CA", u"French (Canada)", u"Fran\xe7ais (Canada)"),
		("fr_FR", u"French", u"Fran\xe7ais"),
		("it_IT", u"Italian", u"Italiano"),
		("km_KH", u"Khmer", u"\u1797\u17b6\u179f\u17b6\u1781\u17d2\u1798\u17c2\u179a"),
		("pt_BR", u"Portuguese (Brazil)", u"Portugu\xeas (Brasil)"),
		("pt_PT", u"Portuguese (Portugal)", u"Portugu\xeas (Portugal)"),
		("ru_RU", u"Russian", u"\u0440\u0443\u0441\u0441\u043a\u0438\u0439"),
	)

	def render(self, name=None, id=None, preselect=None):
		return self.render_string("modules/select/locale.html",
			name=name, id=id, preselect=preselect, supported_locales=self.LOCALE_NAMES)


class SelectTimezoneModule(UIModule):
	def render(self, name=None, id=None, preselect=None):
		return self.render_string("modules/select/timezone.html",
			name=name, id=id, preselect=preselect,
			supported_timezones=pytz.common_timezones)
Commit	Line	Data
f6e6ff79	1	#!/usr/bin/python
9137135a	2
cd870d0a	3	import pytz
f6e6ff79 MT	4	import re
f6e6ff79 MT	5	import string
e434b018	6	import textile
f6e6ff79	7	import tornado.escape
9137135a MT	8	import tornado.web
9137135a MT	9
f6e6ff79	10	import backend.users
9137135a MT	11	from backend.constants import *
	12
	13	class UIModule(tornado.web.UIModule):
	14	@property
	15	def pakfire(self):
	16	return self.handler.application.pakfire
	17
f6e6ff79 MT	18	@property
	19	def settings(self):
	20	return self.pakfire.settings
	21
	22
	23	class TextModule(UIModule):
c764ce43	24	__cache = {}
f6e6ff79	25
c764ce43	26	LINK = """<a href="%s" target="_blank">%s</a>"""
f6e6ff79	27
c764ce43 MT	28	@property
	29	def bugzilla_url(self):
	30	return self.settings.get("bugzilla_url", "")
f6e6ff79	31
c764ce43 MT	32	@property
	33	def bugzilla_pattern(self):
	34	if not self.__cache.has_key("bugzilla_pattern"):
	35	self.__cache["bugzilla_pattern"] = re.compile(BUGZILLA_PATTERN)
	36
	37	return self.__cache["bugzilla_pattern"]
	38
	39	@property
	40	def bugzilla_repl(self):
	41	return self.LINK % (self.bugzilla_url % { "bugid" : r"\2" }, r"\1\2")
	42
	43	@property
	44	def cve_url(self):
	45	return self.settings.get("cve_url", "")
	46
	47	@property
	48	def cve_pattern(self):
	49	if not self.__cache.has_key("cve_pattern"):
	50	self.__cache["cve_pattern"] = re.compile(CVE_PATTERN)
	51
	52	return self.__cache["cve_pattern"]
	53
	54	@property
	55	def cve_repl(self):
	56	return self.LINK % (self.cve_url % r"\3", r"\1\2\3")
c21cb4ec	57
c764ce43 MT	58	def render(self, text, pre=False, remove_linebreaks=True):
c764ce43 MT	59	link = """<a href="%s" target="_blank">%s</a>"""
f6e6ff79	60
c764ce43 MT	61	if remove_linebreaks:
c764ce43 MT	62	text = text.replace("\n", " ")
f6e6ff79	63
c764ce43 MT	64	# Escape the text and create make urls clickable.
	65	text = tornado.escape.xhtml_escape(text)
	66	text = tornado.escape.linkify(text, shorten=True,
	67	extra_params='target="_blank"')
f6e6ff79	68
c764ce43 MT	69	# Search for bug ids that need to be linked to bugzilla.
	70	if self.bugzilla_url:
	71	text = re.sub(self.bugzilla_pattern, self.bugzilla_repl, text, re.I\|re.U)
f6e6ff79	72
c764ce43 MT	73	# Search for CVE numbers and create hyperlinks.
	74	if self.cve_url:
	75	text = re.sub(self.cve_pattern, self.cve_repl, text, re.I\|re.U)
f6e6ff79 MT	76
f6e6ff79 MT	77	if pre:
c764ce43	78	return "<pre>%s</pre>" % text
f6e6ff79	79
c764ce43	80	return textile.textile(text)
f6e6ff79 MT	81
	82
	83	class ModalModule(UIModule):
	84	def render(self, what, **kwargs):
	85	what = "modules/modal-%s.html" % what
9137135a	86
f6e6ff79 MT	87	return self.render_string(what, **kwargs)
	88
	89
	90	class BuildHeadlineModule(UIModule):
	91	def render(self, prefix, build, short=False, shorter=False):
	92	if shorter:
	93	short = True
	94
	95	return self.render_string("modules/build-headline.html",
	96	prefix=prefix, build=build, pkg=build.pkg, short=short, shorter=shorter)
	97
	98
	99	class BugsTableModule(UIModule):
	100	def render(self, pkg, bugs):
	101	return self.render_string("modules/bugs-table.html",
	102	pkg=pkg, bugs=bugs)
	103
	104
4b1e87c4 MT	105	class ChangelogModule(UIModule):
	106	def render(self, name=None, builds=None, args, *kwargs):
	107	if not builds:
	108	builds = self.pakfire.builds.get_changelog(name, args, *kwargs)
	109
	110	return self.render_string("modules/changelog/index.html", builds=builds)
	111
	112
	113	class ChangelogEntryModule(UIModule):
	114	def render(self, build):
	115	return self.render_string("modules/changelog/entry.html", build=build)
	116
	117
f6e6ff79 MT	118	class CommitsTableModule(UIModule):
	119	def render(self, distro, source, commits, full_format=True):
	120	return self.render_string("modules/commits-table.html",
	121	distro=distro, source=source, commits=commits,
	122	full_format=full_format)
	123
	124
	125	class FooterModule(UIModule):
	126	def render(self):
	127	return self.render_string("modules/footer.html")
	128
	129
	130	class PackagesTableModule(UIModule):
	131	def render(self, job, packages):
	132	return self.render_string("modules/packages-table.html", job=job,
	133	packages=packages)
9137135a MT	134
	135
	136	class PackageTable2Module(UIModule):
	137	def render(self, packages):
	138	return self.render_string("modules/package-table-detail.html",
	139	packages=packages)
	140
	141
	142	class FilesTableModule(UIModule):
	143	def render(self, files):
	144	return self.render_string("modules/files-table.html", files=files)
	145
	146
f6e6ff79 MT	147	class LogFilesTableModule(UIModule):
	148	def render(self, job, files):
	149	return self.render_string("modules/log-files-table.html", job=job,
	150	files=files)
	151
	152
	153	class PackageHeaderModule(UIModule):
	154	def render(self, pkg):
	155	return self.render_string("modules/package-header.html", pkg=pkg)
	156
	157
9137135a	158	class PackageFilesTableModule(UIModule):
f6e6ff79 MT	159	def render(self, pkg, filelist):
	160	return self.render_string("modules/packages-files-table.html",
	161	pkg=pkg, filelist=filelist)
9137135a MT	162
	163
	164	class BuildTableModule(UIModule):
f6e6ff79 MT	165	def render(self, builds, **kwargs):
	166	settings = dict(
	167	show_user = False,
	168	show_repo = False,
	169	show_repo_time = False,
	170	show_can_move_forward = False,
	171	show_when = True,
	172	)
	173	settings.update(kwargs)
	174
	175	return self.render_string("modules/build-table.html",
	176	builds=builds, **settings)
	177
	178
	179	class BuildStateWarningsModule(UIModule):
	180	def render(self, build):
	181	return self.render_string("modules/build-state-warnings.html", build=build)
	182
	183
	184	class JobsTableModule(UIModule):
	185	def render(self, build, jobs=None, type="release"):
	186	if jobs is None:
	187	jobs = build.jobs
	188
	189	return self.render_string("modules/jobs-table.html", build=build,
	190	jobs=jobs, type=type)
	191
	192
	193	class JobsListModule(UIModule):
	194	def render(self, jobs, show_builder=False):
	195	return self.render_string("modules/jobs-list.html", jobs=jobs,
	196	show_builder=show_builder)
9137135a MT	197
	198
	199	class RepositoryTableModule(UIModule):
	200	def render(self, distro, repos):
	201	return self.render_string("modules/repository-table.html",
	202	distro=distro, repos=repos)
	203
	204
	205	class SourceTableModule(UIModule):
	206	def render(self, distro, sources):
	207	return self.render_string("modules/source-table.html",
	208	distro=distro, sources=sources)
	209
	210
	211	class CommentsTableModule(UIModule):
	212	def render(self, comments, show_package=False, show_user=True):
	213	pkgs, users = {}, {}
	214	for comment in comments:
	215	if show_package:
	216	try:
	217	pkg = pkgs[comment.pkg_id]
	218	except KeyError:
	219	pkg = pkgs[comment.pkg_id] = \
	220	self.pakfire.packages.get_by_id(comment.pkg_id)
	221
	222	comment["pkg"] = pkg
	223
	224	if show_user:
	225	try:
	226	user = users[comment.user_id]
	227	except KeyError:
	228	user = users[comment.user_id] = \
	229	self.pakfire.users.get_by_id(comment.user_id)
	230
	231	comment["user"] = user
	232
	233	return self.render_string("modules/comments-table.html",
	234	comments=comments, show_package=show_package, show_user=show_user)
	235
	236
f6e6ff79 MT	237	class LogModule(UIModule):
	238	def render(self, entries, **args):
	239	return self.render_string("modules/log.html",
	240	entries=entries, args=args)
	241
	242
	243	class LogEntryModule(UIModule):
e434b018 MT	244	def render(self, entry, small=None, **args):
	245	if small or entry.system_msg:
	246	template = "modules/log-entry-small.html"
	247	else:
	248	template = "modules/log-entry.html"
	249
	250	return self.render_string(template, entry=entry, u=entry.user, **args)
f6e6ff79 MT	251
	252
	253	class LogEntryCommentModule(LogEntryModule):
	254	def render(self, entry, **args):
	255	return self.render_string("modules/log-entry-comment.html",
e434b018	256	entry=entry, u=entry.user, **args)
f6e6ff79 MT	257
	258
	259	class MaintainerModule(UIModule):
	260	def render(self, maintainer):
	261	if isinstance(maintainer, backend.users.User):
	262	type = "user"
	263	else:
	264	type = "string"
	265
	266	return self.render_string("modules/maintainer.html",
	267	type=type, maintainer=maintainer)
	268
	269
9137135a MT	270	class BuildLogModule(UIModule):
	271	# XXX deprecated
	272	def render(self, messages):
	273	_ = self.locale.translate
	274
	275	for message in messages:
	276	try:
	277	msg = LOG2MSG[message.message]
	278	message["message"] = _(msg)
	279	except KeyError:
	280	pass
	281
	282	return self.render_string("modules/build-log.html", messages=messages)
	283
	284
	285	class LogTableModule(UIModule):
	286	def render(self, messages, links=["pkg",]):
	287	for message in messages:
	288	try:
	289	message["message"] = LOG2MSG[message.message]
	290	except KeyError:
	291	pass
	292
	293	if message.build_id:
	294	message["build"] = self.pakfire.builds.get_by_id(message.build_id)
	295
	296	elif message.pkg_id:
	297	message["pkg"] = self.pakfire.packages.get_by_id(message.pkg_id)
	298
	299	return self.render_string("modules/log-table.html",
	300	messages=messages, links=links)
	301
	302
	303	class UsersTableModule(UIModule):
	304	def render(self, users):
	305	return self.render_string("modules/user-table.html", users=users)
	306
	307
	308	class BuildOffsetModule(UIModule):
	309	def render(self):
	310	return self.render_string("modules/build-offset.html")
	311
	312
	313	class RepoActionsTableModule(UIModule):
	314	def render(self, repo):
	315	actions = repo.get_actions()
	316
	317	return self.render_string("modules/repo-actions-table.html",
	318	repo=repo, actions=actions)
f6e6ff79 MT	319
	320
	321	class UpdatesTableModule(UIModule):
	322	def render(self, updates):
	323	return self.render_string("modules/updates-table.html", updates=updates)
	324
	325
	326	class WatchersSidebarTableModule(UIModule):
	327	def css_files(self):
	328	return "css/watchers-sidebar-table.css"
	329
	330	def render(self, build, watchers, limit=5):
	331	# Sort the watchers by their realname.
	332	watchers.sort(key=lambda watcher: watcher.realname)
	333
	334	return self.render_string("modules/watchers-sidebar-table.html",
	335	build=build, watchers=watchers, limit=limit)
cd870d0a MT	336
	337
	338	class SelectLocaleModule(UIModule):
	339	LOCALE_NAMES = (
	340	# local code, English name, name
	341	("ca_ES", u"Catalan", "Catal\xc3\xa0"),
	342	("da_DK", u"Danish", u"Dansk"),
	343	("de_DE", u"German", u"Deutsch"),
	344	("en_GB", u"English (UK)", u"English (UK)"),
	345	("en_US", u"English (US)", u"English (US)"),
	346	("es_ES", u"Spanish (Spain)", u"Espa\xf1ol (Espa\xf1a)"),
	347	("es_LA", u"Spanish", u"Espa\xf1ol"),
	348	("fr_CA", u"French (Canada)", u"Fran\xe7ais (Canada)"),
	349	("fr_FR", u"French", u"Fran\xe7ais"),
	350	("it_IT", u"Italian", u"Italiano"),
	351	("km_KH", u"Khmer", u"\u1797\u17b6\u179f\u17b6\u1781\u17d2\u1798\u17c2\u179a"),
	352	("pt_BR", u"Portuguese (Brazil)", u"Portugu\xeas (Brasil)"),
	353	("pt_PT", u"Portuguese (Portugal)", u"Portugu\xeas (Portugal)"),
	354	("ru_RU", u"Russian", u"\u0440\u0443\u0441\u0441\u043a\u0438\u0439"),
	355	)
	356
	357	def render(self, name=None, id=None, preselect=None):
	358	return self.render_string("modules/select/locale.html",
	359	name=name, id=id, preselect=preselect, supported_locales=self.LOCALE_NAMES)
	360
	361
	362	class SelectTimezoneModule(UIModule):
	363	def render(self, name=None, id=None, preselect=None):
	364	return self.render_string("modules/select/timezone.html",
	365	name=name, id=id, preselect=preselect,
	366	supported_timezones=pytz.common_timezones)