* * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. */ namespace Symfony\Component\Lock\Store; use Psr\Log\LoggerAwareInterface; use Psr\Log\LoggerAwareTrait; use Psr\Log\NullLogger; use Symfony\Component\Lock\Exception\InvalidArgumentException; use Symfony\Component\Lock\Exception\LockConflictedException; use Symfony\Component\Lock\Exception\NotSupportedException; use Symfony\Component\Lock\Key; use Symfony\Component\Lock\StoreInterface; use Symfony\Component\Lock\Strategy\StrategyInterface; /** * CombinedStore is a StoreInterface implementation able to manage and synchronize several StoreInterfaces. * * @author Jérémy Derussé */ class CombinedStore implements StoreInterface, LoggerAwareInterface { use ExpiringStoreTrait; use LoggerAwareTrait; /** @var StoreInterface[] */ private $stores; /** @var StrategyInterface */ private $strategy; /** * @param StoreInterface[] $stores The list of synchronized stores * * @throws InvalidArgumentException */ public function __construct(array $stores, StrategyInterface $strategy) { foreach ($stores as $store) { if (!$store instanceof StoreInterface) { throw new InvalidArgumentException(sprintf('The store must implement "%s". Got "%s".', StoreInterface::class, \get_class($store))); } } $this->stores = $stores; $this->strategy = $strategy; $this->logger = new NullLogger(); } /** * {@inheritdoc} */ public function save(Key $key) { $successCount = 0; $failureCount = 0; $storesCount = \count($this->stores); foreach ($this->stores as $store) { try { $store->save($key); ++$successCount; } catch (\Exception $e) { $this->logger->warning('One store failed to save the "{resource}" lock.', ['resource' => $key, 'store' => $store, 'exception' => $e]); ++$failureCount; } if (!$this->strategy->canBeMet($failureCount, $storesCount)) { break; } } $this->checkNotExpired($key); if ($this->strategy->isMet($successCount, $storesCount)) { return; } $this->logger->warning('Failed to store the "{resource}" lock. Quorum has not been met.', ['resource' => $key, 'success' => $successCount, 'failure' => $failureCount]); // clean up potential locks $this->delete($key); throw new LockConflictedException(); } public function waitAndSave(Key $key) { throw new NotSupportedException(sprintf('The store "%s" does not support blocking locks.', static::class)); } /** * {@inheritdoc} */ public function putOffExpiration(Key $key, $ttl) { $successCount = 0; $failureCount = 0; $storesCount = \count($this->stores); $expireAt = microtime(true) + $ttl; foreach ($this->stores as $store) { try { if (0.0 >= $adjustedTtl = $expireAt - microtime(true)) { $this->logger->warning('Stores took to long to put off the expiration of the "{resource}" lock.', ['resource' => $key, 'store' => $store, 'ttl' => $ttl]); $key->reduceLifetime(0); break; } $store->putOffExpiration($key, $adjustedTtl); ++$successCount; } catch (\Exception $e) { $this->logger->warning('One store failed to put off the expiration of the "{resource}" lock.', ['resource' => $key, 'store' => $store, 'exception' => $e]); ++$failureCount; } if (!$this->strategy->canBeMet($failureCount, $storesCount)) { break; } } $this->checkNotExpired($key); if ($this->strategy->isMet($successCount, $storesCount)) { return; } $this->logger->warning('Failed to define the expiration for the "{resource}" lock. Quorum has not been met.', ['resource' => $key, 'success' => $successCount, 'failure' => $failureCount]); // clean up potential locks $this->delete($key); throw new LockConflictedException(); } /** * {@inheritdoc} */ public function delete(Key $key) { foreach ($this->stores as $store) { try { $store->delete($key); } catch (\Exception $e) { $this->logger->notice('One store failed to delete the "{resource}" lock.', ['resource' => $key, 'store' => $store, 'exception' => $e]); } } } /** * {@inheritdoc} */ public function exists(Key $key) { $successCount = 0; $failureCount = 0; $storesCount = \count($this->stores); foreach ($this->stores as $store) { if ($store->exists($key)) { ++$successCount; } else { ++$failureCount; } if ($this->strategy->isMet($successCount, $storesCount)) { return true; } if (!$this->strategy->canBeMet($failureCount, $storesCount)) { return false; } } return false; } }