#!/usr/bin/env ruby -wKU

require "net/https"
require "uri"
require "yaml"
require "timeout"

module Scout
  class Server
    # A new class for plugin Timeout errors.
    class PluginTimeoutError < RuntimeError; end
    
    # The default URLS are used to communicate with the Scout Server.
    URLS = { :plan   => "/clients/CLIENT_KEY/plugins.scout?version=CLIENT_VERSION",
             :report => "/clients/CLIENT_KEY/plugins/PLUGIN_ID/reports.scout?version=CLIENT_VERSION",
             :error  => "/clients/CLIENT_KEY/plugins/PLUGIN_ID/errors.scout?version=CLIENT_VERSION",
             :alert  => "/clients/CLIENT_KEY/plugins/PLUGIN_ID/alerts.scout?version=CLIENT_VERSION" }

    # 
    # A plugin cannot take more than PLUGIN_TIMEOUT seconds to execute, 
    # otherwise, a timeout error is generated.
    # 
    PLUGIN_TIMEOUT = 60
    
    # Creates a new Scout Server connection.
    def initialize(server, client_key, history_file, logger = nil)
      @server       = server
      @client_key   = client_key
      @history_file = history_file
      @history      = Hash.new
      @logger       = logger
      
      if block_given?
        load_history
        yield self
        save_history
      end
    end
    
    # 
    # Loads the history file from disk. If the file does not exist, 
    # it creates one.
    #
    def load_history
      unless File.exist? @history_file
        debug "Creating empty history file..."
        File.open(@history_file, "w") do |file|
          YAML.dump({"last_runs" => Hash.new, "memory" => Hash.new}, file)
        end
        info "History file created."
      end
      debug "Loading history file..."
      @history = File.open(@history_file) { |file| YAML.load(file) }
      info "History file loaded."
    end
    
    # Saves the history file to disk.
    def save_history
      debug "Saving history file..."
      File.open(@history_file, "w") { |file| YAML.dump(@history, file) }
      info "History file saved."
    end
    
    # Runs all plugins from a given plan. Calls process_plugin on each plugin.
    def run_plugins_by_plan
      plan do |plugin|
        process_plugin(plugin)
      end
    end
    
    # 
    # This is the heart of Scout.  
    # 
    # First, it determines if a plugin is past interval and needs to be run.
    # If it is, it simply evals the code, compiling it.
    # It then loads the plugin and runs it with a PLUGIN_TIMEOUT time limit.
    # The plugin generates data, alerts, and errors. In addition, it will
    # set memory and last_run information in the history file.
    # 
    def process_plugin(plugin)
      info "Processing the #{plugin[:name]} plugin:"
      last_run = @history["last_runs"][plugin[:name]]
      memory   = @history["memory"][plugin[:name]]
      run_time = Time.now
      if last_run.nil? or run_time >= last_run + plugin[:interval]
        debug "Plugin is past interval and needs to be run.  " +
              "(last run:  #{last_run || 'nil'})"
        debug "Compiling plugin..."
        begin
          eval(plugin[:code], TOPLEVEL_BINDING, plugin[:path] || plugin[:name])
          info "Plugin compiled."
        rescue Exception
          error "Plugin would not compile: #{$!.message}"
          return
        end
        debug "Loading plugin..."
        if job = Plugin.last_defined.load( last_run, (memory || Hash.new),
                                           plugin[:options] || Hash.new )
          info "Plugin loaded."
          debug "Running plugin..."
          begin
            data = {}
            Timeout.timeout(PLUGIN_TIMEOUT, PluginTimeoutError) do
              data = job.run
            end
          rescue Timeout::Error
            error "Plugin took too long to run."
            return
          rescue Exception
            error "Plugin failed to run: #{$!.backtrace}"
          end
          info "Plugin completed its run."
          
          # handle single report or array of reports
          send_report(data[:report], plugin[:plugin_id])   if data[:report]
          if data[:reports] and not data[:reports].empty?
            data[:reports].each { |r| send_report(r, plugin[:plugin_id]) }
          end          
          # handle single alert or array of alerts
          send_alert(data[:alert], plugin[:plugin_id])   if data[:alert]
          if data[:alerts] and not data[:alerts].empty?
            data[:alerts].each { |a| send_alert(a, plugin[:plugin_id]) }
          end
          # handle single error or array of errors
          send_error(data[:error], plugin[:plugin_id]) if data[:error]
          if data[:errors] and not data[:errors].empty?
            data[:errors].each { |e| send_error(e, plugin[:plugin_id]) }
          end
          
          @history["last_runs"][plugin[:name]] = run_time
          @history["memory"][plugin[:name]]    = data[:memory]
        else
          scout_error({:subject => "Plugin would not load."}, plugin[:plugin_id])
        end
      else
        debug "Plugin does not need to be run at this time.  " +
              "(last run:  #{last_run || 'nil'})"
      end
      data
    ensure
      if Plugin.last_defined
        debug "Removing plugin code..."
        begin
          Object.send(:remove_const, Plugin.last_defined.to_s.split("::").first)
          Plugin.last_defined = nil
          info "Plugin Removed."
        rescue
          error "Unable to remove plugin."
        end
      end
      info "Plugin #{plugin[:name]} processing complete."
    end
    
    # 
    # Retrieves the Plugin Plan from the server. This is the list of plugins 
    # to execute, along with all options.
    # 
    def plan
      url = urlify(:plan)
      info "Loading plan from #{url}..."
      get(url, "Could not retrieve plan from server.") do |res|
        begin
          plugin_execution_plan = Marshal.load(res.body)
          info "Plan loaded.  (#{plugin_execution_plan.size} plugins:  " +
               "#{plugin_execution_plan.map { |p| p[:name] }.join(', ')})"
        rescue TypeError
          fatal "Plan from server was malformed."
          exit
        end
        plugin_execution_plan.each do |plugin|
          begin
            yield plugin if block_given?
          rescue RuntimeError
            scout_error( { :subject => "Exception:  #{$!.message}.",
                     :body    => $!.backtrace },
                   plugin[:plugin_id] )
          end
        end
      end
    end
    alias_method :test, :plan

    # Sends report data to the Scout Server.
    def send_report(data, plugin_id)
      url = urlify(:report, :plugin_id => plugin_id)
      report_hash = {:data => data, :plugin_id => plugin_id}
      
      # add in any special fields
      if time = ( data.delete(:scout_time) || data.delete("scout_time") )
        report_hash[:time] = time
      end
      
      debug "Sending report to #{url} (#{data.inspect})..."
      post url,
           "Unable to send report to server.",
           :report => report_hash
      info "Report sent."
    end

    # Sends an alert to the Scout Server.
    def send_alert(data, plugin_id)
      url = urlify(:alert, :plugin_id => plugin_id)
      debug "Sending alert to #{url} (subject: #{data[:subject]})..."
      post url,
           "Unable to send alert to server.",
           :alert => data.merge(:plugin_id => plugin_id)
      info "Alert sent."
    end

    # Sends an error to the Scout Server.
    def send_error(data, plugin_id)
      url = urlify(:error, :plugin_id => plugin_id)
      debug "Sending error to #{url} (subject: #{data[:subject]})..."
      post url,
           "Unable to log error on server.",
            :error => data.merge(:plugin_id => plugin_id)
      info "Error sent."
    end
    
    private

    def urlify(url_name, options = Hash.new)
      return unless @server
      options.merge!(:client_version => Scout::VERSION)
      URI.join( @server,
                URLS[url_name].
                  gsub(/\bCLIENT_KEY\b/, @client_key).
                  gsub(/\b[A-Z_]+\b/) { |k| options[k.downcase.to_sym] || k } )
    end

    def paramify(params, prefix = nil)
      params.inject(Hash.new) do |all, (key, value)|
        parent = prefix ? "#{prefix}[#{key}]" : String(key)
        if value.is_a? Hash
          all.merge(paramify(value, parent))
        else
          all.merge(parent => String(value))
        end
      end
    end
    
    def post(url, error, params = {}, &response_handler)
      return unless url
      request(url, response_handler, error) do |connection|
        post = Net::HTTP::Post.new(url.path + (url.query ? ('?' + url.query) : ''))
        post.set_form_data(paramify(params))
        connection.request(post)
      end
    end

    def get(url, error, params = {}, &response_handler)
      return unless url
      request(url, response_handler, error) do |connection|
        connection.get(url.path + (url.query ? ('?' + url.query) : ''))
      end
    end
    
    def request(url, response_handler, error, &connector)
      http             = Net::HTTP.new(url.host, url.port)
      if url.is_a? URI::HTTPS
        http.use_ssl     = true
        http.verify_mode = OpenSSL::SSL::VERIFY_NONE
      end
      case response    = no_warnings { http.start(&connector) }
      when Net::HTTPSuccess
        response_handler[response] unless response_handler.nil?
      else
        fatal error
        exit
      end
    rescue Timeout::Error
      fatal "Request timed out."
      exit
    rescue Exception
      fatal "An HTTP error occurred:  #{$!.message}"
      exit
    end
    
    def no_warnings
      old_verbose = $VERBOSE
      $VERBOSE    = false
      yield
    ensure
      $VERBOSE = old_verbose
    end
    
    # Forward Logger methods to an active instance, when there is one.
    def method_missing(meth, *args, &block)
      if (Logger::SEV_LABEL - %w[ANY]).include? meth.to_s.upcase
        @logger.send(meth, *args, &block) unless @logger.nil?
      else
        super
      end
    end
  end
end