lib/plugin/CalendarList.php

   1 <?php // -*-php-*-
   2 rcs_id('$Id: CalendarList.php,v 1.10 2007-09-01 13:39:46 rurban Exp $');
   3
   4 /**
   5  Copyright 1999-2002,2005-2007 $ThePhpWikiProgrammingTeam
   6
   7  This file is part of PhpWiki.
   8
   9  PhpWiki is free software; you can redistribute it and/or modify
  10  it under the terms of the GNU General Public License as published by
  11  the Free Software Foundation; either version 2 of the License, or
  12  (at your option) any later version.
  13
  14  PhpWiki is distributed in the hope that it will be useful,
  15  but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  GNU General Public License for more details.
  18
  19  You should have received a copy of the GNU General Public License
  20  along with PhpWiki; if not, write to the Free Software
  21  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  22  */
  23
  24 // if not defined in config.ini
  25 if (!defined('PLUGIN_CALENDARLIST_ORDER'))
  26   define('PLUGIN_CALENDARLIST_ORDER',   'normal');
  27 if (!defined('PLUGIN_CALENDARLIST_NEXT_N_DAYS'))
  28   define('PLUGIN_CALENDARLIST_NEXT_N_DAYS','');
  29 if (!defined('PLUGIN_CALENDARLIST_NEXT_N'))
  30   define('PLUGIN_CALENDARLIST_NEXT_N',   '');
  31 if (!defined('PLUGIN_CALENDARLIST_LAST_N_DAYS'))
  32   define('PLUGIN_CALENDARLIST_LAST_N_DAYS','');
  33 if (!defined('PLUGIN_CALENDARLIST_LAST_N'))
  34   define('PLUGIN_CALENDARLIST_LAST_N',   '');
  35
  36 /**
  37  * This is a list of calendar appointments.
  38  * Same arguments as Calendar, so no one is confused
  39  * Uses <dl><dd>DATE<dt>page contents...
  40  * Derived from Calendar.php by Martin Norbäck <martin@safelogic.se>
  41  *
  42  * Insert this plugin into your Calendar page, for example in WikiUser/Calendar:
  43  *   <?plugin Calendar ?>
  44  *   <?plugin CalendarList ?>
  45  *
  46  * Honors now year + month args as start base - together with Calendar navigation.
  47  * The behaviour before 2007 with last/next_n_days was to start now.
  48  *
  49  */
  50 class WikiPlugin_CalendarList
  51 extends WikiPlugin
  52 {
  53     function getName () {
  54         return _("CalendarList");
  55     }
  56
  57     function getDescription () {
  58         return _("CalendarList");
  59     }
  60
  61     function getDefaultArguments() {
  62         return array('prefix'       => '[pagename]',
  63                      'date_format'  => '%Y-%m-%d',
  64                      'order'        => PLUGIN_CALENDARLIST_ORDER, // normal or reverse (report sequence)
  65                      'year'         => '',
  66                      'month'        => '',
  67                      'month_offset' => 0,
  68                      //support ranges: next n days/events
  69                      'next_n_days'  => PLUGIN_CALENDARLIST_NEXT_N_DAYS, // one or the other, not both
  70                      'next_n'       => PLUGIN_CALENDARLIST_NEXT_N,
  71                      // last n days/entries:
  72                      'last_n_days'  => PLUGIN_CALENDARLIST_LAST_N_DAYS, // one or the other, not both
  73                      'last_n'       => PLUGIN_CALENDARLIST_LAST_N,
  74
  75                      'month_format' => '%B, %Y',
  76                      'wday_format'  => '%a',
  77                      'start_wday'   => '1');
  78     }
  79
  80     /**
  81      * return links (static only as of action=edit)
  82      *
  83      * @param string $argstr The plugin argument string.
  84      * @param string $basepage The pagename the plugin is invoked from.
  85      * @return array List of pagenames linked to (or false).
  86      */
  87     function getWikiPageLinks ($argstr, $basepage) {
  88         if (isset($this->_links))
  89             return $this->_links;
  90         else {
  91             global $request;
  92             $this->run($request->_dbi, $argstr, $request, $basepage);
  93             return $this->_links;
  94         }
  95     }
  96
  97     function _count_events($dbi, $n = 7, $direction = 1) {
  98         //      This is used by the last_n/next_n options to determine the date that
  99         //      accounts for the number of N events in the past/future.
 100         //      RETURNS: date of N-th event or the last item found
 101         $args = &$this->args;                           // gather the args array
 102         $timeTMP = time();                              // start with today's date
 103         $t = $timeTMP;                                  // init the control date variable to now
 104
 105         for ($i=0; $i<=180; $i++) {                     // loop thru 180 days, past or future
 106             $date_string = strftime($args['date_format'], $t);
 107             $page_for_date = $args['prefix'] . SUBPAGE_SEPARATOR . $date_string;
 108             if ($dbi->isWikiPage($page_for_date)) { // if this date has any comments/events
 109                 $timeTMP = $t;                      //  capture the date of this event for return
 110                 if ($n-- <= 0) break;               //  if we reached the limit, return the date
 111             }
 112             $t += 24 * 3600 * $direction;           // advance one day back or forward
 113         }
 114
 115         // return the date of the N-th or last, most past/future event in the range
 116         return $timeTMP;
 117     }
 118
 119     function _date($dbi, $time) {
 120         $args = &$this->args;
 121         $date_string = strftime($args['date_format'], $time);
 122
 123         $page_for_date = $args['prefix'] . SUBPAGE_SEPARATOR . $date_string;
 124         $t = localtime($time, 1);
 125
 126         $td = HTML::td(array('align' => 'center'));
 127
 128         if ($dbi->isWikiPage($page_for_date)) {
 129             // Extract the page contents for this date
 130             $p = $dbi->getPage($page_for_date);
 131             $r = $p->getCurrentRevision();
 132             $c = $r->getContent();
 133             include_once('lib/BlockParser.php');
 134             $content = TransformText(implode("\n", $c), $r->get('markup'));
 135             $link = HTML::a(array('class' => 'cal-hide',
 136                                   'href'  => WikiURL($page_for_date,
 137                                                      array('action' => 'edit')),
 138                                   'title' => sprintf(_("Edit %s"), $page_for_date)),
 139                             $date_string);
 140             $this->_links[] = $page_for_date;
 141             $a = array(HTML::dt($link), HTML::dd($content));
 142         } else {
 143             $a = array();
 144         }
 145         return $a;
 146     }
 147
 148     function run($dbi, $argstr, &$request, $basepage) {
 149         $this->args = $this->getArgs($argstr, $request);
 150         $args       = &$this->args;
 151         $this->_links = array();
 152
 153         // default to this month
 154         $now = localtime(time() + 3600 * $request->getPref('timeOffset'), 1);
 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
 228 // $Log: not supported by cvs2svn $
 229 // Revision 1.9  2006/05/14 17:40:31  rurban
 230 // Patch #1232730 by banjo
 231 //
 232 // Revision 1.8  2005/10/12 06:18:31  rurban
 233 // dont overdo constants
 234 //
 235 // Revision 1.7  2005/07/21 18:55:55  rurban
 236 // applied mpullen patch (Revised to work on all date range combinations...),
 237 // but still does not work as documented.
 238 //
 239 // Revision 1.6.2  2005/06/24 12:00:00  mpullen
 240 //   Corrected bug in the main WHILE loop to detect proper termination point in time
 241 //   {it was stopping one day too soon in either direction}.
 242 //
 243 // Revision 1.6.1  2005/06/23 12:00:00  mpullen
 244 //   Revised to work on all date range combinations (past and future, by days or count of events)
 245 //   Externalized five control parameter constants to the config.ini file (new section 8 for PLUGINs)
 246 //
 247 // Revision 1.6  2005/04/02 03:05:44  uckelman
 248 // Removed & from vars passed by reference (not needed, causes PHP to complain).
 249 //
 250 // Revision 1.5  2004/12/06 19:15:04  rurban
 251 // save edit-time links as requested in #946679
 252 //
 253 // Revision 1.4  2004/12/06 18:32:39  rurban
 254 // added order=reverse: feature request from #981109
 255 //
 256 // Revision 1.3  2004/09/22 13:36:45  rurban
 257 // Support ranges, based on a simple patch by JoshWand
 258 //   next_n_days, last_n_days, next_n
 259 //   last_n not yet
 260 //
 261 // Revision 1.2  2004/02/17 12:11:36  rurban
 262 // added missing 4th basepage arg at plugin->run() to almost all plugins. This caused no harm so far,
 263 //      because it was silently dropped on normal usage. However on plugin internal ->run invocations it failed.
 264 //      (InterWikiSearch, IncludeSiteMap, ...)
 265 //
 266 // Revision 1.1  2003/11/18 19:06:03  carstenklapp
 267 // New plugin to be used in conjunction with the Calendar plugin.
 268 // Upgraded to use SUBPAGE_SEPARATOR for subpages. SF patch tracker
 269 // submission 565369.
 270 //
 271
 272
 273 // For emacs users
 274 // Local Variables:
 275 // mode: php
 276 // tab-width: 8
 277 // c-basic-offset: 4
 278 // c-hanging-comment-ender-p: nil
 279 // indent-tabs-mode: nil
 280 // End:
 281 ?>