notifications::information() - Code Metrics - Inspection of "fix" - shibdib/Dramiel - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Push — master ( fb6ce1...7c7d88 )

by Bob
created 2016-07-16 22:57 UTC
notifications::information() A

↳ Parent: notifications
Complexity

Conditions	1
Paths	1
Size

Total Lines	7
Code Lines	5
Duplication

Lines	0
Ratio	0 %
Importance

Changes	2
Bugs	1	Features	0
Metric	Value
cc	1
eloc	5
c	2
b	1
f	0
nc	1
nop	0
dl	0
loc	7
rs	9.4285
<?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.
 */
use Discord\Discord;
use Discord\Parts\Channel\Channel;
use Discord\Parts\Channel\Message;

/**
 * Class notifications.
 *
 * @property  keyID
 * @property  vCode
 */
class notifications
namespace YourVendor;

class YourClass { }
{
    /*
     * @var
     */
    public $config;
    /*
     * @var
     */
    public $discord;
    /*
     * @var
     */
    public $logger;
    /*
     * @var
     */
    public $nextCheck;
    /*
     * @var
     */
    public $keys;
    /*
     * @var
     */
    public $keyCount;
    /*
     * @var
     */
    public $toDiscordChannel;
    /*
     * @var
     */
    public $newestNotificationID;
    /*
     * @var
     */
    public $maxID;
    /*
     * @var
     */
    public $charApi;
    /*
     * @var
     */
    public $corpApi;
    /*
     * @var
     */
    public $alliApi;

    /**
     * @param $config
     * @param $discord
     * @param $logger
     */
    public function init($config, $discord, $logger)
    {
        $this->config = $config;
        $this->discord = $discord;
        $this->logger = $logger;
        $this->toDiscordChannel = $config['plugins']['notifications']['channelID'];
        $this->newestNotificationID = getPermCache('newestNotificationID');
        $this->maxID = 0;
        $this->keyID = $config['eve']['apiKeys']['user1']['keyID'];
class MyClass { }

$x = new MyClass();
$x->foo = true;
        $this->vCode = $config['eve']['apiKeys']['user1']['vCode'];
class MyClass { }

$x = new MyClass();
$x->foo = true;
        $this->characterID = $config['eve']['apiKeys']['user1']['characterID'];
class MyClass { }

$x = new MyClass();
$x->foo = true;
        // Rena APIs
        $this->charApi = 'http://rena.karbowiak.dk/api/character/information/';
        $this->corpApi = 'http://rena.karbowiak.dk/api/corporation/information/';
        $this->alliApi = 'http://rena.karbowiak.dk/api/alliance/information/';
        $lastCheck = getPermCache("notificationsLastChecked{$this->keyID}");
        if ($lastCheck == null) {
            // Schedule it for right now if first run
            setPermCache("notificationsLastChecked{$this->keyID}", time() - 5);
        }
    }


    public function tick()

    {
        $lastChecked = getPermCache("notificationsLastChecked{$this->keyID}");
        $keyID = $this->keyID;
        $vCode = $this->vCode;
        $characterID = $this->characterID;

        if ($lastChecked <= time()) {
            $this->logger->addInfo("Checking API Key {$keyID} for notifications..");
            $this->getNotifications($keyID, $vCode, $characterID);
        }
    }

    /**
     * @param $keyID
     * @param $vCode
     * @param $characterID
     *
     * @return null
     */
    public function getNotifications($keyID, $vCode, $characterID)
    {
        try {
            $url = "https://api.eveonline.com/char/Notifications.xml.aspx?keyID={$keyID}&vCode={$vCode}&characterID={$characterID}";
            $xml = makeApiRequest($url);
            date_default_timezone_set('UTC');
            $cached = $xml->cachedUntil[0];
            $baseUnix = strtotime($cached);
            $cacheClr = $baseUnix - 13500;
            if ($cacheClr <= time()) {

                $weirdTime = time() + 1830;
                $cacheTimer = gmdate('Y-m-d H:i:s', $weirdTime);
                setPermCache("notificationsLastChecked{$keyID}", $weirdTime);
            } else {
                $cacheTimer = gmdate('Y-m-d H:i:s', $cacheClr);
                setPermCache("notificationsLastChecked{$keyID}", $cacheClr);
            }
            $data = json_decode(json_encode(simplexml_load_string(downloadData($url),
                'SimpleXMLElement', LIBXML_NOCDATA)), true);
            $data = $data['result']['rowset']['row'];
            // If there is no data, just quit..
            if (empty($data)) {
                return;
            }
            $fixedData = [];
            // Sometimes there is only ONE notification, so.. yeah..
            if (isset($data['@attributes'])) {
                $fixedData[] = $data['@attributes'];
            }
            if (count($data) > 1) {
                foreach ($data as $multiNotif) {
                    $fixedData[] = $multiNotif['@attributes'];
                }
            }
            foreach ($fixedData as $notification) {
                $notificationID = $notification['notificationID'];
                $typeID = $notification['typeID'];
                $sentDate = $notification['sentDate'];
                if ($notificationID > $this->newestNotificationID) {
                    $notificationString = explode("\n", $this->getNotificationText($keyID, $vCode, $characterID,
                        $notificationID));
                    switch ($typeID) {
                        case 5: // War Declared
                            $aggAllianceID = trim(explode(': ', $notificationString[2])[1]);
                            $aggAllianceName = $this->apiData('alli', $aggAllianceID)['allianceName'];
                            $delayHours = trim(explode(': ', $notificationString[3])[1]);
                            $msg = "@everyone | War declared by {$aggAllianceName}. Fighting begins in roughly {$delayHours} hours.";
                            break;
                        case 7: // War Declared corp
                            $aggCorpID = trim(explode(': ', $notificationString[2])[1]);
                            $aggCorpName = $this->apiData('corp', $aggCorpID)['corporationName'];
                            $msg = "@everyone | War declared by {$aggCorpName}. Fighting begins in roughly 24 hours.";
                            break;
                        case 8: // Alliance war invalidated by CONCORD
                            $aggAllianceID = trim(explode(': ', $notificationString[2])[1]);
                            $aggAllianceName = $this->apiData('alli', $aggAllianceID)['allianceName'];
                            $msg = "War declared by {$aggAllianceName} has been invalidated. Fighting ends in roughly 24 hours.";
                            break;
                        case 10: // Bill issued
                            $msg = 'skip';
                            break;
                        case 14: // Bounty payment
                            $msg = 'skip';
                            break;
                        case 16: // Mail
                            $msg = 'skip';
                            break;
                        case 19: // corp tax changed
                            $corpID = trim(explode(': ', $notificationString[0])[1]);
                            $corpName = $this->apiData('corp', $corpID)['corporationName'];
                            $oldTax = trim(explode(': ', $notificationString[2])[1]);
                            $newTax = trim(explode(': ', $notificationString[1])[1]);
                            $msg = "{$corpName} tax changed from {$oldTax}% to {$newTax}%";
                            break;
                        case 21: // member left corp
                            $msg = 'skip';
                            break;
                        case 35: // Insurance payment
                            $msg = 'skip';
                            break;
                        case 41: // System lost

                            $systemID = trim(explode(': ', $notificationString[2])[1]);
                            $systemName = dbQueryField('SELECT solarSystemName FROM mapSolarSystems WHERE solarSystemID = :id',
                                'solarSystemName', [':id' => $systemID], 'ccp');
                            $allianceID = trim(explode(': ', $notificationString[0])[1]);
                            $allianceName = $this->apiData('alli', $allianceID)['allianceName'];
                            $msg = "{$allianceName} has lost control of **{$systemName}**";
                            break;
                        case 43: // System captured

                            $systemID = trim(explode(': ', $notificationString[2])[1]);
                            $systemName = dbQueryField('SELECT solarSystemName FROM mapSolarSystems WHERE solarSystemID = :id',
                                'solarSystemName', [':id' => $systemID], 'ccp');
                            $allianceID = trim(explode(': ', $notificationString[0])[1]);
                            $allianceName = $this->apiData('alli', $allianceID)['allianceName'];
                            $msg = "{$allianceName} now controls **{$systemName}**";
                            break;
                        case 52: // clone revoked
                            $msg = 'skip';
                            break;
                        case 57: // jump clone destruction
                            $msg = 'skip';
                            break;
                        case 71: // Mission Expiration
                            $msg = 'skip';
                            break;
                        case 75: // POS / POS Module under attack
                            $aggAllianceID = trim(explode(': ', $notificationString[0])[1]);
                            $aggAllianceName = $this->apiData('alli', $aggAllianceID)['allianceName'];
                            $aggCorpID = trim(explode(': ', $notificationString[1])[1]);
                            $aggCorpName = $this->apiData('corp', $aggCorpID)['corporationName'];
                            $aggID = trim(explode(': ', $notificationString[2])[1]);
                            $aggCharacterName = $this->apiData('char', $aggID)['characterName'];
                            $armorValue = trim(explode(': ', $notificationString[3])[1]);
                            $hullValue = trim(explode(': ', $notificationString[4])[1]);
                            $moonID = trim(explode(': ', $notificationString[5])[1]);
                            $moonName = dbQueryField('SELECT itemName FROM mapAllCelestials WHERE itemID = :id',
                                'itemName', [':id' => $moonID], 'ccp');
                            $shieldValue = trim(explode(': ', $notificationString[6])[1]);
                            $solarSystemID = trim(explode(': ', $notificationString[7])[1]);
                            $typeID = trim(explode(': ', $notificationString[8])[1]);
                            $typeName = dbQueryField('SELECT typeName FROM invTypes WHERE typeID = :id',
                                'typeName', [':id' => $typeID], 'ccp');
                            $systemName = dbQueryField('SELECT solarSystemName FROM mapSolarSystems WHERE solarSystemID = :id',
                                'solarSystemName', [':id' => $solarSystemID], 'ccp');
                            $msg = "{$typeName} under attack in **{$systemName} - {$moonName}** by {$aggCharacterName} ({$aggCorpName} / {$aggAllianceName}). Status: Hull: {$hullValue}, Armor: {$armorValue}, Shield: {$shieldValue}";
                            break;
                        case 76: // Tower resource alert
                            $moonID = trim(explode(': ', $notificationString[2])[1]);
                            $moonName = dbQueryField('SELECT itemName FROM mapAllCelestials WHERE itemID = :id',
                                'itemName', [':id' => $moonID], 'ccp');
                            $solarSystemID = trim(explode(': ', $notificationString[3])[1]);
                            $systemName = dbQueryField('SELECT solarSystemName FROM mapSolarSystems WHERE solarSystemID = :id',
                                'solarSystemName', [':id' => $solarSystemID], 'ccp');
                            $blocksRemaining = trim(explode(': ', $notificationString[6])[1]);
                            $typeID = trim(explode(': ', $notificationString[7])[1]);
                            $typeName = dbQueryField('SELECT typeName FROM invTypes WHERE typeID = :id',
                                'typeName', [':id' => $typeID], 'ccp');
                            $msg = "POS in {$systemName} - {$moonName} needs fuel. Only {$blocksRemaining} {$typeName}'s remaining.";
                            break;
                        case 88: // IHUB is being attacked
                            $aggAllianceID = trim(explode(': ', $notificationString[0])[1]);
                            $aggAllianceName = $this->apiData('alli', $aggAllianceID)['allianceName'];
                            $aggCorpID = trim(explode(': ', $notificationString[0])[1]);
                            $aggCorpName = $this->apiData('corp', $aggCorpID)['corporationName'];
                            $aggID = trim(explode(': ', $notificationString[1])[1]);
                            $aggCharacterName = $this->apiData('char', $aggID)['characterName'];
                            $armorValue = trim(explode(': ', $notificationString[3])[1]);
                            $hullValue = trim(explode(': ', $notificationString[4])[1]);
                            $shieldValue = trim(explode(': ', $notificationString[5])[1]);
                            $solarSystemID = trim(explode(': ', $notificationString[6])[1]);
                            $systemName = dbQueryField('SELECT solarSystemName FROM mapSolarSystems WHERE solarSystemID = :id',
                                'solarSystemName', [':id' => $solarSystemID], 'ccp');
                            $msg = "IHUB under attack in **{$systemName}** by {$aggCharacterName} ({$aggCorpName} / {$aggAllianceName}). Status: Hull: {$hullValue}, Armor: {$armorValue}, Shield: {$shieldValue}";
                            break;
                        case 93: // Customs office is being attacked
                            $aggAllianceID = trim(explode(': ', $notificationString[0])[1]);
                            $aggAllianceName = $this->apiData('alli', $aggAllianceID)['allianceName'];
                            $aggCorpID = trim(explode(': ', $notificationString[0])[1]);
                            $aggCorpName = $this->apiData('corp', $aggCorpID)['corporationName'];
                            $aggID = trim(explode(': ', $notificationString[2])[1]);
                            $aggCharacterName = $this->apiData('char', $aggID)['characterName'];
                            $planetID = trim(explode(': ', $notificationString[3])[1]);
                            $planetName = dbQueryField('SELECT itemName FROM mapAllCelestials WHERE itemID = :id',
                                'itemName', [':id' => $planetID], 'ccp');
                            $shieldValue = trim(explode(': ', $notificationString[5])[1]);
                            $solarSystemID = trim(explode(': ', $notificationString[6])[1]);
                            $systemName = dbQueryField('SELECT solarSystemName FROM mapSolarSystems WHERE solarSystemID = :id',
                                'solarSystemName', [':id' => $solarSystemID], 'ccp');
                            $msg = "Customs Office under attack in **{$systemName}** ($planetName) by {$aggCharacterName} ({$aggCorpName} / {$aggAllianceName}). Shield Status: {$shieldValue}";
                            break;
                        case 94: // POCO Reinforced
                            $msg = 'Customs Office reinforced.';
                            break;
                        case 95: // IHub Transfer
                            $msg = 'skip';
                            break;
                        case 103: // War support offer? I think?
                            $msg = 'skip';
                            break;
                        case 111: // Bounty
                            $msg = 'skip';
                            break;
                        case 128: // Corp App
                            $msg = 'skip';
                            break;
                        case 130: // Corp app withdrawn?
                            $msg = 'skip';
                            break;
                        case 138: // Clone activation
                            $msg = 'skip';
                            break;
                        case 140: // Kill report
                            $msg = 'skip';
                            break;
                        case 141: // Kill report
                            $msg = 'skip';
                            break;
                        case 147: // Entosis has stated

                            $systemID = trim(explode(': ', $notificationString[0])[1]);
                            $systemName = dbQueryField('SELECT solarSystemName FROM mapSolarSystems WHERE solarSystemID = :id',
                                'solarSystemName', [':id' => $systemID], 'ccp');
                            $typeID = trim(explode(': ', $notificationString[1])[1]);
                            $typeName = dbQueryField('SELECT typeName FROM invTypes WHERE typeID = :id',
                                'typeName', [':id' => $typeID], 'ccp');
                            $msg = "@everyone | Entosis has started in **{$systemName}** on **{$typeName}** (Date: **{$sentDate}**)";
                            break;
                        case 148: // Entosis enabled a module ??????

                            $systemID = trim(explode(': ', $notificationString[0])[1]);
                            $systemName = dbQueryField('SELECT solarSystemName FROM mapSolarSystems WHERE solarSystemID = :id',
                                'solarSystemName', [':id' => $systemID], 'ccp');
                            $typeID = trim(explode(': ', $notificationString[1])[1]);
                            $typeName = dbQueryField('SELECT typeName FROM invTypes WHERE typeID = :id',
                                'typeName', [':id' => $typeID], 'ccp');
                            $msg = "Entosis has enabled a module in **{$systemName}** on **{$typeName}** (Date: **{$sentDate}**)";
                            break;
                        case 149: // Entosis disabled a module

                            $systemID = trim(explode(': ', $notificationString[0])[1]);
                            $systemName = dbQueryField('SELECT solarSystemName FROM mapSolarSystems WHERE solarSystemID = :id',
                                'solarSystemName', [':id' => $systemID], 'ccp');
                            $typeID = trim(explode(': ', $notificationString[1])[1]);
                            $typeName = dbQueryField('SELECT typeName FROM invTypes WHERE typeID = :id',
                                'typeName', [':id' => $typeID], 'ccp');
                            $msg = "Entosis has disabled a module in **{$systemName}** on **{$typeName}** (Date: **{$sentDate}**)";
                            break;
                        case 160: // Entosis successful

                            $systemID = trim(explode(': ', $notificationString[2])[1]);
                            $systemName = dbQueryField('SELECT solarSystemName FROM mapSolarSystems WHERE solarSystemID = :id', 'solarSystemName', [':id' => $systemID], 'ccp');
                            $msg = "Hostile entosis successful. A structure in **{$systemName}** has entered reinforced mode.";
                            break;
                        case 161: //  Command Nodes Decloaking

                            $systemID = trim(explode(': ', $notificationString[2])[1]);
                            $systemName = dbQueryField('SELECT solarSystemName FROM mapSolarSystems WHERE solarSystemID = :id',
                                'solarSystemName', [':id' => $systemID], 'ccp');
                            $msg = "Command nodes decloaking for **{$systemName}**";
                            break;
                        case 163: //  Outpost freeport

                            $systemID = trim(explode(': ', $notificationString[1])[1]);
                            $systemName = dbQueryField('SELECT solarSystemName FROM mapSolarSystems WHERE solarSystemID = :id',
                                'solarSystemName', [':id' => $systemID], 'ccp');
                            $msg = "Station in **{$systemName}** has now entered freeport mode.";
                            break;
                        case 182: //  Citadel being anchored
                            $corpName = trim(explode(': ', $notificationString[1])[1]);
                            $solarSystemID = trim(explode(': ', $notificationString[2])[1]);
                            $systemName = dbQueryField('SELECT solarSystemName FROM mapSolarSystems WHERE solarSystemID = :id',
                                'solarSystemName', [':id' => $solarSystemID], 'ccp');
                            $msg = "Citadel owned by **{$corpName}** is being anchored in **{$systemName}**.";
                            break;
                        case 184: //  Citadel under attack
                            $aggID = trim(explode(': ', $notificationString[7])[1]);
                            $aggCharacterName = $this->apiData('char', $aggID)['characterName'];
                            $solarSystemID = trim(explode(': ', $notificationString[15])[1]);
                            $aggAllianceID = trim(explode(': ', $notificationString[0])[1]);
                            $aggAllianceName = $this->apiData('alli', $aggAllianceID)['allianceName'];
                            $aggCorpID = trim(explode('- ', $notificationString[11])[1]);
                            $aggCorpName = $this->apiData('corp', $aggCorpID)['corporationName'];
                            $systemName = dbQueryField('SELECT solarSystemName FROM mapSolarSystems WHERE solarSystemID = :id',
                                'solarSystemName', [':id' => $solarSystemID], 'ccp');
                            $msg = "@everyone | Citadel under attack in **{$systemName}** by **{$aggCharacterName}** ({$aggCorpName} / {$aggAllianceName}).";
                            break;
                        case 185: //  Citadel online

                            $solarSystemID = trim(explode(': ', $notificationString[0])[1]);
                            $systemName = dbQueryField('SELECT solarSystemName FROM mapSolarSystems WHERE solarSystemID = :id',
                                'solarSystemName', [':id' => $solarSystemID], 'ccp');
                            $msg = "Citadel now online in **{$systemName}**.";
                            break;
                        case 188: //  Citadel destroyed

                            $corpID = trim(explode('- ', $notificationString[3])[1]);
                            $corpName = $this->apiData('corp', $corpID)['corporationName'];
                            $solarSystemID = trim(explode(': ', $notificationString[5])[1]);
                            $systemName = dbQueryField('SELECT solarSystemName FROM mapSolarSystems WHERE solarSystemID = :id',
                                'solarSystemName', [':id' => $solarSystemID], 'ccp');
                            $msg = "Citadel owned by **{$corpName}** in **{$systemName}** has been destroyed.";
                            break;
                        case 199: // citadel delivery
                            $msg = 'skip';
                            break;
                        default: // Unknown typeID
                            $string = implode(' ', $notificationString);
                            $msg = "typeID {$typeID} is an unmapped notification, send Mr Twinkie this whole message via evemail or github issue. {$string}";
                            break;
                    }

                    if ($msg == 'skip') {
                        return;
                    }
                    if ($msg == '') {
if (rand(1, 6) > 3) {
//print "Check failed";
} else {
    print "Check succeeded";
}
                    }
                    $this->logger->addInfo("Notification sent to channel {$this->toDiscordChannel}, Message - {$msg}");
                    $channelID = $this->toDiscordChannel;
                    $channel = Channel::find($channelID);
                    $channel->sendMessage($msg, false);
                    // Find the maxID so we don't output this message again in the future
                    $this->maxID = max($notificationID, $this->maxID);
                    $this->newestNotificationID = $this->maxID;
                    setPermCache('newestNotificationID', $this->maxID);
                }
            }

            $this->logger->addInfo("Next Notification Check At: {$cacheTimer} EVE Time");
        } catch (Exception $e) {
            $this->logger->addInfo('Notification Error: '.$e->getMessage());
        }
    }

    /**
     * @param $keyID
     * @param $vCode
     * @param $characterID
     * @param $notificationID
     *
     * @return string
     */
    public function getNotificationText($keyID, $vCode, $characterID, $notificationID)
    {
        $url = "https://api.eveonline.com/char/NotificationTexts.xml.aspx?keyID={$keyID}&vCode={$vCode}&characterID={$characterID}&IDs={$notificationID}";
        $data = json_decode(json_encode(simplexml_load_string(downloadData($url),
            'SimpleXMLElement', LIBXML_NOCDATA)), true);
        $data = $data['result']['rowset']['row'];

        return $data;
    }


    public function onMessage()
    {
    }

    /**
     * @param string $type
     * @param string $typeID
     *
     * @return mixed
     */
    public function apiData($type, $typeID)
    {
        $downloadFrom = '';
        switch ($type) {
            case 'char':
                $downloadFrom = $this->charApi;
                break;
            case 'corp':
                $downloadFrom = $this->corpApi;
                break;
            case 'alli':
                $downloadFrom = $this->alliApi;
                break;
        }

        return json_decode(downloadData($downloadFrom.$typeID.'/'), true);
    }

    /**
     * @return array
     */
    public function information()
    {
        return [
            'name'        => '',
            'trigger'     => [''],
            'information' => '', ];
    }
}

shibdib / Dramiel

Push — master ( fb6ce1...7c7d88 )

notifications::information() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
