<?php
/**
- * @file src/Core/Addon.php
+ * @copyright Copyright (C) 2010-2023, the Friendica project
+ *
+ * @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\BaseObject;
-use Friendica\Database\DBA;
use Friendica\DI;
+use Friendica\Model\Contact;
use Friendica\Util\Strings;
/**
* Some functions to handle addons
*/
-class Addon extends BaseObject
+class Addon
{
/**
* The addon sub-directory
* @return array
* @throws \Exception
*/
- public static function getAvailableList()
+ public static function getAvailableList(): array
{
$addons = [];
$files = glob('addon/*/');
list($tmp, $addon) = array_map('trim', explode('/', $file));
$info = self::getInfo($addon);
- if (Config::get('system', 'show_unsupported_addons')
+ if (DI::config()->get('system', 'show_unsupported_addons')
|| strtolower($info['status']) != 'unsupported'
|| self::isEnabled($addon)
) {
* @return array
* @throws \Exception
*/
- public static function getAdminList()
+ public static function getAdminList(): array
{
$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'],
+ $addons = array_filter(DI::config()->get('addons') ?? []);
+
+ ksort($addons);
+ foreach ($addons as $name => $data) {
+ if (empty($data['admin'])) {
+ continue;
+ }
+
+ $addons_admin[$name] = [
+ 'url' => 'admin/addons/' . $name,
+ 'name' => $name,
'class' => 'addon'
];
}
- DBA::close($addonsAdminStmt);
return $addons_admin;
}
/**
- * @brief Synchronize addons:
+ * Synchronize addons:
*
* system.addon contains a comma-separated list of names
* of addons which are used on this system.
*/
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);
- }
- }
+ self::$addons = array_keys(array_filter(DI::config()->get('addons') ?? []));
}
/**
- * @brief uninstalls an addon.
+ * uninstalls an addon.
*
* @param string $addon name of the addon
* @return void
* @throws \Exception
*/
- public static function uninstall($addon)
+ public static function uninstall(string $addon)
{
$addon = Strings::sanitizeFilePathItem($addon);
- Logger::notice("Addon {addon}: {action}", ['action' => 'uninstall', 'addon' => $addon]);
- DBA::delete('addon', ['name' => $addon]);
+ Logger::debug("Addon {addon}: {action}", ['action' => 'uninstall', 'addon' => $addon]);
+ DI::config()->delete('addons', $addon);
@include_once('addon/' . $addon . '/' . $addon . '.php');
if (function_exists($addon . '_uninstall')) {
$func();
}
- DBA::delete('hook', ['file' => 'addon/' . $addon . '/' . $addon . '.php']);
+ Hook::delete(['file' => 'addon/' . $addon . '/' . $addon . '.php']);
unset(self::$addons[array_search($addon, self::$addons)]);
-
- Addon::saveEnabledList();
}
/**
- * @brief installs an addon.
+ * installs an addon.
*
* @param string $addon name of the addon
* @return bool
* @throws \Exception
*/
- public static function install($addon)
+ public static function install(string $addon): bool
{
$addon = Strings::sanitizeFilePathItem($addon);
+ $addon_file_path = 'addon/' . $addon . '/' . $addon . '.php';
+
// silently fail if addon was removed of if $addon is funky
- if (!file_exists('addon/' . $addon . '/' . $addon . '.php')) {
+ if (!file_exists($addon_file_path)) {
return false;
}
- Logger::notice("Addon {addon}: {action}", ['action' => 'install', 'addon' => $addon]);
- $t = @filemtime('addon/' . $addon . '/' . $addon . '.php');
- @include_once('addon/' . $addon . '/' . $addon . '.php');
+ Logger::debug("Addon {addon}: {action}", ['action' => 'install', 'addon' => $addon]);
+ $t = @filemtime($addon_file_path);
+ @include_once($addon_file_path);
if (function_exists($addon . '_install')) {
$func = $addon . '_install';
$func(DI::app());
+ }
- $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]);
- }
-
- if (!self::isEnabled($addon)) {
- self::$addons[] = $addon;
- }
-
- Addon::saveEnabledList();
+ DI::config()->set('addons', $addon, [
+ 'last_update' => $t,
+ 'admin' => function_exists($addon . '_addon_admin'),
+ ]);
- return true;
- } else {
- Logger::error("Addon {addon}: {action} failed", ['action' => 'install', 'addon' => $addon]);
- return false;
+ if (!self::isEnabled($addon)) {
+ self::$addons[] = $addon;
}
+
+ return true;
}
/**
* reload all updated addons
+ *
+ * @return void
+ * @throws \Exception
+ *
*/
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 = [];
+ $addons = array_filter(DI::config()->get('addons') ?? []);
+
+ foreach ($addons as $name => $data) {
+ $addonname = Strings::sanitizeFilePathItem(trim($name));
+ $addon_file_path = 'addon/' . $addonname . '/' . $addonname . '.php';
+ if (file_exists($addon_file_path) && $data['last_update'] == filemtime($addon_file_path)) {
+ // Addon unmodified, skipping
+ continue;
}
- $addon_list = explode(',', $addons);
-
- 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::debug("Addon {addon}: {action}", ['action' => 'reload', 'addon' => $name]);
- Logger::notice("Addon {addon}: {action}", ['action' => 'reload', 'addon' => $i['name']]);
- @include_once($fname);
-
- if (function_exists($addon . '_uninstall')) {
- $func = $addon . '_uninstall';
- $func(DI::app());
- }
- if (function_exists($addon . '_install')) {
- $func = $addon . '_install';
- $func(DI::app());
- }
- DBA::update('addon', ['timestamp' => $t], ['id' => $i['id']]);
- }
- }
- }
- }
+ self::uninstall($name);
+ self::install($name);
}
}
/**
- * @brief Parse addon comment in search of addon infos.
+ * Parse addon comment in search of addon infos.
*
* like
* \code
* @return array with the addon information
* @throws \Exception
*/
- public static function getInfo($addon)
+ public static function getInfo(string $addon): array
{
- $a = DI::app();
-
$addon = Strings::sanitizeFilePathItem($addon);
$info = [
return $info;
}
- $stamp1 = microtime(true);
+ DI::profiler()->startRecording('file');
$f = file_get_contents("addon/$addon/$addon.php");
- $a->getProfiler()->saveTimestamp($stamp1, "file", System::callstack());
+ DI::profiler()->stopRecording();
$r = preg_match("|/\*.*\*/|msU", $f, $m);
if ($type == "author" || $type == "maintainer") {
$r = preg_match("|([^<]+)<([^>]+)>|", $v, $m);
if ($r) {
+ if (!empty($m[2]) && empty(parse_url($m[2], PHP_URL_SCHEME))) {
+ $contact = Contact::getByURL($m[2], false);
+ if (!empty($contact['url'])) {
+ $m[2] = $contact['url'];
+ }
+ }
$info[$type][] = ['name' => $m[1], 'link' => $m[2]];
} else {
$info[$type][] = ['name' => $v];
* @param string $addon
* @return boolean
*/
- public static function isEnabled($addon)
+ public static function isEnabled(string $addon): bool
{
return in_array($addon, self::$addons);
}
*
* @return array
*/
- public static function getEnabledList()
+ public static function getEnabledList(): array
{
return self::$addons;
}
- /**
- * Saves the current enabled addon list in the system.addon config key
- *
- * @return boolean
- */
- 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()
+ public static function getVisibleList(): array
{
$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'];
- }
+ $addons = array_filter(DI::config()->get('addons') ?? []);
+
+ foreach ($addons as $name => $data) {
+ $visible_addons[] = $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