ApiBase.php: coding style cleanup, added more braces, trimmed trailing spaces, change...
[lhc/web/wiklou.git] / api.php
diff --git a/api.php b/api.php
index d75ef10..10baa13 100644 (file)
--- a/api.php
+++ b/api.php
-<?php\r
-\r
-\r
-/**\r
-* API for MediaWiki 1.8+\r
-*\r
-* Copyright (C) 2006 Yuri Astrakhan <FirstnameLastname@gmail.com>\r
-*\r
-* This program is free software; you can redistribute it and/or modify\r
-* it under the terms of the GNU General Public License as published by\r
-* the Free Software Foundation; either version 2 of the License, or\r
-* (at your option) any later version.\r
-*\r
-* This program is distributed in the hope that it will be useful,\r
-* but WITHOUT ANY WARRANTY; without even the implied warranty of\r
-* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\r
-* GNU General Public License for more details.\r
-*\r
-* You should have received a copy of the GNU General Public License along\r
-* with this program; if not, write to the Free Software Foundation, Inc.,\r
-* 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.\r
-* http://www.gnu.org/copyleft/gpl.html\r
-*/\r
-\r
-$wgApiStartTime = microtime(true);\r
-\r
-/**\r
- * When no format parameter is given, this format will be used\r
- */\r
-define('API_DEFAULT_FORMAT', 'xmlfm');\r
-\r
-/**\r
- * List of classes and containing files.\r
- */\r
-$wgApiAutoloadClasses = array (\r
-\r
-       'ApiMain' => 'ApiMain.php',\r
-\r
-               // Utility classes\r
-       'ApiBase' => 'ApiBase.php',\r
-       'ApiQueryBase' => 'ApiQueryBase.php',\r
-       'ApiResult' => 'ApiResult.php',\r
-       'ApiPageSet' => 'ApiPageSet.php',\r
-\r
-               // Formats\r
-       'ApiFormatBase' => 'ApiFormatBase.php',\r
-       'ApiFormatYaml' => 'ApiFormatYaml.php',\r
-       'ApiFormatXml' => 'ApiFormatXml.php',\r
-       'ApiFormatJson' => 'ApiFormatJson.php',\r
-\r
-               // Modules (action=...) - should match the $apiModules list\r
-       'ApiHelp' => 'ApiHelp.php',\r
-       'ApiLogin' => 'ApiLogin.php',\r
-       'ApiQuery' => 'ApiQuery.php',\r
-\r
-               // Query items (meta/prop/list=...)\r
-       'ApiQuerySiteinfo' => 'ApiQuerySiteinfo.php',\r
-       'ApiQueryInfo' => 'ApiQueryInfo.php',\r
-       'ApiQueryRevisions' => 'ApiQueryRevisions.php',\r
-       'ApiQueryAllpages' => 'ApiQueryAllpages.php'\r
-);\r
-\r
-/**\r
- * List of available modules: action name => module class\r
- * The class must also be listed in the $wgApiAutoloadClasses array. \r
- */\r
-$wgApiModules = array (\r
-       'help' => 'ApiHelp',\r
-       'login' => 'ApiLogin',\r
-       'query' => 'ApiQuery'\r
-);\r
-\r
-/**\r
- * List of available formats: format name => format class\r
- * The class must also be listed in the $wgApiAutoloadClasses array. \r
- */\r
-$wgApiFormats = array (\r
-       'json' => 'ApiFormatJson',\r
-       'jsonfm' => 'ApiFormatJson',\r
-       'xml' => 'ApiFormatXml',\r
-       'xmlfm' => 'ApiFormatXml',\r
-       'yaml' => 'ApiFormatYaml',\r
-       'yamlfm' => 'ApiFormatYaml'\r
-);\r
-\r
-// Initialise common code\r
-require (dirname(__FILE__) . "/includes/WebStart.php");\r
-wfProfileIn('api.php');\r
-\r
-// Verify that the API has not been disabled\r
-// The next line should be \r
-//      if (isset ($wgEnableAPI) && !$wgEnableAPI) {\r
-// but will be in a safe mode until api is stabler\r
-if (!isset ($wgEnableAPI) || !$wgEnableAPI) {\r
-       echo 'MediaWiki API is not enabled for this site. Add the following line to your LocalSettings.php';\r
-       echo '<pre><b>$wgEnableAPI=true;</b></pre>';\r
-       die(-1);\r
-}\r
-\r
-apiInitAutoloadClasses($wgApiAutoloadClasses, "$IP/includes/api/");\r
-$processor = new ApiMain($wgApiStartTime, $wgApiModules, $wgApiFormats);\r
-$processor->execute();\r
-\r
-wfProfileOut('api.php');\r
-wfLogProfilingData();\r
-exit; // Done!\r
-\r
-function apiInitAutoloadClasses($apiAutoloadClasses, $apiDirectory) {\r
-\r
-       // Prefix each api class with the proper prefix,\r
-       // and append them to $wgAutoloadClasses\r
-       global $wgAutoloadClasses;\r
-\r
-       foreach ($apiAutoloadClasses as $className => $classFile)\r
-               $wgAutoloadClasses[$className] = $apiDirectory . $classFile;\r
-}\r
-?>
\ No newline at end of file
+<?php
+
+/**
+ * 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.,
+ * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
+ * http://www.gnu.org/copyleft/gpl.html
+ *
+ * @file
+ */
+
+/**
+ * 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.
+ */
+
+// Initialise common code
+require ( dirname( __FILE__ ) . '/includes/WebStart.php' );
+
+wfProfileIn( 'api.php' );
+$starttime = microtime( true );
+
+// URL safety checks
+//
+// See RawPage.php for details; summary is that MSIE can override the
+// Content-Type if it sees a recognized extension on the URL, such as
+// might be appended via PATH_INFO after 'api.php'.
+//
+// Some data formats can end up containing unfiltered user-provided data
+// which will end up triggering HTML detection and execution, hence
+// XSS injection and all that entails.
+//
+if ( $wgRequest->isPathInfoBad() ) {
+       wfHttpError( 403, 'Forbidden',
+               'Invalid file extension found in PATH_INFO. ' .
+               'The API must be accessed through the primary script entry point.' );
+       return;
+}
+
+// Verify that the API has not been disabled
+if ( !$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 );
+}
+
+// Selectively allow cross-site AJAX
+
+/*
+ * Helper function to convert wildcard string into a regex
+ * '*' => '.*?'
+ * '?' => '.'
+ * @ return string
+ */
+function convertWildcard( $search ) {
+       $search = preg_quote( $search, '/' );
+       $search = str_replace(
+               array( '\*', '\?' ),
+               array( '.*?', '.' ),
+               $search
+       );
+       return "/$search/";
+}
+
+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;
+               }
+       }
+}
+
+// So extensions can check whether they're running in API mode
+define( 'MW_API', true );
+
+// 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' );
+
+/* 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();
+
+// Execute any deferred updates
+wfDoUpdates();
+
+// Log what the user did, for book-keeping purposes.
+$endtime = microtime( true );
+wfProfileOut( 'api.php' );
+wfLogProfilingData();
+
+// Log the request
+if ( $wgAPIRequestLog ) {
+       $items = array(
+                       wfTimestamp( TS_MW ),
+                       $endtime - $starttime,
+                       wfGetIP(),
+                       $_SERVER['HTTP_USER_AGENT']
+       );
+       $items[] = $wgRequest->wasPosted() ? 'POST' : 'GET';
+       if ( $processor->getModule()->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
+wfGetLBFactory()->shutdown();
+