2 // PukiWiki - Yet another WikiWikiWeb clone
3 // $Id: tracker.inc.php,v 1.124 2011/01/25 15:01:01 henoheno Exp $
4 // Copyright (C) 2003-2005, 2007 PukiWiki Developers Team
5 // License: GPL v2 or (at your option) any later version
7 // Issue tracker plugin (See Also bugtrack plugin)
9 // tracker_listで表示しないページ名(正規表現で)
10 // 'SubMenu'ページ および '/'を含むページを除外する
11 define('TRACKER_LIST_EXCLUDE_PATTERN','#^SubMenu$|/#');
13 //define('TRACKER_LIST_EXCLUDE_PATTERN','#(?!)#');
15 // 項目の取り出しに失敗したページを一覧に表示する
16 define('TRACKER_LIST_SHOW_ERROR_PAGE',TRUE);
18 function plugin_tracker_convert()
22 if (PKWK_READONLY) return ''; // Show nothing
24 $base = $refer = $vars['page'];
26 $config_name = 'default';
31 $args = func_get_args();
35 $options = array_splice($args,2);
37 $args[1] = get_fullname($args[1],$base);
38 $base = is_pagename($args[1]) ? $args[1] : $base;
40 $config_name = ($args[0] != '') ? $args[0] : $config_name;
41 list($config_name,$form) = array_pad(explode('/',$config_name,2),2,$form);
45 $config = new Config('plugin/tracker/'.$config_name);
49 return "<p>config file '".htmlsc($config_name)."' not found.</p>";
52 $config->config_name = $config_name;
54 $fields = plugin_tracker_get_fields($base,$refer,$config);
56 $form = $config->page.'/'.$form;
59 return "<p>config file '".make_pagelink($form)."' not found.</p>";
61 $retval = convert_html(plugin_tracker_get_source($form));
64 foreach (array_keys($fields) as $name)
66 $replace = $fields[$name]->get_tag();
67 if (is_a($fields[$name],'Tracker_field_hidden'))
72 $retval = str_replace("[$name]",$replace,$retval);
75 <form enctype="multipart/form-data" action="$script" method="post">
83 function plugin_tracker_action()
85 global $post, $vars, $now;
87 if (PKWK_READONLY) die_message('PKWK_READONLY prohibits editing');
89 $config_name = array_key_exists('_config',$post) ? $post['_config'] : '';
91 $config = new Config('plugin/tracker/'.$config_name);
94 return "<p>config file '".htmlsc($config_name)."' not found.</p>";
96 $config->config_name = $config_name;
97 $source = $config->page.'/page';
99 $refer = array_key_exists('_refer',$post) ? $post['_refer'] : $post['_base'];
101 if (!is_pagename($refer))
104 'msg'=>'cannot write',
105 'body'=>'page name ('.htmlsc($refer).') is not valid.'
108 if (!is_page($source))
111 'msg'=>'cannot write',
112 'body'=>'page template ('.htmlsc($source).') is not exist.'
116 $base = $post['_base'];
117 if (!is_pagename($base))
120 'msg'=>'cannot write',
121 'body'=>'page name ('.htmlsc($base).') is not valid.'
125 $name = (array_key_exists('_name',$post)) ? $post['_name'] : '';
126 if (array_key_exists('_page',$post))
128 $page = $real = $post['_page'];
132 $real = is_pagename($name) ? $name : ++$num;
133 $page = get_fullname('./'.$real,$base);
135 if (!is_pagename($page))
140 while (is_page($page))
143 $page = "$base/$real";
146 $postdata = plugin_tracker_get_source($source);
149 $_post = array_merge($post,$_FILES);
150 $_post['_date'] = $now;
151 $_post['_page'] = $page;
152 $_post['_name'] = $name;
153 $_post['_real'] = $real;
154 // $_post['_refer'] = $_post['refer'];
156 $fields = plugin_tracker_get_fields($page,$refer,$config);
158 // Creating an empty page, before attaching files
159 touch(get_filename($page));
161 foreach (array_keys($fields) as $key)
163 $value = array_key_exists($key,$_post) ?
164 $fields[$key]->format_value($_post[$key]) : '';
166 foreach (array_keys($postdata) as $num)
168 if (trim($postdata[$num]) == '')
172 $postdata[$num] = str_replace(
174 ($postdata[$num]{0} == '|' or $postdata[$num]{0} == ':') ?
175 str_replace('|','|',$value) : $value,
181 // Writing page data, without touch
182 page_write($page, join('', $postdata));
184 $r_page = pagename_urlencode($page);
187 header('Location: ' . get_script_uri() . '?' . $r_page);
191 function plugin_tracker_inline()
195 if (PKWK_READONLY) return ''; // Show nothing
197 $args = func_get_args();
198 if (count($args) < 3)
202 $body = array_pop($args);
203 list($config_name,$field) = $args;
205 $config = new Config('plugin/tracker/'.$config_name);
207 if (!$config->read())
209 return "config file '".htmlsc($config_name)."' not found.";
212 $config->config_name = $config_name;
214 $fields = plugin_tracker_get_fields($vars['page'],$vars['page'],$config);
215 $fields[$field]->default_value = $body;
216 return $fields[$field]->get_tag();
220 function plugin_tracker_get_fields($base,$refer,&$config)
222 global $now,$_tracker_messages;
227 '_date'=>'text', // 投稿日時
228 '_update'=>'date', // 最終更新
229 '_past'=>'past', // 経過(passage)
230 '_page'=>'page', // ページ名
231 '_name'=>'text', // 指定されたページ名
232 '_real'=>'real', // 実際のページ名
233 '_refer'=>'page', // 参照元(フォームのあるページ)
234 '_base'=>'page', // 基準ページ
235 '_submit'=>'submit' // 追加ボタン
238 $class = 'Tracker_field_'.$class;
239 $fields[$field] = new $class(array($field,$_tracker_messages["btn$field"],'','20',''),$base,$refer,$config);
242 foreach ($config->get('fields') as $field)
244 // 0=>項目名 1=>見出し 2=>形式 3=>オプション 4=>デフォルト値
245 $class = 'Tracker_field_'.$field[2];
246 if (!class_exists($class))
248 $class = 'Tracker_field_text';
252 $fields[$field[0]] = new $class($field,$base,$refer,$config);
267 var $sort_type = SORT_REGULAR;
270 function __construct($field,$page,$refer,&$config)
276 $this->name = $field[0];
277 $this->title = $field[1];
278 $this->values = explode(',',$field[3]);
279 $this->default_value = $field[4];
281 $this->refer = $refer;
282 $this->config = &$config;
283 $this->data = array_key_exists($this->name,$post) ? $post[$this->name] : '';
288 function get_style($str)
292 function format_value($value)
296 function format_cell($str)
300 function get_value($value)
305 class Tracker_field_text extends Tracker_field
307 var $sort_type = SORT_STRING;
311 $s_name = htmlsc($this->name);
312 $s_size = htmlsc($this->values[0]);
313 $s_value = htmlsc($this->default_value);
314 return "<input type=\"text\" name=\"$s_name\" size=\"$s_size\" value=\"$s_value\" />";
317 class Tracker_field_page extends Tracker_field_text
319 var $sort_type = SORT_STRING;
321 function format_value($value)
325 $value = strip_bracket($value);
326 if (is_pagename($value))
328 $value = "[[$value]]";
330 return parent::format_value($value);
333 class Tracker_field_real extends Tracker_field_text
335 var $sort_type = SORT_REGULAR;
337 class Tracker_field_title extends Tracker_field_text
339 var $sort_type = SORT_STRING;
341 function format_cell($str)
347 class Tracker_field_textarea extends Tracker_field
349 var $sort_type = SORT_STRING;
353 $s_name = htmlsc($this->name);
354 $s_cols = htmlsc($this->values[0]);
355 $s_rows = htmlsc($this->values[1]);
356 $s_value = htmlsc($this->default_value);
357 return "<textarea name=\"$s_name\" cols=\"$s_cols\" rows=\"$s_rows\">$s_value</textarea>";
359 function format_cell($str)
361 $str = preg_replace('/[\r\n]+/','',$str);
362 if (!empty($this->values[2]) and strlen($str) > ($this->values[2] + 3))
364 $str = mb_substr($str,0,$this->values[2]).'...';
369 class Tracker_field_format extends Tracker_field
371 var $sort_type = SORT_STRING;
373 var $styles = array();
374 var $formats = array();
376 function __construct($field,$page,$refer,&$config)
378 parent::__construct($field,$page,$refer,$config);
380 foreach ($this->config->get($this->name) as $option)
382 list($key,$style,$format) = array_pad(array_map(create_function('$a','return trim($a);'),$option),3,'');
385 $this->styles[$key] = $style;
389 $this->formats[$key] = $format;
395 $s_name = htmlsc($this->name);
396 $s_size = htmlsc($this->values[0]);
397 return "<input type=\"text\" name=\"$s_name\" size=\"$s_size\" />";
399 function get_key($str)
401 return ($str == '') ? 'IS NULL' : 'IS NOT NULL';
403 function format_value($str)
407 return join(', ',array_map(array($this,'format_value'),$str));
409 $key = $this->get_key($str);
410 return array_key_exists($key,$this->formats) ? str_replace('%s',$str,$this->formats[$key]) : $str;
412 function get_style($str)
414 $key = $this->get_key($str);
415 return array_key_exists($key,$this->styles) ? $this->styles[$key] : '%s';
418 class Tracker_field_file extends Tracker_field_format
420 var $sort_type = SORT_STRING;
424 $s_name = htmlsc($this->name);
425 $s_size = htmlsc($this->values[0]);
426 return "<input type=\"file\" name=\"$s_name\" size=\"$s_size\" />";
428 function format_value($str)
430 if (array_key_exists($this->name,$_FILES))
432 require_once(PLUGIN_DIR.'attach.inc.php');
433 $result = attach_upload($_FILES[$this->name],$this->page);
434 if ($result['result']) // アップロード成功
436 return parent::format_value($this->page.'/'.$_FILES[$this->name]['name']);
439 // ファイルが指定されていないか、アップロードに失敗
440 return parent::format_value('');
443 class Tracker_field_radio extends Tracker_field_format
445 var $sort_type = SORT_NUMERIC;
449 $s_name = htmlsc($this->name);
452 foreach ($this->config->get($this->name) as $option)
454 $s_option = htmlsc($option[0]);
455 $checked = trim($option[0]) == trim($this->default_value) ? ' checked="checked"' : '';
457 $s_id = '_p_tracker_' . $s_name . '_' . $this->id . '_' . $id;
458 $retval .= '<input type="radio" name="' . $s_name . '" id="' . $s_id .
459 '" value="' . $s_option . '"' . $checked . ' />' .
460 '<label for="' . $s_id . '">' . $s_option . '</label>' . "\n";
465 function get_key($str)
469 function get_value($value)
471 static $options = array();
472 if (!array_key_exists($this->name,$options))
474 $options[$this->name] = array_flip(array_map(create_function('$arr','return $arr[0];'),$this->config->get($this->name)));
476 return array_key_exists($value,$options[$this->name]) ? $options[$this->name][$value] : $value;
479 class Tracker_field_select extends Tracker_field_radio
481 var $sort_type = SORT_NUMERIC;
483 function get_tag($empty=FALSE)
485 $s_name = htmlsc($this->name);
486 $s_size = (array_key_exists(0,$this->values) and is_numeric($this->values[0])) ?
487 ' size="'.htmlsc($this->values[0]).'"' : '';
488 $s_multiple = (array_key_exists(1,$this->values) and strtolower($this->values[1]) == 'multiple') ?
489 ' multiple="multiple"' : '';
490 $retval = "<select name=\"{$s_name}[]\"$s_size$s_multiple>\n";
493 $retval .= " <option value=\"\"></option>\n";
495 $defaults = array_flip(preg_split('/\s*,\s*/',$this->default_value,-1,PREG_SPLIT_NO_EMPTY));
496 foreach ($this->config->get($this->name) as $option)
498 $s_option = htmlsc($option[0]);
499 $selected = array_key_exists(trim($option[0]),$defaults) ? ' selected="selected"' : '';
500 $retval .= " <option value=\"$s_option\"$selected>$s_option</option>\n";
502 $retval .= "</select>";
507 class Tracker_field_checkbox extends Tracker_field_radio
509 var $sort_type = SORT_NUMERIC;
511 function get_tag($empty=FALSE)
513 $s_name = htmlsc($this->name);
514 $defaults = array_flip(preg_split('/\s*,\s*/',$this->default_value,-1,PREG_SPLIT_NO_EMPTY));
517 foreach ($this->config->get($this->name) as $option)
519 $s_option = htmlsc($option[0]);
520 $checked = array_key_exists(trim($option[0]),$defaults) ?
521 ' checked="checked"' : '';
523 $s_id = '_p_tracker_' . $s_name . '_' . $this->id . '_' . $id;
524 $retval .= '<input type="checkbox" name="' . $s_name .
525 '[]" id="' . $s_id . '" value="' . $s_option . '"' . $checked . ' />' .
526 '<label for="' . $s_id . '">' . $s_option . '</label>' . "\n";
532 class Tracker_field_hidden extends Tracker_field_radio
534 var $sort_type = SORT_NUMERIC;
536 function get_tag($empty=FALSE)
538 $s_name = htmlsc($this->name);
539 $s_default = htmlsc($this->default_value);
540 $retval = "<input type=\"hidden\" name=\"$s_name\" value=\"$s_default\" />\n";
545 class Tracker_field_submit extends Tracker_field
549 $s_title = htmlsc($this->title);
550 $s_page = htmlsc($this->page);
551 $s_refer = htmlsc($this->refer);
552 $s_config = htmlsc($this->config->config_name);
555 <input type="submit" value="$s_title" />
556 <input type="hidden" name="plugin" value="tracker" />
557 <input type="hidden" name="_refer" value="$s_refer" />
558 <input type="hidden" name="_base" value="$s_page" />
559 <input type="hidden" name="_config" value="$s_config" />
563 class Tracker_field_date extends Tracker_field
565 var $sort_type = SORT_NUMERIC;
567 function format_cell($timestamp)
569 return format_date($timestamp);
572 class Tracker_field_past extends Tracker_field
574 var $sort_type = SORT_NUMERIC;
576 function format_cell($timestamp)
578 return get_passage($timestamp,FALSE);
580 function get_value($value)
582 return UTIME - $value;
585 ///////////////////////////////////////////////////////////////////////////
587 function plugin_tracker_list_convert()
592 $page = $refer = $vars['page'];
599 $args = func_get_args();
600 switch (count($args))
603 $limit = is_numeric($args[3]) ? $args[3] : $limit;
607 $args[1] = get_fullname($args[1],$page);
608 $page = is_pagename($args[1]) ? $args[1] : $page;
610 $config = ($args[0] != '') ? $args[0] : $config;
611 list($config,$list) = array_pad(explode('/',$config,2),2,$list);
614 return plugin_tracker_getlist($page,$refer,$config,$list,$order,$limit);
616 function plugin_tracker_list_action()
618 global $script,$vars,$_tracker_messages;
620 $page = $refer = $vars['refer'];
621 $s_page = make_pagelink($page);
622 $config = $vars['config'];
623 $list = array_key_exists('list',$vars) ? $vars['list'] : 'list';
624 $order = array_key_exists('order',$vars) ? $vars['order'] : '_real:SORT_DESC';
627 'msg' => $_tracker_messages['msg_list'],
628 'body'=> str_replace('$1',$s_page,$_tracker_messages['msg_back']).
629 plugin_tracker_getlist($page,$refer,$config,$list,$order)
632 function plugin_tracker_getlist($page,$refer,$config_name,$list,$order='',$limit=NULL)
634 $config = new Config('plugin/tracker/'.$config_name);
636 if (!$config->read())
638 return "<p>config file '".htmlsc($config_name)."' is not exist.</p>";
641 $config->config_name = $config_name;
643 if (!is_page($config->page.'/'.$list))
645 return "<p>config file '".make_pagelink($config->page.'/'.$list)."' not found.</p>";
648 $list = new Tracker_list($page,$refer,$config,$list);
650 return $list->toString($limit);
666 function __construct($page,$refer,&$config,$list)
669 $this->config = &$config;
671 $this->fields = plugin_tracker_get_fields($page,$refer,$config);
673 $pattern = join('',plugin_tracker_get_source($config->page.'/page'));
674 // ブロックプラグインをフィールドに置換
675 // #commentなどで前後に文字列の増減があった場合に、[_block_xxx]に吸い込ませるようにする
676 $pattern = preg_replace('/^\#([^\(\s]+)(?:\((.*)\))?\s*$/m','[_block_$1]',$pattern);
680 $this->pattern_fields = array();
681 $pattern = preg_split('/\\\\\[(\w+)\\\\\]/',preg_quote($pattern,'/'),-1,PREG_SPLIT_DELIM_CAPTURE);
682 while (count($pattern))
684 $this->pattern .= preg_replace('/\s+/','\\s*','(?>\\s*'.trim(array_shift($pattern)).'\\s*)');
687 $field = array_shift($pattern);
688 $this->pattern_fields[] = $field;
689 $this->pattern .= '(.*?)';
693 $this->rows = array();
695 $pattern_len = strlen($pattern);
696 foreach (get_existpages() as $_page)
698 if (strpos($_page,$pattern) === 0)
700 $name = substr($_page,$pattern_len);
701 if (preg_match(TRACKER_LIST_EXCLUDE_PATTERN,$name))
705 $this->add($_page,$name);
709 function add($page,$name)
711 static $moved = array();
714 if (array_key_exists($name,$this->rows))
719 $source = plugin_tracker_get_source($page);
720 if (preg_match('/move\sto\s(.+)/',$source[0],$matches))
722 $page = strip_bracket(trim($matches[1]));
723 if (array_key_exists($page,$moved) or !is_page($page))
727 $moved[$page] = TRUE;
728 return $this->add($page,$name);
730 $source = join('',preg_replace('/^(\*{1,3}.*)\[#[A-Za-z][\w-]+\](.*)$/','$1$2',$source));
733 $this->rows[$name] = array(
734 '_page' => "[[$page]]",
735 '_refer' => $this->page,
737 '_update'=> get_filetime($page),
738 '_past' => get_filetime($page)
740 if ($this->rows[$name]['_match'] = preg_match("/{$this->pattern}/s",$source,$matches))
742 array_shift($matches);
743 foreach ($this->pattern_fields as $key=>$field)
745 $this->rows[$name][$field] = trim($matches[$key]);
749 function compare($a, $b)
751 foreach ($this->sort_keys as $sort_key)
753 $field = $sort_key['field'];
754 $dir = $sort_key['dir'];
755 $f = $this->fields[$field];
756 $sort_type = $f->sort_type;
757 $aVal = isset($a[$field]) ? $f->get_value($a[$field]) : '';
758 $bVal = isset($b[$field]) ? $f->get_value($b[$field]) : '';
759 $c = strnatcmp($aVal, $bVal) * ($dir === SORT_ASC ? 1 : -1);
760 if ($c === 0) continue;
765 function sort($order)
771 $names = array_flip(array_keys($this->fields));
772 $this->order = array();
773 foreach (explode(';',$order) as $item)
775 list($key,$dir) = array_pad(explode(':',$item),1,'ASC');
776 if (!array_key_exists($key,$names))
780 switch (strtoupper($dir))
795 $this->order[$key] = $dir;
797 $sort_keys = array();
798 foreach ($this->order as $field=>$order)
800 if (!array_key_exists($field,$names))
804 $sort_keys[] = array('field' => $field, 'dir' => $order);
806 $this->sort_keys = $sort_keys;
807 usort($this->rows, array($this, 'compare'));
809 function replace_item($arr)
811 $params = explode(',',$arr[1]);
812 $name = array_shift($params);
817 else if (array_key_exists($name,$this->items))
819 $str = $this->items[$name];
820 if (array_key_exists($name,$this->fields))
822 $str = $this->fields[$name]->format_cell($str);
827 return $this->pipe ? str_replace('|','|',$arr[0]) : $arr[0];
829 $style = count($params) ? $params[0] : $name;
830 if (array_key_exists($style,$this->items)
831 and array_key_exists($style,$this->fields))
833 $str = sprintf($this->fields[$style]->get_style($this->items[$style]),$str);
835 return $this->pipe ? str_replace('|','|',$str) : $str;
837 function replace_title($arr)
841 $field = $sort = $arr[1];
842 if ($sort == '_name' or $sort == '_page')
846 if (!array_key_exists($field,$this->fields))
852 $order = $this->order;
854 if (is_array($order) && isset($order[$sort]))
856 // BugTrack2/106: Only variables can be passed by reference from PHP 5.0.5
857 $order_keys = array_keys($order); // with array_shift();
859 $index = array_flip($order_keys);
860 $pos = 1 + $index[$sort];
861 $b_end = ($sort == array_shift($order_keys));
862 $b_order = ($order[$sort] == SORT_ASC);
863 $dir = ($b_end xor $b_order) ? SORT_ASC : SORT_DESC;
864 $arrow = '&br;'.($b_order ? '↑' : '↓')."($pos)";
866 unset($order[$sort], $order_keys);
868 $title = $this->fields[$field]->title;
869 $r_page = rawurlencode($this->page);
870 $r_config = rawurlencode($this->config->config_name);
871 $r_list = rawurlencode($this->list);
872 $_order = array("$sort:$dir");
873 if (is_array($order))
874 foreach ($order as $key=>$value)
875 $_order[] = "$key:$value";
876 $r_order = rawurlencode(join(';',$_order));
878 return "[[$title$arrow>$script?plugin=tracker_list&refer=$r_page&config=$r_config&list=$r_list&order=$r_order]]";
880 function toString($limit=NULL)
882 global $_tracker_messages;
887 if ($limit !== NULL and count($this->rows) > $limit)
889 $source = str_replace(
891 array(count($this->rows),$limit),
892 $_tracker_messages['msg_limit'])."\n";
893 $this->rows = array_splice($this->rows,0,$limit);
895 if (count($this->rows) == 0)
899 foreach (plugin_tracker_get_source($this->config->page.'/'.$this->list) as $line)
901 if (preg_match('/^\|(.+)\|[hHfFcC]$/',$line))
903 $source .= preg_replace_callback('/\[([^\[\]]+)\]/',array(&$this,'replace_title'),$line);
910 foreach ($this->rows as $key=>$row)
912 if (!TRACKER_LIST_SHOW_ERROR_PAGE and !$row['_match'])
917 foreach ($body as $line)
919 if (trim($line) == '')
924 $this->pipe = ($line{0} == '|' or $line{0} == ':');
925 $source .= preg_replace_callback('/\[([^\[\]]+)\]/',array(&$this,'replace_item'),$line);
928 return convert_html($source);
931 function plugin_tracker_get_source($page)
933 $source = get_source($page);
935 $source = preg_replace('/^(\*{1,3}.*)\[#[A-Za-z][\w-]+\](.*)$/m','$1$2',$source);
937 return preg_replace('/^#freeze\s*$/im', '', $source);