* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
-abstract class BaseMessageHandler extends BaseHandler {
- /**
- * Array with search criteria elements
- */
- private $searchData = array();
-
- /**
- * Array with all data XML nodes (which hold the actual data) and their values
- */
- protected $messageDataElements = array();
-
- /**
- * Array for translating message data elements (other node's data mostly)
- * into configuration elements.
- */
- protected $messageToConfig = array();
-
- /**
- * Array for copying configuration entries
- */
- protected $configCopy = array();
-
- /**
- * Last exception instance from database layer or NULL (default)
- */
- private $lastException = NULL;
-
+abstract class BaseMessageHandler extends BaseDataHandler {
/**
* Protected constructor
*
protected function __construct ($className) {
// Call parent constructor
parent::__construct($className);
-
- // Init array
- $this->searchData = array(
- XmlAnnouncementTemplateEngine::ANNOUNCEMENT_DATA_SESSION_ID,
- XmlAnnouncementTemplateEngine::ANNOUNCEMENT_DATA_EXTERNAL_IP,
- XmlAnnouncementTemplateEngine::ANNOUNCEMENT_DATA_TCP_PORT
- );
- }
-
- /**
- * Getter for last exception
- *
- * @return $lastException Last thrown exception
- */
- protected final function getLastException () {
- return $this->lastException;
}
/**
$statusCode = self::MESSAGE_STATUS_CODE_OKAY;
// Is the last exception not NULL?
- if ($this->lastException instanceof FrameworkException) {
+ if ($this->getLastException() instanceof FrameworkException) {
// "Determine" the right status code (may differ from exception to exception)
- $this->debugInstance('lastException=' . $this->lastException->__toString() . ',message=' . $this->lastException->getMessage() . ' is not finished!');
+ $this->debugInstance('lastException=' . $this->getLastException()->__toString() . ',message=' . $this->getLastException()->getMessage() . ' is not finished!');
} // END - if
// Return the status code
*
* - session-id (for finding the node's record together with below data)
* - external-ip (hostname or IP number)
- * - tcp-port (TCP port for inbound connections)
+ * - listen-port (TCP/UDP listen port for inbound connections)
*
* @param $messageArray An array with all minimum message data
* @return void
- * @todo Add something more, e.g. spreading information over DHT
+ * @todo Rewrite this to use DHT
*/
protected function registerNodeByMessageData (array $messageData) {
+ // Check if searchData has entries
+ assert(count($this->searchData) > 0);
+
// Get a wrapper instance
$wrapperInstance = ObjectFactory::createObjectByConfiguredName('node_list_db_wrapper_class');
// Get a search criteria class
$searchInstance = ObjectFactory::createObjectByConfiguredName('search_criteria_class');
- // Search for the node's session id and external IP/hostname + TCP port
+ // Debug message
+ /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('MESSAGE-HANDLER: messageData=' . print_r($messageData, true));
+
+ // Search for the node's session id and external IP/hostname + TCP/UDP listen port
foreach ($this->searchData as $key) {
+ // Debug message
+ /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('MESSAGE-HANDLER: messageData[' . $key . ']=' . $messageData[$key]);
+
+ // Is it there?
+ assert(isset($messageData[$key]));
+
// Add criteria
- $searchInstance->addCriteria('node_' . $key, $messageData[$key]);
+ $searchInstance->addCriteria('node_' . str_replace('my-', '', $key), $messageData[$key]);
} // END - foreach
// Only one entry is fine
}
// Save last exception
- $this->lastException = $wrapperInstance->getLastException();
+ $this->setLastException($wrapperInstance->getLastException());
}
-
- /**
- * Prepares a message as answer for given message data for delivery.
- *
- * @param $messageData An array with all message data
- * @param $packageInstance An instance of a Deliverable instance
- * @return void
- */
- protected function prepareAnswerMessage (array $messageData, Deliverable $packageInstance) {
- // Debug message
- /* NOISY-DEBUG: */ $this->debugOutput('MESSAGE-HANDLER[' . $this->__toString() . ']: Going to send an answer message ...');
-
- // Get a helper instance based on this handler's name
- $helperInstance = ObjectFactory::createObjectByConfiguredName('node_answer_' . $this->getHandlerName() . '_helper_class', array($messageData));
-
- // Load descriptor XML
- $helperInstance->loadDescriptorXml();
-
- /*
- * Set missing (temporary) configuration data, mostly it needs to be
- * copied from message data array.
- */
- $this->initMessageConfigurationData($messageData);
-
- // Compile any configuration variables
- $helperInstance->getTemplateInstance()->compileConfigInVariables();
-
- // Get node instance
- $nodeInstance = Registry::getRegistry()->getInstance('node');
-
- // Deliver the package
- $helperInstance->sendPackage($nodeInstance);
-
- /*
- * Remove temporary configuration
- */
- $this->removeMessageConfigurationData($messageData);
-
- // Debug message
- /* NOISY-DEBUG: */ $this->debugOutput('MESSAGE-HANDLER[' . $this->__toString() . ']: Answer message has been prepared.');
- }
-
- /**
- * Initializes configuration data from given message data array
- *
- * @param $messageData An array with all message data
- * @return void
- */
- abstract protected function initMessageConfigurationData (array $messageData);
-
- /**
- * Removes configuration data with given message data array from global
- * configuration
- *
- * @param $messageData An array with all message data
- * @return void
- */
- abstract protected function removeMessageConfigurationData (array $messageData);
}
// [EOF]
projects / hub.git / blobdiff