From 00cc4dcbf44d9ecea89befb08cae4ee5561c4247 Mon Sep 17 00:00:00 2001 From: Adam Tauber Date: Tue, 10 Mar 2015 19:55:22 +0100 Subject: [enh] plugin support basics ++ self ip plugin --- searx/plugins/__init__.py | 46 ++++++++++++++++++++++++++++++++++++++++++++++ searx/plugins/self_ip.py | 17 +++++++++++++++++ 2 files changed, 63 insertions(+) create mode 100644 searx/plugins/__init__.py create mode 100644 searx/plugins/self_ip.py (limited to 'searx/plugins') diff --git a/searx/plugins/__init__.py b/searx/plugins/__init__.py new file mode 100644 index 000000000..b40d2ee89 --- /dev/null +++ b/searx/plugins/__init__.py @@ -0,0 +1,46 @@ +from searx.plugins import self_ip +from searx import logger +from sys import exit + +logger = logger.getChild('plugins') + +required_attrs = ('name', + 'description', + 'default_on') + + +class Plugin(): + default_on = False + name = 'Default plugin' + + +class PluginStore(): + + def __init__(self): + self.plugins = [] + + def __iter__(self): + for plugin in plugins: + yield plugin + + def register(self, *plugins): + for plugin in plugins: + for plugin_attr in required_attrs: + if not hasattr(plugin, plugin_attr): + logger.critical('missing attribute "{0}", cannot load plugin: {1}'.format(plugin_attr, plugin)) + exit(3) + self.plugins.append(plugin) + + def call(self, plugin_type, request, *args, **kwargs): + ret = True + for plugin in self.plugins: + if hasattr(plugin, plugin_type): + ret = getattr(plugin, plugin_type)(request, *args, **kwargs) + if not ret: + break + + return ret + + +plugins = PluginStore() +plugins.register(self_ip) diff --git a/searx/plugins/self_ip.py b/searx/plugins/self_ip.py new file mode 100644 index 000000000..0db6c08df --- /dev/null +++ b/searx/plugins/self_ip.py @@ -0,0 +1,17 @@ + +name = "Self IP" +description = "" +default_on = True + + +def pre_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 False + return True -- cgit v1.2.3 From cae22bfc7609d00f987e679cf6d048873d268d84 Mon Sep 17 00:00:00 2001 From: Adam Tauber Date: Tue, 10 Mar 2015 20:44:02 +0100 Subject: [enh] per user plugin switch --- searx/plugins/__init__.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'searx/plugins') diff --git a/searx/plugins/__init__.py b/searx/plugins/__init__.py index b40d2ee89..9c9c52ae4 100644 --- a/searx/plugins/__init__.py +++ b/searx/plugins/__init__.py @@ -20,7 +20,7 @@ class PluginStore(): self.plugins = [] def __iter__(self): - for plugin in plugins: + for plugin in self.plugins: yield plugin def register(self, *plugins): @@ -33,7 +33,7 @@ class PluginStore(): def call(self, plugin_type, request, *args, **kwargs): ret = True - for plugin in self.plugins: + for plugin in request.user_plugins: if hasattr(plugin, plugin_type): ret = getattr(plugin, plugin_type)(request, *args, **kwargs) if not ret: -- cgit v1.2.3 From 9cb66be29c287357e9b7135fe8840aa8b5979972 Mon Sep 17 00:00:00 2001 From: Adam Tauber Date: Wed, 11 Mar 2015 01:42:25 +0100 Subject: [enh] plugin id --- searx/plugins/__init__.py | 1 + 1 file changed, 1 insertion(+) (limited to 'searx/plugins') diff --git a/searx/plugins/__init__.py b/searx/plugins/__init__.py index 9c9c52ae4..61ec211e4 100644 --- a/searx/plugins/__init__.py +++ b/searx/plugins/__init__.py @@ -29,6 +29,7 @@ class PluginStore(): if not hasattr(plugin, plugin_attr): logger.critical('missing attribute "{0}", cannot load plugin: {1}'.format(plugin_attr, plugin)) exit(3) + plugin.id = plugin.name.replace(' ', '_') self.plugins.append(plugin) def call(self, plugin_type, request, *args, **kwargs): -- cgit v1.2.3 From 9eeb36c787f012f525cbe9c53495a7542bd9eb16 Mon Sep 17 00:00:00 2001 From: Adam Tauber Date: Wed, 11 Mar 2015 01:44:33 +0100 Subject: [enh] selfip plugin description --- searx/plugins/self_ip.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'searx/plugins') diff --git a/searx/plugins/self_ip.py b/searx/plugins/self_ip.py index 0db6c08df..0aec996ab 100644 --- a/searx/plugins/self_ip.py +++ b/searx/plugins/self_ip.py @@ -1,6 +1,6 @@ name = "Self IP" -description = "" +description = "Display your source IP address" default_on = True -- cgit v1.2.3 From 13ea0a20ae222c51d7aac6f751124e484bc1cae3 Mon Sep 17 00:00:00 2001 From: Adam Tauber Date: Sat, 14 Mar 2015 19:45:15 +0100 Subject: [enh] gettext in self ip plugin --- searx/plugins/self_ip.py | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) (limited to 'searx/plugins') diff --git a/searx/plugins/self_ip.py b/searx/plugins/self_ip.py index 0aec996ab..0353be79a 100644 --- a/searx/plugins/self_ip.py +++ b/searx/plugins/self_ip.py @@ -1,9 +1,12 @@ - +from flask.ext.babel import gettext name = "Self IP" -description = "Display your source IP address" +description = gettext('Display your source IP address if the query expression is "ip"') default_on = True +# attach callback to the pre search hook +# request: flask request object +# ctx: the whole local context of the pre search hook def pre_search(request, ctx): if ctx['search'].query == 'ip': x_forwarded_for = request.headers.getlist("X-Forwarded-For") @@ -13,5 +16,6 @@ def pre_search(request, ctx): ip = request.remote_addr ctx['search'].answers.clear() ctx['search'].answers.add(ip) + # return False prevents exeecution of the original block return False return True -- cgit v1.2.3 From bf5d6f56c66feb3cac760f0f30cf4585a2e6134e Mon Sep 17 00:00:00 2001 From: Adam Tauber Date: Sat, 14 Mar 2015 20:22:26 +0100 Subject: [enh] plugin attribute type check --- searx/plugins/__init__.py | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) (limited to 'searx/plugins') diff --git a/searx/plugins/__init__.py b/searx/plugins/__init__.py index 61ec211e4..1cc232560 100644 --- a/searx/plugins/__init__.py +++ b/searx/plugins/__init__.py @@ -4,14 +4,15 @@ from sys import exit logger = logger.getChild('plugins') -required_attrs = ('name', - 'description', - 'default_on') +required_attrs = (('name', str), + ('description', str), + ('default_on', bool)) class Plugin(): default_on = False name = 'Default plugin' + description = 'Default plugin description' class PluginStore(): @@ -25,8 +26,8 @@ class PluginStore(): def register(self, *plugins): for plugin in plugins: - for plugin_attr in required_attrs: - if not hasattr(plugin, plugin_attr): + for plugin_attr, plugin_attr_type in required_attrs: + if not hasattr(plugin, plugin_attr) or not isinstance(getattr(plugin, plugin_attr), plugin_attr_type): logger.critical('missing attribute "{0}", cannot load plugin: {1}'.format(plugin_attr, plugin)) exit(3) plugin.id = plugin.name.replace(' ', '_') -- cgit v1.2.3