X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;f=include%2Fplugin.php;h=f6e4a7a88223e651ad5c7ec1131891338571459d;hb=e13b822e1e6fce03fcd7044e5ce8ce0a70c32dd3;hp=f4861536c10726e6ff8b857d73872e49b61c4925;hpb=31312ab1d2f1180a4486fb401fccfed7d9bc4e87;p=friendica.git

diff --git a/include/plugin.php b/include/plugin.php
index f4861536c1..f6e4a7a882 100644
--- a/include/plugin.php
+++ b/include/plugin.php
@@ -1,7 +1,17 @@
 <?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);
@@ -16,6 +26,12 @@ function uninstall_plugin($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
@@ -42,7 +58,7 @@ function install_plugin($plugin) {
 		// 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)
 			);
 		}
@@ -105,10 +121,27 @@ function reload_plugins() {
 
 }}
 
+/**
+ * @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((bool)(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) {
 
@@ -129,6 +162,14 @@ function register_hook($hook,$file,$function,$priority=0) {
 	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) {
 
@@ -155,35 +196,50 @@ function load_hooks() {
 	}
 }}
 
-
-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();
 
-	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];
-				$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
@@ -201,16 +257,20 @@ function plugin_is_app($name) {
 	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')){
@@ -262,16 +322,20 @@ function get_plugin_info($plugin){
 }}
 
 
-/*
- * 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')){
@@ -337,7 +401,14 @@ function get_theme_info($theme){
 	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');
@@ -386,11 +457,11 @@ function install_theme($theme) {
 
 
 // check service_class restrictions. If there are no service_classes defined, everything is allowed.
-// if $usage is supplied, we check against a maximum count and return true if the current usage is 
+// if $usage is supplied, we check against a maximum count and return true if the current usage is
 // less than the subscriber plan allows. Otherwise we return boolean true or false if the property
-// is allowed (or not) in this subscriber plan. An unset property for this service plan means 
-// the property is allowed, so it is only necessary to provide negative properties for each plan, 
-// or what the subscriber is not allowed to do. 
+// is allowed (or not) in this subscriber plan. An unset property for this service plan means
+// the property is allowed, so it is only necessary to provide negative properties for each plan,
+// or what the subscriber is not allowed to do.
 
 
 function service_class_allows($uid,$property,$usage = false) {
@@ -399,7 +470,7 @@ function service_class_allows($uid,$property,$usage = false) {
 		$service_class = $a->user['service_class'];
 	}
 	else {
-		$r = q("select service_class from user where uid = %d limit 1",
+		$r = q("SELECT `service_class` FROM `user` WHERE `uid` = %d LIMIT 1",
 			intval($uid)
 		);
 		if($r !== false and count($r)) {
@@ -429,7 +500,7 @@ function service_class_fetch($uid,$property) {
 		$service_class = $a->user['service_class'];
 	}
 	else {
-		$r = q("select service_class from user where uid = %d limit 1",
+		$r = q("SELECT `service_class` FROM `user` WHERE `uid` = %d LIMIT 1",
 			intval($uid)
 		);
 		if($r !== false and count($r)) {
@@ -467,3 +538,41 @@ function upgrade_bool_message($bbcode = false) {
 	$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 '';
+}