v1.0.0

Author: wastis

README.md

@@ -2,10 +2,30 @@
 
 Kodi addon to execute shell scripts or commands. It displays a menu to select the script that shall be executed. The menu is defined in a text file, that is ":" separated (see example.menu). The menu file can be selected in the addon settings.
 
-[Version 0.9.1](https://github.com/wastis/LinuxAddonRepo)
+[Version 1.0.0](https://github.com/wastis/LinuxAddonRepo)
 
 <img src="resources/media/icon.png" alt="drawing" width="200"/> 
 
+## Menu file
+
+The menu file defines the menu items, script success flags and the command. It is a colon delimited table file, that can be assigned in the addon settings.
+
+	Name 1:flags:command 1
+	Name 2:flags:command 1
+	....	
+
+The flags are comma separated. Currently there are two flags defined
+
+- notify	 (*displays a notification window, when the script has ended*)
+- exitcode value (*checks if the return value of the script equals value. Displays a message box if it does not match.*)
+
+### example.menu
+	Backup addon data:notify:/bin/tar -czf ~/kodi_addon_data.tgz ~/.kodi/userdata/addon_data
+	Backup keymaps::/bin/tar -czf ~/kodi_keymaps.tgz ~/.kodi/userdata/keymaps
+	Backup userdata	::/bin/tar -czf ~/kodi_userdata.tgz ~/.kodi/userdata
+	Ping Server:notify,exitcode 0:ping -c 1 192.168.1.1
+
+
 2022 wastis
 
 

addon.xml

@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
-<addon id="script.shellscript.launcher" name="Shell Script Launcher" version="0.9.1" provider-name="wastis">
+<addon id="script.shellscript.launcher" name="Shell Script Launcher" version="1.0.0" provider-name="wastis">
 	<requires>
 		<import addon="xbmc.python" version="3.0.0"/>
 	</requires>
@@ -9,16 +9,23 @@
 	<extension point="xbmc.addon.metadata">
 		<platform>linux</platform>
 		<summary lang="en">Execute Shell Scripts</summary>
-		<summary lang="de_DE">Führt Shellscripte aus</summary>
-		<description lang="en">It displays a script selection menu. The menu is defined in a text file, that is ":" separated (see example.menu in addon folder).</description>
-		<description lang="de_DE">Zeigt ein Scriptauswahlmenü zum Ausführen von Scripten an. Das Menü ist in einer Textdatei definiert (siehe example.menu im Addonverzeichnis).</description>
+		<summary lang="de_DE">Führt Shellprogramme aus</summary>
+		<description lang="en">It displays a script selection menu. The menu is defined in a text file (see README.md).</description>
+		<description lang="de_DE">Zeigt ein Auswahlmenü zum Ausführen von Programmen an. Das Menü ist in einer Textdatei definiert (siehe README.md).</description>
 		<license>GPL-3.0-or-later</license>
 		<source></source>
 		<disclaimer lang="en_GB"></disclaimer>
 		<disclaimer lang="de_DE"></disclaimer>
 		<news>
+
+v1.0.0
+- removed blocking flag as non blocking it produced zombie processes
+- introduced flags notify, exitcode
+- improved error handling
+
 v0.9.1
 - added skins 
+
 v0.9.0 
 - Initial Version</news>
 		<assets>

example.menu

@@ -1,3 +1,4 @@
-backup addon data	:blocking	:	/bin/tar -czf ~/kodi_addon_data.tgz ~/.kodi/userdata/addon_data
-backup keymaps		:			:	/bin/tar -czf ~/kodi_keymaps.tgz ~/.kodi/userdata/keymaps
-backup userdata		:			:	/bin/tar -czf ~/kodi_userdata.tgz ~/.kodi/userdata
+Backup addon data:notify:/bin/tar -czf ~/kodi_addon_data.tgz ~/.kodi/userdata/addon_data
+Backup keymaps::/bin/tar -czf ~/kodi_keymaps.tgz ~/.kodi/userdata/keymaps
+Backup userdata	::/bin/tar -czf ~/kodi_userdata.tgz ~/.kodi/userdata
+Ping Server:notify,exitcode 0:ping -c 1 192.168.1.1

resources/language/resource.language.de_de/strings.po

@@ -15,3 +15,43 @@ msgctxt "#32006"
 msgid "menu file"
 msgstr "Menüdatei"
 
+msgctxt "#32100"
+msgid "Menu File Error"
+msgstr "Menüdatei Fehler"
+
+msgctxt "#32101"
+msgid "Menu file not found. Please select a file in the addon settings. Please visit https://github.com/wastis/ShellScriptLauncher for more information."
+msgstr "Menüdatei wurde nicht gefunden. Bitte wähle Sie eine Menüdatei in den Addon-Einstellungen aus. Besuchen sie auch https://github.com/wastis/ShellScriptLauncher für weitere Informationen."
+
+msgctxt "#32102"
+msgid "Menu file is a directory. Please select a file in the addon settings. Please visit https://github.com/wastis/ShellScriptLauncher for more information."
+msgstr "Menüdatei ist ein Verzeichnis. Bitte wähle Sie eine Menüdatei in den Addon-Einstellungen aus. Besuchen sie auch https://github.com/wastis/ShellScriptLauncher für weitere Informationen."
+
+msgctxt "#32103"
+msgid "Cannot access menu file, permission problem."
+msgstr "Kann nicht auf Menüdatei zugreifen, Berechtigungsprobleme."
+
+msgctxt "#32104"
+msgid "Please see Kodi log for more information."
+msgstr "Bitte sehen Sie die Kodi Logdatei für weitere Informationen ein."
+
+msgctxt "#32105"
+msgid "Menu file is empty or might not have the correct format. Please visit https://github.com/wastis/ShellScriptLauncher for more information."
+msgstr "Menüdatei ist leer oder hat das falsche Format. Besuchen sie auch https://github.com/wastis/ShellScriptLauncher für weitere Informationen."
+
+
+msgctxt "#32110"
+msgid "Command Error."
+msgstr "Befehlsfehler."
+
+msgctxt "#32111"
+msgid "Error executing command: %s"
+msgstr "Fehler beim Ausführen des Befehls: %s"
+
+msgctxt "#32112"
+msgid "Execution completed."
+msgstr "Ausführung abgeschlossen."
+
+msgctxt "#32113"
+msgid "%s did not return the expected value. Error code: %s"
+msgstr "%s hat nicht den erwarteten Wert zurückgeliefert. Fehlerwert: %s"

resources/language/resource.language.en_gb/strings.po

@@ -12,3 +12,44 @@ msgstr "General"
 msgctxt "#32006"
 msgid "menu file"
 msgstr "menu file"
+
+msgctxt "#32100"
+msgid "Menu File Error"
+msgstr "Menu File Error"
+
+msgctxt "#32101"
+msgid "Menu file not found. Please select a file in the addon settings. Please visit https://github.com/wastis/ShellScriptLauncher for more information."
+msgstr "Menu file not found. Please select a file in the addon settings. Please visit https://github.com/wastis/ShellScriptLauncher for more information."
+
+msgctxt "#32102"
+msgid "Menu file is a directory. Please select a file in the addon settings. Please visit https://github.com/wastis/ShellScriptLauncher for more information."
+msgstr "Menu file is a directory. Please select a file in the addon settings. Please visit https://github.com/wastis/ShellScriptLauncher for more information."
+
+msgctxt "#32103"
+msgid "Cannot access menu file, permission problem."
+msgstr "Cannot access menu file, permission problem."
+
+msgctxt "#32104"
+msgid "Please see Kodi log for more information."
+msgstr "Please see Kodi log for more information."
+
+msgctxt "#32105"
+msgid "Menu file is empty or might not have the correct format. Please visit https://github.com/wastis/ShellScriptLauncher for more information."
+msgstr "Menu file is empty or might not have the correct format. Please visit https://github.com/wastis/ShellScriptLauncher for more information."
+
+
+msgctxt "#32110"
+msgid "Command Error."
+msgstr "Command Error."
+
+msgctxt "#32111"
+msgid "Error executing command: %s"
+msgstr "Error executing command: %s"
+
+msgctxt "#32112"
+msgid "Execution completed."
+msgstr "Execution completed."
+
+msgctxt "#32113"
+msgid "%s did not return the expected value. Error code: %s"
+msgstr "%s did not return the expected value. Error code: %s"

resources/lib/menu.py

@@ -13,10 +13,6 @@
 import xbmcaddon
 from xbmcgui import ListItem
 
-from log import log
-from handle import handle
-from handle import opthandle
-
 addon = xbmcaddon.Addon()
 def tr(lid):
 	return addon.getLocalizedString(lid)
@@ -34,8 +30,6 @@ def onInit( self ):
 		dx = -self.item_list_bk.getX()
 		dy = -self.item_list_bk.getY()
 
-		log("size :" + str(dx))
-
 		item_height = 80
 		item_cnt = len(self.menu)
 
@@ -48,8 +42,6 @@ def onInit( self ):
 
 		y = int((1080 - window_height) / 2)
 
-		log(str(y))
-
 		self.item_list.setHeight(window_height)
 		self.item_list_bk.setHeight(window_height+2*dy)
 
@@ -72,7 +64,6 @@ def onInit( self ):
 	#
 
 	def end_gui(self):
-		log("end_gui")
 		self.selected = -1
 		self.close()
 
@@ -87,6 +78,6 @@ def onAction( self, action ):
 		if action.getId() in [7, 100]:
 			self.ok_pressed()
 
-		#Cancel
+		#Cancel / Fullscreen
 		if action.getId() in [92,10,18]:
 			self.end_gui()

resources/lib/runaddon.py

@@ -14,48 +14,90 @@
 
 import xbmcaddon
 import xbmc
+import xbmcgui
 
 from log import log
 from handle import handle
 
 from menu import MenuGui
 
+addon = xbmcaddon.Addon()
+def tr(lid):
+	return addon.getLocalizedString(lid)
+
+def parse_flags(flags):
+	# takes comma seperated string like "notify,exitcode 0"
+
+	notify = False
+	check_exit = False
+	expect = 0
+
+	for flag in flags.split(","):
+		flag = flag.strip()
+		if flag == "notify":
+			notify = True
+		if flag.startswith("exitcode"):
+			expect = int(flag[8:].strip())
+			check_exit = True
+
+	return notify, check_exit, expect
+
 def run_addon():
 	try:
 		cwd = xbmcaddon.Addon().getAddonInfo('path')
 		menufile = os.path.expanduser(xbmcaddon.Addon().getSettingString("menufile"))
 
 		log("menufile: " +  menufile)
 
-		with open(menufile, "r") as f:
-			content = f.read().split("\n")
+		try:
+			with open(menufile, "r") as f:
+				content = f.read().split("\n")
+		except FileNotFoundError:
+			xbmcgui.Dialog().ok(tr(32100),tr(32101))
+			return
+		except IsADirectoryError:
+			xbmcgui.Dialog().ok(tr(32100),tr(32102))
+			return
+		except PermissionError:
+			xbmcgui.Dialog().ok(tr(32100),tr(32103))
+			return
+		except Exception as e:
+			handle(e)
+			xbmcgui.Dialog().ok(tr(32100),tr(32104))
+			return
 
+		# parse menu items
 		menu_items = []
 		for line in content:
 			try:
-				pos = line.find(":")
-				if pos <0 : continue
-				expos = line.find(":",pos + 1)
+				cols = line.split(":")
+				if len(cols) < 3:
+					continue
 
-				name =  line[:pos].strip()
-				block = line[pos + 1:expos].strip() == "blocking"
-				exe = line[expos + 1:].strip()
+				name = cols[0].strip()
+				flags = cols[1].lower()
+				exe = ":".join(cols[2:])
 
-				if name == "":
-					continue
-				if exe == "":
+				if name == "" or exe == "":
 					continue
-				menu_items.append((name, block, exe))
+
+				menu_items.append((name, exe, flags))
 
 			except:
 				continue
+		#
+		# check if menu file is empty
+		#
 
 		if not menu_items:
-			log("no menu entries found in menu file")
+			xbmcgui.Dialog().ok(tr(32100),tr(32105))
 			return
 
+		#
+		# show menu dialog
+		#
+
 		current_skin = xbmc.getSkinDir()
-		log(current_skin)
 
 		if os.path.exists(os.path.join(cwd,"resources","skins",current_skin)):
 			skin = current_skin
@@ -65,19 +107,60 @@ def run_addon():
 		ui = MenuGui("menu.xml", cwd, skin, "1080i", menu = menu_items, width = 400)
 		ui.doModal()
 		selected = ui.selected
+
+		#
+		# check if back has been pressed
+		#
+
 		if selected < 0:
 			log("nothing selected")
 			return
 
-		cmd = [os.path.expanduser(item) for item in menu_items[selected][2].split(" ")]
-		block =  menu_items[selected][1]
-		log("run: " + str(block) + " "+ " ".join(cmd))
+		#
+		# expand user home ~
+		#
+
+		cmd = [\
+				os.path.expanduser(item) \
+				for item in menu_items[selected][1].split(" ")\
+			]
+
+		#
+		# parse flags
+		#
+
+		notify, check_exit, expect = parse_flags(menu_items[selected][2])
+
+		#
+		# execute command
+		#
+
+		log("execute: " + " ".join(cmd))
+
+		try:
+			exitcode =  int(subprocess.Popen(cmd).wait())
+
+		except Exception as e:
+			handle(e)
+			xbmcgui.Dialog().ok(tr(32110),tr(32111) % cmd)
 
-		if block:
-			os.system(" ".join(cmd))
 		else:
-			subprocess.Popen(cmd)
-		log("done")
+			log("done with exitcode %s " % str(exitcode))
+
+			if check_exit and exitcode != expect:
+				xbmcgui.Dialog().ok\
+				(\
+					tr(32110), \
+					tr(32113) %  (menu_items[selected][0], exitcode)\
+				)
+
+			elif notify:
+				xbmcgui.Dialog().notification\
+				(
+					tr(32112), \
+					menu_items[selected][0],\
+					os.path.join(cwd,"resources","media","notify.png")\
+				)
 
 	except Exception as e:
 		handle(e)