RequestCacheService.php
1 year ago
RequestService.php
1 year ago
RequestServiceProvider.php
1 year ago
RequestCacheService.php
238 lines
| 1 | <?php |
| 2 | namespace SureCart\Request; |
| 3 | |
| 4 | /** |
| 5 | * Request caching service. |
| 6 | */ |
| 7 | class RequestCacheService { |
| 8 | /** |
| 9 | * Has this been cached yet for the request? |
| 10 | * |
| 11 | * @var boolean |
| 12 | */ |
| 13 | protected static $cached = false; |
| 14 | |
| 15 | /** |
| 16 | * The endpoint for the request |
| 17 | * |
| 18 | * @var string |
| 19 | */ |
| 20 | protected $endpoint = ''; |
| 21 | |
| 22 | /** |
| 23 | * The args for the request |
| 24 | * |
| 25 | * @var array |
| 26 | */ |
| 27 | protected $args = []; |
| 28 | |
| 29 | /** |
| 30 | * The cache key on the account. |
| 31 | * |
| 32 | * @var string |
| 33 | */ |
| 34 | protected $account_cache_key = ''; |
| 35 | |
| 36 | /** |
| 37 | * Needs an endpoint and args |
| 38 | * |
| 39 | * @param string $endpoint The endpoint for the request. |
| 40 | * @param array $args The args for the request. |
| 41 | * @param string $account_cache_key The key on the account model to check for cache. |
| 42 | */ |
| 43 | public function __construct( $endpoint, $args, $account_cache_key ) { |
| 44 | $this->endpoint = $endpoint; |
| 45 | $this->args = $args; |
| 46 | $this->account_cache_key = $account_cache_key; |
| 47 | } |
| 48 | |
| 49 | /** |
| 50 | * Can we use transient caching. |
| 51 | * |
| 52 | * @return boolean |
| 53 | */ |
| 54 | public function canUseTransient() { |
| 55 | $expand = $this->args['query']['expand'] ?? []; |
| 56 | // if any expand has nested expansion, do not cache. |
| 57 | foreach ( $expand as $item ) { |
| 58 | if ( strpos( '.', $item ) !== false ) { |
| 59 | return false; |
| 60 | } |
| 61 | } |
| 62 | return true; |
| 63 | } |
| 64 | |
| 65 | /** |
| 66 | * Get the object cache key. |
| 67 | * |
| 68 | * @return string |
| 69 | */ |
| 70 | public function getObjectCacheKey() { |
| 71 | return $this->endpoint . wp_json_encode( $this->args ); |
| 72 | } |
| 73 | |
| 74 | /** |
| 75 | * Get the transient cache key. |
| 76 | * |
| 77 | * @return string |
| 78 | */ |
| 79 | public function getTransientCacheKey() { |
| 80 | $timestamp = \SureCart::account()->cache_keys->{$this->account_cache_key} ?? 0; |
| 81 | if ( ! $timestamp ) { |
| 82 | return ''; |
| 83 | } |
| 84 | // we need to hash this this because there is a limit on string size for the key on the options table. |
| 85 | return wp_hash( $this->endpoint . wp_json_encode( $this->args ) . $timestamp ); |
| 86 | } |
| 87 | |
| 88 | /** |
| 89 | * Set the cache. |
| 90 | * |
| 91 | * @param mixed $data Data to set. |
| 92 | * @param string $type The type of cache to set. |
| 93 | * |
| 94 | * @return boolean |
| 95 | */ |
| 96 | public function setCache( $data, $type ) { |
| 97 | switch ( $type ) { |
| 98 | case 'object': |
| 99 | return $this->setObjectCache( $data ); |
| 100 | case 'transient': |
| 101 | return $this->setTransientCache( $data ); |
| 102 | } |
| 103 | return false; |
| 104 | } |
| 105 | |
| 106 | /** |
| 107 | * Set the object cache. |
| 108 | * |
| 109 | * @param mixed $data Data to set. |
| 110 | * |
| 111 | * @return boolean |
| 112 | */ |
| 113 | public function setObjectCache( $data ) { |
| 114 | $object_cache_key = $this->getObjectCacheKey(); |
| 115 | // set in object cache. |
| 116 | if ( $object_cache_key ) { |
| 117 | return wp_cache_set( $object_cache_key, $data ); |
| 118 | } |
| 119 | return false; |
| 120 | } |
| 121 | |
| 122 | /** |
| 123 | * Get request from object cache. |
| 124 | * |
| 125 | * @return mixed |
| 126 | */ |
| 127 | public function getObjectCache() { |
| 128 | // we cache this so we can request it several times. |
| 129 | $object_cache_key = $this->getObjectCacheKey(); |
| 130 | |
| 131 | // flush the cache on the first request to clear any redis caching. |
| 132 | if ( ! self::$cached ) { |
| 133 | wp_cache_flush(); |
| 134 | self::$cached = true; |
| 135 | } |
| 136 | |
| 137 | // already made the request this cycle. |
| 138 | return wp_cache_get( $object_cache_key ); |
| 139 | } |
| 140 | |
| 141 | /** |
| 142 | * Set the transient cache. |
| 143 | * |
| 144 | * @param mixed $data Data to set. |
| 145 | * |
| 146 | * @return boolean |
| 147 | */ |
| 148 | public function setTransientCache( $data ) { |
| 149 | if ( ! $this->canUseTransient() ) { |
| 150 | return false; |
| 151 | } |
| 152 | |
| 153 | $transient_cache_key = $this->getTransientCacheKey(); |
| 154 | if ( $transient_cache_key ) { |
| 155 | return set_transient( $transient_cache_key, $data, 60 * MINUTE_IN_SECONDS ); |
| 156 | } |
| 157 | return false; |
| 158 | } |
| 159 | |
| 160 | /** |
| 161 | * Get the transient cache. |
| 162 | * |
| 163 | * @return mixed |
| 164 | */ |
| 165 | public function getTransientCache() { |
| 166 | if ( ! $this->canUseTransient() ) { |
| 167 | return false; |
| 168 | } |
| 169 | return get_transient( $this->getTransientCacheKey() ); |
| 170 | } |
| 171 | |
| 172 | /** |
| 173 | * Get the previous cache key. |
| 174 | * |
| 175 | * @return string |
| 176 | */ |
| 177 | public function getPreviousCacheKey() { |
| 178 | $timestamp = \SureCart::account()->cache_keys->{$this->account_cache_key} ?? 0; |
| 179 | if ( ! $timestamp ) { |
| 180 | return ''; |
| 181 | } |
| 182 | // we need to hash this this because there is a limit on string size for the key on the options table. |
| 183 | return wp_hash( 'sc_previous' . $this->endpoint . wp_json_encode( $this->args ) . $timestamp ); |
| 184 | } |
| 185 | |
| 186 | /** |
| 187 | * Set the previous cache. |
| 188 | * |
| 189 | * @param mixed $data Data to set. |
| 190 | * |
| 191 | * @return boolean |
| 192 | */ |
| 193 | public function setPreviousCache( $data ) { |
| 194 | $cache_key = $this->getPreviousCacheKey(); |
| 195 | if ( $cache_key ) { |
| 196 | return update_option( $cache_key, $data, false ); |
| 197 | } |
| 198 | return false; |
| 199 | } |
| 200 | |
| 201 | /** |
| 202 | * Get the previous cache. |
| 203 | * |
| 204 | * @return mixed |
| 205 | */ |
| 206 | public function getPreviousCache() { |
| 207 | return get_option( $this->getPreviousCacheKey() ); |
| 208 | } |
| 209 | |
| 210 | /** |
| 211 | * Get the previous cache updating key. |
| 212 | * |
| 213 | * @return mixed |
| 214 | */ |
| 215 | public function getPreviousCacheUpdatingKey() { |
| 216 | return $this->endpoint . '_updating'; |
| 217 | } |
| 218 | |
| 219 | /** |
| 220 | * Set the previous cache updating state. |
| 221 | * |
| 222 | * @param mixed $state State to set. |
| 223 | * @return mixed |
| 224 | */ |
| 225 | public function setPreviousCacheUpdatingState( $state ) { |
| 226 | return update_option( $this->getPreviousCacheUpdatingKey(), $state, false ); |
| 227 | } |
| 228 | |
| 229 | /** |
| 230 | * Get the previous cache updating state. |
| 231 | * |
| 232 | * @return mixed |
| 233 | */ |
| 234 | public function getPreviousCacheUpdatingState() { |
| 235 | return get_option( $this->getPreviousCacheUpdatingKey() ); |
| 236 | } |
| 237 | } |
| 238 |