CouchbaseBucketCache.php — Independent Analytics – WordPress Analytics Plugin 2.2.0

independent-analytics / vendor / doctrine / cache / lib / Doctrine / Common / Cache / CouchbaseBucketCache.php

independent-analytics / vendor / doctrine / cache / lib / Doctrine / Common / Cache Last commit date

CouchbaseBucketCache.php

154 lines

1	<?php
2
3	declare (strict_types=1);
4	namespace IAWP_SCOPED\Doctrine\Common\Cache;
5
6	use Couchbase\Bucket;
7	use IAWP_SCOPED\Couchbase\Document;
8	use IAWP_SCOPED\Couchbase\Exception;
9	use RuntimeException;
10	use function phpversion;
11	use function serialize;
12	use function sprintf;
13	use function substr;
14	use function time;
15	use function unserialize;
16	use function version_compare;
17	/**
18	* Couchbase ^2.3.0 cache provider.
19	*
20	* @deprecated Deprecated without replacement in doctrine/cache 1.11. This class will be dropped in 2.0
21	* @internal
22	*/
23	final class CouchbaseBucketCache extends CacheProvider
24	{
25	private const MINIMUM_VERSION = '2.3.0';
26	private const KEY_NOT_FOUND = 13;
27	private const MAX_KEY_LENGTH = 250;
28	private const THIRTY_DAYS_IN_SECONDS = 2592000;
29	/** @var Bucket */
30	private $bucket;
31	public function __construct(Bucket $bucket)
32	{
33	if (version_compare(phpversion('couchbase'), self::MINIMUM_VERSION) < 0) {
34	// Manager is required to flush cache and pull stats.
35	throw new RuntimeException(sprintf('ext-couchbase:^%s is required.', self::MINIMUM_VERSION));
36	}
37	$this->bucket = $bucket;
38	}
39	/**
40	* {@inheritdoc}
41	*/
42	protected function doFetch($id)
43	{
44	$id = $this->normalizeKey($id);
45	try {
46	$document = $this->bucket->get($id);
47	} catch (Exception $e) {
48	return \false;
49	}
50	if ($document instanceof Document && $document->value !== \false) {
51	return unserialize($document->value);
52	}
53	return \false;
54	}
55	/**
56	* {@inheritdoc}
57	*/
58	protected function doContains($id)
59	{
60	$id = $this->normalizeKey($id);
61	try {
62	$document = $this->bucket->get($id);
63	} catch (Exception $e) {
64	return \false;
65	}
66	if ($document instanceof Document) {
67	return !$document->error;
68	}
69	return \false;
70	}
71	/**
72	* {@inheritdoc}
73	*/
74	protected function doSave($id, $data, $lifeTime = 0)
75	{
76	$id = $this->normalizeKey($id);
77	$lifeTime = $this->normalizeExpiry($lifeTime);
78	try {
79	$encoded = serialize($data);
80	$document = $this->bucket->upsert($id, $encoded, ['expiry' => (int) $lifeTime]);
81	} catch (Exception $e) {
82	return \false;
83	}
84	if ($document instanceof Document) {
85	return !$document->error;
86	}
87	return \false;
88	}
89	/**
90	* {@inheritdoc}
91	*/
92	protected function doDelete($id)
93	{
94	$id = $this->normalizeKey($id);
95	try {
96	$document = $this->bucket->remove($id);
97	} catch (Exception $e) {
98	return $e->getCode() === self::KEY_NOT_FOUND;
99	}
100	if ($document instanceof Document) {
101	return !$document->error;
102	}
103	return \false;
104	}
105	/**
106	* {@inheritdoc}
107	*/
108	protected function doFlush()
109	{
110	$manager = $this->bucket->manager();
111	// Flush does not return with success or failure, and must be enabled per bucket on the server.
112	// Store a marker item so that we will know if it was successful.
113	$this->doSave(__METHOD__, \true, 60);
114	$manager->flush();
115	if ($this->doContains(__METHOD__)) {
116	$this->doDelete(__METHOD__);
117	return \false;
118	}
119	return \true;
120	}
121	/**
122	* {@inheritdoc}
123	*/
124	protected function doGetStats()
125	{
126	$manager = $this->bucket->manager();
127	$stats = $manager->info();
128	$nodes = $stats['nodes'];
129	$node = $nodes[0];
130	$interestingStats = $node['interestingStats'];
131	return [Cache::STATS_HITS => $interestingStats['get_hits'], Cache::STATS_MISSES => $interestingStats['cmd_get'] - $interestingStats['get_hits'], Cache::STATS_UPTIME => $node['uptime'], Cache::STATS_MEMORY_USAGE => $interestingStats['mem_used'], Cache::STATS_MEMORY_AVAILABLE => $node['memoryFree']];
132	}
133	private function normalizeKey(string $id) : string
134	{
135	$normalized = substr($id, 0, self::MAX_KEY_LENGTH);
136	if ($normalized === \false) {
137	return $id;
138	}
139	return $normalized;
140	}
141	/**
142	* Expiry treated as a unix timestamp instead of an offset if expiry is greater than 30 days.
143	*
144	* @src https://developer.couchbase.com/documentation/server/4.1/developer-guide/expiry.html
145	*/
146	private function normalizeExpiry(int $expiry) : int
147	{
148	if ($expiry > self::THIRTY_DAYS_IN_SECONDS) {
149	return time() + $expiry;
150	}
151	return $expiry;
152	}
153	}
154