d568978118c97c99b9f3ad069cb83fb0e96dc0c7
[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-2012 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 int container_id
35  */
36 class Calendar_Model_Event extends Tinebase_Record_Abstract
37 {
38     const TRANSP_TRANSP        = 'TRANSPARENT';
39     const TRANSP_OPAQUE        = 'OPAQUE';
40     
41     const CLASS_PUBLIC         = 'PUBLIC';
42     const CLASS_PRIVATE        = 'PRIVATE';
43     //const CLASS_CONFIDENTIAL   = 'CONFIDENTIAL';
44     
45     const STATUS_CONFIRMED     = 'CONFIRMED';
46     const STATUS_TENTATIVE     = 'TENTATIVE';
47     const STATUS_CANCELED      = 'CANCELED';
48     
49     const RANGE_ALL           = 'ALL';
50     const RANGE_THIS          = 'THIS';
51     const RANGE_THISANDFUTURE = 'THISANDFUTURE';
52     
53     /**
54      * key in $_validators/$_properties array for the filed which 
55      * represents the identifier
56      * 
57      * @var string
58      */
59     protected $_identifier = 'id';
60     
61     /**
62      * application the record belongs to
63      *
64      * @var string
65      */
66     protected $_application = 'Calendar';
67     
68     /**
69      * validators
70      *
71      * @var array
72      */
73     protected $_validators = array(
74         // tine record fields
75         'id'                   => array('allowEmpty' => true,  /*'Alnum'*/),
76         'container_id'         => array('allowEmpty' => true,  'Int'  ),
77         'created_by'           => array('allowEmpty' => true,         ),
78         'creation_time'        => array('allowEmpty' => true          ),
79         'last_modified_by'     => array('allowEmpty' => true          ),
80         'last_modified_time'   => array('allowEmpty' => true          ),
81         'is_deleted'           => array('allowEmpty' => true          ),
82         'deleted_time'         => array('allowEmpty' => true          ),
83         'deleted_by'           => array('allowEmpty' => true          ),
84         'seq'                  => array('allowEmpty' => true,  'Int'  ),
85         // calendar only fields
86         'dtend'                => array('allowEmpty' => true          ),
87         'transp'               => array(
88             'allowEmpty' => true,
89             array('InArray', array(self::TRANSP_OPAQUE, self::TRANSP_TRANSP))
90         ),
91         // ical common fields
92         'class'                => array(
93             'allowEmpty' => true,
94             array('InArray', array(self::CLASS_PUBLIC, self::CLASS_PRIVATE, /*self::CLASS_CONFIDENTIAL*/))
95         ),
96         'description'          => array('allowEmpty' => true          ),
97         'geo'                  => array('allowEmpty' => true, Zend_Filter_Input::DEFAULT_VALUE => NULL),
98         'location'             => array('allowEmpty' => true          ),
99         'organizer'            => array('allowEmpty' => false,         ),
100         'priority'             => array('allowEmpty' => true, 'Int'   ),
101         'status'            => array(
102             'allowEmpty' => true,
103             array('InArray', array(self::STATUS_CONFIRMED, self::STATUS_TENTATIVE, self::STATUS_CANCELED))
104         ),
105         'summary'              => array('allowEmpty' => true          ),
106         'url'                  => array('allowEmpty' => true          ),
107         'uid'                  => array('allowEmpty' => true          ),
108         // ical common fields with multiple appearance
109         //'attach'                => array('allowEmpty' => true         ),
110         'attendee'              => array('allowEmpty' => true         ), // RecordSet of Calendar_Model_Attender
111         'alarms'                => array('allowEmpty' => true         ), // RecordSet of Tinebase_Model_Alarm
112         'tags'                  => array('allowEmpty' => true         ), // originally categories handled by Tinebase_Tags
113         'notes'                 => array('allowEmpty' => true         ), // originally comment handled by Tinebase_Notes
114         'relations'             => array('allowEmpty' => true         ),
115         //'contact'               => array('allowEmpty' => true         ),
116         //'related'               => array('allowEmpty' => true         ),
117         //'resources'             => array('allowEmpty' => true         ),
118         //'rstatus'               => array('allowEmpty' => true         ),
119         // ical scheduleable interface fields
120         'dtstart'               => array('allowEmpty' => true         ),
121         'recurid'               => array('allowEmpty' => true         ),
122         // ical scheduleable interface fields with multiple appearance
123         'exdate'                => array('allowEmpty' => true         ), //  array of Tinebase_DateTimeTinebase_DateTime's
124         //'exrule'                => array('allowEmpty' => true         ),
125         //'rdate'                 => array('allowEmpty' => true         ),
126         'rrule'                 => array('allowEmpty' => true         ),
127         // calendar helper fields
128         'is_all_day_event'      => array('allowEmpty' => true         ),
129         'rrule_until'           => array('allowEmpty' => true         ),
130         'originator_tz'         => array('allowEmpty' => true         ),
131     
132         // grant helper fields
133         Tinebase_Model_Grants::GRANT_FREEBUSY  => array('allowEmpty' => true),
134         Tinebase_Model_Grants::GRANT_READ    => array('allowEmpty' => true),
135         Tinebase_Model_Grants::GRANT_SYNC    => array('allowEmpty' => true),
136         Tinebase_Model_Grants::GRANT_EXPORT  => array('allowEmpty' => true),
137         Tinebase_Model_Grants::GRANT_EDIT    => array('allowEmpty' => true),
138         Tinebase_Model_Grants::GRANT_DELETE  => array('allowEmpty' => true),
139         Tinebase_Model_Grants::GRANT_PRIVATE => array('allowEmpty' => true),
140     );
141     
142     /**
143      * datetime fields
144      *
145      * @var array
146      */
147     protected $_datetimeFields = array(
148         'creation_time', 
149         'last_modified_time', 
150         'deleted_time', 
151         'completed', 
152         'dtstart', 
153         'dtend', 
154         'exdate',
155         //'rdate',
156         'rrule_until',
157     );
158     
159     /**
160      * name of fields that should be omited from modlog
161      *
162      * @var array list of modlog omit fields
163      */
164     protected $_modlogOmitFields = array(
165         Tinebase_Model_Grants::GRANT_READ,
166         Tinebase_Model_Grants::GRANT_SYNC,
167         Tinebase_Model_Grants::GRANT_EXPORT,
168         Tinebase_Model_Grants::GRANT_EDIT,
169         Tinebase_Model_Grants::GRANT_DELETE,
170         Tinebase_Model_Grants::GRANT_PRIVATE,
171     );
172     
173     /**
174      * sets record related properties
175      * 
176      * @param string _name of property
177      * @param mixed _value of property
178      * @throws Tinebase_Exception_UnexpectedValue
179      * @return void
180      */
181     public function __set($_name, $_value)
182     {
183         // ensure exdate as array
184         if ($_name == 'exdate' && ! empty($_value) && ! is_array($_value) && ! $_value instanceof Tinebase_Record_RecordSet ) {
185             $_value = array($_value);
186         }
187         
188         if ($_name == 'attendee' && is_array($_value)) {
189             $_value = new Tinebase_Record_RecordSet('Calendar_Model_Attender', $_value);
190         }
191         
192         parent::__set($_name, $_value);
193     }
194     
195     /**
196      * the constructor
197      * it is needed because we have more validation fields in Calendars
198      * 
199      * @param mixed $_data
200      * @param bool $bypassFilters sets {@see this->bypassFilters}
201      * @param bool $convertDates sets {@see $this->convertDates}
202      */
203     public function __construct($_data = NULL, $_bypassFilters = false, $_convertDates = true)
204     {
205         $this->_filters['organizer'] = new Zend_Filter_Empty(NULL);
206         
207         parent::__construct($_data, $_bypassFilters, $_convertDates);
208     }
209     
210     /**
211      * add current user to attendee if he's organizer
212      * 
213      * @param bool $ifOrganizer      only add current user if he's organizer
214      * @param bool $ifNoOtherAttendee  only add current user if no other attendee are present
215      */
216     public function assertCurrentUserAsAttendee($ifOrganizer = TRUE, $ifNoOtherAttendee = FALSE)
217     {
218         if ($ifNoOtherAttendee && $this->attendee instanceof Tinebase_Record_RecordSet && $this->attendee->count() > 0) {
219             if (Tinebase_Core::isLogLevel(Zend_Log::DEBUG)) Tinebase_Core::getLogger()->debug(
220                     __METHOD__ . '::' . __LINE__ . " not adding current user as attendee as other attendee are present.");
221             return;
222         }
223         
224         $ownAttender = Calendar_Model_Attender::getOwnAttender($this->attendee);
225         
226         if (! $ownAttender) {
227             if ($ifOrganizer && $this->organizer && $this->organizer != Tinebase_Core::getUser()->contact_id) {
228                 if (Tinebase_Core::isLogLevel(Zend_Log::DEBUG)) Tinebase_Core::getLogger()->debug(
229                     __METHOD__ . '::' . __LINE__ . " not adding current user as attendee as current user is not organizer.");
230             }
231             
232             else {
233                 if (Tinebase_Core::isLogLevel(Zend_Log::DEBUG)) Tinebase_Core::getLogger()->debug(
234                     __METHOD__ . '::' . __LINE__ . " adding current user as attendee.");
235                 
236                 $newAttender = new Calendar_Model_Attender(array(
237                     'user_id'   => Tinebase_Core::getUser()->contact_id,
238                     'user_type' => Calendar_Model_Attender::USERTYPE_USER,
239                     'status'    => Calendar_Model_Attender::STATUS_ACCEPTED,
240                     'role'      => Calendar_Model_Attender::ROLE_REQUIRED
241                 ));
242                 
243                 if (! $this->attendee instanceof Tinebase_Record_RecordSet) {
244                     $this->attendee = new Tinebase_Record_RecordSet('Calendar_Model_Attender');
245                 }
246                 $this->attendee->addRecord($newAttender);
247             }
248         }
249     }
250     
251     /**
252      * returns the original dtstart of a recur series exception event 
253      *  -> when the event should have started with no exception
254      * 
255      * @return Tinebase_DateTime
256      */
257     public function getOriginalDtStart()
258     {
259         $origianlDtStart = $this->dtstart instanceof stdClass ? clone $this->dtstart : $this->dtstart;
260         
261         if ($this->isRecurException()) {
262             if ($this->recurid instanceof DateTime) {
263                 $origianlDtStart = clone $this->recurid;
264             } else if (is_string($this->recurid)) {
265                 $origianlDtStartString = substr($this->recurid, -19);
266                 if (! Tinebase_DateTime::isDate($origianlDtStartString)) {
267                     throw new Tinebase_Exception_InvalidArgument('recurid does not contain a valid original start date');
268                 }
269                 
270                 $origianlDtStart = new Tinebase_DateTime($origianlDtStartString, 'UTC');
271             }
272         }
273         
274         return $origianlDtStart;
275     }
276     
277     /**
278      * gets translated field name
279      * 
280      * NOTE: this has to be done explicitly as our field names are technically 
281      *       and have no translations
282      *       
283      * @param string         $_field
284      * @param Zend_Translate $_translation
285      * @return string
286      */
287     public static function getTranslatedFieldName($_field, $_translation)
288     {
289         $t = $_translation;
290         switch ($_field) {
291             case 'dtstart':           return $t->_('Start');
292             case 'dtend':             return $t->_('End');
293             case 'transp':            return $t->_('Blocking');
294             case 'class':             return $t->_('Classification');
295             case 'description':       return $t->_('Description');
296             case 'location':          return $t->_('Location');
297             case 'organizer':         return $t->_('Organizer');
298             case 'priority':          return $t->_('Priority');
299             case 'status':            return $t->_('Status');
300             case 'summary':           return $t->_('Summary');
301             case 'url':               return $t->_('Url');
302             case 'rrule':             return $t->_('Recurrance rule');
303             case 'is_all_day_event':  return $t->_('Is all day event');
304             case 'originator_tz':     return $t->_('Organizer timezone');
305             default:                  return $_field;
306         }
307     }
308     
309     /**
310      * gets translated value
311      * 
312      * NOTE: This is needed for values like Yes/No, Datetimes, etc.
313      * 
314      * @param  string           $_field
315      * @param  mixed            $_value
316      * @param  Zend_Translate   $_translation
317      * @param  string           $_timezone
318      * @return string
319      */
320     public static function getTranslatedValue($_field, $_value, $_translation, $_timezone)
321     {
322         if ($_value instanceof Tinebase_DateTime) {
323             $locale = new Zend_Locale($_translation->getAdapter()->getLocale());
324             return Tinebase_Translation::dateToStringInTzAndLocaleFormat($_value, $_timezone, $locale);
325         }
326         
327         switch ($_field) {
328             case 'transp':
329                 return $_value && $_value == Calendar_Model_Event::TRANSP_TRANSP ? $_translation->_('No') : $_translation->_('Yes');
330             case 'organizer':
331                 if (! $_value instanceof Addressbook_Model_Contact) {
332                     $organizer = Addressbook_Controller_Contact::getInstance()->getMultiple($this->organizer, TRUE)->getFirstRecord();
333                 }
334                 return $organizer instanceof Addressbook_Model_Contact ? $organizer->n_fileas : '';
335             default:
336                 return $_value;
337         }
338     }
339     
340     /**
341      * checks event for given grant
342      * 
343      * @param  string $_grant
344      * @return bool
345      */
346     public function hasGrant($_grant)
347     {
348         $hasGrant = array_key_exists($_grant, $this->_properties) && (bool)$this->{$_grant};
349         
350         if ($this->class !== Calendar_Model_Event::CLASS_PUBLIC) {
351             $hasGrant &= (
352                 // private grant
353                 $this->{Tinebase_Model_Grants::GRANT_PRIVATE} ||
354                 // I'm organizer
355                 Tinebase_Core::getUser()->contact_id == ($this->organizer instanceof Addressbook_Model_Contact ? $this->organizer->getId() : $this->organizer) ||
356                 // I'm attendee
357                 Calendar_Model_Attender::getOwnAttender($this->attendee)
358             );
359         }
360         
361         return $hasGrant;
362     }
363     
364     /**
365      * event is an exception of a recur event series
366      * 
367      * @return boolean
368      */
369     public function isRecurException()
370     {
371         return !!$this->recurid;
372     }
373     
374     /**
375      * sets recurId of this model
376      * 
377      * @return string recurid which was set
378      */
379     public function setRecurId()
380     {
381         if (! ($this->uid && $this->dtstart)) {
382             throw new Exception ('uid _and_ dtstart must be set to generate recurid');
383         }
384         
385         // make sure we store recurid in utc
386         $dtstart = $this->getOriginalDtStart();
387         $dtstart->setTimezone('UTC');
388         
389         $this->recurid = $this->uid . '-' . $dtstart->get(Tinebase_Record_Abstract::ISO8601LONG);
390         
391         return $this->recurid;
392     }
393     
394     /**
395      * sets rrule until helper field
396      *
397      * @return void
398      */
399     public function setRruleUntil()
400     {
401         if (empty($this->rrule)) {
402             $this->rrule_until = NULL;
403         } else {
404             $rrule = $this->rrule;
405             if (! $this->rrule instanceof Calendar_Model_Rrule) {
406                 $rrule = new Calendar_Model_Rrule(array());
407                 $rrule->setFromString($this->rrule);
408             }
409             
410             if (isset($rrule->count)) {
411                 $this->rrule_until = NULL;
412                 $exdates = $this->exdate;
413                 $this->exdate = NULL;
414                 
415                 $lastOccurrence = Calendar_Model_Rrule::computeNextOccurrence($this, new Tinebase_Record_RecordSet('Calendar_Model_Event'), $this->dtend, $rrule->count -1);
416                 $this->rrule_until = $lastOccurrence->dtend;
417                 $this->exdate = $exdates;
418             } else {
419                 $this->rrule_until = $rrule->until;
420             }
421         }
422         
423         if ($this->rrule_until && $this->rrule_until < $this->dtstart) {
424             throw new Tinebase_Exception_Record_Validation('rrule until must not be before dtstart');
425         }
426     }
427     
428     /**
429      * cleans up data to only contain freebusy infos
430      * removes all fields except dtstart/dtend/id/modlog fields
431      * 
432      * @return boolean TRUE if cleanup took place
433      */
434     public function doFreeBusyCleanup()
435     {
436         if ($this->hasGrant(Tinebase_Model_Grants::GRANT_READ)) {
437            return FALSE;
438         }
439         
440         $this->_properties = array_intersect_key($this->_properties, array_flip(array(
441             'id', 
442             'dtstart', 
443             'dtend',
444             'transp',
445             'seq',
446             'uid',
447             'is_all_day_event',
448             'rrule',
449             'rrule_until',
450             'recurid',
451             'exdate',
452             'originator_tz',
453             'attendee', // if we remove this, we need to adopt attendee resolveing
454             'container_id',
455             'created_by',
456             'creation_time',
457             'last_modified_by',
458             'last_modified_time',
459             'is_deleted',
460             'deleted_time',
461             'deleted_by',
462         )));
463         
464         return TRUE;
465     }
466     
467     /**
468      * sets the record related properties from user generated input.
469      * 
470      * Input-filtering and validation by Zend_Filter_Input can enabled and disabled
471      *
472      * @param array $_data            the new data to set
473      * @throws Tinebase_Exception_Record_Validation when content contains invalid or missing data
474      */
475     public function setFromArray(array $_data)
476     {
477         if (empty($_data['geo'])) {
478             $_data['geo'] = NULL;
479         }
480         
481         if (empty($_data['class'])) {
482             $_data['class'] = self::CLASS_PUBLIC;
483         }
484         
485         if (empty($_data['priority'])) {
486             $_data['priority'] = NULL;
487         }
488         
489         if (empty($_data['status'])) {
490             $_data['status'] = self::STATUS_CONFIRMED;
491         }
492         
493         if (isset($_data['container_id']) && is_array($_data['container_id'])) {
494             $_data['container_id'] = $_data['container_id']['id'];
495         }
496         
497         if (isset($_data['organizer']) && is_array($_data['organizer'])) {
498             $_data['organizer'] = $_data['organizer']['id'];
499         }
500         
501         if (isset($_data['attendee']) && is_array($_data['attendee'])) {
502             $_data['attendee'] = new Tinebase_Record_RecordSet('Calendar_Model_Attender', $_data['attendee'], $this->bypassFilters);
503         }
504         
505         if (isset($_data['rrule']) && is_array($_data['rrule'])) {
506             $_data['rrule'] = new Calendar_Model_Rrule($_data['rrule'], $this->bypassFilters);
507         }
508         
509         if (isset($_data['alarms']) && is_array($_data['alarms'])) {
510             $_data['alarms'] = new Tinebase_Record_RecordSet('Tinebase_Model_Alarm', $_data['alarms'], TRUE);
511         }
512         
513         parent::setFromArray($_data);
514     }
515     
516     /**
517      * checks if event matches period filter
518      * 
519      * @param Calendar_Model_PeriodFilter $_period
520      * @return boolean
521      */
522     public function isInPeriod(Calendar_Model_PeriodFilter $_period)
523     {
524         $result = TRUE;
525         
526         if ($this->dtend->compare($_period->getFrom()) == -1 || $this->dtstart->compare($_period->getUntil()) == 1) {
527             $result = FALSE;
528         }
529         
530         return $result;
531     }
532     
533     /**
534      * returns TRUE if comparison detects a resechedule / significant change
535      * 
536      * @param  Calendar_Model_Event $_event
537      * @return bool
538      */
539     public function isRescheduled($_event)
540     {
541         return $this->dtstart != $_event->dtstart
542             || (! $this->is_all_day_event && $this->dtend != $_event->dtend)
543             || $this->rrule != $_event->rrule;
544     }
545     
546     /**
547      * sets and returns the addressbook entry of the organizer
548      * 
549      * @return Addressbook_Model_Contact
550      */
551     public function resolveOrganizer()
552     {
553         if (! empty($this->organizer) && ! $this->organizer instanceof Addressbook_Model_Contact) {
554             $contacts = Addressbook_Controller_Contact::getInstance()->getMultiple($this->organizer, TRUE);
555             if (count($contacts)) {
556                 $this->organizer = $contacts->getFirstRecord();
557             }
558         }
559         
560         return $this->organizer;
561     }
562     
563     /**
564      * checks if given attendee is organizer of this event
565      * 
566      * @param Calendar_Model_Attendee $_attendee
567      */
568     public function isOrganizer($_attendee=NULL)
569     {
570         $organizerContactId = NULL;
571         if ($_attendee && in_array($_attendee->user_type, array(Calendar_Model_Attender::USERTYPE_USER, Calendar_Model_Attender::USERTYPE_GROUPMEMBER))) {
572             $organizerContactId = $_attendee->user_id instanceof Tinebase_Record_Abstract ? $_attendee->user_id->getId() : $_attendee->user_id;
573         } else {
574             $organizerContactId = Tinebase_Core::getUser()->contact_id;
575         }
576         
577         return $organizerContactId == ($this->organizer instanceof Tinebase_Record_Abstract ? $this->organizer->getId() : $this->organizer);
578     }
579 }