File: /var/www/vhost/disk-apps/magento.bikenow.co/vendor/magento/module-remote-storage/Plugin/Image.php
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
declare(strict_types=1);
namespace Magento\RemoteStorage\Plugin;
use Magento\Framework\App\Filesystem\DirectoryList;
use Magento\Framework\Exception\FileSystemException;
use Magento\Framework\Exception\RuntimeException;
use Magento\Framework\Filesystem;
use Magento\Framework\Filesystem\Directory\TargetDirectory;
use Magento\Framework\Filesystem\Io\File;
use Magento\Framework\Image\Adapter\AbstractAdapter;
use Magento\RemoteStorage\Model\Config;
use Psr\Log\LoggerInterface;
/**
* @see AbstractAdapter
*/
class Image
{
/**
* @var Filesystem\Directory\WriteInterface
*/
private $tmpDirectoryWrite;
/**
* @var Filesystem\Directory\WriteInterface
*/
private $remoteDirectoryWrite;
/**
* @var array
*/
private $tmpFiles = [];
/**
* @var bool
*/
private $isEnabled;
/**
* @var File
*/
private $ioFile;
/**
* @var LoggerInterface
*/
private $logger;
/**
* @param Filesystem $filesystem
* @param File $ioFile
* @param TargetDirectory $targetDirectory
* @param Config $config
* @param LoggerInterface $logger
* @throws FileSystemException
* @throws RuntimeException
*/
public function __construct(
Filesystem $filesystem,
File $ioFile,
TargetDirectory $targetDirectory,
Config $config,
LoggerInterface $logger
) {
$this->tmpDirectoryWrite = $filesystem->getDirectoryWrite(DirectoryList::TMP);
$this->remoteDirectoryWrite = $targetDirectory->getDirectoryWrite(DirectoryList::ROOT);
$this->isEnabled = $config->isEnabled();
$this->ioFile = $ioFile;
$this->logger = $logger;
}
/**
* Copy file from remote server to tmp directory of Magento
*
* @param AbstractAdapter $subject
* @param string $filename
* @return array
* @throws FileSystemException
*
* @SuppressWarnings(PHPMD.UnusedFormalParameter)
*/
public function beforeOpen(AbstractAdapter $subject, $filename): array
{
if ($this->isEnabled) {
$filename = $this->copyFileToTmp($filename);
}
return [$filename];
}
/**
* Copy import file locally to validate
*
* @param AbstractAdapter $subject
* @param string $filePath
* @return string[]
* @throws FileSystemException
*
* @SuppressWarnings(PHPMD.UnusedFormalParameter)
*/
public function beforeValidateUploadFile(AbstractAdapter $subject, $filePath): array
{
if ($this->isEnabled) {
$filePath = $this->copyFileToTmp($filePath);
}
return [$filePath];
}
/**
* Copy watermark locally before adding it an image
*
* @param AbstractAdapter $subject
* @param string $filePath
* @return string[]
* @throws FileSystemException
*
* @SuppressWarnings(PHPMD.UnusedFormalParameter)
*/
public function beforeWatermark(AbstractAdapter $subject, $filePath): array
{
if ($this->isEnabled) {
$filePath = $this->copyFileToTmp($filePath);
}
return [$filePath];
}
/**
* Get filesystem tmp path for file and provide it to save() function
*
* @param AbstractAdapter $subject
* @param callable $proceed
* @param string|null $destination
* @param string|null $newName
* @return void
* @throws FileSystemException
*/
public function aroundSave(
AbstractAdapter $subject,
callable $proceed,
$destination = null,
$newName = null
): void {
if ($this->isEnabled) {
$relativePath = $this->remoteDirectoryWrite->getRelativePath($destination);
$tmpPath = $this->tmpDirectoryWrite->getAbsolutePath($relativePath);
$proceed($tmpPath, $newName);
$this->tmpDirectoryWrite->getDriver()->rename(
$this->prepareDestination($subject, $tmpPath, $newName),
$this->prepareDestination($subject, $destination, $newName),
$this->remoteDirectoryWrite->getDriver()
);
} else {
$proceed($destination, $newName);
}
}
/**
* Remove created tmp files
*/
public function __destruct()
{
try {
foreach ($this->tmpFiles as $tmpFile) {
$this->tmpDirectoryWrite->delete($tmpFile);
}
} catch (\Exception $e) {
$this->logger->error($e->getMessage());
}
}
/**
* Move files from storage to tmp folder
*
* @param string $filePath
* @return string
* @throws FileSystemException
*/
private function copyFileToTmp(string $filePath): string
{
if ($this->fileExistsInTmp($filePath)) {
return $this->tmpFiles[$filePath];
}
$absolutePath = $this->remoteDirectoryWrite->getAbsolutePath($filePath);
if ($this->remoteDirectoryWrite->isFile($absolutePath)) {
$this->tmpDirectoryWrite->create();
$tmpPath = $this->storeTmpName($filePath);
$content = $this->remoteDirectoryWrite->getDriver()->fileGetContents($filePath);
$filePath = $this->tmpDirectoryWrite->getDriver()->filePutContents($tmpPath, $content)
? $tmpPath
: $filePath;
}
return $filePath;
}
/**
* Store created tmp image path
*
* @param string $filePath
* @return string
*/
private function storeTmpName(string $filePath): string
{
// phpcs:ignore Magento2.Functions.DiscouragedFunction
$tmpPath = $this->tmpDirectoryWrite->getAbsolutePath() . basename($filePath);
$this->tmpFiles[$filePath] = $tmpPath;
return $tmpPath;
}
/**
* Check is file exist in tmp folder
*
* @param string $filePath
* @return bool
*/
private function fileExistsInTmp(string $filePath): bool
{
return array_key_exists($filePath, $this->tmpFiles);
}
/**
* Prepare destination path
*
* @param AbstractAdapter $image
* @param string|null $destination
* @param string|null $newName
* @return string
*/
private function prepareDestination(
AbstractAdapter $image,
string $destination = null,
string $newName = null
): string {
if (empty($destination)) {
$destination = $image->getFileSrcPath();
} elseif (empty($newName)) {
$info = $this->ioFile->getPathInfo($destination);
$newName = $info['basename'];
$destination = $info['dirname'];
}
if (empty($newName)) {
$newFileName = $image->getFileSrcName();
} else {
$newFileName = $newName;
}
return rtrim($destination, '/') . '/' . $newFileName;
}
}