Issues in RemoveComments.php (master) - Issues in master - s9e/SourceOptimizer - Measure and Improve Code Quality continuously with Scrutinizer

Issues (1)

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/Passes/RemoveComments.php (1 issue)

Labels

Unused Code 1

Severity

Minor 1

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

/**
* @package   s9e\SourceOptimizer
* @copyright Copyright (c) 2014-2018 The s9e Authors
* @license   http://www.opensource.org/licenses/mit-license.php The MIT License
*/
namespace s9e\SourceOptimizer\Passes;

use s9e\SourceOptimizer\Helper;

class RemoveComments extends AbstractPass
{
	/**
	* @var string[] List of annotations to preserve
	*/
	public $preserveAnnotations = [
		'license'
	];

	/**
	* @var bool Whether to remove DocBlock comments
	*/
	public $removeDocBlocks = true;

	/**
	* @var bool Whether to remove "C style" comments
	*/
	public $removeMultiLineComments = true;

	/**
	* @var bool Whether to remove "one-line" comments
	*/
	public $removeSingleLineComments = true;

	/**
	* {@inheritdoc}
	*/
	protected function optimizeStream()
	{
		if ($this->removeDocBlocks)
		{
			$this->removeDocBlocks();
		}
		if ($this->removeMultiLineComments || $this->removeSingleLineComments)
		{
			$this->removeComments();
		}
		Helper::mergeWhitespace($this->stream);
class User
{
    private $email;

    public function getEmail()
    {
        return $this->email;
    }

    public function setEmail($email)
    {
        $this->email = $email;
    }
}
	}

	/**
	* Generate a regexp that matches preserved annotations
	*
	* @return string
	*/
	protected function getRegexp()
	{
		if (empty($this->preserveAnnotations))
		{
			return '((?!))';
		}

		return '(@(?:' . implode('|', $this->preserveAnnotations) . '))';
	}

	/**
	* Remove all docblocks tokens from given stream
	*
	* @return void
	*/
	protected function removeDocBlocks()
	{
		$regexp = $this->getRegexp();
		$this->stream->reset();
		while ($this->stream->skipTo(T_DOC_COMMENT))
		{
			$docblock = $this->stream->currentText();
			if (strpos($docblock, '@') !== false && preg_match($regexp, $docblock))
			{
				continue;
			}

			$this->removeComment();
		}
	}

	/**
	* Remove current comment token from given stream
	*
	* @return void
	*/
	protected function removeComment()
	{
		$offset = $this->stream->key();
		$this->stream->previous();
		if ($this->stream->is(T_WHITESPACE))
		{
			$ws = preg_replace('(\\n[ \\t]*$)', '', $this->stream->currentText());
			if ($ws === '')
			{
				$this->stream->remove();
			}
			else
			{
				$this->stream->replace([T_WHITESPACE, $ws]);
			}
		}

		$this->stream->seek($offset);
		if ($this->stream->canRemoveCurrentToken())
		{
			$this->stream->remove();
		}
		else
		{
			$this->stream->replace([T_WHITESPACE, ' ']);
		}
	}

	/**
	* Remove single-line and/or multi-line comments from given stream
	*
	* @return void
	*/
	protected function removeComments()
	{
		$this->stream->reset();
		while ($this->stream->skipTo(T_COMMENT))
		{
			$comment = $this->stream->currentText();
			if ($comment[1] === '/' && !$this->removeSingleLineComments)
			{
				continue;
			}
			if ($comment[1] === '*' && !$this->removeMultiLineComments)
			{
				continue;
			}

			$this->removeComment();
		}
	}
}

1		<?php
2
3		/**
4		* @package s9e\SourceOptimizer
5		* @copyright Copyright (c) 2014-2018 The s9e Authors
6		* @license http://www.opensource.org/licenses/mit-license.php The MIT License
7		*/
8		namespace s9e\SourceOptimizer\Passes;
9
10		use s9e\SourceOptimizer\Helper;
11
12		class RemoveComments extends AbstractPass
13		{
14		/**
15		* @var string[] List of annotations to preserve
16		*/
17		public $preserveAnnotations = [
18		'license'
19		];
20
21		/**
22		* @var bool Whether to remove DocBlock comments
23		*/
24		public $removeDocBlocks = true;
25
26		/**
27		* @var bool Whether to remove "C style" comments
28		*/
29		public $removeMultiLineComments = true;
30
31		/**
32		* @var bool Whether to remove "one-line" comments
33		*/
34		public $removeSingleLineComments = true;
35
36		/**
37		* {@inheritdoc}
38		*/
39	13	protected function optimizeStream()
40		{
41	13	if ($this->removeDocBlocks)
42		{
43	12	$this->removeDocBlocks();
44		}
45	13	if ($this->removeMultiLineComments \|\| $this->removeSingleLineComments)
46		{
47	13	$this->removeComments();
48		}
49	13	Helper::mergeWhitespace($this->stream);
		0 ignored issues – show Unused Code introduced 2018-06-11 00:59 UTC by Report Bug Copy Issue Report Show Similar Issues like this The call to the method `s9e\SourceOptimizer\Helper::mergeWhitespace()` seems un-needed as the method has no side-effects. PHP Analyzer performs a side-effects analysis of your code. A side-effect is basically anything that might be visible after the scope of the method is left. Let’s take a look at an example: class User { private $email; public function getEmail() { return $this->email; } public function setEmail($email) { $this->email = $email; } } If we look at the `getEmail()` method, we can see that it has no side-effect. Whether you call this method or not, no future calls to other methods are affected by this. As such code as the following is useless: $user = new User(); $user->getEmail(); // This line could safely be removed as it has no effect. On the hand, if we look at the `setEmail()`, this method _has_ side-effects. In the following case, we could not remove the method call: $user = new User(); $user->setEmail('email@domain'); // This line has a side-effect (it changes an // instance variable). Loading history...
50	13	}
51
52		/**
53		* Generate a regexp that matches preserved annotations
54		*
55		* @return string
56		*/
57	12	protected function getRegexp()
58		{
59	12	if (empty($this->preserveAnnotations))
60		{
61		return '((?!))';
62		}
63
64	12	return '(@(?:' . implode('\|', $this->preserveAnnotations) . '))';
65		}
66
67		/**
68		* Remove all docblocks tokens from given stream
69		*
70		* @return void
71		*/
72	12	protected function removeDocBlocks()
73		{
74	12	$regexp = $this->getRegexp();
75	12	$this->stream->reset();
76	12	while ($this->stream->skipTo(T_DOC_COMMENT))
77		{
78	3	$docblock = $this->stream->currentText();
79	3	if (strpos($docblock, '@') !== false && preg_match($regexp, $docblock))
80		{
81	2	continue;
82		}
83
84	1	$this->removeComment();
85		}
86	12	}
87
88		/**
89		* Remove current comment token from given stream
90		*
91		* @return void
92		*/
93	8	protected function removeComment()
94		{
95	8	$offset = $this->stream->key();
96	8	$this->stream->previous();
97	8	if ($this->stream->is(T_WHITESPACE))
98		{
99	6	$ws = preg_replace('(\\n[ \\t]*$)', '', $this->stream->currentText());
100	6	if ($ws === '')
101		{
102	6	$this->stream->remove();
103		}
104		else
105		{
106		$this->stream->replace([T_WHITESPACE, $ws]);
107		}
108		}
109
110	8	$this->stream->seek($offset);
111	8	if ($this->stream->canRemoveCurrentToken())
112		{
113	7	$this->stream->remove();
114		}
115		else
116		{
117	1	$this->stream->replace([T_WHITESPACE, ' ']);
118		}
119	8	}
120
121		/**
122		* Remove single-line and/or multi-line comments from given stream
123		*
124		* @return void
125		*/
126	13	protected function removeComments()
127		{
128	13	$this->stream->reset();
129	13	while ($this->stream->skipTo(T_COMMENT))
130		{
131	9	$comment = $this->stream->currentText();
132	9	if ($comment[1] === '/' && !$this->removeSingleLineComments)
133		{
134	1	continue;
135		}
136	8	if ($comment[1] === '*' && !$this->removeMultiLineComments)
137		{
138	1	continue;
139		}
140
141	7	$this->removeComment();
142		}
143		}
144		}

s9e / SourceOptimizer

Issues (1)

Security Analysis no request data

src/Passes/RemoveComments.php (1 issue)

Labels

Severity

Introduced By

Upgrade to new PHP Analysis Engine

Duplication Side-by-Side

Filter issues like