_core.html 44 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444
  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.plugins._core &#8212; SearXNG Documentation (2025.4.30+fd33559cf)</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=b12b0e12"></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.4.30+fd33559cf" 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.4.30+fd33559cf)</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.plugins._core</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.plugins._core</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=too-few-public-methods,missing-module-docstring</span>
  38. <span class="kn">from</span><span class="w"> </span><span class="nn">__future__</span><span class="w"> </span><span class="kn">import</span> <span class="n">annotations</span>
  39. <span class="n">__all__</span> <span class="o">=</span> <span class="p">[</span><span class="s2">&quot;PluginInfo&quot;</span><span class="p">,</span> <span class="s2">&quot;Plugin&quot;</span><span class="p">,</span> <span class="s2">&quot;PluginCfg&quot;</span><span class="p">,</span> <span class="s2">&quot;PluginStorage&quot;</span><span class="p">]</span>
  40. <span class="kn">import</span><span class="w"> </span><span class="nn">abc</span>
  41. <span class="kn">import</span><span class="w"> </span><span class="nn">importlib</span>
  42. <span class="kn">import</span><span class="w"> </span><span class="nn">inspect</span>
  43. <span class="kn">import</span><span class="w"> </span><span class="nn">logging</span>
  44. <span class="kn">import</span><span class="w"> </span><span class="nn">re</span>
  45. <span class="kn">import</span><span class="w"> </span><span class="nn">typing</span>
  46. <span class="kn">from</span><span class="w"> </span><span class="nn">dataclasses</span><span class="w"> </span><span class="kn">import</span> <span class="n">dataclass</span><span class="p">,</span> <span class="n">field</span>
  47. <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>
  48. <span class="kn">from</span><span class="w"> </span><span class="nn">searx.result_types</span><span class="w"> </span><span class="kn">import</span> <span class="n">Result</span>
  49. <span class="k">if</span> <span class="n">typing</span><span class="o">.</span><span class="n">TYPE_CHECKING</span><span class="p">:</span>
  50. <span class="kn">from</span><span class="w"> </span><span class="nn">searx.search</span><span class="w"> </span><span class="kn">import</span> <span class="n">SearchWithPlugins</span>
  51. <span class="kn">import</span><span class="w"> </span><span class="nn">flask</span>
  52. <span class="n">log</span><span class="p">:</span> <span class="n">logging</span><span class="o">.</span><span class="n">Logger</span> <span class="o">=</span> <span class="n">logging</span><span class="o">.</span><span class="n">getLogger</span><span class="p">(</span><span class="s2">&quot;searx.plugins&quot;</span><span class="p">)</span>
  53. <div class="viewcode-block" id="PluginInfo">
  54. <a class="viewcode-back" href="../../../dev/plugins/development.html#searx.plugins.PluginInfo">[docs]</a>
  55. <span class="nd">@dataclass</span>
  56. <span class="k">class</span><span class="w"> </span><span class="nc">PluginInfo</span><span class="p">:</span>
  57. <span class="w"> </span><span class="sd">&quot;&quot;&quot;Object that holds informations about a *plugin*, these infos are shown to</span>
  58. <span class="sd"> the user in the Preferences menu.</span>
  59. <span class="sd"> To be able to translate the information into other languages, the text must</span>
  60. <span class="sd"> be written in English and translated with :py:obj:`flask_babel.gettext`.</span>
  61. <span class="sd"> &quot;&quot;&quot;</span>
  62. <span class="nb">id</span><span class="p">:</span> <span class="nb">str</span>
  63. <span class="w"> </span><span class="sd">&quot;&quot;&quot;The ID-selector in HTML/CSS `#&lt;id&gt;`.&quot;&quot;&quot;</span>
  64. <span class="n">name</span><span class="p">:</span> <span class="nb">str</span>
  65. <span class="w"> </span><span class="sd">&quot;&quot;&quot;Name of the *plugin*.&quot;&quot;&quot;</span>
  66. <span class="n">description</span><span class="p">:</span> <span class="nb">str</span>
  67. <span class="w"> </span><span class="sd">&quot;&quot;&quot;Short description of the *answerer*.&quot;&quot;&quot;</span>
  68. <span class="n">preference_section</span><span class="p">:</span> <span class="n">typing</span><span class="o">.</span><span class="n">Literal</span><span class="p">[</span><span class="s2">&quot;general&quot;</span><span class="p">,</span> <span class="s2">&quot;ui&quot;</span><span class="p">,</span> <span class="s2">&quot;privacy&quot;</span><span class="p">,</span> <span class="s2">&quot;query&quot;</span><span class="p">]</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="s2">&quot;general&quot;</span>
  69. <span class="w"> </span><span class="sd">&quot;&quot;&quot;Section (tab/group) in the preferences where this plugin is shown to the</span>
  70. <span class="sd"> user.</span>
  71. <span class="sd"> The value ``query`` is reserved for plugins that are activated via a</span>
  72. <span class="sd"> *keyword* as part of a search query, see:</span>
  73. <span class="sd"> - :py:obj:`PluginInfo.examples`</span>
  74. <span class="sd"> - :py:obj:`Plugin.keywords`</span>
  75. <span class="sd"> Those plugins are shown in the preferences in tab *Special Queries*.</span>
  76. <span class="sd"> &quot;&quot;&quot;</span>
  77. <span class="n">examples</span><span class="p">:</span> <span class="nb">list</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="n">field</span><span class="p">(</span><span class="n">default_factory</span><span class="o">=</span><span class="nb">list</span><span class="p">)</span>
  78. <span class="w"> </span><span class="sd">&quot;&quot;&quot;List of short examples of the usage / of query terms.&quot;&quot;&quot;</span>
  79. <span class="n">keywords</span><span class="p">:</span> <span class="nb">list</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="n">field</span><span class="p">(</span><span class="n">default_factory</span><span class="o">=</span><span class="nb">list</span><span class="p">)</span>
  80. <span class="w"> </span><span class="sd">&quot;&quot;&quot;See :py:obj:`Plugin.keywords`&quot;&quot;&quot;</span></div>
  81. <span class="n">ID_REGXP</span> <span class="o">=</span> <span class="n">re</span><span class="o">.</span><span class="n">compile</span><span class="p">(</span><span class="s2">&quot;[a-z][a-z0-9].*&quot;</span><span class="p">)</span>
  82. <div class="viewcode-block" id="Plugin">
  83. <a class="viewcode-back" href="../../../dev/plugins/development.html#searx.plugins.Plugin">[docs]</a>
  84. <span class="k">class</span><span class="w"> </span><span class="nc">Plugin</span><span class="p">(</span><span class="n">abc</span><span class="o">.</span><span class="n">ABC</span><span class="p">):</span>
  85. <span class="w"> </span><span class="sd">&quot;&quot;&quot;Abstract base class of all Plugins.&quot;&quot;&quot;</span>
  86. <span class="nb">id</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">&quot;&quot;</span>
  87. <span class="w"> </span><span class="sd">&quot;&quot;&quot;The ID (suffix) in the HTML form.&quot;&quot;&quot;</span>
  88. <span class="n">active</span><span class="p">:</span> <span class="n">typing</span><span class="o">.</span><span class="n">ClassVar</span><span class="p">[</span><span class="nb">bool</span><span class="p">]</span>
  89. <span class="w"> </span><span class="sd">&quot;&quot;&quot;Plugin is enabled/disabled by default (:py:obj:`PluginCfg.active`).&quot;&quot;&quot;</span>
  90. <span class="n">keywords</span><span class="p">:</span> <span class="nb">list</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="p">[]</span>
  91. <span class="w"> </span><span class="sd">&quot;&quot;&quot;Keywords in the search query that activate the plugin. The *keyword* is</span>
  92. <span class="sd"> the first word in a search query. If a plugin should be executed regardless</span>
  93. <span class="sd"> of the search query, the list of keywords should be empty (which is also the</span>
  94. <span class="sd"> default in the base class for Plugins).&quot;&quot;&quot;</span>
  95. <span class="n">log</span><span class="p">:</span> <span class="n">logging</span><span class="o">.</span><span class="n">Logger</span>
  96. <span class="w"> </span><span class="sd">&quot;&quot;&quot;A logger object, is automatically initialized when calling the</span>
  97. <span class="sd"> constructor (if not already set in the subclass).&quot;&quot;&quot;</span>
  98. <span class="n">info</span><span class="p">:</span> <span class="n">PluginInfo</span>
  99. <span class="w"> </span><span class="sd">&quot;&quot;&quot;Informations about the *plugin*, see :py:obj:`PluginInfo`.&quot;&quot;&quot;</span>
  100. <span class="n">fqn</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">&quot;&quot;</span>
  101. <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">plg_cfg</span><span class="p">:</span> <span class="n">PluginCfg</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
  102. <span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="fm">__init__</span><span class="p">()</span>
  103. <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">fqn</span><span class="p">:</span>
  104. <span class="bp">self</span><span class="o">.</span><span class="n">fqn</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="vm">__class__</span><span class="o">.</span><span class="vm">__mro__</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span><span class="o">.</span><span class="vm">__module__</span>
  105. <span class="c1"># names from the configuration</span>
  106. <span class="k">for</span> <span class="n">n</span><span class="p">,</span> <span class="n">v</span> <span class="ow">in</span> <span class="n">plg_cfg</span><span class="o">.</span><span class="vm">__dict__</span><span class="o">.</span><span class="n">items</span><span class="p">():</span>
  107. <span class="nb">setattr</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">n</span><span class="p">,</span> <span class="n">v</span><span class="p">)</span>
  108. <span class="c1"># names that must be set by the plugin implementation</span>
  109. <span class="k">for</span> <span class="n">attr</span> <span class="ow">in</span> <span class="p">[</span>
  110. <span class="s2">&quot;id&quot;</span><span class="p">,</span>
  111. <span class="p">]:</span>
  112. <span class="k">if</span> <span class="nb">getattr</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">attr</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
  113. <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;plugin </span><span class="si">{</span><span class="bp">self</span><span class="si">}</span><span class="s2"> is missing attribute </span><span class="si">{</span><span class="n">attr</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">)</span>
  114. <span class="k">if</span> <span class="ow">not</span> <span class="n">ID_REGXP</span><span class="o">.</span><span class="n">match</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">id</span><span class="p">):</span>
  115. <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;plugin ID </span><span class="si">{</span><span class="bp">self</span><span class="o">.</span><span class="n">id</span><span class="si">}</span><span class="s2"> contains invalid character (use lowercase ASCII)&quot;</span><span class="p">)</span>
  116. <span class="k">if</span> <span class="ow">not</span> <span class="nb">getattr</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="s2">&quot;log&quot;</span><span class="p">,</span> <span class="kc">None</span><span class="p">):</span>
  117. <span class="n">pkg_name</span> <span class="o">=</span> <span class="n">inspect</span><span class="o">.</span><span class="n">getmodule</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="vm">__class__</span><span class="p">)</span><span class="o">.</span><span class="n">__package__</span> <span class="c1"># type: ignore</span>
  118. <span class="bp">self</span><span class="o">.</span><span class="n">log</span> <span class="o">=</span> <span class="n">logging</span><span class="o">.</span><span class="n">getLogger</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;</span><span class="si">{</span><span class="n">pkg_name</span><span class="si">}</span><span class="s2">.</span><span class="si">{</span><span class="bp">self</span><span class="o">.</span><span class="n">id</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">)</span>
  119. <span class="k">def</span><span class="w"> </span><span class="fm">__hash__</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">int</span><span class="p">:</span>
  120. <span class="w"> </span><span class="sd">&quot;&quot;&quot;The hash value is used in :py:obj:`set`, for example, when an object</span>
  121. <span class="sd"> is added to the set. The hash value is also used in other contexts,</span>
  122. <span class="sd"> e.g. when checking for equality to identify identical plugins from</span>
  123. <span class="sd"> different sources (name collisions).&quot;&quot;&quot;</span>
  124. <span class="k">return</span> <span class="nb">id</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
  125. <span class="k">def</span><span class="w"> </span><span class="fm">__eq__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">other</span><span class="p">):</span>
  126. <span class="w"> </span><span class="sd">&quot;&quot;&quot;py:obj:`Plugin` objects are equal if the hash values of the two</span>
  127. <span class="sd"> objects are equal.&quot;&quot;&quot;</span>
  128. <span class="k">return</span> <span class="nb">hash</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">==</span> <span class="nb">hash</span><span class="p">(</span><span class="n">other</span><span class="p">)</span>
  129. <div class="viewcode-block" id="Plugin.init">
  130. <a class="viewcode-back" href="../../../dev/plugins/development.html#searx.plugins.Plugin.init">[docs]</a>
  131. <span class="k">def</span><span class="w"> </span><span class="nf">init</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">app</span><span class="p">:</span> <span class="s2">&quot;flask.Flask&quot;</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">bool</span><span class="p">:</span> <span class="c1"># pylint: disable=unused-argument</span>
  132. <span class="w"> </span><span class="sd">&quot;&quot;&quot;Initialization of the plugin, the return value decides whether this</span>
  133. <span class="sd"> plugin is active or not. Initialization only takes place once, at the</span>
  134. <span class="sd"> time the WEB application is set up. The base methode always returns</span>
  135. <span class="sd"> ``True``, the methode can be overwritten in the inheritances,</span>
  136. <span class="sd"> - ``True`` plugin is active</span>
  137. <span class="sd"> - ``False`` plugin is inactive</span>
  138. <span class="sd"> &quot;&quot;&quot;</span>
  139. <span class="k">return</span> <span class="kc">True</span></div>
  140. <span class="c1"># pylint: disable=unused-argument</span>
  141. <div class="viewcode-block" id="Plugin.pre_search">
  142. <a class="viewcode-back" href="../../../dev/plugins/development.html#searx.plugins.Plugin.pre_search">[docs]</a>
  143. <span class="k">def</span><span class="w"> </span><span class="nf">pre_search</span><span class="p">(</span><span class="bp">self</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">search</span><span class="p">:</span> <span class="s2">&quot;SearchWithPlugins&quot;</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">bool</span><span class="p">:</span>
  144. <span class="w"> </span><span class="sd">&quot;&quot;&quot;Runs BEFORE the search request and returns a boolean:</span>
  145. <span class="sd"> - ``True`` to continue the search</span>
  146. <span class="sd"> - ``False`` to stop the search</span>
  147. <span class="sd"> &quot;&quot;&quot;</span>
  148. <span class="k">return</span> <span class="kc">True</span></div>
  149. <div class="viewcode-block" id="Plugin.on_result">
  150. <a class="viewcode-back" href="../../../dev/plugins/development.html#searx.plugins.Plugin.on_result">[docs]</a>
  151. <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">request</span><span class="p">:</span> <span class="n">SXNG_Request</span><span class="p">,</span> <span class="n">search</span><span class="p">:</span> <span class="s2">&quot;SearchWithPlugins&quot;</span><span class="p">,</span> <span class="n">result</span><span class="p">:</span> <span class="n">Result</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">bool</span><span class="p">:</span>
  152. <span class="w"> </span><span class="sd">&quot;&quot;&quot;Runs for each result of each engine and returns a boolean:</span>
  153. <span class="sd"> - ``True`` to keep the result</span>
  154. <span class="sd"> - ``False`` to remove the result from the result list</span>
  155. <span class="sd"> The ``result`` can be modified to the needs.</span>
  156. <span class="sd"> .. hint::</span>
  157. <span class="sd"> If :py:obj:`Result.url &lt;searx.result_types._base.Result.url&gt;` is modified,</span>
  158. <span class="sd"> :py:obj:`Result.parsed_url &lt;searx.result_types._base.Result.parsed_url&gt;` must</span>
  159. <span class="sd"> be changed accordingly:</span>
  160. <span class="sd"> .. code:: python</span>
  161. <span class="sd"> result[&quot;parsed_url&quot;] = urlparse(result[&quot;url&quot;])</span>
  162. <span class="sd"> &quot;&quot;&quot;</span>
  163. <span class="k">return</span> <span class="kc">True</span></div>
  164. <div class="viewcode-block" id="Plugin.post_search">
  165. <a class="viewcode-back" href="../../../dev/plugins/development.html#searx.plugins.Plugin.post_search">[docs]</a>
  166. <span class="k">def</span><span class="w"> </span><span class="nf">post_search</span><span class="p">(</span><span class="bp">self</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">search</span><span class="p">:</span> <span class="s2">&quot;SearchWithPlugins&quot;</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span> <span class="o">|</span> <span class="n">typing</span><span class="o">.</span><span class="n">Sequence</span><span class="p">[</span><span class="n">Result</span><span class="p">]:</span>
  167. <span class="w"> </span><span class="sd">&quot;&quot;&quot;Runs AFTER the search request. Can return a list of</span>
  168. <span class="sd"> :py:obj:`Result &lt;searx.result_types._base.Result&gt;` objects to be added to the</span>
  169. <span class="sd"> final result list.&quot;&quot;&quot;</span>
  170. <span class="k">return</span></div>
  171. </div>
  172. <div class="viewcode-block" id="PluginCfg">
  173. <a class="viewcode-back" href="../../../dev/plugins/development.html#searx.plugins.PluginCfg">[docs]</a>
  174. <span class="nd">@dataclass</span>
  175. <span class="k">class</span><span class="w"> </span><span class="nc">PluginCfg</span><span class="p">:</span>
  176. <span class="w"> </span><span class="sd">&quot;&quot;&quot;Settings of a plugin.</span>
  177. <span class="sd"> .. code:: yaml</span>
  178. <span class="sd"> mypackage.mymodule.MyPlugin:</span>
  179. <span class="sd"> active: true</span>
  180. <span class="sd"> &quot;&quot;&quot;</span>
  181. <span class="n">active</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span>
  182. <span class="w"> </span><span class="sd">&quot;&quot;&quot;Plugin is active by default and the user can *opt-out* in the preferences.&quot;&quot;&quot;</span></div>
  183. <div class="viewcode-block" id="PluginStorage">
  184. <a class="viewcode-back" href="../../../dev/plugins/development.html#searx.plugins.PluginStorage">[docs]</a>
  185. <span class="k">class</span><span class="w"> </span><span class="nc">PluginStorage</span><span class="p">:</span>
  186. <span class="w"> </span><span class="sd">&quot;&quot;&quot;A storage for managing the *plugins* of SearXNG.&quot;&quot;&quot;</span>
  187. <span class="n">plugin_list</span><span class="p">:</span> <span class="nb">set</span><span class="p">[</span><span class="n">Plugin</span><span class="p">]</span>
  188. <span class="w"> </span><span class="sd">&quot;&quot;&quot;The list of :py:obj:`Plugins` in this storage.&quot;&quot;&quot;</span>
  189. <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>
  190. <span class="bp">self</span><span class="o">.</span><span class="n">plugin_list</span> <span class="o">=</span> <span class="nb">set</span><span class="p">()</span>
  191. <span class="k">def</span><span class="w"> </span><span class="fm">__iter__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
  192. <span class="k">yield from</span> <span class="bp">self</span><span class="o">.</span><span class="n">plugin_list</span>
  193. <span class="k">def</span><span class="w"> </span><span class="fm">__len__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
  194. <span class="k">return</span> <span class="nb">len</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">plugin_list</span><span class="p">)</span>
  195. <span class="nd">@property</span>
  196. <span class="k">def</span><span class="w"> </span><span class="nf">info</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">list</span><span class="p">[</span><span class="n">PluginInfo</span><span class="p">]:</span>
  197. <span class="k">return</span> <span class="p">[</span><span class="n">p</span><span class="o">.</span><span class="n">info</span> <span class="k">for</span> <span class="n">p</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">plugin_list</span><span class="p">]</span>
  198. <div class="viewcode-block" id="PluginStorage.load_settings">
  199. <a class="viewcode-back" href="../../../dev/plugins/development.html#searx.plugins.PluginStorage.load_settings">[docs]</a>
  200. <span class="k">def</span><span class="w"> </span><span class="nf">load_settings</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">cfg</span><span class="p">:</span> <span class="nb">dict</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="nb">dict</span><span class="p">]):</span>
  201. <span class="w"> </span><span class="sd">&quot;&quot;&quot;Load plugins configured in SearXNG&#39;s settings :ref:`settings</span>
  202. <span class="sd"> plugins`.&quot;&quot;&quot;</span>
  203. <span class="k">for</span> <span class="n">fqn</span><span class="p">,</span> <span class="n">plg_settings</span> <span class="ow">in</span> <span class="n">cfg</span><span class="o">.</span><span class="n">items</span><span class="p">():</span>
  204. <span class="bp">cls</span> <span class="o">=</span> <span class="kc">None</span>
  205. <span class="n">mod_name</span><span class="p">,</span> <span class="n">cls_name</span> <span class="o">=</span> <span class="n">fqn</span><span class="o">.</span><span class="n">rsplit</span><span class="p">(</span><span class="s1">&#39;.&#39;</span><span class="p">,</span> <span class="mi">1</span><span class="p">)</span>
  206. <span class="k">try</span><span class="p">:</span>
  207. <span class="n">mod</span> <span class="o">=</span> <span class="n">importlib</span><span class="o">.</span><span class="n">import_module</span><span class="p">(</span><span class="n">mod_name</span><span class="p">)</span>
  208. <span class="bp">cls</span> <span class="o">=</span> <span class="nb">getattr</span><span class="p">(</span><span class="n">mod</span><span class="p">,</span> <span class="n">cls_name</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span>
  209. <span class="k">except</span> <span class="ne">Exception</span> <span class="k">as</span> <span class="n">exc</span><span class="p">:</span> <span class="c1"># pylint: disable=broad-exception-caught</span>
  210. <span class="n">log</span><span class="o">.</span><span class="n">exception</span><span class="p">(</span><span class="n">exc</span><span class="p">)</span>
  211. <span class="k">if</span> <span class="bp">cls</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
  212. <span class="n">msg</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">&quot;plugin </span><span class="si">{</span><span class="n">fqn</span><span class="si">}</span><span class="s2"> is not implemented&quot;</span>
  213. <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="n">msg</span><span class="p">)</span>
  214. <span class="n">plg</span> <span class="o">=</span> <span class="bp">cls</span><span class="p">(</span><span class="n">PluginCfg</span><span class="p">(</span><span class="o">**</span><span class="n">plg_settings</span><span class="p">))</span>
  215. <span class="bp">self</span><span class="o">.</span><span class="n">register</span><span class="p">(</span><span class="n">plg</span><span class="p">)</span></div>
  216. <div class="viewcode-block" id="PluginStorage.register">
  217. <a class="viewcode-back" href="../../../dev/plugins/development.html#searx.plugins.PluginStorage.register">[docs]</a>
  218. <span class="k">def</span><span class="w"> </span><span class="nf">register</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">plugin</span><span class="p">:</span> <span class="n">Plugin</span><span class="p">):</span>
  219. <span class="w"> </span><span class="sd">&quot;&quot;&quot;Register a :py:obj:`Plugin`. In case of name collision (if two</span>
  220. <span class="sd"> plugins have same ID) a :py:obj:`KeyError` exception is raised.</span>
  221. <span class="sd"> &quot;&quot;&quot;</span>
  222. <span class="k">if</span> <span class="n">plugin</span> <span class="ow">in</span> <span class="p">[</span><span class="n">p</span><span class="o">.</span><span class="n">id</span> <span class="k">for</span> <span class="n">p</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">plugin_list</span><span class="p">]:</span>
  223. <span class="n">msg</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">&quot;name collision &#39;</span><span class="si">{</span><span class="n">plugin</span><span class="o">.</span><span class="n">id</span><span class="si">}</span><span class="s2">&#39;&quot;</span>
  224. <span class="n">plugin</span><span class="o">.</span><span class="n">log</span><span class="o">.</span><span class="n">critical</span><span class="p">(</span><span class="n">msg</span><span class="p">)</span>
  225. <span class="k">raise</span> <span class="ne">KeyError</span><span class="p">(</span><span class="n">msg</span><span class="p">)</span>
  226. <span class="bp">self</span><span class="o">.</span><span class="n">plugin_list</span><span class="o">.</span><span class="n">add</span><span class="p">(</span><span class="n">plugin</span><span class="p">)</span>
  227. <span class="n">plugin</span><span class="o">.</span><span class="n">log</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s2">&quot;plugin has been loaded&quot;</span><span class="p">)</span></div>
  228. <div class="viewcode-block" id="PluginStorage.init">
  229. <a class="viewcode-back" href="../../../dev/plugins/development.html#searx.plugins.PluginStorage.init">[docs]</a>
  230. <span class="k">def</span><span class="w"> </span><span class="nf">init</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">app</span><span class="p">:</span> <span class="s2">&quot;flask.Flask&quot;</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
  231. <span class="w"> </span><span class="sd">&quot;&quot;&quot;Calls the method :py:obj:`Plugin.init` of each plugin in this</span>
  232. <span class="sd"> storage. Depending on its return value, the plugin is removed from</span>
  233. <span class="sd"> *this* storage or not.&quot;&quot;&quot;</span>
  234. <span class="k">for</span> <span class="n">plg</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">plugin_list</span><span class="o">.</span><span class="n">copy</span><span class="p">():</span>
  235. <span class="k">if</span> <span class="ow">not</span> <span class="n">plg</span><span class="o">.</span><span class="n">init</span><span class="p">(</span><span class="n">app</span><span class="p">):</span>
  236. <span class="bp">self</span><span class="o">.</span><span class="n">plugin_list</span><span class="o">.</span><span class="n">remove</span><span class="p">(</span><span class="n">plg</span><span class="p">)</span></div>
  237. <span class="k">def</span><span class="w"> </span><span class="nf">pre_search</span><span class="p">(</span><span class="bp">self</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">search</span><span class="p">:</span> <span class="s2">&quot;SearchWithPlugins&quot;</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">bool</span><span class="p">:</span>
  238. <span class="n">ret</span> <span class="o">=</span> <span class="kc">True</span>
  239. <span class="k">for</span> <span class="n">plugin</span> <span class="ow">in</span> <span class="p">[</span><span class="n">p</span> <span class="k">for</span> <span class="n">p</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">plugin_list</span> <span class="k">if</span> <span class="n">p</span><span class="o">.</span><span class="n">id</span> <span class="ow">in</span> <span class="n">search</span><span class="o">.</span><span class="n">user_plugins</span><span class="p">]:</span>
  240. <span class="k">try</span><span class="p">:</span>
  241. <span class="n">ret</span> <span class="o">=</span> <span class="nb">bool</span><span class="p">(</span><span class="n">plugin</span><span class="o">.</span><span class="n">pre_search</span><span class="p">(</span><span class="n">request</span><span class="o">=</span><span class="n">request</span><span class="p">,</span> <span class="n">search</span><span class="o">=</span><span class="n">search</span><span class="p">))</span>
  242. <span class="k">except</span> <span class="ne">Exception</span><span class="p">:</span> <span class="c1"># pylint: disable=broad-except</span>
  243. <span class="n">plugin</span><span class="o">.</span><span class="n">log</span><span class="o">.</span><span class="n">exception</span><span class="p">(</span><span class="s2">&quot;Exception while calling pre_search&quot;</span><span class="p">)</span>
  244. <span class="k">continue</span>
  245. <span class="k">if</span> <span class="ow">not</span> <span class="n">ret</span><span class="p">:</span>
  246. <span class="c1"># skip this search on the first False from a plugin</span>
  247. <span class="k">break</span>
  248. <span class="k">return</span> <span class="n">ret</span>
  249. <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">request</span><span class="p">:</span> <span class="n">SXNG_Request</span><span class="p">,</span> <span class="n">search</span><span class="p">:</span> <span class="s2">&quot;SearchWithPlugins&quot;</span><span class="p">,</span> <span class="n">result</span><span class="p">:</span> <span class="n">Result</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">bool</span><span class="p">:</span>
  250. <span class="n">ret</span> <span class="o">=</span> <span class="kc">True</span>
  251. <span class="k">for</span> <span class="n">plugin</span> <span class="ow">in</span> <span class="p">[</span><span class="n">p</span> <span class="k">for</span> <span class="n">p</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">plugin_list</span> <span class="k">if</span> <span class="n">p</span><span class="o">.</span><span class="n">id</span> <span class="ow">in</span> <span class="n">search</span><span class="o">.</span><span class="n">user_plugins</span><span class="p">]:</span>
  252. <span class="k">try</span><span class="p">:</span>
  253. <span class="n">ret</span> <span class="o">=</span> <span class="nb">bool</span><span class="p">(</span><span class="n">plugin</span><span class="o">.</span><span class="n">on_result</span><span class="p">(</span><span class="n">request</span><span class="o">=</span><span class="n">request</span><span class="p">,</span> <span class="n">search</span><span class="o">=</span><span class="n">search</span><span class="p">,</span> <span class="n">result</span><span class="o">=</span><span class="n">result</span><span class="p">))</span>
  254. <span class="k">except</span> <span class="ne">Exception</span><span class="p">:</span> <span class="c1"># pylint: disable=broad-except</span>
  255. <span class="n">plugin</span><span class="o">.</span><span class="n">log</span><span class="o">.</span><span class="n">exception</span><span class="p">(</span><span class="s2">&quot;Exception while calling on_result&quot;</span><span class="p">)</span>
  256. <span class="k">continue</span>
  257. <span class="k">if</span> <span class="ow">not</span> <span class="n">ret</span><span class="p">:</span>
  258. <span class="c1"># ignore this result item on the first False from a plugin</span>
  259. <span class="k">break</span>
  260. <span class="k">return</span> <span class="n">ret</span>
  261. <div class="viewcode-block" id="PluginStorage.post_search">
  262. <a class="viewcode-back" href="../../../dev/plugins/development.html#searx.plugins.PluginStorage.post_search">[docs]</a>
  263. <span class="k">def</span><span class="w"> </span><span class="nf">post_search</span><span class="p">(</span><span class="bp">self</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">search</span><span class="p">:</span> <span class="s2">&quot;SearchWithPlugins&quot;</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
  264. <span class="w"> </span><span class="sd">&quot;&quot;&quot;Extend :py:obj:`search.result_container</span>
  265. <span class="sd"> &lt;searx.results.ResultContainer`&gt; with result items from plugins listed</span>
  266. <span class="sd"> in :py:obj:`search.user_plugins &lt;SearchWithPlugins.user_plugins&gt;`.</span>
  267. <span class="sd"> &quot;&quot;&quot;</span>
  268. <span class="n">keyword</span> <span class="o">=</span> <span class="kc">None</span>
  269. <span class="k">for</span> <span class="n">keyword</span> <span class="ow">in</span> <span class="n">search</span><span class="o">.</span><span class="n">search_query</span><span class="o">.</span><span class="n">query</span><span class="o">.</span><span class="n">split</span><span class="p">():</span>
  270. <span class="k">if</span> <span class="n">keyword</span><span class="p">:</span>
  271. <span class="k">break</span>
  272. <span class="k">for</span> <span class="n">plugin</span> <span class="ow">in</span> <span class="p">[</span><span class="n">p</span> <span class="k">for</span> <span class="n">p</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">plugin_list</span> <span class="k">if</span> <span class="n">p</span><span class="o">.</span><span class="n">id</span> <span class="ow">in</span> <span class="n">search</span><span class="o">.</span><span class="n">user_plugins</span><span class="p">]:</span>
  273. <span class="k">if</span> <span class="n">plugin</span><span class="o">.</span><span class="n">keywords</span><span class="p">:</span>
  274. <span class="c1"># plugin with keywords: skip plugin if no keyword match</span>
  275. <span class="k">if</span> <span class="n">keyword</span> <span class="ow">and</span> <span class="n">keyword</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">plugin</span><span class="o">.</span><span class="n">keywords</span><span class="p">:</span>
  276. <span class="k">continue</span>
  277. <span class="k">try</span><span class="p">:</span>
  278. <span class="n">results</span> <span class="o">=</span> <span class="n">plugin</span><span class="o">.</span><span class="n">post_search</span><span class="p">(</span><span class="n">request</span><span class="o">=</span><span class="n">request</span><span class="p">,</span> <span class="n">search</span><span class="o">=</span><span class="n">search</span><span class="p">)</span> <span class="ow">or</span> <span class="p">[]</span>
  279. <span class="k">except</span> <span class="ne">Exception</span><span class="p">:</span> <span class="c1"># pylint: disable=broad-except</span>
  280. <span class="n">plugin</span><span class="o">.</span><span class="n">log</span><span class="o">.</span><span class="n">exception</span><span class="p">(</span><span class="s2">&quot;Exception while calling post_search&quot;</span><span class="p">)</span>
  281. <span class="k">continue</span>
  282. <span class="c1"># In case of *plugins* prefix ``plugin:`` is set, see searx.result_types.Result</span>
  283. <span class="n">search</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="sa">f</span><span class="s2">&quot;plugin: </span><span class="si">{</span><span class="n">plugin</span><span class="o">.</span><span class="n">id</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">,</span> <span class="n">results</span><span class="p">)</span></div>
  284. </div>
  285. </pre></div>
  286. <div class="clearer"></div>
  287. </div>
  288. </div>
  289. </div>
  290. <span id="sidebar-top"></span>
  291. <div class="sphinxsidebar" role="navigation" aria-label="Main">
  292. <div class="sphinxsidebarwrapper">
  293. <p class="logo"><a href="../../../index.html">
  294. <img class="logo" src="../../../_static/searxng-wordmark.svg" alt="Logo of SearXNG"/>
  295. </a></p>
  296. <h3><a href="../../../index.html">Table of Contents</a></h3>
  297. <ul>
  298. <li class="toctree-l1"><a class="reference internal" href="../../../user/index.html">User information</a></li>
  299. <li class="toctree-l1"><a class="reference internal" href="../../../own-instance.html">Why use a private instance?</a></li>
  300. <li class="toctree-l1"><a class="reference internal" href="../../../admin/index.html">Administrator documentation</a></li>
  301. <li class="toctree-l1"><a class="reference internal" href="../../../dev/index.html">Developer documentation</a></li>
  302. <li class="toctree-l1"><a class="reference internal" href="../../../utils/index.html">DevOps tooling box</a></li>
  303. <li class="toctree-l1"><a class="reference internal" href="../../../src/index.html">Source-Code</a></li>
  304. </ul>
  305. <h3>Project Links</h3>
  306. <ul>
  307. <li><a href="https://github.com/searxng/searxng/tree/master">Source</a>
  308. <li><a href="https://github.com/searxng/searxng/wiki">Wiki</a>
  309. <li><a href="https://searx.space">Public instances</a>
  310. <li><a href="https://github.com/searxng/searxng/issues">Issue Tracker</a>
  311. </ul><h3>Navigation</h3>
  312. <ul>
  313. <li><a href="../../../index.html">Overview</a>
  314. <ul>
  315. <li><a href="../../index.html">Module code</a>
  316. </ul>
  317. </li>
  318. </ul>
  319. </li>
  320. </ul>
  321. <search id="searchbox" style="display: none" role="search">
  322. <h3 id="searchlabel">Quick search</h3>
  323. <div class="searchformwrapper">
  324. <form class="search" action="../../../search.html" method="get">
  325. <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
  326. <input type="submit" value="Go" />
  327. </form>
  328. </div>
  329. </search>
  330. <script>document.getElementById('searchbox').style.display = "block"</script>
  331. </div>
  332. </div>
  333. <div class="clearer"></div>
  334. </div>
  335. <div class="footer" role="contentinfo">
  336. &#169; Copyright SearXNG team.
  337. </div>
  338. </body>
  339. </html>