File models/behaviors/cacheable.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 326

<?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-----
 */

App::import('Lib', 'BeLib');

/**
 * CacheableBehavior class
 *
 * Used from BEObject to clean cached data when save or delete object
 * Data are meant to be cached through BeObjectCache class in libs
 *
 */
class CacheableBehavior extends ModelBehavior {

    /**
     * If the behavior is active or not
     * @var boolean
     */
    private $on = false;

    /**
     * If object cache is activate by objectCakeCache config param
     * contain instance of BeObjectCache class in libs
     *
     * @var BeObjectCache
     */
    private $BeObjectCache = null;

    private $objectsToClean = array();

    public function setup(&$model, $settings = array()) {
        if (Configure::read('objectCakeCache')) {
            $this->on = true;
            $this->BeObjectCache = BeLib::getObject('BeObjectCache');
        }
    }

    /**
     * Is CacheableBehavior on?
     *
     * @param Model $model
     * @return boolean
     */
    public function isCacheableOn(&$model) {
        return $this->on;
    }

    /**
     * Reset self::objectsToClean
     *
     * @param Model $model
     */
    public function resetObjectsToClean(&$model) {
        $this->objectsToClean = array();
    }

    /**
     * Set an array of object id to clean from cache starting from an object id
     *
     * @param Model $model
     * @param integer $objectId
     * @param array $excludeIds object ids to not clean
     * @see CacheableBehavior::getObjectsToCleanById() to see which object ids are set
     */
    public function setObjectsToClean(&$model, $objectId, array $excludeIds = array()) {
        if (!$this->on) {
            return;
        }
        $this->resetObjectsToClean($model);
        $idsToAdd = $this->getObjectsToCleanById($model, $objectId, $excludeIds);
        $this->addObjectsToClean($model, $idsToAdd);
    }

    /**
     * Return an array of object ids to clean from cache starting from $objectId
     *
     * Objects to clean:
     *  - object itself
     *  - parents
     *  - related objects
     *
     * @param Model $model
     * @param integer $objectId
     * @param array $excludeIds object ids to not clean
     */
    public function getObjectsToCleanById(&$model, $objectId, array $excludeIds = array()) {
        // get parents to clean
        $tree = ClassRegistry::init('Tree');
        $treeConditions = array('id' => $objectId);
        if (!empty($excludeIds)) {
            $treeConditions['NOT'] = array('parent_id' => $excludeIds);
        }
        $parents = $tree->find('list', array(
            'fields' => array('parent_id'),
            'conditions' => $treeConditions
        ));

        // get related object to clean
        $objectRelation = ClassRegistry::init('ObjectRelation');
        $relConditions = array('id' => $objectId);
        if (!empty($excludeIds)) {
            $relConditions['NOT'] = array('object_id' => $excludeIds);
        }
        $relatedObjects = $objectRelation->find('list', array(
            'fields' => array('object_id', 'id'),
            'conditions' => $relConditions
        ));
        $relatedObjects = array_keys($relatedObjects);

        $objectIdsToClean = array_merge(array($objectId), $parents, $relatedObjects);
        return $objectIdsToClean;
    }

    /**
     * Add object ids to delete from cache to self::objectsToClean array
     *
     * @param Model $model
     * @param array|int $ids array of ids or single id
     */
    public function addObjectsToClean(&$model, $ids = array()) {
        if (!$this->on) {
            return;
        }
        if (is_numeric($ids)) {
            $ids = array($ids);
        }
        if (!is_array($ids)) {
            return;
        }
        $this->objectsToClean = array_filter(
            array_values(
                array_unique(
                    array_merge($this->objectsToClean, $ids)
                )
            )
        );
    }

    /**
     * Get a list of IDs of all descendant sections.
     *
     * @param int $id Object ID.
     * @return array
     */
    protected function getDescendantSections($id) {
        $descendants = ClassRegistry::init('Tree')->find('all', array(
            'fields' => array('id'),
            'conditions' => array(
                'object_path LIKE' => '%/' . (int)$id . '/%',
            ),
            'joins' => array(
                array(
                    'table' => 'sections',
                    'alias' => 'Section',
                    'type' => 'INNER',
                    'conditions' => array('Section.id = Tree.id'),
                ),
            ),
        ));
        $descendants = Set::extract('/Tree/id', $descendants);

        return $descendants;
    }

    /**
     * Clear object cache
     *
     * If objectId is passed start from it to obtain all object ids to delete from cache
     * else use self::objectsToClean array that has to be build previously
     *
     * @param Model $model
     * @param integer $objectId
     * @param bool $reset
     */
    public function clearCache(&$model, $objectId, $reset = true, $descendants = true) {
        if (!$this->on) {
            return;
        }

        if ($objectId) {
            if ($reset) {
                $this->resetObjectsToClean($model);
            }

            $this->addObjectsToClean($model, $this->getObjectsToCleanById($model, $objectId));
        }

        foreach ($this->objectsToClean as $id) {
            $this->BeObjectCache->delete($id);
        }

        $notLeafs = array(Configure::read('objectTypes.area.id'), Configure::read('objectTypes.section.id'));
        if (empty($model->data['BEObject']['object_type_id']) || in_array($model->data['BEObject']['object_type_id'], $notLeafs)) {
            $this->BeObjectCache->deletePathCache($objectId, $descendants ? $this->getDescendantSections($objectId) : array());
        }

        if (!empty($this->objectsToClean)) {
            BeLib::eventManager()->trigger('ObjectCache.clear', array($this->objectsToClean));
        }
    }

    /**
     * Clear cache of an array of objects calculating from $objectIds
     *
     * @param Model $model
     * @param array $objectIds object ids from which calculate the objects to clean
     * @see CacheableBehavior::getObjectsToCleanById() to see which how object ids to clean are calculated
     */
    public function clearCacheByIds(&$model, array $objectIds) {
        if (empty($objectIds) || !$this->on) {
            return;
        }
        $this->resetObjectsToClean($model);
        $allObjectsToClean = array();
        foreach ($objectIds as $objectId) {
            $allObjectsToClean = array_merge($allObjectsToClean, $this->getObjectsToCleanById($model, $objectId));
        }
        $this->addObjectsToClean($model, $allObjectsToClean);
        foreach ($objectIds as $objectId) {
            $this->clearCache($model, $objectId, false);
        }
    }

    /**
     * beforeSave callback
     *
     * Prepare object ids that must to be cleaned from cache
     *
     * @param Model $model
     * @return boolean
     */
    public function beforeSave(&$model) {
        if ($this->on) {
            $data = $model->data[$model->name];

            if (!empty($data['id'])) {
                $this->BeObjectCache->deleteNicknameCache($model->getNicknameFromId($data['id']));
            }

            $relatedIds = array();
            if (!empty($data['RelatedObject'])) {
                foreach ($data['RelatedObject'] as $rel => $value) {
                    $relatedIds = array_merge($relatedIds, array_keys($value));
                }
                // get unique values and filter falsy values
                $relatedIds = array_filter(array_unique($relatedIds));
            }

            $treeIds = (!empty($data['destination'])) ? $data['destination'] : array();
            $excludeIdsFromQuery = array_merge($treeIds, $relatedIds);

            // prepare objects to clean
            if (!empty($data['id'])) {
                $this->setObjectsToClean($model, $data['id'], $excludeIdsFromQuery);
            }
            $this->addObjectsToClean($model, $excludeIdsFromQuery);
        }
        return true;
    }

    /**
     * afterSave callback
     *
     * If object already exists then delete cached objects listed in self::objectsToClean
     *
     * @param Model $model
     * @param boolean $created
     */
    public function afterSave(&$model, $created) {
        // if it's an update remove cache
        if ($this->on) {
            $this->addObjectsToClean($model, $model->id);
            $this->clearCache($model, $model->id, false);
        }
    }

    /**
     * beforeDelete callback
     *
     * Prepare object ids that must to be cleaned from cache
     *
     * @param Model $model
     * @param boolean $cascade
     * @return boolean
     */
    public function beforeDelete(&$model, $cascade) {
        if ($this->on) {
            $this->BeObjectCache->deleteNicknameCache($model->getNicknameFromId($model->id));
            $this->setObjectsToClean($model, $model->id);
        }
        return true;
    }

    /**
     * afterDelete callback
     *
     * Delete cached objects listed in self::objectsToClean
     *
     * @param Model $model
     */
    public function afterDelete(&$model) {
        if ($this->on) {
            $this->clearCache($model, $model->id, false);
        }
    }

}

Classes

Interfaces

Exceptions