Hooks EditFilter and EditFilter complete got a new param (edit summary), docs updated...

[lhc/web/wiklou.git] / api.php

diff --git a/api.php b/api.php
index 28c1ef3..77dc52a 100644 (file)
--- a/api.php
+++ b/api.php
@@ -1,7 +1,6 @@
 <?php
 
-
-/**
+/*
 * API for MediaWiki 1.8+
 *
 * Copyright (C) 2006 Yuri Astrakhan <Firstname><Lastname>@gmail.com
@@ -22,11 +21,45 @@
 * http://www.gnu.org/copyleft/gpl.html
 */
 
+/** 
+ * 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');
 
+// 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.
+//
+// Ensure that all access is through the canonical entry point...
+//
+if( isset( $_SERVER['SCRIPT_URL'] ) ) {
+       $url = $_SERVER['SCRIPT_URL'];
+} else {
+       $url = $_SERVER['PHP_SELF'];
+}
+if( strcmp( "$wgScriptPath/api$wgScriptExtension", $url ) ) {
+       wfHttpError( 403, 'Forbidden',
+               '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';
@@ -34,9 +67,22 @@ if (!$wgEnableAPI) {
        die(-1);
 }
 
+/* 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.
 wfProfileOut('api.php');
 wfLogProfilingData();
-?>
+
+// Shut down the database
+wfGetLBFactory()->shutdown();
+