*
* @author Roland Haeder <webmaster@ship-simu.org>
* @version 0.0
- * @copyright Copyright(c) 2007, 2008 Roland Haeder, this is free software
+ * @copyright Copyright (c) 2007 - 2008 Roland Haeder, 2009 - 2012 Hub Developer Team
* @license GNU GPL 3.0 or any newer version
*
* This program is free software: you can redistribute it and/or modify
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
-class ApplicationHelper extends BaseFrameworkSystem implements ManageableApplication {
+class ApplicationHelper extends BaseFrameworkSystem implements ManageableApplication, Registerable {
/**
* The version number of this application
*/
- private $appVersion = "";
+ private $appVersion = '';
/**
* The human-readable name for this application
*/
- private $appName = "";
+ private $appName = '';
/**
* The short uni*-like name for this application
*/
- private $shortName = "";
+ private $shortName = '';
/**
* An instance of this class
*/
- private static $thisInstance = null;
+ private static $selfInstance = NULL;
/**
* Private constructor
protected function __construct () {
// Call parent constructor
parent::__construct(__CLASS__);
-
- // Set description
- $this->setObjectDescription("Application-Helper");
-
- // Create an unique ID
- $this->generateUniqueId();
-
- // Tidy up a little
- $this->removeSystemArray();
}
/**
* Getter for an instance of this class
*
- * @return $thisInstance An instance of this class
+ * @return $selfInstance An instance of this class
*/
- public final static function getInstance () {
+ public static final function getSelfInstance () {
// Is the instance there?
- if (is_null(self::$thisInstance)) {
- self::$thisInstance = new ApplicationHelper();
- }
+ if (is_null(self::$selfInstance)) {
+ self::$selfInstance = new ApplicationHelper();
+ } // END - if
// Return the instance
- return self::$thisInstance;
+ return self::$selfInstance;
}
/**
/**
* Setter for the version number
*
- * @param $appVersion The application's version number
+ * @param $appVersion The application's version number
* @return void
*/
public final function setAppVersion ($appVersion) {
// Cast and set it
- $appVersion = (string) $appVersion;
- $this->appVersion = $appVersion;
+ $this->appVersion = (string) $appVersion;
}
/**
/**
* Setter for human-readable name
*
- * @param $appName The application's human-readable name
+ * @param $appName The application's human-readable name
* @return void
*/
public final function setAppName ($appName) {
// Cast and set it
- $appName = (string) $appName;
- $this->appName = $appName;
+ $this->appName = (string) $appName;;
}
/**
/**
* Setter for short uni*-like name
*
- * @param $shortName The application's short uni*-like name
+ * @param $shortName The application's short uni*-like name
* @return void
*/
public final function setAppShortName ($shortName) {
// Cast and set it
- $shortName = (string) $shortName;
- $this->shortName = $shortName;
+ $this->shortName = (string) $shortName;
}
/**
* @return void
*/
public final function entryPoint () {
- // Get a core loop instance
- $hubInstance = HubCoreLoop::createHubCoreLoop();
-
- // Output some text
- $hubInstance->outputIntro();
-
- // Contact the master hub
- $hubInstance->contactMasterHub();
-
- // The main loop begins here
- $hubInstance->coreLoop();
-
- // Shutdown the hub
- $hubInstance->shutdownHub();
- }
-
- /**
- * Getter for master template name
- *
- * @return $masterTemplate Name of the master template
- */
- public final function getMasterTemplate () {
- return "hub_main";
+ // Set this application in registry
+ Registry::getRegistry()->addInstance('app', $this);
+
+ // Is no external IP set?
+ if ($this->getConfigInstance()->getConfigEntry('external_ip') == '') {
+ // Determine external IP
+ $this->getConfigInstance()->setConfigEntry('external_ip', ConsoleTools::determineExternalIp());
+ } // END - if
+
+ // Default response is console
+ $response = $this->getResponseTypeFromSystem();
+ $responseType = $this->getResponseTypeFromSystem();
+
+ // Create a new request object
+ $requestInstance = ObjectFactory::createObjectByName($this->convertToClassName($response) . 'Request');
+
+ // Remember request instance here
+ $this->setRequestInstance($requestInstance);
+
+ // Do we have another response?
+ if ($requestInstance->isRequestElementSet('request')) {
+ // Then use it
+ $response = strtolower($requestInstance->getRequestElement('request'));
+ $responseType = $response;
+ } // END - if
+
+ // ... and a new response object
+ $responseClass = sprintf("%sResponse", $this->convertToClassName($response));
+ $responseInstance = ObjectFactory::createObjectByName($responseClass, array($this));
+
+ // Remember response instance here
+ $this->setResponseInstance($responseInstance);
+
+ // Get the parameter from the request
+ $commandName = $requestInstance->getRequestElement('command');
+
+ // If it is null then get default command
+ if (is_null($commandName)) {
+ // Get default command
+ $commandName = $responseInstance->getDefaultCommand();
+
+ // Set it in request
+ $requestInstance->setRequestElement('command', $commandName);
+ } // END - if
+
+ // Get a controller resolver
+ $resolverClass = $this->convertToClassName($this->getAppShortName() . '_' . $responseType . '_controller_resolver');
+ $resolverInstance = ObjectFactory::createObjectByName($resolverClass, array($commandName, $this));
+
+ // Get a controller instance as well
+ $this->setControllerInstance($resolverInstance->resolveController());
+
+ // Launch the hub main routine here
+ $this->getControllerInstance()->handleRequest($requestInstance, $responseInstance);
+
+ // -------------------------- Shutdown phase --------------------------
+ // Shutting down the hub by saying "good bye" to all connected peers
+ // and other hubs, flushing all queues and caches.
+ self::createDebugInstance(__CLASS__)->debugOutput('MAIN: Shutdown in progress, main loop exited.');
+ $this->getControllerInstance()->executeShutdownFilters($requestInstance, $responseInstance);
+ self::createDebugInstance(__CLASS__)->debugOutput('MAIN: Shutdown completed. (This is the last line.)');
}
/**
public function handleFatalMessages (array $messageList) {
// Walk through all messages
foreach ($messageList as $message) {
- die("MSG:".$message);
- }
+ exit(__METHOD__ . ':MSG:' . $message);
+ } // END - foreach
+ }
+
+ /**
+ * Builds the master template's name
+ *
+ * @return $masterTemplateName Name of the master template
+ */
+ public function buildMasterTemplateName () {
+ return 'node_main';
}
}