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