#!/usr/local/bin/perl -w # Copyright (C) 2001 Michael Gage package WebworkWebservice::RenderProblem; use WebworkWebservice; use base qw(WebworkWebservice); BEGIN { $main::VERSION = "2.1"; } use strict; use sigtrap; use Carp; use Safe; use Apache; use WeBWorK::CourseEnvironment; use WeBWorK::PG::Translator; use WeBWorK::PG::Local; use WeBWorK::DB; use WeBWorK::DB::Record; use WeBWorK::DB::Record::UserProblem; use WeBWorK::Constants; use WeBWorK::Utils qw(runtime_use formatDateTime makeTempDirectory); use WeBWorK::DB::Utils qw(global2user user2global findDefaults); use WeBWorK::Utils::Tasks qw(fake_set fake_problem); use WeBWorK::PG::IO; use WeBWorK::PG::ImageGenerator; use Benchmark; use MIME::Base64 qw( encode_base64 decode_base64); #print "rereading Webwork\n"; our $WW_DIRECTORY = $WebworkWebservice::WW_DIRECTORY; our $PG_DIRECTORY = $WebworkWebservice::PG_DIRECTORY; our $COURSENAME = $WebworkWebservice::COURSENAME; our $HOST_NAME = $WebworkWebservice::HOST_NAME; our $HOSTURL ="http://$HOST_NAME:8002"; #FIXME our $ce =$WebworkWebservice::SeedCE; # create a local course environment for some course $ce = WeBWorK::CourseEnvironment->new($WW_DIRECTORY, "", "", $COURSENAME); #print "\$ce = \n", WeBWorK::Utils::pretty_print_rh($ce); print "webwork is really ready\n\n"; #other services # File variables #our $WARNINGS=''; # imported constants my $COURSE_TEMP_DIRECTORY = $ce->{courseDirs}->{html_tmp}; my $COURSE_TEMP_URL = $HOSTURL.$ce->{courseURLs}->{html_tmp}; my $pgMacrosDirectory = $ce->{pg_dir}.'/macros/'; my $macroDirectory = $ce->{courseDirs}->{macros}.'/'; my $templateDirectory = $ce->{courseDirs}->{templates}; my %PG_environment = $ce->{pg}->{specialPGEnvironmentVars}; use constant DISPLAY_MODES => { # display name # mode name tex => "TeX", plainText => "HTML", formattedText => "HTML_tth", images => "HTML_dpng", jsMath => "HTML_jsMath", asciimath => "HTML_asciimath", }; use constant DISPLAY_MODE_FAILOVER => { TeX => [], HTML => [], HTML_tth => [ "HTML", ], HTML_dpng => [ "HTML_tth", "HTML", ], HTML_jsMath => [ "HTML_dpng", "HTML_tth", "HTML", ], HTML_asciimath => [ "HTML_dpng", "HTML_tth", "HTML", ], # legacy modes -- these are not supported, but some problems might try to # set the display mode to one of these values manually and some macros may # provide rendered versions for these modes but not the one we want. Latex2HTML => [ "TeX", "HTML", ], HTML_img => [ "HTML_dpng", "HTML_tth", "HTML", ], }; sub renderProblem { my $rh = shift; ########################################### # Grab the course name, if this request is going to depend on # some course other than the default course ########################################### my $courseName; my $ce; my $db; my $user; my $beginTime = new Benchmark; if (defined($rh->{course}) and $rh->{course}=~/\S/ ) { $courseName = $rh->{course}; } else { $courseName = $COURSENAME; # use the default $ce } #FIXME put in check to make sure the course exists. eval { $ce = WeBWorK::CourseEnvironment->new($WW_DIRECTORY, "", "", $courseName); # Create database object for this course $db = WeBWorK::DB->new($ce->{dbLayout}); }; $ce->{pg}->{options}->{catchWarnings}; #^FIXME need better way of determining whether the course actually exists. if ($@) { $ce = WeBWorK::CourseEnvironment->new($WW_DIRECTORY, "", "", $COURSENAME); $db = WeBWorK::DB->new($ce->{dbLayout}); } my $user = $rh->{user}; $user = 'gage' unless defined $user and $user =~/\S/; ########################################### # Authenticate this request ########################################### ########################################### # Determine the authorization level (permissions) ########################################### ########################################### # Determine the method for accessing data ########################################### my $problem_source_access = $rh->{problem_source_access}; # One of # source_from_course_set_problem # source_from_source_file_path # source_from_request my $data_access = $rh->{data_access}; # One of # data_from_course # data_from_request ########################################### # Determine an effective user for this interaction # or create one if it is not given # In order: use effectiveUserName, studentLogin, or user or 'foobar' ########################################### my $effectiveUserName; if (defined($rh->{effectiveUser}) and $rh->{effectiveUser}=~/\S/ ) { $effectiveUserName = $rh->{effectiveUser}; } elsif (defined($rh->{envir}->{studentLogin}) and $rh->{envir}->{studentLogin}=~/\S/ ) { $effectiveUserName = $rh->{envir}->{studentLogin}; } elsif (defined($user) and $user =~ /\S/ ) { $effectiveUserName = $user; } else { $effectiveUserName = 'foobar'; } ################################################## my $effectiveUser = $db->getUser($effectiveUserName); # checked my $effectiveUserPermissionLevel; my $effectiveUserPassword; unless (defined $effectiveUser ) { $effectiveUser = $db->newUser; $effectiveUserPermissionLevel = $db->newPermissionLevel; $effectiveUserPassword = $db->newPassword; $effectiveUser->user_id($effectiveUserName); $effectiveUserPermissionLevel->user_id($effectiveUserName); $effectiveUserPassword->user_id($effectiveUserName); $effectiveUserPassword->password(''); $effectiveUser->last_name($rh->{envir}->{studentName}|| 'foobar'); $effectiveUser->first_name(''); $effectiveUser->student_id($rh->{envir}->{studentID}|| 'foobar'); $effectiveUser->email_address($rh->{envir}->{email}|| ''); $effectiveUser->section($rh->{envir}->{section} ||''); $effectiveUser->recitation($rh->{envir}->{recitation} ||''); $effectiveUser->comment(''); $effectiveUser->status('C'); $effectiveUser->password($rh->{envir}->{studentID}|| 'foobar'); $effectiveUserPermissionLevel->permission(0); } #FIXME these will fail if the keys are not defined within the environment. ########################################### # Insure that set and problem are defined # Define the set and problem information from # data in the environment if necessary ########################################### # determine the set name and the set problem number my $setName = (defined($rh->{envir}->{setNumber}) ) ? $rh->{envir}->{setNumber} : ''; my $problemNumber = (defined($rh->{envir}->{probNum}) ) ? $rh->{envir}->{probNum} : 1 ; my $problemSeed = (defined($rh->{envir}->{problemSeed})) ? $rh->{envir}->{problemSeed} : 1 ; my $psvn = (defined($rh->{envir}->{psvn}) ) ? $rh->{envir}->{psvn} : 1234 ; my $problemStatus = $rh->{problem_state}->{recorded_score}|| 0 ; my $problemValue = (defined($rh->{envir}->{problemValue})) ? $rh->{envir}->{problemValue} : 1 ; my $num_correct = $rh->{problem_state}->{num_correct} || 0 ; my $num_incorrect = $rh->{problem_state}->{num_incorrect} || 0 ; my $problemAttempted = ($num_correct && $num_incorrect); my $lastAnswer = ''; my $setRecord = $db->getMergedSet($effectiveUserName, $setName); unless (defined($setRecord) and ref($setRecord) ) { # if a User Set does not exist for this user and this set # then we check the Global Set # if that does not exist we create a fake set # if it does, we add fake user data my $userSetClass = $db->{set_user}->{record}; my $globalSet = $db->getGlobalSet($setName); # checked if (not defined $globalSet) { $setRecord = fake_set($db); } else { $setRecord = global2user($userSetClass, $globalSet); } # initializations $setRecord->set_id($setName); $setRecord->set_header(""); $setRecord->hardcopy_header(""); $setRecord->open_date(time()-60*60*24*7); # one week ago $setRecord->due_date(time()+60*60*24*7*2); # in two weeks $setRecord->answer_date(time()+60*60*24*7*3); # in three weeks $setRecord->psvn($rh->{envir}->{psvn}||0); } #warn "set Record is $setRecord"; # obtain the merged problem for $effectiveUser my $problemRecord = $db->getMergedProblem($effectiveUserName, $setName, $problemNumber); # if that is not yet defined obtain the global problem, # convert it to a user problem, and add fake user data unless (defined $problemRecord) { my $userProblemClass = $db->{problem_user}->{record}; my $globalProblem = $db->getGlobalProblem($setName, $problemNumber); # checked # if the global problem doesn't exist either, bail! if(not defined $globalProblem) { $problemRecord = fake_problem($db); } else { $problemRecord = global2user($userProblemClass, $globalProblem); } # initializations $problemRecord->user_id($effectiveUserName); $problemRecord->problem_id($problemNumber); $problemRecord->set_id($setName); $problemRecord->problem_seed($problemSeed); $problemRecord->status($problemStatus); $problemRecord->value($problemValue); $problemRecord->attempted($problemAttempted); $problemRecord->last_answer($lastAnswer); $problemRecord->num_correct($num_correct); $problemRecord->num_incorrect($num_incorrect); } # initialize problem source my $problem_source; my $r_problem_source =undef; if (defined($rh->{source})) { $problem_source = decode_base64($rh->{source}); $problem_source =~ tr /\r/\n/; $r_problem_source =\$problem_source; $problemRecord->source_file($rh->{envir}->{fileName}) if defined $rh->{envir}->{fileName}; } elsif (defined($rh->{sourceFilePath}) and $rh->{sourceFilePath} =/\S/) { $problemRecord->source_file($rh->{sourceFilePath}); } $problemRecord->source_file('foobar') unless defined($problemRecord->source_file); #warn "problem Record is $problemRecord"; # now we're sure we have valid UserSet and UserProblem objects # yay! ################################################## # Other initializations ################################################## my $translationOptions = { displayMode => $rh->{envir}->{displayMode}, showHints => $rh->{envir}->{showHints}, showSolutions => $rh->{envir}->{showSolutions}, refreshMath2img => $rh->{envir}->{showHints} || $rh->{envir}->{showSolutions}, processAnswers => 1, # methods for supplying the source, r_source => $r_problem_source, # reference to a source file string. # if reference is not defined then the path is obtained # from the problem object. r_envirOverrides => $rh, }; my $formFields = $rh->{envir}->{inputs_ref}; my $key = $rh->{envir}->{key} || ''; #check definitions #warn "setRecord is ", WebworkWebservice::pretty_print_rh($setRecord); #warn "problemRecord is",WebworkWebservice::pretty_print_rh($problemRecord); # warn "envir is\n ",WebworkWebservice::pretty_print_rh(__PACKAGE__->defineProblemEnvir( # $ce, # $effectiveUser, # $key, # $setRecord, # $problemRecord, # $psvn, # $formFields, # $translationOptions, # )); ################################################# # Other options can be over ridden by modifying # $ce->{pg} # We'll try to use this code instead so that Local does all of the work. # Most of the configuration will take place in the fake course associated # with XMLRPC responses # problem needs to be loaded with the following: # source_file # status # num_correct # num_incorrect # it doesn't seem that $effectiveUser, $set or $key is used in the subroutine # except that it is passed on to defineProblemEnvironment my $pg; $pg = WebworkWebservice::RenderProblem->new( $ce, $effectiveUser, $key, $setRecord, $problemRecord, $setRecord->psvn, # FIXME: this field should be removed $formFields, # translation options $translationOptions, ); # new version of output: my $out2 = { text => encode_base64( $pg->{body_text} ), header_text => encode_base64( $pg->{head_text} ), answers => $pg->{answers}, errors => $pg->{errors}, WARNINGS => encode_base64($pg->{warnings} ), problem_result => $pg->{result}, problem_state => $pg->{state}, #PG_flag => $pg->{flags}, }; # Hack to filter out CODE references foreach my $ans (keys %{$out2->{answers}}) { foreach my $item (keys %{$out2->{answers}->{$ans}}) { my $contents = $out2->{answers}->{$ans}->{$item}; if (ref($contents) =~ /CODE/ ) { #warn "removing code at $ans $item "; $out2->{answers}->{$ans}->{$item} = undef; } } } $out2->{PG_flag}->{PROBLEM_GRADER_TO_USE} = undef; my $endTime = new Benchmark; $out2->{compute_time} = logTimingInfo($beginTime, $endTime); # warn "flags are" , WebworkWebservice::pretty_print_rh($pg->{flags}); $out2; } sub logTimingInfo{ my ($beginTime,$endTime,) = @_; my $out = ""; $out .= Benchmark::timestr( Benchmark::timediff($endTime , $beginTime) ); $out; } ###################################################################### sub new { shift; # throw away invocant -- we don't need it my ($ce, $user, $key, $set, $problem, $psvn, $formFields, $translationOptions) = @_; #my $renderer = 'WeBWorK::PG::Local'; my $renderer = $ce->{pg}->{renderer}; runtime_use $renderer; # the idea is to have Local call back to the defineProblemEnvir below. #return WeBWorK::PG::Local::new($renderer,@_); return $renderer->new(@_); } #FIXME # Save these subroutines. # I'd like to use this version of defineProblemEnvir instead of the # the version in PG.pm That adds flexibility. # sub translateDisplayModeNames($) { # my $name = shift; # return DISPLAY_MODES()->{$name}; # } # sub defineProblemEnvir { # my ( # $self, # $ce, # $user, # $key, # $set, # $problem, # $psvn, # $formFields, # $options, # ) = @_; # # my %envir; # # # ---------------------------------------------------------------------- # # # PG environment variables # # from docs/pglanguage/pgreference/environmentvariables as of 06/25/2002 # # any changes are noted by "ADDED:" or "REMOVED:" # # # Vital state information # # ADDED: displayModeFailover, displayHintsQ, displaySolutionsQ, # # refreshMath2img, texDisposition # # $envir{psvn} = $set->psvn; # $envir{psvnNumber} = $envir{psvn}; # $envir{probNum} = $problem->problem_id; # $envir{questionNumber} = $envir{probNum}; # $envir{fileName} = $problem->source_file; # $envir{probFileName} = $envir{fileName}; # $envir{problemSeed} = $problem->problem_seed; # $envir{displayMode} = translateDisplayModeNames($options->{displayMode}); # $envir{languageMode} = $envir{displayMode}; # $envir{outputMode} = $envir{displayMode}; # $envir{displayHintsQ} = $options->{showHints}; # $envir{displaySolutionsQ} = $options->{showSolutions}; # $envir{texDisposition} = "pdf"; # in webwork2, we use pdflatex # # # Problem Information # # ADDED: courseName, formatedDueDate # # $envir{openDate} = $set->open_date; # $envir{formattedOpenDate} = formatDateTime($envir{openDate}, $ce->{siteDefaults}{timezone}); # $envir{dueDate} = $set->due_date; # $envir{formattedDueDate} = formatDateTime($envir{dueDate}, $ce->{siteDefaults}{timezone}); # $envir{formatedDueDate} = $envir{formattedDueDate}; # typo in many header files # $envir{answerDate} = $set->answer_date; # $envir{formattedAnswerDate} = formatDateTime($envir{answerDate}, $ce->{siteDefaults}{timezone}); # $envir{numOfAttempts} = ($problem->num_correct || 0) + ($problem->num_incorrect || 0); # $envir{problemValue} = $problem->value; # $envir{sessionKey} = $key; # $envir{courseName} = $ce->{courseName}; # # # Student Information # # ADDED: studentID # # $envir{sectionName} = $user->section; # $envir{sectionNumber} = $envir{sectionName}; # $envir{recitationName} = $user->recitation; # $envir{recitationNumber} = $envir{recitationName}; # $envir{setNumber} = $set->set_id; # $envir{studentLogin} = $user->user_id; # $envir{studentName} = $user->first_name . " " . $user->last_name; # $envir{studentID} = $user->student_id; # # # Answer Information # # REMOVED: refSubmittedAnswers # # $envir{inputs_ref} = $formFields; # # # External Programs # # ADDED: externalLaTeXPath, externalDvipngPath, # # externalGif2EpsPath, externalPng2EpsPath # # $envir{externalTTHPath} = $ce->{externalPrograms}->{tth}; # $envir{externalLaTeXPath} = $ce->{externalPrograms}->{latex}; # $envir{externalDvipngPath} = $ce->{externalPrograms}->{dvipng}; # $envir{externalGif2EpsPath} = $ce->{externalPrograms}->{gif2eps}; # $envir{externalPng2EpsPath} = $ce->{externalPrograms}->{png2eps}; # $envir{externalGif2PngPath} = $ce->{externalPrograms}->{gif2png}; # # # Directories and URLs # # REMOVED: courseName # # ADDED: dvipngTempDir # # ADDED: jsMathURL # # ADDED: asciimathURL # # $envir{cgiDirectory} = undef; # $envir{cgiURL} = undef; # $envir{classDirectory} = undef; # $envir{courseScriptsDirectory} = $ce->{pg}->{directories}->{macros}."/"; # $envir{htmlDirectory} = $ce->{courseDirs}->{html}."/"; # $envir{htmlURL} = $ce->{courseURLs}->{html}."/"; # $envir{macroDirectory} = $ce->{courseDirs}->{macros}."/"; # $envir{templateDirectory} = $ce->{courseDirs}->{templates}."/"; # $envir{tempDirectory} = $ce->{courseDirs}->{html_temp}."/"; # $envir{tempURL} = $ce->{courseURLs}->{html_temp}."/"; # $envir{scriptDirectory} = undef; # $envir{webworkDocsURL} = $ce->{webworkURLs}->{docs}."/"; # $envir{localHelpURL} = $ce->{webworkURLs}->{local_help}."/"; # $envir{jsMathURL} = $ce->{webworkURLs}->{jsMath}; # $envir{asciimathURL} = $ce->{webworkURLs}->{asciimath}; # # # Information for sending mail # # $envir{mailSmtpServer} = $ce->{mail}->{smtpServer}; # $envir{mailSmtpSender} = $ce->{mail}->{smtpSender}; # $envir{ALLOW_MAIL_TO} = $ce->{mail}->{allowedRecipients}; # # # Default values for evaluating answers # # my $ansEvalDefaults = $ce->{pg}->{ansEvalDefaults}; # $envir{$_} = $ansEvalDefaults->{$_} foreach (keys %$ansEvalDefaults); # # # ---------------------------------------------------------------------- # # my $basename = "equation-$envir{psvn}.$envir{probNum}"; # $basename .= ".$envir{problemSeed}" if $envir{problemSeed}; # # # to make grabbing these options easier, we'll pull them out now... # my %imagesModeOptions = %{$ce->{pg}->{displayModeOptions}->{images}}; # # # Object for generating equation images # $envir{imagegen} = WeBWorK::PG::ImageGenerator->new( # tempDir => $ce->{webworkDirs}->{tmp}, # global temp dir # latex => $envir{externalLaTeXPath}, # dvipng => $envir{externalDvipngPath}, # useCache => 1, # cacheDir => $ce->{webworkDirs}->{equationCache}, # cacheURL => $ce->{webworkURLs}->{equationCache}, # cacheDB => $ce->{webworkFiles}->{equationCacheDB}, # useMarkers => ($imagesModeOptions{dvipng_align} && $imagesModeOptions{dvipng_align} eq 'mysql'), # dvipng_align => $imagesModeOptions{dvipng_align}, # dvipng_depth_db => $imagesModeOptions{dvipng_depth_db}, # ); # # # ADDED: jsMath options # $envir{jsMath} = {%{$ce->{pg}{displayModeOptions}{jsMath}}}; # # # Other things... # $envir{QUIZ_PREFIX} = $options->{QUIZ_PREFIX}; # used by quizzes # $envir{PROBLEM_GRADER_TO_USE} = $ce->{pg}->{options}->{grader}; # $envir{PRINT_FILE_NAMES_FOR} = $ce->{pg}->{specialPGEnvironmentVars}->{PRINT_FILE_NAMES_FOR}; # # # ADDED: __files__ # # an array for mapping (eval nnn) to filenames in error messages # $envir{__files__} = { # root => $ce->{webworkDirs}{root}, # used to shorten filenames # pg => $ce->{pg}{directories}{root}, # ditto # tmpl => $ce->{courseDirs}{templates}, # ditto # }; # # # variables for interpreting capa problems and other things to be # # seen in a pg file # my $specialPGEnvironmentVarHash = $ce->{pg}->{specialPGEnvironmentVars}; # for my $SPGEV (keys %{$specialPGEnvironmentVarHash}) { # $envir{$SPGEV} = $specialPGEnvironmentVarHash->{$SPGEV}; # } # # return \%envir; # } 1;