1: # The LearningOnline Network with CAPA
2: # chemical equation style response
3: #
4: # $Id: chemresponse.pm,v 1.51 2005/04/22 14:10:47 albertel Exp $
5: #
6: # Copyright Michigan State University Board of Trustees
7: #
8: # This file is part of the LearningOnline Network with CAPA (LON-CAPA).
9: #
10: # LON-CAPA is free software; you can redistribute it and/or modify
11: # it under the terms of the GNU General Public License as published by
12: # the Free Software Foundation; either version 2 of the License, or
13: # (at your option) any later version.
14: #
15: # LON-CAPA is distributed in the hope that it will be useful,
16: # but WITHOUT ANY WARRANTY; without even the implied warranty of
17: # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18: # GNU General Public License for more details.
19: #
20: # You should have received a copy of the GNU General Public License
21: # along with LON-CAPA; if not, write to the Free Software
22: # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
23: #
24: # /home/httpd/html/adm/gpl.txt
25: #
26: # http://www.lon-capa.org/
27: #
28: #
29: package Apache::chemresponse;
30: use strict;
31: use Apache::lonxml;
32: use Apache::lonnet;
33:
34: BEGIN {
35: &Apache::lonxml::register('Apache::chemresponse',('organicresponse','organicstructure','reactionresponse','chem'));
36: }
37:
38: sub chem_standard_order {
39: my ($reaction) = @_;
40: my ($re,$pr) = split(/->|<=>/,$reaction);
41: my @reactants = split(/\s\+/,$re);
42: my @products = split(/\s\+/,$pr);
43: foreach my $substance (@reactants,@products) {
44: $substance =~ s/(\^\d*)\s+/$1_/g; # protect superscript space
45: $substance =~ s/\s*//g; # strip whitespace
46: $substance =~ s/_/ /g; # restore superscript space
47: }
48: @reactants = sort @reactants;
49: @products = sort @products;
50: my $standard = '';
51: foreach my $substance (@reactants) {
52: $standard .= $substance;
53: $standard .= ' + ';
54: }
55: $standard =~ s/ \+ $//; # get rid of trailing plus sign
56: $standard .= ' -> ';
57: foreach my $substance (@products) {
58: $standard .= $substance;
59: $standard .= ' + ';
60: }
61: $standard =~ s/ \+ $//; # get rid of trailing plus sign
62: return $standard;
63: }
64:
65: sub separate_jme_window {
66: my ($smile_input,$jme_input,$molecule,$options)=@_;
67: my $smilesection;
68: if (defined($smile_input)) {
69: $smilesection=<<SMILESECTION;
70: smiles = document.applets.JME.smiles();
71: opener.document.lonhomework.$smile_input.value = smiles;
72: SMILESECTION
73: }
74: my $jmesection;
75: if (defined($jme_input)) {
76: $jmesection=<<JMESECTION;
77: jmeFile = document.applets.JME.jmeFile();
78: opener.document.lonhomework.$jme_input.value = jmeFile;
79: JMESECTION
80: }
81:
82: if ($molecule) { $molecule='<param name="jme" value="'.$molecule.'" />'; }
83: my $body=<<CHEMPAGE;
84: <html>
85: <head>
86: <title>Molecule Editor</title>
87: <script type="text/javascript">
88: function submitSmiles() {
89: jmeFile = document.applets.JME.jmeFile();
90: if (jmeFile == "") {
91: alert("Nothing to submit");
92: } else {
93: $jmesection
94: $smilesection
95: window.close();
96: }
97: }
98: function openHelpWindow() {
99: window.open("/adm/jme/jme_help.html","","scrollbars=yes,resizable=yes,width=500,height=600");
100: }
101: </script>
102: </head>
103: <body bgcolor="#ffffff">
104: <center>
105: <applet code="JME.class" name="JME" archive="/adm/jme/JME.jar" width="440" height="390">
106: You have to enable Java and JavaScript on your machine.
107: $molecule
108: <param name="options" value="$options" />
109: </applet><br />
110: <font face="arial,helvetica,sans-serif" size="-1"><a href="http://www.molinspiration.com/jme/index.html">JME Editor</a> courtesy of Peter Ertl, Novartis</font>
111: <form>
112: <input type="button" name="submit" value="Insert Answer" onclick = "submitSmiles();" />
113: <br />
114: <input type="button" value=" Close " onclick = "window.close()" />
115:
116: <input type="button" value=" Help " onclick = "openHelpWindow()" />
117: </form>
118: </center>
119: </body>
120: </html>
121: CHEMPAGE
122: $body=&HTML::Entities::encode($body,'<>&"');
123: $body=~s/\n/ /g;
124: my $docopen=&Apache::lonhtmlcommon::javascript_docopen();
125: my $result=<<CHEMINPUT;
126: <input type="button" value="Draw Molecule" onclick="javascript:editor=window.open('/rat/adm/empty.html','jmeedit','width=500,height=500,menubar=yes,scrollbars=no,resizable=yes');editor.$docopen;editor.document.write('$body');editor.document.close();editor.focus()" />
127: CHEMINPUT
128: return $result;
129: }
130:
131: sub start_organicresponse {
132: my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
133: my $result;
134: my $partid = $Apache::inputtags::part;
135: my $id = &Apache::response::start_response($parstack,$safeeval);
136: if ($target eq 'meta') {
137: $result=&Apache::response::meta_package_write('organicresponse');
138: } elsif ($target eq 'web') {
139: if ( &Apache::response::show_answer() ) {
140: my $jmeanswer=&Apache::lonxml::get_param('jmeanswer',$parstack,
141: $safeeval);
142: my $options=&Apache::lonxml::get_param('options',$parstack,
143: $safeeval);
144: my $width=&Apache::lonxml::get_param('width',$parstack,
145: $safeeval);
146: my $id=&Apache::loncommon::get_cgi_id();
147: $result="<img src='/cgi-bin/convertjme.pl?$id'";
148: if ($options =~ /border/) { $result.= ' border="1"'; }
149: $result.=' />';
150: &Apache::lonnet::appenv('cgi.'.$id.'.JME' =>
151: &Apache::lonnet::escape($jmeanswer),
152: 'cgi.'.$id.'.PNG' => 1,
153: 'cgi.'.$id.'.WIDTH' => $width);
154: } else {
155: my $molecule;
156: if (defined($Apache::lonhomework::history{"resource.$partid.$id.molecule"})) {
157: $molecule=$Apache::lonhomework::history{"resource.$partid.$id.molecule"};
158: } else {
159: $molecule=&Apache::lonxml::get_param('molecule',$parstack,
160: $safeeval);
161: }
162: my $options=&Apache::lonxml::get_param('options',$parstack,
163: $safeeval);
164: $result=&separate_jme_window("HWVAL_$id","MOLECULE_$id",$molecule,$options);
165: $result.= '<input type="hidden" name="MOLECULE_'.$id.'" value="" />';
166: }
167: } elsif ($target eq 'edit') {
168: $result .=&Apache::edit::tag_start($target,$token);
169: my $options=&Apache::lonxml::get_param('options',$parstack,
170: $safeeval);
171: if ($options !~ /multipart/) { $options.=',multipart'; }
172: $result .='<nobr>'.
173: &Apache::edit::text_arg('Starting Molecule:','molecule',
174: $token,40);
175: my $molecule=&Apache::lonxml::get_param('molecule',$parstack,
176: $safeeval);
177: $result .=&separate_jme_window(undef,
178: &Apache::edit::html_element_name('molecule'),
179: $molecule,$options);
180: $result .='</nobr><br /><nobr>';
181: $result .=&Apache::edit::text_arg('Correct Answer:','answer',
182: $token,40);
183: $result .=&Apache::edit::hidden_arg('jmeanswer',$token);
184: my $jmeanswer=&Apache::lonxml::get_param('jmeanswer',$parstack,
185: $safeeval);
186: $result .=&separate_jme_window(
187: &Apache::edit::html_element_name('answer'),
188: &Apache::edit::html_element_name('jmeanswer'),
189: $jmeanswer,$options);
190: $result .='</nobr><br />';
191: $result .=&Apache::edit::checked_arg('Options:','options',
192: [ ['autoez','Auto E,Z stereochemistry'],
193: ['multipart','Multipart Structures'],
194: ['nostereo','No stereochemistry'],
195: ['reaction','Is a reaction'],
196: ['number','Able to number atoms'] ],
197: ,$token);
198: $result .=&Apache::edit::text_arg('Width of correct answer image:',
199: 'width',$token,10);
200: $result .=&Apache::edit::end_row().&Apache::edit::start_spanning_row();
201: } elsif ($target eq 'modified') {
202: my $constructtag=&Apache::edit::get_new_args($token,$parstack,
203: $safeeval,'molecule',
204: 'answer','jmeanswer',
205: 'options','width');
206: if ($constructtag) { $result = &Apache::edit::rebuild_tag($token); }
207: }
208: return $result;
209: }
210:
211: sub end_organicresponse {
212: my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
213: my $result;
214: if ($target eq 'grade' && &Apache::response::submitted()) {
215: &Apache::response::setup_params($$tagstack[-1],$safeeval);
216: my $response = &Apache::response::getresponse();
217: if ( $response =~ /[^\s]/) {
218: my $partid = $Apache::inputtags::part;
219: my $id = $Apache::inputtags::response['-1'];
220: my (@answers)=&Apache::lonxml::get_param_var('answer',$parstack,$safeeval);
221: my %previous = &Apache::response::check_for_previous($response,$partid,$id);
222: $Apache::lonhomework::results{"resource.$partid.$id.submission"}=$response;
223: my $ad;
224: foreach my $answer (@answers) {
225: &Apache::lonxml::debug("submitted a $response for $answer<br \>\n");
226: if ($response eq $answer) {
227: $ad='EXACT_ANS';
228: last;
229: } else {
230: $ad='INCORRECT';
231: }
232: }
233: if ($ad && $Apache::lonhomework::type eq 'survey') {
234: $ad='SUBMITTED';
235: }
236: &Apache::response::handle_previous(\%previous,$ad);
237: $Apache::lonhomework::results{"resource.$partid.$id.awarddetail"}=$ad;
238: $Apache::lonhomework::results{"resource.$partid.$id.molecule"}=$env{"form.MOLECULE_$id"};
239: }
240: } elsif ($target eq "edit") {
241: $result.= &Apache::edit::tag_end($target,$token,'');
242: } elsif ($target eq 'answer') {
243: my (@answers)=&Apache::lonxml::get_param_var('answer',$parstack,
244: $safeeval);
245: $result.=&Apache::response::answer_header('organicresponse');
246: foreach my $answer (@answers) {
247: $result.=&Apache::response::answer_part('organicresponse',$answer);
248: }
249: $result.=&Apache::response::answer_footer('organicresponse');
250: }
251: &Apache::response::end_response;
252: return $result;
253: }
254:
255: sub start_organicstructure {
256: my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
257: my $result;
258: if ($target eq 'web') {
259: my $width=&Apache::lonxml::get_param('width',$parstack,$safeeval);
260: my $molecule=&Apache::lonxml::get_param('molecule',$parstack,$safeeval);
261: my $options=&Apache::lonxml::get_param('options',$parstack,$safeeval);
262: my $id=&Apache::loncommon::get_cgi_id();
263: $result="<img src='/cgi-bin/convertjme.pl?$id'";
264: if ($options =~ /border/) { $result.= ' border="1"'; }
265: $result.=' />';
266: &Apache::lonnet::appenv(
267: 'cgi.'.$id.'.JME' => &Apache::lonnet::escape($molecule),
268: 'cgi.'.$id.'.PNG' => 1,
269: 'cgi.'.$id.'.WIDTH' => $width );
270: } elsif ($target eq 'tex') {
271: my $texwidth=&Apache::lonxml::get_param('texwidth',$parstack,$safeeval,undef,1);
272: if (!$texwidth) { $texwidth='90'; }
273: my $molecule=&Apache::lonxml::get_param('molecule',$parstack,$safeeval);
274: my $options=&Apache::lonxml::get_param('options',$parstack,$safeeval);
275: my $filename = $env{'user.name'}.'_'.$env{'user.domain'}.
276: '_'.time.'_'.$$.int(rand(1000)).'_organicstructure';
277: my $id=$filename;
278: &Apache::lonnet::appenv(
279: 'cgi.'.$id.'.JME' => &Apache::lonnet::escape($molecule),
280: 'cgi.'.$id.'.PS' => 1,
281: 'cgi.'.$id.'.WIDTH' => $texwidth );
282: $id=&Apache::lonnet::escape($id);
283: &Apache::lonxml::register_ssi("/cgi-bin/convertjme.pl?$id");
284: if ($options =~ /border/) { $result.= '\fbox{'; }
285: $result .= '\graphicspath{{/home/httpd/perl/tmp/}}\includegraphics[width='.$texwidth.' mm]{'.$filename.'.eps}';
286: if ($options =~ /border/) { $result.= '} '; }
287: } elsif ($target eq 'edit') {
288: $result .=&Apache::edit::tag_start($target,$token);
289: $result .=&Apache::edit::text_arg('Width (pixels):','width',$token,5);
290: $result .=&Apache::edit::text_arg('TeXwidth (mm):','texwidth',$token,5);
291: $result .='<nobr>';
292: $result .=&Apache::edit::text_arg('Molecule:','molecule',$token,40);
293: my $molecule=&Apache::lonxml::get_param('molecule',$parstack,
294: $safeeval);
295: my $options=&Apache::lonxml::get_param('options',$parstack,
296: $safeeval);
297: if ($options !~ /reaction/) {
298: $options.= ',multipart,number';
299: }
300:
301: $result .=&separate_jme_window(undef,
302: &Apache::edit::html_element_name('molecule'),
303: $molecule,$options);
304: $result.="</nobr><br />";
305: $result .=&Apache::edit::checked_arg('Options:','options',
306: [ ['reaction','Is a reaction'],
307: ['border','Draw a border'] ],
308: $token);
309: $result .=&Apache::edit::end_row();
310: } elsif ($target eq 'modified') {
311: my $constructtag=&Apache::edit::get_new_args($token,$parstack,
312: $safeeval,'molecule',
313: 'width','texwidth',
314: 'options');
315: if ($constructtag) { $result = &Apache::edit::rebuild_tag($token); }
316: }
317: return $result;
318: }
319:
320: sub end_organicstructure {
321: my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
322: my $result;
323: if ($target eq "edit") {
324: $result.= &Apache::edit::tag_end($target,$token,'');
325: }
326: return $result;
327: }
328:
329: sub edit_reaction_button {
330: my ($id,$field,$reaction)=@_;
331: my $id_es=&Apache::lonnet::escape($id);
332: my $field_es=&Apache::lonnet::escape($field);
333: my $reaction_es=&Apache::lonnet::escape($reaction);
334: my $docopen=&Apache::lonhtmlcommon::javascript_docopen();
335: my $result=<<EDITREACTION;
336: <script type="text/javascript">
337: // <!--
338: function create_reaction_window_${id}_${field} () {
339: editor=window.open('','','width=500,height=270,scrollbars=no,resizable=yes');
340: editor.$docopen;
341: editor.document.writeln('<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML//EN"><html> <head><title>LON-CAPA Reaction Editor</title></head><frameset rows="30%,*" border="0"> <frame src="/res/adm/pages/reactionresponse/reaction_viewer.html?inhibitmenu=yes" name="viewer" scrolling="no" /> <frame src="/res/adm/pages/reactionresponse/reaction_editor.html?inhibitmenu=yes&reaction=$reaction_es&id=$id_es&field=$field_es" name="editor" scrolling="no" /> </frameset> </html>');
342: }
343: // -->
344: </script>
345: <input type='button' value='Edit Answer' onclick="javascript:create_reaction_window_${id}_${field}();void(0);" />
346: EDITREACTION
347: return $result;
348: }
349:
350: sub start_reactionresponse {
351: my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
352: my $result;
353: my $id = &Apache::response::start_response($parstack,$safeeval);
354: if ($target eq 'meta') {
355: $result=&Apache::response::meta_package_write('reactionresponse');
356: } elsif ($target eq 'web') {
357: my $partid = $Apache::inputtags::part;
358: my $id = $Apache::inputtags::response['-1'];
359: my $reaction=$Apache::lonhomework::history{"resource.$partid.$id.submission"};
360: if ($reaction eq '') { $reaction=&Apache::lonxml::get_param('initial',$parstack,$safeeval); }
361: my $status=$Apache::inputtags::status['-1'];
362: if ($status eq 'CAN_ANSWER') {
363: $result.=&edit_reaction_button($id,"HWVAL_$id",$reaction);
364: }
365: if ( &Apache::response::show_answer() ) {
366: my $ans=&Apache::lonxml::get_param('answer',$parstack,$safeeval);
367: if (!$Apache::lonxml::default_homework_loaded) {
368: &Apache::lonxml::default_homework_load($safeeval);
369: }
370: @Apache::scripttag::parser_env = @_;
371: $Apache::inputtags::answertxt{$id}=&Apache::run::run("return &chemparse(q\0$ans\0);",$safeeval);
372: }
373: } elsif ($target eq "edit") {
374: $result .=&Apache::edit::tag_start($target,$token);
375: my $answer=&Apache::lonxml::get_param('answer',$parstack,
376: $safeeval);
377: $result .='<nobr>'.
378: &Apache::edit::text_arg('Answer:','answer',$token,40);
379: $result .=&edit_reaction_button($id,&Apache::edit::html_element_name('answer'),$answer).'</nobr>';
380: my $initial=&Apache::lonxml::get_param('initial',$parstack,$safeeval);
381: $result.='<nobr>'.
382: &Apache::edit::text_arg('Initial Reaction:','initial',$token,40);
383: $result .=&edit_reaction_button($id,&Apache::edit::html_element_name('initial'),$initial).'</nobr>';
384:
385: $result .=&Apache::edit::end_row().&Apache::edit::start_spanning_row();
386: } elsif ($target eq 'modified') {
387: my $constructtag=&Apache::edit::get_new_args($token,$parstack,
388: $safeeval,'answer',
389: 'initial');
390: if ($constructtag) { $result = &Apache::edit::rebuild_tag($token); }
391: }
392: return $result;
393: }
394:
395: sub end_reactionresponse {
396: my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
397: my $result;
398: if ($target eq 'grade' && &Apache::response::submitted()) {
399: &Apache::response::setup_params($$tagstack[-1],$safeeval);
400: my $response = &Apache::response::getresponse();
401: if ( $response =~ /[^\s]/) {
402: my $partid = $Apache::inputtags::part;
403: my $id = $Apache::inputtags::response['-1'];
404: my (@answers)=&Apache::lonxml::get_param_var('answer',$parstack,$safeeval);
405: my %previous = &Apache::response::check_for_previous($response,$partid,$id);
406: $Apache::lonhomework::results{"resource.$partid.$id.submission"}=$response;
407: my $ad;
408: foreach my $answer (@answers) {
409: &Apache::lonxml::debug("submitted a $response for $answer<br \>\n");
410: if (&chem_standard_order($response) eq
411: &chem_standard_order($answer)) {
412: $ad='EXACT_ANS';
413: } else {
414: $ad='INCORRECT';
415: }
416: }
417: if ($ad && $Apache::lonhomework::type eq 'survey') {
418: $ad='SUBMITTED';
419: }
420: &Apache::response::handle_previous(\%previous,$ad);
421: $Apache::lonhomework::results{"resource.$partid.$id.awarddetail"}=$ad;
422: }
423: } elsif ($target eq "edit") {
424: $result.= &Apache::edit::tag_end($target,$token,'');
425: } elsif ($target eq 'answer') {
426: my (@answers)=&Apache::lonxml::get_param_var('answer',$parstack,
427: $safeeval);
428: $result.=&Apache::response::answer_header('reactionresponse');
429: foreach my $answer (@answers) {
430: $result.=&Apache::response::answer_part('reactionresponse',
431: $answer);
432: }
433: $result.=&Apache::response::answer_footer('reactionresponse');
434: }
435: &Apache::response::end_response;
436: return $result;
437: }
438:
439: sub start_chem {
440: my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style) = @_;
441: my $result = '';
442: my $inside = &Apache::lonxml::get_all_text_unbalanced("/chem",$parser);
443: if ($target eq 'tex' || $target eq 'web') {
444: $inside=&Apache::run::evaluate($inside,$safeeval,$$parstack[-1]);
445: if (!$Apache::lonxml::default_homework_loaded) {
446: &Apache::lonxml::default_homework_load($safeeval);
447: }
448: @Apache::scripttag::parser_env = @_;
449: $result=&Apache::run::run("return &chemparse(q\0$inside\0);",$safeeval);
450: }
451: return $result;
452: }
453:
454: sub end_chem {
455: my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style) = @_;
456: my $result = '';
457: return $result;
458: }
459:
460: 1;
461: __END__
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>