xolo-server 1.0.0

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

@@ -0,0 +1,174 @@
+# 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
+
+      module Maint
+
+        # This is how we 'mix in' modules to Sinatra servers:
+        # 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,
+        extend Sinatra::Extension
+
+        # 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
+
+        # Threads
+        ##########
+        get '/maint/threads' do
+          body Xolo::Server.thread_info
+        end
+
+        # State
+        ##########
+        get '/maint/state' do
+          require 'concurrent/version'
+          uptime_secs = (Time.now - Xolo::Server.start_time).to_i
+
+          state = {
+            start_time: Xolo::Server.start_time,
+            uptime: uptime_secs.pix_humanize_secs,
+            uptime_secs: uptime_secs,
+            app_env: Xolo::Server.app_env,
+            data_dir: Xolo::Server::DATA_DIR,
+            log_file: Xolo::Server::Log::LOG_FILE,
+            log_level: Xolo::Server::Log::LEVELS[Xolo::Server.logger.level],
+            ruby_version: RUBY_VERSION,
+            gems: {
+              xolo_version: Xolo::VERSION,
+              ruby_jss_version: Jamf::VERSION,
+              windoo_version: Windoo::VERSION,
+              sinatra_version: Sinatra::VERSION,
+              thin_version: Thin::VERSION::STRING,
+              concurrent_ruby_version: Concurrent::VERSION,
+              faraday_version: Faraday::VERSION
+            },
+            config: Xolo::Server.config.to_h_private
+          }
+
+          if params[:extended]
+            state[:gem_path] = Gem.paths.path
+            state[:load_path] = $LOAD_PATH
+            state[:object_locks] = Xolo::Server.object_locks
+            state[:pkg_deletion_pool] = Xolo::Server::Version.pkg_deletion_pool_info
+            state[:threads] = Xolo::Server.thread_info
+          end
+
+          body state
+        end
+
+        # run the cleanup process from the internal timer task
+        # The before filter will ensure the request came from the server itself.
+        # with a valid internal auth token.
+        ################
+        post '/maint/cleanup-internal' do
+          log_info 'Starting internal cleanup'
+          session[:admin] = 'Automated Cleanup'
+
+          thr = Thread.new { run_cleanup }
+          thr.name = 'Internal Cleanup Thread'
+          result = { result: 'Internal Cleanup Underway' }
+          body result
+        end
+
+        # run the cleanup process manually from a server admin via xadm
+        ################
+        post '/maint/cleanup' do
+          log_info "Starting manual server cleanup by #{session[:admin]}"
+
+          session[:admin] = "Cleanup by #{session[:admin]}"
+          thr = Thread.new { run_cleanup }
+          thr.name = 'Manual Cleanup Thread'
+          result = { result: 'Manual Cleanup Underway' }
+          body result
+        end
+
+        # force an update of the client data
+        ################
+        post '/maint/update-client-data' do
+          log_info "Force update of client-data by #{session[:admin]}"
+          log_debug "Gem Paths: #{Gem.paths.inspect}"
+
+          thr = Thread.new { update_client_data }
+          thr.name = 'Manual Client Data Update Thread'
+          result = { result: 'Client Data Update underway' }
+          body result
+        end
+
+        # force log rotation
+        ################
+        post '/maint/rotate-logs' do
+          log_info "Force log rotation by #{session[:admin]}"
+
+          thr = Thread.new { Xolo::Server::Log.rotate_logs force: true }
+          thr.name = 'Manual Log Rotation Thread'
+          result = { result: 'Log rotation underway' }
+          body result
+        end
+
+        # set the log level
+        ################
+        post '/maint/set-log-level' do
+          request.body.rewind
+          payload = parse_json request.body.read
+          level = payload[:level]
+
+          log_info "Setting log level to #{level} by #{session[:admin]}"
+          Xolo::Server.set_log_level level, admin: session[:admin]
+
+          result = { result: "Log level set to #{level}" }
+          body result
+        end
+
+        # Shutdown the server gracefully
+        # stop accepting new requests
+        # wait for all queues and threads to finish, including:
+        #  the cleanup timer task & mutex
+        #  the log rotation timer task & mutex
+        #  the pkg deletion pool
+        #  the object locks
+        #  the progress streams, including this one, which will be the last thing to finish
+        ################
+        post '/maint/shutdown-server' do
+          request.body.rewind
+          payload = parse_json request.body.read
+          restart = payload[:restart]
+
+          # for streamed responses, the with_streaming block must
+          # be the last thing in the route
+          with_streaming do
+            # give the stream a chance to get started
+            sleep 2
+            shutdown_server restart
+          end
+        end
+
+      end # module maint
+
+    end #  Routes
+
+  end #  Server
+
+end # module Xolo

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

@@ -0,0 +1,71 @@
+# 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 TitleEditor
+
+        # This is how we 'mix in' 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
+        #
+        ##############################
+        ##############################
+
+        ###############
+        get '/title-editor/titles' do
+          log_debug "Fetching Title Editor titles for #{session[:admin]}"
+          wcnx = ted_cnx
+          body Windoo::SoftwareTitle.all(cnx: wcnx).map { |t| t[:id] }.sort
+        ensure
+          wcnx&.disconnect
+        end
+
+      end # Module
+
+    end #  Routes
+
+  end #  Server
+
+end # module Xolo

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

@@ -0,0 +1,285 @@
+# 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
+
+      module Titles
+
+        # This is how we 'mix in' 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
+        extend Sinatra::Extension
+
+        # when this module is included
+        def self.included(includer)
+          Xolo.verbose_include includer, self
+        end
+
+        # Create a new title from the body content of the request
+        #
+        # @return [Hash] A response hash
+        #################################
+        post '/titles' do
+          request.body.rewind
+          data = parse_json(request.body.read)
+          log_debug "Incoming new title data: #{data}"
+
+          title = instantiate_title data
+          halt_on_existing_title title.title
+
+          log_info "Admin #{session[:admin]} is creating title '#{title.title}'"
+          with_streaming do
+            title.create
+            # we don't need to update client data when titles are created
+            # because they don't have any versions yet, so there's nothing a
+            # client can do with them.
+          end
+        end
+
+        # get an array of titles
+        # @return [Array<Hash>] the data for existing titles
+        #################################
+        get '/titles' do
+          log_debug "Admin #{session[:admin]} is fetching all titles"
+          body all_title_objects.map(&:to_h)
+        end
+
+        # get all the data for a single title
+        # @return [Hash] The data for this title
+        #################################
+        get '/titles/:title' do
+          log_debug "Admin #{session[:admin]} is fetching title '#{params[:title]}'"
+          halt_on_missing_title params[:title]
+
+          title = instantiate_title params[:title]
+
+          body title.to_h
+        end
+
+        # Update a title by
+        # replacing the data for an existing title with the content of the request
+        # @return [Hash] A response hash
+        #################################
+        put '/titles/:title' do
+          halt_on_missing_title params[:title]
+          halt_on_locked_title params[:title]
+
+          title = instantiate_title params[:title]
+
+          request.body.rewind
+          new_data = parse_json(request.body.read)
+          log_debug "Incoming update title data: #{new_data}"
+
+          log_info "Admin #{session[:admin]} is updating title '#{params[:title]}'"
+          with_streaming do
+            title.update new_data
+            update_client_data
+          end
+        end
+
+        # Release a version of a title
+        #
+        # @return [Hash] A response hash
+        #################################
+        patch '/titles/:title/release/:version' do
+          log_info "Admin #{session[:admin]} is releasing version #{params[:version]} of title '#{params[:title]}' via PATCH"
+
+          halt_on_missing_title params[:title]
+          halt_on_missing_version params[:title], params[:version]
+          halt_on_locked_title params[:title]
+          halt_on_locked_version params[:title], params[:version]
+
+          title = instantiate_title params[:title]
+
+          if title.released_version == params[:version]
+            msg = "Version '#{params[:version]}' of title '#{params[:title]}' is already released"
+            log_debug "ERROR: #{msg}"
+            halt 409, { status: 409, error: msg }
+          end
+
+          vers_to_release = params[:version]
+
+          with_streaming do
+            title.release vers_to_release
+            update_client_data
+          end
+        end
+
+        # run 'repair' on a title
+        # to do all versions, body should be JSON { "repair_versions": true }
+        ######################
+        post '/titles/:title/repair' do
+          request.body.rewind
+          data = request.body.read.strip
+          do_versions = data.pix_empty? ? false : parse_json(data)[:repair_versions]
+
+          addendum = do_versions ? ' and all versions' : ' (title only)'
+          log_debug "Admin #{session[:admin]} is repairing title '#{params[:title]}'#{addendum}"
+
+          halt_on_missing_title params[:title]
+          halt_on_locked_title params[:title]
+          title = instantiate_title params[:title]
+
+          with_streaming do
+            title.repair repair_versions: do_versions
+            update_client_data
+          end
+        end
+
+        # Delete an existing title
+        # @return [Hash] A response hash
+        #################################
+        delete '/titles/:title' do
+          halt_on_missing_title params[:title]
+
+          title = instantiate_title params[:title]
+
+          with_streaming do
+            title.delete
+            update_client_data
+          end
+        end
+
+        # Handle upload for self-service icon for a title
+        #
+        # @return [Hash] A response hash
+        #################################
+        post '/titles/:title/ssvc-icon' do
+          process_incoming_ssvc_icon
+          body({ result: :uploaded })
+        end
+
+        # Return the members of the 'frozen' static group for a title
+        #
+        # @return [Hash{String => String}] computer name => user name
+        #################################
+        get '/titles/:title/frozen' do
+          log_debug "Admin #{session[:admin]} is fetching frozen computers for title '#{params[:title]}'"
+          halt_on_missing_title params[:title]
+          title = instantiate_title params[:title]
+          body title.frozen_computers
+        end
+
+        # add one or more computers to the 'frozen' static group for a title
+        # Body should be an array of computer names
+        #
+        # @return [Hash] A response hash
+        #################################
+        put '/titles/:title/freeze' do
+          halt_on_missing_title params[:title]
+
+          request.body.rewind
+          data = parse_json(request.body.read)
+
+          comps_to_freeze = expand_freeze_thaw_targets(targets: data[:targets], users: data[:users])
+
+          log_debug "Target computers to freeze for title #{params[:title]}: #{comps_to_freeze}"
+          title = instantiate_title params[:title]
+
+          result = title.freeze_or_thaw_computers(action: :freeze, computers: comps_to_freeze)
+          body result
+        end
+
+        # remove one or more computers from the 'frozen' static group for a title
+        # Body should be an array of computer names
+        #
+        # If any computer name is 'clear_all' then all frozen computers will be thawed
+        #
+        # @return [Hash] A response hash
+        #################################
+        put '/titles/:title/thaw' do
+          halt_on_missing_title params[:title]
+
+          request.body.rewind
+          data = parse_json(request.body.read)
+
+          comps_to_thaw = expand_freeze_thaw_targets(targets: data[:targets], users: data[:users])
+
+          log_debug "Incoming computers to thaw for title #{params[:title]}: #{comps_to_thaw}"
+          title = instantiate_title params[:title]
+
+          result = title.freeze_or_thaw_computers(action: :thaw, computers: comps_to_thaw)
+          body result
+        end
+
+        # Return info about all the computers with a given title installed
+        #
+        # @return [Array<Hash>] The data for all computers with the given title
+        #################################
+        get '/titles/:title/patch_report' do
+          log_debug "Admin #{session[:admin]} is fetching patch report for title '#{params[:title]}'"
+          halt_on_missing_title params[:title]
+          title = instantiate_title params[:title]
+
+          body title.patch_report
+        end
+
+        # Return URLs for all the UI pages for a title
+        #
+        # @return [Hash] The URLs for all the UI pages for a title
+        #################################
+        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[:jamf_manual_install_released_policy_url] = title.jamf_manual_install_released_policy_url if title.jamf_manual_install_released_policy_exist?
+
+          if title.uninstallable?
+            data[:jamf_uninstall_script_url] = title.jamf_uninstall_script_url
+            data[:jamf_uninstall_policy_url] = title.jamf_uninstall_policy_url
+            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?
+            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
+
+        # Return the changelog for a title
+        #
+        # @return [Array<Hash>] The changelog for a title
+        #################################
+        get '/titles/:title/changelog' do
+          log_debug "Admin #{session[:admin]} is fetching the change log for title '#{params[:title]}'"
+          halt_on_missing_title params[:title]
+          title = instantiate_title params[:title]
+          body title.changelog
+        end
+
+      end # Titles
+
+    end #  Routes
+
+  end #  Server
+
+end # module Xolo

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

@@ -0,0 +1,93 @@
+# 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
+
+      module Uploads
+
+        # 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
+
+        # This hash contains upload progress stream urls
+        # for file uploads, keyed by session[:xolo_id]
+        # Individual sessions.
+        # Should be accessible from anywhere via
+        # Xolo::Server::App.file_upload_progress_files
+        # or Xolo::Server::Routes::Uploads.file_upload_progress_files
+        #
+        # @return [Hash {String => String}]
+        ##########################
+        def file_upload_progress_files
+          @file_upload_progress_files ||= {}
+        end
+
+        # Routes
+        ##############################
+        ##############################
+
+        # # 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
+          with_streaming do
+            process_incoming_testfile
+          end
+        end
+
+      end # Module
+
+    end #  Routes
+
+  end #  Server
+
+end # module Xolo