class StatuspageController in Nagios Monitoring 8

Class StatuspageController produces the HTTP output that the bash script in the nagios-plugin directory understands.

@package Drupal\nagios\Controller

Hierarchy

class \Drupal\nagios\Controller\StatuspageController uses StringTranslationTrait

Expanded class hierarchy of StatuspageController

7 files declare their use of StatuspageController

CustomHookCheckTest.php in tests/src/Kernel/CustomHookCheckTest.php
MaintenanceModeSubscriber.php in src/EventSubscriber/MaintenanceModeSubscriber.php
MaintenanceModeTest.php in tests/src/Kernel/MaintenanceModeTest.php
nagios.module in ./nagios.module: Main file for Nagios service monitoring.
NagiosCheckTest.php in tests/src/Kernel/NagiosCheckTest.php

... See full list

File

src/Controller/StatuspageController.php, line 18

Namespace

Drupal\nagios\Controller

View source

class StatuspageController {
  use StringTranslationTrait;
  private $config;
  public function __construct() {
    $this->config = \Drupal::config('nagios.settings');
    _nagios_update_os_user();
  }

  /**
   * Main function building the string to show via HTTP.
   *
   * @param string $module_name
   *   Only check the given module with a hook_nagios() implementation.
   * @param string $id_for_hook
   *   An arbitrary value to pass into the hook_nagios() implementation.
   *
   * @return \Symfony\Component\HttpFoundation\Response
   */
  public function content(string $module_name = '', string $id_for_hook = '') {

    // Disable cache:
    \Drupal::service('page_cache_kill_switch')
      ->trigger();

    // Check the unique ID string and access permissions first.
    $ua = $this->config
      ->get('nagios.ua');
    $request_code = $_SERVER['HTTP_USER_AGENT'];

    // Check if HTTP GET variable "unique_id" is used and the usage is allowed.
    if (isset($_GET['unique_id']) && $this->config
      ->get('nagios.statuspage.getparam') == TRUE) {
      $request_code = $_GET['unique_id'];
    }
    if ($request_code == $ua || \Drupal::currentUser()
      ->hasPermission('administer site configuration')) {

      // Authorized, so go ahead calling all modules:
      $nagios_data = $module_name ? [
        $module_name => call_user_func($module_name . '_nagios', $id_for_hook),
      ] : nagios_invoke_all('nagios');
    }
    else {

      // This is not an authorized unique id or user,
      // so just return this default status.
      $nagios_data = [
        'nagios' => [
          'DRUPAL' => [
            'status' => NAGIOS_STATUS_UNKNOWN,
            'type' => 'state',
            'text' => $this
              ->t('Unauthorized'),
          ],
        ],
      ];
    }
    [
      $output,
    ] = $this
      ->getStringFromNagiosData($nagios_data);
    $response = new Response($output, Response::HTTP_OK, [
      'Content-Type' => 'text/plain',
    ]);

    // Disable browser cache:
    $response
      ->setMaxAge(0);
    $response
      ->setExpires();
    return $response;
  }

  /**
   * Belongs to nagios_check_requirements() function.
   *
   * TODO: compare with functions in nagios.drush.inc; remove repeated code,
   * if possible.
   *
   * @param string $tmp_state
   * @param ImmutableConfig $config
   */
  private function calculateOutdatedModuleAndThemeNames(&$tmp_state, ImmutableConfig $config) {
    $tmp_projects = update_calculate_project_data(\Drupal::service('update.manager')
      ->getProjects());
    $nagios_ignored_modules = $config
      ->get('nagios.ignored_modules') ?: [];
    $nagios_ignored_themes = $config
      ->get('nagios.ignored_themes') ?: [];
    $nagios_ignored_projects = $nagios_ignored_modules + $nagios_ignored_themes;
    $outdated_count = 0;
    $tmp_modules = '';
    foreach ($tmp_projects as $project_name => $value) {
      if (!isset($nagios_ignored_projects[$project_name]) && $value['status'] < UpdateManagerInterface::CURRENT && $value['status'] >= UpdateManagerInterface::NOT_SECURE) {
        switch ($value['status']) {
          case UpdateManagerInterface::NOT_SECURE:
            $project_status = $this
              ->t('NOT SECURE');
            break;
          case UpdateManagerInterface::REVOKED:
            $project_status = $this
              ->t('REVOKED');
            break;
          case UpdateManagerInterface::NOT_SUPPORTED:
            $project_status = $this
              ->t('NOT SUPPORTED');
            break;
          case UpdateManagerInterface::NOT_CURRENT:
            $project_status = $this
              ->t('NOT CURRENT');
            break;
          default:
            $project_status = $value['status'];
        }
        $tmp_modules .= ' ' . $project_name . ':' . $project_status;
        $outdated_count++;
      }
    }
    if ($outdated_count > 0) {
      $tmp_modules = trim($tmp_modules);
      $tmp_state .= " ({$tmp_modules})";
    }
  }

  /**
   * Route callback to allow for user-defined URL of status page.
   *
   * @return Route[]
   */
  public function routes() {
    $config = \Drupal::config('nagios.settings');
    $routes = [];

    // Declares a single route under the name 'example.content'.
    // Returns an array of Route objects.
    $routes['nagios.statuspage'] = new Route($config
      ->get('nagios.statuspage.path') . '/{module_name}/{id_for_hook}', [
      '_controller' => $config
        ->get('nagios.statuspage.controller'),
      '_title' => 'Nagios Status',
      'module_name' => '',
      'id_for_hook' => '',
    ], [
      '_custom_access' => '\\Drupal\\nagios\\Controller\\StatuspageController::access',
    ]);
    return $routes;
  }

  /**
   * Checks if the status page should exist.
   *
   * @return \Drupal\Core\Access\AccessResult
   */
  public function access() {
    $config = \Drupal::config('nagios.settings');
    return AccessResult::allowedIf($config
      ->get('nagios.statuspage.enabled'));
  }

  /**
   * For backwards compatibility, this module uses defines to set levels.
   *
   * This function is called globally in nagios.module.
   *
   * @param \Drupal\Core\Config\ImmutableConfig|null $config
   *   Config to read the values from
   */
  public static function setNagiosStatusConstants(ImmutableConfig $config = NULL) {

    // Defines to be used by this module and others that use its hook_nagios().
    if (!$config) {
      $config = \Drupal::config('nagios.settings');
    }
    if ($config
      ->get('nagios.status.ok') === NULL) {

      // Should only happen in tests, as the config might not be loaded yet.
      return;
    }
    define('NAGIOS_STATUS_OK', $config
      ->get('nagios.status.ok'));
    define('NAGIOS_STATUS_WARNING', $config
      ->get('nagios.status.warning'));
    define('NAGIOS_STATUS_CRITICAL', $config
      ->get('nagios.status.critical'));
    define('NAGIOS_STATUS_UNKNOWN', $config
      ->get('nagios.status.unknown'));
  }

  /**
   * @param array $nagios_data
   *
   * @return array{
   *   0: string,
   *   1: int
   * }
   */
  public function getStringFromNagiosData(array $nagios_data) {

    // Find the highest level to be the overall status:
    $severity = NAGIOS_STATUS_OK;
    $min_severity = $this->config
      ->get('nagios.min_report_severity');
    $output_state = [];
    $output_perf = [];
    $codes = nagios_status();
    foreach ($nagios_data as $module_name => $module_data) {
      foreach ($module_data as $key => $value) {

        // Check status and set global severity:
        if (is_array($value) && array_key_exists('status', $value) && $value['status'] >= $min_severity) {
          $severity = max($severity, $value['status']);
        }
        switch ($value['type']) {
          case 'state':

            // Complain only if status is larger than minimum severity:
            if ($value['status'] >= $min_severity) {
              $tmp_state = $key . ':' . $codes[$value['status']];
            }
            else {
              $tmp_state = $key . ':' . $codes[NAGIOS_STATUS_OK];
            }
            if (!empty($value['text'])) {
              $tmp_state .= '=' . $value['text'];
            }

            // TODO: The $value['text'] condition is very likely wrong.
            // Check with automated tests.
            if ($key == 'ADMIN' && (string) $value['text'] == (string) $this
              ->t('Module and theme update status') && $this->config
              ->get('nagios.show_outdated_names')) {
              $this
                ->calculateOutdatedModuleAndThemeNames($tmp_state, $this->config);
            }
            $output_state[] = $tmp_state;
            break;
          case 'perf':
            $output_perf[] = $key . '=' . $value['text'];
            break;
        }
      }
    }

    // Identifier that we check on the bash side:
    $output = "\n" . 'nagios=' . $codes[$severity] . ', ';
    $output .= implode(', ', $output_state) . ' | ' . implode('; ', $output_perf) . "\n";
    return [
      $output,
      $severity,
    ];
  }

}

Members

Name	Modifiers	Type	Description	Overrides
StatuspageController::$config	private	property
StatuspageController::access	public	function	Checks if the status page should exist.
StatuspageController::calculateOutdatedModuleAndThemeNames	private	function	Belongs to nagios_check_requirements() function.
StatuspageController::content	public	function	Main function building the string to show via HTTP.
StatuspageController::getStringFromNagiosData	public	function
StatuspageController::routes	public	function	Route callback to allow for user-defined URL of status page.
StatuspageController::setNagiosStatusConstants	public static	function	For backwards compatibility, this module uses defines to set levels.
StatuspageController::__construct	public	function
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	1
StringTranslationTrait::formatPlural	protected	function	Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals	protected	function	Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation	protected	function	Gets the string translation service.
StringTranslationTrait::setStringTranslation	public	function	Sets the string translation service to use.	2
StringTranslationTrait::t	protected	function	Translates a string to the current language or to a given language.

You are here

class StatuspageController in Nagios Monitoring 8

Hierarchy

File

Namespace

Members

API Navigation