* ignorewarnings fixes
[lhc/web/wiklou.git] / includes / api / ApiQueryCategoryMembers.php
index 23dca81..29adf5a 100644 (file)
@@ -31,7 +31,7 @@ if (!defined('MEDIAWIKI')) {
 /**
  * A query module to enumerate pages that belong to a category.
  *
- * @addtogroup API
+ * @ingroup API
  */
 class ApiQueryCategoryMembers extends ApiQueryGeneratorBase {
 
@@ -76,24 +76,29 @@ class ApiQueryCategoryMembers extends ApiQueryGeneratorBase {
                $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');
-                       // cl_timestamp will be added by addWhereRange() later
-                       $this->addOption('ORDER BY', 'cl_to');
-               }
                else
-               {
-                       $dir = ($params['dir'] == 'desc' ? ' DESC' : '');
                        $this->addOption('USE INDEX', 'cl_sortkey');
-                       $this->addOption('ORDER BY', 'cl_to, cl_sortkey' . $dir . ', cl_from' . $dir);
-               }
 
                $this->addWhere('cl_from=page_id');
                $this->setContinuation($params['continue'], $params['dir']);
                $this->addWhereFld('cl_to', $categoryTitle->getDBkey());
-               $this->addWhereFld('page_namespace', $params['namespace']);
+               # Scanning large datasets for rare categories sucks, and I already told 
+               # how to have efficient subcategory access :-) ~~~~ (oh well, domas)
+               global $wgMiserMode;
+               $miser_ns = array();
+               if ($wgMiserMode) { 
+                       $miser_ns = $params['namespace'];
+               } else {
+                       $this->addWhereFld('page_namespace', $params['namespace']);
+               }
                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);
@@ -115,7 +120,12 @@ class ApiQueryCategoryMembers extends ApiQueryGeneratorBase {
                                break;
                        }
 
-                       $lastSortKey = $row->cl_sortkey;        // detect duplicate sortkeys
+                       // Since domas won't tell anyone what he told long ago, apply 
+                       // cmnamespace here. This means the query may return 0 actual 
+                       // results, but on the other hand it could save returning 5000 
+                       // useless results to the client. ~~~~
+                       if (count($miser_ns) && !in_array($row->page_namespace, $miser_ns))
+                               continue;
 
                        if (is_null($resultPageSet)) {
                                $vals = array();
@@ -123,23 +133,32 @@ class ApiQueryCategoryMembers extends ApiQueryGeneratorBase {
                                        $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();
+                                       ApiQueryBase::addTitleInfo($vals, $title);
                                }
                                if ($fld_sortkey)
                                        $vals['sortkey'] = $row->cl_sortkey;
                                if ($fld_timestamp)
                                        $vals['timestamp'] = wfTimestamp(TS_ISO_8601, $row->cl_timestamp);
-                               $data[] = $vals;
+                               $fit = $this->getResult()->addValue(array('query', $this->getModuleName()),
+                                               null, $vals);
+                               if(!$fit)
+                               {
+                                       if ($params['sort'] == 'timestamp')
+                                               $this->setContinueEnumParameter('start', wfTimestamp(TS_ISO_8601, $row->cl_timestamp));
+                                       else
+                                               $this->setContinueEnumParameter('continue', $this->getContinueStr($row, $lastSortKey));
+                                       break;
+                               }
                        } else {
                                $resultPageSet->processDbRow($row);
                        }
+                       $lastSortKey = $row->cl_sortkey;        // detect duplicate sortkeys
                }
                $db->freeResult($res);
 
                if (is_null($resultPageSet)) {
-                       $this->getResult()->setIndexedTagName($data, 'cm');
-                       $this->getResult()->addValue('query', $this->getModuleName(), $data);
+                       $this->getResult()->setIndexedTagName_internal(
+                                        array('query', $this->getModuleName()), 'cm');
                }
        }
 
@@ -157,18 +176,15 @@ class ApiQueryCategoryMembers extends ApiQueryGeneratorBase {
                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);
-               }
+               $pos = strrpos($continue, '|');
+               $sortkey = substr($continue, 0, $pos);
+               $fromstr = substr($continue, $pos + 1);
+               $from = intval($fromstr);
 
-               if ($hasError)
+               if ($from == 0 && strlen($fromstr) > 0)
                        $this->dieUsage("Invalid continue param. You should pass the original value returned by the previous query", "badcontinue");
 
-               $encSortKey = $this->getDB()->addQuotes($continueList[0]);
+               $encSortKey = $this->getDB()->addQuotes($sortkey);
                $encFrom = $this->getDB()->addQuotes($from);
                
                $op = ($dir == 'desc' ? '<' : '>');
@@ -225,12 +241,15 @@ class ApiQueryCategoryMembers extends ApiQueryGeneratorBase {
                        ),
                        'end' => array(
                                ApiBase :: PARAM_TYPE => 'timestamp'
-                       )
+                       ),
+                       'startsortkey' => null,
+                       'endsortkey' => null,
                );
        }
 
        public function getParamDescription() {
-               return array (
+               global $wgMiserMode;
+               $desc = array (
                        'title' => 'Which category to enumerate (required). Must include Category: prefix',
                        'prop' => 'What pieces of information to include',
                        'namespace' => 'Only include pages in these namespaces',
@@ -238,9 +257,19 @@ class ApiQueryCategoryMembers extends ApiQueryGeneratorBase {
                        '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.',
                );
+               if ($wgMiserMode) {
+                       $desc['namespace'] = array(
+                               $desc['namespace'],
+                               'NOTE: Due to $wgMiserMode, using this may result in fewer than "limit" results',
+                               'returned before continuing; in extreme cases, zero results may be returned.',
+                       );
+               }
+               return $desc;
        }
 
        public function getDescription() {