webapp.py 35 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981
  1. #!/usr/bin/env python
  2. '''
  3. searx is free software: you can redistribute it and/or modify
  4. it under the terms of the GNU Affero General Public License as published by
  5. the Free Software Foundation, either version 3 of the License, or
  6. (at your option) any later version.
  7. searx is distributed in the hope that it will be useful,
  8. but WITHOUT ANY WARRANTY; without even the implied warranty of
  9. MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  10. GNU Affero General Public License for more details.
  11. You should have received a copy of the GNU Affero General Public License
  12. along with searx. If not, see < http://www.gnu.org/licenses/ >.
  13. (C) 2013- by Adam Tauber, <asciimoo@gmail.com>
  14. '''
  15. if __name__ == '__main__':
  16. from sys import path
  17. from os.path import realpath, dirname
  18. path.append(realpath(dirname(realpath(__file__)) + '/../'))
  19. import hashlib
  20. import hmac
  21. import json
  22. import os
  23. import sys
  24. import requests
  25. from searx import logger
  26. logger = logger.getChild('webapp')
  27. try:
  28. from pygments import highlight
  29. from pygments.lexers import get_lexer_by_name
  30. from pygments.formatters import HtmlFormatter
  31. except:
  32. logger.critical("cannot import dependency: pygments")
  33. from sys import exit
  34. exit(1)
  35. try:
  36. from cgi import escape
  37. except:
  38. from html import escape
  39. from datetime import datetime, timedelta
  40. from time import time
  41. from werkzeug.middleware.proxy_fix import ProxyFix
  42. from flask import (
  43. Flask, request, render_template, url_for, Response, make_response,
  44. redirect, send_from_directory
  45. )
  46. from flask_babel import Babel, gettext, format_date, format_decimal
  47. from flask.json import jsonify
  48. from searx import settings, searx_dir, searx_debug
  49. from searx.exceptions import SearxParameterException
  50. from searx.engines import (
  51. categories, engines, engine_shortcuts, get_engines_stats, initialize_engines
  52. )
  53. from searx.utils import (
  54. UnicodeWriter, highlight_content, html_to_text, get_resources_directory,
  55. get_static_files, get_result_templates, get_themes, gen_useragent,
  56. dict_subset, prettify_url, match_language
  57. )
  58. from searx.version import VERSION_STRING
  59. from searx.languages import language_codes as languages
  60. from searx.search import SearchWithPlugins, get_search_query_from_webapp
  61. from searx.query import RawTextQuery
  62. from searx.autocomplete import searx_bang, backends as autocomplete_backends
  63. from searx.plugins import plugins
  64. from searx.plugins.oa_doi_rewrite import get_doi_resolver
  65. from searx.preferences import Preferences, ValidationException, LANGUAGE_CODES
  66. from searx.answerers import answerers
  67. from searx.url_utils import urlencode, urlparse, urljoin
  68. from searx.utils import new_hmac
  69. # check if the pyopenssl package is installed.
  70. # It is needed for SSL connection without trouble, see #298
  71. try:
  72. import OpenSSL.SSL # NOQA
  73. except ImportError:
  74. logger.critical("The pyopenssl package has to be installed.\n"
  75. "Some HTTPS connections will fail")
  76. try:
  77. from cStringIO import StringIO
  78. except:
  79. from io import StringIO
  80. if sys.version_info[0] == 3:
  81. unicode = str
  82. PY3 = True
  83. else:
  84. PY3 = False
  85. logger.warning('\033[1;31m *** Deprecation Warning ***\033[0m')
  86. logger.warning('\033[1;31m Python2 is deprecated\033[0m')
  87. # serve pages with HTTP/1.1
  88. from werkzeug.serving import WSGIRequestHandler
  89. WSGIRequestHandler.protocol_version = "HTTP/{}".format(settings['server'].get('http_protocol_version', '1.0'))
  90. # about static
  91. static_path = get_resources_directory(searx_dir, 'static', settings['ui']['static_path'])
  92. logger.debug('static directory is %s', static_path)
  93. static_files = get_static_files(static_path)
  94. # about templates
  95. default_theme = settings['ui']['default_theme']
  96. templates_path = get_resources_directory(searx_dir, 'templates', settings['ui']['templates_path'])
  97. logger.debug('templates directory is %s', templates_path)
  98. themes = get_themes(templates_path)
  99. result_templates = get_result_templates(templates_path)
  100. global_favicons = []
  101. for indice, theme in enumerate(themes):
  102. global_favicons.append([])
  103. theme_img_path = os.path.join(static_path, 'themes', theme, 'img', 'icons')
  104. for (dirpath, dirnames, filenames) in os.walk(theme_img_path):
  105. global_favicons[indice].extend(filenames)
  106. # Flask app
  107. app = Flask(
  108. __name__,
  109. static_folder=static_path,
  110. template_folder=templates_path
  111. )
  112. app.jinja_env.trim_blocks = True
  113. app.jinja_env.lstrip_blocks = True
  114. app.jinja_env.add_extension('jinja2.ext.loopcontrols')
  115. app.secret_key = settings['server']['secret_key']
  116. if not searx_debug \
  117. or os.environ.get("WERKZEUG_RUN_MAIN") == "true" \
  118. or os.environ.get('UWSGI_ORIGINAL_PROC_NAME') is not None:
  119. initialize_engines(settings['engines'])
  120. babel = Babel(app)
  121. rtl_locales = ['ar', 'arc', 'bcc', 'bqi', 'ckb', 'dv', 'fa', 'glk', 'he',
  122. 'ku', 'mzn', 'pnb', 'ps', 'sd', 'ug', 'ur', 'yi']
  123. # used when translating category names
  124. _category_names = (gettext('files'),
  125. gettext('general'),
  126. gettext('music'),
  127. gettext('social media'),
  128. gettext('images'),
  129. gettext('videos'),
  130. gettext('it'),
  131. gettext('news'),
  132. gettext('map'),
  133. gettext('science'))
  134. outgoing_proxies = settings['outgoing'].get('proxies') or None
  135. @babel.localeselector
  136. def get_locale():
  137. if 'locale' in request.form\
  138. and request.form['locale'] in settings['locales']:
  139. return request.form['locale']
  140. if 'locale' in request.args\
  141. and request.args['locale'] in settings['locales']:
  142. return request.args['locale']
  143. if request.preferences.get_value('locale') != '':
  144. return request.preferences.get_value('locale')
  145. return request.accept_languages.best_match(settings['locales'].keys())
  146. # code-highlighter
  147. @app.template_filter('code_highlighter')
  148. def code_highlighter(codelines, language=None):
  149. if not language:
  150. language = 'text'
  151. try:
  152. # find lexer by programing language
  153. lexer = get_lexer_by_name(language, stripall=True)
  154. except:
  155. # if lexer is not found, using default one
  156. logger.debug('highlighter cannot find lexer for {0}'.format(language))
  157. lexer = get_lexer_by_name('text', stripall=True)
  158. html_code = ''
  159. tmp_code = ''
  160. last_line = None
  161. # parse lines
  162. for line, code in codelines:
  163. if not last_line:
  164. line_code_start = line
  165. # new codeblock is detected
  166. if last_line is not None and\
  167. last_line + 1 != line:
  168. # highlight last codepart
  169. formatter = HtmlFormatter(linenos='inline',
  170. linenostart=line_code_start)
  171. html_code = html_code + highlight(tmp_code, lexer, formatter)
  172. # reset conditions for next codepart
  173. tmp_code = ''
  174. line_code_start = line
  175. # add codepart
  176. tmp_code += code + '\n'
  177. # update line
  178. last_line = line
  179. # highlight last codepart
  180. formatter = HtmlFormatter(linenos='inline', linenostart=line_code_start)
  181. html_code = html_code + highlight(tmp_code, lexer, formatter)
  182. return html_code
  183. # Extract domain from url
  184. @app.template_filter('extract_domain')
  185. def extract_domain(url):
  186. return urlparse(url)[1]
  187. def get_base_url():
  188. if settings['server']['base_url']:
  189. hostname = settings['server']['base_url']
  190. else:
  191. scheme = 'http'
  192. if request.is_secure:
  193. scheme = 'https'
  194. hostname = url_for('index', _external=True, _scheme=scheme)
  195. return hostname
  196. def get_current_theme_name(override=None):
  197. """Returns theme name.
  198. Checks in this order:
  199. 1. override
  200. 2. cookies
  201. 3. settings"""
  202. if override and (override in themes or override == '__common__'):
  203. return override
  204. theme_name = request.args.get('theme', request.preferences.get_value('theme'))
  205. if theme_name not in themes:
  206. theme_name = default_theme
  207. return theme_name
  208. def get_result_template(theme, template_name):
  209. themed_path = theme + '/result_templates/' + template_name
  210. if themed_path in result_templates:
  211. return themed_path
  212. return 'result_templates/' + template_name
  213. def url_for_theme(endpoint, override_theme=None, **values):
  214. if endpoint == 'static' and values.get('filename'):
  215. theme_name = get_current_theme_name(override=override_theme)
  216. filename_with_theme = "themes/{}/{}".format(theme_name, values['filename'])
  217. if filename_with_theme in static_files:
  218. values['filename'] = filename_with_theme
  219. return url_for(endpoint, **values)
  220. def proxify(url):
  221. if url.startswith('//'):
  222. url = 'https:' + url
  223. if not settings.get('result_proxy'):
  224. return url
  225. url_params = dict(mortyurl=url.encode('utf-8'))
  226. if settings['result_proxy'].get('key'):
  227. url_params['mortyhash'] = hmac.new(settings['result_proxy']['key'],
  228. url.encode('utf-8'),
  229. hashlib.sha256).hexdigest()
  230. return '{0}?{1}'.format(settings['result_proxy']['url'],
  231. urlencode(url_params))
  232. def image_proxify(url):
  233. if url.startswith('//'):
  234. url = 'https:' + url
  235. if not request.preferences.get_value('image_proxy'):
  236. return url
  237. if url.startswith('data:image/jpeg;base64,'):
  238. return url
  239. if settings.get('result_proxy'):
  240. return proxify(url)
  241. h = new_hmac(settings['server']['secret_key'], url.encode('utf-8'))
  242. return '{0}?{1}'.format(url_for('image_proxy'),
  243. urlencode(dict(url=url.encode('utf-8'), h=h)))
  244. def render(template_name, override_theme=None, **kwargs):
  245. disabled_engines = request.preferences.engines.get_disabled()
  246. enabled_categories = set(category for engine_name in engines
  247. for category in engines[engine_name].categories
  248. if (engine_name, category) not in disabled_engines)
  249. if 'categories' not in kwargs:
  250. kwargs['categories'] = ['general']
  251. kwargs['categories'].extend(x for x in
  252. sorted(categories.keys())
  253. if x != 'general'
  254. and x in enabled_categories)
  255. if 'all_categories' not in kwargs:
  256. kwargs['all_categories'] = ['general']
  257. kwargs['all_categories'].extend(x for x in
  258. sorted(categories.keys())
  259. if x != 'general')
  260. if 'selected_categories' not in kwargs:
  261. kwargs['selected_categories'] = []
  262. for arg in request.args:
  263. if arg.startswith('category_'):
  264. c = arg.split('_', 1)[1]
  265. if c in categories:
  266. kwargs['selected_categories'].append(c)
  267. if not kwargs['selected_categories']:
  268. cookie_categories = request.preferences.get_value('categories')
  269. for ccateg in cookie_categories:
  270. kwargs['selected_categories'].append(ccateg)
  271. if not kwargs['selected_categories']:
  272. kwargs['selected_categories'] = ['general']
  273. if 'autocomplete' not in kwargs:
  274. kwargs['autocomplete'] = request.preferences.get_value('autocomplete')
  275. if get_locale() in rtl_locales and 'rtl' not in kwargs:
  276. kwargs['rtl'] = True
  277. kwargs['searx_version'] = VERSION_STRING
  278. kwargs['method'] = request.preferences.get_value('method')
  279. kwargs['safesearch'] = str(request.preferences.get_value('safesearch'))
  280. kwargs['language_codes'] = languages
  281. if 'current_language' not in kwargs:
  282. kwargs['current_language'] = match_language(request.preferences.get_value('language'),
  283. LANGUAGE_CODES,
  284. fallback=settings['search']['language'])
  285. # override url_for function in templates
  286. kwargs['url_for'] = url_for_theme
  287. kwargs['image_proxify'] = image_proxify
  288. kwargs['proxify'] = proxify if settings.get('result_proxy', {}).get('url') else None
  289. kwargs['get_result_template'] = get_result_template
  290. kwargs['theme'] = get_current_theme_name(override=override_theme)
  291. kwargs['template_name'] = template_name
  292. kwargs['cookies'] = request.cookies
  293. kwargs['errors'] = request.errors
  294. kwargs['instance_name'] = settings['general']['instance_name']
  295. kwargs['results_on_new_tab'] = request.preferences.get_value('results_on_new_tab')
  296. kwargs['unicode'] = unicode
  297. kwargs['preferences'] = request.preferences
  298. kwargs['scripts'] = set()
  299. for plugin in request.user_plugins:
  300. for script in plugin.js_dependencies:
  301. kwargs['scripts'].add(script)
  302. kwargs['styles'] = set()
  303. for plugin in request.user_plugins:
  304. for css in plugin.css_dependencies:
  305. kwargs['styles'].add(css)
  306. return render_template(
  307. '{}/{}'.format(kwargs['theme'], template_name), **kwargs)
  308. @app.before_request
  309. def pre_request():
  310. request.start_time = time()
  311. request.timings = []
  312. request.errors = []
  313. preferences = Preferences(themes, list(categories.keys()), engines, plugins)
  314. request.preferences = preferences
  315. try:
  316. preferences.parse_dict(request.cookies)
  317. except:
  318. request.errors.append(gettext('Invalid settings, please edit your preferences'))
  319. # merge GET, POST vars
  320. # request.form
  321. request.form = dict(request.form.items())
  322. for k, v in request.args.items():
  323. if k not in request.form:
  324. request.form[k] = v
  325. if request.form.get('preferences'):
  326. preferences.parse_encoded_data(request.form['preferences'])
  327. else:
  328. try:
  329. preferences.parse_dict(request.form)
  330. except Exception as e:
  331. logger.exception('invalid settings')
  332. request.errors.append(gettext('Invalid settings'))
  333. # request.user_plugins
  334. request.user_plugins = []
  335. allowed_plugins = preferences.plugins.get_enabled()
  336. disabled_plugins = preferences.plugins.get_disabled()
  337. for plugin in plugins:
  338. if ((plugin.default_on and plugin.id not in disabled_plugins)
  339. or plugin.id in allowed_plugins):
  340. request.user_plugins.append(plugin)
  341. @app.after_request
  342. def post_request(response):
  343. total_time = time() - request.start_time
  344. timings_all = ['total;dur=' + str(round(total_time * 1000, 3))]
  345. if len(request.timings) > 0:
  346. timings = sorted(request.timings, key=lambda v: v['total'])
  347. timings_total = ['total_' + str(i) + '_' + v['engine'] +
  348. ';dur=' + str(round(v['total'] * 1000, 3)) for i, v in enumerate(timings)]
  349. timings_load = ['load_' + str(i) + '_' + v['engine'] +
  350. ';dur=' + str(round(v['load'] * 1000, 3)) for i, v in enumerate(timings)]
  351. timings_all = timings_all + timings_total + timings_load
  352. response.headers.add('Server-Timing', ', '.join(timings_all))
  353. return response
  354. def index_error(output_format, error_message):
  355. if output_format == 'json':
  356. return Response(json.dumps({'error': error_message}),
  357. mimetype='application/json')
  358. elif output_format == 'csv':
  359. response = Response('', mimetype='application/csv')
  360. cont_disp = 'attachment;Filename=searx.csv'
  361. response.headers.add('Content-Disposition', cont_disp)
  362. return response
  363. elif output_format == 'rss':
  364. response_rss = render(
  365. 'opensearch_response_rss.xml',
  366. results=[],
  367. q=request.form['q'] if 'q' in request.form else '',
  368. number_of_results=0,
  369. base_url=get_base_url(),
  370. error_message=error_message,
  371. override_theme='__common__',
  372. )
  373. return Response(response_rss, mimetype='text/xml')
  374. else:
  375. # html
  376. request.errors.append(gettext('search error'))
  377. return render(
  378. 'index.html',
  379. )
  380. @app.route('/search', methods=['GET', 'POST'])
  381. @app.route('/', methods=['GET', 'POST'])
  382. def index():
  383. """Render index page.
  384. Supported outputs: html, json, csv, rss.
  385. """
  386. # output_format
  387. output_format = request.form.get('format', 'html')
  388. if output_format not in ['html', 'csv', 'json', 'rss']:
  389. output_format = 'html'
  390. # check if there is query
  391. if request.form.get('q') is None:
  392. if output_format == 'html':
  393. return render(
  394. 'index.html',
  395. )
  396. else:
  397. return index_error(output_format, 'No query'), 400
  398. # search
  399. search_query = None
  400. raw_text_query = None
  401. result_container = None
  402. try:
  403. search_query, raw_text_query = get_search_query_from_webapp(request.preferences, request.form)
  404. # search = Search(search_query) # without plugins
  405. search = SearchWithPlugins(search_query, request.user_plugins, request)
  406. result_container = search.search()
  407. except Exception as e:
  408. # log exception
  409. logger.exception('search error')
  410. # is it an invalid input parameter or something else ?
  411. if (issubclass(e.__class__, SearxParameterException)):
  412. return index_error(output_format, e.message), 400
  413. else:
  414. return index_error(output_format, gettext('search error')), 500
  415. # results
  416. results = result_container.get_ordered_results()
  417. number_of_results = result_container.results_number()
  418. if number_of_results < result_container.results_length():
  419. number_of_results = 0
  420. # UI
  421. advanced_search = request.form.get('advanced_search', None)
  422. # Server-Timing header
  423. request.timings = result_container.get_timings()
  424. # output
  425. for result in results:
  426. if output_format == 'html':
  427. if 'content' in result and result['content']:
  428. result['content'] = highlight_content(escape(result['content'][:1024]), search_query.query)
  429. if 'title' in result and result['title']:
  430. result['title'] = highlight_content(escape(result['title'] or u''), search_query.query)
  431. else:
  432. if result.get('content'):
  433. result['content'] = html_to_text(result['content']).strip()
  434. # removing html content and whitespace duplications
  435. result['title'] = ' '.join(html_to_text(result['title']).strip().split())
  436. if 'url' in result:
  437. result['pretty_url'] = prettify_url(result['url'])
  438. # TODO, check if timezone is calculated right
  439. if 'publishedDate' in result:
  440. try: # test if publishedDate >= 1900 (datetime module bug)
  441. result['pubdate'] = result['publishedDate'].strftime('%Y-%m-%d %H:%M:%S%z')
  442. except ValueError:
  443. result['publishedDate'] = None
  444. else:
  445. if result['publishedDate'].replace(tzinfo=None) >= datetime.now() - timedelta(days=1):
  446. timedifference = datetime.now() - result['publishedDate'].replace(tzinfo=None)
  447. minutes = int((timedifference.seconds / 60) % 60)
  448. hours = int(timedifference.seconds / 60 / 60)
  449. if hours == 0:
  450. result['publishedDate'] = gettext(u'{minutes} minute(s) ago').format(minutes=minutes)
  451. else:
  452. result['publishedDate'] = gettext(u'{hours} hour(s), {minutes} minute(s) ago').format(hours=hours, minutes=minutes) # noqa
  453. else:
  454. result['publishedDate'] = format_date(result['publishedDate'])
  455. if output_format == 'json':
  456. return Response(json.dumps({'query': search_query.query.decode('utf-8'),
  457. 'number_of_results': number_of_results,
  458. 'results': results,
  459. 'answers': list(result_container.answers),
  460. 'corrections': list(result_container.corrections),
  461. 'infoboxes': result_container.infoboxes,
  462. 'suggestions': list(result_container.suggestions),
  463. 'unresponsive_engines': list(result_container.unresponsive_engines)},
  464. default=lambda item: list(item) if isinstance(item, set) else item),
  465. mimetype='application/json')
  466. elif output_format == 'csv':
  467. csv = UnicodeWriter(StringIO())
  468. keys = ('title', 'url', 'content', 'host', 'engine', 'score')
  469. csv.writerow(keys)
  470. for row in results:
  471. row['host'] = row['parsed_url'].netloc
  472. csv.writerow([row.get(key, '') for key in keys])
  473. csv.stream.seek(0)
  474. response = Response(csv.stream.read(), mimetype='application/csv')
  475. cont_disp = 'attachment;Filename=searx_-_{0}.csv'.format(search_query.query)
  476. response.headers.add('Content-Disposition', cont_disp)
  477. return response
  478. elif output_format == 'rss':
  479. response_rss = render(
  480. 'opensearch_response_rss.xml',
  481. results=results,
  482. q=request.form['q'],
  483. number_of_results=number_of_results,
  484. base_url=get_base_url(),
  485. override_theme='__common__',
  486. )
  487. return Response(response_rss, mimetype='text/xml')
  488. # HTML output format
  489. # suggestions: use RawTextQuery to get the suggestion URLs with the same bang
  490. suggestion_urls = list(map(lambda suggestion: {
  491. 'url': raw_text_query.changeSearchQuery(suggestion).getFullQuery(),
  492. 'title': suggestion
  493. },
  494. result_container.suggestions))
  495. correction_urls = list(map(lambda correction: {
  496. 'url': raw_text_query.changeSearchQuery(correction).getFullQuery(),
  497. 'title': correction
  498. },
  499. result_container.corrections))
  500. #
  501. return render(
  502. 'results.html',
  503. results=results,
  504. q=request.form['q'],
  505. selected_categories=search_query.categories,
  506. pageno=search_query.pageno,
  507. time_range=search_query.time_range,
  508. number_of_results=format_decimal(number_of_results),
  509. advanced_search=advanced_search,
  510. suggestions=suggestion_urls,
  511. answers=result_container.answers,
  512. corrections=correction_urls,
  513. infoboxes=result_container.infoboxes,
  514. paging=result_container.paging,
  515. unresponsive_engines=result_container.unresponsive_engines,
  516. current_language=match_language(search_query.lang,
  517. LANGUAGE_CODES,
  518. fallback=settings['search']['language']),
  519. base_url=get_base_url(),
  520. theme=get_current_theme_name(),
  521. favicons=global_favicons[themes.index(get_current_theme_name())],
  522. timeout_limit=request.form.get('timeout_limit', None)
  523. )
  524. @app.route('/about', methods=['GET'])
  525. def about():
  526. """Render about page"""
  527. return render(
  528. 'about.html',
  529. )
  530. @app.route('/autocompleter', methods=['GET', 'POST'])
  531. def autocompleter():
  532. """Return autocompleter results"""
  533. # set blocked engines
  534. disabled_engines = request.preferences.engines.get_disabled()
  535. # parse query
  536. if PY3:
  537. raw_text_query = RawTextQuery(request.form.get('q', b''), disabled_engines)
  538. else:
  539. raw_text_query = RawTextQuery(request.form.get('q', u'').encode('utf-8'), disabled_engines)
  540. raw_text_query.parse_query()
  541. # check if search query is set
  542. if not raw_text_query.getSearchQuery():
  543. return '', 400
  544. # run autocompleter
  545. completer = autocomplete_backends.get(request.preferences.get_value('autocomplete'))
  546. # parse searx specific autocompleter results like !bang
  547. raw_results = searx_bang(raw_text_query)
  548. # normal autocompletion results only appear if no inner results returned
  549. # and there is a query part besides the engine and language bangs
  550. if len(raw_results) == 0 and completer and (len(raw_text_query.query_parts) > 1 or
  551. (len(raw_text_query.languages) == 0 and
  552. not raw_text_query.specific)):
  553. # get language from cookie
  554. language = request.preferences.get_value('language')
  555. if not language or language == 'all':
  556. language = 'en'
  557. else:
  558. language = language.split('-')[0]
  559. # run autocompletion
  560. raw_results.extend(completer(raw_text_query.getSearchQuery(), language))
  561. # parse results (write :language and !engine back to result string)
  562. results = []
  563. for result in raw_results:
  564. raw_text_query.changeSearchQuery(result)
  565. # add parsed result
  566. results.append(raw_text_query.getFullQuery())
  567. # return autocompleter results
  568. if request.form.get('format') == 'x-suggestions':
  569. return Response(json.dumps([raw_text_query.query, results]),
  570. mimetype='application/json')
  571. return Response(json.dumps(results),
  572. mimetype='application/json')
  573. @app.route('/preferences', methods=['GET', 'POST'])
  574. def preferences():
  575. """Render preferences page && save user preferences"""
  576. # save preferences
  577. if request.method == 'POST':
  578. resp = make_response(redirect(urljoin(settings['server']['base_url'], url_for('index'))))
  579. try:
  580. request.preferences.parse_form(request.form)
  581. except ValidationException:
  582. request.errors.append(gettext('Invalid settings, please edit your preferences'))
  583. return resp
  584. return request.preferences.save(resp)
  585. # render preferences
  586. image_proxy = request.preferences.get_value('image_proxy')
  587. lang = request.preferences.get_value('language')
  588. disabled_engines = request.preferences.engines.get_disabled()
  589. allowed_plugins = request.preferences.plugins.get_enabled()
  590. # stats for preferences page
  591. stats = {}
  592. for c in categories:
  593. for e in categories[c]:
  594. stats[e.name] = {'time': None,
  595. 'warn_timeout': False,
  596. 'warn_time': False}
  597. if e.timeout > settings['outgoing']['request_timeout']:
  598. stats[e.name]['warn_timeout'] = True
  599. stats[e.name]['supports_selected_language'] = _is_selected_language_supported(e, request.preferences)
  600. # get first element [0], the engine time,
  601. # and then the second element [1] : the time (the first one is the label)
  602. for engine_stat in get_engines_stats()[0][1]:
  603. stats[engine_stat.get('name')]['time'] = round(engine_stat.get('avg'), 3)
  604. if engine_stat.get('avg') > settings['outgoing']['request_timeout']:
  605. stats[engine_stat.get('name')]['warn_time'] = True
  606. # end of stats
  607. return render('preferences.html',
  608. locales=settings['locales'],
  609. current_locale=get_locale(),
  610. image_proxy=image_proxy,
  611. engines_by_category=categories,
  612. stats=stats,
  613. answerers=[{'info': a.self_info(), 'keywords': a.keywords} for a in answerers],
  614. disabled_engines=disabled_engines,
  615. autocomplete_backends=autocomplete_backends,
  616. shortcuts={y: x for x, y in engine_shortcuts.items()},
  617. themes=themes,
  618. plugins=plugins,
  619. doi_resolvers=settings['doi_resolvers'],
  620. current_doi_resolver=get_doi_resolver(request.args, request.preferences.get_value('doi_resolver')),
  621. allowed_plugins=allowed_plugins,
  622. theme=get_current_theme_name(),
  623. preferences_url_params=request.preferences.get_as_url_params(),
  624. base_url=get_base_url(),
  625. preferences=True)
  626. def _is_selected_language_supported(engine, preferences):
  627. language = preferences.get_value('language')
  628. return (language == 'all'
  629. or match_language(language,
  630. getattr(engine, 'supported_languages', []),
  631. getattr(engine, 'language_aliases', {}), None))
  632. @app.route('/image_proxy', methods=['GET'])
  633. def image_proxy():
  634. url = request.args.get('url').encode('utf-8')
  635. if not url:
  636. return '', 400
  637. h = new_hmac(settings['server']['secret_key'], url)
  638. if h != request.args.get('h'):
  639. return '', 400
  640. headers = dict_subset(request.headers, {'If-Modified-Since', 'If-None-Match'})
  641. headers['User-Agent'] = gen_useragent()
  642. resp = requests.get(url,
  643. stream=True,
  644. timeout=settings['outgoing']['request_timeout'],
  645. headers=headers,
  646. proxies=outgoing_proxies)
  647. if resp.status_code == 304:
  648. return '', resp.status_code
  649. if resp.status_code != 200:
  650. logger.debug('image-proxy: wrong response code: {0}'.format(resp.status_code))
  651. if resp.status_code >= 400:
  652. return '', resp.status_code
  653. return '', 400
  654. if not resp.headers.get('content-type', '').startswith('image/'):
  655. logger.debug('image-proxy: wrong content-type: {0}'.format(resp.headers.get('content-type')))
  656. return '', 400
  657. img = b''
  658. chunk_counter = 0
  659. for chunk in resp.iter_content(1024 * 1024):
  660. chunk_counter += 1
  661. if chunk_counter > 5:
  662. return '', 502 # Bad gateway - file is too big (>5M)
  663. img += chunk
  664. headers = dict_subset(resp.headers, {'Content-Length', 'Length', 'Date', 'Last-Modified', 'Expires', 'Etag'})
  665. return Response(img, mimetype=resp.headers['content-type'], headers=headers)
  666. @app.route('/stats', methods=['GET'])
  667. def stats():
  668. """Render engine statistics page."""
  669. stats = get_engines_stats()
  670. return render(
  671. 'stats.html',
  672. stats=stats,
  673. )
  674. @app.route('/robots.txt', methods=['GET'])
  675. def robots():
  676. return Response("""User-agent: *
  677. Allow: /
  678. Allow: /about
  679. Disallow: /stats
  680. Disallow: /preferences
  681. Disallow: /*?*q=*
  682. """, mimetype='text/plain')
  683. @app.route('/opensearch.xml', methods=['GET'])
  684. def opensearch():
  685. method = 'post'
  686. if request.preferences.get_value('method') == 'GET':
  687. method = 'get'
  688. # chrome/chromium only supports HTTP GET....
  689. if request.headers.get('User-Agent', '').lower().find('webkit') >= 0:
  690. method = 'get'
  691. ret = render('opensearch.xml',
  692. opensearch_method=method,
  693. host=get_base_url(),
  694. urljoin=urljoin,
  695. override_theme='__common__')
  696. resp = Response(response=ret,
  697. status=200,
  698. mimetype="text/xml")
  699. return resp
  700. @app.route('/favicon.ico')
  701. def favicon():
  702. return send_from_directory(os.path.join(app.root_path,
  703. static_path,
  704. 'themes',
  705. get_current_theme_name(),
  706. 'img'),
  707. 'favicon.png',
  708. mimetype='image/vnd.microsoft.icon')
  709. @app.route('/clear_cookies')
  710. def clear_cookies():
  711. resp = make_response(redirect(urljoin(settings['server']['base_url'], url_for('index'))))
  712. for cookie_name in request.cookies:
  713. resp.delete_cookie(cookie_name)
  714. return resp
  715. @app.route('/config')
  716. def config():
  717. return jsonify({'categories': list(categories.keys()),
  718. 'engines': [{'name': engine_name,
  719. 'categories': engine.categories,
  720. 'shortcut': engine.shortcut,
  721. 'enabled': not engine.disabled,
  722. 'paging': engine.paging,
  723. 'language_support': engine.language_support,
  724. 'supported_languages':
  725. list(engine.supported_languages.keys())
  726. if isinstance(engine.supported_languages, dict)
  727. else engine.supported_languages,
  728. 'safesearch': engine.safesearch,
  729. 'time_range_support': engine.time_range_support,
  730. 'timeout': engine.timeout}
  731. for engine_name, engine in engines.items()],
  732. 'plugins': [{'name': plugin.name,
  733. 'enabled': plugin.default_on}
  734. for plugin in plugins],
  735. 'instance_name': settings['general']['instance_name'],
  736. 'locales': settings['locales'],
  737. 'default_locale': settings['ui']['default_locale'],
  738. 'autocomplete': settings['search']['autocomplete'],
  739. 'safe_search': settings['search']['safe_search'],
  740. 'default_theme': settings['ui']['default_theme'],
  741. 'version': VERSION_STRING,
  742. 'doi_resolvers': [r for r in settings['doi_resolvers']],
  743. 'default_doi_resolver': settings['default_doi_resolver'],
  744. })
  745. @app.errorhandler(404)
  746. def page_not_found(e):
  747. return render('404.html'), 404
  748. def run():
  749. logger.debug('starting webserver on %s:%s', settings['server']['bind_address'], settings['server']['port'])
  750. app.run(
  751. debug=searx_debug,
  752. use_debugger=searx_debug,
  753. port=settings['server']['port'],
  754. host=settings['server']['bind_address'],
  755. threaded=True
  756. )
  757. class ReverseProxyPathFix(object):
  758. '''Wrap the application in this middleware and configure the
  759. front-end server to add these headers, to let you quietly bind
  760. this to a URL other than / and to an HTTP scheme that is
  761. different than what is used locally.
  762. http://flask.pocoo.org/snippets/35/
  763. In nginx:
  764. location /myprefix {
  765. proxy_pass http://127.0.0.1:8000;
  766. proxy_set_header Host $host;
  767. proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
  768. proxy_set_header X-Scheme $scheme;
  769. proxy_set_header X-Script-Name /myprefix;
  770. }
  771. :param app: the WSGI application
  772. '''
  773. def __init__(self, app):
  774. self.app = app
  775. def __call__(self, environ, start_response):
  776. script_name = environ.get('HTTP_X_SCRIPT_NAME', '')
  777. if script_name:
  778. environ['SCRIPT_NAME'] = script_name
  779. path_info = environ['PATH_INFO']
  780. if path_info.startswith(script_name):
  781. environ['PATH_INFO'] = path_info[len(script_name):]
  782. scheme = environ.get('HTTP_X_SCHEME', '')
  783. if scheme:
  784. environ['wsgi.url_scheme'] = scheme
  785. return self.app(environ, start_response)
  786. application = app
  787. # patch app to handle non root url-s behind proxy & wsgi
  788. app.wsgi_app = ReverseProxyPathFix(ProxyFix(application.wsgi_app))
  789. if __name__ == "__main__":
  790. run()