--- loncom/homework/response.pm	2007/05/31 15:30:35	1.170
+++ loncom/homework/response.pm	2009/03/16 18:20:22	1.213
@@ -1,7 +1,7 @@
 # The LearningOnline Network with CAPA
 # various response type definitons response definition
 #
-# $Id: response.pm,v 1.170 2007/05/31 15:30:35 albertel Exp $
+# $Id: response.pm,v 1.213 2009/03/16 18:20:22 bisitz Exp $
 #
 # Copyright Michigan State University Board of Trustees
 #
@@ -26,6 +26,29 @@
 # http://www.lon-capa.org/
 #
 
+=pod
+
+=head1 NAME
+
+Apache::resonse.pm
+
+=head1 SYNOPSIS
+
+This is part of the LearningOnline Network with CAPA project
+described at http://www.lon-capa.org.
+
+
+=head1 NOTABLE SUBROUTINES
+
+=over
+
+=item 
+
+=back
+
+=cut
+
+
 package Apache::response;
 use strict;
 use Apache::lonlocal;
@@ -216,35 +239,26 @@ sub meta_stores_write {
 		      "></stores>\n";
 }
 
+=pod
+
+=item mandatory_part_meta()
+
+Autogenerate metadata for mandatory
+input (from RAT or lonparmset) and
+output (to lonspreadsheet)
+of each part
+
+Note: responseid-specific data 'submission' and 'awarddetail'
+not available to spreadsheet -> skip here
+
+=cut
+
+
 sub mandatory_part_meta {
-#
-# Autogenerate metadata for mandatory
-# input (from RAT or lonparmset) and 
-# output (to lonspreadsheet)
-# of each part
-#
-    return
-#    &meta_parameter_write('opendate','date_start','',
-#                          'Opening Date').
-#    &meta_parameter_write('duedate','date_end','',
-#                          'Due Date').
-#    &meta_parameter_write('answerdate','date_start','',
-#                          'Show Answer Date').
-#    &meta_parameter_write('weight','int_zeropos','',
-#                          'Available Points').
-#    &meta_parameter_write('maxtries','int_pos','',
-#                          'Maximum Number of Tries').
-	&meta_package_write('part').
-        &meta_stores_write('solved','string',
-			   'Problem Status').
-        &meta_stores_write('tries','int_zeropos',
-			   'Number of Attempts').
-        &meta_stores_write('awarded','float',
-			   'Partial Credit Factor');
-#
-# Note: responseid-specific data 'submission' and 'awarddetail'
-# not available to spreadsheet -> skip here
-#
+    return &meta_package_write('part').
+           &meta_stores_write('solved','string','Problem Status').
+           &meta_stores_write('tries','int_zeropos','Number of Attempts').
+           &meta_stores_write('awarded','float','Partial Credit Factor');
 }
 
 sub meta_part_order {
@@ -269,7 +283,7 @@ sub check_for_previous {
     my %previous;
     $previous{'used'} = 0;
     foreach my $key (sort(keys(%Apache::lonhomework::history))) {
-	if ($key =~ /resource\.$partid\.$id\.submission$/) {
+	if ($key =~ /resource\.\Q$partid\E\.\Q$id\E\.submission$/) {
 	    if ( $last && $key =~ /^(\d+):/ ) {
 		next if ($1 >= $last);
 	    }
@@ -288,6 +302,7 @@ sub check_for_previous {
 		    $previous{'last'}='1';
 		}
 		if (! $previous{'award'} ) { $previous{'award'} = 'UNKNOWN';	}
+                if ($previous{'award'} eq 'INTERNAL_ERROR') { $previous{'used'}=0; }
 		&Apache::lonxml::debug("got a match :$previous{'award'}:$previous{'used'}:");
 	    }
 	}
@@ -451,7 +466,12 @@ sub end_customresponse {
     }
     if ($target eq 'grade' || $target eq 'web' || $target eq 'answer' || 
 	$target eq 'tex' || $target eq 'analyze') {
-	&Apache::lonxml::increment_counter(&Apache::response::repetition());
+	&Apache::lonxml::increment_counter(&Apache::response::repetition(),
+					   "$part.$id");
+	if ($target eq 'analyze') {
+            $Apache::lonhomework::analyze{"$part.$id.type"} = 'customresponse';
+	    &Apache::lonhomework::set_bubble_lines();
+	}
     }
     pop(@Apache::lonxml::namespace);
     pop(@Apache::response::custom_answer);
@@ -481,6 +501,7 @@ sub start_mathresponse {
 						   $safeeval);
 	    $Apache::inputtags::answertxt{$id}=[$answer];
 	}
+
     } elsif ($target eq 'edit') {
 	$result.=&Apache::edit::tag_start($target,$token);
 	$result.=&Apache::edit::text_arg('String to display for answer:',
@@ -490,12 +511,16 @@ sub start_mathresponse {
 					   ['maxima'],
 					   $token);
 	$result.=&Apache::edit::text_arg('Argument Array:',
-					 'args',$token);
+					 'args',$token).
+                 &Apache::loncommon::help_open_topic('Maxima_Argument_Array');
+        $result.=&Apache::edit::text_arg('Libraries:',
+                                         'libraries',$token).
+                 &Apache::loncommon::help_open_topic('Maxima_Libraries');
 	$result.=&Apache::edit::end_row().&Apache::edit::start_spanning_row();
     } elsif ($target eq 'modified') {
 	my $constructtag;
 	$constructtag=&Apache::edit::get_new_args($token,$parstack,
-						  $safeeval,'answerdisplay','cas','args');
+						  $safeeval,'answerdisplay','cas','args','libraries');
 	if ($constructtag) {
 	    $result = &Apache::edit::rebuild_tag($token);
 	}
@@ -507,6 +532,23 @@ sub start_mathresponse {
     return $result;
 }
 
+sub edit_mathresponse_button {
+    my ($id,$field)=@_;
+    my $button=&mt('Edit Answer');
+#    my $helplink=&Apache::loncommon::help_open_topic('Formula_Editor');
+    my $iconpath=$Apache::lonnet::perlvar{'lonIconsURL'};
+    return(<<ENDFORMULABUTTON);
+<script type="text/javascript" language="JavaScript">
+function edit_${id}_${field} (textarea) {
+    thenumber = textarea;
+    thedata = document.forms['lonhomework'].elements[textarea].value;
+    newwin = window.open("/adm/dragmath/applet/MaximaPopup.html","","width=565,height=400,resizable");
+}
+</script>
+<a href="javascript:edit_${id}_${field}('${field}');void(0);"><img class="stift" src='$iconpath/stift.gif' alt='$button' title='$button'/></a>
+ENDFORMULABUTTON
+}
+
 sub end_mathresponse {
     my ($target,$token,$tagstack,$parstack,$parser,$safeeval)=@_;
     my $result;
@@ -527,7 +569,8 @@ sub end_mathresponse {
 	    my $cas = &Apache::lonxml::get_param('cas',$parstack,$safeeval);
             if ($cas eq 'maxima') {
                 my $args = [&Apache::lonxml::get_param_var('args',$parstack,$safeeval)];
-                $award=&Apache::lonmaxima::maxima_run($Apache::response::custom_answer[-1],$response,$args);
+                $award=&Apache::lonmaxima::maxima_run($Apache::response::custom_answer[-1],$response,$args,
+                                                      &Apache::lonxml::get_param('libraries',$parstack,$safeeval));
             }
 	    if (!&Apache::inputtags::valid_award($award)) {
 		$error = $award;
@@ -544,6 +587,12 @@ sub end_mathresponse {
     }
     if ($target eq 'web') {
 	&setup_prior_tries_hash(\&format_prior_response_math);
+        my $partid = $Apache::inputtags::part;
+        my $id = $Apache::inputtags::response[-1];
+        if (($Apache::inputtags::status['-1'] eq 'CAN_ANSWER')
+           && (&Apache::lonnet::EXT('resource.'.$partid.'_'.$id.'.turnoffeditor') ne 'yes')) {
+            $result.=&edit_mathresponse_button($id,"HWVAL_$id");
+        }
     }
 
     pop(@Apache::lonxml::namespace);
@@ -569,15 +618,15 @@ sub implicit_multiplication {
     $expression=~s/(\d+)(?:x|\*)10(?:\^|\*\*)([\+\-]*\d+)/$1\&\($2\)/gsi;
 # Fill in multiplication signs
 # a b -> a*b;3 b -> 3*b;3 4 -> 3*4
-    $expression=~s/(\w)\s+(\w)/$1\*$2/gs;
+    $expression=~s/([A-Za-z0-9])\s+(?=[A-Za-z0-9])/$1\*/gs;
 # )( -> )*(; ) ( -> )*(
     $expression=~s/\)\s*\(/\)\*\(/gs;
 # 3a -> 3*a; 3( -> 3*(; 3 ( -> 3*(; 3A -> 3*A
     $expression=~s/(\d)\s*([a-zA-Z\(])/$1\*$2/gs;
 # a ( -> a*(
-    $expression=~s/(\w)\s+\(/$1\*\(/gs;
+    $expression=~s/([A-Za-z0-9])\s+\(/$1\*\(/gs;
 # )a -> )*a; )3 -> )*3; ) 3 -> )*3
-    $expression=~s/\)\s*(\w)/\)\*$1/gs;
+    $expression=~s/\)\s*([A-Za-z0-9])/\)\*$1/gs;
 # 3&8 -> 3e8; 3&-4 -> 3e-4
     $expression=~s/(\d+)\&\(([\+\-]*\d+)\)/$1e$2/gs;
     return $expression;
@@ -646,7 +695,7 @@ sub start_responseparam {
 	    }
 	}
 	if (defined($optionlist)) {
-	    $result.='Use template: <select name="'.
+	    $result.=&mt('Use template:').' <select name="'.
 		&Apache::edit::html_element_name('parameter_package').'">'.
 		    '<option value=""></option>'.$optionlist.'</select><br />';
 	}
@@ -671,6 +720,7 @@ sub start_responseparam {
 		$Apache::lonnet::packagetab{"$tag&$name&display"};
 	    $token->[2]->{'default'}=
 		$Apache::lonnet::packagetab{"$tag&$name&default"};
+            $token->[3] = ['name','type','description','default'];
 	    $constructtag=1;
 	}
 	if ($constructtag) {
@@ -795,9 +845,13 @@ sub answer_part {
 		    last;
 		}
 	    }
-	    if ($answer ne '') {
-		$answer = '\verb'.$to_use.$answer.$to_use;
-	    }
+            my $fullanswer=$answer;
+            $answer='';
+            foreach my $element (split(/[\;]/,$fullanswer)) {
+	       if ($element ne '') {
+	 	  $answer.= '\verb'.$to_use.$element.$to_use.' \newline';
+	       }
+            }
 	}
 	if ($answer ne '') {
 	    push(@answer_bits,$answer);
@@ -816,12 +870,17 @@ sub answer_footer {
     my ($type) = @_;
     my $result;
     if ($env{'form.answer_output_mode'} eq 'tex') {
-	my $columns = scalar(@answer_bits);
-	$result  = ' \vskip 0 mm \noindent \begin{tabular}{|'.'c|'x$columns.'}\hline ';
-	$result .= join(' & ',@answer_bits);
-	$result .= ' \\\\ \\hline \end{tabular} \vskip 0 mm ';
+	$result  = ' \vskip 0 mm \noindent \begin{tabular}{|p{1.5cm}|p{6.8cm}|}\hline ';
+	$result .= $answer_bits[0].'&\vspace*{-4mm}\begin{itemize}';
+        for (my $i=1;$i<=$#answer_bits;$i++) {
+            $result.='\item '.$answer_bits[$i].'\vspace*{-7mm}';
+        }
+	$result .= ' \end{itemize} \\\\ \hline \end{tabular} \vskip 0 mm ';
     } else {
-	$result = '</tr></table>';
+	if (!$need_row_start) {
+	    $result .= '</tr>';
+	}
+	$result .= '</table>';
     }
     return $result;
 }
@@ -843,7 +902,7 @@ sub showallfoils {
 
 =pod
 
-=item &getresponse($offset,$resulttype);
+=item &getresponse();
 
 Retreives the current submitted response, helps out in the case of
 scantron mode.
@@ -852,16 +911,24 @@ Returns either the exact text of the sub
 converted to something usable.
 
 Optional Arguments:
-  $offset - if a problem has more than one bubble response, pass in the number
-            of the bubble wanted
+  $offset - (defaults to 1) if a problem has more than one bubble
+            response, pass in the number of the bubble wanted, (the
+            first bubble associated with a problem has an offset of 1,
+            the second bubble is 2
+
   $resulttype - undef    -> a number between 0 and 25
                 'A is 1' -> a number between 1 and 26
                 'letter' -> a letter between 'A' and 'Z'
+  $lines  - undef problem only needs a single line of bubbles.
+            nonzero  Problem wants the first nonempty response in 
+                      $lines lines of bubbles.
+  $bubbles_per_line - Must be provided if lines is defined.. number of
+                      bubbles on a line.
 
 =cut
 
 sub getresponse {
-    my ($offset,$resulttype)=@_;
+    my ($offset,$resulttype, $lines, $bubbles_per_line)=@_;
     my $formparm='form.HWVAL_'.$Apache::inputtags::response['-1'];
     my $response;
     if (!defined($offset)) {
@@ -869,6 +936,9 @@ sub getresponse {
     } else {
 	$formparm.=":$offset";
     }
+    if (!defined($lines)) {
+	$lines = 1;
+    }
     my %let_to_num=('A'=>0,'B'=>1,'C'=>2,'D'=>3,'E'=>4,'F'=>5,'G'=>6,'H'=>7,
 		    'I'=>8,'J'=>9,'K'=>10,'L'=>11,'M'=>12,'N'=>13,'O'=>14,
 		    'P'=>15,'Q'=>16,'R'=>17,'S'=>18,'T'=>19,'U'=>20,'V'=>21,
@@ -876,8 +946,21 @@ sub getresponse {
     if ($env{'form.submitted'} eq 'scantron') {
 	my $part  = $Apache::inputtags::part;
 	my $id    = $Apache::inputtags::response[-1];
-	$response = $env{'scantron.'.($Apache::lonxml::counter+$offset-1).
-			 '.answer'};
+	
+	my $line;
+	my $startline = $env{'form.scantron_questnum_start.'.$part.'.'.$id};
+        if (!$startline) {
+            $startline = $Apache::lonxml::counter;
+        }
+	for ($line = 0; $line < $lines; $line++) {
+            my $theline = $startline+$offset-1+$line;
+	    $response = $env{"scantron.$theline.answer"};
+	    if ((defined($response)) && ($response ne "") && ($response ne " ")) {
+		last;
+	    }
+ 
+	}
+
 	# save bubbled letter for later
 	$Apache::lonhomework::results{"resource.$part.$id.scantron"}.=
 	    $response;
@@ -887,10 +970,23 @@ sub getresponse {
 	    } else {
 		$response = $let_to_num{$response};
 	    }
+	    if ($response ne "") {
+		$response += $line * $bubbles_per_line;
+	    }
+	} else {
+	    if ($response ne "") {
+		$response = chr(ord($response) + $line * $bubbles_per_line);
+	    }
 	}
+
     } else {
 	$response = $env{$formparm};
     }
+    # 
+    #  If we have a nonempty answer, correct the numeric value
+    #  of the answer for the line on which it was found.
+    #
+
     return $response;
 }
 
@@ -914,7 +1010,7 @@ sub repetition {
 
 =pod
 
-=item &scored_response($part_id,$response_id);
+=item &scored_response();
 
 Sets the results hash elements
 
@@ -1010,7 +1106,7 @@ sub show_answer {
     my $award  = $Apache::lonhomework::history{"resource.$part.solved"};
     my $status = $Apache::inputtags::status[-1];
     return  ( ($award =~ /^correct/
-	       && lc($Apache::lonhomework::problemstatus) ne 'no')
+	       && &Apache::lonhomework::show_problem_status())
 	      || $status eq "SHOW_ANSWER");
 }
 
@@ -1071,17 +1167,20 @@ sub pick_foil_for_concept {
 	$Apache::response::conceptgroup{'names'};
 
 }
-#------------------------------------------------------------
-#
-#  Get a parameter associated with a problem.
-# Parameters:
-#  $id        - the id of the paramater, either a part id, 
-#               or a partid and responspe id joined by _
-#  $name      - Name of the parameter to fetch
-#  $default   - Default value for the paramter.
-#
-#  
-#
+
+=pod
+
+=item get_response_param()
+
+Get a parameter associated with a problem.
+Parameters:
+	$id        - the id of the paramater, either a part id, 
+              or a partid and responspe id joined by _
+	$name      - Name of the parameter to fetch
+	$default   - Default value for the paramter.
+
+=cut
+
 sub get_response_param {
     my ($id,$name,$default)=@_;
     my $parameter;
@@ -1115,7 +1214,7 @@ sub submitted {
     }
     # Submit All button on a .page was pressed
     if (defined($env{'form.all_submit'})) { return 1; }
-    # otherwise no submission occured
+    # otherwise no submission occurred
     return 0;
 }
 
@@ -1142,14 +1241,21 @@ sub add_to_gradingqueue {
     }
 }
 
-# basically undef and 0 (both false) mean that they still have work to do
-# and all true values mean that they can't do any more work
-#
-# a return of undef means it is unattempted
-# a return of 0 means it is attmpted and wrong but still has tries
-# a return of 1 means it is marked correct
-# a return of 2 means they have exceed maximum number of tries
-# a return of 3 means it after the answer date
+=pod 
+
+=item check_status()
+
+basically undef and 0 (both false) mean that they still have work to do
+and all true values mean that they can't do any more work
+
+	a return of undef means it is unattempted
+	a return of 0 means it is attmpted and wrong but still has tries
+	a return of 1 means it is marked correct
+	a return of 2 means they have exceed maximum number of tries
+	a return of 3 means it after the answer date
+
+=cut
+
 sub check_status {
     my ($id)=@_;
     if (!defined($id)) { $id=$Apache::inputtags::part; }
@@ -1172,6 +1278,21 @@ sub check_status {
     return 2;
 }
 
+=pod
+
+=item setup_prior_tries_hash()
+
+  Foreach each past .submission $func is called with 3 arguments
+     - the mode to set things up for (currently always 'grade')
+     - the stored .submission string
+     - The expansion of $data
+
+  $data is an array ref containing elements that are either
+    - scalars that are other elements of the history hash to pass to $func
+    - ref to data to be passed untouched to $func
+
+=cut
+
 sub setup_prior_tries_hash {
     my ($func,$data) = @_;
     my $part = $Apache::inputtags::part;
@@ -1202,3 +1323,6 @@ sub setup_prior_tries_hash {
 1;
 __END__
  
+=pod
+
+=cut