Same name in other branches

1. 9 core/modules/file/src/Plugin/rest/resource/FileUploadResource.php \Drupal\file\Plugin\rest\resource\FileUploadResource::post()
2. 8.9.x core/modules/file/src/Plugin/rest/resource/FileUploadResource.php \Drupal\file\Plugin\rest\resource\FileUploadResource::post()
3. 11.x core/modules/file/src/Plugin/rest/resource/FileUploadResource.php \Drupal\file\Plugin\rest\resource\FileUploadResource::post()

Creates a file from an endpoint.

Parameters

\Symfony\Component\HttpFoundation\Request $request: The current request.

string $entity_type_id: The entity type ID.

string $bundle: The entity bundle. This will be the same as $entity_type_id for entity types that don't support bundles.

string $field_name: The field name.

Return value

\Drupal\rest\ModifiedResourceResponse A 201 response, on success.

Throws

\Symfony\Component\HttpKernel\Exception\HttpException Thrown when temporary files cannot be written, a lock cannot be acquired, or when temporary files cannot be moved to their new location.

File

core/modules/file/src/Plugin/rest/resource/FileUploadResource.php, line 190

Class

FileUploadResource

File upload resource.

Namespace

Drupal\file\Plugin\rest\resource

Code

public function post(Request $request, $entity_type_id, $bundle, $field_name) {
    $field_definition = $this->validateAndLoadFieldDefinition($entity_type_id, $bundle, $field_name);
    $destination = $this->getUploadDestination($field_definition);
    // Check the destination file path is writable.
    if (!$this->fileSystem
        ->prepareDirectory($destination, FileSystemInterface::CREATE_DIRECTORY)) {
        throw new HttpException(500, 'Destination file path is not writable');
    }
    $settings = $field_definition->getSettings();
    $validators = $this->getFileUploadValidators($settings);
    if (!array_key_exists('FileExtension', $validators) && $settings['file_extensions'] === '') {
        // An empty string means 'all file extensions' but the FileUploadHandler
        // needs the FileExtension entry to be present and empty in order for this
        // to be respected. An empty array means 'all file extensions'.
        // @see \Drupal\file\Upload\FileUploadHandler::handleExtensionValidation
        $validators['FileExtension'] = [];
    }
    try {
        $filename = ContentDispositionFilenameParser::parseFilename($request);
        $tempPath = $this->inputStreamFileWriter
            ->writeStreamToFile();
        $uploadedFile = new InputStreamUploadedFile($filename, $filename, $tempPath, @filesize($tempPath));
        $result = $this->fileUploadHandler
            ->handleFileUpload($uploadedFile, $validators, $destination, FileExists::Rename, FALSE);
    } catch (LockAcquiringException $e) {
        throw new HttpException(503, $e->getMessage(), NULL, [
            'Retry-After' => 1,
        ]);
    } catch (UploadException $e) {
        $this->logger
            ->error('Input data could not be read');
        throw new HttpException(500, 'Input file data could not be read', $e);
    } catch (CannotWriteFileException $e) {
        $this->logger
            ->error('Temporary file data for could not be written');
        throw new HttpException(500, 'Temporary file data could not be written', $e);
    } catch (NoFileException $e) {
        $this->logger
            ->error('Temporary file could not be opened for file upload');
        throw new HttpException(500, 'Temporary file could not be opened', $e);
    } catch (FileExistsException $e) {
        throw new HttpException(statusCode: 500, message: $e->getMessage(), previous: $e);
    } catch (FileException $e) {
        throw new HttpException(500, 'Temporary file could not be moved to file location');
    }
    if ($result->hasViolations()) {
        $message = "Unprocessable Entity: file validation failed.\n";
        $errors = [];
        foreach ($result->getViolations() as $violation) {
            $errors[] = PlainTextOutput::renderFromHtml($violation->getMessage());
        }
        $message .= implode("\n", $errors);
        throw new UnprocessableEntityHttpException($message);
    }
    // 201 Created responses return the newly created entity in the response
    // body. These responses are not cacheable, so we add no cacheability
    // metadata here.
    return new ModifiedResourceResponse($result->getFile(), 201);
}

---