<?php
-
-/**
-* API for MediaWiki 1.8+
-*
-* Copyright (C) 2006 Yuri Astrakhan <FirstnameLastname@gmail.com>
-*
-* 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.,
-* 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
-* http://www.gnu.org/copyleft/gpl.html
-*/
-
-$wgApiStartTime = microtime(true);
-
/**
- * When no format parameter is given, this format will be used
+ * API for MediaWiki 1.8+
+ *
+ * Copyright (C) 2006 Yuri Astrakhan <Firstname><Lastname>@gmail.com
+ *
+ * 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
*/
-define('API_DEFAULT_FORMAT', 'xmlfm');
/**
- * Location of all api-related files (must end with a slash '/')
+ * This file is the entry point for all API queries. It begins by checking
+ * whether the API is enabled on this wiki; if not, it informs the user that
+ * s/he should set $wgEnableAPI to true and exits. Otherwise, it constructs
+ * a new ApiMain using the parameter passed to it as an argument in the URL
+ * ('?action=') and with write-enabled set to the value of $wgEnableWriteAPI
+ * as specified in LocalSettings.php. It then invokes "execute()" on the
+ * ApiMain object instance, which produces output in the format sepecified
+ * in the URL.
*/
-define('API_DIR', 'includes/api/');
-/**
- * List of classes and containing files.
- */
-$wgApiAutoloadClasses = array (
-
- 'ApiMain' => API_DIR . 'ApiMain.php',
-
- // Utility classes
- 'ApiBase' => API_DIR . 'ApiBase.php',
- 'ApiQueryBase' => API_DIR . 'ApiQueryBase.php',
- 'ApiResult' => API_DIR . 'ApiResult.php',
- 'ApiPageSet' => API_DIR . 'ApiPageSet.php',
-
- // Formats
- 'ApiFormatBase' => API_DIR . 'ApiFormatBase.php',
- 'ApiFormatYaml' => API_DIR . 'ApiFormatYaml.php',
- 'ApiFormatXml' => API_DIR . 'ApiFormatXml.php',
- 'ApiFormatJson' => API_DIR . 'ApiFormatJson.php',
-
- // Modules (action=...) - should match the $apiModules list
- 'ApiHelp' => API_DIR . 'ApiHelp.php',
- 'ApiLogin' => API_DIR . 'ApiLogin.php',
- 'ApiQuery' => API_DIR . 'ApiQuery.php',
-
- // Query items (meta/prop/list=...)
- 'ApiQuerySiteinfo' => API_DIR . 'ApiQuerySiteinfo.php',
- 'ApiQueryInfo' => API_DIR . 'ApiQueryInfo.php',
- 'ApiQueryRevisions' => API_DIR . 'ApiQueryRevisions.php',
- 'ApiQueryAllpages' => API_DIR . 'ApiQueryAllpages.php'
-);
+// So extensions (and other code) can check whether they're running in API mode
+define( 'MW_API', true );
-/**
- * List of available modules: action name => module class
- * The class must also be listed in the $wgApiAutoloadClasses array.
- */
-$wgApiModules = array (
- 'help' => 'ApiHelp',
- 'login' => 'ApiLogin',
- 'query' => 'ApiQuery'
-);
+// Bail if PHP is too low
+if ( !function_exists( 'version_compare' ) || version_compare( phpversion(), '5.2.3' ) < 0 ) {
+ require( dirname( __FILE__ ) . '/includes/PHPVersionError.php' );
+ wfPHPVersionError( 'api.php' );
+}
+
+// Initialise common code.
+if ( isset( $_SERVER['MW_COMPILED'] ) ) {
+ require ( 'phase3/includes/WebStart.php' );
+} else {
+ require ( dirname( __FILE__ ) . '/includes/WebStart.php' );
+}
+
+wfProfileIn( 'api.php' );
+$starttime = microtime( true );
+
+// URL safety checks
+if ( !$wgRequest->checkUrlExtension() ) {
+ return;
+}
+
+// Verify that the API has not been disabled
+if ( !$wgEnableAPI ) {
+ header( $_SERVER['SERVER_PROTOCOL'] . ' 500 MediaWiki configuration Error', true, 500 );
+ echo( 'MediaWiki API is not enabled for this site. Add the following line to your LocalSettings.php'
+ . '<pre><b>$wgEnableAPI=true;</b></pre>' );
+ die(1);
+}
+
+// Selectively allow cross-site AJAX
/**
- * List of available formats: format name => format class
- * The class must also be listed in the $wgApiAutoloadClasses array.
+ * Helper function to convert wildcard string into a regex
+ * '*' => '.*?'
+ * '?' => '.'
+ *
+ * @param $search string
+ * @return string
*/
-$wgApiFormats = array (
- 'json' => 'ApiFormatJson',
- 'jsonfm' => 'ApiFormatJson',
- 'xml' => 'ApiFormatXml',
- 'xmlfm' => 'ApiFormatXml',
- 'yaml' => 'ApiFormatYaml',
- 'yamlfm' => 'ApiFormatYaml'
-);
-
-// Initialise common code
-require (dirname(__FILE__) . '/includes/WebStart.php');
-wfProfileIn('api.php');
+function convertWildcard( $search ) {
+ $search = preg_quote( $search, '/' );
+ $search = str_replace(
+ array( '\*', '\?' ),
+ array( '.*?', '.' ),
+ $search
+ );
+ return "/$search/";
+}
-// Verify that the API has not been disabled
-// The next line should be
-// if (isset ($wgEnableAPI) && !$wgEnableAPI) {
-// but will be in a safe mode until api is stabler
-if (!isset ($wgEnableAPI) || !$wgEnableAPI) {
- echo 'MediaWiki API is not enabled for this site. Add the following line to your LocalSettings.php';
- echo '<pre><b>$wgEnableAPI=true;</b></pre>';
- die(-1);
+if ( $wgCrossSiteAJAXdomains && isset( $_SERVER['HTTP_ORIGIN'] ) ) {
+ $exceptions = array_map( 'convertWildcard', $wgCrossSiteAJAXdomainExceptions );
+ $regexes = array_map( 'convertWildcard', $wgCrossSiteAJAXdomains );
+ foreach ( $regexes as $regex ) {
+ if ( preg_match( $regex, $_SERVER['HTTP_ORIGIN'] ) ) {
+ foreach ( $exceptions as $exc ) { // Check against exceptions
+ if ( preg_match( $exc, $_SERVER['HTTP_ORIGIN'] ) ) {
+ break 2;
+ }
+ }
+ header( "Access-Control-Allow-Origin: {$_SERVER['HTTP_ORIGIN']}" );
+ header( 'Access-Control-Allow-Credentials: true' );
+ break;
+ }
+ }
}
-$wgAutoloadClasses = array_merge($wgAutoloadClasses, $wgApiAutoloadClasses);
+// Set a dummy $wgTitle, because $wgTitle == null breaks various things
+// In a perfect world this wouldn't be necessary
+$wgTitle = Title::makeTitle( NS_MAIN, 'API' );
-if (!isset($wgEnableWriteAPI))
- $wgEnableWriteAPI = false; // This should be 'true' later, once the api is stable.
-
-$processor = new ApiMain($wgApiStartTime, $wgApiModules, $wgApiFormats, $wgEnableWriteAPI);
+/* Construct an ApiMain with the arguments passed via the URL. What we get back
+ * is some form of an ApiMain, possibly even one that produces an error message,
+ * but we don't care here, as that is handled by the ctor.
+ */
+$processor = new ApiMain( $wgRequest, $wgEnableWriteAPI );
+
+// Process data & print results
$processor->execute();
-wfProfileOut('api.php');
+// Execute any deferred updates
+DeferredUpdates::doUpdates();
+
+// Log what the user did, for book-keeping purposes.
+$endtime = microtime( true );
+wfProfileOut( 'api.php' );
wfLogProfilingData();
-exit; // Done!
-?>
+
+// Log the request
+if ( $wgAPIRequestLog ) {
+ $items = array(
+ wfTimestamp( TS_MW ),
+ $endtime - $starttime,
+ $wgRequest->getIP(),
+ $_SERVER['HTTP_USER_AGENT']
+ );
+ $items[] = $wgRequest->wasPosted() ? 'POST' : 'GET';
+ $module = $processor->getModule();
+ if ( $module->mustBePosted() ) {
+ $items[] = "action=" . $wgRequest->getVal( 'action' );
+ } else {
+ $items[] = wfArrayToCGI( $wgRequest->getValues() );
+ }
+ wfErrorLog( implode( ',', $items ) . "\n", $wgAPIRequestLog );
+ wfDebug( "Logged API request to $wgAPIRequestLog\n" );
+}
+
+// Shut down the database. foo()->bar() syntax is not supported in PHP4: we won't ever actually
+// get here to worry about whether this should be = or =&, but the file has to parse properly.
+$lb = wfGetLBFactory();
+$lb->shutdown();
+