IkiWiki/Plugin/calendar.pm

   1 #! /usr/bin/perl
   2 # Copyright (c) 2006, 2007 Manoj Srivastava <srivasta@debian.org>
   3 #
   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.
   8 #
   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.
  13 #
  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., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA.
  17
  18 require 5.002;
  19 package IkiWiki::Plugin::calendar;
  20
  21 use warnings;
  22 use strict;
  23 use IkiWiki 3.00;
  24 use Time::Local;
  25
  26 my $time=time;
  27 my @now=localtime($time);
  28
  29 sub import {
  30         hook(type => "getsetup", id => "calendar", call => \&getsetup);
  31         hook(type => "needsbuild", id => "calendar", call => \&needsbuild);
  32         hook(type => "preprocess", id => "calendar", call => \&preprocess);
  33 }
  34
  35 sub getsetup () {
  36         return
  37                 plugin => {
  38                         safe => 1,
  39                         rebuild => undef,
  40                         section => "widget",
  41                 },
  42                 archivebase => {
  43                         type => "string",
  44                         example => "archives",
  45                         description => "base of the archives hierarchy",
  46                         safe => 1,
  47                         rebuild => 1,
  48                 },
  49                 archive_pagespec => {
  50                         type => "pagespec",
  51                         example => "page(posts/*) and !*/Discussion",
  52                         description => "PageSpec of pages to include in the archives; used by ikiwiki-calendar command",
  53                         link => 'ikiwiki/PageSpec',
  54                         safe => 1,
  55                         rebuild => 0,
  56                 },
  57 }
  58
  59 sub is_leap_year (@) {
  60         my %params=@_;
  61         return ($params{year} % 4 == 0 && (($params{year} % 100 != 0) || $params{year} % 400 == 0));
  62 }
  63
  64 sub month_days {
  65         my %params=@_;
  66         my $days_in_month = (31,28,31,30,31,30,31,31,30,31,30,31)[$params{month}-1];
  67         if ($params{month} == 2 && is_leap_year(%params)) {
  68                 $days_in_month++;
  69         }
  70         return $days_in_month;
  71 }
  72
  73 sub format_month (@) {
  74         my %params=@_;
  75
  76         my %linkcache;
  77         foreach my $p (pagespec_match_list($params{page},
  78                                 "creation_year($params{year}) and creation_month($params{month}) and ($params{pages})",
  79                                 # add presence dependencies to update
  80                                 # month calendar when pages are added/removed
  81                                 deptype => deptype("presence"))) {
  82                 my $mtime = $IkiWiki::pagectime{$p};
  83                 my @date  = localtime($mtime);
  84                 my $mday  = $date[3];
  85                 my $month = $date[4] + 1;
  86                 my $year  = $date[5] + 1900;
  87                 my $mtag  = sprintf("%02d", $month);
  88
  89                 if (! $linkcache{"$year/$mtag/$mday"}) {
  90                         $linkcache{"$year/$mtag/$mday"} = [];
  91                 }
  92                 push(@{$linkcache{"$year/$mtag/$mday"}}, $p);
  93         }
  94
  95         my $pmonth = $params{month} - 1;
  96         my $nmonth = $params{month} + 1;
  97         my $pyear  = $params{year};
  98         my $nyear  = $params{year};
  99
 100         # Adjust for January and December
 101         if ($params{month} == 1) {
 102                 $pmonth = 12;
 103                 $pyear--;
 104         }
 105         if ($params{month} == 12) {
 106                 $nmonth = 1;
 107                 $nyear++;
 108         }
 109
 110         # Add padding.
 111         $pmonth=sprintf("%02d", $pmonth);
 112         $nmonth=sprintf("%02d", $nmonth);
 113
 114         my $calendar="\n";
 115
 116         # When did this month start?
 117         my @monthstart = localtime(timelocal(0,0,0,1,$params{month}-1,$params{year}-1900));
 118
 119         my $future_dom = 0;
 120         my $today      = 0;
 121         if ($params{year} == $now[5]+1900 && $params{month} == $now[4]+1) {
 122                 $future_dom = $now[3]+1;
 123                 $today      = $now[3];
 124         }
 125
 126         # Find out month names for this, next, and previous months
 127         my $monthabbrev=strftime_utf8("%b", @monthstart);
 128         my $monthname=strftime_utf8("%B", @monthstart);
 129         my $pmonthname=strftime_utf8("%B", localtime(timelocal(0,0,0,1,$pmonth-1,$pyear-1900)));
 130         my $nmonthname=strftime_utf8("%B", localtime(timelocal(0,0,0,1,$nmonth-1,$nyear-1900)));
 131
 132         my $archivebase = 'archives';
 133         $archivebase = $config{archivebase} if defined $config{archivebase};
 134         $archivebase = $params{archivebase} if defined $params{archivebase};
 135
 136         # Calculate URL's for monthly archives.
 137         my ($url, $purl, $nurl)=("$monthname $params{year}",'','');
 138         if (exists $pagesources{"$archivebase/$params{year}/$params{month}"}) {
 139                 $url = htmllink($params{page}, $params{destpage},
 140                         "$archivebase/$params{year}/".$params{month},
 141                         noimageinline => 1,
 142                         linktext => "$monthabbrev $params{year}",
 143                         title => $monthname);
 144         }
 145         add_depends($params{page}, "$archivebase/$params{year}/$params{month}",
 146                 deptype("presence"));
 147         if (exists $pagesources{"$archivebase/$pyear/$pmonth"}) {
 148                 $purl = htmllink($params{page}, $params{destpage},
 149                         "$archivebase/$pyear/$pmonth",
 150                         noimageinline => 1,
 151                         linktext => "\&larr;",
 152                         title => $pmonthname);
 153         }
 154         add_depends($params{page}, "$archivebase/$pyear/$pmonth",
 155                 deptype("presence"));
 156         if (exists $pagesources{"$archivebase/$nyear/$nmonth"}) {
 157                 $nurl = htmllink($params{page}, $params{destpage},
 158                         "$archivebase/$nyear/$nmonth",
 159                         noimageinline => 1,
 160                         linktext => "\&rarr;",
 161                         title => $nmonthname);
 162         }
 163         add_depends($params{page}, "$archivebase/$nyear/$nmonth",
 164                 deptype("presence"));
 165
 166         # Start producing the month calendar
 167         $calendar=<<EOF;
 168 <table class="month-calendar">
 169         <tr>
 170         <th class="month-calendar-arrow">$purl</th>
 171         <th class="month-calendar-head" colspan="5">$url</th>
 172         <th class="month-calendar-arrow">$nurl</th>
 173         </tr>
 174         <tr>
 175 EOF
 176
 177         # Suppose we want to start the week with day $week_start_day
 178         # If $monthstart[6] == 1
 179         my $week_start_day = $params{week_start_day};
 180
 181         my $start_day = 1 + (7 - $monthstart[6] + $week_start_day) % 7;
 182         my %downame;
 183         my %dowabbr;
 184         for my $dow ($week_start_day..$week_start_day+6) {
 185                 my @day=localtime(timelocal(0,0,0,$start_day++,$params{month}-1,$params{year}-1900));
 186                 my $downame = strftime_utf8("%A", @day);
 187                 my $dowabbr = substr($downame, 0, 1);
 188                 $downame{$dow % 7}=$downame;
 189                 $dowabbr{$dow % 7}=$dowabbr;
 190                 $calendar.= qq{\t\t<th class="month-calendar-day-head $downame" title="$downame">$dowabbr</th>\n};
 191         }
 192
 193         $calendar.=<<EOF;
 194         </tr>
 195 EOF
 196
 197         my $wday;
 198         # we start with a week_start_day, and skip until we get to the first
 199         for ($wday=$week_start_day; $wday != $monthstart[6]; $wday++, $wday %= 7) {
 200                 $calendar.=qq{\t<tr>\n} if $wday == $week_start_day;
 201                 $calendar.=qq{\t\t<td class="month-calendar-day-noday $downame{$wday}">&nbsp;</td>\n};
 202         }
 203
 204         # At this point, either the first is a week_start_day, in which case
 205         # nothing has been printed, or else we are in the middle of a row.
 206         for (my $day = 1; $day <= month_days(year => $params{year}, month => $params{month});
 207              $day++, $wday++, $wday %= 7) {
 208                 # At this point, on a week_start_day, we close out a row,
 209                 # and start a new one -- unless it is week_start_day on the
 210                 # first, where we do not close a row -- since none was started.
 211                 if ($wday == $week_start_day) {
 212                         $calendar.=qq{\t</tr>\n} unless $day == 1;
 213                         $calendar.=qq{\t<tr>\n};
 214                 }
 215
 216                 my $tag;
 217                 my $key="$params{year}/$params{month}/$day";
 218                 if (defined $linkcache{$key}) {
 219                         if ($day == $today) {
 220                                 $tag='month-calendar-day-this-day';
 221                         }
 222                         else {
 223                                 $tag='month-calendar-day-link';
 224                         }
 225                         $calendar.=qq{\t\t<td class="$tag $downame{$wday}">};
 226                         if (scalar(@{$linkcache{$key}}) == 1) {
 227                                 # Only one posting on this page
 228                                 my $page = $linkcache{$key}[0];
 229                                 $calendar.=htmllink($params{page}, $params{destpage},
 230                                         $page,
 231                                         noimageinline => 1,
 232                                         linktext => $day,
 233                                         title => pagetitle(IkiWiki::basename($page)));
 234                         }
 235                         else {
 236                                 $calendar.=qq{<div class='popup'>$day<div class='balloon'>};
 237                                 # Several postings on this page
 238                                 $calendar.=qq{<ul>};
 239                                 foreach my $page (@{$linkcache{$key}}) {
 240                                         $calendar.= qq{\n\t\t\t<li>};
 241                                         my $title;
 242                                         if (exists $pagestate{$page}{meta}{title}) {
 243                                                 $title = "$pagestate{$page}{meta}{title}";
 244                                         }
 245                                         else {
 246                                                 $title = pagetitle(IkiWiki::basename($page));
 247                                         }
 248                                         $calendar.=htmllink($params{page}, $params{destpage},
 249                                                 $page,
 250                                                 noimageinline => 1,
 251                                                 linktext => $title,
 252                                                 title => $title);
 253                                         $calendar.= '</li>';
 254                                 }
 255                                 $calendar.=qq{\n\t\t</ul>};
 256                                 $calendar.=qq{</div></div>};
 257                         }
 258                         $calendar.=qq{</td>\n};
 259                 }
 260                 else {
 261                         if ($day == $today) {
 262                                 $tag='month-calendar-day-this-day';
 263                         }
 264                         elsif ($day == $future_dom) {
 265                                 $tag='month-calendar-day-future';
 266                         }
 267                         else {
 268                                 $tag='month-calendar-day-nolink';
 269                         }
 270                         $calendar.=qq{\t\t<td class="$tag $downame{$wday}">$day</td>\n};
 271                 }
 272         }
 273
 274         # finish off the week
 275         for (; $wday != $week_start_day; $wday++, $wday %= 7) {
 276                 $calendar.=qq{\t\t<td class="month-calendar-day-noday $downame{$wday}">&nbsp;</td>\n};
 277         }
 278         $calendar.=<<EOF;
 279         </tr>
 280 </table>
 281 EOF
 282
 283         return $calendar;
 284 }
 285
 286 sub format_year (@) {
 287         my %params=@_;
 288
 289         my @post_months;
 290         foreach my $p (pagespec_match_list($params{page},
 291                                 "creation_year($params{year}) and ($params{pages})",
 292                                 # add presence dependencies to update
 293                                 # year calendar's links to months when
 294                                 # pages are added/removed
 295                                 deptype => deptype("presence"))) {
 296                 my $mtime = $IkiWiki::pagectime{$p};
 297                 my @date  = localtime($mtime);
 298                 my $month = $date[4] + 1;
 299
 300                 $post_months[$month]++;
 301         }
 302
 303         my $calendar="\n";
 304
 305         my $pyear = $params{year}  - 1;
 306         my $nyear = $params{year}  + 1;
 307
 308         my $thisyear = $now[5]+1900;
 309         my $future_month = 0;
 310         $future_month = $now[4]+1 if $params{year} == $thisyear;
 311
 312         my $archivebase = 'archives';
 313         $archivebase = $config{archivebase} if defined $config{archivebase};
 314         $archivebase = $params{archivebase} if defined $params{archivebase};
 315
 316         # calculate URL's for previous and next years
 317         my ($url, $purl, $nurl)=("$params{year}",'','');
 318         if (exists $pagesources{"$archivebase/$params{year}"}) {
 319                 $url = htmllink($params{page}, $params{destpage},
 320                         "$archivebase/$params{year}",
 321                         noimageinline => 1,
 322                         linktext => $params{year},
 323                         title => $params{year});
 324         }
 325         add_depends($params{page}, "$archivebase/$params{year}", deptype("presence"));
 326         if (exists $pagesources{"$archivebase/$pyear"}) {
 327                 $purl = htmllink($params{page}, $params{destpage},
 328                         "$archivebase/$pyear",
 329                         noimageinline => 1,
 330                         linktext => "\&larr;",
 331                         title => $pyear);
 332         }
 333         add_depends($params{page}, "$archivebase/$pyear", deptype("presence"));
 334         if (exists $pagesources{"$archivebase/$nyear"}) {
 335                 $nurl = htmllink($params{page}, $params{destpage},
 336                         "$archivebase/$nyear",
 337                         noimageinline => 1,
 338                         linktext => "\&rarr;",
 339                         title => $nyear);
 340         }
 341         add_depends($params{page}, "$archivebase/$nyear", deptype("presence"));
 342
 343         # Start producing the year calendar
 344         my $m=$params{months_per_row}-2;
 345         $calendar=<<EOF;
 346 <table class="year-calendar">
 347         <tr>
 348         <th class="year-calendar-arrow">$purl</th>
 349         <th class="year-calendar-head" colspan="$m">$url</th>
 350         <th class="year-calendar-arrow">$nurl</th>
 351         </tr>
 352         <tr>
 353                 <th class="year-calendar-subhead" colspan="$params{months_per_row}">Months</th>
 354         </tr>
 355 EOF
 356
 357         for (my $month = 1; $month <= 12; $month++) {
 358                 my @day=localtime(timelocal(0,0,0,15,$month-1,$params{year}-1900));
 359                 my $murl;
 360                 my $monthname = strftime_utf8("%B", @day);
 361                 my $monthabbr = strftime_utf8("%b", @day);
 362                 $calendar.=qq{\t<tr>\n}  if ($month % $params{months_per_row} == 1);
 363                 my $tag;
 364                 my $mtag=sprintf("%02d", $month);
 365                 if ($month == $params{month} && $thisyear == $params{year}) {
 366                         $tag = 'year-calendar-this-month';
 367                 }
 368                 elsif ($pagesources{"$archivebase/$params{year}/$mtag"}) {
 369                         $tag = 'year-calendar-month-link';
 370                 }
 371                 elsif ($future_month && $month >= $future_month) {
 372                         $tag = 'year-calendar-month-future';
 373                 }
 374                 else {
 375                         $tag = 'year-calendar-month-nolink';
 376                 }
 377
 378                 if ($pagesources{"$archivebase/$params{year}/$mtag"} &&
 379                     $post_months[$mtag]) {
 380                         $murl = htmllink($params{page}, $params{destpage},
 381                                 "$archivebase/$params{year}/$mtag",
 382                                 noimageinline => 1,
 383                                 linktext => $monthabbr,
 384                                 title => $monthname);
 385                         $calendar.=qq{\t<td class="$tag">};
 386                         $calendar.=$murl;
 387                         $calendar.=qq{\t</td>\n};
 388                 }
 389                 else {
 390                         $calendar.=qq{\t<td class="$tag">$monthabbr</td>\n};
 391                 }
 392                 add_depends($params{page}, "$archivebase/$params{year}/$mtag",
 393                         deptype("presence"));
 394
 395                 $calendar.=qq{\t</tr>\n} if ($month % $params{months_per_row} == 0);
 396         }
 397
 398         $calendar.=<<EOF;
 399 </table>
 400 EOF
 401
 402         return $calendar;
 403 }
 404
 405 sub setnextchange ($$) {
 406         my $page=shift;
 407         my $timestamp=shift;
 408
 409         if (! exists $pagestate{$page}{calendar}{nextchange} ||
 410             $pagestate{$page}{calendar}{nextchange} > $timestamp) {
 411                 $pagestate{$page}{calendar}{nextchange}=$timestamp;
 412         }
 413 }
 414
 415 sub preprocess (@) {
 416         my %params=@_;
 417
 418         my $thisyear=1900 + $now[5];
 419         my $thismonth=1 + $now[4];
 420
 421         $params{pages} = "*"            unless defined $params{pages};
 422         $params{type}  = "month"        unless defined $params{type};
 423         $params{week_start_day} = 0     unless defined $params{week_start_day};
 424         $params{months_per_row} = 3     unless defined $params{months_per_row};
 425         $params{year}  = $thisyear      unless defined $params{year};
 426         $params{month} = $thismonth     unless defined $params{month};
 427
 428         my $relativeyear=0;
 429         if ($params{year} < 1) {
 430                 $relativeyear=1;
 431                 $params{year}=$thisyear+$params{year};
 432         }
 433         my $relativemonth=0;
 434         if ($params{month} < 1) {
 435                 $relativemonth=1;
 436                 my $monthoff=$params{month};
 437                 $params{month}=($thismonth+$monthoff) % 12;
 438                 $params{month}=12 if $params{month}==0;
 439                 my $yearoff=POSIX::ceil(($thismonth-$params{month}) / -12)
 440                         - int($monthoff / 12);
 441                 $params{year}-=$yearoff;
 442         }
 443
 444         $params{month} = sprintf("%02d", $params{month});
 445
 446         if ($params{type} eq 'month' && $params{year} == $thisyear
 447             && $params{month} == $thismonth) {
 448                 # calendar for current month, updates next midnight
 449                 setnextchange($params{destpage}, ($time
 450                         + (60 - $now[0])                # seconds
 451                         + (59 - $now[1]) * 60           # minutes
 452                         + (23 - $now[2]) * 60 * 60      # hours
 453                 ));
 454         }
 455         elsif ($params{type} eq 'month' &&
 456                (($params{year} == $thisyear && $params{month} > $thismonth) ||
 457                 $params{year} > $thisyear)) {
 458                 # calendar for upcoming month, updates 1st of that month
 459                 setnextchange($params{destpage},
 460                         timelocal(0, 0, 0, 1, $params{month}-1, $params{year}));
 461         }
 462         elsif (($params{type} eq 'year' && $params{year} == $thisyear) ||
 463                $relativemonth) {
 464                 # Calendar for current year updates 1st of next month.
 465                 # Any calendar relative to the current month also updates
 466                 # then.
 467                 if ($thismonth < 12) {
 468                         setnextchange($params{destpage},
 469                                 timelocal(0, 0, 0, 1, $thismonth+1-1, $params{year}));
 470                 }
 471                 else {
 472                         setnextchange($params{destpage},
 473                                 timelocal(0, 0, 0, 1, 1-1, $params{year}+1));
 474                 }
 475         }
 476         elsif ($relativeyear) {
 477                 # Any calendar relative to the current year updates 1st
 478                 # of next year.
 479                 setnextchange($params{destpage},
 480                         timelocal(0, 0, 0, 1, 1-1, $thisyear+1));
 481         }
 482         elsif ($params{type} eq 'year' && $params{year} > $thisyear) {
 483                 # calendar for upcoming year, updates 1st of that year
 484                 setnextchange($params{destpage},
 485                         timelocal(0, 0, 0, 1, 1-1, $params{year}));
 486         }
 487         else {
 488                 # calendar for past month or year, does not need
 489                 # to update any more
 490                 delete $pagestate{$params{destpage}}{calendar};
 491         }
 492
 493         my $calendar="";
 494         if ($params{type} eq 'month') {
 495                 $calendar=format_month(%params);
 496         }
 497         elsif ($params{type} eq 'year') {
 498                 $calendar=format_year(%params);
 499         }
 500
 501         return "\n<div><div class=\"calendar\">$calendar</div></div>\n";
 502 } #}}
 503
 504 sub needsbuild (@) {
 505         my $needsbuild=shift;
 506         foreach my $page (keys %pagestate) {
 507                 if (exists $pagestate{$page}{calendar}{nextchange}) {
 508                         if ($pagestate{$page}{calendar}{nextchange} <= $time) {
 509                                 # force a rebuild so the calendar shows
 510                                 # the current day
 511                                 push @$needsbuild, $pagesources{$page};
 512                         }
 513                         if (exists $pagesources{$page} &&
 514                             grep { $_ eq $pagesources{$page} } @$needsbuild) {
 515                                 # remove state, will be re-added if
 516                                 # the calendar is still there during the
 517                                 # rebuild
 518                                 delete $pagestate{$page}{calendar};
 519                         }
 520                 }
 521         }
 522         return $needsbuild;
 523 }
 524
 525 1