online_url_search.html 9.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159
  1. <!DOCTYPE html>
  2. <html lang="en" data-content_root="../../../../">
  3. <head>
  4. <meta charset="utf-8" />
  5. <meta name="viewport" content="width=device-width, initial-scale=1.0" />
  6. <meta name="viewport" content="width=device-width, initial-scale=1">
  7. <title>searx.search.processors.online_url_search &#8212; SearXNG Documentation (2025.5.2+590b21165)</title>
  8. <link rel="stylesheet" type="text/css" href="../../../../_static/pygments.css?v=6625fa76" />
  9. <link rel="stylesheet" type="text/css" href="../../../../_static/searxng.css?v=52e4ff28" />
  10. <script src="../../../../_static/documentation_options.js?v=8c00f3b4"></script>
  11. <script src="../../../../_static/doctools.js?v=9a2dae69"></script>
  12. <script src="../../../../_static/sphinx_highlight.js?v=dc90522c"></script>
  13. <script data-project="searxng" data-version="2025.5.2+590b21165" src="../../../../_static/describe_version.js?v=fa7f30d0"></script>
  14. <link rel="index" title="Index" href="../../../../genindex.html" />
  15. <link rel="search" title="Search" href="../../../../search.html" />
  16. </head><body>
  17. <div class="related" role="navigation" aria-label="Related">
  18. <h3>Navigation</h3>
  19. <ul>
  20. <li class="right" style="margin-right: 10px">
  21. <a href="../../../../genindex.html" title="General Index"
  22. accesskey="I">index</a></li>
  23. <li class="right" >
  24. <a href="../../../../py-modindex.html" title="Python Module Index"
  25. >modules</a> |</li>
  26. <li class="nav-item nav-item-0"><a href="../../../../index.html">SearXNG Documentation (2025.5.2+590b21165)</a> &#187;</li>
  27. <li class="nav-item nav-item-1"><a href="../../../index.html" >Module code</a> &#187;</li>
  28. <li class="nav-item nav-item-2"><a href="../../search.html" accesskey="U">searx.search</a> &#187;</li>
  29. <li class="nav-item nav-item-this"><a href="">searx.search.processors.online_url_search</a></li>
  30. </ul>
  31. </div>
  32. <div class="document">
  33. <div class="documentwrapper">
  34. <div class="bodywrapper">
  35. <div class="body" role="main">
  36. <h1>Source code for searx.search.processors.online_url_search</h1><div class="highlight"><pre>
  37. <span></span><span class="c1"># SPDX-License-Identifier: AGPL-3.0-or-later</span>
  38. <span class="sd">&quot;&quot;&quot;Processors for engine-type: ``online_url_search``</span>
  39. <span class="sd">&quot;&quot;&quot;</span>
  40. <span class="kn">import</span><span class="w"> </span><span class="nn">re</span>
  41. <span class="kn">from</span><span class="w"> </span><span class="nn">.online</span><span class="w"> </span><span class="kn">import</span> <span class="n">OnlineProcessor</span>
  42. <span class="n">re_search_urls</span> <span class="o">=</span> <span class="p">{</span>
  43. <span class="s1">&#39;http&#39;</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="sa">r</span><span class="s1">&#39;https?:\/\/[^ ]*&#39;</span><span class="p">),</span>
  44. <span class="s1">&#39;ftp&#39;</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="sa">r</span><span class="s1">&#39;ftps?:\/\/[^ ]*&#39;</span><span class="p">),</span>
  45. <span class="s1">&#39;data:image&#39;</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="s1">&#39;data:image/[^; ]*;base64,[^ ]*&#39;</span><span class="p">),</span>
  46. <span class="p">}</span>
  47. <div class="viewcode-block" id="OnlineUrlSearchProcessor">
  48. <a class="viewcode-back" href="../../../../src/searx.search.processors.html#searx.search.processors.online_url_search.OnlineUrlSearchProcessor">[docs]</a>
  49. <span class="k">class</span><span class="w"> </span><span class="nc">OnlineUrlSearchProcessor</span><span class="p">(</span><span class="n">OnlineProcessor</span><span class="p">):</span>
  50. <span class="w"> </span><span class="sd">&quot;&quot;&quot;Processor class used by ``online_url_search`` engines.&quot;&quot;&quot;</span>
  51. <span class="n">engine_type</span> <span class="o">=</span> <span class="s1">&#39;online_url_search&#39;</span>
  52. <div class="viewcode-block" id="OnlineUrlSearchProcessor.get_params">
  53. <a class="viewcode-back" href="../../../../src/searx.search.processors.html#searx.search.processors.online_url_search.OnlineUrlSearchProcessor.get_params">[docs]</a>
  54. <span class="k">def</span><span class="w"> </span><span class="nf">get_params</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">search_query</span><span class="p">,</span> <span class="n">engine_category</span><span class="p">):</span>
  55. <span class="w"> </span><span class="sd">&quot;&quot;&quot;Returns a set of :ref:`request params &lt;engine request online&gt;` or ``None`` if</span>
  56. <span class="sd"> search query does not match to :py:obj:`re_search_urls`.</span>
  57. <span class="sd"> &quot;&quot;&quot;</span>
  58. <span class="n">params</span> <span class="o">=</span> <span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="n">get_params</span><span class="p">(</span><span class="n">search_query</span><span class="p">,</span> <span class="n">engine_category</span><span class="p">)</span>
  59. <span class="k">if</span> <span class="n">params</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
  60. <span class="k">return</span> <span class="kc">None</span>
  61. <span class="n">url_match</span> <span class="o">=</span> <span class="kc">False</span>
  62. <span class="n">search_urls</span> <span class="o">=</span> <span class="p">{}</span>
  63. <span class="k">for</span> <span class="n">k</span><span class="p">,</span> <span class="n">v</span> <span class="ow">in</span> <span class="n">re_search_urls</span><span class="o">.</span><span class="n">items</span><span class="p">():</span>
  64. <span class="n">m</span> <span class="o">=</span> <span class="n">v</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="n">search_query</span><span class="o">.</span><span class="n">query</span><span class="p">)</span>
  65. <span class="n">v</span> <span class="o">=</span> <span class="kc">None</span>
  66. <span class="k">if</span> <span class="n">m</span><span class="p">:</span>
  67. <span class="n">url_match</span> <span class="o">=</span> <span class="kc">True</span>
  68. <span class="n">v</span> <span class="o">=</span> <span class="n">m</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span>
  69. <span class="n">search_urls</span><span class="p">[</span><span class="n">k</span><span class="p">]</span> <span class="o">=</span> <span class="n">v</span>
  70. <span class="k">if</span> <span class="ow">not</span> <span class="n">url_match</span><span class="p">:</span>
  71. <span class="k">return</span> <span class="kc">None</span>
  72. <span class="n">params</span><span class="p">[</span><span class="s1">&#39;search_urls&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">search_urls</span>
  73. <span class="k">return</span> <span class="n">params</span></div>
  74. </div>
  75. </pre></div>
  76. <div class="clearer"></div>
  77. </div>
  78. </div>
  79. </div>
  80. <span id="sidebar-top"></span>
  81. <div class="sphinxsidebar" role="navigation" aria-label="Main">
  82. <div class="sphinxsidebarwrapper">
  83. <p class="logo"><a href="../../../../index.html">
  84. <img class="logo" src="../../../../_static/searxng-wordmark.svg" alt="Logo of SearXNG"/>
  85. </a></p>
  86. <h3><a href="../../../../index.html">Table of Contents</a></h3>
  87. <ul>
  88. <li class="toctree-l1"><a class="reference internal" href="../../../../user/index.html">User information</a></li>
  89. <li class="toctree-l1"><a class="reference internal" href="../../../../own-instance.html">Why use a private instance?</a></li>
  90. <li class="toctree-l1"><a class="reference internal" href="../../../../admin/index.html">Administrator documentation</a></li>
  91. <li class="toctree-l1"><a class="reference internal" href="../../../../dev/index.html">Developer documentation</a></li>
  92. <li class="toctree-l1"><a class="reference internal" href="../../../../utils/index.html">DevOps tooling box</a></li>
  93. <li class="toctree-l1"><a class="reference internal" href="../../../../src/index.html">Source-Code</a></li>
  94. </ul>
  95. <h3>Project Links</h3>
  96. <ul>
  97. <li><a href="https://github.com/searxng/searxng/tree/master">Source</a>
  98. <li><a href="https://github.com/searxng/searxng/wiki">Wiki</a>
  99. <li><a href="https://searx.space">Public instances</a>
  100. <li><a href="https://github.com/searxng/searxng/issues">Issue Tracker</a>
  101. </ul><h3>Navigation</h3>
  102. <ul>
  103. <li><a href="../../../../index.html">Overview</a>
  104. <ul>
  105. <li><a href="../../../index.html">Module code</a>
  106. <ul>
  107. <li><a href="../../search.html">searx.search</a>
  108. </ul>
  109. </li></ul>
  110. </li>
  111. </ul>
  112. </li>
  113. </ul>
  114. <search id="searchbox" style="display: none" role="search">
  115. <h3 id="searchlabel">Quick search</h3>
  116. <div class="searchformwrapper">
  117. <form class="search" action="../../../../search.html" method="get">
  118. <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
  119. <input type="submit" value="Go" />
  120. </form>
  121. </div>
  122. </search>
  123. <script>document.getElementById('searchbox').style.display = "block"</script>
  124. </div>
  125. </div>
  126. <div class="clearer"></div>
  127. </div>
  128. <div class="footer" role="contentinfo">
  129. &#169; Copyright SearXNG team.
  130. </div>
  131. </body>
  132. </html>