Ignore:
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

File:
1 edited

Legend:

Unmodified
Added
Removed

  • trunk/src/inc/KMLFile.class.php

    r7702 r7720  
    5151                </kml>';
    5252
     53        // First line of the status file must be like this:
    5354        static $fileFirst = 'type,host_name,has_been_checked,check_execution_time,current_state,last_hard_state,last_check,problem_has_been_acknowledged';
    54         private $fileContent = array('string', 'string', 'integer', 'double', 'integer', 'integer', 'integer', 'integer');
     55        // Every following line will be checked using these functions
     56        private $fileContent = array('string', 'string', 'int', 'double', 'int', 'int', 'int', 'int');
    5557
    5658        private $KMLPlacemarks;
    … …  
    5860        /*
    5961         * Function: __construct (constructor)
     62         * Description: Creating a new KMLFile
    6063         * Parameters: -
    61          * Function: Creating a new KMLFile
     64         * Returns: -
    6265         */
    6366        public function __construct() {
    … …  
    6568        }
    6669
     70        /*
     71         * Function: addPlacemark
     72         * Description: Add a placemark to the local placemark array
     73         * Parameters: KMLPlacemark $placemark
     74         * Returns: -
     75         */
    6776        public function addPlacemark(KMLPlacemark $placemark) {
    6877                $this->KMLPlacemarks[] = $placemark;
    6978        }
    7079
     80        /*
     81         * Function: toString
     82         * Description: Converts the content of this file and the placemarks to a KML valid string
     83         * Parameters: -
     84         * Returns: KML valid string
     85         */
    7186        public function toString() {
     87                global $config;
     88
    7289                $toString = $this->template;
    7390
    … …  
    88105        /*
    89106         * Function: write
     107         * Description: Write KMLFile to a KML file
    90108         * Parameters: string $filename
    91          * Function: Write KMLFile to a KML file
     109         * Returns: true if we can write to the file, otherwise false
    92110         */
    93111        public function write($filename) {
     112                // TODO: David: Needs to be placed in FileHandler.class.php. Here we just want to call our file handler.
     113
    94114                trigger_log(SYSLOG_DEBUG, 'Opening the file "' . $filename . '"', __FILE__, __LINE__);
    95115                $file = fopen("$filename","w")
    … …  
    105125        /*
    106126         * Function: getPlacemarkByName
     127         * Description: Find the first KMLPlacemark with the name $name and return its position. If not found, return false
    107128         * Parameters: string $name
    108          * Function: Find the first KMLPlacemark with the name $name and return its position. If not found, return false
     129         * Returns: Position of placemark in our array, if not found false
    109130         */
    110131        public function getPlacemarkByName($name) {
    … …  
    115136                        }
    116137                }
     138
    117139                return false;
    118140        }
    … …  
    120142        /*
    121143         * Function: parseLocationFile
     144         * Description: Parse the node location file updating or adding KMLPlacemark objects to the current KMLFile object
    122145         * Parameters: string $file
    123          * Function: Parse the node location file updating or adding KMLPlacemark objects to the current KMLFile object
     146         * Returns: true is successfull, otherwise false
    124147         */
    125148        public function parseLocationFile($file) {
    126149                $nodesCount = preg_match_all('/\[[a-zA-Z0-9]*\]/i', $file, $nodes, PREG_OFFSET_CAPTURE);
    127150                for ($i = 0; $i < $nodesCount; $i++) {
    128                         // TODO: Needs checking for parsing errors
    129                         $location       = $this->findInLocationFile($file, 'location', $nodes[0][$i][1]);
    130                         $status         = $this->findInLocationFile($file, 'status', $nodes[0][$i][1]);
    131                         $latitude       = $this->findInLocationFile($file, 'latitude', $nodes[0][$i][1]);
    132                         $longitude      = $this->findInLocationFile($file, 'longitude', $nodes[0][$i][1]);
    133                         $interfaces     = $this->findInLocationFile($file, 'interfaces', $nodes[0][$i][1]);
    134                         $masterip       = $this->findInLocationFile($file, 'masterip', $nodes[0][$i][1]);
    135                         $nodetype       = $this->findInLocationFile($file, 'nodetype', $nodes[0][$i][1]);
    136                         $name           = $this->findInLocationFile($file, 'name', $nodes[0][$i][1]);
    137 
     151                        // Looking for "location" of the node
     152                        if (!$location = $this->findInLocationFile($file, 'location', $nodes[0][$i][1])) {
     153                                trigger_log(SYSLOG_WARNING, 'Could not find the "location" of node "' . $i . '", skipping to next', __FILE__, __LINE__);
     154                                continue;
     155                        }
     156                        // Looking for "status" of the node
     157                        if (!$status = $this->findInLocationFile($file, 'status', $nodes[0][$i][1])) {
     158                                trigger_log(SYSLOG_WARNING, 'Could not find the "status" of node "' . $i . '", skipping to next', __FILE__, __LINE__);
     159                                continue;
     160                        }
     161                        // Looking for "latitude" of the node
     162                        if (!$latitude = $this->findInLocationFile($file, 'latitude', $nodes[0][$i][1])) {
     163                                trigger_log(SYSLOG_WARNING, 'Could not find the "latitude" of node "' . $i . '", skipping to next', __FILE__, __LINE__);
     164                                continue;
     165                        }
     166                        // Looking for "longitude" of the node
     167                        if (!$longitude = $this->findInLocationFile($file, 'longitude', $nodes[0][$i][1])) {
     168                                trigger_log(SYSLOG_WARNING, 'Could not find the "longitude" of node "' . $i . '", skipping to next', __FILE__, __LINE__);
     169                                continue;
     170                        }
     171                        // Looking for "interfaces" of the node
     172                        if (!$interfaces = $this->findInLocationFile($file, 'interfaces', $nodes[0][$i][1])) {
     173                                trigger_log(SYSLOG_WARNING, 'Could not find the "interfaces" of node "' . $i . '", skipping to next', __FILE__, __LINE__);
     174                                continue;
     175                        }
     176                        // Looking for "masterip" of the node
     177                        if (!$masterip = $this->findInLocationFile($file, 'masterip', $nodes[0][$i][1])) {
     178                                trigger_log(SYSLOG_WARNING, 'Could not find the "masterip" of node "' . $i . '", skipping to next', __FILE__, __LINE__);
     179                                continue;
     180                        }
     181                        // Looking for "nodetype" of the node
     182                        if (!$nodetype = $this->findInLocationFile($file, 'nodetype', $nodes[0][$i][1])) {
     183                                trigger_log(SYSLOG_WARNING, 'Could not find the "nodetype" of node "' . $i . '", skipping to next', __FILE__, __LINE__);
     184                                continue;
     185                        }
     186                        // Looking for "name" of the node
     187                        if (!$name = $this->findInLocationFile($file, 'name', $nodes[0][$i][1])) {
     188                                trigger_log(SYSLOG_WARNING, 'Could not find the "name" of node "' . $i . '", skipping to next', __FILE__, __LINE__);
     189                                continue;
     190                        }
     191
     192                        // Creating a string with the complete description of the node using all data in the location file
    138193                        $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/>';
    139194
    140195                        if ($placemarkPosition = $this->getPlacemarkByName($name)) {
     196                                // Updating an excisting placemark
    141197                                $this->KMLPlacemarks[$placemarkPosition]->setDescriptionLocation($descriptionLocation);
    142198                                $this->KMLPlacemarks[$placemarkPosition]->setLongitude($longitude);
    143199                                $this->KMLPlacemarks[$placemarkPosition]->setLatitude($latitude);
    144200                        } else {
     201                                // Adding a new placemark
    145202                                $placemark = new KMLPlacemark();
    146203                                $placemark->setID($name);
    … …  
    156213        /*
    157214         * Function: findInLocationFile
     215         * Description: Find the $keyword in $file and return the value of $keyword, starting at $offset
    158216         * Parameters: string $file, string $keyword, integer $offset
    159          * Function: Find the $keyword in $file and return the value of $keyword, starting at $offset, on error return false
     217         * Returns: The value of the keyword if found, otherwise return false
    160218         */
    161219        private function findInLocationFile($file, $keyword, $offset) {
    162                 $start = strpos($file, $keyword, $offset) + strlen($keyword . ' = ');
     220                $start  = strpos($file, $keyword, $offset) + strlen($keyword . ' = ');
    163221                $end    = strpos($file, "\n", $start);
    164222
    … …  
    172230        /*
    173231         * Function: parseStatusFile
     232         * Description: Parse the node status file updating or adding KMLPlacemark objects to the current KMLFile object
    174233         * Parameters: string $file
    175          * Function: Parse the node status file updating or adding KMLPlacemark objects to the current KMLFile object
     234         * Returns: true is successfull, otherwise false
    176235         */
    177236        public function parseStatusFile($file) {
    … …  
    179238
    180239                if ($fileContents[0] != KMLFile::$fileFirst) {
    181                         trigger_log(LOG_WARNING, 'Contents of file do not match with template of first line', __FILE__, __LINE__);
    182                 }
    183 
     240                        trigger_log(SYSLOG_WARNING, 'Contents of file do not match with template of first line', __FILE__, __LINE__);
     241                }
     242
     243                // For loop for all the lines in the file. Skipping first line (headers) and last line (blank)
    184244                $linesCount = count($fileContents);
    185245                for ($i = 1; $i < $linesCount - 1; $i++) {
    … …  
    187247
    188248                        if (count($lineContent) != count($this->fileContent)) {
    189                                 trigger_log(LOG_WARNING, 'Contents of file do not match with template of lines', __FILE__, __LINE__);
    190                         }
    191 
    192                         // TODO: Process all lines and update KMLPlacemark objects we already have in the current object
    193                         $type = $lineContent[0];
    194                         $host_name = str_replace('CNode', '', $lineContent[1]);
    195                         $has_been_checked = $lineContent[2];
    196                         $check_execution_time = $lineContent[3];
    197                         $current_state = $lineContent[4];
    198                         $last_hard_state = $lineContent[5];
    199                         $last_check = $lineContent[6];
    200                         $problem_has_been_acknowledged = $lineContent[7];
    201 
    202                         $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/>';
    203 
    204                         if ($placemarkPosition = $this->getPlacemarkByName($host_name)) {
     249                                trigger_log(LOG_WARNING, 'Contents of the file do not match with template of lines on line "' . $i . '"', __FILE__, __LINE__);
     250                                continue;
     251                        }
     252
     253                        // Checking for valid entries on this line
     254                        for ($j = 0; $j < 8; $j++) {
     255                                try {
     256                                        switch ($this->fileContent[$j]) {
     257                                                case 'string':
     258                                                        $lineContent[$j] = (string) $lineContent[$j];
     259                                                        break;
     260                                                case 'int':
     261                                                        $lineContent[$j] = (int) $lineContent[$j];
     262                                                        break;
     263                                                case 'double':
     264                                                        $lineContent[$j] = (double) $lineContent[$j];
     265                                                        break;
     266                                                default:
     267                                                        break;
     268                                        }
     269                                } catch (Exception $err) {
     270                                        trigger_log(SYSLOG_WARNING, 'The value "' . $j . '" on line "' . $i . '" is not valid, skipping to next line', __FILE__, __LINE__);
     271                                        continue;
     272                                }
     273                        }
     274
     275                        // Creating a string with the complete description of the node using all data in the status file
     276                        $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/>';
     277
     278                        if ($placemarkPosition = $this->getPlacemarkByName($lineContent[1])) {
     279                                // Updating an excisting placemark
    205280                                $this->KMLPlacemarks[$placemarkPosition]->setDescriptionStatus($descriptionStatus);
    206281                        } else {
     282                                // Adding a new placemark
    207283                                $placemark = new KMLPlacemark();
    208                                 $placemark->setID($host_name);
    209                                 $placemark->setName($host_name);
     284                                $placemark->setID($lineContent[1]);
     285                                $placemark->setName($lineContent[1]);
    210286                                $placemark->setDescriptionStatus($descriptionStatus);
    211287                                $this->addPlacemark($placemark);
Note: See TracChangeset for help on using the changeset viewer.