X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;f=src%2FCore%2FAddon.php;h=dd229be287a83ebbb15466be1e401d00128ecba4;hb=a98957eeb29cfb142dfc4cd3e03c5bdfbc373466;hp=bfb2a1e8fddbdd01f11e93125b65004bd2ba4ea8;hpb=cfa68c52b9117616fa95a4639ad74e7d220d193d;p=friendica.git

diff --git a/src/Core/Addon.php b/src/Core/Addon.php
index bfb2a1e8fd..dd229be287 100644
--- a/src/Core/Addon.php
+++ b/src/Core/Addon.php
@@ -1,13 +1,29 @@
 <?php
 /**
- * @file src/Core/Addon.php
+ * @copyright Copyright (C) 2020, Friendica
+ *
+ * @license GNU AGPL version 3 or any later version
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ *
  */
+
 namespace Friendica\Core;
 
-use Friendica\App;
 use Friendica\Database\DBA;
-
-require_once 'include/dba.php';
+use Friendica\DI;
+use Friendica\Util\Strings;
 
 /**
  * Some functions to handle addons
@@ -15,260 +31,195 @@ require_once 'include/dba.php';
 class Addon
 {
 	/**
-	 * @brief uninstalls an addon.
-	 *
-	 * @param string $addon name of the addon
-	 * @return boolean
+	 * The addon sub-directory
+	 * @var string
 	 */
-	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();
-		}
-	}
+	const DIRECTORY = 'addon';
 
 	/**
-	 * @brief installs an addon.
+	 * List of the names of enabled addons
 	 *
-	 * @param string $addon name of the addon
-	 * @return bool
+	 * @var array
 	 */
-	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;
-		}
-	}
+	private static $addons = [];
 
 	/**
-	 * reload all updated addons
+	 * Returns the list of available addons with their current status and info.
+	 * This list is made from scanning the addon/ folder.
+	 * Unsupported addons are excluded unless they already are enabled or system.show_unsupported_addon is set.
+	 *
+	 * @return array
+	 * @throws \Exception
 	 */
-	public static function reload()
+	public static function getAvailableList()
 	{
-		$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']]);
-							}
-						}
+		$addons = [];
+		$files = glob('addon/*/');
+		if (is_array($files)) {
+			foreach ($files as $file) {
+				if (is_dir($file)) {
+					list($tmp, $addon) = array_map('trim', explode('/', $file));
+					$info = self::getInfo($addon);
+
+					if (DI::config()->get('system', 'show_unsupported_addons')
+						|| strtolower($info['status']) != 'unsupported'
+						|| self::isEnabled($addon)
+					) {
+						$addons[] = [$addon, (self::isEnabled($addon) ? 'on' : 'off'), $info];
 					}
 				}
 			}
 		}
-	}
 
-	/**
-	 * @brief check if addon is enabled
-	 *
-	 * @param string $addon
-	 * @return boolean
-	 */
-	public static function isEnabled($addon)
-	{
-		return DBA::exists('addon', ['installed' => true, 'name' => $addon]);
+		return $addons;
 	}
 
-
 	/**
-	 * @brief registers a hook.
+	 * Returns a list of addons that can be configured at the node level.
+	 * The list is formatted for display in the admin panel aside.
 	 *
-	 * @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
+	 * @return array
+	 * @throws \Exception
 	 */
-	public static function registerHook($hook, $file, $function, $priority = 0)
+	public static function getAdminList()
 	{
-		$condition = ['hook' => $hook, 'file' => $file, 'function' => $function];
-		$exists = DBA::exists('hook', $condition);
-		if ($exists) {
-			return true;
+		$addons_admin = [];
+		$addonsAdminStmt = DBA::select('addon', ['name'], ['plugin_admin' => 1], ['order' => ['name']]);
+		while ($addon = DBA::fetch($addonsAdminStmt)) {
+			$addons_admin[$addon['name']] = [
+				'url' => 'admin/addons/' . $addon['name'],
+				'name' => $addon['name'],
+				'class' => 'addon'
+			];
 		}
+		DBA::close($addonsAdminStmt);
 
-		$r = DBA::insert('hook', ['hook' => $hook, 'file' => $file, 'function' => $function, 'priority' => $priority]);
-
-		return $r;
+		return $addons_admin;
 	}
 
+
 	/**
-	 * @brief unregisters a hook.
+	 * Synchronize 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.
 	 *
-	 * @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)
+	public static function loadAddons()
 	{
-		$condition = ['hook' => $hook, 'file' => $file, 'function' => $function];
-		$r = DBA::delete('hook', $condition);
-		return $r;
+		$installed_addons = DBA::selectToArray('addon', ['name'], ['installed' => true]);
+		self::$addons = array_column($installed_addons, 'name');
 	}
 
 	/**
-	 * Load hooks
+	 * uninstalls an addon.
+	 *
+	 * @param string $addon name of the addon
+	 * @return void
+	 * @throws \Exception
 	 */
-	public static function loadHooks()
+	public static function uninstall($addon)
 	{
-		$a = get_app();
-		$a->hooks = [];
-		$r = DBA::select('hook', ['hook', 'file', 'function'], [], ['order' => ['priority' => 'desc', 'file']]);
+		$addon = Strings::sanitizeFilePathItem($addon);
 
-		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']];
+		Logger::notice("Addon {addon}: {action}", ['action' => 'uninstall', 'addon' => $addon]);
+		DBA::delete('addon', ['name' => $addon]);
+
+		@include_once('addon/' . $addon . '/' . $addon . '.php');
+		if (function_exists($addon . '_uninstall')) {
+			$func = $addon . '_uninstall';
+			$func();
 		}
-		DBA::close($r);
+
+		DBA::delete('hook', ['file' => 'addon/' . $addon . '/' . $addon . '.php']);
+
+		unset(self::$addons[array_search($addon, self::$addons)]);
 	}
 
 	/**
-	 * @brief Forks a hook.
-	 *
-	 * Use this function when you want to fork a hook via the worker.
+	 * installs an addon.
 	 *
-	 * @param string $name of the hook to call
-	 * @param string|array $data to transmit to the callback handler
+	 * @param string $addon name of the addon
+	 * @return bool
+	 * @throws \Exception
 	 */
-	public static function forkHooks($priority, $name, $data = null)
+	public static function install($addon)
 	{
-		$a = get_app();
+		$addon = Strings::sanitizeFilePathItem($addon);
 
-		if (is_array($a->hooks) && array_key_exists($name, $a->hooks)) {
-			foreach ($a->hooks[$name] as $hook) {
-				Worker::add($priority, 'ForkHook', $name, $hook, $data);
-			}
+		// silently fail if addon was removed of if $addon is funky
+		if (!file_exists('addon/' . $addon . '/' . $addon . '.php')) {
+			return false;
 		}
-	}
 
-	/**
-	 * @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 = get_app();
+		Logger::notice("Addon {addon}: {action}", ['action' => 'install', 'addon' => $addon]);
+		$t = @filemtime('addon/' . $addon . '/' . $addon . '.php');
+		@include_once('addon/' . $addon . '/' . $addon . '.php');
+		if (function_exists($addon . '_install')) {
+			$func = $addon . '_install';
+			$func(DI::app());
+
+			$addon_admin = (function_exists($addon . "_addon_admin") ? 1 : 0);
 
-		if (is_array($a->hooks) && array_key_exists($name, $a->hooks)) {
-			foreach ($a->hooks[$name] as $hook) {
-				self::callSingleHook($a, $name, $hook, $data);
+			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]);
 			}
-		}
-	}
 
-	/**
-	 * @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;
-		}
+			if (!self::isEnabled($addon)) {
+				self::$addons[] = $addon;
+			}
 
-		@include_once($hook[0]);
-		if (function_exists($hook[1])) {
-			$func = $hook[1];
-			$func($a, $data);
+			return true;
 		} else {
-			// remove orphan hooks
-			$condition = ['hook' => $name, 'file' => $hook[0], 'function' => $hook[1]];
-			DBA::delete('hook', $condition, ['cascade' => false]);
+			Logger::error("Addon {addon}: {action} failed", ['action' => 'install', 'addon' => $addon]);
+			return false;
 		}
 	}
 
 	/**
-	 * check if an app_menu hook exist for addon $name.
-	 * Return true if the addon is an app
+	 * reload all updated addons
 	 */
-	public static function isApp($name)
+	public static function reload()
 	{
-		$a = get_app();
+		$addons = DBA::selectToArray('addon', [], ['installed' => true]);
+
+		foreach ($addons as $addon) {
+			$addonname = Strings::sanitizeFilePathItem(trim($addon['name']));
+			$fname = 'addon/' . $addonname . '/' . $addonname . '.php';
+			$t = @filemtime($fname);
+			if (!file_exists($fname) || ($addon['timestamp'] == $t)) {
+				continue;
+			}
 
-		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;
-				}
+			Logger::notice("Addon {addon}: {action}", ['action' => 'reload', 'addon' => $addon['name']]);
+			@include_once($fname);
+
+			if (function_exists($addonname . '_uninstall')) {
+				$func = $addonname . '_uninstall';
+				$func(DI::app());
+			}
+			if (function_exists($addonname . '_install')) {
+				$func = $addonname . '_install';
+				$func(DI::app());
 			}
+			DBA::update('addon', ['timestamp' => $t], ['id' => $addon['id']]);
 		}
-
-		return false;
 	}
 
 	/**
-	 * @brief Parse addon comment in search of addon infos.
+	 * Parse addon comment in search of addon infos.
 	 *
 	 * like
 	 * \code
@@ -282,10 +233,13 @@ class Addon
 	 *   *\endcode
 	 * @param string $addon the name of the addon
 	 * @return array with the addon information
+	 * @throws \Exception
 	 */
 	public static function getInfo($addon)
 	{
-		$a = get_app();
+		$a = DI::app();
+
+		$addon = Strings::sanitizeFilePathItem($addon);
 
 		$info = [
 			'name' => $addon,
@@ -302,7 +256,7 @@ class Addon
 
 		$stamp1 = microtime(true);
 		$f = file_get_contents("addon/$addon/$addon.php");
-		$a->save_timestamp($stamp1, "file");
+		DI::profiler()->saveTimestamp($stamp1, "file", System::callstack());
 
 		$r = preg_match("|/\*.*\*/|msU", $f, $m);
 
@@ -311,7 +265,12 @@ class Addon
 			foreach ($ll as $l) {
 				$l = trim($l, "\t\n\r */");
 				if ($l != "") {
-					list($type, $v) = array_map("trim", explode(":", $l, 2));
+					$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);
@@ -330,4 +289,91 @@ class Addon
 		}
 		return $info;
 	}
+
+	/**
+	 * Checks if the provided addon is enabled
+	 *
+	 * @param string $addon
+	 * @return boolean
+	 */
+	public static function isEnabled($addon)
+	{
+		return in_array($addon, self::$addons);
+	}
+
+	/**
+	 * Returns a list of the enabled addon names
+	 *
+	 * @return array
+	 */
+	public static function getEnabledList()
+	{
+		return self::$addons;
+	}
+
+	/**
+	 * Returns the list of non-hidden enabled addon names
+	 *
+	 * @return array
+	 * @throws \Exception
+	 */
+	public static function getVisibleList()
+	{
+		$visible_addons = [];
+		$stmt = DBA::select('addon', ['name'], ['hidden' => false, 'installed' => true]);
+		if (DBA::isResult($stmt)) {
+			foreach (DBA::toArray($stmt) as $addon) {
+				$visible_addons[] = $addon['name'];
+			}
+		}
+
+		return $visible_addons;
+	}
+
+	/**
+	 * Shim of Hook::register left for backward compatibility purpose.
+	 *
+	 * @see        Hook::register
+	 * @deprecated since version 2018.12
+	 * @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
+	 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
+	 */
+	public static function registerHook($hook, $file, $function, $priority = 0)
+	{
+		return Hook::register($hook, $file, $function, $priority);
+	}
+
+	/**
+	 * Shim of Hook::unregister left for backward compatibility purpose.
+	 *
+	 * @see        Hook::unregister
+	 * @deprecated since version 2018.12
+	 * @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 boolean
+	 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
+	 */
+	public static function unregisterHook($hook, $file, $function)
+	{
+		return Hook::unregister($hook, $file, $function);
+	}
+
+	/**
+	 * Shim of Hook::callAll left for backward-compatibility purpose.
+	 *
+	 * @see        Hook::callAll
+	 * @deprecated since version 2018.12
+	 * @param string        $name of the hook to call
+	 * @param string|array &$data to transmit to the callback handler
+	 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
+	 */
+	public static function callHooks($name, &$data = null)
+	{
+		Hook::callAll($name, $data);
+	}
 }