depot3 0.0.0a1 → 3.0.7

data/lib/d3/package/getters.rb

@@ -0,0 +1,164 @@
+### Copyright 2016 Pixar
+###
+###    Licensed under the Apache License, Version 2.0 (the "Apache License")
+###    with the following modification; you may not use this file except in
+###    compliance with the Apache License and the following modification to it:
+###    Section 6. Trademarks. is deleted and replaced with:
+###
+###    6. Trademarks. This License does not grant permission to use the trade
+###       names, trademarks, service marks, or product names of the Licensor
+###       and its affiliates, except as required to comply with Section 4(c) of
+###       the License and to reproduce the content of the NOTICE file.
+###
+###    You may obtain a copy of the Apache License at
+###
+###        http://www.apache.org/licenses/LICENSE-2.0
+###
+###    Unless required by applicable law or agreed to in writing, software
+###    distributed under the Apache License with the above modification is
+###    distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+###    KIND, either express or implied. See the Apache License for the specific
+###    language governing permissions and limitations under the Apache License.
+###
+###
+
+
+module D3
+  class Package < JSS::Package
+
+    ### @return [String,nil] - The name of the pre-install script for this pkg, or nil if none
+    ###
+    def pre_install_script_name
+      return nil unless @pre_install_script_id
+      JSS::Script.map_all_ids_to(:name)[@pre_install_script_id]
+    end
+
+    ### @return [String,nil] - The name of the post install script for this pkg, or nil if none
+    ###
+    def post_install_script_name
+      return nil unless @post_install_script_id
+      JSS::Script.map_all_ids_to(:name)[@post_install_script_id]
+    end
+
+    ### @return [String,nil] - The name of the pre remove script for this pkg, or nil if none
+    ###
+    def pre_remove_script_name
+      return nil unless @pre_remove_script_id
+      JSS::Script.map_all_ids_to(:name)[@pre_remove_script_id]
+    end
+
+    ### @return [String,nil] - The name of the post remove script for this pkg, or nil if none
+    ###
+    def post_remove_script_name
+      return nil unless @post_remove_script_id
+      JSS::Script.map_all_ids_to(:name)[@post_remove_script_id]
+    end
+
+    ### @return [Hash{Symbol=>Integer}] The type and ids of all pre- and post- scripts
+    ###   for this pkg.
+    def script_ids
+      {
+        :pre_install => @pre_install_script_id,
+        :post_install => @post_install_script_id,
+        :pre_remove => @pre_remove_script_id,
+        :post_remove => @post_remove_script_id
+      }
+    end
+
+    ### @return [Hash{Symbol=>String}] The type and names of all pre- and post- scripts
+    ###   for this pkg.
+    def script_names
+      {
+        :pre_install => @pre_install_script_name,
+        :post_install => @post_install_script_name,
+        :pre_remove => @pre_remove_script_name,
+        :post_remove => @post_remove_script_name
+      }
+    end
+
+    ### Generate a human-readable string of details about this installer
+    ###
+    ### @return [String] the package details in a human readble format.
+    ###
+    def formatted_details
+      os_disp = JSS.to_s_and_a(@os_requirements)[:stringform]
+      auto_disp = JSS.to_s_and_a(@auto_groups)[:stringform]
+      excl_disp = JSS.to_s_and_a(@excluded_groups)[:stringform]
+
+      msg = <<-END_DEETS
+Edition: #{edition}
+Status: #{@status}
+---- Description ----
+#{@notes.gsub("\r", "\n") if @notes}
+---------------------
+Added by: #{@added_by or 'unknown'}
+Added date: #{@added_date ? @added_date.strftime('%Y-%m-%d') : 'unknown'}
+Casper Package: #{@name} (id: #{@id})
+Filename: #{@filename}
+Category: #{@category or 'None'}
+Needs reboot (puppytime): #{@reboot_required or 'false'}
+Un-installable: #{removable? or 'false'}
+Pre-install script: #{pre_install_script_name or 'None'}
+Post-install script: #{post_install_script_name or 'None'}
+Pre-remove script: #{pre_remove_script_name or 'None'}
+Post-remove script: #{post_remove_script_name or 'None'}
+CPU limitation: #{@required_processor or 'None'}
+OS limitations: #{os_disp.empty? ? 'None' : os_disp}
+Uninstalls older versions: #{@remove_first or 'false'}
+Installation prohibited by process: #{@prohibiting_process or 'None'}
+Auto installed for groups: #{auto_disp.empty? ? 'None' : auto_disp}
+Excluded for groups: #{excl_disp.empty? ? 'None' : excl_disp}
+Expiration period: #{@expiration.to_i} days
+Expiration path: #{@expiration_path}
+Released by: #{@released_by or '-'}
+Release date: #{@release_date ? @release_date.strftime('%Y-%m-%d') : '-'}
+      END_DEETS
+    end #formatted_details
+
+    ### The index of this package
+    ### This is an array of paths (as Strings) from the pkg's Casper index
+    ###
+    ### @param files_only[Boolean] ignore directories, only return files
+    ###
+    ### @return [Array<String>]
+    ###
+    def index (files_only = false)
+      q =  "SELECT file FROM #{PKG_CONTENTS_TABLE} WHERE package_id = #{@id}"
+      q += " AND mode NOT LIKE 'd%'" if files_only
+      @index = []
+      JSS::DB_CNX.db.query(q).each {|record| @index << record[0]}
+      @index
+    end
+
+    ### Get an array of files installed by this pkg
+    ### Note that this does not show directories.
+    ### use #index to see dirs as well
+    ###
+    ### @return [Array<Pathname>] the files installed
+    ###
+    def installed_files
+      index :files_only
+    end
+
+    ### An Array of ids of all Casper policies using this package
+    ###
+    ### @return [Array<Integer>] the policy ids using this package.
+    ###
+    def policy_ids
+      qry = <<-ENDQ
+      SELECT p.policy_id
+      FROM policies p
+      JOIN policy_packages pp
+        ON p.policy_id = pp.policy_id
+      WHERE pp.package_id = '#{@id}'
+      ENDQ
+      res = JSS::DB_CNX.db.query qry
+      pols = []
+      res.each{|r| pols << r[0].to_i }
+      res.free
+      pols
+    end
+
+
+  end # class Package
+end # module D3

data/lib/d3/package/mixins.rb

@@ -0,0 +1,39 @@
+### Copyright 2016 Pixar
+###
+###    Licensed under the Apache License, Version 2.0 (the "Apache License")
+###    with the following modification; you may not use this file except in
+###    compliance with the Apache License and the following modification to it:
+###    Section 6. Trademarks. is deleted and replaced with:
+###
+###    6. Trademarks. This License does not grant permission to use the trade
+###       names, trademarks, service marks, or product names of the Licensor
+###       and its affiliates, except as required to comply with Section 4(c) of
+###       the License and to reproduce the content of the NOTICE file.
+###
+###    You may obtain a copy of the Apache License at
+###
+###        http://www.apache.org/licenses/LICENSE-2.0
+###
+###    Unless required by applicable law or agreed to in writing, software
+###    distributed under the Apache License with the above modification is
+###    distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+###    KIND, either express or implied. See the Apache License for the specific
+###    language governing permissions and limitations under the Apache License.
+###
+###
+
+
+module D3
+  class Package < JSS::Package
+
+    ################# Mixin Modules #################
+
+    ### The D3::Basename module provides common attributes and methods related to
+    ### d3's use of 'basenames' and 'editions'
+    include D3::Basename
+
+    include D3::Package::Validate
+
+
+  end # class Package
+end # module D3

data/lib/d3/package/private_methods.rb

@@ -0,0 +1,227 @@
+### Copyright 2016 Pixar
+###
+###    Licensed under the Apache License, Version 2.0 (the "Apache License")
+###    with the following modification; you may not use this file except in
+###    compliance with the Apache License and the following modification to it:
+###    Section 6. Trademarks. is deleted and replaced with:
+###
+###    6. Trademarks. This License does not grant permission to use the trade
+###       names, trademarks, service marks, or product names of the Licensor
+###       and its affiliates, except as required to comply with Section 4(c) of
+###       the License and to reproduce the content of the NOTICE file.
+###
+###    You may obtain a copy of the Apache License at
+###
+###        http://www.apache.org/licenses/LICENSE-2.0
+###
+###    Unless required by applicable law or agreed to in writing, software
+###    distributed under the Apache License with the above modification is
+###    distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+###    KIND, either express or implied. See the Apache License for the specific
+###    language governing permissions and limitations under the Apache License.
+###
+###
+
+
+module D3
+  class Package < JSS::Package
+
+    ################# Private Instance Methods #################
+    private
+
+    ### Is there a process running that would prevent installation?
+    ###
+    ### @return [Boolean]
+    ###
+    def install_prohibited_by_process?
+      return false unless @prohibiting_process
+        D3.prohibited_by_process_running? @prohibiting_process
+    end #
+
+    ### If needed, uninstall any previously installed versions of this basename
+    ###
+    def remove_previous_installs_if_needed (verbose = false)
+      if @remove_first && D3::Client::Receipt.basenames.include?(@basename)
+        previous_rcpt = D3::Client::Receipt.all[@basename]
+        if previous_rcpt.removable?
+          D3.log "Uninstalling previously installed version of #{@basename}" , :info
+          begin
+            D3::Client.set_env :uninstalling_before_install, previous_rcpt.edition
+            previous_rcpt.uninstall(verbose)
+          ensure
+            D3::Client.unset_env :uninstalling_before_install
+          end # begin
+        else
+          D3.log "Previously installed version of #{@basename} is not uninstallable, not uninstalling.", :info
+        end # if previous_rcpt.removable?
+      end # @remove_first && D3::Client::Receipt.basenames
+    end # remove_previous_installs_if_needed
+
+    ### Create a new D3 receipt for this pkg and store it in the
+    ### receipts datastore.
+    ###
+    ### @return [void]
+    ###
+    def write_rcpt
+        new_rcpt =  D3::Client::Receipt.new( :basename => @basename,
+            :version => @version,
+            :revision => @revision,
+            :admin => @admin,
+            :installed_at => Time.now,
+            :id => @id,
+            :status => @status,
+            :jamf_rcpt_file => @receipt,
+            :apple_pkg_ids => @apple_receipt_data.map{|r| r[:apple_pkg_id]},
+            :removable => removable?,
+            :pre_remove_script_id => @pre_remove_script_id,
+            :post_remove_script_id => @post_remove_script_id,
+            :expiration => @expiration_to_apply.to_i,
+            :expiration_path => @expiration_path,
+            :custom_expiration => @custom_expiration,
+            :prohibiting_process => @prohibiting_process)
+
+        D3::Client::Receipt.add_receipt new_rcpt, :replace
+
+    end # write_rcpt
+
+    ### Dump this pkg as a YAML marshalled string, for archiving
+    ###
+    ### @reutrn [String] the YAML representation of this pkg
+    ###
+    def package_yaml
+      YAML.dump self
+    end
+
+    def added_by= (name)
+      @added_by = name
+    end
+
+    def added_date= (date)
+      @added_date = date
+    end
+
+    def released_by= (name)
+      @released_by = name
+    end
+
+    def release_date= (date)
+      @release_date = date
+    end
+
+    def apple_receipt_data= (data)
+      @apple_receipt_data = data
+    end
+
+    ### Given one of the keys of the D3::Database::PACKAGE_TABLE[:field_definitions] hash,
+    ### convert the matching attribute value with the :to_sql Proc and return it.
+    ### If there is no matching attribute, assume the argument is a value
+    ### and return it Mysql.quoted.
+    ###
+    ### @param key[Symbol] the attribute to convert to SQL
+    ###
+    ### @return [String] the attribute value converted to an SQL-happy format
+    ###
+    def to_sql(key)
+      if key.is_a?(Symbol) and self.respond_to?(key)
+        return 'NULL' if self.send(key).to_s.empty?
+        if P_FIELDS[key] and P_FIELDS[key][:to_sql]
+          return Mysql.quote(P_FIELDS[key][:to_sql].call(self.send(key)).to_s)
+        else
+          return Mysql.quote(self.send(key).to_s)
+        end # if P_FIELDS[key] and P_FIELDS[key][:to_sql]
+      else
+        return Mysql.quote(key.to_s)
+      end #  if key.is_a?(Symbol)
+    end # to_sql(key)
+
+    ### Given one of the keys of the D3::Database::PACKAGE_TABLE[:field_definitions] hash,
+    ### and a value from an SQL query, convert the SQL value to the appropriate Ruby value
+    ### with the :to_ruby Proc and return it
+    ###
+    ### @param key[Symbol] the attribute to convert to SQL
+    ###
+    ### @return [Object] the attribute value converted to an SQL-happy format
+    ###
+    def to_ruby(key, sql_val)
+      # Note = the d3pkgdata has already been 'rubyized' via the D3::Database.table_records method
+      # (which was used by D3::Package.package_data)
+      return sql_val unless P_FIELDS[key][:to_ruby]
+      return P_FIELDS[key][:to_ruby].call(sql_val)
+    end
+
+    ### Make this package not live, which could be described as killing it, but
+    ### I think it would be more like 'zombification',
+    ### leaving no pkg live for this basename
+    ###
+    ### @return [void]
+    ###
+    def deprecate(admin = @admin)
+
+      raise JSS::InvalidDataError, "Only live packages can be deprecated." unless @status == :live
+      @status = :deprecated
+      stmt = JSS::DB_CNX.db.prepare "UPDATE #{P_TABLE[:table_name]} SET #{P_FIELDS[:status][:field_name]} = #{to_sql :status} WHERE #{P_FIELDS[:id][:field_name]} = '#{@id}'"
+
+      stmt_result = stmt.execute
+
+      # update our knowledge of the world
+      D3::Package.package_data :refresh
+
+      @status
+    end
+
+    ### Delete any scripts associated with this pkg
+    ### but only if they aren't associated with other d3 pkgs or casper policies
+    ###
+    ### @return [Array<String>] a textual list of scripts and whether they were
+    ###   deleted or not (and why not)
+    ###
+    def delete_pkg_scripts
+
+      # gather the ids of all scripts used by all policies
+      # this is a hash of arrays  pol_name => [id,id,id]
+      policy_scripts = D3.policy_scripts
+
+      script_deletion_actions = []
+
+      scripts = [:pre_install_id , :post_install_id , :pre_remove_id , :post_remove_id ]
+
+      scripts.each do |script_type|
+
+        type_display = script_type.to_s.chomp('_id')
+
+        victim_script_id = self.send script_type
+        victim_script_name = JSS::Script.map_all_ids_to(:name)[victim_script_id]
+
+        # skip if not in jss
+        next unless JSS::Script.all_ids.include? victim_script_id
+
+        # these d3 pkg editions use this script
+        d3_users = (D3::Package.packages_for_script(victim_script_id) - [@id])
+        d3_users.map!{|pkgid| D3::Package.ids_to_editions[pkgid]}
+
+        # these policies use this script
+        policy_users = []
+        policy_scripts.each do |pol, pol_scripts|
+          policy_users << pol if pol_scripts.include? victim_script_id
+        end
+
+        if d3_users.empty? and policy_users.empty?
+          # delete the script!
+          JSS::Script.new(id: victim_script_id).delete
+          script_deletion_actions << "deleted #{type_display} script '#{victim_script_name}'"
+        else
+          # add the info to the returned report
+          d3_users.each {|edition| script_deletion_actions << "#{type_display} script '#{victim_script_name}' is in use by d3 package: #{edition}"}
+          policy_users.each {|pol_name| script_deletion_actions << "#{type_display} script '#{victim_script_name}' is in use by policy: #{pol_name}"}
+        end # if both empty
+
+      end # scripts.each do |script_type|
+
+      return script_deletion_actions
+
+    end # delete_scripts
+
+
+
+  end # class Package
+end # module D3

data/lib/d3/package/questions.rb

@@ -0,0 +1,95 @@
+### Copyright 2016 Pixar
+###
+###    Licensed under the Apache License, Version 2.0 (the "Apache License")
+###    with the following modification; you may not use this file except in
+###    compliance with the Apache License and the following modification to it:
+###    Section 6. Trademarks. is deleted and replaced with:
+###
+###    6. Trademarks. This License does not grant permission to use the trade
+###       names, trademarks, service marks, or product names of the Licensor
+###       and its affiliates, except as required to comply with Section 4(c) of
+###       the License and to reproduce the content of the NOTICE file.
+###
+###    You may obtain a copy of the Apache License at
+###
+###        http://www.apache.org/licenses/LICENSE-2.0
+###
+###    Unless required by applicable law or agreed to in writing, software
+###    distributed under the Apache License with the above modification is
+###    distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+###    KIND, either express or implied. See the Apache License for the specific
+###    language governing permissions and limitations under the Apache License.
+###
+###
+
+
+module D3
+  class Package < JSS::Package
+
+    ### @return [Boolean] Does this pkg have a pre-install script?
+    def pre_install_script?
+      not @pre_install_script_id.nil?
+    end
+
+    ### @return [Boolean] Does this pkg have a post-install script?
+    def post_install_script?
+      not @post_install_script_id.nil?
+    end
+
+    ### @return [Boolean] Does this pkg have a pre-remove script?
+    def pre_remove_script?
+      not @pre_remove_script_id.nil?
+    end
+
+    ### @return [Boolean] Does this pkg have a post-remove script?
+    def post_remove_script?
+      not @post_remove_script_id.nil?
+    end
+
+    ### @return [Boolean] Is this pkg in on the server?
+    ###
+    def created?
+      @in_jss and @in_d3
+    end
+
+    ### @return [Boolean] Is this pkg on the server?
+    ###
+    def saved?
+      not (@need_to_update or @need_to_update_d3)
+    end
+
+    ### @return [Boolean] Is this pkg in pilot? (saved, but never made live)
+    ###
+    def deprecated?
+      @status == :deprecated
+    end
+
+    ### @return [Boolean] Is this pkg in pilot? (saved, but never made live)
+    ###
+    def skipped?
+      @status == :skipped
+    end
+
+    ### @return [Boolean] Is this pkg installed on this machine via d3?
+    ###   Note: this overrides JSS::Package#installed?
+    ###
+    def installed?
+      D3::Client::Receipt.basenames.include?(@basename) and D3::Client::Receipt.all[@basename].id == @id
+    end
+
+    ### @return [Boolean] Does this pkg expire by default?
+    ###
+    def expires?
+      @expiration.to_i > 0 && @expiration_path
+    end
+
+    ### @return [Boolean] Is this pkg 'indexed' in the jss, so that it can be removable?
+    ###
+    def indexed?
+      not index.empty?
+    end # indexed?
+
+
+
+  end # class Package
+end # module D3