friendica/src/Core/Addon.php

<?php
/**
 * @file src/Core/Addon.php
 */
namespace Friendica\Core;

use Friendica\App;
use Friendica\BaseObject;
use Friendica\Database\DBA;

require_once 'include/dba.php';

/**
 * Some functions to handle addons
 */
class Addon extends BaseObject
{
	/**
	 * @brief Synchronise addons:
	 *
	 * system.addon contains a comma-separated list of names
	 * of addons which are used on this system.
	 * Go through the database list of already installed addons, and if we have
	 * an entry, but it isn't in the config list, call the uninstall procedure
	 * and mark it uninstalled in the database (for now we'll remove it).
	 * Then go through the config list and if we have a addon that isn't installed,
	 * call the install procedure and add it to the database.
	 *
	 */
	public static function check()
	{
		$a = self::getApp();

		$r = q("SELECT * FROM `addon` WHERE `installed` = 1");
		if (DBA::isResult($r)) {
			$installed = $r;
		} else {
			$installed = [];
		}

		$addons = Config::get('system', 'addon');
		$addons_arr = [];

		if ($addons) {
			$addons_arr = explode(',', str_replace(' ', '', $addons));
		}

		$a->addons = $addons_arr;

		$installed_arr = [];

		if (count($installed)) {
			foreach ($installed as $i) {
				if (!in_array($i['name'], $addons_arr)) {
					self::uninstall($i['name']);
				} else {
					$installed_arr[] = $i['name'];
				}
			}
		}

		if (count($addons_arr)) {
			foreach ($addons_arr as $p) {
				if (!in_array($p, $installed_arr)) {
					self::install($p);
				}
			}
		}

		self::loadHooks();

		return;
	}

	/**
	 * @brief uninstalls an addon.
	 *
	 * @param string $addon name of the addon
	 * @return boolean
	 */
	public static function uninstall($addon)
	{
		logger("Addons: uninstalling " . $addon);
		DBA::delete('addon', ['name' => $addon]);

		@include_once('addon/' . $addon . '/' . $addon . '.php');
		if (function_exists($addon . '_uninstall')) {
			$func = $addon . '_uninstall';
			$func();
		}
	}

	/**
	 * @brief installs an addon.
	 *
	 * @param string $addon name of the addon
	 * @return bool
	 */
	public static function install($addon)
	{
		// silently fail if addon was removed

		if (!file_exists('addon/' . $addon . '/' . $addon . '.php')) {
			return false;
		}
		logger("Addons: installing " . $addon);
		$t = @filemtime('addon/' . $addon . '/' . $addon . '.php');
		@include_once('addon/' . $addon . '/' . $addon . '.php');
		if (function_exists($addon . '_install')) {
			$func = $addon . '_install';
			$func();

			$addon_admin = (function_exists($addon."_addon_admin") ? 1 : 0);

			DBA::insert('addon', ['name' => $addon, 'installed' => true,
						'timestamp' => $t, 'plugin_admin' => $addon_admin]);

			// we can add the following with the previous SQL
			// once most site tables have been updated.
			// This way the system won't fall over dead during the update.

			if (file_exists('addon/' . $addon . '/.hidden')) {
				DBA::update('addon', ['hidden' => true], ['name' => $addon]);
			}
			return true;
		} else {
			logger("Addons: FAILED installing " . $addon);
			return false;
		}
	}

	/**
	 * reload all updated addons
	 */
	public static function reload()
	{
		$addons = Config::get('system', 'addon');
		if (strlen($addons)) {
			$r = DBA::select('addon', [], ['installed' => 1]);
			if (DBA::isResult($r)) {
				$installed = DBA::toArray($r);
			} else {
				$installed = [];
			}

			$addon_list = explode(',', $addons);

			if (count($addon_list)) {
				foreach ($addon_list as $addon) {
					$addon = trim($addon);
					$fname = 'addon/' . $addon . '/' . $addon . '.php';

					if (file_exists($fname)) {
						$t = @filemtime($fname);
						foreach ($installed as $i) {
							if (($i['name'] == $addon) && ($i['timestamp'] != $t)) {
								logger('Reloading addon: ' . $i['name']);
								@include_once($fname);

								if (function_exists($addon . '_uninstall')) {
									$func = $addon . '_uninstall';
									$func();
								}
								if (function_exists($addon . '_install')) {
									$func = $addon . '_install';
									$func();
								}
								DBA::update('addon', ['timestamp' => $t], ['id' => $i['id']]);
							}
						}
					}
				}
			}
		}
	}

	/**
	 * @brief check if addon is enabled
	 *
	 * @param string $addon
	 * @return boolean
	 */
	public static function isEnabled($addon)
	{
		return DBA::exists('addon', ['installed' => true, 'name' => $addon]);
	}


	/**
	 * @brief registers a hook.
	 *
	 * @param string $hook the name of the hook
	 * @param string $file the name of the file that hooks into
	 * @param string $function the name of the function that the hook will call
	 * @param int $priority A priority (defaults to 0)
	 * @return mixed|bool
	 */
	public static function registerHook($hook, $file, $function, $priority = 0)
	{
		$file = str_replace(self::getApp()->get_basepath() . DIRECTORY_SEPARATOR, '', $file);

		$condition = ['hook' => $hook, 'file' => $file, 'function' => $function];
		$exists = DBA::exists('hook', $condition);
		if ($exists) {
			return true;
		}

		$r = DBA::insert('hook', ['hook' => $hook, 'file' => $file, 'function' => $function, 'priority' => $priority]);

		return $r;
	}

	/**
	 * @brief unregisters a hook.
	 *
	 * @param string $hook the name of the hook
	 * @param string $file the name of the file that hooks into
	 * @param string $function the name of the function that the hook called
	 * @return array
	 */
	public static function unregisterHook($hook, $file, $function)
	{
		$relative_file = str_replace(self::getApp()->get_basepath() . DIRECTORY_SEPARATOR, '', $file);

		// This here is only needed for fixing a problem that existed on the develop branch
		$condition = ['hook' => $hook, 'file' => $file, 'function' => $function];
		DBA::delete('hook', $condition);

		$condition = ['hook' => $hook, 'file' => $relative_file, 'function' => $function];
		$r = DBA::delete('hook', $condition);
		return $r;
	}

	/**
	 * Load hooks
	 */
	public static function loadHooks()
	{
		$a = self::getApp();
		$a->hooks = [];
		$r = DBA::select('hook', ['hook', 'file', 'function'], [], ['order' => ['priority' => 'desc', 'file']]);

		while ($rr = DBA::fetch($r)) {
			if (! array_key_exists($rr['hook'], $a->hooks)) {
				$a->hooks[$rr['hook']] = [];
			}
			$a->hooks[$rr['hook']][] = [$rr['file'],$rr['function']];
		}
		DBA::close($r);
	}

	/**
	 * @brief Forks a hook.
	 *
	 * Use this function when you want to fork a hook via the worker.
	 *
	 * @param string $name of the hook to call
	 * @param string|array $data to transmit to the callback handler
	 */
	public static function forkHooks($priority, $name, $data = null)
	{
		$a = self::getApp();

		if (is_array($a->hooks) && array_key_exists($name, $a->hooks)) {
			foreach ($a->hooks[$name] as $hook) {
				Worker::add($priority, 'ForkHook', $name, $hook, $data);
			}
		}
	}

	/**
	 * @brief Calls a hook.
	 *
	 * Use this function when you want to be able to allow a hook to manipulate
	 * the provided data.
	 *
	 * @param string $name of the hook to call
	 * @param string|array &$data to transmit to the callback handler
	 */
	public static function callHooks($name, &$data = null)
	{
		$a = self::getApp();

		if (is_array($a->hooks) && array_key_exists($name, $a->hooks)) {
			foreach ($a->hooks[$name] as $hook) {
				self::callSingleHook($a, $name, $hook, $data);
			}
		}
	}

	/**
	 * @brief Calls a single hook.
	 *
	 * @param App $a
	 * @param string         $name of the hook to call
	 * @param array          $hook Hook data
	 * @param string|array   &$data to transmit to the callback handler
	 */
	public static function callSingleHook(App $a, $name, $hook, &$data = null)
	{
		// Don't run a theme's hook if the user isn't using the theme
		if (strpos($hook[0], 'view/theme/') !== false && strpos($hook[0], 'view/theme/' . $a->getCurrentTheme()) === false) {
			return;
		}

		@include_once($hook[0]);
		if (function_exists($hook[1])) {
			$func = $hook[1];
			$func($a, $data);
		} else {
			// remove orphan hooks
			$condition = ['hook' => $name, 'file' => $hook[0], 'function' => $hook[1]];
			DBA::delete('hook', $condition, ['cascade' => false]);
		}
	}

	/**
	 * check if an app_menu hook exist for addon $name.
	 * Return true if the addon is an app
	 */
	public static function isApp($name)
	{
		$a = self::getApp();

		if (is_array($a->hooks) && (array_key_exists('app_menu', $a->hooks))) {
			foreach ($a->hooks['app_menu'] as $hook) {
				if ($hook[0] == 'addon/'.$name.'/'.$name.'.php') {
					return true;
				}
			}
		}

		return false;
	}

	/**
	 * @brief Parse addon comment in search of addon infos.
	 *
	 * like
	 * \code
	 *   * Name: addon
	 *   * Description: An addon which plugs in
	 * . * Version: 1.2.3
	 *   * Author: John <profile url>
	 *   * Author: Jane <email>
	 *   * Maintainer: Jess <email>
	 *   *
	 *   *\endcode
	 * @param string $addon the name of the addon
	 * @return array with the addon information
	 */
	public static function getInfo($addon)
	{
		$a = self::getApp();

		$info = [
			'name' => $addon,
			'description' => "",
			'author' => [],
			'maintainer' => [],
			'version' => "",
			'status' => ""
		];

		if (!is_file("addon/$addon/$addon.php")) {
			return $info;
		}

		$stamp1 = microtime(true);
		$f = file_get_contents("addon/$addon/$addon.php");
		$a->save_timestamp($stamp1, "file");

		$r = preg_match("|/\*.*\*/|msU", $f, $m);

		if ($r) {
			$ll = explode("\n", $m[0]);
			foreach ($ll as $l) {
				$l = trim($l, "\t\n\r */");
				if ($l != "") {
					$addon_info = array_map("trim", explode(":", $l, 2));
					if (count($addon_info) < 2) {
						continue;
					}

					list($type, $v) = $addon_info;
					$type = strtolower($type);
					if ($type == "author" || $type == "maintainer") {
						$r = preg_match("|([^<]+)<([^>]+)>|", $v, $m);
						if ($r) {
							$info[$type][] = ['name' => $m[1], 'link' => $m[2]];
						} else {
							$info[$type][] = ['name' => $v];
						}
					} else {
						if (array_key_exists($type, $info)) {
							$info[$type] = $v;
						}
					}
				}
			}
		}
		return $info;
	}
}