3 * A TCP connection helper class
5 * @author Roland Haeder <webmaster@ship-simu.org>
7 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2012 Core Developer Team
8 * @license GNU GPL 3.0 or any newer version
9 * @link http://www.ship-simu.org
10 * @todo Find an interface for hub helper
12 * This program is free software: you can redistribute it and/or modify
13 * it under the terms of the GNU General Public License as published by
14 * the Free Software Foundation, either version 3 of the License, or
15 * (at your option) any later version.
17 * This program is distributed in the hope that it will be useful,
18 * but WITHOUT ANY WARRANTY; without even the implied warranty of
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 * GNU General Public License for more details.
22 * You should have received a copy of the GNU General Public License
23 * along with this program. If not, see <http://www.gnu.org/licenses/>.
25 class TcpConnectionHelper extends BaseConnectionHelper implements ConnectionHelper {
27 * Protected constructor
31 protected function __construct () {
32 // Call parent constructor
33 parent::__construct(__CLASS__);
36 $this->setProtocol('tcp');
40 * Creates a half-connected socket resource ("connection") for given
41 * recipient in package data. After you called this method you still need to
42 * connect to the other node.
44 * @param $packageData Raw package data
45 * @return $socketResource Socket resource
46 * @throws SocketCreationException If the socket could not be created
47 * @throws SocketOptionException If a socket option could not be set
48 * @throws SocketConnectionException If a connection could not be opened
49 * @todo $errorCode/-Message are now in handleSocketError()'s call-back methods
51 public static function createConnectionFromPackageData (array $packageData) {
53 $helperInstance = new TcpConnectionHelper();
55 // Create a socket instance
56 $socketResource = socket_create(AF_INET, SOCK_STREAM, SOL_TCP);
58 // Is the socket resource valid?
59 if (!is_resource($socketResource)) {
61 * Something bad happened, calling handleSocketError() is not
62 * possible here because that method would throw an
63 * InvalidSocketException back.
65 throw new SocketCreationException(array($helperInstance, gettype($socketResource)), BaseListener::EXCEPTION_SOCKET_CREATION_FAILED);
68 // Get socket error code for verification
69 $socketError = socket_last_error($socketResource);
71 // Check if there was an error else
72 if ($socketError > 0) {
73 // Handle this socket error with a faked recipientData array
74 $helperInstance->handleSocketError(__METHOD__, __LINE__, $socketResource, array('0.0.0.0', '0'));
77 throw new SocketCreationException(array($helperInstance, gettype($socketResource), $socketError, socket_strerror($socketError)), BaseListener::EXCEPTION_SOCKET_CREATION_FAILED);
81 $helperInstance->setSocketResource($socketResource);
84 $helperInstance->initConnection();
86 // @TODO The whole resolving part should be moved out and made more configurable
87 // Init recipient data
88 $recipientData = NULL;
90 // Try to solve the recipient
92 // Resolve any session ids; 0 = IP, 1 = Port
93 $recipientData = explode(':', HubTools::resolveSessionId($packageData[NetworkPackage::PACKAGE_DATA_RECIPIENT], NetworkPackage::PROTOCOL_TCP));
94 } catch (NoValidHostnameException $e) {
96 $helperInstance->debugOutput('CONNECTION-HELPER: Failed to resolve ' . $packageData[NetworkPackage::PACKAGE_DATA_RECIPIENT] . ':' . $e->getMessage());
98 // Is the recipient equal as configured IP
99 if (substr($packageData[NetworkPackage::PACKAGE_DATA_RECIPIENT], 0, strlen($helperInstance->getConfigInstance()->getConfigEntry('external_ip'))) == $helperInstance->getConfigInstance()->getConfigEntry('external_ip')) {
100 // This connects to ship-simu.org and requests /ip.php which will return our external IP number
101 $recipientData[0] = ConsoleTools::determineExternalIp();
103 // Do we have hostname:ip match?
104 if (strpos($packageData[NetworkPackage::PACKAGE_DATA_RECIPIENT], ':') === false) {
106 $helperInstance->debugInstance($packageData[NetworkPackage::PACKAGE_DATA_RECIPIENT] . ' does not contain ":". Please fix this.');
109 // "explode" the hostname:ip, so index 1 will be the port number
110 $recipientArray = explode(':', $packageData[NetworkPackage::PACKAGE_DATA_RECIPIENT]);
113 $recipientData[1] = $recipientArray[1];
115 // It doesn't match, we need to take care of this later
116 $helperInstance->debugInstance($packageData[NetworkPackage::PACKAGE_DATA_RECIPIENT] . '!=' . $helperInstance->getConfigInstance()->getConfigEntry('external_ip'));
121 $helperInstance->setAddress($recipientData[0]);
122 $helperInstance->setPort($recipientData[1]);
125 if (!$helperInstance->connectToPeerByRecipientData($recipientData)) {
126 // Handle socket error
127 $helperInstance->handleSocketError(__METHOD__, __LINE__, $socketResource, $recipientData);
130 // Okay, that should be it. Return it...
131 return $socketResource;
135 * Do the shutdown sequence for this connection helper
138 * @throws SocketShutdownException If the current socket could not be shut down
139 * @todo We may want to implement a filter for ease notification of other objects like our pool
141 public function doShutdown () {
143 self::createDebugInstance(__CLASS__)->debugOutput('HELPER: Shutting down socket resource ' . $this->getSocketResource());
145 // Clear any previous errors
146 socket_clear_error($this->getSocketResource());
148 // Call the shutdown function on the currently set socket
149 if (!socket_shutdown($this->getSocketResource())) {
150 // Could not shutdown socket, this is fine if e.g. the other side is not connected, so analyse it
151 if (socket_last_error($this->getSocketResource()) != 107) {
152 // Something bad happened while we shutdown a socket
153 throw new SocketShutdownException($this, BaseListener::EXCEPTION_INVALID_SOCKET);
157 // Try to make blocking IO for socket_close()
158 socket_set_block($this->getSocketResource());
160 // Drop all data (don't sent any on socket closure)
161 socket_set_option($this->getSocketResource(), SOL_SOCKET, SO_LINGER, array('l_onoff' => 1, 'l_linger' => 0));
163 // Finally close socket to free some resources
164 socket_close($this->getSocketResource());
166 // Mark this connection as shutted down
167 $this->markConnectionShuttedDown();