includes/api/ApiOpenSearch.php

   1 <?php
   2
   3
   4 /*
   5  * Created on Oct 13, 2006
   6  *
   7  * API for MediaWiki 1.8+
   8  *
   9  * Copyright (C) 2006 Yuri Astrakhan <FirstnameLastname@gmail.com>
  10  *
  11  * This program is free software; you can redistribute it and/or modify
  12  * it under the terms of the GNU General Public License as published by
  13  * the Free Software Foundation; either version 2 of the License, or
  14  * (at your option) any later version.
  15  *
  16  * This program is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  19  * GNU General Public License for more details.
  20  *
  21  * You should have received a copy of the GNU General Public License along
  22  * with this program; if not, write to the Free Software Foundation, Inc.,
  23  * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  24  * http://www.gnu.org/copyleft/gpl.html
  25  */
  26
  27 if (!defined('MEDIAWIKI')) {
  28         // Eclipse helper - will be ignored in production
  29         require_once ("ApiBase.php");
  30 }
  31
  32 class ApiOpenSearch extends ApiBase {
  33
  34         public function __construct($main, $action) {
  35                 parent :: __construct($main, $action);
  36         }
  37
  38         public function getCustomPrinter() {
  39                 return $this->getMain()->createPrinterByName('json');
  40         }
  41
  42         public function execute() {
  43                 $search = null;
  44                 extract($this->ExtractRequestParams());
  45
  46                 // Open search results may be stored for a very long time
  47                 $this->getMain()->setCacheMaxAge(1200);
  48
  49                 $title = Title :: newFromText($search);
  50                 if(!$title)
  51                         return; // Return empty result
  52
  53                 // Prepare nested request
  54                 $params = new FauxRequest(array (
  55                         'action' => 'query',
  56                         'list' => 'allpages',
  57                         'apnamespace' => $title->getNamespace(),
  58                         'aplimit' => 10,
  59                         'apprefix' => $title->getDBkey()
  60                 ));
  61
  62                 // Execute
  63                 $module = new ApiMain($params);
  64                 $module->execute();
  65
  66                 // Get resulting data
  67                 $data = $module->getResultData();
  68
  69                 // Reformat useful data for future printing by JSON engine
  70                 $srchres = array ();
  71                 foreach ($data['query']['allpages'] as & $pageinfo) {
  72                         // Note: this data will no be printable by the xml engine
  73                         // because it does not support lists of unnamed items
  74                         $srchres[] = $pageinfo['title'];
  75                 }
  76
  77                 // Set top level elements
  78                 $result = $this->getResult();
  79                 $result->addValue(null, 0, $search);
  80                 $result->addValue(null, 1, $srchres);
  81         }
  82
  83         protected function getAllowedParams() {
  84                 return array (
  85                         'search' => null
  86                 );
  87         }
  88
  89         protected function getParamDescription() {
  90                 return array (
  91                         'search' => 'Search string'
  92                 );
  93         }
  94
  95         protected function getDescription() {
  96                 return 'This module implements OpenSearch protocol';
  97         }
  98
  99         protected function getExamples() {
 100                 return array (
 101                         'api.php?action=opensearch&search=Te'
 102                 );
 103         }
 104
 105         public function getVersion() {
 106                 return __CLASS__ . ': $Id$';
 107         }
 108 }
 109 ?>