1 files changed, 80 insertions, 51 deletions

diff --git a/include/plugin.php b/include/plugin.php
index 08decc8e3..4d8405b62 100755
--- a/include/plugin.php
+++ b/include/plugin.php
@@ -7,13 +7,12 @@
 
 require_once("include/smarty.php");
 
+
 /**
  * @brief unloads an addon.
  *
  * @param string $plugin name of the addon
- * @return void
  */
-
 function unload_plugin($plugin){
 	logger("Addons: unloading " . $plugin, LOGGER_DEBUG);
 
@@ -28,9 +27,8 @@ function unload_plugin($plugin){
  * @brief uninstalls an addon.
  *
  * @param string $plugin name of the addon
- * @return bool
+ * @return boolean
  */
-
 function uninstall_plugin($plugin) {
 	unload_plugin($plugin);
 
@@ -38,7 +36,7 @@ function uninstall_plugin($plugin) {
 		return false;
 
 	logger("Addons: uninstalling " . $plugin);
-	$t = @filemtime('addon/' . $plugin . '/' . $plugin . '.php');
+	//$t = @filemtime('addon/' . $plugin . '/' . $plugin . '.php');
 	@include_once('addon/' . $plugin . '/' . $plugin . '.php');
 	if(function_exists($plugin . '_uninstall')) {
 		$func = $plugin . '_uninstall';
@@ -68,9 +66,9 @@ function install_plugin($plugin) {
 		$func();
 	}
 
-	$plugin_admin = (function_exists($plugin . "_plugin_admin") ? 1 : 0);
+	$plugin_admin = (function_exists($plugin . '_plugin_admin') ? 1 : 0);
 
-	$r = q("INSERT INTO `addon` (`name`, `installed`, `timestamp`, `plugin_admin`) VALUES ( '%s', 1, %d , %d ) ",
+	q("INSERT INTO `addon` (`name`, `installed`, `timestamp`, `plugin_admin`) VALUES ( '%s', 1, %d , %d ) ",
 		dbesc($plugin),
 		intval($t),
 		$plugin_admin
@@ -91,7 +89,7 @@ function load_plugin($plugin) {
 		return false;
 
 	logger("Addons: loading " . $plugin, LOGGER_DEBUG);
-	$t = @filemtime('addon/' . $plugin . '/' . $plugin . '.php');
+	//$t = @filemtime('addon/' . $plugin . '/' . $plugin . '.php');
 	@include_once('addon/' . $plugin . '/' . $plugin . '.php');
 	if(function_exists($plugin . '_load')) {
 		$func = $plugin . '_load';
@@ -120,6 +118,7 @@ function plugin_is_installed($name) {
 	);
 	if($r)
 		return true;
+
 	return false;
 }
 
@@ -189,12 +188,13 @@ function register_hook($hook, $file, $function, $priority = 0) {
 	if(count($r))
 		return true;
 
-	$r = q("INSERT INTO `hook` (`hook`, `file`, `function`, `priority`) VALUES ( '%s', '%s', '%s', '%s' ) ",
+	$r = q("INSERT INTO `hook` (`hook`, `file`, `function`, `priority`) VALUES ( '%s', '%s', '%s', '%s' )",
 		dbesc($hook),
 		dbesc($file),
 		dbesc($function),
 		dbesc($priority)
 	);
+
 	return $r;
 }
 
@@ -205,7 +205,7 @@ function register_hook($hook, $file, $function, $priority = 0) {
  * @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 mixed
+ * @return array
  */
 function unregister_hook($hook, $file, $function) {
 	$r = q("DELETE FROM hook WHERE hook = '%s' AND `file` = '%s' AND `function` = '%s'",
@@ -213,6 +213,7 @@ function unregister_hook($hook, $file, $function) {
 		dbesc($file),
 		dbesc($function)
 	);
+
 	return $r;
 }
 
@@ -228,11 +229,13 @@ function load_hooks() {
 	$a = get_app();
 //	if(! is_array($a->hooks))
 		$a->hooks = array();
+
 	$r = q("SELECT * FROM hook WHERE true ORDER BY priority DESC");
 	if($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']);
 		}
 	}
@@ -240,8 +243,7 @@ function load_hooks() {
 }
 
 /**
- *
- * @function insert_hook($hook,$fn)
+ * @brief Inserts a hook into a page request.
  *
  * Insert a short-lived hook into the running page request. 
  * Hooks are normally persistent so that they can be called 
@@ -252,36 +254,45 @@ function load_hooks() {
  * which will not persist beyond the life of this page request
  * or the current process. 
  *
- * @param string $hook;
+ * @param string $hook
  *     name of hook to attach callback
- * @param string $fn;
+ * @param string $fn
  *     function name of callback handler
- *
  */ 
-function insert_hook($hook,$fn) {
+function insert_hook($hook, $fn) {
 	$a = get_app();
 	if(! is_array($a->hooks))
 		$a->hooks = array();
-	if(! array_key_exists($hook,$a->hooks))
+
+	if(! array_key_exists($hook, $a->hooks))
 		$a->hooks[$hook] = array();
-	$a->hooks[$hook][] = array('',$fn);
-}
 
+	$a->hooks[$hook][] = array('', $fn);
+}
 
+/**
+ * @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))) {
+	if((is_array($a->hooks)) && (array_key_exists($name, $a->hooks))) {
 		foreach($a->hooks[$name] as $hook) {
 			if($hook[0])
 				@include_once($hook[0]);
+
 			if(function_exists($hook[1])) {
 				$func = $hook[1];
-				$func($a,$data);
-			}
-			else {
+				$func($a, $data);
+			} else {
 				// remove orphan hooks
-				q("delete from hook where hook = '%s' and file = '$s' and function = '%s' limit 1",
+				q("DELETE FROM hook WHERE hook = '%s' AND file = '%s' AND function = '%s'",
 					dbesc($name),
 					dbesc($hook[0]),
 					dbesc($hook[1])
@@ -293,9 +304,10 @@ function call_hooks($name, &$data = null) {
 
 
 /**
- * @brief parse plugin comment in search of plugin infos.
+ * @brief Parse plugin comment in search of plugin infos.
  *
  * like
+ * \code
  *   * Name: Plugin
  *   * Description: A plugin which plugs in
  *   * Version: 1.2.3
@@ -303,21 +315,23 @@ function call_hooks($name, &$data = null) {
  *   * Author: Jane <email>
  *   * Compat: Red [(version)], Friendica [(version)]
  *   *
- *
+ *\endcode
  * @param string $plugin the name of the plugin
  * @return array with the plugin information
  */
 function get_plugin_info($plugin){
-	$info = Array(
+	$m = array();
+	$info = array(
 		'name' => $plugin,
-		'description' => "",
+		'description' => '',
 		'author' => array(),
-		'version' => "",
-		'compat' => ""
+		'version' => '',
+		'compat' => ''
 	);
 
-	if (!is_file("addon/$plugin/$plugin.php")) return $info;
-	
+	if (!is_file("addon/$plugin/$plugin.php"))
+		return $info;
+
 	$f = file_get_contents("addon/$plugin/$plugin.php");
 	$r = preg_match("|/\*.*\*/|msU", $f, $m);
 
@@ -328,7 +342,7 @@ function get_plugin_info($plugin){
 			if ($l != ""){
 				list($k, $v) = array_map("trim", explode(":", $l, 2));
 				$k = strtolower($k);
-				if ($k == "author"){
+				if ($k == 'author'){
 					$r = preg_match("|([^<]+)<([^>]+)>|", $v, $m);
 					if ($r) {
 						$info['author'][] = array('name' => $m[1], 'link' => $m[2]);
@@ -343,14 +357,16 @@ function get_plugin_info($plugin){
 			}
 		}
 	}
+
 	return $info;
 }
 
 
 /**
- * @brief parse theme comment in search of theme infos.
+ * @brief Parse theme comment in search of theme infos.
  *
  * like
+ * \code
  *   * Name: My Theme
  *   * Description: My Cool Theme
  *   * Version: 1.2.3
@@ -358,18 +374,19 @@ function get_plugin_info($plugin){
  *   * Maintainer: Jane <profile url>
  *   * Compat: Friendica [(version)], Red [(version)]
  *   *
- *
+ * \endcode
  * @param string $theme the name of the theme
  * @return array
  */
 function get_theme_info($theme){
-	$info=Array(
+	$m = array();
+	$info = array(
 		'name' => $theme,
-		'description' => "",
+		'description' => '',
 		'author' => array(),
-		'version' => "",
-		'compat' => "",
-		'credits' => "",
+		'version' => '',
+		'compat' => '',
+		'credits' => '',
 		'maintainer' => array(),
 		'experimental' => false,
 		'unsupported' => false
@@ -377,10 +394,12 @@ function get_theme_info($theme){
 
 	if(file_exists("view/theme/$theme/experimental"))
 		$info['experimental'] = true;
+
 	if(file_exists("view/theme/$theme/unsupported"))
 		$info['unsupported'] = true;
 
-	if (!is_file("view/theme/$theme/php/theme.php")) return $info;
+	if (!is_file("view/theme/$theme/php/theme.php"))
+		return $info;
 
 	$f = file_get_contents("view/theme/$theme/php/theme.php");
 	$r = preg_match("|/\*.*\*/|msU", $f, $m);
@@ -392,7 +411,7 @@ function get_theme_info($theme){
 			if ($l != ""){
 				list($k, $v) = array_map("trim", explode(":", $l, 2));
 				$k = strtolower($k);
-				if ($k == "author"){
+				if ($k == 'author'){
 					$r = preg_match("|([^<]+)<([^>]+)>|", $v, $m);
 					if ($r) {
 						$info['author'][] = array('name' => $m[1], 'link' => $m[2]);
@@ -400,7 +419,7 @@ function get_theme_info($theme){
 						$info['author'][] = array('name' => $v);
 					}
 				}
-				elseif ($k == "maintainer"){
+				elseif ($k == 'maintainer'){
 					$r = preg_match("|([^<]+)<([^>]+)>|", $v, $m);
 					if ($r) {
 						$info['maintainer'][] = array('name' => $m[1], 'link' => $m[2]);
@@ -415,10 +434,18 @@ function get_theme_info($theme){
 			}
 		}
 	}
+
 	return $info;
 }
 
-
+/**
+ * @brief Returns the theme's screenshot.
+ *
+ * The screenshot is expected as view/theme/$theme/img/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');
@@ -426,16 +453,15 @@ function get_theme_screenshot($theme) {
 		if(file_exists('view/theme/' . $theme . '/img/screenshot' . $ext))
 			return($a->get_baseurl() . '/view/theme/' . $theme . '/img/screenshot' . $ext);
 	}
+
 	return($a->get_baseurl() . '/images/blank.png');
 }
 
-
 /**
- * @brief add CSS to <head>
+ * @brief add CSS to \<head\>
  *
  * @param string $src
  * @param string $media change media attribute (default to 'screen')
- * @return void
  */
 function head_add_css($src, $media = 'screen') {
 	get_app()->css_sources[] = array($src, $media);
@@ -444,21 +470,23 @@ function head_add_css($src, $media = 'screen') {
 function head_remove_css($src, $media = 'screen') {
 	$a = get_app();
 	$index = array_search(array($src, $media), $a->css_sources);
-	if($index !== false)
+	if ($index !== false)
 		unset($a->css_sources[$index]);
 }
 
 function head_get_css() {
 	$str = '';
 	$sources = get_app()->css_sources;
-	if(count($sources)) 
-		foreach($sources as $source)
+	if (count($sources)) {
+		foreach ($sources as $source)
 			$str .= format_css_if_exists($source);
+	}
+
 	return $str;
 }
 
 function format_css_if_exists($source) {
-	if(strpos($source[0],'/') !== false)
+	if (strpos($source[0], '/') !== false)
 		$path = $source[0];
 	else
 		$path = theme_include($source[0]);
@@ -565,6 +593,7 @@ function theme_include($file, $root = '') {
 		if(file_exists($p))
 			return $p;
 	}
+
 	return '';
 }