paul@309 | 1 | # -*- coding: iso-8859-1 -*- |
paul@309 | 2 | """ |
paul@309 | 3 | MoinMoin - event (EventAggregator) |
paul@309 | 4 | |
paul@366 | 5 | @copyright: 2012, 2013 by Paul Boddie <paul@boddie.org.uk> |
paul@309 | 6 | @license: GNU GPL (v2 or later), see COPYING.txt for details. |
paul@309 | 7 | """ |
paul@309 | 8 | |
paul@366 | 9 | from MoinSupport import parseAttributes |
paul@366 | 10 | from EventAggregatorSupport.Formatting import formatEvent, formatEventsForOutputType |
paul@395 | 11 | from EventAggregatorSupport.Types import parseEventsInPage, EventPage |
paul@309 | 12 | |
paul@309 | 13 | Dependencies = ["pages"] |
paul@309 | 14 | |
paul@309 | 15 | # Parser support. |
paul@309 | 16 | |
paul@309 | 17 | class Parser: |
paul@309 | 18 | |
paul@309 | 19 | "Interpret and show event information in different ways." |
paul@309 | 20 | |
paul@309 | 21 | Dependencies = Dependencies |
paul@309 | 22 | extensions = [] |
paul@309 | 23 | |
paul@309 | 24 | # Output content types preferred by this parser. |
paul@309 | 25 | |
paul@309 | 26 | output_mimetypes = ["text/html", "text/calendar"] |
paul@309 | 27 | |
paul@309 | 28 | def __init__(self, raw, request, **kw): |
paul@309 | 29 | |
paul@309 | 30 | """ |
paul@309 | 31 | Initialise the parser with the given 'raw' data, 'request' and any |
paul@309 | 32 | keyword arguments that may have been supplied. |
paul@309 | 33 | """ |
paul@309 | 34 | |
paul@309 | 35 | self.raw = raw |
paul@309 | 36 | self.request = request |
paul@323 | 37 | attrs = parseAttributes(kw.get("format_args", ""), False) |
paul@323 | 38 | |
paul@323 | 39 | self.fragment = attrs.get("fragment") |
paul@309 | 40 | |
paul@310 | 41 | def format(self, fmt, write=None): |
paul@309 | 42 | |
paul@310 | 43 | """ |
paul@310 | 44 | Format an event using the given formatter 'fmt'. If the 'write' |
paul@310 | 45 | parameter is specified, use it to write output; otherwise, write output |
paul@310 | 46 | using the request. |
paul@310 | 47 | """ |
paul@309 | 48 | |
paul@428 | 49 | for event in parseEventsInPage(self.raw, EventPage(self.request.page), self.fragment).getEvents(): |
paul@310 | 50 | formatEvent(event, self.request, fmt, write=write) |
paul@309 | 51 | |
paul@309 | 52 | # Extra API methods. |
paul@309 | 53 | |
paul@310 | 54 | def formatForOutputType(self, mimetype, write=None): |
paul@309 | 55 | |
paul@310 | 56 | """ |
paul@310 | 57 | Format an event for the given 'mimetype'. If the 'write' parameter is |
paul@310 | 58 | specified, use it to write output; otherwise, write output using the |
paul@310 | 59 | request. |
paul@310 | 60 | """ |
paul@309 | 61 | |
paul@428 | 62 | events = parseEventsInPage(self.raw, EventPage(self.request.page), self.fragment).getEvents() |
paul@310 | 63 | formatEventsForOutputType(events, self.request, mimetype, write=write) |
paul@309 | 64 | |
paul@309 | 65 | # Class methods. |
paul@309 | 66 | |
paul@309 | 67 | def getOutputTypes(self): |
paul@309 | 68 | return self.output_mimetypes |
paul@309 | 69 | |
paul@309 | 70 | getOutputTypes = classmethod(getOutputTypes) |
paul@309 | 71 | |
paul@309 | 72 | # vim: tabstop=4 expandtab shiftwidth=4 |