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}, $params{pages},
70 # add presence dependencies to update
71 # month calendar when pages are added/removed
72 deptype => deptype("presence"))) {
73 my $mtime = $IkiWiki::pagectime{$p};
74 my @date = localtime($mtime);
76 my $month = $date[4] + 1;
77 my $year = $date[5] + 1900;
78 my $mtag = sprintf("%02d", $month);
80 # Only one posting per day is being linked to.
81 $linkcache{"$year/$mtag/$mday"} = $p;
84 my $pmonth = $params{month} - 1;
85 my $nmonth = $params{month} + 1;
86 my $pyear = $params{year};
87 my $nyear = $params{year};
89 # Adjust for January and December
90 if ($params{month} == 1) {
94 if ($params{month} == 12) {
101 # When did this month start?
102 my @monthstart = localtime(timelocal(0,0,0,1,$params{month}-1,$params{year}-1900));
106 if ($params{year} == $now[5]+1900 && $params{month} == $now[4]+1) {
107 $future_dom = $now[3]+1;
111 # Find out month names for this, next, and previous months
112 my $monthname=POSIX::strftime("%B", @monthstart);
113 my $pmonthname=POSIX::strftime("%B", localtime(timelocal(0,0,0,1,$pmonth-1,$pyear-1900)));
114 my $nmonthname=POSIX::strftime("%B", localtime(timelocal(0,0,0,1,$nmonth-1,$nyear-1900)));
116 my $archivebase = 'archives';
117 $archivebase = $config{archivebase} if defined $config{archivebase};
118 $archivebase = $params{archivebase} if defined $params{archivebase};
120 # Calculate URL's for monthly archives.
121 my ($url, $purl, $nurl)=("$monthname",'','');
122 if (exists $pagesources{"$archivebase/$params{year}/$params{month}"}) {
123 $url = htmllink($params{page}, $params{destpage},
124 "$archivebase/$params{year}/".sprintf("%02d", $params{month}),
125 linktext => " $monthname ");
127 add_depends($params{page}, "$archivebase/$params{year}/".sprintf("%02d", $params{month}),
128 deptype("presence"));
129 if (exists $pagesources{"$archivebase/$pyear/$pmonth"}) {
130 $purl = htmllink($params{page}, $params{destpage},
131 "$archivebase/$pyear/" . sprintf("%02d", $pmonth),
132 linktext => " $pmonthname ");
134 add_depends($params{page}, "$archivebase/$pyear/".sprintf("%02d", $pmonth),
135 deptype("presence"));
136 if (exists $pagesources{"$archivebase/$nyear/$nmonth"}) {
137 $nurl = htmllink($params{page}, $params{destpage},
138 "$archivebase/$nyear/" . sprintf("%02d", $nmonth),
139 linktext => " $nmonthname ");
141 add_depends($params{page}, "$archivebase/$nyear/".sprintf("%02d", $nmonth),
142 deptype("presence"));
144 # Start producing the month calendar
146 <table class="month-calendar">
147 <caption class="month-calendar-head">
155 # Suppose we want to start the week with day $week_start_day
156 # If $monthstart[6] == 1
157 my $week_start_day = $params{week_start_day};
159 my $start_day = 1 + (7 - $monthstart[6] + $week_start_day) % 7;
162 for my $dow ($week_start_day..$week_start_day+6) {
163 my @day=localtime(timelocal(0,0,0,$start_day++,$params{month}-1,$params{year}-1900));
164 my $downame = POSIX::strftime("%A", @day);
165 my $dowabbr = POSIX::strftime("%a", @day);
166 $downame{$dow % 7}=$downame;
167 $dowabbr{$dow % 7}=$dowabbr;
168 $calendar.= qq{\t\t<th class="month-calendar-day-head $downame">$dowabbr</th>\n};
176 # we start with a week_start_day, and skip until we get to the first
177 for ($wday=$week_start_day; $wday != $monthstart[6]; $wday++, $wday %= 7) {
178 $calendar.=qq{\t<tr>\n} if $wday == $week_start_day;
179 $calendar.=qq{\t\t<td class="month-calendar-day-noday $downame{$wday}"> </td>\n};
182 # At this point, either the first is a week_start_day, in which case
183 # nothing has been printed, or else we are in the middle of a row.
184 for (my $day = 1; $day <= month_days(year => $params{year}, month => $params{month});
185 $day++, $wday++, $wday %= 7) {
186 # At tihs point, on a week_start_day, we close out a row,
187 # and start a new one -- unless it is week_start_day on the
188 # first, where we do not close a row -- since none was started.
189 if ($wday == $week_start_day) {
190 $calendar.=qq{\t</tr>\n} unless $day == 1;
191 $calendar.=qq{\t<tr>\n};
195 my $mtag = sprintf("%02d", $params{month});
196 if (defined $linkcache{"$params{year}/$mtag/$day"}) {
197 if ($day == $today) {
198 $tag='month-calendar-day-this-day';
201 $tag='month-calendar-day-link';
203 $calendar.=qq{\t\t<td class="$tag $downame{$wday}">};
204 $calendar.=htmllink($params{page}, $params{destpage},
205 $linkcache{"$params{year}/$mtag/$day"},
206 "linktext" => "$day");
207 $calendar.=qq{</td>\n};
210 if ($day == $today) {
211 $tag='month-calendar-day-this-day';
213 elsif ($day == $future_dom) {
214 $tag='month-calendar-day-future';
217 $tag='month-calendar-day-nolink';
219 $calendar.=qq{\t\t<td class="$tag $downame{$wday}">$day</td>\n};
223 # finish off the week
224 for (; $wday != $week_start_day; $wday++, $wday %= 7) {
225 $calendar.=qq{\t\t<td class="month-calendar-day-noday $downame{$wday}"> </td>\n};
235 sub format_year (@) {
240 my $pyear = $params{year} - 1;
241 my $nyear = $params{year} + 1;
243 my $future_month = 0;
244 $future_month = $now[4]+1 if ($params{year} == $now[5]+1900);
246 my $archivebase = 'archives';
247 $archivebase = $config{archivebase} if defined $config{archivebase};
248 $archivebase = $params{archivebase} if defined $params{archivebase};
250 # calculate URL's for previous and next years
251 my ($url, $purl, $nurl)=("$params{year}",'','');
252 if (exists $pagesources{"$archivebase/$params{year}"}) {
253 $url = htmllink($params{page}, $params{destpage},
254 "$archivebase/$params{year}",
255 linktext => "$params{year}");
257 add_depends($params{page}, "$archivebase/$params{year}", deptype("presence"));
258 if (exists $pagesources{"$archivebase/$pyear"}) {
259 $purl = htmllink($params{page}, $params{destpage},
260 "$archivebase/$pyear",
261 linktext => "\←");
263 add_depends($params{page}, "$archivebase/$pyear", deptype("presence"));
264 if (exists $pagesources{"$archivebase/$nyear"}) {
265 $nurl = htmllink($params{page}, $params{destpage},
266 "$archivebase/$nyear",
267 linktext => "\→");
269 add_depends($params{page}, "$archivebase/$nyear", deptype("presence"));
271 # Start producing the year calendar
273 <table class="year-calendar">
274 <caption class="year-calendar-head">
280 <th class="year-calendar-subhead" colspan="$params{months_per_row}">Months</th>
284 for (my $month = 1; $month <= 12; $month++) {
285 my @day=localtime(timelocal(0,0,0,15,$month-1,$params{year}-1900));
287 my $monthname = POSIX::strftime("%B", @day);
288 my $monthabbr = POSIX::strftime("%b", @day);
289 $calendar.=qq{\t<tr>\n} if ($month % $params{months_per_row} == 1);
291 my $mtag=sprintf("%02d", $month);
292 if ($month == $params{month}) {
293 if ($pagesources{"$archivebase/$params{year}/$mtag"}) {
294 $tag = 'this_month_link';
297 $tag = 'this_month_nolink';
300 elsif ($pagesources{"$archivebase/$params{year}/$mtag"}) {
303 elsif ($future_month && $month >= $future_month) {
304 $tag = 'month_future';
307 $tag = 'month_nolink';
310 if ($pagesources{"$archivebase/$params{year}/$mtag"}) {
311 $murl = htmllink($params{page}, $params{destpage},
312 "$archivebase/$params{year}/$mtag",
313 linktext => "$monthabbr");
314 $calendar.=qq{\t<td class="$tag">};
316 $calendar.=qq{\t</td>\n};
319 $calendar.=qq{\t<td class="$tag">$monthabbr</td>\n};
321 add_depends($params{page}, "$archivebase/$params{year}/$mtag",
322 deptype("presence"));
324 $calendar.=qq{\t</tr>\n} if ($month % $params{months_per_row} == 0);
337 my $thisyear=1900 + $now[5];
338 my $thismonth=1 + $now[4];
340 $params{pages} = "*" unless defined $params{pages};
341 $params{type} = "month" unless defined $params{type};
342 $params{week_start_day} = 0 unless defined $params{week_start_day};
343 $params{months_per_row} = 3 unless defined $params{months_per_row};
344 $params{year} = $thisyear unless defined $params{year};
345 $params{month} = $thismonth unless defined $params{month};
347 $params{month} = sprintf("%02d", $params{month});
349 if ($params{type} eq 'month' && $params{year} == $thisyear
350 && $params{month} == $thismonth) {
351 # calendar for current month, updates next midnight
352 $pagestate{$params{destpage}}{calendar}{nextchange}=($time
353 + (60 - $now[0]) # seconds
354 + (59 - $now[1]) * 60 # minutes
355 + (23 - $now[2]) * 60 * 60 # hours
358 elsif ($params{type} eq 'month' &&
359 (($params{year} == $thisyear && $params{month} > $thismonth) ||
360 $params{year} > $thisyear)) {
361 # calendar for upcoming month, updates 1st of that month
362 $pagestate{$params{destpage}}{calendar}{nextchange}=
363 timelocal(0, 0, 0, 1, $params{month}-1, $params{year});
365 elsif ($params{type} eq 'year' && $params{year} == $thisyear) {
366 # calendar for current year, updates 1st of next month
367 $pagestate{$params{destpage}}{calendar}{nextchange}=
368 timelocal(0, 0, 0, 1, $thismonth+1-1, $params{year});
370 elsif ($params{type} eq 'year' && $params{year} > $thisyear) {
371 # calendar for upcoming year, updates 1st of that year
372 $pagestate{$params{destpage}}{calendar}{nextchange}=
373 timelocal(0, 0, 0, 1, 1-1, $params{year});
376 # calendar for past month or year, does not need
378 delete $pagestate{$params{destpage}}{calendar};
381 # Calculate month names for next month, and previous months
383 if ($params{type} eq 'month') {
384 $calendar=format_month(%params);
386 elsif ($params{type} eq 'year') {
387 $calendar=format_year(%params);
390 return "\n<div><div class=\"calendar\">$calendar</div></div>\n";
394 my $needsbuild=shift;
395 foreach my $page (keys %pagestate) {
396 if (exists $pagestate{$page}{calendar}{nextchange}) {
397 if ($pagestate{$page}{calendar}{nextchange} <= $time) {
398 # force a rebuild so the calendar shows
400 push @$needsbuild, $pagesources{$page};
402 if (exists $pagesources{$page} &&
403 grep { $_ eq $pagesources{$page} } @$needsbuild) {
404 # remove state, will be re-added if
405 # the calendar is still there during the
407 delete $pagestate{$page}{calendar};