plugin/bugtrack.inc.php

   1 <?php
   2 // PukiWiki - Yet another WikiWikiWeb clone.
   3 // bugtrack.inc.php
   4 // Copyright
   5 //   2002-2016 PukiWiki Development Team
   6 //   2002 Y.MASUI GPL2  http://masui.net/pukiwiki/ masui@masui.net
   7 //
   8 // BugTrack plugin
   9
  10 // Numbering format
  11 define('PLUGIN_BUGTRACK_NUMBER_FORMAT', '%d'); // Like 'page/1'
  12 //define('PLUGIN_BUGTRACK_NUMBER_FORMAT', '%03d'); // Like 'page/001'
  13
  14 function plugin_bugtrack_init()
  15 {
  16         global $_plugin_bugtrack;
  17         static $init;
  18
  19         if (isset($init)) return; // Already init
  20         if (isset($_plugin_bugtrack)) die('Global $_plugin_bugtrack had been init. Why?');
  21         $init = TRUE;
  22
  23         $_plugin_bugtrack = array(
  24                 'priority_list'  => array('緊急', '重要', '普通', '低'),
  25                 'state_list'     => array('提案', '着手', 'CVS待ち', '完了', '保留', '却下'),
  26                 'state_sort'     => array('着手', 'CVS待ち', '保留', '完了', '提案', '却下'),
  27                 'state_bgcolor'  => array('#ccccff', '#ffcc99', '#ccddcc', '#ccffcc', '#ffccff', '#cccccc', '#ff3333'),
  28                 'header_bgcolor' => '#ffffcc',
  29                 'base'     => 'ページ',
  30                 'summary'  => 'サマリ',
  31                 'nosummary'=> 'ここにサマリを記入して下さい',
  32                 'priority' => '優先順位',
  33                 'state'    => '状態',
  34                 'name'     => '投稿者',
  35                 'noname'   => '名無しさん',
  36                 'date'     => '投稿日',
  37                 'body'     => 'メッセージ',
  38                 'category' => 'カテゴリー',
  39                 'pagename' => 'ページ名',
  40                 'pagename_comment' => '空欄のままだと自動的にページ名が振られます。',
  41                 'version_comment'  => '空欄でも構いません',
  42                 'version'  => 'バージョン',
  43                 'submit'   => '追加'
  44                 );
  45 }
  46
  47 // #bugtrack: Show bugtrack form
  48 function plugin_bugtrack_convert()
  49 {
  50         global $vars;
  51
  52         if (PKWK_READONLY) return ''; // Show nothing
  53
  54         $base = $vars['page'];
  55         $category = array();
  56         if (func_num_args()) {
  57                 $category = func_get_args();
  58                 $_base    = get_fullname(strip_bracket(array_shift($category)), $base);
  59                 if (is_pagename($_base)) $base = $_base;
  60         }
  61
  62         return plugin_bugtrack_print_form($base, $category);
  63 }
  64
  65 function plugin_bugtrack_print_form($base, $category)
  66 {
  67         global $_plugin_bugtrack;
  68         static $id = 0;
  69
  70         ++$id;
  71
  72         $select_priority = "\n";
  73         $count = count($_plugin_bugtrack['priority_list']);
  74         $selected = '';
  75         for ($i = 0; $i < $count; ++$i) {
  76                 if ($i == ($count - 1)) $selected = ' selected="selected"'; // The last one
  77                 $priority_list = htmlsc($_plugin_bugtrack['priority_list'][$i]);
  78                 $select_priority .= '    <option value="' . $priority_list . '"' .
  79                         $selected . '>' . $priority_list . '</option>' . "\n";
  80         }
  81
  82         $select_state = "\n";
  83         for ($i = 0; $i < count($_plugin_bugtrack['state_list']); ++$i) {
  84                 $state_list = htmlsc($_plugin_bugtrack['state_list'][$i]);
  85                 $select_state .= '    <option value="' . $state_list . '">' .
  86                         $state_list . '</option>' . "\n";
  87         }
  88
  89         if (empty($category)) {
  90                 $encoded_category = '<input name="category" id="_p_bugtrack_category_' . $id .
  91                         '" type="text" />';
  92         } else {
  93                 $encoded_category = '<select name="category" id="_p_bugtrack_category_' . $id . '">';
  94                 foreach ($category as $_category) {
  95                         $s_category = htmlsc($_category);
  96                         $encoded_category .= '<option value="' . $s_category . '">' .
  97                                 $s_category . '</option>' . "\n";
  98                 }
  99                 $encoded_category .= '</select>';
 100         }
 101
 102         $script     = get_script_uri();
 103         $s_base     = htmlsc($base);
 104         $s_name     = htmlsc($_plugin_bugtrack['name']);
 105         $s_category = htmlsc($_plugin_bugtrack['category']);
 106         $s_priority = htmlsc($_plugin_bugtrack['priority']);
 107         $s_state    = htmlsc($_plugin_bugtrack['state']);
 108         $s_pname    = htmlsc($_plugin_bugtrack['pagename']);
 109         $s_pnamec   = htmlsc($_plugin_bugtrack['pagename_comment']);
 110         $s_version  = htmlsc($_plugin_bugtrack['version']);
 111         $s_versionc = htmlsc($_plugin_bugtrack['version_comment']);
 112         $s_summary  = htmlsc($_plugin_bugtrack['summary']);
 113         $s_body     = htmlsc($_plugin_bugtrack['body']);
 114         $s_submit   = htmlsc($_plugin_bugtrack['submit']);
 115         $body = <<<EOD
 116 <form action="$script" method="post">
 117  <table border="0">
 118   <tr>
 119    <th><label for="_p_bugtrack_name_$id">$s_name</label></th>
 120    <td><input  id="_p_bugtrack_name_$id" name="name" size="20" type="text" /></td>
 121   </tr>
 122   <tr>
 123    <th><label for="_p_bugtrack_category_$id">$s_category</label></th>
 124    <td>$encoded_category</td>
 125   </tr>
 126   <tr>
 127    <th><label for="_p_bugtrack_priority_$id">$s_priority</label></th>
 128    <td><select id="_p_bugtrack_priority_$id" name="priority">$select_priority   </select></td>
 129   </tr>
 130   <tr>
 131    <th><label for="_p_bugtrack_state_$id">$s_state</label></th>
 132    <td><select id="_p_bugtrack_state_$id" name="state">$select_state   </select></td>
 133   </tr>
 134   <tr>
 135    <th><label for="_p_bugtrack_pagename_$id">$s_pname</label></th>
 136    <td><input  id="_p_bugtrack_pagename_$id" name="pagename" size="20" type="text" />
 137     <small>$s_pnamec</small></td>
 138   </tr>
 139   <tr>
 140    <th><label for="_p_bugtrack_version_$id">$s_version</label></th>
 141    <td><input  id="_p_bugtrack_version_$id" name="version" size="10" type="text" />
 142     <small>$s_versionc</small></td>
 143   </tr>
 144   <tr>
 145    <th><label for="_p_bugtrack_summary_$id">$s_summary</label></th>
 146    <td><input  id="_p_bugtrack_summary_$id" name="summary" size="60" type="text" /></td>
 147   </tr>
 148   <tr>
 149    <th><label   for="_p_bugtrack_body_$id">$s_body</label></th>
 150    <td><textarea id="_p_bugtrack_body_$id" name="body" cols="60" rows="6"></textarea></td>
 151   </tr>
 152   <tr>
 153    <td colspan="2" align="center">
 154     <input type="submit" value="$s_submit" />
 155     <input type="hidden" name="plugin" value="bugtrack" />
 156     <input type="hidden" name="mode"   value="submit" />
 157     <input type="hidden" name="base"   value="$s_base" />
 158    </td>
 159   </tr>
 160  </table>
 161 </form>
 162 EOD;
 163
 164         return $body;
 165 }
 166
 167 // Add new issue
 168 function plugin_bugtrack_action()
 169 {
 170         global $post;
 171
 172         if (PKWK_READONLY) die_message('PKWK_READONLY prohibits editing');
 173         if ($post['mode'] != 'submit') return FALSE;
 174
 175         $page = plugin_bugtrack_write($post['base'], $post['pagename'], $post['summary'],
 176                 $post['name'], $post['priority'], $post['state'], $post['category'],
 177                 $post['version'], $post['body']);
 178
 179         pkwk_headers_sent();
 180         header('Location: ' . get_script_uri() . '?' . pagename_urlencode($page));
 181         exit;
 182 }
 183
 184 function plugin_bugtrack_write($base, $pagename, $summary, $name, $priority, $state, $category, $version, $body)
 185 {
 186         global $post;
 187
 188         $base     = strip_bracket($base);
 189         $pagename = strip_bracket($pagename);
 190
 191         $postdata = plugin_bugtrack_template($base, $summary, $name, $priority,
 192                 $state, $category, $version, $body);
 193
 194         $id = $jump = 1;
 195         $page = $base . '/' . sprintf(PLUGIN_BUGTRACK_NUMBER_FORMAT, $id);
 196         while (is_page($page)) {
 197                 $id   = $jump;
 198                 $jump += 50;
 199                 $page = $base . '/' . sprintf(PLUGIN_BUGTRACK_NUMBER_FORMAT, $jump);
 200         }
 201         $page = $base . '/' . sprintf(PLUGIN_BUGTRACK_NUMBER_FORMAT, $id);
 202         while (is_page($page))
 203                 $page = $base . '/' . sprintf(PLUGIN_BUGTRACK_NUMBER_FORMAT, ++$id);
 204
 205         if ($pagename == '') {
 206                 page_write($page, $postdata);
 207         } else {
 208                 $pagename = get_fullname($pagename, $base);
 209                 if (is_page($pagename) || ! is_pagename($pagename)) {
 210                         $pagename = $page; // Set default
 211                 } else {
 212                         page_write($page, 'move to [[' . $pagename . ']]');
 213                 }
 214                 page_write($pagename, $postdata);
 215         }
 216
 217         return $page;
 218 }
 219
 220 // Generate new page contents
 221 function plugin_bugtrack_template($base, $summary, $name, $priority, $state, $category, $version, $body)
 222 {
 223         global $_plugin_bugtrack, $WikiName;
 224
 225         if (! preg_match("/^$WikiName$$/",$base)) $base = '[[' . $base . ']]';
 226         if ($name != '' && ! preg_match("/^$WikiName$$/",$name)) $name = '[[' . $name . ']]';
 227
 228         if ($name    == '') $name    = $_plugin_bugtrack['noname'];
 229         if ($summary == '') $summary = $_plugin_bugtrack['nosummary'];
 230
 231          return <<<EOD
 232 * $summary
 233
 234 - ${_plugin_bugtrack['base'    ]}: $base
 235 - ${_plugin_bugtrack['name'    ]}: $name
 236 - ${_plugin_bugtrack['priority']}: $priority
 237 - ${_plugin_bugtrack['state'   ]}: $state
 238 - ${_plugin_bugtrack['category']}: $category
 239 - ${_plugin_bugtrack['date'    ]}: &now;
 240 - ${_plugin_bugtrack['version' ]}: $version
 241
 242 ** ${_plugin_bugtrack['body']}
 243 $body
 244 --------
 245
 246 #comment
 247 EOD;
 248 }
 249
 250 // ----------------------------------------
 251 // BugTrack-List plugin
 252
 253 function _plugin_bugtrack_list_paganame_compare($a, $b)
 254 {
 255         return strnatcmp($a['name'], $b['name']);
 256 }
 257
 258 function __pkwk_ctype_digit($s) {
 259         static $ctype_digits_exists;
 260         if (!isset($ctype_digits_exists)) {
 261                 $ctype_digits_exists = function_exists('ctype_digit');
 262         }
 263         if ($ctype_digits_exists) {
 264                 return ctype_digit($s);
 265         }
 266         return preg_match('/^[0-9]+$/', $s) ? true : false;
 267 }
 268
 269 /**
 270  * #bugtrack_list plugin itself
 271  *
 272  * Cache specification
 273  * * Enable only for PHP5.4+ (Because of JSON_UNESCAPE_UNICODE)
 274  * * Use cached values for articles that have the unchaged filemtime
 275  * * Invalidate all cache data everyday
 276  */
 277 function plugin_bugtrack_list_convert()
 278 {
 279         global $script, $vars, $_plugin_bugtrack;
 280         $cache_format_version = 1;
 281         $cache_expire_time = 60 * 60 * 24;
 282         $cache_refresh_time_prev;
 283         static $cache_enabled;
 284         if (!isset($cache_enabled)) {
 285                 $cache_enabled = defined('JSON_UNESCAPED_UNICODE'); // PHP 5.4+
 286         }
 287         $page = $vars['page'];
 288         if (func_num_args()) {
 289                 list($_page) = func_get_args();
 290                 $_page = get_fullname(strip_bracket($_page), $page);
 291                 if (is_pagename($_page)) $page = $_page;
 292         }
 293         $data = array();
 294         $page_list = array();
 295         $pattern = $page . '/';
 296         $pattern_len = strlen($pattern);
 297         foreach (get_existpages() as $p) {
 298                 if (strncmp($p, $pattern, $pattern_len) === 0 && __pkwk_ctype_digit(substr($p, $pattern_len))) {
 299                         $page_list[] = array('name'=>$p,'filetime'=>get_filetime($p));
 300                 }
 301         }
 302         usort($page_list, '_plugin_bugtrack_list_paganame_compare');
 303         $count_list = count($_plugin_bugtrack['state_list']);
 304         $data_map = array();
 305         if ($cache_enabled) {
 306                 // Cache management
 307                 $data_updated = true;
 308                 $cache_filepath = CACHE_DIR . encode($page) . '.bugtrack';
 309                 $json_cached = file_get_contents($cache_filepath);
 310                 if ($json_cached) {
 311                         $wrapdata = json_decode($json_cached);
 312                         if (is_object($wrapdata)) {
 313                                 if (isset($wrapdata->version, $wrapdata->pages, $wrapdata->refreshed_at)) {
 314                                         $cache_time_prev = $wrapdata->refreshed_at;
 315                                   if ($cache_format_version == $wrapdata->version
 316                                                 && time() < $cache_time_prev + $cache_expire_time) {
 317                                                 $data = $wrapdata->pages;
 318                                                 $cache_refresh_time_prev = $cache_time_prev;
 319                                         }
 320                                 }
 321                         }
 322                         if (is_array($data) && !empty($data)) {
 323                                 $all_ok = true;
 324                                 foreach ($page_list as $i=>$page_info) {
 325                                         list($page_name, $no, $summary, $name, $priority, $state, $category, $filetime) = $data[$i];
 326                                         if ($filetime !== $page_info['filetime'] || $page_name !== $page_info['name']) {
 327                                                 $all_ok = false;
 328                                                 break;
 329                                         }
 330                                 }
 331                                 if (!$all_ok) {
 332                                         // Clear cache
 333                                         foreach ($data as $d) {
 334                                                 $page_name = $d[0];
 335                                                 $data_map[$page_name] = $d;
 336                                         }
 337                                         $data = array();
 338                                 }
 339                         }
 340                 }
 341         }
 342
 343         if (empty($data) || !empty($data_map)) {
 344                 // No cache
 345                 foreach ($page_list as $page_info) {
 346                         $page_name = $page_info['name'];
 347                         $filled = false;
 348                         if (isset($data_map[$page_name])) {
 349                                 $d = $data_map[$page_name];
 350                                 list($page_name, $no, $summary, $name, $priority, $state, $category, $filetime) = $d;
 351                                 if ($filetime == $page_info['filetime']) {
 352                                         $data[] = $d;
 353                                         $filled = true;
 354                                 }
 355                         }
 356                         if (!$filled) {
 357                                 $data[] = plugin_bugtrack_list_pageinfo($page_info['name'], null, true, $page_info['filetime']);
 358                         }
 359                 }
 360                 foreach ($data as $i=>$line) {
 361                         list($page_name, $no, $summary, $name, $priority, $state, $category, $filetime, $state_no_cached, $html_cached) = $line;
 362                         if (isset($state_no_cached) && isset($html_cached)) {
 363                                 continue;
 364                         }
 365                         foreach (array('summary', 'name', 'priority', 'state', 'category') as $item)
 366                                 $$item = htmlsc($$item);
 367                         $page_link = make_pagelink($page_name);
 368
 369                         $state_no = array_search($state, $_plugin_bugtrack['state_sort']);
 370                         if ($state_no === NULL || $state_no === FALSE) $state_no = $count_list;
 371                         $bgcolor = htmlsc($_plugin_bugtrack['state_bgcolor'][$state_no]);
 372
 373                         $row = <<<EOD
 374  <tr>
 375   <td style="background-color:$bgcolor">$page_link</td>
 376   <td style="background-color:$bgcolor">$state</td>
 377   <td style="background-color:$bgcolor">$priority</td>
 378   <td style="background-color:$bgcolor">$category</td>
 379   <td style="background-color:$bgcolor">$name</td>
 380   <td style="background-color:$bgcolor">$summary</td>
 381  </tr>
 382 EOD;
 383                         $rec = &$data[$i];
 384                         $rec[] = $state_no; // color number
 385                         $rec[] = $row; // HTML content
 386                 }
 387                 if ($cache_enabled) {
 388                         // Save cache
 389                         if (isset($cache_refresh_time_prev)) {
 390                                 $refreshed_at = $cache_refresh_time_prev;
 391                         } else {
 392                                 $refreshed_at = time();
 393                         }
 394                         $json = array('refreshed_at'=>$refreshed_at, 'pages'=>$data, 'version'=>$cache_format_version);
 395                         $cache_body = json_encode($json, JSON_UNESCAPED_UNICODE + JSON_UNESCAPED_SLASHES);
 396                         file_put_contents($cache_filepath, $cache_body);
 397                 }
 398         }
 399         $table = array();
 400         for ($i = 0; $i <= $count_list + 1; ++$i) $table[$i] = array();
 401         foreach ($data as $line) {
 402                 list($page_name, $no, $summary, $name, $priority, $state, $category, $filetime, $state_no, $html) = $line;
 403                 $table[$state_no][$no] = $html;
 404         }
 405         $table_html = ' <tr>' . "\n";
 406         $bgcolor = htmlsc($_plugin_bugtrack['header_bgcolor']);
 407         foreach (array('pagename', 'state', 'priority', 'category', 'name', 'summary') as $item)
 408                 $table_html .= '  <th style="background-color:' . $bgcolor . '">' .
 409                         htmlsc($_plugin_bugtrack[$item]) . '</th>' . "\n";
 410         $table_html .= ' </tr>' . "\n";
 411         for ($i = 0; $i <= $count_list; ++$i) {
 412                 ksort($table[$i], SORT_NUMERIC);
 413                 $table_html .= join("\n", $table[$i]);
 414         }
 415         return '<table border="1" width="100%">' . "\n" .
 416                 $table_html . "\n" .
 417                 '</table>';
 418 }
 419
 420 // Get one set of data from a page (or a page moved to $page)
 421 function plugin_bugtrack_list_pageinfo($page, $no = NULL, $recurse = TRUE, $filetime = NULL)
 422 {
 423         global $WikiName, $InterWikiName, $BracketName, $_plugin_bugtrack;
 424
 425         if ($no === NULL)
 426                 $no = preg_match('/\/([0-9]+)$/', $page, $matches) ? $matches[1] : 0;
 427
 428         $source = get_source($page);
 429
 430         // Check 'moved' page _just once_
 431         $regex  = "/move\s*to\s*($WikiName|$InterWikiName|\[\[$BracketName\]\])/";
 432         $match  = array();
 433         if ($recurse && preg_match($regex, $source[0], $match))
 434                 return plugin_bugtrack_list_pageinfo(strip_bracket($match[1]), $no, FALSE, $filetime);
 435
 436         $body = join("\n", $source);
 437         foreach(array('summary', 'name', 'priority', 'state', 'category') as $item) {
 438                 $regex = '/-\s*' . preg_quote($_plugin_bugtrack[$item], '/') . '\s*:(.*)/';
 439                 if (preg_match($regex, $body, $matches)) {
 440                         if ($item == 'name') {
 441                                 $$item = strip_bracket(trim($matches[1]));
 442                         } else {
 443                                 $$item = trim($matches[1]);
 444                         }
 445                 } else {
 446                                 $$item = ''; // Data not found
 447                 }
 448         }
 449
 450         if (preg_match("/\*([^\n]*)/", $body, $matches)) {
 451                 $summary = $matches[1];
 452                 make_heading($summary);
 453         }
 454
 455         return array($page, $no, $summary, $name, $priority, $state, $category, $filetime);
 456 }