[enh] plugin support basics ++ self ip plugin

2 files changed, 63 insertions, 0 deletions

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