mirror of https://github.com/searxng/searxng
Merge branch 'plugins'
commit
bd92b43449
@ -0,0 +1,48 @@
|
||||
from searx.plugins import self_ip
|
||||
from searx import logger
|
||||
from sys import exit
|
||||
|
||||
logger = logger.getChild('plugins')
|
||||
|
||||
required_attrs = (('name', str),
|
||||
('description', str),
|
||||
('default_on', bool))
|
||||
|
||||
|
||||
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)
|
||||
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(self_ip)
|
@ -0,0 +1,21 @@
|
||||
from flask.ext.babel import gettext
|
||||
name = "Self IP"
|
||||
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")
|
||||
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 prevents exeecution of the original block
|
||||
return False
|
||||
return True
|
@ -0,0 +1,51 @@
|
||||
# -*- coding: utf-8 -*-
|
||||
|
||||
from searx.testing import SearxTestCase
|
||||
from searx import plugins
|
||||
from mock import Mock
|
||||
|
||||
|
||||
class PluginStoreTest(SearxTestCase):
|
||||
|
||||
def test_PluginStore_init(self):
|
||||
store = plugins.PluginStore()
|
||||
self.assertTrue(isinstance(store.plugins, list) and len(store.plugins) == 0)
|
||||
|
||||
def test_PluginStore_register(self):
|
||||
store = plugins.PluginStore()
|
||||
testplugin = plugins.Plugin()
|
||||
store.register(testplugin)
|
||||
|
||||
self.assertTrue(len(store.plugins) == 1)
|
||||
|
||||
def test_PluginStore_call(self):
|
||||
store = plugins.PluginStore()
|
||||
testplugin = plugins.Plugin()
|
||||
store.register(testplugin)
|
||||
setattr(testplugin, 'asdf', Mock())
|
||||
request = Mock(user_plugins=[])
|
||||
store.call('asdf', request, Mock())
|
||||
|
||||
self.assertFalse(testplugin.asdf.called)
|
||||
|
||||
request.user_plugins.append(testplugin)
|
||||
store.call('asdf', request, Mock())
|
||||
|
||||
self.assertTrue(testplugin.asdf.called)
|
||||
|
||||
|
||||
class SelfIPTest(SearxTestCase):
|
||||
|
||||
def test_PluginStore_init(self):
|
||||
store = plugins.PluginStore()
|
||||
store.register(plugins.self_ip)
|
||||
|
||||
self.assertTrue(len(store.plugins) == 1)
|
||||
|
||||
request = Mock(user_plugins=store.plugins,
|
||||
remote_addr='127.0.0.1')
|
||||
request.headers.getlist.return_value = []
|
||||
ctx = {'search': Mock(answers=set(),
|
||||
query='ip')}
|
||||
store.call('pre_search', request, ctx)
|
||||
self.assertTrue('127.0.0.1' in ctx['search'].answers)
|
Loading…
Reference in New Issue