1 # -*- coding: iso-8859-1 -*- 2 """ 3 MoinMoin - EventAggregator Macro 4 5 @copyright: 2008, 2009 by Paul Boddie <paul@boddie.org.uk> 6 @copyright: 2000-2004 Juergen Hermann <jh@web.de>, 7 2005-2008 MoinMoin:ThomasWaldmann. 8 @license: GNU GPL (v2 or later), see COPYING.txt for details. 9 """ 10 11 from MoinMoin import wikiutil 12 import EventAggregatorSupport 13 import calendar 14 15 linkToPage = EventAggregatorSupport.linkToPage 16 17 try: 18 set 19 except NameError: 20 from sets import Set as set 21 22 Dependencies = ['pages'] 23 24 # HTML-related functions. 25 26 def getColour(s): 27 colour = [0, 0, 0] 28 digit = 0 29 for c in s: 30 colour[digit] += ord(c) 31 colour[digit] = colour[digit] % 256 32 digit += 1 33 digit = digit % 3 34 return tuple(colour) 35 36 def getBlackOrWhite(colour): 37 if sum(colour) / 3.0 > 127: 38 return (0, 0, 0) 39 else: 40 return (255, 255, 255) 41 42 def getMonthActionQueryString(argname, month): 43 if month is not None: 44 return "%s=%04d-%02d" % ((argname,) + month) 45 else: 46 return "" 47 48 def getMonthQueryString(calendar_name, argname, month): 49 if month is not None: 50 return "%s-%s=%04d-%02d" % ((calendar_name, argname) + month) 51 else: 52 return "" 53 54 # Macro functions. 55 56 def execute(macro, args): 57 58 """ 59 Execute the 'macro' with the given 'args': an optional list of selected 60 category names (categories whose pages are to be shown), together with 61 optional named arguments of the following forms: 62 63 start=YYYY-MM shows event details starting from the specified month 64 start=current-N shows event details relative to the current month 65 end=YYYY-MM shows event details ending at the specified month 66 end=current+N shows event details relative to the current month 67 68 mode=calendar shows a calendar view of events 69 mode=list shows a list of events by month 70 mode=ics provides iCalendar data for the events 71 72 names=daily shows the name of an event on every day of that event 73 names=weekly shows the name of an event once per week 74 75 calendar=NAME uses the given NAME to provide request parameters which 76 can be used to control the calendar view 77 """ 78 79 request = macro.request 80 fmt = macro.formatter 81 page = fmt.page 82 _ = request.getText 83 84 # Interpret the arguments. 85 86 try: 87 parsed_args = args and wikiutil.parse_quoted_separated(args, name_value=False) or [] 88 except AttributeError: 89 parsed_args = args.split(",") 90 91 parsed_args = [arg for arg in parsed_args if arg] 92 93 # Get special arguments. 94 95 category_names = [] 96 calendar_start = None 97 calendar_end = None 98 mode = "calendar" 99 name_usage = "weekly" 100 calendar_name = None 101 102 for arg in parsed_args: 103 if arg.startswith("start="): 104 calendar_start = EventAggregatorSupport.getParameterMonth(arg[6:]) 105 106 elif arg.startswith("end="): 107 calendar_end = EventAggregatorSupport.getParameterMonth(arg[4:]) 108 109 elif arg.startswith("mode="): 110 mode = arg[5:] 111 112 elif arg.startswith("names="): 113 name_usage = arg[6:] 114 115 elif arg.startswith("calendar="): 116 calendar_name = arg[9:] 117 118 else: 119 category_names.append(arg) 120 121 # Find request parameters to override settings. 122 123 if calendar_name is not None: 124 calendar_start = EventAggregatorSupport.getFormMonth(request, calendar_name, "start") or calendar_start 125 calendar_end = EventAggregatorSupport.getFormMonth(request, calendar_name, "end") or calendar_end 126 127 # Get the events. 128 129 events, shown_events, all_shown_events, earliest, latest = \ 130 EventAggregatorSupport.getEvents(request, category_names, calendar_start, calendar_end) 131 132 # Get a concrete period of time. 133 134 first, last = EventAggregatorSupport.getConcretePeriod(calendar_start, calendar_end, earliest, latest) 135 136 # Define some useful navigation months. 137 138 if calendar_name is not None: 139 span = EventAggregatorSupport.span(first, last) 140 number_of_months = span[0] * 12 + span[1] + 1 141 142 previous_month_start = EventAggregatorSupport.prevmonth(first) 143 next_month_start = EventAggregatorSupport.nextmonth(first) 144 previous_month_end = EventAggregatorSupport.prevmonth(last) 145 next_month_end = EventAggregatorSupport.nextmonth(last) 146 147 previous_set_start = EventAggregatorSupport.monthupdate(first, -number_of_months) 148 next_set_start = EventAggregatorSupport.monthupdate(first, number_of_months) 149 previous_set_end = EventAggregatorSupport.monthupdate(last, -number_of_months) 150 next_set_end = EventAggregatorSupport.monthupdate(last, number_of_months) 151 152 # Make a calendar. 153 154 output = [] 155 156 # Output download controls. 157 158 download_all_link = "action=EventAggregatorSummary&doit=1&%s" % ( 159 "&".join([("category=%s" % name) for name in category_names]) 160 ) 161 download_link = download_all_link + ("&%s&%s" % ( 162 getMonthActionQueryString("start", calendar_start), 163 getMonthActionQueryString("end", calendar_end) 164 )) 165 subscribe_all_link = download_all_link + "&format=RSS" 166 subscribe_link = download_link + "&format=RSS" 167 168 output.append(fmt.div(on=1, css_class="event-controls")) 169 output.append(fmt.span(on=1, css_class="event-download")) 170 output.append(linkToPage(request, page, _("Download this view"), download_link)) 171 output.append(fmt.span(on=0)) 172 output.append(fmt.span(on=1, css_class="event-download")) 173 output.append(linkToPage(request, page, _("Download this calendar"), download_all_link)) 174 output.append(fmt.span(on=0)) 175 output.append(fmt.span(on=1, css_class="event-download")) 176 output.append(linkToPage(request, page, _("Subscribe to this view"), subscribe_link)) 177 output.append(fmt.span(on=0)) 178 output.append(fmt.span(on=1, css_class="event-download")) 179 output.append(linkToPage(request, page, _("Subscribe to this calendar"), subscribe_all_link)) 180 output.append(fmt.span(on=0)) 181 output.append(fmt.div(on=0)) 182 183 # Output top-level information. 184 185 if mode == "list": 186 output.append(fmt.bullet_list(on=1, attr={"class" : "event-listings"})) 187 188 # Visit all months in the requested range, or across known events. 189 190 for year, month in EventAggregatorSupport.daterange(first, last): 191 192 # Either output a calendar view... 193 194 if mode == "calendar": 195 196 # Output a month. 197 198 output.append(fmt.table(on=1, attrs={"tableclass" : "event-month"})) 199 200 output.append(fmt.table_row(on=1)) 201 output.append(fmt.table_cell(on=1, attrs={"class" : "event-month-heading", "colspan" : "21"})) 202 203 # Either write a month heading or produce a link for navigable 204 # calendars. 205 206 month_label = _(EventAggregatorSupport.getMonthLabel(month)) 207 208 if calendar_name is not None: 209 210 # Links to the previous set of months and to a calendar shifted 211 # back one month. 212 213 previous_set_link = "%s&%s" % ( 214 getMonthQueryString(calendar_name, "start", previous_set_start), 215 getMonthQueryString(calendar_name, "end", previous_set_end) 216 ) 217 previous_month_link = "%s&%s" % ( 218 getMonthQueryString(calendar_name, "start", previous_month_start), 219 getMonthQueryString(calendar_name, "end", previous_month_end) 220 ) 221 222 output.append(fmt.span(on=1, css_class="previous-month")) 223 output.append(linkToPage(request, page, "<<", previous_set_link)) 224 output.append(fmt.text(" ")) 225 output.append(linkToPage(request, page, "<", previous_month_link)) 226 output.append(fmt.span(on=0)) 227 228 # Links to the next set of months and to a calendar shifted 229 # forward one month. 230 231 next_set_link = "%s&%s" % ( 232 getMonthQueryString(calendar_name, "start", next_set_start), 233 getMonthQueryString(calendar_name, "end", next_set_end) 234 ) 235 next_month_link = "%s&%s" % ( 236 getMonthQueryString(calendar_name, "start", next_month_start), 237 getMonthQueryString(calendar_name, "end", next_month_end) 238 ) 239 240 output.append(fmt.span(on=1, css_class="next-month")) 241 output.append(linkToPage(request, page, ">", next_month_link)) 242 output.append(fmt.text(" ")) 243 output.append(linkToPage(request, page, ">>", next_set_link)) 244 output.append(fmt.span(on=0)) 245 246 # A link leading to this month being at the top of the calendar. 247 248 full_month_label = "%s %s" % (month_label, year) 249 end_month = EventAggregatorSupport.monthupdate((year, month), number_of_months - 1) 250 251 month_link = "%s&%s" % ( 252 getMonthQueryString(calendar_name, "start", (year, month)), 253 getMonthQueryString(calendar_name, "end", end_month) 254 ) 255 output.append(linkToPage(request, page, full_month_label, month_link)) 256 257 else: 258 output.append(fmt.span(on=1)) 259 output.append(fmt.text(month_label)) 260 output.append(fmt.span(on=0)) 261 output.append(fmt.text(" ")) 262 output.append(fmt.span(on=1)) 263 output.append(fmt.text(unicode(year))) 264 output.append(fmt.span(on=0)) 265 266 output.append(fmt.table_cell(on=0)) 267 output.append(fmt.table_row(on=0)) 268 269 # Weekday headings. 270 271 output.append(fmt.table_row(on=1)) 272 273 for weekday in range(0, 7): 274 output.append(fmt.table_cell(on=1, attrs={"class" : "event-weekday-heading", "colspan" : "3"})) 275 output.append(fmt.text(_(EventAggregatorSupport.getDayLabel(weekday)))) 276 output.append(fmt.table_cell(on=0)) 277 278 output.append(fmt.table_row(on=0)) 279 280 # Process the days of the month. 281 282 start_weekday, number_of_days = calendar.monthrange(year, month) 283 284 # The start weekday is the weekday of day number 1. 285 # Find the first day of the week, counting from below zero, if 286 # necessary, in order to land on the first day of the month as 287 # day number 1. 288 289 first_day = 1 - start_weekday 290 291 while first_day <= number_of_days: 292 293 # Find events in this week and determine how to mark them on the 294 # calendar. 295 296 week_start = (year, month, max(first_day, 1)) 297 week_end = (year, month, min(first_day + 6, number_of_days)) 298 299 week_coverage, week_events = EventAggregatorSupport.getCoverage( 300 week_start, week_end, shown_events.get((year, month), [])) 301 302 # Output a week, starting with the day numbers. 303 304 output.append(fmt.table_row(on=1)) 305 306 for weekday in range(0, 7): 307 day = first_day + weekday 308 date = (year, month, day) 309 310 # Output out-of-month days. 311 312 if day < 1 or day > number_of_days: 313 output.append(fmt.table_cell(on=1, attrs={"class" : "event-day-heading event-day-excluded", "colspan" : "3"})) 314 output.append(fmt.table_cell(on=0)) 315 316 # Output normal days. 317 318 else: 319 if date in week_coverage: 320 output.append(fmt.table_cell(on=1, attrs={"class" : "event-day-heading event-day-busy", "colspan" : "3"})) 321 else: 322 output.append(fmt.table_cell(on=1, attrs={"class" : "event-day-heading event-day-empty", "colspan" : "3"})) 323 324 output.append(fmt.div(on=1)) 325 output.append(fmt.span(on=1, css_class="event-day-number")) 326 output.append(fmt.text(unicode(day))) 327 output.append(fmt.span(on=0)) 328 output.append(fmt.div(on=0)) 329 330 # End of day. 331 332 output.append(fmt.table_cell(on=0)) 333 334 # End of day numbers. 335 336 output.append(fmt.table_row(on=0)) 337 338 # Either generate empty days... 339 340 if not week_events: 341 output.append(fmt.table_row(on=1)) 342 343 for weekday in range(0, 7): 344 day = first_day + weekday 345 date = (year, month, day) 346 347 # Output out-of-month days. 348 349 if day < 1 or day > number_of_days: 350 output.append(fmt.table_cell(on=1, 351 attrs={"class" : "event-day-content event-day-excluded", "colspan" : "3"})) 352 output.append(fmt.table_cell(on=0)) 353 354 # Output empty days. 355 356 else: 357 output.append(fmt.table_cell(on=1, 358 attrs={"class" : "event-day-content event-day-empty", "colspan" : "3"})) 359 360 output.append(fmt.table_row(on=0)) 361 362 # Or visit each set of scheduled events... 363 364 else: 365 for coverage, events in week_events: 366 367 # Output each set. 368 369 output.append(fmt.table_row(on=1)) 370 371 # Then, output day details. 372 373 for weekday in range(0, 7): 374 day = first_day + weekday 375 date = (year, month, day) 376 377 # Skip out-of-month days. 378 379 if day < 1 or day > number_of_days: 380 output.append(fmt.table_cell(on=1, 381 attrs={"class" : "event-day-content event-day-excluded", "colspan" : "3"})) 382 output.append(fmt.table_cell(on=0)) 383 continue 384 385 # Output the day. 386 387 if date not in coverage: 388 output.append(fmt.table_cell(on=1, 389 attrs={"class" : "event-day-content event-day-empty", "colspan" : "3"})) 390 391 # Get event details for the current day. 392 393 for event_page, event_details in events: 394 if not (event_details["start"] <= date <= event_details["end"]): 395 continue 396 397 # Get basic properties of the event. 398 399 starts_today = event_details["start"] == date 400 ends_today = event_details["end"] == date 401 event_summary = EventAggregatorSupport.getEventSummary(event_page, event_details) 402 403 # Generate a colour for the event. 404 405 bg = getColour(event_page.page_name) 406 fg = getBlackOrWhite(bg) 407 style = ("background-color: rgb(%d, %d, %d); color: rgb(%d, %d, %d);" % (bg + fg)) 408 409 # Determine if the event name should be shown. 410 411 start_of_period = starts_today or weekday == 0 or day == 1 412 413 if name_usage == "daily" or start_of_period: 414 hide_text = 0 415 else: 416 hide_text = 1 417 418 # Output start of day gap and determine whether 419 # any event content should be explicitly output 420 # for this day. 421 422 if starts_today: 423 424 # Single day events... 425 426 if ends_today: 427 colspan = 3 428 event_day_type = "event-day-single" 429 430 # Events starting today... 431 432 else: 433 output.append(fmt.table_cell(on=1, attrs={"class" : "event-day-start-gap"})) 434 output.append(fmt.table_cell(on=0)) 435 436 # Calculate the span of this cell. 437 # Events whose names appear on every day... 438 439 if name_usage == "daily": 440 colspan = 2 441 event_day_type = "event-day-starting" 442 443 # Events whose names appear once per week... 444 445 else: 446 if event_details["end"] <= week_end: 447 event_length = event_details["end"][2] - day + 1 448 colspan = (event_length - 2) * 3 + 4 449 else: 450 event_length = week_end[2] - day + 1 451 colspan = (event_length - 1) * 3 + 2 452 453 event_day_type = "event-day-multiple" 454 455 # Events continuing from a previous week... 456 457 elif start_of_period: 458 459 # End of continuing event... 460 461 if ends_today: 462 colspan = 2 463 event_day_type = "event-day-ending" 464 465 # Events continuing for at least one more day... 466 467 else: 468 469 # Calculate the span of this cell. 470 # Events whose names appear on every day... 471 472 if name_usage == "daily": 473 colspan = 3 474 event_day_type = "event-day-full" 475 476 # Events whose names appear once per week... 477 478 else: 479 if event_details["end"] <= week_end: 480 event_length = event_details["end"][2] - day + 1 481 colspan = (event_length - 1) * 3 + 2 482 else: 483 event_length = week_end[2] - day + 1 484 colspan = event_length * 3 485 486 event_day_type = "event-day-multiple" 487 488 # Continuing events whose names appear on every day... 489 490 elif name_usage == "daily": 491 if ends_today: 492 colspan = 2 493 event_day_type = "event-day-ending" 494 else: 495 colspan = 3 496 event_day_type = "event-day-full" 497 498 # Continuing events whose names appear once per week... 499 500 else: 501 colspan = None 502 503 # Output the main content only if it is not 504 # continuing from a previous day. 505 506 if colspan is not None: 507 508 # Colour the cell for continuing events. 509 510 attrs={ 511 "class" : "event-day-content event-day-busy %s" % event_day_type, 512 "colspan" : str(colspan) 513 } 514 515 if not (starts_today and ends_today): 516 attrs["style"] = style 517 518 output.append(fmt.table_cell(on=1, attrs=attrs)) 519 520 # Output the event. 521 522 if starts_today and ends_today or not hide_text: 523 524 output.append(fmt.div(on=1, css_class="event-summary-box")) 525 output.append(fmt.div(on=1, css_class="event-summary", style=style)) 526 output.append(linkToPage(request, event_page, event_summary)) 527 output.append(fmt.div(on=0)) 528 529 # Add a pop-up element for long summaries. 530 531 output.append(fmt.div(on=1, css_class="event-summary-popup", style=style)) 532 output.append(linkToPage(request, event_page, event_summary)) 533 output.append(fmt.div(on=0)) 534 535 output.append(fmt.div(on=0)) 536 537 # Output end of day content. 538 539 output.append(fmt.div(on=0)) 540 541 # Output end of day gap. 542 543 if ends_today and not starts_today: 544 output.append(fmt.table_cell(on=1, attrs={"class" : "event-day-end-gap"})) 545 output.append(fmt.table_cell(on=0)) 546 547 # End of day. 548 549 output.append(fmt.table_cell(on=0)) 550 551 # End of set. 552 553 output.append(fmt.table_row(on=0)) 554 555 # Add a spacer. 556 557 output.append(fmt.table_row(on=1)) 558 559 for weekday in range(0, 7): 560 day = first_day + weekday 561 css_classes = "event-day-spacer" 562 563 # Skip out-of-month days. 564 565 if day < 1 or day > number_of_days: 566 css_classes += " event-day-excluded" 567 568 output.append(fmt.table_cell(on=1, attrs={"class" : css_classes, "colspan" : "3"})) 569 output.append(fmt.table_cell(on=0)) 570 571 output.append(fmt.table_row(on=0)) 572 573 # Process the next week... 574 575 first_day += 7 576 577 # End of month. 578 579 output.append(fmt.table(on=0)) 580 581 # Or output a summary view... 582 583 elif mode == "list": 584 585 month_label = _(EventAggregatorSupport.getMonthLabel(month)) 586 587 output.append(fmt.listitem(on=1, attr={"class" : "event-listings-month"})) 588 output.append(fmt.div(on=1, attr={"class" : "event-listings-month-heading"})) 589 output.append(fmt.span(on=1)) 590 output.append(fmt.text(month_label)) 591 output.append(fmt.span(on=0)) 592 output.append(fmt.text(" ")) 593 output.append(fmt.span(on=1)) 594 output.append(fmt.text(unicode(year))) 595 output.append(fmt.span(on=0)) 596 output.append(fmt.div(on=0)) 597 598 output.append(fmt.bullet_list(on=1, attr={"class" : "event-month-listings"})) 599 600 # Get the events in order. 601 602 ordered_events = EventAggregatorSummary.getOrderedEvents(shown_events.get((year, month), [])) 603 604 # Show the events in order. 605 606 for event_page, event_details in ordered_events: 607 event_summary = EventAggregatorSupport.getEventSummary(event_page, event_details) 608 609 output.append(fmt.listitem(on=1, attr={"class" : "event-listing"})) 610 611 # Link to the page using the summary. 612 613 output.append(fmt.paragraph(on=1)) 614 output.append(linkToPage(request, event_page, event_summary)) 615 output.append(fmt.paragraph(on=0)) 616 617 # Start and end dates. 618 619 output.append(fmt.paragraph(on=1)) 620 output.append(fmt.span(on=1)) 621 output.append(fmt.text("%04d-%02d-%02d" % event_details["start"])) 622 output.append(fmt.span(on=0)) 623 output.append(fmt.text(" - ")) 624 output.append(fmt.span(on=1)) 625 output.append(fmt.text("%04d-%02d-%02d" % event_details["end"])) 626 output.append(fmt.span(on=0)) 627 output.append(fmt.paragraph(on=0)) 628 629 # Location. 630 631 if event_details.has_key("location"): 632 output.append(fmt.paragraph(on=1)) 633 output.append(fmt.text(event_details["location"])) 634 output.append(fmt.paragraph(on=1)) 635 636 # Topics. 637 638 if event_details.has_key("topics") or event_details.has_key("categories"): 639 output.append(fmt.bullet_list(on=1, attr={"class" : "event-topics"})) 640 641 for topic in event_details.get("topics") or event_details.get("categories"): 642 output.append(fmt.listitem(on=1)) 643 output.append(fmt.text(topic)) 644 output.append(fmt.listitem(on=0)) 645 646 output.append(fmt.bullet_list(on=0)) 647 648 output.append(fmt.listitem(on=0)) 649 650 output.append(fmt.bullet_list(on=0)) 651 652 # Output top-level information. 653 654 # End of list view output. 655 656 if mode == "list": 657 output.append(fmt.bullet_list(on=0)) 658 659 return ''.join(output) 660 661 # vim: tabstop=4 expandtab shiftwidth=4