]> scripts.mit.edu Git - autoinstallsdev/mediawiki.git/blobdiff - includes/AjaxDispatcher.php
MediaWiki 1.30.2
[autoinstallsdev/mediawiki.git] / includes / AjaxDispatcher.php
index f7583188a74749b75ebf6ecf30f44153d35c983b..75fcff3654a10b34d8db41872d3deae7443e75db 100644 (file)
@@ -1,39 +1,69 @@
 <?php
 /**
- * @defgroup Ajax Ajax
+ * Handle ajax requests and send them to the proper handler.
+ *
+ * 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
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * 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.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ * http://www.gnu.org/copyleft/gpl.html
  *
  * @file
  * @ingroup Ajax
- * Handle ajax requests and send them to the proper handler.
  */
 
-if ( !( defined( 'MEDIAWIKI' ) && $wgUseAjax ) ) {
-       die( 1 );
-}
+use MediaWiki\MediaWikiServices;
 
-require_once( 'AjaxFunctions.php' );
+/**
+ * @defgroup Ajax Ajax
+ */
 
 /**
  * Object-Oriented Ajax functions.
  * @ingroup Ajax
  */
 class AjaxDispatcher {
-       /** The way the request was made, either a 'get' or a 'post' */
+       /**
+        * The way the request was made, either a 'get' or a 'post'
+        * @var string $mode
+        */
        private $mode;
 
-       /** Name of the requested handler */
+       /**
+        * Name of the requested handler
+        * @var string $func_name
+        */
        private $func_name;
 
-       /** Arguments passed */
+       /** Arguments passed
+        * @var array $args
+        */
        private $args;
 
-       /** Load up our object with user supplied data */
-       function __construct() {
-               wfProfileIn( __METHOD__ );
+       /**
+        * @var Config
+        */
+       private $config;
+
+       /**
+        * Load up our object with user supplied data
+        * @param Config $config
+        */
+       function __construct( Config $config ) {
+               $this->config = $config;
 
                $this->mode = "";
 
-               if ( ! empty( $_GET["rs"] ) ) {
+               if ( !empty( $_GET["rs"] ) ) {
                        $this->mode = "get";
                }
 
@@ -41,78 +71,64 @@ class AjaxDispatcher {
                        $this->mode = "post";
                }
 
-               switch( $this->mode ) {
+               switch ( $this->mode ) {
                        case 'get':
                                $this->func_name = isset( $_GET["rs"] ) ? $_GET["rs"] : '';
-                               if ( ! empty( $_GET["rsargs"] ) ) {
+                               if ( !empty( $_GET["rsargs"] ) ) {
                                        $this->args = $_GET["rsargs"];
                                } else {
-                                       $this->args = array();
+                                       $this->args = [];
                                }
                                break;
                        case 'post':
                                $this->func_name = isset( $_POST["rs"] ) ? $_POST["rs"] : '';
-                               if ( ! empty( $_POST["rsargs"] ) ) {
+                               if ( !empty( $_POST["rsargs"] ) ) {
                                        $this->args = $_POST["rsargs"];
                                } else {
-                                       $this->args = array();
+                                       $this->args = [];
                                }
                                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.
+       /**
+        * 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.
+        *
+        * @param User $user
         */
-       function performAction() {
-               global $wgAjaxExportList, $wgOut, $wgUser;
-
+       function performAction( User $user ) {
                if ( empty( $this->mode ) ) {
                        return;
                }
 
-               wfProfileIn( __METHOD__ );
-
-               if ( ! in_array( $this->func_name, $wgAjaxExportList ) ) {
+               if ( !in_array( $this->func_name, $this->config->get( 'AjaxExportList' ) ) ) {
                        wfDebug( __METHOD__ . ' Bad Request for unknown function ' . $this->func_name . "\n" );
-
                        wfHttpError(
                                400,
                                'Bad Request',
-                               "unknown function " . (string) $this->func_name
+                               "unknown function " . $this->func_name
                        );
-               } elseif ( !in_array( 'read', User::getGroupPermissions( array( '*' ) ), true ) 
-                       && !$wgUser->isAllowed( 'read' ) )
-               {
+               } elseif ( !User::isEveryoneAllowed( 'read' ) && !$user->isAllowed( 'read' ) ) {
                        wfHttpError(
                                403,
                                'Forbidden',
-                               'You must log in to view pages.' );
+                               'You are not allowed to view pages.' );
                } 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( $func, $this->args );
+                               $result = call_user_func_array( $this->func_name, $this->args );
 
                                if ( $result === false || $result === null ) {
-                                       wfDebug( __METHOD__ . ' ERROR while dispatching '
-                                                       . $this->func_name . "(" . var_export( $this->args, true ) . "): "
-                                                       . "no data returned\n" );
+                                       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" );
@@ -121,15 +137,19 @@ class AjaxDispatcher {
                                                $result = new AjaxResponse( $result );
                                        }
 
+                                       // Make sure DB commit succeeds before sending a response
+                                       $lbFactory = MediaWikiServices::getInstance()->getDBLoadBalancerFactory();
+                                       $lbFactory->commitMasterChanges( __METHOD__ );
+
                                        $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" );
+                               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',
@@ -139,8 +159,5 @@ class AjaxDispatcher {
                                }
                        }
                }
-
-               $wgOut = null;
-               wfProfileOut( __METHOD__ );
        }
 }