3 * @copyright Copyright (C) 2010-2022, the Friendica project
5 * @license GNU AGPL version 3 or any later version
7 * This program is free software: you can redistribute it and/or modify
8 * it under the terms of the GNU Affero General Public License as
9 * published by the Free Software Foundation, either version 3 of the
10 * License, or (at your option) any later version.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU Affero General Public License for more details.
17 * You should have received a copy of the GNU Affero General Public License
18 * along with this program. If not, see <https://www.gnu.org/licenses/>.
22 namespace Friendica\Core;
24 use Friendica\Database\DBA;
26 use Friendica\Model\Contact;
27 use Friendica\Util\Strings;
30 * Some functions to handle addons
35 * The addon sub-directory
38 const DIRECTORY = 'addon';
41 * List of the names of enabled addons
45 private static $addons = [];
48 * Returns the list of available addons with their current status and info.
49 * This list is made from scanning the addon/ folder.
50 * Unsupported addons are excluded unless they already are enabled or system.show_unsupported_addon is set.
55 public static function getAvailableList()
58 $files = glob('addon/*/');
59 if (is_array($files)) {
60 foreach ($files as $file) {
62 list($tmp, $addon) = array_map('trim', explode('/', $file));
63 $info = self::getInfo($addon);
65 if (DI::config()->get('system', 'show_unsupported_addons')
66 || strtolower($info['status']) != 'unsupported'
67 || self::isEnabled($addon)
69 $addons[] = [$addon, (self::isEnabled($addon) ? 'on' : 'off'), $info];
79 * Returns a list of addons that can be configured at the node level.
80 * The list is formatted for display in the admin panel aside.
85 public static function getAdminList()
88 $addonsAdminStmt = DBA::select('addon', ['name'], ['plugin_admin' => 1], ['order' => ['name']]);
89 while ($addon = DBA::fetch($addonsAdminStmt)) {
90 $addons_admin[$addon['name']] = [
91 'url' => 'admin/addons/' . $addon['name'],
92 'name' => $addon['name'],
96 DBA::close($addonsAdminStmt);
103 * Synchronize addons:
105 * system.addon contains a comma-separated list of names
106 * of addons which are used on this system.
107 * Go through the database list of already installed addons, and if we have
108 * an entry, but it isn't in the config list, call the uninstall procedure
109 * and mark it uninstalled in the database (for now we'll remove it).
110 * Then go through the config list and if we have a addon that isn't installed,
111 * call the install procedure and add it to the database.
114 public static function loadAddons()
116 $installed_addons = DBA::selectToArray('addon', ['name'], ['installed' => true]);
117 self::$addons = array_column($installed_addons, 'name');
121 * uninstalls an addon.
123 * @param string $addon name of the addon
127 public static function uninstall(string $addon)
129 $addon = Strings::sanitizeFilePathItem($addon);
131 Logger::notice("Addon {addon}: {action}", ['action' => 'uninstall', 'addon' => $addon]);
132 DBA::delete('addon', ['name' => $addon]);
134 @include_once('addon/' . $addon . '/' . $addon . '.php');
135 if (function_exists($addon . '_uninstall')) {
136 $func = $addon . '_uninstall';
140 Hook::delete(['file' => 'addon/' . $addon . '/' . $addon . '.php']);
142 unset(self::$addons[array_search($addon, self::$addons)]);
148 * @param string $addon name of the addon
152 public static function install(string $addon): bool
154 $addon = Strings::sanitizeFilePathItem($addon);
156 $addon_file_path = 'addon/' . $addon . '/' . $addon . '.php';
158 // silently fail if addon was removed of if $addon is funky
159 if (!file_exists($addon_file_path)) {
163 Logger::notice("Addon {addon}: {action}", ['action' => 'install', 'addon' => $addon]);
164 $t = @filemtime($addon_file_path);
165 @include_once($addon_file_path);
166 if (function_exists($addon . '_install')) {
167 $func = $addon . '_install';
171 DBA::insert('addon', [
175 'plugin_admin' => function_exists($addon . '_addon_admin'),
176 'hidden' => file_exists('addon/' . $addon . '/.hidden')
179 if (!self::isEnabled($addon)) {
180 self::$addons[] = $addon;
187 * reload all updated addons
191 public static function reload()
193 $addons = DBA::selectToArray('addon', [], ['installed' => true]);
195 foreach ($addons as $addon) {
196 $addonname = Strings::sanitizeFilePathItem(trim($addon['name']));
197 $addon_file_path = 'addon/' . $addonname . '/' . $addonname . '.php';
198 if (file_exists($addon_file_path) && $addon['timestamp'] == filemtime($addon_file_path)) {
199 // Addon unmodified, skipping
203 Logger::notice("Addon {addon}: {action}", ['action' => 'reload', 'addon' => $addon['name']]);
205 self::uninstall($addon['name']);
206 self::install($addon['name']);
211 * Parse addon comment in search of addon infos.
216 * * Description: An addon which plugs in
218 * * Author: John <profile url>
219 * * Author: Jane <email>
220 * * Maintainer: Jess <email>
223 * @param string $addon the name of the addon
224 * @return array with the addon information
227 public static function getInfo(string $addon): array
229 $addon = Strings::sanitizeFilePathItem($addon);
240 if (!is_file("addon/$addon/$addon.php")) {
244 DI::profiler()->startRecording('file');
245 $f = file_get_contents("addon/$addon/$addon.php");
246 DI::profiler()->stopRecording();
248 $r = preg_match("|/\*.*\*/|msU", $f, $m);
251 $ll = explode("\n", $m[0]);
252 foreach ($ll as $l) {
253 $l = trim($l, "\t\n\r */");
255 $addon_info = array_map("trim", explode(":", $l, 2));
256 if (count($addon_info) < 2) {
260 list($type, $v) = $addon_info;
261 $type = strtolower($type);
262 if ($type == "author" || $type == "maintainer") {
263 $r = preg_match("|([^<]+)<([^>]+)>|", $v, $m);
265 if (!empty($m[2]) && empty(parse_url($m[2], PHP_URL_SCHEME))) {
266 $contact = Contact::getByURL($m[2], false);
267 if (!empty($contact['url'])) {
268 $m[2] = $contact['url'];
271 $info[$type][] = ['name' => $m[1], 'link' => $m[2]];
273 $info[$type][] = ['name' => $v];
276 if (array_key_exists($type, $info)) {
287 * Checks if the provided addon is enabled
289 * @param string $addon
292 public static function isEnabled(string $addon): bool
294 return in_array($addon, self::$addons);
298 * Returns a list of the enabled addon names
302 public static function getEnabledList(): array
304 return self::$addons;
308 * Returns the list of non-hidden enabled addon names
313 public static function getVisibleList(): array
315 $visible_addons = [];
316 $stmt = DBA::select('addon', ['name'], ['hidden' => false, 'installed' => true]);
317 if (DBA::isResult($stmt)) {
318 foreach (DBA::toArray($stmt) as $addon) {
319 $visible_addons[] = $addon['name'];
323 return $visible_addons;