Gelf\MessageValidator

Complexity

Total Complexity

13

Size/Duplication

Total Lines	84
Duplicated Lines	0 %

Test Coverage

Coverage

96.97%

Importance

Changes	3
Bugs	0	Features	0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	validate0100()	0	27	5
A	validate0101()	0	19	4
A	validate()	0	13	3
A	isEmpty()	0	3	1

<?php
declare(strict_types=1);

/*
 * This file is part of the php-gelf package.
 *
 * (c) Benjamin Zikarsky <http://benjamin-zikarsky.de>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Gelf;

use RuntimeException;

/**
 * Validates a given message according to the GELF standard
 *
 * @author Benjamin Zikarsky <benjamin@zikarsky.de>
 * @author Joe Green
 */
class MessageValidator implements MessageValidatorInterface
{
    public function validate(MessageInterface $message, ?string &$reason = null): bool
    {
        switch ($message->getVersion()) {
            case "1.0":
                return $this->validate0100($message, $reason);
            case "1.1":
                return $this->validate0101($message, $reason);
        }

        throw new RuntimeException(
            sprintf(
                "No validator for message version '%s'",
                $message->getVersion()
            )
        );
    }

    /**
     * Validates a message according to 1.0 standard
     */
    public function validate0100(MessageInterface $message, ?string &$reason = null): bool
    {
        if (self::isEmpty($message->getHost())) {
            $reason = "host not set";

            return false;
        }

        if (self::isEmpty($message->getShortMessage())) {
            $reason = "short-message not set";

            return false;
        }

        if (self::isEmpty($message->getVersion())) {
            $reason = "version not set";

            return false;
        }

        if ($message->hasAdditional('id')) {
            $reason = "additional field 'id' is not allowed";

            return false;
        }

        return true;
    }

    /**
     * Validates a message according to 1.1 standard
     */
    public function validate0101(MessageInterface $message, ?string &$reason = null): bool
    {
        // 1.1 incorporates 1.0 validation standard
        if (!$this->validate0100($message, $reason)) {
            return false;
        }

        foreach ($message->getAllAdditionals() as $key => $value) {
            if (!preg_match('#^[\w\.\-]*$#', $key)) {
                $reason = sprintf(
                    "additional key '%s' contains invalid characters",
                    $key
                );

                return false;
            }
        }

        return true;
    }

    /**
     * Checks that a given scalar will later translate
     * to a non-empty message element
     *
     * Fails on null, false and empty strings
     */
    public static function isEmpty(mixed $scalar): bool
    {
        return strlen((string)$scalar) < 1;
    }
}