Name of Action - * Creates a Checkbox with the "Name of Action" as * the text associated with it. The hash (#, optional) * will cause the checkbox to be checked by default. * The @ sign followed by a username can be used to assign this todo to a user. * examples: * A todo without user assignment * Something todo * A completed todo without user assignment * Completed todo * A todo assigned to user User * Something todo for Leo * A completed todo assigned to user User * Todo completed for Leo * * In combination with dokuwiki searchpattern plugin version (at least v20130408), * it is a lightweight solution for a task management system based on dokuwiki. * use this searchpattern expression for open todos: * ~~SEARCHPATTERN#'/]*>.*?<\/todo[\W]*?>/'?? _ToDo ??~~ * use this searchpattern expression for completed todos: * ~~SEARCHPATTERN#'/]*#[^>]*>.*?<\/todo[\W]*?>/'?? _ToDo ??~~ * do not forget the no-cache option * ~~NOCACHE~~ * * Compatibility: * Release 2013-03-06 "Weatherwax RC1" * Release 2012-10-13 "Adora Belle" * * @license GPL 2 (http://www.gnu.org/licenses/gpl.html) * @author Babbage ; Leo Eibler */ /** * ChangeLog: * ** [04/13/2013]: by Leo Eibler / http://www.eibler.at ** bugfix: config option Strikethrough * [04/11/2013]: by Leo Eibler / http://www.eibler.at * bugfix: encoding html code (security risk ) - bug reported by Andreas * bugfix: use correct tag if there are more than 1 in the same line. * [04/08/2013]: by Leo Eibler / http://www.eibler.at * migrate changes made by Christian Marg to current version of plugin * [04/08/2013]: by Christian Marg * changed behaviour - when multiple todo-items have the same text, only the clicked one is checked. * [04/08/2013]: by Leo Eibler / http://www.eibler.at * add description / comments and syntax howto about integration with searchpattern * check compatibility with dokuwiki release 2012-10-13 "Adora Belle" * remove getInfo() call because it's done by plugin.info.txt (since dokuwiki 2009-12-25 "Lemming") * [04/07/2013]: by Leo Eibler / http://www.eibler.at * add handler method _searchpatternHandler() for dokuwiki searchpattern extension. * add user assignment for todos (with @username syntax in todo tag e.g. do something) * [04/05/2013]: by Leo Eibler / http://www.eibler.at * upgrade plugin to work with newest version of dokuwiki (tested version Release 2013-03-06 Weatherwax RC1). * [08/16/2010]: Fixed another bug where javascript would not decode the action * text properly (replaced unescape with decodeURIComponent). * [04/03/2010]: Fixed a bug where javascript would not decode the action text * properly. * [03/31/2010]: Fixed a bug where checking or unchecking an action whose text * appeared outside of the todo tags, would result in mangling the * code on your page. Also added support for using the ampersand * character (&) and html entities inside of your todo action. * [02/27/2010]: Created an action plugin to insert a ToDo button into the * editor toolbar. * [10/14/2009]: Added the feature so that if you have Links turned off and you * click on the text of an action, it will check that action off. * Thanks to Tero for the suggestion! (Plugin Option: CheckboxText) * [10/08/2009]: I am no longer using the short open php tag ('substition' (i.e. 'substitution'). * @public * @static */ public function getType() { return 'substition'; } /** * What kind of syntax do we allow (optional) */ // function getAllowedTypes() { //return array('formatting', 'substition', 'disabled');; // } /** * Define how this plugin is handled regarding paragraphs. * *

* This method is important for correct XHTML nesting. It returns * one of the following values: *

*
*
normal
The plugin can be used inside paragraphs.
*
block
Open paragraphs need to be closed before * plugin output.
*
stack
Special case: Plugin wraps other paragraphs.
*
* @param none * @return String 'block'. * @public * @static */ // function getPType(){ // return 'normal'; // } /** * Where to sort in? * * @param none * @return Integer 6. * @public * @static */ public function getSort() { return 999; } /** * Connect lookup pattern to lexer. * * @param $mode String The desired rendermode. * @return void * @public * @see render() */ public function connectTo($mode) { $this->Lexer->addEntryPattern('(?=.*?)', $mode, 'plugin_todo_todo'); } public function postConnect() { $this->Lexer->addExitPattern('', 'plugin_todo_todo'); } /** * Handler to prepare matched data for the rendering process. * *

* The $aState parameter gives the type of pattern * which triggered the call to this method: *

*
*
DOKU_LEXER_ENTER
*
a pattern set by addEntryPattern()
*
DOKU_LEXER_MATCHED
*
a pattern set by addPattern()
*
DOKU_LEXER_EXIT
*
a pattern set by addExitPattern()
*
DOKU_LEXER_SPECIAL
*
a pattern set by addSpecialPattern()
*
DOKU_LEXER_UNMATCHED
*
ordinary text encountered within the plugin's syntax mode * which doesn't match any pattern.
*
* @param $match string The text matched by the patterns. * @param $state int The lexer state for the match. * @param $pos int The character position of the matched text. * @param &$handler Doku_Handler Reference to the Doku_Handler object. * @return int The current lexer state for the match. * @public * @see render() * @static */ public function handle($match, $state, $pos, Doku_Handler &$handler) { switch($state) { case DOKU_LEXER_ENTER : #Search to see if the '#' is in the todotag (if so, this means the Action has been completed) $x = preg_match('%]*)>%i', $match, $tododata); if($x) { list($handler->checked, $handler->todo_user) = $this->_parseTodoArgs($tododata[1]); } if(!is_numeric($handler->todo_index)) { $handler->todo_index = 0; } break; case DOKU_LEXER_MATCHED : break; case DOKU_LEXER_UNMATCHED : /** * Structure: * input(checkbox) * * - (if links is on) or (if links is off) * -- (if strikethrough is on) or --NOTHING-- * - or * */ #Make sure there is actually an action to create if(trim($match) != '') { $data = array($state, $match, $handler->todo_index, $handler->todo_user, $handler->checked); $handler->todo_index++; return $data; } break; case DOKU_LEXER_EXIT : #Delete temporary checked variable unset($handler->todo_user); unset($handler->checked); //unset($handler->todo_index); break; case DOKU_LEXER_SPECIAL : break; } return array(); } /** * Handle the actual output creation. * *

* The method checks for the given $aFormat and returns * FALSE when a format isn't supported. $aRenderer * contains a reference to the renderer object which is currently * handling the rendering. The contents of $aData is the * return value of the handle() method. *

* @param $mode String The output format to generate. * @param &$renderer Doku_Renderer A reference to the renderer object. * @param $data Array The data created by the handle() method. * @return Boolean * TRUE if rendered successfully, or * FALSE otherwise. * @public * @see handle() */ public function render($mode, Doku_Renderer &$renderer, $data) { global $ID; list($state, $todotitle, $todoindex, $todouser, $checked) = $data; if($mode == 'xhtml') { /** @var $renderer Doku_Renderer_xhtml */ if($state == DOKU_LEXER_UNMATCHED) { #Output our result $renderer->doc .= $this->_createTodoItem($renderer, $todotitle, $todoindex, $todouser, $checked, $ID); return true; } } elseif($mode == 'metadata') { /** @var $renderer Doku_Renderer_metadata */ if($state == DOKU_LEXER_UNMATCHED) { $id = $this->_composePageid($todotitle); $renderer->internallink($id, $todotitle); } } return false; } /** * Parse the arguments of todotag * * @param string $todoargs * @return array(bool, false|string) with checked and user */ public function _parseTodoArgs($todoargs) { $checked = $todouser = false; if(strpos($todoargs, '#') !== false) { $checked = true; } if(($userStartPos = strpos($todoargs, '@')) !== false) { $userraw = substr($todoargs, $userStartPos); $x = preg_match('%@([-.\w]+)%i', $userraw, $usermatch); if($x) { $todouser = $usermatch[1]; } } return array($checked, $todouser); } /** * @param Doku_Renderer_xhtml &$renderer * @param string $todotitle Title of todoitem * @param int $todoindex which number the todoitem has, null is when not at the page * @param string $todouser User assigned to todoitem * @param bool $checked whether item is done * @param string $id of page * @return string html of an item */ public function _createTodoItem(&$renderer, $todotitle, $todoindex, $todouser, $checked, $id) { //set correct context global $ID; $oldID = $ID; $ID = $id; $return = ' '; if($todouser) { $return .= '[' . hsc($todouser) . ']'; } $spanclass = 'todotext'; if($this->getConf("CheckboxText") && !$this->getConf("AllowLinks")) { $spanclass .= ' clickabletodo todohlght'; } $return .= ''; if($checked && $this->getConf("Strikethrough")) { $return .= ''; } $return .= ''; if($this->getConf("AllowLinks")) { $return .= $this->_createLink($renderer, $todotitle, $todotitle); } else { $return .= hsc($todotitle); } $return .= ''; if($checked && $this->getConf("Strikethrough")) { $return .= ''; } $return .= ''; //restore page ID $ID = $oldID; return $return; } /** * Generate links from our Actions if necessary. * * @param Doku_Renderer_xhtml &$renderer * @param string $pagename * @param string $name * @return string */ private function _createLink(&$renderer, $pagename, $name = NULL) { $id = $this->_composePageid($pagename); return $renderer->internallink($id, $name, null, true); } /** * Compose the pageid of the pages linked by a todoitem * * @param string $pagename * @return string page id */ private function _composePageid($pagename) { #Get the ActionNamespace and make sure it ends with a : (if not, add it) $actionNamespace = $this->getConf("ActionNamespace"); if(strlen($actionNamespace) == 0 || substr($actionNamespace, -1) != ':') { $actionNamespace .= ":"; } #Replace ':' in $pagename so we don't create unnecessary namespaces $pagename = str_replace(':', '-', $pagename); //resolve and build link $id = $actionNamespace . $pagename; return $id; } /** * @brief this function can be called by dokuwiki plugin searchpattern to process the todos found by searchpattern. * use this searchpattern expression for open todos: * ~~SEARCHPATTERN#'/]*>.*?<\/todo[\W]*?>/'?? _ToDo ??~~ * use this searchpattern expression for completed todos: * ~~SEARCHPATTERN#'/]*#[^>]*>.*?<\/todo[\W]*?>/'?? _ToDo ??~~ * this handler method uses the table and layout with css classes from searchpattern plugin * * @param $type string type of the request from searchpattern plugin * (wholeoutput, intable:whole, intable:prefix, intable:match, intable:count, intable:suffix) * wholeoutput = all output is done by THIS plugin (no output will be done by search pattern) * intable:whole = the left side of table (page name) is done by searchpattern, the right side * of the table will be done by THIS plugin * intable:prefix = on the right side of table - THIS plugin will output a prefix header and * searchpattern will continue it's default output * intable:match = if regex, right side of table - THIS plugin will format the current * outputvalue ($value) and output it instead of searchpattern * intable:count = if normal, right side of table - THIS plugin will format the current * outputvalue ($value) and output it instead of searchpattern * intable:suffix = on the right side of table - THIS plugin will output a suffix footer and * searchpattern will continue it's default output * @param Doku_Renderer_xhtml &$renderer current rendering object (use $renderer->doc .= 'text' to output text) * @param array $data whole data multidemensional array( array( $page => $countOfMatches ), ... ) * @param array $matches whole regex matches multidemensional array( array( 0 => '1st Match', 1 => '2nd Match', ... ), ... ) * @param string $page id of current page * @param array $params the parameters set by searchpattern (see search pattern documentation) * @param string $value value which should be outputted by searchpattern * @return bool true if THIS method is responsible for the output (using $renderer->doc) OR false if searchpattern should output it's default */ public function _searchpatternHandler($type, &$renderer, $data, $matches, $params = array(), $page = null, $value = null) { $renderer->nocache(); $type = strtolower($type); switch($type) { case 'wholeoutput': // $matches should hold an array with all matches or matches if(!is_array($matches)) { return false; } //file_put_contents( dirname(__FILE__).'/debug.txt', print_r($matches,true), FILE_APPEND ); //file_put_contents( dirname(__FILE__).'/debug.txt', print_r($params,true), FILE_APPEND ); $renderer->doc .= '
'; $renderer->doc .= ''; //create table foreach($matches as $page => $allTodosPerPage) { $renderer->doc .= ''; //entry 0 contains all whole matches foreach($allTodosPerPage[0] as $todoindex => $todomatch) { $x = preg_match('%]*)>(.*)%i', $todomatch, $tododata); if($x) { list($checked, $todouser) = $this->_parseTodoArgs($tododata[1]); $todotitle = trim($tododata[2]); if(empty($todotitle)) { continue; } $renderer->doc .= ''; } } } $renderer->doc .= '
' . $page . '
'; // in case of integration with searchpattern there is no chance to find the index of an element $renderer->doc .= $this->_createTodoItem($renderer, $todotitle, $todoindex, $todouser, $checked, $page); $renderer->doc .= '
'; //end table $renderer->doc .= '
'; // true means, that this handler method does the output (searchpattern plugin has nothing to do) return true; break; case 'intable:whole': break; case 'intable:prefix': //$renderer->doc .= 'Start on Page '.$page.''; break; case 'intable:match': //$renderer->doc .= 'regex match on page '.$page.': 
'.$value.'
'; break; case 'intable:count': //$renderer->doc .= 'normal count on page '.$page.': 
'.$value.'
'; break; case 'intable:suffix': //$renderer->doc .= 'End on Page '.$page.''; break; default: break; } // false means, that this handler method does not output anything. all should be done by searchpattern plugin return false; } } //Setup VIM: ex: et ts=4 enc=utf-8 :