Menu
▾
▴
[WWcvs] webwork2: factored code from renderProblem.pl and renderViaXMLRPC.pm into this file
|
From: Mike G. v. a. <we...@ma...> - 2010-06-08 12:11:02
|
Log Message:
-----------
factored code from renderProblem.pl and renderViaXMLRPC.pm into this
file
Added Files:
-----------
webwork2/lib:
WebworkClient.pm
Revision Data
-------------
--- /dev/null
+++ lib/WebworkClient.pm
@@ -0,0 +1,399 @@
+#!/usr/bin/perl -w
+
+################################################################################
+# WeBWorK Online Homework Delivery System
+# Copyright © 2000-2007 The WeBWorK Project, http://openwebwork.sf.net/
+# $CVSHeader: webwork2/lib/WebworkClient.pm,v 1.1 2010/06/08 11:46:38 gage Exp $
+#
+# This program is free software; you can redistribute it and/or modify it under
+# the terms of either: (a) the GNU General Public License as published by the
+# Free Software Foundation; either version 2, or (at your option) any later
+# version, or (b) the "Artistic License" which comes with this package.
+#
+# This program is distributed in the hope that it will be useful, but WITHOUT
+# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+# FOR A PARTICULAR PURPOSE. See either the GNU General Public License or the
+# Artistic License for more details.
+################################################################################
+
+=head1 NAME
+
+webwork2/clients/WebworkClient.pm
+
+This script will take a file and send it to a WeBWorK daemon webservice
+to have it rendered. The result is split into the basic HTML rendering
+and evaluation of answers and then passed to a browser for printing.
+
+The formatting allows the browser presentation to be interactive with the
+daemon running the script webwork2/lib/renderViaXMLRPC.pm
+
+Rembember to configure the local output file and display command !!!!!!!!
+
+=cut
+
+use strict;
+use warnings;
+
+
+
+
+our @COMMANDS = qw( listLibraries renderProblem ); #listLib readFile tex2pdf
+
+
+
+##################################################
+# XMLRPC client --
+# this code is identical between renderProblem.pl and renderViaXMLRPC.pm????
+##################################################
+
+package WebworkClient;
+
+#use Crypt::SSLeay; # needed for https
+use XMLRPC::Lite;
+use MIME::Base64 qw( encode_base64 decode_base64);
+
+use constant TRANSPORT_METHOD => 'XMLRPC::Lite';
+use constant REQUEST_CLASS => 'WebworkXMLRPC'; # WebworkXMLRPC is used for soap also!!
+use constant REQUEST_URI => 'mod_xmlrpc';
+
+sub new {
+ my $self = {
+ output => '',
+ encodedSource => '',
+ url => '',
+ password => '',
+ course => '',
+ displayMode => '',
+ inputs_ref => { AnSwEr0001 => '',
+ AnSwEr0002 => '',
+ AnSwEr0003 => '',
+ },
+ };
+
+ bless $self;
+}
+
+
+our $result;
+
+##################################################
+# Utilities --
+# this code is identical between renderProblem.pl and renderViaXMLRPC.pm
+##################################################
+
+sub xmlrpcCall {
+ my $self = shift;
+ my $command = shift;
+ $command = 'listLibraries' unless $command;
+
+ my $requestResult = TRANSPORT_METHOD
+ -> proxy($self->{url}.'/'.REQUEST_URI);
+
+ my $input = $self->setInputTable();
+ local( $result);
+ # use eval to catch errors
+ eval { $result = $requestResult->call(REQUEST_CLASS.'.'.$command,$input) };
+ if ($@) {
+ print STDERR "There were a lot of errors for $command\n" ;
+ print STDERR "Errors: \n $@\n End Errors\n" ;
+ return 0 #failure
+ }
+
+ unless (ref($result) and $result->fault) {
+ my $rh_result = $result->result();
+ #print STDERR pretty_print_rh($rh_result);
+ $self->{output} = $rh_result; #$self->formatRenderedProblem($rh_result);
+ return 1; # success
+
+ } else {
+ $self->{output} = 'Error from server: '. join( ",\n ",
+ $result->faultcode,
+ $result->faultstring);
+ return 0; #failure
+ }
+}
+
+sub encodeSource {
+ my $self = shift;
+ my $source = shift;
+ $self->{encodedSource} =encode_base64($source);
+}
+sub url {
+ my $self = shift;
+ my $new_url = shift;
+ $self->{url} = $new_url if defined($new_url) and $new_url =~ /\S/;
+ $self->{url};
+}
+sub pretty_print { # provides html output -- NOT a method
+ my $r_input = shift;
+ my $level = shift;
+ $level = 4 unless defined($level);
+ $level--;
+ return '' unless $level > 0; # only print three levels of hashes (safety feature)
+ my $out = '';
+ if ( not ref($r_input) ) {
+ $out = $r_input if defined $r_input; # not a reference
+ $out =~ s/</</g ; # protect for HTML output
+ } elsif ("$r_input" =~/hash/i) { # this will pick up objects whose '$self' is hash and so works better than ref($r_iput).
+ local($^W) = 0;
+
+ $out .= "$r_input " ."<TABLE border = \"2\" cellpadding = \"3\" BGCOLOR = \"#FFFFFF\">";
+
+
+ foreach my $key ( sort ( keys %$r_input )) {
+ $out .= "<tr><TD> $key</TD><TD>=></td><td> ".pretty_print($r_input->{$key}) . "</td></tr>";
+ }
+ $out .="</table>";
+ } elsif (ref($r_input) eq 'ARRAY' ) {
+ my @array = @$r_input;
+ $out .= "( " ;
+ while (@array) {
+ $out .= pretty_print(shift @array, $level) . " , ";
+ }
+ $out .= " )";
+ } elsif (ref($r_input) eq 'CODE') {
+ $out = "$r_input";
+ } else {
+ $out = $r_input;
+ $out =~ s/</</g; # protect for HTML output
+ }
+
+ return $out." ";
+}
+
+sub setInputTable_for_listLib {
+ my $self = shift;
+ my $out = {
+ pw => $self->{password},
+ set => 'set0',
+ library_name => 'Library',
+ command => 'all',
+ };
+
+ $out;
+}
+sub setInputTable {
+ my $self = shift;
+ my $out = {
+ pw => $self->{password},
+ library_name => 'Library',
+ command => 'renderProblem',
+ answer_form_submitted => 1,
+ course => $self->{course},
+ extra_packages_to_load => [qw( AlgParserWithImplicitExpand Expr
+ ExprWithImplicitExpand AnswerEvaluator
+ AnswerEvaluatorMaker
+ )],
+ mode => $self->{displayMode},
+ modules_to_evaluate => [ qw(
+Exporter
+DynaLoader
+GD
+WWPlot
+Fun
+Circle
+Label
+PGrandom
+Units
+Hermite
+List
+Match
+Multiple
+Select
+AlgParser
+AnswerHash
+Fraction
+VectorField
+Complex1
+Complex
+MatrixReal1 Matrix
+Distributions
+Regression
+
+ )],
+ envir => $self->environment(),
+ problem_state => {
+
+ num_of_correct_ans => 0,
+ num_of_incorrect_ans => 4,
+ recorded_score => 1.0,
+ },
+ source => $self->{encodedSource}, #base64 encoded
+
+
+
+ };
+
+ $out;
+}
+
+sub environment {
+ my $self = shift;
+ my $envir = {
+ answerDate => '4014438528',
+ CAPA_Graphics_URL=>'http://webwork-db.math.rochester.edu/capa_graphics/',
+ CAPA_GraphicsDirectory =>'/ww/webwork/CAPA/CAPA_Graphics/',
+ CAPA_MCTools=>'/ww/webwork/CAPA/CAPA_MCTools/',
+ CAPA_Tools=>'/ww/webwork/CAPA/CAPA_Tools/',
+ cgiDirectory=>'Not defined',
+ cgiURL => 'foobarNot defined',
+ classDirectory=> 'Not defined',
+ courseName=>'Not defined',
+ courseScriptsDirectory=>'not defined',
+ displayMode=>$self->{displayMode},
+ dueDate=> '4014438528',
+ effectivePermissionLevel => 10,
+ externalGif2EpsPath=>'not defined',
+ externalPng2EpsPath=>'not defined',
+ externalTTHPath=>'/usr/local/bin/tth',
+ fileName=>'set0/prob1a.pg',
+ formattedAnswerDate=>'6/19/00',
+ formattedDueDate=>'6/19/00',
+ formattedOpenDate=>'6/19/00',
+ functAbsTolDefault=> 0.0000001,
+ functLLimitDefault=>0,
+ functMaxConstantOfIntegration=> 1000000000000.0,
+ functNumOfPoints=> 5,
+ functRelPercentTolDefault=> 0.000001,
+ functULimitDefault=>1,
+ functVarDefault=> 'x',
+ functZeroLevelDefault=> 0.000001,
+ functZeroLevelTolDefault=>0.000001,
+ htmlDirectory =>'not defined',
+ htmlURL =>'not defined',
+ inputs_ref => $self->{inputs_ref},
+ macroDirectory=>'not defined',
+ numAbsTolDefault=>0.0000001,
+ numFormatDefault=>'%0.13g',
+ numOfAttempts=> 0,
+ numRelPercentTolDefault => 0.0001,
+ numZeroLevelDefault =>0.000001,
+ numZeroLevelTolDefault =>0.000001,
+ openDate=> '3014438528',
+ permissionLevel =>10,
+ PRINT_FILE_NAMES_FOR => [ 'gage'],
+ probFileName => 'set0/prob1a.pg',
+ problemSeed => 1234,
+ problemValue =>1,
+ probNum => 13,
+ psvn => 54321,
+ psvnNumber=> 54321,
+ questionNumber => 1,
+ scriptDirectory => 'Not defined',
+ sectionName => 'Gage',
+ sectionNumber => 1,
+ server_root_url =>"foobarfoobar",
+ sessionKey=> 'Not defined',
+ setNumber =>'not defined',
+ studentLogin =>'gage',
+ studentName => 'Mike Gage',
+ tempDirectory => 'not defined',
+ templateDirectory=>'not defined',
+ tempURL=>'not defined',
+ webworkDocsURL => 'not defined',
+
+ showHints => 1, # extra options -- usually passed from the input form
+ showSolutions => 1,
+
+ };
+ $envir;
+};
+
+sub formatAnswerRow {
+ my $self = shift;
+ my $rh_answer = shift;
+ my $problemNumber = shift;
+ my $answerString = $rh_answer->{original_student_ans}||' ';
+ my $correctAnswer = $rh_answer->{correct_ans}||'';
+ my $ans_message = $rh_answer->{ans_message}||'';
+ my $score = ($rh_answer->{score}) ? 'Correct' : 'Incorrect';
+ my $row = qq{
+ <tr>
+ <td>
+ Prob: $problemNumber
+ </td>
+ <td>
+ $answerString
+ </td>
+ <td>
+ $score
+ </td>
+ <td>
+ Correct answer is $correctAnswer
+ </td>
+ <td>
+ <i>$ans_message</i>
+ </td>
+ </tr>\n
+ };
+ $row;
+}
+
+sub formatRenderedProblem {
+ my $self = shift;
+ my $rh_result = $self->{output}; # wrap problem in formats
+ my $problemText = decode_base64($rh_result->{text});
+ my $rh_answers = $rh_result->{answers};
+ my $encodedSource = $self->{encodedSource}||'foobar';
+ my $warnings = '';
+ if ( defined ($rh_result->{WARNINGS}) and $rh_result->{WARNINGS} ){
+ $warnings = "<div style=\"background-color:pink\">
+ <p >WARNINGS</p><p>".decode_base64($rh_result->{WARNINGS})."</p></div>";
+ }
+ #warn "keys: ", join(" | ", sort keys %{$rh_result });
+ my $debug_messages = $rh_result->{flags}->{DEBUG_messages} || [];
+ $debug_messages = join("<br/>\n", @{ $debug_messages } );
+ my $internal_debug_messages = $rh_result->{internal_debug_messages} || [];
+ $internal_debug_messages = join("<br/>\n", @{ $internal_debug_messages } );
+ # collect answers
+ my $answerTemplate = q{<hr>ANSWERS <table border="3" align="center">};
+ my $problemNumber = 1;
+ foreach my $key (sort keys %{$rh_answers}) {
+ $answerTemplate .= $self->formatAnswerRow($rh_answers->{$key}, $problemNumber++);
+ }
+ $answerTemplate .= q{</table> <hr>};
+
+ my $FULL_URL = $self->url;
+ my $FORM_ACTION_URL = "$FULL_URL/webwork2/html2xml";
+ my $problemTemplate = <<ENDPROBLEMTEMPLATE;
+<html>
+<head>
+<base href="$FULL_URL">
+<title>$FULL_URL WeBWorK Editor using host $FULL_URL</title>
+</head>
+<body>
+<h2> WeBWorK Editor using host $FULL_URL</h2>
+ $answerTemplate
+ <form action="$FORM_ACTION_URL" method="post">
+ $problemText
+ <input type="hidden" name="answersSubmitted" value="1">
+ <input type="hidden" name="problemAddress" value="probSource">
+ <input type="hidden" name="problemSource" value="$encodedSource">
+ <input type="hidden" name="problemSeed" value="1234">
+ <input type="hidden" name="pathToProblemFile" value="foobar">
+ <p><input type="submit" name="submit" value="submit answers"></p>
+ </form>
+<HR>
+<h3> Warning section </h3>
+$warnings
+<h3>
+Debug message section
+</h3>
+$debug_messages
+<h3>
+internal errors
+</h3>
+$internal_debug_messages
+
+</body>
+</html>
+
+ENDPROBLEMTEMPLATE
+
+
+
+ $problemTemplate;
+}
+
+
+1;
|
