From 1f6bfa092e9d686f3238ec73e5d3cf2e38ae05f0 Mon Sep 17 00:00:00 2001
From: Ben Busby <ben.busby7@gmail.com>
Date: Fri, 24 Apr 2020 18:45:57 -0600
Subject: [PATCH] Complete refactoring of opensearch

Refactored opensearch.xml to only exist as a template that is
served by a flask route, which is then populated with the
necessary url root.
---
 README.md                      |  7 ++-----
 app/filter.py                  |  5 +++--
 app/routes.py                  | 14 +++++++++++++-
 app/static/opensearch.template | 13 -------------
 app/templates/index.html       |  2 +-
 config/opensearch.py           | 21 ---------------------
 6 files changed, 19 insertions(+), 43 deletions(-)
 delete mode 100644 app/static/opensearch.template
 delete mode 100644 config/opensearch.py

diff --git a/README.md b/README.md
index 49da1d7..a90e955 100644
--- a/README.md
+++ b/README.md
@@ -20,7 +20,7 @@ Get Google search results, but without any ads, javascript, AMP links, or tracki
 - [A Heroku Account](https://www.heroku.com/)
   - Optional, but recommended. Allows for free hosting of the web app and single-click deployment.
   - Alternatively, you can host the app using a different service, or deploy it to your own server (explained below).
-  
+
 If deploying manually:
 - Docker ([Windows](https://docs.docker.com/docker-for-windows/install/), [macOS](https://docs.docker.com/docker-for-mac/install/), [Ubuntu](https://docs.docker.com/engine/install/ubuntu/), [other Linux distros](https://docs.docker.com/engine/install/binaries/))
 - [Heroku CLI](https://devcenter.heroku.com/articles/heroku-cli)
@@ -77,10 +77,7 @@ To filter by a range of time, append ":past <time>" to the end of your search, w
 
 ## Extra Steps
 ### Set Shoogle as your primary search engine
-1. From the main shoogle folder, run `python config/opensearch.py "<your app url>"`
-2. Rebuild and release your updated app
-  - `heroku container:push web` and then `heroku container:release web`
-3. Update browser settings
+Update browser settings:
   - Firefox (Desktop)
     - Navigate to your app's url, and click the 3 dot menu in the address bar. At the bottom, there should be an option to "Add Search Engine". Once you've clicked this, open your Firefox Preferences menu, click "Search" in the left menu, and use the available dropdown to select "Shoogle" from the list.
   - Firefox (Mobile)
diff --git a/app/filter.py b/app/filter.py
index 4958efe..c15ee42 100644
--- a/app/filter.py
+++ b/app/filter.py
@@ -52,8 +52,9 @@ class Filter:
             logo['style'] = 'display:flex; justify-content:center; align-items:center; color:#685e79; font-size:18px;'
 
         # Fix search bar length on mobile
-        search_bar = soup.find('header').find('form').find('div')
-        search_bar['style'] = 'width: 100%;'
+        if self.mobile:
+            search_bar = soup.find('header').find('form').find('div')
+            search_bar['style'] = 'width: 100%;'
 
         # Replace hrefs with only the intended destination (no "utm" type tags)
         for a in soup.find_all('a', href=True):
diff --git a/app/routes.py b/app/routes.py
index f56459a..a2a8603 100644
--- a/app/routes.py
+++ b/app/routes.py
@@ -2,7 +2,7 @@ from app import app
 from app.filter import Filter
 from app.request import Request, gen_query
 from bs4 import BeautifulSoup
-from flask import g, request, redirect, render_template
+from flask import g, make_response, request, redirect, render_template
 import json
 import os
 import urllib.parse as urlparse
@@ -24,6 +24,18 @@ def index():
     return render_template('index.html', bg=bg, ua=g.user_request.modified_user_agent)
 
 
+@app.route('/opensearch.xml', methods=['GET'])
+def opensearch():
+    url_root = request.url_root
+    if url_root.endswith('/'):
+        url_root = url_root[:-1]
+
+    template = render_template('opensearch.xml', shoogle_url=url_root)
+    response = make_response(template)
+    response.headers['Content-Type'] = 'application/xml'
+    return response
+
+
 @app.route('/search', methods=['GET'])
 def search():
     q = request.args.get('q')
diff --git a/app/static/opensearch.template b/app/static/opensearch.template
deleted file mode 100644
index 44ac525..0000000
--- a/app/static/opensearch.template
+++ /dev/null
@@ -1,13 +0,0 @@
-<OpenSearchDescription xmlns="http://a9.com/-/spec/opensearch/1.1/"
-                       xmlns:moz="http://www.mozilla.org/2006/browser/search/">
-  <ShortName>Shoogle</ShortName>
-  <Description>Shoogle: A lightweight, deployable Google search proxy for desktop/mobile that removes Javascript, AMP links, and ads</Description>
-  <InputEncoding>UTF-8</InputEncoding>
-  <Image width="32" height="32" type="image/x-icon">/static/img/favicon/favicon-32x32.png</Image>
-  <Url type="text/html" template="SHOOGLE_URL/search">
-    <Param name="q" value="{searchTerms}"/>
-  </Url>
-  <Url type="application/x-suggestions+json" template="SHOOGLE_URL/search"/>
-  <moz:SearchForm>SHOOGLE_URL/search</moz:SearchForm>
-</OpenSearchDescription>
-
diff --git a/app/templates/index.html b/app/templates/index.html
index 0210c4f..e8a0fdb 100644
--- a/app/templates/index.html
+++ b/app/templates/index.html
@@ -17,7 +17,7 @@
         <meta name="msapplication-TileColor" content="#ffffff">
         <meta name="msapplication-TileImage" content="/static/img/favicon/ms-icon-144x144.png">
         <script type="text/javascript" src="/static/js/controller.js"></script>
-        <link rel="search" href="/static/opensearch.xml" type="application/opensearchdescription+xml" title="Shoogle Search">
+        <link rel="search" href="/opensearch.xml" type="application/opensearchdescription+xml" title="Shoogle Search">
         <meta name="viewport" content="width=device-width, initial-scale=1.0">
         <link rel="stylesheet" href="/static/css/main.css">
 	<title>Shoogle Search</title>
diff --git a/config/opensearch.py b/config/opensearch.py
deleted file mode 100644
index 31d612e..0000000
--- a/config/opensearch.py
+++ /dev/null
@@ -1,21 +0,0 @@
-import os
-import sys
-
-script_path = os.path.dirname(os.path.realpath(__file__))
-template_path = script_path + '/../app/static/opensearch.template'
-opensearch_path = script_path + '/../app/static/opensearch.xml'
-replace_tag = 'SHOOGLE_URL'
-
-if len(sys.argv) != 2:
-    print('You must provide the url as an argument for this script.')
-    print('Example: python opensearch.py "https://my-app-1776.herokuapps.com"')
-    sys.exit(0)
-
-app_url = sys.argv[1].rstrip('/')
-opensearch_template = open(template_path, 'r').read()
-
-with open(opensearch_path, 'w') as opensearch_xml:
-    opensearch_xml.write(opensearch_template.replace(replace_tag, app_url))
-    opensearch_xml.close()
-
-print('\nDone - you may now set Shoogle as your primary search engine')