/lib/Sabre/CardDAV/Backend/PDO.php
PHP | 524 lines | 195 code | 93 blank | 236 comment | 7 complexity | 8dad879b2ec626cb89dda1bf68ac53b4 MD5 | raw file
Possible License(s): BSD-3-Clause
- <?php
- namespace Sabre\CardDAV\Backend;
- use Sabre\CardDAV;
- use Sabre\DAV;
- /**
- * PDO CardDAV backend
- *
- * This CardDAV backend uses PDO to store addressbooks
- *
- * @copyright Copyright (C) 2007-2013 fruux GmbH (https://fruux.com/).
- * @author Evert Pot (http://evertpot.com/)
- * @license http://code.google.com/p/sabredav/wiki/License Modified BSD License
- */
- class PDO extends AbstractBackend implements SyncSupport {
- /**
- * PDO connection
- *
- * @var PDO
- */
- protected $pdo;
- /**
- * The PDO table name used to store addressbooks
- */
- protected $addressBooksTableName;
- /**
- * The PDO table name used to store cards
- */
- protected $cardsTableName;
- /**
- * The table name that will be used for tracking changes in address books.
- *
- * @var string
- */
- protected $addressBookChangesTableName;
- /**
- * Sets up the object
- *
- * @param \PDO $pdo
- * @param string $addressBooksTableName
- * @param string $cardsTableName
- */
- public function __construct(\PDO $pdo, $addressBooksTableName = 'addressbooks', $cardsTableName = 'cards', $addressBookChangesTableName = 'addressbookchanges') {
- $this->pdo = $pdo;
- $this->addressBooksTableName = $addressBooksTableName;
- $this->cardsTableName = $cardsTableName;
- $this->addressBookChangesTableName = $addressBookChangesTableName;
- }
- /**
- * Returns the list of addressbooks for a specific user.
- *
- * @param string $principalUri
- * @return array
- */
- public function getAddressBooksForUser($principalUri) {
- $stmt = $this->pdo->prepare('SELECT id, uri, displayname, principaluri, description, synctoken FROM '.$this->addressBooksTableName.' WHERE principaluri = ?');
- $stmt->execute(array($principalUri));
- $addressBooks = array();
- foreach($stmt->fetchAll() as $row) {
- $addressBooks[] = array(
- 'id' => $row['id'],
- 'uri' => $row['uri'],
- 'principaluri' => $row['principaluri'],
- '{DAV:}displayname' => $row['displayname'],
- '{' . CardDAV\Plugin::NS_CARDDAV . '}addressbook-description' => $row['description'],
- '{http://calendarserver.org/ns/}getctag' => $row['synctoken'],
- '{' . CardDAV\Plugin::NS_CARDDAV . '}supported-address-data' =>
- new CardDAV\Property\SupportedAddressData(),
- '{DAV:}sync-token' => $row['synctoken']?$row['synctoken']:'0',
- );
- }
- return $addressBooks;
- }
- /**
- * Updates an addressbook's properties
- *
- * See Sabre\DAV\IProperties for a description of the mutations array, as
- * well as the return value.
- *
- * @param mixed $addressBookId
- * @param array $mutations
- * @see Sabre\DAV\IProperties::updateProperties
- * @return bool|array
- */
- public function updateAddressBook($addressBookId, array $mutations) {
- $updates = array();
- foreach($mutations as $property=>$newValue) {
- switch($property) {
- case '{DAV:}displayname' :
- $updates['displayname'] = $newValue;
- break;
- case '{' . CardDAV\Plugin::NS_CARDDAV . '}addressbook-description' :
- $updates['description'] = $newValue;
- break;
- default :
- // If any unsupported values were being updated, we must
- // let the entire request fail.
- return false;
- }
- }
- // No values are being updated?
- if (!$updates) {
- return false;
- }
- $query = 'UPDATE ' . $this->addressBooksTableName . ' SET ';
- $first = true;
- foreach($updates as $key=>$value) {
- if ($first) {
- $first = false;
- } else {
- $query.=', ';
- }
- $query.=' `' . $key . '` = :' . $key . ' ';
- }
- $query.=' WHERE id = :addressbookid';
- $stmt = $this->pdo->prepare($query);
- $updates['addressbookid'] = $addressBookId;
- $stmt->execute($updates);
- $this->addChange($addressBookId, "", 2);
- return true;
- }
- /**
- * Creates a new address book
- *
- * @param string $principalUri
- * @param string $url Just the 'basename' of the url.
- * @param array $properties
- * @return void
- */
- public function createAddressBook($principalUri, $url, array $properties) {
- $values = array(
- 'displayname' => null,
- 'description' => null,
- 'principaluri' => $principalUri,
- 'uri' => $url,
- );
- foreach($properties as $property=>$newValue) {
- switch($property) {
- case '{DAV:}displayname' :
- $values['displayname'] = $newValue;
- break;
- case '{' . CardDAV\Plugin::NS_CARDDAV . '}addressbook-description' :
- $values['description'] = $newValue;
- break;
- default :
- throw new DAV\Exception\BadRequest('Unknown property: ' . $property);
- }
- }
- $query = 'INSERT INTO ' . $this->addressBooksTableName . ' (uri, displayname, description, principaluri, synctoken) VALUES (:uri, :displayname, :description, :principaluri, 1)';
- $stmt = $this->pdo->prepare($query);
- $stmt->execute($values);
- return $this->pdo->lastInsertId();
- }
- /**
- * Deletes an entire addressbook and all its contents
- *
- * @param int $addressBookId
- * @return void
- */
- public function deleteAddressBook($addressBookId) {
- $stmt = $this->pdo->prepare('DELETE FROM ' . $this->cardsTableName . ' WHERE addressbookid = ?');
- $stmt->execute([$addressBookId]);
- $stmt = $this->pdo->prepare('DELETE FROM ' . $this->addressBooksTableName . ' WHERE id = ?');
- $stmt->execute([$addressBookId]);
- $stmt = $this->pdo->prepare('DELETE FROM '.$this->addressBookChangesTableName.' WHERE id = ?');
- $stmt->execute([$addressBookId]);
- }
- /**
- * 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 ommit carddata.
- * This may speed up certain requests, especially with large cards.
- *
- * @param mixed $addressbookId
- * @return array
- */
- public function getCards($addressbookId) {
- $stmt = $this->pdo->prepare('SELECT id, carddata, uri, lastmodified FROM ' . $this->cardsTableName . ' WHERE addressbookid = ?');
- $stmt->execute(array($addressbookId));
- return $stmt->fetchAll(\PDO::FETCH_ASSOC);
- }
- /**
- * Returns a specfic 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
- * @return array
- */
- public function getCard($addressBookId, $cardUri) {
- $stmt = $this->pdo->prepare('SELECT id, carddata, uri, lastmodified FROM ' . $this->cardsTableName . ' WHERE addressbookid = ? AND uri = ? LIMIT 1');
- $stmt->execute(array($addressBookId, $cardUri));
- $result = $stmt->fetch(\PDO::FETCH_ASSOC);
- return $result?$result:false;
- }
- /**
- * Returns a list of cards.
- *
- * This method should work identical to getCard, but instead return all the
- * cards in the list as an array.
- *
- * If the backend supports this, it may allow for some speed-ups.
- *
- * @param mixed $addressBookId
- * @param array $uris
- * @return array
- */
- public function getMultipleCards($addressBookId, array $uris) {
- return array_map(function($uri) use ($addressBookId) {
- return $this->getCard($addressBookId, $uri);
- }, $uris);
- $query = 'SELECT id, carddata, uri, lastmodified FROM ' . $this->cardsTableName . ' WHERE addressbookid = ? AND uri = IN (';
- // Inserting a whole bunch of question marks
- $query.=implode(',', array_fill(0, count($uris), '?'));
- $query.=')';
- $stmt = $this->pdo->prepare($query);
- $stmt->execute(array_merge([$addressBookId], $uris));
- return $stmt->fetchAll(\PDO::FETCH_ASSOC);
- }
- /**
- * 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 string|null
- */
- public function createCard($addressBookId, $cardUri, $cardData) {
- $stmt = $this->pdo->prepare('INSERT INTO ' . $this->cardsTableName . ' (carddata, uri, lastmodified, addressbookid) VALUES (?, ?, ?, ?)');
- $result = $stmt->execute(array($cardData, $cardUri, time(), $addressBookId));
- $this->addChange($addressBookId, $cardUri, 1);
- return '"' . md5($cardData) . '"';
- }
- /**
- * 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 string|null
- */
- public function updateCard($addressBookId, $cardUri, $cardData) {
- $stmt = $this->pdo->prepare('UPDATE ' . $this->cardsTableName . ' SET carddata = ?, lastmodified = ? WHERE uri = ? AND addressbookid =?');
- $stmt->execute(array($cardData, time(), $cardUri, $addressBookId));
- $this->addChange($addressBookId, $cardUri, 2);
- return '"' . md5($cardData) . '"';
- }
- /**
- * Deletes a card
- *
- * @param mixed $addressBookId
- * @param string $cardUri
- * @return bool
- */
- public function deleteCard($addressBookId, $cardUri) {
- $stmt = $this->pdo->prepare('DELETE FROM ' . $this->cardsTableName . ' WHERE addressbookid = ? AND uri = ?');
- $stmt->execute(array($addressBookId, $cardUri));
- $this->addChange($addressBookId, $cardUri, 3);
- return $stmt->rowCount()===1;
- }
- /**
- * 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' => [
- * 'updated.txt',
- * ],
- * 'deleted' => [
- * 'foo.php.bak',
- * 'old.txt'
- * ]
- * ];
- *
- * The returned syncToken property should reflect the *current* syncToken
- * of the addressbook, as reported in the {DAV:}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) {
- // Current synctoken
- $stmt = $this->pdo->prepare('SELECT synctoken FROM addressbooks WHERE id = ?');
- $stmt->execute([ $addressBookId ]);
- $currentToken = $stmt->fetchColumn(0);
- if (is_null($currentToken)) return null;
- $result = [
- 'syncToken' => $currentToken,
- 'added' => [],
- 'modified' => [],
- 'deleted' => [],
- ];
- if ($syncToken) {
- $query = "SELECT uri, operation FROM " . $this->addressBookChangesTableName . " WHERE synctoken >= ? AND synctoken < ? AND addressbookid = ? ORDER BY synctoken";
- if ($limit>0) $query.= " LIMIT " . (int)$limit;
- // Fetching all changes
- $stmt = $this->pdo->prepare($query);
- $stmt->execute([$syncToken, $currentToken, $addressBookId]);
- $changes = [];
- // This loop ensures that any duplicates are overwritten, only the
- // last change on a node is relevant.
- while($row = $stmt->fetch(\PDO::FETCH_ASSOC)) {
- $changes[$row['uri']] = $row['operation'];
- }
- foreach($changes as $uri => $operation) {
- switch($operation) {
- case 1:
- $result['added'][] = $uri;
- break;
- case 2:
- $result['modified'][] = $uri;
- break;
- case 3:
- $result['deleted'][] = $uri;
- break;
- }
- }
- } else {
- // No synctoken supplied, this is the initial sync.
- $query = "SELECT uri FROM cards WHERE addressbookid = ?";
- $stmt = $this->pdo->prepare($query);
- $stmt->execute([$addressBookId]);
- $result['added'] = $stmt->fetchAll(\PDO::FETCH_COLUMN);
- }
- return $result;
- }
- /**
- * Adds a change record to the addressbookchanges table.
- *
- * @param mixed $addressBookId
- * @param string $objectUri
- * @param int $operation 1 = add, 2 = modify, 3 = delete/
- * @return void
- */
- protected function addChange($addressBookId, $objectUri, $operation) {
- $stmt = $this->pdo->prepare('INSERT INTO ' . $this->addressBookChangesTableName .' (uri, synctoken, addressbookid, operation) SELECT ?, synctoken, ?, ? FROM addressbooks WHERE id = ?');
- $stmt->execute([
- $objectUri,
- $addressBookId,
- $operation,
- $addressBookId
- ]);
- $stmt = $this->pdo->prepare('UPDATE ' . $this->addressBooksTableName . ' SET synctoken = synctoken + 1 WHERE id = ?');
- $stmt->execute([
- $addressBookId
- ]);
- }
- }