<?php
+/**
+ * @file include/plugin.php
+ *
+ * @brief Some functions to handle addons and themes.
+ */
-// install and uninstall plugin
+/**
+ * @brief uninstalls an addon.
+ *
+ * @param string $plugin name of the addon
+ * @return boolean
+ */
if (! function_exists('uninstall_plugin')){
function uninstall_plugin($plugin){
logger("Addons: uninstalling " . $plugin);
}
}}
+/**
+ * @brief installs an addon.
+ *
+ * @param string $plugin name of the addon
+ * @return bool
+ */
if (! function_exists('install_plugin')){
function install_plugin($plugin) {
// silently fail if plugin was removed
// This way the system won't fall over dead during the update.
if(file_exists('addon/' . $plugin . '/.hidden')) {
- q("update addon set hidden = 1 where name = '%s'",
+ q("UPDATE `addon` SET `hidden` = 1 WHERE `name` = '%s'",
dbesc($plugin)
);
}
if(strlen($plugins)) {
$r = q("SELECT * FROM `addon` WHERE `installed` = 1");
- if(count($r))
+ if (dbm::is_result($r))
$installed = $r;
else
$installed = array();
}}
+/**
+ * @brief check if addon is enabled
+ *
+ * @param string $plugin
+ * @return boolean
+ */
+function plugin_enabled($plugin) {
+ $r = q("SELECT * FROM `addon` WHERE `installed` = 1 AND `name` = '%s'", $plugin);
+ return ((dbm::is_result($r)) && (count($r) > 0));
+}
-
-
+/**
+ * @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
+ */
if(! function_exists('register_hook')) {
function register_hook($hook,$file,$function,$priority=0) {
dbesc($file),
dbesc($function)
);
- if(count($r))
+ if (dbm::is_result($r))
return true;
$r = q("INSERT INTO `hook` (`hook`, `file`, `function`, `priority`) VALUES ( '%s', '%s', '%s', '%s' ) ",
return $r;
}}
+/**
+ * @brief unregisters 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 called
+ * @return array
+ */
if(! function_exists('unregister_hook')) {
function unregister_hook($hook,$file,$function) {
$a = get_app();
$a->hooks = array();
$r = q("SELECT * FROM `hook` WHERE 1 ORDER BY `priority` DESC, `file`");
- if(count($r)) {
- foreach($r as $rr) {
+
+ if (dbm::is_result($r)) {
+ foreach ($r as $rr) {
if(! array_key_exists($rr['hook'],$a->hooks))
$a->hooks[$rr['hook']] = array();
$a->hooks[$rr['hook']][] = array($rr['file'],$rr['function']);
}
}}
-
-if(! function_exists('call_hooks')) {
+/**
+ * @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) {
$stamp1 = microtime(true);
$a = get_app();
- #logger($name, LOGGER_ALL);
-
- if((is_array($a->hooks)) && (array_key_exists($name,$a->hooks))) {
- foreach($a->hooks[$name] as $hook) {
- // 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)
- continue;
+ if (is_array($a->hooks) && array_key_exists($name, $a->hooks))
+ foreach ($a->hooks[$name] as $hook)
+ call_single_hook($a, $name, $hook, $data);
+}
- @include_once($hook[0]);
- if(function_exists($hook[1])) {
- $func = $hook[1];
- //logger($name." => ".$hook[0].":".$func."()", LOGGER_DEBUG);
- $func($a,$data);
- }
- else {
- // remove orphan hooks
- q("delete from hook where hook = '%s' and file = '%s' and function = '%s'",
- dbesc($name),
- dbesc($hook[0]),
- dbesc($hook[1])
- );
- }
- }
+/**
+ * @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
+ q("DELETE FROM `hook` WHERE `hook` = '%s' AND `file` = '%s' AND `function` = '%s'",
+ dbesc($name),
+ dbesc($hook[0]),
+ dbesc($hook[1])
+ );
}
-}}
+}
//check if an app_menu hook exist for plugin $name.
//Return true if the plugin is an app
return false;
}}
-/*
- * parse plugin comment in search of plugin infos.
- * like
+/**
+ * @brief Parse plugin comment in search of plugin infos.
*
- * * Name: Plugin
+ * like
+ * \code
+ *...* Name: Plugin
* * Description: A plugin which plugs in
- * * Version: 1.2.3
+ * . * 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
*/
if (! function_exists('get_plugin_info')){
}}
-/*
- * parse theme comment in search of theme infos.
+/**
+ * @brief Parse theme comment in search of theme infos.
+ *
* like
- *
- * * Name: My Theme
+ * \code
+ * ..* Name: My Theme
* * Description: My Cool Theme
- * * Version: 1.2.3
+ * . * Version: 1.2.3
* * Author: John <profile url>
* * Maintainer: Jane <profile url>
* *
+ * \endcode
+ * @param string $theme the name of the theme
+ * @return array
*/
if (! function_exists('get_theme_info')){
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
+ */
function get_theme_screenshot($theme) {
- $a = get_app();
$exts = array('.png','.jpg');
foreach($exts as $ext) {
- if(file_exists('view/theme/' . $theme . '/screenshot' . $ext))
- return($a->get_baseurl() . '/view/theme/' . $theme . '/screenshot' . $ext);
+ if (file_exists('view/theme/' . $theme . '/screenshot' . $ext)) {
+ return(App::get_baseurl() . '/view/theme/' . $theme . '/screenshot' . $ext);
+ }
}
- return($a->get_baseurl() . '/images/blank.png');
+ return(App::get_baseurl() . '/images/blank.png');
}
// install and uninstall theme
function uninstall_theme($theme){
logger("Addons: uninstalling theme " . $theme);
- @include_once("view/theme/$theme/theme.php");
- if(function_exists("{$theme}_uninstall")) {
+ include_once("view/theme/$theme/theme.php");
+ if (function_exists("{$theme}_uninstall")) {
$func = "{$theme}_uninstall";
$func();
}
function install_theme($theme) {
// silently fail if theme was removed
- if(! file_exists("view/theme/$theme/theme.php"))
+ if (! file_exists("view/theme/$theme/theme.php")) {
return false;
+ }
logger("Addons: installing theme $theme");
- @include_once("view/theme/$theme/theme.php");
+ include_once("view/theme/$theme/theme.php");
- if(function_exists("{$theme}_install")) {
+ if (function_exists("{$theme}_install")) {
$func = "{$theme}_install";
$func();
return true;
- }
- else {
+ } else {
logger("Addons: FAILED installing theme $theme");
return false;
}
function service_class_allows($uid,$property,$usage = false) {
- if($uid == local_user()) {
+ if ($uid == local_user()) {
$service_class = $a->user['service_class'];
- }
- else {
- $r = q("select service_class from user where uid = %d limit 1",
+ } else {
+ $r = q("SELECT `service_class` FROM `user` WHERE `uid` = %d LIMIT 1",
intval($uid)
);
- if($r !== false and count($r)) {
+ if (dbm::is_result($r)) {
$service_class = $r[0]['service_class'];
}
}
- if(! x($service_class))
- return true; // everything is allowed
+
+ if (! x($service_class)) {
+ // everything is allowed
+ return true;
+ }
$arr = get_config('service_class',$service_class);
- if(! is_array($arr) || (! count($arr)))
+ if (! is_array($arr) || (! count($arr))) {
return true;
+ }
- if($usage === false)
+ if ($usage === false) {
return ((x($arr[$property])) ? (bool) $arr['property'] : true);
- else {
- if(! array_key_exists($property,$arr))
+ } else {
+ if (! array_key_exists($property,$arr)) {
return true;
+ }
return (((intval($usage)) < intval($arr[$property])) ? true : false);
}
}
function service_class_fetch($uid,$property) {
- if($uid == local_user()) {
+ if ($uid == local_user()) {
$service_class = $a->user['service_class'];
- }
- else {
- $r = q("select service_class from user where uid = %d limit 1",
+ } else {
+ $r = q("SELECT `service_class` FROM `user` WHERE `uid` = %d LIMIT 1",
intval($uid)
);
- if($r !== false and count($r)) {
+ if (dbm::is_result($r)) {
$service_class = $r[0]['service_class'];
}
}
$x = upgrade_link($bbcode);
return t('This action is not available under your subscription plan.') . (($x) ? ' ' . $x : '') ;
}
+
+/**
+ * @brief Get the full path to relevant theme files by filename
+ *
+ * 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
+ * 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 = '') {
+ // Make sure $root ends with a slash / if it's not blank
+ if($root !== '' && $root[strlen($root)-1] !== '/')
+ $root = $root . '/';
+ $theme_info = $a->theme_info;
+ if(is_array($theme_info) AND 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 = array(
+ "{$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;
+ if(file_exists($p))
+ return $p;
+ }
+ return '';
+}
projects / friendica.git / blobdiff