]> scripts.mit.edu Git - autoinstallsdev/mediawiki.git/blobdiff - includes/api/ApiQueryExtLinksUsage.php
MediaWiki 1.16.0
[autoinstallsdev/mediawiki.git] / includes / api / ApiQueryExtLinksUsage.php
index 0ba2767af1c957d9ee4e732863dddc08a589f5c0..0e171e440839a9a3dd2b1394a926e2fa267e97b5 100644 (file)
@@ -23,9 +23,9 @@
  * http://www.gnu.org/copyleft/gpl.html
  */
 
-if (!defined('MEDIAWIKI')) {
+if ( !defined( 'MEDIAWIKI' ) ) {
        // Eclipse helper - will be ignored in production
-       require_once ('ApiQueryBase.php');
+       require_once ( 'ApiQueryBase.php' );
 }
 
 /**
@@ -33,19 +33,23 @@ if (!defined('MEDIAWIKI')) {
  */
 class ApiQueryExtLinksUsage extends ApiQueryGeneratorBase {
 
-       public function __construct($query, $moduleName) {
-               parent :: __construct($query, $moduleName, 'eu');
+       public function __construct( $query, $moduleName ) {
+               parent :: __construct( $query, $moduleName, 'eu' );
        }
 
        public function execute() {
                $this->run();
        }
 
-       public function executeGenerator($resultPageSet) {
-               $this->run($resultPageSet);
+       public function getCacheMode( $params ) {
+               return 'public';
        }
 
-       private function run($resultPageSet = null) {
+       public function executeGenerator( $resultPageSet ) {
+               $this->run( $resultPageSet );
+       }
+
+       private function run( $resultPageSet = null ) {
 
                $params = $this->extractRequestParams();
 
@@ -54,10 +58,10 @@ class ApiQueryExtLinksUsage extends ApiQueryGeneratorBase {
 
                // Find the right prefix
                global $wgUrlProtocols;
-               if($protocol && !in_array($protocol, $wgUrlProtocols))
+               if ( $protocol && !in_array( $protocol, $wgUrlProtocols ) )
                {
-                       foreach ($wgUrlProtocols as $p) {
-                               if( substr( $p, 0, strlen( $protocol ) ) === $protocol ) {
+                       foreach ( $wgUrlProtocols as $p ) {
+                               if ( substr( $p, 0, strlen( $protocol ) ) === $protocol ) {
                                        $protocol = $p;
                                        break;
                                }
@@ -67,91 +71,92 @@ class ApiQueryExtLinksUsage extends ApiQueryGeneratorBase {
                        $protocol = null;
 
                $db = $this->getDB();
-               $this->addTables(array('page','externallinks'));        // must be in this order for 'USE INDEX'
-               $this->addOption('USE INDEX', 'el_index');
-               $this->addWhere('page_id=el_from');
-               $this->addWhereFld('page_namespace', $params['namespace']);
+               $this->addTables( array( 'page', 'externallinks' ) );   // must be in this order for 'USE INDEX'
+               $this->addOption( 'USE INDEX', 'el_index' );
+               $this->addWhere( 'page_id=el_from' );
+               $this->addWhereFld( 'page_namespace', $params['namespace'] );
 
-               if(!is_null($query) || $query != '')
+               if ( !is_null( $query ) || $query != '' )
                {
-                       if(is_null($protocol))
+                       if ( is_null( $protocol ) )
                                $protocol = 'http://';
 
-                       $likeQuery = LinkFilter::makeLike($query, $protocol);
-                       if (!$likeQuery)
-                               $this->dieUsage('Invalid query', 'bad_query');
-                       $likeQuery = substr($likeQuery, 0, strpos($likeQuery,'%')+1);
-                       $this->addWhere('el_index LIKE ' . $db->addQuotes( $likeQuery ));
+                       $likeQuery = LinkFilter::makeLikeArray( $query, $protocol );
+                       if ( !$likeQuery )
+                               $this->dieUsage( 'Invalid query', 'bad_query' );
+
+                       $likeQuery = LinkFilter::keepOneWildcard( $likeQuery );
+                       $this->addWhere( 'el_index ' . $db->buildLike( $likeQuery ) );
                }
-               else if(!is_null($protocol))
-                       $this->addWhere('el_index LIKE ' . $db->addQuotes( "$protocol%" ));
+               else if ( !is_null( $protocol ) )
+                       $this->addWhere( 'el_index ' . $db->buildLike( "$protocol", $db->anyString() ) );
 
-               $prop = array_flip($params['prop']);
-               $fld_ids = isset($prop['ids']);
-               $fld_title = isset($prop['title']);
-               $fld_url = isset($prop['url']);
+               $prop = array_flip( $params['prop'] );
+               $fld_ids = isset( $prop['ids'] );
+               $fld_title = isset( $prop['title'] );
+               $fld_url = isset( $prop['url'] );
 
-               if (is_null($resultPageSet)) {
-                       $this->addFields(array (
+               if ( is_null( $resultPageSet ) ) {
+                       $this->addFields( array (
                                'page_id',
                                'page_namespace',
                                'page_title'
-                       ));
-                       $this->addFieldsIf('el_to', $fld_url);
+                       ) );
+                       $this->addFieldsIf( 'el_to', $fld_url );
                } else {
-                       $this->addFields($resultPageSet->getPageTableFields());
+                       $this->addFields( $resultPageSet->getPageTableFields() );
                }
 
                $limit = $params['limit'];
                $offset = $params['offset'];
-               $this->addOption('LIMIT', $limit +1);
-               if (isset ($offset))
-                       $this->addOption('OFFSET', $offset);
+               $this->addOption( 'LIMIT', $limit + 1 );
+               if ( isset ( $offset ) )
+                       $this->addOption( 'OFFSET', $offset );
 
-               $res = $this->select(__METHOD__);
+               $res = $this->select( __METHOD__ );
 
                $result = $this->getResult();
                $count = 0;
-               while ($row = $db->fetchObject($res)) {
-                       if (++ $count > $limit) {
+               while ( $row = $db->fetchObject( $res ) ) {
+                       if ( ++ $count > $limit ) {
                                // We've reached the one extra which shows that there are additional pages to be had. Stop here...
-                               $this->setContinueEnumParameter('offset', $offset+$limit);
+                               $this->setContinueEnumParameter( 'offset', $offset + $limit );
                                break;
                        }
 
-                       if (is_null($resultPageSet)) {
+                       if ( is_null( $resultPageSet ) ) {
                                $vals = array();
-                               if ($fld_ids)
-                                       $vals['pageid'] = intval($row->page_id);
-                               if ($fld_title) {
-                                       $title = Title :: makeTitle($row->page_namespace, $row->page_title);
-                                       ApiQueryBase::addTitleInfo($vals, $title);
+                               if ( $fld_ids )
+                                       $vals['pageid'] = intval( $row->page_id );
+                               if ( $fld_title ) {
+                                       $title = Title :: makeTitle( $row->page_namespace, $row->page_title );
+                                       ApiQueryBase::addTitleInfo( $vals, $title );
                                }
-                               if ($fld_url)
+                               if ( $fld_url )
                                        $vals['url'] = $row->el_to;
-                               $fit = $result->addValue(array('query', $this->getModuleName()), null, $vals);
-                               if(!$fit)
+                               $fit = $result->addValue( array( 'query', $this->getModuleName() ), null, $vals );
+                               if ( !$fit )
                                {
-                                       $this->setContinueEnumParameter('offset', $offset + $count - 1);
+                                       $this->setContinueEnumParameter( 'offset', $offset + $count - 1 );
                                        break;
                                }
                        } else {
-                               $resultPageSet->processDbRow($row);
+                               $resultPageSet->processDbRow( $row );
                        }
                }
-               $db->freeResult($res);
+               $db->freeResult( $res );
 
-               if (is_null($resultPageSet)) {
-                       $result->setIndexedTagName_internal(array('query', $this->getModuleName()),
-                                       $this->getModulePrefix());
+               if ( is_null( $resultPageSet ) ) {
+                       $result->setIndexedTagName_internal( array( 'query', $this->getModuleName() ),
+                                       $this->getModulePrefix() );
                }
        }
 
        public function getAllowedParams() {
                global $wgUrlProtocols;
-               $protocols = array('');
-               foreach ($wgUrlProtocols as $p) {
-                       $protocols[] = substr($p, 0, strpos($p,':'));
+               $protocols = array( '' );
+               foreach ( $wgUrlProtocols as $p ) {
+                       $protocols[] = substr( $p, 0, strpos( $p, ':' ) );
                }
 
                return array (
@@ -191,7 +196,7 @@ class ApiQueryExtLinksUsage extends ApiQueryGeneratorBase {
                        'prop' => 'What pieces of information to include',
                        'offset' => 'Used for paging. Use the value returned for "continue"',
                        'protocol' => array(    'Protocol of the url. If empty and euquery set, the protocol is http.',
-                                               'Leave both this and euquery empty to list all external links'),
+                                               'Leave both this and euquery empty to list all external links' ),
                        'query' => 'Search string without protocol. See [[Special:LinkSearch]]. Leave empty to list all external links',
                        'namespace' => 'The page namespace(s) to enumerate.',
                        'limit' => 'How many pages to return.'
@@ -201,6 +206,12 @@ class ApiQueryExtLinksUsage extends ApiQueryGeneratorBase {
        public function getDescription() {
                return 'Enumerate pages that contain a given URL';
        }
+       
+       public function getPossibleErrors() {
+               return array_merge( parent::getPossibleErrors(), array(
+                       array( 'code' => 'bad_query', 'info' => 'Invalid query' ),
+               ) );
+       }
 
        protected function getExamples() {
                return array (
@@ -209,6 +220,6 @@ class ApiQueryExtLinksUsage extends ApiQueryGeneratorBase {
        }
 
        public function getVersion() {
-               return __CLASS__ . ': $Id: ApiQueryExtLinksUsage.php 47865 2009-02-27 16:03:01Z catrope $';
+               return __CLASS__ . ': $Id: ApiQueryExtLinksUsage.php 69932 2010-07-26 08:03:21Z tstarling $';
        }
-}
\ No newline at end of file
+}