Diff of /branches/gage_dev/webwork2/lib/WeBWorK/ContentGenerator/Problem.pm

Revision 1364		Revision 4031
1	################################################################################	1	################################################################################
2	# WeBWorK mod_perl (c) 2000-2002 WeBWorK Project	2	# WeBWorK Online Homework Delivery System
3	# $Id$	3	# Copyright © 2000-2006 The WeBWorK Project, http://openwebwork.sf.net/
		4	# $CVSHeader: webwork-modperl/lib/WeBWorK/ContentGenerator/Problem.pm,v 1.196 2006/03/02 16:50:39 apizer Exp $
		5	#
		6	# This program is free software; you can redistribute it and/or modify it under
		7	# the terms of either: (a) the GNU General Public License as published by the
		8	# Free Software Foundation; either version 2, or (at your option) any later
		9	# version, or (b) the "Artistic License" which comes with this package.
		10	#
		11	# This program is distributed in the hope that it will be useful, but WITHOUT
		12	# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
		13	# FOR A PARTICULAR PURPOSE. See either the GNU General Public License or the
		14	# Artistic License for more details.
4	################################################################################	15	################################################################################
5		16
6	package WeBWorK::ContentGenerator::Problem;	17	package WeBWorK::ContentGenerator::Problem;
7	use base qw(WeBWorK::ContentGenerator);	18	use base qw(WeBWorK::ContentGenerator);
8		19
9	=head1 NAME	20	=head1 NAME
10		21
11	WeBWorK::ContentGenerator::Problem - Allow a student to interact with a problem.	22	WeBWorK::ContentGenerator::Problem - Allow a student to interact with a problem.
12		23
13	=cut	24	=cut
14	my $timer0_ON=1; # times pg translation phase	25
15	use strict;	26	use strict;
16	use warnings;	27	use warnings;
17	use CGI qw();	28	use CGI qw();
18	use File::Path qw(rmtree);	29	use File::Path qw(rmtree);
		30	use WeBWorK::Debug;
19	use WeBWorK::Form;	31	use WeBWorK::Form;
20	use WeBWorK::PG;	32	use WeBWorK::PG;
21	use WeBWorK::PG::ImageGenerator;	33	use WeBWorK::PG::ImageGenerator;
22	use WeBWorK::PG::IO;	34	use WeBWorK::PG::IO;
23	use WeBWorK::Utils qw(writeLog encodeAnswers decodeAnswers ref2string makeTempDirectory);	35	use WeBWorK::Utils qw(readFile writeLog writeCourseLog encodeAnswers decodeAnswers ref2string makeTempDirectory path_is_subdir sortByName);
24	use WeBWorK::DB::Utils qw(global2user user2global findDefaults);	36	use WeBWorK::DB::Utils qw(global2user user2global findDefaults);
25	use WeBWorK::Timing;	37	use URI::Escape;
26		38
		39	use WeBWorK::Utils::Tasks qw(fake_set fake_problem);
		40
27	############################################################	41	################################################################################
		42	# CGI param interface to this module (up-to-date as of v1.153)
		43	################################################################################
		44
		45	# Standard params:
28	#	46	#
29	# user	47	# user - user ID of real user
30	# effectiveUser	48	# key - session key
31	# key	49	# effectiveUser - user ID of effective user
32	#	50	#
33	# displayMode	51	# Integration with PGProblemEditor:
34	# showOldAnswers
35	# showCorrectAnswers
36	# showHints
37	# showSolutions
38	#	52	#
39	# AnSwEr# - answer blanks in problem	53	# editMode - if set, indicates alternate problem source location.
		54	# can be "temporaryFile" or "savedFile".
40	#	55	#
		56	# sourceFilePath - path to file to be edited
		57	# problemSeed - force problem seed to value
		58	# success - success message to display
		59	# failure - failure message to display
		60	#
		61	# Rendering options:
		62	#
		63	# displayMode - name of display mode to use
		64	#
		65	# showOldAnswers - request that last entered answer be shown (if allowed)
		66	# showCorrectAnswers - request that correct answers be shown (if allowed)
		67	# showHints - request that hints be shown (if allowed)
		68	# showSolutions - request that solutions be shown (if allowed)
		69	#
		70	# Problem interaction:
		71	#
		72	# AnSwEr# - answer blanks in problem
		73	#
41	# redisplay - name of the "Redisplay Problem" button	74	# redisplay - name of the "Redisplay Problem" button
42	# submitAnswers - name of "Submit Answers" button	75	# submitAnswers - name of "Submit Answers" button
43	# checkAnswers - name of the "Check Answers" button	76	# checkAnswers - name of the "Check Answers" button
44	# previewAnswers - name of the "Preview Answers" button	77	# previewAnswers - name of the "Preview Answers" button
45	#	78
46	############################################################	79	################################################################################
		80	# "can" methods
		81	################################################################################
		82
		83	# Subroutines to determine if a user "can" perform an action. Each subroutine is
		84	# called with the following arguments:
		85	#
		86	# ($self, $User, $EffectiveUser, $Set, $Problem)
		87
		88	# Note that significant parts of the "can" methods are lifted into the
		89	# GatewayQuiz module. It isn't direct, however, because of the necessity
		90	# of dealing with versioning there.
		91
		92	sub can_showOldAnswers {
		93	#my ($self, $User, $EffectiveUser, $Set, $Problem) = @_;
		94
		95	return 1;
		96	}
		97
		98	sub can_showCorrectAnswers {
		99	my ($self, $User, $EffectiveUser, $Set, $Problem) = @_;
		100	my $authz = $self->r->authz;
		101
		102	return
		103	after($Set->answer_date)
		104	\|\|
		105	$authz->hasPermissions($User->user_id, "show_correct_answers_before_answer_date")
		106	;
		107	}
		108
		109	sub can_showHints {
		110	#my ($self, $User, $EffectiveUser, $Set, $Problem) = @_;
		111
		112	return 1;
		113	}
		114
		115	sub can_showSolutions {
		116	my ($self, $User, $EffectiveUser, $Set, $Problem) = @_;
		117	my $authz = $self->r->authz;
		118
		119	return
		120	after($Set->answer_date)
		121	\|\|
		122	$authz->hasPermissions($User->user_id, "show_solutions_before_answer_date")
		123	;
		124	}
		125
		126	sub can_recordAnswers {
		127	my ($self, $User, $EffectiveUser, $Set, $Problem, $submitAnswers) = @_;
		128	my $authz = $self->r->authz;
		129	my $thisAttempt = $submitAnswers ? 1 : 0;
		130	if ($User->user_id ne $EffectiveUser->user_id) {
		131	return $authz->hasPermissions($User->user_id, "record_answers_when_acting_as_student");
		132	}
		133	if (before($Set->open_date)) {
		134	return $authz->hasPermissions($User->user_id, "record_answers_before_open_date");
		135	} elsif (between($Set->open_date, $Set->due_date)) {
		136	my $max_attempts = $Problem->max_attempts;
		137	my $attempts_used = $Problem->num_correct + $Problem->num_incorrect + $thisAttempt;
		138	if ($max_attempts == -1 or $attempts_used < $max_attempts) {
		139	return $authz->hasPermissions($User->user_id, "record_answers_after_open_date_with_attempts");
		140	} else {
		141	return $authz->hasPermissions($User->user_id, "record_answers_after_open_date_without_attempts");
		142	}
		143	} elsif (between($Set->due_date, $Set->answer_date)) {
		144	return $authz->hasPermissions($User->user_id, "record_answers_after_due_date");
		145	} elsif (after($Set->answer_date)) {
		146	return $authz->hasPermissions($User->user_id, "record_answers_after_answer_date");
		147	}
		148	}
		149
		150	sub can_checkAnswers {
		151	my ($self, $User, $EffectiveUser, $Set, $Problem, $submitAnswers) = @_;
		152	my $authz = $self->r->authz;
		153	my $thisAttempt = $submitAnswers ? 1 : 0;
		154
		155	if (before($Set->open_date)) {
		156	return $authz->hasPermissions($User->user_id, "check_answers_before_open_date");
		157	} elsif (between($Set->open_date, $Set->due_date)) {
		158	my $max_attempts = $Problem->max_attempts;
		159	my $attempts_used = $Problem->num_correct + $Problem->num_incorrect + $thisAttempt;
		160	if ($max_attempts == -1 or $attempts_used < $max_attempts) {
		161	return $authz->hasPermissions($User->user_id, "check_answers_after_open_date_with_attempts");
		162	} else {
		163	return $authz->hasPermissions($User->user_id, "check_answers_after_open_date_without_attempts");
		164	}
		165	} elsif (between($Set->due_date, $Set->answer_date)) {
		166	return $authz->hasPermissions($User->user_id, "check_answers_after_due_date");
		167	} elsif (after($Set->answer_date)) {
		168	return $authz->hasPermissions($User->user_id, "check_answers_after_answer_date");
		169	}
		170	}
		171
		172	# Helper functions for calculating times
		173	sub before { return time <= $_[0] }
		174	sub after { return time >= $_[0] }
		175	sub between { my $t = time; return $t > $_[0] && $t < $_[1] }
		176
		177	# Reset the default in some cases
		178	sub set_showOldAnswers_default {
		179	my ($self, $ce, $userName, $authz, $set) = @_;
		180	# these people always use the system/course default, so don't
		181	# override the value of ...->{showOldAnswers}
		182	return if $authz->hasPermissions($userName, "can_always_use_show_old_answers_default");
		183	# this person should always default to 0
		184	$ce->{pg}->{options}->{showOldAnswers} = 0
		185	unless ($authz->hasPermissions($userName, "can_show_old_answers_by_default"));
		186	# we are after the due date, so default to not showing it
		187	$ce->{pg}->{options}->{showOldAnswers} = 0 if $set->{due_date} && after($set->{due_date});
		188	}
		189
		190	################################################################################
		191	# output utilities
		192	################################################################################
		193
		194	# Note: the substance of attemptResults is lifted into GatewayQuiz.pm,
		195	# with some changes to the output format
		196
		197	sub attemptResults {
		198	my $self = shift;
		199	my $pg = shift;
		200	my $showAttemptAnswers = shift;
		201	my $showCorrectAnswers = shift;
		202	my $showAttemptResults = $showAttemptAnswers && shift;
		203	my $showSummary = shift;
		204	my $showAttemptPreview = shift \|\| 0;
		205
		206	my $ce = $self->r->ce;
		207
		208	my $problemResult = $pg->{result}; # the overall result of the problem
		209	my @answerNames = @{ $pg->{flags}->{ANSWER_ENTRY_ORDER} };
		210
		211	my $showMessages = $showAttemptAnswers && grep { $pg->{answers}->{$_}->{ans_message} } @answerNames;
		212
		213	my $basename = "equation-" . $self->{set}->psvn. "." . $self->{problem}->problem_id . "-preview";
		214
		215	# to make grabbing these options easier, we'll pull them out now...
		216	my %imagesModeOptions = %{$ce->{pg}->{displayModeOptions}->{images}};
		217
		218	my $imgGen = WeBWorK::PG::ImageGenerator->new(
		219	tempDir => $ce->{webworkDirs}->{tmp},
		220	latex => $ce->{externalPrograms}->{latex},
		221	dvipng => $ce->{externalPrograms}->{dvipng},
		222	useCache => 1,
		223	cacheDir => $ce->{webworkDirs}->{equationCache},
		224	cacheURL => $ce->{webworkURLs}->{equationCache},
		225	cacheDB => $ce->{webworkFiles}->{equationCacheDB},
		226	dvipng_align => $imagesModeOptions{dvipng_align},
		227	dvipng_depth_db => $imagesModeOptions{dvipng_depth_db},
		228	);
		229
		230	my $header;
		231	#$header .= CGI::th("Part");
		232	$header .= $showAttemptAnswers ? CGI::th("Entered") : "";
		233	$header .= $showAttemptPreview ? CGI::th("Answer Preview") : "";
		234	$header .= $showCorrectAnswers ? CGI::th("Correct") : "";
		235	$header .= $showAttemptResults ? CGI::th("Result") : "";
		236	$header .= $showMessages ? CGI::th("Messages") : "";
		237	my $fully = '';
		238	my @tableRows = ( $header );
		239	my $numCorrect = 0;
		240	my $numBlanks =0;
		241	my $tthPreambleCache;
		242	foreach my $name (@answerNames) {
		243	my $answerResult = $pg->{answers}->{$name};
		244	my $studentAnswer = $answerResult->{student_ans}; # original_student_ans
		245	my $preview = ($showAttemptPreview
		246	? $self->previewAnswer($answerResult, $imgGen, \$tthPreambleCache)
		247	: "");
		248	my $correctAnswer = $answerResult->{correct_ans};
		249	my $answerScore = $answerResult->{score};
		250	my $answerMessage = $showMessages ? $answerResult->{ans_message} : "";
		251	$answerMessage =~ s/\n/<BR>/g;
		252	$numCorrect += $answerScore >= 1;
		253	$numBlanks++ unless $studentAnswer =~/\S/ \|\| $answerScore >= 1; # unless student answer contains entry
		254	my $resultString = $answerScore >= 1 ? "correct" :
		255	$answerScore > 0 ? int($answerScore*100)."% correct" :
		256	"incorrect";
		257	$fully = 'completely ' if $answerScore >0 and $answerScore < 1;
		258
		259	# get rid of the goofy prefix on the answer names (supposedly, the format
		260	# of the answer names is changeable. this only fixes it for "AnSwEr"
		261	#$name =~ s/^AnSwEr//;
		262
		263	my $row;
		264	#$row .= CGI::td($name);
		265	$row .= $showAttemptAnswers ? CGI::td($self->nbsp($studentAnswer)) : "";
		266	$row .= $showAttemptPreview ? CGI::td($self->nbsp($preview)) : "";
		267	$row .= $showCorrectAnswers ? CGI::td($self->nbsp($correctAnswer)) : "";
		268	$row .= $showAttemptResults ? CGI::td($self->nbsp($resultString)) : "";
		269	$row .= $showMessages ? CGI::td({-class=>"Message"},$self->nbsp($answerMessage)) : "";
		270	push @tableRows, $row;
		271	}
		272
		273	# render equation images
		274	$imgGen->render(refresh => 1);
		275
		276	# my $numIncorrectNoun = scalar @answerNames == 1 ? "question" : "questions";
		277	my $scorePercent = sprintf("%.0f%%", $problemResult->{score} * 100);
		278	# FIXME -- I left the old code in in case we have to back out.
		279	# my $summary = "On this attempt, you answered $numCorrect out of "
		280	# . scalar @answerNames . " $numIncorrectNoun correct, for a score of $scorePercent.";
		281	my $summary = "";
		282	unless (defined($problemResult->{summary}) and $problemResult->{summary} =~ /\S/) {
		283	if (scalar @answerNames == 1) { #default messages
		284	if ($numCorrect == scalar @answerNames) {
		285	$summary .= CGI::div({class=>"ResultsWithoutError"},"The above answer is correct.");
		286	} else {
		287	$summary .= CGI::div({class=>"ResultsWithError"},"The above answer is NOT ${fully}correct.");
		288	}
		289	} else {
		290	if ($numCorrect == scalar @answerNames) {
		291	$summary .= CGI::div({class=>"ResultsWithoutError"},"All of the above answers are correct.");
		292	}
		293	unless ($numCorrect + $numBlanks == scalar( @answerNames)) {
		294	$summary .= CGI::div({class=>"ResultsWithError"},"At least one of the above answers is NOT ${fully}correct.");
		295	}
		296	if ($numBlanks) {
		297	my $s = ($numBlanks>1)?'':'s';
		298	$summary .= CGI::div({class=>"ResultsAlert"},"$numBlanks of the questions remain$s unanswered.");
		299	}
		300	}
		301	} else {
		302	$summary = $problemResult->{summary}; # summary has been defined by grader
		303	}
		304	return
		305	CGI::table({-class=>"attemptResults"}, CGI::Tr(\@tableRows))
		306	. ($showSummary ? CGI::p({class=>'attemptResultsSummary'},$summary) : "");
		307	}
		308
		309
		310	# Note: previewAnswer is lifted into GatewayQuiz.pm
		311
		312	sub previewAnswer {
		313	my ($self, $answerResult, $imgGen, $tthPreambleCache) = @_;
		314	my $ce = $self->r->ce;
		315	my $effectiveUser = $self->{effectiveUser};
		316	my $set = $self->{set};
		317	my $problem = $self->{problem};
		318	my $displayMode = $self->{displayMode};
		319
		320	# note: right now, we have to do things completely differently when we are
		321	# rendering math from INSIDE the translator and from OUTSIDE the translator.
		322	# so we'll just deal with each case explicitly here. there's some code
		323	# duplication that can be dealt with later by abstracting out tth/dvipng/etc.
		324
		325	my $tex = $answerResult->{preview_latex_string};
		326
		327	return "" unless defined $tex and $tex ne "";
		328
		329	if ($displayMode eq "plainText") {
		330	return $tex;
		331	} elsif ($displayMode eq "formattedText") {
		332
		333	# read the TTH preamble, or use the cached copy passed in from the caller
		334	my $tthPreamble='';
		335	if (defined $$tthPreambleCache) {
		336	$tthPreamble = $$tthPreambleCache;
		337	} else {
		338	my $tthPreambleFile = $ce->{courseDirs}->{templates} . "/tthPreamble.tex";
		339	if (-r $tthPreambleFile) {
		340	$tthPreamble = readFile($tthPreambleFile);
		341	# thanks to Jim Martino. each line in the definition file should end with
		342	#a % to prevent adding supurious paragraphs to output:
		343	$tthPreamble =~ s/(.)\n/$1%\n/g;
		344	# solves the problem if the file doesn't end with a return:
		345	$tthPreamble .="%\n";
		346	# store preamble in cache:
		347	$$tthPreambleCache = $tthPreamble;
		348	} else {
		349	}
		350	}
		351
		352	# construct TTH command line
		353	my $tthCommand = $ce->{externalPrograms}->{tth}
		354	. " -L -f5 -u -r 2> /dev/null <<END_OF_INPUT; echo > /dev/null\n"
		355	. $tthPreamble . "\\[" . $tex . "\\]\n"
		356	. "END_OF_INPUT\n";
		357
		358	# call tth
		359	my $result = `$tthCommand`;
		360	if ($?) {
		361	return "<b>[tth failed: $? $@]</b>";
		362	} else {
		363	# avoid border problems in tables and remove unneeded initial <br>
		364	$result =~ s/(<table [^>]*)>/$1 CLASS="ArrayLayout">/gi;
		365	$result =~ s!\s*<br clear="all" />!!;
		366	return $result;
		367	}
		368
		369	} elsif ($displayMode eq "images") {
		370	$imgGen->add($tex);
		371	} elsif ($displayMode eq "jsMath") {
		372	return '<SPAN CLASS="math">\\displaystyle{'.$tex.'}</SPAN>';
		373	}
		374	}
		375
		376	################################################################################
		377	# Template escape implementations
		378	################################################################################
47		379
48	sub pre_header_initialize {	380	sub pre_header_initialize {
49	my ($self, $setName, $problemNumber) = @_;	381	my ($self) = @_;
50	my $r = $self->{r};	382	my $r = $self->r;
51	my $courseEnv = $self->{ce};	383	my $ce = $r->ce;
52	my $db = $self->{db};	384	my $db = $r->db;
		385	my $authz = $r->authz;
		386	my $urlpath = $r->urlpath;
		387
		388	my $setName = $urlpath->arg("setID");
		389	my $problemNumber = $r->urlpath->arg("problemID");
53	my $userName = $r->param('user');	390	my $userName = $r->param('user');
54	my $effectiveUserName = $r->param('effectiveUser');	391	my $effectiveUserName = $r->param('effectiveUser');
55	my $key = $r->param('key');	392	my $key = $r->param('key');
56	my $user = $db->getUser($userName);	393	my $editMode = $r->param("editMode");
		394
		395	my $user = $db->getUser($userName); # checked
		396	die "record for user $userName (real user) does not exist."
		397	unless defined $user;
		398
57	my $effectiveUser = $db->getUser($effectiveUserName);	399	my $effectiveUser = $db->getUser($effectiveUserName); # checked
58	my $permissionLevel = $db->getPermissionLevel($userName)->permission();	400	die "record for user $effectiveUserName (effective user) does not exist."
		401	unless defined $effectiveUser;
59		402
60	# obtain the merged set for $effectiveUser	403	# obtain the merged set for $effectiveUser
		404	my $set = $db->getMergedSet($effectiveUserName, $setName); # checked
		405
		406	$self->set_showOldAnswers_default($ce, $userName, $authz, $set);
		407
		408	# gateway check here: we want to be sure that someone isn't trying to take
		409	# a GatewayQuiz through the regular problem/homework mechanism, thereby
		410	# circumventing the versioning, time limits, etc.
		411	if (defined $set and defined $set->assignment_type and $set->assignment_type() =~ /gateway/) {
		412	unless ($editMode eq "temporaryFile" and $authz->hasPermissions($userName, "modify_student_data")) {
		413	die('Invalid access attempt: the Problem ContentGenerator was called for a GatewayQuiz assignment.' );
		414	}
		415	}
		416
		417	# Database fix (in case of undefined published values)
		418	# this is only necessary because some people keep holding to ww1.9 which did not have a published field
		419	# make sure published is set to 0 or 1
		420	if ( $set and $set->published ne "0" and $set->published ne "1") {
		421	my $globalSet = $db->getGlobalSet($set->set_id);
		422	$globalSet->published("1"); # defaults to published
		423	$db->putGlobalSet($globalSet);
61	my $set = $db->getMergedSet($effectiveUserName, $setName);	424	$set = $db->getMergedSet($effectiveUserName, $setName);
		425	} else {
		426	# don't do anything just yet, maybe we're a professor and we're
		427	# fabricating a set or haven't assigned it to ourselves just yet
		428	}
62		429
63	# obtain the merged problem for $effectiveUser	430	# obtain the merged problem for $effectiveUser
64	my $problem = $db->getMergedProblem($effectiveUserName, $setName, $problemNumber);	431	my $problem = $db->getMergedProblem($effectiveUserName, $setName, $problemNumber); # checked
65		432
66	my $editMode = $r->param("editMode");	433	if ($authz->hasPermissions($userName, "modify_problem_sets")) {
67
68	if ($permissionLevel > 0 and defined $editMode) {
69	# professors are allowed to fabricate sets and problems not	434	# professors are allowed to fabricate sets and problems not
70	# assigned to them (or anyone). this allows them to use the	435	# assigned to them (or anyone). this allows them to use the
71	# editor to	436	# editor to
72		437
73	# if that is not yet defined obtain the global set, convert	438	# if a User Set does not exist for this user and this set
74	# it to a user set, and add fake user data	439	# then we check the Global Set
		440	# if that does not exist we create a fake set
		441	# if it does, we add fake user data
75	unless (defined $set) {	442	unless (defined $set) {
76	my $userSetClass = $db->{set_user}->{record};	443	my $userSetClass = $db->{set_user}->{record};
		444	my $globalSet = $db->getGlobalSet($setName); # checked
		445
		446	if (not defined $globalSet) {
		447	$set = fake_set($db);
		448	} else {
77	$set = global2user($userSetClass,	449	$set = global2user($userSetClass, $globalSet);
78	$db->getGlobalSet($setName));
79	die "Set $setName does not exist"
80	unless defined $set;
81	$set->psvn(0);	450	$set->psvn(0);
		451	}
82	}	452	}
83		453
84	# if that is not yet defined obtain the global problem,	454	# if that is not yet defined obtain the global problem,
85	# convert it to a user problem, and add fake user data	455	# convert it to a user problem, and add fake user data
86	unless (defined $problem) {	456	unless (defined $problem) {
87	my $userProblemClass = $db->{problem_user}->{record};	457	my $userProblemClass = $db->{problem_user}->{record};
88	$problem = global2user($userProblemClass,
89	$db->getGlobalProblem($setName,$problemNumber));	458	my $globalProblem = $db->getGlobalProblem($setName, $problemNumber); # checked
		459	# if the global problem doesn't exist either, bail!
		460	if(not defined $globalProblem) {
		461	my $sourceFilePath = $r->param("sourceFilePath");
		462	die "sourceFilePath is unsafe!" unless path_is_subdir($sourceFilePath, $ce->{courseDirs}->{templates});
		463	# These are problems from setmaker. If declared invalid, they won't come up
		464	$self->{invalidProblem} = $self->{invalidSet} = 1 unless defined $sourceFilePath;
90	die "Problem $problemNumber in set $setName does not exist"	465	# die "Problem $problemNumber in set $setName does not exist" unless defined $sourceFilePath;
91	unless defined $problem;	466	$problem = fake_problem($db);
		467	$problem->problem_id(1);
		468	$problem->source_file($sourceFilePath);
92	$problem->user_id($effectiveUserName);	469	$problem->user_id($effectiveUserName);
		470	} else {
		471	$problem = global2user($userProblemClass, $globalProblem);
		472	$problem->user_id($effectiveUserName);
93	$problem->problem_seed(0);	473	$problem->problem_seed(0);
94	$problem->status(0);	474	$problem->status(0);
95	$problem->attempted(0);	475	$problem->attempted(0);
96	$problem->last_answer("");	476	$problem->last_answer("");
97	$problem->num_correct(0);	477	$problem->num_correct(0);
98	$problem->num_incorrect(0);	478	$problem->num_incorrect(0);
		479	}
99	}	480	}
100		481
101	# now we're sure we have valid UserSet and UserProblem objects	482	# now we're sure we have valid UserSet and UserProblem objects
102	# yay!	483	# yay!
103		484
104	# now deal with possible editor overrides:	485	# now deal with possible editor overrides:
105		486
106	# if the caller is asking to override the source file, and	487	# if the caller is asking to override the source file, and
107	# editMode calls for a temporary file, do so	488	# editMode calls for a temporary file, do so
108	my $sourceFilePath = $r->param("sourceFilePath");	489	my $sourceFilePath = $r->param("sourceFilePath");
109	if (defined $sourceFilePath and $editMode eq "temporaryFile") {	490	if (defined $editMode and $editMode eq "temporaryFile" and defined $sourceFilePath) {
		491	die "sourceFilePath is unsafe!" unless path_is_subdir($sourceFilePath, $ce->{courseDirs}->{templates});
110	$problem->source_file($sourceFilePath);	492	$problem->source_file($sourceFilePath);
111	}	493	}
		494
		495	# if the problem does not have a source file or no source file has been passed in
		496	# then this is really an invalid problem (probably from a bad URL)
		497	$self->{invalidProblem} = not (defined $sourceFilePath or $problem->source_file);
112		498
113	# if the caller is asking to override the problem seed, do so	499	# if the caller is asking to override the problem seed, do so
114	my $problemSeed = $r->param("problemSeed");	500	my $problemSeed = $r->param("problemSeed");
115	if (defined $problemSeed) {	501	if (defined $problemSeed) {
116	$problem->problem_seed($problemSeed);	502	$problem->problem_seed($problemSeed);
117	}	503	}
118	} else {	504
119	# students can't view problems not assigned to them	505	my $publishedClass = ($set->published) ? "Published" : "Unpublished";
120	die "Set $setName is not assigned to $effectiveUserName"	506	my $publishedText = ($set->published) ? "visible to students." : "hidden from students.";
121	unless defined $set;	507	$self->addmessage(CGI::p("This set is " . CGI::font({class=>$publishedClass}, $publishedText)));
122	die "Problem $problemNumber in set $setName is not assigned to $effectiveUserName"	508
123	unless defined $problem;	509	# test for additional set validity if it's not already invalid
		510	} else {
		511	# A set is valid if it exists and if it is either published or the user is privileged.
		512	$self->{invalidSet} = !(defined $set and ($set->published \|\| $authz->hasPermissions($userName, "view_unpublished_sets")));
		513	$self->{invalidProblem} = !(defined $problem and ($set->published \|\| $authz->hasPermissions($userName, "view_unpublished_sets")));
		514
		515	$self->addbadmessage(CGI::p("This problem will not count towards your grade.")) if $problem and not $problem->value and not $self->{invalidProblem};
124	}	516	}
125		517
126	$self->{userName} = $userName;	518	$self->{userName} = $userName;
127	$self->{effectiveUserName} = $effectiveUserName;	519	$self->{effectiveUserName} = $effectiveUserName;
128	$self->{user} = $user;	520	$self->{user} = $user;
129	$self->{effectiveUser} = $effectiveUser;	521	$self->{effectiveUser} = $effectiveUser;
130	$self->{permissionLevel} = $permissionLevel;
131	$self->{set} = $set;	522	$self->{set} = $set;
132	$self->{problem} = $problem;	523	$self->{problem} = $problem;
133	$self->{editMode} = $editMode;	524	$self->{editMode} = $editMode;
134		525
135	##### form processing #####	526	##### form processing #####
136		527
137	# set options from form fields (see comment at top of file for names)	528	# set options from form fields (see comment at top of file for names)
138	my $displayMode = $r->param("displayMode") \|\| $courseEnv->{pg}->{options}->{displayMode};	529	my $displayMode = $r->param("displayMode") \|\| $ce->{pg}->{options}->{displayMode};
139	my $redisplay = $r->param("redisplay");	530	my $redisplay = $r->param("redisplay");
140	my $submitAnswers = $r->param("submitAnswers");	531	my $submitAnswers = $r->param("submitAnswers");
141	my $checkAnswers = $r->param("checkAnswers");	532	my $checkAnswers = $r->param("checkAnswers");
142	my $previewAnswers = $r->param("previewAnswers");	533	my $previewAnswers = $r->param("previewAnswers");
143		534
144	# fields which may be defined when using Problem Editor
145	#my $override_seed = ($permissionLevel>=10) ? $r->param('problemSeed') : undef;
146	#my $override_problem_source = ($permissionLevel>=10) ? $r->param('sourceFilePath') : undef;
147	#my $editMode = undef;
148	#my $submit_button = $r->param('submit_button');
149	#if ( defined($submit_button ) ) {
150	# $editMode = "temporaryFile" if $submit_button eq 'Refresh';
151	# $editMode = 'savedFile' if $submit_button eq 'Save';
152	#}
153	#
154	##override using the source file data from the form field
155	#$problem->source_file($override_problem_source) if defined($override_problem_source);
156	#$problem->problem_seed($override_seed) if defined($override_seed);
157	#
158	## store path to source file for title.
159	#$self->{problem_source_name} = $problem->source_file;
160	#$self->{edit_mode} = $editMode;
161	#$self->{current_problem_source} = (defined($override_problem_source) ) ?
162
163	# coerce form fields into CGI::Vars format
164	my $formFields = { WeBWorK::Form->new_from_paramable($r)->Vars };	535	my $formFields = { WeBWorK::Form->new_from_paramable($r)->Vars };
165		536
166	$self->{displayMode} = $displayMode;	537	$self->{displayMode} = $displayMode;
167	$self->{redisplay} = $redisplay;	538	$self->{redisplay} = $redisplay;
168	$self->{submitAnswers} = $submitAnswers;	539	$self->{submitAnswers} = $submitAnswers;
169	$self->{checkAnswers} = $checkAnswers;	540	$self->{checkAnswers} = $checkAnswers;
170	$self->{previewAnswers} = $previewAnswers;	541	$self->{previewAnswers} = $previewAnswers;
171	$self->{formFields} = $formFields;	542	$self->{formFields} = $formFields;
		543
		544	# get result and send to message
		545	my $status_message = $r->param("status_message");
		546	$self->addmessage(CGI::p("$status_message")) if $status_message;
		547
		548	# now that we've set all the necessary variables quit out if the set or problem is invalid
		549	return if $self->{invalidSet} \|\| $self->{invalidProblem};
172		550
173	##### permissions #####	551	##### permissions #####
174		552
175	# are we allowed to view this problem?	553	# are we allowed to view this problem?
176	$self->{isOpen} = time >= $set->open_date \|\| $permissionLevel > 0;	554	$self->{isOpen} = after($set->open_date) \|\| $authz->hasPermissions($userName, "view_unopened_sets");
177	return unless $self->{isOpen};	555	return unless $self->{isOpen};
178		556
179	# what does the user want to do?	557	# what does the user want to do?
		558	#FIXME There is a problem with checkboxes -- if they are not checked they are invisible. Hence if the default mode in $ce is 1
		559	# there is no way to override this. Probably this is ok for the last three options, but it was definitely not ok for showing
		560	# saved answers which is normally on, but you want to be able to turn it off! This section should be moved to ContentGenerator
		561	# so that you can set these options anywhere. We also need mechanisms for making them sticky.
		562	# Note: ProblemSet and ProblemSets might set showOldAnswers to '', which
		563	# needs to be treated as if it is not set.
180	my %want = (	564	my %want = (
181	showOldAnswers => $r->param("showOldAnswers") \|\| $courseEnv->{pg}->{options}->{showOldAnswers},	565	showOldAnswers => (defined($r->param("showOldAnswers")) and $r->param("showOldAnswers") ne '') ? $r->param("showOldAnswers") : $ce->{pg}->{options}->{showOldAnswers},
182	showCorrectAnswers => $r->param("showCorrectAnswers") \|\| $courseEnv->{pg}->{options}->{showCorrectAnswers},	566	showCorrectAnswers => $r->param("showCorrectAnswers") \|\| $ce->{pg}->{options}->{showCorrectAnswers},
183	showHints => $r->param("showHints") \|\| $courseEnv->{pg}->{options}->{showHints},	567	showHints => $r->param("showHints") \|\| $ce->{pg}->{options}->{showHints},
184	showSolutions => $r->param("showSolutions") \|\| $courseEnv->{pg}->{options}->{showSolutions},	568	showSolutions => $r->param("showSolutions") \|\| $ce->{pg}->{options}->{showSolutions},
185	recordAnswers => $submitAnswers,	569	recordAnswers => $submitAnswers,
186	checkAnswers => $checkAnswers,	570	checkAnswers => $checkAnswers,
		571	getSubmitButton => 1,
187	);	572	);
188		573
189	# are certain options enforced?	574	# are certain options enforced?
190	my %must = (	575	my %must = (
191	showOldAnswers => 0,	576	showOldAnswers => 0,
192	showCorrectAnswers => 0,	577	showCorrectAnswers => 0,
193	showHints => 0,	578	showHints => 0,
194	showSolutions => 0,	579	showSolutions => 0,
195	recordAnswers => mustRecordAnswers($permissionLevel),	580	recordAnswers => ! $authz->hasPermissions($userName, "avoid_recording_answers"),
196	checkAnswers => 0,	581	checkAnswers => 0,
		582	getSubmitButton => 0,
197	);	583	);
198		584
199	# does the user have permission to use certain options?	585	# does the user have permission to use certain options?
		586	my @args = ($user, $effectiveUser, $set, $problem);
200	my %can = (	587	my %can = (
201	showOldAnswers => 1,	588	showOldAnswers => $self->can_showOldAnswers(@args),
202	showCorrectAnswers => canShowCorrectAnswers($permissionLevel, $set->answer_date),	589	showCorrectAnswers => $self->can_showCorrectAnswers(@args),
203	showHints => 1,	590	showHints => $self->can_showHints(@args),
204	showSolutions => canShowSolutions($permissionLevel, $set->answer_date),	591	showSolutions => $self->can_showSolutions(@args),
205	recordAnswers => canRecordAnswers($permissionLevel, $set->open_date, $set->due_date,	592	recordAnswers => $self->can_recordAnswers(@args, 0),
206	$problem->max_attempts, $problem->num_correct + $problem->num_incorrect + 1),	593	checkAnswers => $self->can_checkAnswers(@args, $submitAnswers),
207	# attempts=num_correct+num_incorrect+1, as this happens before updating $problem	594	getSubmitButton => $self->can_recordAnswers(@args, $submitAnswers),
208	checkAnswers => canCheckAnswers($permissionLevel, $set->answer_date),
209	);	595	);
210		596
211	# final values for options	597	# final values for options
212	my %will;	598	my %will;
213	foreach (keys %must) {	599	foreach (keys %must) {
…		…
222	$formFields->{$_} = $oldAnswers{$_} foreach keys %oldAnswers;	608	$formFields->{$_} = $oldAnswers{$_} foreach keys %oldAnswers;
223	}	609	}
224		610
225	##### translation #####	611	##### translation #####
226		612
227	$WeBWorK::timer0->continue("begin pg processing") if $timer0_ON;	613	debug("begin pg processing");
228	my $pg = WeBWorK::PG->new(	614	my $pg = WeBWorK::PG->new(
229	$courseEnv,	615	$ce,
230	$effectiveUser,	616	$effectiveUser,
231	$key,	617	$key,
232	$set,	618	$set,
233	$problem,	619	$problem,
234	$set->psvn, # FIXME: this field should be removed	620	$set->psvn, # FIXME: this field should be removed
…		…
240	refreshMath2img => $will{showHints} \|\| $will{showSolutions},	626	refreshMath2img => $will{showHints} \|\| $will{showSolutions},
241	processAnswers => 1,	627	processAnswers => 1,
242	},	628	},
243	);	629	);
244		630
245	$WeBWorK::timer0->continue("end pg processing") if $timer0_ON;	631	debug("end pg processing");
		632
246	##### fix hint/solution options #####	633	##### fix hint/solution options #####
247		634
248	$can{showHints} &&= $pg->{flags}->{hintExists};	635	$can{showHints} &&= $pg->{flags}->{hintExists}
		636	&&= $pg->{flags}->{showHintLimit}<=$pg->{state}->{num_of_incorrect_ans};
249	$can{showSolutions} &&= $pg->{flags}->{solutionExists};	637	$can{showSolutions} &&= $pg->{flags}->{solutionExists};
250		638
251	##### store fields #####	639	##### store fields #####
252		640
253	$self->{want} = \%want;	641	$self->{want} = \%want;
254	$self->{must} = \%must;	642	$self->{must} = \%must;
255	$self->{can} = \%can;	643	$self->{can} = \%can;
256	$self->{will} = \%will;	644	$self->{will} = \%will;
257
258	$self->{pg} = $pg;	645	$self->{pg} = $pg;
259	}	646	}
260
261	#sub if_warnings($$) {
262	# my ($self, $arg) = @_;
263	# return 0 unless $self->{isOpen};
264	# return $self->{pg}->{warnings} ne "";
265	#}
266		647
267	sub if_errors($$) {	648	sub if_errors($$) {
268	my ($self, $arg) = @_;	649	my ($self, $arg) = @_;
269	return 0 unless $self->{isOpen};	650
		651	if ($self->{isOpen}) {
270	return $self->{pg}->{flags}->{error_flag};	652	return $self->{pg}->{flags}->{error_flag} ? $arg : !$arg;
		653	} else {
		654	return !$arg;
		655	}
271	}	656	}
272		657
273	sub head {	658	sub head {
274	my $self = shift;	659	my ($self) = @_;
		660
275	return "" unless $self->{isOpen};	661	return "" unless $self->{isOpen};
276	return $self->{pg}->{head_text} if $self->{pg}->{head_text};	662	return $self->{pg}->{head_text} if $self->{pg}->{head_text};
277	}	663	}
278		664
279	sub options {	665	sub options {
280	my $self = shift;	666	my ($self) = @_;
281	return join("",	667	#warn "doing options in Problem";
282	CGI::start_form("POST", $self->{r}->uri),	668
283	$self->hidden_authen_fields,	669	# don't show options if we don't have anything to show
284	CGI::hr(),	670	return "" if $self->{invalidSet} or $self->{invalidProblem};
285	CGI::start_div({class=>"viewOptions"}),	671	return "" unless $self->{isOpen};
286	$self->viewOptions(),	672
287	CGI::end_div(),	673	my $displayMode = $self->{displayMode};
288	CGI::end_form()	674	my %can = %{ $self->{can} };
		675
		676	my @options_to_show = "displayMode";
		677	push @options_to_show, "showOldAnswers" if $can{showOldAnswers};
		678	push @options_to_show, "showHints" if $can{showHints};
		679	push @options_to_show, "showSolutions" if $can{showSolutions};
		680
		681	return $self->optionsMacro(
		682	options_to_show => \@options_to_show,
		683	extra_params => ["editMode", "sourceFilePath"],
289	);	684	);
290	}	685	}
291		686
292	sub path {
293	my $self = shift;
294	my $args = $_[-1];
295	my $setName = $self->{set}->set_id;
296	my $problemNumber = $self->{problem}->problem_id;
297
298	my $ce = $self->{ce};
299	my $root = $ce->{webworkURLs}->{root};
300	my $courseName = $ce->{courseName};
301	return $self->pathMacro($args,
302	"Home" => "$root",
303	$courseName => "$root/$courseName",
304	$setName => "$root/$courseName/$setName",
305	"Problem $problemNumber" => "",
306	);
307	}
308
309	sub siblings {	687	sub siblings {
310	my $self = shift;	688	my ($self) = @_;
		689	my $r = $self->r;
		690	my $db = $r->db;
		691	my $urlpath = $r->urlpath;
		692
		693	# can't show sibling problems if the set is invalid
		694	return "" if $self->{invalidSet};
		695
		696	my $courseID = $urlpath->arg("courseID");
311	my $setName = $self->{set}->set_id;	697	my $setID = $self->{set}->set_id;
312	my $problemNumber = $self->{problem}->problem_id;
313
314	my $ce = $self->{ce};
315	my $db = $self->{db};
316	my $root = $ce->{webworkURLs}->{root};
317	my $courseName = $ce->{courseName};
318	print CGI::strong("Problems"), CGI::br();
319
320	my $effectiveUser = $self->{r}->param("effectiveUser");	698	my $eUserID = $r->param("effectiveUser");
321	my @problemIDs = $db->listUserProblems($effectiveUser, $setName);	699	my @problemIDs = sort { $a <=> $b } $db->listUserProblems($eUserID, $setID);
		700
		701	print CGI::start_div({class=>"info-box", id=>"fisheye"});
		702	print CGI::h2("Problems");
		703	#print CGI::start_ul({class=>"LinksMenu"});
		704	#print CGI::start_li();
		705	#print CGI::span({style=>"font-size:larger"}, "Problems");
		706	print CGI::start_ul();
		707
322	foreach my $problem (sort { $a <=> $b } @problemIDs) {	708	foreach my $problemID (@problemIDs) {
323	print '  '.CGI::a({-href=>"$root/$courseName/$setName/".$problem."/?"	709	my $problemPage = $urlpath->newFromModule("WeBWorK::ContentGenerator::Problem",
324	. $self->url_authen_args . "&displayMode=" . $self->{displayMode}},	710	courseID => $courseID, setID => $setID, problemID => $problemID);
325	"Problem ".$problem), CGI::br();	711	print CGI::li(CGI::a( {href=>$self->systemLink($problemPage,
		712	params=>{ displayMode => $self->{displayMode},
		713	showOldAnswers => $self->{will}->{showOldAnswers}
		714	})}, "Problem $problemID")
		715	);
326	}	716	}
327		717
		718	print CGI::end_ul();
		719	#print CGI::end_li();
		720	#print CGI::end_ul();
		721	print CGI::end_div();
		722
328	return "";	723	return "";
329	}	724	}
330		725
331	sub nav {	726	sub nav {
332	$WeBWorK::timer0->continue("begin nav subroutine") if $timer0_ON;	727	my ($self, $args) = @_;
333	my $self = shift;
334	my $args = $_[-1];
335	my $setName = $self->{set}->set_id;
336	my $problemNumber = $self->{problem}->problem_id;
337
338	my $ce = $self->{ce};	728	my $r = $self->r;
339	my $db = $self->{db};	729	my $db = $r->db;
340	my $root = $ce->{webworkURLs}->{root};	730	my $urlpath = $r->urlpath;
341	my $courseName = $ce->{courseName};
342		731
343	my $wwdb = $self->{wwdb};	732	my $courseID = $urlpath->arg("courseID");
		733	my $setID = $self->{set}->set_id if !($self->{invalidSet});
		734	my $problemID = $self->{problem}->problem_id if !($self->{invalidProblem});
344	my $effectiveUser = $self->{r}->param("effectiveUser");	735	my $eUserID = $r->param("effectiveUser");
345	my $tail = "&displayMode=".$self->{displayMode};
346		736
347	my @links = ("Problem List" , "$root/$courseName/$setName", "navProbList");
348
349	my @problemIDs = $db->listUserProblems($effectiveUser, $setName);
350	my ($prevID, $nextID);	737	my ($prevID, $nextID);
		738
		739	if (!$self->{invalidProblem}) {
		740	my @problemIDs = $db->listUserProblems($eUserID, $setID);
351	foreach my $id (@problemIDs) {	741	foreach my $id (@problemIDs) {
352	$prevID = $id if $id < $problemNumber	742	$prevID = $id if $id < $problemID
353	and (not defined $prevID or $id > $prevID);	743	and (not defined $prevID or $id > $prevID);
354	$nextID = $id if $id > $problemNumber	744	$nextID = $id if $id > $problemID
355	and (not defined $nextID or $id < $nextID);	745	and (not defined $nextID or $id < $nextID);
356	}	746	}
		747	}
		748
		749	my @links;
		750
		751	if ($prevID) {
		752	my $prevPage = $urlpath->newFromModule(__PACKAGE__,
		753	courseID => $courseID, setID => $setID, problemID => $prevID);
		754	push @links, "Previous Problem", $r->location . $prevPage->path, "navPrev";
		755	} else {
357	unshift @links, "Previous Problem" , ($prevID	756	push @links, "Previous Problem", "", "navPrev";
358	? "$root/$courseName/$setName/".$prevID	757	}
359	: "") , "navPrev";	758
		759	push @links, "Problem List", $r->location . $urlpath->parent->path, "navProbList";
		760
		761	if ($nextID) {
		762	my $nextPage = $urlpath->newFromModule(__PACKAGE__,
		763	courseID => $courseID, setID => $setID, problemID => $nextID);
		764	push @links, "Next Problem", $r->location . $nextPage->path, "navNext";
		765	} else {
360	push @links, "Next Problem" , ($nextID	766	push @links, "Next Problem", "", "navNext";
361	? "$root/$courseName/$setName/".$nextID	767	}
362	: "") , "navNext";
363		768
		769	my $tail = "";
		770
		771	$tail .= "&displayMode=".$self->{displayMode} if defined $self->{displayMode};
		772	$tail .= "&showOldAnswers=".$self->{will}->{showOldAnswers}
		773	if defined $self->{will}->{showOldAnswers};
364	my $result = $self->navMacro($args, $tail, @links);	774	return $self->navMacro($args, $tail, @links);
365	$WeBWorK::timer0->continue("end nav subroutine") if $timer0_ON;
366	return $result;
367	}	775	}
368		776
369	sub title {	777	sub title {
370	my $self = shift;	778	my ($self) = @_;
371	my $setName = $self->{set}->set_id;	779
372	my $problemNumber = $self->{problem}->problem_id;	780	# using the url arguments won't break if the set/problem are invalid
		781	my $setID = WeBWorK::ContentGenerator::underscore2nbsp($self->r->urlpath->arg("setID"));
		782	my $problemID = $self->r->urlpath->arg("problemID");
373		783
374	return "$setName : Problem $problemNumber";	784	return "$setID: Problem $problemID";
375	}	785	}
376		786
377	sub body {	787	sub body {
378	my $self = shift;	788	my $self = shift;
		789	my $r = $self->r;
		790	my $ce = $r->ce;
		791	my $db = $r->db;
		792	my $authz = $r->authz;
		793	my $urlpath = $r->urlpath;
		794	my $user = $r->param('user');
		795	my $effectiveUser = $r->param('effectiveUser');
		796
		797	if ($self->{invalidSet}) {
		798	return CGI::div({class=>"ResultsWithError"},
		799	CGI::p("The selected homework set (" . $urlpath->arg("setID") . ") is not a valid set for " . $r->param("effectiveUser") . "."));
		800	}
379		801
380	return CGI::p(CGI::font({-color=>"red"}, "This problem is not available because the problem set that contains it is not yet open."))	802	if ($self->{invalidProblem}) {
		803	return CGI::div({class=>"ResultsWithError"},
		804	CGI::p("The selected problem (" . $urlpath->arg("problemID") . ") is not a valid problem for set " . $self->{set}->set_id . "."));
		805	}
		806
381	unless $self->{isOpen};	807	unless ($self->{isOpen}) {
382		808	return CGI::div({class=>"ResultsWithError"},
		809	CGI::p("This problem is not available because the homework set that contains it is not yet open."));
		810	}
383	# unpack some useful variables	811	# unpack some useful variables
384	my $r = $self->{r};
385	my $db = $self->{db};
386	my $set = $self->{set};	812	my $set = $self->{set};
387	my $problem = $self->{problem};	813	my $problem = $self->{problem};
388	my $editMode = $self->{editMode};	814	my $editMode = $self->{editMode};
389	my $permissionLevel = $self->{permissionLevel};
390	my $submitAnswers = $self->{submitAnswers};	815	my $submitAnswers = $self->{submitAnswers};
391	my $checkAnswers = $self->{checkAnswers};	816	my $checkAnswers = $self->{checkAnswers};
392	my $previewAnswers = $self->{previewAnswers};	817	my $previewAnswers = $self->{previewAnswers};
393	my %want = %{ $self->{want} };	818	my %want = %{ $self->{want} };
394	my %can = %{ $self->{can} };	819	my %can = %{ $self->{can} };
395	my %must = %{ $self->{must} };	820	my %must = %{ $self->{must} };
396	my %will = %{ $self->{will} };	821	my %will = %{ $self->{will} };
397	my $pg = $self->{pg};	822	my $pg = $self->{pg};
398		823
		824	my $courseName = $urlpath->arg("courseID");
		825
		826	# FIXME: move editor link to top, next to problem number.
		827	# format as "[edit]" like we're doing with course info file, etc.
		828	# add edit link for set as well.
		829	my $editorLink = "";
		830	# if we are here without a real problem set, carry that through
		831	my $forced_field = [];
		832	$forced_field = ['sourceFilePath' => $r->param("sourceFilePath")] if
		833	($set->set_id eq 'Undefined_Set');
		834	if ($authz->hasPermissions($user, "modify_problem_sets")) {
		835	my $editorPage = $urlpath->newFromModule("WeBWorK::ContentGenerator::Instructor::PGProblemEditor",
		836	courseID => $courseName, setID => $set->set_id, problemID => $problem->problem_id);
		837	my $editorURL = $self->systemLink($editorPage, params=>$forced_field);
		838	$editorLink = CGI::p(CGI::a({href=>$editorURL,target =>'WW_Editor'}, "Edit this problem"));
		839	}
		840
399	##### translation errors? #####	841	##### translation errors? #####
400		842
401	if ($pg->{flags}->{error_flag}) {	843	if ($pg->{flags}->{error_flag}) {
		844	if ($authz->hasPermissions($user, "view_problem_debugging_info")) {
402	return $self->errorOutput($pg->{errors}, $pg->{body_text});	845	print $self->errorOutput($pg->{errors}, $pg->{body_text});
		846	} else {
		847	print $self->errorOutput($pg->{errors}, "You do not have permission to view the details of this error.");
		848	}
		849	print $editorLink;
		850	return "";
403	}	851	}
404		852
405	##### answer processing #####	853	##### answer processing #####
406	$WeBWorK::timer0->continue("begin answer processing") if $timer0_ON;	854	debug("begin answer processing");
407	# if answers were submitted:	855	# if answers were submitted:
408	my $scoreRecordedMessage;	856	my $scoreRecordedMessage;
		857	my $pureProblem;
409	if ($submitAnswers) {	858	if ($submitAnswers) {
410	# get a "pure" (unmerged) UserProblem to modify	859	# get a "pure" (unmerged) UserProblem to modify
411	# this will be undefined if the problem has not been assigned to this user	860	# this will be undefined if the problem has not been assigned to this user
412	my $pureProblem = $db->getUserProblem($problem->user_id, $problem->set_id, $problem->problem_id);	861	$pureProblem = $db->getUserProblem($problem->user_id, $problem->set_id, $problem->problem_id); # checked
413	if (defined $pureProblem) {	862	if (defined $pureProblem) {
414	# store answers in DB for sticky answers	863	# store answers in DB for sticky answers
415	my %answersToStore;	864	my %answersToStore;
416	my %answerHash = %{ $pg->{answers} };	865	my %answerHash = %{ $pg->{answers} };
417	$answersToStore{$_} = $answerHash{$_}->{original_student_ans}	866	$answersToStore{$_} = $self->{formFields}->{$_} #$answerHash{$_}->{original_student_ans} -- this may have been modified for fields with multiple values. Don't use it!!
418	foreach (keys %answerHash);	867	foreach (keys %answerHash);
		868
		869	# There may be some more answers to store -- one which are auxiliary entries to a primary answer. Evaluating
		870	# matrices works in this way, only the first answer triggers an answer evaluator, the rest are just inputs
		871	# however we need to store them. Fortunately they are still in the input form.
		872	my @extra_answer_names = @{ $pg->{flags}->{KEPT_EXTRA_ANSWERS}};
		873	$answersToStore{$_} = $self->{formFields}->{$_} foreach (@extra_answer_names);
		874
		875	# Now let's encode these answers to store them -- append the extra answers to the end of answer entry order
		876	my @answer_order = (@{$pg->{flags}->{ANSWER_ENTRY_ORDER}}, @extra_answer_names);
419	my $answerString = encodeAnswers(%answersToStore,	877	my $answerString = encodeAnswers(%answersToStore,
420	@{ $pg->{flags}->{ANSWER_ENTRY_ORDER} });	878	@answer_order);
421		879
422	# store last answer to database	880	# store last answer to database
423	$problem->last_answer($answerString);	881	$problem->last_answer($answerString);
424	$pureProblem->last_answer($answerString);	882	$pureProblem->last_answer($answerString);
425	$db->putUserProblem($pureProblem);	883	$db->putUserProblem($pureProblem);
…		…
453	$pureProblem->last_answer."\t".	911	$pureProblem->last_answer."\t".
454	$pureProblem->num_correct."\t".	912	$pureProblem->num_correct."\t".
455	$pureProblem->num_incorrect	913	$pureProblem->num_incorrect
456	);	914	);
457	} else {	915	} else {
458	if (time < $set->open_date or time > $set->due_date) {	916	if (before($set->open_date) or after($set->due_date)) {
459	$scoreRecordedMessage = "Your score was not recorded because this problem set is closed.";	917	$scoreRecordedMessage = "Your score was not recorded because this homework set is closed.";
460	} else {	918	} else {
461	$scoreRecordedMessage = "Your score was not recorded.";	919	$scoreRecordedMessage = "Your score was not recorded.";
462	}	920	}
463	}	921	}
464	} else {	922	} else {
465	$scoreRecordedMessage = "Your score was not recorded because this problem has not been built for you.";	923	$scoreRecordedMessage = "Your score was not recorded because this problem has not been assigned to you.";
466	}	924	}
467	}	925	}
468		926
469	# logging student answers	927	# logging student answers
470	my $pastAnswerLog = undef;	928
471	if (defined( $self->{ce}->{webworkFiles}->{logs}->{'pastAnswerList'} )) {	929	my $answer_log = $self->{ce}->{courseFiles}->{logs}->{'answer_log'};
472	$pastAnswerLog = $self->{ce}->{webworkFiles}->{logs}->{'pastAnswerList'};	930	if ( defined($answer_log ) and defined($pureProblem)) {
473	if ($submitAnswers and defined $pastAnswerLog) {	931	if ($submitAnswers && !$authz->hasPermissions($effectiveUser, "dont_log_past_answers")) {
474	my $answerString = "";	932	my $answerString = ""; my $scores = "";
475	my %answerHash = %{ $pg->{answers} };	933	my %answerHash = %{ $pg->{answers} };
476	$answerString = $answerString . $answerHash{$_}->{original_student_ans}."\t"	934	# FIXME this is the line 552 error. make sure original student ans is defined.
		935	# The fact that it is not defined is probably due to an error in some answer evaluator.
		936	# But I think it is useful to suppress this error message in the log.
477	foreach (sort keys %answerHash);	937	foreach (sortByName(undef, keys %answerHash)) {
		938	my $orig_ans = $answerHash{$_}->{original_student_ans};
		939	my $student_ans = defined $orig_ans ? $orig_ans : '';
		940	$answerString .= $student_ans."\t";
		941	$scores .= $answerHash{$_}->{score} >= 1 ? "1" : "0";
		942	}
478	$answerString = '' unless defined($answerString); # insure string is defined.	943	$answerString = '' unless defined($answerString); # insure string is defined.
479	writeLog($self->{ce}, "pastAnswerList",	944	writeCourseLog($self->{ce}, "answer_log",
		945	join("",
480	'\|'.$problem->user_id.	946	'\|', $problem->user_id,
481	'\|'.$problem->set_id.	947	'\|', $problem->set_id,
482	'\|'.$problem->problem_id.'\|'."\t".	948	'\|', $problem->problem_id,
		949	'\|', $scores, "\t",
483	time()."\t".	950	time(),"\t",
484	$answerString,	951	$answerString,
		952	),
485	);	953	);
486	}	954
487	}	955	}
		956	}
488		957
489	$WeBWorK::timer0->continue("end answer processing") if $timer0_ON;	958	debug("end answer processing");
490		959
491	##### output #####	960	##### output #####
492		961	# custom message for editor
		962	if ($authz->hasPermissions($user, "modify_problem_sets") and defined $editMode) {
		963	if ($editMode eq "temporaryFile") {
		964	print CGI::p(CGI::div({class=>'temporaryFile'}, "Viewing temporary file: ", $problem->source_file));
		965	} elsif ($editMode eq "savedFile") {
		966	# taken care of in the initialization phase
		967	}
		968	}
493	print CGI::start_div({class=>"problemHeader"});	969	print CGI::start_div({class=>"problemHeader"});
494		970
495	# custom message for editor
496	if ($permissionLevel >= 10 and defined $editMode) {
497	if ($editMode eq "temporaryFile") {
498	print CGI::p(CGI::i("Editing temporary file: ", $problem->source_file));
499	} elsif ($editMode eq "savedFile") {
500	print CGI::p(CGI::i("Problem saved to: ", $problem->source_file));
501	}
502	}
503		971
		972
504	# attempt summary	973	# attempt summary
505	if ($submitAnswers or $will{showCorrectAnswers}) {	974	#FIXME -- the following is a kludge: if showPartialCorrectAnswers is negative don't show anything.
		975	# until after the due date
		976	# do I need to check $will{showCorrectAnswers} to make preflight work??
		977	if (($pg->{flags}->{showPartialCorrectAnswers} >= 0 and $submitAnswers) ) {
506	# print this if user submitted answers OR requested correct answers	978	# print this if user submitted answers OR requested correct answers
		979
507	print $self->attemptResults($pg, $submitAnswers,	980	print $self->attemptResults($pg, 1,
508	$will{showCorrectAnswers},	981	$will{showCorrectAnswers},
509	$pg->{flags}->{showPartialCorrectAnswers}, 1, 1);	982	$pg->{flags}->{showPartialCorrectAnswers}, 1, 1);
510	} elsif ($checkAnswers) {	983	} elsif ($checkAnswers) {
511	# print this if user previewed answers	984	# print this if user previewed answers
		985	print CGI::div({class=>'ResultsWithError'},"ANSWERS ONLY CHECKED -- ANSWERS NOT RECORDED"), CGI::br();
512	print $self->attemptResults($pg, 1, 0, 1, 1, 1);	986	print $self->attemptResults($pg, 1, $will{showCorrectAnswers}, 1, 1, 1);
513	# show attempt answers	987	# show attempt answers
514	# don't show correct answers	988	# show correct answers if asked
515	# show attempt results (correctness)	989	# show attempt results (correctness)
516	# don't show attempt previews	990	# show attempt previews
517	} elsif ($previewAnswers) {	991	} elsif ($previewAnswers) {
518	# print this if user previewed answers	992	# print this if user previewed answers
519	print $self->attemptResults($pg, 1, 0, 0, 0, 1);	993	print CGI::div({class=>'ResultsWithError'},"PREVIEW ONLY -- ANSWERS NOT RECORDED"),CGI::br(),$self->attemptResults($pg, 1, 0, 0, 0, 1);
520	# show attempt answers	994	# show attempt answers
521	# don't show correct answers	995	# don't show correct answers
522	# don't show attempt results (correctness)	996	# don't show attempt results (correctness)
523	# show attempt previews	997	# show attempt previews
524	}	998	}
525		999
526	print CGI::end_div();	1000	print CGI::end_div();
527		1001
		1002	# main form
		1003	print CGI::startform("POST", $r->uri);
		1004	print $self->hidden_authen_fields;
		1005
528	print CGI::start_div({class=>"problem"});	1006	print CGI::start_div({class=>"problem"});
529
530	# main form
531	print
532	CGI::startform("POST", $r->uri),
533	$self->hidden_authen_fields,
534	CGI::p($pg->{body_text}),	1007	print CGI::p($pg->{body_text});
535	CGI::p($pg->{result}->{msg} ? CGI::b("Note: ") : "", CGI::i($pg->{result}->{msg})),	1008	print CGI::p(CGI::b("Note: "), CGI::i($pg->{result}->{msg})) if $pg->{result}->{msg};
536	CGI::p(	1009	print $editorLink; # this is empty unless it is appropriate to have an editor link.
537	($can{recordAnswers}	1010	print CGI::end_div();
538	? CGI::submit(-name=>"submitAnswers",	1011
539	-label=>"Submit Answers")	1012	print CGI::start_p();
540	: ""),	1013
541	($can{checkAnswers}	1014	if ($can{showCorrectAnswers}) {
542	? CGI::submit(-name=>"checkAnswers",	1015	print CGI::checkbox(
543	-label=>"Check Answers")	1016	-name => "showCorrectAnswers",
544	: ""),	1017	-checked => $will{showCorrectAnswers},
545	CGI::submit(-name=>"previewAnswers",	1018	-label => "Show correct answers",
546	-label=>"Preview Answers"),
547	);	1019	);
		1020	}
		1021	if ($can{showHints}) {
		1022	print CGI::div({style=>"color:red"},
		1023	CGI::checkbox(
		1024	-name => "showHints",
		1025	-checked => $will{showHints},
		1026	-label => "Show Hints",
		1027	)
		1028	);
		1029	}
		1030	if ($can{showSolutions}) {
		1031	print CGI::checkbox(
		1032	-name => "showSolutions",
		1033	-checked => $will{showSolutions},
		1034	-label => "Show Solutions",
		1035	);
		1036	}
		1037
		1038	if ($can{showCorrectAnswers} or $can{showHints} or $can{showSolutions}) {
		1039	print CGI::br();
		1040	}
		1041
		1042	print CGI::submit(-name=>"previewAnswers", -label=>"Preview Answers");
		1043	if ($can{checkAnswers}) {
		1044	print CGI::submit(-name=>"checkAnswers", -label=>"Check Answers");
		1045	}
		1046	if ($can{getSubmitButton}) {
		1047	if ($user ne $effectiveUser) {
		1048	# if acting as a student, make it clear that answer submissions will
		1049	# apply to the student's records, not the professor's.
		1050	print CGI::submit(-name=>"submitAnswers", -label=>"Submit Answers for $effectiveUser");
		1051	} else {
		1052	print CGI::submit(-name=>"submitAnswers", -label=>"Submit Answers");
		1053	}
		1054	}
		1055
548	print CGI::end_div();	1056	print CGI::end_p();
549		1057
550	print CGI::start_div({class=>"scoreSummary"});	1058	print CGI::start_div({class=>"scoreSummary"});
551		1059
552	# score summary	1060	# score summary
553	my $attempts = $problem->num_correct + $problem->num_incorrect;	1061	my $attempts = $problem->num_correct + $problem->num_incorrect;
554	my $attemptsNoun = $attempts != 1 ? "times" : "time";	1062	my $attemptsNoun = $attempts != 1 ? "times" : "time";
		1063	my $problem_status = $problem->status \|\| 0;
555	my $lastScore = sprintf("%.0f%%", $problem->status * 100); # Round to whole number	1064	my $lastScore = sprintf("%.0f%%", $problem_status * 100); # Round to whole number
556	my ($attemptsLeft, $attemptsLeftNoun);	1065	my ($attemptsLeft, $attemptsLeftNoun);
557	if ($problem->max_attempts == -1) {	1066	if ($problem->max_attempts == -1) {
558	# unlimited attempts	1067	# unlimited attempts
559	$attemptsLeft = "unlimited";	1068	$attemptsLeft = "unlimited";
560	$attemptsLeftNoun = "attempts";	1069	$attemptsLeftNoun = "attempts";
…		…
563	$attemptsLeftNoun = $attemptsLeft == 1 ? "attempt" : "attempts";	1072	$attemptsLeftNoun = $attemptsLeft == 1 ? "attempt" : "attempts";
564	}	1073	}
565		1074
566	my $setClosed = 0;	1075	my $setClosed = 0;
567	my $setClosedMessage;	1076	my $setClosedMessage;
568	if (time < $set->open_date or time > $set->due_date) {	1077	if (before($set->open_date) or after($set->due_date)) {
569	$setClosed = 1;	1078	$setClosed = 1;
		1079	if (before($set->open_date)) {
		1080	$setClosedMessage = "This homework set is not yet open.";
		1081	} elsif (after($set->due_date)) {
570	$setClosedMessage = "This problem set is closed.";	1082	$setClosedMessage = "This homework set is closed.";
571	if ($permissionLevel > 0) {	1083	}
		1084	}
		1085	#if (before($set->open_date) or after($set->due_date)) {
		1086	# $setClosed = 1;
		1087	# $setClosedMessage = "This homework set is closed.";
		1088	# if ($authz->hasPermissions($user, "view_answers")) {
572	$setClosedMessage .= " However, since you are a privileged user, additional attempts will be recorded.";	1089	# $setClosedMessage .= " However, since you are a privileged user, additional attempts will be recorded.";
573	} else {	1090	# } else {
574	$setClosedMessage .= " Additional attempts will not be recorded.";	1091	# $setClosedMessage .= " Additional attempts will not be recorded.";
575	}	1092	# }
576	}	1093	#}
		1094	unless (defined( $pg->{state}->{state_summary_msg}) and $pg->{state}->{state_summary_msg}=~/\S/) {
		1095	my $notCountedMessage = ($problem->value) ? "" : "(This problem will not count towards your grade.)";
577	print CGI::p(	1096	print CGI::p(
578	$submitAnswers ? $scoreRecordedMessage . CGI::br() : "",	1097	$submitAnswers ? $scoreRecordedMessage . CGI::br() : "",
579	"You have attempted this problem $attempts $attemptsNoun.", CGI::br(),	1098	"You have attempted this problem $attempts $attemptsNoun.", CGI::br(),
		1099	$submitAnswers ?"You received a score of ".sprintf("%.0f%%", $pg->{result}->{score} * 100)." for this attempt.".CGI::br():'',
580	$problem->attempted	1100	$problem->attempted
581	? "Your recorded score is $lastScore." . CGI::br()	1101	? "Your overall recorded score is $lastScore. $notCountedMessage" . CGI::br()
582	: "",	1102	: "",
583	$setClosed ? $setClosedMessage : "You have $attemptsLeft $attemptsLeftNoun remaining."	1103	$setClosed ? $setClosedMessage : "You have $attemptsLeft $attemptsLeftNoun remaining."
584	);	1104	);
		1105	}else {
		1106	print CGI::p($pg->{state}->{state_summary_msg});
		1107	}
585	print CGI::end_div();	1108	print CGI::end_div();
586		1109
587	# save state for viewOptions	1110	# save state for viewOptions
588	print CGI::hidden(	1111	print CGI::hidden(
589	-name => "showOldAnswers",	1112	-name => "showOldAnswers",
590	-value => $will{showOldAnswers}	1113	-value => $will{showOldAnswers}
591	),	1114	),
		1115
592	CGI::hidden(	1116	CGI::hidden(
593	-name => "showCorrectAnswers",
594	-value => $will{showCorrectAnswers}
595	),
596	CGI::hidden(
597	-name => "showHints",
598	-value => $will{showHints}),
599	CGI::hidden(
600	-name => "showSolutions",
601	-value => $will{showSolutions},
602	),
603	CGI::hidden(
604	-name => "displayMode",	1117	-name => "displayMode",
605	-value => $self->{displayMode}	1118	-value => $self->{displayMode}
606	);	1119	);
607		1120	print( CGI::hidden(
		1121	-name => 'editMode',
		1122	-value => $self->{editMode},
		1123	)
		1124	) if defined($self->{editMode}) and $self->{editMode} eq 'temporaryFile';
		1125	print( CGI::hidden(
		1126	-name => 'sourceFilePath',
		1127	-value => $self->{problem}->{source_file}
		1128	)) if defined($self->{problem}->{source_file});
		1129
		1130	print( CGI::hidden(
		1131	-name => 'problemSeed',
		1132	-value => $r->param("problemSeed")
		1133	)) if defined($r->param("problemSeed"));
		1134
608	# end of main form	1135	# end of main form
609	print CGI::endform();	1136	print CGI::endform();
610		1137
611	# stuff we need below (pull these out at the beginning?)
612	my $ce = $self->{ce};
613	my $root = $ce->{webworkURLs}->{root};
614	my $courseName = $ce->{courseName};
615
616	print CGI::start_div({class=>"problemFooter"});	1138	print CGI::start_div({class=>"problemFooter"});
617		1139
618	# arguments for answer inspection button	1140	## arguments for answer inspection button
619	my $prof_url = $ce->{webworkURLs}->{oldProf};	1141	#my $prof_url = $ce->{webworkURLs}->{oldProf};
		1142	#my $webworkURL = $ce->{webworkURLs}->{root};
620	my $cgi_url = $prof_url;	1143	#my $cgi_url = $prof_url;
621	$cgi_url=~ s\|/[^/]*$\|\|; # clip profLogin.pl	1144	#$cgi_url=~ s\|/[^/]*$\|\|; # clip profLogin.pl
622	my $authen_args = $self->url_authen_args();	1145	#my $authen_args = $self->url_authen_args();
623	my $showPastAnswersURL = "$cgi_url/showPastAnswers.pl";	1146	#my $showPastAnswersURL = "$webworkURL/$courseName/instructor/show_answers/";
624		1147
		1148	my $pastAnswersPage = $urlpath->newFromModule("WeBWorK::ContentGenerator::Instructor::ShowAnswers",
		1149	courseID => $courseName);
		1150	my $showPastAnswersURL = $self->systemLink($pastAnswersPage, authen => 0); # no authen info for form action
		1151
625	# print answer inspection button	1152	# print answer inspection button
626	if ($self->{permissionLevel} > 0) {	1153	if ($authz->hasPermissions($user, "view_answers")) {
627	print "\n",	1154	print "\n",
628	CGI::start_form(-method=>"POST",-action=>$showPastAnswersURL,-target=>"information"),"\n",	1155	CGI::start_form(-method=>"POST",-action=>$showPastAnswersURL,-target=>"information"),"\n",
629	$self->hidden_authen_fields,"\n",	1156	$self->hidden_authen_fields,"\n",
630	CGI::hidden(-name => 'course', -value=>$courseName), "\n",	1157	CGI::hidden(-name => 'courseID', -value=>$courseName), "\n",
631	CGI::hidden(-name => 'probNum', -value=>$problem->problem_id), "\n",	1158	CGI::hidden(-name => 'problemID', -value=>$problem->problem_id), "\n",
632	CGI::hidden(-name => 'setNum', -value=>$problem->set_id), "\n",	1159	CGI::hidden(-name => 'setID', -value=>$problem->set_id), "\n",
633	CGI::hidden(-name => 'User', -value=>$problem->user_id), "\n",	1160	CGI::hidden(-name => 'studentUser', -value=>$problem->user_id), "\n",
634	CGI::p( {-align=>"left"},	1161	CGI::p( {-align=>"left"},
635	CGI::submit(-name => 'action', -value=>'Show Past Answers')	1162	CGI::submit(-name => 'action', -value=>'Show Past Answers')
636	), "\n",	1163	), "\n",
637	CGI::endform();	1164	CGI::endform();
638	}	1165	}
639		1166
640	#print CGI::end_div();	1167	## feedback form url
		1168	#my $feedbackPage = $urlpath->newFromModule("WeBWorK::ContentGenerator::Feedback",
		1169	# courseID => $courseName);
		1170	#my $feedbackURL = $self->systemLink($feedbackPage, authen => 0); # no authen info for form action
641	#	1171	#
642	#print CGI::start_div();
643
644	# arguments for feedback form
645	my $feedbackURL = "$root/$courseName/feedback/";
646
647	#print feedback form	1172	##print feedback form
648	print	1173	#print
649	CGI::start_form(-method=>"POST", -action=>$feedbackURL),"\n",	1174	# CGI::start_form(-method=>"POST", -action=>$feedbackURL),"\n",
650	$self->hidden_authen_fields,"\n",	1175	# $self->hidden_authen_fields,"\n",
651	CGI::hidden("module", __PACKAGE__),"\n",	1176	# CGI::hidden("module", __PACKAGE__),"\n",
652	CGI::hidden("set", $set->set_id),"\n",	1177	# CGI::hidden("set", $set->set_id),"\n",
653	CGI::hidden("problem", $problem->problem_id),"\n",	1178	# CGI::hidden("problem", $problem->problem_id),"\n",
654	CGI::hidden("displayMode", $self->{displayMode}),"\n",	1179	# CGI::hidden("displayMode", $self->{displayMode}),"\n",
655	CGI::hidden("showOldAnswers", $will{showOldAnswers}),"\n",	1180	# CGI::hidden("showOldAnswers", $will{showOldAnswers}),"\n",
656	CGI::hidden("showCorrectAnswers", $will{showCorrectAnswers}),"\n",	1181	# CGI::hidden("showCorrectAnswers", $will{showCorrectAnswers}),"\n",
657	CGI::hidden("showHints", $will{showHints}),"\n",	1182	# CGI::hidden("showHints", $will{showHints}),"\n",
658	CGI::hidden("showSolutions", $will{showSolutions}),"\n",	1183	# CGI::hidden("showSolutions", $will{showSolutions}),"\n",
659	CGI::p({-align=>"left"},	1184	# CGI::p({-align=>"left"},
660	CGI::submit(-name=>"feedbackForm", -label=>"Contact instructor")	1185	# CGI::submit(-name=>"feedbackForm", -label=>"Email instructor")
661	),	1186	# ),
662	CGI::endform(),"\n";	1187	# CGI::endform(),"\n";
663		1188
664	# FIXME print editor link	1189	print $self->feedbackMacro(
665	# print editor link if the user is an instructor AND the file is not in temporary editing mode	1190	module => __PACKAGE__,
666	if ($self->{permissionLevel}>=10 and ( (not defined($self->{edit_mode})) or $self->{edit_mode} eq 'savedFile') ) {	1191	set => $self->{set}->set_id,
667	print CGI::a({-href=>$ce->{webworkURLs}->{root}."/$courseName/instructor/pgProblemEditor/".$set->set_id.	1192	problem => $problem->problem_id,
668	'/'.$problem->problem_id.'?'.$self->url_authen_args},'Edit this problem');	1193	displayMode => $self->{displayMode},
669	}	1194	showOldAnswers => $will{showOldAnswers},
		1195	showCorrectAnswers => $will{showCorrectAnswers},
		1196	showHints => $will{showHints},
		1197	showSolutions => $will{showSolutions},
		1198	);
670		1199
671	print CGI::end_div();	1200	print CGI::end_div();
672
673	# warning output
674	#if ($pg->{warnings} ne "") {
675	# print CGI::hr(), $self->warningOutput($pg->{warnings});
676	#}
677		1201
678	# debugging stuff	1202	# debugging stuff
679	if (0) {	1203	if (0) {
680	print	1204	print
681	CGI::hr(),	1205	CGI::hr(),
…		…
693	}	1217	}
694		1218
695	return "";	1219	return "";
696	}	1220	}
697		1221
698	##### output utilities #####
699
700	sub attemptResults($$$$$$) {
701	my $self = shift;
702	my $pg = shift;
703	my $showAttemptAnswers = shift;
704	my $showCorrectAnswers = shift;
705	my $showAttemptResults = $showAttemptAnswers && shift;
706	my $showSummary = shift;
707	my $showAttemptPreview = shift \|\| 0;
708	my $ce = $self->{ce};
709	my $problemResult = $pg->{result}; # the overall result of the problem
710	my @answerNames = @{ $pg->{flags}->{ANSWER_ENTRY_ORDER} };
711
712	my $showMessages = $showAttemptAnswers && grep { $pg->{answers}->{$_}->{ans_message} } @answerNames;
713
714	my $basename = "equation-" . $self->{set}->psvn. "." . $self->{problem}->problem_id . "-preview";
715	my $imgGen = WeBWorK::PG::ImageGenerator->new(
716	tempDir => $ce->{webworkDirs}->{tmp},
717	dir => $ce->{courseDirs}->{html_temp},
718	url => $ce->{courseURLs}->{html_temp},
719	basename => $basename,
720	latex => $ce->{externalPrograms}->{latex},
721	dvipng => $ce->{externalPrograms}->{dvipng},
722	);
723
724	my $header;
725	#$header .= CGI::th("Part");
726	$header .= $showAttemptAnswers ? CGI::th("Entered") : "";
727	$header .= $showAttemptPreview ? CGI::th("Answer Preview") : "";
728	$header .= $showCorrectAnswers ? CGI::th("Correct") : "";
729	$header .= $showAttemptResults ? CGI::th("Result") : "";
730	$header .= $showMessages ? CGI::th("messages") : "";
731	my @tableRows = ( $header );
732	my $numCorrect;
733	foreach my $name (@answerNames) {
734	my $answerResult = $pg->{answers}->{$name};
735	my $studentAnswer = $answerResult->{student_ans}; # original_student_ans
736	my $preview = ($showAttemptPreview
737	? $self->previewAnswer($answerResult, $imgGen)
738	: "");
739	my $correctAnswer = $answerResult->{correct_ans};
740	my $answerScore = $answerResult->{score};
741	my $answerMessage = $showMessages ? $answerResult->{ans_message} : "";
742
743	$numCorrect += $answerScore > 0;
744	my $resultString = $answerScore ? "correct" : "incorrect";
745
746	# get rid of the goofy prefix on the answer names (supposedly, the format
747	# of the answer names is changeable. this only fixes it for "AnSwEr"
748	$name =~ s/^AnSwEr//;
749
750	my $row;
751	#$row .= CGI::td($name);
752	$row .= $showAttemptAnswers ? CGI::td(nbsp($studentAnswer)) : "";
753	$row .= $showAttemptPreview ? CGI::td(nbsp($preview)) : "";
754	$row .= $showCorrectAnswers ? CGI::td(nbsp($correctAnswer)) : "";
755	$row .= $showAttemptResults ? CGI::td(nbsp($resultString)) : "";
756	$row .= $answerMessage ? CGI::td(nbsp($answerMessage)) : "";
757	push @tableRows, $row;
758	}
759
760	# render equation images
761	$imgGen->render(refresh => 1);
762
763	my $numIncorrectNoun = scalar @answerNames == 1 ? "question" : "questions";
764	my $scorePercent = sprintf("%.0f%%", $problemResult->{score} * 100);
765	my $summary = "On this attempt, you answered $numCorrect out of "
766	. scalar @answerNames . " $numIncorrectNoun correct, for a score of $scorePercent.";
767	return CGI::table({-class=>"attemptResults"}, CGI::Tr(\@tableRows)) . ($showSummary ? CGI::p({class=>'emphasis'},$summary) : "");
768	}
769	sub nbsp {
770	my $str = shift;
771	($str eq '') ? ' ' : $str ; # returns non-breaking space for empty strings
772	}
773	sub viewOptions($) {
774	my $self = shift;
775	my $displayMode = $self->{displayMode};
776	my %must = %{ $self->{must} };
777	my %can = %{ $self->{can} };
778	my %will = %{ $self->{will} };
779
780	my $optionLine;
781	$can{showOldAnswers} and $optionLine .= join "",
782	"Show:  ".CGI::br(),
783	CGI::checkbox(
784	-name => "showOldAnswers",
785	-checked => $will{showOldAnswers},
786	-label => "Saved answers",
787	), "  ".CGI::br();
788	$can{showCorrectAnswers} and $optionLine .= join "",
789	CGI::checkbox(
790	-name => "showCorrectAnswers",
791	-checked => $will{showCorrectAnswers},
792	-label => "Correct answers",
793	), "  ".CGI::br();
794	$can{showHints} and $optionLine .= join "",
795	CGI::checkbox(
796	-name => "showHints",
797	-checked => $will{showHints},
798	-label => "Hints",
799	), "  ".CGI::br();
800	$can{showSolutions} and $optionLine .= join "",
801	CGI::checkbox(
802	-name => "showSolutions",
803	-checked => $will{showSolutions},
804	-label => "Solutions",
805	), "  ".CGI::br();
806	$optionLine and $optionLine .= join "", CGI::br();
807
808	return CGI::div({-style=>"border: thin groove; padding: 1ex; margin: 2ex align: left"},
809	"View equations as:    ".CGI::br(),
810	CGI::radio_group(
811	-name => "displayMode",
812	-values => ['plainText', 'formattedText', 'images'],
813	-default => $displayMode,
814	-linebreak=>'true',
815	-labels => {
816	plainText => "plain",
817	formattedText => "formatted",
818	images => "images",
819	}
820	), CGI::br(),CGI::hr(),
821	$optionLine,
822	CGI::submit(-name=>"redisplay", -label=>"Save Options"),
823	);
824	}
825
826	sub previewAnswer($$) {
827	my ($self, $answerResult, $imgGen) = @_;
828	my $ce = $self->{ce};
829	my $effectiveUser = $self->{effectiveUser};
830	my $set = $self->{set};
831	my $problem = $self->{problem};
832	my $displayMode = $self->{displayMode};
833
834	# note: right now, we have to do things completely differently when we are
835	# rendering math from INSIDE the translator and from OUTSIDE the translator.
836	# so we'll just deal with each case explicitly here. there's some code
837	# duplication that can be dealt with later by abstracting out tth/dvipng/etc.
838
839	my $tex = $answerResult->{preview_latex_string};
840
841	return "" unless defined $tex and $tex ne "";
842
843	if ($displayMode eq "plainText") {
844	return $tex;
845	} elsif ($displayMode eq "formattedText") {
846	my $tthCommand = $ce->{externalPrograms}->{tth}
847	. " -L -f5 -r 2> /dev/null <<END_OF_INPUT; echo > /dev/null\n"
848	. "\$".$tex."\$\n"
849	. "END_OF_INPUT\n";
850
851	# call tth
852	my $result = `$tthCommand`;
853	if ($?) {
854	return "<b>[tth failed: $? $@]</b>";
855	}
856	return $result;
857	} elsif ($displayMode eq "images") {
858	## how are we going to name this?
859	#my $targetPathCommon = "/m2i/"
860	# . $effectiveUser->user_id . "."
861	# . $set->set_id . "."
862	# . $problem->problem_id . "."
863	# . $answerResult->{ans_name} . ".png";
864	#
865	## figure out where to put things
866	#my $wd = makeTempDirectory($ce->{courseDirs}->{html_temp}, "webwork-dvipng");
867	#my $latex = $ce->{externalPrograms}->{latex};
868	#my $dvipng = $ce->{externalPrograms}->{dvipng};
869	#my $targetPath = $ce->{courseDirs}->{html_temp} . $targetPathCommon;
870	# # should use surePathToTmpFile, but we have to
871	# # isolate it from the problem enivronment first
872	#my $targetURL = $ce->{courseURLs}->{html_temp} . $targetPathCommon;
873	#
874	## call dvipng to generate a preview
875	#dvipng($wd, $latex, $dvipng, $tex, $targetPath);
876	#rmtree($wd, 0, 0);
877	#if (-e $targetPath) {
878	# return "<img src=\"$targetURL\" alt=\"$tex\" />";
879	#} else {
880	# return "<b>[math2img failed]</b>";
881	#}
882	$imgGen->add($answerResult->{preview_latex_string});
883
884	}
885	}
886
887	##### logging subroutine ####
888
889
890
891	##### permission queries #####
892
893	# this stuff should be abstracted out into the permissions system
894	# however, the permission system only knows about things in the
895	# course environment and the username. hmmm...
896
897	# also, i should fix these so that they have a consistent calling
898	# format -- perhaps:
899	# canPERM($courseEnv, $user, $set, $problem, $permissionLevel)
900
901	sub canShowCorrectAnswers($$) {
902	my ($permissionLevel, $answerDate) = @_;
903	return $permissionLevel > 0 \|\| time > $answerDate;
904	}
905
906	sub canShowSolutions($$) {
907	my ($permissionLevel, $answerDate) = @_;
908	return canShowCorrectAnswers($permissionLevel, $answerDate);
909	}
910
911	sub canRecordAnswers($$$$$) {
912	my ($permissionLevel, $openDate, $dueDate, $maxAttempts, $attempts) = @_;
913	my $permHigh = $permissionLevel > 0;
914	my $timeOK = time >= $openDate && time <= $dueDate;
915	my $attemptsOK = $maxAttempts == -1 \|\| $attempts <= $maxAttempts;
916	my $recordAnswers = $permHigh \|\| ($timeOK && $attemptsOK);
917	return $recordAnswers;
918	}
919
920	sub canCheckAnswers($$) {
921	my ($permissionLevel, $answerDate) = @_;
922	my $permHigh = $permissionLevel > 0;
923	my $timeOK = time >= $answerDate;
924	my $recordAnswers = $permHigh \|\| $timeOK;
925	return $recordAnswers;
926	}
927
928	sub mustRecordAnswers($) {
929	my ($permissionLevel) = @_;
930	return $permissionLevel == 0;
931	}
932
933	1;	1222	1;

 Legend:



Removed from v.1364
 


changed lines


 
Added in v.4031
 Legend:



Removed from v.1364
 


changed lines


 
Added in v.4031
-Removed from v.1364
+Added in v.4031

aubreyja at gmail dot com	ViewVC Help
Powered by ViewVC 1.0.9