lib/plugin/CalendarList.php

   1 <?php
   2
   3 /**
   4  * * Copyright 1999-2002,2005-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 not defined in config.ini
  24 if (!defined('PLUGIN_CALENDARLIST_ORDER'))
  25   define('PLUGIN_CALENDARLIST_ORDER',        'normal');
  26 if (!defined('PLUGIN_CALENDARLIST_NEXT_N_DAYS'))
  27   define('PLUGIN_CALENDARLIST_NEXT_N_DAYS','');
  28 if (!defined('PLUGIN_CALENDARLIST_NEXT_N'))
  29   define('PLUGIN_CALENDARLIST_NEXT_N',         '');
  30 if (!defined('PLUGIN_CALENDARLIST_LAST_N_DAYS'))
  31   define('PLUGIN_CALENDARLIST_LAST_N_DAYS','');
  32 if (!defined('PLUGIN_CALENDARLIST_LAST_N'))
  33   define('PLUGIN_CALENDARLIST_LAST_N',         '');
  34
  35 /**
  36  * This is a list of calendar appointments.
  37  * Same arguments as Calendar, so no one is confused
  38  * Uses <dl><dd>DATE<dt>page contents...
  39  * Derived from Calendar.php by Martin Norbäck <martin@safelogic.se>
  40  *
  41  * Insert this plugin into your Calendar page, for example in WikiUser/Calendar:
  42  *   <<Calendar >>
  43  *   <<CalendarList >>
  44  *
  45  * Honors now year + month args as start base - together with Calendar navigation.
  46  * The behaviour before 2007 with last/next_n_days was to start now.
  47  *
  48  */
  49 class WikiPlugin_CalendarList
  50 extends WikiPlugin
  51 {
  52     function getName () {
  53         return _("CalendarList");
  54     }
  55
  56     function getDescription () {
  57         return _("CalendarList");
  58     }
  59
  60     function getDefaultArguments() {
  61         return array('prefix'       => '[pagename]',
  62                      'date_format'  => '%Y-%m-%d',
  63                      'order'             => PLUGIN_CALENDARLIST_ORDER, // normal or reverse (report sequence)
  64                      'year'         => '',
  65                      'month'        => '',
  66                      'month_offset' => 0,
  67                      //support ranges: next n days/events
  68                      'next_n_days'  => PLUGIN_CALENDARLIST_NEXT_N_DAYS,        // one or the other, not both
  69                      'next_n'            => PLUGIN_CALENDARLIST_NEXT_N,
  70                      // last n days/entries:
  71                      'last_n_days'  => PLUGIN_CALENDARLIST_LAST_N_DAYS,        // one or the other, not both
  72                      'last_n'            => PLUGIN_CALENDARLIST_LAST_N,
  73
  74                      'month_format' => '%B %Y',
  75                      'wday_format'  => '%a',
  76                      'start_wday'   => '1');
  77     }
  78
  79     /**
  80      * return links (static only as of action=edit)
  81      *
  82      * @param  string $argstr   The plugin argument string.
  83      * @param  string $basepage The pagename the plugin is invoked from.
  84      * @return array  List of pagenames linked to (or false).
  85      */
  86     function getWikiPageLinks ($argstr, $basepage) {
  87         if (isset($this->_links))
  88             return $this->_links;
  89         else {
  90             global $request;
  91             $this->run($request->_dbi, $argstr, $request, $basepage);
  92             return $this->_links;
  93         }
  94     }
  95
  96     function _count_events($dbi, $n = 7, $direction = 1) {
  97         //        This is used by the last_n/next_n options to determine the date that
  98         //        accounts for the number of N events in the past/future.
  99         //        RETURNS: date of N-th event or the last item found
 100         $args = &$this->args;                                // gather the args array
 101         $timeTMP = time();                                // start with today's date
 102         $t = $timeTMP;                                        // init the control date variable to now
 103
 104         for ($i=0; $i<=180; $i++) {                        // loop thru 180 days, past or future
 105             $date_string = strftime($args['date_format'], $t);
 106             $page_for_date = $args['prefix'] . SUBPAGE_SEPARATOR . $date_string;
 107             if ($dbi->isWikiPage($page_for_date)) { // if this date has any comments/events
 108                 $timeTMP = $t;                            //  capture the date of this event for return
 109                 if ($n-- <= 0) break;                    //  if we reached the limit, return the date
 110             }
 111             $t += 24 * 3600 * $direction;            // advance one day back or forward
 112         }
 113
 114         // return the date of the N-th or last, most past/future event in the range
 115         return $timeTMP;
 116     }
 117
 118     function _date($dbi, $time) {
 119         $args = &$this->args;
 120         $date_string = strftime($args['date_format'], $time);
 121
 122         $page_for_date = $args['prefix'] . SUBPAGE_SEPARATOR . $date_string;
 123         $t = localtime($time, 1);
 124
 125         $td = HTML::td(array('align' => 'center'));
 126
 127         if ($dbi->isWikiPage($page_for_date)) {
 128             // Extract the page contents for this date
 129             $p = $dbi->getPage($page_for_date);
 130             $r = $p->getCurrentRevision();
 131             $c = $r->getContent();
 132             include_once 'lib/BlockParser.php';
 133             $content = TransformText(implode("\n", $c), $r->get('markup'));
 134             $link = HTML::a(array('class' => 'cal-hide',
 135                                   'href'  => WikiURL($page_for_date,
 136                                                      array('action' => 'edit')),
 137                                   'title' => sprintf(_("Edit %s"), $page_for_date)),
 138                             $date_string);
 139             $this->_links[] = $page_for_date;
 140             $a = array(HTML::dt($link), HTML::dd($content));
 141         } else {
 142             $a = array();
 143         }
 144         return $a;
 145     }
 146
 147     function run($dbi, $argstr, &$request, $basepage) {
 148         $this->args = $this->getArgs($argstr, $request);
 149         $args       = &$this->args;
 150         $this->_links = array();
 151
 152         // default to this month
 153         $now = localtime(time() + 3600 * $request->getPref('timeOffset'), 1);
 154         $args['mday'] = $now['tm_mday'];
 155         foreach ( array('month' => $now['tm_mon'] + 1,
 156                         'year'  => $now['tm_year'] + 1900,
 157                         'mday'  => $now['tm_mday'])
 158                   as $param => $dflt )
 159         {
 160              if (! ($args[$param] = intval($args[$param])))
 161                 $args[$param]   = $dflt;
 162         }
 163         $base = mktime(0, 0, 0, // h, m, s
 164                        $args['month'],     // month 1-12
 165                        $args['mday'],
 166                        $args['year']);     // must have base 1900
 167
 168         // ***************************************************
 169         // start of Plugin CalendarList display logic
 170         // determine start date
 171         if ($args['last_n_days']) { // back by month
 172             // n days ago, affected by month or month_offset
 173             $start = $base - ($args['last_n_days'] * 24 * 3600.0);
 174         }
 175         elseif ($args['last_n']) {
 176             // get date for last nth event
 177             $start = $this->_count_events($dbi, $args['last_n'], -1);
 178         }
 179         else {
 180             // start of requested month
 181             $start = mktime(0, 0, 0, // h, m, s
 182                             $args['month'] + $args['month_offset'], // month (1-12)
 183                             1, // days prior
 184                             $args['year']);
 185         }
 186
 187         // determine end date
 188         if ($args['next_n_days']) {
 189             // n days from now, affected by month and year
 190             $end = $base + ($args['next_n_days'] * 24 * 3600.0);
 191         }
 192         elseif ($args['last_n']) {
 193             // get date for next nth event
 194             $end = $this->_count_events($dbi, $args['next_n'], 1);
 195         }
 196         else {
 197             // trick to get last day of requested month
 198             $end = mktime(0, 0, -1, // h, m, s
 199                             $args['month'] + 1 + $args['month_offset'], // month (1-12)
 200                             1, // days prior
 201                             $args['year']);
 202         }
 203
 204         // switch values for reverse order
 205         $step = 24 * 3600;
 206         if ($args['order'] == 'reverse') {
 207             $time_tmp = $start;
 208             $start = $end;
 209             $end = $time_tmp;
 210             $step *= -1;
 211         }
 212
 213         // style tag on wiki description but not in here
 214         $cal = HTML::dl();
 215
 216         // loop through dates and create list
 217         for ($i = $start; ($step > 0) ? $i < $end : $i > $end; $i += $step) {
 218             $cal->pushContent($this->_date($dbi, $i));
 219         }
 220         //        end of Plugin CalendarList display logic
 221         // ***************************************************
 222
 223         return $cal;
 224     }
 225 };
 226
 227 // Local Variables:
 228 // mode: php
 229 // tab-width: 8
 230 // c-basic-offset: 4
 231 // c-hanging-comment-ender-p: nil
 232 // indent-tabs-mode: nil
 233 // End: