[FOLLOWUP][BUGFIX] Add reload parameter for EM List Utility
[Packages/TYPO3.CMS.git] / typo3 / sysext / extensionmanager / Classes / Utility / ListUtility.php
1 <?php
2 namespace TYPO3\CMS\Extensionmanager\Utility;
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\Package\PackageInterface;
18 use TYPO3\CMS\Core\Utility\ExtensionManagementUtility;
19 use TYPO3\CMS\Core\Utility\GeneralUtility;
20 use TYPO3\CMS\Core\Utility\VersionNumberUtility;
21 use TYPO3\CMS\Extensionmanager\Domain\Model\Extension;
22
23 /**
24 * Utility for dealing with extension list related functions
25 *
26 * @TODO: Refactor this API class:
27 * - The methods depend on each other, they take each others result, that could be done internally
28 * - There is no good wording to distinguish existing and loaded extensions
29 * - The name 'listUtility' is not good, the methods could be moved to some 'extensionInformationUtility', or a repository?
30 */
31 class ListUtility implements \TYPO3\CMS\Core\SingletonInterface
32 {
33 /**
34 * @var \TYPO3\CMS\Extensionmanager\Utility\EmConfUtility
35 */
36 protected $emConfUtility;
37
38 /**
39 * @var \TYPO3\CMS\Extensionmanager\Domain\Repository\ExtensionRepository
40 */
41 protected $extensionRepository;
42
43 /**
44 * @var \TYPO3\CMS\Extensionmanager\Utility\InstallUtility
45 */
46 protected $installUtility;
47
48 /**
49 * @var \TYPO3\CMS\Core\Package\PackageManager
50 */
51 protected $packageManager;
52
53 /**
54 * @var \TYPO3\CMS\Extbase\SignalSlot\Dispatcher
55 */
56 protected $signalSlotDispatcher;
57
58 /**
59 * @var array
60 */
61 protected $availableExtensions = NULL;
62
63 /**
64 * @param \TYPO3\CMS\Extensionmanager\Utility\EmConfUtility $emConfUtility
65 */
66 public function injectEmConfUtility(\TYPO3\CMS\Extensionmanager\Utility\EmConfUtility $emConfUtility)
67 {
68 $this->emConfUtility = $emConfUtility;
69 }
70
71 /**
72 * @param \TYPO3\CMS\Extensionmanager\Domain\Repository\ExtensionRepository $extensionRepository
73 */
74 public function injectExtensionRepository(\TYPO3\CMS\Extensionmanager\Domain\Repository\ExtensionRepository $extensionRepository)
75 {
76 $this->extensionRepository = $extensionRepository;
77 }
78
79 /**
80 * @param \TYPO3\CMS\Extensionmanager\Utility\InstallUtility $installUtility
81 */
82 public function injectInstallUtility(\TYPO3\CMS\Extensionmanager\Utility\InstallUtility $installUtility)
83 {
84 $this->installUtility = $installUtility;
85 }
86
87 /**
88 * @param \TYPO3\CMS\Core\Package\PackageManager $packageManager
89 */
90 public function injectPackageManager(\TYPO3\CMS\Core\Package\PackageManager $packageManager)
91 {
92 $this->packageManager = $packageManager;
93 }
94
95 /**
96 * @param \TYPO3\CMS\Extbase\SignalSlot\Dispatcher $signalSlotDispatcher
97 */
98 public function injectSignalSlotDispatcher(\TYPO3\CMS\Extbase\SignalSlot\Dispatcher $signalSlotDispatcher)
99 {
100 $this->signalSlotDispatcher = $signalSlotDispatcher;
101 }
102
103 /**
104 * Returns the list of available, but not necessarily loaded extensions
105 *
106 * @return array[] All extensions with info
107 */
108 public function getAvailableExtensions()
109 {
110 if ($this->availableExtensions === null) {
111 $this->availableExtensions = [];
112 $this->emitPackagesMayHaveChangedSignal();
113 foreach ($this->packageManager->getAvailablePackages() as $package) {
114 $installationType = $this->getInstallTypeForPackage($package);
115 $this->availableExtensions[$package->getPackageKey()] = array(
116 'siteRelPath' => str_replace(PATH_site, '', $package->getPackagePath()),
117 'type' => $installationType,
118 'key' => $package->getPackageKey(),
119 'ext_icon' => ExtensionManagementUtility::getExtensionIcon($package->getPackagePath()),
120 );
121 }
122 }
123
124 return $this->availableExtensions;
125 }
126
127 /**
128 * Reset and reload the available extensions
129 */
130 public function reloadAvailableExtensions() {
131 $this->availableExtensions = null;
132 $this->packageManager->scanAvailablePackages();
133 $this->getAvailableExtensions();
134 }
135
136 /**
137 * @param string $extensionKey
138 * @return \TYPO3\CMS\Core\Package\PackageInterface
139 * @throws \TYPO3\CMS\Core\Package\Exception\UnknownPackageException if the specified package is unknown
140 */
141 public function getExtension($extensionKey)
142 {
143 return $this->packageManager->getPackage($extensionKey);
144 }
145
146 /**
147 * Emits packages may have changed signal
148 */
149 protected function emitPackagesMayHaveChangedSignal()
150 {
151 $this->signalSlotDispatcher->dispatch('PackageManagement', 'packagesMayHaveChanged');
152 }
153
154 /**
155 * Returns "System", "Global" or "Local" based on extension position in filesystem.
156 *
157 * @param PackageInterface $package
158 * @return string
159 */
160 protected function getInstallTypeForPackage(PackageInterface $package)
161 {
162 foreach (Extension::returnInstallPaths() as $installType => $installPath) {
163 if (GeneralUtility::isFirstPartOfStr($package->getPackagePath(), $installPath)) {
164 return $installType;
165 }
166 }
167 return '';
168 }
169
170 /**
171 * Enrich the output of getAvailableExtensions() with an array key installed = 1 if an extension is loaded.
172 *
173 * @param array $availableExtensions
174 * @return array
175 */
176 public function getAvailableAndInstalledExtensions(array $availableExtensions)
177 {
178 foreach ($this->packageManager->getActivePackages() as $extKey => $_) {
179 if (isset($availableExtensions[$extKey])) {
180 $availableExtensions[$extKey]['installed'] = true;
181 }
182 }
183 return $availableExtensions;
184 }
185
186 /**
187 * Adds the information from the emconf array to the extension information
188 *
189 * @param array $extensions
190 * @return array
191 */
192 public function enrichExtensionsWithEmConfAndTerInformation(array $extensions)
193 {
194 foreach ($extensions as $extensionKey => $properties) {
195 $emconf = $this->emConfUtility->includeEmConf($properties);
196 if ($emconf) {
197 $extensions[$extensionKey] = array_merge($emconf, $properties);
198 $terObject = $this->getExtensionTerData($extensionKey, $extensions[$extensionKey]['version']);
199 if ($terObject !== null) {
200 $extensions[$extensionKey]['terObject'] = $terObject;
201 $extensions[$extensionKey]['updateAvailable'] = false;
202 $extensions[$extensionKey]['updateToVersion'] = null;
203 $extensionToUpdate = $this->installUtility->getUpdateableVersion($terObject);
204 if ($extensionToUpdate !== false) {
205 $extensions[$extensionKey]['updateAvailable'] = true;
206 $extensions[$extensionKey]['updateToVersion'] = $extensionToUpdate;
207 }
208 }
209 } else {
210 unset($extensions[$extensionKey]);
211 }
212 }
213 return $extensions;
214 }
215
216 /**
217 * Tries to find given extension with given version in TER data.
218 * If extension is found but not the given version, we return TER data from highest version with version data set to
219 * given one.
220 *
221 * @param string $extensionKey Key of the extension
222 * @param string $version String representation of version number
223 * @return Extension|NULL Extension TER object or NULL if nothing found
224 */
225 protected function getExtensionTerData($extensionKey, $version)
226 {
227 $terObject = $this->extensionRepository->findOneByExtensionKeyAndVersion($extensionKey, $version);
228 if (!$terObject instanceof Extension) {
229 // Version unknown in TER data, try to find extension
230 $terObject = $this->extensionRepository->findHighestAvailableVersion($extensionKey);
231 if ($terObject instanceof Extension) {
232 // Found in TER now, set version information to the known ones, so we can look if there is a newer one
233 // Use a cloned object, otherwise wrong information is stored in persistenceManager
234 $terObject = clone $terObject;
235 $terObject->setVersion($version);
236 $terObject->setIntegerVersion(
237 VersionNumberUtility::convertVersionNumberToInteger($terObject->getVersion())
238 );
239 } else {
240 $terObject = null;
241 }
242 }
243
244 return $terObject;
245 }
246
247 /**
248 * Adds information about icon size to the extension information
249 *
250 * @param array $extensions
251 * @return array
252 */
253 public function enrichExtensionsWithIconInformation(array $extensions)
254 {
255 foreach ($extensions as &$properties) {
256 $iInfo = @getimagesize(PATH_site . $properties['siteRelPath'] . $properties['ext_icon']);
257 if ($iInfo !== false) {
258 $properties['ext_icon_width'] = $iInfo[0];
259 $properties['ext_icon_height'] = $iInfo[1];
260 } else {
261 $properties['ext_icon_width'] = 0;
262 $properties['ext_icon_height'] = 0;
263 }
264 }
265 unset($properties);
266 return $extensions;
267 }
268
269 /**
270 * Gets all available and installed extension with additional information
271 * from em_conf and TER (if available)
272 *
273 * @return array
274 */
275 public function getAvailableAndInstalledExtensionsWithAdditionalInformation()
276 {
277 $availableExtensions = $this->getAvailableExtensions();
278 $availableAndInstalledExtensions = $this->getAvailableAndInstalledExtensions($availableExtensions);
279 $availableAndInstalledExtensions = $this->enrichExtensionsWithIconInformation($availableAndInstalledExtensions);
280 return $this->enrichExtensionsWithEmConfAndTerInformation($availableAndInstalledExtensions);
281 }
282 }