Updates on explanation on how calls to the webservice are generated from $SITE_URL and REQUEST_URI()

Author: mgage

lib/FormatRenderedProblem.pm

@@ -261,7 +261,7 @@ sub formatRenderedProblem {
 	my $userID           =  $self->{userID}//'';
 	my $course_password  =  $self->{course_password}//'';
 	my $problemSeed      =  $self->{inputs_ref}->{problemSeed}//6666;
-    my $psvn             =  $self->{inputs_ref}->{psvn}//54321;
+	my $psvn             =  $self->{inputs_ref}->{psvn}//54321;
 	my $session_key      =  $rh_result->{session_key}//'';
 	my $displayMode      =  $self->{inputs_ref}->{displayMode};
 
@@ -270,10 +270,10 @@ sub formatRenderedProblem {
 	my $checkMode        =  defined($self->{inputs_ref}->{WWcheck})||0;
 	my $submitMode       =  defined($self->{inputs_ref}->{WWsubmit})||0;
 	my $showCorrectMode  =  defined($self->{inputs_ref}->{WWcorrectAns})||0;
-        # problemUUID can be added to the request as a parameter.  
-        # It adds a prefix to the 
-        # identifier used by the  format so that several different problems
-        # can appear on the same page.   
+	# problemUUID can be added to the request as a parameter.  
+	# It adds a prefix to the 
+	# identifier used by the  format so that several different problems
+	# can appear on the same page.   
 	my $problemUUID      =  $self->{inputs_ref}->{problemUUID}//0;
 	my $problemResult    =  $rh_result->{problem_result}//'';
 	my $problemState     =  $rh_result->{problem_state}//'';

lib/WeBWorK/ContentGenerator/instructorXMLHandler.pm

@@ -46,55 +46,53 @@ use JSON;
 #################################################
   instructorXMLHandler -- a front end for the Webservice that accepts HTML forms
 
-  receives WeBWorK problems presented as HTML forms, usually created with js xmlhttprequests,
-  packages the form variables into an XML_RPC request
+ receives WeBWorK problems presented as HTML forms, usually created with js xmlhttprequests,
+ packages the form variables into an XML_RPC request
  suitable for all of the webservices in WebworkWebservices
  returns xml resutls
 #################################################
 
 =cut
 
 # To configure the target webwork server two URLs are required
-# 1.    http://test.webwork.maa.org/mod_xmlrpc 
+# 1. http://test.webwork.maa.org/mod_xmlrpc 
 #    points to the Webservice.pm and Webservice/RenderProblem modules
 #    Is used by the client to send the original XML request to the webservice
-#    Note: This not the same as the webworkClient->url which should NOT have
-#          the mod_xmlrpc segment. 
-# 2. $FORM_ACTION_URL      http:http://test.webwork.maa.org/webwork2/html2xml
-#    points to the renderViaXMLRPC.pm module.
+#  Note: This NOT the same as the webworkClient->url which does NOT have
+#        the mod_xmlrpc segment attached. webworkClient->url would be http://test.webwork.maa.org
+#        The mod_xmlrpc segment is added by WebworkClient.pm when issuing the webservice call
+#        using the constant REQUEST_URI within the subroutine xmlrpcCall
+# 2. $FORM_ACTION_URL      http:http://test.webwork.maa.org/webwork2/instructorXMLHandler
+#    points to the instructorXMLHandler.pm module.
 #
 #     This url is placed as form action url when the rendered HTML from the original
 #     request is returned to the client from Webservice/RenderProblem. The client
 #     reorganizes the XML it receives into an HTML page (with a WeBWorK form) and 
 #     pipes it through a local browser.
 #
 #     The browser uses this url to resubmit the problem (with answers) via the standard
-#     HTML webform used by WeBWorK to the renderViaXMLRPC.pm handler.  
+#     HTML webform used by WeBWorK to the instructorXMLHandler.pm handler.  
 #
-#     This renderViaXMLRPC.pm handler acts as an intermediary between the browser 
+#     This instructorXMLHandler.pm handler acts as an intermediary between the browser 
 #     and the webservice.  It interprets the HTML form sent by the browser, 
 #     rewrites the form data in XML format, submits it to the WebworkWebservice.pm 
 #     which processes it and sends the the resulting HTML back to renderViaXMLRPC.pm
 #     which in turn passes it back to the browser.
-# 3.  The second time a problem is submitted renderViaXMLRPC.pm receives the WeBWorK form 
+# 3.  The second time a problem is submitted instructorXMLHandler.pm receives the WeBWorK form 
 #     submitted directly by the browser.  
-#     The renderViaXMLRPC.pm translates the WeBWorK form, has it processes by the webservice
+#     The instructorXMLHandler.pm translates the WeBWorK form, has it processed by the webservice
 #     and returns the result to the browser. 
 #     The The client renderProblem.pl script is no longer involved.
-# 4.  Summary: renderProblem.pl is only involved in the first round trip
-#     of the submitted problem.  After that the communication is  between the browser and
-#     renderViaXMLRPC using HTML forms and between renderViaXMLRPC and the WebworkWebservice.pm
-#     module using XML_RPC.
 
 
 # Determine the root directory for webwork on this machine (e.g. /opt/webwork/webwork2 )
 # this is set in webwork.apache2-config
 # it specifies the address of the webwork root directory
 
-#my $webwork_dir  = $ENV{WEBWORK_ROOT};
+
 my $webwork_dir  = $WeBWorK::Constants::WEBWORK_DIRECTORY;
 unless ($webwork_dir) {
-	die "renderViaXMLRPC.pm requires that the top WeBWorK directory be set in ".
+	die " instructorXMLHandler.pm requires that the top WeBWorK directory be set in ".
 	"\$WeBWorK::Constants::WEBWORK_DIRECTORY by webwork.apache-config or webwork.apache2-config\n";
 }
 

lib/WeBWorK/ContentGenerator/renderViaXMLRPC.pm

@@ -54,9 +54,12 @@ use CGI;
 =cut
 
 # To configure the target webwork server two URLs are required
-# 1.    http://test.webwork.maa.org/mod_xmlrpc
+# 1.  The url  http://test.webwork.maa.org/mod_xmlrpc
 #    points to the Webservice.pm and Webservice/RenderProblem modules
-#    Is used by the client to send the original XML request to the webservice
+#    Is used by the client to send the original XML request to the webservice.
+#    It is constructed in WebworkClient::xmlrpcCall() from the value of $webworkClient->site_url which does 
+#    NOT have the mod_xmlrpc segment (it should be   http://test.webwork.maa.org) 
+#    and the constant  REQUEST_URI defined in WebworkClient.pm to be mod_xmlrpc.  
 #
 # 2. $FORM_ACTION_URL      http:http://test.webwork.maa.org/webwork2/html2xml
 #    points to the renderViaXMLRPC.pm module.