Sabre\CardDAV\Plugin Class Reference

CardDAV plugin. More...

Inheritance diagram for Sabre\CardDAV\Plugin:

Collaboration diagram for Sabre\CardDAV\Plugin:

Public Member Functions
	initialize (DAV\Server $server)
	Initializes the plugin. More...
	getFeatures ()
	Returns a list of supported features. More...
	getSupportedReportSet ($uri)
	Returns a list of reports this plugin supports. More...
	propFindEarly (DAV\PropFind $propFind, DAV\INode $node)
	Adds all CardDAV-specific properties. More...
	report ($reportName, $dom, $path)
	This functions handles REPORT requests specific to CardDAV. More...
	addressbookMultiGetReport ($report)
	This function handles the addressbook-multiget REPORT. More...
	beforeWriteContent ($path, DAV\IFile $node, &$data, &$modified)
	This method is triggered before a file gets updated with new content. More...
	beforeCreateFile ($path, &$data, DAV\ICollection $parentNode, &$modified)
	This method is triggered before a new file is created. More...
	validateFilters ($vcardData, array $filters, $test)
	Validates if a vcard makes it throught a list of filters. More...
	propFindLate (DAV\PropFind $propFind, DAV\INode $node)
	This event is triggered when fetching properties. More...
	htmlActionsPanel (DAV\INode $node, &$output)
	This method is used to generate HTML output for the Sabre. More...
	httpAfterGet (RequestInterface $request, ResponseInterface $response)
	This event is triggered after GET requests. More...
	getPluginName ()
	Returns a plugin name. More...
	getPluginInfo ()
	Returns a bunch of meta-data about the plugin. More...
Public Member Functions inherited from Sabre\DAV\ServerPlugin
	initialize (Server $server)
	This initializes the plugin. More...
	getFeatures ()
	This method should return a list of server-features. More...
	getHTTPMethods ($path)
	Use this method to tell the server this plugin defines additional HTTP methods. More...
	getPluginName ()
	Returns a plugin name. More...
	getSupportedReportSet ($uri)
	Returns a list of reports this plugin supports. More...
	getPluginInfo ()
	Returns a bunch of meta-data about the plugin. More...

Data Fields
const	ADDRESSBOOK_ROOT = 'addressbooks'
	Url to the addressbooks. More...
const	NS_CARDDAV = 'urn:ietf:params:xml:ns:carddav'
	xml namespace for CardDAV elements More...
	$directories = []

Protected Member Functions
	getAddressbookHomeForPrincipal ($principal)
	Returns the addressbook home for a given principal. More...
	validateVCard (&$data, &$modified)
	Checks if the submitted iCalendar data is in fact, valid. More...
	addressbookQueryReport ($report)
	This function handles the addressbook-query REPORT. More...
	validateParamFilters (array $vProperties, array $filters, $test)
	Validates if a param-filter can be applied to a specific property. More...
	validateTextMatches (array $texts, array $filters, $test)
	Validates if a text-filter can be applied to a specific property. More...
	negotiateVCard ($input, &$mimeType=null)
	This helper function performs the content-type negotiation for vcards. More...
	convertVCard ($data, $target, array $propertiesFilter=null)
	Converts a vcard blob to a different version, or jcard. More...

Protected Attributes
	$server
	$maxResourceSize = 10000000
	The default PDO storage uses a MySQL MEDIUMBLOB for iCalendar data, which can hold up to 2^24 = 16777216 bytes. More...

Detailed Description

CardDAV plugin.

The CardDAV plugin adds CardDAV functionality to the WebDAV server

Copyright

Copyright (C) fruux GmbH (https://fruux.com/)

Author

Evert Pot (http://evertpot.com/) http://sabre.io/license/ Modified BSD License

Definition at line 23 of file Plugin.php.

Member Function Documentation

addressbookMultiGetReport()

Sabre\CardDAV\Plugin::addressbookMultiGetReport

(

$report

)

This function handles the addressbook-multiget REPORT.

This report is used by the client to fetch the content of a series of urls. Effectively avoiding a lot of redundant requests.

Parameters

Xml\Request\AddressBookMultiGetReport

$report

Returns

void

Definition at line 236 of file Plugin.php.

References $contentType, $paths, $version, Sabre\CardDAV\Plugin\convertVCard(), and Sabre\CardDAV\Plugin\negotiateVCard().

Referenced by Sabre\CardDAV\Plugin\report().

                                                {

        $contentType = $report->contentType;
        $version = $report->version;
        if ($version) {
            $contentType .= '; version=' . $version;
        }

        $vcardType = $this->negotiateVCard(
            $contentType
        );

        $propertyList = [];
        $paths = array_map(
            [$this->server, 'calculateUri'],
            $report->hrefs
        );
        foreach ($this->server->getPropertiesForMultiplePaths($paths, $report->properties) as $props) {

            if (isset($props['200']['{' . self::NS_CARDDAV . '}address-data'])) {

                $props['200']['{' . self::NS_CARDDAV . '}address-data'] = $this->convertVCard(
                    $props[200]['{' . self::NS_CARDDAV . '}address-data'],
                    $vcardType
                );

            }
            $propertyList[] = $props;

        }

        $prefer = $this->server->getHTTPPrefer();

        $this->server->httpResponse->setStatus(207);
        $this->server->httpResponse->setHeader('Content-Type', 'application/xml; charset=utf-8');
        $this->server->httpResponse->setHeader('Vary', 'Brief,Prefer');
        $this->server->httpResponse->setBody($this->server->generateMultiStatus($propertyList, $prefer['return'] === 'minimal'));

    }

Here is the call graph for this function:

Here is the caller graph for this function:

addressbookQueryReport()

Sabre\CardDAV\Plugin::addressbookQueryReport (   $report )

protected

This function handles the addressbook-query REPORT.

This report is used by the client to filter an addressbook based on a complex query.

Parameters

Xml\Request\AddressBookQueryReport

$report

Returns

void

Definition at line 430 of file Plugin.php.

References $contentType, $result, Sabre\CardDAV\Plugin\convertVCard(), Sabre\CardDAV\Plugin\negotiateVCard(), and Sabre\CardDAV\Plugin\validateFilters().

                                                       {

        $depth = $this->server->getHTTPDepth(0);

        if ($depth == 0) {
            $candidateNodes = [
                $this->server->tree->getNodeForPath($this->server->getRequestUri())
            ];
            if (!$candidateNodes[0] instanceof ICard) {
                throw new ReportNotSupported('The addressbook-query report is not supported on this url with Depth: 0');
            }
        } else {
            $candidateNodes = $this->server->tree->getChildren($this->server->getRequestUri());
        }

        $contentType = $report->contentType;
        if ($report->version) {
            $contentType .= '; version=' . $report->version;
        }

        $vcardType = $this->negotiateVCard(
            $contentType
        );

        $validNodes = [];
        foreach ($candidateNodes as $node) {

            if (!$node instanceof ICard)
                continue;

            $blob = $node->get();
            if (is_resource($blob)) {
                $blob = stream_get_contents($blob);
            }

            if (!$this->validateFilters($blob, $report->filters, $report->test)) {
                continue;
            }

            $validNodes[] = $node;

            if ($report->limit && $report->limit <= count($validNodes)) {
                // We hit the maximum number of items, we can stop now.
                break;
            }

        }

        $result = [];
        foreach ($validNodes as $validNode) {

            if ($depth == 0) {
                $href = $this->server->getRequestUri();
            } else {
                $href = $this->server->getRequestUri() . '/' . $validNode->getName();
            }

            list($props) = $this->server->getPropertiesForPath($href, $report->properties, 0);

            if (isset($props[200]['{' . self::NS_CARDDAV . '}address-data'])) {

                $props[200]['{' . self::NS_CARDDAV . '}address-data'] = $this->convertVCard(
                    $props[200]['{' . self::NS_CARDDAV . '}address-data'],
                    $vcardType,
                    $report->addressDataProperties
                );

            }
            $result[] = $props;

        }

        $prefer = $this->server->getHTTPPrefer();

        $this->server->httpResponse->setStatus(207);
        $this->server->httpResponse->setHeader('Content-Type', 'application/xml; charset=utf-8');
        $this->server->httpResponse->setHeader('Vary', 'Brief,Prefer');
        $this->server->httpResponse->setBody($this->server->generateMultiStatus($result, $prefer['return'] === 'minimal'));

    }

Here is the call graph for this function:

beforeCreateFile()

Sabre\CardDAV\Plugin::beforeCreateFile	(		$path,
		&	$data,
		DAV\ICollection	$parentNode,
		&	$modified
	)

This method is triggered before a new file is created.

This plugin uses this method to ensure that Card nodes receive valid vcard data.

Parameters

string	$path
resource	$data
DAV\ICollection	$parentNode
bool	$modified	Should be set to true, if this event handler changed &$data.

Returns

void

Definition at line 311 of file Plugin.php.

References $data, and Sabre\CardDAV\Plugin\validateVCard().

                                                                                      {

        if (!$parentNode instanceof IAddressBook)
            return;

        $this->validateVCard($data, $modified);

    }

Here is the call graph for this function:

beforeWriteContent()

Sabre\CardDAV\Plugin::beforeWriteContent	(		$path,
		DAV\IFile	$node,
		&	$data,
		&	$modified
	)

This method is triggered before a file gets updated with new content.

This plugin uses this method to ensure that Card nodes receive valid vcard data.

Parameters

string	$path
DAV\IFile	$node
resource	$data
bool	$modified	Should be set to true, if this event handler changed &$data.

Returns

void

Definition at line 289 of file Plugin.php.

References $data, and Sabre\CardDAV\Plugin\validateVCard().

                                                                            {

        if (!$node instanceof ICard)
            return;

        $this->validateVCard($data, $modified);

    }

Here is the call graph for this function:

convertVCard()

Sabre\CardDAV\Plugin::convertVCard (   $data,   $target, array  $propertiesFilter = null  )

protected

Converts a vcard blob to a different version, or jcard.

Parameters

string | resource	$data
string	$target
array	$propertiesFilter

Returns

string

Definition at line 852 of file Plugin.php.

References $data, $input, $key, $keys, Sabre\VObject\$output, $target, Sabre\VObject\Reader\read(), Sabre\VObject\Document\VCARD30, and Sabre\VObject\Document\VCARD40.

Referenced by Sabre\CardDAV\Plugin\addressbookMultiGetReport(), Sabre\CardDAV\Plugin\addressbookQueryReport(), and Sabre\CardDAV\Plugin\httpAfterGet().

                                                                                    {

        if (is_resource($data)) {
            $data = stream_get_contents($data);
        }
        $input = VObject\Reader::read($data);
        if (!empty($propertiesFilter)) {
            $propertiesFilter = array_merge(['UID', 'VERSION', 'FN'], $propertiesFilter);
            $keys = array_unique(array_map(function($child) {
                return $child->name;
            }, $input->children()));
            $keys = array_diff($keys, $propertiesFilter);
            foreach ($keys as $key) {
                unset($input->$key);
            }
            $data = $input->serialize();
        }
        $output = null;
        try {

            switch ($target) {
                default :
                case 'vcard3' :
                    if ($input->getDocumentType() === VObject\Document::VCARD30) {
                        // Do nothing
                        return $data;
                    }
                    $output = $input->convert(VObject\Document::VCARD30);
                    return $output->serialize();
                case 'vcard4' :
                    if ($input->getDocumentType() === VObject\Document::VCARD40) {
                        // Do nothing
                        return $data;
                    }
                    $output = $input->convert(VObject\Document::VCARD40);
                    return $output->serialize();
                case 'jcard' :
                    $output = $input->convert(VObject\Document::VCARD40);
                    return json_encode($output);

            }

        } finally {

            // Destroy circular references to PHP will GC the object.
            $input->destroy();
            if (!is_null($output)) {
                $output->destroy();
            }
        }

    }

Here is the call graph for this function:

Here is the caller graph for this function:

getAddressbookHomeForPrincipal()

Sabre\CardDAV\Plugin::getAddressbookHomeForPrincipal (   $principal )

protected

Returns the addressbook home for a given principal.

Parameters

string

$principal

Returns

string

Definition at line 219 of file Plugin.php.

References Sabre\HTTP\URLUtil\splitPath().

                                                                  {

        list(, $principalId) = \Sabre\HTTP\URLUtil::splitPath($principal);
        return self::ADDRESSBOOK_ROOT . '/' . $principalId;

    }

Here is the call graph for this function:

getFeatures()

Sabre\CardDAV\Plugin::getFeatures

(

)

Returns a list of supported features.

This is used in the DAV: header in the OPTIONS and PROPFIND requests.

Returns

array

Definition at line 102 of file Plugin.php.

                           {

        return ['addressbook'];

    }

getPluginInfo()

Sabre\CardDAV\Plugin::getPluginInfo

(

)

Returns a bunch of meta-data about the plugin.

Providing this information is optional, and is mainly displayed by the Browser plugin.

The description key in the returned array may contain html and will not be sanitized.

Returns

array

Definition at line 930 of file Plugin.php.

References Sabre\CardDAV\Plugin\getPluginName().

                             {

        return [
            'name'        => $this->getPluginName(),
            'description' => 'Adds support for CardDAV (rfc6352)',
            'link'        => 'http://sabre.io/dav/carddav/',
        ];

    }

Here is the call graph for this function:

getPluginName()

Sabre\CardDAV\Plugin::getPluginName

(

)

Returns a plugin name.

Using this name other plugins will be able to access other plugins using DAV::getPlugin

Returns

string

Definition at line 913 of file Plugin.php.

Referenced by Sabre\CardDAV\Plugin\getPluginInfo().

                             {

        return 'carddav';

    }

Here is the caller graph for this function:

getSupportedReportSet()

Sabre\CardDAV\Plugin::getSupportedReportSet

(

$uri

)

Returns a list of reports this plugin supports.

This will be used in the {DAV:}supported-report-set property. Note that you still need to subscribe to the 'report' event to actually implement them

Parameters

string

$uri

Returns

array

Definition at line 118 of file Plugin.php.

                                         {

        $node = $this->server->tree->getNodeForPath($uri);
        if ($node instanceof IAddressBook || $node instanceof ICard) {
            return [
                 '{' . self::NS_CARDDAV . '}addressbook-multiget',
                 '{' . self::NS_CARDDAV . '}addressbook-query',
            ];
        }
        return [];

    }

htmlActionsPanel()

Sabre\CardDAV\Plugin::htmlActionsPanel	(	DAV\INode	$node,
		&	$output
	)

This method is used to generate HTML output for the Sabre.

This allows us to generate an interface users can use to create new addressbooks.

Parameters

DAV\INode	$node
string	$output

Returns

bool

Definition at line 744 of file Plugin.php.

References Sabre\VObject\$output.

                                                         {

        if (!$node instanceof AddressBookHome)
            return;

        $output .= '<tr><td colspan="2"><form method="post" action="">
            <h3>Create new address book</h3>
            <input type="hidden" name="sabreAction" value="mkcol" />
            <input type="hidden" name="resourceType" value="{DAV:}collection,{' . self::NS_CARDDAV . '}addressbook" />
            <label>Name (uri):</label> <input type="text" name="name" /><br />
            <label>Display name:</label> <input type="text" name="{DAV:}displayname" /><br />
            <input type="submit" value="create" />
            </form>
            </td></tr>';

        return false;

    }

httpAfterGet()

Sabre\CardDAV\Plugin::httpAfterGet	(	RequestInterface	$request,
		ResponseInterface	$response
	)

This event is triggered after GET requests.

This is used to transform data into jCal, if this was requested.

Parameters

RequestInterface	$request
ResponseInterface	$response

Returns

void

Definition at line 772 of file Plugin.php.

References $target, Sabre\CardDAV\Plugin\convertVCard(), Sabre\HTTP\MessageInterface\getBody(), Sabre\HTTP\MessageInterface\getHeader(), Sabre\CardDAV\Plugin\negotiateVCard(), Sabre\HTTP\MessageInterface\setBody(), and Sabre\HTTP\MessageInterface\setHeader().

                                                                                  {

        if (strpos($response->getHeader('Content-Type'), 'text/vcard') === false) {
            return;
        }

        $target = $this->negotiateVCard($request->getHeader('Accept'), $mimeType);

        $newBody = $this->convertVCard(
            $response->getBody(),
            $target
        );

        $response->setBody($newBody);
        $response->setHeader('Content-Type', $mimeType . '; charset=utf-8');
        $response->setHeader('Content-Length', strlen($newBody));

    }

Here is the call graph for this function:

initialize()

Sabre\CardDAV\Plugin::initialize

(

DAV\Server

$server

)

Initializes the plugin.

Parameters

DAV\Server

$server

Returns

void

Definition at line 63 of file Plugin.php.

References Sabre\CardDAV\Plugin\$server.

                                            {

        /* Events */
        $server->on('propFind',            [$this, 'propFindEarly']);
        $server->on('propFind',            [$this, 'propFindLate'], 150);
        $server->on('report',              [$this, 'report']);
        $server->on('onHTMLActionsPanel',  [$this, 'htmlActionsPanel']);
        $server->on('beforeWriteContent',  [$this, 'beforeWriteContent']);
        $server->on('beforeCreateFile',    [$this, 'beforeCreateFile']);
        $server->on('afterMethod:GET',     [$this, 'httpAfterGet']);

        $server->xml->namespaceMap[self::NS_CARDDAV] = 'card';

        $server->xml->elementMap['{' . self::NS_CARDDAV . '}addressbook-query'] = 'Sabre\\CardDAV\\Xml\\Request\\AddressBookQueryReport';
        $server->xml->elementMap['{' . self::NS_CARDDAV . '}addressbook-multiget'] = 'Sabre\\CardDAV\\Xml\\Request\\AddressBookMultiGetReport';

        /* Mapping Interfaces to {DAV:}resourcetype values */
        $server->resourceTypeMapping['Sabre\\CardDAV\\IAddressBook'] = '{' . self::NS_CARDDAV . '}addressbook';
        $server->resourceTypeMapping['Sabre\\CardDAV\\IDirectory'] = '{' . self::NS_CARDDAV . '}directory';

        /* Adding properties that may never be changed */
        $server->protectedProperties[] = '{' . self::NS_CARDDAV . '}supported-address-data';
        $server->protectedProperties[] = '{' . self::NS_CARDDAV . '}max-resource-size';
        $server->protectedProperties[] = '{' . self::NS_CARDDAV . '}addressbook-home-set';
        $server->protectedProperties[] = '{' . self::NS_CARDDAV . '}supported-collation-set';

        $server->xml->elementMap['{http://calendarserver.org/ns/}me-card'] = 'Sabre\\DAV\\Xml\\Property\\Href';

        $this->server = $server;

    }

negotiateVCard()

Sabre\CardDAV\Plugin::negotiateVCard (   $input, &  $mimeType = null  )

protected

This helper function performs the content-type negotiation for vcards.

It will return one of the following strings:

1. vcard3
2. vcard4
3. jcard

It defaults to vcard3.

Parameters

string	$input
string	$mimeType

Returns

string

Definition at line 805 of file Plugin.php.

References $input, $result, and Sabre\HTTP\Util\negotiate().

Referenced by Sabre\CardDAV\Plugin\addressbookMultiGetReport(), Sabre\CardDAV\Plugin\addressbookQueryReport(), and Sabre\CardDAV\Plugin\httpAfterGet().

                                                                 {

        $result = HTTP\Util::negotiate(
            $input,
            [
                // Most often used mime-type. Version 3
                'text/x-vcard',
                // The correct standard mime-type. Defaults to version 3 as
                // well.
                'text/vcard',
                // vCard 4
                'text/vcard; version=4.0',
                // vCard 3
                'text/vcard; version=3.0',
                // jCard
                'application/vcard+json',
            ]
        );

        $mimeType = $result;
        switch ($result) {

            default :
            case 'text/x-vcard' :
            case 'text/vcard' :
            case 'text/vcard; version=3.0' :
                $mimeType = 'text/vcard';
                return 'vcard3';
            case 'text/vcard; version=4.0' :
                return 'vcard4';
            case 'application/vcard+json' :
                return 'jcard';

        // @codeCoverageIgnoreStart
        }
        // @codeCoverageIgnoreEnd

    }

Here is the call graph for this function:

Here is the caller graph for this function:

propFindEarly()

Sabre\CardDAV\Plugin::propFindEarly	(	DAV\PropFind	$propFind,
		DAV\INode	$node
	)

Adds all CardDAV-specific properties.

Parameters

DAV\PropFind	$propFind
DAV\INode	$node

Returns

void

Definition at line 139 of file Plugin.php.

References $path.

                                                                    {

        $ns = '{' . self::NS_CARDDAV . '}';

        if ($node instanceof IAddressBook) {

            $propFind->handle($ns . 'max-resource-size', $this->maxResourceSize);
            $propFind->handle($ns . 'supported-address-data', function() {
                return new Xml\Property\SupportedAddressData();
            });
            $propFind->handle($ns . 'supported-collation-set', function() {
                return new Xml\Property\SupportedCollationSet();
            });

        }
        if ($node instanceof DAVACL\IPrincipal) {

            $path = $propFind->getPath();

            $propFind->handle('{' . self::NS_CARDDAV . '}addressbook-home-set', function() use ($path) {
                return new LocalHref($this->getAddressBookHomeForPrincipal($path) . '/');
            });

            if ($this->directories) $propFind->handle('{' . self::NS_CARDDAV . '}directory-gateway', function() {
                return new LocalHref($this->directories);
            });

        }

        if ($node instanceof ICard) {

            // The address-data property is not supposed to be a 'real'
            // property, but in large chunks of the spec it does act as such.
            // Therefore we simply expose it as a property.
            $propFind->handle('{' . self::NS_CARDDAV . '}address-data', function() use ($node) {
                $val = $node->get();
                if (is_resource($val))
                    $val = stream_get_contents($val);

                return $val;

            });

        }

    }

propFindLate()

Sabre\CardDAV\Plugin::propFindLate	(	DAV\PropFind	$propFind,
		DAV\INode	$node
	)

This event is triggered when fetching properties.

This event is scheduled late in the process, after most work for propfind has been done.

Parameters

DAV\PropFind	$propFind
DAV\INode	$node

Returns

void

Definition at line 718 of file Plugin.php.

References $contentType.

                                                                   {

        // If the request was made using the SOGO connector, we must rewrite
        // the content-type property. By default SabreDAV will send back
        // text/x-vcard; charset=utf-8, but for SOGO we must strip that last
        // part.
        if (strpos($this->server->httpRequest->getHeader('User-Agent'), 'Thunderbird') === false) {
            return;
        }
        $contentType = $propFind->get('{DAV:}getcontenttype');
        list($part) = explode(';', $contentType);
        if ($part === 'text/x-vcard' || $part === 'text/vcard') {
            $propFind->set('{DAV:}getcontenttype', 'text/x-vcard');
        }

    }

report()

Sabre\CardDAV\Plugin::report	(		$reportName,
			$dom,
			$path
	)

This functions handles REPORT requests specific to CardDAV.

Parameters

string	$reportName
\DOMNode	$dom
mixed	$path

Returns

bool

Definition at line 194 of file Plugin.php.

References Sabre\CardDAV\Plugin\addressbookMultiGetReport().

                                              {

        switch ($reportName) {
            case '{' . self::NS_CARDDAV . '}addressbook-multiget' :
                $this->server->transactionType = 'report-addressbook-multiget';
                $this->addressbookMultiGetReport($dom);
                return false;
            case '{' . self::NS_CARDDAV . '}addressbook-query' :
                $this->server->transactionType = 'report-addressbook-query';
                $this->addressBookQueryReport($dom);
                return false;
            default :
                return;

        }


    }

Here is the call graph for this function:

validateFilters()

Sabre\CardDAV\Plugin::validateFilters	(		$vcardData,
		array	$filters,
			$test
	)

Validates if a vcard makes it throught a list of filters.

Parameters

string	$vcardData
array	$filters
string	$test	anyof or allof (which means OR or AND)

Returns

bool

Definition at line 519 of file Plugin.php.

References $results, $success, $test, Sabre\VObject\Reader\read(), Sabre\CardDAV\Plugin\validateParamFilters(), and Sabre\CardDAV\Plugin\validateTextMatches().

Referenced by Sabre\CardDAV\Plugin\addressbookQueryReport().

                                                                {


        if (!$filters) return true;
        $vcard = VObject\Reader::read($vcardData);

        foreach ($filters as $filter) {

            $isDefined = isset($vcard->{$filter['name']});
            if ($filter['is-not-defined']) {
                if ($isDefined) {
                    $success = false;
                } else {
                    $success = true;
                }
            } elseif ((!$filter['param-filters'] && !$filter['text-matches']) || !$isDefined) {

                // We only need to check for existence
                $success = $isDefined;

            } else {

                $vProperties = $vcard->select($filter['name']);

                $results = [];
                if ($filter['param-filters']) {
                    $results[] = $this->validateParamFilters($vProperties, $filter['param-filters'], $filter['test']);
                }
                if ($filter['text-matches']) {
                    $texts = [];
                    foreach ($vProperties as $vProperty)
                        $texts[] = $vProperty->getValue();

                    $results[] = $this->validateTextMatches($texts, $filter['text-matches'], $filter['test']);
                }

                if (count($results) === 1) {
                    $success = $results[0];
                } else {
                    if ($filter['test'] === 'anyof') {
                        $success = $results[0] || $results[1];
                    } else {
                        $success = $results[0] && $results[1];
                    }
                }

            } // else

            // There are two conditions where we can already determine whether
            // or not this filter succeeds.
            if ($test === 'anyof' && $success) {

                // Destroy circular references to PHP will GC the object.
                $vcard->destroy();

                return true;
            }
            if ($test === 'allof' && !$success) {

                // Destroy circular references to PHP will GC the object.
                $vcard->destroy();

                return false;
            }

        } // foreach


        // Destroy circular references to PHP will GC the object.
        $vcard->destroy();

        // If we got all the way here, it means we haven't been able to
        // determine early if the test failed or not.
        //
        // This implies for 'anyof' that the test failed, and for 'allof' that
        // we succeeded. Sounds weird, but makes sense.
        return $test === 'allof';

    }

Here is the call graph for this function:

Here is the caller graph for this function:

validateParamFilters()

Sabre\CardDAV\Plugin::validateParamFilters ( array  $vProperties, array  $filters,   $test  )

protected

Validates if a param-filter can be applied to a specific property.

Todo:

currently we're only validating the first parameter of the passed property. Any subsequence parameters with the same name are ignored.

Parameters

array	$vProperties
array	$filters
string	$test

Returns

bool

Definition at line 610 of file Plugin.php.

References $success, $test, and Sabre\DAV\StringUtil\textMatch().

Referenced by Sabre\CardDAV\Plugin\validateFilters().

                                                                                       {

        foreach ($filters as $filter) {

            $isDefined = false;
            foreach ($vProperties as $vProperty) {
                $isDefined = isset($vProperty[$filter['name']]);
                if ($isDefined) break;
            }

            if ($filter['is-not-defined']) {
                if ($isDefined) {
                    $success = false;
                } else {
                    $success = true;
                }

            // If there's no text-match, we can just check for existence
            } elseif (!$filter['text-match'] || !$isDefined) {

                $success = $isDefined;

            } else {

                $success = false;
                foreach ($vProperties as $vProperty) {
                    // If we got all the way here, we'll need to validate the
                    // text-match filter.
                    $success = DAV\StringUtil::textMatch($vProperty[$filter['name']]->getValue(), $filter['text-match']['value'], $filter['text-match']['collation'], $filter['text-match']['match-type']);
                    if ($success) break;
                }
                if ($filter['text-match']['negate-condition']) {
                    $success = !$success;
                }

            } // else

            // There are two conditions where we can already determine whether
            // or not this filter succeeds.
            if ($test === 'anyof' && $success) {
                return true;
            }
            if ($test === 'allof' && !$success) {
                return false;
            }

        }

        // If we got all the way here, it means we haven't been able to
        // determine early if the test failed or not.
        //
        // This implies for 'anyof' that the test failed, and for 'allof' that
        // we succeeded. Sounds weird, but makes sense.
        return $test === 'allof';

    }

Here is the call graph for this function:

Here is the caller graph for this function:

validateTextMatches()

Sabre\CardDAV\Plugin::validateTextMatches ( array  $texts, array  $filters,   $test  )

protected

Validates if a text-filter can be applied to a specific property.

Parameters

array	$texts
array	$filters
string	$test

Returns

bool

Definition at line 675 of file Plugin.php.

References $success, $test, and Sabre\DAV\StringUtil\textMatch().

Referenced by Sabre\CardDAV\Plugin\validateFilters().

                                                                                {

        foreach ($filters as $filter) {

            $success = false;
            foreach ($texts as $haystack) {
                $success = DAV\StringUtil::textMatch($haystack, $filter['value'], $filter['collation'], $filter['match-type']);

                // Breaking on the first match
                if ($success) break;
            }
            if ($filter['negate-condition']) {
                $success = !$success;
            }

            if ($success && $test === 'anyof')
                return true;

            if (!$success && $test == 'allof')
                return false;


        }

        // If we got all the way here, it means we haven't been able to
        // determine early if the test failed or not.
        //
        // This implies for 'anyof' that the test failed, and for 'allof' that
        // we succeeded. Sounds weird, but makes sense.
        return $test === 'allof';

    }

Here is the call graph for this function:

Here is the caller graph for this function:

validateVCard()

Sabre\CardDAV\Plugin::validateVCard ( &  $data, &  $modified  )

protected

Checks if the submitted iCalendar data is in fact, valid.

An exception is thrown if it's not.

Parameters

resource | string	$data
bool	$modified	Should be set to true, if this event handler changed &$data.

Returns

void

Definition at line 330 of file Plugin.php.

References $data, $message, $messages, PHPMailer\PHPMailer\$options, $vobj, Sabre\VObject\Node\PROFILE_CARDDAV, Sabre\VObject\Reader\read(), Sabre\VObject\Reader\readJson(), and Sabre\VObject\Node\REPAIR.

Referenced by Sabre\CardDAV\Plugin\beforeCreateFile(), and Sabre\CardDAV\Plugin\beforeWriteContent().

                                                         {

        // If it's a stream, we convert it to a string first.
        if (is_resource($data)) {
            $data = stream_get_contents($data);
        }

        $before = $data;

        try {

            // If the data starts with a [, we can reasonably assume we're dealing
            // with a jCal object.
            if (substr($data, 0, 1) === '[') {
                $vobj = VObject\Reader::readJson($data);

                // Converting $data back to iCalendar, as that's what we
                // technically support everywhere.
                $data = $vobj->serialize();
                $modified = true;
            } else {
                $vobj = VObject\Reader::read($data);
            }

        } catch (VObject\ParseException $e) {

            throw new DAV\Exception\UnsupportedMediaType('This resource only supports valid vCard or jCard data. Parse error: ' . $e->getMessage());

        }

        if ($vobj->name !== 'VCARD') {
            throw new DAV\Exception\UnsupportedMediaType('This collection can only support vcard objects.');
        }

        $options = VObject\Node::PROFILE_CARDDAV;
        $prefer = $this->server->getHTTPPrefer();

        if ($prefer['handling'] !== 'strict') {
            $options |= VObject\Node::REPAIR;
        }

        $messages = $vobj->validate($options);

        $highestLevel = 0;
        $warningMessage = null;

        // $messages contains a list of problems with the vcard, along with
        // their severity.
        foreach ($messages as $message) {

            if ($message['level'] > $highestLevel) {
                // Recording the highest reported error level.
                $highestLevel = $message['level'];
                $warningMessage = $message['message'];
            }

            switch ($message['level']) {

                case 1 :
                    // Level 1 means that there was a problem, but it was repaired.
                    $modified = true;
                    break;
                case 2 :
                    // Level 2 means a warning, but not critical
                    break;
                case 3 :
                    // Level 3 means a critical error
                    throw new DAV\Exception\UnsupportedMediaType('Validation error in vCard: ' . $message['message']);

            }

        }
        if ($warningMessage) {
            $this->server->httpResponse->setHeader(
                'X-Sabre-Ew-Gross',
                'vCard validation warning: ' . $warningMessage
            );

            // Re-serializing object.
            $data = $vobj->serialize();
            if (!$modified && strcmp($data, $before) !== 0) {
                // This ensures that the system does not send an ETag back.
                $modified = true;
            }
        }

        // Destroy circular references to PHP will GC the object.
        $vobj->destroy();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$directories

Sabre\CardDAV\Plugin::$directories = []

Definition at line 41 of file Plugin.php.

$maxResourceSize

Sabre\CardDAV\Plugin::$maxResourceSize = 10000000

protected

The default PDO storage uses a MySQL MEDIUMBLOB for iCalendar data, which can hold up to 2^24 = 16777216 bytes.

This is plenty. We're capping it to 10M here.

Definition at line 55 of file Plugin.php.

$server

Sabre\CardDAV\Plugin::$server

protected

Definition at line 48 of file Plugin.php.

Referenced by Sabre\CardDAV\Plugin\initialize().

ADDRESSBOOK_ROOT

const Sabre\CardDAV\Plugin::ADDRESSBOOK_ROOT = 'addressbooks'

Url to the addressbooks.

Definition at line 28 of file Plugin.php.

Referenced by Sabre\CardDAV\AddressBookRoot\getName().

NS_CARDDAV

const Sabre\CardDAV\Plugin::NS_CARDDAV = 'urn:ietf:params:xml:ns:carddav'

xml namespace for CardDAV elements

Definition at line 33 of file Plugin.php.

Referenced by Sabre\CardDAV\Backend\PDO\createAddressBook(), Sabre\CardDAV\VCFExportPlugin\generateVCF(), Sabre\CardDAV\Backend\PDO\getAddressBooksForUser(), Sabre\CardDAV\VCFExportPlugin\httpGet(), Sabre\CardDAV\PluginTest\testAddressBookHomeSet(), Sabre\CardDAV\PluginTest\testAddressbookPluginProperties(), Sabre\CardDAV\PluginTest\testConstruct(), Sabre\CardDAV\Backend\AbstractPDOTest\testCreateAddressBookSuccess(), Sabre\CardDAV\AddressBookHomeTest\testCreateExtendedCollection(), Sabre\CardDAV\PluginTest\testDirectoryGateway(), Sabre\CardDAV\Backend\AbstractPDOTest\testGetAddressBooksForUser(), Sabre\CardDAV\IDirectoryTest\testResourceType(), Sabre\CardDAV\Xml\Property\SupportedCollationSetTest\testSerialize(), Sabre\CardDAV\Xml\Property\SupportedAddressDataTest\testSerialize(), Sabre\CardDAV\PluginTest\testSupportedReportSet(), Sabre\CardDAV\Backend\AbstractPDOTest\testUpdateAddressBookInvalidProp(), Sabre\CardDAV\Backend\AbstractPDOTest\testUpdateAddressBookNoProps(), Sabre\CardDAV\Backend\AbstractPDOTest\testUpdateAddressBookSuccess(), Sabre\CardDAV\Backend\PDO\updateAddressBook(), Sabre\CardDAV\Xml\Filter\PropFilter\xmlDeserialize(), Sabre\CardDAV\Xml\Filter\ParamFilter\xmlDeserialize(), Sabre\CardDAV\Xml\Request\AddressBookMultiGetReport\xmlDeserialize(), Sabre\CardDAV\Xml\Request\AddressBookQueryReport\xmlDeserialize(), and Sabre\CardDAV\Xml\Property\SupportedAddressData\xmlSerialize().

---

The documentation for this class was generated from the following file:

• libs/composer/vendor/sabre/dav/lib/CardDAV/Plugin.php