chamilo-lms2/main/course_progress/thematic_controller.php

<?php

/* For licensing terms, see /license.txt */

/**
 * This file contains class used like controller for thematic, it should be included inside a dispatcher file (e.g: index.php)
 *
 * !!! WARNING !!! : ALL DATES IN THIS MODULE ARE STORED IN UTC ! DO NOT CONVERT DURING THE TRANSITION FROM CHAMILO 1.8.x TO 2.0
 *
 * @author Christian Fasanando <christian1827@gmail.com>
 * @author Julio Montoya <gugli100@gmail.com> token support improving UI
 * @package chamilo.course_progress
 */

/**
 * Thematic Controller script. Prepares the common background variables to give to the scripts corresponding to
 * the requested action
 * @todo use a proper controller in src/ChamiloLMS
 * @package chamilo.course_progress
 */
class ThematicController
{

    /**
     * Constructor
     */
    public function __construct()
    {
        $this->toolname = 'course_progress';
        $this->view = new View($this->toolname);
    }

    /**
     * This method is used for thematic control (update, insert or listing)
     * @param 	string	Action
     * render to thematic.php
     */
    public function thematic($action)
    {
        $courseInfo = api_get_course_info();
        $thematic = new Thematic($courseInfo);
        $data = array();
        $error = false;

        $check = Security::check_token('request');
        $thematic_id = isset($_REQUEST['thematic_id']) ? intval($_REQUEST['thematic_id']) : null;

        if ($check) {
            switch ($action) {
                case 'thematic_add':
                case 'thematic_edit':
                    // insert or update a thematic
                    if (strtoupper($_SERVER['REQUEST_METHOD']) == "POST") {
                        if (trim($_POST['title']) !== '') {
                            if (api_is_allowed_to_edit(null, true)) {

                                $id = $_POST['thematic_id'];
                                $title = $_POST['title'];
                                $content = $_POST['content'];
                                $session_id = api_get_session_id();
                                $thematic->set_thematic_attributes($id, $title, $content, $session_id);
                                $last_id = $thematic->thematic_save();
                                if ($_POST['action'] == 'thematic_add') {
                                    $action = 'thematic_details';
                                    $thematic_id = null;
                                    if ($last_id) {
                                        $data['last_id'] = $last_id;
                                    }
                                } else {
                                    $action = 'thematic_details';
                                    $thematic_id = null;
                                }
                            }
                        } else {
                            $error = true;
                            $data['error'] = $error;
                            $data['action'] = $_POST['action'];
                            $data['thematic_id'] = $_POST['thematic_id'];
                            // render to the view
                            $this->view->set_data($data);
                            $this->view->set_layout('layout');
                            $this->view->set_template('thematic');
                            $this->view->render();
                        }
                    }
                    break;
                case 'thematic_copy':
                    //Copy a thematic to a session
                    $thematic->copy($thematic_id);
                    $thematic_id = null;
                    $action = 'thematic_details';
                    break;
                case 'thematic_delete_select':
                    //Delete many thematics
                    if (strtoupper($_SERVER['REQUEST_METHOD']) == "POST") {
                        if (api_is_allowed_to_edit(null, true)) {
                            $thematic_ids = $_POST['id'];
                            $affected_rows = $thematic->thematic_destroy($thematic_ids);
                        }
                        $action = 'thematic_details';
                    }
                    break;
                case 'thematic_delete':
                    // Delete a thematic
                    if (isset($thematic_id)) {
                        if (api_is_allowed_to_edit(null, true)) {
                            $affected_rows = $thematic->thematic_destroy($thematic_id);
                        }
                        $thematic_id = null;
                        $action = 'thematic_details';
                    }
                    break;
                case 'thematic_import_select':
                    break;
                case 'thematic_import':
                    $csv_import_array = Import::csv_to_array($_FILES['file']['tmp_name'], 'horizontal');

                    if (isset($_POST['replace']) && $_POST['replace']) {
                        // Remove current thematic.
                        $list = $thematic->get_thematic_list();
                        foreach ($list as $i) {
                            $thematic->thematic_destroy($i);
                        }
                    }

                    // Import the progress.
                    $current_thematic = null;

                    foreach ($csv_import_array as $data) {
                        foreach ($data as $key => $item) {
                            if ($key == 'title') {
                                $thematic->set_thematic_attributes(null, $item[0], $item[1], api_get_session_id());
                                $current_thematic = $thematic->thematic_save();
                                $description_type = 0;
                            }
                            if ($key == 'plan') {
                                $thematic->set_thematic_plan_attributes($current_thematic, $item[0], $item[1], $description_type);
                                $thematic->thematic_plan_save();
                                $description_type++;
                            }
                            if ($key == 'progress') {
                                $thematic->set_thematic_advance_attributes(null, $current_thematic, 0, $item[2], $item[0], $item[1]);
                                $thematic->thematic_advance_save();
                            }
                        }
                    }
                    $action = 'thematic_details';
                    break;
                case 'thematic_export':
                    $list = $thematic->get_thematic_list();
                    $csv = array();
                    foreach ($list as $theme) {
                        $csv[] = array('title', $theme['title'], $theme['content']);
                        $data = $thematic->get_thematic_plan_data($theme['id']);
                        if (!empty($data)) {
                            foreach ($data as $plan) {
                                $csv[] = array('plan', $plan['title'], $plan['description']);
                            }
                        }
                        $data = $thematic->get_thematic_advance_by_thematic_id($theme['id']);
                        if (!empty($data)) {
                            foreach ($data as $advance) {
                                $csv[] = array('progress', $advance['start_date'], $advance['duration'], $advance['content']);
                            }
                        }
                    }
                    Export::export_table_csv($csv);
                    exit;
                    // Don't continue building a normal page.
                    return;
                case 'thematic_export_pdf':
                    $list = $thematic->get_thematic_list();
                    $table = array();
                    $table[] = array(get_lang('Thematic'), get_lang('ThematicPlan'), get_lang('ThematicAdvance'));
                    foreach ($list as $theme) {
                        $data = $thematic->get_thematic_plan_data($theme['id']);
                        $plan_html = null;
                        if (!empty($data)) {
                            foreach ($data as $plan) {
                                $plan_html .= '<strong>' . $plan['title'] . '</strong><br /> ' . $plan['description'] . '<br />';
                            }
                        }
                        $data = $thematic->get_thematic_advance_by_thematic_id($theme['id']);
                        $advance_html = null;
                        if (!empty($data)) {
                            foreach ($data as $advance) {
                                $advance_html .= api_convert_and_format_date($advance['start_date'], DATE_FORMAT_LONG) . ' ('.$advance['duration'].' '.get_lang('HourShort').')<br />'.$advance['content'].'<br />';
                            }
                        }
                        $table[] = array($theme['title'], $plan_html, $advance_html);
                    }
                    $params = array(
                        'filename' => get_lang('Thematic') . '-' . api_get_local_time(),
                        'pdf_title' => get_lang('Thematic'),
                        'add_signatures' => true,
                        'format' => 'A4-L',
                        'orientation' => 'L'
                    );
                    Export::export_table_pdf($table, $params);
                    break;
                case 'moveup':
                    $thematic->move_thematic('up', $thematic_id);
                    $action = 'thematic_details';
                    $thematic_id = null;
                    break;
                case 'movedown':
                    $thematic->move_thematic('down', $thematic_id);
                    $action = 'thematic_details';
                    $thematic_id = null;
                    break;
            }
            Security::clear_token();
        } else {
            $action = 'thematic_details';
            $thematic_id = null;
        }
        if (isset($thematic_id)) {
            $data['thematic_data'] = $thematic->get_thematic_list($thematic_id);
            $data['thematic_id'] = $thematic_id;
        }

        if ($action == 'thematic_details') {
            if (isset($thematic_id)) {
                $thematic_data_result = $thematic->get_thematic_list($thematic_id);
                if (!empty($thematic_data_result)) {
                    $thematic_data[$thematic_id] = $thematic_data_result;
                }
                $data['total_average_of_advances'] = $thematic->get_average_of_advances_by_thematic($thematic_id);
            } else {
                $thematic_data = $thematic->get_thematic_list(null, null, api_get_session_id());
                $data['max_thematic_item'] = $thematic->get_max_thematic_item();
                $data['last_done_thematic_advance'] = $thematic->get_last_done_thematic_advance();
                $data['total_average_of_advances'] = $thematic->get_total_average_of_thematic_advances();
            }

            //Second column
            $thematic_plan_data = $thematic->get_thematic_plan_data();

            //Third column
            $thematic_advance_data = $thematic->get_thematic_advance_list(null, null, true);

            $data['thematic_plan_div'] = $thematic->get_thematic_plan_div($thematic_plan_data);

            $data['thematic_advance_div'] = $thematic->get_thematic_advance_div($thematic_advance_data);

            $data['thematic_plan_data'] = $thematic_plan_data;
            $data['thematic_advance_data'] = $thematic_advance_data;
            $data['thematic_data'] = $thematic_data;
        }

        $data['default_thematic_plan_title'] = $thematic->get_default_thematic_plan_title();

        $data['action'] = $action;
        // render to the view
        $this->view->set_data($data);
        $this->view->set_layout('layout');
        $this->view->set_template('thematic');
        $this->view->render();
    }

    /**
     * This method is used for thematic plan control (update, insert or listing)
     * @param 	string	Action
     * render to thematic_plan.php
     */
    public function thematic_plan($action)
    {
        $courseInfo = api_get_course_info();
        $thematic = new Thematic($courseInfo);

        $data = array();
        $error = false;

        if (strtoupper($_SERVER['REQUEST_METHOD']) == "POST") {
            if (isset($_POST['action']) && ($_POST['action'] == 'thematic_plan_add' || $_POST['action'] == 'thematic_plan_edit')) {
                if (isset($_POST['title'])) {
                    if ($_POST['thematic_plan_token'] == $_SESSION['thematic_plan_token']) {
                        if (api_is_allowed_to_edit(null, true)) {

                            $title_list         = $_REQUEST['title'];
                            $description_list   = $_REQUEST['description'];
                            $description_type   = $_REQUEST['description_type'];
                            $delete_list        = $_REQUEST['delete'];

                            foreach ($title_list as $id => $title) {
                                $thematic_plan_id = $id;
                                if (!$thematic->get_thematic_data_by_id($id)) {
                                    $thematic_plan_id = null;
                                }
                                $thematic->set_thematic_plan_attributes($_REQUEST['thematic_id'], $title, $description_list[$id], $description_type[$id], $thematic_plan_id);
                                if (isset($delete_list[$id]) && !empty($delete_list[$id])) {
                                     $thematic->thematic_plan_delete();
                                } else {
                                    $affected_rows = $thematic->thematic_plan_save();
                                }
                            }
                            unset($_SESSION['thematic_plan_token']);
                            $data['message'] = 'ok';
                        }
                        $data['action'] = 'thematic_plan_list';
                    }
                } else {
                    $error = true;
                    $action = $_POST['action'];
                    $data['error'] = $error;
                    $data['thematic_plan_data'] = $thematic->get_thematic_plan_data($_POST['thematic_id'], $_POST['description_type']);
                    $data['thematic_id'] = $_POST['thematic_id'];
                    $data['description_type'] = $_POST['description_type'];
                    $data['action'] = $action;
                    $data['default_thematic_plan_title'] = $thematic->get_default_thematic_plan_title();
                    $data['default_thematic_plan_icon'] = $thematic->get_default_thematic_plan_icon();
                    $data['default_thematic_plan_question'] = $thematic->get_default_question();
                    $data['next_description_type'] = $thematic->get_next_description_type($_POST['thematic_id']);

                    // render to the view
                    $this->view->set_data($data);
                    $this->view->set_layout('layout');
                    $this->view->set_template('thematic_plan');
                    $this->view->render();
                }
            }
        }

        $thematic_id = intval($_GET['thematic_id']);

        if ($action == 'thematic_plan_list') {
            $data['thematic_plan_data'] = $thematic->get_thematic_plan_data($thematic_id);
        }

        $description_type = intval($_GET['description_type']);

        if (!empty($thematic_id) && !empty($description_type)) {
            if ($action == 'thematic_plan_delete') {
                if (api_is_allowed_to_edit(null, true)) {
                    $affected_rows = $thematic->thematic_plan_destroy($thematic_id, $description_type);
                }
                $data['thematic_plan_data'] = $thematic->get_thematic_plan_data($thematic_id);
                $action = 'thematic_plan_list';
            } else {
                $data['thematic_plan_data'] = $thematic->get_thematic_plan_data($thematic_id, $description_type);
            }
            $data['thematic_id'] = $thematic_id;
            $data['description_type'] = $description_type;
        } else if (!empty($thematic_id) && $action == 'thematic_plan_list') {
            $data['thematic_plan_data'] = $thematic->get_thematic_plan_data($thematic_id);
            $data['thematic_id'] = $thematic_id;
        }

        $data['thematic_id'] = $thematic_id;
        $data['action'] = $action;

        $data['default_thematic_plan_title'] = $thematic->get_default_thematic_plan_title();
        $data['default_thematic_plan_icon'] = $thematic->get_default_thematic_plan_icon();
        $data['next_description_type'] = $thematic->get_next_description_type($thematic_id);
        $data['default_thematic_plan_question'] = $thematic->get_default_question();
        $data['thematic_data'] = $thematic->get_thematic_list($thematic_id);

        //render to the view
        $this->view->set_data($data);
        $this->view->set_layout('layout');
        $this->view->set_template('thematic_plan');
        $this->view->render();
        exit;
    }

    /**
     * This method is used for thematic advance control (update, insert or listing)
     * @param 	string	Action
     * render to thematic_advance.php
     */
    public function thematic_advance($action)
    {
        $courseInfo = api_get_course_info();
        $thematic = new Thematic($courseInfo);
        $attendance = new Attendance();
        $data = array();

        // get data for attendance input select
        $attendance_list = $attendance->get_attendances_list();
        $attendance_select = array();
        $attendance_select[0] = get_lang('SelectAnAttendance');
        foreach ($attendance_list as $attendance_id => $attendance_data) {
            $attendance_select[$attendance_id] = $attendance_data['name'];
        }

        $thematic_id = intval($_REQUEST['thematic_id']);
        $thematic_advance_id = intval($_REQUEST['thematic_advance_id']);

        $thematic_advance_data = array();

        switch ($action) {
            case 'thematic_advance_delete':
                if (!empty($thematic_advance_id)) {
                    if (api_is_allowed_to_edit(null, true)) {
                        $affected_rows = $thematic->thematic_advance_destroy($thematic_advance_id);
                    }
                    $action = 'thematic_list';
                    header('Location: index.php');
                    exit;
                }
                break;
            case 'thematic_advance_list':
                if (!api_is_allowed_to_edit(null, true)) {
                    echo '';
                    exit;
                }

                if (($_REQUEST['start_date_type'] == 1 && empty($_REQUEST['start_date_by_attendance'])) || (!empty($_REQUEST['duration_in_hours']) && !is_numeric($_REQUEST['duration_in_hours']))) {
                    if ($_REQUEST['start_date_type'] == 1 && empty($_REQUEST['start_date_by_attendance'])) {
                        $start_date_error = true;
                        $data['start_date_error'] = $start_date_error;
                    }

                    if (!empty($_REQUEST['duration_in_hours']) && !is_numeric($_REQUEST['duration_in_hours'])) {
                        $duration_error = true;
                        $data['duration_error'] = $duration_error;
                    }

                    $data['action'] = $_REQUEST['action'];
                    $data['thematic_id'] = $_REQUEST['thematic_id'];
                    $data['attendance_select'] = $attendance_select;
                    if (isset($_REQUEST['thematic_advance_id'])) {
                        $data['thematic_advance_id'] = $_REQUEST['thematic_advance_id'];
                        $thematic_advance_data = $thematic->get_thematic_advance_list($_REQUEST['thematic_advance_id']);
                        $data['thematic_advance_data'] = $thematic_advance_data;
                    }
                } else {
                    if ($_REQUEST['thematic_advance_token'] == $_SESSION['thematic_advance_token'] && api_is_allowed_to_edit(null, true)) {

                        $thematic_advance_id = $_REQUEST['thematic_advance_id'];
                        $thematic_id = $_REQUEST['thematic_id'];
                        $content = $_REQUEST['content'];
                        $duration = $_REQUEST['duration_in_hours'];
                        if (isset($_REQUEST['start_date_type']) && $_REQUEST['start_date_type'] == 2) {
                            $start_date = $thematic->build_datetime_from_array($_REQUEST['custom_start_date']);
                            $attendance_id = 0;
                        } else {
                            $start_date = $_REQUEST['start_date_by_attendance'];
                            $attendance_id = $_REQUEST['attendance_select'];
                        }
                        $thematic->set_thematic_advance_attributes($thematic_advance_id, $thematic_id, $attendance_id, $content, $start_date, $duration);
                        $affected_rows = $thematic->thematic_advance_save();
                        if ($affected_rows) {
                            // get last done thematic advance before move thematic list
                            $last_done_thematic_advance = $thematic->get_last_done_thematic_advance();
                            // update done advances with de current thematic list
                            if (!empty($last_done_thematic_advance)) {
                                $update_done_advances = $thematic->update_done_thematic_advances($last_done_thematic_advance);
                            }
                        }
                    }
                }
                break;
            default:
                $thematic_advance_data = $thematic->get_thematic_advance_list($thematic_advance_id);
                break;
        }


        // get calendar select by attendance id
        $calendar_select = array();
        if (!empty($thematic_advance_data)) {
            if (!empty($thematic_advance_data['attendance_id'])) {
                $attendance_calendar = $attendance->get_attendance_calendar($thematic_advance_data['attendance_id']);
                if (!empty($attendance_calendar)) {
                    foreach ($attendance_calendar as $calendar) {
                        $calendar_select[$calendar['date_time']] = $calendar['date_time'];
                    }
                }
            }
        }

        $data['action'] = $action;
        $data['thematic_id'] = $thematic_id;
        $data['thematic_advance_id'] = $thematic_advance_id;
        $data['attendance_select'] = $attendance_select;
        $data['thematic_advance_data'] = $thematic_advance_data;
        $data['calendar_select'] = $calendar_select;

        // render to the view
        $this->view->set_data($data);
        $this->view->set_layout('layout');
        $this->view->set_template('thematic_advance');
        $this->view->render();
    }

}