# The LearningOnline Network with CAPA
# external style responses
#
# $Id: externalresponse.pm,v 1.29 2014/12/06 20:08:16 raeburn 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/
#



package Apache::externalresponse;
use strict;
use HTTP::Request::Common;
use Apache::loncapagrade;
use Apache::lonnet;
use Apache::lonlocal;
use Apache::lonxml();
use Apache::lonhtmlcommon;
use Apache::loncommon;
use Apache::lonnavmaps;
use Apache::essayresponse;
use LONCAPA qw(:DEFAULT :match);

BEGIN {
    &Apache::lonxml::register('Apache::externalresponse',('externalresponse'));
}

=pod

=head1 FIXME (start_externalresponse)

send of response params and their current values (form good enough? what parameters to send?)
Need to get returned message displayed

=cut


sub start_externalresponse {
    my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
    my $result;
    my $id = &Apache::response::start_response($parstack,$safeeval);
    if ($target eq 'edit') {
  	$result .=&Apache::edit::tag_start($target,$token);
	$result .=&Apache::edit::text_arg('URL:','url',$token,60).'<br />';
	$result .=&Apache::edit::text_arg(&mt('Answer:'),'answer',$token);
	$result .=&Apache::edit::text_arg(&mt('Form:'),'form',$token).'<br />';
        $result .=&Apache::edit::text_arg(&mt('Answer display:'),'answerdisplay',$token,80);
	$result .=&Apache::edit::end_row().&Apache::edit::start_spanning_row();
    } elsif ($target eq 'modified') {
	my $constructtag =
	    &Apache::edit::get_new_args($token,$parstack,$safeeval,
					'answerdisplay','answer','form','url');
	if ($constructtag) {
	    $result = &Apache::edit::rebuild_tag($token);
	}
    } elsif ($target eq 'meta') {
  	$result=&Apache::response::meta_package_write('externalresponse');
    } elsif ($target eq 'web') {
        my $part= $Apache::inputtags::part;
        my $coll;
        if ($Apache::lonhomework::history{"resource.$part.$id.collaborators"} =~ /\S/) {
            $coll = &HTML::Entities::encode($Apache::lonhomework::history{"resource.$part.$id.collaborators"},'<>&"');
        }
        if ($Apache::inputtags::status[-1] eq 'CAN_ANSWER') {
            my $ncol= &Apache::lonnet::EXT("resource.$part".'_'."$id.maxcollaborators");
            my $uploadedfiletypes= &Apache::lonnet::EXT("resource.$part".'_'."$id.uploadedfiletypes");
            $uploadedfiletypes=~s/[^\w\,]//g;
            my $maxfilesize=&Apache::lonnet::EXT("resource.$part".'_'."$id.maxfilesize");
            if (!defined($maxfilesize)) {
                $maxfilesize = 10.0; #FIXME This should become a domain configuration 
            }
            my $hiddendraft;
            if ($uploadedfiletypes) {
                if (($Apache::lonhomework::type eq 'survey') ||
                    ($Apache::lonhomework::type eq 'surveycred') ||
                    ($Apache::lonhomework::type eq 'anonsurvey') ||
                    ($Apache::lonhomework::type eq 'anonsurveycred')) {
                    $hiddendraft = '<input type="hidden" name="HWDRAFT'.$part.'_'.$id.'" value="yes" />';
                } else {
                    $result = &Apache::essayresponse::draft_row($part,$id,$ncol,$uploadedfiletypes);
                }
                if ($ncol > 0) {
                    $result .= &Apache::essayresponse::get_collab_row($part,$id,$coll,$ncol);
                }
                my $filesfrom = 'both';
                my $stuname = &Apache::lonnet::EXT('user.name');
                my $studom = &Apache::lonnet::EXT('user.domain');
                if (!&Apache::lonnet::usertools_access($stuname,$studom,'portfolio')) {
                    $filesfrom = 'uploadonly';
                }
                $result.=&Apache::inputtags::file_selector($part,$id,$uploadedfiletypes,
                                                           $filesfrom,undef,$maxfilesize);
            } else {
                if ($ncol > 0) {
                    $result = &Apache::essayresponse::get_collab_row($part,$id,$coll,$ncol,1);
                }
            }
            if ($result) {
                $result =
                    '<div>'.$hiddendraft.
                    &Apache::lonhtmlcommon::start_pick_box().
                    $result.
                    &Apache::lonhtmlcommon::end_pick_box().'</div>';
            } else {
                $result = $hiddendraft;
            }
        } else {
            $result = &Apache::essayresponse::show_status_table($part,$id,$coll);
        }
    }
    return $result;
}

sub end_externalresponse {
    my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
    my $result;
    my $response;
    my $part=$Apache::inputtags::part;
    my $id = $Apache::inputtags::response['-1'];
    my $increment     = 1;
    if ($target eq 'grade') {
        &Apache::essayresponse::get_collaborators($part,$id);
	if (  &Apache::response::submitted('scantron') ) {
	    my $increment=&Apache::response::scored_response($part,$id);
	} elsif ( &Apache::response::submitted() ) {
            $response      = $env{'form.HWVAL_'.$id};
            my $jspart=$part;
            $jspart=~s/\./_/g;
            my $filename = $env{'form.HWFILE'.$jspart.'_'.$id.'.filename'} ||
                           $env{'form.HWFILETOOBIG'.$part.'_'.$id};
            my $portfiles = $env{'form.HWPORT'.$jspart.'_'.$id};
            my @deletions = &Apache::loncommon::get_env_multiple('form.HWFILE'.$jspart.'_'.$id.'_delete');
            my ($is_submit,$was_draft,$externalgrade);
            if ($env{'form.HWDRAFT'.$part.'_'.$id} eq 'yes') {
                 $is_submit = 1;
            }
            if ($Apache::lonhomework::history{"resource.$part.award"} eq 'DRAFT') {
                $was_draft = 1;
            }
            if (($filename =~ /[^\s]/) || ($portfiles =~ /[^\s]/) ||
                (@deletions > 0) || ($was_draft && $is_submit)) {
                my $award='DRAFT';
                if ($env{'form.HWDRAFT'.$part.'_'.$id} eq 'yes') {
                    if ($Apache::lonhomework::type eq 'anonsurvey') {
                        $award='ANONYMOUS';
                    } elsif ($Apache::lonhomework::type eq 'anonsurveycred') {
                        $award='ANONYMOUS_CREDIT';
                    } elsif ($Apache::lonhomework::type eq 'surveycred') {
                        $award='SUBMITTED_CREDIT';
                    } else {
                        $award='SUBMITTED';
                    }
                }
                my $uploadedflag=0;
                my $totalsize=0;
                my %info = (
                             'is_submit' => $is_submit,
                           );
                my $url = &Apache::lonxml::get_param('url',$parstack,$safeeval);
                if ($url =~ m{^https?://([^/]+)/}) {
                    use Socket;
                    my $ip = gethostbyname($1);
                    if (length($ip) eq 4) {
                        $info{'ip'} = inet_ntoa($ip);
                    }
                } elsif ($url =~ m{^/}) {
                    my $ip = &Apache::lonnet::get_host_ip($Apache::lonnet::perlvar{'lonHostID'});
                    if ($ip =~ /^[\d\.]+$/) {
                        $info{'ip'} = $ip;
                    }
                }
                &Apache::essayresponse::file_submission($part,$id,\$award,\$uploadedflag,\$totalsize,
                                                        \@deletions,'externalresponse',\%info);
                $Apache::lonhomework::results{"resource.$part.$id.submission"}=$response;
                $Apache::lonhomework::results{"resource.$part.$id.awarddetail"}=$award;
                my %previous=&Apache::response::check_for_previous($response,$part,$id);
                if ($uploadedflag) {
                    if ($award eq 'FILENAME_INUSE') {
                        delete($Apache::lonhomework::results{"resource.$id.tries"});
                    }
                } else {
                    &Apache::response::handle_previous(\%previous,$award);
                }
                if ($award eq 'SUBMITTED') {
                    my ($symb,$crsid,$domain,$name)=
                        &Apache::lonnet::whichuser();
                    if ($crsid) {
                        my $akey=join('.',&escape($name),&escape($domain),
                                      &escape($crsid));
                        my $essayurl=
                            &Apache::lonnet::declutter($ENV{'REQUEST_URI'});
                        my ($adom,$aname,$apath)=
                            ($essayurl=~/^($LONCAPA::domain_re)\/($LONCAPA::username_re)\/(.*)$/);
                        $apath=&escape($apath);
                        $apath=~s/\W/\_/gs;
                        &Apache::lonnet::put('nohist_essay_'.$apath,
                                         { $akey => $response },$adom,$aname);
                    }
                }
            ($award eq 'DRAFT') ? ($externalgrade = 0) : ($externalgrade =1);
            }
          if (&Apache::response::getresponse() =~ /[^\s]/) {
               $response = &Apache::response::getresponse();
               $externalgrade = 1;
          }  

          if ($externalgrade) {
            my $filesresults=0;
# Previously turned in files
            my %previously_turned_in=();
            foreach my $file (split(/\,/,$Apache::lonhomework::history{"resource.$part.$id.portfiles"}.','.
                                         $Apache::lonhomework::history{"resource.$part.$id.uploadedurl"})) {
               if ($file=~/\S/) {
                  $previously_turned_in{'/uploaded/'.$env{'user.domain'}.'/'.$env{'user.name'}.'/portfolio'.$file}=1;
               }
            }
# Currently turned in files
            my %currently_turned_in=();
           foreach my $file (split(/\,/,$Apache::lonhomework::results{"resource.$part.$id.portfiles"}.','.
                                         $Apache::lonhomework::results{"resource.$part.$id.uploadedurl"})) {
              if ($file=~/\S/) {
                  $filesresults=1;
                  $currently_turned_in{'/uploaded/'.$env{'user.domain'}.'/'.$env{'user.name'}.'/portfolio'.$file}=1;
               }
            }
            my $filelinks=join(',',map{$_}(keys(%currently_turned_in)));
            &Apache::lonnet::logthis("Previously: ".join("\n",sort(keys(%previously_turned_in))));
            &Apache::lonnet::logthis("Currently: ".join("\n",sort(keys(%currently_turned_in))));
            &Apache::lonnet::logthis("File flag: ".$filesresults);
            &Apache::lonnet::logthis("Links String: ".$filelinks);
	    if ($filesresults || ( $response =~ /[^\s]/)  ) {
		my $url = &Apache::lonxml::get_param('url',$parstack,$safeeval);
		my $answer = &Apache::lonxml::get_param('answer',$parstack,$safeeval);
		my %form = &Apache::lonxml::get_param_var('form',$parstack,$safeeval);
		$form{'LONCAPA_student_response'}=$response;
		$form{'LONCAPA_correct_answer'}=$answer;
		$form{'LONCAPA_language'}=
		    &Apache::lonnet::metadata($ENV{'REQUEST_URI'},'language');
                $form{'LONCAPA_student_submitted_files'} = $filelinks;
		&Apache::lonxml::debug("Asking $url, with:");
		&Apache::lonhomework::showhash(%form);
                my $udom = &Apache::lonnet::EXT('user.domain');
                my $uname = &Apache::lonnet::EXT('user.name');
                my $symb = $env{'resource.symb'};
                my %record = &Apache::lonnet::restore($symb,$env{'request.course.id'},$udom,$uname);
		my $ua = LWP::UserAgent->new;
		my $res = $ua->request(POST $url, \%form);
		%Apache::loncapagrade::results=();
		$Apache::lonhomework::results{"resource.$part.$id.submission"}=$response;
		if ($res->is_error()) {
		    $Apache::loncapagrade::results{'awarddetail'}='ERROR';
		} else {
		    &Apache::lonxml::register('Apache::loncapagrade',
					      ('loncapagrade'));
		    @Apache::scripttag::parser_env = @_;
		    my $result=&Apache::scripttag::xmlparse($res->{_content});
		    &Apache::lonxml::debug("Got a result of :$result:");
		}
		foreach my $key (keys(%Apache::loncapagrade::results)) {
		    $Apache::lonhomework::results{"resource.$part.$id.$key"}=
			$Apache::loncapagrade::results{$key};
		}
                $Apache::externalresponse::message=$Apache::loncapagrade::results{'message'};
                if ($Apache::loncapagrade::results{'awarddetail'} eq 'ASSIGNED_SCORE') {
                   $Apache::lonhomework::results{"resource.$part.$id.awarded"}=
                        1.*$Apache::loncapagrade::results{"awarded"};
                }
                my $handbackurl = $Apache::loncapagrade::results{'handbackurl'}
                &Apache::lonnet::logthis("handbackurl: ". $Apache::loncapagrade::results{'handbackurl'});
		&Apache::lonxml::debug("response of");
		&Apache::lonhomework::showhash(%$res);
		&Apache::lonxml::debug("capagrade of");
		&Apache::lonhomework::showhash(%Apache::loncapagrade::results);
		&Apache::lonxml::debug("results of");
		&Apache::lonhomework::showhash(%Apache::lonhomework::results);
	    }
        }
      }
    }
    if ($target eq 'web')  {
        &Apache::response::setup_prior_tries_hash(\&Apache::essayresponse::format_prior_response,
                                                  ['portfiles',
                                                   'uploadedurl']);
        if (&Apache::response::show_answer()) {
           $result.='<table border="1"><tr><th>'.&mt('Your answer:').'</th></tr><tr><td><pre>'.
                    &HTML::Entities::encode(
                        $Apache::lonhomework::history{"resource.$part.$id.submission"},'"<>&').
                    '</pre></td></table><br />'.&Apache::lonxml::get_param('answerdisplay',$parstack,$safeeval).
                    '<br />';
        }
        if ($Apache::externalresponse::message) {
           $result.='<br /><table><tr><td bgcolor="#FFFFAA">'.$Apache::externalresponse::message.'</td></tr></table><br />';
        }
        $Apache::externalresponse::message='';

    }

    if ($target eq 'grade' || $target eq 'web' || $target eq 'answer' ||
	$target eq 'tex' || $target eq 'analyze') {
	&Apache::lonxml::increment_counter($increment, "$part.$id");

	if ($target eq 'analyze') {
            $Apache::lonhomework::analyze{"$part.$id.type"} = 'externalresponse';
	    &Apache::lonhomework::set_bubble_lines();
	}
    }
    elsif ($target eq 'edit') {
        $result.=&Apache::edit::end_table();

    } elsif ($target eq 'tex'
             && $Apache::lonhomework::type eq 'exam') {
        $result .= &Apache::inputtags::exam_score_line($target);

    } 
    &Apache::response::end_response();
    return $result;
}

1;
__END__


=pod

=head1 NAME

Apache::externalresponse.pm

=head1 SYNOPSIS

Handler to evaluate externally graded responses.

This is part of the LearningOnline Network with CAPA project
described at http://www.lon-capa.org.

=head1 SUBROUTINES

=over

=item start_externalresponse()

=item end_externalresponse()

=back

=cut