be9bb7ab3e6340ba889a2ea2a28664733f898649
[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                         . ' IDs to delete: ' . print_r($updateResult['todelete'], true));
316                 $deleteEventCount += Calendar_Controller_Event::getInstance()->delete($updateResult['todelete']);
317             }
318             
319             $newEventCount += $updateResult['toadd'];
320             $updateEventCount += $updateResult['toupdate'];
321         }
322         
323         $count = count($newICSs);
324         if (Tinebase_Core::isLogLevel(Zend_Log::INFO)) Tinebase_Core::getLogger()->info(__METHOD__ . '::' . __LINE__ . ' '
325                 . $count . ' calendar(s) changed for: ' . $this->userName
326                 . ' (' . $newEventCount . '/' . $updateEventCount . '/' . $deleteEventCount . ' records add/update/delete): '
327                 . print_r(array_keys($newICSs), true));
328         
329         if ($count > 0) {
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         }
336     }
337     
338     /**
339      * update calendar
340      * 
341      * @param string $calUri
342      * @param array $calICSs
343      * @param Tinebase_Backend_Sql $recordBackend
344      */
345     protected function updateCalendar($calUri, $calICSs, $recordBackend)
346     {
347         $updateResult = array(
348             'ics'       => array(),
349             'toupdate'  => 0,
350             'toadd'     => 0,
351             'todelete'  => array(), // of record ids
352         );
353         
354         $serverEtags = $this->_fetchServerEtags($calUri, $calICSs);
355         
356         // get current tine20 id/etags of records
357         $defaultCalendarsName = $this->_getDefaultCalendarsName();
358         $container = $this->findContainerForCalendar($calUri, $this->calendars[$calUri]['displayname'], $defaultCalendarsName);
359         $containerEtags = $recordBackend->getEtagsForContainerId($container->getId());
360         
361         if (Tinebase_Core::isLogLevel(Zend_Log::DEBUG)) Tinebase_Core::getLogger()->debug(__METHOD__ . '::' . __LINE__ . ' '
362                 . ' Got ' . count($serverEtags) . ' server etags for container ' . $container->name);
363         if (Tinebase_Core::isLogLevel(Zend_Log::TRACE)) Tinebase_Core::getLogger()->trace(__METHOD__ . '::' . __LINE__ . ' '
364                 . ' server etags: ' . print_r($serverEtags, true));
365         if (Tinebase_Core::isLogLevel(Zend_Log::TRACE)) Tinebase_Core::getLogger()->trace(__METHOD__ . '::' . __LINE__ . ' '
366                 . ' tine20 etags: ' . print_r($containerEtags, true));
367         
368         // handle add/updates
369         $existingIds = array();
370         foreach ($serverEtags as $ics => $data) {
371             if (isset($containerEtags[$data['id']])) {
372                 $tine20Etag = $containerEtags[$data['id']]['etag'];
373                 
374                 // remove from $containerEtags list to be able to tell deletes
375                 unset($containerEtags[$data['id']]);
376                 $existingIds[] = $data['id'];
377         
378                 if ($tine20Etag == $data['etag']) {
379                     continue; // same
380                 } else if (empty($tine20Etag)) {
381                     // event has been added in tine -> don't overwrite/delete
382                     continue;
383                 }
384                 // different -> update record
385             } else {
386                 try {
387                     // might be a delegated event from another container/organizer
388                     $recordBackend->checkETag($data['id'], $data['etag']);
389                     continue; // ignore update here
390                 } catch (Tinebase_Exception_NotFound $tenf) {
391                     // new record
392                 }
393             }
394         
395             if (! isset($this->existingRecordIds[$calUri])) {
396                 if (Tinebase_Core::isLogLevel(Zend_Log::DEBUG)) Tinebase_Core::getLogger()->debug(__METHOD__ . '::' . __LINE__ . ' '
397                         . ' Found changed event(s) for container ' . $container->name);
398         
399                 $this->existingRecordIds[$calUri] = array();
400             }
401             
402             $updateResult['ics'][] = $ics;
403             if (in_array($data['id'], $existingIds)) {
404                 $this->existingRecordIds[$calUri][] = $data['id'];
405                 $updateResult['toupdate']++;
406             } else {
407                 $updateResult['toadd']++;
408             }
409         }
410         
411         // handle deletes/exdates
412         foreach ($containerEtags as $id => $data) {
413             if (in_array($data['uid'], $existingIds)) {
414                 if (Tinebase_Core::isLogLevel(Zend_Log::DEBUG)) Tinebase_Core::getLogger()->debug(__METHOD__ . '::' . __LINE__ . ' '
415                         . ' Record ' . $id . ' is exdate of ' . $data['uid']);
416                 continue;
417             }
418             if (! empty($data['etag'])) {
419                 // record has been deleted on server
420                 $updateResult['todelete'][] = $id;
421             } else {
422                 if (Tinebase_Core::isLogLevel(Zend_Log::DEBUG)) Tinebase_Core::getLogger()->debug(__METHOD__ . '::' . __LINE__ . ' '
423                         . ' Record has been added in tine: ' . $id);
424             }
425         }
426         
427         return $updateResult;
428     }
429     
430     protected function _fetchServerEtags($calUri, $calICSs)
431     {
432         $start = 0;
433         $max = count($calICSs);
434         
435         $etags = array();
436         do {
437             $requestEnd = '';
438             for ($i = $start; $i < $max && $i < ($this->maxBulkRequest+$start); ++$i) {
439                 $requestEnd .= '  <a:href>' . $calICSs[$i] . "</a:href>\n";
440             }
441             $start = $i;
442             $requestEnd .= '</b:calendar-multiget>';
443             $result = $this->calDavRequest('REPORT', $calUri, self::getEventETagsRequest . $requestEnd, 1);
444         
445             foreach ($result as $key => $value) {
446                 if (isset($value['{DAV:}getetag'])) {
447                     $name = explode('/', $key);
448                     $name = end($name);
449                     $id = $this->_getEventIdFromName($name);
450                     $etags[$key] = array( 'id' => $id, 'etag' => $value['{DAV:}getetag']);
451                 }
452             }
453         } while($start < $max);
454
455         return $etags;
456     }
457     
458     protected function _getEventIdFromName($name)
459     {
460         $id = ($pos = strpos($name, '.')) === false ? $name : substr($name, 0, $pos);
461         if (strlen($id) > 40) {
462             $id = sha1($id);
463         }
464         return $id;
465     }
466     
467     public function importAllCalendarData($onlyCurrentUserOrganizer = false, $update = false)
468     {
469         if (count($this->calendarICSs) < 1 && ! $this->findAllCalendarICSs()) {
470             return false;
471         }
472         
473         if (Tinebase_Core::isLogLevel(Zend_Log::INFO)) Tinebase_Core::getLogger()->info(__METHOD__ . ' ' . __LINE__
474             . ' Importing all calendar data for user ' . $this->userName . ' with ics uris: ' . print_r(array_keys($this->calendarICSs), true));
475         
476         Tinebase_Core::getApplicationInstance($this->appName, $this->modelName)->sendNotifications(false);
477         Tinebase_Core::getApplicationInstance($this->appName, $this->modelName)->useNotes(false);
478         Sabre\VObject\Component\VCalendar::$propertyMap['ATTACH'] = '\\Calendar_Import_CalDav_SabreAttachProperty';
479         
480         $this->decorator->initCalendarImport();
481         
482         $application_id = Tinebase_Application::getInstance()->getApplicationByName($this->appName)->getId();
483         $type = Tinebase_Model_Container::TYPE_PERSONAL;
484         $defaultContainer = Tinebase_Container::getInstance()->getDefaultContainer($this->modelName);
485         
486         $defaultCalendarsName = $this->_getDefaultCalendarsName();
487         
488         foreach ($this->calendarICSs as $calUri => $calICSs) {
489             if (Tinebase_Core::isLogLevel(Zend_Log::INFO)) Tinebase_Core::getLogger()->info(__METHOD__ . ' ' . __LINE__
490                 . ' Processing calendar ' . print_r($this->calendars[$calUri], true));
491             
492             $container = $this->findContainerForCalendar($calUri, $this->calendars[$calUri]['displayname'], $defaultCalendarsName,
493                     $type, $application_id);
494             
495             if (Tinebase_Core::isLogLevel(Zend_Log::TRACE)) Tinebase_Core::getLogger()->trace(__METHOD__ . ' ' . __LINE__
496                     . ' User container: ' . print_r($container->toArray(), true));
497             
498             $this->decorator->setCalendarProperties($container, $this->calendars[$calUri]);
499             
500             // we shouldnt do the grants here as the caldav user file may not contain all users, so setting the grants wont work properly!
501             // use importAllCalendars to have the grants set
502             //$grants = $this->getCalendarGrants($calUri);
503             //Tinebase_Container::getInstance()->setGrants($container->getId(), $grants, TRUE, FALSE);
504             
505             $start = 0;
506             $max = count($calICSs);
507             do {
508                 $etags = array();
509                 $requestEnd = '';
510                 for ($i = $start; $i < $max && $i < ($this->maxBulkRequest+$start); ++$i) {
511                     $requestEnd .= '  <a:href>' . $calICSs[$i] . "</a:href>\n";
512                 }
513                 $start = $i;
514                 $requestEnd .= '</b:calendar-multiget>';
515                 $result = $this->calDavRequest('REPORT', $calUri, self::getAllCalendarDataRequest . $requestEnd, 1);
516                 
517                 foreach ($result as $key => $value) {
518                     if (! isset($value['{urn:ietf:params:xml:ns:caldav}calendar-data'])) {
519                         continue;
520                     }
521                     
522                     $data = $value['{urn:ietf:params:xml:ns:caldav}calendar-data'];
523                     
524                     if (strpos($data, 'BEGIN:' . $this->skipComonent) !== false) {
525                         if (Tinebase_Core::isLogLevel(Zend_Log::INFO))
526                             Tinebase_Core::getLogger()->info(__METHOD__ . '::' . __LINE__ . ' Skipping ' . $this->skipComonent);
527                         continue;
528                     }
529                     
530                     if (Tinebase_Core::isLogLevel(Zend_Log::DEBUG)) Tinebase_Core::getLogger()->debug(__METHOD__ . ' ' . __LINE__
531                             . ' Processing caldav record: ' . $key);
532                     
533                     $name = explode('/', $key);
534                     $name = end($name);
535                     $id = $this->_getEventIdFromName($name);
536                     try {
537                         if ($update && in_array($id, $this->existingRecordIds[$calUri])) {
538                             $webdavFrontend = new $this->webdavFrontend($container, $id);
539                             // @todo move this to separate fn
540                             if ($onlyCurrentUserOrganizer && $this->modelName === 'Calendar_Model_Event') {
541                                 // assert current user is organizer
542                                 if ($webdavFrontend->getRecord()->organizer && $webdavFrontend->getRecord()->organizer == Tinebase_Core::getUser()->contact_id) {
543                                     $webdavFrontend->put($data);
544                                 } else {
545                                     continue;
546                                 }
547                             } else {
548                                 $webdavFrontend->put($data);
549                             }
550                             
551                         } else {
552                             $webdavFrontend = call_user_func_array(array($this->webdavFrontend, 'create'), array(
553                                 $container,
554                                 $name,
555                                 $data,
556                                 $onlyCurrentUserOrganizer
557                             ));
558                         }
559                         
560                         if ($webdavFrontend) {
561                             $etags[$webdavFrontend->getRecord()->getId()] = $value['{DAV:}getetag'];
562                         }
563                     } catch (Exception $e) {
564                         if (Tinebase_Core::isLogLevel(Zend_Log::WARN))
565                             Tinebase_Core::getLogger()->warn(__METHOD__ . '::' . __LINE__ . ' Could not create event from data: ' . $data);
566                         Tinebase_Exception::log($e, /* $suppressTrace = */ false);
567                     }
568                 }
569                 
570                 $this->_setEtags($etags);
571             } while($start < $max);
572         }
573         return true;
574     }
575     
576     protected function _setEtags($etags)
577     {
578         $recordBackend = Tinebase_Core::getApplicationInstance($this->appName, $this->modelName)->getBackend();
579         $recordBackend->setETags($etags);
580     }
581     
582     /**
583      * get Tine 2.0 group for given principal (by display name)
584      * - result is cached for 1 week
585      * 
586      * @param string $principal
587      * @return null|Tinebase_Model_Group
588      */
589     protected function _getGroupForPrincipal($principal)
590     {
591         $cacheId = convertCacheId('_getGroupForPrincipal' . $principal);
592         if (Tinebase_Core::getCache()->test($cacheId)) {
593             $group = Tinebase_Core::getCache()->load($cacheId);
594             if (Tinebase_Core::isLogLevel(Zend_Log::INFO)) Tinebase_Core::getLogger()->info(__METHOD__ . ' ' . __LINE__
595                     . ' Loading principal group from cache: ' . $group->name);
596             return $group;
597         }
598         
599         $group = null;
600         
601         $result = $this->calDavRequest('PROPFIND', $principal, self::resolvePrincipalRequest);
602         if (count($result['{DAV:}group-member-set']->getPrincipals()) > 0 && isset($result['{DAV:}displayname'])) {
603             $groupDescription = $result['{DAV:}displayname'];
604             try {
605                 $group = Tinebase_Group::getInstance()->getGroupByPropertyFromSqlBackend('description',$groupDescription);
606                 if (Tinebase_Core::isLogLevel(Zend_Log::INFO)) Tinebase_Core::getLogger()->info(__METHOD__ . ' ' . __LINE__
607                         . ' Found matching group ' . $group->name . ' (' . $group->description .') for principal ' . $principal);
608                 Tinebase_Core::getCache()->save($group, $cacheId, array(), /* 1 week */ 24*3600*7);
609             } catch (Tinebase_Exception_Record_NotDefined $ternd) {
610                 if (Tinebase_Core::isLogLevel(Zend_Log::NOTICE)) Tinebase_Core::getLogger()->notice(__METHOD__ . ' ' . __LINE__
611                         . ' Group not found: ' . $groupDescription . ' ' . print_r($result, true));
612             }
613         }
614         
615         return $group;
616     }
617     
618     /**
619      * get grants for cal uri
620      * 
621      * @param string $calUri
622      * @return Tinebase_Record_RecordSet
623      */
624     public function getCalendarGrants($calUri)
625     {
626         $grants = array();
627         $user = array();
628         $type = array();
629         $privilege = array();
630         foreach ($this->calendars[$calUri]['acl']->getPrivileges() as $ace)
631         {
632             if ('{DAV:}authenticated' == $ace['principal']) {
633                 $user[] = 0;
634                 $type[] = Tinebase_Acl_Rights::ACCOUNT_TYPE_ANYONE;
635                 $privilege[] = $ace['privilege'];
636             } elseif (isset($this->principals[$ace['principal']])) {
637                 $user[] = $this->principals[$ace['principal']]->getId();
638                 $type[] = Tinebase_Acl_Rights::ACCOUNT_TYPE_USER;
639                 $privilege[] = $ace['privilege'];
640             } elseif (isset($this->principalGroups[$ace['principal']])) {
641                 foreach($this->principalGroups[$ace['principal']] as $principal) {
642                     if ('{DAV:}authenticated' == $principal) {
643                         $user[] = 0;
644                         $type[] = Tinebase_Acl_Rights::ACCOUNT_TYPE_ANYONE;
645                         $privilege[] = $ace['privilege'];
646                     } elseif (isset($this->principals[$principal])) {
647                         $user[] = $this->principals[$principal]->getId();
648                         $type[] = Tinebase_Acl_Rights::ACCOUNT_TYPE_USER;
649                         $privilege[] = $ace['privilege'];
650                     } else {
651                         $group = $this->_getGroupForPrincipal($principal);
652                         if ($group) {
653                             $user[] = $group->getId();
654                             $type[] = Tinebase_Acl_Rights::ACCOUNT_TYPE_GROUP;
655                             $privilege[] = $ace['privilege'];
656                         } else {
657                             if (Tinebase_Core::isLogLevel(Zend_Log::WARN))
658                                 Tinebase_Core::getLogger()->warn(__METHOD__ . '::' . __LINE__ 
659                                     . ' There is an unresolved principal: ' . $principal . ' in group: ' . $ace['principal']);
660                         }
661                     }
662                 }
663             } else {
664                 if (Tinebase_Core::isLogLevel(Zend_Log::WARN))
665                     Tinebase_Core::getLogger()->warn(__METHOD__ . '::' . __LINE__ . ' Couldn\'t resolve principal: '.$ace['principal']);
666             }
667         }
668         for ($i=0; $i<count($user); ++$i) {
669             switch ($privilege[$i]) {
670                 case '{DAV:}all':
671                     $grants[$user[$i]] = $this->_getAllGrants();
672                     break;
673                 case '{urn:ietf:params:xml:ns:caldav}read-free-busy':
674                     $grants[$user[$i]] = $this->_getFreeBusyGrants();
675                     break;
676                 case '{DAV:}read':
677                     $grants[$user[$i]] = $this->_getReadGrants();
678                     break;
679                 case '{DAV:}write':
680                     $grants[$user[$i]] = $this->_getWriteGrants();
681                     break;
682                 case '{DAV:}read-current-user-privilege-set':
683                     continue;
684                 default:
685                     if (Tinebase_Core::isLogLevel(Zend_Log::WARN))
686                         Tinebase_Core::getLogger()->warn(__METHOD__ . '::' . __LINE__ . ' unknown privilege: ' . $privilege[$i]);
687                     continue;
688             }
689             $grants[$user[$i]]['account_id'] = $user[$i];
690             $grants[$user[$i]]['account_type'] = $type[$i];
691         }
692         
693         if (Tinebase_Core::isLogLevel(Zend_Log::INFO))
694             Tinebase_Core::getLogger()->info(__METHOD__ . '::' . __LINE__ . ' found ' . count($grants) . ' grants for calendar: ' . $calUri);
695         if (Tinebase_Core::isLogLevel(Zend_Log::DEBUG))
696             Tinebase_Core::getLogger()->debug(__METHOD__ . '::' . __LINE__ . ' grants: ' . print_r($grants, true));
697         
698         return new Tinebase_Record_RecordSet('Tinebase_Model_Grants', $grants, TRUE);
699     }
700     
701     protected function _getAllGrants()
702     {
703         return array(
704             Tinebase_Model_Grants::GRANT_READ => true,
705             Tinebase_Model_Grants::GRANT_ADD=> true,
706             Tinebase_Model_Grants::GRANT_EDIT=> true,
707             Tinebase_Model_Grants::GRANT_DELETE=> true,
708             Tinebase_Model_Grants::GRANT_EXPORT=> true,
709             Tinebase_Model_Grants::GRANT_SYNC=> true,
710             Tinebase_Model_Grants::GRANT_ADMIN=> true,
711             Tinebase_Model_Grants::GRANT_FREEBUSY=> true,
712             Tinebase_Model_Grants::GRANT_PRIVATE=> true,
713         );
714     }
715
716     protected function _getFreeBusyGrants()
717     {
718         return array(
719             Tinebase_Model_Grants::GRANT_FREEBUSY=> true,
720         );
721     }
722
723     protected function _getReadGrants()
724     {
725         return array(
726             Tinebase_Model_Grants::GRANT_READ=> true,
727             Tinebase_Model_Grants::GRANT_EXPORT=> true,
728             Tinebase_Model_Grants::GRANT_SYNC=> true,
729             Tinebase_Model_Grants::GRANT_FREEBUSY=> true,
730         );
731     }
732
733     protected function _getWriteGrants()
734     {
735         return array(
736             Tinebase_Model_Grants::GRANT_READ=> true,
737             Tinebase_Model_Grants::GRANT_ADD=> true,
738             Tinebase_Model_Grants::GRANT_EDIT=> true,
739             Tinebase_Model_Grants::GRANT_DELETE=> true,
740         );
741     }
742     
743     public function updateAllCalendarDataForUsers(array $users)
744     {
745         $result = true;
746         // first only update/import events where the current user is also the organizer
747         foreach ($users as $username => $pwd) {
748             $this->clearCurrentUserCalendarData();
749             $this->userName = $username;
750             $this->password = $pwd;
751             if (!$this->updateAllCalendarData(true)) {
752                 $result = false;
753             }
754         }
755         // then update all events again
756         foreach ($users as $username => $pwd) {
757             $this->clearCurrentUserCalendarData();
758             $this->userName = $username;
759             $this->password = $pwd;
760             if (!$this->updateAllCalendarData(false)) {
761                 $result = false;
762             }
763         }
764         return $result;
765     }
766     
767     public function importAllCalendarDataForUsers(array $users)
768     {
769         $result = true;
770         // first only import events where the current user is also the organizer
771         foreach ($users as $username => $pwd) {
772             $this->clearCurrentUserCalendarData();
773             $this->userName = $username;
774             $this->password = $pwd;
775             if (!$this->importAllCalendarData(true)) {
776                 $result = false;
777             }
778         }
779         // then import all events again
780         foreach ($users as $username => $pwd) {
781             $this->clearCurrentUserCalendarData();
782             $this->userName = $username;
783             $this->password = $pwd;
784             if (!$this->importAllCalendarData(false)) {
785                 $result = false;
786             }
787         }
788         return $result;
789     }
790     
791     public function importAllCalendarsForUsers(array $users)
792     {
793         if (!$this->findCurrentUserPrincipalForUsers($users)) {
794             return false;
795         }
796         
797         $result = true;
798         foreach ($users as $username => $pwd) {
799             $this->clearCurrentUserCalendarData();
800             $this->userName = $username;
801             $this->password = $pwd;
802             if (!$this->importAllCalendars()) {
803                 $result = false;
804             }
805         }
806         return $result;
807     }
808     
809     public function clearCurrentUserCalendarData()
810     {
811         $this->clearCurrentUserData();
812         $this->calendars = array();
813         $this->calendarICSs = array();
814     }
815 }