Changeset 7720

Timestamp:

Apr 12, 2010, 5:56:17 PM (15 years ago)

Author:

Pieter Naber

Message:

Adding a lot of checks for the variables in the status and the location file. Added even more comments everywhere

Location:

trunk/src

Files:

• inc/ErrorHandler.php (modified) (1 diff)
• inc/FileHandler.class.php (modified) (1 diff)
• inc/KMLFile.class.php (modified) (11 diffs)
• inc/KMLPlacemark.class.php (modified) (3 diffs)
• inc/LogHandler.class.php (modified) (1 diff)
• index.php (modified) (2 diffs)

trunk/src/inc/ErrorHandler.php

@@ -26 +26 @@
 /*
  * Function: NodeErrorHandler
+ * Description: Handling with errors, decides what log level it is and send it to LogHandler
  * Parameters: int $errno, string $errstr, string $errfile, int $errline, array $errcontext
- * Function: Handling with errors, decides what log level it is and send it to LogHandler
+ * Returns: true (Just so the internal PHP error handler is nog executed)
  */
 function NodeErrorHandler(int $errno, string $errstr, string $errfile, int $errline, array $errcontext) {

trunk/src/inc/FileHandler.class.php

@@ -7 +7 @@
 
 class FileHandler {
-        private $file;
+        private $filename;
+        private $handle;
+        
+        /*
+         * Function: __construct (constructor)
+         * Description: Handling with a node file 
+         * Parameters: string $filename, string $mode
+         * Returns: true is we've succesfully opened the file, otherwise false
+         */
+        public function __construct($filename, $mode) {
+                $this->filename = $filename;
+
+                try {
+                        trigger_log(SYSLOG_DEBUG, 'Opening the file "' . $this->filename . '"', __FILE__, __LINE__);
+                        $this->handle = fopen($this->filename, $mode);
+                } catch (Exception $err) {
+                        trigger_log(SYSLOG_ERR, 'Reading from file "' . $this->filename . '" failed', __FILE__, __LINE__);
+                        return false;
+                }
+
+                return true;
+        }
 
         /*
-         * Function: __construct (constructor)
-         * Parameters: string $filename
-         * Function: Handling with a node file 
+         * Function: read
+         * Description: Try to read the file we've opened in the constructor
+         * Parameters: -
+         * Returns: The content of the file if we can read from the file, otherwise false
          */
-        public function __construct($filename) {
+        public function read() {
+                $file = '';
+
                 try {
-                        trigger_log(SYSLOG_DEBUG, 'Opening the file "' . $filename . '"', __FILE__, __LINE__);
-                        $handle = fopen($filename, 'r');
+                        trigger_log(SYSLOG_DEBUG, 'Reading from file "' . $this->filename . '"', __FILE__, __LINE__);
+                        $file = stream_get_contents($this->handle);
+                } catch (Exception $err) {
+                        trigger_log(SYSLOG_ERR, 'Reading from file "' . $this->filename . '" failed', __FILE__, __LINE__);
+                        return false;
+                }
 
-                        trigger_log(SYSLOG_DEBUG, 'Reading from file "' . $filename . '"', __FILE__, __LINE__);
-                        $this->file = '';
-                        while (!feof($handle)) {
-                                $this->file .= fread($handle, 8192);
-                        }
-
-                        trigger_log(SYSLOG_DEBUG, 'Closing file "' . $filename . '"', __FILE__, __LINE__);
-                        fclose($handle);
-
-                        trigger_log(SYSLOG_INFO, 'Reading from file "' . $filename . '" is done', __FILE__, __LINE__);
-                } catch (Exception $err) {
-                        trigger_log(SYSLOG_ERR, 'Reading from file "' . $filename . '" failed', __FILE__, __LINE__);
-                }
+                return $file;
         }
 
-        public function getFile() {
-                return $this->file;
+        /*
+         * Function: write
+         * Description: Try to write to the file we've opened in the constructor 
+         * Parameters: string $data
+         * Returns: true if we can write to the file, otherwise false
+         */
+        public function write($data) {
+                // TODO David: Make write function
+
+                return false;
+        }
+
+        public function __destruct() {
+                trigger_log(SYSLOG_DEBUG, 'Closing file "' . $this->filename . '"', __FILE__, __LINE__);
+                fclose($this->handle);
         }
 }

trunk/src/inc/KMLFile.class.php

@@ -51 +51 @@
                 </kml>';
 
+        // First line of the status file must be like this:
         static $fileFirst = 'type,host_name,has_been_checked,check_execution_time,current_state,last_hard_state,last_check,problem_has_been_acknowledged';
-        private $fileContent = array('string', 'string', 'integer', 'double', 'integer', 'integer', 'integer', 'integer');
+        // Every following line will be checked using these functions
+        private $fileContent = array('string', 'string', 'int', 'double', 'int', 'int', 'int', 'int');
 
         private $KMLPlacemarks;
@@ -58 +60 @@
         /*
          * Function: __construct (constructor)
+         * Description: Creating a new KMLFile
          * Parameters: -
-         * Function: Creating a new KMLFile
+         * Returns: -
          */
         public function __construct() {
@@ -65 +68 @@
         }
 
+        /*
+         * Function: addPlacemark
+         * Description: Add a placemark to the local placemark array
+         * Parameters: KMLPlacemark $placemark
+         * Returns: -
+         */
         public function addPlacemark(KMLPlacemark $placemark) {
                 $this->KMLPlacemarks[] = $placemark;
         }
 
+        /*
+         * Function: toString
+         * Description: Converts the content of this file and the placemarks to a KML valid string
+         * Parameters: -
+         * Returns: KML valid string
+         */
         public function toString() {
+                global $config;
+
                 $toString = $this->template;
 
@@ -88 +105 @@
         /*
          * Function: write
+         * Description: Write KMLFile to a KML file
          * Parameters: string $filename
-         * Function: Write KMLFile to a KML file
+         * Returns: true if we can write to the file, otherwise false
          */
         public function write($filename) {
+                // TODO: David: Needs to be placed in FileHandler.class.php. Here we just want to call our file handler.
+
                 trigger_log(SYSLOG_DEBUG, 'Opening the file "' . $filename . '"', __FILE__, __LINE__);
                 $file = fopen("$filename","w")
@@ -105 +125 @@
         /*
          * Function: getPlacemarkByName
+         * Description: Find the first KMLPlacemark with the name $name and return its position. If not found, return false
          * Parameters: string $name
-         * Function: Find the first KMLPlacemark with the name $name and return its position. If not found, return false
+         * Returns: Position of placemark in our array, if not found false
          */
         public function getPlacemarkByName($name) {
@@ -115 +136 @@
                         }
                 }
+
                 return false;
         }
@@ -120 +142 @@
         /*
          * Function: parseLocationFile
+         * Description: Parse the node location file updating or adding KMLPlacemark objects to the current KMLFile object
          * Parameters: string $file
-         * Function: Parse the node location file updating or adding KMLPlacemark objects to the current KMLFile object
+         * Returns: true is successfull, otherwise false
          */
         public function parseLocationFile($file) {
                 $nodesCount = preg_match_all('/\[[a-zA-Z0-9]*\]/i', $file, $nodes, PREG_OFFSET_CAPTURE);
                 for ($i = 0; $i < $nodesCount; $i++) {
-                        // TODO: Needs checking for parsing errors
-                        $location       = $this->findInLocationFile($file, 'location', $nodes[0][$i][1]);
-                        $status         = $this->findInLocationFile($file, 'status', $nodes[0][$i][1]);
-                        $latitude       = $this->findInLocationFile($file, 'latitude', $nodes[0][$i][1]);
-                        $longitude      = $this->findInLocationFile($file, 'longitude', $nodes[0][$i][1]);
-                        $interfaces     = $this->findInLocationFile($file, 'interfaces', $nodes[0][$i][1]);
-                        $masterip       = $this->findInLocationFile($file, 'masterip', $nodes[0][$i][1]);
-                        $nodetype       = $this->findInLocationFile($file, 'nodetype', $nodes[0][$i][1]);
-                        $name           = $this->findInLocationFile($file, 'name', $nodes[0][$i][1]);
-
+                        // Looking for "location" of the node
+                        if (!$location = $this->findInLocationFile($file, 'location', $nodes[0][$i][1])) {
+                                trigger_log(SYSLOG_WARNING, 'Could not find the "location" of node "' . $i . '", skipping to next', __FILE__, __LINE__);
+                                continue;
+                        }
+                        // Looking for "status" of the node
+                        if (!$status = $this->findInLocationFile($file, 'status', $nodes[0][$i][1])) {
+                                trigger_log(SYSLOG_WARNING, 'Could not find the "status" of node "' . $i . '", skipping to next', __FILE__, __LINE__);
+                                continue;
+                        }
+                        // Looking for "latitude" of the node
+                        if (!$latitude = $this->findInLocationFile($file, 'latitude', $nodes[0][$i][1])) {
+                                trigger_log(SYSLOG_WARNING, 'Could not find the "latitude" of node "' . $i . '", skipping to next', __FILE__, __LINE__);
+                                continue;
+                        }
+                        // Looking for "longitude" of the node
+                        if (!$longitude = $this->findInLocationFile($file, 'longitude', $nodes[0][$i][1])) {
+                                trigger_log(SYSLOG_WARNING, 'Could not find the "longitude" of node "' . $i . '", skipping to next', __FILE__, __LINE__);
+                                continue;
+                        }
+                        // Looking for "interfaces" of the node
+                        if (!$interfaces = $this->findInLocationFile($file, 'interfaces', $nodes[0][$i][1])) {
+                                trigger_log(SYSLOG_WARNING, 'Could not find the "interfaces" of node "' . $i . '", skipping to next', __FILE__, __LINE__);
+                                continue;
+                        }
+                        // Looking for "masterip" of the node
+                        if (!$masterip = $this->findInLocationFile($file, 'masterip', $nodes[0][$i][1])) {
+                                trigger_log(SYSLOG_WARNING, 'Could not find the "masterip" of node "' . $i . '", skipping to next', __FILE__, __LINE__);
+                                continue;
+                        }
+                        // Looking for "nodetype" of the node
+                        if (!$nodetype = $this->findInLocationFile($file, 'nodetype', $nodes[0][$i][1])) {
+                                trigger_log(SYSLOG_WARNING, 'Could not find the "nodetype" of node "' . $i . '", skipping to next', __FILE__, __LINE__);
+                                continue;
+                        }
+                        // Looking for "name" of the node
+                        if (!$name = $this->findInLocationFile($file, 'name', $nodes[0][$i][1])) {
+                                trigger_log(SYSLOG_WARNING, 'Could not find the "name" of node "' . $i . '", skipping to next', __FILE__, __LINE__);
+                                continue;
+                        }
+
+                        // Creating a string with the complete description of the node using all data in the location file
                         $descriptionLocation = 'Naam: ' . $name . '<br/>Locatie: ' . $location . '<br/>Status: ' . $status . '<br/>Latitude: ' . $latitude . '<br/>Longitude: ' . $longitude . '<br/>Interfaces: ' . $interfaces . '<br/>Master IP: ' . $masterip . '<br/>Node type: ' . $nodetype . '<br/><br/>';
 
                         if ($placemarkPosition = $this->getPlacemarkByName($name)) {
+                                // Updating an excisting placemark
                                 $this->KMLPlacemarks[$placemarkPosition]->setDescriptionLocation($descriptionLocation);
                                 $this->KMLPlacemarks[$placemarkPosition]->setLongitude($longitude);
                                 $this->KMLPlacemarks[$placemarkPosition]->setLatitude($latitude);
                         } else {
+                                // Adding a new placemark
                                 $placemark = new KMLPlacemark();
                                 $placemark->setID($name);
@@ -156 +213 @@
         /*
          * Function: findInLocationFile
+         * Description: Find the $keyword in $file and return the value of $keyword, starting at $offset
          * Parameters: string $file, string $keyword, integer $offset
-         * Function: Find the $keyword in $file and return the value of $keyword, starting at $offset, on error return false
+         * Returns: The value of the keyword if found, otherwise return false
          */
         private function findInLocationFile($file, $keyword, $offset) {
-                $start = strpos($file, $keyword, $offset) + strlen($keyword . ' = ');
+                $start  = strpos($file, $keyword, $offset) + strlen($keyword . ' = ');
                 $end    = strpos($file, "\n", $start);
 
@@ -172 +230 @@
         /*
          * Function: parseStatusFile
+         * Description: Parse the node status file updating or adding KMLPlacemark objects to the current KMLFile object
          * Parameters: string $file
-         * Function: Parse the node status file updating or adding KMLPlacemark objects to the current KMLFile object
+         * Returns: true is successfull, otherwise false
          */
         public function parseStatusFile($file) {
@@ -179 +238 @@
 
                 if ($fileContents[0] != KMLFile::$fileFirst) {
-                        trigger_log(LOG_WARNING, 'Contents of file do not match with template of first line', __FILE__, __LINE__);
-                }
-
+                        trigger_log(SYSLOG_WARNING, 'Contents of file do not match with template of first line', __FILE__, __LINE__);
+                }
+
+                // For loop for all the lines in the file. Skipping first line (headers) and last line (blank)
                 $linesCount = count($fileContents);
                 for ($i = 1; $i < $linesCount - 1; $i++) {
@@ -187 +247 @@
 
                         if (count($lineContent) != count($this->fileContent)) {
-                                trigger_log(LOG_WARNING, 'Contents of file do not match with template of lines', __FILE__, __LINE__);
-                        }
-
-                        // TODO: Process all lines and update KMLPlacemark objects we already have in the current object
-                        $type = $lineContent[0];
-                        $host_name = str_replace('CNode', '', $lineContent[1]);
-                        $has_been_checked = $lineContent[2];
-                        $check_execution_time = $lineContent[3];
-                        $current_state = $lineContent[4];
-                        $last_hard_state = $lineContent[5];
-                        $last_check = $lineContent[6];
-                        $problem_has_been_acknowledged = $lineContent[7];
-
-                        $descriptionStatus = 'Type: ' . $type . '<br/>Host name: ' . $host_name . '<br/>Has been checked: ' . $has_been_checked . '<br/>Check execution time: ' . $check_execution_time . '<br/>Currenr state: ' . $current_state . '<br/>Last hard state: ' . $last_hard_state . '<br/>Last check: ' . $last_check . '<br/>Problem has been acknowledged: ' . $problem_has_been_acknowledged . '<br/><br/>';
-
-                        if ($placemarkPosition = $this->getPlacemarkByName($host_name)) {
+                                trigger_log(LOG_WARNING, 'Contents of the file do not match with template of lines on line "' . $i . '"', __FILE__, __LINE__);
+                                continue;
+                        }
+
+                        // Checking for valid entries on this line
+                        for ($j = 0; $j < 8; $j++) {
+                                try {
+                                        switch ($this->fileContent[$j]) {
+                                                case 'string':
+                                                        $lineContent[$j] = (string) $lineContent[$j];
+                                                        break;
+                                                case 'int':
+                                                        $lineContent[$j] = (int) $lineContent[$j];
+                                                        break;
+                                                case 'double':
+                                                        $lineContent[$j] = (double) $lineContent[$j];
+                                                        break;
+                                                default:
+                                                        break;
+                                        }
+                                } catch (Exception $err) {
+                                        trigger_log(SYSLOG_WARNING, 'The value "' . $j . '" on line "' . $i . '" is not valid, skipping to next line', __FILE__, __LINE__);
+                                        continue;
+                                }
+                        }
+
+                        // Creating a string with the complete description of the node using all data in the status file
+                        $descriptionStatus = 'Type: ' . $lineContent[0] . '<br/>Host name: ' . $lineContent[1] . '<br/>Has been checked: ' . $lineContent[2] . '<br/>Check execution time: ' . $lineContent[3] . '<br/>Currenr state: ' . $lineContent[4] . '<br/>Last hard state: ' . $lineContent[5] . '<br/>Last check: ' . $lineContent[6] . '<br/>Problem has been acknowledged: ' . $lineContent[7] . '<br/><br/>';
+
+                        if ($placemarkPosition = $this->getPlacemarkByName($lineContent[1])) {
+                                // Updating an excisting placemark
                                 $this->KMLPlacemarks[$placemarkPosition]->setDescriptionStatus($descriptionStatus);
                         } else {
+                                // Adding a new placemark
                                 $placemark = new KMLPlacemark();
-                                $placemark->setID($host_name);
-                                $placemark->setName($host_name);
+                                $placemark->setID($lineContent[1]);
+                                $placemark->setName($lineContent[1]);
                                 $placemark->setDescriptionStatus($descriptionStatus);
                                 $this->addPlacemark($placemark);

trunk/src/inc/KMLPlacemark.class.php

@@ -5 +5 @@
  * Purpose: Placemark used in KMLFile
  */
+
+define('PLACEMARK_GREEN', 'greenArrowIcon');
+define('PLACEMARK_ORANGE', 'orangeArrowIcon');
+define('PLACEMARK_RED', 'redArrowIcon');
 
 class KMLPlacemark {
@@ -41 +45 @@
         /*
          * Function: __construct (constructor)
+         * Description: Creating a new KMLFile
          * Parameters: -
-         * Function: Creating a new KMLFile
+         * Returns: -
          */
         function __construct() {
@@ -54 +59 @@
         }
 
+        /*
+         * Function: setID
+         * Description: Setting the ID of the placemark
+         * Parameters: string $newID
+         * Returns: -
+         */
         function setID($newID) {
                 $this->id = $newID;
         }
 
+        /*
+         * Function: setName
+         * Description: Setting the name of the placemark
+         * Parameters: string $newName
+         * Returns: -
+         */
         function setName($newName) {
                 $this->name = $newName;
         }
 
+        /*
+         * Function: getName
+         * Description: Getting the name of the placemark
+         * Parameters: -
+         * Returns: The name of the placemark
+         */
         function getName() {
                 return $this->name;
         }
 
+        /*
+         * Function: setDescriptionLocation
+         * Description: Setting the location description of the placemark
+         * Parameters: string $newDescriptionLocation
+         * Returns: -
+         */
         function setDescriptionLocation($newDescriptionLocation) {
                 $this->descriptionLocation = (string) $newDescriptionLocation;
         }
 
+        /*
+         * Function: setDescriptionStatus
+         * Description: Setting the status description of the placemark
+         * Parameters: string $newDescriptionStatus
+         * Returns: -
+         */
         function setDescriptionStatus($newDescriptionStatus) {
                 $this->descriptionStatus = (string) $newDescriptionStatus;
         }
 
+        /*
+         * Function: setLongitude
+         * Description: Setting the longitude of the placemark
+         * Parameters: string $newLongitude
+         * Returns: -
+         */
         function setLongitude($newLongitude) {
                 $this->longitude = (double) $newLongitude;
         }
 
+        /*
+         * Function: setLatitude
+         * Description: Setting the latitude of the placemark
+         * Parameters: string $newLatitude
+         * Returns: -
+         */
         function setLatitude($newLatitude) {
                 $this->latitude = (double) $newLatitude;
         }
 
+        /*
+         * Function: setStyle
+         * Description: Setting the style of the placemark
+         * Parameters: string $newStyle
+         * Returns: -
+         */
         function setStyle($newStyle) {
                 $this->style = (string) $newStyle;
         }
 
+        /*
+         * Function: toString
+         * Description: Converts the content of this placemark to a KML valid string
+         * Parameters: -
+         * Returns: KML valid string
+         */
         function toString() {
                 $toString = $this->template;

trunk/src/inc/LogHandler.class.php

@@ -88 +88 @@
                 }
                 if ($logno <= LOG_LEVEL_WRITE) {
-                        // TODO: Write $errorString to file
+                        // TODO: David: Write $errorString to file
                 }
                 if ($logno <= LOG_LEVEL_MAIL) {
-                        // TODO: Mail $errorString to administrator
+                        // TODO: David: Mail $errorString to administrator
                 }
         }

trunk/src/index.php

@@ -42 +42 @@
 
 // Let's try to read the node location file
-$nodeLocation = new FileHandler($config['node_location_file']);
-$kmlFile->parseLocationFile($nodeLocation->getFile());
+$nodeLocation = new FileHandler($config['node_location_file'], 'r');
+$kmlFile->parseLocationFile($nodeLocation->read());
 /*
  * For testing, echo the example KML file
@@ -51 +51 @@
 
 // Let's try to read the node status file
-$nodeStatus = new FileHandler($config['node_status_file']);
-$kmlFile->parseStatusFile($nodeStatus->getFile());
+$nodeStatus = new FileHandler($config['node_status_file'], 'r');
+$kmlFile->parseStatusFile($nodeStatus->read());
 
 // And echo the result to the screen