0011256: Update event with "this and future" hides last event
[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         'external_seq'         => array(Zend_Filter_Input::ALLOW_EMPTY => true,  'Int'  ), // external seq for caldav / imip update handling
88         'dtend'                => array(Zend_Filter_Input::ALLOW_EMPTY => true          ),
89         'transp'               => array(
90             Zend_Filter_Input::ALLOW_EMPTY => true,
91             array('InArray', array(self::TRANSP_OPAQUE, self::TRANSP_TRANSP))
92         ),
93         // ical common fields
94         'class'                => array(
95             Zend_Filter_Input::ALLOW_EMPTY => true,
96             array('InArray', array(self::CLASS_PUBLIC, self::CLASS_PRIVATE, /*self::CLASS_CONFIDENTIAL*/))
97         ),
98         'description'          => array(Zend_Filter_Input::ALLOW_EMPTY => true          ),
99         'geo'                  => array(Zend_Filter_Input::ALLOW_EMPTY => true, Zend_Filter_Input::DEFAULT_VALUE => NULL),
100         'location'             => array(Zend_Filter_Input::ALLOW_EMPTY => true          ),
101         'organizer'            => array(Zend_Filter_Input::ALLOW_EMPTY => false,        ),
102         'priority'             => array(Zend_Filter_Input::ALLOW_EMPTY => true, 'Int'   ),
103         'status'            => array(
104             Zend_Filter_Input::ALLOW_EMPTY => true,
105             array('InArray', array(self::STATUS_CONFIRMED, self::STATUS_TENTATIVE, self::STATUS_CANCELED))
106         ),
107         'summary'              => array(Zend_Filter_Input::ALLOW_EMPTY => true          ),
108         'url'                  => array(Zend_Filter_Input::ALLOW_EMPTY => true          ),
109         'uid'                  => array(Zend_Filter_Input::ALLOW_EMPTY => true          ),
110         'etag'                 => array(Zend_Filter_Input::ALLOW_EMPTY => true          ),
111         // ical common fields with multiple appearance
112         //'attach'                => array(Zend_Filter_Input::ALLOW_EMPTY => true         ),
113         'attendee'              => array(Zend_Filter_Input::ALLOW_EMPTY => true         ), // RecordSet of Calendar_Model_Attender
114         'alarms'                => array(Zend_Filter_Input::ALLOW_EMPTY => true         ), // RecordSet of Tinebase_Model_Alarm
115         'tags'                  => array(Zend_Filter_Input::ALLOW_EMPTY => true         ), // originally categories handled by Tinebase_Tags
116         'notes'                 => array(Zend_Filter_Input::ALLOW_EMPTY => true         ), // originally comment handled by Tinebase_Notes
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         'mute'                  => array(Zend_Filter_Input::ALLOW_EMPTY => true, Zend_Filter_Input::DEFAULT_VALUE => false      ),
137
138         // relations
139         'relations'             => array(Zend_Filter_Input::ALLOW_EMPTY => true, Zend_Filter_Input::DEFAULT_VALUE => NULL),
140         'customfields'          => array(Zend_Filter_Input::ALLOW_EMPTY => true, Zend_Filter_Input::DEFAULT_VALUE => array()),
141         
142         // grant helper fields
143         Tinebase_Model_Grants::GRANT_FREEBUSY => array(Zend_Filter_Input::ALLOW_EMPTY => true),
144         Tinebase_Model_Grants::GRANT_READ     => array(Zend_Filter_Input::ALLOW_EMPTY => true),
145         Tinebase_Model_Grants::GRANT_SYNC     => array(Zend_Filter_Input::ALLOW_EMPTY => true),
146         Tinebase_Model_Grants::GRANT_EXPORT   => array(Zend_Filter_Input::ALLOW_EMPTY => true),
147         Tinebase_Model_Grants::GRANT_EDIT     => array(Zend_Filter_Input::ALLOW_EMPTY => true),
148         Tinebase_Model_Grants::GRANT_DELETE   => array(Zend_Filter_Input::ALLOW_EMPTY => true),
149         Tinebase_Model_Grants::GRANT_PRIVATE  => array(Zend_Filter_Input::ALLOW_EMPTY => true),
150     );
151     
152     /**
153      * datetime fields
154      *
155      * @var array
156      */
157     protected $_datetimeFields = array(
158         'creation_time', 
159         'last_modified_time', 
160         'deleted_time', 
161         'completed', 
162         'dtstart', 
163         'dtend', 
164         'exdate',
165         //'rdate',
166         'rrule_until',
167     );
168     
169     /**
170      * name of fields that should be omited from modlog
171      *
172      * @var array list of modlog omit fields
173      */
174     protected $_modlogOmitFields = array(
175         Tinebase_Model_Grants::GRANT_READ,
176         Tinebase_Model_Grants::GRANT_SYNC,
177         Tinebase_Model_Grants::GRANT_EXPORT,
178         Tinebase_Model_Grants::GRANT_EDIT,
179         Tinebase_Model_Grants::GRANT_DELETE,
180         Tinebase_Model_Grants::GRANT_PRIVATE,
181     );
182     
183     /**
184      * sets record related properties
185      * 
186      * @param string _name of property
187      * @param mixed _value of property
188      * @throws Tinebase_Exception_UnexpectedValue
189      * @return void
190      */
191     public function __set($_name, $_value)
192     {
193         // ensure exdate as array
194         if ($_name == 'exdate' && ! empty($_value) && ! is_array($_value) && ! $_value instanceof Tinebase_Record_RecordSet ) {
195             $_value = array($_value);
196         }
197         
198         if ($_name == 'attendee' && is_array($_value)) {
199             $_value = new Tinebase_Record_RecordSet('Calendar_Model_Attender', $_value);
200         }
201         
202         if ($_name == 'rrule' && is_string($_value) && ! empty($_value)) {
203             // normalize rrule
204             $_value = new Calendar_Model_Rrule($_value);
205             $_value = (string) $_value;
206         }
207         parent::__set($_name, $_value);
208     }
209     
210     /**
211      * the constructor
212      * it is needed because we have more validation fields in Calendars
213      * 
214      * @param mixed $_data
215      * @param bool $bypassFilters sets {@see this->bypassFilters}
216      * @param bool $convertDates sets {@see $this->convertDates}
217      */
218     public function __construct($_data = NULL, $_bypassFilters = false, $_convertDates = true)
219     {
220         $this->_filters['organizer'] = new Zend_Filter_Empty(NULL);
221         
222         parent::__construct($_data, $_bypassFilters, $_convertDates);
223     }
224     
225     /**
226      * (non-PHPdoc)
227      * @see Tinebase_Record_Abstract::diff()
228      */
229     public function diff($record, $omitFields = array())
230     {
231         $checkRrule = false;
232         if (! in_array('rrule', $omitFields)) {
233             $omitFields[] = 'rrule';
234             $checkRrule = true;
235         }
236         
237         $diff = parent::diff($record, $omitFields);
238         
239         if ($checkRrule) {
240             $ownRrule    = ! $this->rrule instanceof Calendar_Model_Rrule ? Calendar_Model_Rrule::getRruleFromString((string) $this->rrule) : $this->rrule;
241             $recordRrule = ! $record->rrule instanceof Calendar_Model_Rrule ? Calendar_Model_Rrule::getRruleFromString($record->rrule) : $record->rrule;
242             
243             $rruleDiff = $ownRrule->diff($recordRrule);
244             
245             // don't take small ( < one day) rrule_until changes as diff
246             if (
247                     $ownRrule->until instanceof Tinebase_DateTime 
248                     && (isset($rruleDiff->diff['until']) || array_key_exists('until', $rruleDiff->diff)) && $rruleDiff->diff['until'] instanceof Tinebase_DateTime
249                     && abs($rruleDiff->diff['until']->getTimestamp() - $ownRrule->until->getTimestamp()) < 86400
250             ){
251                 $rruleDiffArray = $rruleDiff->diff;
252                 unset($rruleDiffArray['until']);
253                 $rruleDiff->diff = $rruleDiffArray;
254             }
255             
256             if (! empty($rruleDiff->diff)) {
257                 $diffArray = $diff->diff;
258                 $diffArray['rrule'] = $rruleDiff;
259                 
260                 $diff->diff = $diffArray;
261             }
262         }
263         
264         return $diff;
265     }
266     /**
267      * add given attendee if not present under given conditions
268      * 
269      * @param Calendar_Model_Attender  $attendee
270      * @param bool                     $ifOrganizer        only add attendee if he's organizer
271      * @param bool                     $ifNoOtherAttendee  only add attendee if no other attendee are present
272      * @param bool                     $personalOnly       only for personal containers
273      * @return Calendar_Model_Attender asserted attendee
274      */
275     public function assertAttendee($attendee, $ifOrganizer = true, $ifNoOtherAttendee = false, $personalOnly = false)
276     {
277         if ($personalOnly) {
278             try {
279                 $container = Tinebase_Container::getInstance()->getContainerById($this->container_id);
280                 if ($container->type != Tinebase_Model_Container::TYPE_PERSONAL) {
281                     if (Tinebase_Core::isLogLevel(Zend_Log::DEBUG)) Tinebase_Core::getLogger()->debug(
282                             __METHOD__ . '::' . __LINE__ . " not adding attendee as container is not personal.");
283                     return;
284                 }
285             } catch (Exception $e) {
286                 Tinebase_Core::getLogger()->info(__METHOD__ . '::' . __LINE__ . " cannot get container: $e");
287             }
288         }
289         
290         
291         if ($ifNoOtherAttendee && $this->attendee instanceof Tinebase_Record_RecordSet && $this->attendee->count() > 0) {
292             if (Tinebase_Core::isLogLevel(Zend_Log::DEBUG)) Tinebase_Core::getLogger()->debug(
293                     __METHOD__ . '::' . __LINE__ . " not adding attendee as other attendee are present.");
294             return;
295         }
296         
297         $assertionAttendee = Calendar_Model_Attender::getAttendee($this->attendee, $attendee);
298         
299         if (! $assertionAttendee) {
300             if ($ifOrganizer && ! $this->isOrganizer($attendee)) {
301                 if (Tinebase_Core::isLogLevel(Zend_Log::DEBUG)) Tinebase_Core::getLogger()->debug(
302                     __METHOD__ . '::' . __LINE__ . " not adding attendee as he is not organizer.");
303             }
304             
305             else {
306                 if (Tinebase_Core::isLogLevel(Zend_Log::DEBUG)) Tinebase_Core::getLogger()->debug(
307                     __METHOD__ . '::' . __LINE__ . " adding attendee.");
308                 
309                 $assertionAttendee = new Calendar_Model_Attender(array(
310                     'user_id'   => $attendee->user_id,
311                     'user_type' => $attendee->user_type,
312                     'status'    => Calendar_Model_Attender::STATUS_ACCEPTED,
313                     'role'      => Calendar_Model_Attender::ROLE_REQUIRED
314                 ));
315                 
316                 if (! $this->attendee instanceof Tinebase_Record_RecordSet) {
317                     $this->attendee = new Tinebase_Record_RecordSet('Calendar_Model_Attender');
318                 }
319                 $this->attendee->addRecord($assertionAttendee);
320             }
321         }
322         
323         return $assertionAttendee;
324     }
325     
326     /**
327      * returns the original dtstart of a recur series exception event 
328      *  -> when the event should have started with no exception
329      * 
330      * @return Tinebase_DateTime
331      */
332     public function getOriginalDtStart()
333     {
334         $origianlDtStart = $this->dtstart instanceof stdClass ? clone $this->dtstart : $this->dtstart;
335         
336         if ($this->isRecurException()) {
337             if ($this->recurid instanceof DateTime) {
338                 $origianlDtStart = clone $this->recurid;
339             } else if (is_string($this->recurid)) {
340                 $origianlDtStartString = substr($this->recurid, -19);
341                 if (! Tinebase_DateTime::isDate($origianlDtStartString)) {
342                     throw new Tinebase_Exception_InvalidArgument('recurid does not contain a valid original start date');
343                 }
344                 
345                 $origianlDtStart = new Tinebase_DateTime($origianlDtStartString, 'UTC');
346             }
347         }
348         
349         return $origianlDtStart;
350     }
351     
352     /**
353      * gets translated field name
354      * 
355      * NOTE: this has to be done explicitly as our field names are technically 
356      *       and have no translations
357      *       
358      * @param string         $_field
359      * @param Zend_Translate $_translation
360      * @return string
361      */
362     public static function getTranslatedFieldName($_field, $_translation)
363     {
364         $t = $_translation;
365         switch ($_field) {
366             case 'dtstart':           return $t->_('Start');
367             case 'dtend':             return $t->_('End');
368             case 'transp':            return $t->_('Blocking');
369             case 'class':             return $t->_('Classification');
370             case 'description':       return $t->_('Description');
371             case 'location':          return $t->_('Location');
372             case 'organizer':         return $t->_('Organizer');
373             case 'priority':          return $t->_('Priority');
374             case 'status':            return $t->_('Status');
375             case 'summary':           return $t->_('Summary');
376             case 'url':               return $t->_('Url');
377             case 'rrule':             return $t->_('Recurrance rule');
378             case 'is_all_day_event':  return $t->_('Is all day event');
379             case 'originator_tz':     return $t->_('Organizer timezone');
380             default:                  return $_field;
381         }
382     }
383     
384     /**
385      * gets translated value
386      * 
387      * NOTE: This is needed for values like Yes/No, Datetimes, etc.
388      * 
389      * @param  string           $_field
390      * @param  mixed            $_value
391      * @param  Zend_Translate   $_translation
392      * @param  string           $_timezone
393      * @return string
394      */
395     public static function getTranslatedValue($_field, $_value, $_translation, $_timezone)
396     {
397         if ($_value instanceof Tinebase_DateTime) {
398             $locale = new Zend_Locale($_translation->getAdapter()->getLocale());
399             return Tinebase_Translation::dateToStringInTzAndLocaleFormat($_value, $_timezone, $locale, 'datetime', true);
400         }
401         
402         switch ($_field) {
403             case 'transp':
404                 return $_value && $_value == Calendar_Model_Event::TRANSP_TRANSP ? $_translation->_('No') : $_translation->_('Yes');
405             case 'organizer':
406                 if (! $_value instanceof Addressbook_Model_Contact) {
407                     $organizer = Addressbook_Controller_Contact::getInstance()->getMultiple($_value, TRUE)->getFirstRecord();
408                 }
409                 return $organizer instanceof Addressbook_Model_Contact ? $organizer->n_fileas : '';
410             case 'rrule':
411                 if ($_value) {
412                     $rrule = $_value instanceof Calendar_Model_Rrule ? $_value : new Calendar_Model_Rrule($_value);
413                     return $rrule->getTranslatedRule($_translation);
414                 }
415             default:
416                 return $_value;
417         }
418     }
419     
420     /**
421      * checks event for given grant
422      * 
423      * @param  string $_grant
424      * @return bool
425      */
426     public function hasGrant($_grant)
427     {
428         $hasGrant = (isset($this->_properties[$_grant]) || array_key_exists($_grant, $this->_properties)) && (bool)$this->{$_grant};
429         
430         if ($this->class !== Calendar_Model_Event::CLASS_PUBLIC) {
431             $hasGrant &= (
432                 // private grant
433                 $this->{Tinebase_Model_Grants::GRANT_PRIVATE} ||
434                 // I'm organizer
435                 Tinebase_Core::getUser()->contact_id == ($this->organizer instanceof Addressbook_Model_Contact ? $this->organizer->getId() : $this->organizer) ||
436                 // I'm attendee
437                 Calendar_Model_Attender::getOwnAttender($this->attendee)
438             );
439         }
440         
441         return $hasGrant;
442     }
443     
444     /**
445      * event is an exception of a recur event series
446      * 
447      * @return boolean
448      */
449     public function isRecurException()
450     {
451         return !!$this->recurid;
452     }
453
454     /**
455      * event is non persistent recur instance
456      * 
457      * @return boolean
458      */
459     public function isRecurInstance()
460     {
461         return (boolean) preg_match('/^fakeid/', $this->getId());
462     }
463     
464     /**
465      * sets recurId of this model
466      * 
467      * @return string recurid which was set
468      */
469     public function setRecurId()
470     {
471         if (! ($this->uid && $this->dtstart)) {
472             throw new Exception ('uid _and_ dtstart must be set to generate recurid');
473         }
474         
475         // make sure we store recurid in utc
476         $dtstart = $this->getOriginalDtStart();
477         $dtstart->setTimezone('UTC');
478         
479         $this->recurid = $this->uid . '-' . $dtstart->get(Tinebase_Record_Abstract::ISO8601LONG);
480         
481         return $this->recurid;
482     }
483     
484     /**
485      * sets rrule until helper field
486      *
487      * @return void
488      */
489     public function setRruleUntil()
490     {
491         if (empty($this->rrule)) {
492             $this->rrule_until = NULL;
493         } else {
494             $rrule = $this->rrule;
495             if (! $this->rrule instanceof Calendar_Model_Rrule) {
496                 $rrule = new Calendar_Model_Rrule(array());
497                 $rrule->setFromString($this->rrule);
498                 $this->rrule = $rrule;
499             }
500             
501             if (isset($rrule->count)) {
502                 $this->rrule_until = NULL;
503                 $exdates = $this->exdate;
504                 $this->exdate = NULL;
505                 
506                 $lastOccurrence = Calendar_Model_Rrule::computeNextOccurrence($this, new Tinebase_Record_RecordSet('Calendar_Model_Event'), $this->dtend, $rrule->count -1);
507                 $this->rrule_until = $lastOccurrence->dtend;
508                 $this->exdate = $exdates;
509             } else {
510                 // set until to end of day in organizers timezone.
511                 // NOTE: this is in contrast to the iCal spec which says until should be the
512                 //       dtstart of the last occurence. But as the client with the name of the
513                 //       spec sets it to the end of the day, we do it also.
514                 if ($rrule->until instanceof Tinebase_DateTime && !$this->is_all_day_event) {
515                     $rrule->until->setTimezone($this->originator_tz);
516                     // NOTE: subSecond cause some clients send 00:00:00 for midnight
517                     $rrule->until->subSecond(1)->setTime(23, 59, 59);
518                     $rrule->until->setTimezone('UTC');
519                 }
520                 
521                 $this->rrule_until = $rrule->until;
522             }
523         }
524         
525         if ($this->rrule_until && $this->rrule_until->getTimeStamp() - $this->dtstart->getTimeStamp() < -1) {
526             throw new Tinebase_Exception_Record_Validation('rrule until must not be before dtstart');
527         }
528     }
529     
530     /**
531      * cleans up data to only contain freebusy infos
532      * removes all fields except dtstart/dtend/id/modlog fields
533      * 
534      * @return boolean TRUE if cleanup took place
535      */
536     public function doFreeBusyCleanup()
537     {
538         if ($this->hasGrant(Tinebase_Model_Grants::GRANT_READ)) {
539            return FALSE;
540         }
541         
542         $this->_properties = array_intersect_key($this->_properties, array_flip(array(
543             'id', 
544             'dtstart', 
545             'dtend',
546             'transp',
547             'seq',
548             'uid',
549             'is_all_day_event',
550             'rrule',
551             'rrule_until',
552             'recurid',
553             'exdate',
554             'originator_tz',
555             'attendee', // if we remove this, we need to adopt attendee resolveing
556             'container_id',
557             'created_by',
558             'creation_time',
559             'last_modified_by',
560             'last_modified_time',
561             'is_deleted',
562             'deleted_time',
563             'deleted_by',
564         )));
565         
566         return TRUE;
567     }
568     
569     /**
570      * sets the record related properties from user generated input.
571      * 
572      * Input-filtering and validation by Zend_Filter_Input can enabled and disabled
573      *
574      * @param array $_data            the new data to set
575      * @throws Tinebase_Exception_Record_Validation when content contains invalid or missing data
576      */
577     public function setFromArray(array $_data)
578     {
579         if (empty($_data['geo'])) {
580             $_data['geo'] = NULL;
581         }
582         
583         if (empty($_data['class'])) {
584             $_data['class'] = self::CLASS_PUBLIC;
585         }
586         
587         if (empty($_data['priority'])) {
588             $_data['priority'] = NULL;
589         }
590         
591         if (empty($_data['status'])) {
592             $_data['status'] = self::STATUS_CONFIRMED;
593         }
594         
595         if (isset($_data['container_id']) && is_array($_data['container_id'])) {
596             $_data['container_id'] = $_data['container_id']['id'];
597         }
598         
599         if (isset($_data['organizer']) && is_array($_data['organizer'])) {
600             $_data['organizer'] = $_data['organizer']['id'];
601         }
602         
603         if (isset($_data['attendee']) && is_array($_data['attendee'])) {
604             $_data['attendee'] = new Tinebase_Record_RecordSet('Calendar_Model_Attender', $_data['attendee'], $this->bypassFilters, $this->convertDates);
605         }
606         
607         if (isset($_data['rrule']) && ! empty($_data['rrule']) && ! $_data['rrule'] instanceof Calendar_Model_Rrule) {
608             // rrule can be array or string
609             $_data['rrule'] = new Calendar_Model_Rrule($_data['rrule'], $this->bypassFilters, $this->convertDates);
610         }
611         
612         if (isset($_data['alarms']) && is_array($_data['alarms'])) {
613             $_data['alarms'] = new Tinebase_Record_RecordSet('Tinebase_Model_Alarm', $_data['alarms'], TRUE, $this->convertDates);
614         }
615         
616         parent::setFromArray($_data);
617     }
618     
619     /**
620      * checks if event matches period filter
621      * 
622      * @param Calendar_Model_PeriodFilter $_period
623      * @return boolean
624      */
625     public function isInPeriod(Calendar_Model_PeriodFilter $_period)
626     {
627         $result = TRUE;
628         
629         if ($this->dtend->compare($_period->getFrom()) == -1 || $this->dtstart->compare($_period->getUntil()) == 1) {
630             $result = FALSE;
631         }
632         
633         return $result;
634     }
635     
636     /**
637      * returns TRUE if comparison detects a resechedule / significant change
638      * 
639      * @param  Calendar_Model_Event $_event
640      * @return bool
641      */
642     public function isRescheduled($_event)
643     {
644         $diff = $this->diff($_event)->diff;
645         
646         return (isset($diff['dtstart']) || array_key_exists('dtstart', $diff))
647             || (! $this->is_all_day_event && (isset($diff['dtend']) || array_key_exists('dtend', $diff)))
648             || (isset($diff['rrule']) || array_key_exists('rrule', $diff));
649     }
650     
651     /**
652      * sets and returns the addressbook entry of the organizer
653      * 
654      * @return Addressbook_Model_Contact
655      */
656     public function resolveOrganizer()
657     {
658         if (! empty($this->organizer) && ! $this->organizer instanceof Addressbook_Model_Contact) {
659             $contacts = Addressbook_Controller_Contact::getInstance()->getMultiple($this->organizer, TRUE);
660             if (count($contacts)) {
661                 $this->organizer = $contacts->getFirstRecord();
662             }
663         }
664         
665         return $this->organizer;
666     }
667     
668     /**
669      * checks if given attendee is organizer of this event
670      * 
671      * @param Calendar_Model_Attender $_attendee
672      */
673     public function isOrganizer($_attendee=NULL)
674     {
675         $organizerContactId = NULL;
676         if ($_attendee && in_array($_attendee->user_type, array(Calendar_Model_Attender::USERTYPE_USER, Calendar_Model_Attender::USERTYPE_GROUPMEMBER))) {
677             $organizerContactId = $_attendee->user_id instanceof Tinebase_Record_Abstract ? $_attendee->user_id->getId() : $_attendee->user_id;
678         } else {
679             $organizerContactId = Tinebase_Core::getUser()->contact_id;
680         }
681         
682         return $organizerContactId == ($this->organizer instanceof Tinebase_Record_Abstract ? $this->organizer->getId() : $this->organizer);
683     }
684     
685     /**
686      * returns true if organizer is external
687      * 
688      * @return boolean
689      */
690     public function hasExternalOrganizer()
691     {
692         $organizer = $this->resolveOrganizer();
693         
694         return $organizer instanceof Addressbook_Model_Contact && ! $organizer->account_id;
695     }
696     
697     public function toShortString()
698     {
699         return $this->summary . '(' . $this->dtstart . ' - ' . $this->dtend . ')';
700     }
701 }