/**
* A query module to enumerate pages that belong to a category.
- *
- * @addtogroup API
+ *
+ * @ingroup API
*/
class ApiQueryCategoryMembers extends ApiQueryGeneratorBase {
$params = $this->extractRequestParams();
- $category = $params['category'];
- if (is_null($category))
- $this->dieUsage("Category parameter is required", 'param_category');
- $categoryTitle = Title::makeTitleSafe( NS_CATEGORY, $category );
- if ( is_null( $categoryTitle ) )
- $this->dieUsage("Category name $category is not valid", 'param_category');
-
- $prop = array_flip($params['prop']);
+ if ( !isset($params['title']) || is_null($params['title']) )
+ $this->dieUsage("The cmtitle parameter is required", 'notitle');
+ $categoryTitle = Title::newFromText($params['title']);
+
+ if ( is_null( $categoryTitle ) || $categoryTitle->getNamespace() != NS_CATEGORY )
+ $this->dieUsage("The category name you entered is not valid", 'invalidcategory');
+
+ $prop = array_flip($params['prop']);
$fld_ids = isset($prop['ids']);
$fld_title = isset($prop['title']);
$fld_sortkey = isset($prop['sortkey']);
+ $fld_timestamp = isset($prop['timestamp']);
if (is_null($resultPageSet)) {
$this->addFields(array('cl_from', 'cl_sortkey', 'page_namespace', 'page_title'));
$this->addFields($resultPageSet->getPageTableFields()); // will include page_ id, ns, title
$this->addFields(array('cl_from', 'cl_sortkey'));
}
-
- $this->addTables(array('page','categorylinks')); // must be in this order for 'USE INDEX'
- $this->addOption('USE INDEX', 'cl_sortkey'); // Not needed after bug 10280 is applied to servers
+
+ $this->addFieldsIf('cl_timestamp', $fld_timestamp || $params['sort'] == 'timestamp');
+ $this->addTables(array('page','categorylinks')); // must be in this order for 'USE INDEX'
+ // Not needed after bug 10280 is applied to servers
+ if($params['sort'] == 'timestamp')
+ $this->addOption('USE INDEX', 'cl_timestamp');
+ else
+ $this->addOption('USE INDEX', 'cl_sortkey');
$this->addWhere('cl_from=page_id');
- $this->setContinuation($params['continue']);
+ $this->setContinuation($params['continue'], $params['dir']);
$this->addWhereFld('cl_to', $categoryTitle->getDBkey());
$this->addWhereFld('page_namespace', $params['namespace']);
- $this->addOption('ORDER BY', "cl_to, cl_sortkey, cl_from");
+ if($params['sort'] == 'timestamp')
+ $this->addWhereRange('cl_timestamp', ($params['dir'] == 'asc' ? 'newer' : 'older'), $params['start'], $params['end']);
+ else
+ {
+ $this->addWhereRange('cl_sortkey', ($params['dir'] == 'asc' ? 'newer' : 'older'), $params['startsortkey'], $params['endsortkey']);
+ $this->addWhereRange('cl_from', ($params['dir'] == 'asc' ? 'newer' : 'older'), null, null);
+ }
$limit = $params['limit'];
$this->addOption('LIMIT', $limit +1);
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('continue', $this->getContinueStr($row, $lastSortKey));
+ if ($params['sort'] == 'timestamp')
+ $this->setContinueEnumParameter('start', wfTimestamp(TS_ISO_8601, $row->cl_timestamp));
+ else
+ $this->setContinueEnumParameter('continue', $this->getContinueStr($row, $lastSortKey));
break;
}
- $lastSortKey = $row->cl_sortkey; // detect duplicate sortkeys
-
+ $lastSortKey = $row->cl_sortkey; // detect duplicate sortkeys
+
if (is_null($resultPageSet)) {
- $title = Title :: makeTitle($row->page_namespace, $row->page_title);
- if ($title->userCanRead()) {
- $vals = array();
- if ($fld_ids)
- $vals['pageid'] = intval($row->page_id);
- if ($fld_title) {
- $vals['ns'] = intval($title->getNamespace());
- $vals['title'] = $title->getPrefixedText();
- }
- if ($fld_sortkey)
- $vals['sortkey'] = $row->cl_sortkey;
- $data[] = $vals;
+ $vals = array();
+ if ($fld_ids)
+ $vals['pageid'] = intval($row->page_id);
+ if ($fld_title) {
+ $title = Title :: makeTitle($row->page_namespace, $row->page_title);
+ $vals['ns'] = intval($title->getNamespace());
+ $vals['title'] = $title->getPrefixedText();
}
+ if ($fld_sortkey)
+ $vals['sortkey'] = $row->cl_sortkey;
+ if ($fld_timestamp)
+ $vals['timestamp'] = wfTimestamp(TS_ISO_8601, $row->cl_timestamp);
+ $data[] = $vals;
} else {
$resultPageSet->processDbRow($row);
}
$this->getResult()->addValue('query', $this->getModuleName(), $data);
}
}
-
+
private function getContinueStr($row, $lastSortKey) {
$ret = $row->cl_sortkey . '|';
if ($row->cl_sortkey == $lastSortKey) // duplicate sort key, add cl_from
$ret .= $row->cl_from;
return $ret;
}
-
+
/**
- * Add DB WHERE clause to continue previous query based on 'continue' parameter
+ * Add DB WHERE clause to continue previous query based on 'continue' parameter
*/
- private function setContinuation($continue) {
+ private function setContinuation($continue, $dir) {
if (is_null($continue))
return; // This is not a continuation request
-
- $continueList = explode('|', $continue);
- $hasError = count($continueList) != 2;
- $from = 0;
- if (!$hasError && strlen($continueList[1]) > 0) {
- $from = intval($continueList[1]);
- $hasError = ($from == 0);
- }
-
- if ($hasError)
+
+ $pos = strrpos($continue, '|');
+ $sortkey = substr($continue, 0, $pos);
+ $fromstr = substr($continue, $pos + 1);
+ $from = intval($fromstr);
+
+ if ($from == 0 && strlen($fromstr) > 0)
$this->dieUsage("Invalid continue param. You should pass the original value returned by the previous query", "badcontinue");
- $sortKey = $this->getDB()->addQuotes($continueList[0]);
+ $encSortKey = $this->getDB()->addQuotes($sortkey);
+ $encFrom = $this->getDB()->addQuotes($from);
+
+ $op = ($dir == 'desc' ? '<' : '>');
if ($from != 0) {
// Duplicate sort key continue
- $this->addWhere( "cl_sortkey>$sortKey OR (cl_sortkey=$sortKey AND cl_from>=$from)" );
+ $this->addWhere( "cl_sortkey$op$encSortKey OR (cl_sortkey=$encSortKey AND cl_from$op=$encFrom)" );
} else {
- $this->addWhere( "cl_sortkey>=$sortKey" );
+ $this->addWhere( "cl_sortkey$op=$encSortKey" );
}
}
- protected function getAllowedParams() {
+ public function getAllowedParams() {
return array (
- 'category' => null,
+ 'title' => null,
'prop' => array (
ApiBase :: PARAM_DFLT => 'ids|title',
- ApiBase :: PARAM_ISMULTI => true,
+ ApiBase :: PARAM_ISMULTI => true,
ApiBase :: PARAM_TYPE => array (
'ids',
'title',
'sortkey',
+ 'timestamp',
)
),
'namespace' => array (
- ApiBase :: PARAM_ISMULTI => true,
+ ApiBase :: PARAM_ISMULTI => true,
ApiBase :: PARAM_TYPE => 'namespace',
),
'continue' => null,
ApiBase :: PARAM_MAX => ApiBase :: LIMIT_BIG1,
ApiBase :: PARAM_MAX2 => ApiBase :: LIMIT_BIG2
),
+ 'sort' => array(
+ ApiBase :: PARAM_DFLT => 'sortkey',
+ ApiBase :: PARAM_TYPE => array(
+ 'sortkey',
+ 'timestamp'
+ )
+ ),
+ 'dir' => array(
+ ApiBase :: PARAM_DFLT => 'asc',
+ ApiBase :: PARAM_TYPE => array(
+ 'asc',
+ 'desc'
+ )
+ ),
+ 'start' => array(
+ ApiBase :: PARAM_TYPE => 'timestamp'
+ ),
+ 'end' => array(
+ ApiBase :: PARAM_TYPE => 'timestamp'
+ ),
+ 'startsortkey' => null,
+ 'endsortkey' => null,
);
}
- protected function getParamDescription() {
+ public function getParamDescription() {
return array (
- 'category' => 'Which category to enumerate (required)',
+ 'title' => 'Which category to enumerate (required). Must include Category: prefix',
'prop' => 'What pieces of information to include',
'namespace' => 'Only include pages in these namespaces',
+ 'sort' => 'Property to sort by',
+ 'dir' => 'In which direction to sort',
+ 'start' => 'Timestamp to start listing from. Can only be used with cmsort=timestamp',
+ 'end' => 'Timestamp to end listing at. Can only be used with cmsort=timestamp',
+ 'startsortkey' => 'Sortkey to start listing from. Can only be used with cmsort=sortkey',
+ 'endsortkey' => 'Sortkey to end listing at. Can only be used with cmsort=sortkey',
'continue' => 'For large categories, give the value retured from previous query',
'limit' => 'The maximum number of pages to return.',
);
}
- protected function getDescription() {
+ public function getDescription() {
return 'List all pages in a given category';
}
protected function getExamples() {
return array (
- "Get first 10 pages in the categories [[Physics]]:",
- " api.php?action=query&list=categorymembers&cmcategory=Physics",
- "Get page info about first 10 pages in the categories [[Physics]]:",
- " api.php?action=query&generator=categorymembers&gcmcategory=Physics&prop=info",
+ "Get first 10 pages in [[Category:Physics]]:",
+ " api.php?action=query&list=categorymembers&cmtitle=Category:Physics",
+ "Get page info about first 10 pages in [[Category:Physics]]:",
+ " api.php?action=query&generator=categorymembers&gcmtitle=Category:Physics&prop=info",
);
}
return __CLASS__ . ': $Id$';
}
}
-
dépôts / lhc / web / wiklou.git / blobdiff