mdebray/tvl-depot
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

feat(atward): Serve OpenSearch XML file to support Firefox

Browse source 
Firefox users can not easily add search engines to the browser unless
the page serves an OpenSearch description. This CL adds said
description according to the documentation:

https://developer.mozilla.org/en-US/docs/Web/OpenSearch

Change-Id: I358c5940304f4abd9e45dd72a64e46d3ce44b3e3
Reviewed-on: https://cl.tvl.fyi/c/depot/+/3105
Tested-by: BuildkiteCI
Reviewed-by: cynthia <cynthia@tvl.fyi>
This commit is contained in:
Vincent Ambo 2021-05-11 23:58:10 +02:00 committed by tazjin
parent 99d11bef5f
commit cb497a0cca
3 changed files with 20 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
web/atward/src/index.html
View file

@ -4,6 +4,7 @@
<meta name="description" content="The Virus Lounge">
<link rel="stylesheet" type="text/css" href="https://tvl.fyi/static/tazjin.css" media="all">
<link rel="icon" type="image/webp" href="https://tvl.fyi/static/favicon.webp">
<link rel="search" type="application/opensearchdescription+xml" title="TVL Search" href="https://at.tvl.fyi/opensearch.xml">
<title>TVL Search</title>
<body class="light">
<header>

11
web/atward/src/main.rs
View file

@ -113,6 +113,13 @@ fn dispatch(handlers: &[Handler], query: &Query) -> Option<String> {
None
}
/// Return the opensearch.xml file which is required for adding atward
/// as a search engine in Firefox.
fn opensearch() -> Response {
Response::text(include_str!("opensearch.xml"))
.with_unique_header("Content-Type", "application/opensearchdescription+xml")
}
/// Render the atward index page which gives users some information
/// about how to use the service.
fn index() -> Response {
@ -133,6 +140,10 @@ fn main() {
rouille::start_server(&address, move |request| {
rouille::log(&request, std::io::stderr(), || {
if request.url() == "/opensearch.xml" {
return opensearch();
}
let query = match Query::from_request(&request) {
Some(q) => q,
None => return index(),

8
web/atward/src/opensearch.xml Normal file
View file

@ -0,0 +1,8 @@
<OpenSearchDescription xmlns="http://a9.com/-/spec/opensearch/1.1/">
<ShortName>TVL</ShortName>
<Description>The Virus Lounge Search</Description>
<InputEncoding>UTF-8</InputEncoding>
<Url type="text/html" template="https://at.tvl.fyi/">
<Param name="q" value="{searchTerms}"/>
</Url>
</OpenSearchDescription>