ExtensionApiService::checkInstallLocation() - Code Metrics - TYPO3-coreapi/ext-coreapi - Measure and Improve Code Quality continuously with Scrutinizer

ExtensionApiService::checkInstallLocation() B
last analyzed 2016-03-15 10:28 UTC

↳ Parent: ExtensionApiService

Complexity

Conditions	5
Paths	5

Size

Total Lines	17
Code Lines	11

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	30

Importance

Changes	1
Bugs	0	Features	1

Metric	Value
c	1
b	0
f	1
dl	0
loc	17
rs	8.8571
ccs	0
cts	12
cp	0
cc	5
eloc	11
nc	5
nop	1
crap	30

<?php
namespace Etobi\CoreAPI\Service;

/***************************************************************
 *  Copyright notice
 *
 *  (c) 2012 Georg Ringer <[email protected]>
 *  (c) 2014 Stefano Kowalke <[email protected]>
 *  All rights reserved
 *
 *  This script is part of the TYPO3 project. The TYPO3 project is
 *  free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation; either version 2 of the License, or
 *  (at your option) any later version.
 *
 *  The GNU General Public License can be found at
 *  http://www.gnu.org/copyleft/gpl.html.
 *
 *  This script is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  This copyright notice MUST APPEAR in all copies of the script!
 ***************************************************************/
use InvalidArgumentException;
use RuntimeException;
use TYPO3\CMS\Core\Configuration\ConfigurationManager;
use TYPO3\CMS\Core\Utility\ExtensionManagementUtility;
use TYPO3\CMS\Core\Utility\GeneralUtility;
use TYPO3\CMS\Extbase\Object\ObjectManagerInterface;
use TYPO3\CMS\Extensionmanager\Domain\Model\Extension;
use TYPO3\CMS\Extensionmanager\Domain\Repository\ExtensionRepository;
use TYPO3\CMS\Extensionmanager\Domain\Repository\RepositoryRepository;
use TYPO3\CMS\Extensionmanager\Service\ExtensionManagementService;
use TYPO3\CMS\Extensionmanager\Utility\FileHandlingUtility;
use TYPO3\CMS\Extensionmanager\Utility\InstallUtility;
use TYPO3\CMS\Extensionmanager\Utility\ListUtility;
use TYPO3\CMS\Extensionmanager\Utility\Repository\Helper;

/**
 * Extension API service
 *
 * @author Georg Ringer <[email protected]>
 * @author Stefano Kowalke <[email protected]>
 * @package Etobi\CoreAPI\Service\SiteApiService
 */
class ExtensionApiService {


	/**
	 * @var \TYPO3\CMS\Extensionmanager\Utility\Connection\TerUtility $terConnection
	 */
	public $terConnection;

	/**
	 * @var \TYPO3\CMS\Core\Configuration\ConfigurationManager $configurationManager
	 */
	protected $configurationManager;

	/**
	 * @var \TYPO3\CMS\Extensionmanager\Utility\ListUtility $extensionList
	 */
	public $listUtility;

	/**
	 * @var \TYPO3\CMS\Extensionmanager\Utility\InstallUtility $installUtility
	 */
	protected $installUtility;

	/**
	 * @var \TYPO3\CMS\Extensionmanager\Domain\Repository\RepositoryRepository $repositoryRepository
	 */
	protected $repositoryRepository;

	/**
	 * @var Helper $repositoryHelper
	 */
	protected $repositoryHelper;

	/**
	 * @var ExtensionRepository $extensionRepository
	 */
	protected $extensionRepository;

	/**
	 * @var ExtensionManagementService $extensionManagementService
	 */
	protected $extensionManagementService;

	/**
	 * @var ObjectManagerInterface $objectManager
	 */
	protected $objectManager;

	/**
	 * @var \TYPO3\CMS\Extensionmanager\Utility\FileHandlingUtility $fileHandlingUtility
	 */
	protected $fileHandlingUtility;

	/**
	 * @var \TYPO3\CMS\Extensionmanager\Utility\EmConfUtility $emConfUtility
	 */
	protected $emConfUtility;

	/**
	 * @param \TYPO3\CMS\Extensionmanager\Utility\FileHandlingUtility $fileHandlingUtility
	 *
	 * @return void
	 */
	public function injectFileHandlingUtility(FileHandlingUtility $fileHandlingUtility) {
		$this->fileHandlingUtility = $fileHandlingUtility;
	}

	/**
	 * @param \TYPO3\CMS\Extensionmanager\Utility\InstallUtility $installUtility
	 *
	 * @return void
	 */
	public function injectInstallUtility(InstallUtility $installUtility) {
		$this->installUtility = $installUtility;
	}

	/**
	 * @param RepositoryRepository $repositoryRepository
	 *
	 * @return void
	 */
	public function injectRepositoryRepository(RepositoryRepository $repositoryRepository) {
		$this->repositoryRepository = $repositoryRepository;
	}

	/**
	 * @param Helper $repositoryHelper
	 *
	 * @return void
	 */
	public function injectRepositoryHelper(Helper $repositoryHelper) {
		$this->repositoryHelper = $repositoryHelper;
	}

	/**
	 * @param ExtensionRepository $extensionRepository
	 *
	 * @return void
	 */
	public function injectExtensionRepository(ExtensionRepository $extensionRepository){
		$this->extensionRepository = $extensionRepository;
	}

	/**
	 * @param ExtensionManagementService $extensionManagementService
	 *
	 * @return void
	 */
	public function injectExtensionManagementService(ExtensionManagementService $extensionManagementService) {
		$this->extensionManagementService = $extensionManagementService;
	}

	/**
	 * @param ObjectManagerInterface $objectManager
	 *
	 * @return void
	 */
	public function injectObjectManager(ObjectManagerInterface $objectManager) {
		$this->objectManager = $objectManager;
	}

	/**
	 * The constructor
	 */
	public function __construct() {
		$this->configurationManager = GeneralUtility::makeInstance('TYPO3\\CMS\\Core\\Configuration\\ConfigurationManager');
	}

	/**
	 * Get information about an extension.
	 *
	 * @param string $extensionKey extension key
	 *
	 * @throws InvalidArgumentException
	 * @return array
	 */
	public function getExtensionInformation($extensionKey) {
		if (strlen($extensionKey) === 0) {
			throw new InvalidArgumentException('No extension key given!');
		}

		$this->checkExtensionExists($extensionKey);

		$extensions = $this->listExtensions();

		$information = array(
			'em_conf' => $extensions[$extensionKey],
			'is_installed' => $this->installUtility->isLoaded($extensionKey)
		);

		return $information;
	}

	/**
	 * Get array of installed extensions.
	 *
	 * @param string $type Local, System, Global or empty (for all)
	 *
	 * @throws InvalidArgumentException
	 * @return array
	 */
	public function listExtensions($type = '') {
		$type = ucfirst(strtolower($type));
		if (!empty($type) && $type !== 'Local' && $type !== 'Global' && $type !== 'System') {
			throw new InvalidArgumentException('Only "Local", "System", "Global" and "" (all) are supported as type');
		}

		$this->initializeExtensionManagerObjects();

		// TODO: Make listUtlity local var
		$extensions = $this->listUtility->getAvailableExtensions();

		$list = array();

		foreach ($extensions as $key => $extension) {
			if ((!empty($type) && $type !== $extension['type'])
					|| (!$this->installUtility->isLoaded($extension['key']))
			) {
				continue;
			}

			// TODO: Make emConfUtility local var
			$configuration = $this->emConfUtility->includeEmConf($extension);
			if (!empty($configuration)) {
				$list[$key] = $configuration;
			}
		}
		ksort($list);

		return $list;
	}

	/**
	 * Update the mirrors, using the scheduler task of EXT:em.
	 *
	 * @throws RuntimeException
	 * @return boolean
	 */
	public function updateMirrors() {
		$result = FALSE;
		$repositories = $this->repositoryRepository->findAll();

		// update all repositories
		foreach ($repositories as $repository) {
			$this->repositoryHelper->setRepository($repository);
			$result = $this->repositoryHelper->updateExtList();
			unset($objRepository, $this->repositoryHelper);
		}

		return $result;
	}

	/**
	 * Install (load) an extension.
	 *
	 * @param string $extensionKey extension key
	 *
	 * @throws RuntimeException
	 * @throws InvalidArgumentException
	 * @return void
	 */
	public function installExtension($extensionKey) {
		$this->checkExtensionExists($extensionKey);

		$this->installUtility->install($extensionKey);
	}

	/**
	 * Uninstall (unload) an extension.
	 *
	 * @param string $extensionKey extension key
	 *
	 * @throws RuntimeException
	 * @throws InvalidArgumentException
	 * @return void
	 */
	public function uninstallExtension($extensionKey) {
		if ($extensionKey === 'coreapi') {
			throw new InvalidArgumentException('Extension "coreapi" cannot be uninstalled!');
		}

		$this->checkExtensionExists($extensionKey);
		$this->checkExtensionLoaded($extensionKey);

		$this->installUtility->uninstall($extensionKey);
	}


	/**
	 * Configure an extension.
	 *
	 * @param string $extensionKey              The extension key
	 * @param array  $newExtensionConfiguration
	 *
	 * @throws RuntimeException
	 * @throws InvalidArgumentException
	 * @return void
	 */
	public function configureExtension($extensionKey, $newExtensionConfiguration = array()) {
		$this->checkExtensionExists($extensionKey);
		$this->checkExtensionLoaded($extensionKey);

		// checks if conf array is empty
		if (empty($newExtensionConfiguration)) {
			throw new InvalidArgumentException(sprintf('No configuration provided for extension "%s"!', $extensionKey));
		}

		// check if extension can be configured
		$extAbsPath = $this->getExtensionPath($extensionKey);
		$extConfTemplateFile = $extAbsPath . 'ext_conf_template.txt';
		if (!file_exists($extConfTemplateFile)) {
			throw new InvalidArgumentException(sprintf('Extension "%s" has no configuration options!', $extensionKey));
		}

		/** @var $configurationUtility \TYPO3\CMS\Extensionmanager\Utility\ConfigurationUtility */
		$configurationUtility = $this->objectManager->get('TYPO3\\CMS\\Extensionmanager\\Utility\\ConfigurationUtility');
		// get existing configuration
		$currentExtensionConfig = $configurationUtility->getCurrentConfiguration($extensionKey);

		// check for unknown configuration settings
		foreach ($newExtensionConfiguration as $key => $_) {
			if (!isset($currentExtensionConfig[$key])) {
				throw new InvalidArgumentException(sprintf('No configuration setting with name "%s" for extension "%s"!', $key, $extensionKey));
			}
		}

		// fill with missing values
		$newExtensionConfiguration = $this->mergeNewExtensionConfiguratonWithCurrentConfiguration(
				$newExtensionConfiguration,
				$currentExtensionConfig
		);

		// write configuration to typo3conf/LocalConfiguration.php
		$configurationUtility->writeConfiguration($newExtensionConfiguration, $extensionKey);
	}

	/**
	 * Fetch an extension from TER.
	 *
	 * @param string $extensionKey     The extension key
	 * @param string $location         Where to import the extension. System = typo3/sysext, Global = typo3/ext, Local = typo3conf/ext
	 * @param bool   $overwrite        Overwrite the extension if it already exists
	 * @param int    $mirror           The mirror to fetch the extension from
	 *
	 * @throws \RuntimeException
	 * @throws \InvalidArgumentException
	 * @return array
	 */
	public function fetchExtension($extensionKey, $version = '', $location = 'Local', $overwrite = FALSE, $mirror = -1) {

		if (!is_numeric($mirror)) {
			throw new InvalidArgumentException('Option --mirror must be a number. Run the command extensionapi:listmirrors to get the list of all available repositories');
		}

		if ($version === '') {
			$extension = $this->extensionRepository->findHighestAvailableVersion($extensionKey);
			if ($extension === NULL) {
				throw new InvalidArgumentException(sprintf('Extension "%s" was not found on TER', $extensionKey));
			}
		} else {
			$extension = $this->extensionRepository->findOneByExtensionKeyAndVersion($extensionKey, $version);
			if ($extension === NULL) {
				throw new InvalidArgumentException(sprintf('Version %s of extension "%s" does not exist', $version, $extensionKey));
			}
		}

		if (!$overwrite) {
			$comingExtPath = $this->fileHandlingUtility->getExtensionDir($extensionKey, $location);
			if (@is_dir($comingExtPath)) {
				throw new InvalidArgumentException(sprintf('Extension "%s" already exists at "%s"!', $extensionKey, $comingExtPath));
			}
		}

		$mirrors = $this->repositoryHelper->getMirrors();

		if ($mirrors === NULL) {
			throw new RuntimeException('No mirrors found!');
		}

		if ($mirror === -1) {
			$mirrors->setSelect();
		} elseif ($mirror > 0 && $mirror <= count($mirrors->getMirrors())) {
			$mirrors->setSelect($mirror);
		} else {
			throw new InvalidArgumentException(sprintf('Mirror "%s" does not exist', $mirror));
		}

		/**
		 * @var \TYPO3\CMS\Extensionmanager\Utility\DownloadUtility $downloadUtility
		 */
		$downloadUtility = $this->objectManager->get('TYPO3\\CMS\\Extensionmanager\\Utility\\DownloadUtility');
		$downloadUtility->setDownloadPath($location);

		$this->extensionManagementService->downloadMainExtension($extension);

		$return = array();
		$extensionDir = $this->fileHandlingUtility->getExtensionDir($extensionKey, $location);
		if (is_dir($extensionDir)) {
			$return['main']['extKey'] = $extension->getExtensionKey();
			$return['main']['version'] = $extension->getVersion();
		} else {
			throw new RuntimeException(
					sprintf('Extension "%s" version %s could not installed!', $extensionKey, $extension->getVersion())
			);
		}

		return $return;
	}

	/**
	 * Lists the possible mirrors
	 *
	 * @return array
	 */
	public function listMirrors() {
		/** @var $repositoryHelper Helper */
		$repositoryHelper = $this->objectManager->get('TYPO3\\CMS\\Extensionmanager\\Utility\\Repository\\Helper');
		$mirrors = $repositoryHelper->getMirrors();

		return $mirrors->getMirrors();
	}

	/**
	 * Extracts and returns the file content of the given file
	 *
	 * @param string $file The file with file path
	 *
	 * @return array
	 */
	protected function getFileContentFromUrl($file) {
		return GeneralUtility::getUrl($file);
	}

	/**
	 * Imports extension from file.
	 *
	 * @param string $file      Path to t3x file
	 * @param string $location  Where to import the extension. System = typo3/sysext, Global = typo3/ext, Local = typo3conf/ext
	 * @param bool   $overwrite Overwrite the extension if it already exists
	 *
	 * @throws \RuntimeException
	 * @throws \InvalidArgumentException
	 * @return array The extension data
	 */
	public function importExtension($file, $location = 'Local', $overwrite = FALSE) {
		if (!is_file($file)) {
			throw new InvalidArgumentException(sprintf('File "%s" does not exist!', $file));
		}

		$this->checkInstallLocation($location);

		$uploadExtensionFileController = $this->objectManager->get('TYPO3\\CMS\\Extensionmanager\\Controller\\UploadExtensionFileController');

		$filename = pathinfo($file, PATHINFO_BASENAME);
		$return = $uploadExtensionFileController->extractExtensionFromFile($file, $filename, $overwrite, FALSE);

		return $return;
	}

	/**
	 * Checks if the function exists in the system
	 *
	 * @param string $extensionKey The extension key
	 *
	 * @return void
	 * @throws \InvalidArgumentException
	 */
	protected function checkExtensionExists($extensionKey) {
		if (!$this->installUtility->isAvailable($extensionKey)) {
			throw new InvalidArgumentException(sprintf('Extension "%s" does not exist!', $extensionKey));
		}
	}

	/**
	 * Check if an extension is loaded.
	 *
	 * @param string $extensionKey The extension key
	 *
	 * @throws \InvalidArgumentException
	 * @return void
	 */
	protected function checkExtensionLoaded($extensionKey) {
		if (!$this->installUtility->isLoaded($extensionKey)) {
			throw new InvalidArgumentException(sprintf('Extension "%s" is not installed!', $extensionKey));
		}
	}

	/**
	 * Returns the absolute extension path.
	 * Wrapper around the static method. This makes the method mockable.
	 *
	 * @param string $extensionKey The extension key
	 *
	 * @return string
	 */
	protected function getExtensionPath($extensionKey) {
		return ExtensionManagementUtility::extPath($extensionKey);
	}

	/**
	 * Add missing values from current configuration to the new configuration
	 *
	 * @param array $newExtensionConfiguration The new configuration which was provided as argument
	 * @param array $currentExtensionConfig    The current configuration of the extension
	 *
	 * @return array The merged configuration
	 */
	protected function mergeNewExtensionConfiguratonWithCurrentConfiguration($newExtensionConfiguration, $currentExtensionConfig) {
		foreach (array_keys($currentExtensionConfig) as $key) {
			if (!isset($newExtensionConfiguration[$key])) {
				if (!empty($currentExtensionConfig[$key]['value'])) {
					$newExtensionConfiguration[$key] = $currentExtensionConfig[$key]['value'];
				} else {
					$newExtensionConfiguration[$key] = $currentExtensionConfig[$key]['default_value'];
				}
			}
		}

		return $newExtensionConfiguration;
	}

	/**
	 * Checks if the extension is able to install at the demanded location
	 *
	 * @param string $location            The location
	 * @param array  $allowedInstallTypes The allowed locations
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
	 *
	 * @return boolean
	 * @throws \InvalidArgumentException
	 */
	protected function checkInstallLocation($location) {
		$allowedInstallTypes = Extension::returnAllowedInstallTypes();
		$location = ucfirst(strtolower($location));

		if (!in_array($location, $allowedInstallTypes)) {
			if ($location === 'Global') {
				throw new InvalidArgumentException('Global installation is not allowed!');
			}
			if ($location === 'Local') {
				throw new InvalidArgumentException('Local installation is not allowed!');
			}
			if ($location === 'System') {
				throw new InvalidArgumentException('System installation is not allowed!');
			}
			throw new InvalidArgumentException(sprintf('Unknown location "%s"!', $location));
		}
	}

	/**
	 * Initialize ExtensionManager Objects.
	 *
	 * @return void
	 */
	protected function initializeExtensionManagerObjects() {
		$this->listUtility = $this->objectManager->get('TYPO3\\CMS\\Extensionmanager\\Utility\\ListUtility');
		$this->emConfUtility = $this->objectManager->get('TYPO3\\CMS\\Extensionmanager\\Utility\\EmConfUtility');
	}

	/**
	 * Clear the caches.
	 *
	 * @return void
	 */
	protected function clearCaches() {
		$cacheApiService = GeneralUtility::makeInstance('Etobi\\CoreAPI\\Service\\CacheApiService');
		$cacheApiService->initializeObject();
		$cacheApiService->clearAllCaches();
	}
}


1		<?php
2		namespace Etobi\CoreAPI\Service;
3
4		/***************************************************************
5		* Copyright notice
6		*
7		* (c) 2012 Georg Ringer <[email protected]>
8		* (c) 2014 Stefano Kowalke <[email protected]>
9		* All rights reserved
10		*
11		* This script is part of the TYPO3 project. The TYPO3 project is
12		* free software; you can redistribute it and/or modify
13		* it under the terms of the GNU General Public License as published by
14		* the Free Software Foundation; either version 2 of the License, or
15		* (at your option) any later version.
16		*
17		* The GNU General Public License can be found at
18		* http://www.gnu.org/copyleft/gpl.html.
19		*
20		* This script is distributed in the hope that it will be useful,
21		* but WITHOUT ANY WARRANTY; without even the implied warranty of
22		* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
23		* GNU General Public License for more details.
24		*
25		* This copyright notice MUST APPEAR in all copies of the script!
26		***************************************************************/
27		use InvalidArgumentException;
28		use RuntimeException;
29		use TYPO3\CMS\Core\Configuration\ConfigurationManager;
30		use TYPO3\CMS\Core\Utility\ExtensionManagementUtility;
31		use TYPO3\CMS\Core\Utility\GeneralUtility;
32		use TYPO3\CMS\Extbase\Object\ObjectManagerInterface;
33		use TYPO3\CMS\Extensionmanager\Domain\Model\Extension;
34		use TYPO3\CMS\Extensionmanager\Domain\Repository\ExtensionRepository;
35		use TYPO3\CMS\Extensionmanager\Domain\Repository\RepositoryRepository;
36		use TYPO3\CMS\Extensionmanager\Service\ExtensionManagementService;
37		use TYPO3\CMS\Extensionmanager\Utility\FileHandlingUtility;
38		use TYPO3\CMS\Extensionmanager\Utility\InstallUtility;
39		use TYPO3\CMS\Extensionmanager\Utility\ListUtility;
40		use TYPO3\CMS\Extensionmanager\Utility\Repository\Helper;
41
42		/**
43		* Extension API service
44		*
45		* @author Georg Ringer <[email protected]>
46		* @author Stefano Kowalke <[email protected]>
47		* @package Etobi\CoreAPI\Service\SiteApiService
48		*/
49		class ExtensionApiService {
		0 ignored issues – show Complexity introduced 2016-02-08 13:46 UTC by Report Bug Copy Issue Report This class has a complexity of 62 which exceeds the configured maximum of 50. The class complexity is the sum of the complexity of all methods. A very high value is usually an indication that your class does not follow the single reponsibility principle and does more than one job. Some resources for further reading: Single Reponsibility Principle Open/Closed Principle You can also find more detailed suggestions for refactoring in the “Code” section of your repository. Loading history...
50
51		/**
52		* @var \TYPO3\CMS\Extensionmanager\Utility\Connection\TerUtility $terConnection
53		*/
54		public $terConnection;
55
56		/**
57		* @var \TYPO3\CMS\Core\Configuration\ConfigurationManager $configurationManager
58		*/
59		protected $configurationManager;
60
61		/**
62		* @var \TYPO3\CMS\Extensionmanager\Utility\ListUtility $extensionList
63		*/
64		public $listUtility;
65
66		/**
67		* @var \TYPO3\CMS\Extensionmanager\Utility\InstallUtility $installUtility
68		*/
69		protected $installUtility;
70
71		/**
72		* @var \TYPO3\CMS\Extensionmanager\Domain\Repository\RepositoryRepository $repositoryRepository
73		*/
74		protected $repositoryRepository;
75
76		/**
77		* @var Helper $repositoryHelper
78		*/
79		protected $repositoryHelper;
80
81		/**
82		* @var ExtensionRepository $extensionRepository
83		*/
84		protected $extensionRepository;
85
86		/**
87		* @var ExtensionManagementService $extensionManagementService
88		*/
89		protected $extensionManagementService;
90
91		/**
92		* @var ObjectManagerInterface $objectManager
93		*/
94		protected $objectManager;
95
96		/**
97		* @var \TYPO3\CMS\Extensionmanager\Utility\FileHandlingUtility $fileHandlingUtility
98		*/
99		protected $fileHandlingUtility;
100
101		/**
102		* @var \TYPO3\CMS\Extensionmanager\Utility\EmConfUtility $emConfUtility
103		*/
104		protected $emConfUtility;
105
106		/**
107		* @param \TYPO3\CMS\Extensionmanager\Utility\FileHandlingUtility $fileHandlingUtility
108		*
109		* @return void
110		*/
111		public function injectFileHandlingUtility(FileHandlingUtility $fileHandlingUtility) {
112		$this->fileHandlingUtility = $fileHandlingUtility;
113		}
114
115		/**
116		* @param \TYPO3\CMS\Extensionmanager\Utility\InstallUtility $installUtility
117		*
118		* @return void
119		*/
120		public function injectInstallUtility(InstallUtility $installUtility) {
121		$this->installUtility = $installUtility;
122		}
123
124		/**
125		* @param RepositoryRepository $repositoryRepository
126		*
127		* @return void
128		*/
129		public function injectRepositoryRepository(RepositoryRepository $repositoryRepository) {
130		$this->repositoryRepository = $repositoryRepository;
131		}
132
133		/**
134		* @param Helper $repositoryHelper
135		*
136		* @return void
137		*/
138		public function injectRepositoryHelper(Helper $repositoryHelper) {
139		$this->repositoryHelper = $repositoryHelper;
140		}
141
142		/**
143		* @param ExtensionRepository $extensionRepository
144		*
145		* @return void
146		*/
147		public function injectExtensionRepository(ExtensionRepository $extensionRepository){
148		$this->extensionRepository = $extensionRepository;
149		}
150
151		/**
152		* @param ExtensionManagementService $extensionManagementService
153		*
154		* @return void
155		*/
156		public function injectExtensionManagementService(ExtensionManagementService $extensionManagementService) {
157		$this->extensionManagementService = $extensionManagementService;
158		}
159
160		/**
161		* @param ObjectManagerInterface $objectManager
162		*
163		* @return void
164		*/
165		public function injectObjectManager(ObjectManagerInterface $objectManager) {
166		$this->objectManager = $objectManager;
167		}
168
169		/**
170		* The constructor
171		*/
172		public function __construct() {
173		$this->configurationManager = GeneralUtility::makeInstance('TYPO3\\CMS\\Core\\Configuration\\ConfigurationManager');
174		}
175
176		/**
177		* Get information about an extension.
178		*
179		* @param string $extensionKey extension key
180		*
181		* @throws InvalidArgumentException
182		* @return array
183		*/
184	3	public function getExtensionInformation($extensionKey) {
185	3	if (strlen($extensionKey) === 0) {
186	1	throw new InvalidArgumentException('No extension key given!');
187		}
188
189	2	$this->checkExtensionExists($extensionKey);
190
191	1	$extensions = $this->listExtensions();
192
193		$information = array(
194	1	'em_conf' => $extensions[$extensionKey],
195	1	'is_installed' => $this->installUtility->isLoaded($extensionKey)
196	1	);
197
198	1	return $information;
199		}
200
201		/**
202		* Get array of installed extensions.
203		*
204		* @param string $type Local, System, Global or empty (for all)
205		*
206		* @throws InvalidArgumentException
207		* @return array
208		*/
209	4	public function listExtensions($type = '') {
210	4	$type = ucfirst(strtolower($type));
211	4	if (!empty($type) && $type !== 'Local' && $type !== 'Global' && $type !== 'System') {
212	1	throw new InvalidArgumentException('Only "Local", "System", "Global" and "" (all) are supported as type');
213		}
214
215	3	$this->initializeExtensionManagerObjects();
216
217		// TODO: Make listUtlity local var
218	3	$extensions = $this->listUtility->getAvailableExtensions();
219
220	3	$list = array();
221
222	3	foreach ($extensions as $key => $extension) {
223	3	if ((!empty($type) && $type !== $extension['type'])
224	3	\|\| (!$this->installUtility->isLoaded($extension['key']))
225	3	) {
226	3	continue;
227		}
228
229		// TODO: Make emConfUtility local var
230	3	$configuration = $this->emConfUtility->includeEmConf($extension);
231	3	if (!empty($configuration)) {
232	3	$list[$key] = $configuration;
233	3	}
234	3	}
235	3	ksort($list);
236
237	3	return $list;
238		}
239
240		/**
241		* Update the mirrors, using the scheduler task of EXT:em.
242		*
243		* @throws RuntimeException
244		* @return boolean
245		*/
246	2	public function updateMirrors() {
247	2	$result = FALSE;
248	2	$repositories = $this->repositoryRepository->findAll();
249
250		// update all repositories
251	2	foreach ($repositories as $repository) {
252	2	$this->repositoryHelper->setRepository($repository);
253	2	$result = $this->repositoryHelper->updateExtList();
254	2	unset($objRepository, $this->repositoryHelper);
255	2	}
256
257	2	return $result;
258		}
259
260		/**
261		* Install (load) an extension.
262		*
263		* @param string $extensionKey extension key
264		*
265		* @throws RuntimeException
266		* @throws InvalidArgumentException
267		* @return void
268		*/
269	2	public function installExtension($extensionKey) {
270	2	$this->checkExtensionExists($extensionKey);
271
272	1	$this->installUtility->install($extensionKey);
273	1	}
274
275		/**
276		* Uninstall (unload) an extension.
277		*
278		* @param string $extensionKey extension key
279		*
280		* @throws RuntimeException
281		* @throws InvalidArgumentException
282		* @return void
283		*/
284	3	public function uninstallExtension($extensionKey) {
285	3	if ($extensionKey === 'coreapi') {
286	1	throw new InvalidArgumentException('Extension "coreapi" cannot be uninstalled!');
287		}
288
289	2	$this->checkExtensionExists($extensionKey);
290	1	$this->checkExtensionLoaded($extensionKey);
291
292	1	$this->installUtility->uninstall($extensionKey);
293	1	}
294
295
296		/**
297		* Configure an extension.
298		*
299		* @param string $extensionKey The extension key
300		* @param array $newExtensionConfiguration
301		*
302		* @throws RuntimeException
303		* @throws InvalidArgumentException
304		* @return void
305		*/
306	8	public function configureExtension($extensionKey, $newExtensionConfiguration = array()) {
307	8	$this->checkExtensionExists($extensionKey);
308	7	$this->checkExtensionLoaded($extensionKey);
309
310		// checks if conf array is empty
311	6	if (empty($newExtensionConfiguration)) {
312	1	throw new InvalidArgumentException(sprintf('No configuration provided for extension "%s"!', $extensionKey));
313		}
314
315		// check if extension can be configured
316	5	$extAbsPath = $this->getExtensionPath($extensionKey);
317	5	$extConfTemplateFile = $extAbsPath . 'ext_conf_template.txt';
318	5	if (!file_exists($extConfTemplateFile)) {
319	1	throw new InvalidArgumentException(sprintf('Extension "%s" has no configuration options!', $extensionKey));
320		}
321
322		/** @var $configurationUtility \TYPO3\CMS\Extensionmanager\Utility\ConfigurationUtility */
323	4	$configurationUtility = $this->objectManager->get('TYPO3\\CMS\\Extensionmanager\\Utility\\ConfigurationUtility');
324		// get existing configuration
325	4	$currentExtensionConfig = $configurationUtility->getCurrentConfiguration($extensionKey);
326
327		// check for unknown configuration settings
328	4	foreach ($newExtensionConfiguration as $key => $_) {
329	4	if (!isset($currentExtensionConfig[$key])) {
330	1	throw new InvalidArgumentException(sprintf('No configuration setting with name "%s" for extension "%s"!', $key, $extensionKey));
331		}
332	3	}
333
334		// fill with missing values
335	3	$newExtensionConfiguration = $this->mergeNewExtensionConfiguratonWithCurrentConfiguration(
336	3	$newExtensionConfiguration,
337		$currentExtensionConfig
338	3	);
339
340		// write configuration to typo3conf/LocalConfiguration.php
341	3	$configurationUtility->writeConfiguration($newExtensionConfiguration, $extensionKey);
342	3	}
343
344		/**
345		* Fetch an extension from TER.
346		*
347		* @param string $extensionKey The extension key
348		* @param string $location Where to import the extension. System = typo3/sysext, Global = typo3/ext, Local = typo3conf/ext
349		* @param bool $overwrite Overwrite the extension if it already exists
350		* @param int $mirror The mirror to fetch the extension from
351		*
352		* @throws \RuntimeException
353		* @throws \InvalidArgumentException
354		* @return array
355		*/
356	13	public function fetchExtension($extensionKey, $version = '', $location = 'Local', $overwrite = FALSE, $mirror = -1) {
		0 ignored issues – show Complexity introduced 2016-02-08 13:46 UTC by Report Bug Copy Issue Report This operation has 384 execution paths which exceeds the configured maximum of 200. A high number of execution paths generally suggests many nested conditional statements and make the code less readible. This can usually be fixed by splitting the method into several smaller methods. You can also find more information in the “Code” section of your repository. Loading history...
357	13	if (!is_numeric($mirror)) {
358	1	throw new InvalidArgumentException('Option --mirror must be a number. Run the command extensionapi:listmirrors to get the list of all available repositories');
359		}
360
361	12	if ($version === '') {
362	6	$extension = $this->extensionRepository->findHighestAvailableVersion($extensionKey);
363	6	if ($extension === NULL) {
364	1	throw new InvalidArgumentException(sprintf('Extension "%s" was not found on TER', $extensionKey));
365		}
366	5	} else {
367	6	$extension = $this->extensionRepository->findOneByExtensionKeyAndVersion($extensionKey, $version);
368	6	if ($extension === NULL) {
369	1	throw new InvalidArgumentException(sprintf('Version %s of extension "%s" does not exist', $version, $extensionKey));
370		}
371		}
372
373	10	if (!$overwrite) {
374	10	$comingExtPath = $this->fileHandlingUtility->getExtensionDir($extensionKey, $location);
375	10	if (@is_dir($comingExtPath)) {
376	1	throw new InvalidArgumentException(sprintf('Extension "%s" already exists at "%s"!', $extensionKey, $comingExtPath));
377		}
378	9	}
379
380	9	$mirrors = $this->repositoryHelper->getMirrors();
381
382	9	if ($mirrors === NULL) {
383	1	throw new RuntimeException('No mirrors found!');
384		}
385
386	8	if ($mirror === -1) {
387	6	$mirrors->setSelect();
388	8	} elseif ($mirror > 0 && $mirror <= count($mirrors->getMirrors())) {
389	1	$mirrors->setSelect($mirror);
390	1	} else {
391	1	throw new InvalidArgumentException(sprintf('Mirror "%s" does not exist', $mirror));
392		}
393
394		/**
395		* @var \TYPO3\CMS\Extensionmanager\Utility\DownloadUtility $downloadUtility
396		*/
397	7	$downloadUtility = $this->objectManager->get('TYPO3\\CMS\\Extensionmanager\\Utility\\DownloadUtility');
398	7	$downloadUtility->setDownloadPath($location);
399
400	3	$this->extensionManagementService->downloadMainExtension($extension);
401
402	3	$return = array();
403	3	$extensionDir = $this->fileHandlingUtility->getExtensionDir($extensionKey, $location);
404	3	if (is_dir($extensionDir)) {
405	3	$return['main']['extKey'] = $extension->getExtensionKey();
406	3	$return['main']['version'] = $extension->getVersion();
407	3	} else {
408		throw new RuntimeException(
409		sprintf('Extension "%s" version %s could not installed!', $extensionKey, $extension->getVersion())
410		);
411		}
412
413	3	return $return;
414		}
415
416		/**
417		* Lists the possible mirrors
418		*
419		* @return array
420		*/
421	1	public function listMirrors() {
422		/** @var $repositoryHelper Helper */
423	1	$repositoryHelper = $this->objectManager->get('TYPO3\\CMS\\Extensionmanager\\Utility\\Repository\\Helper');
424	1	$mirrors = $repositoryHelper->getMirrors();
425
426	1	return $mirrors->getMirrors();
427		}
428
429		/**
430		* Extracts and returns the file content of the given file
431		*
432		* @param string $file The file with file path
433		*
434		* @return array
435		*/
436		protected function getFileContentFromUrl($file) {
437		return GeneralUtility::getUrl($file);
438		}
439
440		/**
441		* Imports extension from file.
442		*
443		* @param string $file Path to t3x file
444		* @param string $location Where to import the extension. System = typo3/sysext, Global = typo3/ext, Local = typo3conf/ext
445		* @param bool $overwrite Overwrite the extension if it already exists
446		*
447		* @throws \RuntimeException
448		* @throws \InvalidArgumentException
449		* @return array The extension data
450		*/
451	8	public function importExtension($file, $location = 'Local', $overwrite = FALSE) {
452	8	if (!is_file($file)) {
453	1	throw new InvalidArgumentException(sprintf('File "%s" does not exist!', $file));
454		}
455
456	7	$this->checkInstallLocation($location);
457
458	6	$uploadExtensionFileController = $this->objectManager->get('TYPO3\\CMS\\Extensionmanager\\Controller\\UploadExtensionFileController');
459
460	6	$filename = pathinfo($file, PATHINFO_BASENAME);
461	6	$return = $uploadExtensionFileController->extractExtensionFromFile($file, $filename, $overwrite, FALSE);
462
463	2	return $return;
464		}
465
466		/**
467		* Checks if the function exists in the system
468		*
469		* @param string $extensionKey The extension key
470		*
471		* @return void
472		* @throws \InvalidArgumentException
473		*/
474		protected function checkExtensionExists($extensionKey) {
475		if (!$this->installUtility->isAvailable($extensionKey)) {
476		throw new InvalidArgumentException(sprintf('Extension "%s" does not exist!', $extensionKey));
477		}
478		}
479
480		/**
481		* Check if an extension is loaded.
482		*
483		* @param string $extensionKey The extension key
484		*
485		* @throws \InvalidArgumentException
486		* @return void
487		*/
488		protected function checkExtensionLoaded($extensionKey) {
489		if (!$this->installUtility->isLoaded($extensionKey)) {
490		throw new InvalidArgumentException(sprintf('Extension "%s" is not installed!', $extensionKey));
491		}
492		}
493
494		/**
495		* Returns the absolute extension path.
496		* Wrapper around the static method. This makes the method mockable.
497		*
498		* @param string $extensionKey The extension key
499		*
500		* @return string
501		*/
502		protected function getExtensionPath($extensionKey) {
503		return ExtensionManagementUtility::extPath($extensionKey);
504		}
505
506		/**
507		* Add missing values from current configuration to the new configuration
508		*
509		* @param array $newExtensionConfiguration The new configuration which was provided as argument
510		* @param array $currentExtensionConfig The current configuration of the extension
511		*
512		* @return array The merged configuration
513		*/
514		protected function mergeNewExtensionConfiguratonWithCurrentConfiguration($newExtensionConfiguration, $currentExtensionConfig) {
515		foreach (array_keys($currentExtensionConfig) as $key) {
516		if (!isset($newExtensionConfiguration[$key])) {
517		if (!empty($currentExtensionConfig[$key]['value'])) {
518		$newExtensionConfiguration[$key] = $currentExtensionConfig[$key]['value'];
519		} else {
520		$newExtensionConfiguration[$key] = $currentExtensionConfig[$key]['default_value'];
521		}
522		}
523		}
524
525		return $newExtensionConfiguration;
526		}
527
528		/**
529		* Checks if the extension is able to install at the demanded location
530		*
531		* @param string $location The location
532		* @param array $allowedInstallTypes The allowed locations
		0 ignored issues – show Bug introduced 2016-01-11 11:05 UTC by Report Bug Copy Issue Report There is no parameter named `$allowedInstallTypes`. Was it maybe removed? This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function. Consider the following example. The parameter `$italy` is not defined by the method `finale(...)`. /** * @param array $germany * @param array $island * @param array $italy */ function finale($germany, $island) { return "2:1"; } The most likely cause is that the parameter was removed, but the annotation was not. Loading history...
533		*
534		* @return boolean
535		* @throws \InvalidArgumentException
536		*/
537		protected function checkInstallLocation($location) {
538		$allowedInstallTypes = Extension::returnAllowedInstallTypes();
539		$location = ucfirst(strtolower($location));
540
541		if (!in_array($location, $allowedInstallTypes)) {
542		if ($location === 'Global') {
543		throw new InvalidArgumentException('Global installation is not allowed!');
544		}
545		if ($location === 'Local') {
546		throw new InvalidArgumentException('Local installation is not allowed!');
547		}
548		if ($location === 'System') {
549		throw new InvalidArgumentException('System installation is not allowed!');
550		}
551		throw new InvalidArgumentException(sprintf('Unknown location "%s"!', $location));
552		}
553		}
554
555		/**
556		* Initialize ExtensionManager Objects.
557		*
558		* @return void
559		*/
560		protected function initializeExtensionManagerObjects() {
561		$this->listUtility = $this->objectManager->get('TYPO3\\CMS\\Extensionmanager\\Utility\\ListUtility');
562		$this->emConfUtility = $this->objectManager->get('TYPO3\\CMS\\Extensionmanager\\Utility\\EmConfUtility');
563		}
564
565		/**
566		* Clear the caches.
567		*
568		* @return void
569		*/
570		protected function clearCaches() {
571		$cacheApiService = GeneralUtility::makeInstance('Etobi\\CoreAPI\\Service\\CacheApiService');
572		$cacheApiService->initializeObject();
573		$cacheApiService->clearAllCaches();
574		}
575		}
576

TYPO3-coreapi / ext-coreapi

ExtensionApiService::checkInstallLocation() B last analyzed 2016-03-15 10:28 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

ExtensionApiService::checkInstallLocation() B
last analyzed 2016-03-15 10:28 UTC