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                 $limit = intval( $params['limit'] );
  48                 if( $limit < 1 || $limit > 100 ) {
  49                         $limit = 10;
  50                 }
  51
  52                 // Open search results may be stored for a very long time
  53                 $this->getMain()->setCacheMaxAge(1200);
  54
  55                 $title = Title :: newFromText($search);
  56                 if(!$title)
  57                         return; // Return empty result
  58
  59                 // Prepare nested request
  60                 $req = new FauxRequest(array (
  61                         'action' => 'query',
  62                         'list' => 'allpages',
  63                         'apnamespace' => $title->getNamespace(),
  64                         'aplimit' => $limit,
  65                         'apprefix' => $title->getDBkey()
  66                 ));
  67
  68                 // Execute
  69                 $module = new ApiMain($req);
  70                 $module->execute();
  71
  72                 // Get resulting data
  73                 $data = $module->getResultData();
  74
  75                 // Reformat useful data for future printing by JSON engine
  76                 $srchres = array ();
  77                 foreach ($data['query']['allpages'] as & $pageinfo) {
  78                         // Note: this data will no be printable by the xml engine
  79                         // because it does not support lists of unnamed items
  80                         $srchres[] = $pageinfo['title'];
  81                 }
  82
  83                 // Set top level elements
  84                 $result = $this->getResult();
  85                 $result->addValue(null, 0, $search);
  86                 $result->addValue(null, 1, $srchres);
  87         }
  88
  89         protected function getAllowedParams() {
  90                 return array (
  91                         'search' => null,
  92                         'limit' => 10
  93                 );
  94         }
  95
  96         protected function getParamDescription() {
  97                 return array (
  98                         'search' => 'Search string',
  99                         'limit' => 'Optional limit (default 10)'
 100                 );
 101         }
 102
 103         protected 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 }
 117