searxng/searx/plugins/__init__.py

76 lines
2.5 KiB
Python
Raw Normal View History

2015-04-12 22:08:04 +00:00
'''
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
2015-04-12 22:30:12 +00:00
from searx import logger
logger = logger.getChild('plugins')
2015-04-12 22:30:12 +00:00
from searx.plugins import (https_rewrite,
self,
2015-04-12 22:30:12 +00:00
search_on_category_select)
2015-03-14 19:22:26 +00:00
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'
2015-03-14 19:22:26 +00:00
description = 'Default plugin description'
class PluginStore():
def __init__(self):
self.plugins = []
def __iter__(self):
2015-03-10 19:44:02 +00:00
for plugin in self.plugins:
yield plugin
def register(self, *plugins):
for plugin in plugins:
2015-03-14 19:22:26 +00:00
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())
2015-03-11 00:42:25 +00:00
plugin.id = plugin.name.replace(' ', '_')
self.plugins.append(plugin)
def call(self, plugin_type, request, *args, **kwargs):
ret = True
2015-03-10 19:44:02 +00:00
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()
2015-04-12 22:30:12 +00:00
plugins.register(https_rewrite)
plugins.register(self)
plugins.register(search_on_category_select)