grommunio / grommunio-dav

lib/GrommunioIMipPlugin.php

Indentation +61 added lines, -61 removed lines

@@ -10,74 +10,74 @@
 namespace grommunio\DAV;
 
 class GrommunioIMipPlugin extends \Sabre\CalDAV\Schedule\IMipPlugin {
-	/**
-	 * Constructor.
-	 */
-	public function __construct(GrommunioDavBackend $gDavBackend, GLogger $glogger) {
-		$this->gDavBackend = $gDavBackend;
-		$this->logger = $glogger;
-	}
+    /**
+     * Constructor.
+     */
+    public function __construct(GrommunioDavBackend $gDavBackend, GLogger $glogger) {
+        $this->gDavBackend = $gDavBackend;
+        $this->logger = $glogger;
+    }
 
-	/**
-	 * Sends out meeting invitation.
-	 *
-	 * Using the information in iTipMessage to send out a meeting
-	 * invitation.
-	 */
-	public function schedule(\Sabre\VObject\ITip\Message $iTipMessage) {
-		$this->logger->trace("method: %s - recipient: %s - significantChange: %d - scheduleStatus: %s - message: %s", $iTipMessage->method, $iTipMessage->recipient, $iTipMessage->significantChange, $iTipMessage->scheduleStatus, $iTipMessage->message->serialize());
+    /**
+     * Sends out meeting invitation.
+     *
+     * Using the information in iTipMessage to send out a meeting
+     * invitation.
+     */
+    public function schedule(\Sabre\VObject\ITip\Message $iTipMessage) {
+        $this->logger->trace("method: %s - recipient: %s - significantChange: %d - scheduleStatus: %s - message: %s", $iTipMessage->method, $iTipMessage->recipient, $iTipMessage->significantChange, $iTipMessage->scheduleStatus, $iTipMessage->message->serialize());
 
-		if (!$iTipMessage->significantChange) {
-			if (!$iTipMessage->scheduleStatus) {
-				$iTipMessage->scheduleStatus = "1.0;We got the message, but it's not significant enough to warrant an email";
-			}
+        if (!$iTipMessage->significantChange) {
+            if (!$iTipMessage->scheduleStatus) {
+                $iTipMessage->scheduleStatus = "1.0;We got the message, but it's not significant enough to warrant an email";
+            }
 
-			return;
-		}
+            return;
+        }
 
-		$recipient = preg_replace('!^mailto:!i', '', $iTipMessage->recipient);
-		$session = $this->gDavBackend->GetSession();
-		$addrbook = $this->gDavBackend->GetAddressBook();
-		$store = $this->gDavBackend->GetStore($this->gDavBackend->GetUser());
-		$storeprops = mapi_getprops($store, [PR_IPM_OUTBOX_ENTRYID, PR_IPM_SENTMAIL_ENTRYID]);
-		if (!isset($storeprops[PR_IPM_OUTBOX_ENTRYID]) || !isset($storeprops[PR_IPM_SENTMAIL_ENTRYID])) {
-			/* handle error */
-			$this->logger->error("no outbox found aborting user: %s", $this->gDavBackend->GetUser());
+        $recipient = preg_replace('!^mailto:!i', '', $iTipMessage->recipient);
+        $session = $this->gDavBackend->GetSession();
+        $addrbook = $this->gDavBackend->GetAddressBook();
+        $store = $this->gDavBackend->GetStore($this->gDavBackend->GetUser());
+        $storeprops = mapi_getprops($store, [PR_IPM_OUTBOX_ENTRYID, PR_IPM_SENTMAIL_ENTRYID]);
+        if (!isset($storeprops[PR_IPM_OUTBOX_ENTRYID]) || !isset($storeprops[PR_IPM_SENTMAIL_ENTRYID])) {
+            /* handle error */
+            $this->logger->error("no outbox found aborting user: %s", $this->gDavBackend->GetUser());
 
-			return;
-		}
+            return;
+        }
 
-		/* create message and convert */
-		$outbox = mapi_msgstore_openentry($store, $storeprops[PR_IPM_OUTBOX_ENTRYID]);
-		$newmessage = mapi_folder_createmessage($outbox);
-		mapi_icaltomapi($session, $store, $addrbook, $newmessage, $iTipMessage->message->serialize(), false);
-		mapi_setprops($newmessage, [PR_SENTMAIL_ENTRYID => $storeprops[PR_IPM_SENTMAIL_ENTRYID], PR_DELETE_AFTER_SUBMIT => false]);
+        /* create message and convert */
+        $outbox = mapi_msgstore_openentry($store, $storeprops[PR_IPM_OUTBOX_ENTRYID]);
+        $newmessage = mapi_folder_createmessage($outbox);
+        mapi_icaltomapi($session, $store, $addrbook, $newmessage, $iTipMessage->message->serialize(), false);
+        mapi_setprops($newmessage, [PR_SENTMAIL_ENTRYID => $storeprops[PR_IPM_SENTMAIL_ENTRYID], PR_DELETE_AFTER_SUBMIT => false]);
 
-		/* clean the recipients (needed since mapi_icaltomapi does not take IC2M_NO_ORGANIZER) */
-		$recipientTable = mapi_message_getrecipienttable($newmessage);
-		$recipientRows = mapi_table_queryallrows($recipientTable, [PR_SMTP_ADDRESS, PR_ROWID]);
-		$removeRecipients = [];
-		foreach ($recipientRows as $key => $recip) {
-			if (!isset($recip[PR_SMTP_ADDRESS])) {
-				continue;
-			}
-			if (strcasecmp($recip[PR_SMTP_ADDRESS], $recipient) != 0) {
-				$removeRecipients[] = $recip;
-			}
-		}
-		if (count($removeRecipients) == count($recipientRows)) {
-			$this->logger->error("message will have no recipients. List to remove: %s - recipientRows: %s", $removeRecipients, $recipientRows);
+        /* clean the recipients (needed since mapi_icaltomapi does not take IC2M_NO_ORGANIZER) */
+        $recipientTable = mapi_message_getrecipienttable($newmessage);
+        $recipientRows = mapi_table_queryallrows($recipientTable, [PR_SMTP_ADDRESS, PR_ROWID]);
+        $removeRecipients = [];
+        foreach ($recipientRows as $key => $recip) {
+            if (!isset($recip[PR_SMTP_ADDRESS])) {
+                continue;
+            }
+            if (strcasecmp($recip[PR_SMTP_ADDRESS], $recipient) != 0) {
+                $removeRecipients[] = $recip;
+            }
+        }
+        if (count($removeRecipients) == count($recipientRows)) {
+            $this->logger->error("message will have no recipients. List to remove: %s - recipientRows: %s", $removeRecipients, $recipientRows);
 
-			return;
-		}
-		if (count($removeRecipients) > 0) {
-			mapi_message_modifyrecipients($newmessage, MODRECIP_REMOVE, $removeRecipients);
-		}
+            return;
+        }
+        if (count($removeRecipients) > 0) {
+            mapi_message_modifyrecipients($newmessage, MODRECIP_REMOVE, $removeRecipients);
+        }
 
-		/* save message and send */
-		mapi_savechanges($newmessage);
-		mapi_message_submitmessage($newmessage);
-		$this->logger->info("email sent, recipient: %s", $recipient);
-		$iTipMessage->scheduleStatus = '1.1;Scheduling message sent via iMip';
-	}
+        /* save message and send */
+        mapi_savechanges($newmessage);
+        mapi_message_submitmessage($newmessage);
+        $this->logger->info("email sent, recipient: %s", $recipient);
+        $iTipMessage->scheduleStatus = '1.1;Scheduling message sent via iMip';
+    }
 }

lib/GrommunioSyncState.php

Indentation +87 added lines, -87 removed lines

@@ -10,105 +10,105 @@
 namespace grommunio\DAV;
 
 class GrommunioSyncState {
-	private $db;
+    private $db;
 
-	/**
-	 * Constructor.
-	 *
-	 * @param GLogger $logger
-	 * @param string  $dbstring
-	 */
-	public function __construct($logger, $dbstring) {
-		$this->logger = $logger;
-		$this->logger->trace("Using db %s", $dbstring);
-		$this->db = new \PDO($dbstring);
+    /**
+     * Constructor.
+     *
+     * @param GLogger $logger
+     * @param string  $dbstring
+     */
+    public function __construct($logger, $dbstring) {
+        $this->logger = $logger;
+        $this->logger->trace("Using db %s", $dbstring);
+        $this->db = new \PDO($dbstring);
 
-		$query = "CREATE TABLE IF NOT EXISTS gdav_sync_state (
+        $query = "CREATE TABLE IF NOT EXISTS gdav_sync_state (
             id VARCHAR(255), folderid VARCHAR(255), value TEXT,
             PRIMARY KEY (id, folderid));
             CREATE TABLE IF NOT EXISTS gdav_sync_appttsref (
             sourcekey VARCHAR(255), folderid VARCHAR(255), appttsref VARCHAR(255),
             PRIMARY KEY (sourcekey, folderid));";
 
-		$this->db->exec($query);
-	}
+        $this->db->exec($query);
+    }
 
-	/**
-	 * Fetch state information for a folderId (e.g. calenderId) and an id (uuid).
-	 *
-	 * @param string $folderid
-	 * @param string $id
-	 *
-	 * @return string
-	 */
-	public function getState($folderid, $id) {
-		$query = "SELECT value FROM gdav_sync_state WHERE folderid = :folderid AND id = :id";
-		$statement = $this->db->prepare($query);
-		$statement->bindParam(":folderid", $folderid);
-		$statement->bindParam(":id", $id);
-		$statement->execute();
-		$result = $statement->fetch();
-		if (!$result) {
-			return null;
-		}
+    /**
+     * Fetch state information for a folderId (e.g. calenderId) and an id (uuid).
+     *
+     * @param string $folderid
+     * @param string $id
+     *
+     * @return string
+     */
+    public function getState($folderid, $id) {
+        $query = "SELECT value FROM gdav_sync_state WHERE folderid = :folderid AND id = :id";
+        $statement = $this->db->prepare($query);
+        $statement->bindParam(":folderid", $folderid);
+        $statement->bindParam(":id", $id);
+        $statement->execute();
+        $result = $statement->fetch();
+        if (!$result) {
+            return null;
+        }
 
-		return $result['value'];
-	}
+        return $result['value'];
+    }
 
-	/**
-	 * Set state information for a folderId (e.g. calenderId) and an id (uuid).
-	 * The state information is the sync token for ICS.
-	 *
-	 * @param string $folderid
-	 * @param string $id
-	 * @param string $value
-	 */
-	public function setState($folderid, $id, $value) {
-		$query = "REPLACE INTO gdav_sync_state (id, folderid, value) VALUES(:id, :folderid, :value)";
-		$statement = $this->db->prepare($query);
-		$statement->bindParam(":folderid", $folderid);
-		$statement->bindParam(":id", $id);
-		$statement->bindParam(":value", $value);
-		$statement->execute();
-	}
+    /**
+     * Set state information for a folderId (e.g. calenderId) and an id (uuid).
+     * The state information is the sync token for ICS.
+     *
+     * @param string $folderid
+     * @param string $id
+     * @param string $value
+     */
+    public function setState($folderid, $id, $value) {
+        $query = "REPLACE INTO gdav_sync_state (id, folderid, value) VALUES(:id, :folderid, :value)";
+        $statement = $this->db->prepare($query);
+        $statement->bindParam(":folderid", $folderid);
+        $statement->bindParam(":id", $id);
+        $statement->bindParam(":value", $value);
+        $statement->execute();
+    }
 
-	/**
-	 * Set the APPTTSREF (custom URL) for a folderId and source key.
-	 * This is needed for detecting the URL of deleted items reported by ICS.
-	 *
-	 * @param string $folderid
-	 * @param string $sourcekey
-	 * @param string $appttsref
-	 */
-	public function rememberAppttsref($folderid, $sourcekey, $appttsref) {
-		$query = "REPLACE INTO gdav_sync_appttsref (folderid, sourcekey, appttsref) VALUES(:folderid, :sourcekey, :appttsref)";
-		$statement = $this->db->prepare($query);
-		$statement->bindParam(":folderid", $folderid);
-		$statement->bindParam(":sourcekey", $sourcekey);
-		$statement->bindParam(":appttsref", $appttsref);
-		$statement->execute();
-	}
+    /**
+     * Set the APPTTSREF (custom URL) for a folderId and source key.
+     * This is needed for detecting the URL of deleted items reported by ICS.
+     *
+     * @param string $folderid
+     * @param string $sourcekey
+     * @param string $appttsref
+     */
+    public function rememberAppttsref($folderid, $sourcekey, $appttsref) {
+        $query = "REPLACE INTO gdav_sync_appttsref (folderid, sourcekey, appttsref) VALUES(:folderid, :sourcekey, :appttsref)";
+        $statement = $this->db->prepare($query);
+        $statement->bindParam(":folderid", $folderid);
+        $statement->bindParam(":sourcekey", $sourcekey);
+        $statement->bindParam(":appttsref", $appttsref);
+        $statement->execute();
+    }
 
-	/**
-	 * Get the APPTTSREF (custom URL) for a folderId and source key.
-	 * This is needed for detecting the URL of deleted items reported by ICS.
-	 *
-	 * @param string $folderid
-	 * @param string $sourcekey
-	 *
-	 * @return string
-	 */
-	public function getAppttsref($folderid, $sourcekey) {
-		$query = "SELECT appttsref FROM gdav_sync_appttsref WHERE folderid = :folderid AND sourcekey = :sourcekey";
-		$statement = $this->db->prepare($query);
-		$statement->bindParam(":folderid", $folderid);
-		$statement->bindParam(":sourcekey", $sourcekey);
-		$statement->execute();
-		$result = $statement->fetch();
-		if (!$result) {
-			return null;
-		}
+    /**
+     * Get the APPTTSREF (custom URL) for a folderId and source key.
+     * This is needed for detecting the URL of deleted items reported by ICS.
+     *
+     * @param string $folderid
+     * @param string $sourcekey
+     *
+     * @return string
+     */
+    public function getAppttsref($folderid, $sourcekey) {
+        $query = "SELECT appttsref FROM gdav_sync_appttsref WHERE folderid = :folderid AND sourcekey = :sourcekey";
+        $statement = $this->db->prepare($query);
+        $statement->bindParam(":folderid", $folderid);
+        $statement->bindParam(":sourcekey", $sourcekey);
+        $statement->execute();
+        $result = $statement->fetch();
+        if (!$result) {
+            return null;
+        }
 
-		return $result['appttsref'];
-	}
+        return $result['appttsref'];
+    }
 }

lib/GPSR3Logger.php

Indentation +101 added lines, -101 removed lines

@@ -10,117 +10,117 @@
 namespace grommunio\DAV;
 
 class GPSR3Logger implements \Psr\Log\LoggerInterface {
-	/**
-	 * log4php.
-	 *
-	 * @var Logger
-	 */
-	private $logger;
+    /**
+     * log4php.
+     *
+     * @var Logger
+     */
+    private $logger;
 
-	/**
-	 * Wraps a log4php logger into a PSR-3 compatible interface.
-	 *
-	 * @param Logger $logger
-	 */
-	public function __construct($logger) {
-		$this->logger = $logger;
-	}
+    /**
+     * Wraps a log4php logger into a PSR-3 compatible interface.
+     *
+     * @param Logger $logger
+     */
+    public function __construct($logger) {
+        $this->logger = $logger;
+    }
 
-	/**
-	 * Emergency message, like system down.
-	 *
-	 * @param string $message
-	 */
-	public function emergency($message, array $context = []) {
-		$this->logger->fatal($this->interpret($message, $context));
-	}
+    /**
+     * Emergency message, like system down.
+     *
+     * @param string $message
+     */
+    public function emergency($message, array $context = []) {
+        $this->logger->fatal($this->interpret($message, $context));
+    }
 
-	/**
-	 * Immediate Action required.
-	 *
-	 * @param string $message
-	 */
-	public function alert($message, array $context = []) {
-		$this->logger->fatal($this->interpret($message, $context));
-	}
+    /**
+     * Immediate Action required.
+     *
+     * @param string $message
+     */
+    public function alert($message, array $context = []) {
+        $this->logger->fatal($this->interpret($message, $context));
+    }
 
-	/**
-	 * Critical messages.
-	 *
-	 * @param string $message
-	 */
-	public function critical($message, array $context = []) {
-		$this->logger->fatal($this->interpret($message, $context));
-	}
+    /**
+     * Critical messages.
+     *
+     * @param string $message
+     */
+    public function critical($message, array $context = []) {
+        $this->logger->fatal($this->interpret($message, $context));
+    }
 
-	/**
-	 * Errors happening on runtime that need to be logged.
-	 *
-	 * @param string $message
-	 */
-	public function error($message, array $context = []) {
-		$this->logger->error($this->interpret($message, $context));
-	}
+    /**
+     * Errors happening on runtime that need to be logged.
+     *
+     * @param string $message
+     */
+    public function error($message, array $context = []) {
+        $this->logger->error($this->interpret($message, $context));
+    }
 
-	/**
-	 * Warnings (not necessarily errors).
-	 *
-	 * @param string $message
-	 */
-	public function warning($message, array $context = []) {
-		$this->logger->warn($this->interpret($message, $context));
-	}
+    /**
+     * Warnings (not necessarily errors).
+     *
+     * @param string $message
+     */
+    public function warning($message, array $context = []) {
+        $this->logger->warn($this->interpret($message, $context));
+    }
 
-	/**
-	 * Significant events (still normal).
-	 *
-	 * @param string $message
-	 */
-	public function notice($message, array $context = []) {
-		$this->logger->info($this->interpret($message, $context));
-	}
+    /**
+     * Significant events (still normal).
+     *
+     * @param string $message
+     */
+    public function notice($message, array $context = []) {
+        $this->logger->info($this->interpret($message, $context));
+    }
 
-	/**
-	 * Events with informational value.
-	 *
-	 * @param string $message
-	 */
-	public function info($message, array $context = []) {
-		$this->logger->info($this->interpret($message, $context));
-	}
+    /**
+     * Events with informational value.
+     *
+     * @param string $message
+     */
+    public function info($message, array $context = []) {
+        $this->logger->info($this->interpret($message, $context));
+    }
 
-	/**
-	 * Debug data.
-	 *
-	 * @param string $message
-	 */
-	public function debug($message, array $context = []) {
-		$this->logger->debug($this->interpret($message, $context));
-	}
+    /**
+     * Debug data.
+     *
+     * @param string $message
+     */
+    public function debug($message, array $context = []) {
+        $this->logger->debug($this->interpret($message, $context));
+    }
 
-	/**
-	 * Logs at a loglevel.
-	 *
-	 * @param mixed  $level
-	 * @param string $message
-	 */
-	public function log($level, $message, array $context = []) {
-		throw new \Exception('Please call specific logging message');
-	}
+    /**
+     * Logs at a loglevel.
+     *
+     * @param mixed  $level
+     * @param string $message
+     */
+    public function log($level, $message, array $context = []) {
+        throw new \Exception('Please call specific logging message');
+    }
 
-	/**
-	 * Interprets context values as string like in the PSR-3 example implementation.
-	 *
-	 * @param string $message
-	 *
-	 * @return string
-	 */
-	protected function interpret($message, array $context = []) {
-		$replace = [];
-		foreach ($context as $key => $val) {
-			$replace['{' . $key . '}'] = $val;
-		}
+    /**
+     * Interprets context values as string like in the PSR-3 example implementation.
+     *
+     * @param string $message
+     *
+     * @return string
+     */
+    protected function interpret($message, array $context = []) {
+        $replace = [];
+        foreach ($context as $key => $val) {
+            $replace['{' . $key . '}'] = $val;
+        }
 
-		return strtr($message, $replace);
-	}
+        return strtr($message, $replace);
+    }
 }

lib/GrommunioCardDavBackend.php

Indentation +349 added lines, -349 removed lines

@@ -10,353 +10,353 @@
 namespace grommunio\DAV;
 
 class GrommunioCardDavBackend extends \Sabre\CardDAV\Backend\AbstractBackend implements \Sabre\CardDAV\Backend\SyncSupport {
-	private $logger;
-	protected $gDavBackend;
-
-	public const FILE_EXTENSION = '.vcf';
-	public const CONTAINER_CLASS = 'IPF.Contact';
-	public const CONTAINER_CLASSES = ['IPF.Contact'];
-
-	/**
-	 * Constructor.
-	 */
-	public function __construct(GrommunioDavBackend $gDavBackend, GLogger $glogger) {
-		$this->gDavBackend = $gDavBackend;
-		$this->logger = $glogger;
-	}
-
-	/**
-	 * Returns the list of addressbooks for a specific user.
-	 *
-	 * Every addressbook should have the following properties:
-	 *   id - an arbitrary unique id
-	 *   uri - the 'basename' part of the url
-	 *   principaluri - Same as the passed parameter
-	 *
-	 * Any additional clark-notation property may be passed besides this. Some
-	 * common ones are :
-	 *   {DAV:}displayname
-	 *   {urn:ietf:params:xml:ns:carddav}addressbook-description
-	 *   {http://calendarserver.org/ns/}getctag
-	 *
-	 * @param string $principalUri
-	 *
-	 * @return array
-	 */
-	public function getAddressBooksForUser($principalUri) {
-		$this->logger->trace("principalUri: %s", $principalUri);
-
-		return $this->gDavBackend->GetFolders($principalUri, static::CONTAINER_CLASSES);
-	}
-
-	/**
-	 * Updates properties for an address book.
-	 *
-	 * The list of mutations is stored in a Sabre\DAV\PropPatch object.
-	 * To do the actual updates, you must tell this object which properties
-	 * you're going to process with the handle() method.
-	 *
-	 * Calling the handle method is like telling the PropPatch object "I
-	 * promise I can handle updating this property".
-	 *
-	 * Read the PropPatch documentation for more info and examples.
-	 *
-	 * @param string $addressBookId
-	 */
-	public function updateAddressBook($addressBookId, \Sabre\DAV\PropPatch $propPatch) {
-		// TODO is our logger able to log this object? It probably needs to be adapted.
-		$this->logger->trace("addressBookId: %s - proppatch: %s", $addressBookId, $propPatch);
-	}
-
-	/**
-	 * Creates a new address book.
-	 *
-	 * This method should return the id of the new address book. The id can be
-	 * in any format, including ints, strings, arrays or objects.
-	 *
-	 * @param string $principalUri
-	 * @param string $url          just the 'basename' of the url
-	 *
-	 * @return mixed
-	 */
-	public function createAddressBook($principalUri, $url, array $properties) {
-		$this->logger->trace("principalUri: %s - url: %s - properties: %s", $principalUri, $url, $properties);
-		// TODO Add displayname
-		return $this->gDavBackend->CreateFolder($principalUri, $url, static::CONTAINER_CLASS, "");
-	}
-
-	/**
-	 * Deletes an entire addressbook and all its contents.
-	 *
-	 * @param mixed $addressBookId
-	 */
-	public function deleteAddressBook($addressBookId) {
-		$this->logger->trace("addressBookId: %s", $addressBookId);
-		$success = $this->gDavBackend->DeleteFolder($addressBookId);
-		// TODO evaluate $success
-	}
-
-	/**
-	 * Returns all cards for a specific addressbook id.
-	 *
-	 * This method should return the following properties for each card:
-	 *   * carddata - raw vcard data
-	 *   * uri - Some unique url
-	 *   * lastmodified - A unix timestamp
-	 *
-	 * It's recommended to also return the following properties:
-	 *   * etag - A unique etag. This must change every time the card changes.
-	 *   * size - The size of the card in bytes.
-	 *
-	 * If these last two properties are provided, less time will be spent
-	 * calculating them. If they are specified, you can also omit carddata.
-	 * This may speed up certain requests, especially with large cards.
-	 *
-	 * @param mixed $addressbookId
-	 *
-	 * @return array
-	 */
-	public function getCards($addressbookId) {
-		$result = $this->gDavBackend->GetObjects($addressbookId, static::FILE_EXTENSION);
-		$this->logger->trace("addressbookId: %s found %d objects", $addressbookId, count($result));
-
-		return $result;
-	}
-
-	/**
-	 * Returns a specific card.
-	 *
-	 * The same set of properties must be returned as with getCards. The only
-	 * exception is that 'carddata' is absolutely required.
-	 *
-	 * If the card does not exist, you must return false.
-	 *
-	 * @param mixed    $addressBookId
-	 * @param string   $cardUri
-	 * @param resource $mapifolder    optional mapifolder resource, used if available
-	 *
-	 * @return array
-	 */
-	public function getCard($addressBookId, $cardUri, $mapifolder = null) {
-		$this->logger->trace("addressBookId: %s - cardUri: %s", $addressBookId, $cardUri);
-
-		if (!$mapifolder) {
-			$mapifolder = $this->gDavBackend->GetMapiFolder($addressBookId);
-		}
-
-		$mapimessage = $this->gDavBackend->GetMapiMessageForId($addressBookId, $cardUri, $mapifolder, static::FILE_EXTENSION);
-		if (!$mapimessage) {
-			$this->logger->debug("Object NOT FOUND");
-
-			return null;
-		}
-
-		$realId = $this->gDavBackend->GetIdOfMapiMessage($addressBookId, $mapimessage);
-
-		$session = $this->gDavBackend->GetSession();
-		$ab = $this->gDavBackend->GetAddressBook();
-
-		$vcf = mapi_mapitovcf($session, $ab, $mapimessage, []);
-		$this->logger->trace("vcf generated by mapi_mapitovcf: %s%s", PHP_EOL, $vcf);
-		$props = mapi_getprops($mapimessage, [PR_LAST_MODIFICATION_TIME]);
-		$r = [
-			'id' => $realId,
-			'uri' => $realId . static::FILE_EXTENSION,
-			'etag' => '"' . $props[PR_LAST_MODIFICATION_TIME] . '"',
-			'lastmodified' => $props[PR_LAST_MODIFICATION_TIME],
-			'carddata' => $vcf,
-			'size' => strlen($vcf),
-			'addressbookid' => $addressBookId,
-		];
-
-		$this->logger->trace("returned data id: %s - size: %d - etag: %s", $r['id'], $r['size'], $r['etag']);
-
-		return $r;
-	}
-
-	/**
-	 * Creates a new card.
-	 *
-	 * The addressbook id will be passed as the first argument. This is the
-	 * same id as it is returned from the getAddressBooksForUser method.
-	 *
-	 * The cardUri is a base uri, and doesn't include the full path. The
-	 * cardData argument is the vcard body, and is passed as a string.
-	 *
-	 * It is possible to return an ETag from this method. This ETag is for the
-	 * newly created resource, and must be enclosed with double quotes (that
-	 * is, the string itself must contain the double quotes).
-	 *
-	 * You should only return the ETag if you store the carddata as-is. If a
-	 * subsequent GET request on the same card does not have the same body,
-	 * byte-by-byte and you did return an ETag here, clients tend to get
-	 * confused.
-	 *
-	 * If you don't return an ETag, you can just return null.
-	 *
-	 * @param mixed  $addressBookId
-	 * @param string $cardUri
-	 * @param string $cardData
-	 *
-	 * @return null|string
-	 */
-	public function createCard($addressBookId, $cardUri, $cardData) {
-		$this->logger->trace("addressBookId: %s - cardUri: %s - cardData: %s", $addressBookId, $cardUri, $cardData);
-		$objectId = $this->gDavBackend->GetObjectIdFromObjectUri($cardUri, static::FILE_EXTENSION);
-		$folder = $this->gDavBackend->GetMapiFolder($addressBookId);
-		$mapimessage = $this->gDavBackend->CreateObject($addressBookId, $folder, $objectId);
-		$retval = $this->setData($addressBookId, $mapimessage, $cardData);
-		if (!$retval) {
-			return null;
-		}
-
-		return '"' . $retval . '"';
-	}
-
-	/**
-	 * Updates a card.
-	 *
-	 * The addressbook id will be passed as the first argument. This is the
-	 * same id as it is returned from the getAddressBooksForUser method.
-	 *
-	 * The cardUri is a base uri, and doesn't include the full path. The
-	 * cardData argument is the vcard body, and is passed as a string.
-	 *
-	 * It is possible to return an ETag from this method. This ETag should
-	 * match that of the updated resource, and must be enclosed with double
-	 * quotes (that is: the string itself must contain the actual quotes).
-	 *
-	 * You should only return the ETag if you store the carddata as-is. If a
-	 * subsequent GET request on the same card does not have the same body,
-	 * byte-by-byte and you did return an ETag here, clients tend to get
-	 * confused.
-	 *
-	 * If you don't return an ETag, you can just return null.
-	 *
-	 * @param mixed  $addressBookId
-	 * @param string $cardUri
-	 * @param string $cardData
-	 *
-	 * @return null|string
-	 */
-	public function updateCard($addressBookId, $cardUri, $cardData) {
-		$this->logger->trace("addressBookId: %s - cardUri: %s - cardData: %s", $addressBookId, $cardUri, $cardData);
-
-		$mapimessage = $this->gDavBackend->GetMapiMessageForId($addressBookId, $cardUri, null, static::FILE_EXTENSION);
-		$retval = $this->setData($addressBookId, $mapimessage, $cardData);
-		if (!$retval) {
-			return null;
-		}
-
-		return '"' . $retval . '"';
-	}
-
-	/**
-	 * Sets data for a contact.
-	 *
-	 * @param mixed       $addressBookId
-	 * @param MAPIMessage $mapimessage
-	 * @param string      $vcf
-	 *
-	 * @return null|string
-	 */
-	private function setData($addressBookId, $mapimessage, $vcf) {
-		$this->logger->trace("mapimessage: %s - vcf: %s", $mapimessage, $vcf);
-		$store = $this->gDavBackend->GetStoreById($addressBookId);
-		$session = $this->gDavBackend->GetSession();
-
-		$ok = mapi_vcftomapi($session, $store, $mapimessage, $vcf);
-		if ($ok) {
-			mapi_savechanges($mapimessage);
-			// $props = mapi_getprops($mapimessage, array(PR_LAST_MODIFICATION_TIME));
-			$props = mapi_getprops($mapimessage);
-
-			return $props[PR_LAST_MODIFICATION_TIME];
-		}
-
-		return null;
-	}
-
-	/**
-	 * Deletes a card.
-	 *
-	 * @param mixed  $addressBookId
-	 * @param string $cardUri
-	 *
-	 * @return bool
-	 */
-	public function deleteCard($addressBookId, $cardUri) {
-		$this->logger->trace("addressBookId: %s - cardUri: %s", $addressBookId, $cardUri);
-		$mapifolder = $this->gDavBackend->GetMapiFolder($addressBookId);
-		$objectId = $this->gDavBackend->GetObjectIdFromObjectUri($cardUri, static::FILE_EXTENSION);
-
-		// to delete we need the PR_ENTRYID of the message
-		// TODO move this part to GrommunioDavBackend
-		$mapimessage = $this->gDavBackend->GetMapiMessageForId($addressBookId, $cardUri, $mapifolder, static::FILE_EXTENSION);
-		$props = mapi_getprops($mapimessage, [PR_ENTRYID]);
-		mapi_folder_deletemessages($mapifolder, [$props[PR_ENTRYID]]);
-	}
-
-	/**
-	 * The getChanges method returns all the changes that have happened, since
-	 * the specified syncToken in the specified address book.
-	 *
-	 * This function should return an array, such as the following:
-	 *
-	 * [
-	 *   'syncToken' => 'The current synctoken',
-	 *   'added'   => [
-	 *      'new.txt',
-	 *   ],
-	 *   'modified'   => [
-	 *      'modified.txt',
-	 *   ],
-	 *   'deleted' => [
-	 *      'foo.php.bak',
-	 *      'old.txt'
-	 *   ]
-	 * ];
-	 *
-	 * The returned syncToken property should reflect the *current* syncToken
-	 * of the calendar, as reported in the {http://sabredav.org/ns}sync-token
-	 * property. This is needed here too, to ensure the operation is atomic.
-	 *
-	 * If the $syncToken argument is specified as null, this is an initial
-	 * sync, and all members should be reported.
-	 *
-	 * The modified property is an array of nodenames that have changed since
-	 * the last token.
-	 *
-	 * The deleted property is an array with nodenames, that have been deleted
-	 * from collection.
-	 *
-	 * The $syncLevel argument is basically the 'depth' of the report. If it's
-	 * 1, you only have to report changes that happened only directly in
-	 * immediate descendants. If it's 2, it should also include changes from
-	 * the nodes below the child collections. (grandchildren)
-	 *
-	 * The $limit argument allows a client to specify how many results should
-	 * be returned at most. If the limit is not specified, it should be treated
-	 * as infinite.
-	 *
-	 * If the limit (infinite or not) is higher than you're willing to return,
-	 * you should throw a Sabre\DAV\Exception\TooMuchMatches() exception.
-	 *
-	 * If the syncToken is expired (due to data cleanup) or unknown, you must
-	 * return null.
-	 *
-	 * The limit is 'suggestive'. You are free to ignore it.
-	 *
-	 * @param string $addressBookId
-	 * @param string $syncToken
-	 * @param int    $syncLevel
-	 * @param int    $limit
-	 *
-	 * @return array
-	 */
-	public function getChangesForAddressBook($addressBookId, $syncToken, $syncLevel, $limit = null) {
-		$this->logger->trace("addressBookId: %s - syncToken: %s - syncLevel: %d - limit: %d", $addressBookId, $syncToken, $syncLevel, $limit);
-
-		return $this->gDavBackend->Sync($addressBookId, $syncToken, static::FILE_EXTENSION, $limit);
-	}
+    private $logger;
+    protected $gDavBackend;
+
+    public const FILE_EXTENSION = '.vcf';
+    public const CONTAINER_CLASS = 'IPF.Contact';
+    public const CONTAINER_CLASSES = ['IPF.Contact'];
+
+    /**
+     * Constructor.
+     */
+    public function __construct(GrommunioDavBackend $gDavBackend, GLogger $glogger) {
+        $this->gDavBackend = $gDavBackend;
+        $this->logger = $glogger;
+    }
+
+    /**
+     * Returns the list of addressbooks for a specific user.
+     *
+     * Every addressbook should have the following properties:
+     *   id - an arbitrary unique id
+     *   uri - the 'basename' part of the url
+     *   principaluri - Same as the passed parameter
+     *
+     * Any additional clark-notation property may be passed besides this. Some
+     * common ones are :
+     *   {DAV:}displayname
+     *   {urn:ietf:params:xml:ns:carddav}addressbook-description
+     *   {http://calendarserver.org/ns/}getctag
+     *
+     * @param string $principalUri
+     *
+     * @return array
+     */
+    public function getAddressBooksForUser($principalUri) {
+        $this->logger->trace("principalUri: %s", $principalUri);
+
+        return $this->gDavBackend->GetFolders($principalUri, static::CONTAINER_CLASSES);
+    }
+
+    /**
+     * Updates properties for an address book.
+     *
+     * The list of mutations is stored in a Sabre\DAV\PropPatch object.
+     * To do the actual updates, you must tell this object which properties
+     * you're going to process with the handle() method.
+     *
+     * Calling the handle method is like telling the PropPatch object "I
+     * promise I can handle updating this property".
+     *
+     * Read the PropPatch documentation for more info and examples.
+     *
+     * @param string $addressBookId
+     */
+    public function updateAddressBook($addressBookId, \Sabre\DAV\PropPatch $propPatch) {
+        // TODO is our logger able to log this object? It probably needs to be adapted.
+        $this->logger->trace("addressBookId: %s - proppatch: %s", $addressBookId, $propPatch);
+    }
+
+    /**
+     * Creates a new address book.
+     *
+     * This method should return the id of the new address book. The id can be
+     * in any format, including ints, strings, arrays or objects.
+     *
+     * @param string $principalUri
+     * @param string $url          just the 'basename' of the url
+     *
+     * @return mixed
+     */
+    public function createAddressBook($principalUri, $url, array $properties) {
+        $this->logger->trace("principalUri: %s - url: %s - properties: %s", $principalUri, $url, $properties);
+        // TODO Add displayname
+        return $this->gDavBackend->CreateFolder($principalUri, $url, static::CONTAINER_CLASS, "");
+    }
+
+    /**
+     * Deletes an entire addressbook and all its contents.
+     *
+     * @param mixed $addressBookId
+     */
+    public function deleteAddressBook($addressBookId) {
+        $this->logger->trace("addressBookId: %s", $addressBookId);
+        $success = $this->gDavBackend->DeleteFolder($addressBookId);
+        // TODO evaluate $success
+    }
+
+    /**
+     * Returns all cards for a specific addressbook id.
+     *
+     * This method should return the following properties for each card:
+     *   * carddata - raw vcard data
+     *   * uri - Some unique url
+     *   * lastmodified - A unix timestamp
+     *
+     * It's recommended to also return the following properties:
+     *   * etag - A unique etag. This must change every time the card changes.
+     *   * size - The size of the card in bytes.
+     *
+     * If these last two properties are provided, less time will be spent
+     * calculating them. If they are specified, you can also omit carddata.
+     * This may speed up certain requests, especially with large cards.
+     *
+     * @param mixed $addressbookId
+     *
+     * @return array
+     */
+    public function getCards($addressbookId) {
+        $result = $this->gDavBackend->GetObjects($addressbookId, static::FILE_EXTENSION);
+        $this->logger->trace("addressbookId: %s found %d objects", $addressbookId, count($result));
+
+        return $result;
+    }
+
+    /**
+     * Returns a specific card.
+     *
+     * The same set of properties must be returned as with getCards. The only
+     * exception is that 'carddata' is absolutely required.
+     *
+     * If the card does not exist, you must return false.
+     *
+     * @param mixed    $addressBookId
+     * @param string   $cardUri
+     * @param resource $mapifolder    optional mapifolder resource, used if available
+     *
+     * @return array
+     */
+    public function getCard($addressBookId, $cardUri, $mapifolder = null) {
+        $this->logger->trace("addressBookId: %s - cardUri: %s", $addressBookId, $cardUri);
+
+        if (!$mapifolder) {
+            $mapifolder = $this->gDavBackend->GetMapiFolder($addressBookId);
+        }
+
+        $mapimessage = $this->gDavBackend->GetMapiMessageForId($addressBookId, $cardUri, $mapifolder, static::FILE_EXTENSION);
+        if (!$mapimessage) {
+            $this->logger->debug("Object NOT FOUND");
+
+            return null;
+        }
+
+        $realId = $this->gDavBackend->GetIdOfMapiMessage($addressBookId, $mapimessage);
+
+        $session = $this->gDavBackend->GetSession();
+        $ab = $this->gDavBackend->GetAddressBook();
+
+        $vcf = mapi_mapitovcf($session, $ab, $mapimessage, []);
+        $this->logger->trace("vcf generated by mapi_mapitovcf: %s%s", PHP_EOL, $vcf);
+        $props = mapi_getprops($mapimessage, [PR_LAST_MODIFICATION_TIME]);
+        $r = [
+            'id' => $realId,
+            'uri' => $realId . static::FILE_EXTENSION,
+            'etag' => '"' . $props[PR_LAST_MODIFICATION_TIME] . '"',
+            'lastmodified' => $props[PR_LAST_MODIFICATION_TIME],
+            'carddata' => $vcf,
+            'size' => strlen($vcf),
+            'addressbookid' => $addressBookId,
+        ];
+
+        $this->logger->trace("returned data id: %s - size: %d - etag: %s", $r['id'], $r['size'], $r['etag']);
+
+        return $r;
+    }
+
+    /**
+     * Creates a new card.
+     *
+     * The addressbook id will be passed as the first argument. This is the
+     * same id as it is returned from the getAddressBooksForUser method.
+     *
+     * The cardUri is a base uri, and doesn't include the full path. The
+     * cardData argument is the vcard body, and is passed as a string.
+     *
+     * It is possible to return an ETag from this method. This ETag is for the
+     * newly created resource, and must be enclosed with double quotes (that
+     * is, the string itself must contain the double quotes).
+     *
+     * You should only return the ETag if you store the carddata as-is. If a
+     * subsequent GET request on the same card does not have the same body,
+     * byte-by-byte and you did return an ETag here, clients tend to get
+     * confused.
+     *
+     * If you don't return an ETag, you can just return null.
+     *
+     * @param mixed  $addressBookId
+     * @param string $cardUri
+     * @param string $cardData
+     *
+     * @return null|string
+     */
+    public function createCard($addressBookId, $cardUri, $cardData) {
+        $this->logger->trace("addressBookId: %s - cardUri: %s - cardData: %s", $addressBookId, $cardUri, $cardData);
+        $objectId = $this->gDavBackend->GetObjectIdFromObjectUri($cardUri, static::FILE_EXTENSION);
+        $folder = $this->gDavBackend->GetMapiFolder($addressBookId);
+        $mapimessage = $this->gDavBackend->CreateObject($addressBookId, $folder, $objectId);
+        $retval = $this->setData($addressBookId, $mapimessage, $cardData);
+        if (!$retval) {
+            return null;
+        }
+
+        return '"' . $retval . '"';
+    }
+
+    /**
+     * Updates a card.
+     *
+     * The addressbook id will be passed as the first argument. This is the
+     * same id as it is returned from the getAddressBooksForUser method.
+     *
+     * The cardUri is a base uri, and doesn't include the full path. The
+     * cardData argument is the vcard body, and is passed as a string.
+     *
+     * It is possible to return an ETag from this method. This ETag should
+     * match that of the updated resource, and must be enclosed with double
+     * quotes (that is: the string itself must contain the actual quotes).
+     *
+     * You should only return the ETag if you store the carddata as-is. If a
+     * subsequent GET request on the same card does not have the same body,
+     * byte-by-byte and you did return an ETag here, clients tend to get
+     * confused.
+     *
+     * If you don't return an ETag, you can just return null.
+     *
+     * @param mixed  $addressBookId
+     * @param string $cardUri
+     * @param string $cardData
+     *
+     * @return null|string
+     */
+    public function updateCard($addressBookId, $cardUri, $cardData) {
+        $this->logger->trace("addressBookId: %s - cardUri: %s - cardData: %s", $addressBookId, $cardUri, $cardData);
+
+        $mapimessage = $this->gDavBackend->GetMapiMessageForId($addressBookId, $cardUri, null, static::FILE_EXTENSION);
+        $retval = $this->setData($addressBookId, $mapimessage, $cardData);
+        if (!$retval) {
+            return null;
+        }
+
+        return '"' . $retval . '"';
+    }
+
+    /**
+     * Sets data for a contact.
+     *
+     * @param mixed       $addressBookId
+     * @param MAPIMessage $mapimessage
+     * @param string      $vcf
+     *
+     * @return null|string
+     */
+    private function setData($addressBookId, $mapimessage, $vcf) {
+        $this->logger->trace("mapimessage: %s - vcf: %s", $mapimessage, $vcf);
+        $store = $this->gDavBackend->GetStoreById($addressBookId);
+        $session = $this->gDavBackend->GetSession();
+
+        $ok = mapi_vcftomapi($session, $store, $mapimessage, $vcf);
+        if ($ok) {
+            mapi_savechanges($mapimessage);
+            // $props = mapi_getprops($mapimessage, array(PR_LAST_MODIFICATION_TIME));
+            $props = mapi_getprops($mapimessage);
+
+            return $props[PR_LAST_MODIFICATION_TIME];
+        }
+
+        return null;
+    }
+
+    /**
+     * Deletes a card.
+     *
+     * @param mixed  $addressBookId
+     * @param string $cardUri
+     *
+     * @return bool
+     */
+    public function deleteCard($addressBookId, $cardUri) {
+        $this->logger->trace("addressBookId: %s - cardUri: %s", $addressBookId, $cardUri);
+        $mapifolder = $this->gDavBackend->GetMapiFolder($addressBookId);
+        $objectId = $this->gDavBackend->GetObjectIdFromObjectUri($cardUri, static::FILE_EXTENSION);
+
+        // to delete we need the PR_ENTRYID of the message
+        // TODO move this part to GrommunioDavBackend
+        $mapimessage = $this->gDavBackend->GetMapiMessageForId($addressBookId, $cardUri, $mapifolder, static::FILE_EXTENSION);
+        $props = mapi_getprops($mapimessage, [PR_ENTRYID]);
+        mapi_folder_deletemessages($mapifolder, [$props[PR_ENTRYID]]);
+    }
+
+    /**
+     * The getChanges method returns all the changes that have happened, since
+     * the specified syncToken in the specified address book.
+     *
+     * This function should return an array, such as the following:
+     *
+     * [
+     *   'syncToken' => 'The current synctoken',
+     *   'added'   => [
+     *      'new.txt',
+     *   ],
+     *   'modified'   => [
+     *      'modified.txt',
+     *   ],
+     *   'deleted' => [
+     *      'foo.php.bak',
+     *      'old.txt'
+     *   ]
+     * ];
+     *
+     * The returned syncToken property should reflect the *current* syncToken
+     * of the calendar, as reported in the {http://sabredav.org/ns}sync-token
+     * property. This is needed here too, to ensure the operation is atomic.
+     *
+     * If the $syncToken argument is specified as null, this is an initial
+     * sync, and all members should be reported.
+     *
+     * The modified property is an array of nodenames that have changed since
+     * the last token.
+     *
+     * The deleted property is an array with nodenames, that have been deleted
+     * from collection.
+     *
+     * The $syncLevel argument is basically the 'depth' of the report. If it's
+     * 1, you only have to report changes that happened only directly in
+     * immediate descendants. If it's 2, it should also include changes from
+     * the nodes below the child collections. (grandchildren)
+     *
+     * The $limit argument allows a client to specify how many results should
+     * be returned at most. If the limit is not specified, it should be treated
+     * as infinite.
+     *
+     * If the limit (infinite or not) is higher than you're willing to return,
+     * you should throw a Sabre\DAV\Exception\TooMuchMatches() exception.
+     *
+     * If the syncToken is expired (due to data cleanup) or unknown, you must
+     * return null.
+     *
+     * The limit is 'suggestive'. You are free to ignore it.
+     *
+     * @param string $addressBookId
+     * @param string $syncToken
+     * @param int    $syncLevel
+     * @param int    $limit
+     *
+     * @return array
+     */
+    public function getChangesForAddressBook($addressBookId, $syncToken, $syncLevel, $limit = null) {
+        $this->logger->trace("addressBookId: %s - syncToken: %s - syncLevel: %d - limit: %d", $addressBookId, $syncToken, $syncLevel, $limit);
+
+        return $this->gDavBackend->Sync($addressBookId, $syncToken, static::FILE_EXTENSION, $limit);
+    }
 }

lib/GrommunioDavBackend.php

Indentation +719 added lines, -719 removed lines

@@ -10,423 +10,423 @@ 
 namespace grommunio\DAV;
 
 class GrommunioDavBackend {
-	private $logger;
-	protected $session;
-	protected $stores;
-	protected $user;
-	protected $customprops;
-	protected $syncstate;
-
-	/**
-	 * Constructor.
-	 */
-	public function __construct(GLogger $glogger) {
-		$this->logger = $glogger;
-		$this->syncstate = new GrommunioSyncState($glogger, SYNC_DB);
-	}
-
-	/**
-	 * Connect to grommunio and create session.
-	 *
-	 * @param string $user
-	 * @param string $pass
-	 *
-	 * @return bool
-	 */
-	public function Logon($user, $pass) {
-		$this->logger->trace('%s / password', $user);
-
-		$gDavVersion = 'grommunio-dav' . @constant('GDAV_VERSION');
-		$userAgent = isset($_SERVER['HTTP_USER_AGENT']) ? $_SERVER['HTTP_USER_AGENT'] : 'unknown';
-		$this->session = mapi_logon_zarafa($user, $pass, MAPI_SERVER, null, null, 1, $gDavVersion, $userAgent);
-		if (!$this->session) {
-			$this->logger->info("Auth: ERROR - logon failed for user %s", $user);
-
-			return false;
-		}
-
-		$this->user = $user;
-		$this->logger->debug("Auth: OK - user %s - session %s", $this->user, $this->session);
-
-		return true;
-	}
-
-	/**
-	 * Returns the authenticated user.
-	 *
-	 * @return string
-	 */
-	public function GetUser() {
-		$this->logger->trace($this->user);
-
-		return $this->user;
-	}
-
-	/**
-	 * Create a folder with MAPI class.
-	 *
-	 * @param mixed  $principalUri
-	 * @param string $url
-	 * @param string $class
-	 * @param string $displayname
-	 *
-	 * @return string
-	 */
-	public function CreateFolder($principalUri, $url, $class, $displayname) {
-		$props = mapi_getprops($this->GetStore($principalUri), [PR_IPM_SUBTREE_ENTRYID]);
-		$folder = mapi_msgstore_openentry($this->GetStore($principalUri), $props[PR_IPM_SUBTREE_ENTRYID]);
-		$newfolder = mapi_folder_createfolder($folder, $url, $displayname);
-		mapi_setprops($newfolder, [PR_CONTAINER_CLASS => $class]);
-
-		return $url;
-	}
-
-	/**
-	 * Delete a folder with MAPI class.
-	 *
-	 * @param mixed $id
-	 *
-	 * @return bool
-	 */
-	public function DeleteFolder($id) {
-		$folder = $this->GetMapiFolder($id);
-		if (!$folder) {
-			return false;
-		}
-
-		$props = mapi_getprops($folder, [PR_ENTRYID, PR_PARENT_ENTRYID]);
-		$parentfolder = mapi_msgstore_openentry($this->GetStoreById($id), $props[PR_PARENT_ENTRYID]);
-		mapi_folder_deletefolder($parentfolder, $props[PR_ENTRYID]);
-
-		return true;
-	}
-
-	/**
-	 * Returns a list of folders for a MAPI class.
-	 *
-	 * @param string $principalUri
-	 * @param string $class
-	 * @param mixed  $classes
-	 *
-	 * @return array
-	 */
-	public function GetFolders($principalUri, $classes) {
-		$this->logger->trace("principal '%s', classes '%s'", $principalUri, $classes);
-		$folders = [];
-
-		// TODO limit the output to subfolders of the principalUri?
-
-		$rootfolder = mapi_msgstore_openentry($this->GetStore($principalUri));
-		$hierarchy = mapi_folder_gethierarchytable($rootfolder, CONVENIENT_DEPTH | MAPI_DEFERRED_ERRORS);
-		// TODO also filter hidden folders
-		$restrictions = [];
-		foreach ($classes as $class) {
-			$restrictions[] = [RES_PROPERTY, [RELOP => RELOP_EQ, ULPROPTAG => PR_CONTAINER_CLASS, VALUE => $class]];
-		}
-		mapi_table_restrict($hierarchy, [RES_OR, $restrictions]);
-
-		// TODO how to handle hierarchies?
-		$rows = mapi_table_queryallrows($hierarchy, [PR_DISPLAY_NAME, PR_ENTRYID, PR_SOURCE_KEY, PR_PARENT_SOURCE_KEY, PR_FOLDER_TYPE, PR_LOCAL_COMMIT_TIME_MAX]);
-
-		$rootprops = mapi_getprops($rootfolder, [PR_IPM_CONTACT_ENTRYID, PR_IPM_APPOINTMENT_ENTRYID]);
-		foreach ($rows as $row) {
-			if ($row[PR_FOLDER_TYPE] == FOLDER_SEARCH) {
-				continue;
-			}
-
-			$folder = [
-				'id' => $principalUri . ":" . bin2hex($row[PR_SOURCE_KEY]),
-				'uri' => $row[PR_DISPLAY_NAME],
-				'principaluri' => $principalUri,
-				'{http://sabredav.org/ns}sync-token' => '0000000000',
-				'{DAV:}displayname' => $row[PR_DISPLAY_NAME],
-				'{http://calendarserver.org/ns/}getctag' => isset($row[PR_LOCAL_COMMIT_TIME_MAX]) ? strval($row[PR_LOCAL_COMMIT_TIME_MAX]) : '0000000000',
-			];
-
-			// ensure default contacts folder is put first, some clients
-			// i.e. Apple Addressbook only supports one contact folder,
-			// therefore it is desired that folder is the default one.
-			if (in_array("IPF.Contact", $classes) && isset($rootprops[PR_IPM_CONTACT_ENTRYID]) && $row[PR_ENTRYID] == $rootprops[PR_IPM_CONTACT_ENTRYID]) {
-				array_unshift($folders, $folder);
-			}
-			// ensure default calendar folder is put first,
-			// before the tasks folder.
-			elseif (in_array('IPF.Appointment', $classes) && isset($rootprops[PR_IPM_APPOINTMENT_ENTRYID]) && $row[PR_ENTRYID] == $rootprops[PR_IPM_APPOINTMENT_ENTRYID]) {
-				array_unshift($folders, $folder);
-			}
-			else {
-				array_push($folders, $folder);
-			}
-		}
-		$this->logger->trace('found %d folders: %s', count($folders), $folders);
-
-		return $folders;
-	}
-
-	/**
-	 * Returns a list of objects for a folder given by the id.
-	 *
-	 * @param string $id
-	 * @param string $fileExtension
-	 * @param array  $filters
-	 *
-	 * @return array
-	 */
-	public function GetObjects($id, $fileExtension, $filters = []) {
-		$folder = $this->GetMapiFolder($id);
-		$properties = $this->GetCustomProperties($id);
-		$table = mapi_folder_getcontentstable($folder, MAPI_DEFERRED_ERRORS);
-
-		$restrictions = [];
-		if (isset($filters['start'], $filters['end'])) {
-			$this->logger->trace("got start: %d and end: %d", $filters['start'], $filters['end']);
-			$subrestriction = $this->GetCalendarRestriction($this->GetStoreById($id), $filters['start'], $filters['end']);
-			$restrictions[] = $subrestriction;
-		}
-		if (isset($filters['types'])) {
-			$this->logger->trace("got types: %s", $filters['types']);
-			$arr = [];
-			foreach ($filters['types'] as $filter) {
-				$arr[] = [RES_PROPERTY,
-					[RELOP => RELOP_EQ,
-						ULPROPTAG => PR_MESSAGE_CLASS,
-						VALUE => $filter,
-					],
-				];
-			}
-			$restrictions[] = [RES_OR, $arr];
-		}
-		if (!empty($restrictions)) {
-			$restriction = [RES_AND, $restrictions];
-			$this->logger->trace("Got restriction: %s", $restriction);
-			mapi_table_restrict($table, $restriction);
-		}
-
-		$rows = mapi_table_queryallrows($table, [PR_SOURCE_KEY, PR_LAST_MODIFICATION_TIME, PR_MESSAGE_SIZE, $properties['goid']]);
-
-		$results = [];
-		foreach ($rows as $row) {
-			$realId = "";
-			if (isset($row[$properties['goid']])) {
-				$realId = getUidFromGoid($row[$properties['goid']]);
-			}
-			if (!$realId) {
-				$realId = bin2hex($row[PR_SOURCE_KEY]);
-			}
-
-			$result = [
-				'id' => $realId,
-				'uri' => $realId . $fileExtension,
-				'etag' => '"' . $row[PR_LAST_MODIFICATION_TIME] . '"',
-				'lastmodified' => $row[PR_LAST_MODIFICATION_TIME],
-				'size' => $row[PR_MESSAGE_SIZE], // only approximation
-			];
-
-			if ($fileExtension == GrommunioCalDavBackend::FILE_EXTENSION) {
-				$result['calendarid'] = $id;
-			}
-			elseif ($fileExtension == GrommunioCardDavBackend::FILE_EXTENSION) {
-				$result['addressbookid'] = $id;
-			}
-			$results[] = $result;
-		}
-
-		return $results;
-	}
-
-	/**
-	 * Create the object and set appttsref.
-	 *
-	 * @param mixed  $folderId
-	 * @param string $folder
-	 * @param string $objectId
-	 *
-	 * @return mapiresource
-	 */
-	public function CreateObject($folderId, $folder, $objectId) {
-		$mapimessage = mapi_folder_createmessage($folder);
-		// we save the objectId in PROP_APPTTSREF so we find it by this id
-		$properties = $this->GetCustomProperties($folderId);
-		// FIXME: uid for contacts
-		$goid = getGoidFromUid($objectId);
-		mapi_setprops($mapimessage, [$properties['goid'] => $goid]);
-
-		return $mapimessage;
-	}
-
-	/**
-	 * Returns a mapi folder resource for a folderid (PR_SOURCE_KEY).
-	 *
-	 * @param string $folderid
-	 *
-	 * @return mapiresource
-	 */
-	public function GetMapiFolder($folderid) {
-		$this->logger->trace('Id: %s', $folderid);
-		$arr = explode(':', $folderid);
-		$entryid = mapi_msgstore_entryidfromsourcekey($this->GetStore($arr[0]), hex2bin($arr[1]));
-
-		return mapi_msgstore_openentry($this->GetStore($arr[0]), $entryid);
-	}
-
-	/**
-	 * Returns MAPI addressbook.
-	 *
-	 * @return MAPIAddressbook
-	 */
-	public function GetAddressBook() {
-		// TODO should be a singleton
-		return mapi_openaddressbook($this->session);
-	}
-
-	/**
-	 * Opens MAPI store for the user.
-	 *
-	 * @param string $username
-	 *
-	 * @return false|MAPIStore if store not available
-	 */
-	public function OpenMapiStore($username = null) {
-		$msgstorestable = mapi_getmsgstorestable($this->session);
-		$msgstores = mapi_table_queryallrows($msgstorestable, [PR_DEFAULT_STORE, PR_ENTRYID, PR_MDB_PROVIDER]);
-
-		$defaultstore = null;
-		$publicstore = null;
-		foreach ($msgstores as $row) {
-			if (isset($row[PR_DEFAULT_STORE]) && $row[PR_DEFAULT_STORE]) {
-				$defaultstore = $row[PR_ENTRYID];
-			}
-			if (isset($row[PR_MDB_PROVIDER]) && $row[PR_MDB_PROVIDER] == KOPANO_STORE_PUBLIC_GUID) {
-				$publicstore = $row[PR_ENTRYID];
-			}
-		}
-
-		/* user's own store or public store */
-		if ($username == $this->GetUser() && $defaultstore != null) {
-			return mapi_openmsgstore($this->session, $defaultstore);
-		}
-		if ($username == 'public' && $publicstore != null) {
-			return mapi_openmsgstore($this->session, $publicstore);
-		}
-
-		/* otherwise other user's store */
-		$store = mapi_openmsgstore($this->session, $defaultstore);
-		if (!$store) {
-			return false;
-		}
-		$otherstore = mapi_msgstore_createentryid($store, $username);
-
-		return mapi_openmsgstore($this->session, $otherstore);
-	}
-
-	/**
-	 * Returns store for the user.
-	 *
-	 * @param string $storename
-	 *
-	 * @return false|MAPIStore if the store is not available
-	 */
-	public function GetStore($storename) {
-		if ($storename == null) {
-			$storename = $this->GetUser();
-		}
-		else {
-			$storename = str_replace('principals/', '', $storename);
-		}
-		$this->logger->trace("storename %s", $storename);
-
-		/* We already got the store */
-		if (isset($this->stores[$storename]) && $this->stores[$storename] != null) {
-			return $this->stores[$storename];
-		}
-
-		$this->stores[$storename] = $this->OpenMapiStore($storename);
-		if (!$this->stores[$storename]) {
-			$this->logger->info("Auth: ERROR - unable to open store for %s (0x%08X)", $storename, mapi_last_hresult());
-
-			return false;
-		}
-
-		return $this->stores[$storename];
-	}
-
-	/**
-	 * Returns store from the id.
-	 *
-	 * @param mixed $id
-	 *
-	 * @return false|\grommunio\DAV\MAPIStore on error
-	 */
-	public function GetStoreById($id) {
-		$arr = explode(':', $id);
-
-		return $this->GetStore($arr[0]);
-	}
-
-	/**
-	 * Returns logon session.
-	 *
-	 * @return MAPISession
-	 */
-	public function GetSession() {
-		return $this->session;
-	}
-
-	/**
-	 * Returns an object ID of a mapi object.
-	 * If set, goid will be preferred. If not the PR_SOURCE_KEY of the message (as hex) will be returned.
-	 *
-	 * This order is reflected as well when searching for a message with these ids in GrommunioDavBackend->GetMapiMessageForId().
-	 *
-	 * @param string       $folderId
-	 * @param mapiresource $mapimessage
-	 *
-	 * @return string
-	 */
-	public function GetIdOfMapiMessage($folderId, $mapimessage) {
-		$this->logger->trace("Finding ID of %s", $mapimessage);
-		$properties = $this->GetCustomProperties($folderId);
-
-		// It's one of these, order:
-		// - GOID (if set)
-		// - PROP_VCARDUID (if set)
-		// - PR_SOURCE_KEY
-		$props = mapi_getprops($mapimessage, [$properties['goid'], PR_SOURCE_KEY]);
-		if (isset($props[$properties['goid']])) {
-			$id = getUidFromGoid($props[$properties['goid']]);
-			$this->logger->debug("Found uid %s from goid: %s", $id, bin2hex($props[$properties['goid']]));
-			if ($id != null) {
-				return $id;
-			}
-		}
-		// PR_SOURCE_KEY is always available
-		$id = bin2hex($props[PR_SOURCE_KEY]);
-		$this->logger->debug("Found PR_SOURCE_KEY: %s", $id);
-
-		return $id;
-	}
-
-	/**
-	 * Finds and opens a MapiMessage from an objectId.
-	 * The id can be a PROP_APPTTSREF or a PR_SOURCE_KEY (as hex).
-	 *
-	 * @param string       $folderId
-	 * @param string       $objectUri
-	 * @param mapiresource $mapifolder optional
-	 * @param string       $extension  optional
-	 *
-	 * @return null|mapiresource
-	 */
-	public function GetMapiMessageForId($folderId, $objectUri, $mapifolder = null, $extension = null) {
-		$this->logger->trace("Searching for '%s' in '%s' (%s) (%s)", $objectUri, $folderId, $mapifolder, $extension);
-
-		if (!$mapifolder) {
-			$mapifolder = $this->GetMapiFolder($folderId);
-		}
-
-		$id = $this->GetObjectIdFromObjectUri($objectUri, $extension);
-
-		/* The ID can be several different things:
+    private $logger;
+    protected $session;
+    protected $stores;
+    protected $user;
+    protected $customprops;
+    protected $syncstate;
+
+    /**
+     * Constructor.
+     */
+    public function __construct(GLogger $glogger) {
+        $this->logger = $glogger;
+        $this->syncstate = new GrommunioSyncState($glogger, SYNC_DB);
+    }
+
+    /**
+     * Connect to grommunio and create session.
+     *
+     * @param string $user
+     * @param string $pass
+     *
+     * @return bool
+     */
+    public function Logon($user, $pass) {
+        $this->logger->trace('%s / password', $user);
+
+        $gDavVersion = 'grommunio-dav' . @constant('GDAV_VERSION');
+        $userAgent = isset($_SERVER['HTTP_USER_AGENT']) ? $_SERVER['HTTP_USER_AGENT'] : 'unknown';
+        $this->session = mapi_logon_zarafa($user, $pass, MAPI_SERVER, null, null, 1, $gDavVersion, $userAgent);
+        if (!$this->session) {
+            $this->logger->info("Auth: ERROR - logon failed for user %s", $user);
+
+            return false;
+        }
+
+        $this->user = $user;
+        $this->logger->debug("Auth: OK - user %s - session %s", $this->user, $this->session);
+
+        return true;
+    }
+
+    /**
+     * Returns the authenticated user.
+     *
+     * @return string
+     */
+    public function GetUser() {
+        $this->logger->trace($this->user);
+
+        return $this->user;
+    }
+
+    /**
+     * Create a folder with MAPI class.
+     *
+     * @param mixed  $principalUri
+     * @param string $url
+     * @param string $class
+     * @param string $displayname
+     *
+     * @return string
+     */
+    public function CreateFolder($principalUri, $url, $class, $displayname) {
+        $props = mapi_getprops($this->GetStore($principalUri), [PR_IPM_SUBTREE_ENTRYID]);
+        $folder = mapi_msgstore_openentry($this->GetStore($principalUri), $props[PR_IPM_SUBTREE_ENTRYID]);
+        $newfolder = mapi_folder_createfolder($folder, $url, $displayname);
+        mapi_setprops($newfolder, [PR_CONTAINER_CLASS => $class]);
+
+        return $url;
+    }
+
+    /**
+     * Delete a folder with MAPI class.
+     *
+     * @param mixed $id
+     *
+     * @return bool
+     */
+    public function DeleteFolder($id) {
+        $folder = $this->GetMapiFolder($id);
+        if (!$folder) {
+            return false;
+        }
+
+        $props = mapi_getprops($folder, [PR_ENTRYID, PR_PARENT_ENTRYID]);
+        $parentfolder = mapi_msgstore_openentry($this->GetStoreById($id), $props[PR_PARENT_ENTRYID]);
+        mapi_folder_deletefolder($parentfolder, $props[PR_ENTRYID]);
+
+        return true;
+    }
+
+    /**
+     * Returns a list of folders for a MAPI class.
+     *
+     * @param string $principalUri
+     * @param string $class
+     * @param mixed  $classes
+     *
+     * @return array
+     */
+    public function GetFolders($principalUri, $classes) {
+        $this->logger->trace("principal '%s', classes '%s'", $principalUri, $classes);
+        $folders = [];
+
+        // TODO limit the output to subfolders of the principalUri?
+
+        $rootfolder = mapi_msgstore_openentry($this->GetStore($principalUri));
+        $hierarchy = mapi_folder_gethierarchytable($rootfolder, CONVENIENT_DEPTH | MAPI_DEFERRED_ERRORS);
+        // TODO also filter hidden folders
+        $restrictions = [];
+        foreach ($classes as $class) {
+            $restrictions[] = [RES_PROPERTY, [RELOP => RELOP_EQ, ULPROPTAG => PR_CONTAINER_CLASS, VALUE => $class]];
+        }
+        mapi_table_restrict($hierarchy, [RES_OR, $restrictions]);
+
+        // TODO how to handle hierarchies?
+        $rows = mapi_table_queryallrows($hierarchy, [PR_DISPLAY_NAME, PR_ENTRYID, PR_SOURCE_KEY, PR_PARENT_SOURCE_KEY, PR_FOLDER_TYPE, PR_LOCAL_COMMIT_TIME_MAX]);
+
+        $rootprops = mapi_getprops($rootfolder, [PR_IPM_CONTACT_ENTRYID, PR_IPM_APPOINTMENT_ENTRYID]);
+        foreach ($rows as $row) {
+            if ($row[PR_FOLDER_TYPE] == FOLDER_SEARCH) {
+                continue;
+            }
+
+            $folder = [
+                'id' => $principalUri . ":" . bin2hex($row[PR_SOURCE_KEY]),
+                'uri' => $row[PR_DISPLAY_NAME],
+                'principaluri' => $principalUri,
+                '{http://sabredav.org/ns}sync-token' => '0000000000',
+                '{DAV:}displayname' => $row[PR_DISPLAY_NAME],
+                '{http://calendarserver.org/ns/}getctag' => isset($row[PR_LOCAL_COMMIT_TIME_MAX]) ? strval($row[PR_LOCAL_COMMIT_TIME_MAX]) : '0000000000',
+            ];
+
+            // ensure default contacts folder is put first, some clients
+            // i.e. Apple Addressbook only supports one contact folder,
+            // therefore it is desired that folder is the default one.
+            if (in_array("IPF.Contact", $classes) && isset($rootprops[PR_IPM_CONTACT_ENTRYID]) && $row[PR_ENTRYID] == $rootprops[PR_IPM_CONTACT_ENTRYID]) {
+                array_unshift($folders, $folder);
+            }
+            // ensure default calendar folder is put first,
+            // before the tasks folder.
+            elseif (in_array('IPF.Appointment', $classes) && isset($rootprops[PR_IPM_APPOINTMENT_ENTRYID]) && $row[PR_ENTRYID] == $rootprops[PR_IPM_APPOINTMENT_ENTRYID]) {
+                array_unshift($folders, $folder);
+            }
+            else {
+                array_push($folders, $folder);
+            }
+        }
+        $this->logger->trace('found %d folders: %s', count($folders), $folders);
+
+        return $folders;
+    }
+
+    /**
+     * Returns a list of objects for a folder given by the id.
+     *
+     * @param string $id
+     * @param string $fileExtension
+     * @param array  $filters
+     *
+     * @return array
+     */
+    public function GetObjects($id, $fileExtension, $filters = []) {
+        $folder = $this->GetMapiFolder($id);
+        $properties = $this->GetCustomProperties($id);
+        $table = mapi_folder_getcontentstable($folder, MAPI_DEFERRED_ERRORS);
+
+        $restrictions = [];
+        if (isset($filters['start'], $filters['end'])) {
+            $this->logger->trace("got start: %d and end: %d", $filters['start'], $filters['end']);
+            $subrestriction = $this->GetCalendarRestriction($this->GetStoreById($id), $filters['start'], $filters['end']);
+            $restrictions[] = $subrestriction;
+        }
+        if (isset($filters['types'])) {
+            $this->logger->trace("got types: %s", $filters['types']);
+            $arr = [];
+            foreach ($filters['types'] as $filter) {
+                $arr[] = [RES_PROPERTY,
+                    [RELOP => RELOP_EQ,
+                        ULPROPTAG => PR_MESSAGE_CLASS,
+                        VALUE => $filter,
+                    ],
+                ];
+            }
+            $restrictions[] = [RES_OR, $arr];
+        }
+        if (!empty($restrictions)) {
+            $restriction = [RES_AND, $restrictions];
+            $this->logger->trace("Got restriction: %s", $restriction);
+            mapi_table_restrict($table, $restriction);
+        }
+
+        $rows = mapi_table_queryallrows($table, [PR_SOURCE_KEY, PR_LAST_MODIFICATION_TIME, PR_MESSAGE_SIZE, $properties['goid']]);
+
+        $results = [];
+        foreach ($rows as $row) {
+            $realId = "";
+            if (isset($row[$properties['goid']])) {
+                $realId = getUidFromGoid($row[$properties['goid']]);
+            }
+            if (!$realId) {
+                $realId = bin2hex($row[PR_SOURCE_KEY]);
+            }
+
+            $result = [
+                'id' => $realId,
+                'uri' => $realId . $fileExtension,
+                'etag' => '"' . $row[PR_LAST_MODIFICATION_TIME] . '"',
+                'lastmodified' => $row[PR_LAST_MODIFICATION_TIME],
+                'size' => $row[PR_MESSAGE_SIZE], // only approximation
+            ];
+
+            if ($fileExtension == GrommunioCalDavBackend::FILE_EXTENSION) {
+                $result['calendarid'] = $id;
+            }
+            elseif ($fileExtension == GrommunioCardDavBackend::FILE_EXTENSION) {
+                $result['addressbookid'] = $id;
+            }
+            $results[] = $result;
+        }
+
+        return $results;
+    }
+
+    /**
+     * Create the object and set appttsref.
+     *
+     * @param mixed  $folderId
+     * @param string $folder
+     * @param string $objectId
+     *
+     * @return mapiresource
+     */
+    public function CreateObject($folderId, $folder, $objectId) {
+        $mapimessage = mapi_folder_createmessage($folder);
+        // we save the objectId in PROP_APPTTSREF so we find it by this id
+        $properties = $this->GetCustomProperties($folderId);
+        // FIXME: uid for contacts
+        $goid = getGoidFromUid($objectId);
+        mapi_setprops($mapimessage, [$properties['goid'] => $goid]);
+
+        return $mapimessage;
+    }
+
+    /**
+     * Returns a mapi folder resource for a folderid (PR_SOURCE_KEY).
+     *
+     * @param string $folderid
+     *
+     * @return mapiresource
+     */
+    public function GetMapiFolder($folderid) {
+        $this->logger->trace('Id: %s', $folderid);
+        $arr = explode(':', $folderid);
+        $entryid = mapi_msgstore_entryidfromsourcekey($this->GetStore($arr[0]), hex2bin($arr[1]));
+
+        return mapi_msgstore_openentry($this->GetStore($arr[0]), $entryid);
+    }
+
+    /**
+     * Returns MAPI addressbook.
+     *
+     * @return MAPIAddressbook
+     */
+    public function GetAddressBook() {
+        // TODO should be a singleton
+        return mapi_openaddressbook($this->session);
+    }
+
+    /**
+     * Opens MAPI store for the user.
+     *
+     * @param string $username
+     *
+     * @return false|MAPIStore if store not available
+     */
+    public function OpenMapiStore($username = null) {
+        $msgstorestable = mapi_getmsgstorestable($this->session);
+        $msgstores = mapi_table_queryallrows($msgstorestable, [PR_DEFAULT_STORE, PR_ENTRYID, PR_MDB_PROVIDER]);
+
+        $defaultstore = null;
+        $publicstore = null;
+        foreach ($msgstores as $row) {
+            if (isset($row[PR_DEFAULT_STORE]) && $row[PR_DEFAULT_STORE]) {
+                $defaultstore = $row[PR_ENTRYID];
+            }
+            if (isset($row[PR_MDB_PROVIDER]) && $row[PR_MDB_PROVIDER] == KOPANO_STORE_PUBLIC_GUID) {
+                $publicstore = $row[PR_ENTRYID];
+            }
+        }
+
+        /* user's own store or public store */
+        if ($username == $this->GetUser() && $defaultstore != null) {
+            return mapi_openmsgstore($this->session, $defaultstore);
+        }
+        if ($username == 'public' && $publicstore != null) {
+            return mapi_openmsgstore($this->session, $publicstore);
+        }
+
+        /* otherwise other user's store */
+        $store = mapi_openmsgstore($this->session, $defaultstore);
+        if (!$store) {
+            return false;
+        }
+        $otherstore = mapi_msgstore_createentryid($store, $username);
+
+        return mapi_openmsgstore($this->session, $otherstore);
+    }
+
+    /**
+     * Returns store for the user.
+     *
+     * @param string $storename
+     *
+     * @return false|MAPIStore if the store is not available
+     */
+    public function GetStore($storename) {
+        if ($storename == null) {
+            $storename = $this->GetUser();
+        }
+        else {
+            $storename = str_replace('principals/', '', $storename);
+        }
+        $this->logger->trace("storename %s", $storename);
+
+        /* We already got the store */
+        if (isset($this->stores[$storename]) && $this->stores[$storename] != null) {
+            return $this->stores[$storename];
+        }
+
+        $this->stores[$storename] = $this->OpenMapiStore($storename);
+        if (!$this->stores[$storename]) {
+            $this->logger->info("Auth: ERROR - unable to open store for %s (0x%08X)", $storename, mapi_last_hresult());
+
+            return false;
+        }
+
+        return $this->stores[$storename];
+    }
+
+    /**
+     * Returns store from the id.
+     *
+     * @param mixed $id
+     *
+     * @return false|\grommunio\DAV\MAPIStore on error
+     */
+    public function GetStoreById($id) {
+        $arr = explode(':', $id);
+
+        return $this->GetStore($arr[0]);
+    }
+
+    /**
+     * Returns logon session.
+     *
+     * @return MAPISession
+     */
+    public function GetSession() {
+        return $this->session;
+    }
+
+    /**
+     * Returns an object ID of a mapi object.
+     * If set, goid will be preferred. If not the PR_SOURCE_KEY of the message (as hex) will be returned.
+     *
+     * This order is reflected as well when searching for a message with these ids in GrommunioDavBackend->GetMapiMessageForId().
+     *
+     * @param string       $folderId
+     * @param mapiresource $mapimessage
+     *
+     * @return string
+     */
+    public function GetIdOfMapiMessage($folderId, $mapimessage) {
+        $this->logger->trace("Finding ID of %s", $mapimessage);
+        $properties = $this->GetCustomProperties($folderId);
+
+        // It's one of these, order:
+        // - GOID (if set)
+        // - PROP_VCARDUID (if set)
+        // - PR_SOURCE_KEY
+        $props = mapi_getprops($mapimessage, [$properties['goid'], PR_SOURCE_KEY]);
+        if (isset($props[$properties['goid']])) {
+            $id = getUidFromGoid($props[$properties['goid']]);
+            $this->logger->debug("Found uid %s from goid: %s", $id, bin2hex($props[$properties['goid']]));
+            if ($id != null) {
+                return $id;
+            }
+        }
+        // PR_SOURCE_KEY is always available
+        $id = bin2hex($props[PR_SOURCE_KEY]);
+        $this->logger->debug("Found PR_SOURCE_KEY: %s", $id);
+
+        return $id;
+    }
+
+    /**
+     * Finds and opens a MapiMessage from an objectId.
+     * The id can be a PROP_APPTTSREF or a PR_SOURCE_KEY (as hex).
+     *
+     * @param string       $folderId
+     * @param string       $objectUri
+     * @param mapiresource $mapifolder optional
+     * @param string       $extension  optional
+     *
+     * @return null|mapiresource
+     */
+    public function GetMapiMessageForId($folderId, $objectUri, $mapifolder = null, $extension = null) {
+        $this->logger->trace("Searching for '%s' in '%s' (%s) (%s)", $objectUri, $folderId, $mapifolder, $extension);
+
+        if (!$mapifolder) {
+            $mapifolder = $this->GetMapiFolder($folderId);
+        }
+
+        $id = $this->GetObjectIdFromObjectUri($objectUri, $extension);
+
+        /* The ID can be several different things:
 		 * - a UID that is saved in goid
 		 * - a PROP_VCARDUID
 		 * - a PR_SOURCE_KEY
@@ -438,306 +438,306 @@ 
 		 *      if it's vcf:
 		 *          - search PROP_VCARDUID value
 		 */
-		$entryid = false;
-		$restriction = false;
-
-		if (ctype_xdigit($id) && strlen($id) % 2 == 0) {
-			$this->logger->trace("Try PR_SOURCE_KEY %s", $id);
-			$arr = explode(':', $folderId);
-			$entryid = mapi_msgstore_entryidfromsourcekey($this->GetStoreById($arr[0]), hex2bin($arr[1]), hex2bin($id));
-		}
-
-		if (!$entryid) {
-			$this->logger->trace("Entryid not found. Try goid/vcarduid %s", $id);
-
-			$properties = $this->GetCustomProperties($folderId);
-			if (strpos($id, '%40') !== false) {
-				$this->logger->debug("The id contains '%40'. Use urldecode.");
-				$id = urldecode($id);
-			}
-			$restriction = [];
-
-			if ($extension) {
-				if ($extension == GrommunioCalDavBackend::FILE_EXTENSION) {
-					$this->logger->trace("Try goid %s", $id);
-					$goid = getGoidFromUid($id);
-					$this->logger->trace("Try goid 0x%08X => %s", $properties["goid"], bin2hex($goid));
-					$restriction[] = [RES_PROPERTY, [RELOP => RELOP_EQ, ULPROPTAG => $properties["goid"], VALUE => $goid]];
-				}
-				elseif ($extension == GrommunioCardDavBackend::FILE_EXTENSION) {
-					$this->logger->trace("Try vcarduid %s", $id);
-					$restriction[] = [RES_PROPERTY, [RELOP => RELOP_EQ, ULPROPTAG => $properties["vcarduid"], VALUE => $id]];
-				}
-			}
-		}
-
-		// find the message if we have a restriction
-		if ($restriction) {
-			$table = mapi_folder_getcontentstable($mapifolder, MAPI_DEFERRED_ERRORS);
-			mapi_table_restrict($table, [RES_OR, $restriction]);
-			// Get requested properties, plus whatever we need
-			$proplist = [PR_ENTRYID];
-			$rows = mapi_table_queryallrows($table, $proplist);
-			if (count($rows) > 1) {
-				$this->logger->warn("Found %d entries for id '%s' searching for message", count($rows), $id);
-			}
-			if (isset($rows[0], $rows[0][PR_ENTRYID])) {
-				$entryid = $rows[0][PR_ENTRYID];
-			}
-		}
-		if ($entryid) {
-			$mapimessage = mapi_msgstore_openentry($this->GetStoreById($folderId), $entryid);
-			if (!$mapimessage) {
-				$this->logger->warn("Error, unable to open entry id: 0x%X", $entryid, mapi_last_hresult());
-
-				return null;
-			}
-
-			return $mapimessage;
-		}
-		$this->logger->debug("Nothing found for %s", $id);
-
-		return null;
-	}
-
-	/**
-	 * Returns the objectId from an objectUri. It strips the file extension
-	 * if it matches the passed one.
-	 *
-	 * @param string $objectUri
-	 * @param string $extension
-	 *
-	 * @return string
-	 */
-	public function GetObjectIdFromObjectUri($objectUri, $extension) {
-		if (!$extension) {
-			return $objectUri;
-		}
-		$extLength = strlen($extension);
-		if (substr($objectUri, -$extLength) === $extension) {
-			return substr($objectUri, 0, -$extLength);
-		}
-
-		return $objectUri;
-	}
-
-	/**
-	 * Checks if the PHP-MAPI extension is available and in a requested version.
-	 *
-	 * @param string $version the version to be checked ("6.30.10-18495", parts or build number)
-	 *
-	 * @return bool installed version is superior to the checked string
-	 */
-	protected function checkMapiExtVersion($version = "") {
-		if (!extension_loaded("mapi")) {
-			return false;
-		}
-		// compare build number if requested
-		if (preg_match('/^\d+$/', $version) && strlen($version) > 3) {
-			$vs = preg_split('/-/', phpversion("mapi"));
-
-			return $version <= $vs[1];
-		}
-		if (version_compare(phpversion("mapi"), $version) == -1) {
-			return false;
-		}
-
-		return true;
-	}
-
-	/**
-	 * Get named (custom) properties. Currently only PROP_APPTTSREF.
-	 *
-	 * @param string $id the folder id
-	 *
-	 * @return mixed
-	 */
-	protected function GetCustomProperties($id) {
-		if (!isset($this->customprops[$id])) {
-			$this->logger->trace("Fetching properties id:%s", $id);
-			$store = $this->GetStoreById($id);
-			$properties = getPropIdsFromStrings($store, ["goid" => "PT_BINARY:PSETID_Meeting:0x3", "vcarduid" => MapiProps::PROP_VCARDUID]);
-			$this->customprops[$id] = $properties;
-		}
-
-		return $this->customprops[$id];
-	}
-
-	/**
-	 * Create a MAPI restriction to use in the calendar which will
-	 * return future calendar items (until $end), plus those since $start.
-	 * Origins: Z-Push.
-	 *
-	 * @param MAPIStore $store the MAPI store
-	 * @param long      $start Timestamp since when to include messages
-	 * @param long      $end   Ending timestamp
-	 *
-	 * @return array
-	 */
-	// TODO getting named properties
-	public function GetCalendarRestriction($store, $start, $end) {
-		$props = MapiProps::GetAppointmentProperties();
-		$props = getPropIdsFromStrings($store, $props);
-
-		return [RES_OR,
-			[
-				// OR
-				// item.end > window.start && item.start < window.end
-				[RES_AND,
-					[
-						[RES_PROPERTY,
-							[RELOP => RELOP_LE,
-								ULPROPTAG => $props["starttime"],
-								VALUE => $end,
-							],
-						],
-						[RES_PROPERTY,
-							[RELOP => RELOP_GE,
-								ULPROPTAG => $props["endtime"],
-								VALUE => $start,
-							],
-						],
-					],
-				],
-				// OR
-				[RES_OR,
-					[
-						// OR
-						// (EXIST(recurrence_enddate_property) && item[isRecurring] == true && recurrence_enddate_property >= start)
-						[RES_AND,
-							[
-								[RES_EXIST,
-									[ULPROPTAG => $props["recurrenceend"],
-									],
-								],
-								[RES_PROPERTY,
-									[RELOP => RELOP_EQ,
-										ULPROPTAG => $props["isrecurring"],
-										VALUE => true,
-									],
-								],
-								[RES_PROPERTY,
-									[RELOP => RELOP_GE,
-										ULPROPTAG => $props["recurrenceend"],
-										VALUE => $start,
-									],
-								],
-							],
-						],
-						// OR
-						// (!EXIST(recurrence_enddate_property) && item[isRecurring] == true && item[start] <= end)
-						[RES_AND,
-							[
-								[RES_NOT,
-									[
-										[RES_EXIST,
-											[ULPROPTAG => $props["recurrenceend"],
-											],
-										],
-									],
-								],
-								[RES_PROPERTY,
-									[RELOP => RELOP_LE,
-										ULPROPTAG => $props["starttime"],
-										VALUE => $end,
-									],
-								],
-								[RES_PROPERTY,
-									[RELOP => RELOP_EQ,
-										ULPROPTAG => $props["isrecurring"],
-										VALUE => true,
-									],
-								],
-							],
-						],
-					],
-				], // EXISTS OR
-			],
-		];        // global OR
-	}
-
-	/**
-	 * Performs ICS based sync used from getChangesForAddressBook
-	 * / getChangesForCalendar.
-	 *
-	 * @param string $folderId
-	 * @param string $syncToken
-	 * @param string $fileExtension
-	 * @param int    $limit
-	 *
-	 * @return array
-	 */
-	public function Sync($folderId, $syncToken, $fileExtension, $limit = null) {
-		$arr = explode(':', $folderId);
-		$phpwrapper = new PHPWrapper($this->GetStoreById($folderId), $this->logger, $this->GetCustomProperties($folderId), $fileExtension, $this->syncstate, $arr[1]);
-		$mapiimporter = mapi_wrap_importcontentschanges($phpwrapper);
-
-		$mapifolder = $this->GetMapiFolder($folderId);
-		$exporter = mapi_openproperty($mapifolder, PR_CONTENTS_SYNCHRONIZER, IID_IExchangeExportChanges, 0, 0);
-		if (!$exporter) {
-			$this->logger->error("Unable to get exporter");
-
-			return null;
-		}
-
-		$stream = mapi_stream_create();
-		if ($syncToken == null) {
-			mapi_stream_write($stream, hex2bin("0000000000000000"));
-		}
-		else {
-			$value = $this->syncstate->getState($arr[1], $syncToken);
-			if ($value == null) {
-				$this->logger->error("Unable to get value from token: %s - folderId: %s", $syncToken, $folderId);
-
-				return null;
-			}
-			mapi_stream_write($stream, hex2bin($value));
-		}
-
-		// The last parameter in mapi_exportchanges_config is buffer size for mapi_exportchanges_synchronize - how many
-		// changes will be processed in its call. Setting it to MAX_SYNC_ITEMS won't export more items than is set in
-		// the config. If there are more changes than MAX_SYNC_ITEMS the client will eventually catch up and sync
-		// the rest on the subsequent sync request(s).
-		$bufferSize = ($limit !== null && $limit > 0) ? $limit : MAX_SYNC_ITEMS;
-		mapi_exportchanges_config($exporter, $stream, SYNC_NORMAL | SYNC_UNICODE, $mapiimporter, null, false, false, $bufferSize);
-		$changesCount = mapi_exportchanges_getchangecount($exporter);
-		$this->logger->debug("Exporter found %d changes, buffer size for mapi_exportchanges_synchronize %d", $changesCount, $bufferSize);
-		while ((is_array(mapi_exportchanges_synchronize($exporter)))) {
-			if ($changesCount > $bufferSize) {
-				$this->logger->info("There were too many changes to be exported in this request. Total changes %d, exported %d.", $changesCount, $phpwrapper->Total());
-
-				break;
-			}
-		}
-		$exportedChanges = $phpwrapper->Total();
-		$this->logger->debug("Exported %d changes, pending %d", $exportedChanges, $changesCount - $exportedChanges);
-
-		mapi_exportchanges_updatestate($exporter, $stream);
-		mapi_stream_seek($stream, 0, STREAM_SEEK_SET);
-		$state = "";
-		while (true) {
-			$data = mapi_stream_read($stream, 4096);
-			if (strlen($data) > 0) {
-				$state .= $data;
-			}
-			else {
-				break;
-			}
-		}
-
-		$newtoken = ($phpwrapper->Total() > 0) ? uniqid() : $syncToken;
-
-		$this->syncstate->setState($arr[1], $newtoken, bin2hex($state));
-
-		$result = [
-			"syncToken" => $newtoken,
-			"added" => $phpwrapper->GetAdded(),
-			"modified" => $phpwrapper->GetModified(),
-			"deleted" => $phpwrapper->GetDeleted(),
-		];
-
-		$this->logger->trace("Returning %s", $result);
-
-		return $result;
-	}
+        $entryid = false;
+        $restriction = false;
+
+        if (ctype_xdigit($id) && strlen($id) % 2 == 0) {
+            $this->logger->trace("Try PR_SOURCE_KEY %s", $id);
+            $arr = explode(':', $folderId);
+            $entryid = mapi_msgstore_entryidfromsourcekey($this->GetStoreById($arr[0]), hex2bin($arr[1]), hex2bin($id));
+        }
+
+        if (!$entryid) {
+            $this->logger->trace("Entryid not found. Try goid/vcarduid %s", $id);
+
+            $properties = $this->GetCustomProperties($folderId);
+            if (strpos($id, '%40') !== false) {
+                $this->logger->debug("The id contains '%40'. Use urldecode.");
+                $id = urldecode($id);
+            }
+            $restriction = [];
+
+            if ($extension) {
+                if ($extension == GrommunioCalDavBackend::FILE_EXTENSION) {
+                    $this->logger->trace("Try goid %s", $id);
+                    $goid = getGoidFromUid($id);
+                    $this->logger->trace("Try goid 0x%08X => %s", $properties["goid"], bin2hex($goid));
+                    $restriction[] = [RES_PROPERTY, [RELOP => RELOP_EQ, ULPROPTAG => $properties["goid"], VALUE => $goid]];
+                }
+                elseif ($extension == GrommunioCardDavBackend::FILE_EXTENSION) {
+                    $this->logger->trace("Try vcarduid %s", $id);
+                    $restriction[] = [RES_PROPERTY, [RELOP => RELOP_EQ, ULPROPTAG => $properties["vcarduid"], VALUE => $id]];
+                }
+            }
+        }
+
+        // find the message if we have a restriction
+        if ($restriction) {
+            $table = mapi_folder_getcontentstable($mapifolder, MAPI_DEFERRED_ERRORS);
+            mapi_table_restrict($table, [RES_OR, $restriction]);
+            // Get requested properties, plus whatever we need
+            $proplist = [PR_ENTRYID];
+            $rows = mapi_table_queryallrows($table, $proplist);
+            if (count($rows) > 1) {
+                $this->logger->warn("Found %d entries for id '%s' searching for message", count($rows), $id);
+            }
+            if (isset($rows[0], $rows[0][PR_ENTRYID])) {
+                $entryid = $rows[0][PR_ENTRYID];
+            }
+        }
+        if ($entryid) {
+            $mapimessage = mapi_msgstore_openentry($this->GetStoreById($folderId), $entryid);
+            if (!$mapimessage) {
+                $this->logger->warn("Error, unable to open entry id: 0x%X", $entryid, mapi_last_hresult());
+
+                return null;
+            }
+
+            return $mapimessage;
+        }
+        $this->logger->debug("Nothing found for %s", $id);
+
+        return null;
+    }
+
+    /**
+     * Returns the objectId from an objectUri. It strips the file extension
+     * if it matches the passed one.
+     *
+     * @param string $objectUri
+     * @param string $extension
+     *
+     * @return string
+     */
+    public function GetObjectIdFromObjectUri($objectUri, $extension) {
+        if (!$extension) {
+            return $objectUri;
+        }
+        $extLength = strlen($extension);
+        if (substr($objectUri, -$extLength) === $extension) {
+            return substr($objectUri, 0, -$extLength);
+        }
+
+        return $objectUri;
+    }
+
+    /**
+     * Checks if the PHP-MAPI extension is available and in a requested version.
+     *
+     * @param string $version the version to be checked ("6.30.10-18495", parts or build number)
+     *
+     * @return bool installed version is superior to the checked string
+     */
+    protected function checkMapiExtVersion($version = "") {
+        if (!extension_loaded("mapi")) {
+            return false;
+        }
+        // compare build number if requested
+        if (preg_match('/^\d+$/', $version) && strlen($version) > 3) {
+            $vs = preg_split('/-/', phpversion("mapi"));
+
+            return $version <= $vs[1];
+        }
+        if (version_compare(phpversion("mapi"), $version) == -1) {
+            return false;
+        }
+
+        return true;
+    }
+
+    /**
+     * Get named (custom) properties. Currently only PROP_APPTTSREF.
+     *
+     * @param string $id the folder id
+     *
+     * @return mixed
+     */
+    protected function GetCustomProperties($id) {
+        if (!isset($this->customprops[$id])) {
+            $this->logger->trace("Fetching properties id:%s", $id);
+            $store = $this->GetStoreById($id);
+            $properties = getPropIdsFromStrings($store, ["goid" => "PT_BINARY:PSETID_Meeting:0x3", "vcarduid" => MapiProps::PROP_VCARDUID]);
+            $this->customprops[$id] = $properties;
+        }
+
+        return $this->customprops[$id];
+    }
+
+    /**
+     * Create a MAPI restriction to use in the calendar which will
+     * return future calendar items (until $end), plus those since $start.
+     * Origins: Z-Push.
+     *
+     * @param MAPIStore $store the MAPI store
+     * @param long      $start Timestamp since when to include messages
+     * @param long      $end   Ending timestamp
+     *
+     * @return array
+     */
+    // TODO getting named properties
+    public function GetCalendarRestriction($store, $start, $end) {
+        $props = MapiProps::GetAppointmentProperties();
+        $props = getPropIdsFromStrings($store, $props);
+
+        return [RES_OR,
+            [
+                // OR
+                // item.end > window.start && item.start < window.end
+                [RES_AND,
+                    [
+                        [RES_PROPERTY,
+                            [RELOP => RELOP_LE,
+                                ULPROPTAG => $props["starttime"],
+                                VALUE => $end,
+                            ],
+                        ],
+                        [RES_PROPERTY,
+                            [RELOP => RELOP_GE,
+                                ULPROPTAG => $props["endtime"],
+                                VALUE => $start,
+                            ],
+                        ],
+                    ],
+                ],
+                // OR
+                [RES_OR,
+                    [
+                        // OR
+                        // (EXIST(recurrence_enddate_property) && item[isRecurring] == true && recurrence_enddate_property >= start)
+                        [RES_AND,
+                            [
+                                [RES_EXIST,
+                                    [ULPROPTAG => $props["recurrenceend"],
+                                    ],
+                                ],
+                                [RES_PROPERTY,
+                                    [RELOP => RELOP_EQ,
+                                        ULPROPTAG => $props["isrecurring"],
+                                        VALUE => true,
+                                    ],
+                                ],
+                                [RES_PROPERTY,
+                                    [RELOP => RELOP_GE,
+                                        ULPROPTAG => $props["recurrenceend"],
+                                        VALUE => $start,
+                                    ],
+                                ],
+                            ],
+                        ],
+                        // OR
+                        // (!EXIST(recurrence_enddate_property) && item[isRecurring] == true && item[start] <= end)
+                        [RES_AND,
+                            [
+                                [RES_NOT,
+                                    [
+                                        [RES_EXIST,
+                                            [ULPROPTAG => $props["recurrenceend"],
+                                            ],
+                                        ],
+                                    ],
+                                ],
+                                [RES_PROPERTY,
+                                    [RELOP => RELOP_LE,
+                                        ULPROPTAG => $props["starttime"],
+                                        VALUE => $end,
+                                    ],
+                                ],
+                                [RES_PROPERTY,
+                                    [RELOP => RELOP_EQ,
+                                        ULPROPTAG => $props["isrecurring"],
+                                        VALUE => true,
+                                    ],
+                                ],
+                            ],
+                        ],
+                    ],
+                ], // EXISTS OR
+            ],
+        ];        // global OR
+    }
+
+    /**
+     * Performs ICS based sync used from getChangesForAddressBook
+     * / getChangesForCalendar.
+     *
+     * @param string $folderId
+     * @param string $syncToken
+     * @param string $fileExtension
+     * @param int    $limit
+     *
+     * @return array
+     */
+    public function Sync($folderId, $syncToken, $fileExtension, $limit = null) {
+        $arr = explode(':', $folderId);
+        $phpwrapper = new PHPWrapper($this->GetStoreById($folderId), $this->logger, $this->GetCustomProperties($folderId), $fileExtension, $this->syncstate, $arr[1]);
+        $mapiimporter = mapi_wrap_importcontentschanges($phpwrapper);
+
+        $mapifolder = $this->GetMapiFolder($folderId);
+        $exporter = mapi_openproperty($mapifolder, PR_CONTENTS_SYNCHRONIZER, IID_IExchangeExportChanges, 0, 0);
+        if (!$exporter) {
+            $this->logger->error("Unable to get exporter");
+
+            return null;
+        }
+
+        $stream = mapi_stream_create();
+        if ($syncToken == null) {
+            mapi_stream_write($stream, hex2bin("0000000000000000"));
+        }
+        else {
+            $value = $this->syncstate->getState($arr[1], $syncToken);
+            if ($value == null) {
+                $this->logger->error("Unable to get value from token: %s - folderId: %s", $syncToken, $folderId);
+
+                return null;
+            }
+            mapi_stream_write($stream, hex2bin($value));
+        }
+
+        // The last parameter in mapi_exportchanges_config is buffer size for mapi_exportchanges_synchronize - how many
+        // changes will be processed in its call. Setting it to MAX_SYNC_ITEMS won't export more items than is set in
+        // the config. If there are more changes than MAX_SYNC_ITEMS the client will eventually catch up and sync
+        // the rest on the subsequent sync request(s).
+        $bufferSize = ($limit !== null && $limit > 0) ? $limit : MAX_SYNC_ITEMS;
+        mapi_exportchanges_config($exporter, $stream, SYNC_NORMAL | SYNC_UNICODE, $mapiimporter, null, false, false, $bufferSize);
+        $changesCount = mapi_exportchanges_getchangecount($exporter);
+        $this->logger->debug("Exporter found %d changes, buffer size for mapi_exportchanges_synchronize %d", $changesCount, $bufferSize);
+        while ((is_array(mapi_exportchanges_synchronize($exporter)))) {
+            if ($changesCount > $bufferSize) {
+                $this->logger->info("There were too many changes to be exported in this request. Total changes %d, exported %d.", $changesCount, $phpwrapper->Total());
+
+                break;
+            }
+        }
+        $exportedChanges = $phpwrapper->Total();
+        $this->logger->debug("Exported %d changes, pending %d", $exportedChanges, $changesCount - $exportedChanges);
+
+        mapi_exportchanges_updatestate($exporter, $stream);
+        mapi_stream_seek($stream, 0, STREAM_SEEK_SET);
+        $state = "";
+        while (true) {
+            $data = mapi_stream_read($stream, 4096);
+            if (strlen($data) > 0) {
+                $state .= $data;
+            }
+            else {
+                break;
+            }
+        }
+
+        $newtoken = ($phpwrapper->Total() > 0) ? uniqid() : $syncToken;
+
+        $this->syncstate->setState($arr[1], $newtoken, bin2hex($state));
+
+        $result = [
+            "syncToken" => $newtoken,
+            "added" => $phpwrapper->GetAdded(),
+            "modified" => $phpwrapper->GetModified(),
+            "deleted" => $phpwrapper->GetDeleted(),
+        ];
+
+        $this->logger->trace("Returning %s", $result);
+
+        return $result;
+    }
 }

Spacing +1 added lines, -1 removed lines

@@ -653,7 +653,7 @@
 					],
 				], // EXISTS OR
 			],
-		];        // global OR
+		]; // global OR
 	}
 
 	/**

Braces +6 added lines, -12 removed lines

@@ -153,8 +153,7 @@ 
 			// before the tasks folder.
 			elseif (in_array('IPF.Appointment', $classes) && isset($rootprops[PR_IPM_APPOINTMENT_ENTRYID]) && $row[PR_ENTRYID] == $rootprops[PR_IPM_APPOINTMENT_ENTRYID]) {
 				array_unshift($folders, $folder);
-			}
-			else {
+			} else {
 				array_push($folders, $folder);
 			}
 		}
@@ -224,8 +223,7 @@ 
 
 			if ($fileExtension == GrommunioCalDavBackend::FILE_EXTENSION) {
 				$result['calendarid'] = $id;
-			}
-			elseif ($fileExtension == GrommunioCardDavBackend::FILE_EXTENSION) {
+			} elseif ($fileExtension == GrommunioCardDavBackend::FILE_EXTENSION) {
 				$result['addressbookid'] = $id;
 			}
 			$results[] = $result;
@@ -329,8 +327,7 @@ 
 	public function GetStore($storename) {
 		if ($storename == null) {
 			$storename = $this->GetUser();
-		}
-		else {
+		} else {
 			$storename = str_replace('principals/', '', $storename);
 		}
 		$this->logger->trace("storename %s", $storename);
@@ -463,8 +460,7 @@ 
 					$goid = getGoidFromUid($id);
 					$this->logger->trace("Try goid 0x%08X => %s", $properties["goid"], bin2hex($goid));
 					$restriction[] = [RES_PROPERTY, [RELOP => RELOP_EQ, ULPROPTAG => $properties["goid"], VALUE => $goid]];
-				}
-				elseif ($extension == GrommunioCardDavBackend::FILE_EXTENSION) {
+				} elseif ($extension == GrommunioCardDavBackend::FILE_EXTENSION) {
 					$this->logger->trace("Try vcarduid %s", $id);
 					$restriction[] = [RES_PROPERTY, [RELOP => RELOP_EQ, ULPROPTAG => $properties["vcarduid"], VALUE => $id]];
 				}
@@ -683,8 +679,7 @@ 
 		$stream = mapi_stream_create();
 		if ($syncToken == null) {
 			mapi_stream_write($stream, hex2bin("0000000000000000"));
-		}
-		else {
+		} else {
 			$value = $this->syncstate->getState($arr[1], $syncToken);
 			if ($value == null) {
 				$this->logger->error("Unable to get value from token: %s - folderId: %s", $syncToken, $folderId);
@@ -719,8 +714,7 @@ 
 			$data = mapi_stream_read($stream, 4096);
 			if (strlen($data) > 0) {
 				$state .= $data;
-			}
-			else {
+			} else {
 				break;
 			}
 		}

lib/GrommunioCalDavBackend.php

Indentation +581 added lines, -581 removed lines

@@ -10,7 +10,7 @@ 
 namespace grommunio\DAV;
 
 class GrommunioCalDavBackend extends \Sabre\CalDAV\Backend\AbstractBackend implements \Sabre\CalDAV\Backend\SchedulingSupport, \Sabre\CalDAV\Backend\SyncSupport {
-	/*
+    /*
 	 * TODO IMPLEMENT
 	 *
 	 * SubscriptionSupport,
@@ -18,584 +18,584 @@ 
 	 *
 	 */
 
-	private $logger;
-	protected $gDavBackend;
-
-	public const FILE_EXTENSION = '.ics';
-	public const CONTAINER_CLASS = 'IPF.Appointment';
-	public const CONTAINER_CLASSES = ['IPF.Appointment', 'IPF.Task'];
-
-	/**
-	 * Constructor.
-	 */
-	public function __construct(GrommunioDavBackend $gDavBackend, GLogger $glogger) {
-		$this->gDavBackend = $gDavBackend;
-		$this->logger = $glogger;
-	}
-
-	/**
-	 * Publish free/busy information.
-	 *
-	 * Uses the FreeBusyPublish class to publish the information
-	 * about free/busy status.
-	 *
-	 * @param string       $calendarId
-	 * @param mapiresource $calendar
-	 */
-	private function UpdateFB($calendarId, $calendar) {
-		$session = $this->gDavBackend->GetSession();
-		$store = $this->gDavBackend->GetStoreById($calendarId);
-		$weekUnixTime = 7 * 24 * 60 * 60;
-		$start = time() - $weekUnixTime;
-		$range = strtotime("+7 weeks");
-		$storeProps = mapi_getprops($store, [PR_MAILBOX_OWNER_ENTRYID]);
-		if (!isset($storeProps[PR_MAILBOX_OWNER_ENTRYID])) {
-			return;
-		}
-		$pub = new \FreeBusyPublish($session, $store, $calendar, $storeProps[PR_MAILBOX_OWNER_ENTRYID]);
-		$pub->publishFB($start, $range);
-	}
-
-	/**
-	 * Returns a list of calendars for a principal.
-	 *
-	 * Every project is an array with the following keys:
-	 *  * id, a unique id that will be used by other functions to modify the
-	 *    calendar. This can be the same as the uri or a database key.
-	 *  * uri. This is just the 'base uri' or 'filename' of the calendar.
-	 *  * principaluri. The owner of the calendar. Almost always the same as
-	 *    principalUri passed to this method.
-	 *
-	 * Furthermore it can contain webdav properties in clark notation. A very
-	 * common one is '{DAV:}displayname'.
-	 *
-	 * Many clients also require:
-	 * {urn:ietf:params:xml:ns:caldav}supported-calendar-component-set
-	 * For this property, you can just return an instance of
-	 * Sabre\CalDAV\Xml\Property\SupportedCalendarComponentSet.
-	 *
-	 * If you return {http://sabredav.org/ns}read-only and set the value to 1,
-	 * ACL will automatically be put in read-only mode.
-	 *
-	 * @param string $principalUri
-	 *
-	 * @return array
-	 */
-	public function getCalendarsForUser($principalUri) {
-		$this->logger->trace("principalUri: %s", $principalUri);
-
-		return $this->gDavBackend->GetFolders($principalUri, static::CONTAINER_CLASSES);
-	}
-
-	/**
-	 * Creates a new calendar for a principal.
-	 *
-	 * If the creation was a success, an id must be returned that can be used
-	 * to reference this calendar in other methods, such as updateCalendar.
-	 *
-	 * @param string $principalUri
-	 * @param string $calendarUri
-	 *
-	 * @return string
-	 */
-	public function createCalendar($principalUri, $calendarUri, array $properties) {
-		$this->logger->trace("principalUri: %s - calendarUri: %s - properties: %s", $principalUri, $calendarUri, $properties);
-		// TODO Add displayname
-		return $this->gDavBackend->CreateFolder($principalUri, $calendarUri, static::CONTAINER_CLASS, "");
-	}
-
-	/**
-	 * Delete a calendar and all its objects.
-	 *
-	 * @param string $calendarId
-	 */
-	public function deleteCalendar($calendarId) {
-		$this->logger->trace("calendarId: %s", $calendarId);
-		$success = $this->gDavBackend->DeleteFolder($calendarId);
-		// TODO evaluate $success
-	}
-
-	/**
-	 * Returns all calendar objects within a calendar.
-	 *
-	 * Every item contains an array with the following keys:
-	 *   * calendardata - The iCalendar-compatible calendar data
-	 *   * uri - a unique key which will be used to construct the uri. This can
-	 *     be any arbitrary string, but making sure it ends with '.ics' is a
-	 *     good idea. This is only the basename, or filename, not the full
-	 *     path.
-	 *   * lastmodified - a timestamp of the last modification time
-	 *   * etag - An arbitrary string, surrounded by double-quotes. (e.g.:
-	 *   '  "abcdef"')
-	 *   * size - The size of the calendar objects, in bytes.
-	 *   * component - optional, a string containing the type of object, such
-	 *     as 'vevent' or 'vtodo'. If specified, this will be used to populate
-	 *     the Content-Type header.
-	 *
-	 * Note that the etag is optional, but it's highly encouraged to return for
-	 * speed reasons.
-	 *
-	 * The calendardata is also optional. If it's not returned
-	 * 'getCalendarObject' will be called later, which *is* expected to return
-	 * calendardata.
-	 *
-	 * If neither etag or size are specified, the calendardata will be
-	 * used/fetched to determine these numbers. If both are specified the
-	 * amount of times this is needed is reduced by a great degree.
-	 *
-	 * @param string $calendarId
-	 *
-	 * @return array
-	 */
-	public function getCalendarObjects($calendarId) {
-		$result = $this->gDavBackend->GetObjects($calendarId, static::FILE_EXTENSION);
-		$this->logger->trace("calendarId: %s found %d objects", $calendarId, count($result));
-
-		return $result;
-	}
-
-	/**
-	 * Performs a calendar-query on the contents of this calendar.
-	 *
-	 * The calendar-query is defined in RFC4791 : CalDAV. Using the
-	 * calendar-query it is possible for a client to request a specific set of
-	 * object, based on contents of iCalendar properties, date-ranges and
-	 * iCalendar component types (VTODO, VEVENT).
-	 *
-	 * This method should just return a list of (relative) urls that match this
-	 * query.
-	 *
-	 * The list of filters are specified as an array. The exact array is
-	 * documented by \Sabre\CalDAV\CalendarQueryParser.
-	 *
-	 * Note that it is extremely likely that getCalendarObject for every path
-	 * returned from this method will be called almost immediately after. You
-	 * may want to anticipate this to speed up these requests.
-	 *
-	 * This method provides a default implementation, which parses *all* the
-	 * iCalendar objects in the specified calendar.
-	 *
-	 * This default may well be good enough for personal use, and calendars
-	 * that aren't very large. But if you anticipate high usage, big calendars
-	 * or high loads, you are strongly advised to optimize certain paths.
-	 *
-	 * The best way to do so is override this method and to optimize
-	 * specifically for 'common filters'.
-	 *
-	 * Requests that are extremely common are:
-	 *   * requests for just VEVENTS
-	 *   * requests for just VTODO
-	 *   * requests with a time-range-filter on either VEVENT or VTODO.
-	 *
-	 * ..and combinations of these requests. It may not be worth it to try to
-	 * handle every possible situation and just rely on the (relatively
-	 * easy to use) CalendarQueryValidator to handle the rest.
-	 *
-	 * Note that especially time-range-filters may be difficult to parse. A
-	 * time-range filter specified on a VEVENT must for instance also handle
-	 * recurrence rules correctly.
-	 * A good example of how to interpret all these filters can also simply
-	 * be found in \Sabre\CalDAV\CalendarQueryFilter. This class is as correct
-	 * as possible, so it gives you a good idea on what type of stuff you need
-	 * to think of.
-	 *
-	 * @param mixed $calendarId
-	 *
-	 * @return array
-	 */
-	public function calendarQuery($calendarId, array $filters) {
-		$start = $end = null;
-		$types = [];
-		foreach ($filters['comp-filters'] as $filter) {
-			$this->logger->trace("got filter: %s", $filter);
-
-			if ($filter['name'] == 'VEVENT') {
-				$types[] = 'IPM.Appointment';
-			}
-			elseif ($filter['name'] == 'VTODO') {
-				$types[] = 'IPM.Task';
-			}
-
-			/* will this work on tasks? */
-			if (is_array($filter['time-range']) && isset($filter['time-range']['start'], $filter['time-range']['end'])) {
-				$start = $filter['time-range']['start']->getTimestamp();
-				$end = $filter['time-range']['end']->getTimestamp();
-			}
-		}
-
-		$objfilters = [];
-		if ($start != null && $end != null) {
-			$objfilters["start"] = $start;
-			$objfilters["end"] = $end;
-		}
-		if (!empty($types)) {
-			$objfilters["types"] = $types;
-		}
-
-		$objects = $this->gDavBackend->GetObjects($calendarId, static::FILE_EXTENSION, $objfilters);
-		$result = [];
-		foreach ($objects as $object) {
-			$result[] = $object['uri'];
-		}
-
-		return $result;
-	}
-
-	/**
-	 * Returns information from a single calendar object, based on its object uri.
-	 *
-	 * The object uri is only the basename, or filename and not a full path.
-	 *
-	 * The returned array must have the same keys as getCalendarObjects. The
-	 * 'calendardata' object is required here though, while it's not required
-	 * for getCalendarObjects.
-	 *
-	 * This method must return null if the object did not exist.
-	 *
-	 * @param string   $calendarId
-	 * @param string   $objectUri
-	 * @param resource $mapifolder optional mapifolder resource, used if available
-	 *
-	 * @return null|array
-	 */
-	public function getCalendarObject($calendarId, $objectUri, $mapifolder = null) {
-		$this->logger->trace("calendarId: %s - objectUri: %s - mapifolder: %s", $calendarId, $objectUri, $mapifolder);
-
-		if (!$mapifolder) {
-			$mapifolder = $this->gDavBackend->GetMapiFolder($calendarId);
-		}
-
-		$mapimessage = $this->gDavBackend->GetMapiMessageForId($calendarId, $objectUri, $mapifolder, static::FILE_EXTENSION);
-		if (!$mapimessage) {
-			$this->logger->error("Object NOT FOUND");
-
-			return null;
-		}
-
-		$realId = $this->gDavBackend->GetIdOfMapiMessage($calendarId, $mapimessage);
-
-		// this should be cached or moved to gDavBackend
-		$session = $this->gDavBackend->GetSession();
-		$ab = $this->gDavBackend->GetAddressBook();
-
-		$ics = mapi_mapitoical($session, $ab, $mapimessage, []);
-		if (!$ics && mapi_last_hresult()) {
-			$this->logger->error("Error generating ical, error code: 0x%08X", mapi_last_hresult());
-			$ics = null;
-		}
-		elseif (!$ics) {
-			$this->logger->error("Error generating ical, unknown error");
-			$ics = null;
-		}
-		$this->logger->trace("ics generated by mapi_mapitoical: %s%s", PHP_EOL, $ics);
-
-		$props = mapi_getprops($mapimessage, [PR_LAST_MODIFICATION_TIME]);
-
-		$r = [
-			'id' => $realId,
-			'uri' => $realId . static::FILE_EXTENSION,
-			'etag' => '"' . $props[PR_LAST_MODIFICATION_TIME] . '"',
-			'lastmodified' => $props[PR_LAST_MODIFICATION_TIME],
-			'calendarid' => $calendarId,
-			'size' => strlen($ics),
-			'calendardata' => $ics,
-		];
-		$this->logger->trace("returned data id: %s - size: %d - etag: %s", $r['id'], $r['size'], $r['etag']);
-
-		return $r;
-	}
-
-	/**
-	 * Creates a new calendar object.
-	 *
-	 * The object uri is only the basename, or filename and not a full path.
-	 *
-	 * It is possible return an etag from this function, which will be used in
-	 * the response to this PUT request. Note that the ETag must be surrounded
-	 * by double-quotes.
-	 *
-	 * However, you should only really return this ETag if you don't mangle the
-	 * calendar-data. If the result of a subsequent GET to this object is not
-	 * the exact same as this request body, you should omit the ETag.
-	 *
-	 * @param mixed  $calendarId
-	 * @param string $objectUri
-	 * @param string $calendarData
-	 *
-	 * @return null|string
-	 */
-	public function createCalendarObject($calendarId, $objectUri, $calendarData) {
-		$this->logger->trace("calendarId: %s - objectUri: %s - calendarData: %s", $calendarId, $objectUri, $calendarData);
-		$objectId = $this->gDavBackend->GetObjectIdFromObjectUri($objectUri, static::FILE_EXTENSION);
-		$folder = $this->gDavBackend->GetMapiFolder($calendarId);
-		$mapimessage = $this->gDavBackend->CreateObject($calendarId, $folder, $objectId);
-		$retval = $this->setData($calendarId, $mapimessage, $calendarData);
-		if (!$retval) {
-			return null;
-		}
-		// $this->UpdateFB($calendarId, $folder);
-		return '"' . $retval . '"';
-	}
-
-	/**
-	 * Updates an existing calendarobject, based on its uri.
-	 *
-	 * The object uri is only the basename, or filename and not a full path.
-	 *
-	 * It is possible return an etag from this function, which will be used in
-	 * the response to this PUT request. Note that the ETag must be surrounded
-	 * by double-quotes.
-	 *
-	 * However, you should only really return this ETag if you don't mangle the
-	 * calendar-data. If the result of a subsequent GET to this object is not
-	 * the exact same as this request body, you should omit the ETag.
-	 *
-	 * @param mixed  $calendarId
-	 * @param string $objectUri
-	 * @param string $calendarData
-	 *
-	 * @return null|string
-	 */
-	public function updateCalendarObject($calendarId, $objectUri, $calendarData) {
-		$this->logger->trace("calendarId: %s - objectUri: %s - calendarData: %s", $calendarId, $objectUri, $calendarData);
-
-		$folder = $this->gDavBackend->GetMapiFolder($calendarId);
-		$mapimessage = $this->gDavBackend->GetMapiMessageForId($calendarId, $objectUri, null, static::FILE_EXTENSION);
-		$retval = $this->setData($calendarId, $mapimessage, $calendarData);
-		if (!$retval) {
-			return null;
-		}
-		// $this->UpdateFB($calendarId, $folder);
-		return '"' . $retval . '"';
-	}
-
-	/**
-	 * Sets data for a calendar item.
-	 *
-	 * @param mixed       $calendarId
-	 * @param MAPIMessage $mapimessage
-	 * @param string      $ics
-	 *
-	 * @return null|string
-	 */
-	private function setData($calendarId, $mapimessage, $ics) {
-		$this->logger->trace("mapimessage: %s - ics: %s", $mapimessage, $ics);
-		// this should be cached or moved to gDavBackend
-		$store = $this->gDavBackend->GetStoreById($calendarId);
-		$session = $this->gDavBackend->GetSession();
-		$ab = $this->gDavBackend->GetAddressBook();
-
-		// Evolution sends daylight/standard information in the ical data
-		// and some values are not supported by Outlook/Exchange.
-		// Strip that data and leave only the last occurrences of
-		// daylight/standard information.
-		// @see GRAM-52
-
-		$xLicLocation = stripos($ics, 'X-LIC-LOCATION:');
-		if (($xLicLocation !== false) &&
-				(
-					substr_count($ics, 'BEGIN:DAYLIGHT', $xLicLocation) > 0 ||
-					substr_count($ics, 'BEGIN:STANDARD', $xLicLocation) > 0
-				)) {
-			$firstDaytime = stripos($ics, 'BEGIN:DAYLIGHT', $xLicLocation);
-			$firstStandard = stripos($ics, 'BEGIN:STANDARD', $xLicLocation);
-
-			$lastDaytime = strripos($ics, 'BEGIN:DAYLIGHT', $xLicLocation);
-			$lastStandard = strripos($ics, 'BEGIN:STANDARD', $xLicLocation);
-
-			// the first part of ics until the first piece of standard/daytime information
-			$cutStart = $firstDaytime < $firstStandard ? $firstDaytime : $firstStandard;
-
-			if ($lastDaytime > $lastStandard) {
-				// the part of the ics with the last piece of standard/daytime information
-				$cutEnd = $lastDaytime;
-
-				// the positions of the last piece of standard information
-				$cut1 = $lastStandard;
-				$cut2 = strripos($ics, 'END:STANDARD', $lastStandard) + 14; // strlen('END:STANDARD')
-			}
-			else {
-				// the part of the ics with the last piece of standard/daytime information
-				$cutEnd = $lastStandard;
-
-				// the positions of the last piece of daylight information
-				$cut1 = $lastDaytime;
-				$cut2 = strripos($ics, 'END:DAYLIGHT', $lastDaytime) + 14; // strlen('END:DAYLIGHT')
-			}
-
-			$ics = substr($ics, 0, $cutStart) . substr($ics, $cut1, ($cut2 - $cut1)) . substr($ics, $cutEnd);
-			$this->logger->trace("newics: %s", $ics);
-		}
-
-		$ok = mapi_icaltomapi($session, $store, $ab, $mapimessage, $ics, false);
-		if (!$ok && mapi_last_hresult()) {
-			$this->logger->error("Error updating mapi object, error code: 0x%08X", mapi_last_hresult());
-
-			return null;
-		}
-		if (!$ok) {
-			$this->logger->error("Error updating mapi object, unknown error");
-
-			return null;
-		}
-
-		mapi_savechanges($mapimessage);
-		$props = mapi_getprops($mapimessage);
-
-		return $props[PR_LAST_MODIFICATION_TIME];
-	}
-
-	/**
-	 * Deletes an existing calendar object.
-	 *
-	 * The object uri is only the basename, or filename and not a full path.
-	 *
-	 * @param string $calendarId
-	 * @param string $objectUri
-	 */
-	public function deleteCalendarObject($calendarId, $objectUri) {
-		$this->logger->trace("calendarId: %s - objectUri: %s", $calendarId, $objectUri);
-
-		$mapifolder = $this->gDavBackend->GetMapiFolder($calendarId);
-
-		// to delete we need the PR_ENTRYID of the message
-		// TODO move this part to GrommunioDavBackend
-		$mapimessage = $this->gDavBackend->GetMapiMessageForId($calendarId, $objectUri, $mapifolder, static::FILE_EXTENSION);
-		$props = mapi_getprops($mapimessage, [PR_ENTRYID]);
-		mapi_folder_deletemessages($mapifolder, [$props[PR_ENTRYID]]);
-	}
-
-	/**
-	 * Return a single scheduling object.
-	 *
-	 * TODO: Add implementation.
-	 *
-	 * @param string $principalUri
-	 * @param string $objectUri
-	 *
-	 * @return array
-	 */
-	public function getSchedulingObject($principalUri, $objectUri) {
-		$this->logger->trace("principalUri: %s - objectUri: %s", $principalUri, $objectUri);
-
-		return [];
-	}
-
-	/**
-	 * Returns scheduling objects for the principal URI.
-	 *
-	 * TODO: Add implementation.
-	 *
-	 * @param string $principalUri
-	 *
-	 * @return array
-	 */
-	public function getSchedulingObjects($principalUri) {
-		$this->logger->trace("principalUri: %s", $principalUri);
-
-		return [];
-	}
-
-	/**
-	 * Delete scheduling object.
-	 *
-	 * TODO: Add implementation.
-	 *
-	 * @param string $principalUri
-	 * @param string $objectUri
-	 */
-	public function deleteSchedulingObject($principalUri, $objectUri) {
-		$this->logger->trace("principalUri: %s - objectUri: %s", $principalUri, $objectUri);
-	}
-
-	/**
-	 * Create a new scheduling object.
-	 *
-	 * TODO: Add implementation.
-	 *
-	 * @param string $principalUri
-	 * @param string $objectUri
-	 * @param string $objectData
-	 */
-	public function createSchedulingObject($principalUri, $objectUri, $objectData) {
-		$this->logger->trace("principalUri: %s - objectUri: %s - objectData: %s", $principalUri, $objectUri, $objectData);
-	}
-
-	/**
-	 * Return CTAG for scheduling inbox.
-	 *
-	 * TODO: Add implementation.
-	 *
-	 * @param string $principalUri
-	 *
-	 * @return string
-	 */
-	public function getSchedulingInboxCtag($principalUri) {
-		$this->logger->trace("principalUri: %s", $principalUri);
-
-		return "empty";
-	}
-
-	/**
-	 * The getChanges method returns all the changes that have happened, since
-	 * the specified syncToken in the specified calendar.
-	 *
-	 * This function should return an array, such as the following:
-	 *
-	 * [
-	 *   'syncToken' => 'The current synctoken',
-	 *   'added'   => [
-	 *      'new.txt',
-	 *   ],
-	 *   'modified'   => [
-	 *      'modified.txt',
-	 *   ],
-	 *   'deleted' => [
-	 *      'foo.php.bak',
-	 *      'old.txt'
-	 *   ]
-	 * );
-	 *
-	 * The returned syncToken property should reflect the *current* syncToken
-	 * of the calendar, as reported in the {http://sabredav.org/ns}sync-token
-	 * property This is * needed here too, to ensure the operation is atomic.
-	 *
-	 * If the $syncToken argument is specified as null, this is an initial
-	 * sync, and all members should be reported.
-	 *
-	 * The modified property is an array of nodenames that have changed since
-	 * the last token.
-	 *
-	 * The deleted property is an array with nodenames, that have been deleted
-	 * from collection.
-	 *
-	 * The $syncLevel argument is basically the 'depth' of the report. If it's
-	 * 1, you only have to report changes that happened only directly in
-	 * immediate descendants. If it's 2, it should also include changes from
-	 * the nodes below the child collections. (grandchildren)
-	 *
-	 * The $limit argument allows a client to specify how many results should
-	 * be returned at most. If the limit is not specified, it should be treated
-	 * as infinite.
-	 *
-	 * If the limit (infinite or not) is higher than you're willing to return,
-	 * you should throw a Sabre\DAV\Exception\TooMuchMatches() exception.
-	 *
-	 * If the syncToken is expired (due to data cleanup) or unknown, you must
-	 * return null.
-	 *
-	 * The limit is 'suggestive'. You are free to ignore it.
-	 *
-	 * @param string $calendarId
-	 * @param string $syncToken
-	 * @param int    $syncLevel
-	 * @param int    $limit
-	 *
-	 * @return array
-	 */
-	public function getChangesForCalendar($calendarId, $syncToken, $syncLevel, $limit = null) {
-		$this->logger->trace("calendarId: %s - syncToken: %s - syncLevel: %d - limit: %d", $calendarId, $syncToken, $syncLevel, $limit);
-
-		return $this->gDavBackend->Sync($calendarId, $syncToken, static::FILE_EXTENSION, $limit);
-	}
+    private $logger;
+    protected $gDavBackend;
+
+    public const FILE_EXTENSION = '.ics';
+    public const CONTAINER_CLASS = 'IPF.Appointment';
+    public const CONTAINER_CLASSES = ['IPF.Appointment', 'IPF.Task'];
+
+    /**
+     * Constructor.
+     */
+    public function __construct(GrommunioDavBackend $gDavBackend, GLogger $glogger) {
+        $this->gDavBackend = $gDavBackend;
+        $this->logger = $glogger;
+    }
+
+    /**
+     * Publish free/busy information.
+     *
+     * Uses the FreeBusyPublish class to publish the information
+     * about free/busy status.
+     *
+     * @param string       $calendarId
+     * @param mapiresource $calendar
+     */
+    private function UpdateFB($calendarId, $calendar) {
+        $session = $this->gDavBackend->GetSession();
+        $store = $this->gDavBackend->GetStoreById($calendarId);
+        $weekUnixTime = 7 * 24 * 60 * 60;
+        $start = time() - $weekUnixTime;
+        $range = strtotime("+7 weeks");
+        $storeProps = mapi_getprops($store, [PR_MAILBOX_OWNER_ENTRYID]);
+        if (!isset($storeProps[PR_MAILBOX_OWNER_ENTRYID])) {
+            return;
+        }
+        $pub = new \FreeBusyPublish($session, $store, $calendar, $storeProps[PR_MAILBOX_OWNER_ENTRYID]);
+        $pub->publishFB($start, $range);
+    }
+
+    /**
+     * Returns a list of calendars for a principal.
+     *
+     * Every project is an array with the following keys:
+     *  * id, a unique id that will be used by other functions to modify the
+     *    calendar. This can be the same as the uri or a database key.
+     *  * uri. This is just the 'base uri' or 'filename' of the calendar.
+     *  * principaluri. The owner of the calendar. Almost always the same as
+     *    principalUri passed to this method.
+     *
+     * Furthermore it can contain webdav properties in clark notation. A very
+     * common one is '{DAV:}displayname'.
+     *
+     * Many clients also require:
+     * {urn:ietf:params:xml:ns:caldav}supported-calendar-component-set
+     * For this property, you can just return an instance of
+     * Sabre\CalDAV\Xml\Property\SupportedCalendarComponentSet.
+     *
+     * If you return {http://sabredav.org/ns}read-only and set the value to 1,
+     * ACL will automatically be put in read-only mode.
+     *
+     * @param string $principalUri
+     *
+     * @return array
+     */
+    public function getCalendarsForUser($principalUri) {
+        $this->logger->trace("principalUri: %s", $principalUri);
+
+        return $this->gDavBackend->GetFolders($principalUri, static::CONTAINER_CLASSES);
+    }
+
+    /**
+     * Creates a new calendar for a principal.
+     *
+     * If the creation was a success, an id must be returned that can be used
+     * to reference this calendar in other methods, such as updateCalendar.
+     *
+     * @param string $principalUri
+     * @param string $calendarUri
+     *
+     * @return string
+     */
+    public function createCalendar($principalUri, $calendarUri, array $properties) {
+        $this->logger->trace("principalUri: %s - calendarUri: %s - properties: %s", $principalUri, $calendarUri, $properties);
+        // TODO Add displayname
+        return $this->gDavBackend->CreateFolder($principalUri, $calendarUri, static::CONTAINER_CLASS, "");
+    }
+
+    /**
+     * Delete a calendar and all its objects.
+     *
+     * @param string $calendarId
+     */
+    public function deleteCalendar($calendarId) {
+        $this->logger->trace("calendarId: %s", $calendarId);
+        $success = $this->gDavBackend->DeleteFolder($calendarId);
+        // TODO evaluate $success
+    }
+
+    /**
+     * Returns all calendar objects within a calendar.
+     *
+     * Every item contains an array with the following keys:
+     *   * calendardata - The iCalendar-compatible calendar data
+     *   * uri - a unique key which will be used to construct the uri. This can
+     *     be any arbitrary string, but making sure it ends with '.ics' is a
+     *     good idea. This is only the basename, or filename, not the full
+     *     path.
+     *   * lastmodified - a timestamp of the last modification time
+     *   * etag - An arbitrary string, surrounded by double-quotes. (e.g.:
+     *   '  "abcdef"')
+     *   * size - The size of the calendar objects, in bytes.
+     *   * component - optional, a string containing the type of object, such
+     *     as 'vevent' or 'vtodo'. If specified, this will be used to populate
+     *     the Content-Type header.
+     *
+     * Note that the etag is optional, but it's highly encouraged to return for
+     * speed reasons.
+     *
+     * The calendardata is also optional. If it's not returned
+     * 'getCalendarObject' will be called later, which *is* expected to return
+     * calendardata.
+     *
+     * If neither etag or size are specified, the calendardata will be
+     * used/fetched to determine these numbers. If both are specified the
+     * amount of times this is needed is reduced by a great degree.
+     *
+     * @param string $calendarId
+     *
+     * @return array
+     */
+    public function getCalendarObjects($calendarId) {
+        $result = $this->gDavBackend->GetObjects($calendarId, static::FILE_EXTENSION);
+        $this->logger->trace("calendarId: %s found %d objects", $calendarId, count($result));
+
+        return $result;
+    }
+
+    /**
+     * Performs a calendar-query on the contents of this calendar.
+     *
+     * The calendar-query is defined in RFC4791 : CalDAV. Using the
+     * calendar-query it is possible for a client to request a specific set of
+     * object, based on contents of iCalendar properties, date-ranges and
+     * iCalendar component types (VTODO, VEVENT).
+     *
+     * This method should just return a list of (relative) urls that match this
+     * query.
+     *
+     * The list of filters are specified as an array. The exact array is
+     * documented by \Sabre\CalDAV\CalendarQueryParser.
+     *
+     * Note that it is extremely likely that getCalendarObject for every path
+     * returned from this method will be called almost immediately after. You
+     * may want to anticipate this to speed up these requests.
+     *
+     * This method provides a default implementation, which parses *all* the
+     * iCalendar objects in the specified calendar.
+     *
+     * This default may well be good enough for personal use, and calendars
+     * that aren't very large. But if you anticipate high usage, big calendars
+     * or high loads, you are strongly advised to optimize certain paths.
+     *
+     * The best way to do so is override this method and to optimize
+     * specifically for 'common filters'.
+     *
+     * Requests that are extremely common are:
+     *   * requests for just VEVENTS
+     *   * requests for just VTODO
+     *   * requests with a time-range-filter on either VEVENT or VTODO.
+     *
+     * ..and combinations of these requests. It may not be worth it to try to
+     * handle every possible situation and just rely on the (relatively
+     * easy to use) CalendarQueryValidator to handle the rest.
+     *
+     * Note that especially time-range-filters may be difficult to parse. A
+     * time-range filter specified on a VEVENT must for instance also handle
+     * recurrence rules correctly.
+     * A good example of how to interpret all these filters can also simply
+     * be found in \Sabre\CalDAV\CalendarQueryFilter. This class is as correct
+     * as possible, so it gives you a good idea on what type of stuff you need
+     * to think of.
+     *
+     * @param mixed $calendarId
+     *
+     * @return array
+     */
+    public function calendarQuery($calendarId, array $filters) {
+        $start = $end = null;
+        $types = [];
+        foreach ($filters['comp-filters'] as $filter) {
+            $this->logger->trace("got filter: %s", $filter);
+
+            if ($filter['name'] == 'VEVENT') {
+                $types[] = 'IPM.Appointment';
+            }
+            elseif ($filter['name'] == 'VTODO') {
+                $types[] = 'IPM.Task';
+            }
+
+            /* will this work on tasks? */
+            if (is_array($filter['time-range']) && isset($filter['time-range']['start'], $filter['time-range']['end'])) {
+                $start = $filter['time-range']['start']->getTimestamp();
+                $end = $filter['time-range']['end']->getTimestamp();
+            }
+        }
+
+        $objfilters = [];
+        if ($start != null && $end != null) {
+            $objfilters["start"] = $start;
+            $objfilters["end"] = $end;
+        }
+        if (!empty($types)) {
+            $objfilters["types"] = $types;
+        }
+
+        $objects = $this->gDavBackend->GetObjects($calendarId, static::FILE_EXTENSION, $objfilters);
+        $result = [];
+        foreach ($objects as $object) {
+            $result[] = $object['uri'];
+        }
+
+        return $result;
+    }
+
+    /**
+     * Returns information from a single calendar object, based on its object uri.
+     *
+     * The object uri is only the basename, or filename and not a full path.
+     *
+     * The returned array must have the same keys as getCalendarObjects. The
+     * 'calendardata' object is required here though, while it's not required
+     * for getCalendarObjects.
+     *
+     * This method must return null if the object did not exist.
+     *
+     * @param string   $calendarId
+     * @param string   $objectUri
+     * @param resource $mapifolder optional mapifolder resource, used if available
+     *
+     * @return null|array
+     */
+    public function getCalendarObject($calendarId, $objectUri, $mapifolder = null) {
+        $this->logger->trace("calendarId: %s - objectUri: %s - mapifolder: %s", $calendarId, $objectUri, $mapifolder);
+
+        if (!$mapifolder) {
+            $mapifolder = $this->gDavBackend->GetMapiFolder($calendarId);
+        }
+
+        $mapimessage = $this->gDavBackend->GetMapiMessageForId($calendarId, $objectUri, $mapifolder, static::FILE_EXTENSION);
+        if (!$mapimessage) {
+            $this->logger->error("Object NOT FOUND");
+
+            return null;
+        }
+
+        $realId = $this->gDavBackend->GetIdOfMapiMessage($calendarId, $mapimessage);
+
+        // this should be cached or moved to gDavBackend
+        $session = $this->gDavBackend->GetSession();
+        $ab = $this->gDavBackend->GetAddressBook();
+
+        $ics = mapi_mapitoical($session, $ab, $mapimessage, []);
+        if (!$ics && mapi_last_hresult()) {
+            $this->logger->error("Error generating ical, error code: 0x%08X", mapi_last_hresult());
+            $ics = null;
+        }
+        elseif (!$ics) {
+            $this->logger->error("Error generating ical, unknown error");
+            $ics = null;
+        }
+        $this->logger->trace("ics generated by mapi_mapitoical: %s%s", PHP_EOL, $ics);
+
+        $props = mapi_getprops($mapimessage, [PR_LAST_MODIFICATION_TIME]);
+
+        $r = [
+            'id' => $realId,
+            'uri' => $realId . static::FILE_EXTENSION,
+            'etag' => '"' . $props[PR_LAST_MODIFICATION_TIME] . '"',
+            'lastmodified' => $props[PR_LAST_MODIFICATION_TIME],
+            'calendarid' => $calendarId,
+            'size' => strlen($ics),
+            'calendardata' => $ics,
+        ];
+        $this->logger->trace("returned data id: %s - size: %d - etag: %s", $r['id'], $r['size'], $r['etag']);
+
+        return $r;
+    }
+
+    /**
+     * Creates a new calendar object.
+     *
+     * The object uri is only the basename, or filename and not a full path.
+     *
+     * It is possible return an etag from this function, which will be used in
+     * the response to this PUT request. Note that the ETag must be surrounded
+     * by double-quotes.
+     *
+     * However, you should only really return this ETag if you don't mangle the
+     * calendar-data. If the result of a subsequent GET to this object is not
+     * the exact same as this request body, you should omit the ETag.
+     *
+     * @param mixed  $calendarId
+     * @param string $objectUri
+     * @param string $calendarData
+     *
+     * @return null|string
+     */
+    public function createCalendarObject($calendarId, $objectUri, $calendarData) {
+        $this->logger->trace("calendarId: %s - objectUri: %s - calendarData: %s", $calendarId, $objectUri, $calendarData);
+        $objectId = $this->gDavBackend->GetObjectIdFromObjectUri($objectUri, static::FILE_EXTENSION);
+        $folder = $this->gDavBackend->GetMapiFolder($calendarId);
+        $mapimessage = $this->gDavBackend->CreateObject($calendarId, $folder, $objectId);
+        $retval = $this->setData($calendarId, $mapimessage, $calendarData);
+        if (!$retval) {
+            return null;
+        }
+        // $this->UpdateFB($calendarId, $folder);
+        return '"' . $retval . '"';
+    }
+
+    /**
+     * Updates an existing calendarobject, based on its uri.
+     *
+     * The object uri is only the basename, or filename and not a full path.
+     *
+     * It is possible return an etag from this function, which will be used in
+     * the response to this PUT request. Note that the ETag must be surrounded
+     * by double-quotes.
+     *
+     * However, you should only really return this ETag if you don't mangle the
+     * calendar-data. If the result of a subsequent GET to this object is not
+     * the exact same as this request body, you should omit the ETag.
+     *
+     * @param mixed  $calendarId
+     * @param string $objectUri
+     * @param string $calendarData
+     *
+     * @return null|string
+     */
+    public function updateCalendarObject($calendarId, $objectUri, $calendarData) {
+        $this->logger->trace("calendarId: %s - objectUri: %s - calendarData: %s", $calendarId, $objectUri, $calendarData);
+
+        $folder = $this->gDavBackend->GetMapiFolder($calendarId);
+        $mapimessage = $this->gDavBackend->GetMapiMessageForId($calendarId, $objectUri, null, static::FILE_EXTENSION);
+        $retval = $this->setData($calendarId, $mapimessage, $calendarData);
+        if (!$retval) {
+            return null;
+        }
+        // $this->UpdateFB($calendarId, $folder);
+        return '"' . $retval . '"';
+    }
+
+    /**
+     * Sets data for a calendar item.
+     *
+     * @param mixed       $calendarId
+     * @param MAPIMessage $mapimessage
+     * @param string      $ics
+     *
+     * @return null|string
+     */
+    private function setData($calendarId, $mapimessage, $ics) {
+        $this->logger->trace("mapimessage: %s - ics: %s", $mapimessage, $ics);
+        // this should be cached or moved to gDavBackend
+        $store = $this->gDavBackend->GetStoreById($calendarId);
+        $session = $this->gDavBackend->GetSession();
+        $ab = $this->gDavBackend->GetAddressBook();
+
+        // Evolution sends daylight/standard information in the ical data
+        // and some values are not supported by Outlook/Exchange.
+        // Strip that data and leave only the last occurrences of
+        // daylight/standard information.
+        // @see GRAM-52
+
+        $xLicLocation = stripos($ics, 'X-LIC-LOCATION:');
+        if (($xLicLocation !== false) &&
+                (
+                    substr_count($ics, 'BEGIN:DAYLIGHT', $xLicLocation) > 0 ||
+                    substr_count($ics, 'BEGIN:STANDARD', $xLicLocation) > 0
+                )) {
+            $firstDaytime = stripos($ics, 'BEGIN:DAYLIGHT', $xLicLocation);
+            $firstStandard = stripos($ics, 'BEGIN:STANDARD', $xLicLocation);
+
+            $lastDaytime = strripos($ics, 'BEGIN:DAYLIGHT', $xLicLocation);
+            $lastStandard = strripos($ics, 'BEGIN:STANDARD', $xLicLocation);
+
+            // the first part of ics until the first piece of standard/daytime information
+            $cutStart = $firstDaytime < $firstStandard ? $firstDaytime : $firstStandard;
+
+            if ($lastDaytime > $lastStandard) {
+                // the part of the ics with the last piece of standard/daytime information
+                $cutEnd = $lastDaytime;
+
+                // the positions of the last piece of standard information
+                $cut1 = $lastStandard;
+                $cut2 = strripos($ics, 'END:STANDARD', $lastStandard) + 14; // strlen('END:STANDARD')
+            }
+            else {
+                // the part of the ics with the last piece of standard/daytime information
+                $cutEnd = $lastStandard;
+
+                // the positions of the last piece of daylight information
+                $cut1 = $lastDaytime;
+                $cut2 = strripos($ics, 'END:DAYLIGHT', $lastDaytime) + 14; // strlen('END:DAYLIGHT')
+            }
+
+            $ics = substr($ics, 0, $cutStart) . substr($ics, $cut1, ($cut2 - $cut1)) . substr($ics, $cutEnd);
+            $this->logger->trace("newics: %s", $ics);
+        }
+
+        $ok = mapi_icaltomapi($session, $store, $ab, $mapimessage, $ics, false);
+        if (!$ok && mapi_last_hresult()) {
+            $this->logger->error("Error updating mapi object, error code: 0x%08X", mapi_last_hresult());
+
+            return null;
+        }
+        if (!$ok) {
+            $this->logger->error("Error updating mapi object, unknown error");
+
+            return null;
+        }
+
+        mapi_savechanges($mapimessage);
+        $props = mapi_getprops($mapimessage);
+
+        return $props[PR_LAST_MODIFICATION_TIME];
+    }
+
+    /**
+     * Deletes an existing calendar object.
+     *
+     * The object uri is only the basename, or filename and not a full path.
+     *
+     * @param string $calendarId
+     * @param string $objectUri
+     */
+    public function deleteCalendarObject($calendarId, $objectUri) {
+        $this->logger->trace("calendarId: %s - objectUri: %s", $calendarId, $objectUri);
+
+        $mapifolder = $this->gDavBackend->GetMapiFolder($calendarId);
+
+        // to delete we need the PR_ENTRYID of the message
+        // TODO move this part to GrommunioDavBackend
+        $mapimessage = $this->gDavBackend->GetMapiMessageForId($calendarId, $objectUri, $mapifolder, static::FILE_EXTENSION);
+        $props = mapi_getprops($mapimessage, [PR_ENTRYID]);
+        mapi_folder_deletemessages($mapifolder, [$props[PR_ENTRYID]]);
+    }
+
+    /**
+     * Return a single scheduling object.
+     *
+     * TODO: Add implementation.
+     *
+     * @param string $principalUri
+     * @param string $objectUri
+     *
+     * @return array
+     */
+    public function getSchedulingObject($principalUri, $objectUri) {
+        $this->logger->trace("principalUri: %s - objectUri: %s", $principalUri, $objectUri);
+
+        return [];
+    }
+
+    /**
+     * Returns scheduling objects for the principal URI.
+     *
+     * TODO: Add implementation.
+     *
+     * @param string $principalUri
+     *
+     * @return array
+     */
+    public function getSchedulingObjects($principalUri) {
+        $this->logger->trace("principalUri: %s", $principalUri);
+
+        return [];
+    }
+
+    /**
+     * Delete scheduling object.
+     *
+     * TODO: Add implementation.
+     *
+     * @param string $principalUri
+     * @param string $objectUri
+     */
+    public function deleteSchedulingObject($principalUri, $objectUri) {
+        $this->logger->trace("principalUri: %s - objectUri: %s", $principalUri, $objectUri);
+    }
+
+    /**
+     * Create a new scheduling object.
+     *
+     * TODO: Add implementation.
+     *
+     * @param string $principalUri
+     * @param string $objectUri
+     * @param string $objectData
+     */
+    public function createSchedulingObject($principalUri, $objectUri, $objectData) {
+        $this->logger->trace("principalUri: %s - objectUri: %s - objectData: %s", $principalUri, $objectUri, $objectData);
+    }
+
+    /**
+     * Return CTAG for scheduling inbox.
+     *
+     * TODO: Add implementation.
+     *
+     * @param string $principalUri
+     *
+     * @return string
+     */
+    public function getSchedulingInboxCtag($principalUri) {
+        $this->logger->trace("principalUri: %s", $principalUri);
+
+        return "empty";
+    }
+
+    /**
+     * The getChanges method returns all the changes that have happened, since
+     * the specified syncToken in the specified calendar.
+     *
+     * This function should return an array, such as the following:
+     *
+     * [
+     *   'syncToken' => 'The current synctoken',
+     *   'added'   => [
+     *      'new.txt',
+     *   ],
+     *   'modified'   => [
+     *      'modified.txt',
+     *   ],
+     *   'deleted' => [
+     *      'foo.php.bak',
+     *      'old.txt'
+     *   ]
+     * );
+     *
+     * The returned syncToken property should reflect the *current* syncToken
+     * of the calendar, as reported in the {http://sabredav.org/ns}sync-token
+     * property This is * needed here too, to ensure the operation is atomic.
+     *
+     * If the $syncToken argument is specified as null, this is an initial
+     * sync, and all members should be reported.
+     *
+     * The modified property is an array of nodenames that have changed since
+     * the last token.
+     *
+     * The deleted property is an array with nodenames, that have been deleted
+     * from collection.
+     *
+     * The $syncLevel argument is basically the 'depth' of the report. If it's
+     * 1, you only have to report changes that happened only directly in
+     * immediate descendants. If it's 2, it should also include changes from
+     * the nodes below the child collections. (grandchildren)
+     *
+     * The $limit argument allows a client to specify how many results should
+     * be returned at most. If the limit is not specified, it should be treated
+     * as infinite.
+     *
+     * If the limit (infinite or not) is higher than you're willing to return,
+     * you should throw a Sabre\DAV\Exception\TooMuchMatches() exception.
+     *
+     * If the syncToken is expired (due to data cleanup) or unknown, you must
+     * return null.
+     *
+     * The limit is 'suggestive'. You are free to ignore it.
+     *
+     * @param string $calendarId
+     * @param string $syncToken
+     * @param int    $syncLevel
+     * @param int    $limit
+     *
+     * @return array
+     */
+    public function getChangesForCalendar($calendarId, $syncToken, $syncLevel, $limit = null) {
+        $this->logger->trace("calendarId: %s - syncToken: %s - syncLevel: %d - limit: %d", $calendarId, $syncToken, $syncLevel, $limit);
+
+        return $this->gDavBackend->Sync($calendarId, $syncToken, static::FILE_EXTENSION, $limit);
+    }
 }

Braces +3 added lines, -6 removed lines

@@ -211,8 +211,7 @@ 
 
 			if ($filter['name'] == 'VEVENT') {
 				$types[] = 'IPM.Appointment';
-			}
-			elseif ($filter['name'] == 'VTODO') {
+			} elseif ($filter['name'] == 'VTODO') {
 				$types[] = 'IPM.Task';
 			}
 
@@ -282,8 +281,7 @@ 
 		if (!$ics && mapi_last_hresult()) {
 			$this->logger->error("Error generating ical, error code: 0x%08X", mapi_last_hresult());
 			$ics = null;
-		}
-		elseif (!$ics) {
+		} elseif (!$ics) {
 			$this->logger->error("Error generating ical, unknown error");
 			$ics = null;
 		}
@@ -413,8 +411,7 @@ 
 				// the positions of the last piece of standard information
 				$cut1 = $lastStandard;
 				$cut2 = strripos($ics, 'END:STANDARD', $lastStandard) + 14; // strlen('END:STANDARD')
-			}
-			else {
+			} else {
 				// the part of the ics with the last piece of standard/daytime information
 				$cutEnd = $lastStandard;
 

lib/PrincipalsBackend.php

Indentation +169 added lines, -169 removed lines

@@ -10,185 +10,185 @@
 namespace grommunio\DAV;
 
 class PrincipalsBackend implements \Sabre\DAVACL\PrincipalBackend\BackendInterface {
-	protected $gDavBackend;
+    protected $gDavBackend;
 
-	/**
-	 * Constructor.
-	 */
-	public function __construct(GrommunioDavBackend $gDavBackend) {
-		file_put_contents('/tmp/grommunio-dav.log', "construct principals\n", FILE_APPEND);
+    /**
+     * Constructor.
+     */
+    public function __construct(GrommunioDavBackend $gDavBackend) {
+        file_put_contents('/tmp/grommunio-dav.log', "construct principals\n", FILE_APPEND);
 
-		$this->gDavBackend = $gDavBackend;
-	}
+        $this->gDavBackend = $gDavBackend;
+    }
 
-	/**
-	 * Returns a list of principals based on a prefix.
-	 *
-	 * This prefix will often contain something like 'principals'. You are only
-	 * expected to return principals that are in this base path.
-	 *
-	 * You are expected to return at least a 'uri' for every user, you can
-	 * return any additional properties if you wish so. Common properties are:
-	 *   {DAV:}displayname
-	 *   {http://sabredav.org/ns}email-address - This is a custom SabreDAV
-	 *     field that's actually injected in a number of other properties. If
-	 *     you have an email address, use this property.
-	 *
-	 * @param string $prefixPath
-	 *
-	 * @return array
-	 */
-	public function getPrincipalsByPrefix($prefixPath) {
-		$principals = [];
-		if ($prefixPath === 'principals') {
-			$principals[] = $this->getPrincipalByPath($prefixPath);
-			$principals[] = $this->getPrincipalByPath('principals/public');
-		}
+    /**
+     * Returns a list of principals based on a prefix.
+     *
+     * This prefix will often contain something like 'principals'. You are only
+     * expected to return principals that are in this base path.
+     *
+     * You are expected to return at least a 'uri' for every user, you can
+     * return any additional properties if you wish so. Common properties are:
+     *   {DAV:}displayname
+     *   {http://sabredav.org/ns}email-address - This is a custom SabreDAV
+     *     field that's actually injected in a number of other properties. If
+     *     you have an email address, use this property.
+     *
+     * @param string $prefixPath
+     *
+     * @return array
+     */
+    public function getPrincipalsByPrefix($prefixPath) {
+        $principals = [];
+        if ($prefixPath === 'principals') {
+            $principals[] = $this->getPrincipalByPath($prefixPath);
+            $principals[] = $this->getPrincipalByPath('principals/public');
+        }
 
-		return $principals;
-	}
+        return $principals;
+    }
 
-	/**
-	 * Returns a specific principal, specified by it's path.
-	 * The returned structure should be the exact same as from
-	 * getPrincipalsByPrefix.
-	 *
-	 * @param string $path
-	 *
-	 * @return array
-	 */
-	public function getPrincipalByPath($path) {
-		if ($path === 'principals/public') {
-			return [
-				'id' => 'public',
-				'uri' => 'principals/public',
-				'{DAV:}displayname' => 'Public',
-				'{http://sabredav.org/ns}email-address' => 'postmaster@localhost',
-			];
-		}
-		if ($path === 'principals') {
-			$username = $this->gDavBackend->GetUser();
-		}
-		else {
-			$username = str_replace('principals/', '', $path);
-		}
-		file_put_contents('/tmp/grommunio-dav.log', 'before mapi_zarafa_getuser_by_name', FILE_APPEND);
-		$userinfo = mapi_zarafa_getuser_by_name($this->gDavBackend->GetStore($username), $username);
-		file_put_contents('/tmp/grommunio-dav.log', 'AFTER mapi_zarafa_getuser_by_name', FILE_APPEND);
-		if (!$userinfo) {
-			return false;
-		}
-		$emailaddress = (isset($userinfo['emailaddress']) && $userinfo['emailaddress']) ? $userinfo['emailaddress'] : false;
-		$fullname = (isset($userinfo['fullname']) && $userinfo['fullname']) ? $userinfo['fullname'] : false;
+    /**
+     * Returns a specific principal, specified by it's path.
+     * The returned structure should be the exact same as from
+     * getPrincipalsByPrefix.
+     *
+     * @param string $path
+     *
+     * @return array
+     */
+    public function getPrincipalByPath($path) {
+        if ($path === 'principals/public') {
+            return [
+                'id' => 'public',
+                'uri' => 'principals/public',
+                '{DAV:}displayname' => 'Public',
+                '{http://sabredav.org/ns}email-address' => 'postmaster@localhost',
+            ];
+        }
+        if ($path === 'principals') {
+            $username = $this->gDavBackend->GetUser();
+        }
+        else {
+            $username = str_replace('principals/', '', $path);
+        }
+        file_put_contents('/tmp/grommunio-dav.log', 'before mapi_zarafa_getuser_by_name', FILE_APPEND);
+        $userinfo = mapi_zarafa_getuser_by_name($this->gDavBackend->GetStore($username), $username);
+        file_put_contents('/tmp/grommunio-dav.log', 'AFTER mapi_zarafa_getuser_by_name', FILE_APPEND);
+        if (!$userinfo) {
+            return false;
+        }
+        $emailaddress = (isset($userinfo['emailaddress']) && $userinfo['emailaddress']) ? $userinfo['emailaddress'] : false;
+        $fullname = (isset($userinfo['fullname']) && $userinfo['fullname']) ? $userinfo['fullname'] : false;
 
-		return [
-			'id' => $username,
-			'uri' => 'principals/' . $username,
-			'{DAV:}displayname' => $fullname,
-			'{http://sabredav.org/ns}email-address' => $emailaddress,
-			// TODO 'vcardurl' should be set, see here: http://sabre.io/dav/principals/
-		];
-	}
+        return [
+            'id' => $username,
+            'uri' => 'principals/' . $username,
+            '{DAV:}displayname' => $fullname,
+            '{http://sabredav.org/ns}email-address' => $emailaddress,
+            // TODO 'vcardurl' should be set, see here: http://sabre.io/dav/principals/
+        ];
+    }
 
-	/**
-	 * Updates one ore more webdav properties on a principal.
-	 *
-	 * The list of mutations is stored in a Sabre\DAV\PropPatch object.
-	 * To do the actual updates, you must tell this object which properties
-	 * you're going to process with the handle() method.
-	 *
-	 * Calling the handle method is like telling the PropPatch object "I
-	 * promise I can handle updating this property".
-	 *
-	 * Read the PropPatch documentation for more info and examples.
-	 *
-	 * @param string $path
-	 */
-	public function updatePrincipal($path, \Sabre\DAV\PropPatch $propPatch) {
-	}
+    /**
+     * Updates one ore more webdav properties on a principal.
+     *
+     * The list of mutations is stored in a Sabre\DAV\PropPatch object.
+     * To do the actual updates, you must tell this object which properties
+     * you're going to process with the handle() method.
+     *
+     * Calling the handle method is like telling the PropPatch object "I
+     * promise I can handle updating this property".
+     *
+     * Read the PropPatch documentation for more info and examples.
+     *
+     * @param string $path
+     */
+    public function updatePrincipal($path, \Sabre\DAV\PropPatch $propPatch) {
+    }
 
-	/**
-	 * This method is used to search for principals matching a set of
-	 * properties.
-	 *
-	 * This search is specifically used by RFC3744's principal-property-search
-	 * REPORT.
-	 *
-	 * The actual search should be a unicode-non-case-sensitive search. The
-	 * keys in searchProperties are the WebDAV property names, while the values
-	 * are the property values to search on.
-	 *
-	 * By default, if multiple properties are submitted to this method, the
-	 * various properties should be combined with 'AND'. If $test is set to
-	 * 'anyof', it should be combined using 'OR'.
-	 *
-	 * This method should simply return an array with full principal uri's.
-	 *
-	 * If somebody attempted to search on a property the backend does not
-	 * support, you should simply return 0 results.
-	 *
-	 * You can also just return 0 results if you choose to not support
-	 * searching at all, but keep in mind that this may stop certain features
-	 * from working.
-	 *
-	 * @param string $prefixPath
-	 * @param string $test
-	 *
-	 * @return array
-	 */
-	public function searchPrincipals($prefixPath, array $searchProperties, $test = 'allof') {
-	}
+    /**
+     * This method is used to search for principals matching a set of
+     * properties.
+     *
+     * This search is specifically used by RFC3744's principal-property-search
+     * REPORT.
+     *
+     * The actual search should be a unicode-non-case-sensitive search. The
+     * keys in searchProperties are the WebDAV property names, while the values
+     * are the property values to search on.
+     *
+     * By default, if multiple properties are submitted to this method, the
+     * various properties should be combined with 'AND'. If $test is set to
+     * 'anyof', it should be combined using 'OR'.
+     *
+     * This method should simply return an array with full principal uri's.
+     *
+     * If somebody attempted to search on a property the backend does not
+     * support, you should simply return 0 results.
+     *
+     * You can also just return 0 results if you choose to not support
+     * searching at all, but keep in mind that this may stop certain features
+     * from working.
+     *
+     * @param string $prefixPath
+     * @param string $test
+     *
+     * @return array
+     */
+    public function searchPrincipals($prefixPath, array $searchProperties, $test = 'allof') {
+    }
 
-	/**
-	 * Finds a principal by its URI.
-	 *
-	 * This method may receive any type of uri, but mailto: addresses will be
-	 * the most common.
-	 *
-	 * Implementation of this API is optional. It is currently used by the
-	 * CalDAV system to find principals based on their email addresses. If this
-	 * API is not implemented, some features may not work correctly.
-	 *
-	 * This method must return a relative principal path, or null, if the
-	 * principal was not found or you refuse to find it.
-	 *
-	 * @param string $uri
-	 * @param string $principalPrefix
-	 *
-	 * @return string
-	 */
-	public function findByUri($uri, $principalPrefix) {
-	}
+    /**
+     * Finds a principal by its URI.
+     *
+     * This method may receive any type of uri, but mailto: addresses will be
+     * the most common.
+     *
+     * Implementation of this API is optional. It is currently used by the
+     * CalDAV system to find principals based on their email addresses. If this
+     * API is not implemented, some features may not work correctly.
+     *
+     * This method must return a relative principal path, or null, if the
+     * principal was not found or you refuse to find it.
+     *
+     * @param string $uri
+     * @param string $principalPrefix
+     *
+     * @return string
+     */
+    public function findByUri($uri, $principalPrefix) {
+    }
 
-	/**
-	 * Returns the list of members for a group-principal.
-	 *
-	 * @param string $principal
-	 *
-	 * @return array
-	 */
-	public function getGroupMemberSet($principal) {
-		return [];
-	}
+    /**
+     * Returns the list of members for a group-principal.
+     *
+     * @param string $principal
+     *
+     * @return array
+     */
+    public function getGroupMemberSet($principal) {
+        return [];
+    }
 
-	/**
-	 * Returns the list of groups a principal is a member of.
-	 *
-	 * @param string $principal
-	 *
-	 * @return array
-	 */
-	public function getGroupMembership($principal) {
-		return [];
-	}
+    /**
+     * Returns the list of groups a principal is a member of.
+     *
+     * @param string $principal
+     *
+     * @return array
+     */
+    public function getGroupMembership($principal) {
+        return [];
+    }
 
-	/**
-	 * Updates the list of group members for a group principal.
-	 *
-	 * The principals should be passed as a list of uri's.
-	 *
-	 * @param string $principal
-	 */
-	public function setGroupMemberSet($principal, array $members) {
-	}
+    /**
+     * Updates the list of group members for a group principal.
+     *
+     * The principals should be passed as a list of uri's.
+     *
+     * @param string $principal
+     */
+    public function setGroupMemberSet($principal, array $members) {
+    }
 }

Braces +1 added lines, -2 removed lines

@@ -68,8 +68,7 @@
 		}
 		if ($path === 'principals') {
 			$username = $this->gDavBackend->GetUser();
-		}
-		else {
+		} else {
 			$username = str_replace('principals/', '', $path);
 		}
 		file_put_contents('/tmp/grommunio-dav.log', 'before mapi_zarafa_getuser_by_name', FILE_APPEND);