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