WikiCalendarMacro: WikiCalendarMacro.2.py

# Copyright (C) 2005 Matthew Good <trac@matt-good.net>
# Copyright (C) 2005 Jan Finell <finell@cenix-bioscience.com> 
#
# "THE BEER-WARE LICENSE" (Revision 42):
# <trac@matt-good.net> wrote this file.  As long as you retain this notice you
# can do whatever you want with this stuff.  If we meet some day, and you think
# this stuff is worth it, you can buy me a beer in return.  Matthew Good
# (Beer-ware license written by Poul-Henning Kamp
#  http://people.freebsd.org/~phk/)
#
# Author: Matthew Good <trac@matt-good.net>
# Month/Year navigation by: Jan Finell <finell@cenix-bioscience.com>
# trac 0.11 compatibility by: Vlad Sukhoy <vladimir.sukhoy@gmail.com>
# refactored; CSS, Javascript added: Andy Schlaikjer <andrew.schlaikjer@gmail.com>

import time
import calendar
from cStringIO import StringIO
from trac.wiki.api import WikiSystem
from trac.wiki.macros import WikiMacroBase
from trac.util import *

class WikiCalendarMacro(WikiMacroBase):
    
    """Inserts a small calendar where each day links to a wiki page whose name
    matches `wiki-page-format`. The current day is highlighted, and days with
    Milestones are marked in bold. This version requires Javascript and makes
    heavy use of CSS for formatting. Tested in Firefox 2.0 only.
    
    Usage:
    {{{
    [[WikiCalendar([year, [month, [show-buttons, [wiki-page-format]]]])]]
    }}}
    
    Arguments:
     1. `year` (4-digit year) - defaults to `*` (current year)
     1. `month` (2-digit month) - defaults to `*` (current month)
     1. `show-buttons` (boolean) - defaults to `true`
     1. `wiki-page-format` (string) - defaults to `%Y-%m-%d`
    
    Examples:
    {{{
    [[WikiCalendar(2006,07)]]
    [[WikiCalendar(2006,07,false)]]
    [[WikiCalendar(*,*,true,Meeting-%Y-%m-%d)]]
    [[WikiCalendar(2006,07,false,Meeting-%Y-%m-%d)]]
    }}}
    """
    
    def expand_macro(self, formatter, name, content):
        today = time.localtime()
        # VS: The hdf is gone in 0.11, using request object instead
        http_param_year = formatter.req.args.get('year', '')
        http_param_month = formatter.req.args.get('month', '')
        if content == "":
            args = []
        else:
            args = content.split(',', 3)
        
        # find out whether use http param, current or macro param year/month
        
        if http_param_year == "":
            # not clicked on a prev or next button
            if len(args) >= 1 and args[0] <> "*":
                # year given in macro parameters
                year = int(args[0])
            else:
                # use current year
                year = today.tm_year
        else:
            # year in http params (clicked by user) overrides everything
            year = int(http_param_year)
        
        if http_param_month == "":
            # not clicked on a prev or next button
            if len(args) >= 2 and args[1] <> "*":
                # month given in macro parameters
                month = int(args[1])
            else:
                # use current month
                month = today.tm_mon
        else:
            # month in http params (clicked by user) overrides everything
            month = int(http_param_month)
        
        showbuttons = 1
        if len(args) >= 3:
            showbuttons = bool(args[2]=="True" or args[2]=="true" or args[2]=="no" or args[2]=="0")
        
        wiki_page_format = "%Y-%m-%d"
        if len(args) >= 4:
            wiki_page_format = args[3]
        
        curr_day = None
        if year == today.tm_year and month == today.tm_mon:
            curr_day = today.tm_mday
        
        # url to the current page (used in the navigation links)
        # VS: hdf is gone in 0.11, using the new "Context" object instead
        # AS: trac.web.Href object used instead of basic strings
        thispageURL = formatter.context.href
        # for the prev/next navigation links
        prevMonth = month-1
        prevYear  = year
        nextMonth = month+1
        nextYear  = year
        # check for year change (KISS version)
        if prevMonth == 0:
            prevMonth = 12
            prevYear -= 1
        if nextMonth == 13:
            nextMonth = 1
            nextYear += 1
        
        # 9-tuple for use with time.* functions requiring a struct_time
        # argument. The ninth value of -1 signals "do the right thing"
        # w.r.t. daylight savings time.
        date = [0] * 8 + [-1]
        
        # building the output
        buff = StringIO()
        buff.write('''\
<style type="text/css">
<!--
table.wiki-calendar {border-collapse: separate; border-spacing: 0px;}
table.wiki-calendar caption {font-size: 120%; white-space: nowrap;}
table.wiki-calendar span.button {color: #b00; cursor: pointer;}
table.wiki-calendar span.button:hover {background-color: #eee;}
table.wiki-calendar th {width: 2em; border-bottom: 2px solid #000; text-align: center; font-weight: bold;}
table.wiki-calendar td {width: 2em; border: 2px solid transparent; text-align: right; color: #888; cursor: pointer;}
table.wiki-calendar td:hover {background-color: #eee; color: #000;}
table.wiki-calendar td.empty {background-color: #fafafa; cursor: default;}
table.wiki-calendar td.milestone {border-color: #888; font-weight: bold;}
table.wiki-calendar td.haspage {color: #b00;}
table.wiki-calendar td.haspage:hover {color: #b00;}
table.wiki-calendar td.today {border-color: #b00;}
//-->
</style>
<table class="wiki-calendar"><caption>
        ''')
        
        if showbuttons:
            # prev year link
            date[0:2] = [year-1, month]
            buff.write('<span class="button prev" onclick="javascript:self.location=\'%s\'" title="%s">&lt;&lt;</span>' % (
                thispageURL(month=month, year=year-1),
                time.strftime('%B %Y', tuple(date))
                ))
            # prev month link
            date[0:2] = [prevYear, prevMonth]
            buff.write('<span class="button prev" onclick="javascript:self.location=\'%s\'" title="%s">&nbsp;&nbsp;&lt;&nbsp;&nbsp;</span>' % (
                thispageURL(month=prevMonth, year=prevYear),
                time.strftime('%B %Y', tuple(date))
                ))
        
        # the caption
        date[0:2] = [year, month]
        buff.write(time.strftime('%B %Y', tuple(date)))
        
        if showbuttons:
            # next month link
            date[0:2] = [nextYear, nextMonth]
            buff.write('<span class="button next" onclick="javascript:self.location=\'%s\'" title="%s">&nbsp;&nbsp;&gt;&nbsp;&nbsp;</span>' % (
                thispageURL(month=nextMonth, year=nextYear),
                time.strftime('%B %Y', tuple(date))
                ))
            # next year link
            date[0:2] = [year+1, month]
            buff.write('<span class="button next" onclick="javascript:self.location=\'%s\'" title="%s">&gt;&gt;</span>' % (
                thispageURL(month=month, year=year+1),
                time.strftime('%B %Y', tuple(date))
                ))
            
        buff.write('</caption>\n<thead><tr class="header">')
        for day in calendar.weekheader(2).split():
            buff.write('<th scope="col">%s</th>' % day)
        buff.write('</tr></thead>\n<tbody>\n')
        date[0:2] = [year, month]
        for row in calendar.monthcalendar(year, month):
            buff.write('<tr>')
            for day in row:
                date[2] = day
                if not day:
                    buff.write('<td class="empty">&nbsp;</td>')
                    continue
                classes = day == curr_day and 'today' or ''
                url = ''
                title = ''
                # first check for milestone on that day
                db = self.env.get_db_cnx()
                cursor = db.cursor()
                duedate = time.mktime(tuple(date))
                cursor.execute("SELECT name,due FROM milestone WHERE due=%s", (duedate,))
                row = cursor.fetchone()
                if row:
                    # found a milestone
                    milestone_name = row[0]
                    classes += ' milestone'
                    url = self.env.href.milestone(milestone_name)
                    title = milestone_name + ' - '
                # secondly check for wikipage with name specified in 'wiki_page_format'
                wiki = time.strftime(wiki_page_format, tuple(date))
                url = self.env.href.wiki(wiki)
                if WikiSystem(self.env).has_page(wiki):
                    classes += ' haspage'
                    title += 'Go to page %s' % wiki
                else:
                    url += "?action=edit"
                    title += 'Create page %s' % wiki
                buff.write('<td class="%(classes)s" onclick="javascript:self.location=\'%(url)s\'" title="%(title)s">%(day)s</td>' % {
                    'classes': classes.strip(),
                    'url': url,
                    'title': title,
                    'day': day
                    })
            buff.write('</tr>\n')
        buff.write('</tbody>\n</table>')
        table = buff.getvalue()
        buff.close()
        return table