depot3 0.0.0a1 → 3.0.7

data/lib/d3/puppytime/puppy_queue.rb

@@ -0,0 +1,274 @@
+### 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
+  module PuppyTime
+      ### PuppyQ - the current queue of pending puppy installs.
+      ### This class only has one real value: A hash of
+      ### PendingPuppy objects, keyed by basename.
+      ### But, PendingPuppies can be added and removed
+      ### and the queue can be read and written to disk
+      ###
+      class PuppyQueue
+
+        ################# Mixin Modules #################
+
+        include Singleton
+
+        ################## Class Constants #################
+
+        QUEUE_FILE = D3::SUPPORT_DIR + "d3-pending-puppies.yaml"
+
+        DFT_NOTIFICATION_FREQUENCY = 7
+
+        ################# Class Methods #################
+
+        ################# Attributes #################
+
+        # the queue of PendingPuppy objects
+        # A hash, keyed by basename.
+        attr_reader :q
+
+        ################# Constructor #################
+
+        # start by sett
+        def initialize
+          read_q
+        end # init
+
+        ################# Public Instance Methods #################
+
+        ### Read in the current puppy queue from disk
+        ### or set it to an empty hash if not there.
+        ###
+        ### @return [void]
+        ###
+        def read_q
+          if QUEUE_FILE.exist?
+            @q = YAML.load(QUEUE_FILE.read)
+            D3.log "Puppy queue loaded from disk", :debug
+          else
+            @q = {}
+            D3.log "Created new empty puppy queue", :debug
+          end
+        end  # read_q
+
+        ### Save the current q out to disk
+        ###
+        def save_q
+          D3.log "Saving puppy queue", :debug
+          if @q.empty?
+            D3.log "Puppy queue is empty, deleting from disk", :debug
+            QUEUE_FILE.delete
+          else
+            QUEUE_FILE.jss_save YAML.dump(@q)
+            D3.log "Puppy queue saved to disk", :debug
+          end
+
+        end # save_q
+
+        ### @return [Array<String>] the basenames of the pending puppies
+        ###
+        def pups
+          @q.keys
+        end
+
+        ### Add a puppy to the queue
+        ###
+        ### @param puppy[D3::PendingPupppy] the puppy to add.
+        ###
+        ### @return [Boolean] True if the puppy was queued, false if already
+        ###   in the queue with a same or newer edition.
+        ###
+        def + (puppy)
+
+          raise TypeError, "You can only add PendingPuppy ojects to the PuppyQueue" unless puppy.class == D3::PuppyTime::PendingPuppy
+
+          D3.log "Adding to puppy queue: #{puppy.edition}", :info
+
+          # does this basename already exist in the queue?
+          # we can only have one edition per basename in the queue at a time
+          if pups.include? puppy.basename
+            in_q = @q[puppy.basename]
+
+            # if the pre-queued one is older, replace it with this one.
+            if in_q.id < puppy.id
+              D3.log "Replacing older puppy in queue: #{in_q.edition}", :warm
+              self - puppy.basename
+            else
+              if puppy.force
+                D3.log "Puppy already in queue for '#{puppy.basename}' is the same or newer (#{in_q.edition}), but force-adding", :warn
+                self - puppy.basename
+              else
+                D3.log "Puppy already in queue for '#{puppy.basename}' is the same or newer (#{in_q.edition}), not adding", :warn
+                return false
+              end # if force
+            end
+          end # if @pups.include? puppy.basename
+
+          # note if we're starting with an empty queue
+          started_empty = @q.empty?
+
+          # Note when we're queueing
+          puppy.queued_at = Time.now
+
+          # add the new puppy
+          @q[puppy.basename] = puppy
+          D3.log "Added puppy to queue: #{puppy.edition}", :info
+
+          # save it
+          save_q
+
+          notify_puppies
+
+          return true
+        end # +
+
+        ### Remove a puppy from the queue
+        ###
+        ### @param puppy[String,D3::PendingPupppy] the basename or D3::PendingPupppy
+        ###   for the puppy to be removed
+        ###
+        ### @return [Boolean] true if it was removed, false if it wasn't in the queue
+        ###
+        def - (puppy)
+
+          puppy = puppy.basename unless puppy.is_a? String
+
+          return false unless pups.include? puppy
+
+          # remove it
+          @q.delete puppy
+          D3.log "Removed basename #{puppy} from the puppy queue", :debug
+
+          # save the queue
+          save_q
+
+          return true
+        end # +
+
+        ### Should we run the puppytime notification policy?
+        ### returns the policy id or name, or false if we
+        ### shouldn't run.
+        ###
+        ### @return [String,Integer,false] the policy to run, if we should
+        ###
+        def should_run_notification_policy
+          # no puppies, no notify
+          if @q.empty?
+            D3.log "Not running puppytime notification policy: No puppies in queue", :debug
+            return false
+          end
+
+          # no policy, no notify
+          unless policy = D3::CONFIG.puppy_notification_policy
+            D3.log "Not running puppytime notification policy: No policy in config", :debug
+            return false
+          end
+
+          # no-notification option was given, no notify
+          unless D3::Client.puppy_notification_ok_with_admin?
+            D3.log "Not running puppytime notification policy: --no-puppy-notification was given", :debug
+            return false
+          end
+
+          # how many days between notifications?
+          frequency = D3::CONFIG.puppy_notification_frequency
+          frequency ||= DFT_NOTIFICATION_FREQUENCY
+
+          case frequency
+          # zero means never notify
+          when 0
+            D3.log "Not running puppytime notification policy: Frequency set to Zero", :debug
+            return false
+          # -1 means always notify
+          when -1
+            D3.log "Frequency set to -1, always running puppytime notification policy", :debug
+            return policy
+          end
+
+          unless last_notification = D3::CONFIG.puppy_last_notification
+            # never been notified? always notify.
+            D3.log "Puppytime notification policy never run, running now.", :debug
+            return policy
+          end # if last notiv
+
+          # not long enough since last? no notify
+          last_notification_days_ago = ((Time.now - last_notification) / 60 / 60 / 24).to_i
+          unless last_notification_days_ago >= frequency
+            D3.log "Not running puppytime notification policy: last notification #{last_notification_days_ago}/#{frequency} days ago", :debug
+            return false
+          end
+
+          return policy
+        end
+
+        ### Run the puppy notification policy, if there is one
+        ### and if its been long enough since the last run.
+        ###
+        ### @return [void]
+        ###
+        def notify_puppies(verbose = false)
+
+          return unless policy = should_run_notification_policy
+
+          # put the queue editions in the ENV
+          puppies = @q.values.map{|p| p.edition}.join " "
+          D3::Client.set_env :puppytime_notification, puppies
+
+          D3.run_policy policy, :puppy_notification, verbose
+
+          update_last_notification
+          D3::Client.unset_env :puppytime_notification
+        end
+
+        ### Update the last notification date in the config
+        ### to right-now.
+        ###
+        ### @return [void]
+        ###
+        def update_last_notification
+          D3.log "Updating last puppy notification time", :debug
+          D3::CONFIG.puppy_last_notification = Time.now
+          D3::CONFIG.save
+        end # update last notification
+
+
+        ################# Method Aliases #################
+
+        alias queue q
+        alias pending_puppies q
+        alias puppies pups
+        alias basenames pups
+        alias refresh read_q
+
+      end # class PuppyQueue
+
+  end # module puppytime
+
+  # here's our one queue instance
+  PUPPY_Q = D3::PuppyTime::PuppyQueue.instance
+
+end #module d3

data/lib/d3/puppytime.rb

@@ -0,0 +1,68 @@
+### 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.
+###
+###
+
+require 'd3/puppytime/pending_puppy'
+require 'd3/puppytime/puppy_queue'
+
+
+
+module D3
+
+  # Constants and methods for PuppyTime, which installs the pkgs listed in the
+  # PuppyQueue at logout.
+  #
+  module PuppyTime
+
+    ################# Module Constants #################
+
+    DFT_IMAGE_DIR = D3::SUPPORT_DIR + "puppytime"
+
+    DFT_OPTOUT_IMAGE = DFT_IMAGE_DIR + "opt_out_image"
+
+    DFT_NOTIFY_IMAGE = DFT_IMAGE_DIR + "notification_image"
+
+    DFT_SLIDESHOW_DIR = DFT_IMAGE_DIR + "slideshow"
+
+    DFT_OPTOUT_TEXT = "Software updates will start when you click OK,\nor when the timer runs out.\nClick cancel to postpone till next logout"
+
+    DFT_OPTOUT_SECS = 30
+
+    DFT_DISPLAY_SECS = 8
+
+    DFT_TITLE = "PuppyTime!"
+
+    DFT_IMG_SIZE = 250
+
+    TEXT_POSITION = :center
+
+    DFT_CAPTION = "The puppies are..."
+
+    CAPTION_POSITION = :left
+
+    COUNTDOWN_POSITION = :right
+
+  end #module PuppyTime
+
+end #module D3
+

data/lib/d3/state.rb

@@ -0,0 +1,105 @@
+### 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
+
+  # this will be set to true when we finish loading
+  @@loaded = false
+
+  def self.loaded?
+    @@loaded
+  end
+
+  # This stores the current level of log messages
+  # sent to stdout. See
+  # D3::Log.level to set the level for messages
+  # sent to the log.
+  # @return [Integer]
+  @@verbosity = D3::Log::DFT_VERBOSITY
+
+  def self.verbosity
+    @@verbosity
+  end
+
+  ### Set the level of verbosity to stderr.
+  ### Messages logged via D3#log, of this severity and higher,
+  ### will show up on stderr
+  ### They *may* show up in the log depending on the D3::LOG.level
+  ###
+  ### @param new_verbosity[Symbol, Integer] the new value, one of D3::Log::LOG_LEVELS
+  ###
+  ### @return [void]
+  ###
+  def self.verbosity= (new_val)
+    # range is 0-4 if we're given an integer
+    # so force it to be in the range.
+    if new_val.is_a? Fixnum
+      new_val = 0 if new_val < 0
+      new_val = 4 if new_val > 4
+    end
+    @@verbosity = D3::Log.check_level(new_val)
+  end
+
+
+  # have we been asked to be forceful, and perform
+  # unnatural acts?
+  # Force is used in many different was in many places
+  # so we'll store it here and anything can access it
+  # using D3::force, D3::unforce, and D3::forced?
+  @@force = false
+
+  def self.force
+    @@force = true
+    D3::Client.set_env :force
+  end
+
+  def self.unforce
+    @@force = false
+    D3::Client.unset_env :force
+  end
+
+  def self.forced?
+    @@force
+  end
+
+  ### Are we connected to the API and DB servers?
+  ###
+  ### returns false if the are not both connected
+  ### returns a hash like this if both are connected:
+  ###
+  ### {:api => "user@api_server", :db => "sql_user@db_server"}
+  ###
+  ### @return [false, Hash] Are we connected to the servers, and if so,
+  ###   what hosts and usernames
+  ###
+  def self.connected?
+    return false unless JSS::API.connected? and JSS::DB_CNX.connected?
+    return {
+      :api => (JSS::API.cnx.options[:user] + "@" + JSS::API.cnx.options[:server]),
+      :db => (JSS::DB_CNX.user + "@" + JSS::DB_CNX.server)
+    }
+  end
+
+end # module