* * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. */ namespace Symfony\Component\Cache\Adapter; use Couchbase\Bucket; use Couchbase\Cluster; use Couchbase\ClusterOptions; use Couchbase\Collection; use Couchbase\DocumentNotFoundException; use Couchbase\UpsertOptions; use Symfony\Component\Cache\Exception\CacheException; use Symfony\Component\Cache\Exception\InvalidArgumentException; use Symfony\Component\Cache\Marshaller\DefaultMarshaller; use Symfony\Component\Cache\Marshaller\MarshallerInterface; /** * @author Antonio Jose Cerezo Aranda */ class CouchbaseCollectionAdapter extends AbstractAdapter { private const MAX_KEY_LENGTH = 250; private MarshallerInterface $marshaller; public function __construct( private Collection $connection, string $namespace = '', int $defaultLifetime = 0, ?MarshallerInterface $marshaller = null, ) { if (!static::isSupported()) { throw new CacheException('Couchbase >= 3.0.5 < 4.0.0 is required.'); } $this->maxIdLength = static::MAX_KEY_LENGTH; parent::__construct($namespace, $defaultLifetime); $this->enableVersioning(); $this->marshaller = $marshaller ?? new DefaultMarshaller(); } public static function createConnection(#[\SensitiveParameter] array|string $dsn, array $options = []): Bucket|Collection { if (\is_string($dsn)) { $dsn = [$dsn]; } if (!static::isSupported()) { throw new CacheException('Couchbase >= 3.0.5 < 4.0.0 is required.'); } set_error_handler(static fn ($type, $msg, $file, $line) => throw new \ErrorException($msg, 0, $type, $file, $line)); $pathPattern = '/^(?:\/(?[^\/\?]+))(?:(?:\/(?[^\/]+))(?:\/(?[^\/\?]+)))?(?:\/)?$/'; $newServers = []; $protocol = 'couchbase'; try { $username = $options['username'] ?? ''; $password = $options['password'] ?? ''; foreach ($dsn as $server) { if (!str_starts_with($server, 'couchbase:')) { throw new InvalidArgumentException('Invalid Couchbase DSN: it does not start with "couchbase:".'); } $params = parse_url($server); $username = isset($params['user']) ? rawurldecode($params['user']) : $username; $password = isset($params['pass']) ? rawurldecode($params['pass']) : $password; $protocol = $params['scheme'] ?? $protocol; if (isset($params['query'])) { $optionsInDsn = self::getOptions($params['query']); foreach ($optionsInDsn as $parameter => $value) { $options[$parameter] = $value; } } $newServers[] = $params['host']; } $option = isset($params['query']) ? '?'.$params['query'] : ''; $connectionString = $protocol.'://'.implode(',', $newServers).$option; $clusterOptions = new ClusterOptions(); $clusterOptions->credentials($username, $password); $client = new Cluster($connectionString, $clusterOptions); preg_match($pathPattern, $params['path'] ?? '', $matches); $bucket = $client->bucket($matches['bucketName']); $collection = $bucket->defaultCollection(); if (!empty($matches['scopeName'])) { $scope = $bucket->scope($matches['scopeName']); $collection = $scope->collection($matches['collectionName']); } return $collection; } finally { restore_error_handler(); } } public static function isSupported(): bool { return \extension_loaded('couchbase') && version_compare(phpversion('couchbase'), '3.0.5', '>=') && version_compare(phpversion('couchbase'), '4.0', '<'); } private static function getOptions(string $options): array { $results = []; $optionsInArray = explode('&', $options); foreach ($optionsInArray as $option) { [$key, $value] = explode('=', $option); $results[$key] = $value; } return $results; } protected function doFetch(array $ids): array { $results = []; foreach ($ids as $id) { try { $resultCouchbase = $this->connection->get($id); } catch (DocumentNotFoundException) { continue; } $content = $resultCouchbase->value ?? $resultCouchbase->content(); $results[$id] = $this->marshaller->unmarshall($content); } return $results; } protected function doHave($id): bool { return $this->connection->exists($id)->exists(); } protected function doClear($namespace): bool { return false; } protected function doDelete(array $ids): bool { $idsErrors = []; foreach ($ids as $id) { try { $result = $this->connection->remove($id); if (null === $result->mutationToken()) { $idsErrors[] = $id; } } catch (DocumentNotFoundException) { } } return 0 === \count($idsErrors); } protected function doSave(array $values, $lifetime): array|bool { if (!$values = $this->marshaller->marshall($values, $failed)) { return $failed; } $upsertOptions = new UpsertOptions(); $upsertOptions->expiry($lifetime); $ko = []; foreach ($values as $key => $value) { try { $this->connection->upsert($key, $value, $upsertOptions); } catch (\Exception) { $ko[$key] = ''; } } return [] === $ko ? true : $ko; } }