1<?php 2/** 3 * ToDo Plugin: Creates a checkbox based todo list 4 * 5 * Syntax: <todo [@username] [#]>Name of Action</todo> - 6 * Creates a Checkbox with the "Name of Action" as 7 * the text associated with it. The hash (#, optional) 8 * will cause the checkbox to be checked by default. 9 * The @ sign followed by a username can be used to assign this todo to a user. 10 * examples: 11 * A todo without user assignment 12 * <todo>Something todo</todo> 13 * A completed todo without user assignment 14 * <todo #>Completed todo</todo> 15 * A todo assigned to user User 16 * <todo @leo>Something todo for Leo</todo> 17 * A completed todo assigned to user User 18 * <todo @leo #>Todo completed for Leo</todo> 19 * 20 * In combination with dokuwiki searchpattern plugin version (at least v20130408), 21 * it is a lightweight solution for a task management system based on dokuwiki. 22 * use this searchpattern expression for open todos: 23 * ~~SEARCHPATTERN#'/<todo[^#>]*>.*?<\/todo[\W]*?>/'?? _ToDo ??~~ 24 * use this searchpattern expression for completed todos: 25 * ~~SEARCHPATTERN#'/<todo[^#>]*#[^>]*>.*?<\/todo[\W]*?>/'?? _ToDo ??~~ 26 * do not forget the no-cache option 27 * ~~NOCACHE~~ 28 * 29 * 30 * @license GPL 2 (http://www.gnu.org/licenses/gpl.html) 31 * @author Babbage <babbage@digitalbrink.com>; Leo Eibler <dokuwiki@sprossenwanne.at> 32 */ 33 34if(!defined('DOKU_INC')) die(); 35 36/** 37 * All DokuWiki plugins to extend the parser/rendering mechanism 38 * need to inherit from this class 39 */ 40class syntax_plugin_todo_todo extends DokuWiki_Syntax_Plugin { 41 42 /** 43 * Get the type of syntax this plugin defines. 44 * 45 * @return String 46 */ 47 public function getType() { 48 return 'substition'; 49 } 50 51 /** 52 * Paragraph Type 53 * 54 * 'normal' - The plugin can be used inside paragraphs 55 * 'block' - Open paragraphs need to be closed before plugin output 56 * 'stack' - Special case. Plugin wraps other paragraphs. 57 */ 58 function getPType(){ 59 return 'normal'; 60 } 61 62 /** 63 * Where to sort in? 64 * 65 * @return Integer 66 */ 67 public function getSort() { 68 return 999; 69 } 70 71 /** 72 * Connect lookup pattern to lexer. 73 * 74 * @param $mode String The desired rendermode. 75 * @return void 76 * @see render() 77 */ 78 public function connectTo($mode) { 79 $this->Lexer->addEntryPattern('<todo[\s]*?.*?>(?=.*?</todo>)', $mode, 'plugin_todo_todo'); 80 $this->Lexer->addSpecialPattern('~~NOTODO~~', $mode, 'plugin_todo_todo'); 81 } 82 83 public function postConnect() { 84 $this->Lexer->addExitPattern('</todo>', 'plugin_todo_todo'); 85 } 86 87 /** 88 * Handler to prepare matched data for the rendering process. 89 * 90 * @param $match string The text matched by the patterns. 91 * @param $state int The lexer state for the match. 92 * @param $pos int The character position of the matched text. 93 * @param $handler Doku_Handler Reference to the Doku_Handler object. 94 * @return int The current lexer state for the match. 95 */ 96 public function handle($match, $state, $pos, Doku_Handler $handler) { 97 switch($state) { 98 case DOKU_LEXER_ENTER : 99 #Search to see if the '#' is in the todotag (if so, this means the Action has been completed) 100 $x = preg_match('%<todo([^>]*)>%i', $match, $tododata); 101 if($x) { 102 $handler->todoargs = $this->parseTodoArgs($tododata[1]); 103 } 104 if(!isset($handler->todo_index) || !is_numeric($handler->todo_index)) { 105 $handler->todo_index = 0; 106 } 107 $handler->todo_user = ''; 108 $handler->checked = ''; 109 break; 110 case DOKU_LEXER_MATCHED : 111 break; 112 case DOKU_LEXER_UNMATCHED : 113 /** 114 * Structure: 115 * input(checkbox) 116 * <span> 117 * -<a> (if links is on) or <span> (if links is off) 118 * --<del> (if strikethrough is on) or --NOTHING-- 119 * -</a> or </span> 120 * </span> 121 */ 122 123 #Make sure there is actually an action to create 124 if(trim($match) != '') { 125 126 $data = array_merge(array ($state, 'todotitle' => $match, 'todoindex' => $handler->todo_index, 'todouser' => $handler->todo_user, 'checked' => $handler->checked), $handler->todoargs); 127 $handler->todo_index++; 128 return $data; 129 } 130 131 break; 132 case DOKU_LEXER_EXIT : 133 #Delete temporary checked variable 134 unset($handler->todo_user); 135 unset($handler->checked); 136 unset($handler->todoargs); 137 //unset($handler->todo_index); 138 break; 139 case DOKU_LEXER_SPECIAL : 140 break; 141 } 142 return array(); 143 } 144 145 /** 146 * Handle the actual output creation. 147 * 148 * @param $mode String The output format to generate. 149 * @param $renderer Doku_Renderer A reference to the renderer object. 150 * @param $data Array The data created by the <tt>handle()</tt> method. 151 * @return Boolean true: if rendered successfully, or false: otherwise. 152 */ 153 public function render($mode, Doku_Renderer $renderer, $data) { 154 global $ID; 155 156 if(empty($data)) { 157 return false; 158 } 159 160 [$state] = $data; 161 162 if($mode == 'xhtml') { 163 /** @var $renderer Doku_Renderer_xhtml */ 164 if($state == DOKU_LEXER_UNMATCHED) { 165 166 #Output our result 167 $renderer->doc .= $this->createTodoItem($renderer, $ID, array_merge($data, array('checkbox'=>'yes'))); 168 return true; 169 } 170 } 171 return false; 172 } 173 174 /** 175 * Parse the arguments of todotag 176 * 177 * @param string $todoargs 178 * @return array(bool, false|string) with checked and user 179 */ 180 protected function parseTodoArgs($todoargs) { 181 $data['checked'] = false; 182 unset($data['start']); 183 unset($data['due']); 184 unset($data['completeddate']); 185 $data['showdate'] = $this->getConf("ShowdateTag"); 186 $data['username'] = $this->getConf("Username"); 187 $options = explode(' ', $todoargs); 188 foreach($options as $option) { 189 $option = trim($option); 190 if(empty($option)) continue; 191 if($option[0] == '@') { 192 $data['todousers'][] = substr($option, 1); //fill todousers array 193 if(!isset($data['todouser'])) $data['todouser'] = substr($option, 1); //set the first/main todouser 194 } 195 elseif($option[0] == '#') { 196 $data['checked'] = true; 197 @list($completeduser, $completeddate) = explode(':', $option, 2); 198 $data['completeduser'] = substr($completeduser, 1); 199 if(date('Y-m-d', strtotime($completeddate)) == $completeddate) { 200 $data['completeddate'] = new DateTime($completeddate); 201 } 202 } 203 else { 204 @list($key, $value) = explode(':', $option, 2); 205 switch($key) { 206 case 'username': 207 if(in_array($value, array('user', 'real', 'none'))) { 208 $data['username'] = $value; 209 } 210 break; 211 case 'start': 212 if(date('Y-m-d', strtotime($value)) == $value) { 213 $data['start'] = new DateTime($value); 214 } 215 break; 216 case 'due': 217 if(date('Y-m-d', strtotime($value)) == $value) { 218 $data['due'] = new DateTime($value); 219 } 220 break; 221 case 'showdate': 222 if(in_array($value, array('yes', 'no'))) { 223 $data['showdate'] = ($value == 'yes'); 224 } 225 break; 226 } 227 } 228 } 229 return $data; 230 } 231 232 /** 233 * @param Doku_Renderer_xhtml $renderer 234 * @param string $id of page 235 * @param array $data data for rendering options 236 * @return string html of an item 237 */ 238 protected function createTodoItem($renderer, $id, $data) { 239 //set correct context 240 global $ID, $INFO; 241 $oldID = $ID; 242 $ID = $id; 243 $todotitle = $data['todotitle']; 244 $todoindex = $data['todoindex']; 245 $checked = $data['checked']; 246 $return = ''; 247 248 if($data['checkbox']) { 249 $return .= '<input type="checkbox" class="todocheckbox"' 250 . ' data-index="' . $todoindex . '"' 251 . ' data-date="' . hsc(@filemtime(wikiFN($ID))) . '"' 252 . ' data-pageid="' . hsc($ID) . '"' 253 . ' data-strikethrough="' . ($this->getConf("Strikethrough") ? '1' : '0') . '"' 254 . ($checked ? ' checked="checked"' : '') . ' /> '; 255 } 256 257 // Username(s) of todouser(s) 258 if (!isset($data['todousers'])) $data['todousers']=array(); 259 $todousers = array(); 260 foreach($data['todousers'] as $user) { 261 if (($user = $this->_prepUsername($user,$data['username'])) != '') { 262 $todousers[] = $user; 263 } 264 } 265 $todouser=join(', ',$todousers); 266 267 if($todouser!='') { 268 $return .= '<span class="todouser">[' . hsc($todouser) . ']</span>'; 269 } 270 if(isset($data['completeduser']) && ($checkeduser=$this->_prepUsername($data['completeduser'],$data['username']))!='') { 271 $return .= '<span class="todouser">[' . hsc('✓ '.$checkeduser); 272 if(isset($data['completeddate'])) { $return .= ', '.$data['completeddate']->format('Y-m-d'); } 273 $return .= ']</span>'; 274 } 275 276 // start/due date 277 unset($bg); 278 $now = new DateTime("now"); 279 if(!$checked && (isset($data['start']) || isset($data['due'])) && (!isset($data['start']) || $data['start']<$now) && (!isset($data['due']) || $now<$data['due'])) $bg='todostarted'; 280 if(!$checked && isset($data['due']) && $now>=$data['due']) $bg='tododue'; 281 282 // show start/due date 283 if($data['showdate'] == 1 && (isset($data['start']) || isset($data['due']))) { 284 $return .= '<span class="tododates">['; 285 if(isset($data['start'])) { $return .= $data['start']->format('Y-m-d'); } 286 $return .= ' → '; 287 if(isset($data['due'])) { $return .= $data['due']->format('Y-m-d'); } 288 $return .= ']</span>'; 289 } 290 291 $spanclass = 'todotext'; 292 if($this->getConf("CheckboxText") && !$this->getConf("AllowLinks") && $oldID == $ID && $data['checkbox']) { 293 $spanclass .= ' clickabletodo todohlght'; 294 } 295 if(isset($bg)) $spanclass .= ' '.$bg; 296 $return .= '<span class="' . $spanclass . '">'; 297 298 if($checked && $this->getConf("Strikethrough")) { 299 $return .= '<del>'; 300 } 301 $return .= '<span class="todoinnertext">'; 302 if($this->getConf("AllowLinks")) { 303 $return .= $this->_createLink($renderer, $todotitle, $todotitle); 304 } else { 305 if ($oldID != $ID) { 306 $return .= $renderer->internallink($id, $todotitle, null, true); 307 } else { 308 $return .= hsc($todotitle); 309 } 310 } 311 $return .= '</span>'; 312 313 if($checked && $this->getConf("Strikethrough")) { 314 $return .= '</del>'; 315 } 316 317 $return .= '</span>'; 318 319 //restore page ID 320 $ID = $oldID; 321 return $return; 322 } 323 324 /** 325 * Prepare user name string. 326 * 327 * @param string $username 328 * @param string $displaytype - one of 'user', 'real', 'none' 329 * @return string 330 */ 331 private function _prepUsername($username, $displaytype) { 332 333 switch ($displaytype) { 334 case "real": 335 global $auth; 336 $username = $auth->getUserData($username)['name']; 337 break; 338 case "none": 339 $username=""; 340 break; 341 case "user": 342 default: 343 break; 344 } 345 346 return $username; 347 } 348 349 /** 350 * Generate links from our Actions if necessary. 351 * 352 * @param Doku_Renderer_xhtml $renderer 353 * @param string $pagename 354 * @param string $name 355 * @return string 356 */ 357 private function _createLink($renderer, $pagename, $name = NULL) { 358 $id = $this->_composePageid($pagename); 359 360 return $renderer->internallink($id, $name, null, true); 361 } 362 363 /** 364 * Compose the pageid of the pages linked by a todoitem 365 * 366 * @param string $pagename 367 * @return string page id 368 */ 369 private function _composePageid($pagename) { 370 #Get the ActionNamespace and make sure it ends with a : (if not, add it) 371 $actionNamespace = $this->getConf("ActionNamespace"); 372 if(strlen($actionNamespace) == 0 || substr($actionNamespace, -1) != ':') { 373 $actionNamespace .= ":"; 374 } 375 376 #Replace ':' in $pagename so we don't create unnecessary namespaces 377 $pagename = str_replace(':', '-', $pagename); 378 379 //resolve and build link 380 $id = $actionNamespace . $pagename; 381 return $id; 382 } 383 384 /** 385 * @brief this function can be called by dokuwiki plugin searchpattern to process the todos found by searchpattern. 386 * use this searchpattern expression for open todos: 387 * ~~SEARCHPATTERN#'/<todo[^#>]*>.*?<\/todo[\W]*?>/'?? _ToDo ??~~ 388 * use this searchpattern expression for completed todos: 389 * ~~SEARCHPATTERN#'/<todo[^#>]*#[^>]*>.*?<\/todo[\W]*?>/'?? _ToDo ??~~ 390 * this handler method uses the table and layout with css classes from searchpattern plugin 391 * 392 * @param $type string type of the request from searchpattern plugin 393 * (wholeoutput, intable:whole, intable:prefix, intable:match, intable:count, intable:suffix) 394 * wholeoutput = all output is done by THIS plugin (no output will be done by search pattern) 395 * intable:whole = the left side of table (page name) is done by searchpattern, the right side 396 * of the table will be done by THIS plugin 397 * intable:prefix = on the right side of table - THIS plugin will output a prefix header and 398 * searchpattern will continue it's default output 399 * intable:match = if regex, right side of table - THIS plugin will format the current 400 * outputvalue ($value) and output it instead of searchpattern 401 * intable:count = if normal, right side of table - THIS plugin will format the current 402 * outputvalue ($value) and output it instead of searchpattern 403 * intable:suffix = on the right side of table - THIS plugin will output a suffix footer and 404 * searchpattern will continue it's default output 405 * @param Doku_Renderer_xhtml $renderer current rendering object (use $renderer->doc .= 'text' to output text) 406 * @param array $data whole data multidemensional array( array( $page => $countOfMatches ), ... ) 407 * @param array $matches whole regex matches multidemensional array( array( 0 => '1st Match', 1 => '2nd Match', ... ), ... ) 408 * @param string $page id of current page 409 * @param array $params the parameters set by searchpattern (see search pattern documentation) 410 * @param string $value value which should be outputted by searchpattern 411 * @return bool true if THIS method is responsible for the output (using $renderer->doc) OR false if searchpattern should output it's default 412 */ 413 public function _searchpatternHandler($type, $renderer, $data, $matches, $params = array(), $page = null, $value = null) { 414 $renderer->nocache(); 415 416 $type = strtolower($type); 417 switch($type) { 418 case 'wholeoutput': 419 // $matches should hold an array with all <todo>matches</todo> or <todo #>matches</todo> 420 if(!is_array($matches)) { 421 return false; 422 } 423 //file_put_contents( dirname(__FILE__).'/debug.txt', print_r($matches,true), FILE_APPEND ); 424 //file_put_contents( dirname(__FILE__).'/debug.txt', print_r($params,true), FILE_APPEND ); 425 $renderer->doc .= '<div class="sp_main">'; 426 $renderer->doc .= '<table class="inline sp_main_table">'; //create table 427 428 foreach($matches as $page => $allTodosPerPage) { 429 $renderer->doc .= '<tr class="sp_title"><th class="sp_title" colspan="2"><a href="' . wl($page) . '">' . $page . '</a></td></tr>'; 430 //entry 0 contains all whole matches 431 foreach($allTodosPerPage[0] as $todoindex => $todomatch) { 432 $x = preg_match('%<todo([^>]*)>(.*)</[\W]*todo[\W]*>%i', $todomatch, $tododata); 433 434 if($x) { 435 list($checked, $todouser) = $this->parseTodoArgs($tododata[1]); 436 $todotitle = trim($tododata[2]); 437 if(empty($todotitle)) { 438 continue; 439 } 440 $renderer->doc .= '<tr class="sp_result"><td class="sp_page" colspan="2">'; 441 442 // in case of integration with searchpattern there is no chance to find the index of an element 443 $renderer->doc .= $this->createTodoItem($renderer, $todotitle, $todoindex, $todouser, $checked, $page, array('checkbox'=>'yes', 'username'=>'user')); 444 445 $renderer->doc .= '</td></tr>'; 446 } 447 } 448 } 449 $renderer->doc .= '</table>'; //end table 450 $renderer->doc .= '</div>'; 451 // true means, that this handler method does the output (searchpattern plugin has nothing to do) 452 return true; 453 break; 454 case 'intable:whole': 455 break; 456 case 'intable:prefix': 457 //$renderer->doc .= '<b>Start on Page '.$page.'</b>'; 458 break; 459 case 'intable:match': 460 //$renderer->doc .= 'regex match on page '.$page.': <pre>'.$value.'</pre>'; 461 break; 462 case 'intable:count': 463 //$renderer->doc .= 'normal count on page '.$page.': <pre>'.$value.'</pre>'; 464 break; 465 case 'intable:suffix': 466 //$renderer->doc .= '<b>End on Page '.$page.'</b>'; 467 break; 468 default: 469 break; 470 } 471 // false means, that this handler method does not output anything. all should be done by searchpattern plugin 472 return false; 473 } 474} 475 476//Setup VIM: ex: et ts=4 enc=utf-8 : 477