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