dav/common/dav_caldav_backend_private.inc.php

   1 <?php
   2
   3 class Sabre_CalDAV_Backend_Private extends Sabre_CalDAV_Backend_Common
   4 {
   5
   6
   7         /**
   8          * @var null|Sabre_CalDAV_Backend_Private
   9          */
  10         private static $instance = null;
  11
  12         /**
  13          * @static
  14          * @return Sabre_CalDAV_Backend_Private
  15          */
  16         public static function getInstance()
  17         {
  18                 if (self::$instance == null) {
  19                         self::$instance = new Sabre_CalDAV_Backend_Private();
  20                 }
  21                 return self::$instance;
  22         }
  23
  24
  25         /**
  26          * @return int
  27          */
  28         public function getNamespace()
  29         {
  30                 return CALDAV_NAMESPACE_PRIVATE;
  31         }
  32
  33         /**
  34          * @static
  35          * @return string
  36          */
  37         public static function getBackendTypeName() {
  38                 return t("Private Events");
  39         }
  40
  41         /**
  42          * @obsolete
  43          * @param array $calendar
  44          * @param int $user
  45          * @return array
  46          */
  47         public function getPermissionsCalendar($calendar, $user)
  48         {
  49                 if ($calendar["namespace"] == CALDAV_NAMESPACE_PRIVATE && $user == $calendar["namespace_id"]) return array("read"=> true, "write"=> true);
  50                 return array("read"=> false, "write"=> false);
  51         }
  52
  53         /**
  54          * @obsolete
  55          * @param array $calendar
  56          * @param int $user
  57          * @param string $calendarobject_id
  58          * @param null|array $item_arr
  59          * @return array
  60          */
  61         public function getPermissionsItem($calendar, $user, $calendarobject_id, $item_arr = null)
  62         {
  63                 return $this->getPermissionsCalendar($calendar, $user);
  64         }
  65
  66
  67         /**
  68          * @param array $row
  69          * @param array $calendar
  70          * @param string $base_path
  71          * @return array
  72          */
  73         private function jqcal2wdcal($row, $calendar, $base_path)
  74         {
  75                 $not      = q("SELECT COUNT(*) num FROM %s%snotifications WHERE `calendar_id` = %d AND `calendarobject_id` = %d",
  76                         CALDAV_SQL_DB, CALDAV_SQL_PREFIX, IntVal($row["calendar_id"]), IntVal($row["calendarobject_id"])
  77                 );
  78                 $editable = $this->getPermissionsItem($calendar["namespace_id"], $row["calendarobject_id"], $row);
  79
  80                 $end = wdcal_mySql2PhpTime($row["EndTime"]);
  81                 if ($row["IsAllDayEvent"]) $end -= 1;
  82
  83                 return array(
  84                         "jq_id"             => $row["id"],
  85                         "ev_id"             => $row["calendarobject_id"],
  86                         "summary"           => escape_tags($row["Summary"]),
  87                         "start"             => wdcal_mySql2PhpTime($row["StartTime"]),
  88                         "end"               => $end,
  89                         "is_allday"         => $row["IsAllDayEvent"],
  90                         "is_moredays"       => 0,
  91                         "is_recurring"      => $row["IsRecurring"],
  92                         "color"             => (is_null($row["Color"]) || $row["Color"] == "" ? $calendar["calendarcolor"] : $row["Color"]),
  93                         "is_editable"       => ($editable ? 1 : 0),
  94                         "is_editable_quick" => ($editable && !$row["IsRecurring"] ? 1 : 0),
  95                         "location"          => "Loc.",
  96                         "attendees"         => '',
  97                         "has_notification"  => ($not[0]["num"] > 0 ? 1 : 0),
  98                         "url_detail"        => $base_path . $row["calendarobject_id"] . "/",
  99                         "url_edit"          => $base_path . $row["calendarobject_id"] . "/edit/",
 100                         "special_type"      => "",
 101                 );
 102         }
 103
 104         /**
 105          * @param int $calendarId
 106          * @param string $sd
 107          * @param string $ed
 108          * @param string $base_path
 109          * @return array
 110          */
 111         public function listItemsByRange($calendarId, $sd, $ed, $base_path)
 112         {
 113                 $calendar = Sabre_CalDAV_Backend_Common::loadCalendarById($calendarId);
 114                 $von      = wdcal_php2MySqlTime($sd);
 115                 $bis      = wdcal_php2MySqlTime($ed);
 116
 117                 // @TODO Events, die früher angefangen haben, aber noch andauern
 118                 $evs = q("SELECT * FROM %s%sjqcalendar WHERE `calendar_id` = %d AND `starttime` between '%s' and '%s'",
 119                         CALDAV_SQL_DB, CALDAV_SQL_PREFIX,
 120                         IntVal($calendarId), dbesc($von), dbesc($bis));
 121
 122                 $events = array();
 123                 foreach ($evs as $row) $events[] = $this->jqcal2wdcal($row, $calendar, $base_path . $row["calendar_id"] . "/");
 124
 125                 return $events;
 126         }
 127
 128
 129         /**
 130          * @param int $calendar_id
 131          * @param int $calendarobject_id
 132          * @return string
 133          */
 134         public function getItemDetailRedirect($calendar_id, $calendarobject_id)
 135         {
 136                 return "/dav/wdcal/$calendar_id/$calendarobject_id/edit/";
 137         }
 138
 139         /**
 140          * Returns a list of calendars for a principal.
 141          *
 142          * Every project is an array with the following keys:
 143          *  * id, a unique id that will be used by other functions to modify the
 144          *    calendar. This can be the same as the uri or a database key.
 145          *  * uri, which the basename of the uri with which the calendar is
 146          *    accessed.
 147          *  * principaluri. The owner of the calendar. Almost always the same as
 148          *    principalUri passed to this method.
 149          *
 150          * Furthermore it can contain webdav properties in clark notation. A very
 151          * common one is '{DAV:}displayname'.
 152          *
 153          * @param string $principalUri
 154          * @return array
 155          */
 156         public function getCalendarsForUser($principalUri)
 157         {
 158                 $n = dav_compat_principal2namespace($principalUri);
 159                 if ($n["namespace"] != $this->getNamespace()) return array();
 160
 161                 $cals = q("SELECT * FROM %s%scalendars WHERE `namespace` = %d AND `namespace_id` = %d", CALDAV_SQL_DB, CALDAV_SQL_PREFIX, $this->getNamespace(), IntVal($n["namespace_id"]));
 162                 $ret  = array();
 163                 foreach ($cals as $cal) {
 164                         if (in_array($cal["uri"], $GLOBALS["CALDAV_PRIVATE_SYSTEM_CALENDARS"])) continue;
 165
 166                         $dat = array(
 167                                 "id"                                                      => $cal["id"],
 168                                 "uri"                                                     => $cal["uri"],
 169                                 "principaluri"                                            => $principalUri,
 170                                 '{' . Sabre_CalDAV_Plugin::NS_CALENDARSERVER . '}getctag' => $cal['ctag'] ? $cal['ctag'] : '0',
 171                                 "calendar_class"                                          => "Sabre_CalDAV_Calendar",
 172                         );
 173                         foreach ($this->propertyMap as $key=> $field) $dat[$key] = $cal[$field];
 174
 175                         $ret[] = $dat;
 176                 }
 177
 178                 return $ret;
 179         }
 180
 181
 182         /**
 183          * Creates a new calendar for a principal.
 184          *
 185          * If the creation was a success, an id must be returned that can be used to reference
 186          * this calendar in other methods, such as updateCalendar.
 187          *
 188          * @param string $principalUri
 189          * @param string $calendarUri
 190          * @param array $properties
 191          * @throws Sabre_DAV_Exception
 192          * @return string|void
 193          */
 194         public function createCalendar($principalUri, $calendarUri, array $properties)
 195         {
 196
 197                 $uid = dav_compat_principal2uid($principalUri);
 198
 199                 $r = q("SELECT * FROM %s%scalendars WHERE `namespace` = %d AND `namespace_id` = %d AND `uri` = '%s'", CALDAV_SQL_DB, CALDAV_SQL_PREFIX, CALDAV_NAMESPACE_PRIVATE, $uid, dbesc($calendarUri));
 200                 if (count($r) > 0) throw new Sabre_DAV_Exception("A calendar with this URI already exists");
 201
 202                 $keys = array("`namespace`", "`namespace_id`", "`ctag`", "`uri`");
 203                 $vals = array(CALDAV_NAMESPACE_PRIVATE, IntVal($uid), 1, "'" . dbesc($calendarUri) . "'");
 204
 205                 // Default value
 206                 $sccs       = '{urn:ietf:params:xml:ns:caldav}supported-calendar-component-set';
 207                 $has_vevent = $has_vtodo = 1;
 208                 if (isset($properties[$sccs])) {
 209                         if (!($properties[$sccs] instanceof Sabre_CalDAV_Property_SupportedCalendarComponentSet)) {
 210                                 throw new Sabre_DAV_Exception('The ' . $sccs . ' property must be of type: Sabre_CalDAV_Property_SupportedCalendarComponentSet');
 211                         }
 212                         $v          = $properties[$sccs]->getValue();
 213                         $has_vevent = $has_vtodo = 0;
 214                         foreach ($v as $w) {
 215                                 if (mb_strtolower($w) == "vevent") $has_vevent = 1;
 216                                 if (mb_strtolower($w) == "vtodo") $has_vtodo = 1;
 217                         }
 218                 }
 219                 $keys[] = "`has_vevent`";
 220                 $keys[] = "`has_vtodo`";
 221                 $vals[] = $has_vevent;
 222                 $vals[] = $has_vtodo;
 223
 224                 foreach ($this->propertyMap as $xmlName=> $dbName) {
 225                         if (isset($properties[$xmlName])) {
 226                                 $keys[] = "`$dbName`";
 227                                 $vals[] = "'" . dbesc($properties[$xmlName]) . "'";
 228                         }
 229                 }
 230
 231                 $sql = sprintf("INSERT INTO %s%scalendars (" . implode(', ', $keys) . ") VALUES (" . implode(', ', $vals) . ")", CALDAV_SQL_DB, CALDAV_SQL_PREFIX);
 232
 233                 q($sql);
 234
 235                 $x = q("SELECT id FROM %s%scalendars WHERE `namespace` = %d AND `namespace_id` = %d AND `uri` = '%s'",
 236                         CALDAV_SQL_DB, CALDAV_SQL_PREFIX, CALDAV_NAMESPACE_PRIVATE, $uid, $calendarUri
 237                 );
 238                 return $x[0]["id"];
 239
 240         }
 241
 242         /**
 243          * Updates properties for a calendar.
 244          *
 245          * The mutations array uses the propertyName in clark-notation as key,
 246          * and the array value for the property value. In the case a property
 247          * should be deleted, the property value will be null.
 248          *
 249          * This method must be atomic. If one property cannot be changed, the
 250          * entire operation must fail.
 251          *
 252          * If the operation was successful, true can be returned.
 253          * If the operation failed, false can be returned.
 254          *
 255          * Deletion of a non-existent property is always successful.
 256          *
 257          * Lastly, it is optional to return detailed information about any
 258          * failures. In this case an array should be returned with the following
 259          * structure:
 260          *
 261          * array(
 262          *   403 => array(
 263          *      '{DAV:}displayname' => null,
 264          *   ),
 265          *   424 => array(
 266          *      '{DAV:}owner' => null,
 267          *   )
 268          * )
 269          *
 270          * In this example it was forbidden to update {DAV:}displayname.
 271          * (403 Forbidden), which in turn also caused {DAV:}owner to fail
 272          * (424 Failed Dependency) because the request needs to be atomic.
 273          *
 274          * @param string $calendarId
 275          * @param array $mutations
 276          * @return bool|array
 277          */
 278         public function updateCalendar($calendarId, array $mutations)
 279         {
 280
 281                 $newValues = array();
 282                 $result    = array(
 283                         200 => array(), // Ok
 284                         403 => array(), // Forbidden
 285                         424 => array(), // Failed Dependency
 286                 );
 287
 288                 $hasError = false;
 289
 290                 foreach ($mutations as $propertyName=> $propertyValue) {
 291
 292                         // We don't know about this property.
 293                         if (!isset($this->propertyMap[$propertyName])) {
 294                                 $hasError                   = true;
 295                                 $result[403][$propertyName] = null;
 296                                 unset($mutations[$propertyName]);
 297                                 continue;
 298                         }
 299
 300                         $fieldName             = $this->propertyMap[$propertyName];
 301                         $newValues[$fieldName] = $propertyValue;
 302
 303                 }
 304
 305                 // If there were any errors we need to fail the request
 306                 if ($hasError) {
 307                         // Properties has the remaining properties
 308                         foreach ($mutations as $propertyName=> $propertyValue) {
 309                                 $result[424][$propertyName] = null;
 310                         }
 311
 312                         // Removing unused statuscodes for cleanliness
 313                         foreach ($result as $status=> $properties) {
 314                                 if (is_array($properties) && count($properties) === 0) unset($result[$status]);
 315                         }
 316
 317                         return $result;
 318
 319                 }
 320
 321                 $sql = "`ctag` = `ctag` + 1";
 322                 foreach ($newValues as $key=> $val) $sql .= ", `" . $key . "` = '" . dbesc($val) . "'";
 323
 324                 $sql = sprintf("UPDATE %s%scalendars SET $sql WHERE `id` = %d", CALDAV_SQL_DB, CALDAV_SQL_PREFIX, IntVal($calendarId));
 325
 326                 q($sql);
 327
 328                 return true;
 329
 330         }
 331
 332
 333         /**
 334          * Delete a calendar and all it's objects
 335          *
 336          * @param string $calendarId
 337          * @return void
 338          */
 339         public function deleteCalendar($calendarId)
 340         {
 341                 q("DELETE FROM %s%scalendarobjects WHERE `calendar_id` = %d", CALDAV_SQL_DB, CALDAV_SQL_PREFIX, IntVal($calendarId));
 342                 q("DELETE FROM %s%scalendars WHERE `id` = %d", CALDAV_SQL_DB, CALDAV_SQL_PREFIX, IntVal($calendarId));
 343
 344         }
 345
 346
 347         /**
 348          * Returns all calendar objects within a calendar.
 349          *
 350          * Every item contains an array with the following keys:
 351          *   * id - unique identifier which will be used for subsequent updates
 352          *   * calendardata - The iCalendar-compatible calendar data
 353          *   * uri - a unique key which will be used to construct the uri. This can be any arbitrary string.
 354          *   * lastmodified - a timestamp of the last modification time
 355          *   * etag - An arbitrary string, surrounded by double-quotes. (e.g.:
 356          *   '  "abcdef"')
 357          *   * calendarid - The calendarid as it was passed to this function.
 358          *   * size - The size of the calendar objects, in bytes.
 359          *
 360          * Note that the etag is optional, but it's highly encouraged to return for
 361          * speed reasons.
 362          *
 363          * The calendardata is also optional. If it's not returned
 364          * 'getCalendarObject' will be called later, which *is* expected to return
 365          * calendardata.
 366          *
 367          * If neither etag or size are specified, the calendardata will be
 368          * used/fetched to determine these numbers. If both are specified the
 369          * amount of times this is needed is reduced by a great degree.
 370          *
 371          * @param mixed $calendarId
 372          * @return array
 373          */
 374         function getCalendarObjects($calendarId)
 375         {
 376                 $objs = q("SELECT * FROM %s%scalendarobjects WHERE `calendar_id` = %d", CALDAV_SQL_DB, CALDAV_SQL_PREFIX, IntVal($calendarId));
 377                 $ret  = array();
 378                 foreach ($objs as $obj) {
 379                         $ret[] = array(
 380                                 "id"           => IntVal($obj["id"]),
 381                                 "calendardata" => $obj["calendardata"],
 382                                 "uri"          => $obj["uri"],
 383                                 "lastmodified" => $obj["lastmodified"],
 384                                 "calendarid"   => $calendarId,
 385                                 "etag"         => $obj["etag"],
 386                                 "size"         => IntVal($obj["size"]),
 387                         );
 388                 }
 389                 return $ret;
 390         }
 391
 392         /**
 393          * Returns information from a single calendar object, based on it's object
 394          * uri.
 395          *
 396          * The returned array must have the same keys as getCalendarObjects. The
 397          * 'calendardata' object is required here though, while it's not required
 398          * for getCalendarObjects.
 399          *
 400          * @param string $calendarId
 401          * @param string $objectUri
 402          * @throws Sabre_DAV_Exception_NotFound
 403          * @return array
 404          */
 405         function getCalendarObject($calendarId, $objectUri)
 406         {
 407                 $o = q("SELECT * FROM %s%scalendarobjects WHERE `calendar_id` = %d AND `uri` = '%s'",
 408                         CALDAV_SQL_DB, CALDAV_SQL_PREFIX, IntVal($calendarId), dbesc($objectUri));
 409                 if (count($o) > 0) {
 410                         $o[0]["calendarid"]   = $calendarId;
 411                         $o[0]["calendardata"] = str_ireplace("Europe/Belgrade", "Europe/Berlin", $o[0]["calendardata"]);
 412                         return $o[0];
 413                 } else throw new Sabre_DAV_Exception_NotFound($calendarId . " / " . $objectUri);
 414         }
 415
 416         /**
 417          * Creates a new calendar object.
 418          *
 419          * It is possible return an etag from this function, which will be used in
 420          * the response to this PUT request. Note that the ETag must be surrounded
 421          * by double-quotes.
 422          *
 423          * However, you should only really return this ETag if you don't mangle the
 424          * calendar-data. If the result of a subsequent GET to this object is not
 425          * the exact same as this request body, you should omit the ETag.
 426          *
 427          * @param mixed $calendarId
 428          * @param string $objectUri
 429          * @param string $calendarData
 430          * @return string|null
 431          */
 432         function createCalendarObject($calendarId, $objectUri, $calendarData)
 433         {
 434                 $calendarData = icalendar_sanitize_string($calendarData);
 435
 436                 $extraData = $this->getDenormalizedData($calendarData);
 437
 438                 q("INSERT INTO %s%scalendarobjects (`calendar_id`, `uri`, `calendardata`, `lastmodified`, `componentType`, `firstOccurence`, `lastOccurence`, `etag`, `size`)
 439                         VALUES (%d, '%s', '%s', NOW(), '%s', '%s', '%s', '%s', %d)",
 440                         CALDAV_SQL_DB, CALDAV_SQL_PREFIX, IntVal($calendarId), dbesc($objectUri), addslashes($calendarData), dbesc($extraData['componentType']),
 441                         dbesc(wdcal_php2MySqlTime($extraData['firstOccurence'])), dbesc(wdcal_php2MySqlTime($extraData['lastOccurence'])), dbesc($extraData["etag"]), IntVal($extraData["size"])
 442                 );
 443
 444                 $this->increaseCalendarCtag($calendarId);
 445                 renderCalDavEntry_uri($objectUri);
 446
 447                 return '"' . $extraData['etag'] . '"';
 448         }
 449
 450         /**
 451          * Updates an existing calendarobject, based on it's uri.
 452          *
 453          * It is possible return an etag from this function, which will be used in
 454          * the response to this PUT request. Note that the ETag must be surrounded
 455          * by double-quotes.
 456          *
 457          * However, you should only really return this ETag if you don't mangle the
 458          * calendar-data. If the result of a subsequent GET to this object is not
 459          * the exact same as this request body, you should omit the ETag.
 460          *
 461          * @param mixed $calendarId
 462          * @param string $objectUri
 463          * @param string $calendarData
 464          * @return string|null
 465          */
 466         function updateCalendarObject($calendarId, $objectUri, $calendarData)
 467         {
 468                 $calendarData = icalendar_sanitize_string($calendarData);
 469
 470                 $extraData = $this->getDenormalizedData($calendarData);
 471
 472                 q("UPDATE %s%scalendarobjects SET `calendardata` = '%s', `lastmodified` = NOW(), `etag` = '%s', `size` = %d, `componentType` = '%s', `firstOccurence` = '%s', `lastOccurence` = '%s'
 473                         WHERE `calendar_id` = %d AND `uri` = '%s'",
 474                         CALDAV_SQL_DB, CALDAV_SQL_PREFIX, dbesc($calendarData), dbesc($extraData["etag"]), IntVal($extraData["size"]), dbesc($extraData["componentType"]),
 475                         dbesc(wdcal_php2MySqlTime($extraData["firstOccurence"])), dbesc(wdcal_php2MySqlTime($extraData["lastOccurence"])), IntVal($calendarId), dbesc($objectUri));
 476
 477                 $this->increaseCalendarCtag($calendarId);
 478                 renderCalDavEntry_uri($objectUri);
 479
 480                 return '"' . $extraData['etag'] . '"';
 481         }
 482
 483         /**
 484          * Deletes an existing calendar object.
 485          *
 486          * @param string $calendarId
 487          * @param string $objectUri
 488          * @throws Sabre_DAV_Exception_NotFound
 489          * @return void
 490          */
 491         function deleteCalendarObject($calendarId, $objectUri)
 492         {
 493                 $r = q("SELECT `id` FROM %s%scalendarobjects WHERE `calendar_id` = %d AND `uri` = '%s'", CALDAV_SQL_DB, CALDAV_SQL_PREFIX, IntVal($calendarId), dbesc($objectUri));
 494                 if (count($r) == 0) throw new Sabre_DAV_Exception_NotFound();
 495
 496                 q("DELETE FROM %s%scalendarobjects WHERE `calendar_id` = %d AND `uri` = '%s'", CALDAV_SQL_DB, CALDAV_SQL_PREFIX, IntVal($calendarId), dbesc($objectUri));
 497
 498                 $this->increaseCalendarCtag($calendarId);
 499                 renderCalDavEntry_calobj_id($r[0]["id"]);
 500         }
 501 }