mirror of
https://codeberg.org/streams/streams.git
synced 2024-09-23 02:15:11 +00:00
550 lines
18 KiB
PHP
550 lines
18 KiB
PHP
<?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) fruux GmbH (https://fruux.com/)
|
|
* @author Evert Pot (http://evertpot.com/)
|
|
* @license http://sabre.io/license/ Modified BSD License
|
|
*/
|
|
class PDO extends AbstractBackend implements SyncSupport {
|
|
|
|
/**
|
|
* PDO connection
|
|
*
|
|
* @var PDO
|
|
*/
|
|
protected $pdo;
|
|
|
|
/**
|
|
* The PDO table name used to store addressbooks
|
|
*/
|
|
public $addressBooksTableName = 'addressbooks';
|
|
|
|
/**
|
|
* The PDO table name used to store cards
|
|
*/
|
|
public $cardsTableName = 'cards';
|
|
|
|
/**
|
|
* The table name that will be used for tracking changes in address books.
|
|
*
|
|
* @var string
|
|
*/
|
|
public $addressBookChangesTableName = 'addressbookchanges';
|
|
|
|
/**
|
|
* Sets up the object
|
|
*
|
|
* @param \PDO $pdo
|
|
*/
|
|
function __construct(\PDO $pdo) {
|
|
|
|
$this->pdo = $pdo;
|
|
|
|
}
|
|
|
|
/**
|
|
* Returns the list of addressbooks for a specific user.
|
|
*
|
|
* @param string $principalUri
|
|
* @return array
|
|
*/
|
|
function getAddressBooksForUser($principalUri) {
|
|
|
|
$stmt = $this->pdo->prepare('SELECT id, uri, displayname, principaluri, description, synctoken FROM ' . $this->addressBooksTableName . ' WHERE principaluri = ?');
|
|
$stmt->execute([$principalUri]);
|
|
|
|
$addressBooks = [];
|
|
|
|
foreach ($stmt->fetchAll() as $row) {
|
|
|
|
$addressBooks[] = [
|
|
'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'],
|
|
'{http://sabredav.org/ns}sync-token' => $row['synctoken'] ? $row['synctoken'] : '0',
|
|
];
|
|
|
|
}
|
|
|
|
return $addressBooks;
|
|
|
|
}
|
|
|
|
|
|
/**
|
|
* 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
|
|
* @param \Sabre\DAV\PropPatch $propPatch
|
|
* @return void
|
|
*/
|
|
function updateAddressBook($addressBookId, \Sabre\DAV\PropPatch $propPatch) {
|
|
|
|
$supportedProperties = [
|
|
'{DAV:}displayname',
|
|
'{' . CardDAV\Plugin::NS_CARDDAV . '}addressbook-description',
|
|
];
|
|
|
|
$propPatch->handle($supportedProperties, function($mutations) use ($addressBookId) {
|
|
|
|
$updates = [];
|
|
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;
|
|
}
|
|
}
|
|
$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 int Last insert id
|
|
*/
|
|
function createAddressBook($principalUri, $url, array $properties) {
|
|
|
|
$values = [
|
|
'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(
|
|
$this->addressBooksTableName . '_id_seq'
|
|
);
|
|
|
|
}
|
|
|
|
/**
|
|
* Deletes an entire addressbook and all its contents
|
|
*
|
|
* @param int $addressBookId
|
|
* @return void
|
|
*/
|
|
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 addressbookid = ?');
|
|
$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
|
|
*/
|
|
function getCards($addressbookId) {
|
|
|
|
$stmt = $this->pdo->prepare('SELECT id, uri, lastmodified, etag, size FROM ' . $this->cardsTableName . ' WHERE addressbookid = ?');
|
|
$stmt->execute([$addressbookId]);
|
|
|
|
$result = [];
|
|
while ($row = $stmt->fetch(\PDO::FETCH_ASSOC)) {
|
|
$row['etag'] = '"' . $row['etag'] . '"';
|
|
$row['lastmodified'] = (int)$row['lastmodified'];
|
|
$result[] = $row;
|
|
}
|
|
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
|
|
* @return array
|
|
*/
|
|
function getCard($addressBookId, $cardUri) {
|
|
|
|
$stmt = $this->pdo->prepare('SELECT id, carddata, uri, lastmodified, etag, size FROM ' . $this->cardsTableName . ' WHERE addressbookid = ? AND uri = ? LIMIT 1');
|
|
$stmt->execute([$addressBookId, $cardUri]);
|
|
|
|
$result = $stmt->fetch(\PDO::FETCH_ASSOC);
|
|
|
|
if (!$result) return false;
|
|
|
|
$result['etag'] = '"' . $result['etag'] . '"';
|
|
$result['lastmodified'] = (int)$result['lastmodified'];
|
|
return $result;
|
|
|
|
}
|
|
|
|
/**
|
|
* 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
|
|
*/
|
|
function getMultipleCards($addressBookId, array $uris) {
|
|
|
|
$query = 'SELECT id, uri, lastmodified, etag, size, carddata 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));
|
|
$result = [];
|
|
while ($row = $stmt->fetch(\PDO::FETCH_ASSOC)) {
|
|
$row['etag'] = '"' . $row['etag'] . '"';
|
|
$row['lastmodified'] = (int)$row['lastmodified'];
|
|
$result[] = $row;
|
|
}
|
|
return $result;
|
|
|
|
}
|
|
|
|
/**
|
|
* 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
|
|
*/
|
|
function createCard($addressBookId, $cardUri, $cardData) {
|
|
|
|
$stmt = $this->pdo->prepare('INSERT INTO ' . $this->cardsTableName . ' (carddata, uri, lastmodified, addressbookid, size, etag) VALUES (?, ?, ?, ?, ?, ?)');
|
|
|
|
$etag = md5($cardData);
|
|
|
|
$stmt->execute([
|
|
$cardData,
|
|
$cardUri,
|
|
time(),
|
|
$addressBookId,
|
|
strlen($cardData),
|
|
$etag,
|
|
]);
|
|
|
|
$this->addChange($addressBookId, $cardUri, 1);
|
|
|
|
return '"' . $etag . '"';
|
|
|
|
}
|
|
|
|
/**
|
|
* 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
|
|
*/
|
|
function updateCard($addressBookId, $cardUri, $cardData) {
|
|
|
|
$stmt = $this->pdo->prepare('UPDATE ' . $this->cardsTableName . ' SET carddata = ?, lastmodified = ?, size = ?, etag = ? WHERE uri = ? AND addressbookid =?');
|
|
|
|
$etag = md5($cardData);
|
|
$stmt->execute([
|
|
$cardData,
|
|
time(),
|
|
strlen($cardData),
|
|
$etag,
|
|
$cardUri,
|
|
$addressBookId
|
|
]);
|
|
|
|
$this->addChange($addressBookId, $cardUri, 2);
|
|
|
|
return '"' . $etag . '"';
|
|
|
|
}
|
|
|
|
/**
|
|
* Deletes a card
|
|
*
|
|
* @param mixed $addressBookId
|
|
* @param string $cardUri
|
|
* @return bool
|
|
*/
|
|
function deleteCard($addressBookId, $cardUri) {
|
|
|
|
$stmt = $this->pdo->prepare('DELETE FROM ' . $this->cardsTableName . ' WHERE addressbookid = ? AND uri = ?');
|
|
$stmt->execute([$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 {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
|
|
*/
|
|
function getChangesForAddressBook($addressBookId, $syncToken, $syncLevel, $limit = null) {
|
|
|
|
// Current synctoken
|
|
$stmt = $this->pdo->prepare('SELECT synctoken FROM ' . $this->addressBooksTableName . ' 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 " . $this->cardsTableName . " 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 ' . $this->addressBooksTableName . ' WHERE id = ?');
|
|
$stmt->execute([
|
|
$objectUri,
|
|
$addressBookId,
|
|
$operation,
|
|
$addressBookId
|
|
]);
|
|
$stmt = $this->pdo->prepare('UPDATE ' . $this->addressBooksTableName . ' SET synctoken = synctoken + 1 WHERE id = ?');
|
|
$stmt->execute([
|
|
$addressBookId
|
|
]);
|
|
|
|
}
|
|
}
|