pandorafms/pandora_console/include/functions_extensions.php

412 lines
10 KiB
PHP
Raw Normal View History

<?php
// Pandora FMS - http://pandorafms.com
// ==================================================
// Copyright (c) 2005-2010 Artica Soluciones Tecnologicas
// Please see http://pandorafms.org for full contribution list
// This program is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public License
// as published by the Free Software Foundation; version 2
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
2009-08-24 Miguel de Dios <miguel.dedios@artica.es> * include/functions_menu.php, include/functions_html.php, include/functions_events.php, include/functions_messages.php, include/functions_modules.php, include/functions_exportserver.php, include/functions_reporting.php, include/functions_filemanager.php, include/pchart_graph.php, include/pandora_graph.php, include/auth/dev.php, include/auth/ldap.php, include/auth/mysql.php, include/config.inc.php, include/functions_networkmap.php, include/functions_servers.php, include/FusionCharts/FusionCharts_Gen.php, include/FusionCharts/FusionCharts.php, include/functions_network_profiles.php, include/gettext.php, include/functions_network_components.php, include/functions_visual_map.php, include/fgraph2.php, include/Image/image_functions.php, include/functions_config.php, include/help/en/help_plugin_parameters.php, include/help/en/help_snmpcommunity.php, include/help/en/help_wmiquery.php, include/help/en/help_postprocess.php, include/help/en/help_prediction_source_module.php, include/help/en/help_date_format.php, include/help/en/help_recontask.php, include/help/en/help_alert-matches.php, include/help/en/help_tcp_send.php, include/help/en/help_wmifield.php, include/help/en/help_duplicateconfig.php, include/help/en/help_agent_status.php, include/help/en/help_manage_alerts.php, include/help/en/help_wmikey.php, include/help/en/help_alert_type.php, include/help/en/help_network_component.php, include/help/en/help_time_stamp-comparation.php, include/help/en/help_eventview.php, include/help/en/help_timesource.php, include/help/en/help_alert_validation.php, include/help/en/help_map_builder.php, include/help/en/help_alert_recovery.php, include/help/en/help_module_type.php, include/help/en/help_planned_downtime.php, include/help/en/help_serverlag.php, include/help/en/help_alerts.php, include/help/en/help_snmpwalk.php, include/help/en/help_module_definition.php, include/help/en/help_plugin_definition.php, include/help/en/help_wminamespace.php, include/help/en/help_snmpoid.php include/help/en/help_manageconfig.php, include/help/es/help_alert_validation.php, include/help/es/help_plugin_parameters.php, include/help/es/help_snmpcommunity.php, include/help/es/help_wmiquery.php, include/help/es/help_map_builder.php, include/help/es/help_postprocess.php, include/help/es/help_date_format.php, include/help/es/help_alert_recovery.php, include/help/es/help_prediction_source_module.php, include/help/es/help_module_type.php, include/help/es/help_planned_downtime.php, include/help/es/help_alert-matches.php, include/help/es/help_recontask.php, include/help/es/help_alerts.php, include/help/es/help_serverlag.php, include/help/es/help_snmpwalk.php, include/help/es/help_module_definition.php, include/help/es/help_tcp_send.php, include/help/es/help_duplicateconfig.php, include/help/es/help_wmifield.php, include/help/es/help_manage_alerts.php, include/help/es/help_wmikey.php, include/help/es/help_plugin_definition.php, include/help/es/help_alert_type.php, include/help/es/help_snmpoid.php, include/help/es/help_wminamespace.php, include/help/es/help_network_component.php, include/help/es/help_time_stamp-comparation.php, include/help/es/help_manageconfig.php, include/help/es/help_timesource.php, include/config_process.php, include/functions_ui.php, include/htmlawed.php, include/functions_custom_graphs.php, include/fgraph.php, include/functions_incidents.php, include/functions.php, include/functions_agents.php, include/functions_db.php, include/functions_themes.php, include/streams.php, include/functions_fsgraph.php, include/functions_alerts.php, include/functions_reports.php, include/functions_extensions.php, include/functions_ui_renders.php: change comments blocks for delete the warnings to construct phpDoc Files, give a struct and order in the phpDoc files. git-svn-id: https://svn.code.sf.net/p/pandora/code/trunk@1881 c3f86ba8-e40f-0410-aaad-9ba5e7f4b01f
2009-08-25 19:39:28 +02:00
/**
* @package Include
* @subpackage Extensions
2009-08-24 Miguel de Dios <miguel.dedios@artica.es> * include/functions_menu.php, include/functions_html.php, include/functions_events.php, include/functions_messages.php, include/functions_modules.php, include/functions_exportserver.php, include/functions_reporting.php, include/functions_filemanager.php, include/pchart_graph.php, include/pandora_graph.php, include/auth/dev.php, include/auth/ldap.php, include/auth/mysql.php, include/config.inc.php, include/functions_networkmap.php, include/functions_servers.php, include/FusionCharts/FusionCharts_Gen.php, include/FusionCharts/FusionCharts.php, include/functions_network_profiles.php, include/gettext.php, include/functions_network_components.php, include/functions_visual_map.php, include/fgraph2.php, include/Image/image_functions.php, include/functions_config.php, include/help/en/help_plugin_parameters.php, include/help/en/help_snmpcommunity.php, include/help/en/help_wmiquery.php, include/help/en/help_postprocess.php, include/help/en/help_prediction_source_module.php, include/help/en/help_date_format.php, include/help/en/help_recontask.php, include/help/en/help_alert-matches.php, include/help/en/help_tcp_send.php, include/help/en/help_wmifield.php, include/help/en/help_duplicateconfig.php, include/help/en/help_agent_status.php, include/help/en/help_manage_alerts.php, include/help/en/help_wmikey.php, include/help/en/help_alert_type.php, include/help/en/help_network_component.php, include/help/en/help_time_stamp-comparation.php, include/help/en/help_eventview.php, include/help/en/help_timesource.php, include/help/en/help_alert_validation.php, include/help/en/help_map_builder.php, include/help/en/help_alert_recovery.php, include/help/en/help_module_type.php, include/help/en/help_planned_downtime.php, include/help/en/help_serverlag.php, include/help/en/help_alerts.php, include/help/en/help_snmpwalk.php, include/help/en/help_module_definition.php, include/help/en/help_plugin_definition.php, include/help/en/help_wminamespace.php, include/help/en/help_snmpoid.php include/help/en/help_manageconfig.php, include/help/es/help_alert_validation.php, include/help/es/help_plugin_parameters.php, include/help/es/help_snmpcommunity.php, include/help/es/help_wmiquery.php, include/help/es/help_map_builder.php, include/help/es/help_postprocess.php, include/help/es/help_date_format.php, include/help/es/help_alert_recovery.php, include/help/es/help_prediction_source_module.php, include/help/es/help_module_type.php, include/help/es/help_planned_downtime.php, include/help/es/help_alert-matches.php, include/help/es/help_recontask.php, include/help/es/help_alerts.php, include/help/es/help_serverlag.php, include/help/es/help_snmpwalk.php, include/help/es/help_module_definition.php, include/help/es/help_tcp_send.php, include/help/es/help_duplicateconfig.php, include/help/es/help_wmifield.php, include/help/es/help_manage_alerts.php, include/help/es/help_wmikey.php, include/help/es/help_plugin_definition.php, include/help/es/help_alert_type.php, include/help/es/help_snmpoid.php, include/help/es/help_wminamespace.php, include/help/es/help_network_component.php, include/help/es/help_time_stamp-comparation.php, include/help/es/help_manageconfig.php, include/help/es/help_timesource.php, include/config_process.php, include/functions_ui.php, include/htmlawed.php, include/functions_custom_graphs.php, include/fgraph.php, include/functions_incidents.php, include/functions.php, include/functions_agents.php, include/functions_db.php, include/functions_themes.php, include/streams.php, include/functions_fsgraph.php, include/functions_alerts.php, include/functions_reports.php, include/functions_extensions.php, include/functions_ui_renders.php: change comments blocks for delete the warnings to construct phpDoc Files, give a struct and order in the phpDoc files. git-svn-id: https://svn.code.sf.net/p/pandora/code/trunk@1881 c3f86ba8-e40f-0410-aaad-9ba5e7f4b01f
2009-08-25 19:39:28 +02:00
*/
$extension_file = '';
/**
* TODO: Document extensions
*
* @param string $filename
*/
function extension_call_main_function ($filename) {
global $config;
$extension = &$config['extensions'][$filename];
if ($extension['main_function'] != '') {
$params = array ();
call_user_func_array ($extension['main_function'], $params);
}
}
/**
* TODO: Document extensions
*
* @param string $filename
*/
function extension_call_godmode_function ($filename) {
global $config;
$extension = &$config['extensions'][$filename];
if ($extension['godmode_function'] != '') {
$params = array ();
call_user_func_array ($extension['godmode_function'], $params);
}
}
/**
* TODO: Document extensions
*/
function extensions_call_login_function () {
global $config;
$params = array ();
foreach ($config['extensions'] as $extension) {
if ($extension['login_function'] == '')
continue;
call_user_func_array ($extension['login_function'], $params);
}
}
/**
* TODO: Document extensions
*
* @param string $page
*/
function is_extension ($page) {
global $config;
$filename = basename ($page);
return isset ($config['extensions'][$filename]);
}
/**
* Scan the EXTENSIONS_DIR or ENTERPRISE_DIR.'/'.EXTENSIONS_DIR for search
* the files extensions.
*
* @param bool $enterprise
*/
function get_extensions ($enterprise = false) {
$dir = EXTENSIONS_DIR;
$handle = false;
if ($enterprise)
$dir = ENTERPRISE_DIR.'/'.EXTENSIONS_DIR;
if (file_exists ($dir))
$handle = @opendir ($dir);
if (empty ($handle))
return;
$file = readdir ($handle);
$extensions = array ();
$ignores = array ('.', '..');
while ($file !== false) {
if (in_array ($file, $ignores)) {
$file = readdir ($handle);
continue;
}
$filepath = realpath ($dir."/".$file);
if (! is_readable ($filepath) || is_dir ($filepath) || ! preg_match ("/.*\.php$/", $filepath)) {
$file = readdir ($handle);
continue;
}
$extension['file'] = $file;
$extension['operation_menu'] = '';
$extension['godmode_menu'] = '';
$extension['main_function'] = '';
$extension['godmode_function'] = '';
$extension['login_function'] = '';
$extension['enterprise'] = $enterprise;
$extension['dir'] = $dir;
$extensions[$file] = $extension;
$file = readdir ($handle);
}
/* Load extensions in enterprise directory */
if (! $enterprise && file_exists (ENTERPRISE_DIR.'/'.EXTENSIONS_DIR))
return array_merge ($extensions, get_extensions (true));
return $extensions;
}
function get_disabled_extensions() {
global $config;
$extensions = array ();
$dirs = array('open' => EXTENSIONS_DIR . '/disabled', 'enterprise' => ENTERPRISE_DIR . '/' . EXTENSIONS_DIR . '/disabled');
foreach ($dirs as $type => $dir) {
$handle = false;
if (file_exists ($dir))
$handle = @opendir ($dir);
if (empty ($handle))
continue;
$ignores = array ('.', '..');
$file = readdir ($handle);
while ($file !== false) {
if (in_array ($file, $ignores)) {
$file = readdir ($handle);
continue;
}
$filepath = realpath ($dir."/".$file);
if (! is_readable ($filepath) || is_dir ($filepath) || ! preg_match ("/.*\.php$/", $filepath)) {
$file = readdir ($handle);
continue;
}
//$content = file_get_contents($filepath);
$content = '';
$data = array();
$data['operation_menu'] = false;
if (preg_match("/<?php(\n|.)*add_operation_menu_option(\n|.)*?>/", $content)) {
$data['operation_menu'] = true;
}
$data['godmode_menu'] = false;
if (preg_match('/<\?php(\n|.)*add_godmode_menu_option(\n|.)*\?>/', $content)) {
$data['godmode_menu'] = true;
}
$data['operation_function'] = false;
if (preg_match('/<\?php(\n|.)*add_extension_main_function(\n|.)*\?>/', $content)) {
$data['operation_function'] = true;
}
$data['login_function'] = false;
if (preg_match('/<\?php(\n|.)*add_extension_login_function(\n|.)*\?>/', $content)) {
$data['login_function'] = true;
}
$data['extension_ope_tab'] = false;
if (preg_match('/<\?php(\n|.)*add_extension_opemode_tab_agent(\n|.)*\?>/', $content)) {
$data['extension_ope_tab'] = true;
}
$data['extension_god_tab'] = false;
if (preg_match('/<\?php(\n|.)*add_extension_godmode_tab_agent(\n|.)*\?>/', $content)) {
$data['extension_god_tab'] = true;
}
$data['godmode_function'] = false;
if (preg_match('/<\?php(\n|.)*add_extension_godmode_function(\n|.)*\?>/', $content)) {
$data['godmode_function'] = true;
}
$data['enterprise'] = false;
if ($type == 'enterprise') {
$data['enterprise'] = true;
}
$data['enabled'] = false;
$extensions[$file] = $data;
$file = readdir ($handle);
}
}
return $extensions;
}
function getExtensionInfo() {
global $config;
$return = array ();
foreach($config['extensions'] as $extension) {
$data = array();
$data['godmode_function'] = false;
if (!empty($extension['godmode_function'])) {
$data['godmode_function'] = true;
}
$data['godmode_menu'] = false;
if (!empty($extension['godmode_menu'])) {
$data['godmode_menu'] = true;
}
$data['operation_function'] = false;
if (!empty($extension['main_function'])) {
$data['operation_function'] = true;
}
$data['operation_menu'] = false;
if (!empty($extension['operation_menu'])) {
$data['operation_menu'] = true;
}
$data['login_function'] = false;
if (!empty($extension['login_function'])) {
$data['login_function'] = true;
}
$data['extension_ope_tab'] = false;
if (!empty($extension['extension_ope_tab'])) {
$data['extension_ope_tab'] = true;
}
$data['extension_god_tab'] = false;
if (!empty($extension['extension_god_tab'])) {
$data['extension_god_tab'] = true;
}
$data['enterprise'] = (bool)$extension['enterprise'];
$data['enabled'] = true;
$return[$extension['file']] = $data;
}
$return = $return + get_disabled_extensions();
return $return;
}
/**
* TODO: Document extensions
*
* @param array $extensions
*/
function load_extensions ($extensions) {
global $config;
global $extension_file;
foreach ($extensions as $extension) {
$extension_file = $extension['file'];
require_once (realpath ($extension['dir']."/".$extension_file));
}
}
/**
* TODO: Document extensions
*
* @param string name
* @param string fatherId
* @param string icon
*/
function add_operation_menu_option ($name, $fatherId = null, $icon = null) {
global $config;
global $extension_file;
/* $config['extension_file'] is set in load_extensions(), since that function must
be called before any function the extension call, we are sure it will
be set. */
$option_menu['name'] = $name;
$extension = &$config['extensions'][$extension_file];
$option_menu['sec2'] = $extension['dir'].'/'.mb_substr ($extension_file, 0, -4);
$option_menu['fatherId'] = $fatherId;
$option_menu['icon'] = $icon;
$extension['operation_menu'] = $option_menu;
}
/**
* TODO: Document extensions
*
* @param string name
* @param string acl
* @param string fatherId
* @param string icon
*/
function add_godmode_menu_option ($name, $acl, $fatherId = null, $icon = null) {
global $config;
global $extension_file;
/* $config['extension_file'] is set in load_extensions(), since that function must
be called before any function the extension call, we are sure it will
be set. */
$option_menu['acl'] = $acl;
$option_menu['name'] = $name;
$extension = &$config['extensions'][$extension_file];
$option_menu['sec2'] = $extension['dir'].'/'.mb_substr ($extension_file, 0, -4);
$option_menu['fatherId'] = $fatherId;
$option_menu['icon'] = $icon;
$extension['godmode_menu'] = $option_menu;
}
/**
* Add in the header tabs in godmode agent the extension tab.
*
* @param $tabId
* @param $tabName
* @param $tabIcon
* @param $tabFunction
*/
function add_extension_godmode_tab_agent($tabId, $tabName, $tabIcon, $tabFunction) {
global $config;
global $extension_file;
$extension = &$config['extensions'][$extension_file];
$extension['extension_god_tab'] = array();
$extension['extension_god_tab']['id'] = $tabId;
$extension['extension_god_tab']['name'] = $tabName;
$extension['extension_god_tab']['icon'] = $tabIcon;
$extension['extension_god_tab']['function'] = $tabFunction;
}
/**
* Add in the header tabs in operation agent the extension tab.
*
* @param unknown_type $tabId
* @param unknown_type $tabName
* @param unknown_type $tabIcon
* @param unknown_type $tabFunction
*/
function add_extension_opemode_tab_agent($tabId, $tabName, $tabIcon, $tabFunction) {
global $config;
global $extension_file;
$extension = &$config['extensions'][$extension_file];
$extension['extension_ope_tab'] = array();
$extension['extension_ope_tab']['id'] = $tabId;
$extension['extension_ope_tab']['name'] = $tabName;
$extension['extension_ope_tab']['icon'] = $tabIcon;
$extension['extension_ope_tab']['function'] = $tabFunction;
}
/**
* Add the function to call in OPERATION
*
* @param string $function_name
*/
function add_extension_main_function ($function_name) {
global $config;
global $extension_file;
$extension = &$config['extensions'][$extension_file];
$extension['main_function'] = $function_name;
}
/**
* TODO: Document extensions
*
* @param string $function_name
*/
function add_extension_godmode_function ($function_name) {
global $config;
global $extension_file;
$extension = &$config['extensions'][$extension_file];
$extension['godmode_function'] = $function_name;
}
/**
* TODO: Document extensions
*
* @param string $function_name
*/
function add_extension_login_function ($function_name) {
global $config;
global $extension_file;
$extension = &$config['extensions'][$extension_file];
$extension['login_function'] = $function_name;
}
?>