Tweak the version info for MW just a bit, bring it more in line with the module listi...

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

diff --git a/includes/api/ApiMain.php b/includes/api/ApiMain.php
index e44a5f2..63e5377 100644 (file)
--- a/includes/api/ApiMain.php
+++ b/includes/api/ApiMain.php
@@ -28,6 +28,10 @@ if (!defined('MEDIAWIKI')) {
        require_once ('ApiBase.php');
 }
 
+/**
+ * @defgroup API API
+ */
+
 /**
  * This is the main API class, used for both external and internal processing.
  * When executed, it will create the requested formatter object,
@@ -39,7 +43,7 @@ if (!defined('MEDIAWIKI')) {
  * case any internal exceptions will not be handled but passed up to the caller.
  * After successful execution, use getResult() for the resulting data.
  *
- * @addtogroup API
+ * @ingroup API
  */
 class ApiMain extends ApiBase {
 
@@ -72,6 +76,7 @@ class ApiMain extends ApiBase {
                'unblock' => 'ApiUnblock',
                'move' => 'ApiMove',
                'edit' => 'ApiEditPage',
+               'emailuser' => 'ApiEmailUser',
        );
 
        /**
@@ -149,7 +154,7 @@ class ApiMain extends ApiBase {
 
                $this->mRequest = & $request;
 
-               $this->mSquidMaxage = 0;
+               $this->mSquidMaxage = -1; // flag for executeActionWithErrorHandling()
                $this->mCommit = false;
        }
 
@@ -175,12 +180,19 @@ class ApiMain extends ApiBase {
        }
 
        /**
-        * This method will simply cause an error if the write mode was disabled for this api.
+        * This method will simply cause an error if the write mode was disabled
+        * or if the current user doesn't have the right to use it
         */
        public function requestWriteMode() {
+               global $wgUser;
                if (!$this->mEnableWrite)
-                       $this->dieUsage('Editing of this site is disabled. Make sure the $wgEnableWriteAPI=true; ' .
-                       'statement is included in the site\'s LocalSettings.php file', 'noapiwrite');
+                       $this->dieUsage('Editing of this wiki through the API' .
+                       ' is disabled. Make sure the $wgEnableWriteAPI=true; ' .
+                       'statement is included in the wiki\'s ' .
+                       'LocalSettings.php file', 'noapiwrite');
+               if (!$wgUser->isAllowed('writeapi'))
+                       $this->dieUsage('You\'re not allowed to edit this ' .
+                       'wiki through the API', 'writeapidenied');
        }
 
        /**
@@ -248,11 +260,22 @@ class ApiMain extends ApiBase {
                        $this->printResult(true);
                }
 
+               global $wgRequest;
+               if($this->mSquidMaxage == -1)
+               {
+                       # Nobody called setCacheMaxAge(), use the (s)maxage parameters
+                       $smaxage = $wgRequest->getVal('smaxage', 0);
+                       $maxage = $wgRequest->getVal('maxage', 0);
+               }
+               else
+                       $smaxage = $maxage = $this->mSquidMaxage;
+
                // Set the cache expiration at the last moment, as any errors may change the expiration.
                // if $this->mSquidMaxage == 0, the expiry time is set to the first second of unix epoch
-               $expires = $this->mSquidMaxage == 0 ? 1 : time() + $this->mSquidMaxage;
+               $exp = min($smaxage, $maxage);
+               $expires = ($exp == 0 ? 1 : time() + $exp);
                header('Expires: ' . wfTimestamp(TS_RFC2822, $expires));
-               header('Cache-Control: s-maxage=' . $this->mSquidMaxage . ', must-revalidate, max-age=0');
+               header('Cache-Control: s-maxage=' . $smaxage . ', must-revalidate, max-age=' . $maxage);
 
                if($this->mPrinter->getIsHtml())
                        echo wfReportTime();
@@ -291,14 +314,21 @@ class ApiMain extends ApiBase {
                                        ApiResult :: setContent($errMessage, $this->makeHelpMsg());
 
                        } else {
+                               global $wgShowSQLErrors, $wgShowExceptionDetails;
                                //
                                // Something is seriously wrong
                                //
+                               if ( ( $e instanceof DBQueryError ) && !$wgShowSQLErrors ) {
+                                       $info = "Database query error";
+                               } else {
+                                       $info = "Exception Caught: {$e->getMessage()}";
+                               }
+
                                $errMessage = array (
                                        'code' => 'internal_api_error_'. get_class($e),
-                                       'info' => "Exception Caught: {$e->getMessage()}"
+                                       'info' => $info,
                                );
-                               ApiResult :: setContent($errMessage, "\n\n{$e->getTraceAsString()}\n\n");
+                               ApiResult :: setContent($errMessage, $wgShowExceptionDetails ? "\n\n{$e->getTraceAsString()}\n\n" : "" );                               
                        }
 
                        $this->getResult()->reset();
@@ -317,6 +347,10 @@ class ApiMain extends ApiBase {
                $this->mShowVersions = $params['version'];
                $this->mAction = $params['action'];
 
+               if( !is_string( $this->mAction ) ) {
+                       $this->dieUsage( "The API requires a valid action parameter", 'unknown_action' );
+               }
+
                // Instantiate the module requested by the user
                $module = new $this->mModules[$this->mAction] ($this, $this->mAction);
 
@@ -399,6 +433,14 @@ class ApiMain extends ApiBase {
                        'maxlag'  => array (
                                ApiBase :: PARAM_TYPE => 'integer'
                        ),
+                       'smaxage' => array (
+                               ApiBase :: PARAM_TYPE => 'integer',
+                               ApiBase :: PARAM_DFLT => 0
+                       ),
+                       'maxage' => array (
+                               ApiBase :: PARAM_TYPE => 'integer',
+                               ApiBase :: PARAM_DFLT => 0
+                       ),
                );
        }
 
@@ -410,7 +452,9 @@ class ApiMain extends ApiBase {
                        'format' => 'The format of the output',
                        'action' => 'What action you would like to perform',
                        'version' => 'When showing help, include version for each module',
-                       'maxlag' => 'Maximum lag'
+                       'maxlag' => 'Maximum lag',
+                       'smaxage' => 'Set the s-maxage header to this many seconds. Errors are never cached',
+                       'maxage' => 'Set the max-age header to this many seconds. Errors are never cached',
                );
        }
 
@@ -562,7 +606,7 @@ class ApiMain extends ApiBase {
         */
        public function getVersion() {
                $vers = array ();
-               $vers[] = 'MediaWiki ' . SpecialVersion::getVersion();
+               $vers[] = 'MediaWiki: ' . SpecialVersion::getVersion() . "\n    http://svn.wikimedia.org/viewvc/mediawiki/trunk/phase3/";
                $vers[] = __CLASS__ . ': $Id$';
                $vers[] = ApiBase :: getBaseVersion();
                $vers[] = ApiFormatBase :: getBaseVersion();
@@ -608,7 +652,7 @@ class ApiMain extends ApiBase {
  * This exception will be thrown when dieUsage is called to stop module execution.
  * The exception handling code will print a help screen explaining how this API may be used.
  *
- * @addtogroup API
+ * @ingroup API
  */
 class UsageException extends Exception {