/**
* @file src/Core/Addon.php
*/
+
namespace Friendica\Core;
-use Friendica\App;
use Friendica\BaseObject;
use Friendica\Database\DBA;
+use Friendica\Util\Strings;
/**
* Some functions to handle addons
*/
class Addon extends BaseObject
{
+ /**
+ * The addon sub-directory
+ * @var string
+ */
+ const DIRECTORY = 'addon';
+
/**
* List of the names of enabled addons
*
*/
private static $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 getAvailableList()
+ {
+ $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 (Config::get('system', 'show_unsupported_addons')
+ || strtolower($info['status']) != 'unsupported'
+ || self::isEnabled($addon)
+ ) {
+ $addons[] = [$addon, (self::isEnabled($addon) ? 'on' : 'off'), $info];
+ }
+ }
+ }
+ }
+
+ return $addons;
+ }
+
+ /**
+ * Returns a list of addons that can be configured at the node level.
+ * The list is formatted for display in the admin panel aside.
+ *
+ * @return array
+ * @throws \Exception
+ */
+ public static function getAdminList()
+ {
+ $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);
+
+ return $addons_admin;
+ }
+
+
/**
* @brief Synchronize addons:
*
* @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();
}
+ DBA::delete('hook', ['file' => 'addon/' . $addon . '/' . $addon . '.php']);
+
unset(self::$addons[array_search($addon, self::$addons)]);
+
+ Addon::saveEnabledList();
}
/**
*
* @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);
if (!self::isEnabled($addon)) {
self::$addons[] = $addon;
}
+
+ Addon::saveEnabledList();
+
return true;
} else {
- logger("Addons: FAILED installing " . $addon);
+ Logger::error("Addon {addon}: {action} failed", ['action' => 'install', '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']]);
}
}
}
* *\endcode
* @param string $addon the name of the addon
* @return array with the addon information
+ * @throws \Exception
*/
public static function getInfo($addon)
{
$a = self::getApp();
+ $addon = Strings::sanitizeFilePathItem($addon);
+
$info = [
'name' => $addon,
'description' => "",
$stamp1 = microtime(true);
$f = file_get_contents("addon/$addon/$addon.php");
- $a->saveTimestamp($stamp1, "file");
+ $a->getProfiler()->saveTimestamp($stamp1, "file", System::callstack());
$r = preg_match("|/\*.*\*/|msU", $f, $m);
*/
public static function saveEnabledList()
{
- return Config::set("system", "addon", implode(", ", self::$addons));
+ 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()
{
/**
* Shim of Hook::register left for backward compatibility purpose.
*
- * @see Hook::register
+ * @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)
{
/**
* Shim of Hook::unregister left for backward compatibility purpose.
*
- * @see Hook::unregister
+ * @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)
{
/**
* Shim of Hook::callAll left for backward-compatibility purpose.
*
- * @see Hook::callAll
+ * @see Hook::callAll
* @deprecated since version 2018.12
- * @param string $name of the hook to call
+ * @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)
{
projects / friendica.git / blobdiff