[people/jschlag/pbs.git] / web / ui_modules.py

#!/usr/bin/python

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

		bz_url = self.settings.get("bugzilla_url", "")
		bz_pattern = re.compile(r"(bug\s?|#)(\d+)")
		bz_repl = link % (bz_url % { "bugid" : r"\2" }, r"\1\2")

		cve_url = self.settings.get("cve_url", "")
		cve_pattern = re.compile(r"(CVE)(\s|\-)(\d{4}\-\d{4})")
		cve_repl = link % (cve_url % r"\3", r"\1\2\3")

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

		o = []
		for p in text.splitlines():
			# Escape the text and create make urls clickable.
			p = tornado.escape.xhtml_escape(p)
			p = tornado.escape.linkify(p, shorten=True,
				extra_params='target="_blank"')

			# Search for bug ids that need to be linked to bugzilla.
			if bz_url:
				p = re.sub(bz_pattern, bz_repl, p, re.I|re.U)

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

			o.append(p)

		o = "\n".join(o)

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

		return textile.textile(o)


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)
Commit	Line	Data
f6e6ff79	1	#!/usr/bin/python
9137135a	2
f6e6ff79 MT	3	import re
f6e6ff79 MT	4	import string
e434b018	5	import textile
f6e6ff79	6	import tornado.escape
9137135a MT	7	import tornado.web
9137135a MT	8
f6e6ff79	9	import backend.users
9137135a MT	10	from backend.constants import *
	11
	12	class UIModule(tornado.web.UIModule):
	13	@property
	14	def pakfire(self):
	15	return self.handler.application.pakfire
	16
f6e6ff79 MT	17	@property
	18	def settings(self):
	19	return self.pakfire.settings
	20
	21
	22	class TextModule(UIModule):
c21cb4ec	23	def render(self, text, pre=False, remove_linebreaks=True):
f6e6ff79 MT	24	link = """<a href="%s" target="_blank">%s</a>"""
	25
	26	bz_url = self.settings.get("bugzilla_url", "")
	27	bz_pattern = re.compile(r"(bug\s?\|#)(\d+)")
	28	bz_repl = link % (bz_url % { "bugid" : r"\2" }, r"\1\2")
	29
	30	cve_url = self.settings.get("cve_url", "")
	31	cve_pattern = re.compile(r"(CVE)(\s\|\-)(\d{4}\-\d{4})")
	32	cve_repl = link % (cve_url % r"\3", r"\1\2\3")
	33
c21cb4ec MT	34	if remove_linebreaks:
	35	text = text.replace("\n", " ")
	36
f6e6ff79 MT	37	o = []
	38	for p in text.splitlines():
	39	# Escape the text and create make urls clickable.
	40	p = tornado.escape.xhtml_escape(p)
	41	p = tornado.escape.linkify(p, shorten=True,
	42	extra_params='target="_blank"')
	43
	44	# Search for bug ids that need to be linked to bugzilla.
	45	if bz_url:
	46	p = re.sub(bz_pattern, bz_repl, p, re.I\|re.U)
	47
	48	# Search for CVE numbers and create hyperlinks.
	49	if cve_url:
	50	p = re.sub(cve_pattern, cve_repl, p, re.I\|re.U)
	51
	52	o.append(p)
	53
	54	o = "\n".join(o)
	55
	56	if pre:
	57	return "<pre>%s</pre>" % o
	58
e434b018	59	return textile.textile(o)
f6e6ff79 MT	60
	61
	62	class ModalModule(UIModule):
	63	def render(self, what, **kwargs):
	64	what = "modules/modal-%s.html" % what
9137135a	65
f6e6ff79 MT	66	return self.render_string(what, **kwargs)
	67
	68
	69	class BuildHeadlineModule(UIModule):
	70	def render(self, prefix, build, short=False, shorter=False):
	71	if shorter:
	72	short = True
	73
	74	return self.render_string("modules/build-headline.html",
	75	prefix=prefix, build=build, pkg=build.pkg, short=short, shorter=shorter)
	76
	77
	78	class BugsTableModule(UIModule):
	79	def render(self, pkg, bugs):
	80	return self.render_string("modules/bugs-table.html",
	81	pkg=pkg, bugs=bugs)
	82
	83
4b1e87c4 MT	84	class ChangelogModule(UIModule):
	85	def render(self, name=None, builds=None, args, *kwargs):
	86	if not builds:
	87	builds = self.pakfire.builds.get_changelog(name, args, *kwargs)
	88
	89	return self.render_string("modules/changelog/index.html", builds=builds)
	90
	91
	92	class ChangelogEntryModule(UIModule):
	93	def render(self, build):
	94	return self.render_string("modules/changelog/entry.html", build=build)
	95
	96
f6e6ff79 MT	97	class CommitsTableModule(UIModule):
	98	def render(self, distro, source, commits, full_format=True):
	99	return self.render_string("modules/commits-table.html",
	100	distro=distro, source=source, commits=commits,
	101	full_format=full_format)
	102
	103
	104	class FooterModule(UIModule):
	105	def render(self):
	106	return self.render_string("modules/footer.html")
	107
	108
	109	class PackagesTableModule(UIModule):
	110	def render(self, job, packages):
	111	return self.render_string("modules/packages-table.html", job=job,
	112	packages=packages)
9137135a MT	113
	114
	115	class PackageTable2Module(UIModule):
	116	def render(self, packages):
	117	return self.render_string("modules/package-table-detail.html",
	118	packages=packages)
	119
	120
	121	class FilesTableModule(UIModule):
	122	def render(self, files):
	123	return self.render_string("modules/files-table.html", files=files)
	124
	125
f6e6ff79 MT	126	class LogFilesTableModule(UIModule):
	127	def render(self, job, files):
	128	return self.render_string("modules/log-files-table.html", job=job,
	129	files=files)
	130
	131
	132	class PackageHeaderModule(UIModule):
	133	def render(self, pkg):
	134	return self.render_string("modules/package-header.html", pkg=pkg)
	135
	136
9137135a	137	class PackageFilesTableModule(UIModule):
f6e6ff79 MT	138	def render(self, pkg, filelist):
	139	return self.render_string("modules/packages-files-table.html",
	140	pkg=pkg, filelist=filelist)
9137135a MT	141
	142
	143	class BuildTableModule(UIModule):
f6e6ff79 MT	144	def render(self, builds, **kwargs):
	145	settings = dict(
	146	show_user = False,
	147	show_repo = False,
	148	show_repo_time = False,
	149	show_can_move_forward = False,
	150	show_when = True,
	151	)
	152	settings.update(kwargs)
	153
	154	return self.render_string("modules/build-table.html",
	155	builds=builds, **settings)
	156
	157
	158	class BuildStateWarningsModule(UIModule):
	159	def render(self, build):
	160	return self.render_string("modules/build-state-warnings.html", build=build)
	161
	162
	163	class JobsTableModule(UIModule):
	164	def render(self, build, jobs=None, type="release"):
	165	if jobs is None:
	166	jobs = build.jobs
	167
	168	return self.render_string("modules/jobs-table.html", build=build,
	169	jobs=jobs, type=type)
	170
	171
	172	class JobsListModule(UIModule):
	173	def render(self, jobs, show_builder=False):
	174	return self.render_string("modules/jobs-list.html", jobs=jobs,
	175	show_builder=show_builder)
9137135a MT	176
	177
	178	class RepositoryTableModule(UIModule):
	179	def render(self, distro, repos):
	180	return self.render_string("modules/repository-table.html",
	181	distro=distro, repos=repos)
	182
	183
	184	class SourceTableModule(UIModule):
	185	def render(self, distro, sources):
	186	return self.render_string("modules/source-table.html",
	187	distro=distro, sources=sources)
	188
	189
	190	class CommentsTableModule(UIModule):
	191	def render(self, comments, show_package=False, show_user=True):
	192	pkgs, users = {}, {}
	193	for comment in comments:
	194	if show_package:
	195	try:
	196	pkg = pkgs[comment.pkg_id]
	197	except KeyError:
	198	pkg = pkgs[comment.pkg_id] = \
	199	self.pakfire.packages.get_by_id(comment.pkg_id)
	200
	201	comment["pkg"] = pkg
	202
	203	if show_user:
	204	try:
	205	user = users[comment.user_id]
	206	except KeyError:
	207	user = users[comment.user_id] = \
	208	self.pakfire.users.get_by_id(comment.user_id)
	209
	210	comment["user"] = user
	211
	212	return self.render_string("modules/comments-table.html",
	213	comments=comments, show_package=show_package, show_user=show_user)
	214
	215
f6e6ff79 MT	216	class LogModule(UIModule):
	217	def render(self, entries, **args):
	218	return self.render_string("modules/log.html",
	219	entries=entries, args=args)
	220
	221
	222	class LogEntryModule(UIModule):
e434b018 MT	223	def render(self, entry, small=None, **args):
	224	if small or entry.system_msg:
	225	template = "modules/log-entry-small.html"
	226	else:
	227	template = "modules/log-entry.html"
	228
	229	return self.render_string(template, entry=entry, u=entry.user, **args)
f6e6ff79 MT	230
	231
	232	class LogEntryCommentModule(LogEntryModule):
	233	def render(self, entry, **args):
	234	return self.render_string("modules/log-entry-comment.html",
e434b018	235	entry=entry, u=entry.user, **args)
f6e6ff79 MT	236
	237
	238	class MaintainerModule(UIModule):
	239	def render(self, maintainer):
	240	if isinstance(maintainer, backend.users.User):
	241	type = "user"
	242	else:
	243	type = "string"
	244
	245	return self.render_string("modules/maintainer.html",
	246	type=type, maintainer=maintainer)
	247
	248
9137135a MT	249	class BuildLogModule(UIModule):
	250	# XXX deprecated
	251	def render(self, messages):
	252	_ = self.locale.translate
	253
	254	for message in messages:
	255	try:
	256	msg = LOG2MSG[message.message]
	257	message["message"] = _(msg)
	258	except KeyError:
	259	pass
	260
	261	return self.render_string("modules/build-log.html", messages=messages)
	262
	263
	264	class LogTableModule(UIModule):
	265	def render(self, messages, links=["pkg",]):
	266	for message in messages:
	267	try:
	268	message["message"] = LOG2MSG[message.message]
	269	except KeyError:
	270	pass
	271
	272	if message.build_id:
	273	message["build"] = self.pakfire.builds.get_by_id(message.build_id)
	274
	275	elif message.pkg_id:
	276	message["pkg"] = self.pakfire.packages.get_by_id(message.pkg_id)
	277
	278	return self.render_string("modules/log-table.html",
	279	messages=messages, links=links)
	280
	281
	282	class UsersTableModule(UIModule):
	283	def render(self, users):
	284	return self.render_string("modules/user-table.html", users=users)
	285
	286
	287	class BuildOffsetModule(UIModule):
	288	def render(self):
	289	return self.render_string("modules/build-offset.html")
	290
	291
	292	class RepoActionsTableModule(UIModule):
	293	def render(self, repo):
	294	actions = repo.get_actions()
	295
	296	return self.render_string("modules/repo-actions-table.html",
	297	repo=repo, actions=actions)
f6e6ff79 MT	298
	299
	300	class UpdatesTableModule(UIModule):
	301	def render(self, updates):
	302	return self.render_string("modules/updates-table.html", updates=updates)
	303
	304
	305	class WatchersSidebarTableModule(UIModule):
	306	def css_files(self):
	307	return "css/watchers-sidebar-table.css"
	308
	309	def render(self, build, watchers, limit=5):
	310	# Sort the watchers by their realname.
	311	watchers.sort(key=lambda watcher: watcher.realname)
	312
	313	return self.render_string("modules/watchers-sidebar-table.html",
	314	build=build, watchers=watchers, limit=limit)