/**
* A query module to list all external URLs found on a given set of pages.
- *
- * @addtogroup API
+ *
+ * @ingroup API
*/
class ApiQueryExternalLinks extends ApiQueryBase {
}
public function execute() {
+ if ( $this->getPageSet()->getGoodTitleCount() == 0 )
+ return;
+ $params = $this->extractRequestParams();
$this->addFields(array (
'el_from',
'el_to'
));
-
+
$this->addTables('externallinks');
$this->addWhereFld('el_from', array_keys($this->getPageSet()->getGoodTitles()));
+ # Don't order by el_from if it's constant in the WHERE clause
+ if(count($this->getPageSet()->getGoodTitles()) != 1)
+ $this->addOption('ORDER BY', 'el_from');
+ $this->addOption('LIMIT', $params['limit'] + 1);
+ if(!is_null($params['offset']))
+ $this->addOption('OFFSET', $params['offset']);
$db = $this->getDB();
$res = $this->select(__METHOD__);
-
- $data = array();
- $lastId = 0; // database has no ID 0
+
+ $count = 0;
while ($row = $db->fetchObject($res)) {
- if ($lastId != $row->el_from) {
- if($lastId != 0) {
- $this->addPageSubItems($lastId, $data);
- $data = array();
- }
- $lastId = $row->el_from;
+ if (++$count > $params['limit']) {
+ // We've reached the one extra which shows that
+ // there are additional pages to be had. Stop here...
+ $this->setContinueEnumParameter('offset', @$params['offset'] + $params['limit']);
+ break;
}
-
$entry = array();
ApiResult :: setContent($entry, $row->el_to);
- $data[] = $entry;
+ $fit = $this->addPageSubItem($row->el_from, $entry);
+ if(!$fit)
+ {
+ $this->setContinueEnumParameter('offset', @$params['offset'] + $count - 1);
+ break;
+ }
}
+ $db->freeResult($res);
+ }
- if($lastId != 0) {
- $this->addPageSubItems($lastId, $data);
- }
+ public function getAllowedParams() {
+ return array(
+ 'limit' => array(
+ ApiBase :: PARAM_DFLT => 10,
+ ApiBase :: PARAM_TYPE => 'limit',
+ ApiBase :: PARAM_MIN => 1,
+ ApiBase :: PARAM_MAX => ApiBase :: LIMIT_BIG1,
+ ApiBase :: PARAM_MAX2 => ApiBase :: LIMIT_BIG2
+ ),
+ 'offset' => null,
+ );
+ }
- $db->freeResult($res);
+ public function getParamDescription () {
+ return array(
+ 'limit' => 'How many links to return',
+ 'offset' => 'When more results are available, use this to continue',
+ );
}
- protected function getDescription() {
+ public function getDescription() {
return 'Returns all external urls (not interwikies) from the given page(s)';
}
}
public function getVersion() {
- return __CLASS__ . ': $Id: ApiQueryExternalLinks.php 23819 2007-07-07 03:05:09Z yurik $';
+ return __CLASS__ . ': $Id: ApiQueryExternalLinks.php 46845 2009-02-05 14:30:59Z catrope $';
}
-}
-
+}
\ No newline at end of file