commit: a9d92c3874dd8d44a5b6ce0e823972823637529a
parent: c9b8c7f8deffce93b920273171a4f8f9d6339ea7
Author: Adam Tauber <asciimoo@gmail.com>
Date: Mon, 15 Jun 2015 09:42:01 -0400
Merge pull request #371 from framasoft/add-useragent-plugin
Add a self user agent plugin
Diffstat:
4 files changed, 64 insertions(+), 38 deletions(-)
diff --git a/searx/plugins/__init__.py b/searx/plugins/__init__.py
@@ -20,7 +20,7 @@ from searx import logger
logger = logger.getChild('plugins')
from searx.plugins import (https_rewrite,
- self_ip,
+ self_info,
search_on_category_select)
required_attrs = (('name', str),
@@ -71,5 +71,5 @@ class PluginStore():
plugins = PluginStore()
plugins.register(https_rewrite)
-plugins.register(self_ip)
+plugins.register(self_info)
plugins.register(search_on_category_select)
diff --git a/searx/plugins/self_info.py b/searx/plugins/self_info.py
@@ -0,0 +1,44 @@
+'''
+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, <asciimoo@gmail.com>
+'''
+from flask.ext.babel import gettext
+import re
+name = "Self Informations"
+description = gettext('Displays your IP if the query is "ip" and your user agent if the query contains "user agent".')
+default_on = True
+
+
+# Self User Agent 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 ctx['search'].query == 'ip':
+ x_forwarded_for = request.headers.getlist("X-Forwarded-For")
+ if x_forwarded_for:
+ ip = x_forwarded_for[0]
+ else:
+ ip = request.remote_addr
+ ctx['search'].answers.clear()
+ ctx['search'].answers.add(ip)
+ elif p.match(ctx['search'].query):
+ ua = request.user_agent
+ ctx['search'].answers.clear()
+ ctx['search'].answers.add(ua)
+ return True
diff --git a/searx/plugins/self_ip.py b/searx/plugins/self_ip.py
@@ -1,35 +0,0 @@
-'''
-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, <asciimoo@gmail.com>
-'''
-from flask.ext.babel import gettext
-name = "Self IP"
-description = gettext('Display your source IP address if the query expression is "ip"')
-default_on = True
-
-
-# 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 ctx['search'].query == 'ip':
- x_forwarded_for = request.headers.getlist("X-Forwarded-For")
- if x_forwarded_for:
- ip = x_forwarded_for[0]
- else:
- ip = request.remote_addr
- ctx['search'].answers.clear()
- ctx['search'].answers.add(ip)
- return True
diff --git a/searx/tests/test_plugins.py b/searx/tests/test_plugins.py
@@ -38,10 +38,11 @@ class SelfIPTest(SearxTestCase):
def test_PluginStore_init(self):
store = plugins.PluginStore()
- store.register(plugins.self_ip)
+ store.register(plugins.self_info)
self.assertTrue(len(store.plugins) == 1)
+ # IP test
request = Mock(user_plugins=store.plugins,
remote_addr='127.0.0.1')
request.headers.getlist.return_value = []
@@ -49,3 +50,19 @@ 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)
+ ctx = {'search': Mock(answers=set(),
+ query='What is my User-Agent?')}
+ store.call('post_search', request, ctx)
