improve default attendee for CalDAV/ActiveSync
[tine20] / tine20 / Calendar / Model / Event.php
1 <?php
2 /**
3  * Tine 2.0
4  * 
5  * @package     Calendar
6  * @license     http://www.gnu.org/licenses/agpl.html AGPL Version 3
7  * @author      Cornelius Weiss <c.weiss@metaways.de>
8  * @copyright   Copyright (c) 2009-2014 Metaways Infosystems GmbH (http://www.metaways.de)
9  *
10  */
11
12 /**
13  * Model of an event
14  * 
15  * Recuring Notes: 
16  *  - deleted recurring exceptions are stored in exdate (array of datetimes)
17  *  - modified recurring exceptions have their own event with recurid set the uid-dtstart
18  *    of the originators event (@see RFC2445)
19  *  - as id is unique, each modified recurring event has its own id
20  *  - rrule is stored in RCF2445 format
21  *  - the rrule_until is redundat to the rrule until property for fast queries
22  *  - we don't use rrule count, they are converted to an until
23  *  - like always in tine, we save all dates in UTC, but to correctly compute
24  *    recurring events, we also save the timezone of the organizer
25  *  - despite RFC2445 we have an expicit isAllDayEvent property
26  * 
27  * @package Calendar
28  * @property Tinebase_Record_RecordSet alarms
29  * @property Tinebase_DateTime creation_time
30  * @property string is_all_day_event
31  * @property string originator_tz
32  * @property string seq
33  * @property string uid
34  * @property string etag
35  * @property int container_id
36  */
37 class Calendar_Model_Event extends Tinebase_Record_Abstract
38 {
39     const TRANSP_TRANSP        = 'TRANSPARENT';
40     const TRANSP_OPAQUE        = 'OPAQUE';
41     
42     const CLASS_PUBLIC         = 'PUBLIC';
43     const CLASS_PRIVATE        = 'PRIVATE';
44     //const CLASS_CONFIDENTIAL   = 'CONFIDENTIAL';
45     
46     const STATUS_CONFIRMED     = 'CONFIRMED';
47     const STATUS_TENTATIVE     = 'TENTATIVE';
48     const STATUS_CANCELED      = 'CANCELED';
49     
50     const RANGE_ALL           = 'ALL';
51     const RANGE_THIS          = 'THIS';
52     const RANGE_THISANDFUTURE = 'THISANDFUTURE';
53     
54     /**
55      * key in $_validators/$_properties array for the filed which 
56      * represents the identifier
57      * 
58      * @var string
59      */
60     protected $_identifier = 'id';
61     
62     /**
63      * application the record belongs to
64      *
65      * @var string
66      */
67     protected $_application = 'Calendar';
68     
69     /**
70      * validators
71      *
72      * @var array
73      */
74     protected $_validators = array(
75         // tine record fields
76         'id'                   => array(Zend_Filter_Input::ALLOW_EMPTY => true,  /*'Alnum'*/),
77         'container_id'         => array(Zend_Filter_Input::ALLOW_EMPTY => true,  'Int'  ),
78         'created_by'           => array(Zend_Filter_Input::ALLOW_EMPTY => true,         ),
79         'creation_time'        => array(Zend_Filter_Input::ALLOW_EMPTY => true          ),
80         'last_modified_by'     => array(Zend_Filter_Input::ALLOW_EMPTY => true          ),
81         'last_modified_time'   => array(Zend_Filter_Input::ALLOW_EMPTY => true          ),
82         'is_deleted'           => array(Zend_Filter_Input::ALLOW_EMPTY => true          ),
83         'deleted_time'         => array(Zend_Filter_Input::ALLOW_EMPTY => true          ),
84         'deleted_by'           => array(Zend_Filter_Input::ALLOW_EMPTY => true          ),
85         'seq'                  => array(Zend_Filter_Input::ALLOW_EMPTY => true,  'Int'  ),
86         // calendar only fields
87         'dtend'                => array(Zend_Filter_Input::ALLOW_EMPTY => true          ),
88         'transp'               => array(
89             Zend_Filter_Input::ALLOW_EMPTY => true,
90             array('InArray', array(self::TRANSP_OPAQUE, self::TRANSP_TRANSP))
91         ),
92         // ical common fields
93         'class'                => array(
94             Zend_Filter_Input::ALLOW_EMPTY => true,
95             array('InArray', array(self::CLASS_PUBLIC, self::CLASS_PRIVATE, /*self::CLASS_CONFIDENTIAL*/))
96         ),
97         'description'          => array(Zend_Filter_Input::ALLOW_EMPTY => true          ),
98         'geo'                  => array(Zend_Filter_Input::ALLOW_EMPTY => true, Zend_Filter_Input::DEFAULT_VALUE => NULL),
99         'location'             => array(Zend_Filter_Input::ALLOW_EMPTY => true          ),
100         'organizer'            => array(Zend_Filter_Input::ALLOW_EMPTY => false,        ),
101         'priority'             => array(Zend_Filter_Input::ALLOW_EMPTY => true, 'Int'   ),
102         'status'            => array(
103             Zend_Filter_Input::ALLOW_EMPTY => true,
104             array('InArray', array(self::STATUS_CONFIRMED, self::STATUS_TENTATIVE, self::STATUS_CANCELED))
105         ),
106         'summary'              => array(Zend_Filter_Input::ALLOW_EMPTY => true          ),
107         'url'                  => array(Zend_Filter_Input::ALLOW_EMPTY => true          ),
108         'uid'                  => array(Zend_Filter_Input::ALLOW_EMPTY => true          ),
109         'etag'                 => array(Zend_Filter_Input::ALLOW_EMPTY => true          ),
110         // ical common fields with multiple appearance
111         //'attach'                => array(Zend_Filter_Input::ALLOW_EMPTY => true         ),
112         'attendee'              => array(Zend_Filter_Input::ALLOW_EMPTY => true         ), // RecordSet of Calendar_Model_Attender
113         'alarms'                => array(Zend_Filter_Input::ALLOW_EMPTY => true         ), // RecordSet of Tinebase_Model_Alarm
114         'tags'                  => array(Zend_Filter_Input::ALLOW_EMPTY => true         ), // originally categories handled by Tinebase_Tags
115         'notes'                 => array(Zend_Filter_Input::ALLOW_EMPTY => true         ), // originally comment handled by Tinebase_Notes
116         'relations'             => array(Zend_Filter_Input::ALLOW_EMPTY => true         ),
117         'attachments'           => array(Zend_Filter_Input::ALLOW_EMPTY => true),
118         
119         //'contact'               => array(Zend_Filter_Input::ALLOW_EMPTY => true         ),
120         //'related'               => array(Zend_Filter_Input::ALLOW_EMPTY => true         ),
121         //'resources'             => array(Zend_Filter_Input::ALLOW_EMPTY => true         ),
122         //'rstatus'               => array(Zend_Filter_Input::ALLOW_EMPTY => true         ),
123         // ical scheduleable interface fields
124         'dtstart'               => array(Zend_Filter_Input::ALLOW_EMPTY => true         ),
125         'recurid'               => array(Zend_Filter_Input::ALLOW_EMPTY => true         ),
126         // ical scheduleable interface fields with multiple appearance
127         'exdate'                => array(Zend_Filter_Input::ALLOW_EMPTY => true         ), //  array of Tinebase_DateTimeTinebase_DateTime's
128         //'exrule'                => array(Zend_Filter_Input::ALLOW_EMPTY => true         ),
129         //'rdate'                 => array(Zend_Filter_Input::ALLOW_EMPTY => true         ),
130         'rrule'                 => array(Zend_Filter_Input::ALLOW_EMPTY => true         ),
131         // calendar helper fields
132
133         'is_all_day_event'      => array(Zend_Filter_Input::ALLOW_EMPTY => true         ),
134         'rrule_until'           => array(Zend_Filter_Input::ALLOW_EMPTY => true         ),
135         'originator_tz'         => array(Zend_Filter_Input::ALLOW_EMPTY => true         ),
136
137         // relations
138         'relations'             => array(Zend_Filter_Input::ALLOW_EMPTY => true, Zend_Filter_Input::DEFAULT_VALUE => NULL),
139         'customfields'          => array(Zend_Filter_Input::ALLOW_EMPTY => true, Zend_Filter_Input::DEFAULT_VALUE => array()),
140         
141         // grant helper fields
142         Tinebase_Model_Grants::GRANT_FREEBUSY => array(Zend_Filter_Input::ALLOW_EMPTY => true),
143         Tinebase_Model_Grants::GRANT_READ     => array(Zend_Filter_Input::ALLOW_EMPTY => true),
144         Tinebase_Model_Grants::GRANT_SYNC     => array(Zend_Filter_Input::ALLOW_EMPTY => true),
145         Tinebase_Model_Grants::GRANT_EXPORT   => array(Zend_Filter_Input::ALLOW_EMPTY => true),
146         Tinebase_Model_Grants::GRANT_EDIT     => array(Zend_Filter_Input::ALLOW_EMPTY => true),
147         Tinebase_Model_Grants::GRANT_DELETE   => array(Zend_Filter_Input::ALLOW_EMPTY => true),
148         Tinebase_Model_Grants::GRANT_PRIVATE  => array(Zend_Filter_Input::ALLOW_EMPTY => true),
149     );
150     
151     /**
152      * datetime fields
153      *
154      * @var array
155      */
156     protected $_datetimeFields = array(
157         'creation_time', 
158         'last_modified_time', 
159         'deleted_time', 
160         'completed', 
161         'dtstart', 
162         'dtend', 
163         'exdate',
164         //'rdate',
165         'rrule_until',
166     );
167     
168     /**
169      * name of fields that should be omited from modlog
170      *
171      * @var array list of modlog omit fields
172      */
173     protected $_modlogOmitFields = array(
174         Tinebase_Model_Grants::GRANT_READ,
175         Tinebase_Model_Grants::GRANT_SYNC,
176         Tinebase_Model_Grants::GRANT_EXPORT,
177         Tinebase_Model_Grants::GRANT_EDIT,
178         Tinebase_Model_Grants::GRANT_DELETE,
179         Tinebase_Model_Grants::GRANT_PRIVATE,
180     );
181     
182     /**
183      * sets record related properties
184      * 
185      * @param string _name of property
186      * @param mixed _value of property
187      * @throws Tinebase_Exception_UnexpectedValue
188      * @return void
189      */
190     public function __set($_name, $_value)
191     {
192         // ensure exdate as array
193         if ($_name == 'exdate' && ! empty($_value) && ! is_array($_value) && ! $_value instanceof Tinebase_Record_RecordSet ) {
194             $_value = array($_value);
195         }
196         
197         if ($_name == 'attendee' && is_array($_value)) {
198             $_value = new Tinebase_Record_RecordSet('Calendar_Model_Attender', $_value);
199         }
200         
201         if ($_name == 'rrule' && is_string($_value) && ! empty($_value)) {
202             // normalize rrule
203             $_value = new Calendar_Model_Rrule($_value);
204             $_value = (string) $_value;
205         }
206         parent::__set($_name, $_value);
207     }
208     
209     /**
210      * the constructor
211      * it is needed because we have more validation fields in Calendars
212      * 
213      * @param mixed $_data
214      * @param bool $bypassFilters sets {@see this->bypassFilters}
215      * @param bool $convertDates sets {@see $this->convertDates}
216      */
217     public function __construct($_data = NULL, $_bypassFilters = false, $_convertDates = true)
218     {
219         $this->_filters['organizer'] = new Zend_Filter_Empty(NULL);
220         
221         parent::__construct($_data, $_bypassFilters, $_convertDates);
222     }
223     
224     /**
225      * (non-PHPdoc)
226      * @see Tinebase_Record_Abstract::diff()
227      */
228     public function diff($record, $omitFields = array())
229     {
230         $checkRrule = false;
231         if (! in_array('rrule', $omitFields)) {
232             $omitFields[] = 'rrule';
233             $checkRrule = true;
234         }
235         
236         $diff = parent::diff($record, $omitFields);
237         
238         if ($checkRrule) {
239             $ownRrule    = ! $this->rrule instanceof Calendar_Model_Rrule ? Calendar_Model_Rrule::getRruleFromString((string) $this->rrule) : $this->rrule;
240             $recordRrule = ! $record->rrule instanceof Calendar_Model_Rrule ? Calendar_Model_Rrule::getRruleFromString($record->rrule) : $record->rrule;
241             
242             $rruleDiff = $ownRrule->diff($recordRrule);
243             
244             // don't take small ( < one day) rrule_until changes as diff
245             if (
246                     $ownRrule->until instanceof Tinebase_DateTime 
247                     && (isset($rruleDiff->diff['until']) || array_key_exists('until', $rruleDiff->diff)) && $rruleDiff->diff['until'] instanceof Tinebase_DateTime
248                     && abs($rruleDiff->diff['until']->getTimestamp() - $ownRrule->until->getTimestamp()) < 86400
249             ){
250                 $rruleDiffArray = $rruleDiff->diff;
251                 unset($rruleDiffArray['until']);
252                 $rruleDiff->diff = $rruleDiffArray;
253             }
254             
255             if (! empty($rruleDiff->diff)) {
256                 $diffArray = $diff->diff;
257                 $diffArray['rrule'] = $rruleDiff;
258                 
259                 $diff->diff = $diffArray;
260             }
261         }
262         
263         return $diff;
264     }
265     /**
266      * add given attendee if not present under given conditions
267      * 
268      * @param Calendar_Model_Attender $attendee
269      * @param bool                    $ifOrganizer        only add attendee if he's organizer
270      * @param bool                    $ifNoOtherAttendee  only add attendee if no other attendee are present
271      * @param bool                    $personalOnly       only for personal containers
272      */
273     public function assertAttendee($attendee, $ifOrganizer = true, $ifNoOtherAttendee = false, $personalOnly = false)
274     {
275         if ($personalOnly) {
276             try {
277                 $container = Tinebase_Container::getInstance()->getContainerById($this->container_id);
278                 if ($container->type != Tinebase_Model_Container::TYPE_PERSONAL) {
279                     if (Tinebase_Core::isLogLevel(Zend_Log::DEBUG)) Tinebase_Core::getLogger()->debug(
280                             __METHOD__ . '::' . __LINE__ . " not adding attendee as container is not personal.");
281                     return;
282                 }
283             } catch (Exception $e) {
284                 Tinebase_Core::getLogger()->info(__METHOD__ . '::' . __LINE__ . " cannot get container: $e");
285             }
286         }
287         
288         
289         if ($ifNoOtherAttendee && $this->attendee instanceof Tinebase_Record_RecordSet && $this->attendee->count() > 0) {
290             if (Tinebase_Core::isLogLevel(Zend_Log::DEBUG)) Tinebase_Core::getLogger()->debug(
291                     __METHOD__ . '::' . __LINE__ . " not adding attendee as other attendee are present.");
292             return;
293         }
294         
295         $assertionAttendee = Calendar_Model_Attender::getAttendee($this->attendee, $attendee);
296         
297         if (! $assertionAttendee) {
298             if ($ifOrganizer && ! $this->isOrganizer($attendee)) {
299                 if (Tinebase_Core::isLogLevel(Zend_Log::DEBUG)) Tinebase_Core::getLogger()->debug(
300                     __METHOD__ . '::' . __LINE__ . " not adding attendee as he is not organizer.");
301             }
302             
303             else {
304                 if (Tinebase_Core::isLogLevel(Zend_Log::DEBUG)) Tinebase_Core::getLogger()->debug(
305                     __METHOD__ . '::' . __LINE__ . " adding attendee.");
306                 
307                 $newAttender = new Calendar_Model_Attender(array(
308                     'user_id'   => $attendee->user_id,
309                     'user_type' => $attendee->user_type,
310                     'status'    => Calendar_Model_Attender::STATUS_ACCEPTED,
311                     'role'      => Calendar_Model_Attender::ROLE_REQUIRED
312                 ));
313                 
314                 if (! $this->attendee instanceof Tinebase_Record_RecordSet) {
315                     $this->attendee = new Tinebase_Record_RecordSet('Calendar_Model_Attender');
316                 }
317                 $this->attendee->addRecord($newAttender);
318             }
319         }
320     }
321     
322     /**
323      * returns the original dtstart of a recur series exception event 
324      *  -> when the event should have started with no exception
325      * 
326      * @return Tinebase_DateTime
327      */
328     public function getOriginalDtStart()
329     {
330         $origianlDtStart = $this->dtstart instanceof stdClass ? clone $this->dtstart : $this->dtstart;
331         
332         if ($this->isRecurException()) {
333             if ($this->recurid instanceof DateTime) {
334                 $origianlDtStart = clone $this->recurid;
335             } else if (is_string($this->recurid)) {
336                 $origianlDtStartString = substr($this->recurid, -19);
337                 if (! Tinebase_DateTime::isDate($origianlDtStartString)) {
338                     throw new Tinebase_Exception_InvalidArgument('recurid does not contain a valid original start date');
339                 }
340                 
341                 $origianlDtStart = new Tinebase_DateTime($origianlDtStartString, 'UTC');
342             }
343         }
344         
345         return $origianlDtStart;
346     }
347     
348     /**
349      * gets translated field name
350      * 
351      * NOTE: this has to be done explicitly as our field names are technically 
352      *       and have no translations
353      *       
354      * @param string         $_field
355      * @param Zend_Translate $_translation
356      * @return string
357      */
358     public static function getTranslatedFieldName($_field, $_translation)
359     {
360         $t = $_translation;
361         switch ($_field) {
362             case 'dtstart':           return $t->_('Start');
363             case 'dtend':             return $t->_('End');
364             case 'transp':            return $t->_('Blocking');
365             case 'class':             return $t->_('Classification');
366             case 'description':       return $t->_('Description');
367             case 'location':          return $t->_('Location');
368             case 'organizer':         return $t->_('Organizer');
369             case 'priority':          return $t->_('Priority');
370             case 'status':            return $t->_('Status');
371             case 'summary':           return $t->_('Summary');
372             case 'url':               return $t->_('Url');
373             case 'rrule':             return $t->_('Recurrance rule');
374             case 'is_all_day_event':  return $t->_('Is all day event');
375             case 'originator_tz':     return $t->_('Organizer timezone');
376             default:                  return $_field;
377         }
378     }
379     
380     /**
381      * gets translated value
382      * 
383      * NOTE: This is needed for values like Yes/No, Datetimes, etc.
384      * 
385      * @param  string           $_field
386      * @param  mixed            $_value
387      * @param  Zend_Translate   $_translation
388      * @param  string           $_timezone
389      * @return string
390      */
391     public static function getTranslatedValue($_field, $_value, $_translation, $_timezone)
392     {
393         if ($_value instanceof Tinebase_DateTime) {
394             $locale = new Zend_Locale($_translation->getAdapter()->getLocale());
395             return Tinebase_Translation::dateToStringInTzAndLocaleFormat($_value, $_timezone, $locale, 'datetime', true);
396         }
397         
398         switch ($_field) {
399             case 'transp':
400                 return $_value && $_value == Calendar_Model_Event::TRANSP_TRANSP ? $_translation->_('No') : $_translation->_('Yes');
401             case 'organizer':
402                 if (! $_value instanceof Addressbook_Model_Contact) {
403                     $organizer = Addressbook_Controller_Contact::getInstance()->getMultiple($_value, TRUE)->getFirstRecord();
404                 }
405                 return $organizer instanceof Addressbook_Model_Contact ? $organizer->n_fileas : '';
406             case 'rrule':
407                 if ($_value) {
408                     $rrule = $_value instanceof Calendar_Model_Rrule ? $_value : new Calendar_Model_Rrule($_value);
409                     return $rrule->getTranslatedRule($_translation);
410                 }
411             default:
412                 return $_value;
413         }
414     }
415     
416     /**
417      * checks event for given grant
418      * 
419      * @param  string $_grant
420      * @return bool
421      */
422     public function hasGrant($_grant)
423     {
424         $hasGrant = (isset($this->_properties[$_grant]) || array_key_exists($_grant, $this->_properties)) && (bool)$this->{$_grant};
425         
426         if ($this->class !== Calendar_Model_Event::CLASS_PUBLIC) {
427             $hasGrant &= (
428                 // private grant
429                 $this->{Tinebase_Model_Grants::GRANT_PRIVATE} ||
430                 // I'm organizer
431                 Tinebase_Core::getUser()->contact_id == ($this->organizer instanceof Addressbook_Model_Contact ? $this->organizer->getId() : $this->organizer) ||
432                 // I'm attendee
433                 Calendar_Model_Attender::getOwnAttender($this->attendee)
434             );
435         }
436         
437         return $hasGrant;
438     }
439     
440     /**
441      * event is an exception of a recur event series
442      * 
443      * @return boolean
444      */
445     public function isRecurException()
446     {
447         return !!$this->recurid;
448     }
449     
450     /**
451      * sets recurId of this model
452      * 
453      * @return string recurid which was set
454      */
455     public function setRecurId()
456     {
457         if (! ($this->uid && $this->dtstart)) {
458             throw new Exception ('uid _and_ dtstart must be set to generate recurid');
459         }
460         
461         // make sure we store recurid in utc
462         $dtstart = $this->getOriginalDtStart();
463         $dtstart->setTimezone('UTC');
464         
465         $this->recurid = $this->uid . '-' . $dtstart->get(Tinebase_Record_Abstract::ISO8601LONG);
466         
467         return $this->recurid;
468     }
469     
470     /**
471      * sets rrule until helper field
472      *
473      * @return void
474      */
475     public function setRruleUntil()
476     {
477         if (empty($this->rrule)) {
478             $this->rrule_until = NULL;
479         } else {
480             $rrule = $this->rrule;
481             if (! $this->rrule instanceof Calendar_Model_Rrule) {
482                 $rrule = new Calendar_Model_Rrule(array());
483                 $rrule->setFromString($this->rrule);
484                 $this->rrule = $rrule;
485             }
486             
487             if (isset($rrule->count)) {
488                 $this->rrule_until = NULL;
489                 $exdates = $this->exdate;
490                 $this->exdate = NULL;
491                 
492                 $lastOccurrence = Calendar_Model_Rrule::computeNextOccurrence($this, new Tinebase_Record_RecordSet('Calendar_Model_Event'), $this->dtend, $rrule->count -1);
493                 $this->rrule_until = $lastOccurrence->dtend;
494                 $this->exdate = $exdates;
495             } else {
496                 // set until to end of day in organizers timezone.
497                 // NOTE: this is in contrast to the iCal spec which says until should be the
498                 //       dtstart of the last occurence. But as the client with the name of the
499                 //       spec sets it to the end of the day, we do it also.
500                 if ($rrule->until instanceof Tinebase_DateTime) {
501                     $rrule->until->setTimezone($this->originator_tz);
502                     // NOTE: subSecond cause some clients send 00:00:00 for midnight
503                     $rrule->until->subSecond(1)->setTime(23, 59, 59);
504                     $rrule->until->setTimezone('UTC');
505                 }
506                 
507                 $this->rrule_until = $rrule->until;
508             }
509         }
510         
511         if ($this->rrule_until && $this->rrule_until->getTimeStamp() - $this->dtstart->getTimeStamp() < -1) {
512             throw new Tinebase_Exception_Record_Validation('rrule until must not be before dtstart');
513         }
514     }
515     
516     /**
517      * cleans up data to only contain freebusy infos
518      * removes all fields except dtstart/dtend/id/modlog fields
519      * 
520      * @return boolean TRUE if cleanup took place
521      */
522     public function doFreeBusyCleanup()
523     {
524         if ($this->hasGrant(Tinebase_Model_Grants::GRANT_READ)) {
525            return FALSE;
526         }
527         
528         $this->_properties = array_intersect_key($this->_properties, array_flip(array(
529             'id', 
530             'dtstart', 
531             'dtend',
532             'transp',
533             'seq',
534             'uid',
535             'is_all_day_event',
536             'rrule',
537             'rrule_until',
538             'recurid',
539             'exdate',
540             'originator_tz',
541             'attendee', // if we remove this, we need to adopt attendee resolveing
542             'container_id',
543             'created_by',
544             'creation_time',
545             'last_modified_by',
546             'last_modified_time',
547             'is_deleted',
548             'deleted_time',
549             'deleted_by',
550         )));
551         
552         return TRUE;
553     }
554     
555     /**
556      * sets the record related properties from user generated input.
557      * 
558      * Input-filtering and validation by Zend_Filter_Input can enabled and disabled
559      *
560      * @param array $_data            the new data to set
561      * @throws Tinebase_Exception_Record_Validation when content contains invalid or missing data
562      */
563     public function setFromArray(array $_data)
564     {
565         if (empty($_data['geo'])) {
566             $_data['geo'] = NULL;
567         }
568         
569         if (empty($_data['class'])) {
570             $_data['class'] = self::CLASS_PUBLIC;
571         }
572         
573         if (empty($_data['priority'])) {
574             $_data['priority'] = NULL;
575         }
576         
577         if (empty($_data['status'])) {
578             $_data['status'] = self::STATUS_CONFIRMED;
579         }
580         
581         if (isset($_data['container_id']) && is_array($_data['container_id'])) {
582             $_data['container_id'] = $_data['container_id']['id'];
583         }
584         
585         if (isset($_data['organizer']) && is_array($_data['organizer'])) {
586             $_data['organizer'] = $_data['organizer']['id'];
587         }
588         
589         if (isset($_data['attendee']) && is_array($_data['attendee'])) {
590             $_data['attendee'] = new Tinebase_Record_RecordSet('Calendar_Model_Attender', $_data['attendee'], $this->bypassFilters, $this->convertDates);
591         }
592         
593         if (isset($_data['rrule']) && ! empty($_data['rrule']) && ! $_data['rrule'] instanceof Calendar_Model_Rrule) {
594             // rrule can be array or string
595             $_data['rrule'] = new Calendar_Model_Rrule($_data['rrule'], $this->bypassFilters, $this->convertDates);
596         }
597         
598         if (isset($_data['alarms']) && is_array($_data['alarms'])) {
599             $_data['alarms'] = new Tinebase_Record_RecordSet('Tinebase_Model_Alarm', $_data['alarms'], TRUE, $this->convertDates);
600         }
601         
602         parent::setFromArray($_data);
603     }
604     
605     /**
606      * checks if event matches period filter
607      * 
608      * @param Calendar_Model_PeriodFilter $_period
609      * @return boolean
610      */
611     public function isInPeriod(Calendar_Model_PeriodFilter $_period)
612     {
613         $result = TRUE;
614         
615         if ($this->dtend->compare($_period->getFrom()) == -1 || $this->dtstart->compare($_period->getUntil()) == 1) {
616             $result = FALSE;
617         }
618         
619         return $result;
620     }
621     
622     /**
623      * returns TRUE if comparison detects a resechedule / significant change
624      * 
625      * @param  Calendar_Model_Event $_event
626      * @return bool
627      */
628     public function isRescheduled($_event)
629     {
630         $diff = $this->diff($_event)->diff;
631         
632         return (isset($diff['dtstart']) || array_key_exists('dtstart', $diff))
633             || (! $this->is_all_day_event && (isset($diff['dtend']) || array_key_exists('dtend', $diff)))
634             || (isset($diff['rrule']) || array_key_exists('rrule', $diff));
635     }
636     
637     /**
638      * sets and returns the addressbook entry of the organizer
639      * 
640      * @return Addressbook_Model_Contact
641      */
642     public function resolveOrganizer()
643     {
644         if (! empty($this->organizer) && ! $this->organizer instanceof Addressbook_Model_Contact) {
645             $contacts = Addressbook_Controller_Contact::getInstance()->getMultiple($this->organizer, TRUE);
646             if (count($contacts)) {
647                 $this->organizer = $contacts->getFirstRecord();
648             }
649         }
650         
651         return $this->organizer;
652     }
653     
654     /**
655      * checks if given attendee is organizer of this event
656      * 
657      * @param Calendar_Model_Attender $_attendee
658      */
659     public function isOrganizer($_attendee=NULL)
660     {
661         $organizerContactId = NULL;
662         if ($_attendee && in_array($_attendee->user_type, array(Calendar_Model_Attender::USERTYPE_USER, Calendar_Model_Attender::USERTYPE_GROUPMEMBER))) {
663             $organizerContactId = $_attendee->user_id instanceof Tinebase_Record_Abstract ? $_attendee->user_id->getId() : $_attendee->user_id;
664         } else {
665             $organizerContactId = Tinebase_Core::getUser()->contact_id;
666         }
667         
668         return $organizerContactId == ($this->organizer instanceof Tinebase_Record_Abstract ? $this->organizer->getId() : $this->organizer);
669     }
670 }