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
/
favicons
/
proxy.html

proxy.html 36 KB
History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363 
  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.favicons.proxy &#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.favicons.proxy</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.favicons.proxy</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="sd">&quot;&quot;&quot;Implementations for a favicon proxy&quot;&quot;&quot;</span>
    41. 

  41. 

  42. <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>
    43. 

  43. 

  44. <span class="kn">from</span><span class="w"> </span><span class="nn">typing</span><span class="w"> </span><span class="kn">import</span> <span class="n">Callable</span>
    45. 

  45. 

  46. <span class="kn">import</span><span class="w"> </span><span class="nn">importlib</span>
    47. 

  47. <span class="kn">import</span><span class="w"> </span><span class="nn">base64</span>
    48. 

  48. <span class="kn">import</span><span class="w"> </span><span class="nn">pathlib</span>
    49. 

  49. <span class="kn">import</span><span class="w"> </span><span class="nn">urllib.parse</span>
    50. 

  50. 

  51. <span class="kn">import</span><span class="w"> </span><span class="nn">flask</span>
    52. 

  52. <span class="kn">from</span><span class="w"> </span><span class="nn">httpx</span><span class="w"> </span><span class="kn">import</span> <span class="n">HTTPError</span>
    53. 

  53. <span class="kn">import</span><span class="w"> </span><span class="nn">msgspec</span>
    54. 

  54. 

  55. <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">get_setting</span>
    56. 

  56. 

  57. <span class="kn">from</span><span class="w"> </span><span class="nn">searx.webutils</span><span class="w"> </span><span class="kn">import</span> <span class="n">new_hmac</span><span class="p">,</span> <span class="n">is_hmac_of</span>
    58. 

  58. <span class="kn">from</span><span class="w"> </span><span class="nn">searx.exceptions</span><span class="w"> </span><span class="kn">import</span> <span class="n">SearxEngineResponseException</span>
    59. 

  59. <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>
    60. 

  60. 

  61. <span class="kn">from</span><span class="w"> </span><span class="nn">.resolvers</span><span class="w"> </span><span class="kn">import</span> <span class="n">DEFAULT_RESOLVER_MAP</span>
    62. 

  62. <span class="kn">from</span><span class="w"> </span><span class="nn">.</span><span class="w"> </span><span class="kn">import</span> <span class="n">cache</span>
    63. 

  63. 

  64. <span class="n">DEFAULT_FAVICON_URL</span> <span class="o">=</span> <span class="p">{}</span>
    65. 

  65. <span class="n">CFG</span><span class="p">:</span> <span class="n">FaviconProxyConfig</span> <span class="o">=</span> <span class="kc">None</span>  <span class="c1"># type: ignore</span>
    66. 

  66. 

  67. 

  68. <span class="k">def</span><span class="w"> </span><span class="nf">init</span><span class="p">(</span><span class="n">cfg</span><span class="p">:</span> <span class="n">FaviconProxyConfig</span><span class="p">):</span>
    69. 

  69.     <span class="k">global</span> <span class="n">CFG</span>  <span class="c1"># pylint: disable=global-statement</span>
    70. 

  70.     <span class="n">CFG</span> <span class="o">=</span> <span class="n">cfg</span>
    71. 

  71. 

  72. 

  73. <span class="k">def</span><span class="w"> </span><span class="nf">_initial_resolver_map</span><span class="p">():</span>
    74. 

  74.     <span class="n">d</span> <span class="o">=</span> <span class="p">{}</span>
    75. 

  75.     <span class="n">name</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="n">get_setting</span><span class="p">(</span><span class="s2">&quot;search.favicon_resolver&quot;</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span>  <span class="c1"># type: ignore</span>
    76. 

  76.     <span class="k">if</span> <span class="n">name</span><span class="p">:</span>
    77. 

  77.         <span class="n">func</span> <span class="o">=</span> <span class="n">DEFAULT_RESOLVER_MAP</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">name</span><span class="p">)</span>
    78. 

  78.         <span class="k">if</span> <span class="n">func</span><span class="p">:</span>
    79. 

  79.             <span class="n">d</span> <span class="o">=</span> <span class="p">{</span><span class="n">name</span><span class="p">:</span> <span class="sa">f</span><span class="s2">&quot;searx.favicons.resolvers.</span><span class="si">{</span><span class="n">func</span><span class="o">.</span><span class="vm">__name__</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">}</span>
    80. 

  80.     <span class="k">return</span> <span class="n">d</span>
    81. 

  81. 

  82. 

  83. <div class="viewcode-block" id="FaviconProxyConfig">
    84. 

  84. <a class="viewcode-back" href="../../../src/searx.favicons.html#searx.favicons.FaviconProxyConfig">[docs]</a>
    85. 

  85. <span class="k">class</span><span class="w"> </span><span class="nc">FaviconProxyConfig</span><span class="p">(</span><span class="n">msgspec</span><span class="o">.</span><span class="n">Struct</span><span class="p">):</span>
    86. 

  86. <span class="w">    </span><span class="sd">&quot;&quot;&quot;Configuration of the favicon proxy.&quot;&quot;&quot;</span>
    87. 

  87. 

  88.     <span class="n">max_age</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="mi">60</span> <span class="o">*</span> <span class="mi">60</span> <span class="o">*</span> <span class="mi">24</span> <span class="o">*</span> <span class="mi">7</span>  <span class="c1"># seven days</span>
    89. 

  89. <span class="w">    </span><span class="sd">&quot;&quot;&quot;HTTP header Cache-Control_ ``max-age``</span>
    90. 

  90. 

  91. <span class="sd">    .. _Cache-Control: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Cache-Control</span>
    92. 

  92. <span class="sd">    &quot;&quot;&quot;</span>
    93. 

  93. 

  94.     <span class="n">secret_key</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="n">get_setting</span><span class="p">(</span><span class="s2">&quot;server.secret_key&quot;</span><span class="p">)</span>  <span class="c1"># type: ignore</span>
    95. 

  95. <span class="w">    </span><span class="sd">&quot;&quot;&quot;By default, the value from :ref:`server.secret_key &lt;settings server&gt;`</span>
    96. 

  96. <span class="sd">    setting is used.&quot;&quot;&quot;</span>
    97. 

  97. 

  98.     <span class="n">resolver_timeout</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="n">get_setting</span><span class="p">(</span><span class="s2">&quot;outgoing.request_timeout&quot;</span><span class="p">)</span>  <span class="c1"># type: ignore</span>
    99. 

  99. <span class="w">    </span><span class="sd">&quot;&quot;&quot;Timeout which the resolvers should not exceed, is usually passed to the</span>
    100. 

  100. <span class="sd">    outgoing request of the resolver.  By default, the value from</span>
    101. 

  101. <span class="sd">    :ref:`outgoing.request_timeout &lt;settings outgoing&gt;` setting is used.&quot;&quot;&quot;</span>
    102. 

  102. 

  103.     <span class="n">resolver_map</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">str</span><span class="p">]</span> <span class="o">=</span> <span class="n">msgspec</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="n">_initial_resolver_map</span><span class="p">)</span>
    104. 

  104. <span class="w">    </span><span class="sd">&quot;&quot;&quot;The resolver_map is a key / value dictionary where the key is the name of</span>
    105. 

  105. <span class="sd">    the resolver and the value is the fully qualifying name (fqn) of resolver&#39;s</span>
    106. 

  106. <span class="sd">    function (the callable).  The resolvers from the python module</span>
    107. 

  107. <span class="sd">    :py:obj:`searx.favicons.resolver` are available by default.&quot;&quot;&quot;</span>
    108. 

  108. 

  109. <div class="viewcode-block" id="FaviconProxyConfig.get_resolver">
    110. 

  110. <a class="viewcode-back" href="../../../src/searx.favicons.html#searx.favicons.FaviconProxyConfig.get_resolver">[docs]</a>
    111. 

  111.     <span class="k">def</span><span class="w"> </span><span class="nf">get_resolver</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Callable</span> <span class="o">|</span> <span class="kc">None</span><span class="p">:</span>
    112. 

  112. <span class="w">        </span><span class="sd">&quot;&quot;&quot;Returns the callable object (function) of the resolver with the</span>
    113. 

  113. <span class="sd">        ``name``.  If no resolver is registered for the ``name``, ``None`` is</span>
    114. 

  114. <span class="sd">        returned.</span>
    115. 

  115. <span class="sd">        &quot;&quot;&quot;</span>
    116. 

  116.         <span class="n">fqn</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">resolver_map</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">name</span><span class="p">)</span>
    117. 

  117.         <span class="k">if</span> <span class="n">fqn</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
    118. 

  118.             <span class="k">return</span> <span class="kc">None</span>
    119. 

  119.         <span class="n">mod_name</span><span class="p">,</span> <span class="n">_</span><span class="p">,</span> <span class="n">func_name</span> <span class="o">=</span> <span class="n">fqn</span><span class="o">.</span><span class="n">rpartition</span><span class="p">(</span><span class="s1">&#39;.&#39;</span><span class="p">)</span>
    120. 

  120.         <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>
    121. 

  121.         <span class="n">func</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">func_name</span><span class="p">)</span>
    122. 

  122.         <span class="k">if</span> <span class="n">func</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
    123. 

  123.             <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;resolver </span><span class="si">{</span><span class="n">fqn</span><span class="si">}</span><span class="s2"> is not implemented&quot;</span><span class="p">)</span>
    124. 

  124.         <span class="k">return</span> <span class="n">func</span></div>
    125. 

  125. 

  126. 

  127.     <span class="n">favicon_path</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="n">get_setting</span><span class="p">(</span><span class="s2">&quot;ui.static_path&quot;</span><span class="p">)</span> <span class="o">+</span> <span class="s2">&quot;/themes/</span><span class="si">{theme}</span><span class="s2">/img/empty_favicon.svg&quot;</span>  <span class="c1"># type: ignore</span>
    128. 

  128.     <span class="n">favicon_mime_type</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">&quot;image/svg+xml&quot;</span>
    129. 

  129. 

  130. <div class="viewcode-block" id="FaviconProxyConfig.favicon">
    131. 

  131. <a class="viewcode-back" href="../../../src/searx.favicons.html#searx.favicons.FaviconProxyConfig.favicon">[docs]</a>
    132. 

  132.     <span class="k">def</span><span class="w"> </span><span class="nf">favicon</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="o">**</span><span class="n">replacements</span><span class="p">):</span>
    133. 

  133. <span class="w">        </span><span class="sd">&quot;&quot;&quot;Returns pathname and mimetype of the default favicon.&quot;&quot;&quot;</span>
    134. 

  134.         <span class="k">return</span> <span class="p">(</span>
    135. 

  135.             <span class="n">pathlib</span><span class="o">.</span><span class="n">Path</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">favicon_path</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="o">**</span><span class="n">replacements</span><span class="p">)),</span>
    136. 

  136.             <span class="bp">self</span><span class="o">.</span><span class="n">favicon_mime_type</span><span class="p">,</span>
    137. 

  137.         <span class="p">)</span></div>
    138. 

  138. 

  139. 

  140. <div class="viewcode-block" id="FaviconProxyConfig.favicon_data_url">
    141. 

  141. <a class="viewcode-back" href="../../../src/searx.favicons.html#searx.favicons.FaviconProxyConfig.favicon_data_url">[docs]</a>
    142. 

  142.     <span class="k">def</span><span class="w"> </span><span class="nf">favicon_data_url</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="o">**</span><span class="n">replacements</span><span class="p">):</span>
    143. 

  143. <span class="w">        </span><span class="sd">&quot;&quot;&quot;Returns data image URL of the default favicon.&quot;&quot;&quot;</span>
    144. 

  144. 

  145.         <span class="n">cache_key</span> <span class="o">=</span> <span class="s2">&quot;, &quot;</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;</span><span class="si">{</span><span class="n">x</span><span class="si">}</span><span class="s2">:</span><span class="si">{</span><span class="n">replacements</span><span class="p">[</span><span class="n">x</span><span class="p">]</span><span class="si">}</span><span class="s2">&quot;</span> <span class="k">for</span> <span class="n">x</span> <span class="ow">in</span> <span class="nb">sorted</span><span class="p">(</span><span class="nb">list</span><span class="p">(</span><span class="n">replacements</span><span class="o">.</span><span class="n">keys</span><span class="p">()),</span> <span class="n">key</span><span class="o">=</span><span class="nb">str</span><span class="p">))</span>
    146. 

  146.         <span class="n">data_url</span> <span class="o">=</span> <span class="n">DEFAULT_FAVICON_URL</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">cache_key</span><span class="p">)</span>
    147. 

  147.         <span class="k">if</span> <span class="n">data_url</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
    148. 

  148.             <span class="k">return</span> <span class="n">data_url</span>
    149. 

  149. 

  150.         <span class="n">fav</span><span class="p">,</span> <span class="n">mimetype</span> <span class="o">=</span> <span class="n">CFG</span><span class="o">.</span><span class="n">favicon</span><span class="p">(</span><span class="o">**</span><span class="n">replacements</span><span class="p">)</span>
    151. 

  151.         <span class="c1"># hint: encoding utf-8 limits favicons to be a SVG image</span>
    152. 

  152.         <span class="k">with</span> <span class="n">fav</span><span class="o">.</span><span class="n">open</span><span class="p">(</span><span class="s2">&quot;r&quot;</span><span class="p">,</span> <span class="n">encoding</span><span class="o">=</span><span class="s2">&quot;utf-8&quot;</span><span class="p">)</span> <span class="k">as</span> <span class="n">f</span><span class="p">:</span>
    153. 

  153.             <span class="n">data_url</span> <span class="o">=</span> <span class="n">f</span><span class="o">.</span><span class="n">read</span><span class="p">()</span>
    154. 

  154. 

  155.         <span class="n">data_url</span> <span class="o">=</span> <span class="n">urllib</span><span class="o">.</span><span class="n">parse</span><span class="o">.</span><span class="n">quote</span><span class="p">(</span><span class="n">data_url</span><span class="p">)</span>
    156. 

  156.         <span class="n">data_url</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">&quot;data:</span><span class="si">{</span><span class="n">mimetype</span><span class="si">}</span><span class="s2">;utf8,</span><span class="si">{</span><span class="n">data_url</span><span class="si">}</span><span class="s2">&quot;</span>
    157. 

  157.         <span class="n">DEFAULT_FAVICON_URL</span><span class="p">[</span><span class="n">cache_key</span><span class="p">]</span> <span class="o">=</span> <span class="n">data_url</span>
    158. 

  158.         <span class="k">return</span> <span class="n">data_url</span></div>
    159. 

  159. </div>
    160. 

  160. 

  161. 

  162. 

  163. <div class="viewcode-block" id="favicon_proxy">
    164. 

  164. <a class="viewcode-back" href="../../../src/searx.favicons.html#searx.favicons.favicon_proxy">[docs]</a>
    165. 

  165. <span class="k">def</span><span class="w"> </span><span class="nf">favicon_proxy</span><span class="p">():</span>
    166. 

  166. <span class="w">    </span><span class="sd">&quot;&quot;&quot;REST API of SearXNG&#39;s favicon proxy service</span>
    167. 

  167. 

  168. <span class="sd">    ::</span>
    169. 

  169. 

  170. <span class="sd">        /favicon_proxy?authority=&lt;...&gt;&amp;h=&lt;...&gt;</span>
    171. 

  171. 

  172. <span class="sd">    ``authority``:</span>
    173. 

  173. <span class="sd">      Domain name :rfc:`3986` / see :py:obj:`favicon_url`</span>
    174. 

  174. 

  175. <span class="sd">    ``h``:</span>
    176. 

  176. <span class="sd">      HMAC :rfc:`2104`, build up from the :ref:`server.secret_key &lt;settings</span>
    177. 

  177. <span class="sd">      server&gt;` setting.</span>
    178. 

  178. 

  179. <span class="sd">    &quot;&quot;&quot;</span>
    180. 

  180.     <span class="n">authority</span> <span class="o">=</span> <span class="n">sxng_request</span><span class="o">.</span><span class="n">args</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;authority&#39;</span><span class="p">)</span>
    181. 

  181. 

  182.     <span class="c1"># malformed request or RFC 3986 authority</span>
    183. 

  183.     <span class="k">if</span> <span class="ow">not</span> <span class="n">authority</span> <span class="ow">or</span> <span class="s2">&quot;/&quot;</span> <span class="ow">in</span> <span class="n">authority</span><span class="p">:</span>
    184. 

  184.         <span class="k">return</span> <span class="s1">&#39;&#39;</span><span class="p">,</span> <span class="mi">400</span>
    185. 

  185. 

  186.     <span class="c1"># malformed request / does not have authorisation</span>
    187. 

  187.     <span class="k">if</span> <span class="ow">not</span> <span class="n">is_hmac_of</span><span class="p">(</span>
    188. 

  188.         <span class="n">CFG</span><span class="o">.</span><span class="n">secret_key</span><span class="p">,</span>
    189. 

  189.         <span class="n">authority</span><span class="o">.</span><span class="n">encode</span><span class="p">(),</span>
    190. 

  190.         <span class="n">sxng_request</span><span class="o">.</span><span class="n">args</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;h&#39;</span><span class="p">,</span> <span class="s1">&#39;&#39;</span><span class="p">),</span>
    191. 

  191.     <span class="p">):</span>
    192. 

  192.         <span class="k">return</span> <span class="s1">&#39;&#39;</span><span class="p">,</span> <span class="mi">400</span>
    193. 

  193. 

  194.     <span class="n">resolver</span> <span class="o">=</span> <span class="n">sxng_request</span><span class="o">.</span><span class="n">preferences</span><span class="o">.</span><span class="n">get_value</span><span class="p">(</span><span class="s1">&#39;favicon_resolver&#39;</span><span class="p">)</span>  <span class="c1"># type: ignore</span>
    195. 

  195.     <span class="c1"># if resolver is empty or not valid, just return HTTP 400.</span>
    196. 

  196.     <span class="k">if</span> <span class="ow">not</span> <span class="n">resolver</span> <span class="ow">or</span> <span class="n">resolver</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">CFG</span><span class="o">.</span><span class="n">resolver_map</span><span class="o">.</span><span class="n">keys</span><span class="p">():</span>
    197. 

  197.         <span class="k">return</span> <span class="s2">&quot;&quot;</span><span class="p">,</span> <span class="mi">400</span>
    198. 

  198. 

  199.     <span class="n">data</span><span class="p">,</span> <span class="n">mime</span> <span class="o">=</span> <span class="n">search_favicon</span><span class="p">(</span><span class="n">resolver</span><span class="p">,</span> <span class="n">authority</span><span class="p">)</span>
    200. 

  200. 

  201.     <span class="k">if</span> <span class="n">data</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span> <span class="ow">and</span> <span class="n">mime</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
    202. 

  202.         <span class="n">resp</span> <span class="o">=</span> <span class="n">flask</span><span class="o">.</span><span class="n">Response</span><span class="p">(</span><span class="n">data</span><span class="p">,</span> <span class="n">mimetype</span><span class="o">=</span><span class="n">mime</span><span class="p">)</span>  <span class="c1"># type: ignore</span>
    203. 

  203.         <span class="n">resp</span><span class="o">.</span><span class="n">headers</span><span class="p">[</span><span class="s1">&#39;Cache-Control&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">&quot;max-age=</span><span class="si">{</span><span class="n">CFG</span><span class="o">.</span><span class="n">max_age</span><span class="si">}</span><span class="s2">&quot;</span>
    204. 

  204.         <span class="k">return</span> <span class="n">resp</span>
    205. 

  205. 

  206.     <span class="c1"># return default favicon from static path</span>
    207. 

  207.     <span class="n">theme</span> <span class="o">=</span> <span class="n">sxng_request</span><span class="o">.</span><span class="n">preferences</span><span class="o">.</span><span class="n">get_value</span><span class="p">(</span><span class="s2">&quot;theme&quot;</span><span class="p">)</span>  <span class="c1"># type: ignore</span>
    208. 

  208.     <span class="n">fav</span><span class="p">,</span> <span class="n">mimetype</span> <span class="o">=</span> <span class="n">CFG</span><span class="o">.</span><span class="n">favicon</span><span class="p">(</span><span class="n">theme</span><span class="o">=</span><span class="n">theme</span><span class="p">)</span>
    209. 

  209.     <span class="k">return</span> <span class="n">flask</span><span class="o">.</span><span class="n">send_from_directory</span><span class="p">(</span><span class="n">fav</span><span class="o">.</span><span class="n">parent</span><span class="p">,</span> <span class="n">fav</span><span class="o">.</span><span class="n">name</span><span class="p">,</span> <span class="n">mimetype</span><span class="o">=</span><span class="n">mimetype</span><span class="p">)</span></div>
    210. 

  210. 

  211. 

  212. 

  213. <div class="viewcode-block" id="search_favicon">
    214. 

  214. <a class="viewcode-back" href="../../../src/searx.favicons.html#searx.favicons.search_favicon">[docs]</a>
    215. 

  215. <span class="k">def</span><span class="w"> </span><span class="nf">search_favicon</span><span class="p">(</span><span class="n">resolver</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">authority</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">tuple</span><span class="p">[</span><span class="kc">None</span> <span class="o">|</span> <span class="nb">bytes</span><span class="p">,</span> <span class="kc">None</span> <span class="o">|</span> <span class="nb">str</span><span class="p">]:</span>
    216. 

  216. <span class="w">    </span><span class="sd">&quot;&quot;&quot;Sends the request to the favicon resolver and returns a tuple for the</span>
    217. 

  217. <span class="sd">    favicon.  The tuple consists of ``(data, mime)``, if the resolver has not</span>
    218. 

  218. <span class="sd">    determined a favicon, both values are ``None``.</span>
    219. 

  219. 

  220. <span class="sd">    ``data``:</span>
    221. 

  221. <span class="sd">      Binary data of the favicon.</span>
    222. 

  222. 

  223. <span class="sd">    ``mime``:</span>
    224. 

  224. <span class="sd">      Mime type of the favicon.</span>
    225. 

  225. 

  226. <span class="sd">    &quot;&quot;&quot;</span>
    227. 

  227. 

  228.     <span class="n">data</span><span class="p">,</span> <span class="n">mime</span> <span class="o">=</span> <span class="p">(</span><span class="kc">None</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span>
    229. 

  229. 

  230.     <span class="n">func</span> <span class="o">=</span> <span class="n">CFG</span><span class="o">.</span><span class="n">get_resolver</span><span class="p">(</span><span class="n">resolver</span><span class="p">)</span>
    231. 

  231.     <span class="k">if</span> <span class="n">func</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
    232. 

  232.         <span class="k">return</span> <span class="n">data</span><span class="p">,</span> <span class="n">mime</span>
    233. 

  233. 

  234.     <span class="c1"># to avoid superfluous requests to the resolver, first look in the cache</span>
    235. 

  235.     <span class="n">data_mime</span> <span class="o">=</span> <span class="n">cache</span><span class="o">.</span><span class="n">CACHE</span><span class="p">(</span><span class="n">resolver</span><span class="p">,</span> <span class="n">authority</span><span class="p">)</span>
    236. 

  236.     <span class="k">if</span> <span class="n">data_mime</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
    237. 

  237.         <span class="k">return</span> <span class="n">data_mime</span>
    238. 

  238. 

  239.     <span class="k">try</span><span class="p">:</span>
    240. 

  240.         <span class="n">data</span><span class="p">,</span> <span class="n">mime</span> <span class="o">=</span> <span class="n">func</span><span class="p">(</span><span class="n">authority</span><span class="p">,</span> <span class="n">timeout</span><span class="o">=</span><span class="n">CFG</span><span class="o">.</span><span class="n">resolver_timeout</span><span class="p">)</span>
    241. 

  241.         <span class="k">if</span> <span class="n">data</span> <span class="ow">is</span> <span class="kc">None</span> <span class="ow">or</span> <span class="n">mime</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
    242. 

  242.             <span class="n">data</span><span class="p">,</span> <span class="n">mime</span> <span class="o">=</span> <span class="p">(</span><span class="kc">None</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span>
    243. 

  243. 

  244.     <span class="k">except</span> <span class="p">(</span><span class="n">HTTPError</span><span class="p">,</span> <span class="n">SearxEngineResponseException</span><span class="p">):</span>
    245. 

  245.         <span class="k">pass</span>
    246. 

  246. 

  247.     <span class="n">cache</span><span class="o">.</span><span class="n">CACHE</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="n">resolver</span><span class="p">,</span> <span class="n">authority</span><span class="p">,</span> <span class="n">mime</span><span class="p">,</span> <span class="n">data</span><span class="p">)</span>
    248. 

  248.     <span class="k">return</span> <span class="n">data</span><span class="p">,</span> <span class="n">mime</span></div>
    249. 

  249. 

  250. 

  251. 

  252. <div class="viewcode-block" id="favicon_url">
    253. 

  253. <a class="viewcode-back" href="../../../src/searx.favicons.html#searx.favicons.favicon_url">[docs]</a>
    254. 

  254. <span class="k">def</span><span class="w"> </span><span class="nf">favicon_url</span><span class="p">(</span><span class="n">authority</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">str</span><span class="p">:</span>
    255. 

  255. <span class="w">    </span><span class="sd">&quot;&quot;&quot;Function to generate the image URL used for favicons in SearXNG&#39;s result</span>
    256. 

  256. <span class="sd">    lists.  The ``authority`` argument (aka netloc / :rfc:`3986`) is usually a</span>
    257. 

  257. <span class="sd">    (sub-) domain name.  This function is used in the HTML (jinja) templates.</span>
    258. 

  258. 

  259. <span class="sd">    .. code:: html</span>
    260. 

  260. 

  261. <span class="sd">       &lt;div class=&quot;favicon&quot;&gt;</span>
    262. 

  262. <span class="sd">          &lt;img src=&quot;{{ favicon_url(result.parsed_url.netloc) }}&quot;&gt;</span>
    263. 

  263. <span class="sd">       &lt;/div&gt;</span>
    264. 

  264. 

  265. <span class="sd">    The returned URL is a route to :py:obj:`favicon_proxy` REST API.</span>
    266. 

  266. 

  267. <span class="sd">    If the favicon is already in the cache, the returned URL is a `data URL`_</span>
    268. 

  268. <span class="sd">    (something like ``data:image/png;base64,...``).  By generating a data url from</span>
    269. 

  269. <span class="sd">    the :py:obj:`.cache.FaviconCache`, additional HTTP roundtripps via the</span>
    270. 

  270. <span class="sd">    :py:obj:`favicon_proxy` are saved.  However, it must also be borne in mind</span>
    271. 

  271. <span class="sd">    that data urls are not cached in the client (web browser).</span>
    272. 

  272. 

  273. <span class="sd">    .. _data URL: https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URLs</span>
    274. 

  274. 

  275. <span class="sd">    &quot;&quot;&quot;</span>
    276. 

  276. 

  277.     <span class="n">resolver</span> <span class="o">=</span> <span class="n">sxng_request</span><span class="o">.</span><span class="n">preferences</span><span class="o">.</span><span class="n">get_value</span><span class="p">(</span><span class="s1">&#39;favicon_resolver&#39;</span><span class="p">)</span>  <span class="c1"># type: ignore</span>
    278. 

  278.     <span class="c1"># if resolver is empty or not valid, just return nothing.</span>
    279. 

  279.     <span class="k">if</span> <span class="ow">not</span> <span class="n">resolver</span> <span class="ow">or</span> <span class="n">resolver</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">CFG</span><span class="o">.</span><span class="n">resolver_map</span><span class="o">.</span><span class="n">keys</span><span class="p">():</span>
    280. 

  280.         <span class="k">return</span> <span class="s2">&quot;&quot;</span>
    281. 

  281. 

  282.     <span class="n">data_mime</span> <span class="o">=</span> <span class="n">cache</span><span class="o">.</span><span class="n">CACHE</span><span class="p">(</span><span class="n">resolver</span><span class="p">,</span> <span class="n">authority</span><span class="p">)</span>
    283. 

  283. 

  284.     <span class="k">if</span> <span class="n">data_mime</span> <span class="o">==</span> <span class="p">(</span><span class="kc">None</span><span class="p">,</span> <span class="kc">None</span><span class="p">):</span>
    285. 

  285.         <span class="c1"># we have already checked, the resolver does not have a favicon</span>
    286. 

  286.         <span class="n">theme</span> <span class="o">=</span> <span class="n">sxng_request</span><span class="o">.</span><span class="n">preferences</span><span class="o">.</span><span class="n">get_value</span><span class="p">(</span><span class="s2">&quot;theme&quot;</span><span class="p">)</span>  <span class="c1"># type: ignore</span>
    287. 

  287.         <span class="k">return</span> <span class="n">CFG</span><span class="o">.</span><span class="n">favicon_data_url</span><span class="p">(</span><span class="n">theme</span><span class="o">=</span><span class="n">theme</span><span class="p">)</span>
    288. 

  288. 

  289.     <span class="k">if</span> <span class="n">data_mime</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
    290. 

  290.         <span class="n">data</span><span class="p">,</span> <span class="n">mime</span> <span class="o">=</span> <span class="n">data_mime</span>
    291. 

  291.         <span class="k">return</span> <span class="sa">f</span><span class="s2">&quot;data:</span><span class="si">{</span><span class="n">mime</span><span class="si">}</span><span class="s2">;base64,</span><span class="si">{</span><span class="nb">str</span><span class="p">(</span><span class="n">base64</span><span class="o">.</span><span class="n">b64encode</span><span class="p">(</span><span class="n">data</span><span class="p">),</span><span class="w"> </span><span class="s1">&#39;utf-8&#39;</span><span class="p">)</span><span class="si">}</span><span class="s2">&quot;</span>  <span class="c1"># type: ignore</span>
    292. 

  292. 

  293.     <span class="n">h</span> <span class="o">=</span> <span class="n">new_hmac</span><span class="p">(</span><span class="n">CFG</span><span class="o">.</span><span class="n">secret_key</span><span class="p">,</span> <span class="n">authority</span><span class="o">.</span><span class="n">encode</span><span class="p">())</span>
    294. 

  294.     <span class="n">proxy_url</span> <span class="o">=</span> <span class="n">flask</span><span class="o">.</span><span class="n">url_for</span><span class="p">(</span><span class="s1">&#39;favicon_proxy&#39;</span><span class="p">)</span>
    295. 

  295.     <span class="n">query</span> <span class="o">=</span> <span class="n">urllib</span><span class="o">.</span><span class="n">parse</span><span class="o">.</span><span class="n">urlencode</span><span class="p">({</span><span class="s2">&quot;authority&quot;</span><span class="p">:</span> <span class="n">authority</span><span class="p">,</span> <span class="s2">&quot;h&quot;</span><span class="p">:</span> <span class="n">h</span><span class="p">})</span>
    296. 

  296.     <span class="k">return</span> <span class="sa">f</span><span class="s2">&quot;</span><span class="si">{</span><span class="n">proxy_url</span><span class="si">}</span><span class="s2">?</span><span class="si">{</span><span class="n">query</span><span class="si">}</span><span class="s2">&quot;</span></div>
    297. 

  297. 

  298. </pre></div>
    299. 

  299. 

  300.             <div class="clearer"></div>
    301. 

  301.           </div>
    302. 

  302.         </div>
    303. 

  303.       </div>
    304. 

  304.   <span id="sidebar-top"></span>
    305. 

  305.       <div class="sphinxsidebar" role="navigation" aria-label="Main">
    306. 

  306.         <div class="sphinxsidebarwrapper">
    307. 

  307.   
    308. 

  308.     
    309. 

  309.             <p class="logo"><a href="../../../index.html">
    310. 

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

  311.             </a></p>
    312. 

  312.   
    313. 

  313. 

  314. <h3><a href="../../../index.html">Table of Contents</a></h3>
    315. 

  315. <ul>
    316. 

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

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

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

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

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

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

  322. </ul>
    323. 

  323. 

  324.   <h3>Project Links</h3>
    325. 

  325.   <ul>
    326. 

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

  327.   
    328. 

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

  329.   
    330. 

  330.     <li><a href="https://searx.space">Public instances</a>
    331. 

  331.   
    332. 

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

  333.   </ul><h3>Navigation</h3>
    334. 

  334. <ul>
    335. 

  335.   <li><a href="../../../index.html">Overview</a>
    336. 

  336.     <ul>
    337. 

  337.       <li><a href="../../index.html">Module code</a>
    338. 

  338.         
    339. 

  339.           
    340. 

  340.           </ul>
    341. 

  341.       </li>
    342. 

  342.     </ul>
    343. 

  343.   </li>
    344. 

  344. </ul>
    345. 

  345. <search id="searchbox" style="display: none" role="search">
    346. 

  346.   <h3 id="searchlabel">Quick search</h3>
    347. 

  347.     <div class="searchformwrapper">
    348. 

  348.     <form class="search" action="../../../search.html" method="get">
    349. 

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

  350.       <input type="submit" value="Go" />
    351. 

  351.     </form>
    352. 

  352.     </div>
    353. 

  353. </search>
    354. 

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

  355.         </div>
    356. 

  356.       </div>
    357. 

  357.       <div class="clearer"></div>
    358. 

  358.     </div>
    359. 

  359.     <div class="footer" role="contentinfo">
    360. 

  360.     &#169; Copyright SearXNG team.
    361. 

  361.     </div>
    362. 

  362.   </body>
    363. 

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