xolo-server 1.0.1 → 2.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fd8f5d511b0e82176d958b1ea7b9df7b9031e080ad02c566e2aa95cada58537e
-  data.tar.gz: 27b72f9c11aa2709a167b766b28e5de836cb382e5f92196909389b94743d26eb
+  metadata.gz: 5762b1b18f24e90927cac0c748c873b32150a55e5037d1e3db4792c93bb79e82
+  data.tar.gz: 5a068566e8e4c28687a26493d29a7c9506ce2247e1cd846fb1a8768d4833fdd4
 SHA512:
-  metadata.gz: 6442b23702ae6193a940991fcdbb8d308f8ffce132d769bb4ca16a91e885f52e95e742af1262a0b6a0108c0168c2704fefad2a70e11e3278cb461c97fbd4de69
-  data.tar.gz: ec49cf6483153c45e7814e5a5b831e065ce6af8f31028f0663546dabddd4ac15d296f3c723206df03933752b151c292ee72e044094b2676adff13de4167fa29f
+  metadata.gz: afbc831c4e4662ccd04ef70f5cf8eef8511a65e2138b220dd74cd53efa45596b566b7dec7b3ccce0c73f9bcfbb61d444f913457ba62cb94b8a497927fcf4180d
+  data.tar.gz: 0cadf36f4e99a2ba8f394228bbb9cb131bd9d8b80179313528f6c4f6a8130b4581c32637646cc6cea6166d3d552ba0c44862b478ae2e0e87c5c917ab7cd0bc17

data/data/client/xolo

@@ -14,9 +14,12 @@
 zmodload zsh/zutil
 
 # for perl-style regexps
-# DISABLED FOR NOW - some versions of macos don't seem to have
-# /usr/lib/zsh/5.9/zsh/pcre.so
-# All our regexps now use posix style
+#
+# DISABLED FOR NOW - macOS before 15 Sequoia doesn't have the pcre module,
+# and we want to support 14 Sonoma for now.
+# The file required is /usr/lib/zsh/5.9/zsh/pcre.so
+#
+# Until then, all our regexps now use posix style
 #
 # setopt RE_MATCH_PCRE
 
@@ -37,10 +40,10 @@ export LC_ALL="en_US.UTF-8"
 XOLO_VERSION="0.0.0"
 
 # The usage message for xolo
-USAGE='xolo [options] <command> [<title> [<version>]]'
+USAGE='xolo [options] <command> [ title1[=version1] [ title2[=version2] ... ]]'
 
 # The URL for more information about xolo
-XOLO_DOX_URL='<URL TO BE DETERMINED>'
+XOLO_DOX_URL='https://pixaranimationstudios.github.io/xolo-home/'
 
 # The long path to the lsregister command
 LSREG='/System/Library/Frameworks/CoreServices.framework/Versions/A/Frameworks/LaunchServices.framework/Versions/A/Support/lsregister'
@@ -51,9 +54,34 @@ JAMF='/usr/local/bin/jamf'
 # The path to the client data json file
 CLIENT_DATA_JSON_FILE="/Library/Application Support/xolo/client-data.json"
 
+# The path to the test client data json file, from a text xolo server
+TEST_CLIENT_DATA_JSON_FILE="/Library/Application Support/xolo/test-client-data.json"
+
 # The jamf policy trigger to update the client data
 UPDATE_CLIENT_DATA_TRIGGER='update-xolo-client-data'
 
+# The jamf policy trigger to update the test client data
+TEST_UPDATE_CLIENT_DATA_TRIGGER='test-update-xolo-client-data'
+
+# In the CLI args, titles and versions are separated by the first
+# occurrence of the equals sign
+TITLE_VERSION_SEPARATOR='='
+
+
+# These commands must be run as root
+ROOT_COMMANDS=(
+  install
+  i
+  uninstall
+  u
+  update
+  U
+  refresh
+  r
+  expire
+  e
+)
+
 # GLOBAL VARIABLES
 ###############################
 ###############################
@@ -63,13 +91,13 @@ UPDATE_CLIENT_DATA_TRIGGER='update-xolo-client-data'
 # options
 show_help=
 be_verbose=
-be_quiet=
 debugging_on=
 no_versions=
 show_xolo_version=
 
 # arguments
 command=
+targets=
 title=
 version=
 
@@ -92,10 +120,18 @@ function die() {
   local mystat=1
 
   [[ -n "$2" ]] && mystat=$2
-  echoerr "$msg"
+  echoerr "ERROR: $msg"
   exit $mystat
 }
 
+# Die if not root and the command being run is in the list of root commands
+#################################
+function must_be_root() {
+  if (( $ROOT_COMMANDS[(Ie)$command] )); then
+    [[ $EUID -ne 0 ]] && die "You must be root to use the '$command' command."
+  fi
+  return 0
+}
 
 # Show the help message
 ###############################
@@ -109,8 +145,12 @@ Usage:
 Options:
   -h, -H, --help:    Show this help message.
   -v, --verbose:     Enable verbose mode, extra information will be printed.
-  -q, --quiet:       Enable quiet mode, only errors will be printed to stderr.
   -d, --debug:       Enable debug mode, extra debug information will be printed.
+                     Implies --verbose.
+  -t, --test         If your site has a "test" xolo server running via the same
+                     Jamf Pro server, this causes 'xolo' to only see data, titles,
+                     policies, etc, from test xolo server, not the production server.
+                     Setting the XOLO_TEST_MODE env. variable does the same thing.
   -r, --recon:       With 'install' or 'uninstall' run a 'jamf recon' after the
                      operation completes successfully.
   -n, --no-versions: With the 'list-titles' and 'list-installed' commands,
@@ -118,15 +158,12 @@ Options:
                      installed, respectively.
   -V, --version:     Show the version of xolo.
 
-  NOTE: Debug mode will also enable verbose mode. Both debug and verbose modes
-  override quiet mode.
-
 Commands:
-  install, i <title> [<version>]
+  install, i <title>[=<version>] [<title2>[=<version2>] ...]
     Install a title, or specific version thereof (e.g. a version currently in pilot)
     If no version is specified, the currently released version will be installed.
 
-  uninstall, u <title>
+  uninstall, u <title> [<title2> ...]
     Uninstall a title, if possible. Not all titles are uninstallable via xolo.
 
   update, U
@@ -150,8 +187,10 @@ Commands:
     a few moments, since all titles with version scripts will run those scripts
     to see if they are installed.
 
-  details, d <title> [<version>]
-    Show detailed information about a title, or a specific version thereof.
+  details, d <title>[=<version>] [<title2>[=<version2>] ...]
+    Show detailed information about titles, or a specific versions thereof.
+    Note that titles and versions contain different sets of information, so the output
+    will differ depending on what you specify.
 
   expire, e
     Expire the given title if it has not been used in its defined expiration period.
@@ -161,6 +200,26 @@ Commands:
   help, h
     Show this help message. The same as -h or --help.
 
+Examples:
+  xolo install transmogrifier
+    Installs the currently released version of the title "transmogrifier".
+
+  xolo install laserbeam transmogrifier=2.0
+    Installs the currently released version of the title "laserbeam" and version 2.0 of
+    the title "transmogrifier", if it is in pilot or already released.
+
+  xolo uninstall transmogrifier laserbeam
+    Uninstalls the titles "transmogrifier" and "laserbeam, if they are uninstallable via
+    xolo and currently installed. Note that versions are ignored for uninstalling, since
+    only one version of a title can be installed at a time.
+
+  xolo list-titles
+    Lists all titles known to xolo, with their versions and statuses.
+
+  xolo details laserbeam transmogrifier=2.0
+    Shows detailed information about the title "laserbeam" and version 2.0 of the title
+    "transmogrifier".
+
   For more information about xolo, see $XOLO_DOX_URL
 ENDHELP
 } # end show_help
@@ -171,8 +230,8 @@ function parse_cli() {
   zparseopts -D -F -E -- \
     {h,H,-help}=show_help \
     {v,-verbose}=be_verbose \
-    {q,-quiet}=be_quiet \
     {d,-debug}=debugging_on \
+    {t,-test}=test_mode \
     {n,-no-versions}=no_versions \
     {r,-recon}=do_recon \
     {V,-version}=show_xolo_version || \
@@ -181,46 +240,57 @@ function parse_cli() {
   # they are in arrays, but we want regular vars
   show_help=$show_help[-1]
   be_verbose=$be_verbose[-1]
-  be_quiet=$be_quiet[-1]
   debugging_on=$debugging_on[-1]
+  test_mode=$test_mode[-1]
   no_versions=$no_versions[-1]
   do_recon=$do_recon[-1]
   show_xolo_version=$show_xolo_version[-1]
 
+  # test mode can be triggered by an env var
+  [[ -n "$XOLO_TEST_MODE" ]] && test_mode=1
+
   # if debugging is on, verbose is also on
   [[ -n $debugging_on ]] && be_verbose=1
 
-  # if we're in verbose mode, we're not in quiet mode
-  [[ -n $be_verbose ]] && unset be_quiet
-
   command=$1
   [[ ${#@} -gt 0 ]] && shift
 
-  title=$1
-  [[ ${#@} -gt 0 ]] && shift
-
-  version=$1
-
-  # echo "show_help is: $show_help"
-  # echo "be_verbose is: $be_verbose"
-  # echo "be_quiet is: $be_quiet"
-  # echo "debugging_on is: $debugging_on"
-  # echo "command is: $command"
-  # echo "title is: $title"
-  # echo "version is: $version"
-
+  targets=("${(@)@}")
 
   debug "Parsed command line:"
   debug "..show_help is: $show_help"
   debug "..be_verbose is: $be_verbose"
-  debug "..be_quiet is: $be_quiet"
   debug "..debugging_on is: $debugging_on"
+  debug "..test_mode is: $test_mode"
+  [[ -n "$XOLO_TEST_MODE" ]] && debug "  ..via XOLO_TEST_MODE env."
   debug "..no_versions is: $no_versions"
   debug "..show_xolo_version is: $show_xolo_version"
 
   debug "..command is: $command"
-  debug "..title is: $title"
-  debug "..version is: $version"
+  debug "..targets are: $targets"
+}
+
+# Parse a title and version from the command line, where they may be given in the form
+# title or title=version
+#################################
+function parse_title_and_version() {
+  local arg=$1
+  debug "Parsing title and version from arg: '$arg'"
+
+  if [[ "$arg" == *"$TITLE_VERSION_SEPARATOR"* ]] ; then
+    # everything before the first = is title
+    title=${arg%%$TITLE_VERSION_SEPARATOR*}
+    # everything after the first = is version
+    version=${arg#*$TITLE_VERSION_SEPARATOR}
+  else
+    title="$arg"
+    version=''
+  fi
+
+  debug "..title is: '$title'"
+  debug "..version is: '$version'"
+
+  return 0
 }
 
 # quick test for debugging_on
@@ -235,16 +305,10 @@ function be_verbose() {
   [[ -n "$be_verbose" ]]
 }
 
-# quick test for be_quiet
-###############################
-function be_quiet() {
-  [[ -n "$be_quiet" ]]
-}
-
-# Print a message to stout if we're not in quiet mode
+# Print a message to stout
 ###############################
 function say() {
-  be_quiet || echo "$*"
+  echo "$*"
 }
 
 # Print a message to stdout if we're in verbose or debug mode
@@ -334,7 +398,7 @@ app.includeStandardAdditions = true;
 
 // run() is automatically executed when the program is called, and will print any output returned.
 function run() {
-    var parsed_data = JSON.parse(app.read("${CLIENT_DATA_JSON_FILE}"));
+    var parsed_data = JSON.parse(app.read("${client_data_json_file}"));
     var result;
 
     // the line below will sub-in whatever code we were passed
@@ -366,7 +430,7 @@ function all_xolo_titles() {
   read -r -d '' jscode <<ENDJAVASCRIPT
     result = Object.keys(parsed_data.titles).join('\n');
 ENDJAVASCRIPT
-  extract_json_data "$jscode"
+  extract_json_data "$jscode" | sort
 }
 
 # Outputs all known titles, one per line, with versions and statuses
@@ -399,7 +463,7 @@ function all_xolo_titles_with_versions() {
     result = result.slice(0, -1);
 
 ENDJAVASCRIPT
-  extract_json_data "$jscode"
+  extract_json_data "$jscode"  | sort
 }
 
 
@@ -680,39 +744,24 @@ ENDJAVASCRIPT
 # Run a Jamf policy trigger
 # $1 = the policy trigger to run
 # $2 = any extra options to pass to the jamf command
-# be_verbose() and be_quiet() will automatically be honored
+# be_verbose() will automatically be honored
 #######################################
 function run_jamf_policy_trigger() {
   local policy_trigger=$1
   local jamf_options=$2
   local jamf_verbose=''
-  local jamf_quiet=''
   local cmd
 
-  # debug means verbose
-  if be_verbose ; then
-    jamf_verbose='-verbose'
-  else
-    # if told to be quiet, do so
-    if be_quiet ; then
-      jamf_quiet=1
-
-    # but if we're refreshing client data as part of
-    # another command, always be quiet.
-    elif [[ $policy_trigger == $UPDATE_CLIENT_DATA_TRIGGER && "$command" != 'refresh' ]] ; then
-      jamf_quiet=1
-    fi
-  fi
-
+  be_verbose && jamf_verbose='-verbose'
 
   cmd="$JAMF policy -trigger $policy_trigger $jamf_options $jamf_verbose"
+  tempfile=$(mktemp /tmp/xolo-policy.XXXXXXXX)
+
   debug "Running jamf policy command: $cmd"
+  eval "$cmd" | tee "$tempfile"
 
-  if [[ -n $jamf_quiet ]] ; then
-    policy_output=$( eval "$cmd" )
-  else
-    policy_output=$( eval "$cmd" | tee /dev/tty )
-  fi
+  policy_output=$(<"$tempfile")
+  rm -f "$tempfile"
 
   [[ $policy_output =~ 'Submitting log to https://' ]] && return 0
 
@@ -723,12 +772,13 @@ function run_jamf_policy_trigger() {
 # Refresh the client data
 ###############################
 function refresh_client_data() {
+
   # if we've already refreshed during this run, we're done
   [[ -n "$client_data_refreshed" ]] && return
 
   [[ "$command" == 'refresh' ]] && say "Refreshing client data..." || debug "Refreshing client data..."
 
-  run_jamf_policy_trigger $UPDATE_CLIENT_DATA_TRIGGER
+  run_jamf_policy_trigger "$update_client_data_trigger"
 
   client_data_refreshed=1
 }
@@ -744,8 +794,9 @@ function validate_title() {
   # die if no title given
   [[ -z "$title" ]] && die "No title given.\nUsage: $USAGE\nUse --help for more information."
 
-  # make sure the JSON data file is up to date
-  refresh_client_data
+  # make sure the JSON data file is up to date, if we are root
+
+  [[ $EUID -eq 0 ]] && refresh_client_data
 
   # die if no such title
   # all titles in an array
@@ -776,9 +827,21 @@ function validate_version() {
   version_is_valid=1
 }
 
+# Install all the items on the command line, which may be titles or specific versions of titles
+#################################
+function install_cli_args() {
+  debug "Installing Targets: $targets"
+  for item in $targets ; do
+    parse_title_and_version "$item"
+    install
+  done
+}
+
+
 # Install a title, or a specific version thereof
 ###############################
 function install() {
+
   validate_title
 
   # if no version is given, we'll find the current release
@@ -814,12 +877,25 @@ function install() {
   fi
 }
 
+# uninstall CLI args, which are just titles since versions don't matter for uninstalling
+##############################
+function uninstall_cli_args() {
+  debug "Uninstalling Targets: $targets"
+  for item in $targets ; do
+    parse_title_and_version "$item"
+    uninstall
+  done
+}
+
 # Unnstall a title
 # This might not do anything if the title is not uninstallable,
 # or if the title is not installed
 ###############################
 function uninstall() {
   validate_title
+
+  details_for_title $title | grep -q 'Uninstallable: true' || die "Title $title is not uninstallable via xolo"
+
   say "Uninstalling title $title..."
 
   if run_jamf_policy_trigger "xolo-${title}-uninstall" ; then
@@ -843,8 +919,6 @@ function run_recon() {
   say 'Running jamf recon...'
   if be_verbose ; then
     $JAMF recon -verbose
-  elif be_quiet ; then
-    $JAMF recon &> /dev/null
   else
     $JAMF recon
   fi
@@ -861,8 +935,6 @@ function update() {
   debug "Running jamf policy..."
     if be_verbose ; then
     $JAMF policy -verbose
-  elif be_quiet ; then
-    $JAMF policy &> /dev/null
   else
     $JAMF policy
   fi
@@ -881,9 +953,20 @@ function list_all_titles() {
   all_xolo_titles_with_versions
 }
 
+# Show detailed information about all titles, or specific versions thereof, given on the command line
+########################
+function show_details_cli_args() {
+  debug "Showing details for targets: $targets"
+  for item in $targets; do
+    parse_title_and_version "$item"
+    show_details
+  done
+}
+
 # Show detailed information about a title or a version thereof
 ###############################
 function show_details() {
+  debug "Showing details for title '$title' and version '$version'..."
   validate_title
 
   if [[ -z "$version" ]] ; then
@@ -901,7 +984,7 @@ function list_installed_titles() {
   local app_data
 
 
-  verbose "Listing installed titles..."
+  verbose "Locating installed titles..."
 
   # populate the installed_apps associative array
   get_installed_apps
@@ -916,6 +999,7 @@ function list_installed_titles() {
       display_title_if_installed_by_version_script $ttl
     fi
   done <<<"$(all_xolo_titles)"
+  return 0
 }
 
 # given a title and some app data (name, bundle id)
@@ -1081,11 +1165,18 @@ function expire() {
   uninstall
 }
 
+
+
+
 # MAIN
 ###############################
 ###############################
 
 function main() {
+  # defaults
+  client_data_json_file="$CLIENT_DATA_JSON_FILE"
+  update_client_data_trigger="$UPDATE_CLIENT_DATA_TRIGGER"
+
   # Parse the command line
   parse_cli "$@"
 
@@ -1101,22 +1192,31 @@ function main() {
     exit 0
   fi
 
+  # use the test data file if in test mode
+  if [[ -n "$test_mode" ]] ; then
+    client_data_json_file="$TEST_CLIENT_DATA_JSON_FILE"
+    update_client_data_trigger="$TEST_UPDATE_CLIENT_DATA_TRIGGER"
+  fi
+
   if [[ "$command" != "refresh" ]] ; then
     # If we're not refreshing, we need to have the client data file
     # and it needs to be up to date
-    [[ -f "$CLIENT_DATA_JSON_FILE" ]] || die "No client data file found at $CLIENT_DATA_JSON_FILE.\nPlease run the 'refresh' command to update the client data."
+    [[ -f "$client_data_json_file" ]] || die "No client data file found at $client_data_json_file.\nPlease run the 'refresh' command to update the client data."
   fi
 
   [[ -z "$command" ]] && die "No command given.\nUsage: $USAGE\nUse --help for more information."
 
+  # confirm we are root for those commands that need it
+  must_be_root
+
   case "$command" in
     install|i)
       debug "processing command 'install'"
-      install
+      install_cli_args
       ;;
     uninstall|u)
       debug "processing command 'uninstall'"
-      uninstall
+      uninstall_cli_args
       ;;
     update|U)
       debug "processing command 'update'"
@@ -1138,7 +1238,7 @@ function main() {
       ;;
     details|d)
       debug "processing command 'details'"
-      show_details
+      show_details_cli_args
       ;;
     expire|e)
       debug "processing command 'expire'"
@@ -1157,4 +1257,4 @@ function main() {
 
 # RUN!
 ###########################
-main "$@"
+main "$@"