summaryrefslogtreecommitdiff
path: root/searx/plugins/__init__.py
diff options
context:
space:
mode:
Diffstat (limited to 'searx/plugins/__init__.py')
-rw-r--r--searx/plugins/__init__.py75
1 files changed, 75 insertions, 0 deletions
diff --git a/searx/plugins/__init__.py b/searx/plugins/__init__.py
new file mode 100644
index 000000000..5ac3f447c
--- /dev/null
+++ b/searx/plugins/__init__.py
@@ -0,0 +1,75 @@
+'''
+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 sys import exit
+from searx import logger
+
+logger = logger.getChild('plugins')
+
+from searx.plugins import (https_rewrite,
+ self_ip,
+ search_on_category_select)
+
+required_attrs = (('name', str),
+ ('description', str),
+ ('default_on', bool))
+
+optional_attrs = (('js_dependencies', tuple),
+ ('css_dependencies', tuple))
+
+
+class Plugin():
+ default_on = False
+ name = 'Default plugin'
+ description = 'Default plugin description'
+
+
+class PluginStore():
+
+ def __init__(self):
+ self.plugins = []
+
+ def __iter__(self):
+ for plugin in self.plugins:
+ yield plugin
+
+ def register(self, *plugins):
+ for plugin in plugins:
+ 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)
+ for plugin_attr, plugin_attr_type in optional_attrs:
+ if not hasattr(plugin, plugin_attr) or not isinstance(getattr(plugin, plugin_attr), plugin_attr_type):
+ setattr(plugin, plugin_attr, plugin_attr_type())
+ plugin.id = plugin.name.replace(' ', '_')
+ self.plugins.append(plugin)
+
+ def call(self, plugin_type, request, *args, **kwargs):
+ ret = True
+ for plugin in request.user_plugins:
+ if hasattr(plugin, plugin_type):
+ ret = getattr(plugin, plugin_type)(request, *args, **kwargs)
+ if not ret:
+ break
+
+ return ret
+
+
+plugins = PluginStore()
+plugins.register(https_rewrite)
+plugins.register(self_ip)
+plugins.register(search_on_category_select)