friendica/include/plugin.php

468 lines
11 KiB
PHP
Raw Normal View History

<?php
2015-11-11 22:41:44 +01:00
/**
2015-12-25 17:26:04 +01:00
* @file include/plugin.php
2017-04-30 06:01:26 +02:00
*
* @brief Some functions to handle addons and themes.
*/
use Friendica\App;
use Friendica\Core\Config;
2017-08-26 08:04:21 +02:00
use Friendica\Core\System;
2017-11-08 04:57:46 +01:00
use Friendica\Database\DBM;
/**
* @brief uninstalls an addon.
*
* @param string $plugin name of the addon
* @return boolean
*/
function uninstall_plugin($plugin) {
logger("Addons: uninstalling " . $plugin);
dba::delete('addon', ['name' => $plugin]);
2013-01-27 13:57:44 +01:00
@include_once('addon/' . $plugin . '/' . $plugin . '.php');
if (function_exists($plugin . '_uninstall')) {
$func = $plugin . '_uninstall';
$func();
}
}
/**
* @brief installs an addon.
*
* @param string $plugin name of the addon
* @return bool
*/
2012-04-06 14:21:42 +02:00
function install_plugin($plugin) {
// silently fail if plugin was removed
if (!file_exists('addon/' . $plugin . '/' . $plugin . '.php')) {
2012-04-06 14:21:42 +02:00
return false;
}
logger("Addons: installing " . $plugin);
2012-01-11 02:47:11 +01:00
$t = @filemtime('addon/' . $plugin . '/' . $plugin . '.php');
@include_once('addon/' . $plugin . '/' . $plugin . '.php');
if (function_exists($plugin . '_install')) {
$func = $plugin . '_install';
$func();
2013-01-27 13:57:44 +01:00
$plugin_admin = (function_exists($plugin."_plugin_admin") ? 1 : 0);
2013-01-27 13:57:44 +01:00
dba::insert('addon', ['name' => $plugin, 'installed' => true,
'timestamp' => $t, 'plugin_admin' => $plugin_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/' . $plugin . '/.hidden')) {
dba::update('addon', ['hidden' => true], ['name' => $plugin]);
}
2012-04-06 14:21:42 +02:00
return true;
} else {
2012-04-06 14:21:42 +02:00
logger("Addons: FAILED installing " . $plugin);
return false;
2012-01-11 02:47:11 +01:00
}
}
// reload all updated plugins
function reload_plugins() {
$plugins = Config::get('system', 'addon');
if (strlen($plugins)) {
$r = q("SELECT * FROM `addon` WHERE `installed` = 1");
if (DBM::is_result($r)) {
$installed = $r;
} else {
$installed = [];
}
$parr = explode(',',$plugins);
2012-05-11 12:41:29 +02:00
if (count($parr)) {
foreach ($parr as $pl) {
2012-05-11 12:41:29 +02:00
$pl = trim($pl);
2012-02-10 07:44:59 +01:00
$fname = 'addon/' . $pl . '/' . $pl . '.php';
if (file_exists($fname)) {
2012-02-10 07:44:59 +01:00
$t = @filemtime($fname);
foreach ($installed as $i) {
if (($i['name'] == $pl) && ($i['timestamp'] != $t)) {
2012-02-10 07:44:59 +01:00
logger('Reloading plugin: ' . $i['name']);
@include_once($fname);
if (function_exists($pl . '_uninstall')) {
2012-02-10 07:44:59 +01:00
$func = $pl . '_uninstall';
$func();
}
if (function_exists($pl . '_install')) {
2012-02-10 07:44:59 +01:00
$func = $pl . '_install';
$func();
}
dba::update('addon', ['timestamp' => $t], ['id' => $i['id']]);
}
}
}
}
}
}
2012-05-11 12:41:29 +02:00
}
2015-11-11 22:41:44 +01:00
/**
* @brief check if addon is enabled
*
* @param string $plugin
* @return boolean
*/
function plugin_enabled($plugin) {
return dba::exists('addon', ['installed' => true, 'name' => $plugin]);
}
/**
* @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
*/
function register_hook($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.
2017-04-30 06:01:26 +02:00
*
* @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
*/
function unregister_hook($hook, $file, $function) {
$condition = ['hook' => $hook, 'file' => $file, 'function' => $function];
$r = dba::delete('hook', $condition);
return $r;
}
function load_hooks() {
$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']];
}
2017-08-10 08:33:24 +02:00
dba::close($r);
}
/**
* @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
*/
function call_hooks($name, &$data = null)
{
$a = get_app();
if (is_array($a->hooks) && array_key_exists($name, $a->hooks)) {
foreach ($a->hooks[$name] as $hook) {
call_single_hook($a, $name, $hook, $data);
}
}
}
2013-02-05 04:53:53 +01:00
/**
* @brief Calls a single hook.
*
* @param string $name of the hook to call
* @param array $hook Hook data
* @param string|array &$data to transmit to the callback handler
*/
function call_single_hook($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/'.current_theme()) === 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);
}
}
//check if an app_menu hook exist for plugin $name.
//Return true if the plugin is an app
function plugin_is_app($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 plugin comment in search of plugin infos.
*
* like
* \code
*...* Name: Plugin
* * Description: A plugin which plugs in
* . * Version: 1.2.3
* * Author: John <profile url>
* * Author: Jane <email>
* *
* *\endcode
* @param string $plugin the name of the plugin
* @return array with the plugin information
*/
function get_plugin_info($plugin) {
2013-01-27 13:57:44 +01:00
$a = get_app();
$info=[
2012-02-25 09:30:14 +01:00
'name' => $plugin,
'description' => "",
'author' => [],
'version' => "",
'status' => ""
];
2012-02-25 09:30:14 +01:00
if (!is_file("addon/$plugin/$plugin.php")) return $info;
$stamp1 = microtime(true);
$f = file_get_contents("addon/$plugin/$plugin.php");
$a->save_timestamp($stamp1, "file");
$r = preg_match("|/\*.*\*/|msU", $f, $m);
if ($r) {
2012-02-25 09:30:14 +01:00
$ll = explode("\n", $m[0]);
foreach ( $ll as $l ) {
2012-02-25 09:30:14 +01:00
$l = trim($l,"\t\n\r */");
if ($l != "") {
2012-02-25 09:30:14 +01:00
list($k,$v) = array_map("trim", explode(":",$l,2));
$k= strtolower($k);
if ($k == "author") {
2012-02-25 09:30:14 +01:00
$r=preg_match("|([^<]+)<([^>]+)>|", $v, $m);
if ($r) {
$info['author'][] = ['name'=>$m[1], 'link'=>$m[2]];
2012-02-25 09:30:14 +01:00
} else {
$info['author'][] = ['name'=>$v];
2012-02-25 09:30:14 +01:00
}
} else {
if (array_key_exists($k,$info)) {
2012-02-25 09:30:14 +01:00
$info[$k]=$v;
}
}
2013-01-27 13:57:44 +01:00
2012-02-25 09:30:14 +01:00
}
}
2013-01-27 13:57:44 +01:00
2012-02-25 09:30:14 +01:00
}
return $info;
}
2012-02-25 09:30:14 +01:00
/**
* @brief Parse theme comment in search of theme infos.
2017-04-30 06:01:26 +02:00
*
2012-02-25 09:30:14 +01:00
* like
* \code
* ..* Name: My Theme
2012-02-25 09:30:14 +01:00
* * Description: My Cool Theme
* . * Version: 1.2.3
2012-02-25 09:30:14 +01:00
* * Author: John <profile url>
* * Maintainer: Jane <profile url>
* *
* \endcode
* @param string $theme the name of the theme
* @return array
2012-02-25 09:30:14 +01:00
*/
function get_theme_info($theme) {
$info=[
2012-02-25 09:30:14 +01:00
'name' => $theme,
'description' => "",
'author' => [],
'maintainer' => [],
'version' => "",
2012-07-24 04:37:00 +02:00
'credits' => "",
'experimental' => false,
'unsupported' => false
];
2012-02-25 09:30:14 +01:00
if (file_exists("view/theme/$theme/experimental"))
$info['experimental'] = true;
if (file_exists("view/theme/$theme/unsupported"))
$info['unsupported'] = true;
2012-02-25 09:30:14 +01:00
if (!is_file("view/theme/$theme/theme.php")) return $info;
2013-01-27 13:57:44 +01:00
$a = get_app();
$stamp1 = microtime(true);
2012-02-25 09:30:14 +01:00
$f = file_get_contents("view/theme/$theme/theme.php");
$a->save_timestamp($stamp1, "file");
2012-02-25 09:30:14 +01: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 != "") {
list($k,$v) = array_map("trim", explode(":",$l,2));
$k= strtolower($k);
if ($k == "author") {
$r=preg_match("|([^<]+)<([^>]+)>|", $v, $m);
if ($r) {
$info['author'][] = ['name'=>$m[1], 'link'=>$m[2]];
} else {
$info['author'][] = ['name'=>$v];
}
} elseif ($k == "maintainer") {
2012-02-25 09:30:14 +01:00
$r=preg_match("|([^<]+)<([^>]+)>|", $v, $m);
if ($r) {
$info['maintainer'][] = ['name'=>$m[1], 'link'=>$m[2]];
2012-02-25 09:30:14 +01:00
} else {
$info['maintainer'][] = ['name'=>$v];
2012-02-25 09:30:14 +01:00
}
} else {
if (array_key_exists($k,$info)) {
$info[$k]=$v;
}
}
}
}
}
return $info;
}
/**
* @brief Returns the theme's screenshot.
*
* The screenshot is expected as view/theme/$theme/screenshot.[png|jpg].
*
* @param sring $theme The name of the theme
* @return string
*/
2012-03-26 02:55:43 +02:00
function get_theme_screenshot($theme) {
$exts = ['.png','.jpg'];
foreach ($exts as $ext) {
if (file_exists('view/theme/' . $theme . '/screenshot' . $ext)) {
return(System::baseUrl() . '/view/theme/' . $theme . '/screenshot' . $ext);
}
2012-03-26 02:55:43 +02:00
}
return(System::baseUrl() . '/images/blank.png');
2012-03-26 02:55:43 +02:00
}
2012-06-24 09:56:27 +02:00
2013-02-05 04:53:53 +01:00
// install and uninstall theme
function uninstall_theme($theme) {
2013-02-05 04:53:53 +01:00
logger("Addons: uninstalling theme " . $theme);
include_once("view/theme/$theme/theme.php");
if (function_exists("{$theme}_uninstall")) {
2013-02-05 04:53:53 +01:00
$func = "{$theme}_uninstall";
$func();
}
}
2013-02-05 04:53:53 +01:00
function install_theme($theme) {
// silently fail if theme was removed
if (! file_exists("view/theme/$theme/theme.php")) {
2013-02-05 04:53:53 +01:00
return false;
}
2013-02-05 04:53:53 +01:00
logger("Addons: installing theme $theme");
include_once("view/theme/$theme/theme.php");
2013-02-05 04:53:53 +01:00
if (function_exists("{$theme}_install")) {
2013-02-05 04:53:53 +01:00
$func = "{$theme}_install";
$func();
return true;
} else {
2013-02-05 04:53:53 +01:00
logger("Addons: FAILED installing theme $theme");
return false;
}
}
2013-02-05 04:53:53 +01:00
/**
* @brief Get the full path to relevant theme files by filename
2017-04-30 06:01:26 +02:00
*
* This function search in the theme directory (and if not present in global theme directory)
* if there is a directory with the file extension and for a file with the given
2017-04-30 06:01:26 +02:00
* filename.
*
* @param string $file Filename
* @param string $root Full root path
* @return string Path to the file or empty string if the file isn't found
*/
function theme_include($file, $root = '') {
2017-08-14 07:47:25 +02:00
$file = basename($file);
// Make sure $root ends with a slash / if it's not blank
if ($root !== '' && $root[strlen($root)-1] !== '/') {
$root = $root . '/';
}
$theme_info = get_app()->theme_info;
if (is_array($theme_info) && array_key_exists('extends',$theme_info)) {
$parent = $theme_info['extends'];
} else {
$parent = 'NOPATH';
}
$theme = current_theme();
$thname = $theme;
$ext = substr($file,strrpos($file,'.')+1);
$paths = [
"{$root}view/theme/$thname/$ext/$file",
"{$root}view/theme/$parent/$ext/$file",
"{$root}view/$ext/$file",
];
foreach ($paths as $p) {
// strpos() is faster than strstr when checking if one string is in another (http://php.net/manual/en/function.strstr.php)
if (strpos($p,'NOPATH') !== false) {
continue;
} elseif (file_exists($p)) {
return $p;
}
}
return '';
}