Add support for Number grouping(commafy) based on CLDR number grouping patterns like...
[lhc/web/wiklou.git] / includes / AjaxDispatcher.php
index 2704e27..17b154d 100644 (file)
 <?php
+/**
+ * @defgroup Ajax Ajax
+ *
+ * @file
+ * @ingroup Ajax
+ * Handle ajax requests and send them to the proper handler.
+ */
 
-//$wgRequestTime = microtime();
-
-// unset( $IP );
-// @ini_set( 'allow_url_fopen', 0 ); # For security...
-
-# Valid web server entry point, enable includes.
-# Please don't move this line to includes/Defines.php. This line essentially defines
-# a valid entry point. If you put it in includes/Defines.php, then any script that includes
-# it becomes an entry point, thereby defeating its purpose.
-// define( 'MEDIAWIKI', true );
-// require_once( './includes/Defines.php' );
-// require_once( './LocalSettings.php' );
-// require_once( 'includes/Setup.php' );
-require_once( 'AjaxFunctions.php' );
-
-if ( ! $wgUseAjax ) {
-       die( 1 );
-}
-
+/**
+ * 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;
 
-       function AjaxDispatcher() {
-               global $wgAjaxCachePolicy;
+       /** Name of the requested handler */
+       private $func_name;
 
-               wfProfileIn( 'AjaxDispatcher::AjaxDispatcher' );
+       /** Arguments passed */
+       private $args;
 
-               $wgAjaxCachePolicy = new AjaxCachePolicy();
+       /** Load up our object with user supplied data */
+       function __construct() {
+               wfProfileIn( __METHOD__ );
 
                $this->mode = "";
 
-               if (! empty($_GET["rs"])) {
+               if ( ! empty( $_GET["rs"] ) ) {
                        $this->mode = "get";
                }
 
-               if (!empty($_POST["rs"])) {
+               if ( !empty( $_POST["rs"] ) ) {
                        $this->mode = "post";
                }
 
-               if ($this->mode == "get") {
-                       $this->func_name = $_GET["rs"];
-                       if (! empty($_GET["rsargs"])) {
-                               $this->args = $_GET["rsargs"];
-                       } else {
-                               $this->args = array();
-                       }
-               } else {
-                       $this->func_name = $_POST["rs"];
-                       if (! empty($_POST["rsargs"])) {
-                               $this->args = $_POST["rsargs"];
-                       } else {
-                               $this->args = array();
-                       }
+               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();
+                               }
+                               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( 'AjaxDispatcher::AjaxDispatcher' );
+
+               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 $wgAjaxCachePolicy, $wgAjaxExportList, $wgOut;
+               global $wgAjaxExportList, $wgOut;
+
                if ( empty( $this->mode ) ) {
                        return;
                }
-               wfProfileIn( 'AjaxDispatcher::performAction' );
 
-               if (! in_array( $this->func_name, $wgAjaxExportList ) ) {
-                       echo "-:{$this->func_name} not callable";
+               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 {
-                       echo "+:";
-                       $result = call_user_func_array($this->func_name, $this->args);
-                       header( 'Content-Type: text/html; charset=utf-8', true );
-                       $wgAjaxCachePolicy->writeHeader();
-                       echo $result;
+                       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( $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" );
+                               } else {
+                                       if ( is_string( $result ) ) {
+                                               $result = new AjaxResponse( $result );
+                                       }
+
+                                       $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() );
+                               } else {
+                                       print $e->getMessage();
+                               }
+                       }
                }
-               wfProfileOut( 'AjaxDispatcher::performAction' );
+
                $wgOut = null;
+               wfProfileOut( __METHOD__ );
        }
 }
-
-?>