2798fb8bde2817fdf848784ac35fbab4176f2e85
[Packages/TYPO3.CMS.git] / typo3 / sysext / core / Classes / Resource / Processing / LocalImageProcessor.php
1 <?php
2 namespace TYPO3\CMS\Core\Resource\Processing;
3
4 /*
5 * This file is part of the TYPO3 CMS project.
6 *
7 * It is free software; you can redistribute it and/or modify it under
8 * the terms of the GNU General Public License, either version 2
9 * of the License, or any later version.
10 *
11 * For the full copyright and license information, please read the
12 * LICENSE.txt file that was distributed with this source code.
13 *
14 * The TYPO3 project - inspiring people to share!
15 */
16
17 use TYPO3\CMS\Core\Imaging\GraphicalFunctions;
18 use TYPO3\CMS\Core\Log\LogManager;
19 use TYPO3\CMS\Core\Utility\GeneralUtility;
20
21 /**
22 * Processes Local Images files
23 */
24 class LocalImageProcessor implements ProcessorInterface
25 {
26 /**
27 * @var \TYPO3\CMS\Core\Log\Logger
28 */
29 protected $logger;
30
31 /**
32 * Constructor
33 */
34 public function __construct()
35 {
36 /** @var $logManager LogManager */
37 $logManager = GeneralUtility::makeInstance(LogManager::class);
38 $this->logger = $logManager->getLogger(__CLASS__);
39 }
40
41 /**
42 * Returns TRUE if this processor can process the given task.
43 *
44 * @param TaskInterface $task
45 * @return bool
46 */
47 public function canProcessTask(TaskInterface $task)
48 {
49 $canProcessTask = $task->getType() === 'Image';
50 $canProcessTask = $canProcessTask & in_array($task->getName(), ['Preview', 'CropScaleMask']);
51 return $canProcessTask;
52 }
53
54 /**
55 * Processes the given task.
56 *
57 * @param TaskInterface $task
58 * @throws \InvalidArgumentException
59 */
60 public function processTask(TaskInterface $task)
61 {
62 if (!$this->canProcessTask($task)) {
63 throw new \InvalidArgumentException('Cannot process task of type "' . $task->getType() . '.' . $task->getName() . '"', 1350570621);
64 }
65 if ($this->checkForExistingTargetFile($task)) {
66 return;
67 }
68 $helper = $this->getHelperByTaskName($task->getName());
69 try {
70 $result = $helper->process($task);
71 if ($result === null) {
72 $task->setExecuted(true);
73 $task->getTargetFile()->setUsesOriginalFile();
74 } elseif (!empty($result['filePath']) && file_exists($result['filePath'])) {
75 $task->setExecuted(true);
76 $imageDimensions = $this->getGraphicalFunctionsObject()->getImageDimensions($result['filePath']);
77 $task->getTargetFile()->setName($task->getTargetFileName());
78 $task->getTargetFile()->updateProperties(
79 ['width' => $imageDimensions[0], 'height' => $imageDimensions[1], 'size' => filesize($result['filePath']), 'checksum' => $task->getConfigurationChecksum()]
80 );
81 $task->getTargetFile()->updateWithLocalFile($result['filePath']);
82 } elseif (!empty($result['width']) && !empty($result['height']) && empty($result['filePath'])) {
83 // New dimensions + no new file (for instance svg)
84 $task->setExecuted(true);
85 $task->getTargetFile()->setUsesOriginalFile();
86 $task->getTargetFile()->updateProperties(
87 ['width' => $result['width'], 'height' => $result['height'], 'size' => $task->getSourceFile()->getSize(), 'checksum' => $task->getConfigurationChecksum()]
88 );
89 } else {
90 // Seems we have no valid processing result
91 $task->setExecuted(false);
92 }
93 } catch (\Exception $e) {
94 $task->setExecuted(false);
95 }
96 }
97
98 /**
99 * Check if the to be processed target file already exists
100 * if exist take info from that file and mark task as done
101 *
102 * @param TaskInterface $task
103 * @return bool
104 */
105 protected function checkForExistingTargetFile(TaskInterface $task)
106 {
107 // the storage of the processed file, not of the original file!
108 $storage = $task->getTargetFile()->getStorage();
109 $processingFolder = $storage->getProcessingFolder($task->getSourceFile());
110
111 // explicitly check for the raw filename here, as we check for files that existed before we even started
112 // processing, i.e. that were processed earlier
113 if ($processingFolder->hasFile($task->getTargetFileName())) {
114 // When the processed file already exists set it as processed file
115 $task->getTargetFile()->setName($task->getTargetFileName());
116
117 // If the processed file is stored on a remote server, we must fetch a local copy of the file, as we
118 // have no API for fetching file metadata from a remote file.
119 $localProcessedFile = $storage->getFileForLocalProcessing($task->getTargetFile(), false);
120 $task->setExecuted(true);
121 $imageDimensions = $this->getGraphicalFunctionsObject()->getImageDimensions($localProcessedFile);
122 $properties = [
123 'width' => $imageDimensions[0],
124 'height' => $imageDimensions[1],
125 'size' => filesize($localProcessedFile),
126 'checksum' => $task->getConfigurationChecksum()
127 ];
128 $task->getTargetFile()->updateProperties($properties);
129
130 return true;
131 } else {
132 return false;
133 }
134 }
135
136 /**
137 * @param string $taskName
138 * @return LocalCropScaleMaskHelper|LocalPreviewHelper
139 * @throws \InvalidArgumentException
140 */
141 protected function getHelperByTaskName($taskName)
142 {
143 switch ($taskName) {
144 case 'Preview':
145 $helper = GeneralUtility::makeInstance(LocalPreviewHelper::class, $this);
146 break;
147 case 'CropScaleMask':
148 $helper = GeneralUtility::makeInstance(LocalCropScaleMaskHelper::class, $this);
149 break;
150 default:
151 throw new \InvalidArgumentException('Cannot find helper for task name: "' . $taskName . '"', 1353401352);
152 }
153
154 return $helper;
155 }
156
157 /**
158 * @return GraphicalFunctions
159 */
160 protected function getGraphicalFunctionsObject()
161 {
162 static $graphicalFunctionsObject = null;
163
164 if ($graphicalFunctionsObject === null) {
165 $graphicalFunctionsObject = GeneralUtility::makeInstance(GraphicalFunctions::class);
166 }
167
168 return $graphicalFunctionsObject;
169 }
170 }