Merge branch 'master' into duckduckgo_correction

# -*- coding: utf-8; mode: sh -*-

# SPDX-License-Identifier: AGPL-3.0-or-later

# shellcheck shell=bash disable=SC2034

#

# This environment is used by ./utils scripts like filtron.sh or searx.sh.  The

# default values are *most flexible* and *best maintained*, you normally not

# need to change the defaults (except PUBLIC_URL).

#

# Before you change any value here you have to uninstall any previous

# installation.  Further is it recommended to backup your changes simply by

# adding them to you local brand (git branch)::

#

#     git add .config

# The public URL of the searx instance: PUBLIC_URL="https://mydomain.xy/searx"

# The default is taken from ./utils/brand.env.

PUBLIC_URL="${SEARX_URL}"

if [[ ${PUBLIC_URL} == "https://searx.me" ]]; then

    # hint: Linux containers do not have DNS entries, lets use IPs

    PUBLIC_URL="http://$(primary_ip)/searx"

fi

# searx.sh

# ---------

# SEARX_INTERNAL_URL="127.0.0.1:8888"

# Only change, if you maintain a searx brand in your searx fork.

# GIT_BRANCH="${GIT_BRANCH:-master}"

# filtron.sh

# ----------

# FILTRON_API="127.0.0.1:4005"

# FILTRON_LISTEN="127.0.0.1:4004"

# FILTRON_TARGET="127.0.0.1:8888"

# morty.sh

# --------

# morty listen address

# MORTY_LISTEN="127.0.0.1:3000"

# PUBLIC_URL_PATH_MORTY="/morty/"

# system services

# ---------------

# Common $HOME folder of the service accounts

# SERVICE_HOME_BASE="/usr/local"

# **experimental**: Set SERVICE_USER to run all services by one account, but be

# aware that removing discrete components might conflict!

# SERVICE_USER=searx

# to sync with .dockerignore

.coverage

coverage/

cache/

.installed.cfg

engines.cfg

env

# -*- coding: utf-8; mode: makefile-gmake -*-

.DEFAULT_GOAL=help

# START Makefile setup

export GIT_URL=https://github.com/asciimoo/searx

export GIT_BRANCH=master

export SEARX_URL=https://searx.me

export DOCS_URL=https://asciimoo.github.io/searx

# END Makefile setup

include utils/makefile.include

PYOBJECTS = searx

DOC       = docs

PY_SETUP_EXTRAS ?= \[test\]

PYDIST=./dist/py

PYBUILD=./build/py

include utils/makefile.include

include utils/makefile.python

include utils/makefile.sphinx

all: clean install

PHONY += help

help:

PHONY += help-min help-all help

help: help-min

	@echo  ''

	@echo  'to get more help:  make help-all'

help-min:

	@echo  '  test      - run developer tests'

	@echo  '  docs      - build documentation'

	@echo  '  docs-live - autobuild HTML documentation while editing'

	@echo  '  docker    - build Docker image'

	@echo  '  node.env  - download & install npm dependencies locally'

	@echo  ''

	@$(MAKE) -s -f utils/makefile.include make-help

	@echo  'environment'

	@echo  '  SEARX_URL = $(SEARX_URL)'

	@echo  '  GIT_URL   = $(GIT_URL)'

	@echo  '  DOCS_URL  = $(DOCS_URL)'

	@echo  ''

	@$(MAKE) -e -s make-help

help-all: help-min

	@echo  ''

	@$(MAKE) -e -s python-help

	@echo  ''

	@$(MAKE) -s -f utils/makefile.python python-help

	@$(MAKE) -e -s docs-help

PHONY += install

install: buildenv pyenvinstall

uninstall: pyenvuninstall

PHONY += clean

clean: pyclean node.clean test.clean

clean: pyclean docs-clean node.clean test.clean

	$(call cmd,common_clean)

PHONY += run

# docs

# ----

sphinx-doc-prebuilds:: buildenv pyenvinstall prebuild-includes

PHONY += docs

docs:  buildenv pyenvinstall sphinx-doc

docs:  sphinx-doc-prebuilds sphinx-doc

	$(call cmd,sphinx,html,docs,docs)

PHONY += docs-live

docs-live:  buildenv pyenvinstall sphinx-live

docs-live:  sphinx-doc-prebuilds sphinx-live

	$(call cmd,sphinx_autobuild,html,docs,docs)

PHONY += prebuild-includes

prebuild-includes:

	$(Q)mkdir -p $(DOCS_BUILD)/includes

	$(Q)./utils/searx.sh doc | cat > $(DOCS_BUILD)/includes/searx.rst

	$(Q)./utils/filtron.sh doc | cat > $(DOCS_BUILD)/includes/filtron.rst

	$(Q)./utils/morty.sh doc | cat > $(DOCS_BUILD)/includes/morty.rst

$(GH_PAGES)::

	@echo "doc available at --> $(DOCS_URL)"

buildenv:

	$(Q)echo "build searx/brand.py"

	$(Q)echo "GIT_URL = '$(GIT_URL)'"  > searx/brand.py

	$(Q)echo "GIT_BRANCH = '$(GIT_BRANCH)'"  >> searx/brand.py

	$(Q)echo "ISSUE_URL = 'https://github.com/asciimoo/searx/issues'" >> searx/brand.py

	$(Q)echo "SEARX_URL = '$(SEARX_URL)'" >> searx/brand.py

	$(Q)echo "DOCS_URL = '$(DOCS_URL)'" >> searx/brand.py

	$(Q)echo "PUBLIC_INSTANCES = 'https://searx.space'" >> searx/brand.py

	$(Q)echo "build utils/brand.env"

	$(Q)echo "export GIT_URL='$(GIT_URL)'"  > utils/brand.env

	$(Q)echo "export GIT_BRANCH='$(GIT_BRANCH)'"  >> utils/brand.env

	$(Q)echo "export ISSUE_URL='https://github.com/asciimoo/searx/issues'" >> utils/brand.env

	$(Q)echo "export SEARX_URL='$(SEARX_URL)'" >> utils/brand.env

	$(Q)echo "export DOCS_URL='$(DOCS_URL)'" >> utils/brand.env

# test

# ----

PHONY += test test.pylint test.pep8 test.unit test.coverage test.robot

PHONY += test test.sh test.pylint test.pep8 test.unit test.coverage test.robot

test: buildenv test.pylint test.pep8 test.unit gecko.driver test.robot

ifeq ($(PY),2)

	@echo "LINT      skip liniting py2"

else

# TODO: balance linting with pylint

test.pylint: pyenvinstall

	$(call cmd,pylint,\

		searx/preferences.py \

#  E402 module level import not at top of file

#  W503 line break before binary operator

# ubu1604: uses shellcheck v0.3.7 (from 04/2015), no longer supported!

test.sh:

	shellcheck -x -s bash utils/brand.env

	shellcheck -x utils/lib.sh

	shellcheck -x utils/filtron.sh

	shellcheck -x utils/searx.sh

	shellcheck -x utils/morty.sh

	shellcheck -x utils/lxc.sh

	shellcheck -x utils/lxc-searx.env

	shellcheck -x .config.sh

test.pep8: pyenvinstall

	@echo "TEST      pep8"

	$(Q)$(PY_ENV_ACT); pep8 --exclude=searx/static --max-line-length=120 --ignore "E402,W503" searx tests

/* admonitions

*/

div.admonition, div.topic {

div.admonition, div.topic, div.toctree-wrapper {

  background-color: #fafafa;

  margin: 8px 0px;

  padding: 1em;

  border-right: none;

  border-bottom: none;

  border-left: 5pt solid #ccc;

  list-style-type: disclosure-closed;

}

div.toctree-wrapper p.caption {

  font-weight: normal;

  font-size: 24px;

  margin: 0 0 10px 0;

  padding: 0;

  line-height: 1;

  display: inline;

}

p.admonition-title:after {

  caption-side: top;

  text-align: left;

}

/* bugs since sphinx 3.1

See sphinx-doc project, PR 7838 & 7484 with elementary patch to the basic CSS:

- https://github.com/sphinx-doc/sphinx/issues/7838#issuecomment-646009605

- https://github.com/sphinx-doc/sphinx/pull/7484#issuecomment-646058972

*/

li > p:first-child {

    margin-top: 0;

}

li > p:last-child {

    margin-bottom: 0;

}

div.admonition dl {

    margin-bottom: 0;

}

div.sidebar {

    clear: none;

}

div.admonition, div.topic, pre {

    clear: none;

}

  edge [fontname="Sans"];

  browser [label="Browser", shape=Mdiamond];

  rp      [label="Reverse Proxy", href="url to configure reverse proxy"];

  filtron [label="Filtron",       href="https://github.com/asciimoo/filtron"];

  morty   [label="Morty",         href="https://github.com/asciimoo/morty"];

  rp      [label="Reverse Proxy", href="https://asciimoo.github.io/searx/utils/filtron.sh.html#public-reverse-proxy"];

  filtron [label="Filtron",       href="https://asciimoo.github.io/searx/utils/filtron.sh.html"];

  morty   [label="Morty",         href="https://asciimoo.github.io/searx/utils/morty.sh.html"];

  static  [label="Static files",  href="url to configure static files"];

  uwsgi   [label="uwsgi",         href="url to configure uwsgi"]

  uwsgi   [label="uwsgi",         href="https://asciimoo.github.io/searx/utils/searx.sh.html"]

  searx1  [label="Searx #1"];

  searx2  [label="Searx #2"];

  searx3  [label="Searx #3"];