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

diff --git a/include/plugin.php b/include/plugin.php
index 3eeb0ccaa8..f6e4a7a882 100644
--- a/include/plugin.php
+++ b/include/plugin.php
@@ -1,17 +1,24 @@
 <?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);
 	q("DELETE FROM `addon` WHERE `name` = '%s' ",
 		dbesc($plugin)
 	);
-    
-	// define THISPLUGIN, make life easy to plugin devs :-)
-	define("THISPLUGIN", 'addon/' . $plugin . '/' . $plugin . '.php');
-	
+
 	@include_once('addon/' . $plugin . '/' . $plugin . '.php');
 	if(function_exists($plugin . '_uninstall')) {
 		$func = $plugin . '_uninstall';
@@ -19,13 +26,16 @@ 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
 
-	// define THISPLUGIN, make life easy to plugin devs :-)
-	define("THISPLUGIN", 'addon/' . $plugin . '/' . $plugin . '.php');
-
 	if(! file_exists('addon/' . $plugin . '/' . $plugin . '.php'))
 		return false;
 	logger("Addons: installing " . $plugin);
@@ -34,9 +44,9 @@ function install_plugin($plugin) {
 	if(function_exists($plugin . '_install')) {
 		$func = $plugin . '_install';
 		$func();
-		
+
 		$plugin_admin = (function_exists($plugin."_plugin_admin")?1:0);
-		
+
 		$r = q("INSERT INTO `addon` (`name`, `installed`, `timestamp`, `plugin_admin`) VALUES ( '%s', 1, %d , %d ) ",
 			dbesc($plugin),
 			intval($t),
@@ -48,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' limit 1",
+			q("UPDATE `addon` SET `hidden` = 1 WHERE `name` = '%s'",
 				dbesc($plugin)
 			);
 		}
@@ -83,13 +93,10 @@ function reload_plugins() {
 
 				$fname = 'addon/' . $pl . '/' . $pl . '.php';
 
-				// define THISPLUGIN, make life easy to plugin devs :-)
-				define("THISPLUGIN", $fname);
-
 				if(file_exists($fname)) {
 					$t = @filemtime($fname);
 					foreach($installed as $i) {
-						if(($i['name'] == $pl) && ($i['timestamp'] != $t)) {	
+						if(($i['name'] == $pl) && ($i['timestamp'] != $t)) {
 							logger('Reloading plugin: ' . $i['name']);
 							@include_once($fname);
 
@@ -101,7 +108,7 @@ function reload_plugins() {
 								$func = $pl . '_install';
 								$func();
 							}
-							q("UPDATE `addon` SET `timestamp` = %d WHERE `id` = %d LIMIT 1",
+							q("UPDATE `addon` SET `timestamp` = %d WHERE `id` = %d",
 								intval($t),
 								intval($i['id'])
 							);
@@ -113,11 +120,28 @@ 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) {
 
@@ -138,10 +162,18 @@ 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) {
 
-	$r = q("DELETE FROM `hook` WHERE `hook` = '%s' AND `file` = '%s' AND `function` = '%s' LIMIT 1",
+	$r = q("DELETE FROM `hook` WHERE `hook` = '%s' AND `file` = '%s' AND `function` = '%s'",
 		dbesc($hook),
 		dbesc($file),
 		dbesc($function)
@@ -154,7 +186,7 @@ if(! function_exists('load_hooks')) {
 function load_hooks() {
 	$a = get_app();
 	$a->hooks = array();
-	$r = q("SELECT * FROM `hook` WHERE 1 ORDER BY `priority` DESC");
+	$r = q("SELECT * FROM `hook` WHERE 1 ORDER BY `priority` DESC, `file`");
 	if(count($r)) {
 		foreach($r as $rr) {
 			if(! array_key_exists($rr['hook'],$a->hooks))
@@ -164,60 +196,104 @@ 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) {
-			// define THISPLUGIN, make life easy to plugin devs :-)
-			define("THISPLUGIN", $hook[0]);
-			@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' limit 1",
-					dbesc($name),
-					dbesc($hook[0]),
-					dbesc($hook[1])
-				);
-			}
+	if (is_array($a->hooks) && array_key_exists($name, $a->hooks))
+		foreach ($a->hooks[$name] as $hook)
+			call_single_hook($a, $name, $hook, $data);
+}
+
+/**
+ * @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
+if(! function_exists('plugin_is_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;
 }}
 
-
-/*
- * parse plugin comment in search of plugin infos.
+/**
+ * @brief Parse plugin comment in search of plugin infos.
+ *
  * like
- * 	
- * 	 * Name: Plugin
+ * \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')){
 function get_plugin_info($plugin){
+
+	$a = get_app();
+
 	$info=Array(
 		'name' => $plugin,
 		'description' => "",
 		'author' => array(),
-		'version' => ""
+		'version' => "",
+		'status' => ""
 	);
-	
+
 	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){
 		$ll = explode("\n", $m[0]);
 		foreach( $ll as $l ) {
@@ -237,25 +313,29 @@ function get_plugin_info($plugin){
 						$info[$k]=$v;
 					}
 				}
-				
+
 			}
 		}
-		
+
 	}
 	return $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')){
@@ -277,11 +357,14 @@ function get_theme_info($theme){
 		$info['unsupported'] = true;
 
 	if (!is_file("view/theme/$theme/theme.php")) return $info;
-	
+
+	$a = get_app();
+	$stamp1 = microtime(true);
 	$f = file_get_contents("view/theme/$theme/theme.php");
+	$a->save_timestamp($stamp1, "file");
+
 	$r = preg_match("|/\*.*\*/|msU", $f, $m);
-	
-	
+
 	if ($r){
 		$ll = explode("\n", $m[0]);
 		foreach( $ll as $l ) {
@@ -310,15 +393,22 @@ function get_theme_info($theme){
 						$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
+ */
 function get_theme_screenshot($theme) {
 	$a = get_app();
 	$exts = array('.png','.jpg');
@@ -329,13 +419,49 @@ function get_theme_screenshot($theme) {
 	return($a->get_baseurl() . '/images/blank.png');
 }
 
+// install and uninstall theme
+if (! function_exists('uninstall_theme')){
+function uninstall_theme($theme){
+	logger("Addons: uninstalling theme " . $theme);
+
+	@include_once("view/theme/$theme/theme.php");
+	if(function_exists("{$theme}_uninstall")) {
+		$func = "{$theme}_uninstall";
+		$func();
+	}
+}}
+
+if (! function_exists('install_theme')){
+function install_theme($theme) {
+	// silently fail if theme was removed
+
+	if(! file_exists("view/theme/$theme/theme.php"))
+		return false;
+
+	logger("Addons: installing theme $theme");
+
+	@include_once("view/theme/$theme/theme.php");
+
+	if(function_exists("{$theme}_install")) {
+		$func = "{$theme}_install";
+		$func();
+		return true;
+	}
+	else {
+		logger("Addons: FAILED installing theme $theme");
+		return false;
+	}
+
+}}
+
+
 
 // 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) {
@@ -344,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)) {
@@ -374,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)) {
@@ -412,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 '';
+}