Issues in SearchQuery.php (devel) - Issues in devel - bardex/elastic-query - Measure and Improve Code Quality continuously with Scrutinizer

Issues (13)

Security Analysis no request data

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/Bardex/Elastic/SearchQuery.php (2 issues)

Labels

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 Bardex\Elastic;

/**
 * Fluent interface for ElasticSearch
 * @package Bardex\Elastic
 */
class SearchQuery extends Query
{
    /**
     * Параметры запроса
     * @var array
     */
    protected $params = [];

    /**
     * @var Where
     */
    protected $whereHelper;


    public function __clone()
    {
        $this->whereHelper = new Where($this);
    }

    /**
     * @return SearchQuery
     */
    public function fork()
    {
        $copy = clone $this;
        return $copy;
    }

    /**
     * Установить имя индекса для поиска
     * @param $index
     * @return self $this
     */
    public function setIndex($index)
    {
        $this->params['index'] = (string)$index;
        return $this;
    }

    /**
     * Установить имя типа для поиска
     * @param $type
     * @return self $this
     */
    public function setType($type)
    {
        $this->params['type'] = (string)$type;
        return $this;
    }


    /**
     * Выводить перечисленные поля.
     * (не обязательный метод, по-умолчанию, выводятся все)
     * Методы select() и exclude() могут работать совместно.
     * @param array $fields
     * @return self $this;
     * @example $query->select(['id', 'title', 'brand.id', 'brand.title']);
     */
    public function select(array $fields)
    {
        $this->params['body']['_source']['includes'] = $fields;
        return $this;
    }


    /**
     * Добавить в результаты вычисляемое поле, на скриптовом языке painless или groovy
     * @param string $fieldName - имя поля в результатах (если такое поле уже есть в документе, то оно будет заменено)
     * @param Script $script - скрипт
     * @link https://www.elastic.co/guide/en/elasticsearch/reference/5.0/search-request-script-fields.html
     * @return self $this
     */
    public function addScriptField($fieldName, Script $script)
    {
        $this->params['body']['script_fields'][$fieldName] = $script->compile();
        return $this;
    }


    /**
     * Удалить из выборки поля.
     * (не обязательный метод, по-умолчанию, выводятся все)
     * Методы select() и exclude() могут работать совместно.
     * @param array $fields
     * @return self $this;
     * @example $query->exclude(['anons', '*.anons']);
     */
    public function exclude(array $fields)
    {
        $this->params['body']['_source']['excludes'] = $fields;
        return $this;
    }


    /**
     * Добавить фильтр в raw формате, если готовые методы фильтрации не подходят.
     *
     * @param string $type - тип фильтрации (term|terms|match|range)
     * @param $filter - фильтр
     * @link https://www.elastic.co/guide/en/elasticsearch/reference/5.0/query-dsl-terms-query.html
     * @return self $this
     */
    public function addFilter($type, $filter)
    {
        if (!isset($this->params['body']['query']['bool']['must'])) {
            $this->params['body']['query']['bool']['must'] = [];
        }
        $this->params['body']['query']['bool']['must'][] = [$type => $filter];
        return $this;
    }

    /**
     * Добавить отрицательный фильтр в raw формате, если готовые методы фильтрации не подходят.
     *
     * @param string $type - тип фильтрации (term|terms|match|range)
     * @param $filter - фильтр
     * @link https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-bool-query.html
     * @return self $this
     */
    public function addNotFilter($type, $filter)
    {
        if (!isset($this->params['body']['query']['bool']['must_not'])) {
            $this->params['body']['query']['bool']['must_not'] = [];
        }
        $this->params['body']['query']['bool']['must_not'][] = [$type => $filter];
        return $this;
    }


    /**
     * Создать фильтр.
     *
     * @param $field - поле по которому фильтруем (id, page.categoryId...)
     * @example $query->where('channel')->equal(1)->where('page.categoryId')->in([10,12]);
     * @return Where;

     */
    public function where($field)
    {
        if (null === $this->whereHelper) {
            $this->whereHelper = new Where($this);
        }
        $this->whereHelper->setField($field);
        return $this->whereHelper;
    }


    /**
     * Добавить в фильтр сложное условие с вычислениями, на скриптовом языке painless или groovy.
     * Использование параметров рекомендуется, для увеличения производительности скриптов.
     *
     * @param Script $script - скрипт
     * @return self $this;
     * @link https://www.elastic.co/guide/en/elasticsearch/reference/5.0/query-dsl-script-query.html
     * @link https://www.elastic.co/guide/en/elasticsearch/reference/5.0/modules-scripting-painless.html
     */
    public function whereScript(Script $script)
    {
        $this->addFilter('script', $script->compile());
        return $this;
    }


    /**
     * Установить поле сортировки.
     * Для сортировки по релевантности существует псевдополе _score (значение больше - релевантность лучше)
     * @param $field - поле сортировки
     * @param string $order - направление сортировки asc|desc
     * @example $query->setOrderBy('_score', 'desc');
     * @return self $this
     */
    public function setOrderBy($field, $order = 'asc')
    {
        $this->params['body']['sort'] = [];
        $this->addOrderBy($field, $order);
        return $this;
    }

    /**
     * Добавить поле сортировки.
     * Для сортировки по релевантности существует псевдополе _score (значение больше - релевантность лучше)
     * @param $field - поле сортировки
     * @param string $order - направление сортировки asc|desc
     * @example $query->addOrderBy('_score', 'desc');
     * @example $query->addOrderBy('seller.rating', 'desc');
     * @return self $this
     */
    public function addOrderBy($field, $order = 'asc')
    {
        $field = (string)$field;
        $order = (string)$order;
        if (!isset($this->params['body']['sort'])) {
            $this->params['body']['sort'] = [];
        }
        $this->params['body']['sort'][] = [$field => ['order' => $order]];
        return $this;
    }


    /**
     * Установить лимиты выборки
     * @param $limit - сколько строк выбирать
     * @param int $offset - сколько строк пропустить
     * @return self $this;
     */
    public function limit($limit, $offset = 0)
    {
        $this->params['body']['size'] = (int)$limit;
        $this->params['body']['from'] = (int)$offset;
        return $this;
    }

    /**
     * Получить собранный запрос
     * @return array
     */
    public function getQuery()
    {
        $params = $this->params;

        if (!isset($params['body']['_source'])) {
            $params['body']['_source'] = true;
        }

        return $params;
    }

    protected function executeQuery(array $query)
    {
        return $this->elastic->search($query);
class Author {
    private $name;

    public function __construct($name) {
        $this->name = $name;
    }

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}
    }
}


1		<?php namespace Bardex\Elastic;
2
3		/**
4		* Fluent interface for ElasticSearch
5		* @package Bardex\Elastic
6		*/
7		class SearchQuery extends Query
8		{
9		/**
10		* Параметры запроса
11		* @var array
12		*/
13		protected $params = [];
14
15		/**
16		* @var Where
17		*/
18		protected $whereHelper;
19
20
21		public function __clone()
22		{
23		$this->whereHelper = new Where($this);
24		}
25
26		/**
27		* @return SearchQuery
28		*/
29		public function fork()
30		{
31		$copy = clone $this;
32		return $copy;
33		}
34
35		/**
36		* Установить имя индекса для поиска
37		* @param $index
38		* @return self $this
39		*/
40		public function setIndex($index)
41		{
42		$this->params['index'] = (string)$index;
43		return $this;
44		}
45
46		/**
47		* Установить имя типа для поиска
48		* @param $type
49		* @return self $this
50		*/
51		public function setType($type)
52		{
53		$this->params['type'] = (string)$type;
54		return $this;
55		}
56
57
58		/**
59		* Выводить перечисленные поля.
60		* (не обязательный метод, по-умолчанию, выводятся все)
61		* Методы select() и exclude() могут работать совместно.
62		* @param array $fields
63		* @return self $this;
64		* @example $query->select(['id', 'title', 'brand.id', 'brand.title']);
65		*/
66		public function select(array $fields)
67		{
68		$this->params['body']['_source']['includes'] = $fields;
69		return $this;
70		}
71
72
73		/**
74		* Добавить в результаты вычисляемое поле, на скриптовом языке painless или groovy
75		* @param string $fieldName - имя поля в результатах (если такое поле уже есть в документе, то оно будет заменено)
76		* @param Script $script - скрипт
77		* @link https://www.elastic.co/guide/en/elasticsearch/reference/5.0/search-request-script-fields.html
78		* @return self $this
79		*/
80		public function addScriptField($fieldName, Script $script)
81		{
82		$this->params['body']['script_fields'][$fieldName] = $script->compile();
83		return $this;
84		}
85
86
87		/**
88		* Удалить из выборки поля.
89		* (не обязательный метод, по-умолчанию, выводятся все)
90		* Методы select() и exclude() могут работать совместно.
91		* @param array $fields
92		* @return self $this;
93		* @example $query->exclude(['anons', '*.anons']);
94		*/
95		public function exclude(array $fields)
96		{
97		$this->params['body']['_source']['excludes'] = $fields;
98		return $this;
99		}
100
101
102		/**
103		* Добавить фильтр в raw формате, если готовые методы фильтрации не подходят.
104		*
105		* @param string $type - тип фильтрации (term\|terms\|match\|range)
106		* @param $filter - фильтр
107		* @link https://www.elastic.co/guide/en/elasticsearch/reference/5.0/query-dsl-terms-query.html
108		* @return self $this
109		*/
110	View Code Duplication	public function addFilter($type, $filter)
111		{
112		if (!isset($this->params['body']['query']['bool']['must'])) {
113		$this->params['body']['query']['bool']['must'] = [];
114		}
115		$this->params['body']['query']['bool']['must'][] = [$type => $filter];
116		return $this;
117		}
118
119		/**
120		* Добавить отрицательный фильтр в raw формате, если готовые методы фильтрации не подходят.
121		*
122		* @param string $type - тип фильтрации (term\|terms\|match\|range)
123		* @param $filter - фильтр
124		* @link https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-bool-query.html
125		* @return self $this
126		*/
127	View Code Duplication	public function addNotFilter($type, $filter)
128		{
129		if (!isset($this->params['body']['query']['bool']['must_not'])) {
130		$this->params['body']['query']['bool']['must_not'] = [];
131		}
132		$this->params['body']['query']['bool']['must_not'][] = [$type => $filter];
133		return $this;
134		}
135
136
137		/**
138		* Создать фильтр.
139		*
140		* @param $field - поле по которому фильтруем (id, page.categoryId...)
141		* @example $query->where('channel')->equal(1)->where('page.categoryId')->in([10,12]);
142		* @return Where;
		0 ignored issues – show Documentation introduced 2017-06-06 18:39 UTC by Report Bug Copy Issue Report Show Similar Issues like this The doc-type `Where;` could not be parsed: Expected "\|" or "end of type", but got ";" at position 5. (view supported doc-types) This check marks PHPDoc comments that could not be parsed by our parser. To see which comment annotations we can parse, please refer to our documentation on supported doc-types. Loading history...
143		*/
144		public function where($field)
145		{
146		if (null === $this->whereHelper) {
147		$this->whereHelper = new Where($this);
148		}
149		$this->whereHelper->setField($field);
150		return $this->whereHelper;
151		}
152
153
154		/**
155		* Добавить в фильтр сложное условие с вычислениями, на скриптовом языке painless или groovy.
156		* Использование параметров рекомендуется, для увеличения производительности скриптов.
157		*
158		* @param Script $script - скрипт
159		* @return self $this;
160		* @link https://www.elastic.co/guide/en/elasticsearch/reference/5.0/query-dsl-script-query.html
161		* @link https://www.elastic.co/guide/en/elasticsearch/reference/5.0/modules-scripting-painless.html
162		*/
163		public function whereScript(Script $script)
164		{
165		$this->addFilter('script', $script->compile());
166		return $this;
167		}
168
169
170		/**
171		* Установить поле сортировки.
172		* Для сортировки по релевантности существует псевдополе _score (значение больше - релевантность лучше)
173		* @param $field - поле сортировки
174		* @param string $order - направление сортировки asc\|desc
175		* @example $query->setOrderBy('_score', 'desc');
176		* @return self $this
177		*/
178		public function setOrderBy($field, $order = 'asc')
179		{
180		$this->params['body']['sort'] = [];
181		$this->addOrderBy($field, $order);
182		return $this;
183		}
184
185		/**
186		* Добавить поле сортировки.
187		* Для сортировки по релевантности существует псевдополе _score (значение больше - релевантность лучше)
188		* @param $field - поле сортировки
189		* @param string $order - направление сортировки asc\|desc
190		* @example $query->addOrderBy('_score', 'desc');
191		* @example $query->addOrderBy('seller.rating', 'desc');
192		* @return self $this
193		*/
194		public function addOrderBy($field, $order = 'asc')
195		{
196		$field = (string)$field;
197		$order = (string)$order;
198		if (!isset($this->params['body']['sort'])) {
199		$this->params['body']['sort'] = [];
200		}
201		$this->params['body']['sort'][] = [$field => ['order' => $order]];
202		return $this;
203		}
204
205
206		/**
207		* Установить лимиты выборки
208		* @param $limit - сколько строк выбирать
209		* @param int $offset - сколько строк пропустить
210		* @return self $this;
211		*/
212		public function limit($limit, $offset = 0)
213		{
214		$this->params['body']['size'] = (int)$limit;
215		$this->params['body']['from'] = (int)$offset;
216		return $this;
217		}
218
219		/**
220		* Получить собранный запрос
221		* @return array
222		*/
223		public function getQuery()
224		{
225		$params = $this->params;
226
227		if (!isset($params['body']['_source'])) {
228		$params['body']['_source'] = true;
229		}
230
231		return $params;
232		}
233
234		protected function executeQuery(array $query)
235		{
236		return $this->elastic->search($query);
		0 ignored issues – show Bug Best Practice introduced 2017-06-05 21:19 UTC by Report Bug Copy Issue Report Show Similar Issues like this The return type of `return $this->elastic->search($query);` (`callable`) is incompatible with the return type declared by the abstract method `Bardex\Elastic\Query::executeQuery` of type `array`. If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design. Let’s take a look at an example: class Author { private $name; public function __construct($name) { $this->name = $name; } public function getName() { return $this->name; } } abstract class Post { public function getAuthor() { return 'Johannes'; } } class BlogPost extends Post { public function getAuthor() { return new Author('Johannes'); } } class ForumPost extends Post { /* ... */ } function my_function(Post $post) { echo strtoupper($post->getAuthor()); } Our function `my_function` expects a `Post` object, and outputs the author of the post. The base class `Post` returns a simple string and outputting a simple string will work just fine. However, the child class `BlogPost` which is a sub-type of `Post` instead decided to return an `object`, and is therefore violating the SOLID principles. If a `BlogPost` were passed to `my_function`, PHP would not complain, but ultimately fail when executing the `strtoupper` call in its body. Loading history...
237		}
238		}
239

bardex / elastic-query

Issues (13)

Security Analysis no request data

src/Bardex/Elastic/SearchQuery.php (2 issues)

Labels

Severity

Introduced By

Upgrade to new PHP Analysis Engine

Duplication Side-by-Side

Filter issues like