aboutsummaryrefslogtreecommitdiffstats
path: root/apps/files_external/lib/Controller/ApiController.php
diff options
context:
space:
mode:
Diffstat (limited to 'apps/files_external/lib/Controller/ApiController.php')
-rw-r--r--apps/files_external/lib/Controller/ApiController.php90
1 files changed, 49 insertions, 41 deletions
diff --git a/apps/files_external/lib/Controller/ApiController.php b/apps/files_external/lib/Controller/ApiController.php
index 40539d0bbca..56242938593 100644
--- a/apps/files_external/lib/Controller/ApiController.php
+++ b/apps/files_external/lib/Controller/ApiController.php
@@ -3,59 +3,38 @@
declare(strict_types=1);
/**
- * @copyright Copyright (c) 2016, ownCloud, Inc.
- *
- * @author Christoph Wurst <christoph@winzerhof-wurst.at>
- * @author Jesús Macias <jmacias@solidgear.es>
- * @author Joas Schilling <coding@schilljs.com>
- * @author Morris Jobke <hey@morrisjobke.de>
- * @author Roeland Jago Douma <roeland@famdouma.nl>
- * @author Vincent Petry <vincent@nextcloud.com>
- *
- * @license AGPL-3.0
- *
- * This code is free software: you can redistribute it and/or modify
- * it under the terms of the GNU Affero General Public License, version 3,
- * as published by the Free Software Foundation.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU Affero General Public License for more details.
- *
- * You should have received a copy of the GNU Affero General Public License, version 3,
- * along with this program. If not, see <http://www.gnu.org/licenses/>
- *
+ * SPDX-FileCopyrightText: 2017-2024 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-FileCopyrightText: 2016 ownCloud, Inc.
+ * SPDX-License-Identifier: AGPL-3.0-only
*/
namespace OCA\Files_External\Controller;
use OCA\Files_External\Lib\StorageConfig;
+use OCA\Files_External\ResponseDefinitions;
use OCA\Files_External\Service\UserGlobalStoragesService;
use OCA\Files_External\Service\UserStoragesService;
+use OCP\AppFramework\Http;
+use OCP\AppFramework\Http\Attribute\NoAdminRequired;
+use OCP\AppFramework\Http\Attribute\OpenAPI;
use OCP\AppFramework\Http\DataResponse;
use OCP\AppFramework\OCSController;
use OCP\IRequest;
-use OCP\IUserSession;
+/**
+ * @psalm-import-type Files_ExternalMount from ResponseDefinitions
+ */
class ApiController extends OCSController {
- /** @var IUserSession */
- private $userSession;
- /** @var UserGlobalStoragesService */
- private $userGlobalStoragesService;
- /** @var UserStoragesService */
- private $userStoragesService;
+ private UserGlobalStoragesService $userGlobalStoragesService;
+ private UserStoragesService $userStoragesService;
public function __construct(
string $appName,
IRequest $request,
- IUserSession $userSession,
UserGlobalStoragesService $userGlobalStorageService,
UserStoragesService $userStorageService
) {
parent::__construct($appName, $request);
-
- $this->userSession = $userSession;
$this->userGlobalStoragesService = $userGlobalStorageService;
$this->userStoragesService = $userStorageService;
}
@@ -66,7 +45,7 @@ class ApiController extends OCSController {
* @param string $mountPoint mount point name, relative to the data dir
* @param StorageConfig $mountConfig mount config to format
*
- * @return array entry
+ * @return Files_ExternalMount
*/
private function formatMount(string $mountPoint, StorageConfig $mountConfig): array {
// split path from mount point
@@ -84,25 +63,27 @@ class ApiController extends OCSController {
}
$entry = [
+ 'id' => $mountConfig->getId(),
+ 'type' => 'dir',
'name' => basename($mountPoint),
'path' => $path,
- 'type' => 'dir',
- 'backend' => $mountConfig->getBackend()->getText(),
- 'scope' => $isSystemMount ? 'system' : 'personal',
'permissions' => $permissions,
- 'id' => $mountConfig->getId(),
+ 'scope' => $isSystemMount ? 'system' : 'personal',
+ 'backend' => $mountConfig->getBackend()->getText(),
'class' => $mountConfig->getBackend()->getIdentifier(),
+ 'config' => $mountConfig->jsonSerialize(true),
];
return $entry;
}
/**
- * @NoAdminRequired
+ * Get the mount points visible for this user
*
- * Returns the mount points visible for this user.
+ * @return DataResponse<Http::STATUS_OK, Files_ExternalMount[], array{}>
*
- * @return DataResponse share information
+ * 200: User mounts returned
*/
+ #[NoAdminRequired]
public function getUserMounts(): DataResponse {
$entries = [];
$mountPoints = [];
@@ -122,4 +103,31 @@ class ApiController extends OCSController {
return new DataResponse($entries);
}
+
+ /**
+ * Ask for credentials using a browser's native basic auth prompt
+ * Then returns it if provided
+ */
+ #[NoAdminRequired]
+ #[OpenAPI(scope: OpenAPI::SCOPE_IGNORE)]
+ public function askNativeAuth(): DataResponse {
+ if (!isset($_SERVER['PHP_AUTH_USER']) || !isset($_SERVER['PHP_AUTH_PW'])) {
+ $response = new DataResponse([], Http::STATUS_UNAUTHORIZED);
+ $response->addHeader('WWW-Authenticate', 'Basic realm="Storage authentification needed"');
+ return $response;
+ }
+
+ $user = $_SERVER['PHP_AUTH_USER'];
+ $password = $_SERVER['PHP_AUTH_PW'];
+
+ // Reset auth
+ unset($_SERVER['PHP_AUTH_USER']);
+ unset($_SERVER['PHP_AUTH_PW']);
+
+ // Using 401 again to ensure we clear any cached Authorization
+ return new DataResponse([
+ 'user' => $user,
+ 'password' => $password,
+ ], Http::STATUS_UNAUTHORIZED);
+ }
}