xolo-admin 1.0.0

data/lib/xolo/admin/progress_history.rb

@@ -0,0 +1,117 @@
+# 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
+
+  module Admin
+
+    # Storage and access to a history of progress-data from
+    # long-running Xolo server processes.
+    #
+    # E.g.. when you run 'xadm delete-title' you'll get a live
+    # progress updates of everything happening. That log is stored for
+    # a while (3 days) on the server.
+    #
+    # Later, esp if you used --quiet and didn't see the progress or any
+    # errors initially
+    # you'll be able to re-view the progress log, if it still exists
+    # on the server
+    #
+    module ProgressHistory
+
+      # Constants
+      ##########################
+      ##########################
+
+      APP_SUPPORT_DIR = '~/Library/Application Support/xadm/'
+      PROGRESS_HISTORY_FILENAME = 'com.pixar.xolo.admin.progress_history.yaml'
+
+      # prog files on the server last 3 days, add an extra to
+      # account for timing of daily cleanup on the server.
+      # if the file is already gone from the server, we'll tell
+      # the user
+      PROGRESS_FILE_LIFETIME = 4 * 24 * 3600
+
+      # 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
+
+      # Instance Methods
+      ##########################
+      ##########################
+
+      # @return [Pathname] The expanded path tot he  prog. history dir for this user
+      ###########################
+      def app_support_dir
+        return @app_support_dir if @app_support_dir
+
+        @app_support_dir = Pathname.new(APP_SUPPORT_DIR).expand_path
+        @app_support_dir.mkpath
+        @app_support_dir
+      end
+
+      # @return [Pathname] The prog. history file for this user
+      ###########################
+      def progress_history_file
+        @progress_history_file ||= (app_support_dir + PROGRESS_HISTORY_FILENAME)
+      end
+
+      # The current history of progress streams for this user
+      # keys are Time objects when the entry was created
+      # values are sub-hashes with :command, and :url keys
+      # the command being the xadm command, e.g. 'delete-version'
+      # and the URL being the url to the progress stream file on the server.
+      #
+      # before returning the hash, any expired entries are removed
+      #
+      # @return [Hash] the current progress history for this user
+      ###################
+      def progress_history
+        progress_history_file.pix_touch
+        history = YAML.load progress_history_file.read
+        history ||= {}
+
+        now = Time.now
+        history.delete_if { |k, _v| now - k > PROGRESS_FILE_LIFETIME }
+
+        history
+      end
+
+      # Add an entry to the progress history
+      #
+      # @prarm url_path [String] the xolo server path to the progress file.
+      #
+      # @return [void]
+      ######################
+      def add_progress_history_entry(url_path)
+        history = progress_history
+        history[Time.now] = {
+          command: cli_cmd.command,
+          url_path: url_path
+        }
+
+        progress_history_file.pix_atomic_write YAML.dump(history)
+      end
+
+    end # module
+
+  end # module Admin
+
+end # module Xolo

data/lib/xolo/admin/title.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
+
+  module Admin
+
+    # A title used by xadm.
+    #
+    # These are instantiated with data from the server
+    # (for existing Titles) or from the xadm CLI opts
+    # or walkthru process.
+    #
+    # This class also defines how xadm communicates
+    # title data to and from the server.
+    class Title < Xolo::Core::BaseClasses::Title
+
+      # Constants
+      #############################
+      #############################
+
+      # This is the server path for dealing with titles
+      # POST to add a new one
+      # GET to get a list of titles
+      # GET .../<title> to get the data for a single title
+      # PUT .../<title> to update a title with new data
+      # DELETE .../<title> to delete a title and its version
+      SERVER_ROUTE = '/titles'
+
+      UPLOAD_ICON_ROUTE = 'ssvc-icon'
+
+      TARGET_TITLE_PLACEHOLDER = 'TARGET_TITLE_PH'
+
+      # Class Methods
+      #############################
+      #############################
+
+      # @return [Hash{Symbol: Hash}] The ATTRIBUTES that are available as CLI & walkthru options
+      def self.cli_opts
+        @cli_opts ||= ATTRIBUTES.select { |_k, v| v[:cli] }
+      end
+
+      # @return [Array<String>] The currently known titles names on the server
+      #############################
+      def self.all_titles(cnx)
+        resp = cnx.get SERVER_ROUTE
+        resp.body.map { |t| t[:title] }
+      end
+
+      # @return [Array<Xolo::Admin::Title>] The currently known titles on the server
+      #############################
+      def self.all_title_objects(cnx)
+        resp = cnx.get SERVER_ROUTE
+        resp.body.map { |td| Xolo::Admin::Title.new td }
+      end
+
+      # Does a title exist on the server?
+      # @param title [String] the title
+      # @param cnx [Faraday::Connection] The connection to use, must be logged in already
+      # @return [Boolean]
+      #############################
+      def self.exist?(title, cnx)
+        all_titles(cnx).include? title
+      end
+
+      # Fetch a title from the server
+      # @param title [String] the title to fetch
+      # @param cnx [Faraday::Connection] The connection to use, must be logged in already
+      # @return [Xolo::Admin::Title]
+      ####################
+      def self.fetch(title, cnx)
+        resp = cnx.get "#{SERVER_ROUTE}/#{title}"
+
+        new resp.body
+      end
+
+      # Delete a title from the server
+      # @param title [String] the title to delete
+      # @param cnx [Faraday::Connection] The connection to use, must be logged in already
+      # @return [Hash] the response data
+      ####################
+      def self.delete(title, cnx)
+        resp = cnx.delete "#{SERVER_ROUTE}/#{title}"
+        resp.body
+      end
+
+      # the latest version of a title in Xolo
+      # @param title [String] the title we care about
+      # @param cnx [Faraday::Connection] The connection to use, must be logged in already
+      # @return [void]
+      ####################
+      def self.latest_version(title, cnx)
+        resp = cnx.get "#{SERVER_ROUTE}/#{title}"
+        resp.body[:version_order].first
+      end
+
+      # Is the current admin allowed to set a title's release groups to 'all'?
+      # @param cnx [Faraday::Connection] The connection to use, must be logged in already
+      # @return [Boolean]
+      ####################
+      def self.release_to_all_allowed?(cnx)
+        resp = cnx.get '/auth/release_to_all_allowed'
+        resp.body
+      end
+
+      # Attributes
+      ######################
+      ######################
+
+      # Constructor
+      ######################
+      ######################
+
+      # Read in the contents of any version script given
+      def initialize(data_hash)
+        super
+        # @self_service_icon = nil if @self_service_icon == Xolo::ITEM_UPLOADED
+
+        return unless version_script
+        return if version_script == Xolo::ITEM_UPLOADED
+
+        @version_script = version_script.read if version_script.respond_to?(:read)
+      end
+
+      # Instance Methods
+      #############################
+      #############################
+
+      # Add this title to the server
+      # @param cnx [Faraday::Connection] The connection to use, must be logged in already
+      # @return [Hash] the response body from the server
+      ####################
+      def add(cnx)
+        resp = cnx.post SERVER_ROUTE, to_h
+        resp.body
+      end
+
+      # Update this title to the server
+      # @param cnx [Faraday::Connection] The connection to use, must be logged in already
+      # @return [Hash] the response body from the server
+      ####################
+      def update(cnx)
+        resp = cnx.put "#{SERVER_ROUTE}/#{title}", to_h
+        resp.body
+      end
+
+      # Release a version of this title.
+      # @param cnx [Faraday::Connection] The connection to use, must be logged in already
+      # @param version [String] the version to release
+      # @return [Hash] the response body from the server
+      ####################
+      def release(cnx, version:)
+        resp = cnx.patch "#{SERVER_ROUTE}/#{title}/release/#{version}", {}
+        resp.body
+      end
+
+      # Repair this title, and optionally all its versions
+      # @param cnx [Faraday::Connection] The connection to use, must be logged in already
+      # @param versions [Boolean] if true, repair all versions of this title
+      # @return [Hash] the response body from the server
+      ####################
+      def repair(cnx, versions: false)
+        resp = cnx.post "#{SERVER_ROUTE}/#{title}/repair", { repair_versions: versions }
+        resp.body
+      end
+
+      # Delete this title from the server
+      # @param cnx [Faraday::Connection] The connection to use, must be logged in already
+      # @return [Hash] the response data
+      ####################
+      def delete(cnx)
+        self.class.delete title, cnx
+      end
+
+      # Freeze the one or more computers for this title
+      # @param computers [Array<String>] the computers to freeze
+      # @param cnx [Faraday::Connection] The connection to use, must be logged in already
+      # @return [Hash] the response data
+      ####################
+      def freeze(targets, users = false, cnx)
+        data = { targets: targets, users: users }
+        resp = cnx.put "#{SERVER_ROUTE}/#{title}/freeze", data
+        resp.body
+      end
+
+      # Thaw the one or more computers for this title
+      # @param computers [Array<String>] the computers to freeze
+      # @param cnx [Faraday::Connection] The connection to use, must be logged in already
+      # @return [Hash] the response data
+      ####################
+      def thaw(targets, users = false, cnx)
+        data = { targets: targets, users: users }
+        resp = cnx.put "#{SERVER_ROUTE}/#{title}/thaw", data
+        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
+      ####################
+      def frozen(cnx)
+        resp = cnx.get "#{SERVER_ROUTE}/#{title}/frozen"
+        resp.body
+      end
+
+      # Fetch a hash of URLs for the GUI pages for this title
+      # @param cnx [Faraday::Connection] The connection to use, must be logged in already
+      # @return [Hash{String => String}] page_name => url
+      ####################
+      def gui_urls(cnx)
+        resp = cnx.get "#{SERVER_ROUTE}/#{title}/urls"
+        resp.body
+      end
+
+      # The change log is a list of hashes, each with keys:
+      # :time, :admin, :ipaddr, :version (may be nil), :action
+      #
+      # @param cnx [Faraday::Connection] The connection to use, must be logged in already
+      # @return [Array<Hash>] The change log for this title
+      ####################
+      def changelog(cnx)
+        resp = cnx.get "#{SERVER_ROUTE}/#{title}/changelog"
+        resp.body
+      end
+
+      # Upload an icon for self service.
+      # At this point, the self_service_icon attribute
+      # should contain the local file path.
+      #
+      # @param upload_cnx [Xolo::Admin::Connection] The server connection
+      #
+      # @return [Faraday::Response] The server response
+      ##################################
+      def upload_self_service_icon(upload_cnx)
+        return unless self_service_icon.is_a? Pathname
+
+        unless self_service_icon.readable?
+          raise Xolo::NoSuchItemError,
+                "Can't upload self service icon '#{self_service_icon}': file doesn't exist or is not readable"
+        end
+
+        # upfile = Faraday::UploadIO.new(
+        #   self_service_icon.to_s,
+        #   'application/octet-stream',
+        #   self_service_icon.basename.to_s
+        # )
+
+        mimetype = `/usr/bin/file --brief --mime-type #{Shellwords.escape self_service_icon.expand_path.to_s}`.chomp
+        upfile = Faraday::Multipart::FilePart.new(self_service_icon.expand_path.to_s, mimetype)
+        content = { file: upfile }
+        # route =  "#{UPLOAD_ICON_ROUTE}/#{title}"
+        route = "#{SERVER_ROUTE}/#{title}/#{UPLOAD_ICON_ROUTE}"
+
+        upload_cnx.post(route) { |req| req.body = content }
+      end
+
+      # Get the patch report data for this title
+      # It's the JPAPI report data with each hash having a frozen: key added
+      #
+      # @param cnx [Faraday::Connection] The connection to use, must be logged in already
+      # @return [Array<Hash>] Data for each computer with any version of this title installed
+      ##################################
+      def patch_report_data(cnx)
+        resp = cnx.get "#{SERVER_ROUTE}/#{title}/patch_report"
+        resp.body
+      end
+
+      # Add more data to our hash
+      ###########################
+      def to_h
+        super
+      end
+
+    end # class Title
+
+  end # module Admin
+
+end # module Xolo

data/lib/xolo/admin/title_editor.rb

@@ -0,0 +1,57 @@
+# 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
+
+  module Admin
+
+    # Methods that process the xadm commands and their options
+    #
+    module TitleEditor
+
+      # Constants
+      ##########################
+      ##########################
+
+      TITLE_EDITOR_ROUTE_BASE = '/title-editor'
+
+      # Xolo server route to the list of titles
+      TITLES_ROUTE = "#{TITLE_EDITOR_ROUTE_BASE}/titles"
+
+      # 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
+
+      # Instance Methods
+      ##########################
+      ##########################
+
+      # Perhaps not needed for anything, but used for initial connection testing
+      # @return [Array<String>] the titles of all Title objects in the Title Editor
+      #######################
+      def ted_titles
+        server_cnx.get(TITLES_ROUTE).body
+      end
+
+    end # module
+
+  end # module Admin
+
+end # module Xolo