slight clarification

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

diff --git a/IkiWiki/Plugin/calendar.pm b/IkiWiki/Plugin/calendar.pm
index c50d038df4f80314bf4a3f3070aa65fa474e264d..0f0e9518adf27b0ca3f912622d89b71ea13f5aa6 100644 (file)
--- a/IkiWiki/Plugin/calendar.pm
+++ b/IkiWiki/Plugin/calendar.pm
@@ -22,7 +22,7 @@ use warnings;
 use strict;
 use IkiWiki 3.00;
 use Time::Local;
 use strict;
 use IkiWiki 3.00;
 use Time::Local;

-use POSIX;
+use POSIX ();

 
 my $time=time;
 my @now=localtime($time);
 
 my $time=time;
 my @now=localtime($time);


@@ -38,6 +38,7 @@ sub getsetup () {
                plugin => {
                        safe => 1,
                        rebuild => undef,
                plugin => {
                        safe => 1,
                        rebuild => undef,

+                       section => "widget",

                },
                archivebase => {
                        type => "string",
                },
                archivebase => {
                        type => "string",


@@ -46,6 +47,14 @@ sub getsetup () {
                        safe => 1,
                        rebuild => 1,
                },
                        safe => 1,
                        rebuild => 1,
                },

+               archive_pagespec => {
+                       type => "pagespec",
+                       example => "posts/* and !*/Discussion",
+                       description => "PageSpec of pages to include in the archives; used by ikiwiki-calendar command",
+                       link => 'ikiwiki/PageSpec',
+                       safe => 1,
+                       rebuild => 0,
+               },

 }
 
 sub is_leap_year (@) {
 }
 
 sub is_leap_year (@) {


@@ -65,21 +74,13 @@ sub month_days {
 sub format_month (@) {
        my %params=@_;
 
 sub format_month (@) {
        my %params=@_;
 

-       my $pagespec = $params{pages};
-       my $year     = $params{year};
-       my $month    = $params{month};
-       my $pmonth   = $params{pmonth};
-       my $nmonth   = $params{nmonth};
-       my $pyear    = $params{pyear};
-       my $nyear    = $params{nyear};
-

        my %linkcache;
        my %linkcache;

-       foreach my $p (pagespec_match_list($params{page}, $params{pagespec},
+       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};
                                # add presence dependencies to update
                                # month calendar when pages are added/removed
                                deptype => deptype("presence"))) {
                my $mtime = $IkiWiki::pagectime{$p};

-               my $src   = $pagesources{$p};

                my @date  = localtime($mtime);
                my $mday  = $date[3];
                my $month = $date[4] + 1;
                my @date  = localtime($mtime);
                my $mday  = $date[3];
                my $month = $date[4] + 1;


@@ -87,18 +88,36 @@ sub format_month (@) {
                my $mtag  = sprintf("%02d", $month);
 
                # Only one posting per day is being linked to.
                my $mtag  = sprintf("%02d", $month);
 
                # Only one posting per day is being linked to.

-               $linkcache{"$year/$mtag/$mday"} = "$src";
+               $linkcache{"$year/$mtag/$mday"} = $p;

        }
        }

+               
+       my $pmonth = $params{month} - 1;
+       my $nmonth = $params{month} + 1;
+       my $pyear  = $params{year};
+       my $nyear  = $params{year};
+
+       # Adjust for January and December
+       if ($params{month} == 1) {
+               $pmonth = 12;
+               $pyear--;
+       }
+       if ($params{month} == 12) {
+               $nmonth = 1;
+               $nyear++;
+       }
+
+       # Add padding.
+       $pmonth=sprintf("%02d", $pmonth);
+       $nmonth=sprintf("%02d", $nmonth);

 
 

-       my @list;

        my $calendar="\n";
 
        # When did this month start?
        my $calendar="\n";
 
        # When did this month start?

-       my @monthstart = localtime(timelocal(0,0,0,1,$month-1,$year-1900));
+       my @monthstart = localtime(timelocal(0,0,0,1,$params{month}-1,$params{year}-1900));

 
        my $future_dom = 0;
        my $today      = 0;
 
        my $future_dom = 0;
        my $today      = 0;

-       if ($year == $now[5]+1900 && $month == $now[4]+1) {
+       if ($params{year} == $now[5]+1900 && $params{month} == $now[4]+1) {

                $future_dom = $now[3]+1;
                $today      = $now[3];
        }
                $future_dom = $now[3]+1;
                $today      = $now[3];
        }


@@ -114,26 +133,32 @@ sub format_month (@) {
   
        # Calculate URL's for monthly archives.
        my ($url, $purl, $nurl)=("$monthname",'','');
   
        # Calculate URL's for monthly archives.
        my ($url, $purl, $nurl)=("$monthname",'','');

-       if (exists $pagesources{"$archivebase/$year/$month"}) {
+       if (exists $pagesources{"$archivebase/$params{year}/$params{month}"}) {

                $url = htmllink($params{page}, $params{destpage}, 
                $url = htmllink($params{page}, $params{destpage}, 

-                       "$archivebase/$year/".sprintf("%02d", $month),
-                       linktext => " $monthname ");
+                       "$archivebase/$params{year}/".$params{month},
+                       noimageinline => 1,
+                       linktext => $monthname,
+                       title => $monthname);

        }
        }

-       add_depends($params{page}, "$archivebase/$year/".sprintf("%02d", $month),
+       add_depends($params{page}, "$archivebase/$params{year}/$params{month}",

                deptype("presence"));
        if (exists $pagesources{"$archivebase/$pyear/$pmonth"}) {
                $purl = htmllink($params{page}, $params{destpage}, 
                deptype("presence"));
        if (exists $pagesources{"$archivebase/$pyear/$pmonth"}) {
                $purl = htmllink($params{page}, $params{destpage}, 

-                       "$archivebase/$pyear/" . sprintf("%02d", $pmonth),
-                       linktext => " $pmonthname ");
+                       "$archivebase/$pyear/$pmonth",
+                       noimageinline => 1,
+                       linktext => "\←",
+                       title => $pmonthname);

        }
        }

-       add_depends($params{page}, "$archivebase/$pyear/".sprintf("%02d", $pmonth),
+       add_depends($params{page}, "$archivebase/$pyear/$pmonth",

                deptype("presence"));
        if (exists $pagesources{"$archivebase/$nyear/$nmonth"}) {
                $nurl = htmllink($params{page}, $params{destpage}, 
                deptype("presence"));
        if (exists $pagesources{"$archivebase/$nyear/$nmonth"}) {
                $nurl = htmllink($params{page}, $params{destpage}, 

-                       "$archivebase/$nyear/" . sprintf("%02d", $nmonth),
-                       linktext => " $nmonthname ");
+                       "$archivebase/$nyear/$nmonth",
+                       noimageinline => 1,
+                       linktext => "\→",
+                       title => $nmonthname);

        }
        }

-       add_depends($params{page}, "$archivebase/$nyear/".sprintf("%02d", $nmonth),
+       add_depends($params{page}, "$archivebase/$nyear/$nmonth",

                deptype("presence"));
 
        # Start producing the month calendar
                deptype("presence"));
 
        # Start producing the month calendar


@@ -155,12 +180,12 @@ EOF
        my %downame;
        my %dowabbr;
        for my $dow ($week_start_day..$week_start_day+6) {
        my %downame;
        my %dowabbr;
        for my $dow ($week_start_day..$week_start_day+6) {

-               my @day=localtime(timelocal(0,0,0,$start_day++,$month-1,$year-1900));
+               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);
                $downame{$dow % 7}=$downame;
                $dowabbr{$dow % 7}=$dowabbr;
                my $downame = POSIX::strftime("%A", @day);
                my $dowabbr = POSIX::strftime("%a", @day);
                $downame{$dow % 7}=$downame;
                $dowabbr{$dow % 7}=$dowabbr;

-               $calendar.= qq{\t\t<th class="month-calendar-day-head $downame">$dowabbr</th>\n};
+               $calendar.= qq{\t\t<th class="month-calendar-day-head $downame" title="$downame">$dowabbr</th>\n};

        }
 
        $calendar.=<<EOF;
        }
 
        $calendar.=<<EOF;


@@ -176,9 +201,9 @@ EOF
 
        # 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.
 
        # 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 => $year, month => $month);
+       for (my $day = 1; $day <= month_days(year => $params{year}, month => $params{month});

             $day++, $wday++, $wday %= 7) {
             $day++, $wday++, $wday %= 7) {

-               # At tihs point, on a week_start_day, we close out a row,
+               # 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) {
                # 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) {


@@ -187,8 +212,8 @@ EOF
                }
                
                my $tag;
                }
                
                my $tag;

-               my $mtag = sprintf("%02d", $month);
-               if (defined $pagesources{"$archivebase/$year/$mtag/$day"}) {
+               my $key="$params{year}/$params{month}/$day";
+               if (defined $linkcache{$key}) {

                        if ($day == $today) {
                                $tag='month-calendar-day-this-day';
                        }
                        if ($day == $today) {
                                $tag='month-calendar-day-this-day';
                        }


@@ -197,9 +222,10 @@ EOF
                        }
                        $calendar.=qq{\t\t<td class="$tag $downame{$wday}">};
                        $calendar.=htmllink($params{page}, $params{destpage}, 
                        }
                        $calendar.=qq{\t\t<td class="$tag $downame{$wday}">};
                        $calendar.=htmllink($params{page}, $params{destpage}, 

-                                           pagename($linkcache{"$year/$mtag/$day"}),
-                                           "linktext" => "$day");
-                       push @list, pagename($linkcache{"$year/$mtag/$day"});
+                               $linkcache{$key},
+                               noimageinline => 1,
+                               linktext => $day,
+                               title => pagetitle(IkiWiki::basename($linkcache{$key})));

                        $calendar.=qq{</td>\n};
                }
                else {
                        $calendar.=qq{</td>\n};
                }
                else {


@@ -230,42 +256,58 @@ EOF
 
 sub format_year (@) {
        my %params=@_;
 
 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;

 
 

-       my $pagespec = $params{pages};
-       my $year     = $params{year};
-       my $month    = $params{month};
-       my $pmonth   = $params{pmonth};
-       my $nmonth   = $params{nmonth};
-       my $pyear    = $params{pyear};
-       my $nyear    = $params{nyear};
-
+               $post_months[$month]++;
+       }
+               

        my $calendar="\n";
        my $calendar="\n";

+       
+       my $pyear = $params{year}  - 1;
+       my $nyear = $params{year}  + 1;

 
 

+       my $thisyear = $now[5]+1900;

        my $future_month = 0;
        my $future_month = 0;

-       $future_month = $now[4]+1 if ($year == $now[5]+1900);
+       $future_month = $now[4]+1 if $params{year} == $thisyear;

 
        my $archivebase = 'archives';
        $archivebase = $config{archivebase} if defined $config{archivebase};
        $archivebase = $params{archivebase} if defined $params{archivebase};
 
        # calculate URL's for previous and next years
 
        my $archivebase = 'archives';
        $archivebase = $config{archivebase} if defined $config{archivebase};
        $archivebase = $params{archivebase} if defined $params{archivebase};
 
        # calculate URL's for previous and next years

-       my ($url, $purl, $nurl)=("$year",'','');
-       if (exists $pagesources{"$archivebase/$year"}) {
+       my ($url, $purl, $nurl)=("$params{year}",'','');
+       if (exists $pagesources{"$archivebase/$params{year}"}) {

                $url = htmllink($params{page}, $params{destpage}, 
                $url = htmllink($params{page}, $params{destpage}, 

-                       "$archivebase/$year",
-                       linktext => "$year");
+                       "$archivebase/$params{year}",
+                       noimageinline => 1,
+                       linktext => $params{year},
+                       title => $params{year});

        }
        }

-       add_depends($params{page}, "$archivebase/$year", deptype("presence"));
+       add_depends($params{page}, "$archivebase/$params{year}", deptype("presence"));

        if (exists $pagesources{"$archivebase/$pyear"}) {
                $purl = htmllink($params{page}, $params{destpage}, 
                        "$archivebase/$pyear",
        if (exists $pagesources{"$archivebase/$pyear"}) {
                $purl = htmllink($params{page}, $params{destpage}, 
                        "$archivebase/$pyear",

-                       linktext => "\&larr;");
+                       noimageinline => 1,
+                       linktext => "\&larr;",
+                       title => $pyear);

        }
        add_depends($params{page}, "$archivebase/$pyear", deptype("presence"));
        if (exists $pagesources{"$archivebase/$nyear"}) {
                $nurl = htmllink($params{page}, $params{destpage}, 
                        "$archivebase/$nyear",
        }
        add_depends($params{page}, "$archivebase/$pyear", deptype("presence"));
        if (exists $pagesources{"$archivebase/$nyear"}) {
                $nurl = htmllink($params{page}, $params{destpage}, 
                        "$archivebase/$nyear",

-                       linktext => "\&rarr;");
+                       noimageinline => 1,
+                       linktext => "\&rarr;",
+                       title => $nyear);

        }
        add_depends($params{page}, "$archivebase/$nyear", deptype("presence"));
 
        }
        add_depends($params{page}, "$archivebase/$nyear", deptype("presence"));
 


@@ -282,36 +324,34 @@ sub format_year (@) {
        </tr>
 EOF
 
        </tr>
 EOF
 

-       for ($month = 1; $month <= 12; $month++) {
-               my @day=localtime(timelocal(0,0,0,15,$month-1,$year-1900));
+       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);
                $calendar.=qq{\t<tr>\n}  if ($month % $params{months_per_row} == 1);
                my $tag;
                my $mtag=sprintf("%02d", $month);
                my $murl;
                my $monthname = POSIX::strftime("%B", @day);
                my $monthabbr = POSIX::strftime("%b", @day);
                $calendar.=qq{\t<tr>\n}  if ($month % $params{months_per_row} == 1);
                my $tag;
                my $mtag=sprintf("%02d", $month);

-               if ($month == $params{month}) {
-                       if ($pagesources{"$archivebase/$year/$mtag"}) {
-                               $tag = 'this_month_link';
-                       }
-                       else {
-                               $tag = 'this_month_nolink';
-                       }
+               if ($month == $params{month} && $thisyear == $params{year}) {
+                       $tag = 'year-calendar-this-month';

                }
                }

-               elsif ($pagesources{"$archivebase/$year/$mtag"}) {
-                       $tag = 'month_link';
+               elsif ($pagesources{"$archivebase/$params{year}/$mtag"}) {
+                       $tag = 'year-calendar-month-link';

                } 
                elsif ($future_month && $month >= $future_month) {
                } 
                elsif ($future_month && $month >= $future_month) {

-                       $tag = 'month_future';
+                       $tag = 'year-calendar-month-future';

                } 
                else {
                } 
                else {

-                       $tag = 'month_nolink';
+                       $tag = 'year-calendar-month-nolink';

                }
 
                }
 

-               if ($pagesources{"$archivebase/$year/$mtag"}) {
+               if ($pagesources{"$archivebase/$params{year}/$mtag"} &&
+                   $post_months[$mtag]) {

                        $murl = htmllink($params{page}, $params{destpage}, 
                        $murl = htmllink($params{page}, $params{destpage}, 

-                               "$archivebase/$year/$mtag",
-                               linktext => "$monthabbr");
+                               "$archivebase/$params{year}/$mtag",
+                               noimageinline => 1,
+                               linktext => $monthabbr,
+                               title => $monthname);

                        $calendar.=qq{\t<td class="$tag">};
                        $calendar.=$murl;
                        $calendar.=qq{\t</td>\n};
                        $calendar.=qq{\t<td class="$tag">};
                        $calendar.=$murl;
                        $calendar.=qq{\t</td>\n};


@@ -319,7 +359,7 @@ EOF
                else {
                        $calendar.=qq{\t<td class="$tag">$monthabbr</td>\n};
                }
                else {
                        $calendar.=qq{\t<td class="$tag">$monthabbr</td>\n};
                }

-               add_depends($params{page}, "$archivebase/$year/$mtag",
+               add_depends($params{page}, "$archivebase/$params{year}/$mtag",

                        deptype("presence"));
 
                $calendar.=qq{\t</tr>\n} if ($month % $params{months_per_row} == 0);
                        deptype("presence"));
 
                $calendar.=qq{\t</tr>\n} if ($month % $params{months_per_row} == 0);


@@ -334,54 +374,63 @@ EOF
 
 sub preprocess (@) {
        my %params=@_;
 
 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{pages} = "*"            unless defined $params{pages};
        $params{type}  = "month"        unless defined $params{type};

-       $params{month} = sprintf("%02d", $params{month}) if 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};
        $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.
+       $params{year}  = $thisyear      unless defined $params{year};
+       $params{month} = $thismonth     unless defined $params{month};
+
+       $params{month} = sprintf("%02d", $params{month});
+                       
+       if ($params{type} eq 'month' && $params{year} == $thisyear
+           && $params{month} == $thismonth) {
+               # calendar for current month, updates next midnight

                $pagestate{$params{destpage}}{calendar}{nextchange}=($time
                        + (60 - $now[0])                # seconds
                        + (59 - $now[1]) * 60           # minutes
                        + (23 - $now[2]) * 60 * 60      # hours
                );
                $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};
+       }
+       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});
+       }
+       elsif ($params{type} eq 'year' && $params{year} == $thisyear) {
+               # calendar for current year, updates 1st of next month
+               if ($thismonth < 12) {
+                       $pagestate{$params{destpage}}{calendar}{nextchange}=
+                               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);
+               }
+       }
+       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});

        }
        else {
        }
        else {

+               # calendar for past month or year, does not need
+               # to update any more

                delete $pagestate{$params{destpage}}{calendar};
        }
 
        # Calculate month names for next month, and previous months
                delete $pagestate{$params{destpage}}{calendar};
        }
 
        # Calculate month names for next month, and previous months

-       my $pmonth = $params{month} - 1;
-       my $nmonth = $params{month} + 1;
-       my $pyear  = $params{year}  - 1;
-       my $nyear  = $params{year}  + 1;
-
-       # Adjust for January and December
-       if ($params{month} == 1) {
-               $pmonth = 12;
-               $pyear--;
-       }
-       if ($params{month} == 12) {
-               $nmonth = 1;
-               $nyear++;
-       }
-
-       $params{pmonth}=$pmonth;
-       $params{nmonth}=$nmonth;
-       $params{pyear} =$pyear;
-       $params{nyear} =$nyear;
-
-       my $calendar="\n";
-
-       if ($params{type} =~ /month/i) {
+       my $calendar="";
+       if ($params{type} eq 'month') {

                $calendar=format_month(%params);
        }
                $calendar=format_month(%params);
        }

-       elsif ($params{type} =~ /year/i) {
+       elsif ($params{type} eq 'year') {

                $calendar=format_year(%params);
        }
 
                $calendar=format_year(%params);
        }