Comments (maybe not so helpful - sorry)

[git.ikiwiki.info.git] / IkiWiki / Plugin / calendar.pm

diff --git a/IkiWiki/Plugin/calendar.pm b/IkiWiki/Plugin/calendar.pm
index 536dbc075e1ce03473d41d96103d0266b384c170..5d16dff75ba7a98a68c3fc8c94d9d9378cb11732 100644 (file)
--- a/IkiWiki/Plugin/calendar.pm
+++ b/IkiWiki/Plugin/calendar.pm
@@ -20,33 +20,51 @@ package IkiWiki::Plugin::calendar;
 
 use warnings;
 use strict;
-use IkiWiki 2.00;
+use IkiWiki 3.00;
 use Time::Local;
 use POSIX;
 
 my %cache;
 my %linkcache;
-my @now=localtime();
+my $time=time;
+my @now=localtime($time);
 
-sub import { #{{{
+sub import {
+       hook(type => "getsetup", id => "calendar", call => \&getsetup);
+       hook(type => "needsbuild", id => "calendar", call => \&needsbuild);
        hook(type => "preprocess", id => "calendar", call => \&preprocess);
-} #}}}
+}
+
+sub getsetup () {
+       return
+               plugin => {
+                       safe => 1,
+                       rebuild => undef,
+               },
+               archivebase => {
+                       type => "string",
+                       example => "archives",
+                       description => "base of the archives hierarchy",
+                       safe => 1,
+                       rebuild => 1,
+               },
+}
 
-sub is_leap_year (@) { #{{
+sub is_leap_year (@) {
        my %params=@_;
        return ($params{year} % 4 == 0 && (($params{year} % 100 != 0) || $params{year} % 400 == 0));
-} #}}}
+}
 
-sub month_days { #{{{
+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 format_month (@) { #{{{
+sub format_month (@) {
        my %params=@_;
 
        my $pagespec = $params{pages};
@@ -193,8 +211,10 @@ EOF
        # matching the pagespec are added or removed.
        add_depends($params{page}, $params{pages});
        # Explicitly add all currently linked pages as dependencies, so
-        # that if they are removed, the calendar will be sure to be updated.
-        add_depends($params{page}, join(" or ", @list));
+       # that if they are removed, the calendar will be sure to be updated.
+       foreach my $p (@list) {
+               add_depends($params{page}, $p);
+       }
 
        return $calendar;
 }
@@ -306,12 +326,25 @@ sub preprocess (@) {
        my %params=@_;
        $params{pages} = "*"            unless defined $params{pages};
        $params{type}  = "month"        unless defined $params{type};
-       $params{year}  = 1900 + $now[5] unless defined $params{year};
        $params{month} = sprintf("%02d", $params{month}) if defined  $params{month};
-       $params{month} = 1    + $now[4] unless defined $params{month};
        $params{week_start_day} = 0     unless defined $params{week_start_day};
        $params{months_per_row} = 3     unless defined $params{months_per_row};
 
+       if (! defined $params{year} || ! defined $params{month}) {
+               # Record that the calendar next changes at midnight.
+               $pagestate{$params{destpage}}{calendar}{nextchange}=($time
+                       + (60 - $now[0])                # seconds
+                       + (59 - $now[1]) * 60           # minutes
+                       + (23 - $now[2]) * 60 * 60      # hours
+               );
+               
+               $params{year}  = 1900 + $now[5] unless defined $params{year};
+               $params{month} = 1    + $now[4] unless defined $params{month};
+       }
+       else {
+               delete $pagestate{$params{destpage}}{calendar};
+       }
+
        # Calculate month names for next month, and previous months
        my $pmonth = $params{month} - 1;
        my $nmonth = $params{month} + 1;
@@ -338,8 +371,7 @@ sub preprocess (@) {
        my $page =$params{page};
 
        if (! defined $cache{$pagespec}) {
-               foreach my $p (keys %pagesources) {
-                       next unless pagespec_match($p, $pagespec);
+               foreach my $p (pagespec_match_list([keys %pagesources], $pagespec)) {
                        my $mtime = $IkiWiki::pagectime{$p};
                        my $src   = $pagesources{$p};
                        my @date  = localtime($mtime);
@@ -363,7 +395,27 @@ sub preprocess (@) {
                $calendar=format_year(%params);
        }
 
-       return "\n<div class=\"calendar\">$calendar</div><!-- calendar -->\n";
+       return "\n<div><div class=\"calendar\">$calendar</div></div>\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};
+                       }
+               }
+       }
 }
 
 1