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  * @addtogroup 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
  48                 // Open search results may be stored for a very long time
  49                 $this->getMain()->setCacheMaxAge(1200);
  50
  51                 $title = Title :: newFromText($search);
  52                 if(!$title)
  53                         return; // Return empty result
  54
  55                 // Prepare nested request
  56                 $req = new FauxRequest(array (
  57                         'action' => 'query',
  58                         'list' => 'allpages',
  59                         'apnamespace' => $title->getNamespace(),
  60                         'aplimit' => $params['limit'],
  61                         'apprefix' => $title->getDBkey()
  62                 ));
  63
  64                 // Execute
  65                 $module = new ApiMain($req);
  66                 $module->execute();
  67
  68                 // Get resulting data
  69                 $data = $module->getResultData();
  70
  71                 // Reformat useful data for future printing by JSON engine
  72                 $srchres = array ();
  73                 foreach ($data['query']['allpages'] as & $pageinfo) {
  74                         // Note: this data will no be printable by the xml engine
  75                         // because it does not support lists of unnamed items
  76                         $srchres[] = $pageinfo['title'];
  77                 }
  78
  79                 // Set top level elements
  80                 $result = $this->getResult();
  81                 $result->addValue(null, 0, $search);
  82                 $result->addValue(null, 1, $srchres);
  83         }
  84
  85         protected function getAllowedParams() {
  86                 return array (
  87                         'search' => null,
  88                         'limit' => array (
  89                                 ApiBase :: PARAM_DFLT => 10,
  90                                 ApiBase :: PARAM_TYPE => 'limit',
  91                                 ApiBase :: PARAM_MIN => 1,
  92                                 ApiBase :: PARAM_MAX => 100,
  93                                 ApiBase :: PARAM_MAX2 => 100
  94                         )
  95                 );
  96         }
  97
  98         protected function getParamDescription() {
  99                 return array (
 100                         'search' => 'Search string',
 101                         'limit' => 'Maximum amount of results to return'
 102                 );
 103         }
 104
 105         protected function getDescription() {
 106                 return 'This module implements OpenSearch protocol';
 107         }
 108
 109         protected function getExamples() {
 110                 return array (
 111                         'api.php?action=opensearch&search=Te'
 112                 );
 113         }
 114
 115         public function getVersion() {
 116                 return __CLASS__ . ': $Id$';
 117         }
 118 }
 119