xolo-server 1.0.1 → 2.0.3

data/lib/xolo/server/title.rb

@@ -72,38 +72,11 @@ module Xolo
       # on the xolo server.
       UNINSTALL_SCRIPT_FILENAME = 'uninstall-script'
 
-      # In the TitleEditor, the version script is
-      # stored as an Extension Attribute - each title can
-      # only have one.
-      # and it needs a 'key', which is the name used to indicate the
-      # EA in various criteria, and is the EA name in Jamf Patch.
-      # The key is this value as a prefix on the title
-      # so for title 'foobar', it is 'xolo-foobar'
-      # That value is also used as the display name
-      TITLE_EDITOR_EA_KEY_PREFIX = Xolo::Server::JAMF_OBJECT_NAME_PFX
-
-      # The EA from the title editor, which is used in Jamf Patch
-      # cannot, unfortunately, be used as a criterion in normal
-      # smart groups or advanced searches.
-      # Since we need a smart group containing all macs with any
-      # version of the title installed, we need a second copy of the
-      # EA as a 'normal' EA.
-      #
-      # (That group is used as an exclusion to any auto-install initial-
-      # install policies, so that those policies don't stomp on the matching
-      # Patch Policies)
-      #
-      # The 'duplicate' EA is named the same as the Titled Editor key
-      # (see TITLE_EDITOR_EA_KEY_PREFIX) with this suffix added.
-      # So for the Title Editor key 'xolo-<title>', we'll also have
-      # a matching normal EA called 'xolo-<title>-installed-version'
-      JAMF_NORMAL_EA_NAME_SUFFIX = '-installed-version'
-
-      JAMF_INSTALLED_GROUP_NAME_SUFFIX = '-installed'
-      JAMF_FROZEN_GROUP_NAME_SUFFIX = '-frozen'
-
-      JAMF_UNINSTALL_SUFFIX = '-uninstall'
-      JAMF_EXPIRE_SUFFIX = '-expire'
+      JAMF_INSTALLED_GROUP_NAME_SUFFIX = 'installed'
+      JAMF_FROZEN_GROUP_NAME_SUFFIX = 'frozen'
+      JAMF_MANUAL_INSTALL_RELEASED_POL_SUFFIX = 'install'
+      JAMF_UNINSTALL_SUFFIX = 'uninstall'
+      JAMF_EXPIRE_SUFFIX = 'expire'
 
       # the expire policy will run this client command,
       # appending the title
@@ -164,20 +137,6 @@ module Xolo
         title_dirs.map(&:basename).map(&:to_s)
       end
 
-      # @return [String] The key and display name of a version script stored
-      #   in the title editor as the ExtAttr for a given title
-      #####################
-      def self.ted_ea_key(title)
-        "#{TITLE_EDITOR_EA_KEY_PREFIX}#{title}"
-      end
-
-      # @return [String] The display name of a version script as a normal
-      #   EA in Jamf, which can be used in Smart Groups and Adv Searches.
-      #####################
-      def self.jamf_normal_ea_name(title)
-        "#{ted_ea_key(title)}#{JAMF_NORMAL_EA_NAME_SUFFIX}"
-      end
-
       # The title dir for a given title on the server,
       # which may or may not exist.
       #
@@ -228,7 +187,8 @@ module Xolo
       # for the given title
       #
       # NOTE: All instantiation should happen using the #instantiate_title method
-      # in the server app instance. Please don't call this method directly
+      # in the server app instance, or related methods like all_title_objects.
+      # Please don't call this method directly
       #
       # @pararm title [String] the title we care about
       # @return [Xolo::Server::Title] load an existing title
@@ -239,6 +199,10 @@ module Xolo
         new parse_json(title_data_file(title).read)
       end
 
+      # Does this title exist in the title editor.
+      # WARNING: Being in the title editor doesn't necessarily mean that this title
+      # is managed
+      #
       # @param title [String] the title we are looking for
       # @pararm cnx [Windoo::Connection] The Title Editor connection to use
       # @return [Boolean] Does the given title exist in the Title Editor?
@@ -325,9 +289,6 @@ module Xolo
       # @return [Xolo::Server::App] our Sinatra server app
       attr_accessor :server_app_instance
 
-      # @return [Integer] The Windoo::SoftwareTitle#softwareTitleId
-      attr_accessor :ted_id_number
-
       # when applying updates, the new data from xadm is stored
       # here so it can be accessed by update-methods
       # and compared to the current instance values
@@ -363,6 +324,13 @@ module Xolo
       #   version being released
       attr_accessor :releasing_version
 
+      # @return [String] The jamf ID of the patch source for this title
+      #   if the title is subscribed. Managed titles are all in the Title Editor source.
+      attr_accessor :jamf_patch_source_id
+
+      # @return [String] The prefix for all jamf objects for this title, which is 'xolo-<title>' or 'xolotest-<title>' for test server
+      attr_reader :jamf_obj_name_pfx
+
       # version_order is defined in ATTRIBUTES
       alias versions version_order
 
@@ -376,19 +344,24 @@ module Xolo
       def initialize(data_hash)
         super
 
-        @ted_id_number ||= data_hash[:ted_id_number]
-        @jamf_patch_title_id ||= data_hash[:jamf_patch_title_id]
+        # ted_id_number and jamf_patch_title_id are now defined in parent classes ATTRIBUTES so are set by super
+
         @version_order ||= []
+
         @new_data_for_update = {}
         @changes_for_update = {}
-        @jamf_installed_group_name = "#{Xolo::Server::JAMF_OBJECT_NAME_PFX}#{data_hash[:title]}#{JAMF_INSTALLED_GROUP_NAME_SUFFIX}"
-        @jamf_frozen_group_name = "#{Xolo::Server::JAMF_OBJECT_NAME_PFX}#{data_hash[:title]}#{JAMF_FROZEN_GROUP_NAME_SUFFIX}"
 
-        @jamf_manual_install_released_policy_name = "#{Xolo::Server::JAMF_OBJECT_NAME_PFX}#{data_hash[:title]}-install"
+        @jamf_obj_name_pfx = "#{jamf_obj_name_pfx_base}#{data_hash[:title]}"
+        @jamf_installed_group_name = "#{jamf_obj_name_pfx}-#{JAMF_INSTALLED_GROUP_NAME_SUFFIX}"
+        @jamf_frozen_group_name = "#{jamf_obj_name_pfx}-#{JAMF_FROZEN_GROUP_NAME_SUFFIX}"
+
+        @jamf_manual_install_released_policy_name = "#{jamf_obj_name_pfx}-#{JAMF_MANUAL_INSTALL_RELEASED_POL_SUFFIX}"
+
+        @jamf_uninstall_script_name = "#{jamf_obj_name_pfx}-#{JAMF_UNINSTALL_SUFFIX}"
+        @jamf_uninstall_policy_name = "#{jamf_obj_name_pfx}-#{JAMF_UNINSTALL_SUFFIX}"
+        @jamf_expire_policy_name = "#{jamf_obj_name_pfx}-#{JAMF_EXPIRE_SUFFIX}"
 
-        @jamf_uninstall_script_name = "#{Xolo::Server::JAMF_OBJECT_NAME_PFX}#{data_hash[:title]}#{JAMF_UNINSTALL_SUFFIX}"
-        @jamf_uninstall_policy_name = "#{Xolo::Server::JAMF_OBJECT_NAME_PFX}#{data_hash[:title]}#{JAMF_UNINSTALL_SUFFIX}"
-        @jamf_expire_policy_name = "#{Xolo::Server::JAMF_OBJECT_NAME_PFX}#{data_hash[:title]}#{JAMF_EXPIRE_SUFFIX}"
+        # DO NOT USE jamf_cnx here, it comes from the server app instance, which is not set until after initialization.
       end
 
       # Instance Methods
@@ -402,10 +375,12 @@ module Xolo
         # @session ||= {}
       end
 
+      # This can be manually set earlier in the request handling to use a non-standard
+      # admin username
       # @return [String]
       ###################
       def admin
-        session[:admin]
+        @admin ||= session[:admin]
       end
 
       # @return [Boolean] Are we creating this title?
@@ -438,6 +413,22 @@ module Xolo
         current_action == :releasing
       end
 
+      # TODO: Remove this when everything has been repaired for v2
+      # and all json files know this value
+      #######################
+      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}'"
+
+        self.jamf_patch_title_id =
+          if managed?
+            jamf_active_managed_titles[title]
+          else
+            jamf_active_subscribed_titles[title]
+          end
+      end
+
       # Append a message to the progress stream file,
       # optionally sending it also to the log
       #
@@ -448,8 +439,8 @@ module Xolo
       #
       # @return [void]
       ###################
-      def progress(msg, log: :debug)
-        server_app_instance.progress msg, log: log
+      def progress(msg, log: :debug, alert: false)
+        server_app_instance.progress msg, log: log, alert: alert
       end
 
       # @return [Windoo::Connection] a single Title Editor connection to use for
@@ -589,13 +580,6 @@ module Xolo
         template_file.read
       end
 
-      # @return [String] The display name of a version script as a normal
-      #   EA in Jamf, which can be used in Smart Groups and Adv Searches.
-      #####################
-      def jamf_normal_ea_name
-        @jamf_normal_ea_name ||= self.class.jamf_normal_ea_name title
-      end
-
       # prepend a new version to the version_order
       #
       # @param version [String] the version to prepend
@@ -603,11 +587,8 @@ module Xolo
       # @return [void]
       ########################
       def prepend_version(version)
-        lock
         version_order.unshift version
         save_local_data
-      ensure
-        unlock
       end
 
       # remove a version from the version_order
@@ -670,8 +651,13 @@ module Xolo
         self.created_by = admin
         log_debug "creation_date: #{creation_date}, created_by: #{created_by}"
 
+        log_debug "TitleData at #create: #{to_h}"
+
         # this will create the title as needed in the Title Editor
+        log_debug "Display Name before creating in ted: #{display_name}"
         create_title_in_ted
+
+        log_debug "Display Name before creating in jamf: #{display_name}"
         create_title_in_jamf
 
         # save to file last, because saving to TitleEd and Jamf will
@@ -679,8 +665,22 @@ module Xolo
         progress 'Saving title data to Xolo server'
         save_local_data
 
+        if subscribed?
+          # create version for latest available
+          # - either autopkg or notification to upload.
+          # See also Helpers::Subscriptions.process_patch_title_updated_webhook
+          Xolo::Server::Version.add_version_via_subscription(
+            title_object: self,
+            new_version: patch_versions(version: :latest)[0][:version]
+          )
+        end # if subscribed
+
         log_change msg: 'Title Created'
 
+        # 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. It'll be updated when the version is created
+
         # ssvc icon is uploaded in a separate process, and the
         # title data file will be updated as needed then.
       ensure
@@ -733,7 +733,8 @@ module Xolo
 
         # any new self svc icon will be uploaded in a separate process
         # and the local data will be updated again then
-        #
+
+        server_app_instance.update_client_data
       rescue => e
         log_change msg: "ERROR: The update failed and the changes didn't all go through!\n#{e.class}: #{e.message}\nSee server log for details."
 
@@ -776,6 +777,9 @@ module Xolo
       # @return [void]
       ##########################
       def save_local_data
+        # If we don't have a patch source id yet, get it now
+        self.jamf_patch_source_id ||= Jamf::PatchSource.valid_id(patch_source, cnx: jamf_cnx) if patch_source
+
         # create the dirs for the title
         title_dir.mkpath
         vdir = title_dir + Xolo::Server::Version::VERSIONS_DIRNAME
@@ -838,6 +842,17 @@ module Xolo
         self.uninstall_script &&= Xolo::ITEM_UPLOADED
       end
 
+      # Is AutoPkg integration enabled for the server and title?
+      # This overrides the method in core title, which just checks for the presence of the recipe and dir.
+      ###############################
+      def autopkg_enabled?
+        return @autopkg_enabled if defined?(@autopkg_enabled)
+
+        @autopkg_enabled = server_app_instance.autopkg_enabled? && \
+                           autopkg_recipe && \
+                           autopkg_dir
+      end
+
       # are we uninstallable?
       #
       # @return [Boolean]
@@ -908,10 +923,10 @@ module Xolo
         version_objects.reverse.each do |vers|
           # vers might be nil if it was already deleted
           # e.g. a prev. attempt to delete the title failed partway through
-          vers&.delete update_title: false
+          vers&.delete update_title: false, deleting_title: true
         end
 
-        delete_title_from_ted
+        delete_title_from_ted unless subscribed?
 
         delete_title_from_jamf
 
@@ -919,6 +934,7 @@ module Xolo
 
         progress "Deleting Xolo server data for title '#{title}'", log: :info
         title_dir.rmtree
+        server_app_instance.update_client_data
       ensure
         unlock
       end
@@ -943,6 +959,7 @@ module Xolo
         # update the title
         self.released_version = version_to_release
         save_local_data
+        server_app_instance.update_client_data
       ensure
         unlock
       end
@@ -1008,8 +1025,14 @@ module Xolo
         progress msg, log: :info
 
         pol = jamf_manual_install_released_policy
-        pol.package_ids.each { |pid| pol.remove_package pid }
-        pol.add_package vobj.jamf_pkg_id
+        toggle_jamf_manual_install_released_policy pol, vobj
+
+        if self_service?
+          add_title_to_self_service(pol)
+        else
+          remove_title_from_self_service(pol)
+        end
+
         pol.save
       end
 
@@ -1058,7 +1081,6 @@ module Xolo
       #
       # Then look at the various Jamf objects pertaining to this title, and ensure they are correct
       #   - Accept Patch EA
-      #   - Normal EA 'xolo-<title>-installed-version'
       #   - title-installed smart group 'xolo-<title>-installed'
       #   - frozen static group 'xolo-<title>-frozen'
       #   - manual/SSvc install-current-release policy 'xolo-<title>-install'
@@ -1085,12 +1107,15 @@ module Xolo
         progress "Starting repair of title '#{title}'"
         repair_ted_title
         repair_jamf_title_objects
+        save_local_data
         return unless repair_versions
 
         version_objects.each do |vobj|
           progress '#########'
           vobj.repair
         end
+
+        server_app_instance.update_client_data
       ensure
         unlock
       end
@@ -1114,7 +1139,7 @@ module Xolo
 
         exp = Time.now + Xolo::Server::ObjectLocks::OBJECT_LOCK_LIMIT
         Xolo::Server.object_locks[title][:expires] = exp
-        log_debug "Locked title '#{title}' for updates until #{exp}"
+        log_debug "Locked title '#{title}' for updates until #{exp}, by method #{caller_locations.first.label}"
       end
 
       # Unlock this v for updates
@@ -1131,7 +1156,11 @@ module Xolo
       ###########################
       def to_h
         hash = super
+
+        # TODO: remove these after 'repairing' everything for v2
         hash[:ted_id_number] = ted_id_number
+        hash[:jamf_patch_title_id] = jamf_patch_title_id
+
         hash[:ssvc_icon_id] = ssvc_icon_id
         hash
       end

data/lib/xolo/server/tmp_overrides.rb

@@ -0,0 +1,38 @@
+# Temp fixes for ruby-jss
+###########################
+module Jamf
+
+  #########################
+  module SelfServable
+
+    # set ssvc notification settings in xml
+    # FIX: its 'notification_enabled' NOT 'notifications_enabled'
+    def add_self_service_notification_xml(ssvc)
+      return unless @self_service_data_config[:notifications_supported]
+
+      # oldstyle/broken, only sscv notifs
+      if @self_service_data_config[:notifications_supported] == :ssvc_only
+        ssvc.add_element('notification').text = self_service_notifications_enabled.to_s
+        ssvc.add_element('notification_subject').text = self_service_notification_subject if self_service_notification_subject
+        ssvc.add_element('notification_message').text = self_service_notification_message if self_service_notification_message
+        return
+      end
+
+      # newstyle, 'notifications' subset
+      notif = ssvc.add_element('notifications')
+      # NEXT LINE IS THE FIX until pushed via ruby-jss, its 'notification_enabled' NOT 'notifications_enabled'
+      notif.add_element('notification_enabled').text = self_service_notifications_enabled.to_s
+      notif.add_element('notification_type').text = NOTIFICATION_TYPES[self_service_notification_type] if self_service_notification_type
+      notif.add_element('notification_subject').text = self_service_notification_subject if self_service_notification_subject
+      notif.add_element('notification_message').text = self_service_notification_message if self_service_notification_message
+
+      return unless @self_service_data_config[:notification_reminders]
+
+      reminds = notif.add_element('reminders')
+      reminds.add_element('notification_reminders_enabled').text = self_service_reminders_enabled.to_s
+      reminds.add_element('notification_reminder_frequency').text = self_service_reminder_frequency.to_s if self_service_reminder_frequency
+    end
+
+  end # module
+
+end # module