diff --git a/lib/filter/mapistore.php b/lib/filter/mapistore.php index 7fb7529..c772b01 100644 --- a/lib/filter/mapistore.php +++ b/lib/filter/mapistore.php @@ -1,532 +1,585 @@ | +--------------------------------------------------------------------------+ | Author: Aleksander Machniak | +--------------------------------------------------------------------------+ */ class kolab_api_filter_mapistore extends kolab_api_filter { protected $input; protected $attrs_filter; // Common properties [MS-OXCMSG] protected static $map = array( // 'PidTagAccess' => '', // 'PidTagAccessLevel' => '', // 0 - read-only, 1 - modify // 'PidTagChangeKey' => '', 'PidTagCreationTime' => 'creation-date', // PtypTime, UTC 'PidTagLastModificationTime' => 'last-modification-date', // PtypTime, UTC // 'PidTagLastModifierName' => '', // 'PidTagObjectType' => '', // @TODO // 'PidTagHasAttachments' => '', // @TODO // 'PidTagRecordKey' => '', // 'PidTagSearchKey' => '', // 'PidLidCategories' => 'categories', // @TODO ); /** * Modify request path * * @param array (Exploded) request path */ public function path(&$path) { // handle differences between OpenChange API and Kolab API // here we do only very basic modifications, just to be able // to select apprioprate api action class if ($path[0] == 'calendars') { $path[0] = 'events'; } } /** * Executed before every api action * * @param kolab_api_input Request */ public function input(&$input) { $this->input = $input; // handle differences between OpenChange API and Kolab API switch ($input->action) { case 'folders': // in OpenChange folders/1/folders means get all folders if ($input->method == 'GET' && $input->path[0] === '1' && $input->path[1] == 'folders') { $input->path = array(); $type = 'folder'; } // in OpenChange folders/0/folders means get the hierarchy of the NON IPM Subtree // we should ignore/send empty request else if ($input->method == 'GET' && $input->path[0] === '0' && $input->path[1] == 'folders') { // @TODO throw new kolab_api_exception(kolab_api_exception::NOT_FOUND); } else if ($input->path[1] == 'messages') { $input->path[1] = 'objects'; if ($input->args['properties']) { $type = $input->api->backend->folder_type($input->path[0]); list($type, ) = explode('.', $type); } } else if ($input->path[1] == 'deletemessages') { $input->path[1] = 'deleteobjects'; } // properties filter, map MAPI attribute names to Kolab attributes if ($type && $input->args['properties']) { $this->attrs_filter = explode(',', $this->input->args['properties']); $properties = $this->attributes_filter($this->attrs_filter, $type); $input->args['properties'] = implode(',', $properties); } break; case 'notes': // Notes do not have attachments in Exchange if ($input->path[1] === 'attachments' || count($this->path) > 2) { throw new kolab_api_exception(kolab_api_exception::NOT_FOUND); } break; } $common_action = !in_array($input->action, array('folders', 'info')); // convert / to // or /// if ($common_action && ($uid = $input->path[0])) { list($folder, $msg, $attach) = self::uid_decode($uid); $path = array($folder, $msg); if ($attach) { $path[] = $attach; } array_splice($input->path, 0, 1, $path); } // convert parent_id into path on object create request if ($input->method == 'POST' && $common_action && !count($input->path)) { $data = $input->input(null, true); if ($data['parent_id']) { $input->path[0] = $data['parent_id']; } else { throw new kolab_api_exception(kolab_api_exception::INVALID_REQUEST); } } } /** * Executed when parsing request body * * @param string Request data * @param string Expected object type * @param string Original object data (set on update requests) */ public function input_body(&$data, $type = null, $original_object = null) { $input = $this->input; // handle differences between OpenChange API and Kolab API // Note: input->path is already modified by input() and path() above switch ($input->action) { case 'folders': // folders//deletemessages input if ($input->path[1] == 'deleteobjects') { // Kolab API expects just a list of identifiers, I.e.: // [{"id": "1"}, {"id": "2"}] => ["1", "2"] foreach ((array) $data as $idx => $element) { $data[$idx] = $element['id']; } } break; } switch ($type) { case 'attachment': case 'event': case 'note': case 'task': case 'contact': case 'mail': case 'folder': $model = $this->get_model_class($type); $data = $model->input($data, $original_object); break; } } /** * Apply filter on output data * * @param array Result data * @param string Object type * @param array Context (folder_uid, object_uid, object) * @param array Optional attributes filter */ public function output(&$result, $type, $context = null, $attrs_filter = array()) { // handle differences between OpenChange API and Kolab API $model = $this->get_model_class($type); if (!empty($this->attrs_filter)) { $attrs_filter = array_combine($this->attrs_filter, $this->attrs_filter); } else if (!empty($attrs_filter)) { $attrs_filter = $this->attributes_filter($attrs_filter, $type, true); $attrs_filter = array_combine($attrs_filter, $attrs_filter); } foreach ($result as $idx => $data) { if ($filtered = $model->output($data, $context)) { // apply properties filter (again) if (!empty($attrs_filter)) { $filtered = array_intersect_key($filtered, $attrs_filter); } $result[$idx] = $filtered; } else { unset($result[$idx]); $unset = true; } } if ($unset) { $result = array_values($result); } } /** * Executed for response headers * * @param array Response headers */ public function headers(&$headers) { // handle differences between OpenChange API and Kolab API foreach ($headers as $name => $value) { switch ($name) { case 'X-Count': $headers['X-mapistore-rowcount'] = $value; unset($headers[$name]); break; } } } /** * Executed for empty response status * * @param int Status code */ public function send_status(&$status) { // handle differences between OpenChange API and Kolab API } /** * Extracts data from kolab data array */ public static function get_kolab_value($data, $name) { $name_items = explode('.', $name); $count = count($name_items); $value = $data[$name_items[0]]; + // special handling of x-custom properties + if ($name_items[0] === 'x-custom') { + foreach ((array) $value as $custom) { + if ($custom['identifier'] === $name_items[1]) { + return $custom['value']; + } + } + + return null; + } + for ($i = 1; $i < $count; $i++) { if (!is_array($value)) { return null; } list($key, $num) = explode(':', $name_items[$i]); $value = $value[$key]; if ($num !== null && $value !== null) { $value = is_array($value) ? $value[$num] : null; } } return $value; } /** * Sets specified kolab data item */ public static function set_kolab_value(&$data, $name, $value) { $name_items = explode('.', $name); $count = count($name_items); $element = &$data; + // x-custom properties + if ($name_items[0] === 'x-custom') { + // this is supposed to be converted later by parse_common_props() + $data[$name] = $value; + return; + } + if ($count > 1) { for ($i = 0; $i < $count - 1; $i++) { $key = $name_items[$i]; if (!array_key_exists($key, $element)) { $element[$key] = array(); } $element = &$element[$key]; } } $element[$name_items[$count - 1]] = $value; } /** * Converts kolab identifiers describind the object into * MAPI identifier that can be easily used in URL. * * @param string Folder UID * @param string Object UID * @param string Optional attachment identifier * * @return string Object identifier */ public static function uid_encode($folder_uid, $msg_uid, $attach_id = null) { $result = array($folder_uid, $msg_uid); if ($attach_id) { $result[] = $attach_id; } $result = array_map(array('kolab_api_filter_mapistore', 'uid_encode_item'), $result); return implode('.', $result); } /** * Converts back the MAPI identifier into kolab folder/object/attachment IDs * * @param string Object identifier * * @return array Object identifiers */ public static function uid_decode($uid) { $result = explode('.', $uid); $result = array_map(array('kolab_api_filter_mapistore', 'uid_decode_item'), $result); return $result; } /** * Encodes UID element */ protected static function uid_encode_item($str) { $fn = function($match) { return '_' . ord($match[1]); }; $str = preg_replace_callback('/([^0-9a-zA-Z-])/', $fn, $str); return $str; } /** * Decodes UID element */ protected static function uid_decode_item($str) { $fn = function($match) { return chr($match[1]); }; $str = preg_replace_callback('/_([0-9]{2})/', $fn, $str); return $str; } /** * Parse common properties in object data (convert into MAPI format) */ public static function parse_common_props(&$result, $data, $context = array()) { if (empty($context)) { // @TODO: throw exception? return; } if ($data['uid'] && $context['folder_uid']) { $result['id'] = self::uid_encode($context['folder_uid'], $data['uid']); } if ($context['folder_uid']) { $result['parent_id'] = $context['folder_uid']; } foreach (self::$map as $mapi_idx => $kolab_idx) { if (!isset($result[$mapi_idx]) && ($value = $data[$kolab_idx]) !== null) { switch ($kolab_idx) { case 'creation-date': case 'last-modification-date': $result[$mapi_idx] = self::date_php2mapi($value, true); break; } } } } /** * Convert common properties into kolab format */ - public static function convert_common_props(&$result, $data) + public static function convert_common_props(&$result, $data, $original) { // @TODO: id, parent_id? foreach (self::$map as $mapi_idx => $kolab_idx) { if (array_key_exists($mapi_idx, $data) && !array_key_exists($kolab_idx, $result)) { $value = $data[$mapi_idx]; switch ($mapi_idx) { case 'PidTagCreationTime': case 'PidTagLastModificationTime': if ($value) { $dt = self::date_mapi2php($value); $result[$kolab_idx] = $dt->format('Y-m-d\TH:i:s\Z'); } break; } } } + + // Handle x-custom fields + foreach ((array) $result as $key => $value) { + if (strpos($key, 'x-custom.') === 0) { + unset($result[$key]); + $key = substr($key, 9); + + foreach ((array) $original['x-custom'] as $idx => $custom) { + if ($custom['identifier'] == $key) { + if ($value) { + $original['x-custom'][$idx]['value'] = $value; + } + else { + unset($original['x-custom'][$idx]); + } + + $x_custom_update = true; + continue 2; + } + } + + if ($value) { + $original['x-custom'][] = array( + 'identifier' => $key, + 'value' => $value, + ); + } + + $x_custom_update = true; + } + } + + if ($x_custom_update) { + $result['x-custom'] = array_values($original['x-custom']); + } } /** * Filter property names */ public function attributes_filter($attrs, $type = null, $reverse = false) { $map = self::$map; $result = array(); if ($type) { $model = $this->get_model_class($type); $map = array_merge($map, $model->map()); } // add some special common attributes $map['PidTagMessageClass'] = 'PidTagMessageClass'; $map['collection'] = 'collection'; $map['id'] = 'uid'; foreach ($attrs as $attr) { if ($reverse) { if ($name = array_search($attr, $map)) { $result[] = $name; } } else if ($name = $map[$attr]) { $result[] = $name; } } return $result; } /** * Return instance of model class object */ protected function get_model_class($type) { $class = "kolab_api_filter_mapistore_$type"; return new $class($this); } /** * Convert DateTime object to MAPI date format */ public function date_php2mapi($date, $utc = true, $time = null) { // convert string to DateTime if (!is_object($date) && !empty($date)) { // convert date to datetime on 00:00:00 if (preg_match('/^([0-9]{4})-?([0-9]{2})-?([0-9]{2})$/', $date, $m)) { $date = $m[1] . '-' . $m[2] . '-' . $m[3] . 'T00:00:00+00:00'; } $date = new DateTime($date); } if (!is_object($date)) { return; } if ($utc) { $date->setTimezone(new DateTimeZone('UTC')); } if (!empty($time)) { $date->setTime((int) $time['hour'], (int) $time['minute'], (int) $time['second']); } // MAPI PTypTime is 64-bit integer representing the number // of 100-nanosecond intervals since January 1, 1601. // Note: probably does not work on 32-bit systems return ($date->format('U') + 11644473600) * 10000000; } /** * Convert date-time from MAPI format to DateTime */ public function date_mapi2php($date, $utc = true) { // Note: probably does not work on 32-bit systems $seconds = intval($date / 10000000) - 11644473600; // assumes we're working with dates after 1970-01-01 return new DateTime('@' . $seconds); } /** * Parse categories according to [MS-OXCICAL 2.1.3.1.1.20.3] * * @param array Categories * * @return array Categories */ public static function parse_categories($categories) { if (!is_array($categories)) { return; } $result = array(); foreach ($categories as $idx => $val) { $val = preg_replace('/(\x3B|\x2C|\x06\x1B|\xFE\x54|\xFF\x1B)/', '', $val); $val = preg_replace('/\s+/', ' ', $val); $val = trim($val); $len = mb_strlen($val); if ($len) { if ($len > 255) { $val = mb_substr($val, 0, 255); } $result[mb_strtolower($val)] = $val; } } return array_values($result); } } diff --git a/lib/filter/mapistore/contact.php b/lib/filter/mapistore/contact.php index 0d3183c..fbedb59 100644 --- a/lib/filter/mapistore/contact.php +++ b/lib/filter/mapistore/contact.php @@ -1,569 +1,579 @@ | +--------------------------------------------------------------------------+ | Author: Aleksander Machniak | +--------------------------------------------------------------------------+ */ class kolab_api_filter_mapistore_contact { protected $map = array( + // contact name properties [MS-OXOCNTC] 'PidTagNickname' => 'nickname', 'PidTagGeneration' => 'n.suffix', 'PidTagDisplayNamePrefix' => 'n.prefix', 'PidTagSurname' => 'n.surname', 'PidTagMiddleName' => 'n.additional', 'PidTagGivenName' => 'n.given', - 'PidTagInitials' => '', // @TODO: X-? + 'PidTagInitials' => 'x-custom.MAPI:PidTagInitials', 'PidTagDisplayName' => 'fn', - 'PidTagPrimaryFaxNumber' => '', // @TODO: X-? - 'PidTagBusinessFaxNumber' => '', // @TODO: X-? + 'PidLidYomiFirstName' => '', + 'PidLidYomiLastName' => '', + 'PidLidFileUnder' => '', + 'PidLidFileUnderId' => '', // PtypInteger32 + 'PidLidFileUnderList' => '', // PtypMultipleInteger32 + // electronic and phisical address properties + 'PidTagPrimaryFaxNumber' => 'x-custom.MAPI:PidTagPrimaryFaxNumber', + 'PidTagBusinessFaxNumber' => 'x-custom.MAPI:PidTagBusinessFaxNumber', 'PidTagHomeFaxNumber' => '', 'PidTagHomeAddressStreet' => '', 'PidTagHomeAddressCity' => '', 'PidTagHomeAddressStateOrProvince' => '', 'PidTagHomeAddressPostalCode' => '', 'PidTagHomeAddressCountry' => '', 'PidLidHomeAddressCountryCode' => '', 'PidTagHomeAddressPostOfficeBox' => '', 'PidLidHomeAddress' => '', // @TODO: ? 'PidLidWorkAddressStreet' => '', 'PidLidWorkAddressCity' => '', 'PidLidWorkAddressState' => '', 'PidLidWorkAddressPostalCode' => '', 'PidLidWorkAddressCountry' => '', 'PidLidWorkAddressCountryCode' => '', 'PidLidWorkAddressPostOfficeBox' => '', 'PidLidWorkAddress' => '', // @TODO: ? 'PidTagOtherAddressStreet' => '', 'PidTagOtherAddressCity' => '', 'PidTagOtherAddressStateOrProvince' => '', 'PidTagOtherAddressPostalCode' => '', 'PidTagOtherAddressCountry' => '', 'PidLidOtherAddressCountryCode' => '', 'PidTagOtherAddressPostOfficeBox' => '', 'PidLidOtherAddress' => '', // @TODO: ? 'PidTagStreetAddress' => '', // @TODO: ? 'PidTagLocality' => '', // @TODO: ? 'PidTagStateOrProvince' => '', // @TODO: ? 'PidTagPostalCode' => '', // @TODO: ? 'PidTagCountry' => '', // @TODO: ? 'PidLidAddressCountryCode' => '', // @TODO: ? 'PidTagPostOfficeBox' => '', // @TODO: ? 'PidTagPostalAddress' => '', // @TODO: ? 'PidTagPagerTelephoneNumber' => '', 'PidTagCallbackTelephoneNumber' => '', 'PidTagBusinessTelephoneNumber' => '', 'PidTagHomeTelephoneNumber' => '', 'PidTagPrimaryTelephoneNumber' => '', 'PidTagBusiness2TelephoneNumber' => '', 'PidTagMobileTelephoneNumber' => '', 'PidTagRadioTelephoneNumber' => '', 'PidTagCarTelephoneNumber' => '', 'PidTagOtherTelephoneNumber' => '', 'PidTagAssistantTelephoneNumber' => '', - 'PidTagHome2TelephoneNumber' => '', // @TODO: X-? - 'PidTagTelecommunicationsDeviceForDeafTelephoneNumber' => '', // @TODO: X-? - 'PidTagCompanyMainTelephoneNumber' => '', // @TODO: X-? + 'PidTagHome2TelephoneNumber' => 'x-custom.MAPI:PidTagHome2TelephoneNumber', + 'PidTagTelecommunicationsDeviceForDeafTelephoneNumber' => 'x-custom.MAPI:PidTagTelecommunicationsDeviceForDeafTelephoneNumber', + 'PidTagCompanyMainTelephoneNumber' => 'x-custom.MAPI:PidTagCompanyMainTelephoneNumber', 'PidTagTelexNumber' => '', 'PidTagIsdnNumber' => '', - 'PidTagBirthday' => 'bday', // PtypTime - 'PidTagWeddingAnniversary' => 'anniversary', // PtypTime + 'PidTagBirthday' => 'bday', // PtypTime, UTC + 'PidLidBirthdayLocal' => '', // PtypTime + 'PidTagWeddingAnniversary' => 'anniversary', // PtypTime, UTC + 'PidLidWeddingAnniversaryLocal' => '', // PtypTime + // professional properties 'PidTagTitle' => 'title', 'PidTagCompanyName' => '', + 'PidLidYomiCompanyName' => '', 'PidTagDepartmentName' => '', - 'PidTagOfficeLocation' => '', // @TODO: X-? + 'PidTagOfficeLocation' => 'x-custom.MAPI:PidTagOfficeLocation', 'PidTagManagerName' => '', 'PidTagAssistant' => '', 'PidTagProfession' => 'group.role', - 'PidLidHasPicture' => '', // bool, more about photo attachments in MS-OXOCNTC - 'PidTagHobbies' => '', // @TODO: X-? + 'PidLidHasPicture' => '', // PtypBoolean, more about photo attachments in MS-OXOCNTC + // other properties + 'PidTagHobbies' => 'x-custom.MAPI:PidTagHobbies', 'PidTagSpouseName' => '', 'PidTagLanguage' => 'lang', - 'PidTagLocation' => '', // @TODO: X-? + 'PidTagLocation' => 'x-custom.MAPI:PidTagLocation', 'PidLidInstantMessagingAddress' => 'impp', - 'PidTagOrganizationalIdNumber' => '', // @TODO: X-? - 'PidTagCustomerId' => '', // @TODO: X-? - 'PidTagGovernmentIdNumber' => '', // @TODO: X-? + 'PidTagOrganizationalIdNumber' => 'x-custom.MAPI:PidTagOrganizationalIdNumber', + 'PidTagCustomerId' => 'x-custom.MAPI:PidTagCustomerId', + 'PidTagGovernmentIdNumber' => 'x-custom.MAPI:PidTagGovernmentIdNumber', 'PidTagPersonalHomePage' => 'url', - 'PidTagBusinessHomePage' => '', // @TODO: X-? - 'PidTagFtpSite' => '', // @TODO: X-? + 'PidTagBusinessHomePage' => 'x-custom.MAPI:PidTagBussinessHomePage', + 'PidTagFtpSite' => 'x-custom.MAPI:PidTagFtpSite', 'PidLidFreeBusyLocation' => 'fburl', - 'PidTagChildrenNames' => '', // PtypMultipleString + 'PidTagChildrenNames' => '', // PtypMultipleString 'PidTagGender' => 'gender', - 'PidTagUserX509Certificate' => 'key', // PtypMultipleBinary - 'PidTagMessageClass' => '', // IPM.Contact, IPM.DistList + 'PidTagUserX509Certificate' => 'key', // PtypMultipleBinary + 'PidTagMessageClass' => '', // IPM.Contact, IPM.DistList 'PidTagBody' => 'note', 'PidTagLastModificationTime' => 'rev', /* - // distribution lists - 'PidTag' => '', - 'PidTag' => '', - 'PidTag' => '', - 'PidTag' => '', - 'PidTag' => '', - 'PidTag' => '', - 'PidTag' => '', - 'PidTag' => '', + // distribution lists [MS-OXOCNTC] + 'PidLidDistributionListName' => '', // PtypString = PidTagDisplayName + 'PidLidDistributionListMembers' => '', // PtypMultipleBinary + 'PidLidDistributionListOneOffMembers' => '', // PtypMultipleBinary + 'PidLidDistributionListChecksum' => '', // PtypInteger32 + 'PidLidDistributionListStream' => '', // PtypBinary */ ); protected $gender_map = array( 0 => '', 1 => 'F', 2 => 'M', ); protected $phone_map = array( 'PidTagPagerTelephoneNumber' => 'pager', 'PidTagBusinessTelephoneNumber' => 'work', 'PidTagHomeTelephoneNumber' => 'home', 'PidTagMobileTelephoneNumber' => 'cell', 'PidTagCarTelephoneNumber' => 'x-car', 'PidTagOtherTelephoneNumber' => 'textphone', 'PidTagBusinessFaxNumber' => 'faxwork', 'PidTagHomeFaxNumber' => 'faxhome', ); protected $email_map = array( 'PidLidEmail1EmailAddress' => 'home', 'PidLidEmail2EmailAddress' => 'work', 'PidLidEmail3EmailAddress' => 'other', ); /** * Convert Kolab to MAPI * * @param array Data * @param array Context (folder_uid, object_uid, object) * * @return array Data */ public function output($data, $context = null) { $result = array( + // @TODO: IPM.DistList for groups 'PidTagMessageClass' => 'IPM.Contact', // mapistore REST API specific properties 'collection' => 'contacts', ); foreach ($this->map as $mapi_idx => $kolab_idx) { if (empty($kolab_idx)) { continue; } $value = kolab_api_filter_mapistore::get_kolab_value($data, $kolab_idx); if ($value === null) { continue; } switch ($mapi_idx) { case 'PidTagGender': $value = (int) array_search($value, $this->gender_map); break; case 'PidTagPersonalHomePage': case 'PidLidInstantMessagingAddress': if (is_array($value)) { $value = $value[0]; } break; case 'PidTagBirthday': case 'PidTagWeddingAnniversary': case 'PidTagLastModificationTime': $value = kolab_api_filter_mapistore::date_php2mapi($value, false); break; case 'PidTagUserX509Certificate': foreach ((array) $value as $val) { if ($val && preg_match('|^data:application/pkcs7-mime;base64,|i', $val, $m)) { $result[$mapi_idx] = substr($val, strlen($m[0])); continue 3; } } $value = null; break; case 'PidTagTitle': if (is_array($value)) { $value = $value[0]; } break; } if ($value === null) { continue; } $result[$mapi_idx] = $value; } // contact photo attachment [MS-OXVCARD 2.1.3.2.4] if (!empty($data['photo'])) { // @TODO: check if photo is one of .bmp, .gif, .jpeg, .png // Photo in MAPI is handled as attachment // Set PidTagAttachmentContactPhoto=true on attachment object $result['PidLidHasPicture'] = true; } // Organization/Department $organization = $data['group']['org']; if (is_array($organization)) { $result['PidTagCompanyName'] = $organization[0]; $result['PidTagDepartmentName'] = $organization[1]; } else if ($organization !== null) { $result['PidTagCompanyName'] = $organization; } // Manager/Assistant $related = $data['group']['related']; if ($related && $related['parameters']) { $related = array($related); } foreach ((array) $related as $rel) { $type = $rel['parameters']['type']; if ($type == 'x-manager') { $result['PidTagManagerName'] = $rel['text']; } else if ($type == 'x-assistant') { $result['PidTagAssistant'] = $rel['text']; } } // Children, Spouse foreach ((array) $data['related'] as $rel) { $type = $rel['parameters']['type']; if ($type == 'child') { $result['PidTagChildrensNames'][] = $rel['text']; } else if ($type == 'spouse') { $result['PidTagSpouseName'] = $rel['text']; } } // Emails $email_map = array_flip($this->email_map); foreach ((array) $data['email'] as $email) { $type = is_array($email) ? $email['parameters']['type'] : 'other'; $key = $email_map[$type] ?: $email_map['other']; $result[$key] = is_array($email) ? $email['text'] : $email; } // Phone(s) $phone_map = array_flip($this->phone_map); $phones = $data['tel']; if ($phones && $phones['parameters']) { $phones = array($phones); } foreach ((array) $phones as $phone) { $type = implode('', (array)$phone['parameters']['type']); if ($phone['text'] && ($idx = $phone_map[$type])) { $result[$idx] = $phone['text']; } } // Addresses(s) $addresses = $data['adr']; if ($addresses && $addresses['parameters']) { $addresses = array($addresses); } foreach ((array) $addresses as $addr) { $type = $addr['parameters']['type']; $address = null; if ($type == 'home') { $address = array( 'PidTagHomeAddressStreet' => $addr['street'], 'PidTagHomeAddressCity' => $addr['locality'], 'PidTagHomeAddressStateOrProvince' => $addr['region'], 'PidTagHomeAddressPostalCode' => $addr['code'], 'PidTagHomeAddressCountry' => $addr['country'], 'PidTagHomeAddressPostOfficeBox' => $addr['pobox'], ); } else if ($type == 'work') { $address = array( 'PidLidWorkAddressStreet' => $addr['street'], 'PidLidWorkAddressCity' => $addr['locality'], 'PidLidWorkAddressState' => $addr['region'], 'PidLidWorkAddressPostalCode' => $addr['code'], 'PidLidWorkAddressCountry' => $addr['country'], 'PidLidWorkAddressPostOfficeBox' => $addr['pobox'], ); } if (!empty($address)) { $result = array_merge($result, array_filter($address)); } } $other_adr_map = array( 'street' => 'PidTagOtherAddressStreet', 'locality' => 'PidTagOtherAddressCity', 'region' => 'PidTagOtherAddressStateOrProvince', 'code' => 'PidTagOtherAddressPostalCode', 'country' => 'PidTagOtherAddressCountry', 'pobox' => 'PidTagOtherAddressPostOfficeBox', ); foreach ((array) $data['group']['adr'] as $idx => $value) { if ($value && ($key = $other_adr_map[$idx])) { $result[$key] = $value; } } kolab_api_filter_mapistore::parse_common_props($result, $data, $context); return $result; } /** * Convert from MAPI to Kolab * * @param array Data * @param array Data of the object that is being updated * * @return array Data */ public function input($data, $object = null) { $result = array(); foreach ($this->map as $mapi_idx => $kolab_idx) { if (empty($kolab_idx)) { continue; } if (!array_key_exists($mapi_idx, $data)) { continue; } $value = $data[$mapi_idx]; switch ($mapi_idx) { case 'PidTagBirthday': case 'PidTagWeddingAnniversary': if ($value) { $value = kolab_api_filter_mapistore::date_mapi2php($value); $value = $value->format('Y-m-d'); } break; case 'PidTagLastModificationTime': if ($value) { $value = kolab_api_filter_mapistore::date_mapi2php($value); $value = $value->format('Y-m-d\TH:i:s\Z'); } break; case 'PidTagGender': $value = $this->gender_map[(int)$value]; break; case 'PidTagUserX509Certificate': if (!empty($value)) { $value = array('data:application/pkcs7-mime;base64,' . $value); } break; case 'PidTagPersonalHomePage': case 'PidLidInstantMessagingAddress': if (!empty($value)) { $value = array($value); } break; } kolab_api_filter_mapistore::set_kolab_value($result, $kolab_idx, $value); } // MS-OXVCARD 2.1.3.2.1 if (!empty($data['PidTagNormalizedSubject']) && empty($data['PidTagDisplayName'])) { $result['fn'] = $data['PidTagNormalizedSubject']; } // Organization/Department if ($data['PidTagCompanyName']) { $result['group']['org'][] = $data['PidTagCompanyName']; } if (!empty($data['PidTagDepartmentName'])) { $result['group']['org'][] = $data['PidTagDepartmentName']; } // Manager if ($data['PidTagManagerName']) { $result['group']['related'][] = array( 'parameters' => array('type' => 'x-manager'), 'text' => $data['PidTagManagerName'], ); } // Assistant if ($data['PidTagAssistant']) { $result['group']['related'][] = array( 'parameters' => array('type' => 'x-assistant'), 'text' => $data['PidTagAssistant'], ); } // Spouse if ($data['PidTagSpouseName']) { $result['related'][] = array( 'parameters' => array('type' => 'spouse'), 'text' => $data['PidTagSpouseName'], ); } // Children foreach ((array) $data['PidTagChildrensNames'] as $child) { $result['related'][] = array( 'parameters' => array('type' => 'child'), 'text' => $child, ); } // Emails foreach ($this->email_map as $mapi_idx => $type) { if ($email = $data[$mapi_idx]) { $result['email'][] = array( 'parameters' => array('type' => $type), 'text' => $email, ); } } // Phone(s) foreach ($this->phone_map as $mapi_idx => $type) { if (array_key_exists($mapi_idx, $data)) { // first remove the old phone... if (!empty($object['tel'])) { foreach ($object['tel'] as $idx => $phone) { $pt = implode('', (array) $phone['parameters']['type']); if ($pt == $type) { unset($object['tel'][$idx]); } } } if ($tel = $data[$mapi_idx]) { if (preg_match('/^fax(work|home)$/', $type, $m)) { $type = array('fax', $m[1]); } // and add it to the list $result['tel'][] = array( 'parameters' => array('type' => $type), 'text' => $tel, ); } } } if (!empty($object['tel'])) { $result['tel'] = array_merge((array) $result['tel'], (array) $object['tel']); } // Home address $address = array(); $adr_map = array( 'PidTagHomeAddressStreet' => 'street', 'PidTagHomeAddressCity' => 'locality', 'PidTagHomeAddressStateOrProvince' => 'region', 'PidTagHomeAddressPostalCode' => 'code', 'PidTagHomeAddressCountry' => 'country', 'PidTagHomeAddressPostOfficeBox' => 'pobox', ); foreach ($adr_map as $mapi_idx => $idx) { if ($adr = $data[$mapi_idx]) { $address[$idx] = $adr; } } if (!empty($address)) { $type = array('parameters' => array('type' => 'home')); $result['adr'][] = array_merge($address, $type); } // Work address $address = array(); $adr_map = array( 'PidLidWorkAddressStreet' => 'street', 'PidLidWorkAddressCity' => 'locality', 'PidLidWorkAddressState' => 'region', 'PidLidWorkAddressPostalCode' => 'code', 'PidLidWorkAddressCountry' => 'country', 'PidLidWorkAddressPostOfficeBox' => 'pobox', ); foreach ($adr_map as $mapi_idx => $idx) { if ($adr = $data[$mapi_idx]) { $address[$idx] = $adr; } } if (!empty($address)) { $type = array('parameters' => array('type' => 'work')); $result['adr'][] = array_merge($address, $type); } // Office address $address = array(); $adr_map = array( 'PidTagOtherAddressStreet' => 'street', 'PidTagOtherAddressCity' => 'locality', 'PidTagOtherAddressStateOrProvince' => 'region', 'PidTagOtherAddressPostalCode' => 'code', 'PidTagOtherAddressCountry' => 'country', 'PidTagOtherAddressPostOfficeBox' => 'pobox', ); foreach ($adr_map as $mapi_idx => $idx) { if ($adr = $data[$mapi_idx]) { $address[$idx] = $adr; } } if (!empty($address)) { $result['group']['adr'] = array_merge($address, $type); } - kolab_api_filter_mapistore::convert_common_props($result, $data); + kolab_api_filter_mapistore::convert_common_props($result, $data, $object); return $result; } /** * Returns the attributes names mapping */ public function map() { $map = array_filter($this->map); return $map; } } diff --git a/lib/filter/mapistore/event.php b/lib/filter/mapistore/event.php index 7c4a1fd..8bd9d53 100644 --- a/lib/filter/mapistore/event.php +++ b/lib/filter/mapistore/event.php @@ -1,592 +1,602 @@ | +--------------------------------------------------------------------------+ | Author: Aleksander Machniak | +--------------------------------------------------------------------------+ */ class kolab_api_filter_mapistore_event { protected $map = array( // common properties [MS-OXOCAL] - 'PidLidAppointmentSequence' => 'sequence', - 'PidLidBusyStatus' => '', // @TODO: X-MICROSOFT-CDO-BUSYSTATUS - 'PidLidAppointmentAuxiliaryFlags' => '', - 'PidLidLocation' => 'location', - 'PidLidAppointmentStartWhole' => 'dtstart', - 'PidLidAppointmentEndWhole' => 'dtend', - 'PidLidAppointmentDuration' => '', - 'PidNameKeywords' => 'categories', - 'PidLidAppointmentSubType' => '', - 'PidLidAppointmentStateFlags' => '', - 'PidLidResponseStatus' => '', - 'PidLidRecurring' => '', - 'PidLidIsRecurring' => '', - 'PidLidClipStart' => '', - 'PidLidClipEnd' => '', - 'PidLidAllAttendeesString' => '', - 'PidLidToAttendeesString' => '', - 'PidLidCCAttendeesString' => '', - 'PidLidNonSendableTo' => '', - 'PidLidNonSendableCc' => '', - 'PidLidNonSendableBcc' => '', - 'PidLidNonSendToTrackStatus' => '', - 'PidLidNonSendCcTrackStatus' => '', - 'PidLidNonSendBccTrackStatus' => '', - 'PidLidAppointmentUnsendableRecipients' => '', - 'PidLidAppointmentNotAllowPropose' => '', // @TODO: X-MICROSOFT-CDO-DISALLOW-COUNTER - 'PidLidGlobalObjectId' => '', - 'PidLidCleanGlobalObjectId' => '', - 'PidTagOwnerAppointmentId' => '', // @TODO: X-MICROSOFT-CDO-OWNERAPPTID - 'PidTagStartDate' => '', - 'PidTagEndDate' => '', - 'PidLidCommonStart' => '', - 'PidLidCommonEnd' => '', - 'PidLidOwnerCriticalChange' => '', // @TODO: X-MICROSOFT-CDO-CRITICAL-CHANGE - 'PidLidIsException' => '', - 'PidTagResponseRequested' => '', - 'PidTagReplyRequested' => '', - 'PidLidTimeZoneStruct' => '', - 'PidLidTimeZoneDescription' => '', - 'PidLidAppointmentTimeZoneDefinitionRecur' => '', - 'PidLidAppointmentTimeZoneDefinitionStartDisplay' => '', - 'PidLidAppointmentTimeZoneDefinitionEndDisplay' => '', - 'PidLidAppointmentRecur' => '', - 'PidLidRecurrenceType' => '', - 'PidLidRecurrencePattern' => '', - 'PidLidLinkedTaskItems' => '', - 'PidLidMeetingWorkspaceUrl' => '', - 'PidTagIconIndex' => '', - 'PidLidAppointmentColor' => '', + 'PidLidAppointmentSequence' => 'sequence', // PtypInteger32 + 'PidLidBusyStatus' => '', // PtypInteger32, @TODO: X-MICROSOFT-CDO-BUSYSTATUS + 'PidLidAppointmentAuxiliaryFlags' => '', // PtypInteger32 + 'PidLidLocation' => 'location', // PtypString + 'PidLidAppointmentStartWhole' => 'dtstart', // PtypTime, UTC + 'PidLidAppointmentEndWhole' => 'dtend', // PtypTime, UTC + 'PidLidAppointmentDuration' => '', // PtypInteger32, optional + 'PidNameKeywords' => 'categories', // PtypMultipleString + 'PidLidAppointmentSubType' => '', // PtypBoolean + 'PidLidAppointmentStateFlags' => '', // PtypInteger32 + 'PidLidResponseStatus' => '', // PtypInteger32 + 'PidLidRecurring' => '', // PtypBoolean + 'PidLidIsRecurring' => '', // PtypBoolean + 'PidLidClipStart' => '', // PtypTime + 'PidLidClipEnd' => '', // PtypTime + 'PidLidAllAttendeesString' => '', // PtypString + 'PidLidToAttendeesString' => '', // PtypString + 'PidLidCCAttendeesString' => '', // PtypString + 'PidLidNonSendableTo' => '', // PtypString + 'PidLidNonSendableCc' => '', // PtypString + 'PidLidNonSendableBcc' => '', // PtypString + 'PidLidNonSendToTrackStatus' => '', // PtypMultipleInteger32 + 'PidLidNonSendCcTrackStatus' => '', // PtypMultipleInteger32 + 'PidLidNonSendBccTrackStatus' => '', // PtypMultipleInteger32 + 'PidLidAppointmentUnsendableRecipients' => '', // PtypBinary, optional + 'PidLidAppointmentNotAllowPropose' => '', // PtypBoolean, @TODO: X-MICROSOFT-CDO-DISALLOW-COUNTER + 'PidLidGlobalObjectId' => '', // PtypBinary + 'PidLidCleanGlobalObjectId' => '', // PtypBinary + 'PidTagOwnerAppointmentId' => '', // PtypInteger32, @TODO: X-MICROSOFT-CDO-OWNERAPPTID + 'PidTagStartDate' => '', // PtypTime + 'PidTagEndDate' => '', // PtypTime + 'PidLidCommonStart' => '', // PtypTime + 'PidLidCommonEnd' => '', // PtypTime + 'PidLidOwnerCriticalChange' => '', // PtypTime, @TODO: X-MICROSOFT-CDO-CRITICAL-CHANGE + 'PidLidIsException' => '', // PtypBoolean + 'PidTagResponseRequested' => '', // PtypBoolean + 'PidTagReplyRequested' => '', // PtypBoolean + 'PidLidTimeZoneStruct' => '', // PtypBinary + 'PidLidTimeZoneDescription' => '', // PtypString + 'PidLidAppointmentTimeZoneDefinitionRecur' => '', // PtypBinary + 'PidLidAppointmentTimeZoneDefinitionStartDisplay' => '', // PtypBinary + 'PidLidAppointmentTimeZoneDefinitionEndDisplay' => '', // PtypBinary + 'PidLidAppointmentRecur' => '', // PtypBinary + 'PidLidRecurrenceType' => '', // PtypInteger32 + 'PidLidRecurrencePattern' => '', // PtypString + 'PidLidLinkedTaskItems' => '', // PtypMultipleBinary + 'PidLidMeetingWorkspaceUrl' => '', // PtypString + 'PidTagIconIndex' => '', // PtypInteger32 + 'PidLidAppointmentColor' => '', // PtypInteger32 'PidLidAppointmentReplyTime' => '', // @TODO: X-MICROSOFT-CDO-REPLYTIME 'PidLidIntendedBusyStatus' => '', // @TODO: X-MICROSOFT-CDO-INTENDEDSTATUS // calendar object properties [MS-OXOCAL] 'PidTagMessageClass' => '', - 'PidLidSideEffects' => '', - 'PidLidFExceptionAttendees' => '', - 'PidLidClientIntent' => '', + 'PidLidSideEffects' => '', // PtypInteger32 + 'PidLidFExceptionAttendees' => '', // PtypBoolean + 'PidLidClientIntent' => '', // PtypInteger32 // common props [MS-OXCMSG] 'PidTagSubject' => 'summary', 'PidTagBody' => 'description', 'PidTagHtml' => '', // @TODO: (?) 'PidTagNativeBody' => '', 'PidTagBodyHtml' => '', 'PidTagRtfCompressed' => '', 'PidTagInternetCodepage' => '', 'PidTagContentId' => '', 'PidTagBodyContentLocation' => '', 'PidTagImportance' => 'priority', 'PidTagSensitivity' => 'class', 'PidLidPrivate' => '', + 'PidTagCreationTime' => 'created', 'PidTagLastModificationTime' => 'dtstamp', // reminder properties [MS-OXORMDR] + 'PidLidReminderSet' => '', // PtypBoolean + 'PidLidReminderSignalTime' => '', // PtypTime + 'PidLidReminderDelta' => '', // PtypInteger32 + 'PidLidReminderTime' => '', // PtypTime + 'PidLidReminderOverride' => '', // PtypBoolean + 'PidLidReminderPlaySound' => '', // PtypBoolean + 'PidLidReminderFileParameter' => '', // PtypString + 'PidTagReplyTime' => '', // PtypTime + 'PidLidReminderType' => '', // PtypInteger32 ); protected $recipient_track_status_map = array( 'TENTATIVE' => 0x00000002, 'ACCEPTED' => 0x00000003, 'DECLINED' => 0x00000004, ); protected $recipient_type_map = array( 'NON-PARTICIPANT' => 0x00000004, 'OPT-PARTICIPANT' => 0x00000002, 'REQ-PARTICIPANT' => 0x00000002, 'CHAIR' => 0x00000001, ); /** * Message importance for PidTagImportance as defined in [MS-OXCMSG] */ protected $importance = array( 0 => 0x00000000, 1 => 0x00000002, 2 => 0x00000002, 3 => 0x00000002, 4 => 0x00000002, 5 => 0x00000001, 6 => 0x00000000, 7 => 0x00000000, 8 => 0x00000000, 9 => 0x00000000, ); /** * Message sesnitivity for PidTagSensitivity as defined in [MS-OXCMSG] */ protected $sensitivity = array( 'public' => 0x00000000, 'personal' => 0x00000001, 'private' => 0x00000002, 'confidential' => 0x00000003, ); /** * Mapping of weekdays */ protected $recurrence_day_map = array( 'SU' => 0x00000000, 'MO' => 0x00000001, 'TU' => 0x00000002, 'WE' => 0x00000003, 'TH' => 0x00000004, 'FR' => 0x00000005, 'SA' => 0x00000006, 'BYDAY-SU' => 0x00000001, 'BYDAY-MO' => 0x00000002, 'BYDAY-TU' => 0x00000004, 'BYDAY-WE' => 0x00000008, 'BYDAY-TH' => 0x00000010, 'BYDAY-FR' => 0x00000020, 'BYDAY-SA' => 0x00000040, ); /** * Convert Kolab to MAPI * * @param array Data * @param array Context (folder_uid, object_uid, object) * * @return array Data */ public function output($data, $context = null) { $result = array( 'PidTagMessageClass' => 'IPM.Appointment', // mapistore REST API specific properties 'collection' => 'calendars', ); foreach ($this->map as $mapi_idx => $kolab_idx) { if (empty($kolab_idx)) { continue; } $value = kolab_api_filter_mapistore::get_kolab_value($data, $kolab_idx); if ($value === null) { continue; } switch ($mapi_idx) { case 'PidNameKeywords': $value = kolab_api_filter_mapistore::parse_categories((array) $value); break; case 'PidTagSensitivity': $value = (int) $this->sensitivity[strtolower($value)]; break; case 'PidTagCreationTime': case 'PidTagLastModificationTime': $value = kolab_api_filter_mapistore::date_php2mapi($value, true); break; case 'PidTagImportance': $value = (int) $this->importance[(int) $value]; break; case 'PidLidAppointmentStartWhole': case 'PidLidAppointmentEndWhole': $dt = kolab_api_input_json::to_datetime($value); $value = kolab_api_filter_mapistore::date_php2mapi($dt, true); // PidLidAppointmentTimeZoneDefinitionStartDisplay // PidLidAppointmentTimeZoneDefinitionEndDisplay // this is all-day event if ($dt->_dateonly) { $result['PidLidAppointmentSubType'] = 0x00000001; } break; } $result[$mapi_idx] = $value; } // Organizer if (!empty($data['organizer'])) { $this->add_attendee_to_result($data['organizer'], $result, true); } // Attendees [MS-OXCICAL 2.1.3.1.1.20.2] foreach ((array) $data['attendee'] as $attendee) { $this->add_attendee_to_result($attendee, $result); } // Alarms (MAPI supports only one) foreach ((array) $data['valarm'] as $alarm) { if ($alarm['properties'] && $alarm['properties']['action'] == 'DISPLAY' && ($duration = $alarm['properties']['trigger']['duration']) && ($delta = self::reminder_duration_to_delta($duration)) ) { $result['PidLidReminderDelta'] = $delta; $result['PidLidReminderSet'] = true; // PidLidReminderTime // PidLidReminderSignalTime break; } } // Recurrence rule if (!empty($data['rrule']) && !empty($data['rrule']['recur'])) { if ($rule = $this->recurrence_from_kolab($data['rrule']['recur'])) { $result['PidLidAppointmentRecur'] = $rule; } } // @TODO: PidLidAppointmentDuration // @TODO: exceptions, resources kolab_api_filter_mapistore::parse_common_props($result, $data, $context); return $result; } /** * Convert from MAPI to Kolab * * @param array Data * @param array Data of the object that is being updated * * @return array Data */ public function input($data, $object = null) { $result = array(); foreach ($this->map as $mapi_idx => $kolab_idx) { if (empty($kolab_idx)) { continue; } if (!array_key_exists($mapi_idx, $data)) { continue; } $value = $data[$mapi_idx]; switch ($mapi_idx) { case 'PidTagImportance': $map = array( 0x00000002 => 1, 0x00000001 => 5, 0x00000000 => 9, ); $value = (int) $map[(int) $value]; break; case 'PidTagSensitivity': $map = array_flip($this->sensitivity); $value = $map[$value]; break; case 'PidTagCreationTime': case 'PidTagLastModificationTime': if ($value) { $value = kolab_api_filter_mapistore::date_mapi2php($value); $value = $value->format('Y-m-d\TH:i:s\Z'); } break; case 'PidLidAppointmentStartWhole': case 'PidLidAppointmentEndWhole': if ($value) { $value = kolab_api_filter_mapistore::date_mapi2php($value); $format = $data['PidLidAppointmentSubType'] ? 'Y-m-d' : 'Y-m-d\TH:i:s\Z'; $value = $value->format($format); } break; } $result[$kolab_idx] = $value; } // Alarms (MAPI supports only one, DISPLAY) if ($data['PidLidReminderSet'] && ($delta = $data['PidLidReminderDelta'])) { $duration = self::reminder_delta_to_duration($delta); $alarm = array( 'action' => 'DISPLAY', 'trigger' => array('duration' => $duration), 'description' => 'Reminder', ); $result['valarm'] = array(array('properties' => $alarm)); } else if (array_key_exists('PidLidReminderSet', $data) || array_key_exists('PidLidReminderDelta', $data)) { $result['valarm'] = array(); } // @TODO: PidLidAppointmentDuration (?) // @TODO: exceptions, resources, recurrence, attendees - kolab_api_filter_mapistore::convert_common_props($result, $data); + kolab_api_filter_mapistore::convert_common_props($result, $data, $object); return $result; } /** * Returns the attributes names mapping */ public function map() { $map = array_filter($this->map); // @TODO: add properties that are not in the map $map['PidLidAppointmentRecur'] = 'rrule'; return $map; } /** * Setting PidTagRecipientType according to [MS-OXCICAL 2.1.3.1.1.20.2] */ protected function to_recipient_type($cutype, $role) { if ($cutype && in_array($cutype, array('RESOURCE', 'ROOM'))) { return 0x00000003; } if ($role && ($type = $this->recipient_type_map[$role])) { return $type; } return 0x00000001; } /** * Convert Kolab 'attendee' specification into MAPI recipient * and add it to the result */ protected function add_attendee_to_result($attendee, &$result, $is_organizer = false) { $email = $attendee['cal-address']; $params = (array) $attendee['parameters']; // parse mailto string if (strpos($email, 'mailto:') === 0) { $email = urldecode(substr($email, 7)); } $emails = rcube_mime::decode_address_list($email, 1); if (!empty($email)) { $email = $emails[key($emails)]; $recipient = array( 'PidTagAddressType' => 'SMTP', 'PidTagDisplayName' => $params['cn'] ?: $email['name'], 'PidTagDisplayType' => 0, 'PidTagEmailAddress' => $email['mailto'], ); if ($is_organizer) { $recipient['PidTagRecipientFlags'] = 0x00000003; $recipient['PidTagRecipientType'] = 0x00000001; } else { $recipient['PidTagRecipientFlags'] = 0x00000001; $recipient['PidTagRecipientTrackStatus'] = (int) $this->recipient_track_status_map[$params['partstat']]; $recipient['PidTagRecipientType'] = $this->to_recipient_type($params['cutype'], $params['role']); } // PidTagEntryId // PidTagRecipientEntryId $recipient['PidTagRecipientDisplayName'] = $recipient['PidTagDisplayName']; $result['recipients'][] = $recipient; if (strtoupper($params['rsvp']) == 'TRUE') { $result['PidTagReplyRequested'] = true; $result['PidTagResponseRequested'] = true; } } } /** * Convert PidLidReminderDelta value into xCal duration */ protected static function reminder_delta_to_duration($delta) { if ($delta == 0x5AE980E1) { $delta = 15; } $delta = (int) $delta; return "-PT{$delta}M"; } /** * Convert Kolab alarm duration into PidLidReminderDelta */ protected static function reminder_duration_to_delta($duration) { if ($duration && preg_match('/^-[PT]*([0-9]+)([WDHMS])$/', $duration, $matches)) { $value = intval($matches[1]); switch ($matches[2]) { case 'S': $value = intval(round($value/60)); break; case 'H': $value *= 60; break; case 'D': $value *= 24 * 60; break; case 'W': $value *= 7 * 24 * 60; break; } return $value; } } /** * Convert Kolab recurrence specification into MAPI properties */ protected function recurrence_from_kolab($rule) { $result = array( 'ReaderVersion' => 0x3004, 'WriterVersion' => 0x3004, 'ReaderVersion2' => 0x00003006, 'WriterVersion2' => 0x00003009, 'Period' => $rule['interval'] ? $rule['interval'] : 1, 'SlidingFlag' => 0, 'FirstDOW' => $this->day2bitmask($rule['wkst']), 'StartTimeOffset' => 60 * intval($rule['byhour']) + intval($rule['byminute']), 'EndType' => 0x00002021, 'OccurenceCount' => 0x0000000A, 'EndDate' => 0x5AE980DF, // @TODO 'CalendarType' => 0x0001, // EndTimeOffset // FirstDateTime // ExceptionCount, ExceptionInfo // ReservedBlocks, ExtendedExceptions // DeletedInstanceCount, DeletedInstanceDates // ModifiedInstanceCount, ModifiedInstanceDates ); switch ($rule['freq']) { case 'DAILY': $result['RecurFrequency'] = 0x200A; $result['PatternType'] = 0x000; $result['Period'] *= 1440; break; case 'WEEKLY': $result['RecurFrequency'] = 0x200B; $result['PatternType'] = 0x0001; $result['PatternTypeSpecific.Week.Sa-Su'] = $this->day2bitmask($rule['byday'], 'BYDAY-'); break; case 'MONTHLY': $result['RecurFrequency'] = 0x200C; $result['PatternType'] = 0x0002; if (!empty($rule['bymonthday'])) { // @TODO: MAPI doesn't support multi-valued month days $month_day = array_shift(explode(',', $rule['bymonthday'])); $result['PatternTypeSpecific.Month.Day'] = $month_day == -1 ? 0x0000001F : $month_day; } else { $result['PatternTypeSpecific.MonthNth.Sa-Su'] = $this->day2bitmask($rule['byday'], 'BYDAY-');; if (!empty($rule['bysetpos'])) { $result['PatternTypeSpecific.MonthNth.N'] = $rule['bysetpos'] == -1 ? 0x00000005 : $rule['bysetpos']; } } break; case 'YEARLY': $result['RecurFrequency'] = 0x200D; $result['PatternType'] = 0x0002; $result['Period'] *= 12; // @TODO: MAPI doesn't support multi-valued months $month = array_shift(explode(',', $rule['bymonth'])); // @TODO: StartDate/EndDate if (!empty($rule['bymonthday'])) { // @TODO: MAPI doesn't support multi-valued month days $month_day = array_shift(explode(',', $rule['bymonthday'])); $result['PatternTypeSpecific.Month.Day'] = $month_day == -1 ? 0x0000001F : $month_day; } else { $result['PatternType'] = 0x0003; $result['PatternTypeSpecific.MonthNth.Sa-Su'] = $this->day2bitmask($rule['byday'], 'BYDAY-');; if (!empty($rule['bysetpos'])) { $result['PatternTypeSpecific.MonthNth.N'] = $rule['bysetpos'] == -1 ? 0x00000005 : $rule['bysetpos']; } } break; } if (!empty($rule['until'])) { // $recurrence['until'] = self::date_from_kolab($rule['until']); // @TODO: calculate OccurenceCount? $result['EndType'] = 0x00002023; } else if (!empty($rule['count'])) { $result['EndType'] = 0x00002022; $result['OccurenceCount'] = $rule['count']; } return $result; } /** * Converts string of days (TU,TH) to bitmask used by MAPI * * @param string $days * * @return int */ protected function day2bitmask($days, $prefix = '') { $days = explode(',', $days); $result = 0; foreach ($days as $day) { $result = $result + $this->recurrence_day_map[$prefix.$day]; } return $result; } /** * Convert bitmask used by MAPI to string of days (TU,TH) * * @param int $days * * @return string */ protected function bitmask2day($days) { $days_arr = array(); foreach ($this->recurrence_day_map as $day => $bit) { if ($days & $bit) { $days_arr[] = preg_replace('/^[A-Z-]+/', '', $day); } } $result = implode(',', $days_arr); return $result; } } diff --git a/lib/filter/mapistore/folder.php b/lib/filter/mapistore/folder.php index 1fe369c..cadb8fc 100644 --- a/lib/filter/mapistore/folder.php +++ b/lib/filter/mapistore/folder.php @@ -1,167 +1,167 @@ | +--------------------------------------------------------------------------+ | Author: Aleksander Machniak | +--------------------------------------------------------------------------+ */ class kolab_api_filter_mapistore_folder { protected $map = array( // read-only properties 'PidTagAccess' => '', 'PidTagChangeKey' => '', - 'PidTagCreationTime' => '', // @TODO: store in folder annotation? - 'PidTagLastodificationTime' => '', - 'PidTagContentCount' => '', - 'PidTagContentUnreadCount' => '', - 'PidTagDeletedOn' => '', -// 'PidTagAddressbookEntryId' => '', - 'PidTagFolderId' => '', // PtypInteger64 - 'PidTagHierarchyChangeNumber' => '', // number of subfolders - 'PidTagMessageSize' => '', // size of all messages - 'PidTagMessageSizeExtended' => '', - 'PidTagSubfolders' => '', // bool - 'PidTagLocalCommitTime' => '', // last change time in UTC - 'PidTagLocalCommitTimeMax' => '', - 'PidTagDeletedCountTotal' => '', + 'PidTagCreationTime' => '', // PtypTime, @TODO: store in folder annotation? + 'PidTagLastodificationTime' => '', // PtypTime + 'PidTagContentCount' => '', // PtypInteger32 + 'PidTagContentUnreadCount' => '', // PtypInteger32 + 'PidTagDeletedOn' => '', // PtypTime +// 'PidTagAddressbookEntryId' => '', // PtypBinary + 'PidTagFolderId' => '', // PtypInteger64 + 'PidTagHierarchyChangeNumber' => '', // PtypInteger32, number of subfolders + 'PidTagMessageSize' => '', // PtypInteger32, size of all messages + 'PidTagMessageSizeExtended' => '', // PtypInteger64 + 'PidTagSubfolders' => '', // PtypBoolean + 'PidTagLocalCommitTime' => '', // PtypTime, last change time in UTC + 'PidTagLocalCommitTimeMax' => '', // PtypTime + 'PidTagDeletedCountTotal' => '', // PtypInteger32 // read-write properties - 'PidTagAttributeHidden' => '', // bool - 'PidTagComment' => '', // @TODO: store in folder annotation? - 'PidTagContainerClass' => 'type', // IPF.* - 'PidTagContainerHierarchy' => '', - 'PidTagDisplayName' => 'name', - 'PidTagFolderAssociatedContents' => '', - 'PidTagFolderType' => '', // 0 - namespace roots, 1 - other, 2 - virtual/search folders - 'PidTagRights' => '', - 'PidTagAccessControlListData' => '', // see [MS-OXCPERM] + 'PidTagAttributeHidden' => '', // Ptypboolean + 'PidTagComment' => '', // PtypString, @TODO: store in folder annotation? + 'PidTagContainerClass' => 'type', // PtypString, IPF.* + 'PidTagContainerHierarchy' => '', // PtypObject + 'PidTagDisplayName' => 'name', // PtypString + 'PidTagFolderAssociatedContents' => '', // PtypObject + 'PidTagFolderType' => '', // PtypInteger32, 0 - namespace roots, 1 - other, 2 - virtual/search folders + 'PidTagRights' => '', // PtypInteger32 + 'PidTagAccessControlListData' => '', // PtypBinary, see [MS-OXCPERM] ); protected $type_map = array( '' => 'IPF.Note', 'mail' => 'IPF.Note', 'task' => 'IPF.Task', 'note' => 'IPF.StickyNote', 'event' => 'IPF.Appointment', 'journal' => 'IPF.Journal', 'contact' => 'IPF.Contact', ); /** * Convert Kolab to MAPI * * @param array Data * @param array Context (folder_uid, object_uid, object) * * @return array Data */ public function output($data, $context = null) { list($type, ) = explode('.', $data['type']); $type = $this->type_map[(string)$type]; // skip folders of unsupported type if (empty($type)) { return; } // skip folders that are not subfolders of the specified folder, // in list-mode MAPI always requests for one-level of the hierarchy (?) if ($api->input->path[1] == 'folders') { $api = kolab_api::get_instance(); $parent = !empty($api->input->path) ? $api->input->path[0] : ''; if ($data['parent'] != $parent) { return; } } $result = array( // mapistore properties 'id' => $data['uid'], // MAPI properties 'PidTagFolderType' => 1, 'PidTagDisplayName' => $data['name'], 'PidTagContainerClass' => $type, ); if ($data['parent']) { $result['parent_id'] = $data['parent']; } $result = array_filter($result, function($v) { return $v !== null; }); return $result; } /** * Convert from MAPI to Kolab * * @param array Data * @param array Data of the object that is being updated * * @return array Data */ public function input($data, $object = null) { $result = array(); // mapistore properties if ($data['id']) { $result['uid'] = $data['id']; } if ($data['parent_id']) { $result['parent'] = $data['parent_id']; } // MAPI properties if ($data['PidTagDisplayName']) { $result['name'] = $data['PidTagDisplayName']; } if ($data['PidTagContainerClass']) { // @TODO: what if folder is already a *.default or *.sentitems, etc. // we should keep the subtype intact $map = array_flip($this->type_map); $result['type'] = $map[$data['PidTagContainerClass']]; } return $result; } /** * Returns the attributes names mapping */ public function map() { $map = array_filter($this->map); $map['parent_id'] = 'parent'; $map['PidTagContainerClass'] = 'type'; $map['PidTagFolderType'] = 'PidTagFolderType'; return $map; } } diff --git a/lib/filter/mapistore/note.php b/lib/filter/mapistore/note.php index 5414716..12ddef0 100644 --- a/lib/filter/mapistore/note.php +++ b/lib/filter/mapistore/note.php @@ -1,142 +1,139 @@ | +--------------------------------------------------------------------------+ | Author: Aleksander Machniak | +--------------------------------------------------------------------------+ */ class kolab_api_filter_mapistore_note { protected $map = array( // note specific props [MS-OXNOTE] - 'PidLidNoteColor' => '', // @TODO: X-? - 'PidLidNoteHeight' => '', // @TODO: X-? - 'PidLidNoteWidth' => '', // @TODO: X-? - 'PidLidNoteX' => '', // @TODO: X-? - 'PidLidNoteY' => '', // @TODO: X-? + 'PidLidNoteColor' => 'x-custom.MAPI:PidLidNoteColor', // PtypInteger32 + 'PidLidNoteHeight' => 'x-custom.MAPI:PidLidNoteHeight', // PtypInteger32 + 'PidLidNoteWidth' => 'x-custom.MAPI:PidLidNoteWidth', // PtypInteger32 + 'PidLidNoteX' => 'x-custom.MAPI:PidLidNoteX', // PtypInteger32 + 'PidLidNoteY' => 'x-custom.MAPI:PidLidNoteY', // PtypInteger32 // common props [MS-OXCMSG] 'PidTagBody' => 'description', 'PidTagHtml' => '', // @TODO: (?) 'PidTagMessageClass' => '', 'PidTagSubject' => 'summary', 'PidTagNormalizedSubject' => '', // @TODO: abbreviated note body 'PidTagIconIndex' => '', // @TODO: depends on PidLidNoteColor ); protected $color_map = array( '0000FF' => 0x00000000, // blue '008000' => 0x00000001, // green 'FFC0CB' => 0x00000002, // pink 'FFFF00' => 0x00000003, // yellow 'FFFFFF' => 0x00000004, // white ); /** * Convert Kolab to MAPI * * @param array Data * @param array Context (folder_uid, object_uid, object) * * @return array Data */ public function output($data, $context = null) { $result = array( 'PidTagMessageClass' => 'IPM.StickyNote', // notes do not have attachments in MAPI // 'PidTagHasAttachments' => 0, // mapistore REST API specific properties 'collection' => 'notes', ); foreach ($this->map as $mapi_idx => $kolab_idx) { if (empty($kolab_idx)) { continue; } $value = kolab_api_filter_mapistore::get_kolab_value($data, $kolab_idx); - switch ($kolab_idx) { -/* - Color property is not supported by Kolab format anymore (see #2918) - case 'color': - if ($value) { - $value = strtoupper($value); - $value = str_replace('#', '', $value); - $value = isset($this->color_map[$value]) ? $this->color_map[$value] : null; - } - break; -*/ - } - if ($value === null) { continue; } + switch ($mapi_idx) { + case 'PidLidNoteColor': + case 'PidLidNoteHeight': + case 'PidLidNoteWidth': + case 'PidLidNoteX': + case 'PidLidNoteY': + $value = (int) $value; + break; + } + $result[$mapi_idx] = $value; } kolab_api_filter_mapistore::parse_common_props($result, $data, $context); return $result; } /** * Convert from MAPI to Kolab * * @param array Data * @param array Data of the object that is being updated * * @return array Data */ public function input($data, $object = null) { $result = array(); foreach ($this->map as $mapi_idx => $kolab_idx) { if (empty($kolab_idx)) { continue; } if (!array_key_exists($mapi_idx, $data)) { continue; } $value = $data[$mapi_idx]; $result[$kolab_idx] = $value; } - kolab_api_filter_mapistore::convert_common_props($result, $data); + kolab_api_filter_mapistore::convert_common_props($result, $data, $object); return $result; } /** * Returns the attributes names mapping */ public function map() { $map = array_filter($this->map); return $map; } } diff --git a/lib/filter/mapistore/task.php b/lib/filter/mapistore/task.php index a7c808b..5613845 100644 --- a/lib/filter/mapistore/task.php +++ b/lib/filter/mapistore/task.php @@ -1,251 +1,259 @@ | +--------------------------------------------------------------------------+ | Author: Aleksander Machniak | +--------------------------------------------------------------------------+ */ class kolab_api_filter_mapistore_task { protected $map = array( // task specific props [MS-OXOTASK] - 'PidLidTaskMode' => '', // ignored - 'PidLidTaskStatus' => '', - 'PidLidPercentComplete' => 'percent-complete', - 'PidLidTaskStartDate' => 'dtstart', // PtypTime - 'PidLidTaskDueDate' => 'due', // PtypTime - 'PidLidTaskResetReminder' => '', // @TODO - 'PidLidTaskAccepted' => '', // @TODO - 'PidLidTaskDeadOcuurence' => '', // @TODO - 'PidLidTaskDateCompleted' => '', // @TODO: X-? - 'PidLidTaskLastUpdate' => '', // PtypTime - 'PidLidTaskActualEffort' => '', // @TODO: X-? - 'PidLidTaskEstimatedEffort' => '', // @TODO: X-? - 'PidLidTaskVersion' => '', - 'PidLidTaskState' => '', - 'PidLidTaskRecurrence' => '', // @TODO - 'PidLidTaskAssigners' => '', - 'PidLidTaskStatusOnComplete' => '', - 'PidLidTaskHistory' => '', // @TODO: ? - 'PidLidTaskUpdates' => '', - 'PidLidTaskComplete' => '', - 'PidLidTaskFCreator' => '', - 'PidLidTaskOwner' => '', // @TODO - 'PidLidTaskMultipleRecipients' => '', - 'PidLidTaskAssigner' => '', - 'PidLidTaskLastUser' => '', - 'PidLidTaskOrdinal' => '', - 'PidLidTaskLastDelegate' => '', - 'PidLidTaskFRecurring' => '', - 'PidLidTaskOwnership' => '', // @TODO - 'PidLidTaskAcceptanceState' => '', - 'PidLidTaskFFixOffline' => '', - 'PidLidTaskGlobalId' => '', // @TODO - 'PidLidTaskCustomFlags' => '', // ignored - 'PidLidTaskRole' => '', // ignored - 'PidLidTaskNoCompute' => '', // ignored - 'PidLidTeamTask' => '', // ignored + 'PidTagProcessed' => '', // PtypBoolean + 'PidLidTaskMode' => '', // ignored + 'PidLidTaskStatus' => '', // PtypInteger32 + 'PidLidPercentComplete' => 'percent-complete', // PtypFloating64 + 'PidLidTaskStartDate' => 'dtstart', // PtypTime + 'PidLidTaskDueDate' => 'due', // PtypTime + 'PidLidTaskResetReminder' => '', // @TODO // PtypBoolean + 'PidLidTaskAccepted' => '', // @TODO // PtypBoolean + 'PidLidTaskDeadOccurrence' => '', // @TODO // PtypBoolean + 'PidLidTaskDateCompleted' => 'x-custom.MAPI:PidLidTaskDateCompleted', // PtypTime + 'PidLidTaskLastUpdate' => '', // PtypTime + 'PidLidTaskActualEffort' => 'x-custom.MAPI:PidLidTaskActualEffort', // PtypInteger32 + 'PidLidTaskEstimatedEffort' => 'x-custom.MAPI:PidLidTaskEstimatedEffort', // PtypInteger32 + 'PidLidTaskVersion' => '', // PtypInteger32 + 'PidLidTaskState' => '', // PtypInteger32 + 'PidLidTaskRecurrence' => '', // @TODO // PtypBinary + 'PidLidTaskAssigners' => '', // PtypBinary + 'PidLidTaskStatusOnComplete' => '', // PtypBoolean + 'PidLidTaskHistory' => '', // @TODO: ? // PtypInteger32 + 'PidLidTaskUpdates' => '', // PtypBoolean + 'PidLidTaskComplete' => '', // PtypBoolean + 'PidLidTaskFCreator' => '', // PtypBoolean + 'PidLidTaskOwner' => '', // @TODO // PtypString + 'PidLidTaskMultipleRecipients' => '', // PtypBoolean + 'PidLidTaskAssigner' => '', // PtypString + 'PidLidTaskLastUser' => '', // PtypString + 'PidLidTaskOrdinal' => '', // PtypInteger32 + 'PidLidTaskLastDelegate' => '', // PtypString + 'PidLidTaskFRecurring' => '', // PtypBoolean + 'PidLidTaskOwnership' => '', // @TODO // PtypInteger32 + 'PidLidTaskAcceptanceState' => '', // PtypInteger32 + 'PidLidTaskFFixOffline' => '', // PtypBoolean + 'PidLidTaskGlobalId' => '', // @TODO // PtypBinary + 'PidLidTaskCustomFlags' => '', // ignored + 'PidLidTaskRole' => '', // ignored + 'PidLidTaskNoCompute' => '', // ignored + 'PidLidTeamTask' => '', // ignored // common props [MS-OXCMSG] 'PidTagSubject' => 'summary', 'PidTagBody' => 'description', 'PidTagHtml' => '', // @TODO: (?) 'PidTagNativeBody' => '', 'PidTagBodyHtml' => '', 'PidTagRtfCompressed' => '', 'PidTagInternetCodepage' => '', - 'PidTagContentId' => '', - 'PidTagBodyContentLocation' => '', 'PidTagMessageClass' => '', 'PidLidCommonStart' => 'dtstart', 'PidLidCommonEnd' => 'due', 'PidTagIconIndex' => '', // @TODO 'PidTagCreationTime' => 'created', // PtypTime, UTC 'PidTagLastModificationTime' => 'dtstamp', // PtypTime, UTC ); /** * Values for PidLidTaskStatus property */ protected $status_map = array( 'none' => 0x00000000, // PidLidPercentComplete = 0 'in-progress' => 0x00000001, // PidLidPercentComplete > 0 and PidLidPercentComplete < 1 'complete' => 0x00000002, // PidLidPercentComplete = 1 'waiting' => 0x00000003, 'deferred' => 0x00000004, ); /** * Values for PidLidTaskHistory property */ protected $history_map = array( 'none' => 0x00000000, 'accepted' => 0x00000001, 'rejected' => 0x00000002, 'changed' => 0x00000003, 'due-changed' => 0x00000004, 'assigned' => 0x00000005, ); /** * Convert Kolab to MAPI * * @param array Data * @param array Context (folder_uid, object_uid, object) * * @return array Data */ public function output($data, $context = null) { $result = array( 'PidTagMessageClass' => 'IPM.Task', // mapistore REST API specific properties 'collection' => 'tasks', ); foreach ($this->map as $mapi_idx => $kolab_idx) { if (empty($kolab_idx)) { continue; } $value = kolab_api_filter_mapistore::get_kolab_value($data, $kolab_idx); + if ($value === null) { + continue; + } + switch ($mapi_idx) { case 'PidLidPercentComplete': $value /= 100; break; case 'PidLidTaskStartDate': case 'PidLidTaskDueDate': $value = kolab_api_filter_mapistore::date_php2mapi($value, false, array('hour' => 0)); break; case 'PidLidCommonStart': case 'PidLidCommonEnd': $value = kolab_api_filter_mapistore::date_php2mapi($value, true); break; // case 'PidLidTaskLastUpdate': case 'PidTagCreationTime': case 'PidTagLastModificationTime': $value = kolab_api_filter_mapistore::date_php2mapi($value, true); break; + + case 'PidLidTaskActualEffort': + case 'PidLidTaskEstimatedEffort': + $value = (int) $value; + break; } if ($value === null) { continue; } $result[$mapi_idx] = $value; } // set status $percent = $result['PidLidPercentComplete']; if ($precent == 1) { $result['PidLidTaskStatus'] = $this->status_map['complete']; // PidLidTaskDateCompleted } else if ($precent > 0) { $result['PidLidTaskStatus'] = $this->status_map['in-progress']; } else { $result['PidLidTaskStatus'] = $this->status_map['none']; } // @TODO: recurrence kolab_api_filter_mapistore::parse_common_props($result, $data, $context); return $result; } /** * Convert from MAPI to Kolab * * @param array Data * @param array Data of the object that is being updated * * @return array Data */ public function input($data, $object = null) { $result = array(); foreach ($this->map as $mapi_idx => $kolab_idx) { if (empty($kolab_idx)) { continue; } - $value = $data[$mapi_idx]; - - if ($value === null) { + if (!array_key_exists($mapi_idx, $data)) { continue; } + $value = $data[$mapi_idx]; + switch ($mapi_idx) { case 'PidLidPercentComplete': $value = intval($value * 100); break; case 'PidLidTaskStartDate': case 'PidLidTaskDueDate': if (intval($value) !== 0x5AE980E0) { $value = kolab_api_filter_mapistore::date_mapi2php($value); $value = $value->format('Y-m-d'); } break; case 'PidLidCommonStart': case 'PidLidCommonEnd': // $value = kolab_api_filter_mapistore::date_mapi2php($value, true); break; case 'PidTagCreationTime': case 'PidTagLastModificationTime': if ($value) { $value = kolab_api_filter_mapistore::date_mapi2php($value); $value = $value->format('Y-m-d\TH:i:s\Z'); } break; } $result[$kolab_idx] = $value; } if ($data['PidLidTaskComplete']) { $result['status'] = 'COMPLETED'; } - kolab_api_filter_mapistore::convert_common_props($result, $data); + kolab_api_filter_mapistore::convert_common_props($result, $data, $object); return $result; } /** * Returns the attributes names mapping */ public function map() { $map = array_filter($this->map); return $map; } } diff --git a/lib/input/json.php b/lib/input/json.php index 20a3807..ec025a1 100644 --- a/lib/input/json.php +++ b/lib/input/json.php @@ -1,127 +1,148 @@ | +--------------------------------------------------------------------------+ | Author: Aleksander Machniak | +--------------------------------------------------------------------------+ */ class kolab_api_input_json extends kolab_api_input { /** * Get request data (JSON) * * @param string Expected object type * @param bool Disable filters application * @param array Original object data (set on update requests) * * @return array Request data */ public function input($type = null, $disable_filters = false, $original = null) { if ($this->input_body === null) { $data = file_get_contents('php://input'); $data = trim($data); $data = json_decode($data, true); $this->input_body = $data; } if (!$disable_filters) { if ($this->filter) { if (!empty($original)) { // convert object data into API format $data = $this->api->get_object_data($original, $type); } $this->filter->input_body($this->input_body, $type, $data); } // convert input to internal kolab_storage format if ($type) { $class = "kolab_api_input_json_$type"; $model = new $class; $model->input($this->input_body, $original); } } return $this->input_body; } /** * Convert xCard/xCal date and date-time into internal DateTime * * @param array|string Date or Date-Time * * @return DateTime */ public static function to_datetime($input) { if (empty($input)) { return; } if (is_array($input)) { if ($input['date-time']) { if ($input['parameters']['tzid']) { $tzid = str_replace('/kolab.org/', '', $input['parameters']['tzid']); } else { $tzid = 'UTC'; } $datetime = $input['date-time']; try { $timezone = new DateTimeZone($tzid); } catch (Exception $e) {} } else if ($input['timestamp']) { $datetime = $input['timestamp']; } else if ($input['date']) { $datetime = $input['date']; $is_date = true; } else { return; } } else { $datetime = $input; $is_date = preg_match('/^[0-9]{4}-?[0-9]{2}-?[0-9]{2}$/', $input); } try { $dt = new DateTime($datetime, $timezone ?: new DateTimeZone('UTC')); } catch (Exception $e) { return; } if ($is_date) { $dt->_dateonly = true; $dt->setTime(0, 0, 0); } return $dt; } + + /** + * Add x-custom fields to the result + */ + public static function add_x_custom($data, &$result) + { + if (array_key_exists('x-custom', (array) $data)) { + $value = (array) $data['x-custom']; + + foreach ((array) $value as $idx => $v) { + if ($v['identifier'] && $v['value'] !== null) { + $value[$idx] = array($v['identifier'], $v['value']); + } + else { + unset($value[$idx]); + } + } + + $result['x-custom'] = $value; + } + } } diff --git a/lib/input/json/contact.php b/lib/input/json/contact.php index c7d86f8..5faedfe 100644 --- a/lib/input/json/contact.php +++ b/lib/input/json/contact.php @@ -1,336 +1,337 @@ | +--------------------------------------------------------------------------+ | Author: Aleksander Machniak | +--------------------------------------------------------------------------+ */ class kolab_api_input_json_contact { // map xml/json attributes into internal (kolab_format) protected $field_map = array( // 'created' => 'creation-date', 'changed' => 'rev', 'categories' => 'categories', 'kind' => 'kind', // not supported by kolab_format_contact 'freebusyurl' => 'fburl', 'notes' => 'note', 'name' => 'fn', 'jobtitle' => 'title', 'nickname' => 'nickname', 'birthday' => 'bday', 'anniversary' => 'anniversary', 'photo' => 'photo', 'gender' => 'gender', 'im' => 'impp', 'lang' => 'lang', 'geo' => 'geo', // not supported by kolab_format_contact 'x-crypto' => 'x-crypto', // not supported by kolab_format_contact // the rest of properties is handled separately ); protected $address_props = array( // 'parameters', // 'pobox', // 'ext', 'street', 'locality', 'region', 'code', 'country' ); protected $gendermap = array( 'M' => 'male', 'F' => 'female', ); /** * Convert contact input array into an array that can * be handled by kolab_storage_folder::save() * * @param array Request body * @param array Original object data (on update) */ public function input(&$data, $original = null) { if (empty($data) || !is_array($data)) { throw new kolab_api_exception(kolab_api_exception::INVALID_REQUEST); } foreach ($this->field_map as $kolab => $api) { if (!array_key_exists($api, $data)) { continue; } $value = $data[$api]; switch ($kolab) { case 'gender': $value = $this->gendermap[$value]; break; case 'created': case 'changed': case 'birthday': case 'anniversary': $value = kolab_api_input_json::to_datetime($value); break; case 'photo': if (preg_match('/^(data:image\/[a-z]+;base64,).+$/i', $value, $m)) { $value = base64_decode(substr($value, strlen($m[1]))); } else { continue 2; } break; case 'jobtitle': $value = (array) $value; break; } $result[$kolab] = $value; } // contact name properties if (array_key_exists('n', $data)) { $name_attrs = array( 'surname' => 'surname', 'firstname' => 'given', 'middlename' => 'additional', 'prefix' => 'prefix', 'suffix' => 'suffix', ); foreach ($name_attrs as $kolab => $api) { $result[$kolab] = $data['n'][$api]; } } // contact additional properties if (array_key_exists('group', $data)) { $group_changed = true; $result['organization'] = null; $result['department'] = null; $result['profession'] = null; $result['manager'] = null; $result['assistant'] = null; foreach ((array) $data['group'] as $idx => $entry) { // organization, department if ($idx == 'org') { if (is_array($entry) && count($entry) > 1) { $result['organization'] = $entry[0]; $result['department'] = $entry[1]; } else { $result['organization'] = is_array($entry) ? $entry[0] : $entry; } } // profession else if ($idx == 'role') { $result['profession'] = $entry; } // manager, assistant else if ($idx == 'related') { foreach ((array) $entry as $item) { if ($item['text'] !== null) { foreach (array('manager', 'assistant') as $i) { if ($item['parameters']['type'] == "x-$i") { $result[$i] = $item['text']; } } } } } // office address else if ($idx == 'adr') { $address = array('type' => 'office'); foreach ($this->address_props as $prop) { if ($entry[$prop] !== null) { $address[$prop] = $entry[$prop]; } } $result['address'][] = $address; } } } // website url if (array_key_exists('url', $data)) { $result['website'] = array(); foreach ((array) $data['url'] as $url) { if (is_array($url) && $url['url']) { $result['website'][] = array( 'url' => $url['url'], 'type' => $url['parameters']['type'], ); } else if ($url) { $result['website'][] = array('url' => $url); } } } // home and work address if (array_key_exists('adr', $data)) { $adr_changed = true; foreach ((array) $data['adr'] as $addr) { $address = array('type' => $addr['parameters']['type']); foreach ($this->address_props as $prop) { if ($addr[$prop] !== null) { $address[$prop] = $addr[$prop]; } } $result['address'][] = $address; } } // spouse, children if (array_key_exists('related', $data)) { $result['spouse'] = null; $result['children'] = array(); foreach ($data['related'] as $entry) { if (isset($entry['text'])) { $type = $entry['parameters']['type']; if ($type == 'spouse') { $result['spouse'] = $entry['text']; } else if ($type == 'child') { $result['children'][] = $entry['text']; } } } } // phone numbers if (array_key_exists('tel', $data)) { $result['phone'] = array(); foreach ((array) $data['tel'] as $phone) { if (!empty($phone) && isset($phone['text'])) { $type = implode('', (array) $phone['parameters']['type']); $aliases = array( 'faxhome' => 'homefax', 'faxwork' => 'workfax', 'x-car' => 'car', 'textphone' => 'other', 'cell' => 'mobile', 'voice' => 'main', ); $result['phone'][] = array( 'type' => $aliases[$type] ?: $type, 'number' => $phone['text'], ); } } } // email addresses if (array_key_exists('email', $data)) { $result['email'] = array(); foreach ($data['email'] as $email) { if (!empty($email)) { if (!is_array($email)) { $result['email'][] = array( 'type' => 'other', 'address' => $email, ); } else if (isset($email['text'])) { $type = implode('', (array) $email['parameters']['type']); $result['email'][] = array( 'type' => $type ? $type : 'other', 'address' => $email['text'], ); } } } } // PGP or S/MIME key if (array_key_exists('key', $data)) { $key_types = array( 'pgp-keys' => 'pgppublickey', 'pkcs7-mime' => 'pkcs7publickey', ); foreach ($key_types as $type) { $result[$type] = null; } foreach ((array) $data['key'] as $key) { if (preg_match('#^data:application/(pgp-keys|pkcs7-mime);base64,#', $key, $m)) { $result[$key_types[$m[1]]] = base64_decode(substr($key, strlen($m[0]))); } } } - // @TODO: x-custom fields - // @TODO: which contact properties should we require? + // x-custom fields + kolab_api_input_json::add_x_custom($data, $result); + // @TODO: which contact properties should we require? if (empty($result)) { throw new kolab_api_exception(kolab_api_exception::INVALID_REQUEST); } if (!empty($original)) { // fix addresses merging... $addresses = (array) $original['address']; // unset office address if ($group_changed) { foreach ($addresses as $idx => $adr) { if ($adr['type'] == 'office') { unset($addresses[$idx]); } } } // unset other addresses if ($adr_changed) { foreach ($addresses as $idx => $adr) { if ($adr['type'] != 'office') { unset($addresses[$idx]); } } } // merge old and new addresses if (isset($result['address']) && !empty($addresses)) { $result['address'] = array_merge($result['address'], $addresses); } $result = array_merge($original, $result); } $data = $result; } } diff --git a/lib/input/json/event.php b/lib/input/json/event.php index 1999eea..2646b88 100644 --- a/lib/input/json/event.php +++ b/lib/input/json/event.php @@ -1,116 +1,118 @@ | +--------------------------------------------------------------------------+ | Author: Aleksander Machniak | +--------------------------------------------------------------------------+ */ class kolab_api_input_json_event { // map xml/json attributes into internal (kolab_format) protected $field_map = array( 'description' => 'description', 'title' => 'summary', 'sensitivity' => 'class', 'sequence' => 'sequence', 'categories' => 'categories', 'created' => 'created', 'changed' => 'dtstamp', 'attendees' => 'attendee', 'organizer' => 'organizer', 'recurrence' => 'rrule', 'start' => 'dtstart', 'end' => 'dtend', 'valarms' => 'valarms', 'location' => 'location', 'priority' => 'priority', 'status' => 'status', 'url' => 'url', ); /** * Convert event input array into an array that can * be handled by kolab_storage_folder::save() * * @param array Request body * @param array Original object data (on update) */ public function input(&$data, $original = null) { if (empty($data) || !is_array($data)) { throw new kolab_api_exception(kolab_api_exception::INVALID_REQUEST); } // require at least 'dtstart' property for new objects if (empty($original) && empty($data['dtstart'])) { throw new kolab_api_exception(kolab_api_exception::INVALID_REQUEST); } foreach ($this->field_map as $kolab => $api) { if (!array_key_exists($api, $data)) { continue; } $value = $data[$api]; switch ($kolab) { case 'sensitivity': if ($value) { $value = strtolower($value); } break; case 'url': if (is_array($value)) { $value = $value[0]; } break; case 'created': case 'changed': case 'start': case 'end': $value = kolab_api_input_json::to_datetime($value); break; } $result[$kolab] = $value; } // @TODO: attendees // @TODO: organizer // @TODO: recurrence // @TODO: exceptions // @TOOD: alarms - // @TODO: x-custom fields - // @TODO: should we require event summary/title? + // x-custom fields + kolab_api_input_json::add_x_custom($data, $result); + + // @TODO: should we require event summary/title? if (empty($result)) { throw new kolab_api_exception(kolab_api_exception::INVALID_REQUEST); } if (!empty($original)) { $result = array_merge($original, $result); } $data = $result; } } diff --git a/lib/input/json/note.php b/lib/input/json/note.php index 0d7926d..376a009 100644 --- a/lib/input/json/note.php +++ b/lib/input/json/note.php @@ -1,87 +1,88 @@ | +--------------------------------------------------------------------------+ | Author: Aleksander Machniak | +--------------------------------------------------------------------------+ */ class kolab_api_input_json_note { // map xml/json attributes into internal (kolab_format) protected $field_map = array( 'description' => 'description', 'title' => 'summary', 'sensitivity' => 'classification', 'categories' => 'categories', 'created' => 'creation-date', 'changed' => 'last-modification-date', ); /** * Convert note input array into an array that can * be handled by kolab_storage_folder::save() * * @param array Request body * @param array Original object data (on update) */ public function input(&$data, $original = null) { if (empty($data) || !is_array($data)) { throw new kolab_api_exception(kolab_api_exception::INVALID_REQUEST); } foreach ($this->field_map as $kolab => $api) { if (!array_key_exists($api, $data)) { continue; } $value = $data[$api]; switch ($kolab) { case 'sensitivity': if ($value) { $value = strtolower($value); } break; case 'created': case 'changed': $value = kolab_api_input_json::to_datetime($value); break; } $result[$kolab] = $value; } - // @TODO: x-custom fields - // @TODO: should we require note summary/title? + // x-custom fields + kolab_api_input_json::add_x_custom($data, $result); + // @TODO: should we require note summary/title? if (empty($result)) { throw new kolab_api_exception(kolab_api_exception::INVALID_REQUEST); } if (!empty($original)) { $result = array_merge($original, $result); } $data = $result; } } diff --git a/lib/input/json/task.php b/lib/input/json/task.php index 360b6a1..f956e06 100644 --- a/lib/input/json/task.php +++ b/lib/input/json/task.php @@ -1,109 +1,111 @@ | +--------------------------------------------------------------------------+ | Author: Aleksander Machniak | +--------------------------------------------------------------------------+ */ class kolab_api_input_json_task { // map xml/json attributes into internal (kolab_format) protected $field_map = array( 'description' => 'description', 'title' => 'summary', 'sensitivity' => 'class', 'sequence' => 'sequence', 'categories' => 'categories', 'created' => 'created', 'changed' => 'dtstamp', 'complete' => 'percent-complete', 'status' => 'status', 'start' => 'dtstart', 'due' => 'due', 'parent_id' => 'related-to', 'location' => 'location', 'priority' => 'priority', 'url' => 'url', ); /** * Convert task input array into an array that can * be handled by kolab_storage_folder::save() * * @param array Request body * @param array Original object data (on update) */ public function input(&$data, $original = null) { if (empty($data) || !is_array($data)) { throw new kolab_api_exception(kolab_api_exception::INVALID_REQUEST); } foreach ($this->field_map as $kolab => $api) { if (!array_key_exists($api, $data)) { continue; } $value = $data[$api]; switch ($kolab) { case 'sensitivity': if ($value) { $value = strtolower($value); } break; case 'parent_id': // kolab_format_task supports only one parent if (is_array($value)) { $value = $value[0]; } break; case 'created': case 'changed': case 'start': case 'due': $value = kolab_api_input_json::to_datetime($value); break; } $result[$kolab] = $value; } // @TOOD: categories // @TODO: attendees // @TODO: organizer // @TODO: recurrence // @TOOD: alarms - // @TODO: x-custom fields + + // x-custom fields + kolab_api_input_json::add_x_custom($data, $result); if (empty($result)) { throw new kolab_api_exception(kolab_api_exception::INVALID_REQUEST); } if (!empty($original)) { $result = array_merge($original, $result); } $data = $result; } } diff --git a/tests/Unit/Filter/Mapistore.php b/tests/Unit/Filter/Mapistore.php index 9e84c44..51b1a5f 100644 --- a/tests/Unit/Filter/Mapistore.php +++ b/tests/Unit/Filter/Mapistore.php @@ -1,187 +1,196 @@ array( 'n2' => 'test2', ), 'n3' => 'test3', + 'x-custom' => array( + array('identifier' => 'i', value => 'val_i'), + ), ); $value = kolab_api_filter_mapistore::get_kolab_value($data, 'n1.n2'); $this->assertSame('test2', $value); $value = kolab_api_filter_mapistore::get_kolab_value($data, 'n3'); $this->assertSame('test3', $value); $value = kolab_api_filter_mapistore::get_kolab_value($data, 'n30'); $this->assertSame(null, $value); + + $value = kolab_api_filter_mapistore::get_kolab_value($data, 'x-custom.i'); + $this->assertSame('val_i', $value); } /** * Test set_kolab_value method */ function test_set_kolab_value() { $data = array(); kolab_api_filter_mapistore::set_kolab_value($data, 'n1.n2', 'test'); $this->assertSame('test', $data['n1']['n2']); kolab_api_filter_mapistore::set_kolab_value($data, 'n1', 'test'); $this->assertSame('test', $data['n1']); + + kolab_api_filter_mapistore::set_kolab_value($data, 'x-custom.i', 'test1'); + $this->assertSame('test1', $data['x-custom.i']); } /** * Test uid_encode method */ function test_uid_encode() { $uid = kolab_api_filter_mapistore::uid_encode('folder', 'msg'); $this->assertSame('folder.msg', $uid); $uid = kolab_api_filter_mapistore::uid_encode('folder', 'msg', 'attach'); $this->assertSame('folder.msg.attach', $uid); $uid = kolab_api_filter_mapistore::uid_encode('f-ol.der', 'm-s.g', 'att.a-ch'); $this->assertSame('f-ol_46der.m-s_46g.att_46a-ch', $uid); } /** * Test uid_decode method */ function test_uid_decode() { $uid = kolab_api_filter_mapistore::uid_decode('f-ol_46der.m-s_46g.att_46a-ch'); $this->assertSame(array('f-ol.der', 'm-s.g', 'att.a-ch'), $uid); } /** * Test parse_common_props method */ function test_parse_common_props() { kolab_api_filter_mapistore::parse_common_props($result = array(), array(), array()); $this->assertSame(array(), $result); } /** * Test attributes_filter method */ function test_attributes_filter() { $api = new kolab_api_filter_mapistore; $input = array( 'creation-date', 'uid', 'unknown', ); $expected = array( 'PidTagCreationTime', 'id', ); $result = $api->attributes_filter($input, '', true); $this->assertSame($expected, $result); $input = $expected; $expected = array( 'creation-date', 'uid', ); $result = $api->attributes_filter($input, ''); $this->assertSame($expected, $result); $result = $api->attributes_filter(array(), ''); $this->assertSame(array(), $result); } /** * Test date_php2mapi method */ function test_date_php2mapi() { $date = kolab_api_filter_mapistore::date_php2mapi('2014-01-01T00:00:00+00:00'); $this->assertSame(130330080000000000, $date); $date = kolab_api_filter_mapistore::date_php2mapi('2014-01-01'); $this->assertSame(130330080000000000, $date); $date = kolab_api_filter_mapistore::date_php2mapi('1970-01-01T00:00:00Z'); $this->assertSame(116444736000000000, $date); $date = kolab_api_filter_mapistore::date_php2mapi('1601-01-01T00:00:00Z'); $this->assertSame(0, $date); $date = new DateTime('1601-01-01T00:00:00Z'); $date = kolab_api_filter_mapistore::date_php2mapi($date); $this->assertSame(0, $date); $date = new DateTime('1970-01-01T00:00:00Z'); $date = kolab_api_filter_mapistore::date_php2mapi($date); $this->assertSame(116444736000000000, $date); $date = kolab_api_filter_mapistore::date_php2mapi(''); $this->assertSame(null, $date); } /** * Test date_mapi2php method */ function test_date_mapi2php() { $format = 'c'; $data = array( 130330080000000000 => '2014-01-01T00:00:00+00:00', 116444736000000000 => '1970-01-01T00:00:00+00:00', 0 => '1601-01-01T00:00:00+00:00', ); foreach ($data as $mapi => $exp) { $date = kolab_api_filter_mapistore::date_mapi2php($mapi); $this->assertSame($exp, $date->format($format)); } } /** * Test parse_categories method */ function test_parse_categories() { $categories = array( "test\x3Btest", "test\x2Ctest", "a\x06\x1Ba", "b\xFE\x54b", "c\xFF\x1Bc", "test ", " test", ); $expected = array( "testtest", "aa", "bb", "cc", "test", ); $result = kolab_api_filter_mapistore::parse_categories($categories); $this->assertSame($expected, $result); } } diff --git a/tests/Unit/Filter/Mapistore/Contact.php b/tests/Unit/Filter/Mapistore/Contact.php index 9cee825..cd4a3f4 100644 --- a/tests/Unit/Filter/Mapistore/Contact.php +++ b/tests/Unit/Filter/Mapistore/Contact.php @@ -1,397 +1,405 @@ output($data, $context); $this->assertSame(kolab_api_filter_mapistore::uid_encode(md5('Contacts'), 'a-b-c-d'), $result['id']); $this->assertSame(md5('Contacts'), $result['parent_id']); // $this->assertSame(kolab_api_filter_mapistore::date_php2mapi('20150421T145607Z'), $result['PidTagLastModificationTime']); $this->assertSame(kolab_api_filter_mapistore::date_php2mapi('20150330', false), $result['PidTagBirthday']); $this->assertSame(kolab_api_filter_mapistore::date_php2mapi('20150301', false), $result['PidTagWeddingAnniversary']); $this->assertSame('displname', $result['PidTagDisplayName']); $this->assertSame('last', $result['PidTagSurname']); $this->assertSame('test', $result['PidTagGivenName']); $this->assertSame('middlename', $result['PidTagMiddleName']); $this->assertSame('prefx', $result['PidTagDisplayNamePrefix']); $this->assertSame('suff', $result['PidTagGeneration']); $this->assertSame('dsfsdfsdfsdf sdfsdfsdf sdfsdfsfd', $result['PidTagBody']); $this->assertSame('free-busy url', $result['PidLidFreeBusyLocation']); $this->assertSame('title', $result['PidTagTitle']); $this->assertSame('Org', $result['PidTagCompanyName']); $this->assertSame('dept', $result['PidTagDepartmentName']); $this->assertSame('profeion', $result['PidTagProfession']); $this->assertSame('manager name', $result['PidTagManagerName']); $this->assertSame('assist', $result['PidTagAssistant']); $this->assertSame('website', $result['PidTagPersonalHomePage']); $this->assertSame('office street', $result['PidTagOtherAddressStreet']); $this->assertSame('office city', $result['PidTagOtherAddressCity']); $this->assertSame('office state', $result['PidTagOtherAddressStateOrProvince']); $this->assertSame('office zip', $result['PidTagOtherAddressPostalCode']); $this->assertSame('office country', $result['PidTagOtherAddressCountry']); // $this->assertSame('office pobox', $result['PidTagOtherAddressPostOfficeBox']); $this->assertSame('home street', $result['PidTagHomeAddressStreet']); $this->assertSame('home city', $result['PidTagHomeAddressCity']); $this->assertSame('home state', $result['PidTagHomeAddressStateOrProvince']); $this->assertSame('home zip', $result['PidTagHomeAddressPostalCode']); $this->assertSame('home country', $result['PidTagHomeAddressCountry']); // $this->assertSame('home pobox', $result['PidTagHomeAddressPostOfficeBox']); $this->assertSame('work street', $result['PidLidWorkAddressStreet']); $this->assertSame('work city', $result['PidLidWorkAddressCity']); $this->assertSame('work state', $result['PidLidWorkAddressState']); $this->assertSame('work zip', $result['PidLidWorkAddressPostalCode']); $this->assertSame('work country', $result['PidLidWorkAddressCountry']); // $this->assertSame('work pobox', $result['PidLidWorkAddressPostOfficeBox']); $this->assertSame('nick', $result['PidTagNickname']); $this->assertSame(2, $result['PidTagGender']); $this->assertSame('spouse', $result['PidTagSpouseName']); $this->assertSame(array('children', 'children2'), $result['PidTagChildrensNames']); $this->assertSame('home phone', $result['PidTagHomeTelephoneNumber']); $this->assertSame('work phone', $result['PidTagBusinessTelephoneNumber']); $this->assertSame('home fax', $result['PidTagHomeFaxNumber']); $this->assertSame('work fax', $result['PidTagBusinessFaxNumber']); $this->assertSame('mobile', $result['PidTagMobileTelephoneNumber']); $this->assertSame('pager', $result['PidTagPagerTelephoneNumber']); $this->assertSame('car phone', $result['PidTagCarTelephoneNumber']); $this->assertSame('other phone', $result['PidTagOtherTelephoneNumber']); $this->assertSame('im gg', $result['PidLidInstantMessagingAddress']); $this->assertSame('test@mail.ru', $result['PidLidEmail1EmailAddress']); $this->assertSame('work@email.pl', $result['PidLidEmail2EmailAddress']); $this->assertSame('other@email.pl', $result['PidLidEmail3EmailAddress']); $this->assertRegExp('/^cy9.*/', $result['PidTagUserX509Certificate']); // $this->assertRegExp('|^data:application/pgp-keys;base64,|', $result['key'][0]); // $this->assertRegExp('|^data:image/jpeg;base64,|', $result['photo']); // $this->assertSame('individual', $result['kind']); } /** * Test input method */ function test_input() { $api = new kolab_api_filter_mapistore_contact; $data = array( 'id' => kolab_api_filter_mapistore::uid_encode(md5('Contacts'), 'a-b-c-d'), 'parent_id' => md5('Contacts'), // 'PidTagLastModificationTime' => kolab_api_filter_mapistore::date_php2mapi('20150421T145607Z'), 'PidTagBirthday' => kolab_api_filter_mapistore::date_php2mapi('20150330', true), 'PidTagWeddingAnniversary' => kolab_api_filter_mapistore::date_php2mapi('20150301', true), 'PidTagDisplayName' => 'displname', 'PidTagSurname' => 'last', 'PidTagGivenName' => 'test', 'PidTagMiddleName' => 'middlename', 'PidTagDisplayNamePrefix' => 'prefx', 'PidTagGeneration' => 'suff', 'PidTagBody' => 'dsfsdfsdfsdf sdfsdfsdf sdfsdfsfd', 'PidLidFreeBusyLocation' => 'free-busy url', 'PidTagTitle' => 'title', 'PidTagCompanyName' => 'Org', 'PidTagDepartmentName' => 'dept', 'PidTagProfession' => 'profeion', 'PidTagManagerName' => 'manager name', 'PidTagAssistant' => 'assist', 'PidTagPersonalHomePage' => 'website', 'PidTagOtherAddressStreet' => 'office street', 'PidTagOtherAddressCity' => 'office city', 'PidTagOtherAddressStateOrProvince' => 'office state', 'PidTagOtherAddressPostalCode' => 'office zip', 'PidTagOtherAddressCountry' => 'office country', // 'PidTagOtherAddressPostOfficeBox' => 'office pobox', 'PidTagHomeAddressStreet' => 'home street', 'PidTagHomeAddressCity' => 'home city', 'PidTagHomeAddressStateOrProvince' => 'home state', 'PidTagHomeAddressPostalCode' => 'home zip', 'PidTagHomeAddressCountry' => 'home country', // 'PidTagHomeAddressPostOfficeBox' => 'home pobox', 'PidLidWorkAddressStreet' => 'work street', 'PidLidWorkAddressCity' => 'work city', 'PidLidWorkAddressState' => 'work state', 'PidLidWorkAddressPostalCode' => 'work zip', 'PidLidWorkAddressCountry' => 'work country', // 'PidLidWorkAddressPostOfficeBox' => 'work pobox', 'PidTagNickname' => 'nick', 'PidTagGender' => 2, 'PidTagSpouseName' => 'spouse', 'PidTagChildrensNames' => array('children', 'children2'), 'PidTagHomeTelephoneNumber' => 'home phone', 'PidTagBusinessTelephoneNumber' => 'work phone', 'PidTagHomeFaxNumber' => 'home fax', 'PidTagBusinessFaxNumber' => 'work fax', 'PidTagMobileTelephoneNumber' => 'mobile', 'PidTagPagerTelephoneNumber' => 'pager', 'PidTagCarTelephoneNumber' => 'car phone', 'PidTagOtherTelephoneNumber' => 'other phone', 'PidLidInstantMessagingAddress' => 'im gg', 'PidLidEmail1EmailAddress' => 'test@mail.ru', 'PidLidEmail2EmailAddress' => 'work@email.pl', 'PidLidEmail3EmailAddress' => 'other@email.pl', 'PidTagUserX509Certificate' => '1234567890', + + 'PidTagInitials' => 'initials', ); $result = $api->input($data); // $this->assertSame('a-b-c-d', $result['uid']); // $this->assertSame('20150420T141533Z', $result['rev']); // $this->assertSame('individual', $result['kind']); $this->assertSame('displname', $result['fn']); $this->assertSame('last', $result['n']['surname']); $this->assertSame('test', $result['n']['given']); $this->assertSame('middlename', $result['n']['additional']); $this->assertSame('prefx', $result['n']['prefix']); $this->assertSame('suff', $result['n']['suffix']); $this->assertSame('dsfsdfsdfsdf sdfsdfsdf sdfsdfsfd', $result['note']); $this->assertSame('free-busy url', $result['fburl']); $this->assertSame('title', $result['title']); $this->assertSame('Org', $result['group']['org'][0]); $this->assertSame('dept', $result['group']['org'][1]); $this->assertSame('profeion', $result['group']['role']); $this->assertSame('x-manager', $result['group']['related'][0]['parameters']['type']); $this->assertSame('manager name', $result['group']['related'][0]['text']); $this->assertSame('x-assistant', $result['group']['related'][1]['parameters']['type']); $this->assertSame('assist', $result['group']['related'][1]['text']); // $this->assertSame('', $result['group']['adr']['pobox']); $this->assertSame('office street', $result['group']['adr']['street']); $this->assertSame('office city', $result['group']['adr']['locality']); $this->assertSame('office state', $result['group']['adr']['region']); $this->assertSame('office zip', $result['group']['adr']['code']); $this->assertSame('office country', $result['group']['adr']['country']); $this->assertSame(array('website'), $result['url']); $this->assertSame('home', $result['adr'][0]['parameters']['type']); $this->assertSame('home street', $result['adr'][0]['street']); $this->assertSame('home city', $result['adr'][0]['locality']); $this->assertSame('home state', $result['adr'][0]['region']); $this->assertSame('home zip', $result['adr'][0]['code']); $this->assertSame('home country', $result['adr'][0]['country']); $this->assertSame('work', $result['adr'][1]['parameters']['type']); $this->assertSame('work street', $result['adr'][1]['street']); $this->assertSame('work city', $result['adr'][1]['locality']); $this->assertSame('work state', $result['adr'][1]['region']); $this->assertSame('work zip', $result['adr'][1]['code']); $this->assertSame('work country', $result['adr'][1]['country']); $this->assertSame('nick', $result['nickname']); $this->assertSame('spouse', $result['related'][0]['parameters']['type']); $this->assertSame('spouse', $result['related'][0]['text']); $this->assertSame('child', $result['related'][1]['parameters']['type']); $this->assertSame('children', $result['related'][1]['text']); $this->assertSame('child', $result['related'][2]['parameters']['type']); $this->assertSame('children2', $result['related'][2]['text']); $this->assertSame('2015-03-30', $result['bday']); // ? $this->assertSame('2015-03-01', $result['anniversary']); // ? $this->assertSame('M', $result['gender']); $this->assertSame(array('im gg'), $result['impp']); $this->assertSame('home', $result['email'][0]['parameters']['type']); $this->assertSame('test@mail.ru', $result['email'][0]['text']); $this->assertSame('work', $result['email'][1]['parameters']['type']); $this->assertSame('work@email.pl', $result['email'][1]['text']); $this->assertSame('other', $result['email'][2]['parameters']['type']); $this->assertSame('other@email.pl', $result['email'][2]['text']); $this->assertRegExp('|^data:application/pkcs7-mime;base64,|', $result['key'][0]); // $this->assertRegExp('|^data:application/pgp-keys;base64,|', $result['key'][1]); // $this->assertRegExp('|^data:image/jpeg;base64,|', $result['photo']); + $this->assertSame('MAPI:PidTagInitials', $result['x-custom'][0]['identifier']); + $this->assertSame('initials', $result['x-custom'][0]['value']); $phones = array( 'home' => 'home phone', 'work' => 'work phone', 'faxhome' => 'home fax', 'faxwork' => 'work fax', 'cell' => 'mobile', 'pager' => 'pager', 'x-car' => 'car phone', 'textphone' => 'other phone', ); foreach ($result['tel'] as $tel) { $type = implode('', (array)$tel['parameters']['type']); $text = $tel['text']; if (!empty($phones[$type]) && $phones[$type] == $text) { unset($phones[$type]); } } $this->assertCount(8, $result['tel']); $this->assertCount(0, $phones); self::$original = $result; } /** * Test input method with merge */ function test_input2() { $api = new kolab_api_filter_mapistore_contact; $data = array( 'id' => kolab_api_filter_mapistore::uid_encode(md5('Contacts'), 'a-b-c-d'), 'parent_id' => md5('Contacts'), // 'PidTagLastModificationTime' => kolab_api_filter_mapistore::date_php2mapi('20150421T145607Z'), 'PidTagBirthday' => kolab_api_filter_mapistore::date_php2mapi('20150430', true), 'PidTagWeddingAnniversary' => kolab_api_filter_mapistore::date_php2mapi('20150401', true), 'PidTagDisplayName' => 'displname1', 'PidTagSurname' => 'last1', 'PidTagGivenName' => 'test1', 'PidTagMiddleName' => 'middlename1', 'PidTagDisplayNamePrefix' => 'prefx1', 'PidTagGeneration' => 'suff1', 'PidTagBody' => 'body1', 'PidLidFreeBusyLocation' => 'free-busy url1', 'PidTagTitle' => 'title1', 'PidTagCompanyName' => 'Org1', 'PidTagDepartmentName' => 'dept1', 'PidTagProfession' => 'profeion1', 'PidTagManagerName' => 'manager name1', 'PidTagAssistant' => 'assist1', 'PidTagPersonalHomePage' => 'website1', 'PidTagOtherAddressStreet' => 'office street1', 'PidTagOtherAddressCity' => 'office city1', 'PidTagOtherAddressStateOrProvince' => 'office state1', 'PidTagOtherAddressPostalCode' => 'office zip1', 'PidTagOtherAddressCountry' => 'office country1', 'PidTagHomeAddressStreet' => 'home street1', 'PidTagHomeAddressCity' => 'home city1', 'PidTagHomeAddressStateOrProvince' => 'home state1', 'PidTagHomeAddressPostalCode' => 'home zip1', 'PidTagHomeAddressCountry' => 'home country1', 'PidLidWorkAddressStreet' => 'work street1', 'PidLidWorkAddressCity' => 'work city1', 'PidLidWorkAddressState' => 'work state1', 'PidLidWorkAddressPostalCode' => 'work zip1', 'PidLidWorkAddressCountry' => 'work country1', 'PidTagNickname' => 'nick1', 'PidTagGender' => 1, 'PidTagSpouseName' => 'spouse1', 'PidTagChildrensNames' => array('children10', 'children20'), 'PidTagHomeTelephoneNumber' => 'home phone1', 'PidTagBusinessTelephoneNumber' => null, 'PidTagHomeFaxNumber' => 'home fax1', 'PidTagBusinessFaxNumber' => 'work fax1', 'PidTagMobileTelephoneNumber' => 'mobile1', 'PidTagPagerTelephoneNumber' => 'pager1', 'PidTagOtherTelephoneNumber' => 'other phone1', 'PidLidInstantMessagingAddress' => 'im gg1', 'PidLidEmail1EmailAddress' => 'test@mail.ru', 'PidLidEmail2EmailAddress' => 'work@email.pl', 'PidTagUserX509Certificate' => '12345678901', + + 'PidTagInitials' => 'initials1', ); $result = $api->input($data, self::$original); // $this->assertSame('a-b-c-d', $result['uid']); // $this->assertSame('20150420T141533Z', $result['rev']); // $this->assertSame('individual', $result['kind']); $this->assertSame('displname1', $result['fn']); $this->assertSame('last1', $result['n']['surname']); $this->assertSame('test1', $result['n']['given']); $this->assertSame('middlename1', $result['n']['additional']); $this->assertSame('prefx1', $result['n']['prefix']); $this->assertSame('suff1', $result['n']['suffix']); $this->assertSame('body1', $result['note']); $this->assertSame('free-busy url1', $result['fburl']); $this->assertSame('title1', $result['title']); $this->assertSame('Org1', $result['group']['org'][0]); $this->assertSame('dept1', $result['group']['org'][1]); $this->assertSame('profeion1', $result['group']['role']); $this->assertSame('x-manager', $result['group']['related'][0]['parameters']['type']); $this->assertSame('manager name1', $result['group']['related'][0]['text']); $this->assertSame('x-assistant', $result['group']['related'][1]['parameters']['type']); $this->assertSame('assist1', $result['group']['related'][1]['text']); $this->assertSame('office street1', $result['group']['adr']['street']); $this->assertSame('office city1', $result['group']['adr']['locality']); $this->assertSame('office state1', $result['group']['adr']['region']); $this->assertSame('office zip1', $result['group']['adr']['code']); $this->assertSame('office country1', $result['group']['adr']['country']); $this->assertSame(array('website1'), $result['url']); $this->assertSame('home', $result['adr'][0]['parameters']['type']); $this->assertSame('home street1', $result['adr'][0]['street']); $this->assertSame('home city1', $result['adr'][0]['locality']); $this->assertSame('home state1', $result['adr'][0]['region']); $this->assertSame('home zip1', $result['adr'][0]['code']); $this->assertSame('home country1', $result['adr'][0]['country']); $this->assertSame('work', $result['adr'][1]['parameters']['type']); $this->assertSame('work street1', $result['adr'][1]['street']); $this->assertSame('work city1', $result['adr'][1]['locality']); $this->assertSame('work state1', $result['adr'][1]['region']); $this->assertSame('work zip1', $result['adr'][1]['code']); $this->assertSame('work country1', $result['adr'][1]['country']); $this->assertSame('nick1', $result['nickname']); $this->assertSame('spouse', $result['related'][0]['parameters']['type']); $this->assertSame('spouse1', $result['related'][0]['text']); $this->assertSame('child', $result['related'][1]['parameters']['type']); $this->assertSame('children10', $result['related'][1]['text']); $this->assertSame('child', $result['related'][2]['parameters']['type']); $this->assertSame('children20', $result['related'][2]['text']); $this->assertSame('2015-04-30', $result['bday']); // ? $this->assertSame('2015-04-01', $result['anniversary']); // ? $this->assertSame('F', $result['gender']); $this->assertSame(array('im gg1'), $result['impp']); $this->assertSame('home', $result['email'][0]['parameters']['type']); $this->assertSame('test@mail.ru', $result['email'][0]['text']); $this->assertSame('work', $result['email'][1]['parameters']['type']); $this->assertSame('work@email.pl', $result['email'][1]['text']); $this->assertSame(null, $result['email'][2]); $this->assertRegExp('|^data:application/pkcs7-mime;base64,|', $result['key'][0]); // $this->assertRegExp('|^data:application/pgp-keys;base64,|', $result['key'][1]); // $this->assertRegExp('|^data:image/jpeg;base64,|', $result['photo']); + $this->assertSame('MAPI:PidTagInitials', $result['x-custom'][0]['identifier']); + $this->assertSame('initials1', $result['x-custom'][0]['value']); $phones = array( 'home' => 'home phone1', 'faxhome' => 'home fax1', 'faxwork' => 'work fax1', 'cell' => 'mobile1', 'pager' => 'pager1', 'x-car' => 'car phone', 'textphone' => 'other phone1', ); foreach ($result['tel'] as $tel) { $type = implode('', (array)$tel['parameters']['type']); $text = $tel['text']; if (!empty($phones[$type]) && $phones[$type] == $text) { unset($phones[$type]); } } $this->assertCount(7, $result['tel']); $this->assertCount(0, $phones); // @TODO: updating some deep items (e.g. adr); } /** * Test map method */ function test_map() { $api = new kolab_api_filter_mapistore_contact; $map = $api->map(); $this->assertInternalType('array', $map); $this->assertTrue(!empty($map)); } } diff --git a/tests/Unit/Filter/Mapistore/Note.php b/tests/Unit/Filter/Mapistore/Note.php index 5fb8fa5..34d3db0 100644 --- a/tests/Unit/Filter/Mapistore/Note.php +++ b/tests/Unit/Filter/Mapistore/Note.php @@ -1,103 +1,132 @@ output($data, $context); $this->assertSame(kolab_api_filter_mapistore::uid_encode(md5('Notes'), '1-1-1-1'), $result['id']); $this->assertSame(md5('Notes'), $result['parent_id']); $this->assertSame(kolab_api_filter_mapistore::date_php2mapi('2015-01-20T11:44:59Z'), $result['PidTagCreationTime']); $this->assertSame(kolab_api_filter_mapistore::date_php2mapi('2015-01-22T11:30:17Z'), $result['PidTagLastModificationTime']); // $this->assertSame('PUBLIC', $result['classification']); $this->assertSame('test', $result['PidTagSubject']); $this->assertRegexp('//', $result['PidTagBody']); + $this->assertSame(100, $result['PidLidNoteX']); + $this->assertSame(200, $result['PidLidNoteY']); } /** * Test input method */ function test_input() { $api = new kolab_api_filter_mapistore_note; $data = array( 'id' => kolab_api_filter_mapistore::uid_encode(md5('Notes'), '1-1-1-1'), 'parent_id' => md5('Notes'), 'PidTagCreationTime' => kolab_api_filter_mapistore::date_php2mapi('2015-01-20T11:44:59Z'), 'PidTagLastModificationTime' => kolab_api_filter_mapistore::date_php2mapi('2015-01-22T11:30:17Z'), 'PidTagSubject' => 'subject', 'PidTagBody' => 'body', + 'PidLidNoteColor' => 1, + 'PidLidNoteHeight' => 100, + 'PidLidNoteWidth' => 200, + 'PidLidNoteX' => 300, + 'PidLidNoteY' => 400, ); $result = $api->input($data); // $this->assertSame(kolab_api_filter_mapistore::uid_encode(md5('Notes'), '1-1-1-1'), $result['uid']); // $this->assertSame(md5('Notes'), $result['parent']); $this->assertSame('2015-01-20T11:44:59Z', $result['creation-date']); $this->assertSame('2015-01-22T11:30:17Z', $result['last-modification-date']); $this->assertSame('subject', $result['summary']); $this->assertSame('body', $result['description']); + $this->assertSame('MAPI:PidLidNoteColor', $result['x-custom'][0]['identifier']); + $this->assertSame(1, $result['x-custom'][0]['value']); + $this->assertSame('MAPI:PidLidNoteHeight', $result['x-custom'][1]['identifier']); + $this->assertSame(100, $result['x-custom'][1]['value']); + $this->assertSame('MAPI:PidLidNoteWidth', $result['x-custom'][2]['identifier']); + $this->assertSame(200, $result['x-custom'][2]['value']); + $this->assertSame('MAPI:PidLidNoteX', $result['x-custom'][3]['identifier']); + $this->assertSame(300, $result['x-custom'][3]['value']); + $this->assertSame('MAPI:PidLidNoteY', $result['x-custom'][4]['identifier']); + $this->assertSame(400, $result['x-custom'][4]['value']); self::$original = $result; } /** * Test input method with merge */ function test_input2() { $api = new kolab_api_filter_mapistore_note; $data = array( 'id' => kolab_api_filter_mapistore::uid_encode(md5('Notes'), '1-1-1-1'), 'parent_id' => md5('Notes'), // 'PidTagCreationTime' => kolab_api_filter_mapistore::date_php2mapi('2015-01-20T11:44:59Z'), // 'PidTagLastModificationTime' => kolab_api_filter_mapistore::date_php2mapi('2015-01-22T11:30:17Z'), 'PidTagSubject' => 'subject1', 'PidTagBody' => 'body1', + 'PidLidNoteX' => 250, + 'PidLidNoteColor' => null, ); - $result = $api->input($data); + $result = $api->input($data, self::$original); // $this->assertSame(kolab_api_filter_mapistore::uid_encode(md5('Notes'), '1-1-1-1'), $result['uid']); // $this->assertSame(md5('Notes'), $result['parent']); // $this->assertSame('2015-01-20T11:44:59Z', $result['creation-date']); // $this->assertSame('2015-01-22T11:30:17Z', $result['last-modification-date']); $this->assertSame('subject1', $result['summary']); $this->assertSame('body1', $result['description']); + $this->assertSame('MAPI:PidLidNoteHeight', $result['x-custom'][0]['identifier']); + $this->assertSame(100, $result['x-custom'][0]['value']); + $this->assertSame('MAPI:PidLidNoteWidth', $result['x-custom'][1]['identifier']); + $this->assertSame(200, $result['x-custom'][1]['value']); + $this->assertSame('MAPI:PidLidNoteX', $result['x-custom'][2]['identifier']); + $this->assertSame(250, $result['x-custom'][2]['value']); + $this->assertSame('MAPI:PidLidNoteY', $result['x-custom'][3]['identifier']); + $this->assertSame(400, $result['x-custom'][3]['value']); + + $this->assertCount(4, $result['x-custom']); // test unsetting values $api = new kolab_api_filter_mapistore_note; $data = array( 'PidTagSubject' => '', ); $result = $api->input($data, self::$original); $this->assertSame('', $result['summary']); } /** * Test map method */ function test_map() { $api = new kolab_api_filter_mapistore_note; $map = $api->map(); $this->assertInternalType('array', $map); $this->assertTrue(!empty($map)); } } diff --git a/tests/Unit/Filter/Mapistore/Task.php b/tests/Unit/Filter/Mapistore/Task.php index afb35ed..b0d400d 100644 --- a/tests/Unit/Filter/Mapistore/Task.php +++ b/tests/Unit/Filter/Mapistore/Task.php @@ -1,138 +1,154 @@ output($data, $context); $this->assertSame(kolab_api_filter_mapistore::uid_encode(md5('Tasks'), '10-10-10-10'), $result['id']); $this->assertSame(md5('Tasks'), $result['parent_id']); $this->assertSame('IPM.Task', $result['PidTagMessageClass']); $this->assertSame('tasks', $result['collection']); $this->assertSame('task title', $result['PidTagSubject']); $this->assertSame("task description\nsecond line", $result['PidTagBody']); $this->assertSame(0.56, $result['PidLidPercentComplete']); $this->assertSame(kolab_api_filter_mapistore::date_php2mapi('2015-04-20T14:22:18Z', true), $result['PidTagLastModificationTime']); $this->assertSame(kolab_api_filter_mapistore::date_php2mapi('2015-04-20T14:22:18Z', true), $result['PidTagCreationTime']); + $this->assertSame(8, $result['PidLidTaskActualEffort']); /* $this->assertSame('German, Mark', $result['organizer']['parameters']['cn']); $this->assertSame('mailto:%3Cmark.german%40example.org%3E', $result['organizer']['cal-address']); */ $data = kolab_api_tests::get_data('20-20-20-20', md5('Tasks'), 'task', 'json', $context); $result = $api->output($data, $context); $this->assertSame(kolab_api_filter_mapistore::uid_encode(md5('Tasks'), '20-20-20-20'), $result['id']); $this->assertSame(md5('Tasks'), $result['parent_id']); $this->assertSame('IPM.Task', $result['PidTagMessageClass']); $this->assertSame('tasks', $result['collection']); $this->assertSame('task', $result['PidTagSubject']); $this->assertSame(kolab_api_filter_mapistore::date_php2mapi('2015-04-20', true), $result['PidLidTaskStartDate']); $this->assertSame(kolab_api_filter_mapistore::date_php2mapi('2015-04-27', true), $result['PidLidTaskDueDate']); /* $this->assertSame('DAILY', $result['rrule']['recur']); $this->assertSame('NEEDS-ACTION', $result['status']); $this->assertSame('Manager, Jane', $result['attendee']['parameters']['cn']); $this->assertSame('NEEDS-ACTION', $result['attendee']['parameters']['partstat']); $this->assertSame('REQ-PARTICIPANT', $result['attendee']['parameters']['role']); $this->assertSame('true', $result['attendee']['parameters']['rsvp']); $this->assertSame('mailto:%3Cjane.manager%40example.org%3E', $result['attendee']['cal-address']); */ } /** * Test input method */ function test_input() { $api = new kolab_api_filter_mapistore_task; $data = array( 'id' => kolab_api_filter_mapistore::uid_encode(md5('Tasks'), '10-10-10-10'), 'parent_id' => md5('Tasks'), 'PidTagCreationTime' => kolab_api_filter_mapistore::date_php2mapi('2015-01-20T11:44:59Z'), 'PidTagLastModificationTime' => kolab_api_filter_mapistore::date_php2mapi('2015-01-22T11:30:17Z'), 'PidTagMessageClass' => 'IPM.Task', 'PidTagSubject' => 'subject', 'PidLidPercentComplete' => 0.56, 'PidTagBody' => 'body', 'PidLidTaskStartDate' => kolab_api_filter_mapistore::date_php2mapi('2015-04-20', true), 'PidLidTaskDueDate' => kolab_api_filter_mapistore::date_php2mapi('2015-04-27', true), + 'PidLidTaskActualEffort' => 16, + 'PidLidTaskEstimatedEffort' => 20, ); $result = $api->input($data); self::$original = $result; $this->assertSame('subject', $result['summary']); $this->assertSame('body', $result['description']); $this->assertSame(56, $result['percent-complete']); $this->assertSame('2015-01-20T11:44:59Z', $result['created']); $this->assertSame('2015-01-22T11:30:17Z', $result['dtstamp']); $this->assertSame('2015-04-20', $result['dtstart']); $this->assertSame('2015-04-27', $result['due']); + $this->assertSame('MAPI:PidLidTaskActualEffort', $result['x-custom'][0]['identifier']); + $this->assertSame(16, $result['x-custom'][0]['value']); + $this->assertSame('MAPI:PidLidTaskEstimatedEffort', $result['x-custom'][1]['identifier']); + $this->assertSame(20, $result['x-custom'][1]['value']); $data = array( 'PidLidTaskComplete' => true, + 'PidLidTaskDateCompleted' => kolab_api_filter_mapistore::date_php2mapi('2015-04-20', true), + 'PidLidTaskActualEffort' => 100, + 'PidLidTaskEstimatedEffort' => 100, ); $result = $api->input($data); $this->assertSame('COMPLETED', $result['status']); +// $this->assertSame(100, $result['x-custom']); } /** * Test input method with merge */ function test_input2() { $api = new kolab_api_filter_mapistore_task; $data = array( // 'id' => kolab_api_filter_mapistore::uid_encode(md5('Tasks'), '10-10-10-10'), // 'parent_id' => md5('Tasks'), 'PidTagCreationTime' => kolab_api_filter_mapistore::date_php2mapi('2015-01-20T12:44:59Z'), 'PidTagLastModificationTime' => kolab_api_filter_mapistore::date_php2mapi('2015-01-22T12:30:17Z'), // 'PidTagMessageClass' => 'IPM.Task', 'PidTagSubject' => 'subject1', 'PidLidPercentComplete' => 0.66, 'PidTagBody' => 'body1', 'PidLidTaskStartDate' => kolab_api_filter_mapistore::date_php2mapi('2015-04-21', true), 'PidLidTaskDueDate' => kolab_api_filter_mapistore::date_php2mapi('2015-04-28', true), + 'PidLidTaskActualEffort' => 21, + 'PidLidTaskEstimatedEffort' => null, ); $result = $api->input($data, self::$original); self::$original = $result; $this->assertSame('subject1', $result['summary']); $this->assertSame('body1', $result['description']); $this->assertSame(66, $result['percent-complete']); $this->assertSame('2015-01-20T12:44:59Z', $result['created']); $this->assertSame('2015-01-22T12:30:17Z', $result['dtstamp']); $this->assertSame('2015-04-21', $result['dtstart']); $this->assertSame('2015-04-28', $result['due']); + $this->assertSame('MAPI:PidLidTaskActualEffort', $result['x-custom'][0]['identifier']); + $this->assertSame(21, $result['x-custom'][0]['value']); + $this->assertCount(1, $result['x-custom']); } /** * Test map method */ function test_map() { $api = new kolab_api_filter_mapistore_task; $map = $api->map(); $this->assertInternalType('array', $map); $this->assertTrue(!empty($map)); } } diff --git a/tests/Unit/Input/Json.php b/tests/Unit/Input/Json.php index 4b49c4d..016c797 100644 --- a/tests/Unit/Input/Json.php +++ b/tests/Unit/Input/Json.php @@ -1,70 +1,98 @@ markTestIncomplete('TODO'); } /** * Test to_datetime method */ function test_to_datetime() { $result = kolab_api_input_json::to_datetime(null); $this->assertNull($result); $date = '2014-01-01'; $result = kolab_api_input_json::to_datetime($date); $this->assertInstanceOf('DateTime', $result); $this->assertSame('2014-01-01T00:00:00+00:00', $result->format('c')); $this->assertTrue($result->_dateonly); $date = array('date' => '2014-01-01'); $result = kolab_api_input_json::to_datetime($date); $this->assertInstanceOf('DateTime', $result); $this->assertSame('2014-01-01T00:00:00+00:00', $result->format('c')); $this->assertTrue($result->_dateonly); $date = '2015-04-20T14:22:18Z'; $result = kolab_api_input_json::to_datetime($date); $this->assertInstanceOf('DateTime', $result); $this->assertSame('2015-04-20T14:22:18+00:00', $result->format('c')); $this->assertFalse((bool) $result->_dateonly); $date = array('date-time' => '2015-04-21T00:00:00Z'); $result = kolab_api_input_json::to_datetime($date); $this->assertInstanceOf('DateTime', $result); $this->assertSame('2015-04-21T00:00:00+00:00', $result->format('c')); $this->assertFalse((bool) $result->_dateonly); $date = array( 'date-time' => '2015-04-21T00:00:00', 'parameters' => array( 'tzid' => '/kolab.org/Europe/Zurich', ), ); $result = kolab_api_input_json::to_datetime($date); $this->assertInstanceOf('DateTime', $result); $this->assertSame('2015-04-21T00:00:00+02:00', $result->format('c')); $this->assertFalse((bool) $result->_dateonly); $this->assertSame('Europe/Zurich', $result->getTimezone()->getName()); } + + /** + * Test add_x_custom + */ + function test_add_x_custom() + { + kolab_api_input_json::add_x_custom($data, $result); + + $this->assertNull($result); + + $data = array('x-custom' => null); + kolab_api_input_json::add_x_custom($data, $result); + + $this->assertSame(array(), $result['x-custom']); + + $data = array('x-custom' => array()); + kolab_api_input_json::add_x_custom($data, $result); + + $this->assertSame(array(), $result['x-custom']); + + $data = array('x-custom' => array( + array('identifier' => 'i', 'value' => 'v'), + )); + kolab_api_input_json::add_x_custom($data, $result); + + $this->assertSame('i', $result['x-custom'][0][0]); + $this->assertSame('v', $result['x-custom'][0][1]); + } } diff --git a/tests/Unit/Input/Json/Note.php b/tests/Unit/Input/Json/Note.php index 570c50c..2efbc39 100644 --- a/tests/Unit/Input/Json/Note.php +++ b/tests/Unit/Input/Json/Note.php @@ -1,92 +1,96 @@ input($data); } /** * Test expected exception in input method * * @expectedException kolab_api_exception * @expectedExceptionCode 422 */ function test_input_exception2() { $input = new kolab_api_input_json_note; $data = 'test'; $input->input($data); } /** * Test input method (convert JSON to internal format) */ function test_input() { $input = new kolab_api_input_json_note; - $data = array( + + $custom = array(array('identifier' => 'test', 'value' => 'val')); + $data = array( 'description' => 'description', 'summary' => 'summary', 'classification' => 'PUBLIC', 'categories' => array('test'), 'creation-date' => '2015-04-20T14:22:18Z', 'last-modification-date' => '2015-04-21T00:00:00Z', + 'x-custom' => $custom, ); $input->input($data); $this->assertSame('description', $data['description']); $this->assertSame('summary', $data['title']); $this->assertSame('public', $data['sensitivity']); $this->assertSame(array('test'), $data['categories']); $this->assertSame(kolab_api_input_json::to_datetime('2015-04-20T14:22:18Z')->format('c'), $data['created']->format('c')); $this->assertSame(kolab_api_input_json::to_datetime('2015-04-21T00:00:00Z')->format('c'), $data['changed']->format('c')); + $this->assertSame(array('test', 'val'), $data['x-custom'][0]); // for test_input2() below self::$original = $data; } /** * Test input method with merging */ function test_input2() { $input = new kolab_api_input_json_note; $data = array( 'description' => 'description1', 'summary' => 'summary1', 'classification' => 'PRIVATE', 'categories' => array('test1'), // 'creation-date' => '2015-04-20T14:22:18Z', // 'last-modification-date' => '2015-04-21T00:00:00Z', ); $input->input($data, self::$original); $this->assertSame('description1', $data['description']); $this->assertSame('summary1', $data['title']); $this->assertSame('private', $data['sensitivity']); $this->assertSame(array('test1'), $data['categories']); // $this->assertSame(kolab_api_input_json::to_datetime('2015-04-20T14:22:18Z')->format('c'), $data['created']->format('c')); // $this->assertSame(kolab_api_input_json::to_datetime('2015-04-21T00:00:00Z')->format('c'), $data['changed']->format('c')); } } diff --git a/tests/Unit/Output/Json/Note.php b/tests/Unit/Output/Json/Note.php index 3dfbd8d..6301435 100644 --- a/tests/Unit/Output/Json/Note.php +++ b/tests/Unit/Output/Json/Note.php @@ -1,28 +1,32 @@ element($object); $this->assertSame('1-1-1-1', $result['uid']); $this->assertSame('2015-01-20T11:44:59Z', $result['creation-date']); $this->assertSame('2015-01-22T11:30:17Z', $result['last-modification-date']); $this->assertSame('PUBLIC', $result['classification']); $this->assertSame('test', $result['summary']); $this->assertRegexp('//', $result['description']); + $this->assertSame('MAPI:PidLidNoteX', $result['x-custom'][0]['identifier']); + $this->assertSame('100', $result['x-custom'][0]['value']); + $this->assertSame('MAPI:PidLidNoteY', $result['x-custom'][1]['identifier']); + $this->assertSame('200', $result['x-custom'][1]['value']); } } diff --git a/tests/Unit/Output/Json/Task.php b/tests/Unit/Output/Json/Task.php index 47a3674..e08d4d7 100644 --- a/tests/Unit/Output/Json/Task.php +++ b/tests/Unit/Output/Json/Task.php @@ -1,51 +1,53 @@ element($object); $this->assertSame('10-10-10-10', $result['uid']); $this->assertSame('task title', $result['summary']); $this->assertSame('2015-04-20T14:22:18Z', $result['created']); $this->assertSame('2015-04-20T14:22:18Z', $result['dtstamp']); $this->assertSame(0, $result['sequence']); $this->assertSame('PUBLIC', $result['class']); $this->assertSame("task description\nsecond line", $result['description']); $this->assertSame(56, $result['percent-complete']); $this->assertSame('German, Mark', $result['organizer']['parameters']['cn']); $this->assertSame('mailto:%3Cmark.german%40example.org%3E', $result['organizer']['cal-address']); $this->assertSame('text/plain', $result['attach'][0]['parameters']['fmttype']); $this->assertSame('test.txt', $result['attach'][0]['parameters']['x-label']); $this->assertSame('cid:test.1429539738.5833.txt', $result['attach'][0]['uri']); + $this->assertSame('MAPI:PidLidTaskActualEffort', $result['x-custom'][0]['identifier']); + $this->assertSame('8', $result['x-custom'][0]['value']); $object = kolab_api_tests::get_data('20-20-20-20', md5('Tasks'), 'task', null, $context); $result = $output->element($object); $this->assertSame('20-20-20-20', $result['uid']); $this->assertSame('task', $result['summary']); $this->assertSame('2015-04-20', $result['dtstart']); $this->assertSame('2015-04-27', $result['due']); $this->assertSame('DAILY', $result['rrule']['recur']); $this->assertSame('NEEDS-ACTION', $result['status']); $this->assertSame('Manager, Jane', $result['attendee'][0]['parameters']['cn']); $this->assertSame('NEEDS-ACTION', $result['attendee'][0]['parameters']['partstat']); $this->assertSame('REQ-PARTICIPANT', $result['attendee'][0]['parameters']['role']); $this->assertSame('true', $result['attendee'][0]['parameters']['rsvp']); $this->assertSame('mailto:%3Cjane.manager%40example.org%3E', $result['attendee'][0]['cal-address']); } } diff --git a/tests/data/note/1-1-1-1 b/tests/data/note/1-1-1-1 index 9f3498b..625d477 100644 --- a/tests/data/note/1-1-1-1 +++ b/tests/data/note/1-1-1-1 @@ -1,50 +1,60 @@ MIME-Version: 1.0 Content-Type: multipart/mixed; boundary="=_a0704d5fd83943b1b5547923bc248816" From: mark.german@example.org To: mark.german@example.org Date: Thu, 22 Jan 2015 12:30:17 +0100 X-Kolab-Type: application/x-vnd.kolab.note X-Kolab-Mime-Version: 3.0 Subject: 1-1-1-1 User-Agent: Kolab 3.1/Roundcube 1.1-git --=_a0704d5fd83943b1b5547923bc248816 Content-Transfer-Encoding: quoted-printable Content-Type: text/plain; charset=ISO-8859-1 This is a Kolab Groupware object. To view this object you will need an emai= l client that understands the Kolab Groupware format. For a list of such em= ail clients please visit http://www.kolab.org/ --=_a0704d5fd83943b1b5547923bc248816 Content-Transfer-Encoding: 8bit Content-Type: application/vnd.kolab+xml; charset=UTF-8; name=kolab.xml Content-Disposition: attachment; filename=kolab.xml 1-1-1-1 Roundcube-libkolab-1.1 Libkolabxml-1.1 2015-01-20T11:44:59Z 2015-01-22T11:30:17Z PUBLIC test <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0//EN" "http://www.w3.org/TR/REC-html40/strict.dtd"> <html><head><meta name="qrichtext" content="1" /><meta http-equiv="Content-Type" /></head><body>test</body></html> + + MAPI:PidLidNoteX + 100 + + + + MAPI:PidLidNoteY + 200 + + --=_a0704d5fd83943b1b5547923bc248816-- diff --git a/tests/data/task/10-10-10-10 b/tests/data/task/10-10-10-10 index e2df828..9f07674 100644 --- a/tests/data/task/10-10-10-10 +++ b/tests/data/task/10-10-10-10 @@ -1,108 +1,112 @@ MIME-Version: 1.0 Content-Type: multipart/mixed; boundary="=_e2deba5349c302693970ce2a6f6c317f" From: mark.german@example.org To: mark.german@example.org Date: Mon, 20 Apr 2015 16:22:18 +0200 X-Kolab-Type: application/x-vnd.kolab.task X-Kolab-Mime-Version: 3.0 Subject: 10-10-10-10 User-Agent: Kolab 3.1/Roundcube 1.2-git --=_e2deba5349c302693970ce2a6f6c317f Content-Transfer-Encoding: quoted-printable Content-Type: text/plain; charset=ISO-8859-1 This is a Kolab Groupware object. To view this object you will need an emai= l client that understands the Kolab Groupware format. For a list of such em= ail clients please visit http://www.kolab.org/ --=_e2deba5349c302693970ce2a6f6c317f Content-Transfer-Encoding: 8bit Content-Type: application/calendar+xml; charset=UTF-8; name=kolab.xml Content-Disposition: attachment; filename=kolab.xml; size=1885 Roundcube-libkolab-1.1 Libkolabxml-1.1 2.0 3.1.0 10-10-10-10 2015-04-20T14:22:18Z 2015-04-20T14:22:18Z 0 PUBLIC task title task description second line 56 German, Mark mailto:%3Cmark.german%40example.org%3E text/plain test.txt cid:test.1429539738.5833.txt + + MAPI:PidLidTaskActualEffort + 8 + --=_e2deba5349c302693970ce2a6f6c317f Content-ID: Content-Transfer-Encoding: base64 Content-Type: text/plain; name=test.txt Content-Disposition: attachment; filename=test.txt; size=4 dGVzdA== --=_e2deba5349c302693970ce2a6f6c317f--