nicoSWD / headsec

src/Infrastructure/ResultPrinter/ConsoleResultPrinter.php

<?php declare(strict_types=1);

/**
 * @license  http://opensource.org/licenses/mit-license.php MIT
 * @link     https://github.com/nicoSWD
 * @author   Nicolas Oelgart <nico@oelgart.com>
 */
namespace nicoSWD\SecHeaderCheck\Infrastructure\ResultPrinter;

use nicoSWD\SecHeaderCheck\Domain\Header\SecurityHeader;
use nicoSWD\SecHeaderCheck\Domain\Result\AuditionResult;
use nicoSWD\SecHeaderCheck\Domain\Result\HeaderWithObservations;
use nicoSWD\SecHeaderCheck\Domain\Result\ObservationCollection;
use nicoSWD\SecHeaderCheck\Domain\ResultPrinter\OutputOptions;
use nicoSWD\SecHeaderCheck\Domain\ResultPrinter\ResultPrinterInterface;

final class ConsoleResultPrinter implements ResultPrinterInterface
{
    public function getOutput(AuditionResult $scanResults, OutputOptions $outputOptions): string
    {
        $output = '';
        $totalWarnings = 0;

        foreach ($scanResults->getObservations() as $observations) {
            if ($observations->getObservations()->empty() && !$outputOptions->showAllHeaders()) {
                continue;
            }

            $totalWarnings++;

            if ($this->hasErrors($observations)) {
                $res = '<fg=red>Fail </>';
            } elseif ($this->hasWarnings($observations)) {
                $res = '<fg=yellow>Pass </>';
            } else {
                $res = '<fg=green>Pass </>';
            }

            $output .= $res . '<bg=default;fg=white>' . $this->prettyName($observations->getHeaderName()) . ': ' . $this->shortenHeaderValue($observations->getHeaderName(), $observations->getHeaderValue()) . ' </>' . $this->getWarnings($observations->getObservations());
        }

        $missingHeaders = $scanResults->getMissingHeaders();

        if ($missingHeaders) {

The expression $missingHeaders of type array is implicitly converted to a boolean; are you sure this is intended? If so, consider using ! empty($expr) instead to make it clear that you intend to check for an array without elements.

            $output .= PHP_EOL . '<bg=red>Missing headers</>: ';
        }

        foreach ($missingHeaders as $headerName) {
            $totalWarnings++;
            $output .= '<bg=red;fg=black>' . $this->prettyName($headerName) . '</> ';
        }

        if ($missingHeaders) {

The expression $missingHeaders of type array is implicitly converted to a boolean; are you sure this is intended? If so, consider using ! empty($expr) instead to make it clear that you intend to check for an array without elements.

            $output .= PHP_EOL;
        }

        if ($totalWarnings === 0) {
            $output .= '  <bg=green;fg=black>                            </>' . PHP_EOL ;
            $output .= '  <bg=green;fg=black>   Congrats, no warnings!   </>' . PHP_EOL ;
            $output .= '  <bg=green;fg=black>                            </>' . PHP_EOL ;
        }

//        $output .= PHP_EOL .'Total Score: <comment>' . $scanResults->getScore() . '</comment> out of <comment>10</comment> (<fg=red>Fail</>)';

        return $output;
    }

    private function prettyName($headerName): string
    {
        return '<fg=cyan>' . implode('-', array_map('ucfirst', explode('-', $headerName))) . '</>';
    }

    private function getWarnings(ObservationCollection $observations): string
    {
        $out = '';
        $c = 1;

        foreach ($observations as $observation) {
            $out .= PHP_EOL . '  ' . $c++ . ')';

            if ($observation->isInfo()) {
                $out .= '<fg=yellow> ' . (string) $observation . '</> ';
            } elseif ($observation->isWarning()) {
                $out .= '<fg=red> ' . (string) $observation . '</> ';
            } elseif ($observation->isKudos()) {
                $out .= '<fg=green> ' . (string) $observation . '</> ';
            } else {
                $out .= '<fg=red> ' . (string) $observation . '</> ';
            }
        }

        return $out . PHP_EOL;
    }

    private function shortenHeaderValue(string $headerName, string $headerValue): string
    {
        $width = (int) `tput cols`;

The assignment to $width is dead and can be removed.

        if ($headerName === SecurityHeader::SET_COOKIE) {
            $callback = function (array $match): string {
                if (strlen($match['value']) < 20) {
                    return $match['full_match'];
                }

                return sprintf(
                    '%s=%s<bg=cyan>(...)</>%s',
                    $match['name'],
                    substr($match['value'], 0, 8),
                    substr($match['value'], -8)
                );
            };

            return preg_replace_callback('~(?<full_match>(?<name>.*?)=(?<value>.*?;))~', $callback, $headerValue);
        }

        return $headerValue;
    }

    private function hasErrors(HeaderWithObservations $header): bool
    {
        foreach ($header->getObservations() as $observation) {
            if ($observation->isError() || $observation->isWarning()) {
                return true;
            }
        }

        return false;
    }

    private function hasWarnings(HeaderWithObservations $header): bool
    {
        foreach ($header->getObservations() as $observation) {
            if ($observation->isInfo()) {
                return true;
            }
        }

        return false;
    }
}