@@ -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 | } |
@@ -121,21 +121,21 @@ discard block |
||
| 121 | 121 | */ |
| 122 | 122 | function xmlSerialize(Writer $writer) { |
| 123 | 123 | |
| 124 | - $cs = '{' . Plugin::NS_OWNCLOUD . '}'; |
|
| 124 | + $cs = '{'.Plugin::NS_OWNCLOUD.'}'; |
|
| 125 | 125 | |
| 126 | 126 | if (!is_null($this->organizer)) { |
| 127 | 127 | |
| 128 | - $writer->startElement($cs . 'organizer'); |
|
| 128 | + $writer->startElement($cs.'organizer'); |
|
| 129 | 129 | $writer->writeElement('{DAV:}href', $this->organizer['href']); |
| 130 | 130 | |
| 131 | 131 | if (isset($this->organizer['commonName']) && $this->organizer['commonName']) { |
| 132 | - $writer->writeElement($cs . 'common-name', $this->organizer['commonName']); |
|
| 132 | + $writer->writeElement($cs.'common-name', $this->organizer['commonName']); |
|
| 133 | 133 | } |
| 134 | 134 | if (isset($this->organizer['firstName']) && $this->organizer['firstName']) { |
| 135 | - $writer->writeElement($cs . 'first-name', $this->organizer['firstName']); |
|
| 135 | + $writer->writeElement($cs.'first-name', $this->organizer['firstName']); |
|
| 136 | 136 | } |
| 137 | 137 | if (isset($this->organizer['lastName']) && $this->organizer['lastName']) { |
| 138 | - $writer->writeElement($cs . 'last-name', $this->organizer['lastName']); |
|
| 138 | + $writer->writeElement($cs.'last-name', $this->organizer['lastName']); |
|
| 139 | 139 | } |
| 140 | 140 | $writer->endElement(); // organizer |
| 141 | 141 | |
@@ -143,23 +143,23 @@ discard block |
||
| 143 | 143 | |
| 144 | 144 | foreach ($this->users as $user) { |
| 145 | 145 | |
| 146 | - $writer->startElement($cs . 'user'); |
|
| 146 | + $writer->startElement($cs.'user'); |
|
| 147 | 147 | $writer->writeElement('{DAV:}href', $user['href']); |
| 148 | 148 | if (isset($user['commonName']) && $user['commonName']) { |
| 149 | - $writer->writeElement($cs . 'common-name', $user['commonName']); |
|
| 149 | + $writer->writeElement($cs.'common-name', $user['commonName']); |
|
| 150 | 150 | } |
| 151 | - $writer->writeElement($cs . 'invite-accepted'); |
|
| 151 | + $writer->writeElement($cs.'invite-accepted'); |
|
| 152 | 152 | |
| 153 | - $writer->startElement($cs . 'access'); |
|
| 153 | + $writer->startElement($cs.'access'); |
|
| 154 | 154 | if ($user['readOnly']) { |
| 155 | - $writer->writeElement($cs . 'read'); |
|
| 155 | + $writer->writeElement($cs.'read'); |
|
| 156 | 156 | } else { |
| 157 | - $writer->writeElement($cs . 'read-write'); |
|
| 157 | + $writer->writeElement($cs.'read-write'); |
|
| 158 | 158 | } |
| 159 | 159 | $writer->endElement(); // access |
| 160 | 160 | |
| 161 | 161 | if (isset($user['summary']) && $user['summary']) { |
| 162 | - $writer->writeElement($cs . 'summary', $user['summary']); |
|
| 162 | + $writer->writeElement($cs.'summary', $user['summary']); |
|
| 163 | 163 | } |
| 164 | 164 | |
| 165 | 165 | $writer->endElement(); //user |
@@ -119,8 +119,9 @@ |
||
| 119 | 119 | |
| 120 | 120 | // Only handling xml |
| 121 | 121 | $contentType = $request->getHeader('Content-Type'); |
| 122 | - if (strpos($contentType, 'application/xml') === false && strpos($contentType, 'text/xml') === false) |
|
| 123 | - return; |
|
| 122 | + if (strpos($contentType, 'application/xml') === false && strpos($contentType, 'text/xml') === false) { |
|
| 123 | + return; |
|
| 124 | + } |
|
| 124 | 125 | |
| 125 | 126 | // Making sure the node exists |
| 126 | 127 | try { |
@@ -37,167 +37,167 @@ |
||
| 37 | 37 | |
| 38 | 38 | class Plugin extends ServerPlugin { |
| 39 | 39 | |
| 40 | - const NS_OWNCLOUD = 'http://owncloud.org/ns'; |
|
| 41 | - const NS_NEXTCLOUD = 'http://nextcloud.com/ns'; |
|
| 42 | - |
|
| 43 | - /** @var Auth */ |
|
| 44 | - private $auth; |
|
| 45 | - |
|
| 46 | - /** @var IRequest */ |
|
| 47 | - private $request; |
|
| 48 | - |
|
| 49 | - /** |
|
| 50 | - * Plugin constructor. |
|
| 51 | - * |
|
| 52 | - * @param Auth $authBackEnd |
|
| 53 | - * @param IRequest $request |
|
| 54 | - */ |
|
| 55 | - public function __construct(Auth $authBackEnd, IRequest $request) { |
|
| 56 | - $this->auth = $authBackEnd; |
|
| 57 | - $this->request = $request; |
|
| 58 | - } |
|
| 59 | - |
|
| 60 | - /** |
|
| 61 | - * Reference to SabreDAV server object. |
|
| 62 | - * |
|
| 63 | - * @var \Sabre\DAV\Server |
|
| 64 | - */ |
|
| 65 | - protected $server; |
|
| 66 | - |
|
| 67 | - /** |
|
| 68 | - * This method should return a list of server-features. |
|
| 69 | - * |
|
| 70 | - * This is for example 'versioning' and is added to the DAV: header |
|
| 71 | - * in an OPTIONS response. |
|
| 72 | - * |
|
| 73 | - * @return string[] |
|
| 74 | - */ |
|
| 75 | - function getFeatures() { |
|
| 76 | - return ['oc-resource-sharing']; |
|
| 77 | - } |
|
| 78 | - |
|
| 79 | - /** |
|
| 80 | - * Returns a plugin name. |
|
| 81 | - * |
|
| 82 | - * Using this name other plugins will be able to access other plugins |
|
| 83 | - * using Sabre\DAV\Server::getPlugin |
|
| 84 | - * |
|
| 85 | - * @return string |
|
| 86 | - */ |
|
| 87 | - function getPluginName() { |
|
| 88 | - return 'oc-resource-sharing'; |
|
| 89 | - } |
|
| 90 | - |
|
| 91 | - /** |
|
| 92 | - * This initializes the plugin. |
|
| 93 | - * |
|
| 94 | - * This function is called by Sabre\DAV\Server, after |
|
| 95 | - * addPlugin is called. |
|
| 96 | - * |
|
| 97 | - * This method should set up the required event subscriptions. |
|
| 98 | - * |
|
| 99 | - * @param Server $server |
|
| 100 | - * @return void |
|
| 101 | - */ |
|
| 102 | - function initialize(Server $server) { |
|
| 103 | - $this->server = $server; |
|
| 104 | - $this->server->xml->elementMap['{' . Plugin::NS_OWNCLOUD . '}share'] = ShareRequest::class; |
|
| 105 | - $this->server->xml->elementMap['{' . Plugin::NS_OWNCLOUD . '}invite'] = Invite::class; |
|
| 106 | - |
|
| 107 | - $this->server->on('method:POST', [$this, 'httpPost']); |
|
| 108 | - $this->server->on('propFind', [$this, 'propFind']); |
|
| 109 | - } |
|
| 110 | - |
|
| 111 | - /** |
|
| 112 | - * We intercept this to handle POST requests on a dav resource. |
|
| 113 | - * |
|
| 114 | - * @param RequestInterface $request |
|
| 115 | - * @param ResponseInterface $response |
|
| 116 | - * @return null|false |
|
| 117 | - */ |
|
| 118 | - function httpPost(RequestInterface $request, ResponseInterface $response) { |
|
| 119 | - |
|
| 120 | - $path = $request->getPath(); |
|
| 121 | - |
|
| 122 | - // Only handling xml |
|
| 123 | - $contentType = $request->getHeader('Content-Type'); |
|
| 124 | - if (strpos($contentType, 'application/xml') === false && strpos($contentType, 'text/xml') === false) |
|
| 125 | - return; |
|
| 126 | - |
|
| 127 | - // Making sure the node exists |
|
| 128 | - try { |
|
| 129 | - $node = $this->server->tree->getNodeForPath($path); |
|
| 130 | - } catch (NotFound $e) { |
|
| 131 | - return; |
|
| 132 | - } |
|
| 133 | - |
|
| 134 | - $requestBody = $request->getBodyAsString(); |
|
| 135 | - |
|
| 136 | - // If this request handler could not deal with this POST request, it |
|
| 137 | - // will return 'null' and other plugins get a chance to handle the |
|
| 138 | - // request. |
|
| 139 | - // |
|
| 140 | - // However, we already requested the full body. This is a problem, |
|
| 141 | - // because a body can only be read once. This is why we preemptively |
|
| 142 | - // re-populated the request body with the existing data. |
|
| 143 | - $request->setBody($requestBody); |
|
| 144 | - |
|
| 145 | - $message = $this->server->xml->parse($requestBody, $request->getUrl(), $documentType); |
|
| 146 | - |
|
| 147 | - switch ($documentType) { |
|
| 148 | - |
|
| 149 | - // Dealing with the 'share' document, which modified invitees on a |
|
| 150 | - // calendar. |
|
| 151 | - case '{' . self::NS_OWNCLOUD . '}share' : |
|
| 152 | - |
|
| 153 | - // We can only deal with IShareableCalendar objects |
|
| 154 | - if (!$node instanceof IShareable) { |
|
| 155 | - return; |
|
| 156 | - } |
|
| 157 | - |
|
| 158 | - $this->server->transactionType = 'post-oc-resource-share'; |
|
| 159 | - |
|
| 160 | - // Getting ACL info |
|
| 161 | - $acl = $this->server->getPlugin('acl'); |
|
| 162 | - |
|
| 163 | - // If there's no ACL support, we allow everything |
|
| 164 | - if ($acl) { |
|
| 165 | - /** @var \Sabre\DAVACL\Plugin $acl */ |
|
| 166 | - $acl->checkPrivileges($path, '{DAV:}write'); |
|
| 167 | - } |
|
| 168 | - |
|
| 169 | - $node->updateShares($message->set, $message->remove); |
|
| 170 | - |
|
| 171 | - $response->setStatus(200); |
|
| 172 | - // Adding this because sending a response body may cause issues, |
|
| 173 | - // and I wanted some type of indicator the response was handled. |
|
| 174 | - $response->setHeader('X-Sabre-Status', 'everything-went-well'); |
|
| 175 | - |
|
| 176 | - // Breaking the event chain |
|
| 177 | - return false; |
|
| 178 | - } |
|
| 179 | - } |
|
| 180 | - |
|
| 181 | - /** |
|
| 182 | - * This event is triggered when properties are requested for a certain |
|
| 183 | - * node. |
|
| 184 | - * |
|
| 185 | - * This allows us to inject any properties early. |
|
| 186 | - * |
|
| 187 | - * @param PropFind $propFind |
|
| 188 | - * @param INode $node |
|
| 189 | - * @return void |
|
| 190 | - */ |
|
| 191 | - function propFind(PropFind $propFind, INode $node) { |
|
| 192 | - if ($node instanceof IShareable) { |
|
| 193 | - |
|
| 194 | - $propFind->handle('{' . Plugin::NS_OWNCLOUD . '}invite', function() use ($node) { |
|
| 195 | - return new Invite( |
|
| 196 | - $node->getShares() |
|
| 197 | - ); |
|
| 198 | - }); |
|
| 199 | - |
|
| 200 | - } |
|
| 201 | - } |
|
| 40 | + const NS_OWNCLOUD = 'http://owncloud.org/ns'; |
|
| 41 | + const NS_NEXTCLOUD = 'http://nextcloud.com/ns'; |
|
| 42 | + |
|
| 43 | + /** @var Auth */ |
|
| 44 | + private $auth; |
|
| 45 | + |
|
| 46 | + /** @var IRequest */ |
|
| 47 | + private $request; |
|
| 48 | + |
|
| 49 | + /** |
|
| 50 | + * Plugin constructor. |
|
| 51 | + * |
|
| 52 | + * @param Auth $authBackEnd |
|
| 53 | + * @param IRequest $request |
|
| 54 | + */ |
|
| 55 | + public function __construct(Auth $authBackEnd, IRequest $request) { |
|
| 56 | + $this->auth = $authBackEnd; |
|
| 57 | + $this->request = $request; |
|
| 58 | + } |
|
| 59 | + |
|
| 60 | + /** |
|
| 61 | + * Reference to SabreDAV server object. |
|
| 62 | + * |
|
| 63 | + * @var \Sabre\DAV\Server |
|
| 64 | + */ |
|
| 65 | + protected $server; |
|
| 66 | + |
|
| 67 | + /** |
|
| 68 | + * This method should return a list of server-features. |
|
| 69 | + * |
|
| 70 | + * This is for example 'versioning' and is added to the DAV: header |
|
| 71 | + * in an OPTIONS response. |
|
| 72 | + * |
|
| 73 | + * @return string[] |
|
| 74 | + */ |
|
| 75 | + function getFeatures() { |
|
| 76 | + return ['oc-resource-sharing']; |
|
| 77 | + } |
|
| 78 | + |
|
| 79 | + /** |
|
| 80 | + * Returns a plugin name. |
|
| 81 | + * |
|
| 82 | + * Using this name other plugins will be able to access other plugins |
|
| 83 | + * using Sabre\DAV\Server::getPlugin |
|
| 84 | + * |
|
| 85 | + * @return string |
|
| 86 | + */ |
|
| 87 | + function getPluginName() { |
|
| 88 | + return 'oc-resource-sharing'; |
|
| 89 | + } |
|
| 90 | + |
|
| 91 | + /** |
|
| 92 | + * This initializes the plugin. |
|
| 93 | + * |
|
| 94 | + * This function is called by Sabre\DAV\Server, after |
|
| 95 | + * addPlugin is called. |
|
| 96 | + * |
|
| 97 | + * This method should set up the required event subscriptions. |
|
| 98 | + * |
|
| 99 | + * @param Server $server |
|
| 100 | + * @return void |
|
| 101 | + */ |
|
| 102 | + function initialize(Server $server) { |
|
| 103 | + $this->server = $server; |
|
| 104 | + $this->server->xml->elementMap['{' . Plugin::NS_OWNCLOUD . '}share'] = ShareRequest::class; |
|
| 105 | + $this->server->xml->elementMap['{' . Plugin::NS_OWNCLOUD . '}invite'] = Invite::class; |
|
| 106 | + |
|
| 107 | + $this->server->on('method:POST', [$this, 'httpPost']); |
|
| 108 | + $this->server->on('propFind', [$this, 'propFind']); |
|
| 109 | + } |
|
| 110 | + |
|
| 111 | + /** |
|
| 112 | + * We intercept this to handle POST requests on a dav resource. |
|
| 113 | + * |
|
| 114 | + * @param RequestInterface $request |
|
| 115 | + * @param ResponseInterface $response |
|
| 116 | + * @return null|false |
|
| 117 | + */ |
|
| 118 | + function httpPost(RequestInterface $request, ResponseInterface $response) { |
|
| 119 | + |
|
| 120 | + $path = $request->getPath(); |
|
| 121 | + |
|
| 122 | + // Only handling xml |
|
| 123 | + $contentType = $request->getHeader('Content-Type'); |
|
| 124 | + if (strpos($contentType, 'application/xml') === false && strpos($contentType, 'text/xml') === false) |
|
| 125 | + return; |
|
| 126 | + |
|
| 127 | + // Making sure the node exists |
|
| 128 | + try { |
|
| 129 | + $node = $this->server->tree->getNodeForPath($path); |
|
| 130 | + } catch (NotFound $e) { |
|
| 131 | + return; |
|
| 132 | + } |
|
| 133 | + |
|
| 134 | + $requestBody = $request->getBodyAsString(); |
|
| 135 | + |
|
| 136 | + // If this request handler could not deal with this POST request, it |
|
| 137 | + // will return 'null' and other plugins get a chance to handle the |
|
| 138 | + // request. |
|
| 139 | + // |
|
| 140 | + // However, we already requested the full body. This is a problem, |
|
| 141 | + // because a body can only be read once. This is why we preemptively |
|
| 142 | + // re-populated the request body with the existing data. |
|
| 143 | + $request->setBody($requestBody); |
|
| 144 | + |
|
| 145 | + $message = $this->server->xml->parse($requestBody, $request->getUrl(), $documentType); |
|
| 146 | + |
|
| 147 | + switch ($documentType) { |
|
| 148 | + |
|
| 149 | + // Dealing with the 'share' document, which modified invitees on a |
|
| 150 | + // calendar. |
|
| 151 | + case '{' . self::NS_OWNCLOUD . '}share' : |
|
| 152 | + |
|
| 153 | + // We can only deal with IShareableCalendar objects |
|
| 154 | + if (!$node instanceof IShareable) { |
|
| 155 | + return; |
|
| 156 | + } |
|
| 157 | + |
|
| 158 | + $this->server->transactionType = 'post-oc-resource-share'; |
|
| 159 | + |
|
| 160 | + // Getting ACL info |
|
| 161 | + $acl = $this->server->getPlugin('acl'); |
|
| 162 | + |
|
| 163 | + // If there's no ACL support, we allow everything |
|
| 164 | + if ($acl) { |
|
| 165 | + /** @var \Sabre\DAVACL\Plugin $acl */ |
|
| 166 | + $acl->checkPrivileges($path, '{DAV:}write'); |
|
| 167 | + } |
|
| 168 | + |
|
| 169 | + $node->updateShares($message->set, $message->remove); |
|
| 170 | + |
|
| 171 | + $response->setStatus(200); |
|
| 172 | + // Adding this because sending a response body may cause issues, |
|
| 173 | + // and I wanted some type of indicator the response was handled. |
|
| 174 | + $response->setHeader('X-Sabre-Status', 'everything-went-well'); |
|
| 175 | + |
|
| 176 | + // Breaking the event chain |
|
| 177 | + return false; |
|
| 178 | + } |
|
| 179 | + } |
|
| 180 | + |
|
| 181 | + /** |
|
| 182 | + * This event is triggered when properties are requested for a certain |
|
| 183 | + * node. |
|
| 184 | + * |
|
| 185 | + * This allows us to inject any properties early. |
|
| 186 | + * |
|
| 187 | + * @param PropFind $propFind |
|
| 188 | + * @param INode $node |
|
| 189 | + * @return void |
|
| 190 | + */ |
|
| 191 | + function propFind(PropFind $propFind, INode $node) { |
|
| 192 | + if ($node instanceof IShareable) { |
|
| 193 | + |
|
| 194 | + $propFind->handle('{' . Plugin::NS_OWNCLOUD . '}invite', function() use ($node) { |
|
| 195 | + return new Invite( |
|
| 196 | + $node->getShares() |
|
| 197 | + ); |
|
| 198 | + }); |
|
| 199 | + |
|
| 200 | + } |
|
| 201 | + } |
|
| 202 | 202 | |
| 203 | 203 | } |
@@ -101,11 +101,11 @@ discard block |
||
| 101 | 101 | */ |
| 102 | 102 | function initialize(Server $server) { |
| 103 | 103 | $this->server = $server; |
| 104 | - $this->server->xml->elementMap['{' . Plugin::NS_OWNCLOUD . '}share'] = ShareRequest::class; |
|
| 105 | - $this->server->xml->elementMap['{' . Plugin::NS_OWNCLOUD . '}invite'] = Invite::class; |
|
| 104 | + $this->server->xml->elementMap['{'.Plugin::NS_OWNCLOUD.'}share'] = ShareRequest::class; |
|
| 105 | + $this->server->xml->elementMap['{'.Plugin::NS_OWNCLOUD.'}invite'] = Invite::class; |
|
| 106 | 106 | |
| 107 | 107 | $this->server->on('method:POST', [$this, 'httpPost']); |
| 108 | - $this->server->on('propFind', [$this, 'propFind']); |
|
| 108 | + $this->server->on('propFind', [$this, 'propFind']); |
|
| 109 | 109 | } |
| 110 | 110 | |
| 111 | 111 | /** |
@@ -148,7 +148,7 @@ discard block |
||
| 148 | 148 | |
| 149 | 149 | // Dealing with the 'share' document, which modified invitees on a |
| 150 | 150 | // calendar. |
| 151 | - case '{' . self::NS_OWNCLOUD . '}share' : |
|
| 151 | + case '{'.self::NS_OWNCLOUD.'}share' : |
|
| 152 | 152 | |
| 153 | 153 | // We can only deal with IShareableCalendar objects |
| 154 | 154 | if (!$node instanceof IShareable) { |
@@ -191,7 +191,7 @@ discard block |
||
| 191 | 191 | function propFind(PropFind $propFind, INode $node) { |
| 192 | 192 | if ($node instanceof IShareable) { |
| 193 | 193 | |
| 194 | - $propFind->handle('{' . Plugin::NS_OWNCLOUD . '}invite', function() use ($node) { |
|
| 194 | + $propFind->handle('{'.Plugin::NS_OWNCLOUD.'}invite', function() use ($node) { |
|
| 195 | 195 | return new Invite( |
| 196 | 196 | $node->getShares() |
| 197 | 197 | ); |
@@ -57,10 +57,10 @@ discard block |
||
| 57 | 57 | * @param string[] $remove |
| 58 | 58 | */ |
| 59 | 59 | public function updateShares($shareable, $add, $remove) { |
| 60 | - foreach($add as $element) { |
|
| 60 | + foreach ($add as $element) { |
|
| 61 | 61 | $this->shareWith($shareable, $element); |
| 62 | 62 | } |
| 63 | - foreach($remove as $element) { |
|
| 63 | + foreach ($remove as $element) { |
|
| 64 | 64 | $this->unshare($shareable, $element); |
| 65 | 65 | } |
| 66 | 66 | } |
@@ -164,9 +164,9 @@ discard block |
||
| 164 | 164 | ->execute(); |
| 165 | 165 | |
| 166 | 166 | $shares = []; |
| 167 | - while($row = $result->fetch()) { |
|
| 167 | + while ($row = $result->fetch()) { |
|
| 168 | 168 | $p = $this->principalBackend->getPrincipalByPath($row['principaluri']); |
| 169 | - $shares[]= [ |
|
| 169 | + $shares[] = [ |
|
| 170 | 170 | 'href' => "principal:${row['principaluri']}", |
| 171 | 171 | 'commonName' => isset($p['{DAV:}displayname']) ? $p['{DAV:}displayname'] : '', |
| 172 | 172 | 'status' => 1, |
@@ -192,13 +192,13 @@ discard block |
||
| 192 | 192 | foreach ($shares as $share) { |
| 193 | 193 | $acl[] = [ |
| 194 | 194 | 'privilege' => '{DAV:}read', |
| 195 | - 'principal' => $share['{' . \OCA\DAV\DAV\Sharing\Plugin::NS_OWNCLOUD . '}principal'], |
|
| 195 | + 'principal' => $share['{'.\OCA\DAV\DAV\Sharing\Plugin::NS_OWNCLOUD.'}principal'], |
|
| 196 | 196 | 'protected' => true, |
| 197 | 197 | ]; |
| 198 | 198 | if (!$share['readOnly']) { |
| 199 | 199 | $acl[] = [ |
| 200 | 200 | 'privilege' => '{DAV:}write', |
| 201 | - 'principal' => $share['{' . \OCA\DAV\DAV\Sharing\Plugin::NS_OWNCLOUD . '}principal'], |
|
| 201 | + 'principal' => $share['{'.\OCA\DAV\DAV\Sharing\Plugin::NS_OWNCLOUD.'}principal'], |
|
| 202 | 202 | 'protected' => true, |
| 203 | 203 | ]; |
| 204 | 204 | } else if ($this->resourceType === 'calendar') { |
@@ -206,7 +206,7 @@ discard block |
||
| 206 | 206 | // so users can change the visibility. |
| 207 | 207 | $acl[] = [ |
| 208 | 208 | 'privilege' => '{DAV:}write-properties', |
| 209 | - 'principal' => $share['{' . \OCA\DAV\DAV\Sharing\Plugin::NS_OWNCLOUD . '}principal'], |
|
| 209 | + 'principal' => $share['{'.\OCA\DAV\DAV\Sharing\Plugin::NS_OWNCLOUD.'}principal'], |
|
| 210 | 210 | 'protected' => true, |
| 211 | 211 | ]; |
| 212 | 212 | } |
@@ -32,208 +32,208 @@ |
||
| 32 | 32 | |
| 33 | 33 | class Backend { |
| 34 | 34 | |
| 35 | - /** @var IDBConnection */ |
|
| 36 | - private $db; |
|
| 37 | - /** @var IUserManager */ |
|
| 38 | - private $userManager; |
|
| 39 | - /** @var IGroupManager */ |
|
| 40 | - private $groupManager; |
|
| 41 | - /** @var Principal */ |
|
| 42 | - private $principalBackend; |
|
| 43 | - /** @var string */ |
|
| 44 | - private $resourceType; |
|
| 45 | - |
|
| 46 | - const ACCESS_OWNER = 1; |
|
| 47 | - const ACCESS_READ_WRITE = 2; |
|
| 48 | - const ACCESS_READ = 3; |
|
| 49 | - |
|
| 50 | - /** |
|
| 51 | - * @param IDBConnection $db |
|
| 52 | - * @param IUserManager $userManager |
|
| 53 | - * @param IGroupManager $groupManager |
|
| 54 | - * @param Principal $principalBackend |
|
| 55 | - * @param string $resourceType |
|
| 56 | - */ |
|
| 57 | - public function __construct(IDBConnection $db, IUserManager $userManager, IGroupManager $groupManager, Principal $principalBackend, $resourceType) { |
|
| 58 | - $this->db = $db; |
|
| 59 | - $this->userManager = $userManager; |
|
| 60 | - $this->groupManager = $groupManager; |
|
| 61 | - $this->principalBackend = $principalBackend; |
|
| 62 | - $this->resourceType = $resourceType; |
|
| 63 | - } |
|
| 64 | - |
|
| 65 | - /** |
|
| 66 | - * @param IShareable $shareable |
|
| 67 | - * @param string[] $add |
|
| 68 | - * @param string[] $remove |
|
| 69 | - */ |
|
| 70 | - public function updateShares($shareable, $add, $remove) { |
|
| 71 | - foreach($add as $element) { |
|
| 72 | - $this->shareWith($shareable, $element); |
|
| 73 | - } |
|
| 74 | - foreach($remove as $element) { |
|
| 75 | - $this->unshare($shareable, $element); |
|
| 76 | - } |
|
| 77 | - } |
|
| 78 | - |
|
| 79 | - /** |
|
| 80 | - * @param IShareable $shareable |
|
| 81 | - * @param string $element |
|
| 82 | - */ |
|
| 83 | - private function shareWith($shareable, $element) { |
|
| 84 | - $user = $element['href']; |
|
| 85 | - $parts = explode(':', $user, 2); |
|
| 86 | - if ($parts[0] !== 'principal') { |
|
| 87 | - return; |
|
| 88 | - } |
|
| 89 | - |
|
| 90 | - // don't share with owner |
|
| 91 | - if ($shareable->getOwner() === $parts[1]) { |
|
| 92 | - return; |
|
| 93 | - } |
|
| 94 | - |
|
| 95 | - $principal = explode('/', $parts[1], 3); |
|
| 96 | - if (count($principal) !== 3 || $principal[0] !== 'principals' || !in_array($principal[1], ['users', 'groups'], true)) { |
|
| 97 | - // Invalid principal |
|
| 98 | - return; |
|
| 99 | - } |
|
| 100 | - |
|
| 101 | - if (($principal[1] === 'users' && !$this->userManager->userExists($principal[2])) || |
|
| 102 | - ($principal[1] === 'groups' && !$this->groupManager->groupExists($principal[2]))) { |
|
| 103 | - // User or group does not exist |
|
| 104 | - return; |
|
| 105 | - } |
|
| 106 | - |
|
| 107 | - // remove the share if it already exists |
|
| 108 | - $this->unshare($shareable, $element['href']); |
|
| 109 | - $access = self::ACCESS_READ; |
|
| 110 | - if (isset($element['readOnly'])) { |
|
| 111 | - $access = $element['readOnly'] ? self::ACCESS_READ : self::ACCESS_READ_WRITE; |
|
| 112 | - } |
|
| 113 | - |
|
| 114 | - $query = $this->db->getQueryBuilder(); |
|
| 115 | - $query->insert('dav_shares') |
|
| 116 | - ->values([ |
|
| 117 | - 'principaluri' => $query->createNamedParameter($parts[1]), |
|
| 118 | - 'type' => $query->createNamedParameter($this->resourceType), |
|
| 119 | - 'access' => $query->createNamedParameter($access), |
|
| 120 | - 'resourceid' => $query->createNamedParameter($shareable->getResourceId()) |
|
| 121 | - ]); |
|
| 122 | - $query->execute(); |
|
| 123 | - } |
|
| 124 | - |
|
| 125 | - /** |
|
| 126 | - * @param $resourceId |
|
| 127 | - */ |
|
| 128 | - public function deleteAllShares($resourceId) { |
|
| 129 | - $query = $this->db->getQueryBuilder(); |
|
| 130 | - $query->delete('dav_shares') |
|
| 131 | - ->where($query->expr()->eq('resourceid', $query->createNamedParameter($resourceId))) |
|
| 132 | - ->andWhere($query->expr()->eq('type', $query->createNamedParameter($this->resourceType))) |
|
| 133 | - ->execute(); |
|
| 134 | - } |
|
| 135 | - |
|
| 136 | - public function deleteAllSharesByUser($principaluri) { |
|
| 137 | - $query = $this->db->getQueryBuilder(); |
|
| 138 | - $query->delete('dav_shares') |
|
| 139 | - ->where($query->expr()->eq('principaluri', $query->createNamedParameter($principaluri))) |
|
| 140 | - ->andWhere($query->expr()->eq('type', $query->createNamedParameter($this->resourceType))) |
|
| 141 | - ->execute(); |
|
| 142 | - } |
|
| 143 | - |
|
| 144 | - /** |
|
| 145 | - * @param IShareable $shareable |
|
| 146 | - * @param string $element |
|
| 147 | - */ |
|
| 148 | - private function unshare($shareable, $element) { |
|
| 149 | - $parts = explode(':', $element, 2); |
|
| 150 | - if ($parts[0] !== 'principal') { |
|
| 151 | - return; |
|
| 152 | - } |
|
| 153 | - |
|
| 154 | - // don't share with owner |
|
| 155 | - if ($shareable->getOwner() === $parts[1]) { |
|
| 156 | - return; |
|
| 157 | - } |
|
| 158 | - |
|
| 159 | - $query = $this->db->getQueryBuilder(); |
|
| 160 | - $query->delete('dav_shares') |
|
| 161 | - ->where($query->expr()->eq('resourceid', $query->createNamedParameter($shareable->getResourceId()))) |
|
| 162 | - ->andWhere($query->expr()->eq('type', $query->createNamedParameter($this->resourceType))) |
|
| 163 | - ->andWhere($query->expr()->eq('principaluri', $query->createNamedParameter($parts[1]))) |
|
| 164 | - ; |
|
| 165 | - $query->execute(); |
|
| 166 | - } |
|
| 167 | - |
|
| 168 | - /** |
|
| 169 | - * Returns the list of people whom this resource is shared with. |
|
| 170 | - * |
|
| 171 | - * Every element in this array should have the following properties: |
|
| 172 | - * * href - Often a mailto: address |
|
| 173 | - * * commonName - Optional, for example a first + last name |
|
| 174 | - * * status - See the Sabre\CalDAV\SharingPlugin::STATUS_ constants. |
|
| 175 | - * * readOnly - boolean |
|
| 176 | - * * summary - Optional, a description for the share |
|
| 177 | - * |
|
| 178 | - * @param int $resourceId |
|
| 179 | - * @return array |
|
| 180 | - */ |
|
| 181 | - public function getShares($resourceId) { |
|
| 182 | - $query = $this->db->getQueryBuilder(); |
|
| 183 | - $result = $query->select(['principaluri', 'access']) |
|
| 184 | - ->from('dav_shares') |
|
| 185 | - ->where($query->expr()->eq('resourceid', $query->createNamedParameter($resourceId))) |
|
| 186 | - ->andWhere($query->expr()->eq('type', $query->createNamedParameter($this->resourceType))) |
|
| 187 | - ->execute(); |
|
| 188 | - |
|
| 189 | - $shares = []; |
|
| 190 | - while($row = $result->fetch()) { |
|
| 191 | - $p = $this->principalBackend->getPrincipalByPath($row['principaluri']); |
|
| 192 | - $shares[]= [ |
|
| 193 | - 'href' => "principal:${row['principaluri']}", |
|
| 194 | - 'commonName' => isset($p['{DAV:}displayname']) ? $p['{DAV:}displayname'] : '', |
|
| 195 | - 'status' => 1, |
|
| 196 | - 'readOnly' => (int) $row['access'] === self::ACCESS_READ, |
|
| 197 | - '{http://owncloud.org/ns}principal' => $row['principaluri'], |
|
| 198 | - '{http://owncloud.org/ns}group-share' => is_null($p) |
|
| 199 | - ]; |
|
| 200 | - } |
|
| 201 | - |
|
| 202 | - return $shares; |
|
| 203 | - } |
|
| 204 | - |
|
| 205 | - /** |
|
| 206 | - * For shared resources the sharee is set in the ACL of the resource |
|
| 207 | - * |
|
| 208 | - * @param int $resourceId |
|
| 209 | - * @param array $acl |
|
| 210 | - * @return array |
|
| 211 | - */ |
|
| 212 | - public function applyShareAcl($resourceId, $acl) { |
|
| 213 | - |
|
| 214 | - $shares = $this->getShares($resourceId); |
|
| 215 | - foreach ($shares as $share) { |
|
| 216 | - $acl[] = [ |
|
| 217 | - 'privilege' => '{DAV:}read', |
|
| 218 | - 'principal' => $share['{' . \OCA\DAV\DAV\Sharing\Plugin::NS_OWNCLOUD . '}principal'], |
|
| 219 | - 'protected' => true, |
|
| 220 | - ]; |
|
| 221 | - if (!$share['readOnly']) { |
|
| 222 | - $acl[] = [ |
|
| 223 | - 'privilege' => '{DAV:}write', |
|
| 224 | - 'principal' => $share['{' . \OCA\DAV\DAV\Sharing\Plugin::NS_OWNCLOUD . '}principal'], |
|
| 225 | - 'protected' => true, |
|
| 226 | - ]; |
|
| 227 | - } else if ($this->resourceType === 'calendar') { |
|
| 228 | - // Allow changing the properties of read only calendars, |
|
| 229 | - // so users can change the visibility. |
|
| 230 | - $acl[] = [ |
|
| 231 | - 'privilege' => '{DAV:}write-properties', |
|
| 232 | - 'principal' => $share['{' . \OCA\DAV\DAV\Sharing\Plugin::NS_OWNCLOUD . '}principal'], |
|
| 233 | - 'protected' => true, |
|
| 234 | - ]; |
|
| 235 | - } |
|
| 236 | - } |
|
| 237 | - return $acl; |
|
| 238 | - } |
|
| 35 | + /** @var IDBConnection */ |
|
| 36 | + private $db; |
|
| 37 | + /** @var IUserManager */ |
|
| 38 | + private $userManager; |
|
| 39 | + /** @var IGroupManager */ |
|
| 40 | + private $groupManager; |
|
| 41 | + /** @var Principal */ |
|
| 42 | + private $principalBackend; |
|
| 43 | + /** @var string */ |
|
| 44 | + private $resourceType; |
|
| 45 | + |
|
| 46 | + const ACCESS_OWNER = 1; |
|
| 47 | + const ACCESS_READ_WRITE = 2; |
|
| 48 | + const ACCESS_READ = 3; |
|
| 49 | + |
|
| 50 | + /** |
|
| 51 | + * @param IDBConnection $db |
|
| 52 | + * @param IUserManager $userManager |
|
| 53 | + * @param IGroupManager $groupManager |
|
| 54 | + * @param Principal $principalBackend |
|
| 55 | + * @param string $resourceType |
|
| 56 | + */ |
|
| 57 | + public function __construct(IDBConnection $db, IUserManager $userManager, IGroupManager $groupManager, Principal $principalBackend, $resourceType) { |
|
| 58 | + $this->db = $db; |
|
| 59 | + $this->userManager = $userManager; |
|
| 60 | + $this->groupManager = $groupManager; |
|
| 61 | + $this->principalBackend = $principalBackend; |
|
| 62 | + $this->resourceType = $resourceType; |
|
| 63 | + } |
|
| 64 | + |
|
| 65 | + /** |
|
| 66 | + * @param IShareable $shareable |
|
| 67 | + * @param string[] $add |
|
| 68 | + * @param string[] $remove |
|
| 69 | + */ |
|
| 70 | + public function updateShares($shareable, $add, $remove) { |
|
| 71 | + foreach($add as $element) { |
|
| 72 | + $this->shareWith($shareable, $element); |
|
| 73 | + } |
|
| 74 | + foreach($remove as $element) { |
|
| 75 | + $this->unshare($shareable, $element); |
|
| 76 | + } |
|
| 77 | + } |
|
| 78 | + |
|
| 79 | + /** |
|
| 80 | + * @param IShareable $shareable |
|
| 81 | + * @param string $element |
|
| 82 | + */ |
|
| 83 | + private function shareWith($shareable, $element) { |
|
| 84 | + $user = $element['href']; |
|
| 85 | + $parts = explode(':', $user, 2); |
|
| 86 | + if ($parts[0] !== 'principal') { |
|
| 87 | + return; |
|
| 88 | + } |
|
| 89 | + |
|
| 90 | + // don't share with owner |
|
| 91 | + if ($shareable->getOwner() === $parts[1]) { |
|
| 92 | + return; |
|
| 93 | + } |
|
| 94 | + |
|
| 95 | + $principal = explode('/', $parts[1], 3); |
|
| 96 | + if (count($principal) !== 3 || $principal[0] !== 'principals' || !in_array($principal[1], ['users', 'groups'], true)) { |
|
| 97 | + // Invalid principal |
|
| 98 | + return; |
|
| 99 | + } |
|
| 100 | + |
|
| 101 | + if (($principal[1] === 'users' && !$this->userManager->userExists($principal[2])) || |
|
| 102 | + ($principal[1] === 'groups' && !$this->groupManager->groupExists($principal[2]))) { |
|
| 103 | + // User or group does not exist |
|
| 104 | + return; |
|
| 105 | + } |
|
| 106 | + |
|
| 107 | + // remove the share if it already exists |
|
| 108 | + $this->unshare($shareable, $element['href']); |
|
| 109 | + $access = self::ACCESS_READ; |
|
| 110 | + if (isset($element['readOnly'])) { |
|
| 111 | + $access = $element['readOnly'] ? self::ACCESS_READ : self::ACCESS_READ_WRITE; |
|
| 112 | + } |
|
| 113 | + |
|
| 114 | + $query = $this->db->getQueryBuilder(); |
|
| 115 | + $query->insert('dav_shares') |
|
| 116 | + ->values([ |
|
| 117 | + 'principaluri' => $query->createNamedParameter($parts[1]), |
|
| 118 | + 'type' => $query->createNamedParameter($this->resourceType), |
|
| 119 | + 'access' => $query->createNamedParameter($access), |
|
| 120 | + 'resourceid' => $query->createNamedParameter($shareable->getResourceId()) |
|
| 121 | + ]); |
|
| 122 | + $query->execute(); |
|
| 123 | + } |
|
| 124 | + |
|
| 125 | + /** |
|
| 126 | + * @param $resourceId |
|
| 127 | + */ |
|
| 128 | + public function deleteAllShares($resourceId) { |
|
| 129 | + $query = $this->db->getQueryBuilder(); |
|
| 130 | + $query->delete('dav_shares') |
|
| 131 | + ->where($query->expr()->eq('resourceid', $query->createNamedParameter($resourceId))) |
|
| 132 | + ->andWhere($query->expr()->eq('type', $query->createNamedParameter($this->resourceType))) |
|
| 133 | + ->execute(); |
|
| 134 | + } |
|
| 135 | + |
|
| 136 | + public function deleteAllSharesByUser($principaluri) { |
|
| 137 | + $query = $this->db->getQueryBuilder(); |
|
| 138 | + $query->delete('dav_shares') |
|
| 139 | + ->where($query->expr()->eq('principaluri', $query->createNamedParameter($principaluri))) |
|
| 140 | + ->andWhere($query->expr()->eq('type', $query->createNamedParameter($this->resourceType))) |
|
| 141 | + ->execute(); |
|
| 142 | + } |
|
| 143 | + |
|
| 144 | + /** |
|
| 145 | + * @param IShareable $shareable |
|
| 146 | + * @param string $element |
|
| 147 | + */ |
|
| 148 | + private function unshare($shareable, $element) { |
|
| 149 | + $parts = explode(':', $element, 2); |
|
| 150 | + if ($parts[0] !== 'principal') { |
|
| 151 | + return; |
|
| 152 | + } |
|
| 153 | + |
|
| 154 | + // don't share with owner |
|
| 155 | + if ($shareable->getOwner() === $parts[1]) { |
|
| 156 | + return; |
|
| 157 | + } |
|
| 158 | + |
|
| 159 | + $query = $this->db->getQueryBuilder(); |
|
| 160 | + $query->delete('dav_shares') |
|
| 161 | + ->where($query->expr()->eq('resourceid', $query->createNamedParameter($shareable->getResourceId()))) |
|
| 162 | + ->andWhere($query->expr()->eq('type', $query->createNamedParameter($this->resourceType))) |
|
| 163 | + ->andWhere($query->expr()->eq('principaluri', $query->createNamedParameter($parts[1]))) |
|
| 164 | + ; |
|
| 165 | + $query->execute(); |
|
| 166 | + } |
|
| 167 | + |
|
| 168 | + /** |
|
| 169 | + * Returns the list of people whom this resource is shared with. |
|
| 170 | + * |
|
| 171 | + * Every element in this array should have the following properties: |
|
| 172 | + * * href - Often a mailto: address |
|
| 173 | + * * commonName - Optional, for example a first + last name |
|
| 174 | + * * status - See the Sabre\CalDAV\SharingPlugin::STATUS_ constants. |
|
| 175 | + * * readOnly - boolean |
|
| 176 | + * * summary - Optional, a description for the share |
|
| 177 | + * |
|
| 178 | + * @param int $resourceId |
|
| 179 | + * @return array |
|
| 180 | + */ |
|
| 181 | + public function getShares($resourceId) { |
|
| 182 | + $query = $this->db->getQueryBuilder(); |
|
| 183 | + $result = $query->select(['principaluri', 'access']) |
|
| 184 | + ->from('dav_shares') |
|
| 185 | + ->where($query->expr()->eq('resourceid', $query->createNamedParameter($resourceId))) |
|
| 186 | + ->andWhere($query->expr()->eq('type', $query->createNamedParameter($this->resourceType))) |
|
| 187 | + ->execute(); |
|
| 188 | + |
|
| 189 | + $shares = []; |
|
| 190 | + while($row = $result->fetch()) { |
|
| 191 | + $p = $this->principalBackend->getPrincipalByPath($row['principaluri']); |
|
| 192 | + $shares[]= [ |
|
| 193 | + 'href' => "principal:${row['principaluri']}", |
|
| 194 | + 'commonName' => isset($p['{DAV:}displayname']) ? $p['{DAV:}displayname'] : '', |
|
| 195 | + 'status' => 1, |
|
| 196 | + 'readOnly' => (int) $row['access'] === self::ACCESS_READ, |
|
| 197 | + '{http://owncloud.org/ns}principal' => $row['principaluri'], |
|
| 198 | + '{http://owncloud.org/ns}group-share' => is_null($p) |
|
| 199 | + ]; |
|
| 200 | + } |
|
| 201 | + |
|
| 202 | + return $shares; |
|
| 203 | + } |
|
| 204 | + |
|
| 205 | + /** |
|
| 206 | + * For shared resources the sharee is set in the ACL of the resource |
|
| 207 | + * |
|
| 208 | + * @param int $resourceId |
|
| 209 | + * @param array $acl |
|
| 210 | + * @return array |
|
| 211 | + */ |
|
| 212 | + public function applyShareAcl($resourceId, $acl) { |
|
| 213 | + |
|
| 214 | + $shares = $this->getShares($resourceId); |
|
| 215 | + foreach ($shares as $share) { |
|
| 216 | + $acl[] = [ |
|
| 217 | + 'privilege' => '{DAV:}read', |
|
| 218 | + 'principal' => $share['{' . \OCA\DAV\DAV\Sharing\Plugin::NS_OWNCLOUD . '}principal'], |
|
| 219 | + 'protected' => true, |
|
| 220 | + ]; |
|
| 221 | + if (!$share['readOnly']) { |
|
| 222 | + $acl[] = [ |
|
| 223 | + 'privilege' => '{DAV:}write', |
|
| 224 | + 'principal' => $share['{' . \OCA\DAV\DAV\Sharing\Plugin::NS_OWNCLOUD . '}principal'], |
|
| 225 | + 'protected' => true, |
|
| 226 | + ]; |
|
| 227 | + } else if ($this->resourceType === 'calendar') { |
|
| 228 | + // Allow changing the properties of read only calendars, |
|
| 229 | + // so users can change the visibility. |
|
| 230 | + $acl[] = [ |
|
| 231 | + 'privilege' => '{DAV:}write-properties', |
|
| 232 | + 'principal' => $share['{' . \OCA\DAV\DAV\Sharing\Plugin::NS_OWNCLOUD . '}principal'], |
|
| 233 | + 'protected' => true, |
|
| 234 | + ]; |
|
| 235 | + } |
|
| 236 | + } |
|
| 237 | + return $acl; |
|
| 238 | + } |
|
| 239 | 239 | } |
@@ -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 | } |
@@ -69,7 +69,7 @@ discard block |
||
| 69 | 69 | \Closure $childExistsFunction |
| 70 | 70 | ) { |
| 71 | 71 | $name = trim($name); |
| 72 | - if(empty($name) || !is_string($name)) { |
|
| 72 | + if (empty($name) || !is_string($name)) { |
|
| 73 | 73 | throw new \InvalidArgumentException('"name" parameter must be non-empty string'); |
| 74 | 74 | } |
| 75 | 75 | $this->name = $name; |
@@ -91,7 +91,7 @@ discard block |
||
| 91 | 91 | * @throws NotFound |
| 92 | 92 | */ |
| 93 | 93 | function getChild($name) { |
| 94 | - if(!$this->childExists($name)) { |
|
| 94 | + if (!$this->childExists($name)) { |
|
| 95 | 95 | throw new NotFound('Entity does not exist or is not available'); |
| 96 | 96 | } |
| 97 | 97 | return new EntityCollection( |
@@ -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 | } |
@@ -86,11 +86,11 @@ discard block |
||
| 86 | 86 | * @throws NotAuthenticated |
| 87 | 87 | */ |
| 88 | 88 | protected function initCollections() { |
| 89 | - if($this->entityTypeCollections !== null) { |
|
| 89 | + if ($this->entityTypeCollections !== null) { |
|
| 90 | 90 | return; |
| 91 | 91 | } |
| 92 | 92 | $user = $this->userSession->getUser(); |
| 93 | - if(is_null($user)) { |
|
| 93 | + if (is_null($user)) { |
|
| 94 | 94 | throw new NotAuthenticated(); |
| 95 | 95 | } |
| 96 | 96 | |
@@ -144,10 +144,10 @@ discard block |
||
| 144 | 144 | */ |
| 145 | 145 | function getChild($name) { |
| 146 | 146 | $this->initCollections(); |
| 147 | - if(isset($this->entityTypeCollections[$name])) { |
|
| 147 | + if (isset($this->entityTypeCollections[$name])) { |
|
| 148 | 148 | return $this->entityTypeCollections[$name]; |
| 149 | 149 | } |
| 150 | - throw new NotFound('Entity type "' . $name . '" not found."'); |
|
| 150 | + throw new NotFound('Entity type "'.$name.'" not found."'); |
|
| 151 | 151 | } |
| 152 | 152 | |
| 153 | 153 | /** |
@@ -100,13 +100,13 @@ |
||
| 100 | 100 | if ($this->shareManager->checkPassword($share, $password)) { |
| 101 | 101 | return true; |
| 102 | 102 | } else if ($this->session->exists('public_link_authenticated') |
| 103 | - && $this->session->get('public_link_authenticated') === (string)$share->getId()) { |
|
| 103 | + && $this->session->get('public_link_authenticated') === (string) $share->getId()) { |
|
| 104 | 104 | return true; |
| 105 | 105 | } else { |
| 106 | 106 | if (in_array('XMLHttpRequest', explode(',', $this->request->getHeader('X-Requested-With')))) { |
| 107 | 107 | // do not re-authenticate over ajax, use dummy auth name to prevent browser popup |
| 108 | 108 | http_response_code(401); |
| 109 | - header('WWW-Authenticate','DummyBasic realm="' . $this->realm . '"'); |
|
| 109 | + header('WWW-Authenticate', 'DummyBasic realm="'.$this->realm.'"'); |
|
| 110 | 110 | throw new \Sabre\DAV\Exception\NotAuthenticated('Cannot authenticate over ajax calls'); |
| 111 | 111 | } |
| 112 | 112 | return false; |
@@ -42,89 +42,89 @@ |
||
| 42 | 42 | */ |
| 43 | 43 | class PublicAuth extends AbstractBasic { |
| 44 | 44 | |
| 45 | - /** @var \OCP\Share\IShare */ |
|
| 46 | - private $share; |
|
| 45 | + /** @var \OCP\Share\IShare */ |
|
| 46 | + private $share; |
|
| 47 | 47 | |
| 48 | - /** @var IManager */ |
|
| 49 | - private $shareManager; |
|
| 48 | + /** @var IManager */ |
|
| 49 | + private $shareManager; |
|
| 50 | 50 | |
| 51 | - /** @var ISession */ |
|
| 52 | - private $session; |
|
| 51 | + /** @var ISession */ |
|
| 52 | + private $session; |
|
| 53 | 53 | |
| 54 | - /** @var IRequest */ |
|
| 55 | - private $request; |
|
| 54 | + /** @var IRequest */ |
|
| 55 | + private $request; |
|
| 56 | 56 | |
| 57 | - /** |
|
| 58 | - * @param IRequest $request |
|
| 59 | - * @param IManager $shareManager |
|
| 60 | - * @param ISession $session |
|
| 61 | - */ |
|
| 62 | - public function __construct(IRequest $request, |
|
| 63 | - IManager $shareManager, |
|
| 64 | - ISession $session) { |
|
| 65 | - $this->request = $request; |
|
| 66 | - $this->shareManager = $shareManager; |
|
| 67 | - $this->session = $session; |
|
| 57 | + /** |
|
| 58 | + * @param IRequest $request |
|
| 59 | + * @param IManager $shareManager |
|
| 60 | + * @param ISession $session |
|
| 61 | + */ |
|
| 62 | + public function __construct(IRequest $request, |
|
| 63 | + IManager $shareManager, |
|
| 64 | + ISession $session) { |
|
| 65 | + $this->request = $request; |
|
| 66 | + $this->shareManager = $shareManager; |
|
| 67 | + $this->session = $session; |
|
| 68 | 68 | |
| 69 | - // setup realm |
|
| 70 | - $defaults = new \OCP\Defaults(); |
|
| 71 | - $this->realm = $defaults->getName(); |
|
| 72 | - } |
|
| 69 | + // setup realm |
|
| 70 | + $defaults = new \OCP\Defaults(); |
|
| 71 | + $this->realm = $defaults->getName(); |
|
| 72 | + } |
|
| 73 | 73 | |
| 74 | - /** |
|
| 75 | - * Validates a username and password |
|
| 76 | - * |
|
| 77 | - * This method should return true or false depending on if login |
|
| 78 | - * succeeded. |
|
| 79 | - * |
|
| 80 | - * @param string $username |
|
| 81 | - * @param string $password |
|
| 82 | - * |
|
| 83 | - * @return bool |
|
| 84 | - * @throws \Sabre\DAV\Exception\NotAuthenticated |
|
| 85 | - */ |
|
| 86 | - protected function validateUserPass($username, $password) { |
|
| 87 | - try { |
|
| 88 | - $share = $this->shareManager->getShareByToken($username); |
|
| 89 | - } catch (ShareNotFound $e) { |
|
| 90 | - return false; |
|
| 91 | - } |
|
| 74 | + /** |
|
| 75 | + * Validates a username and password |
|
| 76 | + * |
|
| 77 | + * This method should return true or false depending on if login |
|
| 78 | + * succeeded. |
|
| 79 | + * |
|
| 80 | + * @param string $username |
|
| 81 | + * @param string $password |
|
| 82 | + * |
|
| 83 | + * @return bool |
|
| 84 | + * @throws \Sabre\DAV\Exception\NotAuthenticated |
|
| 85 | + */ |
|
| 86 | + protected function validateUserPass($username, $password) { |
|
| 87 | + try { |
|
| 88 | + $share = $this->shareManager->getShareByToken($username); |
|
| 89 | + } catch (ShareNotFound $e) { |
|
| 90 | + return false; |
|
| 91 | + } |
|
| 92 | 92 | |
| 93 | - $this->share = $share; |
|
| 93 | + $this->share = $share; |
|
| 94 | 94 | |
| 95 | - \OC_User::setIncognitoMode(true); |
|
| 95 | + \OC_User::setIncognitoMode(true); |
|
| 96 | 96 | |
| 97 | - // check if the share is password protected |
|
| 98 | - if ($share->getPassword() !== null) { |
|
| 99 | - if ($share->getShareType() === \OCP\Share::SHARE_TYPE_LINK || $share->getShareType() === \OCP\Share::SHARE_TYPE_EMAIL) { |
|
| 100 | - if ($this->shareManager->checkPassword($share, $password)) { |
|
| 101 | - return true; |
|
| 102 | - } else if ($this->session->exists('public_link_authenticated') |
|
| 103 | - && $this->session->get('public_link_authenticated') === (string)$share->getId()) { |
|
| 104 | - return true; |
|
| 105 | - } else { |
|
| 106 | - if (in_array('XMLHttpRequest', explode(',', $this->request->getHeader('X-Requested-With')))) { |
|
| 107 | - // do not re-authenticate over ajax, use dummy auth name to prevent browser popup |
|
| 108 | - http_response_code(401); |
|
| 109 | - header('WWW-Authenticate','DummyBasic realm="' . $this->realm . '"'); |
|
| 110 | - throw new \Sabre\DAV\Exception\NotAuthenticated('Cannot authenticate over ajax calls'); |
|
| 111 | - } |
|
| 112 | - return false; |
|
| 113 | - } |
|
| 114 | - } else if ($share->getShareType() === \OCP\Share::SHARE_TYPE_REMOTE) { |
|
| 115 | - return true; |
|
| 116 | - } else { |
|
| 117 | - return false; |
|
| 118 | - } |
|
| 119 | - } else { |
|
| 120 | - return true; |
|
| 121 | - } |
|
| 122 | - } |
|
| 97 | + // check if the share is password protected |
|
| 98 | + if ($share->getPassword() !== null) { |
|
| 99 | + if ($share->getShareType() === \OCP\Share::SHARE_TYPE_LINK || $share->getShareType() === \OCP\Share::SHARE_TYPE_EMAIL) { |
|
| 100 | + if ($this->shareManager->checkPassword($share, $password)) { |
|
| 101 | + return true; |
|
| 102 | + } else if ($this->session->exists('public_link_authenticated') |
|
| 103 | + && $this->session->get('public_link_authenticated') === (string)$share->getId()) { |
|
| 104 | + return true; |
|
| 105 | + } else { |
|
| 106 | + if (in_array('XMLHttpRequest', explode(',', $this->request->getHeader('X-Requested-With')))) { |
|
| 107 | + // do not re-authenticate over ajax, use dummy auth name to prevent browser popup |
|
| 108 | + http_response_code(401); |
|
| 109 | + header('WWW-Authenticate','DummyBasic realm="' . $this->realm . '"'); |
|
| 110 | + throw new \Sabre\DAV\Exception\NotAuthenticated('Cannot authenticate over ajax calls'); |
|
| 111 | + } |
|
| 112 | + return false; |
|
| 113 | + } |
|
| 114 | + } else if ($share->getShareType() === \OCP\Share::SHARE_TYPE_REMOTE) { |
|
| 115 | + return true; |
|
| 116 | + } else { |
|
| 117 | + return false; |
|
| 118 | + } |
|
| 119 | + } else { |
|
| 120 | + return true; |
|
| 121 | + } |
|
| 122 | + } |
|
| 123 | 123 | |
| 124 | - /** |
|
| 125 | - * @return \OCP\Share\IShare |
|
| 126 | - */ |
|
| 127 | - public function getShare() { |
|
| 128 | - return $this->share; |
|
| 129 | - } |
|
| 124 | + /** |
|
| 125 | + * @return \OCP\Share\IShare |
|
| 126 | + */ |
|
| 127 | + public function getShare() { |
|
| 128 | + return $this->share; |
|
| 129 | + } |
|
| 130 | 130 | } |
@@ -102,11 +102,11 @@ |
||
| 102 | 102 | * @param array $conditions |
| 103 | 103 | */ |
| 104 | 104 | public function validateTokens(RequestInterface $request, &$conditions) { |
| 105 | - foreach($conditions as &$fileCondition) { |
|
| 106 | - if(isset($fileCondition['tokens'])) { |
|
| 107 | - foreach($fileCondition['tokens'] as &$token) { |
|
| 108 | - if(isset($token['token'])) { |
|
| 109 | - if(substr($token['token'], 0, 16) === 'opaquelocktoken:') { |
|
| 105 | + foreach ($conditions as &$fileCondition) { |
|
| 106 | + if (isset($fileCondition['tokens'])) { |
|
| 107 | + foreach ($fileCondition['tokens'] as &$token) { |
|
| 108 | + if (isset($token['token'])) { |
|
| 109 | + if (substr($token['token'], 0, 16) === 'opaquelocktoken:') { |
|
| 110 | 110 | $token['validToken'] = true; |
| 111 | 111 | } |
| 112 | 112 | } |
@@ -45,114 +45,114 @@ |
||
| 45 | 45 | * @package OCA\DAV\Connector\Sabre |
| 46 | 46 | */ |
| 47 | 47 | class FakeLockerPlugin extends ServerPlugin { |
| 48 | - /** @var \Sabre\DAV\Server */ |
|
| 49 | - private $server; |
|
| 48 | + /** @var \Sabre\DAV\Server */ |
|
| 49 | + private $server; |
|
| 50 | 50 | |
| 51 | - /** {@inheritDoc} */ |
|
| 52 | - public function initialize(\Sabre\DAV\Server $server) { |
|
| 53 | - $this->server = $server; |
|
| 54 | - $this->server->on('method:LOCK', [$this, 'fakeLockProvider'], 1); |
|
| 55 | - $this->server->on('method:UNLOCK', [$this, 'fakeUnlockProvider'], 1); |
|
| 56 | - $server->on('propFind', [$this, 'propFind']); |
|
| 57 | - $server->on('validateTokens', [$this, 'validateTokens']); |
|
| 58 | - } |
|
| 51 | + /** {@inheritDoc} */ |
|
| 52 | + public function initialize(\Sabre\DAV\Server $server) { |
|
| 53 | + $this->server = $server; |
|
| 54 | + $this->server->on('method:LOCK', [$this, 'fakeLockProvider'], 1); |
|
| 55 | + $this->server->on('method:UNLOCK', [$this, 'fakeUnlockProvider'], 1); |
|
| 56 | + $server->on('propFind', [$this, 'propFind']); |
|
| 57 | + $server->on('validateTokens', [$this, 'validateTokens']); |
|
| 58 | + } |
|
| 59 | 59 | |
| 60 | - /** |
|
| 61 | - * Indicate that we support LOCK and UNLOCK |
|
| 62 | - * |
|
| 63 | - * @param string $path |
|
| 64 | - * @return string[] |
|
| 65 | - */ |
|
| 66 | - public function getHTTPMethods($path) { |
|
| 67 | - return [ |
|
| 68 | - 'LOCK', |
|
| 69 | - 'UNLOCK', |
|
| 70 | - ]; |
|
| 71 | - } |
|
| 60 | + /** |
|
| 61 | + * Indicate that we support LOCK and UNLOCK |
|
| 62 | + * |
|
| 63 | + * @param string $path |
|
| 64 | + * @return string[] |
|
| 65 | + */ |
|
| 66 | + public function getHTTPMethods($path) { |
|
| 67 | + return [ |
|
| 68 | + 'LOCK', |
|
| 69 | + 'UNLOCK', |
|
| 70 | + ]; |
|
| 71 | + } |
|
| 72 | 72 | |
| 73 | - /** |
|
| 74 | - * Indicate that we support locking |
|
| 75 | - * |
|
| 76 | - * @return integer[] |
|
| 77 | - */ |
|
| 78 | - function getFeatures() { |
|
| 79 | - return [2]; |
|
| 80 | - } |
|
| 73 | + /** |
|
| 74 | + * Indicate that we support locking |
|
| 75 | + * |
|
| 76 | + * @return integer[] |
|
| 77 | + */ |
|
| 78 | + function getFeatures() { |
|
| 79 | + return [2]; |
|
| 80 | + } |
|
| 81 | 81 | |
| 82 | - /** |
|
| 83 | - * Return some dummy response for PROPFIND requests with regard to locking |
|
| 84 | - * |
|
| 85 | - * @param PropFind $propFind |
|
| 86 | - * @param INode $node |
|
| 87 | - * @return void |
|
| 88 | - */ |
|
| 89 | - function propFind(PropFind $propFind, INode $node) { |
|
| 90 | - $propFind->handle('{DAV:}supportedlock', function() { |
|
| 91 | - return new SupportedLock(true); |
|
| 92 | - }); |
|
| 93 | - $propFind->handle('{DAV:}lockdiscovery', function() use ($propFind) { |
|
| 94 | - return new LockDiscovery([]); |
|
| 95 | - }); |
|
| 96 | - } |
|
| 82 | + /** |
|
| 83 | + * Return some dummy response for PROPFIND requests with regard to locking |
|
| 84 | + * |
|
| 85 | + * @param PropFind $propFind |
|
| 86 | + * @param INode $node |
|
| 87 | + * @return void |
|
| 88 | + */ |
|
| 89 | + function propFind(PropFind $propFind, INode $node) { |
|
| 90 | + $propFind->handle('{DAV:}supportedlock', function() { |
|
| 91 | + return new SupportedLock(true); |
|
| 92 | + }); |
|
| 93 | + $propFind->handle('{DAV:}lockdiscovery', function() use ($propFind) { |
|
| 94 | + return new LockDiscovery([]); |
|
| 95 | + }); |
|
| 96 | + } |
|
| 97 | 97 | |
| 98 | - /** |
|
| 99 | - * Mark a locking token always as valid |
|
| 100 | - * |
|
| 101 | - * @param RequestInterface $request |
|
| 102 | - * @param array $conditions |
|
| 103 | - */ |
|
| 104 | - public function validateTokens(RequestInterface $request, &$conditions) { |
|
| 105 | - foreach($conditions as &$fileCondition) { |
|
| 106 | - if(isset($fileCondition['tokens'])) { |
|
| 107 | - foreach($fileCondition['tokens'] as &$token) { |
|
| 108 | - if(isset($token['token'])) { |
|
| 109 | - if(substr($token['token'], 0, 16) === 'opaquelocktoken:') { |
|
| 110 | - $token['validToken'] = true; |
|
| 111 | - } |
|
| 112 | - } |
|
| 113 | - } |
|
| 114 | - } |
|
| 115 | - } |
|
| 116 | - } |
|
| 98 | + /** |
|
| 99 | + * Mark a locking token always as valid |
|
| 100 | + * |
|
| 101 | + * @param RequestInterface $request |
|
| 102 | + * @param array $conditions |
|
| 103 | + */ |
|
| 104 | + public function validateTokens(RequestInterface $request, &$conditions) { |
|
| 105 | + foreach($conditions as &$fileCondition) { |
|
| 106 | + if(isset($fileCondition['tokens'])) { |
|
| 107 | + foreach($fileCondition['tokens'] as &$token) { |
|
| 108 | + if(isset($token['token'])) { |
|
| 109 | + if(substr($token['token'], 0, 16) === 'opaquelocktoken:') { |
|
| 110 | + $token['validToken'] = true; |
|
| 111 | + } |
|
| 112 | + } |
|
| 113 | + } |
|
| 114 | + } |
|
| 115 | + } |
|
| 116 | + } |
|
| 117 | 117 | |
| 118 | - /** |
|
| 119 | - * Fakes a successful LOCK |
|
| 120 | - * |
|
| 121 | - * @param RequestInterface $request |
|
| 122 | - * @param ResponseInterface $response |
|
| 123 | - * @return bool |
|
| 124 | - */ |
|
| 125 | - public function fakeLockProvider(RequestInterface $request, |
|
| 126 | - ResponseInterface $response) { |
|
| 118 | + /** |
|
| 119 | + * Fakes a successful LOCK |
|
| 120 | + * |
|
| 121 | + * @param RequestInterface $request |
|
| 122 | + * @param ResponseInterface $response |
|
| 123 | + * @return bool |
|
| 124 | + */ |
|
| 125 | + public function fakeLockProvider(RequestInterface $request, |
|
| 126 | + ResponseInterface $response) { |
|
| 127 | 127 | |
| 128 | - $lockInfo = new LockInfo(); |
|
| 129 | - $lockInfo->token = md5($request->getPath()); |
|
| 130 | - $lockInfo->uri = $request->getPath(); |
|
| 131 | - $lockInfo->depth = \Sabre\DAV\Server::DEPTH_INFINITY; |
|
| 132 | - $lockInfo->timeout = 1800; |
|
| 128 | + $lockInfo = new LockInfo(); |
|
| 129 | + $lockInfo->token = md5($request->getPath()); |
|
| 130 | + $lockInfo->uri = $request->getPath(); |
|
| 131 | + $lockInfo->depth = \Sabre\DAV\Server::DEPTH_INFINITY; |
|
| 132 | + $lockInfo->timeout = 1800; |
|
| 133 | 133 | |
| 134 | - $body = $this->server->xml->write('{DAV:}prop', [ |
|
| 135 | - '{DAV:}lockdiscovery' => |
|
| 136 | - new LockDiscovery([$lockInfo]) |
|
| 137 | - ]); |
|
| 134 | + $body = $this->server->xml->write('{DAV:}prop', [ |
|
| 135 | + '{DAV:}lockdiscovery' => |
|
| 136 | + new LockDiscovery([$lockInfo]) |
|
| 137 | + ]); |
|
| 138 | 138 | |
| 139 | - $response->setStatus(200); |
|
| 140 | - $response->setBody($body); |
|
| 139 | + $response->setStatus(200); |
|
| 140 | + $response->setBody($body); |
|
| 141 | 141 | |
| 142 | - return false; |
|
| 143 | - } |
|
| 142 | + return false; |
|
| 143 | + } |
|
| 144 | 144 | |
| 145 | - /** |
|
| 146 | - * Fakes a successful LOCK |
|
| 147 | - * |
|
| 148 | - * @param RequestInterface $request |
|
| 149 | - * @param ResponseInterface $response |
|
| 150 | - * @return bool |
|
| 151 | - */ |
|
| 152 | - public function fakeUnlockProvider(RequestInterface $request, |
|
| 153 | - ResponseInterface $response) { |
|
| 154 | - $response->setStatus(204); |
|
| 155 | - $response->setHeader('Content-Length', '0'); |
|
| 156 | - return false; |
|
| 157 | - } |
|
| 145 | + /** |
|
| 146 | + * Fakes a successful LOCK |
|
| 147 | + * |
|
| 148 | + * @param RequestInterface $request |
|
| 149 | + * @param ResponseInterface $response |
|
| 150 | + * @return bool |
|
| 151 | + */ |
|
| 152 | + public function fakeUnlockProvider(RequestInterface $request, |
|
| 153 | + ResponseInterface $response) { |
|
| 154 | + $response->setStatus(204); |
|
| 155 | + $response->setHeader('Content-Length', '0'); |
|
| 156 | + return false; |
|
| 157 | + } |
|
| 158 | 158 | } |
@@ -41,362 +41,362 @@ |
||
| 41 | 41 | |
| 42 | 42 | class FilesReportPlugin extends ServerPlugin { |
| 43 | 43 | |
| 44 | - // namespace |
|
| 45 | - const NS_OWNCLOUD = 'http://owncloud.org/ns'; |
|
| 46 | - const REPORT_NAME = '{http://owncloud.org/ns}filter-files'; |
|
| 47 | - const SYSTEMTAG_PROPERTYNAME = '{http://owncloud.org/ns}systemtag'; |
|
| 48 | - |
|
| 49 | - /** |
|
| 50 | - * Reference to main server object |
|
| 51 | - * |
|
| 52 | - * @var \Sabre\DAV\Server |
|
| 53 | - */ |
|
| 54 | - private $server; |
|
| 55 | - |
|
| 56 | - /** |
|
| 57 | - * @var Tree |
|
| 58 | - */ |
|
| 59 | - private $tree; |
|
| 60 | - |
|
| 61 | - /** |
|
| 62 | - * @var View |
|
| 63 | - */ |
|
| 64 | - private $fileView; |
|
| 65 | - |
|
| 66 | - /** |
|
| 67 | - * @var ISystemTagManager |
|
| 68 | - */ |
|
| 69 | - private $tagManager; |
|
| 70 | - |
|
| 71 | - /** |
|
| 72 | - * @var ISystemTagObjectMapper |
|
| 73 | - */ |
|
| 74 | - private $tagMapper; |
|
| 75 | - |
|
| 76 | - /** |
|
| 77 | - * Manager for private tags |
|
| 78 | - * |
|
| 79 | - * @var ITagManager |
|
| 80 | - */ |
|
| 81 | - private $fileTagger; |
|
| 82 | - |
|
| 83 | - /** |
|
| 84 | - * @var IUserSession |
|
| 85 | - */ |
|
| 86 | - private $userSession; |
|
| 87 | - |
|
| 88 | - /** |
|
| 89 | - * @var IGroupManager |
|
| 90 | - */ |
|
| 91 | - private $groupManager; |
|
| 92 | - |
|
| 93 | - /** |
|
| 94 | - * @var Folder |
|
| 95 | - */ |
|
| 96 | - private $userFolder; |
|
| 97 | - |
|
| 98 | - /** |
|
| 99 | - * @param Tree $tree |
|
| 100 | - * @param View $view |
|
| 101 | - * @param ISystemTagManager $tagManager |
|
| 102 | - * @param ISystemTagObjectMapper $tagMapper |
|
| 103 | - * @param ITagManager $fileTagger manager for private tags |
|
| 104 | - * @param IUserSession $userSession |
|
| 105 | - * @param IGroupManager $groupManager |
|
| 106 | - * @param Folder $userFolder |
|
| 107 | - */ |
|
| 108 | - public function __construct(Tree $tree, |
|
| 109 | - View $view, |
|
| 110 | - ISystemTagManager $tagManager, |
|
| 111 | - ISystemTagObjectMapper $tagMapper, |
|
| 112 | - ITagManager $fileTagger, |
|
| 113 | - IUserSession $userSession, |
|
| 114 | - IGroupManager $groupManager, |
|
| 115 | - Folder $userFolder |
|
| 116 | - ) { |
|
| 117 | - $this->tree = $tree; |
|
| 118 | - $this->fileView = $view; |
|
| 119 | - $this->tagManager = $tagManager; |
|
| 120 | - $this->tagMapper = $tagMapper; |
|
| 121 | - $this->fileTagger = $fileTagger; |
|
| 122 | - $this->userSession = $userSession; |
|
| 123 | - $this->groupManager = $groupManager; |
|
| 124 | - $this->userFolder = $userFolder; |
|
| 125 | - } |
|
| 126 | - |
|
| 127 | - /** |
|
| 128 | - * This initializes the plugin. |
|
| 129 | - * |
|
| 130 | - * This function is called by \Sabre\DAV\Server, after |
|
| 131 | - * addPlugin is called. |
|
| 132 | - * |
|
| 133 | - * This method should set up the required event subscriptions. |
|
| 134 | - * |
|
| 135 | - * @param \Sabre\DAV\Server $server |
|
| 136 | - * @return void |
|
| 137 | - */ |
|
| 138 | - public function initialize(\Sabre\DAV\Server $server) { |
|
| 139 | - |
|
| 140 | - $server->xml->namespaceMap[self::NS_OWNCLOUD] = 'oc'; |
|
| 141 | - |
|
| 142 | - $this->server = $server; |
|
| 143 | - $this->server->on('report', array($this, 'onReport')); |
|
| 144 | - } |
|
| 145 | - |
|
| 146 | - /** |
|
| 147 | - * Returns a list of reports this plugin supports. |
|
| 148 | - * |
|
| 149 | - * This will be used in the {DAV:}supported-report-set property. |
|
| 150 | - * |
|
| 151 | - * @param string $uri |
|
| 152 | - * @return array |
|
| 153 | - */ |
|
| 154 | - public function getSupportedReportSet($uri) { |
|
| 155 | - return [self::REPORT_NAME]; |
|
| 156 | - } |
|
| 157 | - |
|
| 158 | - /** |
|
| 159 | - * REPORT operations to look for files |
|
| 160 | - * |
|
| 161 | - * @param string $reportName |
|
| 162 | - * @param $report |
|
| 163 | - * @param string $uri |
|
| 164 | - * @return bool |
|
| 165 | - * @throws BadRequest |
|
| 166 | - * @throws PreconditionFailed |
|
| 167 | - * @internal param $ [] $report |
|
| 168 | - */ |
|
| 169 | - public function onReport($reportName, $report, $uri) { |
|
| 170 | - $reportTargetNode = $this->server->tree->getNodeForPath($uri); |
|
| 171 | - if (!$reportTargetNode instanceof Directory || $reportName !== self::REPORT_NAME) { |
|
| 172 | - return; |
|
| 173 | - } |
|
| 174 | - |
|
| 175 | - $ns = '{' . $this::NS_OWNCLOUD . '}'; |
|
| 176 | - $requestedProps = []; |
|
| 177 | - $filterRules = []; |
|
| 178 | - |
|
| 179 | - // parse report properties and gather filter info |
|
| 180 | - foreach ($report as $reportProps) { |
|
| 181 | - $name = $reportProps['name']; |
|
| 182 | - if ($name === $ns . 'filter-rules') { |
|
| 183 | - $filterRules = $reportProps['value']; |
|
| 184 | - } else if ($name === '{DAV:}prop') { |
|
| 185 | - // propfind properties |
|
| 186 | - foreach ($reportProps['value'] as $propVal) { |
|
| 187 | - $requestedProps[] = $propVal['name']; |
|
| 188 | - } |
|
| 189 | - } |
|
| 190 | - } |
|
| 191 | - |
|
| 192 | - if (empty($filterRules)) { |
|
| 193 | - // an empty filter would return all existing files which would be slow |
|
| 194 | - throw new BadRequest('Missing filter-rule block in request'); |
|
| 195 | - } |
|
| 196 | - |
|
| 197 | - // gather all file ids matching filter |
|
| 198 | - try { |
|
| 199 | - $resultFileIds = $this->processFilterRules($filterRules); |
|
| 200 | - } catch (TagNotFoundException $e) { |
|
| 201 | - throw new PreconditionFailed('Cannot filter by non-existing tag', 0, $e); |
|
| 202 | - } |
|
| 203 | - |
|
| 204 | - // find sabre nodes by file id, restricted to the root node path |
|
| 205 | - $results = $this->findNodesByFileIds($reportTargetNode, $resultFileIds); |
|
| 206 | - |
|
| 207 | - $filesUri = $this->getFilesBaseUri($uri, $reportTargetNode->getPath()); |
|
| 208 | - $responses = $this->prepareResponses($filesUri, $requestedProps, $results); |
|
| 209 | - |
|
| 210 | - $xml = $this->server->xml->write( |
|
| 211 | - '{DAV:}multistatus', |
|
| 212 | - new MultiStatus($responses) |
|
| 213 | - ); |
|
| 214 | - |
|
| 215 | - $this->server->httpResponse->setStatus(207); |
|
| 216 | - $this->server->httpResponse->setHeader('Content-Type', 'application/xml; charset=utf-8'); |
|
| 217 | - $this->server->httpResponse->setBody($xml); |
|
| 218 | - |
|
| 219 | - return false; |
|
| 220 | - } |
|
| 221 | - |
|
| 222 | - /** |
|
| 223 | - * Returns the base uri of the files root by removing |
|
| 224 | - * the subpath from the URI |
|
| 225 | - * |
|
| 226 | - * @param string $uri URI from this request |
|
| 227 | - * @param string $subPath subpath to remove from the URI |
|
| 228 | - * |
|
| 229 | - * @return string files base uri |
|
| 230 | - */ |
|
| 231 | - private function getFilesBaseUri($uri, $subPath) { |
|
| 232 | - $uri = trim($uri, '/'); |
|
| 233 | - $subPath = trim($subPath, '/'); |
|
| 234 | - if (empty($subPath)) { |
|
| 235 | - $filesUri = $uri; |
|
| 236 | - } else { |
|
| 237 | - $filesUri = substr($uri, 0, strlen($uri) - strlen($subPath)); |
|
| 238 | - } |
|
| 239 | - $filesUri = trim($filesUri, '/'); |
|
| 240 | - if (empty($filesUri)) { |
|
| 241 | - return ''; |
|
| 242 | - } |
|
| 243 | - return '/' . $filesUri; |
|
| 244 | - } |
|
| 245 | - |
|
| 246 | - /** |
|
| 247 | - * Find file ids matching the given filter rules |
|
| 248 | - * |
|
| 249 | - * @param array $filterRules |
|
| 250 | - * @return array array of unique file id results |
|
| 251 | - * |
|
| 252 | - * @throws TagNotFoundException whenever a tag was not found |
|
| 253 | - */ |
|
| 254 | - protected function processFilterRules($filterRules) { |
|
| 255 | - $ns = '{' . $this::NS_OWNCLOUD . '}'; |
|
| 256 | - $resultFileIds = null; |
|
| 257 | - $systemTagIds = []; |
|
| 258 | - $favoriteFilter = null; |
|
| 259 | - foreach ($filterRules as $filterRule) { |
|
| 260 | - if ($filterRule['name'] === $ns . 'systemtag') { |
|
| 261 | - $systemTagIds[] = $filterRule['value']; |
|
| 262 | - } |
|
| 263 | - if ($filterRule['name'] === $ns . 'favorite') { |
|
| 264 | - $favoriteFilter = true; |
|
| 265 | - } |
|
| 266 | - } |
|
| 267 | - |
|
| 268 | - if ($favoriteFilter !== null) { |
|
| 269 | - $resultFileIds = $this->fileTagger->load('files')->getFavorites(); |
|
| 270 | - if (empty($resultFileIds)) { |
|
| 271 | - return []; |
|
| 272 | - } |
|
| 273 | - } |
|
| 274 | - |
|
| 275 | - if (!empty($systemTagIds)) { |
|
| 276 | - $fileIds = $this->getSystemTagFileIds($systemTagIds); |
|
| 277 | - if (empty($resultFileIds)) { |
|
| 278 | - $resultFileIds = $fileIds; |
|
| 279 | - } else { |
|
| 280 | - $resultFileIds = array_intersect($fileIds, $resultFileIds); |
|
| 281 | - } |
|
| 282 | - } |
|
| 283 | - |
|
| 284 | - return $resultFileIds; |
|
| 285 | - } |
|
| 286 | - |
|
| 287 | - private function getSystemTagFileIds($systemTagIds) { |
|
| 288 | - $resultFileIds = null; |
|
| 289 | - |
|
| 290 | - // check user permissions, if applicable |
|
| 291 | - if (!$this->isAdmin()) { |
|
| 292 | - // check visibility/permission |
|
| 293 | - $tags = $this->tagManager->getTagsByIds($systemTagIds); |
|
| 294 | - $unknownTagIds = []; |
|
| 295 | - foreach ($tags as $tag) { |
|
| 296 | - if (!$tag->isUserVisible()) { |
|
| 297 | - $unknownTagIds[] = $tag->getId(); |
|
| 298 | - } |
|
| 299 | - } |
|
| 300 | - |
|
| 301 | - if (!empty($unknownTagIds)) { |
|
| 302 | - throw new TagNotFoundException('Tag with ids ' . implode(', ', $unknownTagIds) . ' not found'); |
|
| 303 | - } |
|
| 304 | - } |
|
| 305 | - |
|
| 306 | - // fetch all file ids and intersect them |
|
| 307 | - foreach ($systemTagIds as $systemTagId) { |
|
| 308 | - $fileIds = $this->tagMapper->getObjectIdsForTags($systemTagId, 'files'); |
|
| 309 | - |
|
| 310 | - if (empty($fileIds)) { |
|
| 311 | - // This tag has no files, nothing can ever show up |
|
| 312 | - return []; |
|
| 313 | - } |
|
| 314 | - |
|
| 315 | - // first run ? |
|
| 316 | - if ($resultFileIds === null) { |
|
| 317 | - $resultFileIds = $fileIds; |
|
| 318 | - } else { |
|
| 319 | - $resultFileIds = array_intersect($resultFileIds, $fileIds); |
|
| 320 | - } |
|
| 321 | - |
|
| 322 | - if (empty($resultFileIds)) { |
|
| 323 | - // Empty intersection, nothing can show up anymore |
|
| 324 | - return []; |
|
| 325 | - } |
|
| 326 | - } |
|
| 327 | - return $resultFileIds; |
|
| 328 | - } |
|
| 329 | - |
|
| 330 | - /** |
|
| 331 | - * Prepare propfind response for the given nodes |
|
| 332 | - * |
|
| 333 | - * @param string $filesUri $filesUri URI leading to root of the files URI, |
|
| 334 | - * with a leading slash but no trailing slash |
|
| 335 | - * @param string[] $requestedProps requested properties |
|
| 336 | - * @param Node[] nodes nodes for which to fetch and prepare responses |
|
| 337 | - * @return Response[] |
|
| 338 | - */ |
|
| 339 | - public function prepareResponses($filesUri, $requestedProps, $nodes) { |
|
| 340 | - $responses = []; |
|
| 341 | - foreach ($nodes as $node) { |
|
| 342 | - $propFind = new PropFind($filesUri . $node->getPath(), $requestedProps); |
|
| 343 | - |
|
| 344 | - $this->server->getPropertiesByNode($propFind, $node); |
|
| 345 | - // copied from Sabre Server's getPropertiesForPath |
|
| 346 | - $result = $propFind->getResultForMultiStatus(); |
|
| 347 | - $result['href'] = $propFind->getPath(); |
|
| 348 | - |
|
| 349 | - $resourceType = $this->server->getResourceTypeForNode($node); |
|
| 350 | - if (in_array('{DAV:}collection', $resourceType) || in_array('{DAV:}principal', $resourceType)) { |
|
| 351 | - $result['href'] .= '/'; |
|
| 352 | - } |
|
| 353 | - |
|
| 354 | - $responses[] = new Response( |
|
| 355 | - rtrim($this->server->getBaseUri(), '/') . $filesUri . $node->getPath(), |
|
| 356 | - $result, |
|
| 357 | - 200 |
|
| 358 | - ); |
|
| 359 | - } |
|
| 360 | - return $responses; |
|
| 361 | - } |
|
| 362 | - |
|
| 363 | - /** |
|
| 364 | - * Find Sabre nodes by file ids |
|
| 365 | - * |
|
| 366 | - * @param Node $rootNode root node for search |
|
| 367 | - * @param array $fileIds file ids |
|
| 368 | - * @return Node[] array of Sabre nodes |
|
| 369 | - */ |
|
| 370 | - public function findNodesByFileIds($rootNode, $fileIds) { |
|
| 371 | - $folder = $this->userFolder; |
|
| 372 | - if (trim($rootNode->getPath(), '/') !== '') { |
|
| 373 | - $folder = $folder->get($rootNode->getPath()); |
|
| 374 | - } |
|
| 375 | - |
|
| 376 | - $results = []; |
|
| 377 | - foreach ($fileIds as $fileId) { |
|
| 378 | - $entry = $folder->getById($fileId); |
|
| 379 | - if ($entry) { |
|
| 380 | - $entry = current($entry); |
|
| 381 | - if ($entry instanceof \OCP\Files\File) { |
|
| 382 | - $results[] = new File($this->fileView, $entry); |
|
| 383 | - } else if ($entry instanceof \OCP\Files\Folder) { |
|
| 384 | - $results[] = new Directory($this->fileView, $entry); |
|
| 385 | - } |
|
| 386 | - } |
|
| 387 | - } |
|
| 388 | - |
|
| 389 | - return $results; |
|
| 390 | - } |
|
| 391 | - |
|
| 392 | - /** |
|
| 393 | - * Returns whether the currently logged in user is an administrator |
|
| 394 | - */ |
|
| 395 | - private function isAdmin() { |
|
| 396 | - $user = $this->userSession->getUser(); |
|
| 397 | - if ($user !== null) { |
|
| 398 | - return $this->groupManager->isAdmin($user->getUID()); |
|
| 399 | - } |
|
| 400 | - return false; |
|
| 401 | - } |
|
| 44 | + // namespace |
|
| 45 | + const NS_OWNCLOUD = 'http://owncloud.org/ns'; |
|
| 46 | + const REPORT_NAME = '{http://owncloud.org/ns}filter-files'; |
|
| 47 | + const SYSTEMTAG_PROPERTYNAME = '{http://owncloud.org/ns}systemtag'; |
|
| 48 | + |
|
| 49 | + /** |
|
| 50 | + * Reference to main server object |
|
| 51 | + * |
|
| 52 | + * @var \Sabre\DAV\Server |
|
| 53 | + */ |
|
| 54 | + private $server; |
|
| 55 | + |
|
| 56 | + /** |
|
| 57 | + * @var Tree |
|
| 58 | + */ |
|
| 59 | + private $tree; |
|
| 60 | + |
|
| 61 | + /** |
|
| 62 | + * @var View |
|
| 63 | + */ |
|
| 64 | + private $fileView; |
|
| 65 | + |
|
| 66 | + /** |
|
| 67 | + * @var ISystemTagManager |
|
| 68 | + */ |
|
| 69 | + private $tagManager; |
|
| 70 | + |
|
| 71 | + /** |
|
| 72 | + * @var ISystemTagObjectMapper |
|
| 73 | + */ |
|
| 74 | + private $tagMapper; |
|
| 75 | + |
|
| 76 | + /** |
|
| 77 | + * Manager for private tags |
|
| 78 | + * |
|
| 79 | + * @var ITagManager |
|
| 80 | + */ |
|
| 81 | + private $fileTagger; |
|
| 82 | + |
|
| 83 | + /** |
|
| 84 | + * @var IUserSession |
|
| 85 | + */ |
|
| 86 | + private $userSession; |
|
| 87 | + |
|
| 88 | + /** |
|
| 89 | + * @var IGroupManager |
|
| 90 | + */ |
|
| 91 | + private $groupManager; |
|
| 92 | + |
|
| 93 | + /** |
|
| 94 | + * @var Folder |
|
| 95 | + */ |
|
| 96 | + private $userFolder; |
|
| 97 | + |
|
| 98 | + /** |
|
| 99 | + * @param Tree $tree |
|
| 100 | + * @param View $view |
|
| 101 | + * @param ISystemTagManager $tagManager |
|
| 102 | + * @param ISystemTagObjectMapper $tagMapper |
|
| 103 | + * @param ITagManager $fileTagger manager for private tags |
|
| 104 | + * @param IUserSession $userSession |
|
| 105 | + * @param IGroupManager $groupManager |
|
| 106 | + * @param Folder $userFolder |
|
| 107 | + */ |
|
| 108 | + public function __construct(Tree $tree, |
|
| 109 | + View $view, |
|
| 110 | + ISystemTagManager $tagManager, |
|
| 111 | + ISystemTagObjectMapper $tagMapper, |
|
| 112 | + ITagManager $fileTagger, |
|
| 113 | + IUserSession $userSession, |
|
| 114 | + IGroupManager $groupManager, |
|
| 115 | + Folder $userFolder |
|
| 116 | + ) { |
|
| 117 | + $this->tree = $tree; |
|
| 118 | + $this->fileView = $view; |
|
| 119 | + $this->tagManager = $tagManager; |
|
| 120 | + $this->tagMapper = $tagMapper; |
|
| 121 | + $this->fileTagger = $fileTagger; |
|
| 122 | + $this->userSession = $userSession; |
|
| 123 | + $this->groupManager = $groupManager; |
|
| 124 | + $this->userFolder = $userFolder; |
|
| 125 | + } |
|
| 126 | + |
|
| 127 | + /** |
|
| 128 | + * This initializes the plugin. |
|
| 129 | + * |
|
| 130 | + * This function is called by \Sabre\DAV\Server, after |
|
| 131 | + * addPlugin is called. |
|
| 132 | + * |
|
| 133 | + * This method should set up the required event subscriptions. |
|
| 134 | + * |
|
| 135 | + * @param \Sabre\DAV\Server $server |
|
| 136 | + * @return void |
|
| 137 | + */ |
|
| 138 | + public function initialize(\Sabre\DAV\Server $server) { |
|
| 139 | + |
|
| 140 | + $server->xml->namespaceMap[self::NS_OWNCLOUD] = 'oc'; |
|
| 141 | + |
|
| 142 | + $this->server = $server; |
|
| 143 | + $this->server->on('report', array($this, 'onReport')); |
|
| 144 | + } |
|
| 145 | + |
|
| 146 | + /** |
|
| 147 | + * Returns a list of reports this plugin supports. |
|
| 148 | + * |
|
| 149 | + * This will be used in the {DAV:}supported-report-set property. |
|
| 150 | + * |
|
| 151 | + * @param string $uri |
|
| 152 | + * @return array |
|
| 153 | + */ |
|
| 154 | + public function getSupportedReportSet($uri) { |
|
| 155 | + return [self::REPORT_NAME]; |
|
| 156 | + } |
|
| 157 | + |
|
| 158 | + /** |
|
| 159 | + * REPORT operations to look for files |
|
| 160 | + * |
|
| 161 | + * @param string $reportName |
|
| 162 | + * @param $report |
|
| 163 | + * @param string $uri |
|
| 164 | + * @return bool |
|
| 165 | + * @throws BadRequest |
|
| 166 | + * @throws PreconditionFailed |
|
| 167 | + * @internal param $ [] $report |
|
| 168 | + */ |
|
| 169 | + public function onReport($reportName, $report, $uri) { |
|
| 170 | + $reportTargetNode = $this->server->tree->getNodeForPath($uri); |
|
| 171 | + if (!$reportTargetNode instanceof Directory || $reportName !== self::REPORT_NAME) { |
|
| 172 | + return; |
|
| 173 | + } |
|
| 174 | + |
|
| 175 | + $ns = '{' . $this::NS_OWNCLOUD . '}'; |
|
| 176 | + $requestedProps = []; |
|
| 177 | + $filterRules = []; |
|
| 178 | + |
|
| 179 | + // parse report properties and gather filter info |
|
| 180 | + foreach ($report as $reportProps) { |
|
| 181 | + $name = $reportProps['name']; |
|
| 182 | + if ($name === $ns . 'filter-rules') { |
|
| 183 | + $filterRules = $reportProps['value']; |
|
| 184 | + } else if ($name === '{DAV:}prop') { |
|
| 185 | + // propfind properties |
|
| 186 | + foreach ($reportProps['value'] as $propVal) { |
|
| 187 | + $requestedProps[] = $propVal['name']; |
|
| 188 | + } |
|
| 189 | + } |
|
| 190 | + } |
|
| 191 | + |
|
| 192 | + if (empty($filterRules)) { |
|
| 193 | + // an empty filter would return all existing files which would be slow |
|
| 194 | + throw new BadRequest('Missing filter-rule block in request'); |
|
| 195 | + } |
|
| 196 | + |
|
| 197 | + // gather all file ids matching filter |
|
| 198 | + try { |
|
| 199 | + $resultFileIds = $this->processFilterRules($filterRules); |
|
| 200 | + } catch (TagNotFoundException $e) { |
|
| 201 | + throw new PreconditionFailed('Cannot filter by non-existing tag', 0, $e); |
|
| 202 | + } |
|
| 203 | + |
|
| 204 | + // find sabre nodes by file id, restricted to the root node path |
|
| 205 | + $results = $this->findNodesByFileIds($reportTargetNode, $resultFileIds); |
|
| 206 | + |
|
| 207 | + $filesUri = $this->getFilesBaseUri($uri, $reportTargetNode->getPath()); |
|
| 208 | + $responses = $this->prepareResponses($filesUri, $requestedProps, $results); |
|
| 209 | + |
|
| 210 | + $xml = $this->server->xml->write( |
|
| 211 | + '{DAV:}multistatus', |
|
| 212 | + new MultiStatus($responses) |
|
| 213 | + ); |
|
| 214 | + |
|
| 215 | + $this->server->httpResponse->setStatus(207); |
|
| 216 | + $this->server->httpResponse->setHeader('Content-Type', 'application/xml; charset=utf-8'); |
|
| 217 | + $this->server->httpResponse->setBody($xml); |
|
| 218 | + |
|
| 219 | + return false; |
|
| 220 | + } |
|
| 221 | + |
|
| 222 | + /** |
|
| 223 | + * Returns the base uri of the files root by removing |
|
| 224 | + * the subpath from the URI |
|
| 225 | + * |
|
| 226 | + * @param string $uri URI from this request |
|
| 227 | + * @param string $subPath subpath to remove from the URI |
|
| 228 | + * |
|
| 229 | + * @return string files base uri |
|
| 230 | + */ |
|
| 231 | + private function getFilesBaseUri($uri, $subPath) { |
|
| 232 | + $uri = trim($uri, '/'); |
|
| 233 | + $subPath = trim($subPath, '/'); |
|
| 234 | + if (empty($subPath)) { |
|
| 235 | + $filesUri = $uri; |
|
| 236 | + } else { |
|
| 237 | + $filesUri = substr($uri, 0, strlen($uri) - strlen($subPath)); |
|
| 238 | + } |
|
| 239 | + $filesUri = trim($filesUri, '/'); |
|
| 240 | + if (empty($filesUri)) { |
|
| 241 | + return ''; |
|
| 242 | + } |
|
| 243 | + return '/' . $filesUri; |
|
| 244 | + } |
|
| 245 | + |
|
| 246 | + /** |
|
| 247 | + * Find file ids matching the given filter rules |
|
| 248 | + * |
|
| 249 | + * @param array $filterRules |
|
| 250 | + * @return array array of unique file id results |
|
| 251 | + * |
|
| 252 | + * @throws TagNotFoundException whenever a tag was not found |
|
| 253 | + */ |
|
| 254 | + protected function processFilterRules($filterRules) { |
|
| 255 | + $ns = '{' . $this::NS_OWNCLOUD . '}'; |
|
| 256 | + $resultFileIds = null; |
|
| 257 | + $systemTagIds = []; |
|
| 258 | + $favoriteFilter = null; |
|
| 259 | + foreach ($filterRules as $filterRule) { |
|
| 260 | + if ($filterRule['name'] === $ns . 'systemtag') { |
|
| 261 | + $systemTagIds[] = $filterRule['value']; |
|
| 262 | + } |
|
| 263 | + if ($filterRule['name'] === $ns . 'favorite') { |
|
| 264 | + $favoriteFilter = true; |
|
| 265 | + } |
|
| 266 | + } |
|
| 267 | + |
|
| 268 | + if ($favoriteFilter !== null) { |
|
| 269 | + $resultFileIds = $this->fileTagger->load('files')->getFavorites(); |
|
| 270 | + if (empty($resultFileIds)) { |
|
| 271 | + return []; |
|
| 272 | + } |
|
| 273 | + } |
|
| 274 | + |
|
| 275 | + if (!empty($systemTagIds)) { |
|
| 276 | + $fileIds = $this->getSystemTagFileIds($systemTagIds); |
|
| 277 | + if (empty($resultFileIds)) { |
|
| 278 | + $resultFileIds = $fileIds; |
|
| 279 | + } else { |
|
| 280 | + $resultFileIds = array_intersect($fileIds, $resultFileIds); |
|
| 281 | + } |
|
| 282 | + } |
|
| 283 | + |
|
| 284 | + return $resultFileIds; |
|
| 285 | + } |
|
| 286 | + |
|
| 287 | + private function getSystemTagFileIds($systemTagIds) { |
|
| 288 | + $resultFileIds = null; |
|
| 289 | + |
|
| 290 | + // check user permissions, if applicable |
|
| 291 | + if (!$this->isAdmin()) { |
|
| 292 | + // check visibility/permission |
|
| 293 | + $tags = $this->tagManager->getTagsByIds($systemTagIds); |
|
| 294 | + $unknownTagIds = []; |
|
| 295 | + foreach ($tags as $tag) { |
|
| 296 | + if (!$tag->isUserVisible()) { |
|
| 297 | + $unknownTagIds[] = $tag->getId(); |
|
| 298 | + } |
|
| 299 | + } |
|
| 300 | + |
|
| 301 | + if (!empty($unknownTagIds)) { |
|
| 302 | + throw new TagNotFoundException('Tag with ids ' . implode(', ', $unknownTagIds) . ' not found'); |
|
| 303 | + } |
|
| 304 | + } |
|
| 305 | + |
|
| 306 | + // fetch all file ids and intersect them |
|
| 307 | + foreach ($systemTagIds as $systemTagId) { |
|
| 308 | + $fileIds = $this->tagMapper->getObjectIdsForTags($systemTagId, 'files'); |
|
| 309 | + |
|
| 310 | + if (empty($fileIds)) { |
|
| 311 | + // This tag has no files, nothing can ever show up |
|
| 312 | + return []; |
|
| 313 | + } |
|
| 314 | + |
|
| 315 | + // first run ? |
|
| 316 | + if ($resultFileIds === null) { |
|
| 317 | + $resultFileIds = $fileIds; |
|
| 318 | + } else { |
|
| 319 | + $resultFileIds = array_intersect($resultFileIds, $fileIds); |
|
| 320 | + } |
|
| 321 | + |
|
| 322 | + if (empty($resultFileIds)) { |
|
| 323 | + // Empty intersection, nothing can show up anymore |
|
| 324 | + return []; |
|
| 325 | + } |
|
| 326 | + } |
|
| 327 | + return $resultFileIds; |
|
| 328 | + } |
|
| 329 | + |
|
| 330 | + /** |
|
| 331 | + * Prepare propfind response for the given nodes |
|
| 332 | + * |
|
| 333 | + * @param string $filesUri $filesUri URI leading to root of the files URI, |
|
| 334 | + * with a leading slash but no trailing slash |
|
| 335 | + * @param string[] $requestedProps requested properties |
|
| 336 | + * @param Node[] nodes nodes for which to fetch and prepare responses |
|
| 337 | + * @return Response[] |
|
| 338 | + */ |
|
| 339 | + public function prepareResponses($filesUri, $requestedProps, $nodes) { |
|
| 340 | + $responses = []; |
|
| 341 | + foreach ($nodes as $node) { |
|
| 342 | + $propFind = new PropFind($filesUri . $node->getPath(), $requestedProps); |
|
| 343 | + |
|
| 344 | + $this->server->getPropertiesByNode($propFind, $node); |
|
| 345 | + // copied from Sabre Server's getPropertiesForPath |
|
| 346 | + $result = $propFind->getResultForMultiStatus(); |
|
| 347 | + $result['href'] = $propFind->getPath(); |
|
| 348 | + |
|
| 349 | + $resourceType = $this->server->getResourceTypeForNode($node); |
|
| 350 | + if (in_array('{DAV:}collection', $resourceType) || in_array('{DAV:}principal', $resourceType)) { |
|
| 351 | + $result['href'] .= '/'; |
|
| 352 | + } |
|
| 353 | + |
|
| 354 | + $responses[] = new Response( |
|
| 355 | + rtrim($this->server->getBaseUri(), '/') . $filesUri . $node->getPath(), |
|
| 356 | + $result, |
|
| 357 | + 200 |
|
| 358 | + ); |
|
| 359 | + } |
|
| 360 | + return $responses; |
|
| 361 | + } |
|
| 362 | + |
|
| 363 | + /** |
|
| 364 | + * Find Sabre nodes by file ids |
|
| 365 | + * |
|
| 366 | + * @param Node $rootNode root node for search |
|
| 367 | + * @param array $fileIds file ids |
|
| 368 | + * @return Node[] array of Sabre nodes |
|
| 369 | + */ |
|
| 370 | + public function findNodesByFileIds($rootNode, $fileIds) { |
|
| 371 | + $folder = $this->userFolder; |
|
| 372 | + if (trim($rootNode->getPath(), '/') !== '') { |
|
| 373 | + $folder = $folder->get($rootNode->getPath()); |
|
| 374 | + } |
|
| 375 | + |
|
| 376 | + $results = []; |
|
| 377 | + foreach ($fileIds as $fileId) { |
|
| 378 | + $entry = $folder->getById($fileId); |
|
| 379 | + if ($entry) { |
|
| 380 | + $entry = current($entry); |
|
| 381 | + if ($entry instanceof \OCP\Files\File) { |
|
| 382 | + $results[] = new File($this->fileView, $entry); |
|
| 383 | + } else if ($entry instanceof \OCP\Files\Folder) { |
|
| 384 | + $results[] = new Directory($this->fileView, $entry); |
|
| 385 | + } |
|
| 386 | + } |
|
| 387 | + } |
|
| 388 | + |
|
| 389 | + return $results; |
|
| 390 | + } |
|
| 391 | + |
|
| 392 | + /** |
|
| 393 | + * Returns whether the currently logged in user is an administrator |
|
| 394 | + */ |
|
| 395 | + private function isAdmin() { |
|
| 396 | + $user = $this->userSession->getUser(); |
|
| 397 | + if ($user !== null) { |
|
| 398 | + return $this->groupManager->isAdmin($user->getUID()); |
|
| 399 | + } |
|
| 400 | + return false; |
|
| 401 | + } |
|
| 402 | 402 | } |
@@ -172,14 +172,14 @@ discard block |
||
| 172 | 172 | return; |
| 173 | 173 | } |
| 174 | 174 | |
| 175 | - $ns = '{' . $this::NS_OWNCLOUD . '}'; |
|
| 175 | + $ns = '{'.$this::NS_OWNCLOUD.'}'; |
|
| 176 | 176 | $requestedProps = []; |
| 177 | 177 | $filterRules = []; |
| 178 | 178 | |
| 179 | 179 | // parse report properties and gather filter info |
| 180 | 180 | foreach ($report as $reportProps) { |
| 181 | 181 | $name = $reportProps['name']; |
| 182 | - if ($name === $ns . 'filter-rules') { |
|
| 182 | + if ($name === $ns.'filter-rules') { |
|
| 183 | 183 | $filterRules = $reportProps['value']; |
| 184 | 184 | } else if ($name === '{DAV:}prop') { |
| 185 | 185 | // propfind properties |
@@ -240,7 +240,7 @@ discard block |
||
| 240 | 240 | if (empty($filesUri)) { |
| 241 | 241 | return ''; |
| 242 | 242 | } |
| 243 | - return '/' . $filesUri; |
|
| 243 | + return '/'.$filesUri; |
|
| 244 | 244 | } |
| 245 | 245 | |
| 246 | 246 | /** |
@@ -252,15 +252,15 @@ discard block |
||
| 252 | 252 | * @throws TagNotFoundException whenever a tag was not found |
| 253 | 253 | */ |
| 254 | 254 | protected function processFilterRules($filterRules) { |
| 255 | - $ns = '{' . $this::NS_OWNCLOUD . '}'; |
|
| 255 | + $ns = '{'.$this::NS_OWNCLOUD.'}'; |
|
| 256 | 256 | $resultFileIds = null; |
| 257 | 257 | $systemTagIds = []; |
| 258 | 258 | $favoriteFilter = null; |
| 259 | 259 | foreach ($filterRules as $filterRule) { |
| 260 | - if ($filterRule['name'] === $ns . 'systemtag') { |
|
| 260 | + if ($filterRule['name'] === $ns.'systemtag') { |
|
| 261 | 261 | $systemTagIds[] = $filterRule['value']; |
| 262 | 262 | } |
| 263 | - if ($filterRule['name'] === $ns . 'favorite') { |
|
| 263 | + if ($filterRule['name'] === $ns.'favorite') { |
|
| 264 | 264 | $favoriteFilter = true; |
| 265 | 265 | } |
| 266 | 266 | } |
@@ -299,7 +299,7 @@ discard block |
||
| 299 | 299 | } |
| 300 | 300 | |
| 301 | 301 | if (!empty($unknownTagIds)) { |
| 302 | - throw new TagNotFoundException('Tag with ids ' . implode(', ', $unknownTagIds) . ' not found'); |
|
| 302 | + throw new TagNotFoundException('Tag with ids '.implode(', ', $unknownTagIds).' not found'); |
|
| 303 | 303 | } |
| 304 | 304 | } |
| 305 | 305 | |
@@ -339,7 +339,7 @@ discard block |
||
| 339 | 339 | public function prepareResponses($filesUri, $requestedProps, $nodes) { |
| 340 | 340 | $responses = []; |
| 341 | 341 | foreach ($nodes as $node) { |
| 342 | - $propFind = new PropFind($filesUri . $node->getPath(), $requestedProps); |
|
| 342 | + $propFind = new PropFind($filesUri.$node->getPath(), $requestedProps); |
|
| 343 | 343 | |
| 344 | 344 | $this->server->getPropertiesByNode($propFind, $node); |
| 345 | 345 | // copied from Sabre Server's getPropertiesForPath |
@@ -352,7 +352,7 @@ discard block |
||
| 352 | 352 | } |
| 353 | 353 | |
| 354 | 354 | $responses[] = new Response( |
| 355 | - rtrim($this->server->getBaseUri(), '/') . $filesUri . $node->getPath(), |
|
| 355 | + rtrim($this->server->getBaseUri(), '/').$filesUri.$node->getPath(), |
|
| 356 | 356 | $result, |
| 357 | 357 | 200 |
| 358 | 358 | ); |