kakserpom / phpdaemon

PHPDaemon/HTTPRequest/Input.php

<?php
namespace PHPDaemon\HTTPRequest;

use PHPDaemon\Core\Daemon;
use PHPDaemon\Core\Debug;

/**
 * HTTP request input buffer
 * @package PHPDaemon\HTTPRequest
 * @author  Vasily Zorin <maintainer@daemon.io>
 */
class Input extends \EventBuffer
{
    use \PHPDaemon\Traits\ClassWatchdog;
    use \PHPDaemon\Traits\StaticObjectWatchdog;

    /**
     * State: seek nearest boundary
     */
    const STATE_SEEKBOUNDARY = 0;
    /**
     * State: headers
     */
    const STATE_HEADERS = 1;
    /**
     * State: body
     */
    const STATE_BODY = 2;
    /**
     * State: upload
     */
    const STATE_UPLOAD = 3;
    /**
     * @var array Current Part
     */
    public $curPart;
    /**
     * @var string Boundary
     */
    protected $boundary;
    /**
     * @var integer Maximum file size from multi-part query
     */
    protected $maxFileSize = 0;
    /**
     * @var integer Readed
     */
    protected $readed = 0;
    /**
     * @var boolean Frozen
     */
    protected $frozen = false;
    /**
     * @var boolean EOF
     */
    protected $EOF = false;
    /**
     * @var array Content dispostion of current Part
     */
    protected $curPartDisp = false;
    /**
     * @var Generic Related Request
     */
    protected $req;
    /**
     * @var integer (self::STATE_*) State of multi-part processor
     */
    protected $state = self::STATE_SEEKBOUNDARY;
    /**
     * @var integer Size of current upload chunk
     */
    protected $curChunkSize;

    /**
     * Set boundary
     * @param  string $boundary Boundary
     * @return void
     */
    public function setBoundary($boundary)
    {
        $this->boundary = $boundary;
    }

    /**
     * Freeze input
     * @param  boolean $at_front At front. Default is true. If the front of a buffer is frozen, operations that drain data from the front of the buffer, or that prepend data to the buffer, will fail until it is unfrozen. If the back a buffer is frozen, operations that append data from the buffer will fail until it is unfrozen
     * @return void
     */
    public function freeze($at_front = false)
    {
        $this->frozen = true;
        //parent::freeze($at_front); // @TODO: discuss related pecl-event/libevent bug
    }

    /**
     * Unfreeze input
     * @param  boolean $at_front At front. Default is true. If the front of a buffer is frozen, operations that drain data from the front of the buffer, or that prepend data to the buffer, will fail until it is unfrozen. If the back a buffer is frozen, operations that append data from the buffer will fail until it is unfrozen
     * @return void
     */
    public function unfreeze($at_front = false)
    {
        $f = $this->frozen;
        $this->frozen = false;
        //parent::unfreeze($at_front); // @TODO: discuss related pecl-event/libevent bug
        $this->onRead();
        if ($f && $this->EOF) {
            $this->onEOF();
        }
        $this->req->checkIfReady();
    }

    /**
     * onRead
     * @return void
     */
    protected function onRead()
    {
        if (!empty($this->boundary)) {
            $this->req->attrs->input->parseMultipart();
        }
        if (($this->req->attrs->contentLength <= $this->readed) && !$this->EOF) {
            $this->sendEOF();
        }
    }

    /**
     * Send EOF
     * @return void
     */
    public function sendEOF()
    {
        if (!$this->EOF) {
            $this->EOF = true;
            $this->onEOF();
        }
    }

    /**
     * onEOF
     * @return void
     */
    protected function onEOF()
    {
        if (!$this->req) {
            return;
        }
        if ($this->frozen) {
            return;
        }
        if ($this->req->attrs->inputDone) {
            return;
        }
        $this->curPart =& $foo;

The variable $foo does not exist. Did you forget to declare it?

        $this->req->attrs->inputDone = true;
        $this->req->attrs->raw = '';
        if (($l = $this->length) > 0) {
            $this->req->attrs->raw = $this->read($l);
            if (isset($this->req->contype['application/x-www-form-urlencoded'])) {
                Generic::parseStr($this->req->attrs->raw, $this->req->attrs->post);
            }
            if (isset($this->req->contype['application/json']) || isset($this->req->contype['application/x-json'])) {
                $this->req->attrs->post = json_decode($this->req->attrs->raw, true);
            }
        }
        $this->req->postPrepare();
        $this->req->checkIfReady();
    }

    /**
     * Is frozen?
     * @return boolean
     */
    public function isFrozen()
    {
        return $this->frozen;
    }

    /**
     * Is EOF?
     * @return boolean
     */
    public function isEof()
    {
        return $this->EOF;
    }

    /**
     * Set request
     * @param  Generic $req Request
     * @return void
     */
    public function setRequest(Generic $req)
    {
        $this->req = $req;
    }

    /**
     * Moves $n bytes from input buffer to arbitrary buffer
     * @param  \EventBuffer $buf Source nuffer
     * @return integer
     */
    public function readFromBuffer(\EventBuffer $buf)
    {
        if (!$this->req) {
            return false;
        }
        $n = min($this->req->attrs->contentLength - $this->readed, $buf->length);
        if ($n > 0) {
            $m = $this->appendFrom($buf, $n);
            $this->readed += $m;
            if ($m > 0) {
                $this->onRead();
            }
        } else {
            $this->onRead();
            return 0;
        }
        return $m;
    }

    /**
     * Append string to input buffer
     * @param  string $chunk Piece of request input
     * @param  boolean $final Final call is THIS SEQUENCE of calls (not mandatory final in request)?
     * @return void
     */
    public function readFromString($chunk, $final = true)
    {
        $this->add($chunk);
        $this->readed += mb_orig_strlen($chunk);
        if ($final) {
            $this->onRead();
        }
    }


    /**
     * Read from buffer without draining
     * @param  integer $n Number of bytes to read
     * @param  integer $o Offset
     * @return string
     */
    public function look($n, $o = 0)
    {
        if ($this->length <= $o) {
            return '';
        }
        return $this->substr($o, $n);
    }


    /**
     * Parses multipart
     * @return void
     */
    public function parseMultipart()
    {
        start:
        if ($this->frozen) {
            return;
        }
        if ($this->state === self::STATE_SEEKBOUNDARY) {
            // seek to the nearest boundary
            if (($p = $this->search('--' . $this->boundary . "\r\n")) === false) {
                return;
            }
            // we have found the nearest boundary at position $p
            if ($p > 0) {
                $extra = $this->read($p);
                if ($extra !== "\r\n") {
                    $this->log('parseBody(): SEEKBOUNDARY: got unexpected data before boundary (length = ' . $p . '): ' . Debug::exportBytes($extra));
                }
            }
            $this->drain(mb_orig_strlen($this->boundary) + 4); // drain
            $this->state = self::STATE_HEADERS;
        }
        if ($this->state === self::STATE_HEADERS) {
            // parse the part's headers
            $this->curPartDisp = false;

It seems like false of type false is incompatible with the declared type array of property $curPartDisp.

            $i = 0;
            do {
                $l = $this->readline(\EventBuffer::EOL_CRLF);
                if ($l === null) {
                    return;
                }
                if ($l === '') {
                    break;
                }

                $e = explode(':', $l, 2);
                $e[0] = strtr(strtoupper($e[0]), Generic::$htr);
                if (isset($e[1])) {
                    $e[1] = ltrim($e[1]);
                }
                if (($e[0] === 'CONTENT_DISPOSITION') && isset($e[1])) {
                    Generic::parseStr($e[1], $this->curPartDisp, true);
                    if (!isset($this->curPartDisp['form-data'])) {
                        break;
                    }
                    if (!isset($this->curPartDisp['name'])) {
                        break;
                    }
                    $this->curPartDisp['name'] = trim($this->curPartDisp['name'], '"');
                    $name = $this->curPartDisp['name'];
                    if (isset($this->curPartDisp['filename'])) {
                        $this->curPartDisp['filename'] = trim($this->curPartDisp['filename'], '"');
                        if (!ini_get('file_uploads')) {
                            break;
                        }
                        $this->req->attrs->files[$name] = [
                            'name' => $this->curPartDisp['filename'],
                            'type' => '',
                            'tmp_name' => null,
                            'fp' => null,
                            'error' => UPLOAD_ERR_OK,
                            'size' => 0,
                        ];
                        $this->curPart = &$this->req->attrs->files[$name];
                        $this->req->onUploadFileStart($this);
                        $this->state = self::STATE_UPLOAD;
                    } else {
                        $this->curPart = &$this->req->attrs->post[$name];
                        $this->curPart = '';

It seems like '' of type string is incompatible with the declared type array of property $curPart.

                    }
                } elseif (($e[0] === 'CONTENT_TYPE') && isset($e[1])) {
                    if (isset($this->curPartDisp['name']) && isset($this->curPartDisp['filename'])) {
                        $this->curPart['type'] = $e[1];
                    }
                }
            } while ($i++ < 10);
            if ($this->state === self::STATE_HEADERS) {
                $this->state = self::STATE_BODY;
            }
            goto start;
        }
        if (($this->state === self::STATE_BODY) || ($this->state === self::STATE_UPLOAD)) {
            // process the body
            $chunkEnd1 = $this->search("\r\n--" . $this->boundary . "\r\n");
            $chunkEnd2 = $this->search("\r\n--" . $this->boundary . "--\r\n");
            if ($chunkEnd1 === false && $chunkEnd2 === false) {
                /*  we have only piece of Part in buffer */
                $l = $this->length - mb_orig_strlen($this->boundary) - 8;
                if ($l <= 0) {
                    return;
                }
                if (($this->state === self::STATE_BODY) && isset($this->curPartDisp['name'])) {
                    $this->curPart .= $this->read($l);
                } elseif (($this->state === self::STATE_UPLOAD) && isset($this->curPartDisp['filename'])) {
                    $this->curPart['size'] += $l;
                    if ($this->req->getUploadMaxSize() < $this->curPart['size']) {
                        $this->curPart['error'] = UPLOAD_ERR_INI_SIZE;
                        $this->req->header('413 Request Entity Too Large');
                        $this->req->out('');
                        $this->req->finish();
                    } elseif ($this->maxFileSize && ($this->maxFileSize < $this->curPart['size'])) {
                        $this->curPart['error'] = UPLOAD_ERR_FORM_SIZE;
                        $this->req->header('413 Request Entity Too Large');
                        $this->req->out('');
                        $this->req->finish();
                    } else {
                        $this->curChunkSize = $l;

It seems like $l can also be of type double. However, the property $curChunkSize is declared as type integer. Maybe add an additional type check?

                        $this->req->onUploadFileChunk($this);
                    }
                }
            } else {    /* we have entire Part in buffer */

                if ($chunkEnd1 === false) {
                    $l = $chunkEnd2;
                    $endOfMsg = true;
                } else {
                    $l = $chunkEnd1;
                    $endOfMsg = false;
                }

                if (($this->state === self::STATE_BODY) && isset($this->curPartDisp['name'])) {
                    $this->curPart .= $this->read($l);
                    if ($this->curPartDisp['name'] === 'MAX_FILE_SIZE') {
                        $this->maxFileSize = (int)$this->curPart;
                    }
                } elseif (($this->state === self::STATE_UPLOAD) && isset($this->curPartDisp['filename'])) {
                    $this->curPart['size'] += $l;
                    $this->curChunkSize = $l;
                    $this->req->onUploadFileChunk($this, true);
                }

                $this->state = self::STATE_SEEKBOUNDARY;
                if ($endOfMsg) { // end of whole message
                    $this->sendEOF();
                } else {
                    goto start; // let's read the next part
                }
            }
        }
    }

    /**
     * Log
     * @param  string $msg Message
     * @return void
     */
    public function log($msg)
    {
        Daemon::log(get_class($this) . ': ' . $msg);
    }

    /**
     * Get current upload chunk as string
     * @return string Chunk body
     */
    public function getChunkString()
    {
        if (!$this->curChunkSize) {
            return false;
        }
        $chunk = $this->read($this->curChunkSize);
        $this->curChunkSize = null;
        return $chunk;
    }

    /**
     * Write current upload chunk to file descriptor
     * @todo   It is not supported yet (callback missing in EventBuffer->write())
     * @param  mixed $fd File destriptor
     * @param  callable $cb Callback

Should the type for parameter $cb not be callable|null?

     * @return boolean      Success
     */
    public function writeChunkToFd($fd, $cb = null)
    {
        return false; // It is not supported yet (callback missing in EventBuffer->write())
        if (!$this->curChunkSize) {

if (!$this->curChunkSize) { return false; } does not seem to be reachable.

            return false;
        }
        $this->write($fd, $this->curChunkSize);
        $this->curChunkSize = null;
        return true;
    }
}