Store taskprocessing output files with extension to ease mimtype guessing #61689
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -928,6 +928,7 @@ | |
| 'OCP\\TaskProcessing\\Exception\\UnauthorizedException' => $baseDir . '/lib/public/TaskProcessing/Exception/UnauthorizedException.php', | ||
| 'OCP\\TaskProcessing\\Exception\\UserFacingProcessingException' => $baseDir . '/lib/public/TaskProcessing/Exception/UserFacingProcessingException.php', | ||
| 'OCP\\TaskProcessing\\Exception\\ValidationException' => $baseDir . '/lib/public/TaskProcessing/Exception/ValidationException.php', | ||
| 'OCP\\TaskProcessing\\FileShaped' => $baseDir . '/lib/public/TaskProcessing/FileShaped.php', | ||
| 'OCP\\TaskProcessing\\IInternalTaskType' => $baseDir . '/lib/public/TaskProcessing/IInternalTaskType.php', | ||
| 'OCP\\TaskProcessing\\IManager' => $baseDir . '/lib/public/TaskProcessing/IManager.php', | ||
| 'OCP\\TaskProcessing\\IProvider' => $baseDir . '/lib/public/TaskProcessing/IProvider.php', | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -969,6 +969,7 @@ class ComposerStaticInit749170dad3f5e7f9ca158f5a9f04f6a2 | |
| 'OCP\\TaskProcessing\\Exception\\UnauthorizedException' => __DIR__ . '/../../..' . '/lib/public/TaskProcessing/Exception/UnauthorizedException.php', | ||
| 'OCP\\TaskProcessing\\Exception\\UserFacingProcessingException' => __DIR__ . '/../../..' . '/lib/public/TaskProcessing/Exception/UserFacingProcessingException.php', | ||
| 'OCP\\TaskProcessing\\Exception\\ValidationException' => __DIR__ . '/../../..' . '/lib/public/TaskProcessing/Exception/ValidationException.php', | ||
| 'OCP\\TaskProcessing\\FileShaped' => __DIR__ . '/../../..' . '/lib/public/TaskProcessing/FileShaped.php', | ||
| 'OCP\\TaskProcessing\\IInternalTaskType' => __DIR__ . '/../../..' . '/lib/public/TaskProcessing/IInternalTaskType.php', | ||
| 'OCP\\TaskProcessing\\IManager' => __DIR__ . '/../../..' . '/lib/public/TaskProcessing/IManager.php', | ||
| 'OCP\\TaskProcessing\\IProvider' => __DIR__ . '/../../..' . '/lib/public/TaskProcessing/IProvider.php', | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -57,6 +57,7 @@ | |
| use OCP\TaskProcessing\Exception\UnauthorizedException; | ||
| use OCP\TaskProcessing\Exception\UserFacingProcessingException; | ||
| use OCP\TaskProcessing\Exception\ValidationException; | ||
| use OCP\TaskProcessing\FileShaped; | ||
| use OCP\TaskProcessing\IInternalTaskType; | ||
| use OCP\TaskProcessing\IManager; | ||
| use OCP\TaskProcessing\IProvider; | ||
|
|
@@ -1603,14 +1604,28 @@ public function encapsulateOutputFileData(array $output, ...$specs): array { | |
| continue; | ||
| } | ||
| if (EShapeType::getScalarType($type) === $type) { | ||
| if ($output[$key] instanceof FileShaped) { | ||
| $data = $output[$key]->getData(); | ||
| $ext = FileShaped::sanitizeExtension($output[$key]->getExtension()); | ||
| } else { | ||
| $data = $output[$key]; | ||
| $ext = ''; | ||
| } | ||
| /** @var SimpleFile $file */ | ||
| $file = $folder->newFile(time() . '-' . rand(1, 100000) . ($ext ? '.' . $ext : ''), $data); | ||
|
marcelklehr marked this conversation as resolved.
|
||
| $newOutput[$key] = $file->getId(); // polymorphic call to SimpleFile | ||
|
marcelklehr marked this conversation as resolved.
|
||
| } else { | ||
| $newOutput[$key] = []; | ||
| foreach ($output[$key] as $item) { | ||
| if ($item instanceof FileShaped) { | ||
| $data = $item->getData(); | ||
| $ext = FileShaped::sanitizeExtension($item->getExtension()); | ||
| } else { | ||
| $data = $item; | ||
| $ext = ''; | ||
| } | ||
| /** @var SimpleFile $file */ | ||
| $file = $folder->newFile(time() . '-' . rand(1, 100000) . ($ext ? '.' . $ext : ''), $data); | ||
| $newOutput[$key][] = $file->getId(); | ||
| } | ||
| } | ||
|
|
@@ -1757,7 +1772,7 @@ private function validateOutputFileIds(array $output, ...$specs): array { | |
| $newOutput[$key] = $this->validateFileId($output[$key]); | ||
| } else { | ||
| // Is list of file IDs | ||
| $newOutput[$key] = []; | ||
| foreach ($output[$key] as $item) { | ||
| $newOutput[$key][] = $this->validateFileId($item); | ||
| } | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -9,13 +9,15 @@ | |||||
|
|
||||||
| namespace OCP\TaskProcessing; | ||||||
|
|
||||||
| use OCP\AppFramework\Attribute\Consumable; | ||||||
| use OCP\TaskProcessing\Exception\ValidationException; | ||||||
|
|
||||||
| /** | ||||||
| * The input and output Shape types | ||||||
| * | ||||||
| * @since 30.0.0 | ||||||
| */ | ||||||
| #[Consumable(since: '30.0.0')] | ||||||
| enum EShapeType: int { | ||||||
| /** | ||||||
| * @since 30.0.0 | ||||||
|
|
@@ -156,28 +158,28 @@ public function validateInput(mixed $value): void { | |||||
| */ | ||||||
| public function validateOutputWithFileData(mixed $value): void { | ||||||
| $this->validateNonFileType($value); | ||||||
| if ($this === EShapeType::Image && !is_string($value) && !($value instanceof FileShaped && $value->getShapeType() === EShapeType::Image)) { | ||||||
| throw new ValidationException('Non-image item provided for Image slot'); | ||||||
| } | ||||||
| if ($this === EShapeType::ListOfImages && (!is_array($value) || count(array_filter($value, fn ($item) => !is_string($item) && !($item instanceof FileShaped && $item->getShapeType() === EShapeType::Image))) > 0)) { | ||||||
|
Comment on lines
-159
to
+164
Contributor
There was a problem hiding this comment. maybe it would be nice to exact these checks in functions with separate something along these lines but feel free to do it your way: /**
* Check whether a single value is valid file output data for the given shape type.
* Accepts raw string data or a FileShaped wrapper whose shape type matches.
*/
private static function isValidFileData(mixed $value, EShapeType $expected): bool {
if (is_string($value)) {
return true;
}
return $value instanceof FileShaped && $value->getShapeType() === $expected;
}
/**
* Check whether a value is a valid list of file output data items.
*/
private static function isValidFileDataList(mixed $value, EShapeType $scalarType): bool {
if (!is_array($value)) {
return false;
}
foreach ($value as $item) {
if (!self::isValidFileData($item, $scalarType)) {
return false;
}
}
return true;
}and can be used like: if ($this === EShapeType::Image && !self::isValidFileData($value, EShapeType::Image)) {
throw new ValidationException('Non-image item provided for Image slot');
} |
||||||
| throw new ValidationException('Non-image list item provided for ListOfImages slot'); | ||||||
| } | ||||||
| if ($this === EShapeType::Audio && !is_string($value) && !($value instanceof FileShaped && $value->getShapeType() === EShapeType::Audio)) { | ||||||
| throw new ValidationException('Non-audio item provided for Audio slot'); | ||||||
| } | ||||||
| if ($this === EShapeType::ListOfAudios && (!is_array($value) || count(array_filter($value, fn ($item) => !is_string($item) && !($item instanceof FileShaped && $item->getShapeType() === EShapeType::Audio))) > 0)) { | ||||||
| throw new ValidationException('Non-audio list item provided for ListOfAudio slot'); | ||||||
| } | ||||||
| if ($this === EShapeType::Video && !is_string($value) && !($value instanceof FileShaped && $value->getShapeType() === EShapeType::Video)) { | ||||||
| throw new ValidationException('Non-video item provided for Video slot'); | ||||||
| } | ||||||
| if ($this === EShapeType::ListOfVideos && (!is_array($value) || count(array_filter($value, fn ($item) => !is_string($item) && !($item instanceof FileShaped && $item->getShapeType() === EShapeType::Video))) > 0)) { | ||||||
| throw new ValidationException('Non-video list item provided for ListOfVideos slot'); | ||||||
| } | ||||||
| if ($this === EShapeType::File && !is_string($value) && !($value instanceof FileShaped && $value->getShapeType() === EShapeType::File)) { | ||||||
| throw new ValidationException('Non-file item provided for File slot'); | ||||||
| } | ||||||
| if ($this === EShapeType::ListOfFiles && (!is_array($value) || count(array_filter($value, fn ($item) => !is_string($item) && !($item instanceof FileShaped && $item->getShapeType() === EShapeType::File))) > 0)) { | ||||||
| throw new ValidationException('Non-audio list item provided for ListOfFiles slot'); | ||||||
|
Contributor
There was a problem hiding this comment.
Suggested change
|
||||||
| } | ||||||
| } | ||||||
|
|
||||||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,69 @@ | ||
| <?php | ||
|
|
||
| /** | ||
| * SPDX-FileCopyrightText: 2026 Nextcloud GmbH and Nextcloud contributors | ||
| * SPDX-License-Identifier: AGPL-3.0-or-later | ||
| */ | ||
|
|
||
| namespace OCP\TaskProcessing; | ||
|
|
||
| use OCP\AppFramework\Attribute\Consumable; | ||
|
|
||
| /** | ||
| * Data object for file-shaped output entries | ||
| * | ||
| * @since 35.0.0 | ||
| */ | ||
| #[Consumable(since: '35.0.0')] | ||
|
marcelklehr marked this conversation as resolved.
|
||
| final class FileShaped { | ||
| /** | ||
| * @param EShapeType $shapeType | ||
| * @param string $data | ||
| * @param string $extension (optional) | ||
| * | ||
| * @since 35.0.0 | ||
| */ | ||
| public function __construct( | ||
| private EShapeType $shapeType, | ||
| private string $data, | ||
| private string $extension = '', | ||
| ) { | ||
| $this->extension = self::sanitizeExtension($this->extension); | ||
| } | ||
|
|
||
| /** | ||
| * @return string | ||
| * @since 35.0.0 | ||
| */ | ||
| public function getData(): string { | ||
| return $this->data; | ||
| } | ||
|
|
||
| /** | ||
| * @since 35.0.0 | ||
| */ | ||
| public function getShapeType(): EShapeType { | ||
| return $this->shapeType; | ||
| } | ||
|
|
||
| /** | ||
| * @since 35.0.0 | ||
| */ | ||
| public function getExtension(): string { | ||
| return $this->extension; | ||
| } | ||
|
|
||
| /** | ||
| * @since 35.0.0 | ||
| */ | ||
| public static function sanitizeExtension(string $ext): string { | ||
|
Contributor
There was a problem hiding this comment. the extension provider is within the trust boundary of ex-apps and php apps but it may not hurt to reject |
||
| if ($ext === '') { | ||
| return ''; | ||
| } | ||
| $ext = str_replace(['.', '/'], '', $ext); | ||
|
marcelklehr marked this conversation as resolved.
|
||
| $ext = preg_replace('/[^A-Za-z0-9]/', '', $ext) ?? $ext; | ||
| $ext = strtolower($ext); | ||
| $ext = substr($ext, 0, 16); | ||
| return $ext; | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -9,11 +9,15 @@ | |
|
|
||
| namespace OCP\TaskProcessing; | ||
|
|
||
| use OCP\AppFramework\Attribute\Implementable; | ||
|
|
||
| /** | ||
| * This is a task type interface that is implemented by task processing | ||
| * task types that should not show up in the assistant UI | ||
| * | ||
| * @since 33.0.0 | ||
| */ | ||
| #[Implementable(since: '33.0.0')] | ||
| interface IInternalTaskType extends ITaskType { | ||
|
|
||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -9,11 +9,15 @@ | |
|
|
||
| namespace OCP\TaskProcessing; | ||
|
|
||
| use OCP\AppFramework\Attribute\Implementable; | ||
|
|
||
| /** | ||
| * This is the interface that is implemented by apps that | ||
| * implement a task processing provider | ||
| * | ||
| * @since 30.0.0 | ||
| */ | ||
| #[Implementable(since: '30.0.0')] | ||
| interface IProvider { | ||
| /** | ||
| * The unique id of this provider | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -9,6 +9,7 @@ | |
|
|
||
| namespace OCP\TaskProcessing; | ||
|
|
||
| use OCP\AppFramework\Attribute\Implementable; | ||
| use OCP\Files\File; | ||
| use OCP\TaskProcessing\Exception\ProcessingException; | ||
|
|
||
|
|
@@ -17,6 +18,7 @@ | |
| * implement a task processing provider | ||
| * @since 35.0.0 | ||
| */ | ||
| #[Implementable(since: '35.0.0')] | ||
| interface ISynchronousOptionsAwareProvider extends ISynchronousProvider { | ||
|
|
||
| /** | ||
|
|
@@ -26,7 +28,7 @@ interface ISynchronousOptionsAwareProvider extends ISynchronousProvider { | |
| * @param array<string, list<numeric|string|File>|numeric|string|File> $input The task input | ||
| * @param callable(float):bool $reportProgress Report the task progress. If this returns false, that means the task was cancelled and processing should be stopped. | ||
| * @param SynchronousProviderOptions $options The task options | ||
| * @psalm-return array<string, list<numeric|string|FileShaped>|numeric|string|FileShaped> | ||
| * @throws ProcessingException | ||
| * @since 35.0.0 | ||
| */ | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -9,6 +9,7 @@ | |
|
|
||
| namespace OCP\TaskProcessing; | ||
|
|
||
| use OCP\AppFramework\Attribute\Implementable; | ||
| use OCP\Files\File; | ||
| use OCP\TaskProcessing\Exception\ProcessingException; | ||
|
|
||
|
|
@@ -17,6 +18,7 @@ | |
| * implement a task processing provider | ||
| * @since 30.0.0 | ||
| */ | ||
| #[Implementable(since: '30.0.0')] | ||
| interface ISynchronousProvider extends IProvider { | ||
|
|
||
| /** | ||
|
|
@@ -25,7 +27,7 @@ interface ISynchronousProvider extends IProvider { | |
| * @param null|string $userId The user that created the current task | ||
| * @param array<string, list<numeric|string|File>|numeric|string|File> $input The task input | ||
| * @param callable(float):bool $reportProgress Report the task progress. If this returns false, that means the task was cancelled and processing should be stopped. | ||
| * @psalm-return array<string, list<numeric|string|FileShaped>|numeric|string|FileShaped> | ||
|
Comment on lines
-28
to
+30
Contributor
There was a problem hiding this comment. maybe it can be noted that |
||
| * @throws ProcessingException | ||
| * @since 30.0.0 | ||
| */ | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -9,11 +9,15 @@ | |
|
|
||
| namespace OCP\TaskProcessing; | ||
|
|
||
| use OCP\AppFramework\Attribute\Implementable; | ||
|
|
||
| /** | ||
| * This is a task type interface that is implemented by task processing | ||
| * task types | ||
| * | ||
| * @since 30.0.0 | ||
| */ | ||
| #[Implementable(since: '30.0.0')] | ||
| interface ITaskType { | ||
| /** | ||
| * Returns the unique id of this task type | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -9,11 +9,15 @@ | |
|
|
||
| namespace OCP\TaskProcessing; | ||
|
|
||
| use OCP\AppFramework\Attribute\Implementable; | ||
|
|
||
| /** | ||
| * This is the interface that is implemented by apps that | ||
| * implement a task processing provider with support for being triggered | ||
| * | ||
| * @since 33.0.0 | ||
| */ | ||
| #[Implementable(since: '33.0.0')] | ||
| interface ITriggerableProvider extends IProvider { | ||
|
|
||
| /** | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -7,10 +7,14 @@ | |
|
|
||
| namespace OCP\TaskProcessing; | ||
|
|
||
| use OCP\AppFramework\Attribute\Consumable; | ||
|
|
||
| /** | ||
| * Data object for input output shape entries | ||
| * | ||
| * @since 30.0.0 | ||
| */ | ||
| #[Consumable(since: '30.0.0')] | ||
| class ShapeDescriptor implements \JsonSerializable { | ||
| /** | ||
| * @param string $name | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -7,10 +7,14 @@ | |
|
|
||
| namespace OCP\TaskProcessing; | ||
|
|
||
| use OCP\AppFramework\Attribute\Consumable; | ||
|
|
||
| /** | ||
| * Data object for input output shape enum slot value | ||
| * | ||
| * @since 30.0.0 | ||
| */ | ||
| #[Consumable(since: '30.0.0')] | ||
| class ShapeEnumValue implements \JsonSerializable { | ||
| /** | ||
| * @param string $name | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -7,9 +7,12 @@ | |
|
|
||
| namespace OCP\TaskProcessing; | ||
|
|
||
| use OCP\AppFramework\Attribute\Consumable; | ||
|
|
||
| /** | ||
| * @since 35.0.0 | ||
| */ | ||
| #[Consumable(since: '35.0.0')] | ||
| class SynchronousProviderOptions { | ||
| private \Closure $reportIntermediateOutput; | ||
|
|
||
|
|
||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.