DATEpage contents...
* Derived from Calendar.php by Martin Norbäck
*
* Insert this plugin into your Calendar page, for example in:
* WikiUser/Calendar
* Add the line:
*
*/
class WikiPlugin_CalendarList
extends WikiPlugin
{
function getName () {
return _("CalendarList");
}
function getDescription () {
return _("CalendarList");
}
function getDefaultArguments() {
return array('prefix' => '[pagename]',
'date_format' => '%Y-%m-%d',
'order' => PLUGIN_CALENDARLIST_ORDER, // normal or reverse (report sequence)
'year' => '',
'month' => '',
'month_offset' => 0,
//support ranges: next n days/events
'next_n_days' => PLUGIN_CALENDARLIST_NEXT_N_DAYS, // one or the other, not both
'next_n' => PLUGIN_CALENDARLIST_NEXT_N,
// last n days/entries:
'last_n_days' => PLUGIN_CALENDARLIST_LAST_N_DAYS, // one or the other, not both
'last_n' => PLUGIN_CALENDARLIST_LAST_N,
'month_format' => '%B, %Y',
'wday_format' => '%a',
'start_wday' => '0');
}
/**
* return links (static only as of action=edit)
*
* @param string $argstr The plugin argument string.
* @param string $basepage The pagename the plugin is invoked from.
* @return array List of pagenames linked to (or false).
*/
function getWikiPageLinks ($argstr, $basepage) {
if (isset($this->_links))
return $this->_links;
else {
global $request;
$this->run($request->_dbi, $argstr, $request, $basepage);
return $this->_links;
}
}
function _count_events($dbi, $n = 7, $direction = 1) {
// This is used by the last_n/next_n options to determine the date that
// accounts for the number of N events in the past/future.
// RETURNS: date of N-th event or the last item found
$args = &$this->args; // gather the args array
$timeTMP = time(); // start with today's date
$t = $timeTMP; // init the control date variable to now
for ($i=0; $i<=180; $i++) { // loop thru 180 days, past or future
$date_string = strftime($args['date_format'], $t);
$page_for_date = $args['prefix'] . SUBPAGE_SEPARATOR . $date_string;
if ($dbi->isWikiPage($page_for_date)) { // if this date has any comments/events
$timeTMP = $t; // capture the date of this event for return
if ($n-- <= 0) break; // if we reached the limit, return the date
}
$t += SECONDS_PER_DAY * $direction; // advance one day back or forward
}
// return the date of the N-th or last, most past/future event in the range
return $timeTMP;
}
function _date($dbi, $time) {
$args = &$this->args;
$date_string = strftime($args['date_format'], $time);
$page_for_date = $args['prefix'] . SUBPAGE_SEPARATOR . $date_string;
$t = localtime($time, 1);
$td = HTML::td(array('align' => 'center'));
if ($dbi->isWikiPage($page_for_date)) {
// Extract the page contents for this date
$p = $dbi->getPage($page_for_date);
$r = $p->getCurrentRevision();
$c = $r->getContent();
include_once('lib/BlockParser.php');
$content = TransformText(implode("\n", $c), $r->get('markup'));
$link = HTML::a(array('class' => 'cal-hide',
'href' => WikiURL($page_for_date,
array('action' => 'edit')),
'title' => sprintf(_("Edit %s"), $page_for_date)),
$date_string);
$this->_links[] = $page_for_date;
$a = array(HTML::dt($link), HTML::dd($content));
} else {
$a = array();
}
return $a;
}
function run($dbi, $argstr, &$request, $basepage) {
$this->args = $this->getArgs($argstr, $request);
$args = &$this->args;
$this->_links = array();
$now = localtime(time() + 3600 * $request->getPref('timeOffset'), 1);
foreach ( array('month' => $now['tm_mon'] + 1,
'year' => $now['tm_year'] + 1900)
as $param => $dflt ) {
if (!($args[$param] = intval($args[$param])))
$args[$param] = $dflt;
}
// set up default range for TODAY only
$time = time();
$timeBreak = $time;
// ***************************************************
// SET UP THE START/END DATE CONDITIONS
// last_n_days or last_n events
if ($args['last_n_days']) {
$timeBreak = time();
$time = mktime(23, 59, 54, // hh, mm, ss,
$args['month'] + $args['month_offset'], // month (1-12)
$now['tm_mday'] - $args['last_n_days'], // back up so many days
$args['year']);
} elseif ($args['last_n']) {
$timeBreak = time();
$time = $this->_count_events($dbi, $args['last_n'], -1);
}
if ($args['order'] == 'reverse') { // if reverse order, swap the start/end dates
$timeTMP = $time;
$time = $timeBreak;
$timeBreak = $timeTMP;
unset($timeTMP);
}
// next_n_days or next_n events
if ($args['next_n_days']) {
if ($args['order'] == 'reverse') {
$time = mktime(23, 59, 54, // hh, mm, ss,
$args['month'] + $args['month_offset'], // month (1-12)
$now['tm_mday'] + $args['next_n_days'] ,// starting today + next_n_days
$args['year']);
} else {
$timeBreak = mktime(23, 59, 54, // hh, mm, ss,
$args['month'] + $args['month_offset'], // month (1-12)
$now['tm_mday'] + $args['next_n_days'], // starting at 1st of month
$args['year']);
}
} elseif ($args['next_n']) {
$timeTMP = $this->_count_events($dbi, $args['next_n'], 1);
if ($args['order'] == 'reverse') {
$time = $timeTMP + 5;
} else {
$timeBreak = $timeTMP - 5;
}
unset($timeTMP);
}
// NOTE: I don't know what this does or why it is here, but it was in the original plugin
$t = localtime($time, 1);
if ($now['tm_year'] == $t['tm_year'] && $now['tm_mon'] == $t['tm_mon'])
$this->_today = $now['tm_mday'];
else
$this->_today = false;
$cal = HTML::dl();
$done = false;
// all the start/stop range controls are set up now
// ***************************************************
// ***************************************************
// run up or down the date range; this is the real workhorse loop
if ($args['order'] == "reverse") {
$timeBreak -= SECONDS_PER_DAY;
} else {
$timeBreak += SECONDS_PER_DAY;
}
while (!$done) {
$success = $cal->pushContent($this->_date($dbi, $time));
if ($args['order'] == "reverse") {
$time -= SECONDS_PER_DAY;
if ($time < $timeBreak) {
break;
}
} else {
$time += SECONDS_PER_DAY;
if ($time > $timeBreak) {
break;
}
}
}
// end of Plugin CalendarList display logic
// ***************************************************
return $cal;
}
};
// $Log: not supported by cvs2svn $
// Revision 1.6.2 2005/06/24 12:00:00 mpullen
// Corrected bug in the main WHILE loop to detect proper termination point in time
// {it was stopping one day too soon in either direction}.
//
// Revision 1.6.1 2005/06/23 12:00:00 mpullen
// Revised to work on all date range combinations (past and future, by days or count of events)
// Externalized five control parameter constants to the config.ini file (new section 8 for PLUGINs)
//
// Revision 1.6 2005/04/02 03:05:44 uckelman
// Removed & from vars passed by reference (not needed, causes PHP to complain).
//
// Revision 1.5 2004/12/06 19:15:04 rurban
// save edit-time links as requested in #946679
//
// Revision 1.4 2004/12/06 18:32:39 rurban
// added order=reverse: feature request from #981109
//
// Revision 1.3 2004/09/22 13:36:45 rurban
// Support ranges, based on a simple patch by JoshWand
// next_n_days, last_n_days, next_n
// last_n not yet
//
// Revision 1.2 2004/02/17 12:11:36 rurban
// added missing 4th basepage arg at plugin->run() to almost all plugins. This caused no harm so far,
// because it was silently dropped on normal usage. However on plugin internal ->run invocations it failed.
// (InterWikiSearch, IncludeSiteMap, ...)
//
// Revision 1.1 2003/11/18 19:06:03 carstenklapp
// New plugin to be used in conjunction with the Calendar plugin.
// Upgraded to use SUBPAGE_SEPARATOR for subpages. SF patch tracker
// submission 565369.
//
// For emacs users
// Local Variables:
// mode: php
// tab-width: 8
// c-basic-offset: 4
// c-hanging-comment-ender-p: nil
// indent-tabs-mode: nil
// End:
?>