140 lines
3.7 KiB
PHP
140 lines
3.7 KiB
PHP
<?php
|
||
|
||
/*
|
||
* This file is part of the Symfony package.
|
||
*
|
||
* (c) Fabien Potencier <fabien@symfony.com>
|
||
*
|
||
* 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 Symfony\Component\Lock\Exception\InvalidArgumentException;
|
||
use Symfony\Component\Lock\Exception\LockConflictedException;
|
||
use Symfony\Component\Lock\Exception\LockStorageException;
|
||
use Symfony\Component\Lock\Key;
|
||
use Symfony\Component\Lock\StoreInterface;
|
||
|
||
/**
|
||
* FlockStore is a StoreInterface implementation using the FileSystem flock.
|
||
*
|
||
* Original implementation in \Symfony\Component\Filesystem\LockHandler.
|
||
*
|
||
* @author Jérémy Derussé <jeremy@derusse.com>
|
||
* @author Grégoire Pineau <lyrixx@lyrixx.info>
|
||
* @author Romain Neutron <imprec@gmail.com>
|
||
* @author Nicolas Grekas <p@tchwork.com>
|
||
*/
|
||
class FlockStore implements StoreInterface
|
||
{
|
||
private $lockPath;
|
||
|
||
/**
|
||
* @param string|null $lockPath the directory to store the lock, defaults to the system's temporary directory
|
||
*
|
||
* @throws LockStorageException If the lock directory doesn’t exist or is not writable
|
||
*/
|
||
public function __construct($lockPath = null)
|
||
{
|
||
if (null === $lockPath) {
|
||
$lockPath = sys_get_temp_dir();
|
||
}
|
||
if (!is_dir($lockPath) || !is_writable($lockPath)) {
|
||
throw new InvalidArgumentException(sprintf('The directory "%s" is not writable.', $lockPath));
|
||
}
|
||
|
||
$this->lockPath = $lockPath;
|
||
}
|
||
|
||
/**
|
||
* {@inheritdoc}
|
||
*/
|
||
public function save(Key $key)
|
||
{
|
||
$this->lock($key, false);
|
||
}
|
||
|
||
/**
|
||
* {@inheritdoc}
|
||
*/
|
||
public function waitAndSave(Key $key)
|
||
{
|
||
$this->lock($key, true);
|
||
}
|
||
|
||
private function lock(Key $key, $blocking)
|
||
{
|
||
// The lock is maybe already acquired.
|
||
if ($key->hasState(__CLASS__)) {
|
||
return;
|
||
}
|
||
|
||
$fileName = sprintf('%s/sf.%s.%s.lock',
|
||
$this->lockPath,
|
||
preg_replace('/[^a-z0-9\._-]+/i', '-', $key),
|
||
strtr(substr(base64_encode(hash('sha256', $key, true)), 0, 7), '/', '_')
|
||
);
|
||
|
||
// Silence error reporting
|
||
set_error_handler(function ($type, $msg) use (&$error) { $error = $msg; });
|
||
if (!$handle = fopen($fileName, 'r+') ?: fopen($fileName, 'r')) {
|
||
if ($handle = fopen($fileName, 'x')) {
|
||
chmod($fileName, 0666);
|
||
} elseif (!$handle = fopen($fileName, 'r+') ?: fopen($fileName, 'r')) {
|
||
usleep(100); // Give some time for chmod() to complete
|
||
$handle = fopen($fileName, 'r+') ?: fopen($fileName, 'r');
|
||
}
|
||
}
|
||
restore_error_handler();
|
||
|
||
if (!$handle) {
|
||
throw new LockStorageException($error, 0, null);
|
||
}
|
||
|
||
// On Windows, even if PHP doc says the contrary, LOCK_NB works, see
|
||
// https://bugs.php.net/54129
|
||
if (!flock($handle, \LOCK_EX | ($blocking ? 0 : \LOCK_NB))) {
|
||
fclose($handle);
|
||
throw new LockConflictedException();
|
||
}
|
||
|
||
$key->setState(__CLASS__, $handle);
|
||
}
|
||
|
||
/**
|
||
* {@inheritdoc}
|
||
*/
|
||
public function putOffExpiration(Key $key, $ttl)
|
||
{
|
||
// do nothing, the flock locks forever.
|
||
}
|
||
|
||
/**
|
||
* {@inheritdoc}
|
||
*/
|
||
public function delete(Key $key)
|
||
{
|
||
// The lock is maybe not acquired.
|
||
if (!$key->hasState(__CLASS__)) {
|
||
return;
|
||
}
|
||
|
||
$handle = $key->getState(__CLASS__);
|
||
|
||
flock($handle, \LOCK_UN | \LOCK_NB);
|
||
fclose($handle);
|
||
|
||
$key->removeState(__CLASS__);
|
||
}
|
||
|
||
/**
|
||
* {@inheritdoc}
|
||
*/
|
||
public function exists(Key $key)
|
||
{
|
||
return $key->hasState(__CLASS__);
|
||
}
|
||
}
|