/*
    * AI Soccer Project - network gaming environment for AI warriors.
    * Copyright (C) 2001-2004  Marcin Werla, Pawel Widera
    *
    * This program is free software; you can redistribute it and/or
    * modify it under the terms of the GNU General Public License
    * as published by the Free Software Foundation; either version 2
    * of the License, or (at your option) any later version.
    *
   * 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, you can find it here:
   * http://www.gnu.org/licenses/gpl.html
   */
  
  package snifos.application.test;
  
  import org.apache.log4j.Logger;
  
  import org.custommonkey.xmlunit.Diff;
  
  import org.dom4j.Document;
  import org.dom4j.DocumentHelper;
  
  import snifos.application.Application;
  
  import snifos.common.UserId;
  
  import snifos.common.test.DummyMessages;
  
  import snifos.exception.InvalidUserException;
  
  import snifos.server.Server;
  
  import java.util.ArrayList;
  import java.util.Collection;
  import java.util.Properties;
  
  
  /***
   * This is simple implementation of Application interface. It's configuration
   * should contain only one property named "userId" which value should be
   * integer number. This application accepts user only when user id in user's
   * communication module can be divided by "userId" without remainder.
   *
   * @version $Id: DummyApplication.java,v 1.2 2004/05/08 21:55:30 mwerla Exp $
   */
  public class DummyApplication implements Application {
      private static Logger logger = Logger.getLogger(DummyApplication.class);
      private Server server;
      private int moduloFactor = 1;
      private Collection registeredUsers = new ArrayList();
  
      /***
       * Just dummy constructor - does nothing.
       */
      public DummyApplication() {
          logger.info("Application created " + this);
      }
  
      /***
       * @see Application#configure(Properties, boolean)
       */
      public void configure(Properties configuration, boolean isUnique) {
          if (configuration.getProperty("userId") != null) {
              moduloFactor = Integer.parseInt(configuration.getProperty("userId"));
          }
  
          logger.info("Application configured. Modulo factor = " + moduloFactor);
      }
  
      /***
       * @see Application#setServer(Server)
       */
      public void setServer(Server server) {
          logger.info("Server set in application");
          this.server = server;
      }
  
      /***
       * @see Application#unregisterUser(UserId)
       */
      public void unregisterUser(UserId userId) {
          registeredUsers.remove(userId);
          logger.info("User " + userId + " unregistered from application");
      }
  
      /***
       * @todo This method should be rewritten in some flexible way...
       * @see Application#receiveMessage(UserId, Document)
       */
      public void receiveMessage(UserId userId, Document message) {
          logger.info("Message \"" + message.asXML() + "\" from " + userId +
              " recevied (" + moduloFactor + ")");
  
         try {
             if (registeredUsers.contains(userId)) {
                 Diff d = new Diff(message.asXML(), DummyMessages.requests[1]);
                 assert d.identical();
             } else {
                 Diff d = new Diff(message.asXML(), DummyMessages.requests[0]);
                 assert d.identical();
                 server.sendMessage(userId,
                     DocumentHelper.parseText(DummyMessages.responses[0]));
                 server.sendMessage(userId,
                     DocumentHelper.parseText(DummyMessages.responses[1]));
                 registeredUsers.add(userId);
             }
         } catch (Exception e) {
             throw new RuntimeException(e);
         }
     }
 
     /***
     * Method not implemented.
     * @see java.lang.Runnable#run()
     */
     public void run() {
         //There is nothing needed here.
     }
 
     /***
     * This application accepts user only when user id in user's
      * communication module can be divided by "userId" configuration parameter
     * without remainder.
     * @see Application#registerUser(UserId, Document)
     */
     public void registerUser(UserId userId, Document message)
         throws InvalidUserException {
         if ((userId.getUserIdInModule() % moduloFactor) != 0) {
             throw new InvalidUserException();
         }
     }
 }