Driver::collectionExists() - Code Metrics - Inspection of "Merge pull request #623 from Geolim4/master" - PHPSocialNetwork/phpfastcache - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 4e7427...4a94bb )

by Georges

created 2018-06-24 12:51 UTC

Driver::collectionExists() A

↳ Parent: Driver

Complexity

Conditions	3
Paths	3

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	3
nc	3
nop	1
dl	0
loc	9
rs	9.9666
c	0
b	0
f	0

<?php
/**
 *
 * This file is part of phpFastCache.
 *
 * @license MIT License (MIT)
 *
 * For full copyright and license information, please see the docs/CREDITS.txt file.
 *
 * @author Khoa Bui (khoaofgod)  <[email protected]> https://www.phpfastcache.com
 * @author Georges.L (Geolim4)  <[email protected]>
 * @author Fabio Covolo Mazzo (fabiocmazzo) <[email protected]>
 *
 */
declare(strict_types=1);

namespace Phpfastcache\Drivers\Mongodb;

use LogicException;
use MongoDB\{
    BSON\Binary, BSON\UTCDateTime, Client, Collection, Database, DeleteResult, Driver\Command, Driver\Exception\Exception as MongoDBException
filter:
    dependency_paths: ["lib/*"]
};
use Phpfastcache\Core\Pool\{
    DriverBaseTrait, ExtendedCacheItemPoolInterface
};
use Phpfastcache\Entities\DriverStatistic;
use Phpfastcache\Exceptions\{
    PhpfastcacheDriverException, PhpfastcacheInvalidArgumentException
};
use Psr\Cache\CacheItemInterface;

/**
 * Class Driver
 * @package phpFastCache\Drivers
 * @property Client $instance Instance of driver service
 * @property Config $config Config object
 * @method Config getConfig() Return the config object
 */
class Driver implements ExtendedCacheItemPoolInterface
{
    const MONGODB_DEFAULT_DB_NAME = 'phpfastcache';

    use DriverBaseTrait;

    /**
     * @var Collection
     */
    public $collection;

    /**
     * @var Database
     */
    public $database;

    /**
     * @return bool
     */
    public function driverCheck(): bool
    {
        $mongoExtensionExists = class_exists(\MongoDB\Driver\Manager::class);

        if (!$mongoExtensionExists && class_exists(\MongoClient::class)) {
            \trigger_error('This driver is used to support the pecl MongoDb extension with mongo-php-library.
            For MongoDb with Mongo PECL support use Mongo Driver.', E_USER_ERROR);
        }

        return $mongoExtensionExists && class_exists(\MongoDB\Collection::class);
    }

    /**
     * @param \Psr\Cache\CacheItemInterface $item
     * @return null|array
     */
    protected function driverRead(CacheItemInterface $item)
    {
        $document = $this->getCollection()->findOne(['_id' => $item->getEncodedKey()]);

        if ($document) {
            $return = [
                self::DRIVER_DATA_WRAPPER_INDEX => $this->decode($document[self::DRIVER_DATA_WRAPPER_INDEX]->getData()),
                self::DRIVER_TAGS_WRAPPER_INDEX => $this->decode($document[self::DRIVER_TAGS_WRAPPER_INDEX]->getData()),
                self::DRIVER_EDATE_WRAPPER_INDEX => (new \DateTime())->setTimestamp($document[self::DRIVER_EDATE_WRAPPER_INDEX]->toDateTime()->getTimestamp()),
            ];

            if (!empty($this->getConfig()->isItemDetailedDate())) {
                $return += [
                    self::DRIVER_MDATE_WRAPPER_INDEX => (new \DateTime())->setTimestamp($document[self::DRIVER_MDATE_WRAPPER_INDEX]->toDateTime()
                        ->getTimestamp()),
                    self::DRIVER_CDATE_WRAPPER_INDEX => (new \DateTime())->setTimestamp($document[self::DRIVER_CDATE_WRAPPER_INDEX]->toDateTime()
                        ->getTimestamp()),
                ];
            }

            return $return;
        }

        return null;
    }

    /**
     * @param \Psr\Cache\CacheItemInterface $item
     * @return mixed
     * @throws PhpfastcacheInvalidArgumentException
     * @throws PhpfastcacheDriverException
     */
    protected function driverWrite(CacheItemInterface $item): bool
    {
        /**
         * Check for Cross-Driver type confusion
         */
        if ($item instanceof Item) {
            try {
                $set = [
                    self::DRIVER_DATA_WRAPPER_INDEX => new Binary($this->encode($item->get()), Binary::TYPE_GENERIC),
                    self::DRIVER_TAGS_WRAPPER_INDEX => new Binary($this->encode($item->getTags()), Binary::TYPE_GENERIC),
                    self::DRIVER_EDATE_WRAPPER_INDEX => ($item->getTtl() > 0 ? new UTCDateTime((\time() + $item->getTtl()) * 1000) : new UTCDateTime(\time() * 1000)),
                ];

                if (!empty($this->getConfig()->isItemDetailedDate())) {
                    $set += [
                        self::DRIVER_MDATE_WRAPPER_INDEX => ($item->getModificationDate() ? new UTCDateTime(($item->getModificationDate()
                                ->getTimestamp()) * 1000) : new UTCDateTime(\time() * 1000)),
                        self::DRIVER_CDATE_WRAPPER_INDEX => ($item->getCreationDate() ? new UTCDateTime(($item->getCreationDate()
                                ->getTimestamp()) * 1000) : new UTCDateTime(\time() * 1000)),
                    ];
                }
                $result = (array)$this->getCollection()->updateOne(
                    ['_id' => $item->getEncodedKey()],
                    [
                        '$set' => $set,
                    ],
                    ['upsert' => true, 'multiple' => false]
                );
            } catch (MongoDBException $e) {
                throw new PhpfastcacheDriverException('Got an exception while trying to write data to MongoDB server', null, $e);
            }

            return isset($result['ok']) ? $result['ok'] == 1 : true;
        }

        throw new PhpfastcacheInvalidArgumentException('Cross-Driver type confusion detected');
    }

    /**
     * @param \Psr\Cache\CacheItemInterface $item
     * @return bool
     * @throws PhpfastcacheInvalidArgumentException
     */
    protected function driverDelete(CacheItemInterface $item): bool
    {
        /**
         * Check for Cross-Driver type confusion
         */
        if ($item instanceof Item) {
            /**
             * @var DeleteResult $deletionResult
             */
            $deletionResult = $this->getCollection()->deleteOne(['_id' => $item->getEncodedKey()]);

            return $deletionResult->isAcknowledged();
        }

        throw new PhpfastcacheInvalidArgumentException('Cross-Driver type confusion detected');
    }

    /**
     * @return bool
     */
    protected function driverClear(): bool
    {
        return $this->collection->deleteMany([])->isAcknowledged();
    }

    /**
     * @return bool
     * @throws MongodbException
     * @throws LogicException
     */
    protected function driverConnect(): bool
    {
        if ($this->instance instanceof Client) {
            throw new LogicException('Already connected to Mongodb server');
        }

        $timeout = $this->getConfig()->getTimeout() * 1000;
        $collectionName = $this->getConfig()->getCollectionName();
        $databaseName = $this->getConfig()->getDatabaseName();

        $this->instance = $this->instance ?: new Client($this->buildConnectionURI($databaseName), ['connectTimeoutMS' => $timeout]);
        $this->database = $this->database ?: $this->instance->selectDatabase($databaseName);

        if (!$this->collectionExists($collectionName)) {
            $this->database->createCollection($collectionName);
        }

        $this->collection = $this->database->selectCollection($collectionName);

        return true;
    }

    /**
     * Checks if a collection name exists on the Mongo database.
     *
     * @param string $collectionName The collection name to check.
     *
     * @return bool True if the collection exists, false if not.
     */
    protected function collectionExists($collectionName): bool
    {
        foreach ($this->database->listCollections() as $collection) {
            if ($collection->getName() === $collectionName) {
                return true;
            }
        }

        return false;
    }

    /**
     * Builds the connection URI from the given parameters.
     *
     * @param string $databaseName
     * @return string The connection URI.
     */
    protected function buildConnectionURI($databaseName = ''): string
    {
        $host = $this->getConfig()->getHost();
        $port = $this->getConfig()->getPort();
        $username = $this->getConfig()->getUsername();
        $password = $this->getConfig()->getPassword();

        return implode('', [
            'mongodb://',
            ($username ?: ''),
            ($password ? ":{$password}" : ''),
            ($username ? '@' : ''),
            $host,
            ($port !== 27017 ? ":{$port}" : ''),
            ($databaseName ? "/{$databaseName}" : ''),
        ]);
    }

    /**
     * @return Collection
     */
    protected function getCollection(): Collection
    {
        return $this->collection;
    }

    /********************
     *
     * PSR-6 Extended Methods
     *
     *******************/

    /**
     * @return DriverStatistic
     */
    public function getStats(): DriverStatistic
    {
        $serverStats = $this->instance->getManager()->executeCommand('phpFastCache', new Command([
            'serverStatus' => 1,
            'recordStats' => 0,
            'repl' => 0,
            'metrics' => 0,
        ]))->toArray()[0];

        $collectionStats = $this->instance->getManager()->executeCommand('phpFastCache', new Command([
            'collStats' => (isset($this->getConfig()['collectionName']) ? $this->getConfig()['collectionName'] : 'Cache'),
            'verbose' => true,
        ]))->toArray()[0];

        $array_filter_recursive = function ($array, callable $callback = null) use (&$array_filter_recursive) {
            $array = $callback($array);

            if (\is_object($array) || \is_array($array)) {
                foreach ($array as &$value) {
                    $value = \call_user_func($array_filter_recursive, $value, $callback);
                }
            }

            return $array;
        };

        $callback = function ($item) {
            /**
             * Remove unserializable properties
             */
            if ($item instanceof \MongoDB\BSON\UTCDateTime) {
                return (string)$item;
            }
            return $item;
        };

        $serverStats = $array_filter_recursive($serverStats, $callback);
        $collectionStats = $array_filter_recursive($collectionStats, $callback);

        $stats = (new DriverStatistic())
            ->setInfo('MongoDB version ' . $serverStats->version . ', Uptime (in days): ' . \round($serverStats->uptime / 86400,
                    1) . "\n For more information see RawData.")
            ->setSize($collectionStats->size)
            ->setData(\implode(', ', \array_keys($this->itemInstances)))
            ->setRawData([
                'serverStatus' => $serverStats,
                'collStats' => $collectionStats,
            ]);

        return $stats;
    }
}


1			<?php
2			/**
3			*
4			* This file is part of phpFastCache.
5			*
6			* @license MIT License (MIT)
7			*
8			* For full copyright and license information, please see the docs/CREDITS.txt file.
9			*
10			* @author Khoa Bui (khoaofgod) <[email protected]> https://www.phpfastcache.com
11			* @author Georges.L (Geolim4) <[email protected]>
12			* @author Fabio Covolo Mazzo (fabiocmazzo) <[email protected]>
13			*
14			*/
15			declare(strict_types=1);
16
17			namespace Phpfastcache\Drivers\Mongodb;
18
19			use LogicException;
20			use MongoDB\{
21			BSON\Binary, BSON\UTCDateTime, Client, Collection, Database, DeleteResult, Driver\Command, Driver\Exception\Exception as MongoDBException
			0 ignored issues – show Bug introduced 2018-05-23 20:31 UTC by Report Bug Copy Issue Report The type `MongoDB\Client` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history... Bug introduced 2018-05-23 20:31 UTC by Report Bug Copy Issue Report The type `MongoDB\DeleteResult` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history... Bug introduced 2018-05-23 20:31 UTC by Report Bug Copy Issue Report The type `MongoDB\Collection` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history... Bug introduced 2018-05-23 20:31 UTC by Report Bug Copy Issue Report The type `MongoDB\Database` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
22			};
23			use Phpfastcache\Core\Pool\{
24			DriverBaseTrait, ExtendedCacheItemPoolInterface
25			};
26			use Phpfastcache\Entities\DriverStatistic;
27			use Phpfastcache\Exceptions\{
28			PhpfastcacheDriverException, PhpfastcacheInvalidArgumentException
29			};
30			use Psr\Cache\CacheItemInterface;
31
32			/**
33			* Class Driver
34			* @package phpFastCache\Drivers
35			* @property Client $instance Instance of driver service
36			* @property Config $config Config object
37			* @method Config getConfig() Return the config object
38			*/
39			class Driver implements ExtendedCacheItemPoolInterface
40			{
41			const MONGODB_DEFAULT_DB_NAME = 'phpfastcache';
42
43			use DriverBaseTrait;
44
45			/**
46			* @var Collection
47			*/
48			public $collection;
49
50			/**
51			* @var Database
52			*/
53			public $database;
54
55			/**
56			* @return bool
57			*/
58			public function driverCheck(): bool
59			{
60			$mongoExtensionExists = class_exists(\MongoDB\Driver\Manager::class);
61
62			if (!$mongoExtensionExists && class_exists(\MongoClient::class)) {
63			\trigger_error('This driver is used to support the pecl MongoDb extension with mongo-php-library.
64			For MongoDb with Mongo PECL support use Mongo Driver.', E_USER_ERROR);
65			}
66
67			return $mongoExtensionExists && class_exists(\MongoDB\Collection::class);
68			}
69
70			/**
71			* @param \Psr\Cache\CacheItemInterface $item
72			* @return null\|array
73			*/
74			protected function driverRead(CacheItemInterface $item)
75			{
76			$document = $this->getCollection()->findOne(['_id' => $item->getEncodedKey()]);
77
78			if ($document) {
79			$return = [
80			self::DRIVER_DATA_WRAPPER_INDEX => $this->decode($document[self::DRIVER_DATA_WRAPPER_INDEX]->getData()),
81			self::DRIVER_TAGS_WRAPPER_INDEX => $this->decode($document[self::DRIVER_TAGS_WRAPPER_INDEX]->getData()),
82			self::DRIVER_EDATE_WRAPPER_INDEX => (new \DateTime())->setTimestamp($document[self::DRIVER_EDATE_WRAPPER_INDEX]->toDateTime()->getTimestamp()),
83			];
84
85			if (!empty($this->getConfig()->isItemDetailedDate())) {
86			$return += [
87			self::DRIVER_MDATE_WRAPPER_INDEX => (new \DateTime())->setTimestamp($document[self::DRIVER_MDATE_WRAPPER_INDEX]->toDateTime()
88			->getTimestamp()),
89			self::DRIVER_CDATE_WRAPPER_INDEX => (new \DateTime())->setTimestamp($document[self::DRIVER_CDATE_WRAPPER_INDEX]->toDateTime()
90			->getTimestamp()),
91			];
92			}
93
94			return $return;
95			}
96
97			return null;
98			}
99
100			/**
101			* @param \Psr\Cache\CacheItemInterface $item
102			* @return mixed
103			* @throws PhpfastcacheInvalidArgumentException
104			* @throws PhpfastcacheDriverException
105			*/
106			protected function driverWrite(CacheItemInterface $item): bool
107			{
108			/**
109			* Check for Cross-Driver type confusion
110			*/
111			if ($item instanceof Item) {
112			try {
113			$set = [
114			self::DRIVER_DATA_WRAPPER_INDEX => new Binary($this->encode($item->get()), Binary::TYPE_GENERIC),
115			self::DRIVER_TAGS_WRAPPER_INDEX => new Binary($this->encode($item->getTags()), Binary::TYPE_GENERIC),
116			self::DRIVER_EDATE_WRAPPER_INDEX => ($item->getTtl() > 0 ? new UTCDateTime((\time() + $item->getTtl()) * 1000) : new UTCDateTime(\time() * 1000)),
117			];
118
119			if (!empty($this->getConfig()->isItemDetailedDate())) {
120			$set += [
121			self::DRIVER_MDATE_WRAPPER_INDEX => ($item->getModificationDate() ? new UTCDateTime(($item->getModificationDate()
122			->getTimestamp()) * 1000) : new UTCDateTime(\time() * 1000)),
123			self::DRIVER_CDATE_WRAPPER_INDEX => ($item->getCreationDate() ? new UTCDateTime(($item->getCreationDate()
124			->getTimestamp()) * 1000) : new UTCDateTime(\time() * 1000)),
125			];
126			}
127			$result = (array)$this->getCollection()->updateOne(
128			['_id' => $item->getEncodedKey()],
129			[
130			'$set' => $set,
131			],
132			['upsert' => true, 'multiple' => false]
133			);
134			} catch (MongoDBException $e) {
135			throw new PhpfastcacheDriverException('Got an exception while trying to write data to MongoDB server', null, $e);
136			}
137
138			return isset($result['ok']) ? $result['ok'] == 1 : true;
139			}
140
141			throw new PhpfastcacheInvalidArgumentException('Cross-Driver type confusion detected');
142			}
143
144			/**
145			* @param \Psr\Cache\CacheItemInterface $item
146			* @return bool
147			* @throws PhpfastcacheInvalidArgumentException
148			*/
149			protected function driverDelete(CacheItemInterface $item): bool
150			{
151			/**
152			* Check for Cross-Driver type confusion
153			*/
154			if ($item instanceof Item) {
155			/**
156			* @var DeleteResult $deletionResult
157			*/
158			$deletionResult = $this->getCollection()->deleteOne(['_id' => $item->getEncodedKey()]);
159
160			return $deletionResult->isAcknowledged();
161			}
162
163			throw new PhpfastcacheInvalidArgumentException('Cross-Driver type confusion detected');
164			}
165
166			/**
167			* @return bool
168			*/
169			protected function driverClear(): bool
170			{
171			return $this->collection->deleteMany([])->isAcknowledged();
172			}
173
174			/**
175			* @return bool
176			* @throws MongodbException
177			* @throws LogicException
178			*/
179			protected function driverConnect(): bool
180			{
181			if ($this->instance instanceof Client) {
182			throw new LogicException('Already connected to Mongodb server');
183			}
184
185			$timeout = $this->getConfig()->getTimeout() * 1000;
186			$collectionName = $this->getConfig()->getCollectionName();
187			$databaseName = $this->getConfig()->getDatabaseName();
188
189			$this->instance = $this->instance ?: new Client($this->buildConnectionURI($databaseName), ['connectTimeoutMS' => $timeout]);
190			$this->database = $this->database ?: $this->instance->selectDatabase($databaseName);
191
192			if (!$this->collectionExists($collectionName)) {
193			$this->database->createCollection($collectionName);
194			}
195
196			$this->collection = $this->database->selectCollection($collectionName);
197
198			return true;
199			}
200
201			/**
202			* Checks if a collection name exists on the Mongo database.
203			*
204			* @param string $collectionName The collection name to check.
205			*
206			* @return bool True if the collection exists, false if not.
207			*/
208			protected function collectionExists($collectionName): bool
209			{
210			foreach ($this->database->listCollections() as $collection) {
211			if ($collection->getName() === $collectionName) {
212			return true;
213			}
214			}
215
216			return false;
217			}
218
219			/**
220			* Builds the connection URI from the given parameters.
221			*
222			* @param string $databaseName
223			* @return string The connection URI.
224			*/
225			protected function buildConnectionURI($databaseName = ''): string
226			{
227			$host = $this->getConfig()->getHost();
228			$port = $this->getConfig()->getPort();
229			$username = $this->getConfig()->getUsername();
230			$password = $this->getConfig()->getPassword();
231
232			return implode('', [
233			'mongodb://',
234			($username ?: ''),
235			($password ? ":{$password}" : ''),
236			($username ? '@' : ''),
237			$host,
238			($port !== 27017 ? ":{$port}" : ''),
239			($databaseName ? "/{$databaseName}" : ''),
240			]);
241			}
242
243			/**
244			* @return Collection
245			*/
246			protected function getCollection(): Collection
247			{
248			return $this->collection;
249			}
250
251			/********************
252			*
253			* PSR-6 Extended Methods
254			*
255			*******************/
256
257			/**
258			* @return DriverStatistic
259			*/
260			public function getStats(): DriverStatistic
261			{
262			$serverStats = $this->instance->getManager()->executeCommand('phpFastCache', new Command([
263			'serverStatus' => 1,
264			'recordStats' => 0,
265			'repl' => 0,
266			'metrics' => 0,
267			]))->toArray()[0];
268
269			$collectionStats = $this->instance->getManager()->executeCommand('phpFastCache', new Command([
270			'collStats' => (isset($this->getConfig()['collectionName']) ? $this->getConfig()['collectionName'] : 'Cache'),
271			'verbose' => true,
272			]))->toArray()[0];
273
274			$array_filter_recursive = function ($array, callable $callback = null) use (&$array_filter_recursive) {
275			$array = $callback($array);
276
277			if (\is_object($array) \|\| \is_array($array)) {
278			foreach ($array as &$value) {
279			$value = \call_user_func($array_filter_recursive, $value, $callback);
280			}
281			}
282
283			return $array;
284			};
285
286			$callback = function ($item) {
287			/**
288			* Remove unserializable properties
289			*/
290			if ($item instanceof \MongoDB\BSON\UTCDateTime) {
291			return (string)$item;
292			}
293			return $item;
294			};
295
296			$serverStats = $array_filter_recursive($serverStats, $callback);
297			$collectionStats = $array_filter_recursive($collectionStats, $callback);
298
299			$stats = (new DriverStatistic())
300			->setInfo('MongoDB version ' . $serverStats->version . ', Uptime (in days): ' . \round($serverStats->uptime / 86400,
301			1) . "\n For more information see RawData.")
302			->setSize($collectionStats->size)
303			->setData(\implode(', ', \array_keys($this->itemInstances)))
304			->setRawData([
305			'serverStatus' => $serverStats,
306			'collStats' => $collectionStats,
307			]);
308
309			return $stats;
310			}
311			}
312

PHPSocialNetwork / phpfastcache

Push — master ( 4e7427...4a94bb )

Driver::collectionExists() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like