/');
+ }
+
+ protected function get_contains_checkbox_expectation($baseattr, $enabled, $checked) {
+ $expectedattributes = $baseattr;
+ $forbiddenattributes = array();
+ $expectedattributes['type'] = 'checkbox';
+ if ($enabled === true) {
+ $forbiddenattributes['disabled'] = 'disabled';
+ } else if ($enabled === false) {
+ $expectedattributes['disabled'] = 'disabled';
+ }
+ if ($checked === true) {
+ $expectedattributes['checked'] = 'checked';
+ } else if ($checked === false) {
+ $forbiddenattributes['checked'] = 'checked';
+ }
+ return new ContainsTagWithAttributes('input', $expectedattributes, $forbiddenattributes);
+ }
+
+ protected function get_contains_mc_checkbox_expectation($index, $enabled = null, $checked = null) {
+ return $this->get_contains_checkbox_expectation(array(
+ 'name' => $this->quba->get_field_prefix($this->slot) . $index,
+ 'value' => 1,
+ ), $enabled, $checked);
+ }
+
+ protected function get_contains_radio_expectation($baseattr, $enabled, $checked) {
+ $expectedattributes = $baseattr;
+ $forbiddenattributes = array();
+ $expectedattributes['type'] = 'radio';
+ if ($enabled === true) {
+ $forbiddenattributes['disabled'] = 'disabled';
+ } else if ($enabled === false) {
+ $expectedattributes['disabled'] = 'disabled';
+ }
+ if ($checked === true) {
+ $expectedattributes['checked'] = 'checked';
+ } else if ($checked === false) {
+ $forbiddenattributes['checked'] = 'checked';
+ }
+ return new ContainsTagWithAttributes('input', $expectedattributes, $forbiddenattributes);
+ }
+
+ protected function get_contains_mc_radio_expectation($index, $enabled = null, $checked = null) {
+ return $this->get_contains_radio_expectation(array(
+ 'name' => $this->quba->get_field_prefix($this->slot) . 'answer',
+ 'value' => $index,
+ ), $enabled, $checked);
+ }
+
+ protected function get_contains_hidden_expectation($name, $value = null) {
+ $expectedattributes = array('type' => 'hidden', 'name' => s($name));
+ if (!is_null($value)) {
+ $expectedattributes['value'] = s($value);
+ }
+ return new ContainsTagWithAttributes('input', $expectedattributes);
+ }
+
+ protected function get_does_not_contain_hidden_expectation($name, $value = null) {
+ $expectedattributes = array('type' => 'hidden', 'name' => s($name));
+ if (!is_null($value)) {
+ $expectedattributes['value'] = s($value);
+ }
+ return new DoesNotContainTagWithAttributes('input', $expectedattributes);
+ }
+
+ protected function get_contains_tf_true_radio_expectation($enabled = null, $checked = null) {
+ return $this->get_contains_radio_expectation(array(
+ 'name' => $this->quba->get_field_prefix($this->slot) . 'answer',
+ 'value' => 1,
+ ), $enabled, $checked);
+ }
+
+ protected function get_contains_tf_false_radio_expectation($enabled = null, $checked = null) {
+ return $this->get_contains_radio_expectation(array(
+ 'name' => $this->quba->get_field_prefix($this->slot) . 'answer',
+ 'value' => 0,
+ ), $enabled, $checked);
+ }
+
+ protected function get_contains_cbm_radio_expectation($certainty, $enabled = null, $checked = null) {
+ return $this->get_contains_radio_expectation(array(
+ 'name' => $this->quba->get_field_prefix($this->slot) . '-certainty',
+ 'value' => $certainty,
+ ), $enabled, $checked);
+ }
+
+ protected function get_contains_button_expectation($name, $value = null, $enabled = null) {
+ $expectedattributes = array(
+ 'type' => 'submit',
+ 'name' => $name,
+ );
+ $forbiddenattributes = array();
+ if (!is_null($value)) {
+ $expectedattributes['value'] = $value;
+ }
+ if ($enabled === true) {
+ $forbiddenattributes['disabled'] = 'disabled';
+ } else if ($enabled === false) {
+ $expectedattributes['disabled'] = 'disabled';
+ }
+ return new ContainsTagWithAttributes('input', $expectedattributes, $forbiddenattributes);
+ }
+
+ protected function get_contains_submit_button_expectation($enabled = null) {
+ return $this->get_contains_button_expectation(
+ $this->quba->get_field_prefix($this->slot) . '-submit', null, $enabled);
+ }
+
+ protected function get_tries_remaining_expectation($n) {
+ return new PatternExpectation('/' . preg_quote(get_string('triesremaining', 'qbehaviour_interactive', $n)) . '/');
+ }
+
+ protected function get_invalid_answer_expectation() {
+ return new PatternExpectation('/' . preg_quote(get_string('invalidanswer', 'question')) . '/');
+ }
+
+ protected function get_contains_try_again_button_expectation($enabled = null) {
+ $expectedattributes = array(
+ 'type' => 'submit',
+ 'name' => $this->quba->get_field_prefix($this->slot) . '-tryagain',
+ );
+ $forbiddenattributes = array();
+ if ($enabled === true) {
+ $forbiddenattributes['disabled'] = 'disabled';
+ } else if ($enabled === false) {
+ $expectedattributes['disabled'] = 'disabled';
+ }
+ return new ContainsTagWithAttributes('input', $expectedattributes, $forbiddenattributes);
+ }
+
+ protected function get_does_not_contain_try_again_button_expectation() {
+ return new NoPatternExpectation('/name="' .
+ $this->quba->get_field_prefix($this->slot) . '-tryagain"/');
+ }
+
+ protected function get_contains_select_expectation($name, $choices,
+ $selected = null, $enabled = null) {
+ $fullname = $this->quba->get_field_prefix($this->slot) . $name;
+ return new ContainsSelectExpectation($fullname, $choices, $selected, $enabled);
+ }
+
+ protected function get_mc_right_answer_index($mc) {
+ $order = $mc->get_order($this->get_question_attempt());
+ foreach ($order as $i => $ansid) {
+ if ($mc->answers[$ansid]->fraction == 1) {
+ return $i;
+ }
+ }
+ $this->fail('This multiple choice question does not seem to have a right answer!');
+ }
+
+ protected function get_no_hint_visible_expectation() {
+ return new NoPatternExpectation('/class="hint"/');
+ }
+
+ protected function get_contains_hint_expectation($hinttext) {
+ // Does not currently verify hint text.
+ return new ContainsTagWithAttribute('div', 'class', 'hint');
+ }
+}
\ No newline at end of file
diff --git a/question/engine/simpletest/testdatalib.php b/question/engine/simpletest/testdatalib.php
new file mode 100644
index 00000000000..8b20d941e9e
--- /dev/null
+++ b/question/engine/simpletest/testdatalib.php
@@ -0,0 +1,137 @@
+.
+
+
+/**
+ * This file contains tests for the question_state class.
+ *
+ * @package moodlecore
+ * @subpackage questionengine
+ * @copyright 2009 The Open University
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+
+require_once(dirname(__FILE__) . '/../lib.php');
+
+class qubaid_condition_test extends UnitTestCase {
+
+ protected function check_typical_question_attempts_query(
+ qubaid_condition $qubaids, $expectedsql, $expectedparams) {
+ $sql = "SELECT qa.id, qa.maxmark
+ FROM {$qubaids->from_question_attempts('qa')}
+ WHERE {$qubaids->where()} AND qa.slot = :slot";
+ $this->assertEqual($expectedsql, $sql);
+
+ $params = $qubaids->from_where_params();
+ $params['slot'] = 1;
+ $this->assertEqual($expectedparams, $params);
+ }
+
+ protected function check_typical_in_query(qubaid_condition $qubaids, $expectedsql, $expectedparams) {
+ global $CFG;
+ $sql = "SELECT qa.id, qa.maxmark
+ FROM {$CFG->prefix}question_attempts qa
+ WHERE qa.questionusageid {$qubaids->usage_id_in()}";
+ $this->assertEqual($expectedsql, $sql);
+
+ $this->assertEqual($expectedparams, $qubaids->usage_id_in_params());
+ }
+
+ public function test_qubaid_list_one_join() {
+ global $CFG;
+ $qubaids = new qubaid_list(array(1));
+ $this->check_typical_question_attempts_query($qubaids,
+ "SELECT qa.id, qa.maxmark
+ FROM {$CFG->prefix}question_attempts qa
+ WHERE qa.questionusageid = :qubaid0000 AND qa.slot = :slot",
+ array('qubaid0000' => 1, 'slot' => 1));
+ }
+
+ public function test_qubaid_list_several_join() {
+ global $CFG;
+ $qubaids = new qubaid_list(array(1, 3, 7));
+ $this->check_typical_question_attempts_query($qubaids,
+ "SELECT qa.id, qa.maxmark
+ FROM {$CFG->prefix}question_attempts qa
+ WHERE qa.questionusageid IN (:qubaid0000,:qubaid0001,:qubaid0002) AND qa.slot = :slot",
+ array('qubaid0000' => 1, 'qubaid0001' => 3, 'qubaid0002' => 7, 'slot' => 1));
+ }
+
+ public function test_qubaid_join() {
+ global $CFG;
+ $qubaids = new qubaid_join("{$CFG->prefix}other_table ot", 'ot.usageid', 'ot.id = 1');
+
+ $this->check_typical_question_attempts_query($qubaids,
+ "SELECT qa.id, qa.maxmark
+ FROM {$CFG->prefix}other_table ot
+ JOIN {$CFG->prefix}question_attempts qa ON qa.questionusageid = ot.usageid
+ WHERE ot.id = 1 AND qa.slot = :slot", array('slot' => 1));
+ }
+
+ public function test_qubaid_join_no_where_join() {
+ global $CFG;
+ $qubaids = new qubaid_join("{$CFG->prefix}other_table ot", 'ot.usageid');
+
+ $this->check_typical_question_attempts_query($qubaids,
+ "SELECT qa.id, qa.maxmark
+ FROM {$CFG->prefix}other_table ot
+ JOIN {$CFG->prefix}question_attempts qa ON qa.questionusageid = ot.usageid
+ WHERE 1 = 1 AND qa.slot = :slot", array('slot' => 1));
+ }
+
+ public function test_qubaid_list_one_in() {
+ global $CFG;
+ $qubaids = new qubaid_list(array(1));
+ $this->check_typical_in_query($qubaids,
+ "SELECT qa.id, qa.maxmark
+ FROM {$CFG->prefix}question_attempts qa
+ WHERE qa.questionusageid = :qubaid0000", array('qubaid0000' => 1));
+ }
+
+ public function test_qubaid_list_several_in() {
+ global $CFG;
+ $qubaids = new qubaid_list(array(1, 2, 3));
+ $this->check_typical_in_query($qubaids,
+ "SELECT qa.id, qa.maxmark
+ FROM {$CFG->prefix}question_attempts qa
+ WHERE qa.questionusageid IN (:qubaid0000,:qubaid0001,:qubaid0002)",
+ array('qubaid0000' => 1, 'qubaid0001' => 2, 'qubaid0002' => 3));
+ }
+
+ public function test_qubaid_join_in() {
+ global $CFG;
+ $qubaids = new qubaid_join("{$CFG->prefix}other_table ot", 'ot.usageid', 'ot.id = 1');
+
+ $this->check_typical_in_query($qubaids,
+ "SELECT qa.id, qa.maxmark
+ FROM {$CFG->prefix}question_attempts qa
+ WHERE qa.questionusageid IN (SELECT ot.usageid FROM {$CFG->prefix}other_table ot WHERE ot.id = 1)",
+ array());
+ }
+
+ public function test_qubaid_join_no_where_in() {
+ global $CFG;
+ $qubaids = new qubaid_join("{$CFG->prefix}other_table ot", 'ot.usageid');
+
+ $this->check_typical_in_query($qubaids,
+ "SELECT qa.id, qa.maxmark
+ FROM {$CFG->prefix}question_attempts qa
+ WHERE qa.questionusageid IN (SELECT ot.usageid FROM {$CFG->prefix}other_table ot WHERE 1 = 1)",
+ array());
+ }
+}
\ No newline at end of file
diff --git a/question/engine/simpletest/testquestionattempt.php b/question/engine/simpletest/testquestionattempt.php
new file mode 100644
index 00000000000..d13f339a79f
--- /dev/null
+++ b/question/engine/simpletest/testquestionattempt.php
@@ -0,0 +1,347 @@
+.
+
+
+/**
+ * This file contains tests for the question_attempt class.
+ *
+ * Action methods like start, process_action and finish are assumed to be
+ * tested by testintegration.php.
+ *
+ * @package moodlecore
+ * @subpackage questionengine
+ * @copyright 2009 The Open University
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+
+require_once(dirname(__FILE__) . '/../lib.php');
+require_once(dirname(__FILE__) . '/helpers.php');
+
+class question_attempt_test extends UnitTestCase {
+ private $question;
+ private $usageid;
+ private $qa;
+
+ public function setUp() {
+ $this->question = test_question_maker::make_a_description_question();
+ $this->question->defaultmark = 3;
+ $this->usageid = 13;
+ $this->qa = new question_attempt($this->question, $this->usageid);
+ }
+
+ public function tearDown() {
+ $this->question = null;
+ $this->useageid = null;
+ $this->qa = null;
+ }
+
+ public function test_constructor_sets_maxmark() {
+ $qa = new question_attempt($this->question, $this->usageid);
+ $this->assertIdentical($this->question, $qa->get_question());
+ $this->assertEqual(3, $qa->get_max_mark());
+ }
+
+ public function test_maxmark_beats_default_mark() {
+ $qa = new question_attempt($this->question, $this->usageid, null, 2);
+ $this->assertEqual(2, $qa->get_max_mark());
+ }
+
+ public function test_get_set_number_in_usage() {
+ $this->qa->set_number_in_usage(7);
+ $this->assertEqual(7, $this->qa->get_slot());
+ }
+
+ public function test_fagged_initially_false() {
+ $this->assertEqual(false, $this->qa->is_flagged());
+ }
+
+ public function test_set_is_flagged() {
+ $this->qa->set_flagged(true);
+ $this->assertEqual(true, $this->qa->is_flagged());
+ }
+
+ public function test_get_qt_field_name() {
+ $name = $this->qa->get_qt_field_name('test');
+ $this->assertPattern('/^' . preg_quote($this->qa->get_field_prefix()) . '/', $name);
+ $this->assertPattern('/_test$/', $name);
+ }
+
+ public function test_get_behaviour_field_name() {
+ $name = $this->qa->get_behaviour_field_name('test');
+ $this->assertPattern('/^' . preg_quote($this->qa->get_field_prefix()) . '/', $name);
+ $this->assertPattern('/_-test$/', $name);
+ }
+
+ public function test_get_field_prefix() {
+ $this->qa->set_number_in_usage(7);
+ $name = $this->qa->get_field_prefix();
+ $this->assertPattern('/' . preg_quote($this->usageid) . '/', $name);
+ $this->assertPattern('/' . preg_quote($this->qa->get_slot()) . '/', $name);
+ }
+
+ public function test_get_submitted_var_not_present_var_returns_null() {
+ $this->assertNull(question_attempt::get_submitted_var(
+ 'reallyunlikelyvariablename', PARAM_BOOL));
+ }
+
+ public function test_get_submitted_var_param_mark_not_present() {
+ $this->assertNull(question_attempt::get_submitted_var(
+ 'name', question_attempt::PARAM_MARK, array()));
+ }
+
+ public function test_get_submitted_var_param_mark_blank() {
+ $this->assertIdentical('', question_attempt::get_submitted_var(
+ 'name', question_attempt::PARAM_MARK, array('name' => '')));
+ }
+
+ public function test_get_submitted_var_param_mark_number() {
+ $this->assertIdentical(123.0, question_attempt::get_submitted_var(
+ 'name', question_attempt::PARAM_MARK, array('name' => '123')));
+ }
+
+ public function test_get_submitted_var_param_mark_invalid() {
+ $this->assertIdentical(0.0, question_attempt::get_submitted_var(
+ 'name', question_attempt::PARAM_MARK, array('name' => 'frog')));
+ }
+}
+
+
+/**
+ * These tests use a standard fixture of a question_attempt with three steps.
+ *
+ * @copyright 2009 The Open University
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class question_attempt_with_steps_test extends UnitTestCase {
+ private $question;
+ private $qa;
+
+ public function setUp() {
+ $this->question = test_question_maker::make_a_description_question();
+ $this->qa = new testable_question_attempt($this->question, 0, null, 2);
+ for ($i = 0; $i < 3; $i++) {
+ $step = new question_attempt_step(array('i' => $i));
+ $this->qa->add_step($step);
+ }
+ }
+
+ public function tearDown() {
+ $this->qa = null;
+ }
+
+ public function test_get_step_before_start() {
+ $this->expectException();
+ $step = $this->qa->get_step(-1);
+ }
+
+ public function test_get_step_at_start() {
+ $step = $this->qa->get_step(0);
+ $this->assertEqual(0, $step->get_qt_var('i'));
+ }
+
+ public function test_get_step_at_end() {
+ $step = $this->qa->get_step(2);
+ $this->assertEqual(2, $step->get_qt_var('i'));
+ }
+
+ public function test_get_step_past_end() {
+ $this->expectException();
+ $step = $this->qa->get_step(3);
+ }
+
+ public function test_get_num_steps() {
+ $this->assertEqual(3, $this->qa->get_num_steps());
+ }
+
+ public function test_get_last_step() {
+ $step = $this->qa->get_last_step();
+ $this->assertEqual(2, $step->get_qt_var('i'));
+ }
+
+ public function test_get_last_qt_var_there1() {
+ $this->assertEqual(2, $this->qa->get_last_qt_var('i'));
+ }
+
+ public function test_get_last_qt_var_there2() {
+ $this->qa->get_step(0)->set_qt_var('_x', 'a value');
+ $this->assertEqual('a value', $this->qa->get_last_qt_var('_x'));
+ }
+
+ public function test_get_last_qt_var_missing() {
+ $this->assertNull($this->qa->get_last_qt_var('notthere'));
+ }
+
+ public function test_get_last_qt_var_missing_default() {
+ $this->assertEqual('default', $this->qa->get_last_qt_var('notthere', 'default'));
+ }
+
+ public function test_get_last_behaviour_var_missing() {
+ $this->assertNull($this->qa->get_last_qt_var('notthere'));
+ }
+
+ public function test_get_last_behaviour_var_there() {
+ $this->qa->get_step(1)->set_behaviour_var('_x', 'a value');
+ $this->assertEqual('a value', '' . $this->qa->get_last_behaviour_var('_x'));
+ }
+
+ public function test_get_state_gets_state_of_last() {
+ $this->qa->get_step(2)->set_state(question_state::$gradedright);
+ $this->qa->get_step(1)->set_state(question_state::$gradedwrong);
+ $this->assertEqual(question_state::$gradedright, $this->qa->get_state());
+ }
+
+ public function test_get_mark_gets_mark_of_last() {
+ $this->assertEqual(2, $this->qa->get_max_mark());
+ $this->qa->get_step(2)->set_fraction(0.5);
+ $this->qa->get_step(1)->set_fraction(0.1);
+ $this->assertEqual(1, $this->qa->get_mark());
+ }
+
+ public function test_get_fraction_gets_fraction_of_last() {
+ $this->qa->get_step(2)->set_fraction(0.5);
+ $this->qa->get_step(1)->set_fraction(0.1);
+ $this->assertEqual(0.5, $this->qa->get_fraction());
+ }
+
+ public function test_get_fraction_returns_null_if_none() {
+ $this->assertNull($this->qa->get_fraction());
+ }
+
+ public function test_format_mark() {
+ $this->qa->get_step(2)->set_fraction(0.5);
+ $this->assertEqual('1.00', $this->qa->format_mark(2));
+ }
+
+ public function test_format_max_mark() {
+ $this->assertEqual('2.0000000', $this->qa->format_max_mark(7));
+ }
+
+ public function test_get_min_fraction() {
+ $this->qa->set_min_fraction(-1);
+ $this->assertEqual(-1, $this->qa->get_min_fraction(0));
+ }
+
+ public function test_cannot_get_min_fraction_before_start() {
+ $qa = new question_attempt($this->question, null);
+ $this->expectException();
+ $qa->get_min_fraction();
+ }
+}
+
+
+class question_attempt_db_test extends data_loading_method_test_base {
+ public function test_load() {
+ $records = testing_db_record_builder::build_db_records(array(
+ array('id', 'questionattemptid', 'questionusageid', 'slot',
+ 'behaviour', 'questionid', 'maxmark', 'minfraction', 'flagged',
+ 'questionsummary', 'rightanswer', 'responsesummary', 'timemodified',
+ 'attemptstepid', 'sequencenumber', 'state', 'fraction',
+ 'timecreated', 'userid', 'name', 'value'),
+ array(1, 1, 1, 1, 'deferredfeedback', -1, 2.0000000, 0.0000000, 0, '', '', '', 1256233790, 1, 0, 'todo', null, 1256233700, 1, null, null),
+ array(2, 1, 1, 1, 'deferredfeedback', -1, 2.0000000, 0.0000000, 0, '', '', '', 1256233790, 2, 1, 'complete', null, 1256233705, 1, 'answer', '1'),
+ array(3, 1, 1, 1, 'deferredfeedback', -1, 2.0000000, 0.0000000, 1, '', '', '', 1256233790, 3, 2, 'complete', null, 1256233710, 1, 'answer', '0'),
+ array(4, 1, 1, 1, 'deferredfeedback', -1, 2.0000000, 0.0000000, 0, '', '', '', 1256233790, 4, 3, 'complete', null, 1256233715, 1, 'answer', '1'),
+ array(5, 1, 1, 1, 'deferredfeedback', -1, 2.0000000, 0.0000000, 0, '', '', '', 1256233790, 5, 4, 'gradedright', 1.0000000, 1256233720, 1, '-finish', '1'),
+ array(6, 1, 1, 1, 'deferredfeedback', -1, 2.0000000, 0.0000000, 0, '', '', '', 1256233790, 6, 5, 'mangrpartial', 0.5000000, 1256233790, 1, '-comment', 'Not good enough!'),
+ array(7, 1, 1, 1, 'deferredfeedback', -1, 2.0000000, 0.0000000, 0, '', '', '', 1256233790, 6, 5, 'mangrpartial', 0.5000000, 1256233790, 1, '-mark', '1'),
+ array(8, 1, 1, 1, 'deferredfeedback', -1, 2.0000000, 0.0000000, 0, '', '', '', 1256233790, 6, 5, 'mangrpartial', 0.5000000, 1256233790, 1, '-maxmark', '2'),
+ ));
+
+ $question = test_question_maker::make_a_truefalse_question();
+ $question->id = -1;
+
+ question_bank::start_unit_test();
+ question_bank::load_test_question_data($question);
+ $qa = question_attempt::load_from_records($records, 1, new question_usage_null_observer(), 'deferredfeedback');
+ question_bank::end_unit_test();
+
+ $this->assertEqual($question->questiontext, $qa->get_question()->questiontext);
+
+ $this->assertEqual(6, $qa->get_num_steps());
+
+ $step = $qa->get_step(0);
+ $this->assertEqual(question_state::$todo, $step->get_state());
+ $this->assertNull($step->get_fraction());
+ $this->assertEqual(1256233700, $step->get_timecreated());
+ $this->assertEqual(1, $step->get_user_id());
+ $this->assertEqual(array(), $step->get_all_data());
+
+ $step = $qa->get_step(1);
+ $this->assertEqual(question_state::$complete, $step->get_state());
+ $this->assertNull($step->get_fraction());
+ $this->assertEqual(1256233705, $step->get_timecreated());
+ $this->assertEqual(1, $step->get_user_id());
+ $this->assertEqual(array('answer' => '1'), $step->get_all_data());
+
+ $step = $qa->get_step(2);
+ $this->assertEqual(question_state::$complete, $step->get_state());
+ $this->assertNull($step->get_fraction());
+ $this->assertEqual(1256233710, $step->get_timecreated());
+ $this->assertEqual(1, $step->get_user_id());
+ $this->assertEqual(array('answer' => '0'), $step->get_all_data());
+
+ $step = $qa->get_step(3);
+ $this->assertEqual(question_state::$complete, $step->get_state());
+ $this->assertNull($step->get_fraction());
+ $this->assertEqual(1256233715, $step->get_timecreated());
+ $this->assertEqual(1, $step->get_user_id());
+ $this->assertEqual(array('answer' => '1'), $step->get_all_data());
+
+ $step = $qa->get_step(4);
+ $this->assertEqual(question_state::$gradedright, $step->get_state());
+ $this->assertEqual(1, $step->get_fraction());
+ $this->assertEqual(1256233720, $step->get_timecreated());
+ $this->assertEqual(1, $step->get_user_id());
+ $this->assertEqual(array('-finish' => '1'), $step->get_all_data());
+
+ $step = $qa->get_step(5);
+ $this->assertEqual(question_state::$mangrpartial, $step->get_state());
+ $this->assertEqual(0.5, $step->get_fraction());
+ $this->assertEqual(1256233790, $step->get_timecreated());
+ $this->assertEqual(1, $step->get_user_id());
+ $this->assertEqual(array('-comment' => 'Not good enough!', '-mark' => '1', '-maxmark' => '2'),
+ $step->get_all_data());
+ }
+
+ public function test_load_missing_question() {
+ $records = testing_db_record_builder::build_db_records(array(
+ array('id', 'questionattemptid', 'questionusageid', 'slot',
+ 'behaviour', 'questionid', 'maxmark', 'minfraction', 'flagged',
+ 'questionsummary', 'rightanswer', 'responsesummary', 'timemodified',
+ 'attemptstepid', 'sequencenumber', 'state', 'fraction',
+ 'timecreated', 'userid', 'name', 'value'),
+ array(1, 1, 1, 1, 'deferredfeedback', -1, 2.0000000, 0.0000000, 0, '', '', '', 1256233790, 1, 0, 'todo', null, 1256233700, 1, null, null),
+ ));
+
+ question_bank::start_unit_test();
+ $qa = question_attempt::load_from_records($records, 1, new question_usage_null_observer(), 'deferredfeedback');
+ question_bank::end_unit_test();
+
+ $missingq = question_bank::get_qtype('missingtype')->make_deleted_instance(-1, 2);
+ $this->assertEqual($missingq, $qa->get_question());
+
+ $this->assertEqual(1, $qa->get_num_steps());
+
+ $step = $qa->get_step(0);
+ $this->assertEqual(question_state::$todo, $step->get_state());
+ $this->assertNull($step->get_fraction());
+ $this->assertEqual(1256233700, $step->get_timecreated());
+ $this->assertEqual(1, $step->get_user_id());
+ $this->assertEqual(array(), $step->get_all_data());
+ }
+}
diff --git a/question/engine/simpletest/testquestionattemptiterator.php b/question/engine/simpletest/testquestionattemptiterator.php
new file mode 100644
index 00000000000..79e46cd347d
--- /dev/null
+++ b/question/engine/simpletest/testquestionattemptiterator.php
@@ -0,0 +1,110 @@
+.
+
+
+/**
+ * This file contains tests for the question_attempt_iterator class.
+ *
+ * @package moodlecore
+ * @subpackage questionengine
+ * @copyright 2009 The Open University
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+
+require_once(dirname(__FILE__) . '/../lib.php');
+require_once(dirname(__FILE__) . '/helpers.php');
+
+
+class question_attempt_iterator_test extends UnitTestCase {
+ private $quba;
+ private $qas = array();
+ private $iterator;
+
+ public function setUp() {
+ $this->quba = question_engine::make_questions_usage_by_activity('unit_test',
+ get_context_instance(CONTEXT_SYSTEM));
+ $this->quba->set_preferred_behaviour('deferredfeedback');
+
+ $slot = $this->quba->add_question(test_question_maker::make_a_description_question());
+ $this->qas[$slot] = $this->quba->get_question_attempt($slot);
+
+ $slot = $this->quba->add_question(test_question_maker::make_a_description_question());
+ $this->qas[$slot] = $this->quba->get_question_attempt($slot);
+
+ $this->iterator = $this->quba->get_attempt_iterator();
+ }
+
+ public function tearDown() {
+ $this->quba = null;
+ $this->iterator = null;
+ }
+
+ public function test_foreach_loop() {
+ $i = 1;
+ foreach ($this->iterator as $key => $qa) {
+ $this->assertEqual($i, $key);
+ $this->assertIdentical($this->qas[$i], $qa);
+ $i++;
+ }
+ $this->assertEqual(3, $i);
+ }
+
+ public function test_offsetExists_before_start() {
+ $this->assertFalse(isset($this->iterator[0]));
+ }
+
+ public function test_offsetExists_at_start() {
+ $this->assertTrue(isset($this->iterator[1]));
+ }
+
+ public function test_offsetExists_at_endt() {
+ $this->assertTrue(isset($this->iterator[2]));
+ }
+
+ public function test_offsetExists_past_end() {
+ $this->assertFalse(isset($this->iterator[3]));
+ }
+
+ public function test_offsetGet_before_start() {
+ $this->expectException();
+ $step = $this->iterator[0];
+ }
+
+ public function test_offsetGet_at_start() {
+ $this->assertIdentical($this->qas[1], $this->iterator[1]);
+ }
+
+ public function test_offsetGet_at_end() {
+ $this->assertIdentical($this->qas[2], $this->iterator[2]);
+ }
+
+ public function test_offsetGet_past_end() {
+ $this->expectException();
+ $step = $this->iterator[3];
+ }
+
+ public function test_cannot_set() {
+ $this->expectException();
+ $this->iterator[0] = null;
+ }
+
+ public function test_cannot_unset() {
+ $this->expectException();
+ unset($this->iterator[2]);
+ }
+}
\ No newline at end of file
diff --git a/question/engine/simpletest/testquestionattemptstep.php b/question/engine/simpletest/testquestionattemptstep.php
new file mode 100644
index 00000000000..e9039879a27
--- /dev/null
+++ b/question/engine/simpletest/testquestionattemptstep.php
@@ -0,0 +1,170 @@
+.
+
+
+/**
+ * This file contains tests for the question_attempt_step class.
+ *
+ * @package moodlecore
+ * @subpackage questionengine
+ * @copyright 2009 The Open University
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+
+require_once(dirname(__FILE__) . '/../lib.php');
+require_once(dirname(__FILE__) . '/helpers.php');
+
+class question_attempt_step_test extends UnitTestCase {
+ public function test_initial_state_unprocessed() {
+ $step = new question_attempt_step();
+ $this->assertEqual(question_state::$unprocessed, $step->get_state());
+ }
+
+ public function test_get_set_state() {
+ $step = new question_attempt_step();
+ $step->set_state(question_state::$gradedright);
+ $this->assertEqual(question_state::$gradedright, $step->get_state());
+ }
+
+ public function test_initial_fraction_null() {
+ $step = new question_attempt_step();
+ $this->assertNull($step->get_fraction());
+ }
+
+ public function test_get_set_fraction() {
+ $step = new question_attempt_step();
+ $step->set_fraction(0.5);
+ $this->assertEqual(0.5, $step->get_fraction());
+ }
+
+ public function test_has_var() {
+ $step = new question_attempt_step(array('x' => 1, '-y' => 'frog'));
+ $this->assertTrue($step->has_qt_var('x'));
+ $this->assertTrue($step->has_behaviour_var('y'));
+ $this->assertFalse($step->has_qt_var('y'));
+ $this->assertFalse($step->has_behaviour_var('x'));
+ }
+
+ public function test_get_var() {
+ $step = new question_attempt_step(array('x' => 1, '-y' => 'frog'));
+ $this->assertEqual('1', $step->get_qt_var('x'));
+ $this->assertEqual('frog', $step->get_behaviour_var('y'));
+ $this->assertNull($step->get_qt_var('y'));
+ }
+
+ public function test_set_var() {
+ $step = new question_attempt_step();
+ $step->set_qt_var('_x', 1);
+ $step->set_behaviour_var('_x', 2);
+ $this->assertEqual('1', $step->get_qt_var('_x'));
+ $this->assertEqual('2', $step->get_behaviour_var('_x'));
+ }
+
+ public function test_cannot_set_qt_var_without_underscore() {
+ $step = new question_attempt_step();
+ $this->expectException();
+ $step->set_qt_var('x', 1);
+ }
+
+ public function test_cannot_set_behaviour_var_without_underscore() {
+ $step = new question_attempt_step();
+ $this->expectException();
+ $step->set_behaviour_var('x', 1);
+ }
+
+ public function test_get_data() {
+ $step = new question_attempt_step(array('x' => 1, '-y' => 'frog', ':flagged' => 1));
+ $this->assertEqual(array('x' => '1'), $step->get_qt_data());
+ $this->assertEqual(array('y' => 'frog'), $step->get_behaviour_data());
+ $this->assertEqual(array('x' => 1, '-y' => 'frog', ':flagged' => 1), $step->get_all_data());
+ }
+
+ public function test_get_submitted_data() {
+ $step = new question_attempt_step(array('x' => 1, '-y' => 'frog'));
+ $step->set_qt_var('_x', 1);
+ $step->set_behaviour_var('_x', 2);
+ $this->assertEqual(array('x' => 1, '-y' => 'frog'), $step->get_submitted_data());
+ }
+
+ public function test_constructor_default_params() {
+ global $USER;
+ $step = new question_attempt_step();
+ $this->assertWithinMargin(time(), $step->get_timecreated(), 5);
+ $this->assertEqual($USER->id, $step->get_user_id());
+ $this->assertEqual(array(), $step->get_qt_data());
+ $this->assertEqual(array(), $step->get_behaviour_data());
+
+ }
+
+ public function test_constructor_given_params() {
+ global $USER;
+ $step = new question_attempt_step(array(), 123, 5);
+ $this->assertEqual(123, $step->get_timecreated());
+ $this->assertEqual(5, $step->get_user_id());
+ $this->assertEqual(array(), $step->get_qt_data());
+ $this->assertEqual(array(), $step->get_behaviour_data());
+
+ }
+}
+
+
+class question_attempt_step_db_test extends data_loading_method_test_base {
+ public function test_load_with_data() {
+ $records = $this->build_db_records(array(
+ array('id', 'attemptstepid', 'questionattemptid', 'sequencenumber', 'state', 'fraction', 'timecreated', 'userid', 'name', 'value'),
+ array( 1, 1, 1, 0, 'todo', null, 1256228502, 13, null, null),
+ array( 2, 2, 1, 1, 'complete', null, 1256228505, 13, 'x', 'a'),
+ array( 3, 2, 1, 1, 'complete', null, 1256228505, 13, '_y', '_b'),
+ array( 4, 2, 1, 1, 'complete', null, 1256228505, 13, '-z', '!c'),
+ array( 5, 2, 1, 1, 'complete', null, 1256228505, 13, '-_t', '!_d'),
+ array( 6, 3, 1, 2, 'gradedright', 1.0, 1256228515, 13, '-finish', '1'),
+ ));
+
+ $step = question_attempt_step::load_from_records($records, 2);
+ $this->assertEqual(question_state::$complete, $step->get_state());
+ $this->assertNull($step->get_fraction());
+ $this->assertEqual(1256228505, $step->get_timecreated());
+ $this->assertEqual(13, $step->get_user_id());
+ $this->assertEqual(array('x' => 'a', '_y' => '_b', '-z' => '!c', '-_t' => '!_d'), $step->get_all_data());
+ }
+
+ public function test_load_without_data() {
+ $records = $this->build_db_records(array(
+ array('id', 'attemptstepid', 'questionattemptid', 'sequencenumber', 'state', 'fraction', 'timecreated', 'userid', 'name', 'value'),
+ array( 2, 2, 1, 1, 'complete', null, 1256228505, 13, null, null),
+ ));
+
+ $step = question_attempt_step::load_from_records($records, 2);
+ $this->assertEqual(question_state::$complete, $step->get_state());
+ $this->assertNull($step->get_fraction());
+ $this->assertEqual(1256228505, $step->get_timecreated());
+ $this->assertEqual(13, $step->get_user_id());
+ $this->assertEqual(array(), $step->get_all_data());
+ }
+
+ public function test_load_dont_be_too_greedy() {
+ $records = $this->build_db_records(array(
+ array('id', 'attemptstepid', 'questionattemptid', 'sequencenumber', 'state', 'fraction', 'timecreated', 'userid', 'name', 'value'),
+ array( 1, 1, 1, 0, 'todo', null, 1256228502, 13, 'x', 'right'),
+ array( 2, 2, 2, 0, 'complete', null, 1256228505, 13, 'x', 'wrong'),
+ ));
+
+ $step = question_attempt_step::load_from_records($records, 1);
+ $this->assertEqual(array('x' => 'right'), $step->get_all_data());
+ }
+}
\ No newline at end of file
diff --git a/question/engine/simpletest/testquestionattemptstepiterator.php b/question/engine/simpletest/testquestionattemptstepiterator.php
new file mode 100644
index 00000000000..224510ec399
--- /dev/null
+++ b/question/engine/simpletest/testquestionattemptstepiterator.php
@@ -0,0 +1,129 @@
+.
+
+
+/**
+ * This file contains tests for the question_attempt_step_iterator class.
+ *
+ * @package moodlecore
+ * @subpackage questionengine
+ * @copyright 2009 The Open University
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+
+require_once(dirname(__FILE__) . '/../lib.php');
+require_once(dirname(__FILE__) . '/helpers.php');
+
+
+class question_attempt_step_iterator_test extends UnitTestCase {
+ private $qa;
+ private $iterator;
+
+ public function setUp() {
+ $question = test_question_maker::make_a_description_question();
+ $this->qa = new testable_question_attempt($question, 0);
+ for ($i = 0; $i < 3; $i++) {
+ $step = new question_attempt_step(array('i' => $i));
+ $this->qa->add_step($step);
+ }
+ $this->iterator = $this->qa->get_step_iterator();
+ }
+
+ public function tearDown() {
+ $this->qa = null;
+ $this->iterator = null;
+ }
+
+ public function test_foreach_loop() {
+ $i = 0;
+ foreach ($this->iterator as $key => $step) {
+ $this->assertEqual($i, $key);
+ $this->assertEqual($i, $step->get_qt_var('i'));
+ $i++;
+ }
+ }
+
+ public function test_foreach_loop_add_step_during() {
+ $i = 0;
+ foreach ($this->iterator as $key => $step) {
+ $this->assertEqual($i, $key);
+ $this->assertEqual($i, $step->get_qt_var('i'));
+ $i++;
+ if ($i == 2) {
+ $step = new question_attempt_step(array('i' => 3));
+ $this->qa->add_step($step);
+ }
+ }
+ $this->assertEqual(4, $i);
+ }
+
+ public function test_reverse_foreach_loop() {
+ $i = 2;
+ foreach ($this->qa->get_reverse_step_iterator() as $key => $step) {
+ $this->assertEqual($i, $key);
+ $this->assertEqual($i, $step->get_qt_var('i'));
+ $i--;
+ }
+ }
+
+ public function test_offsetExists_before_start() {
+ $this->assertFalse(isset($this->iterator[-1]));
+ }
+
+ public function test_offsetExists_at_start() {
+ $this->assertTrue(isset($this->iterator[0]));
+ }
+
+ public function test_offsetExists_at_endt() {
+ $this->assertTrue(isset($this->iterator[2]));
+ }
+
+ public function test_offsetExists_past_end() {
+ $this->assertFalse(isset($this->iterator[3]));
+ }
+
+ public function test_offsetGet_before_start() {
+ $this->expectException();
+ $step = $this->iterator[-1];
+ }
+
+ public function test_offsetGet_at_start() {
+ $step = $this->iterator[0];
+ $this->assertEqual(0, $step->get_qt_var('i'));
+ }
+
+ public function test_offsetGet_at_end() {
+ $step = $this->iterator[2];
+ $this->assertEqual(2, $step->get_qt_var('i'));
+ }
+
+ public function test_offsetGet_past_end() {
+ $this->expectException();
+ $step = $this->iterator[3];
+ }
+
+ public function test_cannot_set() {
+ $this->expectException();
+ $this->iterator[0] = null;
+ }
+
+ public function test_cannot_unset() {
+ $this->expectException();
+ unset($this->iterator[2]);
+ }
+}
\ No newline at end of file
diff --git a/question/engine/simpletest/testquestioncbm.php b/question/engine/simpletest/testquestioncbm.php
new file mode 100644
index 00000000000..5274cc7c6b1
--- /dev/null
+++ b/question/engine/simpletest/testquestioncbm.php
@@ -0,0 +1,40 @@
+.
+
+
+/**
+ * This file contains tests for the question_cbm class.
+ *
+ * @package moodlecore
+ * @subpackage questionengine
+ * @copyright 2009 The Open University
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+
+require_once(dirname(__FILE__) . '/../lib.php');
+
+class question_cbm_test extends UnitTestCase {
+ public function test_adjust_fraction() {
+ $this->assertWithinMargin(0, question_cbm::adjust_fraction(0, question_cbm::LOW), 0.0000001);
+ $this->assertWithinMargin(-2/3, question_cbm::adjust_fraction(0, question_cbm::MED), 0.0000001);
+ $this->assertWithinMargin(-2, question_cbm::adjust_fraction(0, question_cbm::HIGH), 0.0000001);
+ $this->assertWithinMargin(1/3, question_cbm::adjust_fraction(1, question_cbm::LOW), 0.0000001);
+ $this->assertWithinMargin(2/3, question_cbm::adjust_fraction(1, question_cbm::MED), 0.0000001);
+ $this->assertWithinMargin(1, question_cbm::adjust_fraction(1, question_cbm::HIGH), 0.0000001);
+ }
+}
\ No newline at end of file
diff --git a/question/engine/simpletest/testquestionengine.php b/question/engine/simpletest/testquestionengine.php
new file mode 100644
index 00000000000..84ef20038c1
--- /dev/null
+++ b/question/engine/simpletest/testquestionengine.php
@@ -0,0 +1,94 @@
+.
+
+
+/**
+ * This file contains tests for the question_engine class.
+ *
+ * @package moodlecore
+ * @subpackage questionengine
+ * @copyright 2009 The Open University
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+
+require_once(dirname(__FILE__) . '/../lib.php');
+
+class question_engine_test extends UnitTestCase {
+
+ public function setUp() {
+
+ }
+
+ public function tearDown() {
+
+ }
+
+ public function test_load_behaviour_class() {
+ // Exercise SUT
+ question_engine::load_behaviour_class('deferredfeedback');
+ // Verify
+ $this->assertTrue(class_exists('qbehaviour_deferredfeedback'));
+ }
+
+ public function test_load_behaviour_class_missing() {
+ // Set expectation.
+ $this->expectException();
+ // Exercise SUT
+ question_engine::load_behaviour_class('nonexistantbehaviour');
+ }
+
+ public function test_get_behaviour_unused_display_options() {
+ $this->assertEqual(array(), question_engine::get_behaviour_unused_display_options('interactive'));
+ $this->assertEqual(array('correctness', 'marks', 'specificfeedback', 'generalfeedback', 'rightanswer'),
+ question_engine::get_behaviour_unused_display_options('deferredfeedback'));
+ $this->assertEqual(array('correctness', 'marks', 'specificfeedback', 'generalfeedback', 'rightanswer'),
+ question_engine::get_behaviour_unused_display_options('deferredcbm'));
+ $this->assertEqual(array('correctness', 'marks', 'specificfeedback', 'generalfeedback', 'rightanswer'),
+ question_engine::get_behaviour_unused_display_options('manualgraded'));
+ }
+
+ public function test_sort_behaviours() {
+ $in = array('b1' => 'Behave 1', 'b2' => 'Behave 2', 'b3' => 'Behave 3', 'b4' => 'Behave 4', 'b5' => 'Behave 5', 'b6' => 'Behave 6');
+
+ $out = array('b1' => 'Behave 1', 'b2' => 'Behave 2', 'b3' => 'Behave 3', 'b4' => 'Behave 4', 'b5' => 'Behave 5', 'b6' => 'Behave 6');
+ $this->assertIdentical($out, question_engine::sort_behaviours($in, '', '', ''));
+
+ $this->assertIdentical($out, question_engine::sort_behaviours($in, '', 'b4', 'b4'));
+
+ $out = array('b4' => 'Behave 4', 'b5' => 'Behave 5', 'b6' => 'Behave 6');
+ $this->assertIdentical($out, question_engine::sort_behaviours($in, '', 'b1,b2,b3,b4', 'b4'));
+
+ $out = array('b6' => 'Behave 6', 'b1' => 'Behave 1', 'b4' => 'Behave 4');
+ $this->assertIdentical($out, question_engine::sort_behaviours($in, 'b6, b1, b4', 'b1, b2, b3, b4, b5', 'b4'));
+
+ $out = array('b6' => 'Behave 6', 'b5' => 'Behave 5', 'b4' => 'Behave 4');
+ $this->assertIdentical($out, question_engine::sort_behaviours($in, 'b6, b5, b4', 'b1, b2, b3', 'b4'));
+
+ $out = array('b1' => 'Behave 1', 'b6' => 'Behave 6', 'b5' => 'Behave 5', 'b4' => 'Behave 4');
+ $this->assertIdentical($out, question_engine::sort_behaviours($in, 'b1, b6, b5', 'b1, b2, b3, b4, b5', 'b4'));
+
+ $out = array('b2' => 'Behave 2', 'b4' => 'Behave 4', 'b6' => 'Behave 6');
+ $this->assertIdentical($out, question_engine::sort_behaviours($in, 'b2, b4, b6', 'b1, b3, b5', 'b2'));
+
+ // Ignore unknown input in the order argument.
+ $this->assertIdentical($in, question_engine::sort_behaviours($in, 'unknown', '', ''));
+
+ // Ignore unknown input in the disabled argument.
+ $this->assertIdentical($in, question_engine::sort_behaviours($in, '', 'unknown', ''));
+ }
+}
\ No newline at end of file
diff --git a/question/engine/simpletest/testquestionstate.php b/question/engine/simpletest/testquestionstate.php
new file mode 100644
index 00000000000..eb0d0551e27
--- /dev/null
+++ b/question/engine/simpletest/testquestionstate.php
@@ -0,0 +1,154 @@
+.
+
+
+/**
+ * This file contains tests for the question_state class.
+ *
+ * @package moodlecore
+ * @subpackage questionengine
+ * @copyright 2009 The Open University
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+
+require_once(dirname(__FILE__) . '/../lib.php');
+require_once($CFG->libdir . '/questionlib.php');
+
+class question_state_test extends UnitTestCase {
+ public function test_is_active() {
+ $this->assertFalse(question_state::$notstarted->is_active());
+ $this->assertFalse(question_state::$unprocessed->is_active());
+ $this->assertTrue(question_state::$todo->is_active());
+ $this->assertTrue(question_state::$invalid->is_active());
+ $this->assertTrue(question_state::$complete->is_active());
+ $this->assertFalse(question_state::$needsgrading->is_active());
+ $this->assertFalse(question_state::$finished->is_active());
+ $this->assertFalse(question_state::$gaveup->is_active());
+ $this->assertFalse(question_state::$gradedwrong->is_active());
+ $this->assertFalse(question_state::$gradedpartial->is_active());
+ $this->assertFalse(question_state::$gradedright->is_active());
+ $this->assertFalse(question_state::$manfinished->is_active());
+ $this->assertFalse(question_state::$mangaveup->is_active());
+ $this->assertFalse(question_state::$mangrwrong->is_active());
+ $this->assertFalse(question_state::$mangrpartial->is_active());
+ $this->assertFalse(question_state::$mangrright->is_active());
+ }
+
+ public function test_is_finished() {
+ $this->assertFalse(question_state::$notstarted->is_finished());
+ $this->assertFalse(question_state::$unprocessed->is_finished());
+ $this->assertFalse(question_state::$todo->is_finished());
+ $this->assertFalse(question_state::$invalid->is_finished());
+ $this->assertFalse(question_state::$complete->is_finished());
+ $this->assertTrue(question_state::$needsgrading->is_finished());
+ $this->assertTrue(question_state::$finished->is_finished());
+ $this->assertTrue(question_state::$gaveup->is_finished());
+ $this->assertTrue(question_state::$gradedwrong->is_finished());
+ $this->assertTrue(question_state::$gradedpartial->is_finished());
+ $this->assertTrue(question_state::$gradedright->is_finished());
+ $this->assertTrue(question_state::$manfinished->is_finished());
+ $this->assertTrue(question_state::$mangaveup->is_finished());
+ $this->assertTrue(question_state::$mangrwrong->is_finished());
+ $this->assertTrue(question_state::$mangrpartial->is_finished());
+ $this->assertTrue(question_state::$mangrright->is_finished());
+ }
+
+ public function test_is_graded() {
+ $this->assertFalse(question_state::$notstarted->is_graded());
+ $this->assertFalse(question_state::$unprocessed->is_graded());
+ $this->assertFalse(question_state::$todo->is_graded());
+ $this->assertFalse(question_state::$invalid->is_graded());
+ $this->assertFalse(question_state::$complete->is_graded());
+ $this->assertFalse(question_state::$needsgrading->is_graded());
+ $this->assertFalse(question_state::$finished->is_graded());
+ $this->assertFalse(question_state::$gaveup->is_graded());
+ $this->assertTrue(question_state::$gradedwrong->is_graded());
+ $this->assertTrue(question_state::$gradedpartial->is_graded());
+ $this->assertTrue(question_state::$gradedright->is_graded());
+ $this->assertFalse(question_state::$manfinished->is_graded());
+ $this->assertFalse(question_state::$mangaveup->is_graded());
+ $this->assertTrue(question_state::$mangrwrong->is_graded());
+ $this->assertTrue(question_state::$mangrpartial->is_graded());
+ $this->assertTrue(question_state::$mangrright->is_graded());
+ }
+
+ public function test_is_commented() {
+ $this->assertFalse(question_state::$notstarted->is_commented());
+ $this->assertFalse(question_state::$unprocessed->is_commented());
+ $this->assertFalse(question_state::$todo->is_commented());
+ $this->assertFalse(question_state::$invalid->is_commented());
+ $this->assertFalse(question_state::$complete->is_commented());
+ $this->assertFalse(question_state::$needsgrading->is_commented());
+ $this->assertFalse(question_state::$finished->is_commented());
+ $this->assertFalse(question_state::$gaveup->is_commented());
+ $this->assertFalse(question_state::$gradedwrong->is_commented());
+ $this->assertFalse(question_state::$gradedpartial->is_commented());
+ $this->assertFalse(question_state::$gradedright->is_commented());
+ $this->assertTrue(question_state::$manfinished->is_commented());
+ $this->assertTrue(question_state::$mangaveup->is_commented());
+ $this->assertTrue(question_state::$mangrwrong->is_commented());
+ $this->assertTrue(question_state::$mangrpartial->is_commented());
+ $this->assertTrue(question_state::$mangrright->is_commented());
+ }
+
+ public function test_graded_state_for_fraction() {
+ $this->assertEqual(question_state::$gradedwrong, question_state::graded_state_for_fraction(-1));
+ $this->assertEqual(question_state::$gradedwrong, question_state::graded_state_for_fraction(0));
+ $this->assertEqual(question_state::$gradedpartial, question_state::graded_state_for_fraction(0.000001));
+ $this->assertEqual(question_state::$gradedpartial, question_state::graded_state_for_fraction(0.999999));
+ $this->assertEqual(question_state::$gradedright, question_state::graded_state_for_fraction(1));
+ }
+
+ public function test_manually_graded_state_for_other_state() {
+ $this->assertEqual(question_state::$manfinished,
+ question_state::$finished->corresponding_commented_state(null));
+ $this->assertEqual(question_state::$mangaveup,
+ question_state::$gaveup->corresponding_commented_state(null));
+ $this->assertEqual(question_state::$manfinished,
+ question_state::$manfinished->corresponding_commented_state(null));
+ $this->assertEqual(question_state::$mangaveup,
+ question_state::$mangaveup->corresponding_commented_state(null));
+ $this->assertEqual(question_state::$needsgrading,
+ question_state::$mangrright->corresponding_commented_state(null));
+ $this->assertEqual(question_state::$needsgrading,
+ question_state::$mangrright->corresponding_commented_state(null));
+
+ $this->assertEqual(question_state::$mangrwrong,
+ question_state::$gaveup->corresponding_commented_state(0));
+ $this->assertEqual(question_state::$mangrwrong,
+ question_state::$needsgrading->corresponding_commented_state(0));
+ $this->assertEqual(question_state::$mangrwrong,
+ question_state::$gradedwrong->corresponding_commented_state(0));
+ $this->assertEqual(question_state::$mangrwrong,
+ question_state::$gradedpartial->corresponding_commented_state(0));
+ $this->assertEqual(question_state::$mangrwrong,
+ question_state::$gradedright->corresponding_commented_state(0));
+ $this->assertEqual(question_state::$mangrwrong,
+ question_state::$mangrright->corresponding_commented_state(0));
+ $this->assertEqual(question_state::$mangrwrong,
+ question_state::$mangrpartial->corresponding_commented_state(0));
+ $this->assertEqual(question_state::$mangrwrong,
+ question_state::$mangrright->corresponding_commented_state(0));
+
+ $this->assertEqual(question_state::$mangrpartial,
+ question_state::$gradedpartial->corresponding_commented_state(0.5));
+
+ $this->assertEqual(question_state::$mangrright,
+ question_state::$gradedpartial->corresponding_commented_state(1));
+ }
+}
\ No newline at end of file
diff --git a/question/engine/simpletest/testquestionusagebyactivity.php b/question/engine/simpletest/testquestionusagebyactivity.php
new file mode 100644
index 00000000000..eb4261def07
--- /dev/null
+++ b/question/engine/simpletest/testquestionusagebyactivity.php
@@ -0,0 +1,155 @@
+.
+
+
+/**
+ * This file contains tests for the question_usage_by_activity class.
+ *
+ * @package moodlecore
+ * @subpackage questionengine
+ * @copyright 2009 The Open University
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+
+require_once(dirname(__FILE__) . '/../lib.php');
+require_once(dirname(__FILE__) . '/helpers.php');
+
+
+class question_usage_by_activity_test extends UnitTestCase {
+
+ public function test_set_get_preferred_model() {
+ // Set up
+ $quba = question_engine::make_questions_usage_by_activity('unit_test',
+ get_context_instance(CONTEXT_SYSTEM));
+
+ // Exercise SUT and verify.
+ $quba->set_preferred_behaviour('deferredfeedback');
+ $this->assertEqual('deferredfeedback', $quba->get_preferred_behaviour());
+ }
+
+ public function test_set_get_id() {
+ // Set up
+ $quba = question_engine::make_questions_usage_by_activity('unit_test',
+ get_context_instance(CONTEXT_SYSTEM));
+
+ // Exercise SUT and verify
+ $quba->set_id_from_database(123);
+ $this->assertEqual(123, $quba->get_id());
+ }
+
+ public function test_fake_id() {
+ // Set up
+ $quba = question_engine::make_questions_usage_by_activity('unit_test',
+ get_context_instance(CONTEXT_SYSTEM));
+
+ // Exercise SUT and verify
+ $this->assertTrue($quba->get_id());
+ }
+
+ public function test_create_usage_and_add_question() {
+ // Exercise SUT
+ $context = get_context_instance(CONTEXT_SYSTEM);
+ $quba = question_engine::make_questions_usage_by_activity('unit_test', $context);
+ $quba->set_preferred_behaviour('deferredfeedback');
+ $tf = test_question_maker::make_a_truefalse_question();
+ $slot = $quba->add_question($tf);
+
+ // Verify.
+ $this->assertEqual($slot, 1);
+ $this->assertEqual('unit_test', $quba->get_owning_component());
+ $this->assertIdentical($context, $quba->get_owning_context());
+ $this->assertEqual($quba->question_count(), 1);
+ $this->assertEqual($quba->get_question_state($slot), question_state::$notstarted);
+ }
+
+ public function test_get_question() {
+ // Set up.
+ $quba = question_engine::make_questions_usage_by_activity('unit_test',
+ get_context_instance(CONTEXT_SYSTEM));
+ $quba->set_preferred_behaviour('deferredfeedback');
+ $tf = test_question_maker::make_a_truefalse_question();
+ $slot = $quba->add_question($tf);
+
+ // Exercise SUT and verify.
+ $this->assertIdentical($tf, $quba->get_question($slot));
+
+ $this->expectException();
+ $quba->get_question($slot + 1);
+ }
+
+ public function test_extract_responses() {
+ // Start a deferred feedback attempt with CBM and add the question to it.
+ $tf = test_question_maker::make_a_truefalse_question();
+ $quba = question_engine::make_questions_usage_by_activity('unit_test',
+ get_context_instance(CONTEXT_SYSTEM));
+ $quba->set_preferred_behaviour('deferredcbm');
+ $slot = $quba->add_question($tf);
+ $quba->start_all_questions();
+
+ // Prepare data to be submitted
+ $prefix = $quba->get_field_prefix($slot);
+ $answername = $prefix . 'answer';
+ $certaintyname = $prefix . '-certainty';
+ $getdata = array(
+ $answername => 1,
+ $certaintyname => 3,
+ 'irrelevant' => 'should be ignored',
+ );
+
+ // Exercise SUT
+ $submitteddata = $quba->extract_responses($slot, $getdata);
+
+ // Verify.
+ $this->assertEqual(array('answer' => 1, '-certainty' => 3), $submitteddata);
+ }
+
+ public function test_access_out_of_sequence_throws_exception() {
+ // Start a deferred feedback attempt with CBM and add the question to it.
+ $tf = test_question_maker::make_a_truefalse_question();
+ $quba = question_engine::make_questions_usage_by_activity('unit_test',
+ get_context_instance(CONTEXT_SYSTEM));
+ $quba->set_preferred_behaviour('deferredcbm');
+ $slot = $quba->add_question($tf);
+ $quba->start_all_questions();
+
+ // Prepare data to be submitted
+ $prefix = $quba->get_field_prefix($slot);
+ $answername = $prefix . 'answer';
+ $certaintyname = $prefix . '-certainty';
+ $postdata = array(
+ $answername => 1,
+ $certaintyname => 3,
+ $prefix . ':sequencecheck' => 1,
+ 'irrelevant' => 'should be ignored',
+ );
+
+ // Exercise SUT - no exception yet.
+ $quba->process_all_actions($slot, $postdata);
+
+ $postdata = array(
+ $answername => 1,
+ $certaintyname => 3,
+ $prefix . ':sequencecheck' => 3,
+ 'irrelevant' => 'should be ignored',
+ );
+
+ // Exercise SUT - now it should fail.
+ $this->expectException('question_out_of_sequence_exception');
+ $quba->process_all_actions($slot, $postdata);
+ }
+}
\ No newline at end of file
diff --git a/question/engine/simpletest/testquestionutils.php b/question/engine/simpletest/testquestionutils.php
new file mode 100644
index 00000000000..87ee68397b3
--- /dev/null
+++ b/question/engine/simpletest/testquestionutils.php
@@ -0,0 +1,186 @@
+.
+
+
+/**
+ * This file contains tests for the {@link question_utils} class.
+ *
+ * @package moodlecore
+ * @subpackage questionengine
+ * @copyright 2010 The Open University
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+
+require_once(dirname(__FILE__) . '/../lib.php');
+
+class question_utils_test extends UnitTestCase {
+ public function test_arrays_have_same_keys_and_values() {
+ $this->assertTrue(question_utils::arrays_have_same_keys_and_values(
+ array(),
+ array()));
+ $this->assertTrue(question_utils::arrays_have_same_keys_and_values(
+ array('key' => 1),
+ array('key' => '1')));
+ $this->assertFalse(question_utils::arrays_have_same_keys_and_values(
+ array(),
+ array('key' => 1)));
+ $this->assertFalse(question_utils::arrays_have_same_keys_and_values(
+ array('key' => 2),
+ array('key' => 1)));
+ $this->assertFalse(question_utils::arrays_have_same_keys_and_values(
+ array('key' => 1),
+ array('otherkey' => 1)));
+ $this->assertFalse(question_utils::arrays_have_same_keys_and_values(
+ array('sub0' => '2', 'sub1' => '2', 'sub2' => '3', 'sub3' => '1'),
+ array('sub0' => '1', 'sub1' => '2', 'sub2' => '3', 'sub3' => '1')));
+ }
+
+ public function test_arrays_same_at_key() {
+ $this->assertTrue(question_utils::arrays_same_at_key(
+ array(),
+ array(),
+ 'key'));
+ $this->assertFalse(question_utils::arrays_same_at_key(
+ array(),
+ array('key' => 1),
+ 'key'));
+ $this->assertFalse(question_utils::arrays_same_at_key(
+ array('key' => 1),
+ array(),
+ 'key'));
+ $this->assertTrue(question_utils::arrays_same_at_key(
+ array('key' => 1),
+ array('key' => 1),
+ 'key'));
+ $this->assertFalse(question_utils::arrays_same_at_key(
+ array('key' => 1),
+ array('key' => 2),
+ 'key'));
+ $this->assertTrue(question_utils::arrays_same_at_key(
+ array('key' => 1),
+ array('key' => '1'),
+ 'key'));
+ $this->assertFalse(question_utils::arrays_same_at_key(
+ array('key' => 0),
+ array('key' => ''),
+ 'key'));
+ $this->assertFalse(question_utils::arrays_same_at_key(
+ array(),
+ array('key' => ''),
+ 'key'));
+ }
+
+ public function test_arrays_same_at_key_missing_is_blank() {
+ $this->assertTrue(question_utils::arrays_same_at_key_missing_is_blank(
+ array(),
+ array(),
+ 'key'));
+ $this->assertFalse(question_utils::arrays_same_at_key_missing_is_blank(
+ array(),
+ array('key' => 1),
+ 'key'));
+ $this->assertFalse(question_utils::arrays_same_at_key_missing_is_blank(
+ array('key' => 1),
+ array(),
+ 'key'));
+ $this->assertTrue(question_utils::arrays_same_at_key_missing_is_blank(
+ array('key' => 1),
+ array('key' => 1),
+ 'key'));
+ $this->assertFalse(question_utils::arrays_same_at_key_missing_is_blank(
+ array('key' => 1),
+ array('key' => 2),
+ 'key'));
+ $this->assertTrue(question_utils::arrays_same_at_key_missing_is_blank(
+ array('key' => 1),
+ array('key' => '1'),
+ 'key'));
+ $this->assertFalse(question_utils::arrays_same_at_key_missing_is_blank(
+ array('key' => '0'),
+ array('key' => ''),
+ 'key'));
+ $this->assertTrue(question_utils::arrays_same_at_key_missing_is_blank(
+ array(),
+ array('key' => ''),
+ 'key'));
+ }
+
+ public function test_arrays_same_at_key_integer() {
+ $this->assertTrue(question_utils::arrays_same_at_key_integer(
+ array(),
+ array(),
+ 'key'));
+ $this->assertFalse(question_utils::arrays_same_at_key_integer(
+ array(),
+ array('key' => 1),
+ 'key'));
+ $this->assertFalse(question_utils::arrays_same_at_key_integer(
+ array('key' => 1),
+ array(),
+ 'key'));
+ $this->assertTrue(question_utils::arrays_same_at_key_integer(
+ array('key' => 1),
+ array('key' => 1),
+ 'key'));
+ $this->assertFalse(question_utils::arrays_same_at_key_integer(
+ array('key' => 1),
+ array('key' => 2),
+ 'key'));
+ $this->assertTrue(question_utils::arrays_same_at_key_integer(
+ array('key' => 1),
+ array('key' => '1'),
+ 'key'));
+ $this->assertTrue(question_utils::arrays_same_at_key_integer(
+ array('key' => '0'),
+ array('key' => ''),
+ 'key'));
+ $this->assertTrue(question_utils::arrays_same_at_key_integer(
+ array(),
+ array('key' => 0),
+ 'key'));
+ }
+
+ public function test_int_to_roman() {
+ $this->assertIdentical('i', question_utils::int_to_roman(1));
+ $this->assertIdentical('iv', question_utils::int_to_roman(4));
+ $this->assertIdentical('v', question_utils::int_to_roman(5));
+ $this->assertIdentical('vi', question_utils::int_to_roman(6));
+ $this->assertIdentical('ix', question_utils::int_to_roman(9));
+ $this->assertIdentical('xi', question_utils::int_to_roman(11));
+ $this->assertIdentical('xlviii', question_utils::int_to_roman(48));
+ $this->assertIdentical('lxxxvii', question_utils::int_to_roman(87));
+ $this->assertIdentical('c', question_utils::int_to_roman(100));
+ $this->assertIdentical('mccxxxiv', question_utils::int_to_roman(1234));
+ $this->assertIdentical('mmmcmxcix', question_utils::int_to_roman(3999));
+ }
+
+ public function test_int_to_roman_too_small() {
+ $this->expectException();
+ question_utils::int_to_roman(0);
+ }
+
+ public function test_int_to_roman_too_big() {
+ $this->expectException();
+ question_utils::int_to_roman(4000);
+ }
+
+ public function test_int_to_roman_not_int() {
+ $this->expectException();
+ question_utils::int_to_roman(1.5);
+ }
+}
\ No newline at end of file
diff --git a/question/engine/states.php b/question/engine/states.php
new file mode 100644
index 00000000000..0fde0fc6368
--- /dev/null
+++ b/question/engine/states.php
@@ -0,0 +1,460 @@
+.
+
+
+/**
+ * This defines the states a question can be in.
+ *
+ * @package moodlecore
+ * @subpackage questionengine
+ * @copyright 2010 The Open University
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+
+/**
+ * An enumeration representing the states a question can be in after a
+ * {@link question_attempt_step}.
+ *
+ * There are also some useful methods for testing and manipulating states.
+ *
+ * @copyright 2009 The Open University
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+abstract class question_state {
+ /**#@+
+ * Specific question_state instances.
+ */
+ public static $notstarted;
+ public static $unprocessed;
+ public static $todo;
+ public static $invalid;
+ public static $complete;
+ public static $needsgrading;
+ public static $finished;
+ public static $gaveup;
+ public static $gradedwrong;
+ public static $gradedpartial;
+ public static $gradedright;
+ public static $manfinished;
+ public static $mangaveup;
+ public static $mangrwrong;
+ public static $mangrpartial;
+ public static $mangrright;
+ /**#@+-*/
+
+ protected function __construct() {
+ }
+
+ public static function init() {
+ $us = new ReflectionClass('question_state');
+ foreach ($us->getStaticProperties() as $name => $notused) {
+ $class = 'question_state_' . $name;
+ $states[$name] = new $class();
+ self::$$name = $states[$name];
+ }
+ }
+
+ /**
+ * Get all the states in an array.
+ * @return of question_state objects.
+ */
+ public static function get_all() {
+ $states = array();
+ $us = new ReflectionClass('question_state');
+ foreach ($us->getStaticProperties() as $name => $notused) {
+ $states[] = self::$$name;
+ }
+ return $states;
+ }
+
+ /**
+ * Get all the states in an array.
+ * @param string $summarystate one of the four summary states
+ * inprogress, needsgrading, manuallygraded or autograded.
+ * @return arrau of the corresponding states.
+ */
+ public static function get_all_for_summary_state($summarystate) {
+ $states = array();
+ foreach (self::get_all() as $state) {
+ if ($state->get_summary_state() == $summarystate) {
+ $states[] = $state;
+ }
+ }
+ if (empty($states)) {
+ throw new Exception('unknown summary state ' . $summarystate);
+ }
+ return $states;
+ }
+
+ /**
+ * @return string convert this state to a string.
+ */
+ public function __toString() {
+ return substr(get_class($this), 15);
+ }
+
+ /**
+ * @param string $name a state name.
+ * @return question_state the state with that name.
+ */
+ public static function get($name) {
+ return self::$$name;
+ }
+
+ /**
+ * Is this state one of the ones that mean the question attempt is in progress?
+ * That is, started, but no finished.
+ * @return boolean
+ */
+ public function is_active() {
+ return false;
+ }
+
+ /**
+ * Is this state one of the ones that mean the question attempt is finished?
+ * That is, no further interaction possible, apart from manual grading.
+ * @return boolean
+ */
+ public function is_finished() {
+ return true;
+ }
+
+ /**
+ * Is this state one of the ones that mean the question attempt has been graded?
+ * @return boolean
+ */
+ public function is_graded() {
+ return false;
+ }
+
+ /**
+ * Is this state one of the ones that mean the question attempt has been graded?
+ * @return boolean
+ */
+ public function is_correct() {
+ return false;
+ }
+
+ /**
+ * Is this state one of the ones that mean the question attempt has been graded?
+ * @return boolean
+ */
+ public function is_partially_correct() {
+ return false;
+ }
+
+ /**
+ * Is this state one of the ones that mean the question attempt has been graded?
+ * @return boolean
+ */
+ public function is_incorrect() {
+ return false;
+ }
+
+ /**
+ * Is this state one of the ones that mean the question attempt has been graded?
+ * @return boolean
+ */
+ public function is_gave_up() {
+ return false;
+ }
+
+ /**
+ * Is this state one of the ones that mean the question attempt has had a manual comment added?
+ * @return boolean
+ */
+ public function is_commented() {
+ return false;
+ }
+
+ /**
+ * Each state can be categorised into one of four categories:
+ * inprogress, needsgrading, manuallygraded or autograded.
+ * @return string which category this state falls into.
+ */
+ public function get_summary_state() {
+ if (!$this->is_finished()) {
+ return 'inprogress';
+ } else if ($this == self::$needsgrading) {
+ return 'needsgrading';
+ } else if ($this->is_commented()) {
+ return 'manuallygraded';
+ } else {
+ return 'autograded';
+ }
+ }
+
+ /**
+ * Return the appropriate graded state based on a fraction. That is 0 or less
+ * is $graded_incorrect, 1 is $graded_correct, otherwise it is $graded_partcorrect.
+ * Appropriate allowance is made for rounding float values.
+ *
+ * @param number $fraction the grade, on the fraction scale.
+ * @return integer one of the state constants.
+ */
+ public static function graded_state_for_fraction($fraction) {
+ if ($fraction < 0.000001) {
+ return self::$gradedwrong;
+ } else if ($fraction > 0.999999) {
+ return self::$gradedright;
+ } else {
+ return self::$gradedpartial;
+ }
+ }
+
+ /**
+ * Return the appropriate manually graded state based on a fraction. That is 0 or less
+ * is $manually_graded_incorrect, 1 is $manually_graded_correct, otherwise it is
+ * $manually_graded_partcorrect. Appropriate allowance is made for rounding float values.
+ *
+ * @param number $fraction the grade, on the fraction scale.
+ * @return integer one of the state constants.
+ */
+ public static function manually_graded_state_for_fraction($fraction) {
+ if (is_null($fraction)) {
+ return self::$needsgrading;
+ } else if ($fraction < 0.000001) {
+ return self::$mangrwrong;
+ } else if ($fraction > 0.999999) {
+ return self::$mangrright;
+ } else {
+ return self::$mangrpartial;
+ }
+ }
+
+ /**
+ * Compute an appropriate state to move to after a manual comment has been
+ * added to this state.
+ * @param number $fraction the manual grade (if any) on the fraction scale.
+ * @return integer the new state.
+ */
+ public function corresponding_commented_state($fraction) {
+ throw new Exception('Unexpected question state.');
+ }
+
+ /**
+ * Return an appropriate CSS class name ''/'correct'/'partiallycorrect'/'incorrect',
+ * for a state.
+ * @return string
+ */
+ public function get_feedback_class() {
+ return '';
+ }
+
+ /**
+ * Return the name of an appropriate string to look up in the question
+ * language pack for a state. This is used, for example, by
+ * {@link question_behaviour::get_state_string()}. However, behaviours
+ * sometimes change this default string for soemthing more specific.
+ *
+ * @param boolean $showcorrectness Whether right/partial/wrong states should
+ * be distinguised, or just treated as 'complete'.
+ * @return string the name of a string that can be looked up in the 'question'
+ * lang pack, or used as a CSS class name, etc.
+ */
+ public abstract function get_state_class($showcorrectness);
+
+ /**
+ * The result of doing get_string on the result of {@link get_state_class()}.
+ *
+ * @param boolean $showcorrectness Whether right/partial/wrong states should
+ * be distinguised.
+ * @return string a string from the lang pack that can be used in the UI.
+ */
+ public function default_string($showcorrectness) {
+ return get_string($this->get_state_class($showcorrectness), 'question');
+ }
+}
+
+
+/**#@+
+ * Specific question_state subclasses.
+ *
+ * @copyright 2009 The Open University
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class question_state_notstarted extends question_state {
+ public function is_finished() {
+ return false;
+ }
+ public function get_state_class($showcorrectness) {
+ throw new Exception('Unexpected question state.');
+ }
+}
+class question_state_unprocessed extends question_state {
+ public function is_finished() {
+ return false;
+ }
+ public function get_state_class($showcorrectness) {
+ throw new Exception('Unexpected question state.');
+ }
+}
+class question_state_todo extends question_state {
+ public function is_active() {
+ return true;
+ }
+ public function is_finished() {
+ return false;
+ }
+ public function get_state_class($showcorrectness) {
+ return 'notyetanswered';
+ }
+}
+class question_state_invalid extends question_state {
+ public function is_active() {
+ return true;
+ }
+ public function is_finished() {
+ return false;
+ }
+ public function get_state_class($showcorrectness) {
+ return 'invalidanswer';
+ }
+}
+class question_state_complete extends question_state {
+ public function is_active() {
+ return true;
+ }
+ public function is_finished() {
+ return false;
+ }
+ public function get_state_class($showcorrectness) {
+ return 'answersaved';
+ }
+}
+class question_state_needsgrading extends question_state {
+ public function get_state_class($showcorrectness) {
+ return 'requiresgrading';
+ }
+ public function corresponding_commented_state($fraction) {
+ return self::manually_graded_state_for_fraction($fraction);
+ }
+}
+class question_state_finished extends question_state {
+ public function get_state_class($showcorrectness) {
+ return 'complete';
+ }
+ public function corresponding_commented_state($fraction) {
+ return self::$manfinished;
+ }
+}
+class question_state_gaveup extends question_state {
+ public function is_gave_up() {
+ return true;
+ }
+ public function get_feedback_class() {
+ return 'incorrect';
+ }
+ public function get_state_class($showcorrectness) {
+ return 'notanswered';
+ }
+ public function corresponding_commented_state($fraction) {
+ if (is_null($fraction)) {
+ return self::$mangaveup;
+ } else {
+ return self::manually_graded_state_for_fraction($fraction);
+ }
+ }
+}
+abstract class question_state_graded extends question_state {
+ public function is_graded() {
+ return true;
+ }
+ public function get_state_class($showcorrectness) {
+ if ($showcorrectness) {
+ return $this->get_feedback_class();
+ } else {
+ return 'complete';
+ }
+ }
+ public function corresponding_commented_state($fraction) {
+ return self::manually_graded_state_for_fraction($fraction);
+ }
+}
+class question_state_gradedwrong extends question_state_graded {
+ public function is_incorrect() {
+ return true;
+ }
+ public function get_feedback_class() {
+ return 'incorrect';
+ }
+}
+class question_state_gradedpartial extends question_state_graded {
+ public function is_graded() {
+ return true;
+ }
+ public function is_partially_correct() {
+ return true;
+ }
+ public function get_feedback_class() {
+ return 'partiallycorrect';
+ }
+}
+class question_state_gradedright extends question_state_graded {
+ public function is_graded() {
+ return true;
+ }
+ public function is_correct() {
+ return true;
+ }
+ public function get_feedback_class() {
+ return 'correct';
+ }
+}
+class question_state_manfinished extends question_state_finished {
+ public function is_commented() {
+ return true;
+ }
+}
+class question_state_mangaveup extends question_state_gaveup {
+ public function is_commented() {
+ return true;
+ }
+}
+abstract class question_state_manuallygraded extends question_state_graded {
+ public function is_commented() {
+ return true;
+ }
+}
+class question_state_mangrwrong extends question_state_manuallygraded {
+ public function is_incorrect() {
+ return false;
+ }
+ public function get_feedback_class() {
+ return 'incorrect';
+ }
+}
+class question_state_mangrpartial extends question_state_manuallygraded {
+ public function is_partially_correct() {
+ return true;
+ }
+ public function get_feedback_class() {
+ return 'partiallycorrect';
+ }
+}
+class question_state_mangrright extends question_state_manuallygraded {
+ public function is_correct() {
+ return true;
+ }
+ public function get_feedback_class() {
+ return 'correct';
+ }
+}
+/**#@-*/
+question_state::init();
diff --git a/question/engine/upgradefromoldqe/upgrade.php b/question/engine/upgradefromoldqe/upgrade.php
new file mode 100644
index 00000000000..a87a16e8741
--- /dev/null
+++ b/question/engine/upgradefromoldqe/upgrade.php
@@ -0,0 +1,1969 @@
+.
+
+
+/**
+ * This file contains the code required to upgrade all the attempt data from
+ * old versions of Moodle into the tables used by the new question engine.
+ *
+ * @package moodlecore
+ * @subpackage questionengine
+ * @copyright 2010 The Open University
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+
+global $CFG;
+require_once($CFG->libdir . '/questionlib.php');
+
+
+/**
+ * This class serves to record all the assumptions that the code had to make
+ * during the question engine database database upgrade, to facilitate reviewing them.
+ *
+ * @copyright 2010 The Open University
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class question_engine_assumption_logger {
+ protected $handle;
+ protected $attemptid;
+
+ public function __construct() {
+ global $CFG;
+ make_upload_directory('upgradelogs');
+ $this->handle = fopen($CFG->dataroot . '/upgradelogs/qe_' .
+ date('Ymd-Hi') . '.html', 'a');
+ fwrite($this->handle, 'Question engine upgrade assumptions ' .
+ date('Ymd-Hi') . ' : bit,
+ // We need to deal with that.
+ $this->logger->log_assumption("Dealing with missing order information
+ in attempt at multiple choice question {$this->question->id}");
+ return $answer;
+ }
+ }
+
+ public function response_summary($state) {
+ $responses = $this->explode_answer($state->answer);
+ if ($this->question->options->single) {
+ if (is_numeric($responses)) {
+ if (array_key_exists($responses, $this->question->options->answers)) {
+ return $this->to_text($this->question->options->answers[$responses]->answer);
+ } else {
+ $this->logger->log_assumption("Dealing with a place where the
+ student selected a choice that was later deleted for
+ multiple choice question {$this->question->id}");
+ return '[CHOICE THAT WAS LATER DELETED]';
+ }
+ } else {
+ return null;
+ }
+
+ } else {
+ if (!empty($responses)) {
+ $responses = explode(',', $responses);
+ $bits = array();
+ foreach ($responses as $response) {
+ if (array_key_exists($response, $this->question->options->answers)) {
+ $bits[] = $this->to_text($this->question->options->answers[$response]->answer);
+ } else {
+ $this->logger->log_assumption("Dealing with a place where the
+ student selected a choice that was later deleted for
+ multiple choice question {$this->question->id}");
+ $bits[] = '[CHOICE THAT WAS LATER DELETED]';
+ }
+ }
+ return implode('; ', $bits);
+ } else {
+ return null;
+ }
+ }
+ }
+
+ public function was_answered($state) {
+ $responses = $this->explode_answer($state->answer);
+ if ($this->question->options->single) {
+ return is_numeric($responses);
+ } else {
+ return !empty($responses);
+ }
+ }
+
+ public function set_first_step_data_elements($state, &$data) {
+ if (!$state->answer) {
+ return;
+ }
+ list($order, $responses) = explode(':', $state->answer);
+ $data['_order'] = $order;
+ $this->order = explode(',', $order);
+ }
+
+ public function supply_missing_first_step_data(&$data) {
+ $data['_order'] = implode(',', array_keys($this->question->options->answers));
+ }
+
+ public function set_data_elements_for_step($state, &$data) {
+ $responses = $this->explode_answer($state->answer);
+ if ($this->question->options->single) {
+ if (is_numeric($responses)) {
+ $flippedorder = array_combine(array_values($this->order), array_keys($this->order));
+ if (array_key_exists($responses, $flippedorder)) {
+ $data['answer'] = $flippedorder[$responses];
+ } else {
+ $data['answer'] = '-1';
+ }
+ }
+
+ } else {
+ $responses = explode(',', $responses);
+ foreach ($this->order as $key => $ansid) {
+ if (in_array($ansid, $responses)) {
+ $data['choice' . $key] = 1;
+ } else {
+ $data['choice' . $key] = 0;
+ }
+ }
+ }
+ }
+}
+
+
+class qtype_shortanswer_updater extends qtype_updater {
+ public function right_answer() {
+ foreach ($this->question->options->answers as $ans) {
+ if ($ans->fraction > 0.999) {
+ return $ans->answer;
+ }
+ }
+ }
+
+ public function was_answered($state) {
+ return !empty($state->answer);
+ }
+
+ public function response_summary($state) {
+ if (!empty($state->answer)) {
+ return $state->answer;
+ } else {
+ return null;
+ }
+ }
+
+ public function set_first_step_data_elements($state, &$data) {
+ }
+
+ public function supply_missing_first_step_data(&$data) {
+ }
+
+ public function set_data_elements_for_step($state, &$data) {
+ if (!empty($state->answer)) {
+ $data['answer'] = $state->answer;
+ }
+ }
+}
+
+
+class qtype_essay_updater extends qtype_updater {
+ public function right_answer() {
+ return '';
+ }
+
+ public function response_summary($state) {
+ if (!empty($state->answer)) {
+ return $this->to_text($state->answer);
+ } else {
+ return null;
+ }
+ }
+
+ public function was_answered($state) {
+ return !empty($state->answer);
+ }
+
+ public function set_first_step_data_elements($state, &$data) {
+ }
+
+ public function supply_missing_first_step_data(&$data) {
+ }
+
+ public function set_data_elements_for_step($state, &$data) {
+ if (!empty($state->answer)) {
+ $data['answer'] = $state->answer;
+ }
+ }
+}
+
+
+class qtype_numerical_updater extends qtype_updater {
+ public function right_answer() {
+ foreach ($this->question->options->answers as $ans) {
+ if ($ans->fraction > 0.999) {
+ return $ans->answer;
+ }
+ }
+ }
+
+ public function response_summary($state) {
+ if (!empty($state->answer)) {
+ return $state->answer;
+ } else {
+ return null;
+ }
+ }
+
+ public function was_answered($state) {
+ return !empty($state->answer);
+ }
+
+ public function set_first_step_data_elements($state, &$data) {
+ $data['_separators'] = '.$,';
+ }
+
+ public function supply_missing_first_step_data(&$data) {
+ $data['_separators'] = '.$,';
+ }
+
+ public function set_data_elements_for_step($state, &$data) {
+ if (!empty($state->answer)) {
+ $data['answer'] = $state->answer;
+ }
+ }
+}
+
+
+class qtype_description_updater extends qtype_updater {
+ public function right_answer() {
+ return '';
+ }
+
+ public function was_answered($state) {
+ return false;
+ }
+
+ public function response_summary($state) {
+ return '';
+ }
+
+ public function set_first_step_data_elements($state, &$data) {
+ }
+
+ public function supply_missing_first_step_data(&$data) {
+ }
+
+ public function set_data_elements_for_step($state, &$data) {
+ }
+}
+
+
+class qtype_truefalse_updater extends qtype_updater {
+ public function right_answer() {
+ foreach ($this->question->options->answers as $ans) {
+ if ($ans->fraction > 0.999) {
+ return $ans->answer;
+ }
+ }
+ }
+
+ public function response_summary($state) {
+ if (is_numeric($state->answer)) {
+ if (array_key_exists($state->answer, $this->question->options->answers)) {
+ return $this->question->options->answers[$state->answer]->answer;
+ } else {
+ $this->logger->log_assumption("Dealing with a place where the
+ student selected a choice that was later deleted for
+ true/false question {$this->question->id}");
+ return null;
+ }
+ } else {
+ return null;
+ }
+ }
+
+ public function was_answered($state) {
+ return !empty($state->answer);
+ }
+
+ public function set_first_step_data_elements($state, &$data) {
+ }
+
+ public function supply_missing_first_step_data(&$data) {
+ }
+
+ public function set_data_elements_for_step($state, &$data) {
+ if (is_numeric($state->answer)) {
+ $data['answer'] = (int) ($state->answer == $this->question->options->trueanswer);
+ }
+ }
+}
+
+
+class qtype_match_updater extends qtype_updater {
+ protected $stems;
+ protected $choices;
+ protected $right;
+ protected $stemorder;
+ protected $choiceorder;
+ protected $flippedchoiceorder;
+
+ public function question_summary() {
+ $this->stems = array();
+ $this->choices = array();
+ $this->right = array();
+
+ foreach ($this->question->options->subquestions as $matchsub) {
+ $ans = $matchsub->answertext;
+ $key = array_search($matchsub->answertext, $this->choices);
+ if ($key === false) {
+ $key = $matchsub->id;
+ $this->choices[$key] = $matchsub->answertext;
+ }
+
+ if ($matchsub->questiontext !== '') {
+ $this->stems[$matchsub->id] = $this->to_text($matchsub->questiontext);
+ $this->right[$matchsub->id] = $key;
+ }
+ }
+
+ return $this->to_text($this->question->questiontext) . ' {' .
+ implode('; ', $this->stems) . '} -> {' . implode('; ', $this->choices) . '}';
+ }
+
+ public function right_answer() {
+ $answer = array();
+ foreach ($this->stems as $key => $stem) {
+ $answer[$stem] = $this->choices[$this->right[$key]];
+ }
+ return $this->make_summary($answer);
+ }
+
+ protected function explode_answer($answer) {
+ if (!$answer) {
+ return array();
+ }
+ $bits = explode(',', $answer);
+ $selections = array();
+ foreach ($bits as $bit) {
+ list($stem, $choice) = explode('-', $bit);
+ $selections[$stem] = $choice;
+ }
+ return $selections;
+ }
+
+ protected function make_summary($pairs) {
+ $bits = array();
+ foreach ($pairs as $stem => $answer) {
+ $bits[] = $stem . ' -> ' . $answer;
+ }
+ return implode('; ', $bits);
+ }
+
+ protected function lookup_choice($choice) {
+ foreach ($this->question->options->subquestions as $matchsub) {
+ if ($matchsub->code == $choice) {
+ if (array_key_exists($matchsub->id, $this->choices)) {
+ return $matchsub->id;
+ } else {
+ return array_search($matchsub->answertext, $this->choices);
+ }
+ }
+ }
+ return null;
+ }
+
+ public function response_summary($state) {
+ $choices = $this->explode_answer($state->answer);
+ if (empty($choices)) {
+ return null;
+ }
+
+ $pairs = array();
+ foreach ($choices as $stemid => $choicekey) {
+ if (array_key_exists($stemid, $this->stems) && $choices[$stemid]) {
+ $choiceid = $this->lookup_choice($choicekey);
+ if ($choiceid) {
+ $pairs[$this->stems[$stemid]] = $this->choices[$choiceid];
+ } else {
+ $this->logger->log_assumption("Dealing with a place where the
+ student selected a choice that was later deleted for
+ match question {$this->question->id}");
+ $pairs[$this->stems[$stemid]] = '[CHOICE THAT WAS LATER DELETED]';
+ }
+ }
+ }
+
+ if ($pairs) {
+ return $this->make_summary($pairs);
+ } else {
+ return '';
+ }
+ }
+
+ public function was_answered($state) {
+ $choices = $this->explode_answer($state->answer);
+ foreach ($choices as $choice) {
+ if ($choice) {
+ return true;
+ }
+ }
+ return false;
+ }
+
+ public function set_first_step_data_elements($state, &$data) {
+ $choices = $this->explode_answer($state->answer);
+ foreach ($choices as $key => $notused) {
+ if (array_key_exists($key, $this->stems)) {
+ $this->stemorder[] = $key;
+ }
+ }
+
+ $this->choiceorder = array_keys($this->choices);
+ shuffle($this->choiceorder);
+ $this->flippedchoiceorder = array_combine(array_values($this->choiceorder), array_keys($this->choiceorder));
+
+ $data['_stemorder'] = implode(',', $this->stemorder);
+ $data['_choiceorder'] = implode(',', $this->choiceorder);
+ }
+
+ public function supply_missing_first_step_data(&$data) {
+ throw new coding_exception('qtype_match_updater::supply_missing_first_step_data not tested');
+ $data['_stemorder'] = array_keys($this->stems);
+ $data['_choiceorder'] = shuffle(array_keys($this->choices));
+ }
+
+ public function set_data_elements_for_step($state, &$data) {
+ $choices = $this->explode_answer($state->answer);
+
+ foreach ($this->stemorder as $i => $key) {
+ if (empty($choices[$key])) {
+ $data['sub' . $i] = 0;
+ continue;
+ }
+ $choice = $this->lookup_choice($choices[$key]);
+
+ if (array_key_exists($choice, $this->flippedchoiceorder)) {
+ $data['sub' . $i] = $this->flippedchoiceorder[$choice] + 1;
+ } else {
+ $data['sub' . $i] = 0;
+ }
+ }
+ }
+}
+
+
+class qtype_oumultiresponse_updater extends qtype_updater {
+ public function question_summary() {
+ $bits = array();
+ foreach ($this->question->options->answers as $ans) {
+ $bits[] = $this->to_text($ans->answer);
+ }
+ return parent::question_summary() . ': ' . implode('; ', $bits);
+ }
+
+ public function right_answer() {
+ $rightbits = array();
+ foreach ($this->question->options->answers as $ans) {
+ if ($ans->fraction >= 0.5) {
+ $rightbits[] = $this->to_text($ans->answer);
+ }
+ }
+ return implode('; ', $rightbits);
+ }
+
+ protected function parse_response($answer) {
+ if (strpos($answer, ':') === false) {
+ $this->logger->log_assumption("Dealing with missing order information
+ in attempt at oumultiresponse question {$this->question->id}");
+ return array(null, $responses);
+ }
+
+ list($order, $responsepart) = explode(':', $answer);
+ $bits = explode(',', $responsepart);
+
+ $responses = array();
+ if ($responsepart) {
+ foreach ($bits as $bit) {
+ if (strpos($bit, 'h')) {
+ list($choice, $history) = explode('h', $bit);
+ if (substr($history, -1) === '1') {
+ $responses[] = $choice;
+ }
+ } else {
+ // Very old code did this.
+ list($choice, $grade) = explode('g', $bit);
+ if ($grade > 0) {
+ $responses[] = $choice;
+ }
+ }
+ }
+ }
+
+ return array($order, $responses);
+ }
+
+ public function response_summary($state) {
+ list($order, $responses) = $this->parse_response($state->answer);
+
+ $bits = array();
+ foreach ($responses as $response) {
+ $bits[] = $this->to_text($this->question->options->answers[$response]->answer);
+ }
+ return implode('; ', $bits);
+ }
+
+ public function was_answered($state) {
+ list($order, $responses) = explode(':', $state->answer);
+ return !empty($responses);
+ }
+
+ public function set_first_step_data_elements($state, &$data) {
+ list($order, $responses) = $this->parse_response($state->answer);
+ $data['_order'] = $order;
+ }
+
+ public function supply_missing_first_step_data(&$data) {
+ throw new coding_exception('qtype_oumultiresponse_updater::supply_missing_first_step_data not tested');
+ $data['_order'] = implode(',', array_keys($this->question->option->answers));
+ }
+
+ public function set_data_elements_for_step($state, &$data) {
+ list($order, $responses) = $this->parse_response($state->answer);
+ $order = explode(',', $order);
+
+ foreach ($order as $key => $ans) {
+ if (in_array($ans, $responses)) {
+ $data['choice' . $key] = 1;
+ } else {
+ $data['choice' . $key] = 0;
+ }
+ }
+ }
+}
+
+
+class qtype_ddwtos_updater extends qtype_updater {
+ protected $choices;
+ protected $rightchoices;
+ protected $places;
+ protected $choiceindexmap;
+ protected $shuffleorders;
+
+ public function question_summary() {
+ $this->choices = array();
+ $choiceindexmap = array();
+
+ // Store the choices in arrays by group.
+ $i = 1;
+ foreach ($this->question->options->answers as $choicedata) {
+ $options = unserialize($choicedata->feedback);
+
+ if (array_key_exists($options->draggroup, $this->choices)) {
+ $this->choices[$options->draggroup][] = $choicedata->answer;
+ } else {
+ $this->choices[$options->draggroup][1] = $choicedata->answer;
+ }
+
+ end($this->choices[$options->draggroup]);
+ $this->choiceindexmap[$i] = array($options->draggroup, $choicedata->answer,
+ key($this->choices[$options->draggroup]));
+ $i += 1;
+ }
+
+ $this->places = array();
+ $this->rightchoices = array();
+
+ // Break up the question text, and store the fragments, places and right answers.
+ $bits = preg_split('/\[\[(\d+)]]/', $this->question->questiontext, null, PREG_SPLIT_DELIM_CAPTURE);
+ array_shift($bits);
+ $i = 1;
+
+ while (!empty($bits)) {
+ $choice = array_shift($bits);
+
+ list($group, $choicetext, $choiceindex) = $this->choiceindexmap[$choice];
+ $this->places[$i] = $group;
+ $this->rightchoices[$i] = $choicetext;
+
+ array_shift($bits);
+ $i += 1;
+ }
+
+ $bits = array(parent::question_summary());
+ foreach ($this->places as $place => $group) {
+ $bits[] = '[[' . $place . ']] -> {' .
+ implode(' / ', $this->choices[$group]) . '}';
+ }
+ return implode('; ', $bits);
+ }
+
+ public function right_answer() {
+ return $this->make_summary($this->rightchoices);
+ }
+
+ public function compare_answers($answer1, $answer2) {
+ list($answer1) = explode('=', $answer1);
+ list($answer2) = explode('=', $answer2);
+ return $answer1 == $answer2;
+ }
+
+ protected function explode_answer($answer) {
+ list($answer) = explode('=', $answer);
+ if (!$answer) {
+ return array();
+ }
+
+ $bits = explode(';', $answer);
+
+ $selections = array();
+ foreach ($bits as $bit) {
+ list($place, $choice) = explode('-', $bit);
+ if ($place === '' || $choice === '0') {
+ continue;
+ }
+
+ $selections[$place + 1] = $choice;
+ }
+
+ return $selections;
+ }
+
+ protected function make_summary($choices) {
+ $answers = array();
+ $allblank = true;
+ foreach ($choices as $group => $ans) {
+ $answers[] = '{' . $ans . '}';
+ $allblank = $allblank && ($ans === '');
+ }
+ if ($allblank) {
+ return '';
+ } else {
+ return implode(' ', $answers);
+ }
+ }
+
+ public function response_summary($state) {
+ $choices = $this->explode_answer($state->answer);
+
+ $answers = array();
+ $allblank = true;
+ foreach ($this->places as $place => $group) {
+ if (array_key_exists($place, $choices) && $choices[$place]) {
+ list($notused, $choicetext, $choiceindex) =
+ $this->choiceindexmap[$choices[$place]];
+ $answers[$place] = $choicetext;
+ } else {
+ $answers[$place] = '';
+ }
+ }
+ return $this->make_summary($answers);
+ }
+
+ public function was_answered($state) {
+ $choices = $this->explode_answer($state->answer);
+ foreach ($choices as $choice) {
+ if ($choice) {
+ return true;
+ }
+ }
+ return false;
+ }
+
+ public function set_first_step_data_elements($state, &$data) {
+ foreach ($this->choices as $group => $notused) {
+ $this->shuffleorders[$group] = array_keys($this->choices[$group]);
+ if ($this->question->options->shuffleanswers) {
+ srand($state->attempt);
+ shuffle($this->shuffleorders[$group]);
+ }
+ $this->shuffleorders[$group] = array_combine(
+ array_values($this->shuffleorders[$group]), array_keys($this->shuffleorders[$group]));
+ }
+
+ foreach ($this->choices as $group => $choices) {
+ $indices = array();
+ foreach ($this->shuffleorders[$group] as $key => $notused) {
+ $indices[] = $key;
+ }
+ $data['_choiceorder' . $group] = implode(',', $indices);
+ }
+ }
+
+ public function supply_missing_first_step_data(&$data) {
+ throw new coding_exception('qtype_ddwtos_updater::supply_missing_first_step_data not implemented');
+ }
+
+ public function set_data_elements_for_step($state, &$data) {
+ $choices = $this->explode_answer($state->answer);
+
+ foreach ($this->places as $place => $group) {
+ if (array_key_exists($place, $choices) &&
+ array_key_exists($choices[$place], $this->choiceindexmap)) {
+ list($notused, $choicetext, $choiceindex) =
+ $this->choiceindexmap[$choices[$place]];
+ $data['p' . $place] = $this->shuffleorders[$this->places[$place]][$choiceindex] + 1;
+ } else {
+ $data['p' . $place] = 0;
+ }
+ }
+ }
+}
+
+
+class qtype_opaque_updater extends qtype_updater {
+ public function question_summary() {
+ return $this->question->options->remoteid . '.' . $this->question->options->remoteversion;
+ }
+
+ public function right_answer() {
+ return '[UNKNOWN]';
+ }
+
+ protected function explode_answer($answer) {
+ // We store the reponses by turning the associative array $state->responses
+ // into a string as follows. For example, array('f2' => 'No, never - ever', 'f1' => '10')
+ // becomes 'f1-10,f2-No\, never - ever'. That is, comma separated pairs, sorted by key,
+ // key and value linked with a '-', commas in vales escaped with '\'.
+
+ // Deal with special case: no responses at all.
+ if (empty($answer)) {
+ return array();
+ }
+
+ // Split the responses on non-backslash-escaped commas.
+ $bits = preg_split('/(?responses properly.
+ $responses = array();
+ foreach ($bits as $reponse) {
+ list($key, $value) = explode('-', $reponse, 2);
+ $responses[$key] = str_replace('\,', ',', $value);
+ }
+
+ return $responses;
+ }
+
+ public function response_summary($state) {
+ $responses = $this->explode_answer($state->answer);
+
+ if (!empty($responses['__answerLine'])) {
+ return $responses['__answerLine'];
+
+ } else if (!empty($responses['__actionSummary'])) {
+ return $responses['__actionSummary'];
+
+ } else {
+ return implode(', ', $responses);
+ }
+ }
+
+ public function was_answered($state) {
+ return false;
+ }
+
+ public function set_first_step_data_elements($state, &$data) {
+ $responses = $this->explode_answer($state->answer);
+ foreach ($responses as $name => $value) {
+ if ($name == '__randomseed') {
+ $data['-_randomseed'] = $value;
+ } else {
+ $data[$name] = $value;
+ }
+ }
+ }
+
+ public function supply_missing_first_step_data(&$data) {
+ $data['-_randomseed'] = rand();
+ }
+
+ public function set_data_elements_for_step($state, &$data) {
+ $responses = $this->explode_answer($state->answer);
+ foreach ($responses as $name => $value) {
+ if ($name == '__questionLine') {
+ continue;
+ } else if ($name == '__actionSummary') {
+ $name = '-_actionSummary';
+ }
+ $data[$name] = $value;
+ }
+ }
+}
+
+class qtype_deleted_updater extends qtype_updater {
+ public function right_answer() {
+ return '';
+ }
+
+ public function response_summary($state) {
+ return $state->answer;
+ }
+
+ public function was_answered($state) {
+ return !empty($state->answer);
+ }
+
+ public function set_first_step_data_elements($state, &$data) {
+ $data['upgradedfromdeletedquestion'] = $state->answer;
+ }
+
+ public function supply_missing_first_step_data(&$data) {
+ }
+
+ public function set_data_elements_for_step($state, &$data) {
+ $data['upgradedfromdeletedquestion'] = $state->answer;
+ }
+}
diff --git a/question/file.php b/question/file.php
index b6ea0470473..ac9a133faed 100644
--- a/question/file.php
+++ b/question/file.php
@@ -1,86 +1,111 @@
.
+
+
+/**
+ * This script fetches files from the dataroot/questionattempt directory
+ * It is based on the top-level file.php
+ *
+ * On a module-by-module basis (currently only implemented for quiz), it checks
+ * whether the user has permission to view the file.
+ *
+ * Syntax: question/file.php/attemptid/questionid/filename.ext
+ * Workaround: question/file.php?file=/attemptid/questionid/filename.ext
+ *
+ * @package moodlecore
+ * @subpackage questionengine
+ * @copyright 2007 Adriane Boyd
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
// disable moodle specific debug messages and any errors in output
define('NO_DEBUG_DISPLAY', true);
- require_once('../config.php');
- require_once('../lib/filelib.php');
- $relativepath = get_file_argument();
- // force download for any student-submitted files to prevent XSS attacks.
- $forcedownload = 1;
+require_once('../config.php');
+require_once('../lib/filelib.php');
- // relative path must start with '/', because of backup/restore!!!
- if (!$relativepath) {
- print_error('invalidarguments');
- } else if ($relativepath{0} != '/') {
- print_error('pathdoesnotstartslash');
+$relativepath = get_file_argument();
+// force download for any student-submitted files to prevent XSS attacks.
+$forcedownload = 1;
+
+// relative path must start with '/', because of backup/restore!!!
+if (!$relativepath) {
+ print_error('invalidarguments');
+} else if ($relativepath{0} != '/') {
+ print_error('pathdoesnotstartslash');
+}
+
+$pathname = $CFG->dataroot.'/questionattempt'.$relativepath;
+
+// extract relative path components
+$args = explode('/', trim($relativepath, '/'));
+
+// check for the right number of directories in the path
+if (count($args) != 3) {
+ print_error('invalidarguments');
+}
+
+// security: require login
+require_login();
+
+// security: do not return directory node!
+if (is_dir($pathname)) {
+ question_attempt_not_found();
+}
+
+$lifetime = 0; // do not cache because students may reupload files
+
+// security: check that the user has permission to access this file
+$haspermission = false;
+if ($attempt = $DB->get_record("question_attempts", array("id" => $args[0]))) {
+ $modfile = $CFG->dirroot .'/mod/'. $attempt->modulename .'/lib.php';
+ $modcheckfileaccess = $attempt->modulename .'_check_file_access';
+ if (file_exists($modfile)) {
+ @require_once($modfile);
+ if (function_exists($modcheckfileaccess)) {
+ $haspermission = $modcheckfileaccess($args[0], $args[1]);
+ }
}
-
- $pathname = $CFG->dataroot.'/questionattempt'.$relativepath;
-
- // extract relative path components
- $args = explode('/', trim($relativepath, '/'));
-
- // check for the right number of directories in the path
- if (count($args) != 3) {
- print_error('invalidarguments');
+} else if ($args[0][0] == 0) {
+ global $USER;
+ $list = explode('_', $args[0]);
+ if ($list[1] == $USER->id) {
+ $haspermission = true;
}
+}
- // security: require login
- require_login();
-
- // security: do not return directory node!
- if (is_dir($pathname)) {
+if ($haspermission) {
+ // check that file exists
+ if (!file_exists($pathname)) {
question_attempt_not_found();
}
- $lifetime = 0; // do not cache because students may reupload files
-
- // security: check that the user has permission to access this file
- $haspermission = false;
- if ($attempt = $DB->get_record("question_attempts", array("id" => $args[0]))) {
- $modfile = $CFG->dirroot .'/mod/'. $attempt->modulename .'/lib.php';
- $modcheckfileaccess = $attempt->modulename .'_check_file_access';
- if (file_exists($modfile)) {
- @require_once($modfile);
- if (function_exists($modcheckfileaccess)) {
- $haspermission = $modcheckfileaccess($args[0], $args[1]);
- }
- }
- } else if ($args[0][0] == 0) {
- global $USER;
- $list = explode('_', $args[0]);
- if ($list[1] == $USER->id) {
- $haspermission = true;
- }
- }
-
- if ($haspermission) {
- // check that file exists
- if (!file_exists($pathname)) {
- question_attempt_not_found();
- }
-
- // send the file
- session_get_instance()->write_close(); // unlock session during fileserving
- $filename = $args[count($args)-1];
- send_file($pathname, $filename, $lifetime, $CFG->filteruploadedfiles, false, $forcedownload);
- } else {
- question_attempt_not_found();
- }
-
- function question_attempt_not_found() {
- global $CFG;
- header('HTTP/1.0 404 not found');
- print_error('filenotfound', 'error', $CFG->wwwroot); //this is not displayed on IIS??
- }
+ // send the file
+ session_get_instance()->write_close(); // unlock session during fileserving
+ $filename = $args[count($args)-1];
+ send_file($pathname, $filename, $lifetime, $CFG->filteruploadedfiles, false, $forcedownload);
+} else {
+ question_attempt_not_found();
+}
+function question_attempt_not_found() {
+ global $CFG;
+ header('HTTP/1.0 404 not found');
+ print_error('filenotfound', 'error', $CFG->wwwroot); //this is not displayed on IIS??
+}
diff --git a/question/format/examview/format.php b/question/format/examview/format.php
old mode 100755
new mode 100644
diff --git a/question/format/gift/format.php b/question/format/gift/format.php
old mode 100755
new mode 100644
diff --git a/question/format/learnwise/format.php b/question/format/learnwise/format.php
old mode 100755
new mode 100644
diff --git a/question/format/qti_two/templates/choice.tpl b/question/format/qti_two/templates/choice.tpl
old mode 100755
new mode 100644
diff --git a/question/format/qti_two/templates/choiceMultiple.tpl b/question/format/qti_two/templates/choiceMultiple.tpl
old mode 100755
new mode 100644
diff --git a/question/format/qti_two/templates/composite.tpl b/question/format/qti_two/templates/composite.tpl
old mode 100755
new mode 100644
diff --git a/question/format/qti_two/templates/extendedText.tpl b/question/format/qti_two/templates/extendedText.tpl
old mode 100755
new mode 100644
diff --git a/question/format/qti_two/templates/extendedText_simpleEssay.tpl b/question/format/qti_two/templates/extendedText_simpleEssay.tpl
old mode 100755
new mode 100644
diff --git a/question/format/qti_two/templates/imsmanifest.tpl b/question/format/qti_two/templates/imsmanifest.tpl
old mode 100755
new mode 100644
diff --git a/question/format/qti_two/templates/mmchoiceMultiple.tpl b/question/format/qti_two/templates/mmchoiceMultiple.tpl
old mode 100755
new mode 100644
diff --git a/question/format/qti_two/templates/notimplemented.tpl b/question/format/qti_two/templates/notimplemented.tpl
old mode 100755
new mode 100644
diff --git a/question/format/qti_two/templates/numerical.tpl b/question/format/qti_two/templates/numerical.tpl
old mode 100755
new mode 100644
diff --git a/question/format/qti_two/templates/textEntry.tpl b/question/format/qti_two/templates/textEntry.tpl
old mode 100755
new mode 100644
diff --git a/question/format/xhtml/format.php b/question/format/xhtml/format.php
old mode 100755
new mode 100644
diff --git a/question/format/xml/format.php b/question/format/xml/format.php
old mode 100755
new mode 100644
diff --git a/question/import_form.php b/question/import_form.php
index f585e29e51e..30408a655c5 100644
--- a/question/import_form.php
+++ b/question/import_form.php
@@ -78,5 +78,23 @@ class question_import_form extends moodleform {
$template = "{help} {element}\n";
$renderer->setGroupElementTemplate($template, 'format');
}
+
+ public function validation($data, $files){
+ $errors = parent::validation($data, $files);
+ return $errors; // TODO.
+ // If a file is uploaded return
+ if ($data['choosefile'] || $files['newfile']) {
+ return $errors;
+ }
+ // If file is not uploaded from file upload
+ if (!$files['newfile']) {
+ $errors['newfile'] = get_string('importfromupload', 'question');
+ }
+ // If filke is not imported from course files
+ if (!$data['choosefile'] && !$files['newfile']) {
+ $errors['choosefile'] = get_string('importfromcoursefiles', 'question');
+ }
+ return $errors;
+ }
}
diff --git a/question/move_form.php b/question/move_form.php
index e5b6a4afcc5..f173004bba9 100644
--- a/question/move_form.php
+++ b/question/move_form.php
@@ -1,5 +1,30 @@
.
+
+
+/**
+ * Form for moving questions between categories.
+ *
+ * @package moodlecore
+ * @subpackage questionbank
+ * @copyright 2008 The Open University
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
if (!defined('MOODLE_INTERNAL')) {
die('Direct access to this script is forbidden.'); /// It must be included from a Moodle page
}
@@ -7,22 +32,17 @@ if (!defined('MOODLE_INTERNAL')) {
require_once($CFG->libdir.'/formslib.php');
class question_move_form extends moodleform {
-
function definition() {
- $mform =& $this->_form;
+ $mform = $this->_form;
- $currentcat = $this->_customdata['currentcat'];
- $contexts = $this->_customdata['contexts'];
-//--------------------------------------------------------------------------------
+ $currentcat = $this->_customdata['currentcat'];
+ $contexts = $this->_customdata['contexts'];
$mform->addElement('questioncategory', 'category', get_string('category','quiz'), compact('contexts', 'currentcat'));
-
-//--------------------------------------------------------------------------------
$this->add_action_buttons(true, get_string('categorymoveto', 'quiz'));
-//--------------------------------------------------------------------------------
+
$mform->addElement('hidden', 'delete', $currentcat);
$mform->setType('delete', PARAM_INT);
}
}
-
diff --git a/question/preview.js b/question/preview.js
new file mode 100644
index 00000000000..c502d8d653b
--- /dev/null
+++ b/question/preview.js
@@ -0,0 +1,46 @@
+// This file is part of Moodle - http://moodle.org/
+//
+// Moodle is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// Moodle is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with Moodle. If not, see ![' . get_string('flagthisquestion', 'question') . ']()
';
+ }
+
+ /**
+ * Get a link to an edit icon for this question, if the current user is allowed
+ * to edit it.
+ *
+ * @param object $question the question object.
+ * @param object $cmoptions the options from the module. If $cmoptions->thispageurl is set
+ * then the link will be to edit the question in this browser window, then return to
+ * $cmoptions->thispageurl. Otherwise the link will be to edit in a popup.
+ * @return string the HTML of the link, or nothing it the currenty user is not allowed to edit.
+ */
+ function get_question_edit_link($question, $cmoptions, $options) {
+ global $CFG, $OUTPUT;
+
+ /// Is this user allowed to edit this question?
+ if (!empty($options->noeditlink) || !question_has_capability_on($question, 'edit')) {
+ return '';
+ }
+
+ /// Work out the right URL.
+ $url = new moodle_url('/question/question.php', array('id' => $question->id));
+ if (!empty($cmoptions->cmid)) {
+ $url->param('cmid', $cmoptions->cmid);
+ } else if (!empty($cmoptions->course)) {
+ $url->param('courseid', $cmoptions->course);
+ } else {
+ print_error('missingcourseorcmidtolink', 'question');
+ }
+
+ $icon = new pix_icon('t/edit', get_string('edit'));
+
+ $action = null;
+ if (!empty($cmoptions->thispageurl)) {
+ // The module allow editing in the same window, print an ordinary
+ // link with a returnurl.
+ $url->param('returnurl', $cmoptions->thispageurl);
+ } else {
+ // We have to edit in a pop-up.
+ $url->param('inpopup', 1);
+ $action = new popup_action('click', $link, 'editquestion');
+ }
+
+ return $OUTPUT->action_icon($url, $icon, $action);
+ }
+
+ /**
+ * Print history of responses
+ *
+ * Used by print_question()
+ */
+ function history($question, $state, $number, $cmoptions, $options) {
+ global $DB, $OUTPUT;
+
+ if (empty($options->history)) {
+ return '';
+ }
+
+ $params = array('aid' => $state->attempt);
+ if (isset($question->randomquestionid)) {
+ $params['qid'] = $question->randomquestionid;
+ $randomprefix = 'random' . $question->id . '-';
+ } else {
+ $params['qid'] = $question->id;
+ $randomprefix = '';
+ }
+ if ($options->history == 'all') {
+ $eventtest = 'event > 0';
+ } else {
+ $eventtest = 'event IN (' . QUESTION_EVENTS_GRADED . ')';
+ }
+ $states = $DB->get_records_select('question_states',
+ 'attempt = :aid AND question = :qid AND ' . $eventtest, $params, 'seq_number ASC');
+ if (count($states) <= 1) {
+ return '';
+ }
+
+ $strreviewquestion = get_string('reviewresponse', 'quiz');
+ $table = new html_table();
+ $table->width = '100%';
+ $table->head = array (
+ get_string('numberabbr', 'quiz'),
+ get_string('action', 'quiz'),
+ get_string('response', 'quiz'),
+ get_string('time'),
+ );
+ if ($options->scores) {
+ $table->head[] = get_string('score', 'quiz');
+ $table->head[] = get_string('grade', 'quiz');
+ }
+
+ foreach ($states as $st) {
+ if ($randomprefix && strpos($st->answer, $randomprefix) === 0) {
+ $st->answer = substr($st->answer, strlen($randomprefix));
+ }
+ $st->responses[''] = $st->answer;
+ $this->restore_session_and_responses($question, $st);
+
+ if ($state->id == $st->id) {
+ $link = '' . $st->seq_number . '';
+ } else if (isset($options->questionreviewlink)) {
+ $reviewlink = new moodle_url($options->questionreviewlink);
+ $reviewlink->params(array('state'=>$st->id,'question'=>$question->id));
+ $link = new moodle_url($reviewlink);
+ $action = new popup_action('click', $link, 'reviewquestion', array('height' => 450, 'width' => 650));
+ $link = $OUTPUT->action_link($link, $st->seq_number, $action, array('title'=>$strreviewquestion));
+ } else {
+ $link = $st->seq_number;
+ }
+
+ if ($state->id == $st->id) {
+ $b = '';
+ $be = '';
+ } else {
+ $b = '';
+ $be = '';
+ }
+
+ $data = array (
+ $link,
+ $b.get_string('event'.$st->event, 'quiz').$be,
+ $b.$this->response_summary($question, $st).$be,
+ $b.userdate($st->timestamp, get_string('timestr', 'quiz')).$be,
+ );
+ if ($options->scores) {
+ $data[] = $b.question_format_grade($cmoptions, $st->raw_grade).$be;
+ $data[] = $b.question_format_grade($cmoptions, $st->raw_grade).$be;
+ }
+ $table->data[] = $data;
+ }
+ return html_writer::table($table);
+ }
+
+ /**
+ * Prints the score obtained and maximum score available plus any penalty
+ * information
+ *
+ * This function prints a summary of the scoring in the most recently
+ * graded state (the question may not have been submitted for marking at
+ * the current state). The default implementation should be suitable for most
+ * question types.
+ * @param object $question The question for which the grading details are
+ * to be rendered. Question type specific information
+ * is included. The maximum possible grade is in
+ * ->maxgrade.
+ * @param object $state The state. In particular the grading information
+ * is in ->grade, ->raw_grade and ->penalty.
+ * @param object $cmoptions
+ * @param object $options An object describing the rendering options.
+ */
+ function print_question_grading_details(&$question, &$state, $cmoptions, $options) {
+ /* The default implementation prints the number of marks if no attempt
+ has been made. Otherwise it displays the grade obtained out of the
+ maximum grade available and a warning if a penalty was applied for the
+ attempt and displays the overall grade obtained counting all previous
+ responses (and penalties) */
+
+ if (QUESTION_EVENTDUPLICATE == $state->event) {
+ echo ' ';
+ print_string('duplicateresponse', 'quiz');
+ }
+ if ($question->maxgrade > 0 && $options->scores) {
+ if (question_state_is_graded($state->last_graded)) {
+ // Display the grading details from the last graded state
+ $grade = new stdClass;
+ $grade->cur = question_format_grade($cmoptions, $state->last_graded->grade);
+ $grade->max = question_format_grade($cmoptions, $question->maxgrade);
+ $grade->raw = question_format_grade($cmoptions, $state->last_graded->raw_grade);
+
+ // let student know wether the answer was correct
+ $class = question_get_feedback_class($state->last_graded->raw_grade /
+ $question->maxgrade);
+ echo '\n";
+ $expout .= $format->writetext($answer->answer, 3, false);
+ $expout .= " \n";
+ $expout .= $format->writetext($answer->feedback, 4, false);
+ $expout .= " \n";
+ $expout .= " \n";
+ }
+ }
+ return $expout;
+ }
+
+ /**
+ * Abstract function implemented by each question type. It runs all the code
+ * required to set up and save a question of any type for testing purposes.
+ * Alternate DB table prefix may be used to facilitate data deletion.
+ */
+ function generate_test($name, $courseid=null) {
+ $form = new stdClass();
+ $form->name = $name;
+ $form->questiontextformat = 1;
+ $form->questiontext = 'test question, generated by script';
+ $form->defaultgrade = 1;
+ $form->penalty = 0.1;
+ $form->generalfeedback = "Well done";
+
+ $context = get_context_instance(CONTEXT_COURSE, $courseid);
+ $newcategory = question_make_default_categories(array($context));
+ $form->category = $newcategory->id . ',1';
+
+ $question = new stdClass();
+ $question->courseid = $courseid;
+ $question->qtype = $this->qtype;
+ return array($form, $question);
+ }
+
+ /**
+ * Get question context by category id
+ * @param int $category
+ * @return object $context
+ */
+ function get_context_by_category_id($category) {
+ global $DB;
+ $contextid = $DB->get_field('question_categories', 'contextid', array('id'=>$category));
+ $context = get_context_instance_by_id($contextid);
+ return $context;
+ }
+
+ /**
+ * Save the file belonging to one text field.
+ *
+ * @param array $field the data from the form (or from import). This will
+ * normally have come from the formslib editor element, so it will be an
+ * array with keys 'text', 'format' and 'itemid'. However, when we are
+ * importing, it will be an array with keys 'text', 'format' and 'files'
+ * @param object $context the context the question is in.
+ * @param string $component indentifies the file area question.
+ * @param string $filearea indentifies the file area questiontext, generalfeedback,answerfeedback.
+ * @param integer $itemid identifies the file area.
+ *
+ * @return string the text for this field, after files have been processed.
+ */
+ protected function import_or_save_files($field, $context, $component, $filearea, $itemid) {
+ if (!empty($field['itemid'])) {
+ // This is the normal case. We are safing the questions editing form.
+ return file_save_draft_area_files($field['itemid'], $context->id, $component,
+ $filearea, $itemid, $this->fileoptions, trim($field['text']));
+
+ } else if (!empty($field['files'])) {
+ // This is the case when we are doing an import.
+ foreach ($field['files'] as $file) {
+ $this->import_file($context, $component, $filearea, $itemid, $file);
+ }
+ }
+ return trim($field['text']);
+ }
+
+ /**
+ * Move all the files belonging to this question from one context to another.
+ * @param integer $questionid the question being moved.
+ * @param integer $oldcontextid the context it is moving from.
+ * @param integer $newcontextid the context it is moving to.
+ */
+ public function move_files($questionid, $oldcontextid, $newcontextid) {
+ $fs = get_file_storage();
+ $fs->move_area_files_to_new_context($oldcontextid,
+ $newcontextid, 'question', 'questiontext', $questionid);
+ $fs->move_area_files_to_new_context($oldcontextid,
+ $newcontextid, 'question', 'generalfeedback', $questionid);
+ }
+
+ /**
+ * Move all the files belonging to this question's answers when the question
+ * is moved from one context to another.
+ * @param integer $questionid the question being moved.
+ * @param integer $oldcontextid the context it is moving from.
+ * @param integer $newcontextid the context it is moving to.
+ * @param boolean $answerstoo whether there is an 'answer' question area,
+ * as well as an 'answerfeedback' one. Default false.
+ */
+ protected function move_files_in_answers($questionid, $oldcontextid, $newcontextid, $answerstoo = false) {
+ global $DB;
+ $fs = get_file_storage();
+
+ $answerids = $DB->get_records_menu('question_answers',
+ array('question' => $questionid), 'id', 'id,1');
+ foreach ($answerids as $answerid => $notused) {
+ if ($answerstoo) {
+ $fs->move_area_files_to_new_context($oldcontextid,
+ $newcontextid, 'question', 'answer', $answerid);
+ }
+ $fs->move_area_files_to_new_context($oldcontextid,
+ $newcontextid, 'question', 'answerfeedback', $answerid);
+ }
+ }
+
+ /**
+ * Delete all the files belonging to this question.
+ * @param integer $questionid the question being deleted.
+ * @param integer $contextid the context the question is in.
+ */
+ protected function delete_files($questionid, $contextid) {
+ $fs = get_file_storage();
+ $fs->delete_area_files($contextid, 'question', 'questiontext', $questionid);
+ $fs->delete_area_files($contextid, 'question', 'generalfeedback', $questionid);
+ }
+
+ /**
+ * Delete all the files belonging to this question's answers.
+ * @param integer $questionid the question being deleted.
+ * @param integer $contextid the context the question is in.
+ * @param boolean $answerstoo whether there is an 'answer' question area,
+ * as well as an 'answerfeedback' one. Default false.
+ */
+ protected function delete_files_in_answers($questionid, $contextid, $answerstoo = false) {
+ global $DB;
+ $fs = get_file_storage();
+
+ $answerids = $DB->get_records_menu('question_answers',
+ array('question' => $questionid), 'id', 'id,1');
+ foreach ($answerids as $answerid => $notused) {
+ if ($answerstoo) {
+ $fs->delete_area_files($contextid, 'question', 'answer', $answerid);
+ }
+ $fs->delete_area_files($contextid, 'question', 'answerfeedback', $answerid);
+ }
+ }
+
+ function import_file($context, $component, $filearea, $itemid, $file) {
+ $fs = get_file_storage();
+ $record = new stdclass;
+ if (is_object($context)) {
+ $record->contextid = $context->id;
+ } else {
+ $record->contextid = $context;
+ }
+ $record->component = $component;
+ $record->filearea = $filearea;
+ $record->itemid = $itemid;
+ $record->filename = $file->name;
+ $record->filepath = '/';
+ return $fs->create_file_from_string($record, $this->decode_file($file));
+ }
+
+ function decode_file($file) {
+ switch ($file->encoding) {
+ case 'base64':
+ default:
+ return base64_decode($file->content);
+ }
+ }
+}
diff --git a/question/type/questionbase.php b/question/type/questionbase.php
new file mode 100644
index 00000000000..bc3b8910a80
--- /dev/null
+++ b/question/type/questionbase.php
@@ -0,0 +1,787 @@
+.
+
+
+/**
+ * This file defines the class {@link question_definition} and its subclasses.
+ *
+ * @package moodlecore
+ * @subpackage questiontypes
+ * @copyright 2009 The Open University
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+
+/**
+ * The definition of a question of a particular type.
+ *
+ * This class is a close match to the question table in the database.
+ * Definitions of question of a particular type normally subclass one of the
+ * more specific classes {@link question_with_responses},
+ * {@link question_graded_automatically} or {@link question_information_item}.
+ *
+ * @copyright 2009 The Open University
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+abstract class question_definition {
+ /** @var integer id of the question in the datase, or null if this question
+ * is not in the database. */
+ public $id;
+
+ /** @var integer question category id. */
+ public $category;
+
+ /** @var integer parent question id. */
+ public $parent = 0;
+
+ /** @var question_type the question type this question is. */
+ public $qtype;
+
+ /** @var string question name. */
+ public $name;
+
+ /** @var string question text. */
+ public $questiontext;
+
+ /** @var integer question test format. */
+ public $questiontextformat;
+
+ /** @var string question general feedback. */
+ public $generalfeedback;
+
+ /** @var number what this quetsion is marked out of, by default. */
+ public $defaultmark = 1;
+
+ /** @var integer How many question numbers this question consumes. */
+ public $length = 1;
+
+ /** @var number penalty factor of this question. */
+ public $penalty = 0;
+
+ /** @var string unique identifier of this question. */
+ public $stamp;
+
+ /** @var string unique identifier of this version of this question. */
+ public $version;
+
+ /** @var boolean whethre this question has been deleted/hidden in the question bank. */
+ public $hidden = 0;
+
+ /** @var integer timestamp when this question was created. */
+ public $timecreated;
+
+ /** @var integer timestamp when this question was modified. */
+ public $timemodified;
+
+ /** @var integer userid of the use who created this question. */
+ public $createdby;
+
+ /** @var integer userid of the use who modified this question. */
+ public $modifiedby;
+
+ /** @var array of question_hints. */
+ public $hints = array();
+
+ /**
+ * Constructor. Normally to get a question, you call
+ * {@link question_bank::load_question()}, but questions can be created
+ * directly, for example in unit test code.
+ * @return unknown_type
+ */
+ public function __construct() {
+ }
+
+ /**
+ * @return the name of the question type (for example multichoice) that this
+ * question is.
+ */
+ public function get_type_name() {
+ return $this->qtype->name();
+ }
+
+ /**
+ * Creat the appropriate behaviour for an attempt at this quetsion,
+ * given the desired (archetypal) behaviour.
+ *
+ * This default implementation will suit most normal graded questions.
+ *
+ * If your question is of a patricular type, then it may need to do something
+ * different. For example, if your question can only be graded manually, then
+ * it should probably return a manualgraded behaviour, irrespective of
+ * what is asked for.
+ *
+ * If your question wants to do somthing especially complicated is some situations,
+ * then you may wish to return a particular behaviour related to the
+ * one asked for. For example, you migth want to return a
+ * qbehaviour_interactive_adapted_for_myqtype.
+ *
+ * @param question_attempt $qa the attempt we are creating an behaviour for.
+ * @param string $preferredbehaviour the requested type of behaviour.
+ * @return question_behaviour the new behaviour object.
+ */
+ public function make_behaviour(question_attempt $qa, $preferredbehaviour) {
+ return question_engine::make_archetypal_behaviour($preferredbehaviour, $qa);
+ }
+
+ /**
+ * Initialise the first step of an attempt at this quetsion.
+ *
+ * For example, the multiple choice question type uses this method to
+ * randomly shuffle the choices, if that option has been set in the question.
+ * It then stores that order by calling $step->set_qt_var(...).
+ *
+ * @param question_attempt_step $step the step to be initialised.
+ */
+ public function init_first_step(question_attempt_step $step) {
+ }
+
+ /**
+ * Generate a brief, plain-text, summary of this question. This is used by
+ * various reports. This should show the particular variant of the question
+ * as presented to students. For example, the calculated quetsion type would
+ * fill in the particular numbers that were presented to the student.
+ * This method will return null if such a summary is not possible, or
+ * inappropriate.
+ * @return string|null a plain text summary of this question.
+ */
+ public function get_question_summary() {
+ return html_to_text($this->format_questiontext(), 0, false);
+ }
+
+ /**
+ * Some questions can return a negative mark if the student gets it wrong.
+ *
+ * This method returns the lowest mark the question can return, on the
+ * fraction scale. that is, where the maximum possible mark is 1.0.
+ *
+ * @return number minimum fraction this question will ever return.
+ */
+ public function get_min_fraction() {
+ return 0;
+ }
+
+ /**
+ * Given a response, rest the parts that are wrong.
+ * @param array $response a response
+ * @return array a cleaned up response with the wrong bits reset.
+ */
+ public function clear_wrong_from_response(array $response) {
+ return array();
+ }
+
+ /**
+ * Return the number of subparts of this response that are right.
+ * @param array $response a response
+ * @return array with two elements, the number of correct subparts, and
+ * the total number of subparts.
+ */
+ public function get_num_parts_right(array $response) {
+ return array(null, null);
+ }
+
+ /**
+ * @return qtype_renderer the renderer to use for outputting this question.
+ */
+ public function get_renderer() {
+ return renderer_factory::get_renderer('qtype_' . $this->qtype->name());
+ }
+
+ /**
+ * What data may be included in the form submission when a student submits
+ * this question in its current state?
+ *
+ * This information is used in calls to optional_param. The parameter name
+ * has {@link question_attempt::get_field_prefix()} automatically prepended.
+ *
+ * @return array|string variable name => PARAM_... constant, or, as a special case
+ * that should only be used in unavoidable, the constant question_attempt::USE_RAW_DATA
+ * meaning take all the raw submitted data belonging to this question.
+ */
+ public abstract function get_expected_data();
+
+ /**
+ * What data would need to be submitted to get this question correct.
+ * If there is more than one correct answer, this method should just
+ * return one possibility.
+ *
+ * @return array parameter name => value.
+ */
+ public abstract function get_correct_response();
+
+ /**
+ * Apply {@link format_text()} to some content with appropriate settings for
+ * this question.
+ *
+ * @param string $text some content that needs to be output.
+ * @param boolean $clean Whether the HTML needs to be cleaned. Generally,
+ * parts of the question do not need to be cleaned, and student input does.
+ * @return string the text formatted for output by format_text.
+ */
+ public function format_text($text, $clean = false) {
+ $formatoptions = new stdClass;
+ $formatoptions->noclean = !$clean;
+ $formatoptions->para = false;
+
+ return format_text($text, $this->questiontextformat, $formatoptions);
+ }
+
+ /** @return the result of applying {@link format_text()} to the question text. */
+ public function format_questiontext() {
+ return $this->format_text($this->questiontext);
+ }
+
+ /** @return the result of applying {@link format_text()} to the general feedback. */
+ public function format_generalfeedback() {
+ return $this->format_text($this->generalfeedback);
+ }
+}
+
+
+/**
+ * This class represents a 'question' that actually does not allow the student
+ * to respond, like the description 'question' type.
+ *
+ * @copyright 2009 The Open University
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class question_information_item extends question_definition {
+ public function __construct() {
+ parent::__construct();
+ $this->defaultmark = 0;
+ $this->penalty = 0;
+ $this->length = 0;
+ }
+
+ public function make_behaviour(question_attempt $qa, $preferredbehaviour) {
+ question_engine::load_behaviour_class('informationitem');
+ return new qbehaviour_informationitem($qa, $preferredbehaviour);
+ }
+
+ public function get_expected_data() {
+ return array();
+ }
+
+ public function get_correct_response() {
+ return array();
+ }
+
+ public function get_question_summary() {
+ return null;
+ }
+}
+
+
+/**
+ * Interface that a {@link question_definition} must implement to be usable by
+ * the manual graded behaviour.
+ *
+ * @copyright 2009 The Open University
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+interface question_manually_gradable {
+ /**
+ * Used by many of the behaviours, to work out whether the student's
+ * response to the question is complete. That is, whether the question attempt
+ * should move to the COMPLETE or INCOMPLETE state.
+ *
+ * @param array $response responses, as returned by {@link question_attempt_step::get_qt_data()}.
+ * @return boolean whether this response is a complete answer to this question.
+ */
+ public function is_complete_response(array $response);
+
+ /**
+ * Use by many of the behaviours to determine whether the student's
+ * response has changed. This is normally used to determine that a new set
+ * of responses can safely be discarded.
+ *
+ * @param array $prevresponse the responses previously recorded for this question,
+ * as returned by {@link question_attempt_step::get_qt_data()}
+ * @param array $newresponse the new responses, in the same format.
+ * @return boolean whether the two sets of responses are the same - that is
+ * whether the new set of responses can safely be discarded.
+ */
+ public function is_same_response(array $prevresponse, array $newresponse);
+
+ /**
+ * Produce a plain text summary of a response.
+ * @param $response a response, as might be passed to {@link grade_response()}.
+ * @return string a plain text summary of that response, that could be used in reports.
+ */
+ public function summarise_response(array $response);
+
+ /**
+ * Categorise the student's response according to the categories defined by
+ * get_possible_responses.
+ * @param $response a response, as might be passed to {@link grade_response()}.
+ * @return array subpartid => {@link question_classified_response} objects.
+ * returns an empty array if no analysis is possible.
+ */
+ public function classify_response(array $response);
+}
+
+
+/**
+ * This class is used in the return value from
+ * {@link question_manually_gradable::classify_response()}.
+ *
+ * @copyright 2010 The Open University
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class question_classified_response {
+ /**
+ * @var string the classification of this response the student gave to this
+ * part of the question. Must match one of the responseclasses returned by
+ * {@link question_type::get_possible_responses()}.
+ */
+ public $responseclassid;
+ /** @var string the actual response the student gave to this part. */
+ public $response;
+ /** @var number the fraction this part of the response earned. */
+ public $fraction;
+ /**
+ * Constructor, just an easy way to set the fields.
+ * @param string $responseclassid see the field descriptions above.
+ * @param string $response see the field descriptions above.
+ * @param number $fraction see the field descriptions above.
+ */
+ public function __construct($responseclassid, $response, $fraction) {
+ $this->responseclassid = $responseclassid;
+ $this->response = $response;
+ $this->fraction = $fraction;
+ }
+
+ public static function no_response() {
+ return new question_classified_response(null, null, null);
+ }
+}
+
+
+/**
+ * Interface that a {@link question_definition} must implement to be usable by
+ * the various automatic grading behaviours.
+ *
+ * @copyright 2009 The Open University
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+interface question_automatically_gradable extends question_manually_gradable {
+ /**
+ * Use by many of the behaviours to determine whether the student
+ * has provided enough of an answer for the question to be graded automatically,
+ * or whether it must be considered aborted.
+ *
+ * @param array $response responses, as returned by {@link question_attempt_step::get_qt_data()}.
+ * @return boolean whether this response can be graded.
+ */
+ public function is_gradable_response(array $response);
+
+ /**
+ * In situations where is_gradable_response() returns false, this method
+ * should generate a description of what the problem is.
+ * @return string the message.
+ */
+ public function get_validation_error(array $response);
+
+ /**
+ * Grade a response to the question, returning a fraction between get_min_fraction() and 1.0,
+ * and the corresponding state CORRECT, PARTIALLY_CORRECT or INCORRECT.
+ * @param array $response responses, as returned by {@link question_attempt_step::get_qt_data()}.
+ * @return array (number, integer) the fraction, and the state.
+ */
+ public function grade_response(array $response);
+
+ /**
+ * Get one of the question hints. The question_attempt is passed in case
+ * the question type wants to do something complex. For example, the
+ * multiple choice with multiple responses question type will turn off most
+ * of the hint options if the student has selected too many opitions.
+ * @param integer $hintnumber Which hint to display. Indexed starting from 0
+ * @param question_attempt $qa The question_attempt.
+ */
+ public function get_hint($hintnumber, question_attempt $qa);
+
+ /**
+ * Generate a brief, plain-text, summary of the correct answer to this question.
+ * This is used by various reports, and can also be useful when testing.
+ * This method will return null if such a summary is not possible, or
+ * inappropriate.
+ * @return string|null a plain text summary of the right answer to this question.
+ */
+ public function get_right_answer_summary();
+}
+
+
+/**
+ * Interface that a {@link question_definition} must implement to be usable by
+ * the interactivecountback behaviour.
+ *
+ * @copyright 2010 The Open University
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+interface question_automatically_gradable_with_countback extends question_automatically_gradable {
+ /**
+ * Work out a final grade for this attempt, taking into account all the
+ * tries the student made.
+ * @param array $responses the response for each try. Each element of this
+ * array is a response array, as would be passed to {@link grade_response()}.
+ * There may be between 1 and $totaltries responses.
+ * @param integer $totaltries The maximum number of tries allowed.
+ * @return numeric the fraction that should be awarded for this
+ * sequence of response.
+ */
+ public function compute_final_grade($responses, $totaltries);
+}
+
+
+/**
+ * This class represents a real question. That is, one that is not a
+ * {@link question_information_item}.
+ *
+ * @copyright 2009 The Open University
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+abstract class question_with_responses extends question_definition
+ implements question_manually_gradable {
+ function classify_response(array $response) {
+ return array();
+ }
+}
+
+
+/**
+ * This class represents a question that can be graded automatically.
+ *
+ * @copyright 2009 The Open University
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+abstract class question_graded_automatically extends question_with_responses
+ implements question_automatically_gradable {
+ /** @var Some question types have the option to show the number of sub-parts correct. */
+ public $shownumcorrect = false;
+
+ public function is_gradable_response(array $response) {
+ return $this->is_complete_response($response);
+ }
+
+ public function get_right_answer_summary() {
+ $correctresponse = $this->get_correct_response();
+ if (empty($correctresponse)) {
+ return null;
+ }
+ return $this->summarise_response($correctresponse);
+ }
+
+ public function get_hint($hintnumber, question_attempt $qa) {
+ if (!isset($this->hints[$hintnumber])) {
+ return null;
+ }
+ return $this->hints[$hintnumber];
+ }
+}
+
+
+/**
+ * This class represents a question that can be graded automatically with
+ * countback grading in interactive mode.
+ *
+ * @copyright 2010 The Open University
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+abstract class question_graded_automatically_with_countback
+ extends question_graded_automatically
+ implements question_automatically_gradable_with_countback {
+
+ public function make_behaviour(question_attempt $qa, $preferredbehaviour) {
+ if ($preferredbehaviour == 'interactive') {
+ return question_engine::make_behaviour('interactivecountback', $qa, $preferredbehaviour);
+ }
+ return question_engine::make_archetypal_behaviour($preferredbehaviour, $qa);
+ }
+}
+
+
+/**
+ * This class represents a question that can be graded automatically by using
+ * a {@link question_grading_strategy}.
+ *
+ * @copyright 2009 The Open University
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+abstract class question_graded_by_strategy extends question_graded_automatically {
+ /** @var question_grading_strategy the strategy to use for grading. */
+ protected $gradingstrategy;
+
+ /** @param question_grading_strategy $strategy the strategy to use for grading. */
+ public function __construct(question_grading_strategy $strategy) {
+ parent::__construct();
+ $this->gradingstrategy = $strategy;
+ }
+
+ public function get_correct_response() {
+ $answer = $this->get_correct_answer();
+ if (!$answer) {
+ return array();
+ }
+
+ return array('answer' => $answer->answer);
+ }
+
+ /**
+ * Get an answer that contains the feedback and fraction that should be
+ * awarded for this resonse.
+ * @param array $response a response.
+ * @return question_answer the matching answer.
+ */
+ public function get_matching_answer(array $response) {
+ return $this->gradingstrategy->grade($response);
+ }
+
+ /**
+ * @return question_answer an answer that contains the a response that would
+ * get full marks.
+ */
+ public function get_correct_answer() {
+ return $this->gradingstrategy->get_correct_answer();
+ }
+
+ public function grade_response(array $response) {
+ $answer = $this->get_matching_answer($response);
+ if ($answer) {
+ return array($answer->fraction, question_state::graded_state_for_fraction($answer->fraction));
+ } else {
+ return array(0, question_state::$gradedwrong);
+ }
+ }
+
+ public function classify_response(array $response) {
+ if (empty($response['answer'])) {
+ return array($this->id => question_classified_response::no_response());
+ }
+
+ $ans = $this->get_matching_answer($response);
+ if (!$ans) {
+ return array($this->id => question_classified_response::no_response());
+ }
+ return array($this->id => new question_classified_response(
+ $ans->id, $response['answer'], $ans->fraction));
+ }
+}
+
+
+/**
+ * Class to represent a question answer, loaded from the question_answers table
+ * in the database.
+ *
+ * @copyright 2009 The Open University
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class question_answer {
+ /** @var string the answer. */
+ public $answer;
+
+ /** @var number the fraction this answer is worth. */
+ public $fraction;
+
+ /** @var string the feedback for this answer. */
+ public $feedback;
+
+ /**
+ * Constructor.
+ * @param string $answer the answer.
+ * @param number $fraction the fraction this answer is worth.
+ * @param string $feedback the feedback for this answer.
+ */
+ public function __construct($answer, $fraction, $feedback) {
+ $this->answer = $answer;
+ $this->fraction = $fraction;
+ $this->feedback = $feedback;
+ }
+}
+
+
+/**
+ * Class to represent a hint associated with a question.
+ * Used by iteractive mode, etc. A question has an array of these.
+ *
+ * @copyright 2010 The Open University
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class question_hint {
+ /** @var The feedback hint to be shown. */
+ public $hint;
+
+ /**
+ * Constructor.
+ * @param string $hint The hint text
+ */
+ public function __construct($hint) {
+ $this->hint = $hint;
+ }
+
+ /**
+ * Create a basic hint from a row loaded from the question_hints table in the database.
+ * @param object $row with $row->hint set.
+ * @return question_hint
+ */
+ public static function load_from_record($row) {
+ return new question_hint($row->hint);
+ }
+
+ /**
+ * Adjust this display options according to the hint settings.
+ * @param question_display_options $options
+ */
+ public function adjust_display_options(question_display_options $options) {
+ // Do nothing.
+ }
+}
+
+
+/**
+ * An extension of {@link question_hint} for questions like match and multiple
+ * choice with multile answers, where there are options for whether to show the
+ * number of parts right at each stage, and to reset the wrong parts.
+ *
+ * @copyright 2010 The Open University
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class question_hint_with_parts extends question_hint {
+ /** @var boolean option to show the number of sub-parts of the question that were right. */
+ public $shownumcorrect;
+
+ /** @var boolean option to clear the parts of the question that were wrong on retry. */
+ public $clearwrong;
+
+ /**
+ * Constructor.
+ * @param string $hint The hint text
+ * @param boolean $shownumcorrect whether the number of right parts should be shown
+ * @param boolean $clearwrong whether the wrong parts should be reset.
+ */
+ public function __construct($hint, $shownumcorrect, $clearwrong) {
+ parent::__construct($hint);
+ $this->shownumcorrect = $shownumcorrect;
+ $this->clearwrong = $clearwrong;
+ }
+
+ /**
+ * Create a basic hint from a row loaded from the question_hints table in the database.
+ * @param object $row with $row->hint, ->shownumcorrect and ->clearwrong set.
+ * @return question_hint_with_parts
+ */
+ public static function load_from_record($row) {
+ return new question_hint_with_parts($row->hint, $row->shownumcorrect, $row->clearwrong);
+ }
+
+ public function adjust_display_options(question_display_options $options) {
+ parent::adjust_display_options($options);
+ if ($this->clearwrong) {
+ $options->clearwrong = true;
+ }
+ $options->numpartscorrect = $this->shownumcorrect;
+ }
+}
+
+
+/**
+ * This question_grading_strategy interface. Used to share grading code between
+ * questions that that subclass {@link question_graded_by_strategy}.
+ *
+ * @copyright 2009 The Open University
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+interface question_grading_strategy {
+ /**
+ * Return a question answer that describes the outcome (fraction and feeback)
+ * for a particular respons.
+ * @param array $response the response.
+ * @return question_answer the answer describing the outcome.
+ */
+ public function grade(array $response);
+
+ /**
+ * @return question_answer an answer that contains the a response that would
+ * get full marks.
+ */
+ public function get_correct_answer();
+}
+
+
+/**
+ * This interface defines the methods that a {@link question_definition} must
+ * implement if it is to be graded by the
+ * {@link question_first_matching_answer_grading_strategy}.
+ *
+ * @copyright 2009 The Open University
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+interface question_response_answer_comparer {
+ /** @return array of {@link question_answers}. */
+ public function get_answers();
+
+ /**
+ * @param array $response the response.
+ * @param question_answer $answer an answer.
+ * @return boolean whether the response matches the answer.
+ */
+ public function compare_response_with_answer(array $response, question_answer $answer);
+}
+
+
+/**
+ * This grading strategy is used by question types like shortanswer an numerical.
+ * It gets a list of possible answers from the question, and returns the first one
+ * that matches the given response. It returns the first answer with fraction 1.0
+ * when asked for the correct answer.
+ *
+ * @copyright 2009 The Open University
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class question_first_matching_answer_grading_strategy implements question_grading_strategy {
+ /**
+ * @var question_response_answer_comparer (presumably also a
+ * {@link question_definition}) the question we are doing the grading for.
+ */
+ protected $question;
+
+ /**
+ * @param question_response_answer_comparer $question (presumably also a
+ * {@link question_definition}) the question we are doing the grading for.
+ */
+ public function __construct(question_response_answer_comparer $question) {
+ $this->question = $question;
+ }
+
+ public function grade(array $response) {
+ foreach ($this->question->get_answers() as $aid => $answer) {
+ if ($this->question->compare_response_with_answer($response, $answer)) {
+ $answer->id = $aid;
+ return $answer;
+ }
+ }
+ return null;
+ }
+
+ public function get_correct_answer() {
+ foreach ($this->question->get_answers() as $answer) {
+ $state = question_state::graded_state_for_fraction($answer->fraction);
+ if ($state == question_state::$gradedright) {
+ return $answer;
+ }
+ }
+ return null;
+ }
+}
\ No newline at end of file
diff --git a/question/type/questiontype.php b/question/type/questiontype.php
index 5aaf4d323d8..d711416650d 100644
--- a/question/type/questiontype.php
+++ b/question/type/questiontype.php
@@ -1,20 +1,4 @@
-.
-
+libdir . '/questionlib.php');
+require_once($CFG->dirroot . '/question/engine/lib.php');
+// DONOTCOMMIT
+class default_questiontype {
+ function plugin_dir() {
+ return '';
+ }
+}
/**
* This is the base class for Moodle question types.
*
@@ -45,79 +35,33 @@ require_once($CFG->libdir . '/questionlib.php');
* @package questionbank
* @subpackage questiontypes
*/
-class default_questiontype {
- protected $fileoptions = array(
- 'subdirs' => false,
- 'maxfiles' => -1,
- 'maxbytes' => 0,
- );
+class question_type {
+
+ public function __construct() {
+ }
/**
- * Name of the question type
- *
- * The name returned should coincide with the name of the directory
- * in which this questiontype is located
- *
* @return string the name of this question type.
*/
- function name() {
- return 'default';
- }
-
- /**
- * Returns a list of other question types that this one requires in order to
- * work. For example, the calculated question type is a subclass of the
- * numerical question type, which is a subclass of the shortanswer question
- * type; and the randomsamatch question type requires the shortanswer type
- * to be installed.
- *
- * @return array any other question types that this one relies on. An empty
- * array if none.
- */
- function requires_qtypes() {
- return array();
- }
-
- /**
- * @return string the name of this pluginfor passing to get_string, set/get_config, etc.
- */
- function plugin_name() {
- return 'qtype_' . $this->name();
- }
-
- /**
- * @return string the name of this question type in the user's language.
- * You should not need to override this method, the default behaviour should be fine.
- */
- function local_name() {
- return get_string($this->name(), $this->plugin_name());
+ public function name() {
+ return substr(get_class($this), 6);
}
/**
* The name this question should appear as in the create new question
- * dropdown. Override this method to return false if you don't want your
- * question type to be createable, for example if it is an abstract base type,
- * otherwise, you should not need to override this method.
+ * dropdown.
*
* @return mixed the desired string, or false to hide this question type in the menu.
*/
- function menu_name() {
- return $this->local_name();
+ public function menu_name() {
+ $name = $this->name();
+ return get_string($name, 'qtype_' . $name);
}
/**
- * @return boolean override this to return false if this is not really a
- * question type, for example the description question type is not
- * really a question type.
+ * @return boolean true if this question type sometimes requires manual grading.
*/
- function is_real_question_type() {
- return true;
- }
-
- /**
- * @return boolean true if this question type may require manual grading.
- */
- function is_manual_graded() {
+ public function is_manual_graded() {
return false;
}
@@ -126,35 +70,38 @@ class default_questiontype {
* @param string $otherquestionsinuse comma-separate list of other question ids in this attempt.
* @return boolean true if a particular instance of this question requires manual grading.
*/
- function is_question_manual_graded($question, $otherquestionsinuse) {
+ public function is_question_manual_graded($question, $otherquestionsinuse) {
return $this->is_manual_graded();
}
- /**
- * @return boolean true if a table analyzing responses should be shown in
- * the quiz statistics report. Usually if a question is manually graded
- * then this analysis table won't be a good idea.
- */
- function show_analysis_of_responses() {
- return !$this->is_manual_graded();
- }
-
/**
* @return boolean true if this question type can be used by the random question type.
*/
- function is_usable_by_random() {
+ public function is_usable_by_random() {
return true;
}
/**
- * @param question record.
- * @param integer subqid this is the id of the subquestion. Usually the id
- * of the question record of the question record but this is dependent on
- * the question type. Not relevant to some question types.
- * @return whether the teacher supplied responses can include wildcards. Can
- * more than one answer be equivalent to one teacher supplied response.
+ * Whether this question type can perform a frequency analysis of student
+ * responses.
+ *
+ * If this method returns true, you must implement the get_possible_responses
+ * method, and the question_definition class must implement the
+ * classify_response method.
+ *
+ * @return boolean whether this report can analyse all the student reponses
+ * for things like the quiz statistics report.
*/
- function has_wildcards_in_responses($question, $subqid) {
+ public function can_analyse_responses() {
+ // This works in most cases.
+ return !$this->is_manual_graded();
+ }
+
+ /**
+ * @return whether the question_answers.answer field needs to have
+ * restore_decode_content_links_worker called on it.
+ */
+ public function has_html_answers() {
return false;
}
@@ -166,7 +113,7 @@ class default_questiontype {
*
* @return mixed array as above, or null to tell the base class to do nothing.
*/
- function extra_question_fields() {
+ public function extra_question_fields() {
return null;
}
@@ -174,7 +121,7 @@ class default_questiontype {
* If you use extra_question_fields, overload this function to return question id field name
* in case you table use another name for this column
*/
- function questionid_column_name() {
+ protected function questionid_column_name() {
return 'questionid';
}
@@ -185,20 +132,20 @@ class default_questiontype {
*
* @return mixed array as above, or null to tell the base class to do nothing.
*/
- function extra_answer_fields() {
- return null;
- }
+ protected function extra_answer_fields() {
+ return null;
+ }
/**
* Return an instance of the question editing form definition. This looks for a
* class called edit_{$this->name()}_question_form in the file
- * {$CFG->dirroot}/question/type/{$this->name()}/edit_{$this->name()}_question_form.php
+ * {$CFG->docroot}/question/type/{$this->name()}/edit_{$this->name()}_question_form.php
* and if it exists returns an instance of it.
*
* @param string $submiturl passed on to the constructor call.
* @return object an instance of the form definition, or null if one could not be found.
*/
- function create_editing_form($submiturl, $question, $category, $contexts, $formeditable) {
+ public function create_editing_form($submiturl, $question, $category, $contexts, $formeditable) {
global $CFG;
require_once("{$CFG->dirroot}/question/type/edit_question_form.php");
$definition_file = $CFG->dirroot.'/question/type/'.$this->name().'/edit_'.$this->name().'_form.php';
@@ -216,7 +163,7 @@ class default_questiontype {
/**
* @return string the full path of the folder this plugin's files live in.
*/
- function plugin_dir() {
+ public function plugin_dir() {
global $CFG;
return $CFG->dirroot . '/question/type/' . $this->name();
}
@@ -224,7 +171,7 @@ class default_questiontype {
/**
* @return string the URL of the folder this plugin's files live in.
*/
- function plugin_baseurl() {
+ public function plugin_baseurl() {
global $CFG;
return $CFG->wwwroot . '/question/type/' . $this->name();
}
@@ -237,12 +184,9 @@ class default_questiontype {
* @param object $question
* @param string $wizardnow is '' for first page.
*/
- function display_question_editing_page(&$mform, $question, $wizardnow){
- global $OUTPUT;
- $heading = $this->get_heading(empty($question->id));
-
- echo $OUTPUT->heading_with_help($heading, $this->name(), $this->plugin_name());
-
+ public function display_question_editing_page(&$mform, $question, $wizardnow) {
+ $name = $this->name();
+ print_heading_with_help($this->get_heading(empty($question->id)), $name, 'qtype_' . $name);
$permissionstrs = array();
if (!empty($question->id)){
if ($question->formoptions->canedit){
@@ -256,13 +200,13 @@ class default_questiontype {
}
}
if (!$question->formoptions->movecontext && count($permissionstrs)){
- echo $OUTPUT->heading(get_string('permissionto', 'question'), 3);
+ print_heading(get_string('permissionto', 'question'), 'center', 3);
$html = '![' . get_string('flagthisquestion', 'question') . ']()
';
- }
-
- /**
- * Get a link to an edit icon for this question, if the current user is allowed
- * to edit it.
- *
- * @param object $question the question object.
- * @param object $cmoptions the options from the module. If $cmoptions->thispageurl is set
- * then the link will be to edit the question in this browser window, then return to
- * $cmoptions->thispageurl. Otherwise the link will be to edit in a popup.
- * @return string the HTML of the link, or nothing it the currenty user is not allowed to edit.
- */
- function get_question_edit_link($question, $cmoptions, $options) {
- global $CFG, $OUTPUT;
-
- /// Is this user allowed to edit this question?
- if (!empty($options->noeditlink) || !question_has_capability_on($question, 'edit')) {
- return '';
- }
-
- /// Work out the right URL.
- $url = new moodle_url('/question/question.php', array('id' => $question->id));
- if (!empty($cmoptions->cmid)) {
- $url->param('cmid', $cmoptions->cmid);
- } else if (!empty($cmoptions->course)) {
- $url->param('courseid', $cmoptions->course);
- } else {
- print_error('missingcourseorcmidtolink', 'question');
- }
-
- $icon = new pix_icon('t/edit', get_string('edit'));
-
- $action = null;
- if (!empty($cmoptions->thispageurl)) {
- // The module allow editing in the same window, print an ordinary
- // link with a returnurl.
- $url->param('returnurl', $cmoptions->thispageurl);
- } else {
- // We have to edit in a pop-up.
- $url->param('inpopup', 1);
- $action = new popup_action('click', $link, 'editquestion');
- }
-
- return $OUTPUT->action_icon($url, $icon, $action);
- }
-
- /**
- * Print history of responses
- *
- * Used by print_question()
- */
- function history($question, $state, $number, $cmoptions, $options) {
- global $DB, $OUTPUT;
-
- if (empty($options->history)) {
- return '';
- }
-
- $params = array('aid' => $state->attempt);
- if (isset($question->randomquestionid)) {
- $params['qid'] = $question->randomquestionid;
- $randomprefix = 'random' . $question->id . '-';
- } else {
- $params['qid'] = $question->id;
- $randomprefix = '';
- }
- if ($options->history == 'all') {
- $eventtest = 'event > 0';
- } else {
- $eventtest = 'event IN (' . QUESTION_EVENTS_GRADED . ')';
- }
- $states = $DB->get_records_select('question_states',
- 'attempt = :aid AND question = :qid AND ' . $eventtest, $params, 'seq_number ASC');
- if (count($states) <= 1) {
- return '';
- }
-
- $strreviewquestion = get_string('reviewresponse', 'quiz');
- $table = new html_table();
- $table->width = '100%';
- $table->head = array (
- get_string('numberabbr', 'quiz'),
- get_string('action', 'quiz'),
- get_string('response', 'quiz'),
- get_string('time'),
- );
- if ($options->scores) {
- $table->head[] = get_string('score', 'quiz');
- $table->head[] = get_string('grade', 'quiz');
- }
-
- foreach ($states as $st) {
- if ($randomprefix && strpos($st->answer, $randomprefix) === 0) {
- $st->answer = substr($st->answer, strlen($randomprefix));
- }
- $st->responses[''] = $st->answer;
- $this->restore_session_and_responses($question, $st);
-
- if ($state->id == $st->id) {
- $link = '' . $st->seq_number . '';
- } else if (isset($options->questionreviewlink)) {
- $reviewlink = new moodle_url($options->questionreviewlink);
- $reviewlink->params(array('state'=>$st->id,'question'=>$question->id));
- $link = new moodle_url($reviewlink);
- $action = new popup_action('click', $link, 'reviewquestion', array('height' => 450, 'width' => 650));
- $link = $OUTPUT->action_link($link, $st->seq_number, $action, array('title'=>$strreviewquestion));
- } else {
- $link = $st->seq_number;
- }
-
- if ($state->id == $st->id) {
- $b = '';
- $be = '';
- } else {
- $b = '';
- $be = '';
- }
-
- $data = array (
- $link,
- $b.get_string('event'.$st->event, 'quiz').$be,
- $b.$this->response_summary($question, $st).$be,
- $b.userdate($st->timestamp, get_string('timestr', 'quiz')).$be,
- );
- if ($options->scores) {
- $data[] = $b.question_format_grade($cmoptions, $st->raw_grade).$be;
- $data[] = $b.question_format_grade($cmoptions, $st->raw_grade).$be;
- }
- $table->data[] = $data;
- }
- return html_writer::table($table);
- }
-
- /**
- * Prints the score obtained and maximum score available plus any penalty
- * information
- *
- * This function prints a summary of the scoring in the most recently
- * graded state (the question may not have been submitted for marking at
- * the current state). The default implementation should be suitable for most
- * question types.
- * @param object $question The question for which the grading details are
- * to be rendered. Question type specific information
- * is included. The maximum possible grade is in
- * ->maxgrade.
- * @param object $state The state. In particular the grading information
- * is in ->grade, ->raw_grade and ->penalty.
- * @param object $cmoptions
- * @param object $options An object describing the rendering options.
- */
- function print_question_grading_details(&$question, &$state, $cmoptions, $options) {
- /* The default implementation prints the number of marks if no attempt
- has been made. Otherwise it displays the grade obtained out of the
- maximum grade available and a warning if a penalty was applied for the
- attempt and displays the overall grade obtained counting all previous
- responses (and penalties) */
-
- if (QUESTION_EVENTDUPLICATE == $state->event) {
- echo ' ';
- print_string('duplicateresponse', 'quiz');
- }
- if ($question->maxgrade > 0 && $options->scores) {
- if (question_state_is_graded($state->last_graded)) {
- // Display the grading details from the last graded state
- $grade = new stdClass;
- $grade->cur = question_format_grade($cmoptions, $state->last_graded->grade);
- $grade->max = question_format_grade($cmoptions, $question->maxgrade);
- $grade->raw = question_format_grade($cmoptions, $state->last_graded->raw_grade);
-
- // let student know wether the answer was correct
- $class = question_get_feedback_class($state->last_graded->raw_grade /
- $question->maxgrade);
- echo '
"; + } + } + backup_flush(300); + } + + if (!$newid) { + $status = false; + } + } + + return $status; + } + + public function restore_recode_answer($state, $restore) { + //answer may be empty + if ($state->answer) { + $answer = backup_getid($restore->backup_unique_code,"question_answers",$state->answer); + if ($answer) { + return $answer->new_id; + } else { + echo 'Could not recode truefalse answer id '.$state->answer.' for state '.$state->oldid.'
'; + } + } + } + /** * Runs all the code required to set up and save an essay question for testing purposes. * Alternate DB table prefix may be used to facilitate data deletion. */ - function generate_test($name, $courseid = null) { - global $DB; + public function generate_test($name, $courseid = null) { list($form, $question) = parent::generate_test($name, $courseid); $question->category = $form->category; $form->questiontext = "This question is really stupid"; $form->penalty = 1; - $form->defaultgrade = 1; + $form->defaultmark = 1; $form->correctanswer = 0; - $form->feedbacktrue = 'Can you justify such a hasty judgment?'; - $form->feedbackfalse = 'Wisdom has spoken!'; + $form->feedbacktrue = array('Can you justify such a hasty judgment?'); + $form->feedbackfalse = array('Wisdom has spoken!'); if ($courseid) { - $course = $DB->get_record('course', array('id' => $courseid)); + $course = get_record('course', 'id', $courseid); } - return $this->save_question($question, $form); + return $this->save_question($question, $form, $course); } } -//// END OF CLASS //// - -////////////////////////////////////////////////////////////////////////// -//// INITIATION - Without this line the question type is not in use... /// -////////////////////////////////////////////////////////////////////////// -question_register_questiontype(new question_truefalse_qtype()); diff --git a/question/type/truefalse/renderer.php b/question/type/truefalse/renderer.php new file mode 100644 index 00000000000..bfea585d08b --- /dev/null +++ b/question/type/truefalse/renderer.php @@ -0,0 +1,142 @@ +. + + +/** + * True-false question renderer class. + * + * @package qtype_truefalse + * @copyright 2009 The Open University + * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later + */ + + +/** + * Generates the output for true-false questions. + * + * @copyright 2009 The Open University + * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later + */ +class qtype_truefalse_renderer extends qtype_renderer { + public function formulation_and_controls(question_attempt $qa, + question_display_options $options) { + + $question = $qa->get_question(); + $response = $qa->get_last_qt_var('answer', ''); + + $inputname = $qa->get_qt_field_name('answer'); + $trueattributes = array( + 'type' => 'radio', + 'name' => $inputname, + 'value' => 1, + 'id' => $inputname . 'true', + ); + $falseattributes = array( + 'type' => 'radio', + 'name' => $inputname, + 'value' => 0, + 'id' => $inputname . 'false', + ); + + if ($options->readonly) { + $trueattributes['disabled'] = 'disabled'; + $falseattributes['disabled'] = 'disabled'; + } + + // Work out which radio button to select (if any) + $truechecked = false; + $falsechecked = false; + $responsearray = array(); + if ($response) { + $trueattributes['checked'] = 'checked'; + $truechecked = true; + $responsearray = array('answer' => 1); + } else if ($response !== '') { + $falseattributes['checked'] = 'checked'; + $falsechecked = true; + $responsearray = array('answer' => 1); + } + + // Work out visual feedback for answer correctness. + $trueclass = ''; + $falseclass = ''; + $truefeedbackimg = ''; + $falsefeedbackimg = ''; + if ($options->correctness) { + if ($truechecked) { + $trueclass = ' ' . $this->feedback_class((int) $question->rightanswer); + $truefeedbackimg = $this->feedback_image((int) $question->rightanswer); + } else if ($falsechecked) { + $falseclass = ' ' . $this->feedback_class((int) (!$question->rightanswer)); + $falsefeedbackimg = $this->feedback_image((int) (!$question->rightanswer)); + } + } + + $radiotrue = html_writer::empty_tag('input', $trueattributes) . + html_writer::tag('label', get_string('true', 'qtype_truefalse'), + array('for' => $trueattributes['id'])); + $radiofalse = html_writer::empty_tag('input', $falseattributes) . + html_writer::tag('label', get_string('false', 'qtype_truefalse'), + array('for' => $falseattributes['id'])); + + $result = ''; + $result .= html_writer::tag('div', $question->format_questiontext(), + array('class' => 'qtext')); + + $result .= html_writer::start_tag('div', array('class' => 'ablock')); + $result .= html_writer::tag('div', get_string('selectone', 'qtype_truefalse'), + array('class' => 'prompt')); + + $result .= html_writer::start_tag('div', array('class' => 'answer')); + $result .= html_writer::tag('span', $radiotrue . ' ' . $truefeedbackimg, + array('class' => 'r0' . $trueclass)); + $result .= html_writer::tag('span', $radiofalse . ' ' . $falsefeedbackimg, + array('class' => 'r1' . $falseclass)); + $result .= html_writer::end_tag('div'); // answer + + $result .= html_writer::end_tag('div'); // ablock + + if ($qa->get_state() == question_state::$invalid) { + $result .= html_writer::nonempty_tag('div', + $question->get_validation_error($responsearray), + array('class' => 'validationerror')); + } + + return $result; + } + + public function specific_feedback(question_attempt $qa) { + $question = $qa->get_question(); + $response = $qa->get_last_qt_var('answer', ''); + + if ($response) { + return $question->format_text($question->truefeedback); + } else { + return $question->format_text($question->falsefeedback); + } + } + + public function correct_response(question_attempt $qa) { + $question = $qa->get_question(); + + if ($question->rightanswer) { + return get_string('correctanswertrue', 'qtype_truefalse'); + } else { + return get_string('correctanswerfalse', 'qtype_truefalse'); + } + } +}
Question engine upgrade assumptions ' . + date('Ymd-Hi') . "
\n\n"); + } + + public function set_current_attempt_id($id) { + $this->attemptid = $id; + } + + public function log_assumption($description, $quizattemptid = null) { + global $CFG; + $message = '' . $description; + if (!$quizattemptid) { + $quizattemptid = $this->attemptid; + } + if ($quizattemptid) { + $message .= ' (Review this attempt)'; + } + $message .= "
\n"; + fwrite($this->handle, $message); + } + + public function __destruct() { + fwrite($this->handle, ''); + fclose($this->handle); + } +} + + +/** + * This class manages upgrading all the question attempts from the old database + * structure to the new question engine. + * + * @copyright 2010 The Open University + * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later + */ +class question_engine_attempt_upgrader { + /** @var question_engine_upgrade_question_loader */ + protected $questionloader; + protected $logger; + + protected function print_progress($done, $outof, $quizid) { + gc_collect_cycles(); + print_progress($done, $outof); + } + + protected function prevent_timeout() { + set_time_limit(300); + } + + protected function table_exists($tablename) { + global $db; + $metatables = $db->MetaTables(); + $metatables = array_flip($metatables); + $metatables = array_change_key_case($metatables, CASE_LOWER); + return array_key_exists($tablename, $metatables); + } + + protected function get_quiz_ids() { + global $CFG; + if ($this->table_exists('vl_v_crs_version_pres')) { + $quizmoduleid = get_field('modules', 'id', 'name', 'quiz'); + + return get_records_sql_menu(" + SELECT quiz.id,1 + + FROM {$CFG->prefix}quiz quiz + JOIN {$CFG->prefix}course_modules cm ON cm.module = {$quizmoduleid} + AND cm.instance = quiz.id + JOIN {$CFG->prefix}course c ON quiz.course = c.id + LEFT JOIN vl_v_crs_version_pres v ON v.vle_course_short_name = c.shortname + AND v.vle_control_course = 'Y' + + WHERE cm.idnumber <> '' + OR v.vle_student_close_date IS NULL + OR (v.vle_student_close_date > '2010-12-01' AND c.shortname <> 'MU123-10B') + "); + + } else { + return get_records_menu('quiz', '', '', 'id', 'id,1'); + } + } + + public function convert_all_quiz_attempts() { + $quizids = $this->get_quiz_ids(); + if (!$quizids) { + return true; + } + + $done = 0; + $outof = count($quizids); + $this->logger = new question_engine_assumption_logger(); + + $success = true; + foreach ($quizids as $quizid => $notused) { + $this->print_progress($done, $outof, $quizid); + + $quiz = get_record('quiz', 'id', $quizid); + $success = $success && $this->update_all_attemtps_at_quiz($quiz); + if (!$success) { + return false; + } + + $done += 1; + } + + $this->print_progress($outof, $outof, 'All done!'); + $this->logger = null; + return $success; + } + + public function get_attemtps_where($quizid) { + return "quiz = {$quizid} AND preview = 0 AND needsupgradetonewqe = 1"; + } + + public function update_all_attemtps_at_quiz($quiz) { + global $CFG; + + // Wipe question loader cache. + $this->questionloader = new question_engine_upgrade_question_loader($this->logger); + + begin_sql(); + + $where = $this->get_attemtps_where($quiz->id); + + $quizattemptsrs = get_recordset_select('quiz_attempts', $where, 'uniqueid'); + $questionsessionsrs = get_recordset_sql(" + SELECT * + FROM {$CFG->prefix}question_sessions + WHERE attemptid IN ( + SELECT uniqueid FROM {$CFG->prefix}quiz_attempts WHERE $where) + ORDER BY attemptid, questionid + "); + + $questionsstatesrs = get_recordset_sql(" + SELECT * + FROM {$CFG->prefix}question_states + WHERE attempt IN ( + SELECT uniqueid FROM {$CFG->prefix}quiz_attempts WHERE $where) + ORDER BY attempt, question, seq_number, id + "); + + $success = $quizattemptsrs && $questionsessionsrs && $questionsstatesrs; + while ($success && ($attempt = rs_fetch_next_record($quizattemptsrs))) { + $success = $success && $this->convert_quiz_attempt( + $quiz, $attempt, $questionsessionsrs, $questionsstatesrs); + } + + rs_close($quizattemptsrs); + rs_close($questionsessionsrs); + rs_close($questionsstatesrs); + + if ($success) { + commit_sql(); + } else { + rollback_sql(); + } + + return $success; + } + + protected function convert_quiz_attempt($quiz, $attempt, $questionsessionsrs, $questionsstatesrs) { + $qas = array(); + $this->logger->set_current_attempt_id($attempt->id); + while ($qsession = $this->get_next_question_session($attempt, $questionsessionsrs)) { + $question = $this->load_question($qsession->questionid, $quiz->id); + $qstates = $this->get_question_states($attempt, $question, $questionsstatesrs); + try { + $qas[$qsession->questionid] = $this->convert_question_attempt($quiz, $attempt, $question, $qsession, $qstates); + } catch (Exception $e) { + notify($e->getMessage()); + } + } + $this->logger->set_current_attempt_id(null); + + if (empty($qas)) { + $this->logger->log_assumption("All the question attempts for + attempt {$attempt->id} at quiz {$attempt->quiz} were missing. + Deleting this attempt", $attempt->id); + // Somehow, all the question attempt data for this quiz attempt + // was lost. (This seems to have happened on labspace.) + // Delete the corresponding quiz attempt. + return $this->delete_quiz_attempt($attempt->uniqueid); + } + + $questionorder = array(); + foreach (explode(',', $quiz->questions) as $questionid) { + if ($questionid == 0) { + continue; + } + if (!array_key_exists($questionid, $qas)) { + $this->logger->log_assumption("Supplying minimal open state for + question {$questionid} in attempt {$attempt->id} at quiz + {$attempt->quiz}, since the session was missing.", $attempt->id); + try { + $qas[$questionid] = $this->supply_missing_question_attempt( + $quiz, $attempt, $question); + } catch (Exception $e) { + notify($e->getMessage()); + } + } + } + + return $this->save_usage($quiz->preferredbehaviour, $attempt, $qas, $quiz->questions); + } + + protected function save_usage($preferredbehaviour, $attempt, $qas, $quizlayout) { + $missing = array(); + $success = true; + + $layout = explode(',', $attempt->layout); + $questionkeys = array_combine(array_values($layout), array_keys($layout)); + + $success = $success && $this->set_quba_preferred_behaviour($attempt->uniqueid, $preferredbehaviour); + if (!$success) { + return false; + } + + $i = 0; + foreach (explode(',', $quizlayout) as $questionid) { + if ($questionid == 0) { + continue; + } + $i++; + + if (!array_key_exists($questionid, $qas)) { + $missing[] = $questionid; + continue; + } + + $qa = $qas[$questionid]; + $qa->questionusageid = $attempt->uniqueid; + $qa->slot = $i; + $success = $success && $this->insert_record('question_attempts', $qa); + if (!$success) { + return false; + } + $layout[$questionkeys[$questionid]] = $qa->slot; + + foreach ($qa->steps as $step) { + $step->questionattemptid = $qa->id; + $success = $success && $this->insert_record('question_attempt_steps', $step); + if (!$success) { + return false; + } + + foreach ($step->data as $name => $value) { + $datum = new stdClass(); + $datum->attemptstepid = $step->id; + $datum->name = $name; + $datum->value = $value; + $success = $success && $this->insert_record( + 'question_attempt_step_data', $datum, false); + } + } + } + + $success = $success && $this->set_quiz_attempt_layout($attempt->uniqueid, implode(',', $layout)); + + if ($missing) { + notify("Question sessions for questions " . + implode(', ', $missing) . + " were missing when upgrading question usage {$attempt->uniqueid}."); + } + + return $success; + } + + protected function set_quba_preferred_behaviour($qubaid, $preferredbehaviour) { + return set_field('question_usages', 'preferredbehaviour', $preferredbehaviour, 'id', $qubaid); + } + + protected function set_quiz_attempt_layout($qubaid, $layout) { + $success = true; + $success = $success && set_field('quiz_attempts', 'layout', $layout, 'uniqueid', $qubaid); + $success = $success && set_field('quiz_attempts', 'needsupgradetonewqe', 0, 'uniqueid', $qubaid); + return $success; + } + + protected function delete_quiz_attempt($qubaid) { + $success = true; + $success = $success && delete_records('quiz_attempts', 'uniqueid', $qubaid); + $success = $success && delete_records('question_attempts', 'id', $qubaid); + return $success; + } + + protected function escape_fields($record) { + foreach (get_object_vars($record) as $field => $value) { + if (is_string($value)) { + $record->$field = addslashes($value); + } + } + } + protected function insert_record($table, $record, $saveid = true) { + $this->escape_fields($record); + $newid = insert_record($table, $record, $saveid); + if ($saveid) { + $record->id = $newid; + } + return $newid; + } + + public function load_question($questionid, $quizid = null) { + return $this->questionloader->get_question($questionid, $quizid); + } + + public function get_next_question_session($attempt, $questionsessionsrs) { + $qsession = rs_fetch_record($questionsessionsrs); + + if (!$qsession || $qsession->attemptid != $attempt->uniqueid) { + // No more question sessions belonging to this attempt. + return false; + } + + // Session found, move the pointer in the RS and return the record. + rs_next_record($questionsessionsrs); + return $qsession; + } + + public function get_question_states($attempt, $question, $questionsstatesrs) { + $qstates = array(); + + while ($state = rs_fetch_record($questionsstatesrs)) { + if (!$state || $state->attempt != $attempt->uniqueid || + $state->question != $question->id) { + // We have found all the states for this attempt. Stop. + break; + } + + // Add the new state to the array, and advance. + $qstates[$state->seq_number] = $state; + rs_next_record($questionsstatesrs); + } + + return $qstates; + } + + public function format_var($name, $var) { + $out = var_export($var, true); + $out = str_replace('<', '<', $out); + $out = str_replace('ADOFetchObj::__set_state(array(', '(object) array(', $out); + $out = str_replace('stdClass::__set_state(array(', '(object) array(', $out); + $out = str_replace('array (', 'array(', $out); + $out = preg_replace('/=> \n\s*/', '=> ', $out); + $out = str_replace(')),', '),', $out); + $out = str_replace('))', ')', $out); + $out = preg_replace('/\n (?! )/', "\n ", $out); + $out = preg_replace('/\n (?! )/', "\n ", $out); + $out = preg_replace('/\n (?! )/', "\n ", $out); + $out = preg_replace('/\n (?! )/', "\n ", $out); + $out = preg_replace('/\n (?! )/', "\n ", $out); + $out = preg_replace('/\n (?! )/', "\n ", $out); + $out = preg_replace('/\n (?! )/', "\n ", $out); + $out = preg_replace('/\n(?! )/', "\n ", $out); + return " $name = $out;\n"; + } + + public function display_convert_attempt_input($quiz, $attempt, $question, $qsession, $qstates) { + echo $this->format_var('$quiz', $quiz); + echo $this->format_var('$attempt', $attempt); + echo $this->format_var('$question', $question); + echo $this->format_var('$qsession', $qsession); + echo $this->format_var('$qstates', $qstates); + } + + protected function get_converter_class_name($question, $quiz, $qsessionid) { + if (in_array($question->qtype, array('calculated', 'multianswer', 'randomsamatch'))) { + throw new coding_exception("Question session {$qsessionid} uses unsupported question type {$question->qtype}."); + } else if ($question->qtype == 'essay') { + return 'qbehaviour_manualgraded_converter'; + } else if ($question->qtype == 'description') { + return 'qbehaviour_informationitem_converter'; + } else if ($question->qtype == 'opaque') { + return 'qbehaviour_opaque_converter'; + } else if ($quiz->preferredbehaviour == 'interactive') { + return 'qbehaviour_interactive_converter'; + } else if ($quiz->preferredbehaviour == 'deferredfeedback') { + return 'qbehaviour_deferredfeedback_converter'; + } else { + throw new coding_exception("Question session {$qsessionid} has an unexpected preferred behaviour {$quiz->preferredbehaviour}."); + } + } + + public function supply_missing_question_attempt($quiz, $attempt, $question) { + if ($question->qtype == 'random') { + throw new coding_exception("Cannot supply a missing qsession for question {$question->id} in attempt {$attempt->id}."); + } + + $converterclass = $this->get_converter_class_name($question, $quiz, 'missing'); + + $qbehaviourupdater = new $converterclass($quiz, $attempt, $question, null, null, $this->logger); + $qa = $qbehaviourupdater->supply_missing_qa(); + $qbehaviourupdater->discard(); + return $qa; + } + + public function convert_question_attempt($quiz, $attempt, $question, $qsession, $qstates) { + $this->prevent_timeout(); + + if ($question->qtype == 'random') { + list($question, $qstates) = $this->decode_random_attempt($qstates, $question->maxmark); + $qsession->questionid = $question->id; + } + + $converterclass = $this->get_converter_class_name($question, $quiz, $qsession->id); + + $qbehaviourupdater = new $converterclass($quiz, $attempt, $question, $qsession, $qstates, $this->logger); + $qa = $qbehaviourupdater->get_converted_qa(); + $qbehaviourupdater->discard(); + return $qa; + } + + protected function decode_random_attempt($qstates, $maxmark) { + $realquestionid = null; + foreach ($qstates as $i => $state) { + if (strpos($state->answer, '-') < 6) { + // Broken state, skip it. + $this->logger->log_assumption("Had to skip brokes state {$state->id} + for question {$state->question}."); + unset($qstates[$i]); + continue; + } + list($randombit, $realanswer) = explode('-', $state->answer, 2); + $newquestionid = substr($randombit, 6); + if ($realquestionid && $realquestionid != $newquestionid) { + throw new coding_exception("Question session {$this->qsession->id} for random question points to two different real questions {$realquestionid} and {$newquestionid}."); + } + $qstates[$i]->answer = $realanswer; + } + + if (empty($newquestionid)) { + // This attempt only had broken states. Set a fake $newquestionid to + // prevent a null DB error later. + $newquestionid = 0; + } + + $newquestion = $this->load_question($newquestionid); + $newquestion->maxmark = $maxmark; + return array($newquestion, $qstates); + } +} + +/** + * This class deals with loading (and caching) question definitions during the + * question engine upgrade. + * + * @copyright 2010 The Open University + * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later + */ +class question_engine_upgrade_question_loader { + private $cache = array(); + + public function __construct($logger) { + $this->logger = $logger; + } + + protected function load_question($questionid, $quizid) { + global $CFG, $QTYPES; + + if ($quizid) { + $question = get_record_sql(" + SELECT q.*, qqi.grade AS maxmark + FROM {$CFG->prefix}question q + JOIN {$CFG->prefix}quiz_question_instances qqi ON qqi.question = q.id + WHERE q.id = $questionid AND qqi.quiz = $quizid"); + } else { + $question = get_record('question', 'id', $questionid); + } + + if (!$question) { + return null; + } + + if (empty($question->defaultmark)) { + if (!empty($question->defaultgrade)) { + $question->defaultmark = $question->defaultgrade; + } else { + $question->defaultmark = 0; + } + unset($question->defaultgrade); + } + + if (!array_key_exists($question->qtype, $QTYPES)) { + $this->logger->log_assumption("Dealing with question id {$question->id} + that is of an unknown type {$question->qtype}."); + $question->qtype = 'missingtype'; + $question->questiontext = '' . get_string('warningmissingtype', 'quiz') . '
' . $question->questiontext; + } + + $QTYPES[$question->qtype]->get_question_options($question); + + return $question; + } + + public function get_question($questionid, $quizid) { + if (isset($this->cache[$questionid])) { + return $this->cache[$questionid]; + } + + $question = $this->load_question($questionid, $quizid); + + if (!$question) { + $this->logger->log_assumption("Dealing with question id {$questionid} + that was missing from the database."); + $question = new stdClass(); + $question->id = $questionid; + $question->qtype = 'deleted'; + $question->maxmark = 1; // Guess, but that is all we can do. + $question->questiontext = get_string('deletedquestiontext', 'qtype_missingtype'); + } + + $this->cache[$questionid] = $question; + return $this->cache[$questionid]; + } +} + + +abstract class qbehaviour_converter { + protected $qtypeupdater; + protected $logger; + + protected $qa; + + protected $quiz; + protected $attempt; + protected $question; + protected $qsession; + protected $qstates; + + protected $sequencenumber; + protected $finishstate; + protected $alreadystarted; + + public function __construct($quiz, $attempt, $question, $qsession, $qstates, $logger) { + $this->quiz = $quiz; + $this->attempt = $attempt; + $this->question = $question; + $this->qsession = $qsession; + $this->qstates = $qstates; + $this->logger = $logger; + } + + public function discard() { + // Help the garbage collector, which seems to be struggling. + $this->quiz = null; + $this->attempt = null; + $this->question = null; + $this->qsession = null; + $this->qstates = null; + $this->qa = null; + $this->qtypeupdater->discard(); + $this->qtypeupdater = null; + $this->logger = null; + } + + protected abstract function behaviour_name(); + + public function get_converted_qa() { + $this->initialise_qa(); + $this->convert_steps(); + return $this->qa; + } + + protected function create_missing_first_step() { + $step = new stdClass(); + $step->state = 'todo'; + $step->data = array(); + $step->fraction = null; + $step->timecreated = $this->attempt->timestart; + $step->userid = $this->attempt->userid; + $this->qtypeupdater->supply_missing_first_step_data($step->data); + return $step; + } + + public function supply_missing_qa() { + $this->initialise_qa(); + $this->qa->timemodified = $this->attempt->timestart; + $this->sequencenumber = 0; + $this->add_step($this->create_missing_first_step()); + return $this->qa; + } + + protected function initialise_qa() { + $this->qtypeupdater = $this->make_qtype_updater(); + + $qa = new stdClass(); + $qa->questionid = $this->question->id; + $qa->behaviour = $this->behaviour_name(); + $qa->maxmark = $this->question->maxmark; + $qa->minfraction = 0; + $qa->flagged = 0; + $qa->questionsummary = $this->qtypeupdater->question_summary($this->question); + $qa->rightanswer = $this->qtypeupdater->right_answer($this->question); + $qa->responsesummary = ''; + $qa->timemodified = 0; + $qa->steps = array(); + + $this->qa = $qa; + } + + protected function convert_steps() { + $this->finishstate = null; + $this->startstate = null; + $this->sequencenumber = 0; + foreach ($this->qstates as $state) { + $this->process_state($state); + } + $this->finish_up(); + } + + protected function process_state($state) { + $step = $this->make_step($state); + $method = 'process' . $state->event; + $this->$method($step, $state); + } + + protected function finish_up() { + } + + protected function add_step($step) { + $step->sequencenumber = $this->sequencenumber; + $this->qa->steps[] = $step; + $this->sequencenumber++; + } + + protected function discard_last_state() { + array_pop($this->qa->steps); + $this->sequencenumber--; + } + + protected function unexpected_event($state) { + throw new coding_exception("Unexpected event {$state->event} in state {$state->id} in question session {$this->qsession->id}."); + } + + protected function process0($step, $state) { + if ($this->startstate) { + if ($state->answer == reset($this->qstates)->answer) { + return; + } else if ($this->quiz->attemptonlast && $this->sequencenumber == 1) { + // There was a bug in attemptonlast in the past, which meant that + // it created two inconsistent open states, with the second taking + // priority. Simulate that be discarding the first open state, then + // continuing. + $this->logger->log_assumption("Ignoring bogus state in attempt at question {$state->question}"); + $this->sequencenumber = 0; + $this->qa->steps = array(); + } else if ($state->answer == '') { + $this->logger->log_assumption("Ignoring second start state with blank answer in attempt at question {$state->question}"); + return; + } else { + throw new coding_exception("Two inconsistent open states for question session {$this->qsession->id}."); + } + } + $step->state = 'todo'; + $this->startstate = $state; + $this->add_step($step); + } + + protected function process1($step, $state) { + $this->unexpected_event($state); + } + + protected function process2($step, $state) { + if ($this->qtypeupdater->was_answered($state)) { + $step->state = 'complete'; + } else { + $step->state = 'todo'; + } + $this->add_step($step); + } + + protected function process3($step, $state) { + return $this->process6($step, $state); + } + + protected function process4($step, $state) { + $this->unexpected_event($state); + } + + protected function process5($step, $state) { + $this->unexpected_event($state); + } + + protected abstract function process6($step, $state); + protected abstract function process7($step, $state); + + protected function process8($step, $state) { + return $this->process6($step, $state); + } + + protected function process9($step, $state) { + if (!$this->finishstate) { + $submitstate = clone($state); + $submitstate->event = 8; + $submitstate->grade = 0; + $this->process_state($submitstate); + } + + $step->data['-comment'] = addslashes($this->qsession->manualcomment); + if ($this->question->maxmark > 0) { + $step->fraction = $state->grade / $this->question->maxmark; + $step->state = $this->manual_graded_state_for_fraction($step->fraction); + $step->data['-mark'] = $state->grade; + $step->data['-maxmark'] = $this->question->maxmark; + } else { + $step->state = 'manfinished'; + } + unset($step->data['answer']); + $step->userid = null; + $this->add_step($step); + } + + protected function process10($step, $state) { + $this->unexpected_event($state); + } + + /** + * @param stdClass $question a question definition + * @return qtype_updater + */ + protected function make_qtype_updater() { + $class = 'qtype_' . $this->question->qtype . '_updater'; + return new $class($this, $this->question, $this->logger); + } + + public function to_text($html) { + return trim(html_to_text($html, 0, false)); + } + + protected function graded_state_for_fraction($fraction) { + if ($fraction < 0.000001) { + return 'gradedwrong'; + } else if ($fraction > 0.999999) { + return 'gradedright'; + } else { + return 'gradedpartial'; + } + } + + protected function manual_graded_state_for_fraction($fraction) { + if ($fraction < 0.000001) { + return 'mangrwrong'; + } else if ($fraction > 0.999999) { + return 'mangrright'; + } else { + return 'mangrpartial'; + } + } + + protected function make_step($state){ + $step = new stdClass(); + $step->data = array(); + + if ($state->event == 0 || $this->sequencenumber == 0) { + $this->qtypeupdater->set_first_step_data_elements($state, $step->data); + } else { + $this->qtypeupdater->set_data_elements_for_step($state, $step->data); + } + + $step->fraction = null; + $step->timecreated = $state->timestamp; + $step->userid = $this->attempt->userid; + + $summary = $this->qtypeupdater->response_summary($state); + if (!is_null($summary)) { + $this->qa->responsesummary = $summary; + } + $this->qa->timemodified = max($this->qa->timemodified, $state->timestamp); + + return $step; + } +} + + +class qbehaviour_informationitem_converter extends qbehaviour_converter { + protected function behaviour_name() { + return 'informationitem'; + } + + protected function process0($step, $state) { + if ($this->startstate) { + return; + } + $step->state = 'todo'; + $this->startstate = $state; + $this->add_step($step); + } + + protected function process2($step, $state) { + $this->unexpected_event($state); + } + + protected function process3($step, $state) { + $this->unexpected_event($state); + } + + protected function process6($step, $state) { + if ($this->finishstate) { + return; + } + + $step->state = 'finished'; + $step->data['-finish'] = '1'; + $this->finishstate = $state; + $this->add_step($step); + } + + protected function process7($step, $state) { + return $this->process6($step, $state); + } + + protected function process8($step, $state) { + return $this->process6($step, $state); + } +} + + +class qbehaviour_opaque_converter extends qbehaviour_converter { + protected function behaviour_name() { + return 'opaque'; + } + + protected function create_missing_first_step() { + global $CFG; + $step = parent::create_missing_first_step(); + $step->data['-_preferredbehaviour'] = $this->quiz->preferredbehaviour; + $step->data['-_language'] = $CFG->lang; + $step->data['-_userid'] = $step->userid; + $step->data['-_statestring'] = 'You have [N] attempts.'; + return $step; + } + + protected function process0($step, $state) { + global $CFG; + $ok = parent::process0($step, $state); + $step->data['-_preferredbehaviour'] = $this->quiz->preferredbehaviour; + $step->data['-_language'] = $CFG->lang; + $step->data['-_userid'] = $step->userid; + $step->data['-_statestring'] = 'You have [N] attempts.'; + return $ok; + } + + protected function process2($step, $state) { + $step->state = 'todo'; + $this->add_step($step); + } + + protected function process3($step, $state) { + return $this->process2($step, $state); + } + + protected function process6($step, $state) { + if ($this->finishstate) { + throw new coding_exception("Two finish states found for opaque question session {$this->qsession->id}."); + } + + if (array_key_exists('-_actionSummary', $step->data) && + $step->data['-_actionSummary'] == '[Not completed]') { + $this->finish_up(); + return; + } + + if ($this->question->maxmark > 0) { + $step->fraction = $state->grade / $this->question->maxmark; + $step->state = $this->graded_state_for_fraction($step->fraction); + } else { + $step->state = 'finished'; + } + $this->finishstate = $state; + $this->add_step($step); + } + + protected function process7($step, $state) { + $this->unexpected_event($state); + } + + protected function process8($step, $state) { + $this->process6($step, $state); + } + + protected function finish_up() { + if ($this->finishstate || !$this->attempt->timefinish) { + return; + } + + $state = end($this->qstates); + $step = $this->make_step($state); + $step->data = array('-finish' => 1); + $step->state = 'gaveup'; + $this->qa->responsesummary = '[Not completed]'; + $this->finishstate = $state; + $this->add_step($step); + } +} + + +class qbehaviour_manualgraded_converter extends qbehaviour_converter { + protected function behaviour_name() { + return 'manualgraded'; + } + + protected function process6($step, $state) { + $step->state = 'needsgrading'; + if (!$this->finishstate) { + $step->data['-finish'] = '1'; + $this->finishstate = $state; + } + $this->add_step($step); + } + + protected function process7($step, $state) { + return $this->process6($step, $state); + } +} + + +class qbehaviour_interactive_converter extends qbehaviour_converter { + protected $triesleft; + + protected function behaviour_name() { + return 'interactive'; + } + + protected function finish_up() { + if ($this->triesleft == 0 || !$this->attempt->timefinish) { + return; + } + + $state = end($this->qstates); + $step = $this->make_step($state); + $step->data['-finish'] = 1; + + if ($this->question->maxmark > 0) { + $step->fraction = $state->grade / $this->question->maxmark; + $step->state = $this->graded_state_for_fraction($step->fraction); + } else { + $step->state = 'finished'; + } + + $this->add_step($step); + } + + protected function process0($step, $state) { + $this->triesleft = 1; + if (!empty($this->question->hints)) { + $this->triesleft += count($this->question->hints); + } + $step->data['-_triesleft'] = $this->triesleft; + parent::process0($step, $state); + } + + protected function process2($step, $state) { + if ($this->finishstate) { + $this->logger->log_assumption("Ignoring bogus save after submit, and before try again, in interactive attempt at question {$state->question} (question session {$this->qsession->id})"); + return; + } + parent::process2($step, $state); + } + + protected function process3($step, $state) { + if ($state->id == $this->qsession->newgraded) { + return $this->process6($step, $state); + } else { + return; + } + } + + protected function process6($step, $state) { + if ($this->finishstate) { + if (!$this->qtypeupdater->compare_answers($this->finishstate->answer, $state->answer) || + $this->finishstate->grade != $state->grade || + $this->finishstate->raw_grade != $state->raw_grade || + $this->finishstate->penalty != $state->penalty) { + throw new coding_exception("Two inconsistent finish states found for question session {$this->qsession->id}."); + } else if ($this->triesleft) { + $step->data = array('-finish' => '1'); + if ($this->question->maxmark > 0) { + $step->fraction = $state->grade / $this->question->maxmark; + $step->state = $this->graded_state_for_fraction($step->fraction); + } else { + $step->state = 'finished'; + } + $this->finishstate = $state; + $this->add_step($step); + $this->triesleft = 0; + return; + } else { + $this->logger->log_assumption("Ignoring extra finish states in attempt at question {$state->question}"); + return; + } + } + + if ($this->question->maxmark > 0) { + $step->fraction = $state->grade / $this->question->maxmark; + $step->state = $this->graded_state_for_fraction($state->raw_grade / $this->question->maxmark); + } else { + $step->state = 'finished'; + } + + $this->triesleft--; + $step->data['-submit'] = '1'; + if ($this->triesleft && $step->state != 'gradedright') { + $step->state = 'todo'; + $step->fraction = null; + $step->data['-_triesleft'] = $this->triesleft; + } else { + $this->triesleft = 0; + } + $this->finishstate = $state; + $this->add_step($step); + } + + protected function process7($step, $state) { + $this->unexpected_event($state); + } + + protected function process10($step, $state) { + if (!$this->finishstate) { + $oldcount = $this->sequencenumber; + $this->process6($step, $state); + if ($this->sequencenumber != $oldcount + 1) { + throw new coding_exception('Submit before try again did not keep the step.'); + } + $step = $this->make_step($state); + } + + $step->state = 'todo'; + $step->data = array('-tryagain' => 1); + $this->finishstate = null; + $this->add_step($step); + } +} + + +class qbehaviour_deferredfeedback_converter extends qbehaviour_converter { + protected function behaviour_name() { + return 'deferredfeedback'; + } + + protected function process6($step, $state) { + if (!$this->startstate) { + $this->logger->log_assumption("Ignoring bogus submit before open in attempt at question {$state->question}"); + // WTF, but this has happened a few times in our DB. It seems it is safe to ignore. + return; + } + + if ($this->finishstate) { + if ($this->finishstate->answer != $state->answer || + $this->finishstate->grade != $state->grade || + $this->finishstate->raw_grade != $state->raw_grade || + $this->finishstate->penalty != $state->penalty) { + $this->logger->log_assumption("Two inconsistent finish states found for question session {$this->qsession->id} in attempt at question {$state->question} keeping the later one."); + $this->discard_last_state(); + } else { + $this->logger->log_assumption("Ignoring extra finish states in attempt at question {$state->question}"); + return; + } + } + + if ($this->question->maxmark > 0) { + $step->fraction = $state->grade / $this->question->maxmark; + $step->state = $this->graded_state_for_fraction($step->fraction); + } else { + $step->state = 'finished'; + } + $step->data['-finish'] = '1'; + $this->finishstate = $state; + $this->add_step($step); + } + + protected function process7($step, $state) { + $this->unexpected_event($state); + } +} + + +abstract class qtype_updater { + /** @var question_engine_attempt_upgrader */ + protected $question; + protected $updater; + /** @var question_engine_assumption_logger */ + protected $logger; + + public function __construct($updater, $question, $logger) { + $this->updater = $updater; + $this->question = $question; + $this->logger = $logger; + } + + public function discard() { + // Help the garbage collector, which seems to be struggling. + $this->updater = null; + $this->question = null; + $this->logger = null; + } + + protected function to_text($html) { + return $this->updater->to_text($html); + } + + public function question_summary() { + return $this->to_text($this->question->questiontext); + } + + public function compare_answers($answer1, $answer2) { + return $answer1 == $answer2; + } + + public abstract function right_answer(); + public abstract function response_summary($state); + public abstract function was_answered($state); + public abstract function set_first_step_data_elements($state, &$data); + public abstract function set_data_elements_for_step($state, &$data); + public abstract function supply_missing_first_step_data(&$data); +} + +class qtype_multichoice_updater extends qtype_updater { + protected $order; + + public function right_answer() { + if ($this->question->options->single) { + foreach ($this->question->options->answers as $ans) { + if ($ans->fraction > 0.999) { + return $this->to_text($ans->answer); + } + } + + } else { + $rightbits = array(); + foreach ($this->question->options->answers as $ans) { + if ($ans->fraction >= 0.000001) { + $rightbits[] = $this->to_text($ans->answer); + } + } + return implode('; ', $rightbits); + } + } + + protected function explode_answer($answer) { + if (strpos($answer, ':') !== false) { + list($order, $responses) = explode(':', $answer); + return $responses; + } else { + // Sometimes, a bug means that a state is missing the- ';
+ foreach ($permissionstrs as $permissionstr){
+ $html .= '
- '.$permissionstr.' '; + } + $html .= '
' . $flagcontent . "
\n";
+ }
+ }
+
+ /**
+ * Work out the actual img tag needed for the flag
+ *
+ * @param boolean $flagged whether the question is currently flagged.
+ * @param string $id an id to be added as an attribute to the img (optional).
+ * @return string the img tag.
+ */
+ protected function get_question_flag_tag($flagged, $id = '') {
+ global $OUTPUT;
+ if ($id) {
+ $id = 'id="' . $id . '" ';
+ }
+ if ($flagged) {
+ $img = 'i/flagged';
+ } else {
+ $img = 'i/unflagged';
+ }
+ return '' . get_string($class, 'quiz') . '
';
+
+ echo '';
+ // print grade for this submission
+ print_string('gradingdetails', 'quiz', $grade);
+ if ($cmoptions->penaltyscheme) {
+ // print details of grade adjustment due to penalties
+ if ($state->last_graded->raw_grade > $state->last_graded->grade){
+ echo ' ';
+ print_string('gradingdetailsadjustment', 'quiz', $grade);
+ }
+ // print info about new penalty
+ // penalty is relevant only if the answer is not correct and further attempts are possible
+ if (($state->last_graded->raw_grade < $question->maxgrade / 1.01)
+ and (QUESTION_EVENTCLOSEANDGRADE != $state->event)) {
+
+ if ('' !== $state->last_graded->penalty && ((float)$state->last_graded->penalty) > 0.0) {
+ // A penalty was applied so display it
+ echo ' ';
+ print_string('gradingdetailspenalty', 'quiz', question_format_grade($cmoptions, $state->last_graded->penalty));
+ } else {
+ /* No penalty was applied even though the answer was
+ not correct (eg. a syntax error) so tell the student
+ that they were not penalised for the attempt */
+ echo ' ';
+ print_string('gradingdetailszeropenalty', 'quiz');
+ }
+ }
+ }
+ echo '
';
+ }
+ }
+ }
+
+ /**
+ * Prints the main content of the question including any interactions
+ *
+ * This function prints the main content of the question including the
+ * interactions for the question in the state given. The last graded responses
+ * are printed or indicated and the current responses are selected or filled in.
+ * Any names (eg. for any form elements) are prefixed with $question->name_prefix.
+ * This method is called from the print_question method.
+ * @param object $question The question to be rendered. Question type
+ * specific information is included. The name
+ * prefix for any named elements is in ->name_prefix.
+ * @param object $state The state to render the question in. The grading
+ * information is in ->grade, ->raw_grade and
+ * ->penalty. The current responses are in
+ * ->responses. This is an associative array (or the
+ * empty string or null in the case of no responses
+ * submitted). The last graded state is in
+ * ->last_graded (hence the most recently graded
+ * responses are in ->last_graded->responses). The
+ * question type specific information is also
+ * included.
+ * The state is passed by reference because some adaptive
+ * questions may want to update it during rendering
+ * @param object $cmoptions
+ * @param object $options An object describing the rendering options.
+ */
+ function print_question_formulation_and_controls(&$question, &$state, $cmoptions, $options) {
+ /* This default implementation prints an error and must be overridden
+ by all question type implementations, unless the default implementation
+ of print_question has been overridden. */
+ global $OUTPUT;
+ echo $OUTPUT->notification('Error: Question formulation and input controls has not'
+ .' been implemented for question type '.$this->name());
+ }
+
+ function check_file_access($question, $state, $options, $contextid, $component,
+ $filearea, $args) {
+
+ if ($component == 'question' && $filearea == 'questiontext') {
+ // Question text always visible.
+ return true;
+
+ } else if ($component == 'question' && $filearea = 'generalfeedback') {
+ return $options->generalfeedback && question_state_is_graded($state->last_graded);
+
+ } else {
+ // Unrecognised component or filearea.
+ return false;
+ }
+ }
+
+ /**
+ * Prints the submit button(s) for the question in the given state
+ *
+ * This function prints the submit button(s) for the question in the
+ * given state. The name of any button created will be prefixed with the
+ * unique prefix for the question in $question->name_prefix. The suffix
+ * 'submit' is reserved for the single question submit button and the suffix
+ * 'validate' is reserved for the single question validate button (for
+ * question types which support it). Other suffixes will result in a response
+ * of that name in $state->responses which the printing and grading methods
+ * can then use.
+ * @param object $question The question for which the submit button(s) are to
+ * be rendered. Question type specific information is
+ * included. The name prefix for any
+ * named elements is in ->name_prefix.
+ * @param object $state The state to render the buttons for. The
+ * question type specific information is also
+ * included.
+ * @param object $cmoptions
+ * @param object $options An object describing the rendering options.
+ */
+ function print_question_submit_buttons(&$question, &$state, $cmoptions, $options) {
+ // The default implementation should be suitable for most question types.
+ // It prints a mark button in the case where individual marking is allowed.
+ if (($cmoptions->optionflags & QUESTION_ADAPTIVE) and !$options->readonly) {
+ echo '';
+ }
+ }
+
+ /**
+ * Return a summary of the student response
+ *
+ * This function returns a short string of no more than a given length that
+ * summarizes the student's response in the given $state. This is used for
+ * example in the response history table. This string should already be
+ * formatted for output.
+ * @return string The summary of the student response
+ * @param object $question
+ * @param object $state The state whose responses are to be summarized
+ * @param int $length The maximum length of the returned string
+ */
+ function response_summary($question, $state, $length = 80, $formatting = true) {
+ // This should almost certainly be overridden
+ $responses = $this->get_actual_response($question, $state);
+ if ($formatting){
+ $responses = $this->format_responses($responses, $question->questiontextformat);
+ }
+ $responses = implode('; ', $responses);
+ return shorten_text($responses, $length);
+ }
+ /**
+ * @param array responses is an array of responses.
+ * @return formatted responses
+ */
+ function format_responses($responses, $format){
+ $toreturn = array();
+ foreach ($responses as $response){
+ $toreturn[] = $this->format_response($response, $format);
+ }
+ return $toreturn;
+ }
+ /**
+ * @param string response is a response.
+ * @return formatted response
+ */
+ function format_response($response, $format){
+ return s($response);
+ }
+ /**
+ * Renders the question for printing and returns the LaTeX source produced
+ *
+ * This function should render the question suitable for a printed problem
+ * or solution sheet in LaTeX and return the rendered output.
+ * @return string The LaTeX output.
+ * @param object $question The question to be rendered. Question type
+ * specific information is included.
+ * @param object $state The state to render the question in. The
+ * question type specific information is also
+ * included.
+ * @param object $cmoptions
+ * @param string $type Indicates if the question or the solution is to be
+ * rendered with the values 'question' and
+ * 'solution'.
+ */
+ function get_texsource(&$question, &$state, $cmoptions, $type) {
+ // The default implementation simply returns a string stating that
+ // the question is only available online.
+
+ return get_string('onlineonly', 'texsheet');
+ }
+
+ /**
+ * Compares two question states for equivalence of the student's responses
+ *
+ * The responses for the two states must be examined to see if they represent
+ * equivalent answers to the question by the student. This method will be
+ * invoked for each of the previous states of the question before grading
+ * occurs. If the student is found to have already attempted the question
+ * with equivalent responses then the attempt at the question is ignored;
+ * grading does not occur and the state does not change. Thus they are not
+ * penalized for this case.
+ * @return boolean
+ * @param object $question The question for which the states are to be
+ * compared. Question type specific information is
+ * included.
+ * @param object $state The state of the question. The responses are in
+ * ->responses. This is the only field of $state
+ * that it is safe to use.
+ * @param object $teststate The state whose responses are to be
+ * compared. The state will be of the same age or
+ * older than $state. If possible, the method should
+ * only use the field $teststate->responses, however
+ * any field that is set up by restore_session_and_responses
+ * can be used.
+ */
+ function compare_responses(&$question, $state, $teststate) {
+ // The default implementation performs a comparison of the response
+ // arrays. The ordering of the arrays does not matter.
+ // Question types may wish to override this (eg. to ignore trailing
+ // white space or to make "7.0" and "7" compare equal).
+
+ // In php neither == nor === compare arrays the way you want. The following
+ // ensures that the arrays have the same keys, with the same values.
+ $result = false;
+ $diff1 = array_diff_assoc($state->responses, $teststate->responses);
+ if (empty($diff1)) {
+ $diff2 = array_diff_assoc($teststate->responses, $state->responses);
+ $result = empty($diff2);
+ }
+
+ return $result;
+ }
+
+ /**
+ * Checks whether a response matches a given answer
+ *
+ * This method only applies to questions that use teacher-defined answers
+ *
+ * @return boolean
+ */
+ function test_response(&$question, &$state, $answer) {
+ $response = isset($state->responses['']) ? $state->responses[''] : '';
+ return ($response == $answer->answer);
+ }
+
+ /**
+ * Performs response processing and grading
+ *
+ * This function performs response processing and grading and updates
+ * the state accordingly.
+ * @return boolean Indicates success or failure.
+ * @param object $question The question to be graded. Question type
+ * specific information is included.
+ * @param object $state The state of the question to grade. The current
+ * responses are in ->responses. The last graded state
+ * is in ->last_graded (hence the most recently graded
+ * responses are in ->last_graded->responses). The
+ * question type specific information is also
+ * included. The ->raw_grade and ->penalty fields
+ * must be updated. The method is able to
+ * close the question session (preventing any further
+ * attempts at this question) by setting
+ * $state->event to QUESTION_EVENTCLOSEANDGRADE
+ * @param object $cmoptions
+ */
+ function grade_responses(&$question, &$state, $cmoptions) {
+ // The default implementation uses the test_response method to
+ // compare what the student entered against each of the possible
+ // answers stored in the question, and uses the grade from the
+ // first one that matches. It also sets the marks and penalty.
+ // This should be good enought for most simple question types.
+
+ $state->raw_grade = 0;
+ foreach($question->options->answers as $answer) {
+ if($this->test_response($question, $state, $answer)) {
+ $state->raw_grade = $answer->fraction;
+ break;
+ }
+ }
+
+ // Make sure we don't assign negative or too high marks.
+ $state->raw_grade = min(max((float) $state->raw_grade,
+ 0.0), 1.0) * $question->maxgrade;
+
+ // Update the penalty.
+ $state->penalty = $question->penalty * $question->maxgrade;
+
+ // mark the state as graded
+ $state->event = ($state->event == QUESTION_EVENTCLOSE) ? QUESTION_EVENTCLOSEANDGRADE : QUESTION_EVENTGRADE;
+
+ return true;
+ }
+
+ /**
+ * Returns true if the editing wizard is finished, false otherwise.
+ *
+ * The default implementation returns true, which is suitable for all question-
+ * types that only use one editing form. This function is used in
+ * question.php to decide whether we can regrade any states of the edited
+ * question and redirect to edit.php.
+ *
+ * The dataset dependent question-type, which is extended by the calculated
+ * question-type, overwrites this method because it uses multiple pages (i.e.
+ * a wizard) to set up the question and associated datasets.
+ *
+ * @param object $form The data submitted by the previous page.
+ *
+ * @return boolean Whether the wizard's last page was submitted or not.
+ */
+ function finished_edit_wizard(&$form) {
+ //In the default case there is only one edit page.
+ return true;
+ }
+
+ /**
+ * Call format_text from weblib.php with the options appropriate to question types.
+ *
+ * @param string $text the text to format.
+ * @param integer $text the type of text. Normally $question->questiontextformat.
+ * @param object $cmoptions the context the string is being displayed in. Only $cmoptions->course is used.
+ * @return string the formatted text.
+ */
+ function format_text($text, $textformat, $cmoptions = NULL) {
+ $formatoptions = new stdClass;
+ $formatoptions->noclean = true;
+ $formatoptions->para = false;
+ return format_text($text, $textformat, $formatoptions, $cmoptions === NULL ? NULL : $cmoptions->course);
+ }
+
+ /**
+ * @return the best link to pass to print_error.
+ * @param $cmoptions as passed in from outside.
+ */
+ function error_link($cmoptions) {
+ global $CFG;
+ $cm = get_coursemodule_from_instance('quiz', $cmoptions->id);
+ if (!empty($cm->id)) {
+ return $CFG->wwwroot . '/mod/quiz/view.php?id=' . $cm->id;
+ } else if (!empty($cm->course)) {
+ return $CFG->wwwroot . '/course/view.php?id=' . $cm->course;
+ } else {
+ return '';
+ }
+ }
+
+/// IMPORT/EXPORT FUNCTIONS /////////////////
+
+ /*
+ * Imports question from the Moodle XML format
+ *
+ * Imports question using information from extra_question_fields function
+ * If some of you fields contains id's you'll need to reimplement this
+ */
+ function import_from_xml($data, $question, $format, $extra=null) {
+ $question_type = $data['@']['type'];
+ if ($question_type != $this->name()) {
+ return false;
+ }
+
+ $extraquestionfields = $this->extra_question_fields();
+ if (!is_array($extraquestionfields)) {
+ return false;
+ }
+
+ //omit table name
+ array_shift($extraquestionfields);
+ $qo = $format->import_headers($data);
+ $qo->qtype = $question_type;
+
+ foreach ($extraquestionfields as $field) {
+ $qo->$field = $format->getpath($data, array('#',$field,0,'#'), $qo->$field);
+ }
+
+ // run through the answers
+ $answers = $data['#']['answer'];
+ $a_count = 0;
+ $extraasnwersfields = $this->extra_answer_fields();
+ if (is_array($extraasnwersfields)) {
+ //TODO import the answers, with any extra data.
+ } else {
+ foreach ($answers as $answer) {
+ $ans = $format->import_answer($answer);
+ $qo->answer[$a_count] = $ans->answer;
+ $qo->fraction[$a_count] = $ans->fraction;
+ $qo->feedback[$a_count] = $ans->feedback;
+ ++$a_count;
+ }
+ }
+ return $qo;
+ }
+
+ /*
+ * Export question to the Moodle XML format
+ *
+ * Export question using information from extra_question_fields function
+ * If some of you fields contains id's you'll need to reimplement this
+ */
+ function export_to_xml($question, $format, $extra=null) {
+ $extraquestionfields = $this->extra_question_fields();
+ if (!is_array($extraquestionfields)) {
+ return false;
+ }
+
+ //omit table name
+ array_shift($extraquestionfields);
+ $expout='';
+ foreach ($extraquestionfields as $field) {
+ $exportedvalue = $question->options->$field;
+ if (!empty($exportedvalue) && htmlspecialchars($exportedvalue) != $exportedvalue) {
+ $exportedvalue = '';
+ }
+ $expout .= " <$field>{$exportedvalue}\n";
+ }
+
+ $extraasnwersfields = $this->extra_answer_fields();
+ if (is_array($extraasnwersfields)) {
+ //TODO export answers with any extra data
+ } else {
+ foreach ($question->options->answers as $answer) {
+ $percent = 100 * $answer->fraction;
+ $expout .= " - ';
foreach ($permissionstrs as $permissionstr){
$html .= '
- '.$permissionstr.' '; } $html .= '
' . $flagcontent . "
\n";
- }
- }
-
- /**
- * Work out the actual img tag needed for the flag
- *
- * @param boolean $flagged whether the question is currently flagged.
- * @param string $id an id to be added as an attribute to the img (optional).
- * @return string the img tag.
- */
- protected function get_question_flag_tag($flagged, $id = '') {
- global $OUTPUT;
- if ($id) {
- $id = 'id="' . $id . '" ';
- }
- if ($flagged) {
- $img = 'i/flagged';
- } else {
- $img = 'i/unflagged';
- }
- return '' . get_string($class, 'quiz') . '
';
-
- echo '';
- // print grade for this submission
- print_string('gradingdetails', 'quiz', $grade);
- if ($cmoptions->penaltyscheme) {
- // print details of grade adjustment due to penalties
- if ($state->last_graded->raw_grade > $state->last_graded->grade){
- echo ' ';
- print_string('gradingdetailsadjustment', 'quiz', $grade);
- }
- // print info about new penalty
- // penalty is relevant only if the answer is not correct and further attempts are possible
- if (($state->last_graded->raw_grade < $question->maxgrade / 1.01)
- and (QUESTION_EVENTCLOSEANDGRADE != $state->event)) {
-
- if ('' !== $state->last_graded->penalty && ((float)$state->last_graded->penalty) > 0.0) {
- // A penalty was applied so display it
- echo ' ';
- print_string('gradingdetailspenalty', 'quiz', question_format_grade($cmoptions, $state->last_graded->penalty));
- } else {
- /* No penalty was applied even though the answer was
- not correct (eg. a syntax error) so tell the student
- that they were not penalised for the attempt */
- echo ' ';
- print_string('gradingdetailszeropenalty', 'quiz');
- }
- }
- }
- echo '
';
- }
- }
- }
-
- /**
- * Prints the main content of the question including any interactions
- *
- * This function prints the main content of the question including the
- * interactions for the question in the state given. The last graded responses
- * are printed or indicated and the current responses are selected or filled in.
- * Any names (eg. for any form elements) are prefixed with $question->name_prefix.
- * This method is called from the print_question method.
- * @param object $question The question to be rendered. Question type
- * specific information is included. The name
- * prefix for any named elements is in ->name_prefix.
- * @param object $state The state to render the question in. The grading
- * information is in ->grade, ->raw_grade and
- * ->penalty. The current responses are in
- * ->responses. This is an associative array (or the
- * empty string or null in the case of no responses
- * submitted). The last graded state is in
- * ->last_graded (hence the most recently graded
- * responses are in ->last_graded->responses). The
- * question type specific information is also
- * included.
- * The state is passed by reference because some adaptive
- * questions may want to update it during rendering
- * @param object $cmoptions
- * @param object $options An object describing the rendering options.
- */
- function print_question_formulation_and_controls(&$question, &$state, $cmoptions, $options) {
- /* This default implementation prints an error and must be overridden
- by all question type implementations, unless the default implementation
- of print_question has been overridden. */
- global $OUTPUT;
- echo $OUTPUT->notification('Error: Question formulation and input controls has not'
- .' been implemented for question type '.$this->name());
- }
-
- function check_file_access($question, $state, $options, $contextid, $component,
- $filearea, $args) {
-
- if ($component == 'question' && $filearea == 'questiontext') {
- // Question text always visible.
- return true;
-
- } else if ($component == 'question' && $filearea = 'generalfeedback') {
- return $options->generalfeedback && question_state_is_graded($state->last_graded);
-
- } else {
- // Unrecognised component or filearea.
- return false;
- }
- }
-
- /**
- * Prints the submit button(s) for the question in the given state
- *
- * This function prints the submit button(s) for the question in the
- * given state. The name of any button created will be prefixed with the
- * unique prefix for the question in $question->name_prefix. The suffix
- * 'submit' is reserved for the single question submit button and the suffix
- * 'validate' is reserved for the single question validate button (for
- * question types which support it). Other suffixes will result in a response
- * of that name in $state->responses which the printing and grading methods
- * can then use.
- * @param object $question The question for which the submit button(s) are to
- * be rendered. Question type specific information is
- * included. The name prefix for any
- * named elements is in ->name_prefix.
- * @param object $state The state to render the buttons for. The
- * question type specific information is also
- * included.
- * @param object $cmoptions
- * @param object $options An object describing the rendering options.
- */
- function print_question_submit_buttons(&$question, &$state, $cmoptions, $options) {
- // The default implementation should be suitable for most question types.
- // It prints a mark button in the case where individual marking is allowed.
- if (($cmoptions->optionflags & QUESTION_ADAPTIVE) and !$options->readonly) {
- echo '';
- }
- }
-
- /**
- * Return a summary of the student response
- *
- * This function returns a short string of no more than a given length that
- * summarizes the student's response in the given $state. This is used for
- * example in the response history table. This string should already be
- * formatted for output.
- * @return string The summary of the student response
- * @param object $question
- * @param object $state The state whose responses are to be summarized
- * @param int $length The maximum length of the returned string
- */
- function response_summary($question, $state, $length = 80, $formatting = true) {
- // This should almost certainly be overridden
- $responses = $this->get_actual_response($question, $state);
- if ($formatting){
- $responses = $this->format_responses($responses, $question->questiontextformat);
- }
- $responses = implode('; ', $responses);
- return shorten_text($responses, $length);
- }
- /**
- * @param array responses is an array of responses.
- * @return formatted responses
- */
- function format_responses($responses, $format){
- $toreturn = array();
- foreach ($responses as $response){
- $toreturn[] = $this->format_response($response, $format);
- }
- return $toreturn;
- }
- /**
- * @param string response is a response.
- * @return formatted response
- */
- function format_response($response, $format){
- return s($response);
- }
- /**
- * Renders the question for printing and returns the LaTeX source produced
- *
- * This function should render the question suitable for a printed problem
- * or solution sheet in LaTeX and return the rendered output.
- * @return string The LaTeX output.
- * @param object $question The question to be rendered. Question type
- * specific information is included.
- * @param object $state The state to render the question in. The
- * question type specific information is also
- * included.
- * @param object $cmoptions
- * @param string $type Indicates if the question or the solution is to be
- * rendered with the values 'question' and
- * 'solution'.
- */
- function get_texsource(&$question, &$state, $cmoptions, $type) {
- // The default implementation simply returns a string stating that
- // the question is only available online.
-
- return get_string('onlineonly', 'texsheet');
- }
-
- /**
- * Compares two question states for equivalence of the student's responses
- *
- * The responses for the two states must be examined to see if they represent
- * equivalent answers to the question by the student. This method will be
- * invoked for each of the previous states of the question before grading
- * occurs. If the student is found to have already attempted the question
- * with equivalent responses then the attempt at the question is ignored;
- * grading does not occur and the state does not change. Thus they are not
- * penalized for this case.
- * @return boolean
- * @param object $question The question for which the states are to be
- * compared. Question type specific information is
- * included.
- * @param object $state The state of the question. The responses are in
- * ->responses. This is the only field of $state
- * that it is safe to use.
- * @param object $teststate The state whose responses are to be
- * compared. The state will be of the same age or
- * older than $state. If possible, the method should
- * only use the field $teststate->responses, however
- * any field that is set up by restore_session_and_responses
- * can be used.
- */
- function compare_responses(&$question, $state, $teststate) {
- // The default implementation performs a comparison of the response
- // arrays. The ordering of the arrays does not matter.
- // Question types may wish to override this (eg. to ignore trailing
- // white space or to make "7.0" and "7" compare equal).
-
- // In php neither == nor === compare arrays the way you want. The following
- // ensures that the arrays have the same keys, with the same values.
- $result = false;
- $diff1 = array_diff_assoc($state->responses, $teststate->responses);
- if (empty($diff1)) {
- $diff2 = array_diff_assoc($teststate->responses, $state->responses);
- $result = empty($diff2);
- }
-
- return $result;
- }
-
- /**
- * Checks whether a response matches a given answer
- *
- * This method only applies to questions that use teacher-defined answers
- *
- * @return boolean
- */
- function test_response(&$question, &$state, $answer) {
- $response = isset($state->responses['']) ? $state->responses[''] : '';
- return ($response == $answer->answer);
- }
-
- /**
- * Performs response processing and grading
- *
- * This function performs response processing and grading and updates
- * the state accordingly.
- * @return boolean Indicates success or failure.
- * @param object $question The question to be graded. Question type
- * specific information is included.
- * @param object $state The state of the question to grade. The current
- * responses are in ->responses. The last graded state
- * is in ->last_graded (hence the most recently graded
- * responses are in ->last_graded->responses). The
- * question type specific information is also
- * included. The ->raw_grade and ->penalty fields
- * must be updated. The method is able to
- * close the question session (preventing any further
- * attempts at this question) by setting
- * $state->event to QUESTION_EVENTCLOSEANDGRADE
- * @param object $cmoptions
- */
- function grade_responses(&$question, &$state, $cmoptions) {
- // The default implementation uses the test_response method to
- // compare what the student entered against each of the possible
- // answers stored in the question, and uses the grade from the
- // first one that matches. It also sets the marks and penalty.
- // This should be good enought for most simple question types.
-
- $state->raw_grade = 0;
- foreach($question->options->answers as $answer) {
- if($this->test_response($question, $state, $answer)) {
- $state->raw_grade = $answer->fraction;
- break;
- }
- }
-
- // Make sure we don't assign negative or too high marks.
- $state->raw_grade = min(max((float) $state->raw_grade,
- 0.0), 1.0) * $question->maxgrade;
-
- // Update the penalty.
- $state->penalty = $question->penalty * $question->maxgrade;
-
- // mark the state as graded
- $state->event = ($state->event == QUESTION_EVENTCLOSE) ? QUESTION_EVENTCLOSEANDGRADE : QUESTION_EVENTGRADE;
-
- return true;
+ return $contributions;
}
/**
@@ -1496,40 +746,221 @@ class default_questiontype {
*
* @return boolean Whether the wizard's last page was submitted or not.
*/
- function finished_edit_wizard(&$form) {
+ public function finished_edit_wizard(&$form) {
//In the default case there is only one edit page.
return true;
}
- /**
- * Call format_text from weblib.php with the options appropriate to question types.
+ /*
+ * Find all course / site files linked from a question.
*
- * @param string $text the text to format.
- * @param integer $text the type of text. Normally $question->questiontextformat.
- * @param object $cmoptions the context the string is being displayed in. Only $cmoptions->course is used.
- * @return string the formatted text.
+ * Need to check for links to files in question_answers.answer and feedback
+ * and in question table in generalfeedback and questiontext fields. Methods
+ * on child classes will also check extra question specific fields.
+ *
+ * Needs to be overriden for child classes that have extra fields containing
+ * html.
+ *
+ * @param string html the html to search
+ * @param int courseid search for files for courseid course or set to siteid for
+ * finding site files.
+ * @return array of url, relative url is key and array with one item = question id as value
+ * relative url is relative to course/site files directory root.
*/
- function format_text($text, $textformat, $cmoptions = NULL) {
- $formatoptions = new stdClass;
- $formatoptions->noclean = true;
- $formatoptions->para = false;
- return format_text($text, $textformat, $formatoptions, $cmoptions === NULL ? NULL : $cmoptions->course);
+ public function find_file_links($question, $courseid){
+ $urls = array();
+
+ /// Question image
+ if ($question->image != ''){
+ if (substr(strtolower($question->image), 0, 7) == 'http://') {
+ $matches = array();
+
+ //support for older questions where we have a complete url in image field
+ if (preg_match('!^'.question_file_links_base_url($courseid).'(.*)!i', $question->image, $matches)){
+ if ($cleanedurl = question_url_check($urls[$matches[2]])){
+ $urls[$cleanedurl] = null;
+ }
+ }
+ } else {
+ if ($question->image != ''){
+ if ($cleanedurl = question_url_check($question->image)){
+ $urls[$cleanedurl] = null;//will be set later
+ }
+ }
+
+ }
+
+ }
+
+ /// Questiontext and general feedback.
+ $urls += question_find_file_links_from_html($question->questiontext, $courseid);
+ $urls += question_find_file_links_from_html($question->generalfeedback, $courseid);
+
+ /// Answers, if this question uses them.
+ if (isset($question->options->answers)){
+ foreach ($question->options->answers as $answerkey => $answer){
+ /// URLs in the answers themselves, if appropriate.
+ if ($this->has_html_answers()) {
+ $urls += question_find_file_links_from_html($answer->answer, $courseid);
+ }
+ /// URLs in the answer feedback.
+ $urls += question_find_file_links_from_html($answer->feedback, $courseid);
+ }
+ }
+
+ /// Set all the values of the array to the question object
+ if ($urls){
+ $urls = array_combine(array_keys($urls), array_fill(0, count($urls), array($question->id)));
+ }
+ return $urls;
}
- /**
- * @return the best link to pass to print_error.
- * @param $cmoptions as passed in from outside.
+ /*
+ * Find all course / site files linked from a question.
+ *
+ * Need to check for links to files in question_answers.answer and feedback
+ * and in question table in generalfeedback and questiontext fields. Methods
+ * on child classes will also check extra question specific fields.
+ *
+ * Needs to be overriden for child classes that have extra fields containing
+ * html.
+ *
+ * @param string html the html to search
+ * @param int course search for files for courseid course or set to siteid for
+ * finding site files.
+ * @return array of files, file name is key and array with one item = question id as value
*/
- function error_link($cmoptions) {
+ public function replace_file_links($question, $fromcourseid, $tocourseid, $url, $destination){
global $CFG;
- $cm = get_coursemodule_from_instance('quiz', $cmoptions->id);
- if (!empty($cm->id)) {
- return $CFG->wwwroot . '/mod/quiz/view.php?id=' . $cm->id;
- } else if (!empty($cm->course)) {
- return $CFG->wwwroot . '/course/view.php?id=' . $cm->course;
- } else {
- return '';
+ $updateqrec = false;
+
+ /// Question image
+ if (!empty($question->image)){
+ //support for older questions where we have a complete url in image field
+ if (substr(strtolower($question->image), 0, 7) == 'http://') {
+ $questionimage = preg_replace('!^'.question_file_links_base_url($fromcourseid).preg_quote($url, '!').'$!i', $destination, $question->image, 1);
+ } else {
+ $questionimage = preg_replace('!^'.preg_quote($url, '!').'$!i', $destination, $question->image, 1);
+ }
+ if ($questionimage != $question->image){
+ $question->image = $questionimage;
+ $updateqrec = true;
+ }
}
+
+ /// Questiontext and general feedback.
+ $question->questiontext = question_replace_file_links_in_html($question->questiontext, $fromcourseid, $tocourseid, $url, $destination, $updateqrec);
+ $question->generalfeedback = question_replace_file_links_in_html($question->generalfeedback, $fromcourseid, $tocourseid, $url, $destination, $updateqrec);
+
+ /// If anything has changed, update it in the database.
+ if ($updateqrec){
+ if (!update_record('question', addslashes_recursive($question))){
+ error ('Couldn\'t update question '.$question->name);
+ }
+ }
+
+
+ /// Answers, if this question uses them.
+ if (isset($question->options->answers)){
+ //answers that do not need updating have been unset
+ foreach ($question->options->answers as $answer){
+ $answerchanged = false;
+ /// URLs in the answers themselves, if appropriate.
+ if ($this->has_html_answers()) {
+ $answer->answer = question_replace_file_links_in_html($answer->answer, $fromcourseid, $tocourseid, $url, $destination, $answerchanged);
+ }
+ /// URLs in the answer feedback.
+ $answer->feedback = question_replace_file_links_in_html($answer->feedback, $fromcourseid, $tocourseid, $url, $destination, $answerchanged);
+ /// If anything has changed, update it in the database.
+ if ($answerchanged){
+ if (!update_record('question_answers', addslashes_recursive($answer))){
+ error ('Couldn\'t update question ('.$question->name.') answer '.$answer->id);
+ }
+ }
+ }
+ }
+ }
+
+/// BACKUP FUNCTIONS ////////////////////////////
+
+ /*
+ * Backup the data in the question
+ *
+ * This is used in question/backuplib.php
+ */
+ public function backup($bf,$preferences,$question,$level=6) {
+
+ $status = true;
+ $extraquestionfields = $this->extra_question_fields();
+
+ if (is_array($extraquestionfields)) {
+ $questionextensiontable = array_shift($extraquestionfields);
+ $record = get_record($questionextensiontable, $this->questionid_column_name(), $question);
+ if ($record) {
+ $tagname = strtoupper($this->name());
+ $status = $status && fwrite($bf, start_tag($tagname, $level, true));
+ foreach ($extraquestionfields as $field) {
+ if (!isset($record->$field)) {
+ echo "No data for field $field when backuping " .
+ $this->name() . ' question id ' . $question;
+ return false;
+ }
+ fwrite($bf, full_tag(strtoupper($field), $level + 1, false, $record->$field));
+ }
+ $status = $status && fwrite($bf, end_tag($tagname, $level, true));
+ }
+ }
+
+ $extraasnwersfields = $this->extra_answer_fields();
+ if (is_array($extraasnwersfields)) {
+ //TODO backup the answers, with any extra data.
+ } else {
+ $status = $status && question_backup_answers($bf, $preferences, $question);
+ }
+ return $status;
+ }
+
+/// RESTORE FUNCTIONS /////////////////
+
+ /*
+ * Restores the data in the question
+ *
+ * This is used in question/restorelib.php
+ */
+ public function restore($old_question_id,$new_question_id,$info,$restore) {
+
+ $status = true;
+ $extraquestionfields = $this->extra_question_fields();
+
+ if (is_array($extraquestionfields)) {
+ $questionextensiontable = array_shift($extraquestionfields);
+ $tagname = strtoupper($this->name());
+ $recordinfo = $info['#'][$tagname][0];
+
+ $record = new stdClass;
+ $qidcolname = $this->questionid_column_name();
+ $record->$qidcolname = $new_question_id;
+ foreach ($extraquestionfields as $field) {
+ $record->$field = backup_todb($recordinfo['#'][strtoupper($field)]['0']['#']);
+ }
+ if (!insert_record($questionextensiontable, $record)) {
+ echo "Can't insert record in $questionextensiontable when restoring " .
+ $this->name() . ' question id ' . $question;
+ $status = false;
+ }
+ }
+ //TODO restore extra data in answers
+ return $status;
+ }
+
+ public function restore_map($old_question_id,$new_question_id,$info,$restore) {
+ // There is nothing to decode
+ return true;
+ }
+
+ public function restore_recode_answer($state, $restore) {
+ // There is nothing to decode
+ return $state->answer;
}
/// IMPORT/EXPORT FUNCTIONS /////////////////
@@ -1540,7 +971,7 @@ class default_questiontype {
* Imports question using information from extra_question_fields function
* If some of you fields contains id's you'll need to reimplement this
*/
- function import_from_xml($data, $question, $format, $extra=null) {
+ public function import_from_xml($data, $question, $format, $extra=null) {
$question_type = $data['@']['type'];
if ($question_type != $this->name()) {
return false;
@@ -1557,7 +988,7 @@ class default_questiontype {
$qo->qtype = $question_type;
foreach ($extraquestionfields as $field) {
- $qo->$field = $format->getpath($data, array('#',$field,0,'#'), $qo->$field);
+ $qo->$field = addslashes($format->getpath($data, array('#',$field,0,'#'), $qo->$field));
}
// run through the answers
@@ -1584,7 +1015,7 @@ class default_questiontype {
* Export question using information from extra_question_fields function
* If some of you fields contains id's you'll need to reimplement this
*/
- function export_to_xml($question, $format, $extra=null) {
+ public function export_to_xml($question, $format, $extra=null) {
$extraquestionfields = $this->extra_question_fields();
if (!is_array($extraquestionfields)) {
return false;
@@ -1623,13 +1054,13 @@ class default_questiontype {
* required to set up and save a question of any type for testing purposes.
* Alternate DB table prefix may be used to facilitate data deletion.
*/
- function generate_test($name, $courseid=null) {
+ public function generate_test($name, $courseid=null) {
$form = new stdClass();
$form->name = $name;
$form->questiontextformat = 1;
$form->questiontext = 'test question, generated by script';
- $form->defaultgrade = 1;
- $form->penalty = 0.1;
+ $form->defaultmark = 1;
+ $form->penalty = 0.3333333;
$form->generalfeedback = "Well done";
$context = get_context_instance(CONTEXT_COURSE, $courseid);
@@ -1641,140 +1072,37 @@ class default_questiontype {
$question->qtype = $this->qtype;
return array($form, $question);
}
+}
+
+/**
+ * This class is used in the return value from
+ * {@link question_type::get_possible_responses()}.
+ *
+ * @copyright 2010 The Open University
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class question_possible_response {
/**
- * Get question context by category id
- * @param int $category
- * @return object $context
+ * @var string the classification of this response the student gave to this
+ * part of the question. Must match one of the responseclasses returned by
+ * {@link question_type::get_possible_responses()}.
*/
- function get_context_by_category_id($category) {
- global $DB;
- $contextid = $DB->get_field('question_categories', 'contextid', array('id'=>$category));
- $context = get_context_instance_by_id($contextid);
- return $context;
- }
-
+ public $responseclass;
+ /** @var string the actual response the student gave to this part. */
+ public $fraction;
/**
- * Save the file belonging to one text field.
- *
- * @param array $field the data from the form (or from import). This will
- * normally have come from the formslib editor element, so it will be an
- * array with keys 'text', 'format' and 'itemid'. However, when we are
- * importing, it will be an array with keys 'text', 'format' and 'files'
- * @param object $context the context the question is in.
- * @param string $component indentifies the file area question.
- * @param string $filearea indentifies the file area questiontext, generalfeedback,answerfeedback.
- * @param integer $itemid identifies the file area.
- *
- * @return string the text for this field, after files have been processed.
+ * Constructor, just an easy way to set the fields.
+ * @param string $responseclassid see the field descriptions above.
+ * @param string $response see the field descriptions above.
+ * @param number $fraction see the field descriptions above.
*/
- protected function import_or_save_files($field, $context, $component, $filearea, $itemid) {
- if (!empty($field['itemid'])) {
- // This is the normal case. We are safing the questions editing form.
- return file_save_draft_area_files($field['itemid'], $context->id, $component,
- $filearea, $itemid, $this->fileoptions, trim($field['text']));
-
- } else if (!empty($field['files'])) {
- // This is the case when we are doing an import.
- foreach ($field['files'] as $file) {
- $this->import_file($context, $component, $filearea, $itemid, $file);
- }
- }
- return trim($field['text']);
+ public function __construct($responseclass, $fraction) {
+ $this->responseclass = $responseclass;
+ $this->fraction = $fraction;
}
- /**
- * Move all the files belonging to this question from one context to another.
- * @param integer $questionid the question being moved.
- * @param integer $oldcontextid the context it is moving from.
- * @param integer $newcontextid the context it is moving to.
- */
- public function move_files($questionid, $oldcontextid, $newcontextid) {
- $fs = get_file_storage();
- $fs->move_area_files_to_new_context($oldcontextid,
- $newcontextid, 'question', 'questiontext', $questionid);
- $fs->move_area_files_to_new_context($oldcontextid,
- $newcontextid, 'question', 'generalfeedback', $questionid);
- }
-
- /**
- * Move all the files belonging to this question's answers when the question
- * is moved from one context to another.
- * @param integer $questionid the question being moved.
- * @param integer $oldcontextid the context it is moving from.
- * @param integer $newcontextid the context it is moving to.
- * @param boolean $answerstoo whether there is an 'answer' question area,
- * as well as an 'answerfeedback' one. Default false.
- */
- protected function move_files_in_answers($questionid, $oldcontextid, $newcontextid, $answerstoo = false) {
- global $DB;
- $fs = get_file_storage();
-
- $answerids = $DB->get_records_menu('question_answers',
- array('question' => $questionid), 'id', 'id,1');
- foreach ($answerids as $answerid => $notused) {
- if ($answerstoo) {
- $fs->move_area_files_to_new_context($oldcontextid,
- $newcontextid, 'question', 'answer', $answerid);
- }
- $fs->move_area_files_to_new_context($oldcontextid,
- $newcontextid, 'question', 'answerfeedback', $answerid);
- }
- }
-
- /**
- * Delete all the files belonging to this question.
- * @param integer $questionid the question being deleted.
- * @param integer $contextid the context the question is in.
- */
- protected function delete_files($questionid, $contextid) {
- $fs = get_file_storage();
- $fs->delete_area_files($contextid, 'question', 'questiontext', $questionid);
- $fs->delete_area_files($contextid, 'question', 'generalfeedback', $questionid);
- }
-
- /**
- * Delete all the files belonging to this question's answers.
- * @param integer $questionid the question being deleted.
- * @param integer $contextid the context the question is in.
- * @param boolean $answerstoo whether there is an 'answer' question area,
- * as well as an 'answerfeedback' one. Default false.
- */
- protected function delete_files_in_answers($questionid, $contextid, $answerstoo = false) {
- global $DB;
- $fs = get_file_storage();
-
- $answerids = $DB->get_records_menu('question_answers',
- array('question' => $questionid), 'id', 'id,1');
- foreach ($answerids as $answerid => $notused) {
- if ($answerstoo) {
- $fs->delete_area_files($contextid, 'question', 'answer', $answerid);
- }
- $fs->delete_area_files($contextid, 'question', 'answerfeedback', $answerid);
- }
- }
-
- function import_file($context, $component, $filearea, $itemid, $file) {
- $fs = get_file_storage();
- $record = new stdclass;
- if (is_object($context)) {
- $record->contextid = $context->id;
- } else {
- $record->contextid = $context;
- }
- $record->component = $component;
- $record->filearea = $filearea;
- $record->itemid = $itemid;
- $record->filename = $file->name;
- $record->filepath = '/';
- return $fs->create_file_from_string($record, $this->decode_file($file));
- }
-
- function decode_file($file) {
- switch ($file->encoding) {
- case 'base64':
- default:
- return base64_decode($file->content);
- }
+ public static function no_response() {
+ return new question_possible_response(get_string('noresponse', 'question'), 0);
}
}
diff --git a/question/type/rendererbase.php b/question/type/rendererbase.php
new file mode 100644
index 00000000000..3fad513b482
--- /dev/null
+++ b/question/type/rendererbase.php
@@ -0,0 +1,265 @@
+.
+
+
+/**
+ * Defines the renderer base classes for question types.
+ *
+ * @package moodlecore
+ * @subpackage questiontypes
+ * @copyright 2009 The Open University
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+
+/**
+ * Renderer base classes for question types.
+ *
+ * @copyright 2009 The Open University
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+abstract class qtype_renderer extends renderer_base {
+ /**
+ * Generate the display of the formulation part of the question. This is the
+ * area that contains the quetsion text, and the controls for students to
+ * input their answers. Some question types also embed bits of feedback, for
+ * example ticks and crosses, in this area.
+ *
+ * @param question_attempt $qa the question attempt to display.
+ * @param question_display_options $options controls what should and should not be displayed.
+ * @return string HTML fragment.
+ */
+ public function formulation_and_controls(question_attempt $qa,
+ question_display_options $options) {
+ return $qa->get_question()->questiontext;
+ }
+
+ /**
+ * Output hidden form fields to clear any wrong parts of the student's response.
+ *
+ * This method will only be called if the question is in read-only mode.
+ * @param question_attempt $qa the question attempt to display.
+ * @return string HTML fragment.
+ */
+ public function clear_wrong(question_attempt $qa) {
+ $response = $qa->get_last_qt_data();
+ if (!$response) {
+ return '';
+ }
+ $cleanresponse = $qa->get_question()->clear_wrong_from_response($response);
+ $output = '';
+ foreach ($cleanresponse as $name => $value) {
+ $attr = array(
+ 'type' => 'hidden',
+ 'name' => $qa->get_qt_field_name($name),
+ 'value' => s($value),
+ );
+ $output .= html_writer::empty_tag('input', $attr);
+ }
+ return $output;
+ }
+
+ /**
+ * Generate the display of the outcome part of the question. This is the
+ * area that contains the various forms of feedback. This function generates
+ * the content of this area belonging to the question type.
+ *
+ * Subclasses will normally want to override the more specific methods
+ * {specific_feedback()}, {general_feedback()} and {correct_response()}
+ * that this method calls.
+ *
+ * @param question_attempt $qa the question attempt to display.
+ * @param question_display_options $options controls what should and should not be displayed.
+ * @return string HTML fragment.
+ */
+ public function feedback(question_attempt $qa, question_display_options $options) {
+ $output = '';
+ $hint = null;
+
+ if ($options->feedback) {
+ $output .= html_writer::nonempty_tag('div', $this->specific_feedback($qa),
+ array('class' => 'specificfeedback'));
+ $hint = $qa->get_applicable_hint();
+ }
+
+ if ($options->numpartscorrect) {
+ $output .= html_writer::nonempty_tag('div', $this->num_parts_correct($qa),
+ array('class' => 'numpartscorrect'));
+ }
+
+ if ($hint) {
+ $output .= $this->hint($qa->get_question(), $hint);
+ }
+
+ if ($options->generalfeedback) {
+ $output .= html_writer::nonempty_tag('div', $this->general_feedback($qa),
+ array('class' => 'generalfeedback'));
+ }
+
+ if ($options->rightanswer) {
+ $output .= html_writer::nonempty_tag('div', $this->correct_response($qa),
+ array('class' => 'rightanswer'));
+ }
+
+ return $output;
+ }
+
+ /**
+ * Gereate the specific feedback. This is feedback that varies accordin to
+ * the reponse the student gave.
+ * @param question_attempt $qa the question attempt to display.
+ * @return string HTML fragment.
+ */
+ protected function specific_feedback(question_attempt $qa) {
+ return '';
+ }
+
+ /**
+ * Gereate a brief statement of how many sub-parts of this question the
+ * student got right.
+ * @param question_attempt $qa the question attempt to display.
+ * @return string HTML fragment.
+ */
+ protected function num_parts_correct(question_attempt $qa) {
+ $a = new stdClass;
+ list($a->num, $a->outof) = $qa->get_question()->get_num_parts_right(
+ $qa->get_last_qt_data());
+ if (is_null($a->outof)) {
+ return '';
+ } else {
+ return get_string('yougotnright', 'question', $a);
+ }
+ }
+
+ /**
+ * Gereate the specific feedback. This is feedback that varies accordin to
+ * the reponse the student gave.
+ * @param question_attempt $qa the question attempt to display.
+ * @return string HTML fragment.
+ */
+ protected function hint(question_definition $question, question_hint $hint) {
+ return html_writer::nonempty_tag('div', $question->format_text($hint->hint),
+ array('class' => 'hint'));
+ }
+
+ /**
+ * Gereate the general feedback. This is feedback is shown ot all students.
+ *
+ * @param question_attempt $qa the question attempt to display.
+ * @return string HTML fragment.
+ */
+ protected function general_feedback(question_attempt $qa) {
+ return $qa->get_question()->format_generalfeedback();
+ }
+
+ /**
+ * Gereate an automatic description of the correct response to this question.
+ * Not all question types can do this. If it is not possible, this method
+ * should just return an empty string.
+ *
+ * @param question_attempt $qa the question attempt to display.
+ * @return string HTML fragment.
+ */
+ protected function correct_response(question_attempt $qa) {
+ return '';
+ }
+
+ /**
+ * Return any HTML that needs to be included in the page's when this
+ * question is used.
+ * @param $qa the question attempt that will be displayed on the page.
+ * @return string HTML fragment.
+ */
+ public function head_code(question_attempt $qa) {
+ return implode("\n", $qa->get_question()->qtype->find_standard_scripts_and_css());
+ }
+
+ protected function feedback_class($fraction) {
+ return question_state::graded_state_for_fraction($fraction)
+ ->get_feedback_class();
+ }
+
+ /**
+ * Return an appropriate icon (green tick, red cross, etc.) for a grade.
+ * @param float $fraction grade on a scale 0..1.
+ * @param boolean $selected whether to show a big or small icon. (Deprecated)
+ * @return string html fragment.
+ */
+ function feedback_image($fraction, $selected = true) {
+ global $CFG;
+
+ $state = question_state::graded_state_for_fraction($fraction);
+
+ if ($state == question_state::$gradedright) {
+ $icon = 'tick_green';
+ } else if ($state == question_state::$gradedpartial) {
+ $icon = 'tick_amber';
+ } else {
+ $icon = 'cross_red';
+ }
+ if ($selected) {
+ $icon .= '_big';
+ } else {
+ $icon .= '_small';
+ }
+
+ $attributes = array(
+ 'src' => $CFG->pixpath . '/i/' . $icon . '.gif',
+ 'alt' => get_string($state->get_feedback_class(), 'question'),
+ 'class' => 'questioncorrectnessicon',
+ );
+
+ return html_writer::empty_tag('img', $attributes);
+ }
+}
+
+/**
+ * Renderer base classes for question types.
+ *
+ * @copyright 2010 The Open University
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+abstract class qtype_with_combined_feedback_renderer extends qtype_renderer {
+ protected function combined_feedback(question_attempt $qa) {
+ $question = $qa->get_question();
+
+ $state = $qa->get_state();
+
+ if (!$state->is_finished()) {
+ $response = $qa->get_last_qt_data();
+ if (!$qa->get_question()->is_gradable_response($response)) {
+ return '';
+ }
+ list($notused, $state) = $qa->get_question()->grade_response($response);
+ }
+
+ $feedback = '';
+ if ($state->is_correct()) {
+ $feedback = $question->correctfeedback;
+ } else if ($state->is_partially_correct()) {
+ $feedback = $question->partiallycorrectfeedback;
+ } else if ($state->is_incorrect()) {
+ $feedback = $question->incorrectfeedback;
+ }
+
+ if ($feedback) {
+ $feedback = $question->format_text($feedback);
+ }
+
+ return $feedback;
+ }
+}
diff --git a/question/type/truefalse/old_questiontype.php b/question/type/truefalse/old_questiontype.php
new file mode 100644
index 00000000000..1dc2cc10213
--- /dev/null
+++ b/question/type/truefalse/old_questiontype.php
@@ -0,0 +1,317 @@
+.
+
+defined('MOODLE_INTERNAL') || die();
+
+/////////////////
+/// TRUEFALSE ///
+/////////////////
+
+/// QUESTION TYPE CLASS //////////////////
+/**
+ * @package questionbank
+ * @subpackage questiontypes
+ */
+class question_truefalse_qtype extends default_questiontype {
+
+ function name() {
+ return 'truefalse';
+ }
+
+ function save_question_options($question) {
+ global $DB;
+ $result = new stdClass;
+ $context = $question->context;
+
+ // Fetch old answer ids so that we can reuse them
+ $oldanswers = $DB->get_records('question_answers',
+ array('question' => $question->id), 'id ASC');
+
+ // Save the true answer - update an existing answer if possible.
+ $answer = array_shift($oldanswers);
+ if (!$answer) {
+ $answer = new stdClass();
+ $answer->question = $question->id;
+ $answer->answer = '';
+ $answer->feedback = '';
+ $answer->id = $DB->insert_record('question_answers', $answer);
+ }
+
+ $answer->answer = get_string('true', 'quiz');
+ $answer->fraction = $question->correctanswer;
+ $answer->feedback = $this->import_or_save_files($question->feedbacktrue,
+ $context, 'question', 'answerfeedback', $answer->id);
+ $answer->feedbackformat = $question->feedbacktrue['format'];
+ $DB->update_record('question_answers', $answer);
+ $trueid = $answer->id;
+
+ // Save the false answer - update an existing answer if possible.
+ $answer = array_shift($oldanswers);
+ if (!$answer) {
+ $answer = new stdClass();
+ $answer->question = $question->id;
+ $answer->answer = '';
+ $answer->feedback = '';
+ $answer->id = $DB->insert_record('question_answers', $answer);
+ }
+
+ $answer->answer = get_string('false', 'quiz');
+ $answer->fraction = 1 - (int)$question->correctanswer;
+ $answer->feedback = $this->import_or_save_files($question->feedbackfalse,
+ $context, 'question', 'answerfeedback', $answer->id);
+ $answer->feedbackformat = $question->feedbackfalse['format'];
+ $DB->update_record('question_answers', $answer);
+ $falseid = $answer->id;
+
+ // Delete any left over old answer records.
+ $fs = get_file_storage();
+ foreach($oldanswers as $oldanswer) {
+ $fs->delete_area_files($context->id, 'question', 'answerfeedback', $oldanswer->id);
+ $DB->delete_records('question_answers', array('id' => $oldanswer->id));
+ }
+
+ // Save question options in question_truefalse table
+ if ($options = $DB->get_record('question_truefalse', array('question' => $question->id))) {
+ // No need to do anything, since the answer IDs won't have changed
+ // But we'll do it anyway, just for robustness
+ $options->trueanswer = $trueid;
+ $options->falseanswer = $falseid;
+ $DB->update_record('question_truefalse', $options);
+ } else {
+ $options = new stdClass();
+ $options->question = $question->id;
+ $options->trueanswer = $trueid;
+ $options->falseanswer = $falseid;
+ $DB->insert_record('question_truefalse', $options);
+ }
+
+ return true;
+ }
+
+ /**
+ * Loads the question type specific options for the question.
+ */
+ function get_question_options(&$question) {
+ global $DB, $OUTPUT;
+ // Get additional information from database
+ // and attach it to the question object
+ if (!$question->options = $DB->get_record('question_truefalse', array('question' => $question->id))) {
+ echo $OUTPUT->notification('Error: Missing question options!');
+ return false;
+ }
+ // Load the answers
+ if (!$question->options->answers = $DB->get_records('question_answers', array('question' => $question->id), 'id ASC')) {
+ echo $OUTPUT->notification('Error: Missing question answers for truefalse question ' . $question->id . '!');
+ return false;
+ }
+
+ return true;
+ }
+
+ function delete_question($questionid, $contextid) {
+ global $DB;
+ $DB->delete_records('question_truefalse', array('question' => $questionid));
+
+ parent::delete_question($questionid, $contextid);
+ }
+
+ function compare_responses($question, $state, $teststate) {
+ if (isset($state->responses['']) && isset($teststate->responses[''])) {
+ return $state->responses[''] === $teststate->responses[''];
+ } else if (isset($teststate->responses['']) && $teststate->responses[''] === '' &&
+ !isset($state->responses[''])) {
+ // Nothing selected in the past, and nothing selected now.
+ return true;
+ }
+ return false;
+ }
+
+ function get_correct_responses(&$question, &$state) {
+ // The correct answer is the one which gives full marks
+ foreach ($question->options->answers as $answer) {
+ if (((int) $answer->fraction) === 1) {
+ return array('' => $answer->id);
+ }
+ }
+ return null;
+ }
+
+ /**
+ * Prints the main content of the question including any interactions
+ */
+ function print_question_formulation_and_controls(&$question, &$state, $cmoptions, $options) {
+ global $CFG;
+ $context = $this->get_context_by_category_id($question->category);
+
+ $readonly = $options->readonly ? ' disabled="disabled"' : '';
+
+ $formatoptions = new stdClass;
+ $formatoptions->noclean = true;
+ $formatoptions->para = false;
+
+ // Print question formulation
+ $questiontext = format_text($question->questiontext,
+ $question->questiontextformat,
+ $formatoptions, $cmoptions->course);
+
+ $answers = &$question->options->answers;
+ $trueanswer = &$answers[$question->options->trueanswer];
+ $falseanswer = &$answers[$question->options->falseanswer];
+ $correctanswer = ($trueanswer->fraction == 1) ? $trueanswer : $falseanswer;
+
+ $trueclass = '';
+ $falseclass = '';
+ $truefeedbackimg = '';
+ $falsefeedbackimg = '';
+
+ // Work out which radio button to select (if any)
+ if (isset($state->responses[''])) {
+ $response = $state->responses[''];
+ } else {
+ $response = '';
+ }
+ $truechecked = ($response == $trueanswer->id) ? ' checked="checked"' : '';
+ $falsechecked = ($response == $falseanswer->id) ? ' checked="checked"' : '';
+
+ // Work out visual feedback for answer correctness.
+ if ($options->feedback) {
+ if ($truechecked) {
+ $trueclass = question_get_feedback_class($trueanswer->fraction);
+ } else if ($falsechecked) {
+ $falseclass = question_get_feedback_class($falseanswer->fraction);
+ }
+ }
+ if ($options->feedback || $options->correct_responses) {
+ if (isset($answers[$response])) {
+ $truefeedbackimg = question_get_feedback_image($trueanswer->fraction, !empty($truechecked) && $options->feedback);
+ $falsefeedbackimg = question_get_feedback_image($falseanswer->fraction, !empty($falsechecked) && $options->feedback);
+ }
+ }
+
+ $inputname = ' name="'.$question->name_prefix.'" ';
+ $trueid = $question->name_prefix.'true';
+ $falseid = $question->name_prefix.'false';
+
+ $radiotrue = '';
+ $radiofalse = '';
+
+ $feedback = '';
+ if ($options->feedback and isset($answers[$response])) {
+ $chosenanswer = $answers[$response];
+ $chosenanswer->feedback = quiz_rewrite_question_urls($chosenanswer->feedback, 'pluginfile.php', $context->id, 'question', 'answerfeedback', array($state->attempt, $state->question), $chosenanswer->id);
+ $feedback = format_text($chosenanswer->feedback, $chosenanswer->feedbackformat, $formatoptions, $cmoptions->course);
+ }
+
+ include("$CFG->dirroot/question/type/truefalse/display.html");
+ }
+
+ function move_files($questionid, $oldcontextid, $newcontextid) {
+ parent::move_files($questionid, $oldcontextid, $newcontextid);
+ $this->move_files_in_answers($questionid, $oldcontextid, $newcontextid);
+ }
+
+ protected function delete_files($questionid, $contextid) {
+ parent::delete_files($questionid, $contextid);
+ $this->delete_files_in_answers($questionid, $contextid);
+ }
+
+ function check_file_access($question, $state, $options, $contextid, $component,
+ $filearea, $args) {
+ if ($component == 'question' && $filearea == 'answerfeedback') {
+
+ $answerid = reset($args); // itemid is answer id.
+ $answers = &$question->options->answers;
+ if (isset($state->responses[''])) {
+ $response = $state->responses[''];
+ } else {
+ $response = '';
+ }
+
+ return $options->feedback && isset($answers[$response]) && $answerid == $response;
+
+ } else {
+ return parent::check_file_access($question, $state, $options, $contextid, $component,
+ $filearea, $args);
+ }
+ }
+
+ function grade_responses(&$question, &$state, $cmoptions) {
+ if (isset($state->responses['']) && isset($question->options->answers[$state->responses['']])) {
+ $state->raw_grade = $question->options->answers[$state->responses['']]->fraction * $question->maxgrade;
+ } else {
+ $state->raw_grade = 0;
+ }
+ // Only allow one attempt at the question
+ $state->penalty = 1 * $question->maxgrade;
+
+ // mark the state as graded
+ $state->event = ($state->event == QUESTION_EVENTCLOSE) ? QUESTION_EVENTCLOSEANDGRADE : QUESTION_EVENTGRADE;
+
+ return true;
+ }
+
+ function get_actual_response($question, $state) {
+ if (isset($question->options->answers[$state->responses['']])) {
+ $responses[] = $question->options->answers[$state->responses['']]->answer;
+ } else {
+ $responses[] = '';
+ }
+ return $responses;
+ }
+ /**
+ * @param object $question
+ * @return mixed either a integer score out of 1 that the average random
+ * guess by a student might give or an empty string which means will not
+ * calculate.
+ */
+ function get_random_guess_score($question) {
+ return 0.5;
+ }
+
+ /**
+ * Runs all the code required to set up and save an essay question for testing purposes.
+ * Alternate DB table prefix may be used to facilitate data deletion.
+ */
+ function generate_test($name, $courseid = null) {
+ global $DB;
+ list($form, $question) = parent::generate_test($name, $courseid);
+ $question->category = $form->category;
+
+ $form->questiontext = "This question is really stupid";
+ $form->penalty = 1;
+ $form->defaultgrade = 1;
+ $form->correctanswer = 0;
+ $form->feedbacktrue = 'Can you justify such a hasty judgment?';
+ $form->feedbackfalse = 'Wisdom has spoken!';
+
+ if ($courseid) {
+ $course = $DB->get_record('course', array('id' => $courseid));
+ }
+
+ return $this->save_question($question, $form);
+ }
+}
+//// END OF CLASS ////
+
+//////////////////////////////////////////////////////////////////////////
+//// INITIATION - Without this line the question type is not in use... ///
+//////////////////////////////////////////////////////////////////////////
+question_register_questiontype(new question_truefalse_qtype());
diff --git a/question/type/truefalse/question.php b/question/type/truefalse/question.php
new file mode 100644
index 00000000000..7e1a9b8f008
--- /dev/null
+++ b/question/type/truefalse/question.php
@@ -0,0 +1,97 @@
+.
+
+
+/**
+ * True-false question definition class.
+ *
+ * @package qtype_truefalse
+ * @copyright 2009 The Open University
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+
+/**
+ * Represents a true-false question.
+ *
+ * @copyright 2009 The Open University
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class qtype_truefalse_question extends question_graded_automatically {
+ public $rightanswer;
+ public $truefeedback;
+ public $falsefeedback;
+
+ public function get_expected_data() {
+ return array('answer' => PARAM_INTEGER);
+ }
+
+ public function get_correct_response() {
+ return array('answer' => (int) $this->rightanswer);
+ }
+
+ public function summarise_response(array $response) {
+ if (!array_key_exists('answer', $response)) {
+ return null;
+ } else if ($response['answer']) {
+ return get_string('true', 'qtype_truefalse');
+ } else {
+ return get_string('false', 'qtype_truefalse');
+ }
+ }
+
+ public function classify_response(array $response) {
+ if (!array_key_exists('answer', $response)) {
+ return array($this->id => question_classified_response::no_response());
+ }
+ list($fraction) = $this->grade_response($response);
+ if ($response['answer']) {
+ return array($this->id => new question_classified_response(1,
+ get_string('true', 'qtype_truefalse'), $fraction));
+ } else {
+ return array($this->id => new question_classified_response(0,
+ get_string('false', 'qtype_truefalse'), $fraction));
+ }
+ }
+
+ public function is_complete_response(array $response) {
+ return array_key_exists('answer', $response);
+ }
+
+ public function get_validation_error(array $response) {
+ if ($this->is_gradable_response($response)) {
+ return '';
+ }
+ return get_string('pleaseselectananswer', 'qtype_truefalse');
+ }
+
+ public function is_same_response(array $prevresponse, array $newresponse) {
+ return question_utils::arrays_same_at_key_missing_is_blank(
+ $prevresponse, $newresponse, 'answer');
+ }
+
+ public function grade_response(array $response) {
+ if ($this->rightanswer == true && $response['answer'] == true) {
+ $fraction = 1;
+ } else if ($this->rightanswer == false && $response['answer'] == false) {
+ $fraction = 1;
+ } else {
+ $fraction = 0;
+ }
+ return array($fraction, question_state::graded_state_for_fraction($fraction));
+ }
+}
diff --git a/question/type/truefalse/questiontype.php b/question/type/truefalse/questiontype.php
index 1dc2cc10213..4b92257bbf2 100644
--- a/question/type/truefalse/questiontype.php
+++ b/question/type/truefalse/questiontype.php
@@ -15,303 +15,284 @@
// You should have received a copy of the GNU General Public License
// along with Moodle. If not, see "; + } + } + backup_flush(300); + } + + if (!$newid) { + $status = false; + } + } + + return $status; + } + + public function restore_recode_answer($state, $restore) { + //answer may be empty + if ($state->answer) { + $answer = backup_getid($restore->backup_unique_code,"question_answers",$state->answer); + if ($answer) { + return $answer->new_id; + } else { + echo 'Could not recode truefalse answer id '.$state->answer.' for state '.$state->oldid.'
'; + } + } + } + /** * Runs all the code required to set up and save an essay question for testing purposes. * Alternate DB table prefix may be used to facilitate data deletion. */ - function generate_test($name, $courseid = null) { - global $DB; + public function generate_test($name, $courseid = null) { list($form, $question) = parent::generate_test($name, $courseid); $question->category = $form->category; $form->questiontext = "This question is really stupid"; $form->penalty = 1; - $form->defaultgrade = 1; + $form->defaultmark = 1; $form->correctanswer = 0; - $form->feedbacktrue = 'Can you justify such a hasty judgment?'; - $form->feedbackfalse = 'Wisdom has spoken!'; + $form->feedbacktrue = array('Can you justify such a hasty judgment?'); + $form->feedbackfalse = array('Wisdom has spoken!'); if ($courseid) { - $course = $DB->get_record('course', array('id' => $courseid)); + $course = get_record('course', 'id', $courseid); } - return $this->save_question($question, $form); + return $this->save_question($question, $form, $course); } } -//// END OF CLASS //// - -////////////////////////////////////////////////////////////////////////// -//// INITIATION - Without this line the question type is not in use... /// -////////////////////////////////////////////////////////////////////////// -question_register_questiontype(new question_truefalse_qtype()); diff --git a/question/type/truefalse/renderer.php b/question/type/truefalse/renderer.php new file mode 100644 index 00000000000..bfea585d08b --- /dev/null +++ b/question/type/truefalse/renderer.php @@ -0,0 +1,142 @@ +. + + +/** + * True-false question renderer class. + * + * @package qtype_truefalse + * @copyright 2009 The Open University + * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later + */ + + +/** + * Generates the output for true-false questions. + * + * @copyright 2009 The Open University + * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later + */ +class qtype_truefalse_renderer extends qtype_renderer { + public function formulation_and_controls(question_attempt $qa, + question_display_options $options) { + + $question = $qa->get_question(); + $response = $qa->get_last_qt_var('answer', ''); + + $inputname = $qa->get_qt_field_name('answer'); + $trueattributes = array( + 'type' => 'radio', + 'name' => $inputname, + 'value' => 1, + 'id' => $inputname . 'true', + ); + $falseattributes = array( + 'type' => 'radio', + 'name' => $inputname, + 'value' => 0, + 'id' => $inputname . 'false', + ); + + if ($options->readonly) { + $trueattributes['disabled'] = 'disabled'; + $falseattributes['disabled'] = 'disabled'; + } + + // Work out which radio button to select (if any) + $truechecked = false; + $falsechecked = false; + $responsearray = array(); + if ($response) { + $trueattributes['checked'] = 'checked'; + $truechecked = true; + $responsearray = array('answer' => 1); + } else if ($response !== '') { + $falseattributes['checked'] = 'checked'; + $falsechecked = true; + $responsearray = array('answer' => 1); + } + + // Work out visual feedback for answer correctness. + $trueclass = ''; + $falseclass = ''; + $truefeedbackimg = ''; + $falsefeedbackimg = ''; + if ($options->correctness) { + if ($truechecked) { + $trueclass = ' ' . $this->feedback_class((int) $question->rightanswer); + $truefeedbackimg = $this->feedback_image((int) $question->rightanswer); + } else if ($falsechecked) { + $falseclass = ' ' . $this->feedback_class((int) (!$question->rightanswer)); + $falsefeedbackimg = $this->feedback_image((int) (!$question->rightanswer)); + } + } + + $radiotrue = html_writer::empty_tag('input', $trueattributes) . + html_writer::tag('label', get_string('true', 'qtype_truefalse'), + array('for' => $trueattributes['id'])); + $radiofalse = html_writer::empty_tag('input', $falseattributes) . + html_writer::tag('label', get_string('false', 'qtype_truefalse'), + array('for' => $falseattributes['id'])); + + $result = ''; + $result .= html_writer::tag('div', $question->format_questiontext(), + array('class' => 'qtext')); + + $result .= html_writer::start_tag('div', array('class' => 'ablock')); + $result .= html_writer::tag('div', get_string('selectone', 'qtype_truefalse'), + array('class' => 'prompt')); + + $result .= html_writer::start_tag('div', array('class' => 'answer')); + $result .= html_writer::tag('span', $radiotrue . ' ' . $truefeedbackimg, + array('class' => 'r0' . $trueclass)); + $result .= html_writer::tag('span', $radiofalse . ' ' . $falsefeedbackimg, + array('class' => 'r1' . $falseclass)); + $result .= html_writer::end_tag('div'); // answer + + $result .= html_writer::end_tag('div'); // ablock + + if ($qa->get_state() == question_state::$invalid) { + $result .= html_writer::nonempty_tag('div', + $question->get_validation_error($responsearray), + array('class' => 'validationerror')); + } + + return $result; + } + + public function specific_feedback(question_attempt $qa) { + $question = $qa->get_question(); + $response = $qa->get_last_qt_var('answer', ''); + + if ($response) { + return $question->format_text($question->truefeedback); + } else { + return $question->format_text($question->falsefeedback); + } + } + + public function correct_response(question_attempt $qa) { + $question = $qa->get_question(); + + if ($question->rightanswer) { + return get_string('correctanswertrue', 'qtype_truefalse'); + } else { + return get_string('correctanswerfalse', 'qtype_truefalse'); + } + } +}