qmsk.irclogs: log_formatter.py@8b50694f841e (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
55 5667d2bbdc50 improve calendar further Tero Marttila <terom@fixme.fi> parents: 51 diff changeset	5	# for escape
5667d2bbdc50 improve calendar further Tero Marttila <terom@fixme.fi> parents: 51 diff changeset	6	import cgi
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	7
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	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	9
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	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	11	"""
65 8b50694f841e improve search further Tero Marttila <terom@fixme.fi> parents: 64 diff changeset	12	Provides a method to format series of LogLines into various output formats, with varying themes.
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	13	"""
51 07ca28f3a9f2 use improved URLConfig/URLType Tero Marttila <terom@fixme.fi> parents: 50 diff changeset	14
07ca28f3a9f2 use improved URLConfig/URLType Tero Marttila <terom@fixme.fi> parents: 50 diff changeset	15	# the formatter's code name
07ca28f3a9f2 use improved URLConfig/URLType Tero Marttila <terom@fixme.fi> parents: 50 diff changeset	16	name = None
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	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	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	19	"""
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	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	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
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	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	24	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	25
65 8b50694f841e improve search further Tero Marttila <terom@fixme.fi> parents: 64 diff changeset	26	def _format_line_text (self, line, template_dict, full_timestamp=False) :
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	27	"""
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	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	29	"""
65 8b50694f841e improve search further Tero Marttila <terom@fixme.fi> parents: 64 diff changeset	30
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	31	# 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	32	template = template_dict[line.type]
65 8b50694f841e improve search further Tero Marttila <terom@fixme.fi> parents: 64 diff changeset	33
8b50694f841e improve search further Tero Marttila <terom@fixme.fi> parents: 64 diff changeset	34	# convert timestamp into display timezone
8b50694f841e improve search further Tero Marttila <terom@fixme.fi> parents: 64 diff changeset	35	dtz = line.timestamp.astimezone(self.tz)
8b50694f841e improve search further Tero Marttila <terom@fixme.fi> parents: 64 diff changeset	36
8b50694f841e improve search further Tero Marttila <terom@fixme.fi> parents: 64 diff changeset	37	# full timestamps?
8b50694f841e improve search further Tero Marttila <terom@fixme.fi> parents: 64 diff changeset	38	if full_timestamp :
8b50694f841e improve search further Tero Marttila <terom@fixme.fi> parents: 64 diff changeset	39	# XXX: ugly
8b50694f841e improve search further Tero Marttila <terom@fixme.fi> parents: 64 diff changeset	40	timestamp_fmt = '%Y-%m-%d ' + self.timestamp_fmt
8b50694f841e improve search further Tero Marttila <terom@fixme.fi> parents: 64 diff changeset	41
8b50694f841e improve search further Tero Marttila <terom@fixme.fi> parents: 64 diff changeset	42	else :
8b50694f841e improve search further Tero Marttila <terom@fixme.fi> parents: 64 diff changeset	43	timestamp_fmt = self.timestamp_fmt
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	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	# build timestamp
65 8b50694f841e improve search further Tero Marttila <terom@fixme.fi> parents: 64 diff changeset	46	timestamp = dtz.strftime(timestamp_fmt)
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	47
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	# 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	49	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	50	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	51	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	52	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	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
65 8b50694f841e improve search further Tero Marttila <terom@fixme.fi> parents: 64 diff changeset	55	def format_txt (self, lines, full_timestamps=False) :
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	56	"""
65 8b50694f841e improve search further Tero Marttila <terom@fixme.fi> parents: 64 diff changeset	57	Format given lines as plaintext.
8b50694f841e improve search further Tero Marttila <terom@fixme.fi> parents: 64 diff changeset	58
8b50694f841e improve search further Tero Marttila <terom@fixme.fi> parents: 64 diff changeset	59	If full_timestamps is given, the output will contain full timestamps with both date and time.
8b50694f841e improve search further Tero Marttila <terom@fixme.fi> parents: 64 diff changeset	60
8b50694f841e improve search further Tero Marttila <terom@fixme.fi> parents: 64 diff changeset	61	No trailing newlines.
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	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	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	65
65 8b50694f841e improve search further Tero Marttila <terom@fixme.fi> parents: 64 diff changeset	66	def format_html (self, lines, full_timestamps=False) :
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	67	"""
65 8b50694f841e improve search further Tero Marttila <terom@fixme.fi> parents: 64 diff changeset	68	Format as HTML.
8b50694f841e improve search further Tero Marttila <terom@fixme.fi> parents: 64 diff changeset	69
8b50694f841e improve search further Tero Marttila <terom@fixme.fi> parents: 64 diff changeset	70	See format_txt for information about arguments
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	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
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	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	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	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	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	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	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	# 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	81	__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	82	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	83	}
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
65 8b50694f841e improve search further Tero Marttila <terom@fixme.fi> parents: 64 diff changeset	85	def format_txt (self, lines, full_timestamps=False) :
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	86	# ...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	87	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	88	# using __TYPES
65 8b50694f841e improve search further Tero Marttila <terom@fixme.fi> parents: 64 diff changeset	89	yield self._format_line_text(line, self.__FMT, full_timestamps)
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	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	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	92	"""
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	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	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
51 07ca28f3a9f2 use improved URLConfig/URLType Tero Marttila <terom@fixme.fi> parents: 50 diff changeset	96	name = 'irssi'
59 8ec729c5d998 ugly, but working, preferences editor Tero Marttila <terom@fixme.fi> parents: 55 diff changeset	97	title = "Irssi (plain)"
51 07ca28f3a9f2 use improved URLConfig/URLType Tero Marttila <terom@fixme.fi> parents: 50 diff changeset	98
65 8b50694f841e improve search further Tero Marttila <terom@fixme.fi> parents: 64 diff changeset	99	def format_html (self, lines, full_timestamps=False) :
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	100	"""
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	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	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
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	# 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	105	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	106
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	107	# format using IrssiTextFormatter
65 8b50694f841e improve search further Tero Marttila <terom@fixme.fi> parents: 64 diff changeset	108	for line in self.format_txt(lines, full_timestamps) :
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	109	# escape HTML
55 5667d2bbdc50 improve calendar further Tero Marttila <terom@fixme.fi> parents: 51 diff changeset	110	yield cgi.escape(line)
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	111
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	112	# 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	113	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	114
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	115	# 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	116	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	117	'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	118	}
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	119
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	120	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	121	"""
64 cdb6403c2498 beginnings of a LogSearchIndex class Tero Marttila <terom@fixme.fi> parents: 59 diff changeset	122	Lookup and return a class LogFormatter by name
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	123	"""
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	124
64 cdb6403c2498 beginnings of a LogSearchIndex class Tero Marttila <terom@fixme.fi> parents: 59 diff changeset	125	return FORMATTERS[name]
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	126

author	Tero Marttila <terom@fixme.fi>
	Mon, 09 Feb 2009 11:46:17 +0200
changeset 65	8b50694f841e
parent 64	cdb6403c2498
child 69	1f182913b1f2
permissions	-rw-r--r--