From 9b103af6d94413704fbd6f47074cabe28db611c6 Mon Sep 17 00:00:00 2001
From: Mads Marquart <madsmtm@gmail.com>
Date: Thu, 10 Dec 2020 16:11:35 +0100
Subject: [PATCH 1/3] Add OpenSearch support

Allows Firefox users to add Package Control as a search engine

See https://github.com/dewitt/opensearch and
https://developer.mozilla.org/en-US/docs/Web/OpenSearch for more info.
---
 app/html/five_hundred.html               | 1 +
 app/templates/partials/header.handlebars | 1 +
 dev.py                                   | 5 +++++
 public/opensearch.xml                    | 9 +++++++++
 servers.sh                               | 7 +++++++
 5 files changed, 23 insertions(+)
 create mode 100644 public/opensearch.xml

diff --git a/app/html/five_hundred.html b/app/html/five_hundred.html
index ac29b6a..097a6e8 100644
--- a/app/html/five_hundred.html
+++ b/app/html/five_hundred.html
@@ -7,6 +7,7 @@
         <link rel="stylesheet" href="/css/app.css" type="text/css" media="all" />
         <link href="//netdna.bootstrapcdn.com/font-awesome/3.2.1/css/font-awesome.css" rel="stylesheet">
         <meta name="viewport" content="width=380" id="meta-viewport" />
+        <link rel="search" type="application/opensearchdescription+xml" href="/opensearch.xml" title="Package Control" />
         <script>
         window.onload = function() {
             if (screen.width < 740) { return; } // Make phones use 380
diff --git a/app/templates/partials/header.handlebars b/app/templates/partials/header.handlebars
index 6033321..b5cc233 100644
--- a/app/templates/partials/header.handlebars
+++ b/app/templates/partials/header.handlebars
@@ -84,6 +84,7 @@
         <link rel="stylesheet" href="/css/app.css?v={{__version__}}" type="text/css" media="all" />
         <link href="//netdna.bootstrapcdn.com/font-awesome/3.2.1/css/font-awesome.css" rel="stylesheet">
         <meta name="viewport" content="width=380" id="meta-viewport" />
+        <link rel="search" type="application/opensearchdescription+xml" href="/opensearch.xml" title="Package Control" />
         <script>
         window.onload = function() {
             if (screen.width < 740) { return; } /* Make phones use 380 */
diff --git a/dev.py b/dev.py
index 2b5ded3..4fdd49f 100755
--- a/dev.py
+++ b/dev.py
@@ -37,6 +37,11 @@ def server_html(filename):
     return add_version(response)
 
 
+@bottle.route('/opensearch.xml')
+def server_opensearch():
+    return bottle.static_file('opensearch.xml', root=public_root, mimetype='application/opensearchdescription+xml')
+
+
 @bottle.route('/favicon.ico')
 def server_fav():
     return bottle.static_file('favicon.ico', root=public_root)
diff --git a/public/opensearch.xml b/public/opensearch.xml
new file mode 100644
index 0000000..235fdc0
--- /dev/null
+++ b/public/opensearch.xml
@@ -0,0 +1,9 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<OpenSearchDescription xmlns="http://a9.com/-/spec/opensearch/1.1/" xmlns:moz="http://www.mozilla.org/2006/browser/search/">
+<ShortName>Package Control</ShortName>
+<Description>The Sublime Text package manager that makes it exceedingly simple to find, install and keep packages up-to-date</Description>
+<Url type="text/html" method="GET" template="https://packagecontrol.io/search/{searchTerms}" />
+<Url type="application/opensearchdescription+xml" rel="self" template="https://packagecontrol.io/opensearch.xml" />
+<Language>en-US</Language>
+<moz:SearchForm>https://packagecontrol.io/search</moz:SearchForm>
+</OpenSearchDescription>
diff --git a/servers.sh b/servers.sh
index 573478b..381b6f3 100755
--- a/servers.sh
+++ b/servers.sh
@@ -156,6 +156,13 @@ if [[ $TASK == "start" ]]; then
                 try_files  \$uri  @site;
             }
 
+            # Override OpenSearch content type
+            location /opensearch.xml {
+                types {
+                    application/opensearchdescription+xml xml;
+                }
+            }
+
             location @site {
                 access_by_lua_file  "$PROJ_DIR/realtime/record_web.lua";
                 proxy_pass http://localhost:9000;

From 8f5671bd0dd03aa2b6352610709fc0bb1e37eb2c Mon Sep 17 00:00:00 2001
From: Mads Marquart <madsmtm@gmail.com>
Date: Thu, 10 Dec 2020 19:18:24 +0100
Subject: [PATCH 2/3] Add support for OpenSearch suggestions

---
 app/controllers/__init__.py               |  1 +
 app/controllers/opensearch_suggestions.py | 20 ++++++++++++++++++++
 public/opensearch.xml                     |  1 +
 3 files changed, 22 insertions(+)
 create mode 100644 app/controllers/opensearch_suggestions.py

diff --git a/app/controllers/__init__.py b/app/controllers/__init__.py
index 2c1b37c..843d708 100644
--- a/app/controllers/__init__.py
+++ b/app/controllers/__init__.py
@@ -23,6 +23,7 @@
 from .messaging import messaging_controller
 from .new import new_controller
 from .news import news_controller
+from .opensearch_suggestions import opensearch_suggestions_controller
 from .package import package_controller
 from .packages import packages_controller
 from .popular import popular_controller
diff --git a/app/controllers/opensearch_suggestions.py b/app/controllers/opensearch_suggestions.py
new file mode 100644
index 0000000..0cadd58
--- /dev/null
+++ b/app/controllers/opensearch_suggestions.py
@@ -0,0 +1,20 @@
+import json
+
+from bottle import route, response
+
+from ..models import package
+
+
+@route('/opensearch_suggestions', name='opensearch_suggestions_blank')
+@route('/opensearch_suggestions/<terms:re:(.*)>', name='opensearch_suggestions')
+def opensearch_suggestions_controller(terms=''):
+    # TODO: Optimize this call, since we're requesting a lot of stuff we don't need
+    results = package.find.search(terms, 'relevance', 1, 10)
+
+    # Convert data to match suggestion extension format
+    # https://github.com/dewitt/opensearch/blob/master/mediawiki/Specifications/OpenSearch/Extensions/Suggestions/1.1/Draft%201.wiki
+    data = [terms, [package['name'] for package in results['packages']]]
+
+    # Manually convert to JSON, since the response is a list and not a dict
+    response.content_type = 'application/x-suggestions+json'
+    return json.dumps(data)
diff --git a/public/opensearch.xml b/public/opensearch.xml
index 235fdc0..de77dee 100644
--- a/public/opensearch.xml
+++ b/public/opensearch.xml
@@ -4,6 +4,7 @@
 <Description>The Sublime Text package manager that makes it exceedingly simple to find, install and keep packages up-to-date</Description>
 <Url type="text/html" method="GET" template="https://packagecontrol.io/search/{searchTerms}" />
 <Url type="application/opensearchdescription+xml" rel="self" template="https://packagecontrol.io/opensearch.xml" />
+<Url type="application/x-suggestions+json" method="get" template="https://packagecontrol.io/opensearch_suggestions/{searchTerms}.json" />
 <Language>en-US</Language>
 <moz:SearchForm>https://packagecontrol.io/search</moz:SearchForm>
 </OpenSearchDescription>

From c921501e5d4f36f551d8ff4e1f0e1e91c3a5ef49 Mon Sep 17 00:00:00 2001
From: Mads Marquart <madsmtm@gmail.com>
Date: Thu, 10 Dec 2020 19:24:11 +0100
Subject: [PATCH 3/3] Add OpenSearch Image element

---
 public/opensearch.xml | 1 +
 1 file changed, 1 insertion(+)

diff --git a/public/opensearch.xml b/public/opensearch.xml
index de77dee..e07b760 100644
--- a/public/opensearch.xml
+++ b/public/opensearch.xml
@@ -5,6 +5,7 @@
 <Url type="text/html" method="GET" template="https://packagecontrol.io/search/{searchTerms}" />
 <Url type="application/opensearchdescription+xml" rel="self" template="https://packagecontrol.io/opensearch.xml" />
 <Url type="application/x-suggestions+json" method="get" template="https://packagecontrol.io/opensearch_suggestions/{searchTerms}.json" />
+<Image height="64" width="64" type="image/x-icon">https://packagecontrol.io/favicon.ico</Image>
 <Language>en-US</Language>
 <moz:SearchForm>https://packagecontrol.io/search</moz:SearchForm>
 </OpenSearchDescription>