Reverting r16861; incompatible change to message texts, breaks a lot of toggle displa...
[lhc/web/wiklou.git] / includes / Hooks.php
index b156a6a..575a28c 100644 (file)
@@ -1,7 +1,7 @@
 <?php
 /**
  * Hooks.php -- a tool for running hook functions
- * Copyright 2004, Evan Prodromou <evan@wikitravel.org>.
+ * Copyright 2004, 2005 Evan Prodromou <evan@wikitravel.org>.
  *
  *  This program is free software; you can redistribute it and/or modify
  *  it under the terms of the GNU General Public License as published by
  *
  *  You should have received a copy of the GNU General Public License
  *  along with this program; if not, write to the Free Software
- *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+ *  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
  *
- * @author <evan@wikitravel.org>
+ * @author Evan Prodromou <evan@wikitravel.org>
  * @package MediaWiki
- * @see hooks.doc
+ * @see hooks.txt
  */
 
-if (defined('MEDIAWIKI')) {
-       
-/** 
+
+/**
  * Because programmers assign to $wgHooks, we need to be very
  * careful about its contents. So, there's a lot more error-checking
  * in here than would normally be necessary.
  */
-function wfRunHooks() {
-               
+function wfRunHooks($event, $args = null) {
+
        global $wgHooks;
+       $fname = 'wfRunHooks';
 
        if (!is_array($wgHooks)) {
-               wfDieDebugBacktrace("Global hooks array is not an array!\n");
-               return false;
-       }
-
-       $args = func_get_args();
-
-       if (count($args) < 1) {
-               wfDieDebugBacktrace("No event name given for wfRunHooks().\n");
+               throw new MWException("Global hooks array is not an array!\n");
                return false;
        }
 
-       $event = array_shift($args);
-
        if (!array_key_exists($event, $wgHooks)) {
                return true;
        }
 
        if (!is_array($wgHooks[$event])) {
-               wfDieDebugBacktrace("Hooks array for event '$event' is not an array!\n");
+               throw new MWException("Hooks array for event '$event' is not an array!\n");
                return false;
        }
 
-       foreach ($wgHooks[$event] as $hook) {
-               
+       foreach ($wgHooks[$event] as $index => $hook) {
+
                $object = NULL;
                $method = NULL;
                $func = NULL;
@@ -68,12 +59,12 @@ function wfRunHooks() {
                 * an array of just a function, an array of object and method, or an
                 * array of object, method, and data.
                 */
-               
+
                if (is_array($hook)) {
                        if (count($hook) < 1) {
-                               wfDieDebugBacktrace("Empty array in hooks for " . $event . "\n");
+                               throw new MWException("Empty array in hooks for " . $event . "\n");
                        } else if (is_object($hook[0])) {
-                               $object = $hook[0];
+                               $object = $wgHooks[$event][$index][0];
                                if (count($hook) < 2) {
                                        $method = "on" . $event;
                                } else {
@@ -90,39 +81,51 @@ function wfRunHooks() {
                                        $have_data = true;
                                }
                        } else {
-                               wfDieDebugBacktrace("Unknown datatype in hooks for " . $event . "\n");
+                               var_dump( $wgHooks );
+                               throw new MWException("Unknown datatype in hooks for " . $event . "\n");
                        }
                } else if (is_string($hook)) { # functions look like strings, too
                        $func = $hook;
                } else if (is_object($hook)) {
-                       $object = $hook;
+                       $object = $wgHooks[$event][$index];
                        $method = "on" . $event;
                } else {
-                       wfDieDebugBacktrace("Unknown datatype in hooks for " . $event . "\n");
+                       throw new MWException("Unknown datatype in hooks for " . $event . "\n");
                }
 
+               /* We put the first data element on, if needed. */
+
                if ($have_data) {
                        $hook_args = array_merge(array($data), $args);
                } else {
                        $hook_args = $args;
                }
-               
-               if ($object) {
-                       $retval = call_user_func_array(array($object, $method), $hook_args);
+
+               if ( isset( $object ) ) {
+                       $func = get_class( $object ) . '::' . $method;
+                       $callback = array( $object, $method );
+               } elseif ( false !== ( $pos = strpos( '::', $func ) ) ) {
+                       $callback = array( substr( $func, 0, $pos ), substr( $func, $pos + 2 ) );
                } else {
-                       $retval = call_user_func_array($func, $hook_args);
+                       $callback = $func;
                }
-               
+
+               /* Call the hook. */
+               wfProfileIn( $func );
+               $retval = call_user_func_array( $callback, $hook_args );
+               wfProfileOut( $func );
+
+               /* String return is an error; false return means stop processing. */
+
                if (is_string($retval)) {
                        global $wgOut;
-                       $wgOut->fatalError($retval);
+                       $wgOut->showFatalError($retval);
                        return false;
                } else if (!$retval) {
                        return false;
                }
        }
-       
+
        return true;
 }
-} /* if defined(MEDIAWIKI) */ 
-?>
\ No newline at end of file
+?>