From 1157462ff9fc08504297e259356ccbefb339965f Mon Sep 17 00:00:00 2001 From: Alexandre Flament Date: Sun, 13 Mar 2022 22:15:27 +0100 Subject: Various change on PR 930 --- searx/info/en/about.md | 75 ------------------------------- searx/info/en/search-syntax.md | 35 --------------- searx/infopage/__init__.py | 92 +++++++++++++++++--------------------- searx/infopage/en/about.md | 75 +++++++++++++++++++++++++++++++ searx/infopage/en/search-syntax.md | 35 +++++++++++++++ searx/templates/oscar/info.html | 6 +-- searx/templates/oscar/navbar.html | 2 +- searx/templates/simple/base.html | 2 +- searx/templates/simple/info.html | 4 +- searx/webapp.py | 22 ++++++--- searxng_extra/docs_prebuild | 39 ++++++++-------- 11 files changed, 192 insertions(+), 195 deletions(-) delete mode 100644 searx/info/en/about.md delete mode 100644 searx/info/en/search-syntax.md create mode 100644 searx/infopage/en/about.md create mode 100644 searx/infopage/en/search-syntax.md diff --git a/searx/info/en/about.md b/searx/info/en/about.md deleted file mode 100644 index 9f323870e..000000000 --- a/searx/info/en/about.md +++ /dev/null @@ -1,75 +0,0 @@ -# About SearXNG - -SearXNG is a fork from the well-known [searx] [metasearch engine], aggregating -the results of other {{link('search engines', 'preferences')}} while not -storing information about its users. - -More about SearXNG ... - -* [SearXNG sources]({{GIT_URL}}) -* [weblate] - - -## Why use it? - -* SearXNG may not offer you as personalised results as Google, but it doesn't - generate a profile about you. - -* SearXNG doesn't care about what you search for, never shares anything with a - third party, and it can't be used to compromise you. - -* SearXNG is free software, the code is 100% open and you can help to make it - better. See more on [SearXNG sources]({{GIT_URL}}). - -If you do care about privacy, want to be a conscious user, or otherwise believe -in digital freedom, make SearXNG your default search engine or run it on your -own server - -## Technical details - How does it work? - -SearXNG is a [metasearch engine], inspired by the [seeks project]. It provides -basic privacy by mixing your queries with searches on other platforms without -storing search data. Queries are made using a POST request on every browser -(except Chromium-based browsers*). Therefore they show up in neither our logs, -nor your url history. In the case of Chromium-based browser users there is an -exception: searx uses the search bar to perform GET requests. SearXNG can be -added to your browser's search bar; moreover, it can be set as the default -search engine. - -## How to set as the default search engine? - -SearXNG supports [OpenSearch]. For more information on changing your default -search engine, see your browser's documentation: - -* [Firefox] -* [Microsoft Edge] -* Chromium-based browsers [only add websites that the user navigates to without - a path.](https://www.chromium.org/tab-to-search) - -## Where to find anonymous usage statistics of this instance ? - -{{link('Stats page', 'stats')}} contains some useful data about the engines -used. - -## How can I make it my own? - -SearXNG appreciates your concern regarding logs, so take the code from the -[SearXNG project]({{GIT_URL}}) and run it yourself! - -Add your instance to this [list of public -instances]({{get_setting('brand.public_instances')}}) to help other people -reclaim their privacy and make the Internet freer! The more decentralized the -Internet is, the more freedom we have! - -## Where are the docs & code of this instance? - -See the [SearXNG docs]({{get_setting('brand.docs_url')}}) and [SearXNG -sources]({{GIT_URL}}) - -[searx]: https://github.com/searx/searx -[metasearch engine]: https://en.wikipedia.org/wiki/Metasearch_engine -[weblate]: https://weblate.bubu1.eu/projects/searxng/ -[seeks project]: https://beniz.github.io/seeks/ -[OpenSearch]: https://github.com/dewitt/opensearch/blob/master/opensearch-1-1-draft-6.md -[Firefox]: https://support.mozilla.org/en-US/kb/add-or-remove-search-engine-firefox -[Microsoft Edge]: https://support.microsoft.com/en-us/help/4028574/microsoft-edge-change-the-default-search-engine diff --git a/searx/info/en/search-syntax.md b/searx/info/en/search-syntax.md deleted file mode 100644 index ae820dfbc..000000000 --- a/searx/info/en/search-syntax.md +++ /dev/null @@ -1,35 +0,0 @@ -# Search syntax - -SearXNG allows you to modify the default categories, engines and search language -via the search query. - -Prefix `!` to set category and engine names. - -Prefix: `:` to set the language. - -Abbrevations of the engines and languages are also accepted. Engine/category -modifiers are chainable and inclusive. E.g. with {{search('!map !ddg !wp paris')}} -search in map category **and** duckduckgo **and** wikipedia for -`paris`. - -See the {{link('preferences', 'preferences')}} for the list of engines, -categories and languages. - -## Examples - -Search in wikipedia for `paris`: - -* {{search('!wp paris')}} -* {{search('!wikipedia paris')}} - -Search in category `map` for `paris`: - -* {{search('!map paris')}} - -Image search: - -* {{search('!images Wau Holland')}} - -Custom language in wikipedia: - -* {{search(':fr !wp Wau Holland')}} diff --git a/searx/infopage/__init__.py b/searx/infopage/__init__.py index 5c58193c1..9b181ad60 100644 --- a/searx/infopage/__init__.py +++ b/searx/infopage/__init__.py @@ -19,8 +19,9 @@ Usage in a Flask app route: """ -__all__ = ['InfoPage', 'MistletoePage', 'InfoPageSet'] +__all__ = ['InfoPage', 'InfoPageSet'] +import os import os.path import logging import typing @@ -33,16 +34,18 @@ import mistletoe from .. import get_setting from ..compat import cached_property from ..version import GIT_URL +from ..locales import LOCALE_NAMES -logger = logging.getLogger('doc') + +logger = logging.getLogger('searx.infopage') +_INFO_FOLDER = os.path.abspath(os.path.dirname(__file__)) class InfoPage: """A page of the :py:obj:`online documentation `.""" - def __init__(self, fname, base_url=None): + def __init__(self, fname): self.fname = fname - self.base_url = base_url @cached_property def raw_content(self): @@ -66,19 +69,25 @@ class InfoPage: t = l.strip('# ') return t + @cached_property + def html(self): + """Render Markdown (CommonMark_) to HTML by using mistletoe_. + + .. _CommonMark: https://commonmark.org/ + .. _mistletoe: https://github.com/miyuchina/mistletoe + + """ + return mistletoe.markdown(self.content) + def get_ctx(self): # pylint: disable=no-self-use """Jinja context to render :py:obj:`InfoPage.content`""" def _md_link(name, url): - url = url_for(url) - if self.base_url: - url = self.base_url + url + url = url_for(url, _external=True) return "[%s](%s)" % (name, url) def _md_search(query): - url = '%s?q=%s' % (url_for('search'), urllib.parse.quote(query)) - if self.base_url: - url = self.base_url + url + url = '%s?q=%s' % (url_for('search', _external=True), urllib.parse.quote(query)) return '[%s](%s)' % (query, url) ctx = {} @@ -89,33 +98,8 @@ class InfoPage: return ctx - def render(self): - """Render / return content""" - return self.content - - -class MistletoePage(InfoPage): - """A HTML page of the :py:obj:`online documentation `.""" - - def __init__(self, *args, **kwargs): - super().__init__(*args, **kwargs) - - @cached_property - def html(self): - """HTML representation of this page""" - return self.render() - - def render(self): - """Render Markdown (CommonMark_) to HTML by using mistletoe_. - - .. _CommonMark: https://commonmark.org/ - .. _mistletoe: https://github.com/miyuchina/mistletoe - - """ - return mistletoe.markdown(self.content) - - -_INFO_FOLDER = os.path.abspath(os.path.join(os.path.dirname(__file__), '..', 'info')) + def __repr__(self): + return f'<{self.__class__.__name__} fname={self.fname!r}>' class InfoPageSet: # pylint: disable=too-few-public-methods @@ -123,24 +107,26 @@ class InfoPageSet: # pylint: disable=too-few-public-methods :param page_class: render online documentation by :py:obj:`InfoPage` parser. :type page_class: :py:obj:`InfoPage` + + :param info_folder: information directory + :type info_folder: str """ - def __init__(self, page_class: typing.Type[InfoPage], base_url=None): - self.page_class = page_class - self.base_url = base_url - self.CACHE: typing.Dict[tuple, InfoPage] = {} + def __init__( + self, page_class: typing.Optional[typing.Type[InfoPage]] = None, info_folder: typing.Optional[str] = None + ): + self.page_class = page_class or InfoPage + self.CACHE: typing.Dict[tuple, typing.Optional[InfoPage]] = {} # future: could be set from settings.xml - self.folder: str = _INFO_FOLDER + self.folder: str = info_folder or _INFO_FOLDER """location of the Markdwon files""" - self.i18n_origin: str = 'en' + self.locale_default: str = 'en' """default language""" - self.l10n: typing.List = [ - 'en', - ] + self.locales: typing.List = [locale for locale in os.listdir(_INFO_FOLDER) if locale in LOCALE_NAMES] """list of supported languages (aka locales)""" self.toc: typing.List = [ @@ -160,12 +146,13 @@ class InfoPageSet: # pylint: disable=too-few-public-methods :type locale: str """ + locale = locale or self.locale_default + if pagename not in self.toc: return None - if locale is not None and locale not in self.l10n: + if locale not in self.locales: return None - locale = locale or self.i18n_origin cache_key = (pagename, locale) page = self.CACHE.get(cache_key) @@ -176,16 +163,17 @@ class InfoPageSet: # pylint: disable=too-few-public-methods fname = os.path.join(self.folder, locale, pagename) + '.md' if not os.path.exists(fname): - logger.error('file %s does not exists', fname) + logger.info('file %s does not exists', fname) + self.CACHE[cache_key] = None return None - page = self.page_class(fname, self.base_url) + page = self.page_class(fname) self.CACHE[cache_key] = page return page def all_pages(self, locale: typing.Optional[str] = None): - """Iterate over all pages""" - locale = locale or self.i18n_origin + """Iterate over all pages of the TOC""" + locale = locale or self.locale_default for pagename in self.toc: page = self.get_page(pagename, locale) yield pagename, page diff --git a/searx/infopage/en/about.md b/searx/infopage/en/about.md new file mode 100644 index 000000000..9f323870e --- /dev/null +++ b/searx/infopage/en/about.md @@ -0,0 +1,75 @@ +# About SearXNG + +SearXNG is a fork from the well-known [searx] [metasearch engine], aggregating +the results of other {{link('search engines', 'preferences')}} while not +storing information about its users. + +More about SearXNG ... + +* [SearXNG sources]({{GIT_URL}}) +* [weblate] + + +## Why use it? + +* SearXNG may not offer you as personalised results as Google, but it doesn't + generate a profile about you. + +* SearXNG doesn't care about what you search for, never shares anything with a + third party, and it can't be used to compromise you. + +* SearXNG is free software, the code is 100% open and you can help to make it + better. See more on [SearXNG sources]({{GIT_URL}}). + +If you do care about privacy, want to be a conscious user, or otherwise believe +in digital freedom, make SearXNG your default search engine or run it on your +own server + +## Technical details - How does it work? + +SearXNG is a [metasearch engine], inspired by the [seeks project]. It provides +basic privacy by mixing your queries with searches on other platforms without +storing search data. Queries are made using a POST request on every browser +(except Chromium-based browsers*). Therefore they show up in neither our logs, +nor your url history. In the case of Chromium-based browser users there is an +exception: searx uses the search bar to perform GET requests. SearXNG can be +added to your browser's search bar; moreover, it can be set as the default +search engine. + +## How to set as the default search engine? + +SearXNG supports [OpenSearch]. For more information on changing your default +search engine, see your browser's documentation: + +* [Firefox] +* [Microsoft Edge] +* Chromium-based browsers [only add websites that the user navigates to without + a path.](https://www.chromium.org/tab-to-search) + +## Where to find anonymous usage statistics of this instance ? + +{{link('Stats page', 'stats')}} contains some useful data about the engines +used. + +## How can I make it my own? + +SearXNG appreciates your concern regarding logs, so take the code from the +[SearXNG project]({{GIT_URL}}) and run it yourself! + +Add your instance to this [list of public +instances]({{get_setting('brand.public_instances')}}) to help other people +reclaim their privacy and make the Internet freer! The more decentralized the +Internet is, the more freedom we have! + +## Where are the docs & code of this instance? + +See the [SearXNG docs]({{get_setting('brand.docs_url')}}) and [SearXNG +sources]({{GIT_URL}}) + +[searx]: https://github.com/searx/searx +[metasearch engine]: https://en.wikipedia.org/wiki/Metasearch_engine +[weblate]: https://weblate.bubu1.eu/projects/searxng/ +[seeks project]: https://beniz.github.io/seeks/ +[OpenSearch]: https://github.com/dewitt/opensearch/blob/master/opensearch-1-1-draft-6.md +[Firefox]: https://support.mozilla.org/en-US/kb/add-or-remove-search-engine-firefox +[Microsoft Edge]: https://support.microsoft.com/en-us/help/4028574/microsoft-edge-change-the-default-search-engine diff --git a/searx/infopage/en/search-syntax.md b/searx/infopage/en/search-syntax.md new file mode 100644 index 000000000..ae820dfbc --- /dev/null +++ b/searx/infopage/en/search-syntax.md @@ -0,0 +1,35 @@ +# Search syntax + +SearXNG allows you to modify the default categories, engines and search language +via the search query. + +Prefix `!` to set category and engine names. + +Prefix: `:` to set the language. + +Abbrevations of the engines and languages are also accepted. Engine/category +modifiers are chainable and inclusive. E.g. with {{search('!map !ddg !wp paris')}} +search in map category **and** duckduckgo **and** wikipedia for +`paris`. + +See the {{link('preferences', 'preferences')}} for the list of engines, +categories and languages. + +## Examples + +Search in wikipedia for `paris`: + +* {{search('!wp paris')}} +* {{search('!wikipedia paris')}} + +Search in category `map` for `paris`: + +* {{search('!map paris')}} + +Image search: + +* {{search('!images Wau Holland')}} + +Custom language in wikipedia: + +* {{search(':fr !wp Wau Holland')}} diff --git a/searx/templates/oscar/info.html b/searx/templates/oscar/info.html index 3a696da50..0c2044adb 100644 --- a/searx/templates/oscar/info.html +++ b/searx/templates/oscar/info.html @@ -2,9 +2,9 @@ {% block title %}{{ active_page.title }} - {% endblock %} {% block content %}
    -{% for pagename, page in all_pages('en') %} -
  • - {{page.title}} + {% for pagename, page, locale in all_pages %} +
  • + {{page.title}}
    • {% endfor %}
diff --git a/searx/templates/oscar/navbar.html b/searx/templates/oscar/navbar.html index 4c0ec0068..f5401c382 100644 --- a/searx/templates/oscar/navbar.html +++ b/searx/templates/oscar/navbar.html @@ -3,7 +3,7 @@ {{ instance_name }}{{- "" -}} {{- "" -}} {{- "" -}} - {{ _('about') }}{{- "" -}} + {{ _('about') }}{{- "" -}} {{ _('preferences') }}{{- "" -}} {{- "" -}} diff --git a/searx/templates/simple/base.html b/searx/templates/simple/base.html index 135a95669..a82c26a61 100644 --- a/searx/templates/simple/base.html +++ b/searx/templates/simple/base.html @@ -58,7 +58,7 @@