183 lines
4.4 KiB
PHP
183 lines
4.4 KiB
PHP
|
|
<?php
|
||
|
|
/*
|
||
|
|
* Copyright 2016 Google Inc.
|
||
|
|
*
|
||
|
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
||
|
|
* you may not use this file except in compliance with the License.
|
||
|
|
* You may obtain a copy of the License at
|
||
|
|
*
|
||
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
||
|
|
*
|
||
|
|
* Unless required by applicable law or agreed to in writing, software
|
||
|
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
||
|
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||
|
|
* See the License for the specific language governing permissions and
|
||
|
|
* limitations under the License.
|
||
|
|
*/
|
||
|
|
|
||
|
|
namespace Google\Auth\Cache;
|
||
|
|
|
||
|
|
use Psr\Cache\CacheItemInterface;
|
||
|
|
use Psr\Cache\CacheItemPoolInterface;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Simple in-memory cache implementation.
|
||
|
|
*/
|
||
|
|
final class MemoryCacheItemPool implements CacheItemPoolInterface
|
||
|
|
{
|
||
|
|
/**
|
||
|
|
* @var CacheItemInterface[]
|
||
|
|
*/
|
||
|
|
private $items;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @var CacheItemInterface[]
|
||
|
|
*/
|
||
|
|
private $deferredItems;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* {@inheritdoc}
|
||
|
|
*
|
||
|
|
* @return CacheItemInterface The corresponding Cache Item.
|
||
|
|
*/
|
||
|
|
public function getItem($key): CacheItemInterface
|
||
|
|
{
|
||
|
|
return current($this->getItems([$key])); // @phpstan-ignore-line
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* {@inheritdoc}
|
||
|
|
*
|
||
|
|
* @return iterable<CacheItemInterface>
|
||
|
|
* A traversable collection of Cache Items keyed by the cache keys of
|
||
|
|
* each item. A Cache item will be returned for each key, even if that
|
||
|
|
* key is not found. However, if no keys are specified then an empty
|
||
|
|
* traversable MUST be returned instead.
|
||
|
|
*/
|
||
|
|
public function getItems(array $keys = []): iterable
|
||
|
|
{
|
||
|
|
$items = [];
|
||
|
|
foreach ($keys as $key) {
|
||
|
|
$items[$key] = $this->hasItem($key) ? clone $this->items[$key] : new TypedItem($key);
|
||
|
|
}
|
||
|
|
|
||
|
|
return $items;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* {@inheritdoc}
|
||
|
|
*
|
||
|
|
* @return bool
|
||
|
|
* True if item exists in the cache, false otherwise.
|
||
|
|
*/
|
||
|
|
public function hasItem($key): bool
|
||
|
|
{
|
||
|
|
$this->isValidKey($key);
|
||
|
|
|
||
|
|
return isset($this->items[$key]) && $this->items[$key]->isHit();
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* {@inheritdoc}
|
||
|
|
*
|
||
|
|
* @return bool
|
||
|
|
* True if the pool was successfully cleared. False if there was an error.
|
||
|
|
*/
|
||
|
|
public function clear(): bool
|
||
|
|
{
|
||
|
|
$this->items = [];
|
||
|
|
$this->deferredItems = [];
|
||
|
|
|
||
|
|
return true;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* {@inheritdoc}
|
||
|
|
*
|
||
|
|
* @return bool
|
||
|
|
* True if the item was successfully removed. False if there was an error.
|
||
|
|
*/
|
||
|
|
public function deleteItem($key): bool
|
||
|
|
{
|
||
|
|
return $this->deleteItems([$key]);
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* {@inheritdoc}
|
||
|
|
*
|
||
|
|
* @return bool
|
||
|
|
* True if the items were successfully removed. False if there was an error.
|
||
|
|
*/
|
||
|
|
public function deleteItems(array $keys): bool
|
||
|
|
{
|
||
|
|
array_walk($keys, [$this, 'isValidKey']);
|
||
|
|
|
||
|
|
foreach ($keys as $key) {
|
||
|
|
unset($this->items[$key]);
|
||
|
|
}
|
||
|
|
|
||
|
|
return true;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* {@inheritdoc}
|
||
|
|
*
|
||
|
|
* @return bool
|
||
|
|
* True if the item was successfully persisted. False if there was an error.
|
||
|
|
*/
|
||
|
|
public function save(CacheItemInterface $item): bool
|
||
|
|
{
|
||
|
|
$this->items[$item->getKey()] = $item;
|
||
|
|
|
||
|
|
return true;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* {@inheritdoc}
|
||
|
|
*
|
||
|
|
* @return bool
|
||
|
|
* False if the item could not be queued or if a commit was attempted and failed. True otherwise.
|
||
|
|
*/
|
||
|
|
public function saveDeferred(CacheItemInterface $item): bool
|
||
|
|
{
|
||
|
|
$this->deferredItems[$item->getKey()] = $item;
|
||
|
|
|
||
|
|
return true;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* {@inheritdoc}
|
||
|
|
*
|
||
|
|
* @return bool
|
||
|
|
* True if all not-yet-saved items were successfully saved or there were none. False otherwise.
|
||
|
|
*/
|
||
|
|
public function commit(): bool
|
||
|
|
{
|
||
|
|
foreach ($this->deferredItems as $item) {
|
||
|
|
$this->save($item);
|
||
|
|
}
|
||
|
|
|
||
|
|
$this->deferredItems = [];
|
||
|
|
|
||
|
|
return true;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Determines if the provided key is valid.
|
||
|
|
*
|
||
|
|
* @param string $key
|
||
|
|
* @return bool
|
||
|
|
* @throws InvalidArgumentException
|
||
|
|
*/
|
||
|
|
private function isValidKey($key)
|
||
|
|
{
|
||
|
|
$invalidCharacters = '{}()/\\\\@:';
|
||
|
|
|
||
|
|
if (!is_string($key) || preg_match("#[$invalidCharacters]#", $key)) {
|
||
|
|
throw new InvalidArgumentException('The provided key is not valid: ' . var_export($key, true));
|
||
|
|
}
|
||
|
|
|
||
|
|
return true;
|
||
|
|
}
|
||
|
|
}
|