-<?php\r
-/**\r
- * @file src/Core/Addon.php\r
- */\r
-namespace Friendica\Core;\r
-\r
-use Friendica\App;\r
-use Friendica\Core\Config;\r
-use Friendica\Core\System;\r
-use Friendica\Database\DBM;\r
-use dba;\r
-\r
-require_once 'include/dba.php';\r
-\r
-/**\r
- * Some functions to handle addons\r
- */\r
-class Addon\r
-{\r
- /**\r
- * @brief uninstalls an addon.\r
- *\r
- * @param string $addon name of the addon\r
- * @return boolean\r
- */\r
- public static function uninstall($addon)\r
- {\r
- logger("Addons: uninstalling " . $addon);\r
- dba::delete('addon', ['name' => $addon]);\r
-\r
- @include_once('addon/' . $addon . '/' . $addon . '.php');\r
- if (function_exists($addon . '_uninstall')) {\r
- $func = $addon . '_uninstall';\r
- $func();\r
- }\r
- }\r
-\r
- /**\r
- * @brief installs an addon.\r
- *\r
- * @param string $addon name of the addon\r
- * @return bool\r
- */\r
- public static function install($addon)\r
- {\r
- // silently fail if addon was removed\r
-\r
- if (!file_exists('addon/' . $addon . '/' . $addon . '.php')) {\r
- return false;\r
- }\r
- logger("Addons: installing " . $addon);\r
- $t = @filemtime('addon/' . $addon . '/' . $addon . '.php');\r
- @include_once('addon/' . $addon . '/' . $addon . '.php');\r
- if (function_exists($addon . '_install')) {\r
- $func = $addon . '_install';\r
- $func();\r
-\r
- $addon_admin = (function_exists($addon."_plugin_admin") ? 1 : 0);\r
-\r
- dba::insert('addon', ['name' => $addon, 'installed' => true,\r
- 'timestamp' => $t, 'plugin_admin' => $addon_admin]);\r
-\r
- // we can add the following with the previous SQL\r
- // once most site tables have been updated.\r
- // This way the system won't fall over dead during the update.\r
-\r
- if (file_exists('addon/' . $addon . '/.hidden')) {\r
- dba::update('addon', ['hidden' => true], ['name' => $addon]);\r
- }\r
- return true;\r
- } else {\r
- logger("Addons: FAILED installing " . $addon);\r
- return false;\r
- }\r
- }\r
-\r
- /**\r
- * reload all updated addons\r
- */\r
- public static function reload()\r
- {\r
- $addons = Config::get('system', 'addon');\r
- if (strlen($addons)) {\r
-\r
- $r = dba::select('addon', [], ['installed' => 1]);\r
- if (DBM::is_result($r)) {\r
- $installed = $r;\r
- } else {\r
- $installed = [];\r
- }\r
-\r
- $addon_list = explode(',', $addons);\r
-\r
- if (count($addon_list)) {\r
- foreach ($addon_list as $addon) {\r
-\r
- $addon = trim($addon);\r
-\r
- $fname = 'addon/' . $addon . '/' . $addon . '.php';\r
-\r
- if (file_exists($fname)) {\r
- $t = @filemtime($fname);\r
- foreach ($installed as $i) {\r
- if (($i['name'] == $addon) && ($i['timestamp'] != $t)) {\r
- logger('Reloading addon: ' . $i['name']);\r
- @include_once($fname);\r
-\r
- if (function_exists($addon . '_uninstall')) {\r
- $func = $addon . '_uninstall';\r
- $func();\r
- }\r
- if (function_exists($addon . '_install')) {\r
- $func = $addon . '_install';\r
- $func();\r
- }\r
- dba::update('addon', ['timestamp' => $t], ['id' => $i['id']]);\r
- }\r
- }\r
- }\r
- }\r
- }\r
- }\r
- }\r
-\r
- /**\r
- * @brief check if addon is enabled\r
- *\r
- * @param string $addon\r
- * @return boolean\r
- */\r
- public static function isEnabled($addon)\r
- {\r
- return dba::exists('addon', ['installed' => true, 'name' => $addon]);\r
- }\r
-\r
-\r
- /**\r
- * @brief registers a hook.\r
- *\r
- * @param string $hook the name of the hook\r
- * @param string $file the name of the file that hooks into\r
- * @param string $function the name of the function that the hook will call\r
- * @param int $priority A priority (defaults to 0)\r
- * @return mixed|bool\r
- */\r
- public static function registerHook($hook, $file, $function, $priority = 0)\r
- {\r
- $condition = ['hook' => $hook, 'file' => $file, 'function' => $function];\r
- $exists = dba::exists('hook', $condition);\r
- if ($exists) {\r
- return true;\r
- }\r
-\r
- $r = dba::insert('hook', ['hook' => $hook, 'file' => $file, 'function' => $function, 'priority' => $priority]);\r
-\r
- return $r;\r
- }\r
-\r
- /**\r
- * @brief unregisters a hook.\r
- *\r
- * @param string $hook the name of the hook\r
- * @param string $file the name of the file that hooks into\r
- * @param string $function the name of the function that the hook called\r
- * @return array\r
- */\r
- public static function unregisterHook($hook, $file, $function)\r
- {\r
- $condition = ['hook' => $hook, 'file' => $file, 'function' => $function];\r
- $r = dba::delete('hook', $condition);\r
- return $r;\r
- }\r
-\r
-\r
- public static function loadHooks() {\r
- $a = get_app();\r
- $a->hooks = [];\r
- $r = dba::select('hook', ['hook', 'file', 'function'], [], ['order' => ['priority' => 'desc', 'file']]);\r
-\r
- while ($rr = dba::fetch($r)) {\r
- if (! array_key_exists($rr['hook'],$a->hooks)) {\r
- $a->hooks[$rr['hook']] = [];\r
- }\r
- $a->hooks[$rr['hook']][] = [$rr['file'],$rr['function']];\r
- }\r
- dba::close($r);\r
- }\r
-\r
- /**\r
- * @brief Calls a hook.\r
- *\r
- * Use this function when you want to be able to allow a hook to manipulate\r
- * the provided data.\r
- *\r
- * @param string $name of the hook to call\r
- * @param string|array &$data to transmit to the callback handler\r
- */\r
- public static function callHooks($name, &$data = null)\r
- {\r
- $a = get_app();\r
-\r
- if (is_array($a->hooks) && array_key_exists($name, $a->hooks)) {\r
- foreach ($a->hooks[$name] as $hook) {\r
- self::callSingleHook($a, $name, $hook, $data);\r
- }\r
- }\r
- }\r
-\r
- /**\r
- * @brief Calls a single hook.\r
- *\r
- * @param string $name of the hook to call\r
- * @param array $hook Hook data\r
- * @param string|array &$data to transmit to the callback handler\r
- */\r
- public static function callSingleHook($a, $name, $hook, &$data = null)\r
- {\r
- // Don't run a theme's hook if the user isn't using the theme\r
- if (strpos($hook[0], 'view/theme/') !== false && strpos($hook[0], 'view/theme/'.current_theme()) === false)\r
- return;\r
-\r
- @include_once($hook[0]);\r
- if (function_exists($hook[1])) {\r
- $func = $hook[1];\r
- $func($a, $data);\r
- } else {\r
- // remove orphan hooks\r
- $condition = ['hook' => $name, 'file' => $hook[0], 'function' => $hook[1]];\r
- dba::delete('hook', $condition);\r
- }\r
- }\r
-\r
- /**\r
- * check if an app_menu hook exist for addon $name.\r
- * Return true if the addon is an app\r
- */\r
- function isApp($name)\r
- {\r
- $a = get_app();\r
-\r
- if (is_array($a->hooks) && (array_key_exists('app_menu',$a->hooks))) {\r
- foreach ($a->hooks['app_menu'] as $hook) {\r
- if ($hook[0] == 'addon/'.$name.'/'.$name.'.php')\r
- return true;\r
- }\r
- }\r
-\r
- return false;\r
- }\r
-\r
- /**\r
- * @brief Parse addon comment in search of addon infos.\r
- *\r
- * like\r
- * \code\r
- *...* Name: addon\r
- * * Description: An addon which plugs in\r
- * . * Version: 1.2.3\r
- * * Author: John <profile url>\r
- * * Author: Jane <email>\r
- * *\r
- * *\endcode\r
- * @param string $addon the name of the addon\r
- * @return array with the addon information\r
- */\r
-\r
- public static function getInfo($addon) {\r
-\r
- $a = get_app();\r
-\r
- $info=[\r
- 'name' => $addon,\r
- 'description' => "",\r
- 'author' => [],\r
- 'version' => "",\r
- 'status' => ""\r
- ];\r
-\r
- if (!is_file("addon/$addon/$addon.php")) {\r
- return $info;\r
- }\r
-\r
- $stamp1 = microtime(true);\r
- $f = file_get_contents("addon/$addon/$addon.php");\r
- $a->save_timestamp($stamp1, "file");\r
-\r
- $r = preg_match("|/\*.*\*/|msU", $f, $m);\r
-\r
- if ($r) {\r
- $ll = explode("\n", $m[0]);\r
- foreach ( $ll as $l ) {\r
- $l = trim($l,"\t\n\r */");\r
- if ($l != "") {\r
- list($k,$v) = array_map("trim", explode(":",$l,2));\r
- $k= strtolower($k);\r
- if ($k == "author") {\r
- $r=preg_match("|([^<]+)<([^>]+)>|", $v, $m);\r
- if ($r) {\r
- $info['author'][] = ['name'=>$m[1], 'link'=>$m[2]];\r
- } else {\r
- $info['author'][] = ['name'=>$v];\r
- }\r
- } else {\r
- if (array_key_exists($k,$info)) {\r
- $info[$k]=$v;\r
- }\r
- }\r
-\r
- }\r
- }\r
- }\r
- return $info;\r
- }\r
-}\r
+<?php
+/**
+ * @file src/Core/Addon.php
+ */
+namespace Friendica\Core;
+
+use Friendica\Core\Config;
+use Friendica\Database\DBM;
+use Friendica\Core\Worker;
+
+use dba;
+
+require_once 'include/dba.php';
+
+/**
+ * Some functions to handle addons
+ */
+class Addon
+{
+ /**
+ * @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 (DBM::is_result($r)) {
+ $installed = dba::inArray($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)
+ {
+ $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)
+ {
+ $condition = ['hook' => $hook, 'file' => $file, 'function' => $function];
+ $r = dba::delete('hook', $condition);
+ return $r;
+ }
+
+ /**
+ * Load hooks
+ */
+ public static function loadHooks()
+ {
+ $a = get_app();
+ $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 = get_app();
+
+ 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 = get_app();
+
+ 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 \Friendica\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(\Friendica\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 = get_app();
+
+ 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 = get_app();
+
+ $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 != "") {
+ list($type, $v) = array_map("trim", explode(":", $l, 2));
+ $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;
+ }
+}
projects / friendica.git / blobdiff