NTab仓库
fjmwkj
/
searxng
mirror of https://github.com/searxng/searxng
1
0
Fork 0
Files Issues 0 Wiki
Tree: 9b01b2448a
Branches Tags
searxng
/
_modules
/
searx
/
plugins
/
hostnames.html

hostnames.html 27 KB
History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320 
  1. <!DOCTYPE html>
    2. 

  2. 

  3. <html lang="en" data-content_root="../../../">
    4. 

  4.   <head>
    5. 

  5.     <meta charset="utf-8" />
    6. 

  6.     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
    7. 

  7.   <meta name="viewport" content="width=device-width, initial-scale=1">
    8. 

  8.     <title>searx.plugins.hostnames &#8212; SearXNG Documentation (2025.4.30+fd33559cf)</title>
    9. 

  9.     <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=6625fa76" />
    10. 

  10.     <link rel="stylesheet" type="text/css" href="../../../_static/searxng.css?v=52e4ff28" />
    11. 

  11.     <script src="../../../_static/documentation_options.js?v=b12b0e12"></script>
    12. 

  12.     <script src="../../../_static/doctools.js?v=9a2dae69"></script>
    13. 

  13.     <script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
    14. 

  14.     <script data-project="searxng" data-version="2025.4.30+fd33559cf" src="../../../_static/describe_version.js?v=fa7f30d0"></script>
    15. 

  15.     <link rel="index" title="Index" href="../../../genindex.html" />
    16. 

  16.     <link rel="search" title="Search" href="../../../search.html" /> 
    17. 

  17.   </head><body>
    18. 

  18.     <div class="related" role="navigation" aria-label="Related">
    19. 

  19.       <h3>Navigation</h3>
    20. 

  20.       <ul>
    21. 

  21.         <li class="right" style="margin-right: 10px">
    22. 

  22.           <a href="../../../genindex.html" title="General Index"
    23. 

  23.              accesskey="I">index</a></li>
    24. 

  24.         <li class="right" >
    25. 

  25.           <a href="../../../py-modindex.html" title="Python Module Index"
    26. 

  26.              >modules</a> |</li>
    27. 

  27.         <li class="nav-item nav-item-0"><a href="../../../index.html">SearXNG Documentation (2025.4.30+fd33559cf)</a> &#187;</li>
    28. 

  28.           <li class="nav-item nav-item-1"><a href="../../index.html" accesskey="U">Module code</a> &#187;</li>
    29. 

  29.         <li class="nav-item nav-item-this"><a href="">searx.plugins.hostnames</a></li> 
    30. 

  30.       </ul>
    31. 

  31.     </div>  
    32. 

  32. 

  33.     <div class="document">
    34. 

  34.       <div class="documentwrapper">
    35. 

  35.         <div class="bodywrapper">
    36. 

  36.           <div class="body" role="main">
    37. 

  37.             
    38. 

  38.   <h1>Source code for searx.plugins.hostnames</h1><div class="highlight"><pre>
    39. 

  39. <span></span><span class="c1"># SPDX-License-Identifier: AGPL-3.0-or-later</span>
    40. 

  40. <span class="c1"># pylint: disable=too-many-branches, unused-argument</span>
    41. 

  41. <span class="sd">&quot;&quot;&quot;</span>
    42. 

  42. 

  43. <span class="sd">During the initialization phase, the plugin checks whether a ``hostnames:``</span>
    44. 

  44. <span class="sd">configuration exists. If this is not the case, the plugin is not included</span>
    45. 

  45. <span class="sd">in the PluginStorage (it is not available for selection).</span>
    46. 

  46. 

  47. <span class="sd">- ``hostnames.replace``: A **mapping** of regular expressions to hostnames to be</span>
    48. 

  48. <span class="sd">  replaced by other hostnames.</span>
    49. 

  49. 

  50. <span class="sd">  .. code:: yaml</span>
    51. 

  51. 

  52. <span class="sd">     hostnames:</span>
    53. 

  53. <span class="sd">       replace:</span>
    54. 

  54. <span class="sd">         &#39;(.*\\.)?youtube\\.com$&#39;: &#39;invidious.example.com&#39;</span>
    55. 

  55. <span class="sd">         &#39;(.*\\.)?youtu\\.be$&#39;: &#39;invidious.example.com&#39;</span>
    56. 

  56. <span class="sd">         ...</span>
    57. 

  57. 

  58. <span class="sd">- ``hostnames.remove``: A **list** of regular expressions of the hostnames whose</span>
    59. 

  59. <span class="sd">  results should be taken from the results list.</span>
    60. 

  60. 

  61. <span class="sd">  .. code:: yaml</span>
    62. 

  62. 

  63. <span class="sd">     hostnames:</span>
    64. 

  64. <span class="sd">       remove:</span>
    65. 

  65. <span class="sd">         - &#39;(.*\\.)?facebook.com$&#39;</span>
    66. 

  66. <span class="sd">         - ...</span>
    67. 

  67. 

  68. <span class="sd">- ``hostnames.high_priority``: A **list** of regular expressions for hostnames</span>
    69. 

  69. <span class="sd">  whose result should be given higher priority. The results from these hosts are</span>
    70. 

  70. <span class="sd">  arranged higher in the results list.</span>
    71. 

  71. 

  72. <span class="sd">  .. code:: yaml</span>
    73. 

  73. 

  74. <span class="sd">     hostnames:</span>
    75. 

  75. <span class="sd">       high_priority:</span>
    76. 

  76. <span class="sd">         - &#39;(.*\\.)?wikipedia.org$&#39;</span>
    77. 

  77. <span class="sd">         - ...</span>
    78. 

  78. 

  79. <span class="sd">- ``hostnames.lower_priority``: A **list** of regular expressions for hostnames</span>
    80. 

  80. <span class="sd">  whose result should be given lower priority. The results from these hosts are</span>
    81. 

  81. <span class="sd">  arranged lower in the results list.</span>
    82. 

  82. 

  83. <span class="sd">  .. code:: yaml</span>
    84. 

  84. 

  85. <span class="sd">     hostnames:</span>
    86. 

  86. <span class="sd">       low_priority:</span>
    87. 

  87. <span class="sd">         - &#39;(.*\\.)?google(\\..*)?$&#39;</span>
    88. 

  88. <span class="sd">         - ...</span>
    89. 

  89. 

  90. <span class="sd">If the URL matches the pattern of ``high_priority`` AND ``low_priority``, the</span>
    91. 

  91. <span class="sd">higher priority wins over the lower priority.</span>
    92. 

  92. 

  93. <span class="sd">Alternatively, you can also specify a file name for the **mappings** or</span>
    94. 

  94. <span class="sd">**lists** to load these from an external file:</span>
    95. 

  95. 

  96. <span class="sd">.. code:: yaml</span>
    97. 

  97. 

  98. <span class="sd">   hostnames:</span>
    99. 

  99. <span class="sd">     replace: &#39;rewrite-hosts.yml&#39;</span>
    100. 

  100. <span class="sd">     remove:</span>
    101. 

  101. <span class="sd">       - &#39;(.*\\.)?facebook.com$&#39;</span>
    102. 

  102. <span class="sd">       - ...</span>
    103. 

  103. <span class="sd">     low_priority:</span>
    104. 

  104. <span class="sd">       - &#39;(.*\\.)?google(\\..*)?$&#39;</span>
    105. 

  105. <span class="sd">       - ...</span>
    106. 

  106. <span class="sd">     high_priority:</span>
    107. 

  107. <span class="sd">       - &#39;(.*\\.)?wikipedia.org$&#39;</span>
    108. 

  108. <span class="sd">       - ...</span>
    109. 

  109. 

  110. <span class="sd">The ``rewrite-hosts.yml`` from the example above must be in the folder in which</span>
    111. 

  111. <span class="sd">the ``settings.yml`` file is already located (``/etc/searxng``). The file then</span>
    112. 

  112. <span class="sd">only contains the lists or the mapping tables without further information on the</span>
    113. 

  113. <span class="sd">namespaces.  In the example above, this would be a mapping table that looks</span>
    114. 

  114. <span class="sd">something like this:</span>
    115. 

  115. 

  116. <span class="sd">.. code:: yaml</span>
    117. 

  117. 

  118. <span class="sd">   &#39;(.*\\.)?youtube\\.com$&#39;: &#39;invidious.example.com&#39;</span>
    119. 

  119. <span class="sd">   &#39;(.*\\.)?youtu\\.be$&#39;: &#39;invidious.example.com&#39;</span>
    120. 

  120. 

  121. <span class="sd">&quot;&quot;&quot;</span>
    122. 

  122. 

  123. <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>
    124. 

  124. <span class="kn">import</span><span class="w"> </span><span class="nn">typing</span>
    125. 

  125. 

  126. <span class="kn">import</span><span class="w"> </span><span class="nn">re</span>
    127. 

  127. <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">urlunparse</span><span class="p">,</span> <span class="n">urlparse</span>
    128. 

  128. 

  129. <span class="kn">from</span><span class="w"> </span><span class="nn">flask_babel</span><span class="w"> </span><span class="kn">import</span> <span class="n">gettext</span>
    130. 

  130. 

  131. <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>
    132. 

  132. <span class="kn">from</span><span class="w"> </span><span class="nn">searx.result_types._base</span><span class="w"> </span><span class="kn">import</span> <span class="n">MainResult</span><span class="p">,</span> <span class="n">LegacyResult</span>
    133. 

  133. <span class="kn">from</span><span class="w"> </span><span class="nn">searx.settings_loader</span><span class="w"> </span><span class="kn">import</span> <span class="n">get_yaml_cfg</span>
    134. 

  134. <span class="kn">from</span><span class="w"> </span><span class="nn">searx.plugins</span><span class="w"> </span><span class="kn">import</span> <span class="n">Plugin</span><span class="p">,</span> <span class="n">PluginInfo</span>
    135. 

  135. 

  136. <span class="kn">from</span><span class="w"> </span><span class="nn">._core</span><span class="w"> </span><span class="kn">import</span> <span class="n">log</span>
    137. 

  137. 

  138. <span class="k">if</span> <span class="n">typing</span><span class="o">.</span><span class="n">TYPE_CHECKING</span><span class="p">:</span>
    139. 

  139.     <span class="kn">import</span><span class="w"> </span><span class="nn">flask</span>
    140. 

  140.     <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>
    141. 

  141.     <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>
    142. 

  142.     <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>
    143. 

  143.     <span class="kn">from</span><span class="w"> </span><span class="nn">searx.plugins</span><span class="w"> </span><span class="kn">import</span> <span class="n">PluginCfg</span>
    144. 

  144. 

  145. 

  146. <span class="n">REPLACE</span><span class="p">:</span> <span class="nb">dict</span><span class="p">[</span><span class="n">re</span><span class="o">.</span><span class="n">Pattern</span><span class="p">,</span> <span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="p">{}</span>
    147. 

  147. <span class="n">REMOVE</span><span class="p">:</span> <span class="nb">set</span> <span class="o">=</span> <span class="nb">set</span><span class="p">()</span>
    148. 

  148. <span class="n">HIGH</span><span class="p">:</span> <span class="nb">set</span> <span class="o">=</span> <span class="nb">set</span><span class="p">()</span>
    149. 

  149. <span class="n">LOW</span><span class="p">:</span> <span class="nb">set</span> <span class="o">=</span> <span class="nb">set</span><span class="p">()</span>
    150. 

  150. 

  151. 

  152. <div class="viewcode-block" id="SXNGPlugin">
    153. 

  153. <a class="viewcode-back" href="../../../dev/plugins/hostnames.html#searx.plugins.hostnames.SXNGPlugin">[docs]</a>
    154. 

  154. <span class="k">class</span><span class="w"> </span><span class="nc">SXNGPlugin</span><span class="p">(</span><span class="n">Plugin</span><span class="p">):</span>
    155. 

  155. <span class="w">    </span><span class="sd">&quot;&quot;&quot;Rewrite hostnames, remove results or prioritize them.&quot;&quot;&quot;</span>
    156. 

  156. 

  157.     <span class="nb">id</span> <span class="o">=</span> <span class="s2">&quot;hostnames&quot;</span>
    158. 

  158. 

  159.     <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="s2">&quot;PluginCfg&quot;</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
    160. 

  160.         <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">plg_cfg</span><span class="p">)</span>
    161. 

  161.         <span class="bp">self</span><span class="o">.</span><span class="n">info</span> <span class="o">=</span> <span class="n">PluginInfo</span><span class="p">(</span>
    162. 

  162.             <span class="nb">id</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">id</span><span class="p">,</span>
    163. 

  163.             <span class="n">name</span><span class="o">=</span><span class="n">gettext</span><span class="p">(</span><span class="s2">&quot;Hostnames plugin&quot;</span><span class="p">),</span>
    164. 

  164.             <span class="n">description</span><span class="o">=</span><span class="n">gettext</span><span class="p">(</span><span class="s2">&quot;Rewrite hostnames, remove results or prioritize them based on the hostname&quot;</span><span class="p">),</span>
    165. 

  165.             <span class="n">preference_section</span><span class="o">=</span><span class="s2">&quot;general&quot;</span><span class="p">,</span>
    166. 

  166.         <span class="p">)</span>
    167. 

  167. 

  168. <div class="viewcode-block" id="SXNGPlugin.on_result">
    169. 

  169. <a class="viewcode-back" href="../../../dev/plugins/hostnames.html#searx.plugins.hostnames.SXNGPlugin.on_result">[docs]</a>
    170. 

  170.     <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="s2">&quot;SXNG_Request&quot;</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>
    171. 

  171. 

  172.         <span class="k">for</span> <span class="n">pattern</span> <span class="ow">in</span> <span class="n">REMOVE</span><span class="p">:</span>
    173. 

  173.             <span class="k">if</span> <span class="n">result</span><span class="o">.</span><span class="n">parsed_url</span> <span class="ow">and</span> <span class="n">pattern</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">parsed_url</span><span class="o">.</span><span class="n">netloc</span><span class="p">):</span>
    174. 

  174.                 <span class="c1"># if the link (parsed_url) of the result match, then remove the</span>
    175. 

  175.                 <span class="c1"># result from the result list, in any other case, the result</span>
    176. 

  176.                 <span class="c1"># remains in the list / see final &quot;return True&quot; below.</span>
    177. 

  177.                 <span class="c1"># log.debug(&quot;FIXME: remove [url/parsed_url] %s %s&quot;, pattern.pattern, result.url)</span>
    178. 

  178.                 <span class="k">return</span> <span class="kc">False</span>
    179. 

  179. 

  180.         <span class="n">result</span><span class="o">.</span><span class="n">filter_urls</span><span class="p">(</span><span class="n">filter_url_field</span><span class="p">)</span>
    181. 

  181. 

  182.         <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">result</span><span class="p">,</span> <span class="p">(</span><span class="n">MainResult</span><span class="p">,</span> <span class="n">LegacyResult</span><span class="p">)):</span>
    183. 

  183.             <span class="k">for</span> <span class="n">pattern</span> <span class="ow">in</span> <span class="n">LOW</span><span class="p">:</span>
    184. 

  184.                 <span class="k">if</span> <span class="n">result</span><span class="o">.</span><span class="n">parsed_url</span> <span class="ow">and</span> <span class="n">pattern</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">parsed_url</span><span class="o">.</span><span class="n">netloc</span><span class="p">):</span>
    185. 

  185.                     <span class="n">result</span><span class="o">.</span><span class="n">priority</span> <span class="o">=</span> <span class="s2">&quot;low&quot;</span>
    186. 

  186. 

  187.             <span class="k">for</span> <span class="n">pattern</span> <span class="ow">in</span> <span class="n">HIGH</span><span class="p">:</span>
    188. 

  188.                 <span class="k">if</span> <span class="n">result</span><span class="o">.</span><span class="n">parsed_url</span> <span class="ow">and</span> <span class="n">pattern</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">parsed_url</span><span class="o">.</span><span class="n">netloc</span><span class="p">):</span>
    189. 

  189.                     <span class="n">result</span><span class="o">.</span><span class="n">priority</span> <span class="o">=</span> <span class="s2">&quot;high&quot;</span>
    190. 

  190. 

  191.         <span class="k">return</span> <span class="kc">True</span></div>
    192. 

  192. 

  193. 

  194. <div class="viewcode-block" id="SXNGPlugin.init">
    195. 

  195. <a class="viewcode-back" href="../../../dev/plugins/hostnames.html#searx.plugins.hostnames.SXNGPlugin.init">[docs]</a>
    196. 

  196.     <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>
    197. 

  197.         <span class="k">global</span> <span class="n">REPLACE</span><span class="p">,</span> <span class="n">REMOVE</span><span class="p">,</span> <span class="n">HIGH</span><span class="p">,</span> <span class="n">LOW</span>  <span class="c1"># pylint: disable=global-statement</span>
    198. 

  198. 

  199.         <span class="k">if</span> <span class="ow">not</span> <span class="n">settings</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">id</span><span class="p">):</span>
    200. 

  200.             <span class="c1"># Remove plugin, if there isn&#39;t a &quot;hostnames:&quot; setting</span>
    201. 

  201.             <span class="k">return</span> <span class="kc">False</span>
    202. 

  202. 

  203.         <span class="n">REPLACE</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_load_regular_expressions</span><span class="p">(</span><span class="s2">&quot;replace&quot;</span><span class="p">)</span> <span class="ow">or</span> <span class="p">{}</span>  <span class="c1"># type: ignore</span>
    204. 

  204.         <span class="n">REMOVE</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_load_regular_expressions</span><span class="p">(</span><span class="s2">&quot;remove&quot;</span><span class="p">)</span> <span class="ow">or</span> <span class="nb">set</span><span class="p">()</span>  <span class="c1"># type: ignore</span>
    205. 

  205.         <span class="n">HIGH</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_load_regular_expressions</span><span class="p">(</span><span class="s2">&quot;high_priority&quot;</span><span class="p">)</span> <span class="ow">or</span> <span class="nb">set</span><span class="p">()</span>  <span class="c1"># type: ignore</span>
    206. 

  206.         <span class="n">LOW</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_load_regular_expressions</span><span class="p">(</span><span class="s2">&quot;low_priority&quot;</span><span class="p">)</span> <span class="ow">or</span> <span class="nb">set</span><span class="p">()</span>  <span class="c1"># type: ignore</span>
    207. 

  207. 

  208.         <span class="k">return</span> <span class="kc">True</span></div>
    209. 

  209. 

  210. 

  211.     <span class="k">def</span><span class="w"> </span><span class="nf">_load_regular_expressions</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">settings_key</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">dict</span><span class="p">[</span><span class="n">re</span><span class="o">.</span><span class="n">Pattern</span><span class="p">,</span> <span class="nb">str</span><span class="p">]</span> <span class="o">|</span> <span class="nb">set</span> <span class="o">|</span> <span class="kc">None</span><span class="p">:</span>
    212. 

  212.         <span class="n">setting_value</span> <span class="o">=</span> <span class="n">settings</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">id</span><span class="p">,</span> <span class="p">{})</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">settings_key</span><span class="p">)</span>
    213. 

  213. 

  214.         <span class="k">if</span> <span class="ow">not</span> <span class="n">setting_value</span><span class="p">:</span>
    215. 

  215.             <span class="k">return</span> <span class="kc">None</span>
    216. 

  216. 

  217.         <span class="c1"># load external file with configuration</span>
    218. 

  218.         <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">setting_value</span><span class="p">,</span> <span class="nb">str</span><span class="p">):</span>
    219. 

  219.             <span class="n">setting_value</span> <span class="o">=</span> <span class="n">get_yaml_cfg</span><span class="p">(</span><span class="n">setting_value</span><span class="p">)</span>
    220. 

  220. 

  221.         <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">setting_value</span><span class="p">,</span> <span class="nb">list</span><span class="p">):</span>
    222. 

  222.             <span class="k">return</span> <span class="p">{</span><span class="n">re</span><span class="o">.</span><span class="n">compile</span><span class="p">(</span><span class="n">r</span><span class="p">)</span> <span class="k">for</span> <span class="n">r</span> <span class="ow">in</span> <span class="n">setting_value</span><span class="p">}</span>
    223. 

  223. 

  224.         <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">setting_value</span><span class="p">,</span> <span class="nb">dict</span><span class="p">):</span>
    225. 

  225.             <span class="k">return</span> <span class="p">{</span><span class="n">re</span><span class="o">.</span><span class="n">compile</span><span class="p">(</span><span class="n">p</span><span class="p">):</span> <span class="n">r</span> <span class="k">for</span> <span class="p">(</span><span class="n">p</span><span class="p">,</span> <span class="n">r</span><span class="p">)</span> <span class="ow">in</span> <span class="n">setting_value</span><span class="o">.</span><span class="n">items</span><span class="p">()}</span>
    226. 

  226. 

  227.         <span class="k">return</span> <span class="kc">None</span></div>
    228. 

  228. 

  229. 

  230. 

  231. <div class="viewcode-block" id="filter_url_field">
    232. 

  232. <a class="viewcode-back" href="../../../dev/plugins/hostnames.html#searx.plugins.hostnames.filter_url_field">[docs]</a>
    233. 

  233. <span class="k">def</span><span class="w"> </span><span class="nf">filter_url_field</span><span class="p">(</span><span class="n">result</span><span class="p">:</span> <span class="s2">&quot;Result|LegacyResult&quot;</span><span class="p">,</span> <span class="n">field_name</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">url_src</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">bool</span> <span class="o">|</span> <span class="nb">str</span><span class="p">:</span>
    234. 

  234. <span class="w">    </span><span class="sd">&quot;&quot;&quot;Returns bool ``True`` to use URL unchanged (``False`` to ignore URL).</span>
    235. 

  235. <span class="sd">    If URL should be modified, the returned string is the new URL to use.&quot;&quot;&quot;</span>
    236. 

  236. 

  237.     <span class="k">if</span> <span class="ow">not</span> <span class="n">url_src</span><span class="p">:</span>
    238. 

  238.         <span class="n">log</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s2">&quot;missing a URL in field </span><span class="si">%s</span><span class="s2">&quot;</span><span class="p">,</span> <span class="n">field_name</span><span class="p">)</span>
    239. 

  239.         <span class="k">return</span> <span class="kc">True</span>
    240. 

  240. 

  241.     <span class="n">url_src_parsed</span> <span class="o">=</span> <span class="n">urlparse</span><span class="p">(</span><span class="n">url</span><span class="o">=</span><span class="n">url_src</span><span class="p">)</span>
    242. 

  242. 

  243.     <span class="k">for</span> <span class="n">pattern</span> <span class="ow">in</span> <span class="n">REMOVE</span><span class="p">:</span>
    244. 

  244.         <span class="k">if</span> <span class="n">pattern</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="n">url_src_parsed</span><span class="o">.</span><span class="n">netloc</span><span class="p">):</span>
    245. 

  245.             <span class="k">return</span> <span class="kc">False</span>
    246. 

  246. 

  247.     <span class="k">for</span> <span class="n">pattern</span><span class="p">,</span> <span class="n">replacement</span> <span class="ow">in</span> <span class="n">REPLACE</span><span class="o">.</span><span class="n">items</span><span class="p">():</span>
    248. 

  248.         <span class="k">if</span> <span class="n">pattern</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="n">url_src_parsed</span><span class="o">.</span><span class="n">netloc</span><span class="p">):</span>
    249. 

  249.             <span class="n">new_url</span> <span class="o">=</span> <span class="n">url_src_parsed</span><span class="o">.</span><span class="n">_replace</span><span class="p">(</span><span class="n">netloc</span><span class="o">=</span><span class="n">pattern</span><span class="o">.</span><span class="n">sub</span><span class="p">(</span><span class="n">replacement</span><span class="p">,</span> <span class="n">url_src_parsed</span><span class="o">.</span><span class="n">netloc</span><span class="p">))</span>
    250. 

  250.             <span class="n">new_url</span> <span class="o">=</span> <span class="n">urlunparse</span><span class="p">(</span><span class="n">new_url</span><span class="p">)</span>
    251. 

  251.             <span class="k">return</span> <span class="n">new_url</span>
    252. 

  252. 

  253.     <span class="k">return</span> <span class="kc">True</span></div>
    254. 

  254. 

  255. </pre></div>
    256. 

  256. 

  257.             <div class="clearer"></div>
    258. 

  258.           </div>
    259. 

  259.         </div>
    260. 

  260.       </div>
    261. 

  261.   <span id="sidebar-top"></span>
    262. 

  262.       <div class="sphinxsidebar" role="navigation" aria-label="Main">
    263. 

  263.         <div class="sphinxsidebarwrapper">
    264. 

  264.   
    265. 

  265.     
    266. 

  266.             <p class="logo"><a href="../../../index.html">
    267. 

  267.               <img class="logo" src="../../../_static/searxng-wordmark.svg" alt="Logo of SearXNG"/>
    268. 

  268.             </a></p>
    269. 

  269.   
    270. 

  270. 

  271. <h3><a href="../../../index.html">Table of Contents</a></h3>
    272. 

  272. <ul>
    273. 

  273. <li class="toctree-l1"><a class="reference internal" href="../../../user/index.html">User information</a></li>
    274. 

  274. <li class="toctree-l1"><a class="reference internal" href="../../../own-instance.html">Why use a private instance?</a></li>
    275. 

  275. <li class="toctree-l1"><a class="reference internal" href="../../../admin/index.html">Administrator documentation</a></li>
    276. 

  276. <li class="toctree-l1"><a class="reference internal" href="../../../dev/index.html">Developer documentation</a></li>
    277. 

  277. <li class="toctree-l1"><a class="reference internal" href="../../../utils/index.html">DevOps tooling box</a></li>
    278. 

  278. <li class="toctree-l1"><a class="reference internal" href="../../../src/index.html">Source-Code</a></li>
    279. 

  279. </ul>
    280. 

  280. 

  281.   <h3>Project Links</h3>
    282. 

  282.   <ul>
    283. 

  283.     <li><a href="https://github.com/searxng/searxng/tree/master">Source</a>
    284. 

  284.   
    285. 

  285.     <li><a href="https://github.com/searxng/searxng/wiki">Wiki</a>
    286. 

  286.   
    287. 

  287.     <li><a href="https://searx.space">Public instances</a>
    288. 

  288.   
    289. 

  289.     <li><a href="https://github.com/searxng/searxng/issues">Issue Tracker</a>
    290. 

  290.   </ul><h3>Navigation</h3>
    291. 

  291. <ul>
    292. 

  292.   <li><a href="../../../index.html">Overview</a>
    293. 

  293.     <ul>
    294. 

  294.       <li><a href="../../index.html">Module code</a>
    295. 

  295.         
    296. 

  296.           
    297. 

  297.           </ul>
    298. 

  298.       </li>
    299. 

  299.     </ul>
    300. 

  300.   </li>
    301. 

  301. </ul>
    302. 

  302. <search id="searchbox" style="display: none" role="search">
    303. 

  303.   <h3 id="searchlabel">Quick search</h3>
    304. 

  304.     <div class="searchformwrapper">
    305. 

  305.     <form class="search" action="../../../search.html" method="get">
    306. 

  306.       <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
    307. 

  307.       <input type="submit" value="Go" />
    308. 

  308.     </form>
    309. 

  309.     </div>
    310. 

  310. </search>
    311. 

  311. <script>document.getElementById('searchbox').style.display = "block"</script>
    312. 

  312.         </div>
    313. 

  313.       </div>
    314. 

  314.       <div class="clearer"></div>
    315. 

  315.     </div>
    316. 

  316.     <div class="footer" role="contentinfo">
    317. 

  317.     &#169; Copyright SearXNG team.
    318. 

  318.     </div>
    319. 

  319.   </body>
    320. 

  320. </html>
    321.
© 2025 NTab仓库
Page: 67ms Template: 1ms 微信 微信二维码 哔哩哔哩 Sina Weibo Javascript Licenses Website