Elgg / Elgg

engine/lib/cache.php

<?php
/**
 * Elgg cache
 * Cache file interface for caching data.
 *
 * @package    Elgg.Core
 * @subpackage Cache
 */

/**
 * Returns an \ElggCache object suitable for caching system information
 *
 * @return ElggCache
 */
function elgg_get_system_cache() {
	return _elgg_services()->fileCache;
}

/**
 * Reset the system cache by deleting the caches
 *
 * @return void
 */
function elgg_reset_system_cache() {
	_elgg_services()->systemCache->reset();
}

/**
 * Saves a system cache.
 *
 * @param string $type The type or identifier of the cache
 * @param string $data The data to be saved
 * @return bool
 */
function elgg_save_system_cache($type, $data) {
	return _elgg_services()->systemCache->save($type, $data);
}

/**
 * Retrieve the contents of a system cache.
 *
 * @param string $type The type of cache to load
 * @return string
 */
function elgg_load_system_cache($type) {
	return _elgg_services()->systemCache->load($type);
}

/**
 * Is system cache enabled
 *
 * @return bool
 * @since 2.2.0
 */
function elgg_is_system_cache_enabled() {
	return _elgg_services()->systemCache->isEnabled();
}

/**
 * Enables the system disk cache.
 *
 * Uses the 'system_cache_enabled' config with a boolean value.
 * Resets the system cache.
 *
 * @return void
 */
function elgg_enable_system_cache() {
	_elgg_services()->systemCache->enable();
}

/**
 * Disables the system disk cache.
 *
 * Uses the 'system_cache_enabled' config with a boolean value.
 * Resets the system cache.
 *
 * @return void
 */
function elgg_disable_system_cache() {
	_elgg_services()->systemCache->disable();
}

/* Simplecache */

/**
 * Registers a view to simple cache.
 *
 * Simple cache is a caching mechanism that saves the output of
 * a view and its extensions into a file.
 *
 * @warning Simple cached views must take no parameters and return
 * the same content no matter who is logged in.
 *
 * @param string $view_name View name
 *
 * @return void
 * @see elgg_get_simplecache_url()
 * @since 1.8.0
 */
function elgg_register_simplecache_view($view_name) {
	_elgg_services()->simpleCache->registerView($view_name);
}

/**
 * Get the URL for the cached view.
 *
 * Recommended usage is to just pass the entire view name as the first and only arg:
 *
 * ```
 * $blog_js = elgg_get_simplecache_url('elgg/blog/save_draft.js');
 * $favicon = elgg_get_simplecache_url('favicon.ico');
 * ```
 *
 * For backwards compatibility with older versions of Elgg, this function supports
 * "js" or "css" as the first arg, with the rest of the view name as the second arg:
 *
 * ```
 * $blog_js = elgg_get_simplecache_url('js', 'elgg/blog/save_draft.js');
 * ```
 *
 * This automatically registers the view with Elgg's simplecache.
 *
 * @param string $view    The full view name
 * @param string $subview If the first arg is "css" or "js", the rest of the view name
 * @return string
 * @since 1.8.0
 */
function elgg_get_simplecache_url($view, $subview = '') {
	return _elgg_services()->simpleCache->getUrl($view, $subview);
}

/**
 * Is simple cache enabled
 *
 * @return bool
 * @since 1.8.0
 */
function elgg_is_simplecache_enabled() {
	return _elgg_services()->simpleCache->isEnabled();
}

/**
 * Enables the simple cache.
 *
 * @see elgg_register_simplecache_view()
 * @return void
 * @since 1.8.0
 */
function elgg_enable_simplecache() {
	_elgg_services()->simpleCache->enable();
}

/**
 * Disables the simple cache.
 *
 * @warning Simplecache is also purged when disabled.
 *
 * @see elgg_register_simplecache_view()
 * @return void
 * @since 1.8.0
 */
function elgg_disable_simplecache() {
	_elgg_services()->simpleCache->disable();
}

/**
 * Recursively deletes a directory, including all hidden files.
 *
 * TODO(ewinslow): Move to filesystem package
 *
 * @param string $dir   The directory
 * @param bool   $empty If true, we just empty the directory
 *
 * @return boolean Whether the dir was successfully deleted.
 * @access private
 */
function _elgg_rmdir($dir, $empty = false) {
	if (!$dir) {
		// realpath can return false
		_elgg_services()->logger->warn(__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);
}

/**
 * Deletes all cached views in the simplecache and sets the lastcache and
 * lastupdate time to 0 for every valid viewtype.
 *
 * @return bool
 * @since 1.7.4
 */
function elgg_invalidate_simplecache() {
	_elgg_services()->simpleCache->invalidate();
}

/**
 * Flush all the registered caches
 *
 * @return void
 * @since 1.11
 */
function elgg_flush_caches() {
	_elgg_services()->hooks->getEvents()->trigger('cache:flush', 'system');
}

/**
 * Checks if /cache directory has been symlinked to views simplecache directory
 *
 * @return bool
 * @access private
 */
function _elgg_is_cache_symlinked() {
	$root_path = elgg_get_root_path();
	$cache_path = elgg_get_cache_path();

	$simplecache_path = "{$cache_path}views_simplecache";
	$symlink_path = "{$root_path}cache";

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

/**
 * Symlinks /cache directory to views simplecache directory
 *
 * @return bool
 * @access private
 */
function _elgg_symlink_cache() {

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

	$root_path = elgg_get_root_path();
	$cache_path = elgg_get_cache_path();

	$simplecache_path = "{$cache_path}views_simplecache";
	$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, 0700, true);
	}

	symlink($simplecache_path, $symlink_path);

	if (_elgg_is_cache_symlinked()) {
		return true;
	}

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

/**
 * Initializes the simplecache lastcache variable and creates system cache files
 * when appropriate.
 *
 * @return void
 *
 * @access private
 */
function _elgg_cache_init() {
	_elgg_services()->simpleCache->init();
	_elgg_services()->systemCache->init();
}

/**
 * @see \Elgg\Application::loadCore Do not do work here. Just register for events.
 */
return function(\Elgg\EventsService $events, \Elgg\HooksRegistrationService $hooks) {

The parameter $hooks is not used and could be removed.

	$events->registerHandler('ready', 'system', '_elgg_cache_init');
	
	// register plugin hooks for cache reset
	$events->registerHandler('cache:flush', 'system', 'elgg_reset_system_cache');
	$events->registerHandler('cache:flush', 'system', 'elgg_invalidate_simplecache');
};