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 try: 16 set 17 except NameError: 18 from sets import Set as set 19 20 Dependencies = ['pages'] 21 22 # Date labels. 23 24 month_labels = ["January", "February", "March", "April", "May", "June", "July", "August", "September", "October", "November", "December"] 25 weekday_labels = ["Mon", "Tue", "Wed", "Thu", "Fri", "Sat", "Sun"] 26 27 # HTML-related functions. 28 29 def getColour(s): 30 colour = [0, 0, 0] 31 digit = 0 32 for c in s: 33 colour[digit] += ord(c) 34 colour[digit] = colour[digit] % 256 35 digit += 1 36 digit = digit % 3 37 return tuple(colour) 38 39 def getBlackOrWhite(colour): 40 if sum(colour) / 3.0 > 127: 41 return (0, 0, 0) 42 else: 43 return (255, 255, 255) 44 45 # Macro functions. 46 47 def getMonth(arg): 48 if arg in ("current", "next", "last"): 49 date = EventAggregatorSupport.getCurrentMonth() 50 if arg == "next": 51 date = EventAggregatorSupport.monthupdate(date, 1) 52 elif arg == "last": 53 date = EventAggregatorSupport.monthupdate(date, -1) 54 else: 55 date = EventAggregatorSupport.getMonth(arg) 56 return date 57 58 def getFormMonth(request, calendar_name, argname): 59 arg = request.form.get("%s-%s" % (calendar_name, argname), [None])[0] 60 if arg is not None: 61 return getMonth(arg) 62 else: 63 return None 64 65 def execute(macro, args): 66 67 """ 68 Execute the 'macro' with the given 'args': an optional list of selected 69 category names (categories whose pages are to be shown), together with 70 optional named arguments of the following forms: 71 72 start=YYYY-MM shows event details starting from the specified month 73 start=current shows event details starting with the current month 74 start=next shows event details starting with next month 75 end=YYYY-MM shows event details ending at the specified month 76 end=current shows event details ending with the current month 77 end=last shows event details ending with last month 78 span=N shows event details for N months starting with the 79 specified start month, or ending with the specified end 80 month 81 82 mode=calendar shows a calendar view of events 83 mode=list shows a list of events by month 84 mode=ics provides iCalendar data for the events 85 86 names=daily shows the name of an event on every day of that event 87 names=weekly shows the name of an event once per week 88 89 calendar=NAME uses the given NAME to provide request parameters which 90 can be used to control the calendar view 91 """ 92 93 request = macro.request 94 fmt = macro.formatter 95 page = fmt.page 96 _ = request.getText 97 98 # Interpret the arguments. 99 100 try: 101 parsed_args = args and wikiutil.parse_quoted_separated(args, name_value=False) or [] 102 except AttributeError: 103 parsed_args = args.split(",") 104 105 parsed_args = [arg for arg in parsed_args if arg] 106 107 # Get special arguments. 108 109 category_names = [] 110 calendar_start = None 111 calendar_end = None 112 span = None 113 mode = "calendar" 114 name_usage = "daily" 115 calendar_name = None 116 117 for arg in parsed_args: 118 if arg.startswith("start="): 119 calendar_start = getMonth(arg[6:]) 120 121 elif arg.startswith("end="): 122 calendar_end = getMonth(arg[4:]) 123 124 elif arg.startswith("span="): 125 span = abs(int(arg[5:])) 126 127 elif arg.startswith("mode="): 128 mode = arg[5:] 129 130 elif arg.startswith("names="): 131 name_usage = arg[6:] 132 133 elif arg.startswith("calendar="): 134 calendar_name = arg[9:] 135 136 else: 137 category_names.append(arg) 138 139 # Find request parameters to override settings. 140 141 if calendar_name is not None: 142 new_calendar_start = getFormMonth(request, calendar_name, "start") 143 new_calendar_end = getFormMonth(request, calendar_name, "end") 144 if new_calendar_start is not None or new_calendar_end is not None: 145 calendar_start = new_calendar_start 146 calendar_end = new_calendar_end 147 148 # Calculate the window of interest. 149 150 if span is not None: 151 if calendar_start is not None: 152 calendar_end = EventAggregatorSupport.monthupdate(calendar_start, max(0, span - 1)) 153 elif calendar_end is not None: 154 calendar_start = EventAggregatorSupport.monthupdate(calendar_end, min(0, -span + 1)) 155 else: 156 calendar_start = EventAggregatorSupport.getCurrentMonth() 157 calendar_end = EventAggregatorSupport.monthupdate(calendar_start, max(0, span - 1)) 158 159 # Some useful navigation months. 160 161 if calendar_name is not None: 162 previous_year, previous_month = EventAggregatorSupport.prevmonth(calendar_start) 163 next_year, next_month = EventAggregatorSupport.nextmonth(calendar_start) 164 next_set_year, next_set_month = EventAggregatorSupport.nextmonth(calendar_end) 165 166 # Get the events. 167 168 events, shown_events, all_shown_events, earliest, latest = \ 169 EventAggregatorSupport.getEvents(request, category_names, calendar_start, calendar_end) 170 171 # Make a calendar. 172 173 output = [] 174 175 # Output top-level information. 176 177 if mode == "list": 178 output.append(fmt.bullet_list(on=1, attr={"class" : "event-listings"})) 179 180 # Visit all months in the requested range, or across known events. 181 182 first = calendar_start or earliest 183 last = calendar_end or latest 184 185 for year, month in EventAggregatorSupport.daterange(first, last): 186 187 # Either output a calendar view... 188 189 if mode == "calendar": 190 191 # Output a month. 192 193 output.append(fmt.table(on=1, attrs={"tableclass" : "event-month"})) 194 195 output.append(fmt.table_row(on=1)) 196 output.append(fmt.table_cell(on=1, attrs={"class" : "event-month-heading", "colspan" : "7"})) 197 198 # Either write a month heading or produce a link for navigable 199 # calendars. 200 201 month_label = _(month_labels[month - 1]) # zero-based labels 202 203 if calendar_name is not None: 204 previous_months_link = "%s-end=%04d-%02d" % (calendar_name, previous_year, previous_month) 205 previous_month_link = "%s-start=%04d-%02d" % (calendar_name, previous_year, previous_month) 206 207 output.append(fmt.span(on=1, css_class="previous-month")) 208 output.append(page.link_to_raw(request, wikiutil.escape("<<"), previous_months_link)) 209 output.append(fmt.text(" ")) 210 output.append(page.link_to_raw(request, wikiutil.escape("<"), previous_month_link)) 211 output.append(fmt.span(on=0)) 212 213 next_months_link = "%s-start=%04d-%02d" % (calendar_name, next_set_year, next_set_month) 214 next_month_link = "%s-start=%04d-%02d" % (calendar_name, next_year, next_month) 215 216 output.append(fmt.span(on=1, css_class="next-month")) 217 output.append(page.link_to_raw(request, wikiutil.escape(">"), next_month_link)) 218 output.append(fmt.text(" ")) 219 output.append(page.link_to_raw(request, wikiutil.escape(">>"), next_months_link)) 220 output.append(fmt.span(on=0)) 221 222 full_month_label = "%s %s" % (month_label, year) 223 month_link = "%s-start=%04d-%02d" % (calendar_name, year, month) 224 output.append(page.link_to_raw(request, wikiutil.escape(full_month_label), month_link)) 225 226 else: 227 output.append(fmt.span(on=1)) 228 output.append(fmt.text(month_label)) 229 output.append(fmt.span(on=0)) 230 output.append(fmt.text(" ")) 231 output.append(fmt.span(on=1)) 232 output.append(fmt.text(year)) 233 output.append(fmt.span(on=0)) 234 235 output.append(fmt.table_cell(on=0)) 236 output.append(fmt.table_row(on=0)) 237 238 # Weekday headings. 239 240 output.append(fmt.table_row(on=1)) 241 242 for weekday in range(0, 7): 243 output.append(fmt.table_cell(on=1, attrs={"class" : "event-weekday-heading"})) 244 output.append(fmt.text(_(weekday_labels[weekday]))) 245 output.append(fmt.table_cell(on=0)) 246 247 output.append(fmt.table_row(on=0)) 248 249 # Process the days of the month. 250 251 start_weekday, number_of_days = calendar.monthrange(year, month) 252 253 # The start weekday is the weekday of day number 1. 254 # Find the first day of the week, counting from below zero, if 255 # necessary, in order to land on the first day of the month as 256 # day number 1. 257 258 first_day = 1 - start_weekday 259 260 while first_day <= number_of_days: 261 262 # Find events in this week and determine how to mark them on the 263 # calendar. 264 265 week_events = [] 266 week_coverage = set() 267 268 week_start = (year, month, max(first_day, 1)) 269 week_end = (year, month, min(first_day + 6, number_of_days)) 270 271 # Get event details. 272 273 for event in shown_events.get((year, month), []): 274 event_page, event_details = event 275 276 # Test for the event in the current week. 277 278 if event_details["start"] <= week_end and event_details["end"] >= week_start: 279 280 # Find the coverage of this week for the event. 281 282 event_start = max(event_details["start"], week_start) 283 event_end = min(event_details["end"], week_end) 284 event_coverage = set(EventAggregatorSupport.daterange(event_start, event_end)) 285 286 # Update the overall coverage. 287 288 week_coverage.update(event_coverage) 289 290 # Try and fit the event into the events list. 291 292 for i, (coverage, events) in enumerate(week_events): 293 294 # Where the event does not overlap with the current 295 # element, add it alongside existing events. 296 297 if not coverage.intersection(event_coverage): 298 events.append(event) 299 week_events[i] = coverage.union(event_coverage), events 300 break 301 302 # Make a new element in the list if the event cannot be 303 # marked alongside existing events. 304 305 else: 306 week_events.append((event_coverage, [event])) 307 308 # Output a week, starting with the day numbers. 309 310 output.append(fmt.table_row(on=1)) 311 312 for weekday in range(0, 7): 313 day = first_day + weekday 314 date = (year, month, day) 315 316 # Output out-of-month days. 317 318 if day < 1 or day > number_of_days: 319 output.append(fmt.table_cell(on=1, attrs={"class" : "event-day-heading event-day-excluded"})) 320 output.append(fmt.table_cell(on=0)) 321 322 # Output normal days. 323 324 else: 325 if date in week_coverage: 326 output.append(fmt.table_cell(on=1, attrs={"class" : "event-day-heading event-day-busy"})) 327 else: 328 output.append(fmt.table_cell(on=1, attrs={"class" : "event-day-heading event-day-empty"})) 329 330 output.append(fmt.div(on=1)) 331 output.append(fmt.span(on=1, css_class="event-day-number")) 332 output.append(fmt.text(day)) 333 output.append(fmt.span(on=0)) 334 output.append(fmt.div(on=0)) 335 336 # End of day. 337 338 output.append(fmt.table_cell(on=0)) 339 340 # End of day numbers. 341 342 output.append(fmt.table_row(on=0)) 343 344 # Either generate empty days... 345 346 if not week_events: 347 output.append(fmt.table_row(on=1)) 348 349 for weekday in range(0, 7): 350 day = first_day + weekday 351 date = (year, month, day) 352 353 # Output out-of-month days. 354 355 if day < 1 or day > number_of_days: 356 output.append(fmt.table_cell(on=1, attrs={"class" : "event-day event-day-excluded"})) 357 output.append(fmt.table_cell(on=0)) 358 359 # Output empty days. 360 361 else: 362 output.append(fmt.table_cell(on=1, attrs={"class" : "event-day event-day-empty"})) 363 364 output.append(fmt.table_row(on=0)) 365 366 # Or visit each set of scheduled events... 367 368 else: 369 for coverage, events in week_events: 370 371 # Output each set. 372 373 output.append(fmt.table_row(on=1)) 374 375 # Then, output day details. 376 377 for weekday in range(0, 7): 378 day = first_day + weekday 379 date = (year, month, day) 380 381 # Skip out-of-month days. 382 383 if day < 1 or day > number_of_days: 384 output.append(fmt.table_cell(on=1, attrs={"class" : "event-day event-day-excluded"})) 385 output.append(fmt.table_cell(on=0)) 386 continue 387 388 # Output the day. 389 390 if date in coverage: 391 output.append(fmt.table_cell(on=1, attrs={"class" : "event-day event-day-busy"})) 392 else: 393 output.append(fmt.table_cell(on=1, attrs={"class" : "event-day event-day-empty"})) 394 395 # Get event details for the current day. 396 397 for event_page, event_details in events: 398 if not (event_details["start"] <= date <= event_details["end"]): 399 continue 400 401 # Get a pretty version of the page name. 402 403 pretty_pagename = EventAggregatorSupport.getPrettyPageName(event_page) 404 405 # Generate a colour for the event. 406 407 bg = getColour(event_page.page_name) 408 fg = getBlackOrWhite(bg) 409 410 css_classes = ["event-summary"] 411 412 if event_details["start"] == date: 413 css_classes.append("event-starts") 414 start_of_event = 1 415 else: 416 start_of_event = 0 417 418 if event_details["end"] == date: 419 css_classes.append("event-ends") 420 421 # Output the event. 422 423 if name_usage == "daily" or start_of_event or weekday == 0 or day == 1: 424 hide_text = 0 425 else: 426 hide_text = 1 427 428 output.append(fmt.div(on=1, css_class=(" ".join(css_classes)), 429 style=("background-color: rgb(%d, %d, %d); color: rgb(%d, %d, %d);" % (bg + fg)))) 430 431 if not hide_text: 432 output.append(event_page.link_to_raw(request, wikiutil.escape(pretty_pagename))) 433 434 output.append(fmt.div(on=0)) 435 436 # End of day. 437 438 output.append(fmt.table_cell(on=0)) 439 440 # End of set. 441 442 output.append(fmt.table_row(on=0)) 443 444 # Process the next week... 445 446 first_day += 7 447 448 # End of month. 449 450 output.append(fmt.table(on=0)) 451 452 # Or output a summary view... 453 454 elif mode == "list": 455 456 output.append(fmt.listitem(on=1, attr={"class" : "event-listings-month"})) 457 output.append(fmt.div(on=1, attr={"class" : "event-listings-month-heading"})) 458 output.append(fmt.span(on=1)) 459 output.append(fmt.text(_(month_labels[month - 1]))) # zero-based labels 460 output.append(fmt.span(on=0)) 461 output.append(fmt.text(" ")) 462 output.append(fmt.span(on=1)) 463 output.append(fmt.text(year)) 464 output.append(fmt.span(on=0)) 465 output.append(fmt.div(on=0)) 466 467 output.append(fmt.bullet_list(on=1, attr={"class" : "event-month-listings"})) 468 469 for event_page, event_details in shown_events.get((year, month), []): 470 471 # Get a pretty version of the page name. 472 473 pretty_pagename = EventAggregatorSupport.getPrettyPageName(event_page) 474 475 output.append(fmt.listitem(on=1, attr={"class" : "event-listing"})) 476 477 # Link to the page using the pretty name. 478 479 output.append(event_page.link_to_raw(request, wikiutil.escape(pretty_pagename))) 480 481 # Add the event details. 482 483 output.append(fmt.definition_list(on=1, attr={"class" : "event-details"})) 484 485 for key, value in event_details.items(): 486 output.append(fmt.definition_term(on=1)) 487 output.append(fmt.text(key)) 488 output.append(fmt.definition_term(on=0)) 489 output.append(fmt.definition_desc(on=1)) 490 output.append(fmt.text(value)) 491 output.append(fmt.definition_desc(on=0)) 492 493 output.append(fmt.definition_list(on=0)) 494 output.append(fmt.listitem(on=0)) 495 496 output.append(fmt.bullet_list(on=0)) 497 498 # Output top-level information. 499 500 # End of list view output. 501 502 if mode == "list": 503 output.append(fmt.bullet_list(on=0)) 504 505 return ''.join(output) 506 507 # vim: tabstop=4 expandtab shiftwidth=4