@@ -36,177 +36,177 @@ |
||
36 | 36 | |
37 | 37 | class RootCollection implements ICollection { |
38 | 38 | |
39 | - /** @var EntityTypeCollection[]|null */ |
|
40 | - private $entityTypeCollections; |
|
41 | - |
|
42 | - /** @var ICommentsManager */ |
|
43 | - protected $commentsManager; |
|
44 | - |
|
45 | - /** @var string */ |
|
46 | - protected $name = 'comments'; |
|
47 | - |
|
48 | - /** @var ILogger */ |
|
49 | - protected $logger; |
|
50 | - |
|
51 | - /** @var IUserManager */ |
|
52 | - protected $userManager; |
|
53 | - |
|
54 | - /** @var IUserSession */ |
|
55 | - protected $userSession; |
|
56 | - |
|
57 | - /** @var EventDispatcherInterface */ |
|
58 | - protected $dispatcher; |
|
59 | - |
|
60 | - /** |
|
61 | - * @param ICommentsManager $commentsManager |
|
62 | - * @param IUserManager $userManager |
|
63 | - * @param IUserSession $userSession |
|
64 | - * @param EventDispatcherInterface $dispatcher |
|
65 | - * @param ILogger $logger |
|
66 | - */ |
|
67 | - public function __construct( |
|
68 | - ICommentsManager $commentsManager, |
|
69 | - IUserManager $userManager, |
|
70 | - IUserSession $userSession, |
|
71 | - EventDispatcherInterface $dispatcher, |
|
72 | - ILogger $logger) |
|
73 | - { |
|
74 | - $this->commentsManager = $commentsManager; |
|
75 | - $this->logger = $logger; |
|
76 | - $this->userManager = $userManager; |
|
77 | - $this->userSession = $userSession; |
|
78 | - $this->dispatcher = $dispatcher; |
|
79 | - } |
|
80 | - |
|
81 | - /** |
|
82 | - * initializes the collection. At this point of time, we need the logged in |
|
83 | - * user. Since it is not the case when the instance is created, we cannot |
|
84 | - * have this in the constructor. |
|
85 | - * |
|
86 | - * @throws NotAuthenticated |
|
87 | - */ |
|
88 | - protected function initCollections() { |
|
89 | - if($this->entityTypeCollections !== null) { |
|
90 | - return; |
|
91 | - } |
|
92 | - $user = $this->userSession->getUser(); |
|
93 | - if(is_null($user)) { |
|
94 | - throw new NotAuthenticated(); |
|
95 | - } |
|
96 | - |
|
97 | - $event = new CommentsEntityEvent(CommentsEntityEvent::EVENT_ENTITY); |
|
98 | - $this->dispatcher->dispatch(CommentsEntityEvent::EVENT_ENTITY, $event); |
|
99 | - |
|
100 | - $this->entityTypeCollections = []; |
|
101 | - foreach ($event->getEntityCollections() as $entity => $entityExistsFunction) { |
|
102 | - $this->entityTypeCollections[$entity] = new EntityTypeCollection( |
|
103 | - $entity, |
|
104 | - $this->commentsManager, |
|
105 | - $this->userManager, |
|
106 | - $this->userSession, |
|
107 | - $this->logger, |
|
108 | - $entityExistsFunction |
|
109 | - ); |
|
110 | - } |
|
111 | - } |
|
112 | - |
|
113 | - /** |
|
114 | - * Creates a new file in the directory |
|
115 | - * |
|
116 | - * @param string $name Name of the file |
|
117 | - * @param resource|string $data Initial payload |
|
118 | - * @return null|string |
|
119 | - * @throws Forbidden |
|
120 | - */ |
|
121 | - function createFile($name, $data = null) { |
|
122 | - throw new Forbidden('Cannot create comments by id'); |
|
123 | - } |
|
124 | - |
|
125 | - /** |
|
126 | - * Creates a new subdirectory |
|
127 | - * |
|
128 | - * @param string $name |
|
129 | - * @throws Forbidden |
|
130 | - */ |
|
131 | - function createDirectory($name) { |
|
132 | - throw new Forbidden('Permission denied to create collections'); |
|
133 | - } |
|
134 | - |
|
135 | - /** |
|
136 | - * Returns a specific child node, referenced by its name |
|
137 | - * |
|
138 | - * This method must throw Sabre\DAV\Exception\NotFound if the node does not |
|
139 | - * exist. |
|
140 | - * |
|
141 | - * @param string $name |
|
142 | - * @return \Sabre\DAV\INode |
|
143 | - * @throws NotFound |
|
144 | - */ |
|
145 | - function getChild($name) { |
|
146 | - $this->initCollections(); |
|
147 | - if(isset($this->entityTypeCollections[$name])) { |
|
148 | - return $this->entityTypeCollections[$name]; |
|
149 | - } |
|
150 | - throw new NotFound('Entity type "' . $name . '" not found."'); |
|
151 | - } |
|
152 | - |
|
153 | - /** |
|
154 | - * Returns an array with all the child nodes |
|
155 | - * |
|
156 | - * @return \Sabre\DAV\INode[] |
|
157 | - */ |
|
158 | - function getChildren() { |
|
159 | - $this->initCollections(); |
|
160 | - return $this->entityTypeCollections; |
|
161 | - } |
|
162 | - |
|
163 | - /** |
|
164 | - * Checks if a child-node with the specified name exists |
|
165 | - * |
|
166 | - * @param string $name |
|
167 | - * @return bool |
|
168 | - */ |
|
169 | - function childExists($name) { |
|
170 | - $this->initCollections(); |
|
171 | - return isset($this->entityTypeCollections[$name]); |
|
172 | - } |
|
173 | - |
|
174 | - /** |
|
175 | - * Deleted the current node |
|
176 | - * |
|
177 | - * @throws Forbidden |
|
178 | - */ |
|
179 | - function delete() { |
|
180 | - throw new Forbidden('Permission denied to delete this collection'); |
|
181 | - } |
|
182 | - |
|
183 | - /** |
|
184 | - * Returns the name of the node. |
|
185 | - * |
|
186 | - * This is used to generate the url. |
|
187 | - * |
|
188 | - * @return string |
|
189 | - */ |
|
190 | - function getName() { |
|
191 | - return $this->name; |
|
192 | - } |
|
193 | - |
|
194 | - /** |
|
195 | - * Renames the node |
|
196 | - * |
|
197 | - * @param string $name The new name |
|
198 | - * @throws Forbidden |
|
199 | - */ |
|
200 | - function setName($name) { |
|
201 | - throw new Forbidden('Permission denied to rename this collection'); |
|
202 | - } |
|
203 | - |
|
204 | - /** |
|
205 | - * Returns the last modification time, as a unix timestamp |
|
206 | - * |
|
207 | - * @return int |
|
208 | - */ |
|
209 | - function getLastModified() { |
|
210 | - return null; |
|
211 | - } |
|
39 | + /** @var EntityTypeCollection[]|null */ |
|
40 | + private $entityTypeCollections; |
|
41 | + |
|
42 | + /** @var ICommentsManager */ |
|
43 | + protected $commentsManager; |
|
44 | + |
|
45 | + /** @var string */ |
|
46 | + protected $name = 'comments'; |
|
47 | + |
|
48 | + /** @var ILogger */ |
|
49 | + protected $logger; |
|
50 | + |
|
51 | + /** @var IUserManager */ |
|
52 | + protected $userManager; |
|
53 | + |
|
54 | + /** @var IUserSession */ |
|
55 | + protected $userSession; |
|
56 | + |
|
57 | + /** @var EventDispatcherInterface */ |
|
58 | + protected $dispatcher; |
|
59 | + |
|
60 | + /** |
|
61 | + * @param ICommentsManager $commentsManager |
|
62 | + * @param IUserManager $userManager |
|
63 | + * @param IUserSession $userSession |
|
64 | + * @param EventDispatcherInterface $dispatcher |
|
65 | + * @param ILogger $logger |
|
66 | + */ |
|
67 | + public function __construct( |
|
68 | + ICommentsManager $commentsManager, |
|
69 | + IUserManager $userManager, |
|
70 | + IUserSession $userSession, |
|
71 | + EventDispatcherInterface $dispatcher, |
|
72 | + ILogger $logger) |
|
73 | + { |
|
74 | + $this->commentsManager = $commentsManager; |
|
75 | + $this->logger = $logger; |
|
76 | + $this->userManager = $userManager; |
|
77 | + $this->userSession = $userSession; |
|
78 | + $this->dispatcher = $dispatcher; |
|
79 | + } |
|
80 | + |
|
81 | + /** |
|
82 | + * initializes the collection. At this point of time, we need the logged in |
|
83 | + * user. Since it is not the case when the instance is created, we cannot |
|
84 | + * have this in the constructor. |
|
85 | + * |
|
86 | + * @throws NotAuthenticated |
|
87 | + */ |
|
88 | + protected function initCollections() { |
|
89 | + if($this->entityTypeCollections !== null) { |
|
90 | + return; |
|
91 | + } |
|
92 | + $user = $this->userSession->getUser(); |
|
93 | + if(is_null($user)) { |
|
94 | + throw new NotAuthenticated(); |
|
95 | + } |
|
96 | + |
|
97 | + $event = new CommentsEntityEvent(CommentsEntityEvent::EVENT_ENTITY); |
|
98 | + $this->dispatcher->dispatch(CommentsEntityEvent::EVENT_ENTITY, $event); |
|
99 | + |
|
100 | + $this->entityTypeCollections = []; |
|
101 | + foreach ($event->getEntityCollections() as $entity => $entityExistsFunction) { |
|
102 | + $this->entityTypeCollections[$entity] = new EntityTypeCollection( |
|
103 | + $entity, |
|
104 | + $this->commentsManager, |
|
105 | + $this->userManager, |
|
106 | + $this->userSession, |
|
107 | + $this->logger, |
|
108 | + $entityExistsFunction |
|
109 | + ); |
|
110 | + } |
|
111 | + } |
|
112 | + |
|
113 | + /** |
|
114 | + * Creates a new file in the directory |
|
115 | + * |
|
116 | + * @param string $name Name of the file |
|
117 | + * @param resource|string $data Initial payload |
|
118 | + * @return null|string |
|
119 | + * @throws Forbidden |
|
120 | + */ |
|
121 | + function createFile($name, $data = null) { |
|
122 | + throw new Forbidden('Cannot create comments by id'); |
|
123 | + } |
|
124 | + |
|
125 | + /** |
|
126 | + * Creates a new subdirectory |
|
127 | + * |
|
128 | + * @param string $name |
|
129 | + * @throws Forbidden |
|
130 | + */ |
|
131 | + function createDirectory($name) { |
|
132 | + throw new Forbidden('Permission denied to create collections'); |
|
133 | + } |
|
134 | + |
|
135 | + /** |
|
136 | + * Returns a specific child node, referenced by its name |
|
137 | + * |
|
138 | + * This method must throw Sabre\DAV\Exception\NotFound if the node does not |
|
139 | + * exist. |
|
140 | + * |
|
141 | + * @param string $name |
|
142 | + * @return \Sabre\DAV\INode |
|
143 | + * @throws NotFound |
|
144 | + */ |
|
145 | + function getChild($name) { |
|
146 | + $this->initCollections(); |
|
147 | + if(isset($this->entityTypeCollections[$name])) { |
|
148 | + return $this->entityTypeCollections[$name]; |
|
149 | + } |
|
150 | + throw new NotFound('Entity type "' . $name . '" not found."'); |
|
151 | + } |
|
152 | + |
|
153 | + /** |
|
154 | + * Returns an array with all the child nodes |
|
155 | + * |
|
156 | + * @return \Sabre\DAV\INode[] |
|
157 | + */ |
|
158 | + function getChildren() { |
|
159 | + $this->initCollections(); |
|
160 | + return $this->entityTypeCollections; |
|
161 | + } |
|
162 | + |
|
163 | + /** |
|
164 | + * Checks if a child-node with the specified name exists |
|
165 | + * |
|
166 | + * @param string $name |
|
167 | + * @return bool |
|
168 | + */ |
|
169 | + function childExists($name) { |
|
170 | + $this->initCollections(); |
|
171 | + return isset($this->entityTypeCollections[$name]); |
|
172 | + } |
|
173 | + |
|
174 | + /** |
|
175 | + * Deleted the current node |
|
176 | + * |
|
177 | + * @throws Forbidden |
|
178 | + */ |
|
179 | + function delete() { |
|
180 | + throw new Forbidden('Permission denied to delete this collection'); |
|
181 | + } |
|
182 | + |
|
183 | + /** |
|
184 | + * Returns the name of the node. |
|
185 | + * |
|
186 | + * This is used to generate the url. |
|
187 | + * |
|
188 | + * @return string |
|
189 | + */ |
|
190 | + function getName() { |
|
191 | + return $this->name; |
|
192 | + } |
|
193 | + |
|
194 | + /** |
|
195 | + * Renames the node |
|
196 | + * |
|
197 | + * @param string $name The new name |
|
198 | + * @throws Forbidden |
|
199 | + */ |
|
200 | + function setName($name) { |
|
201 | + throw new Forbidden('Permission denied to rename this collection'); |
|
202 | + } |
|
203 | + |
|
204 | + /** |
|
205 | + * Returns the last modification time, as a unix timestamp |
|
206 | + * |
|
207 | + * @return int |
|
208 | + */ |
|
209 | + function getLastModified() { |
|
210 | + return null; |
|
211 | + } |
|
212 | 212 | } |
@@ -43,213 +43,213 @@ |
||
43 | 43 | * Sabre plugin to handle comments: |
44 | 44 | */ |
45 | 45 | class CommentsPlugin extends ServerPlugin { |
46 | - // namespace |
|
47 | - const NS_OWNCLOUD = 'http://owncloud.org/ns'; |
|
48 | - |
|
49 | - const REPORT_NAME = '{http://owncloud.org/ns}filter-comments'; |
|
50 | - const REPORT_PARAM_LIMIT = '{http://owncloud.org/ns}limit'; |
|
51 | - const REPORT_PARAM_OFFSET = '{http://owncloud.org/ns}offset'; |
|
52 | - const REPORT_PARAM_TIMESTAMP = '{http://owncloud.org/ns}datetime'; |
|
53 | - |
|
54 | - /** @var ICommentsManager */ |
|
55 | - protected $commentsManager; |
|
56 | - |
|
57 | - /** @var \Sabre\DAV\Server $server */ |
|
58 | - private $server; |
|
59 | - |
|
60 | - /** @var \OCP\IUserSession */ |
|
61 | - protected $userSession; |
|
62 | - |
|
63 | - /** |
|
64 | - * Comments plugin |
|
65 | - * |
|
66 | - * @param ICommentsManager $commentsManager |
|
67 | - * @param IUserSession $userSession |
|
68 | - */ |
|
69 | - public function __construct(ICommentsManager $commentsManager, IUserSession $userSession) { |
|
70 | - $this->commentsManager = $commentsManager; |
|
71 | - $this->userSession = $userSession; |
|
72 | - } |
|
73 | - |
|
74 | - /** |
|
75 | - * This initializes the plugin. |
|
76 | - * |
|
77 | - * This function is called by Sabre\DAV\Server, after |
|
78 | - * addPlugin is called. |
|
79 | - * |
|
80 | - * This method should set up the required event subscriptions. |
|
81 | - * |
|
82 | - * @param Server $server |
|
83 | - * @return void |
|
84 | - */ |
|
85 | - function initialize(Server $server) { |
|
86 | - $this->server = $server; |
|
87 | - if(strpos($this->server->getRequestUri(), 'comments/') !== 0) { |
|
88 | - return; |
|
89 | - } |
|
90 | - |
|
91 | - $this->server->xml->namespaceMap[self::NS_OWNCLOUD] = 'oc'; |
|
92 | - |
|
93 | - $this->server->xml->classMap['DateTime'] = function(Writer $writer, \DateTime $value) { |
|
94 | - $writer->write(\Sabre\HTTP\toDate($value)); |
|
95 | - }; |
|
96 | - |
|
97 | - $this->server->on('report', [$this, 'onReport']); |
|
98 | - $this->server->on('method:POST', [$this, 'httpPost']); |
|
99 | - } |
|
100 | - |
|
101 | - /** |
|
102 | - * POST operation on Comments collections |
|
103 | - * |
|
104 | - * @param RequestInterface $request request object |
|
105 | - * @param ResponseInterface $response response object |
|
106 | - * @return null|false |
|
107 | - */ |
|
108 | - public function httpPost(RequestInterface $request, ResponseInterface $response) { |
|
109 | - $path = $request->getPath(); |
|
110 | - $node = $this->server->tree->getNodeForPath($path); |
|
111 | - if (!$node instanceof EntityCollection) { |
|
112 | - return null; |
|
113 | - } |
|
114 | - |
|
115 | - $data = $request->getBodyAsString(); |
|
116 | - $comment = $this->createComment( |
|
117 | - $node->getName(), |
|
118 | - $node->getId(), |
|
119 | - $data, |
|
120 | - $request->getHeader('Content-Type') |
|
121 | - ); |
|
122 | - |
|
123 | - // update read marker for the current user/poster to avoid |
|
124 | - // having their own comments marked as unread |
|
125 | - $node->setReadMarker(null); |
|
126 | - |
|
127 | - $url = rtrim($request->getUrl(), '/') . '/' . urlencode($comment->getId()); |
|
128 | - |
|
129 | - $response->setHeader('Content-Location', $url); |
|
130 | - |
|
131 | - // created |
|
132 | - $response->setStatus(201); |
|
133 | - return false; |
|
134 | - } |
|
135 | - |
|
136 | - /** |
|
137 | - * Returns a list of reports this plugin supports. |
|
138 | - * |
|
139 | - * This will be used in the {DAV:}supported-report-set property. |
|
140 | - * |
|
141 | - * @param string $uri |
|
142 | - * @return array |
|
143 | - */ |
|
144 | - public function getSupportedReportSet($uri) { |
|
145 | - return [self::REPORT_NAME]; |
|
146 | - } |
|
147 | - |
|
148 | - /** |
|
149 | - * REPORT operations to look for comments |
|
150 | - * |
|
151 | - * @param string $reportName |
|
152 | - * @param array $report |
|
153 | - * @param string $uri |
|
154 | - * @return bool |
|
155 | - * @throws NotFound |
|
156 | - * @throws ReportNotSupported |
|
157 | - */ |
|
158 | - public function onReport($reportName, $report, $uri) { |
|
159 | - $node = $this->server->tree->getNodeForPath($uri); |
|
160 | - if(!$node instanceof EntityCollection || $reportName !== self::REPORT_NAME) { |
|
161 | - throw new ReportNotSupported(); |
|
162 | - } |
|
163 | - $args = ['limit' => 0, 'offset' => 0, 'datetime' => null]; |
|
164 | - $acceptableParameters = [ |
|
165 | - $this::REPORT_PARAM_LIMIT, |
|
166 | - $this::REPORT_PARAM_OFFSET, |
|
167 | - $this::REPORT_PARAM_TIMESTAMP |
|
168 | - ]; |
|
169 | - $ns = '{' . $this::NS_OWNCLOUD . '}'; |
|
170 | - foreach($report as $parameter) { |
|
171 | - if(!in_array($parameter['name'], $acceptableParameters) || empty($parameter['value'])) { |
|
172 | - continue; |
|
173 | - } |
|
174 | - $args[str_replace($ns, '', $parameter['name'])] = $parameter['value']; |
|
175 | - } |
|
176 | - |
|
177 | - if(!is_null($args['datetime'])) { |
|
178 | - $args['datetime'] = new \DateTime($args['datetime']); |
|
179 | - } |
|
180 | - |
|
181 | - $results = $node->findChildren($args['limit'], $args['offset'], $args['datetime']); |
|
182 | - |
|
183 | - $responses = []; |
|
184 | - foreach($results as $node) { |
|
185 | - $nodePath = $this->server->getRequestUri() . '/' . $node->comment->getId(); |
|
186 | - $resultSet = $this->server->getPropertiesForPath($nodePath, CommentNode::getPropertyNames()); |
|
187 | - if(isset($resultSet[0]) && isset($resultSet[0][200])) { |
|
188 | - $responses[] = new Response( |
|
189 | - $this->server->getBaseUri() . $nodePath, |
|
190 | - [200 => $resultSet[0][200]], |
|
191 | - 200 |
|
192 | - ); |
|
193 | - } |
|
194 | - |
|
195 | - } |
|
196 | - |
|
197 | - $xml = $this->server->xml->write( |
|
198 | - '{DAV:}multistatus', |
|
199 | - new MultiStatus($responses) |
|
200 | - ); |
|
201 | - |
|
202 | - $this->server->httpResponse->setStatus(207); |
|
203 | - $this->server->httpResponse->setHeader('Content-Type', 'application/xml; charset=utf-8'); |
|
204 | - $this->server->httpResponse->setBody($xml); |
|
205 | - |
|
206 | - return false; |
|
207 | - } |
|
208 | - |
|
209 | - /** |
|
210 | - * Creates a new comment |
|
211 | - * |
|
212 | - * @param string $objectType e.g. "files" |
|
213 | - * @param string $objectId e.g. the file id |
|
214 | - * @param string $data JSON encoded string containing the properties of the tag to create |
|
215 | - * @param string $contentType content type of the data |
|
216 | - * @return IComment newly created comment |
|
217 | - * |
|
218 | - * @throws BadRequest if a field was missing |
|
219 | - * @throws UnsupportedMediaType if the content type is not supported |
|
220 | - */ |
|
221 | - private function createComment($objectType, $objectId, $data, $contentType = 'application/json') { |
|
222 | - if (explode(';', $contentType)[0] === 'application/json') { |
|
223 | - $data = json_decode($data, true); |
|
224 | - } else { |
|
225 | - throw new UnsupportedMediaType(); |
|
226 | - } |
|
227 | - |
|
228 | - $actorType = $data['actorType']; |
|
229 | - $actorId = null; |
|
230 | - if($actorType === 'users') { |
|
231 | - $user = $this->userSession->getUser(); |
|
232 | - if(!is_null($user)) { |
|
233 | - $actorId = $user->getUID(); |
|
234 | - } |
|
235 | - } |
|
236 | - if(is_null($actorId)) { |
|
237 | - throw new BadRequest('Invalid actor "' . $actorType .'"'); |
|
238 | - } |
|
239 | - |
|
240 | - try { |
|
241 | - $comment = $this->commentsManager->create($actorType, $actorId, $objectType, $objectId); |
|
242 | - $comment->setMessage($data['message']); |
|
243 | - $comment->setVerb($data['verb']); |
|
244 | - $this->commentsManager->save($comment); |
|
245 | - return $comment; |
|
246 | - } catch (\InvalidArgumentException $e) { |
|
247 | - throw new BadRequest('Invalid input values', 0, $e); |
|
248 | - } catch (\OCP\Comments\MessageTooLongException $e) { |
|
249 | - $msg = 'Message exceeds allowed character limit of '; |
|
250 | - throw new BadRequest($msg . \OCP\Comments\IComment::MAX_MESSAGE_LENGTH, 0, $e); |
|
251 | - } |
|
252 | - } |
|
46 | + // namespace |
|
47 | + const NS_OWNCLOUD = 'http://owncloud.org/ns'; |
|
48 | + |
|
49 | + const REPORT_NAME = '{http://owncloud.org/ns}filter-comments'; |
|
50 | + const REPORT_PARAM_LIMIT = '{http://owncloud.org/ns}limit'; |
|
51 | + const REPORT_PARAM_OFFSET = '{http://owncloud.org/ns}offset'; |
|
52 | + const REPORT_PARAM_TIMESTAMP = '{http://owncloud.org/ns}datetime'; |
|
53 | + |
|
54 | + /** @var ICommentsManager */ |
|
55 | + protected $commentsManager; |
|
56 | + |
|
57 | + /** @var \Sabre\DAV\Server $server */ |
|
58 | + private $server; |
|
59 | + |
|
60 | + /** @var \OCP\IUserSession */ |
|
61 | + protected $userSession; |
|
62 | + |
|
63 | + /** |
|
64 | + * Comments plugin |
|
65 | + * |
|
66 | + * @param ICommentsManager $commentsManager |
|
67 | + * @param IUserSession $userSession |
|
68 | + */ |
|
69 | + public function __construct(ICommentsManager $commentsManager, IUserSession $userSession) { |
|
70 | + $this->commentsManager = $commentsManager; |
|
71 | + $this->userSession = $userSession; |
|
72 | + } |
|
73 | + |
|
74 | + /** |
|
75 | + * This initializes the plugin. |
|
76 | + * |
|
77 | + * This function is called by Sabre\DAV\Server, after |
|
78 | + * addPlugin is called. |
|
79 | + * |
|
80 | + * This method should set up the required event subscriptions. |
|
81 | + * |
|
82 | + * @param Server $server |
|
83 | + * @return void |
|
84 | + */ |
|
85 | + function initialize(Server $server) { |
|
86 | + $this->server = $server; |
|
87 | + if(strpos($this->server->getRequestUri(), 'comments/') !== 0) { |
|
88 | + return; |
|
89 | + } |
|
90 | + |
|
91 | + $this->server->xml->namespaceMap[self::NS_OWNCLOUD] = 'oc'; |
|
92 | + |
|
93 | + $this->server->xml->classMap['DateTime'] = function(Writer $writer, \DateTime $value) { |
|
94 | + $writer->write(\Sabre\HTTP\toDate($value)); |
|
95 | + }; |
|
96 | + |
|
97 | + $this->server->on('report', [$this, 'onReport']); |
|
98 | + $this->server->on('method:POST', [$this, 'httpPost']); |
|
99 | + } |
|
100 | + |
|
101 | + /** |
|
102 | + * POST operation on Comments collections |
|
103 | + * |
|
104 | + * @param RequestInterface $request request object |
|
105 | + * @param ResponseInterface $response response object |
|
106 | + * @return null|false |
|
107 | + */ |
|
108 | + public function httpPost(RequestInterface $request, ResponseInterface $response) { |
|
109 | + $path = $request->getPath(); |
|
110 | + $node = $this->server->tree->getNodeForPath($path); |
|
111 | + if (!$node instanceof EntityCollection) { |
|
112 | + return null; |
|
113 | + } |
|
114 | + |
|
115 | + $data = $request->getBodyAsString(); |
|
116 | + $comment = $this->createComment( |
|
117 | + $node->getName(), |
|
118 | + $node->getId(), |
|
119 | + $data, |
|
120 | + $request->getHeader('Content-Type') |
|
121 | + ); |
|
122 | + |
|
123 | + // update read marker for the current user/poster to avoid |
|
124 | + // having their own comments marked as unread |
|
125 | + $node->setReadMarker(null); |
|
126 | + |
|
127 | + $url = rtrim($request->getUrl(), '/') . '/' . urlencode($comment->getId()); |
|
128 | + |
|
129 | + $response->setHeader('Content-Location', $url); |
|
130 | + |
|
131 | + // created |
|
132 | + $response->setStatus(201); |
|
133 | + return false; |
|
134 | + } |
|
135 | + |
|
136 | + /** |
|
137 | + * Returns a list of reports this plugin supports. |
|
138 | + * |
|
139 | + * This will be used in the {DAV:}supported-report-set property. |
|
140 | + * |
|
141 | + * @param string $uri |
|
142 | + * @return array |
|
143 | + */ |
|
144 | + public function getSupportedReportSet($uri) { |
|
145 | + return [self::REPORT_NAME]; |
|
146 | + } |
|
147 | + |
|
148 | + /** |
|
149 | + * REPORT operations to look for comments |
|
150 | + * |
|
151 | + * @param string $reportName |
|
152 | + * @param array $report |
|
153 | + * @param string $uri |
|
154 | + * @return bool |
|
155 | + * @throws NotFound |
|
156 | + * @throws ReportNotSupported |
|
157 | + */ |
|
158 | + public function onReport($reportName, $report, $uri) { |
|
159 | + $node = $this->server->tree->getNodeForPath($uri); |
|
160 | + if(!$node instanceof EntityCollection || $reportName !== self::REPORT_NAME) { |
|
161 | + throw new ReportNotSupported(); |
|
162 | + } |
|
163 | + $args = ['limit' => 0, 'offset' => 0, 'datetime' => null]; |
|
164 | + $acceptableParameters = [ |
|
165 | + $this::REPORT_PARAM_LIMIT, |
|
166 | + $this::REPORT_PARAM_OFFSET, |
|
167 | + $this::REPORT_PARAM_TIMESTAMP |
|
168 | + ]; |
|
169 | + $ns = '{' . $this::NS_OWNCLOUD . '}'; |
|
170 | + foreach($report as $parameter) { |
|
171 | + if(!in_array($parameter['name'], $acceptableParameters) || empty($parameter['value'])) { |
|
172 | + continue; |
|
173 | + } |
|
174 | + $args[str_replace($ns, '', $parameter['name'])] = $parameter['value']; |
|
175 | + } |
|
176 | + |
|
177 | + if(!is_null($args['datetime'])) { |
|
178 | + $args['datetime'] = new \DateTime($args['datetime']); |
|
179 | + } |
|
180 | + |
|
181 | + $results = $node->findChildren($args['limit'], $args['offset'], $args['datetime']); |
|
182 | + |
|
183 | + $responses = []; |
|
184 | + foreach($results as $node) { |
|
185 | + $nodePath = $this->server->getRequestUri() . '/' . $node->comment->getId(); |
|
186 | + $resultSet = $this->server->getPropertiesForPath($nodePath, CommentNode::getPropertyNames()); |
|
187 | + if(isset($resultSet[0]) && isset($resultSet[0][200])) { |
|
188 | + $responses[] = new Response( |
|
189 | + $this->server->getBaseUri() . $nodePath, |
|
190 | + [200 => $resultSet[0][200]], |
|
191 | + 200 |
|
192 | + ); |
|
193 | + } |
|
194 | + |
|
195 | + } |
|
196 | + |
|
197 | + $xml = $this->server->xml->write( |
|
198 | + '{DAV:}multistatus', |
|
199 | + new MultiStatus($responses) |
|
200 | + ); |
|
201 | + |
|
202 | + $this->server->httpResponse->setStatus(207); |
|
203 | + $this->server->httpResponse->setHeader('Content-Type', 'application/xml; charset=utf-8'); |
|
204 | + $this->server->httpResponse->setBody($xml); |
|
205 | + |
|
206 | + return false; |
|
207 | + } |
|
208 | + |
|
209 | + /** |
|
210 | + * Creates a new comment |
|
211 | + * |
|
212 | + * @param string $objectType e.g. "files" |
|
213 | + * @param string $objectId e.g. the file id |
|
214 | + * @param string $data JSON encoded string containing the properties of the tag to create |
|
215 | + * @param string $contentType content type of the data |
|
216 | + * @return IComment newly created comment |
|
217 | + * |
|
218 | + * @throws BadRequest if a field was missing |
|
219 | + * @throws UnsupportedMediaType if the content type is not supported |
|
220 | + */ |
|
221 | + private function createComment($objectType, $objectId, $data, $contentType = 'application/json') { |
|
222 | + if (explode(';', $contentType)[0] === 'application/json') { |
|
223 | + $data = json_decode($data, true); |
|
224 | + } else { |
|
225 | + throw new UnsupportedMediaType(); |
|
226 | + } |
|
227 | + |
|
228 | + $actorType = $data['actorType']; |
|
229 | + $actorId = null; |
|
230 | + if($actorType === 'users') { |
|
231 | + $user = $this->userSession->getUser(); |
|
232 | + if(!is_null($user)) { |
|
233 | + $actorId = $user->getUID(); |
|
234 | + } |
|
235 | + } |
|
236 | + if(is_null($actorId)) { |
|
237 | + throw new BadRequest('Invalid actor "' . $actorType .'"'); |
|
238 | + } |
|
239 | + |
|
240 | + try { |
|
241 | + $comment = $this->commentsManager->create($actorType, $actorId, $objectType, $objectId); |
|
242 | + $comment->setMessage($data['message']); |
|
243 | + $comment->setVerb($data['verb']); |
|
244 | + $this->commentsManager->save($comment); |
|
245 | + return $comment; |
|
246 | + } catch (\InvalidArgumentException $e) { |
|
247 | + throw new BadRequest('Invalid input values', 0, $e); |
|
248 | + } catch (\OCP\Comments\MessageTooLongException $e) { |
|
249 | + $msg = 'Message exceeds allowed character limit of '; |
|
250 | + throw new BadRequest($msg . \OCP\Comments\IComment::MAX_MESSAGE_LENGTH, 0, $e); |
|
251 | + } |
|
252 | + } |
|
253 | 253 | |
254 | 254 | |
255 | 255 |
@@ -41,156 +41,156 @@ |
||
41 | 41 | * @package OCA\DAV\Comments |
42 | 42 | */ |
43 | 43 | class EntityCollection extends RootCollection implements IProperties { |
44 | - const PROPERTY_NAME_READ_MARKER = '{http://owncloud.org/ns}readMarker'; |
|
44 | + const PROPERTY_NAME_READ_MARKER = '{http://owncloud.org/ns}readMarker'; |
|
45 | 45 | |
46 | - /** @var string */ |
|
47 | - protected $id; |
|
46 | + /** @var string */ |
|
47 | + protected $id; |
|
48 | 48 | |
49 | - /** @var ILogger */ |
|
50 | - protected $logger; |
|
49 | + /** @var ILogger */ |
|
50 | + protected $logger; |
|
51 | 51 | |
52 | - /** |
|
53 | - * @param string $id |
|
54 | - * @param string $name |
|
55 | - * @param ICommentsManager $commentsManager |
|
56 | - * @param IUserManager $userManager |
|
57 | - * @param IUserSession $userSession |
|
58 | - * @param ILogger $logger |
|
59 | - */ |
|
60 | - public function __construct( |
|
61 | - $id, |
|
62 | - $name, |
|
63 | - ICommentsManager $commentsManager, |
|
64 | - IUserManager $userManager, |
|
65 | - IUserSession $userSession, |
|
66 | - ILogger $logger |
|
67 | - ) { |
|
68 | - foreach(['id', 'name'] as $property) { |
|
69 | - $$property = trim($$property); |
|
70 | - if(empty($$property) || !is_string($$property)) { |
|
71 | - throw new \InvalidArgumentException('"' . $property . '" parameter must be non-empty string'); |
|
72 | - } |
|
73 | - } |
|
74 | - $this->id = $id; |
|
75 | - $this->name = $name; |
|
76 | - $this->commentsManager = $commentsManager; |
|
77 | - $this->logger = $logger; |
|
78 | - $this->userManager = $userManager; |
|
79 | - $this->userSession = $userSession; |
|
80 | - } |
|
52 | + /** |
|
53 | + * @param string $id |
|
54 | + * @param string $name |
|
55 | + * @param ICommentsManager $commentsManager |
|
56 | + * @param IUserManager $userManager |
|
57 | + * @param IUserSession $userSession |
|
58 | + * @param ILogger $logger |
|
59 | + */ |
|
60 | + public function __construct( |
|
61 | + $id, |
|
62 | + $name, |
|
63 | + ICommentsManager $commentsManager, |
|
64 | + IUserManager $userManager, |
|
65 | + IUserSession $userSession, |
|
66 | + ILogger $logger |
|
67 | + ) { |
|
68 | + foreach(['id', 'name'] as $property) { |
|
69 | + $$property = trim($$property); |
|
70 | + if(empty($$property) || !is_string($$property)) { |
|
71 | + throw new \InvalidArgumentException('"' . $property . '" parameter must be non-empty string'); |
|
72 | + } |
|
73 | + } |
|
74 | + $this->id = $id; |
|
75 | + $this->name = $name; |
|
76 | + $this->commentsManager = $commentsManager; |
|
77 | + $this->logger = $logger; |
|
78 | + $this->userManager = $userManager; |
|
79 | + $this->userSession = $userSession; |
|
80 | + } |
|
81 | 81 | |
82 | - /** |
|
83 | - * returns the ID of this entity |
|
84 | - * |
|
85 | - * @return string |
|
86 | - */ |
|
87 | - public function getId() { |
|
88 | - return $this->id; |
|
89 | - } |
|
82 | + /** |
|
83 | + * returns the ID of this entity |
|
84 | + * |
|
85 | + * @return string |
|
86 | + */ |
|
87 | + public function getId() { |
|
88 | + return $this->id; |
|
89 | + } |
|
90 | 90 | |
91 | - /** |
|
92 | - * Returns a specific child node, referenced by its name |
|
93 | - * |
|
94 | - * This method must throw Sabre\DAV\Exception\NotFound if the node does not |
|
95 | - * exist. |
|
96 | - * |
|
97 | - * @param string $name |
|
98 | - * @return \Sabre\DAV\INode |
|
99 | - * @throws NotFound |
|
100 | - */ |
|
101 | - function getChild($name) { |
|
102 | - try { |
|
103 | - $comment = $this->commentsManager->get($name); |
|
104 | - return new CommentNode( |
|
105 | - $this->commentsManager, |
|
106 | - $comment, |
|
107 | - $this->userManager, |
|
108 | - $this->userSession, |
|
109 | - $this->logger |
|
110 | - ); |
|
111 | - } catch (NotFoundException $e) { |
|
112 | - throw new NotFound(); |
|
113 | - } |
|
114 | - } |
|
91 | + /** |
|
92 | + * Returns a specific child node, referenced by its name |
|
93 | + * |
|
94 | + * This method must throw Sabre\DAV\Exception\NotFound if the node does not |
|
95 | + * exist. |
|
96 | + * |
|
97 | + * @param string $name |
|
98 | + * @return \Sabre\DAV\INode |
|
99 | + * @throws NotFound |
|
100 | + */ |
|
101 | + function getChild($name) { |
|
102 | + try { |
|
103 | + $comment = $this->commentsManager->get($name); |
|
104 | + return new CommentNode( |
|
105 | + $this->commentsManager, |
|
106 | + $comment, |
|
107 | + $this->userManager, |
|
108 | + $this->userSession, |
|
109 | + $this->logger |
|
110 | + ); |
|
111 | + } catch (NotFoundException $e) { |
|
112 | + throw new NotFound(); |
|
113 | + } |
|
114 | + } |
|
115 | 115 | |
116 | - /** |
|
117 | - * Returns an array with all the child nodes |
|
118 | - * |
|
119 | - * @return \Sabre\DAV\INode[] |
|
120 | - */ |
|
121 | - function getChildren() { |
|
122 | - return $this->findChildren(); |
|
123 | - } |
|
116 | + /** |
|
117 | + * Returns an array with all the child nodes |
|
118 | + * |
|
119 | + * @return \Sabre\DAV\INode[] |
|
120 | + */ |
|
121 | + function getChildren() { |
|
122 | + return $this->findChildren(); |
|
123 | + } |
|
124 | 124 | |
125 | - /** |
|
126 | - * Returns an array of comment nodes. Result can be influenced by offset, |
|
127 | - * limit and date time parameters. |
|
128 | - * |
|
129 | - * @param int $limit |
|
130 | - * @param int $offset |
|
131 | - * @param \DateTime|null $datetime |
|
132 | - * @return CommentNode[] |
|
133 | - */ |
|
134 | - function findChildren($limit = 0, $offset = 0, \DateTime $datetime = null) { |
|
135 | - $comments = $this->commentsManager->getForObject($this->name, $this->id, $limit, $offset, $datetime); |
|
136 | - $result = []; |
|
137 | - foreach($comments as $comment) { |
|
138 | - $result[] = new CommentNode( |
|
139 | - $this->commentsManager, |
|
140 | - $comment, |
|
141 | - $this->userManager, |
|
142 | - $this->userSession, |
|
143 | - $this->logger |
|
144 | - ); |
|
145 | - } |
|
146 | - return $result; |
|
147 | - } |
|
125 | + /** |
|
126 | + * Returns an array of comment nodes. Result can be influenced by offset, |
|
127 | + * limit and date time parameters. |
|
128 | + * |
|
129 | + * @param int $limit |
|
130 | + * @param int $offset |
|
131 | + * @param \DateTime|null $datetime |
|
132 | + * @return CommentNode[] |
|
133 | + */ |
|
134 | + function findChildren($limit = 0, $offset = 0, \DateTime $datetime = null) { |
|
135 | + $comments = $this->commentsManager->getForObject($this->name, $this->id, $limit, $offset, $datetime); |
|
136 | + $result = []; |
|
137 | + foreach($comments as $comment) { |
|
138 | + $result[] = new CommentNode( |
|
139 | + $this->commentsManager, |
|
140 | + $comment, |
|
141 | + $this->userManager, |
|
142 | + $this->userSession, |
|
143 | + $this->logger |
|
144 | + ); |
|
145 | + } |
|
146 | + return $result; |
|
147 | + } |
|
148 | 148 | |
149 | - /** |
|
150 | - * Checks if a child-node with the specified name exists |
|
151 | - * |
|
152 | - * @param string $name |
|
153 | - * @return bool |
|
154 | - */ |
|
155 | - function childExists($name) { |
|
156 | - try { |
|
157 | - $this->commentsManager->get($name); |
|
158 | - return true; |
|
159 | - } catch (NotFoundException $e) { |
|
160 | - return false; |
|
161 | - } |
|
162 | - } |
|
149 | + /** |
|
150 | + * Checks if a child-node with the specified name exists |
|
151 | + * |
|
152 | + * @param string $name |
|
153 | + * @return bool |
|
154 | + */ |
|
155 | + function childExists($name) { |
|
156 | + try { |
|
157 | + $this->commentsManager->get($name); |
|
158 | + return true; |
|
159 | + } catch (NotFoundException $e) { |
|
160 | + return false; |
|
161 | + } |
|
162 | + } |
|
163 | 163 | |
164 | - /** |
|
165 | - * Sets the read marker to the specified date for the logged in user |
|
166 | - * |
|
167 | - * @param \DateTime $value |
|
168 | - * @return bool |
|
169 | - */ |
|
170 | - public function setReadMarker($value) { |
|
171 | - $dateTime = new \DateTime($value); |
|
172 | - $user = $this->userSession->getUser(); |
|
173 | - $this->commentsManager->setReadMark($this->name, $this->id, $dateTime, $user); |
|
174 | - return true; |
|
175 | - } |
|
164 | + /** |
|
165 | + * Sets the read marker to the specified date for the logged in user |
|
166 | + * |
|
167 | + * @param \DateTime $value |
|
168 | + * @return bool |
|
169 | + */ |
|
170 | + public function setReadMarker($value) { |
|
171 | + $dateTime = new \DateTime($value); |
|
172 | + $user = $this->userSession->getUser(); |
|
173 | + $this->commentsManager->setReadMark($this->name, $this->id, $dateTime, $user); |
|
174 | + return true; |
|
175 | + } |
|
176 | 176 | |
177 | - /** |
|
178 | - * @inheritdoc |
|
179 | - */ |
|
180 | - function propPatch(PropPatch $propPatch) { |
|
181 | - $propPatch->handle(self::PROPERTY_NAME_READ_MARKER, [$this, 'setReadMarker']); |
|
182 | - } |
|
177 | + /** |
|
178 | + * @inheritdoc |
|
179 | + */ |
|
180 | + function propPatch(PropPatch $propPatch) { |
|
181 | + $propPatch->handle(self::PROPERTY_NAME_READ_MARKER, [$this, 'setReadMarker']); |
|
182 | + } |
|
183 | 183 | |
184 | - /** |
|
185 | - * @inheritdoc |
|
186 | - */ |
|
187 | - function getProperties($properties) { |
|
188 | - $marker = null; |
|
189 | - $user = $this->userSession->getUser(); |
|
190 | - if(!is_null($user)) { |
|
191 | - $marker = $this->commentsManager->getReadMark($this->name, $this->id, $user); |
|
192 | - } |
|
193 | - return [self::PROPERTY_NAME_READ_MARKER => $marker]; |
|
194 | - } |
|
184 | + /** |
|
185 | + * @inheritdoc |
|
186 | + */ |
|
187 | + function getProperties($properties) { |
|
188 | + $marker = null; |
|
189 | + $user = $this->userSession->getUser(); |
|
190 | + if(!is_null($user)) { |
|
191 | + $marker = $this->commentsManager->getReadMark($this->name, $this->id, $user); |
|
192 | + } |
|
193 | + return [self::PROPERTY_NAME_READ_MARKER => $marker]; |
|
194 | + } |
|
195 | 195 | } |
196 | 196 |
@@ -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 | } |
@@ -33,50 +33,50 @@ |
||
33 | 33 | */ |
34 | 34 | class CopyEtagHeaderPlugin extends \Sabre\DAV\ServerPlugin { |
35 | 35 | |
36 | - /** @var \Sabre\DAV\Server */ |
|
37 | - private $server; |
|
38 | - /** |
|
39 | - * This initializes the plugin. |
|
40 | - * |
|
41 | - * @param \Sabre\DAV\Server $server Sabre server |
|
42 | - * |
|
43 | - * @return void |
|
44 | - */ |
|
45 | - public function initialize(\Sabre\DAV\Server $server) { |
|
46 | - $this->server = $server; |
|
36 | + /** @var \Sabre\DAV\Server */ |
|
37 | + private $server; |
|
38 | + /** |
|
39 | + * This initializes the plugin. |
|
40 | + * |
|
41 | + * @param \Sabre\DAV\Server $server Sabre server |
|
42 | + * |
|
43 | + * @return void |
|
44 | + */ |
|
45 | + public function initialize(\Sabre\DAV\Server $server) { |
|
46 | + $this->server = $server; |
|
47 | 47 | |
48 | - $server->on('afterMethod', [$this, 'afterMethod']); |
|
49 | - $server->on('afterMove', [$this, 'afterMove']); |
|
50 | - } |
|
48 | + $server->on('afterMethod', [$this, 'afterMethod']); |
|
49 | + $server->on('afterMove', [$this, 'afterMove']); |
|
50 | + } |
|
51 | 51 | |
52 | - /** |
|
53 | - * After method, copy the "Etag" header to "OC-Etag" header. |
|
54 | - * |
|
55 | - * @param RequestInterface $request request |
|
56 | - * @param ResponseInterface $response response |
|
57 | - */ |
|
58 | - public function afterMethod(RequestInterface $request, ResponseInterface $response) { |
|
59 | - $eTag = $response->getHeader('Etag'); |
|
60 | - if (!empty($eTag)) { |
|
61 | - $response->setHeader('OC-ETag', $eTag); |
|
62 | - } |
|
63 | - } |
|
52 | + /** |
|
53 | + * After method, copy the "Etag" header to "OC-Etag" header. |
|
54 | + * |
|
55 | + * @param RequestInterface $request request |
|
56 | + * @param ResponseInterface $response response |
|
57 | + */ |
|
58 | + public function afterMethod(RequestInterface $request, ResponseInterface $response) { |
|
59 | + $eTag = $response->getHeader('Etag'); |
|
60 | + if (!empty($eTag)) { |
|
61 | + $response->setHeader('OC-ETag', $eTag); |
|
62 | + } |
|
63 | + } |
|
64 | 64 | |
65 | - /** |
|
66 | - * Called after a node is moved. |
|
67 | - * |
|
68 | - * This allows the backend to move all the associated properties. |
|
69 | - * |
|
70 | - * @param string $source |
|
71 | - * @param string $destination |
|
72 | - * @return void |
|
73 | - */ |
|
74 | - function afterMove($source, $destination) { |
|
75 | - $node = $this->server->tree->getNodeForPath($destination); |
|
76 | - if ($node instanceof File) { |
|
77 | - $eTag = $node->getETag(); |
|
78 | - $this->server->httpResponse->setHeader('OC-ETag', $eTag); |
|
79 | - $this->server->httpResponse->setHeader('ETag', $eTag); |
|
80 | - } |
|
81 | - } |
|
65 | + /** |
|
66 | + * Called after a node is moved. |
|
67 | + * |
|
68 | + * This allows the backend to move all the associated properties. |
|
69 | + * |
|
70 | + * @param string $source |
|
71 | + * @param string $destination |
|
72 | + * @return void |
|
73 | + */ |
|
74 | + function afterMove($source, $destination) { |
|
75 | + $node = $this->server->tree->getNodeForPath($destination); |
|
76 | + if ($node instanceof File) { |
|
77 | + $eTag = $node->getETag(); |
|
78 | + $this->server->httpResponse->setHeader('OC-ETag', $eTag); |
|
79 | + $this->server->httpResponse->setHeader('ETag', $eTag); |
|
80 | + } |
|
81 | + } |
|
82 | 82 | } |
@@ -32,41 +32,41 @@ |
||
32 | 32 | * checksum name. |
33 | 33 | */ |
34 | 34 | class ChecksumList implements XmlSerializable { |
35 | - const NS_OWNCLOUD = 'http://owncloud.org/ns'; |
|
35 | + const NS_OWNCLOUD = 'http://owncloud.org/ns'; |
|
36 | 36 | |
37 | - /** @var string[] of TYPE:CHECKSUM */ |
|
38 | - private $checksums; |
|
37 | + /** @var string[] of TYPE:CHECKSUM */ |
|
38 | + private $checksums; |
|
39 | 39 | |
40 | - /** |
|
41 | - * @param string $checksum |
|
42 | - */ |
|
43 | - public function __construct($checksum) { |
|
44 | - $this->checksums = explode(',', $checksum); |
|
45 | - } |
|
40 | + /** |
|
41 | + * @param string $checksum |
|
42 | + */ |
|
43 | + public function __construct($checksum) { |
|
44 | + $this->checksums = explode(',', $checksum); |
|
45 | + } |
|
46 | 46 | |
47 | - /** |
|
48 | - * The xmlSerialize metod is called during xml writing. |
|
49 | - * |
|
50 | - * Use the $writer argument to write its own xml serialization. |
|
51 | - * |
|
52 | - * An important note: do _not_ create a parent element. Any element |
|
53 | - * implementing XmlSerializble should only ever write what's considered |
|
54 | - * its 'inner xml'. |
|
55 | - * |
|
56 | - * The parent of the current element is responsible for writing a |
|
57 | - * containing element. |
|
58 | - * |
|
59 | - * This allows serializers to be re-used for different element names. |
|
60 | - * |
|
61 | - * If you are opening new elements, you must also close them again. |
|
62 | - * |
|
63 | - * @param Writer $writer |
|
64 | - * @return void |
|
65 | - */ |
|
66 | - function xmlSerialize(Writer $writer) { |
|
47 | + /** |
|
48 | + * The xmlSerialize metod is called during xml writing. |
|
49 | + * |
|
50 | + * Use the $writer argument to write its own xml serialization. |
|
51 | + * |
|
52 | + * An important note: do _not_ create a parent element. Any element |
|
53 | + * implementing XmlSerializble should only ever write what's considered |
|
54 | + * its 'inner xml'. |
|
55 | + * |
|
56 | + * The parent of the current element is responsible for writing a |
|
57 | + * containing element. |
|
58 | + * |
|
59 | + * This allows serializers to be re-used for different element names. |
|
60 | + * |
|
61 | + * If you are opening new elements, you must also close them again. |
|
62 | + * |
|
63 | + * @param Writer $writer |
|
64 | + * @return void |
|
65 | + */ |
|
66 | + function xmlSerialize(Writer $writer) { |
|
67 | 67 | |
68 | - foreach ($this->checksums as $checksum) { |
|
69 | - $writer->writeElement('{' . self::NS_OWNCLOUD . '}checksum', $checksum); |
|
70 | - } |
|
71 | - } |
|
68 | + foreach ($this->checksums as $checksum) { |
|
69 | + $writer->writeElement('{' . self::NS_OWNCLOUD . '}checksum', $checksum); |
|
70 | + } |
|
71 | + } |
|
72 | 72 | } |
@@ -34,58 +34,58 @@ |
||
34 | 34 | */ |
35 | 35 | class AppEnabledPlugin extends ServerPlugin { |
36 | 36 | |
37 | - /** |
|
38 | - * Reference to main server object |
|
39 | - * |
|
40 | - * @var \Sabre\DAV\Server |
|
41 | - */ |
|
42 | - private $server; |
|
37 | + /** |
|
38 | + * Reference to main server object |
|
39 | + * |
|
40 | + * @var \Sabre\DAV\Server |
|
41 | + */ |
|
42 | + private $server; |
|
43 | 43 | |
44 | - /** |
|
45 | - * @var string |
|
46 | - */ |
|
47 | - private $app; |
|
44 | + /** |
|
45 | + * @var string |
|
46 | + */ |
|
47 | + private $app; |
|
48 | 48 | |
49 | - /** |
|
50 | - * @var \OCP\App\IAppManager |
|
51 | - */ |
|
52 | - private $appManager; |
|
49 | + /** |
|
50 | + * @var \OCP\App\IAppManager |
|
51 | + */ |
|
52 | + private $appManager; |
|
53 | 53 | |
54 | - /** |
|
55 | - * @param string $app |
|
56 | - * @param \OCP\App\IAppManager $appManager |
|
57 | - */ |
|
58 | - public function __construct($app, IAppManager $appManager) { |
|
59 | - $this->app = $app; |
|
60 | - $this->appManager = $appManager; |
|
61 | - } |
|
54 | + /** |
|
55 | + * @param string $app |
|
56 | + * @param \OCP\App\IAppManager $appManager |
|
57 | + */ |
|
58 | + public function __construct($app, IAppManager $appManager) { |
|
59 | + $this->app = $app; |
|
60 | + $this->appManager = $appManager; |
|
61 | + } |
|
62 | 62 | |
63 | - /** |
|
64 | - * This initializes the plugin. |
|
65 | - * |
|
66 | - * This function is called by \Sabre\DAV\Server, after |
|
67 | - * addPlugin is called. |
|
68 | - * |
|
69 | - * This method should set up the required event subscriptions. |
|
70 | - * |
|
71 | - * @param \Sabre\DAV\Server $server |
|
72 | - * @return void |
|
73 | - */ |
|
74 | - public function initialize(\Sabre\DAV\Server $server) { |
|
63 | + /** |
|
64 | + * This initializes the plugin. |
|
65 | + * |
|
66 | + * This function is called by \Sabre\DAV\Server, after |
|
67 | + * addPlugin is called. |
|
68 | + * |
|
69 | + * This method should set up the required event subscriptions. |
|
70 | + * |
|
71 | + * @param \Sabre\DAV\Server $server |
|
72 | + * @return void |
|
73 | + */ |
|
74 | + public function initialize(\Sabre\DAV\Server $server) { |
|
75 | 75 | |
76 | - $this->server = $server; |
|
77 | - $this->server->on('beforeMethod', array($this, 'checkAppEnabled'), 30); |
|
78 | - } |
|
76 | + $this->server = $server; |
|
77 | + $this->server->on('beforeMethod', array($this, 'checkAppEnabled'), 30); |
|
78 | + } |
|
79 | 79 | |
80 | - /** |
|
81 | - * This method is called before any HTTP after auth and checks if the user has access to the app |
|
82 | - * |
|
83 | - * @throws \Sabre\DAV\Exception\Forbidden |
|
84 | - * @return bool |
|
85 | - */ |
|
86 | - public function checkAppEnabled() { |
|
87 | - if (!$this->appManager->isEnabledForUser($this->app)) { |
|
88 | - throw new Forbidden(); |
|
89 | - } |
|
90 | - } |
|
80 | + /** |
|
81 | + * This method is called before any HTTP after auth and checks if the user has access to the app |
|
82 | + * |
|
83 | + * @throws \Sabre\DAV\Exception\Forbidden |
|
84 | + * @return bool |
|
85 | + */ |
|
86 | + public function checkAppEnabled() { |
|
87 | + if (!$this->appManager->isEnabledForUser($this->app)) { |
|
88 | + throw new Forbidden(); |
|
89 | + } |
|
90 | + } |
|
91 | 91 | } |
@@ -35,47 +35,47 @@ |
||
35 | 35 | * @package OCA\DAV\Connector\Sabre |
36 | 36 | */ |
37 | 37 | class BlockLegacyClientPlugin extends ServerPlugin { |
38 | - /** @var \Sabre\DAV\Server */ |
|
39 | - protected $server; |
|
40 | - /** @var IConfig */ |
|
41 | - protected $config; |
|
38 | + /** @var \Sabre\DAV\Server */ |
|
39 | + protected $server; |
|
40 | + /** @var IConfig */ |
|
41 | + protected $config; |
|
42 | 42 | |
43 | - /** |
|
44 | - * @param IConfig $config |
|
45 | - */ |
|
46 | - public function __construct(IConfig $config) { |
|
47 | - $this->config = $config; |
|
48 | - } |
|
43 | + /** |
|
44 | + * @param IConfig $config |
|
45 | + */ |
|
46 | + public function __construct(IConfig $config) { |
|
47 | + $this->config = $config; |
|
48 | + } |
|
49 | 49 | |
50 | - /** |
|
51 | - * @param \Sabre\DAV\Server $server |
|
52 | - * @return void |
|
53 | - */ |
|
54 | - public function initialize(\Sabre\DAV\Server $server) { |
|
55 | - $this->server = $server; |
|
56 | - $this->server->on('beforeMethod', [$this, 'beforeHandler'], 200); |
|
57 | - } |
|
50 | + /** |
|
51 | + * @param \Sabre\DAV\Server $server |
|
52 | + * @return void |
|
53 | + */ |
|
54 | + public function initialize(\Sabre\DAV\Server $server) { |
|
55 | + $this->server = $server; |
|
56 | + $this->server->on('beforeMethod', [$this, 'beforeHandler'], 200); |
|
57 | + } |
|
58 | 58 | |
59 | - /** |
|
60 | - * Detects all unsupported clients and throws a \Sabre\DAV\Exception\Forbidden |
|
61 | - * exception which will result in a 403 to them. |
|
62 | - * @param RequestInterface $request |
|
63 | - * @throws \Sabre\DAV\Exception\Forbidden If the client version is not supported |
|
64 | - */ |
|
65 | - public function beforeHandler(RequestInterface $request) { |
|
66 | - $userAgent = $request->getHeader('User-Agent'); |
|
67 | - if($userAgent === null) { |
|
68 | - return; |
|
69 | - } |
|
59 | + /** |
|
60 | + * Detects all unsupported clients and throws a \Sabre\DAV\Exception\Forbidden |
|
61 | + * exception which will result in a 403 to them. |
|
62 | + * @param RequestInterface $request |
|
63 | + * @throws \Sabre\DAV\Exception\Forbidden If the client version is not supported |
|
64 | + */ |
|
65 | + public function beforeHandler(RequestInterface $request) { |
|
66 | + $userAgent = $request->getHeader('User-Agent'); |
|
67 | + if($userAgent === null) { |
|
68 | + return; |
|
69 | + } |
|
70 | 70 | |
71 | - $minimumSupportedDesktopVersion = $this->config->getSystemValue('minimum.supported.desktop.version', '2.0.0'); |
|
71 | + $minimumSupportedDesktopVersion = $this->config->getSystemValue('minimum.supported.desktop.version', '2.0.0'); |
|
72 | 72 | |
73 | - // Match on the mirall version which is in scheme "Mozilla/5.0 (%1) mirall/%2" or |
|
74 | - // "mirall/%1" for older releases |
|
75 | - preg_match("/(?:mirall\\/)([\d.]+)/i", $userAgent, $versionMatches); |
|
76 | - if(isset($versionMatches[1]) && |
|
77 | - version_compare($versionMatches[1], $minimumSupportedDesktopVersion) === -1) { |
|
78 | - throw new \Sabre\DAV\Exception\Forbidden('Unsupported client version.'); |
|
79 | - } |
|
80 | - } |
|
73 | + // Match on the mirall version which is in scheme "Mozilla/5.0 (%1) mirall/%2" or |
|
74 | + // "mirall/%1" for older releases |
|
75 | + preg_match("/(?:mirall\\/)([\d.]+)/i", $userAgent, $versionMatches); |
|
76 | + if(isset($versionMatches[1]) && |
|
77 | + version_compare($versionMatches[1], $minimumSupportedDesktopVersion) === -1) { |
|
78 | + throw new \Sabre\DAV\Exception\Forbidden('Unsupported client version.'); |
|
79 | + } |
|
80 | + } |
|
81 | 81 | } |
@@ -32,61 +32,61 @@ |
||
32 | 32 | * This property contains multiple "share-type" elements, each containing a share type. |
33 | 33 | */ |
34 | 34 | class ShareTypeList implements Element { |
35 | - const NS_OWNCLOUD = 'http://owncloud.org/ns'; |
|
35 | + const NS_OWNCLOUD = 'http://owncloud.org/ns'; |
|
36 | 36 | |
37 | - /** |
|
38 | - * Share types |
|
39 | - * |
|
40 | - * @var int[] |
|
41 | - */ |
|
42 | - private $shareTypes; |
|
37 | + /** |
|
38 | + * Share types |
|
39 | + * |
|
40 | + * @var int[] |
|
41 | + */ |
|
42 | + private $shareTypes; |
|
43 | 43 | |
44 | - /** |
|
45 | - * @param int[] $shareTypes |
|
46 | - */ |
|
47 | - public function __construct($shareTypes) { |
|
48 | - $this->shareTypes = $shareTypes; |
|
49 | - } |
|
44 | + /** |
|
45 | + * @param int[] $shareTypes |
|
46 | + */ |
|
47 | + public function __construct($shareTypes) { |
|
48 | + $this->shareTypes = $shareTypes; |
|
49 | + } |
|
50 | 50 | |
51 | - /** |
|
52 | - * Returns the share types |
|
53 | - * |
|
54 | - * @return int[] |
|
55 | - */ |
|
56 | - public function getShareTypes() { |
|
57 | - return $this->shareTypes; |
|
58 | - } |
|
51 | + /** |
|
52 | + * Returns the share types |
|
53 | + * |
|
54 | + * @return int[] |
|
55 | + */ |
|
56 | + public function getShareTypes() { |
|
57 | + return $this->shareTypes; |
|
58 | + } |
|
59 | 59 | |
60 | - /** |
|
61 | - * The deserialize method is called during xml parsing. |
|
62 | - * |
|
63 | - * @param Reader $reader |
|
64 | - * @return mixed |
|
65 | - */ |
|
66 | - static function xmlDeserialize(Reader $reader) { |
|
67 | - $shareTypes = []; |
|
60 | + /** |
|
61 | + * The deserialize method is called during xml parsing. |
|
62 | + * |
|
63 | + * @param Reader $reader |
|
64 | + * @return mixed |
|
65 | + */ |
|
66 | + static function xmlDeserialize(Reader $reader) { |
|
67 | + $shareTypes = []; |
|
68 | 68 | |
69 | - $tree = $reader->parseInnerTree(); |
|
70 | - if ($tree === null) { |
|
71 | - return null; |
|
72 | - } |
|
73 | - foreach ($tree as $elem) { |
|
74 | - if ($elem['name'] === '{' . self::NS_OWNCLOUD . '}share-type') { |
|
75 | - $shareTypes[] = (int)$elem['value']; |
|
76 | - } |
|
77 | - } |
|
78 | - return new self($shareTypes); |
|
79 | - } |
|
69 | + $tree = $reader->parseInnerTree(); |
|
70 | + if ($tree === null) { |
|
71 | + return null; |
|
72 | + } |
|
73 | + foreach ($tree as $elem) { |
|
74 | + if ($elem['name'] === '{' . self::NS_OWNCLOUD . '}share-type') { |
|
75 | + $shareTypes[] = (int)$elem['value']; |
|
76 | + } |
|
77 | + } |
|
78 | + return new self($shareTypes); |
|
79 | + } |
|
80 | 80 | |
81 | - /** |
|
82 | - * The xmlSerialize metod is called during xml writing. |
|
83 | - * |
|
84 | - * @param Writer $writer |
|
85 | - * @return void |
|
86 | - */ |
|
87 | - function xmlSerialize(Writer $writer) { |
|
88 | - foreach ($this->shareTypes as $shareType) { |
|
89 | - $writer->writeElement('{' . self::NS_OWNCLOUD . '}share-type', $shareType); |
|
90 | - } |
|
91 | - } |
|
81 | + /** |
|
82 | + * The xmlSerialize metod is called during xml writing. |
|
83 | + * |
|
84 | + * @param Writer $writer |
|
85 | + * @return void |
|
86 | + */ |
|
87 | + function xmlSerialize(Writer $writer) { |
|
88 | + foreach ($this->shareTypes as $shareType) { |
|
89 | + $writer->writeElement('{' . self::NS_OWNCLOUD . '}share-type', $shareType); |
|
90 | + } |
|
91 | + } |
|
92 | 92 | } |