mod/hotpot/attempt.php

   1 <?php // $Id$
   2     require_once("../../config.php");
   3     require_once("lib.php");
   4
   5     $attemptid = required_param('attemptid', PARAM_INT);
   6
   7     // get attempt, hotpot, course and course_module records
   8     if (! $attempt = get_record("hotpot_attempts", "id", $attemptid)) {
   9         error("Hot Potatoes attempt record $attemptid could not be accessed: ".$db->ErrorMsg());
  10     }
  11     if ($attempt->userid != $USER->id) {
  12         error("User ID is incorrect");
  13     }
  14     if (! $hotpot = get_record("hotpot", "id", $attempt->hotpot)) {
  15         error("Hot Potatoes ID is incorrect (attempt id = $attempt->id)");
  16     }
  17     if (! $course = get_record("course", "id", $hotpot->course)) {
  18         error("Course ID is incorrect (hotpot id = $hotpot->id)");
  19     }
  20     if (! $cm = get_coursemodule_from_instance("hotpot", $hotpot->id, $course->id)) {
  21         error("Course Module ID is incorrect");
  22     }
  23
  24     // make sure this user is enrolled in this course
  25     require_login($course);
  26
  27     $next_url = "$CFG->wwwroot/course/view.php?id=$course->id";
  28     $time = time();
  29
  30     // check user can access this hotpot activity
  31     if (!hotpot_is_visible($cm)) {
  32         print_error("activityiscurrentlyhidden", 'hotpot', $next_url);
  33     }
  34
  35     // update attempt record fields using incoming data
  36     $attempt->score = optional_param('mark', NULL, PARAM_INT);
  37     $attempt->status = optional_param('status', NULL, PARAM_INT);
  38     $attempt->details = optional_param('detail', NULL, PARAM_RAW);
  39     $attempt->endtime = optional_param('endtime', NULL, PARAM_ALPHA);
  40     $attempt->starttime = optional_param('starttime', NULL, PARAM_ALPHA);
  41     $attempt->timefinish = $time;
  42
  43     // convert times, if necessary
  44     if (empty($attempt->starttime)) {
  45         $attempt->starttime = 0;
  46     } else {
  47          $attempt->starttime = strtotime($attempt->starttime);
  48     }
  49     if (empty($attempt->endtime)) {
  50         $attempt->endtime = 0;
  51     } else {
  52          $attempt->endtime = strtotime($attempt->endtime);
  53     }
  54
  55     // set clickreportid, (for click reporting)
  56     $attempt->clickreportid = $attempt->id;
  57
  58     $quiztype = optional_param('quiztype', 0, PARAM_INT);
  59
  60     if (empty($attempt->details)) {
  61         hotpot_set_attempt_details($attempt);
  62         $javascript_is_off = true;
  63     } else {
  64         $javascript_is_off = false;
  65     }
  66
  67     if (empty($attempt->status)) {
  68         if (empty($attempt->endtime)) {
  69             $attempt->status = HOTPOT_STATUS_INPROGRESS;
  70         } else {
  71             $attempt->status = HOTPOT_STATUS_COMPLETED;
  72         }
  73     }
  74
  75     // check if this is the second (or subsequent) click
  76     if (get_field("hotpot_attempts", "timefinish", "id", $attempt->id)) {
  77
  78         if ($hotpot->clickreporting==HOTPOT_YES) {
  79             // add attempt record for each form submission
  80             // records are linked via the "clickreportid" field
  81
  82             // update status in previous records in this group
  83             set_field("hotpot_attempts", "status", $attempt->status, "clickreportid", $attempt->clickreportid);
  84
  85             // add new attempt record
  86             unset ($attempt->id);
  87             $attempt->id = insert_record("hotpot_attempts", $attempt);
  88
  89             if (empty($attempt->id)) {
  90                 error("Could not insert attempt record: ".$db->ErrorMsg(), $next_url);
  91             }
  92
  93             // add attempt details record, if necessary
  94             if (!empty($attempt->details)) {
  95                 unset($details);
  96                 $details->attempt = $attempt->id;
  97                 $details->details = $attempt->details;
  98                 if (! insert_record("hotpot_details", $details, false)) {
  99                     error("Could not insert attempt details record: ".$db->ErrorMsg(), $next_url);
 100                 }
 101             }
 102         } else {
 103             // remove previous responses for this attempt, if required
 104             // (N.B. this does NOT remove the attempt record, just the responses)
 105             delete_records("hotpot_responses", "attempt", $attempt->id);
 106         }
 107     }
 108
 109     // remove slashes added by lib/setup.php
 110     $attempt->details = stripslashes($attempt->details);
 111
 112     // add details of this attempt
 113     hotpot_add_attempt_details($attempt);
 114
 115     // add slashes again, so the details can be added to the database
 116     $attempt->details = addslashes($attempt->details);
 117
 118     // update the attempt record
 119     if (! update_record("hotpot_attempts", $attempt)) {
 120         error("Could not update attempt record: ".$db->ErrorMsg(), $next_url);
 121     }
 122
 123     // update grades for this user
 124     hotpot_update_grades($hotpot, $attempt->userid);
 125
 126     // get previous attempt details record, if any
 127     $details_exist = record_exists("hotpot_details", "attempt", $attempt->id);
 128
 129     // delete/update/add the attempt details record
 130     if (empty($attempt->details)) {
 131         if ($details_exist) {
 132             delete_records("hotpot_details", "attempt", $attempt->id);
 133         }
 134     } else {
 135         if ($details_exist) {
 136             set_field("hotpot_details", "details", $attempt->details, "attempt", $attempt->id);
 137         } else {
 138             unset($details);
 139             $details->attempt = $attempt->id;
 140             $details->details = $attempt->details;
 141             if (! insert_record("hotpot_details", $details)) {
 142                 error("Could not insert attempt details record: ".$db->ErrorMsg(), $next_url);
 143             }
 144         }
 145     }
 146
 147     if ($attempt->status==HOTPOT_STATUS_INPROGRESS) {
 148         if ($javascript_is_off) {
 149             // regenerate HTML page
 150             define('HOTPOT_FIRST_ATTEMPT', false);
 151             include ("$CFG->hotpotroot/view.php");
 152         } else {
 153             // continue without reloading the page
 154             header("Status: 204");
 155             header("HTTP/1.0 204 No Response");
 156         }
 157
 158     } else { // quiz is finished
 159
 160         add_to_log($course->id, "hotpot", "submit", "review.php?id=$cm->id&attempt=$attempt->id", "$hotpot->id", "$cm->id");
 161
 162         if ($hotpot->shownextquiz==HOTPOT_YES) {
 163             if (is_numeric($next_cm = hotpot_get_next_cm($cm))) {
 164                 $next_url = "$CFG->wwwroot/mod/hotpot/view.php?id=$next_cm";
 165             }
 166         }
 167
 168         // redirect to the next quiz or the course page
 169         redirect($next_url, get_string('resultssaved', 'hotpot'));
 170     }
 171
 172 // =================
 173 //  functions
 174 // =================
 175
 176 function hotpot_get_next_cm(&$cm) {
 177     // gets the next module in this section of the course
 178     // that is the same type of module as the current module
 179
 180     $next_mod = false;
 181
 182     // get a list of $ids of modules in this section
 183     if ($ids = get_field('course_sections', 'sequence', 'id', $cm->section)) {
 184
 185         $found = false;
 186         $ids = explode(',', $ids);
 187         foreach ($ids as $id) {
 188             if ($found && ($cm->module==get_field('course_modules', 'module', 'id', $id))) {
 189                 $next_mod = $id;
 190                 break;
 191             } else if ($cm->id==$id) {
 192                 $found = true;
 193             }
 194         }
 195     }
 196     return $next_mod;
 197 }
 198 function hotpot_set_attempt_details(&$attempt) {
 199     global $CFG, $HOTPOT_QUIZTYPE;
 200
 201     // optional_param('showallquestions', 0, PARAM_INT);
 202
 203     $attempt->details = '';
 204     $attempt->score = 0;
 205     $attempt->status = HOTPOT_STATUS_COMPLETED;
 206
 207     $buttons = array('clues', 'hints', 'checks');
 208     $textfields = array('correct', 'wrong', 'ignored');
 209
 210     $ok = false;
 211     $quiztype = optional_param('quiztype', 0, PARAM_ALPHANUM);
 212     if ($quiztype) {
 213         if (is_numeric($quiztype)) {
 214             $ok = array_key_exists($quiztype, $HOTPOT_QUIZTYPE);
 215         } else {
 216             $quiztype = array_search($quiztype, $HOTPOT_QUIZTYPE);
 217             $ok = is_numeric($quiztype);
 218         }
 219     }
 220     if (!$ok) {
 221         return;
 222         // error('Quiz type is missing or invalid');
 223         // print_error('error_invalidquiztype', 'hotpot');
 224         //
 225         // script finishes here if quiztype is invalid
 226         //
 227     }
 228
 229     // special flag to detect jquiz multiselect
 230     $is_jquiz_multiselect = false;
 231
 232     // set maximum question number
 233     $q_max = 0;;
 234     do {
 235         switch ($quiztype) {
 236             case HOTPOT_JCLOZE:
 237             case HOTPOT_JQUIZ:
 238                 $field="q{$q_max}_a0_text";
 239                 break;
 240             case HOTPOT_JCB:
 241             case HOTPOT_JCROSS:
 242             case HOTPOT_JMATCH:
 243             case HOTPOT_JMIX:
 244             default:
 245                 $field = '';
 246         }
 247     } while ($field && isset($_POST[$field]) && ($q_max = $q_max+1));
 248
 249     // check JQuiz navigation buttons
 250     switch (true) {
 251         case isset($_POST['ShowAllQuestionsButton']):
 252             $_POST['ShowAllQuestions'] = 1;
 253             break;
 254         case isset($_POST['ShowOneByOneButton']):
 255             $_POST['ShowAllQuestions'] = 0;
 256             break;
 257         case isset($_POST['PrevQButton']):
 258             $_POST['ThisQuestion']--;
 259             break;
 260         case isset($_POST['NextQButton']):
 261             $_POST['ThisQuestion']++;
 262             break;
 263     }
 264
 265     $q = 0;
 266     while ($q<$q_max) {
 267         $responsefield="q{$q}";
 268
 269         $questiontype = optional_param("{$responsefield}_questiontype", 0, PARAM_INT);
 270         $is_jquiz_multiselect = ($quiztype==HOTPOT_JQUIZ && $questiontype==HOTPOT_JQUIZ_MULTISELECT);
 271
 272         if (isset($_POST[$responsefield]) && is_array($_POST[$responsefield])) {
 273             $responsevalue = array();
 274             foreach ($_POST[$responsefield] as $key=>$value) {
 275                 $responsevalue[$key] = clean_param($value, PARAM_CLEAN);
 276             }
 277         } else {
 278             $responsevalue = optional_param($responsefield, '');
 279         }
 280         if (is_array($responsevalue)) {
 281             // incomplete jquiz multi-select
 282             $responsevalues = $responsevalue;
 283             $responsevalue = implode('+', $responsevalue);
 284         } else {
 285             $responsevalues = explode('+', $responsevalue);
 286         }
 287
 288         // initialize $response object
 289         $response = new stdClass();
 290         $response->correct = array();
 291         $response->wrong   = array();
 292         $response->ignored = array();
 293         $response->clues  = 0;
 294         $response->hints  = 0;
 295         $response->checks = 0;
 296         $response->score  = 0;
 297         $response->weighting = 0;
 298
 299         // create another empty object to hold all previous responses (from database)
 300         $oldresponse = new stdClass();
 301         $vars = get_object_vars($response);
 302         foreach($vars as $name=>$value) {
 303             $oldresponse->$name = $value;
 304         }
 305
 306         foreach ($buttons as $button) {
 307             if (($field = "q{$q}_{$button}_button") && isset($_POST[$field])) {
 308                 $value = optional_param($field, '', PARAM_RAW);
 309                 if (!empty($value)) {
 310                     $response->$button++;
 311                 }
 312             }
 313         }
 314
 315         // loop through possible answers to this question
 316         $firstcorrectvalue = '';
 317         $percents = array();
 318         $a = 0;
 319         while (($valuefield="q{$q}_a{$a}_text") && isset($_POST[$valuefield])) {
 320             $value = optional_param($valuefield, '', PARAM_RAW);
 321
 322             if (($percentfield="q{$q}_a{$a}_percent") && isset($_POST[$percentfield])) {
 323                 $percent = optional_param($percentfield, 0, PARAM_INT);
 324                 if ($percent) {
 325                     $percents[$value] = $percent;
 326                 }
 327             }
 328
 329             if (($correctfield="q{$q}_a{$a}_correct") && isset($_POST[$correctfield])) {
 330                 $correct = optional_param($correctfield, 0, PARAM_INT);
 331             } else {
 332                 $correct = false;
 333             }
 334
 335             if ($correct && empty($firstcorrectvalue)) {
 336                 $firstcorrectvalue = $value;
 337             }
 338
 339             if ($is_jquiz_multiselect) {
 340                 $selected = in_array($value, $responsevalues);
 341                 if ($correct) {
 342                     $response->correct[] = $value;
 343                     if (empty($selected)) {
 344                         $response->wrong[] = true;
 345                     }
 346                 } else {
 347                     if ($selected) {
 348                         $response->wrong[] = true;
 349                     }
 350                 }
 351             } else {
 352                 // single answer only required
 353                 if ($responsevalue==$value) {
 354                     if ($correct) {
 355                         $response->correct[] = $value;
 356                     } else {
 357                         $response->wrong[] = $value;
 358                     }
 359                 } else {
 360                     $response->ignored[] = $value;
 361                 }
 362             }
 363             $a++;
 364         }
 365
 366         // number of answers for this question
 367         $a_max = $a;
 368
 369         if ($is_jquiz_multiselect) {
 370             if (empty($response->wrong) && count($responsevalues)==count($response->correct)) {
 371                 $response->wrong = array();
 372                 $response->correct = array($responsevalue);
 373             } else {
 374                 $response->correct = array();
 375                 $response->wrong = array($responsevalue);
 376             }
 377         } else {
 378             // if response did not match any answer, then this response is wrong
 379             if (empty($response->correct) && empty($response->wrong)) {
 380                 $response->wrong[] = $responsevalue;
 381             }
 382         }
 383
 384         // if this question has not been answered correctly, quiz is still in progress
 385         if (empty($response->correct)) {
 386
 387             if (isset($_POST["q{$q}_ShowAnswers_button"])) {
 388                     $_POST[$responsefield] = $firstcorrectvalue;
 389             } else {
 390                 $attempt->status = HOTPOT_STATUS_INPROGRESS;
 391
 392                 if (isset($_POST["q{$q}_Hint_button"])) {
 393                     // a particular hint button in JQuiz shortanswer
 394                     $_POST['HintButton'] = true;
 395                 }
 396
 397                 // give a hint, if necessary
 398                 if (isset($_POST['HintButton']) && $firstcorrectvalue) {
 399
 400                     // make sure we only come through here once
 401                     unset($_POST['HintButton']);
 402
 403                     $correctlen = strlen($firstcorrectvalue);
 404                     $responselen = strlen($responsevalue);
 405
 406                     // check how many letters are the same
 407                     $i = 0;
 408                     while ($i<$responselen && $i<$correctlen && $responsevalue{$i}==$firstcorrectvalue{$i}) {
 409                         $i++;
 410                     }
 411
 412                     if ($i<$responselen) {
 413                         // remove incorrect characters on the end of the response
 414                         $responsevalue = substr($responsevalue, 0, $i);
 415                     }
 416                     if ($i<$correctlen) {
 417                         // append next correct letter
 418                         $responsevalue .= $firstcorrectvalue{$i};
 419                     }
 420                     $_POST[$responsefield] = $responsevalue;
 421                     $response->hints++;
 422                 } // end if hint
 423             }
 424         } // end if not correct
 425
 426         // get clue text, if any
 427         if (($field="q{$q}_clue") && isset($_POST[$field])) {
 428             $response->clue_text = optional_param($field, '', PARAM_RAW);
 429         }
 430
 431         // get question name
 432         $qq = sprintf('%02d', $q); // (a padded, two-digit version of $q)
 433         if (($field="q{$q}_name") && isset($_POST[$field])) {
 434             $questionname = optional_param($field, '',  PARAM_RAW);
 435             $questionname = strip_tags($questionname);
 436         } else {
 437             $questionname = $qq;
 438         }
 439
 440         // get previous responses to this question (if any)
 441         $records = get_records_sql("
 442             SELECT
 443                 r.*
 444             FROM
 445                 {$CFG->prefix}hotpot_attempts a,
 446                 {$CFG->prefix}hotpot_questions q,
 447                 {$CFG->prefix}hotpot_responses r
 448             WHERE
 449                 a.clickreportid = $attempt->clickreportid AND
 450                 a.id = r.attempt AND
 451                 r.question = q.id AND
 452                 q.name = '$questionname' AND
 453                 q.hotpot = $attempt->hotpot
 454             ORDER BY
 455                 a.timefinish
 456         ");
 457
 458         if ($records) {
 459             foreach ($records as $record) {
 460                 foreach ($buttons as $button) {
 461                     $oldresponse->$button = max($oldresponse->$button, $record->$button);
 462                 }
 463                 foreach ($textfields as $field) {
 464                     if ($record->$field && ($field=='correct' || $field=='wrong')) {
 465                         $values = explode(',', hotpot_strings($record->$field));
 466                         $oldresponse->$field = array_merge($oldresponse->$field, $values);
 467                     }
 468                 }
 469             }
 470         }
 471
 472         // remove "correct" and "wrong" values from "ignored" values
 473         $response->ignored = array_diff($response->ignored,
 474             $response->correct, $response->wrong, $oldresponse->correct, $oldresponse->wrong
 475         );
 476
 477         foreach ($buttons as $button) {
 478             $response->$button += $oldresponse->$button;
 479         }
 480
 481         $value_has_changed = false;
 482         foreach ($textfields as $field) {
 483             $response->$field = array_merge($oldresponse->$field, $response->$field);
 484             $response->$field = array_unique($response->$field);
 485             $response->$field  = implode(',', $response->$field);
 486
 487             if ($field=='correct' || $field=='wrong') {
 488                 $array = $oldresponse->$field;
 489                 $array = array_unique($array);
 490                 $oldresponse->$field  = implode(',', $array);
 491                 if ($response->$field<>$oldresponse->$field) {
 492                     $value_has_changed = true;
 493                 }
 494             }
 495         }
 496         if ($value_has_changed) {
 497             $response->checks++;
 498         }
 499
 500         // $response now holds amalgamation of all responses so far to this question
 501
 502         // set question score and weighting
 503         if ($response->correct) {
 504             switch ($quiztype) {
 505                 case HOTPOT_JCB:
 506                     break;
 507                 case HOTPOT_JCLOZE:
 508                     $strlen = strlen($response->correct);
 509                     $response->score = 100*($strlen-($response->checks-1))/$strlen;
 510                     $attempt->score += $response->score;
 511                     break;
 512                 case HOTPOT_JCROSS:
 513                     break;
 514                 case HOTPOT_JMATCH:
 515                     break;
 516                 case HOTPOT_JMIX:
 517                     break;
 518                 case HOTPOT_JQUIZ:
 519                     switch ($questiontype) {
 520                         case HOTPOT_JQUIZ_MULTICHOICE:
 521                             $wrong = explode(',', $response->wrong);
 522                             foreach ($wrong as $value) {
 523                                 if (isset($percents[$value])) {
 524                                     $percent = $percents[$value];
 525                                 } else {
 526                                     $percent = 0;
 527                                 }
 528                             }
 529                         case HOTPOT_JQUIZ_SHORTANSWER:
 530                             $strlen = strlen($response->correct);
 531                             $response->score = 100*($strlen-($response->checks-1))/$strlen;
 532                             break;
 533                         case HOTPOT_JQUIZ_MULTISELECT:
 534                             if (isset($percents[$response->correct])) {
 535                                 $percent = $percents[$response->correct];
 536                             } else {
 537                                 $percent = 0;
 538                             }
 539                             if ($a_max>0 && $response->checks>0 && $a_max>$response->checks) {
 540                                 $response->score = $percent*($a_max-($response->checks-1))/$a_max;
 541                             }
 542                             break;
 543                     }
 544                     $attempt->score += $response->score;
 545                     break;
 546             }
 547         }
 548
 549         $fieldname = $HOTPOT_QUIZTYPE[$quiztype]."_q{$qq}_name";
 550         $attempt->details .= "<field><fieldname>$fieldname</fieldname><fielddata>$questionname</fielddata></field>";
 551
 552         // encode $response fields as XML
 553         $vars = get_object_vars($response);
 554         foreach($vars as $name=>$value) {
 555             if (!empty($value)) {
 556                 $fieldname = $HOTPOT_QUIZTYPE[$quiztype]."_q{$qq}_{$name}";
 557                 $attempt->details .= "<field><fieldname>$fieldname</fieldname><fielddata>$value</fielddata></field>";
 558             }
 559         }
 560
 561         $q++;
 562     } // end main loop through $q(uestions)
 563
 564     // set attempt score
 565     if ($q>0) {
 566         switch ($quiztype) {
 567             case HOTPOT_JCB:
 568                 break;
 569             case HOTPOT_JCLOZE:
 570                 $attempt->score = floor($attempt->score / $q);
 571                 break;
 572             case HOTPOT_JCROSS:
 573                 break;
 574             case HOTPOT_JMATCH:
 575                 break;
 576             case HOTPOT_JMIX:
 577                 break;
 578             case HOTPOT_JQUIZ:
 579                 break;
 580         }
 581     }
 582
 583     if ($attempt->details) {
 584         $attempt->details = '<?xml version="1.0"?><hpjsresult><fields>'.$attempt->details.'</fields></hpjsresult>';
 585     }
 586
 587 //  print "forcing status to in progress ..<br/>\n";
 588 //  $attempt->status = HOTPOT_STATUS_INPROGRESS;
 589 }
 590
 591 ?>