1<?php 2/** 3 * DokuWiki Plugin todo_list (Syntax Component) 4 * 5 * @license GPL 2 http://www.gnu.org/licenses/gpl-2.0.html 6 */ 7 8// must be run within Dokuwiki 9if(!defined('DOKU_INC')) die(); 10 11/** 12 * Class syntax_plugin_todo_list 13 */ 14class syntax_plugin_todo_list extends syntax_plugin_todo_todo { 15 16 /** 17 * @return string Syntax mode type 18 */ 19 public function getType() { 20 return 'substition'; 21 } 22 23 /** 24 * @return string Paragraph type 25 */ 26 public function getPType() { 27 return 'block'; 28 } 29 30 /** 31 * @return int Sort order - Low numbers go before high numbers 32 */ 33 public function getSort() { 34 return 250; 35 } 36 37 /** 38 * Connect lookup pattern to lexer. 39 * 40 * @param string $mode Parser mode 41 */ 42 public function connectTo($mode) { 43 $this->Lexer->addSpecialPattern('~~TODOLIST[^~]*~~', $mode, 'plugin_todo_list'); 44 } 45 46 /** 47 * Handle matches of the todolist syntax 48 * 49 * @param string $match The match of the syntax 50 * @param int $state The state of the handler 51 * @param int $pos The position in the document 52 * @param Doku_Handler $handler The handler 53 * @return array Data for the renderer 54 */ 55 public function handle($match, $state, $pos, Doku_Handler &$handler) { 56 57 $options = substr($match, 10, -2); // strip markup 58 $options = explode(' ', $options); 59 $data = array( 60 'header' => $this->getConf("Header"), 61 'completed' => 'all', 62 'assigned' => 'all', 63 'completeduserlist' => 'all', 64 'ns' => 'all', 65 'showdate' => $this->getConf("ShowdateList"), 66 'checkbox' => $this->getConf("Checkbox"), 67 'username' => $this->getConf("Username"), 68 ); 69 $allowedvalues = array('yes', 'no'); 70 foreach($options as $option) { 71 @list($key, $value) = explode(':', $option, 2); 72 switch($key) { 73 case 'header': // how should the header be rendered? 74 if(in_array($value, array('id', 'firstheader', 'none'))) { 75 $data['header'] = $value; 76 } 77 break; 78 case 'showdate': 79 if(in_array($value, $allowedvalues)) { 80 $data['showdate'] = ($value == 'yes'); 81 } 82 break; 83 case 'checkbox': // should checkbox be rendered? 84 if(in_array($value, $allowedvalues)) { 85 $data['checkbox'] = ($value == 'yes'); 86 } 87 break; 88 case 'completed': 89 if(in_array($value, $allowedvalues)) { 90 $data['completed'] = ($value == 'yes'); 91 } 92 break; 93 case 'username': // how should the username be rendered? 94 if(in_array($value, array('user', 'real', 'none'))) { 95 $data['username'] = $value; 96 } 97 break; 98 case 'assigned': 99 if(in_array($value, $allowedvalues)) { 100 $data['assigned'] = ($value == 'yes'); 101 break; 102 } 103 //assigned? 104 $data['assigned'] = explode(',', $value); 105 // @date 20140317 le: if check for logged in user, also check for logged in user email address 106 if( in_array( '@@USER@@', $data['assigned'] ) ) { 107 $data['assigned'][] = '@@MAIL@@'; 108 } 109 $data['assigned'] = array_map( array($this,"__todolistTrimUser"), $data['assigned'] ); 110 break; 111 case 'completeduser': 112 $data['completeduserlist'] = explode(',', $value); 113 // @date 20140317 le: if check for logged in user, also check for logged in user email address 114 if(in_array('@@USER@@', $data['completeduserlist'])) { 115 $data['completeduserlist'][] = '@@MAIL@@'; 116 } 117 $data['completeduserlist'] = array_map( array($this,"__todolistTrimUser"), $data['completeduserlist'] ); 118 break; 119 case 'ns': 120 $data['ns'] = $value; 121 break; 122 case 'startbefore': 123 list($data['startbefore'], $data['startignore']) = $this->analyseDate($value); 124 break; 125 case 'startafter': 126 list($data['startafter'], $data['startignore']) = $this->analyseDate($value); 127 break; 128 case 'duebefore': 129 list($data['duebefore'], $data['dueignore']) = $this->analyseDate($value); 130 break; 131 case 'dueafter': 132 list($data['dueafter'], $data['dueignore']) = $this->analyseDate($value); 133 break; 134 case 'completedbefore': 135 $data['completedbefore'] = $this->analyseDate($value)[0]; 136 break; 137 case 'completedafter': 138 $data['completedafter'] = $this->analyseDate($value)[0]; 139 break; 140 } 141 } 142 return $data; 143 } 144 145 /** 146 * Render xhtml output or metadata 147 * 148 * @param string $mode Renderer mode (supported modes: xhtml) 149 * @param Doku_Renderer $renderer The renderer 150 * @param array $data The data from the handler() function 151 * @return bool If rendering was successful. 152 */ 153 public function render($mode, Doku_Renderer &$renderer, $data) { 154 global $conf; 155 156 if($mode != 'xhtml') return false; 157 /** @var Doku_Renderer_xhtml $renderer */ 158 159 $opts['pattern'] = '/<todo([^>]*)>(.*)<\/todo[\W]*?>/'; //all todos in a wiki page 160 $opts['ns'] = $data['ns']; 161 //TODO check if storing subpatterns doesn't cost too much resources 162 163 // search(&$data, $base, $func, $opts,$dir='',$lvl=1,$sort='natural') 164 search($todopages, $conf['datadir'], array($this, 'search_todos'), $opts); //browse wiki pages with callback to search_pattern 165 166 $todopages = $this->filterpages($todopages, $data); 167 168 $this->htmlTodoTable($renderer, $todopages, $data); 169 170 return true; 171 } 172 173 /** 174 * Custom search callback 175 * 176 * This function is called for every found file or 177 * directory. When a directory is given to the function it has to 178 * decide if this directory should be traversed (true) or not (false). 179 * Return values for files are ignored 180 * 181 * All functions should check the ACL for document READ rights 182 * namespaces (directories) are NOT checked (when sneaky_index is 0) as this 183 * would break the recursion (You can have an nonreadable dir over a readable 184 * one deeper nested) also make sure to check the file type (for example 185 * in case of lockfiles). 186 * 187 * @param array &$data - Reference to the result data structure 188 * @param string $base - Base usually $conf['datadir'] 189 * @param string $file - current file or directory relative to $base 190 * @param string $type - Type either 'd' for directory or 'f' for file 191 * @param int $lvl - Current recursion depht 192 * @param array $opts - option array as given to search() 193 * @return bool if this directory should be traversed (true) or not (false). Return values for files are ignored. 194 */ 195 public function search_todos(&$data, $base, $file, $type, $lvl, $opts) { 196 $item['id'] = pathID($file); //get current file ID 197 198 //we do nothing with directories 199 if($type == 'd') return true; 200 201 //only search txt files 202 if(substr($file, -4) != '.txt') return true; 203 204 //check ACL 205 if(auth_quickaclcheck($item['id']) < AUTH_READ) return false; 206 207 // filter namespaces 208 if(!$this->filter_ns($item['id'], $opts['ns'])) return false; 209 210 $wikitext = rawWiki($item['id']); //get wiki text 211 212 $item['count'] = preg_match_all($opts['pattern'], $wikitext, $matches); //count how many times appears the pattern 213 if(!empty($item['count'])) { //if it appears at least once 214 $item['matches'] = $matches; 215 $data[] = $item; 216 } 217 return true; 218 } 219 220 /** 221 * filter namespaces 222 * 223 * @param $todopages array pages with all todoitems 224 * @param $item string listing parameters 225 * @return boolean if item id is in namespace 226 */ 227 private function filter_ns($item, $ns) { 228 global $ID; 229 // check if we should accept currant namespace+subnamespaces or only subnamespaces 230 $wildsubns = substr($ns, -2) == '.:'; 231 $onlysubns = !$wildsubns && (substr($ns, -1) == ':' || substr($ns, -2) == ':.'); 232// $onlyns = $onlysubns && substr($ns, -1) == '.'; 233 234 // if first char of ns is '.'replace it with current ns 235 if ($ns[0] == '.') { 236 $ns = substr($ID, 0, strrpos($ID, ':')+1).ltrim($ns, '.:'); 237 } 238 $ns = trim($ns, '.:'); 239 $len = strlen($ns); 240 $parsepage = false; 241 242 if ($parsepage = $ns == 'all') { 243 // Always return the todo pages 244 } elseif ($ns == '/') { 245 // Only return the todo page if it's in the root namespace 246 $parsepage = strpos($item, ':') === FALSE; 247 } elseif ($wildsubns) { 248 $p = strpos($item.':', ':', $len+1); 249 $x = substr($item, $len+1, $p-$len); 250 $parsepage = 0 === strpos($item, rtrim($ns.':'.$x, ':').':'); 251 } elseif ($onlysubns) { 252 $parsepage = 0 === strpos($item, $ns.':'); 253 } elseif ($parsepage = substr($item, 0, $len) == $ns) { 254 } 255 return $parsepage; 256 } 257 258 /** 259 * Expand assignee-placeholders 260 * 261 * @param $user String to be worked on 262 * @return expanded string 263 */ 264 private function __todolistExpandAssignees($user) { 265 global $USERINFO; 266 if($user == '@@USER@@' && !empty($_SERVER['REMOTE_USER'])) { //$INPUT->server->str('REMOTE_USER') 267 return $_SERVER['REMOTE_USER']; 268 } 269 // @date 20140317 le: check for logged in user email address 270 if( $user == '@@MAIL@@' && isset( $USERINFO['mail'] ) ) { 271 return $USERINFO['mail']; 272 } 273 return $user; 274 } 275 276 /** 277 * Trim input if it's a user 278 * 279 * @param $user String to be worked on 280 * @return trimmed string 281 */ 282 private function __todolistTrimUser($user) { 283 //placeholder (inspired by replacement-patterns - see https://www.dokuwiki.org/namespace_templates#replacement_patterns) 284 if( $user == '@@USER@@' || $user == '@@MAIL@@' ) { 285 return $user; 286 } 287 //user 288 return trim(ltrim($user, '@')); 289 } 290 291 /** 292 * filter the pages 293 * 294 * @param $todopages array pages with all todoitems 295 * @param $data array listing parameters 296 * @return array filtered pages 297 */ 298 private function filterpages($todopages, $data) { 299 $pages = array(); 300 foreach($todopages as $page) { 301 $todos = array(); 302 // contains 3 arrays: an array with complete matches and 2 arrays with subpatterns 303 foreach($page['matches'][1] as $todoindex => $todomatch) { 304 $todo = array_merge(array('todotitle' => trim($page['matches'][2][$todoindex]), 'todoindex' => $todoindex), $this->parseTodoArgs($todomatch), $data); 305 306 if($this->isRequestedTodo($todo)) { $todos[] = $todo; } 307 } 308 if(count($todos) > 0) { 309 $pages[] = array('id' => $page['id'], 'todos' => $todos); 310 } 311 } 312 return $pages; 313 } 314 315 /** 316 * Create html for table with todos 317 * 318 * @param Doku_Renderer_xhtml $R 319 * @param array $todopages 320 * @param array $data array with rendering options 321 */ 322 private function htmlTodoTable($R, $todopages, $data) { 323 $R->table_open(); 324 foreach($todopages as $page) { 325 if ($data['header']!='none') { 326 $R->tablerow_open(); 327 $R->tableheader_open(); 328 $R->internallink($page['id'], ($data['header']=='firstheader' ? p_get_first_heading($page['id']) : $page['id'])); 329 $R->tableheader_close(); 330 $R->tablerow_close(); 331 } 332 foreach($page['todos'] as $todo) { 333//echo "<pre>";var_dump($todo);echo "</pre>"; 334 $R->tablerow_open(); 335 $R->tablecell_open(); 336 $R->doc .= $this->createTodoItem($R, $page['id'], array_merge($todo, $data)); 337 $R->tablecell_close(); 338 $R->tablerow_close(); 339 } 340 } 341 $R->table_close(); 342 } 343 344 /** 345 * Check the conditions for adding a todoitem 346 * 347 * @param $data array the defined filters 348 * @param $checked bool completion status of task; true: finished, false: open 349 * @param $todouser string user username of user 350 * @return bool if the todoitem should be listed 351 */ 352 /** 353 * Check the conditions for adding a todoitem 354 * 355 * @param $data array the defined filters 356 * @param $checked bool completion status of task; true: finished, false: open 357 * @param $todouser string user username of user 358 * @return bool if the todoitem should be listed 359 */ 360 private function isRequestedTodo($data) { 361 //completion status 362 $condition1 = $data['completed'] === 'all' //all 363 || $data['completed'] === $data['checked']; //yes or no 364 365 // resolve placeholder in assignees 366 $requestedassignees = array(); 367 if(is_array($data['assigned'])) { 368 $requestedassignees = array_map( array($this,"__todolistExpandAssignees"), $data['assigned'] ); 369 } 370 //assigned 371 $condition2 = $condition2 372 || $data['assigned'] === 'all' //all 373 || (is_bool($data['assigned']) && $data['assigned'] == $data['todouser']); //yes or no 374 375 if (!$condition2 && is_array($data['assigned']) && is_array($data['todousers'])) 376 foreach($data['todousers'] as $todouser) { 377 if(in_array($todouser, $requestedassignees)) { $condition2 = true; break; } 378 } 379 380 //completed by 381 if($condition2 && is_array($data['completeduserlist'])) 382 $condition2 = in_array($data['completeduser'], $data['completeduserlist']); 383 384 //compare start/due dates 385 if($condition1 && $condition2) { 386 $condition3s = true; $condition3d = true; 387 if(isset($data['startbefore']) || isset($data['startafter'])) { 388 if(is_object($data['start'])) { 389 if($data['startignore'] != '!') { 390 if(isset($data['startbefore'])) { $condition3s = $condition3s && new DateTime($data['startbefore']) > $data['start']; } 391 if(isset($data['startafter'])) { $condition3s = $condition3s && new DateTime($data['startafter']) < $data['start']; } 392 } 393 } else { 394 if(!$data['startignore'] == '*') { $condition3s = false; } 395 if($data['startignore'] == '!') { $condition3s = false; } 396 } 397 } 398 399 if(isset($data['duebefore']) || isset($data['dueafter'])) { 400 if(is_object($data['due'])) { 401 if($data['dueignore'] != '!') { 402 if(isset($data['duebefore'])) { $condition3d = $condition3d && new DateTime($data['duebefore']) > $data['due']; } 403 if(isset($data['dueafter'])) { $condition3d = $condition3d && new DateTime($data['dueafter']) < $data['due']; } 404 } 405 } else { 406 if(!$data['dueignore'] == '*') { $condition3d = false; } 407 if($data['dueignore'] == '!') { $condition3d = false; } 408 } 409 } 410 $condition3 = $condition3s && $condition3d; 411 } 412 413 // compare completed date 414 $condition4 = true; 415 if(isset($data['completedbefore'])) { 416 $condition4 = $condition4 && new DateTime($data['completedbefore']) > $data['completeddate']; 417 } 418 if(isset($data['completedafter'])) { 419 $condition4 = $condition4 && new DateTime($data['completedafter']) < $data['completeddate']; 420 } 421 422 return $condition1 AND $condition2 AND $condition3 AND $condition4; 423 } 424 425 426 /** 427 * Analyse of relative/absolute Date and return an absolute date 428 * 429 * @param $date string absolute/relative value of the date to analyse 430 * @return array absolute date or actual date if $date is invalid 431 */ 432 private function analyseDate($date) { 433 $result = array($date, ''); 434 if(is_string($date)) { 435 if($date == '!') { 436 $result = array('', '!'); 437 } elseif ($date =='*') { 438 $result = array('', '*'); 439 } else { 440 if(substr($date, -1) == '*') { 441 $date = substr($date, 0, -1); 442 $result = array($date, '*'); 443 } 444 445 if(date('Y-m-d', strtotime($date)) == $date) { 446 $result[0] = $date; 447 } elseif(preg_match('/^[\+\-]\d+$/', $date)) { // check if we have a valid relative value 448 $newdate = date_create(date('Y-m-d')); 449 date_modify($newdate, $date . ' day'); 450 $result[0] = date_format($newdate, 'Y-m-d'); 451 } else { 452 $result[0] = date('Y-m-d'); 453 } 454 } 455 } else { $result[0] = date('Y-m-d'); } 456 457 return $result; 458 } 459 460 461} 462