package org.wcb.plugins.beans;
   
   import org.wcb.autohome.AutoHomeDaemonSession;
   import org.wcb.autohome.exceptions.HomeException;
   import org.wcb.autohome.interfaces.IX10Module;
   import org.wcb.autohome.interfaces.X10DeviceConstants;
   
   import java.util.Vector;
   
  import org.wcb.autohome.implementations.X10Module;
  import org.wcb.autohome.implementations.Macro;
  import javax.servlet.http.HttpServletRequest;
  /*
  * Copyright (C) 1999  Walter Bogaardt
  *
  * This library is free software; you can redistribute it and/or
  * modify it under the terms of the GNU Lesser General Public
  * License as published by the Free Software Foundation; either
  * version 2 of the License, or (at your option) any later version.
  *
  * This library 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
  * Lesser General Public License for more details.
  *
  * You should have received a copy of the GNU Lesser General Public
  * License along with this library; if not, write to the Free Software
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307
  *
  *   Project:   Home Automation Interface
  *  Filename:  $Id: X10WebComponent.java,v 1.20 2004/02/03 21:02:27 wbogaardt Exp $
  *  Abstract:  Web bean for x10 jsp.
  *
  * $Log: X10WebComponent.java,v $
  * Revision 1.20  2004/02/03 21:02:27  wbogaardt
  * moved DeviceFactory away from rmi creation and simplified interface between gateway
  *
  * Revision 1.19  2004/01/16 00:53:43  wbogaardt
  * Fixed a very obscure bug with the Macro Panel that it didn't added new
  * x10 devices to the drop down of available x10 device for the macro. Modified Macro triggers to change the events to integer verses strings cleaner this way.
  *
  * Revision 1.18  2004/01/15 21:05:20  wbogaardt
  * major revamp of Modules and interfaces changes overall structure of how information is stored
  *
  * Revision 1.17  2003/12/18 06:10:15  wbogaardt
  * fixed problem with componets sending command
  *
  * Revision 1.16  2003/12/17 23:34:57  wbogaardt
  * fixed capturing of house code to pass it to upper case.
  *
  * Revision 1.15  2003/12/17 21:27:06  wbogaardt
  * Improved error traping of CM11A send command to all house
  *
  * Revision 1.14  2003/12/16 22:08:37  wbogaardt
  * refactored events daemon handeling
  *
  * Revision 1.13  2003/12/13 00:29:09  wbogaardt
  * added cm11a gateway montitor listener option.
  *
  * Revision 1.12  2003/12/12 23:17:36  wbogaardt
  * javadoc comments refactored methods so they are more descriptive
  *
  * Revision 1.11  2003/12/12 05:13:30  wbogaardt
  * fixed web component to say the module description
  *
  * Revision 1.10  2003/12/12 04:27:47  wbogaardt
  * added some speech ability to web interface
  *
  * Revision 1.9  2003/12/11 22:01:41  wbogaardt
  * removed deprecated method of loading speach engine also removed reference to autohome adminsession from X10WebComponent
  *
  * Revision 1.8  2003/12/10 22:48:15  wbogaardt
  * trap error and do not send x10 command through interface if it determined that serial port is not connected
  *
  * Revision 1.7  2003/12/10 19:24:42  wbogaardt
  * Added new serial port controller bean and modified X10Webcomponent
  *
  * Revision 1.6  2003/12/09 21:36:53  wbogaardt
  * modified Session objects so that works with gui app as well as web app. Extended functionality of serial page in web app, and improved error traping of exceptions
  *
  * Revision 1.5  2003/12/09 00:37:06  wbogaardt
  * moved methods from authomAdminSession to parent class
  *
  * Revision 1.4  2003/12/08 23:46:04  wbogaardt
  * added javadoc comments and cleaned up Main class
  *
  */
  public class X10WebComponent {
  
      public static String X10_HOUSE_CODE = "house";
      public static String X10_MODULE_ID = "id";
      public static String ON_BUTTON = "on";
      public static String OFF_BUTTON = "off";
      public static String EXECUTE_BUTTON = "execute";
      public static String COMMAND = "command";
      public static String DESCRIPTION = "description";
  
      public X10WebComponent(){
      }
 
     /***
      * Gets a list of all the saved X10 modules.
      * @return Vector of IX10Module
      */
     public Vector getAllX10Modules(){
         Vector _returnVal = AutoHomeDaemonSession.getInstance().loadAllX10Devices();
         if(_returnVal!=null){
             return _returnVal;
         }
         _returnVal=new Vector();
         _returnVal.addElement(new X10Module());
         return _returnVal;
     }
 
     /***
      * Returns the string name of the saved serial port
      * @return String of saved serial port name.
      */
     public String getSavedSerialPort(){
         return  AutoHomeDaemonSession.getInstance().getSerialPort().getPort();
     }
 
     /***
      * If the serial port is active then return a printable string
      * indicating connected. Otherwise, return a printable string disconnected.
      *
      * @return String of "Connected" or "Disconnected"
      */
     public String getIsPortConnected(){
         if(AutoHomeDaemonSession.getInstance().isX10GatwayConnected())
             return "Connected";
         else
             return "Disconnected";
     }
 
     /***
      * This will return a vector of X10Event these
      * can be cast to the IX10Event interface
      * @return a vector of IMacro objects
      */
     public Vector getMacros(){
         Vector _returnVal = AutoHomeDaemonSession.getInstance().loadAllCM11AMacros();
         if(_returnVal!=null){
             return _returnVal;
         }
         _returnVal=new Vector();
         _returnVal.addElement(new Macro());
         return _returnVal;
     }
 
     /***
      * Process request information when users do form submits
      * based on this we will save the keys, save the file, read
      * in a new directory's build.properties file or run the ANT
      * build script.
      * @param request servlet form post request.
      */
     public void processRequest(HttpServletRequest request) {
         if(request.getMethod().equalsIgnoreCase("post"))
         {
             String action = request.getParameter("action");
             if(action!=null)
             {
                 char cHouse = this.getHouseCode(request.getParameter(X10_HOUSE_CODE));
                 int iId = this.getDeviceCode(request.getParameter(X10_MODULE_ID));
                 String sDescription = request.getParameter(DESCRIPTION);
                 if(AutoHomeDaemonSession.getInstance().isX10GatwayConnected())
                 {
                     if(action.equalsIgnoreCase(ON_BUTTON))
                     {
                         IX10Module module = new X10Module(cHouse,iId,"Name",sDescription,X10DeviceConstants.APPLIANCE_MODULE_ON);
                         this.sendCommandToX10Module(module,X10DeviceConstants.ON_ACTION);
                     }
                     if(action.equalsIgnoreCase(OFF_BUTTON))
                     {
                         IX10Module module = new X10Module(cHouse,iId,"Name",sDescription,X10DeviceConstants.APPLIANCE_MODULE_ON);
                         this.sendCommandToX10Module(module,X10DeviceConstants.OFF_ACTION);
                     }
                     if(action.equalsIgnoreCase(EXECUTE_BUTTON))
                     {
                         int iCommand = Integer.parseInt(request.getParameter(COMMAND));
                         this.sendCommandToSection(cHouse,iCommand);
                     }
                 }
             }
         }
     }
 
     /***
      * Sends the module interface and the command to that module off
      * through the x10 gateway.
      * @param module
      * @param iCmd
      * @return
      */
     private boolean sendCommandToX10Module(IX10Module module, int iCmd)
     {
         try
         {
 	    switch(iCmd)
 		{
 		   case X10DeviceConstants.OFF_ACTION:
 	    		AutoHomeDaemonSession.getInstance().printMessage("Turning off "+module.getDescription());
 		        break;
 		   case X10DeviceConstants.ON_ACTION:
 			    AutoHomeDaemonSession.getInstance().printMessage("Turning on "+module.getDescription());
 		        break;
 		 }
             AutoHomeDaemonSession.getInstance().sendCommandToX10Module(module,iCmd);
         }
         catch(HomeException he)
         {
             return false;
         }
         return true;
     }
 
     /***
      * Sends an all command to a section or house code. The
      * house code can be a character between A - P.
      * The commands are 0 - all lights off; 1 - all lights on;
      * 2 - all modules off;
      * @param cHouse Valid A - P
      * @param iCmd Valid 0 - 2
      * @return Success or fail
      */
     private boolean sendCommandToSection(char cHouse, int iCmd)
     {
         try
         {
             AutoHomeDaemonSession.getInstance().sendCommandToSection(cHouse,iCmd);
         } catch(HomeException err) {
             return false;
         }
         return true;
     }
 
     /***
      * Gets the first position in the DeviceID text field
      * and returns a Upper Case Character value.
      */
     private char getHouseCode(String sDeviceID)
     {
         char cReturnValue='A';
         try
         {
             cReturnValue = sDeviceID.toUpperCase().charAt(0);
         }
         catch(Exception err)
         {
             cReturnValue = 'A';
         }
         return cReturnValue;
     }
 
     /***
      * Gets the last positions in the DeviceID text field
      * and returns an integer value.  If the entered integers
      * are greater than 16 then 16 is returned;
      */
     private int getDeviceCode(String sDeviceID)
     {
         int returnValue = 0;
         try
         {
             returnValue = Integer.parseInt(sDeviceID);
         }
         catch(Exception err)
         {
                   returnValue = 1;
         }
         if (returnValue >16)
         {
             //invalude digit
             returnValue = 16;
         }
         return returnValue;
     }
 }