# === Synopsis:
#   RightScale Cloud Controller (cloud) - Copyright (c) 2013 by RightScale Inc
#
#   cloud is a command line tool which invokes cloud-specific actions
#
# === Examples:
#   Write cloud and user metadata to cache directory using default cloud:
#     cloud --action=write_metadata
#
#   Write user metadata only to cache directory using named ec2 cloud:
#     cloud --name=ec2 --action=write_user_metadata
#
#   Read default cloud user metadata in dictionary format (metadata is output):
#     cloud --action=read_user_metadata
#                      --parameters=dictionary_metadata_writer
#
# === Usage:
#    cloud [options]
#
#    options:
#      --action, -a       Action to perform (required, see below for details).
#      --name, -n         Cloud to use instead of attempting to determine a
#                         default cloud.
#      --parameters, -p   Parameters passed to cloud action as either a single
#                         string argument or as a square-bracketed array in
#                         JSON format for multiple arguments.
#      --only-if, -o      Ignores unknown cloud actions instead of printing an
#                         error.

require 'rubygems'
require 'json'
require 'logger'
require 'trollop'
require 'fileutils'
require 'right_agent'
require 'right_agent/scripts/usage'

require File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib', 'instance', 'agent_config'))
require File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib', 'clouds', 'register_clouds'))
require File.expand_path(File.join(File.dirname(__FILE__), 'command_helper'))

module RightScale

  class CloudController
    include CommandHelper

    # Convenience wrapper
    def self.run
      controller = CloudController.new
      controller.control(controller.parse_args)
    rescue Errno::EACCES => e
      STDERR.puts e.message
      STDERR.puts "Try elevating privilege (sudo/runas) before invoking this command."
      exit(2)
    rescue SystemExit => e
      raise e
    rescue Exception => e
      $stderr.puts "ERROR: #{e.message}"
      exit 1
    end

    # Undecorated formatter to support legacy console output
    class PlainLoggerFormatter < Logger::Formatter
      def call(severity, time, program_name, message)
        return message + "\n"
      end
    end

    # Parse arguments and run
    def control(options)
      fail("No action specified on the command line.") unless options[:action]
      name = options[:name]
      parameters = options[:parameters] || []
      only_if = options[:only_if]
      verbose = options[:verbose]

      # support either single or a comma-delimited list of actions to execute
      # sequentially (e.g. "--action clear_state,wait_for_instance_ready,write_user_metadata")
      # (because we need to split bootstrap actions up in Windows case).
      actions = options[:action].to_s.split(',').inject([]) do |result, action|
        unless (action = action.strip).empty?
          action = action.to_sym
          case action
            when :bootstrap
              # bootstrap is shorthand for all standard actions performed on boot
              result += [:clear_state, :wait_for_instance_ready, :write_cloud_metadata, :write_user_metadata, :wait_for_eip]
              only_if = true
            else
              result << action
          end
        end
        result
      end

      cloud = CloudFactory.instance.create(name, :logger => default_logger(verbose))

      actions.each do |action|
        if cloud.respond_to?(action)
          # Expect most methods to return ActionResult, but a cloud can expose any
          # custom method so we can't assume return type
          result = cloud.send(action, *parameters)
          $stderr.puts result.error if result.respond_to?(:error) && result.error
          $stdout.puts result.output if verbose && result.respond_to?(:output) && result.output

          if result.respond_to?(:exitstatus) && (result.exitstatus != 0)
            raise StandardError, "Action #{action} failed with status #{result.exitstatus}"
          end
        elsif only_if
          next
        else
          raise ArgumentError, "ERROR: Unknown cloud action: #{action}"
        end
      end
    end

    # Parse arguments
    def parse_args
      parser = Trollop::Parser.new do
        opt :name, "", :default => CloudFactory::UNKNOWN_CLOUD_NAME.to_s
        opt :action, "",  :type => :string
        opt :only_if
        opt :parameters, "",:type => :string
        opt :quiet # note that :quiet is deprecated (use -v instead) because Trollop cannot easily support inverse flags that default to true
        opt :verbose
      end
      parse do
        options = parser.parse
        if options[:parameters_given]
          if options[:parameters].start_with?("[")
            options[:parameters] = JSON.parse(options[:parameters])
          else
            options[:parameters] = [options[:parameters]]
          end
        end
        options
      end
    end

    def usage
      Usage.scan(__FILE__)
    end

    # Default logger for printing to console
    def default_logger(verbose)
      if verbose
        logger = Logger.new(STDOUT)
        logger.level = Logger::INFO
        logger.formatter = PlainLoggerFormatter.new
      else
        logger = RightScale::Log
      end
      return logger
    end

  end # CloudController

end # RightScale

#
# Copyright (c) 2011 RightScale Inc
#
# Permission is hereby granted, free of charge, to any person obtaining
# a copy of this software and associated documentation files (the
# "Software"), to deal in the Software without restriction, including
# without limitation the rights to use, copy, modify, merge, publish,
# distribute, sublicense, and/or sell copies of the Software, and to
# permit persons to whom the Software is furnished to do so, subject to
# the following conditions:
#
# The above copyright notice and this permission notice shall be
# included in all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.