xref: /plugin/davcal/helper.php (revision 39787131de02ad610a5dcee81e17cdb502b3b58f)
1a1a3b679SAndreas Boehler<?php
2a1a3b679SAndreas Boehler/**
3cb71a62aSAndreas Boehler  * Helper Class for the DAVCal plugin
4a1a3b679SAndreas Boehler  * This helper does the actual work.
5a1a3b679SAndreas Boehler  *
6a1a3b679SAndreas Boehler  */
7a1a3b679SAndreas Boehler
8a1a3b679SAndreas Boehler// must be run within Dokuwiki
9a1a3b679SAndreas Boehlerif(!defined('DOKU_INC')) die();
10a1a3b679SAndreas Boehler
11a1a3b679SAndreas Boehlerclass helper_plugin_davcal extends DokuWiki_Plugin {
12a1a3b679SAndreas Boehler
13a1a3b679SAndreas Boehler  protected $sqlite = null;
14185e2535SAndreas Boehler  protected $cachedValues = array();
15a1a3b679SAndreas Boehler
16a1a3b679SAndreas Boehler  /**
17cb71a62aSAndreas Boehler    * Constructor to load the configuration and the SQLite plugin
18a1a3b679SAndreas Boehler    */
19a1a3b679SAndreas Boehler  public function helper_plugin_davcal() {
20a1a3b679SAndreas Boehler    $this->sqlite =& plugin_load('helper', 'sqlite');
2121d04f73SAndreas Boehler    global $conf;
2221d04f73SAndreas Boehler    dbglog('---- DAVCAL helper.php init');
23a1a3b679SAndreas Boehler    if(!$this->sqlite)
24a1a3b679SAndreas Boehler    {
2521d04f73SAndreas Boehler        dbglog('This plugin requires the sqlite plugin. Please install it.');
26a1a3b679SAndreas Boehler        msg('This plugin requires the sqlite plugin. Please install it.');
27a1a3b679SAndreas Boehler        return;
28a1a3b679SAndreas Boehler    }
29a1a3b679SAndreas Boehler
30a1a3b679SAndreas Boehler    if(!$this->sqlite->init('davcal', DOKU_PLUGIN.'davcal/db/'))
31a1a3b679SAndreas Boehler    {
3221d04f73SAndreas Boehler        dbglog('Error initialising the SQLite DB for DAVCal');
33a1a3b679SAndreas Boehler        return;
34a1a3b679SAndreas Boehler    }
35a1a3b679SAndreas Boehler  }
36a1a3b679SAndreas Boehler
37cb71a62aSAndreas Boehler  /**
38185e2535SAndreas Boehler   * Retrieve meta data for a given page
39185e2535SAndreas Boehler   *
40185e2535SAndreas Boehler   * @param string $id optional The page ID
41185e2535SAndreas Boehler   * @return array The metadata
42185e2535SAndreas Boehler   */
43185e2535SAndreas Boehler  private function getMeta($id = null) {
44185e2535SAndreas Boehler    global $ID;
45185e2535SAndreas Boehler    global $INFO;
46185e2535SAndreas Boehler
47185e2535SAndreas Boehler    if ($id === null) $id = $ID;
48185e2535SAndreas Boehler
49185e2535SAndreas Boehler    if($ID === $id && $INFO['meta']) {
50185e2535SAndreas Boehler        $meta = $INFO['meta'];
51185e2535SAndreas Boehler    } else {
52185e2535SAndreas Boehler        $meta = p_get_metadata($id);
53185e2535SAndreas Boehler    }
54185e2535SAndreas Boehler
55185e2535SAndreas Boehler    return $meta;
56185e2535SAndreas Boehler  }
57185e2535SAndreas Boehler
58185e2535SAndreas Boehler  /**
59185e2535SAndreas Boehler   * Retrieve the meta data for a given page
60185e2535SAndreas Boehler   *
61185e2535SAndreas Boehler   * @param string $id optional The page ID
62185e2535SAndreas Boehler   * @return array with meta data
63185e2535SAndreas Boehler   */
64185e2535SAndreas Boehler  public function getCalendarMetaForPage($id = null)
65185e2535SAndreas Boehler  {
66185e2535SAndreas Boehler      if(is_null($id))
67185e2535SAndreas Boehler      {
68185e2535SAndreas Boehler          global $ID;
69185e2535SAndreas Boehler          $id = $ID;
70185e2535SAndreas Boehler      }
71185e2535SAndreas Boehler
72185e2535SAndreas Boehler      $meta = $this->getMeta($id);
73185e2535SAndreas Boehler      if(isset($meta['plugin_davcal']))
74185e2535SAndreas Boehler        return $meta['plugin_davcal'];
75185e2535SAndreas Boehler      else
76185e2535SAndreas Boehler        return array();
77185e2535SAndreas Boehler  }
78185e2535SAndreas Boehler
79185e2535SAndreas Boehler  /**
80d71c9934SAndreas Boehler   * Check the permission of a user for a given calendar ID
81d71c9934SAndreas Boehler   *
82d71c9934SAndreas Boehler   * @param string $id The calendar ID to check
83d71c9934SAndreas Boehler   * @return int AUTH_* constants
84d71c9934SAndreas Boehler   */
85d71c9934SAndreas Boehler  public function checkCalendarPermission($id)
86d71c9934SAndreas Boehler  {
87d71c9934SAndreas Boehler      if(strpos($page, 'webdav://') === 0)
88d71c9934SAndreas Boehler      {
89d71c9934SAndreas Boehler          $wdc =& plugin_load('helper', 'webdavclient');
90d71c9934SAndreas Boehler          if(is_null($wdc))
91d71c9934SAndreas Boehler            return AUTH_NONE;
92d71c9934SAndreas Boehler          $connectionId = str_replace('webdav://', '', $page);
93d71c9934SAndreas Boehler          $settings = $wdc->getConnection($connectionId);
94d71c9934SAndreas Boehler          if($settings === false)
95d71c9934SAndreas Boehler            return AUTH_NONE;
96d71c9934SAndreas Boehler          if($settings['write'] === '1')
97d71c9934SAndreas Boehler            return AUTH_CREATE;
98d71c9934SAndreas Boehler          return AUTH_READ;
99d71c9934SAndreas Boehler      }
100d71c9934SAndreas Boehler      else
101d71c9934SAndreas Boehler      {
102d71c9934SAndreas Boehler          $calid = $this->getCalendarIdForPage($id);
103d71c9934SAndreas Boehler          // We return AUTH_READ if the calendar does not exist. This makes
104d71c9934SAndreas Boehler          // davcal happy when there are just included calendars
105d71c9934SAndreas Boehler          if($calid === false)
106d71c9934SAndreas Boehler            return AUTH_READ;
107d71c9934SAndreas Boehler          return auth_quickaclcheck($id);
108d71c9934SAndreas Boehler      }
109d71c9934SAndreas Boehler  }
110d71c9934SAndreas Boehler
111d71c9934SAndreas Boehler  /**
11280e1ddf7SAndreas Boehler   * Filter calendar pages and return only those where the current
11380e1ddf7SAndreas Boehler   * user has at least read permission.
11480e1ddf7SAndreas Boehler   *
11580e1ddf7SAndreas Boehler   * @param array $calendarPages Array with calendar pages to check
11680e1ddf7SAndreas Boehler   * @return array with filtered calendar pages
11780e1ddf7SAndreas Boehler   */
11880e1ddf7SAndreas Boehler  public function filterCalendarPagesByUserPermission($calendarPages)
11980e1ddf7SAndreas Boehler  {
12080e1ddf7SAndreas Boehler      $retList = array();
12180e1ddf7SAndreas Boehler      foreach($calendarPages as $page => $data)
12280e1ddf7SAndreas Boehler      {
1230b805092SAndreas Boehler          // WebDAV Connections are always readable
1240b805092SAndreas Boehler          if(strpos($page, 'webdav://') === 0)
1250b805092SAndreas Boehler          {
1260b805092SAndreas Boehler              $retList[$page] = $data;
1270b805092SAndreas Boehler          }
1280b805092SAndreas Boehler          elseif(auth_quickaclcheck($page) >= AUTH_READ)
12980e1ddf7SAndreas Boehler          {
13080e1ddf7SAndreas Boehler              $retList[$page] = $data;
13180e1ddf7SAndreas Boehler          }
13280e1ddf7SAndreas Boehler      }
13380e1ddf7SAndreas Boehler      return $retList;
13480e1ddf7SAndreas Boehler  }
13580e1ddf7SAndreas Boehler
13680e1ddf7SAndreas Boehler  /**
137185e2535SAndreas Boehler   * Get all calendar pages used by a given page
138185e2535SAndreas Boehler   * based on the stored metadata
139185e2535SAndreas Boehler   *
140185e2535SAndreas Boehler   * @param string $id optional The page id
141185e2535SAndreas Boehler   * @return mixed The pages as array or false
142185e2535SAndreas Boehler   */
143185e2535SAndreas Boehler  public function getCalendarPagesByMeta($id = null)
144185e2535SAndreas Boehler  {
145185e2535SAndreas Boehler      if(is_null($id))
146185e2535SAndreas Boehler      {
147185e2535SAndreas Boehler          global $ID;
148185e2535SAndreas Boehler          $id = $ID;
149185e2535SAndreas Boehler      }
150185e2535SAndreas Boehler
151185e2535SAndreas Boehler      $meta = $this->getCalendarMetaForPage($id);
1520b805092SAndreas Boehler
153185e2535SAndreas Boehler      if(isset($meta['id']))
154ed764890SAndreas Boehler      {
155ed764890SAndreas Boehler          // Filter the list of pages by permission
15680e1ddf7SAndreas Boehler          $pages = $this->filterCalendarPagesByUserPermission($meta['id']);
15780e1ddf7SAndreas Boehler          if(empty($pages))
158ed764890SAndreas Boehler            return false;
15980e1ddf7SAndreas Boehler          return $pages;
160ed764890SAndreas Boehler      }
161185e2535SAndreas Boehler      return false;
162185e2535SAndreas Boehler  }
163185e2535SAndreas Boehler
164185e2535SAndreas Boehler  /**
165185e2535SAndreas Boehler   * Get a list of calendar names/pages/ids/colors
166185e2535SAndreas Boehler   * for an array of page ids
167185e2535SAndreas Boehler   *
168185e2535SAndreas Boehler   * @param array $calendarPages The calendar pages to retrieve
169185e2535SAndreas Boehler   * @return array The list
170185e2535SAndreas Boehler   */
171185e2535SAndreas Boehler  public function getCalendarMapForIDs($calendarPages)
172185e2535SAndreas Boehler  {
173185e2535SAndreas Boehler      $data = array();
1744a2bf5eeSAndreas Boehler      foreach($calendarPages as $page => $color)
175185e2535SAndreas Boehler      {
1760b805092SAndreas Boehler            if(strpos($page, 'webdav://') === 0)
1770b805092SAndreas Boehler            {
1780b805092SAndreas Boehler                $wdc =& plugin_load('helper', 'webdavclient');
1790b805092SAndreas Boehler                if(is_null($wdc))
1800b805092SAndreas Boehler                    continue;
1810b805092SAndreas Boehler                $connectionId = str_replace('webdav://', '', $page);
1820b805092SAndreas Boehler                $settings = $wdc->getConnection($connectionId);
1832393a702SAndreas Boehler                if($settings === false)
1842393a702SAndreas Boehler                    continue;
1850b805092SAndreas Boehler                $name = $settings['displayname'];
186d71c9934SAndreas Boehler                $write = ($settings['write'] === '1');
1870b805092SAndreas Boehler                $calid = $connectionId;
188cd2f100dSAndreas Boehler                $color = '#3a87ad';
1890b805092SAndreas Boehler            }
1900b805092SAndreas Boehler            else
1910b805092SAndreas Boehler            {
192185e2535SAndreas Boehler                $calid = $this->getCalendarIdForPage($page);
193185e2535SAndreas Boehler                if($calid !== false)
194185e2535SAndreas Boehler                {
195185e2535SAndreas Boehler                    $settings = $this->getCalendarSettings($calid);
196185e2535SAndreas Boehler                    $name = $settings['displayname'];
197cd2f100dSAndreas Boehler                    $color = $settings['calendarcolor'];
198ed764890SAndreas Boehler                    $write = (auth_quickaclcheck($page) > AUTH_READ);
1990b805092SAndreas Boehler                }
2000b805092SAndreas Boehler                else
2010b805092SAndreas Boehler                {
2020b805092SAndreas Boehler                    continue;
2030b805092SAndreas Boehler                }
2040b805092SAndreas Boehler            }
205185e2535SAndreas Boehler            $data[] = array('name' => $name, 'page' => $page, 'calid' => $calid,
206ed764890SAndreas Boehler                            'color' => $color, 'write' => $write);
207185e2535SAndreas Boehler      }
208185e2535SAndreas Boehler      return $data;
209185e2535SAndreas Boehler  }
210185e2535SAndreas Boehler
211185e2535SAndreas Boehler  /**
212185e2535SAndreas Boehler   * Get the saved calendar color for a given page.
213185e2535SAndreas Boehler   *
214185e2535SAndreas Boehler   * @param string $id optional The page ID
215185e2535SAndreas Boehler   * @return mixed The color on success, otherwise false
216185e2535SAndreas Boehler   */
217185e2535SAndreas Boehler  public function getCalendarColorForPage($id = null)
218185e2535SAndreas Boehler  {
219185e2535SAndreas Boehler      if(is_null($id))
220185e2535SAndreas Boehler      {
221185e2535SAndreas Boehler          global $ID;
222185e2535SAndreas Boehler          $id = $ID;
223185e2535SAndreas Boehler      }
224185e2535SAndreas Boehler
225185e2535SAndreas Boehler      $calid = $this->getCalendarIdForPage($id);
226185e2535SAndreas Boehler      if($calid === false)
227185e2535SAndreas Boehler        return false;
228185e2535SAndreas Boehler
229185e2535SAndreas Boehler      return $this->getCalendarColorForCalendar($calid);
230185e2535SAndreas Boehler  }
231185e2535SAndreas Boehler
232185e2535SAndreas Boehler  /**
233185e2535SAndreas Boehler   * Get the saved calendar color for a given calendar ID.
234185e2535SAndreas Boehler   *
235185e2535SAndreas Boehler   * @param string $id optional The calendar ID
236185e2535SAndreas Boehler   * @return mixed The color on success, otherwise false
237185e2535SAndreas Boehler   */
238185e2535SAndreas Boehler  public function getCalendarColorForCalendar($calid)
239185e2535SAndreas Boehler  {
240185e2535SAndreas Boehler      if(isset($this->cachedValues['calendarcolor'][$calid]))
241185e2535SAndreas Boehler        return $this->cachedValues['calendarcolor'][$calid];
242185e2535SAndreas Boehler
243185e2535SAndreas Boehler      $row = $this->getCalendarSettings($calid);
244185e2535SAndreas Boehler
245185e2535SAndreas Boehler      if(!isset($row['calendarcolor']))
246185e2535SAndreas Boehler        return false;
247185e2535SAndreas Boehler
248185e2535SAndreas Boehler      $color = $row['calendarcolor'];
249185e2535SAndreas Boehler      $this->cachedValues['calendarcolor'][$calid] = $color;
250185e2535SAndreas Boehler      return $color;
251185e2535SAndreas Boehler  }
252185e2535SAndreas Boehler
253185e2535SAndreas Boehler  /**
254e86c8dd3SAndreas Boehler   * Get the user's principal URL for iOS sync
255e86c8dd3SAndreas Boehler   * @param string $user the user name
256e86c8dd3SAndreas Boehler   * @return the URL to the principal sync
257e86c8dd3SAndreas Boehler   */
258e86c8dd3SAndreas Boehler  public function getPrincipalUrlForUser($user)
259e86c8dd3SAndreas Boehler  {
260e86c8dd3SAndreas Boehler      if(is_null($user))
261e86c8dd3SAndreas Boehler        return false;
262e86c8dd3SAndreas Boehler      $url = DOKU_URL.'lib/plugins/davcal/calendarserver.php/principals/'.$user;
263e86c8dd3SAndreas Boehler      return $url;
264e86c8dd3SAndreas Boehler  }
265e86c8dd3SAndreas Boehler
266e86c8dd3SAndreas Boehler  /**
267185e2535SAndreas Boehler   * Set the calendar color for a given page.
268185e2535SAndreas Boehler   *
269185e2535SAndreas Boehler   * @param string $color The color definition
270185e2535SAndreas Boehler   * @param string $id optional The page ID
271185e2535SAndreas Boehler   * @return boolean True on success, otherwise false
272185e2535SAndreas Boehler   */
273185e2535SAndreas Boehler  public function setCalendarColorForPage($color, $id = null)
274185e2535SAndreas Boehler  {
275185e2535SAndreas Boehler      if(is_null($id))
276185e2535SAndreas Boehler      {
277185e2535SAndreas Boehler          global $ID;
278185e2535SAndreas Boehler          $id = $ID;
279185e2535SAndreas Boehler      }
280185e2535SAndreas Boehler      $calid = $this->getCalendarIdForPage($id);
281185e2535SAndreas Boehler      if($calid === false)
282185e2535SAndreas Boehler        return false;
283185e2535SAndreas Boehler
28451f4febbSAndreas Boehler      $query = "UPDATE calendars SET calendarcolor = ? ".
28551f4febbSAndreas Boehler               " WHERE id = ?";
28651f4febbSAndreas Boehler      $res = $this->sqlite->query($query, $color, $calid);
287185e2535SAndreas Boehler      if($res !== false)
288185e2535SAndreas Boehler      {
289185e2535SAndreas Boehler        $this->cachedValues['calendarcolor'][$calid] = $color;
290185e2535SAndreas Boehler        return true;
291185e2535SAndreas Boehler      }
292185e2535SAndreas Boehler      return false;
293185e2535SAndreas Boehler  }
294185e2535SAndreas Boehler
295185e2535SAndreas Boehler  /**
296cb71a62aSAndreas Boehler   * Set the calendar name and description for a given page with a given
297cb71a62aSAndreas Boehler   * page id.
298cb71a62aSAndreas Boehler   * If the calendar doesn't exist, the calendar is created!
299cb71a62aSAndreas Boehler   *
300cb71a62aSAndreas Boehler   * @param string  $name The name of the new calendar
301cb71a62aSAndreas Boehler   * @param string  $description The description of the new calendar
302cb71a62aSAndreas Boehler   * @param string  $id (optional) The ID of the page
303cb71a62aSAndreas Boehler   * @param string  $userid The userid of the creating user
304cb71a62aSAndreas Boehler   *
305cb71a62aSAndreas Boehler   * @return boolean True on success, otherwise false.
306cb71a62aSAndreas Boehler   */
307a1a3b679SAndreas Boehler  public function setCalendarNameForPage($name, $description, $id = null, $userid = null)
308a1a3b679SAndreas Boehler  {
309a1a3b679SAndreas Boehler      if(is_null($id))
310a1a3b679SAndreas Boehler      {
311a1a3b679SAndreas Boehler          global $ID;
312a1a3b679SAndreas Boehler          $id = $ID;
313a1a3b679SAndreas Boehler      }
314a1a3b679SAndreas Boehler      if(is_null($userid))
31534a47953SAndreas Boehler      {
31634a47953SAndreas Boehler        if(isset($_SERVER['REMOTE_USER']) && !is_null($_SERVER['REMOTE_USER']))
31734a47953SAndreas Boehler        {
318a1a3b679SAndreas Boehler          $userid = $_SERVER['REMOTE_USER'];
31934a47953SAndreas Boehler        }
32034a47953SAndreas Boehler        else
32134a47953SAndreas Boehler        {
32234a47953SAndreas Boehler          $userid = uniqid('davcal-');
32334a47953SAndreas Boehler        }
32434a47953SAndreas Boehler      }
325a1a3b679SAndreas Boehler      $calid = $this->getCalendarIdForPage($id);
326a1a3b679SAndreas Boehler      if($calid === false)
327a1a3b679SAndreas Boehler        return $this->createCalendarForPage($name, $description, $id, $userid);
328a1a3b679SAndreas Boehler
32951f4febbSAndreas Boehler      $query = "UPDATE calendars SET displayname = ?, description = ? WHERE id = ?";
33051f4febbSAndreas Boehler      $res = $this->sqlite->query($query, $name, $description, $calid);
331b269830cSAndreas Boehler      if($res !== false)
332b269830cSAndreas Boehler        return true;
333b269830cSAndreas Boehler      return false;
334a1a3b679SAndreas Boehler  }
335a1a3b679SAndreas Boehler
336cb71a62aSAndreas Boehler  /**
337d5703f5aSAndreas Boehler   * Update a calendar's displayname
338d5703f5aSAndreas Boehler   *
339d5703f5aSAndreas Boehler   * @param int $calid The calendar's ID
340d5703f5aSAndreas Boehler   * @param string $name The new calendar name
341d5703f5aSAndreas Boehler   *
342d5703f5aSAndreas Boehler   * @return boolean True on success, otherwise false
343d5703f5aSAndreas Boehler   */
344d5703f5aSAndreas Boehler  public function updateCalendarName($calid, $name)
345d5703f5aSAndreas Boehler  {
346d5703f5aSAndreas Boehler      $query = "UPDATE calendars SET displayname = ? WHERE id = ?";
347d5703f5aSAndreas Boehler      $res = $this->sqlite->query($query, $calid, $name);
348d5703f5aSAndreas Boehler      if($res !== false)
349d5703f5aSAndreas Boehler      {
350d5703f5aSAndreas Boehler        $this->updateSyncTokenLog($calid, '', 'modified');
351d5703f5aSAndreas Boehler        return true;
352d5703f5aSAndreas Boehler      }
353d5703f5aSAndreas Boehler      return false;
354d5703f5aSAndreas Boehler  }
355d5703f5aSAndreas Boehler
356d5703f5aSAndreas Boehler  /**
357d5703f5aSAndreas Boehler   * Update the calendar description
358d5703f5aSAndreas Boehler   *
359d5703f5aSAndreas Boehler   * @param int $calid The calendar's ID
360d5703f5aSAndreas Boehler   * @param string $description The new calendar's description
361d5703f5aSAndreas Boehler   *
362d5703f5aSAndreas Boehler   * @return boolean True on success, otherwise false
363d5703f5aSAndreas Boehler   */
364d5703f5aSAndreas Boehler  public function updateCalendarDescription($calid, $description)
365d5703f5aSAndreas Boehler  {
366d5703f5aSAndreas Boehler      $query = "UPDATE calendars SET description = ? WHERE id = ?";
367d5703f5aSAndreas Boehler      $res = $this->sqlite->query($query, $calid, $description);
368d5703f5aSAndreas Boehler      if($res !== false)
369d5703f5aSAndreas Boehler      {
370d5703f5aSAndreas Boehler        $this->updateSyncTokenLog($calid, '', 'modified');
371d5703f5aSAndreas Boehler        return true;
372d5703f5aSAndreas Boehler      }
373d5703f5aSAndreas Boehler      return false;
374d5703f5aSAndreas Boehler  }
375d5703f5aSAndreas Boehler
376d5703f5aSAndreas Boehler  /**
377d5703f5aSAndreas Boehler   * Update a calendar's timezone information
378d5703f5aSAndreas Boehler   *
379d5703f5aSAndreas Boehler   * @param int $calid The calendar's ID
380d5703f5aSAndreas Boehler   * @param string $timezone The new timezone to set
381d5703f5aSAndreas Boehler   *
382d5703f5aSAndreas Boehler   * @return boolean True on success, otherwise false
383d5703f5aSAndreas Boehler   */
384d5703f5aSAndreas Boehler  public function updateCalendarTimezone($calid, $timezone)
385d5703f5aSAndreas Boehler  {
386d5703f5aSAndreas Boehler      $query = "UPDATE calendars SET timezone = ? WHERE id = ?";
387d5703f5aSAndreas Boehler      $res = $this->sqlite->query($query, $calid, $timezone);
388d5703f5aSAndreas Boehler      if($res !== false)
389d5703f5aSAndreas Boehler      {
390d5703f5aSAndreas Boehler        $this->updateSyncTokenLog($calid, '', 'modified');
391d5703f5aSAndreas Boehler        return true;
392d5703f5aSAndreas Boehler      }
393d5703f5aSAndreas Boehler      return false;
394d5703f5aSAndreas Boehler  }
395d5703f5aSAndreas Boehler
396d5703f5aSAndreas Boehler  /**
397cb71a62aSAndreas Boehler   * Save the personal settings to the SQLite database 'calendarsettings'.
398cb71a62aSAndreas Boehler   *
399cb71a62aSAndreas Boehler   * @param array  $settings The settings array to store
400cb71a62aSAndreas Boehler   * @param string $userid (optional) The userid to store
401cb71a62aSAndreas Boehler   *
402cb71a62aSAndreas Boehler   * @param boolean True on success, otherwise false
403cb71a62aSAndreas Boehler   */
404a495d34cSAndreas Boehler  public function savePersonalSettings($settings, $userid = null)
405a495d34cSAndreas Boehler  {
406a495d34cSAndreas Boehler      if(is_null($userid))
40734a47953SAndreas Boehler      {
40834a47953SAndreas Boehler          if(isset($_SERVER['REMOTE_USER']) && !is_null($_SERVER['REMOTE_USER']))
40934a47953SAndreas Boehler          {
410a495d34cSAndreas Boehler            $userid = $_SERVER['REMOTE_USER'];
41134a47953SAndreas Boehler          }
41234a47953SAndreas Boehler          else
41334a47953SAndreas Boehler          {
41434a47953SAndreas Boehler              return false;
41534a47953SAndreas Boehler          }
41634a47953SAndreas Boehler      }
417a495d34cSAndreas Boehler      $this->sqlite->query("BEGIN TRANSACTION");
418a495d34cSAndreas Boehler
41951f4febbSAndreas Boehler      $query = "DELETE FROM calendarsettings WHERE userid = ?";
42051f4febbSAndreas Boehler      $this->sqlite->query($query, $userid);
421bd883736SAndreas Boehler
422a495d34cSAndreas Boehler      foreach($settings as $key => $value)
423a495d34cSAndreas Boehler      {
42451f4febbSAndreas Boehler          $query = "INSERT INTO calendarsettings (userid, key, value) VALUES (?, ?, ?)";
42551f4febbSAndreas Boehler          $res = $this->sqlite->query($query, $userid, $key, $value);
426a495d34cSAndreas Boehler          if($res === false)
427a495d34cSAndreas Boehler              return false;
428a495d34cSAndreas Boehler      }
429a495d34cSAndreas Boehler      $this->sqlite->query("COMMIT TRANSACTION");
430185e2535SAndreas Boehler      $this->cachedValues['settings'][$userid] = $settings;
431a495d34cSAndreas Boehler      return true;
432a495d34cSAndreas Boehler  }
433a495d34cSAndreas Boehler
434cb71a62aSAndreas Boehler  /**
435cb71a62aSAndreas Boehler   * Retrieve the settings array for a given user id.
436cb71a62aSAndreas Boehler   * Some sane defaults are returned, currently:
437cb71a62aSAndreas Boehler   *
438cb71a62aSAndreas Boehler   *    timezone    => local
439cb71a62aSAndreas Boehler   *    weeknumbers => 0
440cb71a62aSAndreas Boehler   *    workweek    => 0
441cb71a62aSAndreas Boehler   *
442cb71a62aSAndreas Boehler   * @param string $userid (optional) The user id to retrieve
443cb71a62aSAndreas Boehler   *
444cb71a62aSAndreas Boehler   * @return array The settings array
445cb71a62aSAndreas Boehler   */
446a495d34cSAndreas Boehler  public function getPersonalSettings($userid = null)
447a495d34cSAndreas Boehler  {
448bd883736SAndreas Boehler      // Some sane default settings
449bd883736SAndreas Boehler      $settings = array(
450fb813b30SAndreas Boehler        'timezone' => $this->getConf('timezone'),
451fb813b30SAndreas Boehler        'weeknumbers' => $this->getConf('weeknumbers'),
452fb813b30SAndreas Boehler        'workweek' => $this->getConf('workweek'),
4531d5bdcd0SAndreas Boehler        'monday' => $this->getConf('monday'),
4541d5bdcd0SAndreas Boehler        'timeformat' => $this->getConf('timeformat')
455bd883736SAndreas Boehler      );
45634a47953SAndreas Boehler      if(is_null($userid))
45734a47953SAndreas Boehler      {
45834a47953SAndreas Boehler          if(isset($_SERVER['REMOTE_USER']) && !is_null($_SERVER['REMOTE_USER']))
45934a47953SAndreas Boehler          {
46034a47953SAndreas Boehler            $userid = $_SERVER['REMOTE_USER'];
46134a47953SAndreas Boehler          }
46234a47953SAndreas Boehler          else
46334a47953SAndreas Boehler          {
46434a47953SAndreas Boehler            return $settings;
46534a47953SAndreas Boehler          }
46634a47953SAndreas Boehler      }
46734a47953SAndreas Boehler
46834a47953SAndreas Boehler      if(isset($this->cachedValues['settings'][$userid]))
46934a47953SAndreas Boehler        return $this->cachedValues['settings'][$userid];
47051f4febbSAndreas Boehler      $query = "SELECT key, value FROM calendarsettings WHERE userid = ?";
47151f4febbSAndreas Boehler      $res = $this->sqlite->query($query, $userid);
472a495d34cSAndreas Boehler      $arr = $this->sqlite->res2arr($res);
473a495d34cSAndreas Boehler      foreach($arr as $row)
474a495d34cSAndreas Boehler      {
475a495d34cSAndreas Boehler          $settings[$row['key']] = $row['value'];
476a495d34cSAndreas Boehler      }
477185e2535SAndreas Boehler      $this->cachedValues['settings'][$userid] = $settings;
478a495d34cSAndreas Boehler      return $settings;
479a495d34cSAndreas Boehler  }
480a495d34cSAndreas Boehler
481cb71a62aSAndreas Boehler  /**
482cb71a62aSAndreas Boehler   * Retrieve the calendar ID based on a page ID from the SQLite table
483cb71a62aSAndreas Boehler   * 'pagetocalendarmapping'.
484cb71a62aSAndreas Boehler   *
485cb71a62aSAndreas Boehler   * @param string $id (optional) The page ID to retrieve the corresponding calendar
486cb71a62aSAndreas Boehler   *
487cb71a62aSAndreas Boehler   * @return mixed the ID on success, otherwise false
488cb71a62aSAndreas Boehler   */
489a1a3b679SAndreas Boehler  public function getCalendarIdForPage($id = null)
490a1a3b679SAndreas Boehler  {
491a1a3b679SAndreas Boehler      if(is_null($id))
492a1a3b679SAndreas Boehler      {
493a1a3b679SAndreas Boehler          global $ID;
494a1a3b679SAndreas Boehler          $id = $ID;
495a1a3b679SAndreas Boehler      }
496a1a3b679SAndreas Boehler
497185e2535SAndreas Boehler      if(isset($this->cachedValues['calid'][$id]))
498185e2535SAndreas Boehler        return $this->cachedValues['calid'][$id];
499185e2535SAndreas Boehler
50051f4febbSAndreas Boehler      $query = "SELECT calid FROM pagetocalendarmapping WHERE page = ?";
50151f4febbSAndreas Boehler      $res = $this->sqlite->query($query, $id);
502a1a3b679SAndreas Boehler      $row = $this->sqlite->res2row($res);
503a1a3b679SAndreas Boehler      if(isset($row['calid']))
504185e2535SAndreas Boehler      {
505185e2535SAndreas Boehler        $calid = $row['calid'];
506185e2535SAndreas Boehler        $this->cachedValues['calid'] = $calid;
507185e2535SAndreas Boehler        return $calid;
508185e2535SAndreas Boehler      }
509a1a3b679SAndreas Boehler      return false;
510a1a3b679SAndreas Boehler  }
511a1a3b679SAndreas Boehler
512cb71a62aSAndreas Boehler  /**
513cb71a62aSAndreas Boehler   * Retrieve the complete calendar id to page mapping.
514cb71a62aSAndreas Boehler   * This is necessary to be able to retrieve a list of
515cb71a62aSAndreas Boehler   * calendars for a given user and check the access rights.
516cb71a62aSAndreas Boehler   *
517cb71a62aSAndreas Boehler   * @return array The mapping array
518cb71a62aSAndreas Boehler   */
519a1a3b679SAndreas Boehler  public function getCalendarIdToPageMapping()
520a1a3b679SAndreas Boehler  {
521a1a3b679SAndreas Boehler      $query = "SELECT calid, page FROM pagetocalendarmapping";
522a1a3b679SAndreas Boehler      $res = $this->sqlite->query($query);
523a1a3b679SAndreas Boehler      $arr = $this->sqlite->res2arr($res);
524a1a3b679SAndreas Boehler      return $arr;
525a1a3b679SAndreas Boehler  }
526a1a3b679SAndreas Boehler
527cb71a62aSAndreas Boehler  /**
528cb71a62aSAndreas Boehler   * Retrieve all calendar IDs a given user has access to.
529cb71a62aSAndreas Boehler   * The user is specified by the principalUri, so the
530cb71a62aSAndreas Boehler   * user name is actually split from the URI component.
531cb71a62aSAndreas Boehler   *
532cb71a62aSAndreas Boehler   * Access rights are checked against DokuWiki's ACL
533cb71a62aSAndreas Boehler   * and applied accordingly.
534cb71a62aSAndreas Boehler   *
535cb71a62aSAndreas Boehler   * @param string $principalUri The principal URI to work on
536cb71a62aSAndreas Boehler   *
537cb71a62aSAndreas Boehler   * @return array An associative array of calendar IDs
538cb71a62aSAndreas Boehler   */
539a1a3b679SAndreas Boehler  public function getCalendarIdsForUser($principalUri)
540a1a3b679SAndreas Boehler  {
54134a47953SAndreas Boehler      global $auth;
542a1a3b679SAndreas Boehler      $user = explode('/', $principalUri);
543a1a3b679SAndreas Boehler      $user = end($user);
544a1a3b679SAndreas Boehler      $mapping = $this->getCalendarIdToPageMapping();
545a1a3b679SAndreas Boehler      $calids = array();
54634a47953SAndreas Boehler      $ud = $auth->getUserData($user);
54734a47953SAndreas Boehler      $groups = $ud['grps'];
548a1a3b679SAndreas Boehler      foreach($mapping as $row)
549a1a3b679SAndreas Boehler      {
550a1a3b679SAndreas Boehler          $id = $row['calid'];
551a1a3b679SAndreas Boehler          $page = $row['page'];
55234a47953SAndreas Boehler          $acl = auth_aclcheck($page, $user, $groups);
553a1a3b679SAndreas Boehler          if($acl >= AUTH_READ)
554a1a3b679SAndreas Boehler          {
555a1a3b679SAndreas Boehler              $write = $acl > AUTH_READ;
556a1a3b679SAndreas Boehler              $calids[$id] = array('readonly' => !$write);
557a1a3b679SAndreas Boehler          }
558a1a3b679SAndreas Boehler      }
559a1a3b679SAndreas Boehler      return $calids;
560a1a3b679SAndreas Boehler  }
561a1a3b679SAndreas Boehler
562cb71a62aSAndreas Boehler  /**
563cb71a62aSAndreas Boehler   * Create a new calendar for a given page ID and set name and description
564cb71a62aSAndreas Boehler   * accordingly. Also update the pagetocalendarmapping table on success.
565cb71a62aSAndreas Boehler   *
566cb71a62aSAndreas Boehler   * @param string $name The calendar's name
567cb71a62aSAndreas Boehler   * @param string $description The calendar's description
568cb71a62aSAndreas Boehler   * @param string $id (optional) The page ID to work on
569cb71a62aSAndreas Boehler   * @param string $userid (optional) The user ID that created the calendar
570cb71a62aSAndreas Boehler   *
571cb71a62aSAndreas Boehler   * @return boolean True on success, otherwise false
572cb71a62aSAndreas Boehler   */
573a1a3b679SAndreas Boehler  public function createCalendarForPage($name, $description, $id = null, $userid = null)
574a1a3b679SAndreas Boehler  {
575a1a3b679SAndreas Boehler      if(is_null($id))
576a1a3b679SAndreas Boehler      {
577a1a3b679SAndreas Boehler          global $ID;
578a1a3b679SAndreas Boehler          $id = $ID;
579a1a3b679SAndreas Boehler      }
580a1a3b679SAndreas Boehler      if(is_null($userid))
58134a47953SAndreas Boehler      {
58234a47953SAndreas Boehler        if(isset($_SERVER['REMOTE_USER']) && !is_null($_SERVER['REMOTE_USER']))
58334a47953SAndreas Boehler        {
584a1a3b679SAndreas Boehler          $userid = $_SERVER['REMOTE_USER'];
58534a47953SAndreas Boehler        }
58634a47953SAndreas Boehler        else
58734a47953SAndreas Boehler        {
58834a47953SAndreas Boehler          $userid = uniqid('davcal-');
58934a47953SAndreas Boehler        }
59034a47953SAndreas Boehler      }
591a1a3b679SAndreas Boehler      $values = array('principals/'.$userid,
592a1a3b679SAndreas Boehler                      $name,
593a1a3b679SAndreas Boehler                      str_replace(array('/', ' ', ':'), '_', $id),
594a1a3b679SAndreas Boehler                      $description,
595a1a3b679SAndreas Boehler                      'VEVENT,VTODO',
59655a741c0SAndreas Boehler                      0,
59755a741c0SAndreas Boehler                      1);
59851f4febbSAndreas Boehler      $query = "INSERT INTO calendars (principaluri, displayname, uri, description, components, transparent, synctoken) ".
59951f4febbSAndreas Boehler               "VALUES (?, ?, ?, ?, ?, ?, ?)";
60051f4febbSAndreas Boehler      $res = $this->sqlite->query($query, $values[0], $values[1], $values[2], $values[3], $values[4], $values[5], $values[6]);
60155a741c0SAndreas Boehler      if($res === false)
60255a741c0SAndreas Boehler        return false;
603cb71a62aSAndreas Boehler
604cb71a62aSAndreas Boehler      // Get the new calendar ID
60551f4febbSAndreas Boehler      $query = "SELECT id FROM calendars WHERE principaluri = ? AND displayname = ? AND ".
60651f4febbSAndreas Boehler               "uri = ? AND description = ?";
60751f4febbSAndreas Boehler      $res = $this->sqlite->query($query, $values[0], $values[1], $values[2], $values[3]);
608a1a3b679SAndreas Boehler      $row = $this->sqlite->res2row($res);
609cb71a62aSAndreas Boehler
610cb71a62aSAndreas Boehler      // Update the pagetocalendarmapping table with the new calendar ID
611a1a3b679SAndreas Boehler      if(isset($row['id']))
612a1a3b679SAndreas Boehler      {
61351f4febbSAndreas Boehler          $query = "INSERT INTO pagetocalendarmapping (page, calid) VALUES (?, ?)";
61451f4febbSAndreas Boehler          $res = $this->sqlite->query($query, $id, $row['id']);
61555a741c0SAndreas Boehler          return ($res !== false);
616a1a3b679SAndreas Boehler      }
617a1a3b679SAndreas Boehler
618a1a3b679SAndreas Boehler      return false;
619a1a3b679SAndreas Boehler  }
620a1a3b679SAndreas Boehler
621cb71a62aSAndreas Boehler  /**
622d5703f5aSAndreas Boehler   * Add a new calendar entry to the given calendar. Calendar data is
623d5703f5aSAndreas Boehler   * specified as ICS file, thus it needs to be parsed first.
624d5703f5aSAndreas Boehler   *
625d5703f5aSAndreas Boehler   * This is mainly needed for the sync support.
626d5703f5aSAndreas Boehler   *
627d5703f5aSAndreas Boehler   * @param int $calid The calendar's ID
628d5703f5aSAndreas Boehler   * @param string $uri The new object URI
629d5703f5aSAndreas Boehler   * @param string $ics The ICS file
630d5703f5aSAndreas Boehler   *
631d5703f5aSAndreas Boehler   * @return mixed The etag.
632d5703f5aSAndreas Boehler   */
633d5703f5aSAndreas Boehler  public function addCalendarEntryToCalendarByICS($calid, $uri, $ics)
634d5703f5aSAndreas Boehler  {
635d5703f5aSAndreas Boehler    $extraData = $this->getDenormalizedData($ics);
636d5703f5aSAndreas Boehler
637d5703f5aSAndreas Boehler    $query = "INSERT INTO calendarobjects (calendarid, uri, calendardata, lastmodified, etag, size, componenttype, firstoccurence, lastoccurence, uid) VALUES (?,?,?,?,?,?,?,?,?,?)";
638d5703f5aSAndreas Boehler    $res = $this->sqlite->query($query,
639d5703f5aSAndreas Boehler            $calid,
640d5703f5aSAndreas Boehler            $uri,
641d5703f5aSAndreas Boehler            $ics,
642d5703f5aSAndreas Boehler            time(),
643d5703f5aSAndreas Boehler            $extraData['etag'],
644d5703f5aSAndreas Boehler            $extraData['size'],
645d5703f5aSAndreas Boehler            $extraData['componentType'],
646d5703f5aSAndreas Boehler            $extraData['firstOccurence'],
647d5703f5aSAndreas Boehler            $extraData['lastOccurence'],
648d5703f5aSAndreas Boehler            $extraData['uid']);
649d5703f5aSAndreas Boehler            // If successfully, update the sync token database
650d5703f5aSAndreas Boehler    if($res !== false)
651d5703f5aSAndreas Boehler    {
652d5703f5aSAndreas Boehler        $this->updateSyncTokenLog($calid, $uri, 'added');
653d5703f5aSAndreas Boehler    }
654d5703f5aSAndreas Boehler    return $extraData['etag'];
655d5703f5aSAndreas Boehler  }
656d5703f5aSAndreas Boehler
657d5703f5aSAndreas Boehler  /**
658d5703f5aSAndreas Boehler   * Edit a calendar entry by providing a new ICS file. This is mainly
659d5703f5aSAndreas Boehler   * needed for the sync support.
660d5703f5aSAndreas Boehler   *
661d5703f5aSAndreas Boehler   * @param int $calid The calendar's IS
662d5703f5aSAndreas Boehler   * @param string $uri The object's URI to modify
663d5703f5aSAndreas Boehler   * @param string $ics The new object's ICS file
664d5703f5aSAndreas Boehler   */
665d5703f5aSAndreas Boehler  public function editCalendarEntryToCalendarByICS($calid, $uri, $ics)
666d5703f5aSAndreas Boehler  {
667d5703f5aSAndreas Boehler      $extraData = $this->getDenormalizedData($ics);
668d5703f5aSAndreas Boehler
669d5703f5aSAndreas Boehler      $query = "UPDATE calendarobjects SET calendardata = ?, lastmodified = ?, etag = ?, size = ?, componenttype = ?, firstoccurence = ?, lastoccurence = ?, uid = ? WHERE calendarid = ? AND uri = ?";
670d5703f5aSAndreas Boehler      $res = $this->sqlite->query($query,
671d5703f5aSAndreas Boehler        $ics,
672d5703f5aSAndreas Boehler        time(),
673d5703f5aSAndreas Boehler        $extraData['etag'],
674d5703f5aSAndreas Boehler        $extraData['size'],
675d5703f5aSAndreas Boehler        $extraData['componentType'],
676d5703f5aSAndreas Boehler        $extraData['firstOccurence'],
677d5703f5aSAndreas Boehler        $extraData['lastOccurence'],
678d5703f5aSAndreas Boehler        $extraData['uid'],
679d5703f5aSAndreas Boehler        $calid,
680d5703f5aSAndreas Boehler        $uri
681d5703f5aSAndreas Boehler      );
682d5703f5aSAndreas Boehler      if($res !== false)
683d5703f5aSAndreas Boehler      {
684d5703f5aSAndreas Boehler          $this->updateSyncTokenLog($calid, $uri, 'modified');
685d5703f5aSAndreas Boehler      }
686d5703f5aSAndreas Boehler      return $extraData['etag'];
687d5703f5aSAndreas Boehler  }
688d5703f5aSAndreas Boehler
689d5703f5aSAndreas Boehler  /**
690cb71a62aSAndreas Boehler   * Add a new iCal entry for a given page, i.e. a given calendar.
691cb71a62aSAndreas Boehler   *
692cb71a62aSAndreas Boehler   * The parameter array needs to contain
693cb71a62aSAndreas Boehler   *   detectedtz       => The timezone as detected by the browser
69482a48dfbSAndreas Boehler   *   currenttz        => The timezone in use by the calendar
695cb71a62aSAndreas Boehler   *   eventfrom        => The event's start date
696cb71a62aSAndreas Boehler   *   eventfromtime    => The event's start time
697cb71a62aSAndreas Boehler   *   eventto          => The event's end date
698cb71a62aSAndreas Boehler   *   eventtotime      => The event's end time
699cb71a62aSAndreas Boehler   *   eventname        => The event's name
700cb71a62aSAndreas Boehler   *   eventdescription => The event's description
701cb71a62aSAndreas Boehler   *
702cb71a62aSAndreas Boehler   * @param string $id The page ID to work on
703cb71a62aSAndreas Boehler   * @param string $user The user who created the calendar
704cb71a62aSAndreas Boehler   * @param string $params A parameter array with values to create
705cb71a62aSAndreas Boehler   *
706cb71a62aSAndreas Boehler   * @return boolean True on success, otherwise false
707cb71a62aSAndreas Boehler   */
708a1a3b679SAndreas Boehler  public function addCalendarEntryToCalendarForPage($id, $user, $params)
709a1a3b679SAndreas Boehler  {
71082a48dfbSAndreas Boehler      if($params['currenttz'] !== '' && $params['currenttz'] !== 'local')
71182a48dfbSAndreas Boehler          $timezone = new \DateTimeZone($params['currenttz']);
71282a48dfbSAndreas Boehler      elseif($params['currenttz'] === 'local')
713a25c89eaSAndreas Boehler          $timezone = new \DateTimeZone($params['detectedtz']);
714bd883736SAndreas Boehler      else
715bd883736SAndreas Boehler          $timezone = new \DateTimeZone('UTC');
716cb71a62aSAndreas Boehler
717cb71a62aSAndreas Boehler      // Retrieve dates from settings
718b269830cSAndreas Boehler      $startDate = explode('-', $params['eventfrom']);
719b269830cSAndreas Boehler      $startTime = explode(':', $params['eventfromtime']);
720b269830cSAndreas Boehler      $endDate = explode('-', $params['eventto']);
721b269830cSAndreas Boehler      $endTime = explode(':', $params['eventtotime']);
722cb71a62aSAndreas Boehler
723cb71a62aSAndreas Boehler      // Load SabreDAV
7249bef4ad8SAndreas Boehler      require_once(DOKU_PLUGIN.'davcal/vendor/autoload.php');
725a1a3b679SAndreas Boehler      $vcalendar = new \Sabre\VObject\Component\VCalendar();
726cb71a62aSAndreas Boehler
727cb71a62aSAndreas Boehler      // Add VCalendar, UID and Event Name
728a1a3b679SAndreas Boehler      $event = $vcalendar->add('VEVENT');
729b269830cSAndreas Boehler      $uuid = \Sabre\VObject\UUIDUtil::getUUID();
730b269830cSAndreas Boehler      $event->add('UID', $uuid);
731a1a3b679SAndreas Boehler      $event->summary = $params['eventname'];
732cb71a62aSAndreas Boehler
733cb71a62aSAndreas Boehler      // Add a description if requested
7340eebc909SAndreas Boehler      $description = $params['eventdescription'];
7350eebc909SAndreas Boehler      if($description !== '')
7360eebc909SAndreas Boehler        $event->add('DESCRIPTION', $description);
737cb71a62aSAndreas Boehler
7384ecb526cSAndreas Boehler      // Add attachments
7394ecb526cSAndreas Boehler      $attachments = $params['attachments'];
74082a48dfbSAndreas Boehler      if(!is_null($attachments))
7414ecb526cSAndreas Boehler        foreach($attachments as $attachment)
7424ecb526cSAndreas Boehler          $event->add('ATTACH', $attachment);
7434ecb526cSAndreas Boehler
744cb71a62aSAndreas Boehler      // Create a timestamp for last modified, created and dtstamp values in UTC
745b269830cSAndreas Boehler      $dtStamp = new \DateTime(null, new \DateTimeZone('UTC'));
746b269830cSAndreas Boehler      $event->add('DTSTAMP', $dtStamp);
747b269830cSAndreas Boehler      $event->add('CREATED', $dtStamp);
748b269830cSAndreas Boehler      $event->add('LAST-MODIFIED', $dtStamp);
749cb71a62aSAndreas Boehler
750cb71a62aSAndreas Boehler      // Adjust the start date, based on the given timezone information
751b269830cSAndreas Boehler      $dtStart = new \DateTime();
752a25c89eaSAndreas Boehler      $dtStart->setTimezone($timezone);
753b269830cSAndreas Boehler      $dtStart->setDate(intval($startDate[0]), intval($startDate[1]), intval($startDate[2]));
754cb71a62aSAndreas Boehler
755cb71a62aSAndreas Boehler      // Only add the time values if it's not an allday event
756b269830cSAndreas Boehler      if($params['allday'] != '1')
757b269830cSAndreas Boehler        $dtStart->setTime(intval($startTime[0]), intval($startTime[1]), 0);
758cb71a62aSAndreas Boehler
759cb71a62aSAndreas Boehler      // Adjust the end date, based on the given timezone information
760b269830cSAndreas Boehler      $dtEnd = new \DateTime();
761a25c89eaSAndreas Boehler      $dtEnd->setTimezone($timezone);
762b269830cSAndreas Boehler      $dtEnd->setDate(intval($endDate[0]), intval($endDate[1]), intval($endDate[2]));
763cb71a62aSAndreas Boehler
764cb71a62aSAndreas Boehler      // Only add the time values if it's not an allday event
765b269830cSAndreas Boehler      if($params['allday'] != '1')
766b269830cSAndreas Boehler        $dtEnd->setTime(intval($endTime[0]), intval($endTime[1]), 0);
767cb71a62aSAndreas Boehler
768b269830cSAndreas Boehler      // According to the VCal spec, we need to add a whole day here
769b269830cSAndreas Boehler      if($params['allday'] == '1')
770b269830cSAndreas Boehler          $dtEnd->add(new \DateInterval('P1D'));
771cb71a62aSAndreas Boehler
772cb71a62aSAndreas Boehler      // Really add Start and End events
773b269830cSAndreas Boehler      $dtStartEv = $event->add('DTSTART', $dtStart);
774b269830cSAndreas Boehler      $dtEndEv = $event->add('DTEND', $dtEnd);
775cb71a62aSAndreas Boehler
776cb71a62aSAndreas Boehler      // Adjust the DATE format for allday events
777b269830cSAndreas Boehler      if($params['allday'] == '1')
778b269830cSAndreas Boehler      {
779b269830cSAndreas Boehler          $dtStartEv['VALUE'] = 'DATE';
780b269830cSAndreas Boehler          $dtEndEv['VALUE'] = 'DATE';
781b269830cSAndreas Boehler      }
782cb71a62aSAndreas Boehler
783809cb0faSAndreas Boehler      $eventStr = $vcalendar->serialize();
784809cb0faSAndreas Boehler
785809cb0faSAndreas Boehler      if(strpos($id, 'webdav://') === 0)
786809cb0faSAndreas Boehler      {
787809cb0faSAndreas Boehler          $wdc =& plugin_load('helper', 'webdavclient');
788809cb0faSAndreas Boehler          if(is_null($wdc))
789809cb0faSAndreas Boehler            return false;
790809cb0faSAndreas Boehler          $connectionId = str_replace('webdav://', '', $id);
791809cb0faSAndreas Boehler          return $wdc->addCalendarEntry($connectionId, $eventStr);
792809cb0faSAndreas Boehler      }
793809cb0faSAndreas Boehler      else
794809cb0faSAndreas Boehler      {
795cb71a62aSAndreas Boehler          // Actually add the values to the database
796a1a3b679SAndreas Boehler          $calid = $this->getCalendarIdForPage($id);
797a1a3b679SAndreas Boehler          $uri = uniqid('dokuwiki-').'.ics';
7981bb22c2bSAndreas Boehler          $now = new \DateTime();
799a1a3b679SAndreas Boehler
80051f4febbSAndreas Boehler          $query = "INSERT INTO calendarobjects (calendarid, uri, calendardata, lastmodified, componenttype, firstoccurence, lastoccurence, size, etag, uid) VALUES (?, ?, ?, ?, ?, ?, ?, ?, ?, ?)";
80151f4febbSAndreas Boehler          $res = $this->sqlite->query($query, $calid, $uri, $eventStr, $now->getTimestamp(), 'VEVENT',
80251f4febbSAndreas Boehler                                      $event->DTSTART->getDateTime()->getTimeStamp(), $event->DTEND->getDateTime()->getTimeStamp(),
80351f4febbSAndreas Boehler                                      strlen($eventStr), md5($eventStr), $uuid);
804cb71a62aSAndreas Boehler
805cb71a62aSAndreas Boehler          // If successfully, update the sync token database
80655a741c0SAndreas Boehler          if($res !== false)
80755a741c0SAndreas Boehler          {
80855a741c0SAndreas Boehler              $this->updateSyncTokenLog($calid, $uri, 'added');
809a1a3b679SAndreas Boehler              return true;
810a1a3b679SAndreas Boehler          }
811809cb0faSAndreas Boehler      }
81255a741c0SAndreas Boehler      return false;
81355a741c0SAndreas Boehler  }
814a1a3b679SAndreas Boehler
815cb71a62aSAndreas Boehler  /**
816cb71a62aSAndreas Boehler   * Retrieve the calendar settings of a given calendar id
817cb71a62aSAndreas Boehler   *
818cb71a62aSAndreas Boehler   * @param string $calid The calendar ID
819cb71a62aSAndreas Boehler   *
820cb71a62aSAndreas Boehler   * @return array The calendar settings array
821cb71a62aSAndreas Boehler   */
822b269830cSAndreas Boehler  public function getCalendarSettings($calid)
823b269830cSAndreas Boehler  {
824d5703f5aSAndreas Boehler      $query = "SELECT id, principaluri, calendarcolor, displayname, uri, description, components, transparent, synctoken FROM calendars WHERE id= ? ";
82551f4febbSAndreas Boehler      $res = $this->sqlite->query($query, $calid);
826b269830cSAndreas Boehler      $row = $this->sqlite->res2row($res);
827b269830cSAndreas Boehler      return $row;
828b269830cSAndreas Boehler  }
829b269830cSAndreas Boehler
830cb71a62aSAndreas Boehler  /**
831cb71a62aSAndreas Boehler   * Retrieve all events that are within a given date range,
832cb71a62aSAndreas Boehler   * based on the timezone setting.
833cb71a62aSAndreas Boehler   *
834cb71a62aSAndreas Boehler   * There is also support for retrieving recurring events,
835cb71a62aSAndreas Boehler   * using Sabre's VObject Iterator. Recurring events are represented
836cb71a62aSAndreas Boehler   * as individual calendar entries with the same UID.
837cb71a62aSAndreas Boehler   *
838cb71a62aSAndreas Boehler   * @param string $id The page ID to work with
839cb71a62aSAndreas Boehler   * @param string $user The user ID to work with
840cb71a62aSAndreas Boehler   * @param string $startDate The start date as a string
841cb71a62aSAndreas Boehler   * @param string $endDate The end date as a string
8424a2bf5eeSAndreas Boehler   * @param string $color (optional) The calendar's color
843cb71a62aSAndreas Boehler   *
844cb71a62aSAndreas Boehler   * @return array An array containing the calendar entries.
845cb71a62aSAndreas Boehler   */
8464a2bf5eeSAndreas Boehler  public function getEventsWithinDateRange($id, $user, $startDate, $endDate, $timezone, $color = null)
847a1a3b679SAndreas Boehler  {
84882a48dfbSAndreas Boehler      if($timezone !== '' && $timezone !== 'local')
84982a48dfbSAndreas Boehler          $timezone = new \DateTimeZone($timezone);
850bd883736SAndreas Boehler      else
851bd883736SAndreas Boehler          $timezone = new \DateTimeZone('UTC');
852a1a3b679SAndreas Boehler      $data = array();
853cb71a62aSAndreas Boehler
854a469597cSAndreas Boehler      $query = "SELECT calendardata, componenttype, uid FROM calendarobjects WHERE calendarid = ?";
855a469597cSAndreas Boehler      $startTs = null;
856a469597cSAndreas Boehler      $endTs = null;
857a469597cSAndreas Boehler      if($startDate !== null)
858a469597cSAndreas Boehler      {
859a1a3b679SAndreas Boehler        $startTs = new \DateTime($startDate);
860a469597cSAndreas Boehler        $query .= " AND lastoccurence > ".$this->sqlite->quote_string($startTs->getTimestamp());
861a469597cSAndreas Boehler      }
862a469597cSAndreas Boehler      if($endDate !== null)
863a469597cSAndreas Boehler      {
864a1a3b679SAndreas Boehler        $endTs = new \DateTime($endDate);
865a469597cSAndreas Boehler        $query .= " AND firstoccurence < ".$this->sqlite->quote_string($endTs->getTimestamp());
866a469597cSAndreas Boehler      }
867cb71a62aSAndreas Boehler
8680b805092SAndreas Boehler      // Load SabreDAV
8690b805092SAndreas Boehler      require_once(DOKU_PLUGIN.'davcal/vendor/autoload.php');
8700b805092SAndreas Boehler
8710b805092SAndreas Boehler      if(strpos($id, 'webdav://') === 0)
8720b805092SAndreas Boehler      {
8730b805092SAndreas Boehler          $wdc =& plugin_load('helper', 'webdavclient');
8740b805092SAndreas Boehler          if(is_null($wdc))
8750b805092SAndreas Boehler            return $data;
8760b805092SAndreas Boehler          $connectionId = str_replace('webdav://', '', $id);
8770b805092SAndreas Boehler          $arr = $wdc->getCalendarEntries($connectionId, $startDate, $endDate);
8780b805092SAndreas Boehler      }
8790b805092SAndreas Boehler      else
8800b805092SAndreas Boehler      {
8810b805092SAndreas Boehler          $calid = $this->getCalendarIdForPage($id);
8820b805092SAndreas Boehler          if(is_null($color))
8830b805092SAndreas Boehler            $color = $this->getCalendarColorForCalendar($calid);
8840b805092SAndreas Boehler
885cb71a62aSAndreas Boehler          // Retrieve matching calendar objects
886a469597cSAndreas Boehler          $res = $this->sqlite->query($query, $calid);
887a1a3b679SAndreas Boehler          $arr = $this->sqlite->res2arr($res);
8880b805092SAndreas Boehler      }
889cb71a62aSAndreas Boehler
890cb71a62aSAndreas Boehler      // Parse individual calendar entries
891a1a3b679SAndreas Boehler      foreach($arr as $row)
892a1a3b679SAndreas Boehler      {
893a1a3b679SAndreas Boehler          if(isset($row['calendardata']))
894a1a3b679SAndreas Boehler          {
895b269830cSAndreas Boehler              $entry = array();
896a1a3b679SAndreas Boehler              $vcal = \Sabre\VObject\Reader::read($row['calendardata']);
897ebc4eb57SAndreas Boehler              $recurrence = $vcal->VEVENT->RRULE;
898cb71a62aSAndreas Boehler              // If it is a recurring event, pass it through Sabre's EventIterator
899ebc4eb57SAndreas Boehler              if($recurrence != null)
900ebc4eb57SAndreas Boehler              {
901ebc4eb57SAndreas Boehler                  $rEvents = new \Sabre\VObject\Recur\EventIterator(array($vcal->VEVENT));
902ebc4eb57SAndreas Boehler                  $rEvents->rewind();
903e9b7d302SAndreas Boehler                  while($rEvents->valid())
904ebc4eb57SAndreas Boehler                  {
905ebc4eb57SAndreas Boehler                      $event = $rEvents->getEventObject();
906cb71a62aSAndreas Boehler                      // If we are after the given time range, exit
907a469597cSAndreas Boehler                      if(($endTs !== null) && ($rEvents->getDtStart()->getTimestamp() > $endTs->getTimestamp()))
908e9b7d302SAndreas Boehler                          break;
909cb71a62aSAndreas Boehler
910cb71a62aSAndreas Boehler                      // If we are before the given time range, continue
911a469597cSAndreas Boehler                      if(($startTs != null) && ($rEvents->getDtEnd()->getTimestamp() < $startTs->getTimestamp()))
912ebc4eb57SAndreas Boehler                      {
913ebc4eb57SAndreas Boehler                          $rEvents->next();
914ebc4eb57SAndreas Boehler                          continue;
915ebc4eb57SAndreas Boehler                      }
916cb71a62aSAndreas Boehler
917cb71a62aSAndreas Boehler                      // If we are within the given time range, parse the event
918185e2535SAndreas Boehler                      $data[] = $this->convertIcalDataToEntry($event, $id, $timezone, $row['uid'], $color, true);
919ebc4eb57SAndreas Boehler                      $rEvents->next();
920ebc4eb57SAndreas Boehler                  }
921ebc4eb57SAndreas Boehler              }
922ebc4eb57SAndreas Boehler              else
923185e2535SAndreas Boehler                $data[] = $this->convertIcalDataToEntry($vcal->VEVENT, $id, $timezone, $row['uid'], $color);
924ebc4eb57SAndreas Boehler          }
925ebc4eb57SAndreas Boehler      }
926ebc4eb57SAndreas Boehler      return $data;
927ebc4eb57SAndreas Boehler  }
928ebc4eb57SAndreas Boehler
929cb71a62aSAndreas Boehler  /**
930cb71a62aSAndreas Boehler   * Helper function that parses the iCal data of a VEVENT to a calendar entry.
931cb71a62aSAndreas Boehler   *
932cb71a62aSAndreas Boehler   * @param \Sabre\VObject\VEvent $event The event to parse
933cb71a62aSAndreas Boehler   * @param \DateTimeZone $timezone The timezone object
934cb71a62aSAndreas Boehler   * @param string $uid The entry's UID
9353c86dda8SAndreas Boehler   * @param boolean $recurring (optional) Set to true to define a recurring event
936cb71a62aSAndreas Boehler   *
937cb71a62aSAndreas Boehler   * @return array The parse calendar entry
938cb71a62aSAndreas Boehler   */
939185e2535SAndreas Boehler  private function convertIcalDataToEntry($event, $page, $timezone, $uid, $color, $recurring = false)
940ebc4eb57SAndreas Boehler  {
941ebc4eb57SAndreas Boehler      $entry = array();
942ebc4eb57SAndreas Boehler      $start = $event->DTSTART;
943cb71a62aSAndreas Boehler      // Parse only if the start date/time is present
944b269830cSAndreas Boehler      if($start !== null)
945b269830cSAndreas Boehler      {
946b269830cSAndreas Boehler        $dtStart = $start->getDateTime();
947b269830cSAndreas Boehler        $dtStart->setTimezone($timezone);
948bf0ad2b4SAndreas Boehler
949bf0ad2b4SAndreas Boehler        // moment.js doesn't like times be given even if
950bf0ad2b4SAndreas Boehler        // allDay is set to true
951bf0ad2b4SAndreas Boehler        // This should fix T23
952b269830cSAndreas Boehler        if($start['VALUE'] == 'DATE')
953bf0ad2b4SAndreas Boehler        {
954b269830cSAndreas Boehler          $entry['allDay'] = true;
955bf0ad2b4SAndreas Boehler          $entry['start'] = $dtStart->format("Y-m-d");
956bf0ad2b4SAndreas Boehler        }
957b269830cSAndreas Boehler        else
958bf0ad2b4SAndreas Boehler        {
959b269830cSAndreas Boehler          $entry['allDay'] = false;
960bf0ad2b4SAndreas Boehler          $entry['start'] = $dtStart->format(\DateTime::ATOM);
961bf0ad2b4SAndreas Boehler        }
962b269830cSAndreas Boehler      }
963ebc4eb57SAndreas Boehler      $end = $event->DTEND;
964bf0ad2b4SAndreas Boehler      // Parse only if the end date/time is present
965b269830cSAndreas Boehler      if($end !== null)
966b269830cSAndreas Boehler      {
967b269830cSAndreas Boehler        $dtEnd = $end->getDateTime();
968b269830cSAndreas Boehler        $dtEnd->setTimezone($timezone);
969bf0ad2b4SAndreas Boehler        if($end['VALUE'] == 'DATE')
970bf0ad2b4SAndreas Boehler          $entry['end'] = $dtEnd->format("Y-m-d");
971bf0ad2b4SAndreas Boehler        else
972b269830cSAndreas Boehler          $entry['end'] = $dtEnd->format(\DateTime::ATOM);
973b269830cSAndreas Boehler      }
974ebc4eb57SAndreas Boehler      $description = $event->DESCRIPTION;
9750eebc909SAndreas Boehler      if($description !== null)
9760eebc909SAndreas Boehler        $entry['description'] = (string)$description;
9770eebc909SAndreas Boehler      else
9780eebc909SAndreas Boehler        $entry['description'] = '';
9794ecb526cSAndreas Boehler      $attachments = $event->ATTACH;
9804ecb526cSAndreas Boehler      if($attachments !== null)
9814ecb526cSAndreas Boehler      {
9824ecb526cSAndreas Boehler        $entry['attachments'] = array();
9834ecb526cSAndreas Boehler        foreach($attachments as $attachment)
9844ecb526cSAndreas Boehler          $entry['attachments'][] = (string)$attachment;
9854ecb526cSAndreas Boehler      }
986ebc4eb57SAndreas Boehler      $entry['title'] = (string)$event->summary;
987ebc4eb57SAndreas Boehler      $entry['id'] = $uid;
988185e2535SAndreas Boehler      $entry['page'] = $page;
989185e2535SAndreas Boehler      $entry['color'] = $color;
9903c86dda8SAndreas Boehler      $entry['recurring'] = $recurring;
991185e2535SAndreas Boehler
992ebc4eb57SAndreas Boehler      return $entry;
993a1a3b679SAndreas Boehler  }
994a1a3b679SAndreas Boehler
995cb71a62aSAndreas Boehler  /**
996cb71a62aSAndreas Boehler   * Retrieve an event by its UID
997cb71a62aSAndreas Boehler   *
998cb71a62aSAndreas Boehler   * @param string $uid The event's UID
999cb71a62aSAndreas Boehler   *
1000cb71a62aSAndreas Boehler   * @return mixed The table row with the given event
1001cb71a62aSAndreas Boehler   */
1002a1a3b679SAndreas Boehler  public function getEventWithUid($uid)
1003a1a3b679SAndreas Boehler  {
100451f4febbSAndreas Boehler      $query = "SELECT calendardata, calendarid, componenttype, uri FROM calendarobjects WHERE uid = ?";
100551f4febbSAndreas Boehler      $res = $this->sqlite->query($query, $uid);
1006a1a3b679SAndreas Boehler      $row = $this->sqlite->res2row($res);
1007a1a3b679SAndreas Boehler      return $row;
1008a1a3b679SAndreas Boehler  }
1009a1a3b679SAndreas Boehler
1010cb71a62aSAndreas Boehler  /**
1011d5703f5aSAndreas Boehler   * Retrieve information of a calendar's object, not including the actual
1012d5703f5aSAndreas Boehler   * calendar data! This is mainly neede for the sync support.
1013d5703f5aSAndreas Boehler   *
1014d5703f5aSAndreas Boehler   * @param int $calid The calendar ID
1015d5703f5aSAndreas Boehler   *
1016d5703f5aSAndreas Boehler   * @return mixed The result
1017d5703f5aSAndreas Boehler   */
1018d5703f5aSAndreas Boehler  public function getCalendarObjects($calid)
1019d5703f5aSAndreas Boehler  {
1020d5703f5aSAndreas Boehler      $query = "SELECT id, uri, lastmodified, etag, calendarid, size, componenttype FROM calendarobjects WHERE calendarid = ?";
1021d5703f5aSAndreas Boehler      $res = $this->sqlite->query($query, $calid);
1022d5703f5aSAndreas Boehler      $arr = $this->sqlite->res2arr($res);
1023d5703f5aSAndreas Boehler      return $arr;
1024d5703f5aSAndreas Boehler  }
1025d5703f5aSAndreas Boehler
1026d5703f5aSAndreas Boehler  /**
1027d5703f5aSAndreas Boehler   * Retrieve a single calendar object by calendar ID and URI
1028d5703f5aSAndreas Boehler   *
1029d5703f5aSAndreas Boehler   * @param int $calid The calendar's ID
1030d5703f5aSAndreas Boehler   * @param string $uri The object's URI
1031d5703f5aSAndreas Boehler   *
1032d5703f5aSAndreas Boehler   * @return mixed The result
1033d5703f5aSAndreas Boehler   */
1034d5703f5aSAndreas Boehler  public function getCalendarObjectByUri($calid, $uri)
1035d5703f5aSAndreas Boehler  {
1036d5703f5aSAndreas Boehler      $query = "SELECT id, uri, lastmodified, etag, calendarid, size, calendardata, componenttype FROM calendarobjects WHERE calendarid = ? AND uri = ?";
1037d5703f5aSAndreas Boehler      $res = $this->sqlite->query($query, $calid, $uri);
1038d5703f5aSAndreas Boehler      $row = $this->sqlite->res2row($res);
1039d5703f5aSAndreas Boehler      return $row;
1040d5703f5aSAndreas Boehler  }
1041d5703f5aSAndreas Boehler
1042d5703f5aSAndreas Boehler  /**
1043d5703f5aSAndreas Boehler   * Retrieve several calendar objects by specifying an array of URIs.
1044d5703f5aSAndreas Boehler   * This is mainly neede for sync.
1045d5703f5aSAndreas Boehler   *
1046d5703f5aSAndreas Boehler   * @param int $calid The calendar's ID
1047d5703f5aSAndreas Boehler   * @param array $uris An array of URIs
1048d5703f5aSAndreas Boehler   *
1049d5703f5aSAndreas Boehler   * @return mixed The result
1050d5703f5aSAndreas Boehler   */
1051d5703f5aSAndreas Boehler  public function getMultipleCalendarObjectsByUri($calid, $uris)
1052d5703f5aSAndreas Boehler  {
1053d5703f5aSAndreas Boehler        $query = "SELECT id, uri, lastmodified, etag, calendarid, size, calendardata, componenttype FROM calendarobjects WHERE calendarid = ? AND uri IN (";
1054d5703f5aSAndreas Boehler        // Inserting a whole bunch of question marks
1055d5703f5aSAndreas Boehler        $query .= implode(',', array_fill(0, count($uris), '?'));
1056d5703f5aSAndreas Boehler        $query .= ')';
1057d5703f5aSAndreas Boehler        $vals = array_merge(array($calid), $uris);
1058d5703f5aSAndreas Boehler
1059d5703f5aSAndreas Boehler        $res = $this->sqlite->query($query, $vals);
1060d5703f5aSAndreas Boehler        $arr = $this->sqlite->res2arr($res);
1061d5703f5aSAndreas Boehler        return $arr;
1062d5703f5aSAndreas Boehler  }
1063d5703f5aSAndreas Boehler
1064d5703f5aSAndreas Boehler  /**
1065cb71a62aSAndreas Boehler   * Retrieve all calendar events for a given calendar ID
1066cb71a62aSAndreas Boehler   *
1067cb71a62aSAndreas Boehler   * @param string $calid The calendar's ID
1068cb71a62aSAndreas Boehler   *
1069cb71a62aSAndreas Boehler   * @return array An array containing all calendar data
1070cb71a62aSAndreas Boehler   */
1071f69bb449SAndreas Boehler  public function getAllCalendarEvents($calid)
1072f69bb449SAndreas Boehler  {
10737e0b8590SAndreas Boehler      $query = "SELECT calendardata, uid, componenttype, uri FROM calendarobjects WHERE calendarid = ?";
107451f4febbSAndreas Boehler      $res = $this->sqlite->query($query, $calid);
1075f69bb449SAndreas Boehler      $arr = $this->sqlite->res2arr($res);
1076f69bb449SAndreas Boehler      return $arr;
1077f69bb449SAndreas Boehler  }
1078f69bb449SAndreas Boehler
1079cb71a62aSAndreas Boehler  /**
1080cb71a62aSAndreas Boehler   * Edit a calendar entry for a page, given by its parameters.
1081cb71a62aSAndreas Boehler   * The params array has the same format as @see addCalendarEntryForPage
1082cb71a62aSAndreas Boehler   *
1083cb71a62aSAndreas Boehler   * @param string $id The page's ID to work on
1084cb71a62aSAndreas Boehler   * @param string $user The user's ID to work on
1085cb71a62aSAndreas Boehler   * @param array $params The parameter array for the edited calendar event
1086cb71a62aSAndreas Boehler   *
1087cb71a62aSAndreas Boehler   * @return boolean True on success, otherwise false
1088cb71a62aSAndreas Boehler   */
1089a1a3b679SAndreas Boehler  public function editCalendarEntryForPage($id, $user, $params)
1090a1a3b679SAndreas Boehler  {
109182a48dfbSAndreas Boehler      if($params['currenttz'] !== '' && $params['currenttz'] !== 'local')
109282a48dfbSAndreas Boehler          $timezone = new \DateTimeZone($params['currenttz']);
109382a48dfbSAndreas Boehler      elseif($params['currenttz'] === 'local')
1094a25c89eaSAndreas Boehler          $timezone = new \DateTimeZone($params['detectedtz']);
1095bd883736SAndreas Boehler      else
1096bd883736SAndreas Boehler          $timezone = new \DateTimeZone('UTC');
1097cb71a62aSAndreas Boehler
1098cb71a62aSAndreas Boehler      // Parse dates
1099b269830cSAndreas Boehler      $startDate = explode('-', $params['eventfrom']);
1100b269830cSAndreas Boehler      $startTime = explode(':', $params['eventfromtime']);
1101b269830cSAndreas Boehler      $endDate = explode('-', $params['eventto']);
1102b269830cSAndreas Boehler      $endTime = explode(':', $params['eventtotime']);
1103cb71a62aSAndreas Boehler
1104cb71a62aSAndreas Boehler      // Retrieve the existing event based on the UID
110555a741c0SAndreas Boehler      $uid = $params['uid'];
1106809cb0faSAndreas Boehler
1107809cb0faSAndreas Boehler      if(strpos($id, 'webdav://') === 0)
1108809cb0faSAndreas Boehler      {
1109809cb0faSAndreas Boehler        $wdc =& plugin_load('helper', 'webdavclient');
1110809cb0faSAndreas Boehler        if(is_null($wdc))
1111809cb0faSAndreas Boehler          return false;
1112809cb0faSAndreas Boehler        $event = $wdc->getCalendarEntryByUid($uid);
1113809cb0faSAndreas Boehler      }
1114809cb0faSAndreas Boehler      else
1115809cb0faSAndreas Boehler      {
111655a741c0SAndreas Boehler        $event = $this->getEventWithUid($uid);
1117809cb0faSAndreas Boehler      }
1118cb71a62aSAndreas Boehler
1119cb71a62aSAndreas Boehler      // Load SabreDAV
11209bef4ad8SAndreas Boehler      require_once(DOKU_PLUGIN.'davcal/vendor/autoload.php');
1121a1a3b679SAndreas Boehler      if(!isset($event['calendardata']))
1122a1a3b679SAndreas Boehler        return false;
112355a741c0SAndreas Boehler      $uri = $event['uri'];
112455a741c0SAndreas Boehler      $calid = $event['calendarid'];
1125cb71a62aSAndreas Boehler
1126cb71a62aSAndreas Boehler      // Parse the existing event
1127a1a3b679SAndreas Boehler      $vcal = \Sabre\VObject\Reader::read($event['calendardata']);
1128b269830cSAndreas Boehler      $vevent = $vcal->VEVENT;
1129cb71a62aSAndreas Boehler
1130cb71a62aSAndreas Boehler      // Set the new event values
1131b269830cSAndreas Boehler      $vevent->summary = $params['eventname'];
1132b269830cSAndreas Boehler      $dtStamp = new \DateTime(null, new \DateTimeZone('UTC'));
11330eebc909SAndreas Boehler      $description = $params['eventdescription'];
1134cb71a62aSAndreas Boehler
1135cb71a62aSAndreas Boehler      // Remove existing timestamps to overwrite them
11360eebc909SAndreas Boehler      $vevent->remove('DESCRIPTION');
1137b269830cSAndreas Boehler      $vevent->remove('DTSTAMP');
1138b269830cSAndreas Boehler      $vevent->remove('LAST-MODIFIED');
11394ecb526cSAndreas Boehler      $vevent->remove('ATTACH');
1140cb71a62aSAndreas Boehler
1141cb71a62aSAndreas Boehler      // Add new time stamps and description
1142b269830cSAndreas Boehler      $vevent->add('DTSTAMP', $dtStamp);
1143b269830cSAndreas Boehler      $vevent->add('LAST-MODIFIED', $dtStamp);
11440eebc909SAndreas Boehler      if($description !== '')
11450eebc909SAndreas Boehler        $vevent->add('DESCRIPTION', $description);
1146cb71a62aSAndreas Boehler
11474ecb526cSAndreas Boehler      // Add attachments
11484ecb526cSAndreas Boehler      $attachments = $params['attachments'];
114982a48dfbSAndreas Boehler      if(!is_null($attachments))
11504ecb526cSAndreas Boehler        foreach($attachments as $attachment)
11514ecb526cSAndreas Boehler          $vevent->add('ATTACH', $attachment);
11524ecb526cSAndreas Boehler
1153cb71a62aSAndreas Boehler      // Setup DTSTART
1154b269830cSAndreas Boehler      $dtStart = new \DateTime();
1155a25c89eaSAndreas Boehler      $dtStart->setTimezone($timezone);
1156b269830cSAndreas Boehler      $dtStart->setDate(intval($startDate[0]), intval($startDate[1]), intval($startDate[2]));
1157b269830cSAndreas Boehler      if($params['allday'] != '1')
1158b269830cSAndreas Boehler        $dtStart->setTime(intval($startTime[0]), intval($startTime[1]), 0);
1159cb71a62aSAndreas Boehler
11604ecb526cSAndreas Boehler      // Setup DTEND
1161b269830cSAndreas Boehler      $dtEnd = new \DateTime();
1162a25c89eaSAndreas Boehler      $dtEnd->setTimezone($timezone);
1163b269830cSAndreas Boehler      $dtEnd->setDate(intval($endDate[0]), intval($endDate[1]), intval($endDate[2]));
1164b269830cSAndreas Boehler      if($params['allday'] != '1')
1165b269830cSAndreas Boehler        $dtEnd->setTime(intval($endTime[0]), intval($endTime[1]), 0);
1166cb71a62aSAndreas Boehler
1167b269830cSAndreas Boehler      // According to the VCal spec, we need to add a whole day here
1168b269830cSAndreas Boehler      if($params['allday'] == '1')
1169b269830cSAndreas Boehler          $dtEnd->add(new \DateInterval('P1D'));
1170b269830cSAndreas Boehler      $vevent->remove('DTSTART');
1171b269830cSAndreas Boehler      $vevent->remove('DTEND');
1172b269830cSAndreas Boehler      $dtStartEv = $vevent->add('DTSTART', $dtStart);
1173b269830cSAndreas Boehler      $dtEndEv = $vevent->add('DTEND', $dtEnd);
1174cb71a62aSAndreas Boehler
1175cb71a62aSAndreas Boehler      // Remove the time for allday events
1176b269830cSAndreas Boehler      if($params['allday'] == '1')
1177b269830cSAndreas Boehler      {
1178b269830cSAndreas Boehler          $dtStartEv['VALUE'] = 'DATE';
1179b269830cSAndreas Boehler          $dtEndEv['VALUE'] = 'DATE';
1180b269830cSAndreas Boehler      }
1181a1a3b679SAndreas Boehler      $eventStr = $vcal->serialize();
1182809cb0faSAndreas Boehler      if(strpos($id, 'webdav://') === 0)
1183809cb0faSAndreas Boehler      {
1184809cb0faSAndreas Boehler          $connectionId = str_replace('webdav://', '', $id);
1185809cb0faSAndreas Boehler          return $wdc->editCalendarEntry($connectionId, $uid, $eventStr);
1186809cb0faSAndreas Boehler      }
1187809cb0faSAndreas Boehler      else
1188809cb0faSAndreas Boehler      {
1189809cb0faSAndreas Boehler          $now = new DateTime();
1190cb71a62aSAndreas Boehler          // Actually write to the database
119151f4febbSAndreas Boehler          $query = "UPDATE calendarobjects SET calendardata = ?, lastmodified = ?, ".
119251f4febbSAndreas Boehler                   "firstoccurence = ?, lastoccurence = ?, size = ?, etag = ? WHERE uid = ?";
119351f4febbSAndreas Boehler          $res = $this->sqlite->query($query, $eventStr, $now->getTimestamp(), $dtStart->getTimestamp(),
119451f4febbSAndreas Boehler                                      $dtEnd->getTimestamp(), strlen($eventStr), md5($eventStr), $uid);
119555a741c0SAndreas Boehler          if($res !== false)
119655a741c0SAndreas Boehler          {
119755a741c0SAndreas Boehler              $this->updateSyncTokenLog($calid, $uri, 'modified');
1198a1a3b679SAndreas Boehler              return true;
1199a1a3b679SAndreas Boehler          }
1200809cb0faSAndreas Boehler      }
120155a741c0SAndreas Boehler      return false;
120255a741c0SAndreas Boehler  }
1203a1a3b679SAndreas Boehler
1204cb71a62aSAndreas Boehler  /**
1205d5703f5aSAndreas Boehler   * Delete an event from a calendar by calendar ID and URI
1206d5703f5aSAndreas Boehler   *
1207d5703f5aSAndreas Boehler   * @param int $calid The calendar's ID
1208d5703f5aSAndreas Boehler   * @param string $uri The object's URI
1209d5703f5aSAndreas Boehler   *
1210d5703f5aSAndreas Boehler   * @return true
1211d5703f5aSAndreas Boehler   */
1212d5703f5aSAndreas Boehler  public function deleteCalendarEntryForCalendarByUri($calid, $uri)
1213d5703f5aSAndreas Boehler  {
1214d5703f5aSAndreas Boehler      $query = "DELETE FROM calendarobjects WHERE calendarid = ? AND uri = ?";
1215d5703f5aSAndreas Boehler      $res = $this->sqlite->query($query, $calid, $uri);
1216d5703f5aSAndreas Boehler      if($res !== false)
1217d5703f5aSAndreas Boehler      {
1218d5703f5aSAndreas Boehler          $this->updateSyncTokenLog($calid, $uri, 'deleted');
1219d5703f5aSAndreas Boehler      }
1220d5703f5aSAndreas Boehler      return true;
1221d5703f5aSAndreas Boehler  }
1222d5703f5aSAndreas Boehler
1223d5703f5aSAndreas Boehler  /**
1224cb71a62aSAndreas Boehler   * Delete a calendar entry for a given page. Actually, the event is removed
1225cb71a62aSAndreas Boehler   * based on the entry's UID, so that page ID is no used.
1226cb71a62aSAndreas Boehler   *
1227cb71a62aSAndreas Boehler   * @param string $id The page's ID (unused)
1228cb71a62aSAndreas Boehler   * @param array $params The parameter array to work with
1229cb71a62aSAndreas Boehler   *
1230cb71a62aSAndreas Boehler   * @return boolean True
1231cb71a62aSAndreas Boehler   */
1232a1a3b679SAndreas Boehler  public function deleteCalendarEntryForPage($id, $params)
1233a1a3b679SAndreas Boehler  {
1234a1a3b679SAndreas Boehler      $uid = $params['uid'];
1235809cb0faSAndreas Boehler      if(strpos($id, 'webdav://') === 0)
1236809cb0faSAndreas Boehler      {
1237809cb0faSAndreas Boehler        $wdc =& plugin_load('helper', 'webdavclient');
1238809cb0faSAndreas Boehler        if(is_null($wdc))
1239809cb0faSAndreas Boehler          return false;
1240809cb0faSAndreas Boehler        $connectionId = str_replace('webdav://', '', $id);
1241809cb0faSAndreas Boehler        $result = $wdc->deleteCalendarEntry($connectionId, $uid);
1242809cb0faSAndreas Boehler        return $result;
1243809cb0faSAndreas Boehler      }
124455a741c0SAndreas Boehler      $event = $this->getEventWithUid($uid);
12452c14b82bSAndreas Boehler      $calid = $event['calendarid'];
124655a741c0SAndreas Boehler      $uri = $event['uri'];
124751f4febbSAndreas Boehler      $query = "DELETE FROM calendarobjects WHERE uid = ?";
124851f4febbSAndreas Boehler      $res = $this->sqlite->query($query, $uid);
124955a741c0SAndreas Boehler      if($res !== false)
125055a741c0SAndreas Boehler      {
125155a741c0SAndreas Boehler          $this->updateSyncTokenLog($calid, $uri, 'deleted');
125255a741c0SAndreas Boehler      }
1253a1a3b679SAndreas Boehler      return true;
1254a1a3b679SAndreas Boehler  }
1255a1a3b679SAndreas Boehler
1256cb71a62aSAndreas Boehler  /**
1257cb71a62aSAndreas Boehler   * Retrieve the current sync token for a calendar
1258cb71a62aSAndreas Boehler   *
1259cb71a62aSAndreas Boehler   * @param string $calid The calendar id
1260cb71a62aSAndreas Boehler   *
1261cb71a62aSAndreas Boehler   * @return mixed The synctoken or false
1262cb71a62aSAndreas Boehler   */
126355a741c0SAndreas Boehler  public function getSyncTokenForCalendar($calid)
126455a741c0SAndreas Boehler  {
1265b269830cSAndreas Boehler      $row = $this->getCalendarSettings($calid);
126655a741c0SAndreas Boehler      if(isset($row['synctoken']))
126755a741c0SAndreas Boehler          return $row['synctoken'];
126855a741c0SAndreas Boehler      return false;
126955a741c0SAndreas Boehler  }
127055a741c0SAndreas Boehler
1271cb71a62aSAndreas Boehler  /**
1272cb71a62aSAndreas Boehler   * Helper function to convert the operation name to
1273cb71a62aSAndreas Boehler   * an operation code as stored in the database
1274cb71a62aSAndreas Boehler   *
1275cb71a62aSAndreas Boehler   * @param string $operationName The operation name
1276cb71a62aSAndreas Boehler   *
1277cb71a62aSAndreas Boehler   * @return mixed The operation code or false
1278cb71a62aSAndreas Boehler   */
127955a741c0SAndreas Boehler  public function operationNameToOperation($operationName)
128055a741c0SAndreas Boehler  {
128155a741c0SAndreas Boehler      switch($operationName)
128255a741c0SAndreas Boehler      {
128355a741c0SAndreas Boehler          case 'added':
128455a741c0SAndreas Boehler              return 1;
128555a741c0SAndreas Boehler          break;
128655a741c0SAndreas Boehler          case 'modified':
128755a741c0SAndreas Boehler              return 2;
128855a741c0SAndreas Boehler          break;
128955a741c0SAndreas Boehler          case 'deleted':
129055a741c0SAndreas Boehler              return 3;
129155a741c0SAndreas Boehler          break;
129255a741c0SAndreas Boehler      }
129355a741c0SAndreas Boehler      return false;
129455a741c0SAndreas Boehler  }
129555a741c0SAndreas Boehler
1296cb71a62aSAndreas Boehler  /**
1297cb71a62aSAndreas Boehler   * Update the sync token log based on the calendar id and the
1298cb71a62aSAndreas Boehler   * operation that was performed.
1299cb71a62aSAndreas Boehler   *
1300cb71a62aSAndreas Boehler   * @param string $calid The calendar ID that was modified
1301cb71a62aSAndreas Boehler   * @param string $uri The calendar URI that was modified
1302cb71a62aSAndreas Boehler   * @param string $operation The operation that was performed
1303cb71a62aSAndreas Boehler   *
1304cb71a62aSAndreas Boehler   * @return boolean True on success, otherwise false
1305cb71a62aSAndreas Boehler   */
130655a741c0SAndreas Boehler  private function updateSyncTokenLog($calid, $uri, $operation)
130755a741c0SAndreas Boehler  {
130855a741c0SAndreas Boehler      $currentToken = $this->getSyncTokenForCalendar($calid);
130955a741c0SAndreas Boehler      $operationCode = $this->operationNameToOperation($operation);
131055a741c0SAndreas Boehler      if(($operationCode === false) || ($currentToken === false))
131155a741c0SAndreas Boehler          return false;
131255a741c0SAndreas Boehler      $values = array($uri,
131355a741c0SAndreas Boehler                      $currentToken,
131455a741c0SAndreas Boehler                      $calid,
131555a741c0SAndreas Boehler                      $operationCode
131655a741c0SAndreas Boehler      );
131751f4febbSAndreas Boehler      $query = "INSERT INTO calendarchanges (uri, synctoken, calendarid, operation) VALUES(?, ?, ?, ?)";
131851f4febbSAndreas Boehler      $res = $this->sqlite->query($query, $uri, $currentToken, $calid, $operationCode);
131955a741c0SAndreas Boehler      if($res === false)
132055a741c0SAndreas Boehler        return false;
132155a741c0SAndreas Boehler      $currentToken++;
132251f4febbSAndreas Boehler      $query = "UPDATE calendars SET synctoken = ? WHERE id = ?";
132351f4febbSAndreas Boehler      $res = $this->sqlite->query($query, $currentToken, $calid);
132455a741c0SAndreas Boehler      return ($res !== false);
132555a741c0SAndreas Boehler  }
132655a741c0SAndreas Boehler
1327cb71a62aSAndreas Boehler  /**
1328cb71a62aSAndreas Boehler   * Return the sync URL for a given Page, i.e. a calendar
1329cb71a62aSAndreas Boehler   *
1330cb71a62aSAndreas Boehler   * @param string $id The page's ID
1331cb71a62aSAndreas Boehler   * @param string $user (optional) The user's ID
1332cb71a62aSAndreas Boehler   *
1333cb71a62aSAndreas Boehler   * @return mixed The sync url or false
1334cb71a62aSAndreas Boehler   */
1335b269830cSAndreas Boehler  public function getSyncUrlForPage($id, $user = null)
1336b269830cSAndreas Boehler  {
133734a47953SAndreas Boehler      if(is_null($userid))
133834a47953SAndreas Boehler      {
133934a47953SAndreas Boehler        if(isset($_SERVER['REMOTE_USER']) && !is_null($_SERVER['REMOTE_USER']))
134034a47953SAndreas Boehler        {
134134a47953SAndreas Boehler          $userid = $_SERVER['REMOTE_USER'];
134234a47953SAndreas Boehler        }
134334a47953SAndreas Boehler        else
134434a47953SAndreas Boehler        {
134534a47953SAndreas Boehler          return false;
134634a47953SAndreas Boehler        }
134734a47953SAndreas Boehler      }
1348b269830cSAndreas Boehler
1349b269830cSAndreas Boehler      $calid = $this->getCalendarIdForPage($id);
1350b269830cSAndreas Boehler      if($calid === false)
1351b269830cSAndreas Boehler        return false;
1352b269830cSAndreas Boehler
1353b269830cSAndreas Boehler      $calsettings = $this->getCalendarSettings($calid);
1354b269830cSAndreas Boehler      if(!isset($calsettings['uri']))
1355b269830cSAndreas Boehler        return false;
1356b269830cSAndreas Boehler
1357b269830cSAndreas Boehler      $syncurl = DOKU_URL.'lib/plugins/davcal/calendarserver.php/calendars/'.$user.'/'.$calsettings['uri'];
1358b269830cSAndreas Boehler      return $syncurl;
1359b269830cSAndreas Boehler  }
1360b269830cSAndreas Boehler
1361cb71a62aSAndreas Boehler  /**
1362cb71a62aSAndreas Boehler   * Return the private calendar's URL for a given page
1363cb71a62aSAndreas Boehler   *
1364cb71a62aSAndreas Boehler   * @param string $id the page ID
1365cb71a62aSAndreas Boehler   *
1366cb71a62aSAndreas Boehler   * @return mixed The private URL or false
1367cb71a62aSAndreas Boehler   */
1368f69bb449SAndreas Boehler  public function getPrivateURLForPage($id)
1369f69bb449SAndreas Boehler  {
1370f69bb449SAndreas Boehler      $calid = $this->getCalendarIdForPage($id);
1371f69bb449SAndreas Boehler      if($calid === false)
1372f69bb449SAndreas Boehler        return false;
1373f69bb449SAndreas Boehler
1374f69bb449SAndreas Boehler      return $this->getPrivateURLForCalendar($calid);
1375f69bb449SAndreas Boehler  }
1376f69bb449SAndreas Boehler
1377cb71a62aSAndreas Boehler  /**
1378cb71a62aSAndreas Boehler   * Return the private calendar's URL for a given calendar ID
1379cb71a62aSAndreas Boehler   *
1380cb71a62aSAndreas Boehler   * @param string $calid The calendar's ID
1381cb71a62aSAndreas Boehler   *
1382cb71a62aSAndreas Boehler   * @return mixed The private URL or false
1383cb71a62aSAndreas Boehler   */
1384f69bb449SAndreas Boehler  public function getPrivateURLForCalendar($calid)
1385f69bb449SAndreas Boehler  {
1386185e2535SAndreas Boehler      if(isset($this->cachedValues['privateurl'][$calid]))
1387185e2535SAndreas Boehler        return $this->cachedValues['privateurl'][$calid];
138851f4febbSAndreas Boehler      $query = "SELECT url FROM calendartoprivateurlmapping WHERE calid = ?";
138951f4febbSAndreas Boehler      $res = $this->sqlite->query($query, $calid);
1390f69bb449SAndreas Boehler      $row = $this->sqlite->res2row($res);
1391f69bb449SAndreas Boehler      if(!isset($row['url']))
1392f69bb449SAndreas Boehler      {
1393f69bb449SAndreas Boehler          $url = uniqid("dokuwiki-").".ics";
139451f4febbSAndreas Boehler          $query = "INSERT INTO calendartoprivateurlmapping (url, calid) VALUES(?, ?)";
139551f4febbSAndreas Boehler          $res = $this->sqlite->query($query, $url, $calid);
1396f69bb449SAndreas Boehler          if($res === false)
1397f69bb449SAndreas Boehler            return false;
1398f69bb449SAndreas Boehler      }
1399f69bb449SAndreas Boehler      else
1400f69bb449SAndreas Boehler      {
1401f69bb449SAndreas Boehler          $url = $row['url'];
1402f69bb449SAndreas Boehler      }
1403185e2535SAndreas Boehler
1404185e2535SAndreas Boehler      $url = DOKU_URL.'lib/plugins/davcal/ics.php/'.$url;
1405185e2535SAndreas Boehler      $this->cachedValues['privateurl'][$calid] = $url;
1406185e2535SAndreas Boehler      return $url;
1407f69bb449SAndreas Boehler  }
1408f69bb449SAndreas Boehler
1409cb71a62aSAndreas Boehler  /**
1410cb71a62aSAndreas Boehler   * Retrieve the calendar ID for a given private calendar URL
1411cb71a62aSAndreas Boehler   *
1412cb71a62aSAndreas Boehler   * @param string $url The private URL
1413cb71a62aSAndreas Boehler   *
1414cb71a62aSAndreas Boehler   * @return mixed The calendar ID or false
1415cb71a62aSAndreas Boehler   */
1416f69bb449SAndreas Boehler  public function getCalendarForPrivateURL($url)
1417f69bb449SAndreas Boehler  {
141851f4febbSAndreas Boehler      $query = "SELECT calid FROM calendartoprivateurlmapping WHERE url = ?";
141951f4febbSAndreas Boehler      $res = $this->sqlite->query($query, $url);
1420f69bb449SAndreas Boehler      $row = $this->sqlite->res2row($res);
1421f69bb449SAndreas Boehler      if(!isset($row['calid']))
1422f69bb449SAndreas Boehler        return false;
1423f69bb449SAndreas Boehler      return $row['calid'];
1424f69bb449SAndreas Boehler  }
1425f69bb449SAndreas Boehler
1426cb71a62aSAndreas Boehler  /**
1427cb71a62aSAndreas Boehler   * Return a given calendar as ICS feed, i.e. all events in one ICS file.
1428cb71a62aSAndreas Boehler   *
14297e0b8590SAndreas Boehler   * @param string $calid The calendar ID to retrieve
1430cb71a62aSAndreas Boehler   *
1431cb71a62aSAndreas Boehler   * @return mixed The calendar events as string or false
1432cb71a62aSAndreas Boehler   */
1433f69bb449SAndreas Boehler  public function getCalendarAsICSFeed($calid)
1434f69bb449SAndreas Boehler  {
1435f69bb449SAndreas Boehler      $calSettings = $this->getCalendarSettings($calid);
1436f69bb449SAndreas Boehler      if($calSettings === false)
1437f69bb449SAndreas Boehler        return false;
1438f69bb449SAndreas Boehler      $events = $this->getAllCalendarEvents($calid);
1439f69bb449SAndreas Boehler      if($events === false)
1440f69bb449SAndreas Boehler        return false;
1441f69bb449SAndreas Boehler
14427e0b8590SAndreas Boehler      // Load SabreDAV
14437e0b8590SAndreas Boehler      require_once(DOKU_PLUGIN.'davcal/vendor/autoload.php');
14447e0b8590SAndreas Boehler      $out = "BEGIN:VCALENDAR\r\nVERSION:2.0\r\nPRODID:-//DAVCal//DAVCal for DokuWiki//EN\r\nCALSCALE:GREGORIAN\r\nX-WR-CALNAME:";
14457e0b8590SAndreas Boehler      $out .= $calSettings['displayname']."\r\n";
1446f69bb449SAndreas Boehler      foreach($events as $event)
1447f69bb449SAndreas Boehler      {
14487e0b8590SAndreas Boehler          $vcal = \Sabre\VObject\Reader::read($event['calendardata']);
14497e0b8590SAndreas Boehler          $evt = $vcal->VEVENT;
14507e0b8590SAndreas Boehler          $out .= $evt->serialize();
1451f69bb449SAndreas Boehler      }
14527e0b8590SAndreas Boehler      $out .= "END:VCALENDAR\r\n";
1453f69bb449SAndreas Boehler      return $out;
1454f69bb449SAndreas Boehler  }
1455f69bb449SAndreas Boehler
14567c7c6b0bSAndreas Boehler  /**
14577c7c6b0bSAndreas Boehler   * Retrieve a configuration option for the plugin
14587c7c6b0bSAndreas Boehler   *
14597c7c6b0bSAndreas Boehler   * @param string $key The key to query
146021d04f73SAndreas Boehler   * @return mixed The option set, null if not found
14617c7c6b0bSAndreas Boehler   */
14627c7c6b0bSAndreas Boehler  public function getConfig($key)
14637c7c6b0bSAndreas Boehler  {
14647c7c6b0bSAndreas Boehler      return $this->getConf($key);
14657c7c6b0bSAndreas Boehler  }
14667c7c6b0bSAndreas Boehler
1467d5703f5aSAndreas Boehler  /**
1468d5703f5aSAndreas Boehler   * Parses some information from calendar objects, used for optimized
1469d5703f5aSAndreas Boehler   * calendar-queries. Taken nearly unmodified from Sabre's PDO backend
1470d5703f5aSAndreas Boehler   *
1471d5703f5aSAndreas Boehler   * Returns an array with the following keys:
1472d5703f5aSAndreas Boehler   *   * etag - An md5 checksum of the object without the quotes.
1473d5703f5aSAndreas Boehler   *   * size - Size of the object in bytes
1474d5703f5aSAndreas Boehler   *   * componentType - VEVENT, VTODO or VJOURNAL
1475d5703f5aSAndreas Boehler   *   * firstOccurence
1476d5703f5aSAndreas Boehler   *   * lastOccurence
1477d5703f5aSAndreas Boehler   *   * uid - value of the UID property
1478d5703f5aSAndreas Boehler   *
1479d5703f5aSAndreas Boehler   * @param string $calendarData
1480d5703f5aSAndreas Boehler   * @return array
1481d5703f5aSAndreas Boehler   */
1482d5703f5aSAndreas Boehler  protected function getDenormalizedData($calendarData)
1483d5703f5aSAndreas Boehler  {
1484d5703f5aSAndreas Boehler    require_once(DOKU_PLUGIN.'davcal/vendor/autoload.php');
1485d5703f5aSAndreas Boehler
1486d5703f5aSAndreas Boehler    $vObject = \Sabre\VObject\Reader::read($calendarData);
1487d5703f5aSAndreas Boehler    $componentType = null;
1488d5703f5aSAndreas Boehler    $component = null;
1489d5703f5aSAndreas Boehler    $firstOccurence = null;
1490d5703f5aSAndreas Boehler    $lastOccurence = null;
1491d5703f5aSAndreas Boehler    $uid = null;
1492d5703f5aSAndreas Boehler    foreach ($vObject->getComponents() as $component)
1493d5703f5aSAndreas Boehler    {
1494d5703f5aSAndreas Boehler        if ($component->name !== 'VTIMEZONE')
1495d5703f5aSAndreas Boehler        {
1496d5703f5aSAndreas Boehler            $componentType = $component->name;
1497d5703f5aSAndreas Boehler            $uid = (string)$component->UID;
1498d5703f5aSAndreas Boehler            break;
1499d5703f5aSAndreas Boehler        }
1500d5703f5aSAndreas Boehler    }
1501d5703f5aSAndreas Boehler    if (!$componentType)
1502d5703f5aSAndreas Boehler    {
1503d5703f5aSAndreas Boehler        return false;
1504d5703f5aSAndreas Boehler    }
1505d5703f5aSAndreas Boehler    if ($componentType === 'VEVENT')
1506d5703f5aSAndreas Boehler    {
1507d5703f5aSAndreas Boehler        $firstOccurence = $component->DTSTART->getDateTime()->getTimeStamp();
1508d5703f5aSAndreas Boehler        // Finding the last occurence is a bit harder
1509d5703f5aSAndreas Boehler        if (!isset($component->RRULE))
1510d5703f5aSAndreas Boehler        {
1511d5703f5aSAndreas Boehler            if (isset($component->DTEND))
1512d5703f5aSAndreas Boehler            {
1513d5703f5aSAndreas Boehler                $lastOccurence = $component->DTEND->getDateTime()->getTimeStamp();
1514d5703f5aSAndreas Boehler            }
1515d5703f5aSAndreas Boehler            elseif (isset($component->DURATION))
1516d5703f5aSAndreas Boehler            {
1517d5703f5aSAndreas Boehler                $endDate = clone $component->DTSTART->getDateTime();
1518d5703f5aSAndreas Boehler                $endDate->add(\Sabre\VObject\DateTimeParser::parse($component->DURATION->getValue()));
1519d5703f5aSAndreas Boehler                $lastOccurence = $endDate->getTimeStamp();
1520d5703f5aSAndreas Boehler            }
1521d5703f5aSAndreas Boehler            elseif (!$component->DTSTART->hasTime())
1522d5703f5aSAndreas Boehler            {
1523d5703f5aSAndreas Boehler                $endDate = clone $component->DTSTART->getDateTime();
1524d5703f5aSAndreas Boehler                $endDate->modify('+1 day');
1525d5703f5aSAndreas Boehler                $lastOccurence = $endDate->getTimeStamp();
1526d5703f5aSAndreas Boehler            }
1527d5703f5aSAndreas Boehler            else
1528d5703f5aSAndreas Boehler            {
1529d5703f5aSAndreas Boehler                $lastOccurence = $firstOccurence;
1530d5703f5aSAndreas Boehler            }
1531d5703f5aSAndreas Boehler        }
1532d5703f5aSAndreas Boehler        else
1533d5703f5aSAndreas Boehler        {
1534d5703f5aSAndreas Boehler            $it = new \Sabre\VObject\Recur\EventIterator($vObject, (string)$component->UID);
1535d5703f5aSAndreas Boehler            $maxDate = new \DateTime('2038-01-01');
1536d5703f5aSAndreas Boehler            if ($it->isInfinite())
1537d5703f5aSAndreas Boehler            {
1538d5703f5aSAndreas Boehler                $lastOccurence = $maxDate->getTimeStamp();
1539d5703f5aSAndreas Boehler            }
1540d5703f5aSAndreas Boehler            else
1541d5703f5aSAndreas Boehler            {
1542d5703f5aSAndreas Boehler                $end = $it->getDtEnd();
1543d5703f5aSAndreas Boehler                while ($it->valid() && $end < $maxDate)
1544d5703f5aSAndreas Boehler                {
1545d5703f5aSAndreas Boehler                    $end = $it->getDtEnd();
1546d5703f5aSAndreas Boehler                    $it->next();
1547d5703f5aSAndreas Boehler                }
1548d5703f5aSAndreas Boehler                $lastOccurence = $end->getTimeStamp();
1549d5703f5aSAndreas Boehler            }
1550d5703f5aSAndreas Boehler        }
1551d5703f5aSAndreas Boehler    }
1552d5703f5aSAndreas Boehler
1553d5703f5aSAndreas Boehler    return array(
1554d5703f5aSAndreas Boehler        'etag'           => md5($calendarData),
1555d5703f5aSAndreas Boehler        'size'           => strlen($calendarData),
1556d5703f5aSAndreas Boehler        'componentType'  => $componentType,
1557d5703f5aSAndreas Boehler        'firstOccurence' => $firstOccurence,
1558d5703f5aSAndreas Boehler        'lastOccurence'  => $lastOccurence,
1559d5703f5aSAndreas Boehler        'uid'            => $uid,
1560d5703f5aSAndreas Boehler    );
1561d5703f5aSAndreas Boehler
1562d5703f5aSAndreas Boehler  }
1563d5703f5aSAndreas Boehler
1564d5703f5aSAndreas Boehler  /**
1565d5703f5aSAndreas Boehler   * Query a calendar by ID and taking several filters into account.
1566d5703f5aSAndreas Boehler   * This is heavily based on Sabre's PDO backend.
1567d5703f5aSAndreas Boehler   *
1568d5703f5aSAndreas Boehler   * @param int $calendarId The calendar's ID
1569d5703f5aSAndreas Boehler   * @param array $filters The filter array to apply
1570d5703f5aSAndreas Boehler   *
1571d5703f5aSAndreas Boehler   * @return mixed The result
1572d5703f5aSAndreas Boehler   */
1573d5703f5aSAndreas Boehler  public function calendarQuery($calendarId, $filters)
1574d5703f5aSAndreas Boehler  {
1575*39787131SAndreas Boehler    dbglog('davcal::helper::calendarQuery');
1576d5703f5aSAndreas Boehler    $componentType = null;
1577d5703f5aSAndreas Boehler    $requirePostFilter = true;
1578d5703f5aSAndreas Boehler    $timeRange = null;
1579d5703f5aSAndreas Boehler
1580d5703f5aSAndreas Boehler    // if no filters were specified, we don't need to filter after a query
1581d5703f5aSAndreas Boehler    if (!$filters['prop-filters'] && !$filters['comp-filters'])
1582d5703f5aSAndreas Boehler    {
1583d5703f5aSAndreas Boehler        $requirePostFilter = false;
1584d5703f5aSAndreas Boehler    }
1585d5703f5aSAndreas Boehler
1586d5703f5aSAndreas Boehler    // Figuring out if there's a component filter
1587d5703f5aSAndreas Boehler    if (count($filters['comp-filters']) > 0 && !$filters['comp-filters'][0]['is-not-defined'])
1588d5703f5aSAndreas Boehler    {
1589d5703f5aSAndreas Boehler        $componentType = $filters['comp-filters'][0]['name'];
1590d5703f5aSAndreas Boehler
1591d5703f5aSAndreas Boehler        // Checking if we need post-filters
1592d5703f5aSAndreas Boehler        if (!$filters['prop-filters'] && !$filters['comp-filters'][0]['comp-filters'] && !$filters['comp-filters'][0]['time-range'] && !$filters['comp-filters'][0]['prop-filters'])
1593d5703f5aSAndreas Boehler        {
1594d5703f5aSAndreas Boehler            $requirePostFilter = false;
1595d5703f5aSAndreas Boehler        }
1596d5703f5aSAndreas Boehler        // There was a time-range filter
1597d5703f5aSAndreas Boehler        if ($componentType == 'VEVENT' && isset($filters['comp-filters'][0]['time-range']))
1598d5703f5aSAndreas Boehler        {
1599d5703f5aSAndreas Boehler            $timeRange = $filters['comp-filters'][0]['time-range'];
1600d5703f5aSAndreas Boehler
1601d5703f5aSAndreas Boehler            // If start time OR the end time is not specified, we can do a
1602d5703f5aSAndreas Boehler            // 100% accurate mysql query.
1603d5703f5aSAndreas Boehler            if (!$filters['prop-filters'] && !$filters['comp-filters'][0]['comp-filters'] && !$filters['comp-filters'][0]['prop-filters'] && (!$timeRange['start'] || !$timeRange['end']))
1604d5703f5aSAndreas Boehler            {
1605d5703f5aSAndreas Boehler                $requirePostFilter = false;
1606d5703f5aSAndreas Boehler            }
1607d5703f5aSAndreas Boehler        }
1608d5703f5aSAndreas Boehler
1609d5703f5aSAndreas Boehler    }
1610d5703f5aSAndreas Boehler
1611d5703f5aSAndreas Boehler    if ($requirePostFilter)
1612d5703f5aSAndreas Boehler    {
1613d5703f5aSAndreas Boehler        $query = "SELECT uri, calendardata FROM calendarobjects WHERE calendarid = ?";
1614d5703f5aSAndreas Boehler    }
1615d5703f5aSAndreas Boehler    else
1616d5703f5aSAndreas Boehler    {
1617d5703f5aSAndreas Boehler        $query = "SELECT uri FROM calendarobjects WHERE calendarid = ?";
1618d5703f5aSAndreas Boehler    }
1619d5703f5aSAndreas Boehler
1620d5703f5aSAndreas Boehler    $values = array(
1621d5703f5aSAndreas Boehler        $calendarId
1622d5703f5aSAndreas Boehler    );
1623d5703f5aSAndreas Boehler
1624d5703f5aSAndreas Boehler    if ($componentType)
1625d5703f5aSAndreas Boehler    {
1626d5703f5aSAndreas Boehler        $query .= " AND componenttype = ?";
1627d5703f5aSAndreas Boehler        $values[] = $componentType;
1628d5703f5aSAndreas Boehler    }
1629d5703f5aSAndreas Boehler
1630d5703f5aSAndreas Boehler    if ($timeRange && $timeRange['start'])
1631d5703f5aSAndreas Boehler    {
1632d5703f5aSAndreas Boehler        $query .= " AND lastoccurence > ?";
1633d5703f5aSAndreas Boehler        $values[] = $timeRange['start']->getTimeStamp();
1634d5703f5aSAndreas Boehler    }
1635d5703f5aSAndreas Boehler    if ($timeRange && $timeRange['end'])
1636d5703f5aSAndreas Boehler    {
1637d5703f5aSAndreas Boehler        $query .= " AND firstoccurence < ?";
1638d5703f5aSAndreas Boehler        $values[] = $timeRange['end']->getTimeStamp();
1639d5703f5aSAndreas Boehler    }
1640d5703f5aSAndreas Boehler
1641*39787131SAndreas Boehler    dbglog($query);
1642d5703f5aSAndreas Boehler    $res = $this->sqlite->query($query, $values);
1643d5703f5aSAndreas Boehler    $arr = $this->sqlite->res2arr($res);
1644*39787131SAndreas Boehler    dbglog($arr);
1645d5703f5aSAndreas Boehler
1646d5703f5aSAndreas Boehler    $result = array();
1647d5703f5aSAndreas Boehler    foreach($arr as $row)
1648d5703f5aSAndreas Boehler    {
1649d5703f5aSAndreas Boehler        if ($requirePostFilter)
1650d5703f5aSAndreas Boehler        {
1651*39787131SAndreas Boehler            dbglog('requirePostFilter for');
1652*39787131SAndreas Boehler            dbglog($row);
1653*39787131SAndreas Boehler            dbglog($filters);
1654d5703f5aSAndreas Boehler            if (!$this->validateFilterForObject($row, $filters))
1655d5703f5aSAndreas Boehler            {
1656d5703f5aSAndreas Boehler                continue;
1657d5703f5aSAndreas Boehler            }
1658d5703f5aSAndreas Boehler        }
1659d5703f5aSAndreas Boehler        $result[] = $row['uri'];
1660d5703f5aSAndreas Boehler
1661d5703f5aSAndreas Boehler    }
1662d5703f5aSAndreas Boehler
1663d5703f5aSAndreas Boehler    return $result;
1664d5703f5aSAndreas Boehler  }
1665d5703f5aSAndreas Boehler
1666d5703f5aSAndreas Boehler  /**
1667d5703f5aSAndreas Boehler   * This method validates if a filter (as passed to calendarQuery) matches
1668d5703f5aSAndreas Boehler   * the given object. Taken from Sabre's PDO backend
1669d5703f5aSAndreas Boehler   *
1670d5703f5aSAndreas Boehler   * @param array $object
1671d5703f5aSAndreas Boehler   * @param array $filters
1672d5703f5aSAndreas Boehler   * @return bool
1673d5703f5aSAndreas Boehler   */
1674d5703f5aSAndreas Boehler  protected function validateFilterForObject($object, $filters)
1675d5703f5aSAndreas Boehler  {
1676d5703f5aSAndreas Boehler      require_once(DOKU_PLUGIN.'davcal/vendor/autoload.php');
1677d5703f5aSAndreas Boehler      // Unfortunately, setting the 'calendardata' here is optional. If
1678d5703f5aSAndreas Boehler      // it was excluded, we actually need another call to get this as
1679d5703f5aSAndreas Boehler      // well.
1680d5703f5aSAndreas Boehler      if (!isset($object['calendardata']))
1681d5703f5aSAndreas Boehler      {
1682*39787131SAndreas Boehler          dbglog('fetching object...');
1683d5703f5aSAndreas Boehler          $object = $this->getCalendarObjectByUri($object['calendarid'], $object['uri']);
1684d5703f5aSAndreas Boehler      }
1685d5703f5aSAndreas Boehler
1686*39787131SAndreas Boehler      dbglog('object to validate: ');
1687*39787131SAndreas Boehler      dbglog($object);
1688d5703f5aSAndreas Boehler      $vObject = \Sabre\VObject\Reader::read($object['calendardata']);
1689d5703f5aSAndreas Boehler      $validator = new \Sabre\CalDAV\CalendarQueryValidator();
1690d5703f5aSAndreas Boehler
1691*39787131SAndreas Boehler      $res = $validator->validate($vObject, $filters);
1692*39787131SAndreas Boehler      dbglog($res);
1693*39787131SAndreas Boehler      return $res;
1694d5703f5aSAndreas Boehler
1695d5703f5aSAndreas Boehler  }
1696d5703f5aSAndreas Boehler
1697d5703f5aSAndreas Boehler  /**
1698d5703f5aSAndreas Boehler   * Retrieve changes for a given calendar based on the given syncToken.
1699d5703f5aSAndreas Boehler   *
1700d5703f5aSAndreas Boehler   * @param int $calid The calendar's ID
1701d5703f5aSAndreas Boehler   * @param int $syncToken The supplied sync token
1702d5703f5aSAndreas Boehler   * @param int $syncLevel The sync level
1703d5703f5aSAndreas Boehler   * @param int $limit The limit of changes
1704d5703f5aSAndreas Boehler   *
1705d5703f5aSAndreas Boehler   * @return array The result
1706d5703f5aSAndreas Boehler   */
1707d5703f5aSAndreas Boehler  public function getChangesForCalendar($calid, $syncToken, $syncLevel, $limit = null)
1708d5703f5aSAndreas Boehler  {
1709d5703f5aSAndreas Boehler      // Current synctoken
1710d5703f5aSAndreas Boehler      $currentToken = $this->getSyncTokenForCalendar($calid);
1711d5703f5aSAndreas Boehler
1712d5703f5aSAndreas Boehler      if ($currentToken === false) return null;
1713d5703f5aSAndreas Boehler
1714d5703f5aSAndreas Boehler      $result = array(
1715d5703f5aSAndreas Boehler          'syncToken' => $currentToken,
1716d5703f5aSAndreas Boehler          'added'     => array(),
1717d5703f5aSAndreas Boehler          'modified'  => array(),
1718d5703f5aSAndreas Boehler          'deleted'   => array(),
1719d5703f5aSAndreas Boehler      );
1720d5703f5aSAndreas Boehler
1721d5703f5aSAndreas Boehler      if ($syncToken)
1722d5703f5aSAndreas Boehler      {
1723d5703f5aSAndreas Boehler
1724d5703f5aSAndreas Boehler          $query = "SELECT uri, operation FROM calendarchanges WHERE synctoken >= ? AND synctoken < ? AND calendarid = ? ORDER BY synctoken";
1725d5703f5aSAndreas Boehler          if ($limit > 0) $query .= " LIMIT " . (int)$limit;
1726d5703f5aSAndreas Boehler
1727d5703f5aSAndreas Boehler          // Fetching all changes
1728d5703f5aSAndreas Boehler          $res = $this->sqlite->query($query, $syncToken, $currentToken, $calid);
1729d5703f5aSAndreas Boehler          if($res === false)
1730d5703f5aSAndreas Boehler              return null;
1731d5703f5aSAndreas Boehler
1732d5703f5aSAndreas Boehler          $arr = $this->sqlite->res2arr($res);
1733d5703f5aSAndreas Boehler          $changes = array();
1734d5703f5aSAndreas Boehler
1735d5703f5aSAndreas Boehler          // This loop ensures that any duplicates are overwritten, only the
1736d5703f5aSAndreas Boehler          // last change on a node is relevant.
1737d5703f5aSAndreas Boehler          foreach($arr as $row)
1738d5703f5aSAndreas Boehler          {
1739d5703f5aSAndreas Boehler              $changes[$row['uri']] = $row['operation'];
1740d5703f5aSAndreas Boehler          }
1741d5703f5aSAndreas Boehler
1742d5703f5aSAndreas Boehler          foreach ($changes as $uri => $operation)
1743d5703f5aSAndreas Boehler          {
1744d5703f5aSAndreas Boehler              switch ($operation)
1745d5703f5aSAndreas Boehler              {
1746d5703f5aSAndreas Boehler                  case 1 :
1747d5703f5aSAndreas Boehler                      $result['added'][] = $uri;
1748d5703f5aSAndreas Boehler                      break;
1749d5703f5aSAndreas Boehler                  case 2 :
1750d5703f5aSAndreas Boehler                      $result['modified'][] = $uri;
1751d5703f5aSAndreas Boehler                      break;
1752d5703f5aSAndreas Boehler                  case 3 :
1753d5703f5aSAndreas Boehler                      $result['deleted'][] = $uri;
1754d5703f5aSAndreas Boehler                      break;
1755d5703f5aSAndreas Boehler              }
1756d5703f5aSAndreas Boehler
1757d5703f5aSAndreas Boehler          }
1758d5703f5aSAndreas Boehler      }
1759d5703f5aSAndreas Boehler      else
1760d5703f5aSAndreas Boehler      {
1761d5703f5aSAndreas Boehler          // No synctoken supplied, this is the initial sync.
1762d5703f5aSAndreas Boehler          $query = "SELECT uri FROM calendarobjects WHERE calendarid = ?";
1763d5703f5aSAndreas Boehler          $res = $this->sqlite->query($query);
1764d5703f5aSAndreas Boehler          $arr = $this->sqlite->res2arr($res);
1765d5703f5aSAndreas Boehler
1766d5703f5aSAndreas Boehler          $result['added'] = $arr;
1767d5703f5aSAndreas Boehler      }
1768d5703f5aSAndreas Boehler      return $result;
1769d5703f5aSAndreas Boehler  }
1770d5703f5aSAndreas Boehler
1771a1a3b679SAndreas Boehler}
1772