paul@10 | 1 | # -*- coding: iso-8859-1 -*- |
paul@10 | 2 | """ |
paul@10 | 3 | MoinMoin - EventAggregatorSummary Action |
paul@10 | 4 | |
paul@10 | 5 | @copyright: 2008, 2009 by Paul Boddie <paul@boddie.org.uk> |
paul@10 | 6 | @copyright: 2000-2004 Juergen Hermann <jh@web.de>, |
paul@24 | 7 | 2003-2008 MoinMoin:ThomasWaldmann, |
paul@24 | 8 | 2004-2006 MoinMoin:AlexanderSchremmer, |
paul@19 | 9 | 2007 MoinMoin:ReimarBauer. |
paul@10 | 10 | @license: GNU GPL (v2 or later), see COPYING.txt for details. |
paul@10 | 11 | """ |
paul@10 | 12 | |
paul@19 | 13 | from MoinMoin.action import ActionBase |
paul@10 | 14 | from MoinMoin import config |
paul@24 | 15 | from MoinMoin.Page import Page |
paul@27 | 16 | import MoinMoin.util # for MoinMoin 1.5.x |
paul@29 | 17 | from MoinMoin import wikiutil |
paul@10 | 18 | import EventAggregatorSupport |
paul@10 | 19 | |
paul@10 | 20 | Dependencies = ['pages'] |
paul@10 | 21 | |
paul@19 | 22 | # Action class and supporting functions. |
paul@19 | 23 | |
paul@19 | 24 | class EventAggregatorSummary(ActionBase): |
paul@19 | 25 | |
paul@19 | 26 | "A summary dialogue requesting various parameters." |
paul@19 | 27 | |
paul@19 | 28 | def get_form_html(self, buttons_html): |
paul@19 | 29 | _ = self._ |
paul@19 | 30 | request = self.request |
paul@19 | 31 | |
paul@19 | 32 | category_list = [] |
paul@19 | 33 | |
paul@19 | 34 | for category_name, category_pagename in \ |
paul@19 | 35 | EventAggregatorSupport.getCategoryMapping( |
paul@19 | 36 | EventAggregatorSupport.getCategories(request), |
paul@19 | 37 | request): |
paul@19 | 38 | |
paul@19 | 39 | category_list.append('<option value="%s">%s</option>' % (category_pagename, category_name)) |
paul@19 | 40 | |
paul@23 | 41 | month_list = [] |
paul@23 | 42 | month_list.append('<option value=""></option>') |
paul@23 | 43 | |
paul@23 | 44 | for month in range(1, 13): |
paul@23 | 45 | month_label = _(EventAggregatorSupport.getMonthLabel(month)) |
paul@23 | 46 | month_list.append('<option value="%02d">%s</option>' % (month, month_label)) |
paul@23 | 47 | |
paul@23 | 48 | year_label = [] |
paul@23 | 49 | |
paul@19 | 50 | d = { |
paul@19 | 51 | "buttons_html" : buttons_html, |
paul@19 | 52 | "category_label" : _("Categories"), |
paul@19 | 53 | "category_list" : "\n".join(category_list), |
paul@23 | 54 | "month_list" : "\n".join(month_list), |
paul@19 | 55 | "start_label" : _("Start year and month"), |
paul@23 | 56 | "start_year_default" : "", |
paul@19 | 57 | "end_label" : _("End year and month"), |
paul@23 | 58 | "end_year_default" : "", |
paul@19 | 59 | } |
paul@10 | 60 | |
paul@19 | 61 | return ''' |
paul@19 | 62 | <table> |
paul@19 | 63 | <tr> |
paul@19 | 64 | <td class="label"><label>%(category_label)s</label></td> |
paul@19 | 65 | <td class="content"> |
paul@19 | 66 | <select multiple="multiple" name="category"> |
paul@19 | 67 | %(category_list)s |
paul@19 | 68 | </select> |
paul@19 | 69 | </td> |
paul@19 | 70 | </tr> |
paul@19 | 71 | <tr> |
paul@19 | 72 | <td class="label"><label>%(start_label)s</label></td> |
paul@22 | 73 | <td> |
paul@23 | 74 | <select name="start-month"> |
paul@23 | 75 | %(month_list)s |
paul@23 | 76 | </select> |
paul@23 | 77 | <input name="start-year" type="text" value="%(start_year_default)s" size="4" /> |
paul@19 | 78 | </td> |
paul@19 | 79 | </tr> |
paul@19 | 80 | <tr> |
paul@19 | 81 | <td class="label"><label>%(end_label)s</label></td> |
paul@22 | 82 | <td> |
paul@23 | 83 | <select name="end-month"> |
paul@23 | 84 | %(month_list)s |
paul@23 | 85 | </select> |
paul@23 | 86 | <input name="end-year" type="text" value="%(end_year_default)s" size="4" /> |
paul@19 | 87 | </td> |
paul@19 | 88 | </tr> |
paul@19 | 89 | <tr> |
paul@19 | 90 | <td></td> |
paul@19 | 91 | <td class="buttons"> |
paul@19 | 92 | %(buttons_html)s |
paul@19 | 93 | </td> |
paul@19 | 94 | </tr> |
paul@19 | 95 | </table> |
paul@19 | 96 | ''' % d |
paul@19 | 97 | |
paul@19 | 98 | def do_action(self): |
paul@19 | 99 | |
paul@19 | 100 | "Write the iCalendar resource." |
paul@19 | 101 | |
paul@19 | 102 | _ = self._ |
paul@23 | 103 | form = self.request.form |
paul@19 | 104 | |
paul@19 | 105 | # If no category names exist in the request, an error message is |
paul@19 | 106 | # returned. |
paul@19 | 107 | |
paul@23 | 108 | category_names = form.get("category", []) |
paul@19 | 109 | |
paul@19 | 110 | if not category_names: |
paul@19 | 111 | return 0, _("No categories specified.") |
paul@19 | 112 | |
paul@19 | 113 | write_resource(self.request) |
paul@19 | 114 | return 1, None |
paul@19 | 115 | |
paul@27 | 116 | def render_success(self, msg, msgtype=None): |
paul@19 | 117 | |
paul@19 | 118 | """ |
paul@19 | 119 | Render neither 'msg' nor 'msgtype' since a resource has already been |
paul@19 | 120 | produced. |
paul@27 | 121 | NOTE: msgtype is optional because MoinMoin 1.5.x does not support it. |
paul@19 | 122 | """ |
paul@19 | 123 | |
paul@19 | 124 | pass |
paul@19 | 125 | |
paul@24 | 126 | def getQuotedText(text): |
paul@24 | 127 | |
paul@24 | 128 | "Return the 'text' quoted for iCalendar purposes." |
paul@24 | 129 | |
paul@24 | 130 | return text.replace(";", r"\;").replace(",", r"\,") |
paul@24 | 131 | |
paul@19 | 132 | def write_resource(request): |
paul@10 | 133 | |
paul@10 | 134 | """ |
paul@19 | 135 | For the given 'request', write an iCalendar summary of the event data found |
paul@19 | 136 | in the categories specified via the "category" request parameter, using the |
paul@19 | 137 | "start" and "end" parameters (if specified). Multiple "category" parameters |
paul@19 | 138 | can be specified. |
paul@10 | 139 | """ |
paul@10 | 140 | |
paul@10 | 141 | category_names = request.form.get("category", []) |
paul@29 | 142 | format = request.form.get("format", ["iCalendar"])[0] |
paul@10 | 143 | |
paul@19 | 144 | # Otherwise, produce an iCalendar resource. |
paul@10 | 145 | |
paul@19 | 146 | calendar_start = EventAggregatorSupport.getFormMonth(request, None, "start") |
paul@19 | 147 | calendar_end = EventAggregatorSupport.getFormMonth(request, None, "end") |
paul@10 | 148 | |
paul@23 | 149 | # Look for separate start and end years and months. |
paul@23 | 150 | |
paul@23 | 151 | form = request.form |
paul@23 | 152 | |
paul@23 | 153 | if calendar_start is None: |
paul@23 | 154 | calendar_start = EventAggregatorSupport.getFormMonthPair(request, "start-year", "start-month") |
paul@23 | 155 | |
paul@23 | 156 | if calendar_end is None: |
paul@23 | 157 | calendar_end = EventAggregatorSupport.getFormMonthPair(request, "end-year", "end-month") |
paul@23 | 158 | |
paul@10 | 159 | events, shown_events, all_shown_events, earliest, latest = \ |
paul@10 | 160 | EventAggregatorSupport.getEvents(request, category_names, calendar_start, calendar_end) |
paul@10 | 161 | |
paul@29 | 162 | latest_timestamp = EventAggregatorSupport.setEventTimestamps(request, all_shown_events) |
paul@29 | 163 | |
paul@29 | 164 | # Output summary data... |
paul@10 | 165 | |
paul@27 | 166 | if EventAggregatorSupport.isMoin15(): |
paul@27 | 167 | send_headers = request.http_headers |
paul@27 | 168 | else: |
paul@27 | 169 | send_headers = request.emit_http_headers |
paul@27 | 170 | |
paul@29 | 171 | # Define headers. |
paul@29 | 172 | |
paul@29 | 173 | if format == "iCalendar": |
paul@29 | 174 | headers = ["Content-Type: text/calendar; charset=%s" % config.charset] |
paul@29 | 175 | elif format == "RSS": |
paul@29 | 176 | headers = ["Content-Type: application/rss+xml; charset=%s" % config.charset] |
paul@29 | 177 | |
paul@29 | 178 | # Define the last modified time. |
paul@10 | 179 | |
paul@29 | 180 | headers.append("Last-Modified: %s" % EventAggregatorSupport.getHTTPTimeString(latest_timestamp)) |
paul@29 | 181 | send_headers(headers) |
paul@29 | 182 | |
paul@29 | 183 | # iCalendar output... |
paul@10 | 184 | |
paul@29 | 185 | if format == "iCalendar": |
paul@29 | 186 | request.write("BEGIN:VCALENDAR\r\n") |
paul@29 | 187 | request.write("PRODID:-//MoinMoin//EventAggregatorSummary\r\n") |
paul@29 | 188 | request.write("VERSION:2.0\r\n") |
paul@24 | 189 | |
paul@29 | 190 | for event_page, event_details in all_shown_events: |
paul@29 | 191 | |
paul@29 | 192 | # Get the summary details. |
paul@10 | 193 | |
paul@29 | 194 | event_summary = EventAggregatorSupport.getEventSummary(event_page, event_details) |
paul@29 | 195 | |
paul@29 | 196 | # Output the event details. |
paul@24 | 197 | |
paul@29 | 198 | request.write("BEGIN:VEVENT\r\n") |
paul@29 | 199 | request.write("UID:%s\r\n" % request.getQualifiedURL(event_page.url(request))) |
paul@29 | 200 | request.write("URL:%s\r\n" % request.getQualifiedURL(event_page.url(request))) |
paul@29 | 201 | request.write("DTSTAMP:%04d%02d%02dT%02d%02d%02dZ\r\n" % event_details["created"][:6]) |
paul@29 | 202 | request.write("LAST-MODIFIED:%04d%02d%02dT%02d%02d%02dZ\r\n" % event_details["last-modified"][:6]) |
paul@29 | 203 | request.write("SEQUENCE:%d\r\n" % event_details["sequence"]) |
paul@29 | 204 | request.write("DTSTART;VALUE=DATE:%04d%02d%02d\r\n" % event_details["start"]) |
paul@29 | 205 | request.write("DTEND;VALUE=DATE:%04d%02d%02d\r\n" % EventAggregatorSupport.nextdate(event_details["end"])) |
paul@29 | 206 | request.write("SUMMARY:%s\r\n" % getQuotedText(event_summary)) |
paul@24 | 207 | |
paul@29 | 208 | # Optional details. |
paul@24 | 209 | |
paul@29 | 210 | if event_details.has_key("topics") or event_details.has_key("categories"): |
paul@29 | 211 | request.write("CATEGORIES:%s\r\n" % ",".join( |
paul@29 | 212 | [getQuotedText(topic) for topic in event_details.get("topics") or event_details.get("categories")] |
paul@29 | 213 | )) |
paul@29 | 214 | if event_details.has_key("location"): |
paul@29 | 215 | request.write("LOCATION:%s\r\n" % getQuotedText(event_details["location"])) |
paul@29 | 216 | |
paul@29 | 217 | request.write("END:VEVENT\r\n") |
paul@10 | 218 | |
paul@29 | 219 | request.write("END:VCALENDAR\r\n") |
paul@29 | 220 | |
paul@29 | 221 | elif format == "RSS": |
paul@29 | 222 | request.write('<rss version="2.0">\r\n') |
paul@29 | 223 | request.write('<channel>\r\n') |
paul@29 | 224 | request.write('<title>Events</title>\r\n') |
paul@29 | 225 | request.write('<link>%s</link>\r\n' % request.getBaseURL()) |
paul@29 | 226 | request.write('<description>Events published on %s</description>\r\n' % request.getBaseURL()) |
paul@29 | 227 | request.write('<lastBuildDate>%s</lastBuildDate>\r\n' % EventAggregatorSupport.getHTTPTimeString(latest_timestamp)) |
paul@24 | 228 | |
paul@29 | 229 | for event_page, event_details in all_shown_events: |
paul@29 | 230 | |
paul@29 | 231 | # Get the summary details. |
paul@29 | 232 | |
paul@29 | 233 | event_summary = EventAggregatorSupport.getEventSummary(event_page, event_details) |
paul@29 | 234 | link = request.getQualifiedURL(event_page.url(request)) |
paul@24 | 235 | |
paul@29 | 236 | request.write('<item>\r\n') |
paul@29 | 237 | request.write('<title>%s</title>\r\n' % wikiutil.escape(event_summary)) |
paul@29 | 238 | request.write('<link>%s</link>\r\n' % link) |
paul@30 | 239 | request.write('<description>%s</description>\r\n' % wikiutil.escape(event_details["last-comment"])) |
paul@29 | 240 | |
paul@29 | 241 | for topic in event_details.get("topics") or event_details.get("categories") or []: |
paul@29 | 242 | request.write('<category>%s</category>\r\n' % topic) |
paul@24 | 243 | |
paul@29 | 244 | request.write('<pubDate>%s</pubDate>\r\n' % EventAggregatorSupport.getHTTPTimeString(event_details["created"])) |
paul@29 | 245 | request.write('<guid>%s#%s</guid>\r\n' % (link, event_details["sequence"])) |
paul@29 | 246 | request.write('</item>\r\n') |
paul@10 | 247 | |
paul@29 | 248 | request.write('</channel>\r\n') |
paul@29 | 249 | request.write('</rss>\r\n') |
paul@10 | 250 | |
paul@27 | 251 | if EventAggregatorSupport.isMoin15(): |
paul@27 | 252 | raise MoinMoin.util.MoinMoinNoFooter |
paul@27 | 253 | |
paul@19 | 254 | # Action function. |
paul@19 | 255 | |
paul@19 | 256 | def execute(pagename, request): |
paul@19 | 257 | EventAggregatorSummary(pagename, request).render() |
paul@19 | 258 | |
paul@10 | 259 | # vim: tabstop=4 expandtab shiftwidth=4 |