* (bug 27479) API error when using both prop=pageprops and prop=info&inprop=displaytitle
[lhc/web/wiklou.git] / includes / api / ApiQueryIWLinks.php
index 5136405..6244793 100644 (file)
@@ -1,10 +1,9 @@
 <?php
-
 /**
- * Created on May 14, 2010
- *
  * API for MediaWiki 1.17+
  *
+ * Created on May 14, 2010
+ *
  * Copyright © 2010 Sam Reed
  * Copyright © 2006 Yuri Astrakhan <Firstname><Lastname>@gmail.com
  *
  *
  * 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' ) ) {
@@ -46,6 +47,11 @@ class ApiQueryIWLinks extends ApiQueryBase {
                }
 
                $params = $this->extractRequestParams();
+
+               if ( isset( $params['title'] ) && !isset( $params['prefix'] ) ) {
+                       $this->dieUsageMsg( array( 'missingparam', 'prefix' ) );
+               }
+
                $this->addFields( array(
                        'iwl_from',
                        'iwl_prefix',
@@ -54,6 +60,7 @@ class ApiQueryIWLinks extends ApiQueryBase {
 
                $this->addTables( 'iwlinks' );
                $this->addWhereFld( 'iwl_from', array_keys( $this->getPageSet()->getGoodTitles() ) );
+
                if ( !is_null( $params['continue'] ) ) {
                        $cont = explode( '|', $params['continue'] );
                        if ( count( $cont ) != 3 ) {
@@ -72,18 +79,28 @@ class ApiQueryIWLinks extends ApiQueryBase {
                        );
                }
 
-               // Don't order by iwl_from if it's constant in the WHERE clause
-               if ( count( $this->getPageSet()->getGoodTitles() ) == 1 ) {
-                       $this->addOption( 'ORDER BY', 'iwl_prefix' );
+               if ( isset( $params['prefix'] ) ) {
+                       $this->addWhereFld( 'iwl_prefix', $params['prefix'] );
+                       if ( isset( $params['title'] ) ) {
+                               $this->addWhereFld( 'iwl_title', $params['title'] );
+                               $this->addOption( 'ORDER BY', 'iwl_from' );
+                       } else {
+                               $this->addOption( 'ORDER BY', 'iwl_title, iwl_from' );
+                       }
                } else {
-                       $this->addOption( 'ORDER BY', 'iwl_from, iwl_prefix' );
+                       // Don't order by iwl_from if it's constant in the WHERE clause
+                       if ( count( $this->getPageSet()->getGoodTitles() ) == 1 ) {
+                               $this->addOption( 'ORDER BY', 'iwl_prefix' );
+                       } else {
+                               $this->addOption( 'ORDER BY', 'iwl_from, iwl_prefix' );
+                       }
                }
+
                $this->addOption( 'LIMIT', $params['limit'] + 1 );
                $res = $this->select( __METHOD__ );
 
                $count = 0;
-               $db = $this->getDB();
-               while ( $row = $db->fetchObject( $res ) ) {
+               foreach ( $res as $row ) {
                        if ( ++$count > $params['limit'] ) {
                                // We've reached the one extra which shows that
                                // there are additional pages to be had. Stop here...
@@ -91,6 +108,14 @@ class ApiQueryIWLinks extends ApiQueryBase {
                                break;
                        }
                        $entry = array( 'prefix' => $row->iwl_prefix );
+
+                       if ( !is_null( $params['url'] ) ) {
+                               $title = Title::newFromText( "{$row->iwl_prefix}:{$row->iwl_title}" );
+                               if ( $title ) {
+                                       $entry['url'] = $title->getFullURL();
+                               }
+                       }
+
                        ApiResult::setContent( $entry, $row->iwl_title );
                        $fit = $this->addPageSubItem( $row->iwl_from, $entry );
                        if ( !$fit ) {
@@ -98,11 +123,15 @@ class ApiQueryIWLinks extends ApiQueryBase {
                                break;
                        }
                }
-               $db->freeResult( $res );
+       }
+
+       public function getCacheMode( $params ) {
+               return 'public';
        }
 
        public function getAllowedParams() {
                return array(
+                       'url' => null,
                        'limit' => array(
                                ApiBase::PARAM_DFLT => 10,
                                ApiBase::PARAM_TYPE => 'limit',
@@ -111,13 +140,18 @@ class ApiQueryIWLinks extends ApiQueryBase {
                                ApiBase::PARAM_MAX2 => ApiBase::LIMIT_BIG2
                        ),
                        'continue' => null,
+                       'prefix' => null,
+                       'title' => null,
                );
        }
 
        public function getParamDescription() {
                return array(
+                       'url' => 'Whether to get the full URL',
                        'limit' => 'How many interwiki links to return',
                        'continue' => 'When more results are available, use this to continue',
+                       'prefix' => 'Prefix for the interwiki',
+                       'title' => "Interwiki link to search for. Must be used with {$this->getModulePrefix()}prefix",
                );
        }
 
@@ -127,6 +161,7 @@ class ApiQueryIWLinks extends ApiQueryBase {
 
        public function getPossibleErrors() {
                return array_merge( parent::getPossibleErrors(), array(
+                       array( 'missingparam', 'prefix' ),
                        array( 'code' => '_badcontinue', 'info' => 'Invalid continue param. You should pass the original value returned by the previous query' ),
                ) );
        }
@@ -134,11 +169,11 @@ class ApiQueryIWLinks extends ApiQueryBase {
        protected function getExamples() {
                return array(
                        'Get interwiki links from the [[Main Page]]:',
-                       '  api.php?action=query&prop=iwlinks&titles=Main%20Page&redirects',
+                       '  api.php?action=query&prop=iwlinks&titles=Main%20Page',
                );
        }
 
        public function getVersion() {
                return __CLASS__ . ': $Id$';
        }
-}
\ No newline at end of file
+}