####################################################################################################
# @author       David Kirwan <davidkirwanirl@gmail.com>
# @description  Node Management class for the Ardtweeno Mesh Network
#
# @date         21-02-2013
####################################################################################################

# Imports
require 'rubygems'
require 'logger'
require 'yaml'
require 'json'
require 'ardtweeno'
require 'typhoeus'


module Ardtweeno
  
  ##
  # Ardtweeno::NodeManager class for the Ardtweeno Mesh Network
  #
  class NodeManager
    
    attr_accessor :nodeList, :zones, :log, :watchlist
    
    
    ##
    # Ardtweeno::NodeManager#new constructor
    #
    # * *Args*    :
    #   - ++ ->   options Hash{:log Logger, :nodelist Array[Ardtweeno::Node]}
    # * *Returns* :
    #   -
    # * *Raises* :
    #
    def initialize(options={})
      @log = Ardtweeno.options[:log] ||= Logger.new(STDOUT)
      @log.level = Ardtweeno.options[:level] ||= Logger::DEBUG
      
      @watchlist = Array.new
      
      @nodeList = options[:nodelist] ||= Array.new 
    end


    ##
    # Ardtweeno::NodeManager#flush empties the packetqueue inside each Ardtweeno:Node
    #
    # * *Args*    :
    #   - ++ ->   
    # * *Returns* :
    #   -         
    # * *Raises* :
    #   -         
    #
    def flush()
      @nodeList.each do |i|
        i.packetqueue = Array.new
      end
    end



    ##
    # Ardtweeno::NodeManager#addNode adds an Ardtweeno::Node to the managed node list
    #
    # * *Args*    :
    #   - ++ ->   Ardtweeno::Node
    # * *Returns* :
    #   -         true || false
    # * *Raises* :
    #   -         Ardtweeno::NotANode
    #
    def addNode(node)
      if node.class == Ardtweeno::Node
        @log.debug "Size of nodeList before addition: #{@nodeList.size}"
        @nodeList << node
        @log.debug "Size of nodeList after addition: #{@nodeList.size}"
        
        return true
      else
        raise Ardtweeno::NotANode, "Error Ardtweeno::NodeManager#addNode expects an Ardtweeno::Node as a parameter"
      end
    end


    ##
    # Ardtweeno::NodeManager#removeNode removes an Ardtweeno::Node from the managed nodeList
    #
    # * *Args*    :
    #   - ++ ->   {:node, :key}
    # * *Returns* :
    #   -         Ardtweeno::Node
    # * *Raises* :
    #   -         Ardtweeno::NotInNodeList
    #    
    def removeNode(options={})
      @log.debug "removeNode function called, searching for node in list"
      
      begin
        found = search(options)
        @nodeList.delete(found)
        
        return found
        
      rescue Ardtweeno::NotInNodeList
        return nil
      end
      
    end


    ##
    # Ardtweeno::NodeManager#search provides an interface to search the managed Ardtweeno::Node list
    # takes a single parameter hash, expects :node or :key search strings corresponding with the
    # Ardtweeno::Node you wish to search for, and returns this Node if found
    # Raises Ardtweeno::NotInNodeList exception if entry not found in the list
    #
    # * *Args*    :
    #   - ++ ->   options Hash{:node String, :key String}
    # * *Returns* :
    #   -         Ardtweeno::Node
    # * *Raises* :
    #   -         Ardtweeno::NotInNodeList
    #    
    def search(options={})
      key = options[:key] ||= nil
      node = options[:node] ||= nil
      
      if key.nil? and node.nil? then 
        raise Ardtweeno::NotInNodeList, "Error key does not match any Ardtweeno::Node being maintained by this Ardtweeno::NodeManager"
      end
      
      unless key.nil? then 
        @log.debug "Searching the Nodelist for key: " + key
        
        @nodeList.each do |i|
          @log.debug "Comparing #{key} with #{i.key}"
          if i.key == key
            @log.debug "Match found, returning node"
            return i       
          end
        end
        
      end
      
      unless node.nil? then
        @log.debug "Searching the Nodelist for node: " + node
        
        @nodeList.each do |i|
          @log.debug "Comparing #{node} with #{i.node}"
          if i.node == node
            @log.debug "Match found, returning #{i.to_s}"
            return i       
          end
        end
      end
      
      
      @log.debug "Node not found!"
      # Raise NotInNodeList exception if list has been traversed and a corresponding node was
      # not found
      raise Ardtweeno::NotInNodeList, "Error key does not match any Ardtweeno::Node being maintained by this Ardtweeno::NodeManager"
    end
    
    
    ##
    # Ardtweeno::NodeManager#watched? checks if a node has been added to a watchlist
    #
    # * *Args*    :
    #   - ++ ->   Ardtweeno::Node node
    # * *Returns* :
    #   -         True || False
    # * *Raises* :
    #   -         
    #
    def watched?(node)
      
      @watchlist.each do |i|
        
        @log.debug "Comparing " + i[:node] + " and " + node.node
        if i[:node] == node.node 
          return true
        end
      end
      
      return false
      
    end
    
    
    ##
    # Ardtweeno::NodeManager#addWatch adds a node to the watchlist
    #
    # * *Args*    :
    #   - ++ ->   String node, Hash watch { String :node, String :notifyURL, 
    #                                       String :method, String :timeouts }
    # * *Returns* :
    #   -        
    # * *Raises* :
    #   -         Ardtweeno::NotInNodeList
    #
    def addWatch(params)
      begin
        node = search({:node=>params[:node]})
        @log.debug "Found Node: " + node.inspect
        
        if watched?(node)
          raise Ardtweeno::AlreadyWatched
        end
        
        watch = { :node=>params[:node], 
                  :notifyURL=> params[:notifyURL],
                  :method=>params[:method], 
                  :timeout=>params[:timeout] 
                }
        
        @log.debug "Adding watch: " + watch.inspect
        
        @watchlist << watch
      
      rescue Ardtweeno::AlreadyWatched => e
        raise e
      rescue Ardtweeno::NotInNodeList => e
        raise e
      rescue Exception => e
        raise e
      end
    end
    
    
    ##
    # Ardtweeno::NodeManager#removeWatch removes a node from the watchlist
    #
    # * *Args*    :
    #   - ++ ->   String node
    # * *Returns* :
    #   -        
    # * *Raises* :
    #   -         Ardtweeno::NotInNodeList
    #
    def removeWatch(node)
      begin
        node = search({:node=>node})
        
        @watchlist.each do |i|
          if i[:node] == node.node
            @watchlist.delete(i)
          end
        end
        
      rescue Ardtweeno::NotInNodeList => e
        raise e
      end
    end
    
    
    ##
    # Ardtweeno::NodeManager#pushNotification pushes a notification to the node watcher
    #
    # * *Args*    :
    #   - ++ ->   String node
    # * *Returns* :
    #   -         
    # * *Raises* :
    #   -         
    #
    def pushNotification(node)
      
      @log.debug "Traversing watchlist"
      @watchlist.each do |i|
        
        @log.debug "Comparing " + i[:node].node + " to " + node
                
        if i[:node].node == node
          
          @log.debug "Associated watch found, checking for method " + i[:method]
          
          if i[:method] == "POST"
            @log.debug "HTTP POST method executing"
            @log.debug "URL: #{i[:notifyURL]}"
            @log.debug "Title: Push notification"
            @log.debug "Content: #{i[:node].node}"
            @log.debug "Code: #{i[:node].to_s}"
            
            Typhoeus::Request.post(i[:notifyURL], 
                                     :body=> { :title=>"Push notification",
                                               :content=>"#{i[:node].node}",
                                               :code=>""})
          elsif i[:method] == "GET"
            @log.debug "HTTP GET method executing" 
            Typhoeus::Request.get(i[:notifyURL], 
                                    :body=> { :title=>"Push notification",
                                              :content=>"#{i[:node].node}",
                                              :code=>""})
          end

        end
      end
      
    end
    
    
    
  end
end