cache.php

Go to the documentation of this file.

<?php
/* Filepath Cache */

function elgg_get_system_cache() {
    global $CONFIG;

    static $FILE_PATH_CACHE;

    if (!$FILE_PATH_CACHE) {
        $FILE_PATH_CACHE = new ElggFileCache($CONFIG->dataroot . 'system_cache/');
    }

    return $FILE_PATH_CACHE;
}

function elgg_reset_system_cache() {
    $cache = elgg_get_system_cache();
    $cache->clear();
}

function elgg_save_system_cache($type, $data) {
    global $CONFIG;

    if ($CONFIG->system_cache_enabled) {
        $cache = elgg_get_system_cache();
        return $cache->save($type, $data);
    }

    return false;
}

function elgg_load_system_cache($type) {
    global $CONFIG;

    if ($CONFIG->system_cache_enabled) {
        $cache = elgg_get_system_cache();
        $cached_data = $cache->load($type);

        if ($cached_data) {
            return $cached_data;
        }
    }

    return null;
}

function elgg_enable_system_cache() {
    global $CONFIG;

    datalist_set('system_cache_enabled', 1);
    $CONFIG->system_cache_enabled = 1;
    elgg_reset_system_cache();
}

function elgg_disable_system_cache() {
    global $CONFIG;

    datalist_set('system_cache_enabled', 0);
    $CONFIG->system_cache_enabled = 0;
    elgg_reset_system_cache();
}

/* Simplecache */

function elgg_register_simplecache_view($view_name) {
    elgg_register_external_view($view_name, true);
}

function elgg_get_simplecache_url($type, $view) {
    // handle file type passed with view name
    if (($type === 'js' || $type === 'css') && 0 === strpos($view, $type . '/')) {
        $view = substr($view, strlen($type) + 1);
    }

    elgg_register_simplecache_view("$type/$view");
    return _elgg_get_simplecache_root() . "$type/$view";
}


function _elgg_get_simplecache_root() {
    $viewtype = elgg_get_viewtype();
    if (elgg_is_simplecache_enabled()) {
        // stored in datalist as 'simplecache_lastupdate'
        $lastcache = (int)elgg_get_config('lastcache');
    } else {
        $lastcache = 0;
    }

    return elgg_normalize_url("/cache/$lastcache/$viewtype/");
}

function _elgg_get_view_filetype($view) {
    if (preg_match('~(?:^|/)(css|js)(?:$|/)~', $view, $m)) {
        return $m[1];
    } else {
        return 'unknown';
    }
}

function elgg_is_simplecache_enabled() {
    return (bool) elgg_get_config('simplecache_enabled');
}

function elgg_enable_simplecache() {
    datalist_set('simplecache_enabled', 1);
    elgg_set_config('simplecache_enabled', 1);
    elgg_invalidate_simplecache();
}

function elgg_disable_simplecache() {
    if (elgg_get_config('simplecache_enabled')) {
        datalist_set('simplecache_enabled', 0);
        elgg_set_config('simplecache_enabled', 0);

        // purge simple cache
        _elgg_rmdir(elgg_get_data_path() . "views_simplecache");
    }
}

function _elgg_rmdir($dir) {
    $files = array_diff(scandir($dir), array('.', '..'));

    foreach ($files as $file) {
        if (is_dir("$dir/$file")) {
            _elgg_rmdir("$dir/$file");
        } else {
            unlink("$dir/$file");
        }
    }

    return rmdir($dir);
}

function elgg_invalidate_simplecache() {
    global $CONFIG;

    if (!isset($CONFIG->views->simplecache) || !is_array($CONFIG->views->simplecache)) {
        return false;
    }

    _elgg_rmdir("{$CONFIG->dataroot}views_simplecache");
    mkdir("{$CONFIG->dataroot}views_simplecache");

    $time = time();
    datalist_set("simplecache_lastupdate", $time);
    $CONFIG->lastcache = $time;

    return true;
}

function _elgg_load_cache() {
    global $CONFIG;

    $CONFIG->system_cache_loaded = false;

    $CONFIG->views = new stdClass();
    $data = elgg_load_system_cache('view_locations');
    if (!is_string($data)) {
        return;
    }
    $CONFIG->views->locations = unserialize($data);

    $data = elgg_load_system_cache('view_types');
    if (!is_string($data)) {
        return;
    }
    $CONFIG->view_types = unserialize($data);

    $CONFIG->system_cache_loaded = true;
}

function _elgg_cache_init() {
    global $CONFIG;

    if (!defined('UPGRADING') && empty($CONFIG->lastcache)) {
        $CONFIG->lastcache = (int)datalist_get('simplecache_lastupdate');
    }

    // cache system data if enabled and not loaded
    if ($CONFIG->system_cache_enabled && !$CONFIG->system_cache_loaded) {
        elgg_save_system_cache('view_locations', serialize($CONFIG->views->locations));
        elgg_save_system_cache('view_types', serialize($CONFIG->view_types));
    }

    if ($CONFIG->system_cache_enabled && !$CONFIG->i18n_loaded_from_cache) {
        reload_all_translations();
        foreach ($CONFIG->translations as $lang => $map) {
            elgg_save_system_cache("$lang.lang", serialize($map));
        }
    }
}

elgg_register_event_handler('ready', 'system', '_elgg_cache_init');