path: root/vendor/sabre/dav/lib/CalDAV/Principal/User.php

<?php

declare(strict_types=1);

namespace Sabre\CalDAV\Principal;

use Sabre\DAV;
use Sabre\DAVACL;

/**
 * CalDAV principal.
 *
 * This is a standard user-principal for CalDAV. This principal is also a
 * collection and returns the caldav-proxy-read and caldav-proxy-write child
 * principals.
 *
 * @copyright Copyright (C) fruux GmbH (https://fruux.com/)
 * @author Evert Pot (http://evertpot.com/)
 * @license http://sabre.io/license/ Modified BSD License
 */
class User extends DAVACL\Principal implements DAV\ICollection
{
    /**
     * Creates a new file in the directory.
     *
     * @param string   $name Name of the file
     * @param resource $data initial payload, passed as a readable stream resource
     *
     * @throws DAV\Exception\Forbidden
     */
    public function createFile($name, $data = null)
    {
        throw new DAV\Exception\Forbidden('Permission denied to create file (filename '.$name.')');
    }

    /**
     * Creates a new subdirectory.
     *
     * @param string $name
     *
     * @throws DAV\Exception\Forbidden
     */
    public function createDirectory($name)
    {
        throw new DAV\Exception\Forbidden('Permission denied to create directory');
    }

    /**
     * Returns a specific child node, referenced by its name.
     *
     * @param string $name
     *
     * @return DAV\INode
     */
    public function getChild($name)
    {
        $principal = $this->principalBackend->getPrincipalByPath($this->getPrincipalURL().'/'.$name);
        if (!$principal) {
            throw new DAV\Exception\NotFound('Node with name '.$name.' was not found');
        }
        if ('calendar-proxy-read' === $name) {
            return new ProxyRead($this->principalBackend, $this->principalProperties);
        }

        if ('calendar-proxy-write' === $name) {
            return new ProxyWrite($this->principalBackend, $this->principalProperties);
        }

        throw new DAV\Exception\NotFound('Node with name '.$name.' was not found');
    }

    /**
     * Returns an array with all the child nodes.
     *
     * @return DAV\INode[]
     */
    public function getChildren()
    {
        $r = [];
        if ($this->principalBackend->getPrincipalByPath($this->getPrincipalURL().'/calendar-proxy-read')) {
            $r[] = new ProxyRead($this->principalBackend, $this->principalProperties);
        }
        if ($this->principalBackend->getPrincipalByPath($this->getPrincipalURL().'/calendar-proxy-write')) {
            $r[] = new ProxyWrite($this->principalBackend, $this->principalProperties);
        }

        return $r;
    }

    /**
     * Returns whether or not the child node exists.
     *
     * @param string $name
     *
     * @return bool
     */
    public function childExists($name)
    {
        try {
            $this->getChild($name);

            return true;
        } catch (DAV\Exception\NotFound $e) {
            return false;
        }
    }

    /**
     * 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()
    {
        $acl = parent::getACL();
        $acl[] = [
            'privilege' => '{DAV:}read',
            'principal' => $this->principalProperties['uri'].'/calendar-proxy-read',
            'protected' => true,
        ];
        $acl[] = [
            'privilege' => '{DAV:}read',
            'principal' => $this->principalProperties['uri'].'/calendar-proxy-write',
            'protected' => true,
        ];

        return $acl;
    }
}