3 * Handle ajax requests and send them to the proper handler.
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 * http://www.gnu.org/copyleft/gpl.html
24 use MediaWiki\MediaWikiServices
;
31 * Object-Oriented Ajax functions.
34 class AjaxDispatcher
{
36 * The way the request was made, either a 'get' or a 'post'
42 * Name of the requested handler
43 * @var string $func_name
58 * Load up our object with user supplied data
60 function __construct( Config
$config ) {
61 $this->config
= $config;
65 if ( !empty( $_GET["rs"] ) ) {
69 if ( !empty( $_POST["rs"] ) ) {
73 switch ( $this->mode
) {
75 $this->func_name
= isset( $_GET["rs"] ) ?
$_GET["rs"] : '';
76 if ( !empty( $_GET["rsargs"] ) ) {
77 $this->args
= $_GET["rsargs"];
83 $this->func_name
= isset( $_POST["rs"] ) ?
$_POST["rs"] : '';
84 if ( !empty( $_POST["rsargs"] ) ) {
85 $this->args
= $_POST["rsargs"];
92 # Or we could throw an exception:
93 # throw new MWException( __METHOD__ . ' called without any data (mode empty).' );
98 * Pass the request to our internal function.
99 * BEWARE! Data are passed as they have been supplied by the user,
100 * they should be carefully handled in the function processing the
105 function performAction( User
$user ) {
106 if ( empty( $this->mode
) ) {
110 if ( !in_array( $this->func_name
, $this->config
->get( 'AjaxExportList' ) ) ) {
111 wfDebug( __METHOD__
. ' Bad Request for unknown function ' . $this->func_name
. "\n" );
115 "unknown function " . $this->func_name
117 } elseif ( !User
::isEveryoneAllowed( 'read' ) && !$user->isAllowed( 'read' ) ) {
121 'You are not allowed to view pages.' );
123 wfDebug( __METHOD__
. ' dispatching ' . $this->func_name
. "\n" );
125 $result = call_user_func_array( $this->func_name
, $this->args
);
127 if ( $result === false ||
$result === null ) {
128 wfDebug( __METHOD__
. ' ERROR while dispatching ' .
129 $this->func_name
. "(" . var_export( $this->args
, true ) . "): " .
130 "no data returned\n" );
132 wfHttpError( 500, 'Internal Error',
133 "{$this->func_name} returned no data" );
135 if ( is_string( $result ) ) {
136 $result = new AjaxResponse( $result );
139 // Make sure DB commit succeeds before sending a response
140 $lbFactory = MediaWikiServices
::getInstance()->getDBLoadBalancerFactory();
141 $lbFactory->commitMasterChanges( __METHOD__
);
143 $result->sendHeaders();
144 $result->printText();
146 wfDebug( __METHOD__
. ' dispatch complete for ' . $this->func_name
. "\n" );
148 } catch ( Exception
$e ) {
149 wfDebug( __METHOD__
. ' ERROR while dispatching ' .
150 $this->func_name
. "(" . var_export( $this->args
, true ) . "): " .
151 get_class( $e ) . ": " . $e->getMessage() . "\n" );
153 if ( !headers_sent() ) {
154 wfHttpError( 500, 'Internal Error',
157 print $e->getMessage();