# The LearningOnline Network with CAPA
# various response type definitons response definition
#
# $Id: response.pm,v 1.55 2002/01/07 18:03:03 albertel Exp $
#
# Copyright Michigan State University Board of Trustees
#
# This file is part of the LearningOnline Network with CAPA (LON-CAPA).
#
# LON-CAPA is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# LON-CAPA is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with LON-CAPA; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
#
# /home/httpd/html/adm/gpl.txt
#
# http://www.lon-capa.org/
#
# 11/23,11/24,11/28 Gerd Kortemeyer
# Guy Albertelli
# 08/04,08/07 Gerd Kortemeyer

package Apache::response;
use strict;

sub BEGIN {
  &Apache::lonxml::register('Apache::response',('responseparam','parameter','caparesponse','numericalresponse','formularesponse','stringresponse','radiobuttonresponse','optionresponse','imageresponse','essayresponse','dataresponse'));
}

sub start_response {
  my ($parstack,$safeeval)=@_;
  my $id= &Apache::lonxml::get_param('id',$parstack,$safeeval);
  if ($id eq '') { $id = $Apache::lonxml::curdepth; }
  if ($#Apache::inputtags::import > -1) {
    &Apache::lonxml::debug("Turning :$id: into");
    $id = join('_',@Apache::inputtags::import).'_'.$id;
    &Apache::lonxml::debug("New  :$id:");
  }
  push (@Apache::inputtags::response,$id);
  push (@Apache::inputtags::responselist,$id);
  @Apache::inputtags::inputlist=();
  return $id;
}

sub end_response {
  pop @Apache::inputtags::response;
  @Apache::inputtags::inputlist=();
  return '';
}

sub start_hintresponse {
  my ($parstack,$safeeval)=@_;
  my $id= &Apache::lonxml::get_param('id',$parstack,$safeeval);
  if ($id eq '') { $id = $Apache::lonxml::curdepth; }
  push (@Apache::inputtags::response,$id);
  return $id;
}

sub end_hintresponse {
  pop @Apache::inputtags::response;
  return '';
}

# used by response to set the non-safe space random number generator to something
# that is stable and unique based on the part number and response number
sub setrandomnumber {
  my $rndseed;
  if ($ENV{'request.state'} eq "construct") {
    $rndseed=$ENV{'form.rndseed'};
    if (!$rndseed) { $rndseed=time; }
  } else {
    $rndseed=&Apache::lonnet::rndseed();
  }
  &Apache::lonxml::debug("randseed $rndseed");
#  $rndseed=unpack("%32i",$rndseed);
  $rndseed=$rndseed
    +(&Apache::lonnet::numval($Apache::inputtags::part) << 10);
  if (defined($Apache::inputtags::response['-1'])) {
    $rndseed=$rndseed
      +&Apache::lonnet::numval($Apache::inputtags::response['-1']);
  }
  srand($rndseed);
  &Apache::lonxml::debug("randseed $rndseed");
  return '';
}

sub meta_parameter_write {
    my ($name,$type,$default,$display)=@_;
    my $partref=$Apache::inputtags::part;
    my $result='<parameter part="'.$Apache::inputtags::part.'"';
    if (defined($Apache::inputtags::response[-1])) {
      $result.=            ' id="'.$Apache::inputtags::response[-1].'"';
      $partref.='_'.$Apache::inputtags::response[-1];
    }
    $result.=            ' name="'.$name.'"'.
                         ' type="'.$type.'"'.
($default?' default="'.$default.'"':'').
($display?' display="'.$display.' [Part: '.$partref.']"':'')
             .'></parameter>'
             ."\n";
    return $result;
}

sub meta_package_write {
    my $name=shift;
    my $result = '<parameter part="'.$Apache::inputtags::part.'"';
    if(defined($Apache::inputtags::response[-1])) {
      $result.=              ' id="'.$Apache::inputtags::response[-1].'"';
    }
    $result.=' package="'.$name.'"></parameter>'."\n";
    return $result;
}

sub meta_stores_write {
    my ($name,$type,$display)=@_;
    my $partref=$Apache::inputtags::part;
    my $result = '<stores part="'.$Apache::inputtags::part.'"';
    if (defined($Apache::inputtags::response[-1])) {
      $result.=           ' id="'.$Apache::inputtags::response[-1].'"';
      $partref.='_'.$Apache::inputtags::response[-1];
    }	
    $result.=          ' name="'.$name.'"'.
                       ' type="'.$type.'"'.
	            ' display="'.$display.' [Part: '.$partref.']"'.
		      "></stores>\n";
}

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
#
}

sub check_for_previous {
  my ($curresponse,$partid,$id) = @_;
  my %previous;
  $previous{'used'} = 0;
  foreach my $key (reverse(sort(keys(%Apache::lonhomework::history)))) {
    if ($key =~ /resource\.$partid\.$id\.submission/) {
      &Apache::lonxml::debug("Trying $key");
      my $pastresponse=$Apache::lonhomework::history{$key};
      if ($pastresponse eq $curresponse) {
	$previous{'used'} = 1;
	my $history;
	if ( $key =~ /^(\d+):/ ) {
	  $history=$1;
	  $previous{'award'} = $Apache::lonhomework::history{"$history:resource.$partid.$id.awarddetail"};
	  $previous{'last'}='0';
	} else {
	  $previous{'award'} = $Apache::lonhomework::history{"resource.$partid.$id.awarddetail"};
	  $previous{'last'}='1';
	}
	if (! $previous{'award'} ) { $previous{'award'} = 'UNKNOWN';	}
	&Apache::lonxml::debug("got a match :$previous{'award'}:$previous{'used'}:");
	last;
      }
    }
  }
  return %previous;
}

sub handle_previous {
  my ($previous,$ad)=@_;
  if ($$previous{'used'} && ($$previous{'award'} eq $ad) ) {
    if ($$previous{'last'}) {
      push(@Apache::inputtags::previous,'PREVIOUSLY_LAST');
    } else {
      push(@Apache::inputtags::previous,'PREVIOUSLY_USED');
    }
  }
}

sub start_caparesponse {
  require Apache::caparesponse; 
  import Apache::caparesponse; 
  my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
#  print "\n<br />\nsimple caparesponse\n";
  return &Apache::caparesponse::start_caparesponse($target,$token,$tagstack,$parstack,$parser,$safeeval,$style);
}

sub start_stringresponse {
  require Apache::caparesponse;
  import Apache::caparesponse;
  my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
  return &Apache::caparesponse::start_stringresponse($target,$token,$tagstack,$parstack,$parser,$safeeval,$style);
}

sub start_formularesponse {
  require Apache::caparesponse;
  import Apache::caparesponse;
  my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
  return &Apache::caparesponse::start_formularesponse($target,$token,$tagstack,$parstack,$parser,$safeeval,$style);
}

sub start_numericalresponse {
  require Apache::caparesponse; 
  import Apache::caparesponse; 
  my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
  return &Apache::caparesponse::start_numericalresponse
    ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style);
}

sub start_radiobuttonresponse {
  require Apache::radiobuttonresponse; 
  import Apache::radiobuttonresponse; 
  my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
  return &Apache::radiobuttonresponse::start_radiobuttonresponse($target,$token,$tagstack,$parstack,$parser,$safeeval,$style);
}

sub start_optionresponse {
  require Apache::optionresponse; 
  import Apache::optionresponse; 
  my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
  return &Apache::optionresponse::start_optionresponse($target,$token,$tagstack,$parstack,$parser,$safeeval,$style);
}

sub start_imageresponse {
  require Apache::imageresponse; 
  import Apache::imageresponse; 
  my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
  return &Apache::imageresponse::start_imageresponse($target,$token,$tagstack,$parstack,$parser,$safeeval,$style);
}

sub start_essayresponse {
  require Apache::essayresponse; 
  import Apache::essayresponse; 
  my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
  return &Apache::essayresponse::start_essayresponse($target,$token,$tagstack,$parstack,$parser,$safeeval,$style);
}

sub view_or_modify {
  my ($symb,$courseid,$domain,$name) = &Apache::lonxml::whichuser();
  my $myself=0;
  if ( ($name eq $ENV{'user.name'}) && ($domain eq $ENV{'user.domain'}) ) {
    $myself=1;
  }
  my $vgr=&Apache::lonnet::allowed('vgr',$courseid);
  my $mgr=&Apache::lonnet::allowed('vgr',$courseid);
  if ($mgr) { return "M"; }
  if ($vgr) { return "V"; }
  if ($myself) { return "V"; }
  return '';
}

sub start_dataresponse {
  my ($target,$token,$tagstack,$parstack,$parser,$safeeval)=@_;
  my $id = &Apache::response::start_response($parstack,$safeeval);
  my $result;
  if ($target eq 'web') {
    $result = $token->[2]->{'display'}.':';
  } elsif ($target eq 'meta') {
    $result = &Apache::response::meta_stores_write($token->[2]->{'name'},
						   $token->[2]->{'type'},
						   $token->[2]->{'display'});
    $result .= &Apache::response::meta_package_write('dataresponse');
  }
  return $result;
}

sub end_dataresponse {
  my ($target,$token,$tagstack,$parstack,$parser,$safeeval)=@_;
  my $result;
  if ( $target eq 'web' ) {
  } elsif ($target eq 'grade' ) {
    if ( defined $ENV{'form.submitted'}) {
      my ($symb,$courseid,$domain,$name)=&Apache::lonxml::whichuser();
      my $allowed=&Apache::lonnet::allowed('mgr',$courseid);
      if ($allowed) {
	&Apache::response::setup_params('datasubmission');
	my $partid = $Apache::inputtags::part;
	my $id = $Apache::inputtags::response['-1'];
	my $response = $ENV{'form.HWVAL'.$id};
	my $name = &Apache::lonxml::get_param('name',$parstack,$safeeval);
	if ( $response =~ /[^\s]/) {
	  $Apache::lonhomework::results{"resource.$partid.$id.$name"}=
	    $response;
	  $Apache::lonhomework::results{
					"resource.$partid.$id.submission"}=
					  $response;
	  $Apache::lonhomework::results{
					"resource.$partid.$id.awarddetail"}=
					  'SUBMITTED';
	}
      } else {
	$result='Not Permitted to change values.'
      }
    }
  }
  &Apache::response::end_response;
  return $result;
}

sub start_responseparam {
  my ($target,$token,$tagstack,$parstack,$parser,$safeeval)=@_;
  my $result='';
  if ($target eq 'meta') {
    $result = &meta_parameter_write($token->[2]->{'name'},
				    $token->[2]->{'type'},
				    $token->[2]->{'default'},
				    $token->[2]->{'description'});
  } elsif ($target eq 'edit') {
    $result.=&Apache::edit::tag_start($target,$token,
				      &Apache::lonxml::description($token));
    $result.=&Apache::edit::text_arg('Name:','name',$token).
      &Apache::edit::text_arg('Type:','type',$token).
	&Apache::edit::text_arg('Description:','description',$token).
	  &Apache::edit::text_arg('Default:','default',$token).
	    "</td></tr>";
    $result.=&Apache::edit::end_table;
  } elsif ($target eq 'modified') {
    my $constructtag=&Apache::edit::get_new_args($token,$parstack,$safeeval,
						 'name','type','description',
						 'default');
    if ($constructtag) {
      $result = &Apache::edit::rebuild_tag($token);
      $result.=&Apache::edit::handle_insert();
    }
  } elsif ($target eq 'grade') {
    if ($ENV{'request.state'} eq 'construct') {
      my $name    = &Apache::lonxml::get_param('name',$parstack,$safeeval);
      my $default = &Apache::lonxml::get_param('default',$parstack,$safeeval);
      $Apache::inputtags::params{$name}=$default;
    }
  }
  return $result;
}

sub end_responseparam {
  my ($target,$token,$tagstack,$parstack,$parser,$safeeval)=@_;
  if ($target eq 'edit') { return ('','no'); }
  return '';
}

sub start_parameter {
  my $result = &start_responseparam(@_);
  return $result;
}

sub end_parameter {
  my $result = &end_responseparam(@_);
  return $result;
}

sub setup_params {
  my ($tag) = @_;

  if ($ENV{'request.state'} eq 'construct') { return; }
  @Apache::inputtags::params=();
  my %paramlist=();
  foreach my $key (keys(%Apache::lonnet::packagetab)) {
    if ($key =~ /^$tag/) {
      my ($package,$name) = split(/&/,$key);
      $paramlist{$name}=1;
    }
  }
  foreach my $key (keys(%paramlist)) {
    my $entry= 'resource.'.$Apache::inputtags::part;
    if (defined($Apache::inputtags::response[-1])) {
      $entry.='_'.$Apache::inputtags::response[-1];
    }
    $entry.='.'.$key;
    &Apache::lonxml::debug("looking for $entry");
    my $value = &Apache::lonnet::EXT("$entry");
    &Apache::lonxml::debug("$key has value :$value:");
    if ($value eq 'con_lost' || $value =~ /^error:/) {
      &Apache::lonxml::debug("using nothing");
      $Apache::inputtags::params{$key}='';
    } else {
      &Apache::lonxml::debug("using value");
      $Apache::inputtags::params{$key}=$value;
    }
  }
}

sub answer_header {
  my ($type) = @_;
  my $result;
  if ($type eq 'optionresponse' || $type eq 'radiobuttonresponse' ) {
    $result = '<table border="1"><tr><th>Answer for Part:'.
      $Apache::inputtags::part. '</th></tr><tr>'."\n";
  } else {
    $result = '<table border="1"><tr><td>Answer for Part:'.
      $Apache::inputtags::part. '</td>'."\n";
  }
  return $result;
}

sub answer_part {
  my ($type,$answer) = @_;
  my $result;
  if ($type eq 'optionresponse' || $type eq 'radiobuttonresponse') {
    $result = '<td>'.$answer.'</td>';
  } else {
    $result = '<td>'.$answer.'</td>';
  }
  return $result;
}

sub answer_footer {
  my ($type) = @_;
  my $result;
  if ($type eq 'optionresponse' || $type eq 'radiobuttonresponse') {
    $result = '</tr></table>';
  } else {
    $result = '</tr></table>';
  }
  return $result;
}

1;
__END__
 
<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN">
<html><head>
<title>500 Internal Server Error</title>
</head><body>
<h1>Internal Server Error</h1>
<p>The server encountered an internal error or
misconfiguration and was unable to complete
your request.</p>
<p>Please contact the server administrator at 
 root@localhost to inform them of the time this error occurred,
 and the actions you performed just before this error.</p>
<p>More information about this error may be available
in the server error log.</p>
</body></html>