FileCache.php in Zircon Profile 8

Namespace

Doctrine\Common\Cache

File

vendor/doctrine/cache/lib/Doctrine/Common/Cache/FileCache.php

<?php

/*
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * This software consists of voluntary contributions made by many individuals
 * and is licensed under the MIT license. For more information, see
 * <http://www.doctrine-project.org>.
 */
namespace Doctrine\Common\Cache;


/**
 * Base file cache driver.
 *
 * @since  2.3
 * @author Fabio B. Silva <[e-mail]>
 */
abstract class FileCache extends CacheProvider {

  /**
   * The cache directory.
   *
   * @var string
   */
  protected $directory;

  /**
   * The cache file extension.
   *
   * @var string
   */
  private $extension;

  /**
   * @var string[] regular expressions for replacing disallowed characters in file name
   */
  private $disallowedCharacterPatterns = array(
    '/\\-/',
    // replaced to disambiguate original `-` and `-` derived from replacements
    '/[^a-zA-Z0-9\\-_\\[\\]]/',
  );

  /**
   * @var string[] replacements for disallowed file characters
   */
  private $replacementCharacters = array(
    '__',
    '-',
  );

  /**
   * @var int
   */
  private $umask;

  /**
   * Constructor.
   *
   * @param string $directory The cache directory.
   * @param string $extension The cache file extension.
   *
   * @throws \InvalidArgumentException
   */
  public function __construct($directory, $extension = '', $umask = 02) {

    // YES, this needs to be *before* createPathIfNeeded()
    if (!is_int($umask)) {
      throw new \InvalidArgumentException(sprintf('The umask parameter is required to be integer, was: %s', gettype($umask)));
    }
    $this->umask = $umask;
    if (!$this
      ->createPathIfNeeded($directory)) {
      throw new \InvalidArgumentException(sprintf('The directory "%s" does not exist and could not be created.', $directory));
    }
    if (!is_writable($directory)) {
      throw new \InvalidArgumentException(sprintf('The directory "%s" is not writable.', $directory));
    }

    // YES, this needs to be *after* createPathIfNeeded()
    $this->directory = realpath($directory);
    $this->extension = (string) $extension;
  }

  /**
   * Gets the cache directory.
   *
   * @return string
   */
  public function getDirectory() {
    return $this->directory;
  }

  /**
   * Gets the cache file extension.
   *
   * @return string|null
   */
  public function getExtension() {
    return $this->extension;
  }

  /**
   * @param string $id
   *
   * @return string
   */
  protected function getFilename($id) {
    return $this->directory . DIRECTORY_SEPARATOR . implode(str_split(hash('sha256', $id), 2), DIRECTORY_SEPARATOR) . DIRECTORY_SEPARATOR . preg_replace($this->disallowedCharacterPatterns, $this->replacementCharacters, $id) . $this->extension;
  }

  /**
   * {@inheritdoc}
   */
  protected function doDelete($id) {
    return @unlink($this
      ->getFilename($id));
  }

  /**
   * {@inheritdoc}
   */
  protected function doFlush() {
    foreach ($this
      ->getIterator() as $name => $file) {
      @unlink($name);
    }
    return true;
  }

  /**
   * {@inheritdoc}
   */
  protected function doGetStats() {
    $usage = 0;
    foreach ($this
      ->getIterator() as $file) {
      $usage += $file
        ->getSize();
    }
    $free = disk_free_space($this->directory);
    return array(
      Cache::STATS_HITS => null,
      Cache::STATS_MISSES => null,
      Cache::STATS_UPTIME => null,
      Cache::STATS_MEMORY_USAGE => $usage,
      Cache::STATS_MEMORY_AVAILABLE => $free,
    );
  }

  /**
   * Create path if needed.
   *
   * @param string $path
   * @return bool TRUE on success or if path already exists, FALSE if path cannot be created.
   */
  private function createPathIfNeeded($path) {
    if (!is_dir($path)) {
      if (false === @mkdir($path, 0777 & ~$this->umask, true) && !is_dir($path)) {
        return false;
      }
    }
    return true;
  }

  /**
   * Writes a string content to file in an atomic way.
   *
   * @param string $filename Path to the file where to write the data.
   * @param string $content  The content to write
   *
   * @return bool TRUE on success, FALSE if path cannot be created, if path is not writable or an any other error.
   */
  protected function writeFile($filename, $content) {
    $filepath = pathinfo($filename, PATHINFO_DIRNAME);
    if (!$this
      ->createPathIfNeeded($filepath)) {
      return false;
    }
    if (!is_writable($filepath)) {
      return false;
    }
    $tmpFile = tempnam($filepath, 'swap');
    @chmod($tmpFile, 0666 & ~$this->umask);
    if (file_put_contents($tmpFile, $content) !== false) {
      if (@rename($tmpFile, $filename)) {
        return true;
      }
      @unlink($tmpFile);
    }
    return false;
  }

  /**
   * @return \Iterator
   */
  private function getIterator() {
    return new \RegexIterator(new \RecursiveIteratorIterator(new \RecursiveDirectoryIterator($this->directory)), '/^.+' . preg_quote($this->extension, '/') . '$/i');
  }

}

Classes

Name	Description
FileCache	Base file cache driver.