authCheck

Complexity

Total Complexity

123

Size/Duplication

Total Lines	525
Duplicated Lines	19.05 %

Coupling/Cohesion

Components	1
Dependencies	0

Importance

Changes

0

6 Methods

Rating	Name	Duplication	Size	Complexity
B	init()	0	38	5
C	tick()	0	35	8
D	checkPermissions()	44	167	56
C	checkAuthState()	8	79	14
F	nameReset()	48	140	29
C	standingsUpdate()	0	23	11

<?php
/**
 * The MIT License (MIT)
 *
 * Copyright (c) 2016 Robert Sardinia
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */


/**
 * Class fileAuthCheck
 * @property int nextCheck
 */
class authCheck

PSR1 recommends that each class must be in a namespace of at least one level to avoid collisions.

{

    /**
     * @var
     */
    private $config;
    private $db;
    private $dbUser;
    private $dbPass;
    private $dbName;
    private $guildID;
    private $corpTickers;
    private $authGroups;
    private $exempt;
    private $alertChannel;
    private $guild;
    private $nameEnforce;
    private $standingsBased;
    private $nameCheck;
    private $apiKey;
    private $discord;
    private $logger;

    /**
     * @param $config
     * @param $discord
     * @param $logger
     */
    public function init($config, $discord, $logger)
    {
        $this->config = $config;
        $this->discord = $discord;
        $this->logger = $logger;
        $this->db = $config['database']['host'];
        $this->dbUser = $config['database']['user'];
        $this->dbPass = $config['database']['pass'];
        $this->dbName = $config['database']['database'];
        $this->guildID = $config['bot']['guild'];
        $this->exempt = $config['plugins']['auth']['exempt'];
        $this->corpTickers = $config['plugins']['auth']['corpTickers'];
        $this->nameEnforce = $config['plugins']['auth']['nameEnforce'];
        $this->standingsBased = $config['plugins']['auth']['standings']['enabled'];
        $this->apiKey = $config['eve']['apiKeys'];
        $this->authGroups = $config['plugins']['auth']['authGroups'];
        $this->alertChannel = $config['plugins']['auth']['alertChannel'];
        $this->guild = $config['bot']['guild'];
        $this->nextCheck = 0;

        //Set name check to happen if corpTicker or nameEnforce is set
        if ($this->nameEnforce === 'true' || $this->corpTickers === 'true') {
            $this->nameCheck = 'true';
        }

        //check if cache has been set
        $permsChecked = getPermCache('permsLastChecked');
        $namesChecked = getPermCache('nextRename');
        if ($namesChecked === NULL) {
            setPermCache('nextRename', time());
        }

        //if not set set for now (30 minutes from now for role removal)
        if ($permsChecked === NULL) {
            setPermCache('permsLastChecked', time() - 1);
            setPermCache('authStateLastChecked', time() + 1);
        }
    }

    public function tick()
    {
        // What was the servers last reported state
        $lastStatus = getPermCache('serverState');
        if ($lastStatus === 'online') {
            $permsChecked = getPermCache('permsLastChecked');
            $stateChecked = getPermCache('authStateLastChecked');
            $namesChecked = getPermCache('nextRename');
            $standingsChecked = getPermCache('nextStandingsCheck');

            if ($permsChecked <= time()) {
                $this->logger->addInfo('AuthCheck: Checking for users who have left corp/alliance....');
                $this->checkPermissions();
                $this->logger->addInfo('AuthCheck: Corp/alliance check complete.');
            }

            if ($stateChecked <= time()) {
                $this->logger->addInfo('AuthCheck: Checking for users who have been wrongly given roles....');
                $this->checkAuthState();
                $this->logger->addInfo('AuthCheck: Role check complete.');
            }

            if ($this->nameCheck === 'true' && $namesChecked <= time()) {
                $this->logger->addInfo('AuthCheck: Resetting player names....');
                $this->nameReset();
                $this->logger->addInfo('AuthCheck: Names reset.');
            }

            if ($this->standingsBased === 'true' && $standingsChecked <= time()) {
                $this->logger->addInfo('AuthCheck: Updating Standings');
                $this->standingsUpdate();
                $this->logger->addInfo('AuthCheck: Standings Updated');
            }
        }
    }

    /**
     * @return null
     */

    //Remove members who have roles but never authed
    private function checkPermissions()
    {
        //Get guild object
        $guild = $this->discord->guilds->get('id', $this->guildID);

        //Establish connection to mysql
        $conn = new mysqli($this->db, $this->dbUser, $this->dbPass, $this->dbName);

        //$sql = "SELECT characterID, discordID, eveName, role FROM authUsers WHERE active='yes'";

50% of this comment could be valid code. Did you maybe forget this after debugging?

		$sql = "SELECT characterID, discordID, eveName, active, role FROM authUsers";

        $result = $conn->query($sql);

        //Set empty arrays
        $corpArray = array();
        $allianceArray = array();

        // If config is outdated
        if (null === $this->authGroups) {

This code seems to be duplicated across your project.

            $msg = '**Auth Failure:** Please update the bots config to the latest version.';
            queueMessage($msg, $this->alertChannel, $this->guild);
            $nextCheck = time() + 10800;
            setPermCache('permsLastChecked', $nextCheck);
            return null;
        }

        //Set corp/ally id arrays
        foreach ($this->authGroups as $authGroup) {
            if ($authGroup['corpID'] !== 0) {
                $corpArray[] = (int) $authGroup['corpID'];
            }
            if ($authGroup['allianceID'] !== 0) {
                $allianceArray[] = (int) $authGroup['allianceID'];
            }
        }

        if ($result->num_rows >= 1) {
            while ($rows = $result->fetch_assoc()) {
				$charID = $rows['characterID'];
				$discordID = $rows['discordID'];
				$role = $rows['role'];
				$member = $guild->members->get('id', $discordID);
				$eveName = $rows['eveName'];
				//Check if member has roles
				if (null === @$member->roles) {
					continue;
				}

				//Auth things
				$character = characterDetails($charID);
				//if issue with esi, skip
				$timeout = 0;
				while (null === $character) { //try 10 times to pull characterDetails

This code seems to be duplicated across your project.

					if ($timeout > 9) {
						continue;
					}
					else{
						$character = characterDetails($charID);
						$timeout++;
					}
				}
				$corporationID = $character['corporation_id'];
				$corporationDetails = corpDetails($corporationID);
				$timeout = 0;
				while (null === $corporationDetails) { //try 10 times to pull corporationDetails
					if ($timeout > 9) {
						continue;
					}
					else{
						$corporationDetails = corpDetails($corporationID);
						$timeout++;
					}
				}
				$allianceID = @$corporationDetails['alliance_id'];
				if ($rows['active'] == "yes"){

					//check if user authed based on standings
					$standings = null;
					if ($role === 'blue' || 'neut' || 'red') {
						$allianceContacts = getContacts($allianceID);

Are you sure the assignment to $allianceContacts is correct as getContacts($allianceID) (which targets getContacts()) seems to always return null.

						$corpContacts = getContacts($corporationID);

Are you sure the assignment to $corpContacts is correct as getContacts($corporationID) (which targets getContacts()) seems to always return null.

						if ($role === 'blue' && ((int) $allianceContacts['standing'] === 5 || 10 || (int) $corpContacts['standing'] === 5 || 10)) {
							$standings = 1;
						}
						if ($role === 'red' && ((int) $allianceContacts['standing'] === -5 || -10 || (int) $corpContacts['standing'] === -5 || -10)) {
							$standings = 1;
						}
						if ($role === 'neut' && ((int) $allianceContacts['standing'] === 0 || (int) $corpContacts['standing'] === 0 || (@(int) $allianceContacts['standings'] === null || '' && @(int) $corpContacts['standings'] === null || ''))) {
							$standings = 1;
						}
					}
					if (!in_array((int) $allianceID, $allianceArray) && !in_array((int) $corporationID, $corpArray) && null === $standings) {
						// Deactivate user in database
						$sql = "UPDATE authUsers SET active='no' WHERE discordID='$discordID'";
						$this->logger->addInfo("AuthCheck: {$eveName} account has been deactivated as they are no longer in a correct corp/alliance.");
						$conn->query($sql);
						continue;
					}
				}
				elseif($rows['active'] == "no") {
					$roles = @$guild->roles;
					$member = @$guild->members->get('id', $discordID);
					if (in_array((int) $allianceID, $allianceArray) || in_array((int) $corporationID, $corpArray)) {
						foreach ($this->authGroups as $authGroup) {
							//Check if it's set to match corp and alliance
							if ($authGroup['corpID'] !== 0 && $authGroup['allianceID'] !== 0) {
								//Check if corpID matches
								if ($corpID === $authGroup['corpID'] && $allianceID === $authGroup['allianceID']) {

The variable $corpID does not exist. Did you forget to declare it?

									foreach ($roles as $role) {
										if ((string) $role->name === (string) $authGroup['corpMemberRole']) {
											$member->addRole($role);
										}
										if ((string) $role->name === (string) $authGroup['allyMemberRole']) {
											$member->addRole($role);
											$role = 'corp/ally';
											$guild->members->save($member);
											// Deactivate user in database
											$sql = "UPDATE authUsers SET active='yes' WHERE discordID='$discordID'";
											$this->logger->addInfo("AuthCheck: {$eveName} account has been activates as they are in correct corp/alliance.");
											$conn->query($sql);
										}
									}
									break;
								}
							} elseif ($authGroup['corpID'] !== 0 || $authGroup['allianceID'] !== 0) {
								//Check if corpID matches
								if ($corpID === $authGroup['corpID']) {

This code seems to be duplicated across your project.

									foreach ($roles as $role) {
										if ((string) $role->name === (string) $authGroup['corpMemberRole']) {
											$member->addRole($role);
											$role = 'corp';
											$guild->members->save($member);
											// Deactivate user in database
											$sql = "UPDATE authUsers SET active='yes' WHERE discordID='$discordID'";
											$this->logger->addInfo("AuthCheck: {$eveName} account has been deactivated as they are in correct corp/alliance.");
											$conn->query($sql);
										}
									}
									break;
								}
								//Check if allianceID matches
								if ($allianceID === $authGroup['allianceID'] && $authGroup['allianceID'] !== 0) {

This code seems to be duplicated across your project.

									foreach ($roles as $role) {
										if ((string) $role->name === (string) $authGroup['allyMemberRole']) {
											$member->addRole($role);
											$role = 'ally';
											$guild->members->save($member);
											// Deactivate user in database
											$sql = "UPDATE authUsers SET active='yes' WHERE discordID='$discordID'";
											$this->logger->addInfo("AuthCheck: {$eveName} account has been deactivated as they are in correct corp/alliance.");
											$conn->query($sql);
										}
									}
									break;
								}
							}
						}
					}
				}
				$nextCheck = time() + 10800;
				setPermCache('permsLastChecked', $nextCheck);
			}
        }
        $nextCheck = time() + 10800;
        setPermCache('permsLastChecked', $nextCheck);
        return null;
    }

    //Check user corp/alliance affiliation


    private function checkAuthState()
    {

        //Check if exempt roles are set
        if (null === $this->exempt) {
            $this->exempt = '0';
        }

        // If config is outdated
        if (null === $this->authGroups) {

This code seems to be duplicated across your project.

            $msg = '**Auth Failure:** Please update the bots config to the latest version.';
            queueMessage($msg, $this->alertChannel, $this->guild);
            //queue up next check
            $nextCheck = time() + 1800;
            setPermCache('authStateLastChecked', $nextCheck);
            return null;
        }

        //Establish connection to mysql
        $conn = new mysqli($this->db, $this->dbUser, $this->dbPass, $this->dbName);

        //get bot ID so we don't remove out own roles
        $botID = $this->discord->id;

        //Get guild object
        $guild = $this->discord->guilds->get('id', $this->guildID);

        //Check to make sure guildID is set correctly
        if (null === $guild) {
            $this->logger->addError('Config Error: Ensure the guild entry in the config is the guildID (aka serverID) for the main server that the bot is in.');
            $nextCheck = time() + 7200;
            setPermCache('authLastChecked', $nextCheck);
            return null;
        }

        //create empty array to store names
        $removedRoles = array();
        $userCount = 0;

        //Perform check if roles were added without permission
        foreach ($guild->members as $member) {
            $id = $member->id;
            $username = $member->username;
            $roles = $member->roles;

            //Skip to next member if this user has no roles
            if (null === $roles) {
                continue;
            }
            $sql = "SELECT * FROM authUsers WHERE discordID='$id' AND active='yes'";
            $result = $conn->query($sql);

            //If they are NOT active in the db, check for roles to remove
            if ($result->num_rows === 0) {
                $userCount++;
                foreach ($roles as $role) {
                    if ($id !== $botID && !in_array($role->name, $this->exempt, true)) {
                        $member->removeRole($role);
                        $guild->members->save($member);
                        // Add users name to array
                        if (!in_array($username, $removedRoles)) {
                            $removedRoles[] = $username;
                        }
                    }
                }
            }
        }
        //Report removed users to log and channel
        $nameList = implode(', ', $removedRoles);
        if ($userCount > 0 && strlen($nameList) > 3 && null !== $nameList) {
            $msg = "Following users roles have been removed - {$nameList}";
            queueMessage($msg, $this->alertChannel, $this->guild);
            $this->logger->addInfo("AuthCheck: Roles removed from {$nameList}");
        }
        //queue up next check
        $nextCheck = time() + 1800;
        setPermCache('authStateLastChecked', $nextCheck);
        return null;
    }

    private function nameReset()
    {
        //Get guild object
        $guild = $this->discord->guilds->get('id', $this->guildID);

        //Get name queue status
        $x = (int) getPermCache('nameQueueState');

        //Establish connection to mysql
        $conn = new mysqli($this->db, $this->dbUser, $this->dbPass, $this->dbName);
        $sql = "SELECT id FROM authUsers WHERE active='yes'";
        $count = $conn->query($sql);
        $rowAmount = round($count->num_rows / 2);
        if ($x === 1) {
            $sql = "SELECT characterID, discordID, eveName  FROM authUsers WHERE active='yes' ORDER BY id ASC LIMIT {$rowAmount} OFFSET {$rowAmount}";
            setPermCache('nameQueueState', 0);
        } else {
            $sql = "SELECT characterID, discordID, eveName  FROM authUsers WHERE active='yes' ORDER BY id ASC LIMIT {$rowAmount}";
            setPermCache('nameQueueState', 1);
        }
        $result = $conn->query($sql);

        // If config is outdated
        if (null === $this->authGroups) {

This code seems to be duplicated across your project.

            $msg = '**Auth Failure:** Please update the bots config to the latest version.';
            queueMessage($msg, $this->alertChannel, $this->guild);
            $nextCheck = time() + 1800;
            setPermCache('nextRename', $nextCheck);
            return null;
        }

        if (@$result->num_rows >= 1) {
            while ($rows = $result->fetch_assoc()) {
                $charID = $rows['characterID'];
                $discordID = $rows['discordID'];
                $member = $guild->members->get('id', $discordID);
                $eveName = $rows['eveName'];
                //Check if member has roles
                if (null === @$member->roles) {
                    continue;
                }

                //Get current nickname
                $guild = $this->discord->guilds->get('id', $this->guildID);
                $member = $guild->members->get('id', $discordID);
                $nickName = $member->nick;
                $userName = $member->user->username;
                //If nick isn't set than make it username
                if ($nickName === '' || null === $nickName) {
                    $nickName = $userName;
                }

                //Check for bad tickers
                if (strpos($nickName, '[U]') !== false) {
                    $nickName = str_replace('[U]', '', $nickName);
                    queueRename($discordID, $nickName, $this->guildID);
                    continue;
                }

                //corp ticker
                if ($this->corpTickers === 'true') {
					$timeout = 0;
					$character = characterDetails($charID);
					while (null === $character) { //try 10 times to pull characterDetails

This code seems to be duplicated across your project.

						if ($timeout > 9) {
							continue;
						}
						else{
							$character = characterDetails($charID);
							$timeout++;
						}
					}
                    if (!array_key_exists('corporation_id', $character)) {
                        continue;
                    }
                    $corpInfo = getCorpInfo($character['corporation_id']);

Are you sure the assignment to $corpInfo is correct as getCorpInfo($character['corporation_id']) (which targets getCorpInfo()) seems to always return null.

                    //Clean bad entries
                    if (@$corpInfo['corpTicker'] === 'U') {
                        deleteCorpInfo(@$corpInfo['corpID']);
                    }
                    $nick = null;
                    if (null !== @$corpInfo['corpTicker']) {

This code seems to be duplicated across your project.

                        $corpTicker = (string) $corpInfo['corpTicker'];
                        if ($this->nameEnforce === 'true') {
                            $nick = "[{$corpTicker}] {$eveName}";
                        } elseif ((string) $nickName === "[{$corpTicker}]") {
                            $nick = "[{$corpTicker}] {$userName}";
                        } elseif (strpos($nickName, $corpTicker) === false) {
                            $nick = "[{$corpTicker}] {$nickName}";
                        } elseif (strpos($nickName, $corpTicker) !== false) {
                            continue;
                        }
                        if ($nick !== $nickName) {
                            queueRename($discordID, $nick, $this->guildID);
                        }
                        continue;
                    }
                    $corporationDetails = corpDetails($character['corporation_id']);
                    if (null === $corporationDetails) {
                        continue;
                    }
                    $corpTicker = $corporationDetails['ticker'];
                    //Check for bad tickers (ESI ERROR?)
                    if (@$corpTicker === 'U') {
                        continue;
                    }
                    $corpName = (string) $corporationDetails['corporation_name'];
                    if (null !== $corpTicker) {

This code seems to be duplicated across your project.

                        if ($this->nameEnforce === 'true') {
                            $nick = "[{$corpTicker}] {$eveName}";
                        } elseif ((string) $nickName === "[{$corpTicker}]") {
                            $nick = "[{$corpTicker}] {$userName}";
                        } elseif (strpos($nickName, $corpTicker) === false) {
                            $nick = "[{$corpTicker}] {$nickName}";
                        } elseif (strpos($nickName, $corpTicker) !== false) {
                            continue;
                        }
                        if ($nick !== $nickName) {
                            queueRename($discordID, $nick, $this->guildID);
                            addCorpInfo($character['corporation_id'], $corpTicker, $corpName);
                        }
                        continue;
                    }
                    continue;
                }
                $nick = "{$eveName}";
                if ($nick !== $nickName) {
                    queueRename($discordID, $nick, $this->guildID);
                }
                continue;
            }
            $nextCheck = time() + 1800;
            setPermCache('nextRename', $nextCheck);
            return null;
        }
        $nextCheck = time() + 1800;
        setPermCache('nextRename', $nextCheck);
        return null;

    }

    private function standingsUpdate()
    {
        foreach ($this->apiKey as $apiKey) {
            if ((string) $apiKey['keyID'] === (string) $this->config['plugins']['auth']['standings']['apiKey']) {
                $url = "https://api.eveonline.com/char/ContactList.xml.aspx?keyID={$apiKey['keyID']}&vCode={$apiKey['vCode']}&characterID={$apiKey['characterID']}";
                $xml = makeApiRequest($url);
                if (empty($xml)) {
                    return null;
                }
                foreach ($xml->result->rowset as $contactType) {
                    if ((string) $contactType->attributes()->name === 'corporateContactList' || 'allianceContactList') {
                        foreach ($contactType->row as $contact) {
                            if (null !== $contact['contactID'] && $contact['contactName'] && $contact['standing']) {
                                addContactInfo($contact['contactID'], $contact['contactName'], $contact['standing']);
                            }
                        }
                    }
                }
            }
        }
        $nextCheck = time() + 86400;
        setPermCache('nextStandingsCheck', $nextCheck);
    }
}