xolo-admin 2.2.4 → 2.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c2b0f21f5f3a7a55117054a2fe5cd35e7e702debd3909669f969e009b603cbbe
-  data.tar.gz: 27f012b50a0986d7a06854f5cef89af6b549efe7a22b30faf3601418be3dc56d
+  metadata.gz: 9c667de0cc034e593ed21097a61d356497d18be62c6efa84d681459138457e5c
+  data.tar.gz: 28c33bd6e5eeb50864a7faca5342381a7929354c7eb052d62e6efa377c14ef08
 SHA512:
-  metadata.gz: 854b8cf91c614184a51b2753931135dbb91d697965b5531859d886d96e554fcfb33c60abc141c47bb0748a4150cec8fa0d357a4cbfb4dbf44625b439229adf9a
-  data.tar.gz: bbcbf4275c621a79829d365b0a4d0bd4ac09775516efb924fbb4bd8f1f9039c17e0b1d8c2ce22293793ffbb83696e86b385cdd57fa2c41c6f706080c69bd1b2e
+  metadata.gz: 1af30205a20f66da58d657c716a2de2d6fe7da54f3745add8b68df80929ab2e6aa8dd72a68e1e2d72a009e03c6c48c276f1bd9fbaa3d6b18ba92fe5d7c21dbbc
+  data.tar.gz: 1ac20c8dee5bc4aedab29c39aa405788edf80f43cf1de8843e960220cf4024436ca2ed2f26e9b41e8a76203f5a76de2cdf5b9dedb8234ce1cc7c9b3510d7a069

data/data/client/xolo

@@ -27,6 +27,9 @@ zmodload zsh/zutil
 ###############################
 ###############################
 
+# just in case
+export PATH="/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/usr/libexec:$PATH"
+
 # Needed for the UTF-8 chars in the lsreg output
 export LANG="en_US.UTF-8"
 export LC_ALL="en_US.UTF-8"
@@ -94,6 +97,7 @@ be_verbose=
 debugging_on=
 no_versions=
 show_xolo_version=
+do_recon=
 
 # arguments
 command=
@@ -152,7 +156,9 @@ Options:
                      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.
+                     operation completes successfully. With 'update', run a 'jamf recon'
+                     before the checkin. NOTE: With update, the whole process may take
+                     many minutes.
   -n, --no-versions: With the 'list-titles' and 'list-installed' commands,
                      do not show the versions available, or the version
                      installed, respectively.
@@ -187,6 +193,9 @@ Commands:
     every time this computer checks in with Jamf Pro.
     Note: this just runs the 'jamf policy' command, which will execute any pending
     Jamf policies triggered by "recurring check-in".
+    If --recon is given, a Jamf recon will run first, followed by a 1 minute pause
+    for Jamf to process the data before doing the check-in. This helps the Mac to see
+    very recently-released versions as patch updates.
 
   refresh, r
     Update xolo's information about current titles and versions.
@@ -356,42 +365,43 @@ function debug() {
   debugging_on && echo "DEBUG: $*" 1>&2
 }
 
-# Gather all installed bundle ids and installed versions from lsreg
+# Gather all installed bundle ids and installed versions from system_profiler
 # store them in an associative array in $installed_apps.
 # keys are bundle ids, values are app name & installed version
 # separated by a semicolon
 # e.g. 'com.apple.Safari => Safari.app;14.0.3'
 ###############################
 function get_installed_apps() {
+  # debug "PATH is $PATH"
   debug "Getting all installed .apps on this Mac..."
   local app_name
   local app_bundle_id
   local app_vers
+  local app_plist
 
-  # loop thru lsreg output
-  "$LSREG" -dump Bundle | while IFS= read -r line ; do
-    # a line if ------ starts a new record
-    if [[ "$line" =~ '^-+$' ]] ; then
-      unset app_name
-      unset app_bundle_id
-      unset app_vers
-      continue
-    fi
+  json_app_data=$(/usr/sbin/system_profiler -json SPApplicationsDataType )
+
+  apps_to_look_at=$(echo "$json_app_data" | grep '"path"' | cut -d'"' -f4 | grep -v '^/System/')
+
+  for app_path in ${(f)apps_to_look_at} ; do
+    app_name=$(/usr/bin/basename "$app_path")
+    app_plist="$app_path/Contents/Info.plist"
+
+    if [[ -f "$app_plist" ]] ; then
+      app_bundle_id=$(/usr/bin/plutil -extract CFBundleIdentifier raw "$app_plist" 2>/dev/null)
 
-    # $MATCH is the whole matched string, $match is the array of captures
-    # NOTE this only works if the path is listed before the CFBundleIdentifier
-    # which seems to be the case in the lsreg output
-    [[ "$line" =~ '^path:[[:space:]]+/.*/(.+\.app) \(' ]] && app_name=$match[1]
-    [[ "$line" =~ '^[[:space:]]+CFBundleIdentifier = \"(.+)\";' ]] && app_bundle_id=$match[1]
-    [[ "$line" =~ '^[[:space:]]+CFBundleShortVersionString = \"(.+)\";' ]] && app_vers=$match[1]
+      app_vers=$(/usr/bin/plutil -extract CFBundleShortVersionString raw "$app_plist" 2>/dev/null)
+
+      # Use CFBundleVersion if no CFBundleShortVersionString
+      [[ -z "$app_vers" ]] && \
+        app_vers=$(/usr/bin/plutil -extract CFBundleVersion raw "$app_plist" 2>/dev/null)
 
-    if [[ -n "$app_name" && -n "$app_bundle_id" && -n "$app_vers" ]] ; then
       installed_apps[$app_bundle_id]="$app_name;$app_vers"
-      unset app_name
-      unset app_bundle_id
-      unset app_vers
+    else
+      debug "App Path '$app_path' has no Info.plist"
     fi
   done
+
   # installed_apps is now an associative array with bundle ids as keys and app names as values
 
   # print the installed apps - this is a long list
@@ -402,8 +412,70 @@ function get_installed_apps() {
     done
   fi
 
+# debug "PATH is $PATH"
 } # end installed_apps
 
+########################################
+########################################
+########################################
+########################################
+########################################
+########################################
+# Gather all installed bundle ids and installed versions from lsreg
+# store them in an associative array in $installed_apps.
+# keys are bundle ids, values are app name & installed version
+# separated by a semicolon
+# e.g. 'com.apple.Safari => Safari.app;14.0.3'
+###############################
+# function get_installed_apps() {
+#   debug "Getting all installed .apps on this Mac..."
+#   local app_name
+#   local app_bundle_id
+#   local app_vers
+
+#   # loop thru lsreg output
+#   "$LSREG" -dump Bundle | while IFS= read -r line ; do
+#     # a line if ------ starts a new record
+#     if [[ "$line" =~ '^-+$' ]] ; then
+#       unset app_name
+#       unset app_bundle_id
+#       unset app_vers
+#       continue
+#     fi
+
+#     # $MATCH is the whole matched string, $match is the array of captures
+#     # NOTE this only works if the path is listed before the CFBundleIdentifier
+#     # which seems to be the case in the lsreg output
+#     [[ "$line" =~ '^path:[[:space:]]+/.*/(.+\.app) \(' ]] && app_name=$match[1]
+#     [[ "$line" =~ '^[[:space:]]+CFBundleIdentifier = \"(.+)\";' ]] && app_bundle_id=$match[1]
+#     [[ "$line" =~ '^[[:space:]]+CFBundleShortVersionString = \"(.+)\";' ]] && app_vers=$match[1]
+
+#     if [[ -n "$app_name" && -n "$app_bundle_id" && -n "$app_vers" ]] ; then
+#       installed_apps[$app_bundle_id]="$app_name;$app_vers"
+#       unset app_name
+#       unset app_bundle_id
+#       unset app_vers
+#     fi
+#   done
+#   # installed_apps is now an associative array with bundle ids as keys and app names as values
+
+#   # print the installed apps - this is a long list
+#   if debugging_on ; then
+#     debug "All installed .apps on this Mac:"
+#     for bundle app in ${(kv)installed_apps}; do
+#           debug "'$bundle' -> '$app'"
+#     done
+#   fi
+
+# } # end installed_apps
+########################################
+########################################
+########################################
+########################################
+########################################
+########################################
+########################################
+
 # Extract data from the client-data.json file
 #
 # TODO: Once we only support macOS 15 (Sequoia) and higher, we
@@ -463,7 +535,7 @@ function all_xolo_titles() {
   read -r -d '' jscode <<ENDJAVASCRIPT
     result = Object.keys(parsed_data.titles).join('\n');
 ENDJAVASCRIPT
-  extract_json_data "$jscode" | sort
+  extract_json_data "$jscode" | /usr/bin/sort
 }
 
 # Outputs all known titles, one per line, with versions and statuses
@@ -969,6 +1041,12 @@ function run_recon() {
 function update() {
   say "Updating installed titles, or installing newly scoped ones..."
 
+  if [[ -n "$do_recon" ]]  ; then
+    run_recon
+    say "Pausing to let Jamf Pro process recon data..."
+    sleep 60
+  fi
+
   debug "Running jamf policy..."
     if be_verbose ; then
     $JAMF policy -verbose
@@ -1020,12 +1098,15 @@ function list_installed_titles() {
   local ttl
   local app_data
 
-
   verbose "Locating installed titles..."
 
   # populate the installed_apps associative array
   get_installed_apps
 
+  # gather output here, display it at the end
+  # rather than interspersed with debug lines
+  installed_titles_report=""
+
   while IFS= read -r ttl; do
     app_data=$(app_data_for_title $ttl)
 
@@ -1036,6 +1117,8 @@ function list_installed_titles() {
       display_title_if_installed_by_version_script $ttl
     fi
   done <<<"$(all_xolo_titles)"
+
+  say "$installed_titles_report"
   return 0
 }
 
@@ -1075,9 +1158,9 @@ function display_title_if_installed_by_app_data() {
   [[ "$inst_app_name" == "$app_name" ]] || return
 
   if [[ -n "$no_versions" ]] ; then
-    echo $ttl
+    installed_titles_report="$installed_titles_report\n$ttl"
   else
-    echo "$ttl ($inst_app_vers)"
+    installed_titles_report="$installed_titles_report\n$ttl ($inst_app_vers)"
   fi
 }
 
@@ -1114,9 +1197,9 @@ function display_title_if_installed_by_version_script() {
   [[ -n "$app_vers" ]] || return
 
   if [[ -n "$no_versions" ]] ; then
-    echo $ttl
+    installed_titles_report="$installed_titles_report\n$ttl"
   else
-    echo "$ttl ($app_vers)"
+    installed_titles_report="$installed_titles_report\n$ttl ($inst_app_vers)"
   fi
 }
 

data/lib/xolo/admin/options.rb

@@ -158,6 +158,7 @@ module Xolo
       FREEZE_TITLE_CMD = 'freeze'
       THAW_TITLE_CMD = 'thaw'
       LIST_FROZEN_CMD = 'list-frozen'
+      RERUN_AUTOPKG_RECIPE_CMD = 'rerun-autopkg-recipe'
 
       LIST_VERSIONS_CMD = 'list-versions'
       ADD_VERSION_CMD = 'add-version'
@@ -382,6 +383,10 @@ module Xolo
         }
       }.freeze
 
+      DEPLOY_RELEASED = 'released'
+      DEPLOY_LATEST = 'latest'
+      DEPLOY_SPECIAL_VERSIONS = [DEPLOY_RELEASED, DEPLOY_LATEST].freeze
+
       DEPLOY_VERSION_OPTIONS = {
         groups: {
           label: 'Computer group whose computers will be targeted',
@@ -518,17 +523,6 @@ module Xolo
           confirmation: true
         },
 
-        # SUBSCRIBE_CMD => {
-        #   desc: 'Subscribe to a software title from a Patch Source defined in Jamf Pro',
-        #   display: "#{SUBSCRIBE_CMD} title",
-        #   opts: Xolo::Admin::Title.subscribe_cli_opts,
-        #   walkthru_header: "Subscribing to Xolo Title '#{TARGET_TITLE_PLACEHOLDER}'",
-        #   target: :title,
-        #   process_method: :subscribe_title,
-        #   streamed_response: true,
-        #   confirmation: true
-        # },
-
         EDIT_TITLE_CMD => {
           desc: 'Edit an exising software title',
           display: "#{EDIT_TITLE_CMD} title",
@@ -605,6 +599,19 @@ module Xolo
           process_method: :list_versions
         },
 
+        RERUN_AUTOPKG_RECIPE_CMD => {
+          desc: 'Run the AutoPkg recipe for this title again, and re-upload the new pkg.',
+          display: "#{RERUN_AUTOPKG_RECIPE_CMD} title",
+          long_desc: <<~ENDLONG,
+            The recipe will be run immediately, and the resulting .pkg will be re-uploaded for the latest version of the title.
+          ENDLONG
+          opts: {},
+          target: :title,
+          process_method: :rerun_autopkg_recipe,
+          streamed_response: true,
+          confirmation: true
+        },
+
         ADD_VERSION_CMD => {
           desc: 'Add a new version to a title, making it available for piloting',
           display: "#{ADD_VERSION_CMD} title version",
@@ -667,6 +674,8 @@ module Xolo
             Computers in any excluded-groups for the target will be removed from the list of targets
             before the MDM command is sent.
 
+            You can use the words '#{DEPLOY_RELEASED}' or '#{DEPLOY_LATEST}' as the version, or a specific one.
+
             Computers can be specified by name, serial number, or Jamf ID. Groups can be specified by
             name.
 

data/lib/xolo/admin/processing.rb

@@ -513,6 +513,24 @@ module Xolo
         handle_processing_error e
       end
 
+      # Re run the autopkg recipe
+      ################################
+      def rerun_autopkg_recipe
+        return unless confirmed? "Re-run the AutoPkg recipe for '#{cli_cmd.title}' and re-upload the new pkg"
+
+        title = Xolo::Admin::Title.fetch cli_cmd.title, server_cnx
+
+        response_data = title.rerun_autopkg_recipe server_cnx
+
+        show_debug "response_data: #{response_data}"
+
+        display_progress response_data[:progress_stream_url_path]
+
+        speak "Recipe is running for '#{cli_cmd.title}'. Upload to distribution points will happen soon."
+      rescue StandardError => e
+        handle_processing_error e
+      end
+
       # List all versions of a title in Xolo
       #
       # @return [void]
@@ -648,7 +666,23 @@ module Xolo
       # @return [void]
       ###############################
       def deploy_version
-        return unless confirmed? "Deploy Version '#{cli_cmd.version}' of Title '#{cli_cmd.title}' via MDM?"
+        # If version is 'latest' or 'released', figure out the actual version to deploy
+        if Xolo::Admin::Options::DEPLOY_SPECIAL_VERSIONS.include? cli_cmd.version
+          title = Xolo::Admin::Title.fetch cli_cmd.title, server_cnx
+          vers_display =
+            case cli_cmd.version
+            when Xolo::Admin::Options::DEPLOY_RELEASED
+              cli_cmd.version = title.released_version
+              "#{cli_cmd.version} (#{Xolo::Admin::Options::DEPLOY_RELEASED})"
+            when Xolo::Admin::Options::DEPLOY_LATEST
+              cli_cmd.version = title.version_order.first
+              "#{cli_cmd.version} (#{Xolo::Admin::Options::DEPLOY_LATEST})"
+            else
+              cli_cmd.version
+            end
+        end
+
+        return unless confirmed? "Deploy Version '#{vers_display}' of Title '#{cli_cmd.title}' via MDM?"
 
         unless json? || quiet?
           puts "Deploying Version '#{cli_cmd.version}' of Title '#{cli_cmd.title}' to computers: #{ARGV.join(', ')}"

data/lib/xolo/admin/title.rb

@@ -216,6 +216,15 @@ module Xolo
         resp.body
       end
 
+      # Rerun the autopkg recipe for this title
+      # @param cnx [Faraday::Connection] The connection to use, must be logged in already
+      # @return [Hash] the response data
+      #########################
+      def rerun_autopkg_recipe(_nx = cnx)
+        resp = cnx.post "#{SERVER_ROUTE}/#{title}/rerun_autopkg_recipe", {}
+        resp.body
+      end
+
       # Fetch the frozen computers for this title
       # @param cnx [Faraday::Connection] The connection to use, must be logged in already
       # @return [Hash{String => String}] computer name => user name

data/lib/xolo/core/version.rb

@@ -12,7 +12,7 @@ module Xolo
 
     module Version
 
-      VERSION = '2.2.4'.freeze
+      VERSION = '2.4.0'.freeze
 
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: xolo-admin
 version: !ruby/object:Gem::Version
-  version: 2.2.4
+  version: 2.4.0
 platform: ruby
 authors:
 - Chris Lasell
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-08-24 00:00:00.000000000 Z
+date: 2026-09-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday