kolab_format_xcal.php
No OneTemporary
Actions

Size

17 KB

Referenced Files

None

Subscribers

None

kolab_format_xcal.php
View Options

	<?php

	/**
	* Xcal based Kolab format class wrapping libkolabxml bindings
	*
	* Base class for xcal-based Kolab groupware objects such as event, todo, journal
	*
	* @version @package_version@
	* @author Thomas Bruederli <bruederli@kolabsys.com>
	*
	* Copyright (C) 2012, Kolab Systems AG <contact@kolabsys.com>
	*
	* This program is free software: you can redistribute it and/or modify
	* it under the terms of the GNU Affero General Public License as
	* published by the Free Software Foundation, either version 3 of the
	* License, or (at your option) any later version.
	*
	* This program is distributed in the hope that it will be useful,
	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	* GNU Affero General Public License for more details.
	*
	* You should have received a copy of the GNU Affero General Public License
	* along with this program. If not, see <http://www.gnu.org/licenses/>.
	*/

	abstract class kolab_format_xcal extends kolab_format
	{
	public $CTYPE = 'application/calendar+xml';

	public static $fulltext_cols = array('title', 'description', 'location', 'attendees:name', 'attendees:email', 'categories');

	protected $sensitivity_map = array(
	'public' => kolabformat::ClassPublic,
	'private' => kolabformat::ClassPrivate,
	'confidential' => kolabformat::ClassConfidential,
	);

	protected $role_map = array(
	'REQ-PARTICIPANT' => kolabformat::Required,
	'OPT-PARTICIPANT' => kolabformat::Optional,
	'NON-PARTICIPANT' => kolabformat::NonParticipant,
	'CHAIR' => kolabformat::Chair,
	);

	protected $cutype_map = array(
	'INDIVIDUAL' => kolabformat::CutypeIndividual,
	'GROUP' => kolabformat::CutypeGroup,
	'ROOM' => kolabformat::CutypeRoom,
	'RESOURCE' => kolabformat::CutypeResource,
	'UNKNOWN' => kolabformat::CutypeUnknown,
	);

	protected $rrule_type_map = array(
	'MINUTELY' => RecurrenceRule::Minutely,
	'HOURLY' => RecurrenceRule::Hourly,
	'DAILY' => RecurrenceRule::Daily,
	'WEEKLY' => RecurrenceRule::Weekly,
	'MONTHLY' => RecurrenceRule::Monthly,
	'YEARLY' => RecurrenceRule::Yearly,
	);

	protected $weekday_map = array(
	'MO' => kolabformat::Monday,
	'TU' => kolabformat::Tuesday,
	'WE' => kolabformat::Wednesday,
	'TH' => kolabformat::Thursday,
	'FR' => kolabformat::Friday,
	'SA' => kolabformat::Saturday,
	'SU' => kolabformat::Sunday,
	);

	protected $alarm_type_map = array(
	'DISPLAY' => Alarm::DisplayAlarm,
	'EMAIL' => Alarm::EMailAlarm,
	'AUDIO' => Alarm::AudioAlarm,
	);

	private $status_map = array(
	'NEEDS-ACTION' => kolabformat::StatusNeedsAction,
	'IN-PROCESS' => kolabformat::StatusInProcess,
	'COMPLETED' => kolabformat::StatusCompleted,
	'CANCELLED' => kolabformat::StatusCancelled,
	);

	protected $part_status_map = array(
	'UNKNOWN' => kolabformat::PartNeedsAction,
	'NEEDS-ACTION' => kolabformat::PartNeedsAction,
	'TENTATIVE' => kolabformat::PartTentative,
	'ACCEPTED' => kolabformat::PartAccepted,
	'DECLINED' => kolabformat::PartDeclined,
	'DELEGATED' => kolabformat::PartDelegated,
	);


	/**
	* Convert common xcard properties into a hash array data structure
	*
	* @param array Additional data for merge
	*
	* @return array Object data as hash array
	*/
	public function to_array($data = array())
	{
	// read common object props
	$object = parent::to_array($data);

	$status_map = array_flip($this->status_map);
	$sensitivity_map = array_flip($this->sensitivity_map);

	$object += array(
	'sequence' => intval($this->obj->sequence()),
	'title' => $this->obj->summary(),
	'location' => $this->obj->location(),
	'description' => $this->obj->description(),
	'url' => $this->obj->url(),
	'status' => $status_map[$this->obj->status()],
	'sensitivity' => $sensitivity_map[$this->obj->classification()],
	'priority' => $this->obj->priority(),
	'categories' => self::vector2array($this->obj->categories()),
	'start' => self::php_datetime($this->obj->start()),
	);

	// read organizer and attendees
	if (($organizer = $this->obj->organizer()) && ($organizer->email() \|\| $organizer->name())) {
	$object['organizer'] = array(
	'email' => $organizer->email(),
	'name' => $organizer->name(),
	);
	}

	$role_map = array_flip($this->role_map);
	$cutype_map = array_flip($this->cutype_map);
	$part_status_map = array_flip($this->part_status_map);
	$attvec = $this->obj->attendees();
	for ($i=0; $i < $attvec->size(); $i++) {
	$attendee = $attvec->get($i);
	$cr = $attendee->contact();
	if ($cr->email() != $object['organizer']['email']) {
	$object['attendees'][] = array(
	'role' => $role_map[$attendee->role()],
	'cutype' => $cutype_map[$attendee->cutype()],
	'status' => $part_status_map[$attendee->partStat()],
	'rsvp' => $attendee->rsvp(),
	'email' => $cr->email(),
	'name' => $cr->name(),
	);
	}
	}

	// read recurrence rule
	if (($rr = $this->obj->recurrenceRule()) && $rr->isValid()) {
	$rrule_type_map = array_flip($this->rrule_type_map);
	$object['recurrence'] = array('FREQ' => $rrule_type_map[$rr->frequency()]);

	if ($intvl = $rr->interval())
	$object['recurrence']['INTERVAL'] = $intvl;

	if (($count = $rr->count()) && $count > 0) {
	$object['recurrence']['COUNT'] = $count;
	}
	else if ($until = self::php_datetime($rr->end())) {
	$until->setTime($object['start']->format('G'), $object['start']->format('i'), 0);
	$object['recurrence']['UNTIL'] = $until;
	}

	if (($byday = $rr->byday()) && $byday->size()) {
	$weekday_map = array_flip($this->weekday_map);
	$weekdays = array();
	for ($i=0; $i < $byday->size(); $i++) {
	$daypos = $byday->get($i);
	$prefix = $daypos->occurence();
	$weekdays[] = ($prefix ? $prefix : '') . $weekday_map[$daypos->weekday()];
	}
	$object['recurrence']['BYDAY'] = join(',', $weekdays);
	}

	if (($bymday = $rr->bymonthday()) && $bymday->size()) {
	$object['recurrence']['BYMONTHDAY'] = join(',', self::vector2array($bymday));
	}

	if (($bymonth = $rr->bymonth()) && $bymonth->size()) {
	$object['recurrence']['BYMONTH'] = join(',', self::vector2array($bymonth));
	}

	if ($exdates = $this->obj->exceptionDates()) {
	for ($i=0; $i < $exdates->size(); $i++) {
	if ($exdate = self::php_datetime($exdates->get($i)))
	$object['recurrence']['EXDATE'][] = $exdate;
	}
	}
	}

	// read alarm
	$valarms = $this->obj->alarms();
	$alarm_types = array_flip($this->alarm_type_map);
	for ($i=0; $i < $valarms->size(); $i++) {
	$alarm = $valarms->get($i);
	$type = $alarm_types[$alarm->type()];

	if ($type == 'DISPLAY' \|\| $type == 'EMAIL') { // only DISPLAY and EMAIL alarms are supported
	if ($start = self::php_datetime($alarm->start())) {
	$object['alarms'] = '@' . $start->format('U');
	}
	else if ($offset = $alarm->relativeStart()) {
	$value = $alarm->relativeTo() == kolabformat::End ? '+' : '-';
	if ($w = $offset->weeks()) $value .= $w . 'W';
	else if ($d = $offset->days()) $value .= $d . 'D';
	else if ($h = $offset->hours()) $value .= $h . 'H';
	else if ($m = $offset->minutes()) $value .= $m . 'M';
	else if ($s = $offset->seconds()) $value .= $s . 'S';
	else continue;

	$object['alarms'] = $value;
	}
	$object['alarms'] .= ':' . $type;
	break;
	}
	}

	// handle attachments
	$vattach = $this->obj->attachments();
	for ($i=0; $i < $vattach->size(); $i++) {
	$attach = $vattach->get($i);

	// skip cid: attachments which are mime message parts handled by kolab_storage_folder
	if (substr($attach->uri(), 0, 4) != 'cid:' && $attach->label()) {
	$name = $attach->label();
	$content = $attach->data();
	$object['_attachments'][$name] = array(
	'name' => $name,
	'mimetype' => $attach->mimetype(),
	'size' => strlen($content),
	'content' => $content,
	);
	}
	else if (substr($attach->uri(), 0, 4) == 'http') {
	$object['links'][] = $attach->uri();
	}
	}

	return $object;
	}


	/**
	* Set common xcal properties to the kolabformat object
	*
	* @param array Event data as hash array
	*/
	public function set(&$object)
	{
	$this->init();

	$is_new = !$this->obj->uid();

	// set common object properties
	parent::set($object);

	// increment sequence on updates
	if (empty($object['sequence']))
	$object['sequence'] = !$is_new ? $this->obj->sequence()+1 : 0;
	$this->obj->setSequence($object['sequence']);

	$this->obj->setSummary($object['title']);
	$this->obj->setLocation($object['location']);
	$this->obj->setDescription($object['description']);
	$this->obj->setPriority($object['priority']);
	$this->obj->setClassification($this->sensitivity_map[$object['sensitivity']]);
	$this->obj->setCategories(self::array2vector($object['categories']));
	$this->obj->setUrl(strval($object['url']));

	// process event attendees
	$attendees = new vectorattendee;
	foreach ((array)$object['attendees'] as $attendee) {
	if ($attendee['role'] == 'ORGANIZER') {
	$object['organizer'] = $attendee;
	}
	else if ($attendee['email'] != $object['organizer']['email']) {
	$cr = new ContactReference(ContactReference::EmailReference, $attendee['email']);
	$cr->setName($attendee['name']);

	$att = new Attendee;
	$att->setContact($cr);
	$att->setPartStat($this->part_status_map[$attendee['status']]);
	$att->setRole($this->role_map[$attendee['role']] ? $this->role_map[$attendee['role']] : kolabformat::Required);
	$att->setCutype($this->cutype_map[$attendee['cutype']] ? $this->cutype_map[$attendee['cutype']] : kolabformat::CutypeIndividual);
	$att->setRSVP((bool)$attendee['rsvp']);

	if ($att->isValid()) {
	$attendees->push($att);
	}
	else {
	rcube::raise_error(array(
	'code' => 600, 'type' => 'php',
	'file' => __FILE__, 'line' => __LINE__,
	'message' => "Invalid event attendee: " . json_encode($attendee),
	), true);
	}
	}
	}
	$this->obj->setAttendees($attendees);

	if ($object['organizer']) {
	$organizer = new ContactReference(ContactReference::EmailReference, $object['organizer']['email']);
	$organizer->setName($object['organizer']['name']);
	$this->obj->setOrganizer($organizer);
	}

	// save recurrence rule
	$rr = new RecurrenceRule;
	$rr->setFrequency(RecurrenceRule::FreqNone);

	if ($object['recurrence']) {
	$rr->setFrequency($this->rrule_type_map[$object['recurrence']['FREQ']]);

	if ($object['recurrence']['INTERVAL'])
	$rr->setInterval(intval($object['recurrence']['INTERVAL']));

	if ($object['recurrence']['BYDAY']) {
	$byday = new vectordaypos;
	foreach (explode(',', $object['recurrence']['BYDAY']) as $day) {
	$occurrence = 0;
	if (preg_match('/^([\d-]+)([A-Z]+)$/', $day, $m)) {
	$occurrence = intval($m[1]);
	$day = $m[2];
	}
	if (isset($this->weekday_map[$day]))
	$byday->push(new DayPos($occurrence, $this->weekday_map[$day]));
	}
	$rr->setByday($byday);
	}

	if ($object['recurrence']['BYMONTHDAY']) {
	$bymday = new vectori;
	foreach (explode(',', $object['recurrence']['BYMONTHDAY']) as $day)
	$bymday->push(intval($day));
	$rr->setBymonthday($bymday);
	}

	if ($object['recurrence']['BYMONTH']) {
	$bymonth = new vectori;
	foreach (explode(',', $object['recurrence']['BYMONTH']) as $month)
	$bymonth->push(intval($month));
	$rr->setBymonth($bymonth);
	}

	if ($object['recurrence']['COUNT'])
	$rr->setCount(intval($object['recurrence']['COUNT']));
	else if ($object['recurrence']['UNTIL'])
	$rr->setEnd(self::get_datetime($object['recurrence']['UNTIL'], null, true));

	if ($rr->isValid()) {
	// add exception dates (only if recurrence rule is valid)
	$exdates = new vectordatetime;
	foreach ((array)$object['recurrence']['EXDATE'] as $exdate)
	$exdates->push(self::get_datetime($exdate, null, true));
	$this->obj->setExceptionDates($exdates);
	}
	else {
	rcube::raise_error(array(
	'code' => 600, 'type' => 'php',
	'file' => __FILE__, 'line' => __LINE__,
	'message' => "Invalid event recurrence rule: " . json_encode($object['recurrence']),
	), true);
	}
	}

	$this->obj->setRecurrenceRule($rr);

	// save alarm
	$valarms = new vectoralarm;
	if ($object['alarms']) {
	list($offset, $type) = explode(":", $object['alarms']);

	if ($type == 'EMAIL') { // email alarms implicitly go to event owner
	$recipients = new vectorcontactref;
	$recipients->push(new ContactReference(ContactReference::EmailReference, $object['_owner']));
	$alarm = new Alarm($object['title'], strval($object['description']), $recipients);
	}
	else { // default: display alarm
	$alarm = new Alarm($object['title']);
	}

	if (preg_match('/^@(\d+)/', $offset, $d)) {
	$alarm->setStart(self::get_datetime($d[1], new DateTimeZone('UTC')));
	}
	else if (preg_match('/^([-+]?)P?T?(\d+)([SMHDW])/', $offset, $d)) {
	$days = $hours = $minutes = $seconds = 0;
	switch ($d[3]) {
	case 'W': $days = 7*intval($d[2]); break;
	case 'D': $days = intval($d[2]); break;
	case 'H': $hours = intval($d[2]); break;
	case 'M': $minutes = intval($d[2]); break;
	case 'S': $seconds = intval($d[2]); break;
	}
	$alarm->setRelativeStart(new Duration($days, $hours, $minutes, $seconds, $d[1] == '-'), $d[1] == '-' ? kolabformat::Start : kolabformat::End);
	}

	$valarms->push($alarm);
	}
	$this->obj->setAlarms($valarms);

	// save attachments
	$vattach = new vectorattachment;
	foreach ((array)$object['_attachments'] as $cid => $attr) {
	if (empty($attr))
	continue;
	$attach = new Attachment;
	$attach->setLabel((string)$attr['name']);
	$attach->setUri('cid:' . $cid, $attr['mimetype']);
	$vattach->push($attach);
	}

	foreach ((array)$object['links'] as $link) {
	$attach = new Attachment;
	$attach->setUri($link, 'unknown');
	$vattach->push($attach);
	}

	$this->obj->setAttachments($vattach);
	}

	/**
	* Callback for kolab_storage_cache to get words to index for fulltext search
	*
	* @return array List of words to save in cache
	*/
	public function get_words()
	{
	$data = '';
	foreach (self::$fulltext_cols as $colname) {
	list($col, $field) = explode(':', $colname);

	if ($field) {
	$a = array();
	foreach ((array)$this->data[$col] as $attr)
	$a[] = $attr[$field];
	$val = join(' ', $a);
	}
	else {
	$val = is_array($this->data[$col]) ? join(' ', $this->data[$col]) : $this->data[$col];
	}

	if (strlen($val))
	$data .= $val . ' ';
	}

	return array_unique(rcube_utils::normalize_string($data, true));
	}

	}

File Metadata

Mime Type: text/x-php
Expires: Fri, May 22, 4:53 AM (1 d, 13 h)
Storage Engine: blob
Storage Format: Raw Data
Storage Handle: 754893
Default Alt Text: kolab_format_xcal.php (17 KB)

kolab_format_xcal.phpNo OneTemporaryActions

kolab_format_xcal.phpView Options

File Metadata

Event Timeline

kolab_format_xcal.php
No OneTemporary
Actions

kolab_format_xcal.php
View Options