Issues in TraitUseDeclarationSniff.php (master) - Issues in master - bestit/PHP_CodeSniffer - Measure and Improve Code Quality continuously with Scrutinizer

Issues (51)

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.

Sniffs/Formatting/TraitUseDeclarationSniff.php (1 issue)

Labels

Bug 1

Severity

Critical 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

declare(strict_types=1);

namespace BestIt\Sniffs\Formatting;

use BestIt\CodeSniffer\Helper\ClassHelper;
use BestIt\CodeSniffer\Helper\TokenHelper;
use BestIt\Sniffs\AbstractSniff;
use BestIt\Sniffs\ClassRegistrationTrait;
use const T_COMMA;
use const T_OPEN_CURLY_BRACKET;
use const T_SEMICOLON;
use const T_WHITESPACE;

/**
 * Sniffs if the uses in a class are correct.
 *
 * @author blange <[email protected]>
 * @package BestIt\Sniffs\Formatting
 */
class TraitUseDeclarationSniff extends AbstractSniff
{
    use ClassRegistrationTrait;

    /**
     * You MUST provide only one "use" per Line for importing traits etc. in classes.
     */
    public const CODE_MULTIPLE_TRAITS_PER_DECLARATION = 'MultipleTraitsPerDeclaration';

    /**
     * Readable error message.
     */
    private const MESSAGE_MULTIPLE_TRAITS_PER_DECLARATION = 'Multiple traits per use statement are forbidden.';

    /**
     * The use declarations positions of this "class".
     *
     * @var array
     */
    private array $uses;


    /**
     * Returns false if there are no uses.
     *
     * @return bool
     */
    protected function areRequirementsMet(): bool
    {
        return (bool) $this->uses = ClassHelper::getTraitUsePointers($this->getFile(), $this->getStackPos());
    }

    /**
     * Checks the declaration of the given use position and registers and error if needed.
     *
     * @param int $usePos
     *
     * @return void
     */
    private function checkDeclaration(int $usePos): void
    {
        $file = $this->getFile();

        if (TokenHelper::findNextLocal($file, T_COMMA, $usePos + 1)) {
            $endPos = TokenHelper::findNext($file, [T_OPEN_CURLY_BRACKET, T_SEMICOLON], $usePos + 1);
            $tokens = $file->getTokens();

            if ($tokens[$endPos]['code'] === T_OPEN_CURLY_BRACKET) {
                $file->addError(
                    self::MESSAGE_MULTIPLE_TRAITS_PER_DECLARATION,
                    $usePos,
                    static::CODE_MULTIPLE_TRAITS_PER_DECLARATION
                );
            } else {
                $fix = $file->addFixableError(
                    self::MESSAGE_MULTIPLE_TRAITS_PER_DECLARATION,
                    $usePos,
                    static::CODE_MULTIPLE_TRAITS_PER_DECLARATION
                );

                if ($fix) {
                    $this->fixeUse($endPos, $usePos);
                }
            }
        }
    }

    /**
     * Fixes the given use position.
     *
     * @param int $endPos The end of the checked position.
     * @param int $usePos
     *
     * @return void
     */
    protected function fixeUse(int $endPos, int $usePos): void
    {
        $indentation = $this->getIndentationForFix($usePos);
        $file = $this->getFile();
        $fixer = $file->fixer;

        $fixer->beginChangeset();

        $commaPointers = TokenHelper::findNextAll($file, T_COMMA, $usePos + 1, $endPos);
        foreach ($commaPointers as $commaPos) {
            $pointerAfterComma = TokenHelper::findNextEffective($file, $commaPos + 1);
            $fixer->replaceToken($commaPos, ';' . $file->eolChar . $indentation . 'use ');
            for ($i = $commaPos + 1; $i < $pointerAfterComma; $i++) {
                $fixer->replaceToken($i, '');
            }
        }

        $fixer->endChangeset();
    }

    /**
     * Returns the needed indentation whitespace for fhe fixing of the uses.
     *
     * @param int $usePos
     *
     * @return string
     */
    private function getIndentationForFix(int $usePos): string
    {
        $file = $this->getFile();
        $indentation = '';
        $currentPointer = $usePos - 1;
        $tokens = $file->getTokens();

        while (
            $tokens[$currentPointer]['code'] === T_WHITESPACE &&
            $tokens[$currentPointer]['content'] !== $file->eolChar
        ) {
            $indentation .= $tokens[$currentPointer]['content'];
            $currentPointer--;
        }

        return $indentation;
    }

    /**
     * Processes the token.
     *
     * @return void
     */
    protected function processToken(): void
    {
        foreach ($this->uses as $use) {
            $this->checkDeclaration($use);
        }
    }
}


1			<?php
2
3			declare(strict_types=1);
4
5			namespace BestIt\Sniffs\Formatting;
6
7			use BestIt\CodeSniffer\Helper\ClassHelper;
8			use BestIt\CodeSniffer\Helper\TokenHelper;
9			use BestIt\Sniffs\AbstractSniff;
10			use BestIt\Sniffs\ClassRegistrationTrait;
11			use const T_COMMA;
12			use const T_OPEN_CURLY_BRACKET;
13			use const T_SEMICOLON;
14			use const T_WHITESPACE;
15
16			/**
17			* Sniffs if the uses in a class are correct.
18			*
19			* @author blange <[email protected]>
20			* @package BestIt\Sniffs\Formatting
21			*/
22			class TraitUseDeclarationSniff extends AbstractSniff
23			{
24			use ClassRegistrationTrait;
25
26			/**
27			* You MUST provide only one "use" per Line for importing traits etc. in classes.
28			*/
29			public const CODE_MULTIPLE_TRAITS_PER_DECLARATION = 'MultipleTraitsPerDeclaration';
30
31			/**
32			* Readable error message.
33			*/
34			private const MESSAGE_MULTIPLE_TRAITS_PER_DECLARATION = 'Multiple traits per use statement are forbidden.';
35
36			/**
37			* The use declarations positions of this "class".
38			*
39			* @var array
40			*/
41			private array $uses;
			0 ignored issues – show Bug introduced 2020-06-12 10:39 UTC by Report Bug Copy Issue Report Show Similar Issues like this This code did not parse for me. Apparently, there is an error somewhere around this line: Syntax error, unexpected T_ARRAY, expecting T_FUNCTION or T_CONST Loading history...
42
43			/**
44			* Returns false if there are no uses.
45			*
46			* @return bool
47			*/
48			protected function areRequirementsMet(): bool
49			{
50			return (bool) $this->uses = ClassHelper::getTraitUsePointers($this->getFile(), $this->getStackPos());
51			}
52
53			/**
54			* Checks the declaration of the given use position and registers and error if needed.
55			*
56			* @param int $usePos
57			*
58			* @return void
59			*/
60			private function checkDeclaration(int $usePos): void
61			{
62			$file = $this->getFile();
63
64			if (TokenHelper::findNextLocal($file, T_COMMA, $usePos + 1)) {
65			$endPos = TokenHelper::findNext($file, [T_OPEN_CURLY_BRACKET, T_SEMICOLON], $usePos + 1);
66			$tokens = $file->getTokens();
67
68			if ($tokens[$endPos]['code'] === T_OPEN_CURLY_BRACKET) {
69			$file->addError(
70			self::MESSAGE_MULTIPLE_TRAITS_PER_DECLARATION,
71			$usePos,
72			static::CODE_MULTIPLE_TRAITS_PER_DECLARATION
73			);
74			} else {
75			$fix = $file->addFixableError(
76			self::MESSAGE_MULTIPLE_TRAITS_PER_DECLARATION,
77			$usePos,
78			static::CODE_MULTIPLE_TRAITS_PER_DECLARATION
79			);
80
81			if ($fix) {
82			$this->fixeUse($endPos, $usePos);
83			}
84			}
85			}
86			}
87
88			/**
89			* Fixes the given use position.
90			*
91			* @param int $endPos The end of the checked position.
92			* @param int $usePos
93			*
94			* @return void
95			*/
96			protected function fixeUse(int $endPos, int $usePos): void
97			{
98			$indentation = $this->getIndentationForFix($usePos);
99			$file = $this->getFile();
100			$fixer = $file->fixer;
101
102			$fixer->beginChangeset();
103
104			$commaPointers = TokenHelper::findNextAll($file, T_COMMA, $usePos + 1, $endPos);
105			foreach ($commaPointers as $commaPos) {
106			$pointerAfterComma = TokenHelper::findNextEffective($file, $commaPos + 1);
107			$fixer->replaceToken($commaPos, ';' . $file->eolChar . $indentation . 'use ');
108			for ($i = $commaPos + 1; $i < $pointerAfterComma; $i++) {
109			$fixer->replaceToken($i, '');
110			}
111			}
112
113			$fixer->endChangeset();
114			}
115
116			/**
117			* Returns the needed indentation whitespace for fhe fixing of the uses.
118			*
119			* @param int $usePos
120			*
121			* @return string
122			*/
123			private function getIndentationForFix(int $usePos): string
124			{
125			$file = $this->getFile();
126			$indentation = '';
127			$currentPointer = $usePos - 1;
128			$tokens = $file->getTokens();
129
130			while (
131			$tokens[$currentPointer]['code'] === T_WHITESPACE &&
132			$tokens[$currentPointer]['content'] !== $file->eolChar
133			) {
134			$indentation .= $tokens[$currentPointer]['content'];
135			$currentPointer--;
136			}
137
138			return $indentation;
139			}
140
141			/**
142			* Processes the token.
143			*
144			* @return void
145			*/
146			protected function processToken(): void
147			{
148			foreach ($this->uses as $use) {
149			$this->checkDeclaration($use);
150			}
151			}
152			}
153

bestit / PHP_CodeSniffer

Issues (51)

Security Analysis no request data

Sniffs/Formatting/TraitUseDeclarationSniff.php (1 issue)

Labels

Severity

Introduced By

Upgrade to new PHP Analysis Engine

Duplication Side-by-Side

Filter issues like