w3l\Holt45\Misc

Complexity

Total Complexity

20

Size/Duplication

Total Lines	151
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	0

Importance

Changes	16
Bugs	1	Features	0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	iso3166ToName()	0	6	2
A	autoCorrectParseUrl()	0	17	4
B	urlParser()	0	55	9
B	generatePassword()	0	25	5

<?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

Should the return type not be array<string,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

Should the return type not be array<string,string>?

     */
    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;
    }

    /**
    * 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;
    }
}