O2System\Framework\Http\Controllers\Restful

Complexity

Total Complexity

108

Size/Duplication

Total Lines	697
Duplicated Lines	0 %

Importance

Changes	3
Bugs	0	Features	0

10 Methods

Rating	Name	Duplication	Size	Complexity
A	delete()	0	21	5
B	sendPayload()	0	64	10
C	update()	0	62	16
D	index()	0	71	19
C	create()	0	52	13
A	archive()	0	21	5
A	publish()	0	21	5
A	sendError()	0	17	5
A	unpublish()	0	21	5
F	__construct()	0	99	25

<?php
/**
 * This file is part of the O2System Framework package.
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 *
 * @author         Steeve Andrian Salim
 * @copyright      Copyright (c) Steeve Andrian Salim
 */

// ------------------------------------------------------------------------

namespace O2System\Framework\Http\Controllers;

// ------------------------------------------------------------------------

use O2System\Cache\Item;
use O2System\Framework\Http\Controller;
use O2System\Framework\Models\Sql\Model;
use O2System\Psr\Http\Header\ResponseFieldInterface;
use O2System\Security\Filters\Rules;
use O2System\Spl\Exceptions\Logic\OutOfRangeException;

/**
 * Class Restful
 *
 * @package O2System\Framework\Http\Controllers
 */
class Restful extends Controller
{
    /**
     * Push headers flag
     *
     * Used for push default headers by controller.
     * Set to FALSE if you want to set default headers on the web-server configuration.
     *
     * APACHE via .htaccess
     * IIS via .webconfig
     * Nginx via config
     *
     * @type string
     */
    protected $pushDefaultHeaders = false;

    /**
     * Access-Control-Allow-Origin
     *
     * Used for indicates whether a resource can be shared based by
     * returning the value of the Origin request header, "*", or "null" in the response.
     *
     * @type string
     */
    protected $accessControlAllowOrigin = '*';

    /**
     * Access-Control-Allow-Credentials
     *
     * Used for indicates whether the response to request can be exposed when the omit credentials flag is unset.
     * When part of the response to a preflight request it indicates that the actual request can include user
     * credentials.
     *
     * @type bool
     */
    protected $accessControlAllowCredentials = true;

    /**
     * Access-Control-Method
     *
     * @var string
     */
    protected $accessControlMethod = 'GET';

    /**
     * Access-Control-Params
     *
     * @var array
     */
    protected $accessControlParams = [];

    /**
     * Access-Control-Allow-Methods
     *
     * Used for indicates, as part of the response to a preflight request,
     * which methods can be used during the actual request.
     *
     * @type array
     */
    protected $accessControlAllowMethods = [
        'GET', // common request
        'POST', // used for create, update request
        //'PUT', // used for upload files request
        //'DELETE', // used for delete request
        'OPTIONS', // used for preflight request
    ];

    /**
     * Access-Control-Allow-Headers
     *
     * Used for indicates, as part of the response to a preflight request,
     * which header field names can be used during the actual request.
     *
     * @type int
     */
    protected $accessControlAllowHeaders = [
        'Origin',
        'Access-Control-Request-Method',
        'Access-Control-Request-Headers',
        'X-Api-Authenticate', // API-Authenticate: api_key="xxx", api_secret="xxx", api_signature="xxx"
        'X-Api-Token',
        'X-Web-Token', // X-Web-Token: xxx (json-web-token)
        'X-Csrf-Token',
        'X-Xss-Token',
        'X-Request-ID',
        'X-Requested-With',
        'X-Requested-Result',
    ];

    /**
     * Access-Control-Allow-Headers
     *
     * Used for indicates, as part of the response to a preflight request,
     * which header field names can be used during the actual request.
     *
     * @type array
     */
    protected $accessControlAllowContentTypes = [
        'text/html',
        'application/json',
        'application/xml',
    ];

    /**
     * Access-Control-Max-Age
     *
     * Used for indicates how long the results of a preflight request can be cached in a preflight result cache
     *
     * @type int
     */
    protected $accessControlMaxAge = 86400;

    /**
     * Restful::$ajaxOnly
     *
     * @var bool
     */
    protected $ajaxOnly = false;

    /**
     * Restful::$model
     *
     * @var \O2System\Framework\Models\Sql\Model|\O2System\Framework\Models\NoSql\Model|\O2System\Framework\Models\Files\Model
     */
    public $model;

    /**
     * Restful::$params
     *
     * @var array
     */
    public $params = [];

    /**
     * Restful::$paramsWithRules
     *
     * @var array
     */
    public $paramsWithRules = [];

    /**
     * Restful::$fillableColumns
     *
     * @var array
     */
    public $fillableColumns = [];

    /**
     * Restful::$fillableColumnsWithRules
     *
     * @var array
     */
    public $fillableColumnsWithRules = [];

    // ------------------------------------------------------------------------

    /**
     * Restful::__construct
     */
    public function __construct()
    {
        if (services()->has('presenter')) {
            presenter()->setTheme(false);

false of type false is incompatible with the type string expected by parameter $theme of O2System\Framework\Http\Presenter::setTheme().

        }

        if (is_ajax()) {
            output()->setContentType('application/json');

The method setContentType() does not exist on O2System\Kernel\Cli\Output.

        } elseif ($this->ajaxOnly === false) {
            output()->setContentType('application/json');
        } else {
            output()->setContentType('text/html');
        }

        if ($contentType = input()->server('HTTP_X_REQUESTED_CONTENT_TYPE')) {
            if (in_array($contentType, $this->accessControlAllowContentTypes)) {
                output()->setContentType($contentType);
            }
        }

        if ($this->pushDefaultHeaders) {

            $origin = input()->server('HTTP_ORIGIN');

            /**
             * Prepare for preflight modern browser request
             *
             * Since some server cannot use 'Access-Control-Allow-Origin: *'
             * the Access-Control-Allow-Origin will be defined based on requested origin
             */
            if ($this->accessControlAllowOrigin === '*') {
                output()->addHeader(ResponseFieldInterface::RESPONSE_ACCESS_CONTROL_ALLOW_ORIGIN, $origin);

The method addHeader() does not exist on O2System\Kernel\Cli\Output.

            }

            // Set response access control allowed credentials
            if ($this->accessControlAllowCredentials === false) {
                output()->addHeader(ResponseFieldInterface::RESPONSE_ACCESS_CONTROL_ALLOW_CREDENTIALS, 'false');
            }

            // Set response access control allowed methods header
            if (count($this->accessControlAllowMethods)) {
                output()->addHeader(
                    ResponseFieldInterface::RESPONSE_ACCESS_CONTROL_ALLOW_METHODS,
                    implode(', ', $this->accessControlAllowMethods)
                );
            }

            // Set response access control allowed headers header
            if (count($this->accessControlAllowHeaders)) {

$this->accessControlAllowHeaders of type integer is incompatible with the type Countable|array expected by parameter $var of count().

                output()->addHeader(
                    ResponseFieldInterface::RESPONSE_ACCESS_CONTROL_ALLOW_HEADERS,
                    implode(', ', $this->accessControlAllowHeaders)

$this->accessControlAllowHeaders of type integer is incompatible with the type array expected by parameter $pieces of implode().

                );
            }

            // Set response access control allowed content types header
            if (count($this->accessControlAllowContentTypes)) {
                output()->addHeader(
                    ResponseFieldInterface::RESPONSE_ACCESS_CONTROL_ALLOW_CONTENT_TYPES,
                    implode(', ', $this->accessControlAllowContentTypes)
                );
            }

            // Set response access control max age header
            if ($this->accessControlMaxAge > 0) {
                output()->addHeader(ResponseFieldInterface::RESPONSE_ACCESS_CONTROL_MAX_AGE,
                    $this->accessControlMaxAge);
            }
        }

        if (input()->server('REQUEST_METHOD') === 'OPTIONS') {
            exit(EXIT_SUCCESS);

Using exit here is not recommended.

        } elseif ( ! in_array(input()->server('REQUEST_METHOD'), $this->accessControlAllowMethods)) {
            $this->sendError(405);
        } elseif (count($this->accessControlParams)) {
            if ($this->accessControlMethod === 'GET') {
                if (empty($_GET)) {
                    $this->sendError(400);
                }
            } elseif ($this->accessControlMethod === 'POST') {
                if (empty($_POST)) {
                    $this->sendError(400);
                }
            } elseif (in_array($this->accessControlMethod, ['GETPOST', 'POSTGET'])) {
                if (empty($_REQUEST)) {
                    $this->sendError(400);
                }
            }
        }

        if (empty($this->model)) {
            $controllerClassName = get_called_class();
            $modelClassName = str_replace('Controllers', 'Models', $controllerClassName);

            if (class_exists($modelClassName)) {
                $this->model = new $modelClassName();
            }
        } elseif (class_exists($this->model)) {

$this->model of type O2System\Framework\Models\Files\Model|O2System\Framework\Models\NoSql\Model|O2System\Framework\Models\Sql\Model is incompatible with the type string expected by parameter $class_name of class_exists().

            $this->model = new $this->model();
        }
    }

    // ------------------------------------------------------------------------

    /**
     * Restful::index
     */
    public function index()
    {
        if(empty($this->model)) {
            output()->sendError(204);
        } else {
            if ( ! $this->model instanceof Model) {
                $this->sendError(503, 'Model is not exists!');
            }

            if ( ! $this->model instanceof Model) {

$this->model is always a sub-type of O2System\Framework\Models\Sql\Model.

                $this->sendError(503, 'Model is not exists!');
            }

            if (count($this->params)) {
                if ($get = input()->get()) {
                    if (false !== ($result = $this->model->withPaging()->findWhere($get->getArrayCopy()))) {
                        if ($result->count()) {
                            $this->sendPayload($result);
                        } else {
                            $this->sendError(204);
                        }
                    } else {
                        $this->sendError(204);
                    }
                } else {
                    $this->sendError(400, 'Get parameters cannot be empty!');
                }
            } elseif (count($this->paramsWithRules)) {
                if ($get = input()->get()) {
                    $rules = new Rules($get);

$get of type O2System\Spl\DataStructures\SplArrayObject is incompatible with the type array expected by parameter $sourceVars of O2System\Security\Filters\Rules::__construct().

                    $rules->sets($this->paramsWithRules);

                    if ( ! $rules->validate()) {
                        $this->sendError(400, implode(', ', $rules->displayErrors(true)));

It seems like $rules->displayErrors(true) can also be of type string; however, parameter $pieces of implode() does only seem to accept array, maybe add an additional type check?

The call to O2System\Security\Filters\Rules::displayErrors() has too many arguments starting with true.

                    } else {
                        $conditions = [];

                        foreach ($this->paramsWithRules as $param) {
                            if ($get->offsetExists($param[ 'field' ])) {
                                $conditions[ $param[ 'field' ] ] = $get->offsetGet($param[ 'field' ]);
                            }
                        }

                        if (false !== ($result = $this->model->withPaging()->findWhere($conditions))) {
                            if ($result->count()) {
                                $this->sendPayload($result);
                            } else {
                                $this->sendError(204);
                            }
                        } else {
                            $this->sendError(204);
                        }
                    }
                } else {
                    $this->sendError(400, 'Get parameters cannot be empty!');
                }
            } elseif ($get = input()->get()) {
                if (false !== ($result = $this->model->withPaging()->findWhere($get->getArrayCopy()))) {
                    if ($result->count()) {
                        $this->sendPayload($result);
                    } else {
                        $this->sendError(204);
                    }
                } else {
                    $this->sendError(204);
                }
            } else {
                if (false !== ($result = $this->model->allWithPaging())) {
                    $this->sendPayload($result);
                } else {
                    $this->sendError(204);
                }
            }
        }
    }

    // ------------------------------------------------------------------------

    public function sendError($code, $message = null)
    {
        if ($this->ajaxOnly === false) {
            output()->setContentType('application/json');
        }

        if (is_array($code)) {
            if (is_numeric(key($code))) {
                $message = reset($code);
                $code = key($code);
            } elseif (isset($code[ 'code' ])) {
                $code = $code[ 'code' ];
                $message = $code[ 'message' ];
            }
        }

        output()->sendError($code, $message);
    }

    // ------------------------------------------------------------------------

    /**
     * Restful::sendPayload
     *
     * @param mixed $data        The payload data to-be send.
     * @param bool  $longPooling Long pooling flag mode.
     *
     * @throws \Exception
     */
    public function sendPayload($data, $longPooling = false)
    {
        if ($longPooling === false) {
            if ($this->ajaxOnly) {
                if (is_ajax()) {
                    output()->send($data);

The method send() does not exist on O2System\Kernel\Cli\Output.

                } else {
                    output()->sendError(403);
                }
            } else {
                output()->send($data);
            }
        } elseif (is_ajax()) {
            /**
             * Server-side file.
             * This file is an infinitive loop. Seriously.
             * It gets the cache created timestamp, checks if this is larger than the timestamp of the
             * AJAX-submitted timestamp (time of last ajax request), and if so, it sends back a JSON with the data from
             * data.txt (and a timestamp). If not, it waits for one seconds and then start the next while step.
             *
             * Note: This returns a JSON, containing the content of data.txt and the timestamp of the last data.txt change.
             * This timestamp is used by the client's JavaScript for the next request, so THIS server-side script here only
             * serves new content after the last file change. Sounds weird, but try it out, you'll get into it really fast!
             */

            // set php runtime to unlimited
            set_time_limit(0);

            $longPoolingCacheKey = 'long-pooling-' . session()->get('id');

Are you sure session()->get('id') of type false|mixed can be used in concatenation?

            $longPoolingCacheData = null;

            if ( ! cache()->hasItem($longPoolingCacheKey)) {
                cache()->save(new Item($longPoolingCacheKey, $data));
            }

            // main loop
            while (true) {
                // if ajax request has send a timestamp, then $lastCallTimestamp = timestamp, else $last_call = null
                $lastCallTimestamp = (int)input()->getPost('last_call_timestamp');

The method getPost() does not exist on O2System\Kernel\Cli\Input.

                // PHP caches file data, like requesting the size of a file, by default. clearstatcache() clears that cache
                clearstatcache();

                if (cache()->hasItem($longPoolingCacheKey)) {
                    $longPoolingCacheData = cache()->getItem($longPoolingCacheKey);
                }

                // get timestamp of when file has been changed the last time
                $longPoolingCacheMetadata = $longPoolingCacheData->getMetadata();

                // if no timestamp delivered via ajax or data.txt has been changed SINCE last ajax timestamp
                if ($lastCallTimestamp == null || $longPoolingCacheMetadata[ 'ctime' ] > $lastCallTimestamp) {
                    output()->send([
                        'timestamp' => $longPoolingCacheMetadata,
                        'data'      => $data,
                    ]);
                } else {
                    // wait for 1 sec (not very sexy as this blocks the PHP/Apache process, but that's how it goes)
                    sleep(1);
                    continue;
                }
            }
        } else {
            output()->sendError(501);
        }
    }

    /**
     * Controller::create
     *
     * @throws \O2System\Spl\Exceptions\Logic\BadFunctionCall\BadDependencyCallException
     * @throws \O2System\Spl\Exceptions\Logic\OutOfRangeException
     */
    public function create()
    {
        if ($post = input()->post()) {
            if (count($this->fillableColumnsWithRules)) {
                $rules = new Rules($post);

$post of type O2System\Spl\DataStructures\SplArrayObject is incompatible with the type array expected by parameter $sourceVars of O2System\Security\Filters\Rules::__construct().

                $rules->sets($this->fillableColumnsWithRules);
                if ( ! $rules->validate()) {
                    $this->sendError(400, $rules->displayErrors(true));

The call to O2System\Security\Filters\Rules::displayErrors() has too many arguments starting with true.

                }
            }

            if ( ! $this->model instanceof Model) {
                $this->sendError(503, 'Model is not ready');
            }

            $data = [];

            if (count($this->fillableColumnsWithRules)) {
                foreach ($this->fillableColumnsWithRules as $column) {
                    if ($post->offsetExists($column[ 'field' ])) {
                        $data[ $column[ 'field' ] ] = $post->offsetGet($column[ 'field' ]);
                    }
                }
            } elseif (count($this->fillableColumns)) {
                foreach ($this->fillableColumns as $column) {
                    if ($post->offsetExists($column[ 'field' ])) {
                        $data[ $column[ 'field' ] ] = $post->offsetGet($column[ 'field' ]);
                    }
                }
            } else {
                $data = $post->getArrayCopy();
            }

            if (count($data)) {
                $data[ 'record_create_timestamp' ] = $data[ 'record_update_timestamp' ] = timestamp();
                $data[ 'record_create_user' ] = $data[ 'record_update_user' ] = globals()->account->id;

The property account does not exist on O2System\Framework\Containers\Globals. Since you implemented __get, consider adding a @property annotation.

                if ($this->model->insert($data)) {
                    $data[ 'id' ] = $this->model->db->getLastInsertId();
                    $this->sendPayload([
                        'code' => 201,
                        'Successful insert request',
                        'data' => $data,
                    ]);
                } else {
                    $this->sendError(501, 'Failed update request');
                }
            } else {
                $this->sendError(400, 'Post parameters cannot be empty!');
            }
        } else {
            $this->sendError(400);
        }
    }

    // ------------------------------------------------------------------------

    /**
     * Restful::update
     *
     * @throws \O2System\Spl\Exceptions\Logic\BadFunctionCall\BadDependencyCallException
     * @throws \O2System\Spl\Exceptions\Logic\OutOfRangeException
     */
    public function update()
    {
        if ($post = input()->post()) {
            $conditions = [];

            if (count($this->fillableColumnsWithRules)) {
                $rules = new Rules($post);

$post of type O2System\Spl\DataStructures\SplArrayObject is incompatible with the type array expected by parameter $sourceVars of O2System\Security\Filters\Rules::__construct().

                $rules->sets($this->fillableColumnsWithRules);
                
                if(count($this->model->primaryKeys)) {

The property primaryKeys does not exist on O2System\Framework\Models\Files\Model. Since you implemented __get, consider adding a @property annotation.

                    foreach($this->model->primaryKeys as $primaryKey) {
                        $rules->add($primaryKey, language('LABEL_' . strtoupper($primaryKey)), 'required', 'this field cannot be empty!');

language('LABEL_' . strtoupper($primaryKey)) of type O2System\Framework\Services\Language|O2System\Kernel\Services\Language is incompatible with the type string expected by parameter $label of O2System\Security\Filters\Rules::add().

'this field cannot be empty!' of type string is incompatible with the type array expected by parameter $messages of O2System\Security\Filters\Rules::add().

                    }
                } else {
                    $primaryKey = empty($this->model->primaryKey) ? 'id' : $this->model->primaryKey;
                    $conditions = [$primaryKey => $post->offsetGet($primaryKey)];
                    $rules->add($primaryKey, language('LABEL_' . strtoupper($primaryKey)), 'required', 'this field cannot be empty!');
                }

                if ( ! $rules->validate()) {
                    $this->sendError(400, implode(', ', $rules->displayErrors(true)));

It seems like $rules->displayErrors(true) can also be of type string; however, parameter $pieces of implode() does only seem to accept array, maybe add an additional type check?

The call to O2System\Security\Filters\Rules::displayErrors() has too many arguments starting with true.

                }
            }

            if ( ! $this->model instanceof Model) {
                $this->sendError(503, 'Model is not ready');
            }

            $data = [];

            if (count($this->fillableColumnsWithRules)) {
                foreach ($this->fillableColumnsWithRules as $column) {
                    if ($post->offsetExists($column[ 'field' ])) {
                        $data[ $column[ 'field' ] ] = $post->offsetGet($column[ 'field' ]);
                    }
                }
            } elseif (count($this->fillableColumns)) {
                foreach ($this->fillableColumns as $column) {
                    if ($post->offsetExists($column[ 'field' ])) {
                        $data[ $column[ 'field' ] ] = $post->offsetGet($column[ 'field' ]);
                    }
                }
            } else {
                $data = $post->getArrayCopy();
            }

            if (count($data)) {
                $data[ 'record_update_timestamp' ] = timestamp();
                $data[ 'record_update_user' ] = globals()->account->id;

The property account does not exist on O2System\Framework\Containers\Globals. Since you implemented __get, consider adding a @property annotation.

                if ($this->model->update($data, $conditions)) {
                    $this->sendError(201, 'Successful update request');
                } else {
                    $this->sendError(501, 'Failed update request');
                }
            } else {
                $this->sendError(400, 'Post parameters cannot be empty!');
            }
        } else {
            $this->sendError(400);
        }
    }

    // ------------------------------------------------------------------------

    /**
     * Restful::delete
     *
     * @throws \O2System\Spl\Exceptions\Logic\OutOfRangeException
     * @throws \O2System\Spl\Exceptions\RuntimeException
     * @throws \Psr\Cache\InvalidArgumentException
     */
    public function delete()
    {
        if ($post = input()->post()) {
            $rules = new Rules($post);

$post of type O2System\Spl\DataStructures\SplArrayObject is incompatible with the type array expected by parameter $sourceVars of O2System\Security\Filters\Rules::__construct().

            $rules->add('id', 'ID', 'required', 'ID field cannot be empty!');

'ID field cannot be empty!' of type string is incompatible with the type array expected by parameter $messages of O2System\Security\Filters\Rules::add().

            if ( ! $rules->validate()) {
                $this->sendError(400, implode(', ', $rules->getErrors()));
            }

            if ( ! $this->model instanceof Model) {
                $this->sendError(503, 'Model is not ready');
            }

            if ($this->model->delete($post->id)) {
                $this->sendError(201, 'Successful delete request');
            } else {
                $this->sendError(501, 'Failed delete request');
            }
        } else {
            $this->sendError(400);
        }
    }

    // ------------------------------------------------------------------------

    /**
     * Restful::publish
     *
     * @throws OutOfRangeException
     */
    public function publish()
    {
        if ($post = input()->post()) {
            $rules = new Rules($post);

$post of type O2System\Spl\DataStructures\SplArrayObject is incompatible with the type array expected by parameter $sourceVars of O2System\Security\Filters\Rules::__construct().

            $rules->add('id', 'ID', 'required', 'ID field cannot be empty!');

'ID field cannot be empty!' of type string is incompatible with the type array expected by parameter $messages of O2System\Security\Filters\Rules::add().

            if ( ! $rules->validate()) {
                $this->sendError(400, implode(', ', $rules->getErrors()));
            }

            if ( ! $this->model instanceof Model) {
                $this->sendError(503, 'Model is not ready');
            }

            if ($this->model->publish($post->id)) {
                $this->sendError(201, 'Successful publish request');
            } else {
                $this->sendError(501, 'Failed publish request');
            }
        } else {
            $this->sendError(400);
        }
    }

    // ------------------------------------------------------------------------

    /**
     * Restful::unpublish
     *
     * @throws OutOfRangeException
     */
    public function unpublish()
    {
        if ($post = input()->post()) {
            $rules = new Rules($post);

$post of type O2System\Spl\DataStructures\SplArrayObject is incompatible with the type array expected by parameter $sourceVars of O2System\Security\Filters\Rules::__construct().

            $rules->add('id', 'ID', 'required', 'ID field cannot be empty!');

'ID field cannot be empty!' of type string is incompatible with the type array expected by parameter $messages of O2System\Security\Filters\Rules::add().

            if ( ! $rules->validate()) {
                $this->sendError(400, implode(', ', $rules->getErrors()));
            }

            if ( ! $this->model instanceof Model) {
                $this->sendError(503, 'Model is not ready');
            }

            if ($this->model->unpublish($post->id)) {
                $this->sendError(201, 'Successful unpublish request');
            } else {
                $this->sendError(501, 'Failed unpublish request');
            }
        } else {
            $this->sendError(400);
        }
    }

    // ------------------------------------------------------------------------

    /**
     * Controller::archive
     *
     * @throws OutOfRangeException
     */
    public function archive()
    {
        if ($post = input()->post()) {
            $rules = new Rules($post);

$post of type O2System\Spl\DataStructures\SplArrayObject is incompatible with the type array expected by parameter $sourceVars of O2System\Security\Filters\Rules::__construct().

            $rules->add('id', 'ID', 'required', 'ID field cannot be empty!');

'ID field cannot be empty!' of type string is incompatible with the type array expected by parameter $messages of O2System\Security\Filters\Rules::add().

            if ( ! $rules->validate()) {
                $this->sendError(400, implode(', ', $rules->getErrors()));
            }

            if ( ! $this->model instanceof Model) {
                $this->sendError(503, 'Model is not ready');
            }

            if ($this->model->unpublish($post->id)) {
                $this->sendError(201, 'Successful archived request');
            } else {
                $this->sendError(501, 'Failed archived request');
            }
        } else {
            $this->sendError(400);
        }
    }
}