adds update events test to caldav client test suite
[tine20] / tine20 / Calendar / Import / CalDav / Client.php
1 <?php
2 //./tine20.php --username unittest --method Calendar.importCalDav url="https://osx-testfarm-mavericks-server.hh.metaways.de:8443" caldavuserfile=caldavuserfile.csv
3
4 /**
5  * Tine 2.0
6  * 
7  * @package     Calendar
8  * @subpackage  Import
9  * @license     http://www.gnu.org/licenses/agpl.html AGPL Version 3
10  * @author      Paul Mehrer <p.mehrer@metaways.de>
11  * @copyright   Copyright (c) 2014 Metaways Infosystems GmbH (http://www.metaways.de)
12  */
13
14 /**
15  * Calendar_Import_CalDAV
16  * 
17  * @package     Calendar
18  * @subpackage  Import
19  */
20 class Calendar_Import_CalDav_Client extends Tinebase_Import_CalDav_Client
21 {
22     protected $calendars = array();
23     protected $calendarICSs = array();
24     protected $existingRecordIds = array();
25     protected $maxBulkRequest = 20;
26     protected $mapToDefaultContainer = 'calendar';
27     protected $decorator = null;
28     
29     protected $component = 'VEVENT';
30     protected $skipComonent = 'VTODO';
31     protected $modelName = 'Calendar_Model_Event';
32     protected $appName = 'Calendar';
33     protected $webdavFrontend = 'Calendar_Frontend_WebDAV_Event';
34     protected $_uuidPrefix = '';
35     
36     const calendarDataKey = '{urn:ietf:params:xml:ns:caldav}calendar-data';
37     const findAllCalendarsRequest =
38 '<?xml version="1.0"?>
39 <d:propfind xmlns:d="DAV:">
40   <d:prop>
41     <d:resourcetype />
42     <d:acl />
43     <d:displayname />
44     <x:supported-calendar-component-set xmlns:x="urn:ietf:params:xml:ns:caldav"/>
45   </d:prop>
46 </d:propfind>';
47     
48     const findAllCalendarICSsRequest = 
49 '<?xml version="1.0"?>
50 <d:propfind xmlns:d="DAV:">
51   <d:prop>
52     <x:calendar-data xmlns:x="urn:ietf:params:xml:ns:caldav"/>
53   </d:prop>
54 </d:propfind>';
55     
56     const getAllCalendarDataRequest =
57 '<?xml version="1.0"?>
58 <b:calendar-multiget xmlns:a="DAV:" xmlns:b="urn:ietf:params:xml:ns:caldav">
59   <a:prop>
60     <b:calendar-data />
61     <a:getetag />
62   </a:prop>
63 ';
64     
65     const getEventETagsRequest =
66 '<?xml version="1.0"?>
67 <b:calendar-multiget xmlns:a="DAV:" xmlns:b="urn:ietf:params:xml:ns:caldav">
68   <a:prop>
69     <a:getetag />
70   </a:prop>
71 ';
72     
73     public function __construct(array $a, $flavor)
74     {
75         parent::__construct($a);
76         
77         $flavor = 'Calendar_Import_CalDav_Decorator_' . $flavor;
78         $this->decorator = new $flavor($this);
79     }
80     
81     public function findAllCalendars()
82     {
83         if ('' == $this->calendarHomeSet && ! $this->findCalendarHomeSet())
84             return false;
85         
86         //issue with follow location in curl!?!?
87         if ($this->calendarHomeSet[strlen($this->calendarHomeSet)-1] !== '/')
88             $this->calendarHomeSet .= '/';
89         
90         try {
91             $result = $this->calDavRequest('PROPFIND', $this->calendarHomeSet, $this->decorator->preparefindAllCalendarsRequest(self::findAllCalendarsRequest), 1);
92         } catch (Tinebase_Exception $te) {
93             if (Tinebase_Core::isLogLevel(Zend_Log::WARN))
94                 Tinebase_Core::getLogger()->warn(__METHOD__ . '::' . __LINE__ . ' request failed');
95             Tinebase_Exception::log($te);
96             return false;
97         }
98         
99         foreach ($result as $uri => $response) {
100             if (isset($response['{DAV:}resourcetype']) &&
101                     isset($response['{urn:ietf:params:xml:ns:caldav}supported-calendar-component-set']) && 
102                     $response['{DAV:}resourcetype']->is('{urn:ietf:params:xml:ns:caldav}calendar') &&
103                     in_array($this->component, $response['{urn:ietf:params:xml:ns:caldav}supported-calendar-component-set']->getValue())
104             ) {
105                 $this->calendars[$uri]['acl'] = $response['{DAV:}acl'];
106                 $this->calendars[$uri]['displayname'] = $response['{DAV:}displayname'];
107                 $this->decorator->processAdditionalCalendarProperties($this->calendars[$uri], $response);
108                 $this->resolvePrincipals($this->calendars[$uri]['acl']->getPrivileges());
109             }
110         }
111         
112         if (count($this->calendars) > 0) {
113             return true;
114         } else {
115             if (Tinebase_Core::isLogLevel(Zend_Log::WARN))
116                 Tinebase_Core::getLogger()->warn(__METHOD__ . '::' . __LINE__ . ' couldn\'t find a calendar');
117             return false;
118         }
119     }
120     
121     public function findAllCalendarICSs()
122     {
123         if (count($this->calendars) < 1 && ! $this->findAllCalendars())
124             return false;
125         
126         foreach ($this->calendars as $calUri => $calendar) {
127             $result = $this->calDavRequest('PROPFIND', $calUri, self::findAllCalendarICSsRequest, 1);
128             foreach ($result as $ics => $value) {
129                 if (strpos($ics, '.ics') !== FALSE)
130                     $this->calendarICSs[$calUri][] = $ics;
131             }
132         }
133         
134         if (count($this->calendarICSs) > 0) {
135             return true;
136         } else {
137             if (Tinebase_Core::isLogLevel(Zend_Log::NOTICE))
138                 Tinebase_Core::getLogger()->notice(__METHOD__ . '::' . __LINE__ . ' all found calendars are empty');
139             return false;
140         }
141     }
142     
143     /**
144      * findContainerForCalendar
145      * 
146      * @param unknown $calendarUri
147      * @param unknown $displayname
148      * @param unknown $defaultCalendarsName
149      * @param unknown $type
150      * @param string $application_id
151      */
152     protected function findContainerForCalendar($calendarUri, 
153             $displayname, $defaultCalendarsName, $type = Tinebase_Model_Container::TYPE_PERSONAL,
154             $application_id = null)
155     {
156         if (! $application_id) {
157             $application_id = Tinebase_Application::getInstance()->getApplicationByName($this->appName)->getId();
158         }
159         
160         // sha1() the whole calendar uri as it is very hard to separate a uuid string from the uri otherwise
161         $uuid = $this->_uuidPrefix . sha1($calendarUri);
162         
163         if (Tinebase_Core::isLogLevel(Zend_Log::DEBUG)) Tinebase_Core::getLogger()->debug(__METHOD__ . ' ' . __LINE__
164                 . ' $calendarUri = ' . $calendarUri . ' / $displayname = ' . $displayname 
165                 . ' / $defaultCalendarsName = ' . $defaultCalendarsName . ' / $uuid = ' . $uuid);
166         
167         $filter = new Tinebase_Model_ContainerFilter(array(
168             array(
169                 'field' => 'uuid', 
170                 'operator' => 'equals', 
171                 'value' => $uuid
172             ),
173             array(
174                 'field' => 'model', 
175                 'operator' => 'equals', 
176                 'value' => $this->modelName
177             ),
178         ));
179         $existingCalendar = Tinebase_Container::getInstance()->search($filter)->getFirstRecord();
180         if ($existingCalendar) {
181             if (Tinebase_Core::isLogLevel(Zend_Log::DEBUG)) Tinebase_Core::getLogger()->debug(__METHOD__ . ' ' . __LINE__
182                 . ' Found existing container ' . $existingCalendar->name . ' (id: ' . $existingCalendar->getId() . ')');
183             return $existingCalendar;
184         }
185         
186         $counter = '';
187         
188         if ($defaultCalendarsName == $displayname) {
189             $existingCalendar = Tinebase_Container::getInstance()->getDefaultContainer($this->modelName);
190             if (! $existingCalendar->uuid) {
191                 if (Tinebase_Core::isLogLevel(Zend_Log::DEBUG)) Tinebase_Core::getLogger()->debug(__METHOD__ . ' ' . __LINE__
192                     . ' Found existing calendar with the same name');
193                 $existingCalendar->uuid = $uuid;
194                 return $existingCalendar;
195             }
196             $existingCalendar = null;
197             $counter = 1;
198         }
199         
200         try {
201             while (true) {
202                 $existingCalendar = Tinebase_Container::getInstance()->getContainerByName($this->appName, $displayname . $counter, $type, Tinebase_Core::getUser());
203                 
204                 if (Tinebase_Core::isLogLevel(Zend_Log::INFO)) Tinebase_Core::getLogger()->info(__METHOD__ . ' ' . __LINE__
205                     . ' Got calendar: ' . $existingCalendar->name . ' (id: ' . $existingCalendar->getId() . ')');
206                 
207                 if (! $existingCalendar->uuid) {
208                     $existingCalendar->uuid = $uuid;
209                     return $existingCalendar;
210                 }
211                 $counter += 1;
212             }
213         } catch (Tinebase_Exception_NotFound $e) {
214             $newContainer = new Tinebase_Model_Container(array(
215                 'name'              => $displayname . $counter,
216                 'type'              => $type,
217                 'backend'           => 'Sql',
218                 'application_id'    => $application_id,
219                 'model'             => $this->modelName,
220                 'uuid'              => $uuid
221             ));
222             
223             if (Tinebase_Core::isLogLevel(Zend_Log::INFO)) Tinebase_Core::getLogger()->info(__METHOD__ . ' ' . __LINE__
224                     . ' Adding container: ' . $newContainer->name . ' for model ' . $this->modelName);
225             
226             return Tinebase_Container::getInstance()->addContainer($newContainer);
227         }
228     }
229     
230     public function importAllCalendars()
231     {
232         if (count($this->calendars) < 1 && ! $this->findAllCalendars()) {
233             return false;
234         }
235         
236         if (Tinebase_Core::isLogLevel(Zend_Log::INFO)) Tinebase_Core::getLogger()->info(__METHOD__ . ' ' . __LINE__ 
237             . ' Importing all calendars for user ' . $this->userName);
238         
239         Tinebase_Core::getApplicationInstance($this->appName, $this->modelName)->sendNotifications(false);
240         Tinebase_Core::getApplicationInstance($this->appName, $this->modelName)->useNotes(false);
241         Sabre\VObject\Component\VCalendar::$propertyMap['ATTACH'] = '\\Calendar_Import_CalDav_SabreAttachProperty';
242         
243         $this->decorator->initCalendarImport();
244         
245         $defaultCalendarsName = $this->_getDefaultCalendarsName();
246         
247         if (Tinebase_Core::isLogLevel(Zend_Log::DEBUG)) Tinebase_Core::getLogger()->debug(__METHOD__ . ' ' . __LINE__
248             . ' Calendar uris to import: ' . print_r(array_keys($this->calendars), true));
249         if (Tinebase_Core::isLogLevel(Zend_Log::TRACE)) Tinebase_Core::getLogger()->trace(__METHOD__ . ' ' . __LINE__
250             . ' Calendars to import: ' . print_r($this->calendars, true));
251         
252         foreach ($this->calendars as $calUri => $cal) {
253             $container = $this->findContainerForCalendar($calUri, $cal['displayname'], $defaultCalendarsName);
254             
255             $this->decorator->setCalendarProperties($container, $this->calendars[$calUri]);
256             
257             $grants = $this->getCalendarGrants($calUri);
258             Tinebase_Container::getInstance()->setGrants($container->getId(), $grants, TRUE, FALSE);
259         }
260     }
261     
262     /**
263      * decide which calendar to use as default calendar
264      * if there is a remote default calendar, use that. If not, use the first we find
265      * 
266      * @return string
267      */
268     protected function _getDefaultCalendarsName() 
269     {
270         $defaultCalendarsName = '';
271         foreach ($this->calendarICSs as $calUri => $calICSs) {
272             if ($this->mapToDefaultContainer == $this->calendars[$calUri]['displayname']) {
273                 return $this->calendars[$calUri]['displayname'];
274             } elseif ($defaultCalendarsName === '') {
275                 $defaultCalendarsName = $this->calendars[$calUri]['displayname'];
276             }
277         }
278         return $defaultCalendarsName;
279     }
280     
281     /**
282      * 
283      * @param string $onlyCurrentUserOrganizer
284      * @return boolean
285      */
286     public function updateAllCalendarData($onlyCurrentUserOrganizer = false)
287     {
288         if (count($this->calendarICSs) < 1 && ! $this->findAllCalendarICSs()) {
289             if (Tinebase_Core::isLogLevel(Zend_Log::INFO))
290                 Tinebase_Core::getLogger()->info(__METHOD__ . '::' . __LINE__ . ' no calendars found for: ' . $this->userName);
291             return false;
292         }
293         
294         $newICSs = array();
295         $newEventCount = 0;
296         $updateEventCount = 0;
297         $deleteEventCount = 0;
298         
299         if (Tinebase_Core::isLogLevel(Zend_Log::INFO)) Tinebase_Core::getLogger()->info(__METHOD__ . '::' . __LINE__
300                 . ' Looking for updates in ' . count($this->calendarICSs). ' calendars ...');
301         
302         // @todo move to a member variable
303         $recordBackend = Tinebase_Core::getApplicationInstance($this->appName, $this->modelName)->getBackend();
304         
305         foreach ($this->calendarICSs as $calUri => $calICSs) {
306             $updateResult = $this->updateCalendar($calUri, $calICSs, $recordBackend);
307             if (count($updateResult['ics']) > 0) {
308                 $newICSs[$calUri] = $updateResult['ics'];
309             }
310             
311             if (! empty($updateResult['todelete'])) {
312                 if (Tinebase_Core::isLogLevel(Zend_Log::INFO)) Tinebase_Core::getLogger()->info(__METHOD__ . '::' . __LINE__ . ' '
313                         . ' Deleting ' . count($updateResult['todelete']) . ' ' . $this->modelName . ' in calendar '  . $calUri);
314                 if (Tinebase_Core::isLogLevel(Zend_Log::TRACE)) Tinebase_Core::getLogger()->trace(__METHOD__ . '::' . __LINE__ . ' '
315                         . ' ' . print_r($updateResult['todelete'], true));
316                 
317                 $recordBackend->delete($updateResult['todelete']);
318             }
319             
320             $newEventCount += $updateResult['toadd'];
321             $updateEventCount += $updateResult['toupdate'];
322             $deleteEventCount += count($updateResult['todelete']);
323         }
324         
325         if (($count = count($newICSs)) > 0) {
326             if (Tinebase_Core::isLogLevel(Zend_Log::INFO)) Tinebase_Core::getLogger()->info(__METHOD__ . '::' . __LINE__ . ' ' 
327                     . $count . ' calendar(s) changed for: ' . $this->userName
328                     . ' (' . $newEventCount . '/' . $updateEventCount . '/' . $deleteEventCount . ' records add/update/delete): '
329                     . print_r(array_keys($newICSs), true));
330             if (Tinebase_Core::isLogLevel(Zend_Log::TRACE)) Tinebase_Core::getLogger()->trace(__METHOD__ . '::' . __LINE__ . ' ' 
331                     . 'Events changed: ' . print_r($newICSs, true));
332             
333             $this->calendarICSs = $newICSs;
334             $this->importAllCalendarData($onlyCurrentUserOrganizer, /* $update = */ true);
335         } else {
336             if (Tinebase_Core::isLogLevel(Zend_Log::NOTICE))
337                 Tinebase_Core::getLogger()->notice(__METHOD__ . '::' . __LINE__ . ' no changes found for: ' . $this->userName);
338         }
339     }
340     
341     protected function updateCalendar($calUri, $calICSs, $recordBackend)
342     {
343         $updateResult = array(
344             'ics'       => array(),
345             'toupdate'  => 0,
346             'toadd'     => 0,
347             'todelete'  => array(), // of record ids
348         );
349         
350         $serverEtags = $this->_fetchServerEtags($calUri, $calICSs);
351         
352         // get current tine20 id/etags of records
353         $defaultCalendarsName = $this->_getDefaultCalendarsName();
354         $container = $this->findContainerForCalendar($calUri, $this->calendars[$calUri]['displayname'], $defaultCalendarsName);
355         $containerEtags = $recordBackend->getEtagsForContainerId($container->getId());
356         
357         if (Tinebase_Core::isLogLevel(Zend_Log::DEBUG)) Tinebase_Core::getLogger()->debug(__METHOD__ . '::' . __LINE__ . ' '
358                 . ' Got ' . count($serverEtags) . ' server etags for container ' . $container->name);
359         if (Tinebase_Core::isLogLevel(Zend_Log::TRACE)) Tinebase_Core::getLogger()->trace(__METHOD__ . '::' . __LINE__ . ' '
360                 . ' server etags: ' . print_r($serverEtags, true));
361         if (Tinebase_Core::isLogLevel(Zend_Log::TRACE)) Tinebase_Core::getLogger()->trace(__METHOD__ . '::' . __LINE__ . ' '
362                 . ' tine20 etags: ' . print_r($containerEtags, true));
363         
364         // handle add/updates
365         foreach ($serverEtags as $ics => $data) {
366             if (isset($containerEtags[$data['id']])) {
367                 $tine20Etag = $containerEtags[$data['id']];
368         
369                 // remove from $containerEtags list to be able to tell deletes
370                 unset($containerEtags[$data['id']]);
371         
372                 if ($tine20Etag == $data['etag']) {
373                     continue; // same
374                 } else if (empty($tine20Etag)) {
375                     // event has been added in tine -> don't overwrite/delete
376                     continue;
377                 } else {
378                     $eventExists = true; // different
379                 }
380             } else {
381                 try {
382                     // might be a delegated event from another container/organizer
383                     $recordBackend->checkETag($data['id'], $data['etag']);
384                     continue; // ignore update here
385                 } catch (Tinebase_Exception_NotFound $tenf) {
386                     $eventExists = false; // new record;
387                 }
388             }
389         
390             if (! isset($this->existingRecordIds[$calUri])) {
391                 if (Tinebase_Core::isLogLevel(Zend_Log::DEBUG)) Tinebase_Core::getLogger()->debug(__METHOD__ . '::' . __LINE__ . ' '
392                         . ' Found changed event(s) for container ' . $container->name);
393         
394                 $this->existingRecordIds[$calUri] = array();
395             }
396             $updateResult['ics'][] = $ics;
397             if ($eventExists) {
398                 $this->existingRecordIds[$calUri][] = $data['id'];
399                 $updateResult['toupdate']++;
400             } else {
401                 $updateResult['toadd']++;
402             }
403         }
404         
405         // handle deletes
406         foreach ($containerEtags as $id => $etag) {
407             if (! empty($etag)) {
408                 // record has been deleted on server
409                 $updateResult['todelete'][] = $id;
410             } else {
411                 if (Tinebase_Core::isLogLevel(Zend_Log::DEBUG)) Tinebase_Core::getLogger()->debug(__METHOD__ . '::' . __LINE__ . ' '
412                         . ' Record has been added in tine: ' . $id);
413             }
414         }
415         
416         return $updateResult;
417     }
418     
419     protected function _fetchServerEtags($calUri, $calICSs)
420     {
421         $start = 0;
422         $max = count($calICSs);
423         
424         $etags = array();
425         do {
426             $requestEnd = '';
427             for ($i = $start; $i < $max && $i < ($this->maxBulkRequest+$start); ++$i) {
428                 $requestEnd .= '  <a:href>' . $calICSs[$i] . "</a:href>\n";
429             }
430             $start = $i;
431             $requestEnd .= '</b:calendar-multiget>';
432             $result = $this->calDavRequest('REPORT', $calUri, self::getEventETagsRequest . $requestEnd, 1);
433         
434             foreach ($result as $key => $value) {
435                 if (isset($value['{DAV:}getetag'])) {
436                     $name = explode('/', $key);
437                     $name = end($name);
438                     $id = $this->_getEventIdFromName($name);
439                     $etags[$key] = array( 'id' => $id, 'etag' => $value['{DAV:}getetag']);
440                 }
441             }
442         } while($start < $max);
443
444         return $etags;
445     }
446     
447     protected function _getEventIdFromName($name)
448     {
449         $id = ($pos = strpos($name, '.')) === false ? $name : substr($name, 0, $pos);
450         if (strlen($id) > 40) {
451             $id = sha1($id);
452         }
453         return $id;
454     }
455     
456     public function importAllCalendarData($onlyCurrentUserOrganizer = false, $update = false)
457     {
458         if (count($this->calendarICSs) < 1 && ! $this->findAllCalendarICSs()) {
459             return false;
460         }
461         
462         if (Tinebase_Core::isLogLevel(Zend_Log::INFO)) Tinebase_Core::getLogger()->info(__METHOD__ . ' ' . __LINE__
463             . ' Importing all calendar data for user ' . $this->userName . ' with ics uris: ' . print_r(array_keys($this->calendarICSs), true));
464         
465         Tinebase_Core::getApplicationInstance($this->appName, $this->modelName)->sendNotifications(false);
466         Tinebase_Core::getApplicationInstance($this->appName, $this->modelName)->useNotes(false);
467         Sabre\VObject\Component\VCalendar::$propertyMap['ATTACH'] = '\\Calendar_Import_CalDav_SabreAttachProperty';
468         
469         $this->decorator->initCalendarImport();
470         
471         $application_id = Tinebase_Application::getInstance()->getApplicationByName($this->appName)->getId();
472         $type = Tinebase_Model_Container::TYPE_PERSONAL;
473         $defaultContainer = Tinebase_Container::getInstance()->getDefaultContainer($this->modelName);
474         
475         $defaultCalendarsName = $this->_getDefaultCalendarsName();
476         
477         foreach ($this->calendarICSs as $calUri => $calICSs) {
478             if (Tinebase_Core::isLogLevel(Zend_Log::INFO)) Tinebase_Core::getLogger()->info(__METHOD__ . ' ' . __LINE__
479                 . ' Processing calendar ' . print_r($this->calendars[$calUri], true));
480             
481             $container = $this->findContainerForCalendar($calUri, $this->calendars[$calUri]['displayname'], $defaultCalendarsName,
482                     $type, $application_id);
483             
484             if (Tinebase_Core::isLogLevel(Zend_Log::TRACE)) Tinebase_Core::getLogger()->trace(__METHOD__ . ' ' . __LINE__
485                     . ' User container: ' . print_r($container->toArray(), true));
486             
487             $this->decorator->setCalendarProperties($container, $this->calendars[$calUri]);
488             
489             // we shouldnt do the grants here as the caldav user file may not contain all users, so setting the grants wont work properly!
490             // use importAllCalendars to have the grants set
491             //$grants = $this->getCalendarGrants($calUri);
492             //Tinebase_Container::getInstance()->setGrants($container->getId(), $grants, TRUE, FALSE);
493             
494             $start = 0;
495             $max = count($calICSs);
496             do {
497                 $etags = array();
498                 $requestEnd = '';
499                 for ($i = $start; $i < $max && $i < ($this->maxBulkRequest+$start); ++$i) {
500                     $requestEnd .= '  <a:href>' . $calICSs[$i] . "</a:href>\n";
501                 }
502                 $start = $i;
503                 $requestEnd .= '</b:calendar-multiget>';
504                 $result = $this->calDavRequest('REPORT', $calUri, self::getAllCalendarDataRequest . $requestEnd, 1);
505                 
506                 foreach ($result as $key => $value) {
507                     if (! isset($value['{urn:ietf:params:xml:ns:caldav}calendar-data'])) {
508                         continue;
509                     }
510                     
511                     $data = $value['{urn:ietf:params:xml:ns:caldav}calendar-data'];
512                     
513                     if (strpos($data, 'BEGIN:' . $this->skipComonent) !== false) {
514                         if (Tinebase_Core::isLogLevel(Zend_Log::INFO))
515                             Tinebase_Core::getLogger()->info(__METHOD__ . '::' . __LINE__ . ' Skipping ' . $this->skipComonent);
516                         continue;
517                     }
518                     
519                     if (Tinebase_Core::isLogLevel(Zend_Log::DEBUG)) Tinebase_Core::getLogger()->debug(__METHOD__ . ' ' . __LINE__
520                             . ' Processing caldav record: ' . $key);
521                     
522                     $name = explode('/', $key);
523                     $name = end($name);
524                     $id = $this->_getEventIdFromName($name);
525                     try {
526                         if ($update && in_array($id, $this->existingRecordIds[$calUri])) {
527                             $webdavFrontend = new $this->webdavFrontend($container, $id);
528                             // @todo move this to separate fn
529                             if ($onlyCurrentUserOrganizer && $this->modelName === 'Calendar_Model_Event') {
530                                 // assert current user is organizer
531                                 if ($webdavFrontend->getRecord()->organizer && $webdavFrontend->getRecord()->organizer == Tinebase_Core::getUser()->contact_id) {
532                                     $webdavFrontend->put($data);
533                                 } else {
534                                     continue;
535                                 }
536                             } else {
537                                 $webdavFrontend->put($data);
538                             }
539                             
540                         } else {
541                             $webdavFrontend = call_user_func_array(array($this->webdavFrontend, 'create'), array(
542                                 $container,
543                                 $name,
544                                 $data,
545                                 $onlyCurrentUserOrganizer
546                             ));
547                         }
548                         
549                         if ($webdavFrontend) {
550                             $etags[$webdavFrontend->getRecord()->getId()] = $value['{DAV:}getetag'];
551                         }
552                     } catch (Exception $e) {
553                         if (Tinebase_Core::isLogLevel(Zend_Log::WARN))
554                             Tinebase_Core::getLogger()->warn(__METHOD__ . '::' . __LINE__ . ' Could not create event from data: ' . $data);
555                         Tinebase_Exception::log($e);
556                     }
557                 }
558                 
559                 $this->_setEtags($etags);
560             } while($start < $max);
561         }
562         return true;
563     }
564     
565     protected function _setEtags($etags)
566     {
567         $recordBackend = Tinebase_Core::getApplicationInstance($this->appName, $this->modelName)->getBackend();
568         $recordBackend->setETags($etags);
569     }
570     
571     /**
572      * get Tine 2.0 group for given principal (by display name)
573      * - result is cached for 1 week
574      * 
575      * @param string $principal
576      * @return null|Tinebase_Model_Group
577      */
578     protected function _getGroupForPrincipal($principal)
579     {
580         $cacheId = convertCacheId('_getGroupForPrincipal' . $principal);
581         if (Tinebase_Core::getCache()->test($cacheId)) {
582             $group = Tinebase_Core::getCache()->load($cacheId);
583             if (Tinebase_Core::isLogLevel(Zend_Log::INFO)) Tinebase_Core::getLogger()->info(__METHOD__ . ' ' . __LINE__
584                     . ' Loading principal group from cache: ' . $group->name);
585             return $group;
586         }
587         
588         $group = null;
589         
590         $result = $this->calDavRequest('PROPFIND', $principal, self::resolvePrincipalRequest);
591         if (count($result['{DAV:}group-member-set']->getPrincipals()) > 0 && isset($result['{DAV:}displayname'])) {
592             $groupDescription = $result['{DAV:}displayname'];
593             try {
594                 $group = Tinebase_Group::getInstance()->getGroupByPropertyFromSqlBackend('description',$groupDescription);
595                 if (Tinebase_Core::isLogLevel(Zend_Log::INFO)) Tinebase_Core::getLogger()->info(__METHOD__ . ' ' . __LINE__
596                         . ' Found matching group ' . $group->name . ' (' . $group->description .') for principal ' . $principal);
597                 Tinebase_Core::getCache()->save($group, $cacheId, array(), /* 1 week */ 24*3600*7);
598             } catch (Tinebase_Exception_Record_NotDefined $ternd) {
599                 if (Tinebase_Core::isLogLevel(Zend_Log::NOTICE)) Tinebase_Core::getLogger()->notice(__METHOD__ . ' ' . __LINE__
600                         . ' Group not found: ' . $groupDescription . ' ' . print_r($result, true));
601             }
602         }
603         
604         return $group;
605     }
606     
607     /**
608      * get grants for cal uri
609      * 
610      * @param string $calUri
611      * @return Tinebase_Record_RecordSet
612      */
613     public function getCalendarGrants($calUri)
614     {
615         $grants = array();
616         $user = array();
617         $type = array();
618         $privilege = array();
619         foreach ($this->calendars[$calUri]['acl']->getPrivileges() as $ace)
620         {
621             if ('{DAV:}authenticated' == $ace['principal']) {
622                 $user[] = 0;
623                 $type[] = Tinebase_Acl_Rights::ACCOUNT_TYPE_ANYONE;
624                 $privilege[] = $ace['privilege'];
625             } elseif (isset($this->principals[$ace['principal']])) {
626                 $user[] = $this->principals[$ace['principal']]->getId();
627                 $type[] = Tinebase_Acl_Rights::ACCOUNT_TYPE_USER;
628                 $privilege[] = $ace['privilege'];
629             } elseif (isset($this->principalGroups[$ace['principal']])) {
630                 foreach($this->principalGroups[$ace['principal']] as $principal) {
631                     if ('{DAV:}authenticated' == $principal) {
632                         $user[] = 0;
633                         $type[] = Tinebase_Acl_Rights::ACCOUNT_TYPE_ANYONE;
634                         $privilege[] = $ace['privilege'];
635                     } elseif (isset($this->principals[$principal])) {
636                         $user[] = $this->principals[$principal]->getId();
637                         $type[] = Tinebase_Acl_Rights::ACCOUNT_TYPE_USER;
638                         $privilege[] = $ace['privilege'];
639                     } else {
640                         $group = $this->_getGroupForPrincipal($principal);
641                         if ($group) {
642                             $user[] = $group->getId();
643                             $type[] = Tinebase_Acl_Rights::ACCOUNT_TYPE_GROUP;
644                             $privilege[] = $ace['privilege'];
645                         } else {
646                             if (Tinebase_Core::isLogLevel(Zend_Log::WARN))
647                                 Tinebase_Core::getLogger()->warn(__METHOD__ . '::' . __LINE__ 
648                                     . ' There is an unresolved principal: ' . $principal . ' in group: ' . $ace['principal']);
649                         }
650                     }
651                 }
652             } else {
653                 if (Tinebase_Core::isLogLevel(Zend_Log::WARN))
654                     Tinebase_Core::getLogger()->warn(__METHOD__ . '::' . __LINE__ . ' Couldn\'t resolve principal: '.$ace['principal']);
655             }
656         }
657         for ($i=0; $i<count($user); ++$i) {
658             switch ($privilege[$i]) {
659                 case '{DAV:}all':
660                     $grants[$user[$i]] = $this->_getAllGrants();
661                     break;
662                 case '{urn:ietf:params:xml:ns:caldav}read-free-busy':
663                     $grants[$user[$i]] = $this->_getFreeBusyGrants();
664                     break;
665                 case '{DAV:}read':
666                     $grants[$user[$i]] = $this->_getReadGrants();
667                     break;
668                 case '{DAV:}write':
669                     $grants[$user[$i]] = $this->_getWriteGrants();
670                     break;
671                 case '{DAV:}read-current-user-privilege-set':
672                     continue;
673                 default:
674                     if (Tinebase_Core::isLogLevel(Zend_Log::WARN))
675                         Tinebase_Core::getLogger()->warn(__METHOD__ . '::' . __LINE__ . ' unknown privilege: ' . $privilege[$i]);
676                     continue;
677             }
678             $grants[$user[$i]]['account_id'] = $user[$i];
679             $grants[$user[$i]]['account_type'] = $type[$i];
680         }
681         
682         if (Tinebase_Core::isLogLevel(Zend_Log::INFO))
683             Tinebase_Core::getLogger()->info(__METHOD__ . '::' . __LINE__ . ' found ' . count($grants) . ' grants for calendar: ' . $calUri);
684         if (Tinebase_Core::isLogLevel(Zend_Log::DEBUG))
685             Tinebase_Core::getLogger()->debug(__METHOD__ . '::' . __LINE__ . ' grants: ' . print_r($grants, true));
686         
687         return new Tinebase_Record_RecordSet('Tinebase_Model_Grants', $grants, TRUE);
688     }
689     
690     protected function _getAllGrants()
691     {
692         return array(
693             Tinebase_Model_Grants::GRANT_READ => true,
694             Tinebase_Model_Grants::GRANT_ADD=> true,
695             Tinebase_Model_Grants::GRANT_EDIT=> true,
696             Tinebase_Model_Grants::GRANT_DELETE=> true,
697             Tinebase_Model_Grants::GRANT_EXPORT=> true,
698             Tinebase_Model_Grants::GRANT_SYNC=> true,
699             Tinebase_Model_Grants::GRANT_ADMIN=> true,
700             Tinebase_Model_Grants::GRANT_FREEBUSY=> true,
701             Tinebase_Model_Grants::GRANT_PRIVATE=> true,
702         );
703     }
704
705     protected function _getFreeBusyGrants()
706     {
707         return array(
708             Tinebase_Model_Grants::GRANT_FREEBUSY=> true,
709         );
710     }
711
712     protected function _getReadGrants()
713     {
714         return array(
715             Tinebase_Model_Grants::GRANT_READ=> true,
716             Tinebase_Model_Grants::GRANT_EXPORT=> true,
717             Tinebase_Model_Grants::GRANT_SYNC=> true,
718             Tinebase_Model_Grants::GRANT_FREEBUSY=> true,
719         );
720     }
721
722     protected function _getWriteGrants()
723     {
724         return array(
725             Tinebase_Model_Grants::GRANT_READ=> true,
726             Tinebase_Model_Grants::GRANT_ADD=> true,
727             Tinebase_Model_Grants::GRANT_EDIT=> true,
728             Tinebase_Model_Grants::GRANT_DELETE=> true,
729         );
730     }
731     
732     public function updateAllCalendarDataForUsers(array $users)
733     {
734         $result = true;
735         // first only update/import events where the current user is also the organizer
736         foreach ($users as $username => $pwd) {
737             $this->clearCurrentUserCalendarData();
738             $this->userName = $username;
739             $this->password = $pwd;
740             if (!$this->updateAllCalendarData(true)) {
741                 $result = false;
742             }
743         }
744         // then update all events again
745         foreach ($users as $username => $pwd) {
746             $this->clearCurrentUserCalendarData();
747             $this->userName = $username;
748             $this->password = $pwd;
749             if (!$this->updateAllCalendarData(false)) {
750                 $result = false;
751             }
752         }
753         return $result;
754     }
755     
756     public function importAllCalendarDataForUsers(array $users)
757     {
758         $result = true;
759         // first only import events where the current user is also the organizer
760         foreach ($users as $username => $pwd) {
761             $this->clearCurrentUserCalendarData();
762             $this->userName = $username;
763             $this->password = $pwd;
764             if (!$this->importAllCalendarData(true)) {
765                 $result = false;
766             }
767         }
768         // then import all events again
769         foreach ($users as $username => $pwd) {
770             $this->clearCurrentUserCalendarData();
771             $this->userName = $username;
772             $this->password = $pwd;
773             if (!$this->importAllCalendarData(false)) {
774                 $result = false;
775             }
776         }
777         return $result;
778     }
779     
780     public function importAllCalendarsForUsers(array $users)
781     {
782         if (!$this->findCurrentUserPrincipalForUsers($users)) {
783             return false;
784         }
785         
786         $result = true;
787         foreach ($users as $username => $pwd) {
788             $this->clearCurrentUserCalendarData();
789             $this->userName = $username;
790             $this->password = $pwd;
791             if (!$this->importAllCalendars()) {
792                 $result = false;
793             }
794         }
795         return $result;
796     }
797     
798     public function clearCurrentUserCalendarData()
799     {
800         $this->clearCurrentUserData();
801         $this->calendars = array();
802         $this->calendarICSs = array();
803     }
804 }