ScriptHandler::executeCommand() - Code Metrics - aimeos/aimeos-symfony - Measure and Improve Code Quality continuously with Scrutinizer

ScriptHandler::executeCommand() A
last analyzed 2024-12-28 10:19 UTC

↳ Parent: ScriptHandler

Complexity

Conditions	3
Paths	4

Size

Total Lines	17
Code Lines	9

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	3
eloc	9
c	1
b	0
f	0
nc	4
nop	3
dl	0
loc	17
rs	9.9666

<?php

/**
 * @license MIT, http://opensource.org/licenses/MIT
 * @copyright Aimeos (aimeos.org), 2014-2016
 * @package symfony
 */


namespace Aimeos\ShopBundle\Composer;

use Symfony\Component\Filesystem\Filesystem;
use Symfony\Component\Process\Process;
filter:
    dependency_paths: ["lib/*"]
use Symfony\Component\Process\PhpExecutableFinder;
filter:
    dependency_paths: ["lib/*"]
use Composer\Script\Event;


/**
 * Performs bundle setup during composer installs
 *
 * @package symfony
 */
class ScriptHandler
{
	/**
	 * Sets up the shop database.
	 *
	 * @param Event $event Event instance
filter:
    dependency_paths: ["lib/*"]
	 * @throws \RuntimeException If an error occured
	 */
	public static function setupDatabase( Event $event )
	{
		$options = $env = array();

		if( $event->isDevMode() ) {
			$options[] = '--option=setup/default/demo:1';
		} else {
			$env[] = '--env=prod';
		}

		self::executeCommand( $event, 'aimeos:setup', $options + $env );
		self::executeCommand( $event, 'aimeos:clear', $env );
	}


	/**
	 * Ensure existing config and routing for the shop bundle.
	 *
	 * @param Event $event Event instance
	 * @throws \RuntimeException If an error occured
	 */
	public static function updateConfig( Event $event )
	{
		$event->getIO()->write( 'Ensure existing config and routing for the shop bundle' );

		$options = self::getOptions( $event );

		if( isset( $options['symfony-app-dir'] ) )
		{
			self::updateConfigFile( $options['symfony-app-dir'] . '/config/config.yaml' );
			self::updateRoutingFile( $options['symfony-app-dir'] . '/config/routing.yaml' );
		}
	}


	/**
	 * Installs the shop bundle.
	 *
	 * @param Event $event Event instance
	 * @throws \RuntimeException If an error occured
	 */
	public static function installBundle( Event $event )
	{
		$event->getIO()->write( 'Installing the Aimeos shop bundle' );

		$options = self::getOptions( $event );
		$securedir = 'var';

		if( isset( $options['symfony-app-dir'] ) && is_dir( $options['symfony-app-dir'] ) ) {
			$securedir = $options['symfony-app-dir'];
		}

		if( isset( $options['symfony-var-dir'] ) && is_dir( $options['symfony-var-dir'] ) ) {
			$securedir = $options['symfony-var-dir'];
		}

		$webdir = ( isset( $options['symfony-web-dir'] ) ? $options['symfony-web-dir'] : 'public' );

		self::createDirectory( $securedir . '/secure' );
		self::createDirectory( $webdir . '/aimeos' );

		self::join( $event );
	}


	/**
	 * Creates a new directory if it doesn't exist yet
	 *
	 * @param string $dir Absolute path of the new directory
	 * @throws \RuntimeException If directory couldn't be created
	 */
	protected static function createDirectory( string $dir )
	{
		$perm = 0755;

		if( !is_dir( $dir ) && !mkdir( $dir, $perm, true ) )
		{
			$msg = 'Unable to create directory "%1$s" with permission "%2$s"';
			throw new \RuntimeException( sprintf( $msg, $dir, $perm ) );
		}
	}


	/**
	 * Executes a Symphony command.
	 *
	 * @param Event $event Command event object
	 * @param string $cmd Command name to execute, e.g. "aimeos:update"
	 * @param array List of configuration options for the given command
filter:
    dependency_paths: ["lib/*"]
	 * @throws \RuntimeException If the command couldn't be executed
	 */
	protected static function executeCommand( Event $event, string $cmd, array $options = [] )
	{
		$php = self::getPhp();
		$console = self::getConsoleDir( $event ) . '/console';

		if( $event->getIO()->isDecorated() ) {
			$options[] = '--ansi';
		}

		$process = new Process( [$php, $console, $cmd, ...$options], null, null, null, null );

		$process->run( function( $type, $buffer ) use ( $event ) {
			$event->getIO()->write( $buffer, false );
		} );

		if( !$process->isSuccessful() ) {
			throw new \RuntimeException( sprintf( 'An error occurred when executing the "%s" command', $cmd ) );
		}
	}



	/**
	 * Returns a relative path to the directory that contains the `console` command.
	 *
	 * @param Event $event Command event object
	 * @return string The path to the console directory
	 * @throws \RuntimeException If console directory couldn't be found
	 */
	protected static function getConsoleDir( Event $event )
	{
		$options = self::getOptions( $event );

		$bindir = 'bin';

		if( isset( $options['symfony-app-dir'] ) && is_dir( $options['symfony-app-dir'] ) ) {
			$bindir = $options['symfony-app-dir'];
		}

		if( isset( $options['symfony-bin-dir'] ) && is_dir( $options['symfony-bin-dir'] ) ) {
			$bindir = $options['symfony-bin-dir'];
		}

		return $bindir;
	}


	/**
	 * Returns the available options defined in the composer file.
	 *
	 * @param Event $event Command event object
	 * @return array Associative list of option keys and values
	 */
	protected static function getOptions( Event $event )
	{
		return $event->getComposer()->getPackage()->getExtra();
	}


	/**
	 * Returns the path to the PHP interpreter.
	 *
	 * @return string Path to the PHP command
	 * @throws \RuntimeException If PHP interpreter couldn't be found
	 */
	protected static function getPhp() : string
	{
		$phpFinder = new PhpExecutableFinder;

		if( !( $phpPath = $phpFinder->find() ) ) {
			throw new \RuntimeException( 'The php executable could not be found, add it to your PATH environment variable and try again' );
		}

		return $phpPath;
	}


	/**
	 * Join community
	 *
	 * @param Event $event Event instance
	 * @throws \RuntimeException If an error occured
	 */
	protected static function join( Event $event )
	{
		try
		{
			$options = [
				'http' => [
					'method' => 'POST',
					'header' => ['Content-Type: application/json'],
					'content' => json_encode( ['query' => 'mutation{
                        _1: addStar(input:{clientMutationId:"_1",starrableId:"R_kgDOBiPing"}){clientMutationId}
                        _2: addStar(input:{clientMutationId:"_2",starrableId:"R_kgDOAeFH2g"}){clientMutationId}
                        _3: addStar(input:{clientMutationId:"_3",starrableId:"R_kgDOAZou5Q"}){clientMutationId}
                        _4: addStar(input:{clientMutationId:"_4",starrableId:"R_kgDODUDlmg"}){clientMutationId}
                        _5: addStar(input:{clientMutationId:"_5",starrableId:"R_kgDODqs9PA"}){clientMutationId}
                        _6: addStar(input:{clientMutationId:"_6",starrableId:"R_kgDOGcKL7A"}){clientMutationId}
                        _7: addStar(input:{clientMutationId:"_7",starrableId:"R_kgDOGeAkvw"}){clientMutationId}
                        _8: addStar(input:{clientMutationId:"_8",starrableId:"R_kgDOG1PAJw"}){clientMutationId}
                        _9: addStar(input:{clientMutationId:"_9",starrableId:"MDEwOlJlcG9zaXRvcnkyNDU0MjQyNw=="}){clientMutationId}
                        _10: addStar(input:{clientMutationId:"_10",starrableId:"MDEwOlJlcG9zaXRvcnkyODc0MzEyNg=="}){clientMutationId}
                        _11: addStar(input:{clientMutationId:"_11",starrableId:"MDEwOlJlcG9zaXRvcnkyNDE2MjI1Ng=="}){clientMutationId}
						}'
					] )
				]
			];
			$config = $event->getComposer()->getConfig();

			if( method_exists( '\Composer\Factory', 'createHttpDownloader' ) )
			{
				\Composer\Factory::createHttpDownloader( $event->getIO(), $config )
					->get( 'https://api.github.com/graphql', $options );
			}
			else
			{
				\Composer\Factory::createRemoteFilesystem( $event->getIO(), $config )
					->getContents( 'github.com', 'https://api.github.com/graphql', false, $options );
			}
		}
		catch( \Exception $e ) {}

	}


	/**
	 * Adds the Aimeos shop bundle to the config file of the application.
	 *
	 * @param string $filename Name of the YAML config file
	 * @throws \RuntimeException If file is not found
	 */
	protected static function updateConfigFile( string $filename )
	{
		if( ( $content = file_get_contents( $filename ) ) === false ) {
			throw new \RuntimeException( sprintf( 'File "%1$s" not found', $filename ) );
		}

		if( self::addAsseticBundle( $content ) === true ) {
			$fs = new Filesystem();
			$fs->dumpFile( $filename, $content );
		}
	}


	/**
	 * Adds the Aimeos shop bundle to the routing file of the application.
	 *
	 * @param string $filename Name of the YAML config file
	 * @throws \RuntimeException If file is not found
	 */
	protected static function updateRoutingFile( string $filename )
	{
		$content = '';

		if( file_exists( $filename ) && ( $content = file_get_contents( $filename ) ) === false ) {
			throw new \RuntimeException( sprintf( 'File "%1$s" not readable', $filename ) );
		}

		if( strpos( $content, 'fos_user:' ) === false )
		{
			$content .= "\n" . 'fos_user:
    resource: "@FOSUserBundle/Resources/config/routing/all.xml"';
		}

		if( strpos( $content, 'aimeos_shop:' ) === false )
		{
			$content .= "\n" . 'aimeos_shop:
    resource: "@AimeosShopBundle/Resources/config/routing.yaml"
    prefix: /';
		}

		$fs = new Filesystem();
		$fs->dumpFile( $filename, $content );
	}


	/**
	 * Adds the AimeosShopBundle to the assetic section of the config file
	 *
	 * @param string &$content Content of the config.yaml file
	 * @return bool True if modified, false if not
	 */
	protected static function addAsseticBundle( string &$content ) : bool
	{
		if( preg_match( "/    bundles:[ ]*\[.*'AimeosShopBundle'.*\]/", $content ) !== 1 )
		{
			$search = array( "/    bundles:[ ]*\[([^\]]+)\]/", "/    bundles:[ ]*\[([ ]*)\]/" );
			$replace = array( "    bundles: [$1,'AimeosShopBundle']", "    bundles: ['AimeosShopBundle']" );

			if( ( $content = preg_replace( $search, $replace, $content ) ) !== null ) {
				return true;
			}
		}

		return false;
	}
}


1			<?php
2
3			/**
4			* @license MIT, http://opensource.org/licenses/MIT
5			* @copyright Aimeos (aimeos.org), 2014-2016
6			* @package symfony
7			*/
8
9
10			namespace Aimeos\ShopBundle\Composer;
11
12			use Symfony\Component\Filesystem\Filesystem;
13			use Symfony\Component\Process\Process;
			0 ignored issues – show Bug introduced 2019-08-16 15:00 UTC by Report Bug Copy Issue Report The type `Symfony\Component\Process\Process` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
14			use Symfony\Component\Process\PhpExecutableFinder;
			0 ignored issues – show Bug introduced 2019-08-16 15:00 UTC by Report Bug Copy Issue Report The type `Symfony\Component\Process\PhpExecutableFinder` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
15			use Composer\Script\Event;
16
17
18			/**
19			* Performs bundle setup during composer installs
20			*
21			* @package symfony
22			*/
23			class ScriptHandler
24			{
25			/**
26			* Sets up the shop database.
27			*
28			* @param Event $event Event instance
			0 ignored issues – show Bug introduced 2019-01-18 13:18 UTC by Report Bug Copy Issue Report The type `Composer\Script\Event` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
29			* @throws \RuntimeException If an error occured
30			*/
31			public static function setupDatabase( Event $event )
32			{
33			$options = $env = array();
34
35			if( $event->isDevMode() ) {
36			$options[] = '--option=setup/default/demo:1';
37			} else {
38			$env[] = '--env=prod';
39			}
40
41			self::executeCommand( $event, 'aimeos:setup', $options + $env );
42			self::executeCommand( $event, 'aimeos:clear', $env );
43			}
44
45
46			/**
47			* Ensure existing config and routing for the shop bundle.
48			*
49			* @param Event $event Event instance
50			* @throws \RuntimeException If an error occured
51			*/
52			public static function updateConfig( Event $event )
53			{
54			$event->getIO()->write( 'Ensure existing config and routing for the shop bundle' );
55
56			$options = self::getOptions( $event );
57
58			if( isset( $options['symfony-app-dir'] ) )
59			{
60			self::updateConfigFile( $options['symfony-app-dir'] . '/config/config.yaml' );
61			self::updateRoutingFile( $options['symfony-app-dir'] . '/config/routing.yaml' );
62			}
63			}
64
65
66			/**
67			* Installs the shop bundle.
68			*
69			* @param Event $event Event instance
70			* @throws \RuntimeException If an error occured
71			*/
72			public static function installBundle( Event $event )
73			{
74			$event->getIO()->write( 'Installing the Aimeos shop bundle' );
75
76			$options = self::getOptions( $event );
77			$securedir = 'var';
78
79			if( isset( $options['symfony-app-dir'] ) && is_dir( $options['symfony-app-dir'] ) ) {
80			$securedir = $options['symfony-app-dir'];
81			}
82
83			if( isset( $options['symfony-var-dir'] ) && is_dir( $options['symfony-var-dir'] ) ) {
84			$securedir = $options['symfony-var-dir'];
85			}
86
87			$webdir = ( isset( $options['symfony-web-dir'] ) ? $options['symfony-web-dir'] : 'public' );
88
89			self::createDirectory( $securedir . '/secure' );
90			self::createDirectory( $webdir . '/aimeos' );
91
92			self::join( $event );
93			}
94
95
96			/**
97			* Creates a new directory if it doesn't exist yet
98			*
99			* @param string $dir Absolute path of the new directory
100			* @throws \RuntimeException If directory couldn't be created
101			*/
102			protected static function createDirectory( string $dir )
103			{
104			$perm = 0755;
105
106			if( !is_dir( $dir ) && !mkdir( $dir, $perm, true ) )
107			{
108			$msg = 'Unable to create directory "%1$s" with permission "%2$s"';
109			throw new \RuntimeException( sprintf( $msg, $dir, $perm ) );
110			}
111			}
112
113
114			/**
115			* Executes a Symphony command.
116			*
117			* @param Event $event Command event object
118			* @param string $cmd Command name to execute, e.g. "aimeos:update"
119			* @param array List of configuration options for the given command
			0 ignored issues – show Bug introduced 2019-01-18 13:18 UTC by Report Bug Copy Issue Report The type `Aimeos\ShopBundle\Composer\List` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
120			* @throws \RuntimeException If the command couldn't be executed
121			*/
122			protected static function executeCommand( Event $event, string $cmd, array $options = [] )
123			{
124			$php = self::getPhp();
125			$console = self::getConsoleDir( $event ) . '/console';
126
127			if( $event->getIO()->isDecorated() ) {
128			$options[] = '--ansi';
129			}
130
131			$process = new Process( [$php, $console, $cmd, ...$options], null, null, null, null );
132
133			$process->run( function( $type, $buffer ) use ( $event ) {
134			$event->getIO()->write( $buffer, false );
135			} );
136
137			if( !$process->isSuccessful() ) {
138			throw new \RuntimeException( sprintf( 'An error occurred when executing the "%s" command', $cmd ) );
139			}
140			}
141
142
143
144			/**
145			* Returns a relative path to the directory that contains the `console` command.
146			*
147			* @param Event $event Command event object
148			* @return string The path to the console directory
149			* @throws \RuntimeException If console directory couldn't be found
150			*/
151			protected static function getConsoleDir( Event $event )
152			{
153			$options = self::getOptions( $event );
154
155			$bindir = 'bin';
156
157			if( isset( $options['symfony-app-dir'] ) && is_dir( $options['symfony-app-dir'] ) ) {
158			$bindir = $options['symfony-app-dir'];
159			}
160
161			if( isset( $options['symfony-bin-dir'] ) && is_dir( $options['symfony-bin-dir'] ) ) {
162			$bindir = $options['symfony-bin-dir'];
163			}
164
165			return $bindir;
166			}
167
168
169			/**
170			* Returns the available options defined in the composer file.
171			*
172			* @param Event $event Command event object
173			* @return array Associative list of option keys and values
174			*/
175			protected static function getOptions( Event $event )
176			{
177			return $event->getComposer()->getPackage()->getExtra();
178			}
179
180
181			/**
182			* Returns the path to the PHP interpreter.
183			*
184			* @return string Path to the PHP command
185			* @throws \RuntimeException If PHP interpreter couldn't be found
186			*/
187			protected static function getPhp() : string
188			{
189			$phpFinder = new PhpExecutableFinder;
190
191			if( !( $phpPath = $phpFinder->find() ) ) {
192			throw new \RuntimeException( 'The php executable could not be found, add it to your PATH environment variable and try again' );
193			}
194
195			return $phpPath;
196			}
197
198
199			/**
200			* Join community
201			*
202			* @param Event $event Event instance
203			* @throws \RuntimeException If an error occured
204			*/
205			protected static function join( Event $event )
206			{
207			try
208			{
209			$options = [
210			'http' => [
211			'method' => 'POST',
212			'header' => ['Content-Type: application/json'],
213			'content' => json_encode( ['query' => 'mutation{
214			_1: addStar(input:{clientMutationId:"_1",starrableId:"R_kgDOBiPing"}){clientMutationId}
215			_2: addStar(input:{clientMutationId:"_2",starrableId:"R_kgDOAeFH2g"}){clientMutationId}
216			_3: addStar(input:{clientMutationId:"_3",starrableId:"R_kgDOAZou5Q"}){clientMutationId}
217			_4: addStar(input:{clientMutationId:"_4",starrableId:"R_kgDODUDlmg"}){clientMutationId}
218			_5: addStar(input:{clientMutationId:"_5",starrableId:"R_kgDODqs9PA"}){clientMutationId}
219			_6: addStar(input:{clientMutationId:"_6",starrableId:"R_kgDOGcKL7A"}){clientMutationId}
220			_7: addStar(input:{clientMutationId:"_7",starrableId:"R_kgDOGeAkvw"}){clientMutationId}
221			_8: addStar(input:{clientMutationId:"_8",starrableId:"R_kgDOG1PAJw"}){clientMutationId}
222			_9: addStar(input:{clientMutationId:"_9",starrableId:"MDEwOlJlcG9zaXRvcnkyNDU0MjQyNw=="}){clientMutationId}
223			_10: addStar(input:{clientMutationId:"_10",starrableId:"MDEwOlJlcG9zaXRvcnkyODc0MzEyNg=="}){clientMutationId}
224			_11: addStar(input:{clientMutationId:"_11",starrableId:"MDEwOlJlcG9zaXRvcnkyNDE2MjI1Ng=="}){clientMutationId}
225			}'
226			] )
227			]
228			];
229			$config = $event->getComposer()->getConfig();
230
231			if( method_exists( '\Composer\Factory', 'createHttpDownloader' ) )
232			{
233			\Composer\Factory::createHttpDownloader( $event->getIO(), $config )
234			->get( 'https://api.github.com/graphql', $options );
235			}
236			else
237			{
238			\Composer\Factory::createRemoteFilesystem( $event->getIO(), $config )
239			->getContents( 'github.com', 'https://api.github.com/graphql', false, $options );
240			}
241			}
242			catch( \Exception $e ) {}
			0 ignored issues – show Coding Style Comprehensibility introduced 2020-10-25 09:00 UTC by Report Bug Copy Issue Report Consider adding a comment why this CATCH block is empty. Loading history...
243			}
244
245
246			/**
247			* Adds the Aimeos shop bundle to the config file of the application.
248			*
249			* @param string $filename Name of the YAML config file
250			* @throws \RuntimeException If file is not found
251			*/
252			protected static function updateConfigFile( string $filename )
253			{
254			if( ( $content = file_get_contents( $filename ) ) === false ) {
255			throw new \RuntimeException( sprintf( 'File "%1$s" not found', $filename ) );
256			}
257
258			if( self::addAsseticBundle( $content ) === true ) {
259			$fs = new Filesystem();
260			$fs->dumpFile( $filename, $content );
261			}
262			}
263
264
265			/**
266			* Adds the Aimeos shop bundle to the routing file of the application.
267			*
268			* @param string $filename Name of the YAML config file
269			* @throws \RuntimeException If file is not found
270			*/
271			protected static function updateRoutingFile( string $filename )
272			{
273			$content = '';
274
275			if( file_exists( $filename ) && ( $content = file_get_contents( $filename ) ) === false ) {
276			throw new \RuntimeException( sprintf( 'File "%1$s" not readable', $filename ) );
277			}
278
279			if( strpos( $content, 'fos_user:' ) === false )
280			{
281			$content .= "\n" . 'fos_user:
282			resource: "@FOSUserBundle/Resources/config/routing/all.xml"';
283			}
284
285			if( strpos( $content, 'aimeos_shop:' ) === false )
286			{
287			$content .= "\n" . 'aimeos_shop:
288			resource: "@AimeosShopBundle/Resources/config/routing.yaml"
289			prefix: /';
290			}
291
292			$fs = new Filesystem();
293			$fs->dumpFile( $filename, $content );
294			}
295
296
297			/**
298			* Adds the AimeosShopBundle to the assetic section of the config file
299			*
300			* @param string &$content Content of the config.yaml file
301			* @return bool True if modified, false if not
302			*/
303			protected static function addAsseticBundle( string &$content ) : bool
304			{
305			if( preg_match( "/ bundles:[ ]\[.'AimeosShopBundle'.*\]/", $content ) !== 1 )
306			{
307			$search = array( "/ bundles:[ ]\[([^\]]+)\]/", "/ bundles:[ ]\[([ ]*)\]/" );
308			$replace = array( " bundles: [$1,'AimeosShopBundle']", " bundles: ['AimeosShopBundle']" );
309
310			if( ( $content = preg_replace( $search, $replace, $content ) ) !== null ) {
311			return true;
312			}
313			}
314
315			return false;
316			}
317			}
318

aimeos / aimeos-symfony

ScriptHandler::executeCommand() A last analyzed 2024-12-28 10:19 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

ScriptHandler::executeCommand() A
last analyzed 2024-12-28 10:19 UTC