#!/usr/bin/perl # Copyright (c) 2006, 2007 Manoj Srivastava # # This program is free software; you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation; either version 2 of the License, or # (at your option) any later version. # # This program is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License # along with this program; if not, write to the Free Software # Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA. require 5.002; package IkiWiki::Plugin::calendar; use warnings; use strict; use IkiWiki 3.00; use Time::Local; my $time=time; my @now=localtime($time); my %changed; sub import { hook(type => "checkconfig", id => "calendar", call => \&checkconfig); hook(type => "getsetup", id => "calendar", call => \&getsetup); hook(type => "needsbuild", id => "calendar", call => \&needsbuild); hook(type => "preprocess", id => "calendar", call => \&preprocess); hook(type => "scan", id => "calendar", call => \&scan); hook(type => "build_affected", id => "calendar", call => \&build_affected); IkiWiki::loadplugin("transient"); } sub getsetup () { return plugin => { safe => 1, rebuild => undef, section => "widget", }, archivebase => { type => "string", example => "archives", description => "base of the archives hierarchy", safe => 1, rebuild => 1, }, archive_pagespec => { type => "pagespec", example => "page(posts/*) and !*/Discussion", description => "PageSpec of pages to include in the archives, if option `calendar_autocreate` is true.", link => 'ikiwiki/PageSpec', safe => 1, rebuild => 0, }, calendar_autocreate => { type => "boolean", example => 1, description => "autocreate new calendar pages?", safe => 1, rebuild => undef, }, calendar_fill_gaps => { type => "boolean", example => 1, default => 1, description => "if set, when building calendar pages, also build pages of year and month when no pages were published (building empty calendars).", safe => 1, rebuild => 0, }, } sub checkconfig () { if (! defined $config{calendar_autocreate}) { $config{calendar_autocreate} = defined $config{archivebase}; } if (! defined $config{archive_pagespec}) { $config{archive_pagespec} = '*'; } if (! defined $config{archivebase}) { $config{archivebase} = 'archives'; } if (! defined $config{calendar_fill_gaps}) { $config{calendar_fill_gaps} = 1; } } sub is_leap_year (@) { my %params=@_; return ($params{year} % 4 == 0 && (($params{year} % 100 != 0) || $params{year} % 400 == 0)); } sub month_days { my %params=@_; my $days_in_month = (31,28,31,30,31,30,31,31,30,31,30,31)[$params{month}-1]; if ($params{month} == 2 && is_leap_year(%params)) { $days_in_month++; } return $days_in_month; } sub build_affected { my %affected; my ($ayear, $amonth, $valid); foreach my $year (keys %changed) { ($ayear, $valid) = nextyear($year, $config{archivebase}); $affected{calendarlink($ayear)} = sprintf(gettext("building calendar for %s, its previous or next year has changed"), $ayear) if ($valid); ($ayear, $valid) = previousyear($year, $config{archivebase}); $affected{calendarlink($ayear)} = sprintf(gettext("building calendar for %s, its previous or next year has changed"), $ayear) if ($valid); foreach my $month (keys %{$changed{$year}}) { ($ayear, $amonth, $valid) = nextmonth($year, $month, $config{archivebase}); $affected{calendarlink($ayear, sprintf("%02d", $amonth))} = sprintf(gettext("building calendar for %s/%s, its previous or next month has changed"), $amonth, $ayear) if ($valid); ($ayear, $amonth, $valid) = previousmonth($year, $month, $config{archivebase}); $affected{calendarlink($ayear, sprintf("%02d", $amonth))} = sprintf(gettext("building calendar for %s/%s, its previous or next month has changed"), $amonth, $ayear) if ($valid); } } return %affected; } sub autocreate { my ($page, $pagefile, $year, $month) = @_; my $message=sprintf(gettext("creating calendar page %s"), $page); debug($message); my $template; if (defined $month) { $template=template("calendarmonth.tmpl"); } else { $template=template("calendaryear.tmpl"); } $template->param(year => $year); $template->param(month => $month) if defined $month; $template->param(pagespec => $config{archive_pagespec}); my $dir = $IkiWiki::Plugin::transient::transientdir; writefile($pagefile, $dir, $template->output); } sub calendarlink($;$) { my ($year, $month) = @_; if (defined $month) { return $config{archivebase} . "/" . $year . "/" . $month; } else { return $config{archivebase} . "/" . $year; } } sub gencalendarmonth{ my $year = shift; my $month = sprintf("%02d", shift); my $page = calendarlink($year, $month); my $pagefile = newpagefile($page, $config{default_pageext}); add_autofile( $pagefile, "calendar", sub {return autocreate($page, $pagefile, $year, $month);} ); } sub gencalendaryear { my $year = shift; my %params = @_; # Building year page my $page = calendarlink($year); my $pagefile = newpagefile($page, $config{default_pageext}); add_autofile( $pagefile, "calendar", sub {return autocreate($page, $pagefile, $year);} ); if (not exists $wikistate{calendar}{minyear}) { $wikistate{calendar}{minyear} = $year; } if (not exists $wikistate{calendar}{maxyear}) { $wikistate{calendar}{maxyear} = $year; } if ($config{calendar_fill_gaps}) { # Building month pages foreach my $month (1 .. 12) { gencalendarmonth($year, $month); } # Filling potential gaps in years (e.g. calendar goes from 2010 to 2014, # and we just added year 2005. We have to add years 2006 to 2009). return if $params{norecurse}; if ($wikistate{calendar}{minyear} > $year) { foreach my $other ($year + 1 .. $wikistate{calendar}{minyear} - 1) { gencalendaryear($other, norecurse => 1); } $wikistate{calendar}{minyear} = $year; } if ($wikistate{calendar}{maxyear} < $year) { foreach my $other ($wikistate{calendar}{maxyear} + 1 .. $year - 1) { gencalendaryear($other, norecurse => 1); } $wikistate{calendar}{maxyear} = $year; } } if ($year < $wikistate{calendar}{minyear}) { $wikistate{calendar}{minyear} = $year; } if ($year > $wikistate{calendar}{maxyear}) { $wikistate{calendar}{maxyear} = $year; } } sub previousmonth($$$) { my $year = shift; my $month = shift; my $archivebase = shift; if (not exists $wikistate{calendar}{minyear}) { $wikistate{calendar}{minyear} = $year; } my $pmonth = $month; my $pyear = $year; while ((not exists $pagesources{"$archivebase/$pyear/" . sprintf("%02d", $pmonth)}) or ($pmonth == $month and $pyear == $year)) { $pmonth -= 1; if ($pmonth == 0) { $pyear -= 1; $pmonth = 12; return ($pyear, $pmonth, 0) unless $pyear >= $wikistate{calendar}{minyear}; } } return ($pyear, $pmonth, 1); } sub nextmonth($$$) { my $year = shift; my $month = shift; my $archivebase = shift; if (not exists $wikistate{calendar}{maxyear}) { $wikistate{calendar}{maxyear} = $year; } my $nmonth = $month; my $nyear = $year; while ((not exists $pagesources{"$archivebase/$nyear/" . sprintf("%02d", $nmonth)}) or ($nmonth == $month and $nyear == $year)) { $nmonth += 1; if ($nmonth == 13) { $nyear += 1; $nmonth = 1; return ($nyear, $nmonth, 0) unless $nyear <= $wikistate{calendar}{maxyear}; } } return ($nyear, $nmonth, 1); } sub previousyear($$) { my $year = shift; my $archivebase = shift; my $pyear = $year - 1; while (not exists $pagesources{"$archivebase/$pyear"}) { $pyear -= 1; return ($pyear, 0) unless ($pyear >= $wikistate{calendar}{minyear}); } return ($pyear, 1); } sub nextyear($$) { my $year = shift; my $archivebase = shift; my $nyear = $year + 1; while (not exists $pagesources{"$archivebase/$nyear"}) { $nyear += 1; return ($nyear, 0) unless ($nyear <= $wikistate{calendar}{maxyear}); } return ($nyear, 1); } sub format_month (@) { my %params=@_; my %linkcache; foreach my $p (pagespec_match_list($params{page}, "creation_year($params{year}) and creation_month($params{month}) and ($params{pages})", # add presence dependencies to update # month calendar when pages are added/removed deptype => deptype("presence"))) { my $mtime = $IkiWiki::pagectime{$p}; my @date = localtime($mtime); my $mday = $date[3]; my $month = $date[4] + 1; my $year = $date[5] + 1900; my $mtag = sprintf("%02d", $month); if (! $linkcache{"$year/$mtag/$mday"}) { $linkcache{"$year/$mtag/$mday"} = []; } push(@{$linkcache{"$year/$mtag/$mday"}}, $p); } my $archivebase = 'archives'; $archivebase = $config{archivebase} if defined $config{archivebase}; $archivebase = $params{archivebase} if defined $params{archivebase}; my ($pyear, $pmonth, $pvalid) = previousmonth($params{year}, $params{month}, $archivebase); my ($nyear, $nmonth, $nvalid) = nextmonth($params{year}, $params{month}, $archivebase); # Add padding. $pmonth=sprintf("%02d", $pmonth); $nmonth=sprintf("%02d", $nmonth); my $calendar="\n"; # When did this month start? my @monthstart = localtime(timelocal(0,0,0,1,$params{month}-1,$params{year}-1900)); my $future_dom = 0; my $today = 0; if ($params{year} == $now[5]+1900 && $params{month} == $now[4]+1) { $future_dom = $now[3]+1; $today = $now[3]; } # Find out month names for this, next, and previous months my $monthabbrev=strftime_utf8("%b", @monthstart); my $monthname=strftime_utf8("%B", @monthstart); my $pmonthname=strftime_utf8("%B", localtime(timelocal(0,0,0,1,$pmonth-1,$pyear-1900))); my $nmonthname=strftime_utf8("%B", localtime(timelocal(0,0,0,1,$nmonth-1,$nyear-1900))); # Calculate URL's for monthly archives. my ($url, $purl, $nurl)=("$monthname $params{year}",'',''); if (exists $pagesources{"$archivebase/$params{year}/$params{month}"}) { $url = htmllink($params{page}, $params{destpage}, "$archivebase/$params{year}/".$params{month}, noimageinline => 1, linktext => "$monthabbrev $params{year}", title => $monthname); } add_depends($params{page}, "$archivebase/$params{year}/$params{month}", deptype("presence")); if (exists $pagesources{"$archivebase/$pyear/$pmonth"}) { $purl = htmllink($params{page}, $params{destpage}, "$archivebase/$pyear/$pmonth", noimageinline => 1, linktext => "\←", title => $pmonthname); } add_depends($params{page}, "$archivebase/$pyear/$pmonth", deptype("presence")); if (exists $pagesources{"$archivebase/$nyear/$nmonth"}) { $nurl = htmllink($params{page}, $params{destpage}, "$archivebase/$nyear/$nmonth", noimageinline => 1, linktext => "\→", title => $nmonthname); } add_depends($params{page}, "$archivebase/$nyear/$nmonth", deptype("presence")); # Start producing the month calendar $calendar=< $purl $url $nurl EOF # Suppose we want to start the week with day $week_start_day # If $monthstart[6] == 1 my $week_start_day = $params{week_start_day}; my $start_day = 1 + (7 - $monthstart[6] + $week_start_day) % 7; my %downame; my %dowabbr; for my $dow ($week_start_day..$week_start_day+6) { my @day=localtime(timelocal(0,0,0,$start_day++,$params{month}-1,$params{year}-1900)); my $downame = strftime_utf8("%A", @day); my $dowabbr = substr($downame, 0, 1); $downame{$dow % 7}=$downame; $dowabbr{$dow % 7}=$dowabbr; $calendar.= qq{\t\t$dowabbr\n}; } $calendar.=< EOF my $wday; # we start with a week_start_day, and skip until we get to the first for ($wday=$week_start_day; $wday != $monthstart[6]; $wday++, $wday %= 7) { $calendar.=qq{\t\n} if $wday == $week_start_day; $calendar.=qq{\t\t \n}; } # At this point, either the first is a week_start_day, in which case # nothing has been printed, or else we are in the middle of a row. for (my $day = 1; $day <= month_days(year => $params{year}, month => $params{month}); $day++, $wday++, $wday %= 7) { # At this point, on a week_start_day, we close out a row, # and start a new one -- unless it is week_start_day on the # first, where we do not close a row -- since none was started. if ($wday == $week_start_day) { $calendar.=qq{\t\n} unless $day == 1; $calendar.=qq{\t\n}; } my $tag; my $key="$params{year}/$params{month}/$day"; if (defined $linkcache{$key}) { if ($day == $today) { $tag='month-calendar-day-this-day'; } else { $tag='month-calendar-day-link'; } $calendar.=qq{\t\t}; $calendar.=qq{}; $calendar.=qq{\n}; } else { if ($day == $today) { $tag='month-calendar-day-this-day'; } elsif ($day == $future_dom) { $tag='month-calendar-day-future'; } else { $tag='month-calendar-day-nolink'; } $calendar.=qq{\t\t$day\n}; } } # finish off the week for (; $wday != $week_start_day; $wday++, $wday %= 7) { $calendar.=qq{\t\t \n}; } $calendar.=< EOF return $calendar; } sub format_year (@) { my %params=@_; my @post_months; foreach my $p (pagespec_match_list($params{page}, "creation_year($params{year}) and ($params{pages})", # add presence dependencies to update # year calendar's links to months when # pages are added/removed deptype => deptype("presence"))) { my $mtime = $IkiWiki::pagectime{$p}; my @date = localtime($mtime); my $month = $date[4] + 1; $post_months[$month]++; } my $calendar="\n"; my $archivebase = 'archives'; $archivebase = $config{archivebase} if defined $config{archivebase}; $archivebase = $params{archivebase} if defined $params{archivebase}; my ($pyear, $pvalid) = previousyear($params{year}, $archivebase); my ($nyear, $nvalid) = nextyear($params{year}, $archivebase); my $thisyear = $now[5]+1900; my $future_month = 0; $future_month = $now[4]+1 if $params{year} == $thisyear; # calculate URL's for previous and next years my ($url, $purl, $nurl)=("$params{year}",'',''); if (exists $pagesources{"$archivebase/$params{year}"}) { $url = htmllink($params{page}, $params{destpage}, "$archivebase/$params{year}", noimageinline => 1, linktext => $params{year}, title => $params{year}); } add_depends($params{page}, "$archivebase/$params{year}", deptype("presence")); if (exists $pagesources{"$archivebase/$pyear"}) { $purl = htmllink($params{page}, $params{destpage}, "$archivebase/$pyear", noimageinline => 1, linktext => "\←", title => $pyear); } add_depends($params{page}, "$archivebase/$pyear", deptype("presence")); if (exists $pagesources{"$archivebase/$nyear"}) { $nurl = htmllink($params{page}, $params{destpage}, "$archivebase/$nyear", noimageinline => 1, linktext => "\→", title => $nyear); } add_depends($params{page}, "$archivebase/$nyear", deptype("presence")); # Start producing the year calendar my $m=$params{months_per_row}-2; $calendar=< $purl $url $nurl Months EOF for (my $month = 1; $month <= 12; $month++) { my @day=localtime(timelocal(0,0,0,15,$month-1,$params{year}-1900)); my $murl; my $monthname = strftime_utf8("%B", @day); my $monthabbr = strftime_utf8("%b", @day); $calendar.=qq{\t\n} if ($month % $params{months_per_row} == 1); my $tag; my $mtag=sprintf("%02d", $month); if ($month == $params{month} && $thisyear == $params{year}) { $tag = 'year-calendar-this-month'; } elsif ($pagesources{"$archivebase/$params{year}/$mtag"}) { $tag = 'year-calendar-month-link'; } elsif ($future_month && $month >= $future_month) { $tag = 'year-calendar-month-future'; } else { $tag = 'year-calendar-month-nolink'; } if ($pagesources{"$archivebase/$params{year}/$mtag"} && $post_months[$mtag]) { $murl = htmllink($params{page}, $params{destpage}, "$archivebase/$params{year}/$mtag", noimageinline => 1, linktext => $monthabbr, title => $monthname); $calendar.=qq{\t}; $calendar.=$murl; $calendar.=qq{\t\n}; } else { $calendar.=qq{\t$monthabbr\n}; } add_depends($params{page}, "$archivebase/$params{year}/$mtag", deptype("presence")); $calendar.=qq{\t\n} if ($month % $params{months_per_row} == 0); } $calendar.=< EOF return $calendar; } sub setnextchange ($$) { my $page=shift; my $timestamp=shift; if (! exists $pagestate{$page}{calendar}{nextchange} || $pagestate{$page}{calendar}{nextchange} > $timestamp) { $pagestate{$page}{calendar}{nextchange}=$timestamp; } } sub preprocess (@) { my %params=@_; my $thisyear=1900 + $now[5]; my $thismonth=1 + $now[4]; $params{pages} = "*" unless defined $params{pages}; $params{type} = "month" unless defined $params{type}; $params{week_start_day} = 0 unless defined $params{week_start_day}; $params{months_per_row} = 3 unless defined $params{months_per_row}; $params{year} = $thisyear unless defined $params{year}; $params{month} = $thismonth unless defined $params{month}; my $relativeyear=0; if ($params{year} < 1) { $relativeyear=1; $params{year}=$thisyear+$params{year}; } my $relativemonth=0; if ($params{month} < 1) { $relativemonth=1; my $monthoff=$params{month}; $params{month}=($thismonth+$monthoff) % 12; $params{month}=12 if $params{month}==0; my $yearoff=POSIX::ceil(($thismonth-$params{month}) / -12) - int($monthoff / 12); $params{year}-=$yearoff; } $params{month} = sprintf("%02d", $params{month}); $changed{$params{year}}{$params{month}} = 1; if ($params{type} eq 'month' && $params{year} == $thisyear && $params{month} == $thismonth) { # calendar for current month, updates next midnight setnextchange($params{destpage}, ($time + (60 - $now[0]) # seconds + (59 - $now[1]) * 60 # minutes + (23 - $now[2]) * 60 * 60 # hours )); } elsif ($params{type} eq 'month' && (($params{year} == $thisyear && $params{month} > $thismonth) || $params{year} > $thisyear)) { # calendar for upcoming month, updates 1st of that month setnextchange($params{destpage}, timelocal(0, 0, 0, 1, $params{month}-1, $params{year})); } elsif (($params{type} eq 'year' && $params{year} == $thisyear) || $relativemonth) { # Calendar for current year updates 1st of next month. # Any calendar relative to the current month also updates # then. if ($thismonth < 12) { setnextchange($params{destpage}, timelocal(0, 0, 0, 1, $thismonth+1-1, $params{year})); } else { setnextchange($params{destpage}, timelocal(0, 0, 0, 1, 1-1, $params{year}+1)); } } elsif ($relativeyear) { # Any calendar relative to the current year updates 1st # of next year. setnextchange($params{destpage}, timelocal(0, 0, 0, 1, 1-1, $thisyear+1)); } elsif ($params{type} eq 'year' && $params{year} > $thisyear) { # calendar for upcoming year, updates 1st of that year setnextchange($params{destpage}, timelocal(0, 0, 0, 1, 1-1, $params{year})); } else { # calendar for past month or year, does not need # to update any more delete $pagestate{$params{destpage}}{calendar}; } my $calendar=""; if ($params{type} eq 'month') { $calendar=format_month(%params); } elsif ($params{type} eq 'year') { $calendar=format_year(%params); } return "\n
$calendar
\n"; } #}} sub needsbuild (@) { my $needsbuild=shift; foreach my $page (keys %pagestate) { if (exists $pagestate{$page}{calendar}{nextchange}) { if ($pagestate{$page}{calendar}{nextchange} <= $time) { # force a rebuild so the calendar shows # the current day push @$needsbuild, $pagesources{$page}; } if (exists $pagesources{$page} && grep { $_ eq $pagesources{$page} } @$needsbuild) { # remove state, will be re-added if # the calendar is still there during the # rebuild delete $pagestate{$page}{calendar}; } } } return $needsbuild; } sub scan (@) { my %params=@_; my $page=$params{page}; return unless $config{calendar_autocreate}; # Check if year pages have to be generated if (pagespec_match($page, $config{archive_pagespec})) { my @ctime = localtime($IkiWiki::pagectime{$page}); gencalendaryear($ctime[5]+1900); gencalendarmonth($ctime[5]+1900, $ctime[4]+1); } } 1