Capabilities.php

<?php

/**
 * SPDX-FileCopyrightText: 2016-2024 Nextcloud GmbH and Nextcloud contributors
 * SPDX-FileCopyrightText: 2016 ownCloud, Inc.
 * SPDX-License-Identifier: AGPL-3.0-only
 */
namespace OCA\Files;

use OC\Files\FilenameValidator;
use OCA\Files\Controller\ResumableUploadController;
use OCA\Files\Service\ChunkedUploadConfig;
use OCP\Capabilities\ICapability;
use OCP\Files\Conversion\ConversionMimeProvider;
use OCP\Files\Conversion\IConversionManager;

class Capabilities implements ICapability {

	public function __construct(
		protected FilenameValidator $filenameValidator,
		protected IConversionManager $fileConversionManager,
	) {
	}

	/**
	 * Return this classes capabilities
	 *
	 * @return array{
	 *     files: array{
	 *         '$comment': ?string,
	 *         bigfilechunking: bool,
	 *         blacklisted_files: list<mixed>,
	 *         forbidden_filenames: list<string>,
	 *         forbidden_filename_basenames: list<string>,
	 *         forbidden_filename_characters: list<string>,
	 *         forbidden_filename_extensions: list<string>,
	 *         chunked_upload: array{
	 *             max_size: int,
	 *             max_parallel_count: int,
	 *         },
	 *         file_conversions: list<array{
	 *             from: string,
	 *             to: string,
	 *             extension: string,
	 *             displayName: string,
	 *         }>,
	 *         resumable_upload: array{
	 *             supported: bool,
	 *             interop_version: string,
	 *         }
	 *     }
	 * }
	 */
	public function getCapabilities(): array {
		return [
			'files' => [
				'$comment' => '"blacklisted_files" is deprecated as of Nextcloud 30, use "forbidden_filenames" instead',
				'blacklisted_files' => $this->filenameValidator->getForbiddenFilenames(),
				'forbidden_filenames' => $this->filenameValidator->getForbiddenFilenames(),
				'forbidden_filename_basenames' => $this->filenameValidator->getForbiddenBasenames(),
				'forbidden_filename_characters' => $this->filenameValidator->getForbiddenCharacters(),
				'forbidden_filename_extensions' => $this->filenameValidator->getForbiddenExtensions(),

				'bigfilechunking' => true,
				'chunked_upload' => [
					'max_size' => ChunkedUploadConfig::getMaxChunkSize(),
					'max_parallel_count' => ChunkedUploadConfig::getMaxParallelCount(),
				],
				'file_conversions' => array_map(function (ConversionMimeProvider $mimeProvider) {
					return $mimeProvider->jsonSerialize();
				}, $this->fileConversionManager->getProviders()),
				// https://datatracker.ietf.org/doc/html/draft-ietf-httpbis-resumable-upload-05#section-4.1-3
				'resumable_upload' => [
					'supported' => true,
					'interop_version' => ResumableUploadController::UPLOAD_DRAFT_INTEROP_VERSION,
				],
			],
		];
	}
}