Waca\ConsoleTasks\RecreateTrustedIpTableTask

Complexity

Total Complexity

19

Size/Duplication

Total Lines	148
Duplicated Lines	0 %

Test Coverage

Coverage

0%

Importance

Changes	1
Bugs	0	Features	0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	readFile()	0	34	6
A	doInserts()	0	25	5
A	execute()	0	32	1
A	explodeCidrs()	0	7	3
A	resolveDns()	0	16	4

<?php
/******************************************************************************
 * Wikipedia Account Creation Assistance tool                                 *
 *                                                                            *
 * All code in this file is released into the public domain by the ACC        *
 * Development Team. Please see team.json for a list of contributors.         *
 ******************************************************************************/

namespace Waca\ConsoleTasks;

use Exception;
use PDOException;
use PDOStatement;
use Waca\RegexConstants;
use Waca\Tasks\ConsoleTaskBase;

class RecreateTrustedIpTableTask extends ConsoleTaskBase
{
    public function execute()
    {

        echo "Fetching file...\n";

        $htmlfile = file($this->getSiteConfiguration()->getXffTrustedHostsFile(),
            FILE_IGNORE_NEW_LINES | FILE_SKIP_EMPTY_LINES);

        $ip = array();
        $iprange = array();
        $dnsdomain = array();

        echo "Sorting file...\n";
        $this->readFile($htmlfile, $iprange, $ip, $dnsdomain);

        echo "Exploding CIDRs...\n";
        $this->explodeCidrs($iprange, $ip);

        echo "Resolving DNS...\n";
        $this->resolveDns($dnsdomain, $ip);

        echo "Uniq-ing array...\n";

        $ip = array_unique($ip);

        $database = $this->getDatabase();

        $database->exec('DELETE FROM xfftrustcache;');

        $insert = $database->prepare('INSERT INTO xfftrustcache (ip) VALUES (:ip);');

        $this->doInserts($ip, $insert);

It seems like $insert can also be of type boolean; however, parameter $insert of Waca\ConsoleTasks\RecreateTrustedIpTableTask::doInserts() does only seem to accept PDOStatement, maybe add an additional type check?

    }

Expected //end execute()

    /**
     * @param string[] $dnsDomains  the DNS domains to resolve
     * @param string[] $ipAddresses existing array of IPs to add to
     */
    protected function resolveDns($dnsDomains, &$ipAddresses)
    {
        foreach ($dnsDomains as $domain) {
            $ipList = gethostbynamel($domain);

            if ($ipList === false) {
                echo "Invalid DNS name $domain\n";

As per coding-style, please use concatenation or sprintf for the variable $domain instead of interpolation.

                continue;
            }

            foreach ($ipList as $ipAddress) {
                $ipAddresses[] = $ipAddress;
            }

            // don't DoS
            usleep(10000);
        }
    }

Expected //end resolveDns()

    /**
     * @param $iprange
     * @param $ip
     */
    protected function explodeCidrs($iprange, &$ip)
    {
        foreach ($iprange as $r) {
            $ips = $this->getXffTrustProvider()->explodeCidr($r);

            foreach ($ips as $i) {
                $ip[] = $i;
            }
        }
    }

Expected //end explodeCidrs()

    /**
     * @param $htmlfile
     * @param $iprange
     * @param $ip
     * @param $dnsdomain
     */
    protected function readFile($htmlfile, &$iprange, &$ip, &$dnsdomain)
    {
        foreach ($htmlfile as $line_num => $rawline) {
            // remove the comments
            $hashPos = strpos($rawline, '#');
            if ($hashPos !== false) {
                $line = substr($rawline, 0, $hashPos);
            }
            else {
                $line = $rawline;
            }

            $line = trim($line);

            // this was a comment or empty line...
            if ($line == "") {

The string literal does not require double quotes, as per coding-style, please use single quotes.

                continue;
            }

            // match a regex of an CIDR range:
            $ipcidr = '@' . RegexConstants::IPV4 . RegexConstants::IPV4_CIDR . '@';
            if (preg_match($ipcidr, $line) === 1) {
                $iprange[] = $line;
                continue;
            }

            $ipnoncidr = '@' . RegexConstants::IPV4 . '@';
            if (preg_match($ipnoncidr, $line) === 1) {
                $ip[] = $line;
                continue;
            }

            // it's probably a DNS name.
            $dnsdomain[] = $line;
        }
    }

Expected //end readFile()

    /**
     * @param array        $ip
     * @param PDOStatement $insert
     *
     * @throws Exception
     */
    protected function doInserts($ip, PDOStatement $insert)
    {
        $successful = true;

        foreach ($ip as $i) {
            if (count($i) > 15) {
                echo "Rejected $i\n";

As per coding-style, please use concatenation or sprintf for the variable $i instead of interpolation.

                $successful = false;

                continue;
            }

            try {
                $insert->execute(array(':ip' => $i));
            }
            catch (PDOException $ex) {
                echo "Exception on $i :\n";

As per coding-style, please use concatenation or sprintf for the variable $i instead of interpolation.

                echo $ex->getMessage();
                $successful = false;
                break;
            }
        }

        if (!$successful) {
            throw new Exception('Encountered errors during transaction processing');
        }
    }

Expected //end doInserts()

}

Expected //end class