xolo-server 2.2.0 → 2.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 84bf8381f9806f22096c6404f36e62cb49d418384cf8a9cd722bbb4afbfc60d1
-  data.tar.gz: 22e325e7e124104589c946006531cad9e5ab3b8db047b8403e66d5bb83166d0f
+  metadata.gz: 6b12ee4495ec1ef8ad6ff15963a47b8c5c960fbfc66c447355d9205a821945d5
+  data.tar.gz: b5223966d5f2d32298cbd74fceb3bc9bd86377249f05cf7ff0cdcee7d892a0ef
 SHA512:
-  metadata.gz: 8dde7e538db3e32619b7828057e7671c8eef1460a60df222f63754624d98093b66b6badf78b8834ef4517343b0464e965471cd1bbb841ec66886b20d5ca98d0a
-  data.tar.gz: 738fdb9b8c7cd66cb82c1efe39cbc00aafa011a0adc6b4936f6a2fcaadf1733f64fa88a2648a8a7d8639d4866203328be8ce8baee86103d9982e83b4cf144841
+  metadata.gz: 6891dc7666891af24efb6c3b2842154dedc0fb94652203ac7cdbce21b2f5cbf38e69dbbd54630f7c5c4f5dabdc3b717ade26c26ce1fcfbb94fc318669a2704c7
+  data.tar.gz: faf5eb9e5a6ce4e63989070bece99e9916fe44fe14a40d6e25a04a16ddeabd5d45641cf6cce380827fa0d06901bccfc345a99ea5983b2f2509223eaf816467b6

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

@@ -759,7 +759,7 @@ module Xolo
 
               By default this is false, Patch Policies for versions will be set to 'Install Automatically'.
 
-              If set to true, Patch Policies for versions will be set to 'Make Available in Self Service' and the version will appear in the Updates section when available. The update won't happen until the user clicks a button, or the 7-day deadline passes. Notifications will be displayed daily.
+              If set to true, Patch Policies for versions will be set to 'Make Available in Self Service' and the version will appear in the Updates section when available. The update won't happen until the user clicks a button, or the 7-day deadline passes. Notifications will be displayed daily. For these titles, 'xolo update' will not apply the update, but 'xolo install <title>' will update/install the current release.
 
               When installing automatically, or the deadline passes, the update will happen at the checkin after the next recon. If the version has any KillApps, the user will be prompted to quit them, with a grace period of 15 minutes before the update starts.
 

data/lib/xolo/core/version.rb

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

data/lib/xolo/server/helpers/client_data.rb

@@ -160,15 +160,24 @@ module Xolo
         #
         # This process is protected by a mutex to prevent multiple updates at the same time.
         #
+        # @param post_maint [Boolean] Are we being called at the end of the run_maint method?
+        #
         # @return [void]
         #####################
-        def update_client_data
+        def update_client_data(post_maint: false)
           # don't do anything if we are in developer/test mode
           if Xolo::Server.config.developer_mode?
             log_debug 'Jamf: Skipping client-data update in developer mode'
             return
           end
 
+          # don't do anything if maintenance is running,
+          # the main process will call this method once at the end
+          if Xolo::Server::Helpers::Maintenance.maint_running? && !post_maint
+            log_debug 'Jamf: Skipping client-data update while maintenance is running'
+            return
+          end
+
           log_info 'Jamf: Updating client-data package'
 
           # TODO: Use Concurrent Ruby instead of Mutex

data/lib/xolo/server/helpers/maintenance.rb

@@ -13,9 +13,10 @@ module Xolo
     module Helpers
 
       # Nightly maintenance tasks
-      # - accept TEd EAs
+      # - accept lingering TEd EAs, if configured to
       # - autorelease versions
       # - clean up old versions
+      # - notify title maintainers of old unreleased pilots
       #
       # Also, alerts will be posted, and Emails will be sent to the
       # admins who added versions that have been in pilot for more than
@@ -32,8 +33,24 @@ module Xolo
         # Constants
         #####################################
 
+        # TODO: ? use the next 3 values as defaults, and
+        # set them in the server config
+
+        # how often does our maint timer check to see if it should run maintenance?
+        # Slightly less than an hour means there will always be at least one check every
+        # hour, sometimes two.
+        MAINT_CHECK_INTERVAL = 3500
+        # MAINT_CHECK_INTERVAL = 600
+
         # At what hour should the nightly maintenance run?
         MAINT_HOUR = 2
+        # MAINT_HOUR = 10
+
+        # Maint won't run unless the last run was at least this many
+        # seconds ago.
+        # 23 hrs ago means that even if we check twice within the
+        # MAINT_HOUR, only the first one will run.
+        MAINT_MAX_FREQ_SECS = 23 * 3600
 
         # the route we POST to, to start the nightly process.
         TIMED_MAINT_TRIGGER_ROUTE = '/maint/maint-internal'
@@ -84,9 +101,10 @@ module Xolo
           return @maint_timer_task if @maint_timer_task
 
           @maint_timer_task =
-            Concurrent::TimerTask.new(execution_interval: 3600) { post_to_start_maint }
+            Concurrent::TimerTask.new(execution_interval: MAINT_CHECK_INTERVAL) { post_to_start_maint }
+
+          Xolo::Server.logger.info "Created Concurrent::TimerTask for nightly maintenance. Will check every #{MAINT_CHECK_INTERVAL} secs, and run during the hour of: #{MAINT_HOUR}"
 
-          Xolo::Server.logger.info 'Created Concurrent::TimerTask for nightly maintenance.'
           @maint_timer_task
         end
 
@@ -105,6 +123,12 @@ module Xolo
           @last_maint = time
         end
 
+        # @return [Time] Is maintenance running right now? true if the mutex is locked
+        ######################################
+        def self.maint_running?
+          maint_mutex.locked?
+        end
+
         # post to the server to start the maint process
         # This is done so that the maint can run in the context of a request,
         # having access to Title and Version instantiation.
@@ -118,10 +142,20 @@ module Xolo
             return
           end
 
-          # only run the maintenance if it's between 2am and 3am
-          # and the last one was more than 23 hrs ago
-          last_maint_hrs_ago = (Time.now - last_maint) / 3600
-          return unless force || (Time.now.hour == MAINT_HOUR && last_maint_hrs_ago > 23)
+          now = Time.now
+
+          # only run the maintenance if it's during the MAINT_HOUR
+          # and the last one was more than MAINT_MAX_FREQ_SECS ago
+          if force
+            Xolo::Server.logger.info 'Maint: Starting now due to force'
+
+          elsif now.hour == MAINT_HOUR && (now - last_maint) > MAINT_MAX_FREQ_SECS
+            Xolo::Server.logger.info 'Maint: Starting nightly run now'
+
+          else
+            Xolo::Server.logger.info "Maint: Not starting, it isn't time"
+            return
+          end
 
           uri = URI.parse "https://#{Xolo::Server::Helpers::Auth::IPV4_LOOPBACK}#{TIMED_MAINT_TRIGGER_ROUTE}"
           https = Net::HTTP.new(uri.host, uri.port)
@@ -153,14 +187,25 @@ module Xolo
             return
           end
           mutex.lock
+
           log_info 'Maint: starting'
 
+          # instantiate all the titles once now, rather than in all the task methods
+          title_objects_for_maint = all_title_objects refresh: true
+
           # add new maintenance tasks/methods here
-          accept_title_editor_eas
-          auto_release_versions
-          cleanup_versions
+          ######
+          accept_title_editor_eas title_objects_for_maint
+          auto_release_versions title_objects_for_maint
+          cleanup_versions title_objects_for_maint
+          notify_admins_of_unreleased_pilots title_objects_for_maint
 
+          # make note of the time.
+          Xolo::Server::Helpers::Maintenance.last_maint = Time.now
           log_info 'Maint: complete'
+
+          log_debug 'Maint: running update_client_data after all tasks'
+          update_client_data post_maint: true
         ensure
           mutex&.unlock
         end
@@ -169,17 +214,16 @@ module Xolo
         # and auto accept them if we need to
         # @return [void]
         ######################################
-        def accept_title_editor_eas
+        def accept_title_editor_eas(title_objects)
           unless Xolo::Server.config.jamf_auto_accept_xolo_eas
-            log_info 'Maint: The xolo server is not configured to auto-accept Title Editor EAs'
+            log_debug 'Maint: The xolo server is not configured to auto-accept Title Editor EAs'
             return
           end
 
           log_info 'Maint: Looking for Title Editor EAs to auto-accept'
 
-          # TODO: Be DRY with this stuff and similar in title_jamf_access.rb
-          Xolo::Server::Title.all_titles.each do |title|
-            title_obj = instantiate_title title
+          title_objects.each do |title_obj|
+            title = title_obj.title
             next if title_obj.subscribed?
             next unless title_obj.jamf_patch_ea_awaiting_acceptance?
 
@@ -195,14 +239,17 @@ module Xolo
         # Do any pending auto-releases
         # @return [void]
         ##############################
-        def auto_release_versions
+        def auto_release_versions(title_objects)
           log_info 'Maint: Auto-releasing appropriate versions'
 
           today = Date.today
 
           # Loop thru the titles
-          Xolo::Server::Title.all_titles.each do |title|
-            title_obj = instantiate_title title
+          title_objects.each do |title_obj|
+            title = title_obj.title
+
+            # nothing to do if its nil or 'none'
+            next if title_obj.auto_release_delay.nil? || title_obj.auto_release_delay == Xolo::NONE
 
             # title must be subscribed and autopkg
             # (enforced in xadm)
@@ -214,19 +261,22 @@ module Xolo
             # NOTE: it is stored as a string because it might be 'none'
             # TODO: store none as nil, so we don't have to do the pix_integer check??
             delay = title_obj.auto_release_delay.to_i
-            next unless title_obj.auto_release_delay.pix_integer? && !delay.negative?
+            next unless title_obj.auto_release_delay&.pix_integer? && !delay.negative?
 
             # Any version with this creation date should be released now, skip if not
             # So if the auto_release_delay is 7, its today - 7 days.
             # if the auto_release_delay is 0, its today - 0 days, aka today
             creation_date_to_be_released_today = today - delay
 
-            # Find the newest pilot version whose creation date is creation_date_to_be_released_today
+            # Find the newest pilot version whose creation date is
+            # creation_date_to_be_released_today or earlier
             # That one should be released now.
             vobj_to_release = nil
+
+            # version objects are in order of newest to oldest
             title_obj.version_objects.each do |vobj|
               next unless vobj.pilot?
-              next unless vobj.creation_date.to_date == creation_date_to_be_released_today
+              next unless vobj.creation_date.to_date <= creation_date_to_be_released_today
 
               vobj_to_release = vobj
               break
@@ -243,6 +293,9 @@ module Xolo
             title_obj.release vobj_to_release.version
 
             log_info "Maint: Auto-released version '#{vobj_to_release.version}' of '#{title}' which came out #{vobj_to_release.creation_date}", alert: true
+
+            # pause for server to catch up
+            sleep 60
           end # each title
 
           log_debug 'Maint: Done auto-releasing'
@@ -251,12 +304,11 @@ module Xolo
         # Cleanup versions.
         # @return [void]
         ################################
-        def cleanup_versions
-          log_info 'Maint: cleaning up deprecated and skipped versions'
-
-          Xolo::Server::Title.all_titles.each do |title|
-            title_obj = instantiate_title title
+        def cleanup_versions(title_objects)
+          log_info 'Maint: Cleaning up deprecated and skipped versions'
 
+          # Loop thru the titles
+          title_objects.each do |title_obj|
             title_obj.version_objects.each do |version|
               if version.deprecated?
                 cleanup_deprecated_version version
@@ -264,12 +316,8 @@ module Xolo
                 cleanup_skipped_version version
               end # case
             end # each version
-
-            notify_admins_of_unreleased_pilots(title_obj)
           end # each title
-
-          Xolo::Server::Helpers::Maintenance.last_maint = Time.now
-          log_info 'Maint: versions cleanup complete'
+          log_info 'Maint: Version cleanup complete'
         end
 
         # Cleanup a deprecated version.
@@ -284,7 +332,7 @@ module Xolo
           days_deprecated = (Time.now - version.deprecation_date) / 86_400
           return unless days_deprecated > deprecated_lifetime_days
 
-          log_info "Cleanup: Deleting deprecated version '#{version.version}' of title '#{version.title}'"
+          log_info "Maint: Deleting deprecated version '#{version.version}' of title '#{version.title}'"
           version.delete
         end
 
@@ -295,38 +343,50 @@ module Xolo
         def cleanup_skipped_version(version)
           return if Xolo::Server.config.keep_skipped_versions
 
-          log_info "Cleanup: Deleting skipped version '#{version.version}' of title '#{version.title}'"
+          log_info "Maint: Deleting skipped version '#{version.version}' of title '#{version.title}'"
           version.delete
         end
 
         # Notify the admins about unreleased pilots if needed
         # @return [void]
         ################################
-        def notify_admins_of_unreleased_pilots(title_obj)
-          return unless Time.now.day == UNRELEASED_PILOTS_NOTIFICATION_DAY
-          return unless unreleased_pilots_notification_days.positive?
-          return unless title_obj.latest_version
+        def notify_admins_of_unreleased_pilots(title_objects)
+          unless Time.now.day == UNRELEASED_PILOTS_NOTIFICATION_DAY
+            log_debug 'Maint: Not notifying admins of old pilots, wrong day of the month.'
+            return
+          end
+          unless unreleased_pilots_notification_days&.positive?
+            log_debug 'Maint: Not notifying admins of old pilots, unreleased_pilots_notification_days is not a positive integer'
+            return
+          end
+
+          log_info 'Maint: Notifying admins about old unreleased pilots'
 
-          latest_vers_obj = instantiate_version title: title_obj, version: title_obj.latest_version
-          return unless latest_vers_obj.pilot?
+          title_objects.each do |title_obj|
+            next unless title_obj.latest_version
 
-          days_in_pilot = ((Time.now - latest_vers_obj.creation_date) / 86_400).to_i
+            latest_vers_obj = instantiate_version title: title_obj, version: title_obj.latest_version
+            next unless latest_vers_obj.pilot?
 
-          return unless days_in_pilot > unreleased_pilots_notification_days
+            days_in_pilot = ((Time.now - latest_vers_obj.creation_date) / 86_400).to_i
 
-          alert_msg = "Cleanup: Notifying #{title_obj.contact_email} about unreleased pilot '#{latest_vers}' of title '#{title_obj.title}', in pilot for #{days_in_pilot} days"
+            next unless days_in_pilot > unreleased_pilots_notification_days
 
-          log_info alert_msg
-          send_alert alert_msg
+            alert_msg = "Maint: Notifying #{title_obj.contact_email} about unreleased pilot '#{latest_vers}' of title '#{title_obj.title}', in pilot for #{days_in_pilot} days"
 
-          email_msg = <<~MSG
+            log_info alert_msg
+            send_alert alert_msg
+
+            email_msg = <<~MSG
             The newest version '#{latest_vers_obj.version}' of title '#{title_obj.title}' has been in pilot for #{days_in_pilot} days, which makes it seem like it's not going to be released.
 
             To reduce clutter, please consider releasing it, deleting it, or deleting the whole title if it's no longer needed.
 
             If this is intentional, you can ignore this monthly message.
-          MSG
-          send_email to: title_obj.contact_email, subject: 'Unreleased Pilot Notification', msg: email_msg
+            MSG
+            send_email to: title_obj.contact_email, subject: 'Unreleased Pilot Notification', msg: email_msg
+          end # each title
+          log_info 'Maint: Done notifying admins about old unreleased pilots'
         end
 
         # how many days can a version be deprecated?

data/lib/xolo/server/mixins/title_jamf_access.rb

@@ -1450,7 +1450,7 @@ module Xolo
           jamf_patch_title.category = Xolo::Server::JAMF_XOLO_CATEGORY
           self.jamf_patch_title_id = jamf_patch_title.save
 
-          log_debug "Activated Jamf Patch Title '#{display_name}' (#{title}) with id #{jamf_patch_title_id}"
+          log_debug "Jamf: Activated Jamf Patch Title '#{display_name}' (#{title}) with id #{jamf_patch_title_id}"
 
           jamf_patch_title
         end
@@ -1716,7 +1716,9 @@ module Xolo
         def add_title_to_self_service(pol = nil)
           pol ||= jamf_manual_install_released_policy
 
-          unless pol.in_self_service?
+          if pol.in_self_service?
+            progress "Jamf: Manual Install Policy '#{pol.name}' already in Self Service."
+          else
             msg = "Jamf: Adding Manual Install Policy '#{pol.name}' to Self Service."
             progress msg, log: :info
             pol.add_to_self_service

data/lib/xolo/server/mixins/version_jamf_access.rb

@@ -939,14 +939,22 @@ module Xolo
           # explicit false
           ppol.patch_unknown = patch_unknown ? true : false
 
+          # Patch Pol. Scope Targets:
           # when first creating a patch policy, its status is always
           # 'pilot' so the scope targets are the pilot groups, if any.
+          #
           # When the version is released, the patch policy will be
-          # rescoped to all targets (limited by eligibility)
-          if pilot?
+          # rescoped to all computers (limited by eligibility)
+          #
+          # Any other state should have no scope targets
+          if pilot? || creating?
             set_policy_pilot_groups ppol
-          else
+          elsif released? || releasing?
+            log_debug "Setting Patch Policy Scope for Version '#{version}' of Title '#{title}' to all comptuers, for release"
             ppol.scope.set_all_targets
+          else
+            log_debug "Setting Patch Policy Scope for Version '#{version}' of Title '#{title}' to no targets: not in pilot or released"
+            ppol.scope.set_targets :computer_groups, []
           end
 
           # exclusions are for always
@@ -1016,9 +1024,11 @@ module Xolo
             ppol.self_service_reminder_frequency = PATCH_POL_SSVC_REMINDER_FREQ_HRS
             ppol.deadline = PATCH_POL_SSVC_DEADLINE_DAYS
 
-            return unless title_object.ssvc_icon_id
+            icon_id =
+              title_object.ssvc_icon_id || title_object.jamf_manual_install_released_policy.self_service_icon.id
+            return unless icon_id
 
-            set_patch_policy_ssvc_icon ppol, title_object.ssvc_icon_id
+            set_patch_policy_ssvc_icon ppol, icon_id
 
           # Automatic deployment
           else

data/lib/xolo/server/routes/maint.rb

@@ -51,6 +51,7 @@ module Xolo
             start_time: Xolo::Server.start_time,
             uptime: uptime_secs.pix_humanize_secs,
             uptime_secs: uptime_secs,
+            last_maint: Xolo::Server::Helpers::Maintenance.last_maint,
             app_env: Xolo::Server.app_env,
             test_server: Xolo::Server.test_server?,
             data_dir: Xolo::Server::DATA_DIR,

data/lib/xolo/server/title.rb

@@ -435,7 +435,7 @@ module Xolo
       def jamf_patch_title_id
         return @jamf_patch_title_id if @jamf_patch_title_id
 
-        log_debug "Getting jamf_patch_title_id for title '#{title}'"
+        log_debug "Jamf: Getting jamf_patch_title_id for title '#{title}'"
 
         self.jamf_patch_title_id =
           if managed?
@@ -1130,6 +1130,7 @@ module Xolo
         repair_ted_title
         set_subscribed_display_name_and_publisher
         repair_jamf_title_objects
+        self.ssvc_icon_id = jamf_manual_install_released_policy.self_service_icon.id
         save_local_data
         return unless repair_versions
 

metadata

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