removes merge conflicts in tine20/Courses/translations/de.po
[tine20] / tine20 / Calendar / Backend / Sql.php
1 <?php
2 /**
3  * Sql Calendar 
4  * 
5  * @package     Calendar
6  * @subpackage  Backend
7  * @license     http://www.gnu.org/licenses/agpl.html AGPL Version 3
8  * @author      Cornelius Weiss <c.weiss@metaways.de>
9  * @copyright   Copyright (c) 2010-2013 Metaways Infosystems GmbH (http://www.metaways.de)
10  */
11
12 /**
13  * Native tine 2.0 events sql backend
14  *
15  * Events consists of the properties of Calendar_Model_Event except Tags and Notes 
16  * which are as always handles by their controllers/backends
17  * 
18  * @TODO rework fetch handling. all fetch operations should be based on search.
19  *       remove old grant sql when done
20  * 
21  * @package     Calendar 
22  * @subpackage  Backend
23  */
24 class Calendar_Backend_Sql extends Tinebase_Backend_Sql_Abstract
25 {
26     /**
27      * Table name without prefix
28      *
29      * @var string
30      */
31     protected $_tableName = 'cal_events';
32     
33     /**
34      * Model name
35      *
36      * @var string
37      */
38     protected $_modelName = 'Calendar_Model_Event';
39     
40     /**
41      * if modlog is active, we add 'is_deleted = 0' to select object in _getSelect()
42      *
43      * @var boolean
44      */
45     protected $_modlogActive = TRUE;
46     
47     /**
48      * attendee backend
49      * 
50      * @var Calendar_Backend_Sql_Attendee
51      */
52     protected $_attendeeBackend = NULL;
53     
54     /**
55      * list of record based grants
56      */
57     protected $_recordBasedGrants = array(
58         Tinebase_Model_Grants::GRANT_FREEBUSY,
59         Tinebase_Model_Grants::GRANT_READ, 
60         Tinebase_Model_Grants::GRANT_SYNC, 
61         Tinebase_Model_Grants::GRANT_EXPORT, 
62         Tinebase_Model_Grants::GRANT_EDIT, 
63         Tinebase_Model_Grants::GRANT_DELETE, 
64         Tinebase_Model_Grants::GRANT_PRIVATE,
65     );
66     
67     /**
68      * the constructor
69      *
70      * @param Zend_Db_Adapter_Abstract $_db optional
71      * @param array $_options (optional)
72      */
73     public function __construct ($_dbAdapter = NULL, $_options = array())
74     {
75         parent::__construct($_dbAdapter, $_options);
76         
77         $this->_attendeeBackend = new Calendar_Backend_Sql_Attendee($_dbAdapter);
78     }
79     
80     /**
81      * Creates new entry
82      *
83      * @param   Tinebase_Record_Interface $_record
84      * @return  Tinebase_Record_Interface
85      * @throws  Tinebase_Exception_InvalidArgument
86      * @throws  Tinebase_Exception_UnexpectedValue
87      */
88     public function create(Tinebase_Record_Interface $_record) 
89     {
90         
91         if ($_record->rrule) {
92             $_record->rrule = (string) $_record->rrule;
93         }
94         $_record->rrule   = !empty($_record->rrule)   ? $_record->rrule   : NULL;
95         $_record->recurid = !empty($_record->recurid) ? $_record->recurid : NULL;
96         
97         $event = parent::create($_record);
98         $this->_saveExdates($_record);
99         //$this->_saveAttendee($_record);
100         
101         return $this->get($event->getId());
102     }
103     
104     /**
105      * Gets one entry (by property)
106      *
107      * @param  mixed  $_value
108      * @param  string $_property
109      * @param  bool   $_getDeleted
110      * @return Tinebase_Record_Interface
111      * @throws Tinebase_Exception_NotFound
112      */
113     public function getByProperty($_value, $_property = 'name', $_getDeleted = FALSE) 
114     {
115         //$pagination = new Tinebase_Model_Pagination(array('limit' => 1));
116         $filters = new Calendar_Model_EventFilter();
117         
118         $filter = new Tinebase_Model_Filter_Text($_property, 'equals', $_value);
119         $filters->addFilter($filter);
120
121         if ($_getDeleted) {
122             $deletedFilter = new Tinebase_Model_Filter_Bool('is_deleted', 'equals', Tinebase_Model_Filter_Bool::VALUE_NOTSET);
123             $filters->addFilter($deletedFilter);
124         }
125
126         $resultSet = $this->search($filters, NULL, FALSE);
127         
128         switch (count($resultSet)) {
129             case 0: 
130                 throw new Tinebase_Exception_NotFound($this->_modelName . " record with $_property " . $_value . ' not found!');
131                 break;
132             case 1: 
133                 $result = $resultSet->getFirstRecord();
134                 break;
135             default:
136                 throw new Tinebase_Exception_UnexpectedValue(' in total ' . count($resultSet) . ' where found. But only one should!');
137         }
138         
139         return $result;
140     }
141     
142     /**
143      * Calendar optimized search function
144      * 
145      * 1. get all events neglecting grants filter
146      * 2. get all related container grants (via resolveing)
147      * 3. compute effective grants in PHP and only keep events 
148      *    user has required grant for
149      * 
150      * @TODO rethink if an outer container filter could help
151      *
152      * @param  Tinebase_Model_Filter_FilterGroup    $_filter
153      * @param  Tinebase_Model_Pagination            $_pagination
154      * @param  boolean                              $_onlyIds
155      * @return Tinebase_Record_RecordSet|array
156      */
157     public function search(Tinebase_Model_Filter_FilterGroup $_filter = NULL, Tinebase_Model_Pagination $_pagination = NULL, $_onlyIds = FALSE)
158     {
159         if (Tinebase_Core::isLogLevel(Zend_Log::TRACE)) Tinebase_Core::getLogger()->trace(__METHOD__ . '::' . __LINE__ . ' Searching events ...');
160         
161         if ($_pagination === NULL) {
162             $_pagination = new Tinebase_Model_Pagination();
163         }
164
165         $getDeleted = !!$_filter && $_filter->getFilter('is_deleted');
166         $select = parent::_getSelect('*', $getDeleted);
167         
168         $select->joinLeft(
169             /* table  */ array('exdate' => $this->_tablePrefix . 'cal_exdate'),
170             /* on     */ $this->_db->quoteIdentifier('exdate.cal_event_id') . ' = ' . $this->_db->quoteIdentifier($this->_tableName . '.id'),
171             /* select */ array('exdate' => $this->_dbCommand->getAggregate('exdate.exdate')));
172         
173         // NOTE: we join here as attendee and role filters need it
174         $select->joinLeft(
175             /* table  */ array('attendee' => $this->_tablePrefix . 'cal_attendee'),
176             /* on     */ $this->_db->quoteIdentifier('attendee.cal_event_id') . ' = ' . $this->_db->quoteIdentifier('cal_events.id'),
177             /* select */ array());
178         
179         if (! $getDeleted) {
180             $select->joinLeft(
181                 /* table  */ array('dispcontainer' => $this->_tablePrefix . 'container'), 
182                 /* on     */ $this->_db->quoteIdentifier('dispcontainer.id') . ' = ' . $this->_db->quoteIdentifier('attendee.displaycontainer_id'),
183                 /* select */ array());
184             
185             $select->where($this->_db->quoteIdentifier('dispcontainer.is_deleted') . ' = 0 OR ' . $this->_db->quoteIdentifier('dispcontainer.is_deleted') . 'IS NULL');
186         }
187         
188         // remove grantsfilter here as we do grants computation in PHP
189         $grantsFilter = $_filter->getFilter('grants');
190         if ($grantsFilter) {
191             $_filter->removeFilter('grants');
192         }
193         
194         // clonde the filter, as the filter is also used in the json frontend
195         // and the calendarfilter is used in the UI to
196         $clonedFilters = clone $_filter;
197         
198         $calendarFilter = null;
199         foreach ($clonedFilters as $filter) {
200             if ($filter instanceof Calendar_Model_CalendarFilter) {
201                 $calendarFilter = $filter;
202                 $clonedFilters->removeFilter($filter);
203                 break;
204             }
205         }
206         
207         $this->_addFilter($select, $clonedFilters);
208         
209         $select->group($this->_tableName . '.' . 'id');
210         Tinebase_Backend_Sql_Abstract::traitGroup($select);
211         
212         $period = $_filter->getFilter('period');
213
214         // filter out unnecessary YEARLY candidates for web client requests
215         // periods < 40 days should be client web client requests.
216         if ($period && $period->getFrom()->getClone()->addDay(40) > $period->getUntil()) {
217             $this->_removeNonMatchingBaseEvents($select, $period);
218         }
219         
220         if ($calendarFilter) {
221             $select1 = clone $select;
222             $select2 = clone $select;
223             
224             $calendarFilter->appendFilterSql1($select1, $this);
225             $calendarFilter->appendFilterSql2($select2, $this);
226             
227             $select = $this->getAdapter()->select()->union(array(
228                 $select1,
229                 $select2
230             ));
231         }
232         
233         $_pagination->appendPaginationSql($select);
234         
235         $stmt = $this->_db->query($select);
236         $rows = (array)$stmt->fetchAll(Zend_Db::FETCH_ASSOC);
237         
238         if (Tinebase_Core::isLogLevel(Zend_Log::TRACE)) Tinebase_Core::getLogger()->trace(__METHOD__ . '::' . __LINE__
239                 . ' Event base rows fetched: ' . count($rows) . ' select: ' . $select);
240         
241         $result = $this->_rawDataToRecordSet($rows);
242         
243         $this->_checkGrants($result, $grantsFilter);
244         
245         return $_onlyIds ? $result->{is_bool($_onlyIds) ? $this->_getRecordIdentifier() : $_onlyIds} : $result;
246     }
247     
248     /**
249      * removes non-matching rrule base events
250      * 
251      * @param Zend_Db_Select $select
252      * @param Calendar_Model_PeriodFilter $period
253      * 
254      * TODO improve this by moving the rrules to a separate table to simplify SQL statment
255      */
256     protected function _removeNonMatchingBaseEvents($select, $period)
257     {
258         $gs = new Tinebase_Backend_Sql_Filter_GroupSelect($select);
259         $from = $period->getFrom()->getClone()->subDay(1);
260         $fromMonth = $from->format('n');
261         $fromDay = $from->format('j');
262         $until = $period->getUntil()->getClone()->addDay(1);
263         $untilMonth = $until->format('n');
264         $untilDay = $until->format('j');
265         $quotedRrule = $this->_db->quoteIdentifier('rrule');
266         
267         $gs->where($quotedRrule . ' NOT LIKE ?', 'FREQ=YEARLY%')
268         ->orWhere($quotedRrule . ' IS NULL');
269         
270         if ($fromMonth == $untilMonth && $untilDay-$fromDay <= 10) {
271             // day|week view
272             for($day=$fromDay; $day<=$untilDay; $day++) {
273                 $gs->orWhere($quotedRrule . ' LIKE ?', "FREQ=YEARLY;INTERVAL=1;BYMONTH={$fromMonth};BYMONTHDAY={$day}%");
274             }
275         } else {
276             // monthview
277             for ($month=$fromMonth; $month<=$untilMonth; $month++) {
278                 $gs->orWhere($quotedRrule . ' LIKE ?', "FREQ=YEARLY;INTERVAL=1;BYMONTH={$month};%");
279             }
280         }
281         
282         $gs->appendWhere(Zend_Db_Select::SQL_AND);
283         //            Tinebase_Core::getLogger()->ERR($select);
284     }
285     
286     /**
287      * calculate event permissions and remove events that don't match
288      * 
289      * @param  Tinebase_Record_RecordSet        $events
290      * @param  Tinebase_Model_Filter_AclFilter  $grantsFilter
291      */
292     protected function _checkGrants($events, $grantsFilter)
293     {
294         $currentContact    = Tinebase_Core::getUser()->contact_id;
295         $containerGrants   = Tinebase_Container::getInstance()->getContainerGrantsOfRecords($events, Tinebase_Core::getUser());
296         $resolvedAttendees = Calendar_Model_Attender::getResolvedAttendees($events->attendee, true);
297         
298         $toRemove          = array();
299         $inheritableGrants = array(
300             Tinebase_Model_Grants::GRANT_FREEBUSY,
301             Tinebase_Model_Grants::GRANT_READ,
302             Tinebase_Model_Grants::GRANT_SYNC,
303             Tinebase_Model_Grants::GRANT_EXPORT,
304             Tinebase_Model_Grants::GRANT_PRIVATE,
305         );
306         
307         if ($grantsFilter instanceof Calendar_Model_GrantFilter) {
308             $requiredGrants = array_intersect($grantsFilter->getRequiredGrants(), $this->_recordBasedGrants);
309         }
310         
311         foreach ($events as $event) {
312             $containerId = $event->container_id instanceof Tinebase_Model_Container
313                 ? $event->container_id->getId()
314                 : $event->container_id;
315             
316             // either current user is organizer or has admin right on container
317             if (   $event->organizer === $currentContact
318                 || (isset($containerGrants[$containerId]) && $containerGrants[$containerId]->account_grants[Tinebase_Model_Grants::GRANT_ADMIN])
319             ) {
320                 foreach ($this->_recordBasedGrants as $grant) {
321                     $event->{$grant} = true;
322                 }
323                 
324                 // has all rights => no need to filter
325                 continue;
326             }
327             
328             // grants to original container
329             if (isset($containerGrants[$containerId])) {
330                 foreach ($this->_recordBasedGrants as $grant) {
331                     $event->{$grant} = $containerGrants[$containerId]->account_grants[$grant];
332                 }
333             }
334             
335             // check grant inheritance
336             if ($event->attendee instanceof Tinebase_Record_RecordSet) {
337                 foreach ($inheritableGrants as $grant) {
338                     if (! $event->{$grant}) {
339                         foreach ($event->attendee as $attendee) {
340                             $attendee = $resolvedAttendees->getById($attendee->getId());
341                             
342                             if (!$attendee) {
343                                 continue;
344                             }
345                             
346                             if (   $attendee->displaycontainer_id instanceof Tinebase_Model_Container
347                                 && $attendee->displaycontainer_id->account_grants 
348                                 && (    $attendee->displaycontainer_id->account_grants[$grant]
349                                      || $attendee->displaycontainer_id->account_grants[Tinebase_Model_Grants::GRANT_ADMIN]
350                                    )
351                             ) {
352                                 $event->{$grant} = true;
353                                 break;
354                             }
355                         }
356                     }
357                 }
358             }
359             
360             // check if one of the grants is set ...
361             if (isset($requiredGrants)) {
362                 foreach ($requiredGrants as $requiredGrant) {
363                     if ($event->{$requiredGrant}) {
364                         continue 2;
365                     }
366                 }
367                 
368                 // ... otherwise mark for removal
369                 $toRemove[] = $event;
370             }
371         }
372         
373         // remove records with non matching grants
374         foreach ($toRemove as $event) {
375             $events->removeRecord($event);
376         }
377     }
378     
379     /**
380      * get the basic select object to fetch records from the database
381      *  
382      * @param array|string|Zend_Db_Expr $_cols columns to get, * per default
383      * @param boolean $_getDeleted get deleted records (if modlog is active)
384      * @return Zend_Db_Select
385      */
386     protected function _getSelectSimple($_cols = '*', $_getDeleted = FALSE)
387     {
388         $select = $this->_db->select();
389
390         $select->from(array($this->_tableName => $this->_tablePrefix . $this->_tableName), $_cols);
391         
392         if (!$_getDeleted && $this->_modlogActive) {
393             // don't fetch deleted objects
394             $select->where($this->_db->quoteIdentifier($this->_tableName . '.is_deleted') . ' = 0');
395         }
396         
397         return $select;
398     }
399     
400     /**
401      * Gets total count of search with $_filter
402      * 
403      * @param Tinebase_Model_Filter_FilterGroup $_filter
404      * @return int
405      */
406     public function searchCount(Tinebase_Model_Filter_FilterGroup $_filter)
407     {
408         $select = $this->_getSelect(array('count' => 'COUNT(*)'));
409         $this->_addFilter($select, $_filter);
410
411         $result = $this->_db->fetchOne($select);
412         
413         return $result;
414     }
415     
416     /**
417      * Updates existing entry
418      *
419      * @param Tinebase_Record_Interface $_record
420      * @throws Tinebase_Exception_Record_Validation|Tinebase_Exception_InvalidArgument
421      * @return Tinebase_Record_Interface Record|NULL
422      */
423     public function update(Tinebase_Record_Interface $_record) 
424     {
425         if ($_record->rrule) {
426             $_record->rrule = (string) $_record->rrule;
427         }
428         
429         if ($_record->container_id instanceof Tinebase_Model_Container) {
430             $_record->container_id = $_record->container_id->getId();
431         }
432         
433         $_record->rrule   = !empty($_record->rrule)   ? $_record->rrule   : NULL;
434         $_record->recurid = !empty($_record->recurid) ? $_record->recurid : NULL;
435         
436         $event = parent::update($_record);
437         $this->_saveExdates($_record);
438         
439         return $this->get($event->getId(), TRUE);
440     }
441     
442     /**
443      * get the basic select object to fetch records from the database
444      *  
445      * @param array|string|Zend_Db_Expr $_cols columns to get, * per default
446      * @param boolean $_getDeleted get deleted records (if modlog is active)
447      * @return Zend_Db_Select
448      */
449     protected function _getSelect($_cols = '*', $_getDeleted = FALSE)
450     {
451         $select = $this->_getSelectSimple();
452
453         $this->_appendEffectiveGrantCalculationSql($select);
454         
455         $select->joinLeft(
456             /* table  */ array('exdate' => $this->_tablePrefix . 'cal_exdate'), 
457             /* on     */ $this->_db->quoteIdentifier('exdate.cal_event_id') . ' = ' . $this->_db->quoteIdentifier($this->_tableName . '.id'),
458             /* select */ array('exdate' => $this->_dbCommand->getAggregate('exdate.exdate')));
459         
460         $select->group($this->_tableName . '.' . 'id');
461         
462         return $select;
463     }
464     
465     /**
466      * appends effective grant calculation to select object
467      *
468      * @param Zend_Db_Select $_select
469      */
470     protected function _appendEffectiveGrantCalculationSql($_select, $_attendeeFilters = NULL)
471     {
472         // groupmemberships of current user, needed to compute phys and inherited grants
473         $_select->joinLeft(
474             /* table  */ array('groupmemberships' => $this->_tablePrefix . 'group_members'), 
475             /* on     */ $this->_db->quoteInto($this->_db->quoteIdentifier('groupmemberships.account_id') . ' = ?' , Tinebase_Core::getUser()->getId()),
476             /* select */ array());
477         
478         // attendee joins the attendee we need to compute the curr users effective grants
479         // NOTE: 2010-04 the behaviour changed. Now, only the attendee the client filters for are 
480         //       taken into account for grants calculation 
481         $attendeeWhere = FALSE;
482         if (is_array($_attendeeFilters) && !empty($_attendeeFilters)) {
483             $attendeeSelect = $this->_db->select();
484             foreach ((array) $_attendeeFilters as $attendeeFilter) {
485                 if ($attendeeFilter instanceof Calendar_Model_AttenderFilter) {
486                     $attendeeFilter->appendFilterSql($attendeeSelect, $this);
487                 }
488             }
489             
490             $whereArray = $attendeeSelect->getPart(Zend_Db_Select::SQL_WHERE);
491             if (! empty($whereArray)) {
492                 $attendeeWhere = ' AND ' . Tinebase_Helper::array_value(0, $whereArray);
493             }
494         }
495         
496         $_select->joinLeft(
497             /* table  */ array('attendee' => $this->_tablePrefix . 'cal_attendee'),
498             /* on     */ $this->_db->quoteIdentifier('attendee.cal_event_id') . ' = ' . $this->_db->quoteIdentifier('cal_events.id') . 
499                             $attendeeWhere,
500             /* select */ array());
501         
502
503             
504         $_select->joinLeft(
505             /* table  */ array('attendeeaccounts' => $this->_tablePrefix . 'accounts'), 
506             /* on     */ $this->_db->quoteIdentifier('attendeeaccounts.contact_id') . ' = ' . $this->_db->quoteIdentifier('attendee.user_id') . ' AND (' . 
507                             $this->_db->quoteInto($this->_db->quoteIdentifier('attendee.user_type') . '= ?', Calendar_Model_Attender::USERTYPE_USER) . ' OR ' .
508                             $this->_db->quoteInto($this->_db->quoteIdentifier('attendee.user_type') . '= ?', Calendar_Model_Attender::USERTYPE_GROUPMEMBER) . 
509                         ')',
510             /* select */ array());
511         
512         $_select->joinLeft(
513             /* table  */ array('attendeegroupmemberships' => $this->_tablePrefix . 'group_members'), 
514             /* on     */ $this->_db->quoteIdentifier('attendeegroupmemberships.account_id') . ' = ' . $this->_db->quoteIdentifier('attendeeaccounts.contact_id'),
515             /* select */ array());
516         
517
518         
519         $_select->joinLeft(
520             /* table  */ array('dispgrants' => $this->_tablePrefix . 'container_acl'), 
521             /* on     */ $this->_db->quoteIdentifier('dispgrants.container_id') . ' = ' . $this->_db->quoteIdentifier('attendee.displaycontainer_id') . 
522                            ' AND ' . $this->_getContainGrantCondition('dispgrants', 'groupmemberships'),
523             /* select */ array());
524         
525         $_select->joinLeft(
526             /* table  */ array('physgrants' => $this->_tablePrefix . 'container_acl'), 
527             /* on     */ $this->_db->quoteIdentifier('physgrants.container_id') . ' = ' . $this->_db->quoteIdentifier('cal_events.container_id'),
528             /* select */ array());
529         
530         $allGrants = Tinebase_Model_Grants::getAllGrants();
531         
532         foreach ($allGrants as $grant) {
533             if (in_array($grant, $this->_recordBasedGrants)) {
534                 $_select->columns(array($grant => "\n MAX( CASE WHEN ( \n" .
535                     '  /* physgrant */' . $this->_getContainGrantCondition('physgrants', 'groupmemberships', $grant) . " OR \n" . 
536                     '  /* implicit  */' . $this->_getImplicitGrantCondition($grant) . " OR \n" .
537                     '  /* inherited */' . $this->_getInheritedGrantCondition($grant) . " \n" .
538                  ") THEN 1 ELSE 0 END ) "));
539             } else {
540                 $_select->columns(array($grant => "\n MAX( CASE WHEN ( \n" .
541                     '  /* physgrant */' . $this->_getContainGrantCondition('physgrants', 'groupmemberships', $grant) . "\n" .
542                 ") THEN 1 ELSE 0 END ) "));
543             }
544         }
545     }
546     
547     /**
548      * returns SQL with container grant condition 
549      *
550      * @param  string                               $_aclTableName
551      * @param  string                               $_groupMembersTableName
552      * @param  string|array                         $_requiredGrant (defaults none)
553      * @param  Zend_Db_Expr|int|Tinebase_Model_User $_user (defaults current user)
554      * @return string
555      */
556     protected function _getContainGrantCondition($_aclTableName, $_groupMembersTableName, $_requiredGrant=NULL, $_user=NULL )
557     {
558         $quoteTypeIdentifier = $this->_db->quoteIdentifier($_aclTableName . '.account_type');
559         $quoteIdIdentifier = $this->_db->quoteIdentifier($_aclTableName . '.account_id');
560         
561         if ($_user instanceof Zend_Db_Expr) {
562             $userExpression = $_user;
563         } else {
564             $accountId = $_user ? Tinebase_Model_User::convertUserIdToInt($_user) : Tinebase_Core::getUser()->getId();
565             $userExpression = new Zend_Db_Expr($this->_db->quote($accountId));
566         }
567         
568         $sql = $this->_db->quoteInto(    "($quoteTypeIdentifier = ?", Tinebase_Acl_Rights::ACCOUNT_TYPE_USER)  . " AND $quoteIdIdentifier = $userExpression)" .
569                $this->_db->quoteInto(" OR ($quoteTypeIdentifier = ?", Tinebase_Acl_Rights::ACCOUNT_TYPE_GROUP) . ' AND ' . $this->_db->quoteIdentifier("$_groupMembersTableName.group_id") . " = $quoteIdIdentifier" . ')' . 
570                $this->_db->quoteInto(" OR ($quoteTypeIdentifier = ?)", Tinebase_Acl_Rights::ACCOUNT_TYPE_ANYONE);
571         
572         if ($_requiredGrant) {
573             $sql = "($sql) AND " . $this->_db->quoteInto($this->_db->quoteIdentifier($_aclTableName . '.account_grant') . ' IN (?)', (array)$_requiredGrant);
574             
575         }
576         
577         return "($sql)";
578     }
579     
580     /**
581      * returns SQL condition for implicit grants
582      *
583      * @param  string               $_requiredGrant
584      * @param  Tinebase_Model_User  $_user (defaults to current user)
585      * @return string
586      */
587     protected function _getImplicitGrantCondition($_requiredGrant, $_user=NULL)
588     {
589         $accountId = $_user ? $_user->getId() : Tinebase_Core::getUser()->getId();
590         $contactId = $_user ? $_user->contact_id : Tinebase_Core::getUser()->contact_id;
591         
592         // delte grant couldn't be gained implicitly
593         if ($_requiredGrant == Tinebase_Model_Grants::GRANT_DELETE) {
594             return '1=0';
595         }
596         
597         // organizer gets all other grants implicitly
598         $sql = $this->_db->quoteIdentifier('cal_events.organizer') . " = " . $this->_db->quote($contactId);
599         
600         // attendee get read, sync, export and private grants implicitly
601         if (in_array($_requiredGrant, array(Tinebase_Model_Grants::GRANT_READ, Tinebase_Model_Grants::GRANT_SYNC, Tinebase_Model_Grants::GRANT_EXPORT, Tinebase_Model_Grants::GRANT_PRIVATE))) {
602             $readCond = $this->_db->quoteIdentifier('attendeeaccounts.id') . ' = ' . $this->_db->quote($accountId) . ' AND (' .
603                 $this->_db->quoteInto($this->_db->quoteIdentifier('attendee.user_type') . ' = ?', Calendar_Model_Attender::USERTYPE_USER) . ' OR ' .
604                 $this->_db->quoteInto($this->_db->quoteIdentifier('attendee.user_type') . ' = ?', Calendar_Model_Attender::USERTYPE_GROUPMEMBER) .
605             ')';
606             
607             $sql = "($sql) OR ($readCond)";
608         }
609         
610         return "($sql)";
611     }
612     
613     /**
614      * returns SQL for inherited grants
615      *
616      * @param  string $_requiredGrant
617      * @return string
618      */
619     protected function _getInheritedGrantCondition($_requiredGrant)
620     {
621         // current user needs to have grant on display calendar
622         $sql = $this->_getContainGrantCondition('dispgrants', 'groupmemberships', $_requiredGrant);
623         
624         // _AND_ attender(admin) of display calendar needs to have grant on phys calendar
625         // @todo include implicit inherited grants
626         if (! in_array($_requiredGrant, array(Tinebase_Model_Grants::GRANT_READ, Tinebase_Model_Grants::GRANT_FREEBUSY))) {
627             $userExpr = new Zend_Db_Expr($this->_db->quoteIdentifier('attendeeaccounts.id'));
628             
629             $attenderPhysGrantCond = $this->_getContainGrantCondition('physgrants', 'attendeegroupmemberships', $_requiredGrant, $userExpr);
630             // NOTE: this condition is weak! Not some attendee must have implicit grant.
631             //       -> an attender we have reqired grants for his diplay cal must have implicit grants
632             //$attenderImplicitGrantCond = $this->_getImplicitGrantCondition($_requiredGrant, $userExpr);
633             
634             //$sql = "($sql) AND ($attenderPhysGrantCond) OR ($attenderImplicitGrantCond)";
635             $sql = "($sql) AND ($attenderPhysGrantCond)";
636         }
637         
638         return "($sql)";
639     }
640     
641     /**
642      * converts raw data from adapter into a single record
643      *
644      * @param  array $_data
645      * @return Tinebase_Record_Abstract
646      */
647     protected function _rawDataToRecord(array $_rawData) {
648         $event = parent::_rawDataToRecord($_rawData);
649         
650         $this->appendForeignRecordSetToRecord($event, 'attendee', 'id', Calendar_Backend_Sql_Attendee::FOREIGNKEY_EVENT, $this->_attendeeBackend);
651         
652         return $event;
653     }
654     
655     /**
656      * converts raw data from adapter into a set of records
657      *
658      * @param  array $_rawData of arrays
659      * @return Tinebase_Record_RecordSet
660      */
661     protected function _rawDataToRecordSet(array $_rawData)
662     {
663         $events = new Tinebase_Record_RecordSet($this->_modelName);
664         $events->addIndices(array('rrule', 'recurid'));
665         
666         foreach ($_rawData as $rawEvent) {
667             $events->addRecord(new Calendar_Model_Event($rawEvent, true));
668         }
669         
670         $this->appendForeignRecordSetToRecordSet($events, 'attendee', 'id', Calendar_Backend_Sql_Attendee::FOREIGNKEY_EVENT, $this->_attendeeBackend);
671         
672         return $events;
673     }
674     
675     /**
676      * saves exdates of an event
677      *
678      * @param Calendar_Model_Event $_event
679      */
680     protected function _saveExdates($_event)
681     {
682         $this->_db->delete($this->_tablePrefix . 'cal_exdate', $this->_db->quoteInto($this->_db->quoteIdentifier('cal_event_id') . '= ?', $_event->getId()));
683         
684         // only save exdates if its an recurring event
685         if (! empty($_event->rrule)) {
686             foreach ((array)$_event->exdate as $exdate) {
687                 if (is_object($exdate)) {
688                     $this->_db->insert($this->_tablePrefix . 'cal_exdate', array(
689                         'id'           => $_event->generateUID(),
690                         'cal_event_id' => $_event->getId(),
691                         'exdate'       => $exdate->get(Tinebase_Record_Abstract::ISO8601LONG)
692                     ));
693                 } else {
694                     if (Tinebase_Core::isLogLevel(Zend_Log::WARN)) Tinebase_Core::getLogger()->warn(__METHOD__ . '::' . __LINE__ 
695                        . ' Exdate needs to be an object:' . var_export($exdate, TRUE));
696                 }
697             }
698         }
699     }
700     
701     /**
702      * saves attendee of given event
703      * 
704      * @param Calendar_Model_Evnet $_event
705      *
706     protected function _saveAttendee($_event)
707     {
708         $attendee = $_event->attendee instanceof Tinebase_Record_RecordSet ? 
709             $_event->attendee : 
710             new Tinebase_Record_RecordSet($this->_attendeeBackend->getModelName());
711         $attendee->cal_event_id = $_event->getId();
712             
713         $currentAttendee = $this->_attendeeBackend->getMultipleByProperty($_event->getId(), Calendar_Backend_Sql_Attendee::FOREIGNKEY_EVENT);
714         
715         $diff = $currentAttendee->getMigration($attendee->getArrayOfIds());
716         $this->_attendeeBackend->delete($diff['toDeleteIds']);
717         
718         foreach ($attendee as $attende) {
719             $method = $attende->getId() ? 'update' : 'create';
720             $this->_attendeeBackend->$method($attende);
721         }
722     }
723     */
724     
725     /****************************** attendee functions ************************/
726     
727     /**
728      * gets attendee of a given event
729      *
730      * @param Calendar_Model_Event $_event
731      * @return Tinebase_Record_RecordSet
732      */
733     public function getEventAttendee(Calendar_Model_Event $_event)
734     {
735         $attendee = $this->_attendeeBackend->getMultipleByProperty($_event->getId(), Calendar_Backend_Sql_Attendee::FOREIGNKEY_EVENT);
736         
737         return $attendee;
738     }
739     
740     /**
741      * creates given attender in database
742      *
743      * @param Calendar_Model_Attender $_attendee
744      * @return Calendar_Model_Attender
745      */
746     public function createAttendee(Calendar_Model_Attender $_attendee)
747     {
748         if ($_attendee->user_id instanceof Addressbook_Model_Contact) {
749             $_attendee->user_id = $_attendee->user_id->getId();
750         } else if ($_attendee->user_id instanceof Addressbook_Model_List) {
751             $_attendee->user_id = $_attendee->user_id->group_id;
752         }
753         
754         if ($_attendee->displaycontainer_id instanceof Tinebase_Model_Container) {
755             $_attendee->displaycontainer_id = $_attendee->displaycontainer_id->getId();
756         }
757         
758         return $this->_attendeeBackend->create($_attendee);
759     }
760     
761     /**
762      * updates given attender in database
763      *
764      * @param Calendar_Model_Attender $_attendee
765      * @return Calendar_Model_Attender
766      */
767     public function updateAttendee(Calendar_Model_Attender $_attendee)
768     {
769         if ($_attendee->user_id instanceof Addressbook_Model_Contact) {
770             $_attendee->user_id = $_attendee->user_id->getId();
771         } else if ($_attendee->user_id instanceof Addressbook_Model_List) {
772             $_attendee->user_id = $_attendee->user_id->group_id;
773         }
774         
775         if ($_attendee->displaycontainer_id instanceof Tinebase_Model_Container) {
776             $_attendee->displaycontainer_id = $_attendee->displaycontainer_id->getId();
777         }
778         
779         return $this->_attendeeBackend->update($_attendee);
780     }
781     
782     /**
783      * deletes given attender in database
784      *
785      * @param Calendar_Model_Attender $_attendee
786      * @return void
787      */
788     public function deleteAttendee(array $_ids)
789     {
790         return $this->_attendeeBackend->delete($_ids);
791     }
792
793     /**
794      * delete duplicate events defined by an event filter
795      * 
796      * @param Calendar_Model_EventFilter $filter
797      * @param boolean $dryrun
798      * @return integer number of deleted events
799      */
800     public function deleteDuplicateEvents($filter, $dryrun = TRUE)
801     {
802         if ($dryrun && Tinebase_Core::isLogLevel(Zend_Log::INFO)) Tinebase_Core::getLogger()->info(__METHOD__ . '::' . __LINE__ 
803             . ' - Running in dry run mode - using filter: ' . print_r($filter->toArray(), true));
804         
805         $duplicateFields = array('summary', 'dtstart', 'dtend');
806         
807         $select = $this->_db->select();
808         $select->from(array($this->_tableName => $this->_tablePrefix . $this->_tableName), $duplicateFields);
809         $select->where($this->_db->quoteIdentifier($this->_tableName . '.is_deleted') . ' = 0');
810             
811         $this->_addFilter($select, $filter);
812         
813         $select->group($duplicateFields)
814                ->having('count(*) > 1');
815         
816         if (Tinebase_Core::isLogLevel(Zend_Log::DEBUG)) Tinebase_Core::getLogger()->debug(__METHOD__ . '::' . __LINE__ 
817            . ' ' . $select);
818         
819         $rows = $this->_fetch($select, self::FETCH_ALL);
820         
821         if (Tinebase_Core::isLogLevel(Zend_Log::TRACE)) Tinebase_Core::getLogger()->trace(__METHOD__ . '::' . __LINE__ 
822            . ' ' . print_r($rows, TRUE));
823         
824         $toDelete = array();
825         foreach ($rows as $row) {
826             $index = $row['summary'] . ' / ' . $row['dtstart'] . ' - ' . $row['dtend'];
827             
828             $filter = new Calendar_Model_EventFilter(array(array(
829                 'field'    => 'summary',
830                 'operator' => 'equals',
831                 'value'    => $row['summary'],
832             ), array(
833                 'field'    => 'dtstart',
834                 'operator' => 'equals',
835                 'value'    => new Tinebase_DateTime($row['dtstart']),
836             ), array(
837                 'field'    => 'dtend',
838                 'operator' => 'equals',
839                 'value'    => new Tinebase_DateTime($row['dtend']),
840             )));
841             $pagination = new Tinebase_Model_Pagination(array('sort' => array($this->_tableName . '.last_modified_time', $this->_tableName . '.creation_time'))); 
842             
843             $select = $this->_db->select();
844             $select->from(array($this->_tableName => $this->_tablePrefix . $this->_tableName));
845             $select->where($this->_db->quoteIdentifier($this->_tableName . '.is_deleted') . ' = 0');
846             
847             $this->_addFilter($select, $filter);
848             $pagination->appendPaginationSql($select);
849             
850             $rows = $this->_fetch($select, self::FETCH_ALL);
851             $events = $this->_rawDataToRecordSet($rows);
852             
853             if (Tinebase_Core::isLogLevel(Zend_Log::TRACE)) Tinebase_Core::getLogger()->trace(__METHOD__ . '::' . __LINE__ 
854                 . ' ' . print_r($events->toArray(), TRUE));
855             
856             $deleteIds = $events->getArrayOfIds();
857             // keep the first
858             array_shift($deleteIds);
859             
860             if (! empty($deleteIds)) {
861                 $deleteContainerIds = ($events->container_id);
862                 $origContainer = array_shift($deleteContainerIds);
863                 if (Tinebase_Core::isLogLevel(Zend_Log::INFO)) Tinebase_Core::getLogger()->info(__METHOD__ . '::' . __LINE__ 
864                     . ' Deleting ' . count($deleteIds) . ' duplicates of: ' . $index . ' in container_ids ' . implode(',', $deleteContainerIds) . ' (origin container: ' . $origContainer . ')');
865                 if (Tinebase_Core::isLogLevel(Zend_Log::TRACE)) Tinebase_Core::getLogger()->trace(__METHOD__ . '::' . __LINE__ 
866                     . ' ' . print_r($deleteIds, TRUE));
867                 
868                 $toDelete = array_merge($toDelete, $deleteIds);
869             } else {
870                 if (Tinebase_Core::isLogLevel(Zend_Log::DEBUG)) Tinebase_Core::getLogger()->debug(__METHOD__ . '::' . __LINE__ 
871                    . ' No duplicates found for ' . $index);
872             }
873         }
874         
875         if (empty($toDelete)) {
876             if (Tinebase_Core::isLogLevel(Zend_Log::INFO)) Tinebase_Core::getLogger()->info(__METHOD__ . '::' . __LINE__ 
877                 . ' No duplicates found.');
878             $result = 0;
879         } else {
880             $result = ($dryrun) ? count($toDelete) : $this->delete($toDelete);
881         }
882         
883         return $result;
884     }
885     
886     /**
887      * repair dangling attendee records (no displaycontainer_id)
888      *
889      * @see https://forge.tine20.org/mantisbt/view.php?id=8172
890      */
891     public function repairDanglingDisplaycontainerEvents()
892     {
893         $filter = new Tinebase_Model_Filter_FilterGroup();
894         $filter->addFilter(new Tinebase_Model_Filter_Text(array(
895             'field'     => 'user_type',
896             'operator'  => 'in', 
897             'value'     => array(
898                 Calendar_Model_Attender::USERTYPE_USER,
899                 Calendar_Model_Attender::USERTYPE_GROUPMEMBER,
900                 Calendar_Model_Attender::USERTYPE_RESOURCE
901             )
902         )));
903         
904         $filter->addFilter(new Tinebase_Model_Filter_Text(array(
905             'field'     => 'displaycontainer_id',
906             'operator'  => 'isnull',
907             'value'     => null
908         )));
909         
910         $danglingAttendee = $this->_attendeeBackend->search($filter);
911         $danglingContactAttendee = $danglingAttendee->filter('user_type', '/'. Calendar_Model_Attender::USERTYPE_USER . '|'. Calendar_Model_Attender::USERTYPE_GROUPMEMBER .'/', TRUE);
912         $danglingContactIds = array_unique($danglingContactAttendee->user_id);
913         $danglingContacts = Addressbook_Controller_Contact::getInstance()->getMultiple($danglingContactIds, TRUE);
914         $danglingResourceAttendee = $danglingAttendee->filter('user_type', Calendar_Model_Attender::USERTYPE_RESOURCE);
915         $danglingResourceIds =  array_unique($danglingResourceAttendee->user_id);
916         Calendar_Controller_Resource::getInstance()->doContainerACLChecks(false);
917         $danglingResources = Calendar_Controller_Resource::getInstance()->getMultiple($danglingResourceIds, TRUE);
918         
919         if (Tinebase_Core::isLogLevel(Zend_Log::DEBUG)) Tinebase_Core::getLogger()->debug(__METHOD__ . '::' . __LINE__ 
920             . ' Processing ' . count($danglingContactIds) . ' dangling contact ids...');
921         
922         foreach ($danglingContactIds as $danglingContactId) {
923             $danglingContact = $danglingContacts->getById($danglingContactId);
924             if ($danglingContact && $danglingContact->account_id) {
925                 
926                 if (Tinebase_Core::isLogLevel(Zend_Log::DEBUG)) Tinebase_Core::getLogger()->debug(__METHOD__ . '::' . __LINE__ 
927                     . ' Get default display container for account ' . $danglingContact->account_id);
928                 if (Tinebase_Core::isLogLevel(Zend_Log::TRACE)) Tinebase_Core::getLogger()->trace(__METHOD__ . '::' . __LINE__ 
929                     . ' ' . print_r($danglingContact->toArray(), true));
930                 
931                 $displayCalId = Calendar_Controller_Event::getDefaultDisplayContainerId($danglingContact->account_id);
932                 if ($displayCalId) {
933                     // finaly repair attendee records
934                     $attendeeRecords = $danglingContactAttendee->filter('user_id', $danglingContactId);
935                     $this->_attendeeBackend->updateMultiple($attendeeRecords->getId(), array('displaycontainer_id' => $displayCalId));
936                     Tinebase_Core::getLogger()->NOTICE(__METHOD__ . '::' . __LINE__ . " repaired the following contact attendee " . print_r($attendeeRecords->toArray(), TRUE));
937                 }
938             }
939         }
940         
941         if (Tinebase_Core::isLogLevel(Zend_Log::DEBUG)) Tinebase_Core::getLogger()->debug(__METHOD__ . '::' . __LINE__ 
942             . ' Processing ' . count($danglingResourceIds) . ' dangling resource ids...');
943         
944         foreach ($danglingResourceIds as $danglingResourceId) {
945             $resource = $danglingResources->getById($danglingResourceId);
946             if ($resource && $resource->container_id) {
947                 $displayCalId = $resource->container_id;
948                 $attendeeRecords = $danglingResourceAttendee->filter('user_id', $danglingResourceId);
949                 $this->_attendeeBackend->updateMultiple($attendeeRecords->getId(), array('displaycontainer_id' => $displayCalId));
950                 Tinebase_Core::getLogger()->NOTICE(__METHOD__ . '::' . __LINE__ . " repaired the following resource attendee " . print_r($attendeeRecords->toArray(), TRUE));
951             }
952         }
953     }
954 }