xolo-admin 2.2.3 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 857b7c06e0c9ed5ae064b1cb7c9270341a9ac1abdfdeec8cc1ab648435db20e8
-  data.tar.gz: 16f4edacf06637787b409f32fc86619e9e1a4910b31103d0323b6e0bc244e2c2
+  metadata.gz: 93b88b4836493ad597c2417b6c83f5ed5526a71e1b434ef391ccfe3cc46bfbd6
+  data.tar.gz: b6647511a33dfcdf8812be9dc615c7134df5b8ce989b766c6fd6f33886b188d3
 SHA512:
-  metadata.gz: cf0e7d27e355ea94392c1ebbc96fadc4778b40476d6ab70b53ccee672c9742da95d3f8adf330275dc44370d5e8c4dcfb431a2f29503814ad1f19d93745fa4019
-  data.tar.gz: 1e8b5ffb2ac2f473536d6624da8945382eb1e23f291ab89b9430dd4d4b5324473397d60b9d48217e5727cfa81fb7005c3e36299bb6372127dc10818d8ffef84b
+  metadata.gz: 7e797fdfa95678ab2f6811f44f860a0b5018c72fce7654bb11260d35b176dd19ef84c7d1c250f414dd26d643f21596624cf97cff498fd2c27f005845b5dec330
+  data.tar.gz: de7997dd22b4c59149e1d8b9c565628e959b0636130699997dbb3e339a7debdadc12ac6f5d592eeb188e493b8a7b10d178f7118c6dc798fd839c742a8919b5b8

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"
@@ -356,42 +359,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"
 
-    # $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 [[ -f "$app_plist" ]] ; then
+      app_bundle_id=$(/usr/bin/plutil -extract CFBundleIdentifier raw "$app_plist" 2>/dev/null)
+
+      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 +406,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 +529,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
@@ -1020,12 +1086,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 +1105,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 +1146,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 +1185,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/configuration.rb

@@ -17,7 +17,7 @@ module Xolo
 
       include Singleton
 
-      # Save to yaml file in ~/Library/Preferences/com.pixar.xolo.admin.prefs.yaml
+      # Save to yaml file in ~/Library/Preferences/com.pixar.xolo.admin.config.yaml
       #
       # - hostname of xolo server
       #   - always port 443, for now

data/lib/xolo/admin/options.rb

@@ -274,6 +274,17 @@ module Xolo
           desc: <<~ENDDESC
             Show only titles that have --release-groups set to 'all'.
           ENDDESC
+        },
+
+        version_scripts: {
+          label: 'Using Version Scripts',
+          cli: :v,
+          type: :boolean,
+          validate: :validate_boolean,
+          default: false,
+          desc: <<~ENDDESC
+            Show only titles that use a version script.
+          ENDDESC
         }
 
       }.freeze

data/lib/xolo/admin/processing.rb

@@ -195,8 +195,7 @@ module Xolo
       # @return [void]
       ###############################
       def update_config
-        debug? && puts("DEBUG: opts_to_process: #{opts_to_process}")
-
+        show_debug "DEBUG: opts_to_process: #{opts_to_process}"
         # Xolo::Admin::Configuration::KEYS.each_key do |key|
         #   config.send "#{key}=", opts_to_process[key]
         # end
@@ -225,6 +224,7 @@ module Xolo
         type ||= opts_to_process.managed ? ' managed' : nil
         autopkg = opts_to_process.autopkg ? ' autopkg' : nil
         pilots = opts_to_process.pilots ? ' with unreleased pilots' : nil
+        vscripts = opts_to_process.version_scripts ? ' with version scripts' : nil
         to_all = opts_to_process.released_to_all ? ",\n# released to all non-excluded computers." : nil
 
         ssvc =
@@ -236,7 +236,7 @@ module Xolo
             ' updated via Self Service'
           end
 
-        report_title = "All#{type}#{autopkg} titles in Xolo#{pilots}#{ssvc}#{to_all}"
+        report_title = "All#{type}#{autopkg} titles in Xolo#{pilots}#{ssvc}#{vscripts}#{to_all}"
 
         titles.select!(&:subscribed?) if opts_to_process.subscribed
         titles.reject!(&:subscribed?) if opts_to_process.managed
@@ -247,6 +247,7 @@ module Xolo
         # pending_pilots is a local method, not a title attribute!
         titles.select! { |t| pending_pilots? t } if opts_to_process.pilots
         titles.select! { |t| t.release_groups.include? Xolo::TARGET_ALL } if opts_to_process.released_to_all
+        titles.reject! { |t| t.version_script.pix_empty? } if opts_to_process.version_scripts
 
         header = %w[Title Created By SSvc Latest Released]
 
@@ -310,10 +311,8 @@ module Xolo
 
         response_data = new_title.add(server_cnx)
 
-        if debug?
-          puts "DEBUG: response_data: #{response_data}"
-          puts
-        end
+        show_debug "response_data: #{response_data}"
+
         if response_data[:progress_stream_url_path]
           display_progress response_data[:progress_stream_url_path]
         else
@@ -350,10 +349,7 @@ module Xolo
         title = Xolo::Admin::Title.new opts_to_process
         response_data = title.update server_cnx
 
-        if debug?
-          puts "DEBUG: response_data: #{response_data}"
-          puts
-        end
+        show_debug "response_data: #{response_data}"
 
         display_progress response_data[:progress_stream_url_path]
 
@@ -420,10 +416,7 @@ module Xolo
 
         response_data = Xolo::Admin::Title.delete cli_cmd.title, server_cnx
 
-        if debug?
-          puts "DEBUG: response_data: #{response_data}"
-          puts
-        end
+        show_debug "response_data: #{response_data}"
 
         display_progress response_data[:progress_stream_url_path]
 
@@ -448,10 +441,7 @@ module Xolo
         title = Xolo::Admin::Title.fetch cli_cmd.title, server_cnx
         response_data = title.freeze ARGV, cli_cmd_opts.users_given, server_cnx
 
-        if debug?
-          puts "DEBUG: response_data: #{response_data}"
-          puts
-        end
+        show_debug "response_data: #{response_data}"
 
         if json?
           puts JSON.pretty_generate(response_data)
@@ -473,10 +463,7 @@ module Xolo
       def list_frozen
         title = Xolo::Admin::Title.fetch cli_cmd.title, server_cnx
         frozen_computers = title.frozen server_cnx
-        if debug?
-          puts "DEBUG: response_data: #{frozen_computers}"
-          puts
-        end
+        show_debug "response_data: #{frozen_computers}"
 
         if json?
           puts JSON.pretty_generate(frozen_computers)
@@ -511,10 +498,7 @@ module Xolo
         title = Xolo::Admin::Title.fetch cli_cmd.title, server_cnx
         response_data = title.thaw ARGV, cli_cmd_opts.users_given, server_cnx
 
-        if debug?
-          puts "DEBUG: response_data: #{response_data}"
-          puts
-        end
+        show_debug "response_data: #{response_data}"
 
         if json?
           puts JSON.pretty_generate(response_data)
@@ -580,14 +564,13 @@ module Xolo
         new_vers = Xolo::Admin::Version.new opts_to_process
         response_data = new_vers.add(server_cnx)
 
-        if debug?
-          puts "DEBUG: response_data: #{response_data}"
-          puts
-        end
+        show_debug "response_data: #{response_data}"
 
         display_progress response_data[:progress_stream_url_path]
 
         # Upload the pkg, if any?
+        # for pkg creation, no upload if autopkg.
+        # but yes for edits.
         upload_pkg(new_vers) unless title_obj.autopkg_enabled?
 
         speak 'It can take up to 15 minutes for the version to be available for use. Please do not release it before then'
@@ -608,11 +591,16 @@ module Xolo
       # @return [void]
       ################################
       def upload_pkg(version)
-        return unless version.pkg_to_upload.is_a? Pathname
+        unless version.pkg_to_upload.is_a? Pathname
+          show_debug "version.pkg_to_upload class: #{version.pkg_to_upload.class}"
+          return
+        end
 
-        # TODO: deal with autopkg pkgs, should we be able to do this?
+        # pause a moment for the previous stream to end.
+        sleep 5
 
         speak "Uploading #{version.pkg_to_upload.basename}, #{version.pkg_to_upload.pix_humanize_size} to Xolo"
+
         # start the upload in a thread
         upload_thr = Thread.new { version.upload_pkg(upload_cnx) }
 
@@ -642,14 +630,12 @@ module Xolo
 
         response_data = vers.update server_cnx
 
-        if debug?
-          puts "DEBUG: response_data: #{response_data}"
-          puts
-        end
+        show_debug "response_data: #{response_data}"
 
         display_progress response_data[:progress_stream_url_path]
 
         # Upload the pkg, if any?
+        # speak 'Upload would happen here'
         upload_pkg(vers)
 
         speak "Version '#{cli_cmd.version}' of title '#{cli_cmd.title}' has been updated in Xolo."
@@ -712,10 +698,7 @@ module Xolo
 
         response_data = Xolo::Admin::Version.delete cli_cmd.title, cli_cmd.version, server_cnx
 
-        if debug?
-          puts "DEBUG: response_data: #{response_data}"
-          puts
-        end
+        show_debug "response_data: #{response_data}"
 
         display_progress response_data[:progress_stream_url_path]
       rescue StandardError => e
@@ -734,10 +717,7 @@ module Xolo
         title = Xolo::Admin::Title.new opts_to_process
         response_data = title.release server_cnx, version: cli_cmd.version
 
-        if debug?
-          puts "DEBUG: response_data: #{response_data}"
-          puts
-        end
+        show_debug "response_data: #{response_data}"
 
         display_progress response_data[:progress_stream_url_path]
         speak "Version '#{cli_cmd.version}' of Title '#{cli_cmd.title}' has been released."
@@ -886,10 +866,7 @@ module Xolo
           title = Xolo::Admin::Title.fetch cli_cmd.title, server_cnx
           response_data = title.repair server_cnx, versions: opts_to_process[:versions]
         end
-        if debug?
-          puts "DEBUG: response_data: #{response_data}"
-          puts
-        end
+        show_debug "response_data: #{response_data}"
 
         display_progress response_data[:progress_stream_url_path]
       rescue StandardError => e
@@ -1113,10 +1090,7 @@ module Xolo
         result = server_cnx.post(SERVER_SHUTDOWN_ROUTE, payload).body
         puts "result[:result] = #{result[:result]}"
 
-        if debug?
-          puts "DEBUG: response_data: #{result}"
-          puts
-        end
+        show_debug "response_data: #{result}"
 
         display_progress result[:progress_stream_url_path]
 

data/lib/xolo/core/base_classes/configuration.rb

@@ -33,7 +33,7 @@ module Xolo
       # Instance method #conf_file [Pathname]
       #  The full expanded absolute path to the config yaml file.
       #
-      # Constant KEYS [Hash{Symbol: Hash}]
+      # Constant KEYS [Hash {Symbol: Hash}]
       #   The keys of this Hash are the keys that may be found in the yaml file.
       #   The Hash values here define the value in the YAML file, with these keys:
       #

data/lib/xolo/core/base_classes/server_object.rb

@@ -14,12 +14,9 @@ module Xolo
 
     module BaseClasses
 
-      # The base class for dealing with Titles and Versions/Patches in the
-      # Xolo Server, Admin, and Client modules.
-      #
       # The base class for "xolo objects stored on the xolo server", i.e.
       # Titles and Versions/Patches - whether they are being used on the server,
-      # in xadm, or in the client.
+      # or in xadm.
       #
       # This class holds stuff common to all no matter where or how they are used.
       #

data/lib/xolo/core/base_classes/title.rb

@@ -15,12 +15,12 @@ module Xolo
     module BaseClasses
 
       # The base class for dealing with Titles in the
-      # Xolo Server, Admin, and Client modules.
+      # Xolo Server & Admin modules.
       #
       # This class holds the common aspects of Xolo Titles as used
-      # on the Xolo server, in the Xolo Admin CLI app 'xadm', and the
-      # client app 'xolo' - most importately it defines which data they
-      # exchange.
+      # on the Xolo server and in the Xolo Admin CLI app 'xadm'
+      # and the 'xolo' client app (as JSON data).
+      # - most importately it defines which data they exchange.
       #
       ############################
       class Title < Xolo::Core::BaseClasses::ServerObject
@@ -43,7 +43,7 @@ module Xolo
         #
         # This hash defines the common attributes of all Xolo titles - which should
         # be available in all subclasses, both on the server, in xadm, and via the
-        # client.
+        # client (as JSON data).
         #
         # Each of those subclasses might define (and store or calculate) other
         # attributes as needed.
@@ -966,6 +966,14 @@ module Xolo
           version_order&.first
         end
 
+        # Does a given version exist for this title?
+        # @param vers [String] the version in question
+        # @return [Boolean]
+        #######################
+        def version_exist?(vers)
+          version_order.include? vers
+        end
+
         # Is this a managed title?
         # @return [Boolean]
         #######################

data/lib/xolo/core/base_classes/version.rb

@@ -15,12 +15,12 @@ module Xolo
     module BaseClasses
 
       # The base class for dealing with Versions/Patches in the
-      # Xolo Server, Admin, and Client modules.
+      # Xolo Server & Admin modules.
       #
       # This class holds the common aspects of Xolo Versinos as used
-      # on the Xolo server, in the Xolo Admin CLI app 'xadm', and the
-      # client app 'xolo' - most importately it defines which data they
-      # exchange.
+      # on the Xolo server and in the Xolo Admin CLI app 'xadm'
+      # and the 'xolo' client app (as JSON data).
+      # - most importately it defines which data they exchange.
       #
       ############################
       class Version < Xolo::Core::BaseClasses::ServerObject

data/lib/xolo/core/version.rb

@@ -12,7 +12,7 @@ module Xolo
 
     module Version
 
-      VERSION = '2.2.3'.freeze
+      VERSION = '2.3.0'.freeze
 
     end
 

metadata

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