<?php
// PukiWiki - Yet another WikiWikiWeb clone
-// $Id: tracker.inc.php,v 1.102 2007/10/03 15:18:15 henoheno Exp $
+// $Id: tracker.inc.php,v 1.124 2011/01/25 15:01:01 henoheno Exp $
// Copyright (C) 2003-2005, 2007 PukiWiki Developers Team
// License: GPL v2 or (at your option) any later version
//
// Issue tracker plugin (See Also bugtrack plugin)
-define('PLUGIN_TRACKER_USAGE', '#tracker([config[/form][,basepage]])');
-define('PLUGIN_TRACKER_LIST_USAGE', '#tracker_list([config[/list]][[,base][,field:sort[;field:sort ...][,limit]]])');
-
-define('PLUGIN_TRACKER_DEFAULT_CONFIG', 'default');
-define('PLUGIN_TRACKER_DEFAULT_FORM', 'form');
-define('PLUGIN_TRACKER_DEFAULT_LIST', 'list');
-define('PLUGIN_TRACKER_DEFAULT_LIMIT', 0 ); // 0 = Unlimited
-define('PLUGIN_TRACKER_DEFAULT_ORDER', ''); // Example: '_real'
-
-// Allow N columns sorted at a time
-define('PLUGIN_TRACKER_LIST_SORT_LIMIT', 3);
-// Excluding pattern
+// Tracker_list: Excluding pattern
define('PLUGIN_TRACKER_LIST_EXCLUDE_PATTERN','#^SubMenu$|/#'); // 'SubMenu' and using '/'
//define('PLUGIN_TRACKER_LIST_EXCLUDE_PATTERN','#(?!)#'); // Nothing excluded
-// Show error rows (can't capture columns properly)
+// Tracker_list: Show error rows (can't capture columns properly)
define('PLUGIN_TRACKER_LIST_SHOW_ERROR_PAGE', 1);
+// Tracker_list: Allow N columns sorted at a time
+define('PLUGIN_TRACKER_LIST_SORT_LIMIT', 3);
+
+
// ----
+// Basic interface and strategy
+
+define('PLUGIN_TRACKER_USAGE', '#tracker([config[/form][,basepage]])');
+define('PLUGIN_TRACKER_LIST_USAGE', '#tracker_list([config[/list]][[,base][,field:sort[;field:sort ...][,limit]]])');
+
+// $refer : Where the plugin had been set / Where to return back to
+// If ($refer == '') $refer = $base;
+// $base : "$base/nnn" will be added by plugin_tracker_action(), or will be shown by Tracker_list
+// Compat: If ($base == '') $base = $refer;
+// $config : ":config/plugin/tracker/$config" will be load to the Config
+// $form : ":config/plugin/tracker/$config/$form" will be load as template for XHTML form by Tracker_form
+// $page : ":config/plugin/tracker/$config/$page" will be load as template for a new page written by Tracker_form
+// $list : ":config/plugin/tracker/$config/$list" will be load as template of Tracker_list
+// $order : "field:sort" ... i.e. "Severity:desc" means sorting the field "Severity" descendant order.
+// $limit : Show top N rows at a time
+
+define('PLUGIN_TRACKER_DEFAULT_CONFIG', 'default');
+define('PLUGIN_TRACKER_DEFAULT_FORM', 'form');
+define('PLUGIN_TRACKER_DEFAULT_PAGE', 'page');
+define('PLUGIN_TRACKER_DEFAULT_LIST', 'list');
+define('PLUGIN_TRACKER_DEFAULT_ORDER', '');
+define('PLUGIN_TRACKER_DEFAULT_LIMIT', 0 ); // 0 = Unlimited
// Sort type
define('PLUGIN_TRACKER_SORT_TYPE_REGULAR', 0);
define('PLUGIN_TRACKER_SORT_TYPE_NUMERIC', 1);
define('PLUGIN_TRACKER_SORT_TYPE_STRING', 2);
-//define('PLUGIN_TRACKER_SORT_TYPE_LOCALE_STRING', 5);
define('PLUGIN_TRACKER_SORT_TYPE_NATURAL', 6);
if (! defined('SORT_NATURAL')) define('SORT_NATURAL', PLUGIN_TRACKER_SORT_TYPE_NATURAL);
define('PLUGIN_TRACKER_SORT_ORDER_ASC', 4);
define('PLUGIN_TRACKER_SORT_ORDER_DEFAULT', PLUGIN_TRACKER_SORT_ORDER_ASC);
+// ----
// Show a form
function plugin_tracker_convert()
if (PKWK_READONLY) return ''; // Show nothing
- $base = $refer = isset($vars['page']) ? $vars['page'] : '';
- $config_name = PLUGIN_TRACKER_DEFAULT_CONFIG;
- $form = PLUGIN_TRACKER_DEFAULT_FORM;
-
$args = func_get_args();
$argc = count($args);
- if ($argc > 2) {
- return PLUGIN_TRACKER_USAGE . '<br />';
- }
+ if ($argc > 2) return PLUGIN_TRACKER_USAGE . '<br />';
+
+ $base = isset($vars['page']) ? $vars['page'] : '';
+ $refer = '';
+ $config = '';
+ $form = '';
+ $rel = '';
switch ($argc) {
case 2:
- $arg = get_fullname($args[1], $base);
- if (is_pagename($arg)) $base = $arg;
+ $rel = $args[1];
/*FALLTHROUGH*/
case 1:
- // Config/form
+ // Set "$config/$form"
if ($args[0] != '') {
$arg = explode('/', trim($args[0]), 2);
- if ($arg[0] != '' ) $config_name = trim($arg[0]);
- if (isset($arg[1])) $form = trim($arg[1]);
+ if ($arg[0] != '' ) $config = trim($arg[0]);
+ if (isset($arg[1])) $form = trim($arg[1]);
}
}
unset($args, $argc, $arg);
- $config = new Config('plugin/tracker/' . $config_name);
- if (! $config->read()) {
- return '#tracker: Config \'' . htmlspecialchars($config_name) . '\' not found<br />';
+ $tracker_form = & new Tracker_form();
+ if (! $tracker_form->init($base, $refer, $config, $rel)) {
+ return '#tracker: ' . htmlsc($tracker_form->error) . '<br />';
}
- $config->config_name = $config_name;
- $form = $config->page . '/' . $form;
+ // Load $template
+ $form = ($form != '') ? $form : PLUGIN_TRACKER_DEFAULT_FORM;
+ $form = $tracker_form->config->page . '/' . $form;
$template = plugin_tracker_get_source($form, TRUE);
if ($template === FALSE || empty($template)) {
- return '#tracker: Form \'' . make_pagelink($form) . '\' not found or seems empty<br />';
+ return '#tracker: Form not found: ' . $form . '<br />';
}
- $_form = & new Tracker_form($base, $refer, $config);
- $_form->initFields(plugin_tracker_field_pickup($template));
- $_form->initHiddenFields();
- $fields = $_form->fields;
+ if (! $tracker_form->initFields(plugin_tracker_field_pickup($template)) ||
+ ! $tracker_form->initHiddenFields()) {
+ return '#tracker: ' . htmlsc($tracker_form->error);
+ }
+ $fields = $tracker_form->fields;
+ unset($tracker_form);
$from = $to = $hidden = array();
foreach (array_keys($fields) as $fieldname) {
if (PKWK_READONLY) die_message('PKWK_READONLY prohibits editing');
$base = isset($post['_base']) ? $post['_base'] : '';
- $refer = isset($post['_refer']) ? $post['_refer'] : $base;
- if (! is_pagename($refer)) {
- return array(
- 'msg' => 'Cannot write',
- 'body' => 'Page name (' . htmlspecialchars($refer) . ') invalid'
- );
- }
+ $refer = isset($post['_refer']) ? $post['_refer'] : '';
// $page name to add will be decided here
$num = 0;
$page = $base . '/' . $real;
}
- // Loading configuration
- $config_name = isset($post['_config']) ? $post['_config'] : '';
- $config = new Config('plugin/tracker/' . $config_name);
- if (! $config->read()) {
- return '<p>config file \'' . htmlspecialchars($config_name) . '\' not found.</p>';
- }
- $config->config_name = $config_name;
+ $config = isset($post['_config']) ? $post['_config'] : '';
+ // TODO: Why here
// Default
$_post = array_merge($post, $_FILES);
$_post['_date'] = $now;
$_post['_real'] = $real;
// $_post['_refer'] = $_post['refer'];
+ // TODO: Why here => See BugTrack/662
// Creating an empty page, before attaching files
pkwk_touch_file(get_filename($page));
$from = $to = array();
+ $tracker_form = & new Tracker_form();
+ if (! $tracker_form->init($base, $refer, $config)) {
+ return array(
+ 'msg' => 'Cannot write',
+ 'body' => htmlsc($tracker_form->error)
+ );
+ }
+
// Load $template
- $template_page = $config->page . '/page';
+ $template_page = $tracker_form->config->page . '/' . PLUGIN_TRACKER_DEFAULT_PAGE;
$template = plugin_tracker_get_source($template_page);
if ($template === FALSE || empty($template)) {
return array(
'msg' => 'Cannot write',
- 'body' => 'Page template (' . htmlspecialchars($template_page) . ') not exists or seems empty'
+ 'body' => 'Page template (' . htmlsc($template_page) . ') not found'
);
}
- $form = & new Tracker_form($base, $refer, $config);
- $form->initFields(plugin_tracker_field_pickup(implode('', $template)));
- $fields = & $form->fields; // unset()
+ if (! $tracker_form->initFields(plugin_tracker_field_pickup(implode('', $template)))) {
+ return array(
+ 'msg' => 'Cannot write',
+ 'body' => htmlsc($tracker_form->error)
+ );
+ }
+ $fields = $tracker_form->fields;
+ unset($tracker_form);
+
foreach (array_keys($fields) as $field) {
$from[] = '[' . $field . ']';
$to[] = isset($_post[$field]) ? $fields[$field]->format_value($_post[$field]) : '';
// Data set of XHTML form or something
class Tracker_form
{
- var $id; // Unique id per instance
-
var $base;
var $refer;
- var $config;
+ var $config_name;
+
+ var $config; // class Config
var $raw_fields;
var $fields = array();
var $error = ''; // Error message
- function Tracker_form($base, $refer, $config)
+ function init($base, $refer = '', $config = NULL, $relative = '')
{
- static $id = 0;
- $this->id = ++$id;
+ $base = trim($base);
+ $refer = trim($refer);
+ $relative = trim($relative);
+
+ if ($refer == '') $refer = $base;
+ if ($base == '') $base = $refer; // Compat
+
+ if ($base == '') {
+ $this->error = 'Base not specified';
+ return FALSE;
+ } else if (! is_pagename($refer)) {
+ $this->error = 'Invalid page name: ' . $refer;
+ return FALSE;
+ }
- $this->base = $base;
- $this->refer = $refer;
- $this->config = $config;
+ $absolute = get_fullname($relative, $base);
+ if (is_pagename($absolute)) $base = $absolute;
+
+ $this->base = $base;
+ $this->refer = $refer;
+
+ if ($config !== NULL && ! $this->loadConfig($config)) {
+ return FALSE;
+ }
+
+ return TRUE;
}
- function addField($fieldname, $displayname, $type = 'text', $options = '20', $default = '')
+ function loadConfig($config = '')
{
- // TODO: Return an error
- if (isset($this->fields[$fieldname])) return TRUE;
+ if (isset($this->config)) return TRUE;
- $class = 'Tracker_field_' . $type;
- if (! class_exists($class)) {
- // TODO: Return an error
- $type = 'text';
- $class = 'Tracker_field_' . $type;
- $options = '20';
- }
+ $config = trim($config);
+ if ($config == '') $config = PLUGIN_TRACKER_DEFAULT_CONFIG;
- $this->fields[$fieldname] = & new $class(
- $this, // Reference
- array(
- $fieldname,
- $displayname,
- NULL, // $type
- $options,
- $default
- )
- );
+ $obj_config = new Config('plugin/tracker/' . $config);
- return TRUE;
+ if ($obj_config->read()) {
+ $this->config = $obj_config;
+ $this->config_name = $config;
+ return TRUE;
+ } else {
+ $this->error = "Config not found: " . $obj_config->page;
+ return FALSE;
+ }
}
+ // Init $this->raw_fields and $this->fields
function initFields($requests = NULL)
{
+ // No argument
+ if (func_num_args() == 0 && $requests === NULL) {
+ return $this->initFields(NULL);
+ }
+
if (! isset($this->raw_fields)) {
$raw_fields = array();
// From config
$raw_fields = & $this->raw_fields;
}
- if ($requests === NULL) {
- // (The rest of) All, defined order
- foreach ($raw_fields as $fieldname => $field) {
- $this->addField(
- $fieldname,
- $field['display'],
- $field['type'],
- $field['options'],
- $field['default']
- );
+ foreach(func_get_args() as $requests) {
+ if (empty($raw_fields)) return TRUE;
+
+ if (! is_array($requests)) {
+ if ($requests === NULL) {
+ $requests = array_keys($raw_fields); // (The rest of) All, defined order
+ } else {
+ $requests = array($requests); // Just one
+ }
}
- $raw_fields = array();
- } else {
- // Part of, specific order
- if (! is_array($requests)) $requests = array($requests);
foreach ($requests as $fieldname) {
if (! isset($raw_fields[$fieldname])) continue;
$field = $raw_fields[$fieldname];
- $this->addField(
+ $err = $this->addField(
$fieldname,
$field['display'],
$field['type'],
$field['default']
);
unset($raw_fields[$fieldname]);
+ if (! $err) return FALSE;
}
}
function initHiddenFields()
{
// Make sure to init $this->raw_fields
- $this->initFields(array());
+ if (! $this->initFields(array())) return FALSE;
$fields = array();
foreach ($this->raw_fields as $fieldname => $field) {
- if ($field['type'] == 'hidden') {
+ if (isset($field['type']) && $field['type'] == 'hidden') {
$fields[] = $fieldname;
}
}
- $this->initFields($fields);
+ return $this->initFields($fields);
+ }
+
+ // Add $this->fields
+ function addField($fieldname, $displayname, $type = 'text', $options = '20', $default = '')
+ {
+ if (isset($this->fields[$fieldname])) return TRUE; // Already
+
+ $class = 'Tracker_field_' . $type;
+ if (! class_exists($class)) {
+ $this->error = "No such type: " . $type;
+ return FALSE;
+ }
+
+ $this->fields[$fieldname] = & new $class(
+ $this, // Reference
+ array(
+ $fieldname,
+ $displayname,
+ NULL, // $type
+ $options,
+ $default
+ )
+ );
+
+ return TRUE;
}
}
class Tracker_field
{
var $id; // Unique id per instance, and per class(extended-class)
-
var $form; // Parent (class Tracker_form)
var $name;
var $title;
- var $values;
+ var $options;
var $default_value;
var $data;
$this->form = & $tracker_form;
$this->name = isset($field[0]) ? $field[0] : '';
$this->title = isset($field[1]) ? $field[1] : '';
- $this->values = isset($field[3]) ? explode(',', $field[3]) : array();
+ $this->options = isset($field[3]) ? explode(',', $field[3]) : array();
$this->default_value = isset($field[4]) ? $field[4] : '';
$this->data = isset($post[$this->name]) ? $post[$this->name] : '';
}
- // XHTML part inside a form
+ // Output a part of XHTML form for the field
function get_tag()
{
return '';
}
- function get_style()
+ // Format user input before write
+ function format_value($value)
{
- return '%s';
+ return $value;
}
- function format_value($value)
+ // Compare key for Tracker_list->sort()
+ function get_value($value)
{
return $value;
}
- function format_cell($str)
+ // Get $this->formats[$key] for format_value()), or
+ // Get $this->styles[$key] for get_style()
+ // from cell contents
+ function get_key($value)
{
- return $str;
+ return $value;
}
- // Compare key for Tracker_list->sort()
- function get_value($value)
+ // Format table cell data before output the wiki text
+ function format_cell($value)
+ {
+ return $value;
+ }
+
+ // Format-string for sprintf() before output the wiki text
+ function get_style($value)
{
- return $value; // Default: $value itself
+ return '%s';
}
}
function get_tag()
{
+ $s_name = htmlsc($this->name);
+ $s_size = isset($this->options[0]) ? htmlsc($this->options[0]) : '';
+ $s_value = htmlsc($this->default_value);
+
return '<input type="text"' .
- ' name="' . htmlspecialchars($this->name) . '"' .
- ' size="' . htmlspecialchars($this->values[0]) . '"' .
- ' value="' . htmlspecialchars($this->default_value) . '" />';
+ ' name="' . $s_name . '"' .
+ ' size="' . $s_size . '"' .
+ ' value="' . $s_value . '" />';
}
}
-// Special type: The page names
+// Special type: Page name with link syntax
class Tracker_field_page extends Tracker_field_text
{
var $sort_type = PLUGIN_TRACKER_SORT_TYPE_STRING;
+ function _format($page)
+ {
+ $page = strip_bracket($page);
+ if (is_pagename($page)) $page = '[[' . $page . ']]';
+ return $page;
+ }
+
function format_value($value)
{
- $value = strip_bracket($value);
- if (is_pagename($value)) $value = '[[' . $value . ']]';
- return parent::format_value($value);
+ return $this->_format($value);
}
function format_cell($value)
{
- return '[[' . $value . ']]';
+ return $this->_format($value);
}
}
-// Special type : Real(Raw) value of page name
+// Special type: Page name minus 'base'
+// e.g.
+// page name: Tracker/sales/100
+// base : Tracker/sales
+// _real : 100
+//
+// NOTE:
+// Don't consider using within ":config/plugin/tracker/*/page".
+// This value comes from _the_page_name_ itself.
class Tracker_field_real extends Tracker_field_text
{
var $sort_type = PLUGIN_TRACKER_SORT_TYPE_NATURAL;
+
+ function format_cell($value)
+ {
+ // basename(): Rough but work with this
+ // (PLUGIN_TRACKER_LIST_EXCLUDE_PATTERN prohibits '/') situation
+ return basename($value);
+ }
}
+// Special type: For headings cleaning
class Tracker_field_title extends Tracker_field_text
{
var $sort_type = PLUGIN_TRACKER_SORT_TYPE_STRING;
- function format_cell($str)
+ function format_cell($value)
{
- make_heading($str);
- return $str;
+ make_heading($value);
+ return $value;
}
}
function get_tag()
{
+ $s_name = htmlsc($this->name);
+ $s_cols = isset($this->options[0]) ? htmlsc($this->options[0]) : '';
+ $s_rows = isset($this->options[1]) ? htmlsc($this->options[1]) : '';
+ $s_default = htmlsc($this->default_value);
+
return '<textarea' .
- ' name="' . htmlspecialchars($this->name) . '"' .
- ' cols="' . htmlspecialchars($this->values[0]) . '"' .
- ' rows="' . htmlspecialchars($this->values[1]) . '">' .
- htmlspecialchars($this->default_value) .
+ ' name="' . $s_name . '"' .
+ ' cols="' . $s_cols . '"' .
+ ' rows="' . $s_rows . '">' .
+ $s_default .
'</textarea>';
}
- function format_cell($str)
+ function format_cell($value)
{
- $str = preg_replace('/[\r\n]+/', '', $str);
- if (! empty($this->values[2]) && strlen($str) > ($this->values[2] + 3)) {
- $str = mb_substr($str, 0, $this->values[2]) . '...';
+ // Cut too long ones
+ // TODO: Why store all of them to the memory?
+ if (isset($this->options[2])) {
+ $limit = max(0, $this->options[2]);
+ $len = mb_strlen($value);
+ if ($len > ($limit + 3)) { // 3 = mb_strlen('...')
+ $value = mb_substr($value, 0, $limit) . '...';
+ }
}
- return $str;
+ return $value;
}
}
-// Text with formatting if trim($cell) != ''
+// Writing text with formatting if trim($cell) != ''
// See also: http://home.arino.jp/?tracker.inc.php%2F41
class Tracker_field_format extends Tracker_field
{
function Tracker_field_format(& $tracker_form, $field)
{
parent::Tracker_field($tracker_form, $field);
+
foreach ($this->form->config->get($this->name) as $option) {
list($key, $style, $format) = array_pad(array_map('trim', $option), 3, '');
if ($style != '') $this->styles[$key] = $style;
}
}
- function get_tag()
+ function get_key($value)
{
- return '<input type="text"' .
- ' name="' . htmlspecialchars($this->name) . '"' .
- ' size="' . htmlspecialchars($this->values[0]) . '" />';
+ return ($value == '') ? 'IS NULL' : 'IS NOT NULL';
}
- function get_key($str)
+ function get_tag()
{
- return ($str == '') ? 'IS NULL' : 'IS NOT NULL';
+ $s_name = htmlsc($this->name);
+ $s_size = isset($this->options[0]) ? htmlsc($this->options[0]) : '';
+
+ return '<input type="text" name="' . $s_name . '" size="' . $s_size . '" />';
}
- function format_value($str)
+ function format_value($value)
{
- if (is_array($str)) {
- return join(', ', array_map(array($this, 'format_value'), $str));
+ if (is_array($value)) {
+ return join(', ', array_map(array($this, 'format_value'), $value));
}
- $key = $this->get_key($str);
- return isset($this->formats[$key]) ? str_replace('%s', $str, $this->formats[$key]) : $str;
+ $key = $this->get_key($value);
+ return isset($this->formats[$key]) ? str_replace('%s', $value, $this->formats[$key]) : $value;
}
- function get_style($str)
+ function get_style($value)
{
- $key = $this->get_key($str);
+ $key = $this->get_key($value);
return isset($this->styles[$key]) ? $this->styles[$key] : '%s';
}
}
function get_tag()
{
- return '<input type="file"' .
- ' name="' . htmlspecialchars($this->name) . '"' .
- ' size="' . htmlspecialchars($this->values[0]) . '" />';
+ $s_name = htmlsc($this->name);
+ $s_size = isset($this->options[0]) ? htmlsc($this->options[0]) : '';
+
+ return '<input type="file" name="' . $s_name . '" size="' . $s_size . '" />';
}
function format_value()
{
if (isset($_FILES[$this->name])) {
-
require_once(PLUGIN_DIR . 'attach.inc.php');
$base = $this->form->base;
$retval = '';
$id = 0;
- $s_name = htmlspecialchars($this->name);
+ $s_name = htmlsc($this->name);
foreach ($this->form->config->get($this->name) as $option) {
++$id;
$s_id = '_p_tracker_' . $s_name . '_' . $this->id . '_' . $id;
- $s_option = htmlspecialchars($option[0]);
- $checked = trim($option[0]) == trim($this->default_value) ? ' checked="checked"' : '';
+ $s_option = htmlsc($option[0]);
+ $checked = trim($option[0]) === trim($this->default_value) ? ' checked="checked"' : '';
$retval .= '<input type="radio"' .
' name="' . $s_name . '"' .
return $retval;
}
- function get_key($str)
- {
- return $str;
- }
-
function get_value($value)
{
$options = & $this->_options;
return isset($options[$name][$value]) ? $options[$name][$value] : $value;
}
+
+ // Revert(re-overload) Tracker_field_format's specific code
+ function get_key($value)
+ {
+ return $value;
+ }
}
class Tracker_field_select extends Tracker_field_radio
{
var $sort_type = PLUGIN_TRACKER_SORT_TYPE_NUMERIC;
+ var $_defaults;
+
function get_tag($empty = FALSE)
{
- $s_name = htmlspecialchars($this->name);
- $s_size = (isset($this->values[0]) && is_numeric($this->values[0])) ?
- ' size="' . htmlspecialchars($this->values[0]) . '"' :
- '';
- $s_multiple = (isset($this->values[1]) && strtolower($this->values[1]) == 'multiple') ?
- ' multiple="multiple"' :
- '';
-
- $retval = '<select name="' . $s_name . '[]"' . $s_size . $s_multiple . '>' . "\n";
- if ($empty) $retval .= ' <option value=""></option>' . "\n";
- $defaults = array_flip(preg_split('/\s*,\s*/', $this->default_value, -1, PREG_SPLIT_NO_EMPTY));
+ if (! isset($this->_defaults)) {
+ $this->_defaults = array_flip(preg_split('/\s*,\s*/', $this->default_value, -1, PREG_SPLIT_NO_EMPTY));
+ }
+ $defaults = $this->_defaults;
+
+ $retval = array();
+
+ $s_name = htmlsc($this->name);
+ $s_size = (isset($this->options[0]) && is_numeric($this->options[0])) ?
+ ' size="' . htmlsc($this->options[0]) . '"' : '';
+ $s_multiple = (isset($this->options[1]) && strtolower($this->options[1]) == 'multiple') ?
+ ' multiple="multiple"' : '';
+ $retval[] = '<select name="' . $s_name . '[]"' . $s_size . $s_multiple . '>';
+
+ if ($empty) $retval[] = ' <option value=""></option>';
+
foreach ($this->form->config->get($this->name) as $option) {
- $s_option = htmlspecialchars($option[0]);
- $selected = isset($defaults[trim($option[0])]) ? ' selected="selected"' : '';
- $retval .= ' <option value="' . $s_option . '"' . $selected . '>' . $s_option . '</option>' . "\n";
+ $option = reset($option);
+ $s_option = htmlsc($option);
+ $selected = isset($defaults[trim($option)]) ? ' selected="selected"' : '';
+ $retval[] = ' <option value="' . $s_option . '"' . $selected . '>' . $s_option . '</option>';
}
- $retval .= '</select>';
- return $retval;
+ $retval[] = '</select>';
+
+ return implode("\n", $retval);
}
}
function get_tag()
{
- $retval = '';
+ $config = $this->form->config;
- $id = 0;
- $s_name = htmlspecialchars($this->name);
+ $s_name = htmlsc($this->name);
+ $s_fid = htmlsc($this->id);
$defaults = array_flip(preg_split('/\s*,\s*/', $this->default_value, -1, PREG_SPLIT_NO_EMPTY));
- foreach ($this->form->config->get($this->name) as $option) {
+
+ $id = 0;
+ $retval = '';
+ foreach ($config->get($this->name) as $option) {
++$id;
- $s_id = '_p_tracker_' . $s_name . '_' . $this->id . '_' . $id;
- $s_option = htmlspecialchars($option[0]);
+ $s_id = '_p_tracker_' . $s_name . '_' . $s_fid . '_' . $id;
+ $s_option = htmlsc($option[0]);
$checked = isset($defaults[trim($option[0])]) ? ' checked="checked"' : '';
$retval .= '<input type="checkbox"' .
- ' name="' . $s_name . '[]"' .
- ' id="' . $s_id . '"' .
- ' value="' . $s_option . '"' .
- $checked . ' />' .
+ ' name="' . $s_name . '[]" id="' . $s_id . '"' .
+ ' value="' . $s_option . '"' . $checked . ' />' .
'<label for="' . $s_id . '">' . $s_option . '</label>' . "\n";
}
function get_tag()
{
+ $s_name = htmlsc($this->name);
+ $s_default = htmlsc($this->default_value);
+
return '<input type="hidden"' .
- ' name="' . htmlspecialchars($this->name) . '"' .
- ' value="' . htmlspecialchars($this->default_value) . '" />' . "\n";
+ ' name="' . $s_name . '"' .
+ ' value="' . $s_default . '" />' . "\n";
}
}
{
$form = $this->form;
- $s_title = htmlspecialchars($this->title);
- $s_base = htmlspecialchars($form->base);
- $s_refer = htmlspecialchars($form->refer);
- $s_config = htmlspecialchars($form->config->config_name);
+ $s_title = htmlsc($this->title);
+ $s_base = htmlsc($form->base);
+ $s_refer = htmlsc($form->refer);
+ $s_config = htmlsc($form->config_name);
return <<<EOD
<input type="submit" value="$s_title" />
{
var $sort_type = PLUGIN_TRACKER_SORT_TYPE_NUMERIC;
- function format_cell($timestamp)
+ function get_value($timestamp)
{
- return get_passage($timestamp, FALSE);
+ return UTIME - $timestamp;
}
- function get_value($value)
+ function format_cell($timestamp)
{
- return UTIME - $value;
+ return get_passage($timestamp, FALSE);
}
}
{
global $vars;
- $base = $refer = isset($vars['page']) ? $vars['page'] : '';
- $config_name = PLUGIN_TRACKER_DEFAULT_CONFIG;
- $list = PLUGIN_TRACKER_DEFAULT_LIST;
- $limit = PLUGIN_TRACKER_DEFAULT_LIMIT;
- $order = PLUGIN_TRACKER_DEFAULT_ORDER;
-
$args = func_get_args();
$argc = count($args);
if ($argc > 4) {
return PLUGIN_TRACKER_LIST_USAGE . '<br />';
}
+
+ $base = isset($vars['page']) ? $vars['page'] : '';
+ $refer = '';
+ $rel = '';
+ $config = '';
+ $order = '';
+ $list = '';
+ $limit = NULL;
switch ($argc) {
case 4: $limit = $args[3]; /*FALLTHROUGH*/
case 3: $order = $args[2]; /*FALLTHROUGH*/
- case 2:
- $arg = get_fullname($args[1], $base);
- if (is_pagename($arg)) $base = $arg;
- /*FALLTHROUGH*/
+ case 2: $rel = $args[1]; /*FALLTHROUGH*/
case 1:
- // Config/list
+ // Set "$config/$list"
if ($args[0] != '') {
$arg = explode('/', $args[0], 2);
- if ($arg[0] != '' ) $config_name = $arg[0];
- if (isset($arg[1])) $list = $arg[1];
+ if ($arg[0] != '' ) $config = $arg[0];
+ if (isset($arg[1])) $list = $arg[1];
}
}
+
unset($args, $argc, $arg);
- return plugin_tracker_list_render($base, $refer, $config_name, $list, $order, $limit);
+ return plugin_tracker_list_render($base, $refer, $rel, $config, $order, $list, $limit);
}
function plugin_tracker_list_action()
{
- global $get, $vars;
-
- $base = isset($get['base']) ? $get['base'] : ''; // Base directory to load
-
- if (isset($get['refer'])) {
- $refer = $get['refer']; // Where to #tracker_list
- if ($base == '') $base = $refer;
- } else {
- $refer = $base;
- }
+ global $get;
+ $base = isset($get['base']) ? $get['base'] : '';
+ $refer = isset($get['refer']) ? $get['refer'] : '';
+ $rel = '';
$config = isset($get['config']) ? $get['config'] : '';
- $list = isset($get['list']) ? $get['list'] : 'list';
- $order = isset($get['order']) ? $get['order'] : PLUGIN_TRACKER_DEFAULT_ORDER;
- $limit = isset($get['limit']) ? $get['limit'] : 0;
+ $order = isset($get['order']) ? $get['order'] : '';
+ $list = isset($get['list']) ? $get['list'] : '';
+ $limit = isset($get['limit']) ? $get['limit'] : NULL;
$s_refer = make_pagelink($refer);
+
return array(
'msg' => plugin_tracker_message('msg_list'),
- 'body'=> str_replace('$1', $s_refer, plugin_tracker_message('msg_back')) .
- plugin_tracker_list_render($base, $refer, $config, $list, $order, $limit)
+ 'body'=>
+ str_replace('$1', $s_refer, plugin_tracker_message('msg_back')) .
+ plugin_tracker_list_render($base, $refer, $rel, $config, $order, $list, $limit)
);
}
-function plugin_tracker_list_render($base, $refer, $config_name, $list, $order_commands = '', $limit = 0)
+function plugin_tracker_list_render($base, $refer, $rel = '', $config = '', $order = '', $list = '', $limit = NULL)
{
- $base = trim($base);
- if ($base == '') return '#tracker_list: Base not specified' . '<br />';
+ $tracker_list = & new Tracker_list();
- $refer = trim($refer);
- if (! is_page($refer)) {
- return '#tracker_list: Refer page not found: ' . htmlspecialchars($refer) . '<br />';
+ if (! $tracker_list->init($base, $refer, $config, $rel) ||
+ ! $tracker_list->setSortOrder($order)) {
+ return '#tracker_list: ' . htmlsc($tracker_list->error) . '<br />';
}
- $config_name = trim($config_name);
- if ($config_name == '') $config_name = PLUGIN_TRACKER_DEFAULT_CONFIG;
-
- $list = trim($list);
- if (! is_numeric($limit)) return PLUGIN_TRACKER_LIST_USAGE . '<br />';
- $limit = intval($limit);
-
- $config = new Config('plugin/tracker/' . $config_name);
- if (! $config->read()) {
- return '#tracker_list: Config not found: ' . htmlspecialchars($config_name) . '<br />';
- }
- $config->config_name = $config_name;
- if (! is_page($config->page . '/' . $list)) {
- return '#tracker_list: List not found: ' . make_pagelink($config->page . '/' . $list) . '<br />';
+ if (! is_page($tracker_list->form->refer)) {
+ return '#tracker_list: Refer page not found: ' . htmlsc($refer) . '<br />';
}
- $list = & new Tracker_list($base, $refer, $config, $list);
- if ($list->setSortOrder($order_commands) === FALSE) {
- return '#tracker_list: ' . htmlspecialchars($list->error) . '<br />';
- }
- $result = $list->toString($limit);
+ $result = $tracker_list->toString($list, $limit);
if ($result === FALSE) {
- return '#tracker_list: ' . htmlspecialchars($list->error) . '<br />';
+ return '#tracker_list: ' . htmlsc($tracker_list->error) . '<br />';
}
- unset($list);
+ unset($tracker_list);
return convert_html($result);
}
{
var $form; // class Tracker_form
- var $list;
+ var $rows = array();
+ var $orders;
+ var $error = ''; // Error message
+ // _generate_regex()
var $pattern;
var $pattern_fields;
- var $rows = array();
- var $orders = array();
- var $error = ''; // Error message
-
// add()
var $_added = array();
// toString()
+ var $_list;
var $_row;
var $_the_first_character_of_the_line;
- function Tracker_list($base, $refer, & $config, $list)
+ function init($base, $refer, $config = NULL, $relative = '')
{
- $form = & new Tracker_form($base, $refer, $config);
- $this->form = $form;
- $this->list = $list;
+ $this->form = & new Tracker_form();
+ return $this->form->init($base, $refer, $config, $relative);
}
- // Add multiple pages at a time
- function loadRows()
- {
- $base = $this->form->base . '/';
- $len = strlen($base);
- $regex = '#^' . preg_quote($base, '#') . '#';
-
- // Adding $this->rows
- foreach (preg_grep($regex, array_values(get_existpages())) as $pagename) {
- if (preg_match(PLUGIN_TRACKER_LIST_EXCLUDE_PATTERN, substr($pagename, $len))) {
- continue;
- }
- if ($this->addRow($pagename) === FALSE) return FALSE;
- }
- if (empty($this->rows)) {
- $this->error = 'Pages not found under: ' . $base;
- return FALSE;
- }
-
- return TRUE;
- }
-
- // addRow(): Generate regex to load a page
+ // Generate/Regenerate regex to load one page
function _generate_regex()
{
- $template_page = $this->form->config->page . '/page';
+ if (isset($this->pattern) && isset($this->pattern_fields)) return TRUE;
+
+ $template_page = $this->form->config->page . '/' . 'page';
$fields = $this->form->fields;
$pattern = array();
$pattern[] = '.*?'; // Just ignore pseudo fields etc
}
}
+
$this->pattern = '/' . implode('', $pattern) . '/sS';
$this->pattern_fields = $pattern_fields;
return TRUE;
}
+ // Adding $this->rows
+ // Add multiple pages at a time
+ function loadRows()
+ {
+ $base = $this->form->base . '/';
+ $len = strlen($base);
+ $regex = '#^' . preg_quote($base, '#') . '#';
+
+ foreach (preg_grep($regex, array_values(get_existpages())) as $pagename) {
+ if (preg_match(PLUGIN_TRACKER_LIST_EXCLUDE_PATTERN, substr($pagename, $len))) {
+ continue;
+ }
+ if ($this->addRow($pagename) === FALSE) return FALSE;
+ }
+ if (empty($this->rows)) {
+ $this->error = 'Pages not found under: ' . $base;
+ return FALSE;
+ }
+
+ return TRUE;
+ }
+
// Add one pages
function addRow($pagename, $rescan = FALSE)
{
+ // Generate/Regenerate regex if needed
+ if ($this->_generate_regex() === FALSE) return FALSE;
+
if (isset($this->_added[$pagename])) return TRUE;
$this->_added[$pagename] = TRUE;
function _order_commands2orders($order_commands = '')
{
$order_commands = trim($order_commands);
+ if ($order_commands == '') $order_commands = PLUGIN_TRACKER_DEFAULT_ORDER;
if ($order_commands == '') return array();
$orders = array();
{
$orders = $this->_order_commands2orders($order_commands);
if ($orders === FALSE) {
- $this->orders = array();
+ unset($this->orders);
return FALSE;
+ } else {
+ $this->orders = $orders;
+ return TRUE;
}
- $this->orders = $orders;
- return TRUE;
}
// sortRows(): Internal sort type => PHP sort define
// Sort $this->rows by $this->orders
function sortRows()
{
+ if (! isset($this->orders)) {
+ $this->error = "Sort order seems not set";
+ return FALSE;
+ }
+
$fields = $this->form->fields;
$orders = $this->orders;
+ $types = array();
- foreach (array_keys($orders) as $fieldname) {
+ $fieldnames = array_keys($orders); // Field names to sort
+
+ foreach ($fieldnames as $fieldname) {
if (! isset($fields[$fieldname])) {
$this->error = 'No such field: ' . $fieldname;
return FALSE;
}
+ $types[$fieldname] = $this->_sort_type_dropout($fields[$fieldname]->sort_type);
+ $orders[$fieldname] = $this->_sort_order_dropout($orders[$fieldname]);
+ if ($types[$fieldname] === FALSE || $orders[$fieldname] === FALSE) return FALSE;
}
- $params = array(); // Arguments for array_multisort()
-
- foreach ($orders as $fieldname => $order) {
- $field = $fields[$fieldname];
-
- $type = $this->_sort_type_dropout($field->sort_type);
- if ($type === FALSE) return FALSE;
+ $columns = array();
+ foreach ($this->rows as $row) {
+ foreach ($fieldnames as $fieldname) {
+ if (isset($row[$fieldname])) {
+ $columns[$fieldname][] = $fields[$fieldname]->get_value($row[$fieldname]);
+ } else {
+ $columns[$fieldname][] = '';
+ }
+ }
+ }
- $order = $this->_sort_order_dropout($order);
- if ($order === FALSE) return FALSE;
+ $params = array();
+ foreach ($fieldnames as $fieldname) {
- $column = array();
- foreach ($this->rows as $row) {
- $column[] = isset($row[$fieldname]) ?
- $field->get_value($row[$fieldname]) :
- '';
- }
- if ($type == SORT_NATURAL) {
+ if ($types[$fieldname] == SORT_NATURAL) {
+ $column = & $columns[$fieldname];
natcasesort($column);
$i = 0;
$last = NULL;
foreach (array_keys($column) as $key) {
- // Consider the same values there for array_multisort()
+ // Consider the same values there, for array_multisort()
if ($last !== $column[$key]) ++$i;
$last = strtolower($column[$key]); // natCASEsort()
$column[$key] = $i;
}
- ksort($column, SORT_NUMERIC);
- $type = SORT_NUMERIC;
+ ksort($column, SORT_NUMERIC); // Revert the order
+ $types[$fieldname] = SORT_NUMERIC;
}
// One column set (one-dimensional array, sort type, and sort order)
// for array_multisort()
- $params[] = $column;
- $params[] = $type;
- $params[] = $order;
+ $params[] = $columns[$fieldname];
+ $params[] = $types[$fieldname];
+ $params[] = $orders[$fieldname];
}
-
- if (! empty($params) && ! empty($this->rows)) {
+ if (! empty($orders) && ! empty($this->rows)) {
$params[] = & $this->rows; // The target
call_user_func_array('array_multisort', $params);
}
// toString(): Called within preg_replace_callback()
function _replace_title($matches = array())
{
- $form = $this->form;
- $base = $form->base;
- $refer = $form->refer;
- $fields = $form->fields;
- $config_name = $form->config->config_name;
+ $form = $this->form;
+ $base = $form->base;
+ $refer = $form->refer;
+ $fields = $form->fields;
+ $config = $form->config_name;
- $list = $this->list;
- $orders = $this->orders;
+ $orders = $this->orders;
+ $list = $this->_list;
$fieldname = isset($matches[1]) ? $matches[1] : '';
if (! isset($fields[$fieldname])) {
// Invalid $fieldname or user's own string or something. Nothing to do
return isset($matches[0]) ? $matches[0] : '';
}
- if ($fieldname == '_name' || $fieldname == '_page') $fieldname = '_real';
// This column seems sorted or not
if (isset($orders[$fieldname])) {
}
$script = get_script_uri();
- $r_base = ($refer != $base) ?
- '&base=' . rawurlencode($base) : '';
- $r_config = ($config_name != PLUGIN_TRACKER_DEFAULT_CONFIG) ?
- '&config=' . rawurlencode($config_name) : '';
- $r_list = ($list != PLUGIN_TRACKER_DEFAULT_LIST) ?
- '&list=' . rawurlencode($list) : '';
- $r_order = ! empty($_orders) ?
- '&order=' . rawurlencode(join(';', $_orders)) : '';
+ $r_base = ($refer != $base) ? '&base=' . rawurlencode($base) : '';
+ $r_config = ($config != PLUGIN_TRACKER_DEFAULT_CONFIG) ? '&config=' . rawurlencode($config) : '';
+ $r_list = ($list != PLUGIN_TRACKER_DEFAULT_LIST ) ? '&list=' . rawurlencode($list) : '';
+ $r_order = ! empty($_orders) ? '&order=' . rawurlencode(join(';', $_orders)) : '';
return
'[[' .
if (! isset($row[$fieldname])) {
// Maybe load miss of the page
if (isset($fields[$fieldname])) {
- $str = '[page_err]'; // Exactlly
+ $str = '[match_err]'; // Exactlly
} else {
$str = isset($matches[0]) ? $matches[0] : ''; // Nothing to do
}
$str = $fields[$fieldname]->format_cell($str);
}
}
+ $str = plugin_tracker_escape($str, $tfc);
}
if (isset($fields[$stylename]) && isset($row[$stylename])) {
$str = sprintf($_style, $str);
}
- return plugin_tracker_escape($str, $tfc);
+ return $str;
}
// Output a part of Wiki text
- function toString($limit = 0)
+ function toString($list = PLUGIN_TRACKER_DEFAULT_LIST, $limit = NULL)
{
+ $list = trim($list);
+ if ($list == '') $list = PLUGIN_TRACKER_DEFAULT_LIST;
+
+ if ($limit == NULL) $limit = PLUGIN_TRACKER_DEFAULT_LIMIT;
+ if (! is_numeric($limit)) {
+ $this->error = "Limit seems not numeric: " . $limit;
+ return FALSE;
+ }
+
$form = & $this->form;
- $list = $form->config->page . '/' . $this->list;
+
+ $this->_list = $list; // For _replace_title() only
+ $list = $form->config->page . '/' . $list;
+
$source = array();
$regex = '/\[([^\[\]]+)\]/';
// Loading template
$template = plugin_tracker_get_source($list, TRUE);
if ($template === FALSE || empty($template)) {
- $this->error = 'Page not found or seems empty: ' . $template;
+ $this->error = 'List not found: ' . $list;
return FALSE;
}
- // Creating $form->fields just you need
- if ($form->initFields('_real') === FALSE ||
- $form->initFields(plugin_tracker_field_pickup($template)) === FALSE ||
- $form->initFields(array_keys($this->orders)) === FALSE) {
- $this->error = $form->error;
+ // Try to create $form->fields just you need
+ if ($form->initFields('_real', plugin_tracker_field_pickup($template),
+ array_keys($this->orders)) === FALSE) {
+ $this->error = $form->error;
return FALSE;
}
- // Generate regex for $form->fields
- if ($this->_generate_regex() === FALSE) return FALSE;
-
// Load and sort $this->rows
if ($this->loadRows() === FALSE || $this->sortRows() === FALSE) return FALSE;
$rows = $this->rows;
OSDN Git Service
