Followup r81583, break some of the long lines and centralize the regex.

[lhc/web/wiklou.git] / includes / api / ApiQueryAllLinks.php

diff --git a/includes/api/ApiQueryAllLinks.php b/includes/api/ApiQueryAllLinks.php
index cf6d2ab..1c32050 100644 (file)
--- a/includes/api/ApiQueryAllLinks.php
+++ b/includes/api/ApiQueryAllLinks.php
@@ -1,9 +1,8 @@
 <?php
-
 /**
- * Created on July 7, 2007
  *
- * API for MediaWiki 1.8+
+ *
+ * Created on July 7, 2007
  *
  * Copyright © 2006 Yuri Astrakhan <Firstname><Lastname>@gmail.com
  *
@@ -19,8 +18,10 @@
  *
  * You should have received a copy of the GNU General Public License along
  * with this program; if not, write to the Free Software Foundation, Inc.,
- * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  * http://www.gnu.org/copyleft/gpl.html
+ *
+ * @file
  */
 
 if ( !defined( 'MEDIAWIKI' ) ) {
@@ -43,6 +44,10 @@ class ApiQueryAllLinks extends ApiQueryGeneratorBase {
                $this->run();
        }
 
+       public function getCacheMode( $params ) {
+               return 'public';
+       }
+
        public function executeGenerator( $resultPageSet ) {
                $this->run( $resultPageSet );
        }
@@ -88,6 +93,9 @@ class ApiQueryAllLinks extends ApiQueryGeneratorBase {
                if ( !is_null( $params['from'] ) ) {
                        $this->addWhere( 'pl_title>=' . $db->addQuotes( $this->titlePartToKey( $params['from'] ) ) );
                }
+               if ( !is_null( $params['to'] ) ) {
+                       $this->addWhere( 'pl_title<=' . $db->addQuotes( $this->titlePartToKey( $params['to'] ) ) );
+               }
                if ( isset( $params['prefix'] ) ) {
                        $this->addWhere( 'pl_title' . $db->buildLike( $this->titlePartToKey( $params['prefix'] ), $db->anyString() ) );
                }
@@ -111,7 +119,7 @@ class ApiQueryAllLinks extends ApiQueryGeneratorBase {
                $pageids = array();
                $count = 0;
                $result = $this->getResult();
-               while ( $row = $db->fetchObject( $res ) ) {
+               foreach ( $res as $row ) {
                        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
@@ -145,7 +153,6 @@ class ApiQueryAllLinks extends ApiQueryGeneratorBase {
                                $pageids[] = $row->pl_from;
                        }
                }
-               $db->freeResult( $res );
 
                if ( is_null( $resultPageSet ) ) {
                        $result->setIndexedTagName_internal( array( 'query', $this->getModuleName() ), 'l' );
@@ -158,6 +165,7 @@ class ApiQueryAllLinks extends ApiQueryGeneratorBase {
                return array(
                        'continue' => null,
                        'from' => null,
+                       'to' => null,
                        'prefix' => null,
                        'unique' => false,
                        'prop' => array(
@@ -183,11 +191,17 @@ class ApiQueryAllLinks extends ApiQueryGeneratorBase {
        }
 
        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 {$this->getModulePrefix()}prop=ids",
-                       'prop' => 'What pieces of information to include',
+                       'unique' => "Only show unique links. Cannot be used with generator or {$p}prop=ids",
+                       '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',
+                       ),
                        'namespace' => 'The namespace to enumerate',
                        'limit' => 'How many total links to return',
                        'continue' => 'When more results are available, use this to continue',
@@ -199,9 +213,10 @@ class ApiQueryAllLinks extends ApiQueryGeneratorBase {
        }
 
        public function getPossibleErrors() {
+               $m = $this->getModuleName();
                return array_merge( parent::getPossibleErrors(), array(
-                       array( 'code' => 'params', 'info' => $this->getModuleName() . ' cannot be used as a generator in unique links mode' ),
-                       array( 'code' => 'params', 'info' => $this->getModuleName() . ' cannot return corresponding page ids in unique links mode' ),
+                       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' ),
                ) );
@@ -209,11 +224,11 @@ class ApiQueryAllLinks extends ApiQueryGeneratorBase {
 
        protected function getExamples() {
                return array(
-                       'api.php?action=query&list=alllinks&alunique&alfrom=B',
+                       'api.php?action=query&list=alllinks&alunique=&alfrom=B',
                );
        }
 
        public function getVersion() {
                return __CLASS__ . ': $Id$';
        }
-}
\ No newline at end of file
+}