version based on the git repository

This commit remove the need to update the brand for GIT_URL and GIT_BRANCH:
there are read from the git repository.

It is possible to call python -m searx.version freeze to freeze the current version.
Useful when the code is installed outside git (distro package, docker, etc...)

8 files changed, 153 insertions, 43 deletions

diff --git a/searx/settings.yml b/searx/settings.yml
index ec8d99d1b..bc7eec802 100644
--- a/searx/settings.yml
+++ b/searx/settings.yml
@@ -10,11 +10,6 @@ brand:
   wiki_url: https://github.com/searxng/searxng/wiki
   issue_url: https://github.com/searxng/searxng/issues
 
-  # If you change a value below don't forget to rebuild instance's enviroment
-  # (make buildenv)
-  git_url: https://github.com/searxng/searxng
-  git_branch: master
-
 search:
   # Filter results. 0: None, 1: Moderate, 2: Strict
   safe_search: 0
diff --git a/searx/settings_defaults.py b/searx/settings_defaults.py
index 72d7dc588..e3955d97b 100644
--- a/searx/settings_defaults.py
+++ b/searx/settings_defaults.py
@@ -130,8 +130,6 @@ SCHEMA = {
         'contact_url': SettingsValue((None, False, str), None),
     },
     'brand': {
-        'git_url': SettingsValue(str),
-        'git_branch': SettingsValue(str),
         'issue_url': SettingsValue(str, None),
         'new_issue_url': SettingsValue(str, None),
         'docs_url': SettingsValue(str, None),
diff --git a/searx/templates/__common__/about.html b/searx/templates/__common__/about.html
index 96ebab28a..707802d45 100644
--- a/searx/templates/__common__/about.html
+++ b/searx/templates/__common__/about.html
@@ -11,7 +11,7 @@
   <p>More about SearXNG ...</p>
 
   <ul>
-    <li><a href="{{ get_setting('brand.git_url') }}">SearXNG sources</a></li>
+    <li><a href="{{ searx_git_url }}">SearXNG sources</a></li>
     <li><a href="https://www.transifex.com/projects/p/searx/">transifex</a></li>
   </ul>
 
@@ -30,7 +30,7 @@
     </li>
     <li>
       SearXNG is free software, the code is 100% open and you can help to make
-      it better.  See more on <a href="{{ get_setting('brand.git_url')
+      it better.  See more on <a href="{{ searx_git_url
       }}">SearXNG sources</a>.
     </li>
   </ul>
@@ -81,7 +81,7 @@
 
   <p>
     SearXNG appreciates your concern regarding logs, so take the code from
-    the <a href="{{ get_setting('brand.git_url') }}">SearXNG project</a> and
+    the <a href="{{ searx_git_url }}">SearXNG project</a> and
     run it yourself!
   </p>
   <p>
@@ -95,7 +95,7 @@
 
   <p>
     See the <a href="{{ get_setting('brand.docs_url') }}">SearXNG docs</a>
-    and <a href="{{ get_setting('brand.git_url') }}">SearXNG sources</a>
+    and <a href="{{ searx_git_url }}">SearXNG sources</a>
   </p>
 
 </div>
diff --git a/searx/templates/oscar/base.html b/searx/templates/oscar/base.html
index cc716e62b..7cd38a25c 100644
--- a/searx/templates/oscar/base.html
+++ b/searx/templates/oscar/base.html
@@ -83,7 +83,7 @@
             <p class="text-muted">
                 <small>
                     {{ _('Powered by') }} <a href="{{ get_setting('brand.docs_url') }}">SearXNG</a> - {{ searx_version }} - {{ _('a privacy-respecting, hackable metasearch engine') }}<br/>
-                    <a href="{{ get_setting('brand.git_url') }}">{{ _('Source code') }}</a> |
+                    <a href="{{ searx_git_url }}">{{ _('Source code') }}</a> |
                     <a href="{{ get_setting('brand.issue_url') }}">{{ _('Issue tracker') }}</a> |
                     <a href="{{ get_setting('brand.public_instances') }}">{{ _('Public instances') }}</a>{% if get_setting('general.contact_url') %} |
                     <a href="{{ get_setting('general.contact_url') }}">{{ _('Contact instance maintainer') }}</a>{% endif %}
diff --git a/searx/templates/simple/base.html b/searx/templates/simple/base.html
index edf0eb6eb..7020de756 100644
--- a/searx/templates/simple/base.html
+++ b/searx/templates/simple/base.html
@@ -51,7 +51,7 @@
   <footer>
     <p>
     {{ _('Powered by') }} <a href="{{ url_for('about') }}">searxng</a> - {{ searx_version }} — {{ _('a privacy-respecting, hackable metasearch engine') }}<br/>
-        <a href="{{ get_setting('brand.git_url') }}">{{ _('Source code') }}</a> |
+        <a href="{{ searx_git_url }}">{{ _('Source code') }}</a> |
         <a href="{{ get_setting('brand.issue_url') }}">{{ _('Issue tracker') }}</a> |
         <a href="{{ get_setting('brand.public_instances') }}">{{ _('Public instances') }}</a>{% if get_setting('general.contact_url') %} |
         <a href="{{ get_setting('general.contact_url') }}">{{ _('Contact instance maintainer') }}</a>{% endif %}
diff --git a/searx/utils.py b/searx/utils.py
index 285546043..5e2ab18c4 100644
--- a/searx/utils.py
+++ b/searx/utils.py
@@ -16,7 +16,7 @@ from babel.core import get_global
 
 from searx import settings
 from searx.data import USER_AGENTS
-from searx.version import VERSION_STRING
+from searx.version import VERSION_TAG
 from searx.languages import language_codes
 from searx.exceptions import SearxXPathSyntaxException, SearxEngineXPathException
 from searx import logger
@@ -44,7 +44,7 @@ NOTSET = NotSetClass()
 def searx_useragent():
     """Return the searx User Agent"""
     return 'searx/{searx_version} {suffix}'.format(
-           searx_version=VERSION_STRING,
+           searx_version=VERSION_TAG,
            suffix=settings['outgoing']['useragent_suffix']).strip()
 
 
diff --git a/searx/version.py b/searx/version.py
index aa631d893..34c37bd22 100644
--- a/searx/version.py
+++ b/searx/version.py
@@ -1,26 +1,142 @@
-# -*- coding: utf-8 -*-
-'''
-searx 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.
-
-searx 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 searx. If not, see < http://www.gnu.org/licenses/ >.
-
-(C) 2013- by Adam Tauber, <asciimoo@gmail.com>
-'''
-
-# version of searx
-VERSION_MAJOR = 1
-VERSION_MINOR = 0
-VERSION_BUILD = 0
-
-VERSION_STRING = "{0}.{1}.{2}".format(VERSION_MAJOR,
-                                      VERSION_MINOR,
-                                      VERSION_BUILD)
+# SPDX-License-Identifier: AGPL-3.0-or-later
+# lint: pylint
+# pylint: disable=missing-function-docstring,missing-module-docstring,missing-class-docstring
+
+import re
+import os
+import shlex
+import subprocess
+import logging
+
+# fallback values
+# if there is searx.version_frozen module, and it is not possible to get the git tag
+VERSION_STRING = "1.0.0"
+VERSION_TAG = "1.0.0"
+GIT_URL = "unknow"
+GIT_BRANCH = "unknow"
+
+logger = logging.getLogger("searx")
+
+SUBPROCESS_RUN_ENV = {
+    "PATH": os.environ["PATH"],
+    "LC_ALL": "C",
+    "LANGUAGE": "",
+}
+
+
+def subprocess_run(args, **kwargs):
+    """Call :py:func:`subprocess.run` and return (striped) stdout.  If returncode is
+    non-zero, raise a :py:func:`subprocess.CalledProcessError`.
+    """
+    if not isinstance(args, (list, tuple)):
+        args = shlex.split(args)
+
+    kwargs["env"] = kwargs.get("env", SUBPROCESS_RUN_ENV)
+    kwargs["encoding"] = kwargs.get("encoding", "utf-8")
+    kwargs["stdout"] = subprocess.PIPE
+    kwargs["stderr"] = subprocess.PIPE
+    # raise CalledProcessError if returncode is non-zero
+    kwargs["check"] = True
+    proc = subprocess.run(args, **kwargs)  # pylint: disable=subprocess-run-check
+    return proc.stdout.strip()
+
+
+def get_git_url_and_branch():
+    try:
+        ref = subprocess_run("git rev-parse --abbrev-ref @{upstream}")
+    except subprocess.CalledProcessError:
+        ref = subprocess_run("git rev-parse --abbrev-ref master@{upstream}")
+    origin, git_branch = ref.split("/", 1)
+    git_url = subprocess_run(["git", "remote", "get-url", origin])
+
+    # get https:// url from git@ url
+    if git_url.startswith("git@"):
+        git_url = git_url.replace(":", "/", 2).replace("git@", "https://", 1)
+    if git_url.endswith(".git"):
+        git_url = git_url.replace(".git", "", 1)
+
+    return git_url, git_branch
+
+
+def get_git_version():
+    try:
+        tag = subprocess_run("git describe HEAD")
+        # a. HEAD is on tag name, example: tag = "v1.0.1"
+        # b. HEAD is not a tag name, example "<tag>-<distance>-g<commit>"
+        tag_version, tag_distance, tag_commit = (tag.split("-") + ["", ""])[:3]
+        if re.match(r"v[0-9]+\.[0-9]+\.[0-9]+", tag_version):
+            # tag_version "v1.0.0" becomes "1.0.0" (without the v)
+            # other patterns are kept untouched
+            tag_version = tag_version[1:]
+        # remove "g" prefix from tag_commit
+        if tag_commit and tag_commit[0] == "g":
+            tag_commit = tag_commit[1:]
+        # set git_version to "1.0.0-590-0686e274" or '1.0.0'
+        git_version = "-".join(filter(bool, [tag_version, tag_distance, tag_commit]))
+    except subprocess.CalledProcessError:
+        # fall back to "YYYY.MM.DD.Hash" if there is no tag at all
+        git_version = subprocess_run(r"git show -s --format='%as-%h'")
+        # PEP 440: replace - with .
+        tag_version = git_version = git_version.replace("-", ".")
+
+    # add "-dirty" suffix if there are uncommited changes except searx/settings.yml
+    try:
+        subprocess_run(
+            "git diff --quiet -- . ':!searx/settings.yml' ':!utils/brand.env'"
+        )
+    except subprocess.CalledProcessError as e:
+        if e.returncode == 1:
+            git_version += "-dirty"
+        else:
+            logger.warning(
+                '"%s" returns an unexpected return code %i', e.returncode, e.cmd
+            )
+    return git_version, tag_version
+
+
+try:
+    from searx.version_frozen import VERSION_STRING, VERSION_TAG, GIT_URL, GIT_BRANCH
+except ImportError:
+    try:
+        try:
+            VERSION_STRING, VERSION_TAG = get_git_version()
+        except subprocess.CalledProcessError as ex:
+            logger.error("Error while getting the version: %s", ex.stderr)
+        try:
+            GIT_URL, GIT_BRANCH = get_git_url_and_branch()
+        except subprocess.CalledProcessError as ex:
+            logger.error("Error while getting the git URL & branch: %s", ex.stderr)
+    except FileNotFoundError as ex:
+        logger.error("%s is not found, fallback to the default version", ex.filename)
+
+
+logger.info("version: %s", VERSION_STRING)
+
+if __name__ == "__main__":
+    import sys
+
+    if len(sys.argv) >= 2 and sys.argv[1] == "freeze":
+        # freeze the version (to create an archive outside a git repository)
+        python_code = f"""# SPDX-License-Identifier: AGPL-3.0-or-later
+# this file is generated automatically by searx/version.py
+
+VERSION_STRING = "{VERSION_STRING}"
+VERSION_TAG = "{VERSION_TAG}"
+GIT_URL = "{GIT_URL}"
+GIT_BRANCH = "{GIT_BRANCH}"
+"""
+        with open(
+            os.path.join(os.path.dirname(__file__), "version_frozen.py"), "w"
+        ) as f:
+            f.write(python_code)
+            print(f"{f.name} created")
+    else:
+        # output shell code to set the variables
+        # usage: eval "$(python -m searx.version)"
+        shell_code = f"""
+VERSION_STRING="{VERSION_STRING}"
+VERSION_TAG="{VERSION_TAG}"
+GIT_URL="{GIT_URL}"
+GIT_BRANCH="{GIT_BRANCH}"
+"""
+        print(shell_code)
diff --git a/searx/webapp.py b/searx/webapp.py
index 09c0643be..d638dfb55 100755
--- a/searx/webapp.py
+++ b/searx/webapp.py
@@ -82,7 +82,7 @@ from searx.utils import (
     dict_subset,
     match_language,
 )
-from searx.version import VERSION_STRING
+from searx.version import VERSION_STRING, GIT_URL
 from searx.query import RawTextQuery
 from searx.plugins import plugins
 from searx.plugins.oa_doi_rewrite import get_doi_resolver
@@ -475,6 +475,7 @@ def render(template_name, override_theme=None, **kwargs):
     ]
     kwargs['instance_name'] = get_setting('general.instance_name')
     kwargs['searx_version'] = VERSION_STRING
+    kwargs['searx_git_url'] = GIT_URL
     kwargs['get_setting'] = get_setting
 
     # helpers to create links to other pages
@@ -1322,7 +1323,7 @@ def config():
         'version': VERSION_STRING,
         'brand': {
             'CONTACT_URL': get_setting('general.contact_url'),
-            'GIT_URL': get_setting('brand.git_url'),
+            'GIT_URL': GIT_URL,
             'DOCS_URL': get_setting('brand.docs_url'),
         },
         'doi_resolvers': list(settings['doi_resolvers'].keys()),