--- loncom/homework/chemresponse.pm 2003/05/05 19:27:08 1.3 +++ loncom/homework/chemresponse.pm 2008/12/22 15:05:49 1.85 @@ -1,7 +1,7 @@ # The LearningOnline Network with CAPA # chemical equation style response # -# $Id: chemresponse.pm,v 1.3 2003/05/05 19:27:08 albertel Exp $ +# $Id: chemresponse.pm,v 1.85 2008/12/22 15:05:49 raeburn Exp $ # # Copyright Michigan State University Board of Trustees # @@ -30,16 +30,48 @@ package Apache::chemresponse; use strict; use Apache::lonxml; use Apache::lonnet; +use Apache::lonlocal; +use lib '/home/httpd/lib/perl/'; +use LONCAPA; + BEGIN { - &Apache::lonxml::register('Apache::chemresponse',('chemresponse','chemstructure')); + &Apache::lonxml::register('Apache::chemresponse',('organicresponse','organicstructure','reactionresponse','chem')); } -sub seperate_jme_window { - my ($smile_input,$jme_input,$molecule)=@_; +sub chem_standard_order { + my ($reaction) = @_; + my ($re,$pr) = split(/->|<=>/,$reaction); + my @reactants = split(/\s\+/,$re); + my @products = split(/\s\+/,$pr); + foreach my $substance (@reactants,@products) { + $substance =~ s/(\^\d*)\s+/$1_/g; # protect superscript space + $substance =~ s/\s*//g; # strip whitespace + $substance =~ s/_/ /g; # restore superscript space + } + @reactants = sort @reactants; + @products = sort @products; + my $standard = ''; + foreach my $substance (@reactants) { + $standard .= $substance; + $standard .= ' + '; + } + $standard =~ s/ \+ $//; # get rid of trailing plus sign + $standard .= ' -> '; + foreach my $substance (@products) { + $standard .= $substance; + $standard .= ' + '; + } + $standard =~ s/ \+ $//; # get rid of trailing plus sign + return $standard; +} + +sub separate_jme_window { + my ($smile_input,$jme_input,$molecule,$options,$shown_text)=@_; my $smilesection; if (defined($smile_input)) { $smilesection=< - -Molecule Editor - - - +CHEMJS + + my $start_page = + &Apache::loncommon::start_page('Molecule Editor',undef, + {'only_body' => 1, + 'js_ready' => 1, + 'bgcolor' => '#FFFFFF',}); + my $end_page = + &Apache::loncommon::end_page({'js_ready' => 1,}); + + my $body=< - +
+ + + +
+ +
+ You have to enable Java and JavaScript on your machine. - +$molecule +
-JME Editor courtesy of Peter Ertl, Novartis - - +JME Editor courtesy of Peter Ertl, Novartis
- +$insert_answer +
+    - +
- - CHEMPAGE - $body=&HTML::Entities::encode($body); - $body=~s/\n/ /g; + + $body=&Apache::loncommon::js_ready($body); + my $nothing=&Apache::lonhtmlcommon::javascript_nothing(); + my $docopen=&Apache::lonhtmlcommon::javascript_docopen(); + my $display=&mt('Draw Molecule'); + if (defined($shown_text)) { $display=&mt($shown_text); } + my $iconpath=$Apache::lonnet::perlvar{'lonIconsURL'}; + my $function = + 'LONCAPA_draw_molecule_'.&Apache::lonhtmlcommon::get_uniq_name(); my $result=< + +$display CHEMINPUT return $result; } +sub jme_img { + my ($jme,$smile,$width,$options)=@_; + my $id=&Apache::loncommon::get_cgi_id(); + my $result=''.$smile.' + &escape($jme), + 'cgi.'.$id.'.PNG' => 1, + 'cgi.'.$id.'.WIDTH' => $width}); + return $result; +} -sub start_chemresponse { +sub start_organicresponse { my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_; my $result; my $partid = $Apache::inputtags::part; my $id = &Apache::response::start_response($parstack,$safeeval); if ($target eq 'meta') { + $result=&Apache::response::meta_package_write('organicresponse'); } elsif ($target eq 'web') { - my $molecule; - if (defined($Apache::lonhomework::history{"resource.$partid.$id.molecule"})) { - $molecule=$Apache::lonhomework::history{"resource.$partid.$id.molecule"}; - } else { - $molecule=&Apache::lonxml::get_param('molecule',$parstack, + my $jmeanswer=&Apache::lonxml::get_param('jmeanswer',$parstack, $safeeval); + if ( &Apache::response::show_answer() && $jmeanswer ne '') { + my $options=&Apache::lonxml::get_param('options',$parstack, + $safeeval); + my $width=&Apache::lonxml::get_param('width',$parstack, + $safeeval); + my (@answers)=&Apache::lonxml::get_param_var('answer',$parstack, + $safeeval); + $result.=&jme_img($jmeanswer,$answers[0],$width,$options); + } else { + my $molecule; + if (defined($Apache::lonhomework::history{"resource.$partid.$id.molecule"})) { + $molecule=$Apache::lonhomework::history{"resource.$partid.$id.molecule"}; + } else { + $molecule=&Apache::lonxml::get_param('molecule',$parstack, + $safeeval); + } + my $options=&Apache::lonxml::get_param('options',$parstack, + $safeeval); + my $shown_text; + if (&Apache::response::show_answer()) { + $shown_text="Show Your Last Answer"; + } + #stift $result=&separate_jme_window("HWVAL_$id","MOLECULE_$id",$molecule, +# $options,$shown_text); + $result.= ''; } - $result=&seperate_jme_window("HWVAL_$id","MOLECULE_$id",$molecule); - $result.= ''; } elsif ($target eq 'edit') { $result .=&Apache::edit::tag_start($target,$token); - $result .=&Apache::edit::text_arg('Starting Molecule:','molecule', - $token,40); + my $options=&Apache::lonxml::get_param('options',$parstack, + $safeeval); + if ($options !~ /multipart/) { $options.=',multipart'; } + $result .=''. + &Apache::edit::text_arg('Starting Molecule:','molecule', + $token,40); my $molecule=&Apache::lonxml::get_param('molecule',$parstack, $safeeval); - $result .=&seperate_jme_window(undef, + $result .=&separate_jme_window(undef, &Apache::edit::html_element_name('molecule'), - $molecule); - $result .='
'; + $molecule,$options); + $result .='
'; $result .=&Apache::edit::text_arg('Correct Answer:','answer', $token,40); - $result .=&Apache::edit::hidden_arg('jmeanswer',$token); + $result .='
'; + $result .=&Apache::edit::text_arg('JME string of the answer (automatically updated when using the Draw Molecule button):', + 'jmeanswer',$token); my $jmeanswer=&Apache::lonxml::get_param('jmeanswer',$parstack, $safeeval); - $result .=&seperate_jme_window( + $result .=&separate_jme_window( &Apache::edit::html_element_name('answer'), &Apache::edit::html_element_name('jmeanswer'), - $jmeanswer); + $jmeanswer,$options); + $result .='
'; + $result .=&Apache::edit::checked_arg('Options:','options', + [ ['autoez','Auto E,Z stereochemistry'], + ['multipart','Multipart Structures'], + ['nostereo','No stereochemistry'], + ['reaction','Is a reaction'], + ['number','Able to number atoms'] ], + ,$token); + $result .=&Apache::edit::text_arg('Width of correct answer image:', + 'width',$token,10); $result .=&Apache::edit::end_row().&Apache::edit::start_spanning_row(); } elsif ($target eq 'modified') { my $constructtag=&Apache::edit::get_new_args($token,$parstack, $safeeval,'molecule', - 'answer','jmeanswer'); + 'answer','jmeanswer', + 'options','width'); if ($constructtag) { $result = &Apache::edit::rebuild_tag($token); } } + return $result; } -sub end_chemresponse { +sub end_organicresponse { my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_; my $result; - if ($target eq 'grade' && defined($ENV{'form.submitted'})) { - &Apache::response::setup_params($$tagstack[-1]); + + my $partid = $Apache::inputtags::part; + my $id = $Apache::inputtags::response['-1']; + + if ($target eq 'grade' + && &Apache::response::submitted() + && $Apache::lonhomework::type eq 'exam') { + + &Apache::response::scored_response($partid,$id); + + } elsif ($target eq 'grade' + && &Apache::response::submitted() + && $Apache::lonhomework::type ne 'exam') { + + &Apache::response::setup_params($$tagstack[-1],$safeeval); my $response = &Apache::response::getresponse(); if ( $response =~ /[^\s]/) { - my $partid = $Apache::inputtags::part; - my $id = $Apache::inputtags::response['-1']; - my $answer=&Apache::lonxml::get_param('answer',$parstack,$safeeval); + my (@answers)=&Apache::lonxml::get_param_var('answer',$parstack,$safeeval); my %previous = &Apache::response::check_for_previous($response,$partid,$id); $Apache::lonhomework::results{"resource.$partid.$id.submission"}=$response; - &Apache::lonxml::debug("submitted a $response for $answer
\n"); my $ad; - if ($response eq $answer) { - $ad='EXACT_ANS'; - } else { - $ad='INCORRECT'; + foreach my $answer (@answers) { + &Apache::lonxml::debug("submitted a $response for $answer
\n"); + if ($response eq $answer) { + $ad='EXACT_ANS'; + last; + } else { + $ad='INCORRECT'; + } + } + if ($ad && $Apache::lonhomework::type eq 'survey') { + $ad='SUBMITTED'; } &Apache::response::handle_previous(\%previous,$ad); $Apache::lonhomework::results{"resource.$partid.$id.awarddetail"}=$ad; - $Apache::lonhomework::results{"resource.$partid.$id.molecule"}=$ENV{"form.MOLECULE_$id"}; + $Apache::lonhomework::results{"resource.$partid.$id.molecule"}=$env{"form.MOLECULE_$id"}; } } elsif ($target eq "edit") { $result.= &Apache::edit::tag_end($target,$token,''); + } elsif ($target eq 'answer') { + my (@answers)=&Apache::lonxml::get_param_var('answer',$parstack, + $safeeval); + $result.=&Apache::response::answer_header('organicresponse'); + foreach my $answer (@answers) { + $result.=&Apache::response::answer_part('organicresponse',$answer); + } + $result.=&Apache::response::answer_footer('organicresponse'); + } + if ($target eq 'web') { + &Apache::response::setup_prior_tries_hash(\&format_prior_answer_organic, + ['molecule']) + } + + if ($target eq 'grade' || $target eq 'web' || $target eq 'answer' || + $target eq 'tex' || $target eq 'analyze') { + &Apache::lonxml::increment_counter(&Apache::response::repetition(), + "$partid.$id"); # part.response + if ($target eq 'analyze') { + $Apache::lonhomework::analyze{"$partid.$id.type"} = 'organicresponse'; + push (@{ $Apache::lonhomework::analyze{"parts"} },"$partid.$id"); + &Apache::lonhomework::set_bubble_lines(); + } } - &Apache::response::end_response; + if (($target eq 'web' ) && ($Apache::lonhomework::type ne 'exam') && ($Apache::inputtags::status['-1'] eq 'CAN_ANSWER')){ + my $options=&Apache::lonxml::get_param('options',$parstack, + $safeeval); + my $shown_text; + if (&Apache::response::show_answer()) { + $shown_text="Show Your Last Answer"; + } + my $molecule; + if (defined($Apache::lonhomework::history{"resource.$partid.$id.molecule"})) { + $molecule=$Apache::lonhomework::history{"resource.$partid.$id.molecule"}; + } else { + $molecule=&Apache::lonxml::get_param('molecule',$parstack, + $safeeval); + } + $result.=&separate_jme_window("HWVAL_$id","MOLECULE_$id",$molecule, + $options,$shown_text); + } + &Apache::response::end_response(); return $result; } -sub start_chemstructure { +sub format_prior_answer_organic { + my ($mode,$answer,$other_data) = @_; + my $result=&mt('Smile representation: "[_1]"',''.$answer.''); + my $jme=$other_data->[0]; + $result.=&jme_img($jme,$answer,400); + return $result; +} + +sub start_organicstructure { my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_; my $result; if ($target eq 'web') { my $width=&Apache::lonxml::get_param('width',$parstack,$safeeval); - my $height=&Apache::lonxml::get_param('height',$parstack,$safeeval); my $molecule=&Apache::lonxml::get_param('molecule',$parstack,$safeeval); - $result=< - - - -CHEMOUTPUT + my $options=&Apache::lonxml::get_param('options',$parstack,$safeeval); + my $id=&Apache::loncommon::get_cgi_id(); + $result=" &escape($molecule), + 'cgi.'.$id.'.PNG' => 1, + 'cgi.'.$id.'.WIDTH' => $width}); + } elsif ($target eq 'tex') { + my $texwidth=&Apache::lonxml::get_param('texwidth',$parstack,$safeeval,undef,1); + my $webwidth=&Apache::lonxml::get_param('width', $parstack, $safeeval); + my $webheight=&Apache::lonxml::get_param('height', $parstack, $safeeval); + if (!$webheight) { $webheight = $webwidth; } + if (!$texwidth) { $texwidth='90'; } + $result = "%DYNAMICIMAGE:$webwidth:$webheight:$texwidth\n"; + my $molecule=&Apache::lonxml::get_param('molecule',$parstack,$safeeval); + my $options=&Apache::lonxml::get_param('options',$parstack,$safeeval); + my $filename = $env{'user.name'}.'_'.$env{'user.domain'}. + '_'.time.'_'.$$.int(rand(1000)).'_organicstructure'; + my $id=$filename; + &Apache::lonnet::appenv( + {'cgi.'.$id.'.JME' => &escape($molecule), + 'cgi.'.$id.'.PS' => 1, + 'cgi.'.$id.'.WIDTH' => $texwidth}); + $id=&escape($id); + &Apache::lonxml::register_ssi("/cgi-bin/convertjme.pl?$id"); + if ($options =~ /border/) { $result.= '\fbox{'; } + $result .= '\graphicspath{{/home/httpd/perl/tmp/}}\includegraphics[width='.$texwidth.' mm]{'.$filename.'.eps}'; + if ($options =~ /border/) { $result.= '} '; } } elsif ($target eq 'edit') { $result .=&Apache::edit::tag_start($target,$token); - $result .=&Apache::edit::text_arg('Width:','width',$token,5); - $result .=&Apache::edit::text_arg('Height:','height',$token,5); + $result .=&Apache::edit::text_arg('Width (pixels):','width',$token,5); + $result .=&Apache::edit::text_arg('TeXwidth (mm):','texwidth',$token,5); + $result .=''; $result .=&Apache::edit::text_arg('Molecule:','molecule',$token,40); my $molecule=&Apache::lonxml::get_param('molecule',$parstack, $safeeval); - $result .=&seperate_jme_window(undef, - &Apache::edit::html_element_name('molecule'), - $molecule); - $result .=&Apache::edit::end_row().&Apache::edit::start_spanning_row(); + my $options=&Apache::lonxml::get_param('options',$parstack, + $safeeval); + if ($options !~ /reaction/) { + $options.= ',multipart,number'; + } + + $result .=&separate_jme_window(undef, + &Apache::edit::html_element_name('molecule'), + $molecule,$options); + $result.="
"; + $result .=&Apache::edit::checked_arg('Options:','options', + [ ['reaction','Is a reaction'], + ['border','Draw a border'] ], + $token); + $result .=&Apache::edit::end_row(); } elsif ($target eq 'modified') { my $constructtag=&Apache::edit::get_new_args($token,$parstack, $safeeval,'molecule', - 'width','height'); + 'width','texwidth', + 'options'); if ($constructtag) { $result = &Apache::edit::rebuild_tag($token); } } return $result; } -sub end_chemstructure { +sub end_organicstructure { my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_; my $result; if ($target eq "edit") { @@ -214,5 +449,178 @@ sub end_chemstructure { return $result; } +sub edit_reaction_button { + my ($id,$field,$reaction)=@_; + my $id_es=&escape($id); + my $field_es=&escape($field); + my $reaction_es=&escape($reaction); + my $docopen=&Apache::lonhtmlcommon::javascript_docopen(); + my $iconpath=$Apache::lonnet::perlvar{'lonIconsURL'}; + my $display=&mt('Edit Answer'); + my $start_page = + &Apache::loncommon::start_page('LON-CAPA Reaction Editor',undef, + {'frameset' => 1, + 'js_ready' => 1, + 'add_entries' => { + 'rows' => "30%,*", + 'border' => "0",}},); + my $end_page = + &Apache::loncommon::end_page({'frameset' => 1, + 'js_ready' => 1}); + my $result=< +// + +$display +EDITREACTION + return $result; +} + +sub start_reactionresponse { + my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_; + my $result; + my $id = &Apache::response::start_response($parstack,$safeeval); + if ($target eq 'meta') { + $result=&Apache::response::meta_package_write('reactionresponse'); + } elsif ($target eq 'web') { + my $partid = $Apache::inputtags::part; + my $id = $Apache::inputtags::response['-1']; + if ( &Apache::response::show_answer() ) { + my $ans=&Apache::lonxml::get_param('answer',$parstack,$safeeval); + if (!$Apache::lonxml::default_homework_loaded) { + &Apache::lonxml::default_homework_load($safeeval); + } + @Apache::scripttag::parser_env = @_; + $Apache::inputtags::answertxt{$id}=[&Apache::run::run("return &chemparse(q\0$ans\0);",$safeeval)]; + } + } elsif ($target eq "edit") { + $result .=&Apache::edit::tag_start($target,$token); + my $answer=&Apache::lonxml::get_param('answer',$parstack, + $safeeval); + $result .=''. + &Apache::edit::text_arg('Answer:','answer',$token,40); + $result .=&edit_reaction_button($id,&Apache::edit::html_element_name('answer'),$answer).''; + my $initial=&Apache::lonxml::get_param('initial',$parstack,$safeeval); + $result.=''. + &Apache::edit::text_arg('Initial Reaction:','initial',$token,40); + $result .=&edit_reaction_button($id,&Apache::edit::html_element_name('initial'),$initial).''; + $result .=&Apache::edit::end_row().&Apache::edit::start_spanning_row(); + } elsif ($target eq 'modified') { + my $constructtag=&Apache::edit::get_new_args($token,$parstack, + $safeeval,'answer', + 'initial'); + if ($constructtag) { $result = &Apache::edit::rebuild_tag($token); } + } + return $result; +} + +sub end_reactionresponse { + my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_; + my $result; + + my $partid = $Apache::inputtags::part; + my $id = $Apache::inputtags::response['-1']; + + if ($target eq 'grade' + && &Apache::response::submitted() + && $Apache::lonhomework::type eq 'exam') { + + &Apache::response::scored_response($partid,$id); + + } elsif ($target eq 'grade' + && &Apache::response::submitted() + && $Apache::lonhomework::type ne 'exam') { + + &Apache::response::setup_params($$tagstack[-1],$safeeval); + my $response = &Apache::response::getresponse(); + if ( $response =~ /[^\s]/) { + my (@answers)=&Apache::lonxml::get_param_var('answer',$parstack,$safeeval); + my %previous = &Apache::response::check_for_previous($response,$partid,$id); + $Apache::lonhomework::results{"resource.$partid.$id.submission"}=$response; + my $ad; + foreach my $answer (@answers) { + &Apache::lonxml::debug("submitted a $response for $answer
\n"); + if (&chem_standard_order($response) eq + &chem_standard_order($answer)) { + $ad='EXACT_ANS'; + } else { + $ad='INCORRECT'; + } + } + if ($ad && $Apache::lonhomework::type eq 'survey') { + $ad='SUBMITTED'; + } + &Apache::response::handle_previous(\%previous,$ad); + $Apache::lonhomework::results{"resource.$partid.$id.awarddetail"}=$ad; + } + } elsif ($target eq "edit") { + $result.= &Apache::edit::tag_end($target,$token,''); + } elsif ($target eq 'answer') { + my (@answers)=&Apache::lonxml::get_param_var('answer',$parstack, + $safeeval); + $result.=&Apache::response::answer_header('reactionresponse'); + foreach my $answer (@answers) { + $result.=&Apache::response::answer_part('reactionresponse', + $answer); + } + $result.=&Apache::response::answer_footer('reactionresponse'); + } + if ($target eq 'web') { + &Apache::response::setup_prior_tries_hash(\&format_prior_response_reaction); + } + + if ($target eq 'grade' || $target eq 'web' || $target eq 'answer' || + $target eq 'tex' || $target eq 'analyze') { + &Apache::lonxml::increment_counter(&Apache::response::repetition(), "$partid.$id"); + if ($target eq 'analyze') { + $Apache::lonhomework::analyze{"$partid.$id.type"} = 'reactionresponse'; + push (@{ $Apache::lonhomework::analyze{"parts"} },"$partid.$id"); + &Apache::lonhomework::set_bubble_lines(); + } + } + my $status=$Apache::inputtags::status['-1']; + if (($target eq 'web') && ($Apache::lonhomework::type ne 'exam') && ($status eq 'CAN_ANSWER')) { + my $reaction=$Apache::lonhomework::history{"resource.$partid.$id.submission"}; + if ($reaction eq '') { $reaction=&Apache::lonxml::get_param('initial',$parstack,$safeeval); } + $result.=&edit_reaction_button($id,"HWVAL_$id",$reaction); + } + &Apache::response::end_response(); + return $result; +} + +sub format_prior_response_reaction { + my ($mode,$answer) =@_; + return ''. + &HTML::Entities::encode($answer,'"<>&').''; +} + +sub start_chem { + my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style) = @_; + my $result = ''; + my $inside = &Apache::lonxml::get_all_text_unbalanced("/chem",$parser); + if ($target eq 'tex' || $target eq 'web') { + $inside=&Apache::run::evaluate($inside,$safeeval,$$parstack[-1]); + if (!$Apache::lonxml::default_homework_loaded) { + &Apache::lonxml::default_homework_load($safeeval); + } + @Apache::scripttag::parser_env = @_; + $result=&Apache::run::run("return &chemparse(q\0$inside\0);",$safeeval); + } + return $result; +} + +sub end_chem { + my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style) = @_; + my $result = ''; + return $result; +} + 1; __END__