\wcf\event\endpoint\ControllerCollecting::class,
static function (\wcf\event\endpoint\ControllerCollecting $event) {
$event->register(new \wcf\system\endpoint\controller\core\files\DeleteFile);
- $event->register(new \wcf\system\endpoint\controller\core\files\PostGenerateThumbnails);
- $event->register(new \wcf\system\endpoint\controller\core\files\PostUpload);
- $event->register(new \wcf\system\endpoint\controller\core\files\upload\PostChunk);
+ $event->register(new \wcf\system\endpoint\controller\core\files\GenerateThumbnails);
+ $event->register(new \wcf\system\endpoint\controller\core\files\PrepareUpload);
+ $event->register(new \wcf\system\endpoint\controller\core\files\upload\SaveChunk);
$event->register(new \wcf\system\endpoint\controller\core\comments\CreateComment);
$event->register(new \wcf\system\endpoint\controller\core\comments\DeleteComment);
$event->register(new \wcf\system\endpoint\controller\core\comments\EditComment);
--- /dev/null
+<?php
+
+namespace wcf\system\endpoint\controller\core\files;
+
+use Laminas\Diactoros\Response\JsonResponse;
+use Psr\Http\Message\ServerRequestInterface;
+use Psr\Http\Message\ResponseInterface;
+use wcf\data\file\File;
+use wcf\data\file\thumbnail\FileThumbnailList;
+use wcf\http\Helper;
+use wcf\system\endpoint\IController;
+use wcf\system\endpoint\PostRequest;
+use wcf\system\file\processor\FileProcessor;
+
+#[PostRequest('/core/files/{id:\d+}/generatethumbnails')]
+final class GenerateThumbnails implements IController
+{
+ public function __invoke(ServerRequestInterface $request, array $variables): ResponseInterface
+ {
+ $file = Helper::fetchObjectFromRequestParameter($variables['id'], File::class);
+
+ FileProcessor::getInstance()->generateWebpVariant($file);
+ FileProcessor::getInstance()->generateThumbnails($file);
+
+ $thumbnails = [];
+ foreach ($this->getThumbnails($file) as $thumbnail) {
+ $thumbnails[] = [
+ 'identifier' => $thumbnail->identifier,
+ 'link' => $thumbnail->getLink(),
+ ];
+ }
+
+ return new JsonResponse($thumbnails);
+ }
+
+ /**
+ * @return FileThumbnail[]
+ */
+ private function getThumbnails(File $file): array
+ {
+ $thumbnailList = new FileThumbnailList();
+ $thumbnailList->getConditionBuilder()->add("fileID = ?", [$file->fileID]);
+ $thumbnailList->readObjects();
+
+ return $thumbnailList->getObjects();
+ }
+}
+++ /dev/null
-<?php
-
-namespace wcf\system\endpoint\controller\core\files;
-
-use Laminas\Diactoros\Response\JsonResponse;
-use Psr\Http\Message\ServerRequestInterface;
-use Psr\Http\Message\ResponseInterface;
-use wcf\data\file\File;
-use wcf\data\file\thumbnail\FileThumbnailList;
-use wcf\http\Helper;
-use wcf\system\endpoint\IController;
-use wcf\system\endpoint\PostRequest;
-use wcf\system\exception\UserInputException;
-use wcf\system\file\processor\FileProcessor;
-
-#[PostRequest('/core/files/{id:\d+}/generatethumbnails')]
-final class PostGenerateThumbnails implements IController
-{
- public function __invoke(ServerRequestInterface $request, array $variables): ResponseInterface
- {
- $file = Helper::fetchObjectFromRequestParameter($variables['id'], File::class);
-
- FileProcessor::getInstance()->generateWebpVariant($file);
- FileProcessor::getInstance()->generateThumbnails($file);
-
- $thumbnails = [];
- foreach ($this->getThumbnails($file) as $thumbnail) {
- $thumbnails[] = [
- 'identifier' => $thumbnail->identifier,
- 'link' => $thumbnail->getLink(),
- ];
- }
-
- return new JsonResponse($thumbnails);
- }
-
- /**
- * @return FileThumbnail[]
- */
- private function getThumbnails(File $file): array
- {
- $thumbnailList = new FileThumbnailList();
- $thumbnailList->getConditionBuilder()->add("fileID = ?", [$file->fileID]);
- $thumbnailList->readObjects();
-
- return $thumbnailList->getObjects();
- }
-}
+++ /dev/null
-<?php
-
-namespace wcf\system\endpoint\controller\core\files;
-
-use Laminas\Diactoros\Response\JsonResponse;
-use Psr\Http\Message\ServerRequestInterface;
-use Psr\Http\Message\ResponseInterface;
-use wcf\data\file\temporary\FileTemporary;
-use wcf\data\file\temporary\FileTemporaryAction;
-use wcf\http\Helper;
-use wcf\system\endpoint\IController;
-use wcf\system\endpoint\PostRequest;
-use wcf\system\exception\PermissionDeniedException;
-use wcf\system\exception\SystemException;
-use wcf\system\exception\UserInputException;
-use wcf\system\file\processor\FileProcessor;
-use wcf\system\file\processor\FileProcessorPreflightResult;
-use wcf\util\JSON;
-
-#[PostRequest('/core/files/upload')]
-final class PostUpload implements IController
-{
- public function __invoke(ServerRequestInterface $request, array $variables): ResponseInterface
- {
- $parameters = Helper::mapApiParameters($request, PostUploadParameters::class);
-
- $fileProcessor = FileProcessor::getInstance()->getProcessorByName($parameters->objectType);
- if ($fileProcessor === null) {
- throw new UserInputException('objectType', 'unknown');
- }
-
- try {
- $decodedContext = JSON::decode($parameters->context);
- } catch (SystemException) {
- throw new UserInputException('context', 'invalid');
- }
-
- if ($parameters->fileSize > FileProcessor::getInstance()->getMaximumFileSize()) {
- throw new UserInputException('fileSize', 'tooLarge');
- }
-
- // Check if the maximum number of accepted files has already been uploaded.
- if (FileProcessor::getInstance()->hasReachedUploadLimit($fileProcessor, $decodedContext)) {
- throw new UserInputException('preflight', 'tooManyFiles');
- }
-
- $validationResult = $fileProcessor->acceptUpload($parameters->filename, $parameters->fileSize, $decodedContext);
- if (!$validationResult->ok()) {
- match ($validationResult) {
- FileProcessorPreflightResult::InsufficientPermissions => throw new PermissionDeniedException(),
- FileProcessorPreflightResult::InvalidContext => throw new UserInputException('context', 'invalid'),
- default => throw new UserInputException('preflight', $validationResult->toString()),
- };
- }
-
- $numberOfChunks = FileTemporary::getNumberOfChunks($parameters->fileSize);
- $fileTemporary = $this->createTemporaryFile($parameters, $numberOfChunks);
-
- return new JsonResponse([
- 'identifier' => $fileTemporary->identifier,
- 'numberOfChunks' => $numberOfChunks,
- ]);
- }
-
- private function createTemporaryFile(PostUploadParameters $parameters, int $numberOfChunks): FileTemporary
- {
- $identifier = \bin2hex(\random_bytes(20));
- $objectType = FileProcessor::getInstance()->getObjectType($parameters->objectType);
-
- $action = new FileTemporaryAction([], 'create', [
- 'data' => [
- 'identifier' => $identifier,
- 'time' => \TIME_NOW,
- 'filename' => $parameters->filename,
- 'fileSize' => $parameters->fileSize,
- 'fileHash' => $parameters->fileHash,
- 'objectTypeID' => $objectType?->objectTypeID,
- 'context' => $parameters->context,
- 'chunks' => \str_repeat('0', $numberOfChunks),
- ],
- ]);
-
- return $action->executeAction()['returnValues'];
- }
-}
-
-/** @internal */
-final class PostUploadParameters
-{
- public function __construct(
- /** @var non-empty-string */
- public readonly string $filename,
-
- /** @var positive-int **/
- public readonly int $fileSize,
-
- /** @var non-empty-string */
- public readonly string $fileHash,
-
- /** @var non-empty-string */
- public readonly string $objectType,
-
- /** @var non-empty-string */
- public readonly string $context,
- ) {
- }
-}
--- /dev/null
+<?php
+
+namespace wcf\system\endpoint\controller\core\files;
+
+use Laminas\Diactoros\Response\JsonResponse;
+use Psr\Http\Message\ServerRequestInterface;
+use Psr\Http\Message\ResponseInterface;
+use wcf\data\file\temporary\FileTemporary;
+use wcf\data\file\temporary\FileTemporaryAction;
+use wcf\http\Helper;
+use wcf\system\endpoint\IController;
+use wcf\system\endpoint\PostRequest;
+use wcf\system\exception\PermissionDeniedException;
+use wcf\system\exception\SystemException;
+use wcf\system\exception\UserInputException;
+use wcf\system\file\processor\FileProcessor;
+use wcf\system\file\processor\FileProcessorPreflightResult;
+use wcf\util\JSON;
+
+#[PostRequest('/core/files/upload')]
+final class PrepareUpload implements IController
+{
+ public function __invoke(ServerRequestInterface $request, array $variables): ResponseInterface
+ {
+ $parameters = Helper::mapApiParameters($request, PostUploadParameters::class);
+
+ $fileProcessor = FileProcessor::getInstance()->getProcessorByName($parameters->objectType);
+ if ($fileProcessor === null) {
+ throw new UserInputException('objectType', 'unknown');
+ }
+
+ try {
+ $decodedContext = JSON::decode($parameters->context);
+ } catch (SystemException) {
+ throw new UserInputException('context', 'invalid');
+ }
+
+ if ($parameters->fileSize > FileProcessor::getInstance()->getMaximumFileSize()) {
+ throw new UserInputException('fileSize', 'tooLarge');
+ }
+
+ // Check if the maximum number of accepted files has already been uploaded.
+ if (FileProcessor::getInstance()->hasReachedUploadLimit($fileProcessor, $decodedContext)) {
+ throw new UserInputException('preflight', 'tooManyFiles');
+ }
+
+ $validationResult = $fileProcessor->acceptUpload($parameters->filename, $parameters->fileSize, $decodedContext);
+ if (!$validationResult->ok()) {
+ match ($validationResult) {
+ FileProcessorPreflightResult::InsufficientPermissions => throw new PermissionDeniedException(),
+ FileProcessorPreflightResult::InvalidContext => throw new UserInputException('context', 'invalid'),
+ default => throw new UserInputException('preflight', $validationResult->toString()),
+ };
+ }
+
+ $numberOfChunks = FileTemporary::getNumberOfChunks($parameters->fileSize);
+ $fileTemporary = $this->createTemporaryFile($parameters, $numberOfChunks);
+
+ return new JsonResponse([
+ 'identifier' => $fileTemporary->identifier,
+ 'numberOfChunks' => $numberOfChunks,
+ ]);
+ }
+
+ private function createTemporaryFile(PostUploadParameters $parameters, int $numberOfChunks): FileTemporary
+ {
+ $identifier = \bin2hex(\random_bytes(20));
+ $objectType = FileProcessor::getInstance()->getObjectType($parameters->objectType);
+
+ $action = new FileTemporaryAction([], 'create', [
+ 'data' => [
+ 'identifier' => $identifier,
+ 'time' => \TIME_NOW,
+ 'filename' => $parameters->filename,
+ 'fileSize' => $parameters->fileSize,
+ 'fileHash' => $parameters->fileHash,
+ 'objectTypeID' => $objectType?->objectTypeID,
+ 'context' => $parameters->context,
+ 'chunks' => \str_repeat('0', $numberOfChunks),
+ ],
+ ]);
+
+ return $action->executeAction()['returnValues'];
+ }
+}
+
+/** @internal */
+final class PostUploadParameters
+{
+ public function __construct(
+ /** @var non-empty-string */
+ public readonly string $filename,
+
+ /** @var positive-int **/
+ public readonly int $fileSize,
+
+ /** @var non-empty-string */
+ public readonly string $fileHash,
+
+ /** @var non-empty-string */
+ public readonly string $objectType,
+
+ /** @var non-empty-string */
+ public readonly string $context,
+ ) {
+ }
+}
+++ /dev/null
-<?php
-
-namespace wcf\system\endpoint\controller\core\files\upload;
-
-use Laminas\Diactoros\Response\JsonResponse;
-use Psr\Http\Message\ServerRequestInterface;
-use Psr\Http\Message\ResponseInterface;
-use wcf\data\file\FileEditor;
-use wcf\data\file\temporary\FileTemporary;
-use wcf\data\file\temporary\FileTemporaryEditor;
-use wcf\http\Helper;
-use wcf\system\endpoint\IController;
-use wcf\system\endpoint\PostRequest;
-use wcf\system\exception\UserInputException;
-use wcf\system\io\File;
-
-#[PostRequest('/core/files/upload/{identifier}/chunk/{sequenceNo:\d+}')]
-final class PostChunk implements IController
-{
- /**
- * Read data in chunks to avoid hitting the memory limit.
- * See https://stackoverflow.com/a/61997147
- */
- private const FREAD_BUFFER_SIZE = 10 * 1_024 * 1_024;
-
- public function __invoke(ServerRequestInterface $request, array $variables): ResponseInterface
- {
- $fileTemporary = Helper::fetchObjectFromRequestParameter($variables['identifier'], FileTemporary::class);
-
- $checksum = $request->getHeaderLine('chunk-checksum-sha256');
- if ($checksum === '' || \str_contains($checksum, ',')) {
- // Reject a missing header of multiple values provided by the client.
- throw new UserInputException('chunk-checksum-sha256');
- }
-
- $sequenceNo = $variables['sequenceNo'];
-
- // Check if this is a valid sequence no.
- if ($sequenceNo >= $fileTemporary->getChunkCount()) {
- throw new UserInputException('sequenceNo', 'outOfRange');
- }
-
- // Check if this chunk has already been written.
- if ($fileTemporary->hasChunk($sequenceNo)) {
- throw new UserInputException('sequenceNo', 'alreadyExists');
- }
-
- // Validate the chunk size.
- $chunkSize = $fileTemporary->getChunkSize();
- $stream = $request->getBody();
- $receivedSize = $stream->getSize();
- if ($receivedSize !== null && $receivedSize > $chunkSize) {
- throw new UserInputException('payload', 'tooLarge');
- }
-
- $tmpPath = $fileTemporary->getPath();
- if (!\is_dir($tmpPath)) {
- \mkdir($tmpPath, recursive: true);
- }
-
- $file = new File($tmpPath . $fileTemporary->getFilename(), 'cb+');
- $file->lock(\LOCK_EX);
- $file->seek($sequenceNo * $chunkSize);
-
- // Check if the checksum matches the received data.
- $ctx = \hash_init('sha256');
- $total = 0;
- while (!$stream->eof()) {
- // Write the chunk using a buffer to avoid blowing up the memory limit.
- // See https://stackoverflow.com/a/61997147
- $chunk = $stream->read(self::FREAD_BUFFER_SIZE);
- $total += \strlen($chunk);
-
- if ($total > $chunkSize) {
- throw new UserInputException('file', 'exceedsFileSize');
- }
-
- \hash_update($ctx, $chunk);
- $file->write($chunk);
- }
- $file->sync();
- $file->close();
-
- $result = \hash_final($ctx);
-
- if ($result !== $checksum) {
- throw new UserInputException('payload', 'checksum');
- }
-
- // Mark the chunk as written.
- $chunks = $fileTemporary->chunks;
- $chunks[$sequenceNo] = '1';
- (new FileTemporaryEditor($fileTemporary))->update([
- 'chunks' => $chunks,
- ]);
-
- // Check if we have all chunks.
- if ($chunks === \str_repeat('1', $fileTemporary->getChunkCount())) {
- // Check if the final result matches the expected checksum.
- $checksum = \hash_file('sha256', $tmpPath . $fileTemporary->getFilename());
- if ($checksum !== $fileTemporary->fileHash) {
- throw new UserInputException('file', 'checksum');
- }
-
- $file = FileEditor::createFromTemporary($fileTemporary);
-
- $context = $fileTemporary->getContext();
- (new FileTemporaryEditor($fileTemporary))->delete();
- unset($fileTemporary);
-
- $processor = $file->getProcessor();
- $processor?->adopt($file, $context);
-
- $generateThumbnails = false;
- if ($processor !== null && $file->isImage()) {
- $thumbnailFormats = $processor->getThumbnailFormats();
- if ($thumbnailFormats !== []) {
- $generateThumbnails = true;
- }
- }
-
- $data = [];
- if ($processor !== null) {
- $data = $processor->getUploadResponse($file);
- }
-
- return new JsonResponse([
- 'completed' => true,
- 'generateThumbnails' => $generateThumbnails,
- 'fileID' => $file->fileID,
- 'objectTypeID' => $file->objectTypeID,
- 'mimeType' => $file->mimeType,
- 'link' => $file->getLink(),
- 'data' => $data,
- ]);
- }
-
- return new JsonResponse([
- 'completed' => false,
- ]);
- }
-}
--- /dev/null
+<?php
+
+namespace wcf\system\endpoint\controller\core\files\upload;
+
+use Laminas\Diactoros\Response\JsonResponse;
+use Psr\Http\Message\ServerRequestInterface;
+use Psr\Http\Message\ResponseInterface;
+use wcf\data\file\FileEditor;
+use wcf\data\file\temporary\FileTemporary;
+use wcf\data\file\temporary\FileTemporaryEditor;
+use wcf\http\Helper;
+use wcf\system\endpoint\IController;
+use wcf\system\endpoint\PostRequest;
+use wcf\system\exception\UserInputException;
+use wcf\system\io\File;
+
+#[PostRequest('/core/files/upload/{identifier}/chunk/{sequenceNo:\d+}')]
+final class SaveChunk implements IController
+{
+ /**
+ * Read data in chunks to avoid hitting the memory limit.
+ * See https://stackoverflow.com/a/61997147
+ */
+ private const FREAD_BUFFER_SIZE = 10 * 1_024 * 1_024;
+
+ public function __invoke(ServerRequestInterface $request, array $variables): ResponseInterface
+ {
+ $fileTemporary = Helper::fetchObjectFromRequestParameter($variables['identifier'], FileTemporary::class);
+
+ $checksum = $request->getHeaderLine('chunk-checksum-sha256');
+ if ($checksum === '' || \str_contains($checksum, ',')) {
+ // Reject a missing header of multiple values provided by the client.
+ throw new UserInputException('chunk-checksum-sha256');
+ }
+
+ $sequenceNo = $variables['sequenceNo'];
+
+ // Check if this is a valid sequence no.
+ if ($sequenceNo >= $fileTemporary->getChunkCount()) {
+ throw new UserInputException('sequenceNo', 'outOfRange');
+ }
+
+ // Check if this chunk has already been written.
+ if ($fileTemporary->hasChunk($sequenceNo)) {
+ throw new UserInputException('sequenceNo', 'alreadyExists');
+ }
+
+ // Validate the chunk size.
+ $chunkSize = $fileTemporary->getChunkSize();
+ $stream = $request->getBody();
+ $receivedSize = $stream->getSize();
+ if ($receivedSize !== null && $receivedSize > $chunkSize) {
+ throw new UserInputException('payload', 'tooLarge');
+ }
+
+ $tmpPath = $fileTemporary->getPath();
+ if (!\is_dir($tmpPath)) {
+ \mkdir($tmpPath, recursive: true);
+ }
+
+ $file = new File($tmpPath . $fileTemporary->getFilename(), 'cb+');
+ $file->lock(\LOCK_EX);
+ $file->seek($sequenceNo * $chunkSize);
+
+ // Check if the checksum matches the received data.
+ $ctx = \hash_init('sha256');
+ $total = 0;
+ while (!$stream->eof()) {
+ // Write the chunk using a buffer to avoid blowing up the memory limit.
+ // See https://stackoverflow.com/a/61997147
+ $chunk = $stream->read(self::FREAD_BUFFER_SIZE);
+ $total += \strlen($chunk);
+
+ if ($total > $chunkSize) {
+ throw new UserInputException('file', 'exceedsFileSize');
+ }
+
+ \hash_update($ctx, $chunk);
+ $file->write($chunk);
+ }
+ $file->sync();
+ $file->close();
+
+ $result = \hash_final($ctx);
+
+ if ($result !== $checksum) {
+ throw new UserInputException('payload', 'checksum');
+ }
+
+ // Mark the chunk as written.
+ $chunks = $fileTemporary->chunks;
+ $chunks[$sequenceNo] = '1';
+ (new FileTemporaryEditor($fileTemporary))->update([
+ 'chunks' => $chunks,
+ ]);
+
+ // Check if we have all chunks.
+ if ($chunks === \str_repeat('1', $fileTemporary->getChunkCount())) {
+ // Check if the final result matches the expected checksum.
+ $checksum = \hash_file('sha256', $tmpPath . $fileTemporary->getFilename());
+ if ($checksum !== $fileTemporary->fileHash) {
+ throw new UserInputException('file', 'checksum');
+ }
+
+ $file = FileEditor::createFromTemporary($fileTemporary);
+
+ $context = $fileTemporary->getContext();
+ (new FileTemporaryEditor($fileTemporary))->delete();
+ unset($fileTemporary);
+
+ $processor = $file->getProcessor();
+ $processor?->adopt($file, $context);
+
+ $generateThumbnails = false;
+ if ($processor !== null && $file->isImage()) {
+ $thumbnailFormats = $processor->getThumbnailFormats();
+ if ($thumbnailFormats !== []) {
+ $generateThumbnails = true;
+ }
+ }
+
+ $data = [];
+ if ($processor !== null) {
+ $data = $processor->getUploadResponse($file);
+ }
+
+ return new JsonResponse([
+ 'completed' => true,
+ 'generateThumbnails' => $generateThumbnails,
+ 'fileID' => $file->fileID,
+ 'objectTypeID' => $file->objectTypeID,
+ 'mimeType' => $file->mimeType,
+ 'link' => $file->getLink(),
+ 'data' => $data,
+ ]);
+ }
+
+ return new JsonResponse([
+ 'completed' => false,
+ ]);
+ }
+}
projects / GitHub / WoltLab / WCF.git / commitdiff