Merge branch 'dev' into 'master'HEADmaster

minor refactor and add documentation

Closes #1, #3, #2, #4, #5, and #6

See merge request bgstack15/logout-manager!3

1 files changed, 77 insertions, 0 deletions

diff --git a/src/usr/bin/logout-manager-cli b/src/usr/bin/logout-manager-cli
new file mode 100755
index 0000000..974fd4b
--- /dev/null
+++ b/src/usr/bin/logout-manager-cli
@@ -0,0 +1,77 @@
+#!/usr/bin/env python3
+# File: logout-manager-cli
+# License: CC-BY-SA 4.0
+# Author: bgstack15
+# Startdate: 2020-03-10 18:40
+# Title: cli logout manager
+# Purpose: Feature completeness in this package
+# History:
+#    2020-04-03 fix #5 -n does nothing
+# Usage:
+#    logout-manager-cli
+# Reference:
+#    https://stackoverflow.com/questions/39092149/argparse-how-to-make-mutually-exclusive-arguments-optional/39092229#39092229
+#    https://stackoverflow.com/questions/3061/calling-a-function-of-a-module-by-using-its-name-a-string/12025554#12025554
+# Improve:
+# Dependencies:
+#    dep-devuan: python3-dotenv, python3
+# Documentation:
+
+import os, sys, argparse
+from distro import linux_distribution
+from dotenv import load_dotenv
+
+# all this to load the libpath
+try:
+   defaultdir="/etc/sysconfig"
+   thisplatform = linux_distribution()[0].lower()
+   if 'debian' in thisplatform or 'devuan' in thisplatform:
+      defaultdir="/etc/default"
+   # load_dotenv keeps existing environment variables as higher precedent
+   load_dotenv(os.path.join(defaultdir,"logout-manager"))
+except:
+   pass
+if 'LOGOUT_MANAGER_LIBPATH' in os.environ:
+   for i in os.environ['LOGOUT_MANAGER_LIBPATH'].split(":"):
+      sys.path.append(i)
+sys.path.append("/usr/share/logout-manager")
+import lmlib
+
+def eprint(*args, **kwargs):
+   print(*args, file=sys.stderr, **kwargs)
+
+logout_manager_cli_version="2020-04-03"
+
+parser = argparse.ArgumentParser(description="run logout-manager commands using cli")
+parser.add_argument('action', help='which action to take',nargs='?', choices=('lock','logout','hibernate','shutdown','reboot'))
+parser.add_argument("-d","--debug", nargs='?', default=0, type=int, choices=range(0,11), help="Set debug level.")
+parser.add_argument("-n","--dryrun", action='store_true', help="only report. Useful for checking if hibernate is allowed.")
+parser.add_argument("-V","--version", action="version", version="%(prog)s " + logout_manager_cli_version)
+
+args = parser.parse_args()
+
+# handle -n
+if args.dryrun:
+   os.environ["DRYRUN"] = "from-parameters"
+
+# load configs
+# in cli, must happen after arparse to benefit from debug value
+config = lmlib.Initialize_config(os.environ['LOGOUT_MANAGER_CONF'])
+actions = lmlib.Actions
+
+# MAIN LOOP
+allowed_actions=['lock','logout','shutdown','reboot']
+if config.can_hibernate:
+   allowed_actions.append('hibernate')
+
+if args.action in allowed_actions:
+   func = getattr(globals()['actions'],args.action)
+   func(config)
+   sys.exit(0)
+elif args.action:
+   eprint("Unable to take action: %s" % str(args.action))
+   sys.exit(1)
+
+# if we get here, no action was used
+parser.print_help()
+sys.exit(2)