public/Cerebro/inc/WURFL/Storage/File.php line 64

Open in your IDE?
  1. <?php
  2. /**
  3.  * Copyright (c) 2012 ScientiaMobile, Inc.
  4.  *
  5.  * This program is free software: you can redistribute it and/or modify
  6.  * it under the terms of the GNU Affero General Public License as
  7.  * published by the Free Software Foundation, either version 3 of the
  8.  * License, or (at your option) any later version.
  9.  *
  10.  * Refer to the COPYING.txt file distributed with this package.
  11.  *
  12.  * @category   WURFL
  13.  * @package    WURFL_Storage
  14.  * @copyright  ScientiaMobile, Inc.
  15.  * @license    GNU Affero General Public License
  16.  * @author     Fantayeneh Asres Gizaw
  17.  * @version    $id$
  18.  */
  19. /**
  20.  * WURFL Storage
  21.  * @package    WURFL_Storage
  22.  */
  23. class WURFL_Storage_File extends WURFL_Storage_Base {
  25.     private $defaultParams = array(
  26.         "dir" => "/tmp",
  27.         "expiration" => 0,
  28.     );
  30.     private $expire;
  31.     private $root;
  32.     
  33.     const DIR = "dir";
  35.     protected $supports_secondary_caching = true;
  36.     
  37.     public function __construct($params) {
  38.         $currentParams = is_array($params)? array_merge($this->defaultParams, $params): $this->defaultParams;
  39.         $this->initialize($currentParams);
  40.     }
  42.     public function initialize($params) {
  43.         $this->root = $params[self::DIR];
  44.         $this->createCacheDirIfNotExist();
  45.         $this->expire = $params["expiration"];
  46.     }
  47.     private function createCacheDirIfNotExist() {
  48.         if (!is_dir($this->root)) {
  49.             @mkdir ($this->root, 0777, true);
  50.             if(!is_dir($this->root)){
  51.                 throw new WURFL_Storage_Exception("The file cache directory does not exist and could not be created. Please make sure the cache directory is writeable: ".$this->root);
  52.             }
  53.         }
  54.         if(!is_writeable($this->root)){
  55.             throw new WURFL_Storage_Exception("The file cache directory is not writeable: ".$this->root);
  56.         }
  57.     }
  59.     public function load($key) {
  60.         if (($data = $this->cacheLoad($key)) !== null) {
  61.             return $data->value();
  62.         } else {
  63.             $path = $this->keyPath($key);
  64.             $value = WURFL_FileUtils::read($path);
  65.             if ($value === null) {
  66.                 return null;
  67.             }
  68.             $this->cacheSave($key, $value);
  69.             return $this->unwrap($value, $path);
  70.         }
  71.     }
  73.     private function unwrap($value, $path) {
  74.         if ($value->isExpired()) {
  75.             unlink($path);
  76.             return null;
  77.         }
  78.         return $value->value();
  79.     }
  81.     public function save($key, $value, $expiration=null) {
  82.         $value = new StorageObject($value, (($expiration === null)? $this->expire: $expiration));
  83.         $path = $this->keyPath($key);
  84.         WURFL_FileUtils::write($path, $value);
  85.     }
  87.     public function clear() {
  88.         $this->cacheClear();
  89.         WURFL_FileUtils::rmdirContents($this->root);
  90.     }
  93.     private function keyPath($key) {
  94.         return WURFL_FileUtils::join(array($this->root, $this->spread(md5($key))));
  95.     }
  97.     function spread($md5, $n = 2) {
  98.         $path = "";
  99.         for ($i = 0; $i < $n; $i++) {
  100.             $path .= $md5 [$i] . DIRECTORY_SEPARATOR;
  101.         }
  102.         $path .= substr($md5, $n);
  103.         return $path;
  104.     }
  107. }
  109. /**
  110.  * Object for storing data
  111.  * @package WURFL_Storage
  112.  */
  113. class StorageObject {
  114.     private $value;
  115.     private $expiringOn;
  117.     public function __construct($value, $expire) {
  118.         $this->value = $value;
  119.         $this->expiringOn = ($expire === 0) ? $expire : time() + $expire;
  120.     }
  122.     public function value() {
  123.         return $this->value;
  124.     }
  126.     public function isExpired() {
  127.         if ($this->expiringOn === 0) {
  128.             return false;
  129.         }
  130.         return $this->expiringOn < time();
  131.     }
  133.     public function expiringOn() {
  134.         return $this->expiringOn;
  135.     }
  137. }