diff options
Diffstat (limited to 'includes/api/ApiQueryAllLinks.php')
| -rw-r--r-- | includes/api/ApiQueryAllLinks.php | 182 |
1 files changed, 128 insertions, 54 deletions
diff --git a/includes/api/ApiQueryAllLinks.php b/includes/api/ApiQueryAllLinks.php index da4840f0..47d1bcef 100644 --- a/includes/api/ApiQueryAllLinks.php +++ b/includes/api/ApiQueryAllLinks.php @@ -32,7 +32,51 @@ class ApiQueryAllLinks extends ApiQueryGeneratorBase { public function __construct( $query, $moduleName ) { - parent::__construct( $query, $moduleName, 'al' ); + switch ( $moduleName ) { + case 'alllinks': + $prefix = 'al'; + $this->table = 'pagelinks'; + $this->tablePrefix = 'pl_'; + $this->fieldTitle = 'title'; + $this->dfltNamespace = NS_MAIN; + $this->hasNamespace = true; + $this->indexTag = 'l'; + $this->description = 'Enumerate all links that point to a given namespace'; + $this->descriptionWhat = 'link'; + $this->descriptionTargets = 'linked titles'; + $this->descriptionLinking = 'linking'; + break; + case 'alltransclusions': + $prefix = 'at'; + $this->table = 'templatelinks'; + $this->tablePrefix = 'tl_'; + $this->fieldTitle = 'title'; + $this->dfltNamespace = NS_TEMPLATE; + $this->hasNamespace = true; + $this->indexTag = 't'; + $this->description = 'List all transclusions (pages embedded using {{x}}), including non-existing'; + $this->descriptionWhat = 'transclusion'; + $this->descriptionTargets = 'transcluded titles'; + $this->descriptionLinking = 'transcluding'; + break; + case 'allfileusages': + $prefix = 'af'; + $this->table = 'imagelinks'; + $this->tablePrefix = 'il_'; + $this->fieldTitle = 'to'; + $this->dfltNamespace = NS_FILE; + $this->hasNamespace = false; + $this->indexTag = 'f'; + $this->description = 'List all file usages, including non-existing'; + $this->descriptionWhat = 'file'; + $this->descriptionTargets = 'file titles'; + $this->descriptionLinking = 'using'; + break; + default: + ApiBase::dieDebug( __METHOD__, 'Unknown module name' ); + } + + parent::__construct( $query, $moduleName, $prefix ); } public function execute() { @@ -55,75 +99,81 @@ class ApiQueryAllLinks extends ApiQueryGeneratorBase { $db = $this->getDB(); $params = $this->extractRequestParams(); + $pfx = $this->tablePrefix; + $fieldTitle = $this->fieldTitle; $prop = array_flip( $params['prop'] ); $fld_ids = isset( $prop['ids'] ); $fld_title = isset( $prop['title'] ); + if ( $this->hasNamespace ) { + $namespace = $params['namespace']; + } else { + $namespace = $this->dfltNamespace; + } if ( $params['unique'] ) { - if ( !is_null( $resultPageSet ) ) { - $this->dieUsage( $this->getModuleName() . ' cannot be used as a generator in unique links mode', 'params' ); - } if ( $fld_ids ) { - $this->dieUsage( $this->getModuleName() . ' cannot return corresponding page ids in unique links mode', 'params' ); + $this->dieUsage( + "{$this->getModuleName()} cannot return corresponding page ids in unique {$this->descriptionWhat}s mode", + 'params' ); } $this->addOption( 'DISTINCT' ); } - $this->addTables( 'pagelinks' ); - $this->addWhereFld( 'pl_namespace', $params['namespace'] ); - - if ( !is_null( $params['from'] ) && !is_null( $params['continue'] ) ) { - $this->dieUsage( 'alcontinue and alfrom cannot be used together', 'params' ); + $this->addTables( $this->table ); + if ( $this->hasNamespace ) { + $this->addWhereFld( $pfx . 'namespace', $namespace ); } - if ( !is_null( $params['continue'] ) ) { + + $continue = !is_null( $params['continue'] ); + if ( $continue ) { $continueArr = explode( '|', $params['continue'] ); $op = $params['dir'] == 'descending' ? '<' : '>'; if ( $params['unique'] ) { - if ( count( $continueArr ) != 1 ) { - $this->dieUsage( 'Invalid continue parameter', 'badcontinue' ); - } + $this->dieContinueUsageIf( count( $continueArr ) != 1 ); $continueTitle = $db->addQuotes( $continueArr[0] ); - $this->addWhere( "pl_title $op= $continueTitle" ); + $this->addWhere( "{$pfx}{$fieldTitle} $op= $continueTitle" ); } else { - if ( count( $continueArr ) != 2 ) { - $this->dieUsage( 'Invalid continue parameter', 'badcontinue' ); - } + $this->dieContinueUsageIf( count( $continueArr ) != 2 ); $continueTitle = $db->addQuotes( $continueArr[0] ); $continueFrom = intval( $continueArr[1] ); $this->addWhere( - "pl_title $op $continueTitle OR " . - "(pl_title = $continueTitle AND " . - "pl_from $op= $continueFrom)" + "{$pfx}{$fieldTitle} $op $continueTitle OR " . + "({$pfx}{$fieldTitle} = $continueTitle AND " . + "{$pfx}from $op= $continueFrom)" ); } } - $from = ( is_null( $params['from'] ) ? null : $this->titlePartToKey( $params['from'] ) ); + // 'continue' always overrides 'from' + $from = ( $continue || is_null( $params['from'] ) ? null : $this->titlePartToKey( $params['from'] ) ); $to = ( is_null( $params['to'] ) ? null : $this->titlePartToKey( $params['to'] ) ); - $this->addWhereRange( 'pl_title', 'newer', $from, $to ); + $this->addWhereRange( $pfx . $fieldTitle, 'newer', $from, $to ); if ( isset( $params['prefix'] ) ) { - $this->addWhere( 'pl_title' . $db->buildLike( $this->titlePartToKey( $params['prefix'] ), $db->anyString() ) ); + $this->addWhere( $pfx . $fieldTitle . $db->buildLike( $this->titlePartToKey( $params['prefix'] ), $db->anyString() ) ); } - $this->addFields( 'pl_title' ); - $this->addFieldsIf( 'pl_from', !$params['unique'] ); + $this->addFields( array( 'pl_title' => $pfx . $fieldTitle ) ); + $this->addFieldsIf( array( 'pl_from' => $pfx . 'from' ), !$params['unique'] ); - $this->addOption( 'USE INDEX', 'pl_namespace' ); + if ( $this->hasNamespace ) { + $this->addOption( 'USE INDEX', $pfx . 'namespace' ); + } $limit = $params['limit']; $this->addOption( 'LIMIT', $limit + 1 ); $sort = ( $params['dir'] == 'descending' ? ' DESC' : '' ); $orderBy = array(); - $orderBy[] = 'pl_title' . $sort; + $orderBy[] = $pfx . $fieldTitle . $sort; if ( !$params['unique'] ) { - $orderBy[] = 'pl_from' . $sort; + $orderBy[] = $pfx . 'from' . $sort; } $this->addOption( 'ORDER BY', $orderBy ); $res = $this->select( __METHOD__ ); $pageids = array(); + $titles = array(); $count = 0; $result = $this->getResult(); foreach ( $res as $row ) { @@ -132,7 +182,7 @@ class ApiQueryAllLinks extends ApiQueryGeneratorBase { if ( $params['unique'] ) { $this->setContinueEnumParameter( 'continue', $row->pl_title ); } else { - $this->setContinueEnumParameter( 'continue', $row->pl_title . "|" . $row->pl_from ); + $this->setContinueEnumParameter( 'continue', $row->pl_title . '|' . $row->pl_from ); } break; } @@ -143,7 +193,7 @@ class ApiQueryAllLinks extends ApiQueryGeneratorBase { $vals['fromid'] = intval( $row->pl_from ); } if ( $fld_title ) { - $title = Title::makeTitle( $params['namespace'], $row->pl_title ); + $title = Title::makeTitle( $namespace, $row->pl_title ); ApiQueryBase::addTitleInfo( $vals, $title ); } $fit = $result->addValue( array( 'query', $this->getModuleName() ), null, $vals ); @@ -151,24 +201,28 @@ class ApiQueryAllLinks extends ApiQueryGeneratorBase { if ( $params['unique'] ) { $this->setContinueEnumParameter( 'continue', $row->pl_title ); } else { - $this->setContinueEnumParameter( 'continue', $row->pl_title . "|" . $row->pl_from ); + $this->setContinueEnumParameter( 'continue', $row->pl_title . '|' . $row->pl_from ); } break; } + } elseif ( $params['unique'] ) { + $titles[] = Title::makeTitle( $namespace, $row->pl_title ); } else { $pageids[] = $row->pl_from; } } if ( is_null( $resultPageSet ) ) { - $result->setIndexedTagName_internal( array( 'query', $this->getModuleName() ), 'l' ); + $result->setIndexedTagName_internal( array( 'query', $this->getModuleName() ), $this->indexTag ); + } elseif ( $params['unique'] ) { + $resultPageSet->populateFromTitles( $titles ); } else { $resultPageSet->populateFromPageIDs( $pageids ); } } public function getAllowedParams() { - return array( + $allowedParams = array( 'continue' => null, 'from' => null, 'to' => null, @@ -183,7 +237,7 @@ class ApiQueryAllLinks extends ApiQueryGeneratorBase { ) ), 'namespace' => array( - ApiBase::PARAM_DFLT => 0, + ApiBase::PARAM_DFLT => $this->dfltNamespace, ApiBase::PARAM_TYPE => 'namespace' ), 'limit' => array( @@ -201,25 +255,39 @@ class ApiQueryAllLinks extends ApiQueryGeneratorBase { ) ), ); + if ( !$this->hasNamespace ) { + unset( $allowedParams['namespace'] ); + } + return $allowedParams; } public function getParamDescription() { $p = $this->getModulePrefix(); - return array( - 'from' => 'The page title to start enumerating from', - 'to' => 'The page title to stop enumerating at', - 'prefix' => 'Search for all page titles that begin with this value', - 'unique' => "Only show unique links. Cannot be used with generator or {$p}prop=ids", + $what = $this->descriptionWhat; + $targets = $this->descriptionTargets; + $linking = $this->descriptionLinking; + $paramDescription = array( + 'from' => "The title of the $what to start enumerating from", + 'to' => "The title of the $what to stop enumerating at", + 'prefix' => "Search for all $targets that begin with this value", + 'unique' => array( + "Only show distinct $targets. Cannot be used with {$p}prop=ids.", + 'When used as a generator, yields target pages instead of source pages.', + ), 'prop' => array( 'What pieces of information to include', - " ids - Adds pageid of where the link is from (Cannot be used with {$p}unique)", - ' title - Adds the title of the link', + " ids - Adds the pageid of the $linking page (Cannot be used with {$p}unique)", + " title - Adds the title of the $what", ), 'namespace' => 'The namespace to enumerate', - 'limit' => 'How many total links to return', + 'limit' => 'How many total items to return', 'continue' => 'When more results are available, use this to continue', 'dir' => 'The direction in which to list', ); + if ( !$this->hasNamespace ) { + unset( $paramDescription['namespace'] ); + } + return $paramDescription; } public function getResultProperties() { @@ -235,30 +303,36 @@ class ApiQueryAllLinks extends ApiQueryGeneratorBase { } public function getDescription() { - return 'Enumerate all links that point to a given namespace'; + return $this->description; } public function getPossibleErrors() { $m = $this->getModuleName(); + $what = $this->descriptionWhat; return array_merge( parent::getPossibleErrors(), array( - array( 'code' => 'params', 'info' => "{$m} cannot be used as a generator in unique links mode" ), - array( 'code' => 'params', 'info' => "{$m} cannot return corresponding page ids in unique links mode" ), - array( 'code' => 'params', 'info' => 'alcontinue and alfrom cannot be used together' ), - array( 'code' => 'badcontinue', 'info' => 'Invalid continue parameter' ), + array( 'code' => 'params', 'info' => "{$m} cannot return corresponding page ids in unique {$what}s mode" ), ) ); } public function getExamples() { + $p = $this->getModulePrefix(); + $name = $this->getModuleName(); + $what = $this->descriptionWhat; + $targets = $this->descriptionTargets; return array( - 'api.php?action=query&list=alllinks&alunique=&alfrom=B', + "api.php?action=query&list={$name}&{$p}from=B&{$p}prop=ids|title" + => "List $targets with page ids they are from, including missing ones. Start at B", + "api.php?action=query&list={$name}&{$p}unique=&{$p}from=B" + => "List unique $targets", + "api.php?action=query&generator={$name}&g{$p}unique=&g{$p}from=B" + => "Gets all $targets, marking the missing ones", + "api.php?action=query&generator={$name}&g{$p}from=B" + => "Gets pages containing the {$what}s", ); } public function getHelpUrls() { - return 'https://www.mediawiki.org/wiki/API:Alllinks'; - } - - public function getVersion() { - return __CLASS__ . ': $Id$'; + $name = ucfirst( $this->getModuleName() ); + return "https://www.mediawiki.org/wiki/API:{$name}"; } } |