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 //TODO check if storing subpatterns doesn't cost too much resources 161 162 // search(&$data, $base, $func, $opts,$dir='',$lvl=1,$sort='natural') 163 search($todopages, $conf['datadir'], array($this, 'search_todos'), $opts); //browse wiki pages with callback to search_pattern 164 165 $todopages = $this->filterpages($todopages, $data); 166 167 $this->htmlTodoTable($renderer, $todopages, $data); 168 169 return true; 170 } 171 172 /** 173 * Custom search callback 174 * 175 * This function is called for every found file or 176 * directory. When a directory is given to the function it has to 177 * decide if this directory should be traversed (true) or not (false). 178 * Return values for files are ignored 179 * 180 * All functions should check the ACL for document READ rights 181 * namespaces (directories) are NOT checked (when sneaky_index is 0) as this 182 * would break the recursion (You can have an nonreadable dir over a readable 183 * one deeper nested) also make sure to check the file type (for example 184 * in case of lockfiles). 185 * 186 * @param array &$data - Reference to the result data structure 187 * @param string $base - Base usually $conf['datadir'] 188 * @param string $file - current file or directory relative to $base 189 * @param string $type - Type either 'd' for directory or 'f' for file 190 * @param int $lvl - Current recursion depht 191 * @param array $opts - option array as given to search() 192 * @return bool if this directory should be traversed (true) or not (false). Return values for files are ignored. 193 */ 194 public function search_todos(&$data, $base, $file, $type, $lvl, $opts) { 195 $item['id'] = pathID($file); //get current file ID 196 197 //we do nothing with directories 198 if($type == 'd') return true; 199 200 //only search txt files 201 if(substr($file, -4) != '.txt') return true; 202 203 //check ACL 204 if(auth_quickaclcheck($item['id']) < AUTH_READ) return false; 205 206 $wikitext = rawWiki($item['id']); //get wiki text 207 208 $item['count'] = preg_match_all($opts['pattern'], $wikitext, $matches); //count how many times appears the pattern 209 if(!empty($item['count'])) { //if it appears at least once 210 $item['matches'] = $matches; 211 $data[] = $item; 212 } 213 return true; 214 } 215 216 /** 217 * Expand assignee-placeholders 218 * 219 * @param $user String to be worked on 220 * @return expanded string 221 */ 222 private function __todolistExpandAssignees($user) { 223 global $USERINFO; 224 if($user == '@@USER@@' && !empty($_SERVER['REMOTE_USER'])) { //$INPUT->server->str('REMOTE_USER') 225 return $_SERVER['REMOTE_USER']; 226 } 227 // @date 20140317 le: check for logged in user email address 228 if( $user == '@@MAIL@@' && isset( $USERINFO['mail'] ) ) { 229 return $USERINFO['mail']; 230 } 231 return $user; 232 } 233 234 /** 235 * Trim input if it's a user 236 * 237 * @param $user String to be worked on 238 * @return trimmed string 239 */ 240 private function __todolistTrimUser($user) { 241 //placeholder (inspired by replacement-patterns - see https://www.dokuwiki.org/namespace_templates#replacement_patterns) 242 if( $user == '@@USER@@' || $user == '@@MAIL@@' ) { 243 return $user; 244 } 245 //user 246 return trim(ltrim($user, '@')); 247 } 248 249 /** 250 * filter the pages 251 * 252 * @param $todopages array pages with all todoitems 253 * @param $data array listing parameters 254 * @return array filtered pages 255 */ 256 private function filterpages($todopages, $data) { 257 global $ID; 258 $pages = array(); 259 if ($data['ns'][0] == '.') { 260 if(substr($data['ns'], -1) == ':') { 261 $data['ns'] = substr($ID, 0, strrpos($ID, ':')).':'.substr($data['ns'], 1); 262 } else { 263 $data['ns'] = rtrim(substr($ID, 0, strrpos($ID, ':')).':'.substr($data['ns'], 1), ':'); 264 } 265 $data['ns'] = str_replace('::', ':', $data['ns']); 266 } 267 268 foreach($todopages as $page) { 269 $parsepage = 0; 270 if ($data['ns'] == 'all') { 271 // Always return the todo pages 272 $parsepage = 1; 273 } elseif ($data['ns'] == '/') { 274 // Only return the todo page if it's in the root namespace 275 if (strpos($page['id'], ':') === FALSE) $parsepage = 1; 276 } elseif (strlen($page['id']) > strlen($data['ns']) && substr($data['ns'], -1) == ':') { 277 // Only return the todo page if it's in the namespace of the actual page 278 if (substr($page['id'], 0, strlen($data['ns'])) === $data['ns'] && $page['id'] != $ID) { 279 $parsepage = 1; 280 } 281 } elseif (substr( $page['id'], 0, strlen($data['ns']) ) === $data['ns']) { 282 // Only return the todo page if it starts with the given string 283 $parsepage = 1; 284 } 285 if ($parsepage == 1) { 286 $todos = array(); 287 // contains 3 arrays: an array with complete matches and 2 arrays with subpatterns 288 foreach($page['matches'][1] as $todoindex => $todomatch) { 289 $todo = array_merge(array('todotitle' => trim($page['matches'][2][$todoindex]), 'todoindex' => $todoindex), $this->parseTodoArgs($todomatch), $data); 290 291 if($this->isRequestedTodo($todo)) { $todos[] = $todo; } 292 } 293 if(count($todos) > 0) { 294 $pages[] = array('id' => $page['id'], 'todos' => $todos); 295 } 296 } 297 } 298 return $pages; 299 } 300 301 302 /** 303 * Create html for table with todos 304 * 305 * @param Doku_Renderer_xhtml $R 306 * @param array $todopages 307 * @param array $data array with rendering options 308 */ 309 private function htmlTodoTable($R, $todopages, $data) { 310 $R->table_open(); 311 foreach($todopages as $page) { 312 if ($data['header']!='none') { 313 $R->tablerow_open(); 314 $R->tableheader_open(); 315 $R->internallink($page['id'], ($data['header']=='firstheader' ? p_get_first_heading($page['id']) : $page['id'])); 316 $R->tableheader_close(); 317 $R->tablerow_close(); 318 } 319 foreach($page['todos'] as $todo) { 320//echo "<pre>";var_dump($todo);echo "</pre>"; 321 $R->tablerow_open(); 322 $R->tablecell_open(); 323 $R->doc .= $this->createTodoItem($R, $page['id'], array_merge($todo, $data)); 324 $R->tablecell_close(); 325 $R->tablerow_close(); 326 } 327 } 328 $R->table_close(); 329 } 330 331 /** 332 * Check the conditions for adding a todoitem 333 * 334 * @param $data array the defined filters 335 * @param $checked bool completion status of task; true: finished, false: open 336 * @param $todouser string user username of user 337 * @return bool if the todoitem should be listed 338 */ 339 /** 340 * Check the conditions for adding a todoitem 341 * 342 * @param $data array the defined filters 343 * @param $checked bool completion status of task; true: finished, false: open 344 * @param $todouser string user username of user 345 * @return bool if the todoitem should be listed 346 */ 347 private function isRequestedTodo($data) { 348 //completion status 349 $condition1 = $data['completed'] === 'all' //all 350 || $data['completed'] === $data['checked']; //yes or no 351 352 // resolve placeholder in assignees 353 $requestedassignees = array(); 354 if(is_array($data['assigned'])) { 355 $requestedassignees = array_map( array($this,"__todolistExpandAssignees"), $data['assigned'] ); 356 } 357 //assigned 358 $condition2 = $condition2 359 || $data['assigned'] === 'all' //all 360 || (is_bool($data['assigned']) && $data['assigned'] == $data['todouser']); //yes or no 361 362 if (!$condition2 && is_array($data['assigned']) && is_array($data['todousers'])) 363 foreach($data['todousers'] as $todouser) { 364 if(in_array($todouser, $requestedassignees)) { $condition2 = true; break; } 365 } 366 367 //completed by 368 if($condition2 && is_array($data['completeduserlist'])) 369 $condition2 = in_array($data['completeduser'], $data['completeduserlist']); 370 371 //compare start/due dates 372 if($condition1 && $condition2) { 373 $condition3s = true; $condition3d = true; 374 if(isset($data['startbefore']) || isset($data['startafter'])) { 375 if(is_object($data['start'])) { 376 if($data['startignore'] != '!') { 377 if(isset($data['startbefore'])) { $condition3s = $condition3s && new DateTime($data['startbefore']) > $data['start']; } 378 if(isset($data['startafter'])) { $condition3s = $condition3s && new DateTime($data['startafter']) < $data['start']; } 379 } 380 } else { 381 if(!$data['startignore'] == '*') { $condition3s = false; } 382 if($data['startignore'] == '!') { $condition3s = false; } 383 } 384 } 385 386 if(isset($data['duebefore']) || isset($data['dueafter'])) { 387 if(is_object($data['due'])) { 388 if($data['dueignore'] != '!') { 389 if(isset($data['duebefore'])) { $condition3d = $condition3d && new DateTime($data['duebefore']) > $data['due']; } 390 if(isset($data['dueafter'])) { $condition3d = $condition3d && new DateTime($data['dueafter']) < $data['due']; } 391 } 392 } else { 393 if(!$data['dueignore'] == '*') { $condition3d = false; } 394 if($data['dueignore'] == '!') { $condition3d = false; } 395 } 396 } 397 $condition3 = $condition3s && $condition3d; 398 } 399 400 // compare completed date 401 $condition4 = true; 402 if(isset($data['completedbefore'])) { 403 $condition4 = $condition4 && new DateTime($data['completedbefore']) > $data['completeddate']; 404 } 405 if(isset($data['completedafter'])) { 406 $condition4 = $condition4 && new DateTime($data['completedafter']) < $data['completeddate']; 407 } 408 409 return $condition1 AND $condition2 AND $condition3 AND $condition4; 410 } 411 412 413 /** 414 * Analyse of relative/absolute Date and return an absolute date 415 * 416 * @param $date string absolute/relative value of the date to analyse 417 * @return array absolute date or actual date if $date is invalid 418 */ 419 private function analyseDate($date) { 420 $result = array($date, ''); 421 if(is_string($date)) { 422 if($date == '!') { 423 $result = array('', '!'); 424 } elseif ($date =='*') { 425 $result = array('', '*'); 426 } else { 427 if(substr($date, -1) == '*') { 428 $date = substr($date, 0, -1); 429 $result = array($date, '*'); 430 } 431 432 if(date('Y-m-d', strtotime($date)) == $date) { 433 $result[0] = $date; 434 } elseif(preg_match('/^[\+\-]\d+$/', $date)) { // check if we have a valid relative value 435 $newdate = date_create(date('Y-m-d')); 436 date_modify($newdate, $date . ' day'); 437 $result[0] = date_format($newdate, 'Y-m-d'); 438 } else { 439 $result[0] = date('Y-m-d'); 440 } 441 } 442 } else { $result[0] = date('Y-m-d'); } 443 444 return $result; 445 } 446 447 448} 449