cache.php

Go to the documentation of this file.

<?php
function elgg_get_system_cache() {
    return _elgg_services()->fileCache;
}

function elgg_reset_system_cache() {
    _elgg_services()->systemCache->reset();
}

function elgg_save_system_cache($type, $data) {
    return _elgg_services()->systemCache->save($type, $data);
}

function elgg_load_system_cache($type) {
    return _elgg_services()->systemCache->load($type);
}

function elgg_delete_system_cache($type) {
    return _elgg_services()->systemCache->delete($type);
}

function elgg_is_system_cache_enabled() {
    return _elgg_services()->systemCache->isEnabled();
}

function elgg_enable_system_cache() {
    _elgg_services()->systemCache->enable();
}

function elgg_disable_system_cache() {
    _elgg_services()->systemCache->disable();
}

/* Simplecache */

function elgg_register_simplecache_view($view_name) {
    _elgg_services()->views->registerCacheableView($view_name);
}

function elgg_get_simplecache_url($view, $subview = '') {
    return _elgg_services()->simpleCache->getUrl($view, $subview);
}

function elgg_is_simplecache_enabled() {
    return _elgg_services()->simpleCache->isEnabled();
}

function elgg_enable_simplecache() {
    _elgg_services()->simpleCache->enable();
}

function elgg_disable_simplecache() {
    _elgg_services()->simpleCache->disable();
}

function _elgg_rmdir($dir, $empty = false) {
    if (empty($dir)) {
        // realpath can return false
        _elgg_services()->logger->warning(__FUNCTION__ . ' called with empty $dir');
        return true;
    }
    if (!is_dir($dir)) {
        return true;
    }

    $files = array_diff(scandir($dir), ['.', '..']);
    
    foreach ($files as $file) {
        if (is_dir("$dir/$file")) {
            _elgg_rmdir("$dir/$file");
        } else {
            unlink("$dir/$file");
        }
    }

    if ($empty) {
        return true;
    }
    
    return rmdir($dir);
}

function elgg_invalidate_simplecache() {
    _elgg_services()->simpleCache->invalidate();
}

function elgg_flush_caches() {
    // this event sequence could take while, make sure there is no timeout
    set_time_limit(0);
    
    _elgg_services()->events->triggerSequence('cache:flush', 'system');
}

function _elgg_is_cache_symlinked() {
    $root_path = elgg_get_root_path();

    $simplecache_path = elgg_get_asset_path();
    $symlink_path = "{$root_path}cache";

    if (!is_dir($simplecache_path)) {
        return false;
    }
    return is_dir($symlink_path) && realpath($simplecache_path) == realpath($symlink_path);
}

function _elgg_symlink_cache() {

    if (_elgg_is_cache_symlinked()) {
        // Symlink exists, no need to proceed
        return true;
    }

    $root_path = elgg_get_root_path();
    $simplecache_path = rtrim(elgg_get_asset_path(), '/');
    $symlink_path = "{$root_path}cache";

    if (is_dir($symlink_path)) {
        // Cache directory already exists
        // We can not proceed without overwriting files
        return false;
    }

    if (!is_dir($simplecache_path)) {
        // Views simplecache directory has not yet been created
        mkdir($simplecache_path, 0755, true);
    }

    symlink($simplecache_path, $symlink_path);

    if (_elgg_is_cache_symlinked()) {
        return true;
    }

    if (is_dir($symlink_path)) {
        unlink($symlink_path);
    }
    
    return false;
}

function _elgg_cache_init() {
    _elgg_services()->systemCache->init();
}

function _elgg_disable_caches() {
    _elgg_services()->boot->getCache()->disable();
    _elgg_services()->plugins->getCache()->disable();
    _elgg_services()->sessionCache->disable();
    _elgg_services()->dataCache->disable();
    _elgg_services()->dic_cache->getCache()->disable();
    _elgg_services()->autoloadManager->getCache()->disable();
    _elgg_services()->systemCache->getCache()->disable();
}

function _elgg_clear_caches() {
    _elgg_services()->boot->invalidateCache();
    _elgg_services()->plugins->clear();
    _elgg_services()->sessionCache->clear();
    _elgg_services()->dataCache->clear();
    _elgg_services()->dic_cache->flushAll();
    _elgg_services()->simpleCache->invalidate();
    _elgg_services()->autoloadManager->deleteCache();
    _elgg_services()->fileCache->clear();
}

function _elgg_reset_opcache() {
    if (!function_exists('opcache_reset')) {
        return;
    }
    
    opcache_reset();
}

function _elgg_enable_caches() {
    _elgg_services()->boot->getCache()->enable();
    _elgg_services()->plugins->getCache()->enable();
    _elgg_services()->sessionCache->enable();
    _elgg_services()->dataCache->enable();
    _elgg_services()->dic_cache->getCache()->enable();
    _elgg_services()->autoloadManager->getCache()->enable();
    _elgg_services()->systemCache->getCache()->enable();
}

function _elgg_rebuild_public_container() {
    $services = _elgg_services();

    $dic_builder = new \DI\ContainerBuilder(\Elgg\Di\PublicContainer::class);
    $dic_builder->useAnnotations(false);
    $dic_builder->setDefinitionCache($services->dic_cache);

    $definitions = $services->dic_loader->getDefinitions();
    foreach ($definitions as $definition) {
        $dic_builder->addDefinitions($definition);
    }

    $dic = $dic_builder->build();

    _elgg_services()->setValue('dic_builder', $dic_builder);
    _elgg_services()->setValue('dic', $dic);
}

return function(\Elgg\EventsService $events, \Elgg\HooksRegistrationService $hooks) {
    $events->registerHandler('ready', 'system', '_elgg_cache_init');

    $events->registerHandler('cache:flush:before', 'system', '_elgg_disable_caches');
    $events->registerHandler('cache:flush', 'system', '_elgg_clear_caches');
    $events->registerHandler('cache:flush', 'system', '_elgg_reset_opcache');
    $events->registerHandler('cache:flush:after', 'system', '_elgg_enable_caches');
    $events->registerHandler('cache:flush:after', 'system', '_elgg_rebuild_public_container');
};