setup.py

"""
Copyright 2023 The Anweddol project
See the LICENSE file for licensing informations
---

Anweddol server installation script

"""

from subprocess import Popen, DEVNULL
from setuptools import setup
import shutil
import os


VERSION = "4.1.4"


def getReadmeContent():
    with open("README.md", "r") as fd:
        return fd.read()


def executeCommand(command):
    Popen(command.split(" "), shell=False, stdout=DEVNULL, stderr=DEVNULL)


print("[SETUP] Checking operating system ...")
if os.name == "nt":
    raise EnvironmentError("The Anweddol server is only available on linux systems.")

print("[SETUP] Checking permissions ...")
if os.geteuid() == 0:
    # Create needed folders
    print("[SETUP (root)] Creating folders ...")
    for path in ["/etc/anweddol", "/var/log/anweddol"]:
        if not os.path.exists(path):
            os.mkdir(path)

    # Create the configuration file
    print("[SETUP (root)] Creating configuration file ...")
    if os.path.exists("/etc/anweddol/config.yaml") and not os.path.exists(
        "/etc/anweddol/config.yaml.old"
    ):
        shutil.copy("/etc/anweddol/config.yaml", "/etc/anweddol/config.yaml.old")

    shutil.copy(
        os.path.dirname(os.path.realpath(__file__)) + "/resources/config.yaml",
        "/etc/anweddol/config.yaml",
    )

    # Add the user anweddol and rwx 'anweddol' user permission
    # on the /etc/anweddol and the /var/log/anweddol directory
    print("[SETUP (root)] Creating user 'anweddol' ...")
    executeCommand("/sbin/useradd -s /sbin/nologin -M anweddol")
    executeCommand("/sbin/usermod -aG libvirt anweddol")

    executeCommand("/bin/chown root.anweddol /etc/anweddol /var/log/anweddol")
    executeCommand("/bin/chmod -R g+rwX /etc/anweddol /var/log/anweddol")

    # Create the systemctl service and enable it
    print("[SETUP (root)] Creating systemctl service ...")
    if os.path.exists("/usr/lib/systemd/system/anweddol-server.service"):
        os.remove("/usr/lib/systemd/system/anweddol-server.service")

    shutil.copy(
        os.path.dirname(os.path.realpath(__file__))
        + "/resources/anweddol-server.service",
        "/usr/lib/systemd/system/anweddol-server.service",
    )

else:
    print(
        "[SETUP] WARN : Non-root user detected, the installation limits to the 'anwdlserver' python package installation"
    )

print("[SETUP] Installing Anweddol server package ...")
setup(
    name="anwdlserver",
    version=VERSION,
    author="The Anweddol project",
    author_email="the-anweddol-project@proton.me",
    url="https://the-anweddol-project.github.io/",
    description="The Anweddol server implementation",
    long_description=getReadmeContent(),
    classifiers=[
        "Development Status :: 5 - Production/Stable",
        "License :: OSI Approved :: MIT License",
        "Intended Audience :: Developers",
        "Intended Audience :: System Administrators",
        "Programming Language :: Python :: 3",
        "Operating System :: POSIX",
        "Topic :: Internet",
    ],
    license="MIT",
    packages=[
        "anwdlserver",  # Includes every CLI modules at the root of 'anwdlserver'
        "anwdlserver.core",
        "anwdlserver.tools",
        "anwdlserver.web",
    ],
    install_requires=[
        "cryptography",
        "paramiko",
        "python-daemon",
        "cerberus",
        "defusedxml",
        "sqlalchemy",
        "pyyaml",
        "psutil",
        "twisted",
        "service_identity",
        "pyOpenSSL",
    ],
    include_package_data=True,
    entry_points={
        "console_scripts": [
            "anwdlserver = anwdlserver.cli:MainAnweddolServerCLI",
        ],
    },
)