#-- vim:sw=2:et
#++
#
# :title: Fortune plugin

class FortunePlugin < Plugin
  Config.register Config::StringValue.new('fortune.path',
    :default => '',
    :desc => "Full path to the fortune executable")
  Config.register Config::ArrayValue.new('fortune.options',
    :default => ['-n', '350', '-s'],
    :desc => "Options to be passed on to fortune")

  def help(plugin, topic="")
    "fortune [<category>] => get a (short) fortune, optionally specifying fortune category || fortune categories => show categories"
  end

  def find_fortune(m)
    fortune = @bot.config['fortune.path']
    return fortune if fortune and not fortune.empty?

    ["/usr/bin/fortune",
     "/usr/share/bin/fortune",
     "/usr/games/fortune",
     "/usr/local/games/fortune",
     "/usr/local/bin/fortune"].each do |f|
      if FileTest.executable? f
        fortune = f
        break
      end
    end

    return nil unless fortune

    # Try setting the config entry
    config_par = {:key => 'fortune.path', :value => [fortune], :silent => true }
    debug "Setting fortune.path to #{fortune}"
    set_path = @bot.plugins['config'].handle_set(m, config_par)
    if set_path
      debug "fortune.path set to #{@bot.config['fortune.path']}"
    else
      debug "couldn't set fortune.path"
    end

    return fortune
  end

  ## Pick a fortune
  def fortune(m, params)
    fortune = find_fortune(m)
    if not fortune or fortune.empty?
      m.reply "fortune executable not found (try setting the 'fortune.path' variable)"
      return
    end

    command = [fortune] + @bot.config['fortune.options']
    command << params[:db]
    command.compact!

    begin
      ret = Utils.safe_exec(*command)

      ## cleanup ret
      ret = ret.split(/\n+/).map do |l|
        # check if this is a "  -- Some Dood" line
        if l =~ /^\s+-{1,3}\s+\w/
          # turn "-" into "--"
          l.gsub!(/^\s+-\s/, '-- ')
          # extra space
          " " + l.strip
        else
          # just remove leading and trailing whitespace
          l.strip
        end
      end.join(" ")

    rescue
      ret = "failed to execute fortune"
      # TODO reset fortune.path when execution fails
    end

    m.reply ret
  end

  # Print the fortune categories
  def categories(m, params)
    fortune = find_fortune(m)
    if not fortune or fortune.empty?
      m.reply "fortune executable not found (try setting the 'fortune.path' variable)"
      return
    end

    ## list all fortune databases
    categories = Utils.safe_exec(fortune, "-f").split(/\n+ */).map{ |f|
      f.split[1]
    }.select{ |f|
      f[0..0] != '/'
    }.sort

    ## say 'em!
    m.reply "Fortune categories: #{categories.join ', '}"
  end

end
plugin = FortunePlugin.new
plugin.map 'fortune categories', :action => "categories"
plugin.map 'fortune list', :action => "categories"
plugin.map 'fortune :db', :defaults => {:db => ''},
                          :requirements => {:db => /^[^-][\w-]+$/}