From 00cc4dcbf44d9ecea89befb08cae4ee5561c4247 Mon Sep 17 00:00:00 2001 From: Adam Tauber Date: Tue, 10 Mar 2015 19:55:22 +0100 Subject: [PATCH] [enh] plugin support basics ++ self ip plugin --- searx/plugins/__init__.py | 46 +++++++++++++++++++++++++++++++++++++++ searx/plugins/self_ip.py | 17 +++++++++++++++ searx/webapp.py | 29 ++++++++++++++---------- 3 files changed, 80 insertions(+), 12 deletions(-) create mode 100644 searx/plugins/__init__.py create mode 100644 searx/plugins/self_ip.py 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 diff --git a/searx/webapp.py b/searx/webapp.py index f71df796a..f5d779f15 100644 --- a/searx/webapp.py +++ b/searx/webapp.py @@ -27,6 +27,18 @@ import cStringIO import os import hashlib +from searx import logger +logger = logger.getChild('webapp') + +try: + from pygments import highlight + from pygments.lexers import get_lexer_by_name + from pygments.formatters import HtmlFormatter +except: + logger.critical("cannot import dependency: pygments") + from sys import exit + exit(1) + from datetime import datetime, timedelta from urllib import urlencode from werkzeug.contrib.fixers import ProxyFix @@ -51,19 +63,9 @@ from searx.https_rewrite import https_url_rewrite from searx.search import Search from searx.query import Query from searx.autocomplete import searx_bang, backends as autocomplete_backends -from searx import logger -try: - from pygments import highlight - from pygments.lexers import get_lexer_by_name - from pygments.formatters import HtmlFormatter -except: - logger.critical("cannot import dependency: pygments") - from sys import exit - exit(1) +from searx.plugins import plugins -logger = logger.getChild('webapp') - static_path, templates_path, themes =\ get_themes(settings['themes_path'] if settings.get('themes_path') @@ -323,7 +325,10 @@ def index(): 'index.html', ) - search.search(request) + if plugins.call('pre_search', request, locals()): + search.search(request) + + plugins.call('post_search', request, locals()) for result in search.results: