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
;
26 // Use superglobals, but since it's deprecated, it's not worth fixing
27 // phpcs:disable MediaWiki.Usage.SuperGlobalsUsage.SuperGlobals
34 * Object-Oriented Ajax functions.
37 class AjaxDispatcher
{
39 * The way the request was made, either a 'get' or a 'post'
45 * Name of the requested handler
46 * @var string $func_name
61 * Load up our object with user supplied data
62 * @param Config $config
64 function __construct( Config
$config ) {
65 $this->config
= $config;
69 if ( !empty( $_GET["rs"] ) ) {
73 if ( !empty( $_POST["rs"] ) ) {
77 switch ( $this->mode
) {
79 $this->func_name
= $_GET["rs"] ??
'';
80 if ( !empty( $_GET["rsargs"] ) ) {
81 $this->args
= $_GET["rsargs"];
87 $this->func_name
= $_POST["rs"] ??
'';
88 if ( !empty( $_POST["rsargs"] ) ) {
89 $this->args
= $_POST["rsargs"];
96 # Or we could throw an exception:
97 # throw new MWException( __METHOD__ . ' called without any data (mode empty).' );
102 * Pass the request to our internal function.
103 * BEWARE! Data are passed as they have been supplied by the user,
104 * they should be carefully handled in the function processing the
109 function performAction( User
$user ) {
110 if ( empty( $this->mode
) ) {
114 if ( !in_array( $this->func_name
, $this->config
->get( 'AjaxExportList' ) ) ) {
115 wfDebug( __METHOD__
. ' Bad Request for unknown function ' . $this->func_name
. "\n" );
119 "unknown function " . $this->func_name
121 } elseif ( !User
::isEveryoneAllowed( 'read' ) && !$user->isAllowed( 'read' ) ) {
125 'You are not allowed to view pages.' );
127 wfDebug( __METHOD__
. ' dispatching ' . $this->func_name
. "\n" );
129 $result = call_user_func_array( $this->func_name
, $this->args
);
131 if ( $result === false ||
$result === null ) {
132 wfDebug( __METHOD__
. ' ERROR while dispatching ' .
133 $this->func_name
. "(" . var_export( $this->args
, true ) . "): " .
134 "no data returned\n" );
136 wfHttpError( 500, 'Internal Error',
137 "{$this->func_name} returned no data" );
139 if ( is_string( $result ) ) {
140 $result = new AjaxResponse( $result );
143 // Make sure DB commit succeeds before sending a response
144 $lbFactory = MediaWikiServices
::getInstance()->getDBLoadBalancerFactory();
145 $lbFactory->commitMasterChanges( __METHOD__
);
147 $result->sendHeaders();
148 $result->printText();
150 wfDebug( __METHOD__
. ' dispatch complete for ' . $this->func_name
. "\n" );
152 } catch ( Exception
$e ) {
153 wfDebug( __METHOD__
. ' ERROR while dispatching ' .
154 $this->func_name
. "(" . var_export( $this->args
, true ) . "): " .
155 get_class( $e ) . ": " . $e->getMessage() . "\n" );
157 if ( !headers_sent() ) {
158 wfHttpError( 500, 'Internal Error',
161 print $e->getMessage();