chamilo-lms/public/main/survey/reporting.php

<?php

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

use Chamilo\CoreBundle\Framework\Container;
use Chamilo\CourseBundle\Entity\CSurvey;

/**
 * @author unknown, the initial survey that did not make it in 1.8 because of bad code
 * @author Patrick Cool <patrick.cool@UGent.be>, Ghent University: cleanup,
 * refactoring and rewriting large parts of the code
 *
 * @todo The question has to be more clearly indicated (same style as when filling the survey)
 */
require_once __DIR__.'/../inc/global.inc.php';

$this_section = SECTION_COURSES;
$surveyId = isset($_GET['survey_id']) ? (int) $_GET['survey_id'] : 0;
$userId = $_GET['user_id'] ?? 0;
$action = $_GET['action'] ?? 'overview';
if (empty($surveyId)) {
    api_not_allowed(true);
}

$repo = Container::getSurveyRepository();
/** @var CSurvey $survey */
$survey = $repo->find($surveyId);
if (null === $survey) {
    api_not_allowed(true);
}

$people_filled_full_data = false;
if (0 == $survey->getAnonymous()) {
    $people_filled_full_data = true;
}

$people_filled = SurveyManager::get_people_who_filled_survey($surveyId, $people_filled_full_data);

SurveyUtil::check_parameters($people_filled);

$isDrhOfCourse = CourseManager::isUserSubscribedInCourseAsDrh(api_get_user_id(), api_get_course_info());

/** @todo this has to be moved to a more appropriate place (after the display_header of the code)*/
if ($isDrhOfCourse || !api_is_allowed_to_edit(false, true)) {
    // Show error message if the survey can be seen only by tutors
    if (SURVEY_VISIBLE_TUTOR == $survey->getVisibleResults()) {
        api_not_allowed(true);
    }
    Display::display_header(get_lang('Surveys'));
    SurveyUtil::handleReportingActions($survey, $people_filled);
    Display::display_footer();
    exit;
}

$exportReport = $_REQUEST['export_report'] ?? '';
$format = $_REQUEST['export_format'] ?? '';
if (!empty($exportReport) && !empty($format)) {
    $compact = false;
    switch ($format) {
        case 'xls':
            $filename = 'survey_results_'.$surveyId.'.xlsx';
            SurveyUtil::export_complete_report_xls($survey, $filename, $userId);
            exit;
            break;
        case 'csv-compact':
            $compact = true;
            // no break
        case 'csv':
        default:
            $data = SurveyUtil::export_complete_report($survey, $userId, $compact);
            $filename = 'survey_results_'.$surveyId.($compact ? '_compact' : '').'.csv';
            header('Content-type: application/octet-stream');
            header('Content-Type: application/force-download');
            header('Content-Disposition: attachment; filename= '.$filename);
            if (strpos($_SERVER['HTTP_USER_AGENT'], 'MSIE')) {
                header('Pragma: ');
                header('Cache-Control: ');
                header('Cache-Control: public'); // IE cannot download from sessions without a cache
            }
            header('Content-Description: '.$filename);
            header('Content-transfer-encoding: binary');
            echo $data;
            exit;
            break;
    }
}

$urlname = strip_tags(
    api_substr(api_html_entity_decode($survey->getTitle(), ENT_QUOTES), 0, 40)
);
if (api_strlen(strip_tags($survey->getTitle())) > 40) {
    $urlname .= '...';
}

// Breadcrumbs
$interbreadcrumb[] = [
    'url' => api_get_path(WEB_CODE_PATH).'survey/survey_list.php?'.api_get_cidreq(),
    'name' => get_lang('Survey list'),
];
$interbreadcrumb[] = [
    'url' => api_get_path(WEB_CODE_PATH).'survey/survey.php?survey_id='.$surveyId.'&'.api_get_cidreq(),
    'name' => $urlname,
];

if ('overview' === $action) {
    $tool_name = get_lang('Reporting');
} else {
    $interbreadcrumb[] = [
        'url' => api_get_path(WEB_CODE_PATH).'survey/reporting.php?survey_id='.$surveyId,
        'name' => get_lang('Reporting'),
    ];
    switch ($action) {
        case 'questionreport':
            $singlePage = isset($_GET['single_page']) ? (int) $_GET['single_page'] : 0;
            $tool_name = $singlePage ? get_lang('Questions\' overall report') : get_lang('Detailed report by question');
            break;
        case 'userreport':
            $tool_name = get_lang('Detailed report by user');
            break;
        case 'comparativereport':
            $tool_name = get_lang('Comparative report');
            break;
        case 'completereport':
            $tool_name = get_lang('Complete report');
            break;
    }
}

$htmlHeadXtra[] = '<script>
async function exportToPdf() {
    window.jsPDF = window.jspdf.jsPDF;

    $(".question-item img, #pdf_table img").hide();
    $(".question-item video, #pdf_table video").hide();
    $(".question-item audio, #pdf_table audio").hide();

    var doc = document.getElementById("question_results");
    var pdf = new jsPDF("", "pt", "a4");
    //var a4Height = 841.89;

    // Adding title
    pdf.setFontSize(16);
    pdf.text(40, 40, "'.get_lang('Reporting').'");

    const table = document.getElementById("pdf_table");
    var headerY = 0;
    await html2canvas(table).then(function(canvas) {
        var pageData = canvas.toDataURL("image/jpeg", 1);
        headerY = 530.28/canvas.width * canvas.height;
        pdf.addImage(pageData, "JPEG", 35, 60, 530, headerY);
    });

    var divs = doc.getElementsByClassName("question-item");
    var pages = [];
    var page = 1;
    for (var i = 0; i < divs.length; i += 1) {
        // Two parameters after addImage control the size of the added image,
        // where the page height is compressed according to the width-height ratio column of a4 paper.
        if (!pages[page]) {
            pages[page] = 0;
        }

        var positionY = 150;
        var diff = 250;
        pages[page] += 1;
        if (page > 1) {
            headerY = 0;
            positionY = 60;
            diff = 220;
        }
        if (pages[page] > 1) {
            positionY = pages[page] * diff + 5;
        }

        const title = $(divs[i]).find(".title-question");
        pdf.setFontSize(10);
        pdf.text(40, positionY, title.text());

        var svg = divs[i].querySelector("svg");
        if (svg) {
            svg2pdf(svg, pdf, {
                      xOffset: 150,
                      yOffset: positionY,
                      scale: 0.45,
            });
        }
        var tables = divs[i].getElementsByClassName("display-survey");
        var config= {};
        for (var j = 0; j < tables.length; j += 1) {
            await html2canvas(tables[j], config).then(function(canvas) {
                var pageData = canvas.toDataURL("image/jpeg", 0.7);
                if (pageData) {
                    pdf.addImage(pageData, "JPEG", 40, positionY + 180, 500, 500/canvas.width * canvas.height);
                }
            });
        }

        var tables = divs[i].getElementsByClassName("open-question");
        for (var j = 0; j < tables.length; j += 1) {
            await html2canvas(tables[j], config).then(function(canvas) {
                var pageData = canvas.toDataURL("image/jpeg", 0.7);
                if (pageData) {
                    pdf.addImage(pageData, "JPEG", 40, positionY + 10, 500, 500/canvas.width * canvas.height);
                }
            });
        }

        if (i > 0 && (i -1) % 2 === 0 && (i+1 != divs.length)) {
             pdf.addPage();
             page++;
        }
    }

    $(".question-item img, #pdf_table img").show();
    $(".question-item video, #pdf_table video").show();
    $(".question-item audio, #pdf_table audio").show();

    pdf.save("reporting.pdf");
}
</script>';

Display::display_header($tool_name, 'Survey');
SurveyUtil::handleReportingActions($survey, $people_filled);

if ('overview' === $action) {
    $html = null;
    $url = api_get_path(WEB_CODE_PATH).'survey/reporting.php?'.api_get_cidreq().'&';

    $html .= '<div class="survey-reports">';
    $html .= '<div class="list-group">';
    $html .= Display::url(
        Display::return_icon(
            'survey_reporting_overall.png',
            get_lang('Questions\' overall report'),
            null,
            ICON_SIZE_MEDIUM
        ).'<h4>'.get_lang('Questions\' overall report').'</h4><p>'.get_lang('Questions\' overall reportDetail').'</p>',
        $url.'action=questionreport&survey_id='.$surveyId.'&single_page=1',
        ['class' => 'list-group-item']
    );

    $html .= Display::url(
        Display::return_icon(
            'survey_reporting_question.png',
            get_lang('Detailed report by question'),
            null,
            ICON_SIZE_MEDIUM
        ).'<h4>'.get_lang('Detailed report by question').'</h4><p>'.get_lang('Detailed report by questionDetail').'</p>',
        $url.'action=questionreport&survey_id='.$surveyId,
        ['class' => 'list-group-item']
    );

    $html .= Display::url(
        Display::return_icon(
            'survey_reporting_user.png',
            get_lang('Detailed report by user'),
            null,
            ICON_SIZE_MEDIUM
        ).'<h4>'.get_lang('Detailed report by user').'</h4><p>'.get_lang('Detailed report by userDetail').'</p>',
        $url.'action=userreport&survey_id='.$surveyId,
        ['class' => 'list-group-item']
    );

    $html .= Display::url(
        Display::return_icon(
            'survey_reporting_comparative.png',
            get_lang('Comparative report'),
            null,
            ICON_SIZE_MEDIUM
        ).'<h4>'.get_lang('Comparative report').'</h4><p>'.get_lang('Comparative reportDetail').'</p>',
        $url.'action=comparativereport&survey_id='.$surveyId,
        ['class' => 'list-group-item']
    );

    $html .= Display::url(
        Display::return_icon(
            'survey_reporting_complete.png',
            get_lang('Complete report'),
            null,
            ICON_SIZE_MEDIUM
        ).'<h4>'.get_lang('Complete report').'</h4><p>'.get_lang('Complete reportDetail').'</p>',
        $url.'action=completereport&survey_id='.$surveyId,
        ['class' => 'list-group-item']
    );

    $html .= '</div>';
    $html .= '</div>';

    echo $html;
}

Display::display_footer();