<?php
-
-/*
- * Created on Sep 24, 2006
- *
+/**
* API for MediaWiki 1.8+
*
- * Copyright (C) 2006 Yuri Astrakhan <Firstname><Lastname>@gmail.com
+ * Created on Sep 24, 2006
+ *
+ * Copyright © 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
*
* 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
*/
if ( !defined( 'MEDIAWIKI' ) ) {
// Eclipse helper - will be ignored in production
- require_once ( 'ApiQueryBase.php' );
+ require_once( 'ApiQueryBase.php' );
}
/**
private $mAllPages; // [ns][dbkey] => page_id or negative when missing
private $mTitles, $mGoodTitles, $mMissingTitles, $mInvalidTitles;
- private $mMissingPageIDs, $mRedirectTitles;
+ private $mMissingPageIDs, $mRedirectTitles, $mSpecialTitles;
private $mNormalizedTitles, $mInterwikiTitles;
private $mResolveRedirects, $mPendingRedirectIDs;
+ private $mConvertTitles, $mConvertedTitles;
private $mGoodRevIDs, $mMissingRevIDs;
private $mFakePageId;
* @param $query ApiQuery
* @param $resolveRedirects bool Whether redirects should be resolved
*/
- public function __construct( $query, $resolveRedirects = false ) {
- parent :: __construct( $query, 'query' );
+ public function __construct( $query, $resolveRedirects = false, $convertTitles = false ) {
+ parent::__construct( $query, 'query' );
- $this->mAllPages = array ();
+ $this->mAllPages = array();
$this->mTitles = array();
- $this->mGoodTitles = array ();
- $this->mMissingTitles = array ();
- $this->mInvalidTitles = array ();
- $this->mMissingPageIDs = array ();
- $this->mRedirectTitles = array ();
- $this->mNormalizedTitles = array ();
- $this->mInterwikiTitles = array ();
+ $this->mGoodTitles = array();
+ $this->mMissingTitles = array();
+ $this->mInvalidTitles = array();
+ $this->mMissingPageIDs = array();
+ $this->mRedirectTitles = array();
+ $this->mNormalizedTitles = array();
+ $this->mInterwikiTitles = array();
$this->mGoodRevIDs = array();
$this->mMissingRevIDs = array();
+ $this->mSpecialTitles = array();
- $this->mRequestedPageFields = array ();
+ $this->mRequestedPageFields = array();
$this->mResolveRedirects = $resolveRedirects;
- if ( $resolveRedirects )
+ if ( $resolveRedirects ) {
$this->mPendingRedirectIDs = array();
+ }
+
+ $this->mConvertTitles = $convertTitles;
+ $this->mConvertedTitles = array();
$this->mFakePageId = - 1;
}
public function getPageTableFields() {
// Ensure we get minimum required fields
// DON'T change this order
- $pageFlds = array (
+ $pageFlds = array(
'page_namespace' => null,
'page_title' => null,
'page_id' => null,
);
- if ( $this->mResolveRedirects )
+ if ( $this->mResolveRedirects ) {
$pageFlds['page_is_redirect'] = null;
+ }
// only store non-default fields
$this->mRequestedPageFields = array_diff_key( $this->mRequestedPageFields, $pageFlds );
return $this->mNormalizedTitles;
}
+ /**
+ * Get a list of title conversions - maps a title to its converted
+ * version.
+ * @return array raw_prefixed_title (string) => prefixed_title (string)
+ */
+ public function getConvertedTitles() {
+ return $this->mConvertedTitles;
+ }
+
/**
* Get a list of interwiki titles - maps a title to its interwiki
* prefix.
return $this->mMissingRevIDs;
}
+ /**
+ * Get the list of titles with negative namespace
+ * @return array Title
+ */
+ public function getSpecialTitles() {
+ return $this->mSpecialTitles;
+ }
+
/**
* Returns the number of revisions (requested with revids= parameter)\
* @return int
// Only one of the titles/pageids/revids is allowed at the same time
$dataSource = null;
- if ( isset ( $params['titles'] ) )
+ if ( isset( $params['titles'] ) ) {
$dataSource = 'titles';
- if ( isset ( $params['pageids'] ) ) {
- if ( isset ( $dataSource ) )
+ }
+ if ( isset( $params['pageids'] ) ) {
+ if ( isset( $dataSource ) ) {
$this->dieUsage( "Cannot use 'pageids' at the same time as '$dataSource'", 'multisource' );
+ }
$dataSource = 'pageids';
}
- if ( isset ( $params['revids'] ) ) {
- if ( isset ( $dataSource ) )
+ if ( isset( $params['revids'] ) ) {
+ if ( isset( $dataSource ) ) {
$this->dieUsage( "Cannot use 'revids' at the same time as '$dataSource'", 'multisource' );
+ }
$dataSource = 'revids';
}
switch ( $dataSource ) {
- case 'titles' :
+ case 'titles':
$this->initFromTitles( $params['titles'] );
break;
- case 'pageids' :
+ case 'pageids':
$this->initFromPageIds( $params['pageids'] );
break;
- case 'revids' :
- if ( $this->mResolveRedirects )
+ case 'revids':
+ if ( $this->mResolveRedirects ) {
$this->setWarning( 'Redirect resolution cannot be used together with the revids= parameter. ' .
'Any redirects the revids= point to have not been resolved.' );
+ }
$this->mResolveRedirects = false;
$this->initFromRevIDs( $params['revids'] );
break;
- default :
+ default:
// Do nothing - some queries do not need any of the data sources.
break;
}
/**
* Populate this PageSet from a rowset returned from the database
* @param $db Database object
- * @param $queryResult Query result object
+ * @param $queryResult ResultWrapper Query result object
*/
public function populateFromQueryResult( $db, $queryResult ) {
$this->profileIn();
* @param $row Result row
*/
public function processDbRow( $row ) {
-
// Store Title object in various data structures
- $title = Title :: makeTitle( $row->page_namespace, $row->page_title );
+ $title = Title::makeTitle( $row->page_namespace, $row->page_title );
$pageId = intval( $row->page_id );
$this->mAllPages[$row->page_namespace][$row->page_title] = $pageId;
$this->mGoodTitles[$pageId] = $title;
}
- foreach ( $this->mRequestedPageFields as $fieldName => & $fieldValues )
+ foreach ( $this->mRequestedPageFields as $fieldName => &$fieldValues ) {
$fieldValues[$pageId] = $row-> $fieldName;
+ }
}
/**
* @param $titles array of Title objects or strings
*/
private function initFromTitles( $titles ) {
-
// Get validated and normalized title objects
$linkBatch = $this->processTitlesArray( $titles );
- if ( $linkBatch->isEmpty() )
+ if ( $linkBatch->isEmpty() ) {
return;
+ }
$db = $this->getDB();
$set = $linkBatch->constructSet( 'page', $db );
$this->profileDBOut();
// Hack: get the ns:titles stored in array(ns => array(titles)) format
- $this->initFromQueryResult( $db, $res, $linkBatch->data, true ); // process Titles
+ $this->initFromQueryResult( $db, $res, $linkBatch->data, true ); // process Titles
// Resolve any found redirects
$this->resolvePendingRedirects();
* @param $pageids array of page IDs
*/
private function initFromPageIds( $pageids ) {
- if ( !count( $pageids ) )
+ if ( !count( $pageids ) ) {
return;
+ }
$pageids = array_map( 'intval', $pageids ); // paranoia
- $set = array (
+ $set = array(
'page_id' => $pageids
);
$db = $this->getDB();
* Iterate through the result of the query on 'page' table,
* and for each row create and store title object and save any extra fields requested.
* @param $db Database
- * @param $res DB Query result
+ * @param $res ResultWrapper DB Query result
* @param $remaining array of either pageID or ns/title elements (optional).
* If given, any missing items will go to $mMissingPageIDs and $mMissingTitles
* @param $processTitles bool Must be provided together with $remaining.
* If false, treat it as an array of [pageIDs]
*/
private function initFromQueryResult( $db, $res, &$remaining = null, $processTitles = null ) {
- if ( !is_null( $remaining ) && is_null( $processTitles ) )
- ApiBase :: dieDebug( __METHOD__, 'Missing $processTitles parameter when $remaining is provided' );
-
- while ( $row = $db->fetchObject( $res ) ) {
+ if ( !is_null( $remaining ) && is_null( $processTitles ) ) {
+ ApiBase::dieDebug( __METHOD__, 'Missing $processTitles parameter when $remaining is provided' );
+ }
+ foreach ( $res as $row ) {
$pageId = intval( $row->page_id );
// Remove found page from the list of remaining items
if ( isset( $remaining ) ) {
- if ( $processTitles )
- unset ( $remaining[$row->page_namespace][$row->page_title] );
- else
- unset ( $remaining[$pageId] );
+ if ( $processTitles ) {
+ unset( $remaining[$row->page_namespace][$row->page_title] );
+ } else {
+ unset( $remaining[$pageId] );
+ }
}
// Store any extra fields requested by modules
$this->processDbRow( $row );
}
- $db->freeResult( $res );
if ( isset( $remaining ) ) {
// Any items left in the $remaining list are added as missing
if ( $processTitles ) {
// The remaining titles in $remaining are non-existent pages
foreach ( $remaining as $ns => $dbkeys ) {
- foreach ( $dbkeys as $dbkey => $unused ) {
- $title = Title :: makeTitle( $ns, $dbkey );
+ foreach ( array_keys( $dbkeys ) as $dbkey ) {
+ $title = Title::makeTitle( $ns, $dbkey );
$this->mAllPages[$ns][$dbkey] = $this->mFakePageId;
$this->mMissingTitles[$this->mFakePageId] = $title;
$this->mFakePageId--;
$this->mTitles[] = $title;
}
}
- }
- else
- {
+ } else {
// The remaining pageids do not exist
- if ( !$this->mMissingPageIDs )
+ if ( !$this->mMissingPageIDs ) {
$this->mMissingPageIDs = array_keys( $remaining );
- else
+ } else {
$this->mMissingPageIDs = array_merge( $this->mMissingPageIDs, array_keys( $remaining ) );
+ }
}
}
}
* @param $revids array of revision IDs
*/
private function initFromRevIDs( $revids ) {
-
- if ( !count( $revids ) )
+ if ( !count( $revids ) ) {
return;
+ }
$revids = array_map( 'intval', $revids ); // paranoia
$db = $this->getDB();
// Get pageIDs data from the `page` table
$this->profileDBIn();
$res = $db->select( $tables, $fields, $where, __METHOD__ );
- while ( $row = $db->fetchObject( $res ) ) {
+ foreach ( $res as $row ) {
$revid = intval( $row->rev_id );
$pageid = intval( $row->rev_page );
$this->mGoodRevIDs[$revid] = $pageid;
$pageids[$pageid] = '';
unset( $remaining[$revid] );
}
- $db->freeResult( $res );
$this->profileDBOut();
$this->mMissingRevIDs = array_keys( $remaining );
* have been resolved.
*/
private function resolvePendingRedirects() {
-
if ( $this->mResolveRedirects ) {
$db = $this->getDB();
$pageFlds = $this->getPageTableFields();
// Repeat until all redirects have been resolved
// The infinite loop is prevented by keeping all known pages in $this->mAllPages
while ( $this->mPendingRedirectIDs ) {
-
// Resolve redirects by querying the pagelinks table, and repeat the process
// Create a new linkBatch object for the next pass
$linkBatch = $this->getRedirectTargets();
- if ( $linkBatch->isEmpty() )
+ if ( $linkBatch->isEmpty() ) {
break;
+ }
$set = $linkBatch->constructSet( 'page', $db );
- if ( $set === false )
+ if ( $set === false ) {
break;
+ }
// Get pageIDs data from the `page` table
$this->profileDBIn();
$db = $this->getDB();
$this->profileDBIn();
- $res = $db->select( 'redirect', array(
+ $res = $db->select(
+ 'redirect',
+ array(
'rd_from',
'rd_namespace',
'rd_title'
);
$this->profileDBOut();
- while ( $row = $db->fetchObject( $res ) )
- {
+ foreach ( $res as $row ) {
$rdfrom = intval( $row->rd_from );
$from = $this->mPendingRedirectIDs[$rdfrom]->getPrefixedText();
$to = Title::makeTitle( $row->rd_namespace, $row->rd_title )->getPrefixedText();
unset( $this->mPendingRedirectIDs[$rdfrom] );
- if ( !isset( $this->mAllPages[$row->rd_namespace][$row->rd_title] ) )
+ if ( !isset( $this->mAllPages[$row->rd_namespace][$row->rd_title] ) ) {
$lb->add( $row->rd_namespace, $row->rd_title );
+ }
$this->mRedirectTitles[$from] = $to;
}
- $db->freeResult( $res );
- if ( $this->mPendingRedirectIDs )
- {
- # We found pages that aren't in the redirect table
- # Add them
- foreach ( $this->mPendingRedirectIDs as $id => $title )
- {
+
+ if ( $this->mPendingRedirectIDs ) {
+ // We found pages that aren't in the redirect table
+ // Add them
+ foreach ( $this->mPendingRedirectIDs as $id => $title ) {
$article = new Article( $title );
$rt = $article->insertRedirect();
- if ( !$rt )
- # What the hell. Let's just ignore this
+ if ( !$rt ) {
+ // What the hell. Let's just ignore this
continue;
+ }
$lb->addObj( $rt );
$this->mRedirectTitles[$title->getPrefixedText()] = $rt->getPrefixedText();
unset( $this->mPendingRedirectIDs[$id] );
* @return LinkBatch
*/
private function processTitlesArray( $titles ) {
-
$linkBatch = new LinkBatch();
foreach ( $titles as $title ) {
-
- $titleObj = is_string( $title ) ? Title :: newFromText( $title ) : $title;
- if ( !$titleObj )
- {
- # Handle invalid titles gracefully
+ $titleObj = is_string( $title ) ? Title::newFromText( $title ) : $title;
+ if ( !$titleObj ) {
+ // Handle invalid titles gracefully
$this->mAllpages[0][$title] = $this->mFakePageId;
$this->mInvalidTitles[$this->mFakePageId] = $title;
$this->mFakePageId--;
continue; // There's nothing else we can do
}
+ $unconvertedTitle = $titleObj->getPrefixedText();
+ $titleWasConverted = false;
$iw = $titleObj->getInterwiki();
if ( strval( $iw ) !== '' ) {
// This title is an interwiki link.
$this->mInterwikiTitles[$titleObj->getPrefixedText()] = $iw;
} else {
+ // Variants checking
+ global $wgContLang;
+ if ( $this->mConvertTitles &&
+ count( $wgContLang->getVariants() ) > 1 &&
+ !$titleObj->exists() ) {
+ // Language::findVariantLink will modify titleObj into
+ // the canonical variant if possible
+ $wgContLang->findVariantLink( $title, $titleObj );
+ $titleWasConverted = $unconvertedTitle !== $titleObj->getPrefixedText();
+ }
+
- // Validation
- if ( $titleObj->getNamespace() < 0 )
- $this->setWarning( "No support for special pages has been implemented" );
- else
+ if ( $titleObj->getNamespace() < 0 ) {
+ // Handle Special and Media pages
+ $titleObj = $titleObj->fixSpecialName();
+ $this->mSpecialTitles[$this->mFakePageId] = $titleObj;
+ $this->mFakePageId--;
+ } else {
+ // Regular page
$linkBatch->addObj( $titleObj );
+ }
}
// Make sure we remember the original title that was
// titles with the originally requested when e.g. the
// namespace is localized or the capitalization is
// different
- if ( is_string( $title ) && $title !== $titleObj->getPrefixedText() ) {
+ if ( $titleWasConverted ) {
+ $this->mConvertedTitles[$title] = $titleObj->getPrefixedText();
+ } elseif ( is_string( $title ) && $title !== $titleObj->getPrefixedText() ) {
$this->mNormalizedTitles[$title] = $titleObj->getPrefixedText();
}
}
}
protected function getAllowedParams() {
- return array (
- 'titles' => array (
- ApiBase :: PARAM_ISMULTI => true
+ return array(
+ 'titles' => array(
+ ApiBase::PARAM_ISMULTI => true
),
- 'pageids' => array (
- ApiBase :: PARAM_TYPE => 'integer',
- ApiBase :: PARAM_ISMULTI => true
+ 'pageids' => array(
+ ApiBase::PARAM_TYPE => 'integer',
+ ApiBase::PARAM_ISMULTI => true
),
- 'revids' => array (
- ApiBase :: PARAM_TYPE => 'integer',
- ApiBase :: PARAM_ISMULTI => true
+ 'revids' => array(
+ ApiBase::PARAM_TYPE => 'integer',
+ ApiBase::PARAM_ISMULTI => true
)
);
}
protected function getParamDescription() {
- return array (
+ return array(
'titles' => 'A list of titles to work on',
'pageids' => 'A list of page IDs to work on',
'revids' => 'A list of revision IDs to work on'
);
}
+ public function getPossibleErrors() {
+ return array_merge( parent::getPossibleErrors(), array(
+ array( 'code' => 'multisource', 'info' => "Cannot use 'pageids' at the same time as 'dataSource'" ),
+ array( 'code' => 'multisource', 'info' => "Cannot use 'revids' at the same time as 'dataSource'" ),
+ ) );
+ }
+
public function getVersion() {
return __CLASS__ . ': $Id$';
}
dépôts / lhc / web / wiklou.git / blobdiff