utils.py 25 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745
  1. # SPDX-License-Identifier: AGPL-3.0-or-later
  2. """Utility functions for the engines
  3. """
  4. import re
  5. import importlib
  6. import importlib.util
  7. import json
  8. import types
  9. from typing import Optional, Union, Any, Set, List, Dict, MutableMapping, Tuple, Callable
  10. from numbers import Number
  11. from os.path import splitext, join
  12. from random import choice
  13. from html.parser import HTMLParser
  14. from html import escape
  15. from urllib.parse import urljoin, urlparse
  16. from markdown_it import MarkdownIt
  17. from lxml import html
  18. from lxml.etree import ElementBase, XPath, XPathError, XPathSyntaxError, _ElementStringResult, _ElementUnicodeResult
  19. from searx import settings
  20. from searx.data import USER_AGENTS, data_dir
  21. from searx.version import VERSION_TAG
  22. from searx.sxng_locales import sxng_locales
  23. from searx.exceptions import SearxXPathSyntaxException, SearxEngineXPathException
  24. from searx import logger
  25. logger = logger.getChild('utils')
  26. XPathSpecType = Union[str, XPath]
  27. _BLOCKED_TAGS = ('script', 'style')
  28. _ECMA_UNESCAPE4_RE = re.compile(r'%u([0-9a-fA-F]{4})', re.UNICODE)
  29. _ECMA_UNESCAPE2_RE = re.compile(r'%([0-9a-fA-F]{2})', re.UNICODE)
  30. _JS_QUOTE_KEYS_RE = re.compile(r'([\{\s,])(\w+)(:)')
  31. _JS_VOID_RE = re.compile(r'void\s+[0-9]+|void\s*\([0-9]+\)')
  32. _JS_DECIMAL_RE = re.compile(r":\s*\.")
  33. _STORAGE_UNIT_VALUE: Dict[str, int] = {
  34. 'TB': 1024 * 1024 * 1024 * 1024,
  35. 'GB': 1024 * 1024 * 1024,
  36. 'MB': 1024 * 1024,
  37. 'TiB': 1000 * 1000 * 1000 * 1000,
  38. 'GiB': 1000 * 1000 * 1000,
  39. 'MiB': 1000 * 1000,
  40. 'KiB': 1000,
  41. }
  42. _XPATH_CACHE: Dict[str, XPath] = {}
  43. _LANG_TO_LC_CACHE: Dict[str, Dict[str, str]] = {}
  44. _FASTTEXT_MODEL: Optional["fasttext.FastText._FastText"] = None # type: ignore
  45. """fasttext model to predict laguage of a search term"""
  46. SEARCH_LANGUAGE_CODES = frozenset([searxng_locale[0].split('-')[0] for searxng_locale in sxng_locales])
  47. """Languages supported by most searxng engines (:py:obj:`searx.sxng_locales.sxng_locales`)."""
  48. class _NotSetClass: # pylint: disable=too-few-public-methods
  49. """Internal class for this module, do not create instance of this class.
  50. Replace the None value, allow explicitly pass None as a function argument"""
  51. _NOTSET = _NotSetClass()
  52. def searx_useragent() -> str:
  53. """Return the searx User Agent"""
  54. return 'searx/{searx_version} {suffix}'.format(
  55. searx_version=VERSION_TAG, suffix=settings['outgoing']['useragent_suffix']
  56. ).strip()
  57. def gen_useragent(os_string: Optional[str] = None) -> str:
  58. """Return a random browser User Agent
  59. See searx/data/useragents.json
  60. """
  61. return USER_AGENTS['ua'].format(os=os_string or choice(USER_AGENTS['os']), version=choice(USER_AGENTS['versions']))
  62. class _HTMLTextExtractorException(Exception):
  63. """Internal exception raised when the HTML is invalid"""
  64. class _HTMLTextExtractor(HTMLParser):
  65. """Internal class to extract text from HTML"""
  66. def __init__(self):
  67. HTMLParser.__init__(self)
  68. self.result = []
  69. self.tags = []
  70. def handle_starttag(self, tag, attrs):
  71. self.tags.append(tag)
  72. if tag == 'br':
  73. self.result.append(' ')
  74. def handle_endtag(self, tag):
  75. if not self.tags:
  76. return
  77. if tag != self.tags[-1]:
  78. raise _HTMLTextExtractorException()
  79. self.tags.pop()
  80. def is_valid_tag(self):
  81. return not self.tags or self.tags[-1] not in _BLOCKED_TAGS
  82. def handle_data(self, data):
  83. if not self.is_valid_tag():
  84. return
  85. self.result.append(data)
  86. def handle_charref(self, name):
  87. if not self.is_valid_tag():
  88. return
  89. if name[0] in ('x', 'X'):
  90. codepoint = int(name[1:], 16)
  91. else:
  92. codepoint = int(name)
  93. self.result.append(chr(codepoint))
  94. def handle_entityref(self, name):
  95. if not self.is_valid_tag():
  96. return
  97. # codepoint = htmlentitydefs.name2codepoint[name]
  98. # self.result.append(chr(codepoint))
  99. self.result.append(name)
  100. def get_text(self):
  101. return ''.join(self.result).strip()
  102. def error(self, message):
  103. # error handle is needed in <py3.10
  104. # https://github.com/python/cpython/pull/8562/files
  105. raise AssertionError(message)
  106. def html_to_text(html_str: str) -> str:
  107. """Extract text from a HTML string
  108. Args:
  109. * html_str (str): string HTML
  110. Returns:
  111. * str: extracted text
  112. Examples:
  113. >>> html_to_text('Example <span id="42">#2</span>')
  114. 'Example #2'
  115. >>> html_to_text('<style>.span { color: red; }</style><span>Example</span>')
  116. 'Example'
  117. >>> html_to_text(r'regexp: (?<![a-zA-Z]')
  118. 'regexp: (?<![a-zA-Z]'
  119. """
  120. html_str = html_str.replace('\n', ' ').replace('\r', ' ')
  121. html_str = ' '.join(html_str.split())
  122. s = _HTMLTextExtractor()
  123. try:
  124. s.feed(html_str)
  125. except AssertionError:
  126. s = _HTMLTextExtractor()
  127. s.feed(escape(html_str, quote=True))
  128. except _HTMLTextExtractorException:
  129. logger.debug("HTMLTextExtractor: invalid HTML\n%s", html_str)
  130. return s.get_text()
  131. def markdown_to_text(markdown_str: str) -> str:
  132. """Extract text from a Markdown string
  133. Args:
  134. * markdown_str (str): string Markdown
  135. Returns:
  136. * str: extracted text
  137. Examples:
  138. >>> markdown_to_text('[example](https://example.com)')
  139. 'example'
  140. >>> markdown_to_text('## Headline')
  141. 'Headline'
  142. """
  143. html_str = (
  144. MarkdownIt("commonmark", {"typographer": True}).enable(["replacements", "smartquotes"]).render(markdown_str)
  145. )
  146. return html_to_text(html_str)
  147. def extract_text(xpath_results, allow_none: bool = False) -> Optional[str]:
  148. """Extract text from a lxml result
  149. * if xpath_results is list, extract the text from each result and concat the list
  150. * if xpath_results is a xml element, extract all the text node from it
  151. ( text_content() method from lxml )
  152. * if xpath_results is a string element, then it's already done
  153. """
  154. if isinstance(xpath_results, list):
  155. # it's list of result : concat everything using recursive call
  156. result = ''
  157. for e in xpath_results:
  158. result = result + (extract_text(e) or '')
  159. return result.strip()
  160. if isinstance(xpath_results, ElementBase):
  161. # it's a element
  162. text: str = html.tostring(xpath_results, encoding='unicode', method='text', with_tail=False)
  163. text = text.strip().replace('\n', ' ')
  164. return ' '.join(text.split())
  165. if isinstance(xpath_results, (_ElementStringResult, _ElementUnicodeResult, str, Number, bool)):
  166. return str(xpath_results)
  167. if xpath_results is None and allow_none:
  168. return None
  169. if xpath_results is None and not allow_none:
  170. raise ValueError('extract_text(None, allow_none=False)')
  171. raise ValueError('unsupported type')
  172. def normalize_url(url: str, base_url: str) -> str:
  173. """Normalize URL: add protocol, join URL with base_url, add trailing slash if there is no path
  174. Args:
  175. * url (str): Relative URL
  176. * base_url (str): Base URL, it must be an absolute URL.
  177. Example:
  178. >>> normalize_url('https://example.com', 'http://example.com/')
  179. 'https://example.com/'
  180. >>> normalize_url('//example.com', 'http://example.com/')
  181. 'http://example.com/'
  182. >>> normalize_url('//example.com', 'https://example.com/')
  183. 'https://example.com/'
  184. >>> normalize_url('/path?a=1', 'https://example.com')
  185. 'https://example.com/path?a=1'
  186. >>> normalize_url('', 'https://example.com')
  187. 'https://example.com/'
  188. >>> normalize_url('/test', '/path')
  189. raise ValueError
  190. Raises:
  191. * lxml.etree.ParserError
  192. Returns:
  193. * str: normalized URL
  194. """
  195. if url.startswith('//'):
  196. # add http or https to this kind of url //example.com/
  197. parsed_search_url = urlparse(base_url)
  198. url = '{0}:{1}'.format(parsed_search_url.scheme or 'http', url)
  199. elif url.startswith('/'):
  200. # fix relative url to the search engine
  201. url = urljoin(base_url, url)
  202. # fix relative urls that fall through the crack
  203. if '://' not in url:
  204. url = urljoin(base_url, url)
  205. parsed_url = urlparse(url)
  206. # add a / at this end of the url if there is no path
  207. if not parsed_url.netloc:
  208. raise ValueError('Cannot parse url')
  209. if not parsed_url.path:
  210. url += '/'
  211. return url
  212. def extract_url(xpath_results, base_url) -> str:
  213. """Extract and normalize URL from lxml Element
  214. Args:
  215. * xpath_results (Union[List[html.HtmlElement], html.HtmlElement]): lxml Element(s)
  216. * base_url (str): Base URL
  217. Example:
  218. >>> def f(s, search_url):
  219. >>> return searx.utils.extract_url(html.fromstring(s), search_url)
  220. >>> f('<span id="42">https://example.com</span>', 'http://example.com/')
  221. 'https://example.com/'
  222. >>> f('https://example.com', 'http://example.com/')
  223. 'https://example.com/'
  224. >>> f('//example.com', 'http://example.com/')
  225. 'http://example.com/'
  226. >>> f('//example.com', 'https://example.com/')
  227. 'https://example.com/'
  228. >>> f('/path?a=1', 'https://example.com')
  229. 'https://example.com/path?a=1'
  230. >>> f('', 'https://example.com')
  231. raise lxml.etree.ParserError
  232. >>> searx.utils.extract_url([], 'https://example.com')
  233. raise ValueError
  234. Raises:
  235. * ValueError
  236. * lxml.etree.ParserError
  237. Returns:
  238. * str: normalized URL
  239. """
  240. if xpath_results == []:
  241. raise ValueError('Empty url resultset')
  242. url = extract_text(xpath_results)
  243. if url:
  244. return normalize_url(url, base_url)
  245. raise ValueError('URL not found')
  246. def dict_subset(dictionary: MutableMapping, properties: Set[str]) -> Dict:
  247. """Extract a subset of a dict
  248. Examples:
  249. >>> dict_subset({'A': 'a', 'B': 'b', 'C': 'c'}, ['A', 'C'])
  250. {'A': 'a', 'C': 'c'}
  251. >>> >> dict_subset({'A': 'a', 'B': 'b', 'C': 'c'}, ['A', 'D'])
  252. {'A': 'a'}
  253. """
  254. return {k: dictionary[k] for k in properties if k in dictionary}
  255. def get_torrent_size(filesize: str, filesize_multiplier: str) -> Optional[int]:
  256. """
  257. Args:
  258. * filesize (str): size
  259. * filesize_multiplier (str): TB, GB, .... TiB, GiB...
  260. Returns:
  261. * int: number of bytes
  262. Example:
  263. >>> get_torrent_size('5', 'GB')
  264. 5368709120
  265. >>> get_torrent_size('3.14', 'MiB')
  266. 3140000
  267. """
  268. try:
  269. multiplier = _STORAGE_UNIT_VALUE.get(filesize_multiplier, 1)
  270. return int(float(filesize) * multiplier)
  271. except ValueError:
  272. return None
  273. def humanize_bytes(size, precision=2):
  274. """Determine the *human readable* value of bytes on 1024 base (1KB=1024B)."""
  275. s = ['B ', 'KB', 'MB', 'GB', 'TB']
  276. x = len(s)
  277. p = 0
  278. while size > 1024 and p < x:
  279. p += 1
  280. size = size / 1024.0
  281. return "%.*f %s" % (precision, size, s[p])
  282. def convert_str_to_int(number_str: str) -> int:
  283. """Convert number_str to int or 0 if number_str is not a number."""
  284. if number_str.isdigit():
  285. return int(number_str)
  286. return 0
  287. def int_or_zero(num: Union[List[str], str]) -> int:
  288. """Convert num to int or 0. num can be either a str or a list.
  289. If num is a list, the first element is converted to int (or return 0 if the list is empty).
  290. If num is a str, see convert_str_to_int
  291. """
  292. if isinstance(num, list):
  293. if len(num) < 1:
  294. return 0
  295. num = num[0]
  296. return convert_str_to_int(num)
  297. def is_valid_lang(lang) -> Optional[Tuple[bool, str, str]]:
  298. """Return language code and name if lang describe a language.
  299. Examples:
  300. >>> is_valid_lang('zz')
  301. None
  302. >>> is_valid_lang('uk')
  303. (True, 'uk', 'ukrainian')
  304. >>> is_valid_lang(b'uk')
  305. (True, 'uk', 'ukrainian')
  306. >>> is_valid_lang('en')
  307. (True, 'en', 'english')
  308. >>> searx.utils.is_valid_lang('Español')
  309. (True, 'es', 'spanish')
  310. >>> searx.utils.is_valid_lang('Spanish')
  311. (True, 'es', 'spanish')
  312. """
  313. if isinstance(lang, bytes):
  314. lang = lang.decode()
  315. is_abbr = len(lang) == 2
  316. lang = lang.lower()
  317. if is_abbr:
  318. for l in sxng_locales:
  319. if l[0][:2] == lang:
  320. return (True, l[0][:2], l[3].lower())
  321. return None
  322. for l in sxng_locales:
  323. if l[1].lower() == lang or l[3].lower() == lang:
  324. return (True, l[0][:2], l[3].lower())
  325. return None
  326. def load_module(filename: str, module_dir: str) -> types.ModuleType:
  327. modname = splitext(filename)[0]
  328. modpath = join(module_dir, filename)
  329. # and https://docs.python.org/3/library/importlib.html#importing-a-source-file-directly
  330. spec = importlib.util.spec_from_file_location(modname, modpath)
  331. if not spec:
  332. raise ValueError(f"Error loading '{modpath}' module")
  333. module = importlib.util.module_from_spec(spec)
  334. if not spec.loader:
  335. raise ValueError(f"Error loading '{modpath}' module")
  336. spec.loader.exec_module(module)
  337. return module
  338. def to_string(obj: Any) -> str:
  339. """Convert obj to its string representation."""
  340. if isinstance(obj, str):
  341. return obj
  342. if hasattr(obj, '__str__'):
  343. return str(obj)
  344. return repr(obj)
  345. def ecma_unescape(string: str) -> str:
  346. """Python implementation of the unescape javascript function
  347. https://www.ecma-international.org/ecma-262/6.0/#sec-unescape-string
  348. https://developer.mozilla.org/fr/docs/Web/JavaScript/Reference/Objets_globaux/unescape
  349. Examples:
  350. >>> ecma_unescape('%u5409')
  351. '吉'
  352. >>> ecma_unescape('%20')
  353. ' '
  354. >>> ecma_unescape('%F3')
  355. 'ó'
  356. """
  357. # "%u5409" becomes "吉"
  358. string = _ECMA_UNESCAPE4_RE.sub(lambda e: chr(int(e.group(1), 16)), string)
  359. # "%20" becomes " ", "%F3" becomes "ó"
  360. string = _ECMA_UNESCAPE2_RE.sub(lambda e: chr(int(e.group(1), 16)), string)
  361. return string
  362. def get_string_replaces_function(replaces: Dict[str, str]) -> Callable[[str], str]:
  363. rep = {re.escape(k): v for k, v in replaces.items()}
  364. pattern = re.compile("|".join(rep.keys()))
  365. def func(text):
  366. return pattern.sub(lambda m: rep[re.escape(m.group(0))], text)
  367. return func
  368. def get_engine_from_settings(name: str) -> Dict:
  369. """Return engine configuration from settings.yml of a given engine name"""
  370. if 'engines' not in settings:
  371. return {}
  372. for engine in settings['engines']:
  373. if 'name' not in engine:
  374. continue
  375. if name == engine['name']:
  376. return engine
  377. return {}
  378. def get_xpath(xpath_spec: XPathSpecType) -> XPath:
  379. """Return cached compiled XPath
  380. There is no thread lock.
  381. Worst case scenario, xpath_str is compiled more than one time.
  382. Args:
  383. * xpath_spec (str|lxml.etree.XPath): XPath as a str or lxml.etree.XPath
  384. Returns:
  385. * result (bool, float, list, str): Results.
  386. Raises:
  387. * TypeError: Raise when xpath_spec is neither a str nor a lxml.etree.XPath
  388. * SearxXPathSyntaxException: Raise when there is a syntax error in the XPath
  389. """
  390. if isinstance(xpath_spec, str):
  391. result = _XPATH_CACHE.get(xpath_spec, None)
  392. if result is None:
  393. try:
  394. result = XPath(xpath_spec)
  395. except XPathSyntaxError as e:
  396. raise SearxXPathSyntaxException(xpath_spec, str(e.msg)) from e
  397. _XPATH_CACHE[xpath_spec] = result
  398. return result
  399. if isinstance(xpath_spec, XPath):
  400. return xpath_spec
  401. raise TypeError('xpath_spec must be either a str or a lxml.etree.XPath')
  402. def eval_xpath(element: ElementBase, xpath_spec: XPathSpecType):
  403. """Equivalent of element.xpath(xpath_str) but compile xpath_str once for all.
  404. See https://lxml.de/xpathxslt.html#xpath-return-values
  405. Args:
  406. * element (ElementBase): [description]
  407. * xpath_spec (str|lxml.etree.XPath): XPath as a str or lxml.etree.XPath
  408. Returns:
  409. * result (bool, float, list, str): Results.
  410. Raises:
  411. * TypeError: Raise when xpath_spec is neither a str nor a lxml.etree.XPath
  412. * SearxXPathSyntaxException: Raise when there is a syntax error in the XPath
  413. * SearxEngineXPathException: Raise when the XPath can't be evaluated.
  414. """
  415. xpath = get_xpath(xpath_spec)
  416. try:
  417. return xpath(element)
  418. except XPathError as e:
  419. arg = ' '.join([str(i) for i in e.args])
  420. raise SearxEngineXPathException(xpath_spec, arg) from e
  421. def eval_xpath_list(element: ElementBase, xpath_spec: XPathSpecType, min_len: Optional[int] = None):
  422. """Same as eval_xpath, check if the result is a list
  423. Args:
  424. * element (ElementBase): [description]
  425. * xpath_spec (str|lxml.etree.XPath): XPath as a str or lxml.etree.XPath
  426. * min_len (int, optional): [description]. Defaults to None.
  427. Raises:
  428. * TypeError: Raise when xpath_spec is neither a str nor a lxml.etree.XPath
  429. * SearxXPathSyntaxException: Raise when there is a syntax error in the XPath
  430. * SearxEngineXPathException: raise if the result is not a list
  431. Returns:
  432. * result (bool, float, list, str): Results.
  433. """
  434. result = eval_xpath(element, xpath_spec)
  435. if not isinstance(result, list):
  436. raise SearxEngineXPathException(xpath_spec, 'the result is not a list')
  437. if min_len is not None and min_len > len(result):
  438. raise SearxEngineXPathException(xpath_spec, 'len(xpath_str) < ' + str(min_len))
  439. return result
  440. def eval_xpath_getindex(elements: ElementBase, xpath_spec: XPathSpecType, index: int, default=_NOTSET):
  441. """Call eval_xpath_list then get one element using the index parameter.
  442. If the index does not exist, either raise an exception is default is not set,
  443. other return the default value (can be None).
  444. Args:
  445. * elements (ElementBase): lxml element to apply the xpath.
  446. * xpath_spec (str|lxml.etree.XPath): XPath as a str or lxml.etree.XPath.
  447. * index (int): index to get
  448. * default (Object, optional): Defaults if index doesn't exist.
  449. Raises:
  450. * TypeError: Raise when xpath_spec is neither a str nor a lxml.etree.XPath
  451. * SearxXPathSyntaxException: Raise when there is a syntax error in the XPath
  452. * SearxEngineXPathException: if the index is not found. Also see eval_xpath.
  453. Returns:
  454. * result (bool, float, list, str): Results.
  455. """
  456. result = eval_xpath_list(elements, xpath_spec)
  457. if -len(result) <= index < len(result):
  458. return result[index]
  459. if default == _NOTSET:
  460. # raise an SearxEngineXPathException instead of IndexError
  461. # to record xpath_spec
  462. raise SearxEngineXPathException(xpath_spec, 'index ' + str(index) + ' not found')
  463. return default
  464. def _get_fasttext_model() -> "fasttext.FastText._FastText": # type: ignore
  465. global _FASTTEXT_MODEL # pylint: disable=global-statement
  466. if _FASTTEXT_MODEL is None:
  467. import fasttext # pylint: disable=import-outside-toplevel
  468. # Monkey patch: prevent fasttext from showing a (useless) warning when loading a model.
  469. fasttext.FastText.eprint = lambda x: None
  470. _FASTTEXT_MODEL = fasttext.load_model(str(data_dir / 'lid.176.ftz'))
  471. return _FASTTEXT_MODEL
  472. def detect_language(text: str, threshold: float = 0.3, only_search_languages: bool = False) -> Optional[str]:
  473. """Detect the language of the ``text`` parameter.
  474. :param str text: The string whose language is to be detected.
  475. :param float threshold: Threshold filters the returned labels by a threshold
  476. on probability. A choice of 0.3 will return labels with at least 0.3
  477. probability.
  478. :param bool only_search_languages: If ``True``, returns only supported
  479. SearXNG search languages. see :py:obj:`searx.languages`
  480. :rtype: str, None
  481. :returns:
  482. The detected language code or ``None``. See below.
  483. :raises ValueError: If ``text`` is not a string.
  484. The language detection is done by using `a fork`_ of the fastText_ library
  485. (`python fasttext`_). fastText_ distributes the `language identification
  486. model`_, for reference:
  487. - `FastText.zip: Compressing text classification models`_
  488. - `Bag of Tricks for Efficient Text Classification`_
  489. The `language identification model`_ support the language codes
  490. (ISO-639-3)::
  491. af als am an ar arz as ast av az azb ba bar bcl be bg bh bn bo bpy br bs
  492. bxr ca cbk ce ceb ckb co cs cv cy da de diq dsb dty dv el eml en eo es
  493. et eu fa fi fr frr fy ga gd gl gn gom gu gv he hi hif hr hsb ht hu hy ia
  494. id ie ilo io is it ja jbo jv ka kk km kn ko krc ku kv kw ky la lb lez li
  495. lmo lo lrc lt lv mai mg mhr min mk ml mn mr mrj ms mt mwl my myv mzn nah
  496. nap nds ne new nl nn no oc or os pa pam pfl pl pms pnb ps pt qu rm ro ru
  497. rue sa sah sc scn sco sd sh si sk sl so sq sr su sv sw ta te tg th tk tl
  498. tr tt tyv ug uk ur uz vec vep vi vls vo wa war wuu xal xmf yi yo yue zh
  499. By using ``only_search_languages=True`` the `language identification model`_
  500. is harmonized with the SearXNG's language (locale) model. General
  501. conditions of SearXNG's locale model are:
  502. a. SearXNG's locale of a query is passed to the
  503. :py:obj:`searx.locales.get_engine_locale` to get a language and/or region
  504. code that is used by an engine.
  505. b. Most of SearXNG's engines do not support all the languages from `language
  506. identification model`_ and there is also a discrepancy in the ISO-639-3
  507. (fasttext) and ISO-639-2 (SearXNG)handling. Further more, in SearXNG the
  508. locales like ``zh-TH`` (``zh-CN``) are mapped to ``zh_Hant``
  509. (``zh_Hans``) while the `language identification model`_ reduce both to
  510. ``zh``.
  511. .. _a fork: https://github.com/searxng/fasttext-predict
  512. .. _fastText: https://fasttext.cc/
  513. .. _python fasttext: https://pypi.org/project/fasttext/
  514. .. _language identification model: https://fasttext.cc/docs/en/language-identification.html
  515. .. _Bag of Tricks for Efficient Text Classification: https://arxiv.org/abs/1607.01759
  516. .. _`FastText.zip: Compressing text classification models`: https://arxiv.org/abs/1612.03651
  517. """
  518. if not isinstance(text, str):
  519. raise ValueError('text must a str')
  520. r = _get_fasttext_model().predict(text.replace('\n', ' '), k=1, threshold=threshold)
  521. if isinstance(r, tuple) and len(r) == 2 and len(r[0]) > 0 and len(r[1]) > 0:
  522. language = r[0][0].split('__label__')[1]
  523. if only_search_languages and language not in SEARCH_LANGUAGE_CODES:
  524. return None
  525. return language
  526. return None
  527. def js_variable_to_python(js_variable):
  528. """Convert a javascript variable into JSON and then load the value
  529. It does not deal with all cases, but it is good enough for now.
  530. chompjs has a better implementation.
  531. """
  532. # when in_string is not None, it contains the character that has opened the string
  533. # either simple quote or double quote
  534. in_string = None
  535. # cut the string:
  536. # r"""{ a:"f\"irst", c:'sec"ond'}"""
  537. # becomes
  538. # ['{ a:', '"', 'f\\', '"', 'irst', '"', ', c:', "'", 'sec', '"', 'ond', "'", '}']
  539. parts = re.split(r'(["\'])', js_variable)
  540. # previous part (to check the escape character antislash)
  541. previous_p = ""
  542. for i, p in enumerate(parts):
  543. # parse characters inside a ECMA string
  544. if in_string:
  545. # we are in a JS string: replace the colon by a temporary character
  546. # so quote_keys_regex doesn't have to deal with colon inside the JS strings
  547. parts[i] = parts[i].replace(':', chr(1))
  548. if in_string == "'":
  549. # the JS string is delimited by simple quote.
  550. # This is not supported by JSON.
  551. # simple quote delimited string are converted to double quote delimited string
  552. # here, inside a JS string, we escape the double quote
  553. parts[i] = parts[i].replace('"', r'\"')
  554. # deal with delimiters and escape character
  555. if not in_string and p in ('"', "'"):
  556. # we are not in string
  557. # but p is double or simple quote
  558. # that's the start of a new string
  559. # replace simple quote by double quote
  560. # (JSON doesn't support simple quote)
  561. parts[i] = '"'
  562. in_string = p
  563. continue
  564. if p == in_string:
  565. # we are in a string and the current part MAY close the string
  566. if len(previous_p) > 0 and previous_p[-1] == '\\':
  567. # there is an antislash just before: the ECMA string continue
  568. continue
  569. # the current p close the string
  570. # replace simple quote by double quote
  571. parts[i] = '"'
  572. in_string = None
  573. if not in_string:
  574. # replace void 0 by null
  575. # https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/void
  576. # we are sure there is no string in p
  577. parts[i] = _JS_VOID_RE.sub("null", p)
  578. # update previous_p
  579. previous_p = p
  580. # join the string
  581. s = ''.join(parts)
  582. # add quote around the key
  583. # { a: 12 }
  584. # becomes
  585. # { "a": 12 }
  586. s = _JS_QUOTE_KEYS_RE.sub(r'\1"\2"\3', s)
  587. s = _JS_DECIMAL_RE.sub(":0.", s)
  588. # replace the surogate character by colon
  589. s = s.replace(chr(1), ':')
  590. # load the JSON and return the result
  591. return json.loads(s)