* @copyright (c) 2007-12 by Ralf Becker * @version $Id$ */ require_once EGW_SERVER_ROOT.'/phpgwapi/inc/horde/lib/core.php'; /** * EGroupware: GroupDAV access: infolog handler * * Permanent error_log() calls should use $this->groupdav->log($str) instead, to be send to PHP error_log() * and our request-log (prefixed with "### " after request and response, like exceptions). */ class infolog_groupdav extends groupdav_handler { /** * bo class of the application * * @var infolog_bo */ var $bo; /** * vCalendar Instance for parsing * * @var array */ var $vCalendar; var $filter_prop2infolog = array( 'SUMMARY' => 'info_subject', 'UID' => 'info_uid', 'DTSTART' => 'info_startdate', 'DUE' => 'info_enddate', 'DESCRIPTION' => 'info_des', 'STATUS' => 'info_status', 'PRIORITY' => 'info_priority', 'LOCATION' => 'info_location', 'COMPLETED' => 'info_datecompleted', 'CREATED' => 'info_created', ); /** * Are we using info_id, info_uid or caldav_name for the path/url * * Get's set in constructor to 'caldav_name' and groupdav_handler::$path_extension = ''! */ static $path_attr = 'info_id'; /** * Constructor * * @param string $app 'calendar', 'addressbook' or 'infolog' * @param groupdav $groupdav calling class */ function __construct($app, groupdav $groupdav) { parent::__construct($app, $groupdav); $this->bo = new infolog_bo(); $this->vCalendar = new Horde_iCalendar; // since 1.9.002 we allow clients to specify the URL when creating a new event, as specified by CalDAV if (version_compare($GLOBALS['egw_info']['apps']['calendar']['version'], '1.9.002', '>=')) { self::$path_attr = 'caldav_name'; groupdav_handler::$path_extension = ''; } } /** * Create the path for an event * * @param array|int $info * @return string */ function get_path($info) { if (is_numeric($info) && self::$path_attr == 'info_id') { $name = $info; } else { if (!is_array($info)) $info = $this->bo->read($info); $name = $info[self::$path_attr]; } return $name.groupdav_handler::$path_extension; } /** * Get filter-array for infolog_bo::search used by getctag and propfind * * @param string $path * @param int $user account_id * @return array */ private function get_infolog_filter($path, $user) { if (!($infolog_types = $GLOBALS['egw_info']['user']['preferences']['groupdav']['infolog-types'])) { $infolog_types = 'task'; } if ($path == '/infolog/') { $task_filter= 'own'; } else { if ($user == $GLOBALS['egw_info']['user']['account_id']) { $task_filter = 'own'; } else { $task_filter = 'user' . $user; } } $ret = array( 'filter' => $task_filter, 'info_type' => explode(',', $infolog_types), ); //error_log(__METHOD__."('$path', $user) returning ".array2string($ret)); return $ret; } /** * Handle propfind in the infolog folder * * @param string $path * @param array &$options * @param array &$files * @param int $user account_id * @return mixed boolean true on success, false on failure or string with http status (eg. '404 Not Found') */ function propfind($path,&$options,&$files,$user,$id='') { // todo add a filter to limit how far back entries from the past get synced $filter = $this->get_infolog_filter($path, $user); // process REPORT filters or multiget href's if (($id || $options['root']['name'] != 'propfind') && !$this->_report_filters($options, $filter, $id, $nresults)) { // return empty collection, as iCal under iOS 5 had problems with returning "404 Not found" status // when trying to request not supported components, eg. VTODO on a calendar collection return true; } // enable time-range filter for tests via propfind / autoindex //$filter[] = $sql = $this->_time_range_filter(array('end' => '20001231T000000Z')); if ($id) $path = dirname($path).'/'; // caldav_name get's added anyway in the callback if ($this->debug > 1) { error_log(__METHOD__."($path,,,$user,$id) filter=". array2string($filter)); } // check if we have to return the full calendar data or just the etag's if (!($filter['calendar_data'] = $options['props'] == 'all' && $options['root']['ns'] == groupdav::CALDAV) && is_array($options['props'])) { foreach($options['props'] as $prop) { if ($prop['name'] == 'calendar-data') { $filter['calendar_data'] = true; break; } } } // rfc 6578 sync-collection report: filter for sync-token is already set in _report_filters if ($options['root']['name'] == 'sync-collection') { // callback to query sync-token, after propfind_callbacks / iterator is run and // stored max. modification-time in $this->sync_collection_token $files['sync-token'] = array($this, 'get_sync_collection_token'); $files['sync-token-params'] = array($path, $user); $this->sync_collection_token = null; } if (isset($nresults)) { $files['files'] = $this->propfind_callback($path, $filter, array(0, (int)$nresults)); } else { // return iterator, calling ourself to return result in chunks $files['files'] = new groupdav_propfind_iterator($this,$path,$filter,$files['files']); } return true; } /** * Callback for profind interator * * @param string $path * @param array $filter * @param array|boolean $start=false false=return all or array(start,num) * @return array with "files" array with values for keys path and props */ function &propfind_callback($path,array $filter,$start=false) { if ($this->debug) $starttime = microtime(true); if (($calendar_data = $filter['calendar_data'])) { $handler = self::_get_handler(); } unset($filter['calendar_data']); $task_filter = $filter['filter']; unset($filter['filter']); $order = 'info_datemodified'; $sort = 'DESC'; if (preg_match('/^([a-z0-9_]+)( DESC| ASC)?$/i', $filter['order'], $matches)) { $order = $matches[1]; if ($matches[2]) $sort = $matches[2]; unset($filter['order']); } $query = array( 'order' => $order, 'sort' => $sort, 'filter' => $task_filter, 'date_format' => 'server', 'col_filter' => $filter, 'custom_fields' => true, // otherwise custom fields get NOT loaded! ); if (!$calendar_data) { $query['cols'] = array('info_id', 'info_datemodified', 'info_uid', 'caldav_name', 'info_subject', 'info_status'); } if (is_array($start)) { $query['start'] = $offset = $start[0]; $query['num_rows'] = $start[1]; } else { $offset = 0; } $files = array(); // ToDo: add parameter to only return id & etag $tasks =& $this->bo->search($query); if ($tasks && $offset == $query['start']) { foreach($tasks as $task) { // sync-collection report: deleted entry need to be reported without properties if ($task['info_status'] == 'deleted') { $files[] = array('path' => $path.urldecode($this->get_path($task))); continue; } $props = array( 'getcontenttype' => $this->agent != 'kde' ? 'text/calendar; charset=utf-8; component=VTODO' : 'text/calendar', // Konqueror (3.5) dont understand it otherwise 'getlastmodified' => $task['info_datemodified'], 'displayname' => $task['info_subject'], ); if ($calendar_data) { $content = $handler->exportVTODO($task, '2.0', null); // no METHOD:PUBLISH for CalDAV $props['getcontentlength'] = bytes($content); $props[] = HTTP_WebDAV_Server::mkprop(groupdav::CALDAV,'calendar-data',$content); } $files[] = $this->add_resource($path, $task, $props); } } // sync-collection report --> return modified of last contact as sync-token $sync_collection_report = strpos($task_filter, '+deleted') !== false; if ($sync_collection_report) { $this->sync_collection_token = $info['date_modified']; // hack to support limit with sync-collection report: tasks are returned in modified ASC order (oldest first) // if limit is smaller then full result, return modified-1 as sync-token, so client requests next chunk incl. modified // (which might contain further entries with identical modification time) if ($start[0] == 0 && $start[1] != groupdav_propfind_iterator::CHUNK_SIZE && $query['total'] > $start[1]) { --$this->sync_collection_token; } } if ($this->debug) error_log(__METHOD__."($path) took ".(microtime(true) - $starttime).' to return '.count($files).' items'); return $files; } /** * Process the filters from the CalDAV REPORT request * * @param array $options * @param array &$cal_filters * @param string $id * @param int &$nresult on return limit for number or results or unchanged/null * @return boolean true if filter could be processed */ function _report_filters($options,&$cal_filters,$id, &$nresults) { if ($options['filters']) { $cal_filters_in = $cal_filters; // remember filter, to be able to reset standard open-filter, if client sets own filters foreach($options['filters'] as $filter) { switch($filter['name']) { case 'comp-filter': if ($this->debug > 1) error_log(__METHOD__."($options[path],...) comp-filter='{$filter['attrs']['name']}'"); switch($filter['attrs']['name']) { case 'VTODO': case 'VCALENDAR': break; default: return false; } break; case 'prop-filter': if ($this->debug > 1) error_log(__METHOD__."($options[path],...) prop-filter='{$filter['attrs']['name']}'"); $prop_filter = $filter['attrs']['name']; break; case 'text-match': if ($this->debug > 1) error_log(__METHOD__."($options[path],...) text-match: $prop_filter='{$filter['data']}'"); if (!isset($this->filter_prop2infolog[strtoupper($prop_filter)])) { if ($this->debug) error_log(__METHOD__."($options[path],".array2string($options).",...) unknown property '$prop_filter' --> ignored"); } else { $cal_filters[$this->filter_prop2infolog[strtoupper($prop_filter)]] = $filter['data']; } unset($prop_filter); break; case 'param-filter': if ($this->debug) error_log(__METHOD__."($options[path],...) param-filter='{$filter['attrs']['name']}' not (yet) implemented!"); break; case 'time-range': $cal_filters[] = $this->_time_range_filter($filter['attrs']); break; default: if ($this->debug) error_log(__METHOD__."($options[path],".array2string($options).",...) unknown filter --> ignored"); break; } } } // parse limit from $options['other'] /* Example limit 10 */ foreach((array)$options['other'] as $option) { switch($option['name']) { case 'nresults': $nresults = (int)$option['data']; //error_log(__METHOD__."(...) options[other]=".array2string($options['other'])." --> nresults=$nresults"); break; case 'limit': break; case 'href': break; // from addressbook-multiget, handled below // rfc 6578 sync-report case 'sync-token': if (!empty($option['data'])) { $parts = explode('/', $option['data']); $sync_token = array_pop($parts); $filters[] = 'info_datemodified>'.(int)$sync_token; $filters['filter'] .= '+deleted'; // to return deleted entries too $filters['order'] = 'info_datemodified ASC'; // return oldest modifications first } break; case 'sync-level': if ($option['data'] != '1') { $this->groupdav->log(__METHOD__."(...) only sync-level {$option['data']} requested, but only 1 supported! options[other]=".array2string($options['other'])); } break; default: $this->groupdav->log(__METHOD__."(...) unknown xml tag '{$option['name']}': options[other]=".array2string($options['other'])); break; } } // multiget or propfind on a given id //error_log(__FILE__ . __METHOD__ . "multiget of propfind:"); if ($options['root']['name'] == 'calendar-multiget' || $id) { $ids = array(); if ($id) { $cal_filters[self::$path_attr] = groupdav_handler::$path_extension ? basename($id,groupdav_handler::$path_extension) : $id; } else // fetch all given url's { foreach($options['other'] as $option) { if ($option['name'] == 'href') { $parts = explode('/',$option['data']); if (($id = basename(array_pop($parts)))) { $cal_filters[self::$path_attr][] = groupdav_handler::$path_extension ? basename($id,groupdav_handler::$path_extension) : $id; } } } } if ($this->debug > 1) error_log(__METHOD__ ."($options[path],...,$id) calendar-multiget: ids=".implode(',',$ids)); } return true; } /** * Create SQL filter from time-range filter attributes * * CalDAV time-range for VTODO checks DTSTART, DTEND, DUE, CREATED and allways includes tasks if none given * @see http://tools.ietf.org/html/rfc4791#section-9.9 * * @param array $attrs values for keys 'start' and/or 'end', at least one is required by CalDAV rfc! * @return string with sql */ private function _time_range_filter(array $attrs) { $to_or = $to_and = array(); if (!empty($attrs['start'])) { $start = (int)$this->vCalendar->_parseDateTime($attrs['start']); } if (!empty($attrs['end'])) { $end = (int)$this->vCalendar->_parseDateTime($attrs['end']); } elseif (empty($attrs['start'])) { $this->groupdav->log(__METHOD__.'('.array2string($attrs).') minimum one of start or end is required!'); return '1'; // to not give sql error, but simply not filter out anything } // we dont need to care for DURATION line in rfc4791#section-9.9, as we always put that in DUE/info_enddate // we have start- and/or enddate if (isset($start)) { $to_and[] = "($start < info_enddate OR $start <= info_startdate)"; } if (isset($end)) { $to_and[] = "(info_startdate < $end OR info_enddate <= $end)"; } $to_or[] = '('.implode(' AND ', $to_and).')'; /* either start or enddate is already included in the above, because of OR! // only a startdate, no enddate $to_or[] = "NOT info_enddate > 0".($start ? " AND $start <= info_startdate" : ''). ($end ? " AND info_startdate < $end" : ''); // only an enddate, no startdate $to_or[] = "NOT info_startdate > 0".($start ? " AND $start < info_enddate" : ''). ($end ? " AND info_enddate <= $end" : '');*/ // no startdate AND no enddate (2. half of rfc4791#section-9.9) --> use created and due dates instead $to_or[] = 'NOT info_startdate > 0 AND NOT info_enddate > 0 AND ('. // we have a completed date "info_datecompleted > 0".(isset($start) ? " AND ($start <= info_datecompleted OR $start <= info_created)" : ''). (isset($end) ? " AND (info_datecompleted <= $end OR info_created <= $end)" : '').' OR '. // we have no completed date, but always a created date "NOT info_datecompleted > 0". (isset($end) ? " AND info_created < $end" : ''). ')'; $sql = '('.implode(' OR ', $to_or).')'; if ($this->debug > 1) error_log(__FILE__ . __METHOD__.'('.array2string($attrs).") time-range={$filter['attrs']['start']}-{$filter['attrs']['end']} --> $sql"); return $sql; } /** * Handle get request for a task / infolog entry * * @param array &$options * @param int $id * @param int $user=null account_id * @return mixed boolean true on success, false on failure or string with http status (eg. '404 Not Found') */ function get(&$options,$id,$user=null) { if (!is_array($task = $this->_common_get_put_delete('GET',$options,$id))) { return $task; } $handler = $this->_get_handler(); $options['data'] = $handler->exportVTODO($task, '2.0', null); // no METHOD:PUBLISH for CalDAV $options['mimetype'] = 'text/calendar; charset=utf-8'; header('Content-Encoding: identity'); header('ETag: "'.$this->get_etag($task).'"'); return true; } /** * Handle put request for a task / infolog entry * * @param array &$options * @param int $id * @param int $user=null account_id of owner, default null * @param string $prefix=null user prefix from path (eg. /ralf from /ralf/addressbook) * @return mixed boolean true on success, false on failure or string with http status (eg. '404 Not Found') */ function put(&$options,$id,$user=null,$prefix=null) { if ($this->debug) error_log(__METHOD__."($id, $user)".print_r($options,true)); $oldTask = $this->_common_get_put_delete('PUT',$options,$id); if (!is_null($oldTask) && !is_array($oldTask)) { return $oldTask; } $handler = $this->_get_handler(); $vTodo = htmlspecialchars_decode($options['content']); if (is_array($oldTask)) { $taskId = $oldTask['info_id']; $retval = true; } else // new entry { $taskId = 0; $retval = '201 Created'; } if ($GLOBALS['egw_info']['user']['preferences']['groupdav']['infolog-cat-action'] && $GLOBALS['egw_info']['user']['preferences']['groupdav']['infolog-cat-action'] !== 'none') { $callback_data = array(array($this, 'cat_action'), $oldTask); } if (!($infoId = $handler->importVTODO($vTodo, $taskId, false, $user, null, $id, $callback_data))) { if ($this->debug) error_log(__METHOD__."(,$id) import_vtodo($options[content]) returned false"); return '403 Forbidden'; } if ($infoId != $taskId) { $retval = '201 Created'; } // send evtl. necessary respose headers: Location, etag, ... // but only for new entries, as X-INFOLOG-STATUS get's not updated on client, if we confirm with an etag if ($retval !== true && (!$path_attr_is_name || // POST with add-member query parameter $_SERVER['REQUEST_METHOD'] == 'POST' && isset($_GET['add-member']))) { $this->put_response_headers($infoId, $options['path'], $retval, self::$path_attr == 'caldav_name'); } return $retval; } /** * Callback for infolog_ical::importVTODO to implement infolog-cat-action * * @param array $task * @param array $oldTask=null * @return array modified task data */ public function cat_action(array $task, $oldTask=null) { $action = $GLOBALS['egw_info']['user']['preferences']['groupdav']['infolog-cat-action']; //error_log(__METHOD__.'('.array2string($task).', '.array2string($oldTask).") action=$action"); if ($task['info_cat'] && ($new_cat = categories::id2name($task['info_cat'])) && strpos($new_cat, '@') !== false) { $new_user = $GLOBALS['egw']->accounts->name2id($new_cat, 'account_email'); } $old_responsible = $task['info_responsible']; // no action taken, if cat is not email of user if ($new_user) { // make sure category is global, as otherwise it will not be transmitted to other users if (!categories::is_global($task['info_cat'])) { $cat_obj = new categories(categories::GLOBAL_ACCOUNT, 'infolog'); $cat = categories::read($task['info_cat']); $cat['owner'] = categories::GLOBAL_ACCOUNT; $cat['access'] = 'public'; $cat_obj->edit($cat); } // if replace, remove user of old category from responsible if ($action == 'replace' && $oldTask && $oldTask['info_cat'] && ($old_cat = categories::id2name($oldTask['info_cat'])) && strpos($old_cat, '@') !== false && ($old_user = $GLOBALS['egw']->accounts->name2id($old_cat, 'account_email')) && ($key = array_search($old_user, (array)$task['info_responsible'])) !== false) { unset($task['info_responsible'][$key]); } switch($action) { case 'set': $task['info_responsible'] = array(); // fall through case 'set-user': foreach($task['info_responsible'] as $key => $account_id) { if ($GLOBALS['egw']->accounts->get_type($account_id) == 'u') { unset($task['info_responsible'][$key]); } } // fall-through case 'add': case 'replace': if (!in_array($new_user, (array)$task['info_responsible'])) { $task['info_responsible'][] = $new_user; } break; } } error_log(__METHOD__."() action=$action, new_cat=$new_cat --> new_user=$new_user, old_cat=$old_cat --> old_user=$old_user: responsible: ".array2string($old_responsible).' --> '.array2string($task['info_responsible'])); return $task; } /** * Handle delete request for a task / infolog entry * * @param array &$options * @param int $id * @return mixed boolean true on success, false on failure or string with http status (eg. '404 Not Found') */ function delete(&$options,$id) { if (!is_array($task = $this->_common_get_put_delete('DELETE',$options,$id))) { return $task; } return $this->bo->delete($task['info_id']); } /** * Read an entry * * We have to make sure to not return or even consider in read deleted infologs, as the might have * the same UID and/or caldav_name as not deleted ones and would block access to valid entries * * @param string|id $id * @return array|boolean array with entry, false if no read rights, null if $id does not exist */ function read($id) { return $this->bo->read(array(self::$path_attr => $id, "info_status!='deleted'"),false,'server'); } /** * Check if user has the neccessary rights on a task / infolog entry * * @param int $acl EGW_ACL_READ, EGW_ACL_EDIT or EGW_ACL_DELETE * @param array|int $task task-array or id * @return boolean null if entry does not exist, false if no access, true if access permitted */ function check_access($acl,$task) { if (is_null($task)) return true; $access = $this->bo->check_access($task,$acl); if (!$access && $acl == EGW_ACL_EDIT && $this->bo->is_responsible($task)) { $access = true; // access limited to $this->bo->responsible_edit fields (handled in infolog_bo::write()) } if ($this->debug > 1) error_log(__METHOD__."($acl, ".array2string($task).') returning '.array2string($access)); return $access; } /** * Query ctag for infolog * * @return string */ public function getctag($path,$user) { return $this->bo->getctag($this->get_infolog_filter($path, $user)); } /** * Get the etag for an infolog entry * * etag currently uses the modifcation time (info_datemodified), 1.9.002 adds etag column, but it's not yet used! * * @param array|int $info array with infolog entry or info_id * @return string|boolean string with etag or false */ function get_etag($info) { if (!is_array($info)) { $info = $this->bo->read($info,true,'server'); } if (!is_array($info) || !isset($info['info_id']) || !isset($info['info_datemodified'])) { return false; } return $info['info_id'].':'.$info['info_datemodified']; } /** * Add extra properties for calendar collections * * @param array $props=array() regular props by the groupdav handler * @param string $displayname * @param string $base_uri=null base url of handler * @param int $user=null account_id of owner of collection * @return array */ public function extra_properties(array $props=array(), $displayname, $base_uri=null,$user=null) { // calendar description $displayname = translation::convert(lang('Tasks of'),translation::charset(),'utf-8').' '.$displayname; $props['calendar-description'] = HTTP_WebDAV_Server::mkprop(groupdav::CALDAV,'calendar-description',$displayname); // supported components, currently only VEVENT $props['supported-calendar-component-set'] = HTTP_WebDAV_Server::mkprop(groupdav::CALDAV,'supported-calendar-component-set',array( HTTP_WebDAV_Server::mkprop(groupdav::CALDAV,'comp',array('name' => 'VCALENDAR')), HTTP_WebDAV_Server::mkprop(groupdav::CALDAV,'comp',array('name' => 'VTODO')), )); // supported reports $props['supported-report-set'] = array( 'calendar-query' => HTTP_WebDAV_Server::mkprop('supported-report',array( HTTP_WebDAV_Server::mkprop('report',array( HTTP_WebDAV_Server::mkprop(groupdav::CALDAV,'calendar-query',''))))), 'calendar-multiget' => HTTP_WebDAV_Server::mkprop('supported-report',array( HTTP_WebDAV_Server::mkprop('report',array( HTTP_WebDAV_Server::mkprop(groupdav::CALDAV,'calendar-multiget',''))))), // rfc 6578 sync-collection report 'sync-collection' => HTTP_WebDAV_Server::mkprop('supported-report',array( HTTP_WebDAV_Server::mkprop('report',array( HTTP_WebDAV_Server::mkprop('sync-collection',''))))), ); // get timezone of calendar if ($this->groupdav->prop_requested('calendar-timezone')) { $props['calendar-timezone'] = HTTP_WebDAV_Server::mkprop(groupdav::CALDAV,'calendar-timezone', calendar_timezones::user_timezone($user)); } return $props; } /** * Get the handler and set the supported fields * * @return infolog_ical */ private function _get_handler() { $handler = new infolog_ical(); $handler->tzid = false; // as we read server-time timestamps (!= null=user-time), exports UTC times $handler->setSupportedFields('GroupDAV',$this->agent); return $handler; } /** * Return appliction specific settings * * @param array $hook_data * @return array of array with settings */ static function get_settings($hook_data) { if (!isset($hook_data['setup'])) { translation::add_app('infolog'); $infolog = new infolog_bo(); $types = $infolog->enums['type']; } if (!isset($types)) { $types = array( 'task' => 'Tasks', ); } $settings = array(); $settings['infolog-types'] = array( 'type' => 'multiselect', 'label' => 'InfoLog types to sync', 'name' => 'infolog-types', 'help' => 'Which InfoLog types should be synced with the device, default only tasks.', 'values' => $types, 'default' => 'task', 'xmlrpc' => True, 'admin' => False, ); $settings['infolog-cat-action'] = array( 'type' => 'select', 'label' => 'Action when category is an EMail address', 'name' => 'infolog-cat-action', 'help' => 'Allows to modify responsible users from devices not supporting them, by setting EMail address of a user as category.', 'values' => array( 'none' => lang('none'), 'add' => lang('add user to responsibles'), 'replace' => lang('add user to responsibles, removing evtl. previous category user'), 'set' => lang('set user as only responsible, removing all existing responsibles'), 'set-user' => lang('set user as only responsible user, but keeping groups'), ), 'default' => 'none', 'xmlrpc' => True, 'admin' => False, ); return $settings; } }