<?PHP // $Id: review.php,v 1.4 2005/11/24 05:36:27 gbateson Exp $
// This page prints a review of a particular quiz attempt
	require_once("../../config.php");
	require_once("lib.php");
	$id = optional_param("id"); // Course Module ID, or
	$hp = optional_param("hp"); // hotpot ID
	$attempt = required_param("attempt"); // A particular attempt ID for review
	if ($id) {
		if (! $cm = get_record("course_modules", "id", $id)) {
			error("Course Module ID was incorrect");
		}
		if (! $course = get_record("course", "id", $cm->course)) {
			error("Course is misconfigured");
		}
		if (! $hotpot = get_record("hotpot", "id", $cm->instance)) {
			error("Course module is incorrect");
		}
	} else {
		if (! $hotpot = get_record("hotpot", "id", $hp)) {
			error("Course module is incorrect");
		}
		if (! $course = get_record("course", "id", $hotpot->course)) {
			error("Course is misconfigured");
		}
		if (! $cm = get_coursemodule_from_instance("hotpot", $hotpot->id, $course->id)) {
			error("Course Module ID was incorrect");
		}
	}
	if (! $attempt = get_record("hotpot_attempts", "id", $attempt)) {
		error("Attempt ID was incorrect");
	}
	require_login($course->id);
	if (!isteacher($course->id)) {
		if (!$hotpot->review) {
			error(get_string("noreview", "quiz"));
		}
		//if (time() < $hotpot->timeclose) {
		//	error(get_string("noreviewuntil", "quiz", userdate($hotpot->timeclose)));
		//}
		if ($attempt->userid != $USER->id) {
			error("This is not your attempt!");
		}
	}
	add_to_log($course->id, "hotpot", "review", "review.php?id=$cm->id&attempt=$attempt->id", "$hotpot->id", "$cm->id");
// Print the page header
	$strmodulenameplural = get_string("modulenameplural", "hotpot");
	$strmodulename  = get_string("modulename", "hotpot");
	// print header
	$title = "$course->shortname: $hotpot->name";
	$heading = "$course->fullname";
	$navigation = "<a href=\"index.php?id=$course->id\">$strmodulenameplural</a> -> ".get_string("review", "quiz");
	if ($course->category) {
		$navigation = "<a href=\"../../course/view.php?id=$course->id\">$course->shortname</a> -> $navigation";
	}
	$button = update_module_button($cm->id, $course->id, $strmodulename);
	print_header($title, $heading, $navigation, "", "", true, $button, navmenu($course, $cm));
	print '<div id="overDiv" style="position:absolute; visibility:hidden; z-index:1000;"></div>'; // for overlib
	print_heading($hotpot->name);
	hotpot_print_attempt_summary($hotpot, $attempt);
	hotpot_print_review_buttons($course, $hotpot, $attempt);
	$action = isteacher($course->id) ? optional_param('action') : '';
	if ($action) {
		$xml = get_field('hotpot_details', 'details', 'attempt', $attempt->id);
		print '<hr>';
		switch ($action) {
			case 'showxmltree':
				print '<pre id="contents">';
				$xml_tree = new hotpot_xml_tree($xml, "['hpjsresult']['#']");
				print_r ($xml_tree->xml_value('fields'));
				print '</pre>';
				break;
			case 'showxmlsource':
				print htmlspecialchars($xml);
				break;
			default:
				print "Action '$action' not recognized";
		}
		print '<hr>';
	} else {
		hotpot_print_attempt_details($hotpot, $attempt);
	}
	hotpot_print_review_buttons($course, $hotpot, $attempt);
	print_footer($course);
///////////////////////////
//    functions
///////////////////////////
function hotpot_print_attempt_summary(&$hotpot, &$attempt) {
	// start table
	print_simple_box_start("center", "80%", "#ffffff", 0);
	print '<table width="100%" border="1" valign="top" align="center" cellpadding="2" cellspacing="2" class="generaltable">'."\n";
	// add attempt properties
	$fields = array('attempt', 'score', 'penalties', 'status', 'timetaken', 'timerecorded');
	foreach ($fields as $field) {
		switch ($field) {
			case 'score':
				$value = hotpot_format_score($attempt);
				break;
			case 'status':
				$value = hotpot_format_status($attempt);
				break;
			case 'timerecorded':
				$value = empty($attempt->timefinish) ? '-' : userdate($attempt->timefinish); 
				break;
			case 'timetaken':
				$value = empty($attempt->timefinish) ? '-' : format_time($attempt->timefinish - $attempt->timestart); 
				break;
			default:
				$value = isset($attempt->$field) ? $attempt->$field : NULL;
		}
		if (isset($value)) {
			switch ($field) {
				case 'status':
				case 'timerecorded':
					$name = get_string('report'.$field, 'hotpot');
					break;
				case 'penalties':
					$name = get_string('penalties', 'hotpot');
					break;
				default:
					$name = get_string($field, 'quiz');
			}
			print '<tr><th align="right" width="100" class="generaltableheader">'.$name.':</th><td class="generaltablecell">'.$value.'</td></tr>';
		}
	}
	// finish table
	print '</table>';
	print_simple_box_end();
}
function hotpot_print_review_buttons(&$course, &$hotpot, &$attempt) {
	print "\n".'<table border="0" align="center" cellpadding="2" cellspacing="2" class="generaltable">';
	print "\n<tr>\n".'<td align="center">';
	print_single_button("report.php?hp=$hotpot->id", NULL, get_string('continue'), 'post');
	if (isteacher($course->id) && record_exists('hotpot_details', 'attempt', $attempt->id)) {
		print "</td>\n".'<td align="center">';
		print_single_button("review.php?hp=$hotpot->id&attempt=$attempt->id&action=showxmlsource", NULL, get_string('showxmlsource', 'hotpot'), 'post');
		print "</td>\n".'<td align="center">';
		print_single_button("review.php?hp=$hotpot->id&attempt=$attempt->id&action=showxmltree", NULL, get_string('showxmltree', 'hotpot'), 'post');
		$colspan = 3;
	} else {
		$colspan = 1;
	}
	print "</td>\n</tr>\n";
	print '<tr><td colspan="'.$colspan.'">';
	print_spacer(4, 1, false); // height=4, width=1, no <br />
	print "</td></tr>\n";
	print "</table>\n";
}
function hotpot_print_attempt_details(&$hotpot, &$attempt) {
	// define fields to print
	$textfields = array('correct', 'ignored', 'wrong');
	$numfields = array('score', 'weighting', 'hints', 'clues', 'checks');
	$fields = array_merge($textfields, $numfields);
	$q = array(); // questions
	$f = array(); // fields
	foreach ($fields as $field) {
		$name = get_string($field, 'hotpot');
		$f[$field] = array('count'=>0, 'name'=>$name);
	}
	// get questions and responses for this attempt
	$questions = get_records_select('hotpot_questions', "hotpot='$hotpot->id'", 'id');
	$responses = get_records_select('hotpot_responses', "attempt='$attempt->id'", 'id');
	if ($questions && $responses) {
		foreach ($responses as $response) {
			$id = $response->question;
			foreach ($fields as $field) {
				if (!isset($f[$field])) {
					$name = get_string($field, 'hotpot');
					$f[$field] = array('count'=>0, 'name'=>$name);
				}
				if (isset($response->$field)) {
					$f[$field]['count']++;
					if (!isset($q[$id])) {
						$name = hotpot_get_question_name($questions[$id]);
						$q[$id] = array('name'=>$name);
					}
					$q[$id][$field] = $response->$field;
				}
			}
		}
	}
	// count the number of columns required in the table
	$colspan = 0;
	foreach ($numfields as $field) {
		if ($f[$field]['count']) {
			$colspan += 2;
		}
	}
	$colspan = max(2, $colspan);
	// start table of questions and responses
	print_simple_box_start("center", "80%", "#ffffff", 0);
	print '<table width="100%" border="1" valign="top" align="center" cellpadding="2" cellspacing="2" class="generaltable">'."\n";
	if (empty($q)) {
		print '<tr><td align="center" class="generaltablecell"><b>'.get_string("noresponses", "hotpot")."</b></td></tr>\n";
	} else {
		// flag to ensure separators are only printed before the 2nd and subsequent questions
		$printseparator = false;
		foreach ($q as $i=>$question) {
			// flag to ensure questions are only printed when there is at least one response
			$printedquestion = false;
			// add rows of text fields
			foreach ($textfields as $field) {
				if (isset($question[$field])) {
					$text = hotpot_strings($question[$field]);
					if (trim($text)) {
						// print question if necessary
						if (!$printedquestion) {
							if ($printseparator) {
								print '<tr><td colspan="'.$colspan.'"><div class="tabledivider"></div></td></tr>'."\n";
							}
							$printseparator = true;
							print '<tr><td colspan="'.$colspan.'" class="generaltablecell"><b>'.$question['name'].'</b></td></tr>'."\n";
							$printedquestion = true;
						}
						// print response
						print '<tr><th align="right" width="100" class="generaltableheader">'.$f[$field]['name'].':</th><td colspan="'.($colspan-1).'" class="generaltablecell">'.$text.'</td></tr>'."\n";
					}
				}
			}
			// add row of numeric fields
			print '<tr>';
			foreach ($numfields as $field) {
				if ($f[$field]['count']) {
					// print question if necessary
					if (!$printedquestion) {
						print '<td colspan="'.$colspan.'" class="generaltablecell"><b>'.$question['name']."</b></td></tr>\n<tr>";
						$printedquestion = true;
					}
					// print numeric response
					$value = isset($question[$field]) ? $question[$field] : '-';
					print '<th align="right" width="100" class="generaltableheader">'.$f[$field]['name'].':</th><td class="generaltablecell">'.$value.'</td>';
				}
			}
			print "</tr>\n";
		} // foreach $q
	}
	// finish table
	print "</table>\n";
	print_simple_box_end();
}
?>
