CardDAV first look

This commit is contained in:
RainLoop Team 2013-12-19 20:04:56 +04:00
parent c031a946e8
commit 7648000521
217 changed files with 31899 additions and 12 deletions

View file

@ -60,6 +60,17 @@ class PersonalAddressBook extends \RainLoop\Providers\AbstractProvider
$this->oDriver->IsSupported();
}
/**
* @param string $sEmail
*
* @return string
*/
public function GetUserUidByEmail($sEmail)
{
return $this->oDriver instanceof \RainLoop\Providers\PersonalAddressBook\PersonalAddressBookInterface &&
$this->oDriver->GetUserUidByEmail($sEmail);
}
/**
* @param bool $bConsiderShare = true
*/
@ -96,7 +107,7 @@ class PersonalAddressBook extends \RainLoop\Providers\AbstractProvider
}
/**
* @param \RainLoop\Account $oAccount
* @param \RainLoop\Account|mixed $mAccountOrId
* @param int $iOffset = 0
* @param type $iLimit = 20
* @param string $sSearch = ''
@ -104,9 +115,9 @@ class PersonalAddressBook extends \RainLoop\Providers\AbstractProvider
*
* @return array
*/
public function GetContacts($oAccount, $iOffset = 0, $iLimit = 20, $sSearch = '', &$iResultCount = 0)
public function GetContacts($mAccountOrId, $iOffset = 0, $iLimit = 20, $sSearch = '', &$iResultCount = 0)
{
return $this->IsActive() ? $this->oDriver->GetContacts($oAccount,
return $this->IsActive() ? $this->oDriver->GetContacts($mAccountOrId,
$iOffset, $iLimit, $sSearch, $iResultCount) : array();
}

View file

@ -2,6 +2,8 @@
namespace RainLoop\Providers\PersonalAddressBook\Classes;
use RainLoop\Providers\PersonalAddressBook\Enumerations\PropertyType;
class Contact
{
/**
@ -115,4 +117,56 @@ class Contact
return \array_unique($aResult);
}
/**
* @return string
*/
public function ToVCardObject()
{
$oVCard = new \Sabre\VObject\Component\VCard('VCARD');
$oVCard->VERSION = '3.0';
$oVCard->PRODID = '-//RainLoop//'.APP_VERSION.'//EN';
$sFirstName = $sSurName = '';
foreach ($this->Properties as /* @var $oProperty \RainLoop\Providers\PersonalAddressBook\Classes\Property */ &$oProperty)
{
if ($oProperty)
{
switch ($oProperty->Type)
{
case PropertyType::FULLNAME:
$oVCard->FN = $oProperty->Value;
break;
case PropertyType::NICK:
$oVCard->NICKNAME = $oProperty->Value;
break;
case PropertyType::FIRST_NAME:
$sFirstName = $oProperty->Value;
break;
case PropertyType::SUR_NAME:
$sSurName = $oProperty->Value;
break;
}
if (PropertyType::FULLNAME === $oProperty->Type)
{
$oVCard->FN = $oProperty->Value;
}
}
}
$oVCard->UID = ((string) $this->IdContact).'.vcf';
// $oVCard->N = array(
// $sSurName,
// $sFirstName,
// '',
// '',
// '',
// ''
// );
return $oVCard;
}
}

View file

@ -82,6 +82,16 @@ class PdoPersonalAddressBook
return $this->IsConsiderShare() && $this->IsSupported();
}
/**
* @param string $sEmail
* @return mixed
*/
public function GetUserUidByEmail($sEmail)
{
$iId = $this->getUserId($sEmail);
return 0 < $iId ? (string) $iId : '';
}
/**
* @param \RainLoop\Account $oAccount
* @param \RainLoop\Providers\PersonalAddressBook\Classes\Contact $oContact
@ -275,7 +285,7 @@ class PdoPersonalAddressBook
}
/**
* @param \RainLoop\Account $oAccount
* @param \RainLoop\Account|mixed $mAccountOrId
* @param int $iOffset = 0
* @param int $iLimit = 20
* @param string $sSearch = ''
@ -283,7 +293,7 @@ class PdoPersonalAddressBook
*
* @return array
*/
public function GetContacts($oAccount, $iOffset = 0, $iLimit = 20, $sSearch = '', &$iResultCount = 0)
public function GetContacts($mAccountOrId, $iOffset = 0, $iLimit = 20, $sSearch = '', &$iResultCount = 0)
{
$this->Sync();
@ -291,7 +301,11 @@ class PdoPersonalAddressBook
$iLimit = 0 < $iLimit ? (int) $iLimit : 20;
$sSearch = \trim($sSearch);
$iUserID = $this->getUserId($oAccount->ParentEmailHelper());
$iUserID = $mAccountOrId instanceof \RainLoop\Account ? $this->getUserId($mAccountOrId->ParentEmailHelper()) : (int) $mAccountOrId;
if (0 === $iUserID)
{
throw new \InvalidArgumentException('Invalid Accoutn ID');
}
$iCount = 0;
$aSearchIds = array();

View file

@ -34,7 +34,7 @@ interface PersonalAddressBookInterface
public function DeleteTags($oAccount, $aTagsIds);
/**
* @param \RainLoop\Account $oAccount
* @param \RainLoop\Account|mixed $mAccountOrId
* @param int $iOffset = 0
* @param int $iLimit = 20
* @param string $sSearch = ''
@ -42,7 +42,7 @@ interface PersonalAddressBookInterface
*
* @return array
*/
public function GetContacts($oAccount, $iOffset = 0, $iLimit = 20, $sSearch = '', &$iResultCount = 0);
public function GetContacts($mAccountOrId, $iOffset = 0, $iLimit = 20, $sSearch = '', &$iResultCount = 0);
/**
* @param \RainLoop\Account $oAccount

View file

@ -0,0 +1,31 @@
<?php
namespace RainLoop\SabreDAV;
class AuthBasic extends \Sabre\DAV\Auth\Backend\AbstractBasic
{
/**
* @var \RainLoop\Providers\PersonalAddressBook
*/
private $oPersonalAddressBook;
/**
* @param \RainLoop\Providers\PersonalAddressBook $oPersonalAddressBook
*/
public function __construct($oPersonalAddressBook)
{
$this->oPersonalAddressBook = $oPersonalAddressBook;
}
/**
* @param string $sUserName
* @param string $sPassword
*
* @return bool
*/
protected function validateUserPass($sUserName, $sPassword)
{
$this->currentUser = $sUserName;
return true; // TODO
}
}

View file

@ -0,0 +1,28 @@
<?php
namespace RainLoop\SabreDAV;
class AuthBasic extends \Sabre\DAV\Auth\Backend\AbstractDigest
{
/**
* @var \RainLoop\Providers\PersonalAddressBook
*/
private $oPersonalAddressBook;
/**
* @param \RainLoop\Providers\PersonalAddressBook $oPersonalAddressBook
*/
public function __construct($oPersonalAddressBook)
{
$this->oPersonalAddressBook = $oPersonalAddressBook;
}
/**
* @return bool
*/
public function getDigestHash($sRealm, $sUserName)
{
$this->currentUser = $sUserName;
return true; // TODO
}
}

View file

@ -0,0 +1,278 @@
<?php
namespace RainLoop\SabreDAV;
class CardDAV implements \Sabre\CardDAV\Backend\BackendInterface {
/**
* @var \RainLoop\Providers\PersonalAddressBook
*/
private $oPersonalAddressBook;
/**
* @param \RainLoop\Providers\PersonalAddressBook $oPersonalAddressBook
*/
public function __construct($oPersonalAddressBook)
{
$this->oPersonalAddressBook = $oPersonalAddressBook;
}
/**
* @param string $sPrincipalUri
*
* @return string
*/
private function getEmailFromPrincipalUri($sPrincipalUri)
{
$sEmail = '';
$aMatch = array();
if (\preg_match('/\/?principals\/([^@\/]+@[^@\/]+)/i', $sPrincipalUri, $aMatch) && !empty($aMatch[1]))
{
$sEmail = \trim($aMatch[1]);
}
return $sEmail;
}
/**
* @param string $sPrincipalUri
*
* @return string
*/
private function getCalendarID($sPrincipalUri)
{
$mUserId = (string) $this->oPersonalAddressBook->GetUserUidByEmail(
$this->getEmailFromPrincipalUri($sPrincipalUri));
return !empty($mUserId) ? $mUserId : '';
}
/**
* Returns the list of addressbooks for a specific user.
*
* @param string $sPrincipalUri
* @return array
*/
public function getAddressBooksForUser($sPrincipalUri)
{
$mAddressBookID = $this->getCalendarID($sPrincipalUri);
$aAddressBooks = array();
if (!empty($mAddressBookID))
{
$aAddressBooks[] = array(
'id' => $mAddressBookID,
'uri' => 'default',
'principaluri' => $sPrincipalUri,
'{DAV:}displayname' => 'Personal Address Book',
'{'.\Sabre\CardDAV\Plugin::NS_CARDDAV.'}addressbook-description' => 'Personal Address Book',
'{http://calendarserver.org/ns/}getctag' => 1,
'{'.\Sabre\CardDAV\Plugin::NS_CARDDAV.'}supported-address-data' => new \Sabre\CardDAV\Property\SupportedAddressData()
);
}
return $aAddressBooks;
}
/**
* Updates an addressbook's properties
*
* See Sabre\DAV\IProperties for a description of the mutations array, as
* well as the return value.
*
* @param mixed $mAddressBookId
* @param array $aMutations
* @see Sabre\DAV\IProperties::updateProperties
* @return bool|array
*/
public function updateAddressBook($mAddressBookId, array $aMutations)
{
return false;
}
/**
* Creates a new address book
*
* @param string $sPrincipalUri
* @param string $sUrl Just the 'basename' of the url.
* @param array $aProperties
*
* @return void
*/
public function createAddressBook($sPrincipalUri, $sUrl, array $aProperties)
{
}
/**
* Deletes an entire addressbook and all its contents
*
* @param mixed $mAddressBookId
*
* @return void
*/
public function deleteAddressBook($mAddressBookId)
{
}
private function simpleGetCards($mAddressBookId, $sCardUri = '')
{
$aResult = array();
if (!empty($mAddressBookId))
{
$aList = $this->oPersonalAddressBook->GetContacts($mAddressBookId, 0, 20);
foreach ($aList as /* @var $oItem \RainLoop\Providers\PersonalAddressBook\Classes\Contact */ $oItem)
{
$oVCard = $oItem->ToVCardObject();
if ('' === $sCardUri || $sCardUri === $oVCard->UID)
{
$aResult[] = array(
'id' => $oItem->IdContact,
'uri' => $oVCard->UID,
'lastmodified' => $oItem->Changed,
'carddata' => $oVCard->serialize()
);
}
}
}
return $aResult;
}
/**
* 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 $mAddressbookId
*
* @return array
*/
public function getCards($mAddressBookId)
{
return $this->simpleGetCards($mAddressBookId);
}
/**
* Returns a specfic card.
*
* The same set of properties must be returned as with getCards. The only
* exception is that 'carddata' is absolutely required.
*
* @param mixed $mAddressBookId
* @param string $sCardUri
* @return array
*/
public function getCard($mAddressBookId, $sCardUri)
{
$aList = $this->simpleGetCards($mAddressBookId, $sCardUri);
return 0 < count($aList) && isset($aList) ? $aList[0] : false;
}
/**
* 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 $mAddressBookId
* @param string $sCardUri
* @param string $sCardData
* @return string|null
*/
public function createCard($mAddressBookId, $sCardUri, $sCardData)
{
return null;
//
// $stmt = $this->pdo->prepare('INSERT INTO ' . $this->cardsTableName . ' (carddata, uri, lastmodified, addressbookid) VALUES (?, ?, ?, ?)');
//
// $result = $stmt->execute(array($cardData, $cardUri, time(), $addressBookId));
//
// $stmt2 = $this->pdo->prepare('UPDATE ' . $this->addressBooksTableName . ' SET ctag = ctag + 1 WHERE id = ?');
// $stmt2->execute(array($addressBookId));
//
// 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 $mAddressBookId
* @param string $sCardUri
* @param string $sCardData
* @return string|null
*/
public function updateCard($mAddressBookId, $sCardUri, $sCardData)
{
return null;
// $stmt = $this->pdo->prepare('UPDATE ' . $this->cardsTableName . ' SET carddata = ?, lastmodified = ? WHERE uri = ? AND addressbookid =?');
// $stmt->execute(array($cardData, time(), $cardUri, $addressBookId));
//
// $stmt2 = $this->pdo->prepare('UPDATE ' . $this->addressBooksTableName . ' SET ctag = ctag + 1 WHERE id = ?');
// $stmt2->execute(array($addressBookId));
//
// return '"' . md5($cardData) . '"';
}
/**
* Deletes a card
*
* @param mixed $mAddressBookId
* @param string $sCardUri
*
* @return bool
*/
public function deleteCard($mAddressBookId, $sCardUri)
{
return false;
// $stmt = $this->pdo->prepare('DELETE FROM ' . $this->cardsTableName . ' WHERE addressbookid = ? AND uri = ?');
// $stmt->execute(array($addressBookId, $cardUri));
//
// $stmt2 = $this->pdo->prepare('UPDATE ' . $this->addressBooksTableName . ' SET ctag = ctag + 1 WHERE id = ?');
// $stmt2->execute(array($addressBookId));
//
// return $stmt->rowCount()===1;
}
}

View file

@ -0,0 +1,206 @@
<?php
namespace RainLoop\SabreDAV;
class Principal extends \Sabre\DAVACL\PrincipalBackend\AbstractBackend
{
/**
* @var \RainLoop\Providers\PersonalAddressBook
*/
private $oPersonalAddressBook;
/**
* @var \RainLoop\SabreDAV\AuthBasic
*/
private $oAuthBackend;
/**
* @param \RainLoop\Providers\PersonalAddressBook $oPersonalAddressBook
* @param \RainLoop\SabreDAV\AuthBasic $oAuthBackend
*/
public function __construct($oPersonalAddressBook, &$oAuthBackend)
{
$this->oPersonalAddressBook = $oPersonalAddressBook;
$this->oAuthBackend = $oAuthBackend;
}
/**
* 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
*/
function getPrincipalsByPrefix($prefixPath)
{
$aResult = array();
if (\preg_match('/^principals/', $prefixPath))
{
$sGetCurrentUser = $this->oAuthBackend->getCurrentUser();
if (!empty($sGetCurrentUser))
{
$aResult[] = array(
'uri' => 'principals/'.$sGetCurrentUser,
'{DAV:}displayname' => $sGetCurrentUser,
'{http://sabredav.org/ns}email-address' => $sGetCurrentUser
);
}
}
return $aResult;
}
/**
* Returns a specific principal, specified by it's path.
* The returned structure should be the exact same as from
* getPrincipalsByPrefix.
*
* @param string $sPath
* @return array
*/
function getPrincipalByPath($sPath)
{
$sGetCurrentUser = $this->oAuthBackend->getCurrentUser();
if ('principals/'.$sGetCurrentUser === $sPath)
{
// var_dump($sPath);
return array(
'uri' => 'principals/'.$sGetCurrentUser,
'{DAV:}displayname' => $sGetCurrentUser,
'{http://sabredav.org/ns}email-address' => $sGetCurrentUser
);
}
return array();
}
/**
* Updates one ore more webdav properties on a principal.
*
* The list of mutations is supplied as an array. Each key in the array is
* a propertyname, such as {DAV:}displayname.
*
* Each value is the actual value to be updated. If a value is null, it
* must be deleted.
*
* This method should be atomic. It must either completely succeed, or
* completely fail. Success and failure can simply be returned as 'true' or
* 'false'.
*
* It is also possible to return detailed failure information. In that case
* an array such as this should be returned:
*
* array(
* 200 => array(
* '{DAV:}prop1' => null,
* ),
* 201 => array(
* '{DAV:}prop2' => null,
* ),
* 403 => array(
* '{DAV:}prop3' => null,
* ),
* 424 => array(
* '{DAV:}prop4' => null,
* ),
* );
*
* In this previous example prop1 was successfully updated or deleted, and
* prop2 was succesfully created.
*
* prop3 failed to update due to '403 Forbidden' and because of this prop4
* also could not be updated with '424 Failed dependency'.
*
* This last example was actually incorrect. While 200 and 201 could appear
* in 1 response, if there's any error (403) the other properties should
* always fail with 423 (failed dependency).
*
* But anyway, if you don't want to scratch your head over this, just
* return true or false.
*
* @param string $path
* @param array $mutations
* @return array|bool
*/
function updatePrincipal($path, $mutations)
{
return array();
}
/**
* 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. You should at least allow searching on
* http://sabredav.org/ns}email-address.
*
* 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.
*
* If multiple properties are being searched on, the search should be
* AND'ed.
*
* 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 array $searchProperties
* @return array
*/
function searchPrincipals($prefixPath, array $searchProperties)
{
return array();
}
/**
* Returns the list of members for a group-principal
*
* @param string $principal
* @return array
*/
function getGroupMemberSet($principal)
{
return array();
}
/**
* Returns the list of groups a principal is a member of
*
* @param string $principal
* @return array
*/
function getGroupMembership($principal)
{
return array();
}
/**
* Updates the list of group members for a group principal.
*
* The principals should be passed as a list of uri's.
*
* @param string $principal
* @param array $members
* @return void
*/
function setGroupMemberSet($principal, array $members)
{
}
}

View file

@ -102,11 +102,19 @@ class Service
$bCached = false;
$sResult = '';
$sQuery = \trim(\trim($this->oHttp->GetServer('QUERY_STRING', '')), ' /');
$iPos = \strpos($sQuery, '&');
if (0 < $iPos)
$sPathInfo = \trim(\trim($this->oHttp->GetServer('PATH_INFO', '')), ' /');
if (empty($sPathInfo))
{
$sQuery = \substr($sQuery, 0, $iPos);
$sQuery = \trim(\trim($this->oHttp->GetServer('QUERY_STRING', '')), ' /');
$iPos = \strpos($sQuery, '&');
if (0 < $iPos)
{
$sQuery = \substr($sQuery, 0, $iPos);
}
}
else
{
$sQuery = $sPathInfo;
}
$this->oActions->Plugins()->RunHook('filter.http-query', array(&$sQuery));

View file

@ -711,6 +711,53 @@ class ServiceActions
));
}
/**
* @return string
*/
public function ServiceCardDav()
{
return '';
try
{
\set_error_handler(function ($errno, $errstr, $errfile, $errline ) {
throw new \ErrorException($errstr, 0, $errno, $errfile, $errline);
});
$oPersonalAddressBookProvider = $this->oActions->PersonalAddressBookProvider();
$oAuthBackend = new \RainLoop\SabreDAV\AuthBasic($oPersonalAddressBookProvider);
$oCarddavBackend = new \RainLoop\SabreDAV\CardDAV($oPersonalAddressBookProvider);
$oPrincipalBackend = new \RainLoop\SabreDAV\Principal($oPersonalAddressBookProvider, $oAuthBackend);
$aNodes = array(
new \Sabre\DAVACL\PrincipalCollection($oPrincipalBackend),
new \Sabre\CardDAV\AddressBookRoot($oPrincipalBackend, $oCarddavBackend),
);
$oServer = new \Sabre\DAV\Server($aNodes);
$aPath = \trim($this->oHttp->GetPath(), '/\\ ');
$oServer->setBaseUri((0 < \strlen($aPath) ? '/'.$aPath.'/' : '').'index.php/carddav/');
// Plugins
$oServer->addPlugin(new \Sabre\DAV\Auth\Plugin($oAuthBackend, 'SabreDAV'));
$oServer->addPlugin(new \Sabre\DAV\Browser\Plugin());
$oServer->addPlugin(new \Sabre\CardDAV\Plugin());
$oServer->addPlugin(new \Sabre\DAVACL\Plugin());
$oServer->exec();
}
catch (\Exception $oException)
{
$this->Logger()->WriteException($oException);
}
return '';
}
/**
* @return string
*/