application/hub/main/factories/states/peer/class_PeerStateFactory.php

   1 <?php
   2 /**
   3  * A factory class for peer states
   4  *
   5  * @author              Roland Haeder <webmaster@ship-simu.org>
   6  * @version             0.0.0
   7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2011 Hub Developer Team
   8  * @license             GNU GPL 3.0 or any newer version
   9  * @link                http://www.ship-simu.org
  10  *
  11  * This program is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU General Public License as published by
  13  * the Free Software Foundation, either version 3 of the License, or
  14  * (at your option) any later version.
  15  *
  16  * This program is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU General Public License for more details.
  20  *
  21  * You should have received a copy of the GNU General Public License
  22  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  23  */
  24 class PeerStateFactory extends ObjectFactory {
  25         /**
  26          * Static lookup table instance
  27          */
  28         private static $tableInstance = NULL;
  29
  30         /**
  31          * Protected constructor
  32          *
  33          * @return      void
  34          */
  35         protected function __construct () {
  36                 // Call parent constructor
  37                 parent::__construct(__CLASS__);
  38         }
  39
  40         /**
  41          * Singleton getter for lookup table instances, kept public if we need this
  42          * table somewhere else.
  43          *
  44          * @return      $tableInstance  An instance of a lookup table
  45          */
  46         public static final function getTableInstance () {
  47                 // Is the instance null?
  48                 if (is_null(self::$tableInstance)) {
  49                         // Get a new one
  50                         self::$tableInstance = self::createObjectByConfiguredName('peer_state_lookup_db_wrapper_class');
  51                 } // END - if
  52
  53                 // Return it
  54                 return self::$tableInstance;
  55         }
  56
  57         /**
  58          * Creates a peer state instance based on errorCode if no entry is found in the lookup table
  59          * for the peer given in $packageData 'sender' element or it changes the state if it differs
  60          * from current state.
  61          *
  62          * @param       $helperInstance         An instance of a ConnectionHelper class
  63          * @param       $packageData            Raw package data
  64          * @param       $socketResource         A valid socket resource
  65          * @param       $errorCode                      The last error code
  66          * @return      $stateInstance          A Stateable class instance
  67          */
  68         public static final function createPeerStateInstanceBySocketStatusCode (ConnectionHelper $helperInstance, array $packageData, $socketResource, $errorCode) {
  69                 // So first we need our lookup table
  70                 $tableInstance = self::getTableInstance();
  71
  72                 // Purge old entries
  73                 try {
  74                         $tableInstance->purgeOldEntriesBySocketResource($socketResource);
  75                 } catch (InvalidSocketException $e) {
  76                         // Just log all errors
  77                         $tableInstance->debugOutput('PEER-STATE-FACTORY: Purging of old entries failed. Message from exception: ' . $e->getMessage());
  78                 }
  79
  80                 // Do we have an entry?
  81                 if ($tableInstance->isSenderNewPeer($packageData)) {
  82                         // Debug output
  83                         $tableInstance->debugOutput('PEER-STATE-FACTORY: errorCode=' . $errorCode);
  84
  85                         // Is a new peer so create the state instance based on error code, first we need a config entry
  86                         $configEntry = 'peer_' . $errorCode . '_state_class';
  87
  88                         // Register the new peer with its session id
  89                         $tableInstance->registerPeerByPackageData($packageData, $socketResource);
  90
  91                         // Then get it
  92                         $stateInstance = self::createObjectByConfiguredName($configEntry);
  93
  94                         // And register it with the lookup table
  95                         $tableInstance->registerPeerState($stateInstance, $packageData);
  96                 } else {
  97                         // It is a known peer, so we need to check if the state has changed
  98                         $tableInstance->debugBackTrace(__METHOD__ . ': Lookup!' . "\n");
  99                 }
 100
 101                 // Debug message
 102                 $stateInstance->debugOutput('PEER-STATE[' . __LINE__ . ']: Has changed from ' . $helperInstance->getPrintableState() . ' to ' . $stateInstance->getStateName() . '.');
 103
 104                 // Set the state in the helper
 105                 $helperInstance->setStateInstance($stateInstance);
 106
 107                 // For any purposes, return the state instance
 108                 return $stateInstance;
 109         }
 110
 111         /**
 112          * Creates an instance of a configurable peer state and sets it in the
 113          * given peer instance.
 114          *
 115          * @param       $stateName                      Name of the state
 116          * @param       $helperInstance         A ConnectionHelper class instance
 117          * @return      $stateInstance          A Stateable class instance
 118          */
 119         public static final function createPeerStateInstanceByName ($stateName, ConnectionHelper $helperInstance) {
 120                 // Then construct the class' configuraton entry
 121                 $className = 'peer_' . $stateName . '_state_class';
 122
 123                 // Get a class from that configuration entry
 124                 $stateInstance = self::createObjectByConfiguredName($className, array($helperInstance));
 125
 126                 // Debug message
 127                 $stateInstance->debugOutput('PEER-STATE[' . __LINE__ . ']: Has changed from ' . $helperInstance->getPrintableState() . ' to ' . $stateInstance->getStateName() . ' (' . $stateInstance->__toString() . ').');
 128
 129                 // Once we have that state, set it in the peer instance
 130                 $helperInstance->setStateInstance($stateInstance);
 131
 132                 // For any purposes, return the state instance
 133                 return $stateInstance;
 134         }
 135 }
 136
 137 // [EOF]
 138 ?>