<?php
-
-/*
- * Created on Sep 5, 2006
+/**
*
- * API for MediaWiki 1.8+
*
- * Copyright (C) 2006, 2010 Yuri Astrakhan <Firstname><Lastname>@gmail.com
+ * Created on Sep 5, 2006
+ *
+ * Copyright © 2006, 2010 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
*
* 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.
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
* http://www.gnu.org/copyleft/gpl.html
+ *
+ * @file
*/
/**
const PARAM_MIN = 5; // Lowest value allowed for a parameter. Only applies if TYPE='integer'
const PARAM_ALLOW_DUPLICATES = 6; // Boolean, do we allow the same value to be set more than once when ISMULTI=true
const PARAM_DEPRECATED = 7; // Boolean, is the parameter deprecated (will show a warning)
+ const PARAM_REQUIRED = 8; // Boolean, is the parameter required?
+ const PARAM_RANGE_ENFORCE = 9; // Boolean, if MIN/MAX are set, enforce (die) these? Only applies if TYPE='integer' Use with extreme caution
const LIMIT_BIG1 = 500; // Fast query, std user limit
const LIMIT_BIG2 = 5000; // Fast query, bot/sysop limit
const LIMIT_SML2 = 500; // Slow query, bot/sysop limit
private $mMainModule, $mModuleName, $mModulePrefix;
+ private $mParamCache = array();
/**
* Constructor
* @return string
*/
public function getModuleProfileName( $db = false ) {
- if ( $db )
+ if ( $db ) {
return 'API:' . $this->mModuleName . '-DB';
- else
+ } else {
return 'API:' . $this->mModuleName;
+ }
}
/**
public function getResult() {
// Main module has getResult() method overriden
// Safety - avoid infinite loop:
- if ( $this->isMain() )
- ApiBase :: dieDebug( __METHOD__, 'base method was called on main module. ' );
+ if ( $this->isMain() ) {
+ ApiBase::dieDebug( __METHOD__, 'base method was called on main module. ' );
+ }
return $this->getMain()->getResult();
}
*/
public function setWarning( $warning ) {
$data = $this->getResult()->getData();
- if ( isset( $data['warnings'][$this->getModuleName()] ) )
- {
+ if ( isset( $data['warnings'][$this->getModuleName()] ) ) {
// Don't add duplicate warnings
$warn_regex = preg_quote( $warning, '/' );
- if ( preg_match( "/{$warn_regex}(\\n|$)/", $data['warnings'][$this->getModuleName()]['*'] ) )
+ if ( preg_match( "/{$warn_regex}(\\n|$)/", $data['warnings'][$this->getModuleName()]['*'] ) ) {
return;
+ }
$oldwarning = $data['warnings'][$this->getModuleName()]['*'];
// If there is a warning already, append it to the existing one
$warning = "$oldwarning\n$warning";
$this->getResult()->unsetValue( 'warnings', $this->getModuleName() );
}
$msg = array();
- ApiResult :: setContent( $msg, $warning );
+ ApiResult::setContent( $msg, $warning );
$this->getResult()->disableSizeCheck();
$this->getResult()->addValue( 'warnings', $this->getModuleName(), $msg );
$this->getResult()->enableSizeCheck();
* @return mixed string or false
*/
public function makeHelpMsg() {
-
static $lnPrfx = "\n ";
$msg = $this->getDescription();
if ( $msg !== false ) {
- if ( !is_array( $msg ) )
- $msg = array (
+ if ( !is_array( $msg ) ) {
+ $msg = array(
$msg
);
+ }
$msg = $lnPrfx . implode( $lnPrfx, $msg ) . "\n";
- if ( $this->isReadMode() )
- $msg .= "\nThis module requires read rights.";
- if ( $this->isWriteMode() )
- $msg .= "\nThis module requires write rights.";
- if ( $this->mustBePosted() )
- $msg .= "\nThis module only accepts POST requests.";
+ if ( $this->isReadMode() ) {
+ $msg .= "\nThis module requires read rights";
+ }
+ if ( $this->isWriteMode() ) {
+ $msg .= "\nThis module requires write rights";
+ }
+ if ( $this->mustBePosted() ) {
+ $msg .= "\nThis module only accepts POST requests";
+ }
if ( $this->isReadMode() || $this->isWriteMode() ||
$this->mustBePosted() )
+ {
$msg .= "\n";
+ }
// Parameters
$paramsMsg = $this->makeHelpMsgParameters();
// Examples
$examples = $this->getExamples();
if ( $examples !== false ) {
- if ( !is_array( $examples ) )
- $examples = array (
+ if ( !is_array( $examples ) ) {
+ $examples = array(
$examples
);
- $msg .= 'Example' . ( count( $examples ) > 1 ? 's' : '' ) . ":\n ";
- $msg .= implode( $lnPrfx, $examples ) . "\n";
+ }
+
+ if ( count( $examples ) > 0 ) {
+ $msg .= 'Example' . ( count( $examples ) > 1 ? 's' : '' ) . ":\n ";
+ $msg .= implode( $lnPrfx, $examples ) . "\n";
+ }
}
if ( $this->getMain()->getShowVersions() ) {
$callback = array( $this, 'makeHelpMsg_callback' );
if ( is_array( $versions ) ) {
- foreach ( $versions as &$v )
+ foreach ( $versions as &$v ) {
$v = preg_replace_callback( $pattern, $callback, $v );
+ }
$versions = implode( "\n ", $versions );
- }
- else
+ } else {
$versions = preg_replace_callback( $pattern, $callback, $versions );
+ }
$msg .= "Version:\n $versions\n";
}
$msg = '';
$paramPrefix = "\n" . str_repeat( ' ', 19 );
foreach ( $params as $paramName => $paramSettings ) {
- $desc = isset ( $paramsDescription[$paramName] ) ? $paramsDescription[$paramName] : '';
- if ( is_array( $desc ) )
+ $desc = isset( $paramsDescription[$paramName] ) ? $paramsDescription[$paramName] : '';
+ if ( is_array( $desc ) ) {
$desc = implode( $paramPrefix, $desc );
+ }
+
+ if ( !is_array( $paramSettings ) ) {
+ $paramSettings = array(
+ self::PARAM_DFLT => $paramSettings,
+ );
+ }
- $deprecated = isset( $paramSettings[self :: PARAM_DEPRECATED] ) ?
- $paramSettings[self :: PARAM_DEPRECATED] : false;
- if ( $deprecated )
+ $deprecated = isset( $paramSettings[self::PARAM_DEPRECATED] ) ?
+ $paramSettings[self::PARAM_DEPRECATED] : false;
+ if ( $deprecated ) {
$desc = "DEPRECATED! $desc";
+ }
- $type = isset( $paramSettings[self :: PARAM_TYPE] ) ? $paramSettings[self :: PARAM_TYPE] : null;
- if ( isset ( $type ) ) {
- if ( isset ( $paramSettings[self :: PARAM_ISMULTI] ) )
+ $required = isset( $paramSettings[self::PARAM_REQUIRED] ) ?
+ $paramSettings[self::PARAM_REQUIRED] : false;
+ if ( $required ) {
+ $desc .= $paramPrefix . "This parameter is required";
+ }
+
+ $type = isset( $paramSettings[self::PARAM_TYPE] ) ? $paramSettings[self::PARAM_TYPE] : null;
+ if ( isset( $type ) ) {
+ if ( isset( $paramSettings[self::PARAM_ISMULTI] ) ) {
$prompt = 'Values (separate with \'|\'): ';
- else
+ } else {
$prompt = 'One value: ';
+ }
if ( is_array( $type ) ) {
$choices = array();
$nothingPrompt = false;
- foreach ( $type as $t )
- if ( $t === '' )
+ foreach ( $type as $t ) {
+ if ( $t === '' ) {
$nothingPrompt = 'Can be empty, or ';
- else
+ } else {
$choices[] = $t;
- $desc .= $paramPrefix . $nothingPrompt . $prompt . implode( ', ', $choices );
+ }
+ }
+ $desc .= $paramPrefix . $nothingPrompt . $prompt;
+ $choicesstring = implode( ', ', $choices );
+ $desc .= wordwrap( $choicesstring, 100, "\n " );
} else {
switch ( $type ) {
case 'namespace':
// Special handling because namespaces are type-limited, yet they are not given
- $desc .= $paramPrefix . $prompt . implode( ', ', ApiBase :: getValidNamespaces() );
+ $desc .= $paramPrefix . $prompt . implode( ', ', MWNamespace::getValidNamespaces() );
break;
case 'limit':
- $desc .= $paramPrefix . "No more than {$paramSettings[self :: PARAM_MAX]} ({$paramSettings[self :: PARAM_MAX2]} for bots) allowed.";
+ $desc .= $paramPrefix . "No more than {$paramSettings[self :: PARAM_MAX]}";
+ if ( isset( $paramSettings[self::PARAM_MAX2] ) ) {
+ $desc .= " ({$paramSettings[self::PARAM_MAX2]} for bots)";
+ }
+ $desc .= ' allowed';
break;
case 'integer':
- $hasMin = isset( $paramSettings[self :: PARAM_MIN] );
- $hasMax = isset( $paramSettings[self :: PARAM_MAX] );
+ $hasMin = isset( $paramSettings[self::PARAM_MIN] );
+ $hasMax = isset( $paramSettings[self::PARAM_MAX] );
if ( $hasMin || $hasMax ) {
- if ( !$hasMax )
- $intRangeStr = "The value must be no less than {$paramSettings[self :: PARAM_MIN]}";
- elseif ( !$hasMin )
- $intRangeStr = "The value must be no more than {$paramSettings[self :: PARAM_MAX]}";
- else
- $intRangeStr = "The value must be between {$paramSettings[self :: PARAM_MIN]} and {$paramSettings[self :: PARAM_MAX]}";
+ if ( !$hasMax ) {
+ $intRangeStr = "The value must be no less than {$paramSettings[self::PARAM_MIN]}";
+ } elseif ( !$hasMin ) {
+ $intRangeStr = "The value must be no more than {$paramSettings[self::PARAM_MAX]}";
+ } else {
+ $intRangeStr = "The value must be between {$paramSettings[self::PARAM_MIN]} and {$paramSettings[self::PARAM_MAX]}";
+ }
$desc .= $paramPrefix . $intRangeStr;
}
break;
}
+
+ if ( isset( $paramSettings[self::PARAM_ISMULTI] ) ) {
+ $isArray = is_array( $paramSettings[self::PARAM_TYPE] );
+
+ if ( !$isArray
+ || $isArray && count( $paramSettings[self::PARAM_TYPE] ) > self::LIMIT_SML1 ) {
+ $desc .= $paramPrefix . "Maximum number of values " .
+ self::LIMIT_SML1 . " (" . self::LIMIT_SML2 . " for bots)";
+ }
+ }
}
}
- $default = is_array( $paramSettings ) ? ( isset ( $paramSettings[self :: PARAM_DFLT] ) ? $paramSettings[self :: PARAM_DFLT] : null ) : $paramSettings;
- if ( !is_null( $default ) && $default !== false )
+ $default = is_array( $paramSettings )
+ ? ( isset( $paramSettings[self::PARAM_DFLT] ) ? $paramSettings[self::PARAM_DFLT] : null )
+ : $paramSettings;
+ if ( !is_null( $default ) && $default !== false ) {
$desc .= $paramPrefix . "Default: $default";
+ }
$msg .= sprintf( " %-14s - %s\n", $this->encodeParamName( $paramName ), $desc );
}
return $msg;
- } else
+ } else {
return false;
+ }
}
/**
*/
public function makeHelpMsg_callback( $matches ) {
global $wgAutoloadClasses, $wgAutoloadLocalClasses;
- if ( isset( $wgAutoloadLocalClasses[get_class( $this )] ) )
+ if ( isset( $wgAutoloadLocalClasses[get_class( $this )] ) ) {
$file = $wgAutoloadLocalClasses[get_class( $this )];
- else if ( isset( $wgAutoloadClasses[get_class( $this )] ) )
+ } elseif ( isset( $wgAutoloadClasses[get_class( $this )] ) ) {
$file = $wgAutoloadClasses[get_class( $this )];
+ }
// Do some guesswork here
$path = strstr( $file, 'includes/api/' );
- if ( $path === false )
+ if ( $path === false ) {
$path = strstr( $file, 'extensions/' );
- else
+ } else {
$path = 'phase3/' . $path;
+ }
// Get the filename from $matches[2] instead of $file
// If they're not the same file, they're assumed to be in the
// same directory
// This is necessary to make stuff like ApiMain::getVersion()
// returning the version string for ApiBase work
- if ( $path )
+ if ( $path ) {
return "{$matches[0]}\n http://svn.wikimedia.org/" .
"viewvc/mediawiki/trunk/" . dirname( $path ) .
"/{$matches[2]}";
+ }
return $matches[0];
}
}
/**
- * Using getAllowedParams(), this function makes an array of the values
- * provided by the user, with key being the name of the variable, and
- * value - validated value from user or default. limits will not be
- * parsed if $parseLimit is set to false; use this when the max
- * limit is not definitive yet, e.g. when getting revisions.
- * @param $parseLimit bool
- * @return array
- */
+ * Using getAllowedParams(), this function makes an array of the values
+ * provided by the user, with key being the name of the variable, and
+ * value - validated value from user or default. limits will not be
+ * parsed if $parseLimit is set to false; use this when the max
+ * limit is not definitive yet, e.g. when getting revisions.
+ * @param $parseLimit Boolean: true by default
+ * @return array
+ */
public function extractRequestParams( $parseLimit = true ) {
- $params = $this->getFinalParams();
- $results = array ();
-
- foreach ( $params as $paramName => $paramSettings )
- $results[$paramName] = $this->getParameterFromSettings( $paramName, $paramSettings, $parseLimit );
-
- return $results;
+ // Cache parameters, for performance and to avoid bug 24564.
+ if ( !isset( $this->mParamCache[$parseLimit] ) ) {
+ $params = $this->getFinalParams();
+ $results = array();
+
+ if ( $params ) { // getFinalParams() can return false
+ foreach ( $params as $paramName => $paramSettings ) {
+ $results[$paramName] = $this->getParameterFromSettings(
+ $paramName, $paramSettings, $parseLimit );
+ }
+ }
+ $this->mParamCache[$parseLimit] = $results;
+ }
+ return $this->mParamCache[$parseLimit];
}
/**
}
/**
- * Die if none or more than one of a certain set of parameters is set
+ * Die if none or more than one of a certain set of parameters is set and not false.
* @param $params array of parameter names
*/
public function requireOnlyOneParameter( $params ) {
array_shift( $required );
$intersection = array_intersect( array_keys( array_filter( $params,
- create_function( '$x', 'return !is_null($x);' )
- ) ), $required );
+ array( $this, "parameterNotEmpty" ) ) ), $required );
+
if ( count( $intersection ) > 1 ) {
$this->dieUsage( 'The parameters ' . implode( ', ', $intersection ) . ' can not be used together', 'invalidparammix' );
} elseif ( count( $intersection ) == 0 ) {
}
/**
- * Returns an array of the namespaces (by integer id) that exist on the
- * wiki. Used primarily in help documentation.
- * @return array
+ * Callback function used in requireOnlyOneParameter to check whether reequired parameters are set
+ *
+ * @param $x object Parameter to check is not null/false
+ * @return bool
+ */
+ private function parameterNotEmpty( $x ) {
+ return !is_null( $x ) && $x !== false;
+ }
+
+ /**
+ * @deprecated use MWNamespace::getValidNamespaces()
*/
public static function getValidNamespaces() {
- static $mValidNamespaces = null;
- if ( is_null( $mValidNamespaces ) ) {
-
- global $wgContLang;
- $mValidNamespaces = array ();
- foreach ( array_keys( $wgContLang->getNamespaces() ) as $ns ) {
- if ( $ns >= 0 )
- $mValidNamespaces[] = $ns;
- }
+ return MWNamespace::getValidNamespaces();
+ }
+
+ /**
+ * Return true if we're to watch the page, false if not, null if no change.
+ * @param $watchlist String Valid values: 'watch', 'unwatch', 'preferences', 'nochange'
+ * @param $titleObj Title the page under consideration
+ * @param $userOption String The user option to consider when $watchlist=preferences.
+ * If not set will magically default to either watchdefault or watchcreations
+ * @returns mixed
+ */
+ protected function getWatchlistValue ( $watchlist, $titleObj, $userOption = null ) {
+ global $wgUser;
+ switch ( $watchlist ) {
+ case 'watch':
+ return true;
+
+ case 'unwatch':
+ return false;
+
+ case 'preferences':
+ # If the user is already watching, don't bother checking
+ if ( $titleObj->userIsWatching() ) {
+ return null;
+ }
+ # If no user option was passed, use watchdefault or watchcreation
+ if ( is_null( $userOption ) ) {
+ $userOption = $titleObj->exists()
+ ? 'watchdefault' : 'watchcreations';
+ }
+ # If the corresponding user option is true, watch, else no change
+ return $wgUser->getOption( $userOption ) ? true : null;
+
+ case 'nochange':
+ return null;
+
+ default:
+ return null;
+ }
+ }
+
+ /**
+ * Set a watch (or unwatch) based the based on a watchlist parameter.
+ * @param $watch String Valid values: 'watch', 'unwatch', 'preferences', 'nochange'
+ * @param $titleObj Title the article's title to change
+ * @param $userOption String The user option to consider when $watch=preferences
+ */
+ protected function setWatch ( $watch, $titleObj, $userOption = null ) {
+ $value = $this->getWatchlistValue( $watch, $titleObj, $userOption );
+ if ( $value === null ) {
+ return;
+ }
+
+ $articleObj = new Article( $titleObj );
+ if ( $value ) {
+ $articleObj->doWatch();
+ } else {
+ $articleObj->doUnwatch();
}
- return $mValidNamespaces;
}
/**
* @return mixed Parameter value
*/
protected function getParameterFromSettings( $paramName, $paramSettings, $parseLimit ) {
-
// Some classes may decide to change parameter names
$encParamName = $this->encodeParamName( $paramName );
$type = gettype( $paramSettings );
$dupes = false;
$deprecated = false;
+ $required = false;
} else {
- $default = isset ( $paramSettings[self :: PARAM_DFLT] ) ? $paramSettings[self :: PARAM_DFLT] : null;
- $multi = isset ( $paramSettings[self :: PARAM_ISMULTI] ) ? $paramSettings[self :: PARAM_ISMULTI] : false;
- $type = isset ( $paramSettings[self :: PARAM_TYPE] ) ? $paramSettings[self :: PARAM_TYPE] : null;
- $dupes = isset ( $paramSettings[self:: PARAM_ALLOW_DUPLICATES] ) ? $paramSettings[self :: PARAM_ALLOW_DUPLICATES] : false;
- $deprecated = isset ( $paramSettings[self:: PARAM_DEPRECATED] ) ? $paramSettings[self :: PARAM_DEPRECATED] : false;
+ $default = isset( $paramSettings[self::PARAM_DFLT] ) ? $paramSettings[self::PARAM_DFLT] : null;
+ $multi = isset( $paramSettings[self::PARAM_ISMULTI] ) ? $paramSettings[self::PARAM_ISMULTI] : false;
+ $type = isset( $paramSettings[self::PARAM_TYPE] ) ? $paramSettings[self::PARAM_TYPE] : null;
+ $dupes = isset( $paramSettings[self::PARAM_ALLOW_DUPLICATES] ) ? $paramSettings[self::PARAM_ALLOW_DUPLICATES] : false;
+ $deprecated = isset( $paramSettings[self::PARAM_DEPRECATED] ) ? $paramSettings[self::PARAM_DEPRECATED] : false;
+ $required = isset( $paramSettings[self::PARAM_REQUIRED] ) ? $paramSettings[self::PARAM_REQUIRED] : false;
// When type is not given, and no choices, the type is the same as $default
- if ( !isset ( $type ) ) {
- if ( isset ( $default ) )
+ if ( !isset( $type ) ) {
+ if ( isset( $default ) ) {
$type = gettype( $default );
- else
+ } else {
$type = 'NULL'; // allow everything
+ }
}
}
if ( $type == 'boolean' ) {
- if ( isset ( $default ) && $default !== false ) {
+ if ( isset( $default ) && $default !== false ) {
// Having a default value of anything other than 'false' is pointless
- ApiBase :: dieDebug( __METHOD__, "Boolean param $encParamName's default is set to '$default'" );
+ ApiBase::dieDebug( __METHOD__, "Boolean param $encParamName's default is set to '$default'" );
}
$value = $this->getMain()->getRequest()->getCheck( $encParamName );
} else {
$value = $this->getMain()->getRequest()->getVal( $encParamName, $default );
- if ( isset ( $value ) && $type == 'namespace' )
- $type = ApiBase :: getValidNamespaces();
+ if ( isset( $value ) && $type == 'namespace' ) {
+ $type = MWNamespace::getValidNamespaces();
+ }
}
- if ( isset ( $value ) && ( $multi || is_array( $type ) ) )
+ if ( isset( $value ) && ( $multi || is_array( $type ) ) ) {
$value = $this->parseMultiValue( $encParamName, $value, $multi, is_array( $type ) ? $type : null );
+ }
// More validation only when choices were not given
// choices were validated in parseMultiValue()
- if ( isset ( $value ) ) {
+ if ( isset( $value ) ) {
if ( !is_array( $type ) ) {
switch ( $type ) {
- case 'NULL' : // nothing to do
+ case 'NULL': // nothing to do
break;
- case 'string' : // nothing to do
- break;
- case 'integer' : // Force everything using intval() and optionally validate limits
+ case 'string':
+ if ( $required && $value === '' ) {
+ $this->dieUsageMsg( array( 'missingparam', $paramName ) );
+ }
- $value = is_array( $value ) ? array_map( 'intval', $value ) : intval( $value );
- $min = isset ( $paramSettings[self :: PARAM_MIN] ) ? $paramSettings[self :: PARAM_MIN] : null;
- $max = isset ( $paramSettings[self :: PARAM_MAX] ) ? $paramSettings[self :: PARAM_MAX] : null;
+ break;
+ case 'integer': // Force everything using intval() and optionally validate limits
+ $min = isset ( $paramSettings[self::PARAM_MIN] ) ? $paramSettings[self::PARAM_MIN] : null;
+ $max = isset ( $paramSettings[self::PARAM_MAX] ) ? $paramSettings[self::PARAM_MAX] : null;
+ $enforceLimits = isset ( $paramSettings[self::PARAM_RANGE_ENFORCE] )
+ ? $paramSettings[self::PARAM_RANGE_ENFORCE] : false;
if ( !is_null( $min ) || !is_null( $max ) ) {
- $values = is_array( $value ) ? $value : array( $value );
- foreach ( $values as &$v ) {
- $this->validateLimit( $paramName, $v, $min, $max );
+ if ( is_array( $value ) ) {
+ $value = array_map( 'intval', $value );
+ foreach ( $value as &$v ) {
+ $this->validateLimit( $paramName, $v, $min, $max, null, $enforceLimits );
+ }
+ } else {
+ $value = intval( $value );
+ $this->validateLimit( $paramName, $value, $min, $max, null, $enforceLimits );
}
+ } else {
+ $value = intval( $value );
}
break;
- case 'limit' :
- if ( !$parseLimit )
+ case 'limit':
+ if ( !$parseLimit ) {
// Don't do any validation whatsoever
break;
- if ( !isset ( $paramSettings[self :: PARAM_MAX] ) || !isset ( $paramSettings[self :: PARAM_MAX2] ) )
- ApiBase :: dieDebug( __METHOD__, "MAX1 or MAX2 are not defined for the limit $encParamName" );
- if ( $multi )
- ApiBase :: dieDebug( __METHOD__, "Multi-values not supported for $encParamName" );
- $min = isset ( $paramSettings[self :: PARAM_MIN] ) ? $paramSettings[self :: PARAM_MIN] : 0;
- if ( $value == 'max' ) {
- $value = $this->getMain()->canApiHighLimits() ? $paramSettings[self :: PARAM_MAX2] : $paramSettings[self :: PARAM_MAX];
- $this->getResult()->addValue( 'limits', $this->getModuleName(), $value );
}
- else {
+ if ( !isset( $paramSettings[self::PARAM_MAX] ) || !isset( $paramSettings[self::PARAM_MAX2] ) ) {
+ ApiBase::dieDebug( __METHOD__, "MAX1 or MAX2 are not defined for the limit $encParamName" );
+ }
+ if ( $multi ) {
+ ApiBase::dieDebug( __METHOD__, "Multi-values not supported for $encParamName" );
+ }
+ $min = isset( $paramSettings[self::PARAM_MIN] ) ? $paramSettings[self::PARAM_MIN] : 0;
+ if ( $value == 'max' ) {
+ $value = $this->getMain()->canApiHighLimits() ? $paramSettings[self::PARAM_MAX2] : $paramSettings[self::PARAM_MAX];
+ $this->getResult()->setParsedLimit( $this->getModuleName(), $value );
+ } else {
$value = intval( $value );
- $this->validateLimit( $paramName, $value, $min, $paramSettings[self :: PARAM_MAX], $paramSettings[self :: PARAM_MAX2] );
+ $this->validateLimit( $paramName, $value, $min, $paramSettings[self::PARAM_MAX], $paramSettings[self::PARAM_MAX2] );
}
break;
- case 'boolean' :
- if ( $multi )
- ApiBase :: dieDebug( __METHOD__, "Multi-values not supported for $encParamName" );
+ case 'boolean':
+ if ( $multi ) {
+ ApiBase::dieDebug( __METHOD__, "Multi-values not supported for $encParamName" );
+ }
break;
- case 'timestamp' :
- if ( $multi )
- ApiBase :: dieDebug( __METHOD__, "Multi-values not supported for $encParamName" );
+ case 'timestamp':
+ if ( $multi ) {
+ ApiBase::dieDebug( __METHOD__, "Multi-values not supported for $encParamName" );
+ }
$value = wfTimestamp( TS_UNIX, $value );
- if ( $value === 0 )
+ if ( $value === 0 ) {
$this->dieUsage( "Invalid value '$value' for timestamp parameter $encParamName", "badtimestamp_{$encParamName}" );
+ }
$value = wfTimestamp( TS_MW, $value );
break;
- case 'user' :
- $title = Title::makeTitleSafe( NS_USER, $value );
- if ( is_null( $title ) )
- $this->dieUsage( "Invalid value for user parameter $encParamName", "baduser_{$encParamName}" );
- $value = $title->getText();
+ case 'user':
+ if ( !is_array( $value ) ) {
+ $value = array( $value );
+ }
+
+ foreach ( $value as $key => $val ) {
+ $title = Title::makeTitleSafe( NS_USER, $val );
+ if ( is_null( $title ) ) {
+ $this->dieUsage( "Invalid value for user parameter $encParamName", "baduser_{$encParamName}" );
+ }
+ $value[$key] = $title->getText();
+ }
+
+ if ( !$multi ) {
+ $value = $value[0];
+ }
break;
- default :
- ApiBase :: dieDebug( __METHOD__, "Param $encParamName's type is unknown - $type" );
+ default:
+ ApiBase::dieDebug( __METHOD__, "Param $encParamName's type is unknown - $type" );
}
}
// Throw out duplicates if requested
- if ( is_array( $value ) && !$dupes )
+ if ( is_array( $value ) && !$dupes ) {
$value = array_unique( $value );
+ }
// Set a warning if a deprecated parameter has been passed
if ( $deprecated && $value !== false ) {
$this->setWarning( "The $encParamName parameter has been deprecated." );
}
+ } else if ( $required ) {
+ $this->dieUsageMsg( array( 'missingparam', $paramName ) );
}
return $value;
}
/**
- * Return an array of values that were given in a 'a|b|c' notation,
- * after it optionally validates them against the list allowed values.
- *
- * @param $valueName string The name of the parameter (for error
- * reporting)
- * @param $value mixed The value being parsed
- * @param $allowMultiple bool Can $value contain more than one value
- * separated by '|'?
- * @param $allowedValues mixed An array of values to check against. If
- * null, all values are accepted.
- * @return mixed (allowMultiple ? an_array_of_values : a_single_value)
- */
+ * Return an array of values that were given in a 'a|b|c' notation,
+ * after it optionally validates them against the list allowed values.
+ *
+ * @param $valueName string The name of the parameter (for error
+ * reporting)
+ * @param $value mixed The value being parsed
+ * @param $allowMultiple bool Can $value contain more than one value
+ * separated by '|'?
+ * @param $allowedValues mixed An array of values to check against. If
+ * null, all values are accepted.
+ * @return mixed (allowMultiple ? an_array_of_values : a_single_value)
+ */
protected function parseMultiValue( $valueName, $value, $allowMultiple, $allowedValues ) {
- if ( trim( $value ) === "" && $allowMultiple )
+ if ( trim( $value ) === '' && $allowMultiple ) {
return array();
- $sizeLimit = $this->mMainModule->canApiHighLimits() ? self::LIMIT_SML2 : self::LIMIT_SML1;
- $valuesList = explode( '|', $value, $sizeLimit + 1 );
+ }
+
+ // This is a bit awkward, but we want to avoid calling canApiHighLimits() because it unstubs $wgUser
+ $valuesList = explode( '|', $value, self::LIMIT_SML2 + 1 );
+ $sizeLimit = count( $valuesList ) > self::LIMIT_SML1 && $this->mMainModule->canApiHighLimits() ?
+ self::LIMIT_SML2 : self::LIMIT_SML1;
if ( self::truncateArray( $valuesList, $sizeLimit ) ) {
$this->setWarning( "Too many values supplied for parameter '$valueName': the limit is $sizeLimit" );
if ( is_array( $allowedValues ) ) {
// Check for unknown values
$unknown = array_diff( $valuesList, $allowedValues );
- if ( count( $unknown ) )
- {
- if ( $allowMultiple )
- {
- $s = count( $unknown ) > 1 ? "s" : "";
+ if ( count( $unknown ) ) {
+ if ( $allowMultiple ) {
+ $s = count( $unknown ) > 1 ? 's' : '';
$vals = implode( ", ", $unknown );
$this->setWarning( "Unrecognized value$s for parameter '$valueName': $vals" );
- }
- else
+ } else {
$this->dieUsage( "Unrecognized value for parameter '$valueName': {$valuesList[0]}", "unknown_$valueName" );
+ }
}
// Now throw them out
$valuesList = array_intersect( $valuesList, $allowedValues );
* Prints usage info on failure.
* @param $paramName string Parameter name
* @param $value int Parameter value
- * @param $min int Minimum value
- * @param $max int Maximum value for users
+ * @param $min int|null Minimum value
+ * @param $max int|null Maximum value for users
* @param $botMax int Maximum value for sysops/bots
+ * @param $enforceLimits Boolean Whether to enforce (die) if value is outside limits
*/
- function validateLimit( $paramName, &$value, $min, $max, $botMax = null ) {
+ function validateLimit( $paramName, &$value, $min, $max, $botMax = null, $enforceLimits = false ) {
if ( !is_null( $min ) && $value < $min ) {
- $this->setWarning( $this->encodeParamName( $paramName ) . " may not be less than $min (set to $value)" );
+
+ $msg = $this->encodeParamName( $paramName ) . " may not be less than $min (set to $value)";
+ $this->warnOrDie( $msg, $enforceLimits );
$value = $min;
}
// Minimum is always validated, whereas maximum is checked only if not running in internal call mode
- if ( $this->getMain()->isInternalMode() )
+ if ( $this->getMain()->isInternalMode() ) {
return;
+ }
// Optimization: do not check user's bot status unless really needed -- skips db query
// assumes $botMax >= $max
if ( !is_null( $max ) && $value > $max ) {
if ( !is_null( $botMax ) && $this->getMain()->canApiHighLimits() ) {
if ( $value > $botMax ) {
- $this->setWarning( $this->encodeParamName( $paramName ) . " may not be over $botMax (set to $value) for bots or sysops" );
+ $msg = $this->encodeParamName( $paramName ) . " may not be over $botMax (set to $value) for bots or sysops";
+ $this->warnOrDie( $msg, $enforceLimits );
$value = $botMax;
}
} else {
- $this->setWarning( $this->encodeParamName( $paramName ) . " may not be over $max (set to $value) for users" );
+ $msg = $this->encodeParamName( $paramName ) . " may not be over $max (set to $value) for users";
+ $this->warnOrDie( $msg, $enforceLimits );
$value = $max;
}
}
}
+ /**
+ * Adds a warning to the output, else dies
+ *
+ * @param $msg String Message to show as a warning, or error message if dying
+ * @param $enforceLimits Boolean Whether this is an enforce (die)
+ */
+ private function warnOrDie( $msg, $enforceLimits = false ) {
+ if ( $enforceLimits ) {
+ $this->dieUsage( $msg, 'integeroutofrange' );
+ } else {
+ $this->setWarning( $msg );
+ }
+ }
+
/**
* Truncate an array to a certain length.
* @param $arr array Array to truncate
* @param $limit int Maximum length
* @return bool True if the array was truncated, false otherwise
*/
- public static function truncateArray( &$arr, $limit )
- {
+ public static function truncateArray( &$arr, $limit ) {
$modified = false;
- while ( count( $arr ) > $limit )
- {
- $junk = array_pop( $arr );
+ while ( count( $arr ) > $limit ) {
+ array_pop( $arr );
$modified = true;
}
return $modified;
'ipb_blocked_as_range' => array( 'code' => 'blockedasrange', 'info' => "IP address ``\$1'' was blocked as part of range ``\$2''. You can't unblock the IP invidually, but you can unblock the range as a whole." ),
'ipb_cant_unblock' => array( 'code' => 'cantunblock', 'info' => "The block you specified was not found. It may have been unblocked already" ),
'mailnologin' => array( 'code' => 'cantsend', 'info' => "You are not logged in, you do not have a confirmed e-mail address, or you are not allowed to send e-mail to other users, so you cannot send e-mail" ),
+ 'ipbblocked' => array( 'code' => 'ipbblocked', 'info' => 'You cannot block or unblock users while you are yourself blocked' ),
+ 'ipbnounblockself' => array( 'code' => 'ipbnounblockself', 'info' => 'You are not allowed to unblock yourself' ),
'usermaildisabled' => array( 'code' => 'usermaildisabled', 'info' => "User email has been disabled" ),
'blockedemailuser' => array( 'code' => 'blockedfrommail', 'info' => "You have been blocked from sending e-mail" ),
'notarget' => array( 'code' => 'notarget', 'info' => "You have not specified a valid target for this action" ),
'userrights-nodatabase' => array( 'code' => 'nosuchdatabase', 'info' => "Database ``\$1'' does not exist or is not local" ),
'nouserspecified' => array( 'code' => 'invaliduser', 'info' => "Invalid username ``\$1''" ),
'noname' => array( 'code' => 'invaliduser', 'info' => "Invalid username ``\$1''" ),
+ 'summaryrequired' => array( 'code' => 'summaryrequired', 'info' => 'Summary required' ),
// API-specific messages
'readrequired' => array( 'code' => 'readapidenied', 'info' => "You need read permission to use this module" ),
'createonly-exists' => array( 'code' => 'articleexists', 'info' => "The article you tried to create has been created already" ),
'nocreate-missing' => array( 'code' => 'missingtitle', 'info' => "The article you tried to edit doesn't exist" ),
'nosuchrcid' => array( 'code' => 'nosuchrcid', 'info' => "There is no change with rcid ``\$1''" ),
- 'cantpurge' => array( 'code' => 'cantpurge', 'info' => "Only users with the 'purge' right can purge pages via the API" ),
'protect-invalidaction' => array( 'code' => 'protect-invalidaction', 'info' => "Invalid protection type ``\$1''" ),
'protect-invalidlevel' => array( 'code' => 'protect-invalidlevel', 'info' => "Invalid protection level ``\$1''" ),
'toofewexpiries' => array( 'code' => 'toofewexpiries', 'info' => "\$1 expiry timestamps were provided where \$2 were needed" ),
'cantoverwrite-sharedfile' => array( 'code' => 'cantoverwrite-sharedfile', 'info' => 'The target file exists on a shared repository and you do not have permission to override it' ),
'sharedfile-exists' => array( 'code' => 'fileexists-sharedrepo-perm', 'info' => 'The target file exists on a shared repository. Use the ignorewarnings parameter to override it.' ),
'mustbeposted' => array( 'code' => 'mustbeposted', 'info' => "The \$1 module requires a POST request" ),
+ 'show' => array( 'code' => 'show', 'info' => 'Incorrect parameter - mutually exclusive values may not be supplied' ),
+ 'specialpage-cantexecute' => array( 'code' => 'specialpage-cantexecute', 'info' => "You don't have permission to view the results of this special page" ),
// ApiEditPage messages
'noimageredirect-anon' => array( 'code' => 'noimageredirect-anon', 'info' => "Anonymous users can't create image redirects" ),
'invalid-session-key' => array( 'code' => 'invalid-session-key', 'info' => 'Not a valid session key' ),
'nouploadmodule' => array( 'code' => 'nouploadmodule', 'info' => 'No upload module set' ),
'uploaddisabled' => array( 'code' => 'uploaddisabled', 'info' => 'Uploads are not enabled. Make sure $wgEnableUploads is set to true in LocalSettings.php and the PHP ini setting file_uploads is true' ),
- 'chunked-error' => array( 'code' => 'chunked-error', 'info' => 'There was a problem initializing the chunked upload.' ),
+ 'copyuploaddisabled' => array( 'code' => 'copyuploaddisabled', 'info' => 'Uploads by URL is not enabled. Make sure $wgAllowCopyUploads is set to true in LocalSettings.php.' ),
);
/**
*/
public function parseMsg( $error ) {
$key = array_shift( $error );
- if ( isset( self::$messageMap[$key] ) )
- return array( 'code' =>
+ if ( isset( self::$messageMap[$key] ) ) {
+ return array( 'code' =>
wfMsgReplaceArgs( self::$messageMap[$key]['code'], $error ),
'info' =>
wfMsgReplaceArgs( self::$messageMap[$key]['info'], $error )
);
+ }
// If the key isn't present, throw an "unknown error"
return $this->parseMsg( array( 'unknownerror', $key ) );
}
}
/**
- * Returns a list of all possible errors returned by the module
- * @return array in the format of array( key, param1, param2, ... ) or array( 'code' => ..., 'info' => ... )
+ * Returns whether this module requires a Token to execute
+ * @returns bool
+ */
+ public function needsToken() {
+ return false;
+ }
+
+ /**
+ * Returns the token salt if there is one, '' if the module doesn't require a salt, else false if the module doesn't need a token
+ * @returns bool
+ */
+ public function getTokenSalt() {
+ return false;
+ }
+
+ /**
+ * Gets the user for whom to get the watchlist
+ *
+ * @returns User
*/
+ public function getWatchlistUser( $params ) {
+ global $wgUser;
+ if ( !is_null( $params['owner'] ) && !is_null( $params['token'] ) ) {
+ $user = User::newFromName( $params['owner'], false );
+ if ( !$user->getId() ) {
+ $this->dieUsage( 'Specified user does not exist', 'bad_wlowner' );
+ }
+ $token = $user->getOption( 'watchlisttoken' );
+ if ( $token == '' || $token != $params['token'] ) {
+ $this->dieUsage( 'Incorrect watchlist token provided -- please set a correct token in Special:Preferences', 'bad_wltoken' );
+ }
+ } else {
+ if ( !$wgUser->isLoggedIn() ) {
+ $this->dieUsage( 'You must be logged-in to have a watchlist', 'notloggedin' );
+ }
+ $user = $wgUser;
+ }
+ return $user;
+ }
+
+ /**
+ * Returns a list of all possible errors returned by the module
+ * @return array in the format of array( key, param1, param2, ... ) or array( 'code' => ..., 'info' => ... )
+ */
public function getPossibleErrors() {
- $ret = array( array( 'readrequired' ) );
-
+ $ret = array();
+
+ $params = $this->getFinalParams();
+ if ( $params ) {
+ foreach ( $params as $paramName => $paramSettings ) {
+ if ( isset( $paramSettings[ApiBase::PARAM_REQUIRED] ) ) {
+ $ret[] = array( 'missingparam', $paramName );
+ }
+ }
+ }
+
if ( $this->mustBePosted() ) {
- $ret = array_merge( $ret, array( array ('mustbeposted', $this->mModuleName ) ) );
+ $ret[] = array( 'mustbeposted', $this->getModuleName() );
+ }
+
+ if ( $this->isReadMode() ) {
+ $ret[] = array( 'readrequired' );
+ }
+
+ if ( $this->isWriteMode() ) {
+ $ret[] = array( 'writerequired' );
+ $ret[] = array( 'writedisabled' );
+ }
+
+ if ( $this->needsToken() ) {
+ $ret[] = array( 'missingparam', 'token' );
+ $ret[] = array( 'sessionfailure' );
}
-
+
return $ret;
}
-
+
/**
- * Parses a list of errors into a standardised format
- * @param $errors array List of errors. Items can be in the for array( key, param1, param2, ... ) or array( 'code' => ..., 'info' => ... )
- * @return array Parsed list of errors with items in the form array( 'code' => ..., 'info' => ... )
- */
+ * Parses a list of errors into a standardised format
+ * @param $errors array List of errors. Items can be in the for array( key, param1, param2, ... ) or array( 'code' => ..., 'info' => ... )
+ * @return array Parsed list of errors with items in the form array( 'code' => ..., 'info' => ... )
+ */
public function parseErrors( $errors ) {
$ret = array();
-
- foreach ( $errors as $row )
- {
+
+ foreach ( $errors as $row ) {
if ( isset( $row['code'] ) && isset( $row['info'] ) ) {
$ret[] = $row;
- }
- else {
+ } else {
$ret[] = $this->parseMsg( $row );
}
}
* Start module profiling
*/
public function profileIn() {
- if ( $this->mTimeIn !== 0 )
- ApiBase :: dieDebug( __METHOD__, 'called twice without calling profileOut()' );
+ if ( $this->mTimeIn !== 0 ) {
+ ApiBase::dieDebug( __METHOD__, 'called twice without calling profileOut()' );
+ }
$this->mTimeIn = microtime( true );
wfProfileIn( $this->getModuleProfileName() );
}
* End module profiling
*/
public function profileOut() {
- if ( $this->mTimeIn === 0 )
- ApiBase :: dieDebug( __METHOD__, 'called without calling profileIn() first' );
- if ( $this->mDBTimeIn !== 0 )
- ApiBase :: dieDebug( __METHOD__, 'must be called after database profiling is done with profileDBOut()' );
+ if ( $this->mTimeIn === 0 ) {
+ ApiBase::dieDebug( __METHOD__, 'called without calling profileIn() first' );
+ }
+ if ( $this->mDBTimeIn !== 0 ) {
+ ApiBase::dieDebug( __METHOD__, 'must be called after database profiling is done with profileDBOut()' );
+ }
$this->mModuleTime += microtime( true ) - $this->mTimeIn;
$this->mTimeIn = 0;
*/
public function safeProfileOut() {
if ( $this->mTimeIn !== 0 ) {
- if ( $this->mDBTimeIn !== 0 )
+ if ( $this->mDBTimeIn !== 0 ) {
$this->profileDBOut();
+ }
$this->profileOut();
}
}
* @return float
*/
public function getProfileTime() {
- if ( $this->mTimeIn !== 0 )
- ApiBase :: dieDebug( __METHOD__, 'called without calling profileOut() first' );
+ if ( $this->mTimeIn !== 0 ) {
+ ApiBase::dieDebug( __METHOD__, 'called without calling profileOut() first' );
+ }
return $this->mModuleTime;
}
* Start module profiling
*/
public function profileDBIn() {
- if ( $this->mTimeIn === 0 )
- ApiBase :: dieDebug( __METHOD__, 'must be called while profiling the entire module with profileIn()' );
- if ( $this->mDBTimeIn !== 0 )
- ApiBase :: dieDebug( __METHOD__, 'called twice without calling profileDBOut()' );
+ if ( $this->mTimeIn === 0 ) {
+ ApiBase::dieDebug( __METHOD__, 'must be called while profiling the entire module with profileIn()' );
+ }
+ if ( $this->mDBTimeIn !== 0 ) {
+ ApiBase::dieDebug( __METHOD__, 'called twice without calling profileDBOut()' );
+ }
$this->mDBTimeIn = microtime( true );
wfProfileIn( $this->getModuleProfileName( true ) );
}
* End database profiling
*/
public function profileDBOut() {
- if ( $this->mTimeIn === 0 )
- ApiBase :: dieDebug( __METHOD__, 'must be called while profiling the entire module with profileIn()' );
- if ( $this->mDBTimeIn === 0 )
- ApiBase :: dieDebug( __METHOD__, 'called without calling profileDBIn() first' );
+ if ( $this->mTimeIn === 0 ) {
+ ApiBase::dieDebug( __METHOD__, 'must be called while profiling the entire module with profileIn()' );
+ }
+ if ( $this->mDBTimeIn === 0 ) {
+ ApiBase::dieDebug( __METHOD__, 'called without calling profileDBIn() first' );
+ }
$time = microtime( true ) - $this->mDBTimeIn;
$this->mDBTimeIn = 0;
* @return float
*/
public function getProfileDBTime() {
- if ( $this->mDBTimeIn !== 0 )
- ApiBase :: dieDebug( __METHOD__, 'called without calling profileDBOut() first' );
+ if ( $this->mDBTimeIn !== 0 ) {
+ ApiBase::dieDebug( __METHOD__, 'called without calling profileDBOut() first' );
+ }
return $this->mDBTime;
}
public static function debugPrint( $value, $name = 'unknown', $backtrace = false ) {
print "\n\n<pre><b>Debugging value '$name':</b>\n\n";
var_export( $value );
- if ( $backtrace )
+ if ( $backtrace ) {
print "\n" . wfBacktrace();
+ }
print "\n</pre>\n";
}
-
/**
* Returns a string that identifies the version of this class.
* @return string
dépôts / lhc / web / wiklou.git / blobdiff