mod/quiz/lib.php

   1 <?php
   2 // This file is part of Moodle - http://moodle.org/
   3 //
   4 // Moodle is free software: you can redistribute it and/or modify
   5 // it under the terms of the GNU General Public License as published by
   6 // the Free Software Foundation, either version 3 of the License, or
   7 // (at your option) any later version.
   8 //
   9 // Moodle is distributed in the hope that it will be useful,
  10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12 // GNU General Public License for more details.
  13 //
  14 // You should have received a copy of the GNU General Public License
  15 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
  16
  17 /**
  18  * Library of functions for the quiz module.
  19  *
  20  * This contains functions that are called also from outside the quiz module
  21  * Functions that are only called by the quiz module itself are in {@link locallib.php}
  22  *
  23  * @package    mod
  24  * @subpackage quiz
  25  * @copyright  1999 onwards Martin Dougiamas {@link http://moodle.com}
  26  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  27  */
  28
  29
  30 defined('MOODLE_INTERNAL') || die();
  31
  32 require_once($CFG->libdir . '/eventslib.php');
  33 require_once($CFG->dirroot . '/calendar/lib.php');
  34
  35
  36 /**#@+
  37  * Option controlling what options are offered on the quiz settings form.
  38  */
  39 define('QUIZ_MAX_ATTEMPT_OPTION', 10);
  40 define('QUIZ_MAX_QPP_OPTION', 50);
  41 define('QUIZ_MAX_DECIMAL_OPTION', 5);
  42 define('QUIZ_MAX_Q_DECIMAL_OPTION', 7);
  43 /**#@-*/
  44
  45 /**
  46  * If start and end date for the quiz are more than this many seconds apart
  47  * they will be represented by two separate events in the calendar
  48  */
  49 define('QUIZ_MAX_EVENT_LENGTH', 5*24*60*60); // 5 days
  50
  51 /**
  52  * Given an object containing all the necessary data,
  53  * (defined by the form in mod_form.php) this function
  54  * will create a new instance and return the id number
  55  * of the new instance.
  56  *
  57  * @param object $quiz the data that came from the form.
  58  * @return mixed the id of the new instance on success,
  59  *          false or a string error message on failure.
  60  */
  61 function quiz_add_instance($quiz) {
  62     global $DB;
  63     $cmid = $quiz->coursemodule;
  64
  65     // Process the options from the form.
  66     $quiz->created = time();
  67     $quiz->questions = '';
  68     $result = quiz_process_options($quiz);
  69     if ($result && is_string($result)) {
  70         return $result;
  71     }
  72
  73     // Try to store it in the database.
  74     $quiz->id = $DB->insert_record('quiz', $quiz);
  75
  76     // Do the processing required after an add or an update.
  77     quiz_after_add_or_update($quiz);
  78
  79     return $quiz->id;
  80 }
  81
  82 /**
  83  * Given an object containing all the necessary data,
  84  * (defined by the form in mod_form.php) this function
  85  * will update an existing instance with new data.
  86  *
  87  * @param object $quiz the data that came from the form.
  88  * @return mixed true on success, false or a string error message on failure.
  89  */
  90 function quiz_update_instance($quiz, $mform) {
  91     global $CFG, $DB;
  92
  93     // Process the options from the form.
  94     $result = quiz_process_options($quiz);
  95     if ($result && is_string($result)) {
  96         return $result;
  97     }
  98
  99     $oldquiz = $DB->get_record('quiz', array('id' => $quiz->instance));
 100
 101     // Repaginate, if asked to.
 102     if (!$quiz->shufflequestions && !empty($quiz->repaginatenow)) {
 103         require_once($CFG->dirroot . '/mod/quiz/locallib.php');
 104         $quiz->questions = quiz_repaginate(quiz_clean_layout($oldquiz->questions, true),
 105                 $quiz->questionsperpage);
 106     }
 107     unset($quiz->repaginatenow);
 108
 109     // Update the database.
 110     $quiz->id = $quiz->instance;
 111     $DB->update_record('quiz', $quiz);
 112
 113     // Do the processing required after an add or an update.
 114     quiz_after_add_or_update($quiz);
 115
 116     if ($oldquiz->grademethod != $quiz->grademethod) {
 117         require_once($CFG->dirroot . '/mod/quiz/locallib.php');
 118         $quiz->sumgrades = $oldquiz->sumgrades;
 119         $quiz->grade = $oldquiz->grade;
 120         quiz_update_all_final_grades($quiz);
 121         quiz_update_grades($quiz);
 122     }
 123
 124     // Delete any previous preview attempts
 125     quiz_delete_previews($quiz);
 126
 127     return true;
 128 }
 129
 130 /**
 131  * Given an ID of an instance of this module,
 132  * this function will permanently delete the instance
 133  * and any data that depends on it.
 134  *
 135  * @param int $id the id of the quiz to delete.
 136  * @return bool success or failure.
 137  */
 138 function quiz_delete_instance($id) {
 139     global $DB;
 140
 141     $quiz = $DB->get_record('quiz', array('id' => $id), '*', MUST_EXIST);
 142
 143     quiz_delete_all_attempts($quiz);
 144     quiz_delete_all_overrides($quiz);
 145
 146     $DB->delete_records('quiz_question_instances', array('quiz' => $quiz->id));
 147     $DB->delete_records('quiz_feedback', array('quizid' => $quiz->id));
 148
 149     $events = $DB->get_records('event', array('modulename' => 'quiz', 'instance' => $quiz->id));
 150     foreach ($events as $event) {
 151         $event = calendar_event::load($event);
 152         $event->delete();
 153     }
 154
 155     quiz_grade_item_delete($quiz);
 156     $DB->delete_records('quiz', array('id' => $quiz->id));
 157
 158     return true;
 159 }
 160
 161 /**
 162  * Deletes a quiz override from the database and clears any corresponding calendar events
 163  *
 164  * @param object $quiz The quiz object.
 165  * @param int $overrideid The id of the override being deleted
 166  * @return bool true on success
 167  */
 168 function quiz_delete_override($quiz, $overrideid) {
 169     global $DB;
 170
 171     $override = $DB->get_record('quiz_overrides', array('id' => $overrideid), '*', MUST_EXIST);
 172
 173     // Delete the events
 174     $events = $DB->get_records('event', array('modulename' => 'quiz',
 175             'instance' => $quiz->id, 'groupid' => (int)$override->groupid,
 176             'userid' => (int)$override->userid));
 177     foreach ($events as $event) {
 178         $eventold = calendar_event::load($event);
 179         $eventold->delete();
 180     }
 181
 182     $DB->delete_records('quiz_overrides', array('id' => $overrideid));
 183     return true;
 184 }
 185
 186 /**
 187  * Deletes all quiz overrides from the database and clears any corresponding calendar events
 188  *
 189  * @param object $quiz The quiz object.
 190  */
 191 function quiz_delete_all_overrides($quiz) {
 192     global $DB;
 193
 194     $overrides = $DB->get_records('quiz_overrides', array('quiz' => $quiz->id), 'id');
 195     foreach ($overrides as $override) {
 196         quiz_delete_override($quiz, $override->id);
 197     }
 198 }
 199
 200 /**
 201  * Updates a quiz object with override information for a user.
 202  *
 203  * Algorithm:  For each quiz setting, if there is a matching user-specific override,
 204  *   then use that otherwise, if there are group-specific overrides, return the most
 205  *   lenient combination of them.  If neither applies, leave the quiz setting unchanged.
 206  *
 207  *   Special case: if there is more than one password that applies to the user, then
 208  *   quiz->extrapasswords will contain an array of strings giving the remaining
 209  *   passwords.
 210  *
 211  * @param object $quiz The quiz object.
 212  * @param int $userid The userid.
 213  * @return object $quiz The updated quiz object.
 214  */
 215 function quiz_update_effective_access($quiz, $userid) {
 216     global $DB;
 217
 218     // check for user override
 219     $override = $DB->get_record('quiz_overrides', array('quiz' => $quiz->id, 'userid' => $userid));
 220
 221     if (!$override) {
 222         $override = new stdClass();
 223         $override->timeopen = null;
 224         $override->timeclose = null;
 225         $override->timelimit = null;
 226         $override->attempts = null;
 227         $override->password = null;
 228     }
 229
 230     // check for group overrides
 231     $groupings = groups_get_user_groups($quiz->course, $userid);
 232
 233     if (!empty($groupings[0])) {
 234         // Select all overrides that apply to the User's groups
 235         list($extra, $params) = $DB->get_in_or_equal(array_values($groupings[0]));
 236         $sql = "SELECT * FROM {quiz_overrides}
 237                 WHERE groupid $extra AND quiz = ?";
 238         $params[] = $quiz->id;
 239         $records = $DB->get_records_sql($sql, $params);
 240
 241         // Combine the overrides
 242         $opens = array();
 243         $closes = array();
 244         $limits = array();
 245         $attempts = array();
 246         $passwords = array();
 247
 248         foreach ($records as $gpoverride) {
 249             if (isset($gpoverride->timeopen)) {
 250                 $opens[] = $gpoverride->timeopen;
 251             }
 252             if (isset($gpoverride->timeclose)) {
 253                 $closes[] = $gpoverride->timeclose;
 254             }
 255             if (isset($gpoverride->timelimit)) {
 256                 $limits[] = $gpoverride->timelimit;
 257             }
 258             if (isset($gpoverride->attempts)) {
 259                 $attempts[] = $gpoverride->attempts;
 260             }
 261             if (isset($gpoverride->password)) {
 262                 $passwords[] = $gpoverride->password;
 263             }
 264         }
 265         // If there is a user override for a setting, ignore the group override
 266         if (is_null($override->timeopen) && count($opens)) {
 267             $override->timeopen = min($opens);
 268         }
 269         if (is_null($override->timeclose) && count($closes)) {
 270             $override->timeclose = max($closes);
 271         }
 272         if (is_null($override->timelimit) && count($limits)) {
 273             $override->timelimit = max($limits);
 274         }
 275         if (is_null($override->attempts) && count($attempts)) {
 276             $override->attempts = max($attempts);
 277         }
 278         if (is_null($override->password) && count($passwords)) {
 279             $override->password = array_shift($passwords);
 280             if (count($passwords)) {
 281                 $override->extrapasswords = $passwords;
 282             }
 283         }
 284
 285     }
 286
 287     // merge with quiz defaults
 288     $keys = array('timeopen', 'timeclose', 'timelimit', 'attempts', 'password', 'extrapasswords');
 289     foreach ($keys as $key) {
 290         if (isset($override->{$key})) {
 291             $quiz->{$key} = $override->{$key};
 292         }
 293     }
 294
 295     return $quiz;
 296 }
 297
 298 /**
 299  * Delete all the attempts belonging to a quiz.
 300  *
 301  * @param object $quiz The quiz object.
 302  */
 303 function quiz_delete_all_attempts($quiz) {
 304     global $CFG, $DB;
 305     require_once($CFG->dirroot . '/mod/quiz/locallib.php');
 306     question_engine::delete_questions_usage_by_activities(new qubaids_for_quiz($quiz->id));
 307     $DB->delete_records('quiz_attempts', array('quiz' => $quiz->id));
 308     $DB->delete_records('quiz_grades', array('quiz' => $quiz->id));
 309 }
 310
 311 /**
 312  * Get the best current grade for a particular user in a quiz.
 313  *
 314  * @param object $quiz the quiz settings.
 315  * @param int $userid the id of the user.
 316  * @return float the user's current grade for this quiz, or null if this user does
 317  * not have a grade on this quiz.
 318  */
 319 function quiz_get_best_grade($quiz, $userid) {
 320     global $DB;
 321     $grade = $DB->get_field('quiz_grades', 'grade',
 322             array('quiz' => $quiz->id, 'userid' => $userid));
 323
 324     // Need to detect errors/no result, without catching 0 grades.
 325     if ($grade === false) {
 326         return null;
 327     }
 328
 329     return $grade + 0; // Convert to number.
 330 }
 331
 332 /**
 333  * Is this a graded quiz? If this method returns true, you can assume that
 334  * $quiz->grade and $quiz->sumgrades are non-zero (for example, if you want to
 335  * divide by them).
 336  *
 337  * @param object $quiz a row from the quiz table.
 338  * @return bool whether this is a graded quiz.
 339  */
 340 function quiz_has_grades($quiz) {
 341     return $quiz->grade >= 0.000005 && $quiz->sumgrades >= 0.000005;
 342 }
 343
 344 /**
 345  * Return a small object with summary information about what a
 346  * user has done with a given particular instance of this module
 347  * Used for user activity reports.
 348  * $return->time = the time they did it
 349  * $return->info = a short text description
 350  *
 351  * @param object $course
 352  * @param object $user
 353  * @param object $mod
 354  * @param object $quiz
 355  * @return object|null
 356  */
 357 function quiz_user_outline($course, $user, $mod, $quiz) {
 358     global $DB, $CFG;
 359     require_once("$CFG->libdir/gradelib.php");
 360     $grades = grade_get_grades($course->id, 'mod', 'quiz', $quiz->id, $user->id);
 361
 362     if (empty($grades->items[0]->grades)) {
 363         return null;
 364     } else {
 365         $grade = reset($grades->items[0]->grades);
 366     }
 367
 368     $result = new stdClass();
 369     $result->info = get_string('grade') . ': ' . $grade->str_long_grade;
 370
 371     //datesubmitted == time created. dategraded == time modified or time overridden
 372     //if grade was last modified by the user themselves use date graded. Otherwise use date submitted
 373     //TODO: move this copied & pasted code somewhere in the grades API. See MDL-26704
 374     if ($grade->usermodified == $user->id || empty($grade->datesubmitted)) {
 375         $result->time = $grade->dategraded;
 376     } else {
 377         $result->time = $grade->datesubmitted;
 378     }
 379
 380     return $result;
 381 }
 382
 383 /**
 384  * Print a detailed representation of what a  user has done with
 385  * a given particular instance of this module, for user activity reports.
 386  *
 387  * @global object
 388  * @param object $course
 389  * @param object $user
 390  * @param object $mod
 391  * @param object $quiz
 392  * @return bool
 393  */
 394 function quiz_user_complete($course, $user, $mod, $quiz) {
 395     global $DB, $CFG, $OUTPUT;
 396     require_once("$CFG->libdir/gradelib.php");
 397
 398     $grades = grade_get_grades($course->id, 'mod', 'quiz', $quiz->id, $user->id);
 399     if (!empty($grades->items[0]->grades)) {
 400         $grade = reset($grades->items[0]->grades);
 401         echo $OUTPUT->container(get_string('grade').': '.$grade->str_long_grade);
 402         if ($grade->str_feedback) {
 403             echo $OUTPUT->container(get_string('feedback').': '.$grade->str_feedback);
 404         }
 405     }
 406
 407     if ($attempts = $DB->get_records('quiz_attempts',
 408             array('userid' => $user->id, 'quiz' => $quiz->id), 'attempt')) {
 409         foreach ($attempts as $attempt) {
 410             echo get_string('attempt', 'quiz').' '.$attempt->attempt.': ';
 411             if ($attempt->timefinish == 0) {
 412                 print_string('unfinished');
 413             } else {
 414                 echo quiz_format_grade($quiz, $attempt->sumgrades) . '/' .
 415                         quiz_format_grade($quiz, $quiz->sumgrades);
 416             }
 417             echo ' - '.userdate($attempt->timemodified).'<br />';
 418         }
 419     } else {
 420         print_string('noattempts', 'quiz');
 421     }
 422
 423     return true;
 424 }
 425
 426 /**
 427  * Function to be run periodically according to the moodle cron
 428  * This function searches for things that need to be done, such
 429  * as sending out mail, toggling flags etc ...
 430  *
 431  * @return bool true
 432  */
 433 function quiz_cron() {
 434     return true;
 435 }
 436
 437 /**
 438  * @param int $quizid the quiz id.
 439  * @param int $userid the userid.
 440  * @param string $status 'all', 'finished' or 'unfinished' to control
 441  * @param bool $includepreviews
 442  * @return an array of all the user's attempts at this quiz. Returns an empty
 443  *      array if there are none.
 444  */
 445 function quiz_get_user_attempts($quizid, $userid, $status = 'finished', $includepreviews = false) {
 446     global $DB;
 447     $status_condition = array(
 448         'all' => '',
 449         'finished' => ' AND timefinish > 0',
 450         'unfinished' => ' AND timefinish = 0'
 451     );
 452     $previewclause = '';
 453     if (!$includepreviews) {
 454         $previewclause = ' AND preview = 0';
 455     }
 456     return $DB->get_records_select('quiz_attempts',
 457             'quiz = ? AND userid = ?' . $previewclause . $status_condition[$status],
 458             array($quizid, $userid), 'attempt ASC');
 459 }
 460
 461 /**
 462  * Return grade for given user or all users.
 463  *
 464  * @param int $quizid id of quiz
 465  * @param int $userid optional user id, 0 means all users
 466  * @return array array of grades, false if none. These are raw grades. They should
 467  * be processed with quiz_format_grade for display.
 468  */
 469 function quiz_get_user_grades($quiz, $userid = 0) {
 470     global $CFG, $DB;
 471
 472     $params = array($quiz->id);
 473     $usertest = '';
 474     if ($userid) {
 475         $params[] = $userid;
 476         $usertest = 'AND u.id = ?';
 477     }
 478     return $DB->get_records_sql("
 479             SELECT
 480                 u.id,
 481                 u.id AS userid,
 482                 qg.grade AS rawgrade,
 483                 qg.timemodified AS dategraded,
 484                 MAX(qa.timefinish) AS datesubmitted
 485
 486             FROM {user} u
 487             JOIN {quiz_grades} qg ON u.id = qg.userid
 488             JOIN {quiz_attempts} qa ON qa.quiz = qg.quiz AND qa.userid = u.id
 489
 490             WHERE qg.quiz = ?
 491             $usertest
 492             GROUP BY u.id, qg.grade, qg.timemodified", $params);
 493 }
 494
 495 /**
 496  * Round a grade to to the correct number of decimal places, and format it for display.
 497  *
 498  * @param object $quiz The quiz table row, only $quiz->decimalpoints is used.
 499  * @param float $grade The grade to round.
 500  * @return float
 501  */
 502 function quiz_format_grade($quiz, $grade) {
 503     if (is_null($grade)) {
 504         return get_string('notyetgraded', 'quiz');
 505     }
 506     return format_float($grade, $quiz->decimalpoints);
 507 }
 508
 509 /**
 510  * Round a grade to to the correct number of decimal places, and format it for display.
 511  *
 512  * @param object $quiz The quiz table row, only $quiz->decimalpoints is used.
 513  * @param float $grade The grade to round.
 514  * @return float
 515  */
 516 function quiz_format_question_grade($quiz, $grade) {
 517     if (empty($quiz->questiondecimalpoints)) {
 518         $quiz->questiondecimalpoints = -1;
 519     }
 520     if ($quiz->questiondecimalpoints == -1) {
 521         return format_float($grade, $quiz->decimalpoints);
 522     } else {
 523         return format_float($grade, $quiz->questiondecimalpoints);
 524     }
 525 }
 526
 527 /**
 528  * Update grades in central gradebook
 529  *
 530  * @param object $quiz the quiz settings.
 531  * @param int $userid specific user only, 0 means all users.
 532  */
 533 function quiz_update_grades($quiz, $userid = 0, $nullifnone = true) {
 534     global $CFG, $DB;
 535     require_once($CFG->libdir.'/gradelib.php');
 536
 537     if ($quiz->grade == 0) {
 538         quiz_grade_item_update($quiz);
 539
 540     } else if ($grades = quiz_get_user_grades($quiz, $userid)) {
 541         quiz_grade_item_update($quiz, $grades);
 542
 543     } else if ($userid && $nullifnone) {
 544         $grade = new stdClass();
 545         $grade->userid = $userid;
 546         $grade->rawgrade = null;
 547         quiz_grade_item_update($quiz, $grade);
 548
 549     } else {
 550         quiz_grade_item_update($quiz);
 551     }
 552 }
 553
 554 /**
 555  * Update all grades in gradebook.
 556  */
 557 function quiz_upgrade_grades() {
 558     global $DB;
 559
 560     $sql = "SELECT COUNT('x')
 561               FROM {quiz} a, {course_modules} cm, {modules} m
 562              WHERE m.name='quiz' AND m.id=cm.module AND cm.instance=a.id";
 563     $count = $DB->count_records_sql($sql);
 564
 565     $sql = "SELECT a.*, cm.idnumber AS cmidnumber, a.course AS courseid
 566               FROM {quiz} a, {course_modules} cm, {modules} m
 567              WHERE m.name='quiz' AND m.id=cm.module AND cm.instance=a.id";
 568     $rs = $DB->get_recordset_sql($sql);
 569     if ($rs->valid()) {
 570         $pbar = new progress_bar('quizupgradegrades', 500, true);
 571         $i=0;
 572         foreach ($rs as $quiz) {
 573             $i++;
 574             upgrade_set_timeout(60*5); // set up timeout, may also abort execution
 575             quiz_update_grades($quiz, 0, false);
 576             $pbar->update($i, $count, "Updating Quiz grades ($i/$count).");
 577         }
 578     }
 579     $rs->close();
 580 }
 581
 582 /**
 583  * Create grade item for given quiz
 584  *
 585  * @param object $quiz object with extra cmidnumber
 586  * @param mixed $grades optional array/object of grade(s); 'reset' means reset grades in gradebook
 587  * @return int 0 if ok, error code otherwise
 588  */
 589 function quiz_grade_item_update($quiz, $grades = null) {
 590     global $CFG, $OUTPUT;
 591     require_once($CFG->libdir.'/gradelib.php');
 592
 593     if (array_key_exists('cmidnumber', $quiz)) { // may not be always present
 594         $params = array('itemname' => $quiz->name, 'idnumber' => $quiz->cmidnumber);
 595     } else {
 596         $params = array('itemname' => $quiz->name);
 597     }
 598
 599     if ($quiz->grade > 0) {
 600         $params['gradetype'] = GRADE_TYPE_VALUE;
 601         $params['grademax']  = $quiz->grade;
 602         $params['grademin']  = 0;
 603
 604     } else {
 605         $params['gradetype'] = GRADE_TYPE_NONE;
 606     }
 607
 608     // description by TJ:
 609     // 1. If the quiz is set to not show grades while the quiz is still open,
 610     //    and is set to show grades after the quiz is closed, then create the
 611     //    grade_item with a show-after date that is the quiz close date.
 612     // 2. If the quiz is set to not show grades at either of those times,
 613     //    create the grade_item as hidden.
 614     // 3. If the quiz is set to show grades, create the grade_item visible.
 615     $openreviewoptions = mod_quiz_display_options::make_from_quiz($quiz,
 616             mod_quiz_display_options::LATER_WHILE_OPEN);
 617     $closedreviewoptions = mod_quiz_display_options::make_from_quiz($quiz,
 618             mod_quiz_display_options::AFTER_CLOSE);
 619     if ($openreviewoptions->marks < question_display_options::MARK_AND_MAX &&
 620             $closedreviewoptions->marks < question_display_options::MARK_AND_MAX) {
 621         $params['hidden'] = 1;
 622
 623     } else if ($openreviewoptions->marks < question_display_options::MARK_AND_MAX &&
 624             $closedreviewoptions->marks >= question_display_options::MARK_AND_MAX) {
 625         if ($quiz->timeclose) {
 626             $params['hidden'] = $quiz->timeclose;
 627         } else {
 628             $params['hidden'] = 1;
 629         }
 630
 631     } else {
 632         // a) both open and closed enabled
 633         // b) open enabled, closed disabled - we can not "hide after",
 634         //    grades are kept visible even after closing
 635         $params['hidden'] = 0;
 636     }
 637
 638     if ($grades  === 'reset') {
 639         $params['reset'] = true;
 640         $grades = null;
 641     }
 642
 643     $gradebook_grades = grade_get_grades($quiz->course, 'mod', 'quiz', $quiz->id);
 644     if (!empty($gradebook_grades->items)) {
 645         $grade_item = $gradebook_grades->items[0];
 646         if ($grade_item->locked) {
 647             $confirm_regrade = optional_param('confirm_regrade', 0, PARAM_INT);
 648             if (!$confirm_regrade) {
 649                 $message = get_string('gradeitemislocked', 'grades');
 650                 $back_link = $CFG->wwwroot . '/mod/quiz/report.php?q=' . $quiz->id .
 651                         '&amp;mode=overview';
 652                 $regrade_link = qualified_me() . '&amp;confirm_regrade=1';
 653                 echo $OUTPUT->box_start('generalbox', 'notice');
 654                 echo '<p>'. $message .'</p>';
 655                 echo $OUTPUT->container_start('buttons');
 656                 echo $OUTPUT->single_button($regrade_link, get_string('regradeanyway', 'grades'));
 657                 echo $OUTPUT->single_button($back_link,  get_string('cancel'));
 658                 echo $OUTPUT->container_end();
 659                 echo $OUTPUT->box_end();
 660
 661                 return GRADE_UPDATE_ITEM_LOCKED;
 662             }
 663         }
 664     }
 665
 666     return grade_update('mod/quiz', $quiz->course, 'mod', 'quiz', $quiz->id, 0, $grades, $params);
 667 }
 668
 669 /**
 670  * Delete grade item for given quiz
 671  *
 672  * @param object $quiz object
 673  * @return object quiz
 674  */
 675 function quiz_grade_item_delete($quiz) {
 676     global $CFG;
 677     require_once($CFG->libdir . '/gradelib.php');
 678
 679     return grade_update('mod/quiz', $quiz->course, 'mod', 'quiz', $quiz->id, 0,
 680             null, array('deleted' => 1));
 681 }
 682
 683 /**
 684  * Returns an array of users who have data in a given quiz
 685  *
 686  * @todo: deprecated - to be deleted in 2.2
 687  *
 688  * @param int $quizid the quiz id.
 689  * @return array of userids.
 690  */
 691 function quiz_get_participants($quizid) {
 692     global $CFG, $DB;
 693
 694     return $DB->get_records_sql('
 695             SELECT DISTINCT userid, userid
 696             JOIN {quiz_attempts} qa
 697             WHERE a.quiz = ?', array($quizid));
 698 }
 699
 700 /**
 701  * This standard function will check all instances of this module
 702  * and make sure there are up-to-date events created for each of them.
 703  * If courseid = 0, then every quiz event in the site is checked, else
 704  * only quiz events belonging to the course specified are checked.
 705  * This function is used, in its new format, by restore_refresh_events()
 706  *
 707  * @param int $courseid
 708  * @return bool
 709  */
 710 function quiz_refresh_events($courseid = 0) {
 711     global $DB;
 712
 713     if ($courseid == 0) {
 714         if (!$quizzes = $DB->get_records('quiz')) {
 715             return true;
 716         }
 717     } else {
 718         if (!$quizzes = $DB->get_records('quiz', array('course' => $courseid))) {
 719             return true;
 720         }
 721     }
 722
 723     foreach ($quizzes as $quiz) {
 724         quiz_update_events($quiz);
 725     }
 726
 727     return true;
 728 }
 729
 730 /**
 731  * Returns all quiz graded users since a given time for specified quiz
 732  */
 733 function quiz_get_recent_mod_activity(&$activities, &$index, $timestart,
 734         $courseid, $cmid, $userid = 0, $groupid = 0) {
 735     global $CFG, $COURSE, $USER, $DB;
 736     require_once('locallib.php');
 737
 738     if ($COURSE->id == $courseid) {
 739         $course = $COURSE;
 740     } else {
 741         $course = $DB->get_record('course', array('id' => $courseid));
 742     }
 743
 744     $modinfo =& get_fast_modinfo($course);
 745
 746     $cm = $modinfo->cms[$cmid];
 747     $quiz = $DB->get_record('quiz', array('id' => $cm->instance));
 748
 749     if ($userid) {
 750         $userselect = "AND u.id = :userid";
 751         $params['userid'] = $userid;
 752     } else {
 753         $userselect = '';
 754     }
 755
 756     if ($groupid) {
 757         $groupselect = 'AND gm.groupid = :groupid';
 758         $groupjoin   = 'JOIN {groups_members} gm ON  gm.userid=u.id';
 759         $params['groupid'] = $groupid;
 760     } else {
 761         $groupselect = '';
 762         $groupjoin   = '';
 763     }
 764
 765     $params['timestart'] = $timestart;
 766     $params['quizid'] = $quiz->id;
 767
 768     if (!$attempts = $DB->get_records_sql("
 769               SELECT qa.*,
 770                      u.firstname, u.lastname, u.email, u.picture, u.imagealt
 771                 FROM {quiz_attempts} qa
 772                      JOIN {user} u ON u.id = qa.userid
 773                      $groupjoin
 774                WHERE qa.timefinish > :timestart
 775                  AND qa.quiz = :quizid
 776                  AND qa.preview = 0
 777                      $userselect
 778                      $groupselect
 779             ORDER BY qa.timefinish ASC", $params)) {
 780         return;
 781     }
 782
 783     $context         = get_context_instance(CONTEXT_MODULE, $cm->id);
 784     $accessallgroups = has_capability('moodle/site:accessallgroups', $context);
 785     $viewfullnames   = has_capability('moodle/site:viewfullnames', $context);
 786     $grader          = has_capability('mod/quiz:viewreports', $context);
 787     $groupmode       = groups_get_activity_groupmode($cm, $course);
 788
 789     if (is_null($modinfo->groups)) {
 790         // load all my groups and cache it in modinfo
 791         $modinfo->groups = groups_get_user_groups($course->id);
 792     }
 793
 794     $usersgroups = null;
 795     $aname = format_string($cm->name, true);
 796     foreach ($attempts as $attempt) {
 797         if ($attempt->userid != $USER->id) {
 798             if (!$grader) {
 799                 // Grade permission required
 800                 continue;
 801             }
 802
 803             if ($groupmode == SEPARATEGROUPS and !$accessallgroups) {
 804                 if (is_null($usersgroups)) {
 805                     $usersgroups = groups_get_all_groups($course->id,
 806                             $attempt->userid, $cm->groupingid);
 807                     if (is_array($usersgroups)) {
 808                         $usersgroups = array_keys($usersgroups);
 809                     } else {
 810                         $usersgroups = array();
 811                     }
 812                 }
 813                 if (!array_intersect($usersgroups, $modinfo->groups[$cm->id])) {
 814                     continue;
 815                 }
 816             }
 817         }
 818
 819         $options = quiz_get_review_options($quiz, $attempt, $context);
 820
 821         $tmpactivity = new stdClass();
 822
 823         $tmpactivity->type       = 'quiz';
 824         $tmpactivity->cmid       = $cm->id;
 825         $tmpactivity->name       = $aname;
 826         $tmpactivity->sectionnum = $cm->sectionnum;
 827         $tmpactivity->timestamp  = $attempt->timefinish;
 828
 829         $tmpactivity->content->attemptid = $attempt->id;
 830         $tmpactivity->content->attempt   = $attempt->attempt;
 831         if (quiz_has_grades($quiz) && $options->marks >= question_display_options::MARK_AND_MAX) {
 832             $tmpactivity->content->sumgrades = quiz_format_grade($quiz, $attempt->sumgrades);
 833             $tmpactivity->content->maxgrade  = quiz_format_grade($quiz, $quiz->sumgrades);
 834         } else {
 835             $tmpactivity->content->sumgrades = null;
 836             $tmpactivity->content->maxgrade  = null;
 837         }
 838
 839         $tmpactivity->user->id        = $attempt->userid;
 840         $tmpactivity->user->firstname = $attempt->firstname;
 841         $tmpactivity->user->lastname  = $attempt->lastname;
 842         $tmpactivity->user->fullname  = fullname($attempt, $viewfullnames);
 843         $tmpactivity->user->picture   = $attempt->picture;
 844         $tmpactivity->user->imagealt  = $attempt->imagealt;
 845         $tmpactivity->user->email     = $attempt->email;
 846
 847         $activities[$index++] = $tmpactivity;
 848     }
 849 }
 850
 851 function quiz_print_recent_mod_activity($activity, $courseid, $detail, $modnames) {
 852     global $CFG, $OUTPUT;
 853
 854     echo '<table border="0" cellpadding="3" cellspacing="0" class="forum-recent">';
 855
 856     echo '<tr><td class="userpicture" valign="top">';
 857     echo $OUTPUT->user_picture($activity->user, array('courseid' => $courseid));
 858     echo '</td><td>';
 859
 860     if ($detail) {
 861         $modname = $modnames[$activity->type];
 862         echo '<div class="title">';
 863         echo '<img src="' . $OUTPUT->pix_url('icon', $activity->type) . '" ' .
 864                 'class="icon" alt="' . $modname . '" />';
 865         echo '<a href="' . $CFG->wwwroot . '/mod/quiz/view.php?id=' .
 866                 $activity->cmid . '">' . $activity->name . '</a>';
 867         echo '</div>';
 868     }
 869
 870     echo '<div class="grade">';
 871     echo  get_string('attempt', 'quiz', $activity->content->attempt);
 872     if (isset($activity->content->maxgrade)) {
 873         $grades = $activity->content->sumgrades . ' / ' . $activity->content->maxgrade;
 874         echo ': (<a href="' . $CFG->wwwroot . '/mod/quiz/review.php?attempt=' .
 875                 $activity->content->attemptid . '">' . $grades . '</a>)';
 876     }
 877     echo '</div>';
 878
 879     echo '<div class="user">';
 880     echo '<a href="' . $CFG->wwwroot . '/user/view.php?id=' . $activity->user->id .
 881             '&amp;course=' . $courseid . '">' . $activity->user->fullname .
 882             '</a> - ' . userdate($activity->timestamp);
 883     echo '</div>';
 884
 885     echo '</td></tr></table>';
 886
 887     return;
 888 }
 889
 890 /**
 891  * Pre-process the quiz options form data, making any necessary adjustments.
 892  * Called by add/update instance in this file.
 893  *
 894  * @param object $quiz The variables set on the form.
 895  */
 896 function quiz_process_options($quiz) {
 897     global $CFG;
 898     require_once($CFG->dirroot . '/mod/quiz/locallib.php');
 899     require_once($CFG->libdir . '/questionlib.php');
 900
 901     $quiz->timemodified = time();
 902
 903     // Quiz name.
 904     if (!empty($quiz->name)) {
 905         $quiz->name = trim($quiz->name);
 906     }
 907
 908     // Password field - different in form to stop browsers that remember passwords
 909     // getting confused.
 910     $quiz->password = $quiz->quizpassword;
 911     unset($quiz->quizpassword);
 912
 913     // Quiz feedback
 914     if (isset($quiz->feedbacktext)) {
 915         // Clean up the boundary text.
 916         for ($i = 0; $i < count($quiz->feedbacktext); $i += 1) {
 917             if (empty($quiz->feedbacktext[$i]['text'])) {
 918                 $quiz->feedbacktext[$i]['text'] = '';
 919             } else {
 920                 $quiz->feedbacktext[$i]['text'] = trim($quiz->feedbacktext[$i]['text']);
 921             }
 922         }
 923
 924         // Check the boundary value is a number or a percentage, and in range.
 925         $i = 0;
 926         while (!empty($quiz->feedbackboundaries[$i])) {
 927             $boundary = trim($quiz->feedbackboundaries[$i]);
 928             if (!is_numeric($boundary)) {
 929                 if (strlen($boundary) > 0 && $boundary[strlen($boundary) - 1] == '%') {
 930                     $boundary = trim(substr($boundary, 0, -1));
 931                     if (is_numeric($boundary)) {
 932                         $boundary = $boundary * $quiz->grade / 100.0;
 933                     } else {
 934                         return get_string('feedbackerrorboundaryformat', 'quiz', $i + 1);
 935                     }
 936                 }
 937             }
 938             if ($boundary <= 0 || $boundary >= $quiz->grade) {
 939                 return get_string('feedbackerrorboundaryoutofrange', 'quiz', $i + 1);
 940             }
 941             if ($i > 0 && $boundary >= $quiz->feedbackboundaries[$i - 1]) {
 942                 return get_string('feedbackerrororder', 'quiz', $i + 1);
 943             }
 944             $quiz->feedbackboundaries[$i] = $boundary;
 945             $i += 1;
 946         }
 947         $numboundaries = $i;
 948
 949         // Check there is nothing in the remaining unused fields.
 950         if (!empty($quiz->feedbackboundaries)) {
 951             for ($i = $numboundaries; $i < count($quiz->feedbackboundaries); $i += 1) {
 952                 if (!empty($quiz->feedbackboundaries[$i]) &&
 953                         trim($quiz->feedbackboundaries[$i]) != '') {
 954                     return get_string('feedbackerrorjunkinboundary', 'quiz', $i + 1);
 955                 }
 956             }
 957         }
 958         for ($i = $numboundaries + 1; $i < count($quiz->feedbacktext); $i += 1) {
 959             if (!empty($quiz->feedbacktext[$i]['text']) &&
 960                     trim($quiz->feedbacktext[$i]['text']) != '') {
 961                 return get_string('feedbackerrorjunkinfeedback', 'quiz', $i + 1);
 962             }
 963         }
 964         // Needs to be bigger than $quiz->grade because of '<' test in quiz_feedback_for_grade().
 965         $quiz->feedbackboundaries[-1] = $quiz->grade + 1;
 966         $quiz->feedbackboundaries[$numboundaries] = 0;
 967         $quiz->feedbackboundarycount = $numboundaries;
 968     }
 969
 970     // Combing the individual settings into the review columns.
 971     $quiz->reviewattempt = quiz_review_option_form_to_db($quiz, 'attempt');
 972     $quiz->reviewcorrectness = quiz_review_option_form_to_db($quiz, 'correctness');
 973     $quiz->reviewmarks = quiz_review_option_form_to_db($quiz, 'marks');
 974     $quiz->reviewspecificfeedback = quiz_review_option_form_to_db($quiz, 'specificfeedback');
 975     $quiz->reviewgeneralfeedback = quiz_review_option_form_to_db($quiz, 'generalfeedback');
 976     $quiz->reviewrightanswer = quiz_review_option_form_to_db($quiz, 'rightanswer');
 977     $quiz->reviewoverallfeedback = quiz_review_option_form_to_db($quiz, 'overallfeedback');
 978     $quiz->reviewattempt |= mod_quiz_display_options::DURING;
 979     $quiz->reviewoverallfeedback &= ~mod_quiz_display_options::DURING;
 980 }
 981
 982 /**
 983  * Helper function for {@link quiz_process_options()}.
 984  * @param object $fromform the sumbitted form date.
 985  * @param string $field one of the review option field names.
 986  */
 987 function quiz_review_option_form_to_db($fromform, $field) {
 988     static $times = array(
 989         'during' => mod_quiz_display_options::DURING,
 990         'immediately' => mod_quiz_display_options::IMMEDIATELY_AFTER,
 991         'open' => mod_quiz_display_options::LATER_WHILE_OPEN,
 992         'closed' => mod_quiz_display_options::AFTER_CLOSE,
 993     );
 994
 995     $review = 0;
 996     foreach ($times as $whenname => $when) {
 997         $fieldname = $field . $whenname;
 998         if (isset($fromform->$fieldname)) {
 999             $review |= $when;
1000             unset($fromform->$fieldname);
1001         }
1002     }
1003
1004     return $review;
1005 }
1006
1007 /**
1008  * This function is called at the end of quiz_add_instance
1009  * and quiz_update_instance, to do the common processing.
1010  *
1011  * @param object $quiz the quiz object.
1012  */
1013 function quiz_after_add_or_update($quiz) {
1014     global $DB;
1015     $cmid = $quiz->coursemodule;
1016
1017     // we need to use context now, so we need to make sure all needed info is already in db
1018     $DB->set_field('course_modules', 'instance', $quiz->id, array('id'=>$cmid));
1019     $context = get_context_instance(CONTEXT_MODULE, $cmid);
1020
1021     // Save the feedback
1022     $DB->delete_records('quiz_feedback', array('quizid' => $quiz->id));
1023
1024     for ($i = 0; $i <= $quiz->feedbackboundarycount; $i++) {
1025         $feedback = new stdClass();
1026         $feedback->quizid = $quiz->id;
1027         $feedback->feedbacktext = $quiz->feedbacktext[$i]['text'];
1028         $feedback->feedbacktextformat = $quiz->feedbacktext[$i]['format'];
1029         $feedback->mingrade = $quiz->feedbackboundaries[$i];
1030         $feedback->maxgrade = $quiz->feedbackboundaries[$i - 1];
1031         $feedback->id = $DB->insert_record('quiz_feedback', $feedback);
1032         $feedbacktext = file_save_draft_area_files((int)$quiz->feedbacktext[$i]['itemid'],
1033                 $context->id, 'mod_quiz', 'feedback', $feedback->id,
1034                 array('subdirs' => false, 'maxfiles' => -1, 'maxbytes' => 0),
1035                 $quiz->feedbacktext[$i]['text']);
1036         $DB->set_field('quiz_feedback', 'feedbacktext', $feedbacktext,
1037                 array('id' => $feedback->id));
1038     }
1039
1040     // Update the events relating to this quiz.
1041     quiz_update_events($quiz);
1042
1043     //update related grade item
1044     quiz_grade_item_update($quiz);
1045 }
1046
1047 /**
1048  * This function updates the events associated to the quiz.
1049  * If $override is non-zero, then it updates only the events
1050  * associated with the specified override.
1051  *
1052  * @uses QUIZ_MAX_EVENT_LENGTH
1053  * @param object $quiz the quiz object.
1054  * @param object optional $override limit to a specific override
1055  */
1056 function quiz_update_events($quiz, $override = null) {
1057     global $DB;
1058
1059     // Load the old events relating to this quiz.
1060     $conds = array('modulename'=>'quiz',
1061                    'instance'=>$quiz->id);
1062     if (!empty($override)) {
1063         // only load events for this override
1064         $conds['groupid'] = isset($override->groupid)?  $override->groupid : 0;
1065         $conds['userid'] = isset($override->userid)?  $override->userid : 0;
1066     }
1067     $oldevents = $DB->get_records('event', $conds);
1068
1069     // Now make a todo list of all that needs to be updated
1070     if (empty($override)) {
1071         // We are updating the primary settings for the quiz, so we
1072         // need to add all the overrides
1073         $overrides = $DB->get_records('quiz_overrides', array('quiz' => $quiz->id));
1074         // as well as the original quiz (empty override)
1075         $overrides[] = new stdClass();
1076     } else {
1077         // Just do the one override
1078         $overrides = array($override);
1079     }
1080
1081     foreach ($overrides as $current) {
1082         $groupid   = isset($current->groupid)?  $current->groupid : 0;
1083         $userid    = isset($current->userid)? $current->userid : 0;
1084         $timeopen  = isset($current->timeopen)?  $current->timeopen : $quiz->timeopen;
1085         $timeclose = isset($current->timeclose)? $current->timeclose : $quiz->timeclose;
1086
1087         // only add open/close events for an override if they differ from the quiz default
1088         $addopen  = empty($current->id) || !empty($current->timeopen);
1089         $addclose = empty($current->id) || !empty($current->timeclose);
1090
1091         $event = new stdClass();
1092         $event->description = $quiz->intro;
1093         // Events module won't show user events when the courseid is nonzero
1094         $event->courseid    = ($userid) ? 0 : $quiz->course;
1095         $event->groupid     = $groupid;
1096         $event->userid      = $userid;
1097         $event->modulename  = 'quiz';
1098         $event->instance    = $quiz->id;
1099         $event->timestart   = $timeopen;
1100         $event->timeduration = max($timeclose - $timeopen, 0);
1101         $event->visible     = instance_is_visible('quiz', $quiz);
1102         $event->eventtype   = 'open';
1103
1104         // Determine the event name
1105         if ($groupid) {
1106             $params = new stdClass();
1107             $params->quiz = $quiz->name;
1108             $params->group = groups_get_group_name($groupid);
1109             if ($params->group === false) {
1110                 // group doesn't exist, just skip it
1111                 continue;
1112             }
1113             $eventname = get_string('overridegroupeventname', 'quiz', $params);
1114         } else if ($userid) {
1115             $params = new stdClass();
1116             $params->quiz = $quiz->name;
1117             $eventname = get_string('overrideusereventname', 'quiz', $params);
1118         } else {
1119             $eventname = $quiz->name;
1120         }
1121         if ($addopen or $addclose) {
1122             if ($timeclose and $timeopen and $event->timeduration <= QUIZ_MAX_EVENT_LENGTH) {
1123                 // Single event for the whole quiz.
1124                 if ($oldevent = array_shift($oldevents)) {
1125                     $event->id = $oldevent->id;
1126                 } else {
1127                     unset($event->id);
1128                 }
1129                 $event->name = $eventname;
1130                 // calendar_event::create will reuse a db record if the id field is set
1131                 calendar_event::create($event);
1132             } else {
1133                 // Separate start and end events.
1134                 $event->timeduration  = 0;
1135                 if ($timeopen && $addopen) {
1136                     if ($oldevent = array_shift($oldevents)) {
1137                         $event->id = $oldevent->id;
1138                     } else {
1139                         unset($event->id);
1140                     }
1141                     $event->name = $eventname.' ('.get_string('quizopens', 'quiz').')';
1142                     // calendar_event::create will reuse a db record if the id field is set
1143                     calendar_event::create($event);
1144                 }
1145                 if ($timeclose && $addclose) {
1146                     if ($oldevent = array_shift($oldevents)) {
1147                         $event->id = $oldevent->id;
1148                     } else {
1149                         unset($event->id);
1150                     }
1151                     $event->name      = $eventname.' ('.get_string('quizcloses', 'quiz').')';
1152                     $event->timestart = $timeclose;
1153                     $event->eventtype = 'close';
1154                     calendar_event::create($event);
1155                 }
1156             }
1157         }
1158     }
1159
1160     // Delete any leftover events
1161     foreach ($oldevents as $badevent) {
1162         $badevent = calendar_event::load($badevent);
1163         $badevent->delete();
1164     }
1165 }
1166
1167 /**
1168  * @return array
1169  */
1170 function quiz_get_view_actions() {
1171     return array('view', 'view all', 'report', 'review');
1172 }
1173
1174 /**
1175  * @return array
1176  */
1177 function quiz_get_post_actions() {
1178     return array('attempt', 'close attempt', 'preview', 'editquestions',
1179             'delete attempt', 'manualgrade');
1180 }
1181
1182 /**
1183  * @param array $questionids of question ids.
1184  * @return bool whether any of these questions are used by any instance of this module.
1185  */
1186 function quiz_questions_in_use($questionids) {
1187     global $DB, $CFG;
1188     require_once($CFG->libdir . '/questionlib.php');
1189     list($test, $params) = $DB->get_in_or_equal($questionids);
1190     return $DB->record_exists_select('quiz_question_instances',
1191             'question ' . $test, $params) || question_engine::questions_in_use(
1192             $questionids, new qubaid_join('{quiz_attempts} quiza',
1193             'quiza.uniqueid', 'quiza.preview = 0'));
1194 }
1195
1196 /**
1197  * Implementation of the function for printing the form elements that control
1198  * whether the course reset functionality affects the quiz.
1199  *
1200  * @param $mform the course reset form that is being built.
1201  */
1202 function quiz_reset_course_form_definition($mform) {
1203     $mform->addElement('header', 'quizheader', get_string('modulenameplural', 'quiz'));
1204     $mform->addElement('advcheckbox', 'reset_quiz_attempts',
1205             get_string('removeallquizattempts', 'quiz'));
1206 }
1207
1208 /**
1209  * Course reset form defaults.
1210  * @return array the defaults.
1211  */
1212 function quiz_reset_course_form_defaults($course) {
1213     return array('reset_quiz_attempts' => 1);
1214 }
1215
1216 /**
1217  * Removes all grades from gradebook
1218  *
1219  * @param int $courseid
1220  * @param string optional type
1221  */
1222 function quiz_reset_gradebook($courseid, $type='') {
1223     global $CFG, $DB;
1224
1225     $quizzes = $DB->get_records_sql("
1226             SELECT q.*, cm.idnumber as cmidnumber, q.course as courseid
1227             FROM {modules} m
1228             JOIN {course_modules} cm ON m.id = cm.module
1229             JOIN {quiz} q ON cm.instance = q.id
1230             WHERE m.name = 'quiz' AND cm.course = ?", array($courseid));
1231
1232     foreach ($quizzes as $quiz) {
1233         quiz_grade_item_update($quiz, 'reset');
1234     }
1235 }
1236
1237 /**
1238  * Actual implementation of the reset course functionality, delete all the
1239  * quiz attempts for course $data->courseid, if $data->reset_quiz_attempts is
1240  * set and true.
1241  *
1242  * Also, move the quiz open and close dates, if the course start date is changing.
1243  *
1244  * @param object $data the data submitted from the reset course.
1245  * @return array status array
1246  */
1247 function quiz_reset_userdata($data) {
1248     global $CFG, $DB;
1249     require_once($CFG->libdir.'/questionlib.php');
1250
1251     $componentstr = get_string('modulenameplural', 'quiz');
1252     $status = array();
1253
1254     // Delete attempts.
1255     if (!empty($data->reset_quiz_attempts)) {
1256         require_once($CFG->libdir . '/questionlib.php');
1257
1258         question_engine::delete_questions_usage_by_activities(new qubaid_join(
1259                 '{quiz_attempts} quiza JOIN {quiz} quiz ON quiza.quiz = quiz.id',
1260                 'quiza.uniqueid', 'quiz.course = :quizcourseid',
1261                 array('quizcourseid' => $data->courseid)));
1262
1263         $DB->delete_records_select('quiz_attempts',
1264                 'quiz IN (SELECT id FROM {quiz} WHERE course = ?)', array($data->courseid));
1265         $status[] = array(
1266             'component' => $componentstr,
1267             'item' => get_string('attemptsdeleted', 'quiz'),
1268             'error' => false);
1269
1270         // Remove all grades from gradebook
1271         if (empty($data->reset_gradebook_grades)) {
1272             quiz_reset_gradebook($data->courseid);
1273         }
1274         $status[] = array(
1275             'component' => $componentstr,
1276             'item' => get_string('attemptsdeleted', 'quiz'),
1277             'error' => false);
1278     }
1279
1280     // Updating dates - shift may be negative too
1281     if ($data->timeshift) {
1282         shift_course_mod_dates('quiz', array('timeopen', 'timeclose'),
1283                 $data->timeshift, $data->courseid);
1284         $status[] = array(
1285             'component' => $componentstr,
1286             'item' => get_string('openclosedatesupdated', 'quiz'),
1287             'error' => false);
1288     }
1289
1290     return $status;
1291 }
1292
1293 /**
1294  * Checks whether the current user is allowed to view a file uploaded in a quiz.
1295  * Teachers can view any from their courses, students can only view their own.
1296  *
1297  * @param int $attemptuniqueid int attempt id
1298  * @param int $questionid int question id
1299  * @return bool to indicate access granted or denied
1300  */
1301 function quiz_check_file_access($attemptuniqueid, $questionid, $context = null) {
1302     global $USER, $DB, $CFG;
1303     require_once(dirname(__FILE__).'/attemptlib.php');
1304     require_once(dirname(__FILE__).'/locallib.php');
1305
1306     $attempt = $DB->get_record('quiz_attempts', array('uniqueid' => $attemptuniqueid));
1307     $attemptobj = quiz_attempt::create($attempt->id);
1308
1309     // does question exist?
1310     if (!$question = $DB->get_record('question', array('id' => $questionid))) {
1311         return false;
1312     }
1313
1314     if ($context === null) {
1315         $quiz = $DB->get_record('quiz', array('id' => $attempt->quiz));
1316         $cm = get_coursemodule_from_id('quiz', $quiz->id);
1317         $context = get_context_instance(CONTEXT_MODULE, $cm->id);
1318     }
1319
1320     // Load those questions and the associated states.
1321     $attemptobj->load_questions(array($questionid));
1322     $attemptobj->load_question_states(array($questionid));
1323
1324     // obtain state
1325     $state = $attemptobj->get_question_state($questionid);
1326     // obtain questoin
1327     $question = $attemptobj->get_question($questionid);
1328
1329     // access granted if the current user submitted this file
1330     if ($attempt->userid != $USER->id) {
1331         return false;
1332     }
1333     // access granted if the current user has permission to grade quizzes in this course
1334     if (!(has_capability('mod/quiz:viewreports', $context) ||
1335             has_capability('mod/quiz:grade', $context))) {
1336         return false;
1337     }
1338
1339     return array($question, $state, array());
1340 }
1341
1342 /**
1343  * Prints quiz summaries on MyMoodle Page
1344  * @param arry $courses
1345  * @param array $htmlarray
1346  */
1347 function quiz_print_overview($courses, &$htmlarray) {
1348     global $USER, $CFG;
1349     // These next 6 Lines are constant in all modules (just change module name)
1350     if (empty($courses) || !is_array($courses) || count($courses) == 0) {
1351         return array();
1352     }
1353
1354     if (!$quizzes = get_all_instances_in_courses('quiz', $courses)) {
1355         return;
1356     }
1357
1358     // Fetch some language strings outside the main loop.
1359     $strquiz = get_string('modulename', 'quiz');
1360     $strnoattempts = get_string('noattempts', 'quiz');
1361
1362     // We want to list quizzes that are currently available, and which have a close date.
1363     // This is the same as what the lesson does, and the dabate is in MDL-10568.
1364     $now = time();
1365     foreach ($quizzes as $quiz) {
1366         if ($quiz->timeclose >= $now && $quiz->timeopen < $now) {
1367             // Give a link to the quiz, and the deadline.
1368             $str = '<div class="quiz overview">' .
1369                     '<div class="name">' . $strquiz . ': <a ' .
1370                     ($quiz->visible ? '' : ' class="dimmed"') .
1371                     ' href="' . $CFG->wwwroot . '/mod/quiz/view.php?id=' .
1372                     $quiz->coursemodule . '">' .
1373                     $quiz->name . '</a></div>';
1374             $str .= '<div class="info">' . get_string('quizcloseson', 'quiz',
1375                     userdate($quiz->timeclose)) . '</div>';
1376
1377             // Now provide more information depending on the uers's role.
1378             $context = get_context_instance(CONTEXT_MODULE, $quiz->coursemodule);
1379             if (has_capability('mod/quiz:viewreports', $context)) {
1380                 // For teacher-like people, show a summary of the number of student attempts.
1381                 // The $quiz objects returned by get_all_instances_in_course have the necessary $cm
1382                 // fields set to make the following call work.
1383                 $str .= '<div class="info">' .
1384                         quiz_num_attempt_summary($quiz, $quiz, true) . '</div>';
1385             } else if (has_any_capability(array('mod/quiz:reviewmyattempts', 'mod/quiz:attempt'),
1386                     $context)) { // Student
1387                 // For student-like people, tell them how many attempts they have made.
1388                 if (isset($USER->id) &&
1389                         ($attempts = quiz_get_user_attempts($quiz->id, $USER->id))) {
1390                     $numattempts = count($attempts);
1391                     $str .= '<div class="info">' .
1392                             get_string('numattemptsmade', 'quiz', $numattempts) . '</div>';
1393                 } else {
1394                     $str .= '<div class="info">' . $strnoattempts . '</div>';
1395                 }
1396             } else {
1397                 // For ayone else, there is no point listing this quiz, so stop processing.
1398                 continue;
1399             }
1400
1401             // Add the output for this quiz to the rest.
1402             $str .= '</div>';
1403             if (empty($htmlarray[$quiz->course]['quiz'])) {
1404                 $htmlarray[$quiz->course]['quiz'] = $str;
1405             } else {
1406                 $htmlarray[$quiz->course]['quiz'] .= $str;
1407             }
1408         }
1409     }
1410 }
1411
1412 /**
1413  * Return a textual summary of the number of attempts that have been made at a particular quiz,
1414  * returns '' if no attempts have been made yet, unless $returnzero is passed as true.
1415  *
1416  * @param object $quiz the quiz object. Only $quiz->id is used at the moment.
1417  * @param object $cm the cm object. Only $cm->course, $cm->groupmode and
1418  *      $cm->groupingid fields are used at the moment.
1419  * @param bool $returnzero if false (default), when no attempts have been
1420  *      made '' is returned instead of 'Attempts: 0'.
1421  * @param int $currentgroup if there is a concept of current group where this method is being called
1422  *         (e.g. a report) pass it in here. Default 0 which means no current group.
1423  * @return string a string like "Attempts: 123", "Attemtps 123 (45 from your groups)" or
1424  *          "Attemtps 123 (45 from this group)".
1425  */
1426 function quiz_num_attempt_summary($quiz, $cm, $returnzero = false, $currentgroup = 0) {
1427     global $DB, $USER;
1428     $numattempts = $DB->count_records('quiz_attempts', array('quiz'=> $quiz->id, 'preview'=>0));
1429     if ($numattempts || $returnzero) {
1430         if (groups_get_activity_groupmode($cm)) {
1431             $a->total = $numattempts;
1432             if ($currentgroup) {
1433                 $a->group = $DB->count_records_sql('SELECT count(1) FROM ' .
1434                         '{quiz_attempts} qa JOIN ' .
1435                         '{groups_members} gm ON qa.userid = gm.userid ' .
1436                         'WHERE quiz = ? AND preview = 0 AND groupid = ?',
1437                         array($quiz->id, $currentgroup));
1438                 return get_string('attemptsnumthisgroup', 'quiz', $a);
1439             } else if ($groups = groups_get_all_groups($cm->course, $USER->id, $cm->groupingid)) {
1440                 list($usql, $params) = $DB->get_in_or_equal(array_keys($groups));
1441                 $a->group = $DB->count_records_sql('SELECT count(1) FROM ' .
1442                         '{quiz_attempts} qa JOIN ' .
1443                         '{groups_members} gm ON qa.userid = gm.userid ' .
1444                         'WHERE quiz = ? AND preview = 0 AND ' .
1445                         "groupid $usql", array_merge(array($quiz->id), $params));
1446                 return get_string('attemptsnumyourgroups', 'quiz', $a);
1447             }
1448         }
1449         return get_string('attemptsnum', 'quiz', $numattempts);
1450     }
1451     return '';
1452 }
1453
1454 /**
1455  * Returns the same as {@link quiz_num_attempt_summary()} but wrapped in a link
1456  * to the quiz reports.
1457  *
1458  * @param object $quiz the quiz object. Only $quiz->id is used at the moment.
1459  * @param object $cm the cm object. Only $cm->course, $cm->groupmode and
1460  *      $cm->groupingid fields are used at the moment.
1461  * @param object $context the quiz context.
1462  * @param bool $returnzero if false (default), when no attempts have been made
1463  *      '' is returned instead of 'Attempts: 0'.
1464  * @param int $currentgroup if there is a concept of current group where this method is being called
1465  *         (e.g. a report) pass it in here. Default 0 which means no current group.
1466  * @return string HTML fragment for the link.
1467  */
1468 function quiz_attempt_summary_link_to_reports($quiz, $cm, $context, $returnzero = false,
1469         $currentgroup = 0) {
1470     global $CFG;
1471     $summary = quiz_num_attempt_summary($quiz, $cm, $returnzero, $currentgroup);
1472     if (!$summary) {
1473         return '';
1474     }
1475
1476     require_once($CFG->dirroot . '/mod/quiz/report/reportlib.php');
1477     $url = new moodle_url('/mod/quiz/report.php', array(
1478             'id' => $cm->id, 'mode' => quiz_report_default_report($context)));
1479     return html_writer::link($url, $summary);
1480 }
1481
1482 /**
1483  * @param string $feature FEATURE_xx constant for requested feature
1484  * @return bool True if quiz supports feature
1485  */
1486 function quiz_supports($feature) {
1487     switch($feature) {
1488         case FEATURE_GROUPS:                  return true;
1489         case FEATURE_GROUPINGS:               return true;
1490         case FEATURE_GROUPMEMBERSONLY:        return true;
1491         case FEATURE_MOD_INTRO:               return true;
1492         case FEATURE_COMPLETION_TRACKS_VIEWS: return true;
1493         case FEATURE_GRADE_HAS_GRADE:         return true;
1494         case FEATURE_GRADE_OUTCOMES:          return true;
1495         case FEATURE_BACKUP_MOODLE2:          return true;
1496
1497         default: return null;
1498     }
1499 }
1500
1501 /**
1502  * @return array all other caps used in module
1503  */
1504 function quiz_get_extra_capabilities() {
1505     global $CFG;
1506     require_once($CFG->libdir.'/questionlib.php');
1507     $caps = question_get_all_capabilities();
1508     $caps[] = 'moodle/site:accessallgroups';
1509     return $caps;
1510 }
1511
1512 /**
1513  * This fucntion extends the global navigation for the site.
1514  * It is important to note that you should not rely on PAGE objects within this
1515  * body of code as there is no guarantee that during an AJAX request they are
1516  * available
1517  *
1518  * @param navigation_node $quiznode The quiz node within the global navigation
1519  * @param object $course The course object returned from the DB
1520  * @param object $module The module object returned from the DB
1521  * @param object $cm The course module instance returned from the DB
1522  */
1523 function quiz_extend_navigation($quiznode, $course, $module, $cm) {
1524     global $CFG;
1525
1526     $context = get_context_instance(CONTEXT_MODULE, $cm->id);
1527
1528     if (has_capability('mod/quiz:view', $context)) {
1529         $url = new moodle_url('/mod/quiz/view.php', array('id'=>$cm->id));
1530         $quiznode->add(get_string('info', 'quiz'), $url, navigation_node::TYPE_SETTING,
1531                 null, null, new pix_icon('i/info', ''));
1532     }
1533
1534     if (has_any_capability(array('mod/quiz:viewreports', 'mod/quiz:grade'), $context)) {
1535         require_once($CFG->dirroot.'/mod/quiz/report/reportlib.php');
1536         $reportlist = quiz_report_list($context);
1537
1538         $url = new moodle_url('/mod/quiz/report.php',
1539                 array('id' => $cm->id, 'mode' => reset($reportlist)));
1540         $reportnode = $quiznode->add(get_string('results', 'quiz'), $url,
1541                 navigation_node::TYPE_SETTING,
1542                 null, null, new pix_icon('i/report', ''));
1543
1544         foreach ($reportlist as $report) {
1545             $url = new moodle_url('/mod/quiz/report.php',
1546                     array('id' => $cm->id, 'mode' => $report));
1547             $reportnode->add(get_string($report, 'quiz_'.$report), $url,
1548                     navigation_node::TYPE_SETTING,
1549                     null, 'quiz_report_' . $report, new pix_icon('i/item', ''));
1550         }
1551     }
1552 }
1553
1554 /**
1555  * This function extends the settings navigation block for the site.
1556  *
1557  * It is safe to rely on PAGE here as we will only ever be within the module
1558  * context when this is called
1559  *
1560  * @param settings_navigation $settings
1561  * @param navigation_node $quiznode
1562  */
1563 function quiz_extend_settings_navigation($settings, $quiznode) {
1564     global $PAGE, $CFG;
1565
1566     /**
1567      * Require {@link questionlib.php}
1568      * Included here as we only ever want to include this file if we really need to.
1569      */
1570     require_once($CFG->libdir . '/questionlib.php');
1571
1572     // We want to add these new nodes after the Edit settings node, and before the
1573     // Locally assigned roles node. Of course, both of those are controlled by capabilities.
1574     $keys = $quiznode->get_children_key_list();
1575     $beforekey = null;
1576     $i = array_search('modedit', $keys);
1577     if ($i === false and array_key_exists(0, $keys)) {
1578         $beforekey = $keys[0];
1579     } else if (array_key_exists($i + 1, $keys)) {
1580         $beforekey = $keys[$i + 1];
1581     }
1582
1583     if (has_capability('mod/quiz:manageoverrides', $PAGE->cm->context)) {
1584         $url = new moodle_url('/mod/quiz/overrides.php', array('cmid'=>$PAGE->cm->id));
1585         $node = navigation_node::create(get_string('groupoverrides', 'quiz'),
1586                 new moodle_url($url, array('mode'=>'group')),
1587                 navigation_node::TYPE_SETTING, null, 'mod_quiz_groupoverrides');
1588         $quiznode->add_node($node, $beforekey);
1589
1590         $node = navigation_node::create(get_string('useroverrides', 'quiz'),
1591                 new moodle_url($url, array('mode'=>'user')),
1592                 navigation_node::TYPE_SETTING, null, 'mod_quiz_useroverrides');
1593         $quiznode->add_node($node, $beforekey);
1594     }
1595
1596     if (has_capability('mod/quiz:manage', $PAGE->cm->context)) {
1597         $node = navigation_node::create(get_string('editquiz', 'quiz'),
1598                 new moodle_url('/mod/quiz/edit.php', array('cmid'=>$PAGE->cm->id)),
1599                 navigation_node::TYPE_SETTING, null, 'mod_quiz_edit',
1600                 new pix_icon('t/edit', ''));
1601         $quiznode->add_node($node, $beforekey);
1602     }
1603
1604     if (has_capability('mod/quiz:preview', $PAGE->cm->context)) {
1605         $url = new moodle_url('/mod/quiz/startattempt.php',
1606                 array('cmid'=>$PAGE->cm->id, 'sesskey'=>sesskey()));
1607         $node = navigation_node::create(get_string('preview', 'quiz'), $url,
1608                 navigation_node::TYPE_SETTING, null, 'mod_quiz_preview',
1609                 new pix_icon('t/preview', ''));
1610         $quiznode->add_node($node, $beforekey);
1611     }
1612
1613     question_extend_settings_navigation($quiznode, $PAGE->cm->context)->trim_if_empty();
1614 }
1615
1616 /**
1617  * Serves the quiz files.
1618  *
1619  * @param object $course
1620  * @param object $cm
1621  * @param object $context
1622  * @param string $filearea
1623  * @param array $args
1624  * @param bool $forcedownload
1625  * @return bool false if file not found, does not return if found - justsend the file
1626  */
1627 function quiz_pluginfile($course, $cm, $context, $filearea, $args, $forcedownload) {
1628     global $CFG, $DB;
1629
1630     if ($context->contextlevel != CONTEXT_MODULE) {
1631         return false;
1632     }
1633
1634     require_login($course, false, $cm);
1635
1636     if (!$quiz = $DB->get_record('quiz', array('id'=>$cm->instance))) {
1637         return false;
1638     }
1639
1640     // 'intro' area is served by pluginfile.php
1641     $fileareas = array('feedback');
1642     if (!in_array($filearea, $fileareas)) {
1643         return false;
1644     }
1645
1646     $feedbackid = (int)array_shift($args);
1647     if (!$feedback = $DB->get_record('quiz_feedback', array('id'=>$feedbackid))) {
1648         return false;
1649     }
1650
1651     $fs = get_file_storage();
1652     $relativepath = implode('/', $args);
1653     $fullpath = "/$context->id/mod_quiz/$filearea/$feedbackid/$relativepath";
1654     if (!$file = $fs->get_file_by_hash(sha1($fullpath)) or $file->is_directory()) {
1655         return false;
1656     }
1657     send_stored_file($file, 0, 0, true);
1658 }
1659
1660 /**
1661  * Called via pluginfile.php -> question_pluginfile to serve files belonging to
1662  * a question in a question_attempt when that attempt is a quiz attempt.
1663  *
1664  * @param object $course course settings object
1665  * @param object $context context object
1666  * @param string $component the name of the component we are serving files for.
1667  * @param string $filearea the name of the file area.
1668  * @param array $args the remaining bits of the file path.
1669  * @param bool $forcedownload whether the user must be forced to download the file.
1670  * @return bool false if file not found, does not return if found - justsend the file
1671  */
1672 function mod_quiz_question_pluginfile($course, $context, $component,
1673         $filearea, $qubaid, $slot, $args, $forcedownload) {
1674     global $USER, $CFG;
1675     require_once($CFG->dirroot . '/mod/quiz/locallib.php');
1676
1677     $attemptobj = quiz_attempt::create_from_usage_id($qubaid);
1678     require_login($attemptobj->get_courseid(), false, $attemptobj->get_cm());
1679
1680     if ($attemptobj->is_own_attempt() && !$attemptobj->is_finished()) {
1681         // In the middle of an attempt.
1682         if (!$attemptobj->is_preview_user()) {
1683             $attemptobj->require_capability('mod/quiz:attempt');
1684         }
1685         $isreviewing = false;
1686
1687     } else {
1688         // Reviewing an attempt.
1689         $attemptobj->check_review_capability();
1690         $isreviewing = true;
1691     }
1692
1693     if (!$attemptobj->check_file_access($slot, $isreviewing, $context->id,
1694             $component, $filearea, $args, $forcedownload)) {
1695         send_file_not_found();
1696     }
1697
1698     $fs = get_file_storage();
1699     $relativepath = implode('/', $args);
1700     $fullpath = "/$context->id/$component/$filearea/$relativepath";
1701     if (!$file = $fs->get_file_by_hash(sha1($fullpath)) or $file->is_directory()) {
1702         send_file_not_found();
1703     }
1704
1705     send_stored_file($file, 0, 0, $forcedownload);
1706 }
1707
1708 /**
1709  * Return a list of page types
1710  * @param string $pagetype current page type
1711  * @param stdClass $parentcontext Block's parent context
1712  * @param stdClass $currentcontext Current context of block
1713  */
1714 function quiz_page_type_list($pagetype, $parentcontext, $currentcontext) {
1715     $module_pagetype = array(
1716         'mod-quiz-*'=>get_string('page-mod-quiz-x', 'quiz'),
1717         'mod-quiz-edit'=>get_string('page-mod-quiz-edit', 'quiz'));
1718     return $module_pagetype;
1719 }