FlexyProject\GitHub\Event\Payload

Complexity

Total Complexity

18

Size/Duplication

Total Lines	203
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	4

Importance

Changes

0

12 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	7	1
A	getWebHook()	0	4	1
A	setWebHook()	0	6	1
A	setSecret()	0	6	1
A	getSecret()	0	4	1
A	getRawData()	0	4	1
A	setRawData()	0	6	1
A	getData()	0	4	1
A	setParsedData()	0	9	2
A	__debugInfo()	0	7	1
B	parse()	0	24	4
A	_checkSignature()	0	22	3

<?php
namespace FlexyProject\GitHub\Event;

use Exception;
use FlexyProject\GitHub\Exception\BadSignatureException;
use FlexyProject\GitHub\WebHook;
use Symfony\Component\HttpFoundation\ServerBag;

/**
 * Payloads
 *
 * @link    https://developer.github.com/webhooks/#payloads
 * @package FlexyProject\GitHub\Event
 */
class Payload implements EventInterface
{
    /** @var WebHook */
    protected $webHook;

    /** @var null|string */
    protected $secret = null;

    /** @var string|resource */
    protected $rawData;

    /** @var mixed */
    protected $parsedData;

    /** @var ServerBag */
    protected $serverBag;

    /**
     * Constructor, pass a WebHook object
     *
     * @param WebHook $webHook
     */
    public function __construct(WebHook $webHook)
    {
        $this->setWebHook($webHook);
        $request = $webHook->getRequest();
        $this->setRawData($request->getContent());
        $this->serverBag = $request->server;
    }

    /**
     * Get webHook
     *
     * @return null|WebHook
     */
    public function getWebHook()
    {
        return $this->webHook;
    }

    /**
     * Set webHook
     *
     * @param mixed $webHook
     *
     * @return Payload
     */
    public function setWebHook($webHook): Payload
    {
        $this->webHook = $webHook;

        return $this;
    }

    /**
     * Set secret, encode this secret with Hmac, SHA1 method
     *
     * @param string $secret
     *
     * @return Payload
     */
    public function setSecret(string $secret): Payload
    {
        $this->secret = hash_hmac('sha1', $this->rawData, $secret);

        return $this;
    }

    /**
     * Get secret
     *
     * @return null|string
     */
    public function getSecret()
    {
        return $this->secret;
    }

    /**
     * Get rawData
     *
     * @return resource|string
     */
    public function getRawData()
    {
        return $this->rawData;
    }

    /**
     * Set rawData
     *
     * @param resource|string $rawData
     *
     * @return Payload
     */
    public function setRawData($rawData): Payload
    {
        $this->rawData = $rawData;

        return $this;
    }

    /**
     * Get parsedData
     *
     * @return mixed
     */
    public function getData()
    {
        return $this->parsedData;
    }

    /**
     * Set parsedData
     *
     * @param mixed $parsedData
     *
     * @return Payload
     */
    protected function setParsedData($parsedData): Payload
    {
        $data = json_decode($parsedData);
        if (JSON_ERROR_NONE === json_last_error()) {
            $this->parsedData = $data;
        }

        return $this;
    }

    /**
     * Debugger
     *
     * @return array
     */
    public function __debugInfo(): array
    {
        return [
            'ramData'     => (array)$this->getRawData(),
            'jsonEncoded' => json_decode($this->getRawData())
        ];
    }

    /**
     * Parse raw data
     *
     * @return Payload
     * @throws BadSignatureException
     * @throws \Exception
     */
    public function parse(): Payload
    {
        /** Check signature from header */
        if (!$this->_checkSignature()) {
            throw new BadSignatureException('Hook secret does not match.');
        }

        /** Get data from different locations according to content-type */
        switch ($this->serverBag->get('CONTENT_TYPE')) {
            case 'application/json':
                $data = $this->getRawData();
                break;

            case 'application/x-www-form-urlencoded':
                $data = $_POST['payload'];
                break;

            default:
                throw new Exception('Unsupported content type: "' . $this->serverBag->get('CONTENT_TYPE') . '"');
        }
        $this->setParsedData($data);

        return $this;
    }

    /**
     * Check X-Hub-Signature
     *
     * @throws BadSignatureException
     * @return bool
     */
    private function _checkSignature(): bool
    {
        $secret           = $this->getSecret();
        $httpHubSignature = $this->serverBag->get('HTTP_X_HUB_SIGNATURE');

        if (null !== $secret) {
            if ($httpHubSignature) {
                /**
                 * Split signature into algorithm and hash
                 *
                 * @link http://isometriks.com/verify-github-webhooks-with-php
                 */
                list(, $hash) = explode('=', $httpHubSignature, 2);

                return $secret == $hash;
            }

            throw new BadSignatureException('HTTP header "X-Hub-Signature" is missing.');
        }

        return true;
    }
}