From 538029dc14ca47afae126e29bf789941d9bffd48 Mon Sep 17 00:00:00 2001 From: Luc Didry Date: Sat, 13 Jun 2015 17:49:33 +0200 Subject: [PATCH] Add a self user agent plugin Just like with the "ip" query, duckduckgo gives the server's information with the "user agent" query. This corrects this behavior by adding a plugin based on self_ip.py plugin. --- searx/plugins/__init__.py | 2 ++ searx/plugins/self_useragent.py | 36 +++++++++++++++++++++++++++++++++ searx/tests/test_plugins.py | 17 +++++++++++++++- 3 files changed, 54 insertions(+), 1 deletion(-) create mode 100644 searx/plugins/self_useragent.py diff --git a/searx/plugins/__init__.py b/searx/plugins/__init__.py index 5ac3f447c..a16ae5fc3 100644 --- a/searx/plugins/__init__.py +++ b/searx/plugins/__init__.py @@ -21,6 +21,7 @@ logger = logger.getChild('plugins') from searx.plugins import (https_rewrite, self_ip, + self_useragent, search_on_category_select) required_attrs = (('name', str), @@ -72,4 +73,5 @@ class PluginStore(): plugins = PluginStore() plugins.register(https_rewrite) plugins.register(self_ip) +plugins.register(self_useragent) plugins.register(search_on_category_select) diff --git a/searx/plugins/self_useragent.py b/searx/plugins/self_useragent.py new file mode 100644 index 000000000..cae91ccba --- /dev/null +++ b/searx/plugins/self_useragent.py @@ -0,0 +1,36 @@ +''' +searx is free software: you can redistribute it and/or modify +it under the terms of the GNU Affero General Public License as published by +the Free Software Foundation, either version 3 of the License, or +(at your option) any later version. + +searx is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +GNU Affero General Public License for more details. + +You should have received a copy of the GNU Affero General Public License +along with searx. If not, see < http://www.gnu.org/licenses/ >. + +(C) 2015 by Adam Tauber, +''' +from flask.ext.babel import gettext +import re +name = "Self User Agent" +description = gettext('Display your own User Agent if the query expression contains "user agent" or "user-agent"') +default_on = True + + +# User Agent query regex +p = re.compile('user[ -]agent', re.IGNORECASE) + + +# attach callback to the post search hook +# request: flask request object +# ctx: the whole local context of the pre search hook +def post_search(request, ctx): + if p.match(ctx['search'].query): + ua = request.user_agent + ctx['search'].answers.clear() + ctx['search'].answers.add(ua) + return True diff --git a/searx/tests/test_plugins.py b/searx/tests/test_plugins.py index 8dcad1142..c12e71e1d 100644 --- a/searx/tests/test_plugins.py +++ b/searx/tests/test_plugins.py @@ -39,9 +39,11 @@ class SelfIPTest(SearxTestCase): def test_PluginStore_init(self): store = plugins.PluginStore() store.register(plugins.self_ip) + store.register(plugins.self_useragent) - self.assertTrue(len(store.plugins) == 1) + self.assertTrue(len(store.plugins) == 2) + # IP test request = Mock(user_plugins=store.plugins, remote_addr='127.0.0.1') request.headers.getlist.return_value = [] @@ -49,3 +51,16 @@ class SelfIPTest(SearxTestCase): query='ip')} store.call('post_search', request, ctx) self.assertTrue('127.0.0.1' in ctx['search'].answers) + + # User agent test + request = Mock(user_plugins=store.plugins, + user_agent='Mock') + request.headers.getlist.return_value = [] + ctx = {'search': Mock(answers=set(), + query='user-agent')} + store.call('post_search', request, ctx) + self.assertTrue('Mock' in ctx['search'].answers) + ctx = {'search': Mock(answers=set(), + query='user agent')} + store.call('post_search', request, ctx) + self.assertTrue('Mock' in ctx['search'].answers)