@@ -29,41 +29,41 @@ |
||
| 29 | 29 | |
| 30 | 30 | class Admin implements ISettings { |
| 31 | 31 | |
| 32 | - /** @var TrustedServers */ |
|
| 33 | - private $trustedServers; |
|
| 32 | + /** @var TrustedServers */ |
|
| 33 | + private $trustedServers; |
|
| 34 | 34 | |
| 35 | - public function __construct(TrustedServers $trustedServers) { |
|
| 36 | - $this->trustedServers = $trustedServers; |
|
| 37 | - } |
|
| 35 | + public function __construct(TrustedServers $trustedServers) { |
|
| 36 | + $this->trustedServers = $trustedServers; |
|
| 37 | + } |
|
| 38 | 38 | |
| 39 | - /** |
|
| 40 | - * @return TemplateResponse |
|
| 41 | - */ |
|
| 42 | - public function getForm() { |
|
| 43 | - $parameters = [ |
|
| 44 | - 'trustedServers' => $this->trustedServers->getServers(), |
|
| 45 | - 'autoAddServers' => $this->trustedServers->getAutoAddServers(), |
|
| 46 | - ]; |
|
| 39 | + /** |
|
| 40 | + * @return TemplateResponse |
|
| 41 | + */ |
|
| 42 | + public function getForm() { |
|
| 43 | + $parameters = [ |
|
| 44 | + 'trustedServers' => $this->trustedServers->getServers(), |
|
| 45 | + 'autoAddServers' => $this->trustedServers->getAutoAddServers(), |
|
| 46 | + ]; |
|
| 47 | 47 | |
| 48 | - return new TemplateResponse('federation', 'settings-admin', $parameters, ''); |
|
| 49 | - } |
|
| 48 | + return new TemplateResponse('federation', 'settings-admin', $parameters, ''); |
|
| 49 | + } |
|
| 50 | 50 | |
| 51 | - /** |
|
| 52 | - * @return string the section ID, e.g. 'sharing' |
|
| 53 | - */ |
|
| 54 | - public function getSection() { |
|
| 55 | - return 'sharing'; |
|
| 56 | - } |
|
| 51 | + /** |
|
| 52 | + * @return string the section ID, e.g. 'sharing' |
|
| 53 | + */ |
|
| 54 | + public function getSection() { |
|
| 55 | + return 'sharing'; |
|
| 56 | + } |
|
| 57 | 57 | |
| 58 | - /** |
|
| 59 | - * @return int whether the form should be rather on the top or bottom of |
|
| 60 | - * the admin section. The forms are arranged in ascending order of the |
|
| 61 | - * priority values. It is required to return a value between 0 and 100. |
|
| 62 | - * |
|
| 63 | - * E.g.: 70 |
|
| 64 | - */ |
|
| 65 | - public function getPriority() { |
|
| 66 | - return 30; |
|
| 67 | - } |
|
| 58 | + /** |
|
| 59 | + * @return int whether the form should be rather on the top or bottom of |
|
| 60 | + * the admin section. The forms are arranged in ascending order of the |
|
| 61 | + * priority values. It is required to return a value between 0 and 100. |
|
| 62 | + * |
|
| 63 | + * E.g.: 70 |
|
| 64 | + */ |
|
| 65 | + public function getPriority() { |
|
| 66 | + return 30; |
|
| 67 | + } |
|
| 68 | 68 | |
| 69 | 69 | } |
@@ -27,25 +27,25 @@ |
||
| 27 | 27 | |
| 28 | 28 | class Hooks { |
| 29 | 29 | |
| 30 | - /** @var TrustedServers */ |
|
| 31 | - private $trustedServers; |
|
| 32 | - |
|
| 33 | - public function __construct(TrustedServers $trustedServers) { |
|
| 34 | - $this->trustedServers = $trustedServers; |
|
| 35 | - } |
|
| 36 | - |
|
| 37 | - /** |
|
| 38 | - * add servers to the list of trusted servers once a federated share was established |
|
| 39 | - * |
|
| 40 | - * @param array $params |
|
| 41 | - */ |
|
| 42 | - public function addServerHook($params) { |
|
| 43 | - if ( |
|
| 44 | - $this->trustedServers->getAutoAddServers() === true && |
|
| 45 | - $this->trustedServers->isTrustedServer($params['server']) === false |
|
| 46 | - ) { |
|
| 47 | - $this->trustedServers->addServer($params['server']); |
|
| 48 | - } |
|
| 49 | - } |
|
| 30 | + /** @var TrustedServers */ |
|
| 31 | + private $trustedServers; |
|
| 32 | + |
|
| 33 | + public function __construct(TrustedServers $trustedServers) { |
|
| 34 | + $this->trustedServers = $trustedServers; |
|
| 35 | + } |
|
| 36 | + |
|
| 37 | + /** |
|
| 38 | + * add servers to the list of trusted servers once a federated share was established |
|
| 39 | + * |
|
| 40 | + * @param array $params |
|
| 41 | + */ |
|
| 42 | + public function addServerHook($params) { |
|
| 43 | + if ( |
|
| 44 | + $this->trustedServers->getAutoAddServers() === true && |
|
| 45 | + $this->trustedServers->isTrustedServer($params['server']) === false |
|
| 46 | + ) { |
|
| 47 | + $this->trustedServers->addServer($params['server']); |
|
| 48 | + } |
|
| 49 | + } |
|
| 50 | 50 | |
| 51 | 51 | } |
@@ -26,67 +26,67 @@ |
||
| 26 | 26 | |
| 27 | 27 | class PublicAuth implements BackendInterface { |
| 28 | 28 | |
| 29 | - /** @var string[] */ |
|
| 30 | - private $publicURLs; |
|
| 29 | + /** @var string[] */ |
|
| 30 | + private $publicURLs; |
|
| 31 | 31 | |
| 32 | - public function __construct() { |
|
| 33 | - $this->publicURLs = [ |
|
| 34 | - 'public-calendars', |
|
| 35 | - 'principals/system/public' |
|
| 36 | - ]; |
|
| 37 | - } |
|
| 32 | + public function __construct() { |
|
| 33 | + $this->publicURLs = [ |
|
| 34 | + 'public-calendars', |
|
| 35 | + 'principals/system/public' |
|
| 36 | + ]; |
|
| 37 | + } |
|
| 38 | 38 | |
| 39 | - /** |
|
| 40 | - * When this method is called, the backend must check if authentication was |
|
| 41 | - * successful. |
|
| 42 | - * |
|
| 43 | - * The returned value must be one of the following |
|
| 44 | - * |
|
| 45 | - * [true, "principals/username"] |
|
| 46 | - * [false, "reason for failure"] |
|
| 47 | - * |
|
| 48 | - * If authentication was successful, it's expected that the authentication |
|
| 49 | - * backend returns a so-called principal url. |
|
| 50 | - * |
|
| 51 | - * Examples of a principal url: |
|
| 52 | - * |
|
| 53 | - * principals/admin |
|
| 54 | - * principals/user1 |
|
| 55 | - * principals/users/joe |
|
| 56 | - * principals/uid/123457 |
|
| 57 | - * |
|
| 58 | - * If you don't use WebDAV ACL (RFC3744) we recommend that you simply |
|
| 59 | - * return a string such as: |
|
| 60 | - * |
|
| 61 | - * principals/users/[username] |
|
| 62 | - * |
|
| 63 | - * @param RequestInterface $request |
|
| 64 | - * @param ResponseInterface $response |
|
| 65 | - * @return array |
|
| 66 | - */ |
|
| 67 | - function check(RequestInterface $request, ResponseInterface $response) { |
|
| 39 | + /** |
|
| 40 | + * When this method is called, the backend must check if authentication was |
|
| 41 | + * successful. |
|
| 42 | + * |
|
| 43 | + * The returned value must be one of the following |
|
| 44 | + * |
|
| 45 | + * [true, "principals/username"] |
|
| 46 | + * [false, "reason for failure"] |
|
| 47 | + * |
|
| 48 | + * If authentication was successful, it's expected that the authentication |
|
| 49 | + * backend returns a so-called principal url. |
|
| 50 | + * |
|
| 51 | + * Examples of a principal url: |
|
| 52 | + * |
|
| 53 | + * principals/admin |
|
| 54 | + * principals/user1 |
|
| 55 | + * principals/users/joe |
|
| 56 | + * principals/uid/123457 |
|
| 57 | + * |
|
| 58 | + * If you don't use WebDAV ACL (RFC3744) we recommend that you simply |
|
| 59 | + * return a string such as: |
|
| 60 | + * |
|
| 61 | + * principals/users/[username] |
|
| 62 | + * |
|
| 63 | + * @param RequestInterface $request |
|
| 64 | + * @param ResponseInterface $response |
|
| 65 | + * @return array |
|
| 66 | + */ |
|
| 67 | + function check(RequestInterface $request, ResponseInterface $response) { |
|
| 68 | 68 | |
| 69 | - if ($this->isRequestPublic($request)) { |
|
| 70 | - return [true, "principals/system/public"]; |
|
| 71 | - } |
|
| 72 | - return [false, "No public access to this resource."]; |
|
| 73 | - } |
|
| 69 | + if ($this->isRequestPublic($request)) { |
|
| 70 | + return [true, "principals/system/public"]; |
|
| 71 | + } |
|
| 72 | + return [false, "No public access to this resource."]; |
|
| 73 | + } |
|
| 74 | 74 | |
| 75 | - /** |
|
| 76 | - * @inheritdoc |
|
| 77 | - */ |
|
| 78 | - function challenge(RequestInterface $request, ResponseInterface $response) { |
|
| 79 | - } |
|
| 75 | + /** |
|
| 76 | + * @inheritdoc |
|
| 77 | + */ |
|
| 78 | + function challenge(RequestInterface $request, ResponseInterface $response) { |
|
| 79 | + } |
|
| 80 | 80 | |
| 81 | - /** |
|
| 82 | - * @param RequestInterface $request |
|
| 83 | - * @return bool |
|
| 84 | - */ |
|
| 85 | - private function isRequestPublic(RequestInterface $request) { |
|
| 86 | - $url = $request->getPath(); |
|
| 87 | - $matchingUrls = array_filter($this->publicURLs, function ($publicUrl) use ($url) { |
|
| 88 | - return strpos($url, $publicUrl, 0) === 0; |
|
| 89 | - }); |
|
| 90 | - return !empty($matchingUrls); |
|
| 91 | - } |
|
| 81 | + /** |
|
| 82 | + * @param RequestInterface $request |
|
| 83 | + * @return bool |
|
| 84 | + */ |
|
| 85 | + private function isRequestPublic(RequestInterface $request) { |
|
| 86 | + $url = $request->getPath(); |
|
| 87 | + $matchingUrls = array_filter($this->publicURLs, function ($publicUrl) use ($url) { |
|
| 88 | + return strpos($url, $publicUrl, 0) === 0; |
|
| 89 | + }); |
|
| 90 | + return !empty($matchingUrls); |
|
| 91 | + } |
|
| 92 | 92 | } |
@@ -41,130 +41,130 @@ |
||
| 41 | 41 | */ |
| 42 | 42 | class Invite implements XmlSerializable { |
| 43 | 43 | |
| 44 | - /** |
|
| 45 | - * The list of users a calendar has been shared to. |
|
| 46 | - * |
|
| 47 | - * @var array |
|
| 48 | - */ |
|
| 49 | - protected $users; |
|
| 50 | - |
|
| 51 | - /** |
|
| 52 | - * The organizer contains information about the person who shared the |
|
| 53 | - * object. |
|
| 54 | - * |
|
| 55 | - * @var array|null |
|
| 56 | - */ |
|
| 57 | - protected $organizer; |
|
| 58 | - |
|
| 59 | - /** |
|
| 60 | - * Creates the property. |
|
| 61 | - * |
|
| 62 | - * Users is an array. Each element of the array has the following |
|
| 63 | - * properties: |
|
| 64 | - * |
|
| 65 | - * * href - Often a mailto: address |
|
| 66 | - * * commonName - Optional, for example a first and lastname for a user. |
|
| 67 | - * * status - One of the SharingPlugin::STATUS_* constants. |
|
| 68 | - * * readOnly - true or false |
|
| 69 | - * * summary - Optional, description of the share |
|
| 70 | - * |
|
| 71 | - * The organizer key is optional to specify. It's only useful when a |
|
| 72 | - * 'sharee' requests the sharing information. |
|
| 73 | - * |
|
| 74 | - * The organizer may have the following properties: |
|
| 75 | - * * href - Often a mailto: address. |
|
| 76 | - * * commonName - Optional human-readable name. |
|
| 77 | - * * firstName - Optional first name. |
|
| 78 | - * * lastName - Optional last name. |
|
| 79 | - * |
|
| 80 | - * If you wonder why these two structures are so different, I guess a |
|
| 81 | - * valid answer is that the current spec is still a draft. |
|
| 82 | - * |
|
| 83 | - * @param array $users |
|
| 84 | - */ |
|
| 85 | - function __construct(array $users, array $organizer = null) { |
|
| 86 | - |
|
| 87 | - $this->users = $users; |
|
| 88 | - $this->organizer = $organizer; |
|
| 89 | - |
|
| 90 | - } |
|
| 91 | - |
|
| 92 | - /** |
|
| 93 | - * Returns the list of users, as it was passed to the constructor. |
|
| 94 | - * |
|
| 95 | - * @return array |
|
| 96 | - */ |
|
| 97 | - function getValue() { |
|
| 98 | - |
|
| 99 | - return $this->users; |
|
| 100 | - |
|
| 101 | - } |
|
| 102 | - |
|
| 103 | - /** |
|
| 104 | - * The xmlSerialize metod is called during xml writing. |
|
| 105 | - * |
|
| 106 | - * Use the $writer argument to write its own xml serialization. |
|
| 107 | - * |
|
| 108 | - * An important note: do _not_ create a parent element. Any element |
|
| 109 | - * implementing XmlSerializble should only ever write what's considered |
|
| 110 | - * its 'inner xml'. |
|
| 111 | - * |
|
| 112 | - * The parent of the current element is responsible for writing a |
|
| 113 | - * containing element. |
|
| 114 | - * |
|
| 115 | - * This allows serializers to be re-used for different element names. |
|
| 116 | - * |
|
| 117 | - * If you are opening new elements, you must also close them again. |
|
| 118 | - * |
|
| 119 | - * @param Writer $writer |
|
| 120 | - * @return void |
|
| 121 | - */ |
|
| 122 | - function xmlSerialize(Writer $writer) { |
|
| 123 | - |
|
| 124 | - $cs = '{' . Plugin::NS_OWNCLOUD . '}'; |
|
| 125 | - |
|
| 126 | - if (!is_null($this->organizer)) { |
|
| 127 | - |
|
| 128 | - $writer->startElement($cs . 'organizer'); |
|
| 129 | - $writer->writeElement('{DAV:}href', $this->organizer['href']); |
|
| 130 | - |
|
| 131 | - if (isset($this->organizer['commonName']) && $this->organizer['commonName']) { |
|
| 132 | - $writer->writeElement($cs . 'common-name', $this->organizer['commonName']); |
|
| 133 | - } |
|
| 134 | - if (isset($this->organizer['firstName']) && $this->organizer['firstName']) { |
|
| 135 | - $writer->writeElement($cs . 'first-name', $this->organizer['firstName']); |
|
| 136 | - } |
|
| 137 | - if (isset($this->organizer['lastName']) && $this->organizer['lastName']) { |
|
| 138 | - $writer->writeElement($cs . 'last-name', $this->organizer['lastName']); |
|
| 139 | - } |
|
| 140 | - $writer->endElement(); // organizer |
|
| 141 | - |
|
| 142 | - } |
|
| 143 | - |
|
| 144 | - foreach ($this->users as $user) { |
|
| 145 | - |
|
| 146 | - $writer->startElement($cs . 'user'); |
|
| 147 | - $writer->writeElement('{DAV:}href', $user['href']); |
|
| 148 | - if (isset($user['commonName']) && $user['commonName']) { |
|
| 149 | - $writer->writeElement($cs . 'common-name', $user['commonName']); |
|
| 150 | - } |
|
| 151 | - $writer->writeElement($cs . 'invite-accepted'); |
|
| 152 | - |
|
| 153 | - $writer->startElement($cs . 'access'); |
|
| 154 | - if ($user['readOnly']) { |
|
| 155 | - $writer->writeElement($cs . 'read'); |
|
| 156 | - } else { |
|
| 157 | - $writer->writeElement($cs . 'read-write'); |
|
| 158 | - } |
|
| 159 | - $writer->endElement(); // access |
|
| 160 | - |
|
| 161 | - if (isset($user['summary']) && $user['summary']) { |
|
| 162 | - $writer->writeElement($cs . 'summary', $user['summary']); |
|
| 163 | - } |
|
| 164 | - |
|
| 165 | - $writer->endElement(); //user |
|
| 166 | - |
|
| 167 | - } |
|
| 168 | - |
|
| 169 | - } |
|
| 44 | + /** |
|
| 45 | + * The list of users a calendar has been shared to. |
|
| 46 | + * |
|
| 47 | + * @var array |
|
| 48 | + */ |
|
| 49 | + protected $users; |
|
| 50 | + |
|
| 51 | + /** |
|
| 52 | + * The organizer contains information about the person who shared the |
|
| 53 | + * object. |
|
| 54 | + * |
|
| 55 | + * @var array|null |
|
| 56 | + */ |
|
| 57 | + protected $organizer; |
|
| 58 | + |
|
| 59 | + /** |
|
| 60 | + * Creates the property. |
|
| 61 | + * |
|
| 62 | + * Users is an array. Each element of the array has the following |
|
| 63 | + * properties: |
|
| 64 | + * |
|
| 65 | + * * href - Often a mailto: address |
|
| 66 | + * * commonName - Optional, for example a first and lastname for a user. |
|
| 67 | + * * status - One of the SharingPlugin::STATUS_* constants. |
|
| 68 | + * * readOnly - true or false |
|
| 69 | + * * summary - Optional, description of the share |
|
| 70 | + * |
|
| 71 | + * The organizer key is optional to specify. It's only useful when a |
|
| 72 | + * 'sharee' requests the sharing information. |
|
| 73 | + * |
|
| 74 | + * The organizer may have the following properties: |
|
| 75 | + * * href - Often a mailto: address. |
|
| 76 | + * * commonName - Optional human-readable name. |
|
| 77 | + * * firstName - Optional first name. |
|
| 78 | + * * lastName - Optional last name. |
|
| 79 | + * |
|
| 80 | + * If you wonder why these two structures are so different, I guess a |
|
| 81 | + * valid answer is that the current spec is still a draft. |
|
| 82 | + * |
|
| 83 | + * @param array $users |
|
| 84 | + */ |
|
| 85 | + function __construct(array $users, array $organizer = null) { |
|
| 86 | + |
|
| 87 | + $this->users = $users; |
|
| 88 | + $this->organizer = $organizer; |
|
| 89 | + |
|
| 90 | + } |
|
| 91 | + |
|
| 92 | + /** |
|
| 93 | + * Returns the list of users, as it was passed to the constructor. |
|
| 94 | + * |
|
| 95 | + * @return array |
|
| 96 | + */ |
|
| 97 | + function getValue() { |
|
| 98 | + |
|
| 99 | + return $this->users; |
|
| 100 | + |
|
| 101 | + } |
|
| 102 | + |
|
| 103 | + /** |
|
| 104 | + * The xmlSerialize metod is called during xml writing. |
|
| 105 | + * |
|
| 106 | + * Use the $writer argument to write its own xml serialization. |
|
| 107 | + * |
|
| 108 | + * An important note: do _not_ create a parent element. Any element |
|
| 109 | + * implementing XmlSerializble should only ever write what's considered |
|
| 110 | + * its 'inner xml'. |
|
| 111 | + * |
|
| 112 | + * The parent of the current element is responsible for writing a |
|
| 113 | + * containing element. |
|
| 114 | + * |
|
| 115 | + * This allows serializers to be re-used for different element names. |
|
| 116 | + * |
|
| 117 | + * If you are opening new elements, you must also close them again. |
|
| 118 | + * |
|
| 119 | + * @param Writer $writer |
|
| 120 | + * @return void |
|
| 121 | + */ |
|
| 122 | + function xmlSerialize(Writer $writer) { |
|
| 123 | + |
|
| 124 | + $cs = '{' . Plugin::NS_OWNCLOUD . '}'; |
|
| 125 | + |
|
| 126 | + if (!is_null($this->organizer)) { |
|
| 127 | + |
|
| 128 | + $writer->startElement($cs . 'organizer'); |
|
| 129 | + $writer->writeElement('{DAV:}href', $this->organizer['href']); |
|
| 130 | + |
|
| 131 | + if (isset($this->organizer['commonName']) && $this->organizer['commonName']) { |
|
| 132 | + $writer->writeElement($cs . 'common-name', $this->organizer['commonName']); |
|
| 133 | + } |
|
| 134 | + if (isset($this->organizer['firstName']) && $this->organizer['firstName']) { |
|
| 135 | + $writer->writeElement($cs . 'first-name', $this->organizer['firstName']); |
|
| 136 | + } |
|
| 137 | + if (isset($this->organizer['lastName']) && $this->organizer['lastName']) { |
|
| 138 | + $writer->writeElement($cs . 'last-name', $this->organizer['lastName']); |
|
| 139 | + } |
|
| 140 | + $writer->endElement(); // organizer |
|
| 141 | + |
|
| 142 | + } |
|
| 143 | + |
|
| 144 | + foreach ($this->users as $user) { |
|
| 145 | + |
|
| 146 | + $writer->startElement($cs . 'user'); |
|
| 147 | + $writer->writeElement('{DAV:}href', $user['href']); |
|
| 148 | + if (isset($user['commonName']) && $user['commonName']) { |
|
| 149 | + $writer->writeElement($cs . 'common-name', $user['commonName']); |
|
| 150 | + } |
|
| 151 | + $writer->writeElement($cs . 'invite-accepted'); |
|
| 152 | + |
|
| 153 | + $writer->startElement($cs . 'access'); |
|
| 154 | + if ($user['readOnly']) { |
|
| 155 | + $writer->writeElement($cs . 'read'); |
|
| 156 | + } else { |
|
| 157 | + $writer->writeElement($cs . 'read-write'); |
|
| 158 | + } |
|
| 159 | + $writer->endElement(); // access |
|
| 160 | + |
|
| 161 | + if (isset($user['summary']) && $user['summary']) { |
|
| 162 | + $writer->writeElement($cs . 'summary', $user['summary']); |
|
| 163 | + } |
|
| 164 | + |
|
| 165 | + $writer->endElement(); //user |
|
| 166 | + |
|
| 167 | + } |
|
| 168 | + |
|
| 169 | + } |
|
| 170 | 170 | } |
@@ -28,48 +28,48 @@ |
||
| 28 | 28 | */ |
| 29 | 29 | interface IShareable extends INode { |
| 30 | 30 | |
| 31 | - /** |
|
| 32 | - * Updates the list of shares. |
|
| 33 | - * |
|
| 34 | - * The first array is a list of people that are to be added to the |
|
| 35 | - * resource. |
|
| 36 | - * |
|
| 37 | - * Every element in the add array has the following properties: |
|
| 38 | - * * href - A url. Usually a mailto: address |
|
| 39 | - * * commonName - Usually a first and last name, or false |
|
| 40 | - * * summary - A description of the share, can also be false |
|
| 41 | - * * readOnly - A boolean value |
|
| 42 | - * |
|
| 43 | - * Every element in the remove array is just the address string. |
|
| 44 | - * |
|
| 45 | - * @param array $add |
|
| 46 | - * @param array $remove |
|
| 47 | - * @return void |
|
| 48 | - */ |
|
| 49 | - function updateShares(array $add, array $remove); |
|
| 31 | + /** |
|
| 32 | + * Updates the list of shares. |
|
| 33 | + * |
|
| 34 | + * The first array is a list of people that are to be added to the |
|
| 35 | + * resource. |
|
| 36 | + * |
|
| 37 | + * Every element in the add array has the following properties: |
|
| 38 | + * * href - A url. Usually a mailto: address |
|
| 39 | + * * commonName - Usually a first and last name, or false |
|
| 40 | + * * summary - A description of the share, can also be false |
|
| 41 | + * * readOnly - A boolean value |
|
| 42 | + * |
|
| 43 | + * Every element in the remove array is just the address string. |
|
| 44 | + * |
|
| 45 | + * @param array $add |
|
| 46 | + * @param array $remove |
|
| 47 | + * @return void |
|
| 48 | + */ |
|
| 49 | + function updateShares(array $add, array $remove); |
|
| 50 | 50 | |
| 51 | - /** |
|
| 52 | - * Returns the list of people whom this resource is shared with. |
|
| 53 | - * |
|
| 54 | - * Every element in this array should have the following properties: |
|
| 55 | - * * href - Often a mailto: address |
|
| 56 | - * * commonName - Optional, for example a first + last name |
|
| 57 | - * * status - See the Sabre\CalDAV\SharingPlugin::STATUS_ constants. |
|
| 58 | - * * readOnly - boolean |
|
| 59 | - * * summary - Optional, a description for the share |
|
| 60 | - * |
|
| 61 | - * @return array |
|
| 62 | - */ |
|
| 63 | - function getShares(); |
|
| 51 | + /** |
|
| 52 | + * Returns the list of people whom this resource is shared with. |
|
| 53 | + * |
|
| 54 | + * Every element in this array should have the following properties: |
|
| 55 | + * * href - Often a mailto: address |
|
| 56 | + * * commonName - Optional, for example a first + last name |
|
| 57 | + * * status - See the Sabre\CalDAV\SharingPlugin::STATUS_ constants. |
|
| 58 | + * * readOnly - boolean |
|
| 59 | + * * summary - Optional, a description for the share |
|
| 60 | + * |
|
| 61 | + * @return array |
|
| 62 | + */ |
|
| 63 | + function getShares(); |
|
| 64 | 64 | |
| 65 | - /** |
|
| 66 | - * @return int |
|
| 67 | - */ |
|
| 68 | - public function getResourceId(); |
|
| 65 | + /** |
|
| 66 | + * @return int |
|
| 67 | + */ |
|
| 68 | + public function getResourceId(); |
|
| 69 | 69 | |
| 70 | - /** |
|
| 71 | - * @return string |
|
| 72 | - */ |
|
| 73 | - public function getOwner(); |
|
| 70 | + /** |
|
| 71 | + * @return string |
|
| 72 | + */ |
|
| 73 | + public function getOwner(); |
|
| 74 | 74 | |
| 75 | 75 | } |
| 76 | 76 | \ No newline at end of file |
@@ -43,85 +43,85 @@ |
||
| 43 | 43 | */ |
| 44 | 44 | class EntityTypeCollection extends RootCollection { |
| 45 | 45 | |
| 46 | - /** @var ILogger */ |
|
| 47 | - protected $logger; |
|
| 46 | + /** @var ILogger */ |
|
| 47 | + protected $logger; |
|
| 48 | 48 | |
| 49 | - /** @var IUserManager */ |
|
| 50 | - protected $userManager; |
|
| 49 | + /** @var IUserManager */ |
|
| 50 | + protected $userManager; |
|
| 51 | 51 | |
| 52 | - /** @var \Closure */ |
|
| 53 | - protected $childExistsFunction; |
|
| 52 | + /** @var \Closure */ |
|
| 53 | + protected $childExistsFunction; |
|
| 54 | 54 | |
| 55 | - /** |
|
| 56 | - * @param string $name |
|
| 57 | - * @param ICommentsManager $commentsManager |
|
| 58 | - * @param IUserManager $userManager |
|
| 59 | - * @param IUserSession $userSession |
|
| 60 | - * @param ILogger $logger |
|
| 61 | - * @param \Closure $childExistsFunction |
|
| 62 | - */ |
|
| 63 | - public function __construct( |
|
| 64 | - $name, |
|
| 65 | - ICommentsManager $commentsManager, |
|
| 66 | - IUserManager $userManager, |
|
| 67 | - IUserSession $userSession, |
|
| 68 | - ILogger $logger, |
|
| 69 | - \Closure $childExistsFunction |
|
| 70 | - ) { |
|
| 71 | - $name = trim($name); |
|
| 72 | - if(empty($name) || !is_string($name)) { |
|
| 73 | - throw new \InvalidArgumentException('"name" parameter must be non-empty string'); |
|
| 74 | - } |
|
| 75 | - $this->name = $name; |
|
| 76 | - $this->commentsManager = $commentsManager; |
|
| 77 | - $this->logger = $logger; |
|
| 78 | - $this->userManager = $userManager; |
|
| 79 | - $this->userSession = $userSession; |
|
| 80 | - $this->childExistsFunction = $childExistsFunction; |
|
| 81 | - } |
|
| 55 | + /** |
|
| 56 | + * @param string $name |
|
| 57 | + * @param ICommentsManager $commentsManager |
|
| 58 | + * @param IUserManager $userManager |
|
| 59 | + * @param IUserSession $userSession |
|
| 60 | + * @param ILogger $logger |
|
| 61 | + * @param \Closure $childExistsFunction |
|
| 62 | + */ |
|
| 63 | + public function __construct( |
|
| 64 | + $name, |
|
| 65 | + ICommentsManager $commentsManager, |
|
| 66 | + IUserManager $userManager, |
|
| 67 | + IUserSession $userSession, |
|
| 68 | + ILogger $logger, |
|
| 69 | + \Closure $childExistsFunction |
|
| 70 | + ) { |
|
| 71 | + $name = trim($name); |
|
| 72 | + if(empty($name) || !is_string($name)) { |
|
| 73 | + throw new \InvalidArgumentException('"name" parameter must be non-empty string'); |
|
| 74 | + } |
|
| 75 | + $this->name = $name; |
|
| 76 | + $this->commentsManager = $commentsManager; |
|
| 77 | + $this->logger = $logger; |
|
| 78 | + $this->userManager = $userManager; |
|
| 79 | + $this->userSession = $userSession; |
|
| 80 | + $this->childExistsFunction = $childExistsFunction; |
|
| 81 | + } |
|
| 82 | 82 | |
| 83 | - /** |
|
| 84 | - * Returns a specific child node, referenced by its name |
|
| 85 | - * |
|
| 86 | - * This method must throw Sabre\DAV\Exception\NotFound if the node does not |
|
| 87 | - * exist. |
|
| 88 | - * |
|
| 89 | - * @param string $name |
|
| 90 | - * @return \Sabre\DAV\INode |
|
| 91 | - * @throws NotFound |
|
| 92 | - */ |
|
| 93 | - function getChild($name) { |
|
| 94 | - if(!$this->childExists($name)) { |
|
| 95 | - throw new NotFound('Entity does not exist or is not available'); |
|
| 96 | - } |
|
| 97 | - return new EntityCollection( |
|
| 98 | - $name, |
|
| 99 | - $this->name, |
|
| 100 | - $this->commentsManager, |
|
| 101 | - $this->userManager, |
|
| 102 | - $this->userSession, |
|
| 103 | - $this->logger |
|
| 104 | - ); |
|
| 105 | - } |
|
| 83 | + /** |
|
| 84 | + * Returns a specific child node, referenced by its name |
|
| 85 | + * |
|
| 86 | + * This method must throw Sabre\DAV\Exception\NotFound if the node does not |
|
| 87 | + * exist. |
|
| 88 | + * |
|
| 89 | + * @param string $name |
|
| 90 | + * @return \Sabre\DAV\INode |
|
| 91 | + * @throws NotFound |
|
| 92 | + */ |
|
| 93 | + function getChild($name) { |
|
| 94 | + if(!$this->childExists($name)) { |
|
| 95 | + throw new NotFound('Entity does not exist or is not available'); |
|
| 96 | + } |
|
| 97 | + return new EntityCollection( |
|
| 98 | + $name, |
|
| 99 | + $this->name, |
|
| 100 | + $this->commentsManager, |
|
| 101 | + $this->userManager, |
|
| 102 | + $this->userSession, |
|
| 103 | + $this->logger |
|
| 104 | + ); |
|
| 105 | + } |
|
| 106 | 106 | |
| 107 | - /** |
|
| 108 | - * Returns an array with all the child nodes |
|
| 109 | - * |
|
| 110 | - * @return \Sabre\DAV\INode[] |
|
| 111 | - * @throws MethodNotAllowed |
|
| 112 | - */ |
|
| 113 | - function getChildren() { |
|
| 114 | - throw new MethodNotAllowed('No permission to list folder contents'); |
|
| 115 | - } |
|
| 107 | + /** |
|
| 108 | + * Returns an array with all the child nodes |
|
| 109 | + * |
|
| 110 | + * @return \Sabre\DAV\INode[] |
|
| 111 | + * @throws MethodNotAllowed |
|
| 112 | + */ |
|
| 113 | + function getChildren() { |
|
| 114 | + throw new MethodNotAllowed('No permission to list folder contents'); |
|
| 115 | + } |
|
| 116 | 116 | |
| 117 | - /** |
|
| 118 | - * Checks if a child-node with the specified name exists |
|
| 119 | - * |
|
| 120 | - * @param string $name |
|
| 121 | - * @return bool |
|
| 122 | - */ |
|
| 123 | - function childExists($name) { |
|
| 124 | - return call_user_func($this->childExistsFunction, $name); |
|
| 125 | - } |
|
| 117 | + /** |
|
| 118 | + * Checks if a child-node with the specified name exists |
|
| 119 | + * |
|
| 120 | + * @param string $name |
|
| 121 | + * @return bool |
|
| 122 | + */ |
|
| 123 | + function childExists($name) { |
|
| 124 | + return call_user_func($this->childExistsFunction, $name); |
|
| 125 | + } |
|
| 126 | 126 | |
| 127 | 127 | } |
@@ -36,270 +36,270 @@ |
||
| 36 | 36 | use Sabre\DAV\PropPatch; |
| 37 | 37 | |
| 38 | 38 | class CommentNode implements \Sabre\DAV\INode, \Sabre\DAV\IProperties { |
| 39 | - const NS_OWNCLOUD = 'http://owncloud.org/ns'; |
|
| 39 | + const NS_OWNCLOUD = 'http://owncloud.org/ns'; |
|
| 40 | 40 | |
| 41 | - const PROPERTY_NAME_UNREAD = '{http://owncloud.org/ns}isUnread'; |
|
| 42 | - const PROPERTY_NAME_MESSAGE = '{http://owncloud.org/ns}message'; |
|
| 43 | - const PROPERTY_NAME_ACTOR_DISPLAYNAME = '{http://owncloud.org/ns}actorDisplayName'; |
|
| 44 | - const PROPERTY_NAME_MENTIONS = '{http://owncloud.org/ns}mentions'; |
|
| 45 | - const PROPERTY_NAME_MENTION = '{http://owncloud.org/ns}mention'; |
|
| 46 | - const PROPERTY_NAME_MENTION_TYPE = '{http://owncloud.org/ns}mentionType'; |
|
| 47 | - const PROPERTY_NAME_MENTION_ID = '{http://owncloud.org/ns}mentionId'; |
|
| 48 | - const PROPERTY_NAME_MENTION_DISPLAYNAME = '{http://owncloud.org/ns}mentionDisplayName'; |
|
| 41 | + const PROPERTY_NAME_UNREAD = '{http://owncloud.org/ns}isUnread'; |
|
| 42 | + const PROPERTY_NAME_MESSAGE = '{http://owncloud.org/ns}message'; |
|
| 43 | + const PROPERTY_NAME_ACTOR_DISPLAYNAME = '{http://owncloud.org/ns}actorDisplayName'; |
|
| 44 | + const PROPERTY_NAME_MENTIONS = '{http://owncloud.org/ns}mentions'; |
|
| 45 | + const PROPERTY_NAME_MENTION = '{http://owncloud.org/ns}mention'; |
|
| 46 | + const PROPERTY_NAME_MENTION_TYPE = '{http://owncloud.org/ns}mentionType'; |
|
| 47 | + const PROPERTY_NAME_MENTION_ID = '{http://owncloud.org/ns}mentionId'; |
|
| 48 | + const PROPERTY_NAME_MENTION_DISPLAYNAME = '{http://owncloud.org/ns}mentionDisplayName'; |
|
| 49 | 49 | |
| 50 | - /** @var IComment */ |
|
| 51 | - public $comment; |
|
| 50 | + /** @var IComment */ |
|
| 51 | + public $comment; |
|
| 52 | 52 | |
| 53 | - /** @var ICommentsManager */ |
|
| 54 | - protected $commentsManager; |
|
| 53 | + /** @var ICommentsManager */ |
|
| 54 | + protected $commentsManager; |
|
| 55 | 55 | |
| 56 | - /** @var ILogger */ |
|
| 57 | - protected $logger; |
|
| 56 | + /** @var ILogger */ |
|
| 57 | + protected $logger; |
|
| 58 | 58 | |
| 59 | - /** @var array list of properties with key being their name and value their setter */ |
|
| 60 | - protected $properties = []; |
|
| 59 | + /** @var array list of properties with key being their name and value their setter */ |
|
| 60 | + protected $properties = []; |
|
| 61 | 61 | |
| 62 | - /** @var IUserManager */ |
|
| 63 | - protected $userManager; |
|
| 62 | + /** @var IUserManager */ |
|
| 63 | + protected $userManager; |
|
| 64 | 64 | |
| 65 | - /** @var IUserSession */ |
|
| 66 | - protected $userSession; |
|
| 65 | + /** @var IUserSession */ |
|
| 66 | + protected $userSession; |
|
| 67 | 67 | |
| 68 | - /** |
|
| 69 | - * CommentNode constructor. |
|
| 70 | - * |
|
| 71 | - * @param ICommentsManager $commentsManager |
|
| 72 | - * @param IComment $comment |
|
| 73 | - * @param IUserManager $userManager |
|
| 74 | - * @param IUserSession $userSession |
|
| 75 | - * @param ILogger $logger |
|
| 76 | - */ |
|
| 77 | - public function __construct( |
|
| 78 | - ICommentsManager $commentsManager, |
|
| 79 | - IComment $comment, |
|
| 80 | - IUserManager $userManager, |
|
| 81 | - IUserSession $userSession, |
|
| 82 | - ILogger $logger |
|
| 83 | - ) { |
|
| 84 | - $this->commentsManager = $commentsManager; |
|
| 85 | - $this->comment = $comment; |
|
| 86 | - $this->logger = $logger; |
|
| 68 | + /** |
|
| 69 | + * CommentNode constructor. |
|
| 70 | + * |
|
| 71 | + * @param ICommentsManager $commentsManager |
|
| 72 | + * @param IComment $comment |
|
| 73 | + * @param IUserManager $userManager |
|
| 74 | + * @param IUserSession $userSession |
|
| 75 | + * @param ILogger $logger |
|
| 76 | + */ |
|
| 77 | + public function __construct( |
|
| 78 | + ICommentsManager $commentsManager, |
|
| 79 | + IComment $comment, |
|
| 80 | + IUserManager $userManager, |
|
| 81 | + IUserSession $userSession, |
|
| 82 | + ILogger $logger |
|
| 83 | + ) { |
|
| 84 | + $this->commentsManager = $commentsManager; |
|
| 85 | + $this->comment = $comment; |
|
| 86 | + $this->logger = $logger; |
|
| 87 | 87 | |
| 88 | - $methods = get_class_methods($this->comment); |
|
| 89 | - $methods = array_filter($methods, function($name){ |
|
| 90 | - return strpos($name, 'get') === 0; |
|
| 91 | - }); |
|
| 92 | - foreach($methods as $getter) { |
|
| 93 | - if($getter === 'getMentions') { |
|
| 94 | - continue; // special treatment |
|
| 95 | - } |
|
| 96 | - $name = '{'.self::NS_OWNCLOUD.'}' . lcfirst(substr($getter, 3)); |
|
| 97 | - $this->properties[$name] = $getter; |
|
| 98 | - } |
|
| 99 | - $this->userManager = $userManager; |
|
| 100 | - $this->userSession = $userSession; |
|
| 101 | - } |
|
| 88 | + $methods = get_class_methods($this->comment); |
|
| 89 | + $methods = array_filter($methods, function($name){ |
|
| 90 | + return strpos($name, 'get') === 0; |
|
| 91 | + }); |
|
| 92 | + foreach($methods as $getter) { |
|
| 93 | + if($getter === 'getMentions') { |
|
| 94 | + continue; // special treatment |
|
| 95 | + } |
|
| 96 | + $name = '{'.self::NS_OWNCLOUD.'}' . lcfirst(substr($getter, 3)); |
|
| 97 | + $this->properties[$name] = $getter; |
|
| 98 | + } |
|
| 99 | + $this->userManager = $userManager; |
|
| 100 | + $this->userSession = $userSession; |
|
| 101 | + } |
|
| 102 | 102 | |
| 103 | - /** |
|
| 104 | - * returns a list of all possible property names |
|
| 105 | - * |
|
| 106 | - * @return array |
|
| 107 | - */ |
|
| 108 | - static public function getPropertyNames() { |
|
| 109 | - return [ |
|
| 110 | - '{http://owncloud.org/ns}id', |
|
| 111 | - '{http://owncloud.org/ns}parentId', |
|
| 112 | - '{http://owncloud.org/ns}topmostParentId', |
|
| 113 | - '{http://owncloud.org/ns}childrenCount', |
|
| 114 | - '{http://owncloud.org/ns}verb', |
|
| 115 | - '{http://owncloud.org/ns}actorType', |
|
| 116 | - '{http://owncloud.org/ns}actorId', |
|
| 117 | - '{http://owncloud.org/ns}creationDateTime', |
|
| 118 | - '{http://owncloud.org/ns}latestChildDateTime', |
|
| 119 | - '{http://owncloud.org/ns}objectType', |
|
| 120 | - '{http://owncloud.org/ns}objectId', |
|
| 121 | - // re-used property names are defined as constants |
|
| 122 | - self::PROPERTY_NAME_MESSAGE, |
|
| 123 | - self::PROPERTY_NAME_ACTOR_DISPLAYNAME, |
|
| 124 | - self::PROPERTY_NAME_UNREAD, |
|
| 125 | - self::PROPERTY_NAME_MENTIONS, |
|
| 126 | - self::PROPERTY_NAME_MENTION, |
|
| 127 | - self::PROPERTY_NAME_MENTION_TYPE, |
|
| 128 | - self::PROPERTY_NAME_MENTION_ID, |
|
| 129 | - self::PROPERTY_NAME_MENTION_DISPLAYNAME, |
|
| 130 | - ]; |
|
| 131 | - } |
|
| 103 | + /** |
|
| 104 | + * returns a list of all possible property names |
|
| 105 | + * |
|
| 106 | + * @return array |
|
| 107 | + */ |
|
| 108 | + static public function getPropertyNames() { |
|
| 109 | + return [ |
|
| 110 | + '{http://owncloud.org/ns}id', |
|
| 111 | + '{http://owncloud.org/ns}parentId', |
|
| 112 | + '{http://owncloud.org/ns}topmostParentId', |
|
| 113 | + '{http://owncloud.org/ns}childrenCount', |
|
| 114 | + '{http://owncloud.org/ns}verb', |
|
| 115 | + '{http://owncloud.org/ns}actorType', |
|
| 116 | + '{http://owncloud.org/ns}actorId', |
|
| 117 | + '{http://owncloud.org/ns}creationDateTime', |
|
| 118 | + '{http://owncloud.org/ns}latestChildDateTime', |
|
| 119 | + '{http://owncloud.org/ns}objectType', |
|
| 120 | + '{http://owncloud.org/ns}objectId', |
|
| 121 | + // re-used property names are defined as constants |
|
| 122 | + self::PROPERTY_NAME_MESSAGE, |
|
| 123 | + self::PROPERTY_NAME_ACTOR_DISPLAYNAME, |
|
| 124 | + self::PROPERTY_NAME_UNREAD, |
|
| 125 | + self::PROPERTY_NAME_MENTIONS, |
|
| 126 | + self::PROPERTY_NAME_MENTION, |
|
| 127 | + self::PROPERTY_NAME_MENTION_TYPE, |
|
| 128 | + self::PROPERTY_NAME_MENTION_ID, |
|
| 129 | + self::PROPERTY_NAME_MENTION_DISPLAYNAME, |
|
| 130 | + ]; |
|
| 131 | + } |
|
| 132 | 132 | |
| 133 | - protected function checkWriteAccessOnComment() { |
|
| 134 | - $user = $this->userSession->getUser(); |
|
| 135 | - if( $this->comment->getActorType() !== 'users' |
|
| 136 | - || is_null($user) |
|
| 137 | - || $this->comment->getActorId() !== $user->getUID() |
|
| 138 | - ) { |
|
| 139 | - throw new Forbidden('Only authors are allowed to edit their comment.'); |
|
| 140 | - } |
|
| 141 | - } |
|
| 133 | + protected function checkWriteAccessOnComment() { |
|
| 134 | + $user = $this->userSession->getUser(); |
|
| 135 | + if( $this->comment->getActorType() !== 'users' |
|
| 136 | + || is_null($user) |
|
| 137 | + || $this->comment->getActorId() !== $user->getUID() |
|
| 138 | + ) { |
|
| 139 | + throw new Forbidden('Only authors are allowed to edit their comment.'); |
|
| 140 | + } |
|
| 141 | + } |
|
| 142 | 142 | |
| 143 | - /** |
|
| 144 | - * Deleted the current node |
|
| 145 | - * |
|
| 146 | - * @return void |
|
| 147 | - */ |
|
| 148 | - function delete() { |
|
| 149 | - $this->checkWriteAccessOnComment(); |
|
| 150 | - $this->commentsManager->delete($this->comment->getId()); |
|
| 151 | - } |
|
| 143 | + /** |
|
| 144 | + * Deleted the current node |
|
| 145 | + * |
|
| 146 | + * @return void |
|
| 147 | + */ |
|
| 148 | + function delete() { |
|
| 149 | + $this->checkWriteAccessOnComment(); |
|
| 150 | + $this->commentsManager->delete($this->comment->getId()); |
|
| 151 | + } |
|
| 152 | 152 | |
| 153 | - /** |
|
| 154 | - * Returns the name of the node. |
|
| 155 | - * |
|
| 156 | - * This is used to generate the url. |
|
| 157 | - * |
|
| 158 | - * @return string |
|
| 159 | - */ |
|
| 160 | - function getName() { |
|
| 161 | - return $this->comment->getId(); |
|
| 162 | - } |
|
| 153 | + /** |
|
| 154 | + * Returns the name of the node. |
|
| 155 | + * |
|
| 156 | + * This is used to generate the url. |
|
| 157 | + * |
|
| 158 | + * @return string |
|
| 159 | + */ |
|
| 160 | + function getName() { |
|
| 161 | + return $this->comment->getId(); |
|
| 162 | + } |
|
| 163 | 163 | |
| 164 | - /** |
|
| 165 | - * Renames the node |
|
| 166 | - * |
|
| 167 | - * @param string $name The new name |
|
| 168 | - * @throws MethodNotAllowed |
|
| 169 | - */ |
|
| 170 | - function setName($name) { |
|
| 171 | - throw new MethodNotAllowed(); |
|
| 172 | - } |
|
| 164 | + /** |
|
| 165 | + * Renames the node |
|
| 166 | + * |
|
| 167 | + * @param string $name The new name |
|
| 168 | + * @throws MethodNotAllowed |
|
| 169 | + */ |
|
| 170 | + function setName($name) { |
|
| 171 | + throw new MethodNotAllowed(); |
|
| 172 | + } |
|
| 173 | 173 | |
| 174 | - /** |
|
| 175 | - * Returns the last modification time, as a unix timestamp |
|
| 176 | - * |
|
| 177 | - * @return int |
|
| 178 | - */ |
|
| 179 | - function getLastModified() { |
|
| 180 | - return null; |
|
| 181 | - } |
|
| 174 | + /** |
|
| 175 | + * Returns the last modification time, as a unix timestamp |
|
| 176 | + * |
|
| 177 | + * @return int |
|
| 178 | + */ |
|
| 179 | + function getLastModified() { |
|
| 180 | + return null; |
|
| 181 | + } |
|
| 182 | 182 | |
| 183 | - /** |
|
| 184 | - * update the comment's message |
|
| 185 | - * |
|
| 186 | - * @param $propertyValue |
|
| 187 | - * @return bool |
|
| 188 | - * @throws BadRequest |
|
| 189 | - * @throws \Exception |
|
| 190 | - */ |
|
| 191 | - public function updateComment($propertyValue) { |
|
| 192 | - $this->checkWriteAccessOnComment(); |
|
| 193 | - try { |
|
| 194 | - $this->comment->setMessage($propertyValue); |
|
| 195 | - $this->commentsManager->save($this->comment); |
|
| 196 | - return true; |
|
| 197 | - } catch (\Exception $e) { |
|
| 198 | - $this->logger->logException($e, ['app' => 'dav/comments']); |
|
| 199 | - if($e instanceof MessageTooLongException) { |
|
| 200 | - $msg = 'Message exceeds allowed character limit of '; |
|
| 201 | - throw new BadRequest($msg . IComment::MAX_MESSAGE_LENGTH, 0, $e); |
|
| 202 | - } |
|
| 203 | - throw $e; |
|
| 204 | - } |
|
| 205 | - } |
|
| 183 | + /** |
|
| 184 | + * update the comment's message |
|
| 185 | + * |
|
| 186 | + * @param $propertyValue |
|
| 187 | + * @return bool |
|
| 188 | + * @throws BadRequest |
|
| 189 | + * @throws \Exception |
|
| 190 | + */ |
|
| 191 | + public function updateComment($propertyValue) { |
|
| 192 | + $this->checkWriteAccessOnComment(); |
|
| 193 | + try { |
|
| 194 | + $this->comment->setMessage($propertyValue); |
|
| 195 | + $this->commentsManager->save($this->comment); |
|
| 196 | + return true; |
|
| 197 | + } catch (\Exception $e) { |
|
| 198 | + $this->logger->logException($e, ['app' => 'dav/comments']); |
|
| 199 | + if($e instanceof MessageTooLongException) { |
|
| 200 | + $msg = 'Message exceeds allowed character limit of '; |
|
| 201 | + throw new BadRequest($msg . IComment::MAX_MESSAGE_LENGTH, 0, $e); |
|
| 202 | + } |
|
| 203 | + throw $e; |
|
| 204 | + } |
|
| 205 | + } |
|
| 206 | 206 | |
| 207 | - /** |
|
| 208 | - * Updates properties on this node. |
|
| 209 | - * |
|
| 210 | - * This method received a PropPatch object, which contains all the |
|
| 211 | - * information about the update. |
|
| 212 | - * |
|
| 213 | - * To update specific properties, call the 'handle' method on this object. |
|
| 214 | - * Read the PropPatch documentation for more information. |
|
| 215 | - * |
|
| 216 | - * @param PropPatch $propPatch |
|
| 217 | - * @return void |
|
| 218 | - */ |
|
| 219 | - function propPatch(PropPatch $propPatch) { |
|
| 220 | - // other properties than 'message' are read only |
|
| 221 | - $propPatch->handle(self::PROPERTY_NAME_MESSAGE, [$this, 'updateComment']); |
|
| 222 | - } |
|
| 207 | + /** |
|
| 208 | + * Updates properties on this node. |
|
| 209 | + * |
|
| 210 | + * This method received a PropPatch object, which contains all the |
|
| 211 | + * information about the update. |
|
| 212 | + * |
|
| 213 | + * To update specific properties, call the 'handle' method on this object. |
|
| 214 | + * Read the PropPatch documentation for more information. |
|
| 215 | + * |
|
| 216 | + * @param PropPatch $propPatch |
|
| 217 | + * @return void |
|
| 218 | + */ |
|
| 219 | + function propPatch(PropPatch $propPatch) { |
|
| 220 | + // other properties than 'message' are read only |
|
| 221 | + $propPatch->handle(self::PROPERTY_NAME_MESSAGE, [$this, 'updateComment']); |
|
| 222 | + } |
|
| 223 | 223 | |
| 224 | - /** |
|
| 225 | - * Returns a list of properties for this nodes. |
|
| 226 | - * |
|
| 227 | - * The properties list is a list of propertynames the client requested, |
|
| 228 | - * encoded in clark-notation {xmlnamespace}tagname |
|
| 229 | - * |
|
| 230 | - * If the array is empty, it means 'all properties' were requested. |
|
| 231 | - * |
|
| 232 | - * Note that it's fine to liberally give properties back, instead of |
|
| 233 | - * conforming to the list of requested properties. |
|
| 234 | - * The Server class will filter out the extra. |
|
| 235 | - * |
|
| 236 | - * @param array $properties |
|
| 237 | - * @return array |
|
| 238 | - */ |
|
| 239 | - function getProperties($properties) { |
|
| 240 | - $properties = array_keys($this->properties); |
|
| 224 | + /** |
|
| 225 | + * Returns a list of properties for this nodes. |
|
| 226 | + * |
|
| 227 | + * The properties list is a list of propertynames the client requested, |
|
| 228 | + * encoded in clark-notation {xmlnamespace}tagname |
|
| 229 | + * |
|
| 230 | + * If the array is empty, it means 'all properties' were requested. |
|
| 231 | + * |
|
| 232 | + * Note that it's fine to liberally give properties back, instead of |
|
| 233 | + * conforming to the list of requested properties. |
|
| 234 | + * The Server class will filter out the extra. |
|
| 235 | + * |
|
| 236 | + * @param array $properties |
|
| 237 | + * @return array |
|
| 238 | + */ |
|
| 239 | + function getProperties($properties) { |
|
| 240 | + $properties = array_keys($this->properties); |
|
| 241 | 241 | |
| 242 | - $result = []; |
|
| 243 | - foreach($properties as $property) { |
|
| 244 | - $getter = $this->properties[$property]; |
|
| 245 | - if(method_exists($this->comment, $getter)) { |
|
| 246 | - $result[$property] = $this->comment->$getter(); |
|
| 247 | - } |
|
| 248 | - } |
|
| 242 | + $result = []; |
|
| 243 | + foreach($properties as $property) { |
|
| 244 | + $getter = $this->properties[$property]; |
|
| 245 | + if(method_exists($this->comment, $getter)) { |
|
| 246 | + $result[$property] = $this->comment->$getter(); |
|
| 247 | + } |
|
| 248 | + } |
|
| 249 | 249 | |
| 250 | - if($this->comment->getActorType() === 'users') { |
|
| 251 | - $user = $this->userManager->get($this->comment->getActorId()); |
|
| 252 | - $displayName = is_null($user) ? null : $user->getDisplayName(); |
|
| 253 | - $result[self::PROPERTY_NAME_ACTOR_DISPLAYNAME] = $displayName; |
|
| 254 | - } |
|
| 250 | + if($this->comment->getActorType() === 'users') { |
|
| 251 | + $user = $this->userManager->get($this->comment->getActorId()); |
|
| 252 | + $displayName = is_null($user) ? null : $user->getDisplayName(); |
|
| 253 | + $result[self::PROPERTY_NAME_ACTOR_DISPLAYNAME] = $displayName; |
|
| 254 | + } |
|
| 255 | 255 | |
| 256 | - $result[self::PROPERTY_NAME_MENTIONS] = $this->composeMentionsPropertyValue(); |
|
| 256 | + $result[self::PROPERTY_NAME_MENTIONS] = $this->composeMentionsPropertyValue(); |
|
| 257 | 257 | |
| 258 | - $unread = null; |
|
| 259 | - $user = $this->userSession->getUser(); |
|
| 260 | - if(!is_null($user)) { |
|
| 261 | - $readUntil = $this->commentsManager->getReadMark( |
|
| 262 | - $this->comment->getObjectType(), |
|
| 263 | - $this->comment->getObjectId(), |
|
| 264 | - $user |
|
| 265 | - ); |
|
| 266 | - if(is_null($readUntil)) { |
|
| 267 | - $unread = 'true'; |
|
| 268 | - } else { |
|
| 269 | - $unread = $this->comment->getCreationDateTime() > $readUntil; |
|
| 270 | - // re-format for output |
|
| 271 | - $unread = $unread ? 'true' : 'false'; |
|
| 272 | - } |
|
| 273 | - } |
|
| 274 | - $result[self::PROPERTY_NAME_UNREAD] = $unread; |
|
| 258 | + $unread = null; |
|
| 259 | + $user = $this->userSession->getUser(); |
|
| 260 | + if(!is_null($user)) { |
|
| 261 | + $readUntil = $this->commentsManager->getReadMark( |
|
| 262 | + $this->comment->getObjectType(), |
|
| 263 | + $this->comment->getObjectId(), |
|
| 264 | + $user |
|
| 265 | + ); |
|
| 266 | + if(is_null($readUntil)) { |
|
| 267 | + $unread = 'true'; |
|
| 268 | + } else { |
|
| 269 | + $unread = $this->comment->getCreationDateTime() > $readUntil; |
|
| 270 | + // re-format for output |
|
| 271 | + $unread = $unread ? 'true' : 'false'; |
|
| 272 | + } |
|
| 273 | + } |
|
| 274 | + $result[self::PROPERTY_NAME_UNREAD] = $unread; |
|
| 275 | 275 | |
| 276 | - return $result; |
|
| 277 | - } |
|
| 276 | + return $result; |
|
| 277 | + } |
|
| 278 | 278 | |
| 279 | - /** |
|
| 280 | - * transforms a mentions array as returned from IComment->getMentions to an |
|
| 281 | - * array with DAV-compatible structure that can be assigned to the |
|
| 282 | - * PROPERTY_NAME_MENTION property. |
|
| 283 | - * |
|
| 284 | - * @return array |
|
| 285 | - */ |
|
| 286 | - protected function composeMentionsPropertyValue() { |
|
| 287 | - return array_map(function($mention) { |
|
| 288 | - try { |
|
| 289 | - $displayName = $this->commentsManager->resolveDisplayName($mention['type'], $mention['id']); |
|
| 290 | - } catch (\OutOfBoundsException $e) { |
|
| 291 | - $this->logger->logException($e); |
|
| 292 | - // No displayname, upon client's discretion what to display. |
|
| 293 | - $displayName = ''; |
|
| 294 | - } |
|
| 279 | + /** |
|
| 280 | + * transforms a mentions array as returned from IComment->getMentions to an |
|
| 281 | + * array with DAV-compatible structure that can be assigned to the |
|
| 282 | + * PROPERTY_NAME_MENTION property. |
|
| 283 | + * |
|
| 284 | + * @return array |
|
| 285 | + */ |
|
| 286 | + protected function composeMentionsPropertyValue() { |
|
| 287 | + return array_map(function($mention) { |
|
| 288 | + try { |
|
| 289 | + $displayName = $this->commentsManager->resolveDisplayName($mention['type'], $mention['id']); |
|
| 290 | + } catch (\OutOfBoundsException $e) { |
|
| 291 | + $this->logger->logException($e); |
|
| 292 | + // No displayname, upon client's discretion what to display. |
|
| 293 | + $displayName = ''; |
|
| 294 | + } |
|
| 295 | 295 | |
| 296 | - return [ |
|
| 297 | - self::PROPERTY_NAME_MENTION => [ |
|
| 298 | - self::PROPERTY_NAME_MENTION_TYPE => $mention['type'], |
|
| 299 | - self::PROPERTY_NAME_MENTION_ID => $mention['id'], |
|
| 300 | - self::PROPERTY_NAME_MENTION_DISPLAYNAME => $displayName, |
|
| 301 | - ] |
|
| 302 | - ]; |
|
| 303 | - }, $this->comment->getMentions()); |
|
| 304 | - } |
|
| 296 | + return [ |
|
| 297 | + self::PROPERTY_NAME_MENTION => [ |
|
| 298 | + self::PROPERTY_NAME_MENTION_TYPE => $mention['type'], |
|
| 299 | + self::PROPERTY_NAME_MENTION_ID => $mention['id'], |
|
| 300 | + self::PROPERTY_NAME_MENTION_DISPLAYNAME => $displayName, |
|
| 301 | + ] |
|
| 302 | + ]; |
|
| 303 | + }, $this->comment->getMentions()); |
|
| 304 | + } |
|
| 305 | 305 | } |
@@ -36,177 +36,177 @@ |
||
| 36 | 36 | |
| 37 | 37 | class RootCollection implements ICollection { |
| 38 | 38 | |
| 39 | - /** @var EntityTypeCollection[]|null */ |
|
| 40 | - private $entityTypeCollections; |
|
| 41 | - |
|
| 42 | - /** @var ICommentsManager */ |
|
| 43 | - protected $commentsManager; |
|
| 44 | - |
|
| 45 | - /** @var string */ |
|
| 46 | - protected $name = 'comments'; |
|
| 47 | - |
|
| 48 | - /** @var ILogger */ |
|
| 49 | - protected $logger; |
|
| 50 | - |
|
| 51 | - /** @var IUserManager */ |
|
| 52 | - protected $userManager; |
|
| 53 | - |
|
| 54 | - /** @var IUserSession */ |
|
| 55 | - protected $userSession; |
|
| 56 | - |
|
| 57 | - /** @var EventDispatcherInterface */ |
|
| 58 | - protected $dispatcher; |
|
| 59 | - |
|
| 60 | - /** |
|
| 61 | - * @param ICommentsManager $commentsManager |
|
| 62 | - * @param IUserManager $userManager |
|
| 63 | - * @param IUserSession $userSession |
|
| 64 | - * @param EventDispatcherInterface $dispatcher |
|
| 65 | - * @param ILogger $logger |
|
| 66 | - */ |
|
| 67 | - public function __construct( |
|
| 68 | - ICommentsManager $commentsManager, |
|
| 69 | - IUserManager $userManager, |
|
| 70 | - IUserSession $userSession, |
|
| 71 | - EventDispatcherInterface $dispatcher, |
|
| 72 | - ILogger $logger) |
|
| 73 | - { |
|
| 74 | - $this->commentsManager = $commentsManager; |
|
| 75 | - $this->logger = $logger; |
|
| 76 | - $this->userManager = $userManager; |
|
| 77 | - $this->userSession = $userSession; |
|
| 78 | - $this->dispatcher = $dispatcher; |
|
| 79 | - } |
|
| 80 | - |
|
| 81 | - /** |
|
| 82 | - * initializes the collection. At this point of time, we need the logged in |
|
| 83 | - * user. Since it is not the case when the instance is created, we cannot |
|
| 84 | - * have this in the constructor. |
|
| 85 | - * |
|
| 86 | - * @throws NotAuthenticated |
|
| 87 | - */ |
|
| 88 | - protected function initCollections() { |
|
| 89 | - if($this->entityTypeCollections !== null) { |
|
| 90 | - return; |
|
| 91 | - } |
|
| 92 | - $user = $this->userSession->getUser(); |
|
| 93 | - if(is_null($user)) { |
|
| 94 | - throw new NotAuthenticated(); |
|
| 95 | - } |
|
| 96 | - |
|
| 97 | - $event = new CommentsEntityEvent(CommentsEntityEvent::EVENT_ENTITY); |
|
| 98 | - $this->dispatcher->dispatch(CommentsEntityEvent::EVENT_ENTITY, $event); |
|
| 99 | - |
|
| 100 | - $this->entityTypeCollections = []; |
|
| 101 | - foreach ($event->getEntityCollections() as $entity => $entityExistsFunction) { |
|
| 102 | - $this->entityTypeCollections[$entity] = new EntityTypeCollection( |
|
| 103 | - $entity, |
|
| 104 | - $this->commentsManager, |
|
| 105 | - $this->userManager, |
|
| 106 | - $this->userSession, |
|
| 107 | - $this->logger, |
|
| 108 | - $entityExistsFunction |
|
| 109 | - ); |
|
| 110 | - } |
|
| 111 | - } |
|
| 112 | - |
|
| 113 | - /** |
|
| 114 | - * Creates a new file in the directory |
|
| 115 | - * |
|
| 116 | - * @param string $name Name of the file |
|
| 117 | - * @param resource|string $data Initial payload |
|
| 118 | - * @return null|string |
|
| 119 | - * @throws Forbidden |
|
| 120 | - */ |
|
| 121 | - function createFile($name, $data = null) { |
|
| 122 | - throw new Forbidden('Cannot create comments by id'); |
|
| 123 | - } |
|
| 124 | - |
|
| 125 | - /** |
|
| 126 | - * Creates a new subdirectory |
|
| 127 | - * |
|
| 128 | - * @param string $name |
|
| 129 | - * @throws Forbidden |
|
| 130 | - */ |
|
| 131 | - function createDirectory($name) { |
|
| 132 | - throw new Forbidden('Permission denied to create collections'); |
|
| 133 | - } |
|
| 134 | - |
|
| 135 | - /** |
|
| 136 | - * Returns a specific child node, referenced by its name |
|
| 137 | - * |
|
| 138 | - * This method must throw Sabre\DAV\Exception\NotFound if the node does not |
|
| 139 | - * exist. |
|
| 140 | - * |
|
| 141 | - * @param string $name |
|
| 142 | - * @return \Sabre\DAV\INode |
|
| 143 | - * @throws NotFound |
|
| 144 | - */ |
|
| 145 | - function getChild($name) { |
|
| 146 | - $this->initCollections(); |
|
| 147 | - if(isset($this->entityTypeCollections[$name])) { |
|
| 148 | - return $this->entityTypeCollections[$name]; |
|
| 149 | - } |
|
| 150 | - throw new NotFound('Entity type "' . $name . '" not found."'); |
|
| 151 | - } |
|
| 152 | - |
|
| 153 | - /** |
|
| 154 | - * Returns an array with all the child nodes |
|
| 155 | - * |
|
| 156 | - * @return \Sabre\DAV\INode[] |
|
| 157 | - */ |
|
| 158 | - function getChildren() { |
|
| 159 | - $this->initCollections(); |
|
| 160 | - return $this->entityTypeCollections; |
|
| 161 | - } |
|
| 162 | - |
|
| 163 | - /** |
|
| 164 | - * Checks if a child-node with the specified name exists |
|
| 165 | - * |
|
| 166 | - * @param string $name |
|
| 167 | - * @return bool |
|
| 168 | - */ |
|
| 169 | - function childExists($name) { |
|
| 170 | - $this->initCollections(); |
|
| 171 | - return isset($this->entityTypeCollections[$name]); |
|
| 172 | - } |
|
| 173 | - |
|
| 174 | - /** |
|
| 175 | - * Deleted the current node |
|
| 176 | - * |
|
| 177 | - * @throws Forbidden |
|
| 178 | - */ |
|
| 179 | - function delete() { |
|
| 180 | - throw new Forbidden('Permission denied to delete this collection'); |
|
| 181 | - } |
|
| 182 | - |
|
| 183 | - /** |
|
| 184 | - * Returns the name of the node. |
|
| 185 | - * |
|
| 186 | - * This is used to generate the url. |
|
| 187 | - * |
|
| 188 | - * @return string |
|
| 189 | - */ |
|
| 190 | - function getName() { |
|
| 191 | - return $this->name; |
|
| 192 | - } |
|
| 193 | - |
|
| 194 | - /** |
|
| 195 | - * Renames the node |
|
| 196 | - * |
|
| 197 | - * @param string $name The new name |
|
| 198 | - * @throws Forbidden |
|
| 199 | - */ |
|
| 200 | - function setName($name) { |
|
| 201 | - throw new Forbidden('Permission denied to rename this collection'); |
|
| 202 | - } |
|
| 203 | - |
|
| 204 | - /** |
|
| 205 | - * Returns the last modification time, as a unix timestamp |
|
| 206 | - * |
|
| 207 | - * @return int |
|
| 208 | - */ |
|
| 209 | - function getLastModified() { |
|
| 210 | - return null; |
|
| 211 | - } |
|
| 39 | + /** @var EntityTypeCollection[]|null */ |
|
| 40 | + private $entityTypeCollections; |
|
| 41 | + |
|
| 42 | + /** @var ICommentsManager */ |
|
| 43 | + protected $commentsManager; |
|
| 44 | + |
|
| 45 | + /** @var string */ |
|
| 46 | + protected $name = 'comments'; |
|
| 47 | + |
|
| 48 | + /** @var ILogger */ |
|
| 49 | + protected $logger; |
|
| 50 | + |
|
| 51 | + /** @var IUserManager */ |
|
| 52 | + protected $userManager; |
|
| 53 | + |
|
| 54 | + /** @var IUserSession */ |
|
| 55 | + protected $userSession; |
|
| 56 | + |
|
| 57 | + /** @var EventDispatcherInterface */ |
|
| 58 | + protected $dispatcher; |
|
| 59 | + |
|
| 60 | + /** |
|
| 61 | + * @param ICommentsManager $commentsManager |
|
| 62 | + * @param IUserManager $userManager |
|
| 63 | + * @param IUserSession $userSession |
|
| 64 | + * @param EventDispatcherInterface $dispatcher |
|
| 65 | + * @param ILogger $logger |
|
| 66 | + */ |
|
| 67 | + public function __construct( |
|
| 68 | + ICommentsManager $commentsManager, |
|
| 69 | + IUserManager $userManager, |
|
| 70 | + IUserSession $userSession, |
|
| 71 | + EventDispatcherInterface $dispatcher, |
|
| 72 | + ILogger $logger) |
|
| 73 | + { |
|
| 74 | + $this->commentsManager = $commentsManager; |
|
| 75 | + $this->logger = $logger; |
|
| 76 | + $this->userManager = $userManager; |
|
| 77 | + $this->userSession = $userSession; |
|
| 78 | + $this->dispatcher = $dispatcher; |
|
| 79 | + } |
|
| 80 | + |
|
| 81 | + /** |
|
| 82 | + * initializes the collection. At this point of time, we need the logged in |
|
| 83 | + * user. Since it is not the case when the instance is created, we cannot |
|
| 84 | + * have this in the constructor. |
|
| 85 | + * |
|
| 86 | + * @throws NotAuthenticated |
|
| 87 | + */ |
|
| 88 | + protected function initCollections() { |
|
| 89 | + if($this->entityTypeCollections !== null) { |
|
| 90 | + return; |
|
| 91 | + } |
|
| 92 | + $user = $this->userSession->getUser(); |
|
| 93 | + if(is_null($user)) { |
|
| 94 | + throw new NotAuthenticated(); |
|
| 95 | + } |
|
| 96 | + |
|
| 97 | + $event = new CommentsEntityEvent(CommentsEntityEvent::EVENT_ENTITY); |
|
| 98 | + $this->dispatcher->dispatch(CommentsEntityEvent::EVENT_ENTITY, $event); |
|
| 99 | + |
|
| 100 | + $this->entityTypeCollections = []; |
|
| 101 | + foreach ($event->getEntityCollections() as $entity => $entityExistsFunction) { |
|
| 102 | + $this->entityTypeCollections[$entity] = new EntityTypeCollection( |
|
| 103 | + $entity, |
|
| 104 | + $this->commentsManager, |
|
| 105 | + $this->userManager, |
|
| 106 | + $this->userSession, |
|
| 107 | + $this->logger, |
|
| 108 | + $entityExistsFunction |
|
| 109 | + ); |
|
| 110 | + } |
|
| 111 | + } |
|
| 112 | + |
|
| 113 | + /** |
|
| 114 | + * Creates a new file in the directory |
|
| 115 | + * |
|
| 116 | + * @param string $name Name of the file |
|
| 117 | + * @param resource|string $data Initial payload |
|
| 118 | + * @return null|string |
|
| 119 | + * @throws Forbidden |
|
| 120 | + */ |
|
| 121 | + function createFile($name, $data = null) { |
|
| 122 | + throw new Forbidden('Cannot create comments by id'); |
|
| 123 | + } |
|
| 124 | + |
|
| 125 | + /** |
|
| 126 | + * Creates a new subdirectory |
|
| 127 | + * |
|
| 128 | + * @param string $name |
|
| 129 | + * @throws Forbidden |
|
| 130 | + */ |
|
| 131 | + function createDirectory($name) { |
|
| 132 | + throw new Forbidden('Permission denied to create collections'); |
|
| 133 | + } |
|
| 134 | + |
|
| 135 | + /** |
|
| 136 | + * Returns a specific child node, referenced by its name |
|
| 137 | + * |
|
| 138 | + * This method must throw Sabre\DAV\Exception\NotFound if the node does not |
|
| 139 | + * exist. |
|
| 140 | + * |
|
| 141 | + * @param string $name |
|
| 142 | + * @return \Sabre\DAV\INode |
|
| 143 | + * @throws NotFound |
|
| 144 | + */ |
|
| 145 | + function getChild($name) { |
|
| 146 | + $this->initCollections(); |
|
| 147 | + if(isset($this->entityTypeCollections[$name])) { |
|
| 148 | + return $this->entityTypeCollections[$name]; |
|
| 149 | + } |
|
| 150 | + throw new NotFound('Entity type "' . $name . '" not found."'); |
|
| 151 | + } |
|
| 152 | + |
|
| 153 | + /** |
|
| 154 | + * Returns an array with all the child nodes |
|
| 155 | + * |
|
| 156 | + * @return \Sabre\DAV\INode[] |
|
| 157 | + */ |
|
| 158 | + function getChildren() { |
|
| 159 | + $this->initCollections(); |
|
| 160 | + return $this->entityTypeCollections; |
|
| 161 | + } |
|
| 162 | + |
|
| 163 | + /** |
|
| 164 | + * Checks if a child-node with the specified name exists |
|
| 165 | + * |
|
| 166 | + * @param string $name |
|
| 167 | + * @return bool |
|
| 168 | + */ |
|
| 169 | + function childExists($name) { |
|
| 170 | + $this->initCollections(); |
|
| 171 | + return isset($this->entityTypeCollections[$name]); |
|
| 172 | + } |
|
| 173 | + |
|
| 174 | + /** |
|
| 175 | + * Deleted the current node |
|
| 176 | + * |
|
| 177 | + * @throws Forbidden |
|
| 178 | + */ |
|
| 179 | + function delete() { |
|
| 180 | + throw new Forbidden('Permission denied to delete this collection'); |
|
| 181 | + } |
|
| 182 | + |
|
| 183 | + /** |
|
| 184 | + * Returns the name of the node. |
|
| 185 | + * |
|
| 186 | + * This is used to generate the url. |
|
| 187 | + * |
|
| 188 | + * @return string |
|
| 189 | + */ |
|
| 190 | + function getName() { |
|
| 191 | + return $this->name; |
|
| 192 | + } |
|
| 193 | + |
|
| 194 | + /** |
|
| 195 | + * Renames the node |
|
| 196 | + * |
|
| 197 | + * @param string $name The new name |
|
| 198 | + * @throws Forbidden |
|
| 199 | + */ |
|
| 200 | + function setName($name) { |
|
| 201 | + throw new Forbidden('Permission denied to rename this collection'); |
|
| 202 | + } |
|
| 203 | + |
|
| 204 | + /** |
|
| 205 | + * Returns the last modification time, as a unix timestamp |
|
| 206 | + * |
|
| 207 | + * @return int |
|
| 208 | + */ |
|
| 209 | + function getLastModified() { |
|
| 210 | + return null; |
|
| 211 | + } |
|
| 212 | 212 | } |
@@ -43,213 +43,213 @@ |
||
| 43 | 43 | * Sabre plugin to handle comments: |
| 44 | 44 | */ |
| 45 | 45 | class CommentsPlugin extends ServerPlugin { |
| 46 | - // namespace |
|
| 47 | - const NS_OWNCLOUD = 'http://owncloud.org/ns'; |
|
| 48 | - |
|
| 49 | - const REPORT_NAME = '{http://owncloud.org/ns}filter-comments'; |
|
| 50 | - const REPORT_PARAM_LIMIT = '{http://owncloud.org/ns}limit'; |
|
| 51 | - const REPORT_PARAM_OFFSET = '{http://owncloud.org/ns}offset'; |
|
| 52 | - const REPORT_PARAM_TIMESTAMP = '{http://owncloud.org/ns}datetime'; |
|
| 53 | - |
|
| 54 | - /** @var ICommentsManager */ |
|
| 55 | - protected $commentsManager; |
|
| 56 | - |
|
| 57 | - /** @var \Sabre\DAV\Server $server */ |
|
| 58 | - private $server; |
|
| 59 | - |
|
| 60 | - /** @var \OCP\IUserSession */ |
|
| 61 | - protected $userSession; |
|
| 62 | - |
|
| 63 | - /** |
|
| 64 | - * Comments plugin |
|
| 65 | - * |
|
| 66 | - * @param ICommentsManager $commentsManager |
|
| 67 | - * @param IUserSession $userSession |
|
| 68 | - */ |
|
| 69 | - public function __construct(ICommentsManager $commentsManager, IUserSession $userSession) { |
|
| 70 | - $this->commentsManager = $commentsManager; |
|
| 71 | - $this->userSession = $userSession; |
|
| 72 | - } |
|
| 73 | - |
|
| 74 | - /** |
|
| 75 | - * This initializes the plugin. |
|
| 76 | - * |
|
| 77 | - * This function is called by Sabre\DAV\Server, after |
|
| 78 | - * addPlugin is called. |
|
| 79 | - * |
|
| 80 | - * This method should set up the required event subscriptions. |
|
| 81 | - * |
|
| 82 | - * @param Server $server |
|
| 83 | - * @return void |
|
| 84 | - */ |
|
| 85 | - function initialize(Server $server) { |
|
| 86 | - $this->server = $server; |
|
| 87 | - if(strpos($this->server->getRequestUri(), 'comments/') !== 0) { |
|
| 88 | - return; |
|
| 89 | - } |
|
| 90 | - |
|
| 91 | - $this->server->xml->namespaceMap[self::NS_OWNCLOUD] = 'oc'; |
|
| 92 | - |
|
| 93 | - $this->server->xml->classMap['DateTime'] = function(Writer $writer, \DateTime $value) { |
|
| 94 | - $writer->write(\Sabre\HTTP\toDate($value)); |
|
| 95 | - }; |
|
| 96 | - |
|
| 97 | - $this->server->on('report', [$this, 'onReport']); |
|
| 98 | - $this->server->on('method:POST', [$this, 'httpPost']); |
|
| 99 | - } |
|
| 100 | - |
|
| 101 | - /** |
|
| 102 | - * POST operation on Comments collections |
|
| 103 | - * |
|
| 104 | - * @param RequestInterface $request request object |
|
| 105 | - * @param ResponseInterface $response response object |
|
| 106 | - * @return null|false |
|
| 107 | - */ |
|
| 108 | - public function httpPost(RequestInterface $request, ResponseInterface $response) { |
|
| 109 | - $path = $request->getPath(); |
|
| 110 | - $node = $this->server->tree->getNodeForPath($path); |
|
| 111 | - if (!$node instanceof EntityCollection) { |
|
| 112 | - return null; |
|
| 113 | - } |
|
| 114 | - |
|
| 115 | - $data = $request->getBodyAsString(); |
|
| 116 | - $comment = $this->createComment( |
|
| 117 | - $node->getName(), |
|
| 118 | - $node->getId(), |
|
| 119 | - $data, |
|
| 120 | - $request->getHeader('Content-Type') |
|
| 121 | - ); |
|
| 122 | - |
|
| 123 | - // update read marker for the current user/poster to avoid |
|
| 124 | - // having their own comments marked as unread |
|
| 125 | - $node->setReadMarker(null); |
|
| 126 | - |
|
| 127 | - $url = rtrim($request->getUrl(), '/') . '/' . urlencode($comment->getId()); |
|
| 128 | - |
|
| 129 | - $response->setHeader('Content-Location', $url); |
|
| 130 | - |
|
| 131 | - // created |
|
| 132 | - $response->setStatus(201); |
|
| 133 | - return false; |
|
| 134 | - } |
|
| 135 | - |
|
| 136 | - /** |
|
| 137 | - * Returns a list of reports this plugin supports. |
|
| 138 | - * |
|
| 139 | - * This will be used in the {DAV:}supported-report-set property. |
|
| 140 | - * |
|
| 141 | - * @param string $uri |
|
| 142 | - * @return array |
|
| 143 | - */ |
|
| 144 | - public function getSupportedReportSet($uri) { |
|
| 145 | - return [self::REPORT_NAME]; |
|
| 146 | - } |
|
| 147 | - |
|
| 148 | - /** |
|
| 149 | - * REPORT operations to look for comments |
|
| 150 | - * |
|
| 151 | - * @param string $reportName |
|
| 152 | - * @param array $report |
|
| 153 | - * @param string $uri |
|
| 154 | - * @return bool |
|
| 155 | - * @throws NotFound |
|
| 156 | - * @throws ReportNotSupported |
|
| 157 | - */ |
|
| 158 | - public function onReport($reportName, $report, $uri) { |
|
| 159 | - $node = $this->server->tree->getNodeForPath($uri); |
|
| 160 | - if(!$node instanceof EntityCollection || $reportName !== self::REPORT_NAME) { |
|
| 161 | - throw new ReportNotSupported(); |
|
| 162 | - } |
|
| 163 | - $args = ['limit' => 0, 'offset' => 0, 'datetime' => null]; |
|
| 164 | - $acceptableParameters = [ |
|
| 165 | - $this::REPORT_PARAM_LIMIT, |
|
| 166 | - $this::REPORT_PARAM_OFFSET, |
|
| 167 | - $this::REPORT_PARAM_TIMESTAMP |
|
| 168 | - ]; |
|
| 169 | - $ns = '{' . $this::NS_OWNCLOUD . '}'; |
|
| 170 | - foreach($report as $parameter) { |
|
| 171 | - if(!in_array($parameter['name'], $acceptableParameters) || empty($parameter['value'])) { |
|
| 172 | - continue; |
|
| 173 | - } |
|
| 174 | - $args[str_replace($ns, '', $parameter['name'])] = $parameter['value']; |
|
| 175 | - } |
|
| 176 | - |
|
| 177 | - if(!is_null($args['datetime'])) { |
|
| 178 | - $args['datetime'] = new \DateTime($args['datetime']); |
|
| 179 | - } |
|
| 180 | - |
|
| 181 | - $results = $node->findChildren($args['limit'], $args['offset'], $args['datetime']); |
|
| 182 | - |
|
| 183 | - $responses = []; |
|
| 184 | - foreach($results as $node) { |
|
| 185 | - $nodePath = $this->server->getRequestUri() . '/' . $node->comment->getId(); |
|
| 186 | - $resultSet = $this->server->getPropertiesForPath($nodePath, CommentNode::getPropertyNames()); |
|
| 187 | - if(isset($resultSet[0]) && isset($resultSet[0][200])) { |
|
| 188 | - $responses[] = new Response( |
|
| 189 | - $this->server->getBaseUri() . $nodePath, |
|
| 190 | - [200 => $resultSet[0][200]], |
|
| 191 | - 200 |
|
| 192 | - ); |
|
| 193 | - } |
|
| 194 | - |
|
| 195 | - } |
|
| 196 | - |
|
| 197 | - $xml = $this->server->xml->write( |
|
| 198 | - '{DAV:}multistatus', |
|
| 199 | - new MultiStatus($responses) |
|
| 200 | - ); |
|
| 201 | - |
|
| 202 | - $this->server->httpResponse->setStatus(207); |
|
| 203 | - $this->server->httpResponse->setHeader('Content-Type', 'application/xml; charset=utf-8'); |
|
| 204 | - $this->server->httpResponse->setBody($xml); |
|
| 205 | - |
|
| 206 | - return false; |
|
| 207 | - } |
|
| 208 | - |
|
| 209 | - /** |
|
| 210 | - * Creates a new comment |
|
| 211 | - * |
|
| 212 | - * @param string $objectType e.g. "files" |
|
| 213 | - * @param string $objectId e.g. the file id |
|
| 214 | - * @param string $data JSON encoded string containing the properties of the tag to create |
|
| 215 | - * @param string $contentType content type of the data |
|
| 216 | - * @return IComment newly created comment |
|
| 217 | - * |
|
| 218 | - * @throws BadRequest if a field was missing |
|
| 219 | - * @throws UnsupportedMediaType if the content type is not supported |
|
| 220 | - */ |
|
| 221 | - private function createComment($objectType, $objectId, $data, $contentType = 'application/json') { |
|
| 222 | - if (explode(';', $contentType)[0] === 'application/json') { |
|
| 223 | - $data = json_decode($data, true); |
|
| 224 | - } else { |
|
| 225 | - throw new UnsupportedMediaType(); |
|
| 226 | - } |
|
| 227 | - |
|
| 228 | - $actorType = $data['actorType']; |
|
| 229 | - $actorId = null; |
|
| 230 | - if($actorType === 'users') { |
|
| 231 | - $user = $this->userSession->getUser(); |
|
| 232 | - if(!is_null($user)) { |
|
| 233 | - $actorId = $user->getUID(); |
|
| 234 | - } |
|
| 235 | - } |
|
| 236 | - if(is_null($actorId)) { |
|
| 237 | - throw new BadRequest('Invalid actor "' . $actorType .'"'); |
|
| 238 | - } |
|
| 239 | - |
|
| 240 | - try { |
|
| 241 | - $comment = $this->commentsManager->create($actorType, $actorId, $objectType, $objectId); |
|
| 242 | - $comment->setMessage($data['message']); |
|
| 243 | - $comment->setVerb($data['verb']); |
|
| 244 | - $this->commentsManager->save($comment); |
|
| 245 | - return $comment; |
|
| 246 | - } catch (\InvalidArgumentException $e) { |
|
| 247 | - throw new BadRequest('Invalid input values', 0, $e); |
|
| 248 | - } catch (\OCP\Comments\MessageTooLongException $e) { |
|
| 249 | - $msg = 'Message exceeds allowed character limit of '; |
|
| 250 | - throw new BadRequest($msg . \OCP\Comments\IComment::MAX_MESSAGE_LENGTH, 0, $e); |
|
| 251 | - } |
|
| 252 | - } |
|
| 46 | + // namespace |
|
| 47 | + const NS_OWNCLOUD = 'http://owncloud.org/ns'; |
|
| 48 | + |
|
| 49 | + const REPORT_NAME = '{http://owncloud.org/ns}filter-comments'; |
|
| 50 | + const REPORT_PARAM_LIMIT = '{http://owncloud.org/ns}limit'; |
|
| 51 | + const REPORT_PARAM_OFFSET = '{http://owncloud.org/ns}offset'; |
|
| 52 | + const REPORT_PARAM_TIMESTAMP = '{http://owncloud.org/ns}datetime'; |
|
| 53 | + |
|
| 54 | + /** @var ICommentsManager */ |
|
| 55 | + protected $commentsManager; |
|
| 56 | + |
|
| 57 | + /** @var \Sabre\DAV\Server $server */ |
|
| 58 | + private $server; |
|
| 59 | + |
|
| 60 | + /** @var \OCP\IUserSession */ |
|
| 61 | + protected $userSession; |
|
| 62 | + |
|
| 63 | + /** |
|
| 64 | + * Comments plugin |
|
| 65 | + * |
|
| 66 | + * @param ICommentsManager $commentsManager |
|
| 67 | + * @param IUserSession $userSession |
|
| 68 | + */ |
|
| 69 | + public function __construct(ICommentsManager $commentsManager, IUserSession $userSession) { |
|
| 70 | + $this->commentsManager = $commentsManager; |
|
| 71 | + $this->userSession = $userSession; |
|
| 72 | + } |
|
| 73 | + |
|
| 74 | + /** |
|
| 75 | + * This initializes the plugin. |
|
| 76 | + * |
|
| 77 | + * This function is called by Sabre\DAV\Server, after |
|
| 78 | + * addPlugin is called. |
|
| 79 | + * |
|
| 80 | + * This method should set up the required event subscriptions. |
|
| 81 | + * |
|
| 82 | + * @param Server $server |
|
| 83 | + * @return void |
|
| 84 | + */ |
|
| 85 | + function initialize(Server $server) { |
|
| 86 | + $this->server = $server; |
|
| 87 | + if(strpos($this->server->getRequestUri(), 'comments/') !== 0) { |
|
| 88 | + return; |
|
| 89 | + } |
|
| 90 | + |
|
| 91 | + $this->server->xml->namespaceMap[self::NS_OWNCLOUD] = 'oc'; |
|
| 92 | + |
|
| 93 | + $this->server->xml->classMap['DateTime'] = function(Writer $writer, \DateTime $value) { |
|
| 94 | + $writer->write(\Sabre\HTTP\toDate($value)); |
|
| 95 | + }; |
|
| 96 | + |
|
| 97 | + $this->server->on('report', [$this, 'onReport']); |
|
| 98 | + $this->server->on('method:POST', [$this, 'httpPost']); |
|
| 99 | + } |
|
| 100 | + |
|
| 101 | + /** |
|
| 102 | + * POST operation on Comments collections |
|
| 103 | + * |
|
| 104 | + * @param RequestInterface $request request object |
|
| 105 | + * @param ResponseInterface $response response object |
|
| 106 | + * @return null|false |
|
| 107 | + */ |
|
| 108 | + public function httpPost(RequestInterface $request, ResponseInterface $response) { |
|
| 109 | + $path = $request->getPath(); |
|
| 110 | + $node = $this->server->tree->getNodeForPath($path); |
|
| 111 | + if (!$node instanceof EntityCollection) { |
|
| 112 | + return null; |
|
| 113 | + } |
|
| 114 | + |
|
| 115 | + $data = $request->getBodyAsString(); |
|
| 116 | + $comment = $this->createComment( |
|
| 117 | + $node->getName(), |
|
| 118 | + $node->getId(), |
|
| 119 | + $data, |
|
| 120 | + $request->getHeader('Content-Type') |
|
| 121 | + ); |
|
| 122 | + |
|
| 123 | + // update read marker for the current user/poster to avoid |
|
| 124 | + // having their own comments marked as unread |
|
| 125 | + $node->setReadMarker(null); |
|
| 126 | + |
|
| 127 | + $url = rtrim($request->getUrl(), '/') . '/' . urlencode($comment->getId()); |
|
| 128 | + |
|
| 129 | + $response->setHeader('Content-Location', $url); |
|
| 130 | + |
|
| 131 | + // created |
|
| 132 | + $response->setStatus(201); |
|
| 133 | + return false; |
|
| 134 | + } |
|
| 135 | + |
|
| 136 | + /** |
|
| 137 | + * Returns a list of reports this plugin supports. |
|
| 138 | + * |
|
| 139 | + * This will be used in the {DAV:}supported-report-set property. |
|
| 140 | + * |
|
| 141 | + * @param string $uri |
|
| 142 | + * @return array |
|
| 143 | + */ |
|
| 144 | + public function getSupportedReportSet($uri) { |
|
| 145 | + return [self::REPORT_NAME]; |
|
| 146 | + } |
|
| 147 | + |
|
| 148 | + /** |
|
| 149 | + * REPORT operations to look for comments |
|
| 150 | + * |
|
| 151 | + * @param string $reportName |
|
| 152 | + * @param array $report |
|
| 153 | + * @param string $uri |
|
| 154 | + * @return bool |
|
| 155 | + * @throws NotFound |
|
| 156 | + * @throws ReportNotSupported |
|
| 157 | + */ |
|
| 158 | + public function onReport($reportName, $report, $uri) { |
|
| 159 | + $node = $this->server->tree->getNodeForPath($uri); |
|
| 160 | + if(!$node instanceof EntityCollection || $reportName !== self::REPORT_NAME) { |
|
| 161 | + throw new ReportNotSupported(); |
|
| 162 | + } |
|
| 163 | + $args = ['limit' => 0, 'offset' => 0, 'datetime' => null]; |
|
| 164 | + $acceptableParameters = [ |
|
| 165 | + $this::REPORT_PARAM_LIMIT, |
|
| 166 | + $this::REPORT_PARAM_OFFSET, |
|
| 167 | + $this::REPORT_PARAM_TIMESTAMP |
|
| 168 | + ]; |
|
| 169 | + $ns = '{' . $this::NS_OWNCLOUD . '}'; |
|
| 170 | + foreach($report as $parameter) { |
|
| 171 | + if(!in_array($parameter['name'], $acceptableParameters) || empty($parameter['value'])) { |
|
| 172 | + continue; |
|
| 173 | + } |
|
| 174 | + $args[str_replace($ns, '', $parameter['name'])] = $parameter['value']; |
|
| 175 | + } |
|
| 176 | + |
|
| 177 | + if(!is_null($args['datetime'])) { |
|
| 178 | + $args['datetime'] = new \DateTime($args['datetime']); |
|
| 179 | + } |
|
| 180 | + |
|
| 181 | + $results = $node->findChildren($args['limit'], $args['offset'], $args['datetime']); |
|
| 182 | + |
|
| 183 | + $responses = []; |
|
| 184 | + foreach($results as $node) { |
|
| 185 | + $nodePath = $this->server->getRequestUri() . '/' . $node->comment->getId(); |
|
| 186 | + $resultSet = $this->server->getPropertiesForPath($nodePath, CommentNode::getPropertyNames()); |
|
| 187 | + if(isset($resultSet[0]) && isset($resultSet[0][200])) { |
|
| 188 | + $responses[] = new Response( |
|
| 189 | + $this->server->getBaseUri() . $nodePath, |
|
| 190 | + [200 => $resultSet[0][200]], |
|
| 191 | + 200 |
|
| 192 | + ); |
|
| 193 | + } |
|
| 194 | + |
|
| 195 | + } |
|
| 196 | + |
|
| 197 | + $xml = $this->server->xml->write( |
|
| 198 | + '{DAV:}multistatus', |
|
| 199 | + new MultiStatus($responses) |
|
| 200 | + ); |
|
| 201 | + |
|
| 202 | + $this->server->httpResponse->setStatus(207); |
|
| 203 | + $this->server->httpResponse->setHeader('Content-Type', 'application/xml; charset=utf-8'); |
|
| 204 | + $this->server->httpResponse->setBody($xml); |
|
| 205 | + |
|
| 206 | + return false; |
|
| 207 | + } |
|
| 208 | + |
|
| 209 | + /** |
|
| 210 | + * Creates a new comment |
|
| 211 | + * |
|
| 212 | + * @param string $objectType e.g. "files" |
|
| 213 | + * @param string $objectId e.g. the file id |
|
| 214 | + * @param string $data JSON encoded string containing the properties of the tag to create |
|
| 215 | + * @param string $contentType content type of the data |
|
| 216 | + * @return IComment newly created comment |
|
| 217 | + * |
|
| 218 | + * @throws BadRequest if a field was missing |
|
| 219 | + * @throws UnsupportedMediaType if the content type is not supported |
|
| 220 | + */ |
|
| 221 | + private function createComment($objectType, $objectId, $data, $contentType = 'application/json') { |
|
| 222 | + if (explode(';', $contentType)[0] === 'application/json') { |
|
| 223 | + $data = json_decode($data, true); |
|
| 224 | + } else { |
|
| 225 | + throw new UnsupportedMediaType(); |
|
| 226 | + } |
|
| 227 | + |
|
| 228 | + $actorType = $data['actorType']; |
|
| 229 | + $actorId = null; |
|
| 230 | + if($actorType === 'users') { |
|
| 231 | + $user = $this->userSession->getUser(); |
|
| 232 | + if(!is_null($user)) { |
|
| 233 | + $actorId = $user->getUID(); |
|
| 234 | + } |
|
| 235 | + } |
|
| 236 | + if(is_null($actorId)) { |
|
| 237 | + throw new BadRequest('Invalid actor "' . $actorType .'"'); |
|
| 238 | + } |
|
| 239 | + |
|
| 240 | + try { |
|
| 241 | + $comment = $this->commentsManager->create($actorType, $actorId, $objectType, $objectId); |
|
| 242 | + $comment->setMessage($data['message']); |
|
| 243 | + $comment->setVerb($data['verb']); |
|
| 244 | + $this->commentsManager->save($comment); |
|
| 245 | + return $comment; |
|
| 246 | + } catch (\InvalidArgumentException $e) { |
|
| 247 | + throw new BadRequest('Invalid input values', 0, $e); |
|
| 248 | + } catch (\OCP\Comments\MessageTooLongException $e) { |
|
| 249 | + $msg = 'Message exceeds allowed character limit of '; |
|
| 250 | + throw new BadRequest($msg . \OCP\Comments\IComment::MAX_MESSAGE_LENGTH, 0, $e); |
|
| 251 | + } |
|
| 252 | + } |
|
| 253 | 253 | |
| 254 | 254 | |
| 255 | 255 | |