425 lines
13 KiB
PHP
425 lines
13 KiB
PHP
<?php
|
||
|
||
/*
|
||
* Created on Sep 7, 2006
|
||
*
|
||
* 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
|
||
*/
|
||
|
||
if (!defined('MEDIAWIKI')) {
|
||
// Eclipse helper - will be ignored in production
|
||
require_once ('ApiBase.php');
|
||
}
|
||
|
||
/**
|
||
* This is a base class for all Query modules.
|
||
* It provides some common functionality such as constructing various SQL queries.
|
||
*
|
||
* @addtogroup API
|
||
*/
|
||
abstract class ApiQueryBase extends ApiBase {
|
||
|
||
private $mQueryModule, $mDb, $tables, $where, $fields, $options;
|
||
|
||
const LEFT_JOIN = 1;
|
||
const RIGHT_JOIN = 2;
|
||
|
||
public function __construct($query, $moduleName, $paramPrefix = '') {
|
||
parent :: __construct($query->getMain(), $moduleName, $paramPrefix);
|
||
$this->mQueryModule = $query;
|
||
$this->mDb = null;
|
||
$this->resetQueryParams();
|
||
}
|
||
|
||
/**
|
||
* Blank the internal arrays with query parameters
|
||
*/
|
||
protected function resetQueryParams() {
|
||
$this->tables = array ();
|
||
$this->where = array ();
|
||
$this->fields = array ();
|
||
$this->options = array ();
|
||
}
|
||
|
||
/**
|
||
* Add a set of tables to the internal array
|
||
* @param mixed $tables Table name or array of table names
|
||
* @param mixed $alias Table alias, or null for no alias. Cannot be used with multiple tables
|
||
*/
|
||
protected function addTables($tables, $alias = null) {
|
||
if (is_array($tables)) {
|
||
if (!is_null($alias))
|
||
ApiBase :: dieDebug(__METHOD__, 'Multiple table aliases not supported');
|
||
$this->tables = array_merge($this->tables, $tables);
|
||
} else {
|
||
if (!is_null($alias))
|
||
$tables = $this->getDB()->tableName($tables) . ' ' . $alias;
|
||
$this->tables[] = $tables;
|
||
}
|
||
}
|
||
|
||
/**
|
||
* Add a JOIN to the internal array.
|
||
*
|
||
* Example for: a LEFT JOIN page AS b ON foo=bar RIGHT JOIN c ON foo=baz AND bar=3
|
||
*
|
||
* addJoin(array('a', 'page', 'c'), array(ApiQueryBase::LEFT_JOIN, ApiQueryBase::RIGHT_JOIN),
|
||
* array('foo=bar', array('foo=baz', 'bar' => 3), array(null, 'b', null))
|
||
* @param array $tables Array of table names
|
||
* @param array $types Array of join types (either LEFT_JOIN or RIGHT_JOIN)
|
||
* @param array $onClauses Array of ON clauses. Each element is formed like addWhere()'s parameter
|
||
* @param array $aliases Array of table aliases, or null for no alias
|
||
*/
|
||
protected function addJoin($tables, $types, $onClauses, $aliases = null) {
|
||
if(is_null($aliases))
|
||
foreach($tables as $unused)
|
||
$aliases[] = null;
|
||
if(!is_array($tables) || !is_array($types) || !is_array($onClauses) || !is_array($aliases))
|
||
ApiBase::dieDebug(__METHOD__, 'This function only takes arrays as parameters');
|
||
$sql = $this->getDB()->tableName($tables[0]) . (is_null($aliases[0]) ? "" : " {$aliases[0]}");
|
||
for($i = 0; $i < count($tables) - 1; $i++)
|
||
{
|
||
if($types[$i] == self::LEFT_JOIN)
|
||
$join = "LEFT JOIN";
|
||
else if($types[$i] == self::RIGHT_JOIN)
|
||
$join = "RIGHT JOIN";
|
||
else
|
||
ApiBase::dieDebug(__METHOD__, "Invalid join type {$types[$i]}");
|
||
|
||
if(is_array($onClauses[$i]))
|
||
$on = $this->getDB()->makeList($onClauses[$i], LIST_AND);
|
||
else
|
||
$on = $onClauses[$i];
|
||
$alias = $aliases[$i+1];
|
||
$tblname = $this->getDB()->tableName($tables[$i+1]) . (is_null($alias) ? "" : " $alias");
|
||
$sql = "$sql $join $tblname ON $on";
|
||
}
|
||
$this->addTables($sql);
|
||
}
|
||
|
||
/**
|
||
* Add a set of fields to select to the internal array
|
||
* @param mixed $value Field name or array of field names
|
||
*/
|
||
protected function addFields($value) {
|
||
if (is_array($value))
|
||
$this->fields = array_merge($this->fields, $value);
|
||
else
|
||
$this->fields[] = $value;
|
||
}
|
||
|
||
/**
|
||
* Same as addFields(), but add the fields only if a condition is met
|
||
* @param mixed $value See addFields()
|
||
* @param bool $condition If false, do nothing
|
||
* @return bool $condition
|
||
*/
|
||
protected function addFieldsIf($value, $condition) {
|
||
if ($condition) {
|
||
$this->addFields($value);
|
||
return true;
|
||
}
|
||
return false;
|
||
}
|
||
|
||
/**
|
||
* Add a set of WHERE clauses to the internal array.
|
||
* Clauses can be formatted as 'foo=bar' or array('foo' => 'bar'),
|
||
* the latter only works if the value is a constant (i.e. not another field)
|
||
*
|
||
* For example, array('foo=bar', 'baz' => 3, 'bla' => 'foo') translates
|
||
* to "foo=bar AND baz='3' AND bla='foo'"
|
||
* @param mixed $value String or array
|
||
*/
|
||
protected function addWhere($value) {
|
||
if (is_array($value))
|
||
$this->where = array_merge($this->where, $value);
|
||
else
|
||
$this->where[] = $value;
|
||
}
|
||
|
||
/**
|
||
* Same as addWhere(), but add the WHERE clauses only if a condition is met
|
||
* @param mixed $value See addWhere()
|
||
* @param bool $condition If false, do nothing
|
||
* @return bool $condition
|
||
*/
|
||
protected function addWhereIf($value, $condition) {
|
||
if ($condition) {
|
||
$this->addWhere($value);
|
||
return true;
|
||
}
|
||
return false;
|
||
}
|
||
|
||
/**
|
||
* Equivalent to addWhere(array($field => $value))
|
||
* @param string $field Field name
|
||
* @param string $value Value; ignored if nul;
|
||
*/
|
||
protected function addWhereFld($field, $value) {
|
||
if (!is_null($value))
|
||
$this->where[$field] = $value;
|
||
}
|
||
|
||
/**
|
||
* Add a WHERE clause corresponding to a range, and an ORDER BY
|
||
* clause to sort in the right direction
|
||
* @param string $field Field name
|
||
* @param string $dir If 'newer', sort in ascending order, otherwise sort in descending order
|
||
* @param string $start Value to start the list at. If $dir == 'newer' this is the lower boundary, otherwise it's the upper boundary
|
||
* @param string $end Value to end the list at. If $dir == 'newer' this is the upper boundary, otherwise it's the lower boundary
|
||
*/
|
||
protected function addWhereRange($field, $dir, $start, $end) {
|
||
$isDirNewer = ($dir === 'newer');
|
||
$after = ($isDirNewer ? '>=' : '<=');
|
||
$before = ($isDirNewer ? '<=' : '>=');
|
||
$db = $this->getDB();
|
||
|
||
if (!is_null($start))
|
||
$this->addWhere($field . $after . $db->addQuotes($start));
|
||
|
||
if (!is_null($end))
|
||
$this->addWhere($field . $before . $db->addQuotes($end));
|
||
|
||
$order = $field . ($isDirNewer ? '' : ' DESC');
|
||
if (!isset($this->options['ORDER BY']))
|
||
$this->addOption('ORDER BY', $order);
|
||
else
|
||
$this->addOption('ORDER BY', $this->options['ORDER BY'] . ', ' . $order);
|
||
}
|
||
|
||
/**
|
||
* Add an option such as LIMIT or USE INDEX
|
||
* @param string $name Option name
|
||
* @param string $value Option value
|
||
*/
|
||
protected function addOption($name, $value = null) {
|
||
if (is_null($value))
|
||
$this->options[] = $name;
|
||
else
|
||
$this->options[$name] = $value;
|
||
}
|
||
|
||
/**
|
||
* Execute a SELECT query based on the values in the internal arrays
|
||
* @param string $method Function the query should be attributed to. You should usually use __METHOD__ here
|
||
* @return ResultWrapper
|
||
*/
|
||
protected function select($method) {
|
||
|
||
// getDB has its own profileDBIn/Out calls
|
||
$db = $this->getDB();
|
||
|
||
$this->profileDBIn();
|
||
$res = $db->select($this->tables, $this->fields, $this->where, $method, $this->options);
|
||
$this->profileDBOut();
|
||
|
||
return $res;
|
||
}
|
||
|
||
/**
|
||
* Estimate the row count for the SELECT query that would be run if we
|
||
* called select() right now, and check if it's acceptable.
|
||
* @return bool true if acceptable, false otherwise
|
||
*/
|
||
protected function checkRowCount() {
|
||
$db = $this->getDB();
|
||
$this->profileDBIn();
|
||
$rowcount = $db->estimateRowCount($this->tables, $this->fields, $this->where, __METHOD__, $this->options);
|
||
$this->profileDBOut();
|
||
|
||
global $wgAPIMaxDBRows;
|
||
if($rowcount > $wgAPIMaxDBRows)
|
||
return false;
|
||
return true;
|
||
}
|
||
|
||
/**
|
||
* Add information (title and namespace) about a Title object to a result array
|
||
* @param array $arr Result array <20> la ApiResult
|
||
* @param Title $title Title object
|
||
* @param string $prefix Module prefix
|
||
*/
|
||
public static function addTitleInfo(&$arr, $title, $prefix='') {
|
||
$arr[$prefix . 'ns'] = intval($title->getNamespace());
|
||
$arr[$prefix . 'title'] = $title->getPrefixedText();
|
||
}
|
||
|
||
/**
|
||
* Override this method to request extra fields from the pageSet
|
||
* using $pageSet->requestField('fieldName')
|
||
* @param ApiPageSet $pageSet
|
||
*/
|
||
public function requestExtraData($pageSet) {
|
||
}
|
||
|
||
/**
|
||
* Get the main Query module
|
||
* @return ApiQuery
|
||
*/
|
||
public function getQuery() {
|
||
return $this->mQueryModule;
|
||
}
|
||
|
||
/**
|
||
* Add a sub-element under the page element with the given page ID
|
||
* @param int $pageId Page ID
|
||
* @param array $data Data array <20> la ApiResult
|
||
*/
|
||
protected function addPageSubItems($pageId, $data) {
|
||
$result = $this->getResult();
|
||
$result->setIndexedTagName($data, $this->getModulePrefix());
|
||
$result->addValue(array ('query', 'pages', intval($pageId)),
|
||
$this->getModuleName(),
|
||
$data);
|
||
}
|
||
|
||
/**
|
||
* Set a query-continue value
|
||
* @param $paramName Parameter name
|
||
* @param $paramValue Parameter value
|
||
*/
|
||
protected function setContinueEnumParameter($paramName, $paramValue) {
|
||
|
||
$paramName = $this->encodeParamName($paramName);
|
||
$msg = array( $paramName => $paramValue );
|
||
$this->getResult()->addValue('query-continue', $this->getModuleName(), $msg);
|
||
}
|
||
|
||
/**
|
||
* Get the Query database connection (readonly)
|
||
* @return Database
|
||
*/
|
||
protected function getDB() {
|
||
if (is_null($this->mDb))
|
||
$this->mDb = $this->getQuery()->getDB();
|
||
return $this->mDb;
|
||
}
|
||
|
||
/**
|
||
* Selects the query database connection with the given name.
|
||
* If no such connection has been requested before, it will be created.
|
||
* Subsequent calls with the same $name will return the same connection
|
||
* as the first, regardless of $db or $groups new values.
|
||
* @param string $name Name to assign to the database connection
|
||
* @param int $db One of the DB_* constants
|
||
* @param array $groups Query groups
|
||
* @return Database
|
||
*/
|
||
public function selectNamedDB($name, $db, $groups) {
|
||
$this->mDb = $this->getQuery()->getNamedDB($name, $db, $groups);
|
||
}
|
||
|
||
/**
|
||
* Get the PageSet object to work on
|
||
* @return ApiPageSet
|
||
*/
|
||
protected function getPageSet() {
|
||
return $this->getQuery()->getPageSet();
|
||
}
|
||
|
||
/**
|
||
* This is a very simplistic utility function
|
||
* to convert a non-namespaced title string to a db key.
|
||
* It will replace all ' ' with '_'
|
||
* @param string $title Page title with spaces
|
||
* @return string Page title with underscores
|
||
*/
|
||
public static function titleToKey($title) {
|
||
return str_replace(' ', '_', $title);
|
||
}
|
||
|
||
/**
|
||
* The inverse of titleToKey()
|
||
* @param string $key Page title with underscores
|
||
* @return string Page title with spaces
|
||
*/
|
||
public static function keyToTitle($key) {
|
||
return str_replace('_', ' ', $key);
|
||
}
|
||
|
||
/**
|
||
* Check whether the current user requested a certain token and
|
||
* is actually allowed to request it.
|
||
* @param array $tokenArr Array of tokens the user requested
|
||
* @param string $action Action to check for
|
||
* @return bool true if the user requested the token and is allowed to, false otherwise
|
||
*/
|
||
public function getTokenFlag($tokenArr, $action) {
|
||
if ($this->getMain()->getRequest()->getVal('callback') !== null) {
|
||
// Don't do any session-specific data.
|
||
return false;
|
||
}
|
||
if (in_array($action, $tokenArr)) {
|
||
global $wgUser;
|
||
if ($wgUser->isAllowed($action))
|
||
return true;
|
||
else
|
||
$this->dieUsage("Action '$action' is not allowed for the current user", 'permissiondenied');
|
||
}
|
||
return false;
|
||
}
|
||
|
||
/**
|
||
* Get version string for use in the API help output
|
||
* @return string
|
||
*/
|
||
public static function getBaseVersion() {
|
||
return __CLASS__ . ': $Id$';
|
||
}
|
||
}
|
||
|
||
/**
|
||
* @addtogroup API
|
||
*/
|
||
abstract class ApiQueryGeneratorBase extends ApiQueryBase {
|
||
|
||
private $mIsGenerator;
|
||
|
||
public function __construct($query, $moduleName, $paramPrefix = '') {
|
||
parent :: __construct($query, $moduleName, $paramPrefix);
|
||
$this->mIsGenerator = false;
|
||
}
|
||
|
||
/**
|
||
* Switch this module to generator mode. By default, generator mode is
|
||
* switched off and the module acts like a normal query module.
|
||
*/
|
||
public function setGeneratorMode() {
|
||
$this->mIsGenerator = true;
|
||
}
|
||
|
||
/**
|
||
* Overrides base class to prepend 'g' to every generator parameter
|
||
*/
|
||
public function encodeParamName($paramName) {
|
||
if ($this->mIsGenerator)
|
||
return 'g' . parent :: encodeParamName($paramName);
|
||
else
|
||
return parent :: encodeParamName($paramName);
|
||
}
|
||
|
||
/**
|
||
* Execute this module as a generator
|
||
* @param $resultPageSet PageSet: All output should be appended to this object
|
||
*/
|
||
public abstract function executeGenerator($resultPageSet);
|
||
}
|