increase cache lifetime for principal resolving
[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 && $_record->mute != 1) {
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 && $_record->mute != 1) {
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                 $nextRegularRecurEvent->mute = $exdate->mute;
618                 $newBaseEvent = $this->createRecurException($nextRegularRecurEvent, FALSE, TRUE);
619                 // @todo this should be done by createRecurException
620                 $exdatesOfNewBaseEvent = $this->getRecurExceptions($newBaseEvent);
621                 $this->_applyExdateDiffToRecordSet($exdate, $diff, $exdatesOfNewBaseEvent);
622             } else {
623                 if (Tinebase_Core::isLogLevel(Zend_Log::DEBUG)) Tinebase_Core::getLogger()->debug(__METHOD__ . '::' . __LINE__
624                     . ' No upcoming occurrences found.');
625             }
626         }
627     }
628     
629     /**
630      * apply exdate diff to a recordset of events
631      * 
632      * @param Calendar_Model_Event $exdate
633      * @param Tinebase_Record_Diff $diff
634      * @param Tinebase_Record_RecordSet $events
635      */
636     protected function _applyExdateDiffToRecordSet($exdate, $diff, $events)
637     {
638         foreach ($events as $event) {
639             if ($event->getId() === $exdate->getId()) {
640                 // skip the exdate
641                 continue;
642             }
643             $this->_applyDiff($event, $diff, $exdate, FALSE);
644             $this->update($event);
645         }
646     }
647     
648     /**
649      * merge updates from exdate into event
650      * 
651      * @param Calendar_Model_Event $event
652      * @param Tinebase_Record_Diff $diff
653      * @param Calendar_Model_Event $exdate
654      * @param boolean $overwriteMods
655      * 
656      * @todo is $overwriteMods needed?
657      */
658     protected function _applyDiff($event, $diff, $exdate, $overwriteMods = TRUE)
659     {
660         if (! $overwriteMods) {
661             $recentChanges = Tinebase_Timemachine_ModificationLog::getInstance()->getModifications('Calendar', $event, NULL, 'Sql', $exdate->creation_time);
662             if (Tinebase_Core::isLogLevel(Zend_Log::TRACE)) Tinebase_Core::getLogger()->trace(__METHOD__ . '::' . __LINE__
663                 . ' Recent changes (since ' . $exdate->creation_time->toString() . '): ' . print_r($recentChanges->toArray(), TRUE));
664         } else {
665             $recentChanges = new Tinebase_Record_RecordSet('Tinebase_Model_ModificationLog');
666         }
667         
668         $diffIgnore = array('organizer', 'seq', 'last_modified_by', 'last_modified_time', 'dtstart', 'dtend');
669         foreach ($diff->diff as $key => $newValue) {
670             if ($key === 'attendee') {
671                 if (in_array($key, $recentChanges->modified_attribute)) {
672                     $attendeeDiff = $diff->diff['attendee'];
673                     if (Tinebase_Core::isLogLevel(Zend_Log::TRACE)) Tinebase_Core::getLogger()->trace(__METHOD__ . '::' . __LINE__
674                         . ' Attendee diff: ' . print_r($attendeeDiff->toArray(), TRUE));
675                     foreach ($attendeeDiff['added'] as $attenderToAdd) {
676                         $attenderToAdd->setId(NULL);
677                         $event->attendee->addRecord($attenderToAdd);
678                     }
679                     foreach ($attendeeDiff['removed'] as $attenderToRemove) {
680                         $attenderInCurrentSet = Calendar_Model_Attender::getAttendee($event->attendee, $attenderToRemove);
681                         $event->attendee->removeRecord($attenderInCurrentSet);
682                     }
683                 } else {
684                     // remove ids of new attendee
685                     $attendee = clone($exdate->attendee);
686                     foreach ($attendee as $attender) {
687                         if (! $event->attendee->getById($attender->getId())) {
688                             $attender->setId(NULL);
689                         }
690                     }
691                     $event->attendee = $attendee;
692                 }
693             } else if (! in_array($key, $diffIgnore) && ! in_array($key, $recentChanges->modified_attribute)) {
694                 $event->{$key} = $exdate->{$key};
695             } else {
696                 if (Tinebase_Core::isLogLevel(Zend_Log::TRACE)) Tinebase_Core::getLogger()->trace(__METHOD__ . '::' . __LINE__
697                     . ' Ignore / recently changed: ' . $key);
698             }
699         }
700         
701         if ((isset($diff->diff['dtstart']) || array_key_exists('dtstart', $diff->diff)) || (isset($diff->diff['dtend']) || array_key_exists('dtend', $diff->diff))) {
702             $this->_applyTimeDiff($event, $exdate);
703         }
704     }
705     
706     /**
707      * update multiple records
708      * 
709      * @param   Tinebase_Model_Filter_FilterGroup $_filter
710      * @param   array $_data
711      * @return  integer number of updated records
712      */
713     public function updateMultiple($_filter, $_data)
714     {
715         $this->_checkRight('update');
716         $this->checkFilterACL($_filter, 'update');
717         
718         // get only ids
719         $ids = $this->_backend->search($_filter, NULL, TRUE);
720         
721         foreach ($ids as $eventId) {
722             $event = $this->get($eventId);
723             foreach ($_data as $field => $value) {
724                 $event->$field = $value;
725             }
726             
727             $this->update($event);
728         }
729         
730         return count($ids);
731     }
732     
733     /**
734      * Deletes a set of records.
735      * 
736      * If one of the records could not be deleted, no record is deleted
737      * 
738      * @param   array $_ids array of record identifiers
739      * @param   string $range
740      * @return  NULL
741      * @throws Tinebase_Exception_NotFound|Tinebase_Exception
742      */
743     public function delete($_ids, $range = Calendar_Model_Event::RANGE_THIS)
744     {
745         if ($_ids instanceof $this->_modelName) {
746             $_ids = (array)$_ids->getId();
747         }
748         
749         $records = $this->_backend->getMultiple((array) $_ids);
750         
751         if (Tinebase_Core::isLogLevel(Zend_Log::DEBUG)) Tinebase_Core::getLogger()->debug(__METHOD__ . '::' . __LINE__
752             . " Deleting " . count($records) . ' with range ' . $range . ' ...');
753         
754         foreach ($records as $record) {
755             if ($record->isRecurException() && in_array($range, array(Calendar_Model_Event::RANGE_ALL, Calendar_Model_Event::RANGE_THISANDFUTURE))) {
756                 $this->_deleteExdateRange($record, $range);
757             }
758             
759             try {
760                 $db = $this->_backend->getAdapter();
761                 $transactionId = Tinebase_TransactionManager::getInstance()->startTransaction($db);
762                 
763                 // delete if delete grant is present
764                 if ($this->_doContainerACLChecks === FALSE || $record->hasGrant(Tinebase_Model_Grants::GRANT_DELETE)) {
765                     // NOTE delete needs to update sequence otherwise iTIP based protocolls ignore the delete
766                     $record->status = Calendar_Model_Event::STATUS_CANCELED;
767                     $this->_touch($record);
768                     if ($record->isRecurException()) {
769                         try {
770                             $baseEvent = $this->getRecurBaseEvent($record);
771                             $this->_touch($baseEvent);
772                         } catch (Tinebase_Exception_NotFound $tnfe) {
773                             // base Event might be gone already
774                             if (Tinebase_Core::isLogLevel(Zend_Log::NOTICE)) Tinebase_Core::getLogger()->notice(__METHOD__ . '::' . __LINE__
775                                 . " BaseEvent of exdate {$record->uid} to delete not found ");
776
777                         }
778                     }
779                     parent::delete($record);
780                 }
781                 
782                 // otherwise update status for user to DECLINED
783                 else if ($record->attendee instanceof Tinebase_Record_RecordSet) {
784                     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");
785                     $ownContact = Tinebase_Core::getUser()->contact_id;
786                     foreach ($record->attendee as $attender) {
787                         if ($attender->user_id == $ownContact && in_array($attender->user_type, array(Calendar_Model_Attender::USERTYPE_USER, Calendar_Model_Attender::USERTYPE_GROUPMEMBER))) {
788                             $attender->status = Calendar_Model_Attender::STATUS_DECLINED;
789                             $this->attenderStatusUpdate($record, $attender, $attender->status_authkey);
790                         }
791                     }
792                 }
793                 
794                 // increase display container content sequence for all attendee of deleted event
795                 if ($record->attendee instanceof Tinebase_Record_RecordSet) {
796                     foreach ($record->attendee as $attender) {
797                         $this->_increaseDisplayContainerContentSequence($attender, $record, Tinebase_Model_ContainerContent::ACTION_DELETE);
798                     }
799                 }
800                 
801                 Tinebase_TransactionManager::getInstance()->commitTransaction($transactionId);
802             } catch (Exception $e) {
803                 Tinebase_TransactionManager::getInstance()->rollBack();
804                 throw $e;
805             }
806         }
807     }
808     
809     /**
810      * delete range of events starting with given recur exception
811      *
812      * NOTE: if exdate is persistent, it will not be deleted by this function
813      *       but by the original call of delete
814      *
815      * @param Calendar_Model_Event $exdate
816      * @param string $range
817      */
818     protected function _deleteExdateRange($exdate, $range)
819     {
820         if (Tinebase_Core::isLogLevel(Zend_Log::DEBUG)) Tinebase_Core::getLogger()->debug(__METHOD__ . '::' . __LINE__
821             . ' Deleting events (range: ' . $range . ') belonging to recur exception event ' . $exdate->getId());
822         
823         $baseEvent = $this->getRecurBaseEvent($exdate);
824         
825         if ($range === Calendar_Model_Event::RANGE_ALL) {
826             $this->deleteRecurSeries($exdate);
827         } else if ($range === Calendar_Model_Event::RANGE_THISANDFUTURE) {
828             $nextRegularRecurEvent = Calendar_Model_Rrule::computeNextOccurrence($baseEvent, new Tinebase_Record_RecordSet('Calendar_Model_Event'), $exdate->dtstart);
829             
830             if ($nextRegularRecurEvent == $baseEvent) {
831                 // NOTE if a fist instance exception takes place before the
832                 //      series would start normally, $nextOccurence is the
833                 //      baseEvent of the series. As createRecurException can't
834                 //      deal with this situation we delete whole series here
835                 $this->_deleteExdateRange($exdate, Calendar_Model_Event::RANGE_ALL);
836             } else {
837                 $this->createRecurException($nextRegularRecurEvent, TRUE, TRUE);
838             }
839         }
840     }
841     
842     /**
843      * updates a recur series
844      *
845      * @param  Calendar_Model_Event $_recurInstance
846      * @param  bool                 $_checkBusyConflicts
847      * @return Calendar_Model_Event
848      */
849     public function updateRecurSeries($_recurInstance, $_checkBusyConflicts = FALSE)
850     {
851         $baseEvent = $this->getRecurBaseEvent($_recurInstance);
852         
853         // replace baseEvent with adopted instance
854         $newBaseEvent = clone $_recurInstance;
855         $newBaseEvent->setId($baseEvent->getId());
856         unset($newBaseEvent->recurid);
857         $newBaseEvent->exdate = $baseEvent->exdate;
858         
859         $this->_applyTimeDiff($newBaseEvent, $_recurInstance, $baseEvent);
860         
861         return $this->update($newBaseEvent, $_checkBusyConflicts);
862     }
863     
864     /**
865      * apply time diff
866      * 
867      * @param Calendar_Model_Event $newEvent
868      * @param Calendar_Model_Event $fromEvent
869      * @param Calendar_Model_Event $baseEvent
870      */
871     protected function _applyTimeDiff($newEvent, $fromEvent, $baseEvent = NULL)
872     {
873         if (! $baseEvent) {
874             $baseEvent = $newEvent;
875         }
876         
877         if (Tinebase_Core::isLogLevel(Zend_Log::TRACE)) Tinebase_Core::getLogger()->trace(__METHOD__ . '::' . __LINE__
878             . ' New event: ' . print_r($newEvent->toArray(), TRUE));
879         if (Tinebase_Core::isLogLevel(Zend_Log::TRACE)) Tinebase_Core::getLogger()->trace(__METHOD__ . '::' . __LINE__
880             . ' From event: ' . print_r($fromEvent->toArray(), TRUE));
881         
882         // compute time diff (NOTE: if the $fromEvent is the baseEvent, it has no recurid)
883         $originalDtStart = $fromEvent->recurid ? new Tinebase_DateTime(substr($fromEvent->recurid, -19), 'UTC') : clone $baseEvent->dtstart;
884         
885         $dtstartDiff = $originalDtStart->diff($fromEvent->dtstart);
886         if (Tinebase_Core::isLogLevel(Zend_Log::DEBUG)) Tinebase_Core::getLogger()->debug(__METHOD__ . '::' . __LINE__
887             . " Dtstart diff: " . $dtstartDiff->format('%H:%M:%i'));
888         $eventDuration = $fromEvent->dtstart->diff($fromEvent->dtend);
889         if (Tinebase_Core::isLogLevel(Zend_Log::DEBUG)) Tinebase_Core::getLogger()->debug(__METHOD__ . '::' . __LINE__
890             . " Duration diff: " . $dtstartDiff->format('%H:%M:%i'));
891         
892         $newEvent->dtstart = clone $baseEvent->dtstart;
893         $newEvent->dtstart->add($dtstartDiff);
894         
895         $newEvent->dtend = clone $newEvent->dtstart;
896         $newEvent->dtend->add($eventDuration);
897     }
898     
899     /**
900      * creates an exception instance of a recurring event
901      *
902      * NOTE: deleting persistent exceptions is done via a normal delete action
903      *       and handled in the deleteInspection
904      * 
905      * @param  Calendar_Model_Event  $_event
906      * @param  bool                  $_deleteInstance
907      * @param  bool                  $_allFollowing
908      * @param  bool                  $_checkBusyConflicts
909      * @return Calendar_Model_Event  exception Event | updated baseEvent
910      * 
911      * @todo replace $_allFollowing param with $range
912      * @deprecated replace with create/update/delete
913      */
914     public function createRecurException($_event, $_deleteInstance = FALSE, $_allFollowing = FALSE, $_checkBusyConflicts = FALSE)
915     {
916         $baseEvent = $this->getRecurBaseEvent($_event);
917         
918         if ($baseEvent->last_modified_time != $_event->last_modified_time) {
919             if (Tinebase_Core::isLogLevel(Zend_Log::WARN)) Tinebase_Core::getLogger()->warn(__METHOD__ . '::' . __LINE__
920                 . " It is not allowed to create recur instance if it is clone of base event");
921             throw new Tinebase_Timemachine_Exception_ConcurrencyConflict('concurrency conflict!');
922         }
923         
924         // check if this is an exception to the first occurence
925         if ($baseEvent->getId() == $_event->getId()) {
926             if ($_allFollowing) {
927                 throw new Exception('please edit or delete complete series!');
928             }
929             // NOTE: if the baseEvent gets a time change, we can't compute the recurdid w.o. knowing the original dtstart
930             $recurid = $baseEvent->setRecurId();
931             unset($baseEvent->recurid);
932             $_event->recurid = $recurid;
933         }
934         
935         // just do attender status update if user has no edit grant
936         if ($this->_doContainerACLChecks && !$baseEvent->{Tinebase_Model_Grants::GRANT_EDIT}) {
937             if (Tinebase_Core::isLogLevel(Zend_Log::DEBUG)) Tinebase_Core::getLogger()->debug(__METHOD__ . '::' . __LINE__
938                 . " user has no editGrant for event: '{$baseEvent->getId()}'. Only creating exception for attendee status");
939             if ($_event->attendee instanceof Tinebase_Record_RecordSet) {
940                 foreach ($_event->attendee as $attender) {
941                     if ($attender->status_authkey) {
942                         $exceptionAttender = $this->attenderStatusCreateRecurException($_event, $attender, $attender->status_authkey, $_allFollowing);
943                     }
944                 }
945             }
946             
947             if (! isset($exceptionAttender)) {
948                 if (Tinebase_Core::isLogLevel(Zend_Log::DEBUG) && $_event->attendee instanceof Tinebase_Record_RecordSet) {
949                     Tinebase_Core::getLogger()->debug(__METHOD__ . '::' . __LINE__ . " Failed to update attendee: " . print_r($_event->attendee->toArray(), true));
950                 }
951                 throw new Tinebase_Exception_AccessDenied('Failed to update attendee, status authkey might be missing');
952             }
953             
954             return $this->get($exceptionAttender->cal_event_id);
955         }
956         
957         // NOTE: recurid is computed by rrule recur computations and therefore is already part of the event.
958         if (empty($_event->recurid)) {
959             throw new Exception('recurid must be present to create exceptions!');
960         }
961         
962         // we do notifications ourself
963         $sendNotifications = $this->sendNotifications(FALSE);
964         
965         // EDIT for baseEvent is checked above, CREATE, DELETE for recur exceptions is implied with it
966         $doContainerACLChecks = $this->doContainerACLChecks(FALSE);
967         
968         $db = $this->_backend->getAdapter();
969         $transactionId = Tinebase_TransactionManager::getInstance()->startTransaction($db);
970         
971         $exdate = new Tinebase_DateTime(substr($_event->recurid, -19));
972         $exdates = is_array($baseEvent->exdate) ? $baseEvent->exdate : array();
973         $originalDtstart = $_event->getOriginalDtStart();
974         $originalEvent = Calendar_Model_Rrule::computeNextOccurrence($baseEvent, new Tinebase_Record_RecordSet('Calendar_Model_Event'), $originalDtstart);
975         
976         if ($_allFollowing != TRUE) {
977             if (Tinebase_Core::isLogLevel(Zend_Log::DEBUG)) Tinebase_Core::getLogger()->debug(__METHOD__ . '::' . __LINE__ 
978                 . " Adding exdate for: '{$_event->recurid}'");
979             
980             array_push($exdates, $exdate);
981             $baseEvent->exdate = $exdates;
982             $updatedBaseEvent = $this->update($baseEvent, FALSE);
983             
984             if ($_deleteInstance == FALSE) {
985                 if (Tinebase_Core::isLogLevel(Zend_Log::DEBUG)) Tinebase_Core::getLogger()->debug(__METHOD__ . '::' . __LINE__ 
986                     . " Creating persistent exception for: '{$_event->recurid}'");
987                 if (Tinebase_Core::isLogLevel(Zend_Log::TRACE)) Tinebase_Core::getLogger()->trace(__METHOD__ . '::' . __LINE__ 
988                     . " Recur exception: " . print_r($_event->toArray(), TRUE));
989                 
990                 $_event->setId(NULL);
991                 unset($_event->rrule);
992                 unset($_event->exdate);
993             
994                 foreach (array('attendee', 'notes', 'alarms') as $prop) {
995                     if ($_event->{$prop} instanceof Tinebase_Record_RecordSet) {
996                         $_event->{$prop}->setId(NULL);
997                     }
998                 }
999                 
1000                 $originalDtstart = $_event->getOriginalDtStart();
1001                 $dtStartHasDiff = $originalDtstart->compare($_event->dtstart) != 0; // php52 compat
1002                 
1003                 if (! $dtStartHasDiff) {
1004                     $attendees = $_event->attendee;
1005                     unset($_event->attendee);
1006                 }
1007                 $note = $_event->notes;
1008                 unset($_event->notes);
1009                 $persistentExceptionEvent = $this->create($_event, $_checkBusyConflicts);
1010                 
1011                 if (! $dtStartHasDiff) {
1012                     // we save attendee seperatly to preserve their attributes
1013                     if ($attendees instanceof Tinebase_Record_RecordSet) {
1014                         $attendees->cal_event_id = $persistentExceptionEvent->getId();
1015                         $calendar = Tinebase_Container::getInstance()->getContainerById($_event->container_id);
1016                         foreach ($attendees as $attendee) {
1017                             $this->_createAttender($attendee, $_event, TRUE, $calendar);
1018                             $this->_increaseDisplayContainerContentSequence($attendee, $persistentExceptionEvent, Tinebase_Model_ContainerContent::ACTION_CREATE);
1019                         }
1020                     }
1021                 }
1022                 
1023                 // @todo save notes and add a update note -> what was updated? -> modlog is also missing
1024                 $persistentExceptionEvent = $this->get($persistentExceptionEvent->getId());
1025             }
1026             
1027         } else {
1028             if (Tinebase_Core::isLogLevel(Zend_Log::DEBUG)) Tinebase_Core::getLogger()->debug(__METHOD__ . '::' . __LINE__ . " shorten recur series for/to: '{$_event->recurid}'");
1029                 
1030             // split past/future exceptions
1031             $pastExdates = array();
1032             $futureExdates = array();
1033             foreach($exdates as $exdate) {
1034                 $exdate->isLater($_event->dtstart) ? $futureExdates[] = $exdate : $pastExdates[] = $exdate;
1035             }
1036             
1037             $persistentExceptionEvents = $this->getRecurExceptions($_event);
1038             $pastPersistentExceptionEvents = new Tinebase_Record_RecordSet('Calendar_Model_Event');
1039             $futurePersistentExceptionEvents = new Tinebase_Record_RecordSet('Calendar_Model_Event');
1040             foreach ($persistentExceptionEvents as $persistentExceptionEvent) {
1041                 $persistentExceptionEvent->dtstart->isLater($_event->dtstart) ? $futurePersistentExceptionEvents->addRecord($persistentExceptionEvent) : $pastPersistentExceptionEvents->addRecord($persistentExceptionEvent);
1042             }
1043             
1044             // update baseEvent
1045             $rrule = Calendar_Model_Rrule::getRruleFromString($baseEvent->rrule);
1046             if (isset($rrule->count)) {
1047                 // get all occurences and find the split
1048                 
1049                 $exdate = $baseEvent->exdate;
1050                 $baseEvent->exdate = NULL;
1051                     //$baseCountOccurrence = Calendar_Model_Rrule::computeNextOccurrence($baseEvent, new Tinebase_Record_RecordSet('Calendar_Model_Event'), $baseEvent->rrule_until, $baseCount);
1052                 $recurSet = Calendar_Model_Rrule::computeRecurrenceSet($baseEvent, new Tinebase_Record_RecordSet('Calendar_Model_Event'), $baseEvent->dtstart, $baseEvent->rrule_until);
1053                 $baseEvent->exdate = $exdate;
1054                 
1055                 $originalDtstart = $_event->getOriginalDtStart();
1056                 foreach($recurSet as $idx => $rInstance) {
1057                     if ($rInstance->dtstart >= $originalDtstart) break;
1058                 }
1059                 
1060                 $rrule->count = $idx+1;
1061             } else {
1062                 $lastBaseOccurence = Calendar_Model_Rrule::computeNextOccurrence($baseEvent, new Tinebase_Record_RecordSet('Calendar_Model_Event'), $_event->getOriginalDtStart()->subSecond(1), -1);
1063                 $rrule->until = $lastBaseOccurence ? $lastBaseOccurence->getOriginalDtStart() : $baseEvent->dtstart;
1064             }
1065             $baseEvent->rrule = (string) $rrule;
1066             $baseEvent->exdate = $pastExdates;
1067             
1068             // NOTE: we don't want implicit attendee updates
1069             //$updatedBaseEvent = $this->update($baseEvent, FALSE);
1070             $this->_inspectEvent($baseEvent);
1071             $updatedBaseEvent = parent::update($baseEvent);
1072             
1073             if ($_deleteInstance == TRUE) {
1074                 // delete all future persistent events
1075                 $this->delete($futurePersistentExceptionEvents->getId());
1076             } else {
1077                 if (Tinebase_Core::isLogLevel(Zend_Log::DEBUG)) Tinebase_Core::getLogger()->debug(__METHOD__ . '::' . __LINE__ . " create new recur series for/at: '{$_event->recurid}'");
1078                 
1079                 // NOTE: in order to move exceptions correctly in time we need to find out the original dtstart
1080                 //       and create the new baseEvent with this time. A following update also updates its exceptions
1081                 $originalDtstart = new Tinebase_DateTime(substr($_event->recurid, -19));
1082                 $adoptedDtstart = clone $_event->dtstart;
1083                 $dtStartHasDiff = $adoptedDtstart->compare($originalDtstart) != 0; // php52 compat
1084                 $eventLength = $_event->dtstart->diff($_event->dtend);
1085                 
1086                 $_event->dtstart = clone $originalDtstart;
1087                 $_event->dtend = clone $originalDtstart;
1088                 $_event->dtend->add($eventLength);
1089                 
1090                 // adopt count
1091                 if (isset($rrule->count)) {
1092                     $baseCount = $rrule->count;
1093                     $rrule = Calendar_Model_Rrule::getRruleFromString($_event->rrule);
1094                     $rrule->count = $rrule->count - $baseCount;
1095                     $_event->rrule = (string) $rrule;
1096                 }
1097                 
1098                 $_event->setId(NULL);
1099                 $_event->uid = $futurePersistentExceptionEvents->uid = Tinebase_Record_Abstract::generateUID();
1100                 $futurePersistentExceptionEvents->setRecurId();
1101                 unset($_event->recurid);
1102                 foreach(array('attendee', 'notes', 'alarms') as $prop) {
1103                     if ($_event->{$prop} instanceof Tinebase_Record_RecordSet) {
1104                         $_event->{$prop}->setId(NULL);
1105                     }
1106                 }
1107                 $_event->exdate = $futureExdates;
1108                 $futurePersistentExceptionEvents->setRecurId();
1109                 
1110                 $attendees = $_event->attendee; unset($_event->attendee);
1111                 $note = $_event->notes; unset($_event->notes);
1112                 $persistentExceptionEvent = $this->create($_event, $_checkBusyConflicts && $dtStartHasDiff);
1113                 
1114                 // we save attendee seperatly to preserve their attributes
1115                 if ($attendees instanceof Tinebase_Record_RecordSet) {
1116                     $attendees->cal_event_id = $persistentExceptionEvent->getId();
1117                     
1118                     foreach($attendees as $attendee) {
1119                         if (! $attendee->status_authkey) {
1120                             // new invitations
1121                             $attendee->status_authkey = Tinebase_Record_Abstract::generateUID();
1122                         }
1123                         $this->_backend->createAttendee($attendee);
1124                         $this->_increaseDisplayContainerContentSequence($attendee, $persistentExceptionEvent, Tinebase_Model_ContainerContent::ACTION_CREATE);
1125                     }
1126                 }
1127                 
1128                 // @todo save notes and add a update note -> what was updated? -> modlog is also missing
1129                 
1130                 $persistentExceptionEvent = $this->get($persistentExceptionEvent->getId());
1131                 
1132                 foreach($futurePersistentExceptionEvents as $futurePersistentExceptionEvent) {
1133                     $this->update($futurePersistentExceptionEvent, FALSE);
1134                 }
1135                 
1136                 if ($dtStartHasDiff) {
1137                     if (Tinebase_Core::isLogLevel(Zend_Log::DEBUG)) Tinebase_Core::getLogger()->debug(__METHOD__ . '::' . __LINE__ . " new recur series has adpted dtstart -> update to adopt exceptions'");
1138                     $persistentExceptionEvent->dtstart = clone $adoptedDtstart;
1139                     $persistentExceptionEvent->dtend = clone $adoptedDtstart;
1140                     $persistentExceptionEvent->dtend->add($eventLength);
1141                     
1142                     $persistentExceptionEvent = $this->update($persistentExceptionEvent, $_checkBusyConflicts);
1143                 }
1144             }
1145         }
1146         
1147         Tinebase_TransactionManager::getInstance()->commitTransaction($transactionId);
1148         
1149         // restore original notification handling
1150         $this->sendNotifications($sendNotifications);
1151         $notificationAction = $_deleteInstance ? 'deleted' : 'changed';
1152         $notificationEvent = $_deleteInstance ? $_event : $persistentExceptionEvent;
1153         
1154         // restore acl
1155         $this->doContainerACLChecks($doContainerACLChecks);
1156         
1157         // send notifications
1158         if ($this->_sendNotifications && $_event->mute != 1) {
1159             // NOTE: recur exception is a fake event from client. 
1160             //       this might lead to problems, so we wrap the calls
1161             try {
1162                 if (count($_event->attendee) > 0) {
1163                     $_event->attendee->bypassFilters = TRUE;
1164                 }
1165                 $_event->created_by = $baseEvent->created_by;
1166                 
1167                 $this->doSendNotifications($notificationEvent, Tinebase_Core::getUser(), $notificationAction, $originalEvent);
1168             } catch (Exception $e) {
1169                 if (Tinebase_Core::isLogLevel(Zend_Log::DEBUG)) Tinebase_Core::getLogger()->debug(__METHOD__ . '::' . __LINE__ . " " . $e->getTraceAsString());
1170                 Tinebase_Core::getLogger()->warn(__METHOD__ . '::' . __LINE__ . " could not send notification {$e->getMessage()}");
1171             }
1172         }
1173         
1174         return $_deleteInstance ? $updatedBaseEvent : $persistentExceptionEvent;
1175     }
1176     
1177     /**
1178      * (non-PHPdoc)
1179      * @see Tinebase_Controller_Record_Abstract::get()
1180      */
1181     public function get($_id, $_containerId = NULL, $_getRelatedData = TRUE)
1182     {
1183         if (preg_match('/^fakeid/', $_id)) {
1184             // get base event when trying to fetch a non-persistent recur instance
1185             return $this->getRecurBaseEvent(new Calendar_Model_Event(array('uid' => substr(str_replace('fakeid', '', $_id), 0, 40))), TRUE);
1186         } else {
1187             return parent::get($_id, $_containerId, $_getRelatedData);
1188         }
1189     }
1190     
1191     /**
1192      * returns base event of a recurring series
1193      *
1194      * @param  Calendar_Model_Event $_event
1195      * @return Calendar_Model_Event
1196      */
1197     public function getRecurBaseEvent($_event)
1198     {
1199         $possibleBaseEventIds = $this->_backend->search(new Calendar_Model_EventFilter(array(
1200             array('field' => 'uid',     'operator' => 'equals', 'value' => $_event->uid),
1201             array('field' => 'recurid', 'operator' => 'isnull', 'value' => NULL)
1202         )), NULL, TRUE);
1203         
1204         if (count($possibleBaseEventIds) > 1) {
1205             if (Tinebase_Core::isLogLevel(Zend_Log::NOTICE)) Tinebase_Core::getLogger()->notice(__METHOD__ . '::' . __LINE__ .
1206                 ' Got multiple possible base events: ' . print_r($possibleBaseEventIds, true));
1207         }
1208         $baseEventId = array_value(0, $possibleBaseEventIds);
1209         
1210         if (! $baseEventId) {
1211             throw new Tinebase_Exception_NotFound('base event of a recurring series not found');
1212         }
1213         
1214         // make sure we have a 'fully featured' event
1215         return $this->get($baseEventId);
1216     }
1217
1218    /**
1219     * lookup existing event by uid
1220     *
1221     * @param  Calendar_Model_Event $_event
1222     * @return Calendar_Model_Event|NULL
1223     * 
1224     * @todo also add more criteria for lookup (recurid, ...)
1225     * @todo sophisticated reccurring event handling
1226     */
1227     public function lookupExistingEvent($_event)
1228     {
1229         $events = $this->_backend->search(new Calendar_Model_EventFilter(array(
1230             array('field' => 'uid',     'operator' => 'equals', 'value' => $_event->uid),
1231             //array('field' => 'recurid', 'operator' => 'isnull', 'value' => NULL)
1232         )));
1233         
1234         $event = $events->filter(Tinebase_Model_Grants::GRANT_READ, TRUE)->getFirstRecord();
1235     
1236         // make sure we have a 'fully featured' event
1237         return ($event !== NULL) ? $this->get($event->getId()) : NULL;
1238     }
1239     
1240     /**
1241      * returns all persistent recur exceptions of recur series identified by uid of given event
1242      * 
1243      * NOTE: deleted instances are saved in the base events exception property
1244      * NOTE: returns all exceptions regardless of current filters and access restrictions
1245      * 
1246      * @param  Calendar_Model_Event        $_event
1247      * @param  boolean                     $_fakeDeletedInstances
1248      * @param  Calendar_Model_EventFilter  $_eventFilter
1249      * @return Tinebase_Record_RecordSet of Calendar_Model_Event
1250      */
1251     public function getRecurExceptions($_event, $_fakeDeletedInstances = FALSE, $_eventFilter = NULL)
1252     {
1253         $exceptionFilter = new Calendar_Model_EventFilter(array(
1254             array('field' => 'uid',     'operator' => 'equals',  'value' => $_event->uid),
1255             array('field' => 'recurid', 'operator' => 'notnull', 'value' => NULL)
1256         ));
1257         
1258         if ($_eventFilter instanceof Calendar_Model_EventFilter) {
1259             $exceptionFilter->addFilterGroup($_eventFilter);
1260         }
1261         
1262         $exceptions = $this->_backend->search($exceptionFilter);
1263         
1264         if ($_fakeDeletedInstances) {
1265             $baseEvent = $this->getRecurBaseEvent($_event);
1266             $this->fakeDeletedExceptions($baseEvent, $exceptions);
1267         }
1268         
1269         $exceptions->exdate = NULL;
1270         $exceptions->rrule = NULL;
1271         $exceptions->rrule_until = NULL;
1272         
1273         return $exceptions;
1274     }
1275
1276     /**
1277      * add exceptions events for deleted instances
1278      *
1279      * @param Calendar_Model_Event $baseEvent
1280      * @param Tinebase_Record_RecordSet $exceptions
1281      */
1282     public function fakeDeletedExceptions($baseEvent, $exceptions)
1283     {
1284         $eventLength = $baseEvent->dtstart->diff($baseEvent->dtend);
1285
1286         // compute remaining exdates
1287         $deletedInstanceDtStarts = array_diff(array_unique((array) $baseEvent->exdate), $exceptions->getOriginalDtStart());
1288
1289         if (Tinebase_Core::isLogLevel(Zend_Log::DEBUG)) Tinebase_Core::getLogger()->debug(__METHOD__ . '::' . __LINE__ .
1290             ' Faking ' . count($deletedInstanceDtStarts) . ' deleted exceptions');
1291
1292         foreach((array) $deletedInstanceDtStarts as $deletedInstanceDtStart) {
1293             $fakeEvent = clone $baseEvent;
1294             $fakeEvent->setId(NULL);
1295
1296             $fakeEvent->dtstart = clone $deletedInstanceDtStart;
1297             $fakeEvent->dtend = clone $deletedInstanceDtStart;
1298             $fakeEvent->dtend->add($eventLength);
1299             $fakeEvent->is_deleted = TRUE;
1300             $fakeEvent->setRecurId();
1301             $fakeEvent->rrule = null;
1302
1303             $exceptions->addRecord($fakeEvent);
1304         }
1305     }
1306
1307    /**
1308     * adopt alarm time to next occurrence for recurring events
1309     *
1310     * @param Tinebase_Record_Abstract $_record
1311     * @param Tinebase_Model_Alarm $_alarm
1312     * @param bool $_nextBy {instance|time} set recurr alarm to next from given instance or next by current time
1313     * @return void
1314     */
1315     public function adoptAlarmTime(Tinebase_Record_Abstract $_record, Tinebase_Model_Alarm $_alarm, $_nextBy = 'time')
1316     {
1317         if ($_record->rrule) {
1318             if (Tinebase_Core::isLogLevel(Zend_Log::DEBUG)) Tinebase_Core::getLogger()->debug(__METHOD__ . '::' . __LINE__ .
1319                  ' Adopting alarm time for next recur occurrence (by ' . $_nextBy . ')');
1320             if (Tinebase_Core::isLogLevel(Zend_Log::TRACE)) Tinebase_Core::getLogger()->trace(__METHOD__ . '::' . __LINE__ .
1321                  ' ' . print_r($_record->toArray(), TRUE));
1322             
1323             if ($_nextBy == 'time') {
1324                 // NOTE: this also finds instances running right now
1325                 $from = Tinebase_DateTime::now();
1326             
1327             } else {
1328                 $recurid = $_alarm->getOption('recurid');
1329                 $instanceStart = $recurid ? new Tinebase_DateTime(substr($recurid, -19)) : clone $_record->dtstart;
1330                 $eventLength = $_record->dtstart->diff($_record->dtend);
1331                 
1332                 $instanceStart->setTimezone($_record->originator_tz);
1333                 $from = $instanceStart->add($eventLength);
1334                 $from->setTimezone('UTC');
1335             }
1336             
1337             // compute next
1338             $exceptions = $this->getRecurExceptions($_record);
1339             $nextOccurrence = Calendar_Model_Rrule::computeNextOccurrence($_record, $exceptions, $from);
1340             
1341             if ($nextOccurrence === NULL) {
1342                 if (Tinebase_Core::isLogLevel(Zend_Log::INFO)) Tinebase_Core::getLogger()->info(__METHOD__ . '::' . __LINE__ .
1343                     ' Recur series is over, no more alarms pending');
1344             } else {
1345                 if (Tinebase_Core::isLogLevel(Zend_Log::DEBUG)) Tinebase_Core::getLogger()->debug(__METHOD__ . '::' . __LINE__ .
1346                     ' Found next occurrence, adopting alarm to dtstart ' . $nextOccurrence->dtstart->toString());
1347             }
1348             
1349             // save recurid so we know for which recurrance the alarm is for
1350             $_alarm->setOption('recurid', isset($nextOccurrence) ? $nextOccurrence->recurid : NULL);
1351             
1352             $_alarm->sent_status = $nextOccurrence ? Tinebase_Model_Alarm::STATUS_PENDING : Tinebase_Model_Alarm::STATUS_SUCCESS;
1353             $_alarm->sent_message = $nextOccurrence ?  '' : 'Nothing to send, series is over';
1354             
1355             $eventStart = $nextOccurrence ? clone $nextOccurrence->dtstart : clone $_record->dtstart;
1356         } else {
1357             $eventStart = clone $_record->dtstart;
1358         }
1359         
1360         // save minutes before / compute it for custom alarms
1361         $minutesBefore = $_alarm->minutes_before == Tinebase_Model_Alarm::OPTION_CUSTOM 
1362             ? ($_record->dtstart->getTimestamp() - $_alarm->alarm_time->getTimestamp()) / 60 
1363             : $_alarm->minutes_before;
1364         $minutesBefore = round($minutesBefore);
1365         
1366         $_alarm->setOption('minutes_before', $minutesBefore);
1367         $_alarm->alarm_time = $eventStart->subMinute($minutesBefore);
1368         
1369         if ($_record->rrule && $_alarm->sent_status == Tinebase_Model_Alarm::STATUS_PENDING && $_alarm->alarm_time < $_alarm->sent_time) {
1370             $this->adoptAlarmTime($_record, $_alarm, 'instance');
1371         }
1372         
1373         if (Tinebase_Core::isLogLevel(Zend_Log::TRACE)) Tinebase_Core::getLogger()->trace(__METHOD__ . '::' . __LINE__ .
1374             ' alarm: ' . print_r($_alarm->toArray(), true));
1375     }
1376     
1377     /****************************** overwritten functions ************************/
1378     
1379     /**
1380      * restore original alarm time of recurring events
1381      * 
1382      * @param Tinebase_Record_Abstract $_record
1383      * @return void
1384      */
1385     protected function _inspectAlarmGet(Tinebase_Record_Abstract $_record)
1386     {
1387         foreach ($_record->alarms as $alarm) {
1388             if ($recurid = $alarm->getOption('recurid')) {
1389                 $alarm->alarm_time = clone $_record->dtstart;
1390                 $alarm->alarm_time->subMinute((int) $alarm->getOption('minutes_before'));
1391             }
1392         }
1393         
1394         parent::_inspectAlarmGet($_record);
1395     }
1396     
1397     /**
1398      * adopt alarm time to next occurance for recurring events
1399      * 
1400      * @param Tinebase_Record_Abstract $_record
1401      * @param Tinebase_Model_Alarm $_alarm
1402      * @param bool $_nextBy {instance|time} set recurr alarm to next from given instance or next by current time
1403      * @return void
1404      * @throws Tinebase_Exception_InvalidArgument
1405      */
1406     protected function _inspectAlarmSet(Tinebase_Record_Abstract $_record, Tinebase_Model_Alarm $_alarm, $_nextBy = 'time')
1407     {
1408         parent::_inspectAlarmSet($_record, $_alarm);
1409         $this->adoptAlarmTime($_record, $_alarm, 'time');
1410     }
1411     
1412     /**
1413      * inspect update of one record
1414      * 
1415      * @param   Tinebase_Record_Interface $_record      the update record
1416      * @param   Tinebase_Record_Interface $_oldRecord   the current persistent record
1417      * @return  void
1418      */
1419     protected function _inspectBeforeUpdate($_record, $_oldRecord)
1420     {
1421         // if dtstart of an event changes, we update the originator_tz, alarm times
1422         if (! $_oldRecord->dtstart->equals($_record->dtstart)) {
1423             if (Tinebase_Core::isLogLevel(Zend_Log::DEBUG)) Tinebase_Core::getLogger()->debug(__METHOD__ . '::' . __LINE__ . ' dtstart changed -> adopting organizer_tz');
1424             $_record->originator_tz = Tinebase_Core::get(Tinebase_Core::USERTIMEZONE);
1425             if (! empty($_record->rrule)) {
1426                 $diff = $_oldRecord->dtstart->diff($_record->dtstart);
1427                 $this->_updateRecurIdOfExdates($_record, $diff);
1428             }
1429         }
1430         
1431         // delete recur exceptions if update is no longer a recur series
1432         if (! empty($_oldRecord->rrule) && empty($_record->rrule)) {
1433             if (Tinebase_Core::isLogLevel(Zend_Log::DEBUG)) Tinebase_Core::getLogger()->debug(__METHOD__ . '::' . __LINE__ . ' deleting recur exceptions as event is no longer a recur series');
1434             $this->_backend->delete($this->getRecurExceptions($_record));
1435         }
1436         
1437         // touch base event of a recur series if an persistent exception changes
1438         if ($_record->recurid) {
1439             if (Tinebase_Core::isLogLevel(Zend_Log::DEBUG)) Tinebase_Core::getLogger()->debug(__METHOD__ . '::' . __LINE__ . ' touch base event of a persistent exception');
1440             $baseEvent = $this->getRecurBaseEvent($_record);
1441             $this->_touch($baseEvent, TRUE);
1442         }
1443     }
1444     
1445     /**
1446      * update exdates and recurids if dtstart of an recurevent changes
1447      * 
1448      * @param Calendar_Model_Event $_record
1449      * @param DateInterval $diff
1450      */
1451     protected function _updateRecurIdOfExdates($_record, $diff)
1452     {
1453         // update exceptions
1454         $exceptions = $this->getRecurExceptions($_record);
1455         if (Tinebase_Core::isLogLevel(Zend_Log::DEBUG)) Tinebase_Core::getLogger()->debug(__METHOD__ . '::' . __LINE__ . ' dtstart of a series changed -> adopting '. count($exceptions) . ' recurid(s)');
1456         $exdates = array();
1457         foreach ($exceptions as $exception) {
1458             $exception->recurid = new Tinebase_DateTime(substr($exception->recurid, -19));
1459             Calendar_Model_Rrule::addUTCDateDstFix($exception->recurid, $diff, $_record->originator_tz);
1460             $exdates[] = $exception->recurid;
1461             
1462             $exception->setRecurId();
1463             $this->_backend->update($exception);
1464         }
1465         
1466         $_record->exdate = $exdates;
1467     }
1468     
1469     /**
1470      * inspect before create/update
1471      * 
1472      * @TODO move stuff from other places here
1473      * @param   Calendar_Model_Event $_record      the record to inspect
1474      */
1475     protected function _inspectEvent($_record)
1476     {
1477         $_record->uid = $_record->uid ? $_record->uid : Tinebase_Record_Abstract::generateUID();
1478         $_record->organizer = $_record->organizer ? $_record->organizer : Tinebase_Core::getUser()->contact_id;
1479         $_record->transp = $_record->transp ? $_record->transp : Calendar_Model_Event::TRANSP_OPAQUE;
1480
1481         $this->_inspectOriginatorTZ($_record);
1482
1483         if ($_record->hasExternalOrganizer()) {
1484             // assert calendarUser as attendee. This is important to keep the event in the loop via its displaycontianer(s)
1485             try {
1486                 $container = Tinebase_Container::getInstance()->getContainerById($_record->container_id);
1487                 $owner = $container->getOwner();
1488                 $calendarUserId = Addressbook_Controller_Contact::getInstance()->getContactByUserId($owner, true)->getId();
1489             } catch (Exception $e) {
1490                 $container = NULL;
1491                 $calendarUserId = Tinebase_Core::getUser()->contact_id;
1492             }
1493             
1494             $attendee = $_record->assertAttendee(new Calendar_Model_Attender(array(
1495                 'user_type'    => Calendar_Model_Attender::USERTYPE_USER,
1496                 'user_id'      => $calendarUserId
1497             )), false, false, true);
1498             
1499             if ($attendee && $container instanceof Tinebase_Model_Container) {
1500                 $attendee->displaycontainer_id = $container->getId();
1501             }
1502             
1503             if (! $container instanceof Tinebase_Model_Container || $container->type == Tinebase_Model_Container::TYPE_PERSONAL) {
1504                 // move into special (external users) container
1505                 $container = Calendar_Controller::getInstance()->getInvitationContainer($_record->resolveOrganizer());
1506                 if (Tinebase_Core::isLogLevel(Zend_Log::DEBUG)) Tinebase_Core::getLogger()->debug(__METHOD__ . '::' . __LINE__
1507                     . ' Setting container_id to ' . $container->getId() . ' for external organizer ' . $_record->organizer->email);
1508                 $_record->container_id = $container->getId();
1509             }
1510             
1511         }
1512         
1513         if ($_record->is_all_day_event) {
1514             // harmonize datetimes of all day events
1515             $_record->setTimezone($_record->originator_tz);
1516             if (! $_record->dtend) {
1517                 $_record->dtend = clone $_record->dtstart;
1518                 $_record->dtend->setTime(23,59,59);
1519             }
1520             $_record->dtstart->setTime(0,0,0);
1521             $_record->dtend->setTime(23,59,59);
1522             $_record->setTimezone('UTC');
1523         }
1524         $_record->setRruleUntil();
1525         
1526         if ($_record->rrule instanceof Calendar_Model_Rrule) {
1527             $_record->rrule->normalize($_record);
1528         }
1529         
1530         if ($_record->isRecurException() && $_record->rrule !== NULL) {
1531             if (Tinebase_Core::isLogLevel(Zend_Log::DEBUG)) Tinebase_Core::getLogger()->debug(__METHOD__ . '::' . __LINE__
1532                 . ' Removing invalid rrule from recur exception: ' . $_record->rrule);
1533             $_record->rrule = NULL;
1534         }
1535     }
1536
1537     /**
1538      * checks/sets originator timezone
1539      *
1540      * @param $record
1541      * @throws Tinebase_Exception_Record_Validation
1542      */
1543     protected function _inspectOriginatorTZ($record)
1544     {
1545         $record->originator_tz = $record->originator_tz ? $record->originator_tz : Tinebase_Core::get(Tinebase_Core::USERTIMEZONE);
1546
1547         try {
1548             new DateTimeZone($record->originator_tz);
1549         } catch (Exception $e) {
1550             throw new Tinebase_Exception_Record_Validation('Bad Timezone: ' . $record->originator_tz);
1551         }
1552     }
1553     
1554     /**
1555      * inspects delete action
1556      *
1557      * @param array $_ids
1558      * @return array of ids to actually delete
1559      */
1560     protected function _inspectDelete(array $_ids) {
1561         $events = $this->_backend->getMultiple($_ids);
1562         
1563         foreach ($events as $event) {
1564             
1565             // implicitly delete persistent recur instances of series
1566             if (! empty($event->rrule)) {
1567                 $exceptionIds = $this->getRecurExceptions($event)->getId();
1568                 if (Tinebase_Core::isLogLevel(Zend_Log::DEBUG)) Tinebase_Core::getLogger()->debug(__METHOD__ . '::' . __LINE__
1569                     . ' Implicitly deleting ' . (count($exceptionIds) - 1 ) . ' persistent exception(s) for recurring series with uid' . $event->uid);
1570                 $_ids = array_merge($_ids, $exceptionIds);
1571             }
1572         }
1573         
1574         $this->_deleteAlarmsForIds($_ids);
1575         
1576         return array_unique($_ids);
1577     }
1578     
1579     /**
1580      * redefine required grants for get actions
1581      * 
1582      * @param Tinebase_Model_Filter_FilterGroup $_filter
1583      * @param string $_action get|update
1584      */
1585     public function checkFilterACL(Tinebase_Model_Filter_FilterGroup $_filter, $_action = 'get')
1586     {
1587         $hasGrantsFilter = FALSE;
1588         foreach($_filter->getAclFilters() as $aclFilter) {
1589             if ($aclFilter instanceof Calendar_Model_GrantFilter) {
1590                 $hasGrantsFilter = TRUE;
1591                 break;
1592             }
1593         }
1594         
1595         if (! $hasGrantsFilter) {
1596             // force a grant filter
1597             // NOTE: actual grants are set via setRequiredGrants later
1598             $grantsFilter = $_filter->createFilter('grants', 'in', '@setRequiredGrants');
1599             $_filter->addFilter($grantsFilter);
1600         }
1601         
1602         parent::checkFilterACL($_filter, $_action);
1603         
1604         if ($_action == 'get') {
1605             $_filter->setRequiredGrants(array(
1606                 Tinebase_Model_Grants::GRANT_FREEBUSY,
1607                 Tinebase_Model_Grants::GRANT_READ,
1608                 Tinebase_Model_Grants::GRANT_ADMIN,
1609             ));
1610         }
1611     }
1612     
1613     /**
1614      * check grant for action (CRUD)
1615      *
1616      * @param Tinebase_Record_Interface $_record
1617      * @param string $_action
1618      * @param boolean $_throw
1619      * @param string $_errorMessage
1620      * @param Tinebase_Record_Interface $_oldRecord
1621      * @return boolean
1622      * @throws Tinebase_Exception_AccessDenied
1623      * 
1624      * @todo use this function in other create + update functions
1625      * @todo invent concept for simple adding of grants (plugins?) 
1626      */
1627     protected function _checkGrant($_record, $_action, $_throw = TRUE, $_errorMessage = 'No Permission.', $_oldRecord = NULL)
1628     {
1629         if (    ! $this->_doContainerACLChecks 
1630             // admin grant includes all others (only if class is PUBLIC)
1631             ||  (! empty($this->class) && $this->class === Calendar_Model_Event::CLASS_PUBLIC 
1632                 && $_record->container_id && Tinebase_Core::getUser()->hasGrant($_record->container_id, Tinebase_Model_Grants::GRANT_ADMIN))
1633             // external invitations are in a spechial invitaion calendar. only attendee can see it via displaycal
1634             ||  $_record->hasExternalOrganizer()
1635         ) {
1636             return true;
1637         }
1638         
1639         switch ($_action) {
1640             case 'get':
1641                 // NOTE: free/busy is not a read grant!
1642                 $hasGrant = $_record->hasGrant(Tinebase_Model_Grants::GRANT_READ);
1643                 if (! $hasGrant) {
1644                     $_record->doFreeBusyCleanup();
1645                 }
1646                 break;
1647             case 'create':
1648                 $hasGrant = Tinebase_Core::getUser()->hasGrant($_record->container_id, Tinebase_Model_Grants::GRANT_ADD);
1649                 break;
1650             case 'update':
1651                 $hasGrant = (bool) $_oldRecord->hasGrant(Tinebase_Model_Grants::GRANT_EDIT);
1652                 
1653                 if ($_oldRecord->container_id != $_record->container_id) {
1654                     $hasGrant &= Tinebase_Core::getUser()->hasGrant($_record->container_id, Tinebase_Model_Grants::GRANT_ADD)
1655                                  && $_oldRecord->hasGrant(Tinebase_Model_Grants::GRANT_DELETE);
1656                 }
1657                 break;
1658             case 'delete':
1659                 $hasGrant = (bool) $_record->hasGrant(Tinebase_Model_Grants::GRANT_DELETE);
1660                 break;
1661             case 'sync':
1662                 $hasGrant = (bool) $_record->hasGrant(Tinebase_Model_Grants::GRANT_SYNC);
1663                 break;
1664             case 'export':
1665                 $hasGrant = (bool) $_record->hasGrant(Tinebase_Model_Grants::GRANT_EXPORT);
1666                 break;
1667         }
1668         
1669         if (! $hasGrant) {
1670             if ($_throw) {
1671                 throw new Tinebase_Exception_AccessDenied($_errorMessage);
1672             } else {
1673                 if (Tinebase_Core::isLogLevel(Zend_Log::DEBUG)) Tinebase_Core::getLogger()->debug(__METHOD__ . '::' . __LINE__
1674                     . ' No permissions to ' . $_action . ' in container ' . $_record->container_id);
1675             }
1676         }
1677         
1678         return $hasGrant;
1679     }
1680     
1681     /**
1682      * touches (sets seq, last_modified_time and container content sequence) given event
1683      * 
1684      * @param  $_event
1685      * @return void
1686      */
1687     protected function _touch($_event, $_setModifier = FALSE)
1688     {
1689         $_event->last_modified_time = Tinebase_DateTime::now();
1690         $_event->seq = (int)$_event->seq + 1;
1691         if ($_setModifier) {
1692             $_event->last_modified_by = Tinebase_Core::getUser()->getId();
1693         }
1694         
1695         $this->_backend->update($_event);
1696         
1697         $this->_increaseContainerContentSequence($_event, Tinebase_Model_ContainerContent::ACTION_UPDATE);
1698     }
1699     
1700     /**
1701      * increase container content sequence
1702      *
1703      * @param Tinebase_Record_Interface $_record
1704      * @param string $action
1705      */
1706     protected function _increaseContainerContentSequence(Tinebase_Record_Interface $record, $action = NULL)
1707     {
1708         parent::_increaseContainerContentSequence($record, $action);
1709         
1710         if ($record->attendee instanceof Tinebase_Record_RecordSet) {
1711             $updatedContainerIds = array($record->container_id);
1712             foreach ($record->attendee as $attender) {
1713                 if (isset($attender->displaycontainer_id) && ! in_array($attender->displaycontainer_id, $updatedContainerIds)) {
1714                     Tinebase_Container::getInstance()->increaseContentSequence($attender->displaycontainer_id, $action, $record->getId());
1715                     $updatedContainerIds[] = $attender->displaycontainer_id;
1716                 }
1717             }
1718         }
1719     }
1720     
1721     
1722     /****************************** attendee functions ************************/
1723     
1724     /**
1725      * creates an attender status exception of a recurring event series
1726      * 
1727      * NOTE: Recur exceptions are implicitly created
1728      *
1729      * @param  Calendar_Model_Event    $_recurInstance
1730      * @param  Calendar_Model_Attender $_attender
1731      * @param  string                  $_authKey
1732      * @param  bool                    $_allFollowing
1733      * @return Calendar_Model_Attender updated attender
1734      */
1735     public function attenderStatusCreateRecurException($_recurInstance, $_attender, $_authKey, $_allFollowing = FALSE)
1736     {
1737         try {
1738             $db = $this->_backend->getAdapter();
1739             $transactionId = Tinebase_TransactionManager::getInstance()->startTransaction($db);
1740             
1741             $baseEvent = $this->getRecurBaseEvent($_recurInstance);
1742             $baseEventAttendee = Calendar_Model_Attender::getAttendee($baseEvent->attendee, $_attender);
1743             
1744             if ($baseEvent->getId() == $_recurInstance->getId()) {
1745                 // exception to the first occurence
1746                 $_recurInstance->setRecurId();
1747             }
1748             
1749             // NOTE: recurid is computed by rrule recur computations and therefore is already part of the event.
1750             if (empty($_recurInstance->recurid)) {
1751                 throw new Exception('recurid must be present to create exceptions!');
1752             }
1753             
1754             try {
1755                 // check if we already have a persistent exception for this event
1756                 $eventInstance = $this->_backend->getByProperty($_recurInstance->recurid, $_property = 'recurid');
1757                 
1758                 // NOTE: the user must exist (added by someone with appropriate rights by createRecurException)
1759                 $exceptionAttender = Calendar_Model_Attender::getAttendee($eventInstance->attendee, $_attender);
1760                 if (! $exceptionAttender) {
1761                     throw new Tinebase_Exception_AccessDenied('not an attendee');
1762                 }
1763                 
1764                 
1765                 if ($exceptionAttender->status_authkey != $_authKey) {
1766                     // NOTE: it might happen, that the user set her status from the base event without knowing about 
1767                     //       an existing exception. In this case the base event authkey is also valid
1768                     if (! $baseEventAttendee || $baseEventAttendee->status_authkey != $_authKey) {
1769                         throw new Tinebase_Exception_AccessDenied('Attender authkey mismatch');
1770                     }
1771                 }
1772                 
1773             } catch (Tinebase_Exception_NotFound $e) {
1774                 // otherwise create it implicilty
1775                 
1776                 // check if this intance takes place
1777                 if (in_array($_recurInstance->dtstart, (array)$baseEvent->exdate)) {
1778                     throw new Tinebase_Exception_AccessDenied('Event instance is deleted and may not be recreated via status setting!');
1779                 }
1780                 
1781                 if (! $baseEventAttendee) {
1782                     throw new Tinebase_Exception_AccessDenied('not an attendee');
1783                 }
1784                 
1785                 if ($baseEventAttendee->status_authkey != $_authKey) {
1786                     throw new Tinebase_Exception_AccessDenied('Attender authkey mismatch');
1787                 }
1788                 
1789                 if (Tinebase_Core::isLogLevel(Zend_Log::DEBUG)) Tinebase_Core::getLogger()->debug(__METHOD__ . '::' . __LINE__ . " creating recur exception for a exceptional attendee status");
1790                 
1791                 $doContainerAclChecks = $this->doContainerACLChecks(FALSE);
1792                 $sendNotifications = $this->sendNotifications(FALSE);
1793                 
1794                 // NOTE: the user might have no edit grants, so let's be carefull
1795                 $diff = $baseEvent->dtstart->diff($baseEvent->dtend);
1796                 
1797                 $baseEvent->dtstart = new Tinebase_DateTime(substr($_recurInstance->recurid, -19), 'UTC');
1798                 $baseEvent->dtend   = clone $baseEvent->dtstart;
1799                 $baseEvent->dtend->add($diff);
1800                 
1801                 $baseEvent->id = $_recurInstance->id;
1802                 $baseEvent->recurid = $_recurInstance->recurid;
1803                 
1804                 $attendee = $baseEvent->attendee;
1805                 unset($baseEvent->attendee);
1806                 
1807                 $eventInstance = $this->createRecurException($baseEvent, FALSE, $_allFollowing);
1808                 $eventInstance->attendee = new Tinebase_Record_RecordSet('Calendar_Model_Attender');
1809                 $this->doContainerACLChecks($doContainerAclChecks);
1810                 $this->sendNotifications($sendNotifications);
1811                 
1812                 foreach ($attendee as $attender) {
1813                     $attender->setId(NULL);
1814                     $attender->cal_event_id = $eventInstance->getId();
1815                     
1816                     $attender = $this->_backend->createAttendee($attender);
1817                     $eventInstance->attendee->addRecord($attender);
1818                     $this->_increaseDisplayContainerContentSequence($attender, $eventInstance, Tinebase_Model_ContainerContent::ACTION_CREATE);
1819                 }
1820                 
1821                 $exceptionAttender = Calendar_Model_Attender::getAttendee($eventInstance->attendee, $_attender);
1822             }
1823             
1824             $exceptionAttender->status = $_attender->status;
1825             $exceptionAttender->transp = $_attender->transp;
1826             $eventInstance->alarms     = clone $_recurInstance->alarms;
1827             $eventInstance->alarms->setId(NULL);
1828             
1829             $updatedAttender = $this->attenderStatusUpdate($eventInstance, $exceptionAttender, $exceptionAttender->status_authkey);
1830             
1831             Tinebase_TransactionManager::getInstance()->commitTransaction($transactionId);
1832         } catch (Exception $e) {
1833             Tinebase_TransactionManager::getInstance()->rollBack();
1834             throw $e;
1835         }
1836         
1837         return $updatedAttender;
1838     }
1839     
1840     /**
1841      * updates an attender status of a event
1842      * 
1843      * @param  Calendar_Model_Event    $_event
1844      * @param  Calendar_Model_Attender $_attender
1845      * @param  string                  $_authKey
1846      * @return Calendar_Model_Attender updated attender
1847      */
1848     public function attenderStatusUpdate(Calendar_Model_Event $_event, Calendar_Model_Attender $_attender, $_authKey)
1849     {
1850         try {
1851             $event = $this->get($_event->getId());
1852             
1853             if (! $event->attendee) {
1854                 throw new Tinebase_Exception_NotFound('Could not find any attendee of event.');
1855             }
1856             
1857             if (($currentAttender = Calendar_Model_Attender::getAttendee($event->attendee, $_attender)) == null) {
1858                 throw new Tinebase_Exception_NotFound('Could not find attender in event.');
1859             }
1860             
1861             $updatedAttender = clone $currentAttender;
1862             
1863             if ($currentAttender->status_authkey !== $_authKey) {
1864                 if (Tinebase_Core::isLogLevel(Zend_Log::DEBUG)) 
1865                     Tinebase_Core::getLogger()->debug(__METHOD__ . '::' . __LINE__ . " no permissions to update status for {$currentAttender->user_type} {$currentAttender->user_id}");
1866                 return $updatedAttender;
1867             }
1868             
1869             Calendar_Controller_Alarm::enforceACL($_event, $event);
1870             
1871             $currentAttenderDisplayContainerId = $currentAttender->displaycontainer_id instanceof Tinebase_Model_Container ? 
1872                 $currentAttender->displaycontainer_id->getId() : 
1873                 $currentAttender->displaycontainer_id;
1874             
1875             $attenderDisplayContainerId = $_attender->displaycontainer_id instanceof Tinebase_Model_Container ? 
1876                 $_attender->displaycontainer_id->getId() : 
1877                 $_attender->displaycontainer_id;
1878             
1879             // check if something what can be set as user has changed
1880             if ($currentAttender->status == $_attender->status &&
1881                 $currentAttenderDisplayContainerId  == $attenderDisplayContainerId   &&
1882                 $currentAttender->transp            == $_attender->transp            &&
1883                 ! Calendar_Controller_Alarm::hasUpdates($_event, $event)
1884             ) {
1885                 if (Tinebase_Core::isLogLevel(Zend_Log::DEBUG)) 
1886                     Tinebase_Core::getLogger()->DEBUG(__METHOD__ . '::' . __LINE__ . "no status change -> do nothing");
1887                 return $updatedAttender;
1888             }
1889             
1890             $updatedAttender->status              = $_attender->status;
1891             $updatedAttender->displaycontainer_id = isset($_attender->displaycontainer_id) ? $_attender->displaycontainer_id : $updatedAttender->displaycontainer_id;
1892             $updatedAttender->transp              = isset($_attender->transp) ? $_attender->transp : Calendar_Model_Event::TRANSP_OPAQUE;
1893             
1894             if (Tinebase_Core::isLogLevel(Zend_Log::DEBUG)) {
1895                 Tinebase_Core::getLogger()->debug(__METHOD__ . '::' . __LINE__
1896                     . " update attender status to {$_attender->status} for {$currentAttender->user_type} {$currentAttender->user_id}");
1897                 Tinebase_Core::getLogger()->debug(__METHOD__ . '::' . __LINE__
1898                     . ' set alarm_ack_time / alarm_snooze_time: ' . $updatedAttender->alarm_ack_time . ' / ' . $updatedAttender->alarm_snooze_time);
1899             }
1900             
1901             $transactionId = Tinebase_TransactionManager::getInstance()->startTransaction(Tinebase_Core::getDb());
1902             
1903             $updatedAttender = $this->_backend->updateAttendee($updatedAttender);
1904             if ($_event->alarms instanceof Tinebase_Record_RecordSet) {
1905                 foreach($_event->alarms as $alarm) {
1906                     $this->_inspectAlarmSet($event, $alarm);
1907                 }
1908                 
1909                 Tinebase_Alarm::getInstance()->setAlarmsOfRecord($_event);
1910             }
1911             
1912             $this->_increaseDisplayContainerContentSequence($updatedAttender, $event);
1913
1914             if ($currentAttender->status != $updatedAttender->status) {
1915                 $this->_touch($event, TRUE);
1916             }
1917             
1918             Tinebase_TransactionManager::getInstance()->commitTransaction($transactionId);
1919         } catch (Exception $e) {
1920             Tinebase_TransactionManager::getInstance()->rollBack();
1921             throw $e;
1922         }
1923         
1924         // send notifications
1925         if ($currentAttender->status != $updatedAttender->status && $this->_sendNotifications && $_event->mute != 1) {
1926             $updatedEvent = $this->get($event->getId());
1927             $this->doSendNotifications($updatedEvent, Tinebase_Core::getUser(), 'changed', $event);
1928         }
1929         
1930         return $updatedAttender;
1931     }
1932     
1933     /**
1934      * saves all attendee of given event
1935      * 
1936      * NOTE: This function is executed in a create/update context. As such the user
1937      *       has edit/update the event and can do anything besides status settings of attendee
1938      * 
1939      * @todo add support for resources
1940      * 
1941      * @param Calendar_Model_Event $_event
1942      * @param Calendar_Model_Event $_currentEvent
1943      * @param bool                 $_isRescheduled event got rescheduled reset all attendee status
1944      */
1945     protected function _saveAttendee($_event, $_currentEvent = NULL, $_isRescheduled = FALSE)
1946     {
1947         if (! $_event->attendee instanceof Tinebase_Record_RecordSet) {
1948             $_event->attendee = new Tinebase_Record_RecordSet('Calendar_Model_Attender');
1949         }
1950         
1951         Calendar_Model_Attender::resolveEmailOnlyAttendee($_event);
1952         
1953         $_event->attendee->cal_event_id = $_event->getId();
1954         
1955         Tinebase_Core::getLogger()->info(__METHOD__ . '::' . __LINE__ . " About to save attendee for event {$_event->id} ");
1956         
1957         $currentAttendee = $_currentEvent->attendee;
1958         
1959         $diff = $currentAttendee->getMigration($_event->attendee->getArrayOfIds());
1960
1961         $calendar = Tinebase_Container::getInstance()->getContainerById($_event->container_id);
1962         
1963         // delete attendee
1964         $this->_backend->deleteAttendee($diff['toDeleteIds']);
1965         foreach ($diff['toDeleteIds'] as $deleteAttenderId) {
1966             $idx = $currentAttendee->getIndexById($deleteAttenderId);
1967             if ($idx !== FALSE) {
1968                 $currentAttenderToDelete = $currentAttendee[$idx];
1969                 $this->_increaseDisplayContainerContentSequence($currentAttenderToDelete, $_event, Tinebase_Model_ContainerContent::ACTION_DELETE);
1970             }
1971         }
1972         
1973         // create/update attendee
1974         foreach ($_event->attendee as $attender) {
1975             $attenderId = $attender->getId();
1976             $idx = ($attenderId) ? $currentAttendee->getIndexById($attenderId) : FALSE;
1977             
1978             if ($idx !== FALSE) {
1979                 $currentAttender = $currentAttendee[$idx];
1980                 $this->_updateAttender($attender, $currentAttender, $_event, $_isRescheduled, $calendar);
1981             } else {
1982                 $this->_createAttender($attender, $_event, FALSE, $calendar);
1983             }
1984         }
1985     }
1986
1987     /**
1988      * creates a new attender
1989      * 
1990      * @param Calendar_Model_Attender  $attender
1991      * @param Tinebase_Model_Container $_calendar
1992      * @param boolean $preserveStatus
1993      * @param Tinebase_Model_Container $calendar
1994      */
1995     protected function _createAttender(Calendar_Model_Attender $attender, Calendar_Model_Event $event, $preserveStatus = FALSE, Tinebase_Model_Container $calendar = NULL)
1996     {
1997         // apply defaults
1998         $attender->user_type         = isset($attender->user_type) ? $attender->user_type : Calendar_Model_Attender::USERTYPE_USER;
1999         $calendar = ($calendar) ? $calendar : Tinebase_Container::getInstance()->getContainerById($event->container_id);
2000         
2001         $userAccountId = $attender->getUserAccountId();
2002         
2003         // generate auth key
2004         if (! $attender->status_authkey) {
2005             $attender->status_authkey = Tinebase_Record_Abstract::generateUID();
2006         }
2007         
2008         // attach to display calendar if attender has/is a useraccount
2009         if ($userAccountId) {
2010             if ($calendar->type == Tinebase_Model_Container::TYPE_PERSONAL && Tinebase_Container::getInstance()->hasGrant($userAccountId, $calendar, Tinebase_Model_Grants::GRANT_ADMIN)) {
2011                 // if attender has admin grant to personal physical container, this phys. cal also gets displ. cal
2012                 $attender->displaycontainer_id = $calendar->getId();
2013             } else if ($attender->displaycontainer_id && $userAccountId == Tinebase_Core::getUser()->getId() && Tinebase_Container::getInstance()->hasGrant($userAccountId, $attender->displaycontainer_id, Tinebase_Model_Grants::GRANT_ADMIN)) {
2014                 // allow user to set his own displ. cal
2015                 $attender->displaycontainer_id = $attender->displaycontainer_id;
2016             } else {
2017                 $displayCalId = self::getDefaultDisplayContainerId($userAccountId);
2018                 $attender->displaycontainer_id = $displayCalId;
2019             }
2020
2021         } else if ($attender->user_type === Calendar_Model_Attender::USERTYPE_RESOURCE) {
2022             $resource = Calendar_Controller_Resource::getInstance()->get($attender->user_id);
2023             $attender->displaycontainer_id = $resource->container_id;
2024         }
2025         
2026         if ($attender->displaycontainer_id) {
2027             // check if user is allowed to set status
2028             if (! $preserveStatus && ! Tinebase_Core::getUser()->hasGrant($attender->displaycontainer_id, Tinebase_Model_Grants::GRANT_EDIT)) {
2029                 $attender->status = Calendar_Model_Attender::STATUS_NEEDSACTION;
2030             }
2031         }
2032
2033         if (Tinebase_Core::isLogLevel(Zend_Log::TRACE)) Tinebase_Core::getLogger()->trace(__METHOD__ . '::' . __LINE__ . " New attender: " . print_r($attender->toArray(), TRUE));
2034
2035         Tinebase_Timemachine_ModificationLog::getInstance()->setRecordMetaData($attender, 'create');
2036         $this->_backend->createAttendee($attender);
2037         $this->_increaseDisplayContainerContentSequence($attender, $event, Tinebase_Model_ContainerContent::ACTION_CREATE);
2038     }
2039     
2040     /**
2041      * returns default displayContainer id of given attendee
2042      *
2043      * @param string $userAccountId
2044      */
2045     public static function getDefaultDisplayContainerId($userAccountId)
2046     {
2047         $userAccountId = Tinebase_Model_User::convertUserIdToInt($userAccountId);
2048         $displayCalId = Tinebase_Core::getPreference('Calendar')->getValueForUser(Calendar_Preference::DEFAULTCALENDAR, $userAccountId);
2049         
2050         try {
2051             // assert that displaycal is of type personal
2052             $container = Tinebase_Container::getInstance()->getContainerById($displayCalId);
2053             if ($container->type != Tinebase_Model_Container::TYPE_PERSONAL) {
2054                 $displayCalId = NULL;
2055             }
2056         } catch (Exception $e) {
2057             $displayCalId = NULL;
2058         }
2059         
2060         if (! isset($displayCalId)) {
2061             $containers = Tinebase_Container::getInstance()->getPersonalContainer($userAccountId, 'Calendar_Model_Event', $userAccountId, 0, true);
2062             if ($containers->count() > 0) {
2063                 $displayCalId = $containers->getFirstRecord()->getId();
2064             }
2065         }
2066         
2067         return $displayCalId;
2068     }
2069     
2070     /**
2071      * increases content sequence of attender display container
2072      * 
2073      * @param Calendar_Model_Attender $attender
2074      * @param Calendar_Model_Event $event
2075      * @param string $action
2076      */
2077     protected function _increaseDisplayContainerContentSequence($attender, $event, $action = Tinebase_Model_ContainerContent::ACTION_UPDATE)
2078     {
2079         if ($event->container_id === $attender->displaycontainer_id || empty($attender->displaycontainer_id)) {
2080             // no need to increase sequence
2081             return;
2082         }
2083         
2084         Tinebase_Container::getInstance()->increaseContentSequence($attender->displaycontainer_id, $action, $event->getId());
2085     }
2086     
2087     /**
2088      * updates an attender
2089      * 
2090      * @param Calendar_Model_Attender  $attender
2091      * @param Calendar_Model_Attender  $currentAttender
2092      * @param Calendar_Model_Event     $event
2093      * @param bool                     $isRescheduled event got rescheduled reset all attendee status
2094      * @param Tinebase_Model_Container $calendar
2095      */
2096     protected function _updateAttender($attender, $currentAttender, $event, $isRescheduled, $calendar = NULL)
2097     {
2098         $userAccountId = $currentAttender->getUserAccountId();
2099
2100         // update display calendar if attender has/is a useraccount
2101         if ($userAccountId) {
2102             if ($calendar->type == Tinebase_Model_Container::TYPE_PERSONAL && Tinebase_Container::getInstance()->hasGrant($userAccountId, $calendar, Tinebase_Model_Grants::GRANT_ADMIN)) {
2103                 // if attender has admin grant to personal physical container, this phys. cal also gets displ. cal
2104                 $attender->displaycontainer_id = $calendar->getId();
2105             } else if ($userAccountId == Tinebase_Core::getUser()->getId() && Tinebase_Container::getInstance()->hasGrant($userAccountId, $attender->displaycontainer_id, Tinebase_Model_Grants::GRANT_ADMIN)) {
2106                 // allow user to set his own displ. cal
2107                 $attender->displaycontainer_id = $attender->displaycontainer_id;
2108             } else {
2109                 $attender->displaycontainer_id = $currentAttender->displaycontainer_id;
2110             }
2111         }
2112
2113         // reset status if user has no right and authkey is wrong
2114         if ($attender->displaycontainer_id) {
2115             if (! Tinebase_Core::getUser()->hasGrant($attender->displaycontainer_id, Tinebase_Model_Grants::GRANT_EDIT)
2116                     && $attender->status_authkey != $currentAttender->status_authkey) {
2117
2118                 if (Tinebase_Core::isLogLevel(Zend_Log::NOTICE)) Tinebase_Core::getLogger()->notice(__METHOD__ . '::' . __LINE__
2119                     . ' Wrong authkey, resetting status (' . $attender->status . ' -> ' . $currentAttender->status . ')');
2120                 $attender->status = $currentAttender->status;
2121             }
2122         }
2123
2124         // reset all status but calUser on reschedule
2125         if ($isRescheduled && !$attender->isSame($this->getCalendarUser())) {
2126             $attender->status = Calendar_Model_Attender::STATUS_NEEDSACTION;
2127             $attender->transp = null;
2128         }
2129
2130         // preserve old authkey
2131         $attender->status_authkey = $currentAttender->status_authkey;
2132
2133         if (Tinebase_Core::isLogLevel(Zend_Log::TRACE)) Tinebase_Core::getLogger()->trace(__METHOD__ . '::' . __LINE__
2134             . " Updating attender: " . print_r($attender->toArray(), TRUE));
2135
2136
2137         Tinebase_Timemachine_ModificationLog::getInstance()->setRecordMetaData($attender, 'update', $currentAttender);
2138         Tinebase_Timemachine_ModificationLog::getInstance()->writeModLog($attender, $currentAttender, get_class($attender), $this->_getBackendType(), $attender->getId());
2139         $this->_backend->updateAttendee($attender);
2140         
2141         if ($attender->displaycontainer_id !== $currentAttender->displaycontainer_id) {
2142             $this->_increaseDisplayContainerContentSequence($currentAttender, $event, Tinebase_Model_ContainerContent::ACTION_DELETE);
2143             $this->_increaseDisplayContainerContentSequence($attender, $event, Tinebase_Model_ContainerContent::ACTION_CREATE);
2144         } else {
2145             $this->_increaseDisplayContainerContentSequence($attender, $event);
2146         }
2147     }
2148     
2149     /**
2150      * event handler for group updates
2151      * 
2152      * @param Tinebase_Model_Group $_group
2153      * @return void
2154      */
2155     public function onUpdateGroup($_groupId)
2156     {
2157         $doContainerACLChecks = $this->doContainerACLChecks(FALSE);
2158         
2159         $filter = new Calendar_Model_EventFilter(array(
2160             array('field' => 'attender', 'operator' => 'equals', 'value' => array(
2161                 'user_type' => Calendar_Model_Attender::USERTYPE_GROUP,
2162                 'user_id'   => $_groupId
2163             )),
2164             array('field' => 'period', 'operator' => 'within', 'value' => array(
2165                 'from'  => Tinebase_DateTime::now()->get(Tinebase_Record_Abstract::ISO8601LONG),
2166                 'until' => Tinebase_DateTime::now()->addYear(100)->get(Tinebase_Record_Abstract::ISO8601LONG))
2167             )
2168         ));
2169         $events = $this->search($filter, new Tinebase_Model_Pagination(), FALSE, FALSE);
2170         
2171         foreach($events as $event) {
2172             try {
2173                 if (! $event->rrule) {
2174                     // update non recurring futrue events
2175                     Calendar_Model_Attender::resolveGroupMembers($event->attendee);
2176                     $this->update($event);
2177                 } else {
2178                     // update thisandfuture for recurring events
2179                     $nextOccurrence = Calendar_Model_Rrule::computeNextOccurrence($event, $this->getRecurExceptions($event), Tinebase_DateTime::now());
2180                     Calendar_Model_Attender::resolveGroupMembers($nextOccurrence->attendee);
2181                     
2182                     if ($nextOccurrence->dtstart != $event->dtstart) {
2183                         $this->createRecurException($nextOccurrence, FALSE, TRUE);
2184                     } else {
2185                         $this->update($nextOccurrence);
2186                     }
2187                 }
2188             } catch (Exception $e) {
2189                 Tinebase_Core::getLogger()->NOTICE(__METHOD__ . '::' . __LINE__ . " could not update attendee");
2190             }
2191         }
2192         
2193         $this->doContainerACLChecks($doContainerACLChecks);
2194     }
2195     
2196     /****************************** alarm functions ************************/
2197     
2198     /**
2199      * send an alarm
2200      *
2201      * @param  Tinebase_Model_Alarm $_alarm
2202      * @return void
2203      * 
2204      * NOTE: the given alarm is raw and has not passed _inspectAlarmGet
2205      *  
2206      * @todo throw exception on error
2207      */
2208     public function sendAlarm(Tinebase_Model_Alarm $_alarm) 
2209     {
2210         if (Tinebase_Core::isLogLevel(Zend_Log::DEBUG)) Tinebase_Core::getLogger()->debug(__METHOD__ . '::' . __LINE__ . " About to send alarm " . print_r($_alarm->toArray(), TRUE));
2211         
2212         $doContainerACLChecks = $this->doContainerACLChecks(FALSE);
2213         
2214         $event = $this->get($_alarm->record_id);
2215         $event->alarms = new Tinebase_Record_RecordSet('Tinebase_Model_Alarm', array($_alarm));
2216         $this->_inspectAlarmGet($event);
2217         
2218         $this->doContainerACLChecks($doContainerACLChecks);
2219         
2220         if ($event->rrule) {
2221             $recurid = $_alarm->getOption('recurid');
2222             
2223             // adopts the (referenced) alarm and sets alarm time to next occurance
2224             parent::_inspectAlarmSet($event, $_alarm);
2225             $this->adoptAlarmTime($event, $_alarm, 'instance');
2226             
2227             // sent_status might have changed in adoptAlarmTime()
2228             if ($_alarm->sent_status !== Tinebase_Model_Alarm::STATUS_PENDING) {
2229                 if (Tinebase_Core::isLogLevel(Zend_Log::INFO)) Tinebase_Core::getLogger()->info(__METHOD__ . '::' . __LINE__
2230                     . ' Not sending alarm for event at ' . $event->dtstart->toString() . ' with status ' . $_alarm->sent_status);
2231                 return;
2232             }
2233             
2234             if ($recurid) {
2235                 // NOTE: In case of recuring events $event is always the baseEvent,
2236                 //       so we might need to adopt event time to recur instance.
2237                 $diff = $event->dtstart->diff($event->dtend);
2238                 
2239                 $event->dtstart = new Tinebase_DateTime(substr($recurid, -19));
2240                 
2241                 $event->dtend = clone $event->dtstart;
2242                 $event->dtend->add($diff);
2243             }
2244             
2245             if ($event->exdate && in_array($event->dtstart, $event->exdate)) {
2246                 if (Tinebase_Core::isLogLevel(Zend_Log::INFO)) Tinebase_Core::getLogger()->info(__METHOD__ . '::' . __LINE__
2247                     . " Not sending alarm because instance at " . $event->dtstart->toString() . ' is an exception.');
2248                 return;
2249             }
2250         }
2251         
2252         Calendar_Controller_EventNotifications::getInstance()->doSendNotifications($event, Tinebase_Core::getUser(), 'alarm', NULL, $_alarm);
2253     }
2254     
2255     /**
2256      * send notifications 
2257      * 
2258      * @param Calendar_Model_Event       $_event
2259      * @param Tinebase_Model_FullAccount $_updater
2260      * @param Sting                      $_action
2261      * @param Calendar_Model_Event       $_oldEvent
2262      * @param Array                      $_additionalRecipients
2263      * @return void
2264      */
2265     public function doSendNotifications($_event, $_updater, $_action, $_oldEvent = NULL)
2266     {
2267         Tinebase_ActionQueue::getInstance()->queueAction('Calendar.sendEventNotifications', 
2268             $_event, 
2269             $_updater,
2270             $_action, 
2271             $_oldEvent ? $_oldEvent : NULL
2272         );
2273     }
2274
2275     public function compareCalendars($cal1, $cal2, $from, $until)
2276     {
2277         $matchingEvents = new Tinebase_Record_RecordSet('Calendar_Model_Event');
2278         $changedEvents = new Tinebase_Record_RecordSet('Calendar_Model_Event');
2279         $missingEventsInCal1 = new Tinebase_Record_RecordSet('Calendar_Model_Event');
2280         $missingEventsInCal2 = new Tinebase_Record_RecordSet('Calendar_Model_Event');
2281         $cal2EventIdsAlreadyProcessed = array();
2282         
2283         while ($from->isEarlier($until)) {
2284     
2285             $endWeek = $from->getClone()->addWeek(1);
2286             
2287             if (Tinebase_Core::isLogLevel(Zend_Log::INFO)) Tinebase_Core::getLogger()->info(__METHOD__ . '::' . __LINE__
2288                     . ' Comparing period ' . $from . ' - ' . $endWeek);
2289     
2290             // get all events from cal1+cal2 for the week
2291             $cal1Events = $this->_getEventsForPeriodAndCalendar($cal1, $from, $endWeek);
2292             $cal1EventsClone = clone $cal1Events;
2293             $cal2Events = $this->_getEventsForPeriodAndCalendar($cal2, $from, $endWeek);
2294             $cal2EventsClone = clone $cal2Events;
2295             
2296             $from->addWeek(1);
2297             if (count($cal1Events) == 0 && count($cal2Events) == 0) {
2298                 if (Tinebase_Core::isLogLevel(Zend_Log::DEBUG)) Tinebase_Core::getLogger()->debug(__METHOD__ . '::' . __LINE__
2299                         . ' No events found');
2300                 continue;
2301             }
2302     
2303             foreach ($cal1Events as $event) {
2304                 if (Tinebase_Core::isLogLevel(Zend_Log::DEBUG)) Tinebase_Core::getLogger()->debug(__METHOD__ . '::' . __LINE__
2305                     . ' Checking event "' . $event->summary . '" ' . $event->dtstart . ' - ' . $event->dtend);
2306                 
2307                 if ($event->container_id != $cal1) {
2308                     if (Tinebase_Core::isLogLevel(Zend_Log::DEBUG)) Tinebase_Core::getLogger()->debug(__METHOD__ . '::' . __LINE__
2309                             . ' Event is in another calendar - skip');
2310                     $cal1Events->removeRecord($event);
2311                     continue;
2312                 }
2313                 
2314                 $summaryMatch = $cal2Events->filter('summary', $event->summary);
2315                 if (count($summaryMatch) > 0) {
2316                     if (Tinebase_Core::isLogLevel(Zend_Log::DEBUG)) Tinebase_Core::getLogger()->debug(__METHOD__ . '::' . __LINE__
2317                         . " Found " . count($summaryMatch) . ' events with matching summaries');
2318                     
2319                     $dtStartMatch = $summaryMatch->filter('dtstart', $event->dtstart);
2320                     if (count($dtStartMatch) > 0) {
2321                         if (Tinebase_Core::isLogLevel(Zend_Log::DEBUG)) Tinebase_Core::getLogger()->debug(__METHOD__ . '::' . __LINE__
2322                             . " Found " . count($summaryMatch) . ' events with matching dtstarts and summaries');
2323                         
2324                         $matchingEvents->merge($dtStartMatch);
2325                         // remove from cal1+cal2
2326                         $cal1Events->removeRecord($event);
2327                         $cal2Events->removeRecords($dtStartMatch);
2328                         $cal2EventIdsAlreadyProcessed = array_merge($cal2EventIdsAlreadyProcessed, $dtStartMatch->getArrayOfIds());
2329                     } else {
2330                         $changedEvents->merge($summaryMatch);
2331                         $cal1Events->removeRecord($event);
2332                         $cal2Events->removeRecords($summaryMatch);
2333                         $cal2EventIdsAlreadyProcessed = array_merge($cal2EventIdsAlreadyProcessed, $summaryMatch->getArrayOfIds());
2334                     }
2335                 }
2336             }
2337             
2338             // add missing events
2339             if (Tinebase_Core::isLogLevel(Zend_Log::DEBUG)) Tinebase_Core::getLogger()->debug(__METHOD__ . '::' . __LINE__
2340                 . " Found " . count($cal1Events) . ' events missing in cal2');
2341             $missingEventsInCal2->merge($cal1Events);
2342             
2343             // compare cal2 -> cal1 and add events as missing from cal1 that we did not detect before
2344             foreach ($cal2EventsClone as $event) {
2345                 if (in_array($event->getId(), $cal2EventIdsAlreadyProcessed)) {
2346                     continue;
2347                 }
2348                 if ($event->container_id != $cal2) {
2349                     if (Tinebase_Core::isLogLevel(Zend_Log::DEBUG)) Tinebase_Core::getLogger()->debug(__METHOD__ . '::' . __LINE__
2350                             . ' Event is in another calendar - skip');
2351                     continue;
2352                 }
2353                 
2354                 $missingEventsInCal1->addRecord($event);
2355             }
2356         }
2357         
2358         $result = array(
2359             'matching'      => $matchingEvents,
2360             'changed'       => $changedEvents,
2361             'missingInCal1' => $missingEventsInCal1,
2362             'missingInCal2' => $missingEventsInCal2,
2363         );
2364         return $result;
2365     }
2366     
2367     protected function _getEventsForPeriodAndCalendar($calendarId, $from, $until)
2368     {
2369         $filter = new Calendar_Model_EventFilter(array(
2370             array('field' => 'period', 'operator' => 'within', 'value' =>
2371                 array("from" => $from, "until" => $until)
2372             ),
2373             array('field' => 'container_id', 'operator' => 'equals', 'value' => $calendarId),
2374         ));
2375     
2376         $events = Calendar_Controller_Event::getInstance()->search($filter);
2377         Calendar_Model_Rrule::mergeAndRemoveNonMatchingRecurrences($events, $filter);
2378         return $events;
2379     }
2380     
2381     /**
2382      * add calendar owner as attendee if not already set
2383      * 
2384      * @param string $calendarId
2385      * @param Tinebase_DateTime $from
2386      * @param Tinebase_DateTime $until
2387      * @param boolean $dry run
2388      * 
2389      * @return number of updated events
2390      */
2391     public function repairAttendee($calendarId, $from, $until, $dry = false)
2392     {
2393         $container = Tinebase_Container::getInstance()->getContainerById($calendarId);
2394         if ($container->type !== Tinebase_Model_Container::TYPE_PERSONAL) {
2395             throw new Calendar_Exception('Only allowed for personal containers!');
2396         }
2397         if ($container->owner_id !== Tinebase_Core::getUser()->getId()) {
2398             throw new Calendar_Exception('Only allowed for own containers!');
2399         }
2400         
2401         $updateCount = 0;
2402         while ($from->isEarlier($until)) {
2403             $endWeek = $from->getClone()->addWeek(1);
2404             
2405             if (Tinebase_Core::isLogLevel(Zend_Log::INFO)) Tinebase_Core::getLogger()->info(__METHOD__ . '::' . __LINE__
2406                     . ' Repairing period ' . $from . ' - ' . $endWeek);
2407             
2408             
2409             // TODO we need to detect events with DECLINED/DELETED attendee
2410             $events = $this->_getEventsForPeriodAndCalendar($calendarId, $from, $endWeek);
2411             
2412             $from->addWeek(1);
2413             
2414             if (count($events) == 0) {
2415                 if (Tinebase_Core::isLogLevel(Zend_Log::DEBUG)) Tinebase_Core::getLogger()->debug(__METHOD__ . '::' . __LINE__
2416                         . ' No events found');
2417                 continue;
2418             }
2419             
2420             foreach ($events as $event) {
2421                 // add attendee if not already set
2422                 if ($event->isRecurInstance()) {
2423                     // TODO get base event
2424                     if (Tinebase_Core::isLogLevel(Zend_Log::DEBUG)) Tinebase_Core::getLogger()->debug(__METHOD__ . '::' . __LINE__
2425                             . ' Skip recur instance ' . $event->toShortString());
2426                     continue;
2427                 }
2428                 
2429                 $ownAttender = Calendar_Model_Attender::getOwnAttender($event->attendee);
2430                 if (! $ownAttender) {
2431                     if (Tinebase_Core::isLogLevel(Zend_Log::DEBUG)) Tinebase_Core::getLogger()->debug(__METHOD__ . '::' . __LINE__
2432                             . ' Add missing attender to event ' . $event->toShortString());
2433                     
2434                     $attender = new Calendar_Model_Attender(array(
2435                         'user_type' => Calendar_Model_Attender::USERTYPE_USER,
2436                         'user_id'   => Tinebase_Core::getUser()->contact_id,
2437                         'status'    => Calendar_Model_Attender::STATUS_ACCEPTED
2438                     ));
2439                     $event->attendee->addRecord($attender);
2440                     if (! $dry) {
2441                         $this->update($event);
2442                     }
2443                     $updateCount++;
2444                 }
2445             }
2446         }
2447         
2448         return $updateCount;
2449     }
2450 }