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