update info on my split-view setup, and ask for plugin advice

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

diff --git a/IkiWiki/Plugin/calendar.pm b/IkiWiki/Plugin/calendar.pm
index e3c5e2f2d4170a199bd25712b204a89eab224989..d443198f69618f28e37821766731b50bc2599306 100644 (file)
--- a/IkiWiki/Plugin/calendar.pm
+++ b/IkiWiki/Plugin/calendar.pm
@@ -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
 #
 # 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;
 
 require 5.002;
 package IkiWiki::Plugin::calendar;


@@ -22,7 +22,6 @@ use warnings;
 use strict;
 use IkiWiki 3.00;
 use Time::Local;
 use strict;
 use IkiWiki 3.00;
 use Time::Local;

-use POSIX;

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


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

+                       section => "widget",

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


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

+               archive_pagespec => {
+                       type => "pagespec",
+                       example => "page(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 (@) {


@@ -66,7 +74,8 @@ sub format_month (@) {
        my %params=@_;
 
        my %linkcache;
        my %params=@_;
 
        my %linkcache;

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


@@ -113,21 +122,23 @@ sub format_month (@) {
        }
 
        # Find out month names for this, next, and previous months
        }
 
        # 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 $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,
        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}",
                deptype("presence"));
        }
        add_depends($params{page}, "$archivebase/$params{year}/$params{month}",
                deptype("presence"));


@@ -135,7 +146,8 @@ sub format_month (@) {
                $purl = htmllink($params{page}, $params{destpage}, 
                        "$archivebase/$pyear/$pmonth",
                        noimageinline => 1,
                $purl = htmllink($params{page}, $params{destpage}, 
                        "$archivebase/$pyear/$pmonth",
                        noimageinline => 1,

-                       linktext => " \&larr ");
+                       linktext => "\←",
+                       title => $pmonthname);

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


@@ -143,7 +155,8 @@ sub format_month (@) {
                $nurl = htmllink($params{page}, $params{destpage}, 
                        "$archivebase/$nyear/$nmonth",
                        noimageinline => 1,
                $nurl = htmllink($params{page}, $params{destpage}, 
                        "$archivebase/$nyear/$nmonth",
                        noimageinline => 1,

-                       linktext => " \&rarr ");
+                       linktext => "\→",
+                       title => $nmonthname);

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


@@ -151,11 +164,11 @@ sub format_month (@) {
        # Start producing the month calendar
        $calendar=<<EOF;
 <table class="month-calendar">
        # Start producing the month calendar
        $calendar=<<EOF;
 <table class="month-calendar">

-       <caption class="month-calendar-head">
-       $purl
-       $url
-       $nurl
-       </caption>
+       <tr>
+       <th class="month-calendar-arrow">$purl</th>
+       <th class="month-calendar-head" colspan="5">$url</th>
+       <th class="month-calendar-arrow">$nurl</th>
+       </tr>

        <tr>
 EOF
 
        <tr>
 EOF
 


@@ -168,11 +181,11 @@ 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 %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;
                $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;


@@ -190,7 +203,7 @@ EOF
        # 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) {
        # 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 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) {


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

-               if (defined $linkcache{"$params{year}/$params{month}/$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';
                        }


@@ -208,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}, 

-                               $linkcache{"$params{year}/$params{month}/$day"},
+                               $linkcache{$key},

                                noimageinline => 1,
                                noimageinline => 1,

-                               "linktext" => "$day");
+                               linktext => $day,
+                               title => pagetitle(IkiWiki::basename($linkcache{$key})));

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


@@ -241,14 +256,29 @@ 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;
+
+               $post_months[$month]++;
+       }

                
        my $calendar="\n";
        
        my $pyear = $params{year}  - 1;
        my $nyear = $params{year}  + 1;
 
                
        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 ($params{year} == $now[5]+1900);
+       $future_month = $now[4]+1 if $params{year} == $thisyear;

 
        my $archivebase = 'archives';
        $archivebase = $config{archivebase} if defined $config{archivebase};
 
        my $archivebase = 'archives';
        $archivebase = $config{archivebase} if defined $config{archivebase};


@@ -260,32 +290,36 @@ sub format_year (@) {
                $url = htmllink($params{page}, $params{destpage}, 
                        "$archivebase/$params{year}",
                        noimageinline => 1,
                $url = htmllink($params{page}, $params{destpage}, 
                        "$archivebase/$params{year}",
                        noimageinline => 1,

-                       linktext => "$params{year}");
+                       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,
        }
        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 => "\&larr;");
+                       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",
                        noimageinline => 1,
        }
        add_depends($params{page}, "$archivebase/$pyear", deptype("presence"));
        if (exists $pagesources{"$archivebase/$nyear"}) {
                $nurl = htmllink($params{page}, $params{destpage}, 
                        "$archivebase/$nyear",
                        noimageinline => 1,

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

        }
        add_depends($params{page}, "$archivebase/$nyear", deptype("presence"));
 
        # Start producing the year calendar
        }
        add_depends($params{page}, "$archivebase/$nyear", deptype("presence"));
 
        # Start producing the year calendar

+       my $m=$params{months_per_row}-2;

        $calendar=<<EOF;
 <table class="year-calendar">
        $calendar=<<EOF;
 <table class="year-calendar">

-       <caption class="year-calendar-head">
-       $purl
-       $url
-       $nurl
-       </caption>
+       <tr>
+       <th class="year-calendar-arrow">$purl</th>
+       <th class="year-calendar-head" colspan="$m">$url</th>
+       <th class="year-calendar-arrow">$nurl</th>
+       </tr>

        <tr>
                <th class="year-calendar-subhead" colspan="$params{months_per_row}">Months</th>
        </tr>
        <tr>
                <th class="year-calendar-subhead" colspan="$params{months_per_row}">Months</th>
        </tr>


@@ -294,34 +328,31 @@ EOF
        for (my $month = 1; $month <= 12; $month++) {
                my @day=localtime(timelocal(0,0,0,15,$month-1,$params{year}-1900));
                my $murl;
        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);
                $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/$params{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/$params{year}/$mtag"}) {
                }
                elsif ($pagesources{"$archivebase/$params{year}/$mtag"}) {

-                       $tag = 'month_link';
+                       $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/$params{year}/$mtag"}) {
+               if ($pagesources{"$archivebase/$params{year}/$mtag"} &&
+                   $post_months[$mtag]) {

                        $murl = htmllink($params{page}, $params{destpage}, 
                                "$archivebase/$params{year}/$mtag",
                                noimageinline => 1,
                        $murl = htmllink($params{page}, $params{destpage}, 
                                "$archivebase/$params{year}/$mtag",
                                noimageinline => 1,

-                               linktext => "$monthabbr");
+                               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};


@@ -342,6 +373,16 @@ EOF
        return $calendar;
 }
 
        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=@_;
 
 sub preprocess (@) {
        my %params=@_;
 


@@ -355,33 +396,64 @@ sub preprocess (@) {
        $params{year}  = $thisyear      unless defined $params{year};
        $params{month} = $thismonth     unless defined $params{month};
 
        $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});
        $params{month} = sprintf("%02d", $params{month});

-                       
+       

        if ($params{type} eq 'month' && $params{year} == $thisyear
            && $params{month} == $thismonth) {
                # calendar for current month, updates next midnight
        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
                        + (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
        }
        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) {
+               # 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 ($params{type} eq 'year' && $params{year} == $thisyear) {
-               # calendar for current year, updates 1st of next month
-               $pagestate{$params{destpage}}{calendar}{nextchange}=
-                       timelocal(0, 0, 0, 1, $thismonth+1-1, $params{year});
+       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
        }
        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
        }
        else {
                # calendar for past month or year, does not need


@@ -389,7 +461,6 @@ sub preprocess (@) {
                delete $pagestate{$params{destpage}}{calendar};
        }
 
                delete $pagestate{$params{destpage}}{calendar};
        }
 

-       # Calculate month names for next month, and previous months

        my $calendar="";
        if ($params{type} eq 'month') {
                $calendar=format_month(%params);
        my $calendar="";
        if ($params{type} eq 'month') {
                $calendar=format_month(%params);


@@ -419,6 +490,7 @@ sub needsbuild (@) {
                        }
                }
        }
                        }
                }
        }

+       return $needsbuild;

 }
 
 1
 }
 
 1