Issues in IsSortable.php (master) - Issues in master - zbiller/laravel-sort - Measure and Improve Code Quality continuously with Scrutinizer

Issues (3)

Security Analysis not enabled

Cross-Site Scripting

Cross-Site Scripting enables an attacker to inject code into the response of a web-request that is viewed by other users. It can for example be used to bypass access controls, or even to take over other users' accounts.

File Exposure

File Exposure allows an attacker to gain access to local files that he should not be able to access. These files can for example include database credentials, or other configuration files.

File Manipulation

File Manipulation enables an attacker to write custom data to files. This potentially leads to injection of arbitrary code on the server.

Object Injection

Object Injection enables an attacker to inject an object into PHP code, and can lead to arbitrary code execution, file exposure, or file manipulation attacks.

Code Injection

Code Injection enables an attacker to execute arbitrary code on the server.

Response Splitting

Response Splitting can be used to send arbitrary responses.

File Inclusion

File Inclusion enables an attacker to inject custom files into PHP's file loading mechanism, either explicitly passed to include, or for example via PHP's auto-loading mechanism.

Command Injection

Command Injection enables an attacker to inject a shell command that is execute with the privileges of the web-server. This can be used to expose sensitive data, or gain access of your server.

SQL Injection

SQL Injection enables an attacker to execute arbitrary SQL code on your database server gaining access to user data, or manipulating user data.

XPath Injection

XPath Injection enables an attacker to modify the parts of XML document that are read. If that XML document is for example used for authentication, this can lead to further vulnerabilities similar to SQL Injection.

LDAP Injection

LDAP Injection enables an attacker to inject LDAP statements potentially granting permission to run unauthorized queries, or modify content inside the LDAP tree.

Header Injection

Other Vulnerability

This category comprises other attack vectors such as manipulating the PHP runtime, loading custom extensions, freezing the runtime, or similar.

Regex Injection

Regex Injection enables an attacker to execute arbitrary code in your PHP process.

XML Injection

XML Injection enables an attacker to read files on your local filesystem including configuration files, or can be abused to freeze your web-server process.

Variable Injection

Variable Injection enables an attacker to overwrite program variables with custom data, and can lead to further vulnerabilities.

Unfortunately, the security analysis is currently not available for your project. If you are a non-commercial open-source project, please contact support to gain access.

src/Traits/IsSortable.php (1 issue)

Labels

Bug 1

Severity

Upgrade to new PHP Analysis Engine

These results are based on our legacy PHP analysis, consider migrating to our new PHP analysis engine instead. Learn more

<?php

namespace Zbiller\Sort\Traits;

use Zbiller\Sort\Objects\Sort;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\Builder;
use Zbiller\Sort\Exceptions\SortException;
use Illuminate\Database\Eloquent\Relations\HasOne;
use Illuminate\Database\Eloquent\Relations\BelongsTo;

trait IsSortable
{
    /**
     * @var array
     */
    protected $sort = [
        /*
         * The query builder instance from the Sorted scope.
         *
         * @var Builder
         */
        'query' => null,

        /*
         * The data applying the "sorted" scope on a model.
         *
         * @var array
         */
        'data' => null,

        /*
         * The Zbiller\Sort\Objects\Sort instance.
         * This is used to get the sorting rules, just like a request.
         *
         * @var Sort
         */
        'instance' => null,

        /*
         * The field to sort by.
         *
         * @var string
         */
        'field' => Sort::DEFAULT_SORT_FIELD,

        /*
         * The direction to sort in.
         *
         * @var string
         */
        'direction' => Sort::DEFAULT_DIRECTION_FIELD,
    ];

    /**
     * The filter scope.
     * Should be called on the model when building the query.
     *
     * @param Builder $query
     * @param array $data
     * @param Sort $sort
     */
    public function scopeSorted($query, array $data, Sort $sort = null)
    {
        $this->sort['query'] = $query;
        $this->sort['data'] = $data;
        $this->sort['instance'] = $sort;

        $this->setFieldToSortBy();
        $this->setDirectionToSortIn();

        if ($this->isValidSort()) {
            $this->checkSortingDirection();

            switch ($this->sort['data'][$this->sort['direction']]) {
                case Sort::DIRECTION_RANDOM:
                    $this->sort['query']->inRandomOrder();
                    break;
                default:
                    if ($this->shouldSortByRelation()) {
                        $this->sortByRelation();
                    } else {
                        $this->sortNormally();
                    }
            }
        }
    }

    /**
     * Verify if all sorting conditions are met.
     *
     * @return bool
     */
    protected function isValidSort()
    {
        return
            isset($this->sort['data'][$this->sort['field']]) &&
            isset($this->sort['data'][$this->sort['direction']]);
    }

    /**
     * Set the sort field if an Zbiller\Sort\Objects\Sort instance has been provided as a parameter for the sorted scope.
     *
     * @return void
     */
    protected function setFieldToSortBy()
    {
        if ($this->sort['instance'] instanceof Sort) {
            $this->sort['field'] = $this->sort['instance']->field();
        }
    }

    /**
     * Set the sort direction if an Zbiller\Sort\Objects\Sort instance has been provided as a parameter for the sorted scope.
     *
     * @return void
     */
    protected function setDirectionToSortIn()
    {
        if ($this->sort['instance'] instanceof Sort) {
            $this->sort['direction'] = $this->sort['instance']->direction();
        }
    }

    /**
     * Sort model records using columns from the model's table itself.
     *
     * @return void
     */
    protected function sortNormally()
    {
        $this->sort['query']->orderBy(
            $this->sort['data'][$this->sort['field']],
            $this->sort['data'][$this->sort['direction']]
        );
    }

    /**
     * Sort model records using columns from the model relation's table.
     *
     * @return void
     */
    protected function sortByRelation()
    {
        $parts = explode('.', $this->sort['data'][$this->sort['field']]);
        $models = [];

        if (count($parts) > 2) {
            $field = array_pop($parts);
            $relations = $parts;
        } else {
            $field = array_last($parts);
            $relations = (array) array_first($parts);
        }

        foreach ($relations as $index => $relation) {
            $previousModel = $this;

            if (isset($models[$index - 1])) {
                $previousModel = $models[$index - 1];
            }

            $this->checkRelationToSortBy($previousModel, $relation);

            $models[] = $previousModel->{$relation}()->getModel();

            $modelTable = $previousModel->getTable();
            $relationTable = $previousModel->{$relation}()->getModel()->getTable();
            $foreignKey = $previousModel->{$relation}() instanceof HasOne ?
                $previousModel->{$relation}()->getForeignKeyName() :
                $previousModel->{$relation}()->getForeignKey();

            if (! $this->alreadyJoinedForSorting($relationTable)) {
                switch (get_class($previousModel->{$relation}())) {
                    case BelongsTo::class:
                        $this->sort['query']->join($relationTable, $modelTable.'.'.$foreignKey, '=', $relationTable.'.id');
                        break;
                    case HasOne::class:
                        $this->sort['query']->join($relationTable, $modelTable.'.id', '=', $relationTable.'.'.$foreignKey);
                        break;
                }
            }
        }

        $alias = implode('_', $relations).'_'.$field;

        if (isset($relationTable)) {
            $this->sort['query']->addSelect([
                $this->getTable().'.*',
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
                $relationTable.'.'.$field.' AS '.$alias,
            ]);
        }

        $this->sort['query']->orderBy(
            $alias, $this->sort['data'][$this->sort['direction']]
        );
    }

    /**
     * @return bool
     */
    protected function shouldSortByRelation()
    {
        return str_contains($this->sort['data'][$this->sort['field']], '.');
    }

    /**
     * Verify if the desired join exists already, possibly included by a global scope.
     *
     * @param string $table
     *
     * @return bool
     */
    protected function alreadyJoinedForSorting($table)
    {
        return str_contains(strtolower($this->sort['query']->toSql()), 'join `'.$table.'`');
    }

    /**
     * Verify if the direction provided matches one of the directions from:
     * Zbiller\Sort\Objects\Sort::$directions.
     *
     * @return void
     */
    protected function checkSortingDirection()
    {
        if (! in_array(strtolower($this->sort['data'][$this->sort['direction']]), array_map('strtolower', Sort::$directions))) {
            throw SortException::invalidDirectionSupplied($this->sort['data'][$this->sort['direction']]);
        }
    }

    /**
     * Verify if the desired relation to sort by is one of: HasOne or BelongsTo.
     * Sorting by "many" relations or "morph" ones is not possible.
     *
     * @param Model $model
     * @param string $relation
     */
    protected function checkRelationToSortBy(Model $model, $relation)
    {
        if (! ($model->{$relation}() instanceof HasOne) && ! ($model->{$relation}() instanceof BelongsTo)) {
            throw SortException::wrongRelationToSort($relation, get_class($model->{$relation}()));
        }
    }
}


1		<?php
2
3		namespace Zbiller\Sort\Traits;
4
5		use Zbiller\Sort\Objects\Sort;
6		use Illuminate\Database\Eloquent\Model;
7		use Illuminate\Database\Eloquent\Builder;
8		use Zbiller\Sort\Exceptions\SortException;
9		use Illuminate\Database\Eloquent\Relations\HasOne;
10		use Illuminate\Database\Eloquent\Relations\BelongsTo;
11
12		trait IsSortable
13		{
14		/**
15		* @var array
16		*/
17		protected $sort = [
18		/*
19		* The query builder instance from the Sorted scope.
20		*
21		* @var Builder
22		*/
23		'query' => null,
24
25		/*
26		* The data applying the "sorted" scope on a model.
27		*
28		* @var array
29		*/
30		'data' => null,
31
32		/*
33		* The Zbiller\Sort\Objects\Sort instance.
34		* This is used to get the sorting rules, just like a request.
35		*
36		* @var Sort
37		*/
38		'instance' => null,
39
40		/*
41		* The field to sort by.
42		*
43		* @var string
44		*/
45		'field' => Sort::DEFAULT_SORT_FIELD,
46
47		/*
48		* The direction to sort in.
49		*
50		* @var string
51		*/
52		'direction' => Sort::DEFAULT_DIRECTION_FIELD,
53		];
54
55		/**
56		* The filter scope.
57		* Should be called on the model when building the query.
58		*
59		* @param Builder $query
60		* @param array $data
61		* @param Sort $sort
62		*/
63		public function scopeSorted($query, array $data, Sort $sort = null)
64		{
65		$this->sort['query'] = $query;
66		$this->sort['data'] = $data;
67		$this->sort['instance'] = $sort;
68
69		$this->setFieldToSortBy();
70		$this->setDirectionToSortIn();
71
72		if ($this->isValidSort()) {
73		$this->checkSortingDirection();
74
75		switch ($this->sort['data'][$this->sort['direction']]) {
76		case Sort::DIRECTION_RANDOM:
77		$this->sort['query']->inRandomOrder();
78		break;
79		default:
80		if ($this->shouldSortByRelation()) {
81		$this->sortByRelation();
82		} else {
83		$this->sortNormally();
84		}
85		}
86		}
87		}
88
89		/**
90		* Verify if all sorting conditions are met.
91		*
92		* @return bool
93		*/
94		protected function isValidSort()
95		{
96		return
97		isset($this->sort['data'][$this->sort['field']]) &&
98		isset($this->sort['data'][$this->sort['direction']]);
99		}
100
101		/**
102		* Set the sort field if an Zbiller\Sort\Objects\Sort instance has been provided as a parameter for the sorted scope.
103		*
104		* @return void
105		*/
106		protected function setFieldToSortBy()
107		{
108		if ($this->sort['instance'] instanceof Sort) {
109		$this->sort['field'] = $this->sort['instance']->field();
110		}
111		}
112
113		/**
114		* Set the sort direction if an Zbiller\Sort\Objects\Sort instance has been provided as a parameter for the sorted scope.
115		*
116		* @return void
117		*/
118		protected function setDirectionToSortIn()
119		{
120		if ($this->sort['instance'] instanceof Sort) {
121		$this->sort['direction'] = $this->sort['instance']->direction();
122		}
123		}
124
125		/**
126		* Sort model records using columns from the model's table itself.
127		*
128		* @return void
129		*/
130		protected function sortNormally()
131		{
132		$this->sort['query']->orderBy(
133		$this->sort['data'][$this->sort['field']],
134		$this->sort['data'][$this->sort['direction']]
135		);
136		}
137
138		/**
139		* Sort model records using columns from the model relation's table.
140		*
141		* @return void
142		*/
143		protected function sortByRelation()
144		{
145		$parts = explode('.', $this->sort['data'][$this->sort['field']]);
146		$models = [];
147
148		if (count($parts) > 2) {
149		$field = array_pop($parts);
150		$relations = $parts;
151		} else {
152		$field = array_last($parts);
153		$relations = (array) array_first($parts);
154		}
155
156		foreach ($relations as $index => $relation) {
157		$previousModel = $this;
158
159		if (isset($models[$index - 1])) {
160		$previousModel = $models[$index - 1];
161		}
162
163		$this->checkRelationToSortBy($previousModel, $relation);
164
165		$models[] = $previousModel->{$relation}()->getModel();
166
167		$modelTable = $previousModel->getTable();
168		$relationTable = $previousModel->{$relation}()->getModel()->getTable();
169		$foreignKey = $previousModel->{$relation}() instanceof HasOne ?
170		$previousModel->{$relation}()->getForeignKeyName() :
171		$previousModel->{$relation}()->getForeignKey();
172
173		if (! $this->alreadyJoinedForSorting($relationTable)) {
174		switch (get_class($previousModel->{$relation}())) {
175	View Code Duplication	case BelongsTo::class:
176		$this->sort['query']->join($relationTable, $modelTable.'.'.$foreignKey, '=', $relationTable.'.id');
177		break;
178	View Code Duplication	case HasOne::class:
179		$this->sort['query']->join($relationTable, $modelTable.'.id', '=', $relationTable.'.'.$foreignKey);
180		break;
181		}
182		}
183		}
184
185		$alias = implode('_', $relations).'_'.$field;
186
187		if (isset($relationTable)) {
188		$this->sort['query']->addSelect([
189		$this->getTable().'.*',
		0 ignored issues – show Bug introduced 2019-01-23 22:27 UTC by Report Bug Copy Issue Report Show Similar Issues like this It seems like `getTable()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
190		$relationTable.'.'.$field.' AS '.$alias,
191		]);
192		}
193
194		$this->sort['query']->orderBy(
195		$alias, $this->sort['data'][$this->sort['direction']]
196		);
197		}
198
199		/**
200		* @return bool
201		*/
202		protected function shouldSortByRelation()
203		{
204		return str_contains($this->sort['data'][$this->sort['field']], '.');
205		}
206
207		/**
208		* Verify if the desired join exists already, possibly included by a global scope.
209		*
210		* @param string $table
211		*
212		* @return bool
213		*/
214		protected function alreadyJoinedForSorting($table)
215		{
216		return str_contains(strtolower($this->sort['query']->toSql()), 'join `'.$table.'`');
217		}
218
219		/**
220		* Verify if the direction provided matches one of the directions from:
221		* Zbiller\Sort\Objects\Sort::$directions.
222		*
223		* @return void
224		*/
225		protected function checkSortingDirection()
226		{
227		if (! in_array(strtolower($this->sort['data'][$this->sort['direction']]), array_map('strtolower', Sort::$directions))) {
228		throw SortException::invalidDirectionSupplied($this->sort['data'][$this->sort['direction']]);
229		}
230		}
231
232		/**
233		* Verify if the desired relation to sort by is one of: HasOne or BelongsTo.
234		* Sorting by "many" relations or "morph" ones is not possible.
235		*
236		* @param Model $model
237		* @param string $relation
238		*/
239		protected function checkRelationToSortBy(Model $model, $relation)
240		{
241		if (! ($model->{$relation}() instanceof HasOne) && ! ($model->{$relation}() instanceof BelongsTo)) {
242		throw SortException::wrongRelationToSort($relation, get_class($model->{$relation}()));
243		}
244		}
245		}
246

zbiller / laravel-sort

Issues (3)

Security Analysis not enabled

src/Traits/IsSortable.php (1 issue)

Labels

Severity

Introduced By

Upgrade to new PHP Analysis Engine

Duplication Side-by-Side

Filter issues like