paul@0 | 1 | # -*- coding: iso-8859-1 -*- |
paul@0 | 2 | """ |
paul@0 | 3 | MoinMoin - EventAggregator Macro |
paul@0 | 4 | |
paul@0 | 5 | @copyright: 2008, 2009 by Paul Boddie <paul@boddie.org.uk> |
paul@0 | 6 | @copyright: 2000-2004 Juergen Hermann <jh@web.de>, |
paul@0 | 7 | 2005-2008 MoinMoin:ThomasWaldmann. |
paul@0 | 8 | @license: GNU GPL (v2 or later), see COPYING.txt for details. |
paul@0 | 9 | """ |
paul@0 | 10 | |
paul@0 | 11 | from MoinMoin.Page import Page |
paul@0 | 12 | from MoinMoin import wikiutil, search, version |
paul@0 | 13 | import calendar |
paul@0 | 14 | import re |
paul@0 | 15 | |
paul@0 | 16 | __version__ = "0.1" |
paul@0 | 17 | |
paul@0 | 18 | Dependencies = ['pages'] |
paul@0 | 19 | |
paul@0 | 20 | # Regular expressions where MoinMoin does not provide the required support. |
paul@0 | 21 | |
paul@0 | 22 | category_regexp = None |
paul@0 | 23 | definition_list_regexp = re.compile(ur'^\s+(?P<term>.*?)::\s(?P<desc>.*?)$', re.UNICODE | re.MULTILINE) |
paul@0 | 24 | date_regexp = re.compile(ur'(?P<year>[0-9]{4})-(?P<month>[0-9]{2})-(?P<day>[0-9]{2})', re.UNICODE) |
paul@0 | 25 | month_regexp = re.compile(ur'(?P<year>[0-9]{4})-(?P<month>[0-9]{2})', re.UNICODE) |
paul@0 | 26 | |
paul@0 | 27 | # Date labels. |
paul@0 | 28 | |
paul@0 | 29 | month_labels = ["January", "February", "March", "April", "May", "June", "July", "August", "September", "October", "November", "December"] |
paul@0 | 30 | weekday_labels = ["Mon", "Tue", "Wed", "Thu", "Fri", "Sat", "Sun"] |
paul@0 | 31 | |
paul@0 | 32 | # Utility functions. |
paul@0 | 33 | |
paul@0 | 34 | def isMoin15(): |
paul@0 | 35 | return version.release.startswith("1.5.") |
paul@0 | 36 | |
paul@0 | 37 | def getCategoryPattern(request): |
paul@0 | 38 | global category_regexp |
paul@0 | 39 | |
paul@0 | 40 | try: |
paul@0 | 41 | return request.cfg.cache.page_category_regexact |
paul@0 | 42 | except AttributeError: |
paul@0 | 43 | |
paul@0 | 44 | # Use regular expression from MoinMoin 1.7.1 otherwise. |
paul@0 | 45 | |
paul@0 | 46 | if category_regexp is None: |
paul@0 | 47 | category_regexp = re.compile(u'^%s$' % ur'(?P<all>Category(?P<key>(?!Template)\S+))', re.UNICODE) |
paul@0 | 48 | return category_regexp |
paul@0 | 49 | |
paul@0 | 50 | # The main activity functions. |
paul@0 | 51 | |
paul@0 | 52 | def getPages(pagename, request): |
paul@0 | 53 | |
paul@0 | 54 | "Return the links minus category links for 'pagename' using the 'request'." |
paul@0 | 55 | |
paul@0 | 56 | query = search.QueryParser().parse_query('category:%s' % pagename) |
paul@0 | 57 | if isMoin15(): |
paul@0 | 58 | results = search.searchPages(request, query) |
paul@0 | 59 | results.sortByPagename() |
paul@0 | 60 | else: |
paul@0 | 61 | results = search.searchPages(request, query, "page_name") |
paul@0 | 62 | |
paul@0 | 63 | cat_pattern = getCategoryPattern(request) |
paul@0 | 64 | pages = [] |
paul@0 | 65 | for page in results.hits: |
paul@0 | 66 | if not cat_pattern.match(page.page_name): |
paul@0 | 67 | pages.append(page) |
paul@0 | 68 | return pages |
paul@0 | 69 | |
paul@0 | 70 | def getPrettyPageName(page): |
paul@0 | 71 | |
paul@0 | 72 | "Return a nicely formatted title/name for the given 'page'." |
paul@0 | 73 | |
paul@0 | 74 | return page.split_title(force=1).replace("_", " ").replace("/", u" ? ") |
paul@0 | 75 | |
paul@0 | 76 | def getEventDetails(page): |
paul@0 | 77 | |
paul@0 | 78 | "Return a dictionary of event details from the given 'page'." |
paul@0 | 79 | |
paul@0 | 80 | event_details = {} |
paul@0 | 81 | |
paul@0 | 82 | if page.pi["format"] == "wiki": |
paul@0 | 83 | for match in definition_list_regexp.finditer(page.body): |
paul@0 | 84 | # Permit case-insensitive list terms. |
paul@0 | 85 | term = match.group("term").lower() |
paul@0 | 86 | desc = match.group("desc") |
paul@0 | 87 | if term in ("start", "end"): |
paul@0 | 88 | desc = getDate(desc) |
paul@0 | 89 | if desc is not None: |
paul@0 | 90 | event_details[term] = desc |
paul@0 | 91 | |
paul@0 | 92 | return event_details |
paul@0 | 93 | |
paul@0 | 94 | def getDate(s): |
paul@0 | 95 | |
paul@0 | 96 | "Parse the string 's', extracting and returning a date string." |
paul@0 | 97 | |
paul@0 | 98 | m = date_regexp.search(s) |
paul@0 | 99 | if m: |
paul@0 | 100 | return tuple(map(int, m.groups())) |
paul@0 | 101 | else: |
paul@0 | 102 | return None |
paul@0 | 103 | |
paul@0 | 104 | def getMonth(s): |
paul@0 | 105 | |
paul@0 | 106 | "Parse the string 's', extracting and returning a month string." |
paul@0 | 107 | |
paul@0 | 108 | m = month_regexp.search(s) |
paul@0 | 109 | if m: |
paul@0 | 110 | return tuple(map(int, m.groups())) |
paul@0 | 111 | else: |
paul@0 | 112 | return None |
paul@0 | 113 | |
paul@2 | 114 | def monthrange(first, last): |
paul@2 | 115 | results = [] |
paul@2 | 116 | |
paul@2 | 117 | end_year = last[0] |
paul@2 | 118 | |
paul@2 | 119 | for year in range(first[0], end_year + 1): |
paul@2 | 120 | if year < last[0]: |
paul@2 | 121 | end_month = 12 |
paul@2 | 122 | else: |
paul@2 | 123 | end_month = last[1] |
paul@2 | 124 | |
paul@2 | 125 | if year > first[0]: |
paul@2 | 126 | start_month = 1 |
paul@2 | 127 | else: |
paul@2 | 128 | start_month = first[1] |
paul@2 | 129 | |
paul@2 | 130 | for month in range(start_month, end_month + 1): |
paul@2 | 131 | results.append((year, month)) |
paul@2 | 132 | |
paul@2 | 133 | return results |
paul@2 | 134 | |
paul@2 | 135 | def getColour(s): |
paul@2 | 136 | colour = [0, 0, 0] |
paul@2 | 137 | digit = 0 |
paul@2 | 138 | for c in s: |
paul@2 | 139 | colour[digit] += ord(c) |
paul@2 | 140 | colour[digit] = colour[digit] % 256 |
paul@2 | 141 | digit += 1 |
paul@2 | 142 | digit = digit % 3 |
paul@2 | 143 | return tuple(colour) |
paul@2 | 144 | |
paul@2 | 145 | def getBlackOrWhite(colour): |
paul@2 | 146 | if sum(colour) / 3.0 > 127: |
paul@2 | 147 | return (0, 0, 0) |
paul@2 | 148 | else: |
paul@2 | 149 | return (255, 255, 255) |
paul@2 | 150 | |
paul@0 | 151 | def execute(macro, args): |
paul@0 | 152 | |
paul@0 | 153 | """ |
paul@0 | 154 | Execute the 'macro' with the given 'args': an optional list of selected |
paul@0 | 155 | category names (categories whose pages are to be shown), together with |
paul@0 | 156 | optional named arguments of the form "start=YYYY-MM" and "end=YYYY-MM" |
paul@0 | 157 | (indicating a restricted view of all events), and "mode=list" or |
paul@0 | 158 | "mode=calendar" (indicating the style of view). |
paul@0 | 159 | """ |
paul@0 | 160 | |
paul@0 | 161 | request = macro.request |
paul@0 | 162 | fmt = macro.formatter |
paul@0 | 163 | page = fmt.page |
paul@0 | 164 | _ = request.getText |
paul@0 | 165 | |
paul@0 | 166 | # Interpret the arguments. |
paul@0 | 167 | |
paul@0 | 168 | try: |
paul@0 | 169 | parsed_args = args and wikiutil.parse_quoted_separated(args, name_value=False) or [] |
paul@0 | 170 | except AttributeError: |
paul@0 | 171 | parsed_args = args.split(",") |
paul@0 | 172 | |
paul@0 | 173 | parsed_args = [arg for arg in parsed_args if arg] |
paul@0 | 174 | |
paul@0 | 175 | # Get special arguments. |
paul@0 | 176 | |
paul@0 | 177 | category_names = [] |
paul@0 | 178 | calendar_start = None |
paul@0 | 179 | calendar_end = None |
paul@0 | 180 | mode = "calendar" |
paul@0 | 181 | |
paul@0 | 182 | for arg in parsed_args: |
paul@0 | 183 | if arg.startswith("start="): |
paul@0 | 184 | calendar_start = getMonth(arg[6:]) |
paul@0 | 185 | elif arg.startswith("end="): |
paul@0 | 186 | calendar_end = getMonth(arg[4:]) |
paul@0 | 187 | elif arg.startswith("mode="): |
paul@0 | 188 | mode = arg[5:] |
paul@0 | 189 | else: |
paul@0 | 190 | category_names.append(arg) |
paul@0 | 191 | |
paul@0 | 192 | # Generate a list of events found on pages belonging to the specified |
paul@0 | 193 | # categories, as found in the macro arguments. |
paul@0 | 194 | |
paul@0 | 195 | events = [] |
paul@2 | 196 | shown_events = {} |
paul@2 | 197 | |
paul@1 | 198 | earliest = None |
paul@1 | 199 | latest = None |
paul@0 | 200 | |
paul@0 | 201 | for category_name in category_names: |
paul@0 | 202 | |
paul@0 | 203 | # Get the pages and page names in the category. |
paul@0 | 204 | |
paul@0 | 205 | pages_in_category = getPages(category_name, request) |
paul@0 | 206 | |
paul@0 | 207 | # Visit each page in the category. |
paul@0 | 208 | |
paul@0 | 209 | for page_in_category in pages_in_category: |
paul@0 | 210 | pagename = page_in_category.page_name |
paul@0 | 211 | |
paul@0 | 212 | # Get a real page, not a result page. |
paul@0 | 213 | |
paul@0 | 214 | real_page_in_category = Page(request, pagename) |
paul@0 | 215 | event_details = getEventDetails(real_page_in_category) |
paul@0 | 216 | event = (real_page_in_category, event_details) |
paul@0 | 217 | events.append(event) |
paul@0 | 218 | |
paul@0 | 219 | # Test for the suitability of the event. |
paul@0 | 220 | |
paul@0 | 221 | if event_details.has_key("start") and event_details.has_key("end"): |
paul@0 | 222 | |
paul@0 | 223 | start_month = event_details["start"][:2] |
paul@0 | 224 | end_month = event_details["end"][:2] |
paul@0 | 225 | |
paul@0 | 226 | # Compare the months of the dates to the requested calendar |
paul@0 | 227 | # window, if any. |
paul@0 | 228 | |
paul@0 | 229 | if (calendar_start is None or end_month >= calendar_start) and \ |
paul@0 | 230 | (calendar_end is None or start_month <= calendar_end): |
paul@0 | 231 | |
paul@0 | 232 | if earliest is None or start_month < earliest: |
paul@0 | 233 | earliest = start_month |
paul@0 | 234 | if latest is None or end_month > latest: |
paul@0 | 235 | latest = end_month |
paul@0 | 236 | |
paul@2 | 237 | # Store the event in the month-specific dictionary. |
paul@2 | 238 | |
paul@2 | 239 | first = max(start_month, calendar_start or start_month) |
paul@2 | 240 | last = min(end_month, calendar_end or end_month) |
paul@2 | 241 | |
paul@2 | 242 | for event_month in monthrange(first, last): |
paul@2 | 243 | if not shown_events.has_key(event_month): |
paul@2 | 244 | shown_events[event_month] = [] |
paul@2 | 245 | shown_events[event_month].append(event) |
paul@2 | 246 | |
paul@0 | 247 | # Make a calendar. |
paul@0 | 248 | |
paul@0 | 249 | output = [] |
paul@0 | 250 | |
paul@2 | 251 | if mode == "list": |
paul@2 | 252 | output.append(fmt.bullet_list(on=1, attr={"class" : "event-listings"})) |
paul@0 | 253 | |
paul@2 | 254 | # Visit all months in the requested range, or across known events. |
paul@0 | 255 | |
paul@2 | 256 | first = calendar_start or earliest |
paul@2 | 257 | last = calendar_end or latest |
paul@1 | 258 | |
paul@2 | 259 | for year, month in monthrange(first, last): |
paul@2 | 260 | |
paul@2 | 261 | # Either output a calendar view... |
paul@0 | 262 | |
paul@2 | 263 | if mode == "calendar": |
paul@2 | 264 | |
paul@2 | 265 | # Output a month. |
paul@2 | 266 | |
paul@2 | 267 | output.append(fmt.table(on=1, attrs={"tableclass" : "event-month"})) |
paul@0 | 268 | |
paul@2 | 269 | output.append(fmt.table_row(on=1)) |
paul@2 | 270 | output.append(fmt.table_cell(on=1, attrs={"class" : "event-month-heading", "colspan" : "7"})) |
paul@2 | 271 | output.append(fmt.span(on=1)) |
paul@2 | 272 | output.append(fmt.text(_(month_labels[month - 1]))) # zero-based labels |
paul@2 | 273 | output.append(fmt.span(on=0)) |
paul@2 | 274 | output.append(fmt.text(" ")) |
paul@2 | 275 | output.append(fmt.span(on=1)) |
paul@2 | 276 | output.append(fmt.text(year)) |
paul@2 | 277 | output.append(fmt.span(on=0)) |
paul@2 | 278 | output.append(fmt.table_cell(on=0)) |
paul@2 | 279 | output.append(fmt.table_row(on=0)) |
paul@0 | 280 | |
paul@2 | 281 | # Weekday headings. |
paul@0 | 282 | |
paul@2 | 283 | output.append(fmt.table_row(on=1)) |
paul@0 | 284 | |
paul@2 | 285 | for weekday in range(0, 7): |
paul@2 | 286 | output.append(fmt.table_cell(on=1, attrs={"class" : "event-day-heading"})) |
paul@2 | 287 | output.append(fmt.text(_(weekday_labels[weekday]))) |
paul@0 | 288 | output.append(fmt.table_cell(on=0)) |
paul@2 | 289 | |
paul@2 | 290 | output.append(fmt.table_row(on=0)) |
paul@2 | 291 | |
paul@2 | 292 | # Process the days of the month. |
paul@2 | 293 | |
paul@2 | 294 | start_weekday, number_of_days = calendar.monthrange(year, month) |
paul@0 | 295 | |
paul@2 | 296 | # The start weekday is the weekday of day number 1. |
paul@2 | 297 | # Find the first day of the week, counting from below zero, if |
paul@2 | 298 | # necessary, in order to land on the first day of the month as |
paul@2 | 299 | # day number 1. |
paul@2 | 300 | |
paul@2 | 301 | first_day = 1 - start_weekday |
paul@2 | 302 | |
paul@2 | 303 | while first_day <= number_of_days: |
paul@2 | 304 | |
paul@2 | 305 | # Output a week. |
paul@0 | 306 | |
paul@0 | 307 | output.append(fmt.table_row(on=1)) |
paul@0 | 308 | |
paul@0 | 309 | for weekday in range(0, 7): |
paul@2 | 310 | day = first_day + weekday |
paul@2 | 311 | |
paul@2 | 312 | # Output out-of-month days. |
paul@2 | 313 | |
paul@2 | 314 | if day < 1 or day > number_of_days: |
paul@2 | 315 | output.append(fmt.table_cell(on=1, attrs={"class" : "event-day event-day-excluded"})) |
paul@2 | 316 | output.append(fmt.table_cell(on=0)) |
paul@2 | 317 | |
paul@2 | 318 | # Output normal days. |
paul@2 | 319 | |
paul@2 | 320 | else: |
paul@2 | 321 | # Get event details. |
paul@2 | 322 | # NOTE: Can be made more efficient. |
paul@2 | 323 | |
paul@2 | 324 | date = (year, month, day) |
paul@2 | 325 | day_events = [] |
paul@2 | 326 | |
paul@2 | 327 | for event_page, event_details in shown_events.get((year, month), []): |
paul@2 | 328 | |
paul@2 | 329 | # Test for the event on the current day. |
paul@2 | 330 | |
paul@2 | 331 | if event_details["start"] <= date <= event_details["end"]: |
paul@2 | 332 | day_events.append((event_page, event_details)) |
paul@2 | 333 | |
paul@2 | 334 | # Output the day. |
paul@2 | 335 | |
paul@2 | 336 | if day_events: |
paul@2 | 337 | output.append(fmt.table_cell(on=1, attrs={"class" : "event-day event-day-busy"})) |
paul@2 | 338 | else: |
paul@2 | 339 | output.append(fmt.table_cell(on=1, attrs={"class" : "event-day event-day-empty"})) |
paul@2 | 340 | |
paul@2 | 341 | output.append(fmt.div(on=1)) |
paul@2 | 342 | output.append(fmt.span(on=1, css_class="event-day-number")) |
paul@2 | 343 | output.append(fmt.text(day)) |
paul@2 | 344 | output.append(fmt.span(on=0)) |
paul@2 | 345 | output.append(fmt.div(on=0)) |
paul@2 | 346 | |
paul@2 | 347 | output.append(fmt.div(on=1, css_class="event-summaries")) |
paul@2 | 348 | |
paul@2 | 349 | # Show event details. |
paul@2 | 350 | |
paul@2 | 351 | for event_page, event_details in day_events: |
paul@2 | 352 | |
paul@2 | 353 | # Get a pretty version of the page name. |
paul@2 | 354 | |
paul@2 | 355 | pretty_pagename = getPrettyPageName(event_page) |
paul@2 | 356 | |
paul@2 | 357 | # Generate a colour for the event. |
paul@2 | 358 | |
paul@2 | 359 | bg = getColour(event_page.page_name) |
paul@2 | 360 | fg = getBlackOrWhite(bg) |
paul@2 | 361 | |
paul@2 | 362 | # Output the event. |
paul@2 | 363 | |
paul@2 | 364 | output.append(fmt.div(on=1, css_class="event-summary", |
paul@2 | 365 | style=("background-color: rgb(%d, %d, %d); color: rgb(%d, %d, %d);" % (bg + fg)))) |
paul@2 | 366 | output.append(event_page.link_to_raw(request, wikiutil.escape(pretty_pagename))) |
paul@2 | 367 | output.append(fmt.div(on=0)) |
paul@2 | 368 | |
paul@2 | 369 | output.append(fmt.div(on=0)) |
paul@2 | 370 | |
paul@2 | 371 | # End of day. |
paul@2 | 372 | |
paul@2 | 373 | output.append(fmt.table_cell(on=0)) |
paul@0 | 374 | |
paul@0 | 375 | output.append(fmt.table_row(on=0)) |
paul@0 | 376 | |
paul@2 | 377 | first_day += 7 |
paul@0 | 378 | |
paul@2 | 379 | # End of month. |
paul@0 | 380 | |
paul@2 | 381 | output.append(fmt.table(on=0)) |
paul@0 | 382 | |
paul@2 | 383 | # Or output a summary view... |
paul@0 | 384 | |
paul@2 | 385 | elif mode == "list": |
paul@0 | 386 | |
paul@2 | 387 | output.append(fmt.listitem(on=1, attr={"class" : "event-listings-month"})) |
paul@2 | 388 | output.append(fmt.div(on=1, attr={"class" : "event-listings-month-heading"})) |
paul@2 | 389 | output.append(fmt.span(on=1)) |
paul@2 | 390 | output.append(fmt.text(_(month_labels[month - 1]))) # zero-based labels |
paul@2 | 391 | output.append(fmt.span(on=0)) |
paul@2 | 392 | output.append(fmt.text(" ")) |
paul@2 | 393 | output.append(fmt.span(on=1)) |
paul@2 | 394 | output.append(fmt.text(year)) |
paul@2 | 395 | output.append(fmt.span(on=0)) |
paul@2 | 396 | output.append(fmt.div(on=0)) |
paul@0 | 397 | |
paul@2 | 398 | output.append(fmt.bullet_list(on=1, attr={"class" : "event-month-listings"})) |
paul@0 | 399 | |
paul@2 | 400 | for event_page, event_details in shown_events.get((year, month), []): |
paul@0 | 401 | |
paul@2 | 402 | # Get a pretty version of the page name. |
paul@0 | 403 | |
paul@2 | 404 | pretty_pagename = getPrettyPageName(event_page) |
paul@0 | 405 | |
paul@2 | 406 | output.append(fmt.listitem(on=1, attr={"class" : "event-listing"})) |
paul@0 | 407 | |
paul@2 | 408 | # Link to the page using the pretty name. |
paul@0 | 409 | |
paul@2 | 410 | output.append(event_page.link_to_raw(request, wikiutil.escape(pretty_pagename))) |
paul@0 | 411 | |
paul@2 | 412 | # Add the event details. |
paul@0 | 413 | |
paul@2 | 414 | output.append(fmt.definition_list(on=1, attr={"class" : "event-details"})) |
paul@0 | 415 | |
paul@2 | 416 | for key, value in event_details.items(): |
paul@2 | 417 | output.append(fmt.definition_term(on=1)) |
paul@2 | 418 | output.append(fmt.text(key)) |
paul@2 | 419 | output.append(fmt.definition_term(on=0)) |
paul@2 | 420 | output.append(fmt.definition_desc(on=1)) |
paul@2 | 421 | output.append(fmt.text(value)) |
paul@2 | 422 | output.append(fmt.definition_desc(on=0)) |
paul@0 | 423 | |
paul@2 | 424 | output.append(fmt.definition_list(on=0)) |
paul@2 | 425 | output.append(fmt.listitem(on=0)) |
paul@0 | 426 | |
paul@2 | 427 | output.append(fmt.bullet_list(on=0)) |
paul@0 | 428 | |
paul@2 | 429 | if mode == "list": |
paul@0 | 430 | output.append(fmt.bullet_list(on=0)) |
paul@0 | 431 | |
paul@0 | 432 | return ''.join(output) |
paul@0 | 433 | |
paul@0 | 434 | # vim: tabstop=4 expandtab shiftwidth=4 |