3 * This class contains static helper functions for console applications
5 * @author Roland Haeder <webmaster@ship-simu.org>
7 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 Core Developer Team
8 * @license GNU GPL 3.0 or any newer version
9 * @link http://www.ship-simu.org
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.
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.
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/>.
24 class ConsoleTools extends BaseFrameworkSystem {
26 * Protected constructor
30 protected function __construct () {
31 // Call parent constructor
32 parent::__construct(__CLASS__);
36 * Tries to resolve an IP address from given hostname. Currently only IPv
37 * addresses are resolved.
39 * @param $hostname Host name we shall resolve
40 * @return $ip IP address resolved from host name
42 protected function resolveIpAddress ($hostname) {
44 $this->debugOutput(sprintf("[%s:] Our host name is: <span class=\"data\">%s</span>",
49 // Default is an invalid one
53 $ipResolved = gethostbyname($hostname);
56 if (($ipResolved !== false) && ($ipResolved != $hostname)) {
61 $this->debugOutput(sprintf("[%s:] Resolved IP address is: <span class=\"data\">%s</span>\n",
72 * Aquires the IP address of this host by reading the /etc/hostname file and solving it
74 * @return $ip The resolved IP address
76 public static function acquireSelfIPAddress () {
77 // Local IP by default
81 $helper = new ConsoleTools();
85 $io = FrameworkFileInputPointer::createFrameworkFileInputPointer('/etc/hostname');
88 $hostname = trim($io->readFromFile());
93 // Resolve the IP number
94 $ip = $helper->resolveIpAddress($hostname);
95 } catch (FileNotFoundException $e) {
96 // Fall-back to 'SESSION_SVR' which found on my Sun Station
97 if (isset($_SERVER['SESSION_SVR'])) {
99 $ip = $helper->resolveIpAddress($_SERVER['SESSION_SVR']);
101 // Could not find our hostname
102 $helper->debugOutput(sprintf("[%s:] WARNING: Cannot resolve my own IP address.",
103 $helper->__toString()
106 } catch (FrameworkException $e) {
107 // Output debug message
108 $helper->debugOutput(sprintf("[%s:] Problem while resolving own IP address: [%s|%s]:%s",
109 $helper->__toString(),
116 // Return the IP address
121 * Determines own remote IP address (e.g. can be used to probe if we are
122 * reachable from outside by determining external IP and then connect to it.
123 * This is accomblished by connecting to the IP of www.ship-simu.org which
124 * should default to 217.172.186.31.
126 * This method is taken and lightly rewritten from a user comment on php.net:
127 * http://de.php.net/manual/en/function.socket-create.php#49368
129 * @param $dest IP destination we should connect to
130 * @param $port Port destination we should connect to
131 * @return $externalAddress The determined external IP address
132 * @throws InvalidSocketException If socket initialization wents wrong
134 public function determineExternalIp ($dest = '217.172.186.31', $port = 80) {
135 // First get a socket
136 $socket = socket_create(AF_INET, SOCK_DGRAM, SOL_UDP);
137 if (!is_resource($socket)) {
138 // Throw InvalidSocketException
139 throw new InvalidSocketException (array($this, gettype($socket), 0, 'unknown'));
142 // Connect to the destination
143 socket_connect($socket, $dest, $port);
145 // Get the socket address (our external IP) and port (ignored)
146 socket_getsockname($socket, $externalAddress, $ourPort);
149 socket_close($socket);
151 // Return determined external IP
152 return $externalAddress;