inital commit

webroot/forum/inc/class_plugins.php

@@ -0,0 +1,248 @@
+<?php
+/**
+ * MyBB 1.8
+ * Copyright 2014 MyBB Group, All Rights Reserved
+ * Website: http://www.mybb.com
+ * License: http://www.mybb.com/about/license
+ */
+
+class pluginSystem
+{
+	/**
+	 * The hooks to which plugins can be attached.
+	 *
+	 * @var array
+	 */
+	public $hooks;
+	/**
+	 * The current hook which we're in (if any)
+	 *
+	 * @var string
+	 */
+	public $current_hook;
+
+	/**
+	 * Load all plugins.
+	 */
+	function load()
+	{
+		global $cache, $plugins;
+
+		$plugin_list = $cache->read("plugins");
+		if(!empty($plugin_list['active']) && is_array($plugin_list['active']))
+		{
+			foreach($plugin_list['active'] as $plugin)
+			{
+				if($plugin != "" && file_exists(MYBB_ROOT."inc/plugins/".$plugin.".php"))
+				{
+					require_once MYBB_ROOT."inc/plugins/".$plugin.".php";
+				}
+			}
+		}
+	}
+
+	/**
+	 * Add a hook onto which a plugin can be attached.
+	 *
+	 * @param string       $hook     The hook name.
+	 * @param array|string $function The function of this hook.
+	 * @param int          $priority The priority this hook has.
+	 * @param string       $file     The optional file belonging to this hook.
+	 * @return boolean Whether the hook was added.
+	 */
+	function add_hook($hook, $function, $priority=10, $file="")
+	{
+		if(is_array($function))
+		{
+			if(!count($function) == 2)
+			{ // must be an array of two items!
+				return false;
+			}
+
+			if(is_string($function[0]))
+			{
+				// Static class method
+				$method_representation = sprintf('%s::%s', $function[0], $function[1]);
+			}
+			elseif(is_object($function[0]))
+			{
+				// Instance class method
+				$method_representation = sprintf('%s->%s', spl_object_hash($function[0]), $function[1]);
+			}
+			else
+			{
+				// Unknown array type
+				return false;
+			}
+
+			// Check to see if we already have this hook running at this priority
+			if(!empty($this->hooks[$hook][$priority][$method_representation]) && is_array($this->hooks[$hook][$priority][$method_representation]))
+			{
+				return true;
+			}
+
+			// Add the hook
+			$this->hooks[$hook][$priority][$method_representation] = array(
+				'class_method' => $function,
+				'file'         => $file
+			);
+		}
+		else
+		{
+			// Check to see if we already have this hook running at this priority
+			if(!empty($this->hooks[$hook][$priority][$function]) && is_array($this->hooks[$hook][$priority][$function]))
+			{
+				return true;
+			}
+
+			// Add the hook
+			$this->hooks[$hook][$priority][$function] = array(
+				'function' => $function,
+				'file'     => $file
+			);
+		}
+
+		return true;
+	}
+
+	/**
+	 * Run the hooks that have plugins.
+	 *
+	 * @param string $hook      The name of the hook that is run.
+	 * @param mixed $arguments The argument for the hook that is run. The passed value MUST be a variable
+	 * @return mixed The arguments for the hook.
+	 */
+	function run_hooks($hook, &$arguments="")
+	{
+		if(!isset($this->hooks[$hook]) || !is_array($this->hooks[$hook]))
+		{
+			return $arguments;
+		}
+		$this->current_hook = $hook;
+		ksort($this->hooks[$hook]);
+		foreach($this->hooks[$hook] as $priority => $hooks)
+		{
+			if(is_array($hooks))
+			{
+				foreach($hooks as $key => $hook)
+				{
+					if($hook['file'])
+					{
+						require_once $hook['file'];
+					}
+
+					if(array_key_exists('class_method', $hook))
+					{
+						$return_args = call_user_func_array($hook['class_method'], array(&$arguments));
+					}
+					else
+					{
+						$func = $hook['function'];
+
+						$return_args = $func($arguments);
+					}
+
+					if($return_args)
+					{
+						$arguments = $return_args;
+					}
+				}
+			}
+		}
+		$this->current_hook = '';
+
+		return $arguments;
+	}
+
+	/**
+	 * Remove a specific hook.
+	 *
+	 * @param string       $hook     The name of the hook.
+	 * @param array|string $function The function of the hook.
+	 * @param string       $file     The filename of the plugin.
+	 * @param int          $priority The priority of the hook.
+	 * @return bool Whether the hook was removed successfully.
+	 */
+	function remove_hook($hook, $function, $file="", $priority=10)
+	{
+		if(is_array($function))
+		{
+			if(is_string($function[0]))
+			{ // Static class method
+				$method_representation = sprintf('%s::%s', $function[0], $function[1]);
+			}
+			elseif(is_object($function[0]))
+			{ // Instance class method
+				$method_representation = sprintf('%s->%s', get_class($function[0]), $function[1]);
+			}
+			else
+			{ // Unknown array type
+				return false;
+			}
+
+			if(!isset($this->hooks[$hook][$priority][$method_representation]))
+			{
+				return true;
+			}
+			unset($this->hooks[$hook][$priority][$method_representation]);
+		}
+		else
+		{
+			// Check to see if we don't already have this hook running at this priority
+			if(!isset($this->hooks[$hook][$priority][$function]))
+			{
+				return true;
+			}
+			unset($this->hooks[$hook][$priority][$function]);
+		}
+
+		return true;
+	}
+
+	/**
+	 * Establishes if a particular plugin is compatible with this version of MyBB.
+	 *
+	 * @param string $plugin The name of the plugin.
+	 * @return boolean TRUE if compatible, FALSE if incompatible.
+	 */
+	function is_compatible($plugin)
+	{
+		global $mybb;
+
+		// Ignore potentially missing plugins.
+		if(!file_exists(MYBB_ROOT."inc/plugins/".$plugin.".php"))
+		{
+			return true;
+		}
+
+		require_once MYBB_ROOT."inc/plugins/".$plugin.".php";
+
+		$info_func = "{$plugin}_info";
+		if(!function_exists($info_func))
+		{
+			return false;
+		}
+		$plugin_info = $info_func();
+
+		// No compatibility set or compatibility = * - assume compatible
+		if(!$plugin_info['compatibility'] || $plugin_info['compatibility'] == "*")
+		{
+			return true;
+		}
+		$compatibility = explode(",", $plugin_info['compatibility']);
+		foreach($compatibility as $version)
+		{
+			$version = trim($version);
+			$version = str_replace("*", ".+", preg_quote($version));
+			$version = str_replace("\.+", ".+", $version);
+			if(preg_match("#{$version}#i", $mybb->version_code))
+			{
+				return true;
+			}
+		}
+
+		// Nothing matches
+		return false;
+	}
+}
+