Classes List

Symfony\Component\Lock\Store\FlockStore

 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 
<?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($keyfalse);
    }

    /** * {@inheritdoc} */
    public function waitAndSave(Key $key)
    {
        $this->lock($keytrue);
    }

    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'$keytrue)), 07), '/''_')
        );

        // Silence error reporting
        set_error_handler(function ($type$msguse (&$error) { $error = $msg; });
        if (!$handle = fopen($fileName'r')) {
            if ($handle = fopen($fileName'x')) {
                chmod($fileName0444);
            } elseif (!$handle = fopen($fileName'r')) {
                usleep(100); // Give some time for chmod() to complete
                $handle = fopen($fileName'r');
            }
        }
        restore_error_handler();

        if (!$handle) {
            throw new LockStorageException($error0null);
        }

        // On Windows, even if PHP doc says the contrary, LOCK_NB works, see
        // https://bugs.php.net/54129
        if (!flock($handleLOCK_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($handleLOCK_UN | LOCK_NB);
        fclose($handle);

        $key->removeState(__CLASS__);
    }

    /** * {@inheritdoc} */
    public function exists(Key $key)
    {
        return $key->hasState(__CLASS__);
    }
}