From: Ralf Jung <post@ralfj.de>
Date: Wed, 23 Oct 2013 16:51:40 +0000 (+0200)
Subject: Merge branch 'master' of ralfj.de:saartuer
X-Git-Url: https://git.ralfj.de/saartuer.git/commitdiff_plain/f5e51ba317a3119d1c2ea987cb922a8f437122dd?hp=13b37750aa7399b7a8f9634e7fe7f34b0197fbf8

Merge branch 'master' of ralfj.de:saartuer
---

diff --git a/tyshell b/tyshell
index f8627d2..13a5513 100755
--- a/tyshell
+++ b/tyshell
@@ -7,6 +7,7 @@ import subprocess
 import socket
 import pwd
 import grp
+from collections import namedtuple
 
 tuerSock = "/run/tuer.sock"
 
@@ -21,7 +22,11 @@ atexit.register(readline.write_history_file, histfile)
 
 # available commands
 def helpcmd(c):
-	print("Available commands: %s" % ", ".join(sorted(commands.keys())))
+	if (len(c) > 1):
+		print(commands.get(c[1],(None,'Can\'t find help for command %s'%(c[1]))).helpstring)
+	else:
+		print("Available commands: %s" % ", ".join(sorted(commands.keys())))
+		print("Use 'help command' to get more information on the command 'command'")
 
 def extcmd(cmd):
 	def run(c):
@@ -51,14 +56,23 @@ def whocmd(c):
 		p = pwd.getpwnam(n)
 		print (p.pw_name, " - ", p.pw_gecos)
 
-commands = {
-	'exit': exitcmd,
-	'help': helpcmd,
-	'open': sendcmd(tuerSock, 'unlock'),
-	'unlock': sendcmd(tuerSock, 'unlock'),
-	'buzz': sendcmd(tuerSock, 'buzz'),
-	'who': whocmd,
-}
+def alias (cmds, aliases):
+	for newname, oldname in aliases.items():
+		cmds[newname] = cmds[oldname]
+	return cmds
+
+CmdEntry = namedtuple('CmdEntry','function helpstring')
+
+commands = alias({
+	'exit': CmdEntry(exitcmd, 'Quits this shell'),
+	'help': CmdEntry(helpcmd, 'Helps you getting to know the available commands'),
+	'open': CmdEntry(sendcmd(tuerSock, 'unlock'), 'Will try to unlock the apartment door'),
+	'buzz': CmdEntry(sendcmd(tuerSock, 'buzz'), 'Will buzz the buzzer for the street door'),
+	'who': CmdEntry(whocmd, 'Shows the list of people, who are allowed to control this system'),
+},{
+	# aliases
+	'unlock': 'open',
+})
 
 def complete_command(cmd):
 	'''returns a list of commands (as strings) starting with cmd'''
@@ -86,7 +100,7 @@ while True:
 		print("Command %s not found. Use help." % command[0])
 	elif len(cmdoptions) == 1: # exactly one command fits (prefix)
 		try:
-			res = commands[cmdoptions[0]](command)
+			res = commands[cmdoptions[0]].function(command)
 			if res: break
 		except Exception as e:
 			print("Error while executing %s: %s" % (command[0], str(e)))