friendica/include/dbclean.php

<?php
/**
 * @file include/dbclean.php
 * @brief The script is called from time to time to clean the database entries and remove orphaned data.
 */

use Friendica\Core\Config;

function dbclean_run(&$argv, &$argc) {
	if (!Config::get('system', 'dbclean', false)) {
		return;
	}

	if ($argc == 2) {
		$stage = intval($argv[1]);
	} else {
		$stage = 0;
	}

	if ($stage == 0) {
		for ($i = 1; $i <= 7; $i++) {
			if (!Config::get('system', 'finished-dbclean-'.$i)) {
				proc_run(PRIORITY_LOW, 'include/dbclean.php', $i);
			}
		}
	} else {
		remove_orphans($stage);
	}
}

/**
 * @brief Remove orphaned database entries
 */
function remove_orphans($stage = 0) {
	global $db;

	$count = 0;

	// We split the deletion in many small tasks
	$limit = 1000;

	if ($stage == 1) {
		logger("Deleting old global item entries from item table without user copy");
		$r = dba::p("SELECT `id` FROM `item` WHERE `uid` = 0
				AND NOT EXISTS (SELECT `guid` FROM `item` AS `i` WHERE `item`.`guid` = `i`.`guid` AND `i`.`uid` != 0)
				AND `received` < UTC_TIMESTAMP() - INTERVAL 90 DAY LIMIT ".intval($limit));
		$count = dba::num_rows($r);
		if ($count > 0) {
			logger("found global item orphans: ".$count);
			while ($orphan = dba::fetch($r)) {
				dba::delete('item', array('id' => $orphan["id"]));
			}
		} else {
			logger("No global item orphans found");

			// We will eventually set this value when we found a good way to delete these items in another way.
			// Config::set('system', 'finished-dbclean-1', true);
		}
		dba::close($r);
		logger("Done deleting ".$count." old global item entries from item table without user copy");
	} elseif ($stage == 2) {
		logger("Deleting items without parents");
		$r = dba::p("SELECT `id` FROM `item` WHERE NOT EXISTS (SELECT `id` FROM `item` AS `i` WHERE `item`.`parent` = `i`.`id`) LIMIT ".intval($limit));
		$count = dba::num_rows($r);
		if ($count > 0) {
			logger("found item orphans without parents: ".$count);
			while ($orphan = dba::fetch($r)) {
				dba::delete('item', array('id' => $orphan["id"]));
			}
		} else {
			logger("No item orphans without parents found");
			Config::set('system', 'finished-dbclean-2', true);
		}
		dba::close($r);
		logger("Done deleting ".$count." items without parents");
	} elseif ($stage == 3) {
		logger("Deleting orphaned data from thread table");
		$r = dba::p("SELECT `iid` FROM `thread` WHERE NOT EXISTS (SELECT `id` FROM `item` WHERE `item`.`parent` = `thread`.`iid`) LIMIT ".intval($limit));
		$count = dba::num_rows($r);
		if ($count > 0) {
			logger("found thread orphans: ".$count);
			while ($orphan = dba::fetch($r)) {
				dba::delete('thread', array('iid' => $orphan["iid"]));
			}
		} else {
			logger("No thread orphans found");
			Config::set('system', 'finished-dbclean-3', true);
		}

		dba::close($r);
		logger("Done deleting ".$count." orphaned data from thread table");
	} elseif ($stage == 4) {
		logger("Deleting orphaned data from notify table");
		$r = dba::p("SELECT `iid` FROM `notify` WHERE NOT EXISTS (SELECT `id` FROM `item` WHERE `item`.`id` = `notify`.`iid`) LIMIT ".intval($limit));
		$count = dba::num_rows($r);
		if ($count > 0) {
			logger("found notify orphans: ".$count);
			while ($orphan = dba::fetch($r)) {
				dba::delete('notify', array('iid' => $orphan["iid"]));
			}
		} else {
			logger("No notify orphans found");
			Config::set('system', 'finished-dbclean-4', true);
		}
		dba::close($r);
		logger("Done deleting ".$count." orphaned data from notify table");
	} elseif ($stage == 5) {
		logger("Deleting orphaned data from notify-threads table");
		$r = dba::p("SELECT `id` FROM `notify-threads` WHERE NOT EXISTS (SELECT `id` FROM `item` WHERE `item`.`parent` = `notify-threads`.`master-parent-item`) LIMIT ".intval($limit));
		$count = dba::num_rows($r);
		if ($count > 0) {
			logger("found notify-threads orphans: ".$count);
			while ($orphan = dba::fetch($r)) {
				dba::delete('notify-threads', array('id' => $orphan["id"]));
			}
		} else {
			logger("No notify-threads orphans found");
			Config::set('system', 'finished-dbclean-5', true);
		}
		dba::close($r);
		logger("Done deleting ".$count." orphaned data from notify-threads table");
	} elseif ($stage == 6) {
		logger("Deleting orphaned data from sign table");
		$r = dba::p("SELECT `iid` FROM `sign` WHERE NOT EXISTS (SELECT `id` FROM `item` WHERE `item`.`id` = `sign`.`iid`) LIMIT ".intval($limit));
		$count = dba::num_rows($r);
		if ($count > 0) {
			logger("found sign orphans: ".$count);
			while ($orphan = dba::fetch($r)) {
				dba::delete('sign', array('iid' => $orphan["iid"]));
			}
		} else {
			logger("No sign orphans found");
			Config::set('system', 'finished-dbclean-6', true);
		}
		dba::close($r);
		logger("Done deleting ".$count." orphaned data from sign table");
	} elseif ($stage == 7) {
		logger("Deleting orphaned data from term table");
		$r = dba::p("SELECT `oid` FROM `term` WHERE NOT EXISTS (SELECT `id` FROM `item` WHERE `item`.`id` = `term`.`oid`) LIMIT ".intval($limit));
		$count = dba::num_rows($r);
		if ($count > 0) {
			logger("found term orphans: ".$count);
			while ($orphan = dba::fetch($r)) {
				dba::delete('term', array('oid' => $orphan["oid"]));
			}
		} else {
			logger("No term orphans found");
			Config::set('system', 'finished-dbclean-7', true);
		}
		dba::close($r);
		logger("Done deleting ".$count." orphaned data from term table");
	}

	// Call it again if not all entries were purged
	if (($stage != 0) AND ($count > 0)) {
		proc_run(PRIORITY_MEDIUM, 'include/dbclean.php');
	}

}