includes/api/ApiOpenSearch.php

   1 <?php
   2
   3 /*
   4  * Created on Oct 13, 2006
   5  *
   6  * API for MediaWiki 1.8+
   7  *
   8  * Copyright (C) 2006 Yuri Astrakhan <Firstname><Lastname>@gmail.com
   9  *
  10  * This program is free software; you can redistribute it and/or modify
  11  * it under the terms of the GNU General Public License as published by
  12  * the Free Software Foundation; either version 2 of the License, or
  13  * (at your option) any later version.
  14  *
  15  * This program is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  18  * GNU General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU General Public License along
  21  * with this program; if not, write to the Free Software Foundation, Inc.,
  22  * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  23  * http://www.gnu.org/copyleft/gpl.html
  24  */
  25
  26 if ( !defined( 'MEDIAWIKI' ) ) {
  27         // Eclipse helper - will be ignored in production
  28         require_once ( "ApiBase.php" );
  29 }
  30
  31 /**
  32  * @ingroup API
  33  */
  34 class ApiOpenSearch extends ApiBase {
  35
  36         public function __construct( $main, $action ) {
  37                 parent :: __construct( $main, $action );
  38         }
  39
  40         public function getCustomPrinter() {
  41                 return $this->getMain()->createPrinterByName( 'json' );
  42         }
  43
  44         public function execute() {
  45                 global $wgEnableOpenSearchSuggest, $wgSearchSuggestCacheExpiry;
  46                 $params = $this->extractRequestParams();
  47                 $search = $params['search'];
  48                 $limit = $params['limit'];
  49                 $namespaces = $params['namespace'];
  50                 $suggest = $params['suggest'];
  51
  52                 // MWSuggest or similar hit
  53                 if ( $suggest && !$wgEnableOpenSearchSuggest )
  54                         $srchres = array();
  55                 else {
  56                         // Open search results may be stored for a very long
  57                         // time
  58                         $this->getMain()->setCacheMaxAge( $wgSearchSuggestCacheExpiry );
  59                         $this->getMain()->setCacheControl( array( 'must-revalidate' => false ) );
  60
  61                         $srchres = PrefixSearch::titleSearch( $search, $limit,
  62                                 $namespaces );
  63                 }
  64                 // Set top level elements
  65                 $result = $this->getResult();
  66                 $result->addValue( null, 0, $search );
  67                 $result->addValue( null, 1, $srchres );
  68         }
  69
  70         public function getAllowedParams() {
  71                 return array (
  72                         'search' => null,
  73                         'limit' => array(
  74                                 ApiBase :: PARAM_DFLT => 10,
  75                                 ApiBase :: PARAM_TYPE => 'limit',
  76                                 ApiBase :: PARAM_MIN => 1,
  77                                 ApiBase :: PARAM_MAX => 100,
  78                                 ApiBase :: PARAM_MAX2 => 100
  79                         ),
  80                         'namespace' => array(
  81                                 ApiBase :: PARAM_DFLT => NS_MAIN,
  82                                 ApiBase :: PARAM_TYPE => 'namespace',
  83                                 ApiBase :: PARAM_ISMULTI => true
  84                         ),
  85                         'suggest' => false,
  86                 );
  87         }
  88
  89         public function getParamDescription() {
  90                 return array (
  91                         'search' => 'Search string',
  92                         'limit' => 'Maximum amount of results to return',
  93                         'namespace' => 'Namespaces to search',
  94                         'suggest' => 'Do nothing if $wgEnableOpenSearchSuggest is false',
  95                 );
  96         }
  97
  98         public function getDescription() {
  99                 return 'This module implements OpenSearch protocol';
 100         }
 101
 102         protected function getExamples() {
 103                 return array (
 104                         'api.php?action=opensearch&search=Te'
 105                 );
 106         }
 107
 108         public function getVersion() {
 109                 return __CLASS__ . ': $Id$';
 110         }
 111 }