mdaniels5757 / waca

includes/Providers/CachedRDnsLookupProvider.php

Indentation +27 added lines, -27 removed lines

@@ -20,40 +20,40 @@
  */
 class CachedRDnsLookupProvider implements IRDnsProvider
 {
-    private $database;
+	private $database;
 
-    public function __construct(PdoDatabase $database)
-    {
-        $this->database = $database;
-    }
+	public function __construct(PdoDatabase $database)
+	{
+		$this->database = $database;
+	}
 
-    public function getReverseDNS($address)
-    {
-        $address = trim($address);
+	public function getReverseDNS($address)
+	{
+		$address = trim($address);
 
-        // lets look in our cache database first.
-        $rDns = RDnsCache::getByAddress($address, $this->database);
+		// lets look in our cache database first.
+		$rDns = RDnsCache::getByAddress($address, $this->database);
 
-        if ($rDns instanceof RDnsCache) {
-            // touch cache timer
-            $rDns->save();
+		if ($rDns instanceof RDnsCache) {
+			// touch cache timer
+			$rDns->save();
 
-            return $rDns->getData();
-        }
+			return $rDns->getData();
+		}
 
-        // OK, it's not there, let's do an rDNS lookup.
-        $result = @ gethostbyaddr($address);
+		// OK, it's not there, let's do an rDNS lookup.
+		$result = @ gethostbyaddr($address);
 
-        if ($result !== false) {
-            $rDns = new RDnsCache();
-            $rDns->setDatabase($this->database);
-            $rDns->setAddress($address);
-            $rDns->setData($result);
-            $rDns->save();
+		if ($result !== false) {
+			$rDns = new RDnsCache();
+			$rDns->setDatabase($this->database);
+			$rDns->setAddress($address);
+			$rDns->setData($result);
+			$rDns->save();
 
-            return $result;
-        }
+			return $result;
+		}
 
-        return null;
-    }
+		return null;
+	}
 }

includes/Providers/TorExitProvider.php

Indentation +75 added lines, -75 removed lines

@@ -13,96 +13,96 @@
 
 class TorExitProvider
 {
-    /** @var PdoDatabase */
-    private $database;
-
-    /**
-     * TorExitProvider constructor.
-     *
-     * @param PdoDatabase $database
-     */
-    public function __construct(PdoDatabase $database)
-    {
-        $this->database = $database;
-    }
-
-    /**
-     * Checks whether an IP address is a Tor exit node for one of the pre-cached IP addresses.
-     *
-     * @param string $ip IP Address
-     *
-     * @return bool
-     */
-    public function isTorExit($ip)
-    {
-        $statement = $this->database->prepare('SELECT COUNT(1) FROM tornodecache WHERE ipaddr = :ip');
-
-        $statement->execute(array(':ip' => $ip));
-
-        $count = $statement->fetchColumn();
-        $statement->closeCursor();
-
-        if ($count > 0) {
-            return true;
-        }
-        else {
-            return false;
-        }
-    }
-
-    public static function regenerate(PdoDatabase $database, HttpHelper $httpHelper, $destinationIps)
-    {
-        $query = <<<SQL
+	/** @var PdoDatabase */
+	private $database;
+
+	/**
+	 * TorExitProvider constructor.
+	 *
+	 * @param PdoDatabase $database
+	 */
+	public function __construct(PdoDatabase $database)
+	{
+		$this->database = $database;
+	}
+
+	/**
+	 * Checks whether an IP address is a Tor exit node for one of the pre-cached IP addresses.
+	 *
+	 * @param string $ip IP Address
+	 *
+	 * @return bool
+	 */
+	public function isTorExit($ip)
+	{
+		$statement = $this->database->prepare('SELECT COUNT(1) FROM tornodecache WHERE ipaddr = :ip');
+
+		$statement->execute(array(':ip' => $ip));
+
+		$count = $statement->fetchColumn();
+		$statement->closeCursor();
+
+		if ($count > 0) {
+			return true;
+		}
+		else {
+			return false;
+		}
+	}
+
+	public static function regenerate(PdoDatabase $database, HttpHelper $httpHelper, $destinationIps)
+	{
+		$query = <<<SQL
 INSERT INTO tornodecache (ipaddr, exitaddr, exitport)
 VALUES (:ipaddr, :exitaddr, :exitport)
 ON DUPLICATE KEY
 UPDATE touched = CURRENT_TIMESTAMP, updateversion = updateversion + 1
 SQL;
 
-        $statement = $database->prepare($query);
+		$statement = $database->prepare($query);
 
-        foreach ($destinationIps as $ip) {
-            echo 'Fetching data for ' . $ip . PHP_EOL;
+		foreach ($destinationIps as $ip) {
+			echo 'Fetching data for ' . $ip . PHP_EOL;
 
-            $statement->bindValue(':exitaddr', $ip);
+			$statement->bindValue(':exitaddr', $ip);
 
-            $http = $httpHelper->get(
-                'https://check.torproject.org/cgi-bin/TorBulkExitList.py',
-                array(
-                    'ip'   => $ip,
-                    'port' => 80,
-                ));
+			$http = $httpHelper->get(
+				'https://check.torproject.org/cgi-bin/TorBulkExitList.py',
+				array(
+					'ip'   => $ip,
+					'port' => 80,
+				));
 
-            $https = $httpHelper->get(
-                'https://check.torproject.org/cgi-bin/TorBulkExitList.py',
-                array(
-                    'ip'   => $ip,
-                    'port' => 443,
-                ));
+			$https = $httpHelper->get(
+				'https://check.torproject.org/cgi-bin/TorBulkExitList.py',
+				array(
+					'ip'   => $ip,
+					'port' => 443,
+				));
 
-            foreach (array(80 => $http, 443 => $https) as $port => $response) {
-                echo '  Running for port ' . $ip . ':' . $port . PHP_EOL;
+			foreach (array(80 => $http, 443 => $https) as $port => $response) {
+				echo '  Running for port ' . $ip . ':' . $port . PHP_EOL;
 
-                $statement->bindValue(':exitport', $port);
+				$statement->bindValue(':exitport', $port);
 
-                $lines = explode("\n", $response);
+				$lines = explode("\n", $response);
 
-                foreach ($lines as $line) {
-                    // line contains a comment char, just skip the line.
-                    // This is OK as of 2016-04-06  --stw
-                    if (strpos($line, '#') !== false) {
-                        continue;
-                    }
+				foreach ($lines as $line) {
+					// line contains a comment char, just skip the line.
+					// This is OK as of 2016-04-06  --stw
+					if (strpos($line, '#') !== false) {
+						continue;
+					}
 
-                    $statement->bindValue(':ipaddr', $line);
-                    $statement->execute();
-                }
-            }
+					$statement->bindValue(':ipaddr', $line);
+					$statement->execute();
+				}
+			}
 
-            echo 'Done for ' . $ip . PHP_EOL;
-        }
+			echo 'Done for ' . $ip . PHP_EOL;
+		}
 
-        // kill old cached entries
-        $database->exec('DELETE FROM tornodecache WHERE touched < DATE_SUB(CURRENT_TIMESTAMP, INTERVAL 1 DAY)');
-    }
+		// kill old cached entries
+		$database->exec('DELETE FROM tornodecache WHERE touched < DATE_SUB(CURRENT_TIMESTAMP, INTERVAL 1 DAY)');
+	}
 }
\ No newline at end of file

Braces +1 added lines, -2 removed lines

@@ -44,8 +44,7 @@
 
         if ($count > 0) {
             return true;
-        }
-        else {
+        } else {
             return false;
         }
     }

includes/Providers/CachedApiAntispoofProvider.php

Braces +1 added lines, -2 removed lines

@@ -61,8 +61,7 @@
             $cacheEntry->save();
 
             $cacheResult = $cacheEntry;
-        }
-        else {
+        } else {
             $data = $cacheResult->getData();
         }
 

Indentation +73 added lines, -73 removed lines

@@ -23,77 +23,77 @@
  */
 class CachedApiAntispoofProvider implements IAntiSpoofProvider
 {
-    /**
-     * @var PdoDatabase
-     */
-    private $database;
-
-    /**
-     * @var HttpHelper
-     */
-    private $httpHelper;
-
-    public function __construct(PdoDatabase $database, HttpHelper $httpHelper)
-    {
-        $this->database = $database;
-        $this->httpHelper = $httpHelper;
-    }
-
-    public function getSpoofs($username)
-    {
-        // FIXME: domains!
-        /** @var Domain $domain */
-        $domain = Domain::getById(1, $this->database);
-
-        /** @var AntiSpoofCache $cacheResult */
-        $cacheResult = AntiSpoofCache::getByUsername($username, $this->database);
-        if ($cacheResult == false) {
-            // get the data from the API
-            $data = $this->httpHelper->get($domain->getWikiApiPath(), array(
-                'action'   => 'antispoof',
-                'format'   => 'php',
-                'username' => $username,
-            ));
-
-            $cacheEntry = new AntiSpoofCache();
-            $cacheEntry->setDatabase($this->database);
-            $cacheEntry->setUsername($username);
-            $cacheEntry->setData($data);
-            $cacheEntry->save();
-
-            $cacheResult = $cacheEntry;
-        }
-        else {
-            $data = $cacheResult->getData();
-        }
-
-        $result = unserialize($data);
-
-        if (!isset($result['antispoof']) || !isset($result['antispoof']['result'])) {
-            $cacheResult->delete();
-
-            if (isset($result['error']['info'])) {
-                throw new Exception("Unrecognised API response to query: " . $result['error']['info']);
-            }
-
-            throw new Exception("Unrecognised API response to query.");
-        }
-
-        if ($result['antispoof']['result'] == "pass") {
-            // All good here!
-            return array();
-        }
-
-        if ($result['antispoof']['result'] == "conflict") {
-            // we've got conflicts, let's do something with them.
-            return $result['antispoof']['users'];
-        }
-
-        if ($result['antispoof']['result'] == "error") {
-            // we've got conflicts, let's do something with them.
-            throw new Exception("Encountered error while getting result: " . $result['antispoof']['error']);
-        }
-
-        throw new Exception("Unrecognised API response to query.");
-    }
+	/**
+	 * @var PdoDatabase
+	 */
+	private $database;
+
+	/**
+	 * @var HttpHelper
+	 */
+	private $httpHelper;
+
+	public function __construct(PdoDatabase $database, HttpHelper $httpHelper)
+	{
+		$this->database = $database;
+		$this->httpHelper = $httpHelper;
+	}
+
+	public function getSpoofs($username)
+	{
+		// FIXME: domains!
+		/** @var Domain $domain */
+		$domain = Domain::getById(1, $this->database);
+
+		/** @var AntiSpoofCache $cacheResult */
+		$cacheResult = AntiSpoofCache::getByUsername($username, $this->database);
+		if ($cacheResult == false) {
+			// get the data from the API
+			$data = $this->httpHelper->get($domain->getWikiApiPath(), array(
+				'action'   => 'antispoof',
+				'format'   => 'php',
+				'username' => $username,
+			));
+
+			$cacheEntry = new AntiSpoofCache();
+			$cacheEntry->setDatabase($this->database);
+			$cacheEntry->setUsername($username);
+			$cacheEntry->setData($data);
+			$cacheEntry->save();
+
+			$cacheResult = $cacheEntry;
+		}
+		else {
+			$data = $cacheResult->getData();
+		}
+
+		$result = unserialize($data);
+
+		if (!isset($result['antispoof']) || !isset($result['antispoof']['result'])) {
+			$cacheResult->delete();
+
+			if (isset($result['error']['info'])) {
+				throw new Exception("Unrecognised API response to query: " . $result['error']['info']);
+			}
+
+			throw new Exception("Unrecognised API response to query.");
+		}
+
+		if ($result['antispoof']['result'] == "pass") {
+			// All good here!
+			return array();
+		}
+
+		if ($result['antispoof']['result'] == "conflict") {
+			// we've got conflicts, let's do something with them.
+			return $result['antispoof']['users'];
+		}
+
+		if ($result['antispoof']['result'] == "error") {
+			// we've got conflicts, let's do something with them.
+			throw new Exception("Encountered error while getting result: " . $result['antispoof']['error']);
+		}
+
+		throw new Exception("Unrecognised API response to query.");
+	}
 }

includes/ConsoleTasks/ClearExpiredIdentificationData.php

Indentation +7 added lines, -7 removed lines

@@ -13,11 +13,11 @@
 
 class ClearExpiredIdentificationData extends ConsoleTaskBase
 {
-    /**
-     * @return void
-     */
-    public function execute()
-    {
-        IdentificationVerifier::clearExpiredCacheEntries($this->getSiteConfiguration(), $this->getDatabase());
-    }
+	/**
+	 * @return void
+	 */
+	public function execute()
+	{
+		IdentificationVerifier::clearExpiredCacheEntries($this->getSiteConfiguration(), $this->getDatabase());
+	}
 }

includes/ConsoleTasks/RecreateTrustedIpTableTask.php

Braces +1 added lines, -2 removed lines

@@ -101,8 +101,7 @@
             $hashPos = strpos($rawline, '#');
             if ($hashPos !== false) {
                 $line = substr($rawline, 0, $hashPos);
-            }
-            else {
+            } else {
                 $line = $rawline;
             }
 

Indentation +148 added lines, -148 removed lines

@@ -16,152 +16,152 @@
 
 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);
-    }
-
-    /**
-     * @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";
-                continue;
-            }
-
-            foreach ($ipList as $ipAddress) {
-                $ipAddresses[] = $ipAddress;
-            }
-
-            // don't DoS
-            usleep(10000);
-        }
-    }
-
-    /**
-     * @param $iprange
-     * @param $ip
-     */
-    protected function explodeCidrs($iprange, &$ip)
-    {
-        foreach ($iprange as $r) {
-            $ips = $this->getXffTrustProvider()->explodeCidr($r);
-
-            foreach ($ips as $i) {
-                $ip[] = $i;
-            }
-        }
-    }
-
-    /**
-     * @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 == "") {
-                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;
-        }
-    }
-
-    /**
-     * @param array        $ip
-     * @param PDOStatement $insert
-     *
-     * @throws Exception
-     */
-    protected function doInserts($ip, PDOStatement $insert)
-    {
-        $successful = true;
-
-        foreach ($ip as $i) {
-            if (strlen($i) > 15) {
-                echo "Rejected $i\n";
-                $successful = false;
-
-                continue;
-            }
-
-            try {
-                $insert->execute(array(':ip' => $i));
-            }
-            catch (PDOException $ex) {
-                echo "Exception on $i :\n";
-                echo $ex->getMessage();
-                $successful = false;
-                break;
-            }
-        }
-
-        if (!$successful) {
-            throw new Exception('Encountered errors during transaction processing');
-        }
-    }
+	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);
+	}
+
+	/**
+	 * @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";
+				continue;
+			}
+
+			foreach ($ipList as $ipAddress) {
+				$ipAddresses[] = $ipAddress;
+			}
+
+			// don't DoS
+			usleep(10000);
+		}
+	}
+
+	/**
+	 * @param $iprange
+	 * @param $ip
+	 */
+	protected function explodeCidrs($iprange, &$ip)
+	{
+		foreach ($iprange as $r) {
+			$ips = $this->getXffTrustProvider()->explodeCidr($r);
+
+			foreach ($ips as $i) {
+				$ip[] = $i;
+			}
+		}
+	}
+
+	/**
+	 * @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 == "") {
+				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;
+		}
+	}
+
+	/**
+	 * @param array        $ip
+	 * @param PDOStatement $insert
+	 *
+	 * @throws Exception
+	 */
+	protected function doInserts($ip, PDOStatement $insert)
+	{
+		$successful = true;
+
+		foreach ($ip as $i) {
+			if (strlen($i) > 15) {
+				echo "Rejected $i\n";
+				$successful = false;
+
+				continue;
+			}
+
+			try {
+				$insert->execute(array(':ip' => $i));
+			}
+			catch (PDOException $ex) {
+				echo "Exception on $i :\n";
+				echo $ex->getMessage();
+				$successful = false;
+				break;
+			}
+		}
+
+		if (!$successful) {
+			throw new Exception('Encountered errors during transaction processing');
+		}
+	}
 }
\ No newline at end of file

includes/ConsoleTasks/UpdateTorExitTask.php

Indentation +10 added lines, -10 removed lines

@@ -13,14 +13,14 @@
 
 class UpdateTorExitTask extends ConsoleTaskBase
 {
-    /**
-     * @return void
-     */
-    public function execute()
-    {
-        TorExitProvider::regenerate(
-            $this->getDatabase(),
-            $this->getHttpHelper(),
-            $this->getSiteConfiguration()->getTorExitPaths());
-    }
+	/**
+	 * @return void
+	 */
+	public function execute()
+	{
+		TorExitProvider::regenerate(
+			$this->getDatabase(),
+			$this->getHttpHelper(),
+			$this->getSiteConfiguration()->getTorExitPaths());
+	}
 }
\ No newline at end of file

includes/ApplicationBase.php

Braces +1 added lines, -2 removed lines

@@ -142,8 +142,7 @@
 
         if ($siteConfiguration->getLocationProviderApiKey() === null) {
             $page->setLocationProvider(new FakeLocationProvider());
-        }
-        else {
+        } else {
             $page->setLocationProvider(
                 new IpLocationProvider(
                     $database,

Indentation +158 added lines, -158 removed lines

@@ -24,162 +24,162 @@
 
 abstract class ApplicationBase
 {
-    private $configuration;
-
-    public function __construct(SiteConfiguration $configuration)
-    {
-        $this->configuration = $configuration;
-    }
-
-    /**
-     * Application entry point.
-     *
-     * Sets up the environment and runs the application, performing any global cleanup operations when done.
-     */
-    public function run()
-    {
-        try {
-            if ($this->setupEnvironment()) {
-                $this->main();
-            }
-        }
-        catch (Exception $ex) {
-            print $ex->getMessage();
-        }
-        finally {
-            $this->cleanupEnvironment();
-        }
-    }
-
-    /**
-     * Environment setup
-     *
-     * This method initialises the tool environment. If the tool cannot be initialised correctly, it will return false
-     * and shut down prematurely.
-     *
-     * @return bool
-     * @throws EnvironmentException
-     */
-    protected function setupEnvironment()
-    {
-        foreach ([
-            'mbstring', // unicode and stuff
-            'pdo',
-            'pdo_mysql', // new database module
-            'session',
-            'date',
-            'pcre', // core stuff
-            'curl', // mediawiki api access etc
-            'openssl', // token generation
-        ] as $x) {
-            if (!extension_loaded($x)) {
-                throw new EnvironmentException("PHP extension `$x` is required.");
-            }
-        }
-
-        ini_set('user_agent', $this->getConfiguration()->getUserAgent());
-
-        $this->setupDatabase();
-
-        return true;
-    }
-
-    /**
-     * Checks the database is connectable and at the correct version
-     *
-     * @throws EnvironmentException
-     * @throws Exception
-     */
-    private function setupDatabase(): void
-    {
-        // check the schema version
-        $database = PdoDatabase::getDatabaseConnection($this->getConfiguration());
-
-        $actualVersion = (int)$database->query('SELECT version FROM schemaversion')->fetchColumn();
-        if ($actualVersion !== $this->getConfiguration()->getSchemaVersion()) {
-            throw new EnvironmentException('Database schema is wrong version! Please either update configuration or database.');
-        }
-    }
-
-    /**
-     * @return SiteConfiguration
-     */
-    public function getConfiguration()
-    {
-        return $this->configuration;
-    }
-
-    /**
-     * Main application logic
-     * @return void
-     */
-    abstract protected function main();
-
-    /**
-     * Any cleanup tasks should go here
-     *
-     * Note that we need to be very careful here, as exceptions may have been thrown and handled.
-     * This should *only* be for cleaning up, no logic should go here.
-     *
-     * @return void
-     */
-    abstract protected function cleanupEnvironment();
-
-    /**
-     * @param ITask             $page
-     * @param SiteConfiguration $siteConfiguration
-     * @param PdoDatabase       $database
-     *
-     * @return void
-     */
-    protected function setupHelpers(
-        ITask $page,
-        SiteConfiguration $siteConfiguration,
-        PdoDatabase $database
-    ) {
-        $page->setSiteConfiguration($siteConfiguration);
-
-        // setup the global database object
-        $page->setDatabase($database);
-
-        // set up helpers and inject them into the page.
-        $httpHelper = new HttpHelper($siteConfiguration);
-
-        $page->setEmailHelper(
-            new EmailHelper($siteConfiguration->getEmailSender(), $siteConfiguration->getIrcNotificationsInstance())
-        );
-
-        $page->setHttpHelper($httpHelper);
-
-        if ($siteConfiguration->getLocationProviderApiKey() === null) {
-            $page->setLocationProvider(new FakeLocationProvider());
-        }
-        else {
-            $page->setLocationProvider(
-                new IpLocationProvider(
-                    $database,
-                    $siteConfiguration->getLocationProviderApiKey(),
-                    $httpHelper
-                ));
-        }
-
-        $page->setXffTrustProvider(new XffTrustProvider($siteConfiguration->getSquidList(), $database));
-
-        $page->setRdnsProvider(new CachedRDnsLookupProvider($database));
-
-        $page->setAntiSpoofProvider(new CachedApiAntispoofProvider($database, $httpHelper));
-
-        $page->setOAuthProtocolHelper(new OAuthProtocolHelper(
-            $siteConfiguration->getOAuthConsumerToken(),
-            $siteConfiguration->getOAuthConsumerSecret(),
-            $database,
-            $siteConfiguration->getUserAgent()
-        ));
-
-        $page->setNotificationHelper(new IrcNotificationHelper(
-            $siteConfiguration,
-            $database));
-
-        $page->setTorExitProvider(new TorExitProvider($database));
-    }
+	private $configuration;
+
+	public function __construct(SiteConfiguration $configuration)
+	{
+		$this->configuration = $configuration;
+	}
+
+	/**
+	 * Application entry point.
+	 *
+	 * Sets up the environment and runs the application, performing any global cleanup operations when done.
+	 */
+	public function run()
+	{
+		try {
+			if ($this->setupEnvironment()) {
+				$this->main();
+			}
+		}
+		catch (Exception $ex) {
+			print $ex->getMessage();
+		}
+		finally {
+			$this->cleanupEnvironment();
+		}
+	}
+
+	/**
+	 * Environment setup
+	 *
+	 * This method initialises the tool environment. If the tool cannot be initialised correctly, it will return false
+	 * and shut down prematurely.
+	 *
+	 * @return bool
+	 * @throws EnvironmentException
+	 */
+	protected function setupEnvironment()
+	{
+		foreach ([
+			'mbstring', // unicode and stuff
+			'pdo',
+			'pdo_mysql', // new database module
+			'session',
+			'date',
+			'pcre', // core stuff
+			'curl', // mediawiki api access etc
+			'openssl', // token generation
+		] as $x) {
+			if (!extension_loaded($x)) {
+				throw new EnvironmentException("PHP extension `$x` is required.");
+			}
+		}
+
+		ini_set('user_agent', $this->getConfiguration()->getUserAgent());
+
+		$this->setupDatabase();
+
+		return true;
+	}
+
+	/**
+	 * Checks the database is connectable and at the correct version
+	 *
+	 * @throws EnvironmentException
+	 * @throws Exception
+	 */
+	private function setupDatabase(): void
+	{
+		// check the schema version
+		$database = PdoDatabase::getDatabaseConnection($this->getConfiguration());
+
+		$actualVersion = (int)$database->query('SELECT version FROM schemaversion')->fetchColumn();
+		if ($actualVersion !== $this->getConfiguration()->getSchemaVersion()) {
+			throw new EnvironmentException('Database schema is wrong version! Please either update configuration or database.');
+		}
+	}
+
+	/**
+	 * @return SiteConfiguration
+	 */
+	public function getConfiguration()
+	{
+		return $this->configuration;
+	}
+
+	/**
+	 * Main application logic
+	 * @return void
+	 */
+	abstract protected function main();
+
+	/**
+	 * Any cleanup tasks should go here
+	 *
+	 * Note that we need to be very careful here, as exceptions may have been thrown and handled.
+	 * This should *only* be for cleaning up, no logic should go here.
+	 *
+	 * @return void
+	 */
+	abstract protected function cleanupEnvironment();
+
+	/**
+	 * @param ITask             $page
+	 * @param SiteConfiguration $siteConfiguration
+	 * @param PdoDatabase       $database
+	 *
+	 * @return void
+	 */
+	protected function setupHelpers(
+		ITask $page,
+		SiteConfiguration $siteConfiguration,
+		PdoDatabase $database
+	) {
+		$page->setSiteConfiguration($siteConfiguration);
+
+		// setup the global database object
+		$page->setDatabase($database);
+
+		// set up helpers and inject them into the page.
+		$httpHelper = new HttpHelper($siteConfiguration);
+
+		$page->setEmailHelper(
+			new EmailHelper($siteConfiguration->getEmailSender(), $siteConfiguration->getIrcNotificationsInstance())
+		);
+
+		$page->setHttpHelper($httpHelper);
+
+		if ($siteConfiguration->getLocationProviderApiKey() === null) {
+			$page->setLocationProvider(new FakeLocationProvider());
+		}
+		else {
+			$page->setLocationProvider(
+				new IpLocationProvider(
+					$database,
+					$siteConfiguration->getLocationProviderApiKey(),
+					$httpHelper
+				));
+		}
+
+		$page->setXffTrustProvider(new XffTrustProvider($siteConfiguration->getSquidList(), $database));
+
+		$page->setRdnsProvider(new CachedRDnsLookupProvider($database));
+
+		$page->setAntiSpoofProvider(new CachedApiAntispoofProvider($database, $httpHelper));
+
+		$page->setOAuthProtocolHelper(new OAuthProtocolHelper(
+			$siteConfiguration->getOAuthConsumerToken(),
+			$siteConfiguration->getOAuthConsumerSecret(),
+			$database,
+			$siteConfiguration->getUserAgent()
+		));
+
+		$page->setNotificationHelper(new IrcNotificationHelper(
+			$siteConfiguration,
+			$database));
+
+		$page->setTorExitProvider(new TorExitProvider($database));
+	}
 }

includes/Tasks/PublicInterfacePageBase.php

Indentation +15 added lines, -15 removed lines

@@ -10,21 +10,21 @@
 
 abstract class PublicInterfacePageBase extends PageBase
 {
-    /**
-     * PublicInterfaceInternalPageBase constructor.
-     */
-    public function __construct()
-    {
-        $this->template = 'publicbase.tpl';
-    }
+	/**
+	 * PublicInterfaceInternalPageBase constructor.
+	 */
+	public function __construct()
+	{
+		$this->template = 'publicbase.tpl';
+	}
 
-    final public function execute()
-    {
-        parent::execute();
-    }
+	final public function execute()
+	{
+		parent::execute();
+	}
 
-    final public function finalisePage()
-    {
-        parent::finalisePage();
-    }
+	final public function finalisePage()
+	{
+		parent::finalisePage();
+	}
 }
\ No newline at end of file

includes/Tasks/IRoutedTask.php

Indentation +16 added lines, -16 removed lines

@@ -12,21 +12,21 @@
 
 interface IRoutedTask extends ITask
 {
-    /**
-     * Sets the route the request will take. Only should be called from the request router.
-     *
-     * @param $routeName string
-     *
-     * @return void
-     *
-     * @throws Exception
-     * @category Security-Critical
-     */
-    public function setRoute($routeName);
+	/**
+	 * Sets the route the request will take. Only should be called from the request router.
+	 *
+	 * @param $routeName string
+	 *
+	 * @return void
+	 *
+	 * @throws Exception
+	 * @category Security-Critical
+	 */
+	public function setRoute($routeName);
 
-    /**
-     * Gets the name of the route that has been passed from the request router.
-     * @return string
-     */
-    public function getRouteName();
+	/**
+	 * Gets the name of the route that has been passed from the request router.
+	 * @return string
+	 */
+	public function getRouteName();
 }
\ No newline at end of file