pandorafms/pandora_console/godmode/wizards/DiscoveryTaskList.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/functions_reports.php';
require_once $config['homedir'].'/include/functions_cron.php';
enterprise_include_once('include/functions_tasklist.php');
enterprise_include_once('include/functions_cron.php');

/**
 * Defined as wizard to guide user to explore running tasks.
 */
class DiscoveryTaskList extends Wizard
{


    /**
     * Constructor.
     *
     * @param integer $page  Start page, by default 0.
     * @param string  $msg   Custom default mesage.
     * @param string  $icon  Custom icon.
     * @param string  $label Custom label.
     *
     * @return class HostDevices
     */
    public function __construct(
        int $page=0,
        string $msg='Default message. Not set.',
        string $icon='images/wizard/tasklist.png',
        string $label='Task list'
    ) {
        $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=tasklist'
        );

        return $this;
    }


    /**
     * Implements run method.
     *
     * @param string  $message Redirected input.
     * @param boolean $status  Redirected input.
     *
     * @return mixed Returns null if wizard is ongoing. Result if done.
     */
    public function run($message='', $status=null)
    {
        global $config;
        // Load styles.
        parent::run();

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

        $this->printHeader();

        // Show redirected messages from discovery.php.
        if ($status === 0) {
            ui_print_success_message($message);
        } else if ($status !== null) {
            ui_print_error_message($message);
        }

        $force_run = (bool) get_parameter('force_run');
        if ($force_run === true) {
            return $this->forceConsoleTask();
        }

        $delete_console_task = (bool) get_parameter('delete_console_task');
        if ($delete_console_task === true) {
            return $this->deleteConsoleTask();
        }

        $delete = (bool) get_parameter('delete', false);
        if ($delete === true) {
            return $this->deleteTask();
        }

        if (enterprise_installed()) {
            // This check only applies to enterprise users.
            enterprise_hook('tasklist_checkrunning');

            $ret = $this->showListConsoleTask();
        } else {
            $ret = false;
        }

        $ret2 = $this->showList();

        if ($ret === false && $ret2 === false) {
            include_once $config['homedir'].'/general/firts_task/recon_view.php';
        } else {
            $form = [
                'form'   => [
                    'method' => 'POST',
                    'action' => ui_get_full_url(
                        'index.php?sec=gservers&sec2=godmode/servers/discovery'
                    ),
                ],
                'inputs' => [
                    [
                        'arguments' => [
                            'name'       => 'submit',
                            'label'      => __('Go back'),
                            'type'       => 'submit',
                            'attributes' => 'class="sub cancel"',
                            'return'     => true,
                        ],
                    ],
                ],
            ];

            $this->printForm($form);
        }

        return $ret;
    }


    /**
     * Implements load method.
     *
     * @return mixed Skeleton for button.
     */
    public function load()
    {
        return [
            'icon'  => $this->icon,
            'label' => $this->label,
            'url'   => $this->url,

        ];

    }


    /**
     * Delete a recon task.
     *
     * @return void
     */
    public function deleteTask()
    {
        global $config;

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

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

        if ($task !== null) {
            $result = db_process_sql_delete(
                'trecon_task',
                ['id_rt' => $task]
            );

            if ($result == 1) {
                return [
                    'result' => 0,
                    'msg'    => __('Task successfully deleted'),
                    'id'     => false,
                ];
            }

            // Trick to avoid double execution.
            header('Location: '.$this->url);
        }

    }


    /**
     * Force console task.
     *
     * @return void
     */
    public function forceConsoleTask()
    {
        global $config;

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

        $id_console_task = (int) get_parameter('id_console_task');

        if ($id_console_task !== null) {
            enterprise_hook('cron_task_run', $id_console_task, true);
            // Trick to avoid double execution.
            header('Location: '.$this->url);
        }

    }


    /**
     * Delete a Console task.
     *
     * @return void
     */
    public function deleteConsoleTask()
    {
        global $config;

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

        $id_console_task = (int) get_parameter('id_console_task');

        if ($id_console_task !== null) {
            $result = db_process_sql_delete(
                'tuser_task_scheduled',
                ['id' => $id_console_task]
            );

            if ($result == 1) {
                return [
                    'result' => 0,
                    'msg'    => __('Console Task successfully deleted'),
                    'id'     => false,
                ];
            }

            // Trick to avoid double execution.
            header('Location: '.$this->url);
        }

    }


    /**
     * Show complete list of running tasks.
     *
     * @return boolean Success or not.
     */
    public function showList()
    {
        global $config;

        check_login();

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

        // Get all discovery servers.
        $servers = db_get_all_rows_sql('SELECT * FROM tserver WHERE server_type = 3');
        if ($servers === false) {
            $servers = [];
            ui_print_error_message(__('Discovery Server is disabled'));
            $check = db_get_all_rows_sql('SELECT * FROM trecon_task');
            return (bool) $check;
        } else {
            include_once $config['homedir'].'/include/functions_graph.php';
            include_once $config['homedir'].'/include/functions_servers.php';
            include_once $config['homedir'].'/include/functions_network_profiles.php';

            $modules_server = 0;
            $total_modules = 0;
            $total_modules_data = 0;

            // --------------------------------
            // FORCE A RECON TASK
            // --------------------------------
            if (check_acl($config['id_user'], 0, 'PM')) {
                if (isset($_GET['force'])) {
                    $id = (int) get_parameter_get('force', 0);
                    servers_force_recon_task($id);
                    header(
                        'Location: '.ui_get_full_url(
                            'index.php?sec=gservers&sec2=godmode/servers/discovery&wiz=tasklist'
                        )
                    );
                }
            }

            $recon_tasks = db_get_all_rows_sql('SELECT * FROM trecon_task');
            $user_groups = implode(',', array_keys(users_get_groups()));

            // Show network tasks for Recon Server.
            if ($recon_tasks === false) {
                $recon_tasks = [];
            }

                $table = new StdClass();
                $table->cellpadding = 4;
                $table->cellspacing = 4;
                $table->width = '100%';
                $table->class = 'databox data';
                $table->head = [];
                $table->data = [];
                $table->align = [];
                $table->headstyle = [];
            for ($i = 0; $i < 9; $i++) {
                $table->headstyle[$i] = 'text-align: left;';
            }

                $table->head[0] = __('Force');
                $table->align[0] = 'left';

                $table->head[1] = __('Task name');
                $table->align[1] = 'left';

                $table->head[2] = __('Server name');
                $table->align[2] = 'left';

                $table->head[3] = __('Interval');
                $table->align[3] = 'left';

                $table->head[4] = __('Network');
                $table->align[4] = 'left';

                $table->head[5] = __('Status');
                $table->align[5] = 'left';

                $table->head[6] = __('Task type');
                $table->align[6] = 'left';

                $table->head[7] = __('Progress');
                $table->align[7] = 'left';

                $table->head[8] = __('Updated at');
                $table->align[8] = 'left';

                $table->head[9] = __('Operations');
                $table->align[9] = 'left';

            foreach ($recon_tasks as $task) {
                $data = [];
                $server_name = servers_get_name($task['id_recon_server']);

                // By default.
                $subnet = $task['subnet'];

                // Exceptions: IPAM.
                $ipam = false;
                if ($task['id_recon_script'] != null) {
                    $recon_script_name = db_get_value('name', 'trecon_script', 'id_recon_script', $task['id_recon_script']);
                    if (io_safe_output($recon_script_name) == 'IPAM Recon'
                        && enterprise_installed()
                    ) {
                        $subnet_obj = json_decode($task['macros'], true);
                        $subnet = $subnet_obj['1']['value'];
                        $tipam_task_id = db_get_value('id', 'tipam_network', 'id_recon_task', $task['id_rt']);
                        $ipam = true;
                    }
                }

                if ($task['disabled'] == 0 && $server_name !== '') {
                    $data[0] = '<a href="'.ui_get_full_url(
                        'index.php?sec=gservers&sec2=godmode/servers/discovery&wiz=tasklist&server_id='.$id_server.'&force='.$task['id_rt']
                    ).'">';
                    $data[0] .= html_print_image('images/target.png', true, ['title' => __('Force')]);
                    $data[0] .= '</a>';
                } else if ($task['disabled'] == 2) {
                    $data[0] = ui_print_help_tip(
                        __('This task has not been completely defined, please edit it'),
                        true
                    );
                } else {
                    $data[0] = '';
                }

                $data[1] = '<b>'.$task['name'].'</b>';

                $data[2] = $server_name;

                if ($task['interval_sweep'] > 0) {
                    $data[3] = human_time_description_raw(
                        $task['interval_sweep']
                    );
                } else {
                    $data[3] = __('Manual');
                }

                if ($task['id_recon_script'] == 0 || $ipam === true) {
                    $data[4] = $subnet;
                } else {
                    $data[4] = '-';
                }

                if ($task['status'] <= 0) {
                    $data[5] = __('Done');
                } else {
                    $data[5] = __('Pending');
                }

                if ($task['id_recon_script'] == 0) {
                    // Discovery NetScan.
                    $data[6] = html_print_image(
                        'images/network.png',
                        true,
                        ['title' => __('Discovery NetScan')]
                    ).'&nbsp;&nbsp;';
                    $data[6] .= network_profiles_get_name(
                        $task['id_network_profile']
                    );
                } else {
                    // APP recon task.
                    $data[6] = html_print_image(
                        'images/plugin.png',
                        true
                    ).'&nbsp;&nbsp;';
                    $data[6] .= $recon_script_name;
                }

                if ($task['status'] <= 0 || $task['status'] > 100) {
                    $data[7] = '-';
                } else {
                    $data[7] = progress_bar(
                        $task['status'],
                        100,
                        20,
                        __('Progress').':'.$task['status'].'%',
                        1
                    );
                }

                if ($task['utimestamp'] > 0) {
                    $data[8] = ui_print_timestamp(
                        $task['utimestamp'],
                        true
                    );
                } else {
                    $data[8] = __('Not executed yet');
                }

                if (check_acl(
                    $config['id_user'],
                    $task['id_group'],
                    'PM'
                )
                ) {
                    if ($ipam === true) {
                        $data[9] = '<a href="'.ui_get_full_url(
                            sprintf(
                                'index.php?sec=godmode/extensions&sec2=enterprise/extensions/ipam&action=edit&id=%d',
                                $tipam_task_id
                            )
                        ).'">'.html_print_image(
                            'images/config.png',
                            true
                        ).'</a>';
                        $data[9] .= '<a href="'.ui_get_full_url(
                            'index.php?sec=godmode/extensions&sec2=enterprise/extensions/ipam&action=delete&id='.$tipam_task_id
                        ).'" onClick="if (!confirm(\' '.__('Are you sure?').'\')) return false;">'.html_print_image(
                            'images/cross.png',
                            true
                        ).'</a>';
                    } else {
                        // Check if is a H&D, Cloud or Application or IPAM.
                        $data[9] = '<a href="'.ui_get_full_url(
                            sprintf(
                                'index.php?sec=gservers&sec2=godmode/servers/discovery&%s&task=%d',
                                $this->getTargetWiz($task),
                                $task['id_rt']
                            )
                        ).'">'.html_print_image(
                            'images/config.png',
                            true
                        ).'</a>';
                        $data[9] .= '<a href="'.ui_get_full_url(
                            'index.php?sec=gservers&sec2=godmode/servers/discovery&wiz=tasklist&delete=1&task='.$task['id_rt']
                        ).'" onClick="if (!confirm(\' '.__('Are you sure?').'\')) return false;">'.html_print_image(
                            'images/cross.png',
                            true
                        ).'</a>';
                    }
                } else {
                    $data[9] = '';
                }

                array_push($table->data, $data);
            }

                echo '<h2>'.__('Server tasks').'</h2>';
            if (empty($table->data)) {
                echo '<div class="nf">'.__('Server').' '.$server_name.' '.__('has no discovery tasks assigned').'</div>';
                return false;
            } else {
                html_print_table($table);
            }

                unset($table);
        }

        return true;
    }


    /**
     * Show complete list of running tasks.
     *
     * @return boolean Success or not.
     */
    public function showListConsoleTask()
    {
        return enterprise_hook('tasklist_showListConsoleTask', [$this]);
    }


    /**
     * Return target url sub-string to edit target task.
     *
     * @param array $task With all data.
     *
     * @return string
     */
    public function getTargetWiz($task)
    {
        // TODO: Do not use description. Use recon_script ID instead.
        switch ($task['description']) {
            case 'Discovery.Application.VMware':
            return 'wiz=app&mode=vmware&page=0';

            case CLOUDWIZARD_AWS_DESCRIPTION:
            return 'wiz=cloud&mode=amazonws&page=1';

            case 'console_task':
            return 'wiz=ctask';

            default:
                if ($task['id_recon_script'] === null) {
                    return 'wiz=hd&mode=netscan';
                } else {
                    return 'wiz=hd&mode=customnetscan';
                }
        }
    }


}