Follow up r62436 comments.
[lhc/web/wiklou.git] / includes / Hooks.php
index cda97a6..dec1c44 100644 (file)
  *
  *  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 Prodromou <evan@wikitravel.org>
- * @package MediaWiki
  * @see hooks.txt
+ * @file
  */
 
 
  * careful about its contents. So, there's a lot more error-checking
  * in here than would normally be necessary.
  */
-function wfRunHooks($event, $args = null) {
+function wfRunHooks($event, $args = array()) {
 
        global $wgHooks;
-       $fname = 'wfRunHooks';
 
-       if (!is_array($wgHooks)) {
-               wfDebugDieBacktrace("Global hooks array is not an array!\n");
-               return false;
+       // Return quickly in the most common case
+       if ( !isset( $wgHooks[$event] ) ) {
+               return true;
        }
 
-       if (!array_key_exists($event, $wgHooks)) {
-               return true;
+       if (!is_array($wgHooks)) {
+               throw new MWException("Global hooks array is not an array!\n");
+               return false;
        }
 
        if (!is_array($wgHooks[$event])) {
-               wfDebugDieBacktrace("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 $index => $hook) {
 
-               $object = NULL;
-               $method = NULL;
-               $func = NULL;
-               $data = NULL;
+               $object = null;
+               $method = null;
+               $func = null;
+               $data = null;
                $have_data = false;
+               $closure = false;
 
                /* $hook can be: a function, an object, an array of $function and $data,
                 * 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) {
-                               wfDebugDieBacktrace("Empty array in hooks for " . $event . "\n");
-                       } else if (is_object($hook[0])) {
-                               $object =& $wgHooks[$event][$index][0];
-                               if (count($hook) < 2) {
-                                       $method = "on" . $event;
-                               } else {
-                                       $method = $hook[1];
-                                       if (count($hook) > 2) {
-                                               $data = $hook[2];
+               if ( is_array( $hook ) ) {
+                       if ( count( $hook ) < 1 ) {
+                               throw new MWException("Empty array in hooks for " . $event . "\n");
+                       } else if ( is_object( $hook[0] ) ) {
+                               $object = $wgHooks[$event][$index][0];
+                               if ( $object instanceof Closure ) {
+                                       $closure = true;
+                                       if ( count( $hook ) > 1 ) {
+                                               $data = $hook[1];
                                                $have_data = true;
                                        }
+                               } else {
+                                       if ( count( $hook ) < 2 ) {
+                                               $method = "on" . $event;
+                                       } else {
+                                               $method = $hook[1];
+                                               if ( count( $hook ) > 2 ) {
+                                                       $data = $hook[2];
+                                                       $have_data = true;
+                                               }
+                                       }
                                }
-                       } else if (is_string($hook[0])) {
+                       } else if ( is_string( $hook[0] ) ) {
                                $func = $hook[0];
-                               if (count($hook) > 1) {
+                               if ( count( $hook ) > 1) {
                                        $data = $hook[1];
                                        $have_data = true;
                                }
                        } else {
-                               var_dump( $wgHooks );
-                               wfDebugDieBacktrace("Unknown datatype in hooks for " . $event . "\n");
+                               throw new MWException( "Unknown datatype in hooks for " . $event . "\n" );
                        }
-               } else if (is_string($hook)) { # functions look like strings, too
+               } else if ( is_string( $hook ) ) { # functions look like strings, too
                        $func = $hook;
-               } else if (is_object($hook)) {
-                       $object =& $wgHooks[$event][$index];
-                       $method = "on" . $event;
+               } else if ( is_object( $hook ) ) {
+                       $object = $wgHooks[$event][$index];
+                       if ( $object instanceof Closure ) {
+                               $closure = true;
+                       } else {
+                               $method = "on" . $event;
+                       }
                } else {
-                       wfDebugDieBacktrace("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) {
+               if ( $have_data ) {
                        $hook_args = array_merge(array($data), $args);
                } else {
                        $hook_args = $args;
                }
 
-
-               if ( isset( $object ) ) {
+               if ( $closure ) {
+                       $callback = $object;
+                       $func = "hook-$event-closure";
+               } elseif ( 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 {
+                       $callback = $func;
                }
 
+               // Run autoloader (workaround for call_user_func_array bug)
+               is_callable( $callback );
+
                /* Call the hook. */
                wfProfileIn( $func );
-               if( isset( $object ) ) {
-                       $retval = call_user_func_array(array(&$object, $method), $hook_args);
-               } else {
-                       $retval = call_user_func_array($func, $hook_args);
-               }
+               $retval = call_user_func_array( $callback, $hook_args );
                wfProfileOut( $func );
 
                /* String return is an error; false return means stop processing. */
 
-               if (is_string($retval)) {
+               if ( is_string( $retval ) ) {
                        global $wgOut;
-                       $wgOut->fatalError($retval);
+                       $wgOut->showFatalError( $retval );
                        return false;
-               } else if (!$retval) {
+               } elseif( $retval === null ) {
+                       if ( $closure ) {
+                               $prettyFunc = "$event closure";
+                       } elseif( is_array( $callback ) ) {
+                               if( is_object( $callback[0] ) ) {
+                                       $prettyClass = get_class( $callback[0] );
+                               } else {
+                                       $prettyClass = strval( $callback[0] );
+                               }
+                               $prettyFunc = $prettyClass . '::' . strval( $callback[1] );
+                       } else {
+                               $prettyFunc = strval( $callback );
+                       }
+                       throw new MWException( "Detected bug in an extension! " .
+                               "Hook $prettyFunc failed to return a value; " .
+                               "should return true to continue hook processing or false to abort." );
+               } else if ( !$retval ) {
                        return false;
                }
        }
 
        return true;
 }
-?>