class SensorManager in Monitoring 7

Manages sensor definitions and settings.

Provides list of enabled sensors. Sensors can be listed by category.

Maintains a (non persistent) info cache. Enables and disables sensors.

Hierarchy

• class \Drupal\monitoring\Sensor\SensorManager

1 file declares its use of SensorManager

monitoring.module in ./monitoring.module

Monitoring bootstrap file.

File

lib/Drupal/monitoring/Sensor/SensorManager.php, line 19

Contains \Drupal\monitoring\Sensor\SensorManager.

Namespace

Drupal\monitoring\Sensor

class SensorManager {

  /**
   * List of sensor definitions.
   *
   * @var \Drupal\monitoring\Sensor\SensorInfo[]
   */
  protected $info;

  /**
   * Returns monitoring sensor info.
   *
   * @return \Drupal\monitoring\Sensor\SensorInfo[]
   *   List of SensorInfo instances.
   */
  public function getSensorInfo() {
    if (empty($this->info)) {
      $this->info = $this
        ->loadSensorInfo();
    }
    return $this->info;
  }

  /**
   * Returns monitoring sensor info for enabled sensors.
   *
   * @return \Drupal\monitoring\Sensor\SensorInfo[]
   *   List of SensorInfo instances.
   */
  public function getEnabledSensorInfo() {
    $enabled_sensors = array();
    foreach ($this
      ->getSensorInfo() as $sensor_info) {
      if ($sensor_info
        ->isEnabled()) {
        $enabled_sensors[$sensor_info
          ->getName()] = $sensor_info;
      }
    }
    return $enabled_sensors;
  }

  /**
   * Returns monitoring sensor info for a given sensor.
   *
   * @param string $sensor_name
   *   Sensor id.
   *
   * @return \Drupal\monitoring\Sensor\SensorInfo
   *   A single SensorInfo instance.
   *
   * @throws \Drupal\monitoring\Sensor\NonExistingSensorException
   *   Thrown if the requested sensor does not exist.
   */
  public function getSensorInfoByName($sensor_name) {
    $info = $this
      ->getSensorInfo();
    if (isset($info[$sensor_name])) {
      return $info[$sensor_name];
    }
    throw new NonExistingSensorException(format_string('Sensor @sensor_name does not exist', array(
      '@sensor_name' => $sensor_name,
    )));
  }

  /**
   * Gets sensor info grouped by categories.
   *
   * @todo: The enabled flag is strange, FALSE should return all?
   *
   * @param bool $enabled
   *   Sensor isEnabled flag.
   *
   * @return \Drupal\monitoring\Sensor\SensorInfo[]
   *   Sensor info.
   */
  public function getSensorInfoByCategories($enabled = TRUE) {
    $info_by_categories = array();
    foreach ($this
      ->getSensorInfo() as $sensor_name => $sensor_info) {
      if ($sensor_info
        ->isEnabled() != $enabled) {
        continue;
      }
      $info_by_categories[$sensor_info
        ->getCategory()][$sensor_name] = $sensor_info;
    }
    return $info_by_categories;
  }

  /**
   * Reset the static cache
   */
  public function resetCache() {
    $this->info = array();
  }

  /**
   * Enable a sensor.
   *
   * Checks if the sensor is enabled and enables it if not.
   *
   * @param string $sensor_name
   *   Sensor name to be enabled.
   *
   * @throws \Drupal\monitoring\Sensor\NonExistingSensorException
   *   Thrown if the requested sensor does not exist.
   */
  public function enableSensor($sensor_name) {
    $sensor_info = $this
      ->getSensorInfoByName($sensor_name);
    if (!$sensor_info
      ->isEnabled()) {
      $settings = monitoring_sensor_settings_get($sensor_name);
      $settings['enabled'] = TRUE;
      monitoring_sensor_settings_save($sensor_name, $settings);
      $available_sensors = variable_get('monitoring_available_sensors', array());
      if (!isset($available_sensors[$sensor_name])) {

        // Use the watchdog message as the disappeared sensor does when new
        // sensors are detected.
        watchdog('monitoring', '@count new sensor/s added: @names', array(
          '@count' => 1,
          '@names' => $sensor_name,
        ));
      }
      $available_sensors[$sensor_name]['enabled'] = TRUE;
      $available_sensors[$sensor_name]['name'] = $sensor_name;
      variable_set('monitoring_available_sensors', $available_sensors);
    }
  }

  /**
   * Disable a sensor.
   *
   * Checks if the sensor is enabled and if so it will disable it and remove
   * from the active sensor list.
   *
   * @param string $sensor_name
   *   Sensor name to be disabled.
   *
   * @throws \Drupal\monitoring\Sensor\NonExistingSensorException
   *   Thrown if the requested sensor does not exist.
   */
  public function disableSensor($sensor_name) {
    $sensor_info = $this
      ->getSensorInfoByName($sensor_name);
    if ($sensor_info
      ->isEnabled()) {
      $settings = monitoring_sensor_settings_get($sensor_name);
      $settings['enabled'] = FALSE;
      monitoring_sensor_settings_save($sensor_name, $settings);
      $available_sensors = variable_get('monitoring_available_sensors', array());
      $available_sensors[$sensor_name]['enabled'] = FALSE;
      $available_sensors[$sensor_name]['name'] = $sensor_name;
      variable_set('monitoring_available_sensors', $available_sensors);
    }
  }

  /**
   * Callback for uasort() to order sensors by category and label.
   *
   * @param \Drupal\monitoring\Sensor\SensorInfo $a
   *   1st Object to compare with.
   *
   * @param \Drupal\monitoring\Sensor\SensorInfo $b
   *   2nd Object to compare with.
   *
   * @return int
   *   Sort order of the passed in SensorInfo objects.
   */
  public static function orderSensorInfo(SensorInfo $a, SensorInfo $b) {

    // Checks whether both labels and categories are equal.
    if ($a
      ->getLabel() == $b
      ->getLabel() && $a
      ->getCategory() == $b
      ->getCategory()) {
      return 0;
    }
    elseif ($a
      ->getCategory() != $b
      ->getCategory()) {
      return $a
        ->getCategory() < $b
        ->getCategory() ? -1 : 1;
    }

    // In the end, the label's order is determined.
    return $a
      ->getLabel() < $b
      ->getLabel() ? -1 : 1;
  }

  /**
   * Loads sensor info from hooks.
   *
   * Instantiates a SensorInfo for each sensor with merged settings.
   * Creates also instances for disabled sensors.
   *
   * @return \Drupal\monitoring\Sensor\SensorInfo[]
   *   List of SensorInfo instances.
   *
   * @see hook_monitoring_sensor_info()
   * @see hook_monitoring_sensor_info_alter()
   */
  protected function loadSensorInfo() {
    $info = array();

    // A module might provide a separate file with sensor definitions. Try to
    // include it prior to checking if a hook exists.
    // @todo: Use hook_hook_info().
    foreach (module_list() as $module) {
      $sensors_file = drupal_get_path('module', $module) . '/' . $module . '.monitoring_sensors.inc';
      if (file_exists($sensors_file)) {
        require_once $sensors_file;
      }
    }

    // Collect sensors info.
    $custom_implementations = module_implements('monitoring_sensor_info');
    foreach (module_list() as $module) {

      // Favor custom implementation.
      if (in_array($module, $custom_implementations)) {
        $result = module_invoke($module, 'monitoring_sensor_info');
        $info = drupal_array_merge_deep($info, $result);
      }
      elseif (function_exists('monitoring_' . $module . '_monitoring_sensor_info')) {
        $function = 'monitoring_' . $module . '_monitoring_sensor_info';
        $result = $function();
        if (is_array($result)) {
          $info = drupal_array_merge_deep($info, $result);
        }
      }
    }

    // Allow to alter the collected sensors info.
    drupal_alter('monitoring_sensor_info', $info);

    // Merge in saved sensor settings.
    foreach ($info as $key => &$value) {

      // Set default values.
      $value += array(
        'description' => '',
        'result_class' => 'Drupal\\monitoring\\Result\\SensorResult',
        'numeric' => TRUE,
        'value_label' => NULL,
        'settings' => array(),
      );
      $value['settings'] += array(
        'enabled' => TRUE,
        'caching_time' => 0,
        'category' => 'Other',
      );
      $value['settings'] = $this
        ->mergeSettings($key, $value['settings']);
    }

    // Support variable overrides.
    // @todo This might change in https://drupal.org/node/2170955.
    $info = drupal_array_merge_deep($info, variable_get('monitoring_sensor_info', array()));

    // Convert the arrays into SensorInfo objects.
    foreach ($info as $sensor_name => $sensor_info) {
      $info[$sensor_name] = new SensorInfo($sensor_name, $sensor_info);
    }

    // Sort the sensors by category and label.
    uasort($info, "\\Drupal\\monitoring\\Sensor\\SensorManager::orderSensorInfo");
    return $info;
  }

  /**
   * Merges provided sensor settings with saved settings.
   *
   * @param string $sensor_name
   *   Sensor name.
   * @param array $default_settings
   *   Default sensor settings.
   *
   * @return array
   *   Merged settings.
   */
  protected function mergeSettings($sensor_name, array $default_settings) {
    $saved_settings = monitoring_sensor_settings_get($sensor_name);
    return $this
      ->mergeSettingsArrays(array(
      $default_settings,
      $saved_settings,
    ));
  }

  /**
   * Merges settings arrays.
   *
   * Based on drupal_array_merge_deep_array() but with the additional special
   * case that flat arrays (arrays that don't have other arrays as values)
   * are replaced, not merged.
   *
   * That allows to expose settings forms for multiple values that can override
   * the default configuration.
   *
   * @param $arrays
   *   List of arrays to merge, later arrays replace keys in the previous.
   *
   * @return array
   *   The merged array.
   */
  protected function mergeSettingsArrays($arrays) {
    $result = array();
    foreach ($arrays as $array) {
      foreach ($array as $key => $value) {

        // Renumber integer keys as array_merge_recursive() does. Note that PHP
        // automatically converts array keys that are integer strings (e.g., '1')
        // to integers.
        if (is_integer($key)) {
          $result[] = $value;
        }
        elseif (isset($result[$key]) && is_array($result[$key]) && is_array($value) && $this
          ->isFlatArray($result[$key])) {
          $result[$key] = $value;
        }
        elseif (isset($result[$key]) && is_array($result[$key]) && is_array($value)) {
          $result[$key] = $this
            ->mergeSettingsArrays(array(
            $result[$key],
            $value,
          ));
        }
        else {
          $result[$key] = $value;
        }
      }
    }
    return $result;
  }

  /**
   * Returns if an array is flat.
   *
   * @param $array
   *   The array to check.
   *
   * @return bool
   *   TRUE if the array has no values that are arrays again.
   */
  protected function isFlatArray($array) {
    foreach ($array as $value) {
      if (is_array($value)) {
        return FALSE;
      }
    }
    return TRUE;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
SensorManager::$info	protected	property	List of sensor definitions.
SensorManager::disableSensor	public	function	Disable a sensor.
SensorManager::enableSensor	public	function	Enable a sensor.
SensorManager::getEnabledSensorInfo	public	function	Returns monitoring sensor info for enabled sensors.
SensorManager::getSensorInfo	public	function	Returns monitoring sensor info.
SensorManager::getSensorInfoByCategories	public	function	Gets sensor info grouped by categories.
SensorManager::getSensorInfoByName	public	function	Returns monitoring sensor info for a given sensor.
SensorManager::isFlatArray	protected	function	Returns if an array is flat.
SensorManager::loadSensorInfo	protected	function	Loads sensor info from hooks.
SensorManager::mergeSettings	protected	function	Merges provided sensor settings with saved settings.
SensorManager::mergeSettingsArrays	protected	function	Merges settings arrays.
SensorManager::orderSensorInfo	public static	function	Callback for uasort() to order sensors by category and label.
SensorManager::resetCache	public	function	Reset the static cache