Merge branch '2014.11-develop' into 2015.07
[tine20] / tine20 / Calendar / Setup / Update / Release8.php
1 <?php
2 /**
3  * Tine 2.0
4  *
5  * @package     Calendar
6  * @subpackage  Setup
7  * @license     http://www.gnu.org/licenses/agpl.html AGPL3
8  * @copyright   Copyright (c) 2014 Metaways Infosystems GmbH (http://www.metaways.de)
9  * @author      Cornelius WeiƟ <c.weiss@metaways.de>
10  */
11 class Calendar_Setup_Update_Release8 extends Setup_Update_Abstract
12 {
13     /**
14      * update to 8.1
15      * - move ack & snooze time from attendee to alarm
16      */
17     public function update_0()
18     {
19         // find all events with ack or snooze times set
20         $eventIds = $this->_db->query(
21             "SELECT DISTINCT " . $this->_db->quoteIdentifier('cal_event_id') .
22                 " FROM " . $this->_db->quoteIdentifier(SQL_TABLE_PREFIX . "cal_attendee") .
23                 " WHERE " . $this->_db->quoteIdentifier("alarm_ack_time") . " IS NOT NULL OR ". $this->_db->quoteIdentifier("alarm_snooze_time") . " IS NOT NULL"
24             )->fetchAll(Zend_Db::FETCH_ASSOC);
25         
26         $attendeeBE = new Calendar_Backend_Sql_Attendee();
27         $alarmBE = Tinebase_Alarm::getInstance();
28         
29         foreach ($eventIds as $eventId) {
30             $eventId = $eventId['cal_event_id'];
31             
32             $attendeeFilter = new Tinebase_Model_Filter_FilterGroup();
33             $attendeeFilter->addFilter(new Tinebase_Model_Filter_Text('cal_event_id', 'equals', $eventId));
34             $attendees = $attendeeBE->search($attendeeFilter);
35             
36             $alarms = $alarmBE->search(new Tinebase_Model_AlarmFilter(array(
37                 array('field' => 'model',     'operator' => 'equals', 'value' =>'Calendar_Model_Event'),
38                 array('field' => 'record_id', 'operator' => 'equals', 'value' => $eventId)
39             )));
40             
41             foreach ($alarms as $alarm) {
42                 foreach ($attendees as $attendee) {
43                     if ($attendee->alarm_ack_time instanceof Tinebase_DateTime) {
44                         $alarm->setOption("acknowledged-{$attendee->user_id}", $attendee->alarm_ack_time->format(Tinebase_Record_Abstract::ISO8601LONG));
45                     }
46                     if ($attendee->alarm_snooze_time instanceof Tinebase_DateTime) {
47                         $alarm->setOption("snoozed-{$attendee->user_id}", $attendee->alarm_snooze_time->format(Tinebase_Record_Abstract::ISO8601LONG));
48                     }
49                     
50                 }
51                 $alarmBE->update($alarm);
52             }
53         }
54         
55         // delte ack & snooze from attendee
56         $this->_backend->dropCol('cal_attendee', 'alarm_ack_time');
57         $this->_backend->dropCol('cal_attendee', 'alarm_snooze_time');
58         
59         $this->setTableVersion('cal_attendee', 5);
60         $this->setApplicationVersion('Calendar', '8.1');
61     }
62     
63     /**
64      * update to 8.2
65      * 
66      */
67     public function update_1()
68     {
69         $eventBE = new Tinebase_Backend_Sql(array(
70                 'modelName'    => 'Calendar_Model_Event',
71                 'tableName'    => 'cal_events',
72                 'modlogActive' => false
73         ));
74         // find all events without organizer
75         $eventIds = $this->_db->query(
76                 "SELECT " . $this->_db->quoteIdentifier('id') .
77                 " FROM " . $this->_db->quoteIdentifier(SQL_TABLE_PREFIX . "cal_events") .
78                 " WHERE " . $this->_db->quoteIdentifier("organizer") . " IS NULL OR " .
79                             $this->_db->quoteIdentifier("organizer") . " = ''"
80         )->fetchAll(Zend_Db::FETCH_ASSOC);
81         
82         foreach ($eventIds as $eventId) {
83             $event = $eventBE->get($eventId['id']);
84             $event->organizer = (string) Tinebase_User::getInstance()->getFullUserById($event->created_by)->contact_id;
85             
86             $where  = array(
87                 $this->_db->quoteInto($this->_db->quoteIdentifier('id') . ' = ?', $eventId),
88             );
89             
90             try {
91                 $this->_db->update(SQL_TABLE_PREFIX . "cal_events", $event->toArray(), $where);
92             } catch (Tinebase_Exception_Record_Validation $terv) {
93                 if (Tinebase_Core::isLogLevel(Zend_Log::DEBUG)) Tinebase_Core::getLogger()->debug(__METHOD__ . '::' . __LINE__
94                     . ' Could not fix invalid event record: ' . print_r($event->toArray(), true));
95                 Tinebase_Exception::log($terv);
96             }
97         }
98         
99         // find all events CONFIDENTIAL class
100         $eventIds = $this->_db->query(
101                 "SELECT " . $this->_db->quoteIdentifier('id') .
102                 " FROM " . $this->_db->quoteIdentifier(SQL_TABLE_PREFIX . "cal_events") .
103                 " WHERE " . $this->_db->quoteIdentifier("class") . " = 'CONFIDENTIAL'"
104         )->fetchAll(Zend_Db::FETCH_ASSOC);
105         
106         foreach ($eventIds as $eventId) {
107             $event = $eventBE->get($eventId['id']);
108             $class = Calendar_Model_Event::CLASS_PRIVATE;
109             $event->class = (string) $class;
110             
111             $where  = array(
112                 $this->_db->quoteInto($this->_db->quoteIdentifier('id') . ' = ?', $eventId),
113             );
114             
115             try {
116                 $this->_db->update(SQL_TABLE_PREFIX . "cal_events", $event->toArray(), $where);
117             } catch (Tinebase_Exception_Record_Validation $terv) {
118                 if (Tinebase_Core::isLogLevel(Zend_Log::DEBUG)) Tinebase_Core::getLogger()->debug(__METHOD__ . '::' . __LINE__
119                     . ' Could not fix invalid event record: ' . print_r($event->toArray(), true));
120                 Tinebase_Exception::log($terv);
121             }
122         }
123          $this->setApplicationVersion('Calendar', '8.2');
124     }
125     
126     /**
127      * update to 8.3
128      * - normalize all rrules
129      */
130     public function update_2()
131     {
132         // find all events with rrule
133         $eventIds = $this->_db->query(
134                 "SELECT " . $this->_db->quoteIdentifier('id') .
135                 " FROM " . $this->_db->quoteIdentifier(SQL_TABLE_PREFIX . "cal_events") .
136                 " WHERE " . $this->_db->quoteIdentifier("rrule") . " IS NOT NULL"
137         )->fetchAll(Zend_Db::FETCH_ASSOC);
138         
139         // NOTE: we need a generic sql BE to circumvent calendar specific acl issues
140         $eventBE = new Tinebase_Backend_Sql(array(
141                 'modelName'    => 'Calendar_Model_Event',
142                 'tableName'    => 'cal_events',
143                 'modlogActive' => false
144         ));
145         
146         foreach ($eventIds as $eventId) {
147             $event = $eventBE->get($eventId['id']);
148             $oldRruleString = (string) $event->rrule;
149             $rrule = Calendar_Model_Rrule::getRruleFromString($oldRruleString);
150             $rrule->normalize($event);
151             
152             if ($oldRruleString != (string) $rrule) {
153                 $event->rrule = (string) $rrule;
154                 try {
155                     $eventBE->update($event);
156                 } catch (Tinebase_Exception_Record_Validation $terv) {
157                     Tinebase_Exception::log($terv, null, $event->toArray());
158                 } catch (Tinebase_Exception_UnexpectedValue $teuv) {
159                     Tinebase_Exception::log($teuv, null, $event->toArray());
160                 }
161             }
162         }
163         
164         $this->setApplicationVersion('Calendar', '8.3');
165     }
166     
167     /**
168      * update to 8.4
169      * 
170      * - adds etag column
171      */
172     public function update_3()
173     {
174         $declaration = new Setup_Backend_Schema_Field_Xml('
175             <field>
176                 <name>etag</name>
177                 <type>text</type>
178                 <length>60</length>
179             </field>');
180         $this->_backend->addCol('cal_events', $declaration);
181         
182         $declaration = new Setup_Backend_Schema_Index_Xml('
183             <index>
184                 <name>etag</name>
185                 <field>
186                     <name>etag</name>
187                 </field>
188             </index>');
189         $this->_backend->addIndex('cal_events', $declaration);
190         
191         $this->setTableVersion('cal_events', 7);
192         $this->setApplicationVersion('Calendar', '8.4');
193     }
194     
195     /**
196      * - update import / export
197      */
198     public function update_4()
199     {
200         Setup_Controller::getInstance()->createImportExportDefinitions(Tinebase_Application::getInstance()->getApplicationByName('Calendar'));
201         $this->setTableVersion('cal_events', 7);
202         $this->setApplicationVersion('Calendar', '8.5');
203     }
204     
205     /**
206      * adds external_seq col
207      * 
208      * @see 0009890: improve external event invitation support
209      */
210     public function update_5()
211     {
212         if (! $this->_backend->columnExists('external_seq', 'cal_events')) {
213             $seqCol = '<field>
214                 <name>external_seq</name>
215                 <type>integer</type>
216                 <notnull>true</notnull>
217                 <default>0</default>
218             </field>';
219             
220             $declaration = new Setup_Backend_Schema_Field_Xml($seqCol);
221             $this->_backend->addCol('cal_events', $declaration);
222         }
223         
224         $this->setTableVersion('cal_events', 8);
225         $this->setApplicationVersion('Calendar', '8.6');
226     }
227     
228     /**
229      * add rrule index
230      * 
231      * @see 0010214: improve calendar performance / yearly base events
232      */
233     public function update_6()
234     {
235         $declaration = new Setup_Backend_Schema_Index_Xml('
236             <index>
237                 <name>rrule</name>
238                 <field>
239                     <name>rrule</name>
240                 </field>
241             </index>');
242         try {
243             $this->_backend->addIndex('cal_events', $declaration);
244         } catch (Zend_Db_Statement_Exception $e) {
245             Tinebase_Exception::log($e);
246         }
247         
248         $this->setTableVersion('cal_events', '9');
249         $this->setApplicationVersion('Calendar', '8.7');
250     }
251
252     /**
253      * repair missing displaycontainer_id
254      */
255     public function update_7()
256     {
257         $allUser = $this->_db->query(
258             "SELECT " . $this->_db->quoteIdentifier('id') . "," . $this->_db->quoteIdentifier('contact_id') .
259             " FROM " . $this->_db->quoteIdentifier(SQL_TABLE_PREFIX . "accounts") .
260             " WHERE " . $this->_db->quoteIdentifier("contact_id") . " IS NOT NULL"
261         )->fetchAll(Zend_Db::FETCH_ASSOC);
262
263         $contactUserMap = array();
264         foreach ($allUser as $id => $user) {
265             $contactUserMap[$user['contact_id']] = $user['id'];
266         }
267
268         // find all user/groupmember attendees with missing displaycontainer
269         $attendees = $this->_db->query(
270             "SELECT DISTINCT" . $this->_db->quoteIdentifier('user_type') . "," . $this->_db->quoteIdentifier('user_id') .
271             " FROM " . $this->_db->quoteIdentifier(SQL_TABLE_PREFIX . "cal_attendee") .
272             " WHERE " . $this->_db->quoteIdentifier("displaycontainer_id") . " IS  NULL" .
273             "  AND " . $this->_db->quoteIdentifier("user_type") . $this->_db->quoteInto(" IN (?)", array('user', 'groupmemeber')) .
274             "  AND " . $this->_db->quoteIdentifier("user_id") . $this->_db->quoteInto(" IN (?)", array_keys($contactUserMap))
275         )->fetchAll(Zend_Db::FETCH_ASSOC);
276
277         // find all user/groupmember attendees with missing displaycontainer
278         $attendees = array_merge($attendees, $this->_db->query(
279             "SELECT DISTINCT" . $this->_db->quoteIdentifier('user_type') . "," . $this->_db->quoteIdentifier('user_id') .
280             " FROM " . $this->_db->quoteIdentifier(SQL_TABLE_PREFIX . "cal_attendee") .
281             " WHERE " . $this->_db->quoteIdentifier("displaycontainer_id") . " IS  NULL" .
282             "  AND " . $this->_db->quoteIdentifier("user_type") . $this->_db->quoteInto(" IN (?)", array('resource'))
283         )->fetchAll(Zend_Db::FETCH_ASSOC));
284
285         $resources = $this->_db->query(
286             "SELECT " . $this->_db->quoteIdentifier('id') . "," . $this->_db->quoteIdentifier('container_id') .
287             " FROM " . $this->_db->quoteIdentifier(SQL_TABLE_PREFIX . "cal_resources")
288         )->fetchAll(Zend_Db::FETCH_ASSOC);
289
290         $resourceContainerMap = array();
291         foreach ($resources as $resource) {
292             $resourceContainerMap[$resource['id']] = $resource['container_id'];
293         }
294
295         foreach ($attendees as $attendee) {
296             //find out displaycontainer
297             if ($attendee['user_type'] != 'resource') {
298                 $userAccountId = $contactUserMap[$attendee['user_id']];
299                 $attendee['displaycontainerId'] = Calendar_Controller_Event::getDefaultDisplayContainerId($userAccountId);
300             } else {
301                 $attendee['displaycontainerId'] = $resourceContainerMap[$attendee['user_id']];
302             }
303
304             // update displaycontainer
305             $this->_db->query(
306                 "UPDATE" . $this->_db->quoteIdentifier(SQL_TABLE_PREFIX . "cal_attendee") .
307                 " SET " . $this->_db->quoteIdentifier("displaycontainer_id") . " = " . $this->_db->quote($attendee['displaycontainerId']) .
308                 " WHERE " . $this->_db->quoteIdentifier("user_type") . " = " . $this->_db->quote($attendee['user_type']) .
309                 "  AND " . $this->_db->quoteIdentifier("user_id") . " = " . $this->_db->quote($attendee['user_id'])
310             );
311         }
312
313         $this->setApplicationVersion('Calendar', '8.8');
314     }
315
316     /**
317      * identify base event via new base_event_id field instead of UID
318      */
319     public function update_8()
320     {
321         /* find possibly broken events
322          SELECT group_concat(id), uid, count(id) as cnt from tine20_cal_events
323              WHERE rrule IS NOT NULL
324              GROUP BY uid
325              HAVING cnt > 1;
326          */
327
328         $declaration = new Setup_Backend_Schema_Field_Xml('
329             <field>
330                 <name>base_event_id</name>
331                 <type>text</type>
332                 <length>40</length>
333             </field>');
334         $this->_backend->addCol('cal_events', $declaration);
335
336         $declaration = new Setup_Backend_Schema_Index_Xml('
337             <index>
338                 <name>base_event_id</name>
339                 <field>
340                     <name>base_event_id</name>
341                 </field>
342             </index>');
343         $this->_backend->addIndex('cal_events', $declaration);
344
345         // find all events with rrule
346         $events = $this->_db->query(
347             "SELECT " . $this->_db->quoteIdentifier('id') .
348                  ', ' . $this->_db->quoteIdentifier('uid') .
349                  ', ' . $this->_db->quoteIdentifier('container_id') .
350                  ', ' . $this->_db->quoteIdentifier('created_by') .
351             " FROM " . $this->_db->quoteIdentifier(SQL_TABLE_PREFIX . "cal_events") .
352             " WHERE " . $this->_db->quoteIdentifier("rrule") . " IS NOT NULL" .
353               " AND " . $this->_db->quoteIdentifier("is_deleted") . " = " . $this->_db->quote(0, Zend_Db::INT_TYPE)
354         )->fetchAll(Zend_Db::FETCH_ASSOC);
355
356         // update all exdates in same container
357         foreach($events as $event) {
358             $this->_db->query(
359                 "UPDATE " . $this->_db->quoteIdentifier(SQL_TABLE_PREFIX . "cal_events") .
360                   " SET " . $this->_db->quoteIdentifier('base_event_id') . ' = ' . $this->_db->quote($event['id']) .
361                 " WHERE " . $this->_db->quoteIdentifier('uid') . ' = ' . $this->_db->quote($event['uid']) .
362                   " AND " . $this->_db->quoteIdentifier("container_id") . ' = ' . $this->_db->quote($event['container_id']) .
363                   " AND " . $this->_db->quoteIdentifier("recurid") . " IS NOT NULL" .
364                   " AND " . $this->_db->quoteIdentifier("is_deleted") . " = " . $this->_db->quote(0, Zend_Db::INT_TYPE)
365             );
366         }
367
368         // find all container move exdates
369         $danglingExdates = $this->_db->query(
370             "SELECT " . $this->_db->quoteIdentifier('uid') .
371                 ', ' . $this->_db->quoteIdentifier('id') .
372                 ', ' . $this->_db->quoteIdentifier('created_by') .
373             " FROM " . $this->_db->quoteIdentifier(SQL_TABLE_PREFIX . "cal_events") .
374             " WHERE " . $this->_db->quoteIdentifier("recurid") . " IS NOT NULL" .
375               " AND " . $this->_db->quoteIdentifier("base_event_id") . " IS NULL" .
376               " AND " . $this->_db->quoteIdentifier("is_deleted") . " = " . $this->_db->quote(0, Zend_Db::INT_TYPE)
377         )->fetchAll(Zend_Db::FETCH_ASSOC);
378
379         // try to match by creator
380         foreach ($danglingExdates as $exdate) {
381             $possibleBaseEvents = array();
382             $matches = array_filter($events, function ($event) use ($exdate, $possibleBaseEvents) {
383                 if ($event['uid'] == $exdate['uid']) {
384                     $possibleBaseEvents[] = $event;
385                     return $event['created_by'] == $exdate['created_by'];
386                 }
387                 return false;
388             });
389
390             switch(count($matches)) {
391                 case 0:
392                     // no match :-(
393                     if (count($possibleBaseEvents) == 0) {
394                         // garbage? exdate without any base event
395                         Setup_Core::getLogger()->err(__METHOD__ . '::' . __LINE__ . " dangling exdate with id {$exdate['id']}");
396                         continue 2;
397                     }
398                     Setup_Core::getLogger()->err(__METHOD__ . '::' . __LINE__ . " no match for exdate with id {$exdate['id']}");
399                     $baseEvent = current($possibleBaseEvents);
400                     break;
401                 case 1:
402                     // exact match :-)
403                     $baseEvent = current($matches);
404                     break;
405                 default:
406                     // to much matches :-(
407                     Setup_Core::getLogger()->err(__METHOD__ . '::' . __LINE__ . " multiple matches for exdate with id {$exdate['id']}");
408                     $baseEvent = current($matches);
409             }
410
411             $this->_db->query(
412                 "UPDATE " . $this->_db->quoteIdentifier(SQL_TABLE_PREFIX . "cal_events") .
413                 " SET " . $this->_db->quoteIdentifier('base_event_id') . ' = ' . $this->_db->quote($baseEvent['id']) .
414                 " WHERE " . $this->_db->quoteIdentifier('id') . ' = ' . $this->_db->quote($exdate['id'])
415             );
416         }
417
418         $this->setTableVersion('cal_events', '10');
419         $this->setApplicationVersion('Calendar', '8.9');
420     }
421
422     /**
423      * update to 9.0
424      *
425      * @return void
426      */
427     public function update_9()
428     {
429         $this->setApplicationVersion('Calendar', '9.0');
430     }
431 }