3b49f721685f3ce64e13ab9121f8d76eda3fba0f
[shipsimu.git] / inc / classes / main / console / class_ConsoleTools.php
1 <?php
2 /**
3  * This class contains static helper functions for console applications
4  *
5  * @author              Roland Haeder <webmaster@ship-simu.org>
6  * @version             0.0.0
7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, this is free software
8  * @license             GNU GPL 3.0 or any newer version
9  * @link                http://www.ship-simu.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 ConsoleTools extends BaseFrameworkSystem {
25         /**
26          * Protected constructor
27          *
28          * @return      void
29          */
30         protected function __construct () {
31                 // Call parent constructor
32                 parent::__construct(__CLASS__);
33         }
34
35         /**
36          * Aquires the IP address of this host by reading the /etc/hostname file and solving it
37          *
38          * @return      $ip             The resolved IP address
39          */
40         public static function aquireSelfIPAddress () {
41                 // Local IP by default
42                 $ip = "127.0.0.1";
43
44                 // Get a new instance
45                 $helper = new ConsoleTools();
46
47                 try {
48                         // Get a file pointer
49                         $io = FrameworkFileInputPointer::createFrameworkFileInputPointer("/etc/hostname");
50
51                         // Read the file
52                         $hostname = trim($io->readFromFile());
53                         $helper->debugOutput(sprintf("[%s:] Our host name is: <strong>%s</strong>",
54                                 $helper->__toString(),
55                                 $hostname
56                         ));
57
58                         // Close the file
59                         $io->closeFile();
60
61                         // Resolve it
62                         $ipResolved = gethostbyname($hostname);
63                         if (($ipResolved !== false) && ($ipResolved != $hostname)) {
64                                 // Okay, this works!
65                                 $ip = $ipResolved;
66
67                                 // Debug message
68                                 $helper->debugOutput(sprintf("[%s:] Resolved IP address is: <strong>%s</strong>\n",
69                                         $helper->__toString(),
70                                         $ip
71                                 ));
72                         }
73                 } catch (FrameworkException $e) {
74                         // Do nothing here
75                 }
76
77                 // Return the IP address
78                 return $ip;
79         }
80 }
81
82 // [EOF]
83 ?>