application/city/main/city_daemon/class_BaseCityDaemon.php

   1 <?php
   2 /**
   3  * A general City class
   4  *
   5  * @author              Roland Haeder <webmaster@shipsimu.org>
   6  * @version             0.0.0
   7  * @copyright   Copyright (c) 2015 City Developer Team
   8  * @license             GNU GPL 3.0 or any newer version
   9  * @link                http://www.shipsimu.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 BaseCityDaemon extends BaseCitySystem implements Updateable, AddableCriteria {
  25         /**
  26          * City types
  27          */
  28         const CITY_TYPE_DEFAULT = 'default';
  29         const CITY_TYPE_TESTING = 'testing';
  30
  31         /**
  32          * Whether this City is active (default: FALSE)
  33          */
  34         private $isActive = FALSE;
  35
  36         /**
  37          * Protected constructor
  38          *
  39          * @param       $className      Name of the class
  40          * @return      void
  41          */
  42         protected function __construct ($className) {
  43                 // Call parent constructor
  44                 parent::__construct($className);
  45
  46                 // Get a wrapper instance
  47                 $wrapperInstance = DatabaseWrapperFactory::createWrapperByConfiguredName('city_info_db_wrapper_class');
  48
  49                 // Set it here
  50                 $this->setWrapperInstance($wrapperInstance);
  51
  52                 // Get a crypto instance
  53                 $cryptoInstance = ObjectFactory::createObjectByConfiguredName('crypto_class');
  54
  55                 // Set it here
  56                 $this->setCryptoInstance($cryptoInstance);
  57
  58                 // Add own instance to registry
  59                 Registry::getRegistry()->addInstance('city', $this);
  60
  61                 // Init state which sets the state to 'init'
  62                 $this->initState();
  63         }
  64
  65         /**
  66          * Initializes the City's state which sets it to 'init'
  67          *
  68          * @return      void
  69          */
  70         private function initState() {
  71                 // Get the state factory and create the initial state.
  72                 CityStateFactory::createCityStateInstanceByName('init');
  73         }
  74
  75         /**
  76          * Outputs the console teaser. This should only be executed on startup or
  77          * full restarts. This method generates some space around the teaser.
  78          *
  79          * @return      void
  80          */
  81         public function outputConsoleTeaser () {
  82                 // Get the app instance (for shortening our code)
  83                 $app = $this->getApplicationInstance();
  84
  85                 // Output all lines
  86                 self::createDebugInstance(__CLASS__)->debugOutput(' ');
  87                 self::createDebugInstance(__CLASS__)->debugOutput($app->getAppName() . ' v' . $app->getAppVersion() . ' - ' . $this->getRequestInstance()->getRequestElement('mode') . ' daemon starting');
  88                 self::createDebugInstance(__CLASS__)->debugOutput('Copyright (c) 2015 City Developer Team');
  89                 self::createDebugInstance(__CLASS__)->debugOutput(' ');
  90                 self::createDebugInstance(__CLASS__)->debugOutput('This program comes with ABSOLUTELY NO WARRANTY; for details see docs/COPYING.');
  91                 self::createDebugInstance(__CLASS__)->debugOutput('This is free software, and you are welcome to redistribute it under certain');
  92                 self::createDebugInstance(__CLASS__)->debugOutput('conditions; see docs/COPYING for details.');
  93                 self::createDebugInstance(__CLASS__)->debugOutput(' ');
  94         }
  95
  96         /**
  97          * Adds City data elements to a given dataset instance
  98          *
  99          * @param       $criteriaInstance       An instance of a storeable criteria
 100          * @param       $requestInstance        An instance of a Requestable class
 101          * @return      void
 102          */
 103         public function addElementsToDataSet (StoreableCriteria $criteriaInstance, Requestable $requestInstance = NULL) {
 104                 // Make sure the request instance is set as it is not optional.
 105                 assert($requestInstance instanceof Requestable);
 106
 107                 // Add City number and type
 108                 $criteriaInstance->addCriteria(CityInformationDatabaseWrapper::DB_COLUMN_CITY_ID  , 1);
 109                 $criteriaInstance->addCriteria(CityInformationDatabaseWrapper::DB_COLUMN_CITY_MODE, $requestInstance->getRequestElement('mode'));
 110
 111                 // Add the City id
 112                 $criteriaInstance->addCriteria(CityInformationDatabaseWrapper::DB_COLUMN_CITY_ID, $this->getCityId());
 113
 114                 // Add the session id if acquired
 115                 if ($this->getSessionId() != '') {
 116                         $criteriaInstance->addCriteria(CityInformationDatabaseWrapper::DB_COLUMN_SESSION_ID, $this->getSessionId());
 117                 } // END - if
 118
 119                 // Add the private key if acquired
 120                 if ($this->getPrivateKey() != '') {
 121                         $criteriaInstance->addCriteria(CityInformationDatabaseWrapper::DB_COLUMN_PRIVATE_KEY, base64_encode($this->getPrivateKey()));
 122                         $criteriaInstance->addCriteria(CityInformationDatabaseWrapper::DB_COLUMN_PRIVATE_KEY_HASH, $this->getPrivateKeyHash());
 123                 } // END - if
 124
 125                 // Add own external and internal addresses as UNLs
 126                 $criteriaInstance->addCriteria(CityInformationDatabaseWrapper::DB_COLUMN_INTERNAL_UNL, CityTools::determineOwnInternalAddress());
 127                 $criteriaInstance->addCriteria(CityInformationDatabaseWrapper::DB_COLUMN_EXTERNAL_UNL, CityTools::determineOwnExternalAddress());
 128         }
 129
 130         /**
 131          * Updates a given field with new value
 132          *
 133          * @param       $fieldName              Field to update
 134          * @param       $fieldValue             New value to store
 135          * @return      void
 136          * @throws      DatabaseUpdateSupportException  If this class does not support database updates
 137          * @todo        Try to make this method more generic so we can move it in BaseFrameworkSystem
 138          */
 139         public function updateDatabaseField ($fieldName, $fieldValue) {
 140                 // Unfinished
 141                 $this->partialStub('Unfinished!');
 142                 return;
 143
 144                 // Get a critieria instance
 145                 $searchInstance = ObjectFactory::createObjectByConfiguredName('search_criteria_class');
 146
 147                 // Add search criteria
 148                 $searchInstance->addCriteria(UserDatabaseWrapper::DB_COLUMN_USERNAME, $this->getUserName());
 149                 $searchInstance->setLimit(1);
 150
 151                 // Now get another criteria
 152                 $updateInstance = ObjectFactory::createObjectByConfiguredName('update_criteria_class');
 153
 154                 // Add criteria entry which we shall update
 155                 $updateInstance->addCriteria($fieldName, $fieldValue);
 156
 157                 // Add the search criteria for searching for the right entry
 158                 $updateInstance->setSearchInstance($searchInstance);
 159
 160                 // Set wrapper class name
 161                 $updateInstance->setWrapperConfigEntry('user_db_wrapper_class');
 162
 163                 // Remember the update in database result
 164                 $this->getResultInstance()->add2UpdateQueue($updateInstance);
 165         }
 166
 167         /**
 168          * Activates the City by doing some final preparation and setting
 169          * $CityIsActive to TRUE.
 170          *
 171          * @param       $requestInstance        A Requestable class
 172          * @param       $responseInstance       A Responseable class
 173          * @return      void
 174          */
 175         public function activateCityDaemon (Requestable $requestInstance, Responseable $responseInstance) {
 176                 // Get the controller here
 177                 $controllerInstance = Registry::getRegistry()->getInstance('controller');
 178
 179                 // Run all filters for the City activation
 180                 $controllerInstance->executeActivationFilters($requestInstance, $responseInstance);
 181
 182                 // Make sure the city's state is 'init'
 183                 $this->getStateInstance()->validateCityStateIsInit();
 184
 185                 // ----------------------- Last step from here ------------------------
 186                 // Activate the city daemon. This is ALWAYS the last step in this method
 187                 /* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('CITY[' . __METHOD__ . ':' . __LINE__ . ']: state=' . $this->getStateInstance()->__toString() . ' - Activating ...');
 188                 $this->getStateInstance()->citySimulationIsActivated();
 189                 // ---------------------- Last step until here ------------------------
 190         }
 191
 192         /**
 193          * Getter for isActive attribute
 194          *
 195          * @return      $isActive       Whether the City is active
 196          */
 197         public final function isCityActive () {
 198                 return $this->isActive;
 199         }
 200
 201         /**
 202          * Enables (default) or disables isActive flag
 203          *
 204          * @param       $isActive       Whether the City is active
 205          * @return      void
 206          */
 207         public final function enableIsActive ($isActive = TRUE) {
 208                 $this->isActive = (bool) $isActive;
 209         }
 210
 211         /**
 212          * Updates/refreshes City data (e.g. status).
 213          *
 214          * @return      void
 215          * @todo        Find more to do here
 216          */
 217         public function updateCityData () {
 218                 // Set some dummy configuration entries, e.g. city_status
 219                 $this->getConfigInstance()->setConfigEntry('city_status', $this->getStateInstance()->getStateName());
 220         }
 221
 222         /**
 223          * Adds all required elements from given array into data set instance
 224          *
 225          * @param       $dataSetInstance        An instance of a StoreableCriteria class
 226          * @param       $CityData                       An array with valid City data
 227          * @return      void
 228          */
 229         public function addArrayToDataSet (StoreableCriteria $dataSetInstance, array $cityData) {
 230                 // Add all data the array provides
 231                 foreach (CityInformationDatabaseWrapper::getAllElements() as $element) {
 232                         // Is the element there?
 233                         if (isset($cityData[$element])) {
 234                                 // Add it
 235                                 $dataSetInstance->addCriteria($element, $cityData[$element]);
 236                         } else {
 237                                 // Output warning message
 238                                 /* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('CITY[' . __METHOD__ . ':' . __LINE__ . ']: addArrayToDataSet(): Element ' . $element . ' not found in CityData array.');
 239                         }
 240                 } // END - foreac
 241         }
 242
 243         /**
 244          * Initializes the city daemon
 245          *
 246          * @return      void
 247          * @todo        0% done
 248          */
 249         public function bootstrapInitCityDaemon () {
 250                 $this->partialStub('Please add something here.');
 251         }
 252
 253         /**
 254          * Checks whether at least one map requires expansion
 255          *
 256          * @return      $requiresExpansion      Whether a map requires expansion
 257          */
 258         public function isMapPendingExpansion () {
 259                 // Get sections manager
 260                 $sectionsInstance = ManagerFactory::createManagerByType('city_sections');
 261
 262                 // Call it's method and return value
 263                 return $sectionsInstance->isMapPendingExpansion();
 264         }
 265
 266         /**
 267          * Expands any found map that requires expansion
 268          *
 269          * @return      void
 270          */
 271         public function expandMaps () {
 272                 // Get sections manager
 273                 $sectionsInstance = ManagerFactory::createManagerByType('city_sections');
 274
 275                 // Call it's method and return value
 276                 $sectionsInstance->expandMaps();
 277         }
 278 }
 279
 280 // [EOF]
 281 ?>