From 7f65bc98adcde87ebd12dfcc3c8963c3a5ce315b Mon Sep 17 00:00:00 2001 From: Meik Sievertsen Date: Sat, 22 Sep 2007 19:18:13 +0000 Subject: [PATCH] new hook system (do not get it confused with events or plugins please) - introducing two new hookable functions too git-svn-id: file:///svn/phpbb/trunk@8100 89ea8834-ac86-4346-8a33-228a782c2dd0 --- phpBB/common.php | 9 + phpBB/docs/CHANGELOG.html | 1 + phpBB/docs/hook_system.html | 858 +++++++++++++++++++++++++++++++++ phpBB/includes/cache.php | 32 ++ phpBB/includes/functions.php | 46 +- phpBB/includes/hooks/index.php | 250 ++++++++++ phpBB/includes/session.php | 4 + phpBB/includes/template.php | 11 +- 8 files changed, 1201 insertions(+), 10 deletions(-) create mode 100644 phpBB/docs/hook_system.html create mode 100644 phpBB/includes/hooks/index.php diff --git a/phpBB/common.php b/phpBB/common.php index 1be8eeec9b..2d8a654dac 100644 --- a/phpBB/common.php +++ b/phpBB/common.php @@ -190,4 +190,13 @@ unset($dbpasswd); // Grab global variables, re-cache if necessary $config = $cache->obtain_config(); +// Add own hook handler +require($phpbb_root_path . 'includes/hooks/index.' . $phpEx); +$phpbb_hook = new phpbb_hook(array('exit_handler', 'phpbb_user_session_handler', 'append_sid', array('template', 'display'))); + +foreach ($cache->obtain_hooks() as $hook) +{ + include($phpbb_root_path . 'includes/hooks/' . $hook . '.' . $phpEx); +} + ?> \ No newline at end of file diff --git a/phpBB/docs/CHANGELOG.html b/phpBB/docs/CHANGELOG.html index 5556adfc4f..bea00592bc 100644 --- a/phpBB/docs/CHANGELOG.html +++ b/phpBB/docs/CHANGELOG.html @@ -107,6 +107,7 @@
  • [Fix] Always display the quote button as the most accessible one - edit is always before quote (Bug #14403)
  • [Fix] Use correct dimension (width x height) in ACP (Bug #14452)
  • [Fix] Only display PM history links if there are PM's to be displayed (Bug #14484)
    • +
  • [Feature] Added completely new hook system to allow better application/mod integration - see docs/hook_system.html

    • 1.ii. Changes since 3.0.RC4

    diff --git a/phpBB/docs/hook_system.html b/phpBB/docs/hook_system.html new file mode 100644 index 0000000000..d877757050 --- /dev/null +++ b/phpBB/docs/hook_system.html @@ -0,0 +1,858 @@ + + + + + + + + + + + + + +phpBB3 • Hook System + + + + + + + +
    + +
    +
    +
    + +
    + +

    Hook System

    +

    This is an explanation of how to use the phpBB3 hook system.

    +

    Skip

    +
    + +
    +
    +
    + + + +
    + +

    Hook System

    + +
    +
    + +
    + +
      +
    1. Introduction
      2. +
    2. Allow hooks in functions/methods
      3. +
    3. Registering hooks
      4. +
    4. Result returning
      5. +
    5. Embedding your hook files/classes/methods
      6. +
    6. Copyright and disclaimer
      7. +
    + +
    + +
    +
    + +
    + +

    1. Introduction

    + +
    +
    + +
    + +

    What is it?

    + +

    The hook system allows applicaton and mod developers to hook into phpBB's or their own functions.

    + +

    Pre-defined hookable phpBB3 functions

    + +

    In phpBB3 there are four functions you are able to hook into with your custom functions:

    + +

    phpbb_user_session_handler(); which is called within user::setup after the session and the user object is correctly initialized.
    +append_sid($url, $params = false, $is_amp = true, $session_id = false); which is called for building urls (appending the session id)
    +$template->display($handle, $include_once = true); which is called directly before outputting the (not-yet-compiled) template.
    +exit_handler(); which is called at the very end of phpBB3's execution.

    + +

    There are also valid external constants you may want to use if you embed phpBB3 into your application:

    + +
    +PHPBB_MSG_HANDLER (overwrite message handler)
+PHPBB_ROOT_PATH   (overwrite $phpbb_root_path)
+PHPBB_ADMIN_PATH  (overwrite $phpbb_admin_path)
+
    + +
    + +
    Back to Top
    + +
    +
    + +

    2. Allow hooks in functions/methods

    + +
    +
    + +
    + +

    The following examples explain how phpBB3 utilize the in-build hook system. You will be more interested in registering your hooks, but showing you this may help you understand the system better along the way.

    + +

    First of all, this is how a function need to be layed out if you want to allow it to be hookable...

    + +
    +function my_own_function($my_first_parameter, $my_second_parameter)
+{
+	global $phpbb_hook;
+
+	if ($phpbb_hook->call_hook(__FUNCTION__, $my_first_parameter, $my_second_parameter))
+	{
+		if ($phpbb_hook->hook_return(__FUNCTION__))
+		{
+			return $phpbb_hook->hook_return_result(__FUNCTION__);
+		}
+	}
+
+	[YOUR CODE HERE]
+}
+
    + +

    Above, the call_hook function should always be mapping your function call... in regard to the number of parameters passed.

    + +

    This is how you could make a method being hookable...

    + +
    +class my_hookable_object
+{
+	function hook_me($my_first_parameter, $my_second_parameter)
+	{
+		global $phpbb_hook;
+
+		if ($phpbb_hook->call_hook(array(get_class(), __FUNCTION__), $my_first_parameter, $my_second_parameter))
+		{
+			if ($phpbb_hook->hook_return(array(get_class(), __FUNCTION__)))
+			{
+				return $phpbb_hook->hook_return_result(array(get_class(), __FUNCTION__));
+			}
+		}
+
+		[YOUR CODE HERE]
+	}
+}
+
    + +

    The only difference about calling it is the way you define the first parameter. For a function it is only __FUNCTION__, for a method it is array(get_class(), __FUNCTION__).

    + +

    Now, in phpBB there are some pre-defined hooks available, but how do you make your own hookable function available (and therefore allowing others to hook into it)? For this, there is the add_hook() method:

    + +
    +// Adding your own hookable function:
+$phpbb_hook->add_hook('my_own_function');
+
+// Adding your own hookable method:
+$phpbb_hook->add_hook(array('my_hookable_object', 'hook_me'));
+
    + +

    You are also able to remove the possibility of hooking a function/method by calling $phpbb_hook->remove_hook() with the same parameters as add_hook().
    +This comes in handy if you want to force some hooks not to be called - at all.

    + +
    + +
    Back to Top
    + +
    +
    + +

    3. Registering hooks

    + +
    +
    + +
    + +

    Registering hooks

    + +

    Now to actually defining your functions which should be called. For this we take the append_sid() function as an example (this function is able to be hooked by default). We create two classes, one being static and a function:

    + +
    +class my_append_sid_class
+{
+	// Our functions
+	function my_append_sid(&$hook, $url, $params = false, $is_amp = true, $session_id = false)
+	{
+		// Get possible previous results
+		$result = $hook->previous_hook_result('append_sid');
+
+		return $result['result'] . '<br />And i was the second one.';
+	}
+}
+
+// Yet another class :o
+class my_second_append_sid_class
+{
+	function my_append_sid(&$hook, $url, $params = false, $is_amp = true, $session_id = false)
+	{
+		// Get possible previous results
+		$result = $hook->previous_hook_result('append_sid');
+
+		echo $result['result'] . '<br />I was called as the third one.';
+	}
+}
+
+// And a normal function
+function my_append_sid(&$hook, $url, $params = false, $is_amp = true, $session_id = false)
+{
+	// Get possible previous results
+	$result = $hook->previous_hook_result('append_sid');
+
+	return 'I was called as the first one';
+}
+
+// Initializing the second class
+$my_second_append_sid_class = new my_second_append_sid_class();
+
    + +

    Make sure you add the same parameters to your function as is defined for the hookable function with one exception: The first variable is always &$hook... this is the hook object itself you are able to operate on.

    + +

    Now we register the hooks one by one with the $phpbb_hook->register() method:

    + +
    +// Now, we register our append_sid "replacements" in a stacked way...
+// Registering the function (this is called first)
+$phpbb_hook->register('append_sid', 'my_append_sid');
+
+// Registering the first class
+$phpbb_hook->register('append_sid', array('my_append_sid_class', 'my_append_sid'));
+$phpbb_hook->register('append_sid', array(&$my_second_append_sid_class, 'my_append_sid'));
+
    + +

    With this you are even able to make your own functions that are already hooked itself being hooked again...

    + +
    +// Registering hook, which will be called
+$phpbb_hook->register('append_sid', 'my_own_append_sid');
+
+// Add hook to our called hook function
+$phpbb_hook->add_hook('my_own_append_sid');
+
+// Register added hook
+$phpbb_hook->register('my_own_append_sid', 'also_my_own_append_sid');
+
    + +

    Special treatment/chains

    + +

    The register method is able to take a third argument to specify a special 'chain' mode. The valid modes are first, last and standalone

    + +

    $phpbb_hook->register('append_sid', 'my_own_append_sid', 'first') would make sure that the function is called in the beginning of the chain. It is possible that more than one function is called within the first block - here the FIFO principle is used.

    + +

    $phpbb_hook->register('append_sid', 'my_own_append_sid', 'last') would make sure that the function is called at the very end of the chain. It is possible that more than one function is called within the last block - here the FIFO principle is used.

    + +

    $phpbb_hook->register('append_sid', 'my_own_append_sid', 'standalone') makes sure only the defined function is called. All other functions are removed from the chain and no other functions are added to it later on. If two applications try to trigger the standalone mode a PHP notice will be printed and the second function being discarded.

    + +

    Only allowing hooks for some objects

    + +

    Because the hook system is not able to differate between initialized objects and only operate on the class, you need to solve this on the code level.

    + +

    One possibility would be to use a property:

    + + 
    +class my_hookable_object
+{
+	function blabla()
+	{
+	}
+}
+
+class my_hookable_object2 extends my_hookable_object
+{
+	var $call_hook = true;
+
+	function hook_me($my_first_parameter, $my_second_parameter)
+	{
+		if ($this->call_hook)
+		{
+			global $phpbb_hook;
+
+			if ($phpbb_hook->call_hook(array(get_class(), __FUNCTION__), $my_first_parameter, $my_second_parameter))
+			{
+				if ($phpbb_hook->hook_return(array(get_class(), __FUNCTION__)))
+				{
+					return $phpbb_hook->hook_return_result(array(get_class(), __FUNCTION__));
+				}
+			}
+		}
+
+		return 'not hooked';
+	}
+}
+
+function hooking(&$hook, $first, $second)
+{
+	return 'hooked';
+}
+
+$first_object = new my_hookable_object2();
+$second_object = new my_hookable_object2();
+
+$phpbb_hook->add_hook(array('my_hookable_object2', 'hook_me'));
+
+$phpbb_hook->register(array('my_hookable_object2', 'hook_me'), 'hooking');
+
+// Do not call the hook for $first_object
+$first_object->call_hook = false;
+
+echo $first_object->hook_me('first', 'second') . '<br />';
+echo $second_object->hook_me('first', 'second') . '<br />';
+
    + +

    OUTPUT:

    + +
    +not hooked
+hooked 
+
    + +

    A different possibility would be using a function variable (which could be left out on passing the function variables to the hook):

    + + 
    +class my_hookable_object
+{
+	function blabla()
+	{
+	}
+}
+
+class my_hookable_object2 extends my_hookable_object
+{
+	function hook_me($my_first_parameter, $my_second_parameter, $hook_me = true)
+	{
+		if ($hook_me)
+		{
+			global $phpbb_hook;
+
+			if ($phpbb_hook->call_hook(array(get_class(), __FUNCTION__), $my_first_parameter, $my_second_parameter))
+			{
+				if ($phpbb_hook->hook_return(array(get_class(), __FUNCTION__)))
+				{
+					return $phpbb_hook->hook_return_result(array(get_class(), __FUNCTION__));
+				}
+			}
+		}
+
+		return 'not hooked';
+	}
+}
+
+function hooking(&$hook, $first, $second)
+{
+	return 'hooked';
+}
+
+$first_object = new my_hookable_object2();
+$second_object = new my_hookable_object2();
+
+$phpbb_hook->add_hook(array('my_hookable_object2', 'hook_me'));
+
+$phpbb_hook->register(array('my_hookable_object2', 'hook_me'), 'hooking');
+
+echo $first_object->hook_me('first', 'second', false) . '<br />';
+echo $second_object->hook_me('first', 'second') . '<br />';
+
    + +

    OUTPUT:

    + + 
    +not hooked
+hooked 
+
    + +
    + +
    Back to Top
    + +
    +
    + +

    4. Result returning

    + +
    +
    + +
    + +

    Generally, the distinction has to be made if a function returns the result obtained from the called function or continue the execution. Based on the needs of the application this may differ. Therefore, the function returns the results only if the called hook function is returning a result.

    + +

    Case 1 - Returning the result

    + +

    Imagine the following function supporting hooks:

    + +
    +function append_sid($url, $params = false, $is_amp = true, $session_id = false)
+{
+	global $_SID, $_EXTRA_URL, $phpbb_hook;
+
+	// Developers using the hook function need to globalise the $_SID and $_EXTRA_URL on their own and also handle it appropiatly.
+	// They could mimick most of what is within this function
+	if ($phpbb_hook->call_hook(__FUNCTION__, $url, $params, $is_amp, $session_id))
+	{
+		if ($phpbb_hook->hook_return(__FUNCTION__))
+		{
+			return $phpbb_hook->hook_return_result(__FUNCTION__);
+		}
+	}
+
+	[...]
+}
+
    + +

    Now, the following function is yours. Since you return a value, the append_sid() function itself is returning it as is:

    + +
    +// The function called
+function my_append_sid(&$hook, $url, $params = false, $is_amp = true, $session_id = false)
+{
+	// Get possible previous results
+	$result = $hook->previous_hook_result('append_sid');
+
+	return 'Since i return something the append_sid() function will return my result.';
+}
+
    + +

    To be able to get the results returned from functions higher in the change the previous_hook_result() method should always be used, it returns an array('result' => [your result]) construct.

    + +

    Case 2 - Not Returning any result

    + +

    Sometimes applications want to return nothing and therefore force the underlying function to continue it's execution:

    + +
    +function append_sid($url, $params = false, $is_amp = true, $session_id = false)
+{
+	global $_SID, $_EXTRA_URL, $phpbb_hook;
+
+	// Developers using the hook function need to globalise the $_SID and $_EXTRA_URL on their own and also handle it appropiatly.
+	// They could mimick most of what is within this function
+	if ($phpbb_hook->call_hook(__FUNCTION__, $url, $params, $is_amp, $session_id))
+	{
+		if ($phpbb_hook->hook_return(__FUNCTION__))
+		{
+			return $phpbb_hook->hook_return_result(__FUNCTION__);
+		}
+	}
+
+	[...]
+}
+
+// The function called
+function my_append_sid(&$hook, $url, $params = false, $is_amp = true, $session_id = false)
+{
+	// Get possible previous results
+	$result = $hook->previous_hook_result('append_sid');
+
+	[...]
+
+	// I only rewrite some variables, but return nothing. Therefore, the append_sid() function will not return my (non)result.
+}
+
    + +

    Please Note: The decision to return or not return is solely made of the very last function call within the hook chain. An example:

    + +
    +// The function called
+function my_append_sid(&$hook, $url, $params = false, $is_amp = true, $session_id = false)
+{
+	// Get possible previous results
+	$result = $hook->previous_hook_result('append_sid');
+
+	// $result is not filled
+
+	return 'FILLED';
+}
+
+// This function is registered too and gets executed after my_append_sid()
+function my_own_append_sid(&$hook, $url, $params = false, $is_amp = true, $session_id = false)
+{
+	$result = $hook->previous_hook_result('append_sid');
+
+	// $result is actually filled with $result['result'] = 'FILLED'
+	// But i return nothing, therefore append_sid() continues it's execution.
+}
+
+// The way both functions are registered.
+$phpbb_hook->register('append_sid', 'my_append_sid');
+$phpbb_hook->register('append_sid', 'my_own_append_sid');
+
    + +
    + +
    Back to Top
    + +
    +
    + +

    5. Embedding your hook files/classes/methods

    + +
    +
    + +
    + +

    There are basically two methods you are able to choose from:

    + +

    1) Add a file to includes/hooks/. The file need to be prefixed by hook_. This file is included within common.php, you are able to register your hooks, include other files or functions, etc. It is advised to only include other files if needed (within a function call for example).

    + +

    Please be aware that you need to purge your cache within the ACP to make your newly placed file available to phpBB3.

    + +

    2) The second method is meant for those wanting to wrap phpBB3 without placing a custom file to the hooks directory. This is mostly done by including phpBB's files within the application file. To be able to register your hooks you need to create a function within your application:

    + +
    +// My function which gets executed within the hooks constuctor
+function phpbb_hook_register(&$hook)
+{
+	$hook->register('append_sid', 'my_append_sid');
+}
+
+[...]
+
    + +

    You should get the idea. ;)

    + +
    + +
    Back to Top
    + +
    +
    + +

    6. Copyright and disclaimer

    + +
    +
    + +
    + +

    This application is opensource software released under the GPL. Please see source code and the docs directory for more details. This package and its contents are Copyright (c) 2000, 2002, 2005, 2007 phpBB Group, All Rights Reserved.

    + +
    + +
    Back to Top
    + +
    +
    + +
    +
    $Id$
    +
    +
    + +
    + +
    + + + diff --git a/phpBB/includes/cache.php b/phpBB/includes/cache.php index 97b98e1227..77fc5e30f3 100644 --- a/phpBB/includes/cache.php +++ b/phpBB/includes/cache.php @@ -403,6 +403,38 @@ class cache extends acm return $usernames; } + + /** + * Obtain hooks... + */ + function obtain_hooks() + { + global $phpbb_root_path, $phpEx; + + if (($hook_files = $this->get('_hooks')) === false) + { + $hook_files = array(); + + // Now search in acp and mods folder for permissions_ files. + $dh = @opendir($phpbb_root_path . 'includes/hooks/'); + + if ($dh) + { + while (($file = readdir($dh)) !== false) + { + if (strpos($file, 'hook_') === 0 && substr($file, -(strlen($phpEx) + 1)) === '.' . $phpEx) + { + $hook_files[] = substr($file, 0, -(strlen($phpEx) + 1)); + } + } + closedir($dh); + } + + $this->put('_hooks', $hook_files); + } + + return $hook_files; + } } ?> \ No newline at end of file diff --git a/phpBB/includes/functions.php b/phpBB/includes/functions.php index 004c4d8828..60d4297ff4 100644 --- a/phpBB/includes/functions.php +++ b/phpBB/includes/functions.php @@ -1564,7 +1564,8 @@ function on_page($num_items, $per_page, $start) // Server functions (building urls, redirecting...) /** -* Append session id to url +* Append session id to url. +* This function supports hooks. * * @param string $url The url the session id needs to be appended to (can have params) * @param mixed $params String or array of additional url parameters @@ -1579,17 +1580,19 @@ function on_page($num_items, $per_page, $start) * append_sid("{$phpbb_root_path}viewtopic.$phpEx", array('t' => 1, 'f' => 2)); * * -* Ability to use own function append_sid_phpbb_hook as a hook. It is called in favor of this function. */ function append_sid($url, $params = false, $is_amp = true, $session_id = false) { - global $_SID, $_EXTRA_URL; + global $_SID, $_EXTRA_URL, $phpbb_hook; // Developers using the hook function need to globalise the $_SID and $_EXTRA_URL on their own and also handle it appropiatly. // They could mimick most of what is within this function - if (function_exists('append_sid_phpbb_hook')) + if ($phpbb_hook->call_hook(__FUNCTION__, $url, $params, $is_amp, $session_id)) { - return append_sid_phpbb_hook($url, $params, $is_amp, $session_id); + if ($phpbb_hook->hook_return(__FUNCTION__)) + { + return $phpbb_hook->hook_return_result(__FUNCTION__); + } } // Assign sid if session id is not specified @@ -4333,20 +4336,45 @@ function garbage_collection() } /** -* Handler for exit calls in phpBB +* Handler for exit calls in phpBB. +* This function supports hooks. * -* Ability to use own function exit_handler_phpbb_hook as a hook. It is called in favor of this function. +* Note: This function is called after the template has been outputted. */ function exit_handler() { - if (function_exists('exit_handler_phpbb_hook')) + global $phpbb_hook; + + if ($phpbb_hook->call_hook(__FUNCTION__)) { - return exit_handler_phpbb_hook(); + if ($phpbb_hook->hook_return(__FUNCTION__)) + { + return $phpbb_hook->hook_return_result(__FUNCTION__); + } } exit; } +/** +* Handler for init calls in phpBB. This function is called in user::setup(); +* This function supports hooks. +*/ +function phpbb_user_session_handler() +{ + global $phpbb_hook; + + if ($phpbb_hook->call_hook(__FUNCTION__)) + { + if ($phpbb_hook->hook_return(__FUNCTION__)) + { + return $phpbb_hook->hook_return_result(__FUNCTION__); + } + } + + return; +} + /** * @package phpBB3 */ diff --git a/phpBB/includes/hooks/index.php b/phpBB/includes/hooks/index.php new file mode 100644 index 0000000000..e784b460a9 --- /dev/null +++ b/phpBB/includes/hooks/index.php @@ -0,0 +1,250 @@ + $method) + { + $this->add_hook($method); + } + + if (function_exists('phpbb_hook_register')) + { + phpbb_hook_register($this); + } + } + + /** + * Register function/method to be called within hook + * This function is normally called by the modification/application to attach/register the functions. + * + * @param mixed $definition Declaring function (with __FUNCTION__) or class with array(get_class(), __FUNCTION) + * @param mixed $hook The replacement function/method to be called. Passing function name or array with object/class definition + * @param string $mode Specify the priority/chain mode. 'normal' -> hook gets appended to the chain. 'standalone' -> only the specified hook gets called - later hooks are not able to overwrite this (E_NOTICE is triggered then). 'first' -> hook is called as the first one within the chain. 'last' -> hook is called as the last one within the chain. + */ + function register($definition, $hook, $mode = 'normal') + { + $class = (!is_array($definition)) ? '__global' : $definition[0]; + $function = (!is_array($definition)) ? $definition : $definition[1]; + + // Method able to be hooked? + if (isset($this->hooks[$class][$function])) + { + switch ($mode) + { + case 'standalone': + if (!isset($this->hooks[$class][$function]['standalone'])) + { + $this->hooks[$class][$function] = array('standalone' => $hook); + } + else + { + trigger_error('Hook not able to be called standalone, previous hook already standalone.', E_NOTICE); + } + break; + + case 'first': + case 'last': + $this->hooks[$class][$function][$mode][] = $hook; + break; + + case 'normal': + default: + $this->hooks[$class][$function]['normal'][] = $hook; + break; + } + } + } + + /** + * Calling all functions/methods attached to a specified hook. + * Called by the function allowing hooks... + * + * @param mixed $definition Declaring function (with __FUNCTION__) or class definition with array(). Must be call_user_func_array() compatible. + * @return bool False if no hook got executed, true otherwise + */ + function call_hook($definition) + { + $class = (!is_array($definition)) ? '__global' : $definition[0]; + $function = (!is_array($definition)) ? $definition : $definition[1]; + + if (!empty($this->hooks[$class][$function])) + { + // Developer tries to call a hooked function within the hooked function... + if ($this->current_hook !== NULL && $this->current_hook['class'] === $class && $this->current_hook['function'] === $function) + { + return false; + } + + // Call the hook with the arguments attached and store result + $arguments = func_get_args(); + $this->current_hook = array('class' => $class, 'function' => $function); + $arguments[0] = &$this; + + // Call the hook chain... + if (isset($this->hooks[$class][$function]['standalone'])) + { + $this->hook_result[$class][$function] = call_user_func_array($this->hooks[$class][$function]['standalone'], $arguments); + } + else + { + foreach (array('first', 'normal', 'last') as $mode) + { + if (!isset($this->hooks[$class][$function][$mode])) + { + continue; + } + + foreach ($this->hooks[$class][$function][$mode] as $hook) + { + $this->hook_result[$class][$function] = call_user_func_array($hook, $arguments); + } + } + } + + $this->current_hook = NULL; + return true; + } + + $this->current_hook = NULL; + return false; + } + + /** + * Get result from previously called functions/methods for the same hook + * + * @param mixed $definition Declaring function (with __FUNCTION__) or class with array(get_class(), __FUNCTION) + * @return mixed False if nothing returned if there is no result, else array('result' => ... ) + */ + function previous_hook_result($definition) + { + $class = (!is_array($definition)) ? '__global' : $definition[0]; + $function = (!is_array($definition)) ? $definition : $definition[1]; + + if (!empty($this->hooks[$class][$function]) && isset($this->hook_result[$class][$function])) + { + return array('result' => $this->hook_result[$class][$function]); + } + + return false; + } + + /** + * Check if the called functions/methods returned something. + * + * @param mixed $definition Declaring function (with __FUNCTION__) or class with array(get_class(), __FUNCTION) + * @return bool True if results are there, false if not + */ + function hook_return($definition) + { + $class = (!is_array($definition)) ? '__global' : $definition[0]; + $function = (!is_array($definition)) ? $definition : $definition[1]; + + if (!empty($this->hooks[$class][$function]) && isset($this->hook_result[$class][$function])) + { + return true; + } + + return false; + } + + /** + * Give actual result from called functions/methods back. + * + * @param mixed $definition Declaring function (with __FUNCTION__) or class with array(get_class(), __FUNCTION) + * @return mixed The result + */ + function hook_return_result($definition) + { + $class = (!is_array($definition)) ? '__global' : $definition[0]; + $function = (!is_array($definition)) ? $definition : $definition[1]; + + if (!empty($this->hooks[$class][$function]) && isset($this->hook_result[$class][$function])) + { + $result = $this->hook_result[$class][$function]; + unset($this->hook_result[$class][$function]); + return $result; + } + + return; + } + + /** + * Add new function to the allowed hooks. + * + * @param mixed $definition Declaring function (with __FUNCTION__) or class with array(get_class(), __FUNCTION) + */ + function add_hook($definition) + { + if (!is_array($definition)) + { + $definition = array('__global', $definition); + } + + $this->hooks[$definition[0]][$definition[1]] = array(); + } + + /** + * Remove function from the allowed hooks. + * + * @param mixed $definition Declaring function (with __FUNCTION__) or class with array(get_class(), __FUNCTION) + */ + function remove_hook($definition) + { + $class = (!is_array($definition)) ? '__global' : $definition[0]; + $function = (!is_array($definition)) ? $definition : $definition[1]; + + if (isset($this->hooks[$class][$function])) + { + unset($this->hooks[$class][$function]); + + if (isset($this->hook_result[$class][$function])) + { + unset($this->hook_result[$class][$function]); + } + } + } +} + +?> \ No newline at end of file diff --git a/phpBB/includes/session.php b/phpBB/includes/session.php index d9cc85a154..cbb70e8601 100644 --- a/phpBB/includes/session.php +++ b/phpBB/includes/session.php @@ -1518,6 +1518,10 @@ class user extends session } } + // Call phpbb_user_session_handler() in case external application want to "bend" some variables or replace classes... + // After calling it we continue script execution... + phpbb_user_session_handler(); + // If this function got called from the error handler we are finished here. if (defined('IN_ERROR_HANDLER')) { diff --git a/phpBB/includes/template.php b/phpBB/includes/template.php index b13dbaa99a..ca118fb632 100644 --- a/phpBB/includes/template.php +++ b/phpBB/includes/template.php @@ -147,7 +147,16 @@ class template */ function display($handle, $include_once = true) { - global $user; + global $user, $phpbb_hook; + + // To let users change the complete templated page (all variables available) + if ($phpbb_hook->call_hook(array(get_class(), __FUNCTION__), $handle, $include_once)) + { + if ($phpbb_hook->hook_return(array(get_class(), __FUNCTION__))) + { + return $phpbb_hook->hook_return_result(array(get_class(), __FUNCTION__)); + } + } if (defined('IN_ERROR_HANDLER')) {