green-signals/setup.py

#! /bin/python3

import os
import subprocess
import sys
import tkinter as tk

# imporrt the standard to read and write config files
import configparser

#the main window
master=tk.Tk()

#list of required modules
modules=list()
try:
    import vlc
except:
    modules.append("python-vlc")

try:
    import crontab
except:
    modules.append("python-crontab")

#init variables used in config file and some other places
doAutostart=tk.IntVar()
bild_dauer=tk.IntVar()
DEBUG_PREVIEW=tk.IntVar()
localPath=tk.StringVar()
remoteURL=tk.StringVar()
energyMode=tk.IntVar()
energyStart=tk.StringVar()
energyStop=tk.StringVar()


#when setup can't find the conf file, inited is set to True
inited = False
#URL for the Intro-Screens, use as default, if conf is inited
introURL="https://wolke.netzbegruenung.de/s/CE7CASzEeGF4px2/download"

#set "dirty" flag to False
#any change should set it to True, so we can ask on quit to save data
isDirty=False

def createAutostart():
    '''
    create the auto start file gruene_signale.desktop in $HOME/.config/autostart/
    also create intermediate paths if the do not exist
    when the file already exists, nothing is done
    '''
    autostartfile = os.path.expanduser("~/.config/autostart/gruene_signale.desktop")
    whereami = os.path.dirname(os.path.realpath(__file__))
    contents = """[Desktop Entry]
Type=Application
Name=Green Signals Autostart
Comment=Starten der Slideshow von Grüne Signale
NoDisplay=false
Exec=sh -c 'cd %(path)s && /bin/python3 gruene_signale.py'
"""
    if os.path.isfile(autostartfile) == False:
        if os.path.exists(os.path.dirname(autostartfile)) == False:
            os.makedirs(os.path.dirname(autostartfile))
        file=open(autostartfile,"w")
        file.write(contents%{'path':whereami})
        file.close()

def removeAutostart():
    '''
    check if the auto start file exists, and if it does, remove it
    '''
    autostartfile = os.path.expanduser("~/.config/autostart/gruene_signale.desktop")
    if os.path.isfile(autostartfile) == True:
        os.remove(autostartfile)

def checkAutostartfile():
    '''
    check if the auto start file gruene_signale.desktop already exists
    returns True, if it does, False if not
    '''
    autostartfile = os.path.expanduser("~/.config/autostart/gruene_signale.desktop")
    return int(os.path.isfile(autostartfile))

def installModules():
    global modules
    failed=list()
    for module in modules:
        try:
            subprocess.check_call([sys.executable, "-m", "pip", "install", module])
        except:
            print("install module %s failed" % module)
            failed.append(module)
    modules=failed

def validateTimeFields(input,newchar):
    if newchar not in '01234567890:.':
        return False
    setDirty()
    return True;

def setDirty(ign=None):
    global isDirty
    isDirty = True
    return True


def readConfig(configFile=None):
    global bild_dauer, DEBUG_PREVIEW, localPath, remoteURL, isDirty, inited
    global energyStart, energyStop, energyMode
    if configFile == None:
        configFile = os.path.dirname(os.path.realpath(__file__)) + os.sep + "gruene_signale.conf"
    if os.path.exists(configFile) == False:
        inited = True
    config = configparser.ConfigParser()
    config.read(configFile)
    #read bild - dauer
    try:
        bild_dauer.set(int(config.get('bilder', 'dauer')))
    except:
        bild_dauer.set(10)
        isDirty = True

    #read debug - preview
    try:
        val = config.get('debug', 'preview')
    except:
        val = "0"
    if val == "1":
        DEBUG_PREVIEW.set(1)

    #read pfad - lokal
    try:
        val = os.path.realpath(config.get('pfad', 'lokal'))
    except:
        val = os.path.dirname(os.path.realpath(__file__)) + os.sep + "slideshow"
    localPath.set(val)

    #try to read the remote URL, if not given, work offline
    try:
        val = config.get('pfad', 'remote')
        remoteURL.set(val)
    except:
        val = None
        remoteURL.set("")
    
    #read energ - mode
    try:
        energyMode.set(int(config.get('energy','mode')))
    except:
        energyMode.set(0)
    
    #read energy - start
    try:
        val = config.get('energy', 'start')
    except:
        val = ""
    energyStart.set(val)
    
    #read energy - stop
    try:
        val = config.get('energy', 'stop')
    except:
        val = ""
    energyStop.set(val)

def writeConfig(configFile=None):
    if configFile == None:
        configFile = os.path.dirname(os.path.realpath(__file__)) + os.sep + "gruene_signale.conf"
    config = configparser.ConfigParser()
    config.read(configFile)

    required_sections = ['bilder','filme','pfad','debug','energy']
    for sect in required_sections:
        if sect not in config.sections():
            config.add_section( sect )

    config.set('bilder','dauer',"%d" % bild_dauer.get())
    config.set('debug', 'preview',"%d" % DEBUG_PREVIEW.get())
    config.set('pfad', 'lokal',localPath.get().strip())
    config.set('pfad', 'remote',remoteURL.get().strip())
    config.set('energy', 'mode', "%d" % energyMode.get())
    config.set('energy', 'start', energyStart.get())
    config.set('energy', 'stop', energyStop.get())

    with open(configFile, 'w') as file:
        config.write(file)


def save():
    global isDirty,inited
    if isDirty == False:
        return;
    writeConfig()
    if checkAutostartfile() == 1 and doAutostart.get() == 0:
        removeAutostart()
    if checkAutostartfile() == 0 and doAutostart.get() == 1:
        createAutostart()
    isDirty=False
    inited=False

def quit():
#    if isDirty == False:
    master.destroy()
    exit(0)


readConfig()

master.minsize(600,300)
master.geometry("800x450+560+300")
master.title("Einstellungen für Grüne Signale")

#register callbacks for entry fields
timeEntryCallback = master.register(validateTimeFields)
anyEntryCallback = master.register(setDirty)

#fixed value for pady and padx used by pack() function
dy=2
dx=4

#add button or notification if Python modules (see above) needs to be installed
row=tk.Frame(master,bd=1,relief=tk.SUNKEN)
lab=tk.Label(row,text="Python Module",width=30,anchor='w')
if len(modules) == 0:
    obj=tk.Label(row,text="installiert",fg="green")
else:
    obj=tk.Button(row,text="Installieren",command=installModules,fg="red")
row.pack(side=tk.TOP,padx=dx,pady=dy,expand=tk.YES,fill=tk.X)
lab.pack(side=tk.LEFT,pady=dy,padx=dx)
obj.pack(side=tk.RIGHT,expand=tk.YES,fill=tk.X,padx=dx)

if checkAutostartfile():
    doAutostart.set(1)

#add autostart checkbox
row=tk.Frame(master,bd=1,relief=tk.SUNKEN)
lab=tk.Label(row,text="Grüne Signale automatisch starten",width=30,anchor='w')
obj=tk.Checkbutton(row,text="aktiv",variable=doAutostart,command=setDirty)
row.pack(side=tk.TOP,padx=dx,pady=dy,expand=tk.YES,fill=tk.X)
lab.pack(side=tk.LEFT,pady=dy,padx=dx)
obj.pack(side=tk.RIGHT,expand=tk.YES,fill=tk.X,padx=dx)

#add entry field for local path
row=tk.Frame(master,bd=1,relief=tk.SUNKEN)
lab=tk.Label(row,text="lokaler Pfad",width=30,anchor='w')
obj=tk.Entry(row,textvariable=localPath,validate="key",validatecommand=(anyEntryCallback, '%P'))
row.pack(side=tk.TOP,padx=dx,pady=dy,expand=tk.YES,fill=tk.X)
lab.pack(side=tk.LEFT,pady=dy,padx=dx)
obj.pack(side=tk.RIGHT,expand=tk.YES,fill=tk.X,padx=dx)

#add entry field for remoteURL
row=tk.Frame(master,bd=1,relief=tk.SUNKEN)
lab=tk.Label(row,text="Remote-URL (leer für Offline-Modus)",width=30,anchor='w')
if inited == True:
    remoteURL.set(introURL)
obj=tk.Entry(row,textvariable=remoteURL,validate="key",validatecommand=(anyEntryCallback, '%P'))
row.pack(side=tk.TOP,padx=dx,pady=dy,expand=tk.YES,fill=tk.X)
lab.pack(side=tk.LEFT,pady=dy,padx=dx)
obj.pack(side=tk.RIGHT,expand=tk.YES,fill=tk.X,padx=dx)

#add scale widget for duration
row=tk.Frame(master,bd=1,relief=tk.SUNKEN)
lab=tk.Label(row,text="Anzeigedauer für Bilder (Sekunden)",width=30,anchor='w')
obj=tk.Scale(row,from_=5,to=120,variable=bild_dauer,orient=tk.HORIZONTAL,command=setDirty)
row.pack(side=tk.TOP,padx=dx,pady=dy,expand=tk.YES,fill=tk.X)
lab.pack(side=tk.LEFT,pady=dy,padx=dx)
obj.pack(side=tk.RIGHT,expand=tk.YES,fill=tk.X,padx=dx)

#add controls for energy savings
row1=tk.Frame(master,bd=1,relief=tk.SUNKEN)
row1.pack(side=tk.TOP,padx=dx,pady=dy,expand=tk.YES,fill=tk.X)

row2=tk.Frame(row1,bd=1,relief=tk.FLAT)
row2.pack(side=tk.TOP,padx=dx,pady=dy,expand=tk.YES,fill=tk.X)

row3=tk.Frame(row1,bd=1,relief=tk.FLAT)
row3.pack(side=tk.TOP,padx=dx,pady=dy,expand=tk.YES,fill=tk.X)
row4=tk.Frame(row1,bd=1,relief=tk.FLAT)
row4.pack(side=tk.TOP,padx=dx,pady=dy,expand=tk.YES,fill=tk.X)

lab=tk.Label(row2,text="Energiesparoptionen",width=30,anchor='w')
obj0=tk.Radiobutton(row2,text="ohne",variable=energyMode,command=setDirty,value=0)
obj1=tk.Radiobutton(row2,text="RasPi ausschalten",variable=energyMode,command=setDirty,value=1)
obj2=tk.Radiobutton(row2,text="Monitor deaktivieren",variable=energyMode,command=setDirty,value=2)
lab.pack(side=tk.LEFT,pady=dy,padx=dx)
obj2.pack(side=tk.RIGHT,expand=tk.YES,fill=tk.X,padx=dx)
obj1.pack(side=tk.RIGHT,expand=tk.YES,fill=tk.X,padx=dx)
obj0.pack(side=tk.RIGHT,expand=tk.YES,fill=tk.X,padx=dx)

lab=tk.Label(row3,text="",width=30,anchor='w')
lab.pack(side=tk.LEFT,pady=dy,padx=dx)
lab=tk.Label(row3,text="um",width=3,anchor='w')
lab.pack(side=tk.LEFT,pady=dy,padx=dx)
obj1=tk.Entry(row3,textvariable=energyStart,validate="key",validatecommand=(timeEntryCallback, '%P','%S'))
obj1.pack(side=tk.LEFT,fill=tk.X,padx=dx)

#lab=tk.Label(row3,text="",width=30,anchor='w')
#lab.pack(side=tk.LEFT,pady=dy,padx=dx)
lab=tk.Label(row3,text="bis",width=3,anchor='w')
lab.pack(side=tk.LEFT,pady=dy,padx=dx)
obj2=tk.Entry(row3,textvariable=energyStop,validate="key",validatecommand=(timeEntryCallback, '%P', '%S'))
obj2.pack(side=tk.LEFT,fill=tk.X,padx=dx)


#add checkbox for Debug Preview Mode
row=tk.Frame(master,bd=1,relief=tk.SUNKEN)
lab=tk.Label(row,text="Debug Preview Modus",width=30,anchor='w')
obj=tk.Checkbutton(row,text="aktiv",variable=DEBUG_PREVIEW,command=setDirty)
row.pack(side=tk.TOP,padx=dx,pady=dy,expand=tk.YES,fill=tk.X)
lab.pack(side=tk.LEFT,pady=dy,padx=dx)
obj.pack(side=tk.RIGHT,expand=tk.YES,fill=tk.X,padx=dx)

#add buttons
row=tk.Frame(master)
saveButton=tk.Button(row,text="Übernehmen",command=save,pady=4,padx=dx)
saveButton.pack(side=tk.LEFT,pady=dy,padx=dx)
quitButton=tk.Button(row,text="Beenden",command=quit,pady=4,padx=dx)
quitButton.pack(side=tk.RIGHT,pady=dy,padx=dx)
row.pack(side=tk.BOTTOM)

master.mainloop()