craftbeerpi4-pione/cbpi/cli.py

import argparse
import datetime
import logging
import subprocess
import sys
import re
import requests
import yaml
from cbpi.utils.utils import load_config
from zipfile import ZipFile
from cbpi.craftbeerpi import CraftBeerPi
import os
import platform
import pathlib
import shutil
import yaml
import click
from subprocess import call
import zipfile
from importlib_metadata import version, metadata

from jinja2 import Template


def create_config_file():
    if os.path.exists(os.path.join(".", 'config', "config.yaml")) is False:
        srcfile = os.path.join(os.path.dirname(__file__), "config", "config.yaml")
        destfile = os.path.join(".", 'config')
        shutil.copy(srcfile, destfile)
        
    if os.path.exists(os.path.join(".", 'config', "actor.json")) is False:
        srcfile = os.path.join(os.path.dirname(__file__), "config", "actor.json")
        destfile = os.path.join(".", 'config')
        shutil.copy(srcfile, destfile)

    if os.path.exists(os.path.join(".", 'config', "sensor.json")) is False:
        srcfile = os.path.join(os.path.dirname(__file__), "config", "sensor.json")
        destfile = os.path.join(".", 'config')
        shutil.copy(srcfile, destfile)

    if os.path.exists(os.path.join(".", 'config', "kettle.json")) is False:
        srcfile = os.path.join(os.path.dirname(__file__), "config", "kettle.json")
        destfile = os.path.join(".", 'config')
        shutil.copy(srcfile, destfile)

    if os.path.exists(os.path.join(".", 'config', "fermenter_data.json")) is False:
        srcfile = os.path.join(os.path.dirname(__file__), "config", "fermenter_data.json")
        destfile = os.path.join(".", 'config')
        shutil.copy(srcfile, destfile)

    if os.path.exists(os.path.join(".", 'config', "step_data.json")) is False:
        srcfile = os.path.join(os.path.dirname(__file__), "config", "step_data.json")
        destfile = os.path.join(".", 'config')
        shutil.copy(srcfile, destfile)

    if os.path.exists(os.path.join(".", 'config', "config.json")) is False:
        srcfile = os.path.join(os.path.dirname(__file__), "config", "config.json")
        destfile = os.path.join(".", 'config')
        shutil.copy(srcfile, destfile)

    if os.path.exists(os.path.join(".", 'config', "dashboard", "cbpi_dashboard_1.json")) is False:
        srcfile = os.path.join(os.path.dirname(__file__), "config", "dashboard", "cbpi_dashboard_1.json")
        destfile = os.path.join(".", "config", "dashboard")
        shutil.copy(srcfile, destfile)

    if os.path.exists(os.path.join(".", 'config', "carftbeerpi.service")) is False:
        srcfile = os.path.join(os.path.dirname(__file__), "config", "craftbeerpi.service")
        destfile = os.path.join(".", 'config')
        shutil.copy(srcfile, destfile)

    if os.path.exists(os.path.join(".", 'config', "chromium.desktop")) is False:
        srcfile = os.path.join(os.path.dirname(__file__), "config", "chromium.desktop")
        destfile = os.path.join(".", 'config')
        shutil.copy(srcfile, destfile)

    print("Config Folder created")


def create_home_folder_structure():
    pathlib.Path(os.path.join(".", 'logs/sensors')).mkdir(parents=True, exist_ok=True)
    pathlib.Path(os.path.join(".", 'config')).mkdir(parents=True, exist_ok=True)
    pathlib.Path(os.path.join(".", 'config/dashboard')).mkdir(parents=True, exist_ok=True)
    pathlib.Path(os.path.join(".", 'config/dashboard/widgets')).mkdir(parents=True, exist_ok=True)
    pathlib.Path(os.path.join(".", 'config/recipes')).mkdir(parents=True, exist_ok=True)
    pathlib.Path(os.path.join(".", 'config/fermenterrecipes')).mkdir(parents=True, exist_ok=True)
    pathlib.Path(os.path.join(".", 'config/upload')).mkdir(parents=True, exist_ok=True) 
    print("Folder created")


def setup_one_wire():
    print("Setting up 1Wire")
    with open('/boot/config.txt', 'w') as f:
        f.write("dtoverlay=w1-gpio,gpiopin=4,pullup=on")
    print("/boot/config.txt created")

def list_one_wire():
    print("List 1Wire")
    call(["modprobe", "w1-gpio"])
    call(["modprobe", "w1-therm"])
    try:
        for dirname in os.listdir('/sys/bus/w1/devices'):
            if (dirname.startswith("28") or dirname.startswith("10")):
                print(dirname)
    except Exception as e:
        print(e)

def copy_splash():
    srcfile = os.path.join(".", "config", "splash.png")
    destfile = os.path.join(".", 'config')
    shutil.copy(srcfile, destfile)
    print("Splash Srceen created")


def clear_db():
    import os.path
    if os.path.exists(os.path.join(".", "craftbeerpi.db")) is True:
        os.remove(os.path.join(".", "craftbeerpi.db"))
        print("database Cleared")

def recursive_chown(path, owner, group):
    for dirpath, dirnames, filenames in os.walk(path):
        shutil.chown(dirpath, owner, group)
        for filename in filenames:
            shutil.chown(os.path.join(dirpath, filename), owner, group)

def check_for_setup():
    if os.path.exists(os.path.join(".", "config", "config.yaml")) is False:
        print("***************************************************")
        print("CraftBeerPi Config File not found: %s" % os.path.join(".", "config", "config.yaml"))
        print("Please run 'cbpi setup' before starting the server ")
        print("***************************************************")
        return False
    if os.path.exists(os.path.join(".", "config", "upload")) is False:
        print("***************************************************")
        print("CraftBeerPi upload folder not found: %s" % os.path.join(".", "config/upload"))
        print("Please run 'cbpi setup' before starting the server ")
        print("***************************************************")
        return False
#    if os.path.exists(os.path.join(".", "config", "fermenterrecipes")) is False:
#        print("***************************************************")
#        print("CraftBeerPi fermenterrecipes folder not found: %s" % os.path.join(".", "config/fermenterrecipes"))
#        print("Please run 'cbpi setup' before starting the server ")
#        print("***************************************************")
#        return False
    backupfile = os.path.join(".", "restored_config.zip")
    if os.path.exists(os.path.join(backupfile)) is True:
        print("***************************************************")
        print("Found backup of config. Starting restore")
        required_content=['dashboard/', 'recipes/', 'upload/', 'config.json', 'config.yaml']
        zip=zipfile.ZipFile(backupfile)
        zip_content_list = zip.namelist()
        zip_content = True
        print("Checking content of zip file")
        for content in required_content:
            try:
                check = zip_content_list.index(content)
            except:
                zip_content = False

        if zip_content == True:
            print("Found correct content. Starting Restore process")
            output_path = pathlib.Path(os.path.join(".", 'config'))
            system = platform.system()
            print(system)
            if system != "Windows":
                owner = output_path.owner()
                group = output_path.group()
            print("Removing old config folder")
            shutil.rmtree(output_path, ignore_errors=True) 
            print("Extracting zip file to config folder")
            zip.extractall(output_path)
            zip.close()
            if system != "Windows":
                print("Changing owner and group of config folder recursively to {}:{}".format(owner,group))
                recursive_chown(output_path, owner, group)
            print("Removing backup file")
            os.remove(backupfile)
        else:
            print("Wrong Content in zip file. No restore possible")
            print("Removing zip file")
            os.remove(backupfile)
        print("***************************************************")

        return True 
    else:
        return True


def plugins_add(package_name):
    if package_name is None:
        print("Pleaes provide a plugin Name")
        return

    if package_name == 'autostart':
        print("Add craftbeerpi.service to systemd")
        try:
            if os.path.exists(os.path.join("/etc/systemd/system","craftbeerpi.service")) is False:
                srcfile = os.path.join(".", "config", "craftbeerpi.service")
                destfile = os.path.join("/etc/systemd/system")
                shutil.copy(srcfile, destfile)
                print("Copied craftbeerpi.service to /etc/systemd/system")
                os.system('systemctl enable craftbeerpi.service')
                print('Enabled craftbeerpi service')
                os.system('systemctl start craftbeerpi.service')
                print('Started craftbeerpi.service')
            else:
                print("craftbeerpi.service is already located in /etc/systemd/system")
        except Exception as e:
            print(e)
            return
        return

    if package_name == 'chromium':
        print("Add chromium.desktop to /etc/xdg/autostart/")
        try:
            if os.path.exists(os.path.join("/etc/xdg/autostart/","chromium.desktop")) is False:
                srcfile = os.path.join(".", "config", "chromium.desktop")
                destfile = os.path.join("/etc/xdg/autostart/")
                shutil.copy(srcfile, destfile)
                print("Copied chromium.desktop to /etc/xdg/autostart/")
            else:
                print("chromium.desktop is already located in /etc/xdg/autostart/")
        except Exception as e:
            print(e)
            return
        return

    installation = True
    try:
        try:
            p_metadata= metadata(package_name)
            p_name=p_metadata['Name']
            #if p_name != package_name:
            #    print("Error. Package name {} does not exist. Did you mean {}".format(package_name,p_name))
            #    installation = False
        except Exception as e:
            print("Error. Package {} cannot be found in installed packages".format(package_name))
            installation = False
        if installation:
            with open(os.path.join(".", 'config', "config.yaml"), 'rt') as f:
                data = yaml.load(f, Loader=yaml.FullLoader)
                if package_name in data["plugins"]:
                    print("")
                    print("Plugin {} already active".format(package_name))
                    print("")
                    return
                data["plugins"].append(package_name)
            with open(os.path.join(".", 'config', "config.yaml"), 'w') as outfile:
                yaml.dump(data, outfile, default_flow_style=False)
            print("")
            print("Plugin {} activated".format(package_name))
            print("")
    except Exception as e:
        print(e)
        pass


def plugin_remove(package_name):
    if package_name is None:
        print("Pleaes provide a plugin Name")
        return

    if package_name == 'autostart':
        print("Remove craftbeerpi.service from systemd")
        try:
            status = os.popen('systemctl list-units --type=service --state=running | grep craftbeerpi.service').read()
            if status.find("craftbeerpi.service") != -1:
                os.system('systemctl stop craftbeerpi.service')
                print('Stopped craftbeerpi service')
                os.system('systemctl disable craftbeerpi.service')
                print('Removed craftbeerpi.service as service')
            else:
                print('craftbeerpi.service service is not running')

            if os.path.exists(os.path.join("/etc/systemd/system","craftbeerpi.service")) is True:
                os.remove(os.path.join("/etc/systemd/system","craftbeerpi.service")) 
                print("Deleted craftbeerpi.service from /etc/systemd/system")
            else:
                print("craftbeerpi.service is not located in /etc/systemd/system")
        except Exception as e:
            print(e)
            return
        return

    if package_name == 'chromium':
        print("Remove chromium.desktop from /etc/xdg/autostart/")
        try:
            if os.path.exists(os.path.join("/etc/xdg/autostart/","chromium.desktop")) is True:
                os.remove(os.path.join("/etc/xdg/autostart/","chromium.desktop"))
                print("Deleted chromium.desktop from /etc/xdg/autostart/")
            else:
                print("chromium.desktop is not located in /etc/xdg/autostart/")
        except Exception as e:
            print(e)
            return
        return


    try:
        with open(os.path.join(".", 'config', "config.yaml"), 'rt') as f:
            data = yaml.load(f, Loader=yaml.FullLoader)

            data["plugins"] = list(filter(lambda k: package_name not in k, data["plugins"]))
            with open(os.path.join(".", 'config', "config.yaml"), 'w') as outfile:
                yaml.dump(data, outfile, default_flow_style=False)
        print("")
        print("Plugin {} deactivated".format(package_name))
        print("")
    except Exception as e:
        print(e)
        pass


def plugins_list():
    print("--------------------------------------")
    print("List of active plugins")
    try:
        with open(os.path.join(".", 'config', "config.yaml"), 'rt') as f:
            data = yaml.load(f, Loader=yaml.FullLoader)

            for p in data["plugins"]:
                try:
                    p_metadata= metadata(p)
                    p_Homepage= p_metadata['Home-page']
                    p_version = p_metadata['Version']
                    p_Author = p_metadata['Author']
                    print("- ({})\t{}".format(p_version,p))
                except Exception as e:
                    print (e)
                    pass
    except Exception as e:
        print(e)
        pass
    print("--------------------------------------")


def plugin_create(name):
    if os.path.exists(os.path.join(".", name)) is True:
        print("Cant create Plugin. Folder {} already exists ".format(name))
        return

    url = 'https://github.com/Manuel83/craftbeerpi4-plugin-template/archive/main.zip'
    r = requests.get(url)
    with open('temp.zip', 'wb') as f:
        f.write(r.content)

    with ZipFile('temp.zip', 'r') as repo_zip:
        repo_zip.extractall()

    os.rename("./craftbeerpi4-plugin-template-main", os.path.join(".", name))
    os.rename(os.path.join(".", name, "src"), os.path.join(".", name, name))

    import jinja2

    templateLoader = jinja2.FileSystemLoader(searchpath=os.path.join(".", name))
    templateEnv = jinja2.Environment(loader=templateLoader)
    TEMPLATE_FILE = "setup.py"
    template = templateEnv.get_template(TEMPLATE_FILE)
    outputText = template.render(name=name)

    with open(os.path.join(".", name, "setup.py"), "w") as fh:
        fh.write(outputText)

    TEMPLATE_FILE = "MANIFEST.in"
    template = templateEnv.get_template(TEMPLATE_FILE)
    outputText = template.render(name=name)
    with open(os.path.join(".", name, "MANIFEST.in"), "w") as fh:
        fh.write(outputText)

    TEMPLATE_FILE = os.path.join("/", name, "config.yaml")
    template = templateEnv.get_template(TEMPLATE_FILE)
    outputText = template.render(name=name)

    with open(os.path.join(".", name, name, "config.yaml"), "w") as fh:
        fh.write(outputText)
    print("")
    print("")
    print(
        "Plugin {} created! See https://openbrewing.gitbook.io/craftbeerpi4_support/readme/development how to run your plugin ".format(
            name))
    print("")
    print("Happy Development! Cheers")
    print("")
    print("")


@click.group()
def main():
    level = logging.INFO
    logging.basicConfig(level=level, format='%(asctime)s - %(levelname)s - %(name)s - %(message)s')
    pass


@click.command()
def setup():
    '''Create Config folder'''
    print("Setting up CraftBeerPi")
    create_home_folder_structure()
    create_config_file()


@click.command()
@click.option('--list', is_flag=True, help="List all 1Wire Devices")
@click.option('--setup', is_flag=True, help="Setup 1Wire on Raspberry Pi")
def onewire(list, setup):
    '''Setup 1wire on Raspberry Pi'''
    if setup is True:
        setup_one_wire()
    if list is True:
        list_one_wire()



@click.command()
def start():
    if check_for_setup() is False:
        return
    print("START")
    cbpi = CraftBeerPi()
    cbpi.start()


@click.command()
def plugins():
    '''List active plugins'''
    plugins_list()
    return


@click.command()
@click.argument('name')
def add(name):
    '''Activate Plugin, autostart or chromium '''
    plugins_add(name)


@click.command()
@click.argument('name')
def remove(name):
    '''Deactivate Plugin, autostart or chromium'''
    plugin_remove(name)


@click.command()
@click.argument('name')
def create(name):
    '''Create New Plugin'''
    plugin_create(name)


main.add_command(setup)
main.add_command(start)
main.add_command(plugins)
main.add_command(onewire)
main.add_command(add)
main.add_command(remove)
main.add_command(create)