install.py

DebugSet = False
import sys
import os
import os.path
import apt
import subprocess
import re
import requests
import shutil, glob
import datetime
import time
import argparse
import json
import inspect
   
InstalledCheckingVersion = 10
InstalledAndOK = 0
InstalledButNotOK = 90
NotInst = 99
PackageTypeUnknown = 0
PackageTypeAPT = 1
PackageTypeNPM = 2
PackageTypeManual = 3
HTTPSMetaDriver="https://github.com/jac459/metadriver"
HTTPSPackageDefinitionFile="https://raw.githubusercontent.com/jac459/neeo2021onward/main/packages.json"
MyPackages = []
InstalledCheckingVersion = 10
PKGNPMIndex = -1
PKGNodeRedIndex = -1
InstalledAndOk = 0

#===============================================================================
# Define various  functions
#===============================================================================

#DOC: HandleErrorShowOutput routine
#--> This routine is called when something goes wrong and you want the user to alert and allow the user to review the output of a backgroundcommand 
#--> Input is 3 valuesa: 1): Title, 2) eerrortext, 3) File to showTextInout is the package-name                          
#--> Output is the entire json/array entry
def HandleErrorShowOutput(MyError,GiveError,FileName):
    if DebugSet:
       print("Entering",inspect.stack()[1][3])


    DoWhip = "whiptail --yesno '"+GiveError+"\nClick ok to see output containing the error' --title '"+MyError+"' 10 80"
    if subprocess.call(DoWhip,shell=True)==False: 
       DoWhip = "whiptail --textbox --scrolltext  '"+FileName+"'  40 80"
       subprocess.call(DoWhip,shell=True)

    if DebugSet:
       print("Leaving",inspect.stack()[1][3])

#DOC: CheckDirectory routine
#--> Simple routine  that checks if a file exists and is indeed a directory 9not a file)
def CheckDirectory(TestDir):
    if DebugSet:
       print("Entering",inspect.stack()[1][3])


    if os.path.exists(TestDir) and os.path.isdir(TestDir):
       return 1
    else:
       return 0

    if DebugSet:
       print("Leaving",inspect.stack()[1][3])

#DOC: GetMyPackageFields routine
#--> This routine gets the part of the jsan PAckage definitions for a specific package
#--> Inout is the package-name
#--> Output is the entire json/array entry
def GetMyPackageFields(GetPKG):
    if DebugSet:
       print("Entering",inspect.stack()[1][3])


    for pkg in MyPackages:
        if pkg['name'] == GetPKG:
           return pkg

    DoWhip = "whiptail --title 'Example Dialog' --msgbox 'LOGIC-ERROR! Incorrect package requested "+ GetPKG +  "' 8 78"
    subprocess.call(DoWhip,shell=True)
    return ""

    if DebugSet:
       print("Leaving",inspect.stack()[1][3])

#DOC: CheckAPTPackageInstalled routine
#--> Low level routine that checks the status of an APT package
#--> It just looks up the package name in the APT-cache.
#--> If it installed, it will determine the version that is installed
def CheckAPTPackageInstalled(pkg):
    if DebugSet:
       print("Entering",inspect.stack()[1][3])


    try:
       PkgC = PackageCache[pkg['name']]
    except KeyError:
       PackageCache.close()
       return 0
    if not PkgC.is_installed:
       return 0

    try: 
         Installed_version = PkgC.installed.version
    except AttributeError:
         Installed_version = PkgC.Inst_Vers

    pkg['status'] = InstalledCheckingVersion           #Signal package is installed
    VersionOnly = re.match(r'^[0-9.:]*',Installed_version)
    i = VersionOnly[0].find(':')
    if i != -1:
       Installed=VersionOnly[0][i+1:]
    else:
       Installed=VersionOnly[0]
    pkg['Inst_Vers'] = Installed.strip()


    if DebugSet:
       print("Leaving",inspect.stack()[1][3])
    return 1

#DOC: CheckNPMPackageInstalled routine
#--> Low level routine that checks the status of an NPM  package
#--> If it is a local package (no -g in its install-cmd), it switches to the local directory where the package should be
#--> then it calls npm list against the package
def CheckNPMPackageInstalled(pkg):
    if DebugSet:
       print("Entering",inspect.stack()[1][3])


    if " -g " in pkg['PKGParm']:
       doglob = " -g "
    else:
       doglob = ""
       if CheckDirectory(OriginalHomeDir+"/"+pkg['loc']):        #is this an existing directory?
          os.chdir(OriginalHomeDir+"/"+pkg['loc'])               # yes, switch to the directory
       else:
          return 0

    NPMListCMD = "npm list --no-color "+ doglob+" 2>/dev/null| grep -i " + pkg['name']+"@ 1>" + LogDir + "/BackgroundNPMList.txt "
    Response = subprocess.call(NPMListCMD,shell=True)
    if Response == 0:  # success for npm list
       fp =  open(LogDir + '/BackgroundNPMList.txt')
       Result = fp.readline()
       fp.close()
       pkg['status'] = InstalledCheckingVersion
       MyVersion = Result.split('@')
       if len(MyVersion) > 2:
          VersionOnly  = MyVersion[2].strip()
       else:
          VersionOnly  = MyVersion[1].strip()
       TheVersion  = VersionOnly.split(' ')
       if len(TheVersion)>1:
          pkg['Inst_Vers'] = TheVersion[0]
       else:
          pkg['Inst_Vers'] =  VersionOnly

       if DebugSet:
          print("Leaving",inspect.stack()[1][3])
       return 1
    else:
       AllDepsOK = False

       if DebugSet:
          print("Leaving",inspect.stack()[1][3])
       return 0


#DOC:  TestThisPackage_OK
#--> mid level routine that checks the status of all packages
#--> It only functio0ns as a switch between APT and NPM-packages
#--> The one real thing that happens here is  that it will set AllDepsOK to False if an installation fails.
#--> No further logic. 
def TestThisPackage_OK(pkg):
    if DebugSet:
       print("Entering",inspect.stack()[1][3])

    if pkg['status'] == InstalledAndOK:
       return

    pkg['status'] = NotInst
    if pkg['type']  == PackageTypeAPT:
       Installed = CheckAPTPackageInstalled(pkg)
    elif pkg['type'] == PackageTypeNPM:
       Installed = CheckNPMPackageInstalled(pkg)

    if not Installed:
       AllDepsOK = False
       return

    if  pkg['Inst_Vers'] < pkg['reqvers'].strip():
        pkg['status'] = InstalledButNotOK                #Signal package is installed, but version is too low
        AllDepsOK = False
    else:
        pkg['status'] = InstalledAndOK                   #Signal package is installed with correct version

    if DebugSet:
       print("Leaving",inspect.stack()[1][3])

#DOC: TestPackages_OK routine
#--> High level routine that checks the status of all packages
#--> It opens a cache for APT, to speed up verification 
#--> Then it goes over all packages and calls a subroutine to check that specific package
def TestPackages_OK(Silent = False):
    global AllDepsOK
    global CheckedDependenciesAlready
    if DebugSet:
       print("Entering",inspect.stack()[1][3])


    CheckedDependenciesAlready = True
    AllDepsOK = True
    ChangedDir = False                                          # assume we'll stay in the current directory
    if not Silent:
       print("")
       print("Checking installation status of all packages, this may take some time")
       print("")

    PackageCache.open()

    for pkg in MyPackages:
        TestThisPackage_OK(pkg)

    os.chdir(CurrDir)                                       #Return to the original directory , as we may have changed while testing NPM-packages
    PackageCache.close()

    if DebugSet:
       print("Leaving",inspect.stack()[1][3])

    return AllDepsOK

#DOC: DisplayPrimaryMenu routine
#--> The main menu routine, displays options available in this phase of execution of the installer.
#--> Initially, opnly a small set pf functions is available
#--> As sopon as the installer has checked which packages are installed,all options become available. 
#--> No Silent-mode
def DisplayPrimaryMenu():
    global CheckedDependenciesAlready
    global AllDepsOK

    if DebugSet:
       print("Entering",inspect.stack()[1][3])
       print("DisplayPrimaryMenu")

    if CheckedDependenciesAlready == False:
       DoWhip = "whiptail --title 'Raspberry pi configurator for NEEO' --menu '"
       for pkg in MyPackages:
                  Content = "\nRequired: " + pkg['name'][0:17] + " " + pkg['reqvers']
                  Content = Content.ljust(40, ' ')
                  if  pkg['type'] ==  PackageTypeAPT:
                      Content += " APT "
                  elif  pkg['type'] ==  PackageTypeNPM:
                      Content += " NPM "
                  Content +=  " Not checked yet"
                  DoWhip +=  Content
       DoWhip += "\n\nSetup Options' 45 70 10 " + \
              " --cancel-button Finish --ok-button Select  \
             '1 Check' 'Check packages'    \
             '7 examples' 'Refresh examples in Activated directory'  \
             'X Exit' 'Exit the program'  2>" + LogDir + "/Mainmenu.txt"
    else:
       DoWhip = "whiptail --title 'Raspberry pi configurator for NEEO' --menu  'Package status:\n\n"
       for pkg in MyPackages:
                  Content = "Required: " + pkg['name'][0:17] + " " + pkg['reqvers']
                  Content = Content.ljust(40, ' ')
                  if  pkg['type'] ==  PackageTypeAPT:
                      Content += " APT "
                  elif  pkg['type'] ==  PackageTypeNPM:
                      Content += " NPM "
                  if  pkg['status']  == InstalledAndOK:
                      Content += "Found:  "+ pkg['Inst_Vers']  + " --> OK\n"
                  elif  pkg['status'] == InstalledButNotOK:
                      Content += "Found:  " + pkg['Inst_Vers'] + " --> Version is too low\n"
                  else:
                      Content +=  "Not found --> Need to install\n"
                  DoWhip +=  Content
       DoWhip +=   "Setup options\n' 45 78 15 " + \
             " --cancel-button Finish --ok-button Select "\
             "'1 Check' 'Check packages installation status'   \
             '2 Install' 'Install missing packages' \
             '7 examples' 'Refresh examples in Activated directory'  \
             'S Startup' 'Create autostart for all installed packages'  \
             '8 Simple' 'Simply install all of the above'  \
             'X Exit' 'Exit the program'"
       DoWhip += " 2>" + LogDir + "/Mainmenu.txt"  
#             'n Startup' 'Create autostart for all nodered'  \
    if DebugSet:
       print(DoWhip)
    Response = subprocess.call(DoWhip,shell=True)
    if Response == 0:
       fp =  open(LogDir + '/Mainmenu.txt')
       Choice = fp.readline()
       fp.close()
       return  Choice
    else:
       print("User cancelled the dialog")
       Do_Exit(0)
       return "@"  # signal somethiong is wrong with the main menu

    if DebugSet:
       print("Leaving",inspect.stack()[1][3])

#DOC: Do_Install_dependencies routine
#--> High level install-routine 
#--> Presents select menu with all packages that are not yet installed and on the correct level. User can then select which packages to install.
#--> In case of Silent install, it just selects all packages that need to be installed/updated.

#--> Second phase is to call the installation routine to verify dependencies and install package 
def Do_Install_dependencies(Silent):

    if DebugSet:
       print("Entering",inspect.stack()[1][3])

    if Silent:
       DoThis = ""
       for pkg in MyPackages:
           DoThis  = DoThis + '"' +  pkg['name'] + '" '
    else:
       DoThis = SelectPackageToInstall()

    InstalledSomething = False
    if type(DoThis) == type(None) or DoThis.strip() == "":
       return

    for ThisPackage in DoThis.split('"'):
        if ThisPackage.strip() != "":
           pkg = GetMyPackageFields(ThisPackage.strip())        # lookup extra parms, now we only have the name of the pac kage, not the actual array
           InstallPackage(pkg,Silent)                                  # install the package
           PackageCache.update()

    if DebugSet:
       print("Leaving",inspect.stack()[1][3])

def DoAPTUpdate():
    if DebugSet:
        print("Entering",inspect.stack()[1][3])

    APTUpdateCMD = "apt update -y 1>" + LogDir + "/BackgroundAPTUpdate.txt"
    Response = subprocess.call(APTUpdateCMD,shell=True)
    if Response == 0:
       fp =  open(LogDir + '/BackgroundAPTUpdate.txt')
       Result = fp.readline()
       fp.close()
       #print("Did an apt update",Result) 

       if DebugSet:
          print("Leaving",inspect.stack()[1][3])
       return 


    if DebugSet:
       print("Leaving",inspect.stack()[1][3])
#DOC: InstallPackageAPT routine
#--> Low level install-routine for APT-packages only 
#--> Handles Dependency checking and if all are okay, calls ther actual APT- or NPM-install routine.def InstallPackageAPT(pkg,Silent):
#--> Always uses root (we run as root, so it does not lower it's access-rights)
    global PackageCache
    if DebugSet:
       print("Entering",inspect.stack()[1][3])


    APTAddPackageCMD = "apt install -y "+ pkg['name'] + " 1>" + LogDir + "/BackgroundAPTInstall" + pkg['name'] + ".txt"
    if not Silent:
       print(APTAddPackageCMD)
    Response = subprocess.call(APTAddPackageCMD,shell=True)
    if Response:
       HandleErrorShowOutput("Error APT-install","Could not install package "+ pkg['name'], LogDir + "/BackgroundAPTInstall" + pkg['name'] + ".txt" )
       print("Done apt install",Result)
    else:
       PackageCache.close()  
       PackageCache  = apt.cache.Cache()
       PackageCache.open()
       TestThisPackage_OK(pkg)

    return Response 

    if DebugSet:
       print("Leaving",inspect.stack()[1][3])

#DOC: InstallPackageNPM routine
#--> Low level install-routine for NPM-packages only 
#--> Handles Dependency checking and if all are okay, calls ther actual APT- or NPM-install routine.
#--> Uses root (we run as root, so it does not lower it's access-rights) if it is a globally installed package (-g parm), otherwise lowers rights first to original userid
def InstallPackageNPM(pkg,Silent):
    if DebugSet:
       print("Entering",inspect.stack()[1][3])


    MyLoc = ""
    if pkg['loc'] != "":              # Do we need to install it on a specific location?
       print("Checking custom location now",pkg['loc'])
       InstallDir = OriginalHomeDir+"/"+pkg['loc']
       MyLoc = " --prefix " + '"' + InstallDir + '"' + " "
       if os.path.isdir(InstallDir) == False:
          DoMKDirCMD = MySudo +  "mkdir  "  + '"' + InstallDir + '"' + " 2>"+ LogDir + "/BackgroundMkdir.txt'"
          Response = subprocess.call(DoMKDirCMD,shell=True)
          if Response:
             print("Fatal error ocurred  when creating directory for  package:",pkg['name'],InstallDir)
             Do_Exit(12)

    if pkg['PackageUSER'] != "":
       APTNPMPackageCMD =  pkg['PKGParm'] +  " "  +  MyLoc  + " " + pkg['PKGParm2'] + "  2>" + LogDir + "/BackgroundNPMInstall.txt"
    else:
      APTNPMPackageCMD = MySudo + "export HOME="+OriginalHomeDir + "&& " +  pkg['PKGParm'] +  " --no-color "  +  MyLoc  + " " + pkg['PKGParm2'] + "  2>>" + LogDir + "/BackgroundNPMInstall.txt'"

    if not Silent:
       print(APTNPMPackageCMD)
    Response = subprocess.call(APTNPMPackageCMD,shell=True)

    if Response:
       HandleErrorShowOutput("Error NPM-install","Could not install package "+ pkg['name'], LogDir + "/BackgroundNPMInstall.txt" )
    TestThisPackage_OK(pkg)                     # Refresh status of this package 
    return Response


    if DebugSet:
       print("Leaving",inspect.stack()[1][3])

#DOC: InstallPackage routine
#--> High level install-routine 
#--> hHandles Dependency checking and if all are okay, calls ther actual APT- or NPM-install routine.
def InstallPackage(pkg,Silent):                           # High level install-routine;  handles Dependency checking and if all are okay, calls ther actual APT- or NPM-install routine.
    global DidAPTUpdate
    if DebugSet:
       print("Entering",inspect.stack()[1][3])

    InstalledSomething = False
    if DidAPTUpdate == False:
       DidAPTUpdate = True
       DoAPTUpdate()

    if pkg['mydep']!= "":
       for dep in pkg['mydep']:
           FoundDep = False
           for Testpkg in MyPackages: 
               if  Testpkg['name'] == dep:
                   if Testpkg['status'] != InstalledAndOK:
                      DoWhip = "whiptail --title 'Missing dependencies'  --msgbox 'Not all packages that are required for "+  pkg['name'] + " are installed.\n\n\nMissing:" +  dep  + "'  25 80 70 "
                      subprocess.call(DoWhip,shell=True)
                      return
                   else: 
                      FoundDep = True
                      break 
           if not FoundDep:
              DoWhip = "whiptail --title 'Missing  dependencies'  --msgbox '"+ pkg['name'] + "Has an unknown package defined as dependency:\n\n\n:" +  dep  + "'  25 80 70 "
              subprocess.call(DoWhip,shell=True)
              return

    if pkg['type'] == PackageTypeAPT:   #Is this an APT-package?
       Response =  InstallPackageAPT(pkg,Silent)
    elif pkg['type'] == PackageTypeNPM:   #Is this an NPM-package?
       Response =  InstallPackageNPM(pkg,Silent)


    if DebugSet:
       print("Leaving",inspect.stack()[1][3])
#DOC: SelectPackageToInstall 
#--> "Gui" that shows packages that need to be installed or updated 
def SelectPackageToInstall():             
    if DebugSet:
       print("Entering",inspect.stack()[1][3])


    DoWhip = "whiptail --title 'Install dependencies'   --checklist  'Select packages you want to be installed'  25 78 15 "
    MyIndex = 0
    for pkg in MyPackages:
       if  pkg['status']  != InstalledAndOK:
           Content = "'"+ pkg['name'] + "' '" + pkg['name'] + " " + pkg['reqvers']  +  "' "
           Content = Content.ljust(35, ' ') + "ON "
           DoWhip +=  Content
       MyIndex += 1
    DoWhip += " 2>" + LogDir + "/BackgroundPackageToInstall.txt"
    Response = subprocess.call(DoWhip,shell=True)
    if Response == 0:
       fp =  open(LogDir + '/BackgroundPackageToInstall.txt')
       Choice = fp.readline()
       fp.close()
       return Choice


    if DebugSet:
       print("Leaving",inspect.stack()[1][3])
#DOC: Do_Check_dependencies
#--> A bit of an empty shell. It just calls TestPackages_OK
#--> It's here to follow the naming conventions from the primary menu. 
def Do_Check_dependencies(Silent):
    if DebugSet:
       print("Entering",inspect.stack()[1][3])
        
        
    TestPackages_OK(Silent)

    if DebugSet:
       print("Leaving",inspect.stack()[1][3])
#DOC: Do_ListDependencies
#--> Processor for  the --List argument: Silently print what packages are installed and what versions 
def Do_ListDependencies(Silent):
    if DebugSet:
       print("Entering",inspect.stack()[1][3])


    TestPackages_OK(Silent)

    data = {}
    for pkg in MyPackages:
        data[pkg['name']] = []
        data[pkg['name']].insert(1, { 'name': pkg['name']})
        data[pkg['name']].insert(0, { 'status': str(pkg['status']) })
        data[pkg['name']].insert(0, { 'dependency': str(pkg['mydep']) })
        data[pkg['name']].insert(0, { 'Inst_Vers': pkg['Inst_Vers']  })

    print(json.dumps(data,sort_keys=True, indent=4, separators=(',', ': ')))


    if DebugSet:
       print("Leaving",inspect.stack()[1][3])
#DOC: HandleChoice
#-->  Checks what is selectyed on the primary menu and call the corresponding function 
def HandleChoice(i,Silent=False):
    if DebugSet:
       print("Entering",inspect.stack()[1][3])


    switcher = {
            "1": lambda: Do_Check_dependencies(Silent),
            "2": lambda: Do_Install_dependencies(Silent),
            "7": lambda: Do_Refresh_NEEOCustom(Silent),
            "8": lambda: Do_It_All(Silent),
            "s": lambda: Do_SetupStartups(Silent),
            "S": lambda: Do_SetupStartups(Silent),
#            "n": lambda: Do_SetupServiceNodeRed(Silent),
#            "N": lambda: Do_SetupServiceNodeRed(Silent),
            "L": lambda: Do_ListDependencies(Silent),
            "x": lambda: Do_Exit(0),
            "X": lambda: Do_Exit(0)
        }
    func = switcher.get(i[0], lambda: 'Invalid')
    func()


    if DebugSet:
       print("Leaving",inspect.stack()[1][3])
#DOC: Do_SetupStartups
#-->  Routine for creating startup parameters for the installed packages
def Do_SetupStartups(Silent):
    if DebugSet:
       print("Entering",inspect.stack()[1][3])

    for pkg in MyPackages:
        if pkg['status'] == InstalledAndOk  and len(pkg['startcmd']) > 0:
           if not Silent:
              print("Setting up startup for",pkg['name'],": ",pkg['startcmd'])
           if len(pkg['delstartcmd']) > 0:
              PipeFile =  LogDir + "/BackgroundDeleteStart_"+ pkg['name'] + ".txt"
              for StartupCMD in pkg['delstartcmd']:
                  DoMKDirCMD = StartupCMD +  " 1>>"+ PipeFile
                  if not Silent:
                     print(DoMKDirCMD)
                  subprocess.call(DoMKDirCMD,shell=True)                  # no error checking, because  the package may not have been added as stratup
           PipeFile =  LogDir + "/BackgroundSetupStart_"+ pkg['name'] + ".txt"
           if  os.path.isfile(PipeFile):
               os.remove(PipeFile)                                       # remove outputfile
           for StartupCMD in pkg['startcmd']:
               DoMKDirCMD = StartupCMD +  " 1>>"+ PipeFile
               if not Silent:
                  print(DoMKDirCMD)
               Response = subprocess.call(DoMKDirCMD,shell=True)
               if Response:
                  print("Fatal error ocurred in Startupcmd",StartupCMD,"for  package:",pkg['name'],PipeFile)
                  Do_Exit(12)


    if DebugSet:
       print("Leaving",inspect.stack()[1][3])
#DOC: Do_RenameDir
#-->  A general rename directory routine
def Do_RenameDir(srcDir,destDir):
    if DebugSet:
       print("Entering",inspect.stack()[1][3])

    try:
        os.rename(srcDir,destDir)
    except EnvironmentError:
       DoError = "whiptail --title 'SAVE-Dialog' --yesno  'Error renaming old archive dikrecxtory' 8 78 "
       subprocess.call(DoError,shell=True)
       Do_Exit(12)


    if DebugSet:
       print("Leaving",inspect.stack()[1][3])
#DOC: Do_GetMetaLibrariesfromGithub 
#-->  Routine to download the entire metadriver from github; only 2 directories are used however by routines following this one: activated and deactivated
def Do_GetMetaLibrariesfromGithub():
    if DebugSet:
       print("Entering",inspect.stack()[1][3])

    UniqueName = datetime.datetime.now().strftime("%Y-%m%d %H.%M.%S")                          # prepare to geta unique archive-name for directories
    GitDir = OriginalHomeDir+"/GIT "+ UniqueName
    os.mkdir(GitDir, mode=0o755 )

    DoGetGit = "git clone '"+ HTTPSMetaDriver + "' -b 'master' '" + GitDir +"' 2>"+  LogDir + "/BackgroundGitCone.txt"
    print(DoGetGit)
    Response = subprocess.call(DoGetGit,shell=True)
    if Response:
       print("Seems like an error has occured in GIT clone")
       HandleErrorShowOutput("Error", "Error obtaining new Activated and deactivate directory!!\nYour saved activated and deactivated directories will be restore to metadriver-directory",LogDir + "/BackgroundGitCone.txt" )
       return ""
    return GitDir+"/"


    if DebugSet:
       print("Leaving",inspect.stack()[1][3])
#DOC: Do_Copy
#-->  General purpose routine that copies a source-directory (and subdirectories) to a destination.
#-->  Once copied, it removes the entire tree from sourcdir
def Do_Copy(src, dst, symlinks=False, ignore=None):
    if DebugSet:
       print("Entering",inspect.stack()[1][3])

    print("Do_Copy %s %s",src,dst)
    if not os.path.exists(dst):
        os.makedirs(dst)
    for item in os.listdir(src):
        s = os.path.join(src, item)
        d = os.path.join(dst, item)
        if os.path.isdir(s):
            copytree(s, d, symlinks, ignore)
        else:
            if not os.path.exists(d) or os.stat(s).st_mtime - os.stat(d).st_mtime > 1:
                shutil.copy2(s, d)


    if DebugSet:
       print("Leaving",inspect.stack()[1][3])
#DOC: Do_MoveNoReplace
#-->  General purpose routine that move files (and directories) from  a source-directory to a destination. It will NOT overwrite any files in the destination.
def Do_MoveNoReplace(InSrcDir,InDestDir):
    if DebugSet:
       print("Entering",inspect.stack()[1][3])


    print("Do_MoveNoReplace",InSrcDir, InDestDir)
    for src_dir, dirs, files in os.walk(InSrcDir):
       dst_dir = src_dir.replace(InSrcDir, InDestDir, 1)
       if not os.path.exists(dst_dir):
           os.makedirs(dst_dir)
       for file_ in files:
           src_file = os.path.join(src_dir, file_)
           dst_file = os.path.join(dst_dir, file_)
           if os.path.exists(dst_file):
               #  Same file alreadcy in DestDir, don't move it.
              continue
           shutil.move(src_file, dst_dir)


    if DebugSet:
       print("Leaving",inspect.stack()[1][3])
#DOC: Do_SaveHouseKeepingThisDir
#-->  Routine that moves files (and directories) from  a source-directory to an arc hive/staging  destination.
def Do_SaveHouseKeepingThisDir(SrcDir,TypeDir,DestDir):
    if DebugSet:
       print("Entering",inspect.stack()[1][3])


    UniqueName = datetime.datetime.now().strftime("%Y-%m%d %H.%M.%S")                          # prepare to geta unique archive-name for directories
    for file in os.listdir(SrcDir+TypeDir):                       # Do we even have a meta0directory with this subdir (TypeDir: activated or deactivated)
                                                                  # Yes, now Check to see if there is an activated directory in the meta-directory.MetaActivatedDir
       if os.path.isdir(DestDir):                                 # Check to see if Save-directory already exists (~/SaveMetaInstall)
           if os.path.isdir(DestDir+TypeDir):                    # Yes, it exists... do we have this directory ( parm TypDir = "activated" or "deactivated") in  there?
              Do_RenameDir(DestDir+TypeDir,DestDir+TypeDir+" "+UniqueName)   # rename it to an archive name (~/SaveMetaInstall/archive ttttmmdd : hh:mm:ss)
       else:
           os.mkdir(DestDir, mode=0o755 )
       return 1
    return 0


    if DebugSet:
       print("Leaving",inspect.stack()[1][3])
#DOC: Do_SaveHouseKeeping
#-->  High level routine that moves files (and directories) from  a source-directory to an archive/staging  destination.
#--> In essence, it's just a driver for Do_SaveHouseKeepingThisDir for both the activated and the deactivated directory
def Do_SaveHouseKeeping(MetaDir,SaveDir):
    if DebugSet:
       print("Entering",inspect.stack()[1][3])


    Do_SaveHouseKeepingThisDir(MetaDir, "activated",SaveDir)
    Do_SaveHouseKeepingThisDir(MetaDir, "deactivated",SaveDir)


    if DebugSet:
       print("Leaving",inspect.stack()[1][3])
#DOC: Do_SaveHouseKeeping
#-->  High level routine that moves files (and directories) from  a source-directory to an archive/staging  destination.
#-->  Here, a different routione is called if files are allowed to be overwritten or not
def Do_MoveThisDir(SrcDir,TypeDir,DestDir,ReplaceParm):
    if DebugSet:
       print("Entering",inspect.stack()[1][3])


    if ReplaceParm:
       Do_Copy(SrcDir+TypeDir,DestDir+TypeDir)
    else:
       Do_MoveNoReplace(SrcDir+TypeDir,DestDir+TypeDir)


    if DebugSet:
       print("Leaving",inspect.stack()[1][3])
#DOC: Do_MoveDirs
#-->  High level routine that moves files (and directories) from  a source-directory to an archive/staging  destination.
#--> In essence, it's just a driver for Do_MoveThisDir for both the activated and the deactivated directory
def Do_MoveDirs(SrcDir,DestDir,ReplaceParm):
    if DebugSet:
       print("Entering",inspect.stack()[1][3])


    Do_MoveThisDir(SrcDir, "activated",DestDir,ReplaceParm)
    Do_MoveThisDir(SrcDir, "deactivated",DestDir,ReplaceParm)


    if DebugSet:
       print("Leaving",inspect.stack()[1][3])
#DOC: Do_Refresh_NEEOCustom
#-->  High level routine that handles the refresh examples directories.
def Do_Refresh_NEEOCustom(Silent):
    if DebugSet:
       print("Entering",inspect.stack()[1][3])


    global SaveDir 
    MetaDir = OriginalHomeDir+"/.meta/node_modules/@jac459/metadriver/"
    SaveDir = OriginalHomeDir+"/.SaveMetaInstall/"

    Do_SaveHouseKeeping(MetaDir,SaveDir)                                # first, some housekeeping on .SaveMetaInstall
    Do_MoveDirs(MetaDir,SaveDir,True)                                   # Now move ALL files from meta to .SaveMetaInstall (True means replace)

    GitDir = Do_GetMetaLibrariesfromGithub()
    if GitDir == "":
        return
    Do_MoveDirs(GitDir,MetaDir,True)                                    # Now move ALL files from meta to .SaveMetaInstall (True means replace
    Do_MoveDirs(SaveDir,MetaDir,False)                                  # Next, move back all files that were saved into the neew Meta-directory, without REPLACING ANYONE  (False)
    shutil.rmtree(GitDir)


    if DebugSet:
       print("Leaving",inspect.stack()[1][3])
#DOC: Do_It_All
#-->  High level routine that handles the silent  --InstallAndStart
def Do_It_All():
    if DebugSet:
       print("Entering",inspect.stack()[1][3])


    Print("Now just run through all the options.")



    if DebugSet:
       print("Leaving",inspect.stack()[1][3])
#DOC: SetAccessRights
#-->  Set the access rights to the user on a couple of directories (and files in it)
def SetAccessRights(ThisDir):
    if DebugSet:
       print("Entering",inspect.stack()[1][3])


    for root, dirs, files in os.walk(ThisDir):
        for TheDir in dirs:
            os.chown(os.path.join(root, TheDir), OriginalUID,  OriginalGID)
        for file in files:
            os.chown(os.path.join(root, file), OriginalUID,  OriginalGID)
    if os.path.isdir(ThisDir):
       os.chown(ThisDir, OriginalUID,  OriginalGID)


    if DebugSet:
       print("Leaving",inspect.stack()[1][3])
#DOC: Do_Exit
#-->  Generic exit routine. 
#--> Mainly used to Set accessrights good when the program somehow needs to stop (planned or not planned)
def Do_Exit(RC):                                                        #exit, but first set  logdirectory+fils in it to original user&group
    if DebugSet:
       print("Entering",inspect.stack()[1][3])


    SetAccessRights(LogDir)                                             #Before we say goodbye, we set accessrights on some folders to or own user
    SetAccessRights(SaveDir) 
    sys.exit(RC)


    if DebugSet:
       print("Leaving",inspect.stack()[1][3])
#DOC: DoSomeInit
#-->  Generic initialisation routine. 
#--> Mainly used to Set accessrights good when the program somehow needs to stop (planned or not planned)
def DoSomeInit():
    if DebugSet:
       print("Entering",inspect.stack()[1][3])

    global OriginalUsername
    global OriginalHomeDir
    global OriginalUID
    global OriginalGID
    global PackageCache
    global InstallDir
    global LogDir
    global CurrDir
    global MySudo 
    global SaveDir
    global MyPackages

    MyUsername = os.environ['USER']
    if MyUsername!='root':
       print("please call this program with elevated rights (sudo xxx)")
       sys.exit(12)                                              # Do_Exit() will notwork, since we do not have variable LOGDIR defined yet.
    OriginalUsername = os.environ['SUDO_USER']

    CheckArgs()                                                  # Let's first check if we have optional arguments passed to us

    DoThis = "getent passwd '" + OriginalUsername + "'  | cut -d: -f3,4,6 >BackgroundGetUserProperties.txt"
    Response = subprocess.call(DoThis,shell=True)                #get originalo users homedir, GID en UID from /etc/passwd file
    if Response == 0:
       fp =  open('BackgroundGetUserProperties.txt')
       LineIn = fp.readline()
       Fields = LineIn.split(':')
       OriginalUID     = int(Fields[0])
       OriginalGID     = int(Fields[1])
       OriginalHomeDir = Fields[2].strip('\n')
       fp.close()
    else:
       print("Fatal error ocurred  when accessing properties of original userid",OriginalUsername)
       Do_Exit(12)

    import requests
    import urllib

    MyPackageFile = "packages.yml"
    urllib.request.urlretrieve(HTTPSPackageDefinitionFile, filename=MyPackageFile)

    with open(MyPackageFile) as json_file:
        MyPackages = json.load(json_file)


    SaveDir = OriginalHomeDir+"/.SaveMetaInstall/"
    CurrDir = os.getcwd()                                        #what's the current directory
    LogDir =  CurrDir +  "/log"
    MySudo =  "su -m "+ OriginalUsername + " -c '"
    if os.path.isdir(LogDir) == False:                           # Check to see if LOG-directory already exists (~/log)
       DoMKDIRLog = MySudo + "mkdir  "+ LogDir + " 2>BackgroundMkdirLog.txt'"   # No, so create it
       print(DoMKDIRLog)
       Response = subprocess.call(DoMKDIRLog,shell=True)
       if Response == 0:
          fp =  open('BackgroundMkdirLog.txt')
          LineIn = fp.readline()
          print(LineIn)
          fp.close()
       else:
          print("Fatal error ocurred  when installing metadriver")
          Do_Exit(12)

    InstallDir = OriginalHomeDir+"/.meta"
    PackageCache  = apt.cache.Cache()


    if DebugSet:
       print("Leaving",inspect.stack()[1][3])
#DOC:  Handle the functions initiated via command line parameters 
def Do_Silent_Commands():
    if DebugSet:
       print("Entering",inspect.stack()[1][3])


    if MyArgs.Install:
       HandleChoice(1,True)

    if MyArgs.InstallAndStart:
       HandleChoice(1,True) 

    if  MyArgs.List:
       HandleChoice("L",True) 


    if DebugSet:
       print("Leaving",inspect.stack()[1][3])
#DOC:  Setup parser for command line parameters 
def CheckArgs():
    if DebugSet:
       print("Entering",inspect.stack()[1][3])


    global MyArgs       
    parser = argparse.ArgumentParser(description='NEEO custom devicedriver host builder')
    parser.add_argument(
        '--Install',
        action='store_true',
        help='No menu will be displayed, just executes functions 1, 2 and S, resulting in a fully installed host, but without refreshing the "activated" and "deactivated" directories'
    )
    parser.add_argument(
        '--InstallAndStart',
        action='store_true',
        help='No menu will be displayed, just executes functions 1, 2 and S, resulting in a fully installed host, but without refreshing the "activated" and "deactivated" directories'
    )
    parser.add_argument(
        '--List',
        action='store_true',
        help='No menu will be displayed, just executes functions 7. This will  return an overview of all required packages with their install-status and -version (format: JSON).'
    )

    MyArgs = parser.parse_args()


    if DebugSet:
       print("Leaving",inspect.stack()[1][3])
def MyMain():
   global DidAPTUpdate 
   global AllDepsOK
   global CheckedDependenciesAlready
   if DebugSet:
      print("Entering",inspect.stack()[1][3])

   AllDepsOK = False
   CheckedDependenciesAlready = False      
   DoSomeInit() 
   GoOn = True
   DidAPTUpdate = False

   if MyArgs.Install or MyArgs.InstallAndStart  or MyArgs.List :
      Do_Silent_Commands()
      GoOn = False

    
   while GoOn == True:
       MenuChoice = DisplayPrimaryMenu()
       if MenuChoice == "@":                        # fatal error while displaying main menu
           GoOn = False
           continue
       else:
           HandleChoice(MenuChoice)
       
   if DebugSet:
      print("Leaving",inspect.stack()[1][3])
# Driver program

if __name__ == "__main__":
   MyMain()