}
/**
- * Query module to enumerate all available pages.
- *
- * @addtogroup API
+ * Query module to enumerate links from all pages together.
+ *
+ * @ingroup API
*/
class ApiQueryAllLinks extends ApiQueryGeneratorBase {
$db = $this->getDB();
$params = $this->extractRequestParams();
- $this->debugPrint($params);
$prop = array_flip($params['prop']);
$fld_ids = isset($prop['ids']);
$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');
+ if (!is_null($params['continue']))
+ {
+ $arr = explode('|', $params['continue']);
+ if(count($arr) != 2)
+ $this->dieUsage("Invalid continue parameter", 'badcontinue');
+ $params['from'] = $arr[0]; // Handled later
+ $id = intval($arr[1]);
+ $this->addWhere("pl_from >= $id");
+ }
+
if (!is_null($params['from']))
- $this->addWhere('pl_title>=' . $db->addQuotes(ApiQueryBase :: titleToKey($params['from'])));
+ $this->addWhere('pl_title>=' . $db->addQuotes($this->titlePartToKey($params['from'])));
if (isset ($params['prefix']))
- $this->addWhere("pl_title LIKE '" . $db->strencode(ApiQueryBase :: titleToKey($params['prefix'])) . "%'");
+ $this->addWhere("pl_title LIKE '" . $db->escapeLike($this->titlePartToKey($params['prefix'])) . "%'");
- if (is_null($resultPageSet)) {
- $this->addFields(array (
- 'pl_namespace',
- 'pl_title'
- ));
- $this->addFieldsIf('pl_from', $fld_ids);
- } else {
- $this->addFields('pl_from');
- $pageids = array();
- }
+ $this->addFields(array (
+ 'pl_namespace',
+ 'pl_title',
+ 'pl_from'
+ ));
$this->addOption('USE INDEX', 'pl_namespace');
$limit = $params['limit'];
$this->addOption('LIMIT', $limit+1);
- $this->addOption('ORDER BY', 'pl_namespace, pl_title');
+ # Only order by pl_namespace if it isn't constant in the WHERE clause
+ if(count($params['namespace']) != 1)
+ $this->addOption('ORDER BY', 'pl_namespace, pl_title');
+ else
+ $this->addOption('ORDER BY', 'pl_title');
$res = $this->select(__METHOD__);
if (++ $count > $limit) {
// We've reached the one extra which shows that there are additional pages to be had. Stop here...
// TODO: Security issue - if the user has no right to view next title, it will still be shown
- $this->setContinueEnumParameter('from', ApiQueryBase :: keyToTitle($row->pl_title));
+ $this->setContinueEnumParameter('continue', $this->keyToTitle($row->pl_title) . "|" . $row->pl_from);
break;
}
if (is_null($resultPageSet)) {
- $title = Title :: makeTitle($row->pl_namespace, $row->pl_title);
- if ($title->userCanRead()) {
- $vals = array();
- if ($fld_ids)
- $vals['fromid'] = intval($row->pl_from);
- if ($fld_title) {
- $vals['ns'] = intval($title->getNamespace());
- $vals['title'] = $title->getPrefixedText();
- }
- $data[] = $vals;
+ $vals = array();
+ if ($fld_ids)
+ $vals['fromid'] = intval($row->pl_from);
+ if ($fld_title) {
+ $title = Title :: makeTitle($row->pl_namespace, $row->pl_title);
+ $vals['ns'] = intval($title->getNamespace());
+ $vals['title'] = $title->getPrefixedText();
}
+ $data[] = $vals;
} else {
$pageids[] = $row->pl_from;
}
}
}
- protected function getAllowedParams() {
+ public function getAllowedParams() {
return array (
+ 'continue' => null,
'from' => null,
'prefix' => null,
'unique' => false,
);
}
- protected function getParamDescription() {
+ public function getParamDescription() {
return array (
'from' => 'The page title to start enumerating from.',
'prefix' => 'Search for all page titles that begin with this value.',
'unique' => 'Only show unique links. Cannot be used with generator or prop=ids',
+ 'prop' => 'What pieces of information to include',
'namespace' => 'The namespace to enumerate.',
- 'limit' => 'How many total links to return.'
+ 'limit' => 'How many total links to return.',
+ 'continue' => 'When more results are available, use this to continue.',
);
}
- protected function getDescription() {
- return 'Enumerate all pages sequentially in a given namespace';
+ public function getDescription() {
+ return 'Enumerate all links that point to a given namespace';
}
protected function getExamples() {