searxng/searx/engines/__init__.py

324 lines
11 KiB
Python
Raw Normal View History

2013-10-14 21:09:13 +00:00
2013-10-16 22:32:32 +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) 2013- by Adam Tauber, <asciimoo@gmail.com>
'''
2013-10-14 21:09:13 +00:00
from os.path import realpath, dirname, splitext, join
from imp import load_source
2013-10-15 16:19:06 +00:00
import grequests
2013-10-15 21:20:26 +00:00
from itertools import izip_longest, chain
from operator import itemgetter
2013-10-19 15:36:44 +00:00
from urlparse import urlparse
2013-10-19 17:01:06 +00:00
from searx import settings
2014-01-18 20:53:59 +00:00
from searx.utils import gen_useragent
2013-10-23 21:54:46 +00:00
import sys
from datetime import datetime
2014-01-21 23:17:49 +00:00
from flask.ext.babel import gettext
2013-10-14 21:09:13 +00:00
engine_dir = dirname(realpath(__file__))
2013-10-23 21:54:46 +00:00
2013-10-27 12:55:18 +00:00
number_of_searches = 0
2013-10-14 21:09:13 +00:00
2013-10-15 17:11:43 +00:00
engines = {}
2013-10-14 21:09:13 +00:00
2013-10-17 19:06:28 +00:00
categories = {'general': []}
engine_shortcuts = {}
2013-10-23 21:54:46 +00:00
def load_module(filename):
2013-10-19 17:01:06 +00:00
modname = splitext(filename)[0]
2013-10-23 21:54:46 +00:00
if modname in sys.modules:
del sys.modules[modname]
2013-10-14 21:09:13 +00:00
filepath = join(engine_dir, filename)
2013-10-23 21:54:46 +00:00
module = load_source(modname, filepath)
module.name = modname
return module
if not 'engines' in settings or not settings['engines']:
print '[E] Error no engines found. Edit your settings.yml'
2013-10-26 16:44:58 +00:00
exit(2)
for engine_data in settings['engines']:
engine_name = engine_data['engine']
engine = load_module(engine_name + '.py')
2014-01-31 03:35:23 +00:00
2013-10-23 21:54:46 +00:00
for param_name in engine_data:
if param_name == 'engine':
continue
if param_name == 'categories':
if engine_data['categories'] == 'none':
engine.categories = []
else:
engine.categories = map(
str.strip, engine_data['categories'].split(','))
2013-10-23 21:54:46 +00:00
continue
setattr(engine, param_name, engine_data[param_name])
if not hasattr(engine, 'paging'):
engine.paging = False
if not hasattr(engine, 'language_support'):
#engine.language_support = False
engine.language_support = True
if not hasattr(engine, 'shortcut'):
#engine.language_support = False
engine.shortcut = ''
# checking required variables
2013-10-25 21:41:14 +00:00
for engine_attr in dir(engine):
if engine_attr.startswith('_'):
continue
2014-01-20 01:31:20 +00:00
if getattr(engine, engine_attr) is None:
print '[E] Engine config error: Missing attribute "{0}.{1}"'.format(engine.name, engine_attr) # noqa
2013-10-25 21:41:14 +00:00
sys.exit(1)
2013-10-23 21:54:46 +00:00
engines[engine.name] = engine
engine.stats = {
'result_count': 0,
'search_count': 0,
'page_load_time': 0,
'score_count': 0,
'errors': 0
}
2013-10-23 21:54:46 +00:00
if hasattr(engine, 'categories'):
2013-10-17 19:06:28 +00:00
for category_name in engine.categories:
categories.setdefault(category_name, []).append(engine)
2013-10-23 21:54:46 +00:00
else:
categories['general'].append(engine)
2013-10-15 16:19:06 +00:00
if engine.shortcut:
# TODO check duplications
engine_shortcuts[engine.shortcut] = engine.name
2013-10-15 16:19:06 +00:00
def default_request_params():
return {
'method': 'GET', 'headers': {}, 'data': {}, 'url': '', 'cookies': {}}
2013-10-15 16:19:06 +00:00
2013-11-13 18:32:46 +00:00
def make_callback(engine_name, results, suggestions, callback, params):
# creating a callback wrapper for the search engine results
2013-10-15 16:19:06 +00:00
def process_callback(response, **kwargs):
2013-10-15 21:20:26 +00:00
cb_res = []
2013-10-26 00:21:55 +00:00
response.search_params = params
engines[engine_name].stats['page_load_time'] += \
(datetime.now() - params['started']).total_seconds()
try:
search_results = callback(response)
except Exception, e:
engines[engine_name].stats['errors'] += 1
results[engine_name] = cb_res
print '[E] Error with engine "{0}":\n\t{1}'.format(
engine_name, str(e))
return
for result in search_results:
2013-10-15 17:11:43 +00:00
result['engine'] = engine_name
2013-11-13 18:32:46 +00:00
if 'suggestion' in result:
# TODO type checks
suggestions.add(result['suggestion'])
continue
2013-10-15 21:20:26 +00:00
cb_res.append(result)
results[engine_name] = cb_res
2013-10-15 16:19:06 +00:00
return process_callback
2013-11-12 20:34:28 +00:00
def score_results(results):
flat_res = filter(
None, chain.from_iterable(izip_longest(*results.values())))
2013-11-12 20:34:28 +00:00
flat_len = len(flat_res)
engines_len = len(results)
results = []
# deduplication + scoring
for i, res in enumerate(flat_res):
2013-11-12 20:34:28 +00:00
res['parsed_url'] = urlparse(res['url'])
res['engines'] = [res['engine']]
weight = 1.0
if hasattr(engines[res['engine']], 'weight'):
weight = float(engines[res['engine']].weight)
score = int((flat_len - i) / engines_len) * weight + 1
2013-11-12 20:34:28 +00:00
duplicated = False
for new_res in results:
p1 = res['parsed_url'].path[:-1] if res['parsed_url'].path.endswith('/') else res['parsed_url'].path # noqa
p2 = new_res['parsed_url'].path[:-1] if new_res['parsed_url'].path.endswith('/') else new_res['parsed_url'].path # noqa
2013-11-12 20:34:28 +00:00
if res['parsed_url'].netloc == new_res['parsed_url'].netloc and\
p1 == p2 and\
res['parsed_url'].query == new_res['parsed_url'].query and\
res.get('template') == new_res.get('template'):
duplicated = new_res
break
if duplicated:
if len(res.get('content', '')) > len(duplicated.get('content', '')): # noqa
2013-11-12 20:34:28 +00:00
duplicated['content'] = res['content']
duplicated['score'] += score
duplicated['engines'].append(res['engine'])
if duplicated['parsed_url'].scheme == 'https':
continue
elif res['parsed_url'].scheme == 'https':
duplicated['url'] = res['parsed_url'].geturl()
duplicated['parsed_url'] = res['parsed_url']
else:
res['score'] = score
results.append(res)
return sorted(results, key=itemgetter('score'), reverse=True)
2014-01-31 03:35:23 +00:00
def search(query, request, selected_engines, pageno=1, lang='all'):
2013-10-27 12:55:18 +00:00
global engines, categories, number_of_searches
2013-10-15 16:19:06 +00:00
requests = []
2013-10-15 21:20:26 +00:00
results = {}
2013-11-13 18:32:46 +00:00
suggestions = set()
2013-10-27 12:55:18 +00:00
number_of_searches += 1
2014-01-12 19:13:14 +00:00
#user_agent = request.headers.get('User-Agent', '')
2014-01-18 20:53:59 +00:00
user_agent = gen_useragent()
2013-11-02 23:40:45 +00:00
2013-10-22 16:57:20 +00:00
for selected_engine in selected_engines:
if selected_engine['name'] not in engines:
2013-10-15 20:18:08 +00:00
continue
2013-11-02 23:40:45 +00:00
2013-10-22 16:57:20 +00:00
engine = engines[selected_engine['name']]
2013-11-02 23:40:45 +00:00
2014-01-29 19:52:04 +00:00
if pageno > 1 and not engine.paging:
continue
2014-01-31 03:35:23 +00:00
if lang != 'all' and not engine.language_support:
continue
2013-10-20 18:20:10 +00:00
request_params = default_request_params()
request_params['headers']['User-Agent'] = user_agent
2013-10-22 16:57:20 +00:00
request_params['category'] = selected_engine['category']
request_params['started'] = datetime.now()
2014-01-29 19:52:04 +00:00
request_params['pageno'] = pageno
2014-01-31 03:35:23 +00:00
request_params['language'] = lang
2013-10-20 18:20:10 +00:00
request_params = engine.request(query, request_params)
2013-11-02 23:40:45 +00:00
callback = make_callback(
selected_engine['name'],
results,
suggestions,
engine.response,
request_params
)
request_args = dict(
headers=request_params['headers'],
hooks=dict(response=callback),
cookies=request_params['cookies'],
timeout=settings['server']['request_timeout']
)
2013-11-02 23:40:45 +00:00
2013-10-15 16:19:06 +00:00
if request_params['method'] == 'GET':
2013-11-02 23:40:45 +00:00
req = grequests.get
2013-10-15 16:19:06 +00:00
else:
2013-11-02 23:40:45 +00:00
req = grequests.post
request_args['data'] = request_params['data']
2013-11-04 20:06:53 +00:00
# ignoring empty urls
if not request_params['url']:
continue
2013-11-02 23:40:45 +00:00
requests.append(req(request_params['url'], **request_args))
2013-10-15 16:19:06 +00:00
grequests.map(requests)
for engine_name, engine_results in results.items():
2013-10-26 23:02:28 +00:00
engines[engine_name].stats['search_count'] += 1
engines[engine_name].stats['result_count'] += len(engine_results)
2013-11-12 20:34:28 +00:00
results = score_results(results)
2013-10-27 13:39:23 +00:00
for result in results:
for res_engine in result['engines']:
engines[result['engine']].stats['score_count'] += result['score']
2013-11-13 18:32:46 +00:00
return results, suggestions
2013-10-26 23:02:28 +00:00
2013-10-26 23:02:28 +00:00
def get_engines_stats():
2014-01-05 22:13:53 +00:00
# TODO refactor
2013-10-27 00:50:24 +00:00
pageloads = []
results = []
2013-10-27 13:21:23 +00:00
scores = []
errors = []
2014-01-05 22:13:53 +00:00
scores_per_result = []
2013-10-26 23:02:28 +00:00
max_pageload = max_results = max_score = max_errors = max_score_per_result = 0 # noqa
2013-10-26 23:02:28 +00:00
for engine in engines.values():
if engine.stats['search_count'] == 0:
continue
results_num = \
engine.stats['result_count'] / float(engine.stats['search_count'])
load_times = engine.stats['page_load_time'] / float(engine.stats['search_count']) # noqa
2013-10-27 13:21:23 +00:00
if results_num:
score = engine.stats['score_count'] / float(engine.stats['search_count']) # noqa
2014-01-05 22:13:53 +00:00
score_per_result = score / results_num
2013-10-27 13:21:23 +00:00
else:
2014-01-05 22:13:53 +00:00
score = score_per_result = 0.0
2013-10-27 00:50:24 +00:00
max_results = max(results_num, max_results)
max_pageload = max(load_times, max_pageload)
2013-10-27 13:21:23 +00:00
max_score = max(score, max_score)
2014-01-05 22:13:53 +00:00
max_score_per_result = max(score_per_result, max_score_per_result)
max_errors = max(max_errors, engine.stats['errors'])
2013-10-27 00:50:24 +00:00
pageloads.append({'avg': load_times, 'name': engine.name})
results.append({'avg': results_num, 'name': engine.name})
2013-10-27 13:21:23 +00:00
scores.append({'avg': score, 'name': engine.name})
errors.append({'avg': engine.stats['errors'], 'name': engine.name})
scores_per_result.append({
'avg': score_per_result,
'name': engine.name
})
2013-10-27 00:50:24 +00:00
for engine in pageloads:
engine['percentage'] = int(engine['avg'] / max_pageload * 100)
2013-10-27 00:50:24 +00:00
for engine in results:
engine['percentage'] = int(engine['avg'] / max_results * 100)
2013-10-27 00:50:24 +00:00
2013-10-27 13:21:23 +00:00
for engine in scores:
engine['percentage'] = int(engine['avg'] / max_score * 100)
2013-10-27 13:21:23 +00:00
2014-01-05 22:13:53 +00:00
for engine in scores_per_result:
engine['percentage'] = int(engine['avg'] / max_score_per_result * 100)
2014-01-05 22:13:53 +00:00
for engine in errors:
if max_errors:
engine['percentage'] = int(float(engine['avg']) / max_errors * 100)
else:
engine['percentage'] = 0
return [
(
2014-01-21 23:17:49 +00:00
gettext('Page loads (sec)'),
sorted(pageloads, key=itemgetter('avg'))
),
(
gettext('Number of results'),
sorted(results, key=itemgetter('avg'), reverse=True)
),
(
2014-01-21 23:17:49 +00:00
gettext('Scores'),
sorted(scores, key=itemgetter('avg'), reverse=True)
),
(
gettext('Scores per result'),
sorted(scores_per_result, key=itemgetter('avg'), reverse=True)
),
2014-01-21 23:17:49 +00:00
(
gettext('Errors'),
sorted(errors, key=itemgetter('avg'), reverse=True)
),
]