Dolibarr / dolibarr

htdocs/includes/sabre/sabre/dav/lib/CardDAV/Xml/Filter/PropFilter.php

Indentation +61 added lines, -61 removed lines

@@ -25,71 +25,71 @@
  */
 class PropFilter implements XmlDeserializable
 {
-    /**
-     * The deserialize method is called during xml parsing.
-     *
-     * This method is called statically, this is because in theory this method
-     * may be used as a type of constructor, or factory method.
-     *
-     * Often you want to return an instance of the current class, but you are
-     * free to return other data as well.
-     *
-     * You are responsible for advancing the reader to the next element. Not
-     * doing anything will result in a never-ending loop.
-     *
-     * If you just want to skip parsing for this element altogether, you can
-     * just call $reader->next();
-     *
-     * $reader->parseInnerTree() will parse the entire sub-tree, and advance to
-     * the next element.
-     *
-     * @return mixed
-     */
-    public static function xmlDeserialize(Reader $reader)
-    {
-        $result = [
-            'name' => null,
-            'test' => 'anyof',
-            'is-not-defined' => false,
-            'param-filters' => [],
-            'text-matches' => [],
-        ];
+	/**
+	 * The deserialize method is called during xml parsing.
+	 *
+	 * This method is called statically, this is because in theory this method
+	 * may be used as a type of constructor, or factory method.
+	 *
+	 * Often you want to return an instance of the current class, but you are
+	 * free to return other data as well.
+	 *
+	 * You are responsible for advancing the reader to the next element. Not
+	 * doing anything will result in a never-ending loop.
+	 *
+	 * If you just want to skip parsing for this element altogether, you can
+	 * just call $reader->next();
+	 *
+	 * $reader->parseInnerTree() will parse the entire sub-tree, and advance to
+	 * the next element.
+	 *
+	 * @return mixed
+	 */
+	public static function xmlDeserialize(Reader $reader)
+	{
+		$result = [
+			'name' => null,
+			'test' => 'anyof',
+			'is-not-defined' => false,
+			'param-filters' => [],
+			'text-matches' => [],
+		];
 
-        $att = $reader->parseAttributes();
-        $result['name'] = $att['name'];
+		$att = $reader->parseAttributes();
+		$result['name'] = $att['name'];
 
-        if (isset($att['test']) && 'allof' === $att['test']) {
-            $result['test'] = 'allof';
-        }
+		if (isset($att['test']) && 'allof' === $att['test']) {
+			$result['test'] = 'allof';
+		}
 
-        $elems = $reader->parseInnerTree();
+		$elems = $reader->parseInnerTree();
 
-        if (is_array($elems)) {
-            foreach ($elems as $elem) {
-                switch ($elem['name']) {
-                case '{'.Plugin::NS_CARDDAV.'}param-filter':
-                    $result['param-filters'][] = $elem['value'];
-                    break;
-                case '{'.Plugin::NS_CARDDAV.'}is-not-defined':
-                    $result['is-not-defined'] = true;
-                    break;
-                case '{'.Plugin::NS_CARDDAV.'}text-match':
-                    $matchType = isset($elem['attributes']['match-type']) ? $elem['attributes']['match-type'] : 'contains';
+		if (is_array($elems)) {
+			foreach ($elems as $elem) {
+				switch ($elem['name']) {
+				case '{'.Plugin::NS_CARDDAV.'}param-filter':
+					$result['param-filters'][] = $elem['value'];
+					break;
+				case '{'.Plugin::NS_CARDDAV.'}is-not-defined':
+					$result['is-not-defined'] = true;
+					break;
+				case '{'.Plugin::NS_CARDDAV.'}text-match':
+					$matchType = isset($elem['attributes']['match-type']) ? $elem['attributes']['match-type'] : 'contains';
 
-                    if (!in_array($matchType, ['contains', 'equals', 'starts-with', 'ends-with'])) {
-                        throw new BadRequest('Unknown match-type: '.$matchType);
-                    }
-                    $result['text-matches'][] = [
-                        'negate-condition' => isset($elem['attributes']['negate-condition']) && 'yes' === $elem['attributes']['negate-condition'],
-                        'collation' => isset($elem['attributes']['collation']) ? $elem['attributes']['collation'] : 'i;unicode-casemap',
-                        'value' => $elem['value'],
-                        'match-type' => $matchType,
-                    ];
-                    break;
-            }
-            }
-        }
+					if (!in_array($matchType, ['contains', 'equals', 'starts-with', 'ends-with'])) {
+						throw new BadRequest('Unknown match-type: '.$matchType);
+					}
+					$result['text-matches'][] = [
+						'negate-condition' => isset($elem['attributes']['negate-condition']) && 'yes' === $elem['attributes']['negate-condition'],
+						'collation' => isset($elem['attributes']['collation']) ? $elem['attributes']['collation'] : 'i;unicode-casemap',
+						'value' => $elem['value'],
+						'match-type' => $matchType,
+					];
+					break;
+			}
+			}
+		}
 
-        return $result;
-    }
+		return $result;
+	}
 }

htdocs/includes/sabre/sabre/dav/lib/CardDAV/Xml/Filter/AddressData.php

Indentation +36 added lines, -36 removed lines

@@ -25,42 +25,42 @@
  */
 class AddressData implements XmlDeserializable
 {
-    /**
-     * The deserialize method is called during xml parsing.
-     *
-     * This method is called statically, this is because in theory this method
-     * may be used as a type of constructor, or factory method.
-     *
-     * Often you want to return an instance of the current class, but you are
-     * free to return other data as well.
-     *
-     * You are responsible for advancing the reader to the next element. Not
-     * doing anything will result in a never-ending loop.
-     *
-     * If you just want to skip parsing for this element altogether, you can
-     * just call $reader->next();
-     *
-     * $reader->parseInnerTree() will parse the entire sub-tree, and advance to
-     * the next element.
-     *
-     * @return mixed
-     */
-    public static function xmlDeserialize(Reader $reader)
-    {
-        $result = [
-            'contentType' => $reader->getAttribute('content-type') ?: 'text/vcard',
-            'version' => $reader->getAttribute('version') ?: '3.0',
-        ];
+	/**
+	 * The deserialize method is called during xml parsing.
+	 *
+	 * This method is called statically, this is because in theory this method
+	 * may be used as a type of constructor, or factory method.
+	 *
+	 * Often you want to return an instance of the current class, but you are
+	 * free to return other data as well.
+	 *
+	 * You are responsible for advancing the reader to the next element. Not
+	 * doing anything will result in a never-ending loop.
+	 *
+	 * If you just want to skip parsing for this element altogether, you can
+	 * just call $reader->next();
+	 *
+	 * $reader->parseInnerTree() will parse the entire sub-tree, and advance to
+	 * the next element.
+	 *
+	 * @return mixed
+	 */
+	public static function xmlDeserialize(Reader $reader)
+	{
+		$result = [
+			'contentType' => $reader->getAttribute('content-type') ?: 'text/vcard',
+			'version' => $reader->getAttribute('version') ?: '3.0',
+		];
 
-        $elems = (array) $reader->parseInnerTree();
-        $elems = array_filter($elems, function ($element) {
-            return '{urn:ietf:params:xml:ns:carddav}prop' === $element['name'] &&
-                isset($element['attributes']['name']);
-        });
-        $result['addressDataProperties'] = array_map(function ($element) {
-            return $element['attributes']['name'];
-        }, $elems);
+		$elems = (array) $reader->parseInnerTree();
+		$elems = array_filter($elems, function ($element) {
+			return '{urn:ietf:params:xml:ns:carddav}prop' === $element['name'] &&
+				isset($element['attributes']['name']);
+		});
+		$result['addressDataProperties'] = array_map(function ($element) {
+			return $element['attributes']['name'];
+		}, $elems);
 
-        return $result;
-    }
+		return $result;
+	}
 }

htdocs/includes/sabre/sabre/dav/lib/CardDAV/Xml/Property/SupportedAddressData.php

Indentation +47 added lines, -47 removed lines

@@ -24,54 +24,54 @@
  */
 class SupportedAddressData implements XmlSerializable
 {
-    /**
-     * supported versions.
-     *
-     * @var array
-     */
-    protected $supportedData = [];
+	/**
+	 * supported versions.
+	 *
+	 * @var array
+	 */
+	protected $supportedData = [];
 
-    /**
-     * Creates the property.
-     */
-    public function __construct(array $supportedData = null)
-    {
-        if (is_null($supportedData)) {
-            $supportedData = [
-                ['contentType' => 'text/vcard', 'version' => '3.0'],
-                ['contentType' => 'text/vcard', 'version' => '4.0'],
-                ['contentType' => 'application/vcard+json', 'version' => '4.0'],
-            ];
-        }
+	/**
+	 * Creates the property.
+	 */
+	public function __construct(array $supportedData = null)
+	{
+		if (is_null($supportedData)) {
+			$supportedData = [
+				['contentType' => 'text/vcard', 'version' => '3.0'],
+				['contentType' => 'text/vcard', 'version' => '4.0'],
+				['contentType' => 'application/vcard+json', 'version' => '4.0'],
+			];
+		}
 
-        $this->supportedData = $supportedData;
-    }
+		$this->supportedData = $supportedData;
+	}
 
-    /**
-     * The xmlSerialize method is called during xml writing.
-     *
-     * Use the $writer argument to write its own xml serialization.
-     *
-     * An important note: do _not_ create a parent element. Any element
-     * implementing XmlSerializable should only ever write what's considered
-     * its 'inner xml'.
-     *
-     * The parent of the current element is responsible for writing a
-     * containing element.
-     *
-     * This allows serializers to be re-used for different element names.
-     *
-     * If you are opening new elements, you must also close them again.
-     */
-    public function xmlSerialize(Writer $writer)
-    {
-        foreach ($this->supportedData as $supported) {
-            $writer->startElement('{'.Plugin::NS_CARDDAV.'}address-data-type');
-            $writer->writeAttributes([
-                'content-type' => $supported['contentType'],
-                'version' => $supported['version'],
-                ]);
-            $writer->endElement(); // address-data-type
-        }
-    }
+	/**
+	 * The xmlSerialize method is called during xml writing.
+	 *
+	 * Use the $writer argument to write its own xml serialization.
+	 *
+	 * An important note: do _not_ create a parent element. Any element
+	 * implementing XmlSerializable should only ever write what's considered
+	 * its 'inner xml'.
+	 *
+	 * The parent of the current element is responsible for writing a
+	 * containing element.
+	 *
+	 * This allows serializers to be re-used for different element names.
+	 *
+	 * If you are opening new elements, you must also close them again.
+	 */
+	public function xmlSerialize(Writer $writer)
+	{
+		foreach ($this->supportedData as $supported) {
+			$writer->startElement('{'.Plugin::NS_CARDDAV.'}address-data-type');
+			$writer->writeAttributes([
+				'content-type' => $supported['contentType'],
+				'version' => $supported['version'],
+				]);
+			$writer->endElement(); // address-data-type
+		}
+	}
 }

htdocs/includes/sabre/sabre/dav/lib/CardDAV/Xml/Property/SupportedCollationSet.php

Indentation +22 added lines, -22 removed lines

@@ -19,26 +19,26 @@
  */
 class SupportedCollationSet implements XmlSerializable
 {
-    /**
-     * The xmlSerialize method is called during xml writing.
-     *
-     * Use the $writer argument to write its own xml serialization.
-     *
-     * An important note: do _not_ create a parent element. Any element
-     * implementing XmlSerializable should only ever write what's considered
-     * its 'inner xml'.
-     *
-     * The parent of the current element is responsible for writing a
-     * containing element.
-     *
-     * This allows serializers to be re-used for different element names.
-     *
-     * If you are opening new elements, you must also close them again.
-     */
-    public function xmlSerialize(Writer $writer)
-    {
-        foreach (['i;ascii-casemap', 'i;octet', 'i;unicode-casemap'] as $coll) {
-            $writer->writeElement('{urn:ietf:params:xml:ns:carddav}supported-collation', $coll);
-        }
-    }
+	/**
+	 * The xmlSerialize method is called during xml writing.
+	 *
+	 * Use the $writer argument to write its own xml serialization.
+	 *
+	 * An important note: do _not_ create a parent element. Any element
+	 * implementing XmlSerializable should only ever write what's considered
+	 * its 'inner xml'.
+	 *
+	 * The parent of the current element is responsible for writing a
+	 * containing element.
+	 *
+	 * This allows serializers to be re-used for different element names.
+	 *
+	 * If you are opening new elements, you must also close them again.
+	 */
+	public function xmlSerialize(Writer $writer)
+	{
+		foreach (['i;ascii-casemap', 'i;octet', 'i;unicode-casemap'] as $coll) {
+			$writer->writeElement('{urn:ietf:params:xml:ns:carddav}supported-collation', $coll);
+		}
+	}
 }

htdocs/includes/sabre/sabre/dav/lib/CardDAV/AddressBookHome.php

Indentation +155 added lines, -155 removed lines

@@ -20,159 +20,159 @@
  */
 class AddressBookHome extends DAV\Collection implements DAV\IExtendedCollection, DAVACL\IACL
 {
-    use DAVACL\ACLTrait;
-
-    /**
-     * Principal uri.
-     *
-     * @var array
-     */
-    protected $principalUri;
-
-    /**
-     * carddavBackend.
-     *
-     * @var Backend\BackendInterface
-     */
-    protected $carddavBackend;
-
-    /**
-     * Constructor.
-     *
-     * @param string $principalUri
-     */
-    public function __construct(Backend\BackendInterface $carddavBackend, $principalUri)
-    {
-        $this->carddavBackend = $carddavBackend;
-        $this->principalUri = $principalUri;
-    }
-
-    /**
-     * Returns the name of this object.
-     *
-     * @return string
-     */
-    public function getName()
-    {
-        list(, $name) = Uri\split($this->principalUri);
-
-        return $name;
-    }
-
-    /**
-     * Updates the name of this object.
-     *
-     * @param string $name
-     */
-    public function setName($name)
-    {
-        throw new DAV\Exception\MethodNotAllowed();
-    }
-
-    /**
-     * Deletes this object.
-     */
-    public function delete()
-    {
-        throw new DAV\Exception\MethodNotAllowed();
-    }
-
-    /**
-     * Returns the last modification date.
-     *
-     * @return int
-     */
-    public function getLastModified()
-    {
-        return null;
-    }
-
-    /**
-     * Creates a new file under this object.
-     *
-     * This is currently not allowed
-     *
-     * @param string   $filename
-     * @param resource $data
-     */
-    public function createFile($filename, $data = null)
-    {
-        throw new DAV\Exception\MethodNotAllowed('Creating new files in this collection is not supported');
-    }
-
-    /**
-     * Creates a new directory under this object.
-     *
-     * This is currently not allowed.
-     *
-     * @param string $filename
-     */
-    public function createDirectory($filename)
-    {
-        throw new DAV\Exception\MethodNotAllowed('Creating new collections in this collection is not supported');
-    }
-
-    /**
-     * Returns a single addressbook, by name.
-     *
-     * @param string $name
-     *
-     * @todo needs optimizing
-     *
-     * @return AddressBook
-     */
-    public function getChild($name)
-    {
-        foreach ($this->getChildren() as $child) {
-            if ($name == $child->getName()) {
-                return $child;
-            }
-        }
-        throw new DAV\Exception\NotFound('Addressbook with name \''.$name.'\' could not be found');
-    }
-
-    /**
-     * Returns a list of addressbooks.
-     *
-     * @return array
-     */
-    public function getChildren()
-    {
-        $addressbooks = $this->carddavBackend->getAddressBooksForUser($this->principalUri);
-        $objs = [];
-        foreach ($addressbooks as $addressbook) {
-            $objs[] = new AddressBook($this->carddavBackend, $addressbook);
-        }
-
-        return $objs;
-    }
-
-    /**
-     * Creates a new address book.
-     *
-     * @param string $name
-     *
-     * @throws DAV\Exception\InvalidResourceType
-     */
-    public function createExtendedCollection($name, MkCol $mkCol)
-    {
-        if (!$mkCol->hasResourceType('{'.Plugin::NS_CARDDAV.'}addressbook')) {
-            throw new DAV\Exception\InvalidResourceType('Unknown resourceType for this collection');
-        }
-        $properties = $mkCol->getRemainingValues();
-        $mkCol->setRemainingResultCode(201);
-        $this->carddavBackend->createAddressBook($this->principalUri, $name, $properties);
-    }
-
-    /**
-     * Returns the owner principal.
-     *
-     * This must be a url to a principal, or null if there's no owner
-     *
-     * @return string|null
-     */
-    public function getOwner()
-    {
-        return $this->principalUri;
-    }
+	use DAVACL\ACLTrait;
+
+	/**
+	 * Principal uri.
+	 *
+	 * @var array
+	 */
+	protected $principalUri;
+
+	/**
+	 * carddavBackend.
+	 *
+	 * @var Backend\BackendInterface
+	 */
+	protected $carddavBackend;
+
+	/**
+	 * Constructor.
+	 *
+	 * @param string $principalUri
+	 */
+	public function __construct(Backend\BackendInterface $carddavBackend, $principalUri)
+	{
+		$this->carddavBackend = $carddavBackend;
+		$this->principalUri = $principalUri;
+	}
+
+	/**
+	 * Returns the name of this object.
+	 *
+	 * @return string
+	 */
+	public function getName()
+	{
+		list(, $name) = Uri\split($this->principalUri);
+
+		return $name;
+	}
+
+	/**
+	 * Updates the name of this object.
+	 *
+	 * @param string $name
+	 */
+	public function setName($name)
+	{
+		throw new DAV\Exception\MethodNotAllowed();
+	}
+
+	/**
+	 * Deletes this object.
+	 */
+	public function delete()
+	{
+		throw new DAV\Exception\MethodNotAllowed();
+	}
+
+	/**
+	 * Returns the last modification date.
+	 *
+	 * @return int
+	 */
+	public function getLastModified()
+	{
+		return null;
+	}
+
+	/**
+	 * Creates a new file under this object.
+	 *
+	 * This is currently not allowed
+	 *
+	 * @param string   $filename
+	 * @param resource $data
+	 */
+	public function createFile($filename, $data = null)
+	{
+		throw new DAV\Exception\MethodNotAllowed('Creating new files in this collection is not supported');
+	}
+
+	/**
+	 * Creates a new directory under this object.
+	 *
+	 * This is currently not allowed.
+	 *
+	 * @param string $filename
+	 */
+	public function createDirectory($filename)
+	{
+		throw new DAV\Exception\MethodNotAllowed('Creating new collections in this collection is not supported');
+	}
+
+	/**
+	 * Returns a single addressbook, by name.
+	 *
+	 * @param string $name
+	 *
+	 * @todo needs optimizing
+	 *
+	 * @return AddressBook
+	 */
+	public function getChild($name)
+	{
+		foreach ($this->getChildren() as $child) {
+			if ($name == $child->getName()) {
+				return $child;
+			}
+		}
+		throw new DAV\Exception\NotFound('Addressbook with name \''.$name.'\' could not be found');
+	}
+
+	/**
+	 * Returns a list of addressbooks.
+	 *
+	 * @return array
+	 */
+	public function getChildren()
+	{
+		$addressbooks = $this->carddavBackend->getAddressBooksForUser($this->principalUri);
+		$objs = [];
+		foreach ($addressbooks as $addressbook) {
+			$objs[] = new AddressBook($this->carddavBackend, $addressbook);
+		}
+
+		return $objs;
+	}
+
+	/**
+	 * Creates a new address book.
+	 *
+	 * @param string $name
+	 *
+	 * @throws DAV\Exception\InvalidResourceType
+	 */
+	public function createExtendedCollection($name, MkCol $mkCol)
+	{
+		if (!$mkCol->hasResourceType('{'.Plugin::NS_CARDDAV.'}addressbook')) {
+			throw new DAV\Exception\InvalidResourceType('Unknown resourceType for this collection');
+		}
+		$properties = $mkCol->getRemainingValues();
+		$mkCol->setRemainingResultCode(201);
+		$this->carddavBackend->createAddressBook($this->principalUri, $name, $properties);
+	}
+
+	/**
+	 * Returns the owner principal.
+	 *
+	 * This must be a url to a principal, or null if there's no owner
+	 *
+	 * @return string|null
+	 */
+	public function getOwner()
+	{
+		return $this->principalUri;
+	}
 }

htdocs/includes/sabre/sabre/dav/lib/CardDAV/Card.php

Indentation +183 added lines, -183 removed lines

@@ -16,187 +16,187 @@
  */
 class Card extends DAV\File implements ICard, DAVACL\IACL
 {
-    use DAVACL\ACLTrait;
-
-    /**
-     * CardDAV backend.
-     *
-     * @var Backend\BackendInterface
-     */
-    protected $carddavBackend;
-
-    /**
-     * Array with information about this Card.
-     *
-     * @var array
-     */
-    protected $cardData;
-
-    /**
-     * Array with information about the containing addressbook.
-     *
-     * @var array
-     */
-    protected $addressBookInfo;
-
-    /**
-     * Constructor.
-     */
-    public function __construct(Backend\BackendInterface $carddavBackend, array $addressBookInfo, array $cardData)
-    {
-        $this->carddavBackend = $carddavBackend;
-        $this->addressBookInfo = $addressBookInfo;
-        $this->cardData = $cardData;
-    }
-
-    /**
-     * Returns the uri for this object.
-     *
-     * @return string
-     */
-    public function getName()
-    {
-        return $this->cardData['uri'];
-    }
-
-    /**
-     * Returns the VCard-formatted object.
-     *
-     * @return string
-     */
-    public function get()
-    {
-        // Pre-populating 'carddata' is optional. If we don't yet have it
-        // already, we fetch it from the backend.
-        if (!isset($this->cardData['carddata'])) {
-            $this->cardData = $this->carddavBackend->getCard($this->addressBookInfo['id'], $this->cardData['uri']);
-        }
-
-        return $this->cardData['carddata'];
-    }
-
-    /**
-     * Updates the VCard-formatted object.
-     *
-     * @param string $cardData
-     *
-     * @return string|null
-     */
-    public function put($cardData)
-    {
-        if (is_resource($cardData)) {
-            $cardData = stream_get_contents($cardData);
-        }
-
-        // Converting to UTF-8, if needed
-        $cardData = DAV\StringUtil::ensureUTF8($cardData);
-
-        $etag = $this->carddavBackend->updateCard($this->addressBookInfo['id'], $this->cardData['uri'], $cardData);
-        $this->cardData['carddata'] = $cardData;
-        $this->cardData['etag'] = $etag;
-
-        return $etag;
-    }
-
-    /**
-     * Deletes the card.
-     */
-    public function delete()
-    {
-        $this->carddavBackend->deleteCard($this->addressBookInfo['id'], $this->cardData['uri']);
-    }
-
-    /**
-     * Returns the mime content-type.
-     *
-     * @return string
-     */
-    public function getContentType()
-    {
-        return 'text/vcard; charset=utf-8';
-    }
-
-    /**
-     * Returns an ETag for this object.
-     *
-     * @return string
-     */
-    public function getETag()
-    {
-        if (isset($this->cardData['etag'])) {
-            return $this->cardData['etag'];
-        } else {
-            $data = $this->get();
-            if (is_string($data)) {
-                return '"'.md5($data).'"';
-            } else {
-                // We refuse to calculate the md5 if it's a stream.
-                return null;
-            }
-        }
-    }
-
-    /**
-     * Returns the last modification date as a unix timestamp.
-     *
-     * @return int
-     */
-    public function getLastModified()
-    {
-        return isset($this->cardData['lastmodified']) ? $this->cardData['lastmodified'] : null;
-    }
-
-    /**
-     * Returns the size of this object in bytes.
-     *
-     * @return int
-     */
-    public function getSize()
-    {
-        if (array_key_exists('size', $this->cardData)) {
-            return $this->cardData['size'];
-        } else {
-            return strlen($this->get());
-        }
-    }
-
-    /**
-     * Returns the owner principal.
-     *
-     * This must be a url to a principal, or null if there's no owner
-     *
-     * @return string|null
-     */
-    public function getOwner()
-    {
-        return $this->addressBookInfo['principaluri'];
-    }
-
-    /**
-     * Returns a list of ACE's for this node.
-     *
-     * Each ACE has the following properties:
-     *   * 'privilege', a string such as {DAV:}read or {DAV:}write. These are
-     *     currently the only supported privileges
-     *   * 'principal', a url to the principal who owns the node
-     *   * 'protected' (optional), indicating that this ACE is not allowed to
-     *      be updated.
-     *
-     * @return array
-     */
-    public function getACL()
-    {
-        // An alternative acl may be specified through the cardData array.
-        if (isset($this->cardData['acl'])) {
-            return $this->cardData['acl'];
-        }
-
-        return [
-            [
-                'privilege' => '{DAV:}all',
-                'principal' => $this->addressBookInfo['principaluri'],
-                'protected' => true,
-            ],
-        ];
-    }
+	use DAVACL\ACLTrait;
+
+	/**
+	 * CardDAV backend.
+	 *
+	 * @var Backend\BackendInterface
+	 */
+	protected $carddavBackend;
+
+	/**
+	 * Array with information about this Card.
+	 *
+	 * @var array
+	 */
+	protected $cardData;
+
+	/**
+	 * Array with information about the containing addressbook.
+	 *
+	 * @var array
+	 */
+	protected $addressBookInfo;
+
+	/**
+	 * Constructor.
+	 */
+	public function __construct(Backend\BackendInterface $carddavBackend, array $addressBookInfo, array $cardData)
+	{
+		$this->carddavBackend = $carddavBackend;
+		$this->addressBookInfo = $addressBookInfo;
+		$this->cardData = $cardData;
+	}
+
+	/**
+	 * Returns the uri for this object.
+	 *
+	 * @return string
+	 */
+	public function getName()
+	{
+		return $this->cardData['uri'];
+	}
+
+	/**
+	 * Returns the VCard-formatted object.
+	 *
+	 * @return string
+	 */
+	public function get()
+	{
+		// Pre-populating 'carddata' is optional. If we don't yet have it
+		// already, we fetch it from the backend.
+		if (!isset($this->cardData['carddata'])) {
+			$this->cardData = $this->carddavBackend->getCard($this->addressBookInfo['id'], $this->cardData['uri']);
+		}
+
+		return $this->cardData['carddata'];
+	}
+
+	/**
+	 * Updates the VCard-formatted object.
+	 *
+	 * @param string $cardData
+	 *
+	 * @return string|null
+	 */
+	public function put($cardData)
+	{
+		if (is_resource($cardData)) {
+			$cardData = stream_get_contents($cardData);
+		}
+
+		// Converting to UTF-8, if needed
+		$cardData = DAV\StringUtil::ensureUTF8($cardData);
+
+		$etag = $this->carddavBackend->updateCard($this->addressBookInfo['id'], $this->cardData['uri'], $cardData);
+		$this->cardData['carddata'] = $cardData;
+		$this->cardData['etag'] = $etag;
+
+		return $etag;
+	}
+
+	/**
+	 * Deletes the card.
+	 */
+	public function delete()
+	{
+		$this->carddavBackend->deleteCard($this->addressBookInfo['id'], $this->cardData['uri']);
+	}
+
+	/**
+	 * Returns the mime content-type.
+	 *
+	 * @return string
+	 */
+	public function getContentType()
+	{
+		return 'text/vcard; charset=utf-8';
+	}
+
+	/**
+	 * Returns an ETag for this object.
+	 *
+	 * @return string
+	 */
+	public function getETag()
+	{
+		if (isset($this->cardData['etag'])) {
+			return $this->cardData['etag'];
+		} else {
+			$data = $this->get();
+			if (is_string($data)) {
+				return '"'.md5($data).'"';
+			} else {
+				// We refuse to calculate the md5 if it's a stream.
+				return null;
+			}
+		}
+	}
+
+	/**
+	 * Returns the last modification date as a unix timestamp.
+	 *
+	 * @return int
+	 */
+	public function getLastModified()
+	{
+		return isset($this->cardData['lastmodified']) ? $this->cardData['lastmodified'] : null;
+	}
+
+	/**
+	 * Returns the size of this object in bytes.
+	 *
+	 * @return int
+	 */
+	public function getSize()
+	{
+		if (array_key_exists('size', $this->cardData)) {
+			return $this->cardData['size'];
+		} else {
+			return strlen($this->get());
+		}
+	}
+
+	/**
+	 * Returns the owner principal.
+	 *
+	 * This must be a url to a principal, or null if there's no owner
+	 *
+	 * @return string|null
+	 */
+	public function getOwner()
+	{
+		return $this->addressBookInfo['principaluri'];
+	}
+
+	/**
+	 * Returns a list of ACE's for this node.
+	 *
+	 * Each ACE has the following properties:
+	 *   * 'privilege', a string such as {DAV:}read or {DAV:}write. These are
+	 *     currently the only supported privileges
+	 *   * 'principal', a url to the principal who owns the node
+	 *   * 'protected' (optional), indicating that this ACE is not allowed to
+	 *      be updated.
+	 *
+	 * @return array
+	 */
+	public function getACL()
+	{
+		// An alternative acl may be specified through the cardData array.
+		if (isset($this->cardData['acl'])) {
+			return $this->cardData['acl'];
+		}
+
+		return [
+			[
+				'privilege' => '{DAV:}all',
+				'principal' => $this->addressBookInfo['principaluri'],
+				'protected' => true,
+			],
+		];
+	}
 }

htdocs/includes/sabre/sabre/dav/lib/CardDAV/AddressBook.php

Indentation +290 added lines, -290 removed lines

@@ -18,318 +18,318 @@
  */
 class AddressBook extends DAV\Collection implements IAddressBook, DAV\IProperties, DAVACL\IACL, DAV\Sync\ISyncCollection, DAV\IMultiGet
 {
-    use DAVACL\ACLTrait;
+	use DAVACL\ACLTrait;
 
-    /**
-     * This is an array with addressbook information.
-     *
-     * @var array
-     */
-    protected $addressBookInfo;
+	/**
+	 * This is an array with addressbook information.
+	 *
+	 * @var array
+	 */
+	protected $addressBookInfo;
 
-    /**
-     * CardDAV backend.
-     *
-     * @var Backend\BackendInterface
-     */
-    protected $carddavBackend;
+	/**
+	 * CardDAV backend.
+	 *
+	 * @var Backend\BackendInterface
+	 */
+	protected $carddavBackend;
 
-    /**
-     * Constructor.
-     */
-    public function __construct(Backend\BackendInterface $carddavBackend, array $addressBookInfo)
-    {
-        $this->carddavBackend = $carddavBackend;
-        $this->addressBookInfo = $addressBookInfo;
-    }
+	/**
+	 * Constructor.
+	 */
+	public function __construct(Backend\BackendInterface $carddavBackend, array $addressBookInfo)
+	{
+		$this->carddavBackend = $carddavBackend;
+		$this->addressBookInfo = $addressBookInfo;
+	}
 
-    /**
-     * Returns the name of the addressbook.
-     *
-     * @return string
-     */
-    public function getName()
-    {
-        return $this->addressBookInfo['uri'];
-    }
+	/**
+	 * Returns the name of the addressbook.
+	 *
+	 * @return string
+	 */
+	public function getName()
+	{
+		return $this->addressBookInfo['uri'];
+	}
 
-    /**
-     * Returns a card.
-     *
-     * @param string $name
-     *
-     * @return Card
-     */
-    public function getChild($name)
-    {
-        $obj = $this->carddavBackend->getCard($this->addressBookInfo['id'], $name);
-        if (!$obj) {
-            throw new DAV\Exception\NotFound('Card not found');
-        }
+	/**
+	 * Returns a card.
+	 *
+	 * @param string $name
+	 *
+	 * @return Card
+	 */
+	public function getChild($name)
+	{
+		$obj = $this->carddavBackend->getCard($this->addressBookInfo['id'], $name);
+		if (!$obj) {
+			throw new DAV\Exception\NotFound('Card not found');
+		}
 
-        return new Card($this->carddavBackend, $this->addressBookInfo, $obj);
-    }
+		return new Card($this->carddavBackend, $this->addressBookInfo, $obj);
+	}
 
-    /**
-     * Returns the full list of cards.
-     *
-     * @return array
-     */
-    public function getChildren()
-    {
-        $objs = $this->carddavBackend->getCards($this->addressBookInfo['id']);
-        $children = [];
-        foreach ($objs as $obj) {
-            $obj['acl'] = $this->getChildACL();
-            $children[] = new Card($this->carddavBackend, $this->addressBookInfo, $obj);
-        }
+	/**
+	 * Returns the full list of cards.
+	 *
+	 * @return array
+	 */
+	public function getChildren()
+	{
+		$objs = $this->carddavBackend->getCards($this->addressBookInfo['id']);
+		$children = [];
+		foreach ($objs as $obj) {
+			$obj['acl'] = $this->getChildACL();
+			$children[] = new Card($this->carddavBackend, $this->addressBookInfo, $obj);
+		}
 
-        return $children;
-    }
+		return $children;
+	}
 
-    /**
-     * This method receives a list of paths in it's first argument.
-     * It must return an array with Node objects.
-     *
-     * If any children are not found, you do not have to return them.
-     *
-     * @param string[] $paths
-     *
-     * @return array
-     */
-    public function getMultipleChildren(array $paths)
-    {
-        $objs = $this->carddavBackend->getMultipleCards($this->addressBookInfo['id'], $paths);
-        $children = [];
-        foreach ($objs as $obj) {
-            $obj['acl'] = $this->getChildACL();
-            $children[] = new Card($this->carddavBackend, $this->addressBookInfo, $obj);
-        }
+	/**
+	 * This method receives a list of paths in it's first argument.
+	 * It must return an array with Node objects.
+	 *
+	 * If any children are not found, you do not have to return them.
+	 *
+	 * @param string[] $paths
+	 *
+	 * @return array
+	 */
+	public function getMultipleChildren(array $paths)
+	{
+		$objs = $this->carddavBackend->getMultipleCards($this->addressBookInfo['id'], $paths);
+		$children = [];
+		foreach ($objs as $obj) {
+			$obj['acl'] = $this->getChildACL();
+			$children[] = new Card($this->carddavBackend, $this->addressBookInfo, $obj);
+		}
 
-        return $children;
-    }
+		return $children;
+	}
 
-    /**
-     * Creates a new directory.
-     *
-     * We actually block this, as subdirectories are not allowed in addressbooks.
-     *
-     * @param string $name
-     */
-    public function createDirectory($name)
-    {
-        throw new DAV\Exception\MethodNotAllowed('Creating collections in addressbooks is not allowed');
-    }
+	/**
+	 * Creates a new directory.
+	 *
+	 * We actually block this, as subdirectories are not allowed in addressbooks.
+	 *
+	 * @param string $name
+	 */
+	public function createDirectory($name)
+	{
+		throw new DAV\Exception\MethodNotAllowed('Creating collections in addressbooks is not allowed');
+	}
 
-    /**
-     * Creates a new file.
-     *
-     * The contents of the new file must be a valid VCARD.
-     *
-     * This method may return an ETag.
-     *
-     * @param string   $name
-     * @param resource $vcardData
-     *
-     * @return string|null
-     */
-    public function createFile($name, $vcardData = null)
-    {
-        if (is_resource($vcardData)) {
-            $vcardData = stream_get_contents($vcardData);
-        }
-        // Converting to UTF-8, if needed
-        $vcardData = DAV\StringUtil::ensureUTF8($vcardData);
+	/**
+	 * Creates a new file.
+	 *
+	 * The contents of the new file must be a valid VCARD.
+	 *
+	 * This method may return an ETag.
+	 *
+	 * @param string   $name
+	 * @param resource $vcardData
+	 *
+	 * @return string|null
+	 */
+	public function createFile($name, $vcardData = null)
+	{
+		if (is_resource($vcardData)) {
+			$vcardData = stream_get_contents($vcardData);
+		}
+		// Converting to UTF-8, if needed
+		$vcardData = DAV\StringUtil::ensureUTF8($vcardData);
 
-        return $this->carddavBackend->createCard($this->addressBookInfo['id'], $name, $vcardData);
-    }
+		return $this->carddavBackend->createCard($this->addressBookInfo['id'], $name, $vcardData);
+	}
 
-    /**
-     * Deletes the entire addressbook.
-     */
-    public function delete()
-    {
-        $this->carddavBackend->deleteAddressBook($this->addressBookInfo['id']);
-    }
+	/**
+	 * Deletes the entire addressbook.
+	 */
+	public function delete()
+	{
+		$this->carddavBackend->deleteAddressBook($this->addressBookInfo['id']);
+	}
 
-    /**
-     * Renames the addressbook.
-     *
-     * @param string $newName
-     */
-    public function setName($newName)
-    {
-        throw new DAV\Exception\MethodNotAllowed('Renaming addressbooks is not yet supported');
-    }
+	/**
+	 * Renames the addressbook.
+	 *
+	 * @param string $newName
+	 */
+	public function setName($newName)
+	{
+		throw new DAV\Exception\MethodNotAllowed('Renaming addressbooks is not yet supported');
+	}
 
-    /**
-     * Returns the last modification date as a unix timestamp.
-     */
-    public function getLastModified()
-    {
-        return null;
-    }
+	/**
+	 * Returns the last modification date as a unix timestamp.
+	 */
+	public function getLastModified()
+	{
+		return null;
+	}
 
-    /**
-     * Updates properties on this node.
-     *
-     * This method received a PropPatch object, which contains all the
-     * information about the update.
-     *
-     * To update specific properties, call the 'handle' method on this object.
-     * Read the PropPatch documentation for more information.
-     */
-    public function propPatch(DAV\PropPatch $propPatch)
-    {
-        return $this->carddavBackend->updateAddressBook($this->addressBookInfo['id'], $propPatch);
-    }
+	/**
+	 * Updates properties on this node.
+	 *
+	 * This method received a PropPatch object, which contains all the
+	 * information about the update.
+	 *
+	 * To update specific properties, call the 'handle' method on this object.
+	 * Read the PropPatch documentation for more information.
+	 */
+	public function propPatch(DAV\PropPatch $propPatch)
+	{
+		return $this->carddavBackend->updateAddressBook($this->addressBookInfo['id'], $propPatch);
+	}
 
-    /**
-     * Returns a list of properties for this nodes.
-     *
-     * The properties list is a list of propertynames the client requested,
-     * encoded in clark-notation {xmlnamespace}tagname
-     *
-     * If the array is empty, it means 'all properties' were requested.
-     *
-     * @param array $properties
-     *
-     * @return array
-     */
-    public function getProperties($properties)
-    {
-        $response = [];
-        foreach ($properties as $propertyName) {
-            if (isset($this->addressBookInfo[$propertyName])) {
-                $response[$propertyName] = $this->addressBookInfo[$propertyName];
-            }
-        }
+	/**
+	 * Returns a list of properties for this nodes.
+	 *
+	 * The properties list is a list of propertynames the client requested,
+	 * encoded in clark-notation {xmlnamespace}tagname
+	 *
+	 * If the array is empty, it means 'all properties' were requested.
+	 *
+	 * @param array $properties
+	 *
+	 * @return array
+	 */
+	public function getProperties($properties)
+	{
+		$response = [];
+		foreach ($properties as $propertyName) {
+			if (isset($this->addressBookInfo[$propertyName])) {
+				$response[$propertyName] = $this->addressBookInfo[$propertyName];
+			}
+		}
 
-        return $response;
-    }
+		return $response;
+	}
 
-    /**
-     * Returns the owner principal.
-     *
-     * This must be a url to a principal, or null if there's no owner
-     *
-     * @return string|null
-     */
-    public function getOwner()
-    {
-        return $this->addressBookInfo['principaluri'];
-    }
+	/**
+	 * Returns the owner principal.
+	 *
+	 * This must be a url to a principal, or null if there's no owner
+	 *
+	 * @return string|null
+	 */
+	public function getOwner()
+	{
+		return $this->addressBookInfo['principaluri'];
+	}
 
-    /**
-     * This method returns the ACL's for card nodes in this address book.
-     * The result of this method automatically gets passed to the
-     * card nodes in this address book.
-     *
-     * @return array
-     */
-    public function getChildACL()
-    {
-        return [
-            [
-                'privilege' => '{DAV:}all',
-                'principal' => $this->getOwner(),
-                'protected' => true,
-            ],
-        ];
-    }
+	/**
+	 * This method returns the ACL's for card nodes in this address book.
+	 * The result of this method automatically gets passed to the
+	 * card nodes in this address book.
+	 *
+	 * @return array
+	 */
+	public function getChildACL()
+	{
+		return [
+			[
+				'privilege' => '{DAV:}all',
+				'principal' => $this->getOwner(),
+				'protected' => true,
+			],
+		];
+	}
 
-    /**
-     * This method returns the current sync-token for this collection.
-     * This can be any string.
-     *
-     * If null is returned from this function, the plugin assumes there's no
-     * sync information available.
-     *
-     * @return string|null
-     */
-    public function getSyncToken()
-    {
-        if (
-            $this->carddavBackend instanceof Backend\SyncSupport &&
-            isset($this->addressBookInfo['{DAV:}sync-token'])
-        ) {
-            return $this->addressBookInfo['{DAV:}sync-token'];
-        }
-        if (
-            $this->carddavBackend instanceof Backend\SyncSupport &&
-            isset($this->addressBookInfo['{http://sabredav.org/ns}sync-token'])
-        ) {
-            return $this->addressBookInfo['{http://sabredav.org/ns}sync-token'];
-        }
-    }
+	/**
+	 * This method returns the current sync-token for this collection.
+	 * This can be any string.
+	 *
+	 * If null is returned from this function, the plugin assumes there's no
+	 * sync information available.
+	 *
+	 * @return string|null
+	 */
+	public function getSyncToken()
+	{
+		if (
+			$this->carddavBackend instanceof Backend\SyncSupport &&
+			isset($this->addressBookInfo['{DAV:}sync-token'])
+		) {
+			return $this->addressBookInfo['{DAV:}sync-token'];
+		}
+		if (
+			$this->carddavBackend instanceof Backend\SyncSupport &&
+			isset($this->addressBookInfo['{http://sabredav.org/ns}sync-token'])
+		) {
+			return $this->addressBookInfo['{http://sabredav.org/ns}sync-token'];
+		}
+	}
 
-    /**
-     * The getChanges method returns all the changes that have happened, since
-     * the specified syncToken and the current collection.
-     *
-     * 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 syncToken property should reflect the *current* syncToken of the
-     * collection, as reported getSyncToken(). This is needed here too, to
-     * ensure the operation is atomic.
-     *
-     * If the syncToken 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 second 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 third (optional) 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 $syncToken
-     * @param int    $syncLevel
-     * @param int    $limit
-     *
-     * @return array
-     */
-    public function getChanges($syncToken, $syncLevel, $limit = null)
-    {
-        if (!$this->carddavBackend instanceof Backend\SyncSupport) {
-            return null;
-        }
+	/**
+	 * The getChanges method returns all the changes that have happened, since
+	 * the specified syncToken and the current collection.
+	 *
+	 * 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 syncToken property should reflect the *current* syncToken of the
+	 * collection, as reported getSyncToken(). This is needed here too, to
+	 * ensure the operation is atomic.
+	 *
+	 * If the syncToken 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 second 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 third (optional) 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 $syncToken
+	 * @param int    $syncLevel
+	 * @param int    $limit
+	 *
+	 * @return array
+	 */
+	public function getChanges($syncToken, $syncLevel, $limit = null)
+	{
+		if (!$this->carddavBackend instanceof Backend\SyncSupport) {
+			return null;
+		}
 
-        return $this->carddavBackend->getChangesForAddressBook(
-            $this->addressBookInfo['id'],
-            $syncToken,
-            $syncLevel,
-            $limit
-        );
-    }
+		return $this->carddavBackend->getChangesForAddressBook(
+			$this->addressBookInfo['id'],
+			$syncToken,
+			$syncLevel,
+			$limit
+		);
+	}
 }

htdocs/includes/sabre/sabre/dav/lib/DAVACL/IACL.php

Indentation +48 added lines, -48 removed lines

@@ -17,56 +17,56 @@
  */
 interface IACL extends DAV\INode
 {
-    /**
-     * Returns the owner principal.
-     *
-     * This must be a url to a principal, or null if there's no owner
-     *
-     * @return string|null
-     */
-    public function getOwner();
+	/**
+	 * Returns the owner principal.
+	 *
+	 * This must be a url to a principal, or null if there's no owner
+	 *
+	 * @return string|null
+	 */
+	public function getOwner();
 
-    /**
-     * Returns a group principal.
-     *
-     * This must be a url to a principal, or null if there's no owner
-     *
-     * @return string|null
-     */
-    public function getGroup();
+	/**
+	 * Returns a group principal.
+	 *
+	 * This must be a url to a principal, or null if there's no owner
+	 *
+	 * @return string|null
+	 */
+	public function getGroup();
 
-    /**
-     * Returns a list of ACE's for this node.
-     *
-     * Each ACE has the following properties:
-     *   * 'privilege', a string such as {DAV:}read or {DAV:}write. These are
-     *     currently the only supported privileges
-     *   * 'principal', a url to the principal who owns the node
-     *   * 'protected' (optional), indicating that this ACE is not allowed to
-     *      be updated.
-     *
-     * @return array
-     */
-    public function getACL();
+	/**
+	 * Returns a list of ACE's for this node.
+	 *
+	 * Each ACE has the following properties:
+	 *   * 'privilege', a string such as {DAV:}read or {DAV:}write. These are
+	 *     currently the only supported privileges
+	 *   * 'principal', a url to the principal who owns the node
+	 *   * 'protected' (optional), indicating that this ACE is not allowed to
+	 *      be updated.
+	 *
+	 * @return array
+	 */
+	public function getACL();
 
-    /**
-     * Updates the ACL.
-     *
-     * This method will receive a list of new ACE's as an array argument.
-     */
-    public function setACL(array $acl);
+	/**
+	 * Updates the ACL.
+	 *
+	 * This method will receive a list of new ACE's as an array argument.
+	 */
+	public function setACL(array $acl);
 
-    /**
-     * Returns the list of supported privileges for this node.
-     *
-     * The returned data structure is a list of nested privileges.
-     * See Sabre\DAVACL\Plugin::getDefaultSupportedPrivilegeSet for a simple
-     * standard structure.
-     *
-     * If null is returned from this method, the default privilege set is used,
-     * which is fine for most common usecases.
-     *
-     * @return array|null
-     */
-    public function getSupportedPrivilegeSet();
+	/**
+	 * Returns the list of supported privileges for this node.
+	 *
+	 * The returned data structure is a list of nested privileges.
+	 * See Sabre\DAVACL\Plugin::getDefaultSupportedPrivilegeSet for a simple
+	 * standard structure.
+	 *
+	 * If null is returned from this method, the default privilege set is used,
+	 * which is fine for most common usecases.
+	 *
+	 * @return array|null
+	 */
+	public function getSupportedPrivilegeSet();
 }

htdocs/includes/sabre/sabre/dav/lib/DAVACL/Principal.php

Indentation +172 added lines, -172 removed lines

@@ -24,176 +24,176 @@
  */
 class Principal extends DAV\Node implements IPrincipal, DAV\IProperties, IACL
 {
-    use ACLTrait;
-
-    /**
-     * Struct with principal information.
-     *
-     * @var array
-     */
-    protected $principalProperties;
-
-    /**
-     * Principal backend.
-     *
-     * @var PrincipalBackend\BackendInterface
-     */
-    protected $principalBackend;
-
-    /**
-     * Creates the principal object.
-     */
-    public function __construct(PrincipalBackend\BackendInterface $principalBackend, array $principalProperties = [])
-    {
-        if (!isset($principalProperties['uri'])) {
-            throw new DAV\Exception('The principal properties must at least contain the \'uri\' key');
-        }
-        $this->principalBackend = $principalBackend;
-        $this->principalProperties = $principalProperties;
-    }
-
-    /**
-     * Returns the full principal url.
-     *
-     * @return string
-     */
-    public function getPrincipalUrl()
-    {
-        return $this->principalProperties['uri'];
-    }
-
-    /**
-     * Returns a list of alternative urls for a principal.
-     *
-     * This can for example be an email address, or ldap url.
-     *
-     * @return array
-     */
-    public function getAlternateUriSet()
-    {
-        $uris = [];
-        if (isset($this->principalProperties['{DAV:}alternate-URI-set'])) {
-            $uris = $this->principalProperties['{DAV:}alternate-URI-set'];
-        }
-
-        if (isset($this->principalProperties['{http://sabredav.org/ns}email-address'])) {
-            $uris[] = 'mailto:'.$this->principalProperties['{http://sabredav.org/ns}email-address'];
-        }
-
-        return array_unique($uris);
-    }
-
-    /**
-     * Returns the list of group members.
-     *
-     * If this principal is a group, this function should return
-     * all member principal uri's for the group.
-     *
-     * @return array
-     */
-    public function getGroupMemberSet()
-    {
-        return $this->principalBackend->getGroupMemberSet($this->principalProperties['uri']);
-    }
-
-    /**
-     * Returns the list of groups this principal is member of.
-     *
-     * If this principal is a member of a (list of) groups, this function
-     * should return a list of principal uri's for it's members.
-     *
-     * @return array
-     */
-    public function getGroupMembership()
-    {
-        return $this->principalBackend->getGroupMemberShip($this->principalProperties['uri']);
-    }
-
-    /**
-     * Sets a list of group members.
-     *
-     * If this principal is a group, this method sets all the group members.
-     * The list of members is always overwritten, never appended to.
-     *
-     * This method should throw an exception if the members could not be set.
-     */
-    public function setGroupMemberSet(array $groupMembers)
-    {
-        $this->principalBackend->setGroupMemberSet($this->principalProperties['uri'], $groupMembers);
-    }
-
-    /**
-     * Returns this principals name.
-     *
-     * @return string
-     */
-    public function getName()
-    {
-        $uri = $this->principalProperties['uri'];
-        list(, $name) = Uri\split($uri);
-
-        return $name;
-    }
-
-    /**
-     * Returns the name of the user.
-     *
-     * @return string
-     */
-    public function getDisplayName()
-    {
-        if (isset($this->principalProperties['{DAV:}displayname'])) {
-            return $this->principalProperties['{DAV:}displayname'];
-        } else {
-            return $this->getName();
-        }
-    }
-
-    /**
-     * Returns a list of properties.
-     *
-     * @param array $requestedProperties
-     *
-     * @return array
-     */
-    public function getProperties($requestedProperties)
-    {
-        $newProperties = [];
-        foreach ($requestedProperties as $propName) {
-            if (isset($this->principalProperties[$propName])) {
-                $newProperties[$propName] = $this->principalProperties[$propName];
-            }
-        }
-
-        return $newProperties;
-    }
-
-    /**
-     * Updates properties on this node.
-     *
-     * This method received a PropPatch object, which contains all the
-     * information about the update.
-     *
-     * To update specific properties, call the 'handle' method on this object.
-     * Read the PropPatch documentation for more information.
-     */
-    public function propPatch(DAV\PropPatch $propPatch)
-    {
-        return $this->principalBackend->updatePrincipal(
-            $this->principalProperties['uri'],
-            $propPatch
-        );
-    }
-
-    /**
-     * Returns the owner principal.
-     *
-     * This must be a url to a principal, or null if there's no owner
-     *
-     * @return string|null
-     */
-    public function getOwner()
-    {
-        return $this->principalProperties['uri'];
-    }
+	use ACLTrait;
+
+	/**
+	 * Struct with principal information.
+	 *
+	 * @var array
+	 */
+	protected $principalProperties;
+
+	/**
+	 * Principal backend.
+	 *
+	 * @var PrincipalBackend\BackendInterface
+	 */
+	protected $principalBackend;
+
+	/**
+	 * Creates the principal object.
+	 */
+	public function __construct(PrincipalBackend\BackendInterface $principalBackend, array $principalProperties = [])
+	{
+		if (!isset($principalProperties['uri'])) {
+			throw new DAV\Exception('The principal properties must at least contain the \'uri\' key');
+		}
+		$this->principalBackend = $principalBackend;
+		$this->principalProperties = $principalProperties;
+	}
+
+	/**
+	 * Returns the full principal url.
+	 *
+	 * @return string
+	 */
+	public function getPrincipalUrl()
+	{
+		return $this->principalProperties['uri'];
+	}
+
+	/**
+	 * Returns a list of alternative urls for a principal.
+	 *
+	 * This can for example be an email address, or ldap url.
+	 *
+	 * @return array
+	 */
+	public function getAlternateUriSet()
+	{
+		$uris = [];
+		if (isset($this->principalProperties['{DAV:}alternate-URI-set'])) {
+			$uris = $this->principalProperties['{DAV:}alternate-URI-set'];
+		}
+
+		if (isset($this->principalProperties['{http://sabredav.org/ns}email-address'])) {
+			$uris[] = 'mailto:'.$this->principalProperties['{http://sabredav.org/ns}email-address'];
+		}
+
+		return array_unique($uris);
+	}
+
+	/**
+	 * Returns the list of group members.
+	 *
+	 * If this principal is a group, this function should return
+	 * all member principal uri's for the group.
+	 *
+	 * @return array
+	 */
+	public function getGroupMemberSet()
+	{
+		return $this->principalBackend->getGroupMemberSet($this->principalProperties['uri']);
+	}
+
+	/**
+	 * Returns the list of groups this principal is member of.
+	 *
+	 * If this principal is a member of a (list of) groups, this function
+	 * should return a list of principal uri's for it's members.
+	 *
+	 * @return array
+	 */
+	public function getGroupMembership()
+	{
+		return $this->principalBackend->getGroupMemberShip($this->principalProperties['uri']);
+	}
+
+	/**
+	 * Sets a list of group members.
+	 *
+	 * If this principal is a group, this method sets all the group members.
+	 * The list of members is always overwritten, never appended to.
+	 *
+	 * This method should throw an exception if the members could not be set.
+	 */
+	public function setGroupMemberSet(array $groupMembers)
+	{
+		$this->principalBackend->setGroupMemberSet($this->principalProperties['uri'], $groupMembers);
+	}
+
+	/**
+	 * Returns this principals name.
+	 *
+	 * @return string
+	 */
+	public function getName()
+	{
+		$uri = $this->principalProperties['uri'];
+		list(, $name) = Uri\split($uri);
+
+		return $name;
+	}
+
+	/**
+	 * Returns the name of the user.
+	 *
+	 * @return string
+	 */
+	public function getDisplayName()
+	{
+		if (isset($this->principalProperties['{DAV:}displayname'])) {
+			return $this->principalProperties['{DAV:}displayname'];
+		} else {
+			return $this->getName();
+		}
+	}
+
+	/**
+	 * Returns a list of properties.
+	 *
+	 * @param array $requestedProperties
+	 *
+	 * @return array
+	 */
+	public function getProperties($requestedProperties)
+	{
+		$newProperties = [];
+		foreach ($requestedProperties as $propName) {
+			if (isset($this->principalProperties[$propName])) {
+				$newProperties[$propName] = $this->principalProperties[$propName];
+			}
+		}
+
+		return $newProperties;
+	}
+
+	/**
+	 * Updates properties on this node.
+	 *
+	 * This method received a PropPatch object, which contains all the
+	 * information about the update.
+	 *
+	 * To update specific properties, call the 'handle' method on this object.
+	 * Read the PropPatch documentation for more information.
+	 */
+	public function propPatch(DAV\PropPatch $propPatch)
+	{
+		return $this->principalBackend->updatePrincipal(
+			$this->principalProperties['uri'],
+			$propPatch
+		);
+	}
+
+	/**
+	 * Returns the owner principal.
+	 *
+	 * This must be a url to a principal, or null if there's no owner
+	 *
+	 * @return string|null
+	 */
+	public function getOwner()
+	{
+		return $this->principalProperties['uri'];
+	}
 }