Issues in ElasticsearchManager.php (master) - Issues in master - akalongman/laravel-lodash - Measure and Improve Code Quality continuously with Scrutinizer

Issues (118)

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/Lodash/Elasticsearch/ElasticsearchManager.php (8 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

declare(strict_types=1);

namespace Longman\LaravelLodash\Elasticsearch;

use Elasticsearch\Client;
use InvalidArgumentException;

use function array_keys;
use function implode;
use function reset;

class ElasticsearchManager implements ElasticsearchManagerContract
{
    /** @var \Elasticsearch\Client */
    protected $client;

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

    /** @var int|null */
    protected $timeout;

    public function __construct(Client $client, bool $enabled = false)
    {
        $this->client = $client;
        $this->enabled = $enabled;
    }

    public function setEnabled(bool $enabled): ElasticsearchManagerContract
    {
        $this->enabled = $enabled;

        return $this;
    }

    public function setTimeout(int $timeout): ElasticsearchManagerContract
    {
        $this->timeout = $timeout;

        return $this;
    }

    public function createIndex(string $indexName, array $settings, array $mappings): void
    {
        if (! $this->isEnabled()) {
            return;
        }

        $params = [
            'index' => $indexName,
            'body'  => [
                'settings' => $settings,
                'mappings' => $mappings,
            ],
        ];

        if (! empty($this->timeout)) {
            $params['client'] = [
                'timeout' => $this->timeout,
            ];
        }

        $response = $this->client->indices()->create($params);

        if ($response['acknowledged'] !== true) {
            throw new ElasticsearchException('Something went wrong during index creation');
        }
    }

    public function deleteIndexes(array $names): void
    {
        if (! $this->isEnabled()) {
            return;
        }
        if (empty($names)) {
            throw new InvalidArgumentException('Index names can not be empty');
        }

        $params = [
            'index' => implode(',', $names),
        ];

        if (! empty($this->timeout)) {
            $params['client'] = [
                'timeout' => $this->timeout,
            ];
        }

        $response = $this->client->indices()->delete($params);
        if ($response['acknowledged'] !== true) {
            throw new ElasticsearchException('Something went wrong during index deletion');
        }
    }

    public function deleteIndexesByAlias(string $aliasName): void
    {
        if (! $this->isEnabled()) {
            return;
        }

        $params = [
            'name' => $aliasName,
        ];

        $response = $this->client->indices()->getAlias($params);
        if (empty($response)) {
            throw new ElasticsearchException('Can not get alias ' . $aliasName);
        }

        $indexes = array_keys($response);
        $this->deleteIndexes($indexes);
    }

    /**
     * @throws \Longman\LaravelLodash\Elasticsearch\ElasticsearchException
     */
    public function addDocumentsToIndex(string $indexName, string $typeName, array $items)

    {
        if (! $this->isEnabled()) {
            return;
        }

        $params = [
            'body' => [],
        ];

        if (! empty($this->timeout)) {
            $params['client'] = [
                'timeout' => $this->timeout,
            ];
        }

        foreach ($items as $id => $item) {
            $params['body'][] = [
                'create' => [
                    '_index' => $indexName,
                    '_type'  => $typeName,
                    '_id'    => $id,
                ],
            ];

            $params['body'][] = $item;
        }

        $responses = $this->client->bulk($params);
        if ($responses['errors'] !== true) {
            return;
        }

        $this->handleBulkError($responses, 'Error occurred during bulk create');
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
    }

    /**
     * @throws \Longman\LaravelLodash\Elasticsearch\ElasticsearchException
     */
    public function updateDocumentsInIndex(string $indexName, string $typeName, array $items)

    {
        if (! $this->isEnabled()) {
            return;
        }

        $params = [
            'body' => [],
        ];

        if (! empty($this->timeout)) {
            $params['client'] = [
                'timeout' => $this->timeout,
            ];
        }

        foreach ($items as $id => $item) {
            $params['body'][] = [
                'update' => [
                    '_index' => $indexName,
                    '_type'  => $typeName,
                    '_id'    => $id,
                ],
            ];

            $params['body'][] = ['doc' => $item];
        }

        $responses = $this->client->bulk($params);
        if ($responses['errors'] !== true) {
            return;
        }

        $this->handleBulkError($responses, 'Error occurred during bulk update');
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
    }

    /**
     * @throws \Longman\LaravelLodash\Elasticsearch\ElasticsearchException
     */
    public function addOrUpdateDocumentsInIndex(string $indexName, string $typeName, array $items)

    {
        if (! $this->isEnabled()) {
            return;
        }

        $params = [
            'body' => [],
        ];

        if (! empty($this->timeout)) {
            $params['client'] = [
                'timeout' => $this->timeout,
            ];
        }

        foreach ($items as $id => $item) {
            $params['body'][] = [
                'index' => [
                    '_index' => $indexName,
                    '_type'  => $typeName,
                    '_id'    => $id,
                ],
            ];

            $params['body'][] = $item;
        }

        $responses = $this->client->bulk($params);
        if ($responses['errors'] !== true) {
            return;
        }

        $this->handleBulkError($responses, 'Error occurred during bulk index');
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
    }

    public function refreshIndex(string $indexName): void

    {
        if (! $this->isEnabled()) {
            return;
        }

        $params = [
            'index' => $indexName,
        ];

        if (! empty($this->timeout)) {
            $params['client'] = [
                'timeout' => $this->timeout,
            ];
        }

        $this->client->indices()->refresh($params);
    }

    public function performSearch(ElasticsearchQueryContract $query): array

    {
        if (! $this->isEnabled()) {
            return [];
        }

        $params = $query->build();
        if (! empty($this->timeout)) {
            $params['client'] = [
                'timeout' => $this->timeout,
            ];
        }

        $results = $this->client->search($params);

        return $results;
    }

    public function switchIndexAlias(string $aliasName, string $indexName): void
    {
        if (! $this->isEnabled()) {
            return;
        }

        $params = [
            'name' => $aliasName,
        ];

        $exists = $this->client->indices()->existsAlias($params);

        $actions = [];
        // If alias already exists remove from indexes
        if ($exists) {
            $params = [
                'name' => $aliasName,
            ];

            $response = $this->client->indices()->getAlias($params);
            if (empty($response)) {
                throw new ElasticsearchException('Can not get alias ' . $aliasName);
            }

            $indexes = array_keys($response);

            foreach ($indexes as $index) {
                $actions[] = [
                    'remove' => [
                        'index' => $index,
                        'alias' => $aliasName,
                    ],
                ];
            }
        }

        $actions[] = [
            'add' => [
                'index' => $indexName,
                'alias' => $aliasName,
            ],
        ];

        $params = [
            'body' => [
                'actions' => $actions,
            ],
        ];

        $response = $this->client->indices()->updateAliases($params);
        if ($response['acknowledged'] !== true) {
            throw new ElasticsearchException('Switching alias response error');
        }
    }

    public function createTemplate(string $name, array $settings): void
    {
        if (! $this->isEnabled()) {
            return;
        }

        $params = [
            'name' => $name,
            'body' => $settings,
        ];

        if (! empty($this->timeout)) {
            $params['client'] = [
                'timeout' => $this->timeout,
            ];
        }

        $response = $this->client->indices()->putTemplate($params);

        if ($response['acknowledged'] !== true) {
            throw new ElasticsearchException('Something went wrong during template creation');
        }
    }

    public function ping(): bool
    {
        if (! $this->isEnabled()) {
            return false;
        }

        return $this->client->ping();
    }

    public function getClient(): Client
    {
        return $this->client;
    }

    public function isEnabled(): bool
    {
        return $this->enabled;
    }

    /**
     * @throws \Longman\LaravelLodash\Elasticsearch\ElasticsearchException
     */
    protected function handleBulkError(array $responses, string $message)
    {
        $errors = [];
        foreach ($responses['items'] as $item) {
            $row = $item;
            $row = reset($row);
            if (empty($row['error'])) {
                continue;
            }

            $errors[] = $row['error'];
        }

        throw new ElasticsearchException($message, $errors);
    }
}


1		<?php
2
3		declare(strict_types=1);
4
5		namespace Longman\LaravelLodash\Elasticsearch;
6
7		use Elasticsearch\Client;
8		use InvalidArgumentException;
9
10		use function array_keys;
11		use function implode;
12		use function reset;
13
14		class ElasticsearchManager implements ElasticsearchManagerContract
15		{
16		/** @var \Elasticsearch\Client */
17		protected $client;
18
19		/** @var bool */
20		protected $enabled;
21
22		/** @var int\|null */
23		protected $timeout;
24
25		public function __construct(Client $client, bool $enabled = false)
26		{
27		$this->client = $client;
28		$this->enabled = $enabled;
29		}
30
31		public function setEnabled(bool $enabled): ElasticsearchManagerContract
32		{
33		$this->enabled = $enabled;
34
35		return $this;
36		}
37
38		public function setTimeout(int $timeout): ElasticsearchManagerContract
39		{
40		$this->timeout = $timeout;
41
42		return $this;
43		}
44
45		public function createIndex(string $indexName, array $settings, array $mappings): void
46		{
47		if (! $this->isEnabled()) {
48		return;
49		}
50
51		$params = [
52		'index' => $indexName,
53		'body' => [
54		'settings' => $settings,
55		'mappings' => $mappings,
56		],
57		];
58
59		if (! empty($this->timeout)) {
60		$params['client'] = [
61		'timeout' => $this->timeout,
62		];
63		}
64
65		$response = $this->client->indices()->create($params);
66
67		if ($response['acknowledged'] !== true) {
68		throw new ElasticsearchException('Something went wrong during index creation');
69		}
70		}
71
72		public function deleteIndexes(array $names): void
73		{
74		if (! $this->isEnabled()) {
75		return;
76		}
77		if (empty($names)) {
78		throw new InvalidArgumentException('Index names can not be empty');
79		}
80
81		$params = [
82		'index' => implode(',', $names),
83		];
84
85		if (! empty($this->timeout)) {
86		$params['client'] = [
87		'timeout' => $this->timeout,
88		];
89		}
90
91		$response = $this->client->indices()->delete($params);
92		if ($response['acknowledged'] !== true) {
93		throw new ElasticsearchException('Something went wrong during index deletion');
94		}
95		}
96
97		public function deleteIndexesByAlias(string $aliasName): void
98		{
99		if (! $this->isEnabled()) {
100		return;
101		}
102
103		$params = [
104		'name' => $aliasName,
105		];
106
107		$response = $this->client->indices()->getAlias($params);
108		if (empty($response)) {
109		throw new ElasticsearchException('Can not get alias ' . $aliasName);
110		}
111
112		$indexes = array_keys($response);
113		$this->deleteIndexes($indexes);
114		}
115
116		/**
117		* @throws \Longman\LaravelLodash\Elasticsearch\ElasticsearchException
118		*/
119	View Code Duplication	public function addDocumentsToIndex(string $indexName, string $typeName, array $items)
		0 ignored issues – show Duplication introduced 2018-04-12 10:37 UTC by Report Bug Copy Issue Report Show Similar Issues like this This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
120		{
121		if (! $this->isEnabled()) {
122		return;
123		}
124
125		$params = [
126		'body' => [],
127		];
128
129		if (! empty($this->timeout)) {
130		$params['client'] = [
131		'timeout' => $this->timeout,
132		];
133		}
134
135		foreach ($items as $id => $item) {
136		$params['body'][] = [
137		'create' => [
138		'_index' => $indexName,
139		'_type' => $typeName,
140		'_id' => $id,
141		],
142		];
143
144		$params['body'][] = $item;
145		}
146
147		$responses = $this->client->bulk($params);
148		if ($responses['errors'] !== true) {
149		return;
150		}
151
152		$this->handleBulkError($responses, 'Error occurred during bulk create');
		0 ignored issues – show Documentation introduced 2019-03-22 14:01 UTC by Report Bug Copy Issue Report Show Similar Issues like this `$responses` is of type `callable`, but the function expects a `array`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
153		}
154
155		/**
156		* @throws \Longman\LaravelLodash\Elasticsearch\ElasticsearchException
157		*/
158	View Code Duplication	public function updateDocumentsInIndex(string $indexName, string $typeName, array $items)
		0 ignored issues – show Duplication introduced 2018-04-12 10:37 UTC by Report Bug Copy Issue Report Show Similar Issues like this This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
159		{
160		if (! $this->isEnabled()) {
161		return;
162		}
163
164		$params = [
165		'body' => [],
166		];
167
168		if (! empty($this->timeout)) {
169		$params['client'] = [
170		'timeout' => $this->timeout,
171		];
172		}
173
174		foreach ($items as $id => $item) {
175		$params['body'][] = [
176		'update' => [
177		'_index' => $indexName,
178		'_type' => $typeName,
179		'_id' => $id,
180		],
181		];
182
183		$params['body'][] = ['doc' => $item];
184		}
185
186		$responses = $this->client->bulk($params);
187		if ($responses['errors'] !== true) {
188		return;
189		}
190
191		$this->handleBulkError($responses, 'Error occurred during bulk update');
		0 ignored issues – show Documentation introduced 2019-03-22 14:01 UTC by Report Bug Copy Issue Report Show Similar Issues like this `$responses` is of type `callable`, but the function expects a `array`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
192		}
193
194		/**
195		* @throws \Longman\LaravelLodash\Elasticsearch\ElasticsearchException
196		*/
197	View Code Duplication	public function addOrUpdateDocumentsInIndex(string $indexName, string $typeName, array $items)
		0 ignored issues – show Duplication introduced 2018-05-04 18:59 UTC by Report Bug Copy Issue Report Show Similar Issues like this This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
198		{
199		if (! $this->isEnabled()) {
200		return;
201		}
202
203		$params = [
204		'body' => [],
205		];
206
207		if (! empty($this->timeout)) {
208		$params['client'] = [
209		'timeout' => $this->timeout,
210		];
211		}
212
213		foreach ($items as $id => $item) {
214		$params['body'][] = [
215		'index' => [
216		'_index' => $indexName,
217		'_type' => $typeName,
218		'_id' => $id,
219		],
220		];
221
222		$params['body'][] = $item;
223		}
224
225		$responses = $this->client->bulk($params);
226		if ($responses['errors'] !== true) {
227		return;
228		}
229
230		$this->handleBulkError($responses, 'Error occurred during bulk index');
		0 ignored issues – show Documentation introduced 2019-03-22 14:01 UTC by Report Bug Copy Issue Report Show Similar Issues like this `$responses` is of type `callable`, but the function expects a `array`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
231		}
232
233	View Code Duplication	public function refreshIndex(string $indexName): void
		0 ignored issues – show Duplication introduced 2018-04-11 18:18 UTC by Report Bug Copy Issue Report Show Similar Issues like this This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
234		{
235		if (! $this->isEnabled()) {
236		return;
237		}
238
239		$params = [
240		'index' => $indexName,
241		];
242
243		if (! empty($this->timeout)) {
244		$params['client'] = [
245		'timeout' => $this->timeout,
246		];
247		}
248
249		$this->client->indices()->refresh($params);
250		}
251
252	View Code Duplication	public function performSearch(ElasticsearchQueryContract $query): array
		0 ignored issues – show Duplication introduced 2018-04-11 18:18 UTC by Report Bug Copy Issue Report Show Similar Issues like this This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
253		{
254		if (! $this->isEnabled()) {
255		return [];
256		}
257
258		$params = $query->build();
259		if (! empty($this->timeout)) {
260		$params['client'] = [
261		'timeout' => $this->timeout,
262		];
263		}
264
265		$results = $this->client->search($params);
266
267		return $results;
268		}
269
270		public function switchIndexAlias(string $aliasName, string $indexName): void
271		{
272		if (! $this->isEnabled()) {
273		return;
274		}
275
276		$params = [
277		'name' => $aliasName,
278		];
279
280		$exists = $this->client->indices()->existsAlias($params);
281
282		$actions = [];
283		// If alias already exists remove from indexes
284		if ($exists) {
285		$params = [
286		'name' => $aliasName,
287		];
288
289		$response = $this->client->indices()->getAlias($params);
290		if (empty($response)) {
291		throw new ElasticsearchException('Can not get alias ' . $aliasName);
292		}
293
294		$indexes = array_keys($response);
295
296		foreach ($indexes as $index) {
297		$actions[] = [
298		'remove' => [
299		'index' => $index,
300		'alias' => $aliasName,
301		],
302		];
303		}
304		}
305
306		$actions[] = [
307		'add' => [
308		'index' => $indexName,
309		'alias' => $aliasName,
310		],
311		];
312
313		$params = [
314		'body' => [
315		'actions' => $actions,
316		],
317		];
318
319		$response = $this->client->indices()->updateAliases($params);
320		if ($response['acknowledged'] !== true) {
321		throw new ElasticsearchException('Switching alias response error');
322		}
323		}
324
325		public function createTemplate(string $name, array $settings): void
326		{
327		if (! $this->isEnabled()) {
328		return;
329		}
330
331		$params = [
332		'name' => $name,
333		'body' => $settings,
334		];
335
336		if (! empty($this->timeout)) {
337		$params['client'] = [
338		'timeout' => $this->timeout,
339		];
340		}
341
342		$response = $this->client->indices()->putTemplate($params);
343
344		if ($response['acknowledged'] !== true) {
345		throw new ElasticsearchException('Something went wrong during template creation');
346		}
347		}
348
349		public function ping(): bool
350		{
351		if (! $this->isEnabled()) {
352		return false;
353		}
354
355		return $this->client->ping();
356		}
357
358		public function getClient(): Client
359		{
360		return $this->client;
361		}
362
363		public function isEnabled(): bool
364		{
365		return $this->enabled;
366		}
367
368		/**
369		* @throws \Longman\LaravelLodash\Elasticsearch\ElasticsearchException
370		*/
371		protected function handleBulkError(array $responses, string $message)
372		{
373		$errors = [];
374		foreach ($responses['items'] as $item) {
375		$row = $item;
376		$row = reset($row);
377		if (empty($row['error'])) {
378		continue;
379		}
380
381		$errors[] = $row['error'];
382		}
383
384		throw new ElasticsearchException($message, $errors);
385		}
386		}
387

akalongman / laravel-lodash

Issues (118)

Security Analysis not enabled

src/Lodash/Elasticsearch/ElasticsearchManager.php (8 issues)

Labels

Severity

Introduced By

Upgrade to new PHP Analysis Engine

Duplication Side-by-Side

Filter issues like