# The LearningOnline Network with CAPA
#
# $Id: lonstudentsubmissions.pm,v 1.16 2004/09/02 21:02:54 matthew 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::lonstudentsubmissions;

use strict;
use Apache::lonnet();
use Apache::loncommon();
use Apache::lonhtmlcommon();
use Apache::loncoursedata();
use Apache::lonstatistics;
use Apache::lonlocal;
use Apache::lonstathelpers;
use HTML::Entities();
use Time::Local();
use Spreadsheet::WriteExcel();

my @SubmitButtons = ({ name => 'PrevProblem',
                       text => 'Previous Problem' },
                     { name => 'NextProblem',
                       text => 'Next Problem' },
                     { name => 'break'},
                     { name => 'SelectAnother',
                       text => 'Choose a different Problem' },
                     { name => 'Generate',
                       text => 'Generate Report'},
                     );

sub BuildStudentSubmissionsPage {
    my ($r,$c)=@_;
    #
    my %Saveable_Parameters = ('Status' => 'scalar',
                               'Section' => 'array',
                               'NumPlots' => 'scalar',
                               );
    &Apache::loncommon::store_course_settings('student_submissions',
                                              \%Saveable_Parameters);
    &Apache::loncommon::restore_course_settings('student_submissions',
                                                \%Saveable_Parameters);
    #
    &Apache::lonstatistics::PrepareClasslist();
    #
    $r->print(&CreateInterface());
    #
    my @Students = @Apache::lonstatistics::Students;
    #
    if (@Students < 1) {
        $r->print('<h2>There are no students in the sections selected</h2>');
    }
    #
    my @CacheButtonHTML = 
        &Apache::lonstathelpers::manage_caches($r,'Statistics','stats_status');
    $r->rflush();
    #
    if (exists($ENV{'form.problemchoice'}) && 
        ! exists($ENV{'form.SelectAnother'})) {
        foreach my $button (@SubmitButtons) {
            if ($button->{'name'} eq 'break') {
                $r->print("<br />\n");
            } else {
                $r->print('<input type="submit" name="'.$button->{'name'}.'" '.
                          'value="'.&mt($button->{'text'}).'" />');
                $r->print('&nbsp;'x5);
            }
        }
        foreach my $html (@CacheButtonHTML) {
            $r->print($html.('&nbsp;'x5));
        }
        #
        $r->print('<hr />');
        $r->rflush();
        #
        # Determine which problem we are to analyze
        my $current_problem = &Apache::lonstathelpers::get_target_from_id
            ($ENV{'form.problemchoice'});
        #
        my ($prev,$curr,$next) = 
            &Apache::lonstathelpers::get_prev_curr_next($current_problem,
                                                        '.',
                                                        'response',
                                                        );
        if (exists($ENV{'form.PrevProblem'}) && defined($prev)) {
            $current_problem = $prev;
        } elsif (exists($ENV{'form.NextProblem'}) && defined($next)) {
            $current_problem = $next;
        } else {
            $current_problem = $curr;
        }
        #
        # Store the current problem choice and send it out in the form
        $ENV{'form.problemchoice'} = 
            &Apache::lonstathelpers::make_target_id($current_problem);
        $r->print('<input type="hidden" name="problemchoice" value="'.
                  $ENV{'form.problemchoice'}.'" />');
        #
        if (! defined($current_problem->{'resource'})) {
            $r->print('resource is undefined');
        } else {
            my $resource = $current_problem->{'resource'};
            $r->print('<h1>'.$resource->{'title'}.'</h1>');
            $r->print('<h3>'.$resource->{'src'}.'</h3>');
            if ($ENV{'form.renderprob'} eq 'true') {
                $r->print(&Apache::lonstathelpers::render_resource($resource));
            }
            $r->rflush();
            my %Data = &Apache::lonstathelpers::get_problem_data
                ($resource->{'src'});
            my $ProblemData = $Data{$current_problem->{'part'}.
                                    '.'.
                                    $current_problem->{'respid'}};
            if ($ENV{'form.output'} eq 'excel') {
                &prepare_excel_output($r,$current_problem,
                                      $ProblemData,\@Students);
            } else {
                &prepare_html_output($r,$current_problem,
                                     $ProblemData,\@Students);
            }
        }
        $r->print('<hr />');
    } else {
        $r->print('<input type="submit" name="Generate" value="'.
                  &mt('Generate Spreadsheet').'" />');
        $r->print('&nbsp;'x5);
        $r->print('<h3>'.&mt('Please select a problem to analyze').'</h3>');
        $r->print(&Apache::lonstathelpers::ProblemSelector('.'));
    }
}

#########################################################
#########################################################

my @DefaultColumns = 
    (
     {name=>'username',
      display=>'Student'},
     {name=>'domain',
      display=>'Domain'},
     {name => 'id',
      display => 'Id'},
     {name => 'time',
      display =>'Time'},
     {name => 'attempt',
      display =>'Attempt'},
     {name => 'awarddetail',
      display =>'Awarddetail'},
     {name => 'grading',
      display =>'Score'},
    );

#########################################################
#########################################################
##
##    prepare_html_output
##
#########################################################
#########################################################
sub prepare_html_output {
    my ($r,$problem,$ProblemData,$Students) = @_;
    my $c = $r->connection();
    my ($resource,$respid,$partid) = ($problem->{'resource'},
                                      $problem->{'respid'},
                                      $problem->{'part'});
    #
    if ($ENV{'form.correctans'} eq 'true') {
        $r->print('<h2>'.&mt('Generating Correct Answers').'</h2>');
        &Apache::lonstathelpers::GetStudentAnswers($r,$problem,$Students,
                                                   'Statistics',
                                                   'stats_status');
    }
    #
    $r->print('<h2>'.&mt('Student Responses').'</h2>');
    #
    $r->rflush();
    my $response_type;
    for (my $i=0;
         $i<scalar(@{$resource->{'partdata'}->{$partid}->{'ResponseIds'}});
         $i++) {
        if($resource->{'partdata'}->{$partid}->{'ResponseIds'}->[$i] eq $respid){
            $response_type = 
                $resource->{'partdata'}->{$partid}->{'ResponseTypes'}->[$i];
            last;
        }
    }
    if (! defined($response_type)) {
        $r->print('<h2>'.&mt('Unable to determine response type').'</h2>');
    } else {
        my $count = 0;
        my @Columns;
        if (exists($ENV{'form.concise'}) && $ENV{'form.concise'} eq 'true') {
            foreach (@DefaultColumns) {
                if ($_->{'name'} =~ /^(username|domain|id)$/){
                    push(@Columns,$_);
                }
            }
        } else {
            @Columns = @DefaultColumns;
        }
        my $header = '<table>'.$/.&html_headers(\@Columns);
        if ($response_type eq 'essay') {
            $header .= &html_essay_headers();
        } elsif ($response_type eq 'option') {
            $header .= &html_option_headers();
        } else {
            $header .= &html_generic_headers();
        }
        $header = '<tr>'.$header.'</tr>';
        #
        $r->print($/.$header.$/);
        foreach my $student (@$Students) {
            if ($count >= 50) {
                $r->print('</table>'.$/.$header.$/);
                $count = 0;
            }
            last if ($c->aborted());
            my $results = &Apache::loncoursedata::get_response_data_by_student
                ($student,$resource->{'symb'},$respid);
            next if (! defined($results) || ref($results) ne 'ARRAY');
            for (my $i=0;$i<scalar(@$results);$i++) {
                my $response = $results->[$i];
                if ($ENV{'form.last_sub_only'} eq 'true' && 
                    $i < (scalar(@$results)-1)) {
                    next;
                }
                my $data;
                $data->{'username'} = $student->{'username'};
                $data->{'domain'}   = $student->{'domain'};
                $data->{'id'} = $student->{'id'};
                $data->{'fullname'} = $student->{'fullanem'};
                $data->{'status'} = $student->{'status'};
                $data->{'time'} = &Apache::lonlocal::locallocaltime
                    ($response->[&Apache::loncoursedata::RDs_timestamp()]);
                $data->{'attempt'} = 
                    $response->[&Apache::loncoursedata::RDs_tries()];
                $data->{'awarded'} = 
                    $response->[&Apache::loncoursedata::RDs_awarded()];
                $data->{'awarddetail'} = 
                    $response->[&Apache::loncoursedata::RDs_awarddetail()];
                my $rowextra = 'bgcolor="#CCCCCC"';
                if ($count % 2 == 1) {
                    $rowextra = 'bgcolor="#EEEEEE"';
                }
                my $row = '<tr '.$rowextra.'>';
                foreach my $col (@Columns) {
                    $row .= '<td valign="top">'.
                        $data->{$col->{'name'}}.'</td>';
                }
                if ($response_type eq 'essay') {
                    $row .= &html_essay
                        ($response->[&Apache::loncoursedata::RDs_submission()],
                         $student->{'answer'},
                         scalar(@Columns),$rowextra);
                } elsif ($response_type eq 'option') {
                    $row .= &html_option
                        ($response->[&Apache::loncoursedata::RDs_submission()],
                         $student->{'answer'},
                         scalar(@Columns),$rowextra);
                } else {
                    $row .= &html_generic
                        ($response->[&Apache::loncoursedata::RDs_submission()],
                         $student->{'answer'},
                         scalar(@Columns),$rowextra);
                }
                $row .= '</tr>';
                $r->print($row.$/);
                $count++;
            }
        }
        $r->print('</table>'.$/);
    }
    return;
}

#####################################################
##
##     HTML helper routines
##
#####################################################
sub html_headers {
    my ($Columns) = @_;
    my $Str;
    foreach my $column (@$Columns) {
        $Str .= '<th align="left">'.$column->{'display'}.'</th>';
    }
    return $Str;
}

sub html_essay {
    my ($submission,$correct,$tablewidth,$rowextra)=@_;
    #
    $submission =~ s|\\r\\n|$/|g;
    $submission = &HTML::Entities::encode($submission,'<>&"');
    $submission =~ s|$/\s*$/|$/</p><p>$/|g;
    $submission =~ s|\\||g;
    $submission = '<p>'.$submission.'</p>';
    #
    my $Str  = '</tr><tr '.$rowextra.'>'.
        '<td colspan="'.$tablewidth.'">'.$submission.'</td>';
    if ($ENV{'form.correctans'} eq 'true') {
        $Str .= '</tr>';
        if (defined($correct) && $correct !~ /^\s*$/) {
            $Str .= '<tr '.$rowextra.'><td colspan="'.$tablewidth.'">'.
                '<b>'.&mt('Correct Answer:').'</b>'.$correct.'</td>';
        }
    }
    $Str .= '</tr>';
    #
    return $Str;
}

sub html_essay_headers {
    return '';
}

sub html_generic_headers {
    my $header ='<th>'.&mt('Submission').'</th>';
    if ($ENV{'form.correctans'} eq 'true') {
        $header .= '<th>'.&mt('Correct').'</th>';
    }
    return $header;
}

sub html_radiobutton {
    my ($submission,$correct,$tablewidth,$rowclass)=@_;
    $submission =~ s/=([^=])$//;
    return &html_generic_results($submission,$correct,$tablewidth,$rowclass);
}

sub html_generic {
    my ($submission,$correct,$tablewidth,$rowclass)=@_;
    my $Str .= '<td>'.$submission.'</td>';
    if ($ENV{'form.correctans'} eq 'true') {
        $Str .= '<td>'.$correct.'</td>';
    }
    $Str .= '</tr>';
    return $Str;
}

sub html_option_headers {
    return &html_generic_headers();
}

sub html_option {
    my ($submission,$correct,$tablewidth,$rowclass)=@_;
    $submission = 
        '<ul class="sub_studentans">'.
        '<li>'.join('</li><li>',
                    map { 
                        &Apache::lonnet::unescape($_) ;
                    } sort split('&',$submission)
                    ).
                    '</li><ul>';
    if (defined($correct) && $correct !~ /^\s*$/) {
        $correct = '<ul class="sub_correctans">'.
            '<li>'.join('</li><li>',
                        map { 
                            &Apache::lonnet::unescape($_) ;
                        } sort split('&',$correct)
                        ).
                        '</li></ul>';
    }
    #
    return &html_generic($submission,$correct,$tablewidth,$rowclass);
}

#########################################################
#########################################################
##
##      Excel output of student answers and correct answers
##
#########################################################
#########################################################
sub prepare_excel_output {
    my ($r,$problem,$ProblemData,$Students) = @_;
    my $c = $r->connection();
    my ($resource,$respid,$partid) = ($problem->{'resource'},
                                      $problem->{'respid'},
                                      $problem->{'part'});
    $r->print('<h2>'.
              &mt('Preparing Excel spreadsheet of student responses').
              '</h2>'.
              '<p>'.
              &mt('See the status bar above for student answer computation progress').
              '</p>');
    #
    if ($ENV{'form.correctans'} eq 'true') {
        &Apache::lonstathelpers::GetStudentAnswers($r,$problem,$Students,
                                                   'Statistics',
                                                   'stats_status');
        $r->print('<script>'.
                  'window.document.Statistics.stats_status.value="'.
                  'Done computing student answers.  Compiling spreadsheet.'.
                  '";</script>');
    }
    #
    $r->rflush();
    my @Columns;
    push(@Columns,'username');
    push(@Columns,'domain');
    push(@Columns,'attempt');
    push(@Columns,'time');
    push(@Columns,'submission');
    if ($ENV{'form.correctans'} eq 'true') { push(@Columns,'correct'); }
    push(@Columns,'grading');
    push(@Columns,'awarded');
    my $awarded_col = $#Columns;
    push(@Columns,'weight');
    my $weight_col  = $#Columns;
    push(@Columns,'score');
    #
    # Create excel worksheet
    my $filename = '/prtspool/'.
        $ENV{'user.name'}.'_'.$ENV{'user.domain'}.'_'.
        time.'_'.rand(1000000000).'.xls';
    my $workbook  = Spreadsheet::WriteExcel->new('/home/httpd'.$filename);
    if (! defined($workbook)) {
        $r->log_error("Error creating excel spreadsheet $filename: $!");
        $r->print('<p>'.&mt("Unable to create new Excel file.  ".
                            "This error has been logged.  ".
                            "Please alert your LON-CAPA administrator").
                  '</p>');
        return undef;
    }
    #
    $workbook->set_tempdir('/home/httpd/perl/tmp');
    #
    my $format = &Apache::loncommon::define_excel_formats($workbook);
    my $worksheet  = $workbook->addworksheet('Student Submission Data');
    #
    # Make sure we get new weight data instead of data on a 10 minute delay
    &Apache::lonnet::clear_EXT_cache_status();
    #
    # Put on the standard headers and whatnot
    my $rows_output=0;
    $worksheet->write($rows_output++,0,$resource->{'title'},$format->{'h1'});
    $worksheet->write($rows_output++,0,$resource->{'src'},$format->{'h3'});
    $rows_output++;
    $worksheet->write_row($rows_output++,0,\@Columns,$format->{'bold'});
    #
    # Populate the worksheet with the student data
    my %prog_state=&Apache::lonhtmlcommon::Create_PrgWin
        ($r,'Excel File Compilation Status',
         'Excel File Compilation Progress', 
         scalar(@$Students),'inline',undef,'Statistics','stats_status');
    foreach my $student (@$Students) {
        last if ($c->aborted());
        
        my $results = &Apache::loncoursedata::get_response_data_by_student
            ($student,$resource->{'symb'},$respid);
        my %row;
        $row{'username'} = $student->{'username'};
        $row{'domain'}   = $student->{'domain'};
        $row{'correct'}  = $student->{'answer'};
        $row{'weight'} = &Apache::lonnet::EXT
            ('resource.'.$partid.'.weight',$resource->{'symb'},
             undef,undef,undef);
        if (! defined($results) || ref($results) ne 'ARRAY') {
            $row{'score'} = '='.
                &Spreadsheet::WriteExcel::Utility::xl_rowcol_to_cell
                    ($rows_output,$awarded_col)
                .'*'.
                &Spreadsheet::WriteExcel::Utility::xl_rowcol_to_cell
                    ($rows_output,$weight_col);
            my $cols_output = 0;
            foreach my $col (@Columns) {
                if (! exists($row{$col})) {
                    $cols_output++;
                    next;
                }
                $worksheet->write($rows_output,$cols_output++,$row{$col});
            }
            $rows_output++;
        } else {
            for (my $i=0;$i<scalar(@$results);$i++) {
                my $response = $results->[$i];
                if ($ENV{'form.last_sub_only'} eq 'true' && 
                    $i < (scalar(@$results)-1)) {
                    next;
                }
                delete($row{'time'});
                delete($row{'attempt'});
                delete($row{'submission'});
                delete($row{'awarded'});
                delete($row{'grading'});
                delete($row{'score'});
                my %row_format;
                #
                # Time is handled differently
                $row{'time'} = &Apache::lonstathelpers::calc_serial
                    ($response->[&Apache::loncoursedata::RDs_timestamp()]);
                $row_format{'time'}=$format->{'date'};
                #
                $row{'attempt'}  = $response->[
                     &Apache::loncoursedata::RDs_tries()];
                $row{'submission'} = $response->[
                     &Apache::loncoursedata::RDs_submission()];
                if ($row{'submission'} =~ m/^=/) {
                    # This will be interpreted as a formula.  That is bad!
                    $row{'submission'} = " ".$row{'submission'};
                }
                $row{'grading'} = $response->[
                     &Apache::loncoursedata::RDs_awarddetail()];
                $row{'awarded'} = $response->[
                     &Apache::loncoursedata::RDs_awarded()];
                $row{'score'} = '='.
                    &Spreadsheet::WriteExcel::Utility::xl_rowcol_to_cell
                        ($rows_output,$awarded_col)
                    .'*'.
                    &Spreadsheet::WriteExcel::Utility::xl_rowcol_to_cell
                        ($rows_output,$weight_col);
                my $cols_output = 0;
                foreach my $col (@Columns) {
                    $worksheet->write($rows_output,$cols_output++,$row{$col},
                                      $row_format{$col});
                }
                $rows_output++;
            }
        } # End of else clause on if (! defined($results) ....
        &Apache::lonhtmlcommon::Increment_PrgWin($r,\%prog_state,
                                                 'last student');
    }
    &Apache::lonhtmlcommon::Close_PrgWin($r,\%prog_state);
    #
    # Close the excel file
    $workbook->close();
    #
    # Write a link to allow them to download it
    $r->print('<p><a href="'.$filename.'">'.
              &mt('Your Excel spreadsheet.').
              '</a></p>'."\n");
    $r->print('<script>'.
              'window.document.Statistics.stats_status.value="'.
              'Done compiling spreadsheet.  See link below to download.'.
              '";</script>');
    $r->rflush();
    return;
}

#########################################################
#########################################################
##
##   Generic Interface Routines
##
#########################################################
#########################################################
sub CreateInterface {
    ##
    ## Output Selection
    my $OutputSelector = $/.'<select name="output">'.$/;
    foreach ('HTML','Excel') {
        $OutputSelector .= '    <option value="'.lc($_).'"';
        if ($ENV{'form.output'} eq lc($_)) {
            $OutputSelector .= ' selected ';
        }
        $OutputSelector .='>'.&mt($_).'</option>'.$/;
    } 
    $OutputSelector .= '</select>'.$/;
    ##
    ## Environment variable initialization
    my $Str = '';
    $Str .= &Apache::lonhtmlcommon::breadcrumbs
        (undef,'Student Submission Reports');
    $Str .= '<p>';
    $Str .= '<table cellspacing="5">'."\n";
    $Str .= '<tr>';
    $Str .= '<th>'.&mt('Sections').'</th>';
    $Str .= '<th>'.&mt('Enrollment Status').'</th>';
    $Str .= '<th>'.&mt('Output Options').'</th>';
    $Str .= '</tr>'."\n";
    #
    $Str .= '<tr><td align="center">'."\n";
    $Str .= &Apache::lonstatistics::SectionSelect('Section','multiple',5);
    $Str .= '</td>';
    #
    $Str .= '<td align="center">';
    $Str .= &Apache::lonhtmlcommon::StatusOptions(undef,undef,5);
    $Str .= '</td>';
    #
    # Render problem checkbox
    my $prob_checkbox = '<input type="checkbox" name="renderprob" ';
    if (exists($ENV{'form.renderprob'}) && $ENV{'form.renderprob'} eq 'true') {
        $prob_checkbox .= 'checked ';
    }
    $prob_checkbox .= 'value="true" />';
    #
    # Compute correct answers checkbox
    my $ans_checkbox = '<input type="checkbox" name="correctans" ';
    if (exists($ENV{'form.correctans'}) && $ENV{'form.correctans'} eq 'true') {
        $ans_checkbox .= 'checked ';
    }
    $ans_checkbox .= 'value="true" />';
    #
    # Only show last submission checkbox
    my $last_sub_checkbox = '<input type="checkbox" name="last_sub_only" ';
    if (exists($ENV{'form.last_sub_only'}) && 
        $ENV{'form.last_sub_only'} eq 'true') {
        $last_sub_checkbox .= 'checked ';
    }
    $last_sub_checkbox.= 'value="true" />';
    #
    # Concise view checkbox
    my $concise_view_checkbox = '<input type="checkbox" name="concise" ';
    if (exists($ENV{'form.concise'}) && $ENV{'form.concise'} eq 'true') {
        $concise_view_checkbox .= 'checked ';
    }
    $concise_view_checkbox .= 'value="true" />';
    #
    $Str .= '<td align="right" halign="top">'.
        '<b>'.&mt('Output Format: [_1]',$OutputSelector).'</b><br />'.$/.
        '<label><b>'.
        &mt('show problem [_1]',$prob_checkbox).'</b></label><br />'.
        '<label><b>'.
        &mt('compute correct answers [_1]',$ans_checkbox).'</b></label><br />'.
        '<label><b>'.
        &mt('final answer only [_1]',$last_sub_checkbox).'</b></label><br />'.
        '<label><b>'.
        &mt('concise view [_1]',$concise_view_checkbox).'</b></label><br />'.
        '</td>';
    #
    $Str .= '</tr>'."\n";
    $Str .= '</table>'."\n";
    #
    $Str .= '<nobr>'.&mt('Status: [_1]',
                         '<input type="text" '.
                         'name="stats_status" size="60" value="" />').
            '</nobr>'.'</p>';    
    ##
    return $Str;
}

1;

__END__