c357ef6ad59d1d3786ccb0705bd988f2532bd0dc
[tine20] / tine20 / Calendar / Controller / 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) 2010-2012 Metaways Infosystems GmbH (http://www.metaways.de)
9  */
10
11 /**
12  * Calendar Event Controller
13  * 
14  * In the calendar application, the container grants concept is slightly extended:
15  *  1. GRANTS for events are not only based on the events "calendar" (technically 
16  *     a container) but additionally a USER gets implicit grants for an event if 
17  *     he is ATTENDER (+READ GRANT) or ORGANIZER (+READ,EDIT GRANT).
18  *  2. ATTENDER which are invited to a certain "event" can assign the "event" to
19  *     one of their personal calenders as "display calendar" (technically personal 
20  *     containers they are admin of). The "display calendar" of an ATTENDER is
21  *     stored in the attendee table.  Each USER has a default calendar, as 
22  *     PREFERENCE,  all invitations are assigned to.
23  *  3. The "effective GRANT" a USER has on an event (read/update/delete/...) is the 
24  *     maximum GRANT of the following sources: 
25  *      - container: GRANT the USER has to the calender of the event
26  *      - implicit:  Additional READ GRANT for an attender and READ,EDIT
27  *                   GRANT for the organizer.
28 *       - inherited: FREEBUSY, READ, PRIVATE, SYNC, EXPORT can be inherited
29 *                    from the GRANTS USER has to the a display calendar
30  * 
31  * When Applying/Asuring grants, we have to deal with two differnt situations:
32  *  A: Check: Check individual grants on a event (record) basis.
33  *            This is required for create/update/delete actions and done by 
34  *            this controllers _checkGrant method.
35  *  B: Seach: From the grants perspective this is a multi step process
36  *            1. fetch all records with appropriate grants from backend
37  *            2. cleanup records user has only free/busy grant for
38  * 
39  *  NOTE: To empower the client for enabling/disabling of actions based on the 
40  *        grants a user has to an event, we need to compute the "effective GRANT"
41  *        for read/search operations.
42  *                  
43  * Case A is not critical, as the amount of data is low. 
44  * Case B however is the hard one, as lots of events and calendars may be
45  * involved.
46  * 
47  * NOTE: the backend always fetches full records for grant calculations.
48  *       searching ids only does not hlep with performance
49  * 
50  * @package Calendar
51  */
52 class Calendar_Controller_Event extends Tinebase_Controller_Record_Abstract implements Tinebase_Controller_Alarm_Interface
53 {
54     /**
55      * @var boolean
56      * 
57      * just set is_delete=1 if record is going to be deleted
58      */
59     protected $_purgeRecords = FALSE;
60     
61     /**
62      * send notifications?
63      *
64      * @var boolean
65      */
66     protected $_sendNotifications = TRUE;
67     
68     /**
69      * @var Calendar_Controller_Event
70      */
71     private static $_instance = NULL;
72     
73     /**
74      * the constructor
75      *
76      * don't use the constructor. use the singleton 
77      */
78     private function __construct()
79     {
80         $this->_applicationName = 'Calendar';
81         $this->_modelName       = 'Calendar_Model_Event';
82         $this->_backend         = new Calendar_Backend_Sql();
83     }
84
85     /**
86      * don't clone. Use the singleton.
87      */
88     private function __clone() 
89     {
90         
91     }
92     
93     /**
94      * singleton
95      *
96      * @return Calendar_Controller_Event
97      */
98     public static function getInstance() 
99     {
100         if (self::$_instance === NULL) {
101             self::$_instance = new Calendar_Controller_Event();
102         }
103         return self::$_instance;
104     }
105     
106     /**
107      * checks if all attendee of given event are not busy for given event
108      * 
109      * @param Calendar_Model_Event $_event
110      * @return void
111      * @throws Calendar_Exception_AttendeeBusy
112      */
113     public function checkBusyConflicts($_event)
114     {
115         $ignoreUIDs = !empty($_event->uid) ? array($_event->uid) : array();
116         
117         // 
118         if ($_event->transp == Calendar_Model_Event::TRANSP_TRANSP || count($_event->attendee) < 1) {
119             if (Tinebase_Core::isLogLevel(Zend_Log::DEBUG)) Tinebase_Core::getLogger()->debug(__METHOD__ . '::' . __LINE__
120                 . " Skipping free/busy check because event is transparent");
121             return;
122         }
123         
124         $eventSet = new Tinebase_Record_RecordSet('Calendar_Model_Event', array($_event));
125         
126         if (! empty($_event->rrule)) {
127             $checkUntil = clone $_event->dtstart;
128             $checkUntil->add(1, Tinebase_DateTime::MODIFIER_MONTH);
129             Calendar_Model_Rrule::mergeRecurrenceSet($eventSet, $_event->dtstart, $checkUntil);
130         }
131         
132         $periods = array();
133         foreach ($eventSet as $event) {
134             $periods[] = array('from' => $event->dtstart, 'until' => $event->dtend);
135         }
136         
137         $fbInfo = $this->getFreeBusyInfo($periods, $_event->attendee, $ignoreUIDs);
138         
139         if (count($fbInfo) > 0) {
140             $busyException = new Calendar_Exception_AttendeeBusy();
141             $busyException->setFreeBusyInfo($fbInfo);
142             
143             Calendar_Model_Attender::resolveAttendee($_event->attendee, FALSE);
144             $busyException->setEvent($_event);
145             
146             throw $busyException;
147         }
148         
149         if (Tinebase_Core::isLogLevel(Zend_Log::DEBUG)) Tinebase_Core::getLogger()->debug(__METHOD__ . '::' . __LINE__
150             . " Free/busy check: no conflict found");
151     }
152     
153     /**
154      * add one record
155      *
156      * @param   Tinebase_Record_Interface $_record
157      * @param   bool                      $_checkBusyConflicts
158      * @return  Tinebase_Record_Interface
159      * @throws  Tinebase_Exception_AccessDenied
160      * @throws  Tinebase_Exception_Record_Validation
161      */
162     public function create(Tinebase_Record_Interface $_record, $_checkBusyConflicts = FALSE)
163     {
164         try {
165             $db = $this->_backend->getAdapter();
166             $transactionId = Tinebase_TransactionManager::getInstance()->startTransaction($db);
167             
168             $this->_inspectEvent($_record);
169             
170             // we need to resolve groupmembers before free/busy checking
171             Calendar_Model_Attender::resolveGroupMembers($_record->attendee);
172             
173             if ($_checkBusyConflicts) {
174                 // ensure that all attendee are free
175                 $this->checkBusyConflicts($_record);
176             }
177             
178             $sendNotifications = $this->_sendNotifications;
179             $this->_sendNotifications = FALSE;
180             
181             $event = parent::create($_record);
182             
183             $this->_sendNotifications = $sendNotifications;
184             
185             Tinebase_TransactionManager::getInstance()->commitTransaction($transactionId);
186         } catch (Exception $e) {
187             Tinebase_TransactionManager::getInstance()->rollBack();
188             throw $e;
189         }
190         
191         $createdEvent = $this->get($event->getId());
192         
193         // send notifications
194         if ($this->_sendNotifications) {
195             $this->doSendNotifications($createdEvent, Tinebase_Core::getUser(), 'created');
196         }
197         
198         return $createdEvent;
199     }
200     
201     /**
202      * inspect creation of one record (after create)
203      *
204      * @param   Tinebase_Record_Interface $_createdRecord
205      * @param   Tinebase_Record_Interface $_record
206      * @return  void
207      */
208     protected function _inspectAfterCreate($_createdRecord, Tinebase_Record_Interface $_record)
209     {
210         $this->_saveAttendee($_record);
211     }
212     
213     /**
214      * deletes a recur series
215      *
216      * @param  Calendar_Model_Event $_recurInstance
217      * @return void
218      */
219     public function deleteRecurSeries($_recurInstance)
220     {
221         $baseEvent = $this->getRecurBaseEvent($_recurInstance);
222         $this->delete($baseEvent->getId());
223     }
224     
225     /**
226      * Gets all entries
227      *
228      * @param string $_orderBy Order result by
229      * @param string $_orderDirection Order direction - allowed are ASC and DESC
230      * @throws Tinebase_Exception_InvalidArgument
231      * @return Tinebase_Record_RecordSet
232      */
233     public function getAll($_orderBy = 'id', $_orderDirection = 'ASC') 
234     {
235         throw new Tinebase_Exception_NotImplemented('not implemented');
236     }
237     
238     /**
239      * returns freebusy information for given period and given attendee
240      * 
241      * @todo merge overlapping events to one freebusy entry
242      * 
243      * @param  array of array with from and until                   $_periods
244      * @param  Tinebase_Record_RecordSet of Calendar_Model_Attender $_attendee
245      * @param  array of UIDs                                        $_ignoreUIDs
246      * @return Tinebase_Record_RecordSet of Calendar_Model_FreeBusy
247      */
248     public function getFreeBusyInfo($_periods, $_attendee, $_ignoreUIDs = array())
249     {
250         $fbInfoSet = new Tinebase_Record_RecordSet('Calendar_Model_FreeBusy');
251         
252         // map groupmembers to users
253         $attendee = clone $_attendee;
254         $attendee->addIndices(array('user_type'));
255         $groupmembers = $attendee->filter('user_type', Calendar_Model_Attender::USERTYPE_GROUPMEMBER);
256         $groupmembers->user_type = Calendar_Model_Attender::USERTYPE_USER;
257         
258         // base filter data
259         $filterData = array(
260             array('field' => 'attender', 'operator' => 'in',     'value' => $_attendee),
261             array('field' => 'transp',   'operator' => 'equals', 'value' => Calendar_Model_Event::TRANSP_OPAQUE)
262         );
263         
264         // add all periods to filterdata
265         $periodFilters = array();
266         foreach ($_periods as $period) {
267             $periodFilters[] = array(
268                 'field' => 'period', 
269                 'operator' => 'within', 
270                 'value' => array(
271                     'from' => $period['from'], 
272                     'until' => $period['until']
273             ));
274         }
275         $filterData[] = array('condition' => 'OR', 'filters' => $periodFilters);
276         
277         // finaly create filter
278         $filter = new Calendar_Model_EventFilter($filterData);
279         
280         if (Tinebase_Core::isLogLevel(Zend_Log::TRACE)) Tinebase_Core::getLogger()->trace(__METHOD__ . ' ' . __LINE__
281             . ' free/busy fitler: ' . print_r($filter->toArray(), true));
282         
283         $events = $this->search($filter, new Tinebase_Model_Pagination(), FALSE, FALSE);
284         
285         foreach ($_periods as $period) {
286             Calendar_Model_Rrule::mergeRecurrenceSet($events, $period['from'], $period['until']);
287         }
288         
289         if (Tinebase_Core::isLogLevel(Zend_Log::TRACE)) Tinebase_Core::getLogger()->trace(__METHOD__ . ' ' . __LINE__
290             . ' value: ' . print_r($events->toArray(), true));
291         
292         // create a typemap
293         $typeMap = array();
294         foreach($attendee as $attender) {
295             if (! array_key_exists($attender['user_type'], $typeMap)) {
296                 $typeMap[$attender['user_type']] = array();
297             }
298             
299             $typeMap[$attender['user_type']][$attender['user_id']] = array();
300         }
301         if (Tinebase_Core::isLogLevel(Zend_Log::TRACE)) Tinebase_Core::getLogger()->trace(__METHOD__ . ' ' . __LINE__
302             . ' value: ' . print_r($typeMap, true));
303         
304         // generate freeBusyInfos
305         foreach ($events as $event) {
306             // skip events with ignoreUID
307             if (in_array($event->uid, $_ignoreUIDs)) {
308                 continue;
309             }
310             
311             // check if event is conflicting one of the given periods
312             $conflicts = FALSE;
313             foreach($_periods as $period) {
314                 if ($event->dtstart->isEarlier($period['until']) && $event->dtend->isLater($period['from'])) {
315                     $conflicts = TRUE;
316                     break;
317                 }
318             }
319             if (! $conflicts) {
320                 continue;
321             }
322             
323             // map groupmembers to users
324             $event->attendee->addIndices(array('user_type'));
325             $groupmembers = $event->attendee->filter('user_type', Calendar_Model_Attender::USERTYPE_GROUPMEMBER);
326             $groupmembers->user_type = Calendar_Model_Attender::USERTYPE_USER;
327         
328             foreach ($event->attendee as $attender) {
329                 // skip declined/transp events
330                 if ($attender->status == Calendar_Model_Attender::STATUS_DECLINED ||
331                     $attender->transp == Calendar_Model_Event::TRANSP_TRANSP) {
332                     continue;
333                 }
334                 
335                 if (array_key_exists($attender->user_type, $typeMap) && array_key_exists($attender->user_id, $typeMap[$attender->user_type])) {
336                     $fbInfo = new Calendar_Model_FreeBusy(array(
337                         'user_type' => $attender->user_type,
338                         'user_id'   => $attender->user_id,
339                         'dtstart'   => clone $event->dtstart,
340                         'dtend'     => clone $event->dtend,
341                         'type'      => Calendar_Model_FreeBusy::FREEBUSY_BUSY,
342                     ), true);
343                     
344                     if ($event->{Tinebase_Model_Grants::GRANT_READ}) {
345                         $fbInfo->event = clone $event;
346                         unset($fbInfo->event->attendee);
347                     }
348                     
349                     //$typeMap[$attender->user_type][$attender->user_id][] = $fbInfo;
350                     $fbInfoSet->addRecord($fbInfo);
351                 }
352             }
353         }
354         
355         return $fbInfoSet;
356     }
357     
358     /**
359      * get list of records
360      *
361      * @param Tinebase_Model_Filter_FilterGroup|optional    $_filter
362      * @param Tinebase_Model_Pagination|optional            $_pagination
363      * @param bool                                          $_getRelations
364      * @param boolean                                       $_onlyIds
365      * @param string                                        $_action for right/acl check
366      * @return Tinebase_Record_RecordSet|array
367      */
368     public function search(Tinebase_Model_Filter_FilterGroup $_filter = NULL, Tinebase_Record_Interface $_pagination = NULL, $_getRelations = FALSE, $_onlyIds = FALSE, $_action = 'get')
369     {
370         $events = parent::search($_filter, $_pagination, $_getRelations, $_onlyIds, $_action);
371         if (! $_onlyIds) {
372             $this->_freeBusyCleanup($events, $_action);
373         }
374         
375         return $events;
376     }
377     
378     /**
379      * cleanup search results (freebusy)
380      * 
381      * @param Tinebase_Record_RecordSet $_events
382      * @param string $_action
383      */
384     protected function _freeBusyCleanup(Tinebase_Record_RecordSet $_events, $_action)
385     {
386         foreach ($_events as $event) {
387             $doFreeBusyCleanup = $event->doFreeBusyCleanup();
388             if ($doFreeBusyCleanup && $_action !== 'get') {
389                 $_events->removeRecord($event);
390             }
391         }
392     }
393     
394     /**
395      * returns freeTime (suggestions) for given period of given attendee
396      * 
397      * @param  Tinebase_DateTime                                            $_from
398      * @param  Tinebase_DateTime                                            $_until
399      * @param  Tinebase_Record_RecordSet of Calendar_Model_Attender $_attendee
400      * 
401      * ...
402      */
403     public function searchFreeTime($_from, $_until, $_attendee/*, $_constains, $_mode*/)
404     {
405         $fbInfoSet = $this->getFreeBusyInfo(array(array('from' => $_from, 'until' => $_until)), $_attendee);
406         
407 //        $fromTs = $_from->getTimestamp();
408 //        $untilTs = $_until->getTimestamp();
409 //        $granularity = 1800;
410 //        
411 //        // init registry of granularity
412 //        $eventRegistry = array_combine(range($fromTs, $untilTs, $granularity), array_fill(0, ceil(($untilTs - $fromTs)/$granularity)+1, ''));
413 //        
414 //        foreach ($fbInfoSet as $fbInfo) {
415 //            $startIdx = $fromTs + $granularity * floor(($fbInfo->dtstart->getTimestamp() - $fromTs) / $granularity);
416 //            $endIdx = $fromTs + $granularity * ceil(($fbInfo->dtend->getTimestamp() - $fromTs) / $granularity);
417 //            
418 //            for ($idx=$startIdx; $idx<=$endIdx; $idx+=$granularity) {
419 //                //$eventRegistry[$idx][] = $fbInfo;
420 //                $eventRegistry[$idx] .= '.';
421 //            }
422 //        }
423         
424         //print_r($eventRegistry);
425     }
426     
427     /**
428      * update one record
429      *
430      * @param   Tinebase_Record_Interface $_record
431      * @param   bool                      $_checkBusyConflicts
432      * @param   string                    $range
433      * @return  Tinebase_Record_Interface
434      * @throws  Tinebase_Exception_AccessDenied
435      * @throws  Tinebase_Exception_Record_Validation
436      */
437     public function update(Tinebase_Record_Interface $_record, $_checkBusyConflicts = FALSE, $range = Calendar_Model_Event::RANGE_THIS)
438     {
439         try {
440             $db = $this->_backend->getAdapter();
441             $transactionId = Tinebase_TransactionManager::getInstance()->startTransaction($db);
442             
443             $sendNotifications = $this->sendNotifications(FALSE);
444             
445             $event = $this->get($_record->getId());
446             //NOTE we check via get(full rights) here whereas _updateACLCheck later checks limited rights from search
447             if ($this->_doContainerACLChecks === FALSE || $event->hasGrant(Tinebase_Model_Grants::GRANT_EDIT)) {
448                 Tinebase_Core::getLogger()->info(__METHOD__ . '::' . __LINE__ . " updating event: {$_record->id} (range: {$range})");
449                 
450                 // we need to resolve groupmembers before free/busy checking
451                 Calendar_Model_Attender::resolveGroupMembers($_record->attendee);
452                 $this->_inspectEvent($_record);
453                
454                 if ($_checkBusyConflicts) {
455                     if ($event->isRescheduled($_record) ||
456                            count(array_diff($_record->attendee->user_id, $event->attendee->user_id)) > 0
457                        ) {
458                         if (Tinebase_Core::isLogLevel(Zend_Log::DEBUG)) Tinebase_Core::getLogger()->debug(__METHOD__ . '::' . __LINE__
459                             . " Ensure that all attendee are free with free/busy check ... ");
460                         $this->checkBusyConflicts($_record);
461                     } else {
462                         if (Tinebase_Core::isLogLevel(Zend_Log::DEBUG)) Tinebase_Core::getLogger()->debug(__METHOD__ . '::' . __LINE__
463                             . " Skipping free/busy check because event has not been rescheduled and no new attender has been added");
464                     }
465                 }
466                 
467                 parent::update($_record);
468                 
469             } else if ($_record->attendee instanceof Tinebase_Record_RecordSet) {
470                 if (Tinebase_Core::isLogLevel(Zend_Log::DEBUG)) Tinebase_Core::getLogger()->debug(__METHOD__ . '::' . __LINE__
471                     . " user has no editGrant for event: {$_record->id}, updating attendee status with valid authKey only");
472                 foreach ($_record->attendee as $attender) {
473                     if ($attender->status_authkey) {
474                         $this->attenderStatusUpdate($_record, $attender, $attender->status_authkey);
475                     }
476                 }
477             }
478             
479             if ($_record->isRecurException() && in_array($range, array(Calendar_Model_Event::RANGE_ALL, Calendar_Model_Event::RANGE_THISANDFUTURE))) {
480                 $this->_updateExdateRange($_record, $range, $event);
481             }
482             
483             Tinebase_TransactionManager::getInstance()->commitTransaction($transactionId);
484         } catch (Exception $e) {
485             if (Tinebase_Core::isLogLevel(Zend_Log::DEBUG)) Tinebase_Core::getLogger()->debug(__METHOD__ . '::' . __LINE__ . ' Rolling back because: ' . $e);
486             Tinebase_TransactionManager::getInstance()->rollBack();
487             $this->sendNotifications($sendNotifications);
488             throw $e;
489         }
490         
491         $updatedEvent = $this->get($event->getId());
492         
493         // send notifications
494         $this->sendNotifications($sendNotifications);
495         if ($this->_sendNotifications) {
496             $this->doSendNotifications($updatedEvent, Tinebase_Core::getUser(), 'changed', $event);
497         }
498         return $updatedEvent;
499     }
500     
501     /**
502      * inspect update of one record (after update)
503      *
504      * @param   Tinebase_Record_Interface $updatedRecord   the just updated record
505      * @param   Tinebase_Record_Interface $record          the update record
506      * @param   Tinebase_Record_Interface $currentRecord   the current record (before update)
507      * @return  void
508      */
509     protected function _inspectAfterUpdate($updatedRecord, $record, $currentRecord)
510     {
511         $this->_saveAttendee($record, $record->isRescheduled($currentRecord));
512         // need to save new attendee set in $updatedRecord for modlog
513         $updatedRecord->attendee = clone($record->attendee);
514     }
515     
516     /**
517      * update range of events starting with given recur exception
518      * 
519      * @param Calendar_Model_Event $exdate
520      * @param string $range
521      */
522     protected function _updateExdateRange($exdate, $range, $oldExdate)
523     {
524         if (Tinebase_Core::isLogLevel(Zend_Log::DEBUG)) Tinebase_Core::getLogger()->debug(__METHOD__ . '::' . __LINE__
525             . ' Updating events (range: ' . $range . ') belonging to recur exception event ' . $exdate->getId());
526         
527         $baseEvent = $this->getRecurBaseEvent($exdate);
528         $diff = $oldExdate->diff($exdate);
529         
530         if (Tinebase_Core::isLogLevel(Zend_Log::TRACE)) Tinebase_Core::getLogger()->trace(__METHOD__ . '::' . __LINE__
531             . ' Exdate diff: ' . print_r($diff->toArray(), TRUE));
532         
533         if ($range === Calendar_Model_Event::RANGE_ALL) {
534             $events = $this->getRecurExceptions($baseEvent);
535             $events->addRecord($baseEvent);
536             $this->_applyExdateDiffToRecordSet($exdate, $diff, $events);
537         } else if ($range === Calendar_Model_Event::RANGE_THISANDFUTURE) {
538             $nextRegularRecurEvent = Calendar_Model_Rrule::computeNextOccurrence($baseEvent, new Tinebase_Record_RecordSet('Calendar_Model_Event'), $exdate->dtstart);
539             if ($nextRegularRecurEvent !== NULL && ! $nextRegularRecurEvent->dtstart->isEarlier($exdate->dtstart)) {
540                 $this->_applyDiff($nextRegularRecurEvent, $diff, $exdate, FALSE);
541                 
542                 if (Tinebase_Core::isLogLevel(Zend_Log::DEBUG)) Tinebase_Core::getLogger()->debug(__METHOD__ . '::' . __LINE__
543                     . ' Next recur exception event at: ' . $nextRegularRecurEvent->dtstart->toString());
544                 if (Tinebase_Core::isLogLevel(Zend_Log::TRACE)) Tinebase_Core::getLogger()->trace(__METHOD__ . '::' . __LINE__
545                     . ' ' . print_r($nextRegularRecurEvent->toArray(), TRUE));
546                 
547                 $newBaseEvent = $this->createRecurException($nextRegularRecurEvent, FALSE, TRUE);
548                 // @todo this should be done by createRecurException
549                 $exdatesOfNewBaseEvent = $this->getRecurExceptions($newBaseEvent);
550                 $this->_applyExdateDiffToRecordSet($exdate, $diff, $exdatesOfNewBaseEvent);
551             } else {
552                 if (Tinebase_Core::isLogLevel(Zend_Log::DEBUG)) Tinebase_Core::getLogger()->debug(__METHOD__ . '::' . __LINE__
553                     . ' No upcoming occurrences found.');
554             }
555         }
556     }
557     
558     /**
559      * apply exdate diff to a recordset of events
560      * 
561      * @param Calendar_Model_Event $exdate
562      * @param Tinebase_Record_Diff $diff
563      * @param Tinebase_Record_RecordSet $events
564      */
565     protected function _applyExdateDiffToRecordSet($exdate, $diff, $events)
566     {
567         foreach ($events as $event) {
568             if ($event->getId() === $exdate->getId()) {
569                 // skip the exdate
570                 continue;
571             }
572             $this->_applyDiff($event, $diff, $exdate, FALSE);
573             $this->update($event);
574         }
575     }
576     
577     /**
578      * merge updates from exdate into event
579      * 
580      * @param Calendar_Model_Event $event
581      * @param Tinebase_Record_Diff $diff
582      * @param Calendar_Model_Event $exdate
583      * @param boolean $overwriteMods
584      * 
585      * @todo is $overwriteMods needed?
586      */
587     protected function _applyDiff($event, $diff, $exdate, $overwriteMods = TRUE)
588     {
589         if (! $overwriteMods) {
590             $recentChanges = Tinebase_Timemachine_ModificationLog::getInstance()->getModifications('Calendar', $event, NULL, 'Sql', $exdate->creation_time);
591             if (Tinebase_Core::isLogLevel(Zend_Log::TRACE)) Tinebase_Core::getLogger()->trace(__METHOD__ . '::' . __LINE__
592                 . ' Recent changes (since ' . $exdate->creation_time->toString() . '): ' . print_r($recentChanges->toArray(), TRUE));
593         } else {
594             $recentChanges = new Tinebase_Record_RecordSet('Tinebase_Model_ModificationLog');
595         }
596         
597         $diffIgnore = array('organizer', 'seq', 'last_modified_by', 'last_modified_time', 'dtstart', 'dtend');
598         foreach ($diff->diff as $key => $newValue) {
599             if ($key === 'attendee') {
600                 if (in_array($key, $recentChanges->modified_attribute)) {
601                     $attendeeDiff = $diff->diff['attendee'];
602                     if (Tinebase_Core::isLogLevel(Zend_Log::TRACE)) Tinebase_Core::getLogger()->trace(__METHOD__ . '::' . __LINE__
603                         . ' Attendee diff: ' . print_r($attendeeDiff->toArray(), TRUE));
604                     foreach ($attendeeDiff['added'] as $attenderToAdd) {
605                         $attenderToAdd->setId(NULL);
606                         $event->attendee->addRecord($attenderToAdd);
607                     }
608                     foreach ($attendeeDiff['removed'] as $attenderToRemove) {
609                         $attenderInCurrentSet = Calendar_Model_Attender::getAttendee($event->attendee, $attenderToRemove);
610                         $event->attendee->removeRecord($attenderInCurrentSet);
611                     }
612                 } else {
613                     // remove ids of new attendee
614                     $attendee = clone($exdate->attendee);
615                     foreach ($attendee as $attender) {
616                         if (! $event->attendee->getById($attender->getId())) {
617                             $attender->setId(NULL);
618                         }
619                     }
620                     $event->attendee = $attendee;
621                 }
622             } else if (! in_array($key, $diffIgnore) && ! in_array($key, $recentChanges->modified_attribute)) {
623                 $event->{$key} = $exdate->{$key};
624             } else {
625                 if (Tinebase_Core::isLogLevel(Zend_Log::TRACE)) Tinebase_Core::getLogger()->trace(__METHOD__ . '::' . __LINE__
626                     . ' Ignore / recently changed: ' . $key);
627             }
628         }
629         
630         if (array_key_exists('dtstart', $diff->diff) || array_key_exists('dtend', $diff->diff)) {
631             $this->_applyTimeDiff($event, $exdate);
632         }
633     }
634     
635     /**
636      * update multiple records
637      * 
638      * @param   Tinebase_Model_Filter_FilterGroup $_filter
639      * @param   array $_data
640      * @return  integer number of updated records
641      */
642     public function updateMultiple($_filter, $_data)
643     {
644         $this->_checkRight('update');
645         $this->checkFilterACL($_filter, 'update');
646         
647         // get only ids
648         $ids = $this->_backend->search($_filter, NULL, TRUE);
649         
650         foreach ($ids as $eventId) {
651             $event = $this->get($eventId);
652             foreach ($_data as $field => $value) {
653                 $event->$field = $value;
654             }
655             
656             $this->update($event);
657         }
658         
659         return count($ids);
660     }
661     
662     /**
663      * Deletes a set of records.
664      * 
665      * If one of the records could not be deleted, no record is deleted
666      * 
667      * @param   array $_ids array of record identifiers
668      * @param   string $range
669      * @return  Tinebase_Record_RecordSet
670      * @throws Tinebase_Exception_NotFound|Tinebase_Exception
671      */
672     public function delete($_ids, $range = Calendar_Model_Event::RANGE_THIS)
673     {
674         if ($_ids instanceof $this->_modelName) {
675             $_ids = (array)$_ids->getId();
676         }
677         
678         $records = $this->_backend->getMultiple((array) $_ids);
679         
680         if (Tinebase_Core::isLogLevel(Zend_Log::DEBUG)) Tinebase_Core::getLogger()->debug(__METHOD__ . '::' . __LINE__
681             . " Deleting " . count($records) . ' with range ' . $range . ' ...');
682         
683         foreach ($records as $record) {
684             if ($record->isRecurException() && in_array($range, array(Calendar_Model_Event::RANGE_ALL, Calendar_Model_Event::RANGE_THISANDFUTURE))) {
685                 $this->_deleteExdateRange($record, $range);
686             }
687             
688             try {
689                 $db = $this->_backend->getAdapter();
690                 $transactionId = Tinebase_TransactionManager::getInstance()->startTransaction($db);
691                 
692                 // delete if delete grant is present
693                 if ($this->_doContainerACLChecks === FALSE || $record->hasGrant(Tinebase_Model_Grants::GRANT_DELETE)) {
694                     // NOTE delete needs to update sequence otherwise iTIP based protocolls ignore the delete
695                     $record->status = Calendar_Model_Event::STATUS_CANCELED;
696                     $this->_touch($record);
697                     parent::delete($record);
698                 }
699                 
700                 // otherwise update status for user to DECLINED
701                 else if ($record->attendee instanceof Tinebase_Record_RecordSet) {
702                     if (Tinebase_Core::isLogLevel(Zend_Log::DEBUG)) Tinebase_Core::getLogger()->debug(__METHOD__ . '::' . __LINE__ . " user has no deleteGrant for event: " . $record->id . ", updating own status to DECLINED only");
703                     $ownContact = Tinebase_Core::getUser()->contact_id;
704                     foreach ($record->attendee as $attender) {
705                         if ($attender->user_id == $ownContact && in_array($attender->user_type, array(Calendar_Model_Attender::USERTYPE_USER, Calendar_Model_Attender::USERTYPE_GROUPMEMBER))) {
706                             $attender->status = Calendar_Model_Attender::STATUS_DECLINED;
707                             $this->attenderStatusUpdate($record, $attender, $attender->status_authkey);
708                         }
709                     }
710                 }
711                 
712                 // increase display container content sequence for all attendee of deleted event
713                 if ($record->attendee instanceof Tinebase_Record_RecordSet) {
714                     foreach ($record->attendee as $attender) {
715                         $this->_increaseDisplayContainerContentSequence($attender, $record, Tinebase_Model_ContainerContent::ACTION_DELETE);
716                     }
717                 }
718                 
719                 Tinebase_TransactionManager::getInstance()->commitTransaction($transactionId);
720             } catch (Exception $e) {
721                 Tinebase_TransactionManager::getInstance()->rollBack();
722                 throw $e;
723             }
724         }
725     }
726     
727     /**
728      * delete range of events starting with given recur exception
729      * 
730      * @param Calendar_Model_Event $exdate
731      * @param string $range
732      */
733     protected function _deleteExdateRange($exdate, $range)
734     {
735         if (Tinebase_Core::isLogLevel(Zend_Log::DEBUG)) Tinebase_Core::getLogger()->debug(__METHOD__ . '::' . __LINE__
736             . ' Deleting events (range: ' . $range . ') belonging to recur exception event ' . $exdate->getId());
737         
738         $baseEvent = $this->getRecurBaseEvent($exdate);
739         
740         if ($range === Calendar_Model_Event::RANGE_ALL) {
741             $exceptions = $this->getRecurExceptions($baseEvent);
742             $this->delete($exceptions->getArrayOfIds());
743             $this->delete($baseEvent->getId());
744             
745         } else if ($range === Calendar_Model_Event::RANGE_THISANDFUTURE) {
746             $nextRegularRecurEvent = Calendar_Model_Rrule::computeNextOccurrence($baseEvent, new Tinebase_Record_RecordSet('Calendar_Model_Event'), $exdate->dtstart);
747             $this->createRecurException($nextRegularRecurEvent, TRUE, TRUE);
748         }
749     }
750     
751     /**
752      * updates a recur series
753      *
754      * @param  Calendar_Model_Event $_recurInstance
755      * @param  bool                 $_checkBusyConflicts
756      * @return Calendar_Model_Event
757      */
758     public function updateRecurSeries($_recurInstance, $_checkBusyConflicts = FALSE)
759     {
760         $baseEvent = $this->getRecurBaseEvent($_recurInstance);
761         
762         // replace baseEvent with adopted instance
763         $newBaseEvent = clone $_recurInstance;
764         $newBaseEvent->setId($baseEvent->getId());
765         unset($newBaseEvent->recurid);
766         $newBaseEvent->exdate = $baseEvent->exdate;
767         
768         $this->_applyTimeDiff($newBaseEvent, $_recurInstance, $baseEvent);
769         
770         return $this->update($newBaseEvent, $_checkBusyConflicts);
771     }
772     
773     /**
774      * apply time diff
775      * 
776      * @param Calendar_Model_Event $newEvent
777      * @param Calendar_Model_Event $fromEvent
778      * @param Calendar_Model_Event $baseEvent
779      */
780     protected function _applyTimeDiff($newEvent, $fromEvent, $baseEvent = NULL)
781     {
782         if (! $baseEvent) {
783             $baseEvent = $newEvent;
784         }
785         
786         if (Tinebase_Core::isLogLevel(Zend_Log::TRACE)) Tinebase_Core::getLogger()->trace(__METHOD__ . '::' . __LINE__
787             . ' New event: ' . print_r($newEvent->toArray(), TRUE));
788         if (Tinebase_Core::isLogLevel(Zend_Log::TRACE)) Tinebase_Core::getLogger()->trace(__METHOD__ . '::' . __LINE__
789             . ' From event: ' . print_r($fromEvent->toArray(), TRUE));
790         
791         // compute time diff (NOTE: if the $fromEvent is the baseEvent, it has no recurid)
792         $originalDtStart = $fromEvent->recurid ? new Tinebase_DateTime(substr($fromEvent->recurid, -19), 'UTC') : clone $baseEvent->dtstart;
793         
794         $dtstartDiff = $originalDtStart->diff($fromEvent->dtstart);
795         if (Tinebase_Core::isLogLevel(Zend_Log::DEBUG)) Tinebase_Core::getLogger()->debug(__METHOD__ . '::' . __LINE__
796             . " Dtstart diff: " . $dtstartDiff->format('%H:%M:%i'));
797         $eventDuration = $fromEvent->dtstart->diff($fromEvent->dtend);
798         if (Tinebase_Core::isLogLevel(Zend_Log::DEBUG)) Tinebase_Core::getLogger()->debug(__METHOD__ . '::' . __LINE__
799             . " Duration diff: " . $dtstartDiff->format('%H:%M:%i'));
800         
801         $newEvent->dtstart = clone $baseEvent->dtstart;
802         $newEvent->dtstart->add($dtstartDiff);
803         
804         $newEvent->dtend = clone $newEvent->dtstart;
805         $newEvent->dtend->add($eventDuration);
806     }
807     
808     /**
809      * creates an exception instance of a recurring event
810      *
811      * NOTE: deleting persistent exceptions is done via a normal delete action
812      *       and handled in the deleteInspection
813      * 
814      * @param  Calendar_Model_Event  $_event
815      * @param  bool                  $_deleteInstance
816      * @param  bool                  $_allFollowing
817      * @param  bool                  $_checkBusyConflicts
818      * @return Calendar_Model_Event  exception Event | updated baseEvent
819      * 
820      * @todo replace $_allFollowing param with $range
821      * @deprecated replace with create/update/delete
822      */
823     public function createRecurException($_event, $_deleteInstance = FALSE, $_allFollowing = FALSE, $_checkBusyConflicts = FALSE)
824     {
825         $baseEvent = $this->getRecurBaseEvent($_event);
826         
827         // only allow creation if recur instance if clone of base event
828         if ($baseEvent->last_modified_time != $_event->last_modified_time) {
829             throw new Tinebase_Timemachine_Exception_ConcurrencyConflict('concurrency conflict!');
830         }
831         // check if this is an exception to the first occurence
832         if ($baseEvent->getId() == $_event->getId()) {
833             if ($_allFollowing) {
834                 throw new Exception('please edit or delete complete series!');
835             }
836             // NOTE: if the baseEvent gets a time change, we can't compute the recurdid w.o. knowing the original dtstart
837             $recurid = $baseEvent->setRecurId();
838             unset($baseEvent->recurid);
839             $_event->recurid = $recurid;
840         }
841         
842         // just do attender status update if user has no edit grant
843         if ($this->_doContainerACLChecks && !$baseEvent->{Tinebase_Model_Grants::GRANT_EDIT}) {
844             if (Tinebase_Core::isLogLevel(Zend_Log::DEBUG)) Tinebase_Core::getLogger()->debug(__METHOD__ . '::' . __LINE__ . " user has no editGrant for event: '{$baseEvent->getId()}'. Only creating exception for attendee status");
845             if ($_event->attendee instanceof Tinebase_Record_RecordSet) {
846                 foreach ($_event->attendee as $attender) {
847                     if ($attender->status_authkey) {
848                         $exceptionAttender = $this->attenderStatusCreateRecurException($_event, $attender, $attender->status_authkey, $_allFollowing);
849                     }
850                 }
851             }
852             
853             return $this->get($exceptionAttender->cal_event_id);
854         }
855         
856         // NOTE: recurid is computed by rrule recur computations and therefore is already part of the event.
857         if (empty($_event->recurid)) {
858             throw new Exception('recurid must be present to create exceptions!');
859         }
860         
861         // we do notifications ourself
862         $sendNotifications = $this->sendNotifications(FALSE);
863         
864         // EDIT for baseEvent is checked above, CREATE, DELETE for recur exceptions is implied with it
865         $doContainerACLChecks = $this->doContainerACLChecks(FALSE);
866         
867         $db = $this->_backend->getAdapter();
868         $transactionId = Tinebase_TransactionManager::getInstance()->startTransaction($db);
869         
870         $exdate = new Tinebase_DateTime(substr($_event->recurid, -19));
871         $exdates = is_array($baseEvent->exdate) ? $baseEvent->exdate : array();
872         $originalDtstart = $_event->getOriginalDtStart();
873         $originalEvent = Calendar_Model_Rrule::computeNextOccurrence($baseEvent, new Tinebase_Record_RecordSet('Calendar_Model_Event'), $originalDtstart);
874         
875         if ($_allFollowing != TRUE) {
876             if (Tinebase_Core::isLogLevel(Zend_Log::DEBUG)) Tinebase_Core::getLogger()->debug(__METHOD__ . '::' . __LINE__ . " adding exdate for: '{$_event->recurid}'");
877             
878             array_push($exdates, $exdate);
879             $baseEvent->exdate = $exdates;
880             $updatedBaseEvent = $this->update($baseEvent, FALSE);
881             
882             if ($_deleteInstance == FALSE) {
883                 if (Tinebase_Core::isLogLevel(Zend_Log::DEBUG)) Tinebase_Core::getLogger()->debug(__METHOD__ . '::' . __LINE__ . " Creating persistent exception for: '{$_event->recurid}'");
884                 if (Tinebase_Core::isLogLevel(Zend_Log::TRACE)) Tinebase_Core::getLogger()->trace(__METHOD__ . '::' . __LINE__ . " Recur exception: " . print_r($_event->toArray(), TRUE));
885                 
886                 $_event->setId(NULL);
887                 unset($_event->rrule);
888                 unset($_event->exdate);
889             
890                 foreach (array('attendee', 'notes', 'alarms') as $prop) {
891                     if ($_event->{$prop} instanceof Tinebase_Record_RecordSet) {
892                         $_event->{$prop}->setId(NULL);
893                     }
894                 }
895                 
896                 $originalDtstart = $_event->getOriginalDtStart();
897                 $dtStartHasDiff = $originalDtstart->compare($_event->dtstart) != 0; // php52 compat
898                 
899                 if (! $dtStartHasDiff) {
900                     $attendees = $_event->attendee;
901                     unset($_event->attendee);
902                 }
903                 $note = $_event->notes;
904                 unset($_event->notes);
905                 $persistentExceptionEvent = $this->create($_event, $_checkBusyConflicts);
906                 
907                 if (! $dtStartHasDiff) {
908                     // we save attendee seperatly to preserve their attributes
909                     if ($attendees instanceof Tinebase_Record_RecordSet) {
910                         $attendees->cal_event_id = $persistentExceptionEvent->getId();
911                         $calendar = Tinebase_Container::getInstance()->getContainerById($_event->container_id);
912                         foreach ($attendees as $attendee) {
913                             $this->_createAttender($attendee, $_event, TRUE, $calendar);
914                             $this->_increaseDisplayContainerContentSequence($attendee, $persistentExceptionEvent, Tinebase_Model_ContainerContent::ACTION_CREATE);
915                         }
916                     }
917                 }
918                 
919                 // @todo save notes and add a update note -> what was updated? -> modlog is also missing
920                 $persistentExceptionEvent = $this->get($persistentExceptionEvent->getId());
921             }
922             
923         } else {
924             if (Tinebase_Core::isLogLevel(Zend_Log::DEBUG)) Tinebase_Core::getLogger()->debug(__METHOD__ . '::' . __LINE__ . " shorten recur series for/to: '{$_event->recurid}'");
925                 
926             // split past/future exceptions
927             $pastExdates = array();
928             $futureExdates = array();
929             foreach($exdates as $exdate) {
930                 $exdate->isLater($_event->dtstart) ? $futureExdates[] = $exdate : $pastExdates[] = $exdate;
931             }
932             
933             $persistentExceptionEvents = $this->getRecurExceptions($_event);
934             $pastPersistentExceptionEvents = new Tinebase_Record_RecordSet('Calendar_Model_Event');
935             $futurePersistentExceptionEvents = new Tinebase_Record_RecordSet('Calendar_Model_Event');
936             foreach ($persistentExceptionEvents as $persistentExceptionEvent) {
937                 $persistentExceptionEvent->dtstart->isLater($_event->dtstart) ? $futurePersistentExceptionEvents->addRecord($persistentExceptionEvent) : $pastPersistentExceptionEvents->addRecord($persistentExceptionEvent);
938             }
939             
940             // update baseEvent
941             $rrule = Calendar_Model_Rrule::getRruleFromString($baseEvent->rrule);
942             if (isset($rrule->count)) {
943                 // get all occurences and find the split
944                 
945                 $exdate = $baseEvent->exdate;
946                 $baseEvent->exdate = NULL;
947                     //$baseCountOccurrence = Calendar_Model_Rrule::computeNextOccurrence($baseEvent, new Tinebase_Record_RecordSet('Calendar_Model_Event'), $baseEvent->rrule_until, $baseCount);
948                 $recurSet = Calendar_Model_Rrule::computeRecurrenceSet($baseEvent, new Tinebase_Record_RecordSet('Calendar_Model_Event'), $baseEvent->dtstart, $baseEvent->rrule_until);
949                 $baseEvent->exdate = $exdate;
950                 
951                 $originalDtstart = $_event->getOriginalDtStart();
952                 foreach($recurSet as $idx => $rInstance) {
953                     if ($rInstance->dtstart >= $originalDtstart) break;
954                 }
955                 
956                 $rrule->count = $idx+1;
957             } else {
958                 $rrule->until = $_event->getOriginalDtStart();
959                 $rrule->until->subHour(1);
960             }
961             $baseEvent->rrule = (string) $rrule;
962             $baseEvent->exdate = $pastExdates;
963             
964             // NOTE: we don't want implicit attendee updates
965             //$updatedBaseEvent = $this->update($baseEvent, FALSE);
966             $this->_inspectEvent($baseEvent);
967             $updatedBaseEvent = parent::update($baseEvent);
968             
969             if ($_deleteInstance == TRUE) {
970                 // delete all future persistent events
971                 $this->delete($futurePersistentExceptionEvents->getId());
972             } else {
973                 if (Tinebase_Core::isLogLevel(Zend_Log::DEBUG)) Tinebase_Core::getLogger()->debug(__METHOD__ . '::' . __LINE__ . " create new recur series for/at: '{$_event->recurid}'");
974                 
975                 // NOTE: in order to move exceptions correctly in time we need to find out the original dtstart
976                 //       and create the new baseEvent with this time. A following update also updates its exceptions
977                 $originalDtstart = new Tinebase_DateTime(substr($_event->recurid, -19));
978                 $adoptedDtstart = clone $_event->dtstart;
979                 $dtStartHasDiff = $adoptedDtstart->compare($originalDtstart) != 0; // php52 compat
980                 $eventLength = $_event->dtstart->diff($_event->dtend);
981                 
982                 $_event->dtstart = clone $originalDtstart;
983                 $_event->dtend = clone $originalDtstart;
984                 $_event->dtend->add($eventLength);
985                 
986                 // adopt count
987                 if (isset($rrule->count)) {
988                     $baseCount = $rrule->count;
989                     $rrule = Calendar_Model_Rrule::getRruleFromString($_event->rrule);
990                     $rrule->count = $rrule->count - $baseCount;
991                     $_event->rrule = (string) $rrule;
992                 }
993                 
994                 $_event->setId(NULL);
995                 $_event->uid = $futurePersistentExceptionEvents->uid = Tinebase_Record_Abstract::generateUID();
996                 $futurePersistentExceptionEvents->setRecurId();
997                 unset($_event->recurid);
998                 foreach(array('attendee', 'notes', 'alarms') as $prop) {
999                     if ($_event->{$prop} instanceof Tinebase_Record_RecordSet) {
1000                         $_event->{$prop}->setId(NULL);
1001                     }
1002                 }
1003                 $_event->exdate = $futureExdates;
1004                 $futurePersistentExceptionEvents->setRecurId();
1005                 
1006                 $attendees = $_event->attendee; unset($_event->attendee);
1007                 $note = $_event->notes; unset($_event->notes);
1008                 $persistentExceptionEvent = $this->create($_event, $_checkBusyConflicts && $dtStartHasDiff);
1009                 
1010                 // we save attendee seperatly to preserve their attributes
1011                 if ($attendees instanceof Tinebase_Record_RecordSet) {
1012                     $attendees->cal_event_id = $persistentExceptionEvent->getId();
1013                     
1014                     foreach($attendees as $attendee) {
1015                         if (! $attendee->status_authkey) {
1016                             // new invitations
1017                             $attendee->status_authkey = Tinebase_Record_Abstract::generateUID();
1018                         }
1019                         $this->_backend->createAttendee($attendee);
1020                         $this->_increaseDisplayContainerContentSequence($attendee, $persistentExceptionEvent, Tinebase_Model_ContainerContent::ACTION_CREATE);
1021                     }
1022                 }
1023                 
1024                 // @todo save notes and add a update note -> what was updated? -> modlog is also missing
1025                 
1026                 $persistentExceptionEvent = $this->get($persistentExceptionEvent->getId());
1027                 
1028                 foreach($futurePersistentExceptionEvents as $futurePersistentExceptionEvent) {
1029                     $this->update($futurePersistentExceptionEvent, FALSE);
1030                 }
1031                 
1032                 if ($dtStartHasDiff) {
1033                     if (Tinebase_Core::isLogLevel(Zend_Log::DEBUG)) Tinebase_Core::getLogger()->debug(__METHOD__ . '::' . __LINE__ . " new recur series has adpted dtstart -> update to adopt exceptions'");
1034                     $persistentExceptionEvent->dtstart = clone $adoptedDtstart;
1035                     $persistentExceptionEvent->dtend = clone $adoptedDtstart;
1036                     $persistentExceptionEvent->dtend->add($eventLength);
1037                     
1038                     $persistentExceptionEvent = $this->update($persistentExceptionEvent, $_checkBusyConflicts);
1039                 }
1040             }
1041         }
1042         
1043         Tinebase_TransactionManager::getInstance()->commitTransaction($transactionId);
1044         
1045         // restore original notification handling
1046         $this->sendNotifications($sendNotifications);
1047         $notificationAction = $_deleteInstance ? 'deleted' : 'changed';
1048         $notificationEvent = $_deleteInstance ? $_event : $persistentExceptionEvent;
1049         
1050         // restore acl
1051         $this->doContainerACLChecks($doContainerACLChecks);
1052         
1053         // send notifications
1054         if ($this->_sendNotifications) {
1055             // NOTE: recur exception is a fake event from client. 
1056             //       this might lead to problems, so we wrap the calls
1057             try {
1058                 if (count($_event->attendee) > 0) {
1059                     $_event->attendee->bypassFilters = TRUE;
1060                 }
1061                 $_event->created_by = $baseEvent->created_by;
1062                 
1063                 $this->doSendNotifications($notificationEvent, Tinebase_Core::getUser(), $notificationAction, $originalEvent);
1064             } catch (Exception $e) {
1065                 if (Tinebase_Core::isLogLevel(Zend_Log::DEBUG)) Tinebase_Core::getLogger()->debug(__METHOD__ . '::' . __LINE__ . " " . $e->getTraceAsString());
1066                 Tinebase_Core::getLogger()->warn(__METHOD__ . '::' . __LINE__ . " could not send notification {$e->getMessage()}");
1067             }
1068         }
1069         
1070         return $_deleteInstance ? $updatedBaseEvent : $persistentExceptionEvent;
1071     }
1072     
1073     /**
1074      * get by id
1075      *
1076      * @param string $_id
1077      * @param int $_containerId
1078      * @return Tinebase_Record_Interface
1079      */
1080     public function get($_id, $_containerId = NULL)
1081     {
1082         if (preg_match('/^fakeid/', $_id)) {
1083             // get base event when trying to fetch a non-persistent recur instance
1084             return $this->getRecurBaseEvent(new Calendar_Model_Event(array('uid' => substr(str_replace('fakeid', '', $_id), 0, 40))), TRUE);
1085         } else {
1086             return parent::get($_id, $_containerId);
1087         }
1088     }
1089     
1090     /**
1091      * returns base event of a recurring series
1092      *
1093      * @param  Calendar_Model_Event $_event
1094      * @return Calendar_Model_Event
1095      */
1096     public function getRecurBaseEvent($_event)
1097     {
1098         $baseEventId = array_value(0, $this->_backend->search(new Calendar_Model_EventFilter(array(
1099             array('field' => 'uid',     'operator' => 'equals', 'value' => $_event->uid),
1100             array('field' => 'recurid', 'operator' => 'isnull', 'value' => NULL)
1101         )), NULL, TRUE));
1102         
1103         if (! $baseEventId) {
1104             throw new Tinebase_Exception_NotFound('base event of a recurring series not found');
1105         }
1106         
1107         // make sure we have a 'fully featured' event
1108         return $this->get($baseEventId);
1109     }
1110
1111    /**
1112     * lookup existing event by uid
1113     *
1114     * @param  Calendar_Model_Event $_event
1115     * @return Calendar_Model_Event|NULL
1116     * 
1117     * @todo also add more criteria for lookup (recurid, ...)
1118     * @todo sophisticated reccurring event handling
1119     */
1120     public function lookupExistingEvent($_event)
1121     {
1122         $events = $this->_backend->search(new Calendar_Model_EventFilter(array(
1123             array('field' => 'uid',     'operator' => 'equals', 'value' => $_event->uid),
1124             //array('field' => 'recurid', 'operator' => 'isnull', 'value' => NULL)
1125         )));
1126         
1127         $event = $events->filter(Tinebase_Model_Grants::GRANT_READ, TRUE)->getFirstRecord();
1128     
1129         // make sure we have a 'fully featured' event
1130         return ($event !== NULL) ? $this->get($event->getId()) : NULL;
1131     }
1132     
1133     /**
1134      * returns all persistent recur exceptions of recur series identified by uid of given event
1135      * 
1136      * NOTE: deleted instances are saved in the base events exception property
1137      * NOTE: returns all exceptions regardless of current filters and access restrictions
1138      * 
1139      * @param  Calendar_Model_Event        $_event
1140      * @param  boolean                     $_fakeDeletedInstances
1141      * @param  Calendar_Model_EventFilter  $_eventFilter
1142      * @return Tinebase_Record_RecordSet of Calendar_Model_Event
1143      */
1144     public function getRecurExceptions($_event, $_fakeDeletedInstances = FALSE, $_eventFilter = NULL)
1145     {
1146         $exceptionFilter = new Calendar_Model_EventFilter(array(
1147             array('field' => 'uid',     'operator' => 'equals',  'value' => $_event->uid),
1148             array('field' => 'recurid', 'operator' => 'notnull', 'value' => NULL)
1149         ));
1150         
1151         if ($_eventFilter instanceof Calendar_Model_EventFilter) {
1152             $exceptionFilter->addFilterGroup($_eventFilter);
1153         }
1154         
1155         $exceptions = $this->_backend->search($exceptionFilter);
1156         
1157         if ($_fakeDeletedInstances) {
1158             $baseEvent = $this->getRecurBaseEvent($_event);
1159             $eventLength = $baseEvent->dtstart->diff($baseEvent->dtend);
1160
1161             // compute remaining exdates
1162             $deletedInstanceDtStarts = array_diff(array_unique((array) $baseEvent->exdate), $exceptions->getOriginalDtStart());
1163             foreach((array) $deletedInstanceDtStarts as $deletedInstanceDtStart) {
1164                 $fakeEvent = clone $baseEvent;
1165                 $fakeEvent->setId(NULL);
1166                 
1167                 $fakeEvent->dtstart = clone $deletedInstanceDtStart;
1168                 $fakeEvent->dtend = clone $deletedInstanceDtStart;
1169                 $fakeEvent->dtend->add($eventLength);
1170                 $fakeEvent->is_deleted = TRUE;
1171                 $fakeEvent->setRecurId();
1172                 
1173                 $exceptions->addRecord($fakeEvent);
1174             }
1175         }
1176         
1177         $exceptions->exdate = NULL;
1178         $exceptions->rrule = NULL;
1179         $exceptions->rrule_until = NULL;
1180         
1181         return $exceptions;
1182     }
1183     
1184    /**
1185     * adopt alarm time to next occurrence for recurring events
1186     *
1187     * @param Tinebase_Record_Abstract $_record
1188     * @param Tinebase_Model_Alarm $_alarm
1189     * @param bool $_nextBy {instance|time} set recurr alarm to next from given instance or next by current time
1190     * @return void
1191     */
1192     public function adoptAlarmTime(Tinebase_Record_Abstract $_record, Tinebase_Model_Alarm $_alarm, $_nextBy = 'time')
1193     {
1194         if ($_record->rrule) {
1195             if (Tinebase_Core::isLogLevel(Zend_Log::DEBUG)) Tinebase_Core::getLogger()->debug(__METHOD__ . '::' . __LINE__ .
1196                  ' Adopting alarm time for next recur occurrence (by ' . $_nextBy . ')');
1197             if (Tinebase_Core::isLogLevel(Zend_Log::TRACE)) Tinebase_Core::getLogger()->trace(__METHOD__ . '::' . __LINE__ .
1198                  ' ' . print_r($_record->toArray(), TRUE));
1199             
1200             if ($_nextBy == 'time') {
1201                 // NOTE: this also finds instances running right now
1202                 $from = Tinebase_DateTime::now();
1203             
1204             } else {
1205                 $recurid = $_alarm->getOption('recurid');
1206                 $instanceStart = $recurid ? new Tinebase_DateTime(substr($recurid, -19)) : clone $_record->dtstart;
1207                 $eventLength = $_record->dtstart->diff($_record->dtend);
1208         
1209                 // make sure we hit the next instance
1210                 $from = $instanceStart->add($eventLength)->addMinute(1);
1211             }
1212             
1213             // compute next
1214             $exceptions = $this->getRecurExceptions($_record);
1215             $nextOccurrence = Calendar_Model_Rrule::computeNextOccurrence($_record, $exceptions, $from);
1216             
1217             if ($nextOccurrence === NULL && Tinebase_Core::isLogLevel(Zend_Log::INFO)) Tinebase_Core::getLogger()->info(__METHOD__ . '::' . __LINE__ .
1218                  ' Recur series is over, no more alarms pending');
1219             
1220             // save recurid so we know for which recurrance the alarm is for
1221             $_alarm->setOption('recurid', isset($nextOccurrence) ? $nextOccurrence->recurid : NULL);
1222             
1223             $_alarm->sent_status = $nextOccurrence ? Tinebase_Model_Alarm::STATUS_PENDING : Tinebase_Model_Alarm::STATUS_SUCCESS;
1224             $_alarm->sent_message = $nextOccurrence ?  '' : 'Nothing to send, series is over';
1225             
1226             $eventStart = $nextOccurrence ? clone $nextOccurrence->dtstart : $_record->dtstart;
1227         } else {
1228             $eventStart = clone $_record->dtstart;
1229         }
1230         
1231         // save minutes before / compute it for custom alarms
1232         $minutesBefore = $_alarm->minutes_before == Tinebase_Model_Alarm::OPTION_CUSTOM 
1233             ? ($_record->dtstart->getTimestamp() - $_alarm->alarm_time->getTimestamp()) / 60 
1234             : $_alarm->minutes_before;
1235         $minutesBefore = round($minutesBefore);
1236         
1237         $_alarm->setOption('minutes_before', $minutesBefore);
1238         $_alarm->alarm_time = $eventStart->subMinute($minutesBefore);
1239         
1240         // don't repeat same alarm @see bug #7430
1241         if ($_record->rrule && $_alarm->sent_status == Tinebase_Model_Alarm::STATUS_PENDING && $_alarm->alarm_time < $_alarm->sent_time) {
1242             $this->adoptAlarmTime($_record, $_alarm, 'instance');
1243         }
1244     }
1245     
1246     /****************************** overwritten functions ************************/
1247     
1248     /**
1249      * restore original alarm time of recurring events
1250      * 
1251      * @param Tinebase_Record_Abstract $_record
1252      * @return void
1253      */
1254     protected function _inspectAlarmGet(Tinebase_Record_Abstract $_record)
1255     {
1256         foreach ($_record->alarms as $alarm) {
1257             if ($recurid = $alarm->getOption('recurid')) {
1258                 $alarm->alarm_time = clone $_record->dtstart;
1259                 $alarm->alarm_time->subMinute((int) $alarm->getOption('minutes_before'));
1260             }
1261         }
1262         
1263         parent::_inspectAlarmGet($_record);
1264     }
1265     
1266     /**
1267      * adopt alarm time to next occurance for recurring events
1268      * 
1269      * @param Tinebase_Record_Abstract $_record
1270      * @param Tinebase_Model_Alarm $_alarm
1271      * @param bool $_nextBy {instance|time} set recurr alarm to next from given instance or next by current time
1272      * @return void
1273      * @throws Tinebase_Exception_InvalidArgument
1274      */
1275     protected function _inspectAlarmSet(Tinebase_Record_Abstract $_record, Tinebase_Model_Alarm $_alarm, $_nextBy = 'time')
1276     {
1277         parent::_inspectAlarmSet($_record, $_alarm);
1278         $this->adoptAlarmTime($_record, $_alarm, 'time');
1279     }
1280     
1281     /**
1282      * inspect update of one record
1283      * 
1284      * @param   Tinebase_Record_Interface $_record      the update record
1285      * @param   Tinebase_Record_Interface $_oldRecord   the current persistent record
1286      * @return  void
1287      */
1288     protected function _inspectBeforeUpdate($_record, $_oldRecord)
1289     {
1290         // if dtstart of an event changes, we update the originator_tz, alarm times
1291         if (! $_oldRecord->dtstart->equals($_record->dtstart)) {
1292             if (Tinebase_Core::isLogLevel(Zend_Log::DEBUG)) Tinebase_Core::getLogger()->debug(__METHOD__ . '::' . __LINE__ . ' dtstart changed -> adopting organizer_tz');
1293             $_record->originator_tz = Tinebase_Core::get(Tinebase_Core::USERTIMEZONE);
1294             if (! empty($_record->rrule)) {
1295                 $diff = $_oldRecord->dtstart->diff($_record->dtstart);
1296                 $this->_updateRecurIdOfExdates($_record, $diff);
1297             }
1298         }
1299         
1300         // delete recur exceptions if update is no longer a recur series
1301         if (! empty($_oldRecord->rrule) && empty($_record->rrule)) {
1302             if (Tinebase_Core::isLogLevel(Zend_Log::DEBUG)) Tinebase_Core::getLogger()->debug(__METHOD__ . '::' . __LINE__ . ' deleting recur exceptions as event is no longer a recur series');
1303             $this->_backend->delete($this->getRecurExceptions($_record));
1304         }
1305         
1306         // touch base event of a recur series if an persistent exception changes
1307         if ($_record->recurid) {
1308             if (Tinebase_Core::isLogLevel(Zend_Log::DEBUG)) Tinebase_Core::getLogger()->debug(__METHOD__ . '::' . __LINE__ . ' touch base event of a persistent exception');
1309             $baseEvent = $this->getRecurBaseEvent($_record);
1310             $this->_touch($baseEvent, TRUE);
1311         }
1312     }
1313     
1314     /**
1315      * update exdates and recurids if dtstart of an recurevent changes
1316      * 
1317      * @param Calendar_Model_Event $_record
1318      * @param DateInterval $diff
1319      */
1320     protected function _updateRecurIdOfExdates($_record, $diff)
1321     {
1322         // update exceptions
1323         $exceptions = $this->getRecurExceptions($_record);
1324         if (Tinebase_Core::isLogLevel(Zend_Log::DEBUG)) Tinebase_Core::getLogger()->debug(__METHOD__ . '::' . __LINE__ . ' dtstart of a series changed -> adopting '. count($exceptions) . ' recurid(s)');
1325         $exdates = array();
1326         foreach ($exceptions as $exception) {
1327             $exception->recurid = new Tinebase_DateTime(substr($exception->recurid, -19));
1328             Calendar_Model_Rrule::addUTCDateDstFix($exception->recurid, $diff, $_record->originator_tz);
1329             $exdates[] = $exception->recurid;
1330             
1331             $exception->setRecurId();
1332             $this->_backend->update($exception);
1333         }
1334         
1335         $_record->exdate = $exdates;
1336     }
1337     
1338     /**
1339      * inspect before create/update
1340      * 
1341      * @TODO move stuff from other places here
1342      * @param   Calendar_Model_Event $_record      the record to inspect
1343      */
1344     protected function _inspectEvent($_record)
1345     {
1346         $_record->uid = $_record->uid ? $_record->uid : Tinebase_Record_Abstract::generateUID();
1347         $_record->originator_tz = $_record->originator_tz ? $_record->originator_tz : Tinebase_Core::get(Tinebase_Core::USERTIMEZONE);
1348         $_record->organizer = $_record->organizer ? $_record->organizer : Tinebase_Core::getUser()->contact_id;
1349         $_record->transp = $_record->transp ? $_record->transp : Calendar_Model_Event::TRANSP_OPAQUE;
1350         
1351         // external organizer (iTIP)
1352         if (! $_record->resolveOrganizer()->account_id && count($_record->attendee) > 1) {
1353             $ownAttendee = Calendar_Model_Attender::getOwnAttender($_record->attendee);
1354             $_record->attendee = new Tinebase_Record_RecordSet('Calendar_Model_Attender', $ownAttendee ? array($ownAttendee) : array());
1355         }
1356         
1357         if ($_record->is_all_day_event) {
1358             // harmonize dtend of all day events
1359             $_record->dtend->addSecond($_record->dtend->get('s') == 0 ? 59 : 0);
1360             $_record->dtend->subMinute($_record->dtend->get('i') == 0 ? 1 : 0);
1361         }
1362         $_record->setRruleUntil();
1363     }
1364     
1365     /**
1366      * inspects delete action
1367      *
1368      * @param array $_ids
1369      * @return array of ids to actually delete
1370      */
1371     protected function _inspectDelete(array $_ids) {
1372         $events = $this->_backend->getMultiple($_ids);
1373         
1374         foreach ($events as $event) {
1375             
1376             // implicitly delete persistent recur instances of series
1377             if (! empty($event->rrule)) {
1378                 $exceptionIds = $this->getRecurExceptions($event)->getId();
1379                 if (Tinebase_Core::isLogLevel(Zend_Log::DEBUG)) Tinebase_Core::getLogger()->debug(__METHOD__ . '::' . __LINE__ . ' Implicitly deleting ' . (count($exceptionIds) - 1 ) . ' persistent exception(s) for recurring series with uid' . $event->uid);
1380                 $_ids = array_merge($_ids, $exceptionIds);
1381             }
1382         }
1383         
1384         $this->_deleteAlarmsForIds($_ids);
1385         
1386         return array_unique($_ids);
1387     }
1388     
1389     /**
1390      * redefine required grants for get actions
1391      * 
1392      * @param Tinebase_Model_Filter_FilterGroup $_filter
1393      * @param string $_action get|update
1394      */
1395     public function checkFilterACL(Tinebase_Model_Filter_FilterGroup $_filter, $_action = 'get')
1396     {
1397         $hasGrantsFilter = FALSE;
1398         foreach($_filter->getAclFilters() as $aclFilter) {
1399             if ($aclFilter instanceof Calendar_Model_GrantFilter) {
1400                 $hasGrantsFilter = TRUE;
1401                 break;
1402             }
1403         }
1404         
1405         if (! $hasGrantsFilter) {
1406             // force a grant filter
1407             // NOTE: actual grants are set via setRequiredGrants later
1408             $grantsFilter = $_filter->createFilter('grants', 'in', '@setRequiredGrants');
1409             $_filter->addFilter($grantsFilter);
1410         }
1411         
1412         parent::checkFilterACL($_filter, $_action);
1413         
1414         if ($_action == 'get') {
1415             $_filter->setRequiredGrants(array(
1416                 Tinebase_Model_Grants::GRANT_FREEBUSY,
1417                 Tinebase_Model_Grants::GRANT_READ,
1418                 Tinebase_Model_Grants::GRANT_ADMIN,
1419             ));
1420         }
1421     }
1422     
1423     /**
1424      * check grant for action (CRUD)
1425      *
1426      * @param Tinebase_Record_Interface $_record
1427      * @param string $_action
1428      * @param boolean $_throw
1429      * @param string $_errorMessage
1430      * @param Tinebase_Record_Interface $_oldRecord
1431      * @return boolean
1432      * @throws Tinebase_Exception_AccessDenied
1433      * 
1434      * @todo use this function in other create + update functions
1435      * @todo invent concept for simple adding of grants (plugins?) 
1436      */
1437     protected function _checkGrant($_record, $_action, $_throw = TRUE, $_errorMessage = 'No Permission.', $_oldRecord = NULL)
1438     {
1439         if (    !$this->_doContainerACLChecks 
1440             // admin grant includes all others
1441             ||  ($_record->container_id && Tinebase_Core::getUser()->hasGrant($_record->container_id, Tinebase_Model_Grants::GRANT_ADMIN))) {
1442             return TRUE;
1443         }
1444
1445         switch ($_action) {
1446             case 'get':
1447                 // NOTE: free/busy is not a read grant!
1448                 $hasGrant = $_record->hasGrant(Tinebase_Model_Grants::GRANT_READ);
1449                 if (! $hasGrant) {
1450                     $_record->doFreeBusyCleanup();
1451                 }
1452                 break;
1453             case 'create':
1454                 $hasGrant = Tinebase_Core::getUser()->hasGrant($_record->container_id, Tinebase_Model_Grants::GRANT_ADD);
1455                 break;
1456             case 'update':
1457                 $hasGrant = (bool) $_oldRecord->hasGrant(Tinebase_Model_Grants::GRANT_EDIT);
1458                 
1459                 if ($_oldRecord->container_id != $_record->container_id) {
1460                     $hasGrant &= Tinebase_Core::getUser()->hasGrant($_record->container_id, Tinebase_Model_Grants::GRANT_ADD)
1461                                  && $_oldRecord->hasGrant(Tinebase_Model_Grants::GRANT_DELETE);
1462                 }
1463                 break;
1464             case 'delete':
1465                 $hasGrant = (bool) $_record->hasGrant(Tinebase_Model_Grants::GRANT_DELETE);
1466                 break;
1467             case 'sync':
1468                 $hasGrant = (bool) $_record->hasGrant(Tinebase_Model_Grants::GRANT_SYNC);
1469                 break;
1470             case 'export':
1471                 $hasGrant = (bool) $_record->hasGrant(Tinebase_Model_Grants::GRANT_EXPORT);
1472                 break;
1473         }
1474         
1475         if (!$hasGrant) {
1476             if ($_throw) {
1477                 throw new Tinebase_Exception_AccessDenied($_errorMessage);
1478             } else {
1479                 if (Tinebase_Core::isLogLevel(Zend_Log::DEBUG)) Tinebase_Core::getLogger()->debug(__METHOD__ . '::' . __LINE__ . 'No permissions to ' . $_action . ' in container ' . $_record->container_id);
1480             }
1481         }
1482         
1483         return $hasGrant;
1484     }
1485     
1486     /**
1487      * touches (sets seq and last_modified_time) given event
1488      * 
1489      * @param  $_event
1490      * @return void
1491      */
1492     protected function _touch($_event, $_setModifier = FALSE)
1493     {
1494         $_event->last_modified_time = Tinebase_DateTime::now();
1495         //$_event->last_modified_time = Tinebase_DateTime::now()->get(Tinebase_Record_Abstract::ISO8601LONG);
1496         $_event->seq = (int)$_event->seq + 1;
1497         if ($_setModifier) {
1498             $_event->last_modified_by = Tinebase_Core::getUser()->getId();
1499         }
1500         
1501         
1502         $this->_backend->update($_event);
1503     }
1504     
1505     /****************************** attendee functions ************************/
1506     
1507     /**
1508      * creates an attender status exception of a recurring event series
1509      * 
1510      * NOTE: Recur exceptions are implicitly created
1511      *
1512      * @param  Calendar_Model_Event    $_recurInstance
1513      * @param  Calendar_Model_Attender $_attender
1514      * @param  string                  $_authKey
1515      * @param  bool                    $_allFollowing
1516      * @return Calendar_Model_Attender updated attender
1517      */
1518     public function attenderStatusCreateRecurException($_recurInstance, $_attender, $_authKey, $_allFollowing = FALSE)
1519     {
1520         try {
1521             $db = $this->_backend->getAdapter();
1522             $transactionId = Tinebase_TransactionManager::getInstance()->startTransaction($db);
1523             
1524             $baseEvent = $this->getRecurBaseEvent($_recurInstance);
1525             $baseEventAttendee = Calendar_Model_Attender::getAttendee($baseEvent->attendee, $_attender);
1526             
1527             if ($baseEvent->getId() == $_recurInstance->getId()) {
1528                 // exception to the first occurence
1529                 $_recurInstance->setRecurId();
1530             }
1531             
1532             // NOTE: recurid is computed by rrule recur computations and therefore is already part of the event.
1533             if (empty($_recurInstance->recurid)) {
1534                 throw new Exception('recurid must be present to create exceptions!');
1535             }
1536             
1537             try {
1538                 // check if we already have a persistent exception for this event
1539                 $eventInstance = $this->_backend->getByProperty($_recurInstance->recurid, $_property = 'recurid');
1540                 
1541                 // NOTE: the user must exist (added by someone with appropriate rights by createRecurException)
1542                 $exceptionAttender = Calendar_Model_Attender::getAttendee($eventInstance->attendee, $_attender);
1543                 if (! $exceptionAttender) {
1544                     throw new Tinebase_Exception_AccessDenied('not an attendee');
1545                 }
1546                 
1547                 
1548                 if ($exceptionAttender->status_authkey != $_authKey) {
1549                     // NOTE: it might happen, that the user set her status from the base event without knowing about 
1550                     //       an existing exception. In this case the base event authkey is also valid
1551                     if (! $baseEventAttendee || $baseEventAttendee->status_authkey != $_authKey) {
1552                         throw new Tinebase_Exception_AccessDenied('Attender authkey mismatch');
1553                     }
1554                 }
1555                 
1556             } catch (Tinebase_Exception_NotFound $e) {
1557                 // otherwise create it implicilty
1558                 
1559                 // check if this intance takes place
1560                 if (in_array($_recurInstance->dtstart, (array)$baseEvent->exdate)) {
1561                     throw new Tinebase_Exception_AccessDenied('Event instance is deleted and may not be recreated via status setting!');
1562                 }
1563                 
1564                 if (! $baseEventAttendee) {
1565                     throw new Tinebase_Exception_AccessDenied('not an attendee');
1566                 }
1567                 
1568                 if ($baseEventAttendee->status_authkey != $_authKey) {
1569                     throw new Tinebase_Exception_AccessDenied('Attender authkey mismatch');
1570                 }
1571                 
1572                 if (Tinebase_Core::isLogLevel(Zend_Log::DEBUG)) Tinebase_Core::getLogger()->debug(__METHOD__ . '::' . __LINE__ . " creating recur exception for a exceptional attendee status");
1573                 
1574                 $doContainerAclChecks = $this->doContainerACLChecks(FALSE);
1575                 $sendNotifications = $this->sendNotifications(FALSE);
1576                 
1577                 // NOTE: the user might have no edit grants, so let's be carefull
1578                 $diff = $baseEvent->dtstart->diff($baseEvent->dtend);
1579                 
1580                 $baseEvent->dtstart = new Tinebase_DateTime(substr($_recurInstance->recurid, -19), 'UTC');
1581                 $baseEvent->dtend   = clone $baseEvent->dtstart;
1582                 $baseEvent->dtend->add($diff);
1583                 
1584                 $baseEvent->id = $_recurInstance->id;
1585                 $baseEvent->recurid = $_recurInstance->recurid;
1586                 
1587                 $attendee = $baseEvent->attendee;
1588                 unset($baseEvent->attendee);
1589                 
1590                 $eventInstance = $this->createRecurException($baseEvent, FALSE, $_allFollowing);
1591                 $eventInstance->attendee = new Tinebase_Record_RecordSet('Calendar_Model_Attender');
1592                 $this->doContainerACLChecks($doContainerAclChecks);
1593                 $this->sendNotifications($sendNotifications);
1594                 
1595                 foreach ($attendee as $attender) {
1596                     $attender->setId(NULL);
1597                     $attender->cal_event_id = $eventInstance->getId();
1598                     
1599                     $attender = $this->_backend->createAttendee($attender);
1600                     $eventInstance->attendee->addRecord($attender);
1601                     $this->_increaseDisplayContainerContentSequence($attender, $eventInstance, Tinebase_Model_ContainerContent::ACTION_CREATE);
1602                 }
1603                 
1604                 $exceptionAttender = Calendar_Model_Attender::getAttendee($eventInstance->attendee, $_attender);
1605             }
1606             
1607             $exceptionAttender->status = $_attender->status;
1608             $exceptionAttender->transp = $_attender->transp;
1609             $eventInstance->alarms     = clone $_recurInstance->alarms;
1610             $eventInstance->alarms->setId(NULL);
1611             
1612             $updatedAttender = $this->attenderStatusUpdate($eventInstance, $exceptionAttender, $exceptionAttender->status_authkey);
1613             
1614             Tinebase_TransactionManager::getInstance()->commitTransaction($transactionId);
1615         } catch (Exception $e) {
1616             Tinebase_TransactionManager::getInstance()->rollBack();
1617             throw $e;
1618         }
1619         
1620         return $updatedAttender;
1621     }
1622     
1623     /**
1624      * updates an attender status of a event
1625      * 
1626      * @param  Calendar_Model_Event    $_event
1627      * @param  Calendar_Model_Attender $_attender
1628      * @param  string                  $_authKey
1629      * @return Calendar_Model_Attender updated attender
1630      */
1631     public function attenderStatusUpdate(Calendar_Model_Event $_event, Calendar_Model_Attender $_attender, $_authKey)
1632     {
1633         try {
1634             $event = $this->get($_event->getId());
1635             
1636             if (! $event->attendee) {
1637                 throw new Tinebase_Exception_NotFound('Could not find any attendee of event.');
1638             }
1639             
1640             if (($currentAttender = Calendar_Model_Attender::getAttendee($event->attendee, $_attender)) == null) {
1641                 throw new Tinebase_Exception_NotFound('Could not find attender in event.');
1642             }
1643             
1644             $updatedAttender = clone $currentAttender;
1645             
1646             if ($currentAttender->status_authkey !== $_authKey) {
1647                 if (Tinebase_Core::isLogLevel(Zend_Log::DEBUG)) 
1648                     Tinebase_Core::getLogger()->debug(__METHOD__ . '::' . __LINE__ . " no permissions to update status for {$currentAttender->user_type} {$currentAttender->user_id}");
1649                 return $updatedAttender;
1650             }
1651             
1652             Calendar_Controller_Alarm::enforceACL($_event, $event);
1653             
1654             $currentAttenderDisplayContainerId = $currentAttender->displaycontainer_id instanceof Tinebase_Model_Container ? 
1655                 $currentAttender->displaycontainer_id->getId() : 
1656                 $currentAttender->displaycontainer_id;
1657             
1658             $attenderDisplayContainerId = $_attender->displaycontainer_id instanceof Tinebase_Model_Container ? 
1659                 $_attender->displaycontainer_id->getId() : 
1660                 $_attender->displaycontainer_id;
1661             
1662             // check if something what can be set as user has changed
1663             if ($currentAttender->status == $_attender->status &&
1664                 $currentAttenderDisplayContainerId  == $attenderDisplayContainerId   &&
1665                 $currentAttender->alarm_ack_time    == $_attender->alarm_ack_time    &&
1666                 $currentAttender->alarm_snooze_time == $_attender->alarm_snooze_time &&
1667                 $currentAttender->transp            == $_attender->transp            &&
1668                 ! Calendar_Controller_Alarm::hasUpdates($_event, $event)
1669             ) {
1670                 if (Tinebase_Core::isLogLevel(Zend_Log::DEBUG)) 
1671                     Tinebase_Core::getLogger()->DEBUG(__METHOD__ . '::' . __LINE__ . "no status change -> do nothing");
1672                 return $updatedAttender;
1673             }
1674             
1675             $updatedAttender->status              = $_attender->status;
1676             $updatedAttender->displaycontainer_id = isset($_attender->displaycontainer_id) ? $_attender->displaycontainer_id : $updatedAttender->displaycontainer_id;
1677             $updatedAttender->alarm_ack_time      = isset($_attender->alarm_ack_time) ? $_attender->alarm_ack_time : $updatedAttender->alarm_ack_time;
1678             $updatedAttender->alarm_snooze_time   = isset($_attender->alarm_snooze_time) ? $_attender->alarm_snooze_time : $updatedAttender->alarm_snooze_time;
1679             $updatedAttender->transp              = isset($_attender->transp) ? $_attender->transp : Calendar_Model_Event::TRANSP_OPAQUE;
1680             
1681             if (Tinebase_Core::isLogLevel(Zend_Log::DEBUG)) 
1682                 Tinebase_Core::getLogger()->debug(__METHOD__ . '::' . __LINE__ . " update attender status to {$_attender->status} for {$currentAttender->user_type} {$currentAttender->user_id}");
1683             
1684             $transactionId = Tinebase_TransactionManager::getInstance()->startTransaction(Tinebase_Core::getDb());
1685             
1686             $updatedAttender = $this->_backend->updateAttendee($updatedAttender);
1687             if ($_event->alarms instanceof Tinebase_Record_RecordSet) {
1688                 foreach($_event->alarms as $alarm) {
1689                     $this->_inspectAlarmSet($event, $alarm);
1690                 }
1691                 
1692                 Tinebase_Alarm::getInstance()->setAlarmsOfRecord($_event);
1693             }
1694             
1695             $this->_increaseDisplayContainerContentSequence($updatedAttender, $event);
1696
1697             if ($currentAttender->status != $updatedAttender->status) {
1698                 $this->_touch($event, TRUE);
1699             }
1700             
1701             Tinebase_TransactionManager::getInstance()->commitTransaction($transactionId);
1702         } catch (Exception $e) {
1703             Tinebase_TransactionManager::getInstance()->rollBack();
1704             throw $e;
1705         }
1706         
1707         // send notifications
1708         if ($currentAttender->status != $updatedAttender->status && $this->_sendNotifications) {
1709             $updatedEvent = $this->get($event->getId());
1710             $this->doSendNotifications($updatedEvent, Tinebase_Core::getUser(), 'changed', $event);
1711         }
1712         
1713         return $updatedAttender;
1714     }
1715     
1716     /**
1717      * saves all attendee of given event
1718      * 
1719      * NOTE: This function is executed in a create/update context. As such the user
1720      *       has edit/update the event and can do anything besides status settings of attendee
1721      * 
1722      * @todo add support for resources
1723      * 
1724      * @param Calendar_Model_Event $_event
1725      * @param bool                 $_isRescheduled event got rescheduled reset all attendee status
1726      */
1727     protected function _saveAttendee($_event, $_isRescheduled = FALSE)
1728     {
1729         if (! $_event->attendee instanceof Tinebase_Record_RecordSet) {
1730             $_event->attendee = new Tinebase_Record_RecordSet('Calendar_Model_Attender');
1731         }
1732         
1733         Calendar_Model_Attender::resolveEmailOnlyAttendee($_event);
1734         
1735         $_event->attendee->cal_event_id = $_event->getId();
1736         
1737         Tinebase_Core::getLogger()->info(__METHOD__ . '::' . __LINE__ . " About to save attendee for event {$_event->id} ");
1738         
1739         $currentEvent = $this->get($_event->getId());
1740         $currentAttendee = $currentEvent->attendee;
1741         
1742         $diff = $currentAttendee->getMigration($_event->attendee->getArrayOfIds());
1743
1744         $calendar = Tinebase_Container::getInstance()->getContainerById($_event->container_id);
1745         
1746         // delete attendee
1747         $this->_backend->deleteAttendee($diff['toDeleteIds']);
1748         foreach ($diff['toDeleteIds'] as $deleteAttenderId) {
1749             $idx = $currentAttendee->getIndexById($deleteAttenderId);
1750             if ($idx !== FALSE) {
1751                 $currentAttenderToDelete = $currentAttendee[$idx];
1752                 $this->_increaseDisplayContainerContentSequence($currentAttenderToDelete, $_event, Tinebase_Model_ContainerContent::ACTION_DELETE);
1753             }
1754         }
1755         
1756         // create/update attendee
1757         foreach ($_event->attendee as $attender) {
1758             $attenderId = $attender->getId();
1759             $idx = ($attenderId) ? $currentAttendee->getIndexById($attenderId) : FALSE;
1760             
1761             if ($idx !== FALSE) {
1762                 $currentAttender = $currentAttendee[$idx];
1763                 $this->_updateAttender($attender, $currentAttender, $_event, $_isRescheduled, $calendar);
1764             } else {
1765                 $this->_createAttender($attender, $_event, FALSE, $calendar);
1766             }
1767         }
1768     }
1769
1770     /**
1771      * creates a new attender
1772      * 
1773      * @param Calendar_Model_Attender  $attender
1774      * @param Tinebase_Model_Container $_calendar
1775      * @param boolean $preserveStatus
1776      * @param Tinebase_Model_Container $calendar
1777      */
1778     protected function _createAttender(Calendar_Model_Attender $attender, Calendar_Model_Event $event, $preserveStatus = FALSE, Tinebase_Model_Container $calendar = NULL)
1779     {
1780         // apply defaults
1781         $attender->user_type         = isset($attender->user_type) ? $attender->user_type : Calendar_Model_Attender::USERTYPE_USER;
1782         $calendar = ($calendar) ? $calendar : Tinebase_Container::getInstance()->getContainerById($event->container_id);
1783         
1784         $userAccountId = $attender->getUserAccountId();
1785         
1786         // reset status if not a contact or my account
1787         if (! $preserveStatus 
1788             && ($attender->user_type == Calendar_Model_Attender::USERTYPE_GROUP 
1789                 || $userAccountId && $userAccountId != Tinebase_Core::getUser()->getId()
1790             )) {
1791             $attender->status = Calendar_Model_Attender::STATUS_NEEDSACTION;
1792         }
1793         
1794         // generate auth key
1795         if (! $attender->status_authkey) {
1796             $attender->status_authkey = Tinebase_Record_Abstract::generateUID();
1797         }
1798         
1799         // attach to display calendar if attender has/is a useraccount
1800         if ($userAccountId) {
1801             if ($calendar->type == Tinebase_Model_Container::TYPE_PERSONAL && Tinebase_Container::getInstance()->hasGrant($userAccountId, $calendar, Tinebase_Model_Grants::GRANT_ADMIN)) {
1802                 // if attender has admin grant to personal physical container, this phys. cal also gets displ. cal
1803                 $attender->displaycontainer_id = $calendar->getId();
1804             } else if ($attender->displaycontainer_id && $userAccountId == Tinebase_Core::getUser()->getId() && Tinebase_Container::getInstance()->hasGrant($userAccountId, $attender->displaycontainer_id, Tinebase_Model_Grants::GRANT_ADMIN)) {
1805                 // allow user to set his own displ. cal
1806                 $attender->displaycontainer_id = $attender->displaycontainer_id;
1807             } else {
1808                 $displayCalId = self::getDefaultDisplayContainerId($userAccountId);
1809                 $attender->displaycontainer_id = $displayCalId;
1810             }
1811         }
1812         
1813         if ($attender->user_type === Calendar_Model_Attender::USERTYPE_RESOURCE) {
1814             $resource = Calendar_Controller_Resource::getInstance()->get($attender->user_id);
1815             $attender->displaycontainer_id = $resource->container_id;
1816             
1817             // check if user is allowed to set status
1818             if (! Tinebase_Core::getUser()->hasGrant($attender->displaycontainer_id, Tinebase_Model_Grants::GRANT_EDIT)) {
1819                 $attender->status = Calendar_Model_Attender::STATUS_NEEDSACTION;
1820             }
1821         }
1822         
1823         if (Tinebase_Core::isLogLevel(Zend_Log::TRACE)) Tinebase_Core::getLogger()->trace(__METHOD__ . '::' . __LINE__ . " New attender: " . print_r($attender->toArray(), TRUE));
1824         
1825         Tinebase_Timemachine_ModificationLog::getInstance()->setRecordMetaData($attender, 'create');
1826         $this->_backend->createAttendee($attender);
1827         $this->_increaseDisplayContainerContentSequence($attender, $event, Tinebase_Model_ContainerContent::ACTION_CREATE);
1828     }
1829     
1830     /**
1831      * returns default displayContainer id of given attendee
1832      *
1833      * @param string $userAccountId
1834      */
1835     public static function getDefaultDisplayContainerId($userAccountId)
1836     {
1837         $userAccountId = Tinebase_Model_User::convertUserIdToInt($userAccountId);
1838         $displayCalId = Tinebase_Core::getPreference('Calendar')->getValueForUser(Calendar_Preference::DEFAULTCALENDAR, $userAccountId);
1839         
1840         try {
1841             // assert that displaycal is of type personal
1842             $container = Tinebase_Container::getInstance()->getContainerById($displayCalId);
1843             if ($container->type != Tinebase_Model_Container::TYPE_PERSONAL) {
1844                 $displayCalId = NULL;
1845             }
1846         } catch (Exception $e) {
1847             $displayCalId = NULL;
1848         }
1849         
1850         if (! isset($displayCalId)) {
1851             $containers = Tinebase_Container::getInstance()->getPersonalContainer($userAccountId, 'Calendar_Model_Event', $userAccountId, 0, true);
1852             if ($containers->count() > 0) {
1853                 $displayCalId = $containers->getFirstRecord()->getId();
1854             }
1855         }
1856         
1857         return $displayCalId;
1858     }
1859     
1860     /**
1861      * increases content sequence of attender display container
1862      * 
1863      * @param Calendar_Model_Attender $attender
1864      * @param Calendar_Model_Event $event
1865      * @param string $action
1866      */
1867     protected function _increaseDisplayContainerContentSequence($attender, $event, $action = Tinebase_Model_ContainerContent::ACTION_UPDATE)
1868     {
1869         if ($event->container_id === $attender->displaycontainer_id || empty($attender->displaycontainer_id)) {
1870             // no need to increase sequence
1871             return;
1872         }
1873         
1874         Tinebase_Container::getInstance()->increaseContentSequence($attender->displaycontainer_id, $action, $event->getId());
1875     }
1876     
1877     /**
1878      * updates an attender
1879      * 
1880      * @param Calendar_Model_Attender  $attender
1881      * @param Calendar_Model_Attender  $currentAttender
1882      * @param Calendar_Model_Event     $event
1883      * @param bool                     $isRescheduled event got rescheduled reset all attendee status
1884      * @param Tinebase_Model_Container $calendar
1885      */
1886     protected function _updateAttender($attender, $currentAttender, $event, $isRescheduled, $calendar = NULL)
1887     {
1888         $userAccountId = $currentAttender->getUserAccountId();
1889         
1890         // reset status if attender != currentuser and wrong authkey
1891         if ($userAccountId != Tinebase_Core::getUser()->getId()) {
1892             
1893             if ($isRescheduled) {
1894                 $attender->status = Calendar_Model_Attender::STATUS_NEEDSACTION;
1895                 $attender->transp = null;
1896             }
1897             
1898             else if ($attender->status_authkey != $currentAttender->status_authkey) {
1899                 if (Tinebase_Core::isLogLevel(Zend_Log::NOTICE)) Tinebase_Core::getLogger()->notice(__METHOD__ . '::' . __LINE__
1900                     . ' Wrong authkey, resetting status (' . $attender->status . ' -> ' . $currentAttender->status . ')');
1901                 $attender->status = $currentAttender->status;
1902             }
1903         }
1904         
1905         // reset alarm ack and snooze times
1906         if ($isRescheduled) {
1907             $attender->alarm_ack_time = null;
1908             $attender->alarm_snooze_time = null;
1909         }
1910         
1911         // preserve old authkey
1912         $attender->status_authkey = $currentAttender->status_authkey;
1913         
1914         if (Tinebase_Core::isLogLevel(Zend_Log::TRACE)) Tinebase_Core::getLogger()->trace(__METHOD__ . '::' . __LINE__
1915             . " Updating attender: " . print_r($attender->toArray(), TRUE));
1916         
1917         // update display calendar if attender has/is a useraccount
1918         if ($userAccountId) {
1919             if ($calendar->type == Tinebase_Model_Container::TYPE_PERSONAL && Tinebase_Container::getInstance()->hasGrant($userAccountId, $calendar, Tinebase_Model_Grants::GRANT_ADMIN)) {
1920                 // if attender has admin grant to personal physical container, this phys. cal also gets displ. cal
1921                 $attender->displaycontainer_id = $calendar->getId();
1922             } else if ($userAccountId == Tinebase_Core::getUser()->getId() && Tinebase_Container::getInstance()->hasGrant($userAccountId, $attender->displaycontainer_id, Tinebase_Model_Grants::GRANT_ADMIN)) {
1923                 // allow user to set his own displ. cal
1924                 $attender->displaycontainer_id = $attender->displaycontainer_id;
1925             } else {
1926                 $attender->displaycontainer_id = $currentAttender->displaycontainer_id;
1927             }
1928         }
1929         
1930         Tinebase_Timemachine_ModificationLog::getInstance()->setRecordMetaData($attender, 'update', $currentAttender);
1931         Tinebase_Timemachine_ModificationLog::getInstance()->writeModLog($attender, $currentAttender, get_class($attender), $this->_getBackendType(), $attender->getId());
1932         $this->_backend->updateAttendee($attender);
1933         
1934         if ($attender->displaycontainer_id !== $currentAttender->displaycontainer_id) {
1935             $this->_increaseDisplayContainerContentSequence($currentAttender, $event, Tinebase_Model_ContainerContent::ACTION_DELETE);
1936             $this->_increaseDisplayContainerContentSequence($attender, $event, Tinebase_Model_ContainerContent::ACTION_CREATE);
1937         } else {
1938             $this->_increaseDisplayContainerContentSequence($attender, $event);
1939         }
1940     }
1941     
1942     /**
1943      * event handler for group updates
1944      * 
1945      * @param Tinebase_Model_Group $_group
1946      * @return void
1947      */
1948     public function onUpdateGroup($_groupId)
1949     {
1950         $doContainerACLChecks = $this->doContainerACLChecks(FALSE);
1951         
1952         $filter = new Calendar_Model_EventFilter(array(
1953             array('field' => 'attender', 'operator' => 'equals', 'value' => array(
1954                 'user_type' => Calendar_Model_Attender::USERTYPE_GROUP,
1955                 'user_id'   => $_groupId
1956             )),
1957             array('field' => 'period', 'operator' => 'within', 'value' => array(
1958                 'from'  => Tinebase_DateTime::now()->get(Tinebase_Record_Abstract::ISO8601LONG),
1959                 'until' => Tinebase_DateTime::now()->addYear(100)->get(Tinebase_Record_Abstract::ISO8601LONG))
1960             )
1961         ));
1962         $events = $this->search($filter, new Tinebase_Model_Pagination(), FALSE, FALSE);
1963         
1964         foreach($events as $event) {
1965             try {
1966                 if (! $event->rrule) {
1967                     // update non recurring futrue events
1968                     Calendar_Model_Attender::resolveGroupMembers($event->attendee);
1969                     $this->update($event);
1970                 } else {
1971                     // update thisandfuture for recurring events
1972                     $nextOccurrence = Calendar_Model_Rrule::computeNextOccurrence($event, $this->getRecurExceptions($event), Tinebase_DateTime::now());
1973                     Calendar_Model_Attender::resolveGroupMembers($nextOccurrence->attendee);
1974                     
1975                     if ($nextOccurrence->dtstart != $event->dtstart) {
1976                         $this->createRecurException($nextOccurrence, FALSE, TRUE);
1977                     } else {
1978                         $this->update($nextOccurrence);
1979                     }
1980                 }
1981             } catch (Exception $e) {
1982                 Tinebase_Core::getLogger()->NOTICE(__METHOD__ . '::' . __LINE__ . " could not update attendee");
1983             }
1984         }
1985         
1986         $this->doContainerACLChecks($doContainerACLChecks);
1987     }
1988     
1989     /****************************** alarm functions ************************/
1990     
1991     /**
1992      * send an alarm
1993      *
1994      * @param  Tinebase_Model_Alarm $_alarm
1995      * @return void
1996      * 
1997      * NOTE: the given alarm is raw and has not passed _inspectAlarmGet
1998      *  
1999      * @todo throw exception on error
2000      */
2001     public function sendAlarm(Tinebase_Model_Alarm $_alarm) 
2002     {
2003         if (Tinebase_Core::isLogLevel(Zend_Log::DEBUG)) Tinebase_Core::getLogger()->debug(__METHOD__ . '::' . __LINE__ . " About to send alarm " . print_r($_alarm->toArray(), TRUE));
2004         
2005         $doContainerACLChecks = $this->doContainerACLChecks(FALSE);
2006         
2007         $event = $this->get($_alarm->record_id);
2008         $event->alarms = new Tinebase_Record_RecordSet('Tinebase_Model_Alarm', array($_alarm));
2009         $this->_inspectAlarmGet($event);
2010         
2011         $this->doContainerACLChecks($doContainerACLChecks);
2012         
2013         if ($event->rrule) {
2014             $recurid = $_alarm->getOption('recurid');
2015             
2016             // adopts the (referenced) alarm and sets alarm time to next occurance
2017             parent::_inspectAlarmSet($event, $_alarm);
2018             $this->adoptAlarmTime($event, $_alarm, 'instance');
2019             
2020             if ($recurid) {
2021                 // NOTE: In case of recuring events $event is always the baseEvent,
2022                 //       so we might need to adopt event time to recur instance.
2023                 $diff = $event->dtstart->diff($event->dtend);
2024                 
2025                 $event->dtstart = new Tinebase_DateTime(substr($recurid, -19));
2026                 
2027                 $event->dtend = clone $event->dtstart;
2028                 $event->dtend->add($diff);
2029             }
2030             
2031             // don't send alarm if instance is an exception
2032             if ($event->exdate && in_array($event->dtstart, $event->exdate)) {
2033                 return;
2034             }
2035         }
2036         
2037         Calendar_Controller_EventNotifications::getInstance()->doSendNotifications($event, Tinebase_Core::getUser(), 'alarm', NULL, $_alarm);
2038     }
2039     
2040     /**
2041      * send notifications 
2042      * 
2043      * @param Calendar_Model_Event       $_event
2044      * @param Tinebase_Model_FullAccount $_updater
2045      * @param Sting                      $_action
2046      * @param Calendar_Model_Event       $_oldEvent
2047      * @return void
2048      */
2049     public function doSendNotifications($_event, $_updater, $_action, $_oldEvent=NULL)
2050     {
2051         Tinebase_ActionQueue::getInstance()->queueAction('Calendar.sendEventNotifications', 
2052             $_event, 
2053             $_updater,
2054             $_action, 
2055             $_oldEvent ? $_oldEvent : NULL
2056         );
2057     }
2058 }