pandorafms/pandora_console/godmode/wizards/HostDevices.class.php

<?php
/**
 * Extension to schedule tasks on Pandora FMS Console
 *
 * @category   Wizard
 * @package    Pandora FMS
 * @subpackage Host&Devices
 * @version    1.0.0
 * @license    See below
 *
 *    ______                 ___                    _______ _______ ________
 *   |   __ \.-----.--.--.--|  |.-----.----.-----. |    ___|   |   |     __|
 *  |    __/|  _  |     |  _  ||  _  |   _|  _  | |    ___|       |__     |
 * |___|   |___._|__|__|_____||_____|__| |___._| |___|   |__|_|__|_______|
 *
 * ============================================================================
 * Copyright (c) 2005-2019 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 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.
 * ============================================================================
 */

require_once __DIR__.'/Wizard.main.php';
require_once $config['homedir'].'/include/functions_users.php';
require_once $config['homedir'].'/include/class/CustomNetScan.class.php';
require_once $config['homedir'].'/include/class/ManageNetScanScripts.class.php';

enterprise_include_once('include/class/CSVImportAgents.class.php');
enterprise_include_once('include/functions_hostdevices.php');

/**
 * Wizard section Host&devices.
 * Provides classic recon task creation.
 * In enterprise environments, provides also CSV agent import features.
 */
class HostDevices extends Wizard
{

     /**
      * Number of pages to control breadcrum.
      *
      * @var integer
      */
    public $maxPagesNetScan = 2;

    /**
     * Labels for breadcrum.
     *
     * @var array
     */
    public $pageLabelsNetScan = [
        'NetScan definition',
        'NetScan features',

    ];

    /**
     * Stores all needed parameters to create a recon task.
     *
     * @var array
     */
    public $task;


    /**
     * Constructor.
     *
     * @param integer $page  Start page, by default 0.
     * @param string  $msg   Mensajito.
     * @param string  $icon  Mensajito.
     * @param string  $label Mensajito.
     *
     * @return class HostDevices
     */
    public function __construct(
        int $page=0,
        string $msg='Default message. Not set.',
        string $icon='images/wizard/hostdevices.png',
        string $label='Host & Devices'
    ) {
        $this->setBreadcrum([]);

        $this->task = [];
        $this->msg = $msg;
        $this->icon = $icon;
        $this->label = $label;
        $this->page = $page;
        $this->url = ui_get_full_url(
            'index.php?sec=gservers&sec2=godmode/servers/discovery&wiz=hd'
        );

        return $this;
    }


    /**
     * Run wizard manager.
     *
     * @return mixed Returns null if wizard is ongoing. Result if done.
     */
    public function run()
    {
        global $config;

        // Load styles.
        parent::run();

        $mode = get_parameter('mode', null);

        if ($mode === null) {
            $buttons = [];
            $buttons[] = [
                'url'   => $this->url.'&mode=netscan',
                'icon'  => 'images/wizard/netscan.png',
                'label' => __('Net Scan'),
            ];

            if (enterprise_installed()) {
                $buttons[] = [
                    'url'   => $this->url.'&mode=importcsv',
                    'icon'  => ENTERPRISE_DIR.'/images/wizard/csv.png',
                    'label' => __('Import CSV'),
                ];
            }

            $buttons[] = [
                'url'   => $this->url.'&mode=customnetscan',
                'icon'  => '/images/wizard/customnetscan.png',
                'label' => __('Custom NetScan'),
            ];

            $buttons[] = [
                'url'   => $this->url.'&mode=managenetscanscripts',
                'icon'  => '/images/wizard/managenetscanscripts.png',
                'label' => __('Manage NetScan scripts'),
            ];

            $this->prepareBreadcrum(
                [
                    [
                        'link'  => ui_get_full_url(
                            'index.php?sec=gservers&sec2=godmode/servers/discovery'
                        ),
                        'label' => __('Discovery'),
                    ],
                ],
                true
            );

            ui_print_page_header(__('Host & devices'), '', false, '', true, '', false, '', GENERIC_SIZE_TEXT, '', $this->printHeader(true));

            $this->printBigButtonsList($buttons);
            return;
        }

        if (enterprise_installed()) {
            if ($mode === 'importcsv') {
                $csv_importer = new CSVImportAgents(
                    $this->page,
                    $this->breadcrum
                );
                return $csv_importer->runCSV();
            }
        }

        if ($mode === 'customnetscan') {
            $customnetscan_importer = new CustomNetScan(
                $this->page,
                $this->breadcrum
            );
            return $customnetscan_importer->runCustomNetScan();
        }

        if ($mode === 'managenetscanscripts') {
            $managenetscanscript_importer = new ManageNetScanScripts(
                $this->page,
                $this->breadcrum
            );
            return $managenetscanscript_importer->runManageNetScanScript();
        }

        if ($mode == 'netscan') {
            return $this->runNetScan();
        }

        return null;
    }


    // Extra methods.


    /**
     * Retrieves and validates information given by user in NetScan wizard.
     *
     * @return boolean Data OK or not.
     */
    public function parseNetScan()
    {
        if ($this->page == 0) {
            // Check if we're updating a task.
            $task_id = get_parameter('task', null);

            if (isset($task_id) === true) {
                // We're updating this task.
                $task = db_get_row(
                    'trecon_task',
                    'id_rt',
                    $task_id
                );

                if ($task !== false) {
                    $this->task = $task;
                }
            }

            return true;
        }

        // Validate response from page 0. No, not a bug, we're always 1 page
        // from 'validation' page.
        if ($this->page == 1) {
            $task_id = get_parameter('task', null);
            $taskname = get_parameter('taskname', '');
            $comment = get_parameter('comment', '');
            $server_id = get_parameter('id_recon_server', '');
            $network = get_parameter('network', '');
            $id_group = get_parameter('id_group', '');
            $interval = get_parameter('interval', 0);

            if (isset($task_id) === true) {
                // We're updating this task.
                $task = db_get_row(
                    'trecon_task',
                    'id_rt',
                    $task_id
                );

                if ($task !== false) {
                    $this->task = $task;
                }
            } else if (isset($taskname) === true
                && isset($network) === true
            ) {
                // Avoid double creation.
                $task = db_get_row_filter(
                    'trecon_task',
                    [
                        'name'   => $taskname,
                        'subnet' => $network,
                    ]
                );

                if ($task !== false) {
                    $this->task = $task;
                    $this->msg = __('This network scan task has been already defined. Please edit it or create a new one.');
                    return false;
                }
            }

            if ($task_id !== null
                && $taskname == null
                && $server_id == null
                && $id_group == null
                && $server == null
                && $datacenter == ''
                && $user == ''
                && $pass == ''
                && $encrypt == null
                && $interval == 0
            ) {
                // Default values, no data received.
                // User is accesing directly to this page.
                if (users_is_admin() !== true && check_acl(
                    $config['id_usuario'],
                    $this->task['id_group'],
                    'PM'
                ) !== true
                ) {
                    $this->msg = __('You have no access to edit this task.');
                    return false;
                }
            } else {
                if (isset($this->task['id_rt']) === false) {
                    // Disabled 2 Implies wizard non finished.
                    $this->task['disabled'] = 2;
                }

                if ($taskname == '') {
                    $this->msg = __('You must provide a task name.');
                    return false;
                }

                if ($server_id == '') {
                    $this->msg = __('You must select a Discovery Server.');
                    return false;
                }

                if ($network == '') {
                    // XXX: Could be improved validating provided network.
                    $this->msg = __('You must provide a valid network.');
                    return false;
                }

                if ($id_group == '') {
                    $this->msg = __('You must select a valid group.');
                    return false;
                }

                // Assign fields.
                $this->task['name'] = $taskname;
                $this->task['description'] = $comment;
                $this->task['subnet'] = $network;
                $this->task['id_recon_server'] = $server_id;
                $this->task['id_group'] = $id_group;
                $this->task['interval_sweep'] = $interval;

                if (isset($this->task['id_rt']) === false) {
                    // Create.
                    $this->task['id_rt'] = db_process_sql_insert(
                        'trecon_task',
                        $this->task
                    );
                } else {
                    // Update.
                    db_process_sql_update(
                        'trecon_task',
                        $this->task,
                        ['id_rt' => $this->task['id_rt']]
                    );
                }
            }

            return true;
        }

        // Validate response from page 1.
        if ($this->page == 2) {
            $id_rt = get_parameter('task', -1);

            $task = db_get_row(
                'trecon_task',
                'id_rt',
                $id_rt
            );

            if ($task !== false) {
                $this->task = $task;
            } else {
                $this->msg = __('Failed to find network scan task.');
                return false;
            }

            $id_network_profile = get_parameter('id_network_profile', null);
            $autoconf_enabled = get_parameter_switch(
                'autoconfiguration_enabled'
            );
            $snmp_enabled = get_parameter_switch('snmp_enabled');
            $os_detect = get_parameter_switch('os_detect');
            $parent_detection = get_parameter_switch('parent_detection');
            $parent_recursion = get_parameter_switch('parent_recursion');
            $vlan_enabled = get_parameter_switch('vlan_enabled');
            $wmi_enabled = get_parameter_switch('wmi_enabled');
            $resolve_names = get_parameter_switch('resolve_names');
            $snmp_version = get_parameter('snmp_version', null);
            $community = get_parameter('community', null);
            $snmp_context = get_parameter('snmp_context', null);
            $snmp_auth_user = get_parameter('snmp_auth_user', null);
            $snmp_auth_pass = get_parameter('snmp_auth_pass', null);
            $snmp_privacy_method = get_parameter('snmp_privacy_method', null);
            $snmp_privacy_pass = get_parameter('snmp_privacy_pass', null);
            $snmp_auth_method = get_parameter('snmp_auth_method', null);
            $snmp_security_level = get_parameter('snmp_security_level', null);
            $auth_strings = get_parameter('auth_strings', null);

            if ($snmp_version == 3) {
                $this->task['snmp_community'] = $snmp_context;
            } else {
                $this->task['snmp_community'] = $community;
            }

            $this->task['autoconfiguration_enabled'] = $autoconf_enabled;
            $this->task['id_network_profile'] = $id_network_profile;
            $this->task['snmp_enabled'] = $snmp_enabled;
            $this->task['os_detect'] = $os_detect;
            $this->task['parent_detection'] = $parent_detection;
            $this->task['parent_recursion'] = $parent_recursion;
            $this->task['vlan_enabled'] = $vlan_enabled;
            $this->task['wmi_enabled'] = $wmi_enabled;
            $this->task['resolve_names'] = $resolve_names;
            $this->task['snmp_version'] = $snmp_version;
            $this->task['snmp_auth_user'] = $snmp_auth_user;
            $this->task['snmp_auth_pass'] = $snmp_auth_pass;
            $this->task['snmp_privacy_method'] = $snmp_privacy_method;
            $this->task['snmp_privacy_pass'] = $snmp_privacy_pass;
            $this->task['snmp_auth_method'] = $snmp_auth_method;
            $this->task['snmp_security_level'] = $snmp_security_level;
            $this->task['auth_strings'] = $auth_strings;

            if ($this->task['disabled'] == 2) {
                // Wizard finished.
                $this->task['disabled'] = 0;
            }

            // Update.
            $res = db_process_sql_update(
                'trecon_task',
                $this->task,
                ['id_rt' => $this->task['id_rt']]
            );

            return true;
        }

        if ($this->page == 3) {
            // Wizard ended. Load data and return control to Discovery.
            $id_rt = get_parameter('task', -1);

            $task = db_get_row(
                'trecon_task',
                'id_rt',
                $id_rt
            );

            if ($task !== false) {
                $this->task = $task;
            } else {
                $this->msg = __('Failed to find network scan task.');
                return false;
            }

            return true;
        }

        return false;
    }


    /**
     * Undocumented function
     *
     * @return void
     */
    public function runNetScan()
    {
        global $config;

        check_login();

        if (! check_acl($config['id_user'], 0, 'PM')) {
            db_pandora_audit(
                'ACL Violation',
                'Trying to access Agent Management'
            );
            include 'general/noaccess.php';
            return;
        }

        if ($this->parseNetScan() === false) {
            // Error.
            ui_print_error_message(
                $this->msg
            );

            $form = [
                'form'   => [
                    'method' => 'POST',
                    'action' => $this->url.'&mode=netscan&page='.($this->page - 1).'&task='.$this->task['id_rt'],
                ],
                'inputs' => [
                    [
                        'arguments' => [
                            'type'  => 'hidden',
                            'name'  => 'task',
                            'value' => $this->task['id_rt'],
                        ],
                    ],
                    [
                        'arguments' => [
                            'name'       => 'submit',
                            'label'      => __('Go back'),
                            'type'       => 'submit',
                            'attributes' => 'class="sub cancel"',
                            'return'     => true,
                        ],
                    ],
                ],
            ];

            // Check ACL. If user is not able to manage target task,
            // redirect him to main page.
            if (users_is_admin() !== true && check_acl(
                $config['id_usuario'],
                $this->task['id_group'],
                'PM'
            ) !== true
            ) {
                $form['form']['action'] = $this->url.'&mode=netscan&page='.($this->page - 1);
            }

            $this->printForm($form);
            return null;
        }

        $task_url = '';
        if (isset($this->task['id_rt'])) {
            $task_url = '&task='.$this->task['id_rt'];
        }

        $breadcrum = [
            [
                'link'  => 'index.php?sec=gservers&sec2=godmode/servers/discovery',
                'label' => 'Discovery',
            ],
            [
                'link'  => 'index.php?sec=gservers&sec2=godmode/servers/discovery&wiz=hd',
                'label' => __($this->label),
            ],
        ];
        for ($i = 0; $i < $this->maxPagesNetScan; $i++) {
            $breadcrum[] = [
                'link'     => 'index.php?sec=gservers&sec2=godmode/servers/discovery&wiz=hd&mode=netscan&page='.$i.$task_url,
                'label'    => $this->pageLabelsNetScan[$i],
                'selected' => (($i == $this->page) ? 1 : 0),
            ];
        }

        if ($this->page < $this->maxPagesNetScan) {
            // Avoid to print header out of wizard.
            $this->prepareBreadcrum($breadcrum);
            ui_print_page_header(
                __('NetScan'),
                '',
                false,
                '',
                true,
                '',
                false,
                '',
                GENERIC_SIZE_TEXT,
                '',
                $this->printHeader(true)
            );
        }

        if (isset($this->page) === true
            && $this->page != 0
            && isset($this->task['id_rt']) === false
        ) {
            // Error.
            ui_print_error_message(
                __('Internal error, please re-run this wizard.')
            );

            $form = [
                'form'   => [
                    'method' => 'POST',
                    'action' => $this->url.'&mode=netscan&page=0',
                ],
                'inputs' => [
                    [
                        'arguments' => [
                            'type'  => 'hidden',
                            'name'  => 'page',
                            'value' => 0,
                        ],
                    ],
                    [
                        'arguments' => [
                            'name'       => 'submit',
                            'label'      => __('Go back'),
                            'type'       => 'submit',
                            'attributes' => 'class="sub cancel"',
                            'return'     => true,
                        ],
                    ],
                ],
            ];

            $this->printForm($form);
            return null;
        }

        // -------------------------------.
        // Page 0. wizard starts HERE.
        // -------------------------------.
        if (isset($this->page) === true || $this->page == 0) {
            if (isset($this->page) === false
                || $this->page == 0
            ) {
                $form = [];

                $str = __('Next');

                if (isset($this->task['id_rt']) === true) {
                    $str = __('Update and continue');
                }

                // Interval and schedules.
                $interv_manual = 0;
                if ((int) $this->task['interval_sweep'] == 0) {
                    $interv_manual = 1;
                }

                $form['rows'][0]['new_form_block'] = true;

                $form['rows'][0]['columns'][0] = [
                    'width'  => '30%',
                    'style'  => 'padding: 9px;',
                    'inputs' => [
                        '0' => [
                            'arguments' => [
                                'name'       => 'submit',
                                'label'      => $str,
                                'type'       => 'submit',
                                'attributes' => 'class="sub next"',
                                'return'     => true,
                            ],
                        ],
                        '1' => '<div style="height: 50%; margin-bottom: 35px;">'.html_print_image('images/wizard/netscan_green.png', true, ['title' => __('Close')], false).'</div>',
                        '2' => [
                            'label'     => '<b>'.__('Interval').':</b>'.ui_print_help_tip(
                                __('Manual interval means that it will be executed only On-demand'),
                                true
                            ),
                            'arguments' => [
                                'type'     => 'select',
                                'selected' => $interv_manual,
                                'fields'   => [
                                    0 => __('Defined'),
                                    1 => __('Manual'),
                                ],
                                'name'     => 'interval_manual_defined',
                                'return'   => true,
                            ],
                            'extra'     => '<span id="interval_manual_container">'.html_print_extended_select_for_time(
                                'interval',
                                $this->task['interval_sweep'],
                                '',
                                '',
                                '0',
                                false,
                                true,
                                false,
                                false
                            ).ui_print_help_tip(
                                __('The minimum recomended interval for Recon Task is 5 minutes'),
                                true
                            ).'</span>',

                        ],
                    ],
                ];

                $form['rows'][0]['columns'][1] = [
                    'width'         => '40%',
                    'padding-right' => '12%',
                    'padding-left'  => '5%',
                    'inputs'        => [
                        '0' => [
                            'label'     => '<b>'.__('Task name').':</b>',
                            'arguments' => [
                                'name'  => 'taskname',
                                'value' => $this->task['name'],
                                'type'  => 'text',
                                'size'  => 25,
                                'class' => 'discovery_full_width_input',
                            ],
                        ],
                        '1' => [
                            'label'     => '<b>'.__('Discovery server').':</b>'.ui_print_help_tip(
                                __('You must select a Discovery Server to run the Task, otherwise the Recon Task will never run'),
                                true
                            ),
                            'arguments' => [
                                'type'     => 'select_from_sql',
                                'sql'      => sprintf(
                                    'SELECT id_server, name
                                                FROM tserver
                                                WHERE server_type = %d
                                                ORDER BY name',
                                    SERVER_TYPE_DISCOVERY
                                ),
                                'name'     => 'id_recon_server',
                                'style'    => 'width: 100%;',
                                'selected' => $this->task['id_recon_server'],
                                'return'   => true,
                            ],
                        ],
                        '2' => [
                            'label'     => '<b>'.__('Network').':</b>'.ui_print_help_tip(
                                __('You can specify several networks, separated by commas, for example: 192.168.50.0/24,192.168.60.0/24'),
                                true
                            ),
                            'arguments' => [
                                'name'  => 'network',
                                'value' => $this->task['subnet'],
                                'type'  => 'text',
                                'size'  => 25,
                                'class' => 'discovery_full_width_input',
                            ],
                        ],
                    ],
                ];

                // Group select (custom for this section).
                $group_select = '<div class="label_select"><label>'.__('Group').':</label></div>';

                $group_select .= $this->printInput(
                    [
                        'name'                    => 'id_group',
                        'returnAllGroup'          => false,
                        'privilege'               => 'PM',
                        'type'                    => 'select_groups',
                        'selected'                => $this->task['id_group'],
                        'return'                  => true,
                        'class'                   => 'discovery_list_input',
                        'size'                    => 9,
                        'simple_multiple_options' => true,
                    ]
                );

                $form['rows'][0]['columns'][2] = [
                    'width'  => '30%',
                    'inputs' => ['0' => $group_select],
                ];

                $form['rows'][1]['style'] = 'style de row';
                $form['rows'][1]['columns'][0] = [
                    'padding-right' => '0',
                    'inputs'        => [
                        '0' => [
                            'label'     => '<b>'.__('Comment').':</b>',
                            'arguments' => [
                                'name'    => 'comment',
                                'rows'    => 1,
                                'columns' => 1,
                                'value'   => $this->task['description'],
                                'type'    => 'textarea',
                                'size'    => 25,
                                'class'   => 'discovery_textarea_input',
                                'return'  => true,
                            ],
                        ],
                    ],
                ];

                $task_url = '';
                if (isset($this->task['id_rt'])) {
                    $task_url = '&task='.$this->task['id_rt'];
                }

                $form['form'] = [
                    'method' => 'POST',
                    'action' => $this->url.'&mode=netscan&page='.($this->page + 1).$task_url,
                ];

                // Default.
                $interval = 600;
                $unit = 60;
                if (isset($this->task['interval_sweep']) === true) {
                    $interval = $this->task['interval_sweep'];
                    $unit = $this->getTimeUnit($interval);
                }

                $form['js'] = '
                    $("select#interval_manual_defined").change(function() {
                        if ($("#interval_manual_defined").val() == 1) {
                            $("#interval_manual_container").hide();
                            $("#text-interval_text").val(0);
                            $("#hidden-interval").val(0);
                        }
                        else {
                            $("#interval_manual_container").show();
                            $("#text-interval_text").val(10);
                            $("#hidden-interval").val('.$interval.');
                            $("#interval_units").val('.$unit.');
                        }
                    }).change();';

                $this->printFormAsGrid($form);
            }
        }

        if ($this->page == 1) {
            // Page 1.
            $form = [];
            // Hidden, id_rt.
            $form['inputs'][] = [
                'arguments' => [
                    'name'   => 'task',
                    'value'  => $this->task['id_rt'],
                    'type'   => 'hidden',
                    'return' => true,
                ],
            ];

            $form['inputs'][] = [
                'arguments' => [
                    'name'   => 'page',
                    'value'  => ($this->page + 1),
                    'type'   => 'hidden',
                    'return' => true,
                ],
            ];

            $form['inputs'][] = [
                'extra' => '<p><h3>Please, configure task <b>'.io_safe_output($this->task['name']).'</b></h3></p>',
            ];

            $form['inputs'][] = [
                'label'     => __('Module template'),
                'arguments' => [
                    'name'          => 'id_network_profile',
                    'type'          => 'select_from_sql',
                    'sql'           => 'SELECT id_np, name
                            FROM tnetwork_profile
                            ORDER BY name',
                    'return'        => true,
                    'selected'      => $this->task['id_network_profile'],
                    'nothing_value' => 0,
                    'nothing'       => __('None'),
                ],
            ];

            if (enterprise_installed() === true) {
                // Input: Enable auto configuration.
                $form['inputs'][] = [
                    'label'     => __('Apply autoconfiguration rules').ui_print_help_tip(
                        __(
                            'System is able to auto configure detected host & devices by applying your defined configuration rules.'
                        ),
                        true
                    ),
                    'arguments' => [
                        'name'   => 'autoconfiguration_enabled',
                        'type'   => 'switch',
                        'return' => true,
                        'value'  => (isset($this->task['autoconfiguration_enabled'])) ? $this->task['autoconfiguration_enabled'] : 0,

                    ],
                ];
            }

            if (enterprise_installed()) {
                // Feature configuration.
                $extra = enterprise_hook('hd_showextrainputs', [$this]);
                if (is_array($extra) === true) {
                    $form['inputs'] = array_merge(
                        $form['inputs'],
                        $extra['inputs']
                    );
                    $form['js'] = $extra['js'];
                }
            }

            // Submit button.
            $form['inputs'][] = [
                'arguments' => [
                    'name'       => 'submit',
                    'label'      => __('Finish'),
                    'type'       => 'submit',
                    'attributes' => 'class="sub next"',
                    'return'     => true,
                ],
            ];

            $form['form'] = [
                'method' => 'POST',
                'action' => $this->url.'&mode=netscan&page='.($this->page + 1).'&task='.$this->task['id_rt'],
            ];

            $this->printFormAsList($form);
        }

        if ($this->page == 2) {
            if ($this->task['id_rt']) {
                // 0 - Is OK.
                $this->result = 0;
                $this->msg = __('Task configured.');
            } else {
                // 1 - Is NOT OK.
                $this->result = 1;
                $this->msg = __('Wizard failed. Cannot configure task.');
            }

            return [
                'result' => $this->result,
                'id'     => $this->task['id_rt'],
                'msg'    => $this->msg,
            ];
        }
    }


}