From 67e11c42b973932c8f568d80a0f25bfd7fc150ab Mon Sep 17 00:00:00 2001 From: dalf Date: Sat, 22 Oct 2016 13:10:31 +0200 Subject: Clean up the architecture Purposes : - isolate the plugins calls - distinction between parsing the web request and running the search (Search class). To be able to test code easily, to run searx code outside a web server, to filter the search query parameters with plugins more easily, etc... Details : - request.request_data contains request.form or request.args (initialize inside pre_request() function) - Query class is renamed RawTextQuery - SearchQuery class defines all search parameters - get_search_query_from_webapp create a SearchQuery instance (basically the previous Search.__init__ code) - Search class and SearchWithPlugins class takes a SearchQuery instance as class constructor parameter - SearchWithPlugins class inherites from Search class, and run plugins - A dedicated function search_with_plugins executes plugins to have a well define locals() (which is used by the plugins code). - All plugins code is executed inside the try...except block (webapp.py, index function) - advanced_search HTTP parameter value stays in webapp.py (it is only part of UI) - multiple calls to result_container.get_ordered_results() doesn't compute the order multiple time (note : this method was call only once before) - paging value is stored in the result_container class (compute in the extend method) - test about engine.suspend_end_time is done during search method call (instead of __init__) - check that the format parameter value is one of these : html, rss, json, rss (before the html value was assumed but some text formatting wasn't not done) --- searx/plugins/self_info.py | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) (limited to 'searx/plugins/self_info.py') diff --git a/searx/plugins/self_info.py b/searx/plugins/self_info.py index 438274c41..2f19ad9c7 100644 --- a/searx/plugins/self_info.py +++ b/searx/plugins/self_info.py @@ -37,10 +37,10 @@ def post_search(request, ctx): ip = x_forwarded_for[0] else: ip = request.remote_addr - ctx['search'].result_container.answers.clear() - ctx['search'].result_container.answers.add(ip) + ctx['result_container'].answers.clear() + ctx['result_container'].answers.add(ip) elif p.match(ctx['search'].query): ua = request.user_agent - ctx['search'].result_container.answers.clear() - ctx['search'].result_container.answers.add(ua) + ctx['result_container'].answers.clear() + ctx['result_container'].answers.add(ua) return True -- cgit v1.2.3 From fbb080f3588ad43bf896a569257f3a95e1181d7b Mon Sep 17 00:00:00 2001 From: dalf Date: Sat, 22 Oct 2016 14:01:53 +0200 Subject: Change plugin API : - pre_search(request, search) - post_search(request, search) - on_result(request, search, result) with - request is the Flask request - search a searx.Search instance - result a searx result as usual --- searx/plugins/self_info.py | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) (limited to 'searx/plugins/self_info.py') diff --git a/searx/plugins/self_info.py b/searx/plugins/self_info.py index 2f19ad9c7..a2aeda98e 100644 --- a/searx/plugins/self_info.py +++ b/searx/plugins/self_info.py @@ -28,19 +28,19 @@ p = re.compile('.*user[ -]agent.*', re.IGNORECASE) # attach callback to the post search hook # request: flask request object # ctx: the whole local context of the pre search hook -def post_search(request, ctx): - if ctx['search'].pageno > 1: +def post_search(request, search): + if search.search_query.pageno > 1: return True - if ctx['search'].query == 'ip': + if search.search_query.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['result_container'].answers.clear() - ctx['result_container'].answers.add(ip) - elif p.match(ctx['search'].query): + search.result_container.answers.clear() + search.result_container.answers.add(ip) + elif p.match(search.search_query.query): ua = request.user_agent - ctx['result_container'].answers.clear() - ctx['result_container'].answers.add(ua) + search.result_container.answers.clear() + search.result_container.answers.add(ua) return True -- cgit v1.2.3