src/Module/OpenSearch.php

   1 <?php
   2 /**
   3  * @copyright Copyright (C) 2010-2023, the Friendica project
   4  *
   5  * @license GNU AGPL version 3 or any later version
   6  *
   7  * This program is free software: you can redistribute it and/or modify
   8  * it under the terms of the GNU Affero General Public License as
   9  * published by the Free Software Foundation, either version 3 of the
  10  * License, or (at your option) any later version.
  11  *
  12  * This program is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU Affero General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU Affero General Public License
  18  * along with this program.  If not, see <https://www.gnu.org/licenses/>.
  19  *
  20  */
  21
  22 namespace Friendica\Module;
  23
  24 use DOMDocument;
  25 use DOMElement;
  26 use Friendica\BaseModule;
  27 use Friendica\Core\System;
  28 use Friendica\DI;
  29 use Friendica\Util\XML;
  30
  31 /**
  32  * Prints the opensearch description document
  33  * @see https://github.com/dewitt/opensearch/blob/master/opensearch-1-1-draft-6.md#opensearch-description-document
  34  */
  35 class OpenSearch extends BaseModule
  36 {
  37         /**
  38          * @throws \Exception
  39          */
  40         protected function rawContent(array $request = [])
  41         {
  42                 $hostname = DI::baseUrl()->getHost();
  43                 $baseUrl  = DI::baseUrl();
  44
  45                 /** @var DOMDocument $xml */
  46                 XML::fromArray([
  47                         'OpenSearchDescription' => [
  48                                 '@attributes' => [
  49                                         'xmlns' => 'http://a9.com/-/spec/opensearch/1.1',
  50                                 ],
  51                                 'ShortName'      => "Friendica $hostname",
  52                                 'Description'    => "Search in Friendica $hostname",
  53                                 'Contact'        => 'https://github.com/friendica/friendica/issues',
  54                                 'InputEncoding'  => 'UTF-8',
  55                                 'OutputEncoding' => 'UTF-8',
  56                                 'Developer'      => 'Friendica Developer Team',
  57                         ],
  58                 ], $xml);
  59
  60                 /** @var DOMElement $parent */
  61                 $parent = $xml->getElementsByTagName('OpenSearchDescription')[0];
  62
  63                 XML::addElement($xml, $parent, 'Image',
  64                         "$baseUrl/images/friendica-16.png", [
  65                                 'height' => 16,
  66                                 'width'  => 16,
  67                                 'type'   => 'image/png',
  68                         ]);
  69
  70                 XML::addElement($xml, $parent, 'Image',
  71                         "$baseUrl/images/friendica-64.png", [
  72                                 'height' => 64,
  73                                 'width'  => 64,
  74                                 'type'   => 'image/png',
  75                         ]);
  76
  77                 XML::addElement($xml, $parent, 'Url', '', [
  78                         'type'     => 'text/html',
  79                         'template' => "$baseUrl/search?search={searchTerms}",
  80                 ]);
  81
  82                 XML::addElement($xml, $parent, 'Url', '', [
  83                         'type'     => 'application/opensearchdescription+xml',
  84                         'rel'      => 'self',
  85                         'template' => "$baseUrl/opensearch",
  86                 ]);
  87
  88                 System::httpExit($xml->saveXML(), Response::TYPE_XML, 'application/opensearchdescription+xml');
  89         }
  90 }