Class: Xolo::Server::Title

Inherits:

Core::BaseClasses::Title

Object
Core::BaseClasses::Title
Xolo::Server::Title

show all

Includes:: Helpers::JamfPro, Helpers::Log, Helpers::Notification, Helpers::TitleEditor, Mixins::Changelog, Mixins::TitleJamfAccess, Mixins::TitleTedAccess

Defined in:: lib/xolo/server/title.rb

Overview

A Title in Xolo, as used on the server

The code in this file mostly deals with the data on the Xolo server itself, and general methods for manipulating the title.

Code for interacting with the Title Editor and Jamf Pro are in the helpers and mixins.

NOTE be sure to only instantiate these using the servers 'instantiate_title' method, or else they might not have all the correct innards

Constant Summary collapse

TITLES_DIR = On the server, xolo titles are represented by directories in this directory, named with the title name. So a title 'foobar' would have a directory (Xolo::Server::DATA_DIR)/titles/foobar/ and in there will be a file foobar.json with the data for the Title instance itself Also in there will be a 'versions' dir containing json files for each version of the title. See Version

Xolo::Server::DATA_DIR + 'titles'

NEW_TITLE_CURRENT_VERSION = when creating new titles in the title editor, This is the 'currentVersion', which is required when creating. When the first version/patch is added, the title's value for this will be updated.

'0.0.0'

VERSION_SCRIPT_FILENAME = If a title has a 'version_script' the the contents are stored in the title dir in a file with this name

'version-script'

UNINSTALL_SCRIPT_FILENAME = If a title is uninstallable, it will have a script in Jamf, which is also saved in this file on the xolo server.

'uninstall-script'

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'

JAMF_TGT_GRP_EXCL_GRP_NAME_SUFFIX =

'target-group-exclusions'

CLIENT_EXPIRE_COMMAND = the expire policy will run this client command, appending the title We don't specify a full path so that localized installations will work as long as its in roots default path e.g. /usr/local/bin vs /usr/local/pixar/bin

'xolo expire'

SELF_SERVICE_ICON_FILENAME = When we are given a Self Service icon for the title, we might not be ready to upload it to jamf, cuz until we have a version to pilot, there's nothing IN jamf. So we always store it locally in this file inside the title dir. The extension from the original file will be appended, e.g. '.png'

'self-service-icon'

JPAPI_PATCH_TITLE_RSRC = The JPAPI endpoint for Patch Titles. ruby-jss still uses the Classic API for Patch Titles, and won't by migrated to JPAPI until Jamf fully implements all aspects of patch management to JPAPI. As of this writing, that's not the case. But, the JPAPI endpoint for Patch Title Reporting returns more detailed data than the Classic API, so we use it here, and will keep using it as we move forward. This is the top-level endpoint for all patch titles, see JPAPI_PATCH_REPORT_RSRC for the reporting endpoint below it. TODO: Remove this and update relevant methods when ruby-jss is updated to use JPAPI for Patch Titles..

'v2/patch-software-title-configurations'

JPAPI_PATCH_REPORT_RSRC = The JPAPI endpoint for patch reporting. The JPAPI_PATCH_TITLE_RSRC is appended with "//#JPAPI_PATCH_REPORT_RSRC" to get the URL for the patch report for a specific title. TODO: Remove this and update relevant methods when ruby-jss is updated to use JPAPI for Patch Titles..

'patch-report'

SELF_SERVICE_INSTALL_BTN_TEXT =

'Install'

Instance Attribute Summary collapse

#changes_for_update ⇒ Hash readonly
Also when applying updates, this will hold the changes being made: the differences between tne current attributes and the new_data_for_update We'll figure this out at the start of the update and can use it later to 1) avoid doing things we don't need to 2) log the changes in the change log at the very end.
#current_action ⇒ Symbol
The current action being taken on this title one of :creating, :updating, :deleting.
#jamf_expire_policy_name ⇒ String readonly
If a title is expirable, it will have a policy in Jamf named 'xolo--expire' that will run the expiration process daily, at checkin or using a trigger of the same name.</div> </li> <li class="public "> <a href="#jamf_frozen_group_name-instance_method" title="#jamf_frozen_group_name (instance method)">#jamf_frozen_group_name ⇒ String </a> readonly <div class='inline'>For each title there will be a static group containing macs that should not get any automatic installs or updates, They should be 'frozen' at whatever version was installed when they were added to the group.</div> </li> <li class="public "> <a href="#jamf_installed_group_name-instance_method" title="#jamf_installed_group_name (instance method)">#jamf_installed_group_name ⇒ String </a> readonly <div class='inline'>For each title there will be a smart group containing all macs that have any version of the title installed.</div> </li> <li class="public "> <a href="#jamf_manual_install_released_policy_name-instance_method" title="#jamf_manual_install_released_policy_name (instance method)">#jamf_manual_install_released_policy_name ⇒ Object </a> readonly <div class='inline'>The name of the policy that does initial manual or self-service installs of the currently-released version of this title.</div> </li> <li class="public "> <a href="#jamf_obj_name_pfx-instance_method" title="#jamf_obj_name_pfx (instance method)">#jamf_obj_name_pfx ⇒ String </a> readonly <div class='inline'>The prefix for all jamf objects for this title, which is 'xolo-<title>' or 'xolotest-<title>' for test server.</div> </li> <li class="public "> <a href="#jamf_patch_source_id-instance_method" title="#jamf_patch_source_id (instance method)">#jamf_patch_source_id ⇒ String </a> <div class='inline'>The jamf ID of the patch source for this title if the title is subscribed.</div> </li> <li class="public "> <a href="#jamf_target_groups_exclusion_group_name-instance_method" title="#jamf_target_groups_exclusion_group_name (instance method)">#jamf_target_groups_exclusion_group_name ⇒ String </a> readonly <div class='inline'>If a title has 'target_groups', they act as the opposite of excluded groups - macs NOT in the target groups can't see the title.</div> </li> <li class="public "> <a href="#jamf_uninstall_policy_name-instance_method" title="#jamf_uninstall_policy_name (instance method)">#jamf_uninstall_policy_name ⇒ String </a> readonly <div class='inline'>If a title is uninstallable, it will have a policy in Jamf named 'xolo-<title>-uninstall' that will run the script of the same name, using a trigger of the same name.</div> </li> <li class="public "> <a href="#jamf_uninstall_script_name-instance_method" title="#jamf_uninstall_script_name (instance method)">#jamf_uninstall_script_name ⇒ String </a> readonly <div class='inline'>If a title is uninstallable, it will have a script in Jamf named 'xolo-<title>-uninstall'.</div> </li> <li class="public "> <a href="#new_data_for_update-instance_method" title="#new_data_for_update (instance method)">#new_data_for_update ⇒ Hash </a> readonly <div class='inline'>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 both for updating the title, and the versions.</div> </li> <li class="public "> <a href="#releasing_version-instance_method" title="#releasing_version (instance method)">#releasing_version ⇒ String </a> <div class='inline'>If current action is :releasing, this is the version being released.</div> </li> <li class="public "> <a href="#server_app_instance-instance_method" title="#server_app_instance (instance method)">#server_app_instance ⇒ Xolo::Server::App </a> <div class='inline'>The instance of Xolo::Server::App that instantiated this title object.</div> </li> <li class="public "> <a href="#ssvc_icon_id-instance_method" title="#ssvc_icon_id (instance method)">#ssvc_icon_id ⇒ Integer </a> <div class='inline'>The Jamf Pro ID for the self-service icon once it has been uploaded.</div> </li> </ul> <h2> Class Method Summary <a href="#" class="summary_toggle">collapse</a> </h2> <ul class="summary"> <li class="public "> <a href="#all_titles-class_method" title="all_titles (class method)">.all_titles ⇒ Array<String> </a> <div class='inline'>A list of all known titles, just the basenames of all the title_dirs.</div> </li> <li class="public "> <a href="#in_ted%3F-class_method" title="in_ted? (class method)">.in_ted?(title, cnx:) ⇒ Boolean </a> <div class='inline'>Does this title exist in the title editor.</div> </li> <li class="public "> <a href="#load-class_method" title="load (class method)">.load(title) ⇒ Xolo::Server::Title </a> <div class='inline'>Instantiate from the local JSON file containing the current values for the given title.</div> </li> <li class="public "> <a href="#locked%3F-class_method" title="locked? (class method)">.locked?(title) ⇒ Boolean </a> <div class='inline'>Is a title locked for updates?.</div> </li> <li class="public "> <a href="#ssvc_icon_file-class_method" title="ssvc_icon_file (class method)">.ssvc_icon_file(title) ⇒ Pathname </a> <div class='inline'>The the local file containing the self-service icon.</div> </li> <li class="public "> <a href="#title_data_file-class_method" title="title_data_file (class method)">.title_data_file(title) ⇒ Pathname </a> <div class='inline'>The the local JSON file containing the current values for the given title.</div> </li> <li class="public "> <a href="#title_dir-class_method" title="title_dir (class method)">.title_dir(title) ⇒ Pathname </a> <div class='inline'>The title dir for a given title on the server, which may or may not exist.</div> </li> <li class="public "> <a href="#title_dirs-class_method" title="title_dirs (class method)">.title_dirs ⇒ Array<Pathname> </a> <div class='inline'>A list of all known title dirs.</div> </li> <li class="public "> <a href="#uninstall_script_file-class_method" title="uninstall_script_file (class method)">.uninstall_script_file(title) ⇒ Pathname </a> <div class='inline'>The the local file containing the code of the version script.</div> </li> <li class="public "> <a href="#version_script_file-class_method" title="version_script_file (class method)">.version_script_file(title) ⇒ Pathname </a> <div class='inline'>The the local file containing the code of the version script.</div> </li> </ul> <h2> Instance Method Summary <a href="#" class="summary_toggle">collapse</a> </h2> <ul class="summary"> <li class="public "> <a href="#admin-instance_method" title="#admin (instance method)">#admin ⇒ String </a> <div class='inline'>This can be manually set earlier in the request handling to use a non-standard admin username.</div> </li> <li class="public "> <a href="#autopkg_enabled%3F-instance_method" title="#autopkg_enabled? (instance method)">#autopkg_enabled? ⇒ Boolean </a> <div class='inline'>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.</div> </li> <li class="public "> <a href="#create-instance_method" title="#create (instance method)">#create ⇒ void </a> <div class='inline'>Save a new title, adding to the local filesystem, Jamf Pro, and the Title Editor as needed.</div> </li> <li class="public "> <a href="#creating%3F-instance_method" title="#creating? (instance method)">#creating? ⇒ Boolean </a> <div class='inline'>Are we creating this title?.</div> </li> <li class="public "> <a href="#delete-instance_method" title="#delete (instance method)">#delete ⇒ void </a> <div class='inline'>Delete the title and all of its version.</div> </li> <li class="public "> <a href="#delete_version_script_file-instance_method" title="#delete_version_script_file (instance method)">#delete_version_script_file ⇒ void </a> <div class='inline'>Delete the version script file.</div> </li> <li class="public "> <a href="#deleting%3F-instance_method" title="#deleting? (instance method)">#deleting? ⇒ Boolean </a> <div class='inline'>Are we deleting this title?.</div> </li> <li class="public "> <a href="#deprecate_or_skip_version-instance_method" title="#deprecate_or_skip_version (instance method)">#deprecate_or_skip_version(vobj) ⇒ void </a> <div class='inline'>Deprecate or skip a version.</div> </li> <li class="public "> <a href="#generate_uninstall_script-instance_method" title="#generate_uninstall_script (instance method)">#generate_uninstall_script(script_or_pkg_ids) ⇒ String, Array </a> <div class='inline'>The uninstall script, provided or generated from the given pkg ids.</div> </li> <li class="public "> <a href="#initialize-instance_method" title="#initialize (instance method)">#initialize(data_hash) ⇒ Title </a> constructor <div class='inline'>NOTE: be sure to only instantiate these using the servers 'instantiate_title' method, or else they might not have all the correct innards.</div> </li> <li class="public "> <a href="#jamf_cnx-instance_method" title="#jamf_cnx (instance method)">#jamf_cnx(refresh: false) ⇒ Jamf::Connection </a> <div class='inline'>A single Jamf Pro API connection to use for the life of this instance.</div> </li> <li class="public "> <a href="#jamf_patch_title_id-instance_method" title="#jamf_patch_title_id (instance method)">#jamf_patch_title_id ⇒ Object </a> <div class='inline'>TODO: Remove this when everything has been repaired for v2 and all json files know this value.</div> </li> <li class="public "> <a href="#lock-instance_method" title="#lock (instance method)">#lock ⇒ Object </a> <div class='inline'>Lock this title for updates.</div> </li> <li class="public "> <a href="#locked%3F-instance_method" title="#locked? (instance method)">#locked? ⇒ Boolean </a> <div class='inline'>Is this title locked for updates?.</div> </li> <li class="public "> <a href="#patch_report_rsrc-instance_method" title="#patch_report_rsrc (instance method)">#patch_report_rsrc ⇒ String </a> <div class='inline'>The URL path for the patch report for this title.</div> </li> <li class="public "> <a href="#prepend_version-instance_method" title="#prepend_version (instance method)">#prepend_version(version) ⇒ void </a> <div class='inline'>prepend a new version to the version_order.</div> </li> <li class="public "> <a href="#progress-instance_method" title="#progress (instance method)">#progress(msg, log: :debug, alert: false) ⇒ void </a> <div class='inline'>Append a message to the progress stream file, optionally sending it also to the log.</div> </li> <li class="public "> <a href="#release-instance_method" title="#release (instance method)">#release(version_to_release) ⇒ void </a> <div class='inline'>Release a version of this title.</div> </li> <li class="public "> <a href="#release_version-instance_method" title="#release_version (instance method)">#release_version(vobj, rollback:) ⇒ void </a> <div class='inline'>release a specific version.</div> </li> <li class="public "> <a href="#releasing%3F-instance_method" title="#releasing? (instance method)">#releasing? ⇒ Boolean </a> <div class='inline'>Are we releasing a version this title?.</div> </li> <li class="public "> <a href="#remove_version-instance_method" title="#remove_version (instance method)">#remove_version(version) ⇒ void </a> <div class='inline'>remove a version from the version_order.</div> </li> <li class="public "> <a href="#repair-instance_method" title="#repair (instance method)">#repair(repair_versions: false) ⇒ void </a> <div class='inline'>Repair this title, and optionally all of its versions.</div> </li> <li class="public "> <a href="#repairing%3F-instance_method" title="#repairing? (instance method)">#repairing? ⇒ Boolean </a> <div class='inline'>Are we repairing this title?.</div> </li> <li class="public "> <a href="#reset_version_to_pilot-instance_method" title="#reset_version_to_pilot (instance method)">#reset_version_to_pilot(vobj) ⇒ void </a> <div class='inline'>reset a version to pilot status, this happens when rolling back (releasing a version older than the current release).</div> </li> <li class="public "> <a href="#save_local_data-instance_method" title="#save_local_data (instance method)">#save_local_data ⇒ void </a> <div class='inline'>Save our current data out to our JSON data file This overwrites the existing data.</div> </li> <li class="public "> <a href="#save_ssvc_icon-instance_method" title="#save_ssvc_icon (instance method)">#save_ssvc_icon(tempfile, orig_filename) ⇒ void </a> <div class='inline'>Save the self_service_icon from the upload tmpfile to the file in the data dir.</div> </li> <li class="public "> <a href="#save_uninstall_script-instance_method" title="#save_uninstall_script (instance method)">#save_uninstall_script ⇒ void </a> <div class='inline'>Save our current uninstall script out to our local file.</div> </li> <li class="public "> <a href="#save_version_script-instance_method" title="#save_version_script (instance method)">#save_version_script ⇒ void </a> <div class='inline'>Save our current version script out to our local file, but only if we aren't using app_name and app_bundle_id and only if it's changed.</div> </li> <li class="public "> <a href="#session-instance_method" title="#session (instance method)">#session ⇒ Hash </a> <div class='inline'></div> </li> <li class="public "> <a href="#ssvc_icon_file-instance_method" title="#ssvc_icon_file (instance method)">#ssvc_icon_file ⇒ Pathname </a> <div class='inline'>The the local file containing the self-service icon.</div> </li> <li class="public "> <a href="#ted_cnx-instance_method" title="#ted_cnx (instance method)">#ted_cnx ⇒ Windoo::Connection </a> <div class='inline'>A single Title Editor connection to use for the life of this instance.</div> </li> <li class="public "> <a href="#title_data_file-instance_method" title="#title_data_file (instance method)">#title_data_file ⇒ Pathname </a> <div class='inline'>The title data file for this title on the server.</div> </li> <li class="public "> <a href="#title_dir-instance_method" title="#title_dir (instance method)">#title_dir ⇒ Pathname </a> <div class='inline'>The title dir for this title on the server.</div> </li> <li class="public "> <a href="#to_h-instance_method" title="#to_h (instance method)">#to_h ⇒ Object </a> <div class='inline'>Add more server-specific data to our hash.</div> </li> <li class="public "> <a href="#uninstall_script_contents-instance_method" title="#uninstall_script_contents (instance method)">#uninstall_script_contents ⇒ String </a> <div class='inline'>The code of the uninstall_script , if any, considering the new data of any changes being made.</div> </li> <li class="public "> <a href="#uninstall_script_file-instance_method" title="#uninstall_script_file (instance method)">#uninstall_script_file ⇒ Pathname </a> <div class='inline'>The the local file containing the code of the uninstall script.</div> </li> <li class="public "> <a href="#uninstall_script_template-instance_method" title="#uninstall_script_template (instance method)">#uninstall_script_template ⇒ String </a> <div class='inline'>The template zsh script for uninstalling via pkgutil.</div> </li> <li class="public "> <a href="#uninstallable%3F-instance_method" title="#uninstallable? (instance method)">#uninstallable? ⇒ Boolean </a> <div class='inline'>are we uninstallable?.</div> </li> <li class="public "> <a href="#unlock-instance_method" title="#unlock (instance method)">#unlock ⇒ Object </a> <div class='inline'>Unlock this v for updates.</div> </li> <li class="public "> <a href="#update-instance_method" title="#update (instance method)">#update(new_data) ⇒ void </a> <div class='inline'>Update this title, updating to the local filesystem, Jamf Pro, and the Title Editor, and applying any changes to existing versions as needed.</div> </li> <li class="public "> <a href="#update_local_instance_values-instance_method" title="#update_local_instance_values (instance method)">#update_local_instance_values ⇒ void </a> <div class='inline'>Update our instance attributes with any new data before saving the changes back out to the file system.</div> </li> <li class="public "> <a href="#update_versions_for_release-instance_method" title="#update_versions_for_release (instance method)">#update_versions_for_release(version_to_release) ⇒ void </a> <div class='inline'>Update all versions when releasing one.</div> </li> <li class="public "> <a href="#updating%3F-instance_method" title="#updating? (instance method)">#updating? ⇒ Boolean </a> <div class='inline'>Are we updating this title?.</div> </li> <li class="public "> <a href="#validate_release-instance_method" title="#validate_release (instance method)">#validate_release(version_to_release) ⇒ void </a> <div class='inline'>are we OK releasing a given version?.</div> </li> <li class="public "> <a href="#version_object-instance_method" title="#version_object (instance method)">#version_object(version) ⇒ Xolo::Server::Version </a> <div class='inline'>instantiate a version if this title.</div> </li> <li class="public "> <a href="#version_objects-instance_method" title="#version_objects (instance method)">#version_objects(refresh: false) ⇒ Array<Xolo::Server::Version> </a> <div class='inline'>An array of all current version objects NOTE: This might not be wise if hundreds of versions, but automated maintenance should help with that.</div> </li> <li class="public "> <a href="#version_script_contents-instance_method" title="#version_script_contents (instance method)">#version_script_contents ⇒ String </a> <div class='inline'>The code of the version script, if any, considering the new data of any changes being made.</div> </li> <li class="public "> <a href="#version_script_file-instance_method" title="#version_script_file (instance method)">#version_script_file ⇒ Pathname </a> <div class='inline'>The the local file containing the code of the version script.</div> </li> </ul> <h3 class="inherited">Methods included from <a href="Mixins/TitleTedAccess.html" title="Xolo::Server::Mixins::TitleTedAccess (module)">Mixins::TitleTedAccess</a></h3> <a href="Mixins/TitleTedAccess.html#any_ted_changes%3F-instance_method" title="Xolo::Server::Mixins::TitleTedAccess#any_ted_changes? (method)">#any_ted_changes?</a>, <a href="Mixins/TitleTedAccess.html#apply_requirement_changes-instance_method" title="Xolo::Server::Mixins::TitleTedAccess#apply_requirement_changes (method)">#apply_requirement_changes</a>, <a href="Mixins/TitleTedAccess.html#create_and_enable_stub_patch_in_ted-instance_method" title="Xolo::Server::Mixins::TitleTedAccess#create_and_enable_stub_patch_in_ted (method)">#create_and_enable_stub_patch_in_ted</a>, <a href="Mixins/TitleTedAccess.html#create_ted_ea-instance_method" title="Xolo::Server::Mixins::TitleTedAccess#create_ted_ea (method)">#create_ted_ea</a>, <a href="Mixins/TitleTedAccess.html#create_ted_title_requirements-instance_method" title="Xolo::Server::Mixins::TitleTedAccess#create_ted_title_requirements (method)">#create_ted_title_requirements</a>, <a href="Mixins/TitleTedAccess.html#create_title_in_ted-instance_method" title="Xolo::Server::Mixins::TitleTedAccess#create_title_in_ted (method)">#create_title_in_ted</a>, <a href="Mixins/TitleTedAccess.html#delete_ted_ea-instance_method" title="Xolo::Server::Mixins::TitleTedAccess#delete_ted_ea (method)">#delete_ted_ea</a>, <a href="Mixins/TitleTedAccess.html#delete_title_from_ted-instance_method" title="Xolo::Server::Mixins::TitleTedAccess#delete_title_from_ted (method)">#delete_title_from_ted</a>, <a href="Mixins/TitleTedAccess.html#enable_ted_title-instance_method" title="Xolo::Server::Mixins::TitleTedAccess#enable_ted_title (method)">#enable_ted_title</a>, <a href="Mixins/TitleTedAccess.html#included-class_method" title="Xolo::Server::Mixins::TitleTedAccess.included (method)">included</a>, <a href="Mixins/TitleTedAccess.html#reenable_all_ted_patches-instance_method" title="Xolo::Server::Mixins::TitleTedAccess#reenable_all_ted_patches (method)">#reenable_all_ted_patches</a>, <a href="Mixins/TitleTedAccess.html#repair_ted_title-instance_method" title="Xolo::Server::Mixins::TitleTedAccess#repair_ted_title (method)">#repair_ted_title</a>, <a href="Mixins/TitleTedAccess.html#requirement_change-instance_method" title="Xolo::Server::Mixins::TitleTedAccess#requirement_change (method)">#requirement_change</a>, <a href="Mixins/TitleTedAccess.html#set_app_requirement-instance_method" title="Xolo::Server::Mixins::TitleTedAccess#set_app_requirement (method)">#set_app_requirement</a>, <a href="Mixins/TitleTedAccess.html#set_ea_requirement-instance_method" title="Xolo::Server::Mixins::TitleTedAccess#set_ea_requirement (method)">#set_ea_requirement</a>, <a href="Mixins/TitleTedAccess.html#set_ted_patch_component_criteria_after_update-instance_method" title="Xolo::Server::Mixins::TitleTedAccess#set_ted_patch_component_criteria_after_update (method)">#set_ted_patch_component_criteria_after_update</a>, <a href="Mixins/TitleTedAccess.html#set_ted_title_requirement-instance_method" title="Xolo::Server::Mixins::TitleTedAccess#set_ted_title_requirement (method)">#set_ted_title_requirement</a>, <a href="Mixins/TitleTedAccess.html#ted_ea_key-instance_method" title="Xolo::Server::Mixins::TitleTedAccess#ted_ea_key (method)">#ted_ea_key</a>, <a href="Mixins/TitleTedAccess.html#ted_title-instance_method" title="Xolo::Server::Mixins::TitleTedAccess#ted_title (method)">#ted_title</a>, <a href="Mixins/TitleTedAccess.html#ted_title_url-instance_method" title="Xolo::Server::Mixins::TitleTedAccess#ted_title_url (method)">#ted_title_url</a>, <a href="Mixins/TitleTedAccess.html#update_ted_ea-instance_method" title="Xolo::Server::Mixins::TitleTedAccess#update_ted_ea (method)">#update_ted_ea</a>, <a href="Mixins/TitleTedAccess.html#update_title_in_ted-instance_method" title="Xolo::Server::Mixins::TitleTedAccess#update_title_in_ted (method)">#update_title_in_ted</a> <h3 class="inherited">Methods included from <a href="Mixins/TitleJamfAccess.html" title="Xolo::Server::Mixins::TitleJamfAccess (module)">Mixins::TitleJamfAccess</a></h3> <a href="Mixins/TitleJamfAccess.html#accept_jamf_patch_ea-instance_method" title="Xolo::Server::Mixins::TitleJamfAccess#accept_jamf_patch_ea (method)">#accept_jamf_patch_ea</a>, <a href="Mixins/TitleJamfAccess.html#accept_jamf_patch_ea_via_api-instance_method" title="Xolo::Server::Mixins::TitleJamfAccess#accept_jamf_patch_ea_via_api (method)">#accept_jamf_patch_ea_via_api</a>, <a href="Mixins/TitleJamfAccess.html#activate_jamf_patch_title-instance_method" title="Xolo::Server::Mixins::TitleJamfAccess#activate_jamf_patch_title (method)">#activate_jamf_patch_title</a>, <a href="Mixins/TitleJamfAccess.html#add_title_to_self_service-instance_method" title="Xolo::Server::Mixins::TitleJamfAccess#add_title_to_self_service (method)">#add_title_to_self_service</a>, <a href="Mixins/TitleJamfAccess.html#auto_accept_patch_ea_in_thread-instance_method" title="Xolo::Server::Mixins::TitleJamfAccess#auto_accept_patch_ea_in_thread (method)">#auto_accept_patch_ea_in_thread</a>, <a href="Mixins/TitleJamfAccess.html#configure_jamf_expire_policy-instance_method" title="Xolo::Server::Mixins::TitleJamfAccess#configure_jamf_expire_policy (method)">#configure_jamf_expire_policy</a>, <a href="Mixins/TitleJamfAccess.html#configure_jamf_installed_group-instance_method" title="Xolo::Server::Mixins::TitleJamfAccess#configure_jamf_installed_group (method)">#configure_jamf_installed_group</a>, <a href="Mixins/TitleJamfAccess.html#configure_jamf_manual_install_released_policy-instance_method" title="Xolo::Server::Mixins::TitleJamfAccess#configure_jamf_manual_install_released_policy (method)">#configure_jamf_manual_install_released_policy</a>, <a href="Mixins/TitleJamfAccess.html#configure_jamf_target_groups_exclusion_group-instance_method" title="Xolo::Server::Mixins::TitleJamfAccess#configure_jamf_target_groups_exclusion_group (method)">#configure_jamf_target_groups_exclusion_group</a>, <a href="Mixins/TitleJamfAccess.html#configure_jamf_uninstall_policy-instance_method" title="Xolo::Server::Mixins::TitleJamfAccess#configure_jamf_uninstall_policy (method)">#configure_jamf_uninstall_policy</a>, <a href="Mixins/TitleJamfAccess.html#configure_jamf_uninstall_script-instance_method" title="Xolo::Server::Mixins::TitleJamfAccess#configure_jamf_uninstall_script (method)">#configure_jamf_uninstall_script</a>, <a href="Mixins/TitleJamfAccess.html#configure_pol_for_self_service-instance_method" title="Xolo::Server::Mixins::TitleJamfAccess#configure_pol_for_self_service (method)">#configure_pol_for_self_service</a>, <a href="Mixins/TitleJamfAccess.html#create_jamf_manual_install_released_policy-instance_method" title="Xolo::Server::Mixins::TitleJamfAccess#create_jamf_manual_install_released_policy (method)">#create_jamf_manual_install_released_policy</a>, <a href="Mixins/TitleJamfAccess.html#create_title_in_jamf-instance_method" title="Xolo::Server::Mixins::TitleJamfAccess#create_title_in_jamf (method)">#create_title_in_jamf</a>, <a href="Mixins/TitleJamfAccess.html#delete_jamf_expire_policy-instance_method" title="Xolo::Server::Mixins::TitleJamfAccess#delete_jamf_expire_policy (method)">#delete_jamf_expire_policy</a>, <a href="Mixins/TitleJamfAccess.html#delete_jamf_frozen_group-instance_method" title="Xolo::Server::Mixins::TitleJamfAccess#delete_jamf_frozen_group (method)">#delete_jamf_frozen_group</a>, <a href="Mixins/TitleJamfAccess.html#delete_jamf_installed_group-instance_method" title="Xolo::Server::Mixins::TitleJamfAccess#delete_jamf_installed_group (method)">#delete_jamf_installed_group</a>, <a href="Mixins/TitleJamfAccess.html#delete_jamf_manual_install_released_policy-instance_method" title="Xolo::Server::Mixins::TitleJamfAccess#delete_jamf_manual_install_released_policy (method)">#delete_jamf_manual_install_released_policy</a>, <a href="Mixins/TitleJamfAccess.html#delete_jamf_patch_title-instance_method" title="Xolo::Server::Mixins::TitleJamfAccess#delete_jamf_patch_title (method)">#delete_jamf_patch_title</a>, <a href="Mixins/TitleJamfAccess.html#delete_jamf_target_groups_exclusion_group-instance_method" title="Xolo::Server::Mixins::TitleJamfAccess#delete_jamf_target_groups_exclusion_group (method)">#delete_jamf_target_groups_exclusion_group</a>, <a href="Mixins/TitleJamfAccess.html#delete_jamf_uninstall_policy-instance_method" title="Xolo::Server::Mixins::TitleJamfAccess#delete_jamf_uninstall_policy (method)">#delete_jamf_uninstall_policy</a>, <a href="Mixins/TitleJamfAccess.html#delete_jamf_uninstall_script-instance_method" title="Xolo::Server::Mixins::TitleJamfAccess#delete_jamf_uninstall_script (method)">#delete_jamf_uninstall_script</a>, <a href="Mixins/TitleJamfAccess.html#delete_title_from_jamf-instance_method" title="Xolo::Server::Mixins::TitleJamfAccess#delete_title_from_jamf (method)">#delete_title_from_jamf</a>, <a href="Mixins/TitleJamfAccess.html#excluded_groups_to_use-instance_method" title="Xolo::Server::Mixins::TitleJamfAccess#excluded_groups_to_use (method)">#excluded_groups_to_use</a>, <a href="Mixins/TitleJamfAccess.html#freeze_computers-instance_method" title="Xolo::Server::Mixins::TitleJamfAccess#freeze_computers (method)">#freeze_computers</a>, <a href="Mixins/TitleJamfAccess.html#freeze_or_thaw_computers-instance_method" title="Xolo::Server::Mixins::TitleJamfAccess#freeze_or_thaw_computers (method)">#freeze_or_thaw_computers</a>, <a href="Mixins/TitleJamfAccess.html#frozen_computers-instance_method" title="Xolo::Server::Mixins::TitleJamfAccess#frozen_computers (method)">#frozen_computers</a>, <a href="Mixins/TitleJamfAccess.html#included-class_method" title="Xolo::Server::Mixins::TitleJamfAccess.included (method)">included</a>, <a href="Mixins/TitleJamfAccess.html#jamf_active_managed_titles-instance_method" title="Xolo::Server::Mixins::TitleJamfAccess#jamf_active_managed_titles (method)">#jamf_active_managed_titles</a>, <a href="Mixins/TitleJamfAccess.html#jamf_active_subscribed_titles-instance_method" title="Xolo::Server::Mixins::TitleJamfAccess#jamf_active_subscribed_titles (method)">#jamf_active_subscribed_titles</a>, <a href="Mixins/TitleJamfAccess.html#jamf_available_managed_titles-instance_method" title="Xolo::Server::Mixins::TitleJamfAccess#jamf_available_managed_titles (method)">#jamf_available_managed_titles</a>, <a href="Mixins/TitleJamfAccess.html#jamf_expire_policy-instance_method" title="Xolo::Server::Mixins::TitleJamfAccess#jamf_expire_policy (method)">#jamf_expire_policy</a>, <a href="Mixins/TitleJamfAccess.html#jamf_expire_policy_exist%3F-instance_method" title="Xolo::Server::Mixins::TitleJamfAccess#jamf_expire_policy_exist? (method)">#jamf_expire_policy_exist?</a>, <a href="Mixins/TitleJamfAccess.html#jamf_expire_policy_url-instance_method" title="Xolo::Server::Mixins::TitleJamfAccess#jamf_expire_policy_url (method)">#jamf_expire_policy_url</a>, <a href="Mixins/TitleJamfAccess.html#jamf_frozen_group-instance_method" title="Xolo::Server::Mixins::TitleJamfAccess#jamf_frozen_group (method)">#jamf_frozen_group</a>, <a href="Mixins/TitleJamfAccess.html#jamf_frozen_group_exist%3F-instance_method" title="Xolo::Server::Mixins::TitleJamfAccess#jamf_frozen_group_exist? (method)">#jamf_frozen_group_exist?</a>, <a href="Mixins/TitleJamfAccess.html#jamf_frozen_group_url-instance_method" title="Xolo::Server::Mixins::TitleJamfAccess#jamf_frozen_group_url (method)">#jamf_frozen_group_url</a>, <a href="Mixins/TitleJamfAccess.html#jamf_gui_url-instance_method" title="Xolo::Server::Mixins::TitleJamfAccess#jamf_gui_url (method)">#jamf_gui_url</a>, <a href="Mixins/TitleJamfAccess.html#jamf_installed_group-instance_method" title="Xolo::Server::Mixins::TitleJamfAccess#jamf_installed_group (method)">#jamf_installed_group</a>, <a href="Mixins/TitleJamfAccess.html#jamf_installed_group_criteria-instance_method" title="Xolo::Server::Mixins::TitleJamfAccess#jamf_installed_group_criteria (method)">#jamf_installed_group_criteria</a>, <a href="Mixins/TitleJamfAccess.html#jamf_installed_group_exist%3F-instance_method" title="Xolo::Server::Mixins::TitleJamfAccess#jamf_installed_group_exist? (method)">#jamf_installed_group_exist?</a>, <a href="Mixins/TitleJamfAccess.html#jamf_installed_group_url-instance_method" title="Xolo::Server::Mixins::TitleJamfAccess#jamf_installed_group_url (method)">#jamf_installed_group_url</a>, <a href="Mixins/TitleJamfAccess.html#jamf_managed_patch_source-instance_method" title="Xolo::Server::Mixins::TitleJamfAccess#jamf_managed_patch_source (method)">#jamf_managed_patch_source</a>, <a href="Mixins/TitleJamfAccess.html#jamf_managed_title_available%3F-instance_method" title="Xolo::Server::Mixins::TitleJamfAccess#jamf_managed_title_available? (method)">#jamf_managed_title_available?</a>, <a href="Mixins/TitleJamfAccess.html#jamf_manual_install_released_policy-instance_method" title="Xolo::Server::Mixins::TitleJamfAccess#jamf_manual_install_released_policy (method)">#jamf_manual_install_released_policy</a>, <a href="Mixins/TitleJamfAccess.html#jamf_manual_install_released_policy_exist%3F-instance_method" title="Xolo::Server::Mixins::TitleJamfAccess#jamf_manual_install_released_policy_exist? (method)">#jamf_manual_install_released_policy_exist?</a>, <a href="Mixins/TitleJamfAccess.html#jamf_manual_install_released_policy_url-instance_method" title="Xolo::Server::Mixins::TitleJamfAccess#jamf_manual_install_released_policy_url (method)">#jamf_manual_install_released_policy_url</a>, <a href="Mixins/TitleJamfAccess.html#jamf_patch_ea_awaiting_acceptance%3F-instance_method" title="Xolo::Server::Mixins::TitleJamfAccess#jamf_patch_ea_awaiting_acceptance? (method)">#jamf_patch_ea_awaiting_acceptance?</a>, <a href="Mixins/TitleJamfAccess.html#jamf_patch_ea_contents-instance_method" title="Xolo::Server::Mixins::TitleJamfAccess#jamf_patch_ea_contents (method)">#jamf_patch_ea_contents</a>, <a href="Mixins/TitleJamfAccess.html#jamf_patch_ea_data-instance_method" title="Xolo::Server::Mixins::TitleJamfAccess#jamf_patch_ea_data (method)">#jamf_patch_ea_data</a>, <a href="Mixins/TitleJamfAccess.html#jamf_patch_ea_matches_version_script%3F-instance_method" title="Xolo::Server::Mixins::TitleJamfAccess#jamf_patch_ea_matches_version_script? (method)">#jamf_patch_ea_matches_version_script?</a>, <a href="Mixins/TitleJamfAccess.html#jamf_patch_ea_url-instance_method" title="Xolo::Server::Mixins::TitleJamfAccess#jamf_patch_ea_url (method)">#jamf_patch_ea_url</a>, <a href="Mixins/TitleJamfAccess.html#jamf_patch_title-instance_method" title="Xolo::Server::Mixins::TitleJamfAccess#jamf_patch_title (method)">#jamf_patch_title</a>, <a href="Mixins/TitleJamfAccess.html#jamf_patch_title_url-instance_method" title="Xolo::Server::Mixins::TitleJamfAccess#jamf_patch_title_url (method)">#jamf_patch_title_url</a>, <a href="Mixins/TitleJamfAccess.html#jamf_target_groups_exclusion_group-instance_method" title="Xolo::Server::Mixins::TitleJamfAccess#jamf_target_groups_exclusion_group (method)">#jamf_target_groups_exclusion_group</a>, <a href="Mixins/TitleJamfAccess.html#jamf_target_groups_exclusion_group_criteria-instance_method" title="Xolo::Server::Mixins::TitleJamfAccess#jamf_target_groups_exclusion_group_criteria (method)">#jamf_target_groups_exclusion_group_criteria</a>, <a href="Mixins/TitleJamfAccess.html#jamf_target_groups_exclusion_group_exist%3F-instance_method" title="Xolo::Server::Mixins::TitleJamfAccess#jamf_target_groups_exclusion_group_exist? (method)">#jamf_target_groups_exclusion_group_exist?</a>, <a href="Mixins/TitleJamfAccess.html#jamf_target_groups_exclusion_group_url-instance_method" title="Xolo::Server::Mixins::TitleJamfAccess#jamf_target_groups_exclusion_group_url (method)">#jamf_target_groups_exclusion_group_url</a>, <a href="Mixins/TitleJamfAccess.html#jamf_title_active%3F-instance_method" title="Xolo::Server::Mixins::TitleJamfAccess#jamf_title_active? (method)">#jamf_title_active?</a>, <a href="Mixins/TitleJamfAccess.html#jamf_uninstall_policy-instance_method" title="Xolo::Server::Mixins::TitleJamfAccess#jamf_uninstall_policy (method)">#jamf_uninstall_policy</a>, <a href="Mixins/TitleJamfAccess.html#jamf_uninstall_policy_exist%3F-instance_method" title="Xolo::Server::Mixins::TitleJamfAccess#jamf_uninstall_policy_exist? (method)">#jamf_uninstall_policy_exist?</a>, <a href="Mixins/TitleJamfAccess.html#jamf_uninstall_policy_url-instance_method" title="Xolo::Server::Mixins::TitleJamfAccess#jamf_uninstall_policy_url (method)">#jamf_uninstall_policy_url</a>, <a href="Mixins/TitleJamfAccess.html#jamf_uninstall_script-instance_method" title="Xolo::Server::Mixins::TitleJamfAccess#jamf_uninstall_script (method)">#jamf_uninstall_script</a>, <a href="Mixins/TitleJamfAccess.html#jamf_uninstall_script_exist%3F-instance_method" title="Xolo::Server::Mixins::TitleJamfAccess#jamf_uninstall_script_exist? (method)">#jamf_uninstall_script_exist?</a>, <a href="Mixins/TitleJamfAccess.html#jamf_uninstall_script_url-instance_method" title="Xolo::Server::Mixins::TitleJamfAccess#jamf_uninstall_script_url (method)">#jamf_uninstall_script_url</a>, <a href="Mixins/TitleJamfAccess.html#jp_api_filter_string_for_version-instance_method" title="Xolo::Server::Mixins::TitleJamfAccess#jp_api_filter_string_for_version (method)">#jp_api_filter_string_for_version</a>, <a href="Mixins/TitleJamfAccess.html#need_to_accept_jamf_patch_ea%3F-instance_method" title="Xolo::Server::Mixins::TitleJamfAccess#need_to_accept_jamf_patch_ea? (method)">#need_to_accept_jamf_patch_ea?</a>, <a href="Mixins/TitleJamfAccess.html#need_to_delete_jamf_uninstall_script%3F-instance_method" title="Xolo::Server::Mixins::TitleJamfAccess#need_to_delete_jamf_uninstall_script? (method)">#need_to_delete_jamf_uninstall_script?</a>, <a href="Mixins/TitleJamfAccess.html#need_to_update_description%3F-instance_method" title="Xolo::Server::Mixins::TitleJamfAccess#need_to_update_description? (method)">#need_to_update_description?</a>, <a href="Mixins/TitleJamfAccess.html#need_to_update_expiration%3F-instance_method" title="Xolo::Server::Mixins::TitleJamfAccess#need_to_update_expiration? (method)">#need_to_update_expiration?</a>, <a href="Mixins/TitleJamfAccess.html#need_to_update_jamf_uninstall_script%3F-instance_method" title="Xolo::Server::Mixins::TitleJamfAccess#need_to_update_jamf_uninstall_script? (method)">#need_to_update_jamf_uninstall_script?</a>, <a href="Mixins/TitleJamfAccess.html#patch_report-instance_method" title="Xolo::Server::Mixins::TitleJamfAccess#patch_report (method)">#patch_report</a>, <a href="Mixins/TitleJamfAccess.html#patch_versions-instance_method" title="Xolo::Server::Mixins::TitleJamfAccess#patch_versions (method)">#patch_versions</a>, <a href="Mixins/TitleJamfAccess.html#remove_title_from_self_service-instance_method" title="Xolo::Server::Mixins::TitleJamfAccess#remove_title_from_self_service (method)">#remove_title_from_self_service</a>, <a href="Mixins/TitleJamfAccess.html#repair_frozen_group-instance_method" title="Xolo::Server::Mixins::TitleJamfAccess#repair_frozen_group (method)">#repair_frozen_group</a>, <a href="Mixins/TitleJamfAccess.html#repair_jamf_expire_policy-instance_method" title="Xolo::Server::Mixins::TitleJamfAccess#repair_jamf_expire_policy (method)">#repair_jamf_expire_policy</a>, <a href="Mixins/TitleJamfAccess.html#repair_jamf_installed_group-instance_method" title="Xolo::Server::Mixins::TitleJamfAccess#repair_jamf_installed_group (method)">#repair_jamf_installed_group</a>, <a href="Mixins/TitleJamfAccess.html#repair_jamf_manual_install_released_policy-instance_method" title="Xolo::Server::Mixins::TitleJamfAccess#repair_jamf_manual_install_released_policy (method)">#repair_jamf_manual_install_released_policy</a>, <a href="Mixins/TitleJamfAccess.html#repair_jamf_target_groups_exclusion_group-instance_method" title="Xolo::Server::Mixins::TitleJamfAccess#repair_jamf_target_groups_exclusion_group (method)">#repair_jamf_target_groups_exclusion_group</a>, <a href="Mixins/TitleJamfAccess.html#repair_jamf_title_objects-instance_method" title="Xolo::Server::Mixins::TitleJamfAccess#repair_jamf_title_objects (method)">#repair_jamf_title_objects</a>, <a href="Mixins/TitleJamfAccess.html#repair_jamf_uninstall_policy-instance_method" title="Xolo::Server::Mixins::TitleJamfAccess#repair_jamf_uninstall_policy (method)">#repair_jamf_uninstall_policy</a>, <a href="Mixins/TitleJamfAccess.html#repair_jamf_uninstall_script-instance_method" title="Xolo::Server::Mixins::TitleJamfAccess#repair_jamf_uninstall_script (method)">#repair_jamf_uninstall_script</a>, <a href="Mixins/TitleJamfAccess.html#run_autopkg_recipe-instance_method" title="Xolo::Server::Mixins::TitleJamfAccess#run_autopkg_recipe (method)">#run_autopkg_recipe</a>, <a href="Mixins/TitleJamfAccess.html#set_subscribed_display_name_and_publisher-instance_method" title="Xolo::Server::Mixins::TitleJamfAccess#set_subscribed_display_name_and_publisher (method)">#set_subscribed_display_name_and_publisher</a>, <a href="Mixins/TitleJamfAccess.html#target_groups_to_use-instance_method" title="Xolo::Server::Mixins::TitleJamfAccess#target_groups_to_use (method)">#target_groups_to_use</a>, <a href="Mixins/TitleJamfAccess.html#thaw_computers-instance_method" title="Xolo::Server::Mixins::TitleJamfAccess#thaw_computers (method)">#thaw_computers</a>, <a href="Mixins/TitleJamfAccess.html#toggle_jamf_manual_install_released_policy-instance_method" title="Xolo::Server::Mixins::TitleJamfAccess#toggle_jamf_manual_install_released_policy (method)">#toggle_jamf_manual_install_released_policy</a>, <a href="Mixins/TitleJamfAccess.html#update_description_in_jamf-instance_method" title="Xolo::Server::Mixins::TitleJamfAccess#update_description_in_jamf (method)">#update_description_in_jamf</a>, <a href="Mixins/TitleJamfAccess.html#update_ssvc-instance_method" title="Xolo::Server::Mixins::TitleJamfAccess#update_ssvc (method)">#update_ssvc</a>, <a href="Mixins/TitleJamfAccess.html#update_title_in_jamf-instance_method" title="Xolo::Server::Mixins::TitleJamfAccess#update_title_in_jamf (method)">#update_title_in_jamf</a>, <a href="Mixins/TitleJamfAccess.html#update_versions_for_title_changes_in_jamf-instance_method" title="Xolo::Server::Mixins::TitleJamfAccess#update_versions_for_title_changes_in_jamf (method)">#update_versions_for_title_changes_in_jamf</a>, <a href="Mixins/TitleJamfAccess.html#use_jamf_target_groups_exclusion_group%3F-instance_method" title="Xolo::Server::Mixins::TitleJamfAccess#use_jamf_target_groups_exclusion_group? (method)">#use_jamf_target_groups_exclusion_group?</a>, <a href="Mixins/TitleJamfAccess.html#wait_for_managed_title_to_become_available-instance_method" title="Xolo::Server::Mixins::TitleJamfAccess#wait_for_managed_title_to_become_available (method)">#wait_for_managed_title_to_become_available</a> <h3 class="inherited">Methods included from <a href="Mixins/Changelog.html" title="Xolo::Server::Mixins::Changelog (module)">Mixins::Changelog</a></h3> <a href="Mixins/Changelog.html#backup_changelog-instance_method" title="Xolo::Server::Mixins::Changelog#backup_changelog (method)">#backup_changelog</a>, <a href="Mixins/Changelog.html#backup_file_dir-class_method" title="Xolo::Server::Mixins::Changelog.backup_file_dir (method)">backup_file_dir</a>, <a href="Mixins/Changelog.html#changelog-instance_method" title="Xolo::Server::Mixins::Changelog#changelog (method)">#changelog</a>, <a href="Mixins/Changelog.html#changelog_backup_file-instance_method" title="Xolo::Server::Mixins::Changelog#changelog_backup_file (method)">#changelog_backup_file</a>, <a href="Mixins/Changelog.html#changelog_file-instance_method" title="Xolo::Server::Mixins::Changelog#changelog_file (method)">#changelog_file</a>, <a href="Mixins/Changelog.html#changelog_lock-instance_method" title="Xolo::Server::Mixins::Changelog#changelog_lock (method)">#changelog_lock</a>, <a href="Mixins/Changelog.html#changelog_locks-class_method" title="Xolo::Server::Mixins::Changelog.changelog_locks (method)">changelog_locks</a>, <a href="Mixins/Changelog.html#delete_changelog-instance_method" title="Xolo::Server::Mixins::Changelog#delete_changelog (method)">#delete_changelog</a>, <a href="Mixins/Changelog.html#hostname_from_ip-instance_method" title="Xolo::Server::Mixins::Changelog#hostname_from_ip (method)">#hostname_from_ip</a>, <a href="Mixins/Changelog.html#included-class_method" title="Xolo::Server::Mixins::Changelog.included (method)">included</a>, <a href="Mixins/Changelog.html#log_change-instance_method" title="Xolo::Server::Mixins::Changelog#log_change (method)">#log_change</a>, <a href="Mixins/Changelog.html#log_update_changes-instance_method" title="Xolo::Server::Mixins::Changelog#log_update_changes (method)">#log_update_changes</a>, <a href="Mixins/Changelog.html#note_changes_for_update_and_log-instance_method" title="Xolo::Server::Mixins::Changelog#note_changes_for_update_and_log (method)">#note_changes_for_update_and_log</a> <h3 class="inherited">Methods included from <a href="Helpers/Notification.html" title="Xolo::Server::Helpers::Notification (module)">Helpers::Notification</a></h3> <a href="Helpers/Notification.html#email_from-instance_method" title="Xolo::Server::Helpers::Notification#email_from (method)">#email_from</a>, <a href="Helpers/Notification.html#included-class_method" title="Xolo::Server::Helpers::Notification.included (method)">included</a>, <a href="Helpers/Notification.html#send_alert-instance_method" title="Xolo::Server::Helpers::Notification#send_alert (method)">#send_alert</a>, <a href="Helpers/Notification.html#send_email-instance_method" title="Xolo::Server::Helpers::Notification#send_email (method)">#send_email</a>, <a href="Helpers/Notification.html#send_email_alert-instance_method" title="Xolo::Server::Helpers::Notification#send_email_alert (method)">#send_email_alert</a>, <a href="Helpers/Notification.html#server_fqdn-instance_method" title="Xolo::Server::Helpers::Notification#server_fqdn (method)">#server_fqdn</a>, <a href="Helpers/Notification.html#server_name-instance_method" title="Xolo::Server::Helpers::Notification#server_name (method)">#server_name</a> <h3 class="inherited">Methods included from <a href="Helpers/Log.html" title="Xolo::Server::Helpers::Log (module)">Helpers::Log</a></h3> <a href="Helpers/Log.html#included-class_method" title="Xolo::Server::Helpers::Log.included (method)">included</a>, <a href="Helpers/Log.html#log_debug-instance_method" title="Xolo::Server::Helpers::Log#log_debug (method)">#log_debug</a>, <a href="Helpers/Log.html#log_error-instance_method" title="Xolo::Server::Helpers::Log#log_error (method)">#log_error</a>, <a href="Helpers/Log.html#log_fatal-instance_method" title="Xolo::Server::Helpers::Log#log_fatal (method)">#log_fatal</a>, <a href="Helpers/Log.html#log_info-instance_method" title="Xolo::Server::Helpers::Log#log_info (method)">#log_info</a>, <a href="Helpers/Log.html#log_unknown-instance_method" title="Xolo::Server::Helpers::Log#log_unknown (method)">#log_unknown</a>, <a href="Helpers/Log.html#log_warn-instance_method" title="Xolo::Server::Helpers::Log#log_warn (method)">#log_warn</a>, <a href="Helpers/Log.html#logger-instance_method" title="Xolo::Server::Helpers::Log#logger (method)">#logger</a>, <a href="Helpers/Log.html#session_svr_obj_id-instance_method" title="Xolo::Server::Helpers::Log#session_svr_obj_id (method)">#session_svr_obj_id</a> <h3 class="inherited">Methods included from <a href="Helpers/TitleEditor.html" title="Xolo::Server::Helpers::TitleEditor (module)">Helpers::TitleEditor</a></h3> <a href="Helpers/TitleEditor.html#included-class_method" title="Xolo::Server::Helpers::TitleEditor.included (method)">included</a> <h3 class="inherited">Methods included from <a href="Helpers/JamfPro.html" title="Xolo::Server::Helpers::JamfPro (module)">Helpers::JamfPro</a></h3> <a href="Helpers/JamfPro.html#extended-class_method" title="Xolo::Server::Helpers::JamfPro.extended (method)">extended</a>, <a href="Helpers/JamfPro.html#included-class_method" title="Xolo::Server::Helpers::JamfPro.included (method)">included</a>, <a href="Helpers/JamfPro.html#jamf_gui_url-instance_method" title="Xolo::Server::Helpers::JamfPro#jamf_gui_url (method)">#jamf_gui_url</a>, <a href="Helpers/JamfPro.html#jamf_obj_name_pfx_base-instance_method" title="Xolo::Server::Helpers::JamfPro#jamf_obj_name_pfx_base (method)">#jamf_obj_name_pfx_base</a>, <a href="Helpers/JamfPro.html#jamf_xolo_category_id-instance_method" title="Xolo::Server::Helpers::JamfPro#jamf_xolo_category_id (method)">#jamf_xolo_category_id</a>, <a href="Helpers/JamfPro.html#valid_forced_exclusion_group_name-instance_method" title="Xolo::Server::Helpers::JamfPro#valid_forced_exclusion_group_name (method)">#valid_forced_exclusion_group_name</a> <div id="constructor_details" class="method_details_list"> <h2>Constructor Details</h2> <div class="method_details first"> <h3 class="signature first" id="initialize-instance_method"> #initialize(data_hash) ⇒ <tt><a href="" title="Xolo::Server::Title (class)">Title</a></tt> </h3><div class="docstring"> <div class="discussion"> NOTE: be sure to only instantiate these using the servers 'instantiate_title' method, or else they might not have all the correct innards </div> </div> <div class="tags"> </div><table class="source_code"> <tr> <td> <pre class="lines"> 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/title.rb', line 359 def initialize(data_hash) super # 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_obj_name_pfx = "#{jamf_obj_name_pfx_base}#{data_hash[:title]}" @jamf_installed_group_name = "#{jamf_obj_name_pfx}-#{<a href="#JAMF_INSTALLED_GROUP_NAME_SUFFIX-constant" title="Xolo::Server::Title::JAMF_INSTALLED_GROUP_NAME_SUFFIX (constant)">JAMF_INSTALLED_GROUP_NAME_SUFFIX</a>}" @jamf_frozen_group_name = "#{jamf_obj_name_pfx}-#{<a href="#JAMF_FROZEN_GROUP_NAME_SUFFIX-constant" title="Xolo::Server::Title::JAMF_FROZEN_GROUP_NAME_SUFFIX (constant)">JAMF_FROZEN_GROUP_NAME_SUFFIX</a>}" @jamf_target_groups_exclusion_group_name = "#{jamf_obj_name_pfx}-#{<a href="#JAMF_TGT_GRP_EXCL_GRP_NAME_SUFFIX-constant" title="Xolo::Server::Title::JAMF_TGT_GRP_EXCL_GRP_NAME_SUFFIX (constant)">JAMF_TGT_GRP_EXCL_GRP_NAME_SUFFIX</a>}" @jamf_manual_install_released_policy_name = "#{jamf_obj_name_pfx}-#{<a href="#JAMF_MANUAL_INSTALL_RELEASED_POL_SUFFIX-constant" title="Xolo::Server::Title::JAMF_MANUAL_INSTALL_RELEASED_POL_SUFFIX (constant)">JAMF_MANUAL_INSTALL_RELEASED_POL_SUFFIX</a>}" @jamf_uninstall_script_name = "#{jamf_obj_name_pfx}-#{<a href="#JAMF_UNINSTALL_SUFFIX-constant" title="Xolo::Server::Title::JAMF_UNINSTALL_SUFFIX (constant)">JAMF_UNINSTALL_SUFFIX</a>}" @jamf_uninstall_policy_name = "#{jamf_obj_name_pfx}-#{<a href="#JAMF_UNINSTALL_SUFFIX-constant" title="Xolo::Server::Title::JAMF_UNINSTALL_SUFFIX (constant)">JAMF_UNINSTALL_SUFFIX</a>}" @jamf_expire_policy_name = "#{jamf_obj_name_pfx}-#{<a href="#JAMF_EXPIRE_SUFFIX-constant" title="Xolo::Server::Title::JAMF_EXPIRE_SUFFIX (constant)">JAMF_EXPIRE_SUFFIX</a>}" # DO NOT USE jamf_cnx here, it comes from the server app instance, which is not set until after initialization. end</pre> </td> </tr> </table> </div> </div> <div id="instance_attr_details" class="attr_details"> <h2>Instance Attribute Details</h2> <div class="method_details first"> <h3 class="signature first" id="changes_for_update-instance_method"> #changes_for_update ⇒ <tt>Hash</tt> (readonly) </h3><div class="docstring"> <div class="discussion"> Also when applying updates, this will hold the changes being made: the differences between tne current attributes and the new_data_for_update We'll figure this out at the start of the update and can use it later to <ol> <li>avoid doing things we don't need to</li> <li>log the changes in the change log at the very end</li> </ol> This is a Hash with keys of the attribute names that have changed the values are Hashes with keys of :old and :new e.g. { release_groups: { old: ['foo'], new: ['bar'] } } </div> </div> <div class="tags"> Returns: <ul class="return"> <li> (<tt>Hash</tt>) — <div class='inline'>The changes being made</div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 328 329 330</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/title.rb', line 328 def changes_for_update @changes_for_update end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="current_action-instance_method"> #current_action ⇒ <tt>Symbol</tt> </h3><div class="docstring"> <div class="discussion"> Returns The current action being taken on this title one of :creating, :updating, :deleting. </div> </div> <div class="tags"> Returns: <ul class="return"> <li> (<tt>Symbol</tt>) — <div class='inline'>The current action being taken on this title one of :creating, :updating, :deleting</div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 336 337 338</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/title.rb', line 336 def current_action @current_action end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="jamf_expire_policy_name-instance_method"> #jamf_expire_policy_name ⇒ <tt>String</tt> (readonly) </h3><div class="docstring"> <div class="discussion"> If a title is expirable, it will have a policy in Jamf named 'xolo-<title>-expire' that will run the expiration process daily, at checkin or using a trigger of the same name. </div> </div> <div class="tags"> Returns: <ul class="return"> <li> (<tt>String</tt>) — <div class='inline'>the name of the policy to uninstall the title</div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 298 299 300</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/title.rb', line 298 def jamf_expire_policy_name @jamf_expire_policy_name end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="jamf_frozen_group_name-instance_method"> #jamf_frozen_group_name ⇒ <tt>String</tt> (readonly) </h3><div class="docstring"> <div class="discussion"> For each title there will be a static group containing macs that should not get any automatic installs or updates, They should be 'frozen' at whatever version was installed when they were added to the group. It will be named 'xolo-<title>-frozen' It will be used as an exclusion for the installation policies and the patch policy for each version. Membership is maintained using <code>xadm freeze <title> <computer> [<computer> ...]</code> and <code>xadm thaw <title> <computer> [<computer> ...]</code> Use <code>xadm report <title> frozen</code> to see a list. If computer groups are used with freeze/thaw, they are expanded and their members added/removed individually in the static group Since there is one such group per title, it's name is stored here </div> </div> <div class="tags"> Returns: <ul class="return"> <li> (<tt>String</tt>) — <div class='inline'>the name of the smart group</div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 259 260 261</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/title.rb', line 259 def jamf_frozen_group_name @jamf_frozen_group_name end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="jamf_installed_group_name-instance_method"> #jamf_installed_group_name ⇒ <tt>String</tt> (readonly) </h3><div class="docstring"> <div class="discussion"> For each title there will be a smart group containing all macs that have any version of the title installed. The smart group will be named 'xolo-<title>-installed' It will be used as an exclusion for the initial auto-installation policy for each version since if the title is installed at all, any installation is not 'initial' but an update, and will be handled by the Patch Policy. Since there is one such group per title, it's name is stored here </div> </div> <div class="tags"> Returns: <ul class="return"> <li> (<tt>String</tt>) — <div class='inline'>the name of the smart group</div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 238 239 240</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/title.rb', line 238 def jamf_installed_group_name @jamf_installed_group_name end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="jamf_manual_install_released_policy_name-instance_method"> #jamf_manual_install_released_policy_name ⇒ <tt>Object</tt> (readonly) </h3><div class="docstring"> <div class="discussion"> The name of the policy that does initial manual or self-service installs of the currently-released version of this title. It will be named 'xolo-<title>-install' </div> </div> <div class="tags"> </div><table class="source_code"> <tr> <td> <pre class="lines"> 278 279 280</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/title.rb', line 278 def jamf_manual_install_released_policy_name @jamf_manual_install_released_policy_name end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="jamf_obj_name_pfx-instance_method"> #jamf_obj_name_pfx ⇒ <tt>String</tt> (readonly) </h3><div class="docstring"> <div class="discussion"> Returns The prefix for all jamf objects for this title, which is 'xolo-<title>' or 'xolotest-<title>' for test server. </div> </div> <div class="tags"> Returns: <ul class="return"> <li> (<tt>String</tt>) — <div class='inline'>The prefix for all jamf objects for this title, which is 'xolo-<title>' or 'xolotest-<title>' for test server</div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 347 348 349</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/title.rb', line 347 def jamf_obj_name_pfx @jamf_obj_name_pfx end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="jamf_patch_source_id-instance_method"> #jamf_patch_source_id ⇒ <tt>String</tt> </h3><div class="docstring"> <div class="discussion"> Returns The jamf ID of the patch source for this title if the title is subscribed. Managed titles are all in the Title Editor source. </div> </div> <div class="tags"> Returns: <ul class="return"> <li> (<tt>String</tt>) — <div class='inline'>The jamf ID of the patch source for this title if the title is subscribed. Managed titles are all in the Title Editor source.</div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 344 345 346</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/title.rb', line 344 def jamf_patch_source_id @jamf_patch_source_id end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="jamf_target_groups_exclusion_group_name-instance_method"> #jamf_target_groups_exclusion_group_name ⇒ <tt>String</tt> (readonly) </h3><div class="docstring"> <div class="discussion"> If a title has 'target_groups', they act as the opposite of excluded groups - macs NOT in the target groups can't see the title. We implement this by maintaining a smart group named 'xolo-<title>-target-group-exclusions', which has the criteria: <pre class="code ruby"><code class="ruby">computerGroup...not a member of...<target-group> </code></pre> ANDed together for each target-group and then we use that smart group as an exclusion. This is the name of that smart group. </div> </div> <div class="tags"> Returns: <ul class="return"> <li> (<tt>String</tt>) — <div class='inline'>the name of the smart group</div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 273 274 275</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/title.rb', line 273 def jamf_target_groups_exclusion_group_name @jamf_target_groups_exclusion_group_name end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="jamf_uninstall_policy_name-instance_method"> #jamf_uninstall_policy_name ⇒ <tt>String</tt> (readonly) </h3><div class="docstring"> <div class="discussion"> If a title is uninstallable, it will have a policy in Jamf named 'xolo-<title>-uninstall' that will run the script of the same name, using a trigger of the same name. </div> </div> <div class="tags"> Returns: <ul class="return"> <li> (<tt>String</tt>) — <div class='inline'>the name of the policy to uninstall the title</div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 291 292 293</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/title.rb', line 291 def jamf_uninstall_policy_name @jamf_uninstall_policy_name end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="jamf_uninstall_script_name-instance_method"> #jamf_uninstall_script_name ⇒ <tt>String</tt> (readonly) </h3><div class="docstring"> <div class="discussion"> If a title is uninstallable, it will have a script in Jamf named 'xolo-<title>-uninstall' </div> </div> <div class="tags"> Returns: <ul class="return"> <li> (<tt>String</tt>) — <div class='inline'>the name of the script to uninstall the title</div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 284 285 286</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/title.rb', line 284 def jamf_uninstall_script_name @jamf_uninstall_script_name end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="new_data_for_update-instance_method"> #new_data_for_update ⇒ <tt>Hash</tt> (readonly) </h3><div class="docstring"> <div class="discussion"> 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 both for updating the title, and the versions </div> </div> <div class="tags"> Returns: <ul class="return"> <li> (<tt>Hash</tt>) — <div class='inline'>The new data to apply as an update</div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 313 314 315</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/title.rb', line 313 def new_data_for_update @new_data_for_update end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="releasing_version-instance_method"> #releasing_version ⇒ <tt>String</tt> </h3><div class="docstring"> <div class="discussion"> Returns If current action is :releasing, this is the version being released. </div> </div> <div class="tags"> Returns: <ul class="return"> <li> (<tt>String</tt>) — <div class='inline'>If current action is :releasing, this is the version being released</div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 340 341 342</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/title.rb', line 340 def releasing_version @releasing_version end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="server_app_instance-instance_method"> #server_app_instance ⇒ <tt><a href="App.html" title="Xolo::Server::App (class)">Xolo::Server::App</a></tt> </h3><div class="docstring"> <div class="discussion"> The instance of Xolo::Server::App that instantiated this title object. This is how we access things that are available in routes and helpers, like the single Jamf and TEd connections for this App instance. </div> </div> <div class="tags"> Returns: <ul class="return"> <li> (<tt><a href="App.html" title="Xolo::Server::App (class)">Xolo::Server::App</a></tt>) — <div class='inline'>our Sinatra server app</div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 305 306 307</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/title.rb', line 305 def server_app_instance @server_app_instance end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="ssvc_icon_id-instance_method"> #ssvc_icon_id ⇒ <tt>Integer</tt> </h3><div class="docstring"> <div class="discussion"> Returns The Jamf Pro ID for the self-service icon once it has been uploaded. </div> </div> <div class="tags"> Returns: <ul class="return"> <li> (<tt>Integer</tt>) — <div class='inline'>The Jamf Pro ID for the self-service icon once it has been uploaded</div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 332 333 334</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/title.rb', line 332 def ssvc_icon_id @ssvc_icon_id end</pre> </td> </tr> </table> </div> </div> <div id="class_method_details" class="method_details_list"> <h2>Class Method Details</h2> <div class="method_details first"> <h3 class="signature first" id="all_titles-class_method"> .all_titles ⇒ <tt>Array<String></tt> </h3><div class="docstring"> <div class="discussion"> Returns A list of all known titles, just the basenames of all the title_dirs. </div> </div> <div class="tags"> Returns: <ul class="return"> <li> (<tt>Array<String></tt>) — <div class='inline'>A list of all known titles, just the basenames of all the title_dirs</div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 137 138 139</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/title.rb', line 137 def self.all_titles title_dirs.map(&:basename).map(&:to_s) end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="in_ted?-class_method"> .in_ted?(title, cnx:) ⇒ <tt>Boolean</tt> </h3><div class="docstring"> <div class="discussion"> Does this title exist in the title editor. WARNING: Being in the title editor doesn't necessarily mean that this title is managed </div> </div> <div class="tags"> Parameters: <ul class="param"> <li> title (<tt>String</tt>) — <div class='inline'>the title we are looking for</div> </li> </ul> Returns: <ul class="return"> <li> (<tt>Boolean</tt>) — <div class='inline'>Does the given title exist in the Title Editor?</div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 211 212 213</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/title.rb', line 211 def self.in_ted?(title, cnx:) Windoo::SoftwareTitle.all_ids(cnx: cnx).include? title end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="load-class_method"> .load(title) ⇒ <tt><a href="" title="Xolo::Server::Title (class)">Xolo::Server::Title</a></tt> </h3><div class="docstring"> <div class="discussion"> Instantiate from the local JSON file containing the current values for the given title NOTE: All instantiation should happen using the #instantiate_title method in the server app instance, or related methods like all_title_objects. Please don't call this method directly </div> </div> <div class="tags"> Returns: <ul class="return"> <li> (<tt><a href="" title="Xolo::Server::Title (class)">Xolo::Server::Title</a></tt>) — <div class='inline'>load an existing title from the on-disk JSON file</div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 198 199 200 201</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/title.rb', line 198 def self.load(title) <a href="../../Xolo.html" title="Xolo (module)">Xolo</a>::<a href="../Server.html" title="Xolo::Server (module)">Server</a>.<a href="../Server.html#logger-class_method" title="Xolo::Server.logger (method)">logger</a>.debug "Loading title '#{title}' from file" new parse_json(title_data_file(title).read) end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="locked?-class_method"> .locked?(title) ⇒ <tt>Boolean</tt> </h3><div class="docstring"> <div class="discussion"> Is a title locked for updates? </div> </div> <div class="tags"> Returns: <ul class="return"> <li> (<tt>Boolean</tt>) </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 217 218 219 220</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/title.rb', line 217 def self.locked?(title) curr_lock = <a href="../../Xolo.html" title="Xolo (module)">Xolo</a>::<a href="../Server.html" title="Xolo::Server (module)">Server</a>.<a href="ObjectLocks.html#object_locks-instance_method" title="Xolo::Server::ObjectLocks#object_locks (method)">object_locks</a>.dig title, :expires curr_lock && curr_lock > Time.now end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="ssvc_icon_file-class_method"> .ssvc_icon_file(title) ⇒ <tt>Pathname</tt> </h3><div class="docstring"> <div class="discussion"> Returns The the local file containing the self-service icon. </div> </div> <div class="tags"> Returns: <ul class="return"> <li> (<tt>Pathname</tt>) — <div class='inline'>The the local file containing the self-service icon</div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 183 184 185</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/title.rb', line 183 def self.ssvc_icon_file(title) title_dir(title).children.select { |c| c.basename.to_s.start_with? <a href="#SELF_SERVICE_ICON_FILENAME-constant" title="Xolo::Server::Title::SELF_SERVICE_ICON_FILENAME (constant)">SELF_SERVICE_ICON_FILENAME</a> }.first end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="title_data_file-class_method"> .title_data_file(title) ⇒ <tt>Pathname</tt> </h3><div class="docstring"> <div class="discussion"> The the local JSON file containing the current values for the given title </div> </div> <div class="tags"> Returns: <ul class="return"> <li> (<tt>Pathname</tt>) </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 159 160 161</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/title.rb', line 159 def self.title_data_file(title) title_dir(title) + "#{title}.json" end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="title_dir-class_method"> .title_dir(title) ⇒ <tt>Pathname</tt> </h3><div class="docstring"> <div class="discussion"> The title dir for a given title on the server, which may or may not exist. </div> </div> <div class="tags"> Returns: <ul class="return"> <li> (<tt>Pathname</tt>) </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 148 149 150</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/title.rb', line 148 def self.title_dir(title) <a href="#TITLES_DIR-constant" title="Xolo::Server::Title::TITLES_DIR (constant)">TITLES_DIR</a> + title end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="title_dirs-class_method"> .title_dirs ⇒ <tt>Array<Pathname></tt> </h3><div class="docstring"> <div class="discussion"> Returns A list of all known title dirs. </div> </div> <div class="tags"> Returns: <ul class="return"> <li> (<tt>Array<Pathname></tt>) — <div class='inline'>A list of all known title dirs</div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 130 131 132</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/title.rb', line 130 def self.title_dirs <a href="#TITLES_DIR-constant" title="Xolo::Server::Title::TITLES_DIR (constant)">TITLES_DIR</a>.children end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="uninstall_script_file-class_method"> .uninstall_script_file(title) ⇒ <tt>Pathname</tt> </h3><div class="docstring"> <div class="discussion"> Returns The the local file containing the code of the version script. </div> </div> <div class="tags"> Returns: <ul class="return"> <li> (<tt>Pathname</tt>) — <div class='inline'>The the local file containing the code of the version script</div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 175 176 177</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/title.rb', line 175 def self.uninstall_script_file(title) title_dir(title) + <a href="#UNINSTALL_SCRIPT_FILENAME-constant" title="Xolo::Server::Title::UNINSTALL_SCRIPT_FILENAME (constant)">UNINSTALL_SCRIPT_FILENAME</a> end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="version_script_file-class_method"> .version_script_file(title) ⇒ <tt>Pathname</tt> </h3><div class="docstring"> <div class="discussion"> Returns The the local file containing the code of the version script. </div> </div> <div class="tags"> Returns: <ul class="return"> <li> (<tt>Pathname</tt>) — <div class='inline'>The the local file containing the code of the version script</div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 167 168 169</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/title.rb', line 167 def self.version_script_file(title) title_dir(title) + <a href="#VERSION_SCRIPT_FILENAME-constant" title="Xolo::Server::Title::VERSION_SCRIPT_FILENAME (constant)">VERSION_SCRIPT_FILENAME</a> end</pre> </td> </tr> </table> </div> </div> <div id="instance_method_details" class="method_details_list"> <h2>Instance Method Details</h2> <div class="method_details first"> <h3 class="signature first" id="admin-instance_method"> #admin ⇒ <tt>String</tt> </h3><div class="docstring"> <div class="discussion"> This can be manually set earlier in the request handling to use a non-standard admin username </div> </div> <div class="tags"> Returns: <ul class="return"> <li> (<tt>String</tt>) </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 398 399 400</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/title.rb', line 398 def admin @admin ||= session[:admin] end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="autopkg_enabled?-instance_method"> #autopkg_enabled? ⇒ <tt>Boolean</tt> </h3><div class="docstring"> <div class="discussion"> 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. </div> </div> <div class="tags"> Returns: <ul class="return"> <li> (<tt>Boolean</tt>) </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 864 865 866 867 868 869 870</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/title.rb', line 864 def autopkg_enabled? return @autopkg_enabled if defined?(@autopkg_enabled) @autopkg_enabled = server_app_instance.autopkg_enabled? && \ autopkg_recipe && \ autopkg_dir end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="create-instance_method"> #create ⇒ <tt>void</tt> </h3><div class="docstring"> <div class="discussion"> This method returns an undefined value.Save a new title, adding to the local filesystem, Jamf Pro, and the Title Editor as needed </div> </div> <div class="tags"> </div><table class="source_code"> <tr> <td> <pre class="lines"> 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/title.rb', line 661 def create lock @current_action = :creating self.creation_date = Time.now 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 # add some data 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 <a href="../../Xolo.html" title="Xolo (module)">Xolo</a>::<a href="../Server.html" title="Xolo::Server (module)">Server</a>::<a href="Version.html" title="Xolo::Server::Version (class)">Version</a>.<a href="Version.html#add_version_via_subscription-class_method" title="Xolo::Server::Version.add_version_via_subscription (method)">add_version_via_subscription</a>( 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 unlock end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="creating?-instance_method"> #creating? ⇒ <tt>Boolean</tt> </h3><div class="docstring"> <div class="discussion"> Returns Are we creating this title?. </div> </div> <div class="tags"> Returns: <ul class="return"> <li> (<tt>Boolean</tt>) — <div class='inline'>Are we creating this title?</div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 404 405 406</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/title.rb', line 404 def creating? current_action == :creating end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="delete-instance_method"> #delete ⇒ <tt>void</tt> </h3><div class="docstring"> <div class="discussion"> This method returns an undefined value.Delete the title and all of its version </div> </div> <div class="tags"> </div><table class="source_code"> <tr> <td> <pre class="lines"> 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/title.rb', line 931 def delete lock @current_action = :deleting progress "Deleting all versions of #{title}...", log: :debug # Delete them in reverse order (oldest first) so the jamf server doesn't # see each older version as being 'released' again as newer # ones are deleted. 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, deleting_title: true end delete_title_from_ted unless subscribed? delete_title_from_jamf delete_changelog progress "Deleting Xolo server data for title '#{title}'", log: :info title_dir.rmtree server_app_instance.update_client_data ensure unlock end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="delete_version_script_file-instance_method"> #delete_version_script_file ⇒ <tt>void</tt> </h3><div class="docstring"> <div class="discussion"> This method returns an undefined value.Delete the version script file </div> </div> <div class="tags"> </div><table class="source_code"> <tr> <td> <pre class="lines"> 920 921 922 923 924 925 926</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/title.rb', line 920 def delete_version_script_file return unless version_script_file.file? log_debug "Deleting version script file: #{version_script_file}" version_script_file.delete end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="deleting?-instance_method"> #deleting? ⇒ <tt>Boolean</tt> </h3><div class="docstring"> <div class="discussion"> Returns Are we deleting this title?. </div> </div> <div class="tags"> Returns: <ul class="return"> <li> (<tt>Boolean</tt>) — <div class='inline'>Are we deleting this title?</div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 422 423 424</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/title.rb', line 422 def deleting? current_action == :deleting end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="deprecate_or_skip_version-instance_method"> #deprecate_or_skip_version(vobj) ⇒ <tt>void</tt> </h3><div class="docstring"> <div class="discussion"> This method returns an undefined value.Deprecate or skip a version </div> </div> <div class="tags"> Parameters: <ul class="param"> <li> vobj (<tt><a href="Version.html" title="Xolo::Server::Version (class)">Xolo::Server::Version</a></tt>) — <div class='inline'>the version object to be deprecated or skipped</div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 1065 1066 1067 1068 1069 1070 1071 1072 1073</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/title.rb', line 1065 def deprecate_or_skip_version(vobj) # don't do anything if the status is already deprecated or skipped # but if its released, we need to deprecate it vobj.deprecate if vobj.status == <a href="../../Xolo.html" title="Xolo (module)">Xolo</a>::<a href="../Server.html" title="Xolo::Server (module)">Server</a>::<a href="Version.html" title="Xolo::Server::Version (class)">Version</a>::STATUS_RELEASED # and skip it if its in pilot vobj.skip if vobj.status == <a href="../../Xolo.html" title="Xolo (module)">Xolo</a>::<a href="../Server.html" title="Xolo::Server (module)">Server</a>::<a href="Version.html" title="Xolo::Server::Version (class)">Version</a>::STATUS_PILOT end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="generate_uninstall_script-instance_method"> #generate_uninstall_script(script_or_pkg_ids) ⇒ <tt>String</tt>, <tt>Array</tt> </h3><div class="docstring"> <div class="discussion"> Returns The uninstall script, provided or generated from the given pkg ids. </div> </div> <div class="tags"> Parameters: <ul class="param"> <li> script_or_pkg_ids (<tt>String</tt>) — <div class='inline'>The new uninstall script, or comma-separated list of pkg IDs</div> </li> </ul> Returns: <ul class="return"> <li> (<tt>String</tt>, <tt>Array</tt>) — <div class='inline'>The uninstall script, provided or generated from the given pkg ids</div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 580 581 582 583 584 585</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/title.rb', line 580 def generate_uninstall_script(script_or_pkg_ids) # Its already a script, validated by xadm to start with #! return script_or_pkg_ids if script_or_pkg_ids.is_a? String uninstall_script_template.sub 'PKG_IDS_FROM_XOLO_GO_HERE', script_or_pkg_ids.join(' ') end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="jamf_cnx-instance_method"> #jamf_cnx(refresh: false) ⇒ <tt>Jamf::Connection</tt> </h3><div class="docstring"> <div class="discussion"> Returns a single Jamf Pro API connection to use for the life of this instance. </div> </div> <div class="tags"> Returns: <ul class="return"> <li> (<tt>Jamf::Connection</tt>) — <div class='inline'>a single Jamf Pro API connection to use for the life of this instance</div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 472 473 474</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/title.rb', line 472 def jamf_cnx(refresh: false) server_app_instance.jamf_cnx refresh: refresh end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="jamf_patch_title_id-instance_method"> #jamf_patch_title_id ⇒ <tt>Object</tt> </h3><div class="docstring"> <div class="discussion"> TODO: Remove this when everything has been repaired for v2 and all json files know this value </div> </div> <div class="tags"> </div><table class="source_code"> <tr> <td> <pre class="lines"> 435 436 437 438 439 440 441 442 443 444 445 446</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/title.rb', line 435 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</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="lock-instance_method"> #lock ⇒ <tt>Object</tt> </h3><div class="docstring"> <div class="discussion"> Lock this title for updates </div> </div> <div class="tags"> Raises: <ul class="raise"> <li> (<tt>Xolo::ServerError</tt>) </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/title.rb', line 1154 def lock raise <a href="../../Xolo.html" title="Xolo (module)">Xolo</a>::ServerError, 'Server is shutting down' if <a href="../../Xolo.html" title="Xolo (module)">Xolo</a>::<a href="../Server.html" title="Xolo::Server (module)">Server</a>.<a href="../Server.html#shutting_down%3F-class_method" title="Xolo::Server.shutting_down? (method)">shutting_down?</a> while locked? log_debug "Waiting for update lock on title '#{title}'..." if (Time.now.to_i % 5).zero? sleep 0.33 end <a href="../../Xolo.html" title="Xolo (module)">Xolo</a>::<a href="../Server.html" title="Xolo::Server (module)">Server</a>.<a href="ObjectLocks.html#object_locks-instance_method" title="Xolo::Server::ObjectLocks#object_locks (method)">object_locks</a>[title] ||= { versions: {} } exp = Time.now + <a href="../../Xolo.html" title="Xolo (module)">Xolo</a>::<a href="../Server.html" title="Xolo::Server (module)">Server</a>::<a href="ObjectLocks.html" title="Xolo::Server::ObjectLocks (module)">ObjectLocks</a>::<a href="ObjectLocks.html#OBJECT_LOCK_LIMIT-constant" title="Xolo::Server::ObjectLocks::OBJECT_LOCK_LIMIT (constant)">OBJECT_LOCK_LIMIT</a> <a href="../../Xolo.html" title="Xolo (module)">Xolo</a>::<a href="../Server.html" title="Xolo::Server (module)">Server</a>.<a href="ObjectLocks.html#object_locks-instance_method" title="Xolo::Server::ObjectLocks#object_locks (method)">object_locks</a>[title][:expires] = exp log_debug "Locked title '#{title}' for updates until #{exp}, by method #{caller_locations.first.label}" end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="locked?-instance_method"> #locked? ⇒ <tt>Boolean</tt> </h3><div class="docstring"> <div class="discussion"> Is this title locked for updates? </div> </div> <div class="tags"> Returns: <ul class="return"> <li> (<tt>Boolean</tt>) </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 1148 1149 1150</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/title.rb', line 1148 def locked? self.class.locked?(title) end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="patch_report_rsrc-instance_method"> #patch_report_rsrc ⇒ <tt>String</tt> </h3><div class="docstring"> <div class="discussion"> Returns The URL path for the patch report for this title. </div> </div> <div class="tags"> Returns: <ul class="return"> <li> (<tt>String</tt>) — <div class='inline'>The URL path for the patch report for this title</div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 652 653 654</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/title.rb', line 652 def patch_report_rsrc @patch_report_rsrc ||= "#{<a href="#JPAPI_PATCH_TITLE_RSRC-constant" title="Xolo::Server::Title::JPAPI_PATCH_TITLE_RSRC (constant)">JPAPI_PATCH_TITLE_RSRC</a>}/#{jamf_patch_title_id}/#{<a href="#JPAPI_PATCH_REPORT_RSRC-constant" title="Xolo::Server::Title::JPAPI_PATCH_REPORT_RSRC (constant)">JPAPI_PATCH_REPORT_RSRC</a>}" end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="prepend_version-instance_method"> #prepend_version(version) ⇒ <tt>void</tt> </h3><div class="docstring"> <div class="discussion"> This method returns an undefined value.prepend a new version to the version_order </div> </div> <div class="tags"> Parameters: <ul class="param"> <li> version (<tt>String</tt>) — <div class='inline'>the version to prepend</div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 605 606 607 608</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/title.rb', line 605 def prepend_version(version) version_order.unshift version save_local_data end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="progress-instance_method"> #progress(msg, log: :debug, alert: false) ⇒ <tt>void</tt> </h3><div class="docstring"> <div class="discussion"> This method returns an undefined value.Append a message to the progress stream file, optionally sending it also to the log </div> </div> <div class="tags"> Parameters: <ul class="param"> <li> message (<tt>String</tt>) — <div class='inline'>the message to append</div> </li> <li> log (<tt>Symbol</tt>) (defaults to: <tt>:debug</tt>) — <div class='inline'>the level at which to log the message one of :debug, :info, :warn, :error, :fatal, or :unknown. Default is nil, which doesn't log the message at all.</div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 458 459 460</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/title.rb', line 458 def progress(msg, log: :debug, alert: false) server_app_instance.progress msg, log: log, alert: alert end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="release-instance_method"> #release(version_to_release) ⇒ <tt>void</tt> </h3><div class="docstring"> <div class="discussion"> This method returns an undefined value.Release a version of this title </div> </div> <div class="tags"> Parameters: <ul class="param"> <li> version_to_release (<tt>String</tt>) — <div class='inline'>the version to release</div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/title.rb', line 964 def release(version_to_release) lock @current_action = :releasing @releasing_version = version_to_release validate_release(version_to_release) progress "Releasing version #{version_to_release} of title '#{title}'", log: :info update_versions_for_release version_to_release # update the title self.released_version = version_to_release save_local_data server_app_instance.update_client_data ensure unlock end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="release_version-instance_method"> #release_version(vobj, rollback:) ⇒ <tt>void</tt> </h3><div class="docstring"> <div class="discussion"> This method returns an undefined value.release a specific version </div> </div> <div class="tags"> Parameters: <ul class="param"> <li> vobj (<tt><a href="Version.html" title="Xolo::Server::Version (class)">Xolo::Server::Version</a></tt>) — <div class='inline'>the version object to be released</div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/title.rb', line 1042 def release_version(vobj, rollback:) vobj.release rollback: rollback # update the jamf_manual_install_released_policy to install this version msg = "Jamf: Setting policy #{jamf_manual_install_released_policy_name} to install the package for version '#{vobj.version}'" progress msg, log: :info pol = jamf_manual_install_released_policy 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</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="releasing?-instance_method"> #releasing? ⇒ <tt>Boolean</tt> </h3><div class="docstring"> <div class="discussion"> Returns Are we releasing a version this title?. </div> </div> <div class="tags"> Returns: <ul class="return"> <li> (<tt>Boolean</tt>) — <div class='inline'>Are we releasing a version this title?</div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 428 429 430</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/title.rb', line 428 def releasing? current_action == :releasing end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="remove_version-instance_method"> #remove_version(version) ⇒ <tt>void</tt> </h3><div class="docstring"> <div class="discussion"> This method returns an undefined value.remove a version from the version_order </div> </div> <div class="tags"> Parameters: <ul class="param"> <li> version (<tt>String</tt>) — <div class='inline'>the version to remove</div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 616 617 618 619 620 621 622</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/title.rb', line 616 def remove_version(version) lock version_order.delete version save_local_data ensure unlock end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="repair-instance_method"> #repair(repair_versions: false) ⇒ <tt>void</tt> </h3><div class="docstring"> <div class="discussion"> This method returns an undefined value.Repair this title, and optionally all of its versions. Look at the Title Editor title object, and ensure it's correct based on the local data file. <ul> <li>display name</li> <li>publisher</li> <li>EA or app-data <ul> <li>ea name 'xolo-<title>'</li> </ul> </li> <li>requirement criteria</li> <li>stub version if needed</li> <li>enabled</li> </ul> Then look at the various Jamf objects pertaining to this title, and ensure they are correct <ul> <li>Accept Patch EA</li> <li>title-installed smart group 'xolo-<title>-installed'</li> <li>frozen static group 'xolo-<title>-frozen'</li> <li>manual/SSvc install-current-release policy 'xolo-<title>-install' <ul> <li>trigger 'xolo-<title>-install'</li> <li>ssvc icon</li> <li>ssvc category</li> <li>description</li> </ul> </li> <li>if uninstallable <ul> <li>uninstall script 'xolo-<title>-uninstall'</li> <li>uninstall policy 'xolo-<title>-uninstall'</li> <li>if expirable <ul> <li>expire policy 'xolo-<title>-expire' <ul> <li>trigger 'xolo-<title>-expire'</li> </ul> </li> </ul> </li> </ul> </li> </ul> </div> </div> <div class="tags"> Parameters: <ul class="param"> <li> repair_versions (<tt>Boolean</tt>) (defaults to: <tt>false</tt>) — <div class='inline'>run the repair method on all versions?</div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/title.rb', line 1123 def repair(repair_versions: false) lock @current_action = :repairing chg_log_msg = repair_versions ? 'Repairing title and all versions' : 'Repairing title only' log_change msg: chg_log_msg progress "Starting repair of title '#{title}'" repair_ted_title set_subscribed_display_name_and_publisher 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</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="repairing?-instance_method"> #repairing? ⇒ <tt>Boolean</tt> </h3><div class="docstring"> <div class="discussion"> Returns Are we repairing this title?. </div> </div> <div class="tags"> Returns: <ul class="return"> <li> (<tt>Boolean</tt>) — <div class='inline'>Are we repairing this title?</div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 416 417 418</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/title.rb', line 416 def repairing? current_action == :repairing end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="reset_version_to_pilot-instance_method"> #reset_version_to_pilot(vobj) ⇒ <tt>void</tt> </h3><div class="docstring"> <div class="discussion"> This method returns an undefined value.reset a version to pilot status, this happens when rolling back (releasing a version older than the current release) </div> </div> <div class="tags"> Parameters: <ul class="param"> <li> vobj (<tt><a href="Version.html" title="Xolo::Server::Version (class)">Xolo::Server::Version</a></tt>) — <div class='inline'>the version object to be deprecated or skipped</div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/title.rb', line 1080 def reset_version_to_pilot(vobj) # do nothing if its in pilot return if vobj.status == <a href="../../Xolo.html" title="Xolo (module)">Xolo</a>::<a href="../Server.html" title="Xolo::Server (module)">Server</a>::<a href="Version.html" title="Xolo::Server::Version (class)">Version</a>::STATUS_PILOT # this should be redundant with the above? return unless rollback # if we're here, we're rolling back to something older than this # version, and this version is currently released, deprecated or skipped. # We need to reset it to pilot. vobj.reset_to_pilot end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="save_local_data-instance_method"> #save_local_data ⇒ <tt>void</tt> </h3><div class="docstring"> <div class="discussion"> This method returns an undefined value.Save our current data out to our JSON data file This overwrites the existing data. </div> </div> <div class="tags"> </div><table class="source_code"> <tr> <td> <pre class="lines"> 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/title.rb', line 795 def save_local_data # If we don't have a patch source id yet, get it now self.jamf_patch_source_id ||= <a href="../../Jamf.html" title="Jamf (module)">Jamf</a>::PatchSource.valid_id(patch_source, cnx: jamf_cnx) if patch_source # create the dirs for the title title_dir.mkpath vdir = title_dir + <a href="../../Xolo.html" title="Xolo (module)">Xolo</a>::<a href="../Server.html" title="Xolo::Server (module)">Server</a>::<a href="Version.html" title="Xolo::Server::Version (class)">Version</a>::<a href="Version.html#VERSIONS_DIRNAME-constant" title="Xolo::Server::Version::VERSIONS_DIRNAME (constant)">VERSIONS_DIRNAME</a> vdir.mkpath save_version_script save_uninstall_script self.modification_date = Time.now self.modified_by = admin log_debug "Title '#{title}' noting modification by #{modified_by}" # do we have a stored self service icon? self.self_service_icon = ssvc_icon_file ? <a href="../../Xolo.html" title="Xolo (module)">Xolo</a>::ITEM_UPLOADED : nil log_debug "Saving local title data to: #{title_data_file}" title_data_file.pix_atomic_write to_json end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="save_ssvc_icon-instance_method"> #save_ssvc_icon(tempfile, orig_filename) ⇒ <tt>void</tt> </h3><div class="docstring"> <div class="discussion"> This method returns an undefined value.Save the self_service_icon from the upload tmpfile to the file in the data dir. This is run by the upload route, not the create or update methods here. xadm does the upload after creating or updating the title </div> </div> <div class="tags"> Parameters: <ul class="param"> <li> tempfile (<tt>Pathname</tt>) — <div class='inline'>The path to the uploaded tmp file</div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/title.rb', line 891 def save_ssvc_icon(tempfile, orig_filename) lock # here's where we'll store it on the server ext_for_file = orig_filename.split(<a href="../../Xolo.html" title="Xolo (module)">Xolo</a>::DOT).last new_basename = "#{<a href="#SELF_SERVICE_ICON_FILENAME-constant" title="Xolo::Server::Title::SELF_SERVICE_ICON_FILENAME (constant)">SELF_SERVICE_ICON_FILENAME</a>}.#{ext_for_file}" new_icon_file = title_dir + new_basename # delete any previous icon files existing_icon_file = ssvc_icon_file if existing_icon_file&.file? log_debug "Deleting older icon file: #{existing_icon_file.basename}" existing_icon_file.delete end log_debug "Saving self_service_icon '#{orig_filename}' to: #{new_basename}" tempfile.rename new_icon_file # the json file only stores 'uploaded' in the self_service_icon # attr. self.self_service_icon = <a href="../../Xolo.html" title="Xolo (module)">Xolo</a>::ITEM_UPLOADED save_local_data ensure unlock end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="save_uninstall_script-instance_method"> #save_uninstall_script ⇒ <tt>void</tt> </h3><div class="docstring"> <div class="discussion"> This method returns an undefined value.Save our current uninstall script out to our local file. This won't delete the script if it's being removed, that happens elsewhere. This overwrites the existing data. </div> </div> <div class="tags"> </div><table class="source_code"> <tr> <td> <pre class="lines"> 849 850 851 852 853 854 855 856 857 858 859</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/title.rb', line 849 def save_uninstall_script return if uninstall_script == <a href="../../Xolo.html" title="Xolo (module)">Xolo</a>::ITEM_UPLOADED || uninstall_ids == <a href="../../Xolo.html" title="Xolo (module)">Xolo</a>::ITEM_UPLOADED return if uninstall_script_contents.nil? log_debug "Saving uninstall script to: #{uninstall_script_file}" uninstall_script_file.pix_atomic_write uninstall_script_contents # the json file only stores 'uploaded' in uninstall_script # The actual script is saved in its own file. self.uninstall_script &&= <a href="../../Xolo.html" title="Xolo (module)">Xolo</a>::ITEM_UPLOADED end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="save_version_script-instance_method"> #save_version_script ⇒ <tt>void</tt> </h3><div class="docstring"> <div class="discussion"> This method returns an undefined value.Save our current version script out to our local file, but only if we aren't using app_name and app_bundle_id and only if it's changed This won't delete the script if it's being removed, that happens elsewhere. This overwrites the existing data. </div> </div> <div class="tags"> </div><table class="source_code"> <tr> <td> <pre class="lines"> 829 830 831 832 833 834 835 836 837 838</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/title.rb', line 829 def save_version_script return if app_name || app_bundle_id return if version_script_contents.nil? log_debug "Saving version_script to: #{version_script_file}" version_script_file.pix_atomic_write version_script_contents # the json file only stores 'uploaded' in the version_script attr. self.version_script = <a href="../../Xolo.html" title="Xolo (module)">Xolo</a>::ITEM_UPLOADED end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="session-instance_method"> #session ⇒ <tt>Hash</tt> </h3><div class="docstring"> <div class="discussion"> </div> </div> <div class="tags"> Returns: <ul class="return"> <li> (<tt>Hash</tt>) </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 389 390 391 392</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/title.rb', line 389 def session server_app_instance&.session || {} # @session ||= {} end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="ssvc_icon_file-instance_method"> #ssvc_icon_file ⇒ <tt>Pathname</tt> </h3><div class="docstring"> <div class="discussion"> Returns The the local file containing the self-service icon. </div> </div> <div class="tags"> Returns: <ul class="return"> <li> (<tt>Pathname</tt>) — <div class='inline'>The the local file containing the self-service icon</div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 492 493 494</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/title.rb', line 492 def ssvc_icon_file @ssvc_icon_file ||= self.class.ssvc_icon_file title end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="ted_cnx-instance_method"> #ted_cnx ⇒ <tt>Windoo::Connection</tt> </h3><div class="docstring"> <div class="discussion"> Returns a single Title Editor connection to use for the life of this instance. </div> </div> <div class="tags"> Returns: <ul class="return"> <li> (<tt>Windoo::Connection</tt>) — <div class='inline'>a single Title Editor connection to use for the life of this instance</div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 465 466 467</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/title.rb', line 465 def ted_cnx server_app_instance.ted_cnx end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="title_data_file-instance_method"> #title_data_file ⇒ <tt>Pathname</tt> </h3><div class="docstring"> <div class="discussion"> The title data file for this title on the server </div> </div> <div class="tags"> Returns: <ul class="return"> <li> (<tt>Pathname</tt>) </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 486 487 488</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/title.rb', line 486 def title_data_file @title_data_file ||= self.class.title_data_file title end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="title_dir-instance_method"> #title_dir ⇒ <tt>Pathname</tt> </h3><div class="docstring"> <div class="discussion"> The title dir for this title on the server </div> </div> <div class="tags"> Returns: <ul class="return"> <li> (<tt>Pathname</tt>) </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 479 480 481</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/title.rb', line 479 def title_dir @title_dir ||= self.class.title_dir title end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="to_h-instance_method"> #to_h ⇒ <tt>Object</tt> </h3><div class="docstring"> <div class="discussion"> Add more server-specific data to our hash </div> </div> <div class="tags"> </div><table class="source_code"> <tr> <td> <pre class="lines"> 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/title.rb', line 1180 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</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="uninstall_script_contents-instance_method"> #uninstall_script_contents ⇒ <tt>String</tt> </h3><div class="docstring"> <div class="discussion"> The code of the uninstall_script , if any, considering the new data of any changes being made Returns nil if there is no uninstall_script, or if we are in the process of deleting it. </div> </div> <div class="tags"> Returns: <ul class="return"> <li> (<tt>String</tt>) — <div class='inline'>The string contents of the uninstall_script, if any</div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/title.rb', line 549 def uninstall_script_contents return @uninstall_script_contents if defined? @uninstall_script_contents # use any new/incoming value if we have any # this might still be nil or an empty array if we are removing uninstallability curr_script = changes_for_update.dig(:uninstall_script, :new) || changes_for_update.dig(:uninstall_ids, :new) curr_script = nil if curr_script.pix_empty? # otherwise use the existing value curr_script ||= uninstall_script || uninstall_ids # now get the actual script @uninstall_script_contents = if curr_script.pix_empty? # removing uninstallability, or it was never added nil elsif curr_script == <a href="../../Xolo.html" title="Xolo (module)">Xolo</a>::ITEM_UPLOADED # nothing changed, use the one we have saved on disk uninstall_script_file.read else # this will be a new one from the changes_for_update generate_uninstall_script curr_script end # log_debug "Uninstall script contents: #{@uninstall_script_contents}" @uninstall_script_contents end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="uninstall_script_file-instance_method"> #uninstall_script_file ⇒ <tt>Pathname</tt> </h3><div class="docstring"> <div class="discussion"> Returns The the local file containing the code of the uninstall script. </div> </div> <div class="tags"> Returns: <ul class="return"> <li> (<tt>Pathname</tt>) — <div class='inline'>The the local file containing the code of the uninstall script</div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 537 538 539</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/title.rb', line 537 def uninstall_script_file @uninstall_script_file ||= self.class.uninstall_script_file title end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="uninstall_script_template-instance_method"> #uninstall_script_template ⇒ <tt>String</tt> </h3><div class="docstring"> <div class="discussion"> Returns The template zsh script for uninstalling via pkgutil. </div> </div> <div class="tags"> Returns: <ul class="return"> <li> (<tt>String</tt>) — <div class='inline'>The template zsh script for uninstalling via pkgutil</div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 589 590 591 592 593 594 595 596 597</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/title.rb', line 589 def uninstall_script_template # parent 1 = server # parent 2 = xolo # parent 3 = lib # parent 4 = xolo gem data_dir = Pathname.new(__FILE__).parent.parent.parent.parent + 'data' template_file = data_dir + 'uninstall-pkgs-by-id.zsh' template_file.read end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="uninstallable?-instance_method"> #uninstallable? ⇒ <tt>Boolean</tt> </h3><div class="docstring"> <div class="discussion"> are we uninstallable? </div> </div> <div class="tags"> Returns: <ul class="return"> <li> (<tt>Boolean</tt>) </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 876 877 878</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/title.rb', line 876 def uninstallable? uninstall_script || !uninstall_ids.pix_empty? end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="unlock-instance_method"> #unlock ⇒ <tt>Object</tt> </h3><div class="docstring"> <div class="discussion"> Unlock this v for updates </div> </div> <div class="tags"> </div><table class="source_code"> <tr> <td> <pre class="lines"> 1170 1171 1172 1173 1174 1175 1176</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/title.rb', line 1170 def unlock curr_lock = <a href="../../Xolo.html" title="Xolo (module)">Xolo</a>::<a href="../Server.html" title="Xolo::Server (module)">Server</a>.<a href="ObjectLocks.html#object_locks-instance_method" title="Xolo::Server::ObjectLocks#object_locks (method)">object_locks</a>.dig title, :expires return unless curr_lock <a href="../../Xolo.html" title="Xolo (module)">Xolo</a>::<a href="../Server.html" title="Xolo::Server (module)">Server</a>.<a href="ObjectLocks.html#object_locks-instance_method" title="Xolo::Server::ObjectLocks#object_locks (method)">object_locks</a>[title].delete :expires log_debug "Unlocked title '#{title}' for updates" end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="update-instance_method"> #update(new_data) ⇒ <tt>void</tt> </h3><div class="docstring"> <div class="discussion"> This method returns an undefined value.Update this title, updating to the local filesystem, Jamf Pro, and the Title Editor, and applying any changes to existing versions as needed. </div> </div> <div class="tags"> Parameters: <ul class="param"> <li> new_data (<tt>Hash</tt>) — <div class='inline'>The new data sent from xadm</div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/title.rb', line 713 def update(new_data) lock @current_action = :updating @new_data_for_update = new_data @changes_for_update = note_changes_for_update_and_log if @changes_for_update.pix_empty? progress 'No changes to make', log: :info return end log_info "Updating title '#{title}' for admin '#{admin}'" log_debug "Updating title with these changes: #{changes_for_update}" # changelog - log the changes now, and # if there is an error, we'll log that too # saying the above changes were not completed and to # look at the server log for details. log_update_changes # Do ted before doing things in Jamf update_title_in_ted update_title_in_jamf update_local_instance_values save_local_data # if we already have a version script, and it hasn't changed, the new data should # contain Xolo::ITEM_UPLOADED. If its nil, we shouldn't # have one at all and should remove the old one if its there delete_version_script_file unless new_data_for_update[:version_script] # Do This at the end - after all the versions/patches have been updated. # Jamf won't see the need for re-acceptance until after the title # (and at least one patch) have been re-enabled. accept_jamf_patch_ea if need_to_accept_jamf_patch_ea? # 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." # re-raise for proper error handling in the server app raise ensure unlock end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="update_local_instance_values-instance_method"> #update_local_instance_values ⇒ <tt>void</tt> </h3><div class="docstring"> <div class="discussion"> This method returns an undefined value.Update our instance attributes with any new data before saving the changes back out to the file system </div> </div> <div class="tags"> </div><table class="source_code"> <tr> <td> <pre class="lines"> 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/title.rb', line 767 def update_local_instance_values # update instance data with new data before writing out to the filesystem. # Do this last so that the instance values can be compared to # new_data_for_update in the steps above. # Also, those steps might have updated some server-specific attributes # which will be saved to the file system as well. ATTRIBUTES.each do |attr, deets| # make sure these are updated elsewhere if needed, # e.g. modification data. next if deets[:read_only] next unless deets[:cli] new_val = new_data_for_update[attr] old_val = send(attr) next if new_val == old_val log_debug "Updating Xolo Title attribute '#{attr}': '#{old_val}' -> '#{new_val}'" send "#{attr}=", new_val end # update any other server-specific attributes here... end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="update_versions_for_release-instance_method"> #update_versions_for_release(version_to_release) ⇒ <tt>void</tt> </h3><div class="docstring"> <div class="discussion"> This method returns an undefined value.Update all versions when releasing one </div> </div> <div class="tags"> Parameters: <ul class="param"> <li> version_to_release (<tt>String</tt>) — <div class='inline'>the version to release</div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/title.rb', line 1008 def update_versions_for_release(version_to_release) # get the Version objects and figure out our starting point, but process # them in reverse order so that we don't have two released versions at once all_versions = version_objects.reverse vobj_to_release = all_versions.find { |v| v.version == version_to_release } vobj_current_release = all_versions.find { |v| v.version == released_version } rollback = vobj_current_release && vobj_to_release < vobj_current_release progress "Rolling back from version #{released_version}", log: :info if rollback all_versions.each do |vobj| # This is the one we are releasing if vobj == vobj_to_release release_version(vobj, rollback: rollback) # This one is older than the one we're releasing # so its either deprecated or skipped elsif vobj < vobj_to_release deprecate_or_skip_version(vobj) # this one is newer than the one we're releasing # revert to pilot if appropriate else reset_version_to_pilot(vobj) end # if vobj == vobj_to_release end # all_versions.each end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="updating?-instance_method"> #updating? ⇒ <tt>Boolean</tt> </h3><div class="docstring"> <div class="discussion"> Returns Are we updating this title?. </div> </div> <div class="tags"> Returns: <ul class="return"> <li> (<tt>Boolean</tt>) — <div class='inline'>Are we updating this title?</div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 410 411 412</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/title.rb', line 410 def updating? current_action == :updating end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="validate_release-instance_method"> #validate_release(version_to_release) ⇒ <tt>void</tt> </h3><div class="docstring"> <div class="discussion"> This method returns an undefined value.are we OK releasing a given version? </div> </div> <div class="tags"> Raises: <ul class="raise"> <li> (<tt>Xolo::TooSoonError</tt>) </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/title.rb', line 986 def validate_release(version_to_release) if released_version == version_to_release raise <a href="../../Xolo.html" title="Xolo (module)">Xolo</a>::InvalidDataError, "Version '#{version_to_release}' of title '#{title}' is already released" end unless versions.include? version_to_release raise <a href="../../Xolo.html" title="Xolo (module)">Xolo</a>::NoSuchItemError, "No version '#{version_to_release}' for title '#{title}'" end jamf_patch_title(refresh: true) return if jamf_patch_title.versions.key?(version_to_release) raise <a href="../../Xolo.html" title="Xolo (module)">Xolo</a>::TooSoonError, "Version '#{version_to_release}' of title '#{title}' is not yet visible to Jamf Pro. Please wait at least 10 minutes after adding it before releasing it. An alert notification will be sent when it is ready." end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="version_object-instance_method"> #version_object(version) ⇒ <tt><a href="Version.html" title="Xolo::Server::Version (class)">Xolo::Server::Version</a></tt> </h3><div class="docstring"> <div class="discussion"> instantiate a version if this title </div> </div> <div class="tags"> Returns: <ul class="return"> <li> (<tt><a href="Version.html" title="Xolo::Server::Version (class)">Xolo::Server::Version</a></tt>) </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 628 629 630 631</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/title.rb', line 628 def version_object(version) log_debug "Instantiating version #{version} from Title instance #{title}" server_app_instance.instantiate_version(title: self, version: version) end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="version_objects-instance_method"> #version_objects(refresh: false) ⇒ <tt>Array<<a href="Version.html" title="Xolo::Server::Version (class)">Xolo::Server::Version</a>></tt> </h3><div class="docstring"> <div class="discussion"> Returns An array of all current version objects NOTE: This might not be wise if hundreds of versions, but automated maintenance should help with that. </div> </div> <div class="tags"> Returns: <ul class="return"> <li> (<tt>Array<<a href="Version.html" title="Xolo::Server::Version (class)">Xolo::Server::Version</a>></tt>) — <div class='inline'>An array of all current version objects NOTE: This might not be wise if hundreds of versions, but automated maintenance should help with that.</div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 637 638 639 640 641 642 643 644 645 646 647 648</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/title.rb', line 637 def version_objects(refresh: false) @version_objects = nil if refresh return @version_objects if @version_objects @version_objects = version_order.map do |v| version_object v rescue <a href="../../Xolo.html" title="Xolo (module)">Xolo</a>::<a href="../Core.html" title="Xolo::Core (module)">Core</a>::<a href="../Core/Exceptions.html" title="Xolo::Core::Exceptions (module)">Exceptions</a>::<a href="../Core/Exceptions/NoSuchItemError.html" title="Xolo::Core::Exceptions::NoSuchItemError (class)">NoSuchItemError</a> next if deleting? raise end end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="version_script_contents-instance_method"> #version_script_contents ⇒ <tt>String</tt> </h3><div class="docstring"> <div class="discussion"> The code of the version script, if any, considering the new data of any changes being made Returns nil if there is no version script, or if we are in the process of deleting it. </div> </div> <div class="tags"> Returns: <ul class="return"> <li> (<tt>String</tt>) — <div class='inline'>The string contents of the version_script, if any</div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/title.rb', line 510 def version_script_contents return @version_script_contents if defined? @version_script_contents curr_script = if changes_for_update&.key? :version_script # new, incoming script changes_for_update[:version_script][:new] else # the current attribute value, might be Xolo::ITEM_UPLOADED version_script end @version_script_contents = if curr_script.pix_empty? # no script, or deleting script nil elsif curr_script == <a href="../../Xolo.html" title="Xolo (module)">Xolo</a>::ITEM_UPLOADED # use the one we have saved on disk version_script_file.read else # this will be a new one from the changes_for_update curr_script end end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="version_script_file-instance_method"> #version_script_file ⇒ <tt>Pathname</tt> </h3><div class="docstring"> <div class="discussion"> Returns The the local file containing the code of the version script. </div> </div> <div class="tags"> Returns: <ul class="return"> <li> (<tt>Pathname</tt>) — <div class='inline'>The the local file containing the code of the version script</div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 498 499 500</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/title.rb', line 498 def version_script_file @version_script_file ||= self.class.version_script_file title end</pre> </td> </tr> </table> </div> </div> </div> <div id="footer"> Generated on Sat Aug 15 01:14:46 2026 by <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.9.45 (ruby-4.0.2). </div> </div> </body> </html>

Class: Xolo::Server::Title

Overview

Constant Summary collapse

Constants included from Mixins::Changelog

Constants included from Helpers::Notification

Constants included from Helpers::JamfPro

Instance Attribute Summary collapse