search.html 34 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324
  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.search &#8212; SearXNG Documentation (2025.5.1+1a1628149)</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=cc9fc81d"></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.1+1a1628149" 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.1+1a1628149)</a> &#187;</li>
  27. <li class="nav-item nav-item-1"><a href="../index.html" accesskey="U">Module code</a> &#187;</li>
  28. <li class="nav-item nav-item-this"><a href="">searx.search</a></li>
  29. </ul>
  30. </div>
  31. <div class="document">
  32. <div class="documentwrapper">
  33. <div class="bodywrapper">
  34. <div class="body" role="main">
  35. <h1>Source code for searx.search</h1><div class="highlight"><pre>
  36. <span></span><span class="c1"># SPDX-License-Identifier: AGPL-3.0-or-later</span>
  37. <span class="c1"># pylint: disable=missing-module-docstring, too-few-public-methods</span>
  38. <span class="c1"># the public namespace has not yet been finally defined ..</span>
  39. <span class="c1"># __all__ = [&quot;EngineRef&quot;, &quot;SearchQuery&quot;]</span>
  40. <span class="kn">import</span><span class="w"> </span><span class="nn">threading</span>
  41. <span class="kn">from</span><span class="w"> </span><span class="nn">timeit</span><span class="w"> </span><span class="kn">import</span> <span class="n">default_timer</span>
  42. <span class="kn">from</span><span class="w"> </span><span class="nn">uuid</span><span class="w"> </span><span class="kn">import</span> <span class="n">uuid4</span>
  43. <span class="kn">from</span><span class="w"> </span><span class="nn">flask</span><span class="w"> </span><span class="kn">import</span> <span class="n">copy_current_request_context</span>
  44. <span class="kn">from</span><span class="w"> </span><span class="nn">searx</span><span class="w"> </span><span class="kn">import</span> <span class="n">logger</span>
  45. <span class="kn">from</span><span class="w"> </span><span class="nn">searx</span><span class="w"> </span><span class="kn">import</span> <span class="n">settings</span>
  46. <span class="kn">import</span><span class="w"> </span><span class="nn">searx.answerers</span>
  47. <span class="kn">import</span><span class="w"> </span><span class="nn">searx.plugins</span>
  48. <span class="kn">from</span><span class="w"> </span><span class="nn">searx.engines</span><span class="w"> </span><span class="kn">import</span> <span class="n">load_engines</span>
  49. <span class="kn">from</span><span class="w"> </span><span class="nn">searx.extended_types</span><span class="w"> </span><span class="kn">import</span> <span class="n">SXNG_Request</span>
  50. <span class="kn">from</span><span class="w"> </span><span class="nn">searx.external_bang</span><span class="w"> </span><span class="kn">import</span> <span class="n">get_bang_url</span>
  51. <span class="kn">from</span><span class="w"> </span><span class="nn">searx.metrics</span><span class="w"> </span><span class="kn">import</span> <span class="n">initialize</span> <span class="k">as</span> <span class="n">initialize_metrics</span><span class="p">,</span> <span class="n">counter_inc</span><span class="p">,</span> <span class="n">histogram_observe_time</span>
  52. <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">initialize</span> <span class="k">as</span> <span class="n">initialize_network</span><span class="p">,</span> <span class="n">check_network_configuration</span>
  53. <span class="kn">from</span><span class="w"> </span><span class="nn">searx.results</span><span class="w"> </span><span class="kn">import</span> <span class="n">ResultContainer</span>
  54. <span class="kn">from</span><span class="w"> </span><span class="nn">searx.search.checker</span><span class="w"> </span><span class="kn">import</span> <span class="n">initialize</span> <span class="k">as</span> <span class="n">initialize_checker</span>
  55. <span class="kn">from</span><span class="w"> </span><span class="nn">searx.search.models</span><span class="w"> </span><span class="kn">import</span> <span class="n">SearchQuery</span>
  56. <span class="kn">from</span><span class="w"> </span><span class="nn">searx.search.processors</span><span class="w"> </span><span class="kn">import</span> <span class="n">PROCESSORS</span><span class="p">,</span> <span class="n">initialize</span> <span class="k">as</span> <span class="n">initialize_processors</span>
  57. <span class="kn">from</span><span class="w"> </span><span class="nn">.models</span><span class="w"> </span><span class="kn">import</span> <span class="n">EngineRef</span><span class="p">,</span> <span class="n">SearchQuery</span>
  58. <span class="n">logger</span> <span class="o">=</span> <span class="n">logger</span><span class="o">.</span><span class="n">getChild</span><span class="p">(</span><span class="s1">&#39;search&#39;</span><span class="p">)</span>
  59. <span class="k">def</span><span class="w"> </span><span class="nf">initialize</span><span class="p">(</span><span class="n">settings_engines</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">enable_checker</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">check_network</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">enable_metrics</span><span class="o">=</span><span class="kc">True</span><span class="p">):</span>
  60. <span class="n">settings_engines</span> <span class="o">=</span> <span class="n">settings_engines</span> <span class="ow">or</span> <span class="n">settings</span><span class="p">[</span><span class="s1">&#39;engines&#39;</span><span class="p">]</span>
  61. <span class="n">load_engines</span><span class="p">(</span><span class="n">settings_engines</span><span class="p">)</span>
  62. <span class="n">initialize_network</span><span class="p">(</span><span class="n">settings_engines</span><span class="p">,</span> <span class="n">settings</span><span class="p">[</span><span class="s1">&#39;outgoing&#39;</span><span class="p">])</span>
  63. <span class="k">if</span> <span class="n">check_network</span><span class="p">:</span>
  64. <span class="n">check_network_configuration</span><span class="p">()</span>
  65. <span class="n">initialize_metrics</span><span class="p">([</span><span class="n">engine</span><span class="p">[</span><span class="s1">&#39;name&#39;</span><span class="p">]</span> <span class="k">for</span> <span class="n">engine</span> <span class="ow">in</span> <span class="n">settings_engines</span><span class="p">],</span> <span class="n">enable_metrics</span><span class="p">)</span>
  66. <span class="n">initialize_processors</span><span class="p">(</span><span class="n">settings_engines</span><span class="p">)</span>
  67. <span class="k">if</span> <span class="n">enable_checker</span><span class="p">:</span>
  68. <span class="n">initialize_checker</span><span class="p">()</span>
  69. <div class="viewcode-block" id="Search">
  70. <a class="viewcode-back" href="../../src/searx.search.html#searx.search.Search">[docs]</a>
  71. <span class="k">class</span><span class="w"> </span><span class="nc">Search</span><span class="p">:</span>
  72. <span class="w"> </span><span class="sd">&quot;&quot;&quot;Search information container&quot;&quot;&quot;</span>
  73. <span class="vm">__slots__</span> <span class="o">=</span> <span class="s2">&quot;search_query&quot;</span><span class="p">,</span> <span class="s2">&quot;result_container&quot;</span><span class="p">,</span> <span class="s2">&quot;start_time&quot;</span><span class="p">,</span> <span class="s2">&quot;actual_timeout&quot;</span>
  74. <span class="k">def</span><span class="w"> </span><span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">search_query</span><span class="p">:</span> <span class="n">SearchQuery</span><span class="p">):</span>
  75. <span class="w"> </span><span class="sd">&quot;&quot;&quot;Initialize the Search&quot;&quot;&quot;</span>
  76. <span class="c1"># init vars</span>
  77. <span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="fm">__init__</span><span class="p">()</span>
  78. <span class="bp">self</span><span class="o">.</span><span class="n">search_query</span> <span class="o">=</span> <span class="n">search_query</span>
  79. <span class="bp">self</span><span class="o">.</span><span class="n">result_container</span> <span class="o">=</span> <span class="n">ResultContainer</span><span class="p">()</span>
  80. <span class="bp">self</span><span class="o">.</span><span class="n">start_time</span> <span class="o">=</span> <span class="kc">None</span>
  81. <span class="bp">self</span><span class="o">.</span><span class="n">actual_timeout</span> <span class="o">=</span> <span class="kc">None</span>
  82. <span class="k">def</span><span class="w"> </span><span class="nf">search_external_bang</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
  83. <span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
  84. <span class="sd"> Check if there is a external bang.</span>
  85. <span class="sd"> If yes, update self.result_container and return True</span>
  86. <span class="sd"> &quot;&quot;&quot;</span>
  87. <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">search_query</span><span class="o">.</span><span class="n">external_bang</span><span class="p">:</span>
  88. <span class="bp">self</span><span class="o">.</span><span class="n">result_container</span><span class="o">.</span><span class="n">redirect_url</span> <span class="o">=</span> <span class="n">get_bang_url</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">search_query</span><span class="p">)</span>
  89. <span class="c1"># This means there was a valid bang and the</span>
  90. <span class="c1"># rest of the search does not need to be continued</span>
  91. <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">result_container</span><span class="o">.</span><span class="n">redirect_url</span><span class="p">,</span> <span class="nb">str</span><span class="p">):</span>
  92. <span class="k">return</span> <span class="kc">True</span>
  93. <span class="k">return</span> <span class="kc">False</span>
  94. <span class="k">def</span><span class="w"> </span><span class="nf">search_answerers</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
  95. <span class="n">results</span> <span class="o">=</span> <span class="n">searx</span><span class="o">.</span><span class="n">answerers</span><span class="o">.</span><span class="n">STORAGE</span><span class="o">.</span><span class="n">ask</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">search_query</span><span class="o">.</span><span class="n">query</span><span class="p">)</span>
  96. <span class="bp">self</span><span class="o">.</span><span class="n">result_container</span><span class="o">.</span><span class="n">extend</span><span class="p">(</span><span class="kc">None</span><span class="p">,</span> <span class="n">results</span><span class="p">)</span>
  97. <span class="k">return</span> <span class="nb">bool</span><span class="p">(</span><span class="n">results</span><span class="p">)</span>
  98. <span class="c1"># do search-request</span>
  99. <span class="k">def</span><span class="w"> </span><span class="nf">_get_requests</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
  100. <span class="c1"># init vars</span>
  101. <span class="n">requests</span> <span class="o">=</span> <span class="p">[]</span>
  102. <span class="c1"># max of all selected engine timeout</span>
  103. <span class="n">default_timeout</span> <span class="o">=</span> <span class="mi">0</span>
  104. <span class="c1"># start search-request for all selected engines</span>
  105. <span class="k">for</span> <span class="n">engineref</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">search_query</span><span class="o">.</span><span class="n">engineref_list</span><span class="p">:</span>
  106. <span class="n">processor</span> <span class="o">=</span> <span class="n">PROCESSORS</span><span class="p">[</span><span class="n">engineref</span><span class="o">.</span><span class="n">name</span><span class="p">]</span>
  107. <span class="c1"># stop the request now if the engine is suspend</span>
  108. <span class="k">if</span> <span class="n">processor</span><span class="o">.</span><span class="n">extend_container_if_suspended</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">result_container</span><span class="p">):</span>
  109. <span class="k">continue</span>
  110. <span class="c1"># set default request parameters</span>
  111. <span class="n">request_params</span> <span class="o">=</span> <span class="n">processor</span><span class="o">.</span><span class="n">get_params</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">search_query</span><span class="p">,</span> <span class="n">engineref</span><span class="o">.</span><span class="n">category</span><span class="p">)</span>
  112. <span class="k">if</span> <span class="n">request_params</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
  113. <span class="k">continue</span>
  114. <span class="n">counter_inc</span><span class="p">(</span><span class="s1">&#39;engine&#39;</span><span class="p">,</span> <span class="n">engineref</span><span class="o">.</span><span class="n">name</span><span class="p">,</span> <span class="s1">&#39;search&#39;</span><span class="p">,</span> <span class="s1">&#39;count&#39;</span><span class="p">,</span> <span class="s1">&#39;sent&#39;</span><span class="p">)</span>
  115. <span class="c1"># append request to list</span>
  116. <span class="n">requests</span><span class="o">.</span><span class="n">append</span><span class="p">((</span><span class="n">engineref</span><span class="o">.</span><span class="n">name</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">search_query</span><span class="o">.</span><span class="n">query</span><span class="p">,</span> <span class="n">request_params</span><span class="p">))</span>
  117. <span class="c1"># update default_timeout</span>
  118. <span class="n">default_timeout</span> <span class="o">=</span> <span class="nb">max</span><span class="p">(</span><span class="n">default_timeout</span><span class="p">,</span> <span class="n">processor</span><span class="o">.</span><span class="n">engine</span><span class="o">.</span><span class="n">timeout</span><span class="p">)</span>
  119. <span class="c1"># adjust timeout</span>
  120. <span class="n">max_request_timeout</span> <span class="o">=</span> <span class="n">settings</span><span class="p">[</span><span class="s1">&#39;outgoing&#39;</span><span class="p">][</span><span class="s1">&#39;max_request_timeout&#39;</span><span class="p">]</span>
  121. <span class="n">actual_timeout</span> <span class="o">=</span> <span class="n">default_timeout</span>
  122. <span class="n">query_timeout</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">search_query</span><span class="o">.</span><span class="n">timeout_limit</span>
  123. <span class="k">if</span> <span class="n">max_request_timeout</span> <span class="ow">is</span> <span class="kc">None</span> <span class="ow">and</span> <span class="n">query_timeout</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
  124. <span class="c1"># No max, no user query: default_timeout</span>
  125. <span class="k">pass</span>
  126. <span class="k">elif</span> <span class="n">max_request_timeout</span> <span class="ow">is</span> <span class="kc">None</span> <span class="ow">and</span> <span class="n">query_timeout</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
  127. <span class="c1"># No max, but user query: From user query except if above default</span>
  128. <span class="n">actual_timeout</span> <span class="o">=</span> <span class="nb">min</span><span class="p">(</span><span class="n">default_timeout</span><span class="p">,</span> <span class="n">query_timeout</span><span class="p">)</span>
  129. <span class="k">elif</span> <span class="n">max_request_timeout</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span> <span class="ow">and</span> <span class="n">query_timeout</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
  130. <span class="c1"># Max, no user query: Default except if above max</span>
  131. <span class="n">actual_timeout</span> <span class="o">=</span> <span class="nb">min</span><span class="p">(</span><span class="n">default_timeout</span><span class="p">,</span> <span class="n">max_request_timeout</span><span class="p">)</span>
  132. <span class="k">elif</span> <span class="n">max_request_timeout</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span> <span class="ow">and</span> <span class="n">query_timeout</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
  133. <span class="c1"># Max &amp; user query: From user query except if above max</span>
  134. <span class="n">actual_timeout</span> <span class="o">=</span> <span class="nb">min</span><span class="p">(</span><span class="n">query_timeout</span><span class="p">,</span> <span class="n">max_request_timeout</span><span class="p">)</span>
  135. <span class="n">logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span>
  136. <span class="s2">&quot;actual_timeout=</span><span class="si">{0}</span><span class="s2"> (default_timeout=</span><span class="si">{1}</span><span class="s2">, ?timeout_limit=</span><span class="si">{2}</span><span class="s2">, max_request_timeout=</span><span class="si">{3}</span><span class="s2">)&quot;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
  137. <span class="n">actual_timeout</span><span class="p">,</span> <span class="n">default_timeout</span><span class="p">,</span> <span class="n">query_timeout</span><span class="p">,</span> <span class="n">max_request_timeout</span>
  138. <span class="p">)</span>
  139. <span class="p">)</span>
  140. <span class="k">return</span> <span class="n">requests</span><span class="p">,</span> <span class="n">actual_timeout</span>
  141. <span class="k">def</span><span class="w"> </span><span class="nf">search_multiple_requests</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">requests</span><span class="p">):</span>
  142. <span class="c1"># pylint: disable=protected-access</span>
  143. <span class="n">search_id</span> <span class="o">=</span> <span class="nb">str</span><span class="p">(</span><span class="n">uuid4</span><span class="p">())</span>
  144. <span class="k">for</span> <span class="n">engine_name</span><span class="p">,</span> <span class="n">query</span><span class="p">,</span> <span class="n">request_params</span> <span class="ow">in</span> <span class="n">requests</span><span class="p">:</span>
  145. <span class="n">_search</span> <span class="o">=</span> <span class="n">copy_current_request_context</span><span class="p">(</span><span class="n">PROCESSORS</span><span class="p">[</span><span class="n">engine_name</span><span class="p">]</span><span class="o">.</span><span class="n">search</span><span class="p">)</span>
  146. <span class="n">th</span> <span class="o">=</span> <span class="n">threading</span><span class="o">.</span><span class="n">Thread</span><span class="p">(</span> <span class="c1"># pylint: disable=invalid-name</span>
  147. <span class="n">target</span><span class="o">=</span><span class="n">_search</span><span class="p">,</span>
  148. <span class="n">args</span><span class="o">=</span><span class="p">(</span><span class="n">query</span><span class="p">,</span> <span class="n">request_params</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">result_container</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">start_time</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">actual_timeout</span><span class="p">),</span>
  149. <span class="n">name</span><span class="o">=</span><span class="n">search_id</span><span class="p">,</span>
  150. <span class="p">)</span>
  151. <span class="n">th</span><span class="o">.</span><span class="n">_timeout</span> <span class="o">=</span> <span class="kc">False</span>
  152. <span class="n">th</span><span class="o">.</span><span class="n">_engine_name</span> <span class="o">=</span> <span class="n">engine_name</span>
  153. <span class="n">th</span><span class="o">.</span><span class="n">start</span><span class="p">()</span>
  154. <span class="k">for</span> <span class="n">th</span> <span class="ow">in</span> <span class="n">threading</span><span class="o">.</span><span class="n">enumerate</span><span class="p">():</span> <span class="c1"># pylint: disable=invalid-name</span>
  155. <span class="k">if</span> <span class="n">th</span><span class="o">.</span><span class="n">name</span> <span class="o">==</span> <span class="n">search_id</span><span class="p">:</span>
  156. <span class="n">remaining_time</span> <span class="o">=</span> <span class="nb">max</span><span class="p">(</span><span class="mf">0.0</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">actual_timeout</span> <span class="o">-</span> <span class="p">(</span><span class="n">default_timer</span><span class="p">()</span> <span class="o">-</span> <span class="bp">self</span><span class="o">.</span><span class="n">start_time</span><span class="p">))</span>
  157. <span class="n">th</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">remaining_time</span><span class="p">)</span>
  158. <span class="k">if</span> <span class="n">th</span><span class="o">.</span><span class="n">is_alive</span><span class="p">():</span>
  159. <span class="n">th</span><span class="o">.</span><span class="n">_timeout</span> <span class="o">=</span> <span class="kc">True</span>
  160. <span class="bp">self</span><span class="o">.</span><span class="n">result_container</span><span class="o">.</span><span class="n">add_unresponsive_engine</span><span class="p">(</span><span class="n">th</span><span class="o">.</span><span class="n">_engine_name</span><span class="p">,</span> <span class="s1">&#39;timeout&#39;</span><span class="p">)</span>
  161. <span class="n">PROCESSORS</span><span class="p">[</span><span class="n">th</span><span class="o">.</span><span class="n">_engine_name</span><span class="p">]</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">error</span><span class="p">(</span><span class="s1">&#39;engine timeout&#39;</span><span class="p">)</span>
  162. <span class="k">def</span><span class="w"> </span><span class="nf">search_standard</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
  163. <span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
  164. <span class="sd"> Update self.result_container, self.actual_timeout</span>
  165. <span class="sd"> &quot;&quot;&quot;</span>
  166. <span class="n">requests</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">actual_timeout</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_get_requests</span><span class="p">()</span>
  167. <span class="c1"># send all search-request</span>
  168. <span class="k">if</span> <span class="n">requests</span><span class="p">:</span>
  169. <span class="bp">self</span><span class="o">.</span><span class="n">search_multiple_requests</span><span class="p">(</span><span class="n">requests</span><span class="p">)</span>
  170. <span class="c1"># return results, suggestions, answers and infoboxes</span>
  171. <span class="k">return</span> <span class="kc">True</span>
  172. <span class="c1"># do search-request</span>
  173. <div class="viewcode-block" id="Search.search">
  174. <a class="viewcode-back" href="../../src/searx.search.html#searx.search.Search.search">[docs]</a>
  175. <span class="k">def</span><span class="w"> </span><span class="nf">search</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">ResultContainer</span><span class="p">:</span>
  176. <span class="bp">self</span><span class="o">.</span><span class="n">start_time</span> <span class="o">=</span> <span class="n">default_timer</span><span class="p">()</span>
  177. <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">search_external_bang</span><span class="p">():</span>
  178. <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">search_answerers</span><span class="p">():</span>
  179. <span class="bp">self</span><span class="o">.</span><span class="n">search_standard</span><span class="p">()</span>
  180. <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">result_container</span></div>
  181. </div>
  182. <div class="viewcode-block" id="SearchWithPlugins">
  183. <a class="viewcode-back" href="../../src/searx.search.html#searx.search.SearchWithPlugins">[docs]</a>
  184. <span class="k">class</span><span class="w"> </span><span class="nc">SearchWithPlugins</span><span class="p">(</span><span class="n">Search</span><span class="p">):</span>
  185. <span class="w"> </span><span class="sd">&quot;&quot;&quot;Inherit from the Search class, add calls to the plugins.&quot;&quot;&quot;</span>
  186. <span class="vm">__slots__</span> <span class="o">=</span> <span class="s1">&#39;user_plugins&#39;</span><span class="p">,</span> <span class="s1">&#39;request&#39;</span>
  187. <span class="k">def</span><span class="w"> </span><span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">search_query</span><span class="p">:</span> <span class="n">SearchQuery</span><span class="p">,</span> <span class="n">request</span><span class="p">:</span> <span class="n">SXNG_Request</span><span class="p">,</span> <span class="n">user_plugins</span><span class="p">:</span> <span class="nb">list</span><span class="p">[</span><span class="nb">str</span><span class="p">]):</span>
  188. <span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="n">search_query</span><span class="p">)</span>
  189. <span class="bp">self</span><span class="o">.</span><span class="n">user_plugins</span> <span class="o">=</span> <span class="n">user_plugins</span>
  190. <span class="bp">self</span><span class="o">.</span><span class="n">result_container</span><span class="o">.</span><span class="n">on_result</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_on_result</span>
  191. <span class="c1"># pylint: disable=line-too-long</span>
  192. <span class="c1"># get the &quot;real&quot; request to use it outside the Flask context.</span>
  193. <span class="c1"># see</span>
  194. <span class="c1"># * https://github.com/pallets/flask/blob/d01d26e5210e3ee4cbbdef12f05c886e08e92852/src/flask/globals.py#L55</span>
  195. <span class="c1"># * https://github.com/pallets/werkzeug/blob/3c5d3c9bd0d9ce64590f0af8997a38f3823b368d/src/werkzeug/local.py#L548-L559</span>
  196. <span class="c1"># * https://werkzeug.palletsprojects.com/en/2.0.x/local/#werkzeug.local.LocalProxy._get_current_object</span>
  197. <span class="c1"># pylint: enable=line-too-long</span>
  198. <span class="bp">self</span><span class="o">.</span><span class="n">request</span> <span class="o">=</span> <span class="n">request</span><span class="o">.</span><span class="n">_get_current_object</span><span class="p">()</span>
  199. <span class="k">def</span><span class="w"> </span><span class="nf">_on_result</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">result</span><span class="p">):</span>
  200. <span class="k">return</span> <span class="n">searx</span><span class="o">.</span><span class="n">plugins</span><span class="o">.</span><span class="n">STORAGE</span><span class="o">.</span><span class="n">on_result</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">request</span><span class="p">,</span> <span class="bp">self</span><span class="p">,</span> <span class="n">result</span><span class="p">)</span>
  201. <div class="viewcode-block" id="SearchWithPlugins.search">
  202. <a class="viewcode-back" href="../../src/searx.search.html#searx.search.SearchWithPlugins.search">[docs]</a>
  203. <span class="k">def</span><span class="w"> </span><span class="nf">search</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">ResultContainer</span><span class="p">:</span>
  204. <span class="k">if</span> <span class="n">searx</span><span class="o">.</span><span class="n">plugins</span><span class="o">.</span><span class="n">STORAGE</span><span class="o">.</span><span class="n">pre_search</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">request</span><span class="p">,</span> <span class="bp">self</span><span class="p">):</span>
  205. <span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="n">search</span><span class="p">()</span>
  206. <span class="n">searx</span><span class="o">.</span><span class="n">plugins</span><span class="o">.</span><span class="n">STORAGE</span><span class="o">.</span><span class="n">post_search</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">request</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span>
  207. <span class="bp">self</span><span class="o">.</span><span class="n">result_container</span><span class="o">.</span><span class="n">close</span><span class="p">()</span>
  208. <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">result_container</span></div>
  209. </div>
  210. </pre></div>
  211. <div class="clearer"></div>
  212. </div>
  213. </div>
  214. </div>
  215. <span id="sidebar-top"></span>
  216. <div class="sphinxsidebar" role="navigation" aria-label="Main">
  217. <div class="sphinxsidebarwrapper">
  218. <p class="logo"><a href="../../index.html">
  219. <img class="logo" src="../../_static/searxng-wordmark.svg" alt="Logo of SearXNG"/>
  220. </a></p>
  221. <h3><a href="../../index.html">Table of Contents</a></h3>
  222. <ul>
  223. <li class="toctree-l1"><a class="reference internal" href="../../user/index.html">User information</a></li>
  224. <li class="toctree-l1"><a class="reference internal" href="../../own-instance.html">Why use a private instance?</a></li>
  225. <li class="toctree-l1"><a class="reference internal" href="../../admin/index.html">Administrator documentation</a></li>
  226. <li class="toctree-l1"><a class="reference internal" href="../../dev/index.html">Developer documentation</a></li>
  227. <li class="toctree-l1"><a class="reference internal" href="../../utils/index.html">DevOps tooling box</a></li>
  228. <li class="toctree-l1"><a class="reference internal" href="../../src/index.html">Source-Code</a></li>
  229. </ul>
  230. <h3>Project Links</h3>
  231. <ul>
  232. <li><a href="https://github.com/searxng/searxng/tree/master">Source</a>
  233. <li><a href="https://github.com/searxng/searxng/wiki">Wiki</a>
  234. <li><a href="https://searx.space">Public instances</a>
  235. <li><a href="https://github.com/searxng/searxng/issues">Issue Tracker</a>
  236. </ul><h3>Navigation</h3>
  237. <ul>
  238. <li><a href="../../index.html">Overview</a>
  239. <ul>
  240. <li><a href="../index.html">Module code</a>
  241. </ul>
  242. </li>
  243. </ul>
  244. </li>
  245. </ul>
  246. <search id="searchbox" style="display: none" role="search">
  247. <h3 id="searchlabel">Quick search</h3>
  248. <div class="searchformwrapper">
  249. <form class="search" action="../../search.html" method="get">
  250. <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
  251. <input type="submit" value="Go" />
  252. </form>
  253. </div>
  254. </search>
  255. <script>document.getElementById('searchbox').style.display = "block"</script>
  256. </div>
  257. </div>
  258. <div class="clearer"></div>
  259. </div>
  260. <div class="footer" role="contentinfo">
  261. &#169; Copyright SearXNG team.
  262. </div>
  263. </body>
  264. </html>