ics.php images/ics.gif @@ -93,7 +93,10 @@ class action_plugin_task extends DokuWiki_Action_Plugin { // save .task meta file $my =& plugin_load('helper', 'task'); $task = array( - 'user' => $user, + 'user' => array( + 'id' => $_SERVER['REMOTE_USER'], + 'name' => $INFO['userinfo']['name'], + 'mail' => $INFO['userinfo']['mail']), 'date' => array('due' => $my->_interpretDate($date)), 'priority' => strspn($priority, '!'), 'status' => $status, @@ -153,11 +156,16 @@ class action_plugin_task extends DokuWiki_Action_Plugin { // assign task to a user if (!$task['user'] && ($status == 1)){ - if (!$INFO['userinfo']['name']) return 'show'; // no name of logged in user + if (!$_SERVER['REMOTE_USER']) return 'show'; // no logged in user $wiki = rawWiki($ID); $summary = $this->getLang('mail_changedtask').': '.$this->getLang('accepted'); $new = preg_replace('/~~TASK:?/', '~~TASK:'.$INFO['userinfo']['name'], $wiki); if ($new != $wiki) saveWikiText($ID, $new, $summary, true); // save as minor edit + $task['user'] = array( + 'id' => $_SERVER['REMOTE_USER'], + 'name' => $INFO['userinfo']['name'], + 'mail' => $INFO['userinfo']['mail'], + ); } // save .task meta file and clear xhtml cache action.php @@ -139,7 +139,7 @@ class helper_plugin_task extends DokuWiki_Plugin { $result[$task['key']] = array( 'id' => $id, 'date' => $date, - 'user' => $task['user'], + 'user' => $task['user']['name'], 'status' => $this->statusLabel($task['status']), 'priority' => $task['priority'], 'perm' => $perm, @@ -161,10 +161,11 @@ class helper_plugin_task extends DokuWiki_Plugin { */ function readTask($id){ $file = metaFN($id, '.task'); - if (!@file_exists($file)){ //@remove + if (!@file_exists($file)){ $data = p_get_metadata($id, 'task'); if (is_array($data)){ $data['date'] = array('due' => $data['date']); + $data['user'] = array('name' => $data['user']); $meta = array('task' => NULL); if ($this->writeTask($id, $data)) p_set_metadata($id, $meta); } @@ -189,13 +190,15 @@ class helper_plugin_task extends DokuWiki_Plugin { unset($data['exists']); // set creation or modification time - if (!is_array($data['date'])) $data['date'] = array('due' => $data['date']); //@remove + if (!is_array($data['date'])) $data['date'] = array('due' => $data['date']); if (!@file_exists($file) || !$data['date']['created']){ $data['date']['created'] = time(); } else { $data['date']['modified'] = time(); } + if (!is_array($data['user'])) $data['user'] = array('name' => $data['user']); + if (!isset($data['status'])){ // make sure we don't overwrite status $current = unserialize(io_readFile($file, false)); $data['status'] = $current['status']; @@ -204,7 +207,7 @@ class helper_plugin_task extends DokuWiki_Plugin { } // generate vtodo for iCal file download - // $data['vtodo'] = $this->_vtodo($data); + $data['vtodo'] = $this->_vtodo($id, $data); // generate sortkey with priority and creation date $data['key'] = chr($data['priority'] + 97).(2000000000 - $data['date']['created']); @@ -260,7 +263,8 @@ class helper_plugin_task extends DokuWiki_Plugin { global $INFO; if (!$user) return false; - if (($user == $_SERVER['REMOTE_USER']) || ($user == $INFO['userinfo']['name'])) + if (($user['id'] == $_SERVER['REMOTE_USER']) + || ($user['name'] == $INFO['userinfo']['name'])) return true; return false; } @@ -329,7 +333,92 @@ class helper_plugin_task extends DokuWiki_Plugin { mail_send($to, $subject, $text, $conf['mailfrom'], '', $bcc); } - + + /** + * Generates a VTODO section for iCal file download + */ + function _vtodo($id, $task){ + if (!defined('CRLF')) define('CRLF', "\r\n"); + + $meta = p_get_metadata($id); + + $ret = 'BEGIN:VTODO'.CRLF. + 'UID:'.$id.'@'.$_SERVER['SERVER_NAME'].CRLF. + 'URL:'.wl($id, '', true, '&').CRLF. + 'SUMMARY:'.$this->_vsc($meta['title']).CRLF; + if ($meta['description']['abstract']) + $ret .= 'DESCRIPTION:'.$this->_vsc($meta['description']['abstract']).CRLF; + if ($meta['subject']) + $ret .= 'CATEGORIES:'.$this->_vcategories($meta['subject']).CRLF; + if ($task['date']['created']) + $ret .= 'CREATED:'.$this->_vdate($task['date']['created']).CRLF; + if ($task['date']['modified']) + $ret .= 'LAST-MODIFIED:'.$this->_vdate($task['date']['modified']).CRLF; + if ($task['date']['due']) + $ret .= 'DUE:'.$this->_vdate($task['date']['due']).CRLF; + if ($task['date']['completed']) + $ret .= 'COMPLETED:'.$this->_vdate($task['date']['completed']).CRLF; + if ($task['user']) $ret .= 'ORGANIZER;CN="'.$this->_vsc($task['user']['name']).'":'. + 'MAILTO:'.$task['user']['mail'].CRLF; + $ret .= 'STATUS:'.$this->_vstatus($task['status']).CRLF; + if (is_numeric($task['priority'])) + $ret .= 'PRIORITY:'.(7 - ($task['priority'] * 2)).CRLF; + $ret .= 'CLASS:'.$this->_vclass($id).CRLF. + 'END:VTODO'.CRLF; + return $ret; + } + + /** + * Encodes vCard / iCal special characters + */ + function _vsc($string){ + $search = array("\\", ",", ";", "\n", "\r"); + $replace = array("\\\\", "\\,", "\\;", "\\n", "\\n"); + return str_replace($search, $replace, $string); + } + + /** + * Generates YYYYMMDD"T"hhmmss"Z" UTC time date format (ISO 8601 / RFC 3339) + */ + function _vdate($date, $extended = false){ + $date = $date + date('Z', $date); // calculate UTC time + if ($extended) return date('Y-m-d\TH:i:s\Z', $date); + else return date('Ymd\THis\Z', $date); + } + + /** + * Returns VTODO status + */ + function _vstatus($status){ + switch ($status){ + case -1: + return 'CANCELLED'; + case 1: case 2: + return 'IN-PROCESS'; + case 3: case 4: + return 'COMPLETED'; + default: + return 'NEEDS-ACTION'; + } + } + + /** + * Returns VTODO categories + */ + function _vcategories($cat){ + if (!is_array($cat)) $cat = explode(' ', $cat); + return join(',', $this->_vsc($cat)); + } + + /** + * Returns access classification for VTODO + */ + function _vclass($id){ + global $USERINFO; // checks access rights for anonymous user + if (auth_aclcheck($id, '', $USERINFO['grps'])) return 'PUBLIC'; + else return 'PRIVATE'; + } + } //Setup VIM: ex: et ts=4 enc=utf-8 : helper.php @@ -8,18 +8,22 @@ div.dokuwiki #task__newtask_form input.edit { width: 95%; } -div.dokuwiki div.task { +div.dokuwiki div.vcalendar { margin-bottom: 1em; } -div.dokuwiki div.task fieldset { +div.dokuwiki div.vcalendar fieldset { padding: 0 0.5em 0.5em 0.5em; border: 1px solid #ffc561; width: 90%; } +div.dokuwiki div.vcalendar img.summary { + vertical-align: middle; +} + div.dokuwiki div.newtask_form table.blind, -div.dokuwiki div.task table.blind { +div.dokuwiki div.vcalendar table.blind { border: 0; padding: 0; border-spacing: 3px; @@ -27,7 +31,7 @@ div.dokuwiki div.task table.blind { } div.dokuwiki div.newtask_form table.blind th, -div.dokuwiki div.task table.blind th { +div.dokuwiki div.vcalendar table.blind th { text-align: right; color: __text_neu__; font-weight: normal; @@ -35,23 +39,24 @@ div.dokuwiki div.task table.blind th { } div.dokuwiki div.newtask_form table.blind td, -div.dokuwiki div.task table.blind td { +div.dokuwiki div.vcalendar table.blind td { width: 50%; + text-align: left; } -div.dokuwiki div.task table.blind tr.due { color: #ffa200; font-weight: bold; } -div.dokuwiki div.task table.blind tr.overdue { color: #ff0040; font-weight: bold; } +div.dokuwiki div.vcalendar table.blind tr.due { color: #ffa200; font-weight: bold; } +div.dokuwiki div.vcalendar table.blind tr.overdue { color: #ff0040; font-weight: bold; } -div.dokuwiki div.task fieldset.priority1 { background-color: #fff7e8; } -div.dokuwiki div.task fieldset.priority2 { background-color: #fff1d9; } -div.dokuwiki div.task fieldset.priority3 { background-color: #ffe9c2; } +div.dokuwiki div.vcalendar fieldset.priority1 { background-color: #fff7e8; } +div.dokuwiki div.vcalendar fieldset.priority2 { background-color: #fff1d9; } +div.dokuwiki div.vcalendar fieldset.priority3 { background-color: #ffe9c2; } div.dokuwiki tr.priority1 { background-color: #fff7e8; } div.dokuwiki tr.priority2 { background-color: #fff1d9; } div.dokuwiki tr.priority3 { background-color: #ffe9c2; } -div.dokuwiki div.task fieldset.due { border: 1px solid #ffa200; } -div.dokuwiki div.task fieldset.overdue { border: 1px solid #ff0040; } +div.dokuwiki div.vcalendar fieldset.due { border: 1px solid #ffa200; } +div.dokuwiki div.vcalendar fieldset.overdue { border: 1px solid #ff0040; } div.dokuwiki th.status, div.dokuwiki td.status { style.css @@ -11,12 +11,15 @@ if (!defined('DOKU_INC')) die(); if (!defined('DOKU_LF')) define('DOKU_LF', "\n"); if (!defined('DOKU_TAB')) define('DOKU_TAB', "\t"); -if (!defined('DOKU_PLUGIN')) define('DOKU_PLUGIN',DOKU_INC.'lib/plugins/'); +if (!defined('DOKU_PLUGIN')) define('DOKU_PLUGIN', DOKU_INC.'lib/plugins/'); require_once(DOKU_PLUGIN.'syntax.php'); class syntax_plugin_task_task extends DokuWiki_Syntax_Plugin { + var $my = NULL; + var $task = array(); + function getInfo(){ return array( 'author' => 'Esther Brunner', @@ -50,48 +53,51 @@ class syntax_plugin_task_task extends DokuWiki_Syntax_Plugin { $date = $my->_interpretDate($date); $current = $my->readTask($ID); - if (($current['user'] != $user) + if (($current['user']['name'] != $user) || ($current['date']['due'] != $date) || ($current['priority'] != $priority)){ $task = array( - 'user' => $user, - 'date' => $date, + 'user' => array('name' => $user), + 'date' => array('due' => $date), 'priority' => $priority, - ); + ); // @todo: re-check! $my->writeTask($ID, $task); } } return array($user, $date, $priority); } - function render($mode, &$renderer, $data){ - global $conf; - + function render($mode, &$renderer, $data){ list($user, $date, $priority) = $data; // XHTML output if ($mode == 'xhtml'){ - // strip time from preferred date format - $onlydate = trim($conf['dformat'], 'AaBGgHhiOTZ:'); - // prepare data + $this->_loadHelper(); $status = $this->_getStatus($user, $sn); $due = ''; if ($date && ($sn < 3)){ if ($date + 86400 < time()) $due = 'overdue'; elseif ($date < time()) $due = 'due'; } - if ($priority) $class = ' class="priority'.$priority.($due ? ' '.$due : '').'"'; - if ($due) $due = ' class="'.$due.'"'; + $class = ' class="vtodo'; + if ($priority) $class .= ' priority'.$priority; + if ($due){ + $class .= ' '.$due; + $due = ' class="'.$due.'"'; + } + $class .= '"'; // generate output - $renderer->doc .= '<div class="task">'.DOKU_LF. - '<fieldset'.$class.'>'.DOKU_LF. - DOKU_TAB.'<legend>'.$this->getLang('task').'</legend>'.DOKU_LF. + $renderer->doc .= '<div class="vcalendar">'.DOKU_LF. + '<fieldset'.$class.'>'.DOKU_LF.DOKU_TAB. + '<legend>'.$this->_icsDownload().$this->getLang('task').'</legend>'.DOKU_LF. '<table class="blind">'.DOKU_LF; - if ($user) $this->_tablerow('user', hsc($user), $renderer); - if ($date) $this->_tablerow('date', date($onlydate, $date), $renderer, $due); + if ($user) + $this->_tablerow('user', $this->_hCalUser($user), $renderer, '', 'organizer'); + if ($date) + $this->_tablerow('date', $this->_hCalDate($date), $renderer, $due); $this->_tablerow('status', $status, $renderer); $renderer->table_close(); $renderer->doc .= '</fieldset>'.DOKU_LF. @@ -108,48 +114,59 @@ class syntax_plugin_task_task extends DokuWiki_Syntax_Plugin { /** * Outputs a table row */ - function _tablerow($header, $data, &$renderer, $class = ''){ - $renderer->doc .= DOKU_TAB.'<tr'.$class.'>'.DOKU_LF.DOKU_TAB.DOKU_TAB; + function _tablerow($header, $data, &$renderer, $trclass = '', $tdclass = ''){ + if ($tdclass) $tdclass = ' class="'.$tdclass.'"'; + + $renderer->doc .= DOKU_TAB.'<tr'.$trclass.'>'.DOKU_LF.DOKU_TAB.DOKU_TAB; $renderer->tableheader_open(1, ''); - $renderer->doc .= hsc($this->getLang($header)).':'; + if ($header) $renderer->doc .= hsc($this->getLang($header)).':'; $renderer->tableheader_close(); - $renderer->tablecell_open(); - $renderer->doc .= $data; + $renderer->doc .= '<td'.$tdclass.'>'.$data; $renderer->tablecell_close(); $renderer->tablerow_close(); } /** + * Loads the helper plugin and gets task data for current ID + */ + function _loadHelper(){ + global $ID; + $this->my =& plugin_load('helper', 'task'); + if (!is_object($this->my)) return false; + $this->task = $this->my->readTask($ID); + return $true; + } + + /** * Returns the status cell contents */ function _getStatus($user, &$status){ - global $INFO, $ID; + global $INFO; $ret = ''; - - $my =& plugin_load('helper', 'task'); - $task = $my->readTask($ID); - $status = $task['status']; - $responsible = $my->_isResponsible($user); + $status = $this->task['status']; + $responsible = $this->my->_isResponsible($user); if ($INFO['perm'] == AUTH_ADMIN){ - $ret = $this->_statusMenu(array(-1, 0, 1, 2, 3, 4), $status, $my); + $ret = $this->_statusMenu(array(-1, 0, 1, 2, 3, 4), $status); } elseif ($responsible){ - if ($status < 3) $ret = $this->_statusMenu(array(-1, 0, 1, 2, 3), $status, $my); + if ($status < 3) $ret = $this->_statusMenu(array(-1, 0, 1, 2, 3), $status); } else { - if ($status == 0) $ret = $this->_statusMenu(array(0, 1), $status, $my); - elseif ($status == 3) $ret = $this->_statusMenu(array(2, 3, 4), $status, $my); + if ($status == 0) $ret = $this->_statusMenu(array(0, 1), $status); + elseif ($status == 3) $ret = $this->_statusMenu(array(2, 3, 4), $status); } - if (!$ret && $my) $ret = $my->statusLabel($status); + if (!$ret && $this->my) $ret = $this->my->statusLabel($status); - return $ret; + return '<abbr class="status" title="'.$this->my->_vstatus($status).'">'. + $ret. + '</abbr>'; } /** * Returns the XHTML for the status popup menu */ - function _statusMenu($options, $status, &$my){ + function _statusMenu($options, $status){ global $ID, $lang; $ret = '<form id="task__changetask_form" method="post" action="'.script().'" accept-charset="'.$lang['encoding'].'">'.DOKU_LF. @@ -160,7 +177,7 @@ class syntax_plugin_task_task extends DokuWiki_Syntax_Plugin { foreach ($options as $option){ $ret .= DOKU_TAB.DOKU_TAB.'<option value="'.$option.'"'; if ($status == $option) $ret .= ' selected="selected"'; - $ret .= '>'.$my->statusLabel($option).'</option>'.DOKU_LF; + $ret .= '>'.$this->my->statusLabel($option).'</option>'.DOKU_LF; } $ret .= DOKU_TAB.'</select>'.DOKU_LF. DOKU_TAB.'<input class="button" type="submit" value="'.$this->getLang('btn_change').'" />'.DOKU_LF. @@ -168,7 +185,41 @@ class syntax_plugin_task_task extends DokuWiki_Syntax_Plugin { '</form>'; return $ret; } - + + /** + * Returns the download link for the iCal file + */ + function _icsDownload(){ + global $ID, $INFO; + $uid = hsc($ID.'@'.$_SERVER['SERVER_NAME']); + $title = hsc($INFO['meta']['title']); + $link = DOKU_BASE.'lib/plugins/task/ics.php?id='.$ID; + $src = DOKU_BASE.'lib/plugins/task/images/ics.gif'; + return '<a href="'.$link.'" class="uid" title="'.$uid.'"><img src="'.$src.'"'. + ' class="summary" alt="'.$title.'" title="'.$title.'" width="16" height="16"/>'. + '</a> '; + } + + /** + * Returns the organizer in hCalendar format as hCard + */ + function _hCalUser($user){ + return '<span class="vcard"><span class="fn">'.hsc($user).'</span></span>'; + } + + /** + * Returns the date in hCalendar format + */ + function _hCalDate($date){ + global $conf; + + // strip time from preferred date format + $onlydate = trim($conf['dformat'], 'AaBGgHhiOTZ:'); + + return '<abbr class="due" title="'.$this->my->_vdate($date, true).'">'. + date($onlydate, $date). + '</abbr>'; + } } //Setup VIM: ex: et ts=4 enc=utf-8 : syntax/task.php 9847e190ec1788342ea26a67218896163bb82543 wikidesign chi@chimeric.de http://github.com/dokufreaks/plugin-task/commit/3567ed0a4272b2574e8ea870b481b1ca54c10957 3567ed0a4272b2574e8ea870b481b1ca54c10957 2007-01-04T12:33:12-08:00 2007-01-04T12:33:12-08:00 6 hCalendar and .ics download support darcs-hash:20070104203312-89468-251fba2022f36d9446132d9c4a132114be2950d9.gz 78eddfbaa45c770969dbb3ca3680d9a5f723999a wikidesign chi@chimeric.de