drupal_module__munin_api/munin_api.module

<?php
// $Id$
/**
 * @file
 * Munin API for Drupal.
 *
 * @author Frederic G. MARAND
 *
 * @copyright (c) 2011 Ouest Systèmes Informatiques
 *
 * Licensed under the General Public License version 2 or later.
 */

define('MUNIN_API_COUNTER',  'COUNTER');
define('MUNIN_API_DERIVE',   'DERIVE');
define('MUNIN_API_GAUGE',    'GAUGE');
define('MUNIN_API_ABSOLUTE', 'ABSOLUTE'); // Counters reset upon reading (uncommon)

/**
 * Finalize result pages for Munin interactions.
 *
 * - text content, not HTML
 * - non cacheable, even for anonymous users
 */
function _munin_api_page_closure($ret) {
  drupal_set_header('Content-type: text/plain');
  $GLOBALS['conf']['cache'] = CACHE_DISABLED; // prevent page_set_cache() in drupal_page_footer().

  print $ret;
  drupal_page_footer();
  exit();
}

/**
 * Display and log an incorrect hook implementation.
 *
 * @param string $hook
 * @param string $module
 *
 * @return string
 */
function _munin_report_hook_error($hook, $module) {
  $message = t('Incorrect implementation of hook_!hook() in module @module.');
  $params = array(
    '!hook' => $hook,
    '@module' => $module,
  );
  drupal_set_message(strtr($message, $params), 'error');
  watchdog('munin_api', $message, $params, WATCHDOG_ERROR);
  return '<p>'. l(t('Back'), 'admin/reports/munin_api/'. $module) .'</p>';
}

/**
 * Menu access callback for Munin config fetches.
 *
 * TODO: define rules, then code
 */
function munin_api_access_config($module) {
  return TRUE; // For now, protect at the web server level
}

/**
 * Menu access callback for Munin data fetches.
 *
 * TODO: define rules, then code
 */
function munin_api_access_fetch($module) {
  return TRUE; // For now, protect at the web server level
}

function munin_api_menu() {
  $items = array();

  $items['admin/reports/munin_api'] = array(
    'title' => 'Munin',
    'description' => 'Reports about Munin data collectors and their probes',
    'page callback' => 'munin_api_page_report_global',
    'access arguments' => array('access site reports'),
  );

  $items['admin/reports/munin_api/list'] = array(
    'type' => MENU_DEFAULT_LOCAL_TASK,
    'title' => 'General',
    'weight' => -1,
  );

  foreach (module_implements('munin_api_info') as $name) {
    $module = module_invoke($name, 'munin_api_info');
    $module = $module[$name];
    $items['munin_api/'. $name] = array(
      'type' => MENU_CALLBACK,
      'page callback' => 'munin_api_page_fetch',
      'page arguments' => array(1),
      'access callback' => 'munin_api_access_fetch',
      'access arguments' => array($name),
    );
    $items['munin_api/'. $name .'/config'] = array(
      'type' => MENU_CALLBACK,
      'page callback' => 'munin_api_page_config',
      'page arguments' => array(1),
      'access callback' => 'munin_api_access_config',
      'access arguments' => array($name),
    );

    $items['admin/reports/munin_api/'. $name] = array(
      'type' => MENU_LOCAL_TASK,
      'title' => $module['#title'],
      'description' => $module['#description'],
      'page callback' => 'munin_api_page_report_instance',
      'page arguments' => array(3),
      'access arguments' => array('access site reports'),
    );
  }


  return $items;
}

/**
 * Page callback for munin config fetches.
 */
function munin_api_page_config($module) {
  $module_info = module_invoke($module, 'munin_api_info');
  if (!is_array($module_info) || count($module_info) != 1) {
    return _munin_report_hook_error('munin_api_info', $module);
  }
  $info = reset($module_info);

  $config = array(
    'graph_title'    => $info['#title'],
    // 'graph_vlabel' => '',
    'graph_info'     => $info['#info'],
    'graph_category' => 'Drupal',
  );

  foreach (element_children($info) as $field_name) {
    foreach (element_properties($info[$field_name]) as $property_name) {
      $config[$field_name .'.'. drupal_substr($property_name, 1)] = $info[$field_name][$property_name];
    }
  }

  $ret = '';
  foreach ($config as $k => $v) {
    $ret .= $k .' '. $v . PHP_EOL;
  }
  _munin_api_page_closure($ret);
}

/**
 * Page callback for munin data fetches.
 */
function munin_api_page_fetch($module) {
  $data = module_invoke($module, 'munin_api_fetch');
  if (!is_array($data)) {
    return _munin_report_hook_error('munin_api_fetch', $module);
  }

  $ret = '';
  foreach ($data as $field => $value) {
    $ret .= $field .'.value '. $value . PHP_EOL;
  }

  _munin_api_page_closure($ret);
}

/**
 * Page callback for Munin global report.
 *
 * @return string
 */
function munin_api_page_report_global() {
  $items = module_invoke_all('munin_api_info');

  $header = array(
    t('Module'),
    t('Description'),
    t('Fields'),
  );
  $rows = array();
  foreach ($items as $name => $item) {
    $link_title = $item['#label'] ? $item['#label'] : $name;
    $rows[] = array(
      l($link_title, 'admin/reports/munin_api/'. $name),
      isset($item['#info']) ? $item['#info'] : t('&lt;missing&gt;'),
      count(element_children($item)),
    );
  }
  $ret = theme('table', $header, $rows);
  return $ret;
}

/**
 * Page callback for Munin instance report.
 *
 * @return string
 */
function munin_api_page_report_instance($module) {
  $module_info = module_invoke($module, 'munin_api_info');
  if (!is_array($module_info) || count($module_info) != 1) {
    return _munin_report_hook_error('munin_api_info', $module);
  }
  $module_info = reset($module_info);
  if (!is_array($module_info)) {
    return _munin_report_hook_error('munin_api_info', $module);
  }

  $header = array(t('Name'), t('Description'), t('Type'));
  $rows = array();
  foreach (element_children($module_info) as $name) {
    $rows[] = array(
      $name,
      isset($module_info[$name]['#label']) ? $module_info[$name]['#label'] : t('&lt;missing&gt;'),
      $module_info[$name]['#type'],
    );
  }
  $ret = theme('table', $header, $rows);
  $ret .= '<h3>Munin debug (text-only)</h3><p>'
    . l(t('Fetch data'), 'munin_api/'. $module)
    . ' '
    . l(t('Fetch config'), 'munin_api/'. $module .'/config');
  return $ret;
}