/*
 *  $HeadURL: svn://svn.webarts.bc.ca/open/trunk/projects/WebARTS/ca/bc/webarts/tools/isy/IsyInsteonClient.java $
 *  $Revision: 1030 $
 *  $Date: 2015-11-08 18:40:15 -0800 (Sun, 08 Nov 2015) $
 *  $Author: tgutwin $
 */
/*
 * -----------------------------------------------------------------
 * IsyInsteonClient.java
 * --------------
 *
 *  Based on the UDI example class
 *  Copyright (C) 2010 WebARTS Design, North Vancouver Canada
 *  http://www.webarts.ca
 *
 *  This program is free software; you can redistribute it and/or modify
 *  it under the terms of Version 2 of the GNU General Public License as
 *  published by the Free Software Foundation.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program; if not, write to the Free Software
 *  Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 * -----------------------------------------------------------------
 */
package ca.bc.webarts.tools.isy;

import java.io.BufferedReader;
import java.io.IOException;
import java.io.InputStreamReader;
import java.util.ArrayList;
import java.util.Enumeration;
import java.util.NoSuchElementException;
import java.util.StringTokenizer;
// import java.net.InetSocketAddress;

import com.nanoxml.XMLElement;
import com.udi.isy.jsdk.insteon.ISYInsteonClient;
import com.universaldevices.client.NoDeviceException;
import com.universaldevices.common.Constants;
import com.universaldevices.common.UDClientStatus;
import com.universaldevices.common.UDUtil;
import com.universaldevices.common.properties.UDProperty;
import com.universaldevices.device.model.IModelChangeListener;
import com.universaldevices.device.model.ProductInfo;
import com.universaldevices.device.model.UDControl;
import com.universaldevices.device.model.UDFolder;
import com.universaldevices.device.model.UDGroup;
import com.universaldevices.device.model.UDNode;
import com.universaldevices.common.Constants;
import com.universaldevices.resources.errormessages.Errors;
import com.universaldevices.security.upnp.UPnPSecurity;
import com.universaldevices.soap.UDHTTPResponse;
// import com.universaldevices.upnp.UDControlPoint;
import com.universaldevices.upnp.UDProxyDevice;
import com.universaldevices.device.model.NetworkConfig;

/**
 * This class implements a very simple ISY client which
 * prints out events as they occur in ISY
 *
 */
public class IsyInsteonClient extends ISYInsteonClient
{
  private String myUserId = "admin";
  /* DO NOT cahange the next line, it get changed at compile time to remove the password */
  private String myPassword = "11smiles";
  public static UDProxyDevice myConnectedDevice_=null;
  private NetworkConfig isyNetworkConfig_ = null;
  private boolean debug_ = false;

  private ArrayList <NodeChangeMessage> recentNodeChanges_ = null ;
  private boolean makingNodeChanges = false; // this is the node change lock

  /**
   * Constructor
   * Registers this class as IModelChangeListener
   *
   * @see IModelChangeListener
   *
   */
  public IsyInsteonClient()
  {
    super();
  }

  public IsyInsteonClient(boolean debugOn)
  {
    super();
    debug_=debugOn;
  }

  public void setDebug(boolean d)
  {
    debug_=d;
  }

  public void debugOn()
  {
    debug_=true;
  }

  public void debugOff()
  {
    debug_=false;
  }

  public void debugToggle()
  {
    debug_=!debug_;
  }

  public void unsubscribeFromEvents()
  {
    com.universaldevices.upnp.UDProxyDevice isyDevice = getDevice();
    if (isyDevice!=null) isyDevice.unsubscribeFromEvents() ;
  }


  /**
   * Send SOAP request to the connected device.
   * @param urlPath is the soap urlpath ie "/web/nodescnf.xml"
   **/
  private void submitSoapRequest(String serviceName)
  {
    if (myConnectedDevice_!=null)
    {
      String url = "";
      StringBuffer body=new StringBuffer();
      body.append("<reportURL>");
      body.append(url);
      body.append("</reportURL><duration>");
      body.append(Constants.UD_SUBSCRIPTION_DURATION);
      body.append("</duration>");

      UDHTTPResponse res = myConnectedDevice_.submitSOAPRequest(serviceName,body,UPnPSecurity.SIGN_WITH_HMAC_KEY,false,false);
      if (!res.opStat || res.body == null)
      {
        Errors.showError(res.status,null,myConnectedDevice_);
      }
      System.out.println(res.body);
    }
  }


  /**
   * This method is called when a new ISY is announced or discovered
   * on the network. For this sample, we simply authenticate ourselves
   */
  public void onNewDeviceAnnounced(UDProxyDevice device)
  {
    //if (debug_)
      System.out.println("NEW DEVICE: " + device.getFriendlyName());

  }


  /**
   * This method is invoked when ISY goes into Linking mode
   */
  public void onDiscoveringNodes()
  {
    if (debug_) System.out.println("I am in Linking Mode ...");
  }


  /**
   * This method is invoked when ISY is no longer in Linking mode
   */
  public void onNodeDiscoveryStopped()
  {
    if (debug_) System.out.println("I am no longer in Linking mode ...");

  }


  /**
   * This method is invoked when a group/scene is removed
   */
  public void onGroupRemoved(String groupAddress)
  {
    if (debug_) System.out.println("Scene: " + groupAddress + " was removed by someone or something!");

  }


  /**
   * This method is invoked when a group/scene is renamed
   */
  public void onGroupRenamed(UDGroup group)
  {
    if (debug_) System.out.println("Scene: " + group.address + " was renamed to " + group.name);

  }


  /**
   * This method snoops (retrieves) the list of recent node change messages that came in; WITHOUT removing them from the list.
   *  This method is Thread safe - it mutexes the access to the ArrayList.
   *
   * @return An ArralList filled with the NodeChangeMessages since the last time the getRecentNodeChanges method was called or null if empty.
   */
  public ArrayList<NodeChangeMessage> snoopRecentNodeChanges(){return getRecentNodeChanges(false);}


  /**
   * This method gets (and then clears) the list of recent node change messages that came in.
   *  This method is Thread safe - it mutexes the access to the ArrayList.
   *
   * @return An ArralList filled with the NodeChangeMessages since the last time this method was called or null if empty.
   */
  public ArrayList<NodeChangeMessage> getRecentNodeChanges(){return getRecentNodeChanges(true);}


  /**
   * This method gets (and then clears) the list of recent node change messages that came in.
   *  This method is Thread safe - it mutexes the access to the ArrayList.
   *
   * @param clearList flags if this method should clear the list after retrieval.
   * @return An ArralList filled with the NodeChangeMessages since the last time this method was called or null if empty.
   */
  private ArrayList<NodeChangeMessage> getRecentNodeChanges(boolean clearList)
  {
    ArrayList<NodeChangeMessage>  retVal = null;
    boolean waitingForLock = true;
    while( recentNodeChanges_!=null && waitingForLock)
    {
      if (makingNodeChanges)
      {
        UDUtil.sleep(100);
      }
      else
      {
        waitingForLock = false;
        makingNodeChanges=true;
        retVal =new ArrayList<NodeChangeMessage> ( recentNodeChanges_);
        if (clearList) recentNodeChanges_=null;
        makingNodeChanges=false;
      }
    }

    return retVal;
  }


  /**
   * This method  add the latest model change message to the stack to be consumed.
   */
  private void addToChangeMessageStack( UDNode node, UDControl control, Object value)
  {
    NodeChangeMessage msg = new NodeChangeMessage(node,  control,  value);

    boolean waitingForLock = true;
    while(waitingForLock)
    {
      if (makingNodeChanges)
      {
        UDUtil.sleep(100);
      }
      else
      {
        waitingForLock = false;
        makingNodeChanges=true;
        if (recentNodeChanges_==null) recentNodeChanges_ = new ArrayList<NodeChangeMessage> ( );
        recentNodeChanges_.add(msg);
        makingNodeChanges=false;
      }
    }
  }


  /**
   * This method is invoked everytime there's a change in the state of a control for
   * a node (Insteon Device).
   */
  public void onModelChanged(UDControl control, Object value, UDNode node)
  {

    //if (debug_) System.out.print("Someone or something changed the model: ");
    //if (debug_&& control!=null && node!=null) System.out.print(control.label+ " to "+value+" at "+node.name);

    if (debug_) System.out.print(".");

    // stack the message
    addToChangeMessageStack(node, control, value);

  }


  /**
   * This method is invoked when the network is renamed. Network is the top most node in
   * the tree in our applet.
   */
  public void onNetworkRenamed(String newName)
  {
    if (debug_) System.out.println("Ah, the network was renamed to " + newName);
  }

  /**
   * This method is called when a new group/scene has been created.
   */
  public void onNewGroup(UDGroup newGroup)
  {
    if (debug_) System.out.println("Yummy: we now have a new scene with address " + newGroup.address + " and name " + newGroup.name);
  }

  /**
   * This method is called when a new node (Insteon Device) has been added
   */
  public void onNewNode(UDNode newNode)
  {
    if (debug_) System.out.println("Yummy: we now have a new Insteon device with address " + newNode.address + " and name " + newNode.name);

  }
  /**
   * This method is called when an Insteon Device does not correctly communicate with ISY
   */
  public void onNodeError(UDNode node)
  {
    if (debug_) System.out.println("What's going on? The Insteon device at address " +
                                    node.address + " and name " + node.name +
                                  " is no longer responding to my communication attempts!");

  }
  /**
   * This method is called with a node is enabled or disabled
   * @param node
   * @param b
   */
  public void onNodeEnabled(UDNode node, boolean b)
  {
    if (debug_) System.out.println(String.format("Node %s is now %s", node.name, b ? "enabled" : "disabled"));
  }

  /**
   * This method is called when a node (Insteon Device) has been permanently removed from ISY
   */
  public void onNodeRemoved(String nodeAddress)
  {
    if (debug_) System.out.println("Whooah ... node with address " + nodeAddress + " was permanently removed from ISY");

  }
  /**
   * This method is called when a node (Insteon Device) is removed from a scene
   */
  public void onNodeRemovedFromGroup(UDNode node, UDGroup group)
  {
    if (debug_) System.out.println("Insteon device with address " + node.address + " and name " +
                                    node.name + " is no longer part of the " + group.name + " scene!");

  }

  /**
   * This method is called when a node's role changes in the given group (master/slave role).
   */
  public void onNodeToGroupRoleChanged(UDNode node, UDGroup group, char new_role)
  {
    System.out.println("Insteon device with address " + node.address + " now has a new role in group with address " + group.address + " : ");
    if (new_role == Constants.UD_LINK_MODE_MASTER)
    {
      if (debug_) System.out.println("Controller/Master");
    }
    else
    {
      if (debug_) System.out.println("Responder/Slave");
    }
  }

  /**
   * This method is invoked when a node (Insteon Device) is renamed
   */
  public void onNodeRenamed(UDNode node)
  {
    if (debug_) System.out.println("Insteon device with address " + node.address + " was renamed to " + node.name);

  }
  /**
   * This method is invoked when a node (Insteon Device) has been moved to a scene as controller/master
   */
  public void onNodeMovedAsMaster(UDNode node, UDGroup group)
  {
    if (debug_) System.out.println("Insteon device " + node.name + " is now part of the " + group.name + " scene as a master/controller");

  }
  /**
   * This method is invoked when a node (Insteon Device) has been moved to a scene as responder/slave
   */
  public void onNodeMovedAsSlave(UDNode node, UDGroup group)
  {
    if (debug_) System.out.println("Insteon device " + node.name + " is now part of the " + group.name + " scene as a slave/responder");

  }


  /**
   * This method is invoked with the library does not receive announcements from ISY and considers it offline
   */
  public void onDeviceOffLine()
  {
    if (debug_) System.out.println("oo; ISY is offLine. Did you unplug it?");

  }


  /**
   * This method is invoked when a currently known ISY (UDProxyDevice) is back on line.
   */
  public void onDeviceOnLine()
  {
    if (debug_) System.out.println("  Hooray: ISY is on line ...");
    myConnectedDevice_ = getDevice();
    if (myConnectedDevice_ == null)
    {
      return;
    }
    if (myConnectedDevice_.isSecurityEnabled() || myConnectedDevice_.securityLevel > UPnPSecurity.NO_SECURITY)
    {
      if (myConnectedDevice_.isAuthenticated && myConnectedDevice_.isOnline)
      {
        return;
      }
      try
      {
        if (debug_) System.out.print("  AUTHENTICATING/SUBSCRIBING ("+myConnectedDevice_.uuid+")...");
        authenticate(myUserId, myPassword);
        myConnectedDevice_.subscribeToEvents(true);
        if (debug_) System.out.println(" DONE");
        isyNetworkConfig_ = myConnectedDevice_.getNetworkConfig();
      }
      catch (NoDeviceException e)
      {
        System.err.println("This should never happen!");
      }
    }
    else
    {
      // just subscribe to events
      if (debug_) System.out.print("  SUBSCRIBING ... ");
      myConnectedDevice_.subscribeToEvents(true);
      if (debug_) System.out.println("DONE");
    }
  }


  /**
   * This method is invoked when the state of the system (whether or not busy) is changed
   * @param busy - whether or not ISY is busy
   */
  public void onSystemStatus(boolean busy)
  {
    if (busy)
    {
      if (debug_) System.out.println("I am busy now; please give me some reprieve and don't ask me for more!");
    }
    else
    {
      if (debug_) System.out.println("I am ready and at your service");
    }
  }


  /**
   * This method is invoked when internet access is disabled on ISY
   */
  public void onInternetAccessDisabled()
  {
    if (debug_) System.out.println("You can no longer reach me through the internet");

  }


  /**
   * This method is invoked with internet access is enabled on ISY
   * @param url - the external fully qualified url through which ISY can be accessed
   */
  public void onInternetAccessEnabled(String url)
  {
    if (debug_) System.out.println("You can now reach me remotely at: " + url);

  }


  /**
   * This method is invoked when trigger status changes.
   * @param arg1 - the status
   * @param arg2 - extra information
   */
  public void onTriggerStatus(String arg1, XMLElement arg2)
  {
    if (debug_) System.out.println("Trigger status changed: " + arg1 +": "+ arg2.getContents());

  }


  public void onDeviceSpecific(String arg1, String node, XMLElement arg2)
  {
    if (debug_) System.out.println("Device Specific action: ");
    if (debug_) System.out.println(arg2.toString());

  }


  public void onProgress(String arg1, XMLElement arg2)
  {
    if (debug_) System.out.println("Progress Report:");
    if (debug_) System.out.println(arg2.toString());
  }


  /* ****************************************************************** */
  /** Helper to tell if authenticated and ready to process  **/
  public boolean isReadyToGo()
  {
    boolean retVal = false;
    //System.out.print("^");
    if (myConnectedDevice_!=null)
    {
    //System.out.print("^");
      if (myConnectedDevice_ != null)
      {
    //System.out.print("^");
        if (myConnectedDevice_.isSecurityEnabled() || myConnectedDevice_.securityLevel > UPnPSecurity.NO_SECURITY)
        {
    //System.out.print("^");
          if (myConnectedDevice_.isAuthenticated && myConnectedDevice_.isOnline)
          {
    //System.out.print("^");
            retVal = isISYReady();
          }
        }
        else
        {
          //retVal =( myConnectedDevice_.isOnline && isISYReady());
        }
      }
    }
    //System.out.println(":"+retVal);
    return retVal;
  }


  /**
   * Implement any cleanup Routines necessary here
   */
  @Override
  public void cleanUp()
  {
    if (debug_) System.out.println("Clean up IsyClient static objects you have around");
    unsubscribeFromEvents();
    getDevice().Stop();
    super.cleanUp();

  }


  @Override
  public void onSystemConfigChanged(String event, XMLElement eventInfo)
  {
    if (debug_) System.out.println("\nSystem configuration changed");

  }


  @Override
  public void onFolderRemoved(String folderAddress)
  {
    if (debug_) System.out.println(String.format("Folder removed %s", folderAddress));

  }


  @Override
  public void onFolderRenamed(UDFolder folder)
  {
    if (debug_) System.out.println(String.format("Folder renamed %s, new name %s", folder.address, folder.name));

  }


  @Override
  public void onNewFolder(UDFolder folder)
  {
    if (debug_) System.out.println(String.format("New Folder %s, name %s", folder.address, folder.name));

  }


  @Override
  public void onNodeHasPendingDeviceWrites(UDNode node, boolean hasPending)
  {
    if (debug_) System.out.println(String.format("Node %s, %s pending device writes", node.name, hasPending ? "has" : "does not have"));

  }


  @Override
  public void onNodeIsWritingToDevice(UDNode node, boolean isWriting)
  {
    if (debug_) System.out.println(String.format("Node %s, %s being programmed", node.name, isWriting ? "is" : "is not"));

  }


  @Override
  public void onNodeParentChanged(UDNode node, UDNode newParent)
  {
    if (debug_) System.out.println(String.format("Node %s, has new parent %s", node.name, newParent.name));

  }


  @Override
  public void onNodePowerInfoChanged(UDNode node)
  {
    if (debug_) System.out.println("Not supported ");

  }


  /* (non-Javadoc)
   * @see com.universaldevices.device.model.IModelChangeListener#onNodeDeviceIdChanged(com.universaldevices.upnp.UDProxyDevice, com.universaldevices.device.model.UDNode)
   */
  @Override
  public void onNodeDeviceIdChanged(UDProxyDevice device, UDNode node)
  {
    // TODO Auto-generated method stub

  }


  /* (non-Javadoc)
   * @see com.universaldevices.device.model.IModelChangeListener#onNodeDevicePropertiesRefreshed(com.universaldevices.upnp.UDProxyDevice, com.universaldevices.device.model.UDNode)
   */
  @Override
  public void onNodeDevicePropertiesRefreshed(UDProxyDevice device, UDNode node)
  {
    // TODO Auto-generated method stub

  }


  /* (non-Javadoc)
   * @see com.universaldevices.device.model.IModelChangeListener#onNodeDevicePropertiesRefreshedComplete(com.universaldevices.upnp.UDProxyDevice)
   */
  @Override
  public void onNodeDevicePropertiesRefreshedComplete( UDProxyDevice proxyDevice)
  {
    // TODO Auto-generated method stub

  }


  /* (non-Javadoc)
   * @see com.universaldevices.device.model.IModelChangeListener#onNodeDevicePropertyChanged(com.universaldevices.upnp.UDProxyDevice, com.universaldevices.device.model.UDNode, com.universaldevices.common.properties.UDProperty)
   */
  @Override
  public void onNodeDevicePropertyChanged(UDProxyDevice device, UDNode node, UDProperty<?> property)
  {
    // TODO Auto-generated method stub

  }


  /* (non-Javadoc)
   * @see com.universaldevices.device.model.IModelChangeListener#onNodeRevised(com.universaldevices.upnp.UDProxyDevice, com.universaldevices.device.model.UDNode)
   */
  @Override
  public void onNodeRevised(UDProxyDevice device, UDNode node)
  {
    // TODO Auto-generated method stub

  }


  /* (non-Javadoc)
   * @see com.universaldevices.device.model.IModelChangeListener#onNodeErrorCleared(com.universaldevices.upnp.UDProxyDevice, com.universaldevices.device.model.UDNode)
   */
  @Override
  public void onNodeErrorCleared(UDProxyDevice arg0, UDNode arg1)
  {    // as of jsdk 3.1.17
    // TODO Auto-generated method stub

  }


  /* (non-Javadoc)
   * @see com.universaldevices.device.model.IModelChangeListener#onLinkerEvent(com.universaldevices.upnp.UDProxyDevice, java.lang.String, com.nanoxml.XMLElement)
   */
  @Override
  public void onLinkerEvent(UDProxyDevice arg0, String arg1, XMLElement arg2)
  {   // as of jsdk 4.2.18
    // TODO Auto-generated method stub

  }


  /* (non-Javadoc)
   * @see com.universaldevices.device.model.IModelChangeListener#onNodeSupportedTypeInfoChanged(com.universaldevices.upnp.UDProxyDevice, java.lang.String)
   */
  @Override
  public void onNodeSupportedTypeInfoChanged(UDProxyDevice arg0, String arg1)
  {   // as of jsdk 4.2.18
    // TODO Auto-generated method stub

  }

}