xolo-server 1.0.0 → 2.0.2

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

@@ -48,6 +48,19 @@ module Xolo
         # @return [void]
         ##########################
         def create_patch_in_ted
+          if subscribed?
+            log_debug "Title Editor: SoftwareTitle '#{title}' is subscribed, skipping Title Editor patch creation"
+            return
+          end
+
+          # if the patch exists, remove and recreate it
+          if ted_patch
+            progress "Title Editor: Patch '#{version}' of SoftwareTitle '#{title}' already exists, removing & readding it..."
+            ted_title.patches.delete_patch ted_patch.patchId
+            sleep 2
+            ted_patch(refresh: true)
+          end
+
           progress "Title Editor: Creating Patch '#{version}' of SoftwareTitle '#{title}'", log: :info
           ted_title.patches.add_patch(
             version: version,
@@ -62,6 +75,9 @@ module Xolo
           set_patch_capabilites
           set_ted_patch_component_criteria ttl_obj: title_object
 
+          enable_ted_patch
+          title_object.enable_ted_title
+
           self.ted_id_number = new_patch.patchId
         end
 
@@ -72,6 +88,11 @@ module Xolo
         # @return [void]
         ##########################
         def update_patch_in_ted
+          if subscribed?
+            log_debug "Title Editor: SoftwareTitle '#{title}' is subscribed, skipping Title Editor patch update"
+            return
+          end
+
           progress "Title Editor: Updating Patch '#{version}' SoftwareTitle '#{title}'", log: :info
 
           Xolo::Server::Version::ATTRIBUTES.each do |attr, deets|
@@ -94,6 +115,9 @@ module Xolo
           # those are handled by the title object calling the same method
           #
           # set_ted_patch_component_criteria ttl_obj: title_object
+
+          enable_ted_patch
+          title_object.enable_ted_title
         end
 
         # Set any killapps for this version in the title editor.
@@ -235,9 +259,6 @@ module Xolo
           comp = ted_patch.component
 
           ea_name ? set_ea_component(comp, ea_name) : set_app_component(comp, app_name, app_bundle_id)
-
-          # SHouldn't be needed here, is called in both create and update
-          # enable_ted_patch
         end
 
         # get the param values for patch component criteria from the title object,
@@ -337,12 +358,19 @@ module Xolo
         # @return [String] the URL for the Title Editor Web App page for this patch
         ###################################
         def ted_patch_url
+          return unless managed?
+
           "https://#{Xolo::Server.config.ted_hostname}/patches/#{ted_id_number}"
         end
 
         # Ensure all the TEd items for this version are correct based on the server data.
         #########################
         def repair_ted_patch
+          if subscribed?
+            log_debug "Title Editor: SoftwareTitle '#{title}' is subscribed, skipping Title Editor patch repair"
+            return
+          end
+
           progress "Title Editor: Repairing Patch '#{version}' of SoftwareTitle '#{title}'", log: :info
 
           Xolo::Server::Version::ATTRIBUTES.each do |attr, deets|
@@ -361,7 +389,9 @@ module Xolo
           set_patch_killapps
           set_patch_capabilites
           set_ted_patch_component_criteria ttl_obj: title_object
-          enable_ted_patch unless ted_patch(refresh: true).enabled?
+          enable_ted_patch
+
+          title_object.enable_ted_title
         end
 
       end # VersionTedAccess

data/lib/xolo/server/object_locks.rb

@@ -27,7 +27,8 @@ module Xolo
       end
 
       # How many seconds are update locks valid for?
-      OBJECT_LOCK_LIMIT = 60 * 60
+      # 15 min
+      OBJECT_LOCK_LIMIT = 60 * 15
 
       # The locks for titles and versions - when they are being created or updated
       # they appear in this data structure with an expiration timestamp.

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

@@ -16,7 +16,7 @@ module Xolo
 
       module Auth
 
-        # This is how we 'mix in' modules to Sinatra servers:
+        # This is how we 'extend' modules to Sinatra servers:
         # We make them extentions here with
         #    extend Sinatra::Extension (from sinatra-contrib)
         # and then 'register' them in the server with
@@ -33,7 +33,7 @@ module Xolo
         # Auth a Xolo Admin via Jamf API login
         # Must be a member of the Jamf Admin group
         # named in Xolo::Server.config.admin_jamf_group
-        # before
+        # NOTE: This cannot be an API Client - must be a real user account
         ###################
         post '/auth/login' do
           request.body.rewind

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

@@ -16,7 +16,7 @@ module Xolo
 
       module JamfPro
 
-        # This is how we 'mix in' modules to Sinatra servers
+        # This is how we 'extend' modules to Sinatra servers
         # for route definitions and similar things
         #
         # (things to be 'included' for use in route and view processing
@@ -80,6 +80,16 @@ module Xolo
           jcnx&.disconnect
         end
 
+        # A list of all currently available titles that can be subscribed to
+        ###############
+        get '/jamf/available-titles-for-subscription' do
+          log_debug "Jamf: Fetching titles available for subscription for #{session[:admin]}"
+          jcnx = jamf_cnx
+          body available_titles_for_subscription
+        ensure
+          jcnx&.disconnect
+        end
+
       end # Module
 
     end #  Routes

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

@@ -16,7 +16,7 @@ module Xolo
 
       module Maint
 
-        # This is how we 'mix in' modules to Sinatra servers:
+        # This is how we 'extend' modules to Sinatra servers:
         # We make them extentions here with
         #    extend Sinatra::Extension (from sinatra-contrib)
         # and then 'register' them in the server with
@@ -52,6 +52,7 @@ module Xolo
             uptime: uptime_secs.pix_humanize_secs,
             uptime_secs: uptime_secs,
             app_env: Xolo::Server.app_env,
+            test_server: Xolo::Server.test_server?,
             data_dir: Xolo::Server::DATA_DIR,
             log_file: Xolo::Server::Log::LOG_FILE,
             log_level: Xolo::Server::Log::LEVELS[Xolo::Server.logger.level],

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

@@ -0,0 +1,126 @@
+# Copyright 2025 Pixar
+#
+#    Licensed under the terms set forth in the LICENSE.txt file available at
+#    at the root of this project.
+#
+
+# frozen_string_literal: true
+
+# main module
+module Xolo
+
+  # Server Module
+  module Server
+
+    module Routes
+
+      # See comments for Xolo::Server::Helpers::TitleEditor
+      #
+      module Subscriptions
+
+        # This is how we 'extend' modules to Sinatra servers
+        # for route definitions and similar things
+        #
+        # (things to be 'included' for use in route and view processing
+        # are mixed in by delcaring them to be helpers)
+        #
+        # We make them extentions here with
+        #    extend Sinatra::Extension (from sinatra-contrib)
+        # and then 'register' them in the server with
+        #    register Xolo::Server::<Module>
+        # Doing it this way allows us to split the code into a logical
+        # file structure, without re-opening the Sinatra::Base server app,
+        # and let xeitwork do the requiring of those files
+        extend Sinatra::Extension
+
+        # Module methods
+        #
+        ##############################
+        ##############################
+
+        # when this module is included
+        def self.included(includer)
+          Xolo.verbose_include includer, self
+        end
+
+        # when this module is extended
+        def self.extended(extender)
+          Xolo.verbose_extend extender, self
+        end
+
+        # Routes
+        #
+        ##############################
+        ##############################
+
+        # This endpoint receives Jamf Webhook PatchSoftwareTitleUpdated events
+        # from the Jamf Pro server, indicating that a subscribed title has a new version available.
+        #
+        # If the title is subscribed in Xolo, this creates a new xolo version for the title,
+        # and either notifies the contact email for the title, or uses autopkg to get an installer.
+        #
+        # The body will be JSON like this:
+        # {
+        #   "event": {
+        #     "jssID": integer,
+        #     "lastUpdate": epoch,
+        #     "latestVersion": "string",
+        #     "name": "string",
+        #     "reportUrls": [
+        #       "string",
+        #       "string"
+        #     ]
+        #   },
+        #   "webhook": {
+        #     "eventTimestamp": epoch,
+        #     "id": integer,
+        #     "name": "string",
+        #     "webhookEvent": "PatchSoftwareTitleUpdated"
+        #   }
+        # }
+        #
+        # Some real data:
+        #  {
+        #    "event": {
+        #      "jssID": 145,
+        #      "lastUpdate":1765926131000,
+        #      "latestVersion": "1.0.3",
+        #      "name": "Xolo Testing",
+        #      "reportUrls": [
+        #        "https://myjamf.mycompany.com:8443//patch.html?id=145&o=r"
+        #      ]
+        #    },
+        #    "webhook": {
+        #      "eventTimestamp":1765926428322,
+        #      "id": 4,
+        #      "name": "PatchSoftwareTitleUpdated",
+        #      "webhookEvent": "PatchSoftwareTitleUpdated"
+        #    }
+        #  }
+        #
+        # NOTE: The above reportUrls is incorrect on modern Jamf Pro servers.
+        # the correct one would be https://myjamf.mycompany.com:8443/view/computers/patch/145?tab=report
+        #
+        ###############
+        post '/subscribed-title-updates' do
+          session[:admin] = Xolo::Server::WEBHOOK_HANDLER_ADMIN_USERNAME
+          request.body.rewind
+
+          # this happens in a thread so that we can return a 200 response to the
+          # webhook immediately, and do the processing asynchronously (which may
+          # involve time-consuming tasks like autopkg runs)
+          process_patch_title_updated_webhook(request.body.read)
+
+          # always return 200 to the webhook sender
+          status 200
+          resp = { status: 200, message: 'Webhook event received' }
+          body resp
+        end
+
+      end # Module
+
+    end #  Routes
+
+  end #  Server
+
+end # module Xolo

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

@@ -18,7 +18,7 @@ module Xolo
       #
       module TitleEditor
 
-        # This is how we 'mix in' modules to Sinatra servers
+        # This is how we 'extend' modules to Sinatra servers
         # for route definitions and similar things
         #
         # (things to be 'included' for use in route and view processing

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

@@ -16,7 +16,7 @@ module Xolo
 
       module Titles
 
-        # This is how we 'mix in' modules to Sinatra servers
+        # This is how we 'extend' modules to Sinatra servers
         # for route definitions and similar things
         #
         # (things to be 'included' for use in route and view processing
@@ -48,11 +48,17 @@ module Xolo
           halt_on_existing_title title.title
 
           log_info "Admin #{session[:admin]} is creating title '#{title.title}'"
+          info = { status: 'created', title: title.title }
+          body info
+
           with_streaming do
             title.create
-            # we don't need to update client data when titles are created
+            # we don't need to update client data when managed titles are created
             # because they don't have any versions yet, so there's nothing a
             # client can do with them.
+            #
+            # However subscribed titles will have their latest version activated
+            # will need client data updated
           end
         end
 
@@ -240,13 +246,14 @@ module Xolo
         #################################
         get '/titles/:title/urls' do
           log_debug "Admin #{session[:admin]} is fetching GUI URLS for title '#{params[:title]}'"
+
           halt_on_missing_title params[:title]
           title = instantiate_title params[:title]
-          data = {
-            ted_title_url: title.ted_title_url,
-            jamf_installed_group_url: title.jamf_installed_group_url,
-            jamf_frozen_group_url: title.jamf_frozen_group_url
-          }
+
+          data = {}
+          data[:ted_title_url] = title.ted_title_url if title.managed?
+          data[:jamf_installed_group_url] = title.jamf_installed_group_url if title.jamf_installed_group_exist?
+          data[:jamf_frozen_group_url] = title.jamf_frozen_group_url if title.jamf_frozen_group_exist?
           data[:jamf_manual_install_released_policy_url] = title.jamf_manual_install_released_policy_url if title.jamf_manual_install_released_policy_exist?
 
           if title.uninstallable?
@@ -255,13 +262,11 @@ module Xolo
             data[:jamf_expire_policy_url] = title.jamf_expire_policy_url if title.expiration
           end
 
-          if title.jamf_ted_title_active?
-            data[:jamf_patch_title_url] = title.jamf_patch_title_url unless title.versions.empty?
+          if title.jamf_title_active?
+            data[:jamf_patch_title_url] = title.jamf_patch_title_url unless title.jamf_patch_title_id.pix_empty?
             data[:jamf_patch_ea_url] = title.jamf_patch_ea_url if title.version_script
           end
 
-          data[:jamf_normal_ea_url] = title.jamf_normal_ea_url if title.version_script
-
           body data
         end
 
@@ -276,6 +281,16 @@ module Xolo
           body title.changelog
         end
 
+        # Does this xolo server support autopkg integration?
+        #
+        # @return [Array<Hash>] The changelog for a title
+        #################################
+        get '/titles/autopkg_enabled' do
+          log_debug "Admin #{session[:admin]} is checking if autopkg is enabled on this server"
+          data = { autopkg_enabled: autopkg_enabled? }
+          body data
+        end
+
       end # Titles
 
     end #  Routes

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

@@ -62,20 +62,6 @@ module Xolo
         ##############################
         ##############################
 
-        # # param with the uploaded file must be :file
-        # ######################
-        # post '/upload/ssvc-icon/:title' do
-        #   process_incoming_ssvc_icon
-        #   body({ result: :uploaded })
-        # end
-
-        # # param with the uploaded file must be :file
-        # ######################
-        # post '/upload/pkg/:title/:version' do
-        #   process_incoming_pkg
-        #   body({ result: :uploaded })
-        # end
-
         # param with the uploaded file must be :file
         ######################
         post '/upload/test' do

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

@@ -16,7 +16,7 @@ module Xolo
 
       module Versions
 
-        # This is how we 'mix in' modules to Sinatra servers
+        # This is how we 'extend' modules to Sinatra servers
         # for route definitions and similar things
         #
         # (things to be 'included' for use in route and view processing
@@ -58,9 +58,10 @@ module Xolo
           data[:min_os] = default_min_os if data[:min_os].pix_empty?
 
           log_debug "Incoming new version data: #{data}"
-          log_debug "Incoming new version data: #{data.class}"
 
-          vers = instantiate_version(data)
+          vers = instantiate_version(**data)
+          log_debug "Instantiated version object: #{vers.class} - #{vers.title} #{vers.version}"
+
           halt_on_existing_version vers.title, vers.version
 
           if vers.title_object.jamf_patch_ea_awaiting_acceptance? && !Xolo::Server.config.jamf_auto_accept_xolo_eas
@@ -89,9 +90,9 @@ module Xolo
 
           log_debug "Admin #{session[:admin]} is listing all versions for title '#{params[:title]}'"
           # body all_versions(params[:title])
-          vers_ins = all_version_instances(params[:title])
+          vers_objs = all_version_objects(params[:title])
           # log_debug "vers_ins: #{vers_ins}"
-          body vers_ins.map(&:to_h)
+          body vers_objs.map(&:to_h)
         end
 
         # get all the data for a single version
@@ -156,7 +157,7 @@ module Xolo
         # param with the uploaded file must be :file
         ######################
         post '/titles/:title/versions/:version/pkg' do
-          process_incoming_pkg
+          process_and_upload_uploaded_pkg
           body({ result: :uploaded })
         end
 
@@ -239,13 +240,13 @@ module Xolo
 
           halt_on_missing_version params[:title], params[:version]
           vers = instantiate_version title: params[:title], version: params[:version]
-          data = {
-            ted_patch_url: vers.ted_patch_url,
-            jamf_auto_install_policy_url: vers.jamf_auto_install_policy_url,
-            jamf_manual_install_policy_url: vers.jamf_manual_install_policy_url,
-            jamf_patch_policy_url: vers.jamf_patch_policy_url,
-            jamf_package_url: vers.jamf_package_url
-          }
+
+          data = {}
+          data[:ted_patch_url] = vers.ted_patch_url if vers.managed?
+          data[:jamf_auto_install_policy_url] = vers.jamf_auto_install_policy_url if vers.jamf_auto_install_policy_exist?
+          data[:jamf_manual_install_policy_url] = vers.jamf_manual_install_policy_url if vers.jamf_manual_install_policy_exist?
+          data[:jamf_patch_policy_url] = vers.jamf_patch_policy_url if vers.jamf_patch_policy_exist?
+          data[:jamf_package_url] = vers.jamf_package_url if vers.jamf_package_exist?
           data[:jamf_version_installed_group] = vers.jamf_installed_group_url if vers.jamf_installed_group_exist?
           data[:jamf_auto_reinstall_policy_url] = vers.jamf_auto_reinstall_policy_url if vers.jamf_auto_reinstall_policy_exist?
 

data/lib/xolo/server/routes.rb

@@ -49,6 +49,14 @@ module Xolo
         log_debug "Checking if request path '#{request.path}' is in INTERNAL_ROUTES"
         break if Xolo::Server::Helpers::Auth::INTERNAL_ROUTES.include?(request.path) && valid_internal_auth_token?
 
+        # This route is used by Jamf Pro Webhooks to notify Xolo of subscribed title updates
+        log_debug "Checking if request path '#{request.path}' is PATCH_TITLE_UPDATED_WEBHOOK_ROUTE"
+        if request.path == Xolo::Server::Helpers::Auth::PATCH_TITLE_UPDATED_WEBHOOK_ROUTE
+          break if jamf_webhook_auth_token_ok?
+
+          halt 401, { status: 401, error: 'Valid Bearer Token Required' }
+        end
+
         # these routes are for server admins only, and require an authenticated session
         log_debug "Checking if request path '#{request.path}' is in SERVER_ADMIN_ROUTES"
         break if Xolo::Server::Helpers::Auth::SERVER_ADMIN_ROUTES.include?(request.path) && valid_server_admin?
@@ -71,15 +79,12 @@ module Xolo
       ##############
       after do
         # log a stack trace if the response status is 4xx or 5xx, or if there's a sinatra.error
-        if response.status >= 400
-          log_error "Response status #{response.status} for #{request.request_method} #{request.path}"
-          if env['sinatra.error']
-            log_error "Sinatra Error message: #{env['sinatra.error'].message}"
-            env['sinatra.error'].backtrace.each { |line| log_error "..#{line}" }
-          else
-            log_error 'Xolo Stack trace:'
-            caller.each { |line| log_error "..#{line}" }
-          end
+        log_debug "Response status #{response.status} for #{request.request_method} #{request.path}" if response.status >= 400
+
+        sinatra_error = env['sinatra.error']
+        if sinatra_error
+          log_error "Sinatra Error message: #{sinatra_error.message}"
+          sinatra_error.backtrace.each { |line| log_error "..#{line}" }
         end
 
         if @no_json
@@ -99,7 +104,6 @@ module Xolo
         # from ruby-jss and windoo api connections?
         # perhaps a callback to when a Sinatra server instance
         # 'finishes'?
-        # can't
       end
 
       # Ping
@@ -135,19 +139,6 @@ module Xolo
       # test
       ##########
       get '/test' do
-        # Xolo::Server::Helpers::Maintenance.post_to_start_cleanup force: true
-        # result = { result: 'posted to start cleanup' }
-
-        # send_email(
-        #   to: 'xolo@pixar.com',
-        #   subject: 'Test Email from Xolo Server',
-        #   msg: 'This is a test email from the Xolo Server'
-        # )
-        # result = { result: 'message sent' }
-
-        # client_data_testing
-        # update_client_data
-
         result = { result: 'test' }
 
         body result
@@ -166,3 +157,4 @@ require 'xolo/server/routes/title_editor'
 require 'xolo/server/routes/titles'
 require 'xolo/server/routes/uploads'
 require 'xolo/server/routes/versions'
+require 'xolo/server/routes/subscriptions'