Issues in IndexService.php (master) - Issues in master - ongr-io/ElasticsearchBundle - Measure and Improve Code Quality continuously with Scrutinizer

Issues (36)

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.

Service/IndexService.php (11 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

/*
 * This file is part of the ONGR package.
 *
 * (c) NFQ Technologies UAB <[email protected]>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace ONGR\ElasticsearchBundle\Service;

use Elasticsearch\Client;
use Elasticsearch\ClientBuilder;
use ONGR\ElasticsearchBundle\Event\BulkEvent;
use ONGR\ElasticsearchBundle\Event\CommitEvent;
use ONGR\ElasticsearchBundle\Event\Events;
use ONGR\ElasticsearchBundle\Event\PostCreateClientEvent;
use ONGR\ElasticsearchBundle\Exception\BulkWithErrorsException;
use ONGR\ElasticsearchBundle\Mapping\Converter;
use ONGR\ElasticsearchBundle\Mapping\IndexSettings;
use ONGR\ElasticsearchBundle\Result\ArrayIterator;
use ONGR\ElasticsearchBundle\Result\RawIterator;
use ONGR\ElasticsearchDSL\Query\TermLevel\IdsQuery;
use ONGR\ElasticsearchDSL\Query\TermLevel\TermQuery;
use ONGR\ElasticsearchDSL\Search;
use ONGR\ElasticsearchDSL\Sort\FieldSort;
use ONGR\ElasticsearchBundle\Result\DocumentIterator;
use Symfony\Component\EventDispatcher\EventDispatcherInterface;

class IndexService
{
    private $client;
    private $namespace;
    private $converter;
    private $eventDispatcher;

    private $stopwatch;
    private $bulkCommitSize = 100;
    private $bulkQueries = [];
    private $indexSettings = [];
    private $tracer;

    public function __construct(
        string $namespace,
        Converter $converter,
        EventDispatcherInterface $eventDispatcher,
        IndexSettings $indexSettings,
        $tracer = null
    ) {
        $this->namespace = $namespace;
        $this->converter = $converter;
        $this->eventDispatcher = $eventDispatcher;
        $this->indexSettings = $indexSettings;

        $this->tracer = $tracer;
        $this->getClient();
    }

    public function getNamespace(): string
    {
        return $this->namespace;
    }

    public function getIndexSettings()
    {
        return $this->indexSettings;
    }

    public function setIndexSettings($indexSettings): self
    {
        $this->indexSettings = $indexSettings;
        return $this;
    }

    public function getClient(): Client
    {
        if (!$this->client) {
            $client = ClientBuilder::create();
            $client->setHosts($this->indexSettings->getHosts());

            $this->tracer && $client->setTracer($this->tracer);
//            $client->setLogger()

            $this->eventDispatcher->dispatch(
                new PostCreateClientEvent($this->namespace, $client),
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
                Events::POST_CLIENT_CREATE
            );
            $this->client = $client->build();
        }
        return $this->client;
    }

    public function getIndexName(): string
    {
        return $this->indexSettings->getIndexName();

    }

    public function getEventDispatcher(): EventDispatcherInterface
    {
        return $this->eventDispatcher;
    }

    public function getConverter(): Converter
    {
        return $this->converter;
    }

    public function getBulkCommitSize(): int
    {
        return $this->bulkCommitSize;
    }

    public function setBulkCommitSize(int $bulkCommitSize)
    {
        $this->bulkCommitSize = $bulkCommitSize;
        return $this;
    }

    public function getStopwatch()
    {
        return $this->stopwatch;
    }

    public function setStopwatch($stopwatch)
    {
        $this->stopwatch = $stopwatch;
        return $this;
    }

    public function createIndex($noMapping = false, $params = []): array
    {
        $params = array_merge([
            'index' => $this->getIndexName(),
            'body' => $noMapping ? [] : $this->indexSettings->getIndexMetadata(),

        ], $params);

        #TODO Add event here.

        return $this->getClient()->indices()->create(array_filter($params));
    }

    public function dropIndex(): array
    {
        $indexName = $this->getIndexName();

        if ($this->getClient()->indices()->existsAlias(['name' => $this->getIndexName()])) {
            $aliases = $this->getClient()->indices()->getAlias(['name' => $this->getIndexName()]);
            $indexName = array_keys($aliases);
        }

        return $this->getClient()->indices()->delete(['index' => $indexName]);
    }

    public function dropAndCreateIndex($noMapping = false, $params = []): array
    {
        try {
            if ($this->indexExists()) {
                $this->dropIndex();
            }
        } catch (\Exception $e) {
            // Do nothing, our target is to create the new index.
        }

        return $this->createIndex($noMapping, $params);
    }

    public function indexExists(): bool
    {
        return $this->getClient()->indices()->exists(['index' => $this->getIndexName()]);
    }

    public function clearCache(): array
    {
        return $this->getClient()->indices()->clearCache(['index' => $this->getIndexName()]);
    }

    /**
     * Returns a single document by provided ID or null if a document was not found.
     */
    public function find($id, $params = [])
    {
        $requestParams = [
            'index' => $this->getIndexName(),
            'id' => $id,
        ];

        $requestParams = array_merge($requestParams, $params);

        $result = $this->getClient()->get($requestParams);

        if (!$result['found']) {
            return null;
        }

        $result['_source']['_id'] = $result['_id'];

        return $this->converter->convertArrayToDocument($this->namespace, $result['_source']);
    }

    public function findByIds(array $ids): DocumentIterator
    {
        $search = $this->createSearch();
        $search->addQuery(new IdsQuery($ids));

        return $this->findDocuments($search);
    }

    /**
     * Finds documents by a set of criteria.
     *
     * @param array      $criteria   Example: ['group' => ['best', 'worst'], 'job' => 'medic'].
     * @param array|null $orderBy    Example: ['name' => 'ASC', 'surname' => 'DESC'].
     * @param int|null   $limit      Default is 10.
     * @param int|null   $offset     Default is 0.
     *
     * @return array|DocumentIterator The objects.
     */
    public function findBy(
        array $criteria,
        array $orderBy = [],
        int $limit = 10,
        int $offset = 0
    ) {
        $search = $this->createSearch();
        $search->setSize($limit);
        $search->setFrom($offset);

        foreach ($criteria as $field => $value) {
            $search->addQuery(new TermQuery($field, $value));
        }

        foreach ($orderBy as $field => $direction) {
            $search->addSort(new FieldSort($field, $direction));
        }

        return $this->findDocuments($search);
    }

    /**
     * Finds a single document by a set of criteria.
     *
     * @param array      $criteria   Example: ['group' => ['best', 'worst'], 'job' => 'medic'].
     * @param array|null $orderBy    Example: ['name' => 'ASC', 'surname' => 'DESC'].
     *
     * @return object|null The object.
     */
    public function findOneBy(array $criteria, array $orderBy = [])
    {
        return $this->findBy($criteria, $orderBy, 1)->current();
    }

    public function createSearch(): Search
    {
        return new Search();
    }

    public function getScrollConfiguration($raw, $scrollDuration): array
    {
        $scrollConfig = [];
        if (isset($raw['_scroll_id'])) {
            $scrollConfig['_scroll_id'] = $raw['_scroll_id'];
            $scrollConfig['duration'] = $scrollDuration;
        }

        return $scrollConfig;
    }

    public function findDocuments(Search $search): DocumentIterator

    {
        $results = $this->executeSearch($search);

        return new DocumentIterator(
            $results,
            $this,
            $this->converter,
            $this->getScrollConfiguration($results, $search->getScroll())
        );
    }

    public function findArray(Search $search): ArrayIterator

    {
        $results = $this->executeSearch($search);

        return new ArrayIterator(
            $results,
            $this,
            $this->converter,
            $this->getScrollConfiguration($results, $search->getScroll())
        );
    }

    public function findRaw(Search $search): RawIterator

    {
        $results = $this->executeSearch($search);

        return new RawIterator(
            $results,
            $this,
            $this->converter,
            $this->getScrollConfiguration($results, $search->getScroll())
        );
    }

    private function executeSearch(Search $search): array
    {
        return $this->search($search->toArray(), $search->getUriParams());
    }

    public function getIndexDocumentCount(): int
    {
        $body = [
            'index' => $this->getIndexName(),
            'body' => [],
        ];

        $results = $this->getClient()->count($body);

        return $results['count'];
    }

    public function remove($id, $routing = null)
    {
        $params = [
            'index' => $this->getIndexName(),
            'id' => $id,
        ];

        if ($routing) {
            $params['routing'] = $routing;
        }

        $response = $this->getClient()->delete($params);

        return $response;
    }

    public function update($id, array $fields = [], $script = null, array $params = []): array
    {
        $body = array_filter(
            [
                'doc' => $fields,
                'script' => $script,
            ]
        );

        $params = array_merge(
            [
                'id' => $id,
                'index' => $this->getIndexName(),
                'body' => $body,
            ],
            $params
        );

        return $this->getClient()->update($params);
    }

    public function search(array $query, array $params = []): array
    {
        $requestParams = [
            'index' => $this->getIndexName(),
            'body' => $query,
        ];


        if (!empty($params)) {
            $requestParams = array_merge($requestParams, $params);
        }

//        $this->stopwatch('start', 'search');
        $result = $this->getClient()->search($requestParams);
//        $this->stopwatch('stop', 'search');

        return $result;
    }

    /**
     * Usage example
     *
     * $im->bulk('index', ['_id' => 1, 'title' => 'foo']);
     * $im->bulk('delete', ['_id' => 2]);
     * $im->bulk('create', ['title' => 'foo']);
     */
    public function bulk(string $operation, array $data = [], $autoCommit = true): array
    {
        $bulkParams = [
            '_id' => $data['_id'] ?? null,
        ];

        unset($data['_index'], $data['_id']);

        $this->eventDispatcher->dispatch(
            new BulkEvent($operation, $bulkParams, $data),
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
            Events::BULK
        );

        $this->bulkQueries[] = [ $operation => $bulkParams];

        if (!empty($data)) {
            $this->bulkQueries[] = $data;
        }

        $response = [];

        // %X is not very accurate, but might be better than use counter. This place is experimental for now.
        if ($autoCommit && $this->getBulkCommitSize() <= count($this->bulkQueries) % $this->getBulkCommitSize() / 2) {
            $response = $this->commit();
        }

        return $response;
    }

    /**
     * Adds document to next flush.
     *
     * @param object $document
     */
    public function persist($document): void
    {
        $documentArray = array_filter($this->converter->convertDocumentToArray($document), function ($val) {
            // remove unset properties but keep other falsy values
            return !($val === null);
        });

        $this->bulk('index', $documentArray);
    }

    public function commit($commitMode = 'refresh', array $params = []): array
    {
        $bulkResponse = [];
        if (!empty($this->bulkQueries)) {
            $this->eventDispatcher->dispatch(
                new CommitEvent($commitMode, $this->bulkQueries, []),
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
                Events::PRE_COMMIT
            );

//            $this->stopwatch('start', 'bulk');
            $bulkResponse = $this->client->bulk(
                array_merge(
                    [
                    'index' => $this->getIndexName(),
                    'body' => $this->bulkQueries,
                    ],
                    $params
                )
            );
//            $this->stopwatch('stop', 'bulk');

            if ($bulkResponse['errors']) {
                throw new BulkWithErrorsException(
                    json_encode($bulkResponse),
                    0,
                    null,
                    $bulkResponse
                );
            }

//            $this->stopwatch('start', 'refresh');
            switch ($commitMode) {
                case 'flush':
                    $this->getClient()->indices()->flush();
                    break;
                case 'flush_synced':
                    $this->getClient()->indices()->flushSynced();
                    break;
                case 'refresh':
                    $this->getClient()->indices()->refresh();
                    break;
            }

            $this->eventDispatcher->dispatch(
                new CommitEvent($commitMode, $this->bulkQueries, $bulkResponse),
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
                Events::POST_COMMIT
            );

            $this->bulkQueries = [];

//            $this->stopwatch('stop', $this->getCommitMode());
        }

        return $bulkResponse;
    }

    public function flush(array $params = []): array
    {
        return $this->client->indices()->flush(array_merge(['index' => $this->getIndexName()], $params));
    }

    public function refresh(array $params = []): array
    {
        return $this->client->indices()->refresh(array_merge(['index' => $this->getIndexName()], $params));
    }

    public function scroll($scrollId, $scrollDuration = '5m'): array
    {
        $results = $this->getClient()->scroll(['scroll_id' => $scrollId, 'scroll' => $scrollDuration]);

        return $results;
    }

    public function clearScroll($scrollId): array
    {
        return $this->getClient()->clearScroll(['scroll_id' => $scrollId]);
    }

    public function resetClient(): void
    {
        $this->client = null;
    }

    public function clearElasticIndexCache(): array
    {
        return $this->getClient()->indices()->clearCache(['index' => $this->getIndexName()]);
    }

    private function stopwatch($action, $name): void
    {
        if ($this->stopwatch && ($action == 'start' || $action == 'stop')) {
            $this->stopwatch->$action('ongr_es: '.$name, 'ongr_es');
        }
    }
}


1		<?php
2
3		/*
4		* This file is part of the ONGR package.
5		*
6		* (c) NFQ Technologies UAB <[email protected]>
7		*
8		* For the full copyright and license information, please view the LICENSE
9		* file that was distributed with this source code.
10		*/
11
12		namespace ONGR\ElasticsearchBundle\Service;
13
14		use Elasticsearch\Client;
15		use Elasticsearch\ClientBuilder;
16		use ONGR\ElasticsearchBundle\Event\BulkEvent;
17		use ONGR\ElasticsearchBundle\Event\CommitEvent;
18		use ONGR\ElasticsearchBundle\Event\Events;
19		use ONGR\ElasticsearchBundle\Event\PostCreateClientEvent;
20		use ONGR\ElasticsearchBundle\Exception\BulkWithErrorsException;
21		use ONGR\ElasticsearchBundle\Mapping\Converter;
22		use ONGR\ElasticsearchBundle\Mapping\IndexSettings;
23		use ONGR\ElasticsearchBundle\Result\ArrayIterator;
24		use ONGR\ElasticsearchBundle\Result\RawIterator;
25		use ONGR\ElasticsearchDSL\Query\TermLevel\IdsQuery;
26		use ONGR\ElasticsearchDSL\Query\TermLevel\TermQuery;
27		use ONGR\ElasticsearchDSL\Search;
28		use ONGR\ElasticsearchDSL\Sort\FieldSort;
29		use ONGR\ElasticsearchBundle\Result\DocumentIterator;
30		use Symfony\Component\EventDispatcher\EventDispatcherInterface;
31
32		class IndexService
33		{
34		private $client;
35		private $namespace;
36		private $converter;
37		private $eventDispatcher;
38
39		private $stopwatch;
40		private $bulkCommitSize = 100;
41		private $bulkQueries = [];
42		private $indexSettings = [];
43		private $tracer;
44
45		public function __construct(
46		string $namespace,
47		Converter $converter,
48		EventDispatcherInterface $eventDispatcher,
49		IndexSettings $indexSettings,
50		$tracer = null
51		) {
52		$this->namespace = $namespace;
53		$this->converter = $converter;
54		$this->eventDispatcher = $eventDispatcher;
55		$this->indexSettings = $indexSettings;
		0 ignored issues – show Documentation Bug introduced 2019-04-22 06:57 UTC by Report Bug Copy Issue Report Show Similar Issues like this It seems like `$indexSettings` of type `object<ONGR\Elasticsearc...\Mapping\IndexSettings>` is incompatible with the declared type `array` of property `$indexSettings`. Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property. Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property.. Loading history...
56		$this->tracer = $tracer;
57		$this->getClient();
58		}
59
60		public function getNamespace(): string
61		{
62		return $this->namespace;
63		}
64
65		public function getIndexSettings()
66		{
67		return $this->indexSettings;
68		}
69
70		public function setIndexSettings($indexSettings): self
71		{
72		$this->indexSettings = $indexSettings;
73		return $this;
74		}
75
76		public function getClient(): Client
77		{
78		if (!$this->client) {
79		$client = ClientBuilder::create();
80		$client->setHosts($this->indexSettings->getHosts());
		0 ignored issues – show Bug introduced 2019-04-22 06:57 UTC by Report Bug Copy Issue Report Show Similar Issues like this The method `getHosts` cannot be called on `$this->indexSettings` (of type `array`). Methods can only be called on objects. This check looks for methods being called on variables that have been inferred to never be objects. Loading history...
81		$this->tracer && $client->setTracer($this->tracer);
82		// $client->setLogger()
83
84		$this->eventDispatcher->dispatch(
85		new PostCreateClientEvent($this->namespace, $client),
		0 ignored issues – show Documentation introduced 2020-02-05 16:45 UTC by Report Bug Copy Issue Report Show Similar Issues like this `new \ONGR\ElasticsearchB...is->namespace, $client)` is of type `object<ONGR\Elasticsearc...\PostCreateClientEvent>`, but the function expects a `object<Symfony\Contracts\EventDispatcher\object>`. 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...
86		Events::POST_CLIENT_CREATE
87		);
88		$this->client = $client->build();
89		}
90		return $this->client;
91		}
92
93		public function getIndexName(): string
94		{
95		return $this->indexSettings->getIndexName();
		0 ignored issues – show Bug introduced 2019-04-22 06:57 UTC by Report Bug Copy Issue Report Show Similar Issues like this The method `getIndexName` cannot be called on `$this->indexSettings` (of type `array`). Methods can only be called on objects. This check looks for methods being called on variables that have been inferred to never be objects. Loading history...
96		}
97
98		public function getEventDispatcher(): EventDispatcherInterface
99		{
100		return $this->eventDispatcher;
101		}
102
103		public function getConverter(): Converter
104		{
105		return $this->converter;
106		}
107
108		public function getBulkCommitSize(): int
109		{
110		return $this->bulkCommitSize;
111		}
112
113		public function setBulkCommitSize(int $bulkCommitSize)
114		{
115		$this->bulkCommitSize = $bulkCommitSize;
116		return $this;
117		}
118
119		public function getStopwatch()
120		{
121		return $this->stopwatch;
122		}
123
124		public function setStopwatch($stopwatch)
125		{
126		$this->stopwatch = $stopwatch;
127		return $this;
128		}
129
130		public function createIndex($noMapping = false, $params = []): array
131		{
132		$params = array_merge([
133		'index' => $this->getIndexName(),
134		'body' => $noMapping ? [] : $this->indexSettings->getIndexMetadata(),
		0 ignored issues – show Bug introduced 2019-04-22 06:57 UTC by Report Bug Copy Issue Report Show Similar Issues like this The method `getIndexMetadata` cannot be called on `$this->indexSettings` (of type `array`). Methods can only be called on objects. This check looks for methods being called on variables that have been inferred to never be objects. Loading history...
135		], $params);
136
137		#TODO Add event here.
138
139		return $this->getClient()->indices()->create(array_filter($params));
140		}
141
142		public function dropIndex(): array
143		{
144		$indexName = $this->getIndexName();
145
146		if ($this->getClient()->indices()->existsAlias(['name' => $this->getIndexName()])) {
147		$aliases = $this->getClient()->indices()->getAlias(['name' => $this->getIndexName()]);
148		$indexName = array_keys($aliases);
149		}
150
151		return $this->getClient()->indices()->delete(['index' => $indexName]);
152		}
153
154		public function dropAndCreateIndex($noMapping = false, $params = []): array
155		{
156		try {
157		if ($this->indexExists()) {
158		$this->dropIndex();
159		}
160		} catch (\Exception $e) {
161		// Do nothing, our target is to create the new index.
162		}
163
164		return $this->createIndex($noMapping, $params);
165		}
166
167		public function indexExists(): bool
168		{
169		return $this->getClient()->indices()->exists(['index' => $this->getIndexName()]);
170		}
171
172		public function clearCache(): array
173		{
174		return $this->getClient()->indices()->clearCache(['index' => $this->getIndexName()]);
175		}
176
177		/**
178		* Returns a single document by provided ID or null if a document was not found.
179		*/
180		public function find($id, $params = [])
181		{
182		$requestParams = [
183		'index' => $this->getIndexName(),
184		'id' => $id,
185		];
186
187		$requestParams = array_merge($requestParams, $params);
188
189		$result = $this->getClient()->get($requestParams);
190
191		if (!$result['found']) {
192		return null;
193		}
194
195		$result['_source']['_id'] = $result['_id'];
196
197		return $this->converter->convertArrayToDocument($this->namespace, $result['_source']);
198		}
199
200		public function findByIds(array $ids): DocumentIterator
201		{
202		$search = $this->createSearch();
203		$search->addQuery(new IdsQuery($ids));
204
205		return $this->findDocuments($search);
206		}
207
208		/**
209		* Finds documents by a set of criteria.
210		*
211		* @param array $criteria Example: ['group' => ['best', 'worst'], 'job' => 'medic'].
212		* @param array\|null $orderBy Example: ['name' => 'ASC', 'surname' => 'DESC'].
213		* @param int\|null $limit Default is 10.
214		* @param int\|null $offset Default is 0.
215		*
216		* @return array\|DocumentIterator The objects.
217		*/
218		public function findBy(
219		array $criteria,
220		array $orderBy = [],
221		int $limit = 10,
222		int $offset = 0
223		) {
224		$search = $this->createSearch();
225		$search->setSize($limit);
226		$search->setFrom($offset);
227
228		foreach ($criteria as $field => $value) {
229		$search->addQuery(new TermQuery($field, $value));
230		}
231
232		foreach ($orderBy as $field => $direction) {
233		$search->addSort(new FieldSort($field, $direction));
234		}
235
236		return $this->findDocuments($search);
237		}
238
239		/**
240		* Finds a single document by a set of criteria.
241		*
242		* @param array $criteria Example: ['group' => ['best', 'worst'], 'job' => 'medic'].
243		* @param array\|null $orderBy Example: ['name' => 'ASC', 'surname' => 'DESC'].
244		*
245		* @return object\|null The object.
246		*/
247		public function findOneBy(array $criteria, array $orderBy = [])
248		{
249		return $this->findBy($criteria, $orderBy, 1)->current();
250		}
251
252		public function createSearch(): Search
253		{
254		return new Search();
255		}
256
257		public function getScrollConfiguration($raw, $scrollDuration): array
258		{
259		$scrollConfig = [];
260		if (isset($raw['_scroll_id'])) {
261		$scrollConfig['_scroll_id'] = $raw['_scroll_id'];
262		$scrollConfig['duration'] = $scrollDuration;
263		}
264
265		return $scrollConfig;
266		}
267
268	View Code Duplication	public function findDocuments(Search $search): DocumentIterator
		0 ignored issues – show Duplication introduced 2018-05-03 13:52 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...
269		{
270		$results = $this->executeSearch($search);
271
272		return new DocumentIterator(
273		$results,
274		$this,
275		$this->converter,
276		$this->getScrollConfiguration($results, $search->getScroll())
277		);
278		}
279
280	View Code Duplication	public function findArray(Search $search): ArrayIterator
		0 ignored issues – show Duplication introduced 2018-05-03 13:52 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...
281		{
282		$results = $this->executeSearch($search);
283
284		return new ArrayIterator(
285		$results,
286		$this,
287		$this->converter,
288		$this->getScrollConfiguration($results, $search->getScroll())
289		);
290		}
291
292	View Code Duplication	public function findRaw(Search $search): RawIterator
		0 ignored issues – show Duplication introduced 2018-05-03 13:52 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...
293		{
294		$results = $this->executeSearch($search);
295
296		return new RawIterator(
297		$results,
298		$this,
299		$this->converter,
300		$this->getScrollConfiguration($results, $search->getScroll())
301		);
302		}
303
304		private function executeSearch(Search $search): array
305		{
306		return $this->search($search->toArray(), $search->getUriParams());
307		}
308
309		public function getIndexDocumentCount(): int
310		{
311		$body = [
312		'index' => $this->getIndexName(),
313		'body' => [],
314		];
315
316		$results = $this->getClient()->count($body);
317
318		return $results['count'];
319		}
320
321		public function remove($id, $routing = null)
322		{
323		$params = [
324		'index' => $this->getIndexName(),
325		'id' => $id,
326		];
327
328		if ($routing) {
329		$params['routing'] = $routing;
330		}
331
332		$response = $this->getClient()->delete($params);
333
334		return $response;
335		}
336
337		public function update($id, array $fields = [], $script = null, array $params = []): array
338		{
339		$body = array_filter(
340		[
341		'doc' => $fields,
342		'script' => $script,
343		]
344		);
345
346		$params = array_merge(
347		[
348		'id' => $id,
349		'index' => $this->getIndexName(),
350		'body' => $body,
351		],
352		$params
353		);
354
355		return $this->getClient()->update($params);
356		}
357
358		public function search(array $query, array $params = []): array
359		{
360		$requestParams = [
361		'index' => $this->getIndexName(),
362		'body' => $query,
363		];
364
365
366		if (!empty($params)) {
367		$requestParams = array_merge($requestParams, $params);
368		}
369
370		// $this->stopwatch('start', 'search');
371		$result = $this->getClient()->search($requestParams);
372		// $this->stopwatch('stop', 'search');
373
374		return $result;
375		}
376
377		/**
378		* Usage example
379		*
380		* $im->bulk('index', ['_id' => 1, 'title' => 'foo']);
381		* $im->bulk('delete', ['_id' => 2]);
382		* $im->bulk('create', ['title' => 'foo']);
383		*/
384		public function bulk(string $operation, array $data = [], $autoCommit = true): array
385		{
386		$bulkParams = [
387		'_id' => $data['_id'] ?? null,
388		];
389
390		unset($data['_index'], $data['_id']);
391
392		$this->eventDispatcher->dispatch(
393		new BulkEvent($operation, $bulkParams, $data),
		0 ignored issues – show Documentation introduced 2020-02-05 16:45 UTC by Report Bug Copy Issue Report Show Similar Issues like this `new \ONGR\ElasticsearchB...on, $bulkParams, $data)` is of type `object<ONGR\ElasticsearchBundle\Event\BulkEvent>`, but the function expects a `object<Symfony\Contracts\EventDispatcher\object>`. 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...
394		Events::BULK
395		);
396
397		$this->bulkQueries[] = [ $operation => $bulkParams];
398
399		if (!empty($data)) {
400		$this->bulkQueries[] = $data;
401		}
402
403		$response = [];
404
405		// %X is not very accurate, but might be better than use counter. This place is experimental for now.
406		if ($autoCommit && $this->getBulkCommitSize() <= count($this->bulkQueries) % $this->getBulkCommitSize() / 2) {
407		$response = $this->commit();
408		}
409
410		return $response;
411		}
412
413		/**
414		* Adds document to next flush.
415		*
416		* @param object $document
417		*/
418		public function persist($document): void
419		{
420		$documentArray = array_filter($this->converter->convertDocumentToArray($document), function ($val) {
421		// remove unset properties but keep other falsy values
422		return !($val === null);
423		});
424
425		$this->bulk('index', $documentArray);
426		}
427
428		public function commit($commitMode = 'refresh', array $params = []): array
429		{
430		$bulkResponse = [];
431		if (!empty($this->bulkQueries)) {
432		$this->eventDispatcher->dispatch(
433		new CommitEvent($commitMode, $this->bulkQueries, []),
		0 ignored issues – show Documentation introduced 2020-02-05 16:45 UTC by Report Bug Copy Issue Report Show Similar Issues like this `new \ONGR\ElasticsearchB...->bulkQueries, array())` is of type `object<ONGR\Elasticsearc...ndle\Event\CommitEvent>`, but the function expects a `object<Symfony\Contracts\EventDispatcher\object>`. 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...
434		Events::PRE_COMMIT
435		);
436
437		// $this->stopwatch('start', 'bulk');
438		$bulkResponse = $this->client->bulk(
439		array_merge(
440		[
441		'index' => $this->getIndexName(),
442		'body' => $this->bulkQueries,
443		],
444		$params
445		)
446		);
447		// $this->stopwatch('stop', 'bulk');
448
449		if ($bulkResponse['errors']) {
450		throw new BulkWithErrorsException(
451		json_encode($bulkResponse),
452		0,
453		null,
454		$bulkResponse
455		);
456		}
457
458		// $this->stopwatch('start', 'refresh');
459		switch ($commitMode) {
460		case 'flush':
461		$this->getClient()->indices()->flush();
462		break;
463		case 'flush_synced':
464		$this->getClient()->indices()->flushSynced();
465		break;
466		case 'refresh':
467		$this->getClient()->indices()->refresh();
468		break;
469		}
470
471		$this->eventDispatcher->dispatch(
472		new CommitEvent($commitMode, $this->bulkQueries, $bulkResponse),
		0 ignored issues – show Documentation introduced 2020-02-05 16:45 UTC by Report Bug Copy Issue Report Show Similar Issues like this `new \ONGR\ElasticsearchB...Queries, $bulkResponse)` is of type `object<ONGR\Elasticsearc...ndle\Event\CommitEvent>`, but the function expects a `object<Symfony\Contracts\EventDispatcher\object>`. 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...
473		Events::POST_COMMIT
474		);
475
476		$this->bulkQueries = [];
477
478		// $this->stopwatch('stop', $this->getCommitMode());
479		}
480
481		return $bulkResponse;
482		}
483
484		public function flush(array $params = []): array
485		{
486		return $this->client->indices()->flush(array_merge(['index' => $this->getIndexName()], $params));
487		}
488
489		public function refresh(array $params = []): array
490		{
491		return $this->client->indices()->refresh(array_merge(['index' => $this->getIndexName()], $params));
492		}
493
494		public function scroll($scrollId, $scrollDuration = '5m'): array
495		{
496		$results = $this->getClient()->scroll(['scroll_id' => $scrollId, 'scroll' => $scrollDuration]);
497
498		return $results;
499		}
500
501		public function clearScroll($scrollId): array
502		{
503		return $this->getClient()->clearScroll(['scroll_id' => $scrollId]);
504		}
505
506		public function resetClient(): void
507		{
508		$this->client = null;
509		}
510
511		public function clearElasticIndexCache(): array
512		{
513		return $this->getClient()->indices()->clearCache(['index' => $this->getIndexName()]);
514		}
515
516		private function stopwatch($action, $name): void
517		{
518		if ($this->stopwatch && ($action == 'start' \|\| $action == 'stop')) {
519		$this->stopwatch->$action('ongr_es: '.$name, 'ongr_es');
520		}
521		}
522		}
523

ongr-io / ElasticsearchBundle

Issues (36)

Security Analysis not enabled

Service/IndexService.php (11 issues)

Labels

Severity

Introduced By

Upgrade to new PHP Analysis Engine

Duplication Side-by-Side

Filter issues like