friendica/src/Database/PostUpdate.php

<?php
/**
 * @file src/Database/PostUpdate.php
 */
namespace Friendica\Database;

use Friendica\Core\Config;
use Friendica\Model\Contact;
use Friendica\Model\Item;
use Friendica\Model\ItemURI;
use Friendica\Model\PermissionSet;
use Friendica\Database\DBA;

require_once 'include/dba.php';

/**
 * Post update functions
 */
class PostUpdate
{
	/**
	 * @brief Calls the post update functions
	 */
	public static function update()
	{
		if (!self::update1194()) {
			return false;
		}
		if (!self::update1198()) {
			return false;
		}
		if (!self::update1206()) {
			return false;
		}
		if (!self::update1279()) {
			return false;
		}
		if (!self::update1281()) {
			return false;
		}

		return true;
	}

	/**
	 * @brief Updates the "global" field in the item table
	 *
	 * @return bool "true" when the job is done
	 */
	private static function update1194()
	{
		// Was the script completed?
		if (Config::get("system", "post_update_version") >= 1194) {
			return true;
		}

		logger("Start", LOGGER_DEBUG);

		$end_id = Config::get("system", "post_update_1194_end");
		if (!$end_id) {
			$r = q("SELECT `id` FROM `item` WHERE `uid` != 0 ORDER BY `id` DESC LIMIT 1");
			if ($r) {
				Config::set("system", "post_update_1194_end", $r[0]["id"]);
				$end_id = Config::get("system", "post_update_1194_end");
			}
		}

		logger("End ID: ".$end_id, LOGGER_DEBUG);

		$start_id = Config::get("system", "post_update_1194_start");

		$query1 = "SELECT `item`.`id` FROM `item` ";

		$query2 = "INNER JOIN `item` AS `shadow` ON `item`.`uri` = `shadow`.`uri` AND `shadow`.`uid` = 0 ";

		$query3 = "WHERE `item`.`uid` != 0 AND `item`.`id` >= %d AND `item`.`id` <= %d
				AND `item`.`visible` AND NOT `item`.`private`
				AND NOT `item`.`deleted` AND NOT `item`.`moderated`
				AND `item`.`network` IN ('%s', '%s', '%s', '')
				AND NOT `item`.`global`";

		$r = q($query1.$query2.$query3."  ORDER BY `item`.`id` LIMIT 1",
			intval($start_id), intval($end_id),
			DBA::escape(NETWORK_DFRN), DBA::escape(NETWORK_DIASPORA), DBA::escape(NETWORK_OSTATUS));
		if (!$r) {
			Config::set("system", "post_update_version", 1194);
			logger("Update is done", LOGGER_DEBUG);
			return true;
		} else {
			Config::set("system", "post_update_1194_start", $r[0]["id"]);
			$start_id = Config::get("system", "post_update_1194_start");
		}

		logger("Start ID: ".$start_id, LOGGER_DEBUG);

		$r = q($query1.$query2.$query3."  ORDER BY `item`.`id` LIMIT 1000,1",
			intval($start_id), intval($end_id),
			DBA::escape(NETWORK_DFRN), DBA::escape(NETWORK_DIASPORA), DBA::escape(NETWORK_OSTATUS));
		if ($r) {
			$pos_id = $r[0]["id"];
		} else {
			$pos_id = $end_id;
		}
		logger("Progress: Start: ".$start_id." position: ".$pos_id." end: ".$end_id, LOGGER_DEBUG);

		q("UPDATE `item` ".$query2." SET `item`.`global` = 1 ".$query3,
			intval($start_id), intval($pos_id),
			DBA::escape(NETWORK_DFRN), DBA::escape(NETWORK_DIASPORA), DBA::escape(NETWORK_OSTATUS));

		logger("Done", LOGGER_DEBUG);
	}

	/**
	 * @brief set the author-id and owner-id in all item entries
	 *
	 * This job has to be started multiple times until all entries are set.
	 * It isn't started in the update function since it would consume too much time and can be done in the background.
	 *
	 * @return bool "true" when the job is done
	 */
	private static function update1198()
	{
		// Was the script completed?
		if (Config::get("system", "post_update_version") >= 1198) {
			return true;
		}

		logger("Start", LOGGER_DEBUG);

		// Check if the first step is done (Setting "author-id" and "owner-id" in the item table)
		$fields = ['author-link', 'author-name', 'author-avatar', 'owner-link', 'owner-name', 'owner-avatar', 'network', 'uid'];
		$r = DBA::select('item', $fields, ['author-id' => 0, 'owner-id' => 0], ['limit' => 1000]);
		if (!$r) {
			// Are there unfinished entries in the thread table?
			$r = q("SELECT COUNT(*) AS `total` FROM `thread`
				INNER JOIN `item` ON `item`.`id` =`thread`.`iid`
				WHERE `thread`.`author-id` = 0 AND `thread`.`owner-id` = 0 AND
					(`thread`.`uid` IN (SELECT `uid` from `user`) OR `thread`.`uid` = 0)");

			if ($r && ($r[0]["total"] == 0)) {
				Config::set("system", "post_update_version", 1198);
				logger("Done", LOGGER_DEBUG);
				return true;
			}

			// Update the thread table from the item table
			$r = q("UPDATE `thread` INNER JOIN `item` ON `item`.`id`=`thread`.`iid`
					SET `thread`.`author-id` = `item`.`author-id`,
					`thread`.`owner-id` = `item`.`owner-id`
				WHERE `thread`.`author-id` = 0 AND `thread`.`owner-id` = 0 AND
					(`thread`.`uid` IN (SELECT `uid` from `user`) OR `thread`.`uid` = 0)");

			logger("Updated threads", LOGGER_DEBUG);
			if (DBA::isResult($r)) {
				Config::set("system", "post_update_version", 1198);
				logger("Done", LOGGER_DEBUG);
				return true;
			}
			return false;
		}

		logger("Query done", LOGGER_DEBUG);

		$item_arr = [];
		foreach ($r as $item) {
			$index = $item["author-link"]."-".$item["owner-link"]."-".$item["uid"];
			$item_arr[$index] = ["author-link" => $item["author-link"],
							"owner-link" => $item["owner-link"],
							"uid" => $item["uid"]];
		}

		// Set the "author-id" and "owner-id" in the item table and add a new public contact entry if needed
		foreach ($item_arr as $item) {
			$default = ['url' => $item['author-link'], 'name' => $item['author-name'],
				'photo' => $item['author-avatar'], 'network' => $item['network']];
			$author_id = Contact::getIdForURL($item["author-link"], 0, false, $default);

			$default = ['url' => $item['owner-link'], 'name' => $item['owner-name'],
				'photo' => $item['owner-avatar'], 'network' => $item['network']];
			$owner_id = Contact::getIdForURL($item["owner-link"], 0, false, $default);

			if ($author_id == 0) {
				$author_id = -1;
			}
			if ($owner_id == 0) {
				$owner_id = -1;
			}
			DBA::update('item', ['author-id' => $author_id, 'owner-id' => $owner_id], ['uid' => $item['uid'], 'author-link' => $item['author-link'], 'owner-link' => $item['owner-link'], 'author-id' => 0, 'owner-id' => 0]);
		}

		logger("Updated items", LOGGER_DEBUG);
		return false;
	}

	/**
	 * @brief update the "last-item" field in the "self" contact
	 *
	 * This field avoids cost intensive calls in the admin panel and in "nodeinfo"
	 *
	 * @return bool "true" when the job is done
	 */
	private static function update1206()
	{
		// Was the script completed?
		if (Config::get("system", "post_update_version") >= 1206) {
			return true;
		}

		logger("Start", LOGGER_DEBUG);
		$r = q("SELECT `contact`.`id`, `contact`.`last-item`,
			(SELECT MAX(`changed`) FROM `item` USE INDEX (`uid_wall_changed`) WHERE `wall` AND `uid` = `user`.`uid`) AS `lastitem_date`
			FROM `user`
			INNER JOIN `contact` ON `contact`.`uid` = `user`.`uid` AND `contact`.`self`");

		if (!DBA::isResult($r)) {
			return false;
		}
		foreach ($r as $user) {
			if (!empty($user["lastitem_date"]) && ($user["lastitem_date"] > $user["last-item"])) {
				DBA::update('contact', ['last-item' => $user['lastitem_date']], ['id' => $user['id']]);
			}
		}

		Config::set("system", "post_update_version", 1206);
		logger("Done", LOGGER_DEBUG);
		return true;
	}

	/**
	 * @brief update the item related tables
	 *
	 * @return bool "true" when the job is done
	 */
	private static function update1279()
	{
		// Was the script completed?
		if (Config::get("system", "post_update_version") >= 1279) {
			return true;
		}

		$id = Config::get("system", "post_update_version_1279_id", 0);

		logger("Start from item " . $id, LOGGER_DEBUG);

		$fields = array_merge(Item::MIXED_CONTENT_FIELDLIST, ['network', 'author-id', 'owner-id', 'tag', 'file',
			'author-name', 'author-avatar', 'author-link', 'owner-name', 'owner-avatar', 'owner-link', 'id',
			'uid', 'allow_cid', 'allow_gid', 'deny_cid', 'deny_gid', 'psid', 'post-type', 'bookmark', 'type',
			'inform', 'postopts', 'icid']);

		$start_id = $id;
		$rows = 0;
		$condition = ["`id` > ?", $id];
		$params = ['order' => ['id'], 'limit' => 10000];
		$items = Item::select($fields, $condition, $params);
		while ($item = Item::fetch($items)) {
			$id = $item['id'];

			if (empty($item['author-id'])) {
				$default = ['url' => $item['author-link'], 'name' => $item['author-name'],
					'photo' => $item['author-avatar'], 'network' => $item['network']];

				$item['author-id'] = Contact::getIdForURL($item["author-link"], 0, false, $default);
			}

			if (empty($item['owner-id'])) {
				$default = ['url' => $item['owner-link'], 'name' => $item['owner-name'],
					'photo' => $item['owner-avatar'], 'network' => $item['network']];

				$item['owner-id'] = Contact::getIdForURL($item["owner-link"], 0, false, $default);
			}

			if (empty($item['psid'])) {
				$item['psid'] = PermissionSet::fetchIDForPost($item);
			} else {
				$item['allow_cid'] = null;
				$item['allow_gid'] = null;
				$item['deny_cid'] = null;
				$item['deny_gid'] = null;
			}

			if ($item['post-type'] == 0) {
				if (!empty($item['type']) && ($item['type'] == 'note')) {
					$item['post-type'] = Item::PT_PERSONAL_NOTE;
				} elseif (!empty($item['type']) && ($item['type'] == 'photo')) {
					$item['post-type'] = Item::PT_IMAGE;
				} elseif (!empty($item['bookmark']) && $item['bookmark']) {
					$item['post-type'] = Item::PT_PAGE;
				}
			}

			self::createLanguage($item);

			if (!empty($item['icid']) && !empty($item['language'])) {
				DBA::update('item-content', ['language' => $item['language']], ['id' => $item['icid']]);
			}
			unset($item['language']);

			Item::update($item, ['id' => $id]);

			++$rows;
		}
		DBA::close($items);

		Config::set("system", "post_update_version_1279_id", $id);

		logger("Processed rows: " . $rows . " - last processed item:  " . $id, LOGGER_DEBUG);

		if ($start_id == $id) {
			// Set all deprecated fields to "null" if they contain an empty string
			$nullfields = ['allow_cid', 'allow_gid', 'deny_cid', 'deny_gid', 'postopts', 'inform', 'type',
				'bookmark', 'file', 'location', 'coord', 'tag', 'plink', 'title', 'content-warning',
				'body', 'app', 'verb', 'object-type', 'object', 'target-type', 'target',
				'author-name', 'author-link', 'author-avatar', 'owner-name', 'owner-link', 'owner-avatar',
				'rendered-hash', 'rendered-html'];
			foreach ($nullfields as $field) {
				$fields = [$field => null];
				$condition = [$field => ''];
				logger("Setting '" . $field . "' to null if empty.", LOGGER_DEBUG);
				// Important: This has to be a "DBA::update", not a "Item::update"
				DBA::update('item', $fields, $condition);
			}

			Config::set("system", "post_update_version", 1279);
			logger("Done", LOGGER_DEBUG);
			return true;
		}

		return false;
	}

	private static function createLanguage(&$item)
	{
		if (empty($item['postopts'])) {
			return;
		}

		$opts = explode(',', $item['postopts']);

		$postopts = [];

		foreach ($opts as $opt) {
			if (strstr($opt, 'lang=')) {
				$language = substr($opt, 5);
			} else {
				$postopts[] = $opt;
			}
		}

		if (empty($language)) {
			return;
		}

		if (!empty($postopts)) {
			$item['postopts'] = implode(',', $postopts);
		} else {
			$item['postopts'] = null;
		}

		$lang_pairs = explode(':', $language);

		$lang_arr = [];

		foreach ($lang_pairs as $pair) {
			$lang_pair_arr = explode(';', $pair);
			if (count($lang_pair_arr) == 2) {
				$lang_arr[$lang_pair_arr[0]] = $lang_pair_arr[1];
			}
		}

		$item['language'] = json_encode($lang_arr);
	}

	/**
	 * @brief update item-uri data. Prerequisite for the next item structure update.
	 *
	 * @return bool "true" when the job is done
	 */
	private static function update1281()
	{
		// Was the script completed?
		if (Config::get("system", "post_update_version") >= 1281) {
			return true;
		}

		$id = Config::get("system", "post_update_version_1281_id", 0);

		logger("Start from item " . $id, LOGGER_DEBUG);

		$fields = ['id', 'guid', 'uri', 'uri-id', 'parent-uri', 'parent-uri-id', 'thr-parent', 'thr-parent-id'];

		$start_id = $id;
		$rows = 0;
		$condition = ["`id` > ?", $id];
		$params = ['order' => ['id'], 'limit' => 10000];
		$items = DBA::select('item', $fields, $condition, $params);
		while ($item = DBA::fetch($items)) {
			$id = $item['id'];

			if (empty($item['uri'])) {
				// Should not happen
				continue;
			} elseif (empty($item['uri-id'])) {
				$item['uri-id'] = ItemURI::insert(['uri' => $item['uri'], 'guid' => $item['guid']]);
			}

			if (empty($item['parent-uri'])) {
				$item['parent-uri-id'] = $item['uri-id'];
			} elseif (empty($item['parent-uri-id'])) {
				$item['parent-uri-id'] = ItemURI::getIdByURI($item['parent-uri']);
			}

			// Very old items don't have this field
			if (empty($item['thr-parent'])) {
				$item['thr-parent-id'] = $item['parent-uri-id'];
			} elseif (empty($item['thr-parent-id'])) {
				$item['thr-parent-id'] = ItemURI::getIdByURI($item['thr-parent']);
			}

			unset($item['id']);
			unset($item['guid']);
			unset($item['uri']);
			unset($item['parent-uri']);
			unset($item['thr-parent']);

			DBA::update('item', $item, ['id' => $id]);

			++$rows;
		}
		DBA::close($items);

		Config::set("system", "post_update_version_1281_id", $id);

		logger("Processed rows: " . $rows . " - last processed item:  " . $id, LOGGER_DEBUG);

		if ($start_id == $id) {
			logger("Updating item-uri in item-activity", LOGGER_DEBUG);
			DBA::e("UPDATE `item-activity` INNER JOIN `item-uri` ON `item-uri`.`uri` = `item-activity`.`uri` SET `item-activity`.`uri-id` = `item-uri`.`id` WHERE `item-activity`.`uri-id` IS NULL");

			logger("Updating item-uri in item-content", LOGGER_DEBUG);
			DBA::e("UPDATE `item-content` INNER JOIN `item-uri` ON `item-uri`.`uri` = `item-content`.`uri` SET `item-content`.`uri-id` = `item-uri`.`id` WHERE `item-content`.`uri-id` IS NULL");

			Config::set("system", "post_update_version", 1281);
			logger("Done", LOGGER_DEBUG);
			return true;
		}

		return false;
	}
}