friendica-github/src/Core/Addon.php

420 lines
10 KiB
PHP
Raw Normal View History

2018-02-06 19:35:10 +00:00
<?php
/**
* @file src/Core/Addon.php
*/
2018-02-06 19:35:10 +00:00
namespace Friendica\Core;
use Friendica\BaseObject;
use Friendica\Database\DBA;
2019-04-01 01:53:08 +00:00
use Friendica\Util\Strings;
2018-02-06 19:35:10 +00:00
/**
* Some functions to handle addons
*/
class Addon extends BaseObject
2018-02-06 19:35:10 +00:00
{
2019-02-04 08:33:55 +00:00
/**
* The addon sub-directory
* @var string
*/
2019-02-05 22:36:01 +00:00
const DIRECTORY = 'addon';
2019-02-04 08:33:55 +00:00
/**
* List of the names of enabled addons
*
* @var array
*/
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:
*
* 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 = [];
2018-10-05 23:21:05 +00:00
$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);
}
}
}
2018-02-06 19:35:10 +00:00
/**
* @brief uninstalls an addon.
*
* @param string $addon name of the addon
2019-01-06 21:06:53 +00:00
* @return void
* @throws \Exception
2018-02-06 19:35:10 +00:00
*/
public static function uninstall($addon)
{
2019-04-01 01:53:08 +00:00
$addon = Strings::sanitizeFilePathItem($addon);
2018-12-30 20:42:56 +00:00
Logger::notice("Addon {addon}: {action}", ['action' => 'uninstall', 'addon' => $addon]);
DBA::delete('addon', ['name' => $addon]);
2018-02-06 19:35:10 +00:00
@include_once('addon/' . $addon . '/' . $addon . '.php');
if (function_exists($addon . '_uninstall')) {
$func = $addon . '_uninstall';
$func();
}
DBA::delete('hook', ['file' => 'addon/' . $addon . '/' . $addon . '.php']);
unset(self::$addons[array_search($addon, self::$addons)]);
Addon::saveEnabledList();
2018-02-06 19:35:10 +00:00
}
/**
* @brief installs an addon.
*
* @param string $addon name of the addon
* @return bool
2019-01-06 21:06:53 +00:00
* @throws \Exception
2018-02-06 19:35:10 +00:00
*/
public static function install($addon)
{
2019-04-01 01:53:08 +00:00
$addon = Strings::sanitizeFilePathItem($addon);
2018-02-06 19:35:10 +00:00
2019-04-01 01:53:08 +00:00
// silently fail if addon was removed of if $addon is funky
2018-02-06 19:35:10 +00:00
if (!file_exists('addon/' . $addon . '/' . $addon . '.php')) {
return false;
}
2019-04-01 01:53:08 +00:00
2018-12-30 20:42:56 +00:00
Logger::notice("Addon {addon}: {action}", ['action' => 'install', 'addon' => $addon]);
2018-02-06 19:35:10 +00:00
$t = @filemtime('addon/' . $addon . '/' . $addon . '.php');
@include_once('addon/' . $addon . '/' . $addon . '.php');
if (function_exists($addon . '_install')) {
$func = $addon . '_install';
$func(self::getApp());
2018-02-06 19:35:10 +00:00
$addon_admin = (function_exists($addon . "_addon_admin") ? 1 : 0);
2018-02-06 19:35:10 +00:00
DBA::insert('addon', ['name' => $addon, 'installed' => true,
'timestamp' => $t, 'plugin_admin' => $addon_admin]);
2018-02-06 19:35:10 +00:00
// 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]);
2018-02-06 19:35:10 +00:00
}
if (!self::isEnabled($addon)) {
self::$addons[] = $addon;
}
2019-04-01 01:53:08 +00:00
Addon::saveEnabledList();
2018-02-06 19:35:10 +00:00
return true;
} else {
Logger::error("Addon {addon}: {action} failed", ['action' => 'install', 'addon' => $addon]);
2018-02-06 19:35:10 +00:00
return false;
}
}
/**
* reload all updated addons
*/
public static function reload()
{
$addons = Config::get('system', 'addon');
if (strlen($addons)) {
$r = DBA::select('addon', [], ['installed' => 1]);
2018-07-21 12:46:04 +00:00
if (DBA::isResult($r)) {
2018-07-21 02:03:40 +00:00
$installed = DBA::toArray($r);
2018-02-06 19:35:10 +00:00
} else {
$installed = [];
}
$addon_list = explode(',', $addons);
2019-04-01 01:53:08 +00:00
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());
2018-02-06 19:35:10 +00:00
}
2019-04-01 01:53:08 +00:00
DBA::update('addon', ['timestamp' => $t], ['id' => $i['id']]);
2018-02-06 19:35:10 +00:00
}
}
}
}
}
}
/**
* @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
2019-01-06 21:06:53 +00:00
* @throws \Exception
2018-02-06 19:35:10 +00:00
*/
public static function getInfo($addon)
{
$a = self::getApp();
2018-02-06 19:35:10 +00:00
2019-04-01 01:53:08 +00:00
$addon = Strings::sanitizeFilePathItem($addon);
2018-02-06 19:35:10 +00:00
$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->getProfiler()->saveTimestamp($stamp1, "file", System::callstack());
2018-02-06 19:35:10 +00:00
$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 != "") {
$addon_info = array_map("trim", explode(":", $l, 2));
if (count($addon_info) < 2) {
continue;
}
list($type, $v) = $addon_info;
2018-02-06 19:35:10 +00:00
$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;
}
/**
* Checks if the provided addon is enabled
*
* @param string $addon
* @return boolean
*/
public static function isEnabled($addon)
{
return in_array($addon, self::$addons);
}
2018-10-21 11:53:16 +00:00
/**
* 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
*/
public static function saveEnabledList()
{
return Config::set('system', 'addon', implode(',', self::$addons));
}
/**
* Returns the list of non-hidden enabled addon names
*
* @return array
2019-01-06 21:06:53 +00:00
* @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.
*
2019-01-06 21:06:53 +00:00
* @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
2019-01-06 21:06:53 +00:00
* @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.
*
2019-01-06 21:06:53 +00:00
* @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
2019-01-06 21:06:53 +00:00
* @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.
*
2019-01-06 21:06:53 +00:00
* @see Hook::callAll
* @deprecated since version 2018.12
2019-01-06 21:06:53 +00:00
* @param string $name of the hook to call
* @param string|array &$data to transmit to the callback handler
2019-01-06 21:06:53 +00:00
* @throws \Friendica\Network\HTTPException\InternalServerErrorException
*/
public static function callHooks($name, &$data = null)
{
Hook::callAll($name, $data);
}
2018-02-06 19:35:10 +00:00
}