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                 $params = $this->extractRequestParams();
  46                 $search = $params['search'];
  47                 $limit = $params['limit'];
  48                 $namespaces = $params['namespace'];
  49
  50                 // Open search results may be stored for a very long time
  51                 $this->getMain()->setCacheMaxAge(1200);
  52
  53                 $srchres = PrefixSearch::titleSearch( $search, $limit, $namespaces );
  54
  55                 if( $params['redirects'] ) {
  56                         foreach( $srchres as &$t ) {
  57                                 $title = Title::newFromText( $t );
  58                                 if( is_null( $title ) ) {
  59                                         continue;
  60                                 }
  61                                 $article = new Article( $title );
  62                                 $redirTitle = $article->getRedirectTarget();
  63                                 if( !is_null( $redirTitle ) ) {
  64                                         $t = $redirTitle->getPrefixedText();
  65                                 }
  66                         }
  67                 }
  68
  69                 // Set top level elements
  70                 $result = $this->getResult();
  71                 $result->addValue(null, 0, $search);
  72                 $result->addValue(null, 1, $srchres);
  73         }
  74
  75         public function getAllowedParams() {
  76                 return array (
  77                         'search' => null,
  78                         'limit' => array (
  79                                 ApiBase :: PARAM_DFLT => 10,
  80                                 ApiBase :: PARAM_TYPE => 'limit',
  81                                 ApiBase :: PARAM_MIN => 1,
  82                                 ApiBase :: PARAM_MAX => 100,
  83                                 ApiBase :: PARAM_MAX2 => 100
  84                         ),
  85                         'namespace' => array(
  86                                 ApiBase :: PARAM_DFLT => NS_MAIN,
  87                                 ApiBase :: PARAM_TYPE => 'namespace',
  88                                 ApiBase :: PARAM_ISMULTI => true
  89                         ),
  90                         'redirects' => false,
  91                 );
  92         }
  93
  94         public function getParamDescription() {
  95                 return array (
  96                         'search' => 'Search string',
  97                         'limit' => 'Maximum amount of results to return',
  98                         'namespace' => 'Namespaces to search',
  99                         'redirects' => 'Resolve redirects',
 100                 );
 101         }
 102
 103         public function getDescription() {
 104                 return 'This module implements OpenSearch protocol';
 105         }
 106
 107         protected function getExamples() {
 108                 return array (
 109                         'api.php?action=opensearch&search=Te'
 110                 );
 111         }
 112
 113         public function getVersion() {
 114                 return __CLASS__ . ': $Id$';
 115         }
 116 }