OMF

#!/usr/bin/ruby1.8

#

# Copyright (c) 2010 National ICT Australia (NICTA), Australia

#

# 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.

#

#

#

require "oml4r"

APPNAME = "wlanmonitor"

APPPATH = "/sbin/wlanconfig"

APPVERSION = "1.2"

class MPStat < OML4R::MPBase

    name :wlanstat

    param :src_addr

    param :dst_addr

    param :aid, :type => :long

    param :channel, :type => :long

    param :rate

    param :rssi, :type => :long

    param :dbm, :type => :long

    param :idle, :type => :long

    param :txseq, :type => :long

    param :rxseq, :type => :long

    # wlanconfig returns other metrics which we ignore here

end

class Wrapper

  def process_output(output)

    # wlanconfig returns a sequence of lines

    # The 1st line is a list of labels for the fields of the remaining lines

    # Each remaining line is for a detected stations, and follows the format:

    # ADDR AID CHAN RATE RSSI DBM IDLE TXSEQ RXSEQ CAPS ACAPS ERP STATE MODE

    lines = output.split("\n")

    labels = lines.delete_at(0)

    lines.each { |row|

      column = row.split(" ")

      # Inject the measurements into OML 

      MPStat.inject("#{column[0]}", column[1], column[2],

                    "#{column[3]}", column[4], column[5],

                    column[6], column[7], column[8])

    }

  end

  def initialize(args)

    # Initialise some variable specific to this wrapper

    @interface = nil

    @interval = 1

    # Now call the Init of OML4R with the command line arguments (args)

    # and a block defining the arguments specific to this wrapper

    OML4R::init(args, :appID => APPNAME) { |argParser|

      argParser.banner = "\nExecute a wrapper around #{APPNAME}\n" +

                         "Use -h or --help for a list of options\n\n" 

      argParser.on("-i", "--interface IFNAME", 

                   "Name of Interface to monitor") { |name| @interface = name }

      argParser.on("-s", "--sampling DURATION", 

                   "Interval in second between collected samples") { |time| 

                      @interval = time 

                   }

      argParser.on_tail("-v", "--version", 

                        "Show the version\n") { |v| 

                           puts "Version: #{APPVERSION}"; exit 

                        }

    }

    # Finally do some checking specific to this wrapper

    # e.g. here we do not proceed if the user did not give us a 

    # valid interface to monitor

    unless @interface != nil

      raise "You did not specify an interface to monitor! (-i option)"

    end

  end

  def start()

    while true

      # Run the wlanconfig command with the following syntax

      #   "wlanconfig <interface> list"

      cmd = "#{APPPATH} #{@interface} list"

      output = `#{cmd}`

      # Process its output

      process_output(output)

      # Wait for a given duration and loop again

      sleep @interval.to_i

    end

  end

end

begin

  app = Wrapper.new(ARGV)

  app.start()

rescue Exception => ex

  puts "Received an Exception when executing the wrapper!"

  puts "The Exception is: #{ex}\n"

end