ModuleInstall::getInfosFromModule() - Code Metrics - Inspection of "src/traits files : Add comments" - bfw-systems/bfw - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — 3.0 ( 1aaa8a...5b7375 )

by Vermeulen

created 2016-09-17 18:13 UTC

ModuleInstall::getInfosFromModule() A

↳ Parent: ModuleInstall

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	1
eloc	2
nc	1
nop	0
dl	0
loc	4
rs	10
c	1
b	0
f	0

<?php

namespace BFW\Install;

use \Exception;

/**
 * Class to get module install informations and run install of the module
 */
class ModuleInstall
{
    /**
     * @const INSTALL_SCRIPT_VERSION : Script's version
     */
    const INSTALL_SCRIPT_VERSION = '3.0.0';

    /**
     * @var string $bfwPath : Path to root bfw project
     */
    protected $bfwPath = '';

    /**
     * @var string $bfwConfigPath : Path to bfw config directory
     */
    protected $bfwConfigPath = '';

    /**
     * @var string $bfwModulePath : Path to bfw modules directory
     */
    protected $bfwModulePath = '';

    /**
     * @var boolean $forceReinstall : Force complete reinstall of module
     */
    protected $forceReinstall = false;

    /**
     * @var string $name : Module name
     */
    protected $name = '';

    /**
     * @var string $pathToModule : Path to module which be installed
     */
    protected $pathToModule = '';

    /**
     * @var string $srcPath : Path to module source files
     */
    protected $srcPath = '';

    /**
     * @var string $configPath : Path to module config files
     */
    protected $configPath = '';

    /**
     * @var array $configFiles : List of config file
     *                              to copy on the config directory
     */
    protected $configFiles = [];

    /**
     * @var string|bool $installScript : Script to run for a specific install
     *                                  of the module
     */
    protected $installScript = '';

    /**
     * Constructor
     * 
     * @param string $bfwPath Path to root bfw project
     * @param string $pathToModule Path to module which be installed
     */
    public function __construct($bfwPath, $pathToModule)
    {
        $this->bfwPath      = $bfwPath;
        $this->pathToModule = $pathToModule;

        $this->bfwConfigPath = $this->bfwPath.'/app/config/';
        $this->bfwModulePath = $this->bfwPath.'/app/modules/';
    }

    /**
     * Get accessor to module name
     * 
     * @return string : Module name
     */
    public function getName()
    {
        return $this->name;
    }

    /**
     * Load module informations from files
     * Define module name
     * 
     * @return void
     */
    public function loadInfos()
    {
        //Get the module name
        $pathExplode = explode('/', $this->pathToModule);
        $this->name  = $pathExplode[(count($pathExplode) - 1)];

        //Define path
        $this->bfwConfigPath .= $this->name;
        $this->bfwModulePath .= $this->name;

        $infos = $this->getInfosFromModule();
        
        //check if srcPath is define
        if (!property_exists($infos, 'srcPath')) {
            throw new Exception(
                'srcPath must be present in install json file for module '
                .$this->name
            );
        }

        //Defines default paths
        $this->srcPath    = $infos->srcPath;
        $this->configPath = $infos->srcPath;

        //Defines properties
        
        if (property_exists($infos, 'configFiles')) {
            $this->configFiles = (array) $infos->configFiles;
        }

        if (property_exists($infos, 'configPath')) {
            $this->configPath = $infos->configPath;
        }

        if (property_exists($infos, 'installScript')) {
            $this->installScript = $infos->installScript;
        }

        //Update srcPath to get the complete path
        $this->srcPath = realpath($this->pathToModule.'/'.$this->srcPath);
    }
    
    /**
     * Get infos for this module from BFW Module class
     * It's a separate method for easy override.
     * 
     * @return \stdClass
     */
    protected function getInfosFromModule()
    {
        return \BFW\Module::installInfos($this->pathToModule);
    }

    /**
     * Run module installation
     * 
     * @param boolean $reinstall : If we force reinstall module
     * 
     * @return void
     */
    public function install($reinstall)
    {
        $this->forceReinstall = $reinstall;
        
        echo $this->name." : Run install.\n";
        
        try {
            $this->createSymbolicLink();
            $this->copyConfigFiles();
            $this->runInstallScript();
        } catch (Exception $e) {
            trigger_error('Module '.$this->name.' install error : '.$e->getMessage(), E_USER_WARNING);
        }
    }
    
    /**
     * Create symlink in bfw project module directory
     * 
     * @return void
     * 
     * @throws Exception : If remove symlink fail for reinstall option
     */
    protected function createSymbolicLink()
    {
        echo ' > Create symbolic link ... '."\n";

        $targetPath     = $this->bfwModulePath;
        $alreadyCreated = file_exists($targetPath);

        //If symlink already exist and it's a reinstall mode
        if ($alreadyCreated && $this->forceReinstall === true) {
            echo '[Force Reinstall: Remove symlink] ';
            $alreadyCreated = false;

            //Error with remove symlink
            if (!unlink($targetPath)) {
                echo "\033[1;31m Symbolic link remove fail.\033[0m\n";
                throw new Exception('Reinstall fail. Symlink remove error');
            }
        }

        //If module already exist in "modules" directory
        if ($alreadyCreated) {
            echo "\033[1;33m"
                .' Not created. Module already exist in \'modules\' directory.'
                ."\033[0m\n";
            return;
        }

        //If symbolic link create fail.
        if (!symlink($this->srcPath, $targetPath)) {
            echo "\033[1;31m Symbolic link creation fail.\033[0m\n";
            return;
        }

        echo "\033[1;32m Done\033[0m\n";
    }

    /**
     * Create a directory in bfw project config directory for this module and
     * copy all config files declared in this directory
     * 
     * @return void
     */
    protected function copyConfigFiles()
    {
        echo ' > Copy config files : '."\n";

        //No file to copy
        if ($this->configFiles === []) {
            echo ' >> '
                ."\033[1;33m"
                .'No config file declared. Pass'
                ."\033[0m\n";
            
            return;
        }

        //Create the module directory in config directory.
        $configDirStatus = $this->createConfigDirectory();
        if ($configDirStatus === false) {
            return;
        }

        //Copy each config file declared
        foreach ($this->configFiles as $configFile) {
            try {
                $this->copyConfigFile($configFile);
            } catch (Exception $e) {
                trigger_error(
                    'Module '.$this->name.' Config file '.$configFile
                    .' copy error: '.$e->getMessage(),
                    E_USER_WARNING
                );
            }
        }
    }

    /**
     * Create a directory in bfw project config directory for this module
     * 
     * @return boolean : If directory exist.
     * 
     * @throws Exception : If remove directory fail for reinstall option
     */
    protected function createConfigDirectory()
    {
        echo ' >> Create config directory for this module ... ';
        
        $targetDirectory = $this->bfwConfigPath;
        $alreadyExist    = file_exists($targetDirectory);
        
        //If the directory already exist and if it's a reinstall
        if ($alreadyExist && $this->forceReinstall === true) {
            echo '[Force Reinstall: Remove symlink] ';
            $alreadyExist = false;
            
            if (!rmdir($targetDirectory)) {
                echo "\033[1;31m "
                    .'Remove module config directory fail.'
                    ."\033[0m\n";
                
                throw new Exception(
                    'Reinstall fail. Remove module config directory error.'
                );
            }
        }
        
        //If the directory already exist, nothing to do
        if ($alreadyExist) {
            echo "\033[1;33m Already exist.\033[0m\n";
            return true;
        }
        
        //Create the directory
        if (mkdir($targetDirectory, 0755)) {
            echo "\033[1;32m Created. \033[0m\n";
            return true;
        }

        //If error during the directory creation
        trigger_error('Module '.$this->name.' Error to create config directory', E_USER_WARNING);
        echo "\033[1;31m Fail. \033[0m\n";
        
        return false;
    }
    
    /**
     * Copy a config file into config directory for this module
     * 
     * @param string $configFileName : The config filename
     * 
     * @return void
     * 
     * @throws Exception If copy fail or if source file not exist
     */
    protected function copyConfigFile($configFileName)
    {
        echo ' >> Copy '.$configFileName.' ... ';

        //Define paths to the config file
        $sourceFile = realpath($this->configPath.'/'.$configFileName);
        $targetFile = realpath($this->bfwConfigPath.'/'.$configFileName);

        //Check if config file already exist
        if (file_exists($targetFile)) {
            echo "\033[1;33m Existe déjà.\033[0m\n";
            return;
        }

        //If source file not exist
        if (!file_exists($sourceFile)) {
            echo "\033[1;31m Config file not exist in module source.\033[0m\n";
            throw new Exception('Source file not exist');
        }

        //Alors on copie le fichier vers le dossier /configs/[monModule]/
        if (!copy($sourceFile, $targetFile)) {
            echo "\033[1;31m Copy fail.\033[0m\n";
            throw new Exception('Copy fail');
        }

        echo "\033[1;32m Done\033[0m\n";
    }

    /**
     * Run specific module install script if declared
     * 
     * @return void
     */
    protected function runInstallScript()
    {
        echo ' >> Run install specific script : ';

        //If no script to complete the install
        if ($this->installScript === '' || $this->installScript === false) {
            echo ' >> '
                ."\033[1;33m"
                .'No specific script declared. Pass'
                ."\033[0m\n";
            
            return;
        }

        //If the module ask a install script but not declare the name
        //Use the default name
        if ($this->installScript === true) {
            $this->installScript = 'runInstallModule.php';
        }

        //Include the file for complete the install
        require_once($this->pathToModule.'/'.$this->installScript);
    }
}


1			<?php
2
3			namespace BFW\Install;
4
5			use \Exception;
6
7			/**
8			* Class to get module install informations and run install of the module
9			*/
10			class ModuleInstall
11			{
12			/**
13			* @const INSTALL_SCRIPT_VERSION : Script's version
14			*/
15			const INSTALL_SCRIPT_VERSION = '3.0.0';
16
17			/**
18			* @var string $bfwPath : Path to root bfw project
19			*/
20			protected $bfwPath = '';
21
22			/**
23			* @var string $bfwConfigPath : Path to bfw config directory
24			*/
25			protected $bfwConfigPath = '';
26
27			/**
28			* @var string $bfwModulePath : Path to bfw modules directory
29			*/
30			protected $bfwModulePath = '';
31
32			/**
33			* @var boolean $forceReinstall : Force complete reinstall of module
34			*/
35			protected $forceReinstall = false;
36
37			/**
38			* @var string $name : Module name
39			*/
40			protected $name = '';
41
42			/**
43			* @var string $pathToModule : Path to module which be installed
44			*/
45			protected $pathToModule = '';
46
47			/**
48			* @var string $srcPath : Path to module source files
49			*/
50			protected $srcPath = '';
51
52			/**
53			* @var string $configPath : Path to module config files
54			*/
55			protected $configPath = '';
56
57			/**
58			* @var array $configFiles : List of config file
59			* to copy on the config directory
60			*/
61			protected $configFiles = [];
62
63			/**
64			* @var string\|bool $installScript : Script to run for a specific install
65			* of the module
66			*/
67			protected $installScript = '';
68
69			/**
70			* Constructor
71			*
72			* @param string $bfwPath Path to root bfw project
73			* @param string $pathToModule Path to module which be installed
74			*/
75			public function __construct($bfwPath, $pathToModule)
76			{
77			$this->bfwPath = $bfwPath;
78			$this->pathToModule = $pathToModule;
79
80			$this->bfwConfigPath = $this->bfwPath.'/app/config/';
81			$this->bfwModulePath = $this->bfwPath.'/app/modules/';
82			}
83
84			/**
85			* Get accessor to module name
86			*
87			* @return string : Module name
88			*/
89			public function getName()
90			{
91			return $this->name;
92			}
93
94			/**
95			* Load module informations from files
96			* Define module name
97			*
98			* @return void
99			*/
100			public function loadInfos()
101			{
102			//Get the module name
103			$pathExplode = explode('/', $this->pathToModule);
104			$this->name = $pathExplode[(count($pathExplode) - 1)];
105
106			//Define path
107			$this->bfwConfigPath .= $this->name;
108			$this->bfwModulePath .= $this->name;
109
110			$infos = $this->getInfosFromModule();
111
112			//check if srcPath is define
113			if (!property_exists($infos, 'srcPath')) {
114			throw new Exception(
115			'srcPath must be present in install json file for module '
116			.$this->name
117			);
118			}
119
120			//Defines default paths
121			$this->srcPath = $infos->srcPath;
122			$this->configPath = $infos->srcPath;
123
124			//Defines properties
125
126			if (property_exists($infos, 'configFiles')) {
127			$this->configFiles = (array) $infos->configFiles;
128			}
129
130			if (property_exists($infos, 'configPath')) {
131			$this->configPath = $infos->configPath;
132			}
133
134			if (property_exists($infos, 'installScript')) {
135			$this->installScript = $infos->installScript;
136			}
137
138			//Update srcPath to get the complete path
139			$this->srcPath = realpath($this->pathToModule.'/'.$this->srcPath);
140			}
141
142			/**
143			* Get infos for this module from BFW Module class
144			* It's a separate method for easy override.
145			*
146			* @return \stdClass
147			*/
148			protected function getInfosFromModule()
149			{
150			return \BFW\Module::installInfos($this->pathToModule);
151			}
152
153			/**
154			* Run module installation
155			*
156			* @param boolean $reinstall : If we force reinstall module
157			*
158			* @return void
159			*/
160			public function install($reinstall)
161			{
162			$this->forceReinstall = $reinstall;
163
164			echo $this->name." : Run install.\n";
165
166			try {
167			$this->createSymbolicLink();
168			$this->copyConfigFiles();
169			$this->runInstallScript();
170			} catch (Exception $e) {
171			trigger_error('Module '.$this->name.' install error : '.$e->getMessage(), E_USER_WARNING);
172			}
173			}
174
175			/**
176			* Create symlink in bfw project module directory
177			*
178			* @return void
179			*
180			* @throws Exception : If remove symlink fail for reinstall option
181			*/
182			protected function createSymbolicLink()
183			{
184			echo ' > Create symbolic link ... '."\n";
185
186			$targetPath = $this->bfwModulePath;
187			$alreadyCreated = file_exists($targetPath);
188
189			//If symlink already exist and it's a reinstall mode
190			if ($alreadyCreated && $this->forceReinstall === true) {
191			echo '[Force Reinstall: Remove symlink] ';
192			$alreadyCreated = false;
193
194			//Error with remove symlink
195			if (!unlink($targetPath)) {
196			echo "\033[1;31m Symbolic link remove fail.\033[0m\n";
197			throw new Exception('Reinstall fail. Symlink remove error');
198			}
199			}
200
201			//If module already exist in "modules" directory
202			if ($alreadyCreated) {
203			echo "\033[1;33m"
204			.' Not created. Module already exist in \'modules\' directory.'
205			."\033[0m\n";
206			return;
207			}
208
209			//If symbolic link create fail.
210			if (!symlink($this->srcPath, $targetPath)) {
211			echo "\033[1;31m Symbolic link creation fail.\033[0m\n";
212			return;
213			}
214
215			echo "\033[1;32m Done\033[0m\n";
216			}
217
218			/**
219			* Create a directory in bfw project config directory for this module and
220			* copy all config files declared in this directory
221			*
222			* @return void
223			*/
224			protected function copyConfigFiles()
225			{
226			echo ' > Copy config files : '."\n";
227
228			//No file to copy
229			if ($this->configFiles === []) {
230			echo ' >> '
231			."\033[1;33m"
232			.'No config file declared. Pass'
233			."\033[0m\n";
234
235			return;
236			}
237
238			//Create the module directory in config directory.
239			$configDirStatus = $this->createConfigDirectory();
240			if ($configDirStatus === false) {
241			return;
242			}
243
244			//Copy each config file declared
245			foreach ($this->configFiles as $configFile) {
246			try {
247			$this->copyConfigFile($configFile);
248			} catch (Exception $e) {
249			trigger_error(
250			'Module '.$this->name.' Config file '.$configFile
251			.' copy error: '.$e->getMessage(),
252			E_USER_WARNING
253			);
254			}
255			}
256			}
257
258			/**
259			* Create a directory in bfw project config directory for this module
260			*
261			* @return boolean : If directory exist.
262			*
263			* @throws Exception : If remove directory fail for reinstall option
264			*/
265			protected function createConfigDirectory()
266			{
267			echo ' >> Create config directory for this module ... ';
268
269			$targetDirectory = $this->bfwConfigPath;
270			$alreadyExist = file_exists($targetDirectory);
271
272			//If the directory already exist and if it's a reinstall
273			if ($alreadyExist && $this->forceReinstall === true) {
274			echo '[Force Reinstall: Remove symlink] ';
275			$alreadyExist = false;
276
277			if (!rmdir($targetDirectory)) {
278			echo "\033[1;31m "
279			.'Remove module config directory fail.'
280			."\033[0m\n";
281
282			throw new Exception(
283			'Reinstall fail. Remove module config directory error.'
284			);
285			}
286			}
287
288			//If the directory already exist, nothing to do
289			if ($alreadyExist) {
290			echo "\033[1;33m Already exist.\033[0m\n";
291			return true;
292			}
293
294			//Create the directory
295			if (mkdir($targetDirectory, 0755)) {
296			echo "\033[1;32m Created. \033[0m\n";
297			return true;
298			}
299
300			//If error during the directory creation
301			trigger_error('Module '.$this->name.' Error to create config directory', E_USER_WARNING);
302			echo "\033[1;31m Fail. \033[0m\n";
303
304			return false;
305			}
306
307			/**
308			* Copy a config file into config directory for this module
309			*
310			* @param string $configFileName : The config filename
311			*
312			* @return void
313			*
314			* @throws Exception If copy fail or if source file not exist
315			*/
316			protected function copyConfigFile($configFileName)
317			{
318			echo ' >> Copy '.$configFileName.' ... ';
319
320			//Define paths to the config file
321			$sourceFile = realpath($this->configPath.'/'.$configFileName);
322			$targetFile = realpath($this->bfwConfigPath.'/'.$configFileName);
323
324			//Check if config file already exist
325			if (file_exists($targetFile)) {
326			echo "\033[1;33m Existe déjà.\033[0m\n";
327			return;
328			}
329
330			//If source file not exist
331			if (!file_exists($sourceFile)) {
332			echo "\033[1;31m Config file not exist in module source.\033[0m\n";
333			throw new Exception('Source file not exist');
334			}
335
336			//Alors on copie le fichier vers le dossier /configs/[monModule]/
337			if (!copy($sourceFile, $targetFile)) {
338			echo "\033[1;31m Copy fail.\033[0m\n";
339			throw new Exception('Copy fail');
340			}
341
342			echo "\033[1;32m Done\033[0m\n";
343			}
344
345			/**
346			* Run specific module install script if declared
347			*
348			* @return void
349			*/
350			protected function runInstallScript()
351			{
352			echo ' >> Run install specific script : ';
353
354			//If no script to complete the install
355			if ($this->installScript === '' \|\| $this->installScript === false) {
356			echo ' >> '
357			."\033[1;33m"
358			.'No specific script declared. Pass'
359			."\033[0m\n";
360
361			return;
362			}
363
364			//If the module ask a install script but not declare the name
365			//Use the default name
366			if ($this->installScript === true) {
367			$this->installScript = 'runInstallModule.php';
368			}
369
370			//Include the file for complete the install
371			require_once($this->pathToModule.'/'.$this->installScript);
372			}
373			}
374

bfw-systems / bfw

GitHub Access Token became invalid

Push — 3.0 ( 1aaa8a...5b7375 )

ModuleInstall::getInfosFromModule() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like