chamilo-lms/main/exercice/exercise_report.php

<?php
/* For licensing terms, see /license.txt */
/**
*	Exercise list: This script shows the list of exercises for administrators and students.
*	@package chamilo.exercise
*	@author Olivier Brouckaert, original author
*	@author Denes Nagy, HotPotatoes integration
*	@author Wolfgang Schneider, code/html cleanup
*	@author Julio Montoya <gugli100@gmail.com>, lots of cleanup + several improvements
* Modified by hubert.borderiou (question category)
*/
/**
 * Code
 */
// name of the language file that needs to be included
$language_file = array('exercice');

// including the global library
require_once '../inc/global.inc.php';
require_once '../gradebook/lib/be.inc.php';

// Setting the tabs
$this_section = SECTION_COURSES;

$htmlHeadXtra[] = api_get_jquery_ui_js(true);

// Access control
api_protect_course_script(true);

// including additional libraries
require_once 'exercise.class.php';
require_once 'exercise.lib.php';
require_once 'question.class.php';
require_once 'answer.class.php';
require_once api_get_path(LIBRARY_PATH) . 'fileManage.lib.php';
require_once api_get_path(LIBRARY_PATH) . 'fileUpload.lib.php';
require_once 'hotpotatoes.lib.php';
require_once api_get_path(LIBRARY_PATH) . 'document.lib.php';
require_once api_get_path(LIBRARY_PATH) . 'mail.lib.inc.php';
require_once api_get_path(LIBRARY_PATH) . "groupmanager.lib.php"; // for group filtering

// need functions of statsutils lib to display previous exercices scores
require_once api_get_path(LIBRARY_PATH) . 'statsUtils.lib.inc.php';

// document path
$documentPath = api_get_path(SYS_COURSE_PATH) . $_course['path'] . "/document";


/*	Constants and variables */
$is_allowedToEdit           = api_is_allowed_to_edit(null,true);
$is_tutor                   = api_is_allowed_to_edit(true);
 
$TBL_QUESTIONS              = Database :: get_course_table(TABLE_QUIZ_QUESTION);
$TBL_TRACK_EXERCICES        = Database :: get_statistic_table(TABLE_STATISTIC_TRACK_E_EXERCICES);
$TBL_TRACK_ATTEMPT          = Database :: get_statistic_table(TABLE_STATISTIC_TRACK_E_ATTEMPT);
$TBL_TRACK_ATTEMPT_RECORDING= Database :: get_statistic_table(TABLE_STATISTIC_TRACK_E_ATTEMPT_RECORDING);
$TBL_LP_ITEM_VIEW           = Database :: get_course_table(TABLE_LP_ITEM_VIEW);

$course_id      = api_get_course_int_id();
$exercise_id    = isset($_REQUEST['exerciseId']) ? intval($_REQUEST['exerciseId']) : null;

if (empty($exercise_id)) {
    api_not_allowed();
}

if (!empty($exercise_id))
    $parameters['exerciseId'] = $exercise_id;
if (!empty($_GET['path'])) {
    $parameters['path'] = Security::remove_XSS($_GET['path']);
}

// filter display by student group
// if $_GET['filterByGroup'] = -1 => do not filter
// else, filter by group_id (0 for no group)

$filterByGroup = -1;
if (isset($_GET['filterByGroup']) && is_numeric($_GET['filterByGroup'])) {
    $filterByGroup = Security::remove_XSS($_GET['filterByGroup']);
    api_session_register('filterByGroup');
} else if (isset($_SESSION['filterByGroup'])) {
    $filterByGroup = $_SESSION['filterByGroup'];
}

if (!empty ($_GET['extra_data'])) {
    switch ($_GET['extra_data']) {
        case 'on' :
            $_SESSION['export_user_fields'] = true;
            break;      
        default :
            $_SESSION['export_user_fields'] = false;
            break;
    }
}
if (!empty($_GET['export_report']) && $_GET['export_report'] == '1') {
    if (api_is_platform_admin() || api_is_course_admin() || api_is_course_tutor() || api_is_course_coach()) {
        $user_id = null;
        if (empty($_SESSION['export_user_fields']))
            $_SESSION['export_user_fields'] = false;
        if (!$is_allowedToEdit and !$is_tutor) {
            $user_id = api_get_user_id();
        }
        require_once 'exercise_result.class.php';
        switch ($_GET['export_format']) {
            case 'xls' :
                $export = new ExerciseResult();               
                $export->exportCompleteReportXLS($documentPath, $user_id, $_SESSION['export_user_fields'], $_GET['export_filter'], $_GET['exerciseId'], $_GET['hotpotato_name']);
                exit;
                break;
            case 'csv' :
            default :
                $export = new ExerciseResult();
                $export->exportCompleteReportCSV($documentPath, $user_id, $_SESSION['export_user_fields'], $_GET['export_filter'], $_GET['exerciseId'], $_GET['hotpotato_name']);
                exit;
                break;
        }
    } else {
        api_not_allowed(true);
    }
}

//Send student email @todo move this code in a class, library
if ($_REQUEST['comments'] == 'update' && ($is_allowedToEdit || $is_tutor) && $_GET['exeid']== strval(intval($_GET['exeid']))) {
    $id         = intval($_GET['exeid']); //filtered by post-condition    
    $track_exercise_info = get_exercise_track_exercise_info($id);
    if (empty($track_exercise_info)) {
        api_not_allowed();
    }
    $test              = $track_exercise_info['title'];
    $student_id        = $track_exercise_info['exe_user_id'];

    $session_id        = $track_exercise_info['session_id'];
    $lp_id             = $track_exercise_info['orig_lp_id'];
    $lp_item_id        = $track_exercise_info['orig_lp_item_id'];
    $lp_item_view_id   = $track_exercise_info['orig_lp_item_view_id'];
    
    // Teacher data    
    $teacher_info      = api_get_user_info(api_get_user_id());    
    $user_info         = api_get_user_info($student_id);    
    $student_email     = $user_info['mail'];    
    $from              = $teacher_info['mail'];
    $from_name         = api_get_person_name($teacher_info['firstname'], $teacher_info['lastname'], null, PERSON_NAME_EMAIL_ADDRESS);
    
    $url               = api_get_path(WEB_CODE_PATH) . 'exercice/exercise_report.php?' . api_get_cidreq() . '&id_session='.$session_id.'&exerciseId='.$exercise_id; 

    $my_post_info      = array();
    $post_content_id   = array();
    $comments_exist    = false;
    
    foreach ($_POST as $key_index => $key_value) {
        $my_post_info  = explode('_',$key_index);
        $post_content_id[]=$my_post_info[1];
        if ($my_post_info[0]=='comments') {
            $comments_exist=true;
        }
    }

    $loop_in_track=($comments_exist===true) ? (count($_POST)/2) : count($_POST);
    $array_content_id_exe=array();
    if ($comments_exist===true) {
        $array_content_id_exe = array_slice($post_content_id,$loop_in_track);
    } else {
        $array_content_id_exe = $post_content_id;
    }
    
    for ($i=0;$i<$loop_in_track;$i++) {
        $my_marks           = Database::escape_string($_POST['marks_'.$array_content_id_exe[$i]]);
        $contain_comments   = Database::escape_string($_POST['comments_'.$array_content_id_exe[$i]]);
        if (isset($contain_comments)) {
            $my_comments    = Database::escape_string($_POST['comments_'.$array_content_id_exe[$i]]);
        } else {
            $my_comments    = '';
        }
        $my_questionid = intval($array_content_id_exe[$i]);
        $sql = "SELECT question from $TBL_QUESTIONS WHERE c_id = $course_id AND id = '$my_questionid'";
        $result =Database::query($sql);
        Database::result($result,0,"question");

        $query = "UPDATE $TBL_TRACK_ATTEMPT SET marks = '$my_marks',teacher_comment = '$my_comments' WHERE question_id = ".$my_questionid." AND exe_id=".$id;
        Database::query($query);
        
        //Saving results in the track recording table
        $recording_changes = 'INSERT INTO '.$TBL_TRACK_ATTEMPT_RECORDING.' (exe_id, question_id, marks, insert_date, author, teacher_comment) 
                              VALUES ('."'$id','".$my_questionid."','$my_marks','".api_get_utc_datetime()."','".api_get_user_id()."'".',"'.$my_comments.'")';
        Database::query($recording_changes);
    }
    
    $qry = 'SELECT DISTINCT question_id, marks FROM ' . $TBL_TRACK_ATTEMPT . ' WHERE exe_id = '.$id .' GROUP BY question_id';
    $res = Database::query($qry);
    $tot = 0;
    while ($row = Database :: fetch_array($res, 'ASSOC')) {
        $tot += $row['marks'];
    }
    
    $totquery = "UPDATE $TBL_TRACK_EXERCICES SET exe_result = '".floatval($tot)."' WHERE exe_id = ".$id;
    Database::query($totquery);
    
    //@todo move this somewhere else
    $subject = get_lang('ExamSheetVCC');    
    
    $message  = '<p>'.get_lang('DearStudentEmailIntroduction') . '</p><p>'.get_lang('AttemptVCC');
    $message .= '<h3>'.get_lang('CourseName'). '</h3><p>'.Security::remove_XSS($course_info['name']).'';
    $message .= '<h3>'.get_lang('Exercise') . '</h3><p>'.Security::remove_XSS($test);
    
    //Only for exercises not in a LP
    if ($lp_id == 0) {  
        $message .= '<p>'.get_lang('ClickLinkToViewComment') . ' <a href="#url#">#url#</a><br />';
    }
        
    $message .= '<p>'.get_lang('Regards') . ' </p>';
    $message .= $from_name; 
    
    $message = str_replace("#test#", Security::remove_XSS($test), $message);
    $message = str_replace("#url#", $url, $message);
    
    @api_mail_html($student_email, $student_email, $subject, $message, $from_name, $from, array('charset'=>api_get_system_encoding()));
        
    //Updating LP score here    
    if (in_array($origin, array ('tracking_course','user_course','correct_exercise_in_lp'))) {   
        $sql_update_score = "UPDATE $TBL_LP_ITEM_VIEW SET score = '" . floatval($tot) . "' WHERE c_id = ".$course_id." AND id = " .$lp_item_view_id;
        Database::query($sql_update_score);
        if ($origin == 'tracking_course') {
            //Redirect to the course detail in lp
            header('location: exercice.php?course=' . Security :: remove_XSS($_GET['course']));            
            exit;
        } else {
            //Redirect to the reporting
            header('location: ../mySpace/myStudents.php?origin=' . $origin . '&student=' . $student_id . '&details=true&course=' . $course_id.'&session_id='.$session_id);
            exit;
        }        
    }
}

if ($is_allowedToEdit && $origin != 'learnpath') {
    // the form
    if (api_is_platform_admin() || api_is_course_admin() || api_is_course_tutor() || api_is_course_coach()) {
        if ($_SESSION['export_user_fields']) {
            $alt = get_lang('ExportWithUserFields');
            $extra_user_fields = '<input type="hidden" name="export_user_fields" value="export_user_fields">';
        } else {
            $alt = get_lang('ExportWithoutUserFields');
            $extra_user_fields = '<input type="hidden" name="export_user_fields" value="do_not_export_user_fields">';
        }           
        $actions .= '<a href="admin.php?exerciseId='.intval($_GET['exerciseId']).'">' . Display :: return_icon('back.png', get_lang('GoBackToQuestionList'),'','32').'</a>';        
    
        if ($_GET['filter'] == '1' or !isset ($_GET['filter']) or $_GET['filter'] == 0 ) {
            $filter = 1;
        } else {
            $filter = 2;
        }
        $actions .= '<a id="export_opener" href="'.api_get_self().'?export_report=1&export_filter='.$filter.'&hotpotato_name='.Security::remove_XSS($_GET['path']).'&exerciseId='.intval($_GET['exerciseId']).'" >'.
              Display::return_icon('save.png',   get_lang('Export'),'',32).'</a>';          
    }
} else {
    $actions .= '<a href="exercice.php">' . Display :: return_icon('back.png', get_lang('GoBackToQuestionList'),'','32').'</a>';
}

//Deleting an attempt
if ($_GET['delete'] == 'delete' && ($is_allowedToEdit || api_is_coach()) && !empty ($_GET['did']) && $_GET['did'] == strval(intval($_GET['did']))) {
    $sql = 'DELETE FROM ' . $TBL_TRACK_EXERCICES . ' WHERE exe_id = ' . intval($_GET['did']); //_GET[did] filtered by entry condition    
    Database::query($sql);
    $sql = 'DELETE FROM ' . $TBL_TRACK_ATTEMPT . ' WHERE exe_id = ' . intval($_GET['did']); //_GET[did] filtered by entry condition
    Database::query($sql);
    
    $filter=Security::remove_XSS($_GET['filter']);
    header('Location: exercise_report.php?cidReq=' . Security::remove_XSS($_GET['cidReq']) . '&filter=' . $filter . '&exerciseId='.$exercise_id.'&filter_by_user='.$_GET['filter_by_user']);
    exit;
}

if ($is_allowedToEdit || $is_tutor) {
    $nameTools = get_lang('StudentScore');
    $interbreadcrumb[] = array("url" => "exercice.php?gradebook=$gradebook","name" => get_lang('Exercices'));
    $objExerciseTmp = new Exercise();        
    if ($objExerciseTmp->read($exercise_id)) {
        $interbreadcrumb[] = array("url" => "admin.php?exerciseId=".$exercise_id, "name" => $objExerciseTmp->name);    
    }    
} else {
    
    $interbreadcrumb[] = array("url" => "exercice.php?gradebook=$gradebook","name" => get_lang('Exercices'));
    $objExerciseTmp = new Exercise();        
    if ($objExerciseTmp->read($exercise_id)) {
        $nameTools = get_lang('Results').': '.$objExerciseTmp->name; 
    }
}

Display :: display_header($nameTools);

$actions = Display::div($actions, array('class'=> 'actions'));

$extra =  '<script type="text/javascript">       
    $(document).ready(function() {
                    
        $( "#dialog:ui-dialog" ).dialog( "destroy" );
            
        $( "#dialog-confirm" ).dialog({
                autoOpen: false,
                show: "blind",                
                resizable: false,
                height:250,
                modal: true
         });
    
        $("#export_opener").click(function() {                
            var targetUrl = $(this).attr("href");        
            $( "#dialog-confirm" ).dialog({
                width:350,
                height:220,
                buttons: {
                    "'.addslashes(get_lang('Download')).'": function() {
                        var export_format = $("input[name=export_format]:checked").val();
                        var extra_data  = $("input[name=load_extra_data]:checked").val();                            
                        location.href = targetUrl+"&export_format="+export_format+"&extra_data="+extra_data;                
                        $( this ).dialog( "close" );                    
                    },                
                }
            });        
            $( "#dialog-confirm" ).dialog("open");
            return false;
        });         
    });
    </script>';

$extra .= '<div id="dialog-confirm" title="'.get_lang("ConfirmYourChoice").'">';
$extra .= Display::tag('p', Display::input('radio', 'export_format', 'csv', array('checked'=>'1', 'id'=>'export_format_csv_label')). Display::tag('label', get_lang('ExportAsCSV'), array('for'=>'export_format_csv_label')));
$extra .= Display::tag('p', Display::input('radio', 'export_format', 'xls', array('id'=>'export_format_xls_label')). Display::tag('label', get_lang('ExportAsXLS'), array('for'=>'export_format_xls_label')));   
$extra .= Display::tag('p', Display::input('checkbox', 'load_extra_data',  '0',array('id'=>'load_extra_data_id')). Display::tag('label', get_lang('LoadExtraData'), array('for'=>'load_extra_data_id')));
$extra .= '</div>';

if ($is_allowedToEdit) 
    echo $extra;

echo $actions;
//echo $content;
/*

$tpl = new Template($nameTools);
$tpl->assign('content', $content);
$tpl->display_one_col_template();
*/

$url = api_get_path(WEB_AJAX_PATH).'model.ajax.php?a=get_exercise_results&exerciseId='.$exercise_id;

//$activeurl = '?sidx=session_active';
$action_links = '';

$group_list = GroupManager::get_group_list();
$group_parameters = array(':'.get_lang('All'));
foreach ($group_list as $group) {
    $group_parameters[] = $group['id'].':'.$group['name'];    
}
if (!empty($group_parameters)) {
    $group_parameters = implode(';', $group_parameters);
}

if ($is_allowedToEdit || $is_tutor) {
	
	//The order is important you need to check the the $column variable in the model.ajax.php file 
	$columns        = array(get_lang('FirstName'), get_lang('LastName'), get_lang('LoginName'), 
                        get_lang('Group'), get_lang('Duration'), get_lang('StartDate'),  get_lang('EndDate'), get_lang('Score'), get_lang('Status'), get_lang('Actions'));

//Column config
	$column_model   = array(
                        array('name'=>'firstname',      'index'=>'firstname',		'width'=>'50',   'align'=>'left', 'search' => 'true'),                        
                        array('name'=>'lastname',		'index'=>'lastname',		'width'=>'50',   'align'=>'left', 'formatter'=>'action_formatter', 'search' => 'true'),
                        array('name'=>'login',          'hidden'=>'true',          'index'=>'username',        'width'=>'40',   'align'=>'left', 'search' => 'true'),
                        array('name'=>'group_name',		'index'=>'group_id',    'width'=>'40',   'align'=>'left', 'search' => 'true', 'stype'=> 'select',
                            //for the bottom bar
                            'searchoptions' => array(                                                
                                            'defaultValue'  => '', 
                                            'value'         => $group_parameters),
                              //for the top bar                              
                              'editoptions' => array('value' => $group_parameters)),
                            
                        array('name'=>'duration',       'index'=>'exe_duration',	'width'=>'30',   'align'=>'left', 'search' => 'true'),
                        array('name'=>'start_date',		'index'=>'start_date',		'width'=>'60',   'align'=>'left', 'search' => 'true'),                        
						array('name'=>'exe_date',		'index'=>'exe_date',		'width'=>'60',   'align'=>'left', 'search' => 'true'),                        
						array('name'=>'score',			'index'=>'exe_result',	    'width'=>'50',   'align'=>'left', 'search' => 'true'),
                        array('name'=>'status',         'index'=>'revised',			'width'=>'40',   'align'=>'left', 'search' => 'true', 'stype'=>'select',					          
                              //for the bottom bar
                              'searchoptions' => array(                                                
                                                'defaultValue'  => '', 
                                                'value'         => ':'.get_lang('All').';1:'.get_lang('Validated').';0:'.get_lang('NotValidated')),
                             
                              //for the top bar                              
                              'editoptions' => array('value' => ':'.get_lang('All').';1:'.get_lang('Validated').';0:'.get_lang('NotValidated'))),
//issue fixed in jqgrid                         
//                      array('name'=>'actions',        'index'=>'actions',         'width'=>'100',  'align'=>'left','formatter'=>'action_formatter','sortable'=>'false', 'search' => 'false')
						array('name'=>'actions',        'index'=>'actions',         'width'=>'60',  'align'=>'left', 'search' => 'false')
                       );          
    
    $action_links = '
    // add username as title in lastname filed - ref 4226
    function action_formatter(cellvalue, options, rowObject) {
        // rowObject is firstname,lastname,login,... get the third word
        var loginx = "'.api_htmlentities(sprintf(get_lang("LoginX"),":::"), ENT_QUOTES).'";
        var tabLoginx = loginx.split(/:::/);
        // tabLoginx[0] is before and tabLoginx[1] is after :::
        // may be empty string but is defined
        return "<span title=\""+tabLoginx[0]+rowObject[2]+tabLoginx[1]+"\">"+cellvalue+"</span>";
    }';
} else {
	
	//The order is important you need to check the the $column variable in the model.ajax.php file 
	$columns        = array(get_lang('Duration'), get_lang('StartDate'),  get_lang('EndDate'), get_lang('Score'), get_lang('Status'), get_lang('Actions'));
	
	//Column config
	$column_model   = array(                        
                        array('name'=>'duration',       'index'=>'exe_duration',	'width'=>'20',   'align'=>'left', 'search' => 'false'),
                        array('name'=>'start_date',		'index'=>'start_date',		'width'=>'50',   'align'=>'left', 'search' => 'false'),                        
						array('name'=>'exe_date',		'index'=>'exe_date',		'width'=>'50',   'align'=>'left', 'search' => 'false'),                        
						array('name'=>'score',			'index'=>'exe_result',		'width'=>'40',   'align'=>'left', 'search' => 'false'),	
                        array('name'=>'status',         'index'=>'revised',			'width'=>'40',   'align'=>'left', 'search' => 'false'),
                        array('name'=>'actions',        'index'=>'actions',			'width'=>'40',   'align'=>'left', 'search' => 'false')						
                       );   	
}
//Autowidth             
$extra_params['autowidth'] = 'true';

//height auto 
$extra_params['height'] = 'auto';
//$extra_params['excel'] = 'excel';

$extra_params['rowList'] = array(10, 20 ,30);

?>
<script>
    
function setSearchSelect(columnName) {    
    $("#results").jqGrid('setColProp', columnName,
    {                   
       searchoptions:{
            dataInit:function(el){                            
                $("option[value='1']",el).attr("selected", "selected");
                setTimeout(function(){
                    $(el).trigger('change');
                },1000);
            }
        }
    });
}

$(function() {
    
    <?php 
        echo Display::grid_js('results', $url,$columns,$column_model, $extra_params, array(), $action_links, true);      
    ?>
    
    <?php  if ($is_allowedToEdit || $is_tutor) { ?>       
        //setSearchSelect("status"); 
        
        $("#results").jqGrid('navGrid','#results_pager', {edit:false,add:false,del:false},
            {height:280,reloadAfterSubmit:false}, // edit options 
            {height:280,reloadAfterSubmit:false}, // add options 
            {reloadAfterSubmit:false}, // del options 
            {width:500} // search options
        );
            
        /*
        // add custom button to export the data to excel
        jQuery("#sessions").jqGrid('navButtonAdd','#sessions_pager',{
            caption:"", 
            onClickButton : function () { 
                jQuery("#sessions").excelExport();
            } 
        });

        jQuery('#sessions').jqGrid('navButtonAdd','#sessions_pager',{id:'pager_csv',caption:'',title:'Export To CSV',onClickButton : function(e)
        {
            try {
                jQuery("#sessions").jqGrid('excelExport',{tag:'csv', url:'grid.php'});
            } catch (e) {
                window.location= 'grid.php?oper=csv';
            }
        },buttonicon:'ui-icon-document'})
        */


        //Adding search options
        var options = {
            'stringResult': true,
            'autosearch' : true,
            'searchOnEnter':false   
        }
        jQuery("#results").jqGrid('filterToolbar',options);    
        var sgrid = $("#results")[0];
        sgrid.triggerToolbar();
        
        
    <?php } ?>
});
</script>
<?php

echo Display::grid_html('results');
Display :: display_footer();