Issues in DoctrineCrudGenerator.php (master) - Issues in master - PGSSoft/PgsRestfonyBundle - Measure and Improve Code Quality continuously with Scrutinizer

Issues (82)

Security Analysis not enabled

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.

Generator/DoctrineCrudGenerator.php (3 issues)

Labels

Severity

Minor 3

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

namespace Pgs\RestfonyBundle\Generator;

use Doctrine\ORM\Mapping\ClassMetadataInfo;
use InvalidArgumentException;
use Pgs\RestfonyBundle\Generator\Helper\BundleStructureHelper;
use Sensio\Bundle\GeneratorBundle\Generator\Generator;
use Symfony\Component\Filesystem\Filesystem;
use Symfony\Component\HttpKernel\Bundle\BundleInterface;
use RuntimeException;

class DoctrineCrudGenerator extends Generator
{
    /**
     * @var Filesystem
     */
    protected $filesystem;

    /**
     * @var BundleStructureHelper
     */
    protected $helper;

    /** @var BundleInterface */
    protected $bundle;

    protected $entity;
    protected $metadata;
    protected $actions;

    /**
     * Constructor.
     *
     * @param Filesystem $filesystem A Filesystem instance
     * @param BundleInterface $bundle
     * @param string $entity
     */
    public function __construct(Filesystem $filesystem, BundleInterface $bundle, $entity)
    {
        $this->filesystem = $filesystem;
        $this->helper = new BundleStructureHelper($bundle, $entity);
    }

    /**
     * Generate the CRUD controller.
     *
     * @param BundleInterface   $bundle           A bundle object
     * @param string            $entity           The entity relative class name
     * @param ClassMetadataInfo $metadata         The entity class metadata
     * @param array             $needWriteActions Whether or not to generate write actions
     * @param $forceOverwrite
     */
    public function generate(
        BundleInterface $bundle,
        $entity,
        ClassMetadataInfo $metadata,
        $needWriteActions,
        $forceOverwrite
    ) {
        $this->actions = $needWriteActions
            ? ['cget', 'get', 'post', 'put', 'patch', 'delete', 'new', 'edit']
            : ['cget', 'get'];

        if (count($metadata->getIdentifier()) !== 1) {
            throw new RuntimeException('CRUD generator does not support entities with multiple or no primary keys.');
        }

        $this->entity   = $entity;
        $this->bundle   = $bundle;
        $this->metadata = $metadata;

        $this->generateControllerClass($forceOverwrite);
        $this->generateTestClass();
    }

    /**
     * Generates the controller class only.
     *
     * @param bool $forceOverwrite
     */
    protected function generateControllerClass($forceOverwrite)
    {
        $metadata = $this->metadata;

        $target = $this->helper->getControllerFullFilename();
class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }

        $parts = explode('\\', $this->entity);
        array_pop($parts);
        $entityNamespace = implode('\\', $parts);

        if (!$this->canWriteToFile($target, $forceOverwrite)) {
            throw new \RuntimeException('Unable to generate the controller as it already exists.');
        }

        $idType = $this->getIdentifierType($metadata);

        $this->renderFile('controller/controller.php.twig', $target, array(
            'actions'           => $this->actions,
            'entity'            => $this->entity,
            'namespace'         => $this->bundle->getNamespace(),
            'entity_namespace'  => $entityNamespace,
            'entity_identifier_type' => $idType,
            'entity_identifier'      => $this->getEntityIdentifier($metadata),
            'requirement_regex'      => $this->getRequirementRegex($idType),
            'document' => true,
            'form_type' => $this->bundle->getNamespace()."\\Form\\Type\\".$this->entity."Type.php",
        ));
    }

    /**
     * Generates the functional test class only.
     */
    protected function generateTestClass()
    {
        $target = $this->helper->getTestsDirname() . '/Controller/' . $this->helper->getControllerClass() . 'Test.php';
class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }

        $this->renderFile('controller/controller-test.php.twig', $target, array(
            'entity'            => $this->entity,
            'namespace'         => $this->bundle->getNamespace(),
            'actions'           => $this->actions,
        ));
    }

    protected function canWriteToFile($file, $forceOverwrite)
    {
        return !file_exists($file) || $forceOverwrite;
    }

    /**
     * @param ClassMetadataInfo $metadata
     *
     * @throws \InvalidArgumentException
     *
     * @return string
     */
    private function getIdentifierType(ClassMetadataInfo $metadata)
    {
        $identifier = array_values($metadata->getIdentifier())[0];
        foreach ($metadata->fieldMappings as $field) {
            if ($field['fieldName'] === $identifier) {
                return $field['type'];
            }
        }

        return '';
    }

    /**
     * @param ClassMetadataInfo $metadata
     *
     * @return mixed
     */
    private function getEntityIdentifier(ClassMetadataInfo $metadata)
    {
        return array_values($metadata->getIdentifier())[0];
    }

    /**
     * @param string $idType
     *
     * @return string
     */
    private function getRequirementRegex($idType)
    {
        switch ($idType) {
            case 'string':
                return '\w+';
            case 'integer':
                return '\d+';
            default:
                return '';
        }
    }
}


1		<?php
2
3		namespace Pgs\RestfonyBundle\Generator;
4
5		use Doctrine\ORM\Mapping\ClassMetadataInfo;
6		use InvalidArgumentException;
7		use Pgs\RestfonyBundle\Generator\Helper\BundleStructureHelper;
8		use Sensio\Bundle\GeneratorBundle\Generator\Generator;
9		use Symfony\Component\Filesystem\Filesystem;
10		use Symfony\Component\HttpKernel\Bundle\BundleInterface;
11		use RuntimeException;
12
13		class DoctrineCrudGenerator extends Generator
14		{
15		/**
16		* @var Filesystem
17		*/
18		protected $filesystem;
19
20		/**
21		* @var BundleStructureHelper
22		*/
23		protected $helper;
24
25		/** @var BundleInterface */
26		protected $bundle;
27
28		protected $entity;
29		protected $metadata;
30		protected $actions;
31
32		/**
33		* Constructor.
34		*
35		* @param Filesystem $filesystem A Filesystem instance
36		* @param BundleInterface $bundle
37		* @param string $entity
38		*/
39	5	public function __construct(Filesystem $filesystem, BundleInterface $bundle, $entity)
40		{
41	5	$this->filesystem = $filesystem;
42	5	$this->helper = new BundleStructureHelper($bundle, $entity);
43	5	}
44
45		/**
46		* Generate the CRUD controller.
47		*
48		* @param BundleInterface $bundle A bundle object
49		* @param string $entity The entity relative class name
50		* @param ClassMetadataInfo $metadata The entity class metadata
51		* @param array $needWriteActions Whether or not to generate write actions
52		* @param $forceOverwrite
53		*/
54	5	public function generate(
55		BundleInterface $bundle,
56		$entity,
57		ClassMetadataInfo $metadata,
58		$needWriteActions,
59		$forceOverwrite
60		) {
61	5	$this->actions = $needWriteActions
62	3	? ['cget', 'get', 'post', 'put', 'patch', 'delete', 'new', 'edit']
63	2	: ['cget', 'get'];
64
65	5	if (count($metadata->getIdentifier()) !== 1) {
66	1	throw new RuntimeException('CRUD generator does not support entities with multiple or no primary keys.');
67		}
68
69	4	$this->entity = $entity;
70	4	$this->bundle = $bundle;
71	4	$this->metadata = $metadata;
72
73	4	$this->generateControllerClass($forceOverwrite);
74	3	$this->generateTestClass();
75	3	}
76
77		/**
78		* Generates the controller class only.
79		*
80		* @param bool $forceOverwrite
81		*/
82	4	protected function generateControllerClass($forceOverwrite)
83		{
84	4	$metadata = $this->metadata;
85
86	4	$target = $this->helper->getControllerFullFilename();
		0 ignored issues – show Documentation Bug introduced 2016-08-10 09:43 UTC by Report Bug Copy Issue Report Show Similar Issues like this The method `getControllerFullFilename` does not exist on `object<Pgs\RestfonyBundl...\BundleStructureHelper>`? Since you implemented `__call`, maybe consider adding a @method annotation. If you implement `__call` and you know which methods are available, you can improve IDE auto-completion and static analysis by adding a @method annotation to the class. This is often the case, when `__call` is implemented by a parent class and only the child class knows which methods exist: class ParentClass { private $data = array(); public function __call($method, array $args) { if (0 === strpos($method, 'get')) { return $this->data[strtolower(substr($method, 3))]; } throw new \LogicException(sprintf('Unsupported method: %s', $method)); } } /** * If this class knows which fields exist, you can specify the methods here: * * @method string getName() */ class SomeClass extends ParentClass { } Loading history...
87
88	4	$parts = explode('\\', $this->entity);
89	4	array_pop($parts);
90	4	$entityNamespace = implode('\\', $parts);
91
92	4	if (!$this->canWriteToFile($target, $forceOverwrite)) {
93	1	throw new \RuntimeException('Unable to generate the controller as it already exists.');
94		}
95
96	3	$idType = $this->getIdentifierType($metadata);
97
98	3	$this->renderFile('controller/controller.php.twig', $target, array(
99	3	'actions' => $this->actions,
100	3	'entity' => $this->entity,
101	3	'namespace' => $this->bundle->getNamespace(),
102	3	'entity_namespace' => $entityNamespace,
103	3	'entity_identifier_type' => $idType,
104	3	'entity_identifier' => $this->getEntityIdentifier($metadata),
105	3	'requirement_regex' => $this->getRequirementRegex($idType),
106		'document' => true,
107	3	'form_type' => $this->bundle->getNamespace()."\\Form\\Type\\".$this->entity."Type.php",
108		));
109	3	}
110
111		/**
112		* Generates the functional test class only.
113		*/
114	3	protected function generateTestClass()
115		{
116	3	$target = $this->helper->getTestsDirname() . '/Controller/' . $this->helper->getControllerClass() . 'Test.php';
		0 ignored issues – show Documentation Bug introduced 2016-08-10 09:43 UTC by Report Bug Copy Issue Report Show Similar Issues like this The method `getTestsDirname` does not exist on `object<Pgs\RestfonyBundl...\BundleStructureHelper>`? Since you implemented `__call`, maybe consider adding a @method annotation. If you implement `__call` and you know which methods are available, you can improve IDE auto-completion and static analysis by adding a @method annotation to the class. This is often the case, when `__call` is implemented by a parent class and only the child class knows which methods exist: class ParentClass { private $data = array(); public function __call($method, array $args) { if (0 === strpos($method, 'get')) { return $this->data[strtolower(substr($method, 3))]; } throw new \LogicException(sprintf('Unsupported method: %s', $method)); } } /** * If this class knows which fields exist, you can specify the methods here: * * @method string getName() / class SomeClass extends ParentClass { } Loading history... Documentation Bug introduced 2016-08-10 09:43 UTC by Report Bug Copy Issue Report Show Similar Issues like this The method `getControllerClass` does not exist on `object<Pgs\RestfonyBundl...\BundleStructureHelper>`? Since you implemented `__call`, maybe consider adding a @method annotation. If you implement `__call` and you know which methods are available, you can improve IDE auto-completion and static analysis by adding a @method annotation to the class. This is often the case, when `__call` is implemented by a parent class and only the child class knows which methods exist: class ParentClass { private $data = array(); public function __call($method, array $args) { if (0 === strpos($method, 'get')) { return $this->data[strtolower(substr($method, 3))]; } throw new \LogicException(sprintf('Unsupported method: %s', $method)); } } /* * If this class knows which fields exist, you can specify the methods here: * * @method string getName() */ class SomeClass extends ParentClass { } Loading history...
117
118	3	$this->renderFile('controller/controller-test.php.twig', $target, array(
119	3	'entity' => $this->entity,
120	3	'namespace' => $this->bundle->getNamespace(),
121	3	'actions' => $this->actions,
122		));
123	3	}
124
125	3	protected function canWriteToFile($file, $forceOverwrite)
126		{
127	3	return !file_exists($file) \|\| $forceOverwrite;
128		}
129
130		/**
131		* @param ClassMetadataInfo $metadata
132		*
133		* @throws \InvalidArgumentException
134		*
135		* @return string
136		*/
137	3	private function getIdentifierType(ClassMetadataInfo $metadata)
138		{
139	3	$identifier = array_values($metadata->getIdentifier())[0];
140	3	foreach ($metadata->fieldMappings as $field) {
141	3	if ($field['fieldName'] === $identifier) {
142	3	return $field['type'];
143		}
144		}
145
146	1	return '';
147		}
148
149		/**
150		* @param ClassMetadataInfo $metadata
151		*
152		* @return mixed
153		*/
154	3	private function getEntityIdentifier(ClassMetadataInfo $metadata)
155		{
156	3	return array_values($metadata->getIdentifier())[0];
157		}
158
159		/**
160		* @param string $idType
161		*
162		* @return string
163		*/
164	3	private function getRequirementRegex($idType)
165		{
166		switch ($idType) {
167	3	case 'string':
168	1	return '\w+';
169	2	case 'integer':
170	1	return '\d+';
171		default:
172	1	return '';
173		}
174		}
175		}
176

PGSSoft / PgsRestfonyBundle

Issues (82)

Security Analysis not enabled

Generator/DoctrineCrudGenerator.php (3 issues)

Labels

Severity

Introduced By

Upgrade to new PHP Analysis Engine

Duplication Side-by-Side

Filter issues like