Allow extensions to abort (and replace) email notifications
[lhc/web/wiklou.git] / includes / api / ApiQueryLinks.php
index 8090daf..5cf9068 100644 (file)
  * @file
  */
 
-if ( !defined( 'MEDIAWIKI' ) ) {
-       // Eclipse helper - will be ignored in production
-       require_once( "ApiQueryBase.php" );
-}
-
 /**
  * A query module to list all wiki links on a given set of pages.
  *
@@ -48,14 +43,16 @@ class ApiQueryLinks extends ApiQueryGeneratorBase {
                                $this->prefix = 'pl';
                                $this->description = 'link';
                                $this->titlesParam = 'titles';
-                               $this->helpUrl = 'http://www.mediawiki.org/wiki/API:Properties#links_.2F_pl';
+                               $this->titlesParamDescription = 'Only list links to these titles. Useful for checking whether a certain page links to a certain title.';
+                               $this->helpUrl = 'https://www.mediawiki.org/wiki/API:Properties#links_.2F_pl';
                                break;
                        case self::TEMPLATES:
                                $this->table = 'templatelinks';
                                $this->prefix = 'tl';
                                $this->description = 'template';
                                $this->titlesParam = 'templates';
-                               $this->helpUrl = 'http://www.mediawiki.org/wiki/API:Properties#templates_.2F_tl';
+                               $this->titlesParamDescription = 'Only list these templates. Useful for checking whether a certain page uses a certain template.';
+                               $this->helpUrl = 'https://www.mediawiki.org/wiki/API:Properties#templates_.2F_tl';
                                break;
                        default:
                                ApiBase::dieDebug( __METHOD__, 'Unknown module name' );
@@ -102,7 +99,7 @@ class ApiQueryLinks extends ApiQueryGeneratorBase {
                        foreach ( $params[$this->titlesParam] as $t ) {
                                $title = Title::newFromText( $t );
                                if ( !$title ) {
-                                       $this->setWarning( "``$t'' is not a valid title" );
+                                       $this->setWarning( "\"$t\" is not a valid title" );
                                } else {
                                        $lb->addObj( $title );
                                }
@@ -119,18 +116,20 @@ class ApiQueryLinks extends ApiQueryGeneratorBase {
                                $this->dieUsage( 'Invalid continue param. You should pass the ' .
                                        'original value returned by the previous query', '_badcontinue' );
                        }
+                       $op = $params['dir'] == 'descending' ? '<' : '>';
                        $plfrom = intval( $cont[0] );
                        $plns = intval( $cont[1] );
-                       $pltitle = $this->getDB()->strencode( $this->titleToKey( $cont[2] ) );
+                       $pltitle = $this->getDB()->addQuotes( $this->titleToKey( $cont[2] ) );
                        $this->addWhere(
-                               "{$this->prefix}_from > $plfrom OR " .
+                               "{$this->prefix}_from $op $plfrom OR " .
                                "({$this->prefix}_from = $plfrom AND " .
-                               "({$this->prefix}_namespace > $plns OR " .
+                               "({$this->prefix}_namespace $op $plns OR " .
                                "({$this->prefix}_namespace = $plns AND " .
-                               "{$this->prefix}_title >= '$pltitle')))"
+                               "{$this->prefix}_title $op= $pltitle)))"
                        );
                }
 
+               $sort = ( $params['dir'] == 'descending' ? ' DESC' : '' );
                // Here's some MySQL craziness going on: if you use WHERE foo='bar'
                // and later ORDER BY foo MySQL doesn't notice the ORDER BY is pointless
                // but instead goes and filesorts, because the index for foo was used
@@ -138,15 +137,15 @@ class ApiQueryLinks extends ApiQueryGeneratorBase {
                // clause from the ORDER BY clause
                $order = array();
                if ( count( $this->getPageSet()->getGoodTitles() ) != 1 ) {
-                       $order[] = "{$this->prefix}_from";
+                       $order[] = $this->prefix . '_from' . $sort;
                }
                if ( count( $params['namespace'] ) != 1 ) {
-                       $order[] = "{$this->prefix}_namespace";
+                       $order[] = $this->prefix . '_namespace' . $sort;
                }
 
-               $order[] = "{$this->prefix}_title";
-               $this->addOption( 'ORDER BY', implode( ', ', $order ) );
-               $this->addOption( 'USE INDEX', "{$this->prefix}_from" );
+               $order[] = $this->prefix . '_title' . $sort;
+               $this->addOption( 'ORDER BY', $order );
+               $this->addOption( 'USE INDEX', $this->prefix . '_from' );
                $this->addOption( 'LIMIT', $params['limit'] + 1 );
 
                $res = $this->select( __METHOD__ );
@@ -207,22 +206,34 @@ class ApiQueryLinks extends ApiQueryGeneratorBase {
                        $this->titlesParam => array(
                                ApiBase::PARAM_ISMULTI => true,
                        ),
+                       'dir' => array(
+                               ApiBase::PARAM_DFLT => 'ascending',
+                               ApiBase::PARAM_TYPE => array(
+                                       'ascending',
+                                       'descending'
+                               )
+                       ),
                );
        }
 
        public function getParamDescription() {
                $desc = $this->description;
-               $arr = array(
+               return array(
                        'namespace' => "Show {$desc}s in this namespace(s) only",
                        'limit' => "How many {$desc}s to return",
                        'continue' => 'When more results are available, use this to continue',
+                       $this->titlesParam => $this->titlesParamDescription,
+                       'dir' => 'The direction in which to list',
+               );
+       }
+
+       public function getResultProperties() {
+               return array(
+                       '' => array(
+                               'ns' => 'namespace',
+                               'title' => 'string'
+                       )
                );
-               if ( $this->getModuleName() == self::LINKS ) {
-                       $arr[$this->titlesParam] = 'Only list links to these titles. Useful for checking whether a certain page links to a certain title.';
-               } elseif ( $this->getModuleName() == self::TEMPLATES ) {
-                       $arr[$this->titlesParam] = 'Only list these templates. Useful for checking whether a certain page uses a certain template.';
-               }
-               return $arr;
        }
 
        public function getDescription() {
@@ -230,13 +241,12 @@ class ApiQueryLinks extends ApiQueryGeneratorBase {
        }
 
        public function getExamples() {
+               $desc = $this->description;
+               $name = $this->getModuleName();
                return array(
-                       "Get {$this->description}s from the [[Main Page]]:",
-                       "  api.php?action=query&prop={$this->getModuleName()}&titles=Main%20Page",
-                       "Get information about the {$this->description} pages in the [[Main Page]]:",
-                       "  api.php?action=query&generator={$this->getModuleName()}&titles=Main%20Page&prop=info",
-                       "Get {$this->description}s from the Main Page in the User and Template namespaces:",
-                       "  api.php?action=query&prop={$this->getModuleName()}&titles=Main%20Page&{$this->prefix}namespace=2|10"
+                       "api.php?action=query&prop={$name}&titles=Main%20Page" => "Get {$desc}s from the [[Main Page]]:",
+                       "api.php?action=query&generator={$name}&titles=Main%20Page&prop=info" => "Get information about the {$desc} pages in the [[Main Page]]:",
+                       "api.php?action=query&prop={$name}&titles=Main%20Page&{$this->prefix}namespace=2|10" => "Get {$desc}s from the Main Page in the User and Template namespaces:",
                );
        }