#!/usr/bin/ruby1.8


require 'timeout'
require 'socket'

#
# This class is responsible for performing tests against a remote FTP server
#
#
class FTPTest

  #
  # Data passed from the JSON hash.
  #
  attr_reader :test_data

  #
  # The error text we return on failure.
  #
  attr_reader :error




  #
  # Save the data away.
  #
  def initialize( data )
    @test_data = data
    @error     = nil

    #
    # Ensure we have a host to probe
    #
    if ( @test_data["target_host"].nil? )
      @error = "Missing target for the test."
      raise ArgumentError, @error
    end

    #
    # Ensure we have a port to test.
    #
    if ( @test_data["test_port"].nil? )
      @error = "Missing port for the test."
      raise ArgumentError, @error
    end

  end


  #
  # Run the test.
  #
  #  Return "true" on success
  #
  #  Return "false" on failure.
  #
  # If the test fails the details should be retrieved from "error()".
  #
  def run_test

    #
    # Reset state from previous test.
    #
    @error = nil

    #
    #  Get the hostname & port to test against.
    #
    host = @test_data["target_host"]
    port = @test_data["test_port"]

    puts "FTP testing host #{host}:#{port}" if ( @test_data['verbose'] )

    begin
      timeout(3) do

        begin
          socket = TCPSocket.new( host, port )
          socket.puts( "QUIT")

          banner = socket.gets(nil)
          banner = banner[0,20]

          socket.close()

          if ( banner =~ /^220/ )
            return true
          else
            @error = "Banner didn't report OK: #{banner}"
          end
        rescue
          @error = "FTP exception on host #{host}:#{port} - #{$!}"
          return false
        end
      end
    rescue Timeout::Error => e
      @error = "Timed-out connecting #{e}"
      return false
    end
    @error = "Misc. failure."
    return false
  end


  #
  #  Return the error.
  #
  def error
    return @error
  end

end





#
# Sample test, for testing.
#
if __FILE__ == $0 then

  #
  #  Sample data.
  #
  test = {
    "target_host" => "mirror.bytemark.co.uk",
    "test_type"   => "ftp",
    "test_port"   => 21,
    "verbose"     => 1,
    "test_alert"  => "The FTP server no worky",
  }


  #
  #  Run the test.
  #
  tst = FTPTest.new( test )
  if ( tst.run_test )
    puts "TEST OK"
  else
    puts "TEST FAILED"
    puts tst.error()
  end

end