-
-
Notifications
You must be signed in to change notification settings - Fork 150
/
object-cache.php
3087 lines (2577 loc) · 104 KB
/
object-cache.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?php
/**
* Plugin Name: Redis Object Cache Drop-In
* Plugin URI: https://wordpress.org/plugins/redis-cache/
* Description: A persistent object cache backend powered by Redis. Supports Predis, PhpRedis, Relay, replication, sentinels, clustering and WP-CLI.
* Version: 2.5.4
* Author: Till Krüss
* Author URI: https://objectcache.pro
* License: GPLv3
* License URI: http://www.gnu.org/licenses/gpl-3.0.html
* Requires PHP: 7.2
*
* @package Rhubarb\RedisCache
*/
defined( '\\ABSPATH' ) || exit;
// phpcs:disable Generic.WhiteSpace.ScopeIndent.IncorrectExact, Generic.WhiteSpace.ScopeIndent.Incorrect
if ( ! defined( 'WP_REDIS_DISABLED' ) || ! WP_REDIS_DISABLED ) :
/**
* Determines whether the object cache implementation supports a particular feature.
*
* Possible values include:
* - `add_multiple`, `set_multiple`, `get_multiple` and `delete_multiple`
* - `flush_runtime` and `flush_group`
*
* @param string $feature Name of the feature to check for.
* @return bool True if the feature is supported, false otherwise.
*/
function wp_cache_supports( $feature ) {
switch ( $feature ) {
case 'add_multiple':
case 'set_multiple':
case 'get_multiple':
case 'delete_multiple':
case 'flush_runtime':
case 'flush_group':
return true;
default:
return false;
}
}
/**
* Adds a value to cache.
*
* If the specified key already exists, the value is not stored and the function
* returns false.
*
* @param string $key The key under which to store the value.
* @param mixed $value The value to store.
* @param string $group The group value appended to the $key.
* @param int $expiration The expiration time, defaults to 0.
*
* @return bool Returns TRUE on success or FALSE on failure.
*/
function wp_cache_add( $key, $value, $group = '', $expiration = 0 ) {
global $wp_object_cache;
return $wp_object_cache->add( $key, $value, $group, $expiration );
}
/**
* Adds multiple values to the cache in one call.
*
* @param array $data Array of keys and values to be set.
* @param string $group Optional. Where the cache contents are grouped. Default empty.
* @param int $expire Optional. When to expire the cache contents, in seconds.
* Default 0 (no expiration).
* @return bool[] Array of return values, grouped by key. Each value is either
* true on success, or false if cache key and group already exist.
*/
function wp_cache_add_multiple( array $data, $group = '', $expire = 0 ) {
global $wp_object_cache;
return $wp_object_cache->add_multiple( $data, $group, $expire );
}
/**
* Closes the cache.
*
* This function has ceased to do anything since WordPress 2.5. The
* functionality was removed along with the rest of the persistent cache. This
* does not mean that plugins can't implement this function when they need to
* make sure that the cache is cleaned up after WordPress no longer needs it.
*
* @return bool Always returns True
*/
function wp_cache_close() {
return true;
}
/**
* Decrement a numeric item's value.
*
* @param string $key The key under which to store the value.
* @param int $offset The amount by which to decrement the item's value.
* @param string $group The group value appended to the $key.
*
* @return int|bool Returns item's new value on success or FALSE on failure.
*/
function wp_cache_decr( $key, $offset = 1, $group = '' ) {
global $wp_object_cache;
return $wp_object_cache->decrement( $key, $offset, $group );
}
/**
* Remove the item from the cache.
*
* @param string $key The key under which to store the value.
* @param string $group The group value appended to the $key.
* @param int $time The amount of time the server will wait to delete the item in seconds.
*
* @return bool Returns TRUE on success or FALSE on failure.
*/
function wp_cache_delete( $key, $group = '', $time = 0 ) {
global $wp_object_cache;
return $wp_object_cache->delete( $key, $group, $time );
}
/**
* Deletes multiple values from the cache in one call.
*
* @param array $keys Array of keys under which the cache to deleted.
* @param string $group Optional. Where the cache contents are grouped. Default empty.
* @return bool[] Array of return values, grouped by key. Each value is either
* true on success, or false if the contents were not deleted.
*/
function wp_cache_delete_multiple( array $keys, $group = '' ) {
global $wp_object_cache;
return $wp_object_cache->delete_multiple( $keys, $group );
}
/**
* Invalidate all items in the cache. If `WP_REDIS_SELECTIVE_FLUSH` is `true`,
* only keys prefixed with the `WP_REDIS_PREFIX` are flushed.
*
* @return bool Returns TRUE on success or FALSE on failure.
*/
function wp_cache_flush() {
global $wp_object_cache;
return $wp_object_cache->flush();
}
/**
* Removes all cache items in a group.
*
* @param string $group Name of group to remove from cache.
* @return true Returns TRUE on success or FALSE on failure.
*/
function wp_cache_flush_group( $group )
{
global $wp_object_cache;
return $wp_object_cache->flush_group( $group );
}
/**
* Removes all cache items from the in-memory runtime cache.
*
* @return bool True on success, false on failure.
*/
function wp_cache_flush_runtime() {
global $wp_object_cache;
return $wp_object_cache->flush_runtime();
}
/**
* Retrieve object from cache.
*
* Gets an object from cache based on $key and $group.
*
* @param string $key The key under which to store the value.
* @param string $group The group value appended to the $key.
* @param bool $force Optional. Whether to force an update of the local cache from the persistent
* cache. Default false.
* @param bool $found Optional. Whether the key was found in the cache. Disambiguates a return of false,
* a storable value. Passed by reference. Default null.
*
* @return bool|mixed Cached object value.
*/
function wp_cache_get( $key, $group = '', $force = false, &$found = null ) {
global $wp_object_cache;
return $wp_object_cache->get( $key, $group, $force, $found );
}
/**
* Retrieves multiple values from the cache in one call.
*
* @param array $keys Array of keys under which the cache contents are stored.
* @param string $group Optional. Where the cache contents are grouped. Default empty.
* @param bool $force Optional. Whether to force an update of the local cache
* from the persistent cache. Default false.
* @return array Array of values organized into groups.
*/
function wp_cache_get_multiple( $keys, $group = '', $force = false ) {
global $wp_object_cache;
return $wp_object_cache->get_multiple( $keys, $group, $force );
}
/**
* Increment a numeric item's value.
*
* @param string $key The key under which to store the value.
* @param int $offset The amount by which to increment the item's value.
* @param string $group The group value appended to the $key.
*
* @return int|bool Returns item's new value on success or FALSE on failure.
*/
function wp_cache_incr( $key, $offset = 1, $group = '' ) {
global $wp_object_cache;
return $wp_object_cache->increment( $key, $offset, $group );
}
/**
* Sets up Object Cache Global and assigns it.
*
* @return void
*/
function wp_cache_init() {
global $wp_object_cache;
if ( ! defined( 'WP_REDIS_PREFIX' ) && getenv( 'WP_REDIS_PREFIX' ) ) {
define( 'WP_REDIS_PREFIX', getenv( 'WP_REDIS_PREFIX' ) );
}
if ( ! defined( 'WP_REDIS_SELECTIVE_FLUSH' ) && getenv( 'WP_REDIS_SELECTIVE_FLUSH' ) ) {
define( 'WP_REDIS_SELECTIVE_FLUSH', (bool) getenv( 'WP_REDIS_SELECTIVE_FLUSH' ) );
}
// Backwards compatibility: map `WP_CACHE_KEY_SALT` constant to `WP_REDIS_PREFIX`.
if ( defined( 'WP_CACHE_KEY_SALT' ) && ! defined( 'WP_REDIS_PREFIX' ) ) {
define( 'WP_REDIS_PREFIX', WP_CACHE_KEY_SALT );
}
// Set unique prefix for sites hosted on Cloudways
if ( ! defined( 'WP_REDIS_PREFIX' ) && isset( $_SERVER['cw_allowed_ip'] ) ) {
define( 'WP_REDIS_PREFIX', getenv( 'HTTP_X_APP_USER' ) );
}
if ( ! ( $wp_object_cache instanceof WP_Object_Cache ) ) {
$fail_gracefully = defined( 'WP_REDIS_GRACEFUL' ) && WP_REDIS_GRACEFUL;
// phpcs:ignore WordPress.WP.GlobalVariablesOverride.Prohibited
$wp_object_cache = new WP_Object_Cache( $fail_gracefully );
}
}
/**
* Replaces a value in cache.
*
* This method is similar to "add"; however, is does not successfully set a value if
* the object's key is not already set in cache.
*
* @param string $key The key under which to store the value.
* @param mixed $value The value to store.
* @param string $group The group value appended to the $key.
* @param int $expiration The expiration time, defaults to 0.
*
* @return bool Returns TRUE on success or FALSE on failure.
*/
function wp_cache_replace( $key, $value, $group = '', $expiration = 0 ) {
global $wp_object_cache;
return $wp_object_cache->replace( $key, $value, $group, $expiration );
}
/**
* Sets a value in cache.
*
* The value is set whether or not this key already exists in Redis.
*
* @param string $key The key under which to store the value.
* @param mixed $value The value to store.
* @param string $group The group value appended to the $key.
* @param int $expiration The expiration time, defaults to 0.
*
* @return bool Returns TRUE on success or FALSE on failure.
*/
function wp_cache_set( $key, $value, $group = '', $expiration = 0 ) {
global $wp_object_cache;
return $wp_object_cache->set( $key, $value, $group, $expiration );
}
/**
* Sets multiple values to the cache in one call.
*
* @param array $data Array of keys and values to be set.
* @param string $group Optional. Where the cache contents are grouped. Default empty.
* @param int $expire Optional. When to expire the cache contents, in seconds.
* Default 0 (no expiration).
* @return bool[] Array of return values, grouped by key. Each value is either
* true on success, or false on failure.
*/
function wp_cache_set_multiple( array $data, $group = '', $expire = 0 ) {
global $wp_object_cache;
return $wp_object_cache->set_multiple( $data, $group, $expire );
}
/**
* Switch the internal blog id.
*
* This changes the blog id used to create keys in blog specific groups.
*
* @param int $_blog_id The blog ID.
*
* @return bool
*/
function wp_cache_switch_to_blog( $_blog_id ) {
global $wp_object_cache;
return $wp_object_cache->switch_to_blog( $_blog_id );
}
/**
* Adds a group or set of groups to the list of Redis groups.
*
* @param string|array $groups A group or an array of groups to add.
*
* @return void
*/
function wp_cache_add_global_groups( $groups ) {
global $wp_object_cache;
$wp_object_cache->add_global_groups( $groups );
}
/**
* Adds a group or set of groups to the list of non-Redis groups.
*
* @param string|array $groups A group or an array of groups to add.
*
* @return void
*/
function wp_cache_add_non_persistent_groups( $groups ) {
global $wp_object_cache;
$wp_object_cache->add_non_persistent_groups( $groups );
}
/**
* Object cache class definition
*/
class WP_Object_Cache {
/**
* The Redis client.
*
* @var mixed
*/
private $redis;
/**
* The Redis server version.
*
* @var null|string
*/
private $redis_version = null;
/**
* Track if Redis is available.
*
* @var bool
*/
private $redis_connected = false;
/**
* Check to fail gracefully or throw an exception.
*
* @var bool
*/
private $fail_gracefully = true;
/**
* Holds the non-Redis objects.
*
* @var array
*/
public $cache = [];
/**
* Holds the diagnostics values.
*
* @var array
*/
public $diagnostics = null;
/**
* Holds the error messages.
*
* @var array
*/
public $errors = [];
/**
* List of global groups.
*
* @var array<string>
*/
public $global_groups = [
'blog-details',
'blog-id-cache',
'blog-lookup',
'global-posts',
'networks',
'rss',
'sites',
'site-details',
'site-lookup',
'site-options',
'site-transient',
'users',
'useremail',
'userlogins',
'usermeta',
'user_meta',
'userslugs',
];
/**
* List of groups that will not be flushed.
*
* @var array
*/
public $unflushable_groups = [];
/**
* List of groups not saved to Redis.
*
* @var array
*/
public $ignored_groups = [];
/**
* List of groups and their types.
*
* @var array
*/
public $group_type = [];
/**
* Prefix used for global groups.
*
* @var string
*/
public $global_prefix = '';
/**
* Prefix used for non-global groups.
*
* @var int
*/
public $blog_prefix = 0;
/**
* Track how many requests were found in cache.
*
* @var int
*/
public $cache_hits = 0;
/**
* Track how may requests were not cached.
*
* @var int
*/
public $cache_misses = 0;
/**
* The amount of Redis commands made.
*
* @var int
*/
public $cache_calls = 0;
/**
* The amount of microseconds (μs) waited for Redis commands.
*
* @var float
*/
public $cache_time = 0;
/**
* Instantiate the Redis class.
*
* @param bool $fail_gracefully Handles and logs errors if true throws exceptions otherwise.
*/
public function __construct( $fail_gracefully = false ) {
global $blog_id, $table_prefix;
$this->fail_gracefully = $fail_gracefully;
if ( defined( 'WP_REDIS_GLOBAL_GROUPS' ) && is_array( WP_REDIS_GLOBAL_GROUPS ) ) {
$this->global_groups = array_map( [ $this, 'sanitize_key_part' ], WP_REDIS_GLOBAL_GROUPS );
}
$this->global_groups[] = 'redis-cache';
if ( defined( 'WP_REDIS_IGNORED_GROUPS' ) && is_array( WP_REDIS_IGNORED_GROUPS ) ) {
$this->ignored_groups = array_map( [ $this, 'sanitize_key_part' ], WP_REDIS_IGNORED_GROUPS );
}
if ( defined( 'WP_REDIS_UNFLUSHABLE_GROUPS' ) && is_array( WP_REDIS_UNFLUSHABLE_GROUPS ) ) {
$this->unflushable_groups = array_map( [ $this, 'sanitize_key_part' ], WP_REDIS_UNFLUSHABLE_GROUPS );
}
$this->cache_group_types();
if ( function_exists( '_doing_it_wrong' ) ) {
if ( defined( 'WP_REDIS_TRACE' ) && WP_REDIS_TRACE ) {
_doing_it_wrong( __FUNCTION__ , 'Tracing feature was removed.' , '2.1.2' );
}
}
$client = $this->determine_client();
$parameters = $this->build_parameters();
try {
switch ( $client ) {
case 'hhvm':
$this->connect_using_hhvm( $parameters );
break;
case 'phpredis':
$this->connect_using_phpredis( $parameters );
break;
case 'relay':
$this->connect_using_relay( $parameters );
break;
case 'credis':
$this->connect_using_credis( $parameters );
break;
case 'predis':
default:
$this->connect_using_predis( $parameters );
break;
}
if ( defined( 'WP_REDIS_CLUSTER' ) ) {
$connectionId = is_string( WP_REDIS_CLUSTER )
? WP_REDIS_CLUSTER
: current( $this->build_cluster_connection_array() );
$this->diagnostics[ 'ping' ] = $client === 'predis'
? $this->redis->getClientBy( 'id', $connectionId )->ping()
: $this->redis->ping( $connectionId );
} else {
$this->diagnostics[ 'ping' ] = $this->redis->ping();
}
$this->fetch_info();
$this->redis_connected = true;
} catch ( Exception $exception ) {
$this->handle_exception( $exception );
}
// Assign global and blog prefixes for use with keys.
if ( function_exists( 'is_multisite' ) ) {
$this->global_prefix = is_multisite() ? '' : $table_prefix;
$this->blog_prefix = is_multisite() ? $blog_id : $table_prefix;
}
}
/**
* Set group type array
*
* @return void
*/
protected function cache_group_types() {
foreach ( $this->global_groups as $group ) {
$this->group_type[ $group ] = 'global';
}
foreach ( $this->unflushable_groups as $group ) {
$this->group_type[ $group ] = 'unflushable';
}
foreach ( $this->ignored_groups as $group ) {
$this->group_type[ $group ] = 'ignored';
}
}
/**
* Determine the Redis client.
*
* @return string
*/
protected function determine_client() {
$client = 'predis';
if ( class_exists( 'Redis' ) ) {
$client = defined( 'HHVM_VERSION' ) ? 'hhvm' : 'phpredis';
}
if ( defined( 'WP_REDIS_CLIENT' ) ) {
$client = (string) WP_REDIS_CLIENT;
$client = str_replace( 'pecl', 'phpredis', $client );
}
return trim( strtolower( $client ) );
}
/**
* Build the connection parameters from config constants.
*
* @return array
*/
protected function build_parameters() {
$parameters = [
'scheme' => 'tcp',
'host' => '127.0.0.1',
'port' => 6379,
'database' => 0,
'timeout' => 1,
'read_timeout' => 1,
'retry_interval' => null,
'persistent' => false,
];
$settings = [
'scheme',
'host',
'port',
'path',
'password',
'database',
'timeout',
'read_timeout',
'retry_interval',
];
foreach ( $settings as $setting ) {
$constant = sprintf( 'WP_REDIS_%s', strtoupper( $setting ) );
if ( defined( $constant ) ) {
$parameters[ $setting ] = constant( $constant );
}
}
if ( isset( $parameters[ 'password' ] ) && $parameters[ 'password' ] === '' ) {
unset( $parameters[ 'password' ] );
}
$this->diagnostics[ 'timeout' ] = $parameters[ 'timeout' ];
$this->diagnostics[ 'read_timeout' ] = $parameters[ 'read_timeout' ];
$this->diagnostics[ 'retry_interval' ] = $parameters[ 'retry_interval' ];
return $parameters;
}
/**
* Connect to Redis using the PhpRedis (PECL) extension.
*
* @param array $parameters Connection parameters built by the `build_parameters` method.
* @return void
*/
protected function connect_using_phpredis( $parameters ) {
$version = phpversion( 'redis' );
$this->diagnostics[ 'client' ] = sprintf( 'PhpRedis (v%s)', $version );
if ( defined( 'WP_REDIS_SHARDS' ) ) {
$this->redis = new RedisArray( array_values( WP_REDIS_SHARDS ) );
$this->diagnostics[ 'shards' ] = WP_REDIS_SHARDS;
} elseif ( defined( 'WP_REDIS_CLUSTER' ) ) {
if ( is_string( WP_REDIS_CLUSTER ) ) {
$this->redis = new RedisCluster( WP_REDIS_CLUSTER );
} else {
$args = [
'cluster' => $this->build_cluster_connection_array(),
'timeout' => $parameters['timeout'],
'read_timeout' => $parameters['read_timeout'],
'persistent' => $parameters['persistent'],
];
if ( isset( $parameters['password'] ) && version_compare( $version, '4.3.0', '>=' ) ) {
$args['password'] = $parameters['password'];
}
if ( version_compare( $version, '5.3.0', '>=' ) && defined( 'WP_REDIS_SSL_CONTEXT' ) && ! empty( WP_REDIS_SSL_CONTEXT ) ) {
if ( ! array_key_exists( 'password', $args ) ) {
$args['password'] = null;
}
$args['ssl'] = WP_REDIS_SSL_CONTEXT;
}
$this->redis = new RedisCluster( null, ...array_values( $args ) );
$this->diagnostics += $args;
}
} else {
$this->redis = new Redis();
$args = [
'host' => $parameters['host'],
'port' => $parameters['port'],
'timeout' => $parameters['timeout'],
'',
'retry_interval' => (int) $parameters['retry_interval'],
];
if ( version_compare( $version, '3.1.3', '>=' ) ) {
$args['read_timeout'] = $parameters['read_timeout'];
}
if ( strcasecmp( 'tls', $parameters['scheme'] ) === 0 ) {
$args['host'] = sprintf(
'%s://%s',
$parameters['scheme'],
str_replace( 'tls://', '', $parameters['host'] )
);
if ( version_compare( $version, '5.3.0', '>=' ) && defined( 'WP_REDIS_SSL_CONTEXT' ) && ! empty( WP_REDIS_SSL_CONTEXT ) ) {
$args['others']['stream'] = WP_REDIS_SSL_CONTEXT;
}
}
if ( strcasecmp( 'unix', $parameters['scheme'] ) === 0 ) {
$args['host'] = $parameters['path'];
$args['port'] = -1;
}
call_user_func_array( [ $this->redis, 'connect' ], array_values( $args ) );
if ( isset( $parameters['password'] ) ) {
$args['password'] = $parameters['password'];
$this->redis->auth( $parameters['password'] );
}
if ( isset( $parameters['database'] ) ) {
if ( ctype_digit( (string) $parameters['database'] ) ) {
$parameters['database'] = (int) $parameters['database'];
}
$args['database'] = $parameters['database'];
if ( $parameters['database'] ) {
$this->redis->select( $parameters['database'] );
}
}
$this->diagnostics += $args;
}
if ( defined( 'WP_REDIS_SERIALIZER' ) && ! empty( WP_REDIS_SERIALIZER ) ) {
$this->redis->setOption( Redis::OPT_SERIALIZER, WP_REDIS_SERIALIZER );
if ( function_exists( '_doing_it_wrong' ) ) {
_doing_it_wrong( __FUNCTION__ , 'The `WP_REDIS_SERIALIZER` configuration constant has been deprecated, use `WP_REDIS_IGBINARY` instead.', '2.3.1' );
}
}
}
/**
* Connect to Redis using the Relay extension.
*
* @param array $parameters Connection parameters built by the `build_parameters` method.
* @return void
*/
protected function connect_using_relay( $parameters ) {
$version = phpversion( 'relay' );
$this->diagnostics[ 'client' ] = sprintf( 'Relay (v%s)', $version );
if ( defined( 'WP_REDIS_SHARDS' ) ) {
throw new Exception('Relay does not support sharding.');
} elseif ( defined( 'WP_REDIS_CLUSTER' ) ) {
throw new Exception('Relay does not cluster connections.');
} else {
$this->redis = new Relay\Relay;
$args = [
'host' => $parameters['host'],
'port' => $parameters['port'],
'timeout' => $parameters['timeout'],
'',
'retry_interval' => (int) $parameters['retry_interval'],
];
$args['read_timeout'] = $parameters['read_timeout'];
if ( strcasecmp( 'tls', $parameters['scheme'] ) === 0 ) {
$args['host'] = sprintf(
'%s://%s',
$parameters['scheme'],
str_replace( 'tls://', '', $parameters['host'] )
);
if ( defined( 'WP_REDIS_SSL_CONTEXT' ) && ! empty( WP_REDIS_SSL_CONTEXT ) ) {
$args['others']['stream'] = WP_REDIS_SSL_CONTEXT;
}
}
if ( strcasecmp( 'unix', $parameters['scheme'] ) === 0 ) {
$args['host'] = $parameters['path'];
$args['port'] = -1;
}
call_user_func_array( [ $this->redis, 'connect' ], array_values( $args ) );
if ( isset( $parameters['password'] ) ) {
$args['password'] = $parameters['password'];
$this->redis->auth( $parameters['password'] );
}
if ( isset( $parameters['database'] ) ) {
if ( ctype_digit( (string) $parameters['database'] ) ) {
$parameters['database'] = (int) $parameters['database'];
}
$args['database'] = $parameters['database'];
if ( $parameters['database'] ) {
$this->redis->select( $parameters['database'] );
}
}
$this->diagnostics += $args;
}
if ( defined( 'WP_REDIS_SERIALIZER' ) && ! empty( WP_REDIS_SERIALIZER ) ) {
$this->redis->setOption( Relay\Relay::OPT_SERIALIZER, WP_REDIS_SERIALIZER );
if ( function_exists( '_doing_it_wrong' ) ) {
_doing_it_wrong( __FUNCTION__ , 'The `WP_REDIS_SERIALIZER` configuration constant has been deprecated, use `WP_REDIS_IGBINARY` instead.', '2.3.1' );
}
}
}
/**
* Connect to Redis using the Predis library.
*
* @param array $parameters Connection parameters built by the `build_parameters` method.
* @throws \Exception If the Predis library was not found or is unreadable.
* @return void
*/
protected function connect_using_predis( $parameters ) {
$client = 'Predis';
// Load bundled Predis library.
if ( ! class_exists( 'Predis\Client' ) ) {
$predis = '/dependencies/predis/predis/autoload.php';
$pluginDir = defined( 'WP_PLUGIN_DIR' ) ? WP_PLUGIN_DIR . '/redis-cache' : null;
$contentDir = defined( 'WP_CONTENT_DIR' ) ? WP_CONTENT_DIR . '/plugins/redis-cache' : null;
$pluginPath = defined( 'WP_REDIS_PLUGIN_PATH' ) ? WP_REDIS_PLUGIN_PATH : null;
if ( $pluginDir && is_readable( $pluginDir . $predis ) ) {
require_once $pluginDir . $predis;
} elseif ( $contentDir && is_readable( $contentDir . $predis ) ) {
require_once $contentDir . $predis;
} elseif ( $pluginPath && is_readable( $pluginPath . $predis ) ) {
require_once $pluginPath . $predis;
} else {
throw new Exception(
'Predis library not found. Re-install Redis Cache plugin or delete the object-cache.php.'
);
}
}
$servers = false;
$options = [];
if ( defined( 'WP_REDIS_SHARDS' ) ) {
$servers = WP_REDIS_SHARDS;
$parameters['shards'] = $servers;
} elseif ( defined( 'WP_REDIS_SENTINEL' ) ) {
$servers = WP_REDIS_SERVERS;
$parameters['servers'] = $servers;
$options['replication'] = 'sentinel';
$options['service'] = WP_REDIS_SENTINEL;
} elseif ( defined( 'WP_REDIS_SERVERS' ) ) {
$servers = WP_REDIS_SERVERS;
$parameters['servers'] = $servers;
$options['replication'] = 'predis';
} elseif ( defined( 'WP_REDIS_CLUSTER' ) ) {
$servers = $this->build_cluster_connection_array();
$parameters['cluster'] = $servers;
$options['cluster'] = 'redis';
}
if ( strcasecmp( 'unix', $parameters['scheme'] ) === 0 ) {
unset($parameters['host'], $parameters['port']);
}
if ( isset( $parameters['read_timeout'] ) && $parameters['read_timeout'] ) {
$parameters['read_write_timeout'] = $parameters['read_timeout'];
}
foreach ( [ 'WP_REDIS_SERVERS', 'WP_REDIS_SHARDS', 'WP_REDIS_CLUSTER' ] as $constant ) {
if ( defined( $constant ) ) {
if ( $parameters['database'] ) {
$options['parameters']['database'] = $parameters['database'];
}
if ( isset( $parameters['password'] ) ) {
if ( is_array( $parameters['password'] ) ) {
$options['parameters']['username'] = WP_REDIS_PASSWORD[0];
$options['parameters']['password'] = WP_REDIS_PASSWORD[1];
} else {
$options['parameters']['password'] = WP_REDIS_PASSWORD;
}
}
}
}
if ( isset( $parameters['password'] ) ) {
if ( is_array( $parameters['password'] ) ) {
$parameters['username'] = array_shift( $parameters['password'] );
$parameters['password'] = implode( '', $parameters['password'] );
}
if ( defined( 'WP_REDIS_USERNAME' ) ) {
$parameters['username'] = WP_REDIS_USERNAME;
}
}
if ( defined( 'WP_REDIS_SSL_CONTEXT' ) && ! empty( WP_REDIS_SSL_CONTEXT ) ) {
$parameters['ssl'] = WP_REDIS_SSL_CONTEXT;
}
$this->redis = new Predis\Client( $servers ?: $parameters, $options );
$this->redis->connect();
$this->diagnostics = array_merge(
[ 'client' => sprintf( '%s (v%s)', $client, Predis\Client::VERSION ) ],
$parameters,
$options
);
}
/**
* Connect to Redis using the Credis library.
*
* @param array $parameters Connection parameters built by the `build_parameters` method.
* @throws \Exception If the Credis library was not found or is unreadable.
* @throws \Exception If redis sharding should be configured as Credis does not support sharding.
* @throws \Exception If more than one seninel is configured as Credis does not support multiple sentinel servers.
* @return void
*/
protected function connect_using_credis( $parameters ) {
_doing_it_wrong( __FUNCTION__ , 'Credis support will be removed in future versions.' , '2.0.26' );
$client = 'Credis';
$creds_path = sprintf(
'%s/redis-cache/dependencies/colinmollenhour/credis/',
defined( 'WP_PLUGIN_DIR' ) ? WP_PLUGIN_DIR : WP_CONTENT_DIR . '/plugins'
);
$to_load = [];
if ( ! class_exists( 'Credis_Client' ) ) {
$to_load[] = 'Client.php';
}
$has_shards = defined( 'WP_REDIS_SHARDS' );
$has_sentinel = defined( 'WP_REDIS_SENTINEL' );
$has_servers = defined( 'WP_REDIS_SERVERS' );
$has_cluster = defined( 'WP_REDIS_CLUSTER' );
if ( ( $has_shards || $has_sentinel || $has_servers || $has_cluster ) && ! class_exists( 'Credis_Cluster' ) ) {
$to_load[] = 'Cluster.php';
if ( defined( 'WP_REDIS_SENTINEL' ) && ! class_exists( 'Credis_Sentinel' ) ) {
$to_load[] = 'Sentinel.php';
}
}
foreach ( $to_load as $sub_path ) {
$path = $creds_path . $sub_path;
if ( file_exists( $path ) ) {
require_once $path;
} else {
throw new Exception(
'Credis library not found. Re-install Redis Cache plugin or delete object-cache.php.'
);
}
}
if ( defined( 'WP_REDIS_SHARDS' ) ) {
throw new Exception(
'Sharding not supported by bundled Credis library. Please review your Redis Cache configuration.'
);
}