CardDAVBackend.php

<?php

namespace App\Http\Controllers\DAV\Backend\CardDAV;

use Sabre\DAV;
use Illuminate\Support\Arr;
use App\Models\Contact\Contact;
use App\Models\Account\AddressBook;
use App\Services\VCard\ExportVCard;
use App\Services\VCard\ImportVCard;
use Illuminate\Support\Facades\Log;
use Illuminate\Support\Facades\Auth;
use Sabre\DAV\Server as SabreServer;
use Sabre\CardDAV\Backend\SyncSupport;
use Sabre\CalDAV\Plugin as CalDAVPlugin;
use Sabre\CardDAV\Backend\AbstractBackend;
use Sabre\CardDAV\Plugin as CardDAVPlugin;
use Sabre\DAV\Sync\Plugin as DAVSyncPlugin;
use App\Services\Contact\Contact\SetMeContact;
use App\Http\Controllers\DAV\Backend\IDAVBackend;
use App\Http\Controllers\DAV\Backend\SyncDAVBackend;
use App\Http\Controllers\DAV\DAVACL\PrincipalBackend;

class CardDAVBackend extends AbstractBackend implements SyncSupport, IDAVBackend
{
    use SyncDAVBackend;

    /**
     * Returns the uri for this backend.
     *
     * @return string
     */
    public function backendUri()
    {
        return 'contacts';
    }

    /**
     * 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)
    {
        $result = [];
        $result[] = $this->getDefaultAddressBook();

        $addressbooks = AddressBook::where('account_id', Auth::user()->account_id)
            ->get();

        foreach ($addressbooks as $addressbook) {
            $result[] = $this->getAddressBookDetails($addressbook);
        }

        return $result;
    }

    private function getDefaultAddressBook()
    {
        $des = $this->getAddressBookDetails(null);

        $me = auth()->user()->me;
        if ($me) {
            $des += [
                '{'.CalDAVPlugin::NS_CALENDARSERVER.'}me-card' => '/'.config('laravelsabre.path').'/addressbooks/'.Auth::user()->email.'/contacts/'.$this->encodeUri($me),
            ];
        }

        return $des;
    }

    private function getAddressBookDetails($addressbook)
    {
        $id = $addressbook ? $addressbook->name : $this->backendUri();
        $token = $this->getCurrentSyncToken($addressbook);

        $des = [
            'id'                => $id,
            'uri'               => $id,
            'principaluri'      => PrincipalBackend::getPrincipalUser(),
            '{DAV:}displayname' => trans('app.dav_contacts'),
            '{'.CardDAVPlugin::NS_CARDDAV.'}addressbook-description' => $addressbook ? $addressbook->description : trans('app.dav_contacts_description', ['name' => Auth::user()->name]),
        ];
        if ($token) {
            $des += [
                '{DAV:}sync-token'  => $token->id,
                '{'.SabreServer::NS_SABREDAV.'}sync-token' => $token->id,
                '{'.CalDAVPlugin::NS_CALENDARSERVER.'}getctag' => DAVSyncPlugin::SYNCTOKEN_PREFIX.$token->id,
            ];
        }

        return $des;
    }

    /**
     * Extension for Calendar objects.
     *
     * @return string
     */
    public function getExtension()
    {
        return '.vcf';
    }

    /**
     * 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)
    {
        return $this->getChanges($addressBookId, $syncToken);
    }

    /**
     * Prepare datas for this contact.
     *
     * @param Contact $contact
     * @return array
     */
    private function prepareCard($contact): array
    {
        try {
            $carddata = $contact->vcard;
            if (empty($carddata)) {
                $vcard = app(ExportVCard::class)
                    ->execute([
                        'account_id' => Auth::user()->account_id,
                        'contact_id' => $contact->id,
                    ]);

                $carddata = $vcard->serialize();
            }

            return [
                'id' => $contact->hashID(),
                'uri' => $this->encodeUri($contact),
                'carddata' => $carddata,
                'etag' => '"'.md5($carddata).'"',
                'lastmodified' => $contact->updated_at->timestamp,
            ];
        } catch (\Exception $e) {
            Log::debug(__CLASS__.' prepareCard: '.(string) $e);
            throw $e;
        }
    }

    /**
     * Returns the contact for the specific uuid.
     *
     * @param mixed|null $collectionId
     * @param string  $uuid
     * @return Contact
     */
    public function getObjectUuid($collectionId, $uuid)
    {
        $addressBook = null;
        if ($collectionId && $collectionId != $this->backendUri()) {
            $addressBook = AddressBook::where([
                'account_id' => Auth::user()->account_id,
                'name' => $collectionId,
            ])->first();
        }

        return Contact::where([
            'account_id' => Auth::user()->account_id,
            'uuid' => $uuid,
            'address_book_id' => $addressBook ? $addressBook->id : null,
        ])->first();
    }

    /**
     * Returns the collection of all active contacts.
     *
     * @return \Illuminate\Support\Collection
     */
    public function getObjects($addressBookId)
    {
        return Auth::user()->account->contacts($addressBookId)
                    ->active()
                    ->get();
    }

    /**
     * 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 $collectionId
     * @return array
     */
    public function getCards($collectionId)
    {
        $contacts = $this->getObjects($collectionId);

        return $contacts->map(function ($contact) {
            return $this->prepareCard($contact);
        })->toArray();
    }

    /**
     * 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|bool
     */
    public function getCard($addressBookId, $cardUri)
    {
        $contact = $this->getObject($addressBookId, $cardUri);

        if ($contact) {
            return $this->prepareCard($contact);
        }

        return 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 $addressBookId
     * @param string $cardUri
     * @param string $cardData
     * @return string|null
     */
    public function createCard($addressBookId, $cardUri, $cardData)
    {
        return $this->updateCard($addressBookId, $cardUri, $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): ?string
    {
        $contact_id = null;
        if ($cardUri) {
            $contact = $this->getObject($addressBookId, $cardUri);

            if ($contact) {
                $contact_id = $contact->id;
            }
        }

        try {
            $result = app(ImportVCard::class)
                ->execute([
                    'account_id' => Auth::user()->account_id,
                    'user_id' => Auth::user()->id,
                    'contact_id' => $contact_id,
                    'entry' => $cardData,
                    'behaviour' => ImportVCard::BEHAVIOUR_REPLACE,
                    'addressBookName' => $addressBookId == $this->backendUri() ? null : $addressBookId,
                ]);

            if (! Arr::has($result, 'error')) {
                $contact = Contact::where('account_id', Auth::user()->account_id)
                    ->find($result['contact_id']);
                $card = $this->prepareCard($contact);

                return $card['etag'];
            }
        } catch (\Exception $e) {
            Log::debug(__CLASS__.' updateCard: '.(string) $e);
            throw $e;
        }

        return null;
    }

    /**
     * Deletes a card.
     *
     * @param mixed $addressBookId
     * @param string $cardUri
     * @return bool
     */
    public function deleteCard($addressBookId, $cardUri)
    {
        return false;
    }

    /**
     * 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 bool|null
     */
    public function updateAddressBook($addressBookId, DAV\PropPatch $propPatch): ?bool
    {
        $propPatch->handle('{'.CalDAVPlugin::NS_CALENDARSERVER.'}me-card', function ($props) use ($addressBookId) {
            $contact = $this->getObject($addressBookId, $props->getHref());

            $data = [
                'contact_id' => $contact->id,
                'account_id' => auth()->user()->account_id,
                'user_id' => auth()->user()->id,
            ];

            app(SetMeContact::class)->execute($data);

            return true;
        });

        return null;
    }

    /**
     * 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.
     * @param array $properties
     * @return int|bool
     */
    public function createAddressBook($principalUri, $url, array $properties)
    {
        return false;
    }

    /**
     * Deletes an entire addressbook and all its contents.
     *
     * @param mixed $addressBookId
     * @return bool|null
     */
    public function deleteAddressBook($addressBookId)
    {
        return false;
    }
}