File libs/be_object_cache.php | BEdita API doc

  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 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325

<?php
/*-----8<--------------------------------------------------------------------
 *
 * BEdita - a semantic content management framework
 *
 * Copyright 2014 ChannelWeb Srl, Chialab Srl
 *
 * This file is part of BEdita: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published
 * by the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 * BEdita is distributed WITHOUT ANY WARRANTY; without even the implied
 * warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 * See the GNU Lesser General Public License for more details.
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with BEdita (see LICENSE.LGPL).
 * If not, see <http://gnu.org/licenses/lgpl-3.0.html>.
 *
 *------------------------------------------------------------------->8-----
 */

/**
 * BeObjectCache class
 *
 * Class to read/write object data using Cake Cache
 */
class BeObjectCache {

    /**
     * Base path for objects cache on filesystem.
     *
     * @var string|null
     */
    private $baseCachePath = null;

    /**
     * Default cache config.
     *
     * It's overriden in constructor if exists a cache conf named 'objects'.
     *
     * @var array
     */
    private $cacheConfig = array(
        'engine' => 'File',
        'prefix' => '',
        'duration' => '+24 hours'
    );

    /**
     * Constructor
     * Initialize cache config
     */
    public function __construct() {
        // init cache
        $cacheConf = Cache::settings('objects');
        if (empty($cacheConf)) {
            // default cache path if not configured
            $this->cacheConfig['path'] = BEDITA_CORE_PATH . DS . 'tmp' . DS . 'cache' . DS . 'objects';
        }
        $this->cacheConfig = $cacheConf + $this->cacheConfig;
        if (!empty($this->cacheConfig['path'])) {
            $this->baseCachePath = $this->cacheConfig['path'];
        }
    }

    /**
     * Get cached path by object ID.
     *
     * @param int $id Object ID.
     * @return string
     */
    public function getPathById($id) {
        $id = $id % 1000;
        $id = str_pad($id, 3, '0', STR_PAD_LEFT);

        return $this->baseCachePath . DS . $id;
    }

    /**
     * Prepare cached config for an object to be cached.
     *
     * @param int $id Object ID.
     * @return void
     */
    private function setCacheOptions($id) {
        if (!empty($this->cacheConfig['path'])) {
            $path = $this->getPathById($id);
            if (!file_exists($path)) {
                mkdir($path);
                chmod($path, 0775);
            }
            $this->cacheConfig['path'] = $path;
        }
        Cache::set($this->cacheConfig);
    }

    /**
     * Get cache name for an object.
     *
     * @param int $id Object ID.
     * @param array $options Additional caching options.
     * @param string|null $label Additional label.
     * @return string
     */
    private function cacheName($id, array $options, $label = null) {
        if (!empty($options['bindings_list'])) {
            $strOpt = implode('', $options['bindings_list']);
        } elseif (!empty($options)) {
            $strOpt = print_r($options, true);
        }
        $label = empty($label) ? '' : '-' . $label;
        $strOpt = (!empty($strOpt)) ? '-' . md5($strOpt) : '';
        return $id . $label . $strOpt;
    }

    /**
     * Returns true if cache engine type is 'File'
     *
     * @return boolean
     */
    public function hasFileEngine() {
        return ($this->cacheConfig['engine'] === 'File');
    }

    /**
     * Read id from nickname using cache
     *
     * @param  string $nickname object nickname
     * @return int object id on success, null if $nickname is not found
     */
    public function readIdFromNickname($nickname) {
        if ($this->hasFileEngine()) {
            return null;
        }
        $cacheName = 'nickname-' . $nickname;
        return Cache::read($cacheName, 'objects');
    }

    /**
     * Writes $nickname => $id key-value pair in object cache
     *
     * @param  string $nickname object nickname
     * @param  int $id object id
     * @return boolean true on success, false on failure
     */
    public function writeNicknameId($nickname, $id) {
        if ($this->hasFileEngine()) {
            return false;
        }
        $cacheName = 'nickname-' . $nickname;
        return $this->writeIndexedCache($id, $cacheName, $id);
    }

    /**
     * Read object from cache
     *
     * @param  int $id
     * @param  array $options
     * @return data array or false if no cache is found
     */
    public function read($id, array $options, $label = null) {
        $res = false;
        $cacheName = $this->cacheName($id, $options, $label);
        // use cache config if not using 'File' engine
        if ($this->cacheConfig['engine'] !== 'File') {
            $res = Cache::read($cacheName, 'objects');
        } else {
            $this->setCacheOptions($id);
            $res = Cache::read($cacheName);
        }
        return $res;
    }

    /**
     * Write related indexes to cache
     *
     * @param int $id Object ID.
     * @param string $cacheName Cache key.
     * @param mixed $data Cache value to be stored.
     * @return bool
     */
    private function writeIndexedCache($id, $cacheName, $data) {
        $cacheIdxKey = $id . '_index';
        $cacheIdx = Cache::read($cacheIdxKey, 'objects');
        if (empty($cacheIdx)) {
            $cacheIdx = array();
        }
        if (!is_array($cacheIdx)) {
            CakeLog::write('error', sprintf('Invalid value for cache key %s: array expected, got %s', $cacheIdxKey, var_export($cacheIdx, true)));
            $cacheIdx = array();
        }
        if (!in_array($cacheName, $cacheIdx)) {
            $cacheIdx[] = $cacheName;
            $res = Cache::write($cacheIdxKey, $cacheIdx, 'objects');
            if ($res !== true) {
                CakeLog::write(
                    'error',
                    sprintf(
                        'Error writing index cache %s for object %s. Cache key %s not persisted.',
                        $cacheIdxKey,
                        $id,
                        $cacheName
                    )
                );
                return false;
            }
        }
        $res = Cache::write($cacheName, $data, 'objects');
        return $res;
    }

    /**
     * Write object data to cache
     *
     * @param  string $key
     * @return boolean True if the data was successfully cached, false on failure
     */
    public function write($id, array $options, $data, $label = null) {
        $cacheName = $this->cacheName($id, $options, $label);
        $res = false;
        // store index cache
        if (!$this->hasFileEngine()) {
            $res = $this->writeIndexedCache($id, $cacheName, $data);
        } else {
            $this->setCacheOptions($id);
            $res = Cache::write($cacheName, $data);
        }
        return $res;
    }

    /**
     * Delete objects from cache
     *
     * @param  integer $id objectId
     */
    public function delete($id, array $options = null) {
        if ($this->hasFileEngine()) {
            $cachePath = $this->getPathById($id);
            $wildCard = $cachePath . DS . $this->cacheConfig['prefix'] . $id . '-*';
            $toDelete = glob($wildCard);
            if (!empty($toDelete)) {
                array_map('unlink', $toDelete);
            }
        } else {
            $cacheIdxKey = $id . '_index';
            $cacheIdx = Cache::read($cacheIdxKey, 'objects');
            if (!empty($cacheIdx)) {
                foreach ($cacheIdx as $cacheName) {
                    Cache::delete($cacheName, 'objects');
                }
            }
            Cache::delete($cacheIdxKey, 'objects');
        }
    }

    /**
     * Read path cache for an object.
     *
     * @param int $id Object ID.
     * @param string $statuses Allowed object statuses.
     * @return array|null
     */
    public function readPathCache($id, array $statuses = array()) {
        if ($this->hasFileEngine()) {
            return null;
        }

        $status = 'on';
        if (in_array('draft', $statuses)) {
            $status = 'draft';
        }
        if (in_array('off', $statuses)) {
            $status = 'off';
        }

        return Cache::read(sprintf('path-%d-%s', (int)$id, $status), 'objects');
    }

    /**
     * Write path cache for an object.
     *
     * @param int $id Object ID.
     * @param array $path Object path.
     * @param string $statuses Allowed object statuses.
     * @return bool
     */
    public function writePathCache($id, array $path, array $statuses = array()) {
        if ($this->hasFileEngine()) {
            return false;
        }

        $status = 'on';
        if (in_array('draft', $statuses)) {
            $status = 'draft';
        }
        if (in_array('off', $statuses)) {
            $status = 'off';
        }
        return $this->writeIndexedCache($id, sprintf('path-%d-%s', (int)$id, $status), $path);
    }

    /**
     * Delete path cache for an object and all its descendants.
     *
     * @param int $id Object ID.
     * @param int[] $descendants Array of descendant IDs.
     * @return bool
     */
    public function deletePathCache($id, array $descendants) {
        if ($this->hasFileEngine()) {
            return false;
        }

        $success = true;
        $descendants = array_merge(array($id), $descendants);
        foreach ($descendants as $descId) {
            foreach (array('on', 'draft', 'off') as $status) {
                $success = Cache::delete(sprintf('path-%d-%s', (int)$descId, $status)) && $success;
            }
        }

        return $success;
    }
}

Classes

Interfaces

Exceptions