Helix\Socket\WebSocket\Frame

Complexity

Total Complexity

26

Size/Duplication

Total Lines	212
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

20 Methods

Rating	Name	Duplication	Size	Complexity
A	getOpCode()	0	2	1
A	isClose()	0	2	1
A	hasRsv1()	0	2	1
A	isText()	0	2	1
A	hasRsv2()	0	2	1
A	isPong()	0	2	1
A	__toString()	0	5	2
A	isPing()	0	2	1
A	isFinal()	0	2	1
A	hasRsv3()	0	2	1
A	validate()	0	13	5
A	isControl()	0	2	1
A	getRsv()	0	2	1
A	isContinue()	0	2	1
A	__construct()	0	5	1
A	getCloseReason()	0	2	1
A	getCloseCode()	0	5	2
A	getPayload()	0	2	1
A	getLength()	0	2	1
A	isBinary()	0	2	1

<?php

namespace Helix\Socket\WebSocket;

/**
 * A WebSocket frame.
 *
 * @link https://tools.ietf.org/html/rfc6455#section-5.2 Base Framing Protocol
 * @link https://tools.ietf.org/html/rfc6455#section-7.4.1 Defined Status Codes
 */
class Frame {

    const OP_CONTINUE = 0x00;
    const OP_TEXT = 0x01;
    const OP_BINARY = 0x02;
    const OP_CLOSE = 0x08;
    const OP_PING = 0x09;
    const OP_PONG = 0x0a;

    const CLOSE_NORMAL = 1000;              // mutual closure
    const CLOSE_INTERRUPT = 1001;           // abrupt closure due to hangups, reboots, "going away"
    const CLOSE_PROTOCOL_ERROR = 1002;      // invalid behavior / framing
    const CLOSE_UNHANDLED_DATA = 1003;      // message handler doesn't want the payload
    const CLOSE_BAD_DATA = 1007;            // message handler can't understand the payload
    const CLOSE_POLICY_VIOLATION = 1008;    // generic "access denied"
    const CLOSE_TOO_LARGE = 1009;           // unacceptable payload size
    const CLOSE_EXPECTATION = 1010;         // peer closed because it wants extensions (listed in the reason)
    const CLOSE_INTERNAL_ERROR = 1011;      // like http 500

    /**
     * @var bool
     */
    protected $final;

    /**
     * @var int
     */
    protected $opCode;

    /**
     * @var string
     */
    protected $payload;

    /**
     * @var int
     */
    protected $rsv;

    /**
     * @param bool $final
     * @param int $rsv
     * @param int $opCode
     * @param string $payload
     */
    public function __construct (bool $final, int $rsv, int $opCode, string $payload) {
        $this->final = $final;
        $this->rsv = $rsv;
        $this->opCode = $opCode;
        $this->payload = $payload;
    }

    /**
     * The payload or close reason.
     *
     * @return string
     */
    final public function __toString () {
        if ($this->isClose()) {
            return $this->getCloseReason();
        }
        return $this->payload;
    }

    /**
     * The `CLOSE` code.
     *
     * https://tools.ietf.org/html/rfc6455#section-5.5.1
     *
     * @return int
     */
    public function getCloseCode (): int {
        if ($this->getLength() >= 2) {
            return unpack('n', substr($this->payload, 0, 2))[1];
        }
        return self::CLOSE_NORMAL;
    }

    /**
     * The `CLOSE` reason.
     *
     * https://tools.ietf.org/html/rfc6455#section-5.5.1
     *
     * @return string
     */
    public function getCloseReason (): string {
        return substr($this->payload, 2);
    }

    /**
     * @return int
     */
    final public function getLength (): int {
        return strlen($this->payload);
    }

    /**
     * @return int
     */
    final public function getOpCode (): int {
        return $this->opCode;
    }

    /**
     * @return string
     */
    final public function getPayload (): string {
        return $this->payload;
    }

    /**
     * @return int
     */
    final public function getRsv (): int {
        return $this->rsv;
    }

    /**
     * @return bool
     */
    final public function hasRsv1 (): bool {
        return (bool)($this->rsv & 0b100);
    }

    /**
     * @return bool
     */
    final public function hasRsv2 (): bool {
        return (bool)($this->rsv & 0b010);
    }

    /**
     * @return bool
     */
    final public function hasRsv3 (): bool {
        return (bool)($this->rsv & 0b001);
    }

    /**
     * @return bool
     */
    final public function isBinary (): bool {
        return $this->opCode === self::OP_BINARY;
    }

    /**
     * @return bool
     */
    final public function isClose (): bool {
        return $this->opCode === self::OP_CLOSE;
    }

    /**
     * @return bool
     */
    final public function isContinue (): bool {
        return $this->opCode === self::OP_CONTINUE;
    }

    /**
     * @return bool
     */
    final public function isControl (): bool {
        return (bool)($this->opCode & 0b1000);
    }

    /**
     * @return bool
     */
    final public function isFinal (): bool {
        return $this->final;
    }

    /**
     * @return bool
     */
    final public function isPing (): bool {
        return $this->opCode === self::OP_PING;
    }

    /**
     * @return bool
     */
    final public function isPong (): bool {
        return $this->opCode === self::OP_PONG;
    }

    /**
     * @return bool
     */
    final public function isText (): bool {
        return $this->opCode === self::OP_TEXT;
    }

    /**
     * Throws if invalid. Doesn't validate the payload.
     *
     * @throws WebSocketError
     */
    public function validate (): void {
        if ($this->isControl()) {
            if ($this->opCode > self::OP_PONG) {
                throw new WebSocketError(self::CLOSE_PROTOCOL_ERROR, "Reserved control opcode ($this->opCode).");
            }
            // https://tools.ietf.org/html/rfc6455#section-5.4
            // Page 34: "Control frames themselves MUST NOT be fragmented."
            if (!$this->isFinal()) {
                throw new WebSocketError(self::CLOSE_PROTOCOL_ERROR, "Fragmented control frame.");
            }
        }
        elseif ($this->opCode > self::OP_BINARY) {
            throw new WebSocketError(self::CLOSE_PROTOCOL_ERROR, "Reserved data opcode ($this->opCode).");
        }
    }

}