Magento 2 custom options allows you to add file upload option to product. So on frontend customer is able to attach a file to product when placing an order.<\/p>\n\n\n\n
Recently I have discovered that it is not possible to upload file other than image via Rest API. In the code below I suggest a sample Plugin code that allows you to overcome this restriction.<\/p>\n\n\n\n\n\n\n\n
First declare plugin in app\/code\/Vendor\/ModuleName\/etc\/webapi_rest\/di.xml:<\/p>\n\n\n\n
<?xml version=\"1.0\"?>\n\n<config xmlns:xsi=\"http:\/\/www.w3.org\/2001\/XMLSchema-instance\"\n xsi:noNamespaceSchemaLocation=\"urn:magento:framework:ObjectManager\/etc\/config.xsd\">\n <type name=\"Magento\\Catalog\\Model\\Webapi\\Product\\Option\\Type\\File\\Processor\">\n <plugin name=\"AllowFileUploadPlugin\"\n type=\"Vendor\\ModuleName\\Plugin\\Catalog\\Webaip\\ProductOptionTypeFileProcessor\\AroundProcessFileContent\\AllowFileUploadPlugin\"\/>\n <\/type>\n<\/config><\/pre>\n\n\n\nPlugin code can look like this:<\/p>\n\n\n\n
<?php\n\ndeclare(strict_types=1);\n\nnamespace Vendor\\ModuleName\\Plugin\\Catalog\\Webaip\\ProductOptionTypeFileProcessor\\AroundProcessFileContent;\n\nuse Magento\\Catalog\\Model\\Webapi\\Product\\Option\\Type\\File\\Processor;\nuse Magento\\Framework\\Api\\Data\\ImageContentInterface;\nuse Magento\\Framework\\Api\\Uploader;\nuse Magento\\Framework\\App\\Filesystem\\DirectoryList;\nuse Magento\\Framework\\Exception\\FileSystemException;\nuse Magento\\Framework\\Exception\\InputException;\nuse Magento\\Framework\\Filesystem;\nuse Magento\\Framework\\Filesystem\\Directory\\WriteInterface;\nuse Magento\\Framework\\Phrase;\n\n\/**\n * Allow not only images to be uploaded\n *\n * Class AllowFileUploadPlugin\n *\/\nclass AllowFileUploadPlugin\n{\n\n public const FILE_EXTENSIONS_TO_PROCESS = [\n 'pdf',\n 'docx'\n ];\n\n \/**\n * @var string\n *\/\n protected $destinationFolder = 'custom_options\/quote';\n\n \/**\n * 4Mb file size limit\n *\/\n public const FILE_SIZE_LIMIT_BYTES = 4 * 1048576;\n\n \/**\n * @var Filesystem\n *\/\n private $filesystem;\n\n \/**\n * @var Uploader\n *\/\n private $uploader;\n\n \/**\n * @var WriteInterface\n *\/\n private $mediaDirectory;\n\n \/**\n * AllowFileUploadPlugin constructor.\n * @param Filesystem $filesystem\n * @param Uploader $uploader\n * @throws FileSystemException\n *\/\n public function __construct(\n Filesystem $filesystem,\n Uploader $uploader\n ) {\n $this->filesystem = $filesystem;\n $this->uploader = $uploader;\n $this->mediaDirectory = $this->filesystem->getDirectoryWrite(DirectoryList::MEDIA);\n }\n\n \/**\n * Core magento allows only images to be uploaded\n * Here we allow PDF and DOC files\n *\n * @param Processor $subject\n * @param callable $proceed\n * @param ImageContentInterface $fileContent\n * @return array\n * @throws InputException\n * @throws FileSystemException\n * @SuppressWarnings(PHPMD.UnusedFormalParameter)\n *\/\n public function aroundProcessFileContent(\n Processor $subject,\n callable $proceed,\n ImageContentInterface $fileContent\n ): array {\n $fileMatches = array_search(\n strtolower($fileContent->getType()),\n array_map('strtolower', self::FILE_EXTENSIONS_TO_PROCESS),\n true\n ) !== false;\n\n if (!$fileMatches) {\n return $proceed($fileContent);\n }\n\n $filePath = $this->saveFile($fileContent);\n\n $fileAbsolutePath = $this->filesystem->getDirectoryRead(DirectoryList::MEDIA)->getAbsolutePath($filePath);\n $fileHash = md5($this->filesystem->getDirectoryRead(DirectoryList::MEDIA)->readFile($filePath));\n $imageSize = getimagesize($fileAbsolutePath);\n $result = [\n 'type' => $fileContent->getType(),\n 'title' => $fileContent->getName(),\n 'fullpath' => $fileAbsolutePath,\n 'quote_path' => $filePath,\n 'order_path' => $filePath,\n 'size' => filesize($fileAbsolutePath),\n 'width' => $imageSize ? $imageSize[0] : 0,\n 'height' => $imageSize ? $imageSize[1] : 0,\n 'secret_key' => substr($fileHash, 0, 20),\n ];\n\n return $result;\n }\n\n \/**\n * Save file\n *\n * @param ImageContentInterface $fileContent\n * @return string\n * @throws InputException\n * @throws FileSystemException\n *\/\n private function saveFile(ImageContentInterface $fileContent): string\n {\n $this->validateSize($fileContent);\n\n $content = @base64_decode($fileContent->getBase64EncodedData(), true);\n $tmpDirectory = $this->filesystem->getDirectoryWrite(DirectoryList::SYS_TMP);\n $fileName = $this->getFileName($fileContent);\n $tmpFileName = substr(md5((string)mt_rand()), 0, 7) . '.' . $fileName;\n $tmpDirectory->writeFile($tmpFileName, $content);\n\n $fileAttributes = [\n 'tmp_name' => $tmpDirectory->getAbsolutePath() . $tmpFileName,\n 'name' => $fileContent->getName()\n ];\n\n $this->uploader->processFileAttributes($fileAttributes);\n $this->uploader->setFilesDispersion(true);\n $this->uploader->setFilenamesCaseSensitivity(false);\n $this->uploader->setAllowRenameFiles(true);\n $this->uploader->save($this->mediaDirectory->getAbsolutePath($this->destinationFolder), $fileName);\n\n $filePath = $this->uploader->getUploadedFileName();\n\n return $this->destinationFolder . $filePath;\n }\n\n \/**\n * Validate file size\n *\n * @param ImageContentInterface $fileContent\n * @throws InputException\n *\/\n private function validateSize(ImageContentInterface $fileContent): void\n {\n \/\/convert base 64 size to real one\n $fileSizeInBytes = strlen($fileContent->getBase64EncodedData()) \/ 4 * 3;\n\n if ($fileSizeInBytes > self::FILE_SIZE_LIMIT_BYTES) {\n throw new InputException(new Phrase('File size exceeds the limit'));\n }\n }\n\n \/**\n * Get file name\n *\n * @param $fileContent\n * @return mixed|string\n *\/\n private function getFileName($fileContent)\n {\n $fileName = $fileContent->getName();\n if (!pathinfo($fileName, PATHINFO_EXTENSION)) {\n $fileName .= '.' . $fileContent->getType();\n }\n\n return $fileName;\n }\n}\n<\/pre>\n\n\n\nHope it is helpful.<\/p>\n","protected":false},"excerpt":{"rendered":"
Magento 2 custom options allows you to add file upload option to product. So on frontend customer is able to attach a file to product when placing an order. Recently I have discovered that it is not possible to upload file other than image via Rest API. In the code below I suggest a sample … <\/p>\n