modules/reports/libraries/HttpApiEvent_options.php

   1 <?php defined('SYSPATH') OR die('No direct access allowed.');
   2
   3 /**
   4  * The report options for the Event type of reports in the HTTP API
   5  */
   6 class HttpApiEvent_options extends Summary_options {
   7
   8         const MAX_EVENTS = 10000; /**< Pagination limit for events retrieved from HTTP API. Hardcoded, deal with it */
   9
  10         private $limit;
  11
  12         /**
  13          * Means to translate options back and forth between Report_options
  14          * terms and HTTP API parameters. Handles both input and output translation.
  15          */
  16         static $http_api_options = array(
  17                 'alert_types' => array(
  18                         'options' => array(
  19                                 'both' => 3,
  20                                 'host' => 1,
  21                                 'service' => 2
  22                         )
  23                 ),
  24                 'state_types' => array(
  25                         'options' => array(
  26                                 'both' => 3,
  27                                 'hard' => 2,
  28                                 'soft' => 1
  29                         )
  30                 ),
  31                 'host_states' => array(
  32                         'options' => array(
  33                                 'all' => 7,
  34                                 'problem' => 6,
  35                                 'up' => 1,
  36                                 'down' => 2,
  37                                 'unreachable' => 4
  38                         )
  39                 ),
  40                 'service_states' => array(
  41                         'options' => array(
  42                                 'all' => 15,
  43                                 'problem' => 14,
  44                                 'ok' => 1,
  45                                 'warning' => 2,
  46                                 'critical' => 4,
  47                                 'unknown' => 8
  48                         )
  49                 )
  50         );
  51
  52         /**
  53          * Select report options' properties to include and adjust
  54          * them for the HTTP API
  55          *
  56          * @param $options array = false
  57          */
  58         function __construct($options = false)
  59         {
  60                 parent::__construct(false); // allright, this is a bit hackish, but parent's constructor tries to set options
  61                 // but we're not actually ready for that yet (see below? we modify the properties which are used by set_options
  62
  63                 // whitelist properties to use, reuse the previous definitions
  64                 $this->properties = array_intersect_key(
  65                         $this->properties,
  66                         array_flip(array(
  67                                 'report_period',
  68                                 'alert_types',
  69                                 'state_types',
  70                                 'host_states',
  71                                 'service_states',
  72                                 'host_name',
  73                                 'service_description',
  74                                 'hostgroup',
  75                                 'servicegroup',
  76                                 'start_time',
  77                                 'end_time',
  78                                 'include_comments'
  79                         ))
  80                 );
  81                 $this->properties['include_comments'] = array(
  82                         'type' => 'bool',
  83                         'default' => false,
  84                         'description' => "Include events' comments"
  85                 );
  86                 $this->properties['alert_types']['description'] = _('Show events for this kind of objects');
  87                 $this->properties['host_states']['description'] = _('Limit the result set to a certain kind of host states');
  88                 $this->properties['service_states']['description'] = _('Limit the result set to a certain kind of service states');
  89                 $this->properties['state_types']['description'] = _('Restrict events based on which state the event is in (soft vs hard)');
  90
  91                 $limit = $this->limit = (int) Op5Config::instance()->getConfig('http_api.report.limit');
  92                 if($limit > self::MAX_EVENTS || $limit < 1) {
  93                         $this->limit = self::MAX_EVENTS;
  94                         $limit = $this->limit."; you can decrease this value in http_api.yml";
  95                 } else {
  96                         $limit .= "; you can increase this value in http_api.yml";
  97                 }
  98                 $this->properties['limit'] = array(
  99                         'type' => 'int',
 100                         'default' => $this->limit,
 101                         'description' => 'Include at most this many events (between 1 and '.$limit.')'
 102                 );
 103                 $this->properties['offset'] = array(
 104                         'type' => 'int',
 105                         'default' => 0,
 106                         'description' => 'Skip the first <em>offset</em> events matching the rest of the query, well suited for pagination'
 107                 );
 108
 109                 if($options) {
 110                         // finally make the call which *can not* be set in parent::__construct() until all properties and
 111                         // other boilerplate is set up
 112                         $this->set_options($options);
 113                 }
 114         }
 115
 116         /**
 117          * Listen for "http api" options/properties, instead of "report" options
 118          *
 119          * @param $input array = false
 120          * @return array
 121          */
 122         static function discover_options($input = false)
 123         {
 124                 $options = array();
 125                 if($input) {
 126                         $options = $input;
 127                 } elseif($_POST) {
 128                         $options = $_POST;
 129                 } elseif($_GET) {
 130                         $options = $_GET;
 131                 }
 132                 if(isset($options['start_time']) && !isset($options['end_time'])) {
 133                         $options['end_time'] = time();
 134                 }
 135                 if(isset($options['start_time']) || isset($options['end_time'])) {
 136                         // @todo workaround a nasty bug, implement this in Report_options directly
 137                         $options['report_period'] = 'custom';
 138                 }
 139                 if(isset($options['host_name'])) {
 140                         $options['host_name'] = (array) $options['host_name'];
 141                 }
 142                 if(isset($options['service_description'])) {
 143                         $options['service_description'] = (array) $options['service_description'];
 144                 }
 145
 146                 // translate "all" to valid int-bitmap, for example
 147                 foreach($options as $key => $value) {
 148                         if(isset(self::$http_api_options[$key]) &&
 149                                 isset(self::$http_api_options[$key]['options']) &&
 150                                 isset(self::$http_api_options[$key]['options'][$value])
 151                         ) {
 152                                 $options[$key] = self::$http_api_options[$key]['options'][$value];
 153                         }
 154                 }
 155                 return $options;
 156                 }
 157
 158                 /**
 159                  * @param $value mixed
 160                  * @param $type string
 161                  * @return string
 162                  */
 163                 function format_default($value, $type)
 164                 {
 165                         if($type == 'bool') {
 166                                 return (int) $value;
 167                         }
 168                         if($type == 'array' || $type == 'objsel') {
 169                                 if(empty($value)) {
 170                                         return "[empty]";
 171                                 }
 172                                 return implode(", ", $value);
 173                         }
 174                         if($type == 'string' && !$value) {
 175                                 return '[empty]';
 176                         }
 177                         if($type == 'enum') {
 178                                 return "'$value'";
 179                         }
 180                 if($type == 'int' && empty($value) && $value !== 0) {
 181                         return "[empty]";
 182                 }
 183                 return (string) $value;
 184         }
 185
 186         /**
 187          * Not as forgiving as the parent. (Why is parent forgiving?)
 188          *
 189          * @param $options array
 190          * @throws Api_Error_Response
 191          */
 192         function set_options($options) {
 193                 foreach($options as $name => $value) {
 194                         if(!$this->set($name, $value)) {
 195                                 throw new Api_Error_Response("Invalid value for option '$name'", 400);
 196                         }
 197                 }
 198         }
 199
 200         /**
 201          * Final step in the "from merlin.report_data row to API-output" process
 202          *
 203          * @param $row array
 204          * @return array
 205          */
 206         function to_output($row)
 207         {
 208                 // transform values
 209                 $type = $row['service_description'] ? 'service' : 'host';
 210                 $row['event_type'] = Reports_Model::event_type_to_string($row['event_type'], $type, true);
 211                 $row['state'] = strtolower(Current_status_Model::status_text($row['state'], true, $type));
 212
 213                 // rename properties
 214                 $row['in_scheduled_downtime'] = (int) $row['downtime_depth'];
 215                 unset($row['downtime_depth']);
 216                 if(isset($row['username'])) {
 217                         // comments are included and we've got one of them!
 218                         // let's produce some hierarchy
 219                         $row['comment'] = array(
 220                                 'username' => $row['username'],
 221                                 'comment' => $row['user_comment'],
 222                                 'timestamp' => $row['comment_timestamp'],
 223                         );
 224                 }
 225                 unset($row['username'], $row['user_comment'], $row['comment_timestamp']);
 226
 227                 return $row;
 228         }
 229
 230         /**
 231          * @todo be able to throw exceptions here to give feedback of
 232          * *which* error we experienced, since, you know, there's at
 233          * least one user (you) exposed to this API.. Help yourself
 234          *
 235          * @param $key string
 236          * @param $value mixed
 237          * @return boolean
 238          */
 239         protected function validate_value($key, &$value)
 240         {
 241                 if($key == 'limit') {
 242                         if(!$value) {
 243                                 $value = $this->limit;
 244                                 return true;
 245                         }
 246                         if(!is_numeric($value)) {
 247                                 return false;
 248                         }
 249                         $value = (int) $value;
 250                         if($value > $this->limit || $value < 1) {
 251                                 return false;
 252                         }
 253                         return true;
 254                 }
 255                 if($key == 'start_time' && isset($this->options['end_time']) && $value > $this->options['end_time']) {
 256                         return false;
 257                 }
 258                 if($key == 'end_time' && isset($this->options['start_time']) && $value < $this->options['start_time']) {
 259                         return false;
 260                 }
 261                 return parent::validate_value($key, $value);
 262         }
 263 }