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
/
engines
/
command.html

command.html 32 KB
History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354 
  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.engines.command &#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" >Module code</a> &#187;</li>
    29. 

  29.           <li class="nav-item nav-item-2"><a href="../engines.html" accesskey="U">searx.engines</a> &#187;</li>
    30. 

  30.         <li class="nav-item nav-item-this"><a href="">searx.engines.command</a></li> 
    31. 

  31.       </ul>
    32. 

  32.     </div>  
    33. 

  33. 

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

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

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

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

  38.             
    39. 

  39.   <h1>Source code for searx.engines.command</h1><div class="highlight"><pre>
    40. 

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

  41. <span class="sd">&quot;&quot;&quot;With *command engines* administrators can run engines to integrate arbitrary</span>
    42. 

  42. <span class="sd">shell commands.</span>
    43. 

  43. 

  44. <span class="sd">.. attention::</span>
    45. 

  45. 

  46. <span class="sd">   When creating and enabling a ``command`` engine on a public instance, you</span>
    47. 

  47. <span class="sd">   must be careful to avoid leaking private data.</span>
    48. 

  48. 

  49. <span class="sd">The easiest solution is to limit the access by setting ``tokens`` as described</span>
    50. 

  50. <span class="sd">in section :ref:`private engines`.  The engine base is flexible.  Only your</span>
    51. 

  51. <span class="sd">imagination can limit the power of this engine (and maybe security concerns).</span>
    52. 

  52. 

  53. <span class="sd">Configuration</span>
    54. 

  54. <span class="sd">=============</span>
    55. 

  55. 

  56. <span class="sd">The following options are available:</span>
    57. 

  57. 

  58. <span class="sd">``command``:</span>
    59. 

  59. <span class="sd">  A comma separated list of the elements of the command.  A special token</span>
    60. 

  60. <span class="sd">  ``{{QUERY}}`` tells where to put the search terms of the user. Example:</span>
    61. 

  61. 

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

  63. 

  64. <span class="sd">     [&#39;ls&#39;, &#39;-l&#39;, &#39;-h&#39;, &#39;{{QUERY}}&#39;]</span>
    65. 

  65. 

  66. <span class="sd">``delimiter``:</span>
    67. 

  67. <span class="sd">  A mapping containing a delimiter ``char`` and the *titles* of each element in</span>
    68. 

  68. <span class="sd">  ``keys``.</span>
    69. 

  69. 

  70. <span class="sd">``parse_regex``:</span>
    71. 

  71. <span class="sd">  A dict containing the regular expressions for each result key.</span>
    72. 

  72. 

  73. <span class="sd">``query_type``:</span>
    74. 

  74. 

  75. <span class="sd">  The expected type of user search terms.  Possible values: ``path`` and</span>
    76. 

  76. <span class="sd">  ``enum``.</span>
    77. 

  77. 

  78. <span class="sd">  ``path``:</span>
    79. 

  79. <span class="sd">    Checks if the user provided path is inside the working directory.  If not,</span>
    80. 

  80. <span class="sd">    the query is not executed.</span>
    81. 

  81. 

  82. <span class="sd">  ``enum``:</span>
    83. 

  83. <span class="sd">    Is a list of allowed search terms.  If the user submits something which is</span>
    84. 

  84. <span class="sd">    not included in the list, the query returns an error.</span>
    85. 

  85. 

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

  87. <span class="sd">  A list containing allowed search terms if ``query_type`` is set to ``enum``.</span>
    88. 

  88. 

  89. <span class="sd">``working_dir``:</span>
    90. 

  90. <span class="sd">  The directory where the command has to be executed.  Default: ``./``.</span>
    91. 

  91. 

  92. <span class="sd">``result_separator``:</span>
    93. 

  93. <span class="sd">  The character that separates results. Default: ``\\n``.</span>
    94. 

  94. 

  95. <span class="sd">Example</span>
    96. 

  96. <span class="sd">=======</span>
    97. 

  97. 

  98. <span class="sd">The example engine below can be used to find files with a specific name in the</span>
    99. 

  99. <span class="sd">configured working directory:</span>
    100. 

  100. 

  101. <span class="sd">.. code:: yaml</span>
    102. 

  102. 

  103. <span class="sd">  - name: find</span>
    104. 

  104. <span class="sd">    engine: command</span>
    105. 

  105. <span class="sd">    command: [&#39;find&#39;, &#39;.&#39;, &#39;-name&#39;, &#39;{{QUERY}}&#39;]</span>
    106. 

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

  107. <span class="sd">    shortcut: fnd</span>
    108. 

  108. <span class="sd">    delimiter:</span>
    109. 

  109. <span class="sd">        chars: &#39; &#39;</span>
    110. 

  110. <span class="sd">        keys: [&#39;line&#39;]</span>
    111. 

  111. 

  112. <span class="sd">Implementations</span>
    113. 

  113. <span class="sd">===============</span>
    114. 

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

  115. 

  116. <span class="kn">import</span><span class="w"> </span><span class="nn">re</span>
    117. 

  117. <span class="kn">from</span><span class="w"> </span><span class="nn">os.path</span><span class="w"> </span><span class="kn">import</span> <span class="n">expanduser</span><span class="p">,</span> <span class="n">isabs</span><span class="p">,</span> <span class="n">realpath</span><span class="p">,</span> <span class="n">commonprefix</span>
    118. 

  118. <span class="kn">from</span><span class="w"> </span><span class="nn">shlex</span><span class="w"> </span><span class="kn">import</span> <span class="n">split</span> <span class="k">as</span> <span class="n">shlex_split</span>
    119. 

  119. <span class="kn">from</span><span class="w"> </span><span class="nn">subprocess</span><span class="w"> </span><span class="kn">import</span> <span class="n">Popen</span><span class="p">,</span> <span class="n">PIPE</span>
    120. 

  120. <span class="kn">from</span><span class="w"> </span><span class="nn">threading</span><span class="w"> </span><span class="kn">import</span> <span class="n">Thread</span>
    121. 

  121. 

  122. <span class="kn">from</span><span class="w"> </span><span class="nn">searx</span><span class="w"> </span><span class="kn">import</span> <span class="n">logger</span>
    123. 

  123. <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">EngineResults</span>
    124. 

  124. 

  125. 

  126. <span class="n">engine_type</span> <span class="o">=</span> <span class="s1">&#39;offline&#39;</span>
    127. 

  127. <span class="n">paging</span> <span class="o">=</span> <span class="kc">True</span>
    128. 

  128. <span class="n">command</span> <span class="o">=</span> <span class="p">[]</span>
    129. 

  129. <span class="n">delimiter</span> <span class="o">=</span> <span class="p">{}</span>
    130. 

  130. <span class="n">parse_regex</span> <span class="o">=</span> <span class="p">{}</span>
    131. 

  131. <span class="n">query_type</span> <span class="o">=</span> <span class="s1">&#39;&#39;</span>
    132. 

  132. <span class="n">query_enum</span> <span class="o">=</span> <span class="p">[]</span>
    133. 

  133. <span class="n">environment_variables</span> <span class="o">=</span> <span class="p">{}</span>
    134. 

  134. <span class="n">working_dir</span> <span class="o">=</span> <span class="n">realpath</span><span class="p">(</span><span class="s1">&#39;.&#39;</span><span class="p">)</span>
    135. 

  135. <span class="n">result_separator</span> <span class="o">=</span> <span class="s1">&#39;</span><span class="se">\n</span><span class="s1">&#39;</span>
    136. 

  136. <span class="n">timeout</span> <span class="o">=</span> <span class="mf">4.0</span>
    137. 

  137. 

  138. <span class="n">_command_logger</span> <span class="o">=</span> <span class="n">logger</span><span class="o">.</span><span class="n">getChild</span><span class="p">(</span><span class="s1">&#39;command&#39;</span><span class="p">)</span>
    139. 

  139. <span class="n">_compiled_parse_regex</span> <span class="o">=</span> <span class="p">{}</span>
    140. 

  140. 

  141. 

  142. <span class="k">def</span><span class="w"> </span><span class="nf">init</span><span class="p">(</span><span class="n">engine_settings</span><span class="p">):</span>
    143. 

  143.     <span class="n">check_parsing_options</span><span class="p">(</span><span class="n">engine_settings</span><span class="p">)</span>
    144. 

  144. 

  145.     <span class="k">if</span> <span class="s1">&#39;command&#39;</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">engine_settings</span><span class="p">:</span>
    146. 

  146.         <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s1">&#39;engine command : missing configuration key: command&#39;</span><span class="p">)</span>
    147. 

  147. 

  148.     <span class="k">global</span> <span class="n">command</span><span class="p">,</span> <span class="n">working_dir</span><span class="p">,</span> <span class="n">delimiter</span><span class="p">,</span> <span class="n">parse_regex</span><span class="p">,</span> <span class="n">environment_variables</span>  <span class="c1"># pylint: disable=global-statement</span>
    149. 

  149. 

  150.     <span class="n">command</span> <span class="o">=</span> <span class="n">engine_settings</span><span class="p">[</span><span class="s1">&#39;command&#39;</span><span class="p">]</span>
    151. 

  151. 

  152.     <span class="k">if</span> <span class="s1">&#39;working_dir&#39;</span> <span class="ow">in</span> <span class="n">engine_settings</span><span class="p">:</span>
    153. 

  153.         <span class="n">working_dir</span> <span class="o">=</span> <span class="n">engine_settings</span><span class="p">[</span><span class="s1">&#39;working_dir&#39;</span><span class="p">]</span>
    154. 

  154.         <span class="k">if</span> <span class="ow">not</span> <span class="n">isabs</span><span class="p">(</span><span class="n">engine_settings</span><span class="p">[</span><span class="s1">&#39;working_dir&#39;</span><span class="p">]):</span>
    155. 

  155.             <span class="n">working_dir</span> <span class="o">=</span> <span class="n">realpath</span><span class="p">(</span><span class="n">working_dir</span><span class="p">)</span>
    156. 

  156. 

  157.     <span class="k">if</span> <span class="s1">&#39;parse_regex&#39;</span> <span class="ow">in</span> <span class="n">engine_settings</span><span class="p">:</span>
    158. 

  158.         <span class="n">parse_regex</span> <span class="o">=</span> <span class="n">engine_settings</span><span class="p">[</span><span class="s1">&#39;parse_regex&#39;</span><span class="p">]</span>
    159. 

  159.         <span class="k">for</span> <span class="n">result_key</span><span class="p">,</span> <span class="n">regex</span> <span class="ow">in</span> <span class="n">parse_regex</span><span class="o">.</span><span class="n">items</span><span class="p">():</span>
    160. 

  160.             <span class="n">_compiled_parse_regex</span><span class="p">[</span><span class="n">result_key</span><span class="p">]</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="n">regex</span><span class="p">,</span> <span class="n">flags</span><span class="o">=</span><span class="n">re</span><span class="o">.</span><span class="n">MULTILINE</span><span class="p">)</span>
    161. 

  161.     <span class="k">if</span> <span class="s1">&#39;delimiter&#39;</span> <span class="ow">in</span> <span class="n">engine_settings</span><span class="p">:</span>
    162. 

  162.         <span class="n">delimiter</span> <span class="o">=</span> <span class="n">engine_settings</span><span class="p">[</span><span class="s1">&#39;delimiter&#39;</span><span class="p">]</span>
    163. 

  163. 

  164.     <span class="k">if</span> <span class="s1">&#39;environment_variables&#39;</span> <span class="ow">in</span> <span class="n">engine_settings</span><span class="p">:</span>
    165. 

  165.         <span class="n">environment_variables</span> <span class="o">=</span> <span class="n">engine_settings</span><span class="p">[</span><span class="s1">&#39;environment_variables&#39;</span><span class="p">]</span>
    166. 

  166. 

  167. 

  168. <span class="k">def</span><span class="w"> </span><span class="nf">search</span><span class="p">(</span><span class="n">query</span><span class="p">,</span> <span class="n">params</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">EngineResults</span><span class="p">:</span>
    169. 

  169.     <span class="n">res</span> <span class="o">=</span> <span class="n">EngineResults</span><span class="p">()</span>
    170. 

  170.     <span class="n">cmd</span> <span class="o">=</span> <span class="n">_get_command_to_run</span><span class="p">(</span><span class="n">query</span><span class="p">)</span>
    171. 

  171.     <span class="k">if</span> <span class="ow">not</span> <span class="n">cmd</span><span class="p">:</span>
    172. 

  172.         <span class="k">return</span> <span class="n">res</span>
    173. 

  173. 

  174.     <span class="n">reader_thread</span> <span class="o">=</span> <span class="n">Thread</span><span class="p">(</span><span class="n">target</span><span class="o">=</span><span class="n">_get_results_from_process</span><span class="p">,</span> <span class="n">args</span><span class="o">=</span><span class="p">(</span><span class="n">res</span><span class="p">,</span> <span class="n">cmd</span><span class="p">,</span> <span class="n">params</span><span class="p">[</span><span class="s1">&#39;pageno&#39;</span><span class="p">]))</span>
    175. 

  175.     <span class="n">reader_thread</span><span class="o">.</span><span class="n">start</span><span class="p">()</span>
    176. 

  176.     <span class="n">reader_thread</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">timeout</span><span class="o">=</span><span class="n">timeout</span><span class="p">)</span>
    177. 

  177. 

  178.     <span class="k">return</span> <span class="n">res</span>
    179. 

  179. 

  180. 

  181. <span class="k">def</span><span class="w"> </span><span class="nf">_get_command_to_run</span><span class="p">(</span><span class="n">query</span><span class="p">):</span>
    182. 

  182.     <span class="n">params</span> <span class="o">=</span> <span class="n">shlex_split</span><span class="p">(</span><span class="n">query</span><span class="p">)</span>
    183. 

  183.     <span class="n">__check_query_params</span><span class="p">(</span><span class="n">params</span><span class="p">)</span>
    184. 

  184. 

  185.     <span class="n">cmd</span> <span class="o">=</span> <span class="p">[]</span>
    186. 

  186.     <span class="k">for</span> <span class="n">c</span> <span class="ow">in</span> <span class="n">command</span><span class="p">:</span>
    187. 

  187.         <span class="k">if</span> <span class="n">c</span> <span class="o">==</span> <span class="s1">&#39;{{QUERY}}&#39;</span><span class="p">:</span>
    188. 

  188.             <span class="n">cmd</span><span class="o">.</span><span class="n">extend</span><span class="p">(</span><span class="n">params</span><span class="p">)</span>
    189. 

  189.         <span class="k">else</span><span class="p">:</span>
    190. 

  190.             <span class="n">cmd</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">c</span><span class="p">)</span>
    191. 

  191. 

  192.     <span class="k">return</span> <span class="n">cmd</span>
    193. 

  193. 

  194. 

  195. <span class="k">def</span><span class="w"> </span><span class="nf">_get_results_from_process</span><span class="p">(</span><span class="n">res</span><span class="p">:</span> <span class="n">EngineResults</span><span class="p">,</span> <span class="n">cmd</span><span class="p">,</span> <span class="n">pageno</span><span class="p">):</span>
    196. 

  196.     <span class="n">leftover</span> <span class="o">=</span> <span class="s1">&#39;&#39;</span>
    197. 

  197.     <span class="n">count</span> <span class="o">=</span> <span class="mi">0</span>
    198. 

  198.     <span class="n">start</span><span class="p">,</span> <span class="n">end</span> <span class="o">=</span> <span class="n">__get_results_limits</span><span class="p">(</span><span class="n">pageno</span><span class="p">)</span>
    199. 

  199.     <span class="k">with</span> <span class="n">Popen</span><span class="p">(</span><span class="n">cmd</span><span class="p">,</span> <span class="n">stdout</span><span class="o">=</span><span class="n">PIPE</span><span class="p">,</span> <span class="n">stderr</span><span class="o">=</span><span class="n">PIPE</span><span class="p">,</span> <span class="n">env</span><span class="o">=</span><span class="n">environment_variables</span><span class="p">)</span> <span class="k">as</span> <span class="n">process</span><span class="p">:</span>
    200. 

  200.         <span class="n">line</span> <span class="o">=</span> <span class="n">process</span><span class="o">.</span><span class="n">stdout</span><span class="o">.</span><span class="n">readline</span><span class="p">()</span>
    201. 

  201.         <span class="k">while</span> <span class="n">line</span><span class="p">:</span>
    202. 

  202.             <span class="n">buf</span> <span class="o">=</span> <span class="n">leftover</span> <span class="o">+</span> <span class="n">line</span><span class="o">.</span><span class="n">decode</span><span class="p">(</span><span class="s1">&#39;utf-8&#39;</span><span class="p">)</span>
    203. 

  203.             <span class="n">raw_results</span> <span class="o">=</span> <span class="n">buf</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="n">result_separator</span><span class="p">)</span>
    204. 

  204.             <span class="k">if</span> <span class="n">raw_results</span><span class="p">[</span><span class="o">-</span><span class="mi">1</span><span class="p">]:</span>
    205. 

  205.                 <span class="n">leftover</span> <span class="o">=</span> <span class="n">raw_results</span><span class="p">[</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span>
    206. 

  206.             <span class="n">raw_results</span> <span class="o">=</span> <span class="n">raw_results</span><span class="p">[:</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span>
    207. 

  207. 

  208.             <span class="k">for</span> <span class="n">raw_result</span> <span class="ow">in</span> <span class="n">raw_results</span><span class="p">:</span>
    209. 

  209.                 <span class="n">result</span> <span class="o">=</span> <span class="n">__parse_single_result</span><span class="p">(</span><span class="n">raw_result</span><span class="p">)</span>
    210. 

  210.                 <span class="k">if</span> <span class="n">result</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
    211. 

  211.                     <span class="n">_command_logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s1">&#39;skipped result:&#39;</span><span class="p">,</span> <span class="n">raw_result</span><span class="p">)</span>
    212. 

  212.                     <span class="k">continue</span>
    213. 

  213. 

  214.                 <span class="k">if</span> <span class="n">start</span> <span class="o">&lt;=</span> <span class="n">count</span> <span class="ow">and</span> <span class="n">count</span> <span class="o">&lt;=</span> <span class="n">end</span><span class="p">:</span>  <span class="c1"># pylint: disable=chained-comparison</span>
    215. 

  215.                     <span class="n">res</span><span class="o">.</span><span class="n">add</span><span class="p">(</span><span class="n">res</span><span class="o">.</span><span class="n">types</span><span class="o">.</span><span class="n">KeyValue</span><span class="p">(</span><span class="n">kvmap</span><span class="o">=</span><span class="n">result</span><span class="p">))</span>
    216. 

  216. 

  217.                 <span class="n">count</span> <span class="o">+=</span> <span class="mi">1</span>
    218. 

  218.                 <span class="k">if</span> <span class="n">end</span> <span class="o">&lt;</span> <span class="n">count</span><span class="p">:</span>
    219. 

  219.                     <span class="k">return</span> <span class="n">res</span>
    220. 

  220. 

  221.             <span class="n">line</span> <span class="o">=</span> <span class="n">process</span><span class="o">.</span><span class="n">stdout</span><span class="o">.</span><span class="n">readline</span><span class="p">()</span>
    222. 

  222. 

  223.         <span class="n">return_code</span> <span class="o">=</span> <span class="n">process</span><span class="o">.</span><span class="n">wait</span><span class="p">(</span><span class="n">timeout</span><span class="o">=</span><span class="n">timeout</span><span class="p">)</span>
    224. 

  224.         <span class="k">if</span> <span class="n">return_code</span> <span class="o">!=</span> <span class="mi">0</span><span class="p">:</span>
    225. 

  225.             <span class="k">raise</span> <span class="ne">RuntimeError</span><span class="p">(</span><span class="s1">&#39;non-zero return code when running command&#39;</span><span class="p">,</span> <span class="n">cmd</span><span class="p">,</span> <span class="n">return_code</span><span class="p">)</span>
    226. 

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

  227. 

  228. 

  229. <span class="k">def</span><span class="w"> </span><span class="nf">__get_results_limits</span><span class="p">(</span><span class="n">pageno</span><span class="p">):</span>
    230. 

  230.     <span class="n">start</span> <span class="o">=</span> <span class="p">(</span><span class="n">pageno</span> <span class="o">-</span> <span class="mi">1</span><span class="p">)</span> <span class="o">*</span> <span class="mi">10</span>
    231. 

  231.     <span class="n">end</span> <span class="o">=</span> <span class="n">start</span> <span class="o">+</span> <span class="mi">9</span>
    232. 

  232.     <span class="k">return</span> <span class="n">start</span><span class="p">,</span> <span class="n">end</span>
    233. 

  233. 

  234. 

  235. <span class="k">def</span><span class="w"> </span><span class="nf">__check_query_params</span><span class="p">(</span><span class="n">params</span><span class="p">):</span>
    236. 

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

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

  238. 

  239.     <span class="k">if</span> <span class="n">query_type</span> <span class="o">==</span> <span class="s1">&#39;path&#39;</span><span class="p">:</span>
    240. 

  240.         <span class="n">query_path</span> <span class="o">=</span> <span class="n">params</span><span class="p">[</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span>
    241. 

  241.         <span class="n">query_path</span> <span class="o">=</span> <span class="n">expanduser</span><span class="p">(</span><span class="n">query_path</span><span class="p">)</span>
    242. 

  242.         <span class="k">if</span> <span class="n">commonprefix</span><span class="p">([</span><span class="n">realpath</span><span class="p">(</span><span class="n">query_path</span><span class="p">),</span> <span class="n">working_dir</span><span class="p">])</span> <span class="o">!=</span> <span class="n">working_dir</span><span class="p">:</span>
    243. 

  243.             <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s1">&#39;requested path is outside of configured working directory&#39;</span><span class="p">)</span>
    244. 

  244.     <span class="k">elif</span> <span class="n">query_type</span> <span class="o">==</span> <span class="s1">&#39;enum&#39;</span> <span class="ow">and</span> <span class="nb">len</span><span class="p">(</span><span class="n">query_enum</span><span class="p">)</span> <span class="o">&gt;</span> <span class="mi">0</span><span class="p">:</span>
    245. 

  245.         <span class="k">for</span> <span class="n">param</span> <span class="ow">in</span> <span class="n">params</span><span class="p">:</span>
    246. 

  246.             <span class="k">if</span> <span class="n">param</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">query_enum</span><span class="p">:</span>
    247. 

  247.                 <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s1">&#39;submitted query params is not allowed&#39;</span><span class="p">,</span> <span class="n">param</span><span class="p">,</span> <span class="s1">&#39;allowed params:&#39;</span><span class="p">,</span> <span class="n">query_enum</span><span class="p">)</span>
    248. 

  248. 

  249. 

  250. <div class="viewcode-block" id="check_parsing_options">
    251. 

  251. <a class="viewcode-back" href="../../../dev/engines/offline/command-line-engines.html#searx.engines.command.check_parsing_options">[docs]</a>
    252. 

  252. <span class="k">def</span><span class="w"> </span><span class="nf">check_parsing_options</span><span class="p">(</span><span class="n">engine_settings</span><span class="p">):</span>
    253. 

  253. <span class="w">    </span><span class="sd">&quot;&quot;&quot;Checks if delimiter based parsing or regex parsing is configured correctly&quot;&quot;&quot;</span>
    254. 

  254. 

  255.     <span class="k">if</span> <span class="s1">&#39;delimiter&#39;</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">engine_settings</span> <span class="ow">and</span> <span class="s1">&#39;parse_regex&#39;</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">engine_settings</span><span class="p">:</span>
    256. 

  256.         <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s1">&#39;failed to init settings for parsing lines: missing delimiter or parse_regex&#39;</span><span class="p">)</span>
    257. 

  257.     <span class="k">if</span> <span class="s1">&#39;delimiter&#39;</span> <span class="ow">in</span> <span class="n">engine_settings</span> <span class="ow">and</span> <span class="s1">&#39;parse_regex&#39;</span> <span class="ow">in</span> <span class="n">engine_settings</span><span class="p">:</span>
    258. 

  258.         <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s1">&#39;failed to init settings for parsing lines: too many settings&#39;</span><span class="p">)</span>
    259. 

  259. 

  260.     <span class="k">if</span> <span class="s1">&#39;delimiter&#39;</span> <span class="ow">in</span> <span class="n">engine_settings</span><span class="p">:</span>
    261. 

  261.         <span class="k">if</span> <span class="s1">&#39;chars&#39;</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">engine_settings</span><span class="p">[</span><span class="s1">&#39;delimiter&#39;</span><span class="p">]</span> <span class="ow">or</span> <span class="s1">&#39;keys&#39;</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">engine_settings</span><span class="p">[</span><span class="s1">&#39;delimiter&#39;</span><span class="p">]:</span>
    262. 

  262.             <span class="k">raise</span> <span class="ne">ValueError</span></div>
    263. 

  263. 

  264. 

  265. 

  266. <span class="k">def</span><span class="w"> </span><span class="nf">__parse_single_result</span><span class="p">(</span><span class="n">raw_result</span><span class="p">):</span>
    267. 

  267. <span class="w">    </span><span class="sd">&quot;&quot;&quot;Parses command line output based on configuration&quot;&quot;&quot;</span>
    268. 

  268. 

  269.     <span class="n">result</span> <span class="o">=</span> <span class="p">{}</span>
    270. 

  270. 

  271.     <span class="k">if</span> <span class="n">delimiter</span><span class="p">:</span>
    272. 

  272.         <span class="n">elements</span> <span class="o">=</span> <span class="n">raw_result</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="n">delimiter</span><span class="p">[</span><span class="s1">&#39;chars&#39;</span><span class="p">],</span> <span class="n">maxsplit</span><span class="o">=</span><span class="nb">len</span><span class="p">(</span><span class="n">delimiter</span><span class="p">[</span><span class="s1">&#39;keys&#39;</span><span class="p">])</span> <span class="o">-</span> <span class="mi">1</span><span class="p">)</span>
    273. 

  273.         <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">elements</span><span class="p">)</span> <span class="o">!=</span> <span class="nb">len</span><span class="p">(</span><span class="n">delimiter</span><span class="p">[</span><span class="s1">&#39;keys&#39;</span><span class="p">]):</span>
    274. 

  274.             <span class="k">return</span> <span class="p">{}</span>
    275. 

  275.         <span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="nb">len</span><span class="p">(</span><span class="n">elements</span><span class="p">)):</span>  <span class="c1"># pylint: disable=consider-using-enumerate</span>
    276. 

  276.             <span class="n">result</span><span class="p">[</span><span class="n">delimiter</span><span class="p">[</span><span class="s1">&#39;keys&#39;</span><span class="p">][</span><span class="n">i</span><span class="p">]]</span> <span class="o">=</span> <span class="n">elements</span><span class="p">[</span><span class="n">i</span><span class="p">]</span>
    277. 

  277. 

  278.     <span class="k">if</span> <span class="n">parse_regex</span><span class="p">:</span>
    279. 

  279.         <span class="k">for</span> <span class="n">result_key</span><span class="p">,</span> <span class="n">regex</span> <span class="ow">in</span> <span class="n">_compiled_parse_regex</span><span class="o">.</span><span class="n">items</span><span class="p">():</span>
    280. 

  280.             <span class="n">found</span> <span class="o">=</span> <span class="n">regex</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="n">raw_result</span><span class="p">)</span>
    281. 

  281.             <span class="k">if</span> <span class="ow">not</span> <span class="n">found</span><span class="p">:</span>
    282. 

  282.                 <span class="k">return</span> <span class="p">{}</span>
    283. 

  283.             <span class="n">result</span><span class="p">[</span><span class="n">result_key</span><span class="p">]</span> <span class="o">=</span> <span class="n">raw_result</span><span class="p">[</span><span class="n">found</span><span class="o">.</span><span class="n">start</span><span class="p">()</span> <span class="p">:</span> <span class="n">found</span><span class="o">.</span><span class="n">end</span><span class="p">()]</span>
    284. 

  284. 

  285.     <span class="k">return</span> <span class="n">result</span>
    286. 

  286. </pre></div>
    287. 

  287. 

  288.             <div class="clearer"></div>
    289. 

  289.           </div>
    290. 

  290.         </div>
    291. 

  291.       </div>
    292. 

  292.   <span id="sidebar-top"></span>
    293. 

  293.       <div class="sphinxsidebar" role="navigation" aria-label="Main">
    294. 

  294.         <div class="sphinxsidebarwrapper">
    295. 

  295.   
    296. 

  296.     
    297. 

  297.             <p class="logo"><a href="../../../index.html">
    298. 

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

  299.             </a></p>
    300. 

  300.   
    301. 

  301. 

  302. <h3><a href="../../../index.html">Table of Contents</a></h3>
    303. 

  303. <ul>
    304. 

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

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

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

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

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

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

  310. </ul>
    311. 

  311. 

  312.   <h3>Project Links</h3>
    313. 

  313.   <ul>
    314. 

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

  315.   
    316. 

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

  317.   
    318. 

  318.     <li><a href="https://searx.space">Public instances</a>
    319. 

  319.   
    320. 

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

  321.   </ul><h3>Navigation</h3>
    322. 

  322. <ul>
    323. 

  323.   <li><a href="../../../index.html">Overview</a>
    324. 

  324.     <ul>
    325. 

  325.       <li><a href="../../index.html">Module code</a>
    326. 

  326.         <ul>
    327. 

  327.       <li><a href="../engines.html">searx.engines</a>
    328. 

  328.         
    329. 

  329.           
    330. 

  330.           </ul>
    331. 

  331.       </li></ul>
    332. 

  332.       </li>
    333. 

  333.     </ul>
    334. 

  334.   </li>
    335. 

  335. </ul>
    336. 

  336. <search id="searchbox" style="display: none" role="search">
    337. 

  337.   <h3 id="searchlabel">Quick search</h3>
    338. 

  338.     <div class="searchformwrapper">
    339. 

  339.     <form class="search" action="../../../search.html" method="get">
    340. 

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

  341.       <input type="submit" value="Go" />
    342. 

  342.     </form>
    343. 

  343.     </div>
    344. 

  344. </search>
    345. 

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

  346.         </div>
    347. 

  347.       </div>
    348. 

  348.       <div class="clearer"></div>
    349. 

  349.     </div>
    350. 

  350.     <div class="footer" role="contentinfo">
    351. 

  351.     &#169; Copyright SearXNG team.
    352. 

  352.     </div>
    353. 

  353.   </body>
    354. 

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