More patterns added, part description changed to object description
[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@mxchange.org>
6  * @version             0.3.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.mxchange.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          * Private constructor
27          *
28          * @return      void
29          */
30         private function __construct () {
31                 // Call parent constructor
32                 parent::constructor(__CLASS__);
33
34                 // Set description
35                 $this->setObjectDescription("Console-Tools");
36
37                 // Create an unique ID
38                 $this->createUniqueID();
39         }
40
41         /**
42          * Aquires the IP address of this host by reading the /etc/hostname file and solving it
43          *
44          * @return      $ip             The resolved IP address
45          */
46         public static function aquireSelfIPAddress () {
47                 // Local IP by default
48                 $ip = "127.0.0.1";
49
50                 // Get a new instance
51                 $helper = new ConsoleTools();
52
53                 try {
54                         // Get a file pointer
55                         $io = FrameworkFileInputPointer::createFrameworkFileInputPointer("/etc/hostname");
56
57                         // Read the file
58                         $hostname = trim($io->readFromFile());
59                         $helper->getDebugInstance()->output(sprintf("[%s:] Our host name is: <strong>%s</strong><br />\n",
60                                 $helper->__toString(),
61                                 $hostname
62                         ));
63
64                         // Close the file
65                         $io->closeFile();
66
67                         // Resolve it
68                         $ipResolved = gethostbyname($hostname);
69                         if (($ipResolved !== false) && ($ipResolved != $hostname)) {
70                                 // Okay, this works!
71                                 $ip = $ipResolved;
72
73                                 // Debug message
74                                 $helper->getDebugInstance()->output(sprintf("[%s:] Resolved IP address is: <strong>%s</strong><br />\n",
75                                         $helper->__toString(),
76                                         $ip
77                                 ));
78                         }
79                 } catch (FrameworkException $e) {
80                         // Do nothing here
81                 }
82
83                 // Return the IP address
84                 return $ip;
85         }
86 }
87
88 // [EOF]
89 ?>