]> sipb.mit.edu Git - ikiwiki.git/blobdiff - IkiWiki/Plugin/calendar.pm
Merge branch 'dependency-types' into transitive-dependencies
[ikiwiki.git] / IkiWiki / Plugin / calendar.pm
index b808c9d1d64bbc5adf226335e14b31d7b5c67085..a5cc208821691d6574d77a985b09673b0fd7f70a 100644 (file)
@@ -20,7 +20,7 @@ package IkiWiki::Plugin::calendar;
 
 use warnings;
 use strict;
-use IkiWiki 2.00;
+use IkiWiki 3.00;
 use Time::Local;
 use POSIX;
 
@@ -29,38 +29,42 @@ my %linkcache;
 my $time=time;
 my @now=localtime($time);
 
-sub import { #{{{
-       hook(type => "getsetup", id => "version", call => \&getsetup);
-       hook(type => "needsbuild", id => "version", call => \&needsbuild);
+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 () { #{{{
+sub getsetup () {
        return
+               plugin => {
+                       safe => 1,
+                       rebuild => undef,
+               },
                archivebase => {
                        type => "string",
-                       default => "archives",
+                       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};
@@ -100,19 +104,22 @@ sub format_month (@) { #{{{
                        "$archivebase/$year/".sprintf("%02d", $month),
                        linktext => " $monthname ");
        }
-       add_depends($params{page}, "$archivebase/$year/".sprintf("%02d", $month));
+       add_depends($params{page}, "$archivebase/$year/".sprintf("%02d", $month),
+               content => 0);
        if (exists $cache{$pagespec}{"$pyear/$pmonth"}) {
                $purl = htmllink($params{page}, $params{destpage}, 
                        "$archivebase/$pyear/" . sprintf("%02d", $pmonth),
                        linktext => " $pmonthname ");
        }
-       add_depends($params{page}, "$archivebase/$pyear/".sprintf("%02d", $pmonth));
+       add_depends($params{page}, "$archivebase/$pyear/".sprintf("%02d", $pmonth),
+               content => 0);
        if (exists $cache{$pagespec}{"$nyear/$nmonth"}) {
                $nurl = htmllink($params{page}, $params{destpage}, 
                        "$archivebase/$nyear/" . sprintf("%02d", $nmonth),
                        linktext => " $nmonthname ");
        }
-       add_depends($params{page}, "$archivebase/$nyear/".sprintf("%02d", $nmonth));
+       add_depends($params{page}, "$archivebase/$nyear/".sprintf("%02d", $nmonth),
+               content => 0);
 
        # Start producing the month calendar
        $calendar=<<EOF;
@@ -205,15 +212,17 @@ EOF
 
        # Add dependencies to update the calendar whenever pages
        # matching the pagespec are added or removed.
-       add_depends($params{page}, $params{pages});
+       add_depends($params{page}, $params{pages}, content => 0);
        # 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, content => 0);
+       }
 
        return $calendar;
-} #}}}
+}
 
-sub format_year (@) { #{{{
+sub format_year (@) {
        my %params=@_;
 
        my $pagespec = $params{pages};
@@ -240,19 +249,19 @@ sub format_year (@) { #{{{
                        "$archivebase/$year",
                        linktext => "$year");
        }
-       add_depends($params{page}, "$archivebase/$year");
+       add_depends($params{page}, "$archivebase/$year", content => 0);
        if (exists $cache{$pagespec}{"$pyear"}) {
                $purl = htmllink($params{page}, $params{destpage}, 
                        "$archivebase/$pyear",
                        linktext => "\&larr;");
        }
-       add_depends($params{page}, "$archivebase/$pyear");
+       add_depends($params{page}, "$archivebase/$pyear", content => 0);
        if (exists $cache{$pagespec}{"$nyear"}) {
                $nurl = htmllink($params{page}, $params{destpage}, 
                        "$archivebase/$nyear",
                        linktext => "\&rarr;");
        }
-       add_depends($params{page}, "$archivebase/$nyear");
+       add_depends($params{page}, "$archivebase/$nyear", content => 0);
 
        # Start producing the year calendar
        $calendar=<<EOF;
@@ -304,7 +313,7 @@ EOF
                else {
                        $calendar.=qq{\t<td class="$tag">$monthabbr</td>\n};
                }
-               add_depends($params{page}, "$archivebase/$year/$mtag");
+               add_depends($params{page}, "$archivebase/$year/$mtag", content => 0);
 
                $calendar.=qq{\t</tr>\n} if ($month % $params{months_per_row} == 0);
        }
@@ -314,9 +323,9 @@ EOF
 EOF
 
        return $calendar;
-} #}}}
+}
 
-sub preprocess (@) { #{{{
+sub preprocess (@) {
        my %params=@_;
        $params{pages} = "*"            unless defined $params{pages};
        $params{type}  = "month"        unless defined $params{type};
@@ -365,8 +374,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);
@@ -393,7 +401,7 @@ sub preprocess (@) { #{{{
        return "\n<div><div class=\"calendar\">$calendar</div></div>\n";
 } #}}
 
-sub needsbuild (@) { #{{{
+sub needsbuild (@) {
        my $needsbuild=shift;
        foreach my $page (keys %pagestate) {
                if (exists $pagestate{$page}{calendar}{nextchange}) {
@@ -411,6 +419,6 @@ sub needsbuild (@) { #{{{
                        }
                }
        }
-} # }}}
+}
 
 1