Support OpenSearch (closes #7058) (#9427)

Co-authored-by: Chaos <chaoticryptidz@owo.monster>
misskey-dev · Dec 28, 2022 · 123e490 · 123e490
1 parent c4e4ffc
commit 123e490
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 0 deletions.
diff --git a/packages/backend/src/server/web/ClientServerService.ts b/packages/backend/src/server/web/ClientServerService.ts
@@ -304,6 +304,24 @@ export class ClientServerService {
  return await reply.sendFile('/robots.txt', staticAssets);
  });
 
+ // OpenSearch XML
+ fastify.get('/opensearch.xml', async (request, reply) => {
+ const meta = await this.metaService.fetch();
+
+ const name = meta.name || "Misskey";
+ let content = "";
+ content += `<OpenSearchDescription xmlns="http://a9.com/-/spec/opensearch/1.1/" xmlns:moz="http://www.mozilla.org/2006/browser/search/">`;
+ content += `<ShortName>${name} Search</ShortName>`;
+ content += `<Description>${name} Search</Description>`;
+ content += `<InputEncoding>UTF-8</InputEncoding>`;
+ content += `<Image width="16" height="16" type="image/x-icon">${this.config.url}/favicon.ico</Image>`;
+ content += `<Url type="text/html" template="${this.config.url}/search?q={searchTerms}"/>`;
+ content += `</OpenSearchDescription>`;
+
+ reply.header('Content-Type', 'application/opensearchdescription+xml');
+ return await reply.send(content);
+ });
+
  //#endregion
 
  const renderBase = async (reply: FastifyReply) => {
@@ -313,6 +331,7 @@ export class ClientServerService {
  img: meta.bannerUrl,
  title: meta.name ?? 'Misskey',
  instanceName: meta.name ?? 'Misskey',
+ url: this.config.url,
  desc: meta.description,
  icon: meta.iconUrl,
  themeColor: meta.themeColor,

diff --git a/packages/backend/src/server/web/views/base.pug b/packages/backend/src/server/web/views/base.pug
@@ -31,6 +31,7 @@ html
  link(rel='icon' href= icon || '/favicon.ico')
  link(rel='apple-touch-icon' href= icon || '/apple-touch-icon.png')
  link(rel='manifest' href='/manifest.json')
+ link(rel='search' type='application/opensearchdescription+xml' title=((title || "Misskey") + " Search") href=`${url}/opensearch.xml`)
  link(rel='prefetch' href='https://xn--931a.moe/assets/info.jpg')
  link(rel='prefetch' href='https://xn--931a.moe/assets/not-found.jpg')
  link(rel='prefetch' href='https://xn--931a.moe/assets/error.jpg')