mod/hotpot/report.php

   1 <?PHP  // $Id$
   2
   3 // This script uses installed report plugins to print quiz reports
   4
   5     require_once("../../config.php");
   6     require_once("lib.php");
   7
   8     $id = optional_param("id"); // Course Module ID, or
   9     $hp = optional_param("hp"); // hotpot ID
  10
  11     if ($id) {
  12         if (! $cm = get_record("course_modules", "id", $id)) {
  13             error("Course Module ID was incorrect");
  14         }
  15         if (! $course = get_record("course", "id", $cm->course)) {
  16             error("Course is misconfigured");
  17         }
  18         if (! $hotpot = get_record("hotpot", "id", $cm->instance)) {
  19             error("Course module is incorrect");
  20         }
  21
  22     } else {
  23         if (! $hotpot = get_record("hotpot", "id", $hp)) {
  24             error("Course module is incorrect");
  25         }
  26         if (! $course = get_record("course", "id", $hotpot->course)) {
  27             error("Course is misconfigured");
  28         }
  29         if (! $cm = get_coursemodule_from_instance("hotpot", $hotpot->id, $course->id)) {
  30             error("Course Module ID was incorrect");
  31         }
  32     }
  33
  34         // set homeurl of couse (for error messages)
  35         $course_homeurl = "$CFG->wwwroot/course/view.php?id=$course->id";
  36
  37         require_login($course->id);
  38
  39         // get report mode
  40         if (isteacher($course->id)) {
  41                 $mode = optional_param("mode", "overview", 0);
  42                 if (is_array($mode)) {
  43                         $mode = array_keys($mode);
  44                         $mode = $mode[0];
  45                 }
  46         } else {
  47                 // students have no choice
  48                 $mode = 'overview';
  49         }
  50
  51         // get report attributes
  52         if (isadmin()) {
  53                 $reportcourse = optional_param("reportcourse", "this");
  54         } else {
  55                 // students and ordinary teachers have no choice
  56                 $reportcourse = 'this';
  57         }
  58         if (isteacher($course->id)) {
  59                 $reportusers = optional_param("reportusers", "all");
  60         } else {
  61                 // students have no choice
  62                 $reportusers = 'this';
  63         }
  64         $reportattempts = optional_param("reportattempts", "all");
  65
  66 /// Start the report
  67
  68         add_to_log($course->id, "hotpot", "report", "report.php?id=$cm->id", "$hotpot->id", "$cm->id");
  69
  70         // print page header. if required
  71         if (empty($noheader)) {
  72                 hotpot_print_report_heading($course, $cm, $hotpot, $mode);
  73                 if (isteacher($course->id)) {
  74                         hotpot_print_report_selector($course, $hotpot, $mode, $reportcourse, $reportusers, $reportattempts);
  75                 }
  76         }
  77
  78         // delete selected attempts, if any
  79         if (isteacher($course->id)) {
  80                 $del = optional_param("del", "");
  81                 hotpot_delete_selected_attempts($hotpot, $del);
  82         }
  83
  84         $hotpot_ids = '';
  85         $course_ids = '';
  86         switch ($reportcourse) {
  87                 case 'this':
  88                         $course_ids = $course->id;
  89                         $hotpot_ids = $hotpot->id;
  90                         break;
  91                 case 'all' :
  92                         $records = get_records_select_menu('user_teachers', "userid='$USER->id'", 'course', 'id, course');
  93                         $course_ids = join(',', array_values($records));
  94
  95                         $records = get_records_select_menu('hotpot', "reference='$hotpot->reference'", 'reference', 'id, reference');
  96                         $hotpot_ids = join(',', array_keys($records));
  97                         break;
  98         }
  99
 100         $user_ids = '';
 101         $users = array();
 102         switch ($reportusers) {
 103                 case 'all':
 104                         $admin_ids = get_records_select_menu('user_admins');
 105                         if (is_array($admin_ids)) {
 106                                 $users = array_merge($users, $admin_ids);
 107                         }
 108                         $creator_ids = get_records_select_menu('user_coursecreators');
 109                         if (is_array($creator_ids)) {
 110                                 $users = array_merge($users, $creator_ids);
 111                         }
 112                         $teacher_ids = get_records_select_menu('user_teachers', "course IN ($course_ids)", 'course', 'id, userid');
 113                         if (is_array($teacher_ids)) {
 114                                 $users = array_merge($users, $teacher_ids);
 115                         }
 116                         $guest_id = get_records_select_menu('user', "username='guest'", '', 'id,id');
 117                         if (is_array($guest_id)) {
 118                                 $users = array_merge($users, $guest_id);
 119                         }
 120                 case 'students':
 121                         $student_ids = get_records_select_menu('user_students', "course IN ($course_ids)", 'course', 'id, userid');
 122                         if (is_array($student_ids)) {
 123                                 $users = array_merge($users, $student_ids);
 124                         }
 125                         $user_ids = join(',', array_values($users));
 126                         break;
 127                 case 'this':
 128                         $user_ids = $USER->id;
 129                         break;
 130         }
 131
 132         if (empty($user_ids)) {
 133                 print_heading(get_string('nousersyet'));
 134                 exit;
 135         }
 136
 137         // get attempts for these users
 138         $fields = 'a.*, u.firstname, u.lastname, u.picture';
 139         $table = "{$CFG->prefix}hotpot_attempts AS a, {$CFG->prefix}user AS u";
 140         $select = ($mode=='simplestat' || $mode=='fullstat') ? 'a.score IS NOT NULL' : 'a.timefinish>0';
 141         $select .= " AND a.hotpot IN ($hotpot_ids) AND a.userid IN ($user_ids) AND a.userid = u.id";
 142         $order = "u.lastname, a.attempt";
 143         if ($reportattempts=='best') {
 144                 $fields .= ", MAX(a.score) AS grade";
 145                 $select .= " GROUP BY a.userid";
 146         }
 147         $attempts = get_records_sql("SELECT $fields FROM $table WHERE $select ORDER BY $order");
 148
 149         if (empty($attempts)) {
 150                 print_heading(get_string('noattempts','quiz'));
 151                 exit;
 152         }
 153
 154         // get the questions
 155         if (!$questions = get_records_select('hotpot_questions', "hotpot='$hotpot->id'")) {
 156                 $questions = array();
 157         }
 158
 159         // get grades
 160         $grades = hotpot_get_grades($hotpot, $user_ids);
 161
 162         // get list of attempts by user
 163         $users = array();
 164         foreach ($attempts as $id=>$attempt) {
 165
 166                 $userid = $attempt->userid;
 167
 168                 if (!isset($users[$userid])) {
 169                         $grade = isset($grades[$userid]) ? $grades[$userid] : '&nbsp;';
 170                         $users[$userid]->grade = $grade;
 171                         $users[$userid]->attempts = array();
 172                 }
 173
 174                 $users[$userid]->attempts[] = &$attempts[$id];
 175
 176         }
 177
 178 /// Open the selected hotpot report and display it
 179
 180         $mode = clean_filename($mode);
 181
 182         if (! is_readable("report/$mode/report.php")) {
 183                 error("Report not known (".clean_text($mode).")", $course_homeurl);
 184         }
 185
 186         include("report/default.php");  // Parent class
 187         include("report/$mode/report.php");
 188
 189         $report = new hotpot_report();
 190
 191         if (! $report->display($hotpot, $cm, $course, $users, $attempts, $questions)) {
 192                 error("Error occurred during pre-processing!", $course_homeurl);
 193         }
 194
 195         if (empty($noheader)) {
 196                 print_footer($course);
 197         }
 198
 199 //////////////////////////////////////////////
 200 /// functions to delete attempts and responses
 201
 202 function hotpot_grade_heading($hotpot, $download) {
 203
 204         global $HOTPOT_GRADEMETHOD;
 205         $grademethod = $HOTPOT_GRADEMETHOD[$hotpot->grademethod];
 206
 207         if ($hotpot->grade!=100) {
 208                 $grademethod = "$hotpot->grade x $grademethod/100";
 209         }
 210         if (empty($download)) {
 211                 $grademethod = '<FONT size="1">'.$grademethod.'</FONT>';
 212         }
 213         $nl = $download ? "\n" : '<br>';
 214         return get_string('grade')."$nl($grademethod)";
 215 }
 216 function hotpot_delete_selected_attempts(&$hotpot, $del) {
 217
 218         $select = '';
 219         switch ($del) {
 220                 case 'all' :
 221                         $select = "hotpot='$hotpot->id'";
 222                         break;
 223                 case 'abandoned':
 224                         $select = "hotpot='$hotpot->id' AND timefinish>0 AND score IS NULL";
 225                         break;
 226                 case 'selection':
 227                         $ids = (array)data_submitted();
 228                         unset($ids['del']);
 229                         unset($ids['id']);
 230                         if (!empty($ids)) {
 231                                 $select = "hotpot='$hotpot->id' AND id IN (".implode(',', $ids).")";
 232                         }
 233                         break;
 234         }
 235
 236         // delete attempts using $select, if it is set
 237         if ($select) {
 238
 239                 $table = 'hotpot_attempts';
 240                 if ($attempts = get_records_select($table, $select)) {
 241
 242                         hotpot_delete_and_notify($table, $select, get_string('attempts', 'quiz'));
 243
 244                         $table = 'hotpot_responses';
 245                         $select = 'attempt IN ('.implode(',', array_keys($attempts)).')';
 246                         hotpot_delete_and_notify($table, $select, get_string('answer', 'quiz'));
 247                 }
 248         }
 249
 250 }
 251
 252 //////////////////////////////////////////////
 253 /// functions to print the report headings and
 254 /// report selector menus
 255
 256 function hotpot_print_report_heading(&$course, &$cm, &$hotpot, &$mode) {
 257         $strmodulenameplural = get_string("modulenameplural", "hotpot");
 258         $strmodulename  = get_string("modulename", "hotpot");
 259
 260         $title = "$course->shortname: $hotpot->name";
 261         $heading = "$course->fullname";
 262
 263         $navigation = "<a href=index.php?id=$course->id>$strmodulenameplural</a> -> ";
 264         $navigation .= "<a href=\"view.php?id=$cm->id\">$hotpot->name</a> -> ";
 265         if (isteacher($course->id)) {
 266                 $navigation .= get_string("report$mode", "quiz");
 267         } else {
 268                 $navigation .= get_string("report", "quiz");
 269         }
 270         if ($course->category) {
 271                 $navigation = "<a href=\"../../course/view.php?id=$course->id\">$course->shortname</a> -> $navigation";
 272         }
 273         $button = update_module_button($cm->id, $course->id, $strmodulename);
 274
 275         print_header($title, $heading, $navigation, "", "", true, $button, navmenu($course, $cm));
 276
 277         print_heading($hotpot->name);
 278 }
 279 function hotpot_print_report_selector(&$course, &$hotpot, &$mode, &$reportcourse, &$reportusers, &$reportattempts) {
 280
 281         global $CFG;
 282
 283         $reports = hotpot_get_report_names('overview,simplestat');
 284
 285         print '<form method="post" action="'."$CFG->wwwroot/mod/hotpot/report.php?hp=$hotpot->id".'">';
 286         print '<table cellpadding="4" align="center">';
 287
 288         $menus = array();
 289         if (isadmin()) {
 290                 $menus['reportcourse'] = array(
 291                         'this' => get_string('thiscourse', 'hotpot'),
 292                         'all' => get_string('allmycourses', 'hotpot')
 293                 );
 294         }
 295         $menus['reportusers'] = array(
 296                 'students' => get_string('students'),
 297                 'all' => get_string('allparticipants')
 298         );
 299         $menus['reportattempts'] = array(
 300                 'best' => get_string('bestattempt', 'hotpot'),
 301                 'all' => get_string('allattempts', 'hotpot')
 302         );
 303
 304         print '<tr><td align="center" colspan="'.count($reports).'">';
 305         foreach ($menus as $name => $options) {
 306                 eval('$value=$'.$name.';');
 307                 print choose_from_menu($options, $name, $value, "", "", 0, true);
 308         }
 309         if (isteacher($course->id)) {
 310                 helpbutton('reportselector', get_string('report'), 'hotpot');
 311         }
 312         print '</td></tr>';
 313
 314         print '<tr>';
 315         foreach ($reports as $name) {
 316                 print '<td><input type="submit" name="'."mode[$name]".'" value="'.get_string("report$name", "quiz").'"></td>';
 317         }
 318         print '</tr>';
 319
 320         print '</table>';
 321
 322         print '<hr size="1" noshade="noshade" />';
 323         print '</form>'."\n";
 324 }
 325 function hotpot_get_report_names($names='') {
 326         // $names : optional list showing required order reports names
 327
 328         $reports = array();
 329
 330         // convert $names to an array, if necessary (usually is)
 331         if (!is_array($names)) {
 332                 $names = explode(',', $names);
 333         }
 334
 335         $plugins = get_list_of_plugins("mod/hotpot/report");
 336         foreach($names as $name) {
 337                 if (is_numeric($i = array_search($name, $plugins))) {
 338                         $reports[] = $name;
 339                         unset($plugins[$i]);
 340                 }
 341         }
 342
 343         // append remaining plugins
 344         $reports = array_merge($reports, $plugins);
 345
 346         return $reports;
 347 }
 348 function hotpot_get_report_users($course_ids, $reportusers) {
 349         $users = array();
 350
 351         /// Check to see if groups are being used in this module
 352         $currentgroup = false;
 353         if ($groupmode = groupmode($course, $cm)) {   // Groups are being used
 354                 $currentgroup = setup_and_print_groups($course, $groupmode, "report.php?id=$cm->id&mode=simplestat");
 355         }
 356
 357         $sort = "u.lastname ASC";
 358
 359         switch ($reportusers) {
 360                 case 'students':
 361                         if ($currentgroup) {
 362                                 $users = get_group_students($currentgroup, $sort);
 363                         } else {
 364                                 $users = get_course_students($course->id, $sort);
 365                         }
 366                         break;
 367                 case 'all':
 368                         if ($currentgroup) {
 369                                 $users = get_group_users($currentgroup, $sort);
 370                         } else {
 371                                 $users = get_course_users($course->id, $sort);
 372                         }
 373                         break;
 374         }
 375
 376         return $users;
 377 }
 378 ?>