json_engine.html 39 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537
  1. <!DOCTYPE html>
  2. <html lang="en" data-content_root="../../../">
  3. <head>
  4. <meta charset="utf-8" />
  5. <meta name="viewport" content="width=device-width, initial-scale=1.0" />
  6. <meta name="viewport" content="width=device-width, initial-scale=1">
  7. <title>searx.engines.json_engine &#8212; SearXNG Documentation (2025.5.2+590b21165)</title>
  8. <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=6625fa76" />
  9. <link rel="stylesheet" type="text/css" href="../../../_static/searxng.css?v=52e4ff28" />
  10. <script src="../../../_static/documentation_options.js?v=8c00f3b4"></script>
  11. <script src="../../../_static/doctools.js?v=9a2dae69"></script>
  12. <script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
  13. <script data-project="searxng" data-version="2025.5.2+590b21165" src="../../../_static/describe_version.js?v=fa7f30d0"></script>
  14. <link rel="index" title="Index" href="../../../genindex.html" />
  15. <link rel="search" title="Search" href="../../../search.html" />
  16. </head><body>
  17. <div class="related" role="navigation" aria-label="Related">
  18. <h3>Navigation</h3>
  19. <ul>
  20. <li class="right" style="margin-right: 10px">
  21. <a href="../../../genindex.html" title="General Index"
  22. accesskey="I">index</a></li>
  23. <li class="right" >
  24. <a href="../../../py-modindex.html" title="Python Module Index"
  25. >modules</a> |</li>
  26. <li class="nav-item nav-item-0"><a href="../../../index.html">SearXNG Documentation (2025.5.2+590b21165)</a> &#187;</li>
  27. <li class="nav-item nav-item-1"><a href="../../index.html" >Module code</a> &#187;</li>
  28. <li class="nav-item nav-item-2"><a href="../engines.html" accesskey="U">searx.engines</a> &#187;</li>
  29. <li class="nav-item nav-item-this"><a href="">searx.engines.json_engine</a></li>
  30. </ul>
  31. </div>
  32. <div class="document">
  33. <div class="documentwrapper">
  34. <div class="bodywrapper">
  35. <div class="body" role="main">
  36. <h1>Source code for searx.engines.json_engine</h1><div class="highlight"><pre>
  37. <span></span><span class="c1"># SPDX-License-Identifier: AGPL-3.0-or-later</span>
  38. <span class="sd">&quot;&quot;&quot;The JSON engine is a *generic* engine with which it is possible to configure</span>
  39. <span class="sd">engines in the settings.</span>
  40. <span class="sd">Configuration</span>
  41. <span class="sd">=============</span>
  42. <span class="sd">Request:</span>
  43. <span class="sd">- :py:obj:`search_url`</span>
  44. <span class="sd">- :py:obj:`lang_all`</span>
  45. <span class="sd">- :py:obj:`soft_max_redirects`</span>
  46. <span class="sd">- :py:obj:`method`</span>
  47. <span class="sd">- :py:obj:`request_body`</span>
  48. <span class="sd">- :py:obj:`cookies`</span>
  49. <span class="sd">- :py:obj:`headers`</span>
  50. <span class="sd">Paging:</span>
  51. <span class="sd">- :py:obj:`paging`</span>
  52. <span class="sd">- :py:obj:`page_size`</span>
  53. <span class="sd">- :py:obj:`first_page_num`</span>
  54. <span class="sd">Time Range:</span>
  55. <span class="sd">- :py:obj:`time_range_support`</span>
  56. <span class="sd">- :py:obj:`time_range_url`</span>
  57. <span class="sd">- :py:obj:`time_range_map`</span>
  58. <span class="sd">Safe-Search:</span>
  59. <span class="sd">- :py:obj:`safe_search_support`</span>
  60. <span class="sd">- :py:obj:`safe_search_map`</span>
  61. <span class="sd">Response:</span>
  62. <span class="sd">- :py:obj:`title_html_to_text`</span>
  63. <span class="sd">- :py:obj:`content_html_to_text`</span>
  64. <span class="sd">- :py:obj:`no_result_for_http_status`</span>
  65. <span class="sd">JSON query:</span>
  66. <span class="sd">- :py:obj:`results_query`</span>
  67. <span class="sd">- :py:obj:`url_query`</span>
  68. <span class="sd">- :py:obj:`url_prefix`</span>
  69. <span class="sd">- :py:obj:`title_query`</span>
  70. <span class="sd">- :py:obj:`content_query`</span>
  71. <span class="sd">- :py:obj:`thumbnail_query`</span>
  72. <span class="sd">- :py:obj:`thumbnail_prefix`</span>
  73. <span class="sd">- :py:obj:`suggestion_query`</span>
  74. <span class="sd">Example</span>
  75. <span class="sd">=======</span>
  76. <span class="sd">Here is a simple example of a JSON engine configure in the :ref:`settings</span>
  77. <span class="sd">engines` section, further read :ref:`engines-dev`.</span>
  78. <span class="sd">.. code:: yaml</span>
  79. <span class="sd"> - name : mdn</span>
  80. <span class="sd"> engine : json_engine</span>
  81. <span class="sd"> paging : True</span>
  82. <span class="sd"> search_url : https://developer.mozilla.org/api/v1/search?q={query}&amp;page={pageno}</span>
  83. <span class="sd"> results_query : documents</span>
  84. <span class="sd"> url_query : mdn_url</span>
  85. <span class="sd"> url_prefix : https://developer.mozilla.org</span>
  86. <span class="sd"> title_query : title</span>
  87. <span class="sd"> content_query : summary</span>
  88. <span class="sd">Implementations</span>
  89. <span class="sd">===============</span>
  90. <span class="sd">&quot;&quot;&quot;</span>
  91. <span class="kn">from</span><span class="w"> </span><span class="nn">collections.abc</span><span class="w"> </span><span class="kn">import</span> <span class="n">Iterable</span>
  92. <span class="kn">from</span><span class="w"> </span><span class="nn">json</span><span class="w"> </span><span class="kn">import</span> <span class="n">loads</span>
  93. <span class="kn">from</span><span class="w"> </span><span class="nn">urllib.parse</span><span class="w"> </span><span class="kn">import</span> <span class="n">urlencode</span>
  94. <span class="kn">from</span><span class="w"> </span><span class="nn">searx.utils</span><span class="w"> </span><span class="kn">import</span> <span class="n">to_string</span><span class="p">,</span> <span class="n">html_to_text</span>
  95. <span class="kn">from</span><span class="w"> </span><span class="nn">searx.network</span><span class="w"> </span><span class="kn">import</span> <span class="n">raise_for_httperror</span>
  96. <span class="n">search_url</span> <span class="o">=</span> <span class="kc">None</span>
  97. <span class="sd">&quot;&quot;&quot;</span>
  98. <span class="sd">Search URL of the engine. Example::</span>
  99. <span class="sd"> https://example.org/?search={query}&amp;page={pageno}{time_range}{safe_search}</span>
  100. <span class="sd">Replacements are:</span>
  101. <span class="sd">``{query}``:</span>
  102. <span class="sd"> Search terms from user.</span>
  103. <span class="sd">``{pageno}``:</span>
  104. <span class="sd"> Page number if engine supports paging :py:obj:`paging`</span>
  105. <span class="sd">``{lang}``:</span>
  106. <span class="sd"> ISO 639-1 language code (en, de, fr ..)</span>
  107. <span class="sd">``{time_range}``:</span>
  108. <span class="sd"> :py:obj:`URL parameter &lt;time_range_url&gt;` if engine :py:obj:`supports time</span>
  109. <span class="sd"> range &lt;time_range_support&gt;`. The value for the parameter is taken from</span>
  110. <span class="sd"> :py:obj:`time_range_map`.</span>
  111. <span class="sd">``{safe_search}``:</span>
  112. <span class="sd"> Safe-search :py:obj:`URL parameter &lt;safe_search_map&gt;` if engine</span>
  113. <span class="sd"> :py:obj:`supports safe-search &lt;safe_search_support&gt;`. The ``{safe_search}``</span>
  114. <span class="sd"> replacement is taken from the :py:obj:`safes_search_map`. Filter results::</span>
  115. <span class="sd"> 0: none, 1: moderate, 2:strict</span>
  116. <span class="sd"> If not supported, the URL parameter is an empty string.</span>
  117. <span class="sd">&quot;&quot;&quot;</span>
  118. <span class="n">lang_all</span> <span class="o">=</span> <span class="s1">&#39;en&#39;</span>
  119. <span class="sd">&#39;&#39;&#39;Replacement ``{lang}`` in :py:obj:`search_url` if language ``all`` is</span>
  120. <span class="sd">selected.</span>
  121. <span class="sd">&#39;&#39;&#39;</span>
  122. <span class="n">no_result_for_http_status</span> <span class="o">=</span> <span class="p">[]</span>
  123. <span class="sd">&#39;&#39;&#39;Return empty result for these HTTP status codes instead of throwing an error.</span>
  124. <span class="sd">.. code:: yaml</span>
  125. <span class="sd"> no_result_for_http_status: []</span>
  126. <span class="sd">&#39;&#39;&#39;</span>
  127. <span class="n">soft_max_redirects</span> <span class="o">=</span> <span class="mi">0</span>
  128. <span class="sd">&#39;&#39;&#39;Maximum redirects, soft limit. Record an error but don&#39;t stop the engine&#39;&#39;&#39;</span>
  129. <span class="n">method</span> <span class="o">=</span> <span class="s1">&#39;GET&#39;</span>
  130. <span class="sd">&#39;&#39;&#39;Some engines might require to do POST requests for search.&#39;&#39;&#39;</span>
  131. <span class="n">request_body</span> <span class="o">=</span> <span class="s1">&#39;&#39;</span>
  132. <span class="sd">&#39;&#39;&#39;The body of the request. This can only be used if different :py:obj:`method`</span>
  133. <span class="sd">is set, e.g. ``POST``. For formatting see the documentation of :py:obj:`search_url`.</span>
  134. <span class="sd">Note: Curly brackets which aren&#39;t encapsulating a replacement placeholder</span>
  135. <span class="sd">must be escaped by doubling each ``{`` and ``}``.</span>
  136. <span class="sd">.. code:: yaml</span>
  137. <span class="sd"> request_body: &gt;-</span>
  138. <span class="sd"> {{</span>
  139. <span class="sd"> &quot;search&quot;: &quot;{query}&quot;,</span>
  140. <span class="sd"> &quot;page&quot;: {pageno},</span>
  141. <span class="sd"> &quot;extra&quot;: {{</span>
  142. <span class="sd"> &quot;time_range&quot;: {time_range},</span>
  143. <span class="sd"> &quot;rating&quot;: &quot;{safe_search}&quot;</span>
  144. <span class="sd"> }}</span>
  145. <span class="sd"> }}</span>
  146. <span class="sd">&#39;&#39;&#39;</span>
  147. <span class="n">cookies</span> <span class="o">=</span> <span class="p">{}</span>
  148. <span class="sd">&#39;&#39;&#39;Some engines might offer different result based on cookies.</span>
  149. <span class="sd">Possible use-case: To set safesearch cookie.&#39;&#39;&#39;</span>
  150. <span class="n">headers</span> <span class="o">=</span> <span class="p">{}</span>
  151. <span class="sd">&#39;&#39;&#39;Some engines might offer different result based on cookies or headers.</span>
  152. <span class="sd">Possible use-case: To set safesearch cookie or header to moderate.&#39;&#39;&#39;</span>
  153. <span class="n">paging</span> <span class="o">=</span> <span class="kc">False</span>
  154. <span class="sd">&#39;&#39;&#39;Engine supports paging [True or False].&#39;&#39;&#39;</span>
  155. <span class="n">page_size</span> <span class="o">=</span> <span class="mi">1</span>
  156. <span class="sd">&#39;&#39;&#39;Number of results on each page. Only needed if the site requires not a page</span>
  157. <span class="sd">number, but an offset.&#39;&#39;&#39;</span>
  158. <span class="n">first_page_num</span> <span class="o">=</span> <span class="mi">1</span>
  159. <span class="sd">&#39;&#39;&#39;Number of the first page (usually 0 or 1).&#39;&#39;&#39;</span>
  160. <span class="n">results_query</span> <span class="o">=</span> <span class="s1">&#39;&#39;</span>
  161. <span class="sd">&#39;&#39;&#39;JSON query for the list of result items.</span>
  162. <span class="sd">The query string is a slash `/` separated path of JSON key names.</span>
  163. <span class="sd">Array entries can be specified using the index or can be omitted entirely,</span>
  164. <span class="sd">in which case each entry is considered -</span>
  165. <span class="sd">most implementations will default to the first entry in this case.</span>
  166. <span class="sd">&#39;&#39;&#39;</span>
  167. <span class="n">url_query</span> <span class="o">=</span> <span class="kc">None</span>
  168. <span class="sd">&#39;&#39;&#39;JSON query of result&#39;s ``url``. For the query string documentation see :py:obj:`results_query`&#39;&#39;&#39;</span>
  169. <span class="n">url_prefix</span> <span class="o">=</span> <span class="s2">&quot;&quot;</span>
  170. <span class="sd">&#39;&#39;&#39;String to prepend to the result&#39;s ``url``.&#39;&#39;&#39;</span>
  171. <span class="n">title_query</span> <span class="o">=</span> <span class="kc">None</span>
  172. <span class="sd">&#39;&#39;&#39;JSON query of result&#39;s ``title``. For the query string documentation see :py:obj:`results_query`&#39;&#39;&#39;</span>
  173. <span class="n">content_query</span> <span class="o">=</span> <span class="kc">None</span>
  174. <span class="sd">&#39;&#39;&#39;JSON query of result&#39;s ``content``. For the query string documentation see :py:obj:`results_query`&#39;&#39;&#39;</span>
  175. <span class="n">thumbnail_query</span> <span class="o">=</span> <span class="kc">False</span>
  176. <span class="sd">&#39;&#39;&#39;JSON query of result&#39;s ``thumbnail``. For the query string documentation see :py:obj:`results_query`&#39;&#39;&#39;</span>
  177. <span class="n">thumbnail_prefix</span> <span class="o">=</span> <span class="s1">&#39;&#39;</span>
  178. <span class="sd">&#39;&#39;&#39;String to prepend to the result&#39;s ``thumbnail``.&#39;&#39;&#39;</span>
  179. <span class="n">suggestion_query</span> <span class="o">=</span> <span class="s1">&#39;&#39;</span>
  180. <span class="sd">&#39;&#39;&#39;JSON query of result&#39;s ``suggestion``. For the query string documentation see :py:obj:`results_query`&#39;&#39;&#39;</span>
  181. <span class="n">title_html_to_text</span> <span class="o">=</span> <span class="kc">False</span>
  182. <span class="sd">&#39;&#39;&#39;Extract text from a HTML title string&#39;&#39;&#39;</span>
  183. <span class="n">content_html_to_text</span> <span class="o">=</span> <span class="kc">False</span>
  184. <span class="sd">&#39;&#39;&#39;Extract text from a HTML content string&#39;&#39;&#39;</span>
  185. <span class="n">time_range_support</span> <span class="o">=</span> <span class="kc">False</span>
  186. <span class="sd">&#39;&#39;&#39;Engine supports search time range.&#39;&#39;&#39;</span>
  187. <span class="n">time_range_url</span> <span class="o">=</span> <span class="s1">&#39;&amp;hours=</span><span class="si">{time_range_val}</span><span class="s1">&#39;</span>
  188. <span class="sd">&#39;&#39;&#39;Time range URL parameter in the in :py:obj:`search_url`. If no time range is</span>
  189. <span class="sd">requested by the user, the URL parameter is an empty string. The</span>
  190. <span class="sd">``{time_range_val}`` replacement is taken from the :py:obj:`time_range_map`.</span>
  191. <span class="sd">.. code:: yaml</span>
  192. <span class="sd"> time_range_url : &#39;&amp;days={time_range_val}&#39;</span>
  193. <span class="sd">&#39;&#39;&#39;</span>
  194. <span class="n">time_range_map</span> <span class="o">=</span> <span class="p">{</span>
  195. <span class="s1">&#39;day&#39;</span><span class="p">:</span> <span class="mi">24</span><span class="p">,</span>
  196. <span class="s1">&#39;week&#39;</span><span class="p">:</span> <span class="mi">24</span> <span class="o">*</span> <span class="mi">7</span><span class="p">,</span>
  197. <span class="s1">&#39;month&#39;</span><span class="p">:</span> <span class="mi">24</span> <span class="o">*</span> <span class="mi">30</span><span class="p">,</span>
  198. <span class="s1">&#39;year&#39;</span><span class="p">:</span> <span class="mi">24</span> <span class="o">*</span> <span class="mi">365</span><span class="p">,</span>
  199. <span class="p">}</span>
  200. <span class="sd">&#39;&#39;&#39;Maps time range value from user to ``{time_range_val}`` in</span>
  201. <span class="sd">:py:obj:`time_range_url`.</span>
  202. <span class="sd">.. code:: yaml</span>
  203. <span class="sd"> time_range_map:</span>
  204. <span class="sd"> day: 1</span>
  205. <span class="sd"> week: 7</span>
  206. <span class="sd"> month: 30</span>
  207. <span class="sd"> year: 365</span>
  208. <span class="sd">&#39;&#39;&#39;</span>
  209. <span class="n">safe_search_support</span> <span class="o">=</span> <span class="kc">False</span>
  210. <span class="sd">&#39;&#39;&#39;Engine supports safe-search.&#39;&#39;&#39;</span>
  211. <span class="n">safe_search_map</span> <span class="o">=</span> <span class="p">{</span><span class="mi">0</span><span class="p">:</span> <span class="s1">&#39;&amp;filter=none&#39;</span><span class="p">,</span> <span class="mi">1</span><span class="p">:</span> <span class="s1">&#39;&amp;filter=moderate&#39;</span><span class="p">,</span> <span class="mi">2</span><span class="p">:</span> <span class="s1">&#39;&amp;filter=strict&#39;</span><span class="p">}</span>
  212. <span class="sd">&#39;&#39;&#39;Maps safe-search value to ``{safe_search}`` in :py:obj:`search_url`.</span>
  213. <span class="sd">.. code:: yaml</span>
  214. <span class="sd"> safesearch: true</span>
  215. <span class="sd"> safes_search_map:</span>
  216. <span class="sd"> 0: &#39;&amp;filter=none&#39;</span>
  217. <span class="sd"> 1: &#39;&amp;filter=moderate&#39;</span>
  218. <span class="sd"> 2: &#39;&amp;filter=strict&#39;</span>
  219. <span class="sd">&#39;&#39;&#39;</span>
  220. <span class="k">def</span><span class="w"> </span><span class="nf">iterate</span><span class="p">(</span><span class="n">iterable</span><span class="p">):</span>
  221. <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">iterable</span><span class="p">,</span> <span class="nb">dict</span><span class="p">):</span>
  222. <span class="n">items</span> <span class="o">=</span> <span class="n">iterable</span><span class="o">.</span><span class="n">items</span><span class="p">()</span>
  223. <span class="k">else</span><span class="p">:</span>
  224. <span class="n">items</span> <span class="o">=</span> <span class="nb">enumerate</span><span class="p">(</span><span class="n">iterable</span><span class="p">)</span>
  225. <span class="k">for</span> <span class="n">index</span><span class="p">,</span> <span class="n">value</span> <span class="ow">in</span> <span class="n">items</span><span class="p">:</span>
  226. <span class="k">yield</span> <span class="nb">str</span><span class="p">(</span><span class="n">index</span><span class="p">),</span> <span class="n">value</span>
  227. <span class="k">def</span><span class="w"> </span><span class="nf">is_iterable</span><span class="p">(</span><span class="n">obj</span><span class="p">):</span>
  228. <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">obj</span><span class="p">,</span> <span class="nb">str</span><span class="p">):</span>
  229. <span class="k">return</span> <span class="kc">False</span>
  230. <span class="k">return</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">obj</span><span class="p">,</span> <span class="n">Iterable</span><span class="p">)</span>
  231. <span class="k">def</span><span class="w"> </span><span class="nf">parse</span><span class="p">(</span><span class="n">query</span><span class="p">):</span> <span class="c1"># pylint: disable=redefined-outer-name</span>
  232. <span class="n">q</span> <span class="o">=</span> <span class="p">[]</span> <span class="c1"># pylint: disable=invalid-name</span>
  233. <span class="k">for</span> <span class="n">part</span> <span class="ow">in</span> <span class="n">query</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s1">&#39;/&#39;</span><span class="p">):</span>
  234. <span class="k">if</span> <span class="n">part</span> <span class="o">==</span> <span class="s1">&#39;&#39;</span><span class="p">:</span>
  235. <span class="k">continue</span>
  236. <span class="n">q</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">part</span><span class="p">)</span>
  237. <span class="k">return</span> <span class="n">q</span>
  238. <span class="k">def</span><span class="w"> </span><span class="nf">do_query</span><span class="p">(</span><span class="n">data</span><span class="p">,</span> <span class="n">q</span><span class="p">):</span> <span class="c1"># pylint: disable=invalid-name</span>
  239. <span class="n">ret</span> <span class="o">=</span> <span class="p">[]</span>
  240. <span class="k">if</span> <span class="ow">not</span> <span class="n">q</span><span class="p">:</span>
  241. <span class="k">return</span> <span class="n">ret</span>
  242. <span class="n">qkey</span> <span class="o">=</span> <span class="n">q</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span>
  243. <span class="k">for</span> <span class="n">key</span><span class="p">,</span> <span class="n">value</span> <span class="ow">in</span> <span class="n">iterate</span><span class="p">(</span><span class="n">data</span><span class="p">):</span>
  244. <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">q</span><span class="p">)</span> <span class="o">==</span> <span class="mi">1</span><span class="p">:</span>
  245. <span class="k">if</span> <span class="n">key</span> <span class="o">==</span> <span class="n">qkey</span><span class="p">:</span>
  246. <span class="n">ret</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">value</span><span class="p">)</span>
  247. <span class="k">elif</span> <span class="n">is_iterable</span><span class="p">(</span><span class="n">value</span><span class="p">):</span>
  248. <span class="n">ret</span><span class="o">.</span><span class="n">extend</span><span class="p">(</span><span class="n">do_query</span><span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="n">q</span><span class="p">))</span>
  249. <span class="k">else</span><span class="p">:</span>
  250. <span class="k">if</span> <span class="ow">not</span> <span class="n">is_iterable</span><span class="p">(</span><span class="n">value</span><span class="p">):</span>
  251. <span class="k">continue</span>
  252. <span class="k">if</span> <span class="n">key</span> <span class="o">==</span> <span class="n">qkey</span><span class="p">:</span>
  253. <span class="n">ret</span><span class="o">.</span><span class="n">extend</span><span class="p">(</span><span class="n">do_query</span><span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="n">q</span><span class="p">[</span><span class="mi">1</span><span class="p">:]))</span>
  254. <span class="k">else</span><span class="p">:</span>
  255. <span class="n">ret</span><span class="o">.</span><span class="n">extend</span><span class="p">(</span><span class="n">do_query</span><span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="n">q</span><span class="p">))</span>
  256. <span class="k">return</span> <span class="n">ret</span>
  257. <span class="k">def</span><span class="w"> </span><span class="nf">query</span><span class="p">(</span><span class="n">data</span><span class="p">,</span> <span class="n">query_string</span><span class="p">):</span>
  258. <span class="n">q</span> <span class="o">=</span> <span class="n">parse</span><span class="p">(</span><span class="n">query_string</span><span class="p">)</span>
  259. <span class="k">return</span> <span class="n">do_query</span><span class="p">(</span><span class="n">data</span><span class="p">,</span> <span class="n">q</span><span class="p">)</span>
  260. <div class="viewcode-block" id="request">
  261. <a class="viewcode-back" href="../../../dev/engines/json_engine.html#searx.engines.json_engine.request">[docs]</a>
  262. <span class="k">def</span><span class="w"> </span><span class="nf">request</span><span class="p">(</span><span class="n">query</span><span class="p">,</span> <span class="n">params</span><span class="p">):</span> <span class="c1"># pylint: disable=redefined-outer-name</span>
  263. <span class="w"> </span><span class="sd">&#39;&#39;&#39;Build request parameters (see :ref:`engine request`).&#39;&#39;&#39;</span>
  264. <span class="n">lang</span> <span class="o">=</span> <span class="n">lang_all</span>
  265. <span class="k">if</span> <span class="n">params</span><span class="p">[</span><span class="s1">&#39;language&#39;</span><span class="p">]</span> <span class="o">!=</span> <span class="s1">&#39;all&#39;</span><span class="p">:</span>
  266. <span class="n">lang</span> <span class="o">=</span> <span class="n">params</span><span class="p">[</span><span class="s1">&#39;language&#39;</span><span class="p">][:</span><span class="mi">2</span><span class="p">]</span>
  267. <span class="n">time_range</span> <span class="o">=</span> <span class="s1">&#39;&#39;</span>
  268. <span class="k">if</span> <span class="n">params</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;time_range&#39;</span><span class="p">):</span>
  269. <span class="n">time_range_val</span> <span class="o">=</span> <span class="n">time_range_map</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">params</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;time_range&#39;</span><span class="p">))</span>
  270. <span class="n">time_range</span> <span class="o">=</span> <span class="n">time_range_url</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">time_range_val</span><span class="o">=</span><span class="n">time_range_val</span><span class="p">)</span>
  271. <span class="n">safe_search</span> <span class="o">=</span> <span class="s1">&#39;&#39;</span>
  272. <span class="k">if</span> <span class="n">params</span><span class="p">[</span><span class="s1">&#39;safesearch&#39;</span><span class="p">]:</span>
  273. <span class="n">safe_search</span> <span class="o">=</span> <span class="n">safe_search_map</span><span class="p">[</span><span class="n">params</span><span class="p">[</span><span class="s1">&#39;safesearch&#39;</span><span class="p">]]</span>
  274. <span class="n">fp</span> <span class="o">=</span> <span class="p">{</span> <span class="c1"># pylint: disable=invalid-name</span>
  275. <span class="s1">&#39;query&#39;</span><span class="p">:</span> <span class="n">urlencode</span><span class="p">({</span><span class="s1">&#39;q&#39;</span><span class="p">:</span> <span class="n">query</span><span class="p">})[</span><span class="mi">2</span><span class="p">:],</span>
  276. <span class="s1">&#39;lang&#39;</span><span class="p">:</span> <span class="n">lang</span><span class="p">,</span>
  277. <span class="s1">&#39;pageno&#39;</span><span class="p">:</span> <span class="p">(</span><span class="n">params</span><span class="p">[</span><span class="s1">&#39;pageno&#39;</span><span class="p">]</span> <span class="o">-</span> <span class="mi">1</span><span class="p">)</span> <span class="o">*</span> <span class="n">page_size</span> <span class="o">+</span> <span class="n">first_page_num</span><span class="p">,</span>
  278. <span class="s1">&#39;time_range&#39;</span><span class="p">:</span> <span class="n">time_range</span><span class="p">,</span>
  279. <span class="s1">&#39;safe_search&#39;</span><span class="p">:</span> <span class="n">safe_search</span><span class="p">,</span>
  280. <span class="p">}</span>
  281. <span class="n">params</span><span class="p">[</span><span class="s1">&#39;cookies&#39;</span><span class="p">]</span><span class="o">.</span><span class="n">update</span><span class="p">(</span><span class="n">cookies</span><span class="p">)</span>
  282. <span class="n">params</span><span class="p">[</span><span class="s1">&#39;headers&#39;</span><span class="p">]</span><span class="o">.</span><span class="n">update</span><span class="p">(</span><span class="n">headers</span><span class="p">)</span>
  283. <span class="n">params</span><span class="p">[</span><span class="s1">&#39;url&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">search_url</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="o">**</span><span class="n">fp</span><span class="p">)</span>
  284. <span class="n">params</span><span class="p">[</span><span class="s1">&#39;method&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">method</span>
  285. <span class="k">if</span> <span class="n">request_body</span><span class="p">:</span>
  286. <span class="c1"># don&#39;t url-encode the query if it&#39;s in the request body</span>
  287. <span class="n">fp</span><span class="p">[</span><span class="s1">&#39;query&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">query</span>
  288. <span class="n">params</span><span class="p">[</span><span class="s1">&#39;data&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">request_body</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="o">**</span><span class="n">fp</span><span class="p">)</span>
  289. <span class="n">params</span><span class="p">[</span><span class="s1">&#39;soft_max_redirects&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">soft_max_redirects</span>
  290. <span class="n">params</span><span class="p">[</span><span class="s1">&#39;raise_for_httperror&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="kc">False</span>
  291. <span class="k">return</span> <span class="n">params</span></div>
  292. <span class="k">def</span><span class="w"> </span><span class="nf">identity</span><span class="p">(</span><span class="n">arg</span><span class="p">):</span>
  293. <span class="k">return</span> <span class="n">arg</span>
  294. <span class="k">def</span><span class="w"> </span><span class="nf">extract_response_info</span><span class="p">(</span><span class="n">result</span><span class="p">):</span>
  295. <span class="n">title_filter</span> <span class="o">=</span> <span class="n">html_to_text</span> <span class="k">if</span> <span class="n">title_html_to_text</span> <span class="k">else</span> <span class="n">identity</span>
  296. <span class="n">content_filter</span> <span class="o">=</span> <span class="n">html_to_text</span> <span class="k">if</span> <span class="n">content_html_to_text</span> <span class="k">else</span> <span class="n">identity</span>
  297. <span class="n">tmp_result</span> <span class="o">=</span> <span class="p">{}</span>
  298. <span class="k">try</span><span class="p">:</span>
  299. <span class="n">url</span> <span class="o">=</span> <span class="n">query</span><span class="p">(</span><span class="n">result</span><span class="p">,</span> <span class="n">url_query</span><span class="p">)[</span><span class="mi">0</span><span class="p">]</span>
  300. <span class="n">tmp_result</span><span class="p">[</span><span class="s1">&#39;url&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">url_prefix</span> <span class="o">+</span> <span class="n">to_string</span><span class="p">(</span><span class="n">url</span><span class="p">)</span>
  301. <span class="n">title</span> <span class="o">=</span> <span class="n">query</span><span class="p">(</span><span class="n">result</span><span class="p">,</span> <span class="n">title_query</span><span class="p">)[</span><span class="mi">0</span><span class="p">]</span>
  302. <span class="n">tmp_result</span><span class="p">[</span><span class="s1">&#39;title&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">title_filter</span><span class="p">(</span><span class="n">to_string</span><span class="p">(</span><span class="n">title</span><span class="p">))</span>
  303. <span class="k">except</span><span class="p">:</span> <span class="c1"># pylint: disable=bare-except</span>
  304. <span class="k">return</span> <span class="kc">None</span>
  305. <span class="k">try</span><span class="p">:</span>
  306. <span class="n">content</span> <span class="o">=</span> <span class="n">query</span><span class="p">(</span><span class="n">result</span><span class="p">,</span> <span class="n">content_query</span><span class="p">)[</span><span class="mi">0</span><span class="p">]</span>
  307. <span class="n">tmp_result</span><span class="p">[</span><span class="s1">&#39;content&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">content_filter</span><span class="p">(</span><span class="n">to_string</span><span class="p">(</span><span class="n">content</span><span class="p">))</span>
  308. <span class="k">except</span><span class="p">:</span> <span class="c1"># pylint: disable=bare-except</span>
  309. <span class="n">tmp_result</span><span class="p">[</span><span class="s1">&#39;content&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="s2">&quot;&quot;</span>
  310. <span class="k">try</span><span class="p">:</span>
  311. <span class="k">if</span> <span class="n">thumbnail_query</span><span class="p">:</span>
  312. <span class="n">thumbnail_query_result</span> <span class="o">=</span> <span class="n">query</span><span class="p">(</span><span class="n">result</span><span class="p">,</span> <span class="n">thumbnail_query</span><span class="p">)[</span><span class="mi">0</span><span class="p">]</span>
  313. <span class="n">tmp_result</span><span class="p">[</span><span class="s1">&#39;thumbnail&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">thumbnail_prefix</span> <span class="o">+</span> <span class="n">to_string</span><span class="p">(</span><span class="n">thumbnail_query_result</span><span class="p">)</span>
  314. <span class="k">except</span><span class="p">:</span> <span class="c1"># pylint: disable=bare-except</span>
  315. <span class="k">pass</span>
  316. <span class="k">return</span> <span class="n">tmp_result</span>
  317. <div class="viewcode-block" id="response">
  318. <a class="viewcode-back" href="../../../dev/engines/json_engine.html#searx.engines.json_engine.response">[docs]</a>
  319. <span class="k">def</span><span class="w"> </span><span class="nf">response</span><span class="p">(</span><span class="n">resp</span><span class="p">):</span>
  320. <span class="w"> </span><span class="sd">&#39;&#39;&#39;Scrap *results* from the response (see :ref:`result types`).&#39;&#39;&#39;</span>
  321. <span class="n">results</span> <span class="o">=</span> <span class="p">[]</span>
  322. <span class="k">if</span> <span class="n">no_result_for_http_status</span> <span class="ow">and</span> <span class="n">resp</span><span class="o">.</span><span class="n">status_code</span> <span class="ow">in</span> <span class="n">no_result_for_http_status</span><span class="p">:</span>
  323. <span class="k">return</span> <span class="n">results</span>
  324. <span class="n">raise_for_httperror</span><span class="p">(</span><span class="n">resp</span><span class="p">)</span>
  325. <span class="k">if</span> <span class="ow">not</span> <span class="n">resp</span><span class="o">.</span><span class="n">text</span><span class="p">:</span>
  326. <span class="k">return</span> <span class="n">results</span>
  327. <span class="n">json</span> <span class="o">=</span> <span class="n">loads</span><span class="p">(</span><span class="n">resp</span><span class="o">.</span><span class="n">text</span><span class="p">)</span>
  328. <span class="n">is_onion</span> <span class="o">=</span> <span class="s1">&#39;onions&#39;</span> <span class="ow">in</span> <span class="n">categories</span>
  329. <span class="k">if</span> <span class="n">results_query</span><span class="p">:</span>
  330. <span class="n">rs</span> <span class="o">=</span> <span class="n">query</span><span class="p">(</span><span class="n">json</span><span class="p">,</span> <span class="n">results_query</span><span class="p">)</span> <span class="c1"># pylint: disable=invalid-name</span>
  331. <span class="k">if</span> <span class="ow">not</span> <span class="n">rs</span><span class="p">:</span>
  332. <span class="k">return</span> <span class="n">results</span>
  333. <span class="n">rs</span> <span class="o">=</span> <span class="n">rs</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="c1"># pylint: disable=invalid-name</span>
  334. <span class="k">else</span><span class="p">:</span>
  335. <span class="n">rs</span> <span class="o">=</span> <span class="n">json</span> <span class="c1"># pylint: disable=invalid-name</span>
  336. <span class="k">for</span> <span class="n">result</span> <span class="ow">in</span> <span class="n">rs</span><span class="p">:</span>
  337. <span class="n">tmp_result</span> <span class="o">=</span> <span class="n">extract_response_info</span><span class="p">(</span><span class="n">result</span><span class="p">)</span>
  338. <span class="k">if</span> <span class="ow">not</span> <span class="n">tmp_result</span><span class="p">:</span>
  339. <span class="k">continue</span>
  340. <span class="k">if</span> <span class="n">is_onion</span><span class="p">:</span>
  341. <span class="n">tmp_result</span><span class="p">[</span><span class="s1">&#39;is_onion&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="kc">True</span>
  342. <span class="n">results</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">tmp_result</span><span class="p">)</span>
  343. <span class="k">if</span> <span class="ow">not</span> <span class="n">suggestion_query</span><span class="p">:</span>
  344. <span class="k">return</span> <span class="n">results</span>
  345. <span class="k">for</span> <span class="n">suggestion</span> <span class="ow">in</span> <span class="n">query</span><span class="p">(</span><span class="n">json</span><span class="p">,</span> <span class="n">suggestion_query</span><span class="p">):</span>
  346. <span class="n">results</span><span class="o">.</span><span class="n">append</span><span class="p">({</span><span class="s1">&#39;suggestion&#39;</span><span class="p">:</span> <span class="n">suggestion</span><span class="p">})</span>
  347. <span class="k">return</span> <span class="n">results</span></div>
  348. </pre></div>
  349. <div class="clearer"></div>
  350. </div>
  351. </div>
  352. </div>
  353. <span id="sidebar-top"></span>
  354. <div class="sphinxsidebar" role="navigation" aria-label="Main">
  355. <div class="sphinxsidebarwrapper">
  356. <p class="logo"><a href="../../../index.html">
  357. <img class="logo" src="../../../_static/searxng-wordmark.svg" alt="Logo of SearXNG"/>
  358. </a></p>
  359. <h3><a href="../../../index.html">Table of Contents</a></h3>
  360. <ul>
  361. <li class="toctree-l1"><a class="reference internal" href="../../../user/index.html">User information</a></li>
  362. <li class="toctree-l1"><a class="reference internal" href="../../../own-instance.html">Why use a private instance?</a></li>
  363. <li class="toctree-l1"><a class="reference internal" href="../../../admin/index.html">Administrator documentation</a></li>
  364. <li class="toctree-l1"><a class="reference internal" href="../../../dev/index.html">Developer documentation</a></li>
  365. <li class="toctree-l1"><a class="reference internal" href="../../../utils/index.html">DevOps tooling box</a></li>
  366. <li class="toctree-l1"><a class="reference internal" href="../../../src/index.html">Source-Code</a></li>
  367. </ul>
  368. <h3>Project Links</h3>
  369. <ul>
  370. <li><a href="https://github.com/searxng/searxng/tree/master">Source</a>
  371. <li><a href="https://github.com/searxng/searxng/wiki">Wiki</a>
  372. <li><a href="https://searx.space">Public instances</a>
  373. <li><a href="https://github.com/searxng/searxng/issues">Issue Tracker</a>
  374. </ul><h3>Navigation</h3>
  375. <ul>
  376. <li><a href="../../../index.html">Overview</a>
  377. <ul>
  378. <li><a href="../../index.html">Module code</a>
  379. <ul>
  380. <li><a href="../engines.html">searx.engines</a>
  381. </ul>
  382. </li></ul>
  383. </li>
  384. </ul>
  385. </li>
  386. </ul>
  387. <search id="searchbox" style="display: none" role="search">
  388. <h3 id="searchlabel">Quick search</h3>
  389. <div class="searchformwrapper">
  390. <form class="search" action="../../../search.html" method="get">
  391. <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
  392. <input type="submit" value="Go" />
  393. </form>
  394. </div>
  395. </search>
  396. <script>document.getElementById('searchbox').style.display = "block"</script>
  397. </div>
  398. </div>
  399. <div class="clearer"></div>
  400. </div>
  401. <div class="footer" role="contentinfo">
  402. &#169; Copyright SearXNG team.
  403. </div>
  404. </body>
  405. </html>