Issues in RootModuleFileManagerImpl.php (master) - Issues in master - puli/manager - Measure and Improve Code Quality continuously with Scrutinizer

Issues (201)

Security Analysis no request data

Cross-Site Scripting

Cross-Site Scripting enables an attacker to inject code into the response of a web-request that is viewed by other users. It can for example be used to bypass access controls, or even to take over other users' accounts.

File Exposure

File Exposure allows an attacker to gain access to local files that he should not be able to access. These files can for example include database credentials, or other configuration files.

File Manipulation

File Manipulation enables an attacker to write custom data to files. This potentially leads to injection of arbitrary code on the server.

Object Injection

Object Injection enables an attacker to inject an object into PHP code, and can lead to arbitrary code execution, file exposure, or file manipulation attacks.

Code Injection

Code Injection enables an attacker to execute arbitrary code on the server.

Response Splitting

Response Splitting can be used to send arbitrary responses.

File Inclusion

File Inclusion enables an attacker to inject custom files into PHP's file loading mechanism, either explicitly passed to include, or for example via PHP's auto-loading mechanism.

Command Injection

Command Injection enables an attacker to inject a shell command that is execute with the privileges of the web-server. This can be used to expose sensitive data, or gain access of your server.

SQL Injection

SQL Injection enables an attacker to execute arbitrary SQL code on your database server gaining access to user data, or manipulating user data.

XPath Injection

XPath Injection enables an attacker to modify the parts of XML document that are read. If that XML document is for example used for authentication, this can lead to further vulnerabilities similar to SQL Injection.

LDAP Injection

LDAP Injection enables an attacker to inject LDAP statements potentially granting permission to run unauthorized queries, or modify content inside the LDAP tree.

Header Injection

Other Vulnerability

This category comprises other attack vectors such as manipulating the PHP runtime, loading custom extensions, freezing the runtime, or similar.

Regex Injection

Regex Injection enables an attacker to execute arbitrary code in your PHP process.

XML Injection

XML Injection enables an attacker to read files on your local filesystem including configuration files, or can be abused to freeze your web-server process.

Variable Injection

Variable Injection enables an attacker to overwrite program variables with custom data, and can lead to further vulnerabilities.

Unfortunately, the security analysis is currently not available for your project. If you are a non-commercial open-source project, please contact support to gain access.

src/Module/RootModuleFileManagerImpl.php (12 issues)

Labels

Severity

Upgrade to new PHP Analysis Engine

These results are based on our legacy PHP analysis, consider migrating to our new PHP analysis engine instead. Learn more

<?php

/*
 * This file is part of the puli/manager package.
 *
 * (c) Bernhard Schussek <[email protected]>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Puli\Manager\Module;

use Exception;
use InvalidArgumentException;
use Puli\Manager\Api\Context\ProjectContext;
use Puli\Manager\Api\Module\RootModuleFile;
use Puli\Manager\Api\Module\RootModuleFileManager;
use Puli\Manager\Config\AbstractConfigManager;
use Puli\Manager\Json\JsonStorage;
use ReflectionClass;
use ReflectionException;
use Webmozart\Expression\Expr;
use Webmozart\Expression\Expression;

/**
 * Manages changes to the root module file.
 *
 * Use this class to make persistent changes to the puli.json of a project.
 * Whenever you call methods in this class, the changes will be written to disk.
 *
 * @since  1.0
 *
 * @author Bernhard Schussek <[email protected]>
 */
class RootModuleFileManagerImpl extends AbstractConfigManager implements RootModuleFileManager
{
    /**
     * @var ProjectContext
     */
    private $context;

    /**
     * @var RootModuleFile
     */
    private $rootModuleFile;

    /**
     * @var JsonStorage
     */
    private $jsonStorage;

    /**
     * Creates a new module file manager.
     *
     * @param ProjectContext $context     The project context
     * @param JsonStorage    $jsonStorage The module file storage.
     */
    public function __construct(ProjectContext $context, JsonStorage $jsonStorage)
    {
        $this->context = $context;
        $this->rootModuleFile = $context->getRootModuleFile();
        $this->jsonStorage = $jsonStorage;
    }

    /**
     * {@inheritdoc}
     */
    public function getConfig()
    {
        return $this->rootModuleFile->getConfig();
    }

    /**
     * {@inheritdoc}
     */
    public function getContext()
    {
        return $this->context;
    }

    /**
     * {@inheritdoc}
     */
    public function getModuleFile()
    {
        return $this->rootModuleFile;
    }

    /**
     * {@inheritdoc}
     */
    public function getModuleName()
    {
        return $this->rootModuleFile->getModuleName();
    }

    /**
     * {@inheritdoc}
     */
    public function setModuleName($moduleName)

    {
        if ($moduleName === $this->rootModuleFile->getModuleName()) {
            return;
        }

        $previousName = $this->rootModuleFile->getModuleName();

        $this->rootModuleFile->setModuleName($moduleName);

        try {
            $this->jsonStorage->saveRootModuleFile($this->rootModuleFile);
        } catch (Exception $e) {
            $this->rootModuleFile->setModuleName($previousName);

            throw $e;
        }
    }

    /**
     * {@inheritdoc}
     */
    public function addPluginClass($pluginClass)

    {
        if ($this->rootModuleFile->hasPluginClass($pluginClass)) {
            // Already installed locally
            return;
        }

        $this->validatePluginClass($pluginClass);

        $previousClasses = $this->rootModuleFile->getPluginClasses();

        $this->rootModuleFile->addPluginClass($pluginClass);

        try {
            $this->jsonStorage->saveRootModuleFile($this->rootModuleFile);
        } catch (Exception $e) {
            $this->rootModuleFile->setPluginClasses($previousClasses);

            throw $e;
        }
    }

    /**
     * {@inheritdoc}
     */
    public function removePluginClass($pluginClass)
    {
        if (!$this->rootModuleFile->hasPluginClass($pluginClass)) {
            return;
        }

        $previousClasses = $this->rootModuleFile->getPluginClasses();

        $this->rootModuleFile->removePluginClass($pluginClass);

        try {
            $this->jsonStorage->saveRootModuleFile($this->rootModuleFile);
        } catch (Exception $e) {
            $this->rootModuleFile->setPluginClasses($previousClasses);

            throw $e;
        }
    }

    /**
     * {@inheritdoc}
     */
    public function removePluginClasses(Expression $expr)

    {
        $save = false;
        $previousClasses = $this->rootModuleFile->getPluginClasses();

        foreach ($previousClasses as $pluginClass) {
            if ($expr->evaluate($pluginClass)) {
                $this->rootModuleFile->removePluginClass($pluginClass);
                $save = true;
            }
        }

        if (!$save) {
            return;
        }

        try {
            $this->jsonStorage->saveRootModuleFile($this->rootModuleFile);
        } catch (Exception $e) {
            $this->rootModuleFile->setPluginClasses($previousClasses);

            throw $e;
        }
    }

    /**
     * {@inheritdoc}
     */
    public function clearPluginClasses()
    {
        $this->removePluginClasses(Expr::true());
    }

    /**
     * {@inheritdoc}
     */
    public function hasPluginClass($pluginClass)
    {
        return $this->rootModuleFile->hasPluginClass($pluginClass);
    }

    /**
     * {@inheritdoc}
     */
    public function hasPluginClasses(Expression $expr = null)

    {
        if (!$expr) {
            return $this->rootModuleFile->hasPluginClasses();
        }

        foreach ($this->rootModuleFile->getPluginClasses() as $pluginClass) {
            if ($expr->evaluate($pluginClass)) {
                return true;
            }
        }

        return false;
    }

    /**
     * {@inheritdoc}
     */
    public function getPluginClasses()
    {
        return $this->rootModuleFile->getPluginClasses();
    }

    /**
     * {@inheritdoc}
     */
    public function findPluginClasses(Expression $expr)
    {
        $pluginClasses = array();

        foreach ($this->rootModuleFile->getPluginClasses() as $pluginClass) {
            if ($expr->evaluate($pluginClass)) {
                $pluginClasses[] = $pluginClass;
            }
        }

        return $pluginClasses;
    }

    /**
     * {@inheritdoc}
     */
    public function setExtraKey($key, $value)
    {
        $previouslySet = $this->rootModuleFile->hasExtraKey($key);
        $previousValue = $this->rootModuleFile->getExtraKey($key);

        if ($value === $previousValue) {
            return;
        }

        $this->rootModuleFile->setExtraKey($key, $value);

        try {
            $this->jsonStorage->saveRootModuleFile($this->rootModuleFile);
        } catch (Exception $e) {
            if ($previouslySet) {
                $this->rootModuleFile->setExtraKey($key, $previousValue);
            } else {
                $this->rootModuleFile->removeExtraKey($key);
            }

            throw $e;
        }
    }

    /**
     * {@inheritdoc}
     */
    public function setExtraKeys(array $values)
    {
        $previousValues = array();
        $previouslyUnset = array();

        foreach ($values as $key => $value) {
            if ($this->rootModuleFile->hasExtraKey($key)) {
                if ($value !== $previous = $this->rootModuleFile->getExtraKey($key)) {
                    $previousValues[$key] = $previous;
                }
            } else {
                $previouslyUnset[$key] = true;
            }
        }

        if (!$previousValues && !$previouslyUnset) {

            return;
        }

        $this->rootModuleFile->setExtraKeys($values);

        try {
            $this->jsonStorage->saveRootModuleFile($this->rootModuleFile);
        } catch (Exception $e) {
            foreach ($values as $key => $value) {
                if (isset($previouslyUnset[$key])) {
                    $this->rootModuleFile->removeExtraKey($key);
                } else {
                    $this->rootModuleFile->setExtraKey($key, $previousValues[$key]);
                }
            }

            throw $e;
        }
    }

    /**
     * {@inheritdoc}
     */
    public function removeExtraKey($key)

    {
        if (!$this->rootModuleFile->hasExtraKey($key)) {
            return;
        }

        $previousValue = $this->rootModuleFile->getExtraKey($key);

        $this->rootModuleFile->removeExtraKey($key);

        try {
            $this->jsonStorage->saveRootModuleFile($this->rootModuleFile);
        } catch (Exception $e) {
            $this->rootModuleFile->setExtraKey($key, $previousValue);

            throw $e;
        }
    }

    /**
     * {@inheritdoc}
     */
    public function removeExtraKeys(Expression $expr)

    {
        $previousValues = $this->rootModuleFile->getExtraKeys();
        $save = false;

        foreach ($this->rootModuleFile->getExtraKeys() as $key => $value) {
            if ($expr->evaluate($key)) {
                $this->rootModuleFile->removeExtraKey($key);
                $save = true;
            }
        }

        if (!$save) {
            return;
        }

        try {
            $this->jsonStorage->saveRootModuleFile($this->rootModuleFile);
        } catch (Exception $e) {
            $this->rootModuleFile->setExtraKeys($previousValues);

            throw $e;
        }
    }

    /**
     * {@inheritdoc}
     */
    public function clearExtraKeys()

    {
        $previousValues = $this->rootModuleFile->getExtraKeys();

        if (!$previousValues) {

            return;
        }

        $this->rootModuleFile->clearExtraKeys();

        try {
            $this->jsonStorage->saveRootModuleFile($this->rootModuleFile);
        } catch (Exception $e) {
            $this->rootModuleFile->setExtraKeys($previousValues);

            throw $e;
        }
    }

    /**
     * {@inheritdoc}
     */
    public function hasExtraKey($key)
    {
        return $this->rootModuleFile->hasExtraKey($key);
    }

    /**
     * {@inheritdoc}
     */
    public function hasExtraKeys(Expression $expr = null)

    {
        if (!$expr) {
            return $this->rootModuleFile->hasExtraKeys();
        }

        foreach ($this->rootModuleFile->getExtraKeys() as $key => $value) {
            if ($expr->evaluate($key)) {
                return true;
            }
        }

        return false;
    }

    /**
     * {@inheritdoc}
     */
    public function getExtraKey($key, $default = null)
    {
        return $this->rootModuleFile->getExtraKey($key, $default);
    }

    /**
     * {@inheritdoc}
     */
    public function getExtraKeys()
    {
        return $this->rootModuleFile->getExtraKeys();
    }

    /**
     * {@inheritdoc}
     */
    public function findExtraKeys(Expression $expr)
    {
        $values = array();

        foreach ($this->rootModuleFile->getExtraKeys() as $key => $value) {
            if ($expr->evaluate($key)) {
                $values[$key] = $value;
            }
        }

        return $values;
    }

    /**
     * {@inheritdoc}
     */
    public function migrate($targetVersion)

    {
        $previousVersion = $this->rootModuleFile->getVersion();

        if ($previousVersion === $targetVersion) {
            return;
        }

        $this->rootModuleFile->setVersion($targetVersion);

        try {
            $this->jsonStorage->saveRootModuleFile($this->rootModuleFile);
        } catch (Exception $e) {
            $this->rootModuleFile->setVersion($previousVersion);

            throw $e;
        }
    }

    /**
     * {@inheritdoc}
     */
    protected function saveConfigFile()
    {
        $this->jsonStorage->saveRootModuleFile($this->rootModuleFile);
    }

    private function validatePluginClass($pluginClass)
    {
        try {
            $reflClass = new ReflectionClass($pluginClass);
        } catch (ReflectionException $e) {
            throw new InvalidArgumentException(sprintf(
                'The plugin class %s does not exist.',
                $pluginClass
            ), 0, $e);
        }

        if ($reflClass->isInterface()) {
            throw new InvalidArgumentException(sprintf(
                'The plugin class %s should be a class, but is an interface.',
                $pluginClass
            ));
        }

        if (version_compare(PHP_VERSION, '5.4.0', '>=') && $reflClass->isTrait()) {
            throw new InvalidArgumentException(sprintf(
                'The plugin class %s should be a class, but is a trait.',
                $pluginClass
            ));
        }

        if (!$reflClass->implementsInterface('\Puli\Manager\Api\PuliPlugin')) {
            throw new InvalidArgumentException(sprintf(
                'The plugin class %s must implement PuliPlugin.',
                $pluginClass
            ));
        }

        $constructor = $reflClass->getConstructor();

        if (null !== $constructor && $constructor->getNumberOfRequiredParameters() > 0) {
            throw new InvalidArgumentException(sprintf(
                'The constructor of the plugin class %s must not have required '.
                'parameters.',
                $pluginClass
            ));
        }
    }
}


1			<?php
2
3			/*
4			* This file is part of the puli/manager package.
5			*
6			* (c) Bernhard Schussek <[email protected]>
7			*
8			* For the full copyright and license information, please view the LICENSE
9			* file that was distributed with this source code.
10			*/
11
12			namespace Puli\Manager\Module;
13
14			use Exception;
15			use InvalidArgumentException;
16			use Puli\Manager\Api\Context\ProjectContext;
17			use Puli\Manager\Api\Module\RootModuleFile;
18			use Puli\Manager\Api\Module\RootModuleFileManager;
19			use Puli\Manager\Config\AbstractConfigManager;
20			use Puli\Manager\Json\JsonStorage;
21			use ReflectionClass;
22			use ReflectionException;
23			use Webmozart\Expression\Expr;
24			use Webmozart\Expression\Expression;
25
26			/**
27			* Manages changes to the root module file.
28			*
29			* Use this class to make persistent changes to the puli.json of a project.
30			* Whenever you call methods in this class, the changes will be written to disk.
31			*
32			* @since 1.0
33			*
34			* @author Bernhard Schussek <[email protected]>
35			*/
36			class RootModuleFileManagerImpl extends AbstractConfigManager implements RootModuleFileManager
37			{
38			/**
39			* @var ProjectContext
40			*/
41			private $context;
42
43			/**
44			* @var RootModuleFile
45			*/
46			private $rootModuleFile;
47
48			/**
49			* @var JsonStorage
50			*/
51			private $jsonStorage;
52
53			/**
54			* Creates a new module file manager.
55			*
56			* @param ProjectContext $context The project context
57			* @param JsonStorage $jsonStorage The module file storage.
58			*/
59	80		public function __construct(ProjectContext $context, JsonStorage $jsonStorage)
60			{
61	80		$this->context = $context;
62	80		$this->rootModuleFile = $context->getRootModuleFile();
63	80		$this->jsonStorage = $jsonStorage;
64	80		}
65
66			/**
67			* {@inheritdoc}
68			*/
69	17		public function getConfig()
70			{
71	17		return $this->rootModuleFile->getConfig();
72			}
73
74			/**
75			* {@inheritdoc}
76			*/
77	1		public function getContext()
78			{
79	1		return $this->context;
80			}
81
82			/**
83			* {@inheritdoc}
84			*/
85			public function getModuleFile()
86			{
87			return $this->rootModuleFile;
88			}
89
90			/**
91			* {@inheritdoc}
92			*/
93	4		public function getModuleName()
94			{
95	4		return $this->rootModuleFile->getModuleName();
96			}
97
98			/**
99			* {@inheritdoc}
100			*/
101	3	View Code Duplication	public function setModuleName($moduleName)
			0 ignored issues – show Duplication introduced 2016-01-28 11:06 UTC by Report Bug Copy Issue Report Show Similar Issues like this This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
102			{
103	3		if ($moduleName === $this->rootModuleFile->getModuleName()) {
104	1		return;
105			}
106
107	2		$previousName = $this->rootModuleFile->getModuleName();
108
109	2		$this->rootModuleFile->setModuleName($moduleName);
110
111			try {
112	2		$this->jsonStorage->saveRootModuleFile($this->rootModuleFile);
113	1		} catch (Exception $e) {
114	1		$this->rootModuleFile->setModuleName($previousName);
115
116	1		throw $e;
117			}
118	1		}
119
120			/**
121			* {@inheritdoc}
122			*/
123	8	View Code Duplication	public function addPluginClass($pluginClass)
			0 ignored issues – show Duplication introduced 2016-01-28 11:06 UTC by Report Bug Copy Issue Report Show Similar Issues like this This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
124			{
125	8		if ($this->rootModuleFile->hasPluginClass($pluginClass)) {
126			// Already installed locally
127	1		return;
128			}
129
130	7		$this->validatePluginClass($pluginClass);
131
132	2		$previousClasses = $this->rootModuleFile->getPluginClasses();
133
134	2		$this->rootModuleFile->addPluginClass($pluginClass);
135
136			try {
137	2		$this->jsonStorage->saveRootModuleFile($this->rootModuleFile);
138	1		} catch (Exception $e) {
139	1		$this->rootModuleFile->setPluginClasses($previousClasses);
140
141	1		throw $e;
142			}
143	1		}
144
145			/**
146			* {@inheritdoc}
147			*/
148	3		public function removePluginClass($pluginClass)
149			{
150	3		if (!$this->rootModuleFile->hasPluginClass($pluginClass)) {
151	1		return;
152			}
153
154	2		$previousClasses = $this->rootModuleFile->getPluginClasses();
155
156	2		$this->rootModuleFile->removePluginClass($pluginClass);
157
158			try {
159	2		$this->jsonStorage->saveRootModuleFile($this->rootModuleFile);
160	1		} catch (Exception $e) {
161	1		$this->rootModuleFile->setPluginClasses($previousClasses);
162
163	1		throw $e;
164			}
165	1		}
166
167			/**
168			* {@inheritdoc}
169			*/
170	7	View Code Duplication	public function removePluginClasses(Expression $expr)
			0 ignored issues – show Duplication introduced 2016-01-28 11:06 UTC by Report Bug Copy Issue Report Show Similar Issues like this This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
171			{
172	7		$save = false;
173	7		$previousClasses = $this->rootModuleFile->getPluginClasses();
174
175	7		foreach ($previousClasses as $pluginClass) {
176	6		if ($expr->evaluate($pluginClass)) {
177	5		$this->rootModuleFile->removePluginClass($pluginClass);
178	6		$save = true;
179			}
180			}
181
182	7		if (!$save) {
183	2		return;
184			}
185
186			try {
187	5		$this->jsonStorage->saveRootModuleFile($this->rootModuleFile);
188	2		} catch (Exception $e) {
189	2		$this->rootModuleFile->setPluginClasses($previousClasses);
190
191	2		throw $e;
192			}
193	3		}
194
195			/**
196			* {@inheritdoc}
197			*/
198	3		public function clearPluginClasses()
199			{
200	3		$this->removePluginClasses(Expr::true());
201	2		}
202
203			/**
204			* {@inheritdoc}
205			*/
206	1		public function hasPluginClass($pluginClass)
207			{
208	1		return $this->rootModuleFile->hasPluginClass($pluginClass);
209			}
210
211			/**
212			* {@inheritdoc}
213			*/
214	1	View Code Duplication	public function hasPluginClasses(Expression $expr = null)
			0 ignored issues – show Duplication introduced 2016-01-28 11:06 UTC by Report Bug Copy Issue Report Show Similar Issues like this This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
215			{
216	1		if (!$expr) {
217	1		return $this->rootModuleFile->hasPluginClasses();
218			}
219
220	1		foreach ($this->rootModuleFile->getPluginClasses() as $pluginClass) {
221	1		if ($expr->evaluate($pluginClass)) {
222	1		return true;
223			}
224			}
225
226	1		return false;
227			}
228
229			/**
230			* {@inheritdoc}
231			*/
232	14		public function getPluginClasses()
233			{
234	14		return $this->rootModuleFile->getPluginClasses();
235			}
236
237			/**
238			* {@inheritdoc}
239			*/
240	1		public function findPluginClasses(Expression $expr)
241			{
242	1		$pluginClasses = array();
243
244	1		foreach ($this->rootModuleFile->getPluginClasses() as $pluginClass) {
245	1		if ($expr->evaluate($pluginClass)) {
246	1		$pluginClasses[] = $pluginClass;
247			}
248			}
249
250	1		return $pluginClasses;
251			}
252
253			/**
254			* {@inheritdoc}
255			*/
256	4		public function setExtraKey($key, $value)
257			{
258	4		$previouslySet = $this->rootModuleFile->hasExtraKey($key);
259	4		$previousValue = $this->rootModuleFile->getExtraKey($key);
260
261	4		if ($value === $previousValue) {
262	1		return;
263			}
264
265	3		$this->rootModuleFile->setExtraKey($key, $value);
266
267			try {
268	3		$this->jsonStorage->saveRootModuleFile($this->rootModuleFile);
269	2		} catch (Exception $e) {
270	2		if ($previouslySet) {
271	1		$this->rootModuleFile->setExtraKey($key, $previousValue);
272			} else {
273	1		$this->rootModuleFile->removeExtraKey($key);
274			}
275
276	2		throw $e;
277			}
278	1		}
279
280			/**
281			* {@inheritdoc}
282			*/
283	3		public function setExtraKeys(array $values)
284			{
285	3		$previousValues = array();
286	3		$previouslyUnset = array();
287
288	3		foreach ($values as $key => $value) {
289	3		if ($this->rootModuleFile->hasExtraKey($key)) {
290	2		if ($value !== $previous = $this->rootModuleFile->getExtraKey($key)) {
291	2		$previousValues[$key] = $previous;
292			}
293			} else {
294	3		$previouslyUnset[$key] = true;
295			}
296			}
297
298	3		if (!$previousValues && !$previouslyUnset) {
			0 ignored issues – show Bug Best Practice introduced 2016-01-28 11:06 UTC by Report Bug Copy Issue Report Show Similar Issues like this The expression `$previousValues` of type `array` is implicitly converted to a boolean; are you sure this is intended? If so, consider using `empty($expr)` instead to make it clear that you intend to check for an array without elements. This check marks implicit conversions of arrays to boolean values in a comparison. While in PHP an empty array is considered to be equal (but not identical) to false, this is not always apparent. Consider making the comparison explicit by using `empty(..)` or `! empty(...)` instead. Loading history... Bug Best Practice introduced 2016-01-28 11:06 UTC by Report Bug Copy Issue Report Show Similar Issues like this The expression `$previouslyUnset` of type `array` is implicitly converted to a boolean; are you sure this is intended? If so, consider using `empty($expr)` instead to make it clear that you intend to check for an array without elements. This check marks implicit conversions of arrays to boolean values in a comparison. While in PHP an empty array is considered to be equal (but not identical) to false, this is not always apparent. Consider making the comparison explicit by using `empty(..)` or `! empty(...)` instead. Loading history...
299	1		return;
300			}
301
302	2		$this->rootModuleFile->setExtraKeys($values);
303
304			try {
305	2		$this->jsonStorage->saveRootModuleFile($this->rootModuleFile);
306	1		} catch (Exception $e) {
307	1		foreach ($values as $key => $value) {
308	1		if (isset($previouslyUnset[$key])) {
309	1		$this->rootModuleFile->removeExtraKey($key);
310			} else {
311	1		$this->rootModuleFile->setExtraKey($key, $previousValues[$key]);
312			}
313			}
314
315	1		throw $e;
316			}
317	1		}
318
319			/**
320			* {@inheritdoc}
321			*/
322	3	View Code Duplication	public function removeExtraKey($key)
			0 ignored issues – show Duplication introduced 2016-01-28 11:06 UTC by Report Bug Copy Issue Report Show Similar Issues like this This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
323			{
324	3		if (!$this->rootModuleFile->hasExtraKey($key)) {
325	1		return;
326			}
327
328	2		$previousValue = $this->rootModuleFile->getExtraKey($key);
329
330	2		$this->rootModuleFile->removeExtraKey($key);
331
332			try {
333	2		$this->jsonStorage->saveRootModuleFile($this->rootModuleFile);
334	1		} catch (Exception $e) {
335	1		$this->rootModuleFile->setExtraKey($key, $previousValue);
336
337	1		throw $e;
338			}
339	1		}
340
341			/**
342			* {@inheritdoc}
343			*/
344	3	View Code Duplication	public function removeExtraKeys(Expression $expr)
			0 ignored issues – show Duplication introduced 2016-01-28 11:06 UTC by Report Bug Copy Issue Report Show Similar Issues like this This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
345			{
346	3		$previousValues = $this->rootModuleFile->getExtraKeys();
347	3		$save = false;
348
349	3		foreach ($this->rootModuleFile->getExtraKeys() as $key => $value) {
350	2		if ($expr->evaluate($key)) {
351	2		$this->rootModuleFile->removeExtraKey($key);
352	2		$save = true;
353			}
354			}
355
356	3		if (!$save) {
357	1		return;
358			}
359
360			try {
361	2		$this->jsonStorage->saveRootModuleFile($this->rootModuleFile);
362	1		} catch (Exception $e) {
363	1		$this->rootModuleFile->setExtraKeys($previousValues);
364
365	1		throw $e;
366			}
367	1		}
368
369			/**
370			* {@inheritdoc}
371			*/
372	3	View Code Duplication	public function clearExtraKeys()
			0 ignored issues – show Duplication introduced 2016-01-28 11:06 UTC by Report Bug Copy Issue Report Show Similar Issues like this This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
373			{
374	3		$previousValues = $this->rootModuleFile->getExtraKeys();
375
376	3		if (!$previousValues) {
			0 ignored issues – show Bug Best Practice introduced 2016-01-28 11:06 UTC by Report Bug Copy Issue Report Show Similar Issues like this The expression `$previousValues` of type `array` is implicitly converted to a boolean; are you sure this is intended? If so, consider using `empty($expr)` instead to make it clear that you intend to check for an array without elements. This check marks implicit conversions of arrays to boolean values in a comparison. While in PHP an empty array is considered to be equal (but not identical) to false, this is not always apparent. Consider making the comparison explicit by using `empty(..)` or `! empty(...)` instead. Loading history...
377	1		return;
378			}
379
380	2		$this->rootModuleFile->clearExtraKeys();
381
382			try {
383	2		$this->jsonStorage->saveRootModuleFile($this->rootModuleFile);
384	1		} catch (Exception $e) {
385	1		$this->rootModuleFile->setExtraKeys($previousValues);
386
387	1		throw $e;
388			}
389	1		}
390
391			/**
392			* {@inheritdoc}
393			*/
394	1		public function hasExtraKey($key)
395			{
396	1		return $this->rootModuleFile->hasExtraKey($key);
397			}
398
399			/**
400			* {@inheritdoc}
401			*/
402	1	View Code Duplication	public function hasExtraKeys(Expression $expr = null)
			0 ignored issues – show Duplication introduced 2016-01-28 11:06 UTC by Report Bug Copy Issue Report Show Similar Issues like this This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
403			{
404	1		if (!$expr) {
405	1		return $this->rootModuleFile->hasExtraKeys();
406			}
407
408	1		foreach ($this->rootModuleFile->getExtraKeys() as $key => $value) {
409	1		if ($expr->evaluate($key)) {
410	1		return true;
411			}
412			}
413
414	1		return false;
415			}
416
417			/**
418			* {@inheritdoc}
419			*/
420	15		public function getExtraKey($key, $default = null)
421			{
422	15		return $this->rootModuleFile->getExtraKey($key, $default);
423			}
424
425			/**
426			* {@inheritdoc}
427			*/
428	1		public function getExtraKeys()
429			{
430	1		return $this->rootModuleFile->getExtraKeys();
431			}
432
433			/**
434			* {@inheritdoc}
435			*/
436	1		public function findExtraKeys(Expression $expr)
437			{
438	1		$values = array();
439
440	1		foreach ($this->rootModuleFile->getExtraKeys() as $key => $value) {
441	1		if ($expr->evaluate($key)) {
442	1		$values[$key] = $value;
443			}
444			}
445
446	1		return $values;
447			}
448
449			/**
450			* {@inheritdoc}
451			*/
452	2	View Code Duplication	public function migrate($targetVersion)
			0 ignored issues – show Duplication introduced 2016-01-28 11:06 UTC by Report Bug Copy Issue Report Show Similar Issues like this This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
453			{
454	2		$previousVersion = $this->rootModuleFile->getVersion();
455
456	2		if ($previousVersion === $targetVersion) {
457			return;
458			}
459
460	2		$this->rootModuleFile->setVersion($targetVersion);
461
462			try {
463	2		$this->jsonStorage->saveRootModuleFile($this->rootModuleFile);
464	1		} catch (Exception $e) {
465	1		$this->rootModuleFile->setVersion($previousVersion);
466
467	1		throw $e;
468			}
469	1		}
470
471			/**
472			* {@inheritdoc}
473			*/
474	4		protected function saveConfigFile()
475			{
476	4		$this->jsonStorage->saveRootModuleFile($this->rootModuleFile);
477	4		}
478
479	7		private function validatePluginClass($pluginClass)
480			{
481			try {
482	7		$reflClass = new ReflectionClass($pluginClass);
483	1		} catch (ReflectionException $e) {
484	1		throw new InvalidArgumentException(sprintf(
485	1		'The plugin class %s does not exist.',
486			$pluginClass
487	1		), 0, $e);
488			}
489
490	6		if ($reflClass->isInterface()) {
491	1		throw new InvalidArgumentException(sprintf(
492	1		'The plugin class %s should be a class, but is an interface.',
493			$pluginClass
494			));
495			}
496
497	5		if (version_compare(PHP_VERSION, '5.4.0', '>=') && $reflClass->isTrait()) {
498	1		throw new InvalidArgumentException(sprintf(
499	1		'The plugin class %s should be a class, but is a trait.',
500			$pluginClass
501			));
502			}
503
504	4		if (!$reflClass->implementsInterface('\Puli\Manager\Api\PuliPlugin')) {
505	1		throw new InvalidArgumentException(sprintf(
506	1		'The plugin class %s must implement PuliPlugin.',
507			$pluginClass
508			));
509			}
510
511	3		$constructor = $reflClass->getConstructor();
512
513	3		if (null !== $constructor && $constructor->getNumberOfRequiredParameters() > 0) {
514	1		throw new InvalidArgumentException(sprintf(
515			'The constructor of the plugin class %s must not have required '.
516	1		'parameters.',
517			$pluginClass
518			));
519			}
520	2		}
521			}
522

puli / manager

Issues (201)

Security Analysis no request data

src/Module/RootModuleFileManagerImpl.php (12 issues)

Labels

Severity

Introduced By

Upgrade to new PHP Analysis Engine

Duplication Side-by-Side

Filter issues like