Kristuff\AbuseIPDB\ShellUtils

Complexity

Total Complexity

22

Size/Duplication

Total Lines	232
Duplicated Lines	0 %

Importance

Changes	5
Bugs	0	Features	0

10 Methods

Rating	Name	Duplication	Size	Complexity
A	printLogo()	0	7	2
A	isDefaultOuput()	0	3	1
A	clearTempMessage()	0	5	2
A	printTempMessage()	0	4	2
A	printTitle()	0	6	2
A	printResult()	0	11	4
A	printVersion()	0	16	1
A	printBanner()	0	11	2
A	getScoreBadge()	0	16	3
A	printFooter()	0	19	3

<?php declare(strict_types=1);

/**
 *       _                 ___ ___ ___  ___
 *  __ _| |__ _  _ ___ ___|_ _| _ \   \| _ )
 * / _` | '_ \ || (_-</ -_)| ||  _/ |) | _ \
 * \__,_|_.__/\_,_/__/\___|___|_| |___/|___/
 * 
 * This file is part of Kristuff\AbuseIPDB.
 *
 * (c) Kristuff <kristuff@kristuff.fr>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 *
 * @version    0.9.20
 * @copyright  2020-2022 Kristuff
 */
namespace Kristuff\AbuseIPDB;

use Kristuff\Mishell\Console;
use Kristuff\AbuseIPDB\ApiHandler;

/**
 * Class ShellUtils
 * 
 * Abstract base class for main cli program
 */
abstract class ShellUtils
{
    /**
     * helper functions
     */
    use UtilsTrait;
  
    /**
     * @var string      
     */
    const OUTPUT_JSON       = 'json';

    /**
     * @var string      
     */
    const OUTPUT_DEFAULT    = 'default';

    /**
     * @var string      
     */
    const OUTPUT_PLAINTEXT  = 'plaintext';
    
    /**
     * @var string      $outputFormat
     */
    protected static $outputFormat = self::OUTPUT_DEFAULT; 

    /**
     * Gets whether current output is default 
     */
    protected static function isDefaultOuput(): bool
    {
        return self::$outputFormat === self::OUTPUT_DEFAULT; 
    }

    /**
     * Prints title action banner 
     * 
     * @access protected
     * @static
     * @param string    $title
     * 
     * @return void
     */
    protected static function printTitle(string $title): void
    {
        if (self::isDefaultOuput()) {
            Console::log();
            Console::log($title);
            Console::log();
        }
    }
  
    /**
     * Print temp message during api request 
     * 
     * @access protected
     * @static
     * @param array $arguments
     * 
     * @return void
     */
    protected static function printTempMessage(): void
    {
        if (self::isDefaultOuput()) {
            Console::reLog(Console::text('   ? ', 'green') . Console::text('waiting for api response', 'white') . Console::text(' ... ', 'green'));
        }
    }

    /**
     * Clear the temp message set during api request 
     * 
     * @access protected
     * @static
     * @param array $arguments
     * 
     * @return void
     */
    protected static function clearTempMessage(): void
    {
        if (self::isDefaultOuput()) {
            // long blank string to overwrite previous message
            Console::reLog('                                                     ');
        }
    }

    /**
     * Print to banner 
     * 
     * @access protected
     * @static
     * @param array $arguments
     * 
     * @return void
     */
    protected static function printLogo(): void
    {
        if (self::isDefaultOuput()) {
            Console::log("        _                 ___ ___ ___  ___        ", "darkgray");
            Console::log("   __ _| |__ _  _ ___ ___|_ _| _ \   \| _ )       ", "darkgray");
            Console::log("  / _` | '_ \ || (_-</ -_)| ||  _/ |) | _ \       ", "darkgray");
            Console::log("  \__,_|_.__/\_,_/__/\___|___|_| |___/|___/       ", "darkgray");
        }
    }

    /**
     * Print version 
     * 
     * @access protected
     * @static
     * @param array $arguments
     * 
     * @return void
     */
    protected static function printVersion(): void
    {
        self::printLogo();

        Console::log();
        Console::log(Console::text('  Kristuff/AbuseIPDB Client version: ', 'darkgray') . Console::text(AbuseIPDBClient::VERSION, 'lightgray'));
        Console::log(Console::text('  Kristuff/AbuseIPDB Core version:   ', 'darkgray') . Console::text(ApiHandler::VERSION, 'lightgray')); 
        Console::log(Console::text('  Released under the MIT licence', 'darkgray'));
        Console::log(Console::text('  Made with ', 'darkgray') . Console::text('♥', 'red') . Console::text(' in France', 'darkgray'));
        Console::log(
            Console::text('  © 2020-2022 Kristuff (', 'darkgray').
            Console::text('https://github.com/kristuff', 'darkgray', 'underlined').
            Console::text(')', 'darkgray')
        );
        //Console::log(Console::text('  --------------------------------------------------', 'darkgray'));    
        Console::log();
    }

    /**
     * Print app banner
     * 
     * @access protected
     * @static
     * 
     * @return void
     */
    protected static function printBanner(): void
    {
        if (self::isDefaultOuput()) {
            Console::log();    
            Console::log( Console::text(' Kristuff/AbuseIPDB-client ', 'darkgray') . Console::text(' ' . AbuseIPDBClient::VERSION . ' ', 'white', 'blue')); 
            Console::log(Console::text(' Made with ', 'darkgray') . Console::text('♥', 'red') . Console::text(' in France', 'darkgray')); 
            Console::log(Console::text(' © 2020-2022 Kristuff (', 'darkgray').
                Console::text('https://github.com/kristuff', 'darkgray', 'underlined').
                Console::text(')', 'darkgray')
            );
            Console::log();  
        }  
    }

    /**
     * Print footer
     * 
     * @access protected
     * @static
     * 
     * @return void
     */
    protected static function printFooter($requestTime = ''): void
    {
        if (self::isDefaultOuput()) {
            if (!empty($requestTime)){
                $date_utc = new \DateTime("now", new \DateTimeZone("UTC"));
                Console::log(
                    Console::text('  Request time: ', 'darkgray') . Console::text($requestTime . 's', 'lightgray'). 
                    Console::text(' | UTC time: ', 'darkgray') . Console::text($date_utc->format('Y-m-d H:i:s'), 'lightgray')
                );
            }
            Console::log(Console::text('  ------------------------------------------------------------------------------------------------------', 'darkgray')); 
            Console::log(
                Console::text('  Kristuff\AbuseIPDB ', 'darkgray') . 
                Console::text(AbuseIPDBClient::VERSION, 'lightgray') . 
                Console::text(' | Made with ', 'darkgray') . 
                Console::text('♥', 'red') .
                Console::text(' in France | © 2020-2022 Kristuff (https://github.com/kristuff)', 'darkgray')
            ); 
            Console::log(); 
        }   
    }

    /**
     * Prints/gets a result value 
     * 
     * @access protected
     * @static
     * 
     * @return string
     */
    protected static function printResult($text, $value, string $foregroundColor = 'lightred', string $backgroundColor = '', bool $print = true): string
    {
        // do not print null/blank values
        if (isset($value)){
            $line = Console::text($text, 'white') . Console::text($value, $foregroundColor, $backgroundColor); 
            if ($print && self::isDefaultOuput()){
                Console::log($line);
            }
            return $line;
        }
        return '';
    }
 
    /**
     * Prints score badge 
     * 
     * @access protected
     * @static
     * @param string    $text       
     * @param int       $score     
     * @param string    $textColor
     * 
     * @return string
     */
    protected static function getScoreBadge(int $score, string $padding = ' '): string
    {
        $scoreforegroundColor = 'white';
        $scoreBackgroundColor = 'green';

        if (intval($score) > 0 ){
            $scoreforegroundColor = 'black';
            $scoreBackgroundColor = 'yellow';
        } 
        if (intval($score) > 50 ){
            $scoreforegroundColor = 'white';
            $scoreBackgroundColor = 'red';
        } 
  
        $badge = str_pad(strval($score), 3, ' ',STR_PAD_LEFT); 
        return Console::text($padding.$badge.$padding, $scoreforegroundColor, $scoreBackgroundColor);
    }
}