qmsk.irclogs: log_formatter.py@f13cf27a360b (annotated)

50 f13cf27a360b implement more LogSource features (logs for date, cleanup last_logs), implement irssi parser, formatter, other misc. stuff Tero Marttila <terom@fixme.fi> parents: diff changeset	1	"""
f13cf27a360b implement more LogSource features (logs for date, cleanup last_logs), implement irssi parser, formatter, other misc. stuff Tero Marttila <terom@fixme.fi> parents: diff changeset	2	Format LogLines into some other representation
f13cf27a360b implement more LogSource features (logs for date, cleanup last_logs), implement irssi parser, formatter, other misc. stuff Tero Marttila <terom@fixme.fi> parents: diff changeset	3	"""
f13cf27a360b implement more LogSource features (logs for date, cleanup last_logs), implement irssi parser, formatter, other misc. stuff Tero Marttila <terom@fixme.fi> parents: diff changeset	4
f13cf27a360b implement more LogSource features (logs for date, cleanup last_logs), implement irssi parser, formatter, other misc. stuff Tero Marttila <terom@fixme.fi> parents: diff changeset	5	from qmsk.web import helpers
f13cf27a360b implement more LogSource features (logs for date, cleanup last_logs), implement irssi parser, formatter, other misc. stuff Tero Marttila <terom@fixme.fi> parents: diff changeset	6
f13cf27a360b implement more LogSource features (logs for date, cleanup last_logs), implement irssi parser, formatter, other misc. stuff Tero Marttila <terom@fixme.fi> parents: diff changeset	7	from log_line import LogTypes
f13cf27a360b implement more LogSource features (logs for date, cleanup last_logs), implement irssi parser, formatter, other misc. stuff Tero Marttila <terom@fixme.fi> parents: diff changeset	8
f13cf27a360b implement more LogSource features (logs for date, cleanup last_logs), implement irssi parser, formatter, other misc. stuff Tero Marttila <terom@fixme.fi> parents: diff changeset	9	class LogFormatter (object) :
f13cf27a360b implement more LogSource features (logs for date, cleanup last_logs), implement irssi parser, formatter, other misc. stuff Tero Marttila <terom@fixme.fi> parents: diff changeset	10	"""
f13cf27a360b implement more LogSource features (logs for date, cleanup last_logs), implement irssi parser, formatter, other misc. stuff Tero Marttila <terom@fixme.fi> parents: diff changeset	11	Provides a method to format series of LogLines into various output formats, with varying themes
f13cf27a360b implement more LogSource features (logs for date, cleanup last_logs), implement irssi parser, formatter, other misc. stuff Tero Marttila <terom@fixme.fi> parents: diff changeset	12	"""
f13cf27a360b implement more LogSource features (logs for date, cleanup last_logs), implement irssi parser, formatter, other misc. stuff Tero Marttila <terom@fixme.fi> parents: diff changeset	13
f13cf27a360b implement more LogSource features (logs for date, cleanup last_logs), implement irssi parser, formatter, other misc. stuff Tero Marttila <terom@fixme.fi> parents: diff changeset	14	def __init__ (self, tz, timestamp_fmt="%H:%M:%S") :
f13cf27a360b implement more LogSource features (logs for date, cleanup last_logs), implement irssi parser, formatter, other misc. stuff Tero Marttila <terom@fixme.fi> parents: diff changeset	15	"""
f13cf27a360b implement more LogSource features (logs for date, cleanup last_logs), implement irssi parser, formatter, other misc. stuff Tero Marttila <terom@fixme.fi> parents: diff changeset	16	Initialize to format timestamps with the given timezone and timestamp
f13cf27a360b implement more LogSource features (logs for date, cleanup last_logs), implement irssi parser, formatter, other misc. stuff Tero Marttila <terom@fixme.fi> parents: diff changeset	17	"""
f13cf27a360b implement more LogSource features (logs for date, cleanup last_logs), implement irssi parser, formatter, other misc. stuff Tero Marttila <terom@fixme.fi> parents: diff changeset	18
f13cf27a360b implement more LogSource features (logs for date, cleanup last_logs), implement irssi parser, formatter, other misc. stuff Tero Marttila <terom@fixme.fi> parents: diff changeset	19	self.tz = tz
f13cf27a360b implement more LogSource features (logs for date, cleanup last_logs), implement irssi parser, formatter, other misc. stuff Tero Marttila <terom@fixme.fi> parents: diff changeset	20	self.timestamp_fmt = timestamp_fmt
f13cf27a360b implement more LogSource features (logs for date, cleanup last_logs), implement irssi parser, formatter, other misc. stuff Tero Marttila <terom@fixme.fi> parents: diff changeset	21
f13cf27a360b implement more LogSource features (logs for date, cleanup last_logs), implement irssi parser, formatter, other misc. stuff Tero Marttila <terom@fixme.fi> parents: diff changeset	22	def _format_line_text (self, line, template_dict) :
f13cf27a360b implement more LogSource features (logs for date, cleanup last_logs), implement irssi parser, formatter, other misc. stuff Tero Marttila <terom@fixme.fi> parents: diff changeset	23	"""
f13cf27a360b implement more LogSource features (logs for date, cleanup last_logs), implement irssi parser, formatter, other misc. stuff Tero Marttila <terom@fixme.fi> parents: diff changeset	24	Format the given line as text, using the given { type: string template } dict
f13cf27a360b implement more LogSource features (logs for date, cleanup last_logs), implement irssi parser, formatter, other misc. stuff Tero Marttila <terom@fixme.fi> parents: diff changeset	25	"""
f13cf27a360b implement more LogSource features (logs for date, cleanup last_logs), implement irssi parser, formatter, other misc. stuff Tero Marttila <terom@fixme.fi> parents: diff changeset	26
f13cf27a360b implement more LogSource features (logs for date, cleanup last_logs), implement irssi parser, formatter, other misc. stuff Tero Marttila <terom@fixme.fi> parents: diff changeset	27	# look up the template
f13cf27a360b implement more LogSource features (logs for date, cleanup last_logs), implement irssi parser, formatter, other misc. stuff Tero Marttila <terom@fixme.fi> parents: diff changeset	28	template = template_dict[line.type]
f13cf27a360b implement more LogSource features (logs for date, cleanup last_logs), implement irssi parser, formatter, other misc. stuff Tero Marttila <terom@fixme.fi> parents: diff changeset	29
f13cf27a360b implement more LogSource features (logs for date, cleanup last_logs), implement irssi parser, formatter, other misc. stuff Tero Marttila <terom@fixme.fi> parents: diff changeset	30	# build timestamp
f13cf27a360b implement more LogSource features (logs for date, cleanup last_logs), implement irssi parser, formatter, other misc. stuff Tero Marttila <terom@fixme.fi> parents: diff changeset	31	timestamp = line.timestamp.astimezone(self.tz).strftime(self.timestamp_fmt)
f13cf27a360b implement more LogSource features (logs for date, cleanup last_logs), implement irssi parser, formatter, other misc. stuff Tero Marttila <terom@fixme.fi> parents: diff changeset	32
f13cf27a360b implement more LogSource features (logs for date, cleanup last_logs), implement irssi parser, formatter, other misc. stuff Tero Marttila <terom@fixme.fi> parents: diff changeset	33	# format with dict
f13cf27a360b implement more LogSource features (logs for date, cleanup last_logs), implement irssi parser, formatter, other misc. stuff Tero Marttila <terom@fixme.fi> parents: diff changeset	34	return template % dict(
f13cf27a360b implement more LogSource features (logs for date, cleanup last_logs), implement irssi parser, formatter, other misc. stuff Tero Marttila <terom@fixme.fi> parents: diff changeset	35	timestamp = timestamp,
f13cf27a360b implement more LogSource features (logs for date, cleanup last_logs), implement irssi parser, formatter, other misc. stuff Tero Marttila <terom@fixme.fi> parents: diff changeset	36	source = line.source,
f13cf27a360b implement more LogSource features (logs for date, cleanup last_logs), implement irssi parser, formatter, other misc. stuff Tero Marttila <terom@fixme.fi> parents: diff changeset	37	data = line.data,
f13cf27a360b implement more LogSource features (logs for date, cleanup last_logs), implement irssi parser, formatter, other misc. stuff Tero Marttila <terom@fixme.fi> parents: diff changeset	38	)
f13cf27a360b implement more LogSource features (logs for date, cleanup last_logs), implement irssi parser, formatter, other misc. stuff Tero Marttila <terom@fixme.fi> parents: diff changeset	39
f13cf27a360b implement more LogSource features (logs for date, cleanup last_logs), implement irssi parser, formatter, other misc. stuff Tero Marttila <terom@fixme.fi> parents: diff changeset	40	def format_txt (self, lines) :
f13cf27a360b implement more LogSource features (logs for date, cleanup last_logs), implement irssi parser, formatter, other misc. stuff Tero Marttila <terom@fixme.fi> parents: diff changeset	41	"""
f13cf27a360b implement more LogSource features (logs for date, cleanup last_logs), implement irssi parser, formatter, other misc. stuff Tero Marttila <terom@fixme.fi> parents: diff changeset	42	Format as plaintext
f13cf27a360b implement more LogSource features (logs for date, cleanup last_logs), implement irssi parser, formatter, other misc. stuff Tero Marttila <terom@fixme.fi> parents: diff changeset	43	"""
f13cf27a360b implement more LogSource features (logs for date, cleanup last_logs), implement irssi parser, formatter, other misc. stuff Tero Marttila <terom@fixme.fi> parents: diff changeset	44
f13cf27a360b implement more LogSource features (logs for date, cleanup last_logs), implement irssi parser, formatter, other misc. stuff Tero Marttila <terom@fixme.fi> parents: diff changeset	45	abstract
f13cf27a360b implement more LogSource features (logs for date, cleanup last_logs), implement irssi parser, formatter, other misc. stuff Tero Marttila <terom@fixme.fi> parents: diff changeset	46
f13cf27a360b implement more LogSource features (logs for date, cleanup last_logs), implement irssi parser, formatter, other misc. stuff Tero Marttila <terom@fixme.fi> parents: diff changeset	47	def format_html (self, lines) :
f13cf27a360b implement more LogSource features (logs for date, cleanup last_logs), implement irssi parser, formatter, other misc. stuff Tero Marttila <terom@fixme.fi> parents: diff changeset	48	"""
f13cf27a360b implement more LogSource features (logs for date, cleanup last_logs), implement irssi parser, formatter, other misc. stuff Tero Marttila <terom@fixme.fi> parents: diff changeset	49	Format as HTML
f13cf27a360b implement more LogSource features (logs for date, cleanup last_logs), implement irssi parser, formatter, other misc. stuff Tero Marttila <terom@fixme.fi> parents: diff changeset	50	"""
f13cf27a360b implement more LogSource features (logs for date, cleanup last_logs), implement irssi parser, formatter, other misc. stuff Tero Marttila <terom@fixme.fi> parents: diff changeset	51
f13cf27a360b implement more LogSource features (logs for date, cleanup last_logs), implement irssi parser, formatter, other misc. stuff Tero Marttila <terom@fixme.fi> parents: diff changeset	52	abstract
f13cf27a360b implement more LogSource features (logs for date, cleanup last_logs), implement irssi parser, formatter, other misc. stuff Tero Marttila <terom@fixme.fi> parents: diff changeset	53
f13cf27a360b implement more LogSource features (logs for date, cleanup last_logs), implement irssi parser, formatter, other misc. stuff Tero Marttila <terom@fixme.fi> parents: diff changeset	54	class IrssiTextFormatter (LogFormatter) :
f13cf27a360b implement more LogSource features (logs for date, cleanup last_logs), implement irssi parser, formatter, other misc. stuff Tero Marttila <terom@fixme.fi> parents: diff changeset	55	"""
f13cf27a360b implement more LogSource features (logs for date, cleanup last_logs), implement irssi parser, formatter, other misc. stuff Tero Marttila <terom@fixme.fi> parents: diff changeset	56	Implements format_txt for irssi-style output
f13cf27a360b implement more LogSource features (logs for date, cleanup last_logs), implement irssi parser, formatter, other misc. stuff Tero Marttila <terom@fixme.fi> parents: diff changeset	57	"""
f13cf27a360b implement more LogSource features (logs for date, cleanup last_logs), implement irssi parser, formatter, other misc. stuff Tero Marttila <terom@fixme.fi> parents: diff changeset	58
f13cf27a360b implement more LogSource features (logs for date, cleanup last_logs), implement irssi parser, formatter, other misc. stuff Tero Marttila <terom@fixme.fi> parents: diff changeset	59	# format definitions by type
f13cf27a360b implement more LogSource features (logs for date, cleanup last_logs), implement irssi parser, formatter, other misc. stuff Tero Marttila <terom@fixme.fi> parents: diff changeset	60	__FMT = {
f13cf27a360b implement more LogSource features (logs for date, cleanup last_logs), implement irssi parser, formatter, other misc. stuff Tero Marttila <terom@fixme.fi> parents: diff changeset	61	LogTypes.RAW : "%(timestamp)s %(data)s",
f13cf27a360b implement more LogSource features (logs for date, cleanup last_logs), implement irssi parser, formatter, other misc. stuff Tero Marttila <terom@fixme.fi> parents: diff changeset	62	}
f13cf27a360b implement more LogSource features (logs for date, cleanup last_logs), implement irssi parser, formatter, other misc. stuff Tero Marttila <terom@fixme.fi> parents: diff changeset	63
f13cf27a360b implement more LogSource features (logs for date, cleanup last_logs), implement irssi parser, formatter, other misc. stuff Tero Marttila <terom@fixme.fi> parents: diff changeset	64	def format_txt (self, lines) :
f13cf27a360b implement more LogSource features (logs for date, cleanup last_logs), implement irssi parser, formatter, other misc. stuff Tero Marttila <terom@fixme.fi> parents: diff changeset	65	# ...handle each line
f13cf27a360b implement more LogSource features (logs for date, cleanup last_logs), implement irssi parser, formatter, other misc. stuff Tero Marttila <terom@fixme.fi> parents: diff changeset	66	for line in lines :
f13cf27a360b implement more LogSource features (logs for date, cleanup last_logs), implement irssi parser, formatter, other misc. stuff Tero Marttila <terom@fixme.fi> parents: diff changeset	67	# using __TYPES
f13cf27a360b implement more LogSource features (logs for date, cleanup last_logs), implement irssi parser, formatter, other misc. stuff Tero Marttila <terom@fixme.fi> parents: diff changeset	68	yield self._format_line_text(line, self.__FMT)
f13cf27a360b implement more LogSource features (logs for date, cleanup last_logs), implement irssi parser, formatter, other misc. stuff Tero Marttila <terom@fixme.fi> parents: diff changeset	69
f13cf27a360b implement more LogSource features (logs for date, cleanup last_logs), implement irssi parser, formatter, other misc. stuff Tero Marttila <terom@fixme.fi> parents: diff changeset	70	class IrssiFormatter (IrssiTextFormatter) :
f13cf27a360b implement more LogSource features (logs for date, cleanup last_logs), implement irssi parser, formatter, other misc. stuff Tero Marttila <terom@fixme.fi> parents: diff changeset	71	"""
f13cf27a360b implement more LogSource features (logs for date, cleanup last_logs), implement irssi parser, formatter, other misc. stuff Tero Marttila <terom@fixme.fi> parents: diff changeset	72	Implements plain black-and-white irssi-style formatting
f13cf27a360b implement more LogSource features (logs for date, cleanup last_logs), implement irssi parser, formatter, other misc. stuff Tero Marttila <terom@fixme.fi> parents: diff changeset	73	"""
f13cf27a360b implement more LogSource features (logs for date, cleanup last_logs), implement irssi parser, formatter, other misc. stuff Tero Marttila <terom@fixme.fi> parents: diff changeset	74
f13cf27a360b implement more LogSource features (logs for date, cleanup last_logs), implement irssi parser, formatter, other misc. stuff Tero Marttila <terom@fixme.fi> parents: diff changeset	75	def format_html (self, lines) :
f13cf27a360b implement more LogSource features (logs for date, cleanup last_logs), implement irssi parser, formatter, other misc. stuff Tero Marttila <terom@fixme.fi> parents: diff changeset	76	"""
f13cf27a360b implement more LogSource features (logs for date, cleanup last_logs), implement irssi parser, formatter, other misc. stuff Tero Marttila <terom@fixme.fi> parents: diff changeset	77	Just uses format_txt, but wraps in <pre></pre>
f13cf27a360b implement more LogSource features (logs for date, cleanup last_logs), implement irssi parser, formatter, other misc. stuff Tero Marttila <terom@fixme.fi> parents: diff changeset	78	"""
f13cf27a360b implement more LogSource features (logs for date, cleanup last_logs), implement irssi parser, formatter, other misc. stuff Tero Marttila <terom@fixme.fi> parents: diff changeset	79
f13cf27a360b implement more LogSource features (logs for date, cleanup last_logs), implement irssi parser, formatter, other misc. stuff Tero Marttila <terom@fixme.fi> parents: diff changeset	80	# open pre
f13cf27a360b implement more LogSource features (logs for date, cleanup last_logs), implement irssi parser, formatter, other misc. stuff Tero Marttila <terom@fixme.fi> parents: diff changeset	81	yield "<pre>"
f13cf27a360b implement more LogSource features (logs for date, cleanup last_logs), implement irssi parser, formatter, other misc. stuff Tero Marttila <terom@fixme.fi> parents: diff changeset	82
f13cf27a360b implement more LogSource features (logs for date, cleanup last_logs), implement irssi parser, formatter, other misc. stuff Tero Marttila <terom@fixme.fi> parents: diff changeset	83	# format using IrssiTextFormatter
f13cf27a360b implement more LogSource features (logs for date, cleanup last_logs), implement irssi parser, formatter, other misc. stuff Tero Marttila <terom@fixme.fi> parents: diff changeset	84	for line in self.format_txt(lines) :
f13cf27a360b implement more LogSource features (logs for date, cleanup last_logs), implement irssi parser, formatter, other misc. stuff Tero Marttila <terom@fixme.fi> parents: diff changeset	85	# escape HTML
f13cf27a360b implement more LogSource features (logs for date, cleanup last_logs), implement irssi parser, formatter, other misc. stuff Tero Marttila <terom@fixme.fi> parents: diff changeset	86	yield helpers.escape(line)
f13cf27a360b implement more LogSource features (logs for date, cleanup last_logs), implement irssi parser, formatter, other misc. stuff Tero Marttila <terom@fixme.fi> parents: diff changeset	87
f13cf27a360b implement more LogSource features (logs for date, cleanup last_logs), implement irssi parser, formatter, other misc. stuff Tero Marttila <terom@fixme.fi> parents: diff changeset	88	# close pre
f13cf27a360b implement more LogSource features (logs for date, cleanup last_logs), implement irssi parser, formatter, other misc. stuff Tero Marttila <terom@fixme.fi> parents: diff changeset	89	yield "</pre>"
f13cf27a360b implement more LogSource features (logs for date, cleanup last_logs), implement irssi parser, formatter, other misc. stuff Tero Marttila <terom@fixme.fi> parents: diff changeset	90
f13cf27a360b implement more LogSource features (logs for date, cleanup last_logs), implement irssi parser, formatter, other misc. stuff Tero Marttila <terom@fixme.fi> parents: diff changeset	91	# define formatters by name
f13cf27a360b implement more LogSource features (logs for date, cleanup last_logs), implement irssi parser, formatter, other misc. stuff Tero Marttila <terom@fixme.fi> parents: diff changeset	92	FORMATTERS = {
f13cf27a360b implement more LogSource features (logs for date, cleanup last_logs), implement irssi parser, formatter, other misc. stuff Tero Marttila <terom@fixme.fi> parents: diff changeset	93	'irssi': IrssiFormatter,
f13cf27a360b implement more LogSource features (logs for date, cleanup last_logs), implement irssi parser, formatter, other misc. stuff Tero Marttila <terom@fixme.fi> parents: diff changeset	94	}
f13cf27a360b implement more LogSource features (logs for date, cleanup last_logs), implement irssi parser, formatter, other misc. stuff Tero Marttila <terom@fixme.fi> parents: diff changeset	95
f13cf27a360b implement more LogSource features (logs for date, cleanup last_logs), implement irssi parser, formatter, other misc. stuff Tero Marttila <terom@fixme.fi> parents: diff changeset	96	def by_name (name) :
f13cf27a360b implement more LogSource features (logs for date, cleanup last_logs), implement irssi parser, formatter, other misc. stuff Tero Marttila <terom@fixme.fi> parents: diff changeset	97	"""
f13cf27a360b implement more LogSource features (logs for date, cleanup last_logs), implement irssi parser, formatter, other misc. stuff Tero Marttila <terom@fixme.fi> parents: diff changeset	98	Lookup and return a formatter by name
f13cf27a360b implement more LogSource features (logs for date, cleanup last_logs), implement irssi parser, formatter, other misc. stuff Tero Marttila <terom@fixme.fi> parents: diff changeset	99
f13cf27a360b implement more LogSource features (logs for date, cleanup last_logs), implement irssi parser, formatter, other misc. stuff Tero Marttila <terom@fixme.fi> parents: diff changeset	100	XXX: uses default timezone/timefmt
f13cf27a360b implement more LogSource features (logs for date, cleanup last_logs), implement irssi parser, formatter, other misc. stuff Tero Marttila <terom@fixme.fi> parents: diff changeset	101	"""
f13cf27a360b implement more LogSource features (logs for date, cleanup last_logs), implement irssi parser, formatter, other misc. stuff Tero Marttila <terom@fixme.fi> parents: diff changeset	102
f13cf27a360b implement more LogSource features (logs for date, cleanup last_logs), implement irssi parser, formatter, other misc. stuff Tero Marttila <terom@fixme.fi> parents: diff changeset	103	import pytz
f13cf27a360b implement more LogSource features (logs for date, cleanup last_logs), implement irssi parser, formatter, other misc. stuff Tero Marttila <terom@fixme.fi> parents: diff changeset	104
f13cf27a360b implement more LogSource features (logs for date, cleanup last_logs), implement irssi parser, formatter, other misc. stuff Tero Marttila <terom@fixme.fi> parents: diff changeset	105	return FORMATTERS[name](pytz.utc)
f13cf27a360b implement more LogSource features (logs for date, cleanup last_logs), implement irssi parser, formatter, other misc. stuff Tero Marttila <terom@fixme.fi> parents: diff changeset	106

author	Tero Marttila <terom@fixme.fi>
	Mon, 09 Feb 2009 00:24:13 +0200
changeset 50	f13cf27a360b
child 51	07ca28f3a9f2
permissions	-rw-r--r--