EmailCheck::punnycode() - Code Metrics - Inspection of "[!]: "php": ">=7.0" v2" - voku/email-check - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( c69bf1...9e1abb )

by Lars

created 2017-12-01 19:10 UTC

EmailCheck::punnycode() C

↳ Parent: EmailCheck

Complexity

Conditions	14
Paths	41

Size

Total Lines	70
Code Lines	44

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	24
CRAP Score	16.2564

Importance

Changes

Metric	Value
c	0
b	0
f	0
dl	0
loc	70
ccs	24
cts	31
cp	0.7742
rs	5.6188
cc	14
eloc	44
nc	41
nop	2
crap	16.2564

How to fix Long Method Complexity

<?php

declare(strict_types=1);

namespace voku\helper;

use TrueBV\Exception\LabelOutOfBoundsException;
use TrueBV\Punycode;

/**
 * E-Mail Check Class
 *
 * -> use "EmailCheck::isValid()" to validate a email-address
 *
 * @author      Lars Moelleken
 * @copyright   Copyright (c) 2017, Lars Moelleken (http://moelleken.org/)
 * @license     http://opensource.org/licenses/MIT	MIT License
 */
class EmailCheck
{
  /**
   * @var null|array
   */
  protected static $domainsExample = null;

  /**
   * @var null|array
   */
  protected static $domainsTemporary = null;

  /**
   * @var null|array
   */
  protected static $domainsTypo = null;

  /**
   * @var bool
   */
  protected static $useDnsCheck = true;

  /**
   * Check if the email is valid.
   *
   * @param string $email
   * @param bool   $useExampleDomainCheck
   * @param bool   $useTypoInDomainCheck
   * @param bool   $useTemporaryDomainCheck
   * @param bool   $useDnsCheck (do not use, if you don't need it)
   *
   * @return bool
   */
  public static function isValid(string $email, bool $useExampleDomainCheck = false, bool $useTypoInDomainCheck = false, bool $useTemporaryDomainCheck = false, bool $useDnsCheck = false): bool
  {
    // must be a string
    if (!\is_string($email)) {
      return false;
    }

    // make sure string length is limited to avoid DOS attacks
    $emailStringLength = \strlen($email);
    if (
        $emailStringLength >= 320
        ||
        $emailStringLength <= 2 // i@y //
    ) {
      return false;
    }
    unset($emailStringLength);

    $email = \str_replace(
        [
            '.', // non-Latin chars are also allowed | https://tools.ietf.org/html/rfc6530
            '＠', // non-Latin chars are also allowed | https://tools.ietf.org/html/rfc6530
        ],
        [
            '.',
            '@',
        ],
        $email
    );

    if (
        (\strpos($email, '@') === false) // "at" is needed
        ||
        (\strpos($email, '.') === false && \strpos($email, ':') === false) // "dot" or "colon" is needed
    ) {
      return false;
    }

    if (!\preg_match('/^(?<local>.*<?)(?:.*)@(?<domain>.*)(?:>?)$/', $email, $parts)) {
      return false;
    }

    $local = $parts['local'];
    $domain = $parts['domain'];

    if (!$local) {
      return false;
    }

    if (!$domain) {
      return false;
    }

    // Escaped spaces are allowed in the "local"-part.
    $local = \str_replace('\\ ', '', $local);

    // Spaces in quotes e.g. "firstname lastname"@foo.bar are also allowed in the "local"-part.
    $quoteHelperForIdn = false;
    if (\preg_match('/^"(?<inner>[^"]*)"$/mU', $local, $parts)) {
      $quoteHelperForIdn = true;
      $local = \trim(
          \str_replace(
              $parts['inner'],
              \str_replace(' ', '', $parts['inner']),
              $local
          ),
          '"'
      );
    }

    if (
        \strpos($local, ' ') !== false // no spaces allowed, anymore
        ||
        \strpos($local, '".') !== false // no quote + dot allowed
    ) {
      return false;
    }

    list($local, $domain) = self::punnycode($local, $domain);

    if ($quoteHelperForIdn === true) {
      $local = '"' . $local . '"';
    }

    $email = $local . '@' . $domain;

    if (!\filter_var($email, FILTER_VALIDATE_EMAIL)) {
      return false;
    }

    if ($useExampleDomainCheck === true && self::isExampleDomain($domain) === true) {
      return false;
    }

    if ($useTypoInDomainCheck === true && self::isTypoInDomain($domain) === true) {
      return false;
    }

    if ($useTemporaryDomainCheck === true && self::isTemporaryDomain($domain) === true) {
      return false;
    }

    if ($useDnsCheck === true && self::isDnsError($domain) === true) {
      return false;
    }

    return true;
  }

  /**
   * Check if the domain is a example domain.
   *
   * @param string $domain
   *
   * @return bool
   */
  public static function isExampleDomain(string $domain): bool

  {
    if (self::$domainsExample === null) {
      self::$domainsExample = self::getData('domainsExample');
    }

    if (\in_array($domain, self::$domainsExample, true)) {
      return true;
    }

    return false;
  }

  /**
   * Check if the domain has a typo.
   *
   * @param string $domain
   *
   * @return bool
   */
  public static function isTypoInDomain(string $domain): bool

  {
    if (self::$domainsTypo === null) {
      self::$domainsTypo = self::getData('domainsTypo');
    }

    if (\in_array($domain, self::$domainsTypo, true)) {
      return true;
    }

    return false;
  }

  /**
   * Check if the domain is a temporary domain.
   *
   * @param string $domain
   *
   * @return bool
   */
  public static function isTemporaryDomain(string $domain): bool

  {
    if (self::$domainsTemporary === null) {
      self::$domainsTemporary = self::getData('domainsTemporary');
    }

    if (\in_array($domain, self::$domainsTemporary, true)) {
      return true;
    }

    return false;
  }

  /**
   * get data from "/data/*.php"
   *
   * @param string $file
   *
   * @return bool|string|array|int <p>Will return false on error.</p>
   */
  protected static function getData(string $file)
  {
    $file = __DIR__ . '/data/' . $file . '.php';
    if (\file_exists($file)) {
      /** @noinspection PhpIncludeInspection */
      return require $file;
    }

    return false;
  }

  /**
   * Check if the domain has a typo.
   *
   * @param string $domain
   *
   * @return bool|null will return null if we can't use the "checkdnsrr"-function
   *
   * @throws \Exception
   */
  public static function isDnsError(string $domain)
  {
    if (\function_exists('checkdnsrr')) {
      return !\checkdnsrr($domain . '.', 'MX') || !\checkdnsrr($domain, 'A');
    }

    throw new \Exception(' Can\'t call checkdnsrr');
  }

  /**
   * @param string $local
   * @param string $domain
   *
   * @return array
   */
  private static function punnycode(string $local, string $domain): array
  {
    $max_chr_width = UTF8::max_chr_width($local . $domain);

    if ($max_chr_width <= 1) {
      return [$local, $domain];
    }

    if (
        $max_chr_width <= 3 // check for unicode chars with more then 3 bytes
        &&
        \function_exists('idn_to_ascii')
    ) {

      // https://git.ispconfig.org/ispconfig/ispconfig3/blob/master/interface/lib/classes/functions.inc.php#L305
      if (
          \defined('IDNA_NONTRANSITIONAL_TO_ASCII')
          &&
          \defined('INTL_IDNA_VARIANT_UTS46')
          &&
          \constant('IDNA_NONTRANSITIONAL_TO_ASCII')
      ) {
        $useIdnaUts46 = true;
      } else {
        $useIdnaUts46 = false;
      }

      if ($useIdnaUts46 === true) {
        $localTmp = idn_to_ascii($local, IDNA_NONTRANSITIONAL_TO_ASCII, INTL_IDNA_VARIANT_UTS46);
      } else {
        $localTmp = idn_to_ascii($local);
      }
      if ($localTmp) {
        $local = $localTmp;
      }
      unset($localTmp);

      if ($useIdnaUts46 === true) {
        $domainTmp = idn_to_ascii($domain, IDNA_NONTRANSITIONAL_TO_ASCII, INTL_IDNA_VARIANT_UTS46);
      } else {
        $domainTmp = idn_to_ascii($domain);
      }
      if ($domainTmp) {
        $domain = $domainTmp;
      }
      unset($domainTmp);

    } else {

      static $punycode = null;
      if ($punycode === null) {
        $punycode = new Punycode();
      }

      try {
        $local = $punycode->encode($local);
      } catch (LabelOutOfBoundsException $e) {
        $local = '';
      }

      try {
        $domain = $punycode->encode($domain);
      } catch (LabelOutOfBoundsException $e) {
        $domain = '';
      }

    }

    return [$local, $domain];
  }
}


1			<?php
2
3			declare(strict_types=1);
4
5			namespace voku\helper;
6
7			use TrueBV\Exception\LabelOutOfBoundsException;
8			use TrueBV\Punycode;
9
10			/**
11			* E-Mail Check Class
12			*
13			* -> use "EmailCheck::isValid()" to validate a email-address
14			*
15			* @author Lars Moelleken
16			* @copyright Copyright (c) 2017, Lars Moelleken (http://moelleken.org/)
17			* @license http://opensource.org/licenses/MIT MIT License
18			*/
19			class EmailCheck
20			{
21			/**
22			* @var null\|array
23			*/
24			protected static $domainsExample = null;
25
26			/**
27			* @var null\|array
28			*/
29			protected static $domainsTemporary = null;
30
31			/**
32			* @var null\|array
33			*/
34			protected static $domainsTypo = null;
35
36			/**
37			* @var bool
38			*/
39			protected static $useDnsCheck = true;
40
41			/**
42			* Check if the email is valid.
43			*
44			* @param string $email
45			* @param bool $useExampleDomainCheck
46			* @param bool $useTypoInDomainCheck
47			* @param bool $useTemporaryDomainCheck
48			* @param bool $useDnsCheck (do not use, if you don't need it)
49			*
50			* @return bool
51			*/
52	151		public static function isValid(string $email, bool $useExampleDomainCheck = false, bool $useTypoInDomainCheck = false, bool $useTemporaryDomainCheck = false, bool $useDnsCheck = false): bool
53			{
54			// must be a string
55	151		if (!\is_string($email)) {
56			return false;
57			}
58
59			// make sure string length is limited to avoid DOS attacks
60	151		$emailStringLength = \strlen($email);
61			if (
62	151		$emailStringLength >= 320
63			\|\|
64	151		$emailStringLength <= 2 // i@y //
65			) {
66	4		return false;
67			}
68	149		unset($emailStringLength);
69
70	149		$email = \str_replace(
71			[
72	149		'.', // non-Latin chars are also allowed \| https://tools.ietf.org/html/rfc6530
73			'＠', // non-Latin chars are also allowed \| https://tools.ietf.org/html/rfc6530
74			],
75			[
76	149		'.',
77			'@',
78			],
79	149		$email
80			);
81
82			if (
83	149		(\strpos($email, '@') === false) // "at" is needed
84			\|\|
85	149		(\strpos($email, '.') === false && \strpos($email, ':') === false) // "dot" or "colon" is needed
86			) {
87	24		return false;
88			}
89
90	128		if (!\preg_match('/^(?<local>.<?)(?:.)@(?<domain>.*)(?:>?)$/', $email, $parts)) {
91	9		return false;
92			}
93
94	119		$local = $parts['local'];
95	119		$domain = $parts['domain'];
96
97	119		if (!$local) {
98	2		return false;
99			}
100
101	118		if (!$domain) {
102			return false;
103			}
104
105			// Escaped spaces are allowed in the "local"-part.
106	118		$local = \str_replace('\\ ', '', $local);
107
108			// Spaces in quotes e.g. "firstname lastname"@foo.bar are also allowed in the "local"-part.
109	118		$quoteHelperForIdn = false;
110	118		if (\preg_match('/^"(?<inner>[^"]*)"$/mU', $local, $parts)) {
111	17		$quoteHelperForIdn = true;
112	17		$local = \trim(
113	17		\str_replace(
114	17		$parts['inner'],
115	17		\str_replace(' ', '', $parts['inner']),
116	17		$local
117			),
118	17		'"'
119			);
120			}
121
122			if (
123	118		\strpos($local, ' ') !== false // no spaces allowed, anymore
124			\|\|
125	118		\strpos($local, '".') !== false // no quote + dot allowed
126			) {
127	13		return false;
128			}
129
130	106		list($local, $domain) = self::punnycode($local, $domain);
131
132	106		if ($quoteHelperForIdn === true) {
133	17		$local = '"' . $local . '"';
134			}
135
136	106		$email = $local . '@' . $domain;
137
138	106		if (!\filter_var($email, FILTER_VALIDATE_EMAIL)) {
139	63		return false;
140			}
141
142	44		if ($useExampleDomainCheck === true && self::isExampleDomain($domain) === true) {
143	2		return false;
144			}
145
146	44		if ($useTypoInDomainCheck === true && self::isTypoInDomain($domain) === true) {
147	1		return false;
148			}
149
150	44		if ($useTemporaryDomainCheck === true && self::isTemporaryDomain($domain) === true) {
151			return false;
152			}
153
154	44		if ($useDnsCheck === true && self::isDnsError($domain) === true) {
155	3		return false;
156			}
157
158	41		return true;
159			}
160
161			/**
162			* Check if the domain is a example domain.
163			*
164			* @param string $domain
165			*
166			* @return bool
167			*/
168	2	View Code Duplication	public static function isExampleDomain(string $domain): bool
			0 ignored issues – show Duplication introduced 2017-12-01 19:13 UTC by Report Bug Copy Issue Report 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...
169			{
170	2		if (self::$domainsExample === null) {
171	1		self::$domainsExample = self::getData('domainsExample');
172			}
173
174	2		if (\in_array($domain, self::$domainsExample, true)) {
175	2		return true;
176			}
177
178	2		return false;
179			}
180
181			/**
182			* Check if the domain has a typo.
183			*
184			* @param string $domain
185			*
186			* @return bool
187			*/
188	3	View Code Duplication	public static function isTypoInDomain(string $domain): bool
			0 ignored issues – show Duplication introduced 2017-12-01 19:13 UTC by Report Bug Copy Issue Report 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...
189			{
190	3		if (self::$domainsTypo === null) {
191	1		self::$domainsTypo = self::getData('domainsTypo');
192			}
193
194	3		if (\in_array($domain, self::$domainsTypo, true)) {
195	2		return true;
196			}
197
198	3		return false;
199			}
200
201			/**
202			* Check if the domain is a temporary domain.
203			*
204			* @param string $domain
205			*
206			* @return bool
207			*/
208	3	View Code Duplication	public static function isTemporaryDomain(string $domain): bool
			0 ignored issues – show Duplication introduced 2017-12-01 19:13 UTC by Report Bug Copy Issue Report 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...
209			{
210	3		if (self::$domainsTemporary === null) {
211	1		self::$domainsTemporary = self::getData('domainsTemporary');
212			}
213
214	3		if (\in_array($domain, self::$domainsTemporary, true)) {
215	1		return true;
216			}
217
218	3		return false;
219			}
220
221			/**
222			* get data from "/data/*.php"
223			*
224			* @param string $file
225			*
226			* @return bool\|string\|array\|int <p>Will return false on error.</p>
227			*/
228	1		protected static function getData(string $file)
229			{
230	1		$file = __DIR__ . '/data/' . $file . '.php';
231	1		if (\file_exists($file)) {
232			/** @noinspection PhpIncludeInspection */
233	1		return require $file;
234			}
235
236			return false;
237			}
238
239			/**
240			* Check if the domain has a typo.
241			*
242			* @param string $domain
243			*
244			* @return bool\|null will return null if we can't use the "checkdnsrr"-function
245			*
246			* @throws \Exception
247			*/
248	4		public static function isDnsError(string $domain)
249			{
250	4		if (\function_exists('checkdnsrr')) {
251	4		return !\checkdnsrr($domain . '.', 'MX') \|\| !\checkdnsrr($domain, 'A');
252			}
253
254			throw new \Exception(' Can\'t call checkdnsrr');
255			}
256
257			/**
258			* @param string $local
259			* @param string $domain
260			*
261			* @return array
262			*/
263	106		private static function punnycode(string $local, string $domain): array
264			{
265	106		$max_chr_width = UTF8::max_chr_width($local . $domain);
266
267	106		if ($max_chr_width <= 1) {
268	98		return [$local, $domain];
269			}
270
271			if (
272	9		$max_chr_width <= 3 // check for unicode chars with more then 3 bytes
273			&&
274	9		\function_exists('idn_to_ascii')
275			) {
276
277			// https://git.ispconfig.org/ispconfig/ispconfig3/blob/master/interface/lib/classes/functions.inc.php#L305
278			if (
279			\defined('IDNA_NONTRANSITIONAL_TO_ASCII')
280			&&
281			\defined('INTL_IDNA_VARIANT_UTS46')
282			&&
283	8		\constant('IDNA_NONTRANSITIONAL_TO_ASCII')
284			) {
285	8		$useIdnaUts46 = true;
286			} else {
287			$useIdnaUts46 = false;
288			}
289
290	8		if ($useIdnaUts46 === true) {
291	8		$localTmp = idn_to_ascii($local, IDNA_NONTRANSITIONAL_TO_ASCII, INTL_IDNA_VARIANT_UTS46);
292			} else {
293			$localTmp = idn_to_ascii($local);
294			}
295	8		if ($localTmp) {
296	8		$local = $localTmp;
297			}
298	8		unset($localTmp);
299
300	8		if ($useIdnaUts46 === true) {
301	8		$domainTmp = idn_to_ascii($domain, IDNA_NONTRANSITIONAL_TO_ASCII, INTL_IDNA_VARIANT_UTS46);
302			} else {
303			$domainTmp = idn_to_ascii($domain);
304			}
305	8		if ($domainTmp) {
306	8		$domain = $domainTmp;
307			}
308	8		unset($domainTmp);
309
310			} else {
311
312	1		static $punycode = null;
313	1		if ($punycode === null) {
314	1		$punycode = new Punycode();
315			}
316
317			try {
318	1		$local = $punycode->encode($local);
319			} catch (LabelOutOfBoundsException $e) {
320			$local = '';
321			}
322
323			try {
324	1		$domain = $punycode->encode($domain);
325			} catch (LabelOutOfBoundsException $e) {
326			$domain = '';
327			}
328
329			}
330
331	9		return [$local, $domain];
332			}
333			}
334

voku / email-check

Push — master ( c69bf1...9e1abb )

EmailCheck::punnycode() C

Complexity

Size

Duplication

Code Coverage

Importance

How to fix Long Method Complexity

Long Method

Duplication Side-by-Side

Filter issues like