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'];
118 $name = (array_key_exists('_name',$post)) ? $post['_name'] : '';
119 if (array_key_exists('_page',$post))
121 $page = $real = $post['_page'];
125 $real = is_pagename($name) ? $name : ++$num;
126 $page = get_fullname('./'.$real,$base);
128 if (!is_pagename($page))
133 while (is_page($page))
136 $page = "$base/$real";
139 $postdata = plugin_tracker_get_source($source);
142 $_post = array_merge($post,$_FILES);
143 $_post['_date'] = $now;
144 $_post['_page'] = $page;
145 $_post['_name'] = $name;
146 $_post['_real'] = $real;
147 // $_post['_refer'] = $_post['refer'];
149 $fields = plugin_tracker_get_fields($page,$refer,$config);
151 // Creating an empty page, before attaching files
152 touch(get_filename($page));
154 foreach (array_keys($fields) as $key)
156 $value = array_key_exists($key,$_post) ?
157 $fields[$key]->format_value($_post[$key]) : '';
159 foreach (array_keys($postdata) as $num)
161 if (trim($postdata[$num]) == '')
165 $postdata[$num] = str_replace(
167 ($postdata[$num]{0} == '|' or $postdata[$num]{0} == ':') ?
168 str_replace('|','|',$value) : $value,
174 // Writing page data, without touch
175 page_write($page, join('', $postdata));
177 $r_page = rawurlencode($page);
180 header('Location: ' . get_script_uri() . '?' . $r_page);
184 function plugin_tracker_inline()
188 if (PKWK_READONLY) return ''; // Show nothing
190 $args = func_get_args();
191 if (count($args) < 3)
195 $body = array_pop($args);
196 list($config_name,$field) = $args;
198 $config = new Config('plugin/tracker/'.$config_name);
200 if (!$config->read())
202 return "config file '".htmlsc($config_name)."' not found.";
205 $config->config_name = $config_name;
207 $fields = plugin_tracker_get_fields($vars['page'],$vars['page'],$config);
208 $fields[$field]->default_value = $body;
209 return $fields[$field]->get_tag();
213 function plugin_tracker_get_fields($base,$refer,&$config)
215 global $now,$_tracker_messages;
220 '_date'=>'text', // 投稿日時
221 '_update'=>'date', // 最終更新
222 '_past'=>'past', // 経過(passage)
223 '_page'=>'page', // ページ名
224 '_name'=>'text', // 指定されたページ名
225 '_real'=>'real', // 実際のページ名
226 '_refer'=>'page', // 参照元(フォームのあるページ)
227 '_base'=>'page', // 基準ページ
228 '_submit'=>'submit' // 追加ボタン
231 $class = 'Tracker_field_'.$class;
232 $fields[$field] = &new $class(array($field,$_tracker_messages["btn$field"],'','20',''),$base,$refer,$config);
235 foreach ($config->get('fields') as $field)
237 // 0=>項目名 1=>見出し 2=>形式 3=>オプション 4=>デフォルト値
238 $class = 'Tracker_field_'.$field[2];
239 if (!class_exists($class))
241 $class = 'Tracker_field_text';
245 $fields[$field[0]] = &new $class($field,$base,$refer,$config);
260 var $sort_type = SORT_REGULAR;
263 function Tracker_field($field,$page,$refer,&$config)
269 $this->name = $field[0];
270 $this->title = $field[1];
271 $this->values = explode(',',$field[3]);
272 $this->default_value = $field[4];
274 $this->refer = $refer;
275 $this->config = &$config;
276 $this->data = array_key_exists($this->name,$post) ? $post[$this->name] : '';
281 function get_style($str)
285 function format_value($value)
289 function format_cell($str)
293 function get_value($value)
298 class Tracker_field_text extends Tracker_field
300 var $sort_type = SORT_STRING;
304 $s_name = htmlsc($this->name);
305 $s_size = htmlsc($this->values[0]);
306 $s_value = htmlsc($this->default_value);
307 return "<input type=\"text\" name=\"$s_name\" size=\"$s_size\" value=\"$s_value\" />";
310 class Tracker_field_page extends Tracker_field_text
312 var $sort_type = SORT_STRING;
314 function format_value($value)
318 $value = strip_bracket($value);
319 if (is_pagename($value))
321 $value = "[[$value]]";
323 return parent::format_value($value);
326 class Tracker_field_real extends Tracker_field_text
328 var $sort_type = SORT_REGULAR;
330 class Tracker_field_title extends Tracker_field_text
332 var $sort_type = SORT_STRING;
334 function format_cell($str)
340 class Tracker_field_textarea extends Tracker_field
342 var $sort_type = SORT_STRING;
346 $s_name = htmlsc($this->name);
347 $s_cols = htmlsc($this->values[0]);
348 $s_rows = htmlsc($this->values[1]);
349 $s_value = htmlsc($this->default_value);
350 return "<textarea name=\"$s_name\" cols=\"$s_cols\" rows=\"$s_rows\">$s_value</textarea>";
352 function format_cell($str)
354 $str = preg_replace('/[\r\n]+/','',$str);
355 if (!empty($this->values[2]) and strlen($str) > ($this->values[2] + 3))
357 $str = mb_substr($str,0,$this->values[2]).'...';
362 class Tracker_field_format extends Tracker_field
364 var $sort_type = SORT_STRING;
366 var $styles = array();
367 var $formats = array();
369 function Tracker_field_format($field,$page,$refer,&$config)
371 parent::Tracker_field($field,$page,$refer,$config);
373 foreach ($this->config->get($this->name) as $option)
375 list($key,$style,$format) = array_pad(array_map(create_function('$a','return trim($a);'),$option),3,'');
378 $this->styles[$key] = $style;
382 $this->formats[$key] = $format;
388 $s_name = htmlsc($this->name);
389 $s_size = htmlsc($this->values[0]);
390 return "<input type=\"text\" name=\"$s_name\" size=\"$s_size\" />";
392 function get_key($str)
394 return ($str == '') ? 'IS NULL' : 'IS NOT NULL';
396 function format_value($str)
400 return join(', ',array_map(array($this,'format_value'),$str));
402 $key = $this->get_key($str);
403 return array_key_exists($key,$this->formats) ? str_replace('%s',$str,$this->formats[$key]) : $str;
405 function get_style($str)
407 $key = $this->get_key($str);
408 return array_key_exists($key,$this->styles) ? $this->styles[$key] : '%s';
411 class Tracker_field_file extends Tracker_field_format
413 var $sort_type = SORT_STRING;
417 $s_name = htmlsc($this->name);
418 $s_size = htmlsc($this->values[0]);
419 return "<input type=\"file\" name=\"$s_name\" size=\"$s_size\" />";
421 function format_value($str)
423 if (array_key_exists($this->name,$_FILES))
425 require_once(PLUGIN_DIR.'attach.inc.php');
426 $result = attach_upload($_FILES[$this->name],$this->page);
427 if ($result['result']) // アップロード成功
429 return parent::format_value($this->page.'/'.$_FILES[$this->name]['name']);
432 // ファイルが指定されていないか、アップロードに失敗
433 return parent::format_value('');
436 class Tracker_field_radio extends Tracker_field_format
438 var $sort_type = SORT_NUMERIC;
442 $s_name = htmlsc($this->name);
445 foreach ($this->config->get($this->name) as $option)
447 $s_option = htmlsc($option[0]);
448 $checked = trim($option[0]) == trim($this->default_value) ? ' checked="checked"' : '';
450 $s_id = '_p_tracker_' . $s_name . '_' . $this->id . '_' . $id;
451 $retval .= '<input type="radio" name="' . $s_name . '" id="' . $s_id .
452 '" value="' . $s_option . '"' . $checked . ' />' .
453 '<label for="' . $s_id . '">' . $s_option . '</label>' . "\n";
458 function get_key($str)
462 function get_value($value)
464 static $options = array();
465 if (!array_key_exists($this->name,$options))
467 $options[$this->name] = array_flip(array_map(create_function('$arr','return $arr[0];'),$this->config->get($this->name)));
469 return array_key_exists($value,$options[$this->name]) ? $options[$this->name][$value] : $value;
472 class Tracker_field_select extends Tracker_field_radio
474 var $sort_type = SORT_NUMERIC;
476 function get_tag($empty=FALSE)
478 $s_name = htmlsc($this->name);
479 $s_size = (array_key_exists(0,$this->values) and is_numeric($this->values[0])) ?
480 ' size="'.htmlsc($this->values[0]).'"' : '';
481 $s_multiple = (array_key_exists(1,$this->values) and strtolower($this->values[1]) == 'multiple') ?
482 ' multiple="multiple"' : '';
483 $retval = "<select name=\"{$s_name}[]\"$s_size$s_multiple>\n";
486 $retval .= " <option value=\"\"></option>\n";
488 $defaults = array_flip(preg_split('/\s*,\s*/',$this->default_value,-1,PREG_SPLIT_NO_EMPTY));
489 foreach ($this->config->get($this->name) as $option)
491 $s_option = htmlsc($option[0]);
492 $selected = array_key_exists(trim($option[0]),$defaults) ? ' selected="selected"' : '';
493 $retval .= " <option value=\"$s_option\"$selected>$s_option</option>\n";
495 $retval .= "</select>";
500 class Tracker_field_checkbox extends Tracker_field_radio
502 var $sort_type = SORT_NUMERIC;
504 function get_tag($empty=FALSE)
506 $s_name = htmlsc($this->name);
507 $defaults = array_flip(preg_split('/\s*,\s*/',$this->default_value,-1,PREG_SPLIT_NO_EMPTY));
510 foreach ($this->config->get($this->name) as $option)
512 $s_option = htmlsc($option[0]);
513 $checked = array_key_exists(trim($option[0]),$defaults) ?
514 ' checked="checked"' : '';
516 $s_id = '_p_tracker_' . $s_name . '_' . $this->id . '_' . $id;
517 $retval .= '<input type="checkbox" name="' . $s_name .
518 '[]" id="' . $s_id . '" value="' . $s_option . '"' . $checked . ' />' .
519 '<label for="' . $s_id . '">' . $s_option . '</label>' . "\n";
525 class Tracker_field_hidden extends Tracker_field_radio
527 var $sort_type = SORT_NUMERIC;
529 function get_tag($empty=FALSE)
531 $s_name = htmlsc($this->name);
532 $s_default = htmlsc($this->default_value);
533 $retval = "<input type=\"hidden\" name=\"$s_name\" value=\"$s_default\" />\n";
538 class Tracker_field_submit extends Tracker_field
542 $s_title = htmlsc($this->title);
543 $s_page = htmlsc($this->page);
544 $s_refer = htmlsc($this->refer);
545 $s_config = htmlsc($this->config->config_name);
548 <input type="submit" value="$s_title" />
549 <input type="hidden" name="plugin" value="tracker" />
550 <input type="hidden" name="_refer" value="$s_refer" />
551 <input type="hidden" name="_base" value="$s_page" />
552 <input type="hidden" name="_config" value="$s_config" />
556 class Tracker_field_date extends Tracker_field
558 var $sort_type = SORT_NUMERIC;
560 function format_cell($timestamp)
562 return format_date($timestamp);
565 class Tracker_field_past extends Tracker_field
567 var $sort_type = SORT_NUMERIC;
569 function format_cell($timestamp)
571 return get_passage($timestamp,FALSE);
573 function get_value($value)
575 return UTIME - $value;
578 ///////////////////////////////////////////////////////////////////////////
580 function plugin_tracker_list_convert()
585 $page = $refer = $vars['page'];
592 $args = func_get_args();
593 switch (count($args))
596 $limit = is_numeric($args[3]) ? $args[3] : $limit;
600 $args[1] = get_fullname($args[1],$page);
601 $page = is_pagename($args[1]) ? $args[1] : $page;
603 $config = ($args[0] != '') ? $args[0] : $config;
604 list($config,$list) = array_pad(explode('/',$config,2),2,$list);
607 return plugin_tracker_getlist($page,$refer,$config,$list,$order,$limit);
609 function plugin_tracker_list_action()
611 global $script,$vars,$_tracker_messages;
613 $page = $refer = $vars['refer'];
614 $s_page = make_pagelink($page);
615 $config = $vars['config'];
616 $list = array_key_exists('list',$vars) ? $vars['list'] : 'list';
617 $order = array_key_exists('order',$vars) ? $vars['order'] : '_real:SORT_DESC';
620 'msg' => $_tracker_messages['msg_list'],
621 'body'=> str_replace('$1',$s_page,$_tracker_messages['msg_back']).
622 plugin_tracker_getlist($page,$refer,$config,$list,$order)
625 function plugin_tracker_getlist($page,$refer,$config_name,$list,$order='',$limit=NULL)
627 $config = new Config('plugin/tracker/'.$config_name);
629 if (!$config->read())
631 return "<p>config file '".htmlsc($config_name)."' is not exist.</p>";
634 $config->config_name = $config_name;
636 if (!is_page($config->page.'/'.$list))
638 return "<p>config file '".make_pagelink($config->page.'/'.$list)."' not found.</p>";
641 $list = &new Tracker_list($page,$refer,$config,$list);
643 return $list->toString($limit);
658 function Tracker_list($page,$refer,&$config,$list)
661 $this->config = &$config;
663 $this->fields = plugin_tracker_get_fields($page,$refer,$config);
665 $pattern = join('',plugin_tracker_get_source($config->page.'/page'));
666 // ブロックプラグインをフィールドに置換
667 // #commentなどで前後に文字列の増減があった場合に、[_block_xxx]に吸い込ませるようにする
668 $pattern = preg_replace('/^\#([^\(\s]+)(?:\((.*)\))?\s*$/m','[_block_$1]',$pattern);
672 $this->pattern_fields = array();
673 $pattern = preg_split('/\\\\\[(\w+)\\\\\]/',preg_quote($pattern,'/'),-1,PREG_SPLIT_DELIM_CAPTURE);
674 while (count($pattern))
676 $this->pattern .= preg_replace('/\s+/','\\s*','(?>\\s*'.trim(array_shift($pattern)).'\\s*)');
679 $field = array_shift($pattern);
680 $this->pattern_fields[] = $field;
681 $this->pattern .= '(.*)';
685 $this->rows = array();
687 $pattern_len = strlen($pattern);
688 foreach (get_existpages() as $_page)
690 if (strpos($_page,$pattern) === 0)
692 $name = substr($_page,$pattern_len);
693 if (preg_match(TRACKER_LIST_EXCLUDE_PATTERN,$name))
697 $this->add($_page,$name);
701 function add($page,$name)
703 static $moved = array();
706 if (array_key_exists($name,$this->rows))
711 $source = plugin_tracker_get_source($page);
712 if (preg_match('/move\sto\s(.+)/',$source[0],$matches))
714 $page = strip_bracket(trim($matches[1]));
715 if (array_key_exists($page,$moved) or !is_page($page))
719 $moved[$page] = TRUE;
720 return $this->add($page,$name);
722 $source = join('',preg_replace('/^(\*{1,3}.*)\[#[A-Za-z][\w-]+\](.*)$/','$1$2',$source));
725 $this->rows[$name] = array(
726 '_page' => "[[$page]]",
727 '_refer' => $this->page,
729 '_update'=> get_filetime($page),
730 '_past' => get_filetime($page)
732 if ($this->rows[$name]['_match'] = preg_match("/{$this->pattern}/s",$source,$matches))
734 array_shift($matches);
735 foreach ($this->pattern_fields as $key=>$field)
737 $this->rows[$name][$field] = trim($matches[$key]);
741 function sort($order)
747 $names = array_flip(array_keys($this->fields));
748 $this->order = array();
749 foreach (explode(';',$order) as $item)
751 list($key,$dir) = array_pad(explode(':',$item),1,'ASC');
752 if (!array_key_exists($key,$names))
756 switch (strtoupper($dir))
771 $this->order[$key] = $dir;
775 foreach ($this->order as $field=>$order)
777 if (!array_key_exists($field,$names))
781 foreach ($this->rows as $row)
783 $keys[$field][] = isset($row[$field])? $this->fields[$field]->get_value($row[$field]) : '';
785 $params[] = $keys[$field];
786 $params[] = $this->fields[$field]->sort_type;
790 $params[] = &$this->rows;
792 call_user_func_array('array_multisort',$params);
794 function replace_item($arr)
796 $params = explode(',',$arr[1]);
797 $name = array_shift($params);
802 else if (array_key_exists($name,$this->items))
804 $str = $this->items[$name];
805 if (array_key_exists($name,$this->fields))
807 $str = $this->fields[$name]->format_cell($str);
812 return $this->pipe ? str_replace('|','|',$arr[0]) : $arr[0];
814 $style = count($params) ? $params[0] : $name;
815 if (array_key_exists($style,$this->items)
816 and array_key_exists($style,$this->fields))
818 $str = sprintf($this->fields[$style]->get_style($this->items[$style]),$str);
820 return $this->pipe ? str_replace('|','|',$str) : $str;
822 function replace_title($arr)
826 $field = $sort = $arr[1];
827 if ($sort == '_name' or $sort == '_page')
831 if (!array_key_exists($field,$this->fields))
837 $order = $this->order;
839 if (is_array($order) && isset($order[$sort]))
841 // BugTrack2/106: Only variables can be passed by reference from PHP 5.0.5
842 $order_keys = array_keys($order); // with array_shift();
844 $index = array_flip($order_keys);
845 $pos = 1 + $index[$sort];
846 $b_end = ($sort == array_shift($order_keys));
847 $b_order = ($order[$sort] == SORT_ASC);
848 $dir = ($b_end xor $b_order) ? SORT_ASC : SORT_DESC;
849 $arrow = '&br;'.($b_order ? '↑' : '↓')."($pos)";
851 unset($order[$sort], $order_keys);
853 $title = $this->fields[$field]->title;
854 $r_page = rawurlencode($this->page);
855 $r_config = rawurlencode($this->config->config_name);
856 $r_list = rawurlencode($this->list);
857 $_order = array("$sort:$dir");
858 if (is_array($order))
859 foreach ($order as $key=>$value)
860 $_order[] = "$key:$value";
861 $r_order = rawurlencode(join(';',$_order));
863 return "[[$title$arrow>$script?plugin=tracker_list&refer=$r_page&config=$r_config&list=$r_list&order=$r_order]]";
865 function toString($limit=NULL)
867 global $_tracker_messages;
872 if ($limit !== NULL and count($this->rows) > $limit)
874 $source = str_replace(
876 array(count($this->rows),$limit),
877 $_tracker_messages['msg_limit'])."\n";
878 $this->rows = array_splice($this->rows,0,$limit);
880 if (count($this->rows) == 0)
884 foreach (plugin_tracker_get_source($this->config->page.'/'.$this->list) as $line)
886 if (preg_match('/^\|(.+)\|[hHfFcC]$/',$line))
888 $source .= preg_replace_callback('/\[([^\[\]]+)\]/',array(&$this,'replace_title'),$line);
895 foreach ($this->rows as $key=>$row)
897 if (!TRACKER_LIST_SHOW_ERROR_PAGE and !$row['_match'])
902 foreach ($body as $line)
904 if (trim($line) == '')
909 $this->pipe = ($line{0} == '|' or $line{0} == ':');
910 $source .= preg_replace_callback('/\[([^\[\]]+)\]/',array(&$this,'replace_item'),$line);
913 return convert_html($source);
916 function plugin_tracker_get_source($page)
918 $source = get_source($page);
920 $source = preg_replace('/^(\*{1,3}.*)\[#[A-Za-z][\w-]+\](.*)$/m','$1$2',$source);
922 return preg_replace('/^#freeze\s*$/im', '', $source);