2 # Copyright (c) 2006, 2007 Manoj Srivastava <srivasta@debian.org>
4 # This program is free software; you can redistribute it and/or modify
5 # it under the terms of the GNU General Public License as published by
6 # the Free Software Foundation; either version 2 of the License, or
7 # (at your option) any later version.
9 # This program is distributed in the hope that it will be useful,
10 # but WITHOUT ANY WARRANTY; without even the implied warranty of
11 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 # GNU General Public License for more details.
14 # You should have received a copy of the GNU General Public License
15 # along with this program; if not, write to the Free Software
16 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
19 package IkiWiki::Plugin::calendar;
28 my @now=localtime($time);
31 hook(type => "getsetup", id => "calendar", call => \&getsetup);
32 hook(type => "needsbuild", id => "calendar", call => \&needsbuild);
33 hook(type => "preprocess", id => "calendar", call => \&preprocess);
44 example => "archives",
45 description => "base of the archives hierarchy",
51 sub is_leap_year (@) {
53 return ($params{year} % 4 == 0 && (($params{year} % 100 != 0) || $params{year} % 400 == 0));
58 my $days_in_month = (31,28,31,30,31,30,31,31,30,31,30,31)[$params{month}-1];
59 if ($params{month} == 2 && is_leap_year(%params)) {
62 return $days_in_month;
65 sub format_month (@) {
69 foreach my $p (pagespec_match_list($params{page},
70 "creation_year($params{year}) and creation_month($params{month}) and ($params{pages})",
71 # add presence dependencies to update
72 # month calendar when pages are added/removed
73 deptype => deptype("presence"))) {
74 my $mtime = $IkiWiki::pagectime{$p};
75 my @date = localtime($mtime);
77 my $month = $date[4] + 1;
78 my $year = $date[5] + 1900;
79 my $mtag = sprintf("%02d", $month);
81 # Only one posting per day is being linked to.
82 $linkcache{"$year/$mtag/$mday"} = $p;
85 my $pmonth = $params{month} - 1;
86 my $nmonth = $params{month} + 1;
87 my $pyear = $params{year};
88 my $nyear = $params{year};
90 # Adjust for January and December
91 if ($params{month} == 1) {
95 if ($params{month} == 12) {
101 $pmonth=sprintf("%02d", $pmonth);
102 $nmonth=sprintf("%02d", $nmonth);
106 # When did this month start?
107 my @monthstart = localtime(timelocal(0,0,0,1,$params{month}-1,$params{year}-1900));
111 if ($params{year} == $now[5]+1900 && $params{month} == $now[4]+1) {
112 $future_dom = $now[3]+1;
116 # Find out month names for this, next, and previous months
117 my $monthname=POSIX::strftime("%B", @monthstart);
118 my $pmonthname=POSIX::strftime("%B", localtime(timelocal(0,0,0,1,$pmonth-1,$pyear-1900)));
119 my $nmonthname=POSIX::strftime("%B", localtime(timelocal(0,0,0,1,$nmonth-1,$nyear-1900)));
121 my $archivebase = 'archives';
122 $archivebase = $config{archivebase} if defined $config{archivebase};
123 $archivebase = $params{archivebase} if defined $params{archivebase};
125 # Calculate URL's for monthly archives.
126 my ($url, $purl, $nurl)=("$monthname",'','');
127 if (exists $pagesources{"$archivebase/$params{year}/$params{month}"}) {
128 $url = htmllink($params{page}, $params{destpage},
129 "$archivebase/$params{year}/".$params{month},
131 linktext => " $monthname ");
133 add_depends($params{page}, "$archivebase/$params{year}/$params{month}",
134 deptype("presence"));
135 if (exists $pagesources{"$archivebase/$pyear/$pmonth"}) {
136 $purl = htmllink($params{page}, $params{destpage},
137 "$archivebase/$pyear/$pmonth",
139 linktext => "\&larr");
141 add_depends($params{page}, "$archivebase/$pyear/$pmonth",
142 deptype("presence"));
143 if (exists $pagesources{"$archivebase/$nyear/$nmonth"}) {
144 $nurl = htmllink($params{page}, $params{destpage},
145 "$archivebase/$nyear/$nmonth",
147 linktext => "\&rarr");
149 add_depends($params{page}, "$archivebase/$nyear/$nmonth",
150 deptype("presence"));
152 # Start producing the month calendar
154 <table class="month-calendar">
155 <caption class="month-calendar-head">
163 # Suppose we want to start the week with day $week_start_day
164 # If $monthstart[6] == 1
165 my $week_start_day = $params{week_start_day};
167 my $start_day = 1 + (7 - $monthstart[6] + $week_start_day) % 7;
170 for my $dow ($week_start_day..$week_start_day+6) {
171 my @day=localtime(timelocal(0,0,0,$start_day++,$params{month}-1,$params{year}-1900));
172 my $downame = POSIX::strftime("%A", @day);
173 my $dowabbr = POSIX::strftime("%a", @day);
174 $downame{$dow % 7}=$downame;
175 $dowabbr{$dow % 7}=$dowabbr;
176 $calendar.= qq{\t\t<th class="month-calendar-day-head $downame">$dowabbr</th>\n};
184 # we start with a week_start_day, and skip until we get to the first
185 for ($wday=$week_start_day; $wday != $monthstart[6]; $wday++, $wday %= 7) {
186 $calendar.=qq{\t<tr>\n} if $wday == $week_start_day;
187 $calendar.=qq{\t\t<td class="month-calendar-day-noday $downame{$wday}"> </td>\n};
190 # At this point, either the first is a week_start_day, in which case
191 # nothing has been printed, or else we are in the middle of a row.
192 for (my $day = 1; $day <= month_days(year => $params{year}, month => $params{month});
193 $day++, $wday++, $wday %= 7) {
194 # At tihs point, on a week_start_day, we close out a row,
195 # and start a new one -- unless it is week_start_day on the
196 # first, where we do not close a row -- since none was started.
197 if ($wday == $week_start_day) {
198 $calendar.=qq{\t</tr>\n} unless $day == 1;
199 $calendar.=qq{\t<tr>\n};
203 if (defined $linkcache{"$params{year}/$params{month}/$day"}) {
204 if ($day == $today) {
205 $tag='month-calendar-day-this-day';
208 $tag='month-calendar-day-link';
210 $calendar.=qq{\t\t<td class="$tag $downame{$wday}">};
211 $calendar.=htmllink($params{page}, $params{destpage},
212 $linkcache{"$params{year}/$params{month}/$day"},
214 "linktext" => "$day");
215 $calendar.=qq{</td>\n};
218 if ($day == $today) {
219 $tag='month-calendar-day-this-day';
221 elsif ($day == $future_dom) {
222 $tag='month-calendar-day-future';
225 $tag='month-calendar-day-nolink';
227 $calendar.=qq{\t\t<td class="$tag $downame{$wday}">$day</td>\n};
231 # finish off the week
232 for (; $wday != $week_start_day; $wday++, $wday %= 7) {
233 $calendar.=qq{\t\t<td class="month-calendar-day-noday $downame{$wday}"> </td>\n};
243 sub format_year (@) {
248 my $pyear = $params{year} - 1;
249 my $nyear = $params{year} + 1;
251 my $future_month = 0;
252 $future_month = $now[4]+1 if ($params{year} == $now[5]+1900);
254 my $archivebase = 'archives';
255 $archivebase = $config{archivebase} if defined $config{archivebase};
256 $archivebase = $params{archivebase} if defined $params{archivebase};
258 # calculate URL's for previous and next years
259 my ($url, $purl, $nurl)=("$params{year}",'','');
260 if (exists $pagesources{"$archivebase/$params{year}"}) {
261 $url = htmllink($params{page}, $params{destpage},
262 "$archivebase/$params{year}",
264 linktext => "$params{year}");
266 add_depends($params{page}, "$archivebase/$params{year}", deptype("presence"));
267 if (exists $pagesources{"$archivebase/$pyear"}) {
268 $purl = htmllink($params{page}, $params{destpage},
269 "$archivebase/$pyear",
271 linktext => "\←");
273 add_depends($params{page}, "$archivebase/$pyear", deptype("presence"));
274 if (exists $pagesources{"$archivebase/$nyear"}) {
275 $nurl = htmllink($params{page}, $params{destpage},
276 "$archivebase/$nyear",
278 linktext => "\→");
280 add_depends($params{page}, "$archivebase/$nyear", deptype("presence"));
282 # Start producing the year calendar
284 <table class="year-calendar">
285 <caption class="year-calendar-head">
291 <th class="year-calendar-subhead" colspan="$params{months_per_row}">Months</th>
295 for (my $month = 1; $month <= 12; $month++) {
296 my @day=localtime(timelocal(0,0,0,15,$month-1,$params{year}-1900));
298 my $monthname = POSIX::strftime("%B", @day);
299 my $monthabbr = POSIX::strftime("%b", @day);
300 $calendar.=qq{\t<tr>\n} if ($month % $params{months_per_row} == 1);
302 my $mtag=sprintf("%02d", $month);
303 if ($month == $params{month}) {
304 $tag = 'year-calendar-this-month';
306 elsif ($pagesources{"$archivebase/$params{year}/$mtag"}) {
307 $tag = 'year-calendar-month-link';
309 elsif ($future_month && $month >= $future_month) {
310 $tag = 'year-calendar-month-future';
313 $tag = 'year-calendar-month-nolink';
316 if ($pagesources{"$archivebase/$params{year}/$mtag"}) {
317 $murl = htmllink($params{page}, $params{destpage},
318 "$archivebase/$params{year}/$mtag",
320 linktext => "$monthabbr");
321 $calendar.=qq{\t<td class="$tag">};
323 $calendar.=qq{\t</td>\n};
326 $calendar.=qq{\t<td class="$tag">$monthabbr</td>\n};
328 add_depends($params{page}, "$archivebase/$params{year}/$mtag",
329 deptype("presence"));
331 $calendar.=qq{\t</tr>\n} if ($month % $params{months_per_row} == 0);
344 my $thisyear=1900 + $now[5];
345 my $thismonth=1 + $now[4];
347 $params{pages} = "*" unless defined $params{pages};
348 $params{type} = "month" unless defined $params{type};
349 $params{week_start_day} = 0 unless defined $params{week_start_day};
350 $params{months_per_row} = 3 unless defined $params{months_per_row};
351 $params{year} = $thisyear unless defined $params{year};
352 $params{month} = $thismonth unless defined $params{month};
354 $params{month} = sprintf("%02d", $params{month});
356 if ($params{type} eq 'month' && $params{year} == $thisyear
357 && $params{month} == $thismonth) {
358 # calendar for current month, updates next midnight
359 $pagestate{$params{destpage}}{calendar}{nextchange}=($time
360 + (60 - $now[0]) # seconds
361 + (59 - $now[1]) * 60 # minutes
362 + (23 - $now[2]) * 60 * 60 # hours
365 elsif ($params{type} eq 'month' &&
366 (($params{year} == $thisyear && $params{month} > $thismonth) ||
367 $params{year} > $thisyear)) {
368 # calendar for upcoming month, updates 1st of that month
369 $pagestate{$params{destpage}}{calendar}{nextchange}=
370 timelocal(0, 0, 0, 1, $params{month}-1, $params{year});
372 elsif ($params{type} eq 'year' && $params{year} == $thisyear) {
373 # calendar for current year, updates 1st of next month
374 $pagestate{$params{destpage}}{calendar}{nextchange}=
375 timelocal(0, 0, 0, 1, $thismonth+1-1, $params{year});
377 elsif ($params{type} eq 'year' && $params{year} > $thisyear) {
378 # calendar for upcoming year, updates 1st of that year
379 $pagestate{$params{destpage}}{calendar}{nextchange}=
380 timelocal(0, 0, 0, 1, 1-1, $params{year});
383 # calendar for past month or year, does not need
385 delete $pagestate{$params{destpage}}{calendar};
388 # Calculate month names for next month, and previous months
390 if ($params{type} eq 'month') {
391 $calendar=format_month(%params);
393 elsif ($params{type} eq 'year') {
394 $calendar=format_year(%params);
397 return "\n<div><div class=\"calendar\">$calendar</div></div>\n";
401 my $needsbuild=shift;
402 foreach my $page (keys %pagestate) {
403 if (exists $pagestate{$page}{calendar}{nextchange}) {
404 if ($pagestate{$page}{calendar}{nextchange} <= $time) {
405 # force a rebuild so the calendar shows
407 push @$needsbuild, $pagesources{$page};
409 if (exists $pagesources{$page} &&
410 grep { $_ eq $pagesources{$page} } @$needsbuild) {
411 # remove state, will be re-added if
412 # the calendar is still there during the
414 delete $pagestate{$page}{calendar};