lib/plugin/Calendar.php

   1 <?php
   2
   3 /**
   4  * Copyright 1999,2000,2001,2002,2007 $ThePhpWikiProgrammingTeam
   5  *
   6  * This file is part of PhpWiki.
   7  *
   8  * PhpWiki is free software; you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License as published by
  10  * the Free Software Foundation; either version 2 of the License, or
  11  * (at your option) any later version.
  12  *
  13  * PhpWiki is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16  * GNU General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License along
  19  * with PhpWiki; if not, write to the Free Software Foundation, Inc.,
  20  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  21  */
  22
  23 if (!defined('SECONDS_PER_DAY'))
  24     define('SECONDS_PER_DAY', 24 * 3600);
  25
  26 // FIXME: Still needs:
  27 //
  28 //   o Better way to navigate to distant months.
  29 //     (Maybe a form with selectors for month and year)?
  30 //
  31 // It would be nice to have some way to get from the individual date
  32 // pages back to the calendar page. (Subpage support might make this
  33 // easier.)
  34
  35 class WikiPlugin_Calendar
  36 extends WikiPlugin
  37 {
  38     function getName () {
  39         return _("Calendar");
  40     }
  41
  42     function getDescription () {
  43         return _("Calendar");
  44     }
  45
  46     function getDefaultArguments() {
  47         return array('prefix'           => '[pagename]' . SUBPAGE_SEPARATOR,
  48                      'date_format'      => '%Y-%m-%d',
  49                      'year'             => '',
  50                      'month'            => '',
  51                      'month_offset'     => 0,
  52                      'month_format'     => '%B %Y',
  53                      'wday_format'      => '%a',
  54                      'start_wday'       => '1', // start now with Monday
  55                      'display_weeknum'  => 0);
  56     }
  57
  58     /**
  59      * return links (static only as of action=edit)
  60      *
  61      * @param  string $argstr   The plugin argument string.
  62      * @param  string $basepage The pagename the plugin is invoked from.
  63      * @return array  List of pagenames linked to (or false).
  64      */
  65     function getWikiPageLinks ($argstr, $basepage) {
  66         if (isset($this->_links))
  67             return $this->_links;
  68         else {
  69             global $request;
  70             $this->run($request->_dbi, $argstr, $request, $basepage);
  71             return $this->_links;
  72         }
  73     }
  74
  75     function __header($pagename, $time) {
  76         $args = &$this->args;
  77
  78         $t = localtime($time - SECONDS_PER_DAY, 1);
  79         $prev_url = WikiURL($pagename, array('month' => $t['tm_mon'] + 1,
  80                                              'year'  => $t['tm_year'] + 1900));
  81
  82         $t = localtime($time + 32 * SECONDS_PER_DAY, 1);
  83         $next_url = WikiURL($pagename, array('month' => $t['tm_mon'] + 1,
  84                                              'year'  => $t['tm_year'] + 1900));
  85
  86         $prev = HTML::a(array('href'  => $prev_url,
  87                               'class' => 'cal-arrow',
  88                               'title' => _("Previous Month")),
  89                         '<');
  90         $next = HTML::a(array('href'  => $next_url,
  91                               'class' => 'cal-arrow',
  92                               'title' => _("Next Month")),
  93                         '>');
  94
  95
  96         $row = HTML::tr(HTML::td(array('align' => 'left'), $prev),
  97                         HTML::td(array('align' => 'center'),
  98                                  HTML::strong(array('class' => 'cal-header'),
  99                                               strftime($args['month_format'],
 100                                                        $time))),
 101                         HTML::td(array('align' => 'right'), $next));
 102
 103         return HTML::tr(HTML::td(array('colspan' => $args['display_weeknum'] ? 8 : 7,
 104                                        'align'   => 'center'),
 105                                  HTML::table(array('width' => '100%',
 106                                                    'class' => 'cal-header'),
 107     }
 108
 109     function __daynames($start_wday) {
 110         $time  = mktime(12, 0, 0, 1, 1, 2001);
 111         $t     = localtime($time, 1);
 112         $time += (7 + $start_wday - $t['tm_wday']) * SECONDS_PER_DAY;
 113
 114         $t = localtime($time, 1);
 115         assert($t['tm_wday'] == $start_wday);
 116
 117         $fs = $this->args['wday_format'];
 118         $row = HTML::tr();
 119         $row->setattr('class', 'cal-dayname');
 120         if ($this->args['display_weeknum'])
 121             $row->pushContent(HTML::td(array('class' => 'cal-dayname',
 122                                              'align' => 'center'),
 123                                        _("Wk")));
 124         for ($i = 0; $i < 7; $i++) {
 125             $row->pushContent(HTML::td(array('class' => 'cal-dayname',
 126                                              'align' => 'center'),
 127                                        strftime($fs, $time)));
 128             $time += SECONDS_PER_DAY;
 129         }
 130         return $row;
 131     }
 132
 133     function __date($dbi, $time) {
 134         $args = &$this->args;
 135
 136         $page_for_date = $args['prefix'] . strftime($args['date_format'],
 137                                                     $time);
 138         $t = localtime($time, 1);
 139
 140         $td = HTML::td(array('align' => 'center'));
 141
 142         $mday = $t['tm_mday'];
 143         if ($mday == $this->_today) {
 144             $mday = HTML::strong($mday);
 145             $td->setAttr('class', 'cal-today');
 146         }
 147         else if ($dbi->isWikiPage($page_for_date)) {
 148             $this->_links[] = $page_for_date;
 149             $td->setAttr('class', 'cal-day');
 150         }
 151
 152         if ($dbi->isWikiPage($page_for_date)) {
 153             $this->_links[] = $page_for_date;
 154             $date = HTML::a(array('class' => 'cal-day',
 155                                   'href'  => WikiURL($page_for_date),
 156                                   'title' => $page_for_date),
 157                             HTML::em($mday));
 158         }
 159         else {
 160             $date = HTML::a(array('class' => 'cal-hide',
 161                                   'rel'   => 'nofollow',
 162                                   'href'  => WikiURL($page_for_date,
 163                                                      array('action' => 'edit')),
 164                                   'title' => sprintf(_("Edit %s"),
 165                                                      $page_for_date)),
 166                             $mday);
 167         }
 168         $td->pushContent(HTML::raw('&nbsp;'), $date, HTML::raw('&nbsp;'));
 169         return $td;
 170     }
 171
 172     function run($dbi, $argstr, &$request, $basepage) {
 173         $this->args = $this->getArgs($argstr, $request);
 174         $args       = &$this->args;
 175         $this->_links = array();
 176
 177         $now = localtime(time() + 3600 * $request->getPref('timeOffset'), 1);
 178         foreach ( array('month' => $now['tm_mon'] + 1,
 179                         'year'  => $now['tm_year'] + 1900)
 180                   as $param => $dflt ) {
 181
 182             if (!($args[$param] = intval($args[$param])))
 183                 $args[$param]   = $dflt;
 184         }
 185
 186         $time = mktime(12, 0, 0,                               // hh, mm, ss,
 187                        $args['month'] + $args['month_offset'], // month (1-12)
 188                        1,                                      // mday (1-31)
 189                        $args['year']);
 190
 191         $colnum = $args['display_weeknum'] ? 8 : 7;
 192         $cal = HTML::table(array('cellspacing' => 0,
 193                                  'cellpadding' => 2,
 194                                  'class'       => 'cal'),
 195                            HTML::thead(
 196                                        $this->__header($request->getArg('pagename'),
 197                                                        $time),
 198                                        $this->__daynames($args['start_wday'])));
 199
 200         $t = localtime($time, 1);
 201
 202         if ($now['tm_year'] == $t['tm_year'] && $now['tm_mon'] == $t['tm_mon'])
 203             $this->_today = $now['tm_mday'];
 204         else
 205             $this->_today = false;
 206
 207         $tbody = HTML::tbody();
 208         $row = HTML::tr();
 209
 210         if ($args['display_weeknum'])
 211             $row->pushContent(HTML::td(array('class' => 'cal-weeknum'),
 212                                        ((int)strftime("%U", $time))+1)); // %U problem. starts with 0
 213         $col = (7 + $t['tm_wday'] - $args['start_wday']) % 7;
 214         if ($col > 0)
 215             $row->pushContent(HTML::td(array('colspan' => $col)));
 216         $done = false;
 217         while (!$done) {
 218             $row->pushContent($this->__date($dbi, $time));
 219
 220             if (++$col % 7 == 0) {
 221                 $tbody->pushContent($row);
 222                 $col = 0;
 223                 $row = HTML::tr();
 224             }
 225
 226             $time += SECONDS_PER_DAY;
 227             $t     = localtime($time, 1);
 228             $done  = $t['tm_mday'] == 1;
 229             if (!$col and !$done and $args['display_weeknum'])
 230                 $row->pushContent(HTML::td(array('class' => 'cal-weeknum'),
 231                                            ((int)strftime("%U", $time))+1)); // starts with 0
 232         }
 233
 234         if ($row->getContent()) {
 235             $row->pushContent(HTML::td(array('colspan' => (42 - $col) % 7)));
 236             $tbody->pushContent($row);
 237         }
 238         $cal->pushContent($tbody);
 239         return $cal;
 240     }
 241 };
 242
 243 // Local Variables:
 244 // mode: php
 245 // tab-width: 8
 246 // c-basic-offset: 4
 247 // c-hanging-comment-ender-p: nil
 248 // indent-tabs-mode: nil
 249 // End: