freedombone/src/freedombone-app-searx

#!/bin/bash
#
# .---.                  .              .
# |                      |              |
# |--- .--. .-.  .-.  .-.|  .-. .--.--. |.-.  .-. .--.  .-.
# |    |   (.-' (.-' (   | (   )|  |  | |   )(   )|  | (.-'
# '    '     --'  --'  -' -  -' '  '   -' -'   -' '   -  --'
#
#                    Freedom in the Cloud
#
# Searx engine application
#
# License
# =======
#
# Copyright (C) 2014-2017 Bob Mottram <bob@freedombone.net>
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU Affero General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU Affero General Public License for more details.
#
# You should have received a copy of the GNU Affero General Public License
# along with this program.  If not, see <http://www.gnu.org/licenses/>.

VARIANTS='full full-vim'

IN_DEFAULT_INSTALL=0
SHOW_ON_ABOUT=1
SHOW_ICANN_ADDRESS_ON_ABOUT=0

SEARX_REPO="https://github.com/asciimoo/searx"
SEARX_COMMIT='80460be8f69cea5f15c9d5ddbb63e4e48fde2dd0'
SEARX_PATH=/etc
SEARX_ONION_PORT=8094
SEARX_ONION_HOSTNAME=
SEARX_LOGIN_TEXT=$"Search engine login"
SEARX_PASSWORD=
SEARX_BACKGROUND_IMAGE_URL=

searx_variables=(SEARX_LOGIN_TEXT
                 MY_USERNAME
                 SEARX_BACKGROUND_IMAGE_URL
                 SYSTEM_TYPE)

function logging_on_searx {
    echo -n ''
}

function logging_off_searx {
    echo -n ''
}

function searx_set_default_background {
    if [ -f ~/freedombone/img/backgrounds/searx.jpg ]; then
        cp ~/freedombone/img/backgrounds/searx.jpg /etc/searx/searx/static/themes/courgette/img/bg-body-index.jpg
        chown -R searx:searx ${SEARX_PATH}/searx
    else
        if [ -f /home/$MY_USERNAME/freedombone/img/backgrounds/searx.jpg ]; then
            cp /home/$MY_USERNAME/freedombone/img/backgrounds/searx.jpg /etc/searx/searx/static/themes/courgette/img/bg-body-index.jpg
            chown -R searx:searx ${SEARX_PATH}/searx
        fi
    fi

    # remove the github ribbon icon
    if [ -f /etc/searx/searx/static/themes/courgette/img/github_ribbon.png ]; then
        mv /etc/searx/searx/static/themes/courgette/img/github_ribbon.png /etc/searx/searx/static/themes/courgette/img/github_ribbon.png.old
    fi
}

function searx_set_background_image_from_url {
    url="$1"

    ext=
    if [ ${#url} -gt 0 ]; then
        if [[ "$url" == *".jpeg" || "$url" == *".jpg" ]]; then
            ext="jpg"
        fi
        if [[ "$url" == *".png" ]]; then
            ext="png"
        fi
        if [[ "$url" == *".gif" ]]; then
            ext="gif"
        fi
    fi

    if [ ${#ext} -gt 0 ]; then
        if [ -d /etc/searx/searx/static/themes/courgette/img ]; then
            cd /etc/searx/searx/static/themes/courgette/img


            # remove any existing image
            if [ -f bg-body-index.jpg ]; then
                rm bg-body-index.jpg
            fi

            # get the new image
            if [[ "$ext" != 'jpg' ]]; then
                if [ -f bg-body-index.${ext} ]; then
                    rm bg-body-index.${ext}
                fi
                wget "$url" -O bg-body-index.${ext}
                convert bg-body-index.${ext} bg-body-index.jpg
            else
                wget "$url" -O bg-body-index.jpg
            fi
            if [ ! -f bg-body-index.jpg ]; then
                echo "$url"
                echo $'Custom background image for SearX could not be downloaded'
                echo "1"
                return
            fi
            chown -R searx:searx ${SEARX_PATH}/searx
        fi
    else
        echo "2"
        return
    fi

    echo "0"
}

function searx_set_background_image {
    data=$(tempfile 2>/dev/null)
    trap "rm -f $data" 0 1 2 5 15
    dialog --title $"SearX Metasearch" \
           --backtitle $"Freedombone Control Panel" \
           --inputbox $'Set a background image URL' 10 60 2>$data
    sel=$?
    case $sel in
        0)
            temp_background=$(<$data)
            if [ ${#temp_background} -gt 0 ]; then
                SEARX_BACKGROUND_IMAGE_URL="$temp_background"
                write_config_param "SEARX_BACKGROUND_IMAGE_URL" "$SEARX_BACKGROUND_IMAGE_URL"
                if [[ $(searx_set_background_image_from_url "$SEARX_BACKGROUND_IMAGE_URL" | tail -n 1) == "0" ]]; then
                    dialog --title $"Set SearX background" \
                           --msgbox $"The background image has been set" 6 60
                fi
            fi
           ;;
    esac
}

function searx_enable_login {
    dialog --title $"Enable Searx login" \
           --backtitle $"Freedombone Control Panel" \
           --defaultno \
           --yesno $"\nDo you want to add a login so that random web users can't use your metasearch engine?" 10 60
    sel=$?
    case $sel in
        0) if grep -q '#auth_basic' /etc/nginx/sites-available/searx; then
               sed -i 's|#auth_basic|auth_basic|g' /etc/nginx/sites-available/searx
               systemctl restart nginx
           fi
           read_config_param $MY_USERNAME
           SEARX_LOGIN_PASS=$(${PROJECT_NAME}-pass -u $MY_USERNAME -a searx)
           dialog --title $"Enable Searx login" \
                  --msgbox $"Searx logins are now enabled with the password $SEARX_LOGIN_PASS" 6 65
           SEARX_LOGIN_PASS=
           ;;
        1) if ! grep -q '#auth_basic' /etc/nginx/sites-available/searx; then
               sed -i 's|auth_basic|#auth_basic|g' /etc/nginx/sites-available/searx
               systemctl restart nginx
           fi
           dialog --title $"Disable Searx login" \
                  --msgbox $"Searx logins are now disabled. Anyone can access your metasearch engine." 6 65
           ;;
    esac
}

function configure_interactive_searx {
    while true
    do
        data=$(tempfile 2>/dev/null)
        trap "rm -f $data" 0 1 2 5 15
        dialog --backtitle $"Freedombone Control Panel" \
               --title $"SearX Metasearch" \
               --radiolist $"Choose an operation:" 12 70 3 \
               1 $"Set a background image" off \
               2 $"Enable login" off \
               3 $"Exit" on 2> $data
        sel=$?
        case $sel in
            1) return;;
            255) return;;
        esac
        case $(cat $data) in
            1) searx_set_background_image;;
            2) searx_enable_login;;
            3) break;;
        esac
    done
}

function remove_user_searx {
    remove_username="$1"

    ${PROJECT_NAME}-pass -u $remove_username --rmapp searx
    if grep -q "$remove_username:" /etc/nginx/.htpasswd; then
        sed -i "/$remove_username:/d" /etc/nginx/.htpasswd
    fi
}

function add_user_searx {
    if [[ $(app_is_installed searx) == "0" ]]; then
        echo '0'
        return
    fi

    new_username="$1"
    new_user_password="$2"

    ${PROJECT_NAME}-pass -u $new_username -a searx -p "$new_user_password"

    if grep -q "$new_username:" /etc/nginx/.htpasswd; then
        sed -i "/$new_username:/d" /etc/nginx/.htpasswd
    fi
    echo "$new_user_password" | htpasswd -i -s -c /etc/nginx/.htpasswd $new_username

    echo '0'
}

function install_interactive_searx {
    echo -n ''
    APP_INSTALLED=1
}

function change_password_searx {
    new_username="$1"
    new_user_password="$2"

    if grep -q "$new_username:" /etc/nginx/.htpasswd; then
        sed -i "/$new_username:/d" /etc/nginx/.htpasswd
        echo "$new_user_password" | htpasswd -i -s -c /etc/nginx/.htpasswd $new_username
        ${PROJECT_NAME}-pass -u $curr_username -a searx -p "$new_user_password"
        echo '0'
    fi
    echo '1'
}

function reconfigure_searx {
    echo -n ''
}

function create_searx_config {
    settings_file=${SEARX_PATH}/searx/searx/settings.yml

    SEARX_ONION_HOSTNAME=$(cat /var/lib/tor/hidden_service_searx/hostname)
    SEARX_SECRET_KEY=$(get_completion_param "searx key")

    echo 'general:' > $settings_file
    echo '    debug : False' >> $settings_file
    echo '    instance_name : "Freedombone Metasearch"' >> $settings_file
    echo '' >> $settings_file
    echo 'search:' >> $settings_file
    echo '    safe_search : 0 # Filter results. 0: None, 1: Moderate, 2: Strict' >> $settings_file
    echo '    autocomplete : "" # Existing autocomplete backends: "dbpedia", "duckduckgo", "startpage", "wikipedia" - leave blank to turn it off by default' >> $settings_file
    echo '    language : "all"' >> $settings_file
    echo '' >> $settings_file
    echo 'server:' >> $settings_file
    echo '    port : 8888' >> $settings_file
    echo '    bind_address : "127.0.0.1" # address to listen on' >> $settings_file
    echo "    secret_key : \"${SEARX_SECRET_KEY}\"" >> $settings_file
    echo "    base_url : http://${SEARX_ONION_HOSTNAME}/" >> $settings_file
    echo '    image_proxy : True # Proxying image results through searx' >> $settings_file
    echo '    http_protocol_version : "1.1"  # 1.0 and 1.1 are supported' >> $settings_file
    echo '' >> $settings_file
    echo 'ui:' >> $settings_file
    echo '    static_path : "" # Custom static path - leave it blank if you didnt change' >> $settings_file
    echo '    templates_path : "" # Custom templates path - leave it blank if you didnt change' >> $settings_file
    echo '    themes_path : "" # Custom ui themes path' >> $settings_file
    echo '    default_theme : courgette # ui theme' >> $settings_file
    echo '    default_locale : "" # Default interface locale - leave blank to detect from browser information or use codes from the 'locales' config section' >> $settings_file
    echo '' >> $settings_file
    echo 'outgoing: # communication with search engines' >> $settings_file
    echo '    request_timeout : 10.0 # seconds' >> $settings_file
    echo '    useragent_suffix : "" # suffix of searx_useragent, could contain informations like an email address to the administrator' >> $settings_file
    echo '    pool_connections : 100 # Number of different hosts' >> $settings_file
    echo '    pool_maxsize : 10 # Number of simultaneous requests by host' >> $settings_file
    echo '    proxies :' >> $settings_file
    echo '        http : socks5://127.0.0.1:9050' >> $settings_file
    echo '' >> $settings_file
    echo 'engines:' >> $settings_file
    echo '  - name : arch linux wiki' >> $settings_file
    echo '    engine : archlinux' >> $settings_file
    echo '    categories : general' >> $settings_file
    echo '    shortcut : al' >> $settings_file
    echo '' >> $settings_file
    echo '  - name : archive is' >> $settings_file
    echo '    engine : xpath' >> $settings_file
    echo '    search_url : https://archive.is/{query}' >> $settings_file
    echo '    url_xpath : (//div[@class="TEXT-BLOCK"]/a)/@href' >> $settings_file
    echo '    title_xpath : (//div[@class="TEXT-BLOCK"]/a)' >> $settings_file
    echo '    content_xpath : //div[@class="TEXT-BLOCK"]/ul/li' >> $settings_file
    echo '    categories : general' >> $settings_file
    echo '    timeout : 7.0' >> $settings_file
    echo '    disabled : True' >> $settings_file
    echo '    shortcut : ai' >> $settings_file
    echo '' >> $settings_file
    echo '  - name : base' >> $settings_file
    echo '    engine : base' >> $settings_file
    echo '    shortcut : bs' >> $settings_file
    echo '' >> $settings_file
    echo '  - name : wikipedia' >> $settings_file
    echo '    engine : wikipedia' >> $settings_file
    echo '    shortcut : wp' >> $settings_file
    echo '    categories : general' >> $settings_file
    echo '    base_url : "https://{language}.wikipedia.org/"' >> $settings_file
    echo '' >> $settings_file
    echo '  - name : bitbucket' >> $settings_file
    echo '    engine : xpath' >> $settings_file
    echo '    paging : True' >> $settings_file
    echo '    search_url : https://bitbucket.org/repo/all/{pageno}?name={query}' >> $settings_file
    echo '    url_xpath : //article[@class="repo-summary"]//a[@class="repo-link"]/@href' >> $settings_file
    echo '    title_xpath : //article[@class="repo-summary"]//a[@class="repo-link"]' >> $settings_file
    echo '    content_xpath : //article[@class="repo-summary"]/p' >> $settings_file
    echo '    categories : code' >> $settings_file
    echo '    timeout : 4.0' >> $settings_file
    echo '    disabled : True' >> $settings_file
    echo '    shortcut : bb' >> $settings_file
    echo '' >> $settings_file
    echo '  - name : ccc-tv' >> $settings_file
    echo '    engine : xpath' >> $settings_file
    echo '    paging : False' >> $settings_file
    echo '    search_url : https://media.ccc.de/search/?q={query}' >> $settings_file
    echo '    url_xpath : //div[@class="caption"]/h3/a/@href' >> $settings_file
    echo '    title_xpath : //div[@class="caption"]/h3/a/text()' >> $settings_file
    echo '    content_xpath : //div[@class="caption"]/h4/@title' >> $settings_file
    echo '    categories : videos' >> $settings_file
    echo '    shortcut : c3tv' >> $settings_file
    echo '' >> $settings_file
    echo '  - name : crossref' >> $settings_file
    echo '    engine : json_engine' >> $settings_file
    echo '    paging : True' >> $settings_file
    echo '    search_url : http://search.crossref.org/dois?q={query}&page={pageno}' >> $settings_file
    echo '    url_query : doi' >> $settings_file
    echo '    title_query : title' >> $settings_file
    echo '    content_query : fullCitation' >> $settings_file
    echo '    categories : science' >> $settings_file
    echo '    shortcut : cr' >> $settings_file
    echo '' >> $settings_file
    echo '  - name : currency' >> $settings_file
    echo '    engine : currency_convert' >> $settings_file
    echo '    categories : general' >> $settings_file
    echo '    shortcut : cc' >> $settings_file
    echo '' >> $settings_file
    echo '  - name : deezer' >> $settings_file
    echo '    engine : deezer' >> $settings_file
    echo '    shortcut : dz' >> $settings_file
    echo '' >> $settings_file
    echo '  - name : deviantart' >> $settings_file
    echo '    engine : deviantart' >> $settings_file
    echo '    shortcut : da' >> $settings_file
    echo '    timeout: 3.0' >> $settings_file
    echo '' >> $settings_file
    echo '  - name : ddg definitions' >> $settings_file
    echo '    engine : duckduckgo_definitions' >> $settings_file
    echo '    shortcut : ddd' >> $settings_file
    echo '    weight : 2' >> $settings_file
    echo '    disabled : True' >> $settings_file
    echo '' >> $settings_file
    echo '  - name : digbt' >> $settings_file
    echo '    engine : digbt' >> $settings_file
    echo '    shortcut : dbt' >> $settings_file
    echo '    timeout : 6.0' >> $settings_file
    echo '    disabled : True' >> $settings_file
    echo '' >> $settings_file
    echo '  - name : erowid' >> $settings_file
    echo '    engine : xpath' >> $settings_file
    echo '    paging : True' >> $settings_file
    echo '    first_page_num : 0' >> $settings_file
    echo '    page_size : 30' >> $settings_file
    echo '    search_url : https://www.erowid.org/search.php?q={query}&s={pageno}' >> $settings_file
    echo '    url_xpath : //dl[@class="results-list"]/dt[@class="result-title"]/a/@href' >> $settings_file
    echo '    title_xpath : //dl[@class="results-list"]/dt[@class="result-title"]/a/text()' >> $settings_file
    echo '    content_xpath : //dl[@class="results-list"]/dd[@class="result-details"]' >> $settings_file
    echo '    categories : general' >> $settings_file
    echo '    shortcut : ew' >> $settings_file
    echo '    disabled : True' >> $settings_file
    echo '' >> $settings_file
    echo '  - name : wikidata' >> $settings_file
    echo '    engine : wikidata' >> $settings_file
    echo '    shortcut : wd' >> $settings_file
    echo '    weight : 2' >> $settings_file
    echo '' >> $settings_file
    echo '  - name : duckduckgo' >> $settings_file
    echo '    engine : duckduckgo' >> $settings_file
    echo '    shortcut : ddg' >> $settings_file
    echo '    categories : general' >> $settings_file
    echo '' >> $settings_file
    echo '  - name : etymonline' >> $settings_file
    echo '    engine : xpath' >> $settings_file
    echo '    paging : True' >> $settings_file
    echo '    search_url : http://etymonline.com/?search={query}&p={pageno}' >> $settings_file
    echo '    url_xpath : //dt/a[1]/@href' >> $settings_file
    echo '    title_xpath : //dt' >> $settings_file
    echo '    content_xpath : //dd' >> $settings_file
    echo '    suggestion_xpath : //a[@class="crossreference"]' >> $settings_file
    echo '    first_page_num : 0' >> $settings_file
    echo '    shortcut : et' >> $settings_file
    echo '    disabled : True' >> $settings_file
    echo '' >> $settings_file
    echo '  - name : 500px' >> $settings_file
    echo '    engine : www500px' >> $settings_file
    echo '    shortcut : px' >> $settings_file
    echo '' >> $settings_file
    echo '  - name : 1x' >> $settings_file
    echo '    engine : www1x' >> $settings_file
    echo '    shortcut : 1x' >> $settings_file
    echo '    disabled : True' >> $settings_file
    echo '' >> $settings_file
    echo '  - name : fdroid' >> $settings_file
    echo '    engine : fdroid' >> $settings_file
    echo '    shortcut : fd' >> $settings_file
    echo '    disabled : True' >> $settings_file
    echo '' >> $settings_file
    echo '  - name : flickr' >> $settings_file
    echo '    categories : images' >> $settings_file
    echo '    shortcut : fl' >> $settings_file
    echo '# You can use the engine using the official stable API, but you need an API key' >> $settings_file
    echo '# See : https://www.flickr.com/services/apps/create/' >> $settings_file
    echo '#    engine : flickr' >> $settings_file
    echo '#    api_key: 'apikey' # required!' >> $settings_file
    echo '# Or you can use the html non-stable engine, activated by default' >> $settings_file
    echo '    engine : flickr_noapi' >> $settings_file
    echo '' >> $settings_file
    echo '  - name : frinkiac' >> $settings_file
    echo '    engine : frinkiac' >> $settings_file
    echo '    shortcut : frk' >> $settings_file
    echo '    disabled : True' >> $settings_file
    echo '' >> $settings_file
    echo '  - name : gigablast' >> $settings_file
    echo '    engine : gigablast' >> $settings_file
    echo '    shortcut : gb' >> $settings_file
    echo '    timeout : 3.0' >> $settings_file
    echo '    disabled: True' >> $settings_file
    echo '' >> $settings_file
    echo '  - name : gitlab' >> $settings_file
    echo '    engine : json_engine' >> $settings_file
    echo '    paging : True' >> $settings_file
    echo '    search_url : https://gitlab.com/api/v4/projects?search={query}&page={pageno}' >> $settings_file
    echo '    url_query : web_url' >> $settings_file
    echo '    title_query : name_with_namespace' >> $settings_file
    echo '    content_query : description' >> $settings_file
    echo '    page_size : 20' >> $settings_file
    echo '    categories : code' >> $settings_file
    echo '    shortcut : gl' >> $settings_file
    echo '    timeout : 10.0' >> $settings_file
    echo '    disabled : False' >> $settings_file
    echo '' >> $settings_file
    echo '  - name : github' >> $settings_file
    echo '    engine : github' >> $settings_file
    echo '    shortcut : gh' >> $settings_file
    echo '    categories : code' >> $settings_file
    echo '' >> $settings_file
    echo '  - name : geektimes' >> $settings_file
    echo '    engine : xpath' >> $settings_file
    echo '    paging : True' >> $settings_file
    echo '    search_url : https://geektimes.ru/search/page{pageno}/?q={query}' >> $settings_file
    echo '    url_xpath : //div[@class="search_results"]//a[@class="post__title_link"]/@href' >> $settings_file
    echo '    title_xpath : //div[@class="search_results"]//a[@class="post__title_link"]' >> $settings_file
    echo '    content_xpath : //div[@class="search_results"]//div[contains(@class, "content")]' >> $settings_file
    echo '    categories : code' >> $settings_file
    echo '    timeout : 4.0' >> $settings_file
    echo '    disabled : True' >> $settings_file
    echo '    shortcut : gt' >> $settings_file
    echo '' >> $settings_file
    echo '  - name : habrahabr' >> $settings_file
    echo '    engine : xpath' >> $settings_file
    echo '    paging : True' >> $settings_file
    echo '    search_url : https://habrahabr.ru/search/page{pageno}/?q={query}' >> $settings_file
    echo '    url_xpath : //div[@class="search_results"]//a[contains(@class, "post__title_link")]/@href' >> $settings_file
    echo '    title_xpath : //div[@class="search_results"]//a[contains(@class, "post__title_link")]' >> $settings_file
    echo '    content_xpath : //div[@class="search_results"]//div[contains(@class, "content")]' >> $settings_file
    echo '    categories : code' >> $settings_file
    echo '    timeout : 4.0' >> $settings_file
    echo '    disabled : True' >> $settings_file
    echo '    shortcut : habr' >> $settings_file
    echo '' >> $settings_file
    echo '  - name : hoogle' >> $settings_file
    echo '    engine : json_engine' >> $settings_file
    echo '    paging : True' >> $settings_file
    echo '    search_url : https://www.haskell.org/hoogle/?mode=json&hoogle={query}&start={pageno}' >> $settings_file
    echo '    results_query : results' >> $settings_file
    echo '    url_query : location' >> $settings_file
    echo '    title_query : self' >> $settings_file
    echo '    content_query : docs' >> $settings_file
    echo '    page_size : 20' >> $settings_file
    echo '    categories : code' >> $settings_file
    echo '    shortcut : ho' >> $settings_file
    echo '' >> $settings_file
    echo '  - name : ina' >> $settings_file
    echo '    engine : ina' >> $settings_file
    echo '    shortcut : in' >> $settings_file
    echo '    timeout : 6.0' >> $settings_file
    echo '    disabled : True' >> $settings_file
    echo '' >> $settings_file
    echo '  - name: kickass' >> $settings_file
    echo '    engine : kickass' >> $settings_file
    echo '    shortcut : kc' >> $settings_file
    echo '    timeout : 4.0' >> $settings_file
    echo '    disabled : True' >> $settings_file
    echo '' >> $settings_file
    echo '  - name : library genesis' >> $settings_file
    echo '    engine : xpath' >> $settings_file
    echo '    search_url : http://libgen.io/search.php?req={query}' >> $settings_file
    echo '    url_xpath : //a[contains(@href,"bookfi.net")]/@href' >> $settings_file
    echo '    title_xpath : //a[contains(@href,"book/")]/text()[1]' >> $settings_file
    echo '    content_xpath : //td/a[1][contains(@href,"=author")]/text()' >> $settings_file
    echo '    categories : general' >> $settings_file
    echo '    timeout : 7.0' >> $settings_file
    echo '    disabled : True' >> $settings_file
    echo '    shortcut : lg' >> $settings_file
    echo '' >> $settings_file
    echo '  - name : lobste.rs' >> $settings_file
    echo '    engine : xpath' >> $settings_file
    echo '    search_url : https://lobste.rs/search?utf8=%E2%9C%93&q={query}&what=stories&order=relevance' >> $settings_file
    echo '    results_xpath : //li[contains(@class, "story")]' >> $settings_file
    echo '    url_xpath : .//span[@class="link"]/a/@href' >> $settings_file
    echo '    title_xpath : .//span[@class="link"]/a' >> $settings_file
    echo '    content_xpath : .//a[@class="domain"]' >> $settings_file
    echo '    categories : code' >> $settings_file
    echo '    shortcut : lo' >> $settings_file
    echo '' >> $settings_file
    echo '  - name : mixcloud' >> $settings_file
    echo '    engine : mixcloud' >> $settings_file
    echo '    shortcut : mc' >> $settings_file
    echo '' >> $settings_file
    echo '  - name : nyaa' >> $settings_file
    echo '    engine : nyaa' >> $settings_file
    echo '    shortcut : nt' >> $settings_file
    echo '    disabled : True' >> $settings_file
    echo '' >> $settings_file
    echo '  - name : openstreetmap' >> $settings_file
    echo '    engine : openstreetmap' >> $settings_file
    echo '    shortcut : osm' >> $settings_file
    echo '' >> $settings_file
    echo '  - name : openrepos' >> $settings_file
    echo '    engine : xpath' >> $settings_file
    echo '    paging : True' >> $settings_file
    echo '    search_url : https://openrepos.net/search/node/{query}?page={pageno}' >> $settings_file
    echo '    url_xpath : //li[@class="search-result"]//h3[@class="title"]/a/@href' >> $settings_file
    echo '    title_xpath : //li[@class="search-result"]//h3[@class="title"]/a' >> $settings_file
    echo '    content_xpath : //li[@class="search-result"]//div[@class="search-snippet-info"]//p[@class="search-snippet"]' >> $settings_file
    echo '    categories : files' >> $settings_file
    echo '    timeout : 4.0' >> $settings_file
    echo '    disabled : True' >> $settings_file
    echo '    shortcut : or' >> $settings_file
    echo '' >> $settings_file
    echo '  - name : pdbe' >> $settings_file
    echo '    engine : pdbe' >> $settings_file
    echo '    shortcut : pdb' >> $settings_file
    echo '' >> $settings_file
    echo '  - name : photon' >> $settings_file
    echo '    engine : photon' >> $settings_file
    echo '    shortcut : ph' >> $settings_file
    echo '' >> $settings_file
    echo '  - name : piratebay' >> $settings_file
    echo '    engine : piratebay' >> $settings_file
    echo '    shortcut : tpb' >> $settings_file
    echo '    url: https://pirateproxy.red/' >> $settings_file
    echo '    timeout : 3.0' >> $settings_file
    echo '' >> $settings_file
    echo '  - name : qwant' >> $settings_file
    echo '    engine : qwant' >> $settings_file
    echo '    shortcut : qw' >> $settings_file
    echo '    categories : general' >> $settings_file
    echo '    disabled : True' >> $settings_file
    echo '' >> $settings_file
    echo '  - name : qwant images' >> $settings_file
    echo '    engine : qwant' >> $settings_file
    echo '    shortcut : qwi' >> $settings_file
    echo '    categories : images' >> $settings_file
    echo '' >> $settings_file
    echo '  - name : qwant news' >> $settings_file
    echo '    engine : qwant' >> $settings_file
    echo '    shortcut : qwn' >> $settings_file
    echo '    categories : news' >> $settings_file
    echo '' >> $settings_file
    echo '  - name : qwant social' >> $settings_file
    echo '    engine : qwant' >> $settings_file
    echo '    shortcut : qws' >> $settings_file
    echo '    categories : social media' >> $settings_file
    echo '' >> $settings_file
    echo '  - name : reddit' >> $settings_file
    echo '    engine : reddit' >> $settings_file
    echo '    shortcut : re' >> $settings_file
    echo '    page_size : 25' >> $settings_file
    echo '    timeout : 10.0' >> $settings_file
    echo '    disabled : True' >> $settings_file
    echo '' >> $settings_file
    echo '  - name : scanr structures' >> $settings_file
    echo '    shortcut: scs' >> $settings_file
    echo '    engine : scanr_structures' >> $settings_file
    echo '    disabled : True' >> $settings_file
    echo '' >> $settings_file
    echo '  - name : soundcloud' >> $settings_file
    echo '    engine : soundcloud' >> $settings_file
    echo '    shortcut : sc' >> $settings_file
    echo '' >> $settings_file
    echo '  - name : stackoverflow' >> $settings_file
    echo '    engine : stackoverflow' >> $settings_file
    echo '    shortcut : st' >> $settings_file
    echo '' >> $settings_file
    echo '  - name : searchcode doc' >> $settings_file
    echo '    engine : searchcode_doc' >> $settings_file
    echo '    shortcut : scd' >> $settings_file
    echo '' >> $settings_file
    echo '  - name : searchcode code' >> $settings_file
    echo '    engine : searchcode_code' >> $settings_file
    echo '    shortcut : scc' >> $settings_file
    echo '    disabled : True' >> $settings_file
    echo '' >> $settings_file
    echo '  - name : framalibre' >> $settings_file
    echo '    engine : framalibre' >> $settings_file
    echo '    shortcut : frl' >> $settings_file
    echo '    disabled : True' >> $settings_file
    echo '' >> $settings_file
    echo '  - name : semantic scholar' >> $settings_file
    echo '    engine : xpath' >> $settings_file
    echo '    paging : True' >> $settings_file
    echo '    search_url : https://www.semanticscholar.org/search?q={query}&sort=relevance&page={pageno}&ae=false' >> $settings_file
    echo '    results_xpath : //article' >> $settings_file
    echo '    url_xpath : .//div[@class="search-result-title"]/a/@href' >> $settings_file
    echo '    title_xpath : .//div[@class="search-result-title"]/a' >> $settings_file
    echo '    content_xpath : .//div[@class="search-result-abstract"]' >> $settings_file
    echo '    shortcut : se' >> $settings_file
    echo '    categories : science' >> $settings_file
    echo '' >> $settings_file
    echo '  - name : spotify' >> $settings_file
    echo '    engine : spotify' >> $settings_file
    echo '    shortcut : stf' >> $settings_file
    echo '' >> $settings_file
    echo '  - name : subtitleseeker' >> $settings_file
    echo '    engine : subtitleseeker' >> $settings_file
    echo '    shortcut : ss' >> $settings_file
    echo '# The language is an option. You can put any language written in english' >> $settings_file
    echo '# Examples : English, French, German, Hungarian, Chinese...' >> $settings_file
    echo '#    language : English' >> $settings_file
    echo '' >> $settings_file
    echo '  - name : startpage' >> $settings_file
    echo '    engine : startpage' >> $settings_file
    echo '    shortcut : sp' >> $settings_file
    echo '    timeout : 6.0' >> $settings_file
    echo '    disabled : True' >> $settings_file
    echo '' >> $settings_file
    echo '  - name : ixquick' >> $settings_file
    echo '    engine : startpage' >> $settings_file
    echo "    base_url : 'https://www.ixquick.eu/'" >> $settings_file
    echo "    search_url : 'https://www.ixquick.eu/do/search'" >> $settings_file
    echo '    shortcut : iq' >> $settings_file
    echo '    timeout : 6.0' >> $settings_file
    echo '' >> $settings_file
    echo '  - name : swisscows' >> $settings_file
    echo '    engine : swisscows' >> $settings_file
    echo '    shortcut : sw' >> $settings_file
    echo '    disabled : True' >> $settings_file
    echo '' >> $settings_file
    echo '  - name : tokyotoshokan' >> $settings_file
    echo '    engine : tokyotoshokan' >> $settings_file
    echo '    shortcut : tt' >> $settings_file
    echo '    timeout : 6.0' >> $settings_file
    echo '    disabled : True' >> $settings_file
    echo '' >> $settings_file
    echo '  - name : twitter' >> $settings_file
    echo '    engine : twitter' >> $settings_file
    echo '    shortcut : tw' >> $settings_file
    echo '' >> $settings_file
    echo '  - name : urbandictionary' >> $settings_file
    echo '    engine        : xpath' >> $settings_file
    echo '    search_url    : http://www.urbandictionary.com/define.php?term={query}' >> $settings_file
    echo '    url_xpath     : //*[@class="word"]/@href' >> $settings_file
    echo '    title_xpath   : //*[@class="def-header"]' >> $settings_file
    echo '    content_xpath : //*[@class="meaning"]' >> $settings_file
    echo '    shortcut : ud' >> $settings_file
    echo '' >> $settings_file
    echo '  - name : yandex' >> $settings_file
    echo '    engine : yandex' >> $settings_file
    echo '    shortcut : yn' >> $settings_file
    echo '    disabled : True' >> $settings_file
    echo '' >> $settings_file
    echo '  - name : youtube' >> $settings_file
    echo '    shortcut : yt' >> $settings_file
    echo '    # You can use the engine using the official stable API, but you need an API key' >> $settings_file
    echo '    # See : https://console.developers.google.com/project' >> $settings_file
    echo '    #    engine : youtube_api' >> $settings_file
    echo '    #    api_key: apikey # required!' >> $settings_file
    echo '    # Or you can use the html non-stable engine, activated by default' >> $settings_file
    echo '    engine : youtube_noapi' >> $settings_file
    echo '' >> $settings_file
    echo '  - name : dailymotion' >> $settings_file
    echo '    engine : dailymotion' >> $settings_file
    echo '    shortcut : dm' >> $settings_file
    echo '' >> $settings_file
    echo '  - name : vimeo' >> $settings_file
    echo '    engine : vimeo' >> $settings_file
    echo '    shortcut : vm' >> $settings_file
    echo '' >> $settings_file
    echo '  - name : wolframalpha' >> $settings_file
    echo '    shortcut : wa' >> $settings_file
    echo '    # You can use the engine using the official stable API, but you need an API key' >> $settings_file
    echo '    # See : http://products.wolframalpha.com/api/' >> $settings_file
    echo '    # engine : wolframalpha_api' >> $settings_file
    echo '    # api_key: '' # required!' >> $settings_file
    echo '    engine : wolframalpha_noapi' >> $settings_file
    echo '    timeout: 6.0' >> $settings_file
    echo '    categories : science' >> $settings_file
    echo '' >> $settings_file
    echo '  - name : seedpeer' >> $settings_file
    echo '    engine : seedpeer' >> $settings_file
    echo '    shortcut: speu'
    echo '    categories: files, music, videos'
    echo '    disabled: True' >> $settings_file
    echo '' >> $settings_file
    echo '  - name : dictzone' >> $settings_file
    echo '    engine : dictzone' >> $settings_file
    echo '    shortcut : dc' >> $settings_file
    echo '' >> $settings_file
    echo '  - name : mymemory translated' >> $settings_file
    echo '    engine : translated' >> $settings_file
    echo '    shortcut : tl' >> $settings_file
    echo '    timeout : 5.0' >> $settings_file
    echo '    disabled : True' >> $settings_file
    echo '    # You can use without an API key, but you are limited to 1000 words/day' >> $settings_file
    echo '    # See : http://mymemory.translated.net/doc/usagelimits.php' >> $settings_file
    echo '    # api_key : ""' >> $settings_file
    echo '' >> $settings_file
    echo '  - name : voat' >> $settings_file
    echo '    engine: xpath' >> $settings_file
    echo '    shortcut: vo' >> $settings_file
    echo '    categories: social media' >> $settings_file
    echo '    search_url : https://voat.co/search?q={query}' >> $settings_file
    echo '    url_xpath : //p[contains(@class, "title")]/a/@href' >> $settings_file
    echo '    title_xpath : //p[contains(@class, "title")]/a' >> $settings_file
    echo '    content_xpath : //span[@class="domain"]' >> $settings_file
    echo '    timeout : 10.0' >> $settings_file
    echo '    disabled : True' >> $settings_file
    echo '' >> $settings_file
    echo '  - name : 1337x' >> $settings_file
    echo '    engine : 1337x' >> $settings_file
    echo '    shortcut : 1337x' >> $settings_file
    echo '    disabled : True' >> $settings_file
    echo '' >> $settings_file
    echo 'locales:' >> $settings_file
    echo '    en : English' >> $settings_file
    echo '    bg : Български (Bulgarian)' >> $settings_file
    echo '    cs : Čeština (Czech)' >> $settings_file
    echo '    de : Deutsch (German)' >> $settings_file
    echo '    de_DE : Deutsch (German_Germany)' >> $settings_file
    echo '    el_GR : Ελληνικά (Greek_Greece)' >> $settings_file
    echo '    eo : Esperanto (Esperanto)' >> $settings_file
    echo '    es : Español (Spanish)' >> $settings_file
    echo '    fi : Suomi (Finnish)' >> $settings_file
    echo '    fr : Français (French)' >> $settings_file
    echo '    he : עברית (Hebrew)' >> $settings_file
    echo '    hu : Magyar (Hungarian)' >> $settings_file
    echo '    it : Italiano (Italian)' >> $settings_file
    echo '    ja : 日本語 (Japanese)' >> $settings_file
    echo '    nl : Nederlands (Dutch)' >> $settings_file
    echo '    pt : Português (Portuguese)' >> $settings_file
    echo '    pt_BR : Português (Portuguese_Brazil)' >> $settings_file
    echo '    ro : Română (Romanian)' >> $settings_file
    echo '    ru : Русский (Russian)' >> $settings_file
    echo '    sk : Slovenčina (Slovak)' >> $settings_file
    echo '    sv : Svenska (Swedish)' >> $settings_file
    echo '    tr : Türkçe (Turkish)' >> $settings_file
    echo '    uk : українська мова (Ukrainian)' >> $settings_file
    echo '    zh : 中文 (Chinese)' >> $settings_file
    echo '' >> $settings_file
    echo 'doi_resolvers :' >> $settings_file
    echo "    oadoi.org : 'https://oadoi.org/'" >> $settings_file
    echo "    doi.org : 'https://doi.org/'" >> $settings_file
    echo "    doai.io : 'http://doai.io/'" >> $settings_file
    echo '' >> $settings_file
    echo "default_doi_resolver : 'oadoi.org'" >> $settings_file
}

function upgrade_searx {
    CURR_SEARX_COMMIT=$(get_completion_param "searx commit")
    if [[ "$CURR_SEARX_COMMIT" == "$SEARX_COMMIT" ]]; then
        return
    fi

    settings_file=${SEARX_PATH}/searx/searx/settings.yml
    background_image=/etc/searx/searx/static/themes/courgette/img/bg-body-index.jpg

    # save the background image
    if [ -f ${background_image} ]; then
        cp ${background_image} ${background_image}.prev
    fi

    # save the settings
    cp ${settings_file} ${settings_file}.prev

    # do the upgrade
    set_repo_commit $SEARX_PATH/searx "searx commit" "$SEARX_COMMIT" $SEARX_REPO

    # restore the background image
    if [ -f ${background_image}.prev ]; then
        cp ${background_image}.prev ${background_image}
        chown -R searx:searx ${SEARX_PATH}/searx
    fi

    # restore the settings
    if [ -f ${settings_file}.prev ]; then
        cp ${settings_file}.prev ${settings_file}
        chown -R searx:searx ${SEARX_PATH}/searx
    fi

    # remove the github ribbon icon
    if [ -f /etc/searx/searx/static/themes/courgette/img/github_ribbon.png ]; then
        mv /etc/searx/searx/static/themes/courgette/img/github_ribbon.png /etc/searx/searx/static/themes/courgette/img/github_ribbon.png.old
    fi
}

function backup_local_searx {
    echo -n ''
}

function restore_local_searx {
    echo -n ''
}

function backup_remote_searx {
    echo -n ''
}

function restore_remote_searx {
    echo -n ''
}

function remove_searx {
    systemctl stop searx
    systemctl disable searx
    rm /etc/systemd/system/searx.service
    systemctl daemon-reload

    function_check remove_onion_service
    remove_onion_service searx ${SEARX_ONION_PORT}
    userdel -r searx
    nginx_dissite searx
    if [ -f /etc/nginx/sites-available/searx ]; then
        rm /etc/nginx/sites-available/searx
    fi
    if [ -d ${SEARX_PATH}/searx ]; then
        rm -rf ${SEARX_PATH}/searx
    fi
    remove_completion_param install_searx
    sed -i '/Search engine /d' $COMPLETION_FILE
    sed -i '/searx /d' $COMPLETION_FILE
}

function install_searx {
    # Note: currently socks5 outgoing proxies to other search engines does not work
    if [ ! -d /etc/nginx ]; then
        echo $'Webserver is not installed'
        exit 62429
    fi

    apt-get -yq install python-pip libyaml-dev python-werkzeug python-babel python-lxml
    apt-get -yq install git build-essential libxslt-dev python-dev python-virtualenv zlib1g-dev uwsgi uwsgi-plugin-python imagemagick
    apt-get -yq install apache2-utils python-setuptools
    apt-get -yq install python-service-identity python-ndg-httpsclient

    apt-get -yq remove --purge apache2-bin*
    if [ -d /etc/apache2 ]; then
        rm -rf /etc/apache2
        echo $'Removed Apache installation'
    fi

    pip install --upgrade pip

    pip install certifi
    if [ ! "$?" = "0" ]; then
        echo $'Failed to install certifi'
        exit 737692
    fi

    pip install pyyaml
    if [ ! "$?" = "0" ]; then
        echo $'Failed to install pyyaml'
        exit 469242
    fi

    pip install flask --upgrade
    if [ ! "$?" = "0" ]; then
        echo $'Failed to install flask'
        exit 888575
    fi

    pip install flask_restless --upgrade
    if [ ! "$?" = "0" ]; then
        echo $'Failed to install flask_restless'
        exit 54835
    fi

    pip install flask_babel --upgrade
    if [ ! "$?" = "0" ]; then
        echo $'Failed to install flask_babel'
        exit 63738
    fi

    pip install requests --upgrade
    if [ ! "$?" = "0" ]; then
        echo $'Failed to install requests'
        exit 357282
    fi

    pip install pygments --upgrade
    if [ ! "$?" = "0" ]; then
        echo $'Failed to install pygments'
        exit 357282
    fi

    if [ ! -d $SEARX_PATH ]; then
        mkdir -p $SEARX_PATH
    fi

    # clone the repo
    cd $SEARX_PATH

    if [ -d /repos/searx ]; then
        mkdir searx
        cp -r -p /repos/searx/. searx
        cd searx
        git pull
    else
        function_check git_clone
        git_clone $SEARX_REPO searx
    fi

    git checkout $SEARX_COMMIT -b $SEARX_COMMIT
    set_completion_param "searx commit" "$SEARX_COMMIT"

    # create an onion service
    SEARX_ONION_HOSTNAME=$(add_onion_service searx 80 ${SEARX_ONION_PORT})

    # an unprivileged user to run as
    useradd -d ${SEARX_PATH}/searx/ -s /bin/false searx
    adduser searx debian-tor

    # daemon
    echo '[Unit]' > /etc/systemd/system/searx.service
    echo 'Description=Searx (search engine)' >> /etc/systemd/system/searx.service
    echo 'After=syslog.target' >> /etc/systemd/system/searx.service
    echo 'After=network.target' >> /etc/systemd/system/searx.service
    echo '' >> /etc/systemd/system/searx.service
    echo '[Service]' >> /etc/systemd/system/searx.service
    echo 'Type=simple' >> /etc/systemd/system/searx.service
    echo 'User=searx' >> /etc/systemd/system/searx.service
    echo 'Group=searx' >> /etc/systemd/system/searx.service
    echo "WorkingDirectory=${SEARX_PATH}/searx" >> /etc/systemd/system/searx.service
    echo "ExecStart=/usr/bin/python ${SEARX_PATH}/searx/searx/webapp.py" >> /etc/systemd/system/searx.service
    echo 'Restart=always' >> /etc/systemd/system/searx.service
    echo 'Environment="USER=searx"' >> /etc/systemd/system/searx.service
    echo '' >> /etc/systemd/system/searx.service
    echo '[Install]' >> /etc/systemd/system/searx.service
    echo 'WantedBy=multi-user.target' >> /etc/systemd/system/searx.service

    # create a webserver file
    echo 'server {' > /etc/nginx/sites-available/searx
    echo "    listen 127.0.0.1:${SEARX_ONION_PORT} default_server;" >> /etc/nginx/sites-available/searx
    echo "    root ${SEARX_PATH}/searx;" >> /etc/nginx/sites-available/searx
    echo "    server_name ${SEARX_ONION_HOSTNAME};" >> /etc/nginx/sites-available/searx
    echo '    access_log /dev/null;' >> /etc/nginx/sites-available/searx
    echo "    error_log /var/log/searx_error.log $WEBSERVER_LOG_LEVEL;" >> /etc/nginx/sites-available/searx
    echo '' >> /etc/nginx/sites-available/searx
    function_check nginx_disable_sniffing
    nginx_disable_sniffing searx
    echo '    add_header Strict-Transport-Security max-age=0;' >> /etc/nginx/sites-available/searx
    echo '' >> /etc/nginx/sites-available/searx
    echo '    location / {' >> /etc/nginx/sites-available/searx
    function_check nginx_limits
    nginx_limits searx '1M'
    echo '        proxy_pass http://localhost:8888;' >> /etc/nginx/sites-available/searx
    echo "        #auth_basic \"${SEARX_LOGIN_TEXT}\";" >> /etc/nginx/sites-available/searx
    echo '        #auth_basic_user_file /etc/nginx/.htpasswd;' >> /etc/nginx/sites-available/searx
    echo '    }' >> /etc/nginx/sites-available/searx
    echo '' >> /etc/nginx/sites-available/searx
    echo '    fastcgi_buffers 64 4K;' >> /etc/nginx/sites-available/searx
    echo '' >> /etc/nginx/sites-available/searx
    echo '    error_page 403 /core/templates/403.php;' >> /etc/nginx/sites-available/searx
    echo '    error_page 404 /core/templates/404.php;' >> /etc/nginx/sites-available/searx
    echo '' >> /etc/nginx/sites-available/searx
    echo '    location = /robots.txt {' >> /etc/nginx/sites-available/searx
    echo '        allow all;' >> /etc/nginx/sites-available/searx
    echo '        log_not_found off;' >> /etc/nginx/sites-available/searx
    echo '        access_log /dev/null;' >> /etc/nginx/sites-available/searx
    echo '    }' >> /etc/nginx/sites-available/searx
    echo '}' >> /etc/nginx/sites-available/searx

    # replace the secret key
    if ! grep -q "searx key" $COMPLETION_FILE; then
        SEARX_SECRET_KEY="$(create_password 30)"
        set_completion_param "searx key" "${SEARX_SECRET_KEY}"
    fi

    create_searx_config

    searx_set_default_background

    chown -R searx:searx ${SEARX_PATH}/searx

    # enable the site
    nginx_ensite searx

    # restart the web server
    systemctl restart php7.0-fpm
    systemctl restart nginx

    # start the daemon
    systemctl enable searx.service
    systemctl daemon-reload
    systemctl start searx.service

    SEARX_PASSWORD="$(create_password ${MINIMUM_PASSWORD_LENGTH})"
    ${PROJECT_NAME}-pass -u $MY_USERNAME -a searx -p "$SEARX_PASSWORD"
    if grep -q "$MY_USERNAME:" /etc/nginx/.htpasswd; then
        sed -i "/$MY_USERNAME:/d" /etc/nginx/.htpasswd
    fi
    echo "$SEARX_PASSWORD" | htpasswd -i -s -c /etc/nginx/.htpasswd $MY_USERNAME

    APP_INSTALLED=1
}

# NOTE: deliberately no exit 0