https://www.phpfastcache.com * @author Georges.L (Geolim4) * */ declare(strict_types=1); namespace Phpfastcache\Drivers\Couchbase; use Couchbase\Exception as CouchbaseException; use Couchbase\PasswordAuthenticator; use Couchbase\Bucket as CouchbaseBucket; use Couchbase\Cluster as CouchbaseClient; use DateTime; use Phpfastcache\Cluster\AggregatablePoolInterface; use Phpfastcache\Core\Pool\{DriverBaseTrait, ExtendedCacheItemPoolInterface}; use Phpfastcache\Config\ConfigurationOption; use Phpfastcache\Entities\DriverStatistic; use Phpfastcache\Exceptions\{PhpfastcacheDriverCheckException, PhpfastcacheInvalidArgumentException, PhpfastcacheLogicException}; use Psr\Cache\CacheItemInterface; /** * Class Driver * @package phpFastCache\Drivers * @property CouchbaseClient $instance Instance of driver service * @property Config $config Config object * @method Config getConfig() Return the config object */ class Driver implements ExtendedCacheItemPoolInterface, AggregatablePoolInterface { use DriverBaseTrait { __construct as __baseConstruct; } /** * @var CouchbaseBucket[] */ protected $bucketInstances = []; /** * @var CouchbaseBucket */ protected $bucketInstance; /** * @var string */ protected $currentBucket = ''; public function __construct(ConfigurationOption $config, $instanceId) { // @todo Deprecation to enable in v8.1 // \trigger_error('Couchbase driver is now deprecated and will be removed in the V9, use Couchbasev3 instead which will support SDK 3.', \E_USER_DEPRECATED); $this->__baseConstruct($config, $instanceId); } /** * @return bool */ public function driverCheck(): bool { return extension_loaded('couchbase'); } /** * @return DriverStatistic */ public function getStats(): DriverStatistic { $info = $this->getBucket()->manager()->info(); return (new DriverStatistic()) ->setSize($info['basicStats']['diskUsed']) ->setRawData($info) ->setData(implode(', ', array_keys($this->itemInstances))) ->setInfo( 'CouchBase version ' . $info['nodes'][0]['version'] . ', Uptime (in days): ' . round( $info['nodes'][0]['uptime'] / 86400, 1 ) . "\n For more information see RawData." ); } /** * @return bool * @throws PhpfastcacheLogicException */ protected function driverConnect(): bool { if (\class_exists(\Couchbase\ClusterOptions::class)) { throw new PhpfastcacheDriverCheckException('You are using the Couchbase PHP SDK 3.x so please use driver Couchbasev3'); } if ($this->instance instanceof CouchbaseClient) { throw new PhpfastcacheLogicException('Already connected to Couchbase server'); } $clientConfig = $this->getConfig(); $authenticator = new PasswordAuthenticator(); $authenticator->username($clientConfig->getUsername())->password($clientConfig->getPassword()); $this->instance = new CouchbaseClient( 'couchbase://' . $clientConfig->getHost() . ($clientConfig->getPort() ? ":{$clientConfig->getPort()}" : '') ); $this->instance->authenticate($authenticator); $this->setBucket($this->instance->openBucket($clientConfig->getBucketName())); return true; } /** * @param CouchbaseBucket $CouchbaseBucket */ protected function setBucket(CouchbaseBucket $CouchbaseBucket) { $this->bucketInstance = $CouchbaseBucket; } /** * @param CacheItemInterface $item * @return null|array */ protected function driverRead(CacheItemInterface $item) { try { /** * CouchbaseBucket::get() returns a CouchbaseMetaDoc object */ return $this->decodeDocument((array) $this->getBucket()->get($item->getEncodedKey())->value); } catch (CouchbaseException $e) { return null; } } /** * @return CouchbaseBucket */ protected function getBucket(): CouchbaseBucket { return $this->bucketInstance; } /** * @param CacheItemInterface $item * @return bool * @throws PhpfastcacheInvalidArgumentException */ protected function driverWrite(CacheItemInterface $item): bool { /** * Check for Cross-Driver type confusion */ if ($item instanceof Item) { try { return (bool)$this->getBucket()->upsert( $item->getEncodedKey(), $this->encodeDocument($this->driverPreWrap($item)), ['expiry' => $item->getTtl()] ); } catch (CouchbaseException $e) { return false; } } throw new PhpfastcacheInvalidArgumentException('Cross-Driver type confusion detected'); } /** * @param CacheItemInterface $item * @return bool * @throws PhpfastcacheInvalidArgumentException */ protected function driverDelete(CacheItemInterface $item): bool { /** * Check for Cross-Driver type confusion */ if ($item instanceof Item) { try { return (bool)$this->getBucket()->remove($item->getEncodedKey()); } catch (Exception $e) { return $e->getCode() === COUCHBASE_KEY_ENOENT; } } throw new PhpfastcacheInvalidArgumentException('Cross-Driver type confusion detected'); } /** * @param array $data * @return array */ protected function encodeDocument(array $data): array { $data[ExtendedCacheItemPoolInterface::DRIVER_DATA_WRAPPER_INDEX] = $this->encode($data[ExtendedCacheItemPoolInterface::DRIVER_DATA_WRAPPER_INDEX]); $data[ExtendedCacheItemPoolInterface::DRIVER_EDATE_WRAPPER_INDEX] = $data[ExtendedCacheItemPoolInterface::DRIVER_EDATE_WRAPPER_INDEX]->format(\DateTime::ATOM); if($this->getConfig()->isItemDetailedDate()){ $data[ExtendedCacheItemPoolInterface::DRIVER_CDATE_WRAPPER_INDEX] = $data[ExtendedCacheItemPoolInterface::DRIVER_CDATE_WRAPPER_INDEX]->format(\DateTime::ATOM); $data[ExtendedCacheItemPoolInterface::DRIVER_MDATE_WRAPPER_INDEX] = $data[ExtendedCacheItemPoolInterface::DRIVER_MDATE_WRAPPER_INDEX]->format(\DateTime::ATOM); } return $data; } /** * @param array $data * @return array */ protected function decodeDocument(array $data): array { $data[ExtendedCacheItemPoolInterface::DRIVER_DATA_WRAPPER_INDEX] = $this->decode($data[ExtendedCacheItemPoolInterface::DRIVER_DATA_WRAPPER_INDEX]); $data[ExtendedCacheItemPoolInterface::DRIVER_EDATE_WRAPPER_INDEX] = \DateTime::createFromFormat( \DateTime::ATOM, $data[ExtendedCacheItemPoolInterface::DRIVER_EDATE_WRAPPER_INDEX] ); if($this->getConfig()->isItemDetailedDate()){ $data[ExtendedCacheItemPoolInterface::DRIVER_CDATE_WRAPPER_INDEX] = \DateTime::createFromFormat( \DateTime::ATOM, $data[ExtendedCacheItemPoolInterface::DRIVER_CDATE_WRAPPER_INDEX] ); $data[ExtendedCacheItemPoolInterface::DRIVER_MDATE_WRAPPER_INDEX] = \DateTime::createFromFormat( \DateTime::ATOM, $data[ExtendedCacheItemPoolInterface::DRIVER_MDATE_WRAPPER_INDEX] ); } return $data; } /******************** * * PSR-6 Extended Methods * *******************/ /** * @return bool */ protected function driverClear(): bool { $this->getBucket()->manager()->flush(); return true; } }