]> sipb.mit.edu Git - ikiwiki.git/blobdiff - IkiWiki/Plugin/calendar.pm
Simplifying code
[ikiwiki.git] / IkiWiki / Plugin / calendar.pm
index 02f41070e10ae6acf29ce9abd3c52aead7aefbc4..03726281652a73f5bb86f18b0329f8663b74f48d 100644 (file)
@@ -13,7 +13,7 @@
 #
 # 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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA.
 
 require 5.002;
 package IkiWiki::Plugin::calendar;
@@ -22,15 +22,16 @@ use warnings;
 use strict;
 use IkiWiki 3.00;
 use Time::Local;
-use POSIX ();
 
 my $time=time;
 my @now=localtime($time);
 
 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);
 }
 
 sub getsetup () {
@@ -49,12 +50,42 @@ sub getsetup () {
                },
                archive_pagespec => {
                        type => "pagespec",
-                       example => "posts/* and !*/Discussion",
-                       description => "PageSpec of pages to include in the archives; used by ikiwiki-calendar command",
+                       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_autocreate_commit => {
+                       type => "boolean",
+                       example => 1,
+                       default => 1,
+                       description => "commit autocreated calendar pages",
+                       safe => 1,
+                       rebuild => 0,
+               },
+}
+
+sub checkconfig () {
+       if (! defined $config{calendar_autocreate}) {
+               $config{calendar_autocreate} = defined $config{archivebase} || defined $config{calendar_autocreate_commit};
+       }
+       if (! defined $config{calendar_autocreate_commit}) {
+               $config{calendar_autocreate_commit} = 1;
+       }
+       if (! defined $config{archive_pagespec}) {
+               $config{archive_pagespec} = '*';
+       }
+       if (! defined $config{archivebase}) {
+               $config{archivebase} = 'archives';
+       }
 }
 
 sub is_leap_year (@) {
@@ -71,6 +102,89 @@ sub month_days {
        return $days_in_month;
 }
 
+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 = $config{srcdir};
+       if (! $config{calendar_autocreate_commit}) {
+               $dir = $IkiWiki::Plugin::transient::transientdir;
+       }
+
+       writefile($pagefile, $dir, $template->output);
+       if ($config{rcs} && $config{calendar_autocreate_commit}) {
+               IkiWiki::disable_commit_hook();
+               IkiWiki::rcs_add($pagefile);
+               IkiWiki::rcs_commit_staged(message => $message);
+               IkiWiki::enable_commit_hook();
+       }
+}
+
+sub calendarlink($;$) {
+       my ($year, $month) = @_;
+       if (defined $month) {
+               return $config{archivebase} . "/" . $year . "/" . $month;
+       } else {
+               return $config{archivebase} . "/" . $year;
+       }
+}
+
+sub gencalendaryear {
+       my $year = shift;
+       my %params = @_;
+
+       return unless $config{calendar_autocreate};
+
+       # Building year page
+       my $page = calendarlink($year);
+       my $pagefile = newpagefile($page, $config{default_pageext});
+       add_autofile(
+               $pagefile, "calendar",
+               sub {return autocreate($page, $pagefile, $year);}
+       );
+
+       # Building month pages
+       foreach my $month (qw{01 02 03 04 05 06 07 08 09 10 11 12}) {
+               my $page = calendarlink($year, $month);
+               my $pagefile = newpagefile($page, $config{default_pageext});
+               add_autofile(
+                       $pagefile, "calendar",
+                       sub {return autocreate($page, $pagefile, $year, $month);}
+               );
+       }
+
+       # Filling potential gaps in years (e.g. calendar goes from 2010 to 2014,
+       # and we just added year 2005. We have to had years 2006 to 2009).
+       return if $params{norecurse};
+       if (not exists $wikistate{calendar}{minyear}) {
+               $wikistate{calendar}{minyear} = $year;
+       } elsif ($wikistate{calendar}{minyear} > $year) {
+               foreach my $other ($year + 1 .. $wikistate{calendar}{minyear} - 1) {
+                       gencalendaryear($other, norecurse => 1);
+               }
+               $wikistate{calendar}{minyear} = $year;
+       }
+       if (not exists $wikistate{calendar}{maxyear}) {
+               $wikistate{calendar}{maxyear} = $year;
+       } elsif ($wikistate{calendar}{maxyear} < $year) {
+               foreach my $other ($wikistate{calendar}{maxyear} + 1 .. $year - 1) {
+                       gencalendaryear($other, norecurse => 1);
+               }
+               $wikistate{calendar}{maxyear} = $year;
+       }
+}
+
 sub format_month (@) {
        my %params=@_;
 
@@ -87,8 +201,10 @@ sub format_month (@) {
                my $year  = $date[5] + 1900;
                my $mtag  = sprintf("%02d", $month);
 
-               # Only one posting per day is being linked to.
-               $linkcache{"$year/$mtag/$mday"} = $p;
+               if (! $linkcache{"$year/$mtag/$mday"}) {
+                       $linkcache{"$year/$mtag/$mday"} = [];
+               }
+               push(@{$linkcache{"$year/$mtag/$mday"}}, $p);
        }
                
        my $pmonth = $params{month} - 1;
@@ -123,21 +239,22 @@ sub format_month (@) {
        }
 
        # Find out month names for this, next, and previous months
-       my $monthname=POSIX::strftime("%B", @monthstart);
-       my $pmonthname=POSIX::strftime("%B", localtime(timelocal(0,0,0,1,$pmonth-1,$pyear-1900)));
-       my $nmonthname=POSIX::strftime("%B", localtime(timelocal(0,0,0,1,$nmonth-1,$nyear-1900)));
+       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)));
 
        my $archivebase = 'archives';
        $archivebase = $config{archivebase} if defined $config{archivebase};
        $archivebase = $params{archivebase} if defined $params{archivebase};
   
        # Calculate URL's for monthly archives.
-       my ($url, $purl, $nurl)=("$monthname",'','');
+       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 => $monthname,
+                       linktext => "$monthabbrev $params{year}",
                        title => $monthname);
        }
        add_depends($params{page}, "$archivebase/$params{year}/$params{month}",
@@ -181,8 +298,8 @@ EOF
        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 = POSIX::strftime("%A", @day);
-               my $dowabbr = POSIX::strftime("%a", @day);
+               my $downame = strftime_utf8("%A", @day);
+               my $dowabbr = substr($downame, 0, 1);
                $downame{$dow % 7}=$downame;
                $dowabbr{$dow % 7}=$dowabbr;
                $calendar.= qq{\t\t<th class="month-calendar-day-head $downame" title="$downame">$dowabbr</th>\n};
@@ -221,11 +338,27 @@ EOF
                                $tag='month-calendar-day-link';
                        }
                        $calendar.=qq{\t\t<td class="$tag $downame{$wday}">};
-                       $calendar.=htmllink($params{page}, $params{destpage}, 
-                               $linkcache{$key},
-                               noimageinline => 1,
-                               linktext => $day,
-                               title => pagetitle(IkiWiki::basename($linkcache{$key})));
+                       $calendar.=qq{<div class='popup'>$day<div class='balloon'>};
+                       # Several postings on this page
+                       $calendar.=qq{<ul>};
+                       foreach my $page (@{$linkcache{$key}}) {
+                               $calendar.= qq{\n\t\t\t<li>};
+                               my $title;
+                               if (exists $pagestate{$page}{meta}{title}) {
+                                       $title = "$pagestate{$page}{meta}{title}";
+                               }
+                               else {
+                                       $title = pagetitle(IkiWiki::basename($page));
+                               }
+                               $calendar.=htmllink($params{page}, $params{destpage}, 
+                                       $page,
+                                       noimageinline => 1,
+                                       linktext => $title,
+                                       title => $title);
+                               $calendar.= '</li>';
+                       }
+                       $calendar.=qq{\n\t\t</ul>};
+                       $calendar.=qq{</div></div>};
                        $calendar.=qq{</td>\n};
                }
                else {
@@ -256,7 +389,7 @@ EOF
 
 sub format_year (@) {
        my %params=@_;
-       
+
        my @post_months;
        foreach my $p (pagespec_match_list($params{page}, 
                                "creation_year($params{year}) and ($params{pages})",
@@ -328,8 +461,8 @@ 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 = POSIX::strftime("%B", @day);
-               my $monthabbr = POSIX::strftime("%b", @day);
+               my $monthname = strftime_utf8("%B", @day);
+               my $monthabbr = strftime_utf8("%b", @day);
                $calendar.=qq{\t<tr>\n}  if ($month % $params{months_per_row} == 1);
                my $tag;
                my $mtag=sprintf("%02d", $month);
@@ -373,6 +506,16 @@ 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=@_;
 
@@ -386,15 +529,20 @@ sub preprocess (@) {
        $params{year}  = $thisyear      unless defined $params{year};
        $params{month} = $thismonth     unless defined $params{month};
 
-       my $relativemonth=0;
-       if ($params{month} < 1) {
-               $params{month}=$thismonth+$params{month};
-               $relativemonth=1;
-       }
        my $relativeyear=0;
        if ($params{year} < 1) {
-               $params{year}=$thisyear+$params{year};
                $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});
@@ -402,18 +550,18 @@ sub preprocess (@) {
        if ($params{type} eq 'month' && $params{year} == $thisyear
            && $params{month} == $thismonth) {
                # calendar for current month, updates next midnight
-               $pagestate{$params{destpage}}{calendar}{nextchange}=($time
+               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
-               $pagestate{$params{destpage}}{calendar}{nextchange}=
-                       timelocal(0, 0, 0, 1, $params{month}-1, $params{year});
+               setnextchange($params{destpage},
+                       timelocal(0, 0, 0, 1, $params{month}-1, $params{year}));
        }
        elsif (($params{type} eq 'year' && $params{year} == $thisyear) ||
               $relativemonth) {
@@ -421,24 +569,24 @@ sub preprocess (@) {
                # Any calendar relative to the current month also updates
                # then.
                if ($thismonth < 12) {
-                       $pagestate{$params{destpage}}{calendar}{nextchange}=
-                               timelocal(0, 0, 0, 1, $thismonth+1-1, $params{year});
+                       setnextchange($params{destpage},
+                               timelocal(0, 0, 0, 1, $thismonth+1-1, $params{year}));
                }
                else {
-                       $pagestate{$params{destpage}}{calendar}{nextchange}=
-                               timelocal(0, 0, 0, 1, 1-1, $params{year}+1);
+                       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.
-               $pagestate{$params{destpage}}{calendar}{nextchange}=
-                       timelocal(0, 0, 0, 1, 1-1, $thisyear+1);
+               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
-               $pagestate{$params{destpage}}{calendar}{nextchange}=
-                       timelocal(0, 0, 0, 1, 1-1, $params{year});
+               setnextchange($params{destpage},
+                       timelocal(0, 0, 0, 1, 1-1, $params{year}));
        }
        else {
                # calendar for past month or year, does not need
@@ -475,6 +623,19 @@ sub needsbuild (@) {
                        }
                }
        }
+
+       return $needsbuild;
+}
+
+sub scan (@) {
+       my %params=@_;
+       my $page=$params{page};
+
+       # 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);
+       }
 }
 
 1