Return to response.pm CVS log

Up to [LON-CAPA] / loncom / homework

- adding external response

    1: # The LearningOnline Network with CAPA
    2: # various response type definitons response definition
    3: #
    4: # $Id: response.pm,v 1.58 2002/01/30 17:33:15 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: # 11/23,11/24,11/28 Gerd Kortemeyer
   29: # Guy Albertelli
   30: # 08/04,08/07 Gerd Kortemeyer
   31: 
   32: package Apache::response;
   33: use strict;
   34: 
   35: BEGIN {
   36:   &Apache::lonxml::register('Apache::response',('responseparam','parameter','caparesponse','numericalresponse','formularesponse','stringresponse','radiobuttonresponse','optionresponse','imageresponse','essayresponse','dataresponse','externalresponse'));
   37: }
   38: 
   39: sub start_response {
   40:   my ($parstack,$safeeval)=@_;
   41:   my $id= &Apache::lonxml::get_param('id',$parstack,$safeeval);
   42:   if ($id eq '') { $id = $Apache::lonxml::curdepth; }
   43:   if ($#Apache::inputtags::import > -1) {
   44:     &Apache::lonxml::debug("Turning :$id: into");
   45:     $id = join('_',@Apache::inputtags::import).'_'.$id;
   46:     &Apache::lonxml::debug("New  :$id:");
   47:   }
   48:   push (@Apache::inputtags::response,$id);
   49:   push (@Apache::inputtags::responselist,$id);
   50:   @Apache::inputtags::inputlist=();
   51:   return $id;
   52: }
   53: 
   54: sub end_response {
   55:   pop @Apache::inputtags::response;
   56:   @Apache::inputtags::inputlist=();
   57:   return '';
   58: }
   59: 
   60: sub start_hintresponse {
   61:   my ($parstack,$safeeval)=@_;
   62:   my $id= &Apache::lonxml::get_param('id',$parstack,$safeeval);
   63:   if ($id eq '') { $id = $Apache::lonxml::curdepth; }
   64:   push (@Apache::inputtags::response,$id);
   65:   return $id;
   66: }
   67: 
   68: sub end_hintresponse {
   69:   pop @Apache::inputtags::response;
   70:   return '';
   71: }
   72: 
   73: # used by response to set the non-safe space random number generator to something
   74: # that is stable and unique based on the part number and response number
   75: sub setrandomnumber {
   76:   my $rndseed;
   77:   if ($ENV{'request.state'} eq "construct") {
   78:     $rndseed=$ENV{'form.rndseed'};
   79:     if (!$rndseed) { $rndseed=time; }
   80:   } else {
   81:     $rndseed=&Apache::lonnet::rndseed();
   82:   }
   83:   &Apache::lonxml::debug("randseed $rndseed");
   84: #  $rndseed=unpack("%32i",$rndseed);
   85:   $rndseed=$rndseed
   86:     +(&Apache::lonnet::numval($Apache::inputtags::part) << 10);
   87:   if (defined($Apache::inputtags::response['-1'])) {
   88:     $rndseed=$rndseed
   89:       +&Apache::lonnet::numval($Apache::inputtags::response['-1']);
   90:   }
   91:   srand($rndseed);
   92:   &Apache::lonxml::debug("randseed $rndseed");
   93:   return '';
   94: }
   95: 
   96: sub meta_parameter_write {
   97:     my ($name,$type,$default,$display)=@_;
   98:     my $partref=$Apache::inputtags::part;
   99:     my $result='<parameter part="'.$Apache::inputtags::part.'"';
  100:     if (defined($Apache::inputtags::response[-1])) {
  101:       $result.=            ' id="'.$Apache::inputtags::response[-1].'"';
  102:       $partref.='_'.$Apache::inputtags::response[-1];
  103:     }
  104:     $result.=            ' name="'.$name.'"'.
  105:                          ' type="'.$type.'"'.
  106: ($default?' default="'.$default.'"':'').
  107: ($display?' display="'.$display.' [Part: '.$partref.']"':'')
  108:              .'></parameter>'
  109:              ."\n";
  110:     return $result;
  111: }
  112: 
  113: sub meta_package_write {
  114:     my $name=shift;
  115:     my $result = '<parameter part="'.$Apache::inputtags::part.'"';
  116:     if(defined($Apache::inputtags::response[-1])) {
  117:       $result.=              ' id="'.$Apache::inputtags::response[-1].'"';
  118:     }
  119:     $result.=' package="'.$name.'"></parameter>'."\n";
  120:     return $result;
  121: }
  122: 
  123: sub meta_stores_write {
  124:     my ($name,$type,$display)=@_;
  125:     my $partref=$Apache::inputtags::part;
  126:     my $result = '<stores part="'.$Apache::inputtags::part.'"';
  127:     if (defined($Apache::inputtags::response[-1])) {
  128:       $result.=           ' id="'.$Apache::inputtags::response[-1].'"';
  129:       $partref.='_'.$Apache::inputtags::response[-1];
  130:     }	
  131:     $result.=          ' name="'.$name.'"'.
  132:                        ' type="'.$type.'"'.
  133: 	            ' display="'.$display.' [Part: '.$partref.']"'.
  134: 		      "></stores>\n";
  135: }
  136: 
  137: sub mandatory_part_meta {
  138: #
  139: # Autogenerate metadata for mandatory
  140: # input (from RAT or lonparmset) and 
  141: # output (to lonspreadsheet)
  142: # of each part
  143: #
  144:  return
  145: #    &meta_parameter_write('opendate','date_start','',
  146: #                          'Opening Date').
  147: #    &meta_parameter_write('duedate','date_end','',
  148: #                          'Due Date').
  149: #    &meta_parameter_write('answerdate','date_start','',
  150: #                          'Show Answer Date').
  151: #    &meta_parameter_write('weight','int_zeropos','',
  152: #                          'Available Points').
  153: #    &meta_parameter_write('maxtries','int_pos','',
  154: #                          'Maximum Number of Tries').
  155:     &meta_package_write('part').
  156:     &meta_stores_write('solved','string',
  157:                           'Problem Status').
  158:     &meta_stores_write('tries','int_zeropos',
  159:                           'Number of Attempts').
  160:     &meta_stores_write('awarded','float',
  161: 		          'Partial Credit Factor');
  162: #
  163: # Note: responseid-specific data 'submission' and 'awarddetail'
  164: # not available to spreadsheet -> skip here
  165: #
  166: }
  167: 
  168: sub check_for_previous {
  169:   my ($curresponse,$partid,$id) = @_;
  170:   my %previous;
  171:   $previous{'used'} = 0;
  172:   foreach my $key (reverse(sort(keys(%Apache::lonhomework::history)))) {
  173:     if ($key =~ /resource\.$partid\.$id\.submission/) {
  174:       &Apache::lonxml::debug("Trying $key");
  175:       my $pastresponse=$Apache::lonhomework::history{$key};
  176:       if ($pastresponse eq $curresponse) {
  177: 	$previous{'used'} = 1;
  178: 	my $history;
  179: 	if ( $key =~ /^(\d+):/ ) {
  180: 	  $history=$1;
  181: 	  $previous{'award'} = $Apache::lonhomework::history{"$history:resource.$partid.$id.awarddetail"};
  182: 	  $previous{'last'}='0';
  183: 	} else {
  184: 	  $previous{'award'} = $Apache::lonhomework::history{"resource.$partid.$id.awarddetail"};
  185: 	  $previous{'last'}='1';
  186: 	}
  187: 	if (! $previous{'award'} ) { $previous{'award'} = 'UNKNOWN';	}
  188: 	&Apache::lonxml::debug("got a match :$previous{'award'}:$previous{'used'}:");
  189: 	last;
  190:       }
  191:     }
  192:   }
  193:   return %previous;
  194: }
  195: 
  196: sub handle_previous {
  197:   my ($previous,$ad)=@_;
  198:   if ($$previous{'used'} && ($$previous{'award'} eq $ad) ) {
  199:     if ($$previous{'last'}) {
  200:       push(@Apache::inputtags::previous,'PREVIOUSLY_LAST');
  201:     } else {
  202:       push(@Apache::inputtags::previous,'PREVIOUSLY_USED');
  203:     }
  204:   }
  205: }
  206: 
  207: sub start_caparesponse {
  208:   require Apache::caparesponse; 
  209:   import Apache::caparesponse; 
  210:   my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
  211: #  print "\n<br />\nsimple caparesponse\n";
  212:   return &Apache::caparesponse::start_caparesponse($target,$token,$tagstack,$parstack,$parser,$safeeval,$style);
  213: }
  214: 
  215: sub start_stringresponse {
  216:   require Apache::caparesponse;
  217:   import Apache::caparesponse;
  218:   my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
  219:   return &Apache::caparesponse::start_stringresponse($target,$token,$tagstack,$parstack,$parser,$safeeval,$style);
  220: }
  221: 
  222: sub start_formularesponse {
  223:   require Apache::caparesponse;
  224:   import Apache::caparesponse;
  225:   my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
  226:   return &Apache::caparesponse::start_formularesponse($target,$token,$tagstack,$parstack,$parser,$safeeval,$style);
  227: }
  228: 
  229: sub start_numericalresponse {
  230:   require Apache::caparesponse; 
  231:   import Apache::caparesponse; 
  232:   my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
  233:   return &Apache::caparesponse::start_numericalresponse
  234:     ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style);
  235: }
  236: 
  237: sub start_radiobuttonresponse {
  238:   require Apache::radiobuttonresponse; 
  239:   import Apache::radiobuttonresponse; 
  240:   my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
  241:   return &Apache::radiobuttonresponse::start_radiobuttonresponse($target,$token,$tagstack,$parstack,$parser,$safeeval,$style);
  242: }
  243: 
  244: sub start_optionresponse {
  245:   require Apache::optionresponse; 
  246:   import Apache::optionresponse; 
  247:   my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
  248:   return &Apache::optionresponse::start_optionresponse($target,$token,$tagstack,$parstack,$parser,$safeeval,$style);
  249: }
  250: 
  251: sub start_imageresponse {
  252:   require Apache::imageresponse; 
  253:   import Apache::imageresponse; 
  254:   my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
  255:   return &Apache::imageresponse::start_imageresponse($target,$token,$tagstack,$parstack,$parser,$safeeval,$style);
  256: }
  257: 
  258: sub start_essayresponse {
  259:   require Apache::essayresponse; 
  260:   import Apache::essayresponse; 
  261:   my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
  262:   return &Apache::essayresponse::start_essayresponse($target,$token,$tagstack,$parstack,$parser,$safeeval,$style);
  263: }
  264: 
  265: sub start_externalresponse {
  266:   require Apache::externalresponse; 
  267:   import Apache::externalresponse; 
  268:   my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
  269:   return &Apache::externalresponse::start_externalresponse($target,$token,$tagstack,$parstack,$parser,$safeeval,$style);
  270: }
  271: 
  272: sub view_or_modify {
  273:   my ($symb,$courseid,$domain,$name) = &Apache::lonxml::whichuser();
  274:   my $myself=0;
  275:   if ( ($name eq $ENV{'user.name'}) && ($domain eq $ENV{'user.domain'}) ) {
  276:     $myself=1;
  277:   }
  278:   my $vgr=&Apache::lonnet::allowed('vgr',$courseid);
  279:   my $mgr=&Apache::lonnet::allowed('vgr',$courseid);
  280:   if ($mgr) { return "M"; }
  281:   if ($vgr) { return "V"; }
  282:   if ($myself) { return "V"; }
  283:   return '';
  284: }
  285: 
  286: sub start_dataresponse {
  287:   my ($target,$token,$tagstack,$parstack,$parser,$safeeval)=@_;
  288:   my $id = &Apache::response::start_response($parstack,$safeeval);
  289:   my $result;
  290:   if ($target eq 'web') {
  291:     $result = $token->[2]->{'display'}.':';
  292:   } elsif ($target eq 'meta') {
  293:     $result = &Apache::response::meta_stores_write($token->[2]->{'name'},
  294: 						   $token->[2]->{'type'},
  295: 						   $token->[2]->{'display'});
  296:     $result .= &Apache::response::meta_package_write('dataresponse');
  297:   }
  298:   return $result;
  299: }
  300: 
  301: sub end_dataresponse {
  302:   my ($target,$token,$tagstack,$parstack,$parser,$safeeval)=@_;
  303:   my $result;
  304:   if ( $target eq 'web' ) {
  305:   } elsif ($target eq 'grade' ) {
  306:     if ( defined $ENV{'form.submitted'}) {
  307:       my ($symb,$courseid,$domain,$name)=&Apache::lonxml::whichuser();
  308:       my $allowed=&Apache::lonnet::allowed('mgr',$courseid);
  309:       if ($allowed) {
  310: 	&Apache::response::setup_params('datasubmission');
  311: 	my $partid = $Apache::inputtags::part;
  312: 	my $id = $Apache::inputtags::response['-1'];
  313: 	my $response = $ENV{'form.HWVAL'.$id};
  314: 	my $name = &Apache::lonxml::get_param('name',$parstack,$safeeval);
  315: 	if ( $response =~ /[^\s]/) {
  316: 	  $Apache::lonhomework::results{"resource.$partid.$id.$name"}=
  317: 	    $response;
  318: 	  $Apache::lonhomework::results{
  319: 					"resource.$partid.$id.submission"}=
  320: 					  $response;
  321: 	  $Apache::lonhomework::results{
  322: 					"resource.$partid.$id.awarddetail"}=
  323: 					  'SUBMITTED';
  324: 	}
  325:       } else {
  326: 	$result='Not Permitted to change values.'
  327:       }
  328:     }
  329:   }
  330:   &Apache::response::end_response;
  331:   return $result;
  332: }
  333: 
  334: sub start_responseparam {
  335:   my ($target,$token,$tagstack,$parstack,$parser,$safeeval)=@_;
  336:   my $result='';
  337:   if ($target eq 'meta') {
  338:     $result = &meta_parameter_write($token->[2]->{'name'},
  339: 				    $token->[2]->{'type'},
  340: 				    $token->[2]->{'default'},
  341: 				    $token->[2]->{'description'});
  342:   } elsif ($target eq 'edit') {
  343:     $result.=&Apache::edit::tag_start($target,$token);
  344:     $result.=&Apache::edit::text_arg('Name:','name',$token).
  345:       &Apache::edit::text_arg('Type:','type',$token).
  346: 	&Apache::edit::text_arg('Description:','description',$token).
  347: 	  &Apache::edit::text_arg('Default:','default',$token).
  348: 	    "</td></tr>";
  349:     $result.=&Apache::edit::end_table;
  350:   } elsif ($target eq 'modified') {
  351:     my $constructtag=&Apache::edit::get_new_args($token,$parstack,$safeeval,
  352: 						 'name','type','description',
  353: 						 'default');
  354:     if ($constructtag) {
  355:       $result = &Apache::edit::rebuild_tag($token);
  356:       $result.=&Apache::edit::handle_insert();
  357:     }
  358:   } elsif ($target eq 'grade') {
  359:     if ($ENV{'request.state'} eq 'construct') {
  360:       my $name    = &Apache::lonxml::get_param('name',$parstack,$safeeval);
  361:       my $default = &Apache::lonxml::get_param('default',$parstack,$safeeval);
  362:       $Apache::inputtags::params{$name}=$default;
  363:     }
  364:   }
  365:   return $result;
  366: }
  367: 
  368: sub end_responseparam {
  369:   my ($target,$token,$tagstack,$parstack,$parser,$safeeval)=@_;
  370:   if ($target eq 'edit') { return ('','no'); }
  371:   return '';
  372: }
  373: 
  374: sub start_parameter {
  375:   my $result = &start_responseparam(@_);
  376:   return $result;
  377: }
  378: 
  379: sub end_parameter {
  380:   my $result = &end_responseparam(@_);
  381:   return $result;
  382: }
  383: 
  384: sub setup_params {
  385:   my ($tag) = @_;
  386: 
  387:   if ($ENV{'request.state'} eq 'construct') { return; }
  388:   @Apache::inputtags::params=();
  389:   my %paramlist=();
  390:   foreach my $key (keys(%Apache::lonnet::packagetab)) {
  391:     if ($key =~ /^$tag/) {
  392:       my ($package,$name) = split(/&/,$key);
  393:       $paramlist{$name}=1;
  394:     }
  395:   }
  396:   foreach my $key (keys(%paramlist)) {
  397:     my $entry= 'resource.'.$Apache::inputtags::part;
  398:     if (defined($Apache::inputtags::response[-1])) {
  399:       $entry.='_'.$Apache::inputtags::response[-1];
  400:     }
  401:     $entry.='.'.$key;
  402:     &Apache::lonxml::debug("looking for $entry");
  403:     my $value = &Apache::lonnet::EXT("$entry");
  404:     &Apache::lonxml::debug("$key has value :$value:");
  405:     if ($value eq 'con_lost' || $value =~ /^error:/) {
  406:       &Apache::lonxml::debug("using nothing");
  407:       $Apache::inputtags::params{$key}='';
  408:     } else {
  409:       &Apache::lonxml::debug("using value");
  410:       $Apache::inputtags::params{$key}=$value;
  411:     }
  412:   }
  413: }
  414: 
  415: sub answer_header {
  416:   my ($type) = @_;
  417:   my $result;
  418:   if ($type eq 'optionresponse' || $type eq 'radiobuttonresponse' ) {
  419:     $result = '<table border="1"><tr><th>Answer for Part:'.
  420:       $Apache::inputtags::part. '</th></tr><tr>'."\n";
  421:   } else {
  422:     $result = '<table border="1"><tr><td>Answer for Part:'.
  423:       $Apache::inputtags::part. '</td>'."\n";
  424:   }
  425:   return $result;
  426: }
  427: 
  428: sub answer_part {
  429:   my ($type,$answer) = @_;
  430:   my $result;
  431:   if ($type eq 'optionresponse' || $type eq 'radiobuttonresponse') {
  432:     $result = '<td>'.$answer.'</td>';
  433:   } else {
  434:     $result = '<td>'.$answer.'</td>';
  435:   }
  436:   return $result;
  437: }
  438: 
  439: sub answer_footer {
  440:   my ($type) = @_;
  441:   my $result;
  442:   if ($type eq 'optionresponse' || $type eq 'radiobuttonresponse') {
  443:     $result = '</tr></table>';
  444:   } else {
  445:     $result = '</tr></table>';
  446:   }
  447:   return $result;
  448: }
  449: 
  450: 1;
  451: __END__
  452: