# encoding: utf-8
require "logstash/event"
require "logstash/logging"
require "logstash/plugin"
require "logstash/namespace"
require "logstash/config/mixin"
require "logstash/util/wrapped_synchronous_queue"
require "concurrent/atomic/atomic_fixnum"

class LogStash::Outputs::Base < LogStash::Plugin
  include LogStash::Config::Mixin

  config_name "output"

  config :type, :validate => :string, :default => "", :obsolete => "You can achieve this same behavior with the new conditionals, like: `if [type] == \"sometype\" { %PLUGIN% { ... } }`."

  config :tags, :validate => :array, :default => [], :obsolete => "You can achieve similar behavior with the new conditionals, like: `if \"sometag\" in [tags] { %PLUGIN% { ... } }`"

  config :exclude_tags, :validate => :array, :default => [], :obsolete => "You can achieve similar behavior with the new conditionals, like: `if (\"sometag\" not in [tags]) { %PLUGIN% { ... } }`"

  # The codec used for output data. Output codecs are a convenient method for encoding your data before it leaves the output, without needing a separate filter in your Logstash pipeline.
  config :codec, :validate => :codec, :default => "plain"

  # The number of workers to use for this output.
  # Note that this setting may not be useful for all outputs.
  config :workers, :validate => :number, :default => 1

  attr_reader :worker_plugins, :available_workers, :workers, :worker_plugins, :workers_not_supported

  def self.declare_threadsafe!
    declare_workers_not_supported!
    @threadsafe = true
  end

  def self.threadsafe?
    @threadsafe == true
  end

  def self.declare_workers_not_supported!(message=nil)
    @workers_not_supported_message = message
    @workers_not_supported = true
  end

  def self.workers_not_supported_message
    @workers_not_supported_message
  end

  def self.workers_not_supported?
    !!@workers_not_supported
  end

  public
  # TODO: Remove this in the next major version after Logstash 2.x
  # Post 2.x it should raise an error and tell people to use the class level
  # declaration
  def workers_not_supported(message=nil)
    self.class.declare_workers_not_supported!(message)
  end

  public
  def initialize(params={})
    super
    config_init(@params)

    # If we're running with a single thread we must enforce single-threaded concurrency by default
    # Maybe in a future version we'll assume output plugins are threadsafe
    @single_worker_mutex = Mutex.new
  end

  public
  def register
    raise "#{self.class}#register must be overidden"
  end # def register

  public
  def receive(event)
    raise "#{self.class}#receive must be overidden"
  end # def receive

  public
  # To be overriden in implementations
  def multi_receive(events)
    events.each {|event| receive(event) }
  end

  private
  def output?(event)
    # TODO: noop for now, remove this once we delete this call from all plugins
    true
  end # def output?
end # class LogStash::Outputs::Base