2021-06-15 17:24:03 +02:00
< ? php
/**
* Plugin registration .
*
* @ category Plugins
* @ package Pandora FMS
* @ subpackage Community
* @ version 1.0 . 0
* @ license See below
*
* ______ ___ _______ _______ ________
2023-06-08 12:42:10 +02:00
* | __ \ .-----.--.--.--| |.-----.----.-----. | ___ | | | __ |
* | __ /| _ | | _ || _ | _ | _ | | ___ | | __ |
2021-06-15 17:24:03 +02:00
* | ___ | | ___ . _ | __ | __ | _____ || _____ | __ | | ___ . _ | | ___ | | __ | _ | __ | _______ |
*
* ============================================================================
2023-06-08 11:53:13 +02:00
* Copyright ( c ) 2005 - 2023 Pandora FMS
2023-06-08 13:19:01 +02:00
* Please see https :// pandorafms . com / community / for full contribution list
2021-06-15 17:24:03 +02:00
* This program is free software ; you can redistribute it and / or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation for 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 .
* ============================================================================
*/
2021-06-16 15:53:05 +02:00
use PandoraFMS\Enterprise\Metaconsole\Synchronizer ;
use PandoraFMS\Tools\Files ;
2021-06-15 17:24:03 +02:00
// Load global vars.
global $config ;
// Check ACL and Login.
check_login ();
if (( bool ) check_acl ( $config [ 'id_user' ], 0 , 'PM' ) === false
2021-06-16 17:26:19 +02:00
|| ( bool ) check_acl ( $config [ 'id_user' ], 0 , 'AW' ) === false
2021-06-15 17:24:03 +02:00
) {
db_pandora_audit (
2022-01-20 10:55:23 +01:00
AUDIT_LOG_ACL_VIOLATION ,
2021-06-15 17:24:03 +02:00
'Trying to access Plugin Management'
);
include 'general/noaccess.php' ;
return ;
}
ui_require_css_file ( 'first_task' );
if ( is_metaconsole () === true ) {
enterprise_include_once ( 'meta/include/functions_components_meta.php' );
components_meta_print_header ();
$sec = 'advanced' ;
$management_allowed = is_management_allowed ();
if ( $management_allowed === false ) {
ui_print_warning_message (
__ ( 'To manage plugin you must activate centralized management' )
);
return ;
}
} else {
2023-03-06 17:51:49 +01:00
ui_print_standard_header (
2021-06-15 17:24:03 +02:00
__ ( 'PLUGIN REGISTRATION' ),
'images/gm_servers.png' ,
false ,
'' ,
2023-03-06 17:51:49 +01:00
true ,
[],
[
[
'link' => '' ,
'label' => __ ( 'Servers' ),
],
[
'link' => '' ,
'label' => __ ( 'Register plugin' ),
],
]
2021-06-15 17:24:03 +02:00
);
$management_allowed = is_management_allowed ();
if ( $management_allowed === false ) {
ui_print_warning_message (
__ (
2021-06-25 12:54:14 +02:00
'This console is not manager of this environment, please manage this feature from feature from %s.' ,
'<a target="_blank" href="' . ui_get_meta_url (
'index.php?sec=advanced&sec2=godmode/servers/plugin_registration&tab=plugin_registration&pure=0'
) . '">' . __ ( 'metaconsole' ) . '</a>'
2021-06-15 17:24:03 +02:00
)
);
return ;
}
}
$output = '<div class="new_task">' ;
$output .= '<div class="image_task">' ;
$output .= html_print_image (
'images/first_task/icono_grande_import.png' ,
true ,
[ 'title' => __ ( 'Plugin Registration' ) ]
);
$output .= '</div>' ;
$output .= '<div class="text_task">' ;
$output .= '<h3>' . __ ( 'Plugin registration' ) . '</h3>' ;
$output .= '<p id="description_task">' ;
2023-05-17 11:19:57 +02:00
$output .= __ ( 'This extension makes registering server plugins an easier task. Here you can upload a server plugin in .pspz zipped format. Please refer to the official documentation on how to obtain and use Server Plugins.' );
2021-06-15 17:24:03 +02:00
$output .= '<br><br>' ;
$output .= __ ( 'You can get more plugins in our' );
2022-01-17 17:13:29 +01:00
$output .= '<a href="https://pandorafms.com/Library/Library/">' ;
2021-06-15 17:24:03 +02:00
$output .= ' ' . __ ( 'Public Resource Library' );
$output .= '</a>' ;
$output .= '</p>' ;
// Upload form.
$output .= " <form name='submit_plugin' method='post' enctype='multipart/form-data'> " ;
$output .= '<table class="" id="table1" width="100%" border="0" cellpadding="4" cellspacing="4">' ;
$output .= " <tr><td class='datos'><input type='file' name='plugin_upload' /> " ;
$output .= " <td class='datos'><input type='submit' class='sub next' value=' " . __ ( 'Upload' ) . " ' /> " ;
$output .= '</form></table>' ;
$output .= '</div>' ;
$output .= '</div>' ;
echo $output ;
$zip = null ;
$upload = false ;
if ( isset ( $_FILES [ 'plugin_upload' ]) === true ) {
2021-06-16 15:53:05 +02:00
$basepath = $config [ 'attachment_store' ] . '/plugin' ;
2021-06-15 17:24:03 +02:00
2021-06-16 15:53:05 +02:00
$filename = $_FILES [ 'plugin_upload' ][ 'name' ];
$uploaded_filename = $_FILES [ 'plugin_upload' ][ 'tmp_name' ];
2021-06-15 17:24:03 +02:00
2021-06-16 15:53:05 +02:00
$tmp_path = Files :: tempdirnam (
$config [ 'attachment_store' ] . '/downloads/' ,
'plugin_uploaded_'
);
if ( $tmp_path === false ) {
$error = __ ( 'Failed to create temporary directory' );
2021-06-15 17:24:03 +02:00
}
2021-06-16 15:53:05 +02:00
} else {
$error = '' ;
2021-06-15 17:24:03 +02:00
}
2021-06-16 15:53:05 +02:00
if ( $error === null ) {
if ( Files :: unzip ( $uploaded_filename , $tmp_path ) === true ) {
// Successfully extracted to tmp directory.
// Grant execution over all files found.
Files :: chmod ( $tmp_path , 0755 );
2021-06-15 17:24:03 +02:00
2021-06-16 15:53:05 +02:00
// Operate.
$ini_array = parse_ini_file ( $tmp_path . '/plugin_definition.ini' , true );
// Clean plugin_definition.ini file.
unlink ( $tmp_path . '/plugin_definition.ini' );
2021-06-15 17:24:03 +02:00
2021-06-16 15:53:05 +02:00
// Parse with sections.
if ( $ini_array === false ) {
$error = __ ( 'Cannot load INI file' );
2021-06-15 17:24:03 +02:00
} else {
2021-06-16 15:53:05 +02:00
// Relocate files to target destination.
2022-02-08 10:01:17 +01:00
Files :: move ( $tmp_path . '/' , $basepath . '/' , true );
2021-06-16 15:53:05 +02:00
// Extract information.
$version = preg_replace ( '/.*[.]/' , '' , $filename );
$exec_path = $basepath . '/' . $ini_array [ 'plugin_definition' ][ 'filename' ];
$file_exec_path = $exec_path ;
if ( isset ( $ini_array [ 'plugin_definition' ][ 'execution_command' ]) === true
&& empty ( $ini_array [ 'plugin_definition' ][ 'execution_command' ]) === false
) {
$exec_path = $ini_array [ 'plugin_definition' ][ 'execution_command' ];
$exec_path .= ' ' . $basepath . '/' ;
$exec_path .= $ini_array [ 'plugin_definition' ][ 'filename' ];
}
2021-06-15 17:24:03 +02:00
2021-06-16 15:53:05 +02:00
if ( isset ( $ini_array [ 'plugin_definition' ][ 'execution_postcommand' ]) === true
&& empty ( $ini_array [ 'plugin_definition' ][ 'execution_postcommand' ]) === false
) {
$exec_path .= ' ' . $ini_array [ 'plugin_definition' ][ 'execution_postcommand' ];
}
if ( file_exists ( $file_exec_path ) === false ) {
$error = __ ( 'Plugin exec not found. Aborting!' );
2021-06-15 17:24:03 +02:00
unlink ( $config [ 'attachment_store' ] . '/plugin_definition.ini' );
} else {
2021-06-16 15:53:05 +02:00
// Verify if a plugin with the same name is already registered.
$sql = sprintf (
'SELECT COUNT(*) FROM tplugin WHERE name = "%s"' ,
io_safe_input ( $ini_array [ 'plugin_definition' ][ 'name' ])
);
$result = db_get_sql ( $sql );
if ( $result > 0 ) {
$error = __ ( 'Plugin already registered. Aborting!' );
unlink ( $config [ 'attachment_store' ] . '/plugin_definition.ini' );
} else {
$values = [
'name' => io_safe_input ( $ini_array [ 'plugin_definition' ][ 'name' ]),
'description' => io_safe_input ( $ini_array [ 'plugin_definition' ][ 'description' ]),
'max_timeout' => $ini_array [ 'plugin_definition' ][ 'timeout' ],
'execute' => io_safe_input ( $exec_path ),
'net_dst_opt' => $ini_array [ 'plugin_definition' ][ 'ip_opt' ],
'net_port_opt' => $ini_array [ 'plugin_definition' ][ 'port_opt' ],
'user_opt' => $ini_array [ 'plugin_definition' ][ 'user_opt' ],
'pass_opt' => $ini_array [ 'plugin_definition' ][ 'pass_opt' ],
'parameters' => $ini_array [ 'plugin_definition' ][ 'parameters' ],
'plugin_type' => $ini_array [ 'plugin_definition' ][ 'plugin_type' ],
];
switch ( $version ) {
case 'pspz' :
// Fixed the static parameters
// for
// the dinamic parameters of pandoras 5.
$total_macros = 0 ;
$macros = [];
if ( isset ( $values [ 'parameters' ]) === false ) {
$values [ 'parameters' ] = '' ;
}
if ( empty ( $values [ 'net_dst_opt' ]) === false ) {
$total_macros ++ ;
$macro = [];
$macro [ 'macro' ] = '_field' . $total_macros . '_' ;
$macro [ 'desc' ] = 'Target IP from net' ;
$macro [ 'help' ] = '' ;
$macro [ 'value' ] = '' ;
$values [ 'parameters' ] .= $values [ 'net_dst_opt' ] . ' _field' . $total_macros . '_ ' ;
$macros [( string ) $total_macros ] = $macro ;
}
if ( empty ( $values [ 'ip_opt' ]) === false ) {
$total_macros ++ ;
$macro = [];
$macro [ 'macro' ] = '_field' . $total_macros . '_' ;
$macro [ 'desc' ] = 'Target IP' ;
$macro [ 'help' ] = '' ;
$macro [ 'value' ] = '' ;
$values [ 'parameters' ] .= $values [ 'ip_opt' ] . ' _field' . $total_macros . '_ ' ;
$macros [( string ) $total_macros ] = $macro ;
}
if ( empty ( $values [ 'net_port_opt' ]) === false ) {
$total_macros ++ ;
$macro = [];
$macro [ 'macro' ] = '_field' . $total_macros . '_' ;
$macro [ 'desc' ] = 'Port from net' ;
$macro [ 'help' ] = '' ;
$macro [ 'value' ] = '' ;
$values [ 'parameters' ] .= $values [ 'net_port_opt' ] . ' _field' . $total_macros . '_ ' ;
$macros [( string ) $total_macros ] = $macro ;
}
if ( empty ( $values [ 'port_opt' ]) === false ) {
$total_macros ++ ;
$macro = [];
$macro [ 'macro' ] = '_field' . $total_macros . '_' ;
$macro [ 'desc' ] = 'Port' ;
$macro [ 'help' ] = '' ;
$macro [ 'value' ] = '' ;
$values [ 'parameters' ] .= $values [ 'port_opt' ] . ' _field' . $total_macros . '_ ' ;
$macros [( string ) $total_macros ] = $macro ;
}
if ( empty ( $values [ 'user_opt' ]) === false ) {
$total_macros ++ ;
$macro = [];
$macro [ 'macro' ] = '_field' . $total_macros . '_' ;
$macro [ 'desc' ] = 'Username' ;
$macro [ 'help' ] = '' ;
$macro [ 'value' ] = '' ;
$values [ 'parameters' ] .= $values [ 'user_opt' ] . ' _field' . $total_macros . '_ ' ;
$macros [( string ) $total_macros ] = $macro ;
}
if ( empty ( $values [ 'pass_opt' ]) === false ) {
$total_macros ++ ;
$macro = [];
$macro [ 'macro' ] = '_field' . $total_macros . '_' ;
$macro [ 'desc' ] = 'Password' ;
$macro [ 'help' ] = '' ;
$macro [ 'value' ] = '' ;
2021-06-15 17:24:03 +02:00
2021-06-16 15:53:05 +02:00
$values [ 'parameters' ] .= $values [ 'pass_opt' ] . ' _field' . $total_macros . '_ ' ;
2021-06-15 17:24:03 +02:00
2021-06-16 15:53:05 +02:00
$macros [( string ) $total_macros ] = $macro ;
}
2021-06-15 17:24:03 +02:00
2021-06-16 15:53:05 +02:00
// A last parameter is defined always to
// add the old "Plug-in parameters" in the
// side of the module.
2021-06-15 17:24:03 +02:00
$total_macros ++ ;
$macro = [];
$macro [ 'macro' ] = '_field' . $total_macros . '_' ;
2021-06-16 15:53:05 +02:00
$macro [ 'desc' ] = 'Plug-in Parameters' ;
2021-06-15 17:24:03 +02:00
$macro [ 'help' ] = '' ;
$macro [ 'value' ] = '' ;
2021-06-16 15:53:05 +02:00
$values [ 'parameters' ] .= ' _field' . $total_macros . '_' ;
2021-06-15 17:24:03 +02:00
$macros [( string ) $total_macros ] = $macro ;
2021-06-16 15:53:05 +02:00
break ;
case 'pspz2' :
// Fill the macros field.
$total_macros = $ini_array [ 'plugin_definition' ][ 'total_macros_provided' ];
$macros = [];
for ( $it_macros = 1 ; $it_macros <= $total_macros ; $it_macros ++ ) {
$label = 'macro_' . $it_macros ;
$macro = [];
$macro [ 'macro' ] = '_field' . $it_macros . '_' ;
$macro [ 'hide' ] = $ini_array [ $label ][ 'hide' ];
$macro [ 'desc' ] = io_safe_input (
$ini_array [ $label ][ 'description' ]
);
$macro [ 'help' ] = io_safe_input (
$ini_array [ $label ][ 'help' ]
);
$macro [ 'value' ] = io_safe_input (
$ini_array [ $label ][ 'value' ]
);
$macros [( string ) $it_macros ] = $macro ;
}
break ;
default :
// Not possible.
break ;
}
2021-06-15 17:24:03 +02:00
2021-06-16 15:53:05 +02:00
if ( empty ( $macros ) === false ) {
$values [ 'macros' ] = json_encode ( $macros );
}
2021-06-15 17:24:03 +02:00
2021-06-16 15:53:05 +02:00
$create_id = db_process_sql_insert ( 'tplugin' , $values );
2021-06-15 17:24:03 +02:00
2021-06-16 15:53:05 +02:00
if ( empty ( $create_id ) === true ) {
ui_print_error_message (
__ ( 'Plug-in Remote Registered unsuccessfull' )
);
ui_print_info_message (
__ ( 'Please check the syntax of file "plugin_definition.ini"' )
);
} else {
for ( $ax = 1 ; $ax <= $ini_array [ 'plugin_definition' ][ 'total_modules_provided' ]; $ax ++ ) {
$label = 'module' . $ax ;
$plugin_user = '' ;
if ( isset ( $ini_array [ $label ][ 'plugin_user' ]) === true ) {
$plugin_user = $ini_array [ $label ][ 'plugin_user' ];
}
$plugin_pass = '' ;
if ( isset ( $ini_array [ $label ][ 'plugin_pass' ]) === true ) {
$plugin_pass = $ini_array [ $label ][ 'plugin_pass' ];
}
$plugin_parameter = '' ;
if ( isset ( $ini_array [ $label ][ 'plugin_parameter' ]) === true ) {
$plugin_parameter = $ini_array [ $label ][ 'plugin_parameter' ];
}
$unit = '' ;
if ( isset ( $ini_array [ $label ][ 'unit' ]) === true ) {
$unit = $ini_array [ $label ][ 'unit' ];
}
$values = [
'name' => io_safe_input ( $ini_array [ $label ][ 'name' ]),
'description' => io_safe_input ( $ini_array [ $label ][ 'description' ]),
'id_group' => $ini_array [ $label ][ 'id_group' ],
'type' => $ini_array [ $label ][ 'type' ],
'max' => ( $ini_array [ $label ][ 'max' ] ? ? '' ),
'min' => ( $ini_array [ $label ][ 'min' ] ? ? '' ),
'module_interval' => ( $ini_array [ $label ][ 'module_interval' ] ? ? '' ),
'id_module_group' => $ini_array [ $label ][ 'id_module_group' ],
'id_modulo' => $ini_array [ $label ][ 'id_modulo' ],
'plugin_user' => io_safe_input ( $plugin_user ),
'plugin_pass' => io_safe_input ( $plugin_pass ),
'plugin_parameter' => io_safe_input ( $plugin_parameter ),
'unit' => io_safe_input ( $unit ),
'max_timeout' => ( $ini_array [ $label ][ 'max_timeout' ] ? ? '' ),
'history_data' => ( $ini_array [ $label ][ 'history_data' ] ? ? '' ),
'dynamic_interval' => ( $ini_array [ $label ][ 'dynamic_interval' ] ? ? '' ),
'dynamic_min' => ( $ini_array [ $label ][ 'dynamic_min' ] ? ? '' ),
'dynamic_max' => ( $ini_array [ $label ][ 'dynamic_max' ] ? ? '' ),
'dynamic_two_tailed' => ( $ini_array [ $label ][ 'dynamic_two_tailed' ] ? ? '' ),
'min_warning' => ( $ini_array [ $label ][ 'min_warning' ] ? ? '' ),
'max_warning' => ( $ini_array [ $label ][ 'max_warning' ] ? ? '' ),
'str_warning' => ( $ini_array [ $label ][ 'str_warning' ] ? ? '' ),
'min_critical' => ( $ini_array [ $label ][ 'min_critical' ] ? ? '' ),
'max_critical' => ( $ini_array [ $label ][ 'max_critical' ] ? ? '' ),
'str_critical' => ( $ini_array [ $label ][ 'str_critical' ] ? ? '' ),
'min_ff_event' => ( $ini_array [ $label ][ 'min_ff_event' ] ? ? '' ),
'tcp_port' => ( $ini_array [ $label ][ 'tcp_port' ] ? ? '' ),
'id_plugin' => $create_id ,
];
$macros_component = $macros ;
switch ( $version ) {
case 'pspz' :
// Fixed the static parameters
// for
// the dinamic parameters of pandoras 5.
foreach ( $macros_component as $key => $macro ) {
if ( $macro [ 'desc' ] === 'Target IP from net' ) {
if ( empty ( $values [ 'ip_target' ]) === false ) {
$macros_component [ $key ][ 'value' ] = io_safe_input (
$values [ 'ip_target' ]
);
}
2021-06-15 17:24:03 +02:00
}
2021-06-16 15:53:05 +02:00
if ( $macro [ 'desc' ] === 'Target IP' ) {
if ( empty ( $values [ 'ip_target' ]) === false ) {
$macros_component [ $key ][ 'value' ] = io_safe_input (
$values [ 'ip_target' ]
);
}
} else if ( $macro [ 'desc' ] === 'Port from net' ) {
if ( empty ( $values [ 'tcp_port' ]) === false ) {
$macros_component [ $key ][ 'value' ] = io_safe_input (
$values [ 'tcp_port' ]
);
}
} else if ( $macro [ 'desc' ] === 'Port' ) {
if ( empty ( $values [ 'tcp_port' ]) === false ) {
$macros_component [ $key ][ 'value' ] = io_safe_input (
$values [ 'tcp_port' ]
);
}
} else if ( $macro [ 'desc' ] === 'Username' ) {
if ( empty ( $values [ 'plugin_user' ]) === false ) {
$macros_component [ $key ][ 'value' ] = io_safe_input (
$values [ 'plugin_user' ]
);
}
} else if ( $macro [ 'desc' ] === 'Password' ) {
if ( empty ( $values [ 'plugin_pass' ]) === false ) {
$macros_component [ $key ][ 'value' ] = io_safe_input (
$values [ 'plugin_pass' ]
);
}
} else if ( $macro [ 'desc' ] === 'Plug-in Parameters' ) {
if ( empty ( $values [ 'plugin_parameter' ]) === false ) {
$macros_component [ $key ][ 'value' ] = io_safe_input (
$values [ 'plugin_parameter' ]
);
}
2021-06-15 17:24:03 +02:00
}
}
2021-06-16 15:53:05 +02:00
break ;
case 'pspz2' :
if ( $total_macros > 0 ) {
for ( $it_macros = 1 ; $it_macros <= $total_macros ; $it_macros ++ ) {
$macro = 'macro_' . $it_macros . '_value' ;
// Set the value or use the default.
if ( isset ( $ini_array [ $label ][ $macro ]) === true ) {
$macros_component [( string ) $it_macros ][ 'value' ] = io_safe_input (
$ini_array [ $label ][ $macro ]
);
}
2021-06-15 17:24:03 +02:00
}
}
2021-06-16 15:53:05 +02:00
break ;
2021-06-15 17:24:03 +02:00
2021-06-16 15:53:05 +02:00
default :
// Not possible.
break ;
}
2021-06-15 17:24:03 +02:00
2021-06-16 15:53:05 +02:00
if ( empty ( $macros_component ) === false ) {
$values [ 'macros' ] = json_encode ( $macros_component );
}
2021-06-15 17:24:03 +02:00
2021-06-16 15:53:05 +02:00
db_process_sql_insert ( 'tnetwork_component' , $values );
ui_print_success_message (
__ ( 'Module plugin registered' ) . ' : ' . $ini_array [ $label ][ 'name' ]
);
}
2021-06-15 17:24:03 +02:00
ui_print_success_message (
2021-06-16 15:53:05 +02:00
__ ( 'Plugin' ) . ' ' . $ini_array [ 'plugin_definition' ][ 'name' ] . ' ' . __ ( 'Registered successfully' )
2021-06-15 17:24:03 +02:00
);
}
2021-06-16 15:53:05 +02:00
unlink ( $config [ 'attachment_store' ] . '/plugin_definition.ini' );
2021-06-15 17:24:03 +02:00
}
}
}
2021-06-16 15:53:05 +02:00
// Clean.
Files :: rmrf ( $tmp_path );
} else {
$error = __ ( 'Unable to uncompress uploaded file' );
2021-06-15 17:24:03 +02:00
}
}
2021-06-16 15:53:05 +02:00
if ( file_exists ( $uploaded_filename ) === true ) {
if ( is_metaconsole () === true && is_management_allowed () === true ) {
// Keep uploaded file to be transferred to nodes.
if ( is_dir ( $config [ 'attachment_store' ] . '/downloads/' ) === false ) {
mkdir ( $config [ 'attachment_store' ] . '/downloads/' );
}
$keep = move_uploaded_file (
$uploaded_filename ,
$config [ 'attachment_store' ] . '/downloads/' . $filename
);
if ( $keep === false ) {
$error = __ (
'Cannot move uploaded file to %s.' ,
$config [ 'attachment_store' ] . '/downloads/'
);
}
} else {
// Clean temporary files.
unlink ( $uploaded_filename );
}
}
if ( $error !== null && $error !== '' ) {
ui_print_error_message ( $error );
2021-06-16 18:18:38 +02:00
} else if ( $error === null
&& is_management_allowed () === true
&& is_metaconsole () === true
) {
2021-06-16 15:53:05 +02:00
$attachment = '/' . str_replace (
$config [ 'homedir' ],
'' ,
$config [ 'attachment_store' ]
);
$sc = new Synchronizer ();
$sc -> queueOperation (
Synchronizer :: OPERATION_REFRESH_PLUGIN ,
ui_get_full_url (
$attachment . '/downloads/' . $filename ,
false ,
false ,
false
)
);
}
