*/
namespace Friendica\Core;
-use Friendica\App;
+use Friendica\BaseObject;
use Friendica\Database\DBA;
-
-require_once 'include/dba.php';
+use Friendica\Util\Strings;
/**
* Some functions to handle addons
*/
-class Addon
+class Addon extends BaseObject
{
+ /**
+ * The addon sub-directory
+ * @var string
+ */
+ const DIRECTORY = 'addon';
+
+ /**
+ * List of the names of enabled addons
+ *
+ * @var array
+ */
+ private static $addons = [];
+
+ /**
+ * @brief 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.
+ *
+ */
+ public static function loadAddons()
+ {
+ $installed_addons = [];
+
+ $r = DBA::select('addon', [], ['installed' => 1]);
+ if (DBA::isResult($r)) {
+ $installed_addons = DBA::toArray($r);
+ }
+
+ $addons = Config::get('system', 'addon');
+ $addons_arr = [];
+
+ if ($addons) {
+ $addons_arr = explode(',', str_replace(' ', '', $addons));
+ }
+
+ self::$addons = $addons_arr;
+
+ $installed_arr = [];
+
+ foreach ($installed_addons as $addon) {
+ if (!self::isEnabled($addon['name'])) {
+ self::uninstall($addon['name']);
+ } else {
+ $installed_arr[] = $addon['name'];
+ }
+ }
+
+ foreach (self::$addons as $p) {
+ if (!in_array($p, $installed_arr)) {
+ self::install($p);
+ }
+ }
+ }
+
/**
* @brief uninstalls an addon.
*
* @param string $addon name of the addon
- * @return boolean
+ * @return void
+ * @throws \Exception
*/
public static function uninstall($addon)
{
- logger("Addons: uninstalling " . $addon);
+ $addon = Strings::sanitizeFilePathItem($addon);
+
+ Logger::notice("Addon {addon}: {action}", ['action' => 'uninstall', 'addon' => $addon]);
DBA::delete('addon', ['name' => $addon]);
@include_once('addon/' . $addon . '/' . $addon . '.php');
$func = $addon . '_uninstall';
$func();
}
+
+ unset(self::$addons[array_search($addon, self::$addons)]);
}
/**
*
* @param string $addon name of the addon
* @return bool
+ * @throws \Exception
*/
public static function install($addon)
{
- // silently fail if addon was removed
+ $addon = Strings::sanitizeFilePathItem($addon);
+ // silently fail if addon was removed of if $addon is funky
if (!file_exists('addon/' . $addon . '/' . $addon . '.php')) {
return false;
}
- logger("Addons: installing " . $addon);
+
+ 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();
+ $func(self::getApp());
- $addon_admin = (function_exists($addon."_addon_admin") ? 1 : 0);
+ $addon_admin = (function_exists($addon . "_addon_admin") ? 1 : 0);
DBA::insert('addon', ['name' => $addon, 'installed' => true,
- 'timestamp' => $t, 'plugin_admin' => $addon_admin]);
+ 'timestamp' => $t, 'plugin_admin' => $addon_admin]);
// we can add the following with the previous SQL
// once most site tables have been updated.
if (file_exists('addon/' . $addon . '/.hidden')) {
DBA::update('addon', ['hidden' => true], ['name' => $addon]);
}
+
+ if (!self::isEnabled($addon)) {
+ self::$addons[] = $addon;
+ }
+
return true;
} else {
- logger("Addons: FAILED installing " . $addon);
+ Logger::error("Addon {addon}: {action} failed", ['action' => 'uninstall', 'addon' => $addon]);
return false;
}
}
$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']]);
+ foreach ($addon_list as $addon) {
+ $addon = Strings::sanitizeFilePathItem(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::notice("Addon {addon}: {action}", ['action' => 'reload', 'addon' => $i['name']]);
+ @include_once($fname);
+
+ if (function_exists($addon . '_uninstall')) {
+ $func = $addon . '_uninstall';
+ $func(self::getApp());
+ }
+ if (function_exists($addon . '_install')) {
+ $func = $addon . '_install';
+ $func(self::getApp());
}
+ 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 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 = 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.
*
* *\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 = self::getApp();
+
+ $addon = Strings::sanitizeFilePathItem($addon);
$info = [
'name' => $addon,
$stamp1 = microtime(true);
$f = file_get_contents("addon/$addon/$addon.php");
- $a->save_timestamp($stamp1, "file");
+ $a->getProfiler()->saveTimestamp($stamp1, "file", System::callstack());
$r = preg_match("|/\*.*\*/|msU", $f, $m);
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);
}
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;
+ }
+
+ /**
+ * Saves the current enabled addon list in the system.addon config key
+ *
+ * @return boolean
+ * @throws \Friendica\Network\HTTPException\InternalServerErrorException
+ */
+ public static function saveEnabledList()
+ {
+ return Config::set("system", "addon", implode(", ", 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);
+ }
}
projects / friendica.git / blobdiff