opensearch_desc.php

   1 <?php
   2 /**
   3  * The web entry point for generating an OpenSearch description document.
   4  *
   5  * See <http://www.opensearch.org/> for the specification of the OpenSearch
   6  * "description" document. In a nut shell, this tells browsers how and where
   7  * to submit submit search queries to get a search results page back,
   8  * as well as how to get typeahead suggestions (see ApiOpenSearch).
   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  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  23  * http://www.gnu.org/copyleft/gpl.html
  24  *
  25  * @file
  26  * @ingroup entrypoint
  27  */
  28
  29 // This endpoint is supposed to be independent of request cookies and other
  30 // details of the session. Enforce this constraint with respect to session use.
  31 define( 'MW_NO_SESSION', 1 );
  32
  33 define( 'MW_ENTRY_POINT', 'opensearch_desc' );
  34
  35 require_once __DIR__ . '/includes/WebStart.php';
  36
  37 wfOpenSearchDescMain();
  38
  39 function wfOpenSearchDescMain() {
  40         global $wgRequest, $wgFavicon, $wgOpenSearchTemplates;
  41
  42         if ( $wgRequest->getVal( 'ctype' ) == 'application/xml' ) {
  43                 // Makes testing tweaks about a billion times easier
  44                 $ctype = 'application/xml';
  45         } else {
  46                 $ctype = 'application/opensearchdescription+xml';
  47         }
  48
  49         $response = $wgRequest->response();
  50         $response->header( "Content-type: $ctype" );
  51
  52         // Set an Expires header so that CDN can cache it for a short time
  53         // Short enough so that the sysadmin barely notices when $wgSitename is changed
  54         $expiryTime = 600; # 10 minutes
  55         $response->header( 'Expires: ' . gmdate( 'D, d M Y H:i:s', time() + $expiryTime ) . ' GMT' );
  56         $response->header( 'Cache-control: max-age=600' );
  57
  58         print '<?xml version="1.0"?>';
  59         print Xml::openElement( 'OpenSearchDescription',
  60                 [
  61                         'xmlns' => 'http://a9.com/-/spec/opensearch/1.1/',
  62                         'xmlns:moz' => 'http://www.mozilla.org/2006/browser/search/' ] );
  63
  64         // The spec says the ShortName must be no longer than 16 characters,
  65         // but 16 is *realllly* short. In practice, browsers don't appear to care
  66         // when we give them a longer string, so we're no longer attempting to trim.
  67         //
  68         // Note: ShortName and the <link title=""> need to match; they are used as
  69         // a key for identifying if the search engine has been added already, *and*
  70         // as the display name presented to the end-user.
  71         //
  72         // Behavior seems about the same between Firefox and IE 7/8 here.
  73         // 'Description' doesn't appear to be used by either.
  74         $fullName = wfMessage( 'opensearch-desc' )->inContentLanguage()->text();
  75         print Xml::element( 'ShortName', null, $fullName );
  76         print Xml::element( 'Description', null, $fullName );
  77
  78         // By default we'll use the site favicon.
  79         // Double-check if IE supports this properly?
  80         print Xml::element( 'Image',
  81                 [
  82                         'height' => 16,
  83                         'width' => 16,
  84                         'type' => 'image/x-icon' ],
  85                 wfExpandUrl( $wgFavicon, PROTO_CURRENT ) );
  86
  87         $urls = [];
  88
  89         // General search template. Given an input term, this should bring up
  90         // search results or a specific found page.
  91         // At least Firefox and IE 7 support this.
  92         $searchPage = SpecialPage::getTitleFor( 'Search' );
  93         $urls[] = [
  94                 'type' => 'text/html',
  95                 'method' => 'get',
  96                 'template' => $searchPage->getCanonicalURL( 'search={searchTerms}' ) ];
  97
  98         foreach ( $wgOpenSearchTemplates as $type => $template ) {
  99                 if ( !$template ) {
 100                         $template = ApiOpenSearch::getOpenSearchTemplate( $type );
 101                 }
 102
 103                 if ( $template ) {
 104                         $urls[] = [
 105                                 'type' => $type,
 106                                 'method' => 'get',
 107                                 'template' => $template,
 108                         ];
 109                 }
 110         }
 111
 112         // Allow hooks to override the suggestion URL settings in a more
 113         // general way than overriding the whole search engine...
 114         Hooks::runner()->onOpenSearchUrls( $urls );
 115
 116         foreach ( $urls as $attribs ) {
 117                 print Xml::element( 'Url', $attribs );
 118         }
 119
 120         // And for good measure, add a link to the straight search form.
 121         // This is a custom format extension for Firefox, which otherwise
 122         // sends you to the domain root if you hit "enter" with an empty
 123         // search box.
 124         print Xml::element( 'moz:SearchForm', null,
 125                 $searchPage->getCanonicalURL() );
 126
 127         print '</OpenSearchDescription>';
 128 }