Misc::urlParser() - Code Metrics - Inspection of "Merge pull request #51 from w3l/dev" - w3l/holt45 - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 48ae1f...7cd5fb )

by w3l

created 2017-05-10 17:39 UTC

Misc::urlParser() B

↳ Parent: Misc

Complexity

Conditions	9
Paths	97

Size

Total Lines	55
Code Lines	26

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	9
eloc	26
nc	97
nop	1
dl	0
loc	55
rs	7.2446
c	0
b	0
f	0

How to fix Long Method

<?php
/**
 * Misc.php
 */
namespace w3l\Holt45;

/**
 * Things that does not fit in other traits...
 */
trait Misc
{
    /**
     * Convert ISO 3166-1 alpha-2 code to (English) country name.
     *
     * @uses Holt45::getCountriesList()
     *
     * @param string $key ISO 3166-1 alpha-2 code
     * @return string Country name OR $key if no match.
     */
    public static function iso3166ToName($key)
    {
        $countries = self::getCountriesList();

        return ((array_key_exists($key, $countries)) ? $countries[$key] : $key);
    }

    /**
     * Tries to auto-correct parse_url()-output.
     *
     * @used-by Holt45::autoCorrectParseUrl()
     *
     * @param string $url
     * @return string[]|false

     */
    private static function autoCorrectParseUrl($url)
    {
        // multiple /// messes up parse_url, replace 3 or more with 2
        $url = preg_replace('/(\/{2,})/', '//', $url);

        $parseUrl = parse_url($url);

        if (empty($parseUrl["scheme"])) {
            $parseUrl["scheme"] = "http";
        }
        if (empty($parseUrl["host"]) && !empty($parseUrl["path"])) {
            // Strip slash from the beginning of path
            $parseUrl["host"] = ltrim($parseUrl["path"], '\/');
            $parseUrl["path"] = "";
        }
        return $parseUrl;
    }

    /**
     * parse url, try to correct errors and return valid url + display-url.
     *
     * Example:
     * ```
     * http:/wwww.example.com/lorum.html => http://www.example.com/lorum.html
     * gopher:/ww.example.com => gopher://www.example.com
     * http:/www3.example.com/?q=asd&f=#asd =>http://www3.example.com/?q=asd&f=#asd
     * asd://.example.com/folder/folder/ =>http://example.com/folder/folder/
     * .example.com/ => http://example.com/
     * example.com =>http://example.com
     * subdomain.example.com => http://subdomain.example.com
     * ```
     *
     * @uses Holt45::autoCorrectParseUrl()
     *
     * @param string $url Any somewhat valid url.
     * @return string[] "url" contains an auto-corrected url. "url_display" host.tld or subdomain.host.tld

     */
    public static function urlParser($url)
    {

        $parseUrl = self::autoCorrectParseUrl($url);

        // malformed URL, parse_url() returns false. Returns urls "as is".
        if ($parseUrl === false) {
            return array("url" => $url, "url_display" => $url);
        }

        $urlArray = array("url" => "", "url_display" => "");

        // Check if scheme is correct
        if (!in_array($parseUrl["scheme"], array("http", "https", "gopher"))) {
            $urlArray["url"] .= 'http'.'://';
        } else {
            $urlArray["url"] .= $parseUrl["scheme"].'://';
        }

        // Check if the right amount of "www" is set.
        $explodeHost = explode(".", $parseUrl["host"]);

        // Remove empty entries
        $explodeHost = array_filter($explodeHost);
        // And reassign indexes
        $explodeHost = array_values($explodeHost);

        // Contains subdomain
        if (count($explodeHost) > 2) {
            // Check if subdomain only contains the letter w(then not any other subdomain).
            if (substr_count($explodeHost[0], 'w') == strlen($explodeHost[0])) {
                // Replace with "www" to avoid "ww" or "wwww", etc.
                $explodeHost[0] = "www";

            }
        }

        $urlArray["url"] .= implode(".", $explodeHost);
        $urlArray["url_display"] = trim(implode(".", $explodeHost), '\/'); // Removes trailing slash

        if (!empty($parseUrl["port"])) {
            $urlArray["url"] .= ":".$parseUrl["port"];
        }
        if (!empty($parseUrl["path"])) {
            $urlArray["url"] .= $parseUrl["path"];
        }
        if (!empty($parseUrl["query"])) {
            $urlArray["url"] .= '?'.$parseUrl["query"];
        }
        if (!empty($parseUrl["fragment"])) {
            $urlArray["url"] .= '#'.$parseUrl["fragment"];
        }

        return $urlArray;
    }
    
    /**
     * To allow shorthand-requests for <Pre>, Print_R and Exit.
     *
     * @param array input array
     */
    public static function ppre($array)
    {
        echo '<pre>';
        print_r($array);
        echo '</pre>';
        EXIT;

    }
    
    /**
    * Generate a password-suggestion.
    *
    * @param int $length Length of password
    * @param string $passwordType "simple" limit character-set to first 33 characters. "long" uses 64 characters.
    * @return string
    */
    public static function generatePassword($length = 8, $passwordType = "long")
    {
        $characterSet = "23456789abcdefghijkmnopqrstuvwxyzABCDEFGHJKLMNPRSTUVWXYZ!#%+:=?@";
        $characterSetLenght = (($passwordType == "simple") ? 33 : 64);

        $counter = 0;
        $suggestedPassword = "";

        while ($counter < 10) {
            $suggestedPassword = "";

            for ($i = 0; $i < $length; $i++) {
                $suggestedPassword .= $characterSet[rand(0, ($characterSetLenght-1))];
            }

            if (strlen(count_chars($suggestedPassword, 3)) > ($length-2)) {
                break;
            }

            $counter++;
        }

        return $suggestedPassword;
    }
}


1			<?php
2			/**
3			* Misc.php
4			*/
5			namespace w3l\Holt45;
6
7			/**
8			* Things that does not fit in other traits...
9			*/
10			trait Misc
11			{
12			/**
13			* Convert ISO 3166-1 alpha-2 code to (English) country name.
14			*
15			* @uses Holt45::getCountriesList()
16			*
17			* @param string $key ISO 3166-1 alpha-2 code
18			* @return string Country name OR $key if no match.
19			*/
20			public static function iso3166ToName($key)
21			{
22			$countries = self::getCountriesList();
23
24			return ((array_key_exists($key, $countries)) ? $countries[$key] : $key);
25			}
26
27			/**
28			* Tries to auto-correct parse_url()-output.
29			*
30			* @used-by Holt45::autoCorrectParseUrl()
31			*
32			* @param string $url
33			* @return string[]\|false
			0 ignored issues – show Documentation introduced 2016-01-22 05:34 UTC by Report Bug Copy Issue Report Should the return type not be `array<string,string>\|false`? This check compares the return type specified in the `@return` annotation of a function or method doc comment with the types returned by the function and raises an issue if they mismatch. Loading history...
34			*/
35			private static function autoCorrectParseUrl($url)
36			{
37			// multiple /// messes up parse_url, replace 3 or more with 2
38			$url = preg_replace('/(\/{2,})/', '//', $url);
39
40			$parseUrl = parse_url($url);
41
42			if (empty($parseUrl["scheme"])) {
43			$parseUrl["scheme"] = "http";
44			}
45			if (empty($parseUrl["host"]) && !empty($parseUrl["path"])) {
46			// Strip slash from the beginning of path
47			$parseUrl["host"] = ltrim($parseUrl["path"], '\/');
48			$parseUrl["path"] = "";
49			}
50			return $parseUrl;
51			}
52
53			/**
54			* parse url, try to correct errors and return valid url + display-url.
55			*
56			* Example:
57			* ```
58			* http:/wwww.example.com/lorum.html => http://www.example.com/lorum.html
59			* gopher:/ww.example.com => gopher://www.example.com
60			* http:/www3.example.com/?q=asd&f=#asd =>http://www3.example.com/?q=asd&f=#asd
61			* asd://.example.com/folder/folder/ =>http://example.com/folder/folder/
62			* .example.com/ => http://example.com/
63			* example.com =>http://example.com
64			* subdomain.example.com => http://subdomain.example.com
65			* ```
66			*
67			* @uses Holt45::autoCorrectParseUrl()
68			*
69			* @param string $url Any somewhat valid url.
70			* @return string[] "url" contains an auto-corrected url. "url_display" host.tld or subdomain.host.tld
			0 ignored issues – show Documentation introduced 2016-01-19 12:35 UTC by Report Bug Copy Issue Report Should the return type not be `array<string,string>`? This check compares the return type specified in the `@return` annotation of a function or method doc comment with the types returned by the function and raises an issue if they mismatch. Loading history...
71			*/
72			public static function urlParser($url)
73			{
74
75			$parseUrl = self::autoCorrectParseUrl($url);
76
77			// malformed URL, parse_url() returns false. Returns urls "as is".
78			if ($parseUrl === false) {
79			return array("url" => $url, "url_display" => $url);
80			}
81
82			$urlArray = array("url" => "", "url_display" => "");
83
84			// Check if scheme is correct
85			if (!in_array($parseUrl["scheme"], array("http", "https", "gopher"))) {
86			$urlArray["url"] .= 'http'.'://';
87			} else {
88			$urlArray["url"] .= $parseUrl["scheme"].'://';
89			}
90
91			// Check if the right amount of "www" is set.
92			$explodeHost = explode(".", $parseUrl["host"]);
93
94			// Remove empty entries
95			$explodeHost = array_filter($explodeHost);
96			// And reassign indexes
97			$explodeHost = array_values($explodeHost);
98
99			// Contains subdomain
100			if (count($explodeHost) > 2) {
101			// Check if subdomain only contains the letter w(then not any other subdomain).
102			if (substr_count($explodeHost[0], 'w') == strlen($explodeHost[0])) {
103			// Replace with "www" to avoid "ww" or "wwww", etc.
104			$explodeHost[0] = "www";
105
106			}
107			}
108
109			$urlArray["url"] .= implode(".", $explodeHost);
110			$urlArray["url_display"] = trim(implode(".", $explodeHost), '\/'); // Removes trailing slash
111
112			if (!empty($parseUrl["port"])) {
113			$urlArray["url"] .= ":".$parseUrl["port"];
114			}
115			if (!empty($parseUrl["path"])) {
116			$urlArray["url"] .= $parseUrl["path"];
117			}
118			if (!empty($parseUrl["query"])) {
119			$urlArray["url"] .= '?'.$parseUrl["query"];
120			}
121			if (!empty($parseUrl["fragment"])) {
122			$urlArray["url"] .= '#'.$parseUrl["fragment"];
123			}
124
125			return $urlArray;
126			}
127
128			/**
129			* To allow shorthand-requests for <Pre>, Print_R and Exit.
130			*
131			* @param array input array
132			*/
133			public static function ppre($array)
134			{
135			echo '<pre>';
136			print_r($array);
137			echo '</pre>';
138			EXIT;
			0 ignored issues – show Coding Style Compatibility introduced 2017-05-09 23:56 UTC by Report Bug Copy Issue Report The method `ppre()` contains an exit expression. An exit expression should only be used in rare cases. For example, if you write a short command line script. In most cases however, using an `exit` expression makes the code untestable and often causes incompatibilities with other libraries. Thus, unless you are absolutely sure it is required here, we recommend to refactor your code to avoid its usage. Loading history...
139			}
140
141			/**
142			* Generate a password-suggestion.
143			*
144			* @param int $length Length of password
145			* @param string $passwordType "simple" limit character-set to first 33 characters. "long" uses 64 characters.
146			* @return string
147			*/
148			public static function generatePassword($length = 8, $passwordType = "long")
149			{
150			$characterSet = "23456789abcdefghijkmnopqrstuvwxyzABCDEFGHJKLMNPRSTUVWXYZ!#%+:=?@";
151			$characterSetLenght = (($passwordType == "simple") ? 33 : 64);
152
153			$counter = 0;
154			$suggestedPassword = "";
155
156			while ($counter < 10) {
157			$suggestedPassword = "";
158
159			for ($i = 0; $i < $length; $i++) {
160			$suggestedPassword .= $characterSet[rand(0, ($characterSetLenght-1))];
161			}
162
163			if (strlen(count_chars($suggestedPassword, 3)) > ($length-2)) {
164			break;
165			}
166
167			$counter++;
168			}
169
170			return $suggestedPassword;
171			}
172			}
173

w3l / holt45

GitHub Access Token became invalid

Push — master ( 48ae1f...7cd5fb )

Misc::urlParser() B

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like