08577d7fb9ee96fddddeca02ede21e151373bb0e
[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 $result
290      * @param Tinebase_Model_Filter_AclFilter $grantsFilter
291      */
292     protected function _checkGrants($result, $grantsFilter)
293     {
294         $clones = clone $result;
295         
296         Tinebase_Container::getInstance()->getGrantsOfRecords($clones, Tinebase_Core::getUser());
297         Calendar_Model_Attender::resolveAttendee($clones->attendee, TRUE, $clones);
298         
299         $me = Tinebase_Core::getUser()->contact_id;
300         $inheritableGrants = array(
301             Tinebase_Model_Grants::GRANT_FREEBUSY,
302             Tinebase_Model_Grants::GRANT_READ,
303             Tinebase_Model_Grants::GRANT_SYNC,
304             Tinebase_Model_Grants::GRANT_EXPORT,
305             Tinebase_Model_Grants::GRANT_PRIVATE,
306         );
307         $toRemove = array();
308         
309         foreach ($result as $event) {
310             $clone = $clones->getById($event->getId());
311             if ($event->organizer == $me) {
312                 foreach($this->_recordBasedGrants as $grant) {
313                     $event->{$grant}     = TRUE;
314                 }
315             } else {
316                 // grants to original container
317                 if ($clone->container_id instanceof Tinebase_Model_Container && $clone->container_id->account_grants) {
318                     foreach($this->_recordBasedGrants as $grant) {
319                         $event->{$grant} =     $clone->container_id->account_grants[$grant] 
320                                             || $clone->container_id->account_grants[Tinebase_Model_Grants::GRANT_ADMIN];
321                     }
322                 }
323                 
324                 // check grant inheritance
325                 foreach ($inheritableGrants as $grant) {
326                     if (! $event->{$grant} && $clone->attendee instanceof Tinebase_Record_RecordSet) {
327                         foreach($clone->attendee as $attendee) {
328                             if (   $attendee->displaycontainer_id instanceof Tinebase_Model_Container
329                                 && $attendee->displaycontainer_id->account_grants 
330                                 && (    $attendee->displaycontainer_id->account_grants[$grant]
331                                      || $attendee->displaycontainer_id->account_grants[Tinebase_Model_Grants::GRANT_ADMIN]
332                                    )
333                             ){
334                                 $event->{$grant} = TRUE;
335                                 break;
336                             }
337                         }
338                     }
339                 }
340                 
341                 if ($grantsFilter) {
342                     $requiredGrants = array_intersect($grantsFilter->getRequiredGrants(), $this->_recordBasedGrants);
343                     
344                     $hasGrant = FALSE;
345                     foreach($requiredGrants as $requiredGrant) {
346                         if ($event->{$requiredGrant}) {
347                             $hasGrant |= $event->{$requiredGrant};
348                         }
349                     }
350                     
351                     if (! $hasGrant) {
352                         $toRemove[] = $event;
353                     }
354                 }
355             }
356         }
357         
358         foreach ($toRemove as $event) {
359             $result->removeRecord($event);
360         }
361     }
362     
363     /**
364      * get the basic select object to fetch records from the database
365      *  
366      * @param array|string|Zend_Db_Expr $_cols columns to get, * per default
367      * @param boolean $_getDeleted get deleted records (if modlog is active)
368      * @return Zend_Db_Select
369      */
370     protected function _getSelectSimple($_cols = '*', $_getDeleted = FALSE)
371     {
372         $select = $this->_db->select();
373
374         $select->from(array($this->_tableName => $this->_tablePrefix . $this->_tableName), $_cols);
375         
376         if (!$_getDeleted && $this->_modlogActive) {
377             // don't fetch deleted objects
378             $select->where($this->_db->quoteIdentifier($this->_tableName . '.is_deleted') . ' = 0');
379         }
380         
381         return $select;
382     }
383     
384     /**
385      * Gets total count of search with $_filter
386      * 
387      * @param Tinebase_Model_Filter_FilterGroup $_filter
388      * @return int
389      */
390     public function searchCount(Tinebase_Model_Filter_FilterGroup $_filter)
391     {
392         $select = $this->_getSelect(array('count' => 'COUNT(*)'));
393         $this->_addFilter($select, $_filter);
394
395         $result = $this->_db->fetchOne($select);
396         
397         return $result;
398     }
399     
400     /**
401      * Updates existing entry
402      *
403      * @param Tinebase_Record_Interface $_record
404      * @throws Tinebase_Exception_Record_Validation|Tinebase_Exception_InvalidArgument
405      * @return Tinebase_Record_Interface Record|NULL
406      */
407     public function update(Tinebase_Record_Interface $_record) 
408     {
409         if ($_record->rrule) {
410             $_record->rrule = (string) $_record->rrule;
411         }
412         
413         if ($_record->container_id instanceof Tinebase_Model_Container) {
414             $_record->container_id = $_record->container_id->getId();
415         }
416         
417         $_record->rrule   = !empty($_record->rrule)   ? $_record->rrule   : NULL;
418         $_record->recurid = !empty($_record->recurid) ? $_record->recurid : NULL;
419         
420         $event = parent::update($_record);
421         $this->_saveExdates($_record);
422         
423         return $this->get($event->getId(), TRUE);
424     }
425     
426     /**
427      * get the basic select object to fetch records from the database
428      *  
429      * @param array|string|Zend_Db_Expr $_cols columns to get, * per default
430      * @param boolean $_getDeleted get deleted records (if modlog is active)
431      * @return Zend_Db_Select
432      */
433     protected function _getSelect($_cols = '*', $_getDeleted = FALSE)
434     {
435         $select = $this->_getSelectSimple();
436
437         $this->_appendEffectiveGrantCalculationSql($select);
438         
439         $select->joinLeft(
440             /* table  */ array('exdate' => $this->_tablePrefix . 'cal_exdate'), 
441             /* on     */ $this->_db->quoteIdentifier('exdate.cal_event_id') . ' = ' . $this->_db->quoteIdentifier($this->_tableName . '.id'),
442             /* select */ array('exdate' => $this->_dbCommand->getAggregate('exdate.exdate')));
443         
444         $select->group($this->_tableName . '.' . 'id');
445         
446         return $select;
447     }
448     
449     /**
450      * appends effective grant calculation to select object
451      *
452      * @param Zend_Db_Select $_select
453      */
454     protected function _appendEffectiveGrantCalculationSql($_select, $_attendeeFilters = NULL)
455     {
456         // groupmemberships of current user, needed to compute phys and inherited grants
457         $_select->joinLeft(
458             /* table  */ array('groupmemberships' => $this->_tablePrefix . 'group_members'), 
459             /* on     */ $this->_db->quoteInto($this->_db->quoteIdentifier('groupmemberships.account_id') . ' = ?' , Tinebase_Core::getUser()->getId()),
460             /* select */ array());
461         
462         // attendee joins the attendee we need to compute the curr users effective grants
463         // NOTE: 2010-04 the behaviour changed. Now, only the attendee the client filters for are 
464         //       taken into account for grants calculation 
465         $attendeeWhere = FALSE;
466         if (is_array($_attendeeFilters) && !empty($_attendeeFilters)) {
467             $attendeeSelect = $this->_db->select();
468             foreach ((array) $_attendeeFilters as $attendeeFilter) {
469                 if ($attendeeFilter instanceof Calendar_Model_AttenderFilter) {
470                     $attendeeFilter->appendFilterSql($attendeeSelect, $this);
471                 }
472             }
473             
474             $whereArray = $attendeeSelect->getPart(Zend_Db_Select::SQL_WHERE);
475             if (! empty($whereArray)) {
476                 $attendeeWhere = ' AND ' . array_value(0, $whereArray);
477             }
478         }
479         
480         $_select->joinLeft(
481             /* table  */ array('attendee' => $this->_tablePrefix . 'cal_attendee'),
482             /* on     */ $this->_db->quoteIdentifier('attendee.cal_event_id') . ' = ' . $this->_db->quoteIdentifier('cal_events.id') . 
483                             $attendeeWhere,
484             /* select */ array());
485         
486
487             
488         $_select->joinLeft(
489             /* table  */ array('attendeeaccounts' => $this->_tablePrefix . 'accounts'), 
490             /* on     */ $this->_db->quoteIdentifier('attendeeaccounts.contact_id') . ' = ' . $this->_db->quoteIdentifier('attendee.user_id') . ' AND (' . 
491                             $this->_db->quoteInto($this->_db->quoteIdentifier('attendee.user_type') . '= ?', Calendar_Model_Attender::USERTYPE_USER) . ' OR ' .
492                             $this->_db->quoteInto($this->_db->quoteIdentifier('attendee.user_type') . '= ?', Calendar_Model_Attender::USERTYPE_GROUPMEMBER) . 
493                         ')',
494             /* select */ array());
495         
496         $_select->joinLeft(
497             /* table  */ array('attendeegroupmemberships' => $this->_tablePrefix . 'group_members'), 
498             /* on     */ $this->_db->quoteIdentifier('attendeegroupmemberships.account_id') . ' = ' . $this->_db->quoteIdentifier('attendeeaccounts.contact_id'),
499             /* select */ array());
500         
501
502         
503         $_select->joinLeft(
504             /* table  */ array('dispgrants' => $this->_tablePrefix . 'container_acl'), 
505             /* on     */ $this->_db->quoteIdentifier('dispgrants.container_id') . ' = ' . $this->_db->quoteIdentifier('attendee.displaycontainer_id') . 
506                            ' AND ' . $this->_getContainGrantCondition('dispgrants', 'groupmemberships'),
507             /* select */ array());
508         
509         $_select->joinLeft(
510             /* table  */ array('physgrants' => $this->_tablePrefix . 'container_acl'), 
511             /* on     */ $this->_db->quoteIdentifier('physgrants.container_id') . ' = ' . $this->_db->quoteIdentifier('cal_events.container_id'),
512             /* select */ array());
513         
514         $allGrants = Tinebase_Model_Grants::getAllGrants();
515         
516         foreach ($allGrants as $grant) {
517             if (in_array($grant, $this->_recordBasedGrants)) {
518                 $_select->columns(array($grant => "\n MAX( CASE WHEN ( \n" .
519                     '  /* physgrant */' . $this->_getContainGrantCondition('physgrants', 'groupmemberships', $grant) . " OR \n" . 
520                     '  /* implicit  */' . $this->_getImplicitGrantCondition($grant) . " OR \n" .
521                     '  /* inherited */' . $this->_getInheritedGrantCondition($grant) . " \n" .
522                  ") THEN 1 ELSE 0 END ) "));
523             } else {
524                 $_select->columns(array($grant => "\n MAX( CASE WHEN ( \n" .
525                     '  /* physgrant */' . $this->_getContainGrantCondition('physgrants', 'groupmemberships', $grant) . "\n" .
526                 ") THEN 1 ELSE 0 END ) "));
527             }
528         }
529     }
530     
531     /**
532      * returns SQL with container grant condition 
533      *
534      * @param  string                               $_aclTableName
535      * @param  string                               $_groupMembersTableName
536      * @param  string|array                         $_requiredGrant (defaults none)
537      * @param  Zend_Db_Expr|int|Tinebase_Model_User $_user (defaults current user)
538      * @return string
539      */
540     protected function _getContainGrantCondition($_aclTableName, $_groupMembersTableName, $_requiredGrant=NULL, $_user=NULL )
541     {
542         $quoteTypeIdentifier = $this->_db->quoteIdentifier($_aclTableName . '.account_type');
543         $quoteIdIdentifier = $this->_db->quoteIdentifier($_aclTableName . '.account_id');
544         
545         if ($_user instanceof Zend_Db_Expr) {
546             $userExpression = $_user;
547         } else {
548             $accountId = $_user ? Tinebase_Model_User::convertUserIdToInt($_user) : Tinebase_Core::getUser()->getId();
549             $userExpression = new Zend_Db_Expr($this->_db->quote($accountId));
550         }
551         
552         $sql = $this->_db->quoteInto(    "($quoteTypeIdentifier = ?", Tinebase_Acl_Rights::ACCOUNT_TYPE_USER)  . " AND $quoteIdIdentifier = $userExpression)" .
553                $this->_db->quoteInto(" OR ($quoteTypeIdentifier = ?", Tinebase_Acl_Rights::ACCOUNT_TYPE_GROUP) . ' AND ' . $this->_db->quoteIdentifier("$_groupMembersTableName.group_id") . " = $quoteIdIdentifier" . ')' . 
554                $this->_db->quoteInto(" OR ($quoteTypeIdentifier = ?)", Tinebase_Acl_Rights::ACCOUNT_TYPE_ANYONE);
555         
556         if ($_requiredGrant) {
557             $sql = "($sql) AND " . $this->_db->quoteInto($this->_db->quoteIdentifier($_aclTableName . '.account_grant') . ' IN (?)', (array)$_requiredGrant);
558             
559         }
560         
561         return "($sql)";
562     }
563     
564     /**
565      * returns SQL condition for implicit grants
566      *
567      * @param  string               $_requiredGrant
568      * @param  Tinebase_Model_User  $_user (defaults to current user)
569      * @return string
570      */
571     protected function _getImplicitGrantCondition($_requiredGrant, $_user=NULL)
572     {
573         $accountId = $_user ? $_user->getId() : Tinebase_Core::getUser()->getId();
574         $contactId = $_user ? $_user->contact_id : Tinebase_Core::getUser()->contact_id;
575         
576         // delte grant couldn't be gained implicitly
577         if ($_requiredGrant == Tinebase_Model_Grants::GRANT_DELETE) {
578             return '1=0';
579         }
580         
581         // organizer gets all other grants implicitly
582         $sql = $this->_db->quoteIdentifier('cal_events.organizer') . " = " . $this->_db->quote($contactId);
583         
584         // attendee get read, sync, export and private grants implicitly
585         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))) {
586             $readCond = $this->_db->quoteIdentifier('attendeeaccounts.id') . ' = ' . $this->_db->quote($accountId) . ' AND (' .
587                 $this->_db->quoteInto($this->_db->quoteIdentifier('attendee.user_type') . ' = ?', Calendar_Model_Attender::USERTYPE_USER) . ' OR ' .
588                 $this->_db->quoteInto($this->_db->quoteIdentifier('attendee.user_type') . ' = ?', Calendar_Model_Attender::USERTYPE_GROUPMEMBER) .
589             ')';
590             
591             $sql = "($sql) OR ($readCond)";
592         }
593         
594         return "($sql)";
595     }
596     
597     /**
598      * returns SQL for inherited grants
599      *
600      * @param  string $_requiredGrant
601      * @return string
602      */
603     protected function _getInheritedGrantCondition($_requiredGrant)
604     {
605         // current user needs to have grant on display calendar
606         $sql = $this->_getContainGrantCondition('dispgrants', 'groupmemberships', $_requiredGrant);
607         
608         // _AND_ attender(admin) of display calendar needs to have grant on phys calendar
609         // @todo include implicit inherited grants
610         if (! in_array($_requiredGrant, array(Tinebase_Model_Grants::GRANT_READ, Tinebase_Model_Grants::GRANT_FREEBUSY))) {
611             $userExpr = new Zend_Db_Expr($this->_db->quoteIdentifier('attendeeaccounts.id'));
612             
613             $attenderPhysGrantCond = $this->_getContainGrantCondition('physgrants', 'attendeegroupmemberships', $_requiredGrant, $userExpr);
614             // NOTE: this condition is weak! Not some attendee must have implicit grant.
615             //       -> an attender we have reqired grants for his diplay cal must have implicit grants
616             //$attenderImplicitGrantCond = $this->_getImplicitGrantCondition($_requiredGrant, $userExpr);
617             
618             //$sql = "($sql) AND ($attenderPhysGrantCond) OR ($attenderImplicitGrantCond)";
619             $sql = "($sql) AND ($attenderPhysGrantCond)";
620         }
621         
622         return "($sql)";
623     }
624     
625     /**
626      * converts raw data from adapter into a single record
627      *
628      * @param  array $_data
629      * @return Tinebase_Record_Abstract
630      */
631     protected function _rawDataToRecord(array $_rawData) {
632         $event = parent::_rawDataToRecord($_rawData);
633         
634         $this->appendForeignRecordSetToRecord($event, 'attendee', 'id', Calendar_Backend_Sql_Attendee::FOREIGNKEY_EVENT, $this->_attendeeBackend);
635         
636         return $event;
637     }
638     
639     /**
640      * converts raw data from adapter into a set of records
641      *
642      * @param  array $_rawData of arrays
643      * @return Tinebase_Record_RecordSet
644      */
645     protected function _rawDataToRecordSet(array $_rawData)
646     {
647         $events = new Tinebase_Record_RecordSet($this->_modelName);
648         $events->addIndices(array('rrule', 'recurid'));
649         
650         foreach ($_rawData as $rawEvent) {
651             $events->addRecord(new Calendar_Model_Event($rawEvent, true));
652         }
653         
654         $this->appendForeignRecordSetToRecordSet($events, 'attendee', 'id', Calendar_Backend_Sql_Attendee::FOREIGNKEY_EVENT, $this->_attendeeBackend);
655         
656         return $events;
657     }
658     
659     /**
660      * saves exdates of an event
661      *
662      * @param Calendar_Model_Event $_event
663      */
664     protected function _saveExdates($_event)
665     {
666         $this->_db->delete($this->_tablePrefix . 'cal_exdate', $this->_db->quoteInto($this->_db->quoteIdentifier('cal_event_id') . '= ?', $_event->getId()));
667         
668         // only save exdates if its an recurring event
669         if (! empty($_event->rrule)) {
670             foreach ((array)$_event->exdate as $exdate) {
671                 if (is_object($exdate)) {
672                     $this->_db->insert($this->_tablePrefix . 'cal_exdate', array(
673                         'id'           => $_event->generateUID(),
674                         'cal_event_id' => $_event->getId(),
675                         'exdate'       => $exdate->get(Tinebase_Record_Abstract::ISO8601LONG)
676                     ));
677                 } else {
678                     if (Tinebase_Core::isLogLevel(Zend_Log::WARN)) Tinebase_Core::getLogger()->warn(__METHOD__ . '::' . __LINE__ 
679                        . ' Exdate needs to be an object:' . var_export($exdate, TRUE));
680                 }
681             }
682         }
683     }
684     
685     /**
686      * saves attendee of given event
687      * 
688      * @param Calendar_Model_Evnet $_event
689      *
690     protected function _saveAttendee($_event)
691     {
692         $attendee = $_event->attendee instanceof Tinebase_Record_RecordSet ? 
693             $_event->attendee : 
694             new Tinebase_Record_RecordSet($this->_attendeeBackend->getModelName());
695         $attendee->cal_event_id = $_event->getId();
696             
697         $currentAttendee = $this->_attendeeBackend->getMultipleByProperty($_event->getId(), Calendar_Backend_Sql_Attendee::FOREIGNKEY_EVENT);
698         
699         $diff = $currentAttendee->getMigration($attendee->getArrayOfIds());
700         $this->_attendeeBackend->delete($diff['toDeleteIds']);
701         
702         foreach ($attendee as $attende) {
703             $method = $attende->getId() ? 'update' : 'create';
704             $this->_attendeeBackend->$method($attende);
705         }
706     }
707     */
708     
709     /****************************** attendee functions ************************/
710     
711     /**
712      * gets attendee of a given event
713      *
714      * @param Calendar_Model_Event $_event
715      * @return Tinebase_Record_RecordSet
716      */
717     public function getEventAttendee(Calendar_Model_Event $_event)
718     {
719         $attendee = $this->_attendeeBackend->getMultipleByProperty($_event->getId(), Calendar_Backend_Sql_Attendee::FOREIGNKEY_EVENT);
720         
721         return $attendee;
722     }
723     
724     /**
725      * creates given attender in database
726      *
727      * @param Calendar_Model_Attender $_attendee
728      * @return Calendar_Model_Attender
729      */
730     public function createAttendee(Calendar_Model_Attender $_attendee)
731     {
732         if ($_attendee->user_id instanceof Addressbook_Model_Contact) {
733             $_attendee->user_id = $_attendee->user_id->getId();
734         } else if ($_attendee->user_id instanceof Addressbook_Model_List) {
735             $_attendee->user_id = $_attendee->user_id->group_id;
736         }
737         
738         if ($_attendee->displaycontainer_id instanceof Tinebase_Model_Container) {
739             $_attendee->displaycontainer_id = $_attendee->displaycontainer_id->getId();
740         }
741         
742         return $this->_attendeeBackend->create($_attendee);
743     }
744     
745     /**
746      * updates given attender in database
747      *
748      * @param Calendar_Model_Attender $_attendee
749      * @return Calendar_Model_Attender
750      */
751     public function updateAttendee(Calendar_Model_Attender $_attendee)
752     {
753         if ($_attendee->user_id instanceof Addressbook_Model_Contact) {
754             $_attendee->user_id = $_attendee->user_id->getId();
755         } else if ($_attendee->user_id instanceof Addressbook_Model_List) {
756             $_attendee->user_id = $_attendee->user_id->group_id;
757         }
758         
759         if ($_attendee->displaycontainer_id instanceof Tinebase_Model_Container) {
760             $_attendee->displaycontainer_id = $_attendee->displaycontainer_id->getId();
761         }
762         
763         return $this->_attendeeBackend->update($_attendee);
764     }
765     
766     /**
767      * deletes given attender in database
768      *
769      * @param Calendar_Model_Attender $_attendee
770      * @return void
771      */
772     public function deleteAttendee(array $_ids)
773     {
774         return $this->_attendeeBackend->delete($_ids);
775     }
776
777     /**
778      * delete duplicate events defined by an event filter
779      * 
780      * @param Calendar_Model_EventFilter $filter
781      * @param boolean $dryrun
782      * @return integer number of deleted events
783      */
784     public function deleteDuplicateEvents($filter, $dryrun = TRUE)
785     {
786         if ($dryrun && Tinebase_Core::isLogLevel(Zend_Log::INFO)) Tinebase_Core::getLogger()->info(__METHOD__ . '::' . __LINE__ 
787             . ' - Running in dry run mode - using filter: ' . print_r($filter->toArray(), true));
788         
789         $duplicateFields = array('summary', 'dtstart', 'dtend');
790         
791         $select = $this->_db->select();
792         $select->from(array($this->_tableName => $this->_tablePrefix . $this->_tableName), $duplicateFields);
793         $select->where($this->_db->quoteIdentifier($this->_tableName . '.is_deleted') . ' = 0');
794             
795         $this->_addFilter($select, $filter);
796         
797         $select->group($duplicateFields)
798                ->having('count(*) > 1');
799         
800         if (Tinebase_Core::isLogLevel(Zend_Log::DEBUG)) Tinebase_Core::getLogger()->debug(__METHOD__ . '::' . __LINE__ 
801            . ' ' . $select);
802         
803         $rows = $this->_fetch($select, self::FETCH_ALL);
804         
805         if (Tinebase_Core::isLogLevel(Zend_Log::TRACE)) Tinebase_Core::getLogger()->trace(__METHOD__ . '::' . __LINE__ 
806            . ' ' . print_r($rows, TRUE));
807         
808         $toDelete = array();
809         foreach ($rows as $row) {
810             $index = $row['summary'] . ' / ' . $row['dtstart'] . ' - ' . $row['dtend'];
811             
812             $filter = new Calendar_Model_EventFilter(array(array(
813                 'field'    => 'summary',
814                 'operator' => 'equals',
815                 'value'    => $row['summary'],
816             ), array(
817                 'field'    => 'dtstart',
818                 'operator' => 'equals',
819                 'value'    => new Tinebase_DateTime($row['dtstart']),
820             ), array(
821                 'field'    => 'dtend',
822                 'operator' => 'equals',
823                 'value'    => new Tinebase_DateTime($row['dtend']),
824             )));
825             $pagination = new Tinebase_Model_Pagination(array('sort' => array($this->_tableName . '.last_modified_time', $this->_tableName . '.creation_time'))); 
826             
827             $select = $this->_db->select();
828             $select->from(array($this->_tableName => $this->_tablePrefix . $this->_tableName));
829             $select->where($this->_db->quoteIdentifier($this->_tableName . '.is_deleted') . ' = 0');
830             
831             $this->_addFilter($select, $filter);
832             $pagination->appendPaginationSql($select);
833             
834             $rows = $this->_fetch($select, self::FETCH_ALL);
835             $events = $this->_rawDataToRecordSet($rows);
836             
837             if (Tinebase_Core::isLogLevel(Zend_Log::TRACE)) Tinebase_Core::getLogger()->trace(__METHOD__ . '::' . __LINE__ 
838                 . ' ' . print_r($events->toArray(), TRUE));
839             
840             $deleteIds = $events->getArrayOfIds();
841             // keep the first
842             array_shift($deleteIds);
843             
844             if (! empty($deleteIds)) {
845                 $deleteContainerIds = ($events->container_id);
846                 $origContainer = array_shift($deleteContainerIds);
847                 if (Tinebase_Core::isLogLevel(Zend_Log::INFO)) Tinebase_Core::getLogger()->info(__METHOD__ . '::' . __LINE__ 
848                     . ' Deleting ' . count($deleteIds) . ' duplicates of: ' . $index . ' in container_ids ' . implode(',', $deleteContainerIds) . ' (origin container: ' . $origContainer . ')');
849                 if (Tinebase_Core::isLogLevel(Zend_Log::TRACE)) Tinebase_Core::getLogger()->trace(__METHOD__ . '::' . __LINE__ 
850                     . ' ' . print_r($deleteIds, TRUE));
851                 
852                 $toDelete = array_merge($toDelete, $deleteIds);
853             } else {
854                 if (Tinebase_Core::isLogLevel(Zend_Log::DEBUG)) Tinebase_Core::getLogger()->debug(__METHOD__ . '::' . __LINE__ 
855                    . ' No duplicates found for ' . $index);
856             }
857         }
858         
859         if (empty($toDelete)) {
860             if (Tinebase_Core::isLogLevel(Zend_Log::INFO)) Tinebase_Core::getLogger()->info(__METHOD__ . '::' . __LINE__ 
861                 . ' No duplicates found.');
862             $result = 0;
863         } else {
864             $result = ($dryrun) ? count($toDelete) : $this->delete($toDelete);
865         }
866         
867         return $result;
868     }
869     
870     /**
871      * repair dangling attendee records (no displaycontainer_id)
872      *
873      * @see https://forge.tine20.org/mantisbt/view.php?id=8172
874      */
875     public function repairDanglingDisplaycontainerEvents()
876     {
877         $filter = new Tinebase_Model_Filter_FilterGroup();
878         $filter->addFilter(new Tinebase_Model_Filter_Text(array(
879             'field'     => 'user_type',
880             'operator'  => 'in', 
881             'value'     => array(
882                 Calendar_Model_Attender::USERTYPE_USER,
883                 Calendar_Model_Attender::USERTYPE_GROUPMEMBER,
884                 Calendar_Model_Attender::USERTYPE_RESOURCE
885             )
886         )));
887         
888         $filter->addFilter(new Tinebase_Model_Filter_Text(array(
889             'field'     => 'displaycontainer_id',
890             'operator'  => 'isnull',
891             'value'     => null
892         )));
893         
894         $danglingAttendee = $this->_attendeeBackend->search($filter);
895         $danglingContactAttendee = $danglingAttendee->filter('user_type', '/'. Calendar_Model_Attender::USERTYPE_USER . '|'. Calendar_Model_Attender::USERTYPE_GROUPMEMBER .'/', TRUE);
896         $danglingContactIds = array_unique($danglingContactAttendee->user_id);
897         $danglingContacts = Addressbook_Controller_Contact::getInstance()->getMultiple($danglingContactIds, TRUE);
898         $danglingResourceAttendee = $danglingAttendee->filter('user_type', Calendar_Model_Attender::USERTYPE_RESOURCE);
899         $danglingResourceIds =  array_unique($danglingResourceAttendee->user_id);
900         Calendar_Controller_Resource::getInstance()->doContainerACLChecks(false);
901         $danglingResources = Calendar_Controller_Resource::getInstance()->getMultiple($danglingResourceIds, TRUE);
902         
903         if (Tinebase_Core::isLogLevel(Zend_Log::DEBUG)) Tinebase_Core::getLogger()->debug(__METHOD__ . '::' . __LINE__ 
904             . ' Processing ' . count($danglingContactIds) . ' dangling contact ids...');
905         
906         foreach ($danglingContactIds as $danglingContactId) {
907             $danglingContact = $danglingContacts->getById($danglingContactId);
908             if ($danglingContact && $danglingContact->account_id) {
909                 
910                 if (Tinebase_Core::isLogLevel(Zend_Log::DEBUG)) Tinebase_Core::getLogger()->debug(__METHOD__ . '::' . __LINE__ 
911                     . ' Get default display container for account ' . $danglingContact->account_id);
912                 if (Tinebase_Core::isLogLevel(Zend_Log::TRACE)) Tinebase_Core::getLogger()->trace(__METHOD__ . '::' . __LINE__ 
913                     . ' ' . print_r($danglingContact->toArray(), true));
914                 
915                 $displayCalId = Calendar_Controller_Event::getDefaultDisplayContainerId($danglingContact->account_id);
916                 if ($displayCalId) {
917                     // finaly repair attendee records
918                     $attendeeRecords = $danglingContactAttendee->filter('user_id', $danglingContactId);
919                     $this->_attendeeBackend->updateMultiple($attendeeRecords->getId(), array('displaycontainer_id' => $displayCalId));
920                     Tinebase_Core::getLogger()->NOTICE(__METHOD__ . '::' . __LINE__ . " repaired the following contact attendee " . print_r($attendeeRecords->toArray(), TRUE));
921                 }
922             }
923         }
924         
925         if (Tinebase_Core::isLogLevel(Zend_Log::DEBUG)) Tinebase_Core::getLogger()->debug(__METHOD__ . '::' . __LINE__ 
926             . ' Processing ' . count($danglingResourceIds) . ' dangling resource ids...');
927         
928         foreach ($danglingResourceIds as $danglingResourceId) {
929             $resource = $danglingResources->getById($danglingResourceId);
930             if ($resource && $resource->container_id) {
931                 $displayCalId = $resource->container_id;
932                 $attendeeRecords = $danglingResourceAttendee->filter('user_id', $danglingResourceId);
933                 $this->_attendeeBackend->updateMultiple($attendeeRecords->getId(), array('displaycontainer_id' => $displayCalId));
934                 Tinebase_Core::getLogger()->NOTICE(__METHOD__ . '::' . __LINE__ . " repaired the following resource attendee " . print_r($attendeeRecords->toArray(), TRUE));
935             }
936         }
937     }
938 }