StringTwigExtension - Code Metrics - core23/AntiSpamBundle - Measure and Improve Code Quality continuously with Scrutinizer

StringTwigExtension A
last analyzed 2019-12-09 17:09 UTC

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	104
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Importance

Changes

Metric	Value
wmc	15
lcom	1
cbo	2
dl	0
loc	104
rs	10
c	0
b	0
f	0

6 Methods

Rating	Name	Size	Complexity
A	__construct()	6	1
A	getFilters()	8	1
A	antispam()	8	4
A	encryptMailText()	8	1
A	encryptMail()	16	4
A	getSecuredName()	14	4

<?php

declare(strict_types=1);

/*
 * (c) Christian Gripp <[email protected]>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Core23\AntiSpamBundle\Twig\Extension;

use Twig\Extension\AbstractExtension;
use Twig\TwigFilter;

final class StringTwigExtension extends AbstractExtension
{
    private const MAIL_HTML_PATTERN = '/\<a(?:[^>]+)href\=\"mailto\:([^">]+)\"(?:[^>]*)\>(.*?)\<\/a\>/ism';
    private const MAIL_TEXT_PATTERN = '/(([A-Z0-9._%+-]+)@([A-Z0-9.-]+)\.([A-Z]{2,4})(\((.+?)\))?)/i';

    /**
     * @var string|null
     */
    private $mailCssClass;

    /**
     * @var string[]
     */
    private $mailAtText;

    /**
     * @var string[]
     */
    private $mailDotText;

    /**
     * @param string[] $mailAtText
     * @param string[] $mailDotText
     */
    public function __construct(?string $mailCssClass, array $mailAtText, array $mailDotText)
    {
        $this->mailCssClass = $mailCssClass;
        $this->mailAtText   = $mailAtText;
        $this->mailDotText  = $mailDotText;
    }

    public function getFilters()
    {
        return [
            new TwigFilter('antispam', [$this, 'antispam'], [
                'is_safe' => ['html'],
            ]),
        ];
    }

    /**
     * Replaces E-Mail addresses with an alternative text representation.
     *
     * @param string $string input string
     * @param bool   $html   Secure html or text
     *
     * @return string with replaced links
     */
    public function antispam(string $string, bool $html = true): string
    {
        if ($html) {
            return preg_replace_callback(self::MAIL_HTML_PATTERN, [$this, 'encryptMail'], $string) ?: '';
        }

        return preg_replace_callback(self::MAIL_TEXT_PATTERN, [$this, 'encryptMailText'], $string) ?: '';
    }

    /**
     * @param string[] $matches
     */
    private function encryptMailText(array $matches): string
    {
        $email = $matches[1];

        return $this->getSecuredName($email).
            $this->mailAtText[array_rand($this->mailAtText)].
            $this->getSecuredName($email, true);
    }

    /**
     * @param string[] $matches
     */
    private function encryptMail(array $matches): string
    {
        [, $email, $text] = $matches;
function someFunction() {
    $x = 5;
    echo $x;
}

        if ($text === $email) {
function someFunction() {
    $x = 5;
    echo $x;
}
            $text = '';
        }

        return
            '<span'.(null !== $this->mailCssClass ? ' class="'.$this->mailCssClass.'"' : '').'>'.
            '<span>'.$this->getSecuredName($email).'</span>'.
                $this->mailAtText[array_rand($this->mailAtText)].
            '<span>'.$this->getSecuredName($email, true).'</span>'.
            ('' !== $text ? ' (<span>'.$text.'</span>)' : '').
function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;
    }

    // $x is potentially undefined here.
    echo $x;
}
            '</span>';
    }

    private function getSecuredName(string $name, bool $isDomain = false): string
    {
        $index = strpos($name, '@');

        \assert(false !== $index && -1 !== $index);

        if ($isDomain) {
            $name = substr($name, $index + 1);
        } else {
            $name = substr($name, 0, $index);
        }

        return str_replace('.', $this->mailDotText[array_rand($this->mailDotText)], $name ?: '');
    }
}


1			<?php
2
3			declare(strict_types=1);
4
5			/*
6			* (c) Christian Gripp <[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 Core23\AntiSpamBundle\Twig\Extension;
13
14			use Twig\Extension\AbstractExtension;
15			use Twig\TwigFilter;
16
17			final class StringTwigExtension extends AbstractExtension
18			{
19			private const MAIL_HTML_PATTERN = '/\<a(?:[^>]+)href\=\"mailto\:([^">]+)\"(?:[^>])\>(.?)\<\/a\>/ism';
20			private const MAIL_TEXT_PATTERN = '/(([A-Z0-9._%+-]+)@([A-Z0-9.-]+)\.([A-Z]{2,4})(\((.+?)\))?)/i';
21
22			/**
23			* @var string\|null
24			*/
25			private $mailCssClass;
26
27			/**
28			* @var string[]
29			*/
30			private $mailAtText;
31
32			/**
33			* @var string[]
34			*/
35			private $mailDotText;
36
37			/**
38			* @param string[] $mailAtText
39			* @param string[] $mailDotText
40			*/
41			public function __construct(?string $mailCssClass, array $mailAtText, array $mailDotText)
42			{
43			$this->mailCssClass = $mailCssClass;
44			$this->mailAtText = $mailAtText;
45			$this->mailDotText = $mailDotText;
46			}
47
48			public function getFilters()
49			{
50			return [
51			new TwigFilter('antispam', [$this, 'antispam'], [
52			'is_safe' => ['html'],
53			]),
54			];
55			}
56
57			/**
58			* Replaces E-Mail addresses with an alternative text representation.
59			*
60			* @param string $string input string
61			* @param bool $html Secure html or text
62			*
63			* @return string with replaced links
64			*/
65			public function antispam(string $string, bool $html = true): string
66			{
67			if ($html) {
68			return preg_replace_callback(self::MAIL_HTML_PATTERN, [$this, 'encryptMail'], $string) ?: '';
69			}
70
71			return preg_replace_callback(self::MAIL_TEXT_PATTERN, [$this, 'encryptMailText'], $string) ?: '';
72			}
73
74			/**
75			* @param string[] $matches
76			*/
77			private function encryptMailText(array $matches): string
78			{
79			$email = $matches[1];
80
81			return $this->getSecuredName($email).
82			$this->mailAtText[array_rand($this->mailAtText)].
83			$this->getSecuredName($email, true);
84			}
85
86			/**
87			* @param string[] $matches
88			*/
89			private function encryptMail(array $matches): string
90			{
91			[, $email, $text] = $matches;
			0 ignored issues – show Bug introduced 2018-01-30 19:07 UTC by Report Bug Copy Issue Report The variable `$email` does not exist. Did you forget to declare it? This check marks access to variables or properties that have not been declared yet. While PHP has no explicit notion of declaring a variable, accessing it before a value is assigned to it is most likely a bug. Loading history... Bug introduced 2018-01-30 19:07 UTC by Report Bug Copy Issue Report The variable `$text` seems only to be defined at a later point. Did you maybe move this code here without moving the variable definition? This error can happen if you refactor code and forget to move the variable initialization. Let’s take a look at a simple example: function someFunction() { $x = 5; echo $x; } The above code is perfectly fine. Now imagine that we re-order the statements: function someFunction() { echo $x; $x = 5; } In that case, `$x` would be read before it is initialized. This was a very basic example, however the principle is the same for the found issue. Loading history...
92
93			if ($text === $email) {
			0 ignored issues – show Bug introduced 2018-01-30 19:07 UTC by Report Bug Copy Issue Report The variable `$text` seems only to be defined at a later point. Did you maybe move this code here without moving the variable definition? This error can happen if you refactor code and forget to move the variable initialization. Let’s take a look at a simple example: function someFunction() { $x = 5; echo $x; } The above code is perfectly fine. Now imagine that we re-order the statements: function someFunction() { echo $x; $x = 5; } In that case, `$x` would be read before it is initialized. This was a very basic example, however the principle is the same for the found issue. Loading history...
94			$text = '';
95			}
96
97			return
98			'<span'.(null !== $this->mailCssClass ? ' class="'.$this->mailCssClass.'"' : '').'>'.
99			'<span>'.$this->getSecuredName($email).'</span>'.
100			$this->mailAtText[array_rand($this->mailAtText)].
101			'<span>'.$this->getSecuredName($email, true).'</span>'.
102			('' !== $text ? ' (<span>'.$text.'</span>)' : '').
			0 ignored issues – show Bug introduced 2018-01-30 19:07 UTC by Report Bug Copy Issue Report The variable `$text` does not seem to be defined for all execution paths leading up to this point. If you define a variable conditionally, it can happen that it is not defined for all execution paths. Let’s take a look at an example: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } // $x is potentially undefined here. echo $x; } In the above example, the variable `$x` is defined if you pass “foo” or “bar” as argument for `$a`. However, since the `switch` statement has no default case statement, if you pass any other value, the variable `$x` would be undefined. Available Fixes Check for existence of the variable explicitly: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } if (isset($x)) { // Make sure it's always set. echo $x; } } Define a default value for the variable: function myFunction($a) { $x = ''; // Set a default which gets overridden for certain paths. switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } echo $x; } Add a value for the missing path: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; // We add support for the missing case. default: $x = ''; break; } echo $x; } Loading history...
103			'</span>';
104			}
105
106			private function getSecuredName(string $name, bool $isDomain = false): string
107			{
108			$index = strpos($name, '@');
109
110			\assert(false !== $index && -1 !== $index);
111
112			if ($isDomain) {
113			$name = substr($name, $index + 1);
114			} else {
115			$name = substr($name, 0, $index);
116			}
117
118			return str_replace('.', $this->mailDotText[array_rand($this->mailDotText)], $name ?: '');
119			}
120			}
121

core23 / AntiSpamBundle

GitHub Access Token became invalid

StringTwigExtension A last analyzed 2019-12-09 17:09 UTC

Complexity

Size/Duplication

Coupling/Cohesion

Importance

6 Methods

Available Fixes

Duplication Side-by-Side

Filter issues like

StringTwigExtension A
last analyzed 2019-12-09 17:09 UTC