Elgg / Elgg

mod/garbagecollector/start.php

<?php
/**
 * Elgg garbage collector.
 *
 * @package ElggGarbageCollector
 */

/**
 * Garbage collection init
 *
 * @return void
 */
function garbagecollector_init() {
	$period = elgg_get_plugin_setting('period', 'garbagecollector');
	switch ($period) {
		case 'weekly':
		case 'monthly':
		case 'yearly':
			break;
		default:
			$period = 'monthly';
	}

	// Register cron hook
	elgg_register_plugin_hook_handler('cron', $period, 'garbagecollector_cron');
}

/**
 * Cron job
 *
 * @param string $hook        'cron'
 * @param string $type        interval
 * @param mixed  $returnvalue current return value
 * @param array  $params      supplied params
 *
 * @return void
 */
function garbagecollector_cron($hook, $type, $returnvalue, $params) {

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

	echo elgg_echo('garbagecollector') . "\n";

	// Now, because we are nice, trigger a plugin hook to let other plugins do some GC
	$rv = true;
	$period = elgg_get_plugin_setting('period', 'garbagecollector');
	elgg_trigger_plugin_hook('gc', 'system', ['period' => $period]);

	// Now we optimize all tables
	$tables = garbagecollector_get_tables();
	foreach ($tables as $table) {
		echo elgg_echo('garbagecollector:optimize', [$table]);

		if (garbagecollector_optimize_table($table) !== false) {
			echo elgg_echo('ok');
		} else {
			echo elgg_echo('error');
		}

		echo "\n";
	}

	echo elgg_echo('garbagecollector:done');
}

/**
 * Get array of table names
 *
 * @return array
 */
function garbagecollector_get_tables() {
	static $tables;

	if (isset($tables)) {
		return $tables;
	}

	$table_prefix = elgg_get_config('dbprefix');
	$result = get_data("SHOW TABLES LIKE '$table_prefix%'");

	$tables = [];
	if (is_array($result) && !empty($result)) {
		foreach ($result as $row) {
			$row = (array) $row;
			if (is_array($row) && !empty($row)) {
				foreach ($row as $element) {
					$tables[] = $element;
				}
			}
		}
	}

	return $tables;
}

/**
 * Optimize a table
 *
 * @param string $table Database table name
 * @return bool
 */
function garbagecollector_optimize_table($table) {
	$table = sanitise_string($table);
	return update_data("OPTIMIZE TABLE $table");
}

return function() {
	elgg_register_event_handler('init', 'system', 'garbagecollector_init');
};