application/helpers/pnp.php

   1 <?php defined('SYSPATH') OR die('No direct access allowed.');
   2 /**
   3  * Help class for handling PNP related stuff such as
   4  * checking if we should display a graph link or not.
   5  */
   6 class pnp_Core
   7 {
   8         /**
   9         *       Check that there is actually a graph to display
  10         *       and that we can show a link to it.
  11         */
  12         public static function has_graph($host=false, $service=false)
  13         {
  14 throw new Exception('deprecated');
  15 /* TODO: integrate in normal query instead calling it for every host / service */
  16                 try {
  17                         $ls = Livestatus::instance();
  18                         $objects = null;
  19                         if (empty($service)) {
  20                                 $objects = $ls->getHosts(array('filter' => array('name' => $host), 'columns' => array('pnpgraph_present')));
  21                         } else {
  22                                 $service = urldecode($service);
  23                                 $objects = $ls->getServices(array('filter' => array('host_name' => $host, 'description' => $service), 'columns' => array('pnpgraph_present')));
  24                         }
  25                         if (isset($objects) and isset($objects[0]) and $objects[0]['pnpgraph_present'] === 1) {
  26                                 return true;
  27                         }
  28                 } catch (LivestatusException $ex) {}
  29                 return false;
  30         }
  31
  32         /**
  33          * Given a host and optionally a service, return all rrd sources
  34          *
  35          * @param $host A host name
  36          * @param $service A service description
  37          * @return An array of DS sources
  38          */
  39         public static function get_sources($host=false, $service=false)
  40         {
  41                 if (empty($host)) {
  42                         return array();
  43                 }
  44                 if (!self::is_enabled()) {
  45                         return array();
  46                 }
  47                 $host = self::clean($host);
  48                 $rrdbase = self::pnp_config('rrdbase');
  49                 if (empty($rrdbase)) {
  50                         # config missing or some other error
  51                         return array();
  52                 }
  53
  54                 $rrdbase = trim($rrdbase);
  55
  56                 # Better safe than sorry...
  57                 if (substr($rrdbase, -1, 1) != '/') {
  58                         $rrdbase .= '/';
  59                 }
  60
  61                 if (empty($service)) {
  62                         $service = '_HOST_';
  63                 } else {
  64                         # replace some strings in service name
  65                         # like PNP does
  66                         $service = urldecode($service);
  67                         $service = self::clean($service);
  68                 }
  69
  70                 $path = $rrdbase . $host . '/' . $service . '.xml';
  71
  72                 if (!posix_access($path, POSIX_R_OK))
  73                         return array();
  74
  75                 $contents = file_get_contents($path);
  76                 $xmldata = @simplexml_load_string($contents);
  77                 if ($xmldata === false) {
  78                         // one can always try...
  79                         $xmldata = @simplexml_load_string(utf8_encode($contents));
  80                 }
  81                 if ($xmldata === false || !isset($xmldata->DATASOURCE)) {
  82                         return array();
  83                 }
  84                 $res = array();
  85                 if ($xmldata->DATASOURCE) {
  86                         $i = 0;
  87                         foreach ($xmldata->DATASOURCE as $ds) {
  88                                 if (isset($ds->DS))
  89                                         $res[] = $i++;
  90                         }
  91                 }
  92                 return $res;
  93         }
  94
  95         /**
  96         *       Check if PNP is installed (enabled) on this machine
  97         */
  98         public static function is_enabled()
  99         {
 100                 $pnp_path = config::get('config.pnp4nagios_path');
 101                 return $pnp_path === false ? false : true;
 102         }
 103
 104         /**
 105         *       Fetch PNP config options and stash in current session.
 106         *       Returns the value of $key or entire config if no params
 107         */
 108         public static function pnp_config($key=false)
 109         {
 110                 $conf = Session::instance()->get('pnp_config', false);
 111
 112                 if (empty($conf)) {
 113                         # PNP config file consists of PHP code which makes it possible
 114                         # for us to just include it to get options available in $conf array
 115                         $pnp_config_file = Kohana::config('config.pnp4nagios_config_path');
 116                         if (file_exists($pnp_config_file))
 117                                 include_once($pnp_config_file);
 118
 119                         # Since the PNP is not very likely to change very often,
 120                         # we may store the config in session to save us from
 121                         # fetching it more than once per session.
 122                         Session::instance()->set('pnp_config', $conf);
 123                 }
 124                 return empty($key) ? $conf : $conf[$key];
 125         }
 126
 127         /**
 128          * Cleanses a string for use as a pnp object reference
 129          * @param $string The string to cleanse
 130          * @return The mangled string
 131          */
 132         public static function clean($string)
 133         {
 134                 $string = trim($string);
 135                 return preg_replace('/[ :\/\\\]/', "_", $string);
 136         }
 137
 138         /**
 139          * Creates a pnp url for a host or service
 140          *
 141          * @param $host The host
 142          * @param $service The service
 143          * @return A url usable from Ninja to get the desired pnp page
 144          */
 145         public static function url($host, $service=false)
 146         {
 147                 $base = config::get('config.pnp4nagios_path');
 148                 # luls hackish
 149                 if (!$base)
 150                         return 'PNP_seems_to_be_improperly_configured';
 151
 152                 $host = urlencode(pnp::clean($host));
 153                 if ($service !== false) {
 154                         $service = urlencode(pnp::clean($service));
 155                 } else {
 156                         $service = '_HOST_';
 157                 }
 158                 return $base . "/graph?host=$host&srv=$service";
 159         }
 160 }