header comments added
[shipsimu.git] / ship-simu / 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
7  * @copyright   Copyright(c) 2007, 2008 Roland Haeder, this is free software
8  * @license             GNU GPL 3.0 or any newer version
9  *
10  * This program is free software: you can redistribute it and/or modify
11  * it under the terms of the GNU General Public License as published by
12  * the Free Software Foundation, either version 3 of the License, or
13  * (at your option) any later version.
14  *
15  * This program is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18  * GNU General Public License for more details.
19  *
20  * You should have received a copy of the GNU General Public License
21  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
22  */
23 class ConsoleTools extends BaseFrameworkSystem {
24         /**
25          * Private constructor
26          *
27          * @return      void
28          */
29         private function __construct () {
30                 // Call parent constructor
31                 parent::constructor(__CLASS__);
32
33                 // Set description
34                 $this->setPartDescr("Console-Tools");
35
36                 // Create an unique ID
37                 $this->createUniqueID();
38         }
39
40         /**
41          * Aquires the IP address of this host by reading the /etc/hostname file and solving it
42          *
43          * @return      $ip             The resolved IP address
44          */
45         public static function aquireSelfIPAddress () {
46                 // Local IP by default
47                 $ip = "127.0.0.1";
48
49                 // Get a new instance
50                 $helper = new ConsoleTools();
51
52                 try {
53                         // Get a file pointer
54                         $io = FrameworkFileInputPointer::createFrameworkFileInputPointer("/etc/hostname");
55
56                         // Read the file
57                         $hostname = trim($io->readFromFile());
58                         $helper->getDebugInstance()->output(sprintf("[%s:] Our host name is: <strong>%s</strong><br />\n",
59                                 $helper->__toString(),
60                                 $hostname
61                         ));
62
63                         // Close the file
64                         $io->closeFile();
65
66                         // Resolve it
67                         $ipResolved = gethostbyname($hostname);
68                         if (($ipResolved !== false) && ($ipResolved != $hostname)) {
69                                 // Okay, this works!
70                                 $ip = $ipResolved;
71
72                                 // Debug message
73                                 $helper->getDebugInstance()->output(sprintf("[%s:] Resolved IP address is: <strong>%s</strong><br />\n",
74                                         $helper->__toString(),
75                                         $ip
76                                 ));
77                         }
78                 } catch (FrameworkException $e) {
79                         // Do nothing here
80                 }
81
82                 // Return the IP address
83                 return $ip;
84         }
85 }
86
87 // [EOF]
88 ?>