* (bug 20336) changed json_decode json_encode to static class in global functions

[lhc/web/wiklou.git] / includes / AjaxDispatcher.php

diff --git a/includes/AjaxDispatcher.php b/includes/AjaxDispatcher.php
index bb4709b..c489cf1 100644 (file)
--- a/includes/AjaxDispatcher.php
+++ b/includes/AjaxDispatcher.php
@@ -1,22 +1,33 @@
 <?php
+/**
+ * @defgroup Ajax Ajax
+ *
+ * @file
+ * @ingroup Ajax
+ * Handle ajax requests and send them to the proper handler.
+ */
 
-if( !defined( 'MEDIAWIKI' ) )
-        die( 1 );
-
-if ( ! $wgUseAjax ) {
+if( !(defined( 'MEDIAWIKI' ) && $wgUseAjax ) ) {
        die( 1 );
 }
 
 require_once( 'AjaxFunctions.php' );
 
 /**
- * @todo Document - e.g. Provide top-level description of this class.
+ * Object-Oriented Ajax functions.
+ * @ingroup Ajax
  */
 class AjaxDispatcher {
-       var $mode;
-       var $func_name;
-       var $args;
+       /** The way the request was made, either a 'get' or a 'post' */
+       private $mode;
+
+       /** Name of the requested handler */
+       private $func_name;
+
+       /** Arguments passed */
+       private $args;
 
+       /** Load up our object with user supplied data */
        function __construct() {
                wfProfileIn( __METHOD__ );
 
@@ -30,24 +41,42 @@ class AjaxDispatcher {
                        $this->mode = "post";
                }
 
-               if ($this->mode == "get") {
+               switch( $this->mode ) {
+
+               case 'get':
                        $this->func_name = isset( $_GET["rs"] ) ? $_GET["rs"] : '';
                        if (! empty($_GET["rsargs"])) {
                                $this->args = $_GET["rsargs"];
                        } else {
                                $this->args = array();
                        }
-               } else {
+               break;
+
+               case 'post':
                        $this->func_name = isset( $_POST["rs"] ) ? $_POST["rs"] : '';
                        if (! empty($_POST["rsargs"])) {
                                $this->args = $_POST["rsargs"];
                        } else {
                                $this->args = array();
                        }
+               break;
+
+               default:
+                       wfProfileOut( __METHOD__ );
+                       return;
+                       # Or we could throw an exception:
+                       #throw new MWException( __METHOD__ . ' called without any data (mode empty).' );
+
                }
+
                wfProfileOut( __METHOD__ );
        }
 
+       /** Pass the request to our internal function.
+        * BEWARE! Data are passed as they have been supplied by the user,
+        * they should be carefully handled in the function processing the
+        * request.
+        */
        function performAction() {
                global $wgAjaxExportList, $wgOut;
 
@@ -57,13 +86,26 @@ class AjaxDispatcher {
                wfProfileIn( __METHOD__ );
 
                if (! in_array( $this->func_name, $wgAjaxExportList ) ) {
+                       wfDebug( __METHOD__ . ' Bad Request for unknown function ' . $this->func_name . "\n" );
+
                        wfHttpError( 400, 'Bad Request',
                                "unknown function " . (string) $this->func_name );
                } else {
+                       wfDebug( __METHOD__ . ' dispatching ' . $this->func_name . "\n" );
+
+                       if ( strpos( $this->func_name, '::' ) !== false ) {
+                               $func = explode( '::', $this->func_name, 2 );
+                       } else {
+                               $func = $this->func_name;
+                       }
                        try {
-                               $result = call_user_func_array($this->func_name, $this->args);
+                               $result = call_user_func_array($func, $this->args);
 
                                if ( $result === false || $result === NULL ) {
+                                       wfDebug( __METHOD__ . ' ERROR while dispatching ' 
+                                                       . $this->func_name . "(" . var_export( $this->args, true ) . "): " 
+                                                       . "no data returned\n" );
+
                                        wfHttpError( 500, 'Internal Error',
                                                "{$this->func_name} returned no data" );
                                }
@@ -74,9 +116,15 @@ class AjaxDispatcher {
 
                                        $result->sendHeaders();
                                        $result->printText();
+
+                                       wfDebug( __METHOD__ . ' dispatch complete for ' . $this->func_name . "\n" );
                                }
 
                        } catch (Exception $e) {
+                               wfDebug( __METHOD__ . ' ERROR while dispatching ' 
+                                               . $this->func_name . "(" . var_export( $this->args, true ) . "): " 
+                                               . get_class($e) . ": " . $e->getMessage() . "\n" );
+
                                if (!headers_sent()) {
                                        wfHttpError( 500, 'Internal Error',
                                                $e->getMessage() );
@@ -90,5 +138,3 @@ class AjaxDispatcher {
                $wgOut = null;
        }
 }
-
-?>