searx.engines.annas_archive Namespace Reference

Functions
	init (engine_settings=None)
Dict[str, Any]	request (query, Dict[str, Any] params)
List[Dict[str, Optional[str]]]	response (resp)
	_get_result (item)
	fetch_traits (EngineTraits engine_traits)

Variables
dict	about
list	categories = ["files"]
bool	paging = False
str	base_url = "https://annas-archive.org"
str	aa_content = ""
str	aa_sort = ''
str	aa_ext = ''

Detailed Description

`Anna's Archive`_ is a free non-profit online shadow library metasearch
engine providing access to a variety of book resources (also via IPFS), created
by a team of anonymous archivists (AnnaArchivist_).

.. _Anna's Archive: https://annas-archive.org/
.. _AnnaArchivist: https://annas-software.org/AnnaArchivist/annas-archive

Configuration
=============

The engine has the following additional settings:

- :py:obj:`aa_content`
- :py:obj:`aa_ext`
- :py:obj:`aa_sort`

With this options a SearXNG maintainer is able to configure **additional**
engines for specific searches in Anna's Archive.  For example a engine to search
for *newest* articles and journals (PDF) / by shortcut ``!aaa <search-term>``.

.. code:: yaml

  - name: annas articles
    engine: annas_archive
    shortcut: aaa
    aa_content: 'magazine'
    aa_ext: 'pdf'
    aa_sort: 'newest'

Implementations
===============

Function Documentation

_get_result()

searx.engines.annas_archive._get_result ( item )

protected

Definition at line 128 of file annas_archive.py.

def _get_result(item):
    return {
        'template': 'paper.html',
        'url': base_url + item.xpath('./@href')[0],
        'title': extract_text(eval_xpath(item, './/h3/text()[1]')),
        'publisher': extract_text(eval_xpath(item, './/div[contains(@class, "text-sm")]')),
        'authors': [extract_text(eval_xpath(item, './/div[contains(@class, "italic")]'))],
        'content': extract_text(eval_xpath(item, './/div[contains(@class, "text-xs")]')),
        'img_src': item.xpath('.//img/@src')[0],
    }
 
 

Referenced by searx.engines.annas_archive.response().

Here is the caller graph for this function:

fetch_traits()

searx.engines.annas_archive.fetch_traits

(

EngineTraits

engine_traits

)

Fetch languages and other search arguments from Anna's search form.

Definition at line 140 of file annas_archive.py.

def fetch_traits(engine_traits: EngineTraits):
    """Fetch languages and other search arguments from Anna's search form."""
    # pylint: disable=import-outside-toplevel
 
    import babel
    from searx.network import get  # see https://github.com/searxng/searxng/issues/762
    from searx.locales import language_tag
 
    engine_traits.all_locale = ''
    engine_traits.custom['content'] = []
    engine_traits.custom['ext'] = []
    engine_traits.custom['sort'] = []
 
    resp = get(base_url + '/search')
    if not resp.ok:  # type: ignore
        raise RuntimeError("Response from Anna's search page is not OK.")
    dom = html.fromstring(resp.text)  # type: ignore
 
    # supported language codes
 
    lang_map = {}
    for x in eval_xpath_list(dom, "//form//input[@name='lang']"):
        eng_lang = x.get("value")
        if eng_lang in ('', '_empty', 'nl-BE', 'und'):
            continue
        try:
            locale = babel.Locale.parse(lang_map.get(eng_lang, eng_lang), sep='-')
        except babel.UnknownLocaleError:
            # silently ignore unknown languages
            # print("ERROR: %s -> %s is unknown by babel" % (x.get("data-name"), eng_lang))
            continue
        sxng_lang = language_tag(locale)
        conflict = engine_traits.languages.get(sxng_lang)
        if conflict:
            if conflict != eng_lang:
                print("CONFLICT: babel %s --> %s, %s" % (sxng_lang, conflict, eng_lang))
            continue
        engine_traits.languages[sxng_lang] = eng_lang
 
    for x in eval_xpath_list(dom, "//form//input[@name='content']"):
        engine_traits.custom['content'].append(x.get("value"))
 
    for x in eval_xpath_list(dom, "//form//input[@name='ext']"):
        engine_traits.custom['ext'].append(x.get("value"))
 
    for x in eval_xpath_list(dom, "//form//select[@name='sort']//option"):
        engine_traits.custom['sort'].append(x.get("value"))

init()

searx.engines.annas_archive.init

(

engine_settings = None

)

Check of engine's settings.

Definition at line 87 of file annas_archive.py.

def init(engine_settings=None):  # pylint: disable=unused-argument
    """Check of engine's settings."""
    traits = EngineTraits(**ENGINE_TRAITS['annas archive'])
 
    if aa_content and aa_content not in traits.custom['content']:
        raise ValueError(f'invalid setting content: {aa_content}')
 
    if aa_sort and aa_sort not in traits.custom['sort']:
        raise ValueError(f'invalid setting sort: {aa_sort}')
 
    if aa_ext and aa_ext not in traits.custom['ext']:
        raise ValueError(f'invalid setting ext: {aa_ext}')
 
 

request()

Dict[str, Any] searx.engines.annas_archive.request	(		query,
		Dict[str, Any]	params )

Definition at line 101 of file annas_archive.py.

def request(query, params: Dict[str, Any]) -> Dict[str, Any]:
    q = quote(query)
    lang = traits.get_language(params["language"], traits.all_locale)  # type: ignore
    params["url"] = base_url + f"/search?lang={lang or ''}&content={aa_content}&ext={aa_ext}&sort={aa_sort}&q={q}"
    return params
 
 

response()

List[Dict[str, Optional[str]]] searx.engines.annas_archive.response

(

resp

)

Definition at line 108 of file annas_archive.py.

def response(resp) -> List[Dict[str, Optional[str]]]:
    results: List[Dict[str, Optional[str]]] = []
    dom = html.fromstring(resp.text)
 
    for item in eval_xpath_list(dom, '//main//div[contains(@class, "h-[125]")]/a'):
        results.append(_get_result(item))
 
    # The rendering of the WEB page is very strange; except the first position
    # all other positions of Anna's result page are enclosed in SGML comments.
    # These comments are *uncommented* by some JS code, see query of class
    # '.js-scroll-hidden' in Anna's HTML template:
    #   https://annas-software.org/AnnaArchivist/annas-archive/-/blob/main/allthethings/templates/macros/md5_list.html
 
    for item in eval_xpath_list(dom, '//main//div[contains(@class, "js-scroll-hidden")]'):
        item = html.fromstring(item.xpath('./comment()')[0].text)
        results.append(_get_result(item))
 
    return results
 
 

References searx.engines.annas_archive._get_result().

Here is the call graph for this function:

Variable Documentation

aa_content

str searx.engines.annas_archive.aa_content = ""

Definition at line 60 of file annas_archive.py.

aa_ext

str searx.engines.annas_archive.aa_ext = ''

Definition at line 75 of file annas_archive.py.

aa_sort

str searx.engines.annas_archive.aa_sort = ''

Definition at line 68 of file annas_archive.py.

about

dict searx.engines.annas_archive.about

Initial value:

=  {
    "website": "https://annas-archive.org/",
    "wikidata_id": "Q115288326",
    "official_api_documentation": None,
    "use_official_api": False,
    "require_api_key": False,
    "results": "HTML",
}

Definition at line 45 of file annas_archive.py.

base_url

str searx.engines.annas_archive.base_url = "https://annas-archive.org"

Definition at line 59 of file annas_archive.py.

categories

list searx.engines.annas_archive.categories = ["files"]

Definition at line 55 of file annas_archive.py.

paging

bool searx.engines.annas_archive.paging = False

Definition at line 56 of file annas_archive.py.