aboutsummaryrefslogtreecommitdiffstats
path: root/apps/files_sharing/lib/Controller/ShareInfoController.php
diff options
context:
space:
mode:
Diffstat (limited to 'apps/files_sharing/lib/Controller/ShareInfoController.php')
-rw-r--r--apps/files_sharing/lib/Controller/ShareInfoController.php154
1 files changed, 154 insertions, 0 deletions
diff --git a/apps/files_sharing/lib/Controller/ShareInfoController.php b/apps/files_sharing/lib/Controller/ShareInfoController.php
new file mode 100644
index 00000000000..b7e79aec830
--- /dev/null
+++ b/apps/files_sharing/lib/Controller/ShareInfoController.php
@@ -0,0 +1,154 @@
+<?php
+
+/**
+ * SPDX-FileCopyrightText: 2016 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+namespace OCA\Files_Sharing\Controller;
+
+use OCA\Files_External\NotFoundException;
+use OCA\Files_Sharing\ResponseDefinitions;
+use OCP\AppFramework\ApiController;
+use OCP\AppFramework\Http;
+use OCP\AppFramework\Http\Attribute\BruteForceProtection;
+use OCP\AppFramework\Http\Attribute\NoCSRFRequired;
+use OCP\AppFramework\Http\Attribute\OpenAPI;
+use OCP\AppFramework\Http\Attribute\PublicPage;
+use OCP\AppFramework\Http\JSONResponse;
+use OCP\Constants;
+use OCP\Files\File;
+use OCP\Files\Folder;
+use OCP\Files\Node;
+use OCP\IRequest;
+use OCP\Share\Exceptions\ShareNotFound;
+use OCP\Share\IManager;
+
+/**
+ * @psalm-import-type Files_SharingShareInfo from ResponseDefinitions
+ */
+class ShareInfoController extends ApiController {
+
+ /**
+ * ShareInfoController constructor.
+ *
+ * @param string $appName
+ * @param IRequest $request
+ * @param IManager $shareManager
+ */
+ public function __construct(
+ string $appName,
+ IRequest $request,
+ private IManager $shareManager,
+ ) {
+ parent::__construct($appName, $request);
+ }
+
+ /**
+ * Get the info about a share
+ *
+ * @param string $t Token of the share
+ * @param string|null $password Password of the share
+ * @param string|null $dir Subdirectory to get info about
+ * @param int $depth Maximum depth to get info about
+ * @return JSONResponse<Http::STATUS_OK, Files_SharingShareInfo, array{}>|JSONResponse<Http::STATUS_FORBIDDEN|Http::STATUS_NOT_FOUND, list<empty>, array{}>
+ *
+ * 200: Share info returned
+ * 403: Getting share info is not allowed
+ * 404: Share not found
+ */
+ #[PublicPage]
+ #[NoCSRFRequired]
+ #[BruteForceProtection(action: 'shareinfo')]
+ #[OpenAPI(scope: OpenAPI::SCOPE_DEFAULT)]
+ public function info(string $t, ?string $password = null, ?string $dir = null, int $depth = -1): JSONResponse {
+ try {
+ $share = $this->shareManager->getShareByToken($t);
+ } catch (ShareNotFound $e) {
+ $response = new JSONResponse([], Http::STATUS_NOT_FOUND);
+ $response->throttle(['token' => $t]);
+ return $response;
+ }
+
+ if ($share->getPassword() && !$this->shareManager->checkPassword($share, $password)) {
+ $response = new JSONResponse([], Http::STATUS_FORBIDDEN);
+ $response->throttle(['token' => $t]);
+ return $response;
+ }
+
+ if (!($share->getPermissions() & Constants::PERMISSION_READ)) {
+ $response = new JSONResponse([], Http::STATUS_FORBIDDEN);
+ $response->throttle(['token' => $t]);
+ return $response;
+ }
+
+ $permissionMask = $share->getPermissions();
+ $node = $share->getNode();
+
+ if ($dir !== null && $node instanceof Folder) {
+ try {
+ $node = $node->get($dir);
+ } catch (NotFoundException $e) {
+ }
+ }
+
+ return new JSONResponse($this->parseNode($node, $permissionMask, $depth));
+ }
+
+ /**
+ * @return Files_SharingShareInfo
+ */
+ private function parseNode(Node $node, int $permissionMask, int $depth): array {
+ if ($node instanceof File) {
+ return $this->parseFile($node, $permissionMask);
+ }
+ /** @var Folder $node */
+ return $this->parseFolder($node, $permissionMask, $depth);
+ }
+
+ /**
+ * @return Files_SharingShareInfo
+ */
+ private function parseFile(File $file, int $permissionMask): array {
+ return $this->format($file, $permissionMask);
+ }
+
+ /**
+ * @return Files_SharingShareInfo
+ */
+ private function parseFolder(Folder $folder, int $permissionMask, int $depth): array {
+ $data = $this->format($folder, $permissionMask);
+
+ if ($depth === 0) {
+ return $data;
+ }
+
+ $data['children'] = [];
+
+ $nodes = $folder->getDirectoryListing();
+ foreach ($nodes as $node) {
+ $data['children'][] = $this->parseNode($node, $permissionMask, $depth <= -1 ? -1 : $depth - 1);
+ }
+
+ return $data;
+ }
+
+ /**
+ * @return Files_SharingShareInfo
+ */
+ private function format(Node $node, int $permissionMask): array {
+ $entry = [];
+
+ $entry['id'] = $node->getId();
+ $entry['parentId'] = $node->getParent()->getId();
+ $entry['mtime'] = $node->getMTime();
+
+ $entry['name'] = $node->getName();
+ $entry['permissions'] = $node->getPermissions() & $permissionMask;
+ $entry['mimetype'] = $node->getMimetype();
+ $entry['size'] = $node->getSize();
+ $entry['type'] = $node->getType();
+ $entry['etag'] = $node->getEtag();
+
+ return $entry;
+ }
+}