Classes
class	SXNGPlugin

Functions
bool\|str	filter_url_field ("Result\|LegacyResult" result, str field_name, str url_src)
	extract_doi (url)
str	get_doi_resolver ()

Variables
list	ahmia_blacklist = []
	regex = re.compile(r'10\.\d{4,9}/[^\s]+')

Function Documentation

◆ extract_doi()

searx.plugins.oa_doi_rewrite.extract_doi ( url )

Definition at line 73 of file oa_doi_rewrite.py.

def extract_doi(url):
    m = regex.search(url.path)
    if m:
        return m.group(0)
    for _, v in parse_qsl(url.query):
        m = regex.search(v)
        if m:
            return m.group(0)
    return None
 
 

Referenced by filter_url_field().

Here is the caller graph for this function:

◆ filter_url_field()

bool \| str searx.plugins.oa_doi_rewrite.filter_url_field	(	"Result\|LegacyResult"	result,
		str	field_name,
		str	url_src )

Returns bool ``True`` to use URL unchanged (``False`` to ignore URL).
If URL should be modified, the returned string is the new URL to use.

Definition at line 25 of file oa_doi_rewrite.py.

def filter_url_field(result: "Result|LegacyResult", field_name: str, url_src: str) -> bool | str:
    """Returns bool ``True`` to use URL unchanged (``False`` to ignore URL).
    If URL should be modified, the returned string is the new URL to use."""
 
    if field_name != "url":
        return True  # use it unchanged
 
    doi = extract_doi(result.parsed_url)
    if doi and len(doi) < 50:
        for suffix in ("/", ".pdf", ".xml", "/full", "/meta", "/abstract"):
            doi = doi.removesuffix(suffix)
        new_url = get_doi_resolver() + doi
        if "doi" not in result:
            result["doi"] = doi
        log.debug("oa_doi_rewrite: [URL field: %s] %s -> %s", field_name, url_src, new_url)
        return new_url  # use new url
 
    return True  # use it unchanged
 
 

References extract_doi(), and get_doi_resolver().

Here is the call graph for this function:

◆ get_doi_resolver()

str searx.plugins.oa_doi_rewrite.get_doi_resolver ( )

Definition at line 84 of file oa_doi_rewrite.py.

def get_doi_resolver() -> str:
    doi_resolvers = get_setting("doi_resolvers")
    selected_resolver = sxng_request.preferences.get_value('doi_resolver')[0]
    if selected_resolver not in doi_resolvers:
        selected_resolver = get_setting("default_doi_resolver")
    return doi_resolvers[selected_resolver]

References searx.get_setting().

Referenced by filter_url_field().

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

◆ ahmia_blacklist

list searx.plugins.oa_doi_rewrite.ahmia_blacklist = []

Definition at line 22 of file oa_doi_rewrite.py.

◆ regex

searx.plugins.oa_doi_rewrite.regex = re.compile(r'10\.\d{4,9}/[^\s]+')

Definition at line 70 of file oa_doi_rewrite.py.

Classes

Functions